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