From: Thomas Lamprecht <t.lamprecht@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [PATCH guest-common v2 10/36] abstract config: let the VMID reservation return the previous state
Date: Tue, 17 Nov 2026 23:34:20 +0100 [thread overview]
Message-ID: <20261117223945.862914-11-t.lamprecht@proxmox.com> (raw)
In-Reply-To: <20261117223945.862914-1-t.lamprecht@proxmox.com>
A restore needs to know whether its target existed and had an identity
before the operation, to decide between keeping the identity of the
target and taking over the uid of the backup. With identities enabled,
the reservation already assigns an identity to a target without one,
so reading the config afterwards cannot tell anymore, and reading it
before the locked section races with other writers.
Return that state from within the locked section, together with the
identity that the guest has after the reservation. With identities
enabled, the reservation reads the existing identity under the same lock
as the write. A config that fails to parse still counts as existing,
with the identity found in its raw text.
Existing callers ignore the return value.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
---
changes v1 -> v2:
* rebase: the used guest ID gets registered before the state is captured
* name the keys of the returned state after what they hold (previous,
assigned)
src/PVE/AbstractConfig.pm | 39 ++++++++++-
src/tests/config-identity-tests.pl | 107 ++++++++++++++++++++++++++++-
2 files changed, 142 insertions(+), 4 deletions(-)
diff --git a/src/PVE/AbstractConfig.pm b/src/PVE/AbstractConfig.pm
index 40cbe86..5cc1d7f 100644
--- a/src/PVE/AbstractConfig.pm
+++ b/src/PVE/AbstractConfig.pm
@@ -332,10 +332,19 @@ sub load_current_config {
return $conf;
}
+# Reserves $vmid for an operation by writing its config with the lock $lock, 'create' by default.
+# An existing config is only allowed with $allow_existing and must not be locked.
+#
+# Returns the state of the guest identity around the write, captured under the guest config lock,
+# as the write can assign an identity to a config without one. Taking over a uid later needs it.
+# existed - whether a config existed before
+# previous - the guest identity of that config, undef if it had none or did not exist
+# assigned - the guest identity of the config after the write, undef with identities
+# disabled
sub create_and_lock_config {
my ($class, $vmid, $allow_existing, $lock) = @_;
- $class->lock_config_full(
+ return $class->lock_config_full(
$vmid,
5,
sub {
@@ -343,10 +352,34 @@ sub create_and_lock_config {
PVE::GuestID::register_used_id($vmid);
- my $conf = eval { $class->load_config($vmid) } || {};
+ my $conf = eval { $class->load_config($vmid) };
+ my $existed = defined($conf);
+ my $previous = $existed ? $class->get_identity($conf) : undef;
+
+ $conf //= {};
$class->check_lock($conf);
$conf->{lock} = $lock // 'create';
- $class->write_config($vmid, $conf);
+
+ if ($class->__identity_enabled()) {
+ # use what the write itself sees as stored, see write_config
+ $class->__identity_lock(
+ $vmid,
+ sub {
+ my $stored = $class->__identity_read_stored($vmid);
+ $existed = defined($stored);
+ $previous = $stored ? $stored->{identity} : undef;
+ $class->write_config($vmid, $conf);
+ },
+ );
+ } else {
+ $class->write_config($vmid, $conf);
+ }
+
+ return {
+ existed => $existed ? 1 : 0,
+ previous => $previous,
+ assigned => $class->__identity_enabled() ? $class->get_identity($conf) : undef,
+ };
},
);
}
diff --git a/src/tests/config-identity-tests.pl b/src/tests/config-identity-tests.pl
index fcec452..09ac9e4 100755
--- a/src/tests/config-identity-tests.pl
+++ b/src/tests/config-identity-tests.pl
@@ -151,6 +151,12 @@ $cluster_module->redefine(
$versions->{$path} = ++$version_counter;
$cache->{$path}->{version} = undef if $cache->{$path};
},
+ check_vmid_unused => sub {
+ my ($vmid, $noerr) = @_;
+ return 1 if !grep { defined($files->{$_}) && vmid_of_path($_) == $vmid } keys %$files;
+ return undef if $noerr;
+ die "guest $vmid already exists\n";
+ },
get_config => sub {
my ($path) = @_;
my $vmid = vmid_of_path($path);
@@ -167,7 +173,7 @@ $cluster_module->redefine(
my $uid_counter = 0;
my $now = 1_700_000_000_000;
-# recording used guest IDs needs the cluster filesystem and is not what gets tested here
+# recording used guest IDs needs the cluster filesystem, only one subtest fakes the list of them
my $guest_id_module = Test::MockModule->new('PVE::GuestID');
$guest_id_module->redefine(register_used_id => sub { });
@@ -380,4 +386,103 @@ subtest 'snapshot rollback' => sub {
);
};
+subtest 'create and lock config' => sub {
+ my $class = 'PVE::TestConfig';
+
+ my $state = $class->create_and_lock_config(150);
+ my $reserved = identity_of($class, 150);
+ ok($reserved, 'free VMID: reservation gets an identity');
+ is_deeply(
+ $state,
+ { existed => 0, previous => undef, assigned => $reserved },
+ 'free VMID: no previous identity',
+ );
+ is(conf_of($class, 150)->{lock}, 'create', 'free VMID: reserved');
+
+ eval { $class->create_and_lock_config(150) };
+ like($@, qr/already exists/, 'existing config is refused by default');
+
+ $class->write_config(151, { name => 'target', meta => 'ctime=1' });
+ my $stored = identity_of($class, 151);
+ $now += 1000;
+ $state = $class->create_and_lock_config(151, 1, 'restore');
+ is_deeply(
+ $state,
+ { existed => 1, previous => $stored, assigned => $stored },
+ 'in place: previous identity',
+ );
+ my $conf = conf_of($class, 151);
+ is($conf->{lock}, 'restore', 'in place: locked');
+ is($conf->{name}, 'target', 'in place: config is kept');
+ is_deeply(identity_of($class, 151), $stored, 'in place: identity is kept');
+
+ eval { $class->create_and_lock_config(151, 1) };
+ like($@, qr/^VM is locked \(restore\)/, 'locked config is refused');
+
+ set_file($class, 152, "meta: ctime=1\nname: old\n");
+ $state = $class->create_and_lock_config(152, 1);
+ is_deeply(
+ $state,
+ { existed => 1, previous => undef, assigned => identity_of($class, 152) },
+ 'in place without identity: reservation gets one',
+ );
+ ok($state->{assigned}, 'in place without identity: reserved identity');
+
+ set_file($class, 157, '');
+ $state = $class->create_and_lock_config(157, 1);
+ is_deeply(
+ $state,
+ { existed => 1, previous => undef, assigned => identity_of($class, 157) },
+ 'in place with empty config: reservation gets an identity',
+ );
+ ok($state->{assigned}, 'in place with empty config: reserved identity');
+
+ set_file($class, 156, "meta: rtime=5,uid=$foreign_uid\n!unparsable\n");
+ $state = $class->create_and_lock_config(156, 1);
+ my $kept = { uid => $foreign_uid, rtime => 5 };
+ is_deeply(
+ $state,
+ { existed => 1, previous => $kept, assigned => $kept },
+ 'in place, config fails to load: stored identity',
+ );
+ is_deeply(
+ identity_of($class, 156),
+ $kept,
+ 'in place, config fails to load: identity is kept',
+ );
+
+ # clone: the target's first write must not store the source's identity
+ $state = $class->create_and_lock_config(153);
+ $conf = conf_of($class, 151);
+ delete $conf->{lock};
+ $class->write_config(153, $conf);
+ is_deeply(identity_of($class, 153), $state->{assigned},
+ 'clone keeps the reserved identity');
+ like(file_of($class, 153), qr/^meta: ctime=1,/m, 'clone keeps other members of the source');
+
+ local $check_identity_lock = 0;
+ $class = 'PVE::TestConfig::NoIdentity';
+
+ $state = $class->create_and_lock_config(154);
+ is_deeply(
+ $state,
+ { existed => 0, previous => undef, assigned => undef },
+ 'disabled, free VMID: no previous identity',
+ );
+ is(file_of($class, 154), "lock: create\n", 'disabled, free VMID: no identity assigned');
+
+ set_file($class, 155, "meta: ctime=1,rtime=5,uid=$foreign_uid\nname: old\n");
+ $state = $class->create_and_lock_config(155, 1);
+ is_deeply(
+ $state,
+ { existed => 1, previous => { uid => $foreign_uid, rtime => 5 }, assigned => undef },
+ 'disabled, in place: identity from the config',
+ );
+ is(
+ file_of($class, 155),
+ "lock: create\nmeta: ctime=1,rtime=5,uid=$foreign_uid\nname: old\n",
+ 'disabled, in place: config is kept',
+ );
+};
+
done_testing();
--
2.47.3
next prev parent reply other threads:[~2026-11-17 22:41 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-11-17 22:34 [PATCH cluster/guest-common/qemu-server/container/manager/docs v2 00/36] fix #7846: guest identity (uid) and cluster ID Thomas Lamprecht
2026-11-17 22:34 ` [PATCH cluster v2 01/36] pmxcfs: reject changes to the cluster ID file from user space Thomas Lamprecht
2026-11-17 22:34 ` [PATCH cluster v2 02/36] pmxcfs: generate a cluster ID on standalone nodes Thomas Lamprecht
2026-11-17 22:34 ` [PATCH cluster v2 03/36] pmxcfs: dfsm: add a callback that runs once all members are in sync Thomas Lamprecht
2026-11-17 22:34 ` [PATCH cluster v2 04/36] pmxcfs: quorum: pass the corosync membership to an optional listener Thomas Lamprecht
2026-11-17 22:34 ` [PATCH cluster v2 05/36] pmxcfs: dcdb: generate the cluster ID once the cluster is in sync Thomas Lamprecht
2026-11-17 22:34 ` [PATCH cluster v2 06/36] cluster: add helper to read the cluster ID Thomas Lamprecht
2026-11-17 22:34 ` [PATCH cluster v2 07/36] pmxcfs: allow removing the cluster ID file in forced local mode Thomas Lamprecht
2026-11-17 22:34 ` [PATCH guest-common v2 08/36] guest identity: add helpers for the guest uid and registration time Thomas Lamprecht
2026-11-17 22:34 ` [PATCH guest-common v2 09/36] abstract config: assign a guest identity and keep it on config writes Thomas Lamprecht
2026-11-17 22:34 ` Thomas Lamprecht [this message]
2026-11-17 22:34 ` [PATCH guest-common v2 11/36] guest identity: allow taking over a uid that is unused in the cluster Thomas Lamprecht
2026-11-17 22:34 ` [PATCH qemu-server v2 12/36] api: restore: release the VMID if a restore to an unused VMID fails Thomas Lamprecht
2026-11-17 22:34 ` [PATCH qemu-server v2 13/36] api: migrate, clone: refuse targets that would drop the guest identity Thomas Lamprecht
2026-11-17 22:34 ` [PATCH qemu-server v2 14/36] fix #7846: config: add a guest identity to the 'meta' property Thomas Lamprecht
2026-11-17 22:34 ` [PATCH qemu-server v2 15/36] restore: take over the guest uid from the backup where possible Thomas Lamprecht
2026-11-17 22:34 ` [PATCH qemu-server v2 16/36] api: remote migration: take over the guest uid from the source Thomas Lamprecht
2026-11-17 22:34 ` [PATCH qemu-server v2 17/36] api: status: return the guest uid Thomas Lamprecht
2026-11-17 22:34 ` [PATCH qemu-server v2 18/36] tests: remote migration: check a failed command and an early tunnel end Thomas Lamprecht
2026-11-17 22:34 ` [PATCH container v2 19/36] config: add read-only meta property with the creation time Thomas Lamprecht
2026-11-17 22:34 ` [PATCH container v2 20/36] fix #7846: config: add a guest identity to the 'meta' property Thomas Lamprecht
2026-11-17 22:34 ` [PATCH container v2 21/36] api: migrate, clone: refuse targets that would drop the guest identity Thomas Lamprecht
2026-11-17 22:34 ` [PATCH container v2 22/36] restore: take over the guest uid from the backup where possible Thomas Lamprecht
2026-11-17 22:34 ` [PATCH container v2 23/36] restore: refuse overwriting a container with another guest's backup Thomas Lamprecht
2026-11-17 22:34 ` [PATCH container v2 24/36] test: remote migration: check the cleanup of the target after failures Thomas Lamprecht
2026-11-17 22:34 ` [PATCH container v2 25/36] api: remote migration: take over the guest uid from the source Thomas Lamprecht
2026-11-17 22:34 ` [PATCH container v2 26/36] api: status: return the guest uid Thomas Lamprecht
2026-11-17 22:34 ` [PATCH manager v2 27/36] api: cluster resources: add guest uid and registration time Thomas Lamprecht
2026-11-17 22:34 ` [PATCH manager v2 28/36] api: cluster status: add cluster ID Thomas Lamprecht
2026-11-17 22:34 ` [PATCH manager v2 29/36] ui: restore: allow overwriting a guest with a backup of another guest Thomas Lamprecht
2026-11-17 22:34 ` [PATCH manager v2 30/36] ui: migrate: refuse target nodes that would drop the guest identity Thomas Lamprecht
2026-11-17 22:34 ` [PATCH manager v2 31/36] ui: guest summary: show " Thomas Lamprecht
2026-11-17 22:34 ` [PATCH manager v2 32/36] api: migrate all: refuse targets that would drop " Thomas Lamprecht
2026-11-17 22:34 ` [PATCH docs v2 33/36] vzdump: describe the guest identity of VMs and containers Thomas Lamprecht
2026-11-17 22:34 ` [PATCH docs v2 34/36] pvecm: document the cluster ID and how to get a new one Thomas Lamprecht
2026-11-17 22:34 ` [PATCH docs v2 35/36] qm: configuration: describe the read-only meta property Thomas Lamprecht
2026-11-17 22:34 ` [PATCH docs v2 36/36] pct: " Thomas Lamprecht
2026-11-18 5:57 ` superseded: [PATCH cluster/guest-common/qemu-server/container/manager/docs v2 00/36] fix #7846: guest identity (uid) and cluster ID Thomas Lamprecht
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20261117223945.862914-11-t.lamprecht@proxmox.com \
--to=t.lamprecht@proxmox.com \
--cc=pve-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox