src/PVE/VZDump/LXC.pm

   1 package PVE::VZDump::LXC;
   2
   3 use strict;
   4 use warnings;
   5 use File::Path;
   6 use File::Basename;
   7 use PVE::INotify;
   8 use PVE::Cluster qw(cfs_read_file);
   9 use PVE::Storage;
  10 use PVE::VZDump;
  11 use PVE::LXC;
  12 use PVE::LXC::Config;
  13 use PVE::Tools;
  14
  15 use base qw (PVE::VZDump::Plugin);
  16
  17 my $default_mount_point = "/mnt/vzsnap0";
  18
  19 my $rsync_vm = sub {
  20     my ($self, $task, $to, $text, $first) = @_;
  21
  22     my $disks = $task->{disks};
  23     my $from = $disks->[0]->{dir} . '/';
  24     $self->loginfo ("starting $text sync $from to $to");
  25
  26     my $opts = $self->{vzdump}->{opts};
  27
  28     my @xattr = $task->{no_xattrs} ? () : ('-X', '-A');
  29
  30     my $rsync = ['rsync', '--stats', @xattr, '--numeric-ids',
  31                  '-aH', '--delete', '--no-whole-file',
  32                  ($first ? '--sparse' : '--inplace'),
  33                  '--one-file-system', '--relative'];
  34     push @$rsync, "--bwlimit=$opts->{bwlimit}" if $opts->{bwlimit};
  35     push @$rsync, map { "--exclude=$_" } @{$self->{vzdump}->{findexcl}};
  36     push @$rsync, map { "--exclude=$_" } @{$task->{exclude_dirs}};
  37
  38     my $starttime = time();
  39     # See the rsync(1) manpage for --relative in conjunction with /./ in paths.
  40     # This is the only way to have exclude-dirs work together with the
  41     # --one-file-system option.
  42     # This way we can pass multiple source paths and tell rsync which directory
  43     # they're supposed to be relative to.
  44     # Otherwise with eg. using multiple rsync commands means the --exclude
  45     # directives need to be modified for every command as they are meant to be
  46     # relative to the rootdir, while rsync treats them as relative to the
  47     # source dir.
  48     foreach my $disk (@$disks) {
  49         push @$rsync, "$from/.$disk->{mp}";
  50     }
  51     $self->cmd([@$rsync, $to]);
  52     my $delay = time () - $starttime;
  53
  54     $self->loginfo ("$text sync finished ($delay seconds)");
  55 };
  56
  57 sub new {
  58     my ($class, $vzdump) = @_;
  59
  60     PVE::VZDump::check_bin('lxc-stop');
  61     PVE::VZDump::check_bin('lxc-start');
  62     PVE::VZDump::check_bin('lxc-freeze');
  63     PVE::VZDump::check_bin('lxc-unfreeze');
  64
  65     my $self = bless {};
  66
  67     $self->{vzdump} = $vzdump;
  68     $self->{storecfg} = PVE::Storage::config();
  69
  70     $self->{vmlist} = PVE::LXC::config_list();
  71
  72     return $self;
  73 }
  74
  75 sub type {
  76     return 'lxc';
  77 }
  78
  79 sub vm_status {
  80     my ($self, $vmid) = @_;
  81
  82     my $running = PVE::LXC::check_running($vmid) ? 1 : 0;
  83
  84     return wantarray ? ($running, $running ? 'running' : 'stopped') : $running;
  85 }
  86
  87 my $check_mountpoint_empty = sub {
  88     my ($mountpoint) = @_;
  89
  90     die "mount point '$mountpoint' is not a directory\n" if ! -d $mountpoint;
  91
  92     PVE::Tools::dir_glob_foreach($mountpoint, qr/.*/, sub {
  93         my $entry = shift;
  94         return if $entry eq '.' || $entry eq '..';
  95         die "mount point '$mountpoint' not empty\n";
  96     });
  97 };
  98
  99 sub prepare {
 100     my ($self, $task, $vmid, $mode) = @_;
 101
 102     my $conf = $self->{vmlist}->{$vmid} = PVE::LXC::Config->load_config($vmid);
 103     my $storage_cfg = $self->{storecfg};
 104
 105     $self->loginfo("CT Name: $conf->{hostname}")
 106         if defined($conf->{hostname});
 107
 108     my $running = PVE::LXC::check_running($vmid);
 109
 110     my $disks = $task->{disks} = [];
 111     my $exclude_dirs = $task->{exclude_dirs} = [];
 112
 113     $task->{hostname} = $conf->{'hostname'} || "CT$vmid";
 114
 115     my ($id_map, $rootuid, $rootgid) = PVE::LXC::parse_id_maps($conf);
 116     $task->{userns_cmd} = PVE::LXC::userns_command($id_map);
 117     $task->{rootuid} = $rootuid;
 118     $task->{rootgid} = $rootgid;
 119
 120
 121     my $volids = $task->{volids} = [];
 122     PVE::LXC::Config->foreach_mountpoint($conf, sub {
 123         my ($name, $data) = @_;
 124         my $volid = $data->{volume};
 125         my $mount = $data->{mp};
 126         my $type = $data->{type};
 127
 128         return if !$volid || !$mount;
 129
 130         if (!PVE::LXC::Config->mountpoint_backup_enabled($name, $data)) {
 131             push @$exclude_dirs, $mount;
 132             $self->loginfo("excluding $type mount point $name ('$mount') from backup");
 133             return;
 134         }
 135
 136         push @$disks, $data;
 137         push @$volids, $volid
 138             if $type eq 'volume';
 139     });
 140
 141     if ($mode eq 'snapshot') {
 142         if (!PVE::LXC::Config->has_feature('snapshot', $conf, $storage_cfg, undef, undef, 1)) {
 143             die "mode failure - some volumes do not support snapshots\n";
 144         }
 145
 146
 147         if ($conf->{snapshots} && $conf->{snapshots}->{vzdump}) {
 148             $self->loginfo("found old vzdump snapshot (force removal)");
 149             PVE::LXC::Config->lock_config($vmid, sub {
 150                 $self->unlock_vm($vmid);
 151                 PVE::LXC::Config->snapshot_delete($vmid, 'vzdump', 1);
 152                 $self->lock_vm($vmid);
 153             });
 154         }
 155
 156         my $rootdir = $default_mount_point;
 157         mkpath $rootdir;
 158         &$check_mountpoint_empty($rootdir);
 159
 160         # set snapshot_count (freezes CT if snapshot_count > 1)
 161         $task->{snapshot_count} = scalar(@$volids);
 162     } elsif ($mode eq 'stop') {
 163         my $rootdir = $default_mount_point;
 164         mkpath $rootdir;
 165         &$check_mountpoint_empty($rootdir);
 166         PVE::Storage::activate_volumes($storage_cfg, $volids);
 167     } elsif ($mode eq 'suspend') {
 168         my $pid = PVE::LXC::find_lxc_pid($vmid);
 169         foreach my $disk (@$disks) {
 170             $disk->{dir} = "/proc/$pid/root$disk->{mp}";
 171         }
 172         $task->{snapdir} = $task->{tmpdir};
 173     } else {
 174         unlock_vm($self, $vmid);
 175         die "unknown mode '$mode'\n"; # should not happen
 176     }
 177
 178     if ($mode ne 'suspend') {
 179         # If we perform mount operations, let's unshare the mount namespace
 180         # to not influence the running host.
 181         PVE::Tools::unshare(PVE::Tools::CLONE_NEWNS);
 182         PVE::Tools::run_command(['mount', '--make-rslave', '/']);
 183     }
 184 }
 185
 186 sub lock_vm {
 187     my ($self, $vmid) = @_;
 188
 189     PVE::LXC::Config->set_lock($vmid, 'backup');
 190 }
 191
 192 sub unlock_vm {
 193     my ($self, $vmid) = @_;
 194
 195     PVE::LXC::Config->remove_lock($vmid, 'backup')
 196 }
 197
 198 sub snapshot {
 199     my ($self, $task, $vmid) = @_;
 200
 201     $self->loginfo("create storage snapshot 'vzdump'");
 202
 203     # todo: freeze/unfreeze if we have more than one volid
 204     PVE::LXC::Config->lock_config($vmid, sub {
 205         $self->unlock_vm($vmid);
 206         PVE::LXC::Config->snapshot_create($vmid, 'vzdump', 0, "vzdump backup snapshot");
 207         $self->lock_vm($vmid);
 208     });
 209     $task->{cleanup}->{remove_snapshot} = 1;
 210
 211     # reload config
 212     my $conf = $self->{vmlist}->{$vmid} = PVE::LXC::Config->load_config($vmid);
 213     die "unable to read vzdump snapshot config - internal error"
 214         if !($conf->{snapshots} && $conf->{snapshots}->{vzdump});
 215
 216     my $disks = $task->{disks};
 217     my $volids = $task->{volids};
 218
 219     my $rootdir = $default_mount_point;
 220     my $storage_cfg = $self->{storecfg};
 221
 222     PVE::Storage::activate_volumes($storage_cfg, $volids, 'vzdump');
 223     foreach my $disk (@$disks) {
 224         $disk->{dir} = "${rootdir}$disk->{mp}";
 225         PVE::LXC::mountpoint_mount($disk, $rootdir, $storage_cfg, 'vzdump', $task->{rootuid}, $task->{rootgid});
 226     }
 227
 228     $task->{snapdir} = $rootdir;
 229 }
 230
 231 sub copy_data_phase1 {
 232     my ($self, $task) = @_;
 233
 234     if (my $mntinfo = PVE::VZDump::get_mount_info($task->{snapdir})) {
 235         if ($mntinfo->{fstype} =~ /^nfs4?/) {
 236             $self->loginfo(
 237                  "temporary directory is on NFS, disabling xattr and acl"
 238                 ." support, consider configuring a local tmpdir via"
 239                 ." /etc/vzdump.conf\n");
 240             $task->{no_xattrs} = 1;
 241         }
 242     }
 243
 244     $self->$rsync_vm($task, $task->{snapdir}, "first", 1);
 245 }
 246
 247 sub copy_data_phase2 {
 248     my ($self, $task) = @_;
 249
 250     $self->$rsync_vm($task, $task->{snapdir}, "final", 0);
 251 }
 252
 253 sub stop_vm {
 254     my ($self, $task, $vmid) = @_;
 255
 256     my $opts = $self->{vzdump}->{opts};
 257     my $timeout = $opts->{stopwait} * 60;
 258
 259     PVE::LXC::vm_stop($vmid, 0, $timeout);
 260 }
 261
 262 sub start_vm {
 263     my ($self, $task, $vmid) = @_;
 264
 265     $self->cmd(['systemctl', 'start', "pve-container\@$vmid"]);
 266 }
 267
 268 sub suspend_vm {
 269     my ($self, $task, $vmid) = @_;
 270
 271     $self->cmd ("lxc-freeze -n $vmid");
 272 }
 273
 274 sub resume_vm {
 275     my ($self, $task, $vmid) = @_;
 276
 277     $self->cmd ("lxc-unfreeze -n $vmid");
 278 }
 279
 280 sub assemble {
 281     my ($self, $task, $vmid) = @_;
 282
 283     my $tmpdir = $task->{tmpdir};
 284
 285     mkpath "$tmpdir/etc/vzdump/";
 286
 287     my $conf = PVE::LXC::Config->load_config($vmid);
 288     delete $conf->{lock};
 289     delete $conf->{snapshots};
 290     delete $conf->{parent};
 291
 292     PVE::Tools::file_set_contents("$tmpdir/etc/vzdump/pct.conf", PVE::LXC::Config::write_pct_config("/lxc/$vmid.conf", $conf));
 293
 294     my $firewall ="/etc/pve/firewall/$vmid.fw";
 295     my $fwconftmp = "$tmpdir/etc/vzdump/pct.fw";
 296     if (-e  $firewall) {
 297         PVE::Tools::file_copy($firewall, $fwconftmp);
 298     } else {
 299         PVE::Tools::file_set_contents($fwconftmp, '');
 300     }
 301     $task->{fw} = 1;
 302 }
 303
 304 sub archive {
 305     my ($self, $task, $vmid, $filename, $comp) = @_;
 306
 307     my $disks = $task->{disks};
 308     my @sources;
 309
 310     if ($task->{mode} eq 'stop') {
 311         my $rootdir = $default_mount_point;
 312         my $storage_cfg = $self->{storecfg};
 313         foreach my $disk (@$disks) {
 314             $disk->{dir} = "${rootdir}$disk->{mp}";
 315             PVE::LXC::mountpoint_mount($disk, $rootdir, $storage_cfg, undef, $task->{rootuid}, $task->{rootgid});
 316             # add every enabled mountpoint (since we use --one-file-system)
 317             # mp already starts with a / so we only need to add the dot
 318             push @sources, ".$disk->{mp}";
 319         }
 320         $task->{snapdir} = $rootdir;
 321     } elsif ($task->{mode} eq 'snapshot') {
 322         # mounting the vzdump snapshots and setting $snapdir is already done,
 323         # but we need to include all mountpoints here!
 324         foreach my $disk (@$disks) {
 325             push @sources, ".$disk->{mp}";
 326         }
 327     } else {
 328         # the data was rsynced to a temporary location, only use '.' to avoid
 329         # having mountpoints duplicated
 330         push @sources, '.';
 331     }
 332
 333     my $opts = $self->{vzdump}->{opts};
 334     my $snapdir = $task->{snapdir};
 335     my $tmpdir = $task->{tmpdir};
 336
 337     my $userns_cmd = $task->{userns_cmd};
 338     my $tar = [@$userns_cmd, 'tar', 'cpf', '-', '--totals',
 339                @PVE::Storage::Plugin::COMMON_TAR_FLAGS,
 340                '--one-file-system', '--warning=no-file-ignored'];
 341
 342     # note: --remove-files does not work because we do not
 343     # backup all files (filters). tar complains:
 344     # Cannot rmdir: Directory not empty
 345     # we disable this optimization for now
 346     #if ($snapdir eq $task->{tmpdir} && $snapdir =~ m|^$opts->{dumpdir}/|) {
 347     #       push @$tar, "--remove-files"; # try to save space
 348     #}
 349
 350     # The directory parameter can give an alternative directory as source.
 351     # the second parameter gives the structure in the tar.
 352     push @$tar, "--directory=$tmpdir", './etc/vzdump/pct.conf';
 353     push @$tar, "./etc/vzdump/pct.fw" if $task->{fw};
 354     push @$tar, "--directory=$snapdir";
 355     push @$tar, '--no-anchored', '--exclude=lost+found' if $userns_cmd;
 356     push @$tar, '--anchored';
 357     push @$tar, map { "--exclude=.$_" } @{$self->{vzdump}->{findexcl}};
 358
 359     push @$tar, @sources;
 360
 361     my $cmd = [ $tar ];
 362
 363     my $bwl = $opts->{bwlimit}*1024; # bandwidth limit for cstream
 364     push @$cmd, [ 'cstream', '-t', $bwl ] if $opts->{bwlimit};
 365     push @$cmd, [ split(/\s+/, $comp) ] if $comp;
 366
 367     if ($opts->{stdout}) {
 368         $self->cmd($cmd, output => ">&" . fileno($opts->{stdout}));
 369     } else {
 370         push @{$cmd->[-1]}, \(">" . PVE::Tools::shellquote($filename));
 371        $self->cmd($cmd);
 372     }
 373 }
 374
 375 sub cleanup {
 376     my ($self, $task, $vmid) = @_;
 377
 378     my $conf = PVE::LXC::Config->load_config($vmid);
 379
 380     if ($task->{mode} ne 'suspend') {
 381         my $rootdir = $default_mount_point;
 382         my $disks = $task->{disks};
 383         foreach my $disk (reverse @$disks) {
 384             PVE::Tools::run_command(['umount', '-l', '-d', $disk->{dir}]) if $disk->{dir};
 385         }
 386     }
 387
 388     if ($task->{cleanup}->{remove_snapshot}) {
 389         $self->loginfo("remove vzdump snapshot");
 390         PVE::LXC::Config->snapshot_delete($vmid, 'vzdump', 0);
 391     }
 392 }
 393
 394 1;