]>
git.proxmox.com Git - pve-storage.git/blob - PVE/Storage/LunCmd/LIO.pm
1 package PVE
::Storage
::LunCmd
::LIO
;
3 # lightly based on code from Iet.pm
6 # -----------------------------------------------------------------
7 # Copyright (c) 2018 BestSolution.at EDV Systemhaus GmbH
10 # This software is released under the terms of the
12 # "GNU Affero General Public License"
14 # and may only be distributed and used under the terms of the
15 # mentioned license. You should have received a copy of the license
16 # along with this software product, if not you can download it from
17 # https://www.gnu.org/licenses/agpl-3.0.en.html
19 # Author: udo.rader@bestsolution.at
20 # -----------------------------------------------------------------
24 use PVE
::Tools
qw(run_command);
30 # config file location differs from distro to distro
32 '/etc/rtslib-fb-target/saveconfig.json', # Debian 9.x et al
33 '/etc/target/saveconfig.json' , # ArchLinux, CentOS
35 my $BACKSTORE = '/backstores/block';
38 my $SETTINGS_TIMESTAMP = 0;
39 my $SETTINGS_MAXAGE = 15; # in seconds
41 my @ssh_opts = ('-o', 'BatchMode=yes');
42 my @ssh_cmd = ('/usr/bin/ssh', @ssh_opts);
43 my $id_rsa_path = '/etc/pve/priv/zfs';
44 my $targetcli = '/usr/bin/targetcli';
46 my $execute_remote_command = sub {
47 my ($scfg, $timeout, $remote_command, @params) = @_;
55 $timeout = 10 if !$timeout;
57 my $output = sub { $msg .= "$_[0]\n" };
58 my $errfunc = sub { $err .= "$_[0]\n" };
60 $target = 'root@' . $scfg->{portal
};
61 $cmd = [@ssh_cmd, '-i', "$id_rsa_path/$scfg->{portal}_id_rsa", $target, '--', $remote_command, @params];
64 run_command
($cmd, outfunc
=> $output, errfunc
=> $errfunc, timeout
=> $timeout);
81 # fetch targetcli configuration from the portal
82 my $read_config = sub {
83 my ($scfg, $timeout) = @_;
91 $timeout = 10 if !$timeout;
93 my $output = sub { $msg .= "$_[0]\n" };
94 my $errfunc = sub { $err .= "$_[0]\n" };
96 $target = 'root@' . $scfg->{portal
};
98 foreach my $oneFile (@CONFIG_FILES) {
99 my $cmd = [@ssh_cmd, '-i', "$id_rsa_path/$scfg->{portal}_id_rsa", $target, $luncmd, $oneFile];
101 run_command
($cmd, outfunc
=> $output, errfunc
=> $errfunc, timeout
=> $timeout);
104 die $err if ($err !~ /No such file or directory/);
106 return $msg if $msg ne '';
109 die "No configuration found. Install targetcli on $scfg->{portal}\n" if $msg eq '';
114 my $get_config = sub {
118 my $config = $read_config->($scfg, undef);
119 die "Missing config file" unless $config;
124 # Return settings of a specific target
125 my $get_target_settings = sub {
128 my $id = "$scfg->{portal}.$scfg->{target}";
129 return undef if !$SETTINGS;
130 return $SETTINGS->{$id};
133 # fetches and parses targetcli config from the portal
136 my $tpg = $scfg->{lio_tpg
} || die "Target Portal Group not set, aborting!\n";
139 if ($tpg =~ /^tpg(\d+)$/) {
142 die "Target Portal Group has invalid value, must contain string 'tpg' and a suffix number, eg 'tpg17'\n";
147 my $config = $get_config->($scfg);
148 my $jsonconfig = JSON-
>new->utf8->decode($config);
151 foreach my $target (@{$jsonconfig->{targets
}}) {
152 # only interested in iSCSI targets
153 next if !($target->{fabric
} eq 'iscsi' && $target->{wwn
} eq $scfg->{target
});
155 foreach my $tpg (@{$target->{tpgs
}}) {
156 if ($tpg->{tag
} == $tpg_tag) {
157 my $id = "$scfg->{portal}.$scfg->{target}";
158 $SETTINGS->{$id} = $tpg;
165 # seriously unhappy if the target server lacks iSCSI target configuration ...
167 die "target portal group tpg$tpg_tag not found!\n";
171 # Get prefix for backstores
172 my $get_backstore_prefix = sub {
174 my $pool = $scfg->{pool
};
179 # removes the given lu_name from the local list of luns
180 my $free_lu_name = sub {
181 my ($scfg, $lu_name) = @_;
184 my $target = $get_target_settings->($scfg);
185 foreach my $lun (@{$target->{luns
}}) {
186 if ($lun->{storage_object
} ne "$BACKSTORE/$lu_name") {
191 $target->{luns
} = $new;
194 # locally registers a new lun
195 my $register_lun = sub {
196 my ($scfg, $idx, $volname) = @_;
200 storage_object
=> "$BACKSTORE/$volname",
203 my $target = $get_target_settings->($scfg);
204 push @{$target->{luns
}}, $conf;
209 # extracts the ZFS volume name from a device path
210 my $extract_volname = sub {
211 my ($scfg, $lunpath) = @_;
215 if ($lunpath =~ /^$base\/$scfg
->{pool
}\
/([\w\-]+)$/) {
217 my $prefix = $get_backstore_prefix->($scfg);
218 my $target = $get_target_settings->($scfg);
219 foreach my $lun (@{$target->{luns
}}) {
220 # If we have a lun with the pool prefix matching this vol, then return this one
221 # like pool-pve-vm-100-disk-0
222 # Else, just fallback to the old name scheme which is vm-100-disk-0
223 if ($lun->{storage_object
} =~ /^$BACKSTORE\/($prefix$volname)$/) {
232 # retrieves the LUN index for a particular object
233 my $list_view = sub {
234 my ($scfg, $timeout, $method, @params) = @_;
237 my $object = $params[0];
238 my $volname = $extract_volname->($scfg, $object);
239 my $target = $get_target_settings->($scfg);
241 return undef if !defined($volname); # nothing to search for..
243 foreach my $lun (@{$target->{luns
}}) {
244 if ($lun->{storage_object
} eq "$BACKSTORE/$volname") {
245 return $lun->{index};
252 # determines, if the given object exists on the portal
254 my ($scfg, $timeout, $method, @params) = @_;
257 my $object = $params[0];
258 my $volname = $extract_volname->($scfg, $object);
259 my $target = $get_target_settings->($scfg);
261 foreach my $lun (@{$target->{luns
}}) {
262 if ($lun->{storage_object
} eq "$BACKSTORE/$volname") {
270 # adds a new LUN to the target
271 my $create_lun = sub {
272 my ($scfg, $timeout, $method, @params) = @_;
274 if ($list_lun->($scfg, $timeout, $method, @params)) {
275 die "$params[0]: LUN already exists!";
278 my $device = $params[0];
279 my $volname = $extract_volname->($scfg, $device);
280 # Here we create a new device, so we didn't get the volname prefixed with the pool name
281 # as extract_volname couldn't find a matching vol yet
282 $volname = $get_backstore_prefix->($scfg) . $volname;
283 my $tpg = $scfg->{lio_tpg
} || die "Target Portal Group not set, aborting!\n";
285 # step 1: create backstore for device
286 my @cliparams = ($BACKSTORE, 'create', "name=$volname", "dev=$device" );
287 my $res = $execute_remote_command->($scfg, $timeout, $targetcli, @cliparams);
288 die $res->{msg
} if !$res->{result
};
290 # step 2: enable unmap support on the backstore
291 @cliparams = ($BACKSTORE . '/' . $volname, 'set', 'attribute', 'emulate_tpu=1' );
292 $res = $execute_remote_command->($scfg, $timeout, $targetcli, @cliparams);
293 die $res->{msg
} if !$res->{result
};
295 # step 3: register lun with target
296 # targetcli /iscsi/iqn.2018-04.at.bestsolution.somehost:target/tpg1/luns/ create /backstores/block/foobar
297 @cliparams = ("/iscsi/$scfg->{target}/$tpg/luns/", 'create', "$BACKSTORE/$volname" );
298 $res = $execute_remote_command->($scfg, $timeout, $targetcli, @cliparams);
299 die $res->{msg
} if !$res->{result
};
301 # targetcli responds with "Created LUN 99"
302 # not calculating the index ourselves, because the index at the portal might have
303 # changed without our knowledge, so relying on the number that targetcli returns
305 if ($res->{msg
} =~ /LUN (\d+)/) {
308 die "unable to determine new LUN index: $res->{msg}";
311 $register_lun->($scfg, $lun_idx, $volname);
313 # step 3: unfortunately, targetcli doesn't always save changes, no matter
314 # if auto_save_on_exit is true or not. So saving to be safe ...
315 $execute_remote_command->($scfg, $timeout, $targetcli, 'saveconfig');
320 my $delete_lun = sub {
321 my ($scfg, $timeout, $method, @params) = @_;
322 my $res = {msg
=> undef};
324 my $tpg = $scfg->{lio_tpg
} || die "Target Portal Group not set, aborting!\n";
326 my $path = $params[0];
327 my $volname = $extract_volname->($scfg, $path);
328 my $target = $get_target_settings->($scfg);
330 foreach my $lun (@{$target->{luns
}}) {
331 next if $lun->{storage_object
} ne "$BACKSTORE/$volname";
333 # step 1: delete the lun
334 my @cliparams = ("/iscsi/$scfg->{target}/$tpg/luns/", 'delete', "lun$lun->{index}" );
335 my $res = $execute_remote_command->($scfg, $timeout, $targetcli, @cliparams);
338 } unless $res->{result
};
340 # step 2: delete the backstore
341 @cliparams = ($BACKSTORE, 'delete', $volname);
342 $res = $execute_remote_command->($scfg, $timeout, $targetcli, @cliparams);
345 } unless $res->{result
};
347 # step 3: save to be safe ...
348 $execute_remote_command->($scfg, $timeout, $targetcli, 'saveconfig');
350 # update interal cache
351 $free_lu_name->($scfg, $volname);
359 my $import_lun = sub {
360 my ($scfg, $timeout, $method, @params) = @_;
362 return $create_lun->($scfg, $timeout, $method, @params);
365 # needed for example when the underlying ZFS volume has been resized
366 my $modify_lun = sub {
367 my ($scfg, $timeout, $method, @params) = @_;
368 # Nothing to do on volume modification for LIO
373 my ($scfg, $timeout, $method, @params) = @_;
379 create_lu
=> $create_lun,
380 delete_lu
=> $delete_lun,
381 import_lu
=> $import_lun,
382 modify_lu
=> $modify_lun,
383 add_view
=> $add_view,
384 list_view
=> $list_view,
385 list_lu
=> $list_lun,
388 sub run_lun_command
{
389 my ($scfg, $timeout, $method, @params) = @_;
391 # fetch configuration from target if we haven't yet or if it is stale
392 my $timediff = time - $SETTINGS_TIMESTAMP;
393 my $target = $get_target_settings->($scfg);
394 if (!$target || $timediff > $SETTINGS_MAXAGE) {
395 $SETTINGS_TIMESTAMP = time;
399 die "unknown command '$method'" unless exists $lun_cmd_map{$method};
400 my $msg = $lun_cmd_map{$method}->($scfg, $timeout, $method, @params);