]> git.proxmox.com Git - pve-storage.git/blobdiff - PVE/Storage.pm
Extend archive_info to include filename and logfilename
[pve-storage.git] / PVE / Storage.pm
index 60b831090130b81ea394b8656bfccc1b5ed3c554..f1181cc9c5bbc070107dc387ceed8e86fa7275c6 100755 (executable)
@@ -12,6 +12,7 @@ use File::Basename;
 use File::Path;
 use Cwd 'abs_path';
 use Socket;
+use Time::Local qw(timelocal);
 
 use PVE::Tools qw(run_command file_read_firstline dir_glob_foreach $IPV6RE);
 use PVE::Cluster qw(cfs_read_file cfs_write_file cfs_lock_file);
@@ -39,11 +40,11 @@ use PVE::Storage::DRBDPlugin;
 use PVE::Storage::PBSPlugin;
 
 # Storage API version. Icrement it on changes in storage API interface.
-use constant APIVER => 4;
+use constant APIVER => 5;
 # Age is the number of versions we're backward compatible with.
 # This is like having 'current=APIVER' and age='APIAGE' in libtool,
 # see https://www.gnu.org/software/libtool/manual/html_node/Libtool-versioning.html
-use constant APIAGE => 3;
+use constant APIAGE => 4;
 
 # load standard plugins
 PVE::Storage::DirPlugin->register();
@@ -285,6 +286,21 @@ sub volume_snapshot_delete {
     }
 }
 
+# check if a volume or snapshot supports a given feature
+# $feature - one of:
+#            clone - linked clone is possible
+#            copy  - full clone is possible
+#            replicate - replication is possible
+#            snapshot - taking a snapshot is possible
+#            sparseinit - volume is sparsely initialized
+#            template - conversion to base image is possible
+# $snap - check if the feature is supported for a given snapshot
+# $running - if the guest owning the volume is running
+# $opts - hash with further options:
+#         valid_target_formats - list of formats for the target of a copy/clone
+#                                operation that the caller could work with. The
+#                                format of $volid is always considered valid and if
+#                                no list is specified, all formats are considered valid.
 sub volume_has_feature {
     my ($cfg, $feature, $volid, $snap, $running, $opts) = @_;
 
@@ -497,6 +513,7 @@ sub path_to_volume_id {
        my $tmpldir = $plugin->get_subdir($scfg, 'vztmpl');
        my $backupdir = $plugin->get_subdir($scfg, 'backup');
        my $privatedir = $plugin->get_subdir($scfg, 'rootdir');
+       my $snippetsdir = $plugin->get_subdir($scfg, 'snippets');
 
        if ($path =~ m!^$imagedir/(\d+)/([^/\s]+)$!) {
            my $vmid = $1;
@@ -519,9 +536,12 @@ sub path_to_volume_id {
        } elsif ($path =~ m!^$privatedir/(\d+)$!) {
            my $vmid = $1;
            return ('rootdir', "$sid:rootdir/$vmid");
-       } elsif ($path =~ m!^$backupdir/([^/]+\.(tar|tar\.gz|tar\.lzo|tgz|vma|vma\.gz|vma\.lzo))$!) {
+       } elsif ($path =~ m!^$backupdir/([^/]+\.(?:tgz|(?:(?:tar|vma)(?:\.(?:${\PVE::Storage::Plugin::COMPRESSOR_RE}))?)))$!) {
            my $name = $1;
-           return ('iso', "$sid:backup/$name");
+           return ('backup', "$sid:backup/$name");
+       } elsif ($path =~ m!^$snippetsdir/([^/]+)$!) {
+           my $name = $1;
+           return ('snippets', "$sid:snippets/$name");
        }
     }
 
@@ -562,23 +582,52 @@ sub abs_filesystem_path {
     return $path;
 }
 
+my $volname_for_storage = sub {
+    my ($cfg, $volid, $target_storeid) = @_;
+
+    my (undef, $name, $vmid, undef, undef, undef, $format) = parse_volname($cfg, $volid);
+    my $target_scfg = storage_config($cfg, $target_storeid);
+
+    my (undef, $valid_formats) = PVE::Storage::Plugin::default_format($target_scfg);
+    my $format_is_valid = grep { $_ eq $format } @$valid_formats;
+    die "unsupported format '$format' for storage type $target_scfg->{type}\n" if !$format_is_valid;
+
+    (my $name_without_extension = $name) =~ s/\.$format$//;
+
+    if ($target_scfg->{path}) {
+       return "$vmid/$name_without_extension.$format";
+    } else {
+       return "$name_without_extension";
+    }
+};
+
 sub storage_migrate {
-    my ($cfg, $volid, $target_sshinfo, $target_storeid, $target_volname, $base_snapshot, $snapshot, $ratelimit_bps, $insecure, $with_snapshots, $logfunc) = @_;
+    my ($cfg, $volid, $target_sshinfo, $target_storeid, $opts, $logfunc) = @_;
+
+    my $base_snapshot = $opts->{base_snapshot};
+    my $snapshot = $opts->{snapshot};
+    my $ratelimit_bps = $opts->{ratelimit_bps};
+    my $insecure = $opts->{insecure};
+    my $with_snapshots = $opts->{with_snapshots} ? 1 : 0;
+    my $allow_rename = $opts->{allow_rename} ? 1 : 0;
 
     my ($storeid, $volname) = parse_volume_id($volid);
-    $target_volname = $volname if !$target_volname;
 
     my $scfg = storage_config($cfg, $storeid);
 
     # no need to migrate shared content
-    return if $storeid eq $target_storeid && $scfg->{shared};
+    return $volid if $storeid eq $target_storeid && $scfg->{shared};
 
     my $tcfg = storage_config($cfg, $target_storeid);
 
-    my $vtype = (parse_volname($cfg, $volid))[0];
-
-    die "content type '$vtype' is not available on storage '$target_storeid'\n"
-       if !$tcfg->{content}->{$vtype};
+    my $target_volname;
+    if ($opts->{target_volname}) {
+       $target_volname = $opts->{target_volname};
+    } elsif ($scfg->{type} eq $tcfg->{type}) {
+       $target_volname = $volname;
+    } else {
+       $target_volname = $volname_for_storage->($cfg, $volid, $target_storeid);
+    }
 
     my $target_volid = "${target_storeid}:${target_volname}";
 
@@ -609,7 +658,11 @@ sub storage_migrate {
        $import_fn = "tcp://$net";
     }
 
-    $with_snapshots = $with_snapshots ? 1 : 0; # sanitize for passing as cli parameter
+    my $target_apiver = 1; # if there is no apiinfo call, assume 1
+    my $get_api_version = [@$ssh, 'pvesm', 'apiinfo'];
+    my $match_api_version = sub { $target_apiver = $1 if $_[0] =~ m!^APIVER (\d+)$!; };
+    eval { run_command($get_api_version, logfunc => $match_api_version); };
+
     my $send = ['pvesm', 'export', $volid, $format, '-', '-with-snapshots', $with_snapshots];
     my $recv = [@$ssh, '--', 'pvesm', 'import', $target_volid, $format, $import_fn, '-with-snapshots', $with_snapshots];
     if (defined($snapshot)) {
@@ -618,6 +671,7 @@ sub storage_migrate {
     if ($migration_snapshot) {
        push @$recv, '-delete-snapshot', $snapshot;
     }
+    push @$recv, '-allow-rename', $allow_rename if $target_apiver >= 5;
 
     if (defined($base_snapshot)) {
        # Check if the snapshot exists on the remote side:
@@ -625,6 +679,19 @@ sub storage_migrate {
        push @$recv, '-base', $base_snapshot;
     }
 
+    my $new_volid;
+    my $pattern = volume_imported_message(undef, 1);
+    my $match_volid_and_log = sub {
+       my $line = shift;
+
+       $new_volid = $1 if ($line =~ $pattern);
+
+       if ($logfunc) {
+           chomp($line);
+           $logfunc->($line);
+       }
+    };
+
     volume_snapshot($cfg, $volid, $snapshot) if $migration_snapshot;
     eval {
        if ($insecure) {
@@ -642,13 +709,8 @@ sub storage_migrate {
            shutdown($socket, 1);
 
            # wait for the remote process to finish
-           if ($logfunc) {
-               while (my $line = <$info>) {
-                   chomp($line);
-                   $logfunc->("[$target_sshinfo->{name}] $line");
-               }
-           } else {
-               1 while <$info>;
+           while (my $line = <$info>) {
+               $match_volid_and_log->("[$target_sshinfo->{name}] $line");
            }
 
            # now close the socket
@@ -658,8 +720,11 @@ sub storage_migrate {
                die "import failed: exit code ".($?>>8)."\n";
            }
        } else {
-           run_command([$send, @cstream, $recv], logfunc => $logfunc);
+           run_command([$send, @cstream, $recv], logfunc => $match_volid_and_log);
        }
+
+       die "unable to get ID of the migrated volume\n"
+           if !defined($new_volid) && $target_apiver >= 5;
     };
     my $err = $@;
     warn "send/receive failed, cleaning up snapshot(s)..\n" if $err;
@@ -668,6 +733,8 @@ sub storage_migrate {
        warn "could not remove source snapshot: $@\n" if $@;
     }
     die $err if $err;
+
+    return $new_volid // $target_volid;
 }
 
 sub vdisk_clone {
@@ -1158,7 +1225,7 @@ sub scan_cifs {
 
 sub scan_zfs {
 
-    my $cmd = ['zfs',  'list', '-t', 'filesystem', '-H', '-o', 'name,avail,used'];
+    my $cmd = ['zfs',  'list', '-t', 'filesystem', '-Hp', '-o', 'name,avail,used'];
 
     my $res = [];
     run_command($cmd, outfunc => sub {
@@ -1166,8 +1233,8 @@ sub scan_zfs {
 
        if ($line =~m/^(\S+)\s+(\S+)\s+(\S+)$/) {
            my ($pool, $size_str, $used_str) = ($1, $2, $3);
-           my $size = PVE::Storage::ZFSPoolPlugin::zfs_parse_size($size_str);
-           my $used = PVE::Storage::ZFSPoolPlugin::zfs_parse_size($used_str);
+           my $size = $size_str + 0;
+           my $used = $used_str + 0;
            # ignore subvolumes generated by our ZFSPoolPlugin
            return if $pool =~ m!/subvol-\d+-[^/]+$!;
            return if $pool =~ m!/basevol-\d+-[^/]+$!;
@@ -1284,6 +1351,68 @@ sub foreach_volid {
     }
 }
 
+sub decompressor_info {
+    my ($format, $comp) = @_;
+
+    if ($format eq 'tgz' && !defined($comp)) {
+       ($format, $comp) = ('tar', 'gz');
+    }
+
+    my $decompressor = {
+       tar => {
+           gz => ['tar', '-z'],
+           lzo => ['tar', '--lzop'],
+           zst => ['tar', '--zstd'],
+       },
+       vma => {
+           gz => ['zcat'],
+           lzo => ['lzop', '-d', '-c'],
+           zst => ['zstd', '-q', '-d', '-c'],
+       },
+    };
+
+    die "ERROR: archive format not defined\n"
+       if !defined($decompressor->{$format});
+
+    my $decomp = $decompressor->{$format}->{$comp} if $comp;
+
+    my $info = {
+       format => $format,
+       compression => $comp,
+       decompressor => $decomp,
+    };
+
+    return $info;
+}
+
+sub archive_info {
+    my ($archive) = shift;
+    my $info;
+
+    my $volid = basename($archive);
+    if ($volid =~ /^(vzdump-(lxc|openvz|qemu)-\d+-.+\.(tgz$|tar|vma)(?:\.(${\PVE::Storage::Plugin::COMPRESSOR_RE}))?)$/) {
+       my $filename = "$1"; # untaint
+       my ($type, $format, $comp) = ($2, $3, $4);
+       my $format_re = defined($comp) ? "$format.$comp" : "$format";
+       $info = decompressor_info($format, $comp);
+       $info->{filename} = $filename;
+       $info->{type} = $type;
+
+       if ($volid =~ /^(vzdump-${type}-([1-9][0-9]{2,8})-(\d{4})_(\d{2})_(\d{2})-(\d{2})_(\d{2})_(\d{2}))\.${format_re}$/) {
+           $info->{logfilename} = "$1.log";
+           $info->{vmid} = int($2);
+           $info->{ctime} = timelocal($8, $7, $6, $5, $4 - 1, $3 - 1900);
+           $info->{is_std_name} = 1;
+       } else {
+           $info->{is_std_name} = 0;
+       }
+    } else {
+       die "ERROR: couldn't determine archive info from '$archive'\n";
+    }
+
+    return $info;
+}
+
 sub extract_vzdump_config_tar {
     my ($archive, $conf_re) = @_;
 
@@ -1313,7 +1442,7 @@ sub extract_vzdump_config_tar {
        $raw .= "$output\n";
     };
 
-    PVE::Tools::run_command(['tar', '-xpOf', $archive, $file, '--occurrence'], outfunc => $out);
+    run_command(['tar', '-xpOf', $archive, $file, '--occurrence'], outfunc => $out);
 
     return wantarray ? ($raw, $file) : $raw;
 }
@@ -1321,55 +1450,40 @@ sub extract_vzdump_config_tar {
 sub extract_vzdump_config_vma {
     my ($archive, $comp) = @_;
 
-    my $cmd;
     my $raw = '';
-    my $out = sub {
-       my $output = shift;
-       $raw .= "$output\n";
-    };
+    my $out = sub { $raw .= "$_[0]\n"; };
 
+    my $info = archive_info($archive);
+    $comp //= $info->{compression};
+    my $decompressor = $info->{decompressor};
 
     if ($comp) {
-       my $uncomp;
-       if ($comp eq 'gz') {
-           $uncomp = ["zcat", $archive];
-       } elsif ($comp eq 'lzo') {
-           $uncomp = ["lzop", "-d", "-c", $archive];
-       } else {
-           die "unknown compression method '$comp'\n";
-       }
-       $cmd = [$uncomp, ["vma", "config", "-"]];
+       my $cmd = [ [@$decompressor, $archive], ["vma", "config", "-"] ];
 
-       # in some cases, lzop/zcat exits with 1 when its stdout pipe is
-       # closed early by vma, detect this and ignore the exit code later
+       # lzop/zcat exits with 1 when the pipe is closed early by vma, detect this and ignore the exit code later
        my $broken_pipe;
        my $errstring;
        my $err = sub {
            my $output = shift;
-           if ($output =~ m/lzop: Broken pipe: <stdout>/ || $output =~ m/gzip: stdout: Broken pipe/) {
+           if ($output =~ m/lzop: Broken pipe: <stdout>/ || $output =~ m/gzip: stdout: Broken pipe/ || $output =~ m/zstd: error 70 : Write error : Broken pipe/) {
                $broken_pipe = 1;
            } elsif (!defined ($errstring) && $output !~ m/^\s*$/) {
                $errstring = "Failed to extract config from VMA archive: $output\n";
            }
        };
 
-       # in other cases, the pipeline will exit with exit code 141
-       # because of the broken pipe, handle / ignore this as well
-       my $rc;
-       eval {
-           $rc = PVE::Tools::run_command($cmd, outfunc => $out, errfunc => $err, noerr => 1);
-       };
+       my $rc = eval { run_command($cmd, outfunc => $out, errfunc => $err, noerr => 1) };
        my $rerr = $@;
 
-       # use exit code if no stderr output and not just broken pipe
-       if (!$errstring && !$broken_pipe && $rc != 0 && $rc != 141) {
+       $broken_pipe ||= $rc == 141; # broken pipe from vma POV
+
+       if (!$errstring && !$broken_pipe && $rc != 0) {
            die "$rerr\n" if $rerr;
            die "config extraction failed with exit code $rc\n";
        }
        die "$errstring\n" if $errstring;
     } else {
-       # simple case without compression and weird piping behaviour
-       PVE::Tools::run_command(["vma", "config", $archive], outfunc => $out);
+       run_command(["vma", "config", $archive], outfunc => $out);
     }
 
     return wantarray ? ($raw, undef) : $raw;
@@ -1388,20 +1502,14 @@ sub extract_vzdump_config {
     }
 
     my $archive = abs_filesystem_path($cfg, $volid);
+    my $info = archive_info($archive);
+    my $format = $info->{format};
+    my $comp = $info->{compression};
+    my $type = $info->{type};
 
-    if ($volid =~ /vzdump-(lxc|openvz)-\d+-(\d{4})_(\d{2})_(\d{2})-(\d{2})_(\d{2})_(\d{2})\.(tgz|(tar(\.(gz|lzo))?))$/) {
+    if ($type eq 'lxc' || $type eq 'openvz') {
        return extract_vzdump_config_tar($archive, qr!^(\./etc/vzdump/(pct|vps)\.conf)$!);
-    } elsif ($volid =~ /vzdump-qemu-\d+-(\d{4})_(\d{2})_(\d{2})-(\d{2})_(\d{2})_(\d{2})\.(tgz|((tar|vma)(\.(gz|lzo))?))$/) {
-       my $format;
-       my $comp;
-       if ($7 eq 'tgz') {
-           $format = 'tar';
-           $comp = 'gz';
-       } else {
-           $format = $9;
-           $comp = $11 if defined($11);
-       }
-
+    } elsif ($type eq 'qemu') {
        if ($format eq 'tar') {
            return extract_vzdump_config_tar($archive, qr!\(\./qemu-server\.conf\)!);
        } else {
@@ -1424,14 +1532,14 @@ sub volume_export {
 }
 
 sub volume_import {
-    my ($cfg, $fh, $volid, $format, $base_snapshot, $with_snapshots) = @_;
+    my ($cfg, $fh, $volid, $format, $base_snapshot, $with_snapshots, $allow_rename) = @_;
 
     my ($storeid, $volname) = parse_volume_id($volid, 1);
     die "cannot import into volume '$volid'\n" if !$storeid;
     my $scfg = storage_config($cfg, $storeid);
     my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
     return $plugin->volume_import($scfg, $storeid, $fh, $volname, $format,
-                                  $base_snapshot, $with_snapshots);
+                                  $base_snapshot, $with_snapshots, $allow_rename) // $volid;
 }
 
 sub volume_export_formats {
@@ -1466,6 +1574,16 @@ sub volume_transfer_formats {
     return @common;
 }
 
+sub volume_imported_message {
+    my ($volid, $want_pattern) = @_;
+
+    if ($want_pattern) {
+       return qr/successfully imported '([^']*)'$/;
+    } else {
+       return "successfully imported '$volid'\n";
+    }
+}
+
 # bash completion helper
 
 sub complete_storage {