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 # fetches and parses targetcli config from the portal
127 my $tpg = $scfg->{lio_tpg
} || die "Target Portal Group not set, aborting!\n";
130 if ($tpg =~ /^tpg(\d+)$/) {
133 die "Target Portal Group has invalid value, must contain string 'tpg' and a suffix number, eg 'tpg17'\n";
138 my $config = $get_config->($scfg);
139 my $jsonconfig = JSON-
>new->utf8->decode($config);
142 foreach my $target (@{$jsonconfig->{targets
}}) {
143 # only interested in iSCSI targets
144 next if !($target->{fabric
} eq 'iscsi' && $target->{wwn
} eq $scfg->{target
});
146 foreach my $tpg (@{$target->{tpgs
}}) {
147 if ($tpg->{tag
} == $tpg_tag) {
148 $SETTINGS->{target
} = $tpg;
155 # seriously unhappy if the target server lacks iSCSI target configuration ...
157 die "target portal group tpg$tpg_tag not found!\n";
161 # removes the given lu_name from the local list of luns
162 my $free_lu_name = sub {
166 foreach my $lun (@{$SETTINGS->{target
}->{luns
}}) {
167 if ($lun->{storage_object
} ne "$BACKSTORE/$lu_name") {
172 $SETTINGS->{target
}->{luns
} = $new;
175 # locally registers a new lun
176 my $register_lun = sub {
177 my ($scfg, $idx, $volname) = @_;
181 storage_object
=> "$BACKSTORE/$volname",
184 push @{$SETTINGS->{target
}->{luns
}}, $conf;
189 # extracts the ZFS volume name from a device path
190 my $extract_volname = sub {
191 my ($scfg, $lunpath) = @_;
195 if ($lunpath =~ /^$base\/$scfg
->{pool
}\
/([\w\-]+)$/) {
202 # retrieves the LUN index for a particular object
203 my $list_view = sub {
204 my ($scfg, $timeout, $method, @params) = @_;
207 my $object = $params[0];
208 my $volname = $extract_volname->($scfg, $params[0]);
210 foreach my $lun (@{$SETTINGS->{target
}->{luns
}}) {
211 if ($lun->{storage_object
} eq "$BACKSTORE/$volname") {
212 return $lun->{index};
219 # determines, if the given object exists on the portal
221 my ($scfg, $timeout, $method, @params) = @_;
224 my $object = $params[0];
225 my $volname = $extract_volname->($scfg, $params[0]);
227 foreach my $lun (@{$SETTINGS->{target
}->{luns
}}) {
228 if ($lun->{storage_object
} eq "$BACKSTORE/$volname") {
236 # adds a new LUN to the target
237 my $create_lun = sub {
238 my ($scfg, $timeout, $method, @params) = @_;
240 if ($list_lun->($scfg, $timeout, $method, @params)) {
241 die "$params[0]: LUN already exists!";
244 my $device = $params[0];
245 my $volname = $extract_volname->($scfg, $device);
246 my $tpg = $scfg->{lio_tpg
} || die "Target Portal Group not set, aborting!\n";
248 # step 1: create backstore for device
249 my @cliparams = ($BACKSTORE, 'create', "name=$volname", "dev=$device" );
250 my $res = $execute_remote_command->($scfg, $timeout, $targetcli, @cliparams);
251 die $res->{msg
} if !$res->{result
};
253 # step 2: register lun with target
254 # targetcli /iscsi/iqn.2018-04.at.bestsolution.somehost:target/tpg1/luns/ create /backstores/block/foobar
255 @cliparams = ("/iscsi/$scfg->{target}/$tpg/luns/", 'create', "$BACKSTORE/$volname" );
256 $res = $execute_remote_command->($scfg, $timeout, $targetcli, @cliparams);
257 die $res->{msg
} if !$res->{result
};
259 # targetcli responds with "Created LUN 99"
260 # not calculating the index ourselves, because the index at the portal might have
261 # changed without our knowledge, so relying on the number that targetcli returns
263 if ($res->{msg
} =~ /LUN (\d+)/) {
266 die "unable to determine new LUN index: $res->{msg}";
269 $register_lun->($scfg, $lun_idx, $volname);
271 # step 3: unfortunately, targetcli doesn't always save changes, no matter
272 # if auto_save_on_exit is true or not. So saving to be safe ...
273 $execute_remote_command->($scfg, $timeout, $targetcli, 'saveconfig');
278 my $delete_lun = sub {
279 my ($scfg, $timeout, $method, @params) = @_;
280 my $res = {msg
=> undef};
282 my $tpg = $scfg->{lio_tpg
} || die "Target Portal Group not set, aborting!\n";
284 my $path = $params[0];
285 my $volname = $extract_volname->($scfg, $params[0]);
287 foreach my $lun (@{$SETTINGS->{target
}->{luns
}}) {
288 next if $lun->{storage_object
} ne "$BACKSTORE/$volname";
290 # step 1: delete the lun
291 my @cliparams = ("/iscsi/$scfg->{target}/$tpg/luns/", 'delete', "lun$lun->{index}" );
292 my $res = $execute_remote_command->($scfg, $timeout, $targetcli, @cliparams);
295 } unless $res->{result
};
297 # step 2: delete the backstore
298 @cliparams = ($BACKSTORE, 'delete', $volname);
299 $res = $execute_remote_command->($scfg, $timeout, $targetcli, @cliparams);
302 } unless $res->{result
};
304 # step 3: save to be safe ...
305 $execute_remote_command->($scfg, $timeout, $targetcli, 'saveconfig');
307 # update interal cache
308 $free_lu_name->($volname);
316 my $import_lun = sub {
317 my ($scfg, $timeout, $method, @params) = @_;
319 return $create_lun->($scfg, $timeout, $method, @params);
322 # needed for example when the underlying ZFS volume has been resized
323 my $modify_lun = sub {
324 my ($scfg, $timeout, $method, @params) = @_;
327 $msg = $delete_lun->($scfg, $timeout, $method, @params);
329 $msg = $create_lun->($scfg, $timeout, $method, @params);
336 my ($scfg, $timeout, $method, @params) = @_;
342 create_lu
=> $create_lun,
343 delete_lu
=> $delete_lun,
344 import_lu
=> $import_lun,
345 modify_lu
=> $modify_lun,
346 add_view
=> $add_view,
347 list_view
=> $list_view,
348 list_lu
=> $list_lun,
351 sub run_lun_command
{
352 my ($scfg, $timeout, $method, @params) = @_;
354 # fetch configuration from target if we haven't yet or if it is stale
355 my $timediff = time - $SETTINGS_TIMESTAMP;
356 if (!$SETTINGS || $timediff > $SETTINGS_MAXAGE) {
357 $SETTINGS_TIMESTAMP = time;
361 die "unknown command '$method'" unless exists $lun_cmd_map{$method};
362 my $msg = $lun_cmd_map{$method}->($scfg, $timeout, $method, @params);