1 package PVE
::AbstractConfig
;
6 use PVE
::Tools
qw(lock_file lock_file_full);
11 use PVE
::ReplicationConfig
;
14 my $nodename = PVE
::INotify
::nodename
();
16 # Printable string, currently either "VM" or "CT"
19 die "abstract method - implement me ";
22 sub __config_max_unused_disks
{
25 die "implement me - abstract method\n";
28 # Path to the flock file for this VM/CT
29 sub config_file_lock
{
30 my ($class, $vmid) = @_;
31 die "abstract method - implement me";
34 # Relative config file path for this VM/CT in CFS
36 my ($class, $vmid, $node) = @_;
37 die "abstract method - implement me";
40 # Absolute config file path for this VM/CT
42 my ($class, $vmid, $node) = @_;
44 my $cfspath = $class->cfs_config_path($vmid, $node);
45 return "/etc/pve/$cfspath";
48 # Read and parse config file for this VM/CT
50 my ($class, $vmid, $node) = @_;
52 $node = $nodename if !$node;
53 my $cfspath = $class->cfs_config_path($vmid, $node);
55 my $conf = PVE
::Cluster
::cfs_read_file
($cfspath);
56 die "Configuration file '$cfspath' does not exist\n"
62 # Generate and write config file for this VM/CT
64 my ($class, $vmid, $conf) = @_;
66 my $cfspath = $class->cfs_config_path($vmid);
68 PVE
::Cluster
::cfs_write_file
($cfspath, $conf);
71 # Lock config file using flock, run $code with @param, unlock config file.
72 # $timeout is the maximum time to aquire the flock
73 sub lock_config_full
{
74 my ($class, $vmid, $timeout, $code, @param) = @_;
76 my $filename = $class->config_file_lock($vmid);
78 my $res = lock_file
($filename, $timeout, $code, @param);
85 sub create_and_lock_config
{
86 my ($class, $vmid, $allow_existing) = @_;
88 $class->lock_config_full($vmid, 5, sub {
89 PVE
::Cluster
::check_vmid_unused
($vmid, $allow_existing);
91 my $conf = eval { $class->load_config($vmid) } || {};
92 $class->check_lock($conf);
93 $conf->{lock} = 'create';
94 $class->write_config($vmid, $conf);
98 # Lock config file using flock, run $code with @param, unlock config file.
99 # $timeout is the maximum time to aquire the flock
100 # $shared eq 1 creates a non-exclusive ("read") flock
101 sub lock_config_mode
{
102 my ($class, $vmid, $timeout, $shared, $code, @param) = @_;
104 my $filename = $class->config_file_lock($vmid);
106 my $res = lock_file_full
($filename, $timeout, $shared, $code, @param);
113 # Lock config file using flock, run $code with @param, unlock config file.
115 my ($class, $vmid, $code, @param) = @_;
117 return $class->lock_config_full($vmid, 10, $code, @param);
120 # Checks whether the config is locked with the lock parameter
122 my ($class, $conf) = @_;
124 die $class->guest_type()." is locked ($conf->{lock})\n" if $conf->{lock};
127 # Returns whether the config is locked with the lock parameter, also checks
128 # whether the lock value is correct if the optional $lock is set.
130 my ($class, $conf, $lock) = @_;
132 return $conf->{lock} && (!defined($lock) || $lock eq $conf->{lock});
135 # Sets the lock parameter for this VM/CT's config to $lock.
137 my ($class, $vmid, $lock) = @_;
140 $class->lock_config($vmid, sub {
141 $conf = $class->load_config($vmid);
142 $class->check_lock($conf);
143 $conf->{lock} = $lock;
144 $class->write_config($vmid, $conf);
149 # Removes the lock parameter for this VM/CT's config, also checks whether
150 # the lock value is correct if the optional $lock is set.
152 my ($class, $vmid, $lock) = @_;
154 $class->lock_config($vmid, sub {
155 my $conf = $class->load_config($vmid);
156 if (!$conf->{lock}) {
157 my $lockstring = defined($lock) ?
"'$lock' " : "any";
158 die "no lock found trying to remove $lockstring lock\n";
159 } elsif (defined($lock) && $conf->{lock} ne $lock) {
160 die "found lock '$conf->{lock}' trying to remove '$lock' lock\n";
162 delete $conf->{lock};
163 $class->write_config($vmid, $conf);
167 # Checks whether protection mode is enabled for this VM/CT.
168 sub check_protection
{
169 my ($class, $conf, $err_msg) = @_;
171 if ($conf->{protection
}) {
172 die "$err_msg - protection mode enabled\n";
176 # Adds an unused volume to $config, if possible.
177 sub add_unused_volume
{
178 my ($class, $config, $volid) = @_;
181 for (my $ind = $class->__config_max_unused_disks() - 1; $ind >= 0; $ind--) {
182 my $test = "unused$ind";
183 if (my $vid = $config->{$test}) {
184 return if $vid eq $volid; # do not add duplicates
190 die "Too many unused volumes - please delete them first.\n" if !$key;
192 $config->{$key} = $volid;
197 # Returns whether the template parameter is set in $conf.
199 my ($class, $conf) = @_;
201 return 1 if defined $conf->{template
} && $conf->{template
} == 1;
204 # Checks whether $feature is availabe for the referenced volumes in $conf.
205 # Note: depending on the parameters, some volumes may be skipped!
207 my ($class, $feature, $conf, $storecfg, $snapname, $running, $backup_only) = @_;
208 die "implement me - abstract method\n";
211 # get all replicatable volume (hash $res->{$volid} = 1)
212 # $cleanup: for cleanup - simply ignores volumes without replicate feature
213 # $norerr: never raise exceptions - return undef instead
214 sub get_replicatable_volumes
{
215 my ($class, $storecfg, $vmid, $conf, $cleanup, $noerr) = @_;
217 die "implement me - abstract method\n";
222 # NOTE: Snapshot create/delete involves several non-atomic
223 # actions, and can take a long time.
224 # So we try to avoid locking the file and use the 'lock' variable
225 # inside the config file instead.
227 # Save the vmstate (RAM).
228 sub __snapshot_save_vmstate
{
229 my ($class, $vmid, $conf, $snapname, $storecfg) = @_;
230 die "implement me - abstract method\n";
233 # Check whether the VM/CT is running.
234 sub __snapshot_check_running
{
235 my ($class, $vmid) = @_;
236 die "implement me - abstract method\n";
239 # Check whether we need to freeze the VM/CT
240 sub __snapshot_check_freeze_needed
{
241 my ($sself, $vmid, $config, $save_vmstate) = @_;
242 die "implement me - abstract method\n";
245 # Freeze or unfreeze the VM/CT.
246 sub __snapshot_freeze
{
247 my ($class, $vmid, $unfreeze) = @_;
249 die "abstract method - implement me\n";
252 # Code run before and after creating all the volume snapshots
254 sub __snapshot_create_vol_snapshots_hook
{
255 my ($class, $vmid, $snap, $running, $hook) = @_;
260 # Create the volume snapshots for the VM/CT.
261 sub __snapshot_create_vol_snapshot
{
262 my ($class, $vmid, $vs, $volume, $snapname) = @_;
264 die "abstract method - implement me\n";
267 # Remove a drive from the snapshot config.
268 sub __snapshot_delete_remove_drive
{
269 my ($class, $snap, $drive) = @_;
271 die "abstract method - implement me\n";
274 # Delete the vmstate file/drive
275 sub __snapshot_delete_vmstate_file
{
276 my ($class, $snap, $force) = @_;
278 die "abstract method - implement me\n";
281 # Delete a volume snapshot
282 sub __snapshot_delete_vol_snapshot
{
283 my ($class, $vmid, $vs, $volume, $snapname) = @_;
285 die "abstract method - implement me\n";
288 # called during rollback prepare, and between config rollback and starting guest
289 # can change config, e.g. for vmgenid
290 # $data is shared across calls and passed to vm_start
291 sub __snapshot_rollback_hook
{
292 my ($class, $vmid, $conf, $snap, $prepare, $data) = @_;
297 # Checks whether a volume snapshot is possible for this volume.
298 sub __snapshot_rollback_vol_possible
{
299 my ($class, $volume, $snapname) = @_;
301 die "abstract method - implement me\n";
304 # Rolls back this volume.
305 sub __snapshot_rollback_vol_rollback
{
306 my ($class, $volume, $snapname) = @_;
308 die "abstract method - implement me\n";
311 # Stops the VM/CT for a rollback.
312 sub __snapshot_rollback_vm_stop
{
313 my ($class, $vmid) = @_;
315 die "abstract method - implement me\n";
318 # Start the VM/CT after a rollback with restored vmstate.
319 sub __snapshot_rollback_vm_start
{
320 my ($class, $vmid, $vmstate, $data);
322 die "abstract method - implement me\n";
325 # Get list of volume IDs which are referenced in $conf, but not in $snap.
326 sub __snapshot_rollback_get_unused
{
327 my ($class, $conf, $snap) = @_;
329 die "abstract method - implement me\n";
332 # Iterate over all configured volumes, calling $func for each key/value pair.
333 sub __snapshot_foreach_volume
{
334 my ($class, $conf, $func) = @_;
336 die "abstract method - implement me\n";
339 # Copy the current config $source to the snapshot config $dest
340 sub __snapshot_copy_config
{
341 my ($class, $source, $dest) = @_;
343 foreach my $k (keys %$source) {
344 next if $k eq 'snapshots';
345 next if $k eq 'snapstate';
346 next if $k eq 'snaptime';
347 next if $k eq 'vmstate';
348 next if $k eq 'lock';
349 next if $k eq 'digest';
350 next if $k eq 'description';
351 next if $k =~ m/^unused\d+$/;
353 $dest->{$k} = $source->{$k};
357 # Apply the snapshot config $snap to the config $conf (rollback)
358 sub __snapshot_apply_config
{
359 my ($class, $conf, $snap) = @_;
363 snapshots
=> $conf->{snapshots
},
366 # keep description and list of unused disks
367 foreach my $k (keys %$conf) {
368 next if !($k =~ m/^unused\d+$/ || $k eq 'description');
370 $newconf->{$k} = $conf->{$k};
373 $class->__snapshot_copy_config($snap, $newconf);
378 # Prepares the configuration for snapshotting.
379 sub __snapshot_prepare
{
380 my ($class, $vmid, $snapname, $save_vmstate, $comment) = @_;
386 my $conf = $class->load_config($vmid);
388 die "you can't take a snapshot if it's a template\n"
389 if $class->is_template($conf);
391 $class->check_lock($conf);
393 $conf->{lock} = 'snapshot';
395 die "snapshot name '$snapname' already used\n"
396 if defined($conf->{snapshots
}->{$snapname});
398 my $storecfg = PVE
::Storage
::config
();
399 die "snapshot feature is not available\n"
400 if !$class->has_feature('snapshot', $conf, $storecfg, undef, undef, $snapname eq 'vzdump');
402 $snap = $conf->{snapshots
}->{$snapname} = {};
404 if ($save_vmstate && $class->__snapshot_check_running($vmid)) {
405 $class->__snapshot_save_vmstate($vmid, $conf, $snapname, $storecfg);
408 $class->__snapshot_copy_config($conf, $snap);
410 $snap->{snapstate
} = "prepare";
411 $snap->{snaptime
} = time();
412 $snap->{description
} = $comment if $comment;
414 $class->write_config($vmid, $conf);
417 $class->lock_config($vmid, $updatefn);
422 # Commits the configuration after snapshotting.
423 sub __snapshot_commit
{
424 my ($class, $vmid, $snapname) = @_;
428 my $conf = $class->load_config($vmid);
430 die "missing snapshot lock\n"
431 if !($conf->{lock} && $conf->{lock} eq 'snapshot');
433 my $snap = $conf->{snapshots
}->{$snapname};
434 die "snapshot '$snapname' does not exist\n" if !defined($snap);
436 die "wrong snapshot state\n"
437 if !($snap->{snapstate
} && $snap->{snapstate
} eq "prepare");
439 delete $snap->{snapstate
};
440 delete $conf->{lock};
442 $conf->{parent
} = $snapname;
444 $class->write_config($vmid, $conf);
447 $class->lock_config($vmid, $updatefn);
450 # Creates a snapshot for the VM/CT.
451 sub snapshot_create
{
452 my ($class, $vmid, $snapname, $save_vmstate, $comment) = @_;
454 my $snap = $class->__snapshot_prepare($vmid, $snapname, $save_vmstate, $comment);
456 $save_vmstate = 0 if !$snap->{vmstate
};
458 my $conf = $class->load_config($vmid);
460 my ($running, $freezefs) = $class->__snapshot_check_freeze_needed($vmid, $conf, $snap->{vmstate
});
466 $class->__snapshot_freeze($vmid, 0);
469 $class->__snapshot_create_vol_snapshots_hook($vmid, $snap, $running, "before");
471 $class->__snapshot_foreach_volume($snap, sub {
472 my ($vs, $volume) = @_;
474 $class->__snapshot_create_vol_snapshot($vmid, $vs, $volume, $snapname);
475 $drivehash->{$vs} = 1;
481 $class->__snapshot_create_vol_snapshots_hook($vmid, $snap, $running, "after");
483 $class->__snapshot_freeze($vmid, 1);
485 $class->__snapshot_create_vol_snapshots_hook($vmid, $snap, $running, "after-unfreeze");
489 warn "snapshot create failed: starting cleanup\n";
490 eval { $class->snapshot_delete($vmid, $snapname, 1, $drivehash); };
495 $class->__snapshot_commit($vmid, $snapname);
498 # Deletes a snapshot.
499 # Note: $drivehash is only set when called from snapshot_create.
500 sub snapshot_delete
{
501 my ($class, $vmid, $snapname, $force, $drivehash) = @_;
507 my $conf = $class->load_config($vmid);
508 my $snap = $conf->{snapshots
}->{$snapname};
510 die "snapshot '$snapname' does not exist\n" if !defined($snap);
512 $class->set_lock($vmid, 'snapshot-delete')
513 if (!$drivehash); # doesn't already have a 'snapshot' lock
515 my $unlink_parent = sub {
516 my ($confref, $new_parent) = @_;
518 if ($confref->{parent
} && $confref->{parent
} eq $snapname) {
520 $confref->{parent
} = $new_parent;
522 delete $confref->{parent
};
527 my $remove_drive = sub {
530 my $conf = $class->load_config($vmid);
531 $snap = $conf->{snapshots
}->{$snapname};
532 die "snapshot '$snapname' does not exist\n" if !defined($snap);
534 $class->__snapshot_delete_remove_drive($snap, $drive);
536 $class->write_config($vmid, $conf);
540 $class->lock_config($vmid, sub {
541 my $conf = $class->load_config($vmid);
543 die "you can't delete a snapshot if vm is a template\n"
544 if $class->is_template($conf);
546 $snap = $conf->{snapshots
}->{$snapname};
547 die "snapshot '$snapname' does not exist\n" if !defined($snap);
549 $snap->{snapstate
} = 'delete';
551 $class->write_config($vmid, $conf);
554 # now remove vmstate file
555 if ($snap->{vmstate
}) {
556 $class->__snapshot_delete_vmstate_file($snap, $force);
558 # save changes (remove vmstate from snapshot)
559 $class->lock_config($vmid, $remove_drive, 'vmstate') if !$force;
562 # now remove all volume snapshots
563 $class->__snapshot_foreach_volume($snap, sub {
564 my ($vs, $volume) = @_;
566 return if $snapname eq 'vzdump' && $vs ne 'rootfs' && !$volume->{backup
};
567 if (!$drivehash || $drivehash->{$vs}) {
568 eval { $class->__snapshot_delete_vol_snapshot($vmid, $vs, $volume, $snapname, $unused); };
575 # save changes (remove drive from snapshot)
576 $class->lock_config($vmid, $remove_drive, $vs) if !$force;
580 $class->lock_config($vmid, sub {
581 my $conf = $class->load_config($vmid);
582 $snap = $conf->{snapshots
}->{$snapname};
583 die "snapshot '$snapname' does not exist\n" if !defined($snap);
586 &$unlink_parent($conf, $snap->{parent
});
587 foreach my $sn (keys %{$conf->{snapshots
}}) {
588 next if $sn eq $snapname;
589 &$unlink_parent($conf->{snapshots
}->{$sn}, $snap->{parent
});
593 delete $conf->{snapshots
}->{$snapname};
594 delete $conf->{lock};
595 foreach my $volid (@$unused) {
596 $class->add_unused_volume($conf, $volid);
599 $class->write_config($vmid, $conf);
603 # Rolls back to a given snapshot.
604 sub snapshot_rollback
{
605 my ($class, $vmid, $snapname) = @_;
609 my $storecfg = PVE
::Storage
::config
();
611 my $conf = $class->load_config($vmid);
613 my $get_snapshot_config = sub {
615 die "you can't rollback if vm is a template\n" if $class->is_template($conf);
617 my $res = $conf->{snapshots
}->{$snapname};
619 die "snapshot '$snapname' does not exist\n" if !defined($res);
624 my $repl_conf = PVE
::ReplicationConfig-
>new();
625 if ($repl_conf->check_for_existing_jobs($vmid, 1)) {
626 # remove all replication snapshots
627 my $volumes = $class->get_replicatable_volumes($storecfg, $vmid, $conf, 1);
628 my $sorted_volids = [ sort keys %$volumes ];
630 # remove all local replication snapshots (jobid => undef)
631 my $logfunc = sub { my $line = shift; chomp $line; print "$line\n"; };
632 PVE
::Replication
::prepare
($storecfg, $sorted_volids, undef, 0, undef, $logfunc);
635 my $snap = &$get_snapshot_config();
637 $class->__snapshot_foreach_volume($snap, sub {
638 my ($vs, $volume) = @_;
640 $class->__snapshot_rollback_vol_possible($volume, $snapname);
647 $conf = $class->load_config($vmid);
649 $snap = &$get_snapshot_config();
651 die "unable to rollback to incomplete snapshot (snapstate = $snap->{snapstate})\n"
652 if $snap->{snapstate
};
655 $class->check_lock($conf);
656 $class->__snapshot_rollback_vm_stop($vmid);
659 die "unable to rollback vm $vmid: vm is running\n"
660 if $class->__snapshot_check_running($vmid);
663 $conf->{lock} = 'rollback';
665 die "got wrong lock\n" if !($conf->{lock} && $conf->{lock} eq 'rollback');
666 delete $conf->{lock};
668 my $unused = $class->__snapshot_rollback_get_unused($conf, $snap);
670 foreach my $volid (@$unused) {
671 $class->add_unused_volume($conf, $volid);
674 # copy snapshot config to current config
675 $conf = $class->__snapshot_apply_config($conf, $snap);
676 $conf->{parent
} = $snapname;
679 $class->__snapshot_rollback_hook($vmid, $conf, $snap, $prepare, $data);
681 $class->write_config($vmid, $conf);
683 if (!$prepare && $snap->{vmstate
}) {
684 $class->__snapshot_rollback_vm_start($vmid, $snap->{vmstate
}, $data);
688 $class->lock_config($vmid, $updatefn);
690 $class->__snapshot_foreach_volume($snap, sub {
691 my ($vs, $volume) = @_;
693 $class->__snapshot_rollback_vol_rollback($volume, $snapname);
697 $class->lock_config($vmid, $updatefn);
700 # bash completion helper
702 sub complete_snapshot_name
{
706 my $conf = $class->load_config($vmid);
708 my $snapshot = [ keys %{$conf->{snapshots
}} ];