]> git.proxmox.com Git - qemu-server.git/blame - PVE/QemuServer.pm
d/control: make pve-qemu-kvm build-dependency versioned to >= 7.1
[qemu-server.git] / PVE / QemuServer.pm
CommitLineData
baa4f62d 1package PVE::QemuServer;
1e3baf05
DM
2
3use strict;
990fc5e2 4use warnings;
3ff84d6f 5
5da072fb
TL
6use Cwd 'abs_path';
7use Digest::SHA;
8use Fcntl ':flock';
9use Fcntl;
1e3baf05 10use File::Basename;
5da072fb 11use File::Copy qw(copy);
1e3baf05
DM
12use File::Path;
13use File::stat;
14use Getopt::Long;
5da072fb
TL
15use IO::Dir;
16use IO::File;
17use IO::Handle;
18use IO::Select;
19use IO::Socket::UNIX;
1e3baf05 20use IPC::Open3;
c971c4f2 21use JSON;
1f30ac3a 22use MIME::Base64;
5da072fb
TL
23use POSIX;
24use Storable qw(dclone);
f85951dc 25use Time::HiRes qw(gettimeofday usleep);
5da072fb 26use URI::Escape;
425441e6 27use UUID;
5da072fb 28
82841214 29use PVE::Cluster qw(cfs_register_file cfs_read_file cfs_write_file);
5b65b00d 30use PVE::CGroup;
83870398 31use PVE::CpuSet;
48cf040f 32use PVE::DataCenterConfig;
5da072fb 33use PVE::Exception qw(raise raise_param_exc);
3b56383b 34use PVE::Format qw(render_duration render_bytes);
81d6e4e1 35use PVE::GuestHelpers qw(safe_string_ne safe_num_ne safe_boolean_ne);
1e3baf05 36use PVE::INotify;
4df98f2f 37use PVE::JSONSchema qw(get_standard_option parse_property_string);
1e3baf05 38use PVE::ProcFSTools;
fbec3f89 39use PVE::PBSClient;
34e82fa2 40use PVE::RESTEnvironment qw(log_warn);
91bd6c90 41use PVE::RPCEnvironment;
5da072fb 42use PVE::Storage;
b71351a7 43use PVE::SysFSTools;
d04d6af1 44use PVE::Systemd;
82841214 45use PVE::Tools qw(run_command file_read_firstline file_get_contents dir_glob_foreach get_host_arch $IPV6RE);
5da072fb
TL
46
47use PVE::QMPClient;
48use PVE::QemuConfig;
238af88e 49use PVE::QemuServer::Helpers qw(min_version config_aware_timeout windows_version);
5da072fb 50use PVE::QemuServer::Cloudinit;
5b65b00d 51use PVE::QemuServer::CGroup;
d786a274 52use PVE::QemuServer::CPUConfig qw(print_cpu_device get_cpu_options);
75748d44 53use PVE::QemuServer::Drive qw(is_valid_drivename drive_is_cloudinit drive_is_cdrom drive_is_read_only parse_drive print_drive);
2ea5fb7e 54use PVE::QemuServer::Machine;
5da072fb 55use PVE::QemuServer::Memory;
0a13e08e 56use PVE::QemuServer::Monitor qw(mon_cmd);
74c17b7a 57use PVE::QemuServer::PCI qw(print_pci_addr print_pcie_addr print_pcie_root_port parse_hostpci);
5da072fb 58use PVE::QemuServer::USB qw(parse_usb_device);
1e3baf05 59
28e129cc
AD
60my $have_sdn;
61eval {
62 require PVE::Network::SDN::Zones;
63 $have_sdn = 1;
64};
65
102cf9d8 66my $EDK2_FW_BASE = '/usr/share/pve-edk2-firmware/';
96ed3574 67my $OVMF = {
b5099b4f 68 x86_64 => {
90b20b15
DC
69 '4m-no-smm' => [
70 "$EDK2_FW_BASE/OVMF_CODE_4M.fd",
71 "$EDK2_FW_BASE/OVMF_VARS_4M.fd",
72 ],
73 '4m-no-smm-ms' => [
74 "$EDK2_FW_BASE/OVMF_CODE_4M.fd",
75 "$EDK2_FW_BASE/OVMF_VARS_4M.ms.fd",
76 ],
b5099b4f
SR
77 '4m' => [
78 "$EDK2_FW_BASE/OVMF_CODE_4M.secboot.fd",
79 "$EDK2_FW_BASE/OVMF_VARS_4M.fd",
80 ],
81 '4m-ms' => [
82 "$EDK2_FW_BASE/OVMF_CODE_4M.secboot.fd",
83 "$EDK2_FW_BASE/OVMF_VARS_4M.ms.fd",
84 ],
85 default => [
86 "$EDK2_FW_BASE/OVMF_CODE.fd",
87 "$EDK2_FW_BASE/OVMF_VARS.fd",
88 ],
89 },
90 aarch64 => {
91 default => [
92 "$EDK2_FW_BASE/AAVMF_CODE.fd",
93 "$EDK2_FW_BASE/AAVMF_VARS.fd",
94 ],
95 },
96ed3574 96};
2ddc0a5c 97
7f0b5beb 98my $cpuinfo = PVE::ProcFSTools::read_cpuinfo();
1e3baf05 99
8d88a594
TL
100# Note about locking: we use flock on the config file protect against concurent actions.
101# Aditionaly, we have a 'lock' setting in the config file. This can be set to 'migrate',
102# 'backup', 'snapshot' or 'rollback'. Most actions are not allowed when such lock is set.
103# But you can ignore this kind of lock with the --skiplock flag.
1e3baf05 104
97d62eb7 105cfs_register_file('/qemu-server/',
1858638f
DM
106 \&parse_vm_config,
107 \&write_vm_config);
1e3baf05 108
3ea94c60
DM
109PVE::JSONSchema::register_standard_option('pve-qm-stateuri', {
110 description => "Some command save/restore state from this location.",
111 type => 'string',
112 maxLength => 128,
113 optional => 1,
114});
115
c6737ef1
DC
116PVE::JSONSchema::register_standard_option('pve-qemu-machine', {
117 description => "Specifies the Qemu machine type.",
118 type => 'string',
9471e48b 119 pattern => '(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)',
c6737ef1
DC
120 maxLength => 40,
121 optional => 1,
122});
123
1e3baf05
DM
124#no warnings 'redefine';
125
38277afc
TL
126my $nodename_cache;
127sub nodename {
128 $nodename_cache //= PVE::INotify::nodename();
129 return $nodename_cache;
130}
1e3baf05 131
ec3582b5
WB
132my $watchdog_fmt = {
133 model => {
134 default_key => 1,
135 type => 'string',
136 enum => [qw(i6300esb ib700)],
137 description => "Watchdog type to emulate.",
138 default => 'i6300esb',
139 optional => 1,
140 },
141 action => {
142 type => 'string',
143 enum => [qw(reset shutdown poweroff pause debug none)],
144 description => "The action to perform if after activation the guest fails to poll the watchdog in time.",
145 optional => 1,
146 },
147};
148PVE::JSONSchema::register_format('pve-qm-watchdog', $watchdog_fmt);
149
9d66b397
SI
150my $agent_fmt = {
151 enabled => {
8d88a594 152 description => "Enable/disable communication with a Qemu Guest Agent (QGA) running in the VM.",
9d66b397
SI
153 type => 'boolean',
154 default => 0,
155 default_key => 1,
156 },
157 fstrim_cloned_disks => {
0a4aff09 158 description => "Run fstrim after moving a disk or migrating the VM.",
9d66b397
SI
159 type => 'boolean',
160 optional => 1,
161 default => 0
162 },
48657158
MD
163 type => {
164 description => "Select the agent type",
165 type => 'string',
166 default => 'virtio',
167 optional => 1,
168 enum => [qw(virtio isa)],
169 },
9d66b397
SI
170};
171
55655ebc
DC
172my $vga_fmt = {
173 type => {
174 description => "Select the VGA type.",
175 type => 'string',
176 default => 'std',
177 optional => 1,
178 default_key => 1,
6f070e39 179 enum => [qw(cirrus qxl qxl2 qxl3 qxl4 none serial0 serial1 serial2 serial3 std virtio virtio-gl vmware)],
55655ebc
DC
180 },
181 memory => {
182 description => "Sets the VGA memory (in MiB). Has no effect with serial display.",
183 type => 'integer',
184 optional => 1,
185 minimum => 4,
186 maximum => 512,
187 },
188};
189
6dbcb073
DC
190my $ivshmem_fmt = {
191 size => {
192 type => 'integer',
193 minimum => 1,
194 description => "The size of the file in MB.",
195 },
196 name => {
197 type => 'string',
198 pattern => '[a-zA-Z0-9\-]+',
199 optional => 1,
200 format_description => 'string',
201 description => "The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.",
202 },
203};
204
1448547f
AL
205my $audio_fmt = {
206 device => {
207 type => 'string',
208 enum => [qw(ich9-intel-hda intel-hda AC97)],
209 description => "Configure an audio device."
210 },
211 driver => {
212 type => 'string',
211785ee 213 enum => ['spice', 'none'],
1448547f
AL
214 default => 'spice',
215 optional => 1,
216 description => "Driver backend for the audio device."
217 },
218};
219
c4df18db
AL
220my $spice_enhancements_fmt = {
221 foldersharing => {
222 type => 'boolean',
223 optional => 1,
d282a24d 224 default => '0',
c4df18db
AL
225 description => "Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM."
226 },
227 videostreaming => {
228 type => 'string',
229 enum => ['off', 'all', 'filter'],
d282a24d 230 default => 'off',
c4df18db
AL
231 optional => 1,
232 description => "Enable video streaming. Uses compression for detected video streams."
233 },
234};
235
2cf61f33
SR
236my $rng_fmt = {
237 source => {
238 type => 'string',
239 enum => ['/dev/urandom', '/dev/random', '/dev/hwrng'],
240 default_key => 1,
8d88a594
TL
241 description => "The file on the host to gather entropy from. In most cases '/dev/urandom'"
242 ." should be preferred over '/dev/random' to avoid entropy-starvation issues on the"
243 ." host. Using urandom does *not* decrease security in any meaningful way, as it's"
244 ." still seeded from real entropy, and the bytes provided will most likely be mixed"
245 ." with real entropy on the guest as well. '/dev/hwrng' can be used to pass through"
246 ." a hardware RNG from the host.",
2cf61f33
SR
247 },
248 max_bytes => {
249 type => 'integer',
8d88a594
TL
250 description => "Maximum bytes of entropy allowed to get injected into the guest every"
251 ." 'period' milliseconds. Prefer a lower value when using '/dev/random' as source. Use"
252 ." `0` to disable limiting (potentially dangerous!).",
2cf61f33
SR
253 optional => 1,
254
8d88a594
TL
255 # default is 1 KiB/s, provides enough entropy to the guest to avoid boot-starvation issues
256 # (e.g. systemd etc...) while allowing no chance of overwhelming the host, provided we're
257 # reading from /dev/urandom
2cf61f33
SR
258 default => 1024,
259 },
260 period => {
261 type => 'integer',
8d88a594
TL
262 description => "Every 'period' milliseconds the entropy-injection quota is reset, allowing"
263 ." the guest to retrieve another 'max_bytes' of entropy.",
2cf61f33
SR
264 optional => 1,
265 default => 1000,
266 },
267};
268
26b443c8
TL
269my $meta_info_fmt = {
270 'ctime' => {
271 type => 'integer',
272 description => "The guest creation timestamp as UNIX epoch time",
273 minimum => 0,
274 optional => 1,
275 },
af2a1a1c
TL
276 'creation-qemu' => {
277 type => 'string',
278 description => "The QEMU (machine) version from the time this VM was created.",
279 pattern => '\d+(\.\d+)+',
280 optional => 1,
281 },
26b443c8
TL
282};
283
1e3baf05
DM
284my $confdesc = {
285 onboot => {
286 optional => 1,
287 type => 'boolean',
288 description => "Specifies whether a VM will be started during system bootup.",
289 default => 0,
290 },
291 autostart => {
292 optional => 1,
293 type => 'boolean',
294 description => "Automatic restart after crash (currently ignored).",
295 default => 0,
296 },
2ff09f52 297 hotplug => {
483ceeab
TL
298 optional => 1,
299 type => 'string', format => 'pve-hotplug-features',
300 description => "Selectively enable hotplug features. This is a comma separated list of"
94ec5e7c 301 ." hotplug features: 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable"
c60cad61
DC
302 ." hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`."
303 ." USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or"
304 ." windows > 7.",
b3c2bdd1 305 default => 'network,disk,usb',
2ff09f52 306 },
1e3baf05
DM
307 reboot => {
308 optional => 1,
309 type => 'boolean',
310 description => "Allow reboot. If set to '0' the VM exit on reboot.",
311 default => 1,
312 },
313 lock => {
314 optional => 1,
315 type => 'string',
316 description => "Lock/unlock the VM.",
159719e5 317 enum => [qw(backup clone create migrate rollback snapshot snapshot-delete suspending suspended)],
1e3baf05
DM
318 },
319 cpulimit => {
320 optional => 1,
c6f773b8 321 type => 'number',
52261945 322 description => "Limit of CPU usage.",
8d88a594
TL
323 verbose_description => "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has"
324 ." total of '2' CPU time. Value '0' indicates no CPU limit.",
1e3baf05 325 minimum => 0,
c6f773b8 326 maximum => 128,
483ceeab 327 default => 0,
1e3baf05
DM
328 },
329 cpuunits => {
330 optional => 1,
331 type => 'integer',
483ceeab 332 description => "CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2.",
67498860
TL
333 verbose_description => "CPU weight for a VM. Argument is used in the kernel fair scheduler."
334 ." The larger the number is, the more CPU time this VM gets. Number is relative to"
335 ." weights of all the other running VMs.",
e65e35ca 336 minimum => 1,
237239bf 337 maximum => 262144,
67498860 338 default => 'cgroup v1: 1024, cgroup v2: 100',
1e3baf05
DM
339 },
340 memory => {
341 optional => 1,
342 type => 'integer',
8d88a594
TL
343 description => "Amount of RAM for the VM in MB. This is the maximum available memory when"
344 ." you use the balloon device.",
1e3baf05
DM
345 minimum => 16,
346 default => 512,
347 },
13a48620 348 balloon => {
483ceeab
TL
349 optional => 1,
350 type => 'integer',
351 description => "Amount of target RAM for the VM in MB. Using zero disables the ballon driver.",
8b1accf7
DM
352 minimum => 0,
353 },
354 shares => {
483ceeab
TL
355 optional => 1,
356 type => 'integer',
357 description => "Amount of memory shares for auto-ballooning. The larger the number is, the"
8d88a594
TL
358 ." more memory this VM gets. Number is relative to weights of all other running VMs."
359 ." Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.",
8b1accf7
DM
360 minimum => 0,
361 maximum => 50000,
362 default => 1000,
13a48620 363 },
1e3baf05
DM
364 keyboard => {
365 optional => 1,
366 type => 'string',
233fb336
DW
367 description => "Keyboard layout for VNC server. This option is generally not required and"
368 ." is often better handled from within the guest OS.",
e95fe75f 369 enum => PVE::Tools::kvmkeymaplist(),
aea47dd6 370 default => undef,
1e3baf05
DM
371 },
372 name => {
373 optional => 1,
7fabe17d 374 type => 'string', format => 'dns-name',
1e3baf05
DM
375 description => "Set a name for the VM. Only used on the configuration web interface.",
376 },
cdd20088
AD
377 scsihw => {
378 optional => 1,
379 type => 'string',
52261945 380 description => "SCSI controller model",
6731a4cf 381 enum => [qw(lsi lsi53c810 virtio-scsi-pci virtio-scsi-single megasas pvscsi)],
cdd20088
AD
382 default => 'lsi',
383 },
1e3baf05
DM
384 description => {
385 optional => 1,
386 type => 'string',
a200af10
TL
387 description => "Description for the VM. Shown in the web-interface VM's summary."
388 ." This is saved as comment inside the configuration file.",
389 maxLength => 1024 * 8,
1e3baf05
DM
390 },
391 ostype => {
392 optional => 1,
393 type => 'string',
483ceeab 394 enum => [qw(other wxp w2k w2k3 w2k8 wvista win7 win8 win10 win11 l24 l26 solaris)],
52261945
DM
395 description => "Specify guest operating system.",
396 verbose_description => <<EODESC,
397Specify guest operating system. This is used to enable special
398optimization/features for specific operating systems:
399
400[horizontal]
401other;; unspecified OS
402wxp;; Microsoft Windows XP
403w2k;; Microsoft Windows 2000
404w2k3;; Microsoft Windows 2003
405w2k8;; Microsoft Windows 2008
406wvista;; Microsoft Windows Vista
407win7;; Microsoft Windows 7
44c2a647 408win8;; Microsoft Windows 8/2012/2012r2
1f5828f2 409win10;; Microsoft Windows 10/2016/2019
179b9f1b 410win11;; Microsoft Windows 11/2022
52261945 411l24;; Linux 2.4 Kernel
a5269260 412l26;; Linux 2.6 - 5.X Kernel
52261945 413solaris;; Solaris/OpenSolaris/OpenIndiania kernel
1e3baf05
DM
414EODESC
415 },
416 boot => {
417 optional => 1,
2141a802 418 type => 'string', format => 'pve-qm-boot',
483ceeab
TL
419 description => "Specify guest boot order. Use the 'order=' sub-property as usage with no"
420 ." key or 'legacy=' is deprecated.",
1e3baf05
DM
421 },
422 bootdisk => {
423 optional => 1,
424 type => 'string', format => 'pve-qm-bootdisk',
2141a802 425 description => "Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.",
03e480fc 426 pattern => '(ide|sata|scsi|virtio)\d+',
1e3baf05
DM
427 },
428 smp => {
429 optional => 1,
430 type => 'integer',
431 description => "The number of CPUs. Please use option -sockets instead.",
432 minimum => 1,
433 default => 1,
434 },
435 sockets => {
436 optional => 1,
437 type => 'integer',
438 description => "The number of CPU sockets.",
439 minimum => 1,
440 default => 1,
441 },
442 cores => {
443 optional => 1,
444 type => 'integer',
445 description => "The number of cores per socket.",
446 minimum => 1,
447 default => 1,
448 },
8a010eae
AD
449 numa => {
450 optional => 1,
451 type => 'boolean',
1917695c 452 description => "Enable/disable NUMA.",
8a010eae
AD
453 default => 0,
454 },
7023f3ea
AD
455 hugepages => {
456 optional => 1,
457 type => 'string',
458 description => "Enable/disable hugepages memory.",
459 enum => [qw(any 2 1024)],
460 },
f36e9894
SR
461 keephugepages => {
462 optional => 1,
463 type => 'boolean',
464 default => 0,
4df98f2f
TL
465 description => "Use together with hugepages. If enabled, hugepages will not not be deleted"
466 ." after VM shutdown and can be used for subsequent starts.",
f36e9894 467 },
de9d1e55 468 vcpus => {
3bd18e48
AD
469 optional => 1,
470 type => 'integer',
de9d1e55 471 description => "Number of hotplugged vcpus.",
3bd18e48 472 minimum => 1,
de9d1e55 473 default => 0,
3bd18e48 474 },
1e3baf05
DM
475 acpi => {
476 optional => 1,
477 type => 'boolean',
478 description => "Enable/disable ACPI.",
479 default => 1,
480 },
bc84dcca 481 agent => {
ab6a046f 482 optional => 1,
8d88a594 483 description => "Enable/disable communication with the Qemu Guest Agent and its properties.",
9d66b397
SI
484 type => 'string',
485 format => $agent_fmt,
ab6a046f 486 },
1e3baf05
DM
487 kvm => {
488 optional => 1,
489 type => 'boolean',
490 description => "Enable/disable KVM hardware virtualization.",
491 default => 1,
492 },
493 tdf => {
494 optional => 1,
495 type => 'boolean',
8c559505
DM
496 description => "Enable/disable time drift fix.",
497 default => 0,
1e3baf05 498 },
19672434 499 localtime => {
1e3baf05
DM
500 optional => 1,
501 type => 'boolean',
8d88a594
TL
502 description => "Set the real time clock (RTC) to local time. This is enabled by default if"
503 ." the `ostype` indicates a Microsoft Windows OS.",
1e3baf05
DM
504 },
505 freeze => {
506 optional => 1,
507 type => 'boolean',
508 description => "Freeze CPU at startup (use 'c' monitor command to start execution).",
509 },
510 vga => {
511 optional => 1,
55655ebc
DC
512 type => 'string', format => $vga_fmt,
513 description => "Configure the VGA hardware.",
4df98f2f
TL
514 verbose_description => "Configure the VGA Hardware. If you want to use high resolution"
515 ." modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU"
516 ." 2.9 the default VGA display type is 'std' for all OS types besides some Windows"
517 ." versions (XP and older) which use 'cirrus'. The 'qxl' option enables the SPICE"
518 ." display server. For win* OS you can select how many independent displays you want,"
519 ." Linux guests can add displays them self.\nYou can also run without any graphic card,"
520 ." using a serial device as terminal.",
1e3baf05 521 },
0ea9541d
DM
522 watchdog => {
523 optional => 1,
524 type => 'string', format => 'pve-qm-watchdog',
52261945 525 description => "Create a virtual hardware watchdog device.",
4df98f2f
TL
526 verbose_description => "Create a virtual hardware watchdog device. Once enabled (by a guest"
527 ." action), the watchdog must be periodically polled by an agent inside the guest or"
528 ." else the watchdog will reset the guest (or execute the respective action specified)",
0ea9541d 529 },
1e3baf05
DM
530 startdate => {
531 optional => 1,
19672434 532 type => 'string',
1e3baf05 533 typetext => "(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)",
4df98f2f
TL
534 description => "Set the initial date of the real time clock. Valid format for date are:"
535 ."'now' or '2006-06-17T16:01:21' or '2006-06-17'.",
1e3baf05
DM
536 pattern => '(now|\d{4}-\d{1,2}-\d{1,2}(T\d{1,2}:\d{1,2}:\d{1,2})?)',
537 default => 'now',
538 },
43574f73 539 startup => get_standard_option('pve-startup-order'),
68eda3ab
AD
540 template => {
541 optional => 1,
542 type => 'boolean',
543 description => "Enable/disable Template.",
544 default => 0,
545 },
1e3baf05
DM
546 args => {
547 optional => 1,
548 type => 'string',
52261945
DM
549 description => "Arbitrary arguments passed to kvm.",
550 verbose_description => <<EODESCR,
c7a8aad6 551Arbitrary arguments passed to kvm, for example:
1e3baf05
DM
552
553args: -no-reboot -no-hpet
c7a8aad6
FG
554
555NOTE: this option is for experts only.
1e3baf05
DM
556EODESCR
557 },
558 tablet => {
559 optional => 1,
560 type => 'boolean',
561 default => 1,
52261945 562 description => "Enable/disable the USB tablet device.",
4df98f2f
TL
563 verbose_description => "Enable/disable the USB tablet device. This device is usually needed"
564 ." to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with"
565 ." normal VNC clients. If you're running lots of console-only guests on one host, you"
566 ." may consider disabling this to save some context switches. This is turned off by"
567 ." default if you use spice (`qm set <vmid> --vga qxl`).",
1e3baf05
DM
568 },
569 migrate_speed => {
570 optional => 1,
571 type => 'integer',
572 description => "Set maximum speed (in MB/s) for migrations. Value 0 is no limit.",
573 minimum => 0,
574 default => 0,
575 },
576 migrate_downtime => {
577 optional => 1,
04432191 578 type => 'number',
1e3baf05
DM
579 description => "Set maximum tolerated downtime (in seconds) for migrations.",
580 minimum => 0,
04432191 581 default => 0.1,
1e3baf05
DM
582 },
583 cdrom => {
584 optional => 1,
b799312f 585 type => 'string', format => 'pve-qm-ide',
8485b9ba 586 typetext => '<volume>',
1e3baf05
DM
587 description => "This is an alias for option -ide2",
588 },
589 cpu => {
590 optional => 1,
591 description => "Emulated CPU type.",
592 type => 'string',
5d008ad3 593 format => 'pve-vm-cpu-conf',
1e3baf05 594 },
b7ba6b79
DM
595 parent => get_standard_option('pve-snapshot-name', {
596 optional => 1,
597 description => "Parent snapshot name. This is used internally, and should not be modified.",
598 }),
982c7f12
DM
599 snaptime => {
600 optional => 1,
601 description => "Timestamp for snapshots.",
602 type => 'integer',
603 minimum => 0,
604 },
18bfb361
DM
605 vmstate => {
606 optional => 1,
607 type => 'string', format => 'pve-volume-id',
4df98f2f
TL
608 description => "Reference to a volume which stores the VM state. This is used internally"
609 ." for snapshots.",
18bfb361 610 },
253624c7
FG
611 vmstatestorage => get_standard_option('pve-storage-id', {
612 description => "Default storage for VM state volumes/files.",
613 optional => 1,
614 }),
c6737ef1 615 runningmachine => get_standard_option('pve-qemu-machine', {
4df98f2f
TL
616 description => "Specifies the QEMU machine type of the running vm. This is used internally"
617 ." for snapshots.",
c6737ef1 618 }),
ea1c2110 619 runningcpu => {
4df98f2f
TL
620 description => "Specifies the QEMU '-cpu' parameter of the running vm. This is used"
621 ." internally for snapshots.",
ea1c2110
SR
622 optional => 1,
623 type => 'string',
624 pattern => $PVE::QemuServer::CPUConfig::qemu_cmdline_cpu_re,
625 format_description => 'QEMU -cpu parameter'
626 },
c6737ef1 627 machine => get_standard_option('pve-qemu-machine'),
d731ecbe
WB
628 arch => {
629 description => "Virtual processor architecture. Defaults to the host.",
630 optional => 1,
631 type => 'string',
632 enum => [qw(x86_64 aarch64)],
633 },
2796e7d5
DM
634 smbios1 => {
635 description => "Specify SMBIOS type 1 fields.",
636 type => 'string', format => 'pve-qm-smbios1',
5d004b00 637 maxLength => 512,
2796e7d5
DM
638 optional => 1,
639 },
cb0e4540
AG
640 protection => {
641 optional => 1,
642 type => 'boolean',
4df98f2f
TL
643 description => "Sets the protection flag of the VM. This will disable the remove VM and"
644 ." remove disk operations.",
cb0e4540
AG
645 default => 0,
646 },
3edb45e7 647 bios => {
a783c78e 648 optional => 1,
3edb45e7
DM
649 type => 'string',
650 enum => [ qw(seabios ovmf) ],
651 description => "Select BIOS implementation.",
652 default => 'seabios',
a783c78e 653 },
6ee499ff
DC
654 vmgenid => {
655 type => 'string',
656 pattern => '(?:[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}|[01])',
657 format_description => 'UUID',
4df98f2f
TL
658 description => "Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0'"
659 ." to disable explicitly.",
660 verbose_description => "The VM generation ID (vmgenid) device exposes a 128-bit integer"
661 ." value identifier to the guest OS. This allows to notify the guest operating system"
662 ." when the virtual machine is executed with a different configuration (e.g. snapshot"
663 ." execution or creation from a template). The guest operating system notices the"
664 ." change, and is then able to react as appropriate by marking its copies of"
665 ." distributed databases as dirty, re-initializing its random number generator, etc.\n"
666 ."Note that auto-creation only works when done through API/CLI create or update methods"
667 .", but not when manually editing the config file.",
f7ed64e7 668 default => "1 (autogenerated)",
6ee499ff
DC
669 optional => 1,
670 },
9e784b11
DC
671 hookscript => {
672 type => 'string',
673 format => 'pve-volume-id',
674 optional => 1,
675 description => "Script that will be executed during various steps in the vms lifetime.",
676 },
6dbcb073
DC
677 ivshmem => {
678 type => 'string',
679 format => $ivshmem_fmt,
4df98f2f
TL
680 description => "Inter-VM shared memory. Useful for direct communication between VMs, or to"
681 ." the host.",
6dbcb073 682 optional => 1,
2e7b5925
AL
683 },
684 audio0 => {
685 type => 'string',
1448547f 686 format => $audio_fmt,
194b65f1 687 description => "Configure a audio device, useful in combination with QXL/Spice.",
2e7b5925
AL
688 optional => 1
689 },
c4df18db
AL
690 spice_enhancements => {
691 type => 'string',
692 format => $spice_enhancements_fmt,
693 description => "Configure additional enhancements for SPICE.",
694 optional => 1
695 },
b8e7068a
DC
696 tags => {
697 type => 'string', format => 'pve-tag-list',
698 description => 'Tags of the VM. This is only meta information.',
699 optional => 1,
700 },
2cf61f33
SR
701 rng0 => {
702 type => 'string',
703 format => $rng_fmt,
704 description => "Configure a VirtIO-based Random Number Generator.",
705 optional => 1,
706 },
26b443c8
TL
707 meta => {
708 type => 'string',
709 format => $meta_info_fmt,
710 description => "Some (read-only) meta-information about this guest.",
711 optional => 1,
712 },
83870398
DB
713 affinity => {
714 type => 'string', format => 'pve-cpuset',
715 description => "List of host cores used to execute guest processes.",
716 optional => 1,
717 },
9ed7a77c
WB
718};
719
cb702ebe
DL
720my $cicustom_fmt = {
721 meta => {
722 type => 'string',
723 optional => 1,
4df98f2f
TL
724 description => 'Specify a custom file containing all meta data passed to the VM via"
725 ." cloud-init. This is provider specific meaning configdrive2 and nocloud differ.',
cb702ebe
DL
726 format => 'pve-volume-id',
727 format_description => 'volume',
728 },
729 network => {
730 type => 'string',
731 optional => 1,
4df98f2f
TL
732 description => 'Specify a custom file containing all network data passed to the VM via'
733 .' cloud-init.',
cb702ebe
DL
734 format => 'pve-volume-id',
735 format_description => 'volume',
736 },
737 user => {
738 type => 'string',
739 optional => 1,
4df98f2f
TL
740 description => 'Specify a custom file containing all user data passed to the VM via'
741 .' cloud-init.',
cb702ebe
DL
742 format => 'pve-volume-id',
743 format_description => 'volume',
744 },
101beafe
CH
745 vendor => {
746 type => 'string',
747 optional => 1,
748 description => 'Specify a custom file containing all vendor data passed to the VM via'
749 .' cloud-init.',
750 format => 'pve-volume-id',
751 format_description => 'volume',
752 },
cb702ebe
DL
753};
754PVE::JSONSchema::register_format('pve-qm-cicustom', $cicustom_fmt);
755
9ed7a77c 756my $confdesc_cloudinit = {
41cd94a0
WB
757 citype => {
758 optional => 1,
759 type => 'string',
4df98f2f
TL
760 description => 'Specifies the cloud-init configuration format. The default depends on the'
761 .' configured operating system type (`ostype`. We use the `nocloud` format for Linux,'
762 .' and `configdrive2` for windows.',
545eec65 763 enum => ['configdrive2', 'nocloud', 'opennebula'],
41cd94a0 764 },
7b42f951
WB
765 ciuser => {
766 optional => 1,
767 type => 'string',
4df98f2f
TL
768 description => "cloud-init: User name to change ssh keys and password for instead of the"
769 ." image's configured default user.",
7b42f951
WB
770 },
771 cipassword => {
772 optional => 1,
773 type => 'string',
4df98f2f
TL
774 description => 'cloud-init: Password to assign the user. Using this is generally not'
775 .' recommended. Use ssh keys instead. Also note that older cloud-init versions do not'
776 .' support hashed passwords.',
7b42f951 777 },
cb702ebe
DL
778 cicustom => {
779 optional => 1,
780 type => 'string',
4df98f2f
TL
781 description => 'cloud-init: Specify custom files to replace the automatically generated'
782 .' ones at start.',
cb702ebe
DL
783 format => 'pve-qm-cicustom',
784 },
0c9a7596
AD
785 searchdomain => {
786 optional => 1,
787 type => 'string',
bd49ecb4 788 description => 'cloud-init: Sets DNS search domains for a container. Create will'
4df98f2f 789 .' automatically use the setting from the host if neither searchdomain nor nameserver'
bd49ecb4 790 .' are set.',
0c9a7596
AD
791 },
792 nameserver => {
793 optional => 1,
794 type => 'string', format => 'address-list',
bd49ecb4 795 description => 'cloud-init: Sets DNS server IP address for a container. Create will'
4df98f2f 796 .' automatically use the setting from the host if neither searchdomain nor nameserver'
bd49ecb4 797 .' are set.',
0c9a7596
AD
798 },
799 sshkeys => {
800 optional => 1,
801 type => 'string',
802 format => 'urlencoded',
1d1c4e1c 803 description => "cloud-init: Setup public SSH keys (one key per line, OpenSSH format).",
0c9a7596 804 },
1e3baf05
DM
805};
806
807# what about other qemu settings ?
808#cpu => 'string',
809#machine => 'string',
810#fda => 'file',
811#fdb => 'file',
812#mtdblock => 'file',
813#sd => 'file',
814#pflash => 'file',
815#snapshot => 'bool',
816#bootp => 'file',
817##tftp => 'dir',
818##smb => 'dir',
819#kernel => 'file',
820#append => 'string',
821#initrd => 'file',
822##soundhw => 'string',
823
824while (my ($k, $v) = each %$confdesc) {
825 PVE::JSONSchema::register_standard_option("pve-qm-$k", $v);
826}
827
0c3d18ef 828my $MAX_USB_DEVICES = 14;
5bdcf937 829my $MAX_NETS = 32;
bae179aa 830my $MAX_SERIAL_PORTS = 4;
1989a89c 831my $MAX_PARALLEL_PORTS = 3;
2ed5d572
AD
832my $MAX_NUMA = 8;
833
ffc0d8c7
WB
834my $numa_fmt = {
835 cpus => {
836 type => "string",
837 pattern => qr/\d+(?:-\d+)?(?:;\d+(?:-\d+)?)*/,
52261945 838 description => "CPUs accessing this NUMA node.",
ffc0d8c7
WB
839 format_description => "id[-id];...",
840 },
841 memory => {
842 type => "number",
52261945 843 description => "Amount of memory this NUMA node provides.",
ffc0d8c7
WB
844 optional => 1,
845 },
846 hostnodes => {
847 type => "string",
848 pattern => qr/\d+(?:-\d+)?(?:;\d+(?:-\d+)?)*/,
52261945 849 description => "Host NUMA nodes to use.",
ffc0d8c7
WB
850 format_description => "id[-id];...",
851 optional => 1,
852 },
853 policy => {
854 type => 'string',
855 enum => [qw(preferred bind interleave)],
52261945 856 description => "NUMA allocation policy.",
ffc0d8c7
WB
857 optional => 1,
858 },
859};
860PVE::JSONSchema::register_format('pve-qm-numanode', $numa_fmt);
2ed5d572
AD
861my $numadesc = {
862 optional => 1,
ffc0d8c7 863 type => 'string', format => $numa_fmt,
52261945 864 description => "NUMA topology.",
2ed5d572
AD
865};
866PVE::JSONSchema::register_standard_option("pve-qm-numanode", $numadesc);
867
868for (my $i = 0; $i < $MAX_NUMA; $i++) {
869 $confdesc->{"numa$i"} = $numadesc;
870}
1e3baf05 871
f7bc17ca
TL
872my $nic_model_list = [
873 'e1000',
874 'e1000-82540em',
875 'e1000-82544gc',
876 'e1000-82545em',
e83dd50a 877 'e1000e',
f7bc17ca
TL
878 'i82551',
879 'i82557b',
880 'i82559er',
881 'ne2k_isa',
882 'ne2k_pci',
883 'pcnet',
884 'rtl8139',
885 'virtio',
886 'vmxnet3',
887];
6b64503e 888my $nic_model_list_txt = join(' ', sort @$nic_model_list);
1e3baf05 889
52261945
DM
890my $net_fmt_bridge_descr = <<__EOD__;
891Bridge to attach the network device to. The Proxmox VE standard bridge
892is called 'vmbr0'.
893
894If you do not specify a bridge, we create a kvm user (NATed) network
895device, which provides DHCP and DNS services. The following addresses
896are used:
897
898 10.0.2.2 Gateway
899 10.0.2.3 DNS Server
900 10.0.2.4 SMB Server
901
902The DHCP server assign addresses to the guest starting from 10.0.2.15.
903__EOD__
904
cd9c34d1 905my $net_fmt = {
399d96db 906 macaddr => get_standard_option('mac-addr', {
4df98f2f
TL
907 description => "MAC address. That address must be unique withing your network. This is"
908 ." automatically generated if not specified.",
399d96db 909 }),
7f694a71
DM
910 model => {
911 type => 'string',
4df98f2f
TL
912 description => "Network Card Model. The 'virtio' model provides the best performance with"
913 ." very low CPU overhead. If your guest does not support this driver, it is usually"
914 ." best to use 'e1000'.",
7f694a71
DM
915 enum => $nic_model_list,
916 default_key => 1,
917 },
918 (map { $_ => { keyAlias => 'model', alias => 'macaddr' }} @$nic_model_list),
dbdcc5cd 919 bridge => get_standard_option('pve-bridge-id', {
52261945 920 description => $net_fmt_bridge_descr,
cd9c34d1 921 optional => 1,
dbdcc5cd 922 }),
cd9c34d1
WB
923 queues => {
924 type => 'integer',
925 minimum => 0, maximum => 16,
926 description => 'Number of packet queues to be used on the device.',
cd9c34d1
WB
927 optional => 1,
928 },
929 rate => {
930 type => 'number',
931 minimum => 0,
52261945 932 description => "Rate limit in mbps (megabytes per second) as floating point number.",
cd9c34d1
WB
933 optional => 1,
934 },
935 tag => {
936 type => 'integer',
9f41a659 937 minimum => 1, maximum => 4094,
cd9c34d1 938 description => 'VLAN tag to apply to packets on this interface.',
cd9c34d1
WB
939 optional => 1,
940 },
941 trunks => {
942 type => 'string',
943 pattern => qr/\d+(?:-\d+)?(?:;\d+(?:-\d+)?)*/,
944 description => 'VLAN trunks to pass through this interface.',
7f694a71 945 format_description => 'vlanid[;vlanid...]',
cd9c34d1
WB
946 optional => 1,
947 },
948 firewall => {
949 type => 'boolean',
950 description => 'Whether this interface should be protected by the firewall.',
cd9c34d1
WB
951 optional => 1,
952 },
953 link_down => {
954 type => 'boolean',
52261945 955 description => 'Whether this interface should be disconnected (like pulling the plug).',
cd9c34d1
WB
956 optional => 1,
957 },
61a14cde
AD
958 mtu => {
959 type => 'integer',
960 minimum => 1, maximum => 65520,
0530177b 961 description => "Force MTU, for VirtIO only. Set to '1' to use the bridge MTU",
61a14cde
AD
962 optional => 1,
963 },
cd9c34d1 964};
52261945 965
1e3baf05
DM
966my $netdesc = {
967 optional => 1,
7f694a71 968 type => 'string', format => $net_fmt,
52261945 969 description => "Specify network devices.",
1e3baf05 970};
52261945 971
1e3baf05
DM
972PVE::JSONSchema::register_standard_option("pve-qm-net", $netdesc);
973
0c9a7596
AD
974my $ipconfig_fmt = {
975 ip => {
976 type => 'string',
977 format => 'pve-ipv4-config',
978 format_description => 'IPv4Format/CIDR',
979 description => 'IPv4 address in CIDR format.',
980 optional => 1,
981 default => 'dhcp',
982 },
983 gw => {
984 type => 'string',
985 format => 'ipv4',
986 format_description => 'GatewayIPv4',
987 description => 'Default gateway for IPv4 traffic.',
988 optional => 1,
989 requires => 'ip',
990 },
991 ip6 => {
992 type => 'string',
993 format => 'pve-ipv6-config',
994 format_description => 'IPv6Format/CIDR',
995 description => 'IPv6 address in CIDR format.',
996 optional => 1,
997 default => 'dhcp',
998 },
999 gw6 => {
1000 type => 'string',
1001 format => 'ipv6',
1002 format_description => 'GatewayIPv6',
1003 description => 'Default gateway for IPv6 traffic.',
1004 optional => 1,
1005 requires => 'ip6',
1006 },
1007};
1008PVE::JSONSchema::register_format('pve-qm-ipconfig', $ipconfig_fmt);
1009my $ipconfigdesc = {
1010 optional => 1,
1011 type => 'string', format => 'pve-qm-ipconfig',
1012 description => <<'EODESCR',
1013cloud-init: Specify IP addresses and gateways for the corresponding interface.
1014
1015IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
1016
4df98f2f
TL
1017The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
1018gateway should be provided.
988be8d0
ML
1019For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires
1020cloud-init 19.4 or newer.
0c9a7596 1021
4df98f2f
TL
1022If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
1023dhcp on IPv4.
0c9a7596
AD
1024EODESCR
1025};
1026PVE::JSONSchema::register_standard_option("pve-qm-ipconfig", $netdesc);
1027
1e3baf05
DM
1028for (my $i = 0; $i < $MAX_NETS; $i++) {
1029 $confdesc->{"net$i"} = $netdesc;
9ed7a77c
WB
1030 $confdesc_cloudinit->{"ipconfig$i"} = $ipconfigdesc;
1031}
1032
1033foreach my $key (keys %$confdesc_cloudinit) {
1034 $confdesc->{$key} = $confdesc_cloudinit->{$key};
1e3baf05
DM
1035}
1036
83870398
DB
1037PVE::JSONSchema::register_format('pve-cpuset', \&pve_verify_cpuset);
1038sub pve_verify_cpuset {
1039 my ($set_text, $noerr) = @_;
1040
1041 my ($count, $members) = eval { PVE::CpuSet::parse_cpuset($set_text) };
1042
1043 if ($@) {
1044 return if $noerr;
1045 die "unable to parse cpuset option\n";
1046 }
1047
1048 return PVE::CpuSet->new($members)->short_string();
1049}
1050
ffa42b86
DC
1051PVE::JSONSchema::register_format('pve-volume-id-or-qm-path', \&verify_volume_id_or_qm_path);
1052sub verify_volume_id_or_qm_path {
822c8a07
WB
1053 my ($volid, $noerr) = @_;
1054
6e55f579
FE
1055 return $volid if $volid eq 'none' || $volid eq 'cdrom';
1056
1057 return verify_volume_id_or_absolute_path($volid, $noerr);
1058}
1059
1060PVE::JSONSchema::register_format('pve-volume-id-or-absolute-path', \&verify_volume_id_or_absolute_path);
1061sub verify_volume_id_or_absolute_path {
1062 my ($volid, $noerr) = @_;
1063
1064 return $volid if $volid =~ m|^/|;
ffa42b86 1065
822c8a07
WB
1066 $volid = eval { PVE::JSONSchema::check_format('pve-volume-id', $volid, '') };
1067 if ($@) {
d1c1af4b 1068 return if $noerr;
822c8a07
WB
1069 die $@;
1070 }
1071 return $volid;
1072}
1073
ff6ffe20 1074my $usb_fmt = {
a6b9aee4
DC
1075 host => {
1076 default_key => 1,
1077 type => 'string', format => 'pve-qm-usb-device',
1078 format_description => 'HOSTUSBDEVICE|spice',
52261945
DM
1079 description => <<EODESCR,
1080The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
1081
1082 'bus-port(.port)*' (decimal numbers) or
1083 'vendor_id:product_id' (hexadeciaml numbers) or
1084 'spice'
1085
1086You can use the 'lsusb -t' command to list existing usb devices.
1087
4df98f2f
TL
1088NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such
1089machines - use with special care.
52261945
DM
1090
1091The value 'spice' can be used to add a usb redirection devices for spice.
1092EODESCR
a6b9aee4
DC
1093 },
1094 usb3 => {
1095 optional => 1,
1096 type => 'boolean',
4862922a
DC
1097 description => "Specifies whether if given host option is a USB3 device or port."
1098 ." For modern guests (machine version >= 7.1 and ostype l26 and windows > 7), this flag"
1099 ." is irrelevant (all devices are plugged into a xhci controller).",
52261945 1100 default => 0,
a6b9aee4
DC
1101 },
1102};
1103
1e3baf05
DM
1104my $usbdesc = {
1105 optional => 1,
ff6ffe20 1106 type => 'string', format => $usb_fmt,
0c3d18ef
DC
1107 description => "Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype"
1108 ." l26 or windows > 7, n can be up to 14).",
1e3baf05
DM
1109};
1110PVE::JSONSchema::register_standard_option("pve-qm-usb", $usbdesc);
1111
bae179aa
DA
1112my $serialdesc = {
1113 optional => 1,
ca0cef26 1114 type => 'string',
1b0b51ed 1115 pattern => '(/dev/.+|socket)',
52261945
DM
1116 description => "Create a serial device inside the VM (n is 0 to 3)",
1117 verbose_description => <<EODESCR,
52261945
DM
1118Create a serial device inside the VM (n is 0 to 3), and pass through a
1119host serial device (i.e. /dev/ttyS0), or create a unix socket on the
1120host side (use 'qm terminal' to open a terminal connection).
bae179aa 1121
4df98f2f
TL
1122NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines -
1123use with special care.
bae179aa 1124
52261945 1125CAUTION: Experimental! User reported problems with this option.
bae179aa
DA
1126EODESCR
1127};
bae179aa 1128
1989a89c
DA
1129my $paralleldesc= {
1130 optional => 1,
ca0cef26 1131 type => 'string',
9ecc8431 1132 pattern => '/dev/parport\d+|/dev/usb/lp\d+',
52261945
DM
1133 description => "Map host parallel devices (n is 0 to 2).",
1134 verbose_description => <<EODESCR,
19672434 1135Map host parallel devices (n is 0 to 2).
1989a89c 1136
4df98f2f
TL
1137NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such
1138machines - use with special care.
1989a89c 1139
52261945 1140CAUTION: Experimental! User reported problems with this option.
1989a89c
DA
1141EODESCR
1142};
1989a89c
DA
1143
1144for (my $i = 0; $i < $MAX_PARALLEL_PORTS; $i++) {
1145 $confdesc->{"parallel$i"} = $paralleldesc;
1146}
1147
bae179aa
DA
1148for (my $i = 0; $i < $MAX_SERIAL_PORTS; $i++) {
1149 $confdesc->{"serial$i"} = $serialdesc;
1150}
1151
74c17b7a
SR
1152for (my $i = 0; $i < $PVE::QemuServer::PCI::MAX_HOSTPCI_DEVICES; $i++) {
1153 $confdesc->{"hostpci$i"} = $PVE::QemuServer::PCI::hostpcidesc;
040b06b7 1154}
1e3baf05 1155
e0fd2b2f
FE
1156for my $key (keys %{$PVE::QemuServer::Drive::drivedesc_hash}) {
1157 $confdesc->{$key} = $PVE::QemuServer::Drive::drivedesc_hash->{$key};
cdb0931f
DA
1158}
1159
1e3baf05
DM
1160for (my $i = 0; $i < $MAX_USB_DEVICES; $i++) {
1161 $confdesc->{"usb$i"} = $usbdesc;
1162}
1163
5cfa9f5f
SR
1164my $boot_fmt = {
1165 legacy => {
1166 optional => 1,
1167 default_key => 1,
1168 type => 'string',
1169 description => "Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n)."
1170 . " Deprecated, use 'order=' instead.",
1171 pattern => '[acdn]{1,4}',
1172 format_description => "[acdn]{1,4}",
1173
1174 # note: this is also the fallback if boot: is not given at all
1175 default => 'cdn',
1176 },
1177 order => {
1178 optional => 1,
1179 type => 'string',
1180 format => 'pve-qm-bootdev-list',
1181 format_description => "device[;device...]",
1182 description => <<EODESC,
1183The guest will attempt to boot from devices in the order they appear here.
1184
1185Disks, optical drives and passed-through storage USB devices will be directly
1186booted from, NICs will load PXE, and PCIe devices will either behave like disks
1187(e.g. NVMe) or load an option ROM (e.g. RAID controller, hardware NIC).
1188
1189Note that only devices in this list will be marked as bootable and thus loaded
1190by the guest firmware (BIOS/UEFI). If you require multiple disks for booting
1191(e.g. software-raid), you need to specify all of them here.
1192
1193Overrides the deprecated 'legacy=[acdn]*' value when given.
1194EODESC
1195 },
1196};
1197PVE::JSONSchema::register_format('pve-qm-boot', $boot_fmt);
1198
1199PVE::JSONSchema::register_format('pve-qm-bootdev', \&verify_bootdev);
1200sub verify_bootdev {
1201 my ($dev, $noerr) = @_;
1202
f9dde219
SR
1203 my $special = $dev =~ m/^efidisk/ || $dev =~ m/^tpmstate/;
1204 return $dev if PVE::QemuServer::Drive::is_valid_drivename($dev) && !$special;
5cfa9f5f
SR
1205
1206 my $check = sub {
1207 my ($base) = @_;
1208 return 0 if $dev !~ m/^$base\d+$/;
1209 return 0 if !$confdesc->{$dev};
1210 return 1;
1211 };
1212
1213 return $dev if $check->("net");
1214 return $dev if $check->("usb");
1215 return $dev if $check->("hostpci");
1216
d1c1af4b 1217 return if $noerr;
5cfa9f5f
SR
1218 die "invalid boot device '$dev'\n";
1219}
1220
1221sub print_bootorder {
1222 my ($devs) = @_;
4c27b18c 1223 return "" if !@$devs;
5cfa9f5f
SR
1224 my $data = { order => join(';', @$devs) };
1225 return PVE::JSONSchema::print_property_string($data, $boot_fmt);
1226}
1227
1e3baf05
DM
1228my $kvm_api_version = 0;
1229
1230sub kvm_version {
1e3baf05
DM
1231 return $kvm_api_version if $kvm_api_version;
1232
808a65b5 1233 open my $fh, '<', '/dev/kvm' or return;
1e3baf05 1234
646f2df4
WB
1235 # 0xae00 => KVM_GET_API_VERSION
1236 $kvm_api_version = ioctl($fh, 0xae00, 0);
808a65b5 1237 close($fh);
1e3baf05 1238
646f2df4 1239 return $kvm_api_version;
1e3baf05
DM
1240}
1241
1476b99f
DC
1242my $kvm_user_version = {};
1243my $kvm_mtime = {};
1e3baf05
DM
1244
1245sub kvm_user_version {
1476b99f 1246 my ($binary) = @_;
1e3baf05 1247
1476b99f
DC
1248 $binary //= get_command_for_arch(get_host_arch()); # get the native arch by default
1249 my $st = stat($binary);
1e3baf05 1250
1476b99f
DC
1251 my $cachedmtime = $kvm_mtime->{$binary} // -1;
1252 return $kvm_user_version->{$binary} if $kvm_user_version->{$binary} &&
1253 $cachedmtime == $st->mtime;
1254
1255 $kvm_user_version->{$binary} = 'unknown';
1256 $kvm_mtime->{$binary} = $st->mtime;
1e3baf05 1257
09b11429
TL
1258 my $code = sub {
1259 my $line = shift;
1260 if ($line =~ m/^QEMU( PC)? emulator version (\d+\.\d+(\.\d+)?)(\.\d+)?[,\s]/) {
1476b99f 1261 $kvm_user_version->{$binary} = $2;
09b11429
TL
1262 }
1263 };
19672434 1264
1476b99f 1265 eval { run_command([$binary, '--version'], outfunc => $code); };
09b11429 1266 warn $@ if $@;
1e3baf05 1267
1476b99f 1268 return $kvm_user_version->{$binary};
1e3baf05
DM
1269
1270}
4df98f2f
TL
1271my sub extract_version {
1272 my ($machine_type, $version) = @_;
1273 $version = kvm_user_version() if !defined($version);
8eb73377 1274 return PVE::QemuServer::Machine::extract_version($machine_type, $version)
4df98f2f 1275}
1e3baf05 1276
db70021b
TL
1277sub kernel_has_vhost_net {
1278 return -c '/dev/vhost-net';
1279}
1e3baf05 1280
1e3baf05
DM
1281sub option_exists {
1282 my $key = shift;
1283 return defined($confdesc->{$key});
19672434 1284}
1e3baf05 1285
1e3baf05 1286my $cdrom_path;
1e3baf05
DM
1287sub get_cdrom_path {
1288
1289 return $cdrom_path if $cdrom_path;
1290
1291 return $cdrom_path = "/dev/cdrom" if -l "/dev/cdrom";
1292 return $cdrom_path = "/dev/cdrom1" if -l "/dev/cdrom1";
1293 return $cdrom_path = "/dev/cdrom2" if -l "/dev/cdrom2";
1294}
1295
1296sub get_iso_path {
1297 my ($storecfg, $vmid, $cdrom) = @_;
1298
1299 if ($cdrom eq 'cdrom') {
1300 return get_cdrom_path();
1301 } elsif ($cdrom eq 'none') {
1302 return '';
1303 } elsif ($cdrom =~ m|^/|) {
1304 return $cdrom;
1305 } else {
6b64503e 1306 return PVE::Storage::path($storecfg, $cdrom);
1e3baf05
DM
1307 }
1308}
1309
1310# try to convert old style file names to volume IDs
1311sub filename_to_volume_id {
1312 my ($vmid, $file, $media) = @_;
1313
0c9a7596 1314 if (!($file eq 'none' || $file eq 'cdrom' ||
1e3baf05 1315 $file =~ m|^/dev/.+| || $file =~ m/^([^:]+):(.+)$/)) {
19672434 1316
d1c1af4b 1317 return if $file =~ m|/|;
19672434 1318
1e3baf05
DM
1319 if ($media && $media eq 'cdrom') {
1320 $file = "local:iso/$file";
1321 } else {
1322 $file = "local:$vmid/$file";
1323 }
1324 }
1325
1326 return $file;
1327}
1328
1329sub verify_media_type {
1330 my ($opt, $vtype, $media) = @_;
1331
1332 return if !$media;
1333
1334 my $etype;
1335 if ($media eq 'disk') {
a125592c 1336 $etype = 'images';
1e3baf05
DM
1337 } elsif ($media eq 'cdrom') {
1338 $etype = 'iso';
1339 } else {
1340 die "internal error";
1341 }
1342
1343 return if ($vtype eq $etype);
19672434 1344
1e3baf05
DM
1345 raise_param_exc({ $opt => "unexpected media type ($vtype != $etype)" });
1346}
1347
1348sub cleanup_drive_path {
1349 my ($opt, $storecfg, $drive) = @_;
1350
1351 # try to convert filesystem paths to volume IDs
1352
1353 if (($drive->{file} !~ m/^(cdrom|none)$/) &&
1354 ($drive->{file} !~ m|^/dev/.+|) &&
1355 ($drive->{file} !~ m/^([^:]+):(.+)$/) &&
19672434 1356 ($drive->{file} !~ m/^\d+$/)) {
1e3baf05 1357 my ($vtype, $volid) = PVE::Storage::path_to_volume_id($storecfg, $drive->{file});
4df98f2f
TL
1358 raise_param_exc({ $opt => "unable to associate path '$drive->{file}' to any storage"})
1359 if !$vtype;
1e3baf05
DM
1360 $drive->{media} = 'cdrom' if !$drive->{media} && $vtype eq 'iso';
1361 verify_media_type($opt, $vtype, $drive->{media});
1362 $drive->{file} = $volid;
1363 }
1364
1365 $drive->{media} = 'cdrom' if !$drive->{media} && $drive->{file} =~ m/^(cdrom|none)$/;
1366}
1367
b3c2bdd1
DM
1368sub parse_hotplug_features {
1369 my ($data) = @_;
1370
1371 my $res = {};
1372
1373 return $res if $data eq '0';
a1b7d579 1374
b3c2bdd1
DM
1375 $data = $confdesc->{hotplug}->{default} if $data eq '1';
1376
45827685 1377 foreach my $feature (PVE::Tools::split_list($data)) {
94ec5e7c 1378 if ($feature =~ m/^(network|disk|cpu|memory|usb|cloudinit)$/) {
b3c2bdd1
DM
1379 $res->{$1} = 1;
1380 } else {
596a0a20 1381 die "invalid hotplug feature '$feature'\n";
b3c2bdd1
DM
1382 }
1383 }
1384 return $res;
1385}
1386
1387PVE::JSONSchema::register_format('pve-hotplug-features', \&pve_verify_hotplug_features);
1388sub pve_verify_hotplug_features {
1389 my ($value, $noerr) = @_;
1390
1391 return $value if parse_hotplug_features($value);
1392
d1c1af4b 1393 return if $noerr;
b3c2bdd1
DM
1394
1395 die "unable to parse hotplug option\n";
1396}
1397
28ef82d3
DM
1398sub scsi_inquiry {
1399 my($fh, $noerr) = @_;
1400
1401 my $SG_IO = 0x2285;
1402 my $SG_GET_VERSION_NUM = 0x2282;
1403
1404 my $versionbuf = "\x00" x 8;
1405 my $ret = ioctl($fh, $SG_GET_VERSION_NUM, $versionbuf);
1406 if (!$ret) {
1407 die "scsi ioctl SG_GET_VERSION_NUM failoed - $!\n" if !$noerr;
d1c1af4b 1408 return;
28ef82d3 1409 }
97d62eb7 1410 my $version = unpack("I", $versionbuf);
28ef82d3
DM
1411 if ($version < 30000) {
1412 die "scsi generic interface too old\n" if !$noerr;
d1c1af4b 1413 return;
28ef82d3 1414 }
97d62eb7 1415
28ef82d3
DM
1416 my $buf = "\x00" x 36;
1417 my $sensebuf = "\x00" x 8;
f334aa3e 1418 my $cmd = pack("C x3 C x1", 0x12, 36);
97d62eb7 1419
28ef82d3
DM
1420 # see /usr/include/scsi/sg.h
1421 my $sg_io_hdr_t = "i i C C s I P P P I I i P C C C C S S i I I";
1422
f606d5bd
TL
1423 my $packet = pack(
1424 $sg_io_hdr_t, ord('S'), -3, length($cmd), length($sensebuf), 0, length($buf), $buf, $cmd, $sensebuf, 6000
1425 );
28ef82d3
DM
1426
1427 $ret = ioctl($fh, $SG_IO, $packet);
1428 if (!$ret) {
1429 die "scsi ioctl SG_IO failed - $!\n" if !$noerr;
d1c1af4b 1430 return;
28ef82d3 1431 }
97d62eb7 1432
28ef82d3
DM
1433 my @res = unpack($sg_io_hdr_t, $packet);
1434 if ($res[17] || $res[18]) {
1435 die "scsi ioctl SG_IO status error - $!\n" if !$noerr;
d1c1af4b 1436 return;
28ef82d3
DM
1437 }
1438
1439 my $res = {};
f606d5bd 1440 $res->@{qw(type removable vendor product revision)} = unpack("C C x6 A8 A16 A4", $buf);
28ef82d3 1441
f606d5bd
TL
1442 $res->{removable} = $res->{removable} & 128 ? 1 : 0;
1443 $res->{type} &= 0x1F;
09984754 1444
28ef82d3
DM
1445 return $res;
1446}
1447
1448sub path_is_scsi {
1449 my ($path) = @_;
1450
d1c1af4b 1451 my $fh = IO::File->new("+<$path") || return;
28ef82d3
DM
1452 my $res = scsi_inquiry($fh, 1);
1453 close($fh);
1454
1455 return $res;
1456}
1457
db656e5f 1458sub print_tabletdevice_full {
d559309f 1459 my ($conf, $arch) = @_;
b467f79a 1460
3392d6ca 1461 my $q35 = PVE::QemuServer::Machine::machine_type_is_q35($conf);
db656e5f
DM
1462
1463 # we use uhci for old VMs because tablet driver was buggy in older qemu
d559309f 1464 my $usbbus;
2b938c7d 1465 if ($q35 || $arch eq 'aarch64') {
d559309f
WB
1466 $usbbus = 'ehci';
1467 } else {
1468 $usbbus = 'uhci';
1469 }
b467f79a 1470
db656e5f
DM
1471 return "usb-tablet,id=tablet,bus=$usbbus.0,port=1";
1472}
1473
d559309f 1474sub print_keyboarddevice_full {
6971c38e 1475 my ($conf, $arch) = @_;
d559309f 1476
d1c1af4b 1477 return if $arch ne 'aarch64';
d559309f
WB
1478
1479 return "usb-kbd,id=keyboard,bus=ehci.0,port=2";
1480}
1481
a183df68
TL
1482my sub get_drive_id {
1483 my ($drive) = @_;
1484 return "$drive->{interface}$drive->{index}";
1485}
1486
ca916ecc 1487sub print_drivedevice_full {
d559309f 1488 my ($storecfg, $conf, $vmid, $drive, $bridges, $arch, $machine_type) = @_;
ca916ecc
DA
1489
1490 my $device = '';
1491 my $maxdev = 0;
19672434 1492
a183df68 1493 my $drive_id = get_drive_id($drive);
ca916ecc 1494 if ($drive->{interface} eq 'virtio') {
4df98f2f
TL
1495 my $pciaddr = print_pci_addr("$drive_id", $bridges, $arch, $machine_type);
1496 $device = "virtio-blk-pci,drive=drive-$drive_id,id=${drive_id}${pciaddr}";
1497 $device .= ",iothread=iothread-$drive_id" if $drive->{iothread};
2ed36a41 1498 } elsif ($drive->{interface} eq 'scsi') {
6731a4cf 1499
ee034f5c 1500 my ($maxdev, $controller, $controller_prefix) = scsihw_infos($conf, $drive);
2ed36a41
DM
1501 my $unit = $drive->{index} % $maxdev;
1502 my $devicetype = 'hd';
69bcf246
WB
1503 my $path = '';
1504 if (drive_is_cdrom($drive)) {
1505 $devicetype = 'cd';
29b19529 1506 } else {
69bcf246
WB
1507 if ($drive->{file} =~ m|^/|) {
1508 $path = $drive->{file};
1509 if (my $info = path_is_scsi($path)) {
8e3c33ab 1510 if ($info->{type} == 0 && $drive->{scsiblock}) {
69bcf246
WB
1511 $devicetype = 'block';
1512 } elsif ($info->{type} == 1) { # tape
1513 $devicetype = 'generic';
1514 }
1515 }
1516 } else {
1517 $path = PVE::Storage::path($storecfg, $drive->{file});
1518 }
1519
a034e3d6 1520 # for compatibility only, we prefer scsi-hd (#2408, #2355, #2380)
4df98f2f 1521 my $version = extract_version($machine_type, kvm_user_version());
a034e3d6 1522 if ($path =~ m/^iscsi\:\/\// &&
2ea5fb7e 1523 !min_version($version, 4, 1)) {
69bcf246
WB
1524 $devicetype = 'generic';
1525 }
1526 }
1527
ef88eaaa 1528 if (!$conf->{scsihw} || $conf->{scsihw} =~ m/^lsi/ || $conf->{scsihw} eq 'pvscsi') {
4df98f2f 1529 $device = "scsi-$devicetype,bus=$controller_prefix$controller.0,scsi-id=$unit";
69bcf246 1530 } else {
4df98f2f
TL
1531 $device = "scsi-$devicetype,bus=$controller_prefix$controller.0,channel=0,scsi-id=0"
1532 .",lun=$drive->{index}";
69bcf246 1533 }
4df98f2f 1534 $device .= ",drive=drive-$drive_id,id=$drive_id";
cdd20088 1535
6c875f9f
NC
1536 if ($drive->{ssd} && ($devicetype eq 'block' || $devicetype eq 'hd')) {
1537 $device .= ",rotation_rate=1";
1538 }
e741c516 1539 $device .= ",wwn=$drive->{wwn}" if $drive->{wwn};
6c875f9f
NC
1540
1541 } elsif ($drive->{interface} eq 'ide' || $drive->{interface} eq 'sata') {
e0fd2b2f 1542 my $maxdev = ($drive->{interface} eq 'sata') ? $PVE::QemuServer::Drive::MAX_SATA_DISKS : 2;
2ed36a41
DM
1543 my $controller = int($drive->{index} / $maxdev);
1544 my $unit = $drive->{index} % $maxdev;
1545 my $devicetype = ($drive->{media} && $drive->{media} eq 'cdrom') ? "cd" : "hd";
1546
6c875f9f
NC
1547 $device = "ide-$devicetype";
1548 if ($drive->{interface} eq 'ide') {
1549 $device .= ",bus=ide.$controller,unit=$unit";
1550 } else {
1551 $device .= ",bus=ahci$controller.$unit";
1552 }
4df98f2f 1553 $device .= ",drive=drive-$drive_id,id=$drive_id";
6c875f9f
NC
1554
1555 if ($devicetype eq 'hd') {
1556 if (my $model = $drive->{model}) {
1557 $model = URI::Escape::uri_unescape($model);
1558 $device .= ",model=$model";
1559 }
1560 if ($drive->{ssd}) {
1561 $device .= ",rotation_rate=1";
1562 }
0f2812c2 1563 }
e741c516 1564 $device .= ",wwn=$drive->{wwn}" if $drive->{wwn};
2ed36a41
DM
1565 } elsif ($drive->{interface} eq 'usb') {
1566 die "implement me";
1567 # -device ide-drive,bus=ide.1,unit=0,drive=drive-ide0-1-0,id=ide0-1-0
1568 } else {
1569 die "unsupported interface type";
ca916ecc
DA
1570 }
1571
3b408e82
DM
1572 $device .= ",bootindex=$drive->{bootindex}" if $drive->{bootindex};
1573
a70e7e6c
TL
1574 if (my $serial = $drive->{serial}) {
1575 $serial = URI::Escape::uri_unescape($serial);
1576 $device .= ",serial=$serial";
1577 }
1578
1579
ca916ecc
DA
1580 return $device;
1581}
1582
15b21acc 1583sub get_initiator_name {
46f58b5f 1584 my $initiator;
15b21acc 1585
d1c1af4b 1586 my $fh = IO::File->new('/etc/iscsi/initiatorname.iscsi') || return;
46f58b5f
DM
1587 while (defined(my $line = <$fh>)) {
1588 next if $line !~ m/^\s*InitiatorName\s*=\s*([\.\-:\w]+)/;
15b21acc
MR
1589 $initiator = $1;
1590 last;
1591 }
46f58b5f
DM
1592 $fh->close();
1593
15b21acc
MR
1594 return $initiator;
1595}
1596
776c5f50 1597sub print_drive_commandline_full {
6d5673c3 1598 my ($storecfg, $vmid, $drive, $pbs_name, $io_uring) = @_;
1e3baf05 1599
d81f0f09
DM
1600 my $path;
1601 my $volid = $drive->{file};
5921764c 1602 my $format = $drive->{format};
a183df68 1603 my $drive_id = get_drive_id($drive);
370b05e7 1604
0fe779a6
WB
1605 my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
1606 my $scfg = $storeid ? PVE::Storage::storage_config($storecfg, $storeid) : undef;
1607
d81f0f09
DM
1608 if (drive_is_cdrom($drive)) {
1609 $path = get_iso_path($storecfg, $vmid, $volid);
a183df68 1610 die "$drive_id: cannot back cdrom drive with PBS snapshot\n" if $pbs_name;
d81f0f09 1611 } else {
d81f0f09
DM
1612 if ($storeid) {
1613 $path = PVE::Storage::path($storecfg, $volid);
5921764c 1614 $format //= qemu_img_format($scfg, $volname);
d81f0f09
DM
1615 } else {
1616 $path = $volid;
5921764c 1617 $format //= "raw";
d81f0f09
DM
1618 }
1619 }
1620
5921764c
SR
1621 my $is_rbd = $path =~ m/^rbd:/;
1622
1e3baf05 1623 my $opts = '';
5921764c 1624 my @qemu_drive_options = qw(heads secs cyls trans media cache rerror werror aio discard);
1e3baf05 1625 foreach my $o (@qemu_drive_options) {
5fc74861 1626 $opts .= ",$o=$drive->{$o}" if defined($drive->{$o});
19672434 1627 }
8a267708
DC
1628
1629 # snapshot only accepts on|off
1630 if (defined($drive->{snapshot})) {
1631 my $v = $drive->{snapshot} ? 'on' : 'off';
1632 $opts .= ",snapshot=$v";
1633 }
1634
1f91f7b4
TL
1635 if (defined($drive->{ro})) { # ro maps to QEMUs `readonly`, which accepts `on` or `off` only
1636 $opts .= ",readonly=" . ($drive->{ro} ? 'on' : 'off');
12e1d472
DC
1637 }
1638
fb8e95a2
WB
1639 foreach my $type (['', '-total'], [_rd => '-read'], [_wr => '-write']) {
1640 my ($dir, $qmpname) = @$type;
1641 if (my $v = $drive->{"mbps$dir"}) {
1642 $opts .= ",throttling.bps$qmpname=".int($v*1024*1024);
1643 }
1644 if (my $v = $drive->{"mbps${dir}_max"}) {
1645 $opts .= ",throttling.bps$qmpname-max=".int($v*1024*1024);
1646 }
1647 if (my $v = $drive->{"bps${dir}_max_length"}) {
1648 $opts .= ",throttling.bps$qmpname-max-length=$v";
1649 }
1650 if (my $v = $drive->{"iops${dir}"}) {
1651 $opts .= ",throttling.iops$qmpname=$v";
1652 }
1653 if (my $v = $drive->{"iops${dir}_max"}) {
8aca1654 1654 $opts .= ",throttling.iops$qmpname-max=$v";
fb8e95a2
WB
1655 }
1656 if (my $v = $drive->{"iops${dir}_max_length"}) {
8aca1654 1657 $opts .= ",throttling.iops$qmpname-max-length=$v";
fb8e95a2
WB
1658 }
1659 }
1660
5921764c
SR
1661 if ($pbs_name) {
1662 $format = "rbd" if $is_rbd;
a183df68
TL
1663 die "$drive_id: Proxmox Backup Server backed drive cannot auto-detect the format\n"
1664 if !$format;
5921764c
SR
1665 $opts .= ",format=alloc-track,file.driver=$format";
1666 } elsif ($format) {
1667 $opts .= ",format=$format";
1668 }
d81f0f09 1669
b2ee900e
WB
1670 my $cache_direct = 0;
1671
1672 if (my $cache = $drive->{cache}) {
1673 $cache_direct = $cache =~ /^(?:off|none|directsync)$/;
0fe779a6 1674 } elsif (!drive_is_cdrom($drive) && !($scfg && $scfg->{type} eq 'btrfs' && !$scfg->{nocow})) {
b2ee900e
WB
1675 $opts .= ",cache=none";
1676 $cache_direct = 1;
1677 }
1678
628937f5
SR
1679 # io_uring with cache mode writeback or writethrough on krbd will hang...
1680 my $rbd_no_io_uring = $scfg && $scfg->{type} eq 'rbd' && $scfg->{krbd} && !$cache_direct;
1681
78a3ada7
TL
1682 # io_uring with cache mode writeback or writethrough on LVM will hang, without cache only
1683 # sometimes, just plain disable...
1684 my $lvm_no_io_uring = $scfg && $scfg->{type} eq 'lvm';
ec5d198e 1685
e31762f2
FE
1686 # io_uring causes problems when used with CIFS since kernel 5.15
1687 # Some discussion: https://www.spinics.net/lists/linux-cifs/msg26734.html
1688 my $cifs_no_io_uring = $scfg && $scfg->{type} eq 'cifs';
1689
b2ee900e 1690 if (!$drive->{aio}) {
e31762f2 1691 if ($io_uring && !$rbd_no_io_uring && !$lvm_no_io_uring && !$cifs_no_io_uring) {
6d5673c3
SR
1692 # io_uring supports all cache modes
1693 $opts .= ",aio=io_uring";
b2ee900e 1694 } else {
6d5673c3
SR
1695 # aio native works only with O_DIRECT
1696 if($cache_direct) {
1697 $opts .= ",aio=native";
1698 } else {
1699 $opts .= ",aio=threads";
1700 }
b2ee900e
WB
1701 }
1702 }
11490cf2 1703
6e47c3b4
WB
1704 if (!drive_is_cdrom($drive)) {
1705 my $detectzeroes;
7d4e30f3 1706 if (defined($drive->{detect_zeroes}) && !$drive->{detect_zeroes}) {
6e47c3b4
WB
1707 $detectzeroes = 'off';
1708 } elsif ($drive->{discard}) {
1709 $detectzeroes = $drive->{discard} eq 'on' ? 'unmap' : 'on';
1710 } else {
1711 # This used to be our default with discard not being specified:
1712 $detectzeroes = 'on';
1713 }
5921764c
SR
1714
1715 # note: 'detect-zeroes' works per blockdev and we want it to persist
1716 # after the alloc-track is removed, so put it on 'file' directly
1717 my $dz_param = $pbs_name ? "file.detect-zeroes" : "detect-zeroes";
1718 $opts .= ",$dz_param=$detectzeroes" if $detectzeroes;
6e47c3b4 1719 }
f1e05305 1720
5921764c
SR
1721 if ($pbs_name) {
1722 $opts .= ",backing=$pbs_name";
1723 $opts .= ",auto-remove=on";
1724 }
1725
1726 # my $file_param = $pbs_name ? "file.file.filename" : "file";
1727 my $file_param = "file";
1728 if ($pbs_name) {
1729 # non-rbd drivers require the underlying file to be a seperate block
1730 # node, so add a second .file indirection
1731 $file_param .= ".file" if !$is_rbd;
1732 $file_param .= ".filename";
1733 }
1734 my $pathinfo = $path ? "$file_param=$path," : '';
1e3baf05 1735
3ebfcc86 1736 return "${pathinfo}if=none,id=drive-$drive->{interface}$drive->{index}$opts";
1e3baf05
DM
1737}
1738
5921764c
SR
1739sub print_pbs_blockdev {
1740 my ($pbs_conf, $pbs_name) = @_;
1741 my $blockdev = "driver=pbs,node-name=$pbs_name,read-only=on";
1742 $blockdev .= ",repository=$pbs_conf->{repository}";
2dda626d 1743 $blockdev .= ",namespace=$pbs_conf->{namespace}" if $pbs_conf->{namespace};
5921764c
SR
1744 $blockdev .= ",snapshot=$pbs_conf->{snapshot}";
1745 $blockdev .= ",archive=$pbs_conf->{archive}";
1746 $blockdev .= ",keyfile=$pbs_conf->{keyfile}" if $pbs_conf->{keyfile};
1747 return $blockdev;
1748}
1749
cc4d6182 1750sub print_netdevice_full {
0c03a390 1751 my ($vmid, $conf, $net, $netid, $bridges, $use_old_bios_files, $arch, $machine_type, $machine_version) = @_;
cc4d6182 1752
cc4d6182
DA
1753 my $device = $net->{model};
1754 if ($net->{model} eq 'virtio') {
1755 $device = 'virtio-net-pci';
1756 };
1757
d559309f 1758 my $pciaddr = print_pci_addr("$netid", $bridges, $arch, $machine_type);
5e2068d2 1759 my $tmpstr = "$device,mac=$net->{macaddr},netdev=$netid$pciaddr,id=$netid";
a9410357 1760 if ($net->{queues} && $net->{queues} > 1 && $net->{model} eq 'virtio'){
4df98f2f
TL
1761 # Consider we have N queues, the number of vectors needed is 2 * N + 2, i.e., one per in
1762 # and out of each queue plus one config interrupt and control vector queue
a9410357
AD
1763 my $vectors = $net->{queues} * 2 + 2;
1764 $tmpstr .= ",vectors=$vectors,mq=on";
0c03a390
AD
1765 if (min_version($machine_version, 7, 1)) {
1766 $tmpstr .= ",packed=on";
1767 }
a9410357 1768 }
620d6b32
AD
1769
1770 if (min_version($machine_version, 7, 1) && $net->{model} eq 'virtio'){
1771 $tmpstr .= ",rx_queue_size=1024,tx_queue_size=1024";
1772 }
1773
cc4d6182 1774 $tmpstr .= ",bootindex=$net->{bootindex}" if $net->{bootindex} ;
ba9e1000 1775
0530177b
TL
1776 if (my $mtu = $net->{mtu}) {
1777 if ($net->{model} eq 'virtio' && $net->{bridge}) {
1778 my $bridge_mtu = PVE::Network::read_bridge_mtu($net->{bridge});
1779 if ($mtu == 1) {
1780 $mtu = $bridge_mtu;
1781 } elsif ($mtu < 576) {
1782 die "netdev $netid: MTU '$mtu' is smaller than the IP minimum MTU '576'\n";
1783 } elsif ($mtu > $bridge_mtu) {
1784 die "netdev $netid: MTU '$mtu' is bigger than the bridge MTU '$bridge_mtu'\n";
1785 }
1786 $tmpstr .= ",host_mtu=$mtu";
1787 } else {
1788 warn "WARN: netdev $netid: ignoring MTU '$mtu', not using VirtIO or no bridge configured.\n";
61a14cde 1789 }
61a14cde
AD
1790 }
1791
ba9e1000
DM
1792 if ($use_old_bios_files) {
1793 my $romfile;
1794 if ($device eq 'virtio-net-pci') {
1795 $romfile = 'pxe-virtio.rom';
1796 } elsif ($device eq 'e1000') {
1797 $romfile = 'pxe-e1000.rom';
e83dd50a
TL
1798 } elsif ($device eq 'e1000e') {
1799 $romfile = 'pxe-e1000e.rom';
ba9e1000
DM
1800 } elsif ($device eq 'ne2k') {
1801 $romfile = 'pxe-ne2k_pci.rom';
1802 } elsif ($device eq 'pcnet') {
1803 $romfile = 'pxe-pcnet.rom';
1804 } elsif ($device eq 'rtl8139') {
1805 $romfile = 'pxe-rtl8139.rom';
1806 }
1807 $tmpstr .= ",romfile=$romfile" if $romfile;
1808 }
1809
cc4d6182
DA
1810 return $tmpstr;
1811}
1812
1813sub print_netdev_full {
d559309f 1814 my ($vmid, $conf, $arch, $net, $netid, $hotplug) = @_;
cc4d6182
DA
1815
1816 my $i = '';
1817 if ($netid =~ m/^net(\d+)$/) {
1818 $i = int($1);
1819 }
1820
1821 die "got strange net id '$i'\n" if $i >= ${MAX_NETS};
1822
1823 my $ifname = "tap${vmid}i$i";
1824
1825 # kvm uses TUNSETIFF ioctl, and that limits ifname length
1826 die "interface name '$ifname' is too long (max 15 character)\n"
1827 if length($ifname) >= 16;
1828
1829 my $vhostparam = '';
6f0cb675 1830 if (is_native($arch)) {
db70021b 1831 $vhostparam = ',vhost=on' if kernel_has_vhost_net() && $net->{model} eq 'virtio';
6f0cb675 1832 }
cc4d6182
DA
1833
1834 my $vmname = $conf->{name} || "vm$vmid";
1835
a9410357 1836 my $netdev = "";
208ba94e 1837 my $script = $hotplug ? "pve-bridge-hotplug" : "pve-bridge";
a9410357 1838
cc4d6182 1839 if ($net->{bridge}) {
4df98f2f
TL
1840 $netdev = "type=tap,id=$netid,ifname=${ifname},script=/var/lib/qemu-server/$script"
1841 .",downscript=/var/lib/qemu-server/pve-bridgedown$vhostparam";
cc4d6182 1842 } else {
a9410357 1843 $netdev = "type=user,id=$netid,hostname=$vmname";
cc4d6182 1844 }
a9410357
AD
1845
1846 $netdev .= ",queues=$net->{queues}" if ($net->{queues} && $net->{model} eq 'virtio');
1847
1848 return $netdev;
cc4d6182 1849}
1e3baf05 1850
55655ebc
DC
1851my $vga_map = {
1852 'cirrus' => 'cirrus-vga',
1853 'std' => 'VGA',
1854 'vmware' => 'vmware-svga',
1855 'virtio' => 'virtio-vga',
6f070e39 1856 'virtio-gl' => 'virtio-vga-gl',
55655ebc
DC
1857};
1858
1859sub print_vga_device {
2ea5fb7e 1860 my ($conf, $vga, $arch, $machine_version, $machine, $id, $qxlnum, $bridges) = @_;
55655ebc
DC
1861
1862 my $type = $vga_map->{$vga->{type}};
86c9fafe 1863 if ($arch eq 'aarch64' && defined($type) && $type eq 'virtio-vga') {
d559309f
WB
1864 $type = 'virtio-gpu';
1865 }
55655ebc 1866 my $vgamem_mb = $vga->{memory};
6021c7a5
AL
1867
1868 my $max_outputs = '';
55655ebc
DC
1869 if ($qxlnum) {
1870 $type = $id ? 'qxl' : 'qxl-vga';
6021c7a5 1871
c5a4c92c 1872 if (!$conf->{ostype} || $conf->{ostype} =~ m/^(?:l\d\d)|(?:other)$/) {
6021c7a5 1873 # set max outputs so linux can have up to 4 qxl displays with one device
2ea5fb7e 1874 if (min_version($machine_version, 4, 1)) {
9e8976ea
TL
1875 $max_outputs = ",max_outputs=4";
1876 }
6021c7a5 1877 }
55655ebc 1878 }
6021c7a5 1879
55655ebc
DC
1880 die "no devicetype for $vga->{type}\n" if !$type;
1881
1882 my $memory = "";
1883 if ($vgamem_mb) {
6f070e39 1884 if ($vga->{type} =~ /^virtio/) {
55655ebc
DC
1885 my $bytes = PVE::Tools::convert_size($vgamem_mb, "mb" => "b");
1886 $memory = ",max_hostmem=$bytes";
1887 } elsif ($qxlnum) {
1888 # from https://www.spice-space.org/multiple-monitors.html
1889 $memory = ",vgamem_mb=$vga->{memory}";
1890 my $ram = $vgamem_mb * 4;
1891 my $vram = $vgamem_mb * 2;
1892 $memory .= ",ram_size_mb=$ram,vram_size_mb=$vram";
1893 } else {
1894 $memory = ",vgamem_mb=$vga->{memory}";
1895 }
1896 } elsif ($qxlnum && $id) {
1897 $memory = ",ram_size=67108864,vram_size=33554432";
1898 }
1899
789fe8e8
AL
1900 my $edidoff = "";
1901 if ($type eq 'VGA' && windows_version($conf->{ostype})) {
b5d32c6b 1902 $edidoff=",edid=off" if (!defined($conf->{bios}) || $conf->{bios} ne 'ovmf');
789fe8e8
AL
1903 }
1904
3392d6ca 1905 my $q35 = PVE::QemuServer::Machine::machine_type_is_q35($conf);
55655ebc
DC
1906 my $vgaid = "vga" . ($id // '');
1907 my $pciaddr;
1908 if ($q35 && $vgaid eq 'vga') {
daadd5a4 1909 # the first display uses pcie.0 bus on q35 machines
d559309f 1910 $pciaddr = print_pcie_addr($vgaid, $bridges, $arch, $machine);
55655ebc 1911 } else {
d559309f 1912 $pciaddr = print_pci_addr($vgaid, $bridges, $arch, $machine);
55655ebc
DC
1913 }
1914
9f979d9f 1915 if ($vga->{type} eq 'virtio-gl') {
8884a8bf
TL
1916 my $base = '/usr/lib/x86_64-linux-gnu/lib';
1917 die "missing libraries for '$vga->{type}' detected! Please install 'libgl1' and 'libegl1'\n"
1918 if !-e "${base}EGL.so.1" || !-e "${base}GL.so.1";
9f979d9f 1919
8884a8bf
TL
1920 die "no DRM render node detected (/dev/dri/renderD*), no GPU? - needed for '$vga->{type}' display\n"
1921 if !PVE::Tools::dir_glob_regex('/dev/dri/', "renderD.*");
9f979d9f
SI
1922 }
1923
789fe8e8 1924 return "$type,id=${vgaid}${memory}${max_outputs}${pciaddr}${edidoff}";
55655ebc
DC
1925}
1926
ffc0d8c7
WB
1927sub parse_number_sets {
1928 my ($set) = @_;
1929 my $res = [];
1930 foreach my $part (split(/;/, $set)) {
1931 if ($part =~ /^\s*(\d+)(?:-(\d+))?\s*$/) {
1932 die "invalid range: $part ($2 < $1)\n" if defined($2) && $2 < $1;
1933 push @$res, [ $1, $2 ];
2ed5d572 1934 } else {
ffc0d8c7 1935 die "invalid range: $part\n";
2ed5d572
AD
1936 }
1937 }
ffc0d8c7
WB
1938 return $res;
1939}
2ed5d572 1940
ffc0d8c7
WB
1941sub parse_numa {
1942 my ($data) = @_;
1943
4df98f2f 1944 my $res = parse_property_string($numa_fmt, $data);
ffc0d8c7
WB
1945 $res->{cpus} = parse_number_sets($res->{cpus}) if defined($res->{cpus});
1946 $res->{hostnodes} = parse_number_sets($res->{hostnodes}) if defined($res->{hostnodes});
2ed5d572
AD
1947 return $res;
1948}
1949
1e3baf05
DM
1950# netX: e1000=XX:XX:XX:XX:XX:XX,bridge=vmbr0,rate=<mbps>
1951sub parse_net {
4ddd2ca2 1952 my ($data, $disable_mac_autogen) = @_;
1e3baf05 1953
4df98f2f 1954 my $res = eval { parse_property_string($net_fmt, $data) };
cd9c34d1
WB
1955 if ($@) {
1956 warn $@;
d1c1af4b 1957 return;
1e3baf05 1958 }
4ddd2ca2 1959 if (!defined($res->{macaddr}) && !$disable_mac_autogen) {
b5b99790
WB
1960 my $dc = PVE::Cluster::cfs_read_file('datacenter.cfg');
1961 $res->{macaddr} = PVE::Tools::random_ether_addr($dc->{mac_prefix});
1962 }
0c9a7596
AD
1963 return $res;
1964}
1965
1966# ipconfigX ip=cidr,gw=ip,ip6=cidr,gw6=ip
1967sub parse_ipconfig {
1968 my ($data) = @_;
1969
4df98f2f 1970 my $res = eval { parse_property_string($ipconfig_fmt, $data) };
0c9a7596
AD
1971 if ($@) {
1972 warn $@;
d1c1af4b 1973 return;
0c9a7596
AD
1974 }
1975
1976 if ($res->{gw} && !$res->{ip}) {
1977 warn 'gateway specified without specifying an IP address';
d1c1af4b 1978 return;
0c9a7596
AD
1979 }
1980 if ($res->{gw6} && !$res->{ip6}) {
1981 warn 'IPv6 gateway specified without specifying an IPv6 address';
d1c1af4b 1982 return;
0c9a7596
AD
1983 }
1984 if ($res->{gw} && $res->{ip} eq 'dhcp') {
1985 warn 'gateway specified together with DHCP';
d1c1af4b 1986 return;
0c9a7596
AD
1987 }
1988 if ($res->{gw6} && $res->{ip6} !~ /^$IPV6RE/) {
1989 # gw6 + auto/dhcp
1990 warn "IPv6 gateway specified together with $res->{ip6} address";
d1c1af4b 1991 return;
0c9a7596
AD
1992 }
1993
1994 if (!$res->{ip} && !$res->{ip6}) {
1995 return { ip => 'dhcp', ip6 => 'dhcp' };
1996 }
1997
1e3baf05
DM
1998 return $res;
1999}
2000
2001sub print_net {
2002 my $net = shift;
2003
cd9c34d1 2004 return PVE::JSONSchema::print_property_string($net, $net_fmt);
1e3baf05
DM
2005}
2006
2007sub add_random_macs {
2008 my ($settings) = @_;
2009
2010 foreach my $opt (keys %$settings) {
2011 next if $opt !~ m/^net(\d+)$/;
2012 my $net = parse_net($settings->{$opt});
2013 next if !$net;
2014 $settings->{$opt} = print_net($net);
2015 }
2016}
2017
055d554d
DM
2018sub vm_is_volid_owner {
2019 my ($storecfg, $vmid, $volid) = @_;
2020
2021 if ($volid !~ m|^/|) {
2022 my ($path, $owner);
2023 eval { ($path, $owner) = PVE::Storage::path($storecfg, $volid); };
2024 if ($owner && ($owner == $vmid)) {
2025 return 1;
2026 }
2027 }
2028
d1c1af4b 2029 return;
055d554d
DM
2030}
2031
055d554d
DM
2032sub vmconfig_register_unused_drive {
2033 my ($storecfg, $vmid, $conf, $drive) = @_;
2034
2d9ddec5
WB
2035 if (drive_is_cloudinit($drive)) {
2036 eval { PVE::Storage::vdisk_free($storecfg, $drive->{file}) };
2037 warn $@ if $@;
95a5135d 2038 delete $conf->{cloudinit};
2d9ddec5 2039 } elsif (!drive_is_cdrom($drive)) {
055d554d
DM
2040 my $volid = $drive->{file};
2041 if (vm_is_volid_owner($storecfg, $vmid, $volid)) {
8793d495 2042 PVE::QemuConfig->add_unused_volume($conf, $volid, $vmid);
055d554d
DM
2043 }
2044 }
2045}
2046
1f30ac3a 2047# smbios: [manufacturer=str][,product=str][,version=str][,serial=str][,uuid=uuid][,sku=str][,family=str][,base64=bool]
ff6ffe20 2048my $smbios1_fmt = {
bd27e851
WB
2049 uuid => {
2050 type => 'string',
2051 pattern => '[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}',
2052 format_description => 'UUID',
52261945 2053 description => "Set SMBIOS1 UUID.",
bd27e851
WB
2054 optional => 1,
2055 },
2056 version => {
2057 type => 'string',
1f30ac3a
CE
2058 pattern => '[A-Za-z0-9+\/]+={0,2}',
2059 format_description => 'Base64 encoded string',
52261945 2060 description => "Set SMBIOS1 version.",
bd27e851
WB
2061 optional => 1,
2062 },
2063 serial => {
2064 type => 'string',
1f30ac3a
CE
2065 pattern => '[A-Za-z0-9+\/]+={0,2}',
2066 format_description => 'Base64 encoded string',
52261945 2067 description => "Set SMBIOS1 serial number.",
bd27e851
WB
2068 optional => 1,
2069 },
2070 manufacturer => {
2071 type => 'string',
1f30ac3a
CE
2072 pattern => '[A-Za-z0-9+\/]+={0,2}',
2073 format_description => 'Base64 encoded string',
52261945 2074 description => "Set SMBIOS1 manufacturer.",
bd27e851
WB
2075 optional => 1,
2076 },
2077 product => {
2078 type => 'string',
1f30ac3a
CE
2079 pattern => '[A-Za-z0-9+\/]+={0,2}',
2080 format_description => 'Base64 encoded string',
52261945 2081 description => "Set SMBIOS1 product ID.",
bd27e851
WB
2082 optional => 1,
2083 },
2084 sku => {
2085 type => 'string',
1f30ac3a
CE
2086 pattern => '[A-Za-z0-9+\/]+={0,2}',
2087 format_description => 'Base64 encoded string',
52261945 2088 description => "Set SMBIOS1 SKU string.",
bd27e851
WB
2089 optional => 1,
2090 },
2091 family => {
2092 type => 'string',
1f30ac3a
CE
2093 pattern => '[A-Za-z0-9+\/]+={0,2}',
2094 format_description => 'Base64 encoded string',
52261945 2095 description => "Set SMBIOS1 family string.",
bd27e851
WB
2096 optional => 1,
2097 },
1f30ac3a
CE
2098 base64 => {
2099 type => 'boolean',
2100 description => 'Flag to indicate that the SMBIOS values are base64 encoded',
2101 optional => 1,
2102 },
2796e7d5
DM
2103};
2104
2796e7d5
DM
2105sub parse_smbios1 {
2106 my ($data) = @_;
2107
4df98f2f 2108 my $res = eval { parse_property_string($smbios1_fmt, $data) };
bd27e851 2109 warn $@ if $@;
2796e7d5
DM
2110 return $res;
2111}
2112
cd11416f
DM
2113sub print_smbios1 {
2114 my ($smbios1) = @_;
ff6ffe20 2115 return PVE::JSONSchema::print_property_string($smbios1, $smbios1_fmt);
cd11416f
DM
2116}
2117
ff6ffe20 2118PVE::JSONSchema::register_format('pve-qm-smbios1', $smbios1_fmt);
2796e7d5 2119
0ea9541d
DM
2120sub parse_watchdog {
2121 my ($value) = @_;
2122
d1c1af4b 2123 return if !$value;
0ea9541d 2124
4df98f2f 2125 my $res = eval { parse_property_string($watchdog_fmt, $value) };
ec3582b5 2126 warn $@ if $@;
0ea9541d
DM
2127 return $res;
2128}
2129
9d66b397 2130sub parse_guest_agent {
a2af1bbe 2131 my ($conf) = @_;
9d66b397 2132
a2af1bbe 2133 return {} if !defined($conf->{agent});
9d66b397 2134
a2af1bbe 2135 my $res = eval { parse_property_string($agent_fmt, $conf->{agent}) };
9d66b397
SI
2136 warn $@ if $@;
2137
2138 # if the agent is disabled ignore the other potentially set properties
2139 return {} if !$res->{enabled};
2140 return $res;
2141}
2142
a2af1bbe
TL
2143sub get_qga_key {
2144 my ($conf, $key) = @_;
2145 return undef if !defined($conf->{agent});
2146
2147 my $agent = parse_guest_agent($conf);
2148 return $agent->{$key};
2149}
2150
55655ebc
DC
2151sub parse_vga {
2152 my ($value) = @_;
2153
2154 return {} if !$value;
4df98f2f 2155 my $res = eval { parse_property_string($vga_fmt, $value) };
55655ebc
DC
2156 warn $@ if $@;
2157 return $res;
2158}
2159
2cf61f33
SR
2160sub parse_rng {
2161 my ($value) = @_;
2162
d1c1af4b 2163 return if !$value;
2cf61f33 2164
4df98f2f 2165 my $res = eval { parse_property_string($rng_fmt, $value) };
2cf61f33
SR
2166 warn $@ if $@;
2167 return $res;
2168}
2169
26b443c8
TL
2170sub parse_meta_info {
2171 my ($value) = @_;
2172
2173 return if !$value;
2174
2175 my $res = eval { parse_property_string($meta_info_fmt, $value) };
2176 warn $@ if $@;
2177 return $res;
2178}
2179
2180sub new_meta_info_string {
2181 my () = @_; # for now do not allow to override any value
2182
2183 return PVE::JSONSchema::print_property_string(
2184 {
af2a1a1c 2185 'creation-qemu' => kvm_user_version(),
26b443c8
TL
2186 ctime => "". int(time()),
2187 },
2188 $meta_info_fmt
2189 );
2190}
2191
cc181036
TL
2192sub qemu_created_version_fixups {
2193 my ($conf, $forcemachine, $kvmver) = @_;
2194
2195 my $meta = parse_meta_info($conf->{meta}) // {};
2196 my $forced_vers = PVE::QemuServer::Machine::extract_version($forcemachine);
2197
2198 # check if we need to apply some handling for VMs that always use the latest machine version but
2199 # had a machine version transition happen that affected HW such that, e.g., an OS config change
2200 # would be required (we do not want to pin machine version for non-windows OS type)
2201 if (
2202 (!defined($conf->{machine}) || $conf->{machine} =~ m/^(?:pc|q35|virt)$/) # non-versioned machine
2203 && (!defined($meta->{'creation-qemu'}) || !min_version($meta->{'creation-qemu'}, 6, 1)) # created before 6.1
2204 && (!$forced_vers || min_version($forced_vers, 6, 1)) # handle snapshot-rollback/migrations
2205 && min_version($kvmver, 6, 1) # only need to apply the change since 6.1
2206 ) {
2207 my $q35 = PVE::QemuServer::Machine::machine_type_is_q35($conf);
2208 if ($q35 && $conf->{ostype} && $conf->{ostype} eq 'l26') {
2209 # this changed to default-on in Q 6.1 for q35 machines, it will mess with PCI slot view
2210 # and thus with the predictable interface naming of systemd
2211 return ['-global', 'ICH9-LPC.acpi-pci-hotplug-with-bridge-support=off'];
2212 }
2213 }
2214 return;
2215}
2216
1e3baf05
DM
2217PVE::JSONSchema::register_format('pve-qm-usb-device', \&verify_usb_device);
2218sub verify_usb_device {
2219 my ($value, $noerr) = @_;
2220
2221 return $value if parse_usb_device($value);
2222
d1c1af4b 2223 return if $noerr;
19672434 2224
1e3baf05
DM
2225 die "unable to parse usb device\n";
2226}
2227
1e3baf05
DM
2228# add JSON properties for create and set function
2229sub json_config_properties {
c1accf9d 2230 my ($prop, $with_disk_alloc) = @_;
1e3baf05 2231
5a08fb9c
TL
2232 my $skip_json_config_opts = {
2233 parent => 1,
2234 snaptime => 1,
2235 vmstate => 1,
2236 runningmachine => 1,
2237 runningcpu => 1,
26b443c8 2238 meta => 1,
5a08fb9c
TL
2239 };
2240
1e3baf05 2241 foreach my $opt (keys %$confdesc) {
5a08fb9c 2242 next if $skip_json_config_opts->{$opt};
c1accf9d
FE
2243
2244 if ($with_disk_alloc && is_valid_drivename($opt)) {
2245 $prop->{$opt} = $PVE::QemuServer::Drive::drivedesc_hash_with_alloc->{$opt};
2246 } else {
2247 $prop->{$opt} = $confdesc->{$opt};
2248 }
1e3baf05
DM
2249 }
2250
2251 return $prop;
2252}
2253
39051ac0
FE
2254# Properties that we can read from an OVF file
2255sub json_ovf_properties {
2256 my $prop = {};
2257
2258 for my $device (PVE::QemuServer::Drive::valid_drive_names()) {
2259 $prop->{$device} = {
2260 type => 'string',
2261 format => 'pve-volume-id-or-absolute-path',
2262 description => "Disk image that gets imported to $device",
2263 optional => 1,
2264 };
2265 }
2266
2267 $prop->{cores} = {
2268 type => 'integer',
2269 description => "The number of CPU cores.",
2270 optional => 1,
2271 };
2272 $prop->{memory} = {
2273 type => 'integer',
2274 description => "Amount of RAM for the VM in MB.",
2275 optional => 1,
2276 };
2277 $prop->{name} = {
2278 type => 'string',
2279 description => "Name of the VM.",
2280 optional => 1,
2281 };
2282
2283 return $prop;
2284}
2285
d41121fd
DM
2286# return copy of $confdesc_cloudinit to generate documentation
2287sub cloudinit_config_properties {
2288
2289 return dclone($confdesc_cloudinit);
2290}
2291
1e3baf05
DM
2292sub check_type {
2293 my ($key, $value) = @_;
2294
2295 die "unknown setting '$key'\n" if !$confdesc->{$key};
2296
2297 my $type = $confdesc->{$key}->{type};
2298
6b64503e 2299 if (!defined($value)) {
1e3baf05
DM
2300 die "got undefined value\n";
2301 }
2302
2303 if ($value =~ m/[\n\r]/) {
2304 die "property contains a line feed\n";
2305 }
2306
2307 if ($type eq 'boolean') {
19672434
DM
2308 return 1 if ($value eq '1') || ($value =~ m/^(on|yes|true)$/i);
2309 return 0 if ($value eq '0') || ($value =~ m/^(off|no|false)$/i);
2310 die "type check ('boolean') failed - got '$value'\n";
1e3baf05
DM
2311 } elsif ($type eq 'integer') {
2312 return int($1) if $value =~ m/^(\d+)$/;
2313 die "type check ('integer') failed - got '$value'\n";
04432191
AD
2314 } elsif ($type eq 'number') {
2315 return $value if $value =~ m/^(\d+)(\.\d+)?$/;
2316 die "type check ('number') failed - got '$value'\n";
1e3baf05
DM
2317 } elsif ($type eq 'string') {
2318 if (my $fmt = $confdesc->{$key}->{format}) {
1e3baf05 2319 PVE::JSONSchema::check_format($fmt, $value);
19672434
DM
2320 return $value;
2321 }
1e3baf05 2322 $value =~ s/^\"(.*)\"$/$1/;
19672434 2323 return $value;
1e3baf05
DM
2324 } else {
2325 die "internal error"
2326 }
2327}
2328
1e3baf05 2329sub destroy_vm {
75854662 2330 my ($storecfg, $vmid, $skiplock, $replacement_conf, $purge_unreferenced) = @_;
1e3baf05 2331
ffda963f 2332 my $conf = PVE::QemuConfig->load_config($vmid);
1e3baf05 2333
ffda963f 2334 PVE::QemuConfig->check_lock($conf) if !$skiplock;
1e3baf05 2335
5e67a2d2
DC
2336 if ($conf->{template}) {
2337 # check if any base image is still used by a linked clone
3ab0f925 2338 PVE::QemuConfig->foreach_volume_full($conf, { include_unused => 1 }, sub {
5e67a2d2 2339 my ($ds, $drive) = @_;
5e67a2d2
DC
2340 return if drive_is_cdrom($drive);
2341
2342 my $volid = $drive->{file};
5e67a2d2
DC
2343 return if !$volid || $volid =~ m|^/|;
2344
2345 die "base volume '$volid' is still in use by linked cloned\n"
2346 if PVE::Storage::volume_is_base_and_used($storecfg, $volid);
2347
2348 });
2349 }
2350
3e07c6d5 2351 my $volids = {};
ba1a1984 2352 my $remove_owned_drive = sub {
1e3baf05 2353 my ($ds, $drive) = @_;
9c52f5ed 2354 return if drive_is_cdrom($drive, 1);
1e3baf05
DM
2355
2356 my $volid = $drive->{file};
ff1a2432 2357 return if !$volid || $volid =~ m|^/|;
3e07c6d5 2358 return if $volids->{$volid};
1e3baf05 2359
6b64503e 2360 my ($path, $owner) = PVE::Storage::path($storecfg, $volid);
ff1a2432 2361 return if !$path || !$owner || ($owner != $vmid);
1e3baf05 2362
3e07c6d5 2363 $volids->{$volid} = 1;
a2f50f01 2364 eval { PVE::Storage::vdisk_free($storecfg, $volid) };
31b52247 2365 warn "Could not remove disk '$volid', check manually: $@" if $@;
ba1a1984
FE
2366 };
2367
2368 # only remove disks owned by this VM (referenced in the config)
2369 my $include_opts = {
2370 include_unused => 1,
2371 extra_keys => ['vmstate'],
2372 };
2373 PVE::QemuConfig->foreach_volume_full($conf, $include_opts, $remove_owned_drive);
2374
2375 for my $snap (values %{$conf->{snapshots}}) {
2376 next if !defined($snap->{vmstate});
2377 my $drive = PVE::QemuConfig->parse_volume('vmstate', $snap->{vmstate}, 1);
2378 next if !defined($drive);
2379 $remove_owned_drive->('vmstate', $drive);
2380 }
19672434 2381
3e07c6d5
FG
2382 PVE::QemuConfig->foreach_volume_full($conf->{pending}, $include_opts, $remove_owned_drive);
2383
75854662 2384 if ($purge_unreferenced) { # also remove unreferenced disk
d0ff75d9 2385 my $vmdisks = PVE::Storage::vdisk_list($storecfg, undef, $vmid, undef, 'images');
75854662
TL
2386 PVE::Storage::foreach_volid($vmdisks, sub {
2387 my ($volid, $sid, $volname, $d) = @_;
2388 eval { PVE::Storage::vdisk_free($storecfg, $volid) };
2389 warn $@ if $@;
2390 });
2391 }
dfda979e 2392
b04ea584 2393 if (defined $replacement_conf) {
8baf8bc7 2394 PVE::QemuConfig->write_config($vmid, $replacement_conf);
dfda979e
DJ
2395 } else {
2396 PVE::QemuConfig->destroy_config($vmid);
2397 }
1e3baf05
DM
2398}
2399
1e3baf05 2400sub parse_vm_config {
ad5812d8 2401 my ($filename, $raw, $strict) = @_;
1e3baf05 2402
d1c1af4b 2403 return if !defined($raw);
1e3baf05 2404
554ac7e7 2405 my $res = {
fc1ddcdc 2406 digest => Digest::SHA::sha1_hex($raw),
0d18dcfc 2407 snapshots => {},
0d732d16 2408 pending => {},
95a5135d 2409 cloudinit => {},
554ac7e7 2410 };
1e3baf05 2411
ad5812d8
FG
2412 my $handle_error = sub {
2413 my ($msg) = @_;
2414
2415 if ($strict) {
2416 die $msg;
2417 } else {
2418 warn $msg;
2419 }
2420 };
2421
19672434 2422 $filename =~ m|/qemu-server/(\d+)\.conf$|
1e3baf05
DM
2423 || die "got strange filename '$filename'";
2424
2425 my $vmid = $1;
2426
0d18dcfc 2427 my $conf = $res;
b0ec896e 2428 my $descr;
e297c490 2429 my $section = '';
0581fe4f 2430
0d18dcfc
DM
2431 my @lines = split(/\n/, $raw);
2432 foreach my $line (@lines) {
1e3baf05 2433 next if $line =~ m/^\s*$/;
be190583 2434
eab09f4e 2435 if ($line =~ m/^\[PENDING\]\s*$/i) {
e297c490 2436 $section = 'pending';
b0ec896e
DM
2437 if (defined($descr)) {
2438 $descr =~ s/\s+$//;
2439 $conf->{description} = $descr;
2440 }
2441 $descr = undef;
e297c490 2442 $conf = $res->{$section} = {};
eab09f4e 2443 next;
95a5135d
AD
2444 } elsif ($line =~ m/^\[special:cloudinit\]\s*$/i) {
2445 $section = 'cloudinit';
2446 $descr = undef;
2447 $conf = $res->{$section} = {};
2448 next;
eab09f4e 2449
0d732d16 2450 } elsif ($line =~ m/^\[([a-z][a-z0-9_\-]+)\]\s*$/i) {
e297c490 2451 $section = $1;
b0ec896e
DM
2452 if (defined($descr)) {
2453 $descr =~ s/\s+$//;
2454 $conf->{description} = $descr;
2455 }
2456 $descr = undef;
e297c490 2457 $conf = $res->{snapshots}->{$section} = {};
0d18dcfc
DM
2458 next;
2459 }
1e3baf05 2460
d1e7b922 2461 if ($line =~ m/^\#(.*)$/) {
b0ec896e 2462 $descr = '' if !defined($descr);
0581fe4f
DM
2463 $descr .= PVE::Tools::decode_text($1) . "\n";
2464 next;
2465 }
2466
1e3baf05 2467 if ($line =~ m/^(description):\s*(.*\S)\s*$/) {
b0ec896e 2468 $descr = '' if !defined($descr);
0581fe4f 2469 $descr .= PVE::Tools::decode_text($2);
0d18dcfc
DM
2470 } elsif ($line =~ m/snapstate:\s*(prepare|delete)\s*$/) {
2471 $conf->{snapstate} = $1;
1e3baf05
DM
2472 } elsif ($line =~ m/^(args):\s*(.*\S)\s*$/) {
2473 my $key = $1;
2474 my $value = $2;
0d18dcfc 2475 $conf->{$key} = $value;
ef824322 2476 } elsif ($line =~ m/^delete:\s*(.*\S)\s*$/) {
e297c490 2477 my $value = $1;
ef824322
DM
2478 if ($section eq 'pending') {
2479 $conf->{delete} = $value; # we parse this later
2480 } else {
ad5812d8 2481 $handle_error->("vm $vmid - property 'delete' is only allowed in [PENDING]\n");
eab09f4e 2482 }
15cf7698 2483 } elsif ($line =~ m/^([a-z][a-z_]*\d*):\s*(.+?)\s*$/) {
1e3baf05
DM
2484 my $key = $1;
2485 my $value = $2;
2486 eval { $value = check_type($key, $value); };
2487 if ($@) {
ad5812d8 2488 $handle_error->("vm $vmid - unable to parse value of '$key' - $@");
1e3baf05 2489 } else {
b799312f 2490 $key = 'ide2' if $key eq 'cdrom';
1e3baf05 2491 my $fmt = $confdesc->{$key}->{format};
b799312f 2492 if ($fmt && $fmt =~ /^pve-qm-(?:ide|scsi|virtio|sata)$/) {
1e3baf05
DM
2493 my $v = parse_drive($key, $value);
2494 if (my $volid = filename_to_volume_id($vmid, $v->{file}, $v->{media})) {
2495 $v->{file} = $volid;
71c58bb7 2496 $value = print_drive($v);
1e3baf05 2497 } else {
ad5812d8 2498 $handle_error->("vm $vmid - unable to parse value of '$key'\n");
1e3baf05
DM
2499 next;
2500 }
2501 }
2502
b799312f 2503 $conf->{$key} = $value;
1e3baf05 2504 }
f8d2a1ce 2505 } else {
ad5812d8 2506 $handle_error->("vm $vmid - unable to parse config: $line\n");
1e3baf05
DM
2507 }
2508 }
2509
b0ec896e
DM
2510 if (defined($descr)) {
2511 $descr =~ s/\s+$//;
2512 $conf->{description} = $descr;
2513 }
0d18dcfc 2514 delete $res->{snapstate}; # just to be sure
1e3baf05
DM
2515
2516 return $res;
2517}
2518
1858638f
DM
2519sub write_vm_config {
2520 my ($filename, $conf) = @_;
1e3baf05 2521
0d18dcfc
DM
2522 delete $conf->{snapstate}; # just to be sure
2523
1858638f
DM
2524 if ($conf->{cdrom}) {
2525 die "option ide2 conflicts with cdrom\n" if $conf->{ide2};
2526 $conf->{ide2} = $conf->{cdrom};
2527 delete $conf->{cdrom};
2528 }
1e3baf05
DM
2529
2530 # we do not use 'smp' any longer
1858638f
DM
2531 if ($conf->{sockets}) {
2532 delete $conf->{smp};
2533 } elsif ($conf->{smp}) {
2534 $conf->{sockets} = $conf->{smp};
2535 delete $conf->{cores};
2536 delete $conf->{smp};
1e3baf05
DM
2537 }
2538
ee2f90b1 2539 my $used_volids = {};
0d18dcfc 2540
ee2f90b1 2541 my $cleanup_config = sub {
ef824322 2542 my ($cref, $pending, $snapname) = @_;
1858638f 2543
ee2f90b1
DM
2544 foreach my $key (keys %$cref) {
2545 next if $key eq 'digest' || $key eq 'description' || $key eq 'snapshots' ||
95a5135d 2546 $key eq 'snapstate' || $key eq 'pending' || $key eq 'cloudinit';
ee2f90b1 2547 my $value = $cref->{$key};
ef824322
DM
2548 if ($key eq 'delete') {
2549 die "propertry 'delete' is only allowed in [PENDING]\n"
2550 if !$pending;
2551 # fixme: check syntax?
2552 next;
2553 }
ee2f90b1
DM
2554 eval { $value = check_type($key, $value); };
2555 die "unable to parse value of '$key' - $@" if $@;
1858638f 2556
ee2f90b1
DM
2557 $cref->{$key} = $value;
2558
74479ee9 2559 if (!$snapname && is_valid_drivename($key)) {
ed221350 2560 my $drive = parse_drive($key, $value);
ee2f90b1
DM
2561 $used_volids->{$drive->{file}} = 1 if $drive && $drive->{file};
2562 }
1e3baf05 2563 }
ee2f90b1
DM
2564 };
2565
2566 &$cleanup_config($conf);
ef824322
DM
2567
2568 &$cleanup_config($conf->{pending}, 1);
2569
95a5135d
AD
2570 &$cleanup_config($conf->{cloudinit});
2571
ee2f90b1 2572 foreach my $snapname (keys %{$conf->{snapshots}}) {
15c6e277 2573 die "internal error: snapshot name '$snapname' is forbidden" if lc($snapname) eq 'pending';
ef824322 2574 &$cleanup_config($conf->{snapshots}->{$snapname}, undef, $snapname);
1e3baf05
DM
2575 }
2576
1858638f
DM
2577 # remove 'unusedX' settings if we re-add a volume
2578 foreach my $key (keys %$conf) {
2579 my $value = $conf->{$key};
ee2f90b1 2580 if ($key =~ m/^unused/ && $used_volids->{$value}) {
1858638f 2581 delete $conf->{$key};
1e3baf05 2582 }
1858638f 2583 }
be190583 2584
0d18dcfc 2585 my $generate_raw_config = sub {
b0ec896e 2586 my ($conf, $pending) = @_;
0581fe4f 2587
0d18dcfc
DM
2588 my $raw = '';
2589
2590 # add description as comment to top of file
b0ec896e
DM
2591 if (defined(my $descr = $conf->{description})) {
2592 if ($descr) {
2593 foreach my $cl (split(/\n/, $descr)) {
2594 $raw .= '#' . PVE::Tools::encode_text($cl) . "\n";
2595 }
2596 } else {
2597 $raw .= "#\n" if $pending;
2598 }
0d18dcfc
DM
2599 }
2600
2601 foreach my $key (sort keys %$conf) {
95a5135d 2602 next if $key =~ /^(digest|description|pending|cloudinit|snapshots)$/;
0d18dcfc
DM
2603 $raw .= "$key: $conf->{$key}\n";
2604 }
2605 return $raw;
2606 };
0581fe4f 2607
0d18dcfc 2608 my $raw = &$generate_raw_config($conf);
ef824322
DM
2609
2610 if (scalar(keys %{$conf->{pending}})){
2611 $raw .= "\n[PENDING]\n";
b0ec896e 2612 $raw .= &$generate_raw_config($conf->{pending}, 1);
ef824322
DM
2613 }
2614
95a5135d
AD
2615 if (scalar(keys %{$conf->{cloudinit}})){
2616 $raw .= "\n[special:cloudinit]\n";
2617 $raw .= &$generate_raw_config($conf->{cloudinit});
2618 }
2619
0d18dcfc
DM
2620 foreach my $snapname (sort keys %{$conf->{snapshots}}) {
2621 $raw .= "\n[$snapname]\n";
2622 $raw .= &$generate_raw_config($conf->{snapshots}->{$snapname});
1858638f 2623 }
1e3baf05 2624
1858638f
DM
2625 return $raw;
2626}
1e3baf05 2627
19672434 2628sub load_defaults {
1e3baf05
DM
2629
2630 my $res = {};
2631
2632 # we use static defaults from our JSON schema configuration
2633 foreach my $key (keys %$confdesc) {
2634 if (defined(my $default = $confdesc->{$key}->{default})) {
2635 $res->{$key} = $default;
2636 }
2637 }
19672434 2638
1e3baf05
DM
2639 return $res;
2640}
2641
2642sub config_list {
2643 my $vmlist = PVE::Cluster::get_vmlist();
2644 my $res = {};
2645 return $res if !$vmlist || !$vmlist->{ids};
2646 my $ids = $vmlist->{ids};
38277afc 2647 my $nodename = nodename();
1e3baf05 2648
1e3baf05
DM
2649 foreach my $vmid (keys %$ids) {
2650 my $d = $ids->{$vmid};
2651 next if !$d->{node} || $d->{node} ne $nodename;
5ee957cc 2652 next if !$d->{type} || $d->{type} ne 'qemu';
1e3baf05
DM
2653 $res->{$vmid}->{exists} = 1;
2654 }
2655 return $res;
2656}
2657
64e13401
DM
2658# test if VM uses local resources (to prevent migration)
2659sub check_local_resources {
2660 my ($conf, $noerr) = @_;
2661
ca6abacf 2662 my @loc_res = ();
19672434 2663
ca6abacf
TM
2664 push @loc_res, "hostusb" if $conf->{hostusb}; # old syntax
2665 push @loc_res, "hostpci" if $conf->{hostpci}; # old syntax
64e13401 2666
ca6abacf 2667 push @loc_res, "ivshmem" if $conf->{ivshmem};
6dbcb073 2668
0d29ab3b 2669 foreach my $k (keys %$conf) {
a9ce7583 2670 next if $k =~ m/^usb/ && ($conf->{$k} =~ m/^spice(?![^,])/);
d44712fc
EK
2671 # sockets are safe: they will recreated be on the target side post-migrate
2672 next if $k =~ m/^serial/ && ($conf->{$k} eq 'socket');
ca6abacf 2673 push @loc_res, $k if $k =~ m/^(usb|hostpci|serial|parallel)\d+$/;
64e13401
DM
2674 }
2675
ca6abacf 2676 die "VM uses local resources\n" if scalar @loc_res && !$noerr;
64e13401 2677
ca6abacf 2678 return \@loc_res;
64e13401
DM
2679}
2680
719893a9 2681# check if used storages are available on all nodes (use by migrate)
47152e2e
DM
2682sub check_storage_availability {
2683 my ($storecfg, $conf, $node) = @_;
2684
912792e2 2685 PVE::QemuConfig->foreach_volume($conf, sub {
47152e2e
DM
2686 my ($ds, $drive) = @_;
2687
2688 my $volid = $drive->{file};
2689 return if !$volid;
2690
2691 my ($sid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
2692 return if !$sid;
2693
2694 # check if storage is available on both nodes
0d2db084
FE
2695 my $scfg = PVE::Storage::storage_check_enabled($storecfg, $sid);
2696 PVE::Storage::storage_check_enabled($storecfg, $sid, $node);
24b84b47 2697
3148f0b0
TL
2698 my ($vtype) = PVE::Storage::parse_volname($storecfg, $volid);
2699
2700 die "$volid: content type '$vtype' is not available on storage '$sid'\n"
2701 if !$scfg->{content}->{$vtype};
47152e2e
DM
2702 });
2703}
2704
719893a9
DM
2705# list nodes where all VM images are available (used by has_feature API)
2706sub shared_nodes {
2707 my ($conf, $storecfg) = @_;
2708
2709 my $nodelist = PVE::Cluster::get_nodelist();
2710 my $nodehash = { map { $_ => 1 } @$nodelist };
38277afc 2711 my $nodename = nodename();
be190583 2712
912792e2 2713 PVE::QemuConfig->foreach_volume($conf, sub {
719893a9
DM
2714 my ($ds, $drive) = @_;
2715
2716 my $volid = $drive->{file};
2717 return if !$volid;
2718
2719 my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
2720 if ($storeid) {
2721 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
2722 if ($scfg->{disable}) {
2723 $nodehash = {};
2724 } elsif (my $avail = $scfg->{nodes}) {
2725 foreach my $node (keys %$nodehash) {
2726 delete $nodehash->{$node} if !$avail->{$node};
2727 }
2728 } elsif (!$scfg->{shared}) {
2729 foreach my $node (keys %$nodehash) {
2730 delete $nodehash->{$node} if $node ne $nodename
2731 }
2732 }
2733 }
2734 });
2735
2736 return $nodehash
2737}
2738
f25852c2
TM
2739sub check_local_storage_availability {
2740 my ($conf, $storecfg) = @_;
2741
2742 my $nodelist = PVE::Cluster::get_nodelist();
2743 my $nodehash = { map { $_ => {} } @$nodelist };
2744
912792e2 2745 PVE::QemuConfig->foreach_volume($conf, sub {
f25852c2
TM
2746 my ($ds, $drive) = @_;
2747
2748 my $volid = $drive->{file};
2749 return if !$volid;
2750
2751 my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
2752 if ($storeid) {
2753 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
2754
2755 if ($scfg->{disable}) {
2756 foreach my $node (keys %$nodehash) {
32075a2c 2757 $nodehash->{$node}->{unavailable_storages}->{$storeid} = 1;
f25852c2
TM
2758 }
2759 } elsif (my $avail = $scfg->{nodes}) {
2760 foreach my $node (keys %$nodehash) {
2761 if (!$avail->{$node}) {
32075a2c 2762 $nodehash->{$node}->{unavailable_storages}->{$storeid} = 1;
f25852c2
TM
2763 }
2764 }
2765 }
2766 }
2767 });
2768
32075a2c
TL
2769 foreach my $node (values %$nodehash) {
2770 if (my $unavail = $node->{unavailable_storages}) {
2771 $node->{unavailable_storages} = [ sort keys %$unavail ];
2772 }
2773 }
2774
f25852c2
TM
2775 return $nodehash
2776}
2777
babf613a 2778# Compat only, use assert_config_exists_on_node and vm_running_locally where possible
1e3baf05 2779sub check_running {
7e8dcf2c 2780 my ($vmid, $nocheck, $node) = @_;
1e3baf05 2781
babf613a
SR
2782 PVE::QemuConfig::assert_config_exists_on_node($vmid, $node) if !$nocheck;
2783 return PVE::QemuServer::Helpers::vm_running_locally($vmid);
1e3baf05
DM
2784}
2785
2786sub vzlist {
19672434 2787
1e3baf05
DM
2788 my $vzlist = config_list();
2789
d036e418 2790 my $fd = IO::Dir->new($PVE::QemuServer::Helpers::var_run_tmpdir) || return $vzlist;
1e3baf05 2791
19672434 2792 while (defined(my $de = $fd->read)) {
1e3baf05
DM
2793 next if $de !~ m/^(\d+)\.pid$/;
2794 my $vmid = $1;
6b64503e
DM
2795 next if !defined($vzlist->{$vmid});
2796 if (my $pid = check_running($vmid)) {
1e3baf05
DM
2797 $vzlist->{$vmid}->{pid} = $pid;
2798 }
2799 }
2800
2801 return $vzlist;
2802}
2803
b1a70cab
DM
2804our $vmstatus_return_properties = {
2805 vmid => get_standard_option('pve-vmid'),
2806 status => {
2807 description => "Qemu process status.",
2808 type => 'string',
2809 enum => ['stopped', 'running'],
2810 },
2811 maxmem => {
2812 description => "Maximum memory in bytes.",
2813 type => 'integer',
2814 optional => 1,
2815 renderer => 'bytes',
2816 },
2817 maxdisk => {
2818 description => "Root disk size in bytes.",
2819 type => 'integer',
2820 optional => 1,
2821 renderer => 'bytes',
2822 },
2823 name => {
2824 description => "VM name.",
2825 type => 'string',
2826 optional => 1,
2827 },
2828 qmpstatus => {
2829 description => "Qemu QMP agent status.",
2830 type => 'string',
2831 optional => 1,
2832 },
2833 pid => {
2834 description => "PID of running qemu process.",
2835 type => 'integer',
2836 optional => 1,
2837 },
2838 uptime => {
2839 description => "Uptime.",
2840 type => 'integer',
2841 optional => 1,
2842 renderer => 'duration',
2843 },
2844 cpus => {
2845 description => "Maximum usable CPUs.",
2846 type => 'number',
2847 optional => 1,
2848 },
e6ed61b4 2849 lock => {
11efdfa5 2850 description => "The current config lock, if any.",
e6ed61b4
DC
2851 type => 'string',
2852 optional => 1,
b8e7068a
DC
2853 },
2854 tags => {
2855 description => "The current configured tags, if any",
2856 type => 'string',
2857 optional => 1,
2858 },
949112c3
FE
2859 'running-machine' => {
2860 description => "The currently running machine type (if running).",
2861 type => 'string',
2862 optional => 1,
2863 },
2864 'running-qemu' => {
2865 description => "The currently running QEMU version (if running).",
2866 type => 'string',
2867 optional => 1,
2868 },
b1a70cab
DM
2869};
2870
1e3baf05
DM
2871my $last_proc_pid_stat;
2872
03a33f30
DM
2873# get VM status information
2874# This must be fast and should not block ($full == false)
2875# We only query KVM using QMP if $full == true (this can be slow)
1e3baf05 2876sub vmstatus {
03a33f30 2877 my ($opt_vmid, $full) = @_;
1e3baf05
DM
2878
2879 my $res = {};
2880
19672434 2881 my $storecfg = PVE::Storage::config();
1e3baf05
DM
2882
2883 my $list = vzlist();
3618ee99
EK
2884 my $defaults = load_defaults();
2885
694fcad4 2886 my ($uptime) = PVE::ProcFSTools::read_proc_uptime(1);
1e3baf05 2887
ae4915a2
DM
2888 my $cpucount = $cpuinfo->{cpus} || 1;
2889
1e3baf05
DM
2890 foreach my $vmid (keys %$list) {
2891 next if $opt_vmid && ($vmid ne $opt_vmid);
2892
9f78b695 2893 my $conf = PVE::QemuConfig->load_config($vmid);
1e3baf05 2894
ad2cad72 2895 my $d = { vmid => int($vmid) };
8a0addab 2896 $d->{pid} = int($list->{$vmid}->{pid}) if $list->{$vmid}->{pid};
1e3baf05
DM
2897
2898 # fixme: better status?
2899 $d->{status} = $list->{$vmid}->{pid} ? 'running' : 'stopped';
2900
776c5f50 2901 my $size = PVE::QemuServer::Drive::bootdisk_size($storecfg, $conf);
af990afe
DM
2902 if (defined($size)) {
2903 $d->{disk} = 0; # no info available
1e3baf05
DM
2904 $d->{maxdisk} = $size;
2905 } else {
2906 $d->{disk} = 0;
2907 $d->{maxdisk} = 0;
2908 }
2909
3618ee99
EK
2910 $d->{cpus} = ($conf->{sockets} || $defaults->{sockets})
2911 * ($conf->{cores} || $defaults->{cores});
ae4915a2 2912 $d->{cpus} = $cpucount if $d->{cpus} > $cpucount;
d7c8364b 2913 $d->{cpus} = $conf->{vcpus} if $conf->{vcpus};
ae4915a2 2914
1e3baf05 2915 $d->{name} = $conf->{name} || "VM $vmid";
3618ee99
EK
2916 $d->{maxmem} = $conf->{memory} ? $conf->{memory}*(1024*1024)
2917 : $defaults->{memory}*(1024*1024);
1e3baf05 2918
8b1accf7 2919 if ($conf->{balloon}) {
4bdb0514 2920 $d->{balloon_min} = $conf->{balloon}*(1024*1024);
3618ee99
EK
2921 $d->{shares} = defined($conf->{shares}) ? $conf->{shares}
2922 : $defaults->{shares};
8b1accf7
DM
2923 }
2924
1e3baf05
DM
2925 $d->{uptime} = 0;
2926 $d->{cpu} = 0;
1e3baf05
DM
2927 $d->{mem} = 0;
2928
2929 $d->{netout} = 0;
2930 $d->{netin} = 0;
2931
2932 $d->{diskread} = 0;
2933 $d->{diskwrite} = 0;
2934
75a2a423 2935 $d->{template} = 1 if PVE::QemuConfig->is_template($conf);
4d8c851b 2936
8107b378 2937 $d->{serial} = 1 if conf_has_serial($conf);
e6ed61b4 2938 $d->{lock} = $conf->{lock} if $conf->{lock};
b8e7068a 2939 $d->{tags} = $conf->{tags} if defined($conf->{tags});
8107b378 2940
1e3baf05
DM
2941 $res->{$vmid} = $d;
2942 }
2943
2944 my $netdev = PVE::ProcFSTools::read_proc_net_dev();
2945 foreach my $dev (keys %$netdev) {
2946 next if $dev !~ m/^tap([1-9]\d*)i/;
2947 my $vmid = $1;
2948 my $d = $res->{$vmid};
2949 next if !$d;
19672434 2950
1e3baf05
DM
2951 $d->{netout} += $netdev->{$dev}->{receive};
2952 $d->{netin} += $netdev->{$dev}->{transmit};
604ea644
AD
2953
2954 if ($full) {
ad2cad72
FE
2955 $d->{nics}->{$dev}->{netout} = int($netdev->{$dev}->{receive});
2956 $d->{nics}->{$dev}->{netin} = int($netdev->{$dev}->{transmit});
604ea644
AD
2957 }
2958
1e3baf05
DM
2959 }
2960
1e3baf05
DM
2961 my $ctime = gettimeofday;
2962
2963 foreach my $vmid (keys %$list) {
2964
2965 my $d = $res->{$vmid};
2966 my $pid = $d->{pid};
2967 next if !$pid;
2968
694fcad4
DM
2969 my $pstat = PVE::ProcFSTools::read_proc_pid_stat($pid);
2970 next if !$pstat; # not running
19672434 2971
694fcad4 2972 my $used = $pstat->{utime} + $pstat->{stime};
1e3baf05 2973
694fcad4 2974 $d->{uptime} = int(($uptime - $pstat->{starttime})/$cpuinfo->{user_hz});
1e3baf05 2975
694fcad4 2976 if ($pstat->{vsize}) {
6b64503e 2977 $d->{mem} = int(($pstat->{rss}/$pstat->{vsize})*$d->{maxmem});
1e3baf05
DM
2978 }
2979
2980 my $old = $last_proc_pid_stat->{$pid};
2981 if (!$old) {
19672434
DM
2982 $last_proc_pid_stat->{$pid} = {
2983 time => $ctime,
1e3baf05
DM
2984 used => $used,
2985 cpu => 0,
1e3baf05
DM
2986 };
2987 next;
2988 }
2989
7f0b5beb 2990 my $dtime = ($ctime - $old->{time}) * $cpucount * $cpuinfo->{user_hz};
1e3baf05
DM
2991
2992 if ($dtime > 1000) {
2993 my $dutime = $used - $old->{used};
2994
ae4915a2 2995 $d->{cpu} = (($dutime/$dtime)* $cpucount) / $d->{cpus};
1e3baf05 2996 $last_proc_pid_stat->{$pid} = {
19672434 2997 time => $ctime,
1e3baf05
DM
2998 used => $used,
2999 cpu => $d->{cpu},
1e3baf05
DM
3000 };
3001 } else {
3002 $d->{cpu} = $old->{cpu};
1e3baf05
DM
3003 }
3004 }
3005
f5eb281a 3006 return $res if !$full;
03a33f30
DM
3007
3008 my $qmpclient = PVE::QMPClient->new();
3009
64e7fcf2
DM
3010 my $ballooncb = sub {
3011 my ($vmid, $resp) = @_;
3012
3013 my $info = $resp->{'return'};
38babf81
DM
3014 return if !$info->{max_mem};
3015
64e7fcf2
DM
3016 my $d = $res->{$vmid};
3017
38babf81
DM
3018 # use memory assigned to VM
3019 $d->{maxmem} = $info->{max_mem};
3020 $d->{balloon} = $info->{actual};
3021
3022 if (defined($info->{total_mem}) && defined($info->{free_mem})) {
3023 $d->{mem} = $info->{total_mem} - $info->{free_mem};
3024 $d->{freemem} = $info->{free_mem};
64e7fcf2
DM
3025 }
3026
604ea644 3027 $d->{ballooninfo} = $info;
64e7fcf2
DM
3028 };
3029
03a33f30
DM
3030 my $blockstatscb = sub {
3031 my ($vmid, $resp) = @_;
3032 my $data = $resp->{'return'} || [];
3033 my $totalrdbytes = 0;
3034 my $totalwrbytes = 0;
604ea644 3035
03a33f30
DM
3036 for my $blockstat (@$data) {
3037 $totalrdbytes = $totalrdbytes + $blockstat->{stats}->{rd_bytes};
3038 $totalwrbytes = $totalwrbytes + $blockstat->{stats}->{wr_bytes};
604ea644
AD
3039
3040 $blockstat->{device} =~ s/drive-//;
3041 $res->{$vmid}->{blockstat}->{$blockstat->{device}} = $blockstat->{stats};
03a33f30
DM
3042 }
3043 $res->{$vmid}->{diskread} = $totalrdbytes;
3044 $res->{$vmid}->{diskwrite} = $totalwrbytes;
3045 };
3046
949112c3
FE
3047 my $machinecb = sub {
3048 my ($vmid, $resp) = @_;
3049 my $data = $resp->{'return'} || [];
3050
3051 $res->{$vmid}->{'running-machine'} =
3052 PVE::QemuServer::Machine::current_from_query_machines($data);
3053 };
3054
3055 my $versioncb = sub {
3056 my ($vmid, $resp) = @_;
3057 my $data = $resp->{'return'} // {};
3058 my $version = 'unknown';
3059
3060 if (my $v = $data->{qemu}) {
3061 $version = $v->{major} . "." . $v->{minor} . "." . $v->{micro};
3062 }
3063
3064 $res->{$vmid}->{'running-qemu'} = $version;
3065 };
3066
03a33f30
DM
3067 my $statuscb = sub {
3068 my ($vmid, $resp) = @_;
64e7fcf2 3069
03a33f30 3070 $qmpclient->queue_cmd($vmid, $blockstatscb, 'query-blockstats');
949112c3
FE
3071 $qmpclient->queue_cmd($vmid, $machinecb, 'query-machines');
3072 $qmpclient->queue_cmd($vmid, $versioncb, 'query-version');
64e7fcf2
DM
3073 # this fails if ballon driver is not loaded, so this must be
3074 # the last commnand (following command are aborted if this fails).
38babf81 3075 $qmpclient->queue_cmd($vmid, $ballooncb, 'query-balloon');
03a33f30
DM
3076
3077 my $status = 'unknown';
3078 if (!defined($status = $resp->{'return'}->{status})) {
3079 warn "unable to get VM status\n";
3080 return;
3081 }
3082
3083 $res->{$vmid}->{qmpstatus} = $resp->{'return'}->{status};
3084 };
3085
3086 foreach my $vmid (keys %$list) {
3087 next if $opt_vmid && ($vmid ne $opt_vmid);
3088 next if !$res->{$vmid}->{pid}; # not running
3089 $qmpclient->queue_cmd($vmid, $statuscb, 'query-status');
3090 }
3091
b017fbda 3092 $qmpclient->queue_execute(undef, 2);
03a33f30 3093
6891fd70
SR
3094 foreach my $vmid (keys %$list) {
3095 next if $opt_vmid && ($vmid ne $opt_vmid);
e5b18771
FG
3096 next if !$res->{$vmid}->{pid}; #not running
3097
6891fd70
SR
3098 # we can't use the $qmpclient since it might have already aborted on
3099 # 'query-balloon', but this might also fail for older versions...
3100 my $qemu_support = eval { mon_cmd($vmid, "query-proxmox-support") };
3101 $res->{$vmid}->{'proxmox-support'} = $qemu_support // {};
3102 }
3103
03a33f30
DM
3104 foreach my $vmid (keys %$list) {
3105 next if $opt_vmid && ($vmid ne $opt_vmid);
3106 $res->{$vmid}->{qmpstatus} = $res->{$vmid}->{status} if !$res->{$vmid}->{qmpstatus};
3107 }
3108
1e3baf05
DM
3109 return $res;
3110}
3111
8107b378
DC
3112sub conf_has_serial {
3113 my ($conf) = @_;
3114
3115 for (my $i = 0; $i < $MAX_SERIAL_PORTS; $i++) {
3116 if ($conf->{"serial$i"}) {
3117 return 1;
3118 }
3119 }
3120
3121 return 0;
3122}
3123
d5535a00
TL
3124sub conf_has_audio {
3125 my ($conf, $id) = @_;
3126
3127 $id //= 0;
3128 my $audio = $conf->{"audio$id"};
d1c1af4b 3129 return if !defined($audio);
d5535a00 3130
4df98f2f 3131 my $audioproperties = parse_property_string($audio_fmt, $audio);
d5535a00
TL
3132 my $audiodriver = $audioproperties->{driver} // 'spice';
3133
3134 return {
3135 dev => $audioproperties->{device},
b0f96836 3136 dev_id => "audiodev$id",
d5535a00
TL
3137 backend => $audiodriver,
3138 backend_id => "$audiodriver-backend${id}",
3139 };
3140}
3141
b01de199 3142sub audio_devs {
1cc5ed1b 3143 my ($audio, $audiopciaddr, $machine_version) = @_;
b01de199
TL
3144
3145 my $devs = [];
3146
3147 my $id = $audio->{dev_id};
1cc5ed1b
AL
3148 my $audiodev = "";
3149 if (min_version($machine_version, 4, 2)) {
3150 $audiodev = ",audiodev=$audio->{backend_id}";
3151 }
b01de199
TL
3152
3153 if ($audio->{dev} eq 'AC97') {
1cc5ed1b 3154 push @$devs, '-device', "AC97,id=${id}${audiopciaddr}$audiodev";
b01de199
TL
3155 } elsif ($audio->{dev} =~ /intel\-hda$/) {
3156 push @$devs, '-device', "$audio->{dev},id=${id}${audiopciaddr}";
1cc5ed1b
AL
3157 push @$devs, '-device', "hda-micro,id=${id}-codec0,bus=${id}.0,cad=0$audiodev";
3158 push @$devs, '-device', "hda-duplex,id=${id}-codec1,bus=${id}.0,cad=1$audiodev";
b01de199
TL
3159 } else {
3160 die "unkown audio device '$audio->{dev}', implement me!";
3161 }
3162
3163 push @$devs, '-audiodev', "$audio->{backend},id=$audio->{backend_id}";
3164
3165 return $devs;
3166}
3167
f9dde219
SR
3168sub get_tpm_paths {
3169 my ($vmid) = @_;
3170 return {
3171 socket => "/var/run/qemu-server/$vmid.swtpm",
3172 pid => "/var/run/qemu-server/$vmid.swtpm.pid",
3173 };
3174}
3175
3176sub add_tpm_device {
3177 my ($vmid, $devices, $conf) = @_;
3178
3179 return if !$conf->{tpmstate0};
3180
3181 my $paths = get_tpm_paths($vmid);
3182
3183 push @$devices, "-chardev", "socket,id=tpmchar,path=$paths->{socket}";
3184 push @$devices, "-tpmdev", "emulator,id=tpmdev,chardev=tpmchar";
3185 push @$devices, "-device", "tpm-tis,tpmdev=tpmdev";
3186}
3187
3188sub start_swtpm {
3189 my ($storecfg, $vmid, $tpmdrive, $migration) = @_;
3190
3191 return if !$tpmdrive;
3192
3193 my $state;
3194 my $tpm = parse_drive("tpmstate0", $tpmdrive);
3195 my ($storeid, $volname) = PVE::Storage::parse_volume_id($tpm->{file}, 1);
3196 if ($storeid) {
3197 $state = PVE::Storage::map_volume($storecfg, $tpm->{file});
3198 } else {
3199 $state = $tpm->{file};
3200 }
3201
3202 my $paths = get_tpm_paths($vmid);
3203
3204 # during migration, we will get state from remote
3205 #
3206 if (!$migration) {
3207 # run swtpm_setup to create a new TPM state if it doesn't exist yet
3208 my $setup_cmd = [
3209 "swtpm_setup",
3210 "--tpmstate",
3211 "file://$state",
3212 "--createek",
3213 "--create-ek-cert",
3214 "--create-platform-cert",
3215 "--lock-nvram",
3216 "--config",
3217 "/etc/swtpm_setup.conf", # do not use XDG configs
3218 "--runas",
3219 "0", # force creation as root, error if not possible
3220 "--not-overwrite", # ignore existing state, do not modify
3221 ];
3222
3223 push @$setup_cmd, "--tpm2" if $tpm->{version} eq 'v2.0';
3224 # TPM 2.0 supports ECC crypto, use if possible
3225 push @$setup_cmd, "--ecc" if $tpm->{version} eq 'v2.0';
3226
3227 run_command($setup_cmd, outfunc => sub {
3228 print "swtpm_setup: $1\n";
3229 });
3230 }
3231
3232 my $emulator_cmd = [
3233 "swtpm",
3234 "socket",
3235 "--tpmstate",
3236 "backend-uri=file://$state,mode=0600",
3237 "--ctrl",
3238 "type=unixio,path=$paths->{socket},mode=0600",
3239 "--pid",
3240 "file=$paths->{pid}",
3241 "--terminate", # terminate on QEMU disconnect
3242 "--daemon",
3243 ];
3244 push @$emulator_cmd, "--tpm2" if $tpm->{version} eq 'v2.0';
3245 run_command($emulator_cmd, outfunc => sub { print $1; });
3246
6bbcd71f 3247 my $tries = 100; # swtpm may take a bit to start before daemonizing, wait up to 5s for pid
f85951dc 3248 while (! -e $paths->{pid}) {
90c41bac 3249 die "failed to start swtpm: pid file '$paths->{pid}' wasn't created.\n" if --$tries == 0;
6bbcd71f 3250 usleep(50_000);
f85951dc
SR
3251 }
3252
f9dde219
SR
3253 # return untainted PID of swtpm daemon so it can be killed on error
3254 file_read_firstline($paths->{pid}) =~ m/(\d+)/;
3255 return $1;
3256}
3257
86b8228b
DM
3258sub vga_conf_has_spice {
3259 my ($vga) = @_;
3260
55655ebc
DC
3261 my $vgaconf = parse_vga($vga);
3262 my $vgatype = $vgaconf->{type};
3263 return 0 if !$vgatype || $vgatype !~ m/^qxl([234])?$/;
590e698c
DM
3264
3265 return $1 || 1;
86b8228b
DM
3266}
3267
d731ecbe
WB
3268sub is_native($) {
3269 my ($arch) = @_;
3270 return get_host_arch() eq $arch;
3271}
3272
045749f2
TL
3273sub get_vm_arch {
3274 my ($conf) = @_;
3275 return $conf->{arch} // get_host_arch();
3276}
3277
d731ecbe
WB
3278my $default_machines = {
3279 x86_64 => 'pc',
3280 aarch64 => 'virt',
3281};
3282
0761e619
TL
3283sub get_installed_machine_version {
3284 my ($kvmversion) = @_;
3285 $kvmversion = kvm_user_version() if !defined($kvmversion);
3286 $kvmversion =~ m/^(\d+\.\d+)/;
3287 return $1;
3288}
3289
3290sub windows_get_pinned_machine_version {
3291 my ($machine, $base_version, $kvmversion) = @_;
3292
3293 my $pin_version = $base_version;
3294 if (!defined($base_version) ||
3295 !PVE::QemuServer::Machine::can_run_pve_machine_version($base_version, $kvmversion)
3296 ) {
3297 $pin_version = get_installed_machine_version($kvmversion);
3298 }
3299 if (!$machine || $machine eq 'pc') {
3300 $machine = "pc-i440fx-$pin_version";
3301 } elsif ($machine eq 'q35') {
3302 $machine = "pc-q35-$pin_version";
3303 } elsif ($machine eq 'virt') {
3304 $machine = "virt-$pin_version";
3305 } else {
3306 warn "unknown machine type '$machine', not touching that!\n";
3307 }
3308
3309 return $machine;
3310}
3311
045749f2 3312sub get_vm_machine {
ac0077cc 3313 my ($conf, $forcemachine, $arch, $add_pve_version, $kvmversion) = @_;
045749f2
TL
3314
3315 my $machine = $forcemachine || $conf->{machine};
d731ecbe 3316
9471e48b 3317 if (!$machine || $machine =~ m/^(?:pc|q35|virt)$/) {
4dd1e83c
TL
3318 $kvmversion //= kvm_user_version();
3319 # we must pin Windows VMs without a specific version to 5.1, as 5.2 fixed a bug in ACPI
3320 # layout which confuses windows quite a bit and may result in various regressions..
3321 # see: https://lists.gnu.org/archive/html/qemu-devel/2021-02/msg08484.html
3322 if (windows_version($conf->{ostype})) {
0761e619 3323 $machine = windows_get_pinned_machine_version($machine, '5.1', $kvmversion);
4dd1e83c 3324 }
045749f2
TL
3325 $arch //= 'x86_64';
3326 $machine ||= $default_machines->{$arch};
ac0077cc 3327 if ($add_pve_version) {
ac0077cc
SR
3328 my $pvever = PVE::QemuServer::Machine::get_pve_version($kvmversion);
3329 $machine .= "+pve$pvever";
3330 }
3331 }
3332
d4be7f31
SR
3333 if ($add_pve_version && $machine !~ m/\+pve\d+?(?:\.pxe)?$/) {
3334 my $is_pxe = $machine =~ m/^(.*?)\.pxe$/;
3335 $machine = $1 if $is_pxe;
3336
ac0077cc
SR
3337 # for version-pinned machines that do not include a pve-version (e.g.
3338 # pc-q35-4.1), we assume 0 to keep them stable in case we bump
3339 $machine .= '+pve0';
d4be7f31
SR
3340
3341 $machine .= '.pxe' if $is_pxe;
045749f2
TL
3342 }
3343
3344 return $machine;
d731ecbe
WB
3345}
3346
90b20b15
DC
3347sub get_ovmf_files($$$) {
3348 my ($arch, $efidisk, $smm) = @_;
96ed3574 3349
b5099b4f 3350 my $types = $OVMF->{$arch}
96ed3574
WB
3351 or die "no OVMF images known for architecture '$arch'\n";
3352
b5099b4f
SR
3353 my $type = 'default';
3354 if (defined($efidisk->{efitype}) && $efidisk->{efitype} eq '4m') {
90b20b15
DC
3355 $type = $smm ? "4m" : "4m-no-smm";
3356 $type .= '-ms' if $efidisk->{'pre-enrolled-keys'};
b5099b4f
SR
3357 }
3358
3359 return $types->{$type}->@*;
96ed3574
WB
3360}
3361
6908fd9b
WB
3362my $Arch2Qemu = {
3363 aarch64 => '/usr/bin/qemu-system-aarch64',
3364 x86_64 => '/usr/bin/qemu-system-x86_64',
3365};
3366sub get_command_for_arch($) {
3367 my ($arch) = @_;
3368 return '/usr/bin/kvm' if is_native($arch);
3369
3370 my $cmd = $Arch2Qemu->{$arch}
3371 or die "don't know how to emulate architecture '$arch'\n";
3372 return $cmd;
3373}
3374
05a4c550
SR
3375# To use query_supported_cpu_flags and query_understood_cpu_flags to get flags
3376# to use in a QEMU command line (-cpu element), first array_intersect the result
3377# of query_supported_ with query_understood_. This is necessary because:
3378#
3379# a) query_understood_ returns flags the host cannot use and
3380# b) query_supported_ (rather the QMP call) doesn't actually return CPU
3381# flags, but CPU settings - with most of them being flags. Those settings
3382# (and some flags, curiously) cannot be specified as a "-cpu" argument.
3383#
3384# query_supported_ needs to start up to 2 temporary VMs and is therefore rather
3385# expensive. If you need the value returned from this, you can get it much
3386# cheaper from pmxcfs using PVE::Cluster::get_node_kv('cpuflags-$accel') with
3387# $accel being 'kvm' or 'tcg'.
3388#
3389# pvestatd calls this function on startup and whenever the QEMU/KVM version
3390# changes, automatically populating pmxcfs.
3391#
3392# Returns: { kvm => [ flagX, flagY, ... ], tcg => [ flag1, flag2, ... ] }
3393# since kvm and tcg machines support different flags
3394#
3395sub query_supported_cpu_flags {
52cffab6 3396 my ($arch) = @_;
05a4c550 3397
52cffab6
SR
3398 $arch //= get_host_arch();
3399 my $default_machine = $default_machines->{$arch};
3400
3401 my $flags = {};
05a4c550
SR
3402
3403 # FIXME: Once this is merged, the code below should work for ARM as well:
3404 # https://lists.nongnu.org/archive/html/qemu-devel/2019-06/msg04947.html
3405 die "QEMU/KVM cannot detect CPU flags on ARM (aarch64)\n" if
3406 $arch eq "aarch64";
3407
3408 my $kvm_supported = defined(kvm_version());
3409 my $qemu_cmd = get_command_for_arch($arch);
3410 my $fakevmid = -1;
3411 my $pidfile = PVE::QemuServer::Helpers::pidfile_name($fakevmid);
3412
3413 # Start a temporary (frozen) VM with vmid -1 to allow sending a QMP command
3414 my $query_supported_run_qemu = sub {
3415 my ($kvm) = @_;
3416
3417 my $flags = {};
3418 my $cmd = [
3419 $qemu_cmd,
3420 '-machine', $default_machine,
3421 '-display', 'none',
378ad769 3422 '-chardev', "socket,id=qmp,path=/var/run/qemu-server/$fakevmid.qmp,server=on,wait=off",
05a4c550
SR
3423 '-mon', 'chardev=qmp,mode=control',
3424 '-pidfile', $pidfile,
3425 '-S', '-daemonize'
3426 ];
3427
3428 if (!$kvm) {
3429 push @$cmd, '-accel', 'tcg';
3430 }
3431
3432 my $rc = run_command($cmd, noerr => 1, quiet => 0);
3433 die "QEMU flag querying VM exited with code " . $rc if $rc;
3434
3435 eval {
3436 my $cmd_result = mon_cmd(
3437 $fakevmid,
3438 'query-cpu-model-expansion',
3439 type => 'full',
3440 model => { name => 'host' }
3441 );
3442
3443 my $props = $cmd_result->{model}->{props};
3444 foreach my $prop (keys %$props) {
3445 next if $props->{$prop} ne '1';
3446 # QEMU returns some flags multiple times, with '_', '.' or '-'
3447 # (e.g. lahf_lm and lahf-lm; sse4.2, sse4-2 and sse4_2; ...).
3448 # We only keep those with underscores, to match /proc/cpuinfo
3449 $prop =~ s/\.|-/_/g;
3450 $flags->{$prop} = 1;
3451 }
3452 };
3453 my $err = $@;
3454
6bbcd71f 3455 # force stop with 10 sec timeout and 'nocheck', always stop, even if QMP failed
05a4c550
SR
3456 vm_stop(undef, $fakevmid, 1, 1, 10, 0, 1);
3457
3458 die $err if $err;
3459
3460 return [ sort keys %$flags ];
3461 };
3462
3463 # We need to query QEMU twice, since KVM and TCG have different supported flags
3464 PVE::QemuConfig->lock_config($fakevmid, sub {
3465 $flags->{tcg} = eval { $query_supported_run_qemu->(0) };
3466 warn "warning: failed querying supported tcg flags: $@\n" if $@;
3467
3468 if ($kvm_supported) {
3469 $flags->{kvm} = eval { $query_supported_run_qemu->(1) };
3470 warn "warning: failed querying supported kvm flags: $@\n" if $@;
3471 }
3472 });
3473
3474 return $flags;
3475}
3476
3477# Understood CPU flags are written to a file at 'pve-qemu' compile time
3478my $understood_cpu_flag_dir = "/usr/share/kvm";
3479sub query_understood_cpu_flags {
3480 my $arch = get_host_arch();
3481 my $filepath = "$understood_cpu_flag_dir/recognized-CPUID-flags-$arch";
3482
3483 die "Cannot query understood QEMU CPU flags for architecture: $arch (file not found)\n"
3484 if ! -e $filepath;
3485
3486 my $raw = file_get_contents($filepath);
3487 $raw =~ s/^\s+|\s+$//g;
3488 my @flags = split(/\s+/, $raw);
3489
3490 return \@flags;
3491}
3492
e5a6919c
FE
3493# Since commit 277d33454f77ec1d1e0bc04e37621e4dd2424b67 in pve-qemu, smm is not off by default
3494# anymore. But smm=off seems to be required when using SeaBIOS and serial display.
3495my sub should_disable_smm {
3496 my ($conf, $vga) = @_;
3497
3498 return (!defined($conf->{bios}) || $conf->{bios} eq 'seabios') &&
bec87424 3499 $vga->{type} && $vga->{type} =~ m/^(serial\d+|none)$/;
e5a6919c
FE
3500}
3501
1e3baf05 3502sub config_to_command {
5921764c
SR
3503 my ($storecfg, $vmid, $conf, $defaults, $forcemachine, $forcecpu,
3504 $pbs_backing) = @_;
1e3baf05
DM
3505
3506 my $cmd = [];
3326ae19 3507 my ($globalFlags, $machineFlags, $rtcFlags) = ([], [], []);
5bdcf937 3508 my $devices = [];
5bdcf937 3509 my $bridges = {};
b42d3cf9 3510 my $ostype = $conf->{ostype};
4317f69f 3511 my $winversion = windows_version($ostype);
d731ecbe 3512 my $kvm = $conf->{kvm};
38277afc 3513 my $nodename = nodename();
d731ecbe 3514
045749f2 3515 my $arch = get_vm_arch($conf);
1476b99f
DC
3516 my $kvm_binary = get_command_for_arch($arch);
3517 my $kvmver = kvm_user_version($kvm_binary);
045749f2 3518
a04dd5c4
SR
3519 if (!$kvmver || $kvmver !~ m/^(\d+)\.(\d+)/ || $1 < 3) {
3520 $kvmver //= "undefined";
3521 die "Detected old QEMU binary ('$kvmver', at least 3.0 is required)\n";
3522 }
3523
9471e48b
TL
3524 my $add_pve_version = min_version($kvmver, 4, 1);
3525
3526 my $machine_type = get_vm_machine($conf, $forcemachine, $arch, $add_pve_version);
4df98f2f 3527 my $machine_version = extract_version($machine_type, $kvmver);
d731ecbe 3528 $kvm //= 1 if is_native($arch);
4317f69f 3529
a77a53ae 3530 $machine_version =~ m/(\d+)\.(\d+)/;
ac0077cc 3531 my ($machine_major, $machine_minor) = ($1, $2);
ac0077cc 3532
b516c848
SR
3533 if ($kvmver =~ m/^\d+\.\d+\.(\d+)/ && $1 >= 90) {
3534 warn "warning: Installed QEMU version ($kvmver) is a release candidate, ignoring version checks\n";
3535 } elsif (!min_version($kvmver, $machine_major, $machine_minor)) {
4df98f2f
TL
3536 die "Installed QEMU version '$kvmver' is too old to run machine type '$machine_type',"
3537 ." please upgrade node '$nodename'\n"
b516c848 3538 } elsif (!PVE::QemuServer::Machine::can_run_pve_machine_version($machine_version, $kvmver)) {
ac0077cc 3539 my $max_pve_version = PVE::QemuServer::Machine::get_pve_version($machine_version);
4df98f2f
TL
3540 die "Installed qemu-server (max feature level for $machine_major.$machine_minor is"
3541 ." pve$max_pve_version) is too old to run machine type '$machine_type', please upgrade"
3542 ." node '$nodename'\n";
ac0077cc
SR
3543 }
3544
3545 # if a specific +pve version is required for a feature, use $version_guard
3546 # instead of min_version to allow machines to be run with the minimum
3547 # required version
3548 my $required_pve_version = 0;
3549 my $version_guard = sub {
3550 my ($major, $minor, $pve) = @_;
3551 return 0 if !min_version($machine_version, $major, $minor, $pve);
47f35977
SR
3552 my $max_pve = PVE::QemuServer::Machine::get_pve_version("$major.$minor");
3553 return 1 if min_version($machine_version, $major, $minor, $max_pve+1);
ac0077cc
SR
3554 $required_pve_version = $pve if $pve && $pve > $required_pve_version;
3555 return 1;
3556 };
a77a53ae 3557
4df98f2f
TL
3558 if ($kvm && !defined kvm_version()) {
3559 die "KVM virtualisation configured, but not available. Either disable in VM configuration"
3560 ." or enable in BIOS.\n";
d731ecbe 3561 }
bfcd9b7e 3562
3392d6ca 3563 my $q35 = PVE::QemuServer::Machine::machine_type_is_q35($conf);
4d3f29ed 3564 my $hotplug_features = parse_hotplug_features(defined($conf->{hotplug}) ? $conf->{hotplug} : '1');
249c4a6c
AD
3565 my $use_old_bios_files = undef;
3566 ($use_old_bios_files, $machine_type) = qemu_use_old_bios_files($machine_type);
db656e5f 3567
83870398 3568 if ($conf->{affinity}) {
c963efc8 3569 push @$cmd, "/usr/bin/taskset";
83870398
DB
3570 push @$cmd, "--cpu-list";
3571 push @$cmd, "--all-tasks";
3572 push @$cmd, $conf->{affinity};
3573 }
3574
1476b99f 3575 push @$cmd, $kvm_binary;
1e3baf05
DM
3576
3577 push @$cmd, '-id', $vmid;
3578
e4d4cda1
HR
3579 my $vmname = $conf->{name} || "vm$vmid";
3580
6884a7d7 3581 push @$cmd, '-name', "$vmname,debug-threads=on";
e4d4cda1 3582
27b25d03
SR
3583 push @$cmd, '-no-shutdown';
3584
1e3baf05
DM
3585 my $use_virtio = 0;
3586
d036e418 3587 my $qmpsocket = PVE::QemuServer::Helpers::qmp_socket($vmid);
378ad769 3588 push @$cmd, '-chardev', "socket,id=qmp,path=$qmpsocket,server=on,wait=off";
c971c4f2
AD
3589 push @$cmd, '-mon', "chardev=qmp,mode=control";
3590
2ea5fb7e 3591 if (min_version($machine_version, 2, 12)) {
b4496b9e 3592 push @$cmd, '-chardev', "socket,id=qmp-event,path=/var/run/qmeventd.sock,reconnect=5";
71bd73b5
DC
3593 push @$cmd, '-mon', "chardev=qmp-event,mode=control";
3594 }
1e3baf05 3595
d036e418 3596 push @$cmd, '-pidfile' , PVE::QemuServer::Helpers::pidfile_name($vmid);
19672434 3597
1e3baf05
DM
3598 push @$cmd, '-daemonize';
3599
2796e7d5 3600 if ($conf->{smbios1}) {
1f30ac3a
CE
3601 my $smbios_conf = parse_smbios1($conf->{smbios1});
3602 if ($smbios_conf->{base64}) {
3603 # Do not pass base64 flag to qemu
3604 delete $smbios_conf->{base64};
3605 my $smbios_string = "";
3606 foreach my $key (keys %$smbios_conf) {
3607 my $value;
3608 if ($key eq "uuid") {
3609 $value = $smbios_conf->{uuid}
3610 } else {
3611 $value = decode_base64($smbios_conf->{$key});
3612 }
3613 # qemu accepts any binary data, only commas need escaping by double comma
3614 $value =~ s/,/,,/g;
3615 $smbios_string .= "," . $key . "=" . $value if $value;
3616 }
3617 push @$cmd, '-smbios', "type=1" . $smbios_string;
3618 } else {
3619 push @$cmd, '-smbios', "type=1,$conf->{smbios1}";
3620 }
2796e7d5
DM
3621 }
3622
3edb45e7 3623 if ($conf->{bios} && $conf->{bios} eq 'ovmf') {
b5099b4f
SR
3624 my $d;
3625 if (my $efidisk = $conf->{efidisk0}) {
3626 $d = parse_drive('efidisk0', $efidisk);
3627 }
3628
90b20b15 3629 my ($ovmf_code, $ovmf_vars) = get_ovmf_files($arch, $d, $q35);
818c3b8d 3630 die "uefi base image '$ovmf_code' not found\n" if ! -f $ovmf_code;
2ddc0a5c 3631
818c3b8d 3632 my ($path, $format);
b4dc6475 3633 my $read_only_str = '';
b5099b4f 3634 if ($d) {
2ddc0a5c 3635 my ($storeid, $volname) = PVE::Storage::parse_volume_id($d->{file}, 1);
13bca7b4 3636 $format = $d->{format};
2ddc0a5c
DC
3637 if ($storeid) {
3638 $path = PVE::Storage::path($storecfg, $d->{file});
13bca7b4
WB
3639 if (!defined($format)) {
3640 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
3641 $format = qemu_img_format($scfg, $volname);
3642 }
2ddc0a5c
DC
3643 } else {
3644 $path = $d->{file};
13bca7b4
WB
3645 die "efidisk format must be specified\n"
3646 if !defined($format);
2ddc0a5c 3647 }
b4dc6475
FG
3648
3649 $read_only_str = ',readonly=on' if drive_is_read_only($conf, $d);
2ddc0a5c 3650 } else {
34e82fa2 3651 log_warn("no efidisk configured! Using temporary efivars disk.");
4dcce9ee 3652 $path = "/tmp/$vmid-ovmf.fd";
96ed3574 3653 PVE::Tools::file_copy($ovmf_vars, $path, -s $ovmf_vars);
13bca7b4 3654 $format = 'raw';
2ddc0a5c 3655 }
4dcce9ee 3656
818ce80e
DC
3657 my $size_str = "";
3658
3659 if ($format eq 'raw' && $version_guard->(4, 1, 2)) {
3660 $size_str = ",size=" . (-s $ovmf_vars);
3661 }
3662
738dc81c
TL
3663 # SPI flash does lots of read-modify-write OPs, without writeback this gets really slow #3329
3664 my $cache = "";
3665 if ($path =~ m/^rbd:/) {
3666 $cache = ',cache=writeback';
3667 $path .= ':rbd_cache_policy=writeback'; # avoid write-around, we *need* to cache writes too
3668 }
6aaad230 3669
378ad769 3670 push @$cmd, '-drive', "if=pflash,unit=0,format=raw,readonly=on,file=$ovmf_code";
b4dc6475 3671 push @$cmd, '-drive', "if=pflash,unit=1$cache,format=$format,id=drive-efidisk0$size_str,file=${path}${read_only_str}";
a783c78e
AD
3672 }
3673
483ceeab 3674 if ($q35) { # tell QEMU to load q35 config early
7583d156 3675 # we use different pcie-port hardware for qemu >= 4.0 for passthrough
2ea5fb7e 3676 if (min_version($machine_version, 4, 0)) {
7583d156
DC
3677 push @$devices, '-readconfig', '/usr/share/qemu-server/pve-q35-4.0.cfg';
3678 } else {
3679 push @$devices, '-readconfig', '/usr/share/qemu-server/pve-q35.cfg';
3680 }
3681 }
da8b4189 3682
cc181036
TL
3683 if (defined(my $fixups = qemu_created_version_fixups($conf, $forcemachine, $kvmver))) {
3684 push @$cmd, $fixups->@*;
3685 }
3686
844d8fa6
DC
3687 if ($conf->{vmgenid}) {
3688 push @$devices, '-device', 'vmgenid,guid='.$conf->{vmgenid};
3689 }
3690
d40e5e18 3691 # add usb controllers
4df98f2f 3692 my @usbcontrollers = PVE::QemuServer::USB::get_usb_controllers(
4862922a 3693 $conf, $bridges, $arch, $machine_type, $usbdesc->{format}, $MAX_USB_DEVICES, $machine_version);
d40e5e18 3694 push @$devices, @usbcontrollers if @usbcontrollers;
55655ebc 3695 my $vga = parse_vga($conf->{vga});
2fa3151e 3696
55655ebc
DC
3697 my $qxlnum = vga_conf_has_spice($conf->{vga});
3698 $vga->{type} = 'qxl' if $qxlnum;
2fa3151e 3699
55655ebc 3700 if (!$vga->{type}) {
869ad4a7
WB
3701 if ($arch eq 'aarch64') {
3702 $vga->{type} = 'virtio';
2ea5fb7e 3703 } elsif (min_version($machine_version, 2, 9)) {
55655ebc 3704 $vga->{type} = (!$winversion || $winversion >= 6) ? 'std' : 'cirrus';
a2a5cd64 3705 } else {
55655ebc 3706 $vga->{type} = ($winversion >= 6) ? 'std' : 'cirrus';
a2a5cd64 3707 }
5acbfe9e
DM
3708 }
3709
1e3baf05 3710 # enable absolute mouse coordinates (needed by vnc)
fa3b3ce0
TL
3711 my $tablet = $conf->{tablet};
3712 if (!defined($tablet)) {
5acbfe9e 3713 $tablet = $defaults->{tablet};
590e698c 3714 $tablet = 0 if $qxlnum; # disable for spice because it is not needed
55655ebc 3715 $tablet = 0 if $vga->{type} =~ m/^serial\d+$/; # disable if we use serial terminal (no vga card)
5acbfe9e
DM
3716 }
3717
d559309f
WB
3718 if ($tablet) {
3719 push @$devices, '-device', print_tabletdevice_full($conf, $arch) if $tablet;
3720 my $kbd = print_keyboarddevice_full($conf, $arch);
3721 push @$devices, '-device', $kbd if defined($kbd);
3722 }
b467f79a 3723
e5d611c3 3724 my $bootorder = device_bootorder($conf);
2141a802 3725
74c17b7a 3726 # host pci device passthrough
13d68979 3727 my ($kvm_off, $gpu_passthrough, $legacy_igd) = PVE::QemuServer::PCI::print_hostpci_devices(
41af2dfc 3728 $vmid, $conf, $devices, $vga, $winversion, $q35, $bridges, $arch, $machine_type, $bootorder);
1e3baf05
DM
3729
3730 # usb devices
ae36393d 3731 my $usb_dev_features = {};
2ea5fb7e 3732 $usb_dev_features->{spice_usb3} = 1 if min_version($machine_version, 4, 0);
ae36393d 3733
4df98f2f 3734 my @usbdevices = PVE::QemuServer::USB::get_usb_devices(
4862922a 3735 $conf, $usbdesc->{format}, $MAX_USB_DEVICES, $usb_dev_features, $bootorder, $machine_version);
d40e5e18 3736 push @$devices, @usbdevices if @usbdevices;
2141a802 3737
1e3baf05 3738 # serial devices
bae179aa 3739 for (my $i = 0; $i < $MAX_SERIAL_PORTS; $i++) {
fa3b3ce0
TL
3740 my $path = $conf->{"serial$i"} or next;
3741 if ($path eq 'socket') {
3742 my $socket = "/var/run/qemu-server/${vmid}.serial$i";
3743 push @$devices, '-chardev', "socket,id=serial$i,path=$socket,server=on,wait=off";
3744 # On aarch64, serial0 is the UART device. Qemu only allows
3745 # connecting UART devices via the '-serial' command line, as
3746 # the device has a fixed slot on the hardware...
3747 if ($arch eq 'aarch64' && $i == 0) {
3748 push @$devices, '-serial', "chardev:serial$i";
9f9d2fb2 3749 } else {
9f9d2fb2
DM
3750 push @$devices, '-device', "isa-serial,chardev=serial$i";
3751 }
fa3b3ce0
TL
3752 } else {
3753 die "no such serial device\n" if ! -c $path;
3754 push @$devices, '-chardev', "tty,id=serial$i,path=$path";
3755 push @$devices, '-device', "isa-serial,chardev=serial$i";
34978be3 3756 }
1e3baf05
DM
3757 }
3758
3759 # parallel devices
1989a89c 3760 for (my $i = 0; $i < $MAX_PARALLEL_PORTS; $i++) {
34978be3 3761 if (my $path = $conf->{"parallel$i"}) {
19672434 3762 die "no such parallel device\n" if ! -c $path;
32e69805 3763 my $devtype = $path =~ m!^/dev/usb/lp! ? 'tty' : 'parport';
4c5dbaf6 3764 push @$devices, '-chardev', "$devtype,id=parallel$i,path=$path";
5bdcf937 3765 push @$devices, '-device', "isa-parallel,chardev=parallel$i";
34978be3 3766 }
1e3baf05
DM
3767 }
3768
b01de199 3769 if (min_version($machine_version, 4, 0) && (my $audio = conf_has_audio($conf))) {
2e7b5925 3770 my $audiopciaddr = print_pci_addr("audio0", $bridges, $arch, $machine_type);
1cc5ed1b 3771 my $audio_devs = audio_devs($audio, $audiopciaddr, $machine_version);
b01de199 3772 push @$devices, @$audio_devs;
2e7b5925 3773 }
19672434 3774
f9dde219
SR
3775 add_tpm_device($vmid, $devices, $conf);
3776
1e3baf05
DM
3777 my $sockets = 1;
3778 $sockets = $conf->{smp} if $conf->{smp}; # old style - no longer iused
3779 $sockets = $conf->{sockets} if $conf->{sockets};
3780
3781 my $cores = $conf->{cores} || 1;
3bd18e48 3782
de9d1e55 3783 my $maxcpus = $sockets * $cores;
76267728 3784
de9d1e55 3785 my $vcpus = $conf->{vcpus} ? $conf->{vcpus} : $maxcpus;
76267728 3786
de9d1e55
AD
3787 my $allowed_vcpus = $cpuinfo->{cpus};
3788
483ceeab 3789 die "MAX $allowed_vcpus vcpus allowed per VM on this node\n" if ($allowed_vcpus < $maxcpus);
1e3baf05 3790
483ceeab 3791 if ($hotplug_features->{cpu} && min_version($machine_version, 2, 7)) {
69c81430
AD
3792 push @$cmd, '-smp', "1,sockets=$sockets,cores=$cores,maxcpus=$maxcpus";
3793 for (my $i = 2; $i <= $vcpus; $i++) {
3794 my $cpustr = print_cpu_device($conf,$i);
3795 push @$cmd, '-device', $cpustr;
3796 }
3797
3798 } else {
3799
3800 push @$cmd, '-smp', "$vcpus,sockets=$sockets,cores=$cores,maxcpus=$maxcpus";
3801 }
1e3baf05
DM
3802 push @$cmd, '-nodefaults';
3803
dbea4415 3804 push @$cmd, '-boot', "menu=on,strict=on,reboot-timeout=1000,splash=/usr/share/qemu-server/bootsplash.jpg";
1e3baf05 3805
6b64503e 3806 push @$cmd, '-no-acpi' if defined($conf->{acpi}) && $conf->{acpi} == 0;
1e3baf05 3807
6b64503e 3808 push @$cmd, '-no-reboot' if defined($conf->{reboot}) && $conf->{reboot} == 0;
1e3baf05 3809
84902837 3810 if ($vga->{type} && $vga->{type} !~ m/^serial\d+$/ && $vga->{type} ne 'none'){
4df98f2f
TL
3811 push @$devices, '-device', print_vga_device(
3812 $conf, $vga, $arch, $machine_version, $machine_type, undef, $qxlnum, $bridges);
6f070e39
TL
3813
3814 push @$cmd, '-display', 'egl-headless,gl=core' if $vga->{type} eq 'virtio-gl'; # VIRGL
3815
d036e418 3816 my $socket = PVE::QemuServer::Helpers::vnc_socket($vmid);
378ad769 3817 push @$cmd, '-vnc', "unix:$socket,password=on";
b7be4ba9 3818 } else {
55655ebc 3819 push @$cmd, '-vga', 'none' if $vga->{type} eq 'none';
b7be4ba9
AD
3820 push @$cmd, '-nographic';
3821 }
3822
1e3baf05 3823 # time drift fix
6b64503e 3824 my $tdf = defined($conf->{tdf}) ? $conf->{tdf} : $defaults->{tdf};
8c559505 3825 my $useLocaltime = $conf->{localtime};
1e3baf05 3826
4317f69f
AD
3827 if ($winversion >= 5) { # windows
3828 $useLocaltime = 1 if !defined($conf->{localtime});
7a131888 3829
4317f69f
AD
3830 # use time drift fix when acpi is enabled
3831 if (!(defined($conf->{acpi}) && $conf->{acpi} == 0)) {
3832 $tdf = 1 if !defined($conf->{tdf});
462e8d19 3833 }
4317f69f 3834 }
462e8d19 3835
4317f69f
AD
3836 if ($winversion >= 6) {
3837 push @$globalFlags, 'kvm-pit.lost_tick_policy=discard';
3838 push @$cmd, '-no-hpet';
1e3baf05
DM
3839 }
3840
8c559505
DM
3841 push @$rtcFlags, 'driftfix=slew' if $tdf;
3842
2f6f002c 3843 if ($conf->{startdate} && $conf->{startdate} ne 'now') {
8c559505
DM
3844 push @$rtcFlags, "base=$conf->{startdate}";
3845 } elsif ($useLocaltime) {
3846 push @$rtcFlags, 'base=localtime';
3847 }
1e3baf05 3848
58c64ad5
SR
3849 if ($forcecpu) {
3850 push @$cmd, '-cpu', $forcecpu;
3851 } else {
2f6f002c 3852 push @$cmd, get_cpu_options($conf, $arch, $kvm, $kvm_off, $machine_version, $winversion, $gpu_passthrough);
58c64ad5 3853 }
519ed28c 3854
0567a4d5 3855 PVE::QemuServer::Memory::config($conf, $vmid, $sockets, $cores, $defaults, $hotplug_features, $cmd);
370b05e7 3856
1e3baf05
DM
3857 push @$cmd, '-S' if $conf->{freeze};
3858
b20df606 3859 push @$cmd, '-k', $conf->{keyboard} if defined($conf->{keyboard});
1e3baf05 3860
48657158
MD
3861 my $guest_agent = parse_guest_agent($conf);
3862
3863 if ($guest_agent->{enabled}) {
d036e418 3864 my $qgasocket = PVE::QemuServer::Helpers::qmp_socket($vmid, 1);
378ad769 3865 push @$devices, '-chardev', "socket,path=$qgasocket,server=on,wait=off,id=qga0";
48657158 3866
60f03a11 3867 if (!$guest_agent->{type} || $guest_agent->{type} eq 'virtio') {
48657158
MD
3868 my $pciaddr = print_pci_addr("qga0", $bridges, $arch, $machine_type);
3869 push @$devices, '-device', "virtio-serial,id=qga0$pciaddr";
3870 push @$devices, '-device', 'virtserialport,chardev=qga0,name=org.qemu.guest_agent.0';
3871 } elsif ($guest_agent->{type} eq 'isa') {
3872 push @$devices, '-device', "isa-serial,chardev=qga0";
3873 }
ab6a046f
AD
3874 }
3875
e5d611c3
TL
3876 my $rng = $conf->{rng0} ? parse_rng($conf->{rng0}) : undef;
3877 if ($rng && $version_guard->(4, 1, 2)) {
05853188
SR
3878 check_rng_source($rng->{source});
3879
2cf61f33
SR
3880 my $max_bytes = $rng->{max_bytes} // $rng_fmt->{max_bytes}->{default};
3881 my $period = $rng->{period} // $rng_fmt->{period}->{default};
2cf61f33
SR
3882 my $limiter_str = "";
3883 if ($max_bytes) {
3884 $limiter_str = ",max-bytes=$max_bytes,period=$period";
3885 }
3886
2cf61f33 3887 my $rng_addr = print_pci_addr("rng0", $bridges, $arch, $machine_type);
2cf61f33
SR
3888 push @$devices, '-object', "rng-random,filename=$rng->{source},id=rng0";
3889 push @$devices, '-device', "virtio-rng-pci,rng=rng0$limiter_str$rng_addr";
3890 }
3891
1d794448 3892 my $spice_port;
2fa3151e 3893
f8ea1b30 3894 if ($qxlnum || $vga->{type} =~ /^virtio/) {
590e698c 3895 if ($qxlnum > 1) {
ac087616 3896 if ($winversion){
2f6f002c 3897 for (my $i = 1; $i < $qxlnum; $i++){
4df98f2f
TL
3898 push @$devices, '-device', print_vga_device(
3899 $conf, $vga, $arch, $machine_version, $machine_type, $i, $qxlnum, $bridges);
590e698c
DM
3900 }
3901 } else {
3902 # assume other OS works like Linux
55655ebc
DC
3903 my ($ram, $vram) = ("134217728", "67108864");
3904 if ($vga->{memory}) {
3905 $ram = PVE::Tools::convert_size($qxlnum*4*$vga->{memory}, 'mb' => 'b');
3906 $vram = PVE::Tools::convert_size($qxlnum*2*$vga->{memory}, 'mb' => 'b');
3907 }
3908 push @$cmd, '-global', "qxl-vga.ram_size=$ram";
3909 push @$cmd, '-global', "qxl-vga.vram_size=$vram";
2fa3151e
AD
3910 }
3911 }
3912
d559309f 3913 my $pciaddr = print_pci_addr("spice", $bridges, $arch, $machine_type);
95a4b4a9 3914
af0eba7e 3915 my $pfamily = PVE::Tools::get_host_address_family($nodename);
91152441
WB
3916 my @nodeaddrs = PVE::Tools::getaddrinfo_all('localhost', family => $pfamily);
3917 die "failed to get an ip address of type $pfamily for 'localhost'\n" if !@nodeaddrs;
4d316a63
AL
3918
3919 push @$devices, '-device', "virtio-serial,id=spice$pciaddr";
3920 push @$devices, '-chardev', "spicevmc,id=vdagent,name=vdagent";
3921 push @$devices, '-device', "virtserialport,chardev=vdagent,name=com.redhat.spice.0";
3922
91152441
WB
3923 my $localhost = PVE::Network::addr_to_ip($nodeaddrs[0]->{addr});
3924 $spice_port = PVE::Tools::next_spice_port($pfamily, $localhost);
943340a6 3925
4df98f2f
TL
3926 my $spice_enhancement_str = $conf->{spice_enhancements} // '';
3927 my $spice_enhancement = parse_property_string($spice_enhancements_fmt, $spice_enhancement_str);
caab114a
TL
3928 if ($spice_enhancement->{foldersharing}) {
3929 push @$devices, '-chardev', "spiceport,id=foldershare,name=org.spice-space.webdav.0";
3930 push @$devices, '-device', "virtserialport,chardev=foldershare,name=org.spice-space.webdav.0";
3931 }
c4df18db 3932
caab114a 3933 my $spice_opts = "tls-port=${spice_port},addr=$localhost,tls-ciphers=HIGH,seamless-migration=on";
4df98f2f
TL
3934 $spice_opts .= ",streaming-video=$spice_enhancement->{videostreaming}"
3935 if $spice_enhancement->{videostreaming};
3936
caab114a 3937 push @$devices, '-spice', "$spice_opts";
1011b570
DM
3938 }
3939
8d9ae0d2
DM
3940 # enable balloon by default, unless explicitly disabled
3941 if (!defined($conf->{balloon}) || $conf->{balloon}) {
3326ae19 3942 my $pciaddr = print_pci_addr("balloon0", $bridges, $arch, $machine_type);
c70e4ec3
AD
3943 my $ballooncmd = "virtio-balloon-pci,id=balloon0$pciaddr";
3944 $ballooncmd .= ",free-page-reporting=on" if min_version($machine_version, 6, 2);
3945 push @$devices, '-device', $ballooncmd;
8d9ae0d2 3946 }
1e3baf05 3947
0ea9541d
DM
3948 if ($conf->{watchdog}) {
3949 my $wdopts = parse_watchdog($conf->{watchdog});
3326ae19 3950 my $pciaddr = print_pci_addr("watchdog", $bridges, $arch, $machine_type);
0a40e8ea 3951 my $watchdog = $wdopts->{model} || 'i6300esb';
5bdcf937
AD
3952 push @$devices, '-device', "$watchdog$pciaddr";
3953 push @$devices, '-watchdog-action', $wdopts->{action} if $wdopts->{action};
0ea9541d
DM
3954 }
3955
1e3baf05 3956 my $vollist = [];
941e0c42 3957 my $scsicontroller = {};
26ee04b6 3958 my $ahcicontroller = {};
cdd20088 3959 my $scsihw = defined($conf->{scsihw}) ? $conf->{scsihw} : $defaults->{scsihw};
1e3baf05 3960
5881b913
DM
3961 # Add iscsi initiator name if available
3962 if (my $initiator = get_initiator_name()) {
3963 push @$devices, '-iscsi', "initiator-name=$initiator";
3964 }
3965
912792e2 3966 PVE::QemuConfig->foreach_volume($conf, sub {
1e3baf05
DM
3967 my ($ds, $drive) = @_;
3968
ff1a2432 3969 if (PVE::Storage::parse_volume_id($drive->{file}, 1)) {
3f11f0d7 3970 check_volume_storage_type($storecfg, $drive->{file});
1e3baf05 3971 push @$vollist, $drive->{file};
ff1a2432 3972 }
afdb31d5 3973
4dcce9ee
TL
3974 # ignore efidisk here, already added in bios/fw handling code above
3975 return if $drive->{interface} eq 'efidisk';
f9dde219
SR
3976 # similar for TPM
3977 return if $drive->{interface} eq 'tpmstate';
4dcce9ee 3978
1e3baf05 3979 $use_virtio = 1 if $ds =~ m/^virtio/;
3b408e82 3980
2141a802 3981 $drive->{bootindex} = $bootorder->{$ds} if $bootorder->{$ds};
3b408e82 3982
2f6f002c 3983 if ($drive->{interface} eq 'virtio'){
51f492cd
AD
3984 push @$cmd, '-object', "iothread,id=iothread-$ds" if $drive->{iothread};
3985 }
3986
2f6f002c 3987 if ($drive->{interface} eq 'scsi') {
cdd20088 3988
ee034f5c 3989 my ($maxdev, $controller, $controller_prefix) = scsihw_infos($conf, $drive);
6731a4cf 3990
b8fb1c03
SR
3991 die "scsi$drive->{index}: machine version 4.1~pve2 or higher is required to use more than 14 SCSI disks\n"
3992 if $drive->{index} > 13 && !&$version_guard(4, 1, 2);
3993
3326ae19 3994 my $pciaddr = print_pci_addr("$controller_prefix$controller", $bridges, $arch, $machine_type);
a1b7d579 3995 my $scsihw_type = $scsihw =~ m/^virtio-scsi-single/ ? "virtio-scsi-pci" : $scsihw;
fc8b40fd
AD
3996
3997 my $iothread = '';
3998 if($conf->{scsihw} && $conf->{scsihw} eq "virtio-scsi-single" && $drive->{iothread}){
3999 $iothread .= ",iothread=iothread-$controller_prefix$controller";
4000 push @$cmd, '-object', "iothread,id=iothread-$controller_prefix$controller";
e7a5104d 4001 } elsif ($drive->{iothread}) {
d80ad18c
MH
4002 log_warn(
4003 "iothread is only valid with virtio disk or virtio-scsi-single controller, ignoring\n"
4004 );
fc8b40fd
AD
4005 }
4006
6e11f143
AD
4007 my $queues = '';
4008 if($conf->{scsihw} && $conf->{scsihw} eq "virtio-scsi-single" && $drive->{queues}){
4009 $queues = ",num_queues=$drive->{queues}";
370b05e7 4010 }
6e11f143 4011
4df98f2f
TL
4012 push @$devices, '-device', "$scsihw_type,id=$controller_prefix$controller$pciaddr$iothread$queues"
4013 if !$scsicontroller->{$controller};
cdd20088 4014 $scsicontroller->{$controller}=1;
2f6f002c 4015 }
3b408e82 4016
26ee04b6 4017 if ($drive->{interface} eq 'sata') {
2f6f002c 4018 my $controller = int($drive->{index} / $PVE::QemuServer::Drive::MAX_SATA_DISKS);
3326ae19 4019 my $pciaddr = print_pci_addr("ahci$controller", $bridges, $arch, $machine_type);
4df98f2f
TL
4020 push @$devices, '-device', "ahci,id=ahci$controller,multifunction=on$pciaddr"
4021 if !$ahcicontroller->{$controller};
2f6f002c 4022 $ahcicontroller->{$controller}=1;
26ee04b6 4023 }
46f58b5f 4024
5921764c
SR
4025 my $pbs_conf = $pbs_backing->{$ds};
4026 my $pbs_name = undef;
4027 if ($pbs_conf) {
4028 $pbs_name = "drive-$ds-pbs";
4029 push @$devices, '-blockdev', print_pbs_blockdev($pbs_conf, $pbs_name);
4030 }
4031
6d5673c3
SR
4032 my $drive_cmd = print_drive_commandline_full(
4033 $storecfg, $vmid, $drive, $pbs_name, min_version($kvmver, 6, 0));
3dc33a72
FG
4034
4035 # extra protection for templates, but SATA and IDE don't support it..
75748d44 4036 $drive_cmd .= ',readonly=on' if drive_is_read_only($conf, $drive);
4ef13a7f 4037
15b21acc 4038 push @$devices, '-drive',$drive_cmd;
4df98f2f
TL
4039 push @$devices, '-device', print_drivedevice_full(
4040 $storecfg, $conf, $vmid, $drive, $bridges, $arch, $machine_type);
1e3baf05
DM
4041 });
4042
cc4d6182 4043 for (my $i = 0; $i < $MAX_NETS; $i++) {
2141a802
SR
4044 my $netname = "net$i";
4045
4046 next if !$conf->{$netname};
4047 my $d = parse_net($conf->{$netname});
d0a86b24 4048 next if !$d;
4ddd2ca2 4049 # save the MAC addr here (could be auto-gen. in some odd setups) for FDB registering later?
1e3baf05 4050
d0a86b24 4051 $use_virtio = 1 if $d->{model} eq 'virtio';
1e3baf05 4052
2141a802 4053 $d->{bootindex} = $bootorder->{$netname} if $bootorder->{$netname};
1e3baf05 4054
2141a802 4055 my $netdevfull = print_netdev_full($vmid, $conf, $arch, $d, $netname);
d0a86b24 4056 push @$devices, '-netdev', $netdevfull;
5bdcf937 4057
d0a86b24 4058 my $netdevicefull = print_netdevice_full(
0c03a390 4059 $vmid, $conf, $d, $netname, $bridges, $use_old_bios_files, $arch, $machine_type, $machine_version);
4df98f2f 4060
d0a86b24 4061 push @$devices, '-device', $netdevicefull;
5bdcf937 4062 }
1e3baf05 4063
6dbcb073 4064 if ($conf->{ivshmem}) {
4df98f2f 4065 my $ivshmem = parse_property_string($ivshmem_fmt, $conf->{ivshmem});
e3c27a6a 4066
6dbcb073
DC
4067 my $bus;
4068 if ($q35) {
4069 $bus = print_pcie_addr("ivshmem");
4070 } else {
4071 $bus = print_pci_addr("ivshmem", $bridges, $arch, $machine_type);
4072 }
e3c27a6a
TL
4073
4074 my $ivshmem_name = $ivshmem->{name} // $vmid;
4075 my $path = '/dev/shm/pve-shm-' . $ivshmem_name;
4076
6dbcb073 4077 push @$devices, '-device', "ivshmem-plain,memdev=ivshmem$bus,";
4df98f2f
TL
4078 push @$devices, '-object', "memory-backend-file,id=ivshmem,share=on,mem-path=$path"
4079 .",size=$ivshmem->{size}M";
6dbcb073
DC
4080 }
4081
2513b862
DC
4082 # pci.4 is nested in pci.1
4083 $bridges->{1} = 1 if $bridges->{4};
4084
3326ae19
TL
4085 if (!$q35) { # add pci bridges
4086 if (min_version($machine_version, 2, 3)) {
fc79e813
AD
4087 $bridges->{1} = 1;
4088 $bridges->{2} = 1;
4089 }
6731a4cf 4090 $bridges->{3} = 1 if $scsihw =~ m/^virtio-scsi-single/;
2513b862
DC
4091 }
4092
4093 for my $k (sort {$b cmp $a} keys %$bridges) {
4094 next if $q35 && $k < 4; # q35.cfg already includes bridges up to 3
13d68979
SR
4095
4096 my $k_name = $k;
4097 if ($k == 2 && $legacy_igd) {
4098 $k_name = "$k-igd";
4099 }
3326ae19 4100 my $pciaddr = print_pci_addr("pci.$k_name", undef, $arch, $machine_type);
2513b862 4101 my $devstr = "pci-bridge,id=pci.$k,chassis_nr=$k$pciaddr";
3326ae19
TL
4102
4103 if ($q35) { # add after -readconfig pve-q35.cfg
2513b862
DC
4104 splice @$devices, 2, 0, '-device', $devstr;
4105 } else {
4106 unshift @$devices, '-device', $devstr if $k > 0;
f8e83f05 4107 }
19672434
DM
4108 }
4109
ac0077cc
SR
4110 if (!$kvm) {
4111 push @$machineFlags, 'accel=tcg';
4112 }
4113
e5a6919c
FE
4114 push @$machineFlags, 'smm=off' if should_disable_smm($conf, $vga);
4115
ac0077cc
SR
4116 my $machine_type_min = $machine_type;
4117 if ($add_pve_version) {
4118 $machine_type_min =~ s/\+pve\d+$//;
4119 $machine_type_min .= "+pve$required_pve_version";
4120 }
4121 push @$machineFlags, "type=${machine_type_min}";
4122
5bdcf937 4123 push @$cmd, @$devices;
2f6f002c
TL
4124 push @$cmd, '-rtc', join(',', @$rtcFlags) if scalar(@$rtcFlags);
4125 push @$cmd, '-machine', join(',', @$machineFlags) if scalar(@$machineFlags);
4126 push @$cmd, '-global', join(',', @$globalFlags) if scalar(@$globalFlags);
8c559505 4127
7ceade4c
DC
4128 if (my $vmstate = $conf->{vmstate}) {
4129 my $statepath = PVE::Storage::path($storecfg, $vmstate);
24d1f93a 4130 push @$vollist, $vmstate;
7ceade4c 4131 push @$cmd, '-loadstate', $statepath;
b85666cf 4132 print "activating and using '$vmstate' as vmstate\n";
7ceade4c
DC
4133 }
4134
85fcf79e
FG
4135 if (PVE::QemuConfig->is_template($conf)) {
4136 # needed to workaround base volumes being read-only
4137 push @$cmd, '-snapshot';
4138 }
4139
76350670
DC
4140 # add custom args
4141 if ($conf->{args}) {
4142 my $aa = PVE::Tools::split_args($conf->{args});
4143 push @$cmd, @$aa;
4144 }
4145
1d794448 4146 return wantarray ? ($cmd, $vollist, $spice_port) : $cmd;
1e3baf05 4147}
19672434 4148
05853188
SR
4149sub check_rng_source {
4150 my ($source) = @_;
4151
4152 # mostly relevant for /dev/hwrng, but doesn't hurt to check others too
4153 die "cannot create VirtIO RNG device: source file '$source' doesn't exist\n"
4154 if ! -e $source;
4155
4156 my $rng_current = '/sys/devices/virtual/misc/hw_random/rng_current';
4157 if ($source eq '/dev/hwrng' && file_read_firstline($rng_current) eq 'none') {
4df98f2f
TL
4158 # Needs to abort, otherwise QEMU crashes on first rng access. Note that rng_current cannot
4159 # be changed to 'none' manually, so once the VM is past this point, it's no longer an issue.
4160 die "Cannot start VM with passed-through RNG device: '/dev/hwrng' exists, but"
4161 ." '$rng_current' is set to 'none'. Ensure that a compatible hardware-RNG is attached"
4162 ." to the host.\n";
05853188
SR
4163 }
4164}
4165
943340a6 4166sub spice_port {
1011b570 4167 my ($vmid) = @_;
943340a6 4168
0a13e08e 4169 my $res = mon_cmd($vmid, 'query-spice');
943340a6
DM
4170
4171 return $res->{'tls-port'} || $res->{'port'} || die "no spice port\n";
1011b570
DM
4172}
4173
86fdcfb2
DA
4174sub vm_devices_list {
4175 my ($vmid) = @_;
4176
0a13e08e 4177 my $res = mon_cmd($vmid, 'query-pci');
f721624b 4178 my $devices_to_check = [];
ceea9078
DM
4179 my $devices = {};
4180 foreach my $pcibus (@$res) {
f721624b
DC
4181 push @$devices_to_check, @{$pcibus->{devices}},
4182 }
4183
4184 while (@$devices_to_check) {
4185 my $to_check = [];
4186 for my $d (@$devices_to_check) {
4187 $devices->{$d->{'qdev_id'}} = 1 if $d->{'qdev_id'};
4188 next if !$d->{'pci_bridge'};
4189
4190 $devices->{$d->{'qdev_id'}} += scalar(@{$d->{'pci_bridge'}->{devices}});
4191 push @$to_check, @{$d->{'pci_bridge'}->{devices}};
f78cc802 4192 }
f721624b 4193 $devices_to_check = $to_check;
f78cc802
AD
4194 }
4195
0a13e08e 4196 my $resblock = mon_cmd($vmid, 'query-block');
f78cc802
AD
4197 foreach my $block (@$resblock) {
4198 if($block->{device} =~ m/^drive-(\S+)/){
4199 $devices->{$1} = 1;
1dc4f496
DM
4200 }
4201 }
86fdcfb2 4202
0a13e08e 4203 my $resmice = mon_cmd($vmid, 'query-mice');
3d7389fe
DM
4204 foreach my $mice (@$resmice) {
4205 if ($mice->{name} eq 'QEMU HID Tablet') {
4206 $devices->{tablet} = 1;
4207 last;
4208 }
4209 }
4210
deb091c5
DC
4211 # for usb devices there is no query-usb
4212 # but we can iterate over the entries in
4213 # qom-list path=/machine/peripheral
0a13e08e 4214 my $resperipheral = mon_cmd($vmid, 'qom-list', path => '/machine/peripheral');
deb091c5 4215 foreach my $per (@$resperipheral) {
c60cad61 4216 if ($per->{name} =~ m/^usb(?:redirdev)?\d+$/) {
deb091c5
DC
4217 $devices->{$per->{name}} = 1;
4218 }
4219 }
4220
1dc4f496 4221 return $devices;
86fdcfb2
DA
4222}
4223
ec21aa11 4224sub vm_deviceplug {
d559309f 4225 my ($storecfg, $conf, $vmid, $deviceid, $device, $arch, $machine_type) = @_;
ae57f6b3 4226
3392d6ca 4227 my $q35 = PVE::QemuServer::Machine::machine_type_is_q35($conf);
db656e5f 4228
95d6343b
DA
4229 my $devices_list = vm_devices_list($vmid);
4230 return 1 if defined($devices_list->{$deviceid});
4231
4df98f2f
TL
4232 # add PCI bridge if we need it for the device
4233 qemu_add_pci_bridge($storecfg, $conf, $vmid, $deviceid, $arch, $machine_type);
fee46675 4234
3d7389fe 4235 if ($deviceid eq 'tablet') {
d559309f 4236 qemu_deviceadd($vmid, print_tabletdevice_full($conf, $arch));
d559309f 4237 } elsif ($deviceid eq 'keyboard') {
d559309f 4238 qemu_deviceadd($vmid, print_keyboarddevice_full($conf, $arch));
c60cad61
DC
4239 } elsif ($deviceid =~ m/^usbredirdev(\d+)$/) {
4240 my $id = $1;
4241 qemu_spice_usbredir_chardev_add($vmid, "usbredirchardev$id");
4242 qemu_deviceadd($vmid, PVE::QemuServer::USB::print_spice_usbdevice($id, "xhci", $id + 1));
4eb68604 4243 } elsif ($deviceid =~ m/^usb(\d+)$/) {
c60cad61 4244 qemu_deviceadd($vmid, PVE::QemuServer::USB::print_usbdevice_full($conf, $deviceid, $device, {}, $1 + 1));
fee46675 4245 } elsif ($deviceid =~ m/^(virtio)(\d+)$/) {
22de899a
AD
4246 qemu_iothread_add($vmid, $deviceid, $device);
4247
3326ae19
TL
4248 qemu_driveadd($storecfg, $vmid, $device);
4249 my $devicefull = print_drivedevice_full($storecfg, $conf, $vmid, $device, undef, $arch, $machine_type);
fee46675 4250
3326ae19 4251 qemu_deviceadd($vmid, $devicefull);
fee46675
DM
4252 eval { qemu_deviceaddverify($vmid, $deviceid); };
4253 if (my $err = $@) {
63c2da2f
DM
4254 eval { qemu_drivedel($vmid, $deviceid); };
4255 warn $@ if $@;
fee46675 4256 die $err;
5e5dcb73 4257 }
2733141c 4258 } elsif ($deviceid =~ m/^(virtioscsi|scsihw)(\d+)$/) {
3326ae19
TL
4259 my $scsihw = defined($conf->{scsihw}) ? $conf->{scsihw} : "lsi";
4260 my $pciaddr = print_pci_addr($deviceid, undef, $arch, $machine_type);
a1b7d579 4261 my $scsihw_type = $scsihw eq 'virtio-scsi-single' ? "virtio-scsi-pci" : $scsihw;
2733141c 4262
3326ae19 4263 my $devicefull = "$scsihw_type,id=$deviceid$pciaddr";
fee46675 4264
fc8b40fd
AD
4265 if($deviceid =~ m/^virtioscsi(\d+)$/ && $device->{iothread}) {
4266 qemu_iothread_add($vmid, $deviceid, $device);
4267 $devicefull .= ",iothread=iothread-$deviceid";
4268 }
4269
6e11f143
AD
4270 if($deviceid =~ m/^virtioscsi(\d+)$/ && $device->{queues}) {
4271 $devicefull .= ",num_queues=$device->{queues}";
4272 }
4273
3326ae19
TL
4274 qemu_deviceadd($vmid, $devicefull);
4275 qemu_deviceaddverify($vmid, $deviceid);
fee46675 4276 } elsif ($deviceid =~ m/^(scsi)(\d+)$/) {
d559309f 4277 qemu_findorcreatescsihw($storecfg,$conf, $vmid, $device, $arch, $machine_type);
fee46675 4278 qemu_driveadd($storecfg, $vmid, $device);
a1b7d579 4279
acfc6ef8 4280 my $devicefull = print_drivedevice_full($storecfg, $conf, $vmid, $device, undef, $arch, $machine_type);
fee46675
DM
4281 eval { qemu_deviceadd($vmid, $devicefull); };
4282 if (my $err = $@) {
63c2da2f
DM
4283 eval { qemu_drivedel($vmid, $deviceid); };
4284 warn $@ if $@;
fee46675 4285 die $err;
a4f091a0 4286 }
fee46675 4287 } elsif ($deviceid =~ m/^(net)(\d+)$/) {
d1c1af4b 4288 return if !qemu_netdevadd($vmid, $conf, $arch, $device, $deviceid);
8718099c 4289
3392d6ca 4290 my $machine_type = PVE::QemuServer::Machine::qemu_machine_pxe($vmid, $conf);
0c03a390 4291 my $machine_version = PVE::QemuServer::Machine::extract_version($machine_type);
95d3be58
DC
4292 my $use_old_bios_files = undef;
4293 ($use_old_bios_files, $machine_type) = qemu_use_old_bios_files($machine_type);
8718099c 4294
4df98f2f 4295 my $netdevicefull = print_netdevice_full(
0c03a390 4296 $vmid, $conf, $device, $deviceid, undef, $use_old_bios_files, $arch, $machine_type, $machine_version);
95d3be58 4297 qemu_deviceadd($vmid, $netdevicefull);
79046fd1
DC
4298 eval {
4299 qemu_deviceaddverify($vmid, $deviceid);
4300 qemu_set_link_status($vmid, $deviceid, !$device->{link_down});
4301 };
fee46675
DM
4302 if (my $err = $@) {
4303 eval { qemu_netdevdel($vmid, $deviceid); };
4304 warn $@ if $@;
4305 die $err;
95d3be58 4306 }
fee46675 4307 } elsif (!$q35 && $deviceid =~ m/^(pci\.)(\d+)$/) {
40f28a9f 4308 my $bridgeid = $2;
d559309f 4309 my $pciaddr = print_pci_addr($deviceid, undef, $arch, $machine_type);
40f28a9f 4310 my $devicefull = "pci-bridge,id=pci.$bridgeid,chassis_nr=$bridgeid$pciaddr";
a1b7d579 4311
40f28a9f 4312 qemu_deviceadd($vmid, $devicefull);
fee46675 4313 qemu_deviceaddverify($vmid, $deviceid);
fee46675 4314 } else {
a1b7d579 4315 die "can't hotplug device '$deviceid'\n";
40f28a9f
AD
4316 }
4317
5e5dcb73 4318 return 1;
a4dea331
DA
4319}
4320
3eec5767 4321# fixme: this should raise exceptions on error!
ec21aa11 4322sub vm_deviceunplug {
f19d1c47 4323 my ($vmid, $conf, $deviceid) = @_;
873c2d69 4324
95d6343b
DA
4325 my $devices_list = vm_devices_list($vmid);
4326 return 1 if !defined($devices_list->{$deviceid});
4327
2141a802
SR
4328 my $bootdisks = PVE::QemuServer::Drive::get_bootdisks($conf);
4329 die "can't unplug bootdisk '$deviceid'\n" if grep {$_ eq $deviceid} @$bootdisks;
63c2da2f 4330
c60cad61 4331 if ($deviceid eq 'tablet' || $deviceid eq 'keyboard' || $deviceid eq 'xhci') {
3d7389fe 4332 qemu_devicedel($vmid, $deviceid);
c60cad61
DC
4333 } elsif ($deviceid =~ m/^usbredirdev\d+$/) {
4334 qemu_devicedel($vmid, $deviceid);
4335 qemu_devicedelverify($vmid, $deviceid);
4eb68604 4336 } elsif ($deviceid =~ m/^usb\d+$/) {
c60cad61
DC
4337 qemu_devicedel($vmid, $deviceid);
4338 qemu_devicedelverify($vmid, $deviceid);
63c2da2f 4339 } elsif ($deviceid =~ m/^(virtio)(\d+)$/) {
9a66c311 4340 my $device = parse_drive($deviceid, $conf->{$deviceid});
f19d1c47 4341
a8d0fec3
TL
4342 qemu_devicedel($vmid, $deviceid);
4343 qemu_devicedelverify($vmid, $deviceid);
4344 qemu_drivedel($vmid, $deviceid);
9a66c311 4345 qemu_iothread_del($vmid, $deviceid, $device);
2733141c 4346 } elsif ($deviceid =~ m/^(virtioscsi|scsihw)(\d+)$/) {
63c2da2f 4347 qemu_devicedel($vmid, $deviceid);
8ce30dde 4348 qemu_devicedelverify($vmid, $deviceid);
63c2da2f 4349 } elsif ($deviceid =~ m/^(scsi)(\d+)$/) {
9a66c311 4350 my $device = parse_drive($deviceid, $conf->{$deviceid});
cfc817c7 4351
a8d0fec3 4352 qemu_devicedel($vmid, $deviceid);
52b361af 4353 qemu_devicedelverify($vmid, $deviceid);
a8d0fec3 4354 qemu_drivedel($vmid, $deviceid);
a1b7d579 4355 qemu_deletescsihw($conf, $vmid, $deviceid);
8ce30dde 4356
9a66c311
FG
4357 qemu_iothread_del($vmid, "virtioscsi$device->{index}", $device)
4358 if $conf->{scsihw} && ($conf->{scsihw} eq 'virtio-scsi-single');
63c2da2f 4359 } elsif ($deviceid =~ m/^(net)(\d+)$/) {
a8d0fec3
TL
4360 qemu_devicedel($vmid, $deviceid);
4361 qemu_devicedelverify($vmid, $deviceid);
4362 qemu_netdevdel($vmid, $deviceid);
63c2da2f
DM
4363 } else {
4364 die "can't unplug device '$deviceid'\n";
2630d2a9
DA
4365 }
4366
5e5dcb73
DA
4367 return 1;
4368}
4369
c60cad61
DC
4370sub qemu_spice_usbredir_chardev_add {
4371 my ($vmid, $id) = @_;
4372
4373 mon_cmd($vmid, "chardev-add" , (
4374 id => $id,
4375 backend => {
4376 type => 'spicevmc',
4377 data => {
4378 type => "usbredir",
4379 },
4380 },
4381 ));
4382}
4383
5e5dcb73
DA
4384sub qemu_deviceadd {
4385 my ($vmid, $devicefull) = @_;
873c2d69 4386
d695b5b7
AD
4387 $devicefull = "driver=".$devicefull;
4388 my %options = split(/[=,]/, $devicefull);
f19d1c47 4389
0a13e08e 4390 mon_cmd($vmid, "device_add" , %options);
5e5dcb73 4391}
afdb31d5 4392
5e5dcb73 4393sub qemu_devicedel {
fee46675 4394 my ($vmid, $deviceid) = @_;
63c2da2f 4395
0a13e08e 4396 my $ret = mon_cmd($vmid, "device_del", id => $deviceid);
5e5dcb73
DA
4397}
4398
22de899a 4399sub qemu_iothread_add {
a8d0fec3 4400 my ($vmid, $deviceid, $device) = @_;
22de899a
AD
4401
4402 if ($device->{iothread}) {
4403 my $iothreads = vm_iothreads_list($vmid);
4404 qemu_objectadd($vmid, "iothread-$deviceid", "iothread") if !$iothreads->{"iothread-$deviceid"};
4405 }
4406}
4407
4408sub qemu_iothread_del {
a8d0fec3 4409 my ($vmid, $deviceid, $device) = @_;
22de899a 4410
22de899a
AD
4411 if ($device->{iothread}) {
4412 my $iothreads = vm_iothreads_list($vmid);
4413 qemu_objectdel($vmid, "iothread-$deviceid") if $iothreads->{"iothread-$deviceid"};
4414 }
4415}
4416
4d3f29ed 4417sub qemu_objectadd {
a8d0fec3 4418 my ($vmid, $objectid, $qomtype) = @_;
4d3f29ed 4419
0a13e08e 4420 mon_cmd($vmid, "object-add", id => $objectid, "qom-type" => $qomtype);
4d3f29ed
AD
4421
4422 return 1;
4423}
4424
4425sub qemu_objectdel {
a8d0fec3 4426 my ($vmid, $objectid) = @_;
4d3f29ed 4427
0a13e08e 4428 mon_cmd($vmid, "object-del", id => $objectid);
4d3f29ed
AD
4429
4430 return 1;
4431}
4432
5e5dcb73 4433sub qemu_driveadd {
fee46675 4434 my ($storecfg, $vmid, $device) = @_;
5e5dcb73 4435
6d5673c3
SR
4436 my $kvmver = get_running_qemu_version($vmid);
4437 my $io_uring = min_version($kvmver, 6, 0);
4438 my $drive = print_drive_commandline_full($storecfg, $vmid, $device, undef, $io_uring);
7a69fc3c 4439 $drive =~ s/\\/\\\\/g;
0a13e08e 4440 my $ret = PVE::QemuServer::Monitor::hmp_cmd($vmid, "drive_add auto \"$drive\"");
fee46675 4441
5e5dcb73 4442 # If the command succeeds qemu prints: "OK"
fee46675
DM
4443 return 1 if $ret =~ m/OK/s;
4444
4445 die "adding drive failed: $ret\n";
5e5dcb73 4446}
afdb31d5 4447
5e5dcb73 4448sub qemu_drivedel {
a8d0fec3 4449 my ($vmid, $deviceid) = @_;
873c2d69 4450
0a13e08e 4451 my $ret = PVE::QemuServer::Monitor::hmp_cmd($vmid, "drive_del drive-$deviceid");
5e5dcb73 4452 $ret =~ s/^\s+//;
a1b7d579 4453
63c2da2f 4454 return 1 if $ret eq "";
a1b7d579 4455
63c2da2f 4456 # NB: device not found errors mean the drive was auto-deleted and we ignore the error
a1b7d579
DM
4457 return 1 if $ret =~ m/Device \'.*?\' not found/s;
4458
63c2da2f 4459 die "deleting drive $deviceid failed : $ret\n";
5e5dcb73 4460}
f19d1c47 4461
5e5dcb73 4462sub qemu_deviceaddverify {
fee46675 4463 my ($vmid, $deviceid) = @_;
873c2d69 4464
5e5dcb73
DA
4465 for (my $i = 0; $i <= 5; $i++) {
4466 my $devices_list = vm_devices_list($vmid);
4467 return 1 if defined($devices_list->{$deviceid});
4468 sleep 1;
afdb31d5 4469 }
fee46675
DM
4470
4471 die "error on hotplug device '$deviceid'\n";
5e5dcb73 4472}
afdb31d5 4473
5e5dcb73
DA
4474
4475sub qemu_devicedelverify {
63c2da2f
DM
4476 my ($vmid, $deviceid) = @_;
4477
a1b7d579 4478 # need to verify that the device is correctly removed as device_del
63c2da2f 4479 # is async and empty return is not reliable
5e5dcb73 4480
5e5dcb73
DA
4481 for (my $i = 0; $i <= 5; $i++) {
4482 my $devices_list = vm_devices_list($vmid);
4483 return 1 if !defined($devices_list->{$deviceid});
4484 sleep 1;
afdb31d5 4485 }
63c2da2f
DM
4486
4487 die "error on hot-unplugging device '$deviceid'\n";
873c2d69
DA
4488}
4489
cdd20088 4490sub qemu_findorcreatescsihw {
d559309f 4491 my ($storecfg, $conf, $vmid, $device, $arch, $machine_type) = @_;
cfc817c7 4492
ee034f5c 4493 my ($maxdev, $controller, $controller_prefix) = scsihw_infos($conf, $device);
2733141c
AD
4494
4495 my $scsihwid="$controller_prefix$controller";
cfc817c7
DA
4496 my $devices_list = vm_devices_list($vmid);
4497
a8d0fec3 4498 if (!defined($devices_list->{$scsihwid})) {
d559309f 4499 vm_deviceplug($storecfg, $conf, $vmid, $scsihwid, $device, $arch, $machine_type);
cfc817c7 4500 }
fee46675 4501
cfc817c7
DA
4502 return 1;
4503}
4504
8ce30dde
AD
4505sub qemu_deletescsihw {
4506 my ($conf, $vmid, $opt) = @_;
4507
4508 my $device = parse_drive($opt, $conf->{$opt});
4509
a1511b3c 4510 if ($conf->{scsihw} && ($conf->{scsihw} eq 'virtio-scsi-single')) {
2733141c
AD
4511 vm_deviceunplug($vmid, $conf, "virtioscsi$device->{index}");
4512 return 1;
4513 }
4514
ee034f5c 4515 my ($maxdev, $controller, $controller_prefix) = scsihw_infos($conf, $device);
8ce30dde
AD
4516
4517 my $devices_list = vm_devices_list($vmid);
4518 foreach my $opt (keys %{$devices_list}) {
e0fd2b2f
FE
4519 if (is_valid_drivename($opt)) {
4520 my $drive = parse_drive($opt, $conf->{$opt});
a8d0fec3 4521 if ($drive->{interface} eq 'scsi' && $drive->{index} < (($maxdev-1)*($controller+1))) {
8ce30dde
AD
4522 return 1;
4523 }
4524 }
4525 }
4526
4527 my $scsihwid="scsihw$controller";
4528
4529 vm_deviceunplug($vmid, $conf, $scsihwid);
4530
4531 return 1;
4532}
4533
281fedb3 4534sub qemu_add_pci_bridge {
d559309f 4535 my ($storecfg, $conf, $vmid, $device, $arch, $machine_type) = @_;
40f28a9f
AD
4536
4537 my $bridges = {};
281fedb3
DM
4538
4539 my $bridgeid;
4540
d559309f 4541 print_pci_addr($device, $bridges, $arch, $machine_type);
40f28a9f
AD
4542
4543 while (my ($k, $v) = each %$bridges) {
4544 $bridgeid = $k;
4545 }
fee46675 4546 return 1 if !defined($bridgeid) || $bridgeid < 1;
281fedb3 4547
40f28a9f
AD
4548 my $bridge = "pci.$bridgeid";
4549 my $devices_list = vm_devices_list($vmid);
4550
281fedb3 4551 if (!defined($devices_list->{$bridge})) {
d559309f 4552 vm_deviceplug($storecfg, $conf, $vmid, $bridge, $arch, $machine_type);
40f28a9f 4553 }
281fedb3 4554
40f28a9f
AD
4555 return 1;
4556}
4557
25088687
DM
4558sub qemu_set_link_status {
4559 my ($vmid, $device, $up) = @_;
4560
0a13e08e 4561 mon_cmd($vmid, "set_link", name => $device,
25088687
DM
4562 up => $up ? JSON::true : JSON::false);
4563}
4564
2630d2a9 4565sub qemu_netdevadd {
d559309f 4566 my ($vmid, $conf, $arch, $device, $deviceid) = @_;
2630d2a9 4567
d559309f 4568 my $netdev = print_netdev_full($vmid, $conf, $arch, $device, $deviceid, 1);
73aa03b8 4569 my %options = split(/[=,]/, $netdev);
2630d2a9 4570
bf5aef9b
DC
4571 if (defined(my $vhost = $options{vhost})) {
4572 $options{vhost} = JSON::boolean(PVE::JSONSchema::parse_boolean($vhost));
4573 }
4574
4575 if (defined(my $queues = $options{queues})) {
4576 $options{queues} = $queues + 0;
4577 }
4578
0a13e08e 4579 mon_cmd($vmid, "netdev_add", %options);
73aa03b8 4580 return 1;
2630d2a9
DA
4581}
4582
4583sub qemu_netdevdel {
4584 my ($vmid, $deviceid) = @_;
4585
0a13e08e 4586 mon_cmd($vmid, "netdev_del", id => $deviceid);
2630d2a9
DA
4587}
4588
16521d63 4589sub qemu_usb_hotplug {
d559309f 4590 my ($storecfg, $conf, $vmid, $deviceid, $device, $arch, $machine_type) = @_;
16521d63
DC
4591
4592 return if !$device;
4593
4594 # remove the old one first
4595 vm_deviceunplug($vmid, $conf, $deviceid);
4596
4597 # check if xhci controller is necessary and available
c60cad61 4598 my $devicelist = vm_devices_list($vmid);
16521d63 4599
c60cad61
DC
4600 if (!$devicelist->{xhci}) {
4601 my $pciaddr = print_pci_addr("xhci", undef, $arch, $machine_type);
4602 qemu_deviceadd($vmid, PVE::QemuServer::USB::print_qemu_xhci_controller($pciaddr));
16521d63 4603 }
c60cad61
DC
4604
4605 # print_usbdevice_full expects the parsed device
16521d63
DC
4606 my $d = parse_usb_device($device->{host});
4607 $d->{usb3} = $device->{usb3};
4608
4609 # add the new one
d559309f 4610 vm_deviceplug($storecfg, $conf, $vmid, $deviceid, $d, $arch, $machine_type);
16521d63
DC
4611}
4612
838776ab 4613sub qemu_cpu_hotplug {
8edc9c08 4614 my ($vmid, $conf, $vcpus) = @_;
838776ab 4615
3392d6ca 4616 my $machine_type = PVE::QemuServer::Machine::get_current_qemu_machine($vmid);
1e881b75 4617
8edc9c08
AD
4618 my $sockets = 1;
4619 $sockets = $conf->{smp} if $conf->{smp}; # old style - no longer iused
4620 $sockets = $conf->{sockets} if $conf->{sockets};
4621 my $cores = $conf->{cores} || 1;
4622 my $maxcpus = $sockets * $cores;
838776ab 4623
8edc9c08 4624 $vcpus = $maxcpus if !$vcpus;
3a11fadb 4625
8edc9c08
AD
4626 die "you can't add more vcpus than maxcpus\n"
4627 if $vcpus > $maxcpus;
3a11fadb 4628
8edc9c08 4629 my $currentvcpus = $conf->{vcpus} || $maxcpus;
1e881b75 4630
eba3e64d 4631 if ($vcpus < $currentvcpus) {
1e881b75 4632
2ea5fb7e 4633 if (PVE::QemuServer::Machine::machine_version($machine_type, 2, 7)) {
1e881b75
AD
4634
4635 for (my $i = $currentvcpus; $i > $vcpus; $i--) {
4636 qemu_devicedel($vmid, "cpu$i");
4637 my $retry = 0;
4638 my $currentrunningvcpus = undef;
4639 while (1) {
65af8c31 4640 $currentrunningvcpus = mon_cmd($vmid, "query-cpus-fast");
1e881b75 4641 last if scalar(@{$currentrunningvcpus}) == $i-1;
961af8a3 4642 raise_param_exc({ vcpus => "error unplugging cpu$i" }) if $retry > 5;
1e881b75
AD
4643 $retry++;
4644 sleep 1;
4645 }
4646 #update conf after each succesfull cpu unplug
4647 $conf->{vcpus} = scalar(@{$currentrunningvcpus});
4648 PVE::QemuConfig->write_config($vmid, $conf);
4649 }
4650 } else {
961af8a3 4651 die "cpu hot-unplugging requires qemu version 2.7 or higher\n";
1e881b75
AD
4652 }
4653
4654 return;
4655 }
838776ab 4656
65af8c31 4657 my $currentrunningvcpus = mon_cmd($vmid, "query-cpus-fast");
961af8a3 4658 die "vcpus in running vm does not match its configuration\n"
8edc9c08 4659 if scalar(@{$currentrunningvcpus}) != $currentvcpus;
838776ab 4660
2ea5fb7e 4661 if (PVE::QemuServer::Machine::machine_version($machine_type, 2, 7)) {
eba3e64d
AD
4662
4663 for (my $i = $currentvcpus+1; $i <= $vcpus; $i++) {
4664 my $cpustr = print_cpu_device($conf, $i);
4665 qemu_deviceadd($vmid, $cpustr);
4666
4667 my $retry = 0;
4668 my $currentrunningvcpus = undef;
4669 while (1) {
65af8c31 4670 $currentrunningvcpus = mon_cmd($vmid, "query-cpus-fast");
eba3e64d 4671 last if scalar(@{$currentrunningvcpus}) == $i;
961af8a3 4672 raise_param_exc({ vcpus => "error hotplugging cpu$i" }) if $retry > 10;
eba3e64d
AD
4673 sleep 1;
4674 $retry++;
4675 }
4676 #update conf after each succesfull cpu hotplug
4677 $conf->{vcpus} = scalar(@{$currentrunningvcpus});
4678 PVE::QemuConfig->write_config($vmid, $conf);
4679 }
4680 } else {
4681
4682 for (my $i = $currentvcpus; $i < $vcpus; $i++) {
0a13e08e 4683 mon_cmd($vmid, "cpu-add", id => int($i));
eba3e64d 4684 }
838776ab
AD
4685 }
4686}
4687
affd2f88 4688sub qemu_block_set_io_throttle {
277ca170
WB
4689 my ($vmid, $deviceid,
4690 $bps, $bps_rd, $bps_wr, $iops, $iops_rd, $iops_wr,
9196a8ec
WB
4691 $bps_max, $bps_rd_max, $bps_wr_max, $iops_max, $iops_rd_max, $iops_wr_max,
4692 $bps_max_length, $bps_rd_max_length, $bps_wr_max_length,
4693 $iops_max_length, $iops_rd_max_length, $iops_wr_max_length) = @_;
affd2f88 4694
f3f323a3
AD
4695 return if !check_running($vmid) ;
4696
0a13e08e 4697 mon_cmd($vmid, "block_set_io_throttle", device => $deviceid,
277ca170
WB
4698 bps => int($bps),
4699 bps_rd => int($bps_rd),
4700 bps_wr => int($bps_wr),
4701 iops => int($iops),
4702 iops_rd => int($iops_rd),
4703 iops_wr => int($iops_wr),
4704 bps_max => int($bps_max),
4705 bps_rd_max => int($bps_rd_max),
4706 bps_wr_max => int($bps_wr_max),
4707 iops_max => int($iops_max),
4708 iops_rd_max => int($iops_rd_max),
9196a8ec
WB
4709 iops_wr_max => int($iops_wr_max),
4710 bps_max_length => int($bps_max_length),
4711 bps_rd_max_length => int($bps_rd_max_length),
4712 bps_wr_max_length => int($bps_wr_max_length),
4713 iops_max_length => int($iops_max_length),
4714 iops_rd_max_length => int($iops_rd_max_length),
4715 iops_wr_max_length => int($iops_wr_max_length),
277ca170 4716 );
f3f323a3 4717
affd2f88
AD
4718}
4719
c1175c92
AD
4720sub qemu_block_resize {
4721 my ($vmid, $deviceid, $storecfg, $volid, $size) = @_;
4722
ed221350 4723 my $running = check_running($vmid);
c1175c92 4724
7246e8f9 4725 $size = 0 if !PVE::Storage::volume_resize($storecfg, $volid, $size, $running);
c1175c92
AD
4726
4727 return if !$running;
4728
375db731
FE
4729 my $padding = (1024 - $size % 1024) % 1024;
4730 $size = $size + $padding;
4731
190c8461
SR
4732 mon_cmd(
4733 $vmid,
4734 "block_resize",
4735 device => $deviceid,
4736 size => int($size),
4737 timeout => 60,
4738 );
c1175c92
AD
4739}
4740
1ab0057c
AD
4741sub qemu_volume_snapshot {
4742 my ($vmid, $deviceid, $storecfg, $volid, $snap) = @_;
4743
ed221350 4744 my $running = check_running($vmid);
1ab0057c 4745
9d83932d 4746 if ($running && do_snapshots_with_qemu($storecfg, $volid, $deviceid)) {
0a13e08e 4747 mon_cmd($vmid, 'blockdev-snapshot-internal-sync', device => $deviceid, name => $snap);
e5eaa028
WL
4748 } else {
4749 PVE::Storage::volume_snapshot($storecfg, $volid, $snap);
4750 }
1ab0057c
AD
4751}
4752
fc46aff9
AD
4753sub qemu_volume_snapshot_delete {
4754 my ($vmid, $deviceid, $storecfg, $volid, $snap) = @_;
4755
ed221350 4756 my $running = check_running($vmid);
fc46aff9 4757
a2f1554b
AD
4758 if($running) {
4759
4760 $running = undef;
4761 my $conf = PVE::QemuConfig->load_config($vmid);
912792e2 4762 PVE::QemuConfig->foreach_volume($conf, sub {
a2f1554b
AD
4763 my ($ds, $drive) = @_;
4764 $running = 1 if $drive->{file} eq $volid;
4765 });
4766 }
4767
9d83932d 4768 if ($running && do_snapshots_with_qemu($storecfg, $volid, $deviceid)) {
0a13e08e 4769 mon_cmd($vmid, 'blockdev-snapshot-delete-internal-sync', device => $deviceid, name => $snap);
1ef7592f
AD
4770 } else {
4771 PVE::Storage::volume_snapshot_delete($storecfg, $volid, $snap, $running);
4772 }
fc46aff9
AD
4773}
4774
264e519f 4775sub set_migration_caps {
27a5be53 4776 my ($vmid, $savevm) = @_;
a89fded1 4777
acc10e51
SR
4778 my $qemu_support = eval { mon_cmd($vmid, "query-proxmox-support") };
4779
27a5be53
SR
4780 my $bitmap_prop = $savevm ? 'pbs-dirty-bitmap-savevm' : 'pbs-dirty-bitmap-migration';
4781 my $dirty_bitmaps = $qemu_support->{$bitmap_prop} ? 1 : 0;
4782
8b8345f3 4783 my $cap_ref = [];
a89fded1
AD
4784
4785 my $enabled_cap = {
8b8345f3 4786 "auto-converge" => 1,
0b0a47e8 4787 "xbzrle" => 1,
8b8345f3
DM
4788 "x-rdma-pin-all" => 0,
4789 "zero-blocks" => 0,
acc10e51 4790 "compress" => 0,
27a5be53 4791 "dirty-bitmaps" => $dirty_bitmaps,
a89fded1
AD
4792 };
4793
0a13e08e 4794 my $supported_capabilities = mon_cmd($vmid, "query-migrate-capabilities");
a89fded1 4795
8b8345f3 4796 for my $supported_capability (@$supported_capabilities) {
b463a3ce
SP
4797 push @$cap_ref, {
4798 capability => $supported_capability->{capability},
22430fa2
DM
4799 state => $enabled_cap->{$supported_capability->{capability}} ? JSON::true : JSON::false,
4800 };
a89fded1
AD
4801 }
4802
0a13e08e 4803 mon_cmd($vmid, "migrate-set-capabilities", capabilities => $cap_ref);
8b8345f3 4804}
a89fded1 4805
912792e2
FE
4806sub foreach_volid {
4807 my ($conf, $func, @param) = @_;
4808
4809 my $volhash = {};
4810
4811 my $test_volid = sub {
ae180b8f 4812 my ($key, $drive, $snapname) = @_;
912792e2 4813
ae180b8f 4814 my $volid = $drive->{file};
912792e2
FE
4815 return if !$volid;
4816
4817 $volhash->{$volid}->{cdrom} //= 1;
ae180b8f 4818 $volhash->{$volid}->{cdrom} = 0 if !drive_is_cdrom($drive);
912792e2 4819
ae180b8f 4820 my $replicate = $drive->{replicate} // 1;
912792e2
FE
4821 $volhash->{$volid}->{replicate} //= 0;
4822 $volhash->{$volid}->{replicate} = 1 if $replicate;
4823
4824 $volhash->{$volid}->{shared} //= 0;
ae180b8f 4825 $volhash->{$volid}->{shared} = 1 if $drive->{shared};
912792e2
FE
4826
4827 $volhash->{$volid}->{referenced_in_config} //= 0;
4828 $volhash->{$volid}->{referenced_in_config} = 1 if !defined($snapname);
4829
4830 $volhash->{$volid}->{referenced_in_snapshot}->{$snapname} = 1
4831 if defined($snapname);
ae180b8f
FE
4832
4833 my $size = $drive->{size};
4834 $volhash->{$volid}->{size} //= $size if $size;
4835
4836 $volhash->{$volid}->{is_vmstate} //= 0;
4837 $volhash->{$volid}->{is_vmstate} = 1 if $key eq 'vmstate';
4838
f9dde219
SR
4839 $volhash->{$volid}->{is_tpmstate} //= 0;
4840 $volhash->{$volid}->{is_tpmstate} = 1 if $key eq 'tpmstate0';
4841
ae180b8f
FE
4842 $volhash->{$volid}->{is_unused} //= 0;
4843 $volhash->{$volid}->{is_unused} = 1 if $key =~ /^unused\d+$/;
a6be63ac
FE
4844
4845 $volhash->{$volid}->{drivename} = $key if is_valid_drivename($key);
912792e2
FE
4846 };
4847
ae180b8f
FE
4848 my $include_opts = {
4849 extra_keys => ['vmstate'],
4850 include_unused => 1,
4851 };
4852
0b953b8e 4853 PVE::QemuConfig->foreach_volume_full($conf, $include_opts, $test_volid);
912792e2
FE
4854 foreach my $snapname (keys %{$conf->{snapshots}}) {
4855 my $snap = $conf->{snapshots}->{$snapname};
0b953b8e 4856 PVE::QemuConfig->foreach_volume_full($snap, $include_opts, $test_volid, $snapname);
912792e2
FE
4857 }
4858
4859 foreach my $volid (keys %$volhash) {
4860 &$func($volid, $volhash->{$volid}, @param);
4861 }
4862}
4863
81d95ae1 4864my $fast_plug_option = {
7498eb64 4865 'lock' => 1,
81d95ae1 4866 'name' => 1,
a1b7d579 4867 'onboot' => 1,
81d95ae1
DM
4868 'shares' => 1,
4869 'startup' => 1,
b0ec896e 4870 'description' => 1,
ec647db4 4871 'protection' => 1,
8cad5e9b 4872 'vmstatestorage' => 1,
9e784b11 4873 'hookscript' => 1,
b8e7068a 4874 'tags' => 1,
81d95ae1
DM
4875};
4876
71d9006b
AD
4877for my $opt (keys %$confdesc_cloudinit) {
4878 $fast_plug_option->{$opt} = 1;
4879};
4880
3a11fadb
DM
4881# hotplug changes in [PENDING]
4882# $selection hash can be used to only apply specified options, for
4883# example: { cores => 1 } (only apply changed 'cores')
4884# $errors ref is used to return error messages
c427973b 4885sub vmconfig_hotplug_pending {
3a11fadb 4886 my ($vmid, $conf, $storecfg, $selection, $errors) = @_;
c427973b 4887
8e90138a 4888 my $defaults = load_defaults();
045749f2
TL
4889 my $arch = get_vm_arch($conf);
4890 my $machine_type = get_vm_machine($conf, undef, $arch);
c427973b
DM
4891
4892 # commit values which do not have any impact on running VM first
3a11fadb
DM
4893 # Note: those option cannot raise errors, we we do not care about
4894 # $selection and always apply them.
4895
4896 my $add_error = sub {
4897 my ($opt, $msg) = @_;
4898 $errors->{$opt} = "hotplug problem - $msg";
4899 };
c427973b
DM
4900
4901 my $changes = 0;
4902 foreach my $opt (keys %{$conf->{pending}}) { # add/change
81d95ae1 4903 if ($fast_plug_option->{$opt}) {
c427973b
DM
4904 $conf->{$opt} = $conf->{pending}->{$opt};
4905 delete $conf->{pending}->{$opt};
4906 $changes = 1;
4907 }
4908 }
4909
4910 if ($changes) {
ffda963f 4911 PVE::QemuConfig->write_config($vmid, $conf);
c427973b
DM
4912 }
4913
c60cad61
DC
4914 my $ostype = $conf->{ostype};
4915 my $version = extract_version($machine_type, get_running_qemu_version($vmid));
b3c2bdd1 4916 my $hotplug_features = parse_hotplug_features(defined($conf->{hotplug}) ? $conf->{hotplug} : '1');
c60cad61
DC
4917 my $usb_hotplug = $hotplug_features->{usb}
4918 && min_version($version, 7, 1)
4919 && defined($ostype) && ($ostype eq 'l26' || windows_version($ostype) > 7);
c427973b 4920
5b65b00d 4921 my $cgroup = PVE::QemuServer::CGroup->new($vmid);
98bc3aeb 4922 my $pending_delete_hash = PVE::QemuConfig->parse_pending_delete($conf->{pending}->{delete});
d321c4a9 4923 foreach my $opt (sort keys %$pending_delete_hash) {
3a11fadb 4924 next if $selection && !$selection->{$opt};
d321c4a9 4925 my $force = $pending_delete_hash->{$opt}->{force};
3a11fadb 4926 eval {
51a6f637
AD
4927 if ($opt eq 'hotplug') {
4928 die "skip\n" if ($conf->{hotplug} =~ /memory/);
4929 } elsif ($opt eq 'tablet') {
b3c2bdd1 4930 die "skip\n" if !$hotplug_features->{usb};
3a11fadb 4931 if ($defaults->{tablet}) {
d559309f
WB
4932 vm_deviceplug($storecfg, $conf, $vmid, 'tablet', $arch, $machine_type);
4933 vm_deviceplug($storecfg, $conf, $vmid, 'keyboard', $arch, $machine_type)
4934 if $arch eq 'aarch64';
3a11fadb 4935 } else {
d559309f
WB
4936 vm_deviceunplug($vmid, $conf, 'tablet');
4937 vm_deviceunplug($vmid, $conf, 'keyboard') if $arch eq 'aarch64';
3a11fadb 4938 }
c60cad61
DC
4939 } elsif ($opt =~ m/^usb(\d+)$/) {
4940 my $index = $1;
4941 die "skip\n" if !$usb_hotplug;
4942 vm_deviceunplug($vmid, $conf, "usbredirdev$index"); # if it's a spice port
4943 vm_deviceunplug($vmid, $conf, $opt);
8edc9c08 4944 } elsif ($opt eq 'vcpus') {
b3c2bdd1 4945 die "skip\n" if !$hotplug_features->{cpu};
8edc9c08 4946 qemu_cpu_hotplug($vmid, $conf, undef);
9c2f7069 4947 } elsif ($opt eq 'balloon') {
81d95ae1 4948 # enable balloon device is not hotpluggable
75b51053
DC
4949 die "skip\n" if defined($conf->{balloon}) && $conf->{balloon} == 0;
4950 # here we reset the ballooning value to memory
4951 my $balloon = $conf->{memory} || $defaults->{memory};
0a13e08e 4952 mon_cmd($vmid, "balloon", value => $balloon*1024*1024);
81d95ae1
DM
4953 } elsif ($fast_plug_option->{$opt}) {
4954 # do nothing
3eec5767 4955 } elsif ($opt =~ m/^net(\d+)$/) {
b3c2bdd1 4956 die "skip\n" if !$hotplug_features->{network};
3eec5767 4957 vm_deviceunplug($vmid, $conf, $opt);
74479ee9 4958 } elsif (is_valid_drivename($opt)) {
b3c2bdd1 4959 die "skip\n" if !$hotplug_features->{disk} || $opt =~ m/(ide|sata)(\d+)/;
19120f99 4960 vm_deviceunplug($vmid, $conf, $opt);
3dc38fbb 4961 vmconfig_delete_or_detach_drive($vmid, $storecfg, $conf, $opt, $force);
4d3f29ed
AD
4962 } elsif ($opt =~ m/^memory$/) {
4963 die "skip\n" if !$hotplug_features->{memory};
6779f1ac 4964 PVE::QemuServer::Memory::qemu_memory_hotplug($vmid, $conf, $defaults, $opt);
c8effec3 4965 } elsif ($opt eq 'cpuunits') {
0d318453 4966 $cgroup->change_cpu_shares(undef);
58be00f1 4967 } elsif ($opt eq 'cpulimit') {
25de70ae 4968 $cgroup->change_cpu_quota(undef, undef); # reset, cgroup module can better decide values
3d7389fe 4969 } else {
e56beeda 4970 die "skip\n";
3d7389fe 4971 }
3a11fadb
DM
4972 };
4973 if (my $err = $@) {
e56beeda
DM
4974 &$add_error($opt, $err) if $err ne "skip\n";
4975 } else {
3a11fadb 4976 delete $conf->{$opt};
98bc3aeb 4977 PVE::QemuConfig->remove_from_pending_delete($conf, $opt);
3d7389fe 4978 }
3d7389fe
DM
4979 }
4980
4981 foreach my $opt (keys %{$conf->{pending}}) {
3a11fadb 4982 next if $selection && !$selection->{$opt};
3d7389fe 4983 my $value = $conf->{pending}->{$opt};
3a11fadb 4984 eval {
51a6f637
AD
4985 if ($opt eq 'hotplug') {
4986 die "skip\n" if ($value =~ /memory/) || ($value !~ /memory/ && $conf->{hotplug} =~ /memory/);
4987 } elsif ($opt eq 'tablet') {
b3c2bdd1 4988 die "skip\n" if !$hotplug_features->{usb};
3a11fadb 4989 if ($value == 1) {
d559309f
WB
4990 vm_deviceplug($storecfg, $conf, $vmid, 'tablet', $arch, $machine_type);
4991 vm_deviceplug($storecfg, $conf, $vmid, 'keyboard', $arch, $machine_type)
4992 if $arch eq 'aarch64';
3a11fadb 4993 } elsif ($value == 0) {
d559309f
WB
4994 vm_deviceunplug($vmid, $conf, 'tablet');
4995 vm_deviceunplug($vmid, $conf, 'keyboard') if $arch eq 'aarch64';
3a11fadb 4996 }
c60cad61
DC
4997 } elsif ($opt =~ m/^usb(\d+)$/) {
4998 my $index = $1;
4999 die "skip\n" if !$usb_hotplug;
5000 my $d = eval { parse_property_string($usbdesc->{format}, $value) };
5001 my $id = $opt;
5002 if ($d->{host} eq 'spice') {
5003 $id = "usbredirdev$index";
5004 }
5005 qemu_usb_hotplug($storecfg, $conf, $vmid, $id, $d, $arch, $machine_type);
8edc9c08 5006 } elsif ($opt eq 'vcpus') {
b3c2bdd1 5007 die "skip\n" if !$hotplug_features->{cpu};
3a11fadb
DM
5008 qemu_cpu_hotplug($vmid, $conf, $value);
5009 } elsif ($opt eq 'balloon') {
81d95ae1 5010 # enable/disable balloning device is not hotpluggable
8fe689e7 5011 my $old_balloon_enabled = !!(!defined($conf->{balloon}) || $conf->{balloon});
a1b7d579 5012 my $new_balloon_enabled = !!(!defined($conf->{pending}->{balloon}) || $conf->{pending}->{balloon});
81d95ae1
DM
5013 die "skip\n" if $old_balloon_enabled != $new_balloon_enabled;
5014
3a11fadb 5015 # allow manual ballooning if shares is set to zero
4cc1efa6 5016 if ((defined($conf->{shares}) && ($conf->{shares} == 0))) {
9c2f7069 5017 my $balloon = $conf->{pending}->{balloon} || $conf->{memory} || $defaults->{memory};
0a13e08e 5018 mon_cmd($vmid, "balloon", value => $balloon*1024*1024);
9c2f7069 5019 }
a1b7d579 5020 } elsif ($opt =~ m/^net(\d+)$/) {
3eec5767 5021 # some changes can be done without hotplug
a1b7d579 5022 vmconfig_update_net($storecfg, $conf, $hotplug_features->{network},
d559309f 5023 $vmid, $opt, $value, $arch, $machine_type);
74479ee9 5024 } elsif (is_valid_drivename($opt)) {
f9dde219 5025 die "skip\n" if $opt eq 'efidisk0' || $opt eq 'tpmstate0';
a05cff86 5026 # some changes can be done without hotplug
9ed7a77c
WB
5027 my $drive = parse_drive($opt, $value);
5028 if (drive_is_cloudinit($drive)) {
71d9006b 5029 PVE::QemuServer::Cloudinit::generate_cloudinitconfig($conf, $vmid);
9ed7a77c 5030 }
b3c2bdd1 5031 vmconfig_update_disk($storecfg, $conf, $hotplug_features->{disk},
9e7bce2c 5032 $vmid, $opt, $value, $arch, $machine_type);
4d3f29ed
AD
5033 } elsif ($opt =~ m/^memory$/) { #dimms
5034 die "skip\n" if !$hotplug_features->{memory};
6779f1ac 5035 $value = PVE::QemuServer::Memory::qemu_memory_hotplug($vmid, $conf, $defaults, $opt, $value);
c8effec3 5036 } elsif ($opt eq 'cpuunits') {
6b7ef5e5 5037 my $new_cpuunits = PVE::CGroup::clamp_cpu_shares($conf->{pending}->{$opt}); #clamp
0d318453 5038 $cgroup->change_cpu_shares($new_cpuunits);
58be00f1 5039 } elsif ($opt eq 'cpulimit') {
c6f773b8 5040 my $cpulimit = $conf->{pending}->{$opt} == 0 ? -1 : int($conf->{pending}->{$opt} * 100000);
5b65b00d 5041 $cgroup->change_cpu_quota($cpulimit, 100000);
74ea2c65
AD
5042 } elsif ($opt eq 'agent') {
5043 vmconfig_update_agent($conf, $opt, $value);
3a11fadb 5044 } else {
e56beeda 5045 die "skip\n"; # skip non-hot-pluggable options
3d7389fe 5046 }
3a11fadb
DM
5047 };
5048 if (my $err = $@) {
e56beeda
DM
5049 &$add_error($opt, $err) if $err ne "skip\n";
5050 } else {
3a11fadb
DM
5051 $conf->{$opt} = $value;
5052 delete $conf->{pending}->{$opt};
3d7389fe 5053 }
3d7389fe 5054 }
c60cad61
DC
5055
5056 # unplug xhci controller if no usb device is left
5057 if ($usb_hotplug) {
5058 my $has_usb = 0;
5059 for (my $i = 0; $i < $MAX_USB_DEVICES; $i++) {
5060 next if !defined($conf->{"usb$i"});
5061 $has_usb = 1;
5062 last;
5063 }
5064 if (!$has_usb) {
5065 vm_deviceunplug($vmid, $conf, 'xhci');
5066 }
5067 }
5068
4df15a03 5069 PVE::QemuConfig->write_config($vmid, $conf);
94ec5e7c
AD
5070
5071 if($hotplug_features->{cloudinit}) {
5072 my $pending = PVE::QemuServer::Cloudinit::get_pending_config($conf, $vmid);
5073 my $regenerate = undef;
5074 for my $item (@$pending) {
5075 $regenerate = 1 if defined($item->{delete}) or defined($item->{pending});
5076 }
5077 PVE::QemuServer::vmconfig_update_cloudinit_drive($storecfg, $conf, $vmid) if $regenerate;
5078 }
c427973b 5079}
055d554d 5080
3dc38fbb
WB
5081sub try_deallocate_drive {
5082 my ($storecfg, $vmid, $conf, $key, $drive, $rpcenv, $authuser, $force) = @_;
5083
5084 if (($force || $key =~ /^unused/) && !drive_is_cdrom($drive, 1)) {
5085 my $volid = $drive->{file};
5086 if (vm_is_volid_owner($storecfg, $vmid, $volid)) {
5087 my $sid = PVE::Storage::parse_volume_id($volid);
5088 $rpcenv->check($authuser, "/storage/$sid", ['Datastore.AllocateSpace']);
cee01bcb
WB
5089
5090 # check if the disk is really unused
cee01bcb 5091 die "unable to delete '$volid' - volume is still in use (snapshot?)\n"
e0fd2b2f 5092 if PVE::QemuServer::Drive::is_volume_in_use($storecfg, $conf, $key, $volid);
cee01bcb 5093 PVE::Storage::vdisk_free($storecfg, $volid);
3dc38fbb 5094 return 1;
40b977f3
WL
5095 } else {
5096 # If vm is not owner of this disk remove from config
5097 return 1;
3dc38fbb
WB
5098 }
5099 }
5100
d1c1af4b 5101 return;
3dc38fbb
WB
5102}
5103
5104sub vmconfig_delete_or_detach_drive {
5105 my ($vmid, $storecfg, $conf, $opt, $force) = @_;
5106
5107 my $drive = parse_drive($opt, $conf->{$opt});
5108
5109 my $rpcenv = PVE::RPCEnvironment::get();
5110 my $authuser = $rpcenv->get_user();
5111
5112 if ($force) {
5113 $rpcenv->check_vm_perm($authuser, $vmid, undef, ['VM.Config.Disk']);
5114 try_deallocate_drive($storecfg, $vmid, $conf, $opt, $drive, $rpcenv, $authuser, $force);
5115 } else {
5116 vmconfig_register_unused_drive($storecfg, $vmid, $conf, $drive);
5117 }
5118}
5119
98bc3aeb
OB
5120
5121
055d554d 5122sub vmconfig_apply_pending {
eb5e482d
OB
5123 my ($vmid, $conf, $storecfg, $errors) = @_;
5124
a644de29
OB
5125 return if !scalar(keys %{$conf->{pending}});
5126
eb5e482d
OB
5127 my $add_apply_error = sub {
5128 my ($opt, $msg) = @_;
5129 my $err_msg = "unable to apply pending change $opt : $msg";
5130 $errors->{$opt} = $err_msg;
5131 warn $err_msg;
5132 };
c427973b
DM
5133
5134 # cold plug
055d554d 5135
98bc3aeb 5136 my $pending_delete_hash = PVE::QemuConfig->parse_pending_delete($conf->{pending}->{delete});
d321c4a9 5137 foreach my $opt (sort keys %$pending_delete_hash) {
fb4d1ba2 5138 my $force = $pending_delete_hash->{$opt}->{force};
eb5e482d 5139 eval {
3d48b95a
OB
5140 if ($opt =~ m/^unused/) {
5141 die "internal error";
5142 } elsif (defined($conf->{$opt}) && is_valid_drivename($opt)) {
eb5e482d 5143 vmconfig_delete_or_detach_drive($vmid, $storecfg, $conf, $opt, $force);
eb5e482d
OB
5144 }
5145 };
5146 if (my $err = $@) {
5147 $add_apply_error->($opt, $err);
055d554d 5148 } else {
98bc3aeb 5149 PVE::QemuConfig->remove_from_pending_delete($conf, $opt);
055d554d 5150 delete $conf->{$opt};
055d554d
DM
5151 }
5152 }
5153
3d48b95a 5154 PVE::QemuConfig->cleanup_pending($conf);
055d554d 5155
c930f99e
AD
5156 my $generate_cloudnit = undef;
5157
055d554d 5158 foreach my $opt (keys %{$conf->{pending}}) { # add/change
3d48b95a 5159 next if $opt eq 'delete'; # just to be sure
eb5e482d 5160 eval {
3d48b95a 5161 if (defined($conf->{$opt}) && is_valid_drivename($opt)) {
eb5e482d 5162 vmconfig_register_unused_drive($storecfg, $vmid, $conf, parse_drive($opt, $conf->{$opt}))
eb5e482d
OB
5163 }
5164 };
5165 if (my $err = $@) {
5166 $add_apply_error->($opt, $err);
055d554d 5167 } else {
c930f99e
AD
5168
5169 if (is_valid_drivename($opt)) {
5170 my $drive = parse_drive($opt, $conf->{pending}->{$opt});
5171 $generate_cloudnit = 1 if drive_is_cloudinit($drive);
5172 }
5173
eb5e482d 5174 $conf->{$opt} = delete $conf->{pending}->{$opt};
055d554d 5175 }
055d554d 5176 }
3d48b95a
OB
5177
5178 # write all changes at once to avoid unnecessary i/o
5179 PVE::QemuConfig->write_config($vmid, $conf);
c930f99e 5180 PVE::QemuServer::Cloudinit::generate_cloudinitconfig($conf, $vmid) if $generate_cloudnit;
055d554d
DM
5181}
5182
3eec5767 5183sub vmconfig_update_net {
d559309f 5184 my ($storecfg, $conf, $hotplug, $vmid, $opt, $value, $arch, $machine_type) = @_;
3eec5767
DM
5185
5186 my $newnet = parse_net($value);
5187
5188 if ($conf->{$opt}) {
5189 my $oldnet = parse_net($conf->{$opt});
5190
0f1af9e7
OB
5191 if (safe_string_ne($oldnet->{model}, $newnet->{model}) ||
5192 safe_string_ne($oldnet->{macaddr}, $newnet->{macaddr}) ||
5193 safe_num_ne($oldnet->{queues}, $newnet->{queues}) ||
3eec5767
DM
5194 !($newnet->{bridge} && $oldnet->{bridge})) { # bridge/nat mode change
5195
5196 # for non online change, we try to hot-unplug
7196b757 5197 die "skip\n" if !$hotplug;
3eec5767
DM
5198 vm_deviceunplug($vmid, $conf, $opt);
5199 } else {
5200
5201 die "internal error" if $opt !~ m/net(\d+)/;
5202 my $iface = "tap${vmid}i$1";
a1b7d579 5203
0f1af9e7
OB
5204 if (safe_string_ne($oldnet->{bridge}, $newnet->{bridge}) ||
5205 safe_num_ne($oldnet->{tag}, $newnet->{tag}) ||
5206 safe_string_ne($oldnet->{trunks}, $newnet->{trunks}) ||
5207 safe_num_ne($oldnet->{firewall}, $newnet->{firewall})) {
3eec5767 5208 PVE::Network::tap_unplug($iface);
28e129cc
AD
5209
5210 if ($have_sdn) {
5211 PVE::Network::SDN::Zones::tap_plug($iface, $newnet->{bridge}, $newnet->{tag}, $newnet->{firewall}, $newnet->{trunks}, $newnet->{rate});
5212 } else {
5213 PVE::Network::tap_plug($iface, $newnet->{bridge}, $newnet->{tag}, $newnet->{firewall}, $newnet->{trunks}, $newnet->{rate});
5214 }
0f1af9e7 5215 } elsif (safe_num_ne($oldnet->{rate}, $newnet->{rate})) {
4f4fbeb0
WB
5216 # Rate can be applied on its own but any change above needs to
5217 # include the rate in tap_plug since OVS resets everything.
5218 PVE::Network::tap_rate_limit($iface, $newnet->{rate});
3eec5767 5219 }
38c590d9 5220
0f1af9e7 5221 if (safe_string_ne($oldnet->{link_down}, $newnet->{link_down})) {
25088687
DM
5222 qemu_set_link_status($vmid, $opt, !$newnet->{link_down});
5223 }
5224
38c590d9 5225 return 1;
3eec5767
DM
5226 }
5227 }
a1b7d579 5228
7196b757 5229 if ($hotplug) {
d559309f 5230 vm_deviceplug($storecfg, $conf, $vmid, $opt, $newnet, $arch, $machine_type);
38c590d9
DM
5231 } else {
5232 die "skip\n";
5233 }
3eec5767
DM
5234}
5235
74ea2c65
AD
5236sub vmconfig_update_agent {
5237 my ($conf, $opt, $value) = @_;
5238
5239 die "skip\n" if !$conf->{$opt};
5240
5241 my $hotplug_options = { fstrim_cloned_disks => 1 };
5242
5243 my $old_agent = parse_guest_agent($conf);
5244 my $agent = parse_guest_agent({$opt => $value});
5245
33f8b887 5246 for my $option (keys %$agent) { # added/changed options
74ea2c65
AD
5247 next if defined($hotplug_options->{$option});
5248 die "skip\n" if safe_string_ne($agent->{$option}, $old_agent->{$option});
5249 }
5250
33f8b887 5251 for my $option (keys %$old_agent) { # removed options
74ea2c65
AD
5252 next if defined($hotplug_options->{$option});
5253 die "skip\n" if safe_string_ne($old_agent->{$option}, $agent->{$option});
5254 }
33f8b887
TL
5255
5256 return; # either no actual change (e.g., format string reordered) or just hotpluggable changes
74ea2c65
AD
5257}
5258
a05cff86 5259sub vmconfig_update_disk {
9e7bce2c 5260 my ($storecfg, $conf, $hotplug, $vmid, $opt, $value, $arch, $machine_type) = @_;
a05cff86
DM
5261
5262 my $drive = parse_drive($opt, $value);
5263
4df98f2f
TL
5264 if ($conf->{$opt} && (my $old_drive = parse_drive($opt, $conf->{$opt}))) {
5265 my $media = $drive->{media} || 'disk';
5266 my $oldmedia = $old_drive->{media} || 'disk';
5267 die "unable to change media type\n" if $media ne $oldmedia;
a05cff86 5268
4df98f2f 5269 if (!drive_is_cdrom($old_drive)) {
a05cff86 5270
4df98f2f 5271 if ($drive->{file} ne $old_drive->{file}) {
a05cff86 5272
4df98f2f 5273 die "skip\n" if !$hotplug;
a05cff86 5274
4df98f2f
TL
5275 # unplug and register as unused
5276 vm_deviceunplug($vmid, $conf, $opt);
5277 vmconfig_register_unused_drive($storecfg, $vmid, $conf, $old_drive)
a1b7d579 5278
4df98f2f
TL
5279 } else {
5280 # update existing disk
5281
5282 # skip non hotpluggable value
5283 if (safe_string_ne($drive->{discard}, $old_drive->{discard}) ||
5284 safe_string_ne($drive->{iothread}, $old_drive->{iothread}) ||
5285 safe_string_ne($drive->{queues}, $old_drive->{queues}) ||
5286 safe_string_ne($drive->{cache}, $old_drive->{cache}) ||
5287 safe_string_ne($drive->{ssd}, $old_drive->{ssd})) {
5288 die "skip\n";
5289 }
a05cff86 5290
4df98f2f
TL
5291 # apply throttle
5292 if (safe_num_ne($drive->{mbps}, $old_drive->{mbps}) ||
5293 safe_num_ne($drive->{mbps_rd}, $old_drive->{mbps_rd}) ||
5294 safe_num_ne($drive->{mbps_wr}, $old_drive->{mbps_wr}) ||
5295 safe_num_ne($drive->{iops}, $old_drive->{iops}) ||
5296 safe_num_ne($drive->{iops_rd}, $old_drive->{iops_rd}) ||
5297 safe_num_ne($drive->{iops_wr}, $old_drive->{iops_wr}) ||
5298 safe_num_ne($drive->{mbps_max}, $old_drive->{mbps_max}) ||
5299 safe_num_ne($drive->{mbps_rd_max}, $old_drive->{mbps_rd_max}) ||
5300 safe_num_ne($drive->{mbps_wr_max}, $old_drive->{mbps_wr_max}) ||
5301 safe_num_ne($drive->{iops_max}, $old_drive->{iops_max}) ||
5302 safe_num_ne($drive->{iops_rd_max}, $old_drive->{iops_rd_max}) ||
5303 safe_num_ne($drive->{iops_wr_max}, $old_drive->{iops_wr_max}) ||
5304 safe_num_ne($drive->{bps_max_length}, $old_drive->{bps_max_length}) ||
5305 safe_num_ne($drive->{bps_rd_max_length}, $old_drive->{bps_rd_max_length}) ||
5306 safe_num_ne($drive->{bps_wr_max_length}, $old_drive->{bps_wr_max_length}) ||
5307 safe_num_ne($drive->{iops_max_length}, $old_drive->{iops_max_length}) ||
5308 safe_num_ne($drive->{iops_rd_max_length}, $old_drive->{iops_rd_max_length}) ||
5309 safe_num_ne($drive->{iops_wr_max_length}, $old_drive->{iops_wr_max_length})) {
5310
5311 qemu_block_set_io_throttle(
5312 $vmid,"drive-$opt",
5313 ($drive->{mbps} || 0)*1024*1024,
5314 ($drive->{mbps_rd} || 0)*1024*1024,
5315 ($drive->{mbps_wr} || 0)*1024*1024,
5316 $drive->{iops} || 0,
5317 $drive->{iops_rd} || 0,
5318 $drive->{iops_wr} || 0,
5319 ($drive->{mbps_max} || 0)*1024*1024,
5320 ($drive->{mbps_rd_max} || 0)*1024*1024,
5321 ($drive->{mbps_wr_max} || 0)*1024*1024,
5322 $drive->{iops_max} || 0,
5323 $drive->{iops_rd_max} || 0,
5324 $drive->{iops_wr_max} || 0,
5325 $drive->{bps_max_length} || 1,
5326 $drive->{bps_rd_max_length} || 1,
5327 $drive->{bps_wr_max_length} || 1,
5328 $drive->{iops_max_length} || 1,
5329 $drive->{iops_rd_max_length} || 1,
5330 $drive->{iops_wr_max_length} || 1,
5331 );
a05cff86 5332
4df98f2f 5333 }
a1b7d579 5334
4df98f2f
TL
5335 return 1;
5336 }
4de1bb25 5337
4df98f2f 5338 } else { # cdrom
a1b7d579 5339
4df98f2f
TL
5340 if ($drive->{file} eq 'none') {
5341 mon_cmd($vmid, "eject", force => JSON::true, id => "$opt");
5342 if (drive_is_cloudinit($old_drive)) {
5343 vmconfig_register_unused_drive($storecfg, $vmid, $conf, $old_drive);
5344 }
5345 } else {
5346 my $path = get_iso_path($storecfg, $vmid, $drive->{file});
ce9fce79 5347
4df98f2f
TL
5348 # force eject if locked
5349 mon_cmd($vmid, "eject", force => JSON::true, id => "$opt");
ce9fce79 5350
4df98f2f
TL
5351 if ($path) {
5352 mon_cmd($vmid, "blockdev-change-medium",
5353 id => "$opt", filename => "$path");
4de1bb25 5354 }
a05cff86 5355 }
4df98f2f
TL
5356
5357 return 1;
a05cff86
DM
5358 }
5359 }
5360
a1b7d579 5361 die "skip\n" if !$hotplug || $opt =~ m/(ide|sata)(\d+)/;
4de1bb25 5362 # hotplug new disks
f7b4356f 5363 PVE::Storage::activate_volumes($storecfg, [$drive->{file}]) if $drive->{file} !~ m|^/dev/.+|;
d559309f 5364 vm_deviceplug($storecfg, $conf, $vmid, $opt, $drive, $arch, $machine_type);
a05cff86
DM
5365}
5366
9687287b
AD
5367sub vmconfig_update_cloudinit_drive {
5368 my ($storecfg, $conf, $vmid) = @_;
5369
5370 my $cloudinit_ds = undef;
5371 my $cloudinit_drive = undef;
5372
5373 PVE::QemuConfig->foreach_volume($conf, sub {
5374 my ($ds, $drive) = @_;
5375 if (PVE::QemuServer::drive_is_cloudinit($drive)) {
5376 $cloudinit_ds = $ds;
5377 $cloudinit_drive = $drive;
5378 }
5379 });
5380
5381 return if !$cloudinit_drive;
5382
5383 PVE::QemuServer::Cloudinit::generate_cloudinitconfig($conf, $vmid);
5384 my $running = PVE::QemuServer::check_running($vmid);
5385
5386 if ($running) {
5387 my $path = PVE::Storage::path($storecfg, $cloudinit_drive->{file});
5388 if ($path) {
5389 mon_cmd($vmid, "eject", force => JSON::true, id => "$cloudinit_ds");
5390 mon_cmd($vmid, "blockdev-change-medium", id => "$cloudinit_ds", filename => "$path");
5391 }
5392 }
5393}
5394
13cfe3b7 5395# called in locked context by incoming migration
ba5396b5
FG
5396sub vm_migrate_get_nbd_disks {
5397 my ($storecfg, $conf, $replicated_volumes) = @_;
13cfe3b7
FG
5398
5399 my $local_volumes = {};
912792e2 5400 PVE::QemuConfig->foreach_volume($conf, sub {
13cfe3b7
FG
5401 my ($ds, $drive) = @_;
5402
5403 return if drive_is_cdrom($drive);
41c8671e 5404 return if $ds eq 'tpmstate0';
13cfe3b7
FG
5405
5406 my $volid = $drive->{file};
5407
5408 return if !$volid;
5409
5410 my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid);
5411
5412 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
5413 return if $scfg->{shared};
ba5396b5
FG
5414
5415 # replicated disks re-use existing state via bitmap
5416 my $use_existing = $replicated_volumes->{$volid} ? 1 : 0;
5417 $local_volumes->{$ds} = [$volid, $storeid, $volname, $drive, $use_existing];
13cfe3b7 5418 });
ba5396b5
FG
5419 return $local_volumes;
5420}
5421
5422# called in locked context by incoming migration
5423sub vm_migrate_alloc_nbd_disks {
5424 my ($storecfg, $vmid, $source_volumes, $storagemap) = @_;
13cfe3b7 5425
13cfe3b7 5426 my $nbd = {};
ba5396b5 5427 foreach my $opt (sort keys %$source_volumes) {
5668463b 5428 my ($volid, $storeid, $volname, $drive, $use_existing, $format) = @{$source_volumes->{$opt}};
ba5396b5
FG
5429
5430 if ($use_existing) {
5431 $nbd->{$opt}->{drivestr} = print_drive($drive);
5432 $nbd->{$opt}->{volid} = $volid;
5433 $nbd->{$opt}->{replicated} = 1;
13cfe3b7
FG
5434 next;
5435 }
13cfe3b7 5436
5668463b
FG
5437 # storage mapping + volname = regular migration
5438 # storage mapping + format = remote migration
5439 # order of precedence, filtered by whether storage supports it:
5440 # 1. explicit requested format
5441 # 2. format of current volume
5442 # 3. default format of storage
bf8fc5a3 5443 if (!$storagemap->{identity}) {
82a03671 5444 $storeid = PVE::JSONSchema::map_id($storagemap, $storeid);
13cfe3b7 5445 my ($defFormat, $validFormats) = PVE::Storage::storage_default_format($storecfg, $storeid);
5668463b
FG
5446 if (!$format || !grep { $format eq $_ } @$validFormats) {
5447 if ($volname) {
5448 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
5449 my $fileFormat = qemu_img_format($scfg, $volname);
5450 $format = $fileFormat
5451 if grep { $fileFormat eq $_ } @$validFormats;
5452 }
5453 $format //= $defFormat;
5454 }
13cfe3b7 5455 } else {
5668463b 5456 # can't happen for remote migration, so $volname is always defined
13cfe3b7
FG
5457 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
5458 $format = qemu_img_format($scfg, $volname);
5459 }
5460
4df98f2f
TL
5461 my $size = $drive->{size} / 1024;
5462 my $newvolid = PVE::Storage::vdisk_alloc($storecfg, $storeid, $vmid, $format, undef, $size);
13cfe3b7
FG
5463 my $newdrive = $drive;
5464 $newdrive->{format} = $format;
5465 $newdrive->{file} = $newvolid;
5466 my $drivestr = print_drive($newdrive);
ba5396b5
FG
5467 $nbd->{$opt}->{drivestr} = $drivestr;
5468 $nbd->{$opt}->{volid} = $newvolid;
13cfe3b7
FG
5469 }
5470
5471 return $nbd;
5472}
5473
5474# see vm_start_nolock for parameters, additionally:
5475# migrate_opts:
bf8fc5a3 5476# storagemap = parsed storage map for allocating NBD disks
3898a563
FG
5477sub vm_start {
5478 my ($storecfg, $vmid, $params, $migrate_opts) = @_;
5479
84da8217 5480 return PVE::QemuConfig->lock_config($vmid, sub {
3898a563
FG
5481 my $conf = PVE::QemuConfig->load_config($vmid, $migrate_opts->{migratedfrom});
5482
4ef13a7f
FG
5483 die "you can't start a vm if it's a template\n"
5484 if !$params->{skiptemplate} && PVE::QemuConfig->is_template($conf);
3898a563 5485
d544e0e0 5486 my $has_suspended_lock = PVE::QemuConfig->has_lock($conf, 'suspended');
8e0c97bb
SR
5487 my $has_backup_lock = PVE::QemuConfig->has_lock($conf, 'backup');
5488
5489 my $running = check_running($vmid, undef, $migrate_opts->{migratedfrom});
5490
5491 if ($has_backup_lock && $running) {
5492 # a backup is currently running, attempt to start the guest in the
5493 # existing QEMU instance
5494 return vm_resume($vmid);
5495 }
3898a563
FG
5496
5497 PVE::QemuConfig->check_lock($conf)
d544e0e0
FE
5498 if !($params->{skiplock} || $has_suspended_lock);
5499
5500 $params->{resume} = $has_suspended_lock || defined($conf->{vmstate});
3898a563 5501
8e0c97bb 5502 die "VM $vmid already running\n" if $running;
3898a563 5503
ba5396b5
FG
5504 if (my $storagemap = $migrate_opts->{storagemap}) {
5505 my $replicated = $migrate_opts->{replicated_volumes};
5506 my $disks = vm_migrate_get_nbd_disks($storecfg, $conf, $replicated);
5507 $migrate_opts->{nbd} = vm_migrate_alloc_nbd_disks($storecfg, $vmid, $disks, $storagemap);
5508
5509 foreach my $opt (keys %{$migrate_opts->{nbd}}) {
5510 $conf->{$opt} = $migrate_opts->{nbd}->{$opt}->{drivestr};
5511 }
5512 }
13cfe3b7 5513
84da8217 5514 return vm_start_nolock($storecfg, $vmid, $conf, $params, $migrate_opts);
3898a563
FG
5515 });
5516}
5517
5518
0c498cca
FG
5519# params:
5520# statefile => 'tcp', 'unix' for migration or path/volid for RAM state
5521# skiplock => 0/1, skip checking for config lock
4ef13a7f 5522# skiptemplate => 0/1, skip checking whether VM is template
0c498cca 5523# forcemachine => to force Qemu machine (rollback/migration)
58c64ad5 5524# forcecpu => a QEMU '-cpu' argument string to override get_cpu_options
0c498cca
FG
5525# timeout => in seconds
5526# paused => start VM in paused state (backup)
3898a563 5527# resume => resume from hibernation
5921764c
SR
5528# pbs-backing => {
5529# sata0 => {
5530# repository
5531# snapshot
5532# keyfile
5533# archive
5534# },
5535# virtio2 => ...
5536# }
0c498cca 5537# migrate_opts:
ba5396b5 5538# nbd => volumes for NBD exports (vm_migrate_alloc_nbd_disks)
0c498cca
FG
5539# migratedfrom => source node
5540# spice_ticket => used for spice migration, passed via tunnel/stdin
5541# network => CIDR of migration network
5542# type => secure/insecure - tunnel over encrypted connection or plain-text
0c498cca 5543# nbd_proto_version => int, 0 for TCP, 1 for UNIX
fd95d780 5544# replicated_volumes => which volids should be re-used with bitmaps for nbd migration
13d121d7
FE
5545# offline_volumes => new volids of offline migrated disks like tpmstate and cloudinit, not yet
5546# contained in config
3898a563
FG
5547sub vm_start_nolock {
5548 my ($storecfg, $vmid, $conf, $params, $migrate_opts) = @_;
1e3baf05 5549
3898a563
FG
5550 my $statefile = $params->{statefile};
5551 my $resume = $params->{resume};
3dcb98d5 5552
3898a563
FG
5553 my $migratedfrom = $migrate_opts->{migratedfrom};
5554 my $migration_type = $migrate_opts->{type};
7ceade4c 5555
84da8217
FG
5556 my $res = {};
5557
3898a563
FG
5558 # clean up leftover reboot request files
5559 eval { clear_reboot_request($vmid); };
5560 warn $@ if $@;
1e3baf05 5561
3898a563
FG
5562 if (!$statefile && scalar(keys %{$conf->{pending}})) {
5563 vmconfig_apply_pending($vmid, $conf, $storecfg);
5564 $conf = PVE::QemuConfig->load_config($vmid); # update/reload
5565 }
64457ed4 5566
104f47a9
ML
5567 # don't regenerate the ISO if the VM is started as part of a live migration
5568 # this way we can reuse the old ISO with the correct config
5569 PVE::QemuServer::Cloudinit::generate_cloudinitconfig($conf, $vmid) if !$migratedfrom;
055d554d 5570
13d121d7
FE
5571 # override offline migrated volumes, conf is out of date still
5572 if (my $offline_volumes = $migrate_opts->{offline_volumes}) {
5573 for my $key (sort keys $offline_volumes->%*) {
5574 my $parsed = parse_drive($key, $conf->{$key});
5575 $parsed->{file} = $offline_volumes->{$key};
5576 $conf->{$key} = print_drive($parsed);
5577 }
fd95d780
FG
5578 }
5579
3898a563 5580 my $defaults = load_defaults();
0c9a7596 5581
3898a563
FG
5582 # set environment variable useful inside network script
5583 $ENV{PVE_MIGRATED_FROM} = $migratedfrom if $migratedfrom;
6c47d546 5584
3898a563 5585 PVE::GuestHelpers::exec_hookscript($conf, $vmid, 'pre-start', 1);
9e784b11 5586
3898a563 5587 my $forcemachine = $params->{forcemachine};
ea1c2110 5588 my $forcecpu = $params->{forcecpu};
3898a563 5589 if ($resume) {
ea1c2110 5590 # enforce machine and CPU type on suspended vm to ensure HW compatibility
3898a563 5591 $forcemachine = $conf->{runningmachine};
ea1c2110 5592 $forcecpu = $conf->{runningcpu};
3898a563
FG
5593 print "Resuming suspended VM\n";
5594 }
7ceade4c 5595
5921764c
SR
5596 my ($cmd, $vollist, $spice_port) = config_to_command($storecfg, $vmid,
5597 $conf, $defaults, $forcemachine, $forcecpu, $params->{'pbs-backing'});
6c47d546 5598
3898a563
FG
5599 my $migration_ip;
5600 my $get_migration_ip = sub {
5601 my ($nodename) = @_;
b24e1ac2 5602
3898a563 5603 return $migration_ip if defined($migration_ip);
b24e1ac2 5604
3898a563 5605 my $cidr = $migrate_opts->{network};
0c498cca 5606
3898a563
FG
5607 if (!defined($cidr)) {
5608 my $dc_conf = PVE::Cluster::cfs_read_file('datacenter.cfg');
5609 $cidr = $dc_conf->{migration}->{network};
5610 }
b24e1ac2 5611
3898a563
FG
5612 if (defined($cidr)) {
5613 my $ips = PVE::Network::get_local_ip_from_cidr($cidr);
b24e1ac2 5614
3898a563
FG
5615 die "could not get IP: no address configured on local " .
5616 "node for network '$cidr'\n" if scalar(@$ips) == 0;
b24e1ac2 5617
3898a563
FG
5618 die "could not get IP: multiple addresses configured on local " .
5619 "node for network '$cidr'\n" if scalar(@$ips) > 1;
b24e1ac2 5620
3898a563
FG
5621 $migration_ip = @$ips[0];
5622 }
b24e1ac2 5623
3898a563
FG
5624 $migration_ip = PVE::Cluster::remote_node_ip($nodename, 1)
5625 if !defined($migration_ip);
b24e1ac2 5626
3898a563
FG
5627 return $migration_ip;
5628 };
b24e1ac2 5629
3898a563
FG
5630 my $migrate_uri;
5631 if ($statefile) {
5632 if ($statefile eq 'tcp') {
5633 my $localip = "localhost";
5634 my $datacenterconf = PVE::Cluster::cfs_read_file('datacenter.cfg');
5635 my $nodename = nodename();
2de2d6f7 5636
3898a563
FG
5637 if (!defined($migration_type)) {
5638 if (defined($datacenterconf->{migration}->{type})) {
5639 $migration_type = $datacenterconf->{migration}->{type};
5640 } else {
5641 $migration_type = 'secure';
b7a5a225 5642 }
3898a563 5643 }
b7a5a225 5644
3898a563
FG
5645 if ($migration_type eq 'insecure') {
5646 $localip = $get_migration_ip->($nodename);
5647 $localip = "[$localip]" if Net::IP::ip_is_ipv6($localip);
5648 }
2de2d6f7 5649
3898a563
FG
5650 my $pfamily = PVE::Tools::get_host_address_family($nodename);
5651 my $migrate_port = PVE::Tools::next_migrate_port($pfamily);
5652 $migrate_uri = "tcp:${localip}:${migrate_port}";
5653 push @$cmd, '-incoming', $migrate_uri;
5654 push @$cmd, '-S';
1c9d54bf 5655
3898a563
FG
5656 } elsif ($statefile eq 'unix') {
5657 # should be default for secure migrations as a ssh TCP forward
5658 # tunnel is not deterministic reliable ready and fails regurarly
5659 # to set up in time, so use UNIX socket forwards
5660 my $socket_addr = "/run/qemu-server/$vmid.migrate";
5661 unlink $socket_addr;
54323eed 5662
3898a563 5663 $migrate_uri = "unix:$socket_addr";
1c9d54bf 5664
3898a563
FG
5665 push @$cmd, '-incoming', $migrate_uri;
5666 push @$cmd, '-S';
1c9d54bf 5667
3898a563
FG
5668 } elsif (-e $statefile) {
5669 push @$cmd, '-loadstate', $statefile;
5670 } else {
5671 my $statepath = PVE::Storage::path($storecfg, $statefile);
5672 push @$vollist, $statefile;
5673 push @$cmd, '-loadstate', $statepath;
5674 }
5675 } elsif ($params->{paused}) {
5676 push @$cmd, '-S';
5677 }
5678
1fb1822e
DC
5679 my $start_timeout = $params->{timeout} // config_aware_timeout($conf, $resume);
5680
5681 my $pci_devices = {}; # host pci devices
74c17b7a 5682 for (my $i = 0; $i < $PVE::QemuServer::PCI::MAX_HOSTPCI_DEVICES; $i++) {
1fb1822e
DC
5683 my $dev = $conf->{"hostpci$i"} or next;
5684 $pci_devices->{$i} = parse_hostpci($dev);
5685 }
5686
9c85548f
DC
5687 # do not reserve pciid for mediated devices, sysfs will error out for duplicate assignment
5688 my $real_pci_devices = [ grep { !(defined($_->{mdev}) && scalar($_->{pciid}->@*) == 1) } values $pci_devices->%* ];
5689
5690 # map to a flat list of pci ids
5691 my $pci_id_list = [ map { $_->{id} } map { $_->{pciid}->@* } $real_pci_devices->@* ];
5692
1fb1822e
DC
5693 # reserve all PCI IDs before actually doing anything with them
5694 PVE::QemuServer::PCI::reserve_pci_usage($pci_id_list, $vmid, $start_timeout);
5695
5696 eval {
bbf96e0f 5697 my $uuid;
1fb1822e
DC
5698 for my $id (sort keys %$pci_devices) {
5699 my $d = $pci_devices->{$id};
5700 for my $dev ($d->{pciid}->@*) {
bbf96e0f
DC
5701 my $info = PVE::QemuServer::PCI::prepare_pci_device($vmid, $dev->{id}, $id, $d->{mdev});
5702
5703 # nvidia grid needs the uuid of the mdev as qemu parameter
5704 if ($d->{mdev} && !defined($uuid) && $info->{vendor} eq '10de') {
5705 $uuid = PVE::QemuServer::PCI::generate_mdev_uuid($vmid, $id);
5706 }
1fb1822e
DC
5707 }
5708 }
bbf96e0f 5709 push @$cmd, '-uuid', $uuid if defined($uuid);
1fb1822e
DC
5710 };
5711 if (my $err = $@) {
1b189121 5712 eval { cleanup_pci_devices($vmid, $conf) };
1fb1822e
DC
5713 warn $@ if $@;
5714 die $err;
3898a563 5715 }
1e3baf05 5716
3898a563 5717 PVE::Storage::activate_volumes($storecfg, $vollist);
1e3baf05 5718
3898a563 5719 eval {
6bbcd71f 5720 run_command(['/bin/systemctl', 'stop', "$vmid.scope"], outfunc => sub{}, errfunc => sub{});
3898a563
FG
5721 };
5722 # Issues with the above 'stop' not being fully completed are extremely rare, a very low
5723 # timeout should be more than enough here...
39abafc8 5724 PVE::Systemd::wait_for_unit_removed("$vmid.scope", 20);
3898a563 5725
6b7ef5e5 5726 my $cpuunits = PVE::CGroup::clamp_cpu_shares($conf->{cpuunits});
3898a563 5727
3898a563
FG
5728 my %run_params = (
5729 timeout => $statefile ? undef : $start_timeout,
5730 umask => 0077,
5731 noerr => 1,
5732 );
1e3baf05 5733
3898a563
FG
5734 # when migrating, prefix QEMU output so other side can pick up any
5735 # errors that might occur and show the user
5736 if ($migratedfrom) {
5737 $run_params{quiet} = 1;
5738 $run_params{logfunc} = sub { print "QEMU: $_[0]\n" };
5739 }
8bf30c2a 5740
212220a4 5741 my %systemd_properties = (
3898a563 5742 Slice => 'qemu.slice',
354e61aa
SR
5743 KillMode => 'process',
5744 SendSIGKILL => 0,
5745 TimeoutStopUSec => ULONG_MAX, # infinity
3898a563 5746 );
7023f3ea 5747
6cbd3eb8 5748 if (PVE::CGroup::cgroup_mode() == 2) {
212220a4 5749 $systemd_properties{CPUWeight} = $cpuunits;
6cbd3eb8 5750 } else {
212220a4 5751 $systemd_properties{CPUShares} = $cpuunits;
6cbd3eb8
AD
5752 }
5753
3898a563 5754 if (my $cpulimit = $conf->{cpulimit}) {
212220a4 5755 $systemd_properties{CPUQuota} = int($cpulimit * 100);
3898a563 5756 }
212220a4 5757 $systemd_properties{timeout} = 10 if $statefile; # setting up the scope shoul be quick
7023f3ea 5758
3898a563
FG
5759 my $run_qemu = sub {
5760 PVE::Tools::run_fork sub {
212220a4 5761 PVE::Systemd::enter_systemd_scope($vmid, "Proxmox VE VM $vmid", %systemd_properties);
6e0216d8 5762
f9dde219
SR
5763 my $tpmpid;
5764 if (my $tpm = $conf->{tpmstate0}) {
5765 # start the TPM emulator so QEMU can connect on start
5766 $tpmpid = start_swtpm($storecfg, $vmid, $tpm, $migratedfrom);
5767 }
5768
3898a563 5769 my $exitcode = run_command($cmd, %run_params);
f9dde219 5770 if ($exitcode) {
23bee97d
FE
5771 if ($tpmpid) {
5772 warn "stopping swtpm instance (pid $tpmpid) due to QEMU startup error\n";
5773 kill 'TERM', $tpmpid;
5774 }
f9dde219
SR
5775 die "QEMU exited with code $exitcode\n";
5776 }
503308ed 5777 };
3898a563 5778 };
503308ed 5779
3898a563 5780 if ($conf->{hugepages}) {
7023f3ea 5781
3898a563
FG
5782 my $code = sub {
5783 my $hugepages_topology = PVE::QemuServer::Memory::hugepages_topology($conf);
5784 my $hugepages_host_topology = PVE::QemuServer::Memory::hugepages_host_topology();
7023f3ea 5785
3898a563
FG
5786 PVE::QemuServer::Memory::hugepages_mount();
5787 PVE::QemuServer::Memory::hugepages_allocate($hugepages_topology, $hugepages_host_topology);
7023f3ea 5788
503308ed 5789 eval { $run_qemu->() };
3898a563 5790 if (my $err = $@) {
f36e9894
SR
5791 PVE::QemuServer::Memory::hugepages_reset($hugepages_host_topology)
5792 if !$conf->{keephugepages};
3898a563
FG
5793 die $err;
5794 }
77cde36b 5795
f36e9894
SR
5796 PVE::QemuServer::Memory::hugepages_pre_deallocate($hugepages_topology)
5797 if !$conf->{keephugepages};
3898a563
FG
5798 };
5799 eval { PVE::QemuServer::Memory::hugepages_update_locked($code); };
1e3baf05 5800
3898a563
FG
5801 } else {
5802 eval { $run_qemu->() };
5803 }
afdb31d5 5804
3898a563
FG
5805 if (my $err = $@) {
5806 # deactivate volumes if start fails
5807 eval { PVE::Storage::deactivate_volumes($storecfg, $vollist); };
1b189121
DC
5808 warn $@ if $@;
5809 eval { cleanup_pci_devices($vmid, $conf) };
5810 warn $@ if $@;
1fb1822e 5811
3898a563
FG
5812 die "start failed: $err";
5813 }
62de2cbd 5814
1fb1822e
DC
5815 # re-reserve all PCI IDs now that we can know the actual VM PID
5816 my $pid = PVE::QemuServer::Helpers::vm_running_locally($vmid);
5817 eval { PVE::QemuServer::PCI::reserve_pci_usage($pci_id_list, $vmid, undef, $pid) };
5818 warn $@ if $@;
5819
3898a563 5820 print "migration listens on $migrate_uri\n" if $migrate_uri;
84da8217 5821 $res->{migrate_uri} = $migrate_uri;
eb8cddb5 5822
3898a563
FG
5823 if ($statefile && $statefile ne 'tcp' && $statefile ne 'unix') {
5824 eval { mon_cmd($vmid, "cont"); };
5825 warn $@ if $@;
5826 }
2189246c 5827
3898a563 5828 #start nbd server for storage migration
13cfe3b7 5829 if (my $nbd = $migrate_opts->{nbd}) {
3898a563 5830 my $nbd_protocol_version = $migrate_opts->{nbd_proto_version} // 0;
2189246c 5831
3898a563
FG
5832 my $migrate_storage_uri;
5833 # nbd_protocol_version > 0 for unix socket support
5834 if ($nbd_protocol_version > 0 && $migration_type eq 'secure') {
5835 my $socket_path = "/run/qemu-server/$vmid\_nbd.migrate";
5836 mon_cmd($vmid, "nbd-server-start", addr => { type => 'unix', data => { path => $socket_path } } );
5837 $migrate_storage_uri = "nbd:unix:$socket_path";
5838 } else {
5839 my $nodename = nodename();
5840 my $localip = $get_migration_ip->($nodename);
5841 my $pfamily = PVE::Tools::get_host_address_family($nodename);
5842 my $storage_migrate_port = PVE::Tools::next_migrate_port($pfamily);
5843
4df98f2f
TL
5844 mon_cmd($vmid, "nbd-server-start", addr => {
5845 type => 'inet',
5846 data => {
5847 host => "${localip}",
5848 port => "${storage_migrate_port}",
5849 },
5850 });
3898a563
FG
5851 $localip = "[$localip]" if Net::IP::ip_is_ipv6($localip);
5852 $migrate_storage_uri = "nbd:${localip}:${storage_migrate_port}";
2189246c
AD
5853 }
5854
84da8217
FG
5855 $res->{migrate_storage_uri} = $migrate_storage_uri;
5856
13cfe3b7 5857 foreach my $opt (sort keys %$nbd) {
ba5396b5
FG
5858 my $drivestr = $nbd->{$opt}->{drivestr};
5859 my $volid = $nbd->{$opt}->{volid};
3898a563 5860 mon_cmd($vmid, "nbd-server-add", device => "drive-$opt", writable => JSON::true );
84da8217
FG
5861 my $nbd_uri = "$migrate_storage_uri:exportname=drive-$opt";
5862 print "storage migration listens on $nbd_uri volume:$drivestr\n";
ba5396b5
FG
5863 print "re-using replicated volume: $opt - $volid\n"
5864 if $nbd->{$opt}->{replicated};
84da8217
FG
5865
5866 $res->{drives}->{$opt} = $nbd->{$opt};
5867 $res->{drives}->{$opt}->{nbd_uri} = $nbd_uri;
3898a563
FG
5868 }
5869 }
a89fded1 5870
3898a563
FG
5871 if ($migratedfrom) {
5872 eval {
5873 set_migration_caps($vmid);
5874 };
5875 warn $@ if $@;
5876
5877 if ($spice_port) {
5878 print "spice listens on port $spice_port\n";
84da8217 5879 $res->{spice_port} = $spice_port;
3898a563 5880 if ($migrate_opts->{spice_ticket}) {
4df98f2f
TL
5881 mon_cmd($vmid, "set_password", protocol => 'spice', password =>
5882 $migrate_opts->{spice_ticket});
3898a563 5883 mon_cmd($vmid, "expire_password", protocol => 'spice', time => "+30");
95a4b4a9 5884 }
3898a563 5885 }
95a4b4a9 5886
3898a563
FG
5887 } else {
5888 mon_cmd($vmid, "balloon", value => $conf->{balloon}*1024*1024)
5889 if !$statefile && $conf->{balloon};
25088687 5890
3898a563
FG
5891 foreach my $opt (keys %$conf) {
5892 next if $opt !~ m/^net\d+$/;
5893 my $nicconf = parse_net($conf->{$opt});
5894 qemu_set_link_status($vmid, $opt, 0) if $nicconf->{link_down};
e18b0b99 5895 }
21947fea 5896 add_nets_bridge_fdb($conf, $vmid);
3898a563 5897 }
a1b7d579 5898
3898a563
FG
5899 mon_cmd($vmid, 'qom-set',
5900 path => "machine/peripheral/balloon0",
5901 property => "guest-stats-polling-interval",
5902 value => 2) if (!defined($conf->{balloon}) || $conf->{balloon});
eb065317 5903
3898a563
FG
5904 if ($resume) {
5905 print "Resumed VM, removing state\n";
5906 if (my $vmstate = $conf->{vmstate}) {
5907 PVE::Storage::deactivate_volumes($storecfg, [$vmstate]);
5908 PVE::Storage::vdisk_free($storecfg, $vmstate);
7ceade4c 5909 }
ea1c2110 5910 delete $conf->@{qw(lock vmstate runningmachine runningcpu)};
3898a563
FG
5911 PVE::QemuConfig->write_config($vmid, $conf);
5912 }
7ceade4c 5913
3898a563 5914 PVE::GuestHelpers::exec_hookscript($conf, $vmid, 'post-start');
84da8217
FG
5915
5916 return $res;
1e3baf05
DM
5917}
5918
1e3baf05 5919sub vm_commandline {
b14477e7 5920 my ($storecfg, $vmid, $snapname) = @_;
1e3baf05 5921
ffda963f 5922 my $conf = PVE::QemuConfig->load_config($vmid);
1e3baf05 5923
e8a26810 5924 my ($forcemachine, $forcecpu);
b14477e7
RV
5925 if ($snapname) {
5926 my $snapshot = $conf->{snapshots}->{$snapname};
87d92707
TL
5927 die "snapshot '$snapname' does not exist\n" if !defined($snapshot);
5928
ea1c2110
SR
5929 # check for machine or CPU overrides in snapshot
5930 $forcemachine = $snapshot->{runningmachine};
5931 $forcecpu = $snapshot->{runningcpu};
092868c4 5932
87d92707 5933 $snapshot->{digest} = $conf->{digest}; # keep file digest for API
b14477e7 5934
b14477e7
RV
5935 $conf = $snapshot;
5936 }
5937
1e3baf05
DM
5938 my $defaults = load_defaults();
5939
e8a26810 5940 my $cmd = config_to_command($storecfg, $vmid, $conf, $defaults, $forcemachine, $forcecpu);
1e3baf05 5941
5930c1ff 5942 return PVE::Tools::cmd2string($cmd);
1e3baf05
DM
5943}
5944
5945sub vm_reset {
5946 my ($vmid, $skiplock) = @_;
5947
ffda963f 5948 PVE::QemuConfig->lock_config($vmid, sub {
1e3baf05 5949
ffda963f 5950 my $conf = PVE::QemuConfig->load_config($vmid);
1e3baf05 5951
ffda963f 5952 PVE::QemuConfig->check_lock($conf) if !$skiplock;
1e3baf05 5953
0a13e08e 5954 mon_cmd($vmid, "system_reset");
ff1a2432
DM
5955 });
5956}
5957
5958sub get_vm_volumes {
5959 my ($conf) = @_;
1e3baf05 5960
ff1a2432 5961 my $vollist = [];
d5769dc2 5962 foreach_volid($conf, sub {
392f8b5d 5963 my ($volid, $attr) = @_;
ff1a2432 5964
d5769dc2 5965 return if $volid =~ m|^/|;
ff1a2432 5966
d5769dc2
DM
5967 my ($sid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
5968 return if !$sid;
ff1a2432
DM
5969
5970 push @$vollist, $volid;
1e3baf05 5971 });
ff1a2432
DM
5972
5973 return $vollist;
5974}
5975
1b189121
DC
5976sub cleanup_pci_devices {
5977 my ($vmid, $conf) = @_;
5978
5979 foreach my $key (keys %$conf) {
5980 next if $key !~ m/^hostpci(\d+)$/;
5981 my $hostpciindex = $1;
5982 my $uuid = PVE::SysFSTools::generate_mdev_uuid($vmid, $hostpciindex);
5983 my $d = parse_hostpci($conf->{$key});
faf72d6c
TL
5984 if ($d->{mdev}) {
5985 # NOTE: avoid PVE::SysFSTools::pci_cleanup_mdev_device as it requires PCI ID and we
5986 # don't want to break ABI just for this two liner
5987 my $dev_sysfs_dir = "/sys/bus/mdev/devices/$uuid";
5988 PVE::SysFSTools::file_write("$dev_sysfs_dir/remove", "1") if -e $dev_sysfs_dir;
5989 }
1b189121
DC
5990 }
5991 PVE::QemuServer::PCI::remove_pci_reservation($vmid);
5992}
5993
ff1a2432 5994sub vm_stop_cleanup {
70b04821 5995 my ($storecfg, $vmid, $conf, $keepActive, $apply_pending_changes) = @_;
ff1a2432 5996
745fed70 5997 eval {
ff1a2432 5998
254575e9
DM
5999 if (!$keepActive) {
6000 my $vollist = get_vm_volumes($conf);
6001 PVE::Storage::deactivate_volumes($storecfg, $vollist);
f9dde219
SR
6002
6003 if (my $tpmdrive = $conf->{tpmstate0}) {
6004 my $tpm = parse_drive("tpmstate0", $tpmdrive);
6005 my ($storeid, $volname) = PVE::Storage::parse_volume_id($tpm->{file}, 1);
6006 if ($storeid) {
6007 PVE::Storage::unmap_volume($storecfg, $tpm->{file});
6008 }
6009 }
254575e9 6010 }
a1b7d579 6011
ab6a046f 6012 foreach my $ext (qw(mon qmp pid vnc qga)) {
961bfcb2
DM
6013 unlink "/var/run/qemu-server/${vmid}.$ext";
6014 }
a1b7d579 6015
6dbcb073 6016 if ($conf->{ivshmem}) {
4df98f2f 6017 my $ivshmem = parse_property_string($ivshmem_fmt, $conf->{ivshmem});
4c5a6a24
TL
6018 # just delete it for now, VMs which have this already open do not
6019 # are affected, but new VMs will get a separated one. If this
6020 # becomes an issue we either add some sort of ref-counting or just
6021 # add a "don't delete on stop" flag to the ivshmem format.
6dbcb073
DC
6022 unlink '/dev/shm/pve-shm-' . ($ivshmem->{name} // $vmid);
6023 }
6024
1b189121 6025 cleanup_pci_devices($vmid, $conf);
6ab45bd7 6026
70b04821 6027 vmconfig_apply_pending($vmid, $conf, $storecfg) if $apply_pending_changes;
745fed70
DM
6028 };
6029 warn $@ if $@; # avoid errors - just warn
1e3baf05
DM
6030}
6031
575d19da
DC
6032# call only in locked context
6033sub _do_vm_stop {
6034 my ($storecfg, $vmid, $skiplock, $nocheck, $timeout, $shutdown, $force, $keepActive) = @_;
9269013a 6035
575d19da
DC
6036 my $pid = check_running($vmid, $nocheck);
6037 return if !$pid;
1e3baf05 6038
575d19da
DC
6039 my $conf;
6040 if (!$nocheck) {
6041 $conf = PVE::QemuConfig->load_config($vmid);
6042 PVE::QemuConfig->check_lock($conf) if !$skiplock;
6043 if (!defined($timeout) && $shutdown && $conf->{startup}) {
6044 my $opts = PVE::JSONSchema::pve_parse_startup_order($conf->{startup});
6045 $timeout = $opts->{down} if $opts->{down};
e6c3b671 6046 }
575d19da
DC
6047 PVE::GuestHelpers::exec_hookscript($conf, $vmid, 'pre-stop');
6048 }
19672434 6049
575d19da
DC
6050 eval {
6051 if ($shutdown) {
a2af1bbe 6052 if (defined($conf) && get_qga_key($conf, 'enabled')) {
0a13e08e 6053 mon_cmd($vmid, "guest-shutdown", timeout => $timeout);
9269013a 6054 } else {
0a13e08e 6055 mon_cmd($vmid, "system_powerdown");
1e3baf05
DM
6056 }
6057 } else {
0a13e08e 6058 mon_cmd($vmid, "quit");
1e3baf05 6059 }
575d19da
DC
6060 };
6061 my $err = $@;
1e3baf05 6062
575d19da
DC
6063 if (!$err) {
6064 $timeout = 60 if !defined($timeout);
1e3baf05
DM
6065
6066 my $count = 0;
e6c3b671 6067 while (($count < $timeout) && check_running($vmid, $nocheck)) {
1e3baf05
DM
6068 $count++;
6069 sleep 1;
6070 }
6071
6072 if ($count >= $timeout) {
575d19da
DC
6073 if ($force) {
6074 warn "VM still running - terminating now with SIGTERM\n";
6075 kill 15, $pid;
6076 } else {
6077 die "VM quit/powerdown failed - got timeout\n";
6078 }
6079 } else {
6080 vm_stop_cleanup($storecfg, $vmid, $conf, $keepActive, 1) if $conf;
6081 return;
1e3baf05 6082 }
575d19da 6083 } else {
d60cbb97
TL
6084 if (!check_running($vmid, $nocheck)) {
6085 warn "Unexpected: VM shutdown command failed, but VM not running anymore..\n";
6086 return;
6087 }
6088 if ($force) {
575d19da
DC
6089 warn "VM quit/powerdown failed - terminating now with SIGTERM\n";
6090 kill 15, $pid;
6091 } else {
6092 die "VM quit/powerdown failed\n";
6093 }
6094 }
6095
6096 # wait again
6097 $timeout = 10;
6098
6099 my $count = 0;
6100 while (($count < $timeout) && check_running($vmid, $nocheck)) {
6101 $count++;
6102 sleep 1;
6103 }
6104
6105 if ($count >= $timeout) {
6106 warn "VM still running - terminating now with SIGKILL\n";
6107 kill 9, $pid;
6108 sleep 1;
6109 }
1e3baf05 6110
575d19da
DC
6111 vm_stop_cleanup($storecfg, $vmid, $conf, $keepActive, 1) if $conf;
6112}
6113
6114# Note: use $nocheck to skip tests if VM configuration file exists.
6115# We need that when migration VMs to other nodes (files already moved)
6116# Note: we set $keepActive in vzdump stop mode - volumes need to stay active
6117sub vm_stop {
6118 my ($storecfg, $vmid, $skiplock, $nocheck, $timeout, $shutdown, $force, $keepActive, $migratedfrom) = @_;
6119
6120 $force = 1 if !defined($force) && !$shutdown;
6121
6122 if ($migratedfrom){
6123 my $pid = check_running($vmid, $nocheck, $migratedfrom);
6124 kill 15, $pid if $pid;
6125 my $conf = PVE::QemuConfig->load_config($vmid, $migratedfrom);
6126 vm_stop_cleanup($storecfg, $vmid, $conf, $keepActive, 0);
6127 return;
6128 }
6129
6130 PVE::QemuConfig->lock_config($vmid, sub {
6131 _do_vm_stop($storecfg, $vmid, $skiplock, $nocheck, $timeout, $shutdown, $force, $keepActive);
ff1a2432 6132 });
1e3baf05
DM
6133}
6134
165411f0
DC
6135sub vm_reboot {
6136 my ($vmid, $timeout) = @_;
6137
6138 PVE::QemuConfig->lock_config($vmid, sub {
66026117 6139 eval {
165411f0 6140
66026117
OB
6141 # only reboot if running, as qmeventd starts it again on a stop event
6142 return if !check_running($vmid);
165411f0 6143
66026117 6144 create_reboot_request($vmid);
165411f0 6145
66026117
OB
6146 my $storecfg = PVE::Storage::config();
6147 _do_vm_stop($storecfg, $vmid, undef, undef, $timeout, 1);
165411f0 6148
66026117
OB
6149 };
6150 if (my $err = $@) {
3c1c3fe6 6151 # avoid that the next normal shutdown will be confused for a reboot
66026117
OB
6152 clear_reboot_request($vmid);
6153 die $err;
6154 }
165411f0
DC
6155 });
6156}
6157
75c24bba 6158# note: if using the statestorage parameter, the caller has to check privileges
1e3baf05 6159sub vm_suspend {
48b4cdc2 6160 my ($vmid, $skiplock, $includestate, $statestorage) = @_;
159719e5
DC
6161
6162 my $conf;
6163 my $path;
6164 my $storecfg;
6165 my $vmstate;
1e3baf05 6166
ffda963f 6167 PVE::QemuConfig->lock_config($vmid, sub {
1e3baf05 6168
159719e5 6169 $conf = PVE::QemuConfig->load_config($vmid);
1e3baf05 6170
159719e5 6171 my $is_backing_up = PVE::QemuConfig->has_lock($conf, 'backup');
e79706d4 6172 PVE::QemuConfig->check_lock($conf)
159719e5
DC
6173 if !($skiplock || $is_backing_up);
6174
6175 die "cannot suspend to disk during backup\n"
6176 if $is_backing_up && $includestate;
bcb7c9cf 6177
159719e5
DC
6178 if ($includestate) {
6179 $conf->{lock} = 'suspending';
6180 my $date = strftime("%Y-%m-%d", localtime(time()));
6181 $storecfg = PVE::Storage::config();
75c24bba
DC
6182 if (!$statestorage) {
6183 $statestorage = find_vmstate_storage($conf, $storecfg);
6184 # check permissions for the storage
6185 my $rpcenv = PVE::RPCEnvironment::get();
6186 if ($rpcenv->{type} ne 'cli') {
6187 my $authuser = $rpcenv->get_user();
6188 $rpcenv->check($authuser, "/storage/$statestorage", ['Datastore.AllocateSpace']);
6189 }
6190 }
6191
6192
4df98f2f
TL
6193 $vmstate = PVE::QemuConfig->__snapshot_save_vmstate(
6194 $vmid, $conf, "suspend-$date", $storecfg, $statestorage, 1);
159719e5
DC
6195 $path = PVE::Storage::path($storecfg, $vmstate);
6196 PVE::QemuConfig->write_config($vmid, $conf);
6197 } else {
0a13e08e 6198 mon_cmd($vmid, "stop");
159719e5 6199 }
1e3baf05 6200 });
159719e5
DC
6201
6202 if ($includestate) {
6203 # save vm state
6204 PVE::Storage::activate_volumes($storecfg, [$vmstate]);
6205
6206 eval {
27a5be53 6207 set_migration_caps($vmid, 1);
0a13e08e 6208 mon_cmd($vmid, "savevm-start", statefile => $path);
159719e5 6209 for(;;) {
0a13e08e 6210 my $state = mon_cmd($vmid, "query-savevm");
159719e5
DC
6211 if (!$state->{status}) {
6212 die "savevm not active\n";
6213 } elsif ($state->{status} eq 'active') {
6214 sleep(1);
6215 next;
6216 } elsif ($state->{status} eq 'completed') {
b0a9a385 6217 print "State saved, quitting\n";
159719e5
DC
6218 last;
6219 } elsif ($state->{status} eq 'failed' && $state->{error}) {
6220 die "query-savevm failed with error '$state->{error}'\n"
6221 } else {
6222 die "query-savevm returned status '$state->{status}'\n";
6223 }
6224 }
6225 };
6226 my $err = $@;
6227
6228 PVE::QemuConfig->lock_config($vmid, sub {
6229 $conf = PVE::QemuConfig->load_config($vmid);
6230 if ($err) {
6231 # cleanup, but leave suspending lock, to indicate something went wrong
6232 eval {
0a13e08e 6233 mon_cmd($vmid, "savevm-end");
159719e5
DC
6234 PVE::Storage::deactivate_volumes($storecfg, [$vmstate]);
6235 PVE::Storage::vdisk_free($storecfg, $vmstate);
ea1c2110 6236 delete $conf->@{qw(vmstate runningmachine runningcpu)};
159719e5
DC
6237 PVE::QemuConfig->write_config($vmid, $conf);
6238 };
6239 warn $@ if $@;
6240 die $err;
6241 }
6242
6243 die "lock changed unexpectedly\n"
6244 if !PVE::QemuConfig->has_lock($conf, 'suspending');
6245
0a13e08e 6246 mon_cmd($vmid, "quit");
159719e5
DC
6247 $conf->{lock} = 'suspended';
6248 PVE::QemuConfig->write_config($vmid, $conf);
6249 });
6250 }
1e3baf05
DM
6251}
6252
6253sub vm_resume {
289e0b85 6254 my ($vmid, $skiplock, $nocheck) = @_;
1e3baf05 6255
ffda963f 6256 PVE::QemuConfig->lock_config($vmid, sub {
0a13e08e 6257 my $res = mon_cmd($vmid, 'query-status');
c2786bed 6258 my $resume_cmd = 'cont';
8e0c97bb 6259 my $reset = 0;
21947fea 6260 my $conf = PVE::QemuConfig->load_config($vmid);
c2786bed 6261
8e0c97bb
SR
6262 if ($res->{status}) {
6263 return if $res->{status} eq 'running'; # job done, go home
6264 $resume_cmd = 'system_wakeup' if $res->{status} eq 'suspended';
6265 $reset = 1 if $res->{status} eq 'shutdown';
c2786bed
DC
6266 }
6267
289e0b85 6268 if (!$nocheck) {
1e3baf05 6269
e79706d4
FG
6270 PVE::QemuConfig->check_lock($conf)
6271 if !($skiplock || PVE::QemuConfig->has_lock($conf, 'backup'));
289e0b85 6272 }
3e24733b 6273
8e0c97bb
SR
6274 if ($reset) {
6275 # required if a VM shuts down during a backup and we get a resume
6276 # request before the backup finishes for example
6277 mon_cmd($vmid, "system_reset");
6278 }
21947fea
AD
6279
6280 add_nets_bridge_fdb($conf, $vmid) if $resume_cmd eq 'cont';
6281
0a13e08e 6282 mon_cmd($vmid, $resume_cmd);
1e3baf05
DM
6283 });
6284}
6285
5fdbe4f0
DM
6286sub vm_sendkey {
6287 my ($vmid, $skiplock, $key) = @_;
1e3baf05 6288
ffda963f 6289 PVE::QemuConfig->lock_config($vmid, sub {
1e3baf05 6290
ffda963f 6291 my $conf = PVE::QemuConfig->load_config($vmid);
f5eb281a 6292
7b7c6d1b 6293 # there is no qmp command, so we use the human monitor command
0a13e08e 6294 my $res = PVE::QemuServer::Monitor::hmp_cmd($vmid, "sendkey $key");
d30820d6 6295 die $res if $res ne '';
1e3baf05
DM
6296 });
6297}
6298
3e16d5fc
DM
6299# vzdump restore implementaion
6300
ed221350 6301sub tar_archive_read_firstfile {
3e16d5fc 6302 my $archive = shift;
afdb31d5 6303
3e16d5fc
DM
6304 die "ERROR: file '$archive' does not exist\n" if ! -f $archive;
6305
6306 # try to detect archive type first
387ba257 6307 my $pid = open (my $fh, '-|', 'tar', 'tf', $archive) ||
3e16d5fc 6308 die "unable to open file '$archive'\n";
387ba257 6309 my $firstfile = <$fh>;
3e16d5fc 6310 kill 15, $pid;
387ba257 6311 close $fh;
3e16d5fc
DM
6312
6313 die "ERROR: archive contaions no data\n" if !$firstfile;
6314 chomp $firstfile;
6315
6316 return $firstfile;
6317}
6318
ed221350
DM
6319sub tar_restore_cleanup {
6320 my ($storecfg, $statfile) = @_;
3e16d5fc
DM
6321
6322 print STDERR "starting cleanup\n";
6323
6324 if (my $fd = IO::File->new($statfile, "r")) {
6325 while (defined(my $line = <$fd>)) {
6326 if ($line =~ m/vzdump:([^\s:]*):(\S+)$/) {
6327 my $volid = $2;
6328 eval {
6329 if ($volid =~ m|^/|) {
6330 unlink $volid || die 'unlink failed\n';
6331 } else {
ed221350 6332 PVE::Storage::vdisk_free($storecfg, $volid);
3e16d5fc 6333 }
afdb31d5 6334 print STDERR "temporary volume '$volid' sucessfuly removed\n";
3e16d5fc
DM
6335 };
6336 print STDERR "unable to cleanup '$volid' - $@" if $@;
6337 } else {
6338 print STDERR "unable to parse line in statfile - $line";
afdb31d5 6339 }
3e16d5fc
DM
6340 }
6341 $fd->close();
6342 }
6343}
6344
d1e92cf6 6345sub restore_file_archive {
a0d1b1a2 6346 my ($archive, $vmid, $user, $opts) = @_;
3e16d5fc 6347
a2ec5a67
FG
6348 return restore_vma_archive($archive, $vmid, $user, $opts)
6349 if $archive eq '-';
6350
c6d51783
AA
6351 my $info = PVE::Storage::archive_info($archive);
6352 my $format = $opts->{format} // $info->{format};
6353 my $comp = $info->{compression};
91bd6c90
DM
6354
6355 # try to detect archive format
6356 if ($format eq 'tar') {
6357 return restore_tar_archive($archive, $vmid, $user, $opts);
6358 } else {
6359 return restore_vma_archive($archive, $vmid, $user, $opts, $comp);
6360 }
6361}
6362
d1e92cf6
DM
6363# hepler to remove disks that will not be used after restore
6364my $restore_cleanup_oldconf = sub {
6365 my ($storecfg, $vmid, $oldconf, $virtdev_hash) = @_;
6366
01a4377f
FE
6367 my $kept_disks = {};
6368
912792e2 6369 PVE::QemuConfig->foreach_volume($oldconf, sub {
d1e92cf6
DM
6370 my ($ds, $drive) = @_;
6371
6372 return if drive_is_cdrom($drive, 1);
6373
6374 my $volid = $drive->{file};
6375 return if !$volid || $volid =~ m|^/|;
6376
6377 my ($path, $owner) = PVE::Storage::path($storecfg, $volid);
6378 return if !$path || !$owner || ($owner != $vmid);
6379
6380 # Note: only delete disk we want to restore
6381 # other volumes will become unused
6382 if ($virtdev_hash->{$ds}) {
6383 eval { PVE::Storage::vdisk_free($storecfg, $volid); };
6384 if (my $err = $@) {
6385 warn $err;
6386 }
01a4377f
FE
6387 } else {
6388 $kept_disks->{$volid} = 1;
d1e92cf6
DM
6389 }
6390 });
6391
01a4377f
FE
6392 # after the restore we have no snapshots anymore
6393 for my $snapname (keys $oldconf->{snapshots}->%*) {
d1e92cf6
DM
6394 my $snap = $oldconf->{snapshots}->{$snapname};
6395 if ($snap->{vmstate}) {
6396 eval { PVE::Storage::vdisk_free($storecfg, $snap->{vmstate}); };
6397 if (my $err = $@) {
6398 warn $err;
6399 }
6400 }
01a4377f
FE
6401
6402 for my $volid (keys $kept_disks->%*) {
6403 eval { PVE::Storage::volume_snapshot_delete($storecfg, $volid, $snapname); };
6404 warn $@ if $@;
6405 }
d1e92cf6
DM
6406 }
6407};
6408
9f3d73bc
DM
6409# Helper to parse vzdump backup device hints
6410#
6411# $rpcenv: Environment, used to ckeck storage permissions
6412# $user: User ID, to check storage permissions
6413# $storecfg: Storage configuration
6414# $fh: the file handle for reading the configuration
6415# $devinfo: should contain device sizes for all backu-up'ed devices
6416# $options: backup options (pool, default storage)
6417#
6418# Return: $virtdev_hash, updates $devinfo (add devname, virtdev, format, storeid)
6419my $parse_backup_hints = sub {
6420 my ($rpcenv, $user, $storecfg, $fh, $devinfo, $options) = @_;
d1e92cf6 6421
36d4bdcb
TL
6422 my $check_storage = sub { # assert if an image can be allocate
6423 my ($storeid, $scfg) = @_;
6424 die "Content type 'images' is not available on storage '$storeid'\n"
6425 if !$scfg->{content}->{images};
6426 $rpcenv->check($user, "/storage/$storeid", ['Datastore.AllocateSpace'])
6427 if $user ne 'root@pam';
6428 };
d1e92cf6 6429
36d4bdcb 6430 my $virtdev_hash = {};
9f3d73bc
DM
6431 while (defined(my $line = <$fh>)) {
6432 if ($line =~ m/^\#qmdump\#map:(\S+):(\S+):(\S*):(\S*):$/) {
6433 my ($virtdev, $devname, $storeid, $format) = ($1, $2, $3, $4);
6434 die "archive does not contain data for drive '$virtdev'\n"
6435 if !$devinfo->{$devname};
6436
6437 if (defined($options->{storage})) {
6438 $storeid = $options->{storage} || 'local';
6439 } elsif (!$storeid) {
6440 $storeid = 'local';
d1e92cf6 6441 }
9f3d73bc
DM
6442 $format = 'raw' if !$format;
6443 $devinfo->{$devname}->{devname} = $devname;
6444 $devinfo->{$devname}->{virtdev} = $virtdev;
6445 $devinfo->{$devname}->{format} = $format;
6446 $devinfo->{$devname}->{storeid} = $storeid;
6447
62af60cd 6448 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
36d4bdcb 6449 $check_storage->($storeid, $scfg); # permission and content type check
d1e92cf6 6450
9f3d73bc
DM
6451 $virtdev_hash->{$virtdev} = $devinfo->{$devname};
6452 } elsif ($line =~ m/^((?:ide|sata|scsi)\d+):\s*(.*)\s*$/) {
6453 my $virtdev = $1;
6454 my $drive = parse_drive($virtdev, $2);
36d4bdcb 6455
9f3d73bc
DM
6456 if (drive_is_cloudinit($drive)) {
6457 my ($storeid, $volname) = PVE::Storage::parse_volume_id($drive->{file});
5364990d
TL
6458 $storeid = $options->{storage} if defined ($options->{storage});
6459 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
9f3d73bc 6460 my $format = qemu_img_format($scfg, $volname); # has 'raw' fallback
d1e92cf6 6461
36d4bdcb 6462 $check_storage->($storeid, $scfg); # permission and content type check
9f8ba326 6463
9f3d73bc
DM
6464 $virtdev_hash->{$virtdev} = {
6465 format => $format,
5364990d 6466 storeid => $storeid,
9f3d73bc
DM
6467 size => PVE::QemuServer::Cloudinit::CLOUDINIT_DISK_SIZE,
6468 is_cloudinit => 1,
6469 };
d1e92cf6 6470 }
9f3d73bc
DM
6471 }
6472 }
d1e92cf6 6473
9f3d73bc
DM
6474 return $virtdev_hash;
6475};
d1e92cf6 6476
9f3d73bc
DM
6477# Helper to allocate and activate all volumes required for a restore
6478#
6479# $storecfg: Storage configuration
6480# $virtdev_hash: as returned by parse_backup_hints()
6481#
6482# Returns: { $virtdev => $volid }
6483my $restore_allocate_devices = sub {
6484 my ($storecfg, $virtdev_hash, $vmid) = @_;
d1e92cf6 6485
9f3d73bc
DM
6486 my $map = {};
6487 foreach my $virtdev (sort keys %$virtdev_hash) {
6488 my $d = $virtdev_hash->{$virtdev};
6489 my $alloc_size = int(($d->{size} + 1024 - 1)/1024);
6490 my $storeid = $d->{storeid};
6491 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
d1e92cf6 6492
9f3d73bc
DM
6493 # test if requested format is supported
6494 my ($defFormat, $validFormats) = PVE::Storage::storage_default_format($storecfg, $storeid);
6495 my $supported = grep { $_ eq $d->{format} } @$validFormats;
6496 $d->{format} = $defFormat if !$supported;
d1e92cf6 6497
9f3d73bc
DM
6498 my $name;
6499 if ($d->{is_cloudinit}) {
6500 $name = "vm-$vmid-cloudinit";
c997e24a
ML
6501 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
6502 if ($scfg->{path}) {
6503 $name .= ".$d->{format}";
6504 }
d1e92cf6
DM
6505 }
6506
4df98f2f
TL
6507 my $volid = PVE::Storage::vdisk_alloc(
6508 $storecfg, $storeid, $vmid, $d->{format}, $name, $alloc_size);
d1e92cf6 6509
9f3d73bc
DM
6510 print STDERR "new volume ID is '$volid'\n";
6511 $d->{volid} = $volid;
d1e92cf6 6512
9f3d73bc 6513 PVE::Storage::activate_volumes($storecfg, [$volid]);
d1e92cf6 6514
9f3d73bc 6515 $map->{$virtdev} = $volid;
d1e92cf6
DM
6516 }
6517
9f3d73bc
DM
6518 return $map;
6519};
d1e92cf6 6520
c62d7cf5 6521sub restore_update_config_line {
eabac302 6522 my ($cookie, $map, $line, $unique) = @_;
91bd6c90 6523
98a4b3fb
FE
6524 return '' if $line =~ m/^\#qmdump\#/;
6525 return '' if $line =~ m/^\#vzdump\#/;
6526 return '' if $line =~ m/^lock:/;
6527 return '' if $line =~ m/^unused\d+:/;
6528 return '' if $line =~ m/^parent:/;
6529
6530 my $res = '';
91bd6c90 6531
b5b99790 6532 my $dc = PVE::Cluster::cfs_read_file('datacenter.cfg');
91bd6c90
DM
6533 if (($line =~ m/^(vlan(\d+)):\s*(\S+)\s*$/)) {
6534 # try to convert old 1.X settings
6535 my ($id, $ind, $ethcfg) = ($1, $2, $3);
6536 foreach my $devconfig (PVE::Tools::split_list($ethcfg)) {
6537 my ($model, $macaddr) = split(/\=/, $devconfig);
b5b99790 6538 $macaddr = PVE::Tools::random_ether_addr($dc->{mac_prefix}) if !$macaddr || $unique;
91bd6c90
DM
6539 my $net = {
6540 model => $model,
6541 bridge => "vmbr$ind",
6542 macaddr => $macaddr,
6543 };
6544 my $netstr = print_net($net);
6545
98a4b3fb 6546 $res .= "net$cookie->{netcount}: $netstr\n";
91bd6c90
DM
6547 $cookie->{netcount}++;
6548 }
6549 } elsif (($line =~ m/^(net\d+):\s*(\S+)\s*$/) && $unique) {
6550 my ($id, $netstr) = ($1, $2);
6551 my $net = parse_net($netstr);
b5b99790 6552 $net->{macaddr} = PVE::Tools::random_ether_addr($dc->{mac_prefix}) if $net->{macaddr};
91bd6c90 6553 $netstr = print_net($net);
98a4b3fb 6554 $res .= "$id: $netstr\n";
f9dde219 6555 } elsif ($line =~ m/^((ide|scsi|virtio|sata|efidisk|tpmstate)\d+):\s*(\S+)\s*$/) {
91bd6c90 6556 my $virtdev = $1;
907ea891 6557 my $value = $3;
d9faf790
WB
6558 my $di = parse_drive($virtdev, $value);
6559 if (defined($di->{backup}) && !$di->{backup}) {
98a4b3fb 6560 $res .= "#$line";
c0f7406e 6561 } elsif ($map->{$virtdev}) {
8fd57431 6562 delete $di->{format}; # format can change on restore
91bd6c90 6563 $di->{file} = $map->{$virtdev};
71c58bb7 6564 $value = print_drive($di);
98a4b3fb 6565 $res .= "$virtdev: $value\n";
91bd6c90 6566 } else {
98a4b3fb 6567 $res .= $line;
91bd6c90 6568 }
1a0c2f03 6569 } elsif (($line =~ m/^vmgenid: (.*)/)) {
babecffe 6570 my $vmgenid = $1;
6ee499ff 6571 if ($vmgenid ne '0') {
1a0c2f03 6572 # always generate a new vmgenid if there was a valid one setup
6ee499ff
DC
6573 $vmgenid = generate_uuid();
6574 }
98a4b3fb 6575 $res .= "vmgenid: $vmgenid\n";
19a5dd55
WL
6576 } elsif (($line =~ m/^(smbios1: )(.*)/) && $unique) {
6577 my ($uuid, $uuid_str);
6578 UUID::generate($uuid);
6579 UUID::unparse($uuid, $uuid_str);
6580 my $smbios1 = parse_smbios1($2);
6581 $smbios1->{uuid} = $uuid_str;
98a4b3fb 6582 $res .= $1.print_smbios1($smbios1)."\n";
91bd6c90 6583 } else {
98a4b3fb 6584 $res .= $line;
91bd6c90 6585 }
98a4b3fb
FE
6586
6587 return $res;
c62d7cf5 6588}
9f3d73bc
DM
6589
6590my $restore_deactivate_volumes = sub {
e8b07b29 6591 my ($storecfg, $virtdev_hash) = @_;
9f3d73bc
DM
6592
6593 my $vollist = [];
e8b07b29
FE
6594 for my $dev (values $virtdev_hash->%*) {
6595 push $vollist->@*, $dev->{volid} if $dev->{volid};
9f3d73bc
DM
6596 }
6597
ff86112c
FE
6598 eval { PVE::Storage::deactivate_volumes($storecfg, $vollist); };
6599 print STDERR $@ if $@;
9f3d73bc
DM
6600};
6601
6602my $restore_destroy_volumes = sub {
e8b07b29 6603 my ($storecfg, $virtdev_hash) = @_;
9f3d73bc 6604
e8b07b29
FE
6605 for my $dev (values $virtdev_hash->%*) {
6606 my $volid = $dev->{volid} or next;
9f3d73bc 6607 eval {
e60afe82 6608 PVE::Storage::vdisk_free($storecfg, $volid);
9f3d73bc
DM
6609 print STDERR "temporary volume '$volid' sucessfuly removed\n";
6610 };
6611 print STDERR "unable to cleanup '$volid' - $@" if $@;
6612 }
6613};
91bd6c90 6614
202a2a0b
FE
6615my $restore_merge_config = sub {
6616 my ($filename, $backup_conf_raw, $override_conf) = @_;
6617
6618 my $backup_conf = parse_vm_config($filename, $backup_conf_raw);
6619 for my $key (keys $override_conf->%*) {
6620 $backup_conf->{$key} = $override_conf->{$key};
6621 }
6622
6623 return $backup_conf;
6624};
6625
91bd6c90 6626sub scan_volids {
9a8ba127 6627 my ($cfg, $vmid) = @_;
91bd6c90 6628
9a8ba127 6629 my $info = PVE::Storage::vdisk_list($cfg, undef, $vmid, undef, 'images');
91bd6c90
DM
6630
6631 my $volid_hash = {};
6632 foreach my $storeid (keys %$info) {
6633 foreach my $item (@{$info->{$storeid}}) {
6634 next if !($item->{volid} && $item->{size});
5996a936 6635 $item->{path} = PVE::Storage::path($cfg, $item->{volid});
91bd6c90
DM
6636 $volid_hash->{$item->{volid}} = $item;
6637 }
6638 }
6639
6640 return $volid_hash;
6641}
6642
68b108ee 6643sub update_disk_config {
91bd6c90 6644 my ($vmid, $conf, $volid_hash) = @_;
be190583 6645
91bd6c90 6646 my $changes;
9b29cbd0 6647 my $prefix = "VM $vmid";
91bd6c90 6648
c449137a
DC
6649 # used and unused disks
6650 my $referenced = {};
91bd6c90 6651
5996a936
DM
6652 # Note: it is allowed to define multiple storages with same path (alias), so
6653 # we need to check both 'volid' and real 'path' (two different volid can point
6654 # to the same path).
6655
c449137a 6656 my $referencedpath = {};
be190583 6657
91bd6c90 6658 # update size info
0c4fef3f 6659 PVE::QemuConfig->foreach_volume($conf, sub {
ca04977c 6660 my ($opt, $drive) = @_;
91bd6c90 6661
ca04977c
FE
6662 my $volid = $drive->{file};
6663 return if !$volid;
4df98f2f 6664 my $volume = $volid_hash->{$volid};
91bd6c90 6665
ca04977c
FE
6666 # mark volid as "in-use" for next step
6667 $referenced->{$volid} = 1;
4df98f2f 6668 if ($volume && (my $path = $volume->{path})) {
ca04977c 6669 $referencedpath->{$path} = 1;
91bd6c90 6670 }
ca04977c
FE
6671
6672 return if drive_is_cdrom($drive);
4df98f2f 6673 return if !$volume;
ca04977c 6674
4df98f2f 6675 my ($updated, $msg) = PVE::QemuServer::Drive::update_disksize($drive, $volume->{size});
ca04977c
FE
6676 if (defined($updated)) {
6677 $changes = 1;
6678 $conf->{$opt} = print_drive($updated);
9b29cbd0 6679 print "$prefix ($opt): $msg\n";
ca04977c
FE
6680 }
6681 });
91bd6c90 6682
5996a936 6683 # remove 'unusedX' entry if volume is used
ca04977c
FE
6684 PVE::QemuConfig->foreach_unused_volume($conf, sub {
6685 my ($opt, $drive) = @_;
6686
6687 my $volid = $drive->{file};
6688 return if !$volid;
6689
f7d1505b
TL
6690 my $path;
6691 $path = $volid_hash->{$volid}->{path} if $volid_hash->{$volid};
c449137a 6692 if ($referenced->{$volid} || ($path && $referencedpath->{$path})) {
68b108ee 6693 print "$prefix remove entry '$opt', its volume '$volid' is in use\n";
5996a936
DM
6694 $changes = 1;
6695 delete $conf->{$opt};
6696 }
c449137a
DC
6697
6698 $referenced->{$volid} = 1;
6699 $referencedpath->{$path} = 1 if $path;
ca04977c 6700 });
5996a936 6701
91bd6c90
DM
6702 foreach my $volid (sort keys %$volid_hash) {
6703 next if $volid =~ m/vm-$vmid-state-/;
c449137a 6704 next if $referenced->{$volid};
5996a936
DM
6705 my $path = $volid_hash->{$volid}->{path};
6706 next if !$path; # just to be sure
c449137a 6707 next if $referencedpath->{$path};
91bd6c90 6708 $changes = 1;
53b81297 6709 my $key = PVE::QemuConfig->add_unused_volume($conf, $volid);
68b108ee 6710 print "$prefix add unreferenced volume '$volid' as '$key' to config\n";
c449137a 6711 $referencedpath->{$path} = 1; # avoid to add more than once (aliases)
91bd6c90
DM
6712 }
6713
6714 return $changes;
6715}
6716
6717sub rescan {
9224dcee 6718 my ($vmid, $nolock, $dryrun) = @_;
91bd6c90 6719
20519efc 6720 my $cfg = PVE::Storage::config();
91bd6c90 6721
53b81297 6722 print "rescan volumes...\n";
9a8ba127 6723 my $volid_hash = scan_volids($cfg, $vmid);
91bd6c90
DM
6724
6725 my $updatefn = sub {
6726 my ($vmid) = @_;
6727
ffda963f 6728 my $conf = PVE::QemuConfig->load_config($vmid);
be190583 6729
ffda963f 6730 PVE::QemuConfig->check_lock($conf);
91bd6c90 6731
03da3f0d
DM
6732 my $vm_volids = {};
6733 foreach my $volid (keys %$volid_hash) {
6734 my $info = $volid_hash->{$volid};
6735 $vm_volids->{$volid} = $info if $info->{vmid} && $info->{vmid} == $vmid;
6736 }
6737
68b108ee 6738 my $changes = update_disk_config($vmid, $conf, $vm_volids);
91bd6c90 6739
9224dcee 6740 PVE::QemuConfig->write_config($vmid, $conf) if $changes && !$dryrun;
91bd6c90
DM
6741 };
6742
6743 if (defined($vmid)) {
6744 if ($nolock) {
6745 &$updatefn($vmid);
6746 } else {
ffda963f 6747 PVE::QemuConfig->lock_config($vmid, $updatefn, $vmid);
91bd6c90
DM
6748 }
6749 } else {
6750 my $vmlist = config_list();
6751 foreach my $vmid (keys %$vmlist) {
6752 if ($nolock) {
6753 &$updatefn($vmid);
6754 } else {
ffda963f 6755 PVE::QemuConfig->lock_config($vmid, $updatefn, $vmid);
be190583 6756 }
91bd6c90
DM
6757 }
6758 }
6759}
6760
9f3d73bc
DM
6761sub restore_proxmox_backup_archive {
6762 my ($archive, $vmid, $user, $options) = @_;
6763
6764 my $storecfg = PVE::Storage::config();
6765
6766 my ($storeid, $volname) = PVE::Storage::parse_volume_id($archive);
6767 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
6768
9f3d73bc 6769 my $fingerprint = $scfg->{fingerprint};
503e96f8 6770 my $keyfile = PVE::Storage::PBSPlugin::pbs_encryption_key_file_name($storecfg, $storeid);
9f3d73bc 6771
fbec3f89 6772 my $repo = PVE::PBSClient::get_repository($scfg);
2dda626d 6773 my $namespace = $scfg->{namespace};
dea4b04c 6774
26731a3c 6775 # This is only used for `pbs-restore` and the QEMU PBS driver (live-restore)
9f3d73bc
DM
6776 my $password = PVE::Storage::PBSPlugin::pbs_get_password($scfg, $storeid);
6777 local $ENV{PBS_PASSWORD} = $password;
6778 local $ENV{PBS_FINGERPRINT} = $fingerprint if defined($fingerprint);
6779
6780 my ($vtype, $pbs_backup_name, undef, undef, undef, undef, $format) =
6781 PVE::Storage::parse_volname($storecfg, $archive);
6782
6783 die "got unexpected vtype '$vtype'\n" if $vtype ne 'backup';
6784
6785 die "got unexpected backup format '$format'\n" if $format ne 'pbs-vm';
6786
6787 my $tmpdir = "/var/tmp/vzdumptmp$$";
6788 rmtree $tmpdir;
6789 mkpath $tmpdir;
6790
6791 my $conffile = PVE::QemuConfig->config_file($vmid);
9f3d73bc
DM
6792 # disable interrupts (always do cleanups)
6793 local $SIG{INT} =
6794 local $SIG{TERM} =
6795 local $SIG{QUIT} =
6796 local $SIG{HUP} = sub { print STDERR "got interrupt - ignored\n"; };
6797
6798 # Note: $oldconf is undef if VM does not exists
6799 my $cfs_path = PVE::QemuConfig->cfs_config_path($vmid);
6800 my $oldconf = PVE::Cluster::cfs_read_file($cfs_path);
98a4b3fb 6801 my $new_conf_raw = '';
9f3d73bc
DM
6802
6803 my $rpcenv = PVE::RPCEnvironment::get();
e8b07b29
FE
6804 my $devinfo = {}; # info about drives included in backup
6805 my $virtdev_hash = {}; # info about allocated drives
9f3d73bc
DM
6806
6807 eval {
6808 # enable interrupts
6809 local $SIG{INT} =
6810 local $SIG{TERM} =
6811 local $SIG{QUIT} =
6812 local $SIG{HUP} =
6813 local $SIG{PIPE} = sub { die "interrupted by signal\n"; };
6814
6815 my $cfgfn = "$tmpdir/qemu-server.conf";
6816 my $firewall_config_fn = "$tmpdir/fw.conf";
6817 my $index_fn = "$tmpdir/index.json";
6818
6819 my $cmd = "restore";
6820
6821 my $param = [$pbs_backup_name, "index.json", $index_fn];
6822 PVE::Storage::PBSPlugin::run_raw_client_cmd($scfg, $storeid, $cmd, $param);
6823 my $index = PVE::Tools::file_get_contents($index_fn);
6824 $index = decode_json($index);
6825
9f3d73bc
DM
6826 foreach my $info (@{$index->{files}}) {
6827 if ($info->{filename} =~ m/^(drive-\S+).img.fidx$/) {
6828 my $devname = $1;
6829 if ($info->{size} =~ m/^(\d+)$/) { # untaint size
6830 $devinfo->{$devname}->{size} = $1;
6831 } else {
6832 die "unable to parse file size in 'index.json' - got '$info->{size}'\n";
6833 }
6834 }
6835 }
6836
4df98f2f
TL
6837 my $is_qemu_server_backup = scalar(
6838 grep { $_->{filename} eq 'qemu-server.conf.blob' } @{$index->{files}}
6839 );
9f3d73bc
DM
6840 if (!$is_qemu_server_backup) {
6841 die "backup does not look like a qemu-server backup (missing 'qemu-server.conf' file)\n";
6842 }
6843 my $has_firewall_config = scalar(grep { $_->{filename} eq 'fw.conf.blob' } @{$index->{files}});
6844
6845 $param = [$pbs_backup_name, "qemu-server.conf", $cfgfn];
6846 PVE::Storage::PBSPlugin::run_raw_client_cmd($scfg, $storeid, $cmd, $param);
6847
6848 if ($has_firewall_config) {
6849 $param = [$pbs_backup_name, "fw.conf", $firewall_config_fn];
6850 PVE::Storage::PBSPlugin::run_raw_client_cmd($scfg, $storeid, $cmd, $param);
6851
6852 my $pve_firewall_dir = '/etc/pve/firewall';
6853 mkdir $pve_firewall_dir; # make sure the dir exists
6854 PVE::Tools::file_copy($firewall_config_fn, "${pve_firewall_dir}/$vmid.fw");
6855 }
6856
6857 my $fh = IO::File->new($cfgfn, "r") ||
a1cbe55c 6858 die "unable to read qemu-server.conf - $!\n";
9f3d73bc 6859
e8b07b29 6860 $virtdev_hash = $parse_backup_hints->($rpcenv, $user, $storecfg, $fh, $devinfo, $options);
9f3d73bc
DM
6861
6862 # fixme: rate limit?
6863
6864 # create empty/temp config
6865 PVE::Tools::file_set_contents($conffile, "memory: 128\nlock: create");
6866
6867 $restore_cleanup_oldconf->($storecfg, $vmid, $oldconf, $virtdev_hash) if $oldconf;
6868
6869 # allocate volumes
6870 my $map = $restore_allocate_devices->($storecfg, $virtdev_hash, $vmid);
6871
6f94e162
SR
6872 foreach my $virtdev (sort keys %$virtdev_hash) {
6873 my $d = $virtdev_hash->{$virtdev};
6874 next if $d->{is_cloudinit}; # no need to restore cloudinit
9f3d73bc 6875
55c7f9cf 6876 # this fails if storage is unavailable
6f94e162 6877 my $volid = $d->{volid};
6f94e162 6878 my $path = PVE::Storage::path($storecfg, $volid);
9f3d73bc 6879
f9dde219
SR
6880 # for live-restore we only want to preload the efidisk and TPM state
6881 next if $options->{live} && $virtdev ne 'efidisk0' && $virtdev ne 'tpmstate0';
55c7f9cf 6882
21a9ec2a
WB
6883 my @ns_arg;
6884 if (defined(my $ns = $scfg->{namespace})) {
6885 @ns_arg = ('--ns', $ns);
6886 }
6887
6f94e162
SR
6888 my $pbs_restore_cmd = [
6889 '/usr/bin/pbs-restore',
6890 '--repository', $repo,
21a9ec2a 6891 @ns_arg,
6f94e162
SR
6892 $pbs_backup_name,
6893 "$d->{devname}.img.fidx",
6894 $path,
6895 '--verbose',
6896 ];
55fb78aa 6897
6f94e162
SR
6898 push @$pbs_restore_cmd, '--format', $d->{format} if $d->{format};
6899 push @$pbs_restore_cmd, '--keyfile', $keyfile if -e $keyfile;
9f3d73bc 6900
6f94e162
SR
6901 if (PVE::Storage::volume_has_feature($storecfg, 'sparseinit', $volid)) {
6902 push @$pbs_restore_cmd, '--skip-zero';
26731a3c 6903 }
6f94e162
SR
6904
6905 my $dbg_cmdstring = PVE::Tools::cmd2string($pbs_restore_cmd);
6906 print "restore proxmox backup image: $dbg_cmdstring\n";
6907 run_command($pbs_restore_cmd);
9f3d73bc
DM
6908 }
6909
6910 $fh->seek(0, 0) || die "seek failed - $!\n";
6911
9f3d73bc
DM
6912 my $cookie = { netcount => 0 };
6913 while (defined(my $line = <$fh>)) {
c62d7cf5 6914 $new_conf_raw .= restore_update_config_line(
98a4b3fb 6915 $cookie,
98a4b3fb
FE
6916 $map,
6917 $line,
6918 $options->{unique},
6919 );
9f3d73bc
DM
6920 }
6921
6922 $fh->close();
9f3d73bc
DM
6923 };
6924 my $err = $@;
6925
26731a3c 6926 if ($err || !$options->{live}) {
e8b07b29 6927 $restore_deactivate_volumes->($storecfg, $virtdev_hash);
26731a3c 6928 }
9f3d73bc
DM
6929
6930 rmtree $tmpdir;
6931
6932 if ($err) {
e8b07b29 6933 $restore_destroy_volumes->($storecfg, $virtdev_hash);
9f3d73bc
DM
6934 die $err;
6935 }
6936
f7551170
SR
6937 if ($options->{live}) {
6938 # keep lock during live-restore
6939 $new_conf_raw .= "\nlock: create";
6940 }
6941
202a2a0b
FE
6942 my $new_conf = $restore_merge_config->($conffile, $new_conf_raw, $options->{override_conf});
6943 PVE::QemuConfig->write_config($vmid, $new_conf);
9f3d73bc
DM
6944
6945 eval { rescan($vmid, 1); };
6946 warn $@ if $@;
26731a3c
SR
6947
6948 PVE::AccessControl::add_vm_to_pool($vmid, $options->{pool}) if $options->{pool};
6949
6950 if ($options->{live}) {
fefd65a1
SR
6951 # enable interrupts
6952 local $SIG{INT} =
6953 local $SIG{TERM} =
6954 local $SIG{QUIT} =
6955 local $SIG{HUP} =
6956 local $SIG{PIPE} = sub { die "got signal ($!) - abort\n"; };
26731a3c 6957
fefd65a1
SR
6958 my $conf = PVE::QemuConfig->load_config($vmid);
6959 die "cannot do live-restore for template\n" if PVE::QemuConfig->is_template($conf);
26731a3c 6960
f9dde219
SR
6961 # these special drives are already restored before start
6962 delete $devinfo->{'drive-efidisk0'};
6963 delete $devinfo->{'drive-tpmstate0-backup'};
2dda626d
DC
6964
6965 my $pbs_opts = {
6966 repo => $repo,
6967 keyfile => $keyfile,
6968 snapshot => $pbs_backup_name,
6969 namespace => $namespace,
6970 };
6971 pbs_live_restore($vmid, $conf, $storecfg, $devinfo, $pbs_opts);
f7551170
SR
6972
6973 PVE::QemuConfig->remove_lock($vmid, "create");
26731a3c
SR
6974 }
6975}
6976
6977sub pbs_live_restore {
2dda626d 6978 my ($vmid, $conf, $storecfg, $restored_disks, $opts) = @_;
26731a3c 6979
88cabb62 6980 print "starting VM for live-restore\n";
2dda626d 6981 print "repository: '$opts->{repo}', snapshot: '$opts->{snapshot}'\n";
26731a3c
SR
6982
6983 my $pbs_backing = {};
8986e36e 6984 for my $ds (keys %$restored_disks) {
26731a3c 6985 $ds =~ m/^drive-(.*)$/;
88cabb62
SR
6986 my $confname = $1;
6987 $pbs_backing->{$confname} = {
2dda626d
DC
6988 repository => $opts->{repo},
6989 snapshot => $opts->{snapshot},
26731a3c
SR
6990 archive => "$ds.img.fidx",
6991 };
2dda626d
DC
6992 $pbs_backing->{$confname}->{keyfile} = $opts->{keyfile} if -e $opts->{keyfile};
6993 $pbs_backing->{$confname}->{namespace} = $opts->{namespace} if defined($opts->{namespace});
88cabb62
SR
6994
6995 my $drive = parse_drive($confname, $conf->{$confname});
6996 print "restoring '$ds' to '$drive->{file}'\n";
26731a3c
SR
6997 }
6998
fd70c843 6999 my $drives_streamed = 0;
26731a3c
SR
7000 eval {
7001 # make sure HA doesn't interrupt our restore by stopping the VM
7002 if (PVE::HA::Config::vm_is_ha_managed($vmid)) {
fd70c843 7003 run_command(['ha-manager', 'set', "vm:$vmid", '--state', 'started']);
26731a3c
SR
7004 }
7005
fd70c843
TL
7006 # start VM with backing chain pointing to PBS backup, environment vars for PBS driver
7007 # in QEMU (PBS_PASSWORD and PBS_FINGERPRINT) are already set by our caller
bfb12678 7008 vm_start_nolock($storecfg, $vmid, $conf, {paused => 1, 'pbs-backing' => $pbs_backing}, {});
26731a3c 7009
26697640
SR
7010 my $qmeventd_fd = register_qmeventd_handle($vmid);
7011
26731a3c
SR
7012 # begin streaming, i.e. data copy from PBS to target disk for every vol,
7013 # this will effectively collapse the backing image chain consisting of
7014 # [target <- alloc-track -> PBS snapshot] to just [target] (alloc-track
7015 # removes itself once all backing images vanish with 'auto-remove=on')
7016 my $jobs = {};
8986e36e 7017 for my $ds (sort keys %$restored_disks) {
26731a3c
SR
7018 my $job_id = "restore-$ds";
7019 mon_cmd($vmid, 'block-stream',
7020 'job-id' => $job_id,
7021 device => "$ds",
7022 );
7023 $jobs->{$job_id} = {};
7024 }
7025
7026 mon_cmd($vmid, 'cont');
7027 qemu_drive_mirror_monitor($vmid, undef, $jobs, 'auto', 0, 'stream');
7028
a09b39f1
TL
7029 print "restore-drive jobs finished successfully, removing all tracking block devices"
7030 ." to disconnect from Proxmox Backup Server\n";
7031
8986e36e 7032 for my $ds (sort keys %$restored_disks) {
26731a3c
SR
7033 mon_cmd($vmid, 'blockdev-del', 'node-name' => "$ds-pbs");
7034 }
26697640
SR
7035
7036 close($qmeventd_fd);
26731a3c
SR
7037 };
7038
7039 my $err = $@;
7040
7041 if ($err) {
8b8893c3 7042 warn "An error occurred during live-restore: $err\n";
26731a3c
SR
7043 _do_vm_stop($storecfg, $vmid, 1, 1, 10, 0, 1);
7044 die "live-restore failed\n";
7045 }
9f3d73bc
DM
7046}
7047
91bd6c90
DM
7048sub restore_vma_archive {
7049 my ($archive, $vmid, $user, $opts, $comp) = @_;
7050
91bd6c90
DM
7051 my $readfrom = $archive;
7052
7c536e11
WB
7053 my $cfg = PVE::Storage::config();
7054 my $commands = [];
7055 my $bwlimit = $opts->{bwlimit};
7056
7057 my $dbg_cmdstring = '';
7058 my $add_pipe = sub {
7059 my ($cmd) = @_;
7060 push @$commands, $cmd;
7061 $dbg_cmdstring .= ' | ' if length($dbg_cmdstring);
7062 $dbg_cmdstring .= PVE::Tools::cmd2string($cmd);
91bd6c90 7063 $readfrom = '-';
7c536e11
WB
7064 };
7065
7066 my $input = undef;
7067 if ($archive eq '-') {
7068 $input = '<&STDIN';
7069 } else {
7070 # If we use a backup from a PVE defined storage we also consider that
7071 # storage's rate limit:
7072 my (undef, $volid) = PVE::Storage::path_to_volume_id($cfg, $archive);
7073 if (defined($volid)) {
7074 my ($sid, undef) = PVE::Storage::parse_volume_id($volid);
7075 my $readlimit = PVE::Storage::get_bandwidth_limit('restore', [$sid], $bwlimit);
7076 if ($readlimit) {
7077 print STDERR "applying read rate limit: $readlimit\n";
9444c6e4 7078 my $cstream = ['cstream', '-t', $readlimit*1024, '--', $readfrom];
7c536e11
WB
7079 $add_pipe->($cstream);
7080 }
7081 }
7082 }
7083
7084 if ($comp) {
c6d51783
AA
7085 my $info = PVE::Storage::decompressor_info('vma', $comp);
7086 my $cmd = $info->{decompressor};
7087 push @$cmd, $readfrom;
7c536e11 7088 $add_pipe->($cmd);
91bd6c90
DM
7089 }
7090
7091 my $tmpdir = "/var/tmp/vzdumptmp$$";
7092 rmtree $tmpdir;
7093
7094 # disable interrupts (always do cleanups)
5b97ef24
TL
7095 local $SIG{INT} =
7096 local $SIG{TERM} =
7097 local $SIG{QUIT} =
7098 local $SIG{HUP} = sub { warn "got interrupt - ignored\n"; };
91bd6c90
DM
7099
7100 my $mapfifo = "/var/tmp/vzdumptmp$$.fifo";
7101 POSIX::mkfifo($mapfifo, 0600);
7102 my $fifofh;
808a65b5 7103 my $openfifo = sub { open($fifofh, '>', $mapfifo) or die $! };
91bd6c90 7104
7c536e11 7105 $add_pipe->(['vma', 'extract', '-v', '-r', $mapfifo, $readfrom, $tmpdir]);
91bd6c90
DM
7106
7107 my $oldtimeout;
7108 my $timeout = 5;
7109
e8b07b29
FE
7110 my $devinfo = {}; # info about drives included in backup
7111 my $virtdev_hash = {}; # info about allocated drives
91bd6c90
DM
7112
7113 my $rpcenv = PVE::RPCEnvironment::get();
7114
ffda963f 7115 my $conffile = PVE::QemuConfig->config_file($vmid);
91bd6c90 7116
ae200950 7117 # Note: $oldconf is undef if VM does not exist
ffda963f
FG
7118 my $cfs_path = PVE::QemuConfig->cfs_config_path($vmid);
7119 my $oldconf = PVE::Cluster::cfs_read_file($cfs_path);
98a4b3fb 7120 my $new_conf_raw = '';
ed221350 7121
7c536e11
WB
7122 my %storage_limits;
7123
91bd6c90 7124 my $print_devmap = sub {
91bd6c90
DM
7125 my $cfgfn = "$tmpdir/qemu-server.conf";
7126
7127 # we can read the config - that is already extracted
7128 my $fh = IO::File->new($cfgfn, "r") ||
a1cbe55c 7129 die "unable to read qemu-server.conf - $!\n";
91bd6c90 7130
6738ab9c 7131 my $fwcfgfn = "$tmpdir/qemu-server.fw";
3457d090
WL
7132 if (-f $fwcfgfn) {
7133 my $pve_firewall_dir = '/etc/pve/firewall';
7134 mkdir $pve_firewall_dir; # make sure the dir exists
7135 PVE::Tools::file_copy($fwcfgfn, "${pve_firewall_dir}/$vmid.fw");
7136 }
6738ab9c 7137
e8b07b29 7138 $virtdev_hash = $parse_backup_hints->($rpcenv, $user, $cfg, $fh, $devinfo, $opts);
91bd6c90 7139
c8964278
FE
7140 foreach my $info (values %{$virtdev_hash}) {
7141 my $storeid = $info->{storeid};
7142 next if defined($storage_limits{$storeid});
7143
7144 my $limit = PVE::Storage::get_bandwidth_limit('restore', [$storeid], $bwlimit) // 0;
7145 print STDERR "rate limit for storage $storeid: $limit KiB/s\n" if $limit;
7146 $storage_limits{$storeid} = $limit * 1024;
7c536e11
WB
7147 }
7148
91bd6c90 7149 foreach my $devname (keys %$devinfo) {
be190583
DM
7150 die "found no device mapping information for device '$devname'\n"
7151 if !$devinfo->{$devname}->{virtdev};
91bd6c90
DM
7152 }
7153
ed221350 7154 # create empty/temp config
be190583 7155 if ($oldconf) {
ed221350 7156 PVE::Tools::file_set_contents($conffile, "memory: 128\n");
d1e92cf6 7157 $restore_cleanup_oldconf->($cfg, $vmid, $oldconf, $virtdev_hash);
ed221350
DM
7158 }
7159
9f3d73bc
DM
7160 # allocate volumes
7161 my $map = $restore_allocate_devices->($cfg, $virtdev_hash, $vmid);
7162
7163 # print restore information to $fifofh
91bd6c90
DM
7164 foreach my $virtdev (sort keys %$virtdev_hash) {
7165 my $d = $virtdev_hash->{$virtdev};
9f3d73bc
DM
7166 next if $d->{is_cloudinit}; # no need to restore cloudinit
7167
7c536e11 7168 my $storeid = $d->{storeid};
9f3d73bc 7169 my $volid = $d->{volid};
7c536e11
WB
7170
7171 my $map_opts = '';
7172 if (my $limit = $storage_limits{$storeid}) {
7173 $map_opts .= "throttling.bps=$limit:throttling.group=$storeid:";
7174 }
8fd57431 7175
91bd6c90 7176 my $write_zeros = 1;
88240a83 7177 if (PVE::Storage::volume_has_feature($cfg, 'sparseinit', $volid)) {
91bd6c90
DM
7178 $write_zeros = 0;
7179 }
7180
9f3d73bc 7181 my $path = PVE::Storage::path($cfg, $volid);
87056e18 7182
9f3d73bc 7183 print $fifofh "${map_opts}format=$d->{format}:${write_zeros}:$d->{devname}=$path\n";
91bd6c90 7184
9f3d73bc 7185 print "map '$d->{devname}' to '$path' (write zeros = ${write_zeros})\n";
91bd6c90
DM
7186 }
7187
7188 $fh->seek(0, 0) || die "seek failed - $!\n";
7189
91bd6c90
DM
7190 my $cookie = { netcount => 0 };
7191 while (defined(my $line = <$fh>)) {
c62d7cf5 7192 $new_conf_raw .= restore_update_config_line(
98a4b3fb 7193 $cookie,
98a4b3fb
FE
7194 $map,
7195 $line,
7196 $opts->{unique},
7197 );
91bd6c90
DM
7198 }
7199
7200 $fh->close();
91bd6c90
DM
7201 };
7202
7203 eval {
7204 # enable interrupts
6cb0144a
EK
7205 local $SIG{INT} =
7206 local $SIG{TERM} =
7207 local $SIG{QUIT} =
7208 local $SIG{HUP} =
7209 local $SIG{PIPE} = sub { die "interrupted by signal\n"; };
91bd6c90
DM
7210 local $SIG{ALRM} = sub { die "got timeout\n"; };
7211
7212 $oldtimeout = alarm($timeout);
7213
7214 my $parser = sub {
7215 my $line = shift;
7216
7217 print "$line\n";
7218
7219 if ($line =~ m/^DEV:\sdev_id=(\d+)\ssize:\s(\d+)\sdevname:\s(\S+)$/) {
7220 my ($dev_id, $size, $devname) = ($1, $2, $3);
7221 $devinfo->{$devname} = { size => $size, dev_id => $dev_id };
7222 } elsif ($line =~ m/^CTIME: /) {
46f58b5f 7223 # we correctly received the vma config, so we can disable
3cf90d7a
DM
7224 # the timeout now for disk allocation (set to 10 minutes, so
7225 # that we always timeout if something goes wrong)
7226 alarm(600);
91bd6c90
DM
7227 &$print_devmap();
7228 print $fifofh "done\n";
7229 my $tmp = $oldtimeout || 0;
7230 $oldtimeout = undef;
7231 alarm($tmp);
7232 close($fifofh);
808a65b5 7233 $fifofh = undef;
91bd6c90
DM
7234 }
7235 };
be190583 7236
7c536e11
WB
7237 print "restore vma archive: $dbg_cmdstring\n";
7238 run_command($commands, input => $input, outfunc => $parser, afterfork => $openfifo);
91bd6c90
DM
7239 };
7240 my $err = $@;
7241
7242 alarm($oldtimeout) if $oldtimeout;
7243
e8b07b29 7244 $restore_deactivate_volumes->($cfg, $virtdev_hash);
5f96f4df 7245
808a65b5 7246 close($fifofh) if $fifofh;
91bd6c90 7247 unlink $mapfifo;
9f3d73bc 7248 rmtree $tmpdir;
91bd6c90
DM
7249
7250 if ($err) {
e8b07b29 7251 $restore_destroy_volumes->($cfg, $virtdev_hash);
91bd6c90
DM
7252 die $err;
7253 }
7254
202a2a0b
FE
7255 my $new_conf = $restore_merge_config->($conffile, $new_conf_raw, $opts->{override_conf});
7256 PVE::QemuConfig->write_config($vmid, $new_conf);
ed221350 7257
91bd6c90
DM
7258 eval { rescan($vmid, 1); };
7259 warn $@ if $@;
26731a3c
SR
7260
7261 PVE::AccessControl::add_vm_to_pool($vmid, $opts->{pool}) if $opts->{pool};
91bd6c90
DM
7262}
7263
7264sub restore_tar_archive {
7265 my ($archive, $vmid, $user, $opts) = @_;
7266
202a2a0b
FE
7267 if (scalar(keys $opts->{override_conf}->%*) > 0) {
7268 my $keystring = join(' ', keys $opts->{override_conf}->%*);
7269 die "cannot pass along options ($keystring) when restoring from tar archive\n";
7270 }
7271
9c502e26 7272 if ($archive ne '-') {
ed221350 7273 my $firstfile = tar_archive_read_firstfile($archive);
32e54050 7274 die "ERROR: file '$archive' does not look like a QemuServer vzdump backup\n"
9c502e26
DM
7275 if $firstfile ne 'qemu-server.conf';
7276 }
3e16d5fc 7277
20519efc 7278 my $storecfg = PVE::Storage::config();
ebb55558 7279
4b026937
TL
7280 # avoid zombie disks when restoring over an existing VM -> cleanup first
7281 # pass keep_empty_config=1 to keep the config (thus VMID) reserved for us
7282 # skiplock=1 because qmrestore has set the 'create' lock itself already
ffda963f 7283 my $vmcfgfn = PVE::QemuConfig->config_file($vmid);
b04ea584 7284 destroy_vm($storecfg, $vmid, 1, { lock => 'restore' }) if -f $vmcfgfn;
ed221350 7285
3e16d5fc
DM
7286 my $tocmd = "/usr/lib/qemu-server/qmextract";
7287
2415a446 7288 $tocmd .= " --storage " . PVE::Tools::shellquote($opts->{storage}) if $opts->{storage};
a0d1b1a2 7289 $tocmd .= " --pool " . PVE::Tools::shellquote($opts->{pool}) if $opts->{pool};
3e16d5fc
DM
7290 $tocmd .= ' --prealloc' if $opts->{prealloc};
7291 $tocmd .= ' --info' if $opts->{info};
7292
a0d1b1a2 7293 # tar option "xf" does not autodetect compression when read from STDIN,
9c502e26 7294 # so we pipe to zcat
2415a446
DM
7295 my $cmd = "zcat -f|tar xf " . PVE::Tools::shellquote($archive) . " " .
7296 PVE::Tools::shellquote("--to-command=$tocmd");
3e16d5fc
DM
7297
7298 my $tmpdir = "/var/tmp/vzdumptmp$$";
7299 mkpath $tmpdir;
7300
7301 local $ENV{VZDUMP_TMPDIR} = $tmpdir;
7302 local $ENV{VZDUMP_VMID} = $vmid;
a0d1b1a2 7303 local $ENV{VZDUMP_USER} = $user;
3e16d5fc 7304
ffda963f 7305 my $conffile = PVE::QemuConfig->config_file($vmid);
98a4b3fb 7306 my $new_conf_raw = '';
3e16d5fc
DM
7307
7308 # disable interrupts (always do cleanups)
6cb0144a
EK
7309 local $SIG{INT} =
7310 local $SIG{TERM} =
7311 local $SIG{QUIT} =
7312 local $SIG{HUP} = sub { print STDERR "got interrupt - ignored\n"; };
3e16d5fc 7313
afdb31d5 7314 eval {
3e16d5fc 7315 # enable interrupts
6cb0144a
EK
7316 local $SIG{INT} =
7317 local $SIG{TERM} =
7318 local $SIG{QUIT} =
7319 local $SIG{HUP} =
7320 local $SIG{PIPE} = sub { die "interrupted by signal\n"; };
3e16d5fc 7321
9c502e26
DM
7322 if ($archive eq '-') {
7323 print "extracting archive from STDIN\n";
7324 run_command($cmd, input => "<&STDIN");
7325 } else {
7326 print "extracting archive '$archive'\n";
7327 run_command($cmd);
7328 }
3e16d5fc
DM
7329
7330 return if $opts->{info};
7331
7332 # read new mapping
7333 my $map = {};
7334 my $statfile = "$tmpdir/qmrestore.stat";
7335 if (my $fd = IO::File->new($statfile, "r")) {
7336 while (defined (my $line = <$fd>)) {
7337 if ($line =~ m/vzdump:([^\s:]*):(\S+)$/) {
7338 $map->{$1} = $2 if $1;
7339 } else {
7340 print STDERR "unable to parse line in statfile - $line\n";
7341 }
7342 }
7343 $fd->close();
7344 }
7345
7346 my $confsrc = "$tmpdir/qemu-server.conf";
7347
f7d1505b 7348 my $srcfd = IO::File->new($confsrc, "r") || die "unable to open file '$confsrc'\n";
3e16d5fc 7349
91bd6c90 7350 my $cookie = { netcount => 0 };
3e16d5fc 7351 while (defined (my $line = <$srcfd>)) {
c62d7cf5 7352 $new_conf_raw .= restore_update_config_line(
98a4b3fb 7353 $cookie,
98a4b3fb
FE
7354 $map,
7355 $line,
7356 $opts->{unique},
7357 );
3e16d5fc
DM
7358 }
7359
7360 $srcfd->close();
3e16d5fc 7361 };
7dc7f315 7362 if (my $err = $@) {
ed221350 7363 tar_restore_cleanup($storecfg, "$tmpdir/qmrestore.stat") if !$opts->{info};
3e16d5fc 7364 die $err;
afdb31d5 7365 }
3e16d5fc
DM
7366
7367 rmtree $tmpdir;
7368
98a4b3fb 7369 PVE::Tools::file_set_contents($conffile, $new_conf_raw);
91bd6c90 7370
ed221350
DM
7371 PVE::Cluster::cfs_update(); # make sure we read new file
7372
91bd6c90
DM
7373 eval { rescan($vmid, 1); };
7374 warn $@ if $@;
3e16d5fc
DM
7375};
7376
65a5ce88 7377sub foreach_storage_used_by_vm {
18bfb361
DM
7378 my ($conf, $func) = @_;
7379
7380 my $sidhash = {};
7381
912792e2 7382 PVE::QemuConfig->foreach_volume($conf, sub {
8ddbcf8b
FG
7383 my ($ds, $drive) = @_;
7384 return if drive_is_cdrom($drive);
18bfb361
DM
7385
7386 my $volid = $drive->{file};
7387
7388 my ($sid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
be190583 7389 $sidhash->{$sid} = $sid if $sid;
8ddbcf8b 7390 });
18bfb361
DM
7391
7392 foreach my $sid (sort keys %$sidhash) {
7393 &$func($sid);
7394 }
7395}
7396
6c9f59c1
TL
7397my $qemu_snap_storage = {
7398 rbd => 1,
7399};
e5eaa028 7400sub do_snapshots_with_qemu {
9d83932d
SR
7401 my ($storecfg, $volid, $deviceid) = @_;
7402
7403 return if $deviceid =~ m/tpmstate0/;
e5eaa028
WL
7404
7405 my $storage_name = PVE::Storage::parse_volume_id($volid);
8aa2ed7c 7406 my $scfg = $storecfg->{ids}->{$storage_name};
f7d1505b 7407 die "could not find storage '$storage_name'\n" if !defined($scfg);
e5eaa028 7408
8aa2ed7c 7409 if ($qemu_snap_storage->{$scfg->{type}} && !$scfg->{krbd}){
e5eaa028
WL
7410 return 1;
7411 }
7412
7413 if ($volid =~ m/\.(qcow2|qed)$/){
7414 return 1;
7415 }
7416
d1c1af4b 7417 return;
e5eaa028
WL
7418}
7419
4dcc780c 7420sub qga_check_running {
a4938c72 7421 my ($vmid, $nowarn) = @_;
4dcc780c 7422
0a13e08e 7423 eval { mon_cmd($vmid, "guest-ping", timeout => 3); };
4dcc780c 7424 if ($@) {
a4938c72 7425 warn "Qemu Guest Agent is not running - $@" if !$nowarn;
4dcc780c
WL
7426 return 0;
7427 }
7428 return 1;
7429}
7430
04a69bb4
AD
7431sub template_create {
7432 my ($vmid, $conf, $disk) = @_;
7433
04a69bb4 7434 my $storecfg = PVE::Storage::config();
04a69bb4 7435
912792e2 7436 PVE::QemuConfig->foreach_volume($conf, sub {
9cd07842
DM
7437 my ($ds, $drive) = @_;
7438
7439 return if drive_is_cdrom($drive);
7440 return if $disk && $ds ne $disk;
7441
7442 my $volid = $drive->{file};
bbd56097 7443 return if !PVE::Storage::volume_has_feature($storecfg, 'template', $volid);
9cd07842 7444
04a69bb4
AD
7445 my $voliddst = PVE::Storage::vdisk_create_base($storecfg, $volid);
7446 $drive->{file} = $voliddst;
71c58bb7 7447 $conf->{$ds} = print_drive($drive);
ffda963f 7448 PVE::QemuConfig->write_config($vmid, $conf);
04a69bb4 7449 });
04a69bb4
AD
7450}
7451
92bdc3f0
DC
7452sub convert_iscsi_path {
7453 my ($path) = @_;
7454
7455 if ($path =~ m|^iscsi://([^/]+)/([^/]+)/(.+)$|) {
7456 my $portal = $1;
7457 my $target = $2;
7458 my $lun = $3;
7459
7460 my $initiator_name = get_initiator_name();
7461
7462 return "file.driver=iscsi,file.transport=tcp,file.initiator-name=$initiator_name,".
7463 "file.portal=$portal,file.target=$target,file.lun=$lun,driver=raw";
7464 }
7465
7466 die "cannot convert iscsi path '$path', unkown format\n";
7467}
7468
5133de42 7469sub qemu_img_convert {
988e2714 7470 my ($src_volid, $dst_volid, $size, $snapname, $is_zero_initialized) = @_;
5133de42
AD
7471
7472 my $storecfg = PVE::Storage::config();
7473 my ($src_storeid, $src_volname) = PVE::Storage::parse_volume_id($src_volid, 1);
7474 my ($dst_storeid, $dst_volname) = PVE::Storage::parse_volume_id($dst_volid, 1);
7475
af1f1ec0 7476 die "destination '$dst_volid' is not a valid volid form qemu-img convert\n" if !$dst_storeid;
6bb91c17 7477
af1f1ec0
DC
7478 my $cachemode;
7479 my $src_path;
7480 my $src_is_iscsi = 0;
bdd1feef 7481 my $src_format;
6bb91c17 7482
af1f1ec0
DC
7483 if ($src_storeid) {
7484 PVE::Storage::activate_volumes($storecfg, [$src_volid], $snapname);
5133de42 7485 my $src_scfg = PVE::Storage::storage_config($storecfg, $src_storeid);
af1f1ec0
DC
7486 $src_format = qemu_img_format($src_scfg, $src_volname);
7487 $src_path = PVE::Storage::path($storecfg, $src_volid, $snapname);
7488 $src_is_iscsi = ($src_path =~ m|^iscsi://|);
7489 $cachemode = 'none' if $src_scfg->{type} eq 'zfspool';
a23d57d5 7490 } elsif (-f $src_volid || -b $src_volid) {
af1f1ec0 7491 $src_path = $src_volid;
e0fd2b2f 7492 if ($src_path =~ m/\.($PVE::QemuServer::Drive::QEMU_FORMAT_RE)$/) {
af1f1ec0
DC
7493 $src_format = $1;
7494 }
7495 }
5133de42 7496
af1f1ec0 7497 die "source '$src_volid' is not a valid volid nor path for qemu-img convert\n" if !$src_path;
5133de42 7498
af1f1ec0
DC
7499 my $dst_scfg = PVE::Storage::storage_config($storecfg, $dst_storeid);
7500 my $dst_format = qemu_img_format($dst_scfg, $dst_volname);
7501 my $dst_path = PVE::Storage::path($storecfg, $dst_volid);
7502 my $dst_is_iscsi = ($dst_path =~ m|^iscsi://|);
5133de42 7503
af1f1ec0
DC
7504 my $cmd = [];
7505 push @$cmd, '/usr/bin/qemu-img', 'convert', '-p', '-n';
bdd1feef
TL
7506 push @$cmd, '-l', "snapshot.name=$snapname"
7507 if $snapname && $src_format && $src_format eq "qcow2";
af1f1ec0
DC
7508 push @$cmd, '-t', 'none' if $dst_scfg->{type} eq 'zfspool';
7509 push @$cmd, '-T', $cachemode if defined($cachemode);
7510
7511 if ($src_is_iscsi) {
7512 push @$cmd, '--image-opts';
7513 $src_path = convert_iscsi_path($src_path);
bdd1feef 7514 } elsif ($src_format) {
af1f1ec0
DC
7515 push @$cmd, '-f', $src_format;
7516 }
92bdc3f0 7517
af1f1ec0
DC
7518 if ($dst_is_iscsi) {
7519 push @$cmd, '--target-image-opts';
7520 $dst_path = convert_iscsi_path($dst_path);
7521 } else {
7522 push @$cmd, '-O', $dst_format;
7523 }
92bdc3f0 7524
af1f1ec0 7525 push @$cmd, $src_path;
92bdc3f0 7526
af1f1ec0
DC
7527 if (!$dst_is_iscsi && $is_zero_initialized) {
7528 push @$cmd, "zeroinit:$dst_path";
7529 } else {
7530 push @$cmd, $dst_path;
7531 }
92bdc3f0 7532
af1f1ec0
DC
7533 my $parser = sub {
7534 my $line = shift;
7535 if($line =~ m/\((\S+)\/100\%\)/){
7536 my $percent = $1;
7537 my $transferred = int($size * $percent / 100);
b5e9d97b
TL
7538 my $total_h = render_bytes($size, 1);
7539 my $transferred_h = render_bytes($transferred, 1);
92bdc3f0 7540
6629f976 7541 print "transferred $transferred_h of $total_h ($percent%)\n";
988e2714 7542 }
5133de42 7543
af1f1ec0 7544 };
5133de42 7545
af1f1ec0
DC
7546 eval { run_command($cmd, timeout => undef, outfunc => $parser); };
7547 my $err = $@;
7548 die "copy failed: $err" if $err;
5133de42
AD
7549}
7550
7551sub qemu_img_format {
7552 my ($scfg, $volname) = @_;
7553
e0fd2b2f 7554 if ($scfg->{path} && $volname =~ m/\.($PVE::QemuServer::Drive::QEMU_FORMAT_RE)$/) {
5133de42 7555 return $1;
be190583 7556 } else {
5133de42 7557 return "raw";
5133de42
AD
7558 }
7559}
7560
cfad42af 7561sub qemu_drive_mirror {
bc6c8231 7562 my ($vmid, $drive, $dst_volid, $vmiddst, $is_zero_initialized, $jobs, $completion, $qga, $bwlimit, $src_bitmap) = @_;
cfad42af 7563
5a345967
AD
7564 $jobs = {} if !$jobs;
7565
7566 my $qemu_target;
7567 my $format;
35e4ab04 7568 $jobs->{"drive-$drive"} = {};
152fe752 7569
1e5143de 7570 if ($dst_volid =~ /^nbd:/) {
87955688 7571 $qemu_target = $dst_volid;
5a345967 7572 $format = "nbd";
5a345967 7573 } else {
5a345967
AD
7574 my $storecfg = PVE::Storage::config();
7575 my ($dst_storeid, $dst_volname) = PVE::Storage::parse_volume_id($dst_volid);
7576
7577 my $dst_scfg = PVE::Storage::storage_config($storecfg, $dst_storeid);
cfad42af 7578
5a345967 7579 $format = qemu_img_format($dst_scfg, $dst_volname);
21ccdb50 7580
5a345967 7581 my $dst_path = PVE::Storage::path($storecfg, $dst_volid);
21ccdb50 7582
5a345967
AD
7583 $qemu_target = $is_zero_initialized ? "zeroinit:$dst_path" : $dst_path;
7584 }
988e2714
WB
7585
7586 my $opts = { timeout => 10, device => "drive-$drive", mode => "existing", sync => "full", target => $qemu_target };
88383920
DM
7587 $opts->{format} = $format if $format;
7588
bc6c8231
FG
7589 if (defined($src_bitmap)) {
7590 $opts->{sync} = 'incremental';
7591 $opts->{bitmap} = $src_bitmap;
7592 print "drive mirror re-using dirty bitmap '$src_bitmap'\n";
7593 }
7594
9fa05d31 7595 if (defined($bwlimit)) {
f6409f61
TL
7596 $opts->{speed} = $bwlimit * 1024;
7597 print "drive mirror is starting for drive-$drive with bandwidth limit: ${bwlimit} KB/s\n";
9fa05d31
SI
7598 } else {
7599 print "drive mirror is starting for drive-$drive\n";
7600 }
21ccdb50 7601
6dde5ea2 7602 # if a job already runs for this device we get an error, catch it for cleanup
0a13e08e 7603 eval { mon_cmd($vmid, "drive-mirror", %$opts); };
5a345967
AD
7604 if (my $err = $@) {
7605 eval { PVE::QemuServer::qemu_blockjobs_cancel($vmid, $jobs) };
6dde5ea2
TL
7606 warn "$@\n" if $@;
7607 die "mirroring error: $err\n";
5a345967
AD
7608 }
7609
e02fb126 7610 qemu_drive_mirror_monitor ($vmid, $vmiddst, $jobs, $completion, $qga);
5a345967
AD
7611}
7612
db1f8b39
FG
7613# $completion can be either
7614# 'complete': wait until all jobs are ready, block-job-complete them (default)
7615# 'cancel': wait until all jobs are ready, block-job-cancel them
7616# 'skip': wait until all jobs are ready, return with block jobs in ready state
9e671722 7617# 'auto': wait until all jobs disappear, only use for jobs which complete automatically
5a345967 7618sub qemu_drive_mirror_monitor {
9e671722 7619 my ($vmid, $vmiddst, $jobs, $completion, $qga, $op) = @_;
e02fb126 7620
db1f8b39 7621 $completion //= 'complete';
9e671722 7622 $op //= "mirror";
2e953867 7623
08ac653f 7624 eval {
5a345967
AD
7625 my $err_complete = 0;
7626
3b56383b 7627 my $starttime = time ();
08ac653f 7628 while (1) {
9e671722 7629 die "block job ('$op') timed out\n" if $err_complete > 300;
5a345967 7630
0a13e08e 7631 my $stats = mon_cmd($vmid, "query-block-jobs");
3b56383b 7632 my $ctime = time();
08ac653f 7633
9e671722 7634 my $running_jobs = {};
0ea24bf0 7635 for my $stat (@$stats) {
9e671722
SR
7636 next if $stat->{type} ne $op;
7637 $running_jobs->{$stat->{device}} = $stat;
5a345967 7638 }
08ac653f 7639
5a345967 7640 my $readycounter = 0;
67fb9de6 7641
0ea24bf0 7642 for my $job_id (sort keys %$jobs) {
1057fc74 7643 my $job = $running_jobs->{$job_id};
5a345967 7644
1057fc74 7645 my $vanished = !defined($job);
0ea24bf0 7646 my $complete = defined($jobs->{$job_id}->{complete}) && $vanished;
9e671722 7647 if($complete || ($vanished && $completion eq 'auto')) {
3b56383b 7648 print "$job_id: $op-job finished\n";
0ea24bf0 7649 delete $jobs->{$job_id};
5a345967
AD
7650 next;
7651 }
7652
1057fc74 7653 die "$job_id: '$op' has been cancelled\n" if !defined($job);
f34ebd52 7654
1057fc74
TL
7655 my $busy = $job->{busy};
7656 my $ready = $job->{ready};
7657 if (my $total = $job->{len}) {
7658 my $transferred = $job->{offset} || 0;
5a345967
AD
7659 my $remaining = $total - $transferred;
7660 my $percent = sprintf "%.2f", ($transferred * 100 / $total);
08ac653f 7661
3b56383b
TL
7662 my $duration = $ctime - $starttime;
7663 my $total_h = render_bytes($total, 1);
7664 my $transferred_h = render_bytes($transferred, 1);
7665
7666 my $status = sprintf(
7667 "transferred $transferred_h of $total_h ($percent%%) in %s",
7668 render_duration($duration),
7669 );
7670
7671 if ($ready) {
7672 if ($busy) {
7673 $status .= ", still busy"; # shouldn't even happen? but mirror is weird
7674 } else {
7675 $status .= ", ready";
7676 }
7677 }
67daf692
TL
7678 print "$job_id: $status\n" if !$jobs->{$job_id}->{ready};
7679 $jobs->{$job_id}->{ready} = $ready;
5a345967 7680 }
f34ebd52 7681
1057fc74 7682 $readycounter++ if $job->{ready};
5a345967 7683 }
b467f79a 7684
5a345967
AD
7685 last if scalar(keys %$jobs) == 0;
7686
7687 if ($readycounter == scalar(keys %$jobs)) {
9e671722
SR
7688 print "all '$op' jobs are ready\n";
7689
7690 # do the complete later (or has already been done)
7691 last if $completion eq 'skip' || $completion eq 'auto';
5a345967
AD
7692
7693 if ($vmiddst && $vmiddst != $vmid) {
1a988fd2
DC
7694 my $agent_running = $qga && qga_check_running($vmid);
7695 if ($agent_running) {
5619e74a 7696 print "freeze filesystem\n";
0a13e08e 7697 eval { mon_cmd($vmid, "guest-fsfreeze-freeze"); };
d6cdfae4 7698 warn $@ if $@;
5619e74a
AD
7699 } else {
7700 print "suspend vm\n";
7701 eval { PVE::QemuServer::vm_suspend($vmid, 1); };
d6cdfae4 7702 warn $@ if $@;
5619e74a
AD
7703 }
7704
5a345967
AD
7705 # if we clone a disk for a new target vm, we don't switch the disk
7706 PVE::QemuServer::qemu_blockjobs_cancel($vmid, $jobs);
5619e74a 7707
1a988fd2 7708 if ($agent_running) {
5619e74a 7709 print "unfreeze filesystem\n";
0a13e08e 7710 eval { mon_cmd($vmid, "guest-fsfreeze-thaw"); };
d6cdfae4 7711 warn $@ if $@;
5619e74a
AD
7712 } else {
7713 print "resume vm\n";
d6cdfae4
FE
7714 eval { PVE::QemuServer::vm_resume($vmid, 1, 1); };
7715 warn $@ if $@;
5619e74a
AD
7716 }
7717
2e953867 7718 last;
5a345967
AD
7719 } else {
7720
0ea24bf0 7721 for my $job_id (sort keys %$jobs) {
5a345967 7722 # try to switch the disk if source and destination are on the same guest
0ea24bf0 7723 print "$job_id: Completing block job_id...\n";
5a345967 7724
e02fb126 7725 my $op;
db1f8b39 7726 if ($completion eq 'complete') {
e02fb126 7727 $op = 'block-job-complete';
db1f8b39 7728 } elsif ($completion eq 'cancel') {
e02fb126
ML
7729 $op = 'block-job-cancel';
7730 } else {
7731 die "invalid completion value: $completion\n";
7732 }
0ea24bf0 7733 eval { mon_cmd($vmid, $op, device => $job_id) };
5a345967 7734 if ($@ =~ m/cannot be completed/) {
3b56383b 7735 print "$job_id: block job cannot be completed, trying again.\n";
5a345967
AD
7736 $err_complete++;
7737 }else {
0ea24bf0
TL
7738 print "$job_id: Completed successfully.\n";
7739 $jobs->{$job_id}->{complete} = 1;
5a345967
AD
7740 }
7741 }
2e953867 7742 }
08ac653f 7743 }
08ac653f 7744 sleep 1;
cfad42af 7745 }
08ac653f 7746 };
88383920 7747 my $err = $@;
08ac653f 7748
88383920 7749 if ($err) {
5a345967 7750 eval { PVE::QemuServer::qemu_blockjobs_cancel($vmid, $jobs) };
3b56383b 7751 die "block job ($op) error: $err";
88383920 7752 }
5a345967
AD
7753}
7754
7755sub qemu_blockjobs_cancel {
7756 my ($vmid, $jobs) = @_;
7757
7758 foreach my $job (keys %$jobs) {
bd2d5fe6 7759 print "$job: Cancelling block job\n";
0a13e08e 7760 eval { mon_cmd($vmid, "block-job-cancel", device => $job); };
5a345967
AD
7761 $jobs->{$job}->{cancel} = 1;
7762 }
7763
7764 while (1) {
0a13e08e 7765 my $stats = mon_cmd($vmid, "query-block-jobs");
5a345967
AD
7766
7767 my $running_jobs = {};
7768 foreach my $stat (@$stats) {
7769 $running_jobs->{$stat->{device}} = $stat;
7770 }
7771
7772 foreach my $job (keys %$jobs) {
7773
bd2d5fe6
WB
7774 if (defined($jobs->{$job}->{cancel}) && !defined($running_jobs->{$job})) {
7775 print "$job: Done.\n";
5a345967
AD
7776 delete $jobs->{$job};
7777 }
7778 }
7779
7780 last if scalar(keys %$jobs) == 0;
7781
7782 sleep 1;
cfad42af
AD
7783 }
7784}
7785
152fe752 7786sub clone_disk {
1196086f
FE
7787 my ($storecfg, $source, $dest, $full, $newvollist, $jobs, $completion, $qga, $bwlimit) = @_;
7788
7789 my ($vmid, $running) = $source->@{qw(vmid running)};
25166060 7790 my ($src_drivename, $drive, $snapname) = $source->@{qw(drivename drive snapname)};
1196086f 7791
25166060 7792 my ($newvmid, $dst_drivename, $efisize) = $dest->@{qw(vmid drivename efisize)};
1196086f 7793 my ($storage, $format) = $dest->@{qw(storage format)};
152fe752 7794
5f957592
FE
7795 my $use_drive_mirror = $full && $running && $src_drivename && !$snapname;
7796
25166060
FE
7797 if ($src_drivename && $dst_drivename && $src_drivename ne $dst_drivename) {
7798 die "cloning from/to EFI disk requires EFI disk\n"
7799 if $src_drivename eq 'efidisk0' || $dst_drivename eq 'efidisk0';
7800 die "cloning from/to TPM state requires TPM state\n"
7801 if $src_drivename eq 'tpmstate0' || $dst_drivename eq 'tpmstate0';
5f957592
FE
7802
7803 # This would lead to two device nodes in QEMU pointing to the same backing image!
7804 die "cannot change drive name when cloning disk from/to the same VM\n"
7805 if $use_drive_mirror && $vmid == $newvmid;
25166060
FE
7806 }
7807
1d1f8f9a
FE
7808 die "cannot move TPM state while VM is running\n"
7809 if $use_drive_mirror && $src_drivename eq 'tpmstate0';
7810
152fe752
DM
7811 my $newvolid;
7812
25166060
FE
7813 print "create " . ($full ? 'full' : 'linked') . " clone of drive ";
7814 print "$src_drivename " if $src_drivename;
7815 print "($drive->{file})\n";
7816
152fe752 7817 if (!$full) {
258e646c 7818 $newvolid = PVE::Storage::vdisk_clone($storecfg, $drive->{file}, $newvmid, $snapname);
152fe752
DM
7819 push @$newvollist, $newvolid;
7820 } else {
5a345967 7821
152fe752
DM
7822 my ($storeid, $volname) = PVE::Storage::parse_volume_id($drive->{file});
7823 $storeid = $storage if $storage;
7824
44549149 7825 my $dst_format = resolve_dst_disk_format($storecfg, $storeid, $volname, $format);
152fe752 7826
931432bd 7827 my $name = undef;
d0abc774 7828 my $size = undef;
7fe8b44c
TL
7829 if (drive_is_cloudinit($drive)) {
7830 $name = "vm-$newvmid-cloudinit";
c997e24a
ML
7831 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
7832 if ($scfg->{path}) {
7833 $name .= ".$dst_format";
7834 }
7fe8b44c
TL
7835 $snapname = undef;
7836 $size = PVE::QemuServer::Cloudinit::CLOUDINIT_DISK_SIZE;
25166060 7837 } elsif ($dst_drivename eq 'efidisk0') {
7344af7b 7838 $size = $efisize or die "internal error - need to specify EFI disk size\n";
25166060 7839 } elsif ($dst_drivename eq 'tpmstate0') {
5f5aba25 7840 $dst_format = 'raw';
f9dde219 7841 $size = PVE::QemuServer::Drive::TPMSTATE_DISK_SIZE;
d0abc774 7842 } else {
3bae384f 7843 ($size) = PVE::Storage::volume_size_info($storecfg, $drive->{file}, 10);
7fe8b44c 7844 }
b5688f69
FE
7845 $newvolid = PVE::Storage::vdisk_alloc(
7846 $storecfg, $storeid, $newvmid, $dst_format, $name, ($size/1024)
7847 );
152fe752
DM
7848 push @$newvollist, $newvolid;
7849
3999f370 7850 PVE::Storage::activate_volumes($storecfg, [$newvolid]);
1dbd6d30 7851
7fe8b44c 7852 if (drive_is_cloudinit($drive)) {
1b485263
ML
7853 # when cloning multiple disks (e.g. during clone_vm) it might be the last disk
7854 # if this is the case, we have to complete any block-jobs still there from
7855 # previous drive-mirrors
7856 if (($completion eq 'complete') && (scalar(keys %$jobs) > 0)) {
7857 qemu_drive_mirror_monitor($vmid, $newvmid, $jobs, $completion, $qga);
7858 }
7fe8b44c
TL
7859 goto no_data_clone;
7860 }
7861
988e2714 7862 my $sparseinit = PVE::Storage::volume_has_feature($storecfg, 'sparseinit', $newvolid);
5f957592 7863 if ($use_drive_mirror) {
5f957592
FE
7864 qemu_drive_mirror($vmid, $src_drivename, $newvolid, $newvmid, $sparseinit, $jobs,
7865 $completion, $qga, $bwlimit);
7866 } else {
d189e590 7867 # TODO: handle bwlimits
25166060 7868 if ($dst_drivename eq 'efidisk0') {
818ce80e
DC
7869 # the relevant data on the efidisk may be smaller than the source
7870 # e.g. on RBD/ZFS, so we use dd to copy only the amount
7871 # that is given by the OVMF_VARS.fd
62375438 7872 my $src_path = PVE::Storage::path($storecfg, $drive->{file}, $snapname);
818ce80e 7873 my $dst_path = PVE::Storage::path($storecfg, $newvolid);
fdfdc80e 7874
62375438
FE
7875 my $src_format = (PVE::Storage::parse_volname($storecfg, $drive->{file}))[6];
7876
fdfdc80e
FE
7877 # better for Ceph if block size is not too small, see bug #3324
7878 my $bs = 1024*1024;
7879
62375438 7880 my $cmd = ['qemu-img', 'dd', '-n', '-O', $dst_format];
a9c45bd4
FE
7881
7882 if ($src_format eq 'qcow2' && $snapname) {
7883 die "cannot clone qcow2 EFI disk snapshot - requires QEMU >= 6.2\n"
7884 if !min_version(kvm_user_version(), 6, 2);
7885 push $cmd->@*, '-l', $snapname;
7886 }
62375438
FE
7887 push $cmd->@*, "bs=$bs", "osize=$size", "if=$src_path", "of=$dst_path";
7888 run_command($cmd);
818ce80e
DC
7889 } else {
7890 qemu_img_convert($drive->{file}, $newvolid, $size, $snapname, $sparseinit);
7891 }
be190583 7892 }
152fe752
DM
7893 }
7894
7fe8b44c 7895no_data_clone:
3bae384f 7896 my ($size) = eval { PVE::Storage::volume_size_info($storecfg, $newvolid, 10) };
152fe752 7897
3b53c471
FE
7898 my $disk = dclone($drive);
7899 delete $disk->{format};
152fe752 7900 $disk->{file} = $newvolid;
3bae384f 7901 $disk->{size} = $size if defined($size);
152fe752
DM
7902
7903 return $disk;
7904}
7905
98cfd8b6
AD
7906sub get_running_qemu_version {
7907 my ($vmid) = @_;
0a13e08e 7908 my $res = mon_cmd($vmid, "query-version");
98cfd8b6
AD
7909 return "$res->{qemu}->{major}.$res->{qemu}->{minor}";
7910}
7911
249c4a6c
AD
7912sub qemu_use_old_bios_files {
7913 my ($machine_type) = @_;
7914
7915 return if !$machine_type;
7916
7917 my $use_old_bios_files = undef;
7918
7919 if ($machine_type =~ m/^(\S+)\.pxe$/) {
7920 $machine_type = $1;
7921 $use_old_bios_files = 1;
7922 } else {
4df98f2f 7923 my $version = extract_version($machine_type, kvm_user_version());
249c4a6c
AD
7924 # Note: kvm version < 2.4 use non-efi pxe files, and have problems when we
7925 # load new efi bios files on migration. So this hack is required to allow
7926 # live migration from qemu-2.2 to qemu-2.4, which is sometimes used when
7927 # updrading from proxmox-ve-3.X to proxmox-ve 4.0
2ea5fb7e 7928 $use_old_bios_files = !min_version($version, 2, 4);
249c4a6c
AD
7929 }
7930
7931 return ($use_old_bios_files, $machine_type);
7932}
7933
818ce80e 7934sub get_efivars_size {
ff84f0e3
FE
7935 my ($conf, $efidisk) = @_;
7936
818ce80e 7937 my $arch = get_vm_arch($conf);
ff84f0e3 7938 $efidisk //= $conf->{efidisk0} ? parse_drive('efidisk0', $conf->{efidisk0}) : undef;
90b20b15
DC
7939 my $smm = PVE::QemuServer::Machine::machine_type_is_q35($conf);
7940 my (undef, $ovmf_vars) = get_ovmf_files($arch, $efidisk, $smm);
818ce80e
DC
7941 die "uefi vars image '$ovmf_vars' not found\n" if ! -f $ovmf_vars;
7942 return -s $ovmf_vars;
7943}
7944
7945sub update_efidisk_size {
7946 my ($conf) = @_;
7947
7948 return if !defined($conf->{efidisk0});
7949
7950 my $disk = PVE::QemuServer::parse_drive('efidisk0', $conf->{efidisk0});
7951 $disk->{size} = get_efivars_size($conf);
7952 $conf->{efidisk0} = print_drive($disk);
7953
7954 return;
7955}
7956
f9dde219
SR
7957sub update_tpmstate_size {
7958 my ($conf) = @_;
7959
7960 my $disk = PVE::QemuServer::parse_drive('tpmstate0', $conf->{tpmstate0});
7961 $disk->{size} = PVE::QemuServer::Drive::TPMSTATE_DISK_SIZE;
7962 $conf->{tpmstate0} = print_drive($disk);
7963}
7964
90b20b15
DC
7965sub create_efidisk($$$$$$$) {
7966 my ($storecfg, $storeid, $vmid, $fmt, $arch, $efidisk, $smm) = @_;
3e1f1122 7967
90b20b15 7968 my (undef, $ovmf_vars) = get_ovmf_files($arch, $efidisk, $smm);
96ed3574 7969 die "EFI vars default image not found\n" if ! -f $ovmf_vars;
3e1f1122 7970
af1f1ec0
DC
7971 my $vars_size_b = -s $ovmf_vars;
7972 my $vars_size = PVE::Tools::convert_size($vars_size_b, 'b' => 'kb');
3e1f1122
TL
7973 my $volid = PVE::Storage::vdisk_alloc($storecfg, $storeid, $vmid, $fmt, undef, $vars_size);
7974 PVE::Storage::activate_volumes($storecfg, [$volid]);
7975
af1f1ec0 7976 qemu_img_convert($ovmf_vars, $volid, $vars_size_b, undef, 0);
340dbcf7 7977 my ($size) = PVE::Storage::volume_size_info($storecfg, $volid, 3);
3e1f1122 7978
340dbcf7 7979 return ($volid, $size/1024);
3e1f1122
TL
7980}
7981
22de899a
AD
7982sub vm_iothreads_list {
7983 my ($vmid) = @_;
7984
0a13e08e 7985 my $res = mon_cmd($vmid, 'query-iothreads');
22de899a
AD
7986
7987 my $iothreads = {};
7988 foreach my $iothread (@$res) {
7989 $iothreads->{ $iothread->{id} } = $iothread->{"thread-id"};
7990 }
7991
7992 return $iothreads;
7993}
7994
ee034f5c
AD
7995sub scsihw_infos {
7996 my ($conf, $drive) = @_;
7997
7998 my $maxdev = 0;
7999
7fe1b688 8000 if (!$conf->{scsihw} || ($conf->{scsihw} =~ m/^lsi/)) {
ee034f5c 8001 $maxdev = 7;
a1511b3c 8002 } elsif ($conf->{scsihw} && ($conf->{scsihw} eq 'virtio-scsi-single')) {
ee034f5c
AD
8003 $maxdev = 1;
8004 } else {
8005 $maxdev = 256;
8006 }
8007
8008 my $controller = int($drive->{index} / $maxdev);
4df98f2f
TL
8009 my $controller_prefix = ($conf->{scsihw} && $conf->{scsihw} eq 'virtio-scsi-single')
8010 ? "virtioscsi"
8011 : "scsihw";
ee034f5c
AD
8012
8013 return ($maxdev, $controller, $controller_prefix);
8014}
a1511b3c 8015
44549149
EK
8016sub resolve_dst_disk_format {
8017 my ($storecfg, $storeid, $src_volname, $format) = @_;
8018 my ($defFormat, $validFormats) = PVE::Storage::storage_default_format($storecfg, $storeid);
8019
8020 if (!$format) {
8021 # if no target format is specified, use the source disk format as hint
8022 if ($src_volname) {
8023 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
8024 $format = qemu_img_format($scfg, $src_volname);
8025 } else {
8026 return $defFormat;
8027 }
8028 }
8029
8030 # test if requested format is supported - else use default
8031 my $supported = grep { $_ eq $format } @$validFormats;
8032 $format = $defFormat if !$supported;
8033 return $format;
8034}
8035
66cebc46
DC
8036# NOTE: if this logic changes, please update docs & possibly gui logic
8037sub find_vmstate_storage {
8038 my ($conf, $storecfg) = @_;
8039
8040 # first, return storage from conf if set
8041 return $conf->{vmstatestorage} if $conf->{vmstatestorage};
8042
8043 my ($target, $shared, $local);
8044
8045 foreach_storage_used_by_vm($conf, sub {
8046 my ($sid) = @_;
8047 my $scfg = PVE::Storage::storage_config($storecfg, $sid);
8048 my $dst = $scfg->{shared} ? \$shared : \$local;
8049 $$dst = $sid if !$$dst || $scfg->{path}; # prefer file based storage
8050 });
8051
8052 # second, use shared storage where VM has at least one disk
8053 # third, use local storage where VM has at least one disk
8054 # fall back to local storage
8055 $target = $shared // $local // 'local';
8056
8057 return $target;
8058}
8059
6ee499ff 8060sub generate_uuid {
ae2fcb3b
EK
8061 my ($uuid, $uuid_str);
8062 UUID::generate($uuid);
8063 UUID::unparse($uuid, $uuid_str);
6ee499ff
DC
8064 return $uuid_str;
8065}
8066
8067sub generate_smbios1_uuid {
8068 return "uuid=".generate_uuid();
ae2fcb3b
EK
8069}
8070
9c152e87
TL
8071sub nbd_stop {
8072 my ($vmid) = @_;
8073
0a13e08e 8074 mon_cmd($vmid, 'nbd-server-stop');
9c152e87
TL
8075}
8076
dae98db9
DC
8077sub create_reboot_request {
8078 my ($vmid) = @_;
8079 open(my $fh, '>', "/run/qemu-server/$vmid.reboot")
8080 or die "failed to create reboot trigger file: $!\n";
8081 close($fh);
8082}
8083
8084sub clear_reboot_request {
8085 my ($vmid) = @_;
8086 my $path = "/run/qemu-server/$vmid.reboot";
8087 my $res = 0;
8088
8089 $res = unlink($path);
8090 die "could not remove reboot request for $vmid: $!"
8091 if !$res && $! != POSIX::ENOENT;
8092
8093 return $res;
8094}
8095
5cfa9f5f
SR
8096sub bootorder_from_legacy {
8097 my ($conf, $bootcfg) = @_;
8098
8099 my $boot = $bootcfg->{legacy} || $boot_fmt->{legacy}->{default};
8100 my $bootindex_hash = {};
8101 my $i = 1;
8102 foreach my $o (split(//, $boot)) {
8103 $bootindex_hash->{$o} = $i*100;
8104 $i++;
8105 }
8106
8107 my $bootorder = {};
8108
8109 PVE::QemuConfig->foreach_volume($conf, sub {
8110 my ($ds, $drive) = @_;
8111
8112 if (drive_is_cdrom ($drive, 1)) {
8113 if ($bootindex_hash->{d}) {
8114 $bootorder->{$ds} = $bootindex_hash->{d};
8115 $bootindex_hash->{d} += 1;
8116 }
8117 } elsif ($bootindex_hash->{c}) {
8118 $bootorder->{$ds} = $bootindex_hash->{c}
8119 if $conf->{bootdisk} && $conf->{bootdisk} eq $ds;
8120 $bootindex_hash->{c} += 1;
8121 }
8122 });
8123
8124 if ($bootindex_hash->{n}) {
8125 for (my $i = 0; $i < $MAX_NETS; $i++) {
8126 my $netname = "net$i";
8127 next if !$conf->{$netname};
8128 $bootorder->{$netname} = $bootindex_hash->{n};
8129 $bootindex_hash->{n} += 1;
8130 }
8131 }
8132
8133 return $bootorder;
8134}
8135
8136# Generate default device list for 'boot: order=' property. Matches legacy
8137# default boot order, but with explicit device names. This is important, since
8138# the fallback for when neither 'order' nor the old format is specified relies
8139# on 'bootorder_from_legacy' above, and it would be confusing if this diverges.
8140sub get_default_bootdevices {
8141 my ($conf) = @_;
8142
8143 my @ret = ();
8144
8145 # harddisk
8146 my $first = PVE::QemuServer::Drive::resolve_first_disk($conf, 0);
8147 push @ret, $first if $first;
8148
8149 # cdrom
8150 $first = PVE::QemuServer::Drive::resolve_first_disk($conf, 1);
8151 push @ret, $first if $first;
8152
8153 # network
8154 for (my $i = 0; $i < $MAX_NETS; $i++) {
8155 my $netname = "net$i";
8156 next if !$conf->{$netname};
8157 push @ret, $netname;
8158 last;
8159 }
8160
8161 return \@ret;
8162}
8163
e5d611c3
TL
8164sub device_bootorder {
8165 my ($conf) = @_;
8166
8167 return bootorder_from_legacy($conf) if !defined($conf->{boot});
8168
8169 my $boot = parse_property_string($boot_fmt, $conf->{boot});
8170
8171 my $bootorder = {};
8172 if (!defined($boot) || $boot->{legacy}) {
8173 $bootorder = bootorder_from_legacy($conf, $boot);
8174 } elsif ($boot->{order}) {
8175 my $i = 100; # start at 100 to allow user to insert devices before us with -args
8176 for my $dev (PVE::Tools::split_list($boot->{order})) {
8177 $bootorder->{$dev} = $i++;
8178 }
8179 }
8180
8181 return $bootorder;
8182}
8183
65911545
SR
8184sub register_qmeventd_handle {
8185 my ($vmid) = @_;
8186
8187 my $fh;
8188 my $peer = "/var/run/qmeventd.sock";
8189 my $count = 0;
8190
8191 for (;;) {
8192 $count++;
8193 $fh = IO::Socket::UNIX->new(Peer => $peer, Blocking => 0, Timeout => 1);
8194 last if $fh;
8195 if ($! != EINTR && $! != EAGAIN) {
8196 die "unable to connect to qmeventd socket (vmid: $vmid) - $!\n";
8197 }
8198 if ($count > 4) {
8199 die "unable to connect to qmeventd socket (vmid: $vmid) - timeout "
8200 . "after $count retries\n";
8201 }
8202 usleep(25000);
8203 }
8204
8205 # send handshake to mark VM as backing up
8206 print $fh to_json({vzdump => {vmid => "$vmid"}});
8207
8208 # return handle to be closed later when inhibit is no longer required
8209 return $fh;
8210}
8211
65e866e5
DM
8212# bash completion helper
8213
8214sub complete_backup_archives {
8215 my ($cmdname, $pname, $cvalue) = @_;
8216
8217 my $cfg = PVE::Storage::config();
8218
8219 my $storeid;
8220
8221 if ($cvalue =~ m/^([^:]+):/) {
8222 $storeid = $1;
8223 }
8224
8225 my $data = PVE::Storage::template_list($cfg, $storeid, 'backup');
8226
8227 my $res = [];
8228 foreach my $id (keys %$data) {
8229 foreach my $item (@{$data->{$id}}) {
f43a4f12 8230 next if $item->{format} !~ m/^vma\.(${\PVE::Storage::Plugin::COMPRESSOR_RE})$/;
65e866e5
DM
8231 push @$res, $item->{volid} if defined($item->{volid});
8232 }
8233 }
8234
8235 return $res;
8236}
8237
8238my $complete_vmid_full = sub {
8239 my ($running) = @_;
8240
8241 my $idlist = vmstatus();
8242
8243 my $res = [];
8244
8245 foreach my $id (keys %$idlist) {
8246 my $d = $idlist->{$id};
8247 if (defined($running)) {
8248 next if $d->{template};
8249 next if $running && $d->{status} ne 'running';
8250 next if !$running && $d->{status} eq 'running';
8251 }
8252 push @$res, $id;
8253
8254 }
8255 return $res;
8256};
8257
8258sub complete_vmid {
8259 return &$complete_vmid_full();
8260}
8261
8262sub complete_vmid_stopped {
8263 return &$complete_vmid_full(0);
8264}
8265
8266sub complete_vmid_running {
8267 return &$complete_vmid_full(1);
8268}
8269
335af808
DM
8270sub complete_storage {
8271
8272 my $cfg = PVE::Storage::config();
8273 my $ids = $cfg->{ids};
8274
8275 my $res = [];
8276 foreach my $sid (keys %$ids) {
8277 next if !PVE::Storage::storage_check_enabled($cfg, $sid, undef, 1);
c4c844ef 8278 next if !$ids->{$sid}->{content}->{images};
335af808
DM
8279 push @$res, $sid;
8280 }
8281
8282 return $res;
8283}
8284
255e9c54
AL
8285sub complete_migration_storage {
8286 my ($cmd, $param, $current_value, $all_args) = @_;
8287
8288 my $targetnode = @$all_args[1];
8289
8290 my $cfg = PVE::Storage::config();
8291 my $ids = $cfg->{ids};
8292
8293 my $res = [];
8294 foreach my $sid (keys %$ids) {
8295 next if !PVE::Storage::storage_check_enabled($cfg, $sid, $targetnode, 1);
8296 next if !$ids->{$sid}->{content}->{images};
8297 push @$res, $sid;
8298 }
8299
8300 return $res;
8301}
8302
b08c37c3
DC
8303sub vm_is_paused {
8304 my ($vmid) = @_;
8305 my $qmpstatus = eval {
8306 PVE::QemuConfig::assert_config_exists_on_node($vmid);
8307 mon_cmd($vmid, "query-status");
8308 };
8309 warn "$@\n" if $@;
8310 return $qmpstatus && $qmpstatus->{status} eq "paused";
8311}
8312
3f11f0d7
LS
8313sub check_volume_storage_type {
8314 my ($storecfg, $vol) = @_;
8315
8316 my ($storeid, $volname) = PVE::Storage::parse_volume_id($vol);
8317 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
8318 my ($vtype) = PVE::Storage::parse_volname($storecfg, $vol);
8319
8320 die "storage '$storeid' does not support content-type '$vtype'\n"
8321 if !$scfg->{content}->{$vtype};
8322
8323 return 1;
8324}
8325
21947fea
AD
8326sub add_nets_bridge_fdb {
8327 my ($conf, $vmid) = @_;
8328
1b5ba4dd
TL
8329 for my $opt (keys %$conf) {
8330 next if $opt !~ m/^net(\d+)$/;
8331 my $iface = "tap${vmid}i$1";
4ddd2ca2
TL
8332 # NOTE: expect setups with learning off to *not* use auto-random-generation of MAC on start
8333 my $net = parse_net($conf->{$opt}, 1) or next;
8334
8335 my $mac = $net->{macaddr};
8336 if (!$mac) {
8337 log_warn("MAC learning disabled, but vNIC '$iface' has no static MAC to add to forwarding DB!")
8338 if !file_read_firstline("/sys/class/net/$iface/brport/learning");
8339 next;
8340 }
21947fea 8341
1b5ba4dd
TL
8342 if ($have_sdn) {
8343 PVE::Network::SDN::Zones::add_bridge_fdb($iface, $mac, $net->{bridge}, $net->{firewall});
8344 } else {
8345 PVE::Network::add_bridge_fdb($iface, $mac, $net->{firewall});
21947fea
AD
8346 }
8347 }
8348}
1b5ba4dd 8349
73ed6496
AD
8350sub del_nets_bridge_fdb {
8351 my ($conf, $vmid) = @_;
8352
8353 for my $opt (keys %$conf) {
8354 next if $opt !~ m/^net(\d+)$/;
8355 my $iface = "tap${vmid}i$1";
8356
8357 my $net = parse_net($conf->{$opt}) or next;
8358 my $mac = $net->{macaddr} or next;
8359
8360 if ($have_sdn) {
8361 PVE::Network::SDN::Zones::del_bridge_fdb($iface, $mac, $net->{bridge}, $net->{firewall});
8362 } else {
8363 PVE::Network::del_bridge_fdb($iface, $mac, $net->{firewall});
8364 }
8365 }
8366}
8367
1e3baf05 83681;