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 JSON;
use base qw(PVE::SectionConfig);
+use constant COMPRESSOR_RE => 'gz|lzo|zst';
+
+use constant COMMENT_EXT => ".comment";
+
our @COMMON_TAR_FLAGS = qw(
--one-file-system
-p --sparse --numeric-owner --acls
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-last' => {
+ %prune_option,
+ description => 'Keep the last <N> backups.',
+ },
+ 'keep-hourly' => {
+ %prune_option,
+ description => 'Keep backups for the last <N> 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 <N> 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 <N> 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 <N> 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 <N> 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);
+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 => {
minimum => 0,
optional => 1,
},
+ 'prune-backups' => get_standard_option('prune-backups'),
shared => {
description => "Mark storage as shared.",
type => 'boolean',
# 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.
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);
snippets => 'snippets',
};
+sub get_vtype_subdirs {
+ return $vtype_subdirs;
+}
+
sub get_subdir {
my ($class, $scfg, $vtype) = @_;
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) = @_;
mkpath $imagedir;
- my $name = $find_free_diskname->($imagedir, $vmid, "qcow2", $scfg);
+ my $name = $class->find_free_diskname($imagedir, $scfg, $vmid, "qcow2", 1);
warn "clone $volname: $vtype, $name, $vmid to $name (base=../$basevmid/$basename)\n";
mkpath $imagedir;
- $name = $find_free_diskname->($imagedir, $vmid, $fmt, $scfg) if !$name;
+ $name = $class->find_free_diskname($imagedir, $scfg, $vmid, $fmt, 1) if !$name;
my (undef, $tmpfmt) = parse_name_dir($name);
File::Path::remove_tree($path);
} else {
if (!(-f $path || -l $path)) {
- warn "disk image '$path' does not exists\n";
+ warn "disk image '$path' does not exist\n";
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;
+ }
+
+ if (S_ISDIR($st->mode)) {
+ return wantarray ? (0, 'subvol', 0, undef, $st->ctime) : 1;
}
my $json = '';
my ($size, $format, $used, $parent) = $info->@{qw(virtual-size format actual-size backing-filename)};
- return wantarray ? ($size, $format, $used, $parent) : $size;
+ return wantarray ? ($size, $format, $used, $parent, $st->ctime) : $size;
}
sub volume_size_info {
return undef;
}
+sub volume_snapshot_needs_fsfreeze {
+
+ return 0;
+}
sub storage_can_replicate {
my ($class, $scfg, $storeid, $format) = @_;
}
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} },
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);
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;
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;
my $res = [];
foreach my $fn (<$path/*>) {
+ my $st = File::stat::stat($fn);
- next if -d $fn;
+ next if (!$st || S_ISDIR($st->mode));
my $info;
} elsif ($tt eq 'backup') {
next if defined($vmid) && $fn !~ m/\S+-$vmid-\S+/;
- next if $fn !~ m!/([^/]+\.(tar|tar\.gz|tar\.lzo|tgz|vma|vma\.gz|vma\.lzo))$!;
+ next if $fn !~ m!/([^/]+\.(tgz|(?:(?:tar|vma)(?:\.(${\COMPRESSOR_RE}))?)))$!;
+ my $original = $fn;
+ my $format = $2;
+ $fn = $1;
+ $info = { volid => "$sid:backup/$fn", format => $format };
+
+ my $archive_info = eval { PVE::Storage::archive_info($fn) } // {};
- $info = { volid => "$sid:backup/$1", format => $2 };
+ $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;
+ }
+
+ my $comment_fn = $original.COMMENT_EXT;
+ if (-f $comment_fn) {
+ my $comment = PVE::Tools::file_read_firstline($comment_fn);
+ $info->{comment} = $comment if defined($comment);
+ }
} elsif ($tt eq 'snippets') {
};
}
- $info->{size} = -s $fn // 0;
+ $info->{size} = $st->size;
+ $info->{ctime} //= $st->ctime;
push @$res, $info;
}
foreach my $item (@$data) {
if ($type eq 'images' || $type eq 'rootdir') {
-
- my $vmtype = $vmlist->{ids}->{$item->{vmid}}->{type};
+ my $vminfo = $vmlist->{ids}->{$item->{vmid}};
+ my $vmtype;
+ if (defined($vminfo)) {
+ $vmtype = $vminfo->{type};
+ }
if (defined($vmtype) && $vmtype eq 'lxc') {
$item->{content} = 'rootdir';
} else {
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,
# 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$/;
# 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)
warn $@ if $@;
die $err;
}
+
+ return "$storeid:$volname";
}
sub volume_import_formats {