]>
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";
145 my $config = $get_config->($scfg);
146 my $jsonconfig = JSON-
>new->utf8->decode($config);
149 foreach my $target (@{$jsonconfig->{targets
}}) {
150 # only interested in iSCSI targets
151 next if !($target->{fabric
} eq 'iscsi' && $target->{wwn
} eq $scfg->{target
});
153 foreach my $tpg (@{$target->{tpgs
}}) {
154 if ($tpg->{tag
} == $tpg_tag) {
156 foreach my $lun (@{$tpg->{luns
}}) {
157 my ($idx, $storage_object);
158 if ($lun->{index} =~ /^(\d+)$/) {
161 if ($lun->{storage_object
} =~ m
|^($BACKSTORE/.*)$|) {
162 $storage_object = $1;
164 die "Invalid lun definition in config!\n"
165 if !(defined($idx) && defined($storage_object));
166 push @$res, { index => $idx, storage_object
=> $storage_object };
169 my $id = "$scfg->{portal}.$scfg->{target}";
170 $SETTINGS->{$id}->{luns
} = $res;
177 # seriously unhappy if the target server lacks iSCSI target configuration ...
179 die "target portal group tpg$tpg_tag not found!\n";
183 # Get prefix for backstores
184 my $get_backstore_prefix = sub {
186 my $pool = $scfg->{pool
};
191 # removes the given lu_name from the local list of luns
192 my $free_lu_name = sub {
193 my ($scfg, $lu_name) = @_;
196 my $target = $get_target_settings->($scfg);
197 foreach my $lun (@{$target->{luns
}}) {
198 if ($lun->{storage_object
} ne "$BACKSTORE/$lu_name") {
203 $target->{luns
} = $new;
206 # locally registers a new lun
207 my $register_lun = sub {
208 my ($scfg, $idx, $volname) = @_;
212 storage_object
=> "$BACKSTORE/$volname",
215 my $target = $get_target_settings->($scfg);
216 push @{$target->{luns
}}, $conf;
221 # extracts the ZFS volume name from a device path
222 my $extract_volname = sub {
223 my ($scfg, $lunpath) = @_;
227 if ($lunpath =~ /^$base\/$scfg
->{pool
}\
/([\w\-]+)$/) {
229 my $prefix = $get_backstore_prefix->($scfg);
230 my $target = $get_target_settings->($scfg);
231 foreach my $lun (@{$target->{luns
}}) {
232 # If we have a lun with the pool prefix matching this vol, then return this one
233 # like pool-pve-vm-100-disk-0
234 # Else, just fallback to the old name scheme which is vm-100-disk-0
235 if ($lun->{storage_object
} =~ /^$BACKSTORE\/($prefix$volname)$/) {
244 # retrieves the LUN index for a particular object
245 my $list_view = sub {
246 my ($scfg, $timeout, $method, @params) = @_;
249 my $object = $params[0];
250 my $volname = $extract_volname->($scfg, $object);
251 my $target = $get_target_settings->($scfg);
253 return undef if !defined($volname); # nothing to search for..
255 foreach my $lun (@{$target->{luns
}}) {
256 if ($lun->{storage_object
} eq "$BACKSTORE/$volname") {
257 return $lun->{index};
264 # determines, if the given object exists on the portal
266 my ($scfg, $timeout, $method, @params) = @_;
268 my $object = $params[0];
269 my $volname = $extract_volname->($scfg, $object);
270 my $target = $get_target_settings->($scfg);
272 foreach my $lun (@{$target->{luns
}}) {
273 if ($lun->{storage_object
} eq "$BACKSTORE/$volname") {
281 # adds a new LUN to the target
282 my $create_lun = sub {
283 my ($scfg, $timeout, $method, @params) = @_;
285 if ($list_lun->($scfg, $timeout, $method, @params)) {
286 die "$params[0]: LUN already exists!";
289 my $device = $params[0];
290 my $volname = $extract_volname->($scfg, $device);
291 # Here we create a new device, so we didn't get the volname prefixed with the pool name
292 # as extract_volname couldn't find a matching vol yet
293 $volname = $get_backstore_prefix->($scfg) . $volname;
294 my $tpg = $scfg->{lio_tpg
} || die "Target Portal Group not set, aborting!\n";
296 # step 1: create backstore for device
297 my @cliparams = ($BACKSTORE, 'create', "name=$volname", "dev=$device" );
298 my $res = $execute_remote_command->($scfg, $timeout, $targetcli, @cliparams);
299 die $res->{msg
} if !$res->{result
};
301 # step 2: enable unmap support on the backstore
302 @cliparams = ($BACKSTORE . '/' . $volname, 'set', 'attribute', 'emulate_tpu=1' );
303 $res = $execute_remote_command->($scfg, $timeout, $targetcli, @cliparams);
304 die $res->{msg
} if !$res->{result
};
306 # step 3: register lun with target
307 # targetcli /iscsi/iqn.2018-04.at.bestsolution.somehost:target/tpg1/luns/ create /backstores/block/foobar
308 @cliparams = ("/iscsi/$scfg->{target}/$tpg/luns/", 'create', "$BACKSTORE/$volname" );
309 $res = $execute_remote_command->($scfg, $timeout, $targetcli, @cliparams);
310 die $res->{msg
} if !$res->{result
};
312 # targetcli responds with "Created LUN 99"
313 # not calculating the index ourselves, because the index at the portal might have
314 # changed without our knowledge, so relying on the number that targetcli returns
316 if ($res->{msg
} =~ /LUN (\d+)/) {
319 die "unable to determine new LUN index: $res->{msg}";
322 $register_lun->($scfg, $lun_idx, $volname);
324 # step 3: unfortunately, targetcli doesn't always save changes, no matter
325 # if auto_save_on_exit is true or not. So saving to be safe ...
326 $execute_remote_command->($scfg, $timeout, $targetcli, 'saveconfig');
331 my $delete_lun = sub {
332 my ($scfg, $timeout, $method, @params) = @_;
333 my $res = {msg
=> undef};
335 my $tpg = $scfg->{lio_tpg
} || die "Target Portal Group not set, aborting!\n";
337 my $path = $params[0];
338 my $volname = $extract_volname->($scfg, $path);
339 my $target = $get_target_settings->($scfg);
341 foreach my $lun (@{$target->{luns
}}) {
342 next if $lun->{storage_object
} ne "$BACKSTORE/$volname";
344 # step 1: delete the lun
345 my @cliparams = ("/iscsi/$scfg->{target}/$tpg/luns/", 'delete', "lun$lun->{index}" );
346 my $res = $execute_remote_command->($scfg, $timeout, $targetcli, @cliparams);
349 } unless $res->{result
};
351 # step 2: delete the backstore
352 @cliparams = ($BACKSTORE, 'delete', $volname);
353 $res = $execute_remote_command->($scfg, $timeout, $targetcli, @cliparams);
356 } unless $res->{result
};
358 # step 3: save to be safe ...
359 $execute_remote_command->($scfg, $timeout, $targetcli, 'saveconfig');
361 # update internal cache
362 $free_lu_name->($scfg, $volname);
370 my $import_lun = sub {
371 my ($scfg, $timeout, $method, @params) = @_;
373 return $create_lun->($scfg, $timeout, $method, @params);
376 # needed for example when the underlying ZFS volume has been resized
377 my $modify_lun = sub {
378 my ($scfg, $timeout, $method, @params) = @_;
379 # Nothing to do on volume modification for LIO
384 my ($scfg, $timeout, $method, @params) = @_;
390 create_lu
=> $create_lun,
391 delete_lu
=> $delete_lun,
392 import_lu
=> $import_lun,
393 modify_lu
=> $modify_lun,
394 add_view
=> $add_view,
395 list_view
=> $list_view,
396 list_lu
=> $list_lun,
399 sub run_lun_command
{
400 my ($scfg, $timeout, $method, @params) = @_;
402 # fetch configuration from target if we haven't yet or if it is stale
403 my $timediff = time - $SETTINGS_TIMESTAMP;
404 my $target = $get_target_settings->($scfg);
405 if (!$target || $timediff > $SETTINGS_MAXAGE) {
406 $SETTINGS_TIMESTAMP = time;
410 die "unknown command '$method'" unless exists $lun_cmd_map{$method};
411 my $msg = $lun_cmd_map{$method}->($scfg, $timeout, $method, @params);