X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=PVE%2FStorage%2FPlugin.pm;h=8a41df10b94b7112bf566561409305505fc8e67c;hb=2be327abf62a9df0f958c19a9bc60dded84de352;hp=b565e92f471625e4f052f1124e147ab3282b5220;hpb=f6f22cb3a25adaec7182746aabbc2a389681a3cb;p=pve-storage.git diff --git a/PVE/Storage/Plugin.pm b/PVE/Storage/Plugin.pm index b565e92..8a41df1 100644 --- a/PVE/Storage/Plugin.pm +++ b/PVE/Storage/Plugin.pm @@ -3,16 +3,26 @@ package PVE::Storage::Plugin; use strict; use warnings; +use Encode qw(decode); +use Fcntl ':mode'; use File::chdir; use File::Path; use File::Basename; +use File::stat qw(); use PVE::Tools qw(run_command); -use PVE::JSONSchema qw(get_standard_option); +use PVE::JSONSchema qw(get_standard_option register_standard_option); use PVE::Cluster qw(cfs_register_file); +use JSON; + use base qw(PVE::SectionConfig); +use constant COMPRESSOR_RE => 'gz|lzo|zst'; + +use constant LOG_EXT => ".log"; +use constant NOTES_EXT => ".notes"; + our @COMMON_TAR_FLAGS = qw( --one-file-system -p --sparse --numeric-owner --acls @@ -29,7 +39,22 @@ our @SHARED_STORAGE = ( 'iscsidirect', 'glusterfs', 'zfs', - 'drbd'); + 'drbd', + 'pbs', +); + +our $QCOW2_PREALLOCATION = { + off => 1, + metadata => 1, + falloc => 1, + full => 1, +}; + +our $RAW_PREALLOCATION = { + off => 1, + falloc => 1, + full => 1, +}; our $MAX_VOLUMES_PER_GUEST = 1024; @@ -37,6 +62,74 @@ cfs_register_file ('storage.cfg', sub { __PACKAGE__->parse_config(@_); }, sub { __PACKAGE__->write_config(@_); }); +my %prune_option = ( + optional => 1, + type => 'integer', minimum => '0', + format_description => 'N', +); + +our $prune_backups_format = { + 'keep-all' => { + type => 'boolean', + description => 'Keep all backups. Conflicts with the other options when true.', + optional => 1, + }, + 'keep-last' => { + %prune_option, + description => 'Keep the last backups.', + }, + 'keep-hourly' => { + %prune_option, + description => 'Keep backups for the last different hours. If there is more' . + 'than one backup for a single hour, only the latest one is kept.' + }, + 'keep-daily' => { + %prune_option, + description => 'Keep backups for the last different days. If there is more' . + 'than one backup for a single day, only the latest one is kept.' + }, + 'keep-weekly' => { + %prune_option, + description => 'Keep backups for the last different weeks. If there is more' . + 'than one backup for a single week, only the latest one is kept.' + }, + 'keep-monthly' => { + %prune_option, + description => 'Keep backups for the last different months. If there is more' . + 'than one backup for a single month, only the latest one is kept.' + }, + 'keep-yearly' => { + %prune_option, + description => 'Keep backups for the last different years. If there is more' . + 'than one backup for a single year, only the latest one is kept.' + }, +}; +PVE::JSONSchema::register_format('prune-backups', $prune_backups_format, \&validate_prune_backups); +sub validate_prune_backups { + my ($prune_backups) = @_; + + my $res = { $prune_backups->%* }; + + my $keep_all = delete $res->{'keep-all'}; + + if (scalar(grep { $_ > 0 } values %{$res}) == 0) { + $res = { 'keep-all' => 1 }; + } elsif ($keep_all) { + die "keep-all cannot be set together with other options.\n"; + } + + return $res; +} +register_standard_option('prune-backups', { + description => "The retention options with shorter intervals are processed first " . + "with --keep-last being the very first one. Each option covers a " . + "specific period of time. We say that backups within this period " . + "are covered by this option. The next option does not take care " . + "of already covered backups and only considers older backups.", + optional => 1, + type => 'string', + format => 'prune-backups', +}); my $defaultData = { propertyList => { @@ -57,11 +150,20 @@ my $defaultData = { optional => 1, }, maxfiles => { - description => "Maximal number of backup files per VM. Use '0' for unlimted.", + description => "Deprecated: use 'prune-backups' instead. " . + "Maximal number of backup files per VM. Use '0' for unlimited.", type => 'integer', minimum => 0, optional => 1, }, + 'prune-backups' => get_standard_option('prune-backups'), + 'max-protected-backups' => { + description => "Maximal number of protected backups per guest. Use '-1' for unlimited.", + type => 'integer', + minimum => -1, + optional => 1, + default => "Unlimited for users with Datastore.Allocate privilege, 5 for other users", + }, shared => { description => "Mark storage as shared.", type => 'boolean', @@ -72,6 +174,13 @@ my $defaultData = { type => 'string', format => 'pve-storage-format', optional => 1, }, + preallocation => { + description => "Preallocation mode for raw and qcow2 images. " . + "Using 'metadata' on raw images results in preallocation=off.", + type => 'string', enum => ['off', 'metadata', 'falloc', 'full'], + default => 'metadata', + optional => 1, + }, }, }; @@ -143,7 +252,7 @@ PVE::JSONSchema::register_format('pve-storage-vgname', \&parse_lvm_name); sub parse_lvm_name { my ($name, $noerr) = @_; - if ($name !~ m/^[a-z][a-z0-9\-\_\.]*[a-z0-9]$/i) { + if ($name !~ m/^[a-z0-9][a-z0-9\-\_\.]*[a-z0-9]$/i) { return undef if $noerr; die "lvm name '$name' contains illegal characters\n"; } @@ -267,6 +376,10 @@ sub decode_value { die "unable to combine 'none' with other content types\n"; } + if (scalar(keys $res->%*) == 0 && !$valid_content->{none}) { + die "storage does not support content type 'none'\n"; + } + return $res; } elsif ($key eq 'format') { my $valid_formats = $def->{format}->[0]; @@ -325,8 +438,15 @@ sub parse_config { type => 'dir', priority => 0, # force first entry path => '/var/lib/vz', - maxfiles => 0, - content => { images => 1, rootdir => 1, vztmpl => 1, iso => 1, snippets => 1}, + 'prune-backups' => 'keep-all=1', + content => { + backup => 1, + images => 1, + iso => 1, + rootdir => 1, + snippets => 1, + vztmpl => 1, + }, }; } @@ -353,15 +473,51 @@ sub parse_config { return $cfg; } +sub preallocation_cmd_option { + my ($scfg, $fmt) = @_; + + my $prealloc = $scfg->{preallocation}; + + if ($fmt eq 'qcow2') { + $prealloc = $prealloc // 'metadata'; + + die "preallocation mode '$prealloc' not supported by format '$fmt'\n" + if !$QCOW2_PREALLOCATION->{$prealloc}; + + return "preallocation=$prealloc"; + } elsif ($fmt eq 'raw') { + $prealloc = $prealloc // 'off'; + $prealloc = 'off' if $prealloc eq 'metadata'; + + die "preallocation mode '$prealloc' not supported by format '$fmt'\n" + if !$RAW_PREALLOCATION->{$prealloc}; + + return "preallocation=$prealloc"; + } + + return; +} + # Storage implementation # called during addition of storage (before the new storage config got written) -# die to abort additon if there are (grave) problems +# die to abort addition if there are (grave) problems # NOTE: runs in a storage config *locked* context sub on_add_hook { my ($class, $storeid, $scfg, %param) = @_; # do nothing by default + return undef; +} + +# called during storage configuration update (before the updated storage config got written) +# die to abort the update if there are (grave) problems +# NOTE: runs in a storage config *locked* context +sub on_update_hook { + my ($class, $storeid, $scfg, %param) = @_; + + # do nothing by default + return undef; } # called during deletion of storage (before the new storage config got written) @@ -373,6 +529,7 @@ sub on_delete_hook { my ($class, $storeid, $scfg) = @_; # do nothing by default + return undef; } sub cluster_lock_storage { @@ -415,13 +572,13 @@ sub parse_volname { my ($vmid, $name) = ($1, $2); my (undef, $format, $isBase) = parse_name_dir($name); return ('images', $name, $vmid, undef, undef, $isBase, $format); - } elsif ($volname =~ m!^iso/([^/]+\.[Ii][Ss][Oo])$!) { + } elsif ($volname =~ m!^iso/([^/]+$PVE::Storage::ISO_EXT_RE_0)$!) { return ('iso', $1); - } elsif ($volname =~ m!^vztmpl/([^/]+\.tar\.[gx]z)$!) { + } elsif ($volname =~ m!^vztmpl/([^/]+$PVE::Storage::VZTMPL_EXT_RE_1)$!) { return ('vztmpl', $1); } elsif ($volname =~ m!^rootdir/(\d+)$!) { return ('rootdir', $1, $1); - } elsif ($volname =~ m!^backup/([^/]+(\.(tar|tar\.gz|tar\.lzo|tgz|vma|vma\.gz|vma\.lzo)))$!) { + } elsif ($volname =~ m!^backup/([^/]+$PVE::Storage::BACKUP_EXT_RE_2)$!) { my $fn = $1; if ($fn =~ m/^vzdump-(openvz|lxc|qemu)-(\d+)-.+/) { return ('backup', $fn, $2); @@ -443,12 +600,16 @@ my $vtype_subdirs = { snippets => 'snippets', }; +sub get_vtype_subdirs { + return $vtype_subdirs; +} + sub get_subdir { my ($class, $scfg, $vtype) = @_; my $path = $scfg->{path}; - die "storage definintion has no path\n" if !$path; + die "storage definition has no path\n" if !$path; my $subdir = $vtype_subdirs->{$vtype}; @@ -570,24 +731,21 @@ sub get_next_vm_diskname { die "unable to allocate an image name for VM $vmid in storage '$storeid'\n" } -my $find_free_diskname = sub { - my ($imgdir, $vmid, $fmt, $scfg) = @_; +sub find_free_diskname { + my ($class, $storeid, $scfg, $vmid, $fmt, $add_fmt_suffix) = @_; - my $disk_list = []; + my $disks = $class->list_images($storeid, $scfg, $vmid); - if (defined(my $dh = IO::Dir->new($imgdir))) { - @$disk_list = $dh->read(); - $dh->close(); - } + my $disk_list = [ map { $_->{volid} } @$disks ]; - return get_next_vm_diskname($disk_list, $imgdir, $vmid, $fmt, $scfg, 1); -}; + return get_next_vm_diskname($disk_list, $storeid, $vmid, $fmt, $scfg, $add_fmt_suffix); +} sub clone_image { my ($class, $scfg, $storeid, $volname, $vmid, $snap) = @_; # this only works for file based storage types - die "storage definintion has no path\n" if !$scfg->{path}; + die "storage definition has no path\n" if !$scfg->{path}; my ($vtype, $basename, $basevmid, undef, undef, $isBase, $format) = $class->parse_volname($volname); @@ -605,7 +763,7 @@ sub clone_image { mkpath $imagedir; - my $name = $find_free_diskname->($imagedir, $vmid, "qcow2", $scfg); + my $name = $class->find_free_diskname($storeid, $scfg, $vmid, "qcow2", 1); warn "clone $volname: $vtype, $name, $vmid to $name (base=../$basevmid/$basename)\n"; @@ -618,7 +776,7 @@ sub clone_image { local $CWD = $imagedir; my $cmd = ['/usr/bin/qemu-img', 'create', '-b', "../$basevmid/$basename", - '-f', 'qcow2', $path]; + '-F', $format, '-f', 'qcow2', $path]; run_command($cmd); }; @@ -637,7 +795,7 @@ sub alloc_image { mkpath $imagedir; - $name = $find_free_diskname->($imagedir, $vmid, $fmt, $scfg) if !$name; + $name = $class->find_free_diskname($storeid, $scfg, $vmid, $fmt, 1) if !$name; my (undef, $tmpfmt) = parse_name_dir($name); @@ -651,7 +809,7 @@ sub alloc_image { if ($fmt eq 'subvol') { # only allow this if size = 0, so that user knows what he is doing die "storage does not support subvol quotas\n" if $size != 0; - + my $old_umask = umask(0022); my $err; mkdir($path) or $err = "unable to create subvol '$path' - $!\n"; @@ -660,8 +818,9 @@ sub alloc_image { } else { my $cmd = ['/usr/bin/qemu-img', 'create']; - push @$cmd, '-o', 'preallocation=metadata' if $fmt eq 'qcow2'; - + my $prealloc_opt = preallocation_cmd_option($scfg, $fmt); + push @$cmd, '-o', $prealloc_opt if defined($prealloc_opt); + push @$cmd, '-f', $fmt, $path, "${size}K"; eval { run_command($cmd, errmsg => "unable to create image"); }; @@ -671,13 +830,16 @@ sub alloc_image { die "$@"; } } - + return "$vmid/$name"; } sub free_image { my ($class, $storeid, $scfg, $volname, $isBase, $format) = @_; + die "cannot remove protected volume '$volname' on '$storeid'\n" + if $class->get_volume_attribute($scfg, $storeid, $volname, 'protected'); + my $path = $class->filesystem_path($scfg, $volname); if ($isBase) { @@ -689,8 +851,8 @@ sub free_image { if (defined($format) && ($format eq 'subvol')) { File::Path::remove_tree($path); } else { - if (! -e $path) { - warn "disk image '$path' does not exists\n"; + if (!(-f $path || -l $path)) { + warn "disk image '$path' does not exist\n"; return undef; } @@ -701,48 +863,101 @@ sub free_image { # all images from a guest got deleted my $dir = dirname($path); rmdir($dir); - + return undef; } sub file_size_info { my ($filename, $timeout) = @_; - if (-d $filename) { - return wantarray ? (0, 'subvol', 0, undef) : 1; + my $st = File::stat::stat($filename); + + if (!defined($st)) { + my $extramsg = -l $filename ? ' - dangling symlink?' : ''; + warn "failed to stat '$filename'$extramsg\n"; + return undef; } - - my $cmd = ['/usr/bin/qemu-img', 'info', $filename]; - my $format; - my $parent; - my $size = 0; - my $used = 0; + if (S_ISDIR($st->mode)) { + return wantarray ? (0, 'subvol', 0, undef, $st->ctime) : 1; + } + my $json = ''; eval { - run_command($cmd, timeout => $timeout, outfunc => sub { - my $line = shift; - if ($line =~ m/^file format:\s+(\S+)\s*$/) { - $format = $1; - } elsif ($line =~ m/^backing file:\s(\S+)\s/) { - $parent = $1; - } elsif ($line =~ m/^virtual size:\s\S+\s+\((\d+)\s+bytes\)$/) { - $size = int($1); - } elsif ($line =~ m/^disk size:\s+(\d+(.\d+)?)([KMGT])\s*$/) { - $used = $1; - my $u = $3; - - $used *= 1024 if $u eq 'K'; - $used *= (1024*1024) if $u eq 'M'; - $used *= (1024*1024*1024) if $u eq 'G'; - $used *= (1024*1024*1024*1024) if $u eq 'T'; - - $used = int($used); - } - }); + run_command(['/usr/bin/qemu-img', 'info', '--output=json', $filename], + timeout => $timeout, + outfunc => sub { $json .= shift }, + errfunc => sub { warn "$_[0]\n" } + ); }; + warn $@ if $@; + + my $info = eval { decode_json($json) }; + if (my $err = $@) { + warn "could not parse qemu-img info command output for '$filename' - $err\n"; + return wantarray ? (undef, undef, undef, undef, $st->ctime) : undef; + } + + my ($size, $format, $used, $parent) = $info->@{qw(virtual-size format actual-size backing-filename)}; + + ($size) = ($size =~ /^(\d+)$/) or die "size '$size' not an integer\n"; # untaint + # coerce back from string + $size = int($size); + ($used) = ($used =~ /^(\d+)$/) or die "used '$used' not an integer\n"; # untaint + # coerce back from string + $used = int($used); + ($format) = ($format =~ /^(\S+)$/) or die "format '$format' includes whitespace\n"; # untaint + if (defined($parent)) { + ($parent) = ($parent =~ /^(\S+)$/) or die "parent '$parent' includes whitespace\n"; # untaint + } + return wantarray ? ($size, $format, $used, $parent, $st->ctime) : $size; +} + +# FIXME remove on the next APIAGE reset. +# Deprecated, use get_volume_attribute instead. +sub get_volume_notes { + my ($class, $scfg, $storeid, $volname, $timeout) = @_; + + die "volume notes are not supported for $class"; +} - return wantarray ? ($size, $format, $used, $parent) : $size; +# FIXME remove on the next APIAGE reset. +# Deprecated, use update_volume_attribute instead. +sub update_volume_notes { + my ($class, $scfg, $storeid, $volname, $notes, $timeout) = @_; + + die "volume notes are not supported for $class"; +} + +# Returns undef if the attribute is not supported for the volume. +# Should die if there is an error fetching the attribute. +# Possible attributes: +# notes - user-provided comments/notes. +# protected - not to be removed by free_image, and for backups, ignored when pruning. +sub get_volume_attribute { + my ($class, $scfg, $storeid, $volname, $attribute) = @_; + + if ($attribute eq 'notes') { + my $notes = eval { $class->get_volume_notes($scfg, $storeid, $volname); }; + if (my $err = $@) { + return if $err =~ m/^volume notes are not supported/; + die $err; + } + return $notes; + } + + return; +} + +# Dies if the attribute is not supported for the volume. +sub update_volume_attribute { + my ($class, $scfg, $storeid, $volname, $attribute, $value) = @_; + + if ($attribute eq 'notes') { + $class->update_volume_notes($scfg, $storeid, $volname, $value); + } + + die "attribute '$attribute' is not supported for storage type '$scfg->{type}'\n"; } sub volume_size_info { @@ -784,10 +999,13 @@ sub volume_snapshot { return undef; } +# Asserts that a rollback to $snap on $volname is possible. +# If certain snapshots are preventing the rollback and $blockers is an array +# reference, the snapshot names can be pushed onto $blockers prior to dying. sub volume_rollback_is_possible { - my ($class, $scfg, $storeid, $volname, $snap) = @_; + my ($class, $scfg, $storeid, $volname, $snap, $blockers) = @_; - return 1; + return 1; } sub volume_snapshot_rollback { @@ -822,6 +1040,10 @@ sub volume_snapshot_delete { return undef; } +sub volume_snapshot_needs_fsfreeze { + + return 0; +} sub storage_can_replicate { my ($class, $scfg, $storeid, $format) = @_; @@ -829,21 +1051,46 @@ sub storage_can_replicate { } sub volume_has_feature { - my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running) = @_; + my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running, $opts) = @_; my $features = { - snapshot => { current => { qcow2 => 1}, snap => { qcow2 => 1} }, - clone => { base => {qcow2 => 1, raw => 1, vmdk => 1} }, - template => { current => {qcow2 => 1, raw => 1, vmdk => 1, subvol => 1} }, - copy => { base => {qcow2 => 1, raw => 1, vmdk => 1}, - current => {qcow2 => 1, raw => 1, vmdk => 1}, - snap => {qcow2 => 1} }, - sparseinit => { base => {qcow2 => 1, raw => 1, vmdk => 1}, - current => {qcow2 => 1, raw => 1, vmdk => 1} }, + snapshot => { + current => { qcow2 => 1 }, + snap => { qcow2 => 1 }, + }, + clone => { + base => { qcow2 => 1, raw => 1, vmdk => 1 }, + }, + template => { + current => { qcow2 => 1, raw => 1, vmdk => 1, subvol => 1 }, + }, + copy => { + base => { qcow2 => 1, raw => 1, vmdk => 1 }, + current => { qcow2 => 1, raw => 1, vmdk => 1 }, + snap => { qcow2 => 1 }, + }, + sparseinit => { + base => { qcow2 => 1, raw => 1, vmdk => 1 }, + current => { qcow2 => 1, raw => 1, vmdk => 1 }, + }, + rename => { + current => {qcow2 => 1, raw => 1, vmdk => 1}, + }, }; - my ($vtype, $name, $vmid, $basename, $basevmid, $isBase, $format) = - $class->parse_volname($volname); + if ($feature eq 'clone') { + if ( + defined($opts->{valid_target_formats}) + && !(grep { $_ eq 'qcow2' } @{$opts->{valid_target_formats}}) + ) { + return 0; # clone_image creates a qcow2 volume + } + } elsif ($feature eq 'rename') { + return 0 if $class->can('api') && $class->api() < 10; + } + + + my ($vtype, $name, $vmid, $basename, $basevmid, $isBase, $format) = $class->parse_volname($volname); my $key = undef; if($snapname){ @@ -877,7 +1124,7 @@ sub list_images { next if !$vollist && defined($vmid) && ($owner ne $vmid); - my ($size, $format, $used, $parent) = file_size_info($fn); + my ($size, $format, $used, $parent, $ctime) = file_size_info($fn); next if !($format && defined($size)); my $volid; @@ -893,10 +1140,133 @@ sub list_images { next if !$found; } - push @$res, { + my $info = { volid => $volid, format => $format, size => $size, vmid => $owner, used => $used, parent => $parent }; + + $info->{ctime} = $ctime if $ctime; + + push @$res, $info; + } + + return $res; +} + +# list templates ($tt = ) +my $get_subdir_files = sub { + my ($sid, $path, $tt, $vmid) = @_; + + my $res = []; + + foreach my $fn (<$path/*>) { + my $st = File::stat::stat($fn); + + next if (!$st || S_ISDIR($st->mode)); + + my $info; + + if ($tt eq 'iso') { + next if $fn !~ m!/([^/]+$PVE::Storage::ISO_EXT_RE_0)$!i; + + $info = { volid => "$sid:iso/$1", format => 'iso' }; + + } elsif ($tt eq 'vztmpl') { + next if $fn !~ m!/([^/]+$PVE::Storage::VZTMPL_EXT_RE_1)$!; + + $info = { volid => "$sid:vztmpl/$1", format => "t$2" }; + + } elsif ($tt eq 'backup') { + next if $fn !~ m!/([^/]+$PVE::Storage::BACKUP_EXT_RE_2)$!; + my $original = $fn; + my $format = $2; + $fn = $1; + + # only match for VMID now, to avoid false positives (VMID in parent directory name) + next if defined($vmid) && $fn !~ m/\S+-$vmid-\S+/; + + $info = { volid => "$sid:backup/$fn", format => $format }; + + my $archive_info = eval { PVE::Storage::archive_info($fn) } // {}; + + $info->{ctime} = $archive_info->{ctime} if defined($archive_info->{ctime}); + $info->{subtype} = $archive_info->{type} // 'unknown'; + + if (defined($vmid) || $fn =~ m!\-([1-9][0-9]{2,8})\-[^/]+\.${format}$!) { + $info->{vmid} = $vmid // $1; + } + + my $notes_fn = $original.NOTES_EXT; + if (-f $notes_fn) { + my $notes = PVE::Tools::file_read_firstline($notes_fn); + $info->{notes} = eval { decode('UTF-8', $notes, 1) } // $notes if defined($notes); + } + + $info->{protected} = 1 if -e PVE::Storage::protection_file_path($original); + } elsif ($tt eq 'snippets') { + + $info = { + volid => "$sid:snippets/". basename($fn), + format => 'snippet', + }; + } + + $info->{size} = $st->size; + $info->{ctime} //= $st->ctime; + + push @$res, $info; + } + + return $res; +}; + +# If attributes are set on a volume, they should be included in the result. +# See get_volume_attribute for a list of possible attributes. +sub list_volumes { + my ($class, $storeid, $scfg, $vmid, $content_types) = @_; + + my $res = []; + my $vmlist = PVE::Cluster::get_vmlist(); + foreach my $type (@$content_types) { + my $data; + + if ($type eq 'images' || $type eq 'rootdir') { + $data = $class->list_images($storeid, $scfg, $vmid); + } elsif ($scfg->{path}) { + my $path = $class->get_subdir($scfg, $type); + + if ($type eq 'iso' && !defined($vmid)) { + $data = $get_subdir_files->($storeid, $path, 'iso'); + } elsif ($type eq 'vztmpl'&& !defined($vmid)) { + $data = $get_subdir_files->($storeid, $path, 'vztmpl'); + } elsif ($type eq 'backup') { + $data = $get_subdir_files->($storeid, $path, 'backup', $vmid); + } elsif ($type eq 'snippets') { + $data = $get_subdir_files->($storeid, $path, 'snippets'); + } + } + + next if !$data; + + foreach my $item (@$data) { + if ($type eq 'images' || $type eq 'rootdir') { + my $vminfo = $vmlist->{ids}->{$item->{vmid}}; + my $vmtype; + if (defined($vminfo)) { + $vmtype = $vminfo->{type}; + } + if (defined($vmtype) && $vmtype eq 'lxc') { + $item->{content} = 'rootdir'; + } else { + $item->{content} = 'images'; + } + next if $type ne $item->{content}; + } else { + $item->{content} = $type; + } + + push @$res, $item; + } } return $res; @@ -907,7 +1277,7 @@ sub status { my $path = $scfg->{path}; - die "storage definintion has no path\n" if !$path; + die "storage definition has no path\n" if !$path; my $timeout = 2; my $res = PVE::Tools::df($path, $timeout); @@ -917,13 +1287,14 @@ sub status { return ($res->{total}, $res->{avail}, $res->{used}, 1); } -sub volume_snapshot_list { +# Returns a hash with the snapshot names as keys and the following data: +# id - Unique id to distinguish different snapshots even if the have the same name. +# timestamp - Creation time of the snapshot (seconds since epoch). +# Returns an empty hash if the volume does not exist. +sub volume_snapshot_info { my ($class, $scfg, $storeid, $volname) = @_; - # implement in subclass - die "Volume_snapshot_list is not implemented for $class"; - - # return an empty array if dataset does not exist. + die "volume_snapshot_info is not implemented for $class"; } sub activate_storage { @@ -931,7 +1302,7 @@ sub activate_storage { my $path = $scfg->{path}; - die "storage definintion has no path\n" if !$path; + die "storage definition has no path\n" if !$path; # this path test may hang indefinitely on unresponsive mounts my $timeout = 2; @@ -999,6 +1370,77 @@ sub check_connection { return 1; } +sub prune_backups { + my ($class, $scfg, $storeid, $keep, $vmid, $type, $dryrun, $logfunc) = @_; + + $logfunc //= sub { print "$_[1]\n" }; + + my $backups = $class->list_volumes($storeid, $scfg, $vmid, ['backup']); + + my $backup_groups = {}; + my $prune_list = []; + + foreach my $backup (@{$backups}) { + my $volid = $backup->{volid}; + my $archive_info = eval { PVE::Storage::archive_info($volid) } // {}; + my $backup_type = $archive_info->{type} // 'unknown'; + my $backup_vmid = $archive_info->{vmid} // $backup->{vmid}; + + next if defined($type) && $type ne $backup_type; + + my $prune_entry = { + ctime => $backup->{ctime}, + type => $backup_type, + volid => $volid, + }; + + $prune_entry->{vmid} = $backup_vmid if defined($backup_vmid); + + if ($archive_info->{is_std_name}) { + die "internal error - got no VMID\n" if !defined($backup_vmid); + die "internal error - got wrong VMID '$backup_vmid' != '$vmid'\n" + if defined($vmid) && $backup_vmid ne $vmid; + + $prune_entry->{ctime} = $archive_info->{ctime}; + my $group = "$backup_type/$backup_vmid"; + push @{$backup_groups->{$group}}, $prune_entry; + } else { + # ignore backups that don't use the standard naming scheme + $prune_entry->{mark} = 'renamed'; + } + + $prune_entry->{mark} = 'protected' if $backup->{protected}; + + push @{$prune_list}, $prune_entry; + } + + foreach my $backup_group (values %{$backup_groups}) { + PVE::Storage::prune_mark_backup_group($backup_group, $keep); + } + + my $failed; + if (!$dryrun) { + foreach my $prune_entry (@{$prune_list}) { + next if $prune_entry->{mark} ne 'remove'; + + my $volid = $prune_entry->{volid}; + $logfunc->('info', "removing backup '$volid'"); + eval { + my (undef, $volname) = parse_volume_id($volid); + my $archive_path = $class->filesystem_path($scfg, $volname); + PVE::Storage::archive_remove($archive_path); + }; + if (my $err = $@) { + $logfunc->('err', "error when removing backup '$volid' - $err\n"); + $failed = 1; + } + } + } + die "error pruning backups - check log\n" if $failed; + + return $prune_list; +} + # Import/Export interface: # Any path based storage is assumed to support 'raw' and 'tar' streams, so # the default implementations will return this if $scfg->{path} is set, @@ -1037,7 +1479,7 @@ sub read_common_header($) { my ($fh) = @_; sysread($fh, my $size, 8); $size = unpack('Q<', $size); - die "got a bad size (not a multiple of 1K)\n" if ($size&1023); + die "import: no size found in export header, aborting.\n" if !defined($size); # Size is in bytes! return $size; } @@ -1097,7 +1539,7 @@ sub volume_export_formats { # Import data from a stream, creating a new or replacing or adding to an existing volume. sub volume_import { - my ($class, $scfg, $storeid, $fh, $volname, $format, $base_snapshot, $with_snapshots) = @_; + my ($class, $scfg, $storeid, $fh, $volname, $format, $snapshot, $base_snapshot, $with_snapshots, $allow_rename) = @_; die "volume import format '$format' not available for $class\n" if $format !~ /^(raw|tar|qcow2|vmdk)\+size$/; @@ -1119,16 +1561,20 @@ sub volume_import { # Check for an existing file first since interrupting alloc_image doesn't # free it. my $file = $class->path($scfg, $volname, $storeid); - die "file '$file' already exists\n" if -e $file; + if (-e $file) { + die "file '$file' already exists\n" if !$allow_rename; + warn "file '$file' already exists - importing with a different name\n"; + $name = undef; + } my ($size) = read_common_header($fh); $size = int($size/1024); eval { my $allocname = $class->alloc_image($storeid, $scfg, $vmid, $file_format, $name, $size); - if ($allocname ne $volname) { - my $oldname = $volname; - $volname = $allocname; # Let the cleanup code know what to free + my $oldname = $volname; + $volname = $allocname; + if (defined($name) && $allocname ne $oldname) { die "internal error: unexpected allocated name: '$allocname' != '$oldname'\n"; } my $file = $class->path($scfg, $volname, $storeid) @@ -1148,10 +1594,12 @@ sub volume_import { warn $@ if $@; die $err; } + + return "$storeid:$volname"; } sub volume_import_formats { - my ($class, $scfg, $storeid, $volname, $base_snapshot, $with_snapshots) = @_; + my ($class, $scfg, $storeid, $volname, $snapshot, $base_snapshot, $with_snapshots) = @_; if ($scfg->{path} && !defined($base_snapshot)) { my $format = ($class->parse_volname($volname))[6]; if ($with_snapshots) { @@ -1164,4 +1612,39 @@ sub volume_import_formats { return (); } +sub rename_volume { + my ($class, $scfg, $storeid, $source_volname, $target_vmid, $target_volname) = @_; + die "not implemented in storage plugin '$class'\n" if $class->can('api') && $class->api() < 10; + die "no path found\n" if !$scfg->{path}; + + my ( + undef, + $source_image, + $source_vmid, + $base_name, + $base_vmid, + undef, + $format + ) = $class->parse_volname($source_volname); + + $target_volname = $class->find_free_diskname($storeid, $scfg, $target_vmid, $format, 1) + if !$target_volname; + + my $basedir = $class->get_subdir($scfg, 'images'); + + mkpath "${basedir}/${target_vmid}"; + + my $old_path = "${basedir}/${source_vmid}/${source_image}"; + my $new_path = "${basedir}/${target_vmid}/${target_volname}"; + + die "target volume '${target_volname}' already exists\n" if -e $new_path; + + my $base = $base_name ? "${base_vmid}/${base_name}/" : ''; + + rename($old_path, $new_path) || + die "rename '$old_path' to '$new_path' failed - $!\n"; + + return "${storeid}:${base}${target_vmid}/${target_volname}"; +} + 1;