X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=PVE%2FStorage%2FPlugin.pm;h=8a58ff4050ae516af4ffe708a196e8bf274a704a;hb=8f26b3910d7e5149bfa495c3df9c44242af989d5;hp=43f3bdca4c889c3a3388f48f7786fbda4a333f4f;hpb=e34ce1444359ee06f50dd6907c0937d10748ce05;p=pve-storage.git diff --git a/PVE/Storage/Plugin.pm b/PVE/Storage/Plugin.pm index 43f3bdc..8a58ff4 100644 --- a/PVE/Storage/Plugin.pm +++ b/PVE/Storage/Plugin.pm @@ -2,16 +2,23 @@ package PVE::Storage::Plugin; use strict; use warnings; + +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 Data::Dumper; +use JSON; use base qw(PVE::SectionConfig); +use constant COMPRESSOR_RE => 'gz|lzo|zst'; + our @COMMON_TAR_FLAGS = qw( --one-file-system -p --sparse --numeric-owner --acls @@ -25,16 +32,73 @@ our @SHARED_STORAGE = ( 'cifs', 'rbd', 'cephfs', - 'sheepdog', 'iscsidirect', 'glusterfs', 'zfs', 'drbd'); +our $MAX_VOLUMES_PER_GUEST = 1024; + 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', +); + +my $prune_backups_format = { + '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 ($keep) = @_; + + die "at least one keep-option must be set and positive\n" + if !grep { $_ } values %{$keep}; + + return $keep; +} +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 => { @@ -60,6 +124,7 @@ my $defaultData = { minimum => 0, optional => 1, }, + 'prune-backups' => get_standard_option('prune-backups'), shared => { description => "Mark storage as shared.", type => 'boolean', @@ -141,7 +206,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"; } @@ -324,7 +389,7 @@ sub parse_config { priority => 0, # force first entry path => '/var/lib/vz', maxfiles => 0, - content => { images => 1, rootdir => 1, vztmpl => 1, iso => 1}, + content => { images => 1, rootdir => 1, vztmpl => 1, iso => 1, snippets => 1}, }; } @@ -362,6 +427,15 @@ sub on_add_hook { # do nothing by default } +# 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 +} + # called during deletion of storage (before the new storage config got written) # and if the activate check on addition fails, to cleanup all storage traces # which on_add_hook may have created. @@ -413,18 +487,20 @@ 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_extension_re)$!) { return ('iso', $1); } elsif ($volname =~ m!^vztmpl/([^/]+\.tar\.[gx]z)$!) { 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/([^/]+(?:\.(?:tgz|(?:(?:tar|vma)(?:\.(?:${\COMPRESSOR_RE}))?))))$!) { my $fn = $1; if ($fn =~ m/^vzdump-(openvz|lxc|qemu)-(\d+)-.+/) { return ('backup', $fn, $2); } return ('backup', $fn); + } elsif ($volname =~ m!^snippets/([^/]+)$!) { + return ('snippets', $1); } die "unable to parse directory volume name '$volname'\n"; @@ -436,8 +512,13 @@ my $vtype_subdirs = { iso => 'template/iso', vztmpl => 'template/cache', backup => 'dump', + snippets => 'snippets', }; +sub get_vtype_subdirs { + return $vtype_subdirs; +} + sub get_subdir { my ($class, $scfg, $vtype) = @_; @@ -523,25 +604,57 @@ sub create_base { return $newvolname; } -my $find_free_diskname = sub { - my ($imgdir, $vmid, $fmt) = @_; +my $get_vm_disk_number = sub { + my ($disk_name, $scfg, $vmid, $suffix) = @_; + + my $disk_regex = qr/(vm|base)-$vmid-disk-(\d+)$suffix/; + + my $type = $scfg->{type}; + my $def = { %{$defaultData->{plugindata}->{$type}} }; + + my $valid = $def->{format}[0]; + if ($valid->{subvol}) { + $disk_regex = qr/(vm|base|subvol|basevol)-$vmid-disk-(\d+)/; + } + + if ($disk_name =~ m/$disk_regex/) { + return $2; + } + + return undef; +}; + +sub get_next_vm_diskname { + my ($disk_list, $storeid, $vmid, $fmt, $scfg, $add_fmt_suffix) = @_; + + $fmt //= ''; + my $prefix = ($fmt eq 'subvol') ? 'subvol' : 'vm'; + my $suffix = $add_fmt_suffix ? ".$fmt" : ''; my $disk_ids = {}; - PVE::Tools::dir_glob_foreach($imgdir, - qr!(vm|base)-$vmid-disk-(\d+)\..*!, - sub { - my ($fn, $type, $disk) = @_; - $disk_ids->{$disk} = 1; - }); - - for (my $i = 1; $i < 100; $i++) { + foreach my $disk (@$disk_list) { + my $disknum = $get_vm_disk_number->($disk, $scfg, $vmid, $suffix); + $disk_ids->{$disknum} = 1 if defined($disknum); + } + + for (my $i = 0; $i < $MAX_VOLUMES_PER_GUEST; $i++) { if (!$disk_ids->{$i}) { - return "vm-$vmid-disk-$i.$fmt"; + return "$prefix-$vmid-disk-$i$suffix"; } } - die "unable to allocate a new image name for VM $vmid in '$imgdir'\n"; -}; + die "unable to allocate an image name for VM $vmid in storage '$storeid'\n" +} + +sub find_free_diskname { + my ($class, $storeid, $scfg, $vmid, $fmt, $add_fmt_suffix) = @_; + + my $disks = $class->list_images($storeid, $scfg, $vmid); + + my $disk_list = [ map { $_->{volid} } @$disks ]; + + return get_next_vm_diskname($disk_list, $storeid, $vmid, $fmt, $scfg, $add_fmt_suffix); +} sub clone_image { my ($class, $scfg, $storeid, $volname, $vmid, $snap) = @_; @@ -565,7 +678,7 @@ sub clone_image { mkpath $imagedir; - my $name = &$find_free_diskname($imagedir, $vmid, "qcow2"); + my $name = $class->find_free_diskname($imagedir, $scfg, $vmid, "qcow2", 1); warn "clone $volname: $vtype, $name, $vmid to $name (base=../$basevmid/$basename)\n"; @@ -597,7 +710,7 @@ sub alloc_image { mkpath $imagedir; - $name = &$find_free_diskname($imagedir, $vmid, $fmt) if !$name; + $name = $class->find_free_diskname($imagedir, $scfg, $vmid, $fmt, 1) if !$name; my (undef, $tmpfmt) = parse_name_dir($name); @@ -611,7 +724,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"; @@ -621,12 +734,17 @@ sub alloc_image { my $cmd = ['/usr/bin/qemu-img', 'create']; push @$cmd, '-o', 'preallocation=metadata' if $fmt eq 'qcow2'; - + push @$cmd, '-f', $fmt, $path, "${size}K"; - run_command($cmd, errmsg => "unable to create image"); + eval { run_command($cmd, errmsg => "unable to create image"); }; + if ($@) { + unlink $path; + rmdir $imagedir; + die "$@"; + } } - + return "$vmid/$name"; } @@ -644,56 +762,47 @@ sub free_image { if (defined($format) && ($format eq 'subvol')) { File::Path::remove_tree($path); } else { - - if (! -f $path) { - warn "disk image '$path' does not exists\n"; + if (!(-f $path || -l $path)) { + warn "disk image '$path' does not exist\n"; return undef; } unlink($path) || die "unlink '$path' failed - $!\n"; } - + + # try to cleanup directory to not clutter storage with empty $vmid dirs if + # 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 $cmd = ['/usr/bin/qemu-img', 'info', $filename]; + my $st = File::stat::stat($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 $@; - return wantarray ? ($size, $format, $used, $parent) : $size; + my $info = eval { decode_json($json) }; + warn "could not parse qemu-img info command output for '$filename'\n" if $@; + + my ($size, $format, $used, $parent) = $info->@{qw(virtual-size format actual-size backing-filename)}; + + return wantarray ? ($size, $format, $used, $parent, $st->ctime) : $size; } sub volume_size_info { @@ -736,9 +845,9 @@ sub volume_snapshot { } sub volume_rollback_is_possible { - my ($class, $scfg, $storeid, $volname, $snap) = @_; + my ($class, $scfg, $storeid, $volname, $snap) = @_; - return 1; + return 1; } sub volume_snapshot_rollback { @@ -780,7 +889,7 @@ 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} }, @@ -793,6 +902,11 @@ sub volume_has_feature { current => {qcow2 => 1, raw => 1, vmdk => 1} }, }; + # clone_image creates a qcow2 volume + return 0 if $feature eq 'clone' && + defined($opts->{valid_target_formats}) && + !(grep { $_ eq 'qcow2' } @{$opts->{valid_target_formats}}); + my ($vtype, $name, $vmid, $basename, $basevmid, $isBase, $format) = $class->parse_volname($volname); @@ -828,7 +942,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; @@ -844,10 +958,120 @@ 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_extension_re)$!i; + + $info = { volid => "$sid:iso/$1", format => 'iso' }; + + } elsif ($tt eq 'vztmpl') { + next if $fn !~ m!/([^/]+\.tar\.([gx]z))$!; + + $info = { volid => "$sid:vztmpl/$1", format => "t$2" }; + + } elsif ($tt eq 'backup') { + next if defined($vmid) && $fn !~ m/\S+-$vmid-\S+/; + next if $fn !~ m!/([^/]+\.(tgz|(?:(?:tar|vma)(?:\.(${\COMPRESSOR_RE}))?)))$!; + my $format = $2; + $fn = $1; + $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}); + + if (defined($vmid) || $fn =~ m!\-([1-9][0-9]{2,8})\-[^/]+\.${format}$!) { + $info->{vmid} = $vmid // $1; + } + + } 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; +}; + +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; @@ -912,6 +1136,19 @@ sub deactivate_storage { # do nothing by default } +sub map_volume { + my ($class, $storeid, $scfg, $volname, $snapname) = @_; + + my ($path) = $class->path($scfg, $volname, $storeid, $snapname); + return $path; +} + +sub unmap_volume { + my ($class, $storeid, $scfg, $volname, $snapname) = @_; + + return 1; +} + sub activate_volume { my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_; @@ -937,6 +1174,71 @@ 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 $backup_vmid = $backup->{vmid}; + my $archive_info = eval { PVE::Storage::archive_info($volid) } // {}; + my $backup_type = $archive_info->{type} // 'unknown'; + + 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}) { + $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} = '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, @@ -975,7 +1277,8 @@ 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); + die "import: got a bad size (not a multiple of 1K), aborting.\n" if ($size&1023); # Size is in bytes! return $size; } @@ -1035,7 +1338,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, $base_snapshot, $with_snapshots, $allow_rename) = @_; die "volume import format '$format' not available for $class\n" if $format !~ /^(raw|tar|qcow2|vmdk)\+size$/; @@ -1057,16 +1360,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) @@ -1086,6 +1393,8 @@ sub volume_import { warn $@ if $@; die $err; } + + return "$storeid:$volname"; } sub volume_import_formats {