]> git.proxmox.com Git - qemu-server.git/blame - PVE/QemuServer.pm
migration: nbd export: switch away from deprecated QMP command
[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',
8d88a594
TL
345 description => "Amount of RAM for the VM in MB. This is the maximum available memory when"
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',
353 description => "Amount of target RAM for the VM in MB. 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
a5269260 414l26;; Linux 2.6 - 5.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,
4df98f2f
TL
734 description => 'Specify a custom file containing all network data passed to the VM via'
735 .' cloud-init.',
cb702ebe
DL
736 format => 'pve-volume-id',
737 format_description => 'volume',
738 },
739 user => {
740 type => 'string',
741 optional => 1,
4df98f2f
TL
742 description => 'Specify a custom file containing all user data passed to the VM via'
743 .' cloud-init.',
cb702ebe
DL
744 format => 'pve-volume-id',
745 format_description => 'volume',
746 },
101beafe
CH
747 vendor => {
748 type => 'string',
749 optional => 1,
750 description => 'Specify a custom file containing all vendor data passed to the VM via'
751 .' cloud-init.',
752 format => 'pve-volume-id',
753 format_description => 'volume',
754 },
cb702ebe
DL
755};
756PVE::JSONSchema::register_format('pve-qm-cicustom', $cicustom_fmt);
757
9ed7a77c 758my $confdesc_cloudinit = {
41cd94a0
WB
759 citype => {
760 optional => 1,
761 type => 'string',
4df98f2f
TL
762 description => 'Specifies the cloud-init configuration format. The default depends on the'
763 .' configured operating system type (`ostype`. We use the `nocloud` format for Linux,'
764 .' and `configdrive2` for windows.',
545eec65 765 enum => ['configdrive2', 'nocloud', 'opennebula'],
41cd94a0 766 },
7b42f951
WB
767 ciuser => {
768 optional => 1,
769 type => 'string',
4df98f2f
TL
770 description => "cloud-init: User name to change ssh keys and password for instead of the"
771 ." image's configured default user.",
7b42f951
WB
772 },
773 cipassword => {
774 optional => 1,
775 type => 'string',
4df98f2f
TL
776 description => 'cloud-init: Password to assign the user. Using this is generally not'
777 .' recommended. Use ssh keys instead. Also note that older cloud-init versions do not'
778 .' support hashed passwords.',
7b42f951 779 },
cb702ebe
DL
780 cicustom => {
781 optional => 1,
782 type => 'string',
4df98f2f
TL
783 description => 'cloud-init: Specify custom files to replace the automatically generated'
784 .' ones at start.',
cb702ebe
DL
785 format => 'pve-qm-cicustom',
786 },
0c9a7596
AD
787 searchdomain => {
788 optional => 1,
789 type => 'string',
bd49ecb4 790 description => 'cloud-init: Sets DNS search domains for a container. Create will'
4df98f2f 791 .' automatically use the setting from the host if neither searchdomain nor nameserver'
bd49ecb4 792 .' are set.',
0c9a7596
AD
793 },
794 nameserver => {
795 optional => 1,
796 type => 'string', format => 'address-list',
bd49ecb4 797 description => 'cloud-init: Sets DNS server IP address for a container. Create will'
4df98f2f 798 .' automatically use the setting from the host if neither searchdomain nor nameserver'
bd49ecb4 799 .' are set.',
0c9a7596
AD
800 },
801 sshkeys => {
802 optional => 1,
803 type => 'string',
804 format => 'urlencoded',
1d1c4e1c 805 description => "cloud-init: Setup public SSH keys (one key per line, OpenSSH format).",
0c9a7596 806 },
1e3baf05
DM
807};
808
809# what about other qemu settings ?
810#cpu => 'string',
811#machine => 'string',
812#fda => 'file',
813#fdb => 'file',
814#mtdblock => 'file',
815#sd => 'file',
816#pflash => 'file',
817#snapshot => 'bool',
818#bootp => 'file',
819##tftp => 'dir',
820##smb => 'dir',
821#kernel => 'file',
822#append => 'string',
823#initrd => 'file',
824##soundhw => 'string',
825
826while (my ($k, $v) = each %$confdesc) {
827 PVE::JSONSchema::register_standard_option("pve-qm-$k", $v);
828}
829
0c3d18ef 830my $MAX_USB_DEVICES = 14;
5bdcf937 831my $MAX_NETS = 32;
bae179aa 832my $MAX_SERIAL_PORTS = 4;
1989a89c 833my $MAX_PARALLEL_PORTS = 3;
2ed5d572
AD
834my $MAX_NUMA = 8;
835
ffc0d8c7
WB
836my $numa_fmt = {
837 cpus => {
838 type => "string",
839 pattern => qr/\d+(?:-\d+)?(?:;\d+(?:-\d+)?)*/,
52261945 840 description => "CPUs accessing this NUMA node.",
ffc0d8c7
WB
841 format_description => "id[-id];...",
842 },
843 memory => {
844 type => "number",
52261945 845 description => "Amount of memory this NUMA node provides.",
ffc0d8c7
WB
846 optional => 1,
847 },
848 hostnodes => {
849 type => "string",
850 pattern => qr/\d+(?:-\d+)?(?:;\d+(?:-\d+)?)*/,
52261945 851 description => "Host NUMA nodes to use.",
ffc0d8c7
WB
852 format_description => "id[-id];...",
853 optional => 1,
854 },
855 policy => {
856 type => 'string',
857 enum => [qw(preferred bind interleave)],
52261945 858 description => "NUMA allocation policy.",
ffc0d8c7
WB
859 optional => 1,
860 },
861};
862PVE::JSONSchema::register_format('pve-qm-numanode', $numa_fmt);
2ed5d572
AD
863my $numadesc = {
864 optional => 1,
ffc0d8c7 865 type => 'string', format => $numa_fmt,
52261945 866 description => "NUMA topology.",
2ed5d572
AD
867};
868PVE::JSONSchema::register_standard_option("pve-qm-numanode", $numadesc);
869
870for (my $i = 0; $i < $MAX_NUMA; $i++) {
871 $confdesc->{"numa$i"} = $numadesc;
872}
1e3baf05 873
f7bc17ca
TL
874my $nic_model_list = [
875 'e1000',
876 'e1000-82540em',
877 'e1000-82544gc',
878 'e1000-82545em',
e83dd50a 879 'e1000e',
f7bc17ca
TL
880 'i82551',
881 'i82557b',
882 'i82559er',
883 'ne2k_isa',
884 'ne2k_pci',
885 'pcnet',
886 'rtl8139',
887 'virtio',
888 'vmxnet3',
889];
6b64503e 890my $nic_model_list_txt = join(' ', sort @$nic_model_list);
1e3baf05 891
52261945
DM
892my $net_fmt_bridge_descr = <<__EOD__;
893Bridge to attach the network device to. The Proxmox VE standard bridge
894is called 'vmbr0'.
895
896If you do not specify a bridge, we create a kvm user (NATed) network
897device, which provides DHCP and DNS services. The following addresses
898are used:
899
900 10.0.2.2 Gateway
901 10.0.2.3 DNS Server
902 10.0.2.4 SMB Server
903
904The DHCP server assign addresses to the guest starting from 10.0.2.15.
905__EOD__
906
cd9c34d1 907my $net_fmt = {
399d96db 908 macaddr => get_standard_option('mac-addr', {
4df98f2f
TL
909 description => "MAC address. That address must be unique withing your network. This is"
910 ." automatically generated if not specified.",
399d96db 911 }),
7f694a71
DM
912 model => {
913 type => 'string',
4df98f2f
TL
914 description => "Network Card Model. The 'virtio' model provides the best performance with"
915 ." very low CPU overhead. If your guest does not support this driver, it is usually"
916 ." best to use 'e1000'.",
7f694a71
DM
917 enum => $nic_model_list,
918 default_key => 1,
919 },
920 (map { $_ => { keyAlias => 'model', alias => 'macaddr' }} @$nic_model_list),
dbdcc5cd 921 bridge => get_standard_option('pve-bridge-id', {
52261945 922 description => $net_fmt_bridge_descr,
cd9c34d1 923 optional => 1,
dbdcc5cd 924 }),
cd9c34d1
WB
925 queues => {
926 type => 'integer',
66222265 927 minimum => 0, maximum => 64,
cd9c34d1 928 description => 'Number of packet queues to be used on the device.',
cd9c34d1
WB
929 optional => 1,
930 },
931 rate => {
932 type => 'number',
933 minimum => 0,
52261945 934 description => "Rate limit in mbps (megabytes per second) as floating point number.",
cd9c34d1
WB
935 optional => 1,
936 },
937 tag => {
938 type => 'integer',
9f41a659 939 minimum => 1, maximum => 4094,
cd9c34d1 940 description => 'VLAN tag to apply to packets on this interface.',
cd9c34d1
WB
941 optional => 1,
942 },
943 trunks => {
944 type => 'string',
945 pattern => qr/\d+(?:-\d+)?(?:;\d+(?:-\d+)?)*/,
946 description => 'VLAN trunks to pass through this interface.',
7f694a71 947 format_description => 'vlanid[;vlanid...]',
cd9c34d1
WB
948 optional => 1,
949 },
950 firewall => {
951 type => 'boolean',
952 description => 'Whether this interface should be protected by the firewall.',
cd9c34d1
WB
953 optional => 1,
954 },
955 link_down => {
956 type => 'boolean',
52261945 957 description => 'Whether this interface should be disconnected (like pulling the plug).',
cd9c34d1
WB
958 optional => 1,
959 },
61a14cde
AD
960 mtu => {
961 type => 'integer',
962 minimum => 1, maximum => 65520,
0530177b 963 description => "Force MTU, for VirtIO only. Set to '1' to use the bridge MTU",
61a14cde
AD
964 optional => 1,
965 },
cd9c34d1 966};
52261945 967
1e3baf05
DM
968my $netdesc = {
969 optional => 1,
7f694a71 970 type => 'string', format => $net_fmt,
52261945 971 description => "Specify network devices.",
1e3baf05 972};
52261945 973
1e3baf05
DM
974PVE::JSONSchema::register_standard_option("pve-qm-net", $netdesc);
975
0c9a7596
AD
976my $ipconfig_fmt = {
977 ip => {
978 type => 'string',
979 format => 'pve-ipv4-config',
980 format_description => 'IPv4Format/CIDR',
981 description => 'IPv4 address in CIDR format.',
982 optional => 1,
983 default => 'dhcp',
984 },
985 gw => {
986 type => 'string',
987 format => 'ipv4',
988 format_description => 'GatewayIPv4',
989 description => 'Default gateway for IPv4 traffic.',
990 optional => 1,
991 requires => 'ip',
992 },
993 ip6 => {
994 type => 'string',
995 format => 'pve-ipv6-config',
996 format_description => 'IPv6Format/CIDR',
997 description => 'IPv6 address in CIDR format.',
998 optional => 1,
999 default => 'dhcp',
1000 },
1001 gw6 => {
1002 type => 'string',
1003 format => 'ipv6',
1004 format_description => 'GatewayIPv6',
1005 description => 'Default gateway for IPv6 traffic.',
1006 optional => 1,
1007 requires => 'ip6',
1008 },
1009};
1010PVE::JSONSchema::register_format('pve-qm-ipconfig', $ipconfig_fmt);
1011my $ipconfigdesc = {
1012 optional => 1,
1013 type => 'string', format => 'pve-qm-ipconfig',
1014 description => <<'EODESCR',
1015cloud-init: Specify IP addresses and gateways for the corresponding interface.
1016
1017IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
1018
4df98f2f
TL
1019The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
1020gateway should be provided.
988be8d0
ML
1021For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires
1022cloud-init 19.4 or newer.
0c9a7596 1023
4df98f2f
TL
1024If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
1025dhcp on IPv4.
0c9a7596
AD
1026EODESCR
1027};
1028PVE::JSONSchema::register_standard_option("pve-qm-ipconfig", $netdesc);
1029
1e3baf05
DM
1030for (my $i = 0; $i < $MAX_NETS; $i++) {
1031 $confdesc->{"net$i"} = $netdesc;
9ed7a77c
WB
1032 $confdesc_cloudinit->{"ipconfig$i"} = $ipconfigdesc;
1033}
1034
1035foreach my $key (keys %$confdesc_cloudinit) {
1036 $confdesc->{$key} = $confdesc_cloudinit->{$key};
1e3baf05
DM
1037}
1038
83870398
DB
1039PVE::JSONSchema::register_format('pve-cpuset', \&pve_verify_cpuset);
1040sub pve_verify_cpuset {
1041 my ($set_text, $noerr) = @_;
1042
1043 my ($count, $members) = eval { PVE::CpuSet::parse_cpuset($set_text) };
1044
1045 if ($@) {
1046 return if $noerr;
1047 die "unable to parse cpuset option\n";
1048 }
1049
1050 return PVE::CpuSet->new($members)->short_string();
1051}
1052
ffa42b86
DC
1053PVE::JSONSchema::register_format('pve-volume-id-or-qm-path', \&verify_volume_id_or_qm_path);
1054sub verify_volume_id_or_qm_path {
822c8a07
WB
1055 my ($volid, $noerr) = @_;
1056
6e55f579
FE
1057 return $volid if $volid eq 'none' || $volid eq 'cdrom';
1058
1059 return verify_volume_id_or_absolute_path($volid, $noerr);
1060}
1061
1062PVE::JSONSchema::register_format('pve-volume-id-or-absolute-path', \&verify_volume_id_or_absolute_path);
1063sub verify_volume_id_or_absolute_path {
1064 my ($volid, $noerr) = @_;
1065
1066 return $volid if $volid =~ m|^/|;
ffa42b86 1067
822c8a07
WB
1068 $volid = eval { PVE::JSONSchema::check_format('pve-volume-id', $volid, '') };
1069 if ($@) {
d1c1af4b 1070 return if $noerr;
822c8a07
WB
1071 die $@;
1072 }
1073 return $volid;
1074}
1075
ff6ffe20 1076my $usb_fmt = {
a6b9aee4
DC
1077 host => {
1078 default_key => 1,
1079 type => 'string', format => 'pve-qm-usb-device',
1080 format_description => 'HOSTUSBDEVICE|spice',
52261945
DM
1081 description => <<EODESCR,
1082The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
1083
1084 'bus-port(.port)*' (decimal numbers) or
1085 'vendor_id:product_id' (hexadeciaml numbers) or
1086 'spice'
1087
1088You can use the 'lsusb -t' command to list existing usb devices.
1089
4df98f2f
TL
1090NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such
1091machines - use with special care.
52261945
DM
1092
1093The value 'spice' can be used to add a usb redirection devices for spice.
1094EODESCR
a6b9aee4
DC
1095 },
1096 usb3 => {
1097 optional => 1,
1098 type => 'boolean',
4862922a
DC
1099 description => "Specifies whether if given host option is a USB3 device or port."
1100 ." For modern guests (machine version >= 7.1 and ostype l26 and windows > 7), this flag"
1101 ." is irrelevant (all devices are plugged into a xhci controller).",
52261945 1102 default => 0,
a6b9aee4
DC
1103 },
1104};
1105
1e3baf05
DM
1106my $usbdesc = {
1107 optional => 1,
ff6ffe20 1108 type => 'string', format => $usb_fmt,
0c3d18ef
DC
1109 description => "Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype"
1110 ." l26 or windows > 7, n can be up to 14).",
1e3baf05
DM
1111};
1112PVE::JSONSchema::register_standard_option("pve-qm-usb", $usbdesc);
1113
bae179aa
DA
1114my $serialdesc = {
1115 optional => 1,
ca0cef26 1116 type => 'string',
1b0b51ed 1117 pattern => '(/dev/.+|socket)',
52261945
DM
1118 description => "Create a serial device inside the VM (n is 0 to 3)",
1119 verbose_description => <<EODESCR,
52261945
DM
1120Create a serial device inside the VM (n is 0 to 3), and pass through a
1121host serial device (i.e. /dev/ttyS0), or create a unix socket on the
1122host side (use 'qm terminal' to open a terminal connection).
bae179aa 1123
4df98f2f
TL
1124NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines -
1125use with special care.
bae179aa 1126
52261945 1127CAUTION: Experimental! User reported problems with this option.
bae179aa
DA
1128EODESCR
1129};
bae179aa 1130
1989a89c
DA
1131my $paralleldesc= {
1132 optional => 1,
ca0cef26 1133 type => 'string',
9ecc8431 1134 pattern => '/dev/parport\d+|/dev/usb/lp\d+',
52261945
DM
1135 description => "Map host parallel devices (n is 0 to 2).",
1136 verbose_description => <<EODESCR,
19672434 1137Map host parallel devices (n is 0 to 2).
1989a89c 1138
4df98f2f
TL
1139NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such
1140machines - use with special care.
1989a89c 1141
52261945 1142CAUTION: Experimental! User reported problems with this option.
1989a89c
DA
1143EODESCR
1144};
1989a89c
DA
1145
1146for (my $i = 0; $i < $MAX_PARALLEL_PORTS; $i++) {
1147 $confdesc->{"parallel$i"} = $paralleldesc;
1148}
1149
bae179aa
DA
1150for (my $i = 0; $i < $MAX_SERIAL_PORTS; $i++) {
1151 $confdesc->{"serial$i"} = $serialdesc;
1152}
1153
74c17b7a
SR
1154for (my $i = 0; $i < $PVE::QemuServer::PCI::MAX_HOSTPCI_DEVICES; $i++) {
1155 $confdesc->{"hostpci$i"} = $PVE::QemuServer::PCI::hostpcidesc;
040b06b7 1156}
1e3baf05 1157
e0fd2b2f
FE
1158for my $key (keys %{$PVE::QemuServer::Drive::drivedesc_hash}) {
1159 $confdesc->{$key} = $PVE::QemuServer::Drive::drivedesc_hash->{$key};
cdb0931f
DA
1160}
1161
1e3baf05
DM
1162for (my $i = 0; $i < $MAX_USB_DEVICES; $i++) {
1163 $confdesc->{"usb$i"} = $usbdesc;
1164}
1165
5cfa9f5f
SR
1166my $boot_fmt = {
1167 legacy => {
1168 optional => 1,
1169 default_key => 1,
1170 type => 'string',
1171 description => "Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n)."
1172 . " Deprecated, use 'order=' instead.",
1173 pattern => '[acdn]{1,4}',
1174 format_description => "[acdn]{1,4}",
1175
1176 # note: this is also the fallback if boot: is not given at all
1177 default => 'cdn',
1178 },
1179 order => {
1180 optional => 1,
1181 type => 'string',
1182 format => 'pve-qm-bootdev-list',
1183 format_description => "device[;device...]",
1184 description => <<EODESC,
1185The guest will attempt to boot from devices in the order they appear here.
1186
1187Disks, optical drives and passed-through storage USB devices will be directly
1188booted from, NICs will load PXE, and PCIe devices will either behave like disks
1189(e.g. NVMe) or load an option ROM (e.g. RAID controller, hardware NIC).
1190
1191Note that only devices in this list will be marked as bootable and thus loaded
1192by the guest firmware (BIOS/UEFI). If you require multiple disks for booting
1193(e.g. software-raid), you need to specify all of them here.
1194
1195Overrides the deprecated 'legacy=[acdn]*' value when given.
1196EODESC
1197 },
1198};
1199PVE::JSONSchema::register_format('pve-qm-boot', $boot_fmt);
1200
1201PVE::JSONSchema::register_format('pve-qm-bootdev', \&verify_bootdev);
1202sub verify_bootdev {
1203 my ($dev, $noerr) = @_;
1204
f9dde219
SR
1205 my $special = $dev =~ m/^efidisk/ || $dev =~ m/^tpmstate/;
1206 return $dev if PVE::QemuServer::Drive::is_valid_drivename($dev) && !$special;
5cfa9f5f
SR
1207
1208 my $check = sub {
1209 my ($base) = @_;
1210 return 0 if $dev !~ m/^$base\d+$/;
1211 return 0 if !$confdesc->{$dev};
1212 return 1;
1213 };
1214
1215 return $dev if $check->("net");
1216 return $dev if $check->("usb");
1217 return $dev if $check->("hostpci");
1218
d1c1af4b 1219 return if $noerr;
5cfa9f5f
SR
1220 die "invalid boot device '$dev'\n";
1221}
1222
1223sub print_bootorder {
1224 my ($devs) = @_;
4c27b18c 1225 return "" if !@$devs;
5cfa9f5f
SR
1226 my $data = { order => join(';', @$devs) };
1227 return PVE::JSONSchema::print_property_string($data, $boot_fmt);
1228}
1229
1e3baf05
DM
1230my $kvm_api_version = 0;
1231
1232sub kvm_version {
1e3baf05
DM
1233 return $kvm_api_version if $kvm_api_version;
1234
808a65b5 1235 open my $fh, '<', '/dev/kvm' or return;
1e3baf05 1236
646f2df4
WB
1237 # 0xae00 => KVM_GET_API_VERSION
1238 $kvm_api_version = ioctl($fh, 0xae00, 0);
808a65b5 1239 close($fh);
1e3baf05 1240
646f2df4 1241 return $kvm_api_version;
1e3baf05
DM
1242}
1243
1476b99f
DC
1244my $kvm_user_version = {};
1245my $kvm_mtime = {};
1e3baf05
DM
1246
1247sub kvm_user_version {
1476b99f 1248 my ($binary) = @_;
1e3baf05 1249
1476b99f
DC
1250 $binary //= get_command_for_arch(get_host_arch()); # get the native arch by default
1251 my $st = stat($binary);
1e3baf05 1252
1476b99f
DC
1253 my $cachedmtime = $kvm_mtime->{$binary} // -1;
1254 return $kvm_user_version->{$binary} if $kvm_user_version->{$binary} &&
1255 $cachedmtime == $st->mtime;
1256
1257 $kvm_user_version->{$binary} = 'unknown';
1258 $kvm_mtime->{$binary} = $st->mtime;
1e3baf05 1259
09b11429
TL
1260 my $code = sub {
1261 my $line = shift;
1262 if ($line =~ m/^QEMU( PC)? emulator version (\d+\.\d+(\.\d+)?)(\.\d+)?[,\s]/) {
1476b99f 1263 $kvm_user_version->{$binary} = $2;
09b11429
TL
1264 }
1265 };
19672434 1266
1476b99f 1267 eval { run_command([$binary, '--version'], outfunc => $code); };
09b11429 1268 warn $@ if $@;
1e3baf05 1269
1476b99f 1270 return $kvm_user_version->{$binary};
1e3baf05
DM
1271
1272}
4df98f2f
TL
1273my sub extract_version {
1274 my ($machine_type, $version) = @_;
1275 $version = kvm_user_version() if !defined($version);
8eb73377 1276 return PVE::QemuServer::Machine::extract_version($machine_type, $version)
4df98f2f 1277}
1e3baf05 1278
db70021b
TL
1279sub kernel_has_vhost_net {
1280 return -c '/dev/vhost-net';
1281}
1e3baf05 1282
1e3baf05
DM
1283sub option_exists {
1284 my $key = shift;
1285 return defined($confdesc->{$key});
19672434 1286}
1e3baf05 1287
1e3baf05 1288my $cdrom_path;
1e3baf05
DM
1289sub get_cdrom_path {
1290
259470ee 1291 return $cdrom_path if defined($cdrom_path);
1e3baf05 1292
c3d15108
TL
1293 $cdrom_path = first { -l $_ } map { "/dev/cdrom$_" } ('', '1', '2');
1294
1295 if (!defined($cdrom_path)) {
490b7308
SS
1296 log_warn("no physical CD-ROM available, ignoring");
1297 $cdrom_path = '';
1298 }
259470ee
SS
1299
1300 return $cdrom_path;
1e3baf05
DM
1301}
1302
1303sub get_iso_path {
1304 my ($storecfg, $vmid, $cdrom) = @_;
1305
1306 if ($cdrom eq 'cdrom') {
1307 return get_cdrom_path();
1308 } elsif ($cdrom eq 'none') {
1309 return '';
1310 } elsif ($cdrom =~ m|^/|) {
1311 return $cdrom;
1312 } else {
6b64503e 1313 return PVE::Storage::path($storecfg, $cdrom);
1e3baf05
DM
1314 }
1315}
1316
1317# try to convert old style file names to volume IDs
1318sub filename_to_volume_id {
1319 my ($vmid, $file, $media) = @_;
1320
0c9a7596 1321 if (!($file eq 'none' || $file eq 'cdrom' ||
1e3baf05 1322 $file =~ m|^/dev/.+| || $file =~ m/^([^:]+):(.+)$/)) {
19672434 1323
d1c1af4b 1324 return if $file =~ m|/|;
19672434 1325
1e3baf05
DM
1326 if ($media && $media eq 'cdrom') {
1327 $file = "local:iso/$file";
1328 } else {
1329 $file = "local:$vmid/$file";
1330 }
1331 }
1332
1333 return $file;
1334}
1335
1336sub verify_media_type {
1337 my ($opt, $vtype, $media) = @_;
1338
1339 return if !$media;
1340
1341 my $etype;
1342 if ($media eq 'disk') {
a125592c 1343 $etype = 'images';
1e3baf05
DM
1344 } elsif ($media eq 'cdrom') {
1345 $etype = 'iso';
1346 } else {
1347 die "internal error";
1348 }
1349
1350 return if ($vtype eq $etype);
19672434 1351
1e3baf05
DM
1352 raise_param_exc({ $opt => "unexpected media type ($vtype != $etype)" });
1353}
1354
1355sub cleanup_drive_path {
1356 my ($opt, $storecfg, $drive) = @_;
1357
1358 # try to convert filesystem paths to volume IDs
1359
1360 if (($drive->{file} !~ m/^(cdrom|none)$/) &&
1361 ($drive->{file} !~ m|^/dev/.+|) &&
1362 ($drive->{file} !~ m/^([^:]+):(.+)$/) &&
19672434 1363 ($drive->{file} !~ m/^\d+$/)) {
1e3baf05 1364 my ($vtype, $volid) = PVE::Storage::path_to_volume_id($storecfg, $drive->{file});
4df98f2f
TL
1365 raise_param_exc({ $opt => "unable to associate path '$drive->{file}' to any storage"})
1366 if !$vtype;
1e3baf05
DM
1367 $drive->{media} = 'cdrom' if !$drive->{media} && $vtype eq 'iso';
1368 verify_media_type($opt, $vtype, $drive->{media});
1369 $drive->{file} = $volid;
1370 }
1371
1372 $drive->{media} = 'cdrom' if !$drive->{media} && $drive->{file} =~ m/^(cdrom|none)$/;
1373}
1374
b3c2bdd1
DM
1375sub parse_hotplug_features {
1376 my ($data) = @_;
1377
1378 my $res = {};
1379
1380 return $res if $data eq '0';
a1b7d579 1381
b3c2bdd1
DM
1382 $data = $confdesc->{hotplug}->{default} if $data eq '1';
1383
45827685 1384 foreach my $feature (PVE::Tools::split_list($data)) {
94ec5e7c 1385 if ($feature =~ m/^(network|disk|cpu|memory|usb|cloudinit)$/) {
b3c2bdd1
DM
1386 $res->{$1} = 1;
1387 } else {
596a0a20 1388 die "invalid hotplug feature '$feature'\n";
b3c2bdd1
DM
1389 }
1390 }
1391 return $res;
1392}
1393
1394PVE::JSONSchema::register_format('pve-hotplug-features', \&pve_verify_hotplug_features);
1395sub pve_verify_hotplug_features {
1396 my ($value, $noerr) = @_;
1397
1398 return $value if parse_hotplug_features($value);
1399
d1c1af4b 1400 return if $noerr;
b3c2bdd1
DM
1401
1402 die "unable to parse hotplug option\n";
1403}
1404
28ef82d3
DM
1405sub scsi_inquiry {
1406 my($fh, $noerr) = @_;
1407
1408 my $SG_IO = 0x2285;
1409 my $SG_GET_VERSION_NUM = 0x2282;
1410
1411 my $versionbuf = "\x00" x 8;
1412 my $ret = ioctl($fh, $SG_GET_VERSION_NUM, $versionbuf);
1413 if (!$ret) {
1414 die "scsi ioctl SG_GET_VERSION_NUM failoed - $!\n" if !$noerr;
d1c1af4b 1415 return;
28ef82d3 1416 }
97d62eb7 1417 my $version = unpack("I", $versionbuf);
28ef82d3
DM
1418 if ($version < 30000) {
1419 die "scsi generic interface too old\n" if !$noerr;
d1c1af4b 1420 return;
28ef82d3 1421 }
97d62eb7 1422
28ef82d3
DM
1423 my $buf = "\x00" x 36;
1424 my $sensebuf = "\x00" x 8;
f334aa3e 1425 my $cmd = pack("C x3 C x1", 0x12, 36);
97d62eb7 1426
28ef82d3
DM
1427 # see /usr/include/scsi/sg.h
1428 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";
1429
f606d5bd
TL
1430 my $packet = pack(
1431 $sg_io_hdr_t, ord('S'), -3, length($cmd), length($sensebuf), 0, length($buf), $buf, $cmd, $sensebuf, 6000
1432 );
28ef82d3
DM
1433
1434 $ret = ioctl($fh, $SG_IO, $packet);
1435 if (!$ret) {
1436 die "scsi ioctl SG_IO failed - $!\n" if !$noerr;
d1c1af4b 1437 return;
28ef82d3 1438 }
97d62eb7 1439
28ef82d3
DM
1440 my @res = unpack($sg_io_hdr_t, $packet);
1441 if ($res[17] || $res[18]) {
1442 die "scsi ioctl SG_IO status error - $!\n" if !$noerr;
d1c1af4b 1443 return;
28ef82d3
DM
1444 }
1445
1446 my $res = {};
f606d5bd 1447 $res->@{qw(type removable vendor product revision)} = unpack("C C x6 A8 A16 A4", $buf);
28ef82d3 1448
f606d5bd
TL
1449 $res->{removable} = $res->{removable} & 128 ? 1 : 0;
1450 $res->{type} &= 0x1F;
09984754 1451
28ef82d3
DM
1452 return $res;
1453}
1454
1455sub path_is_scsi {
1456 my ($path) = @_;
1457
d1c1af4b 1458 my $fh = IO::File->new("+<$path") || return;
28ef82d3
DM
1459 my $res = scsi_inquiry($fh, 1);
1460 close($fh);
1461
1462 return $res;
1463}
1464
db656e5f 1465sub print_tabletdevice_full {
d559309f 1466 my ($conf, $arch) = @_;
b467f79a 1467
3392d6ca 1468 my $q35 = PVE::QemuServer::Machine::machine_type_is_q35($conf);
db656e5f
DM
1469
1470 # we use uhci for old VMs because tablet driver was buggy in older qemu
d559309f 1471 my $usbbus;
2b938c7d 1472 if ($q35 || $arch eq 'aarch64') {
d559309f
WB
1473 $usbbus = 'ehci';
1474 } else {
1475 $usbbus = 'uhci';
1476 }
b467f79a 1477
db656e5f
DM
1478 return "usb-tablet,id=tablet,bus=$usbbus.0,port=1";
1479}
1480
d559309f 1481sub print_keyboarddevice_full {
6971c38e 1482 my ($conf, $arch) = @_;
d559309f 1483
d1c1af4b 1484 return if $arch ne 'aarch64';
d559309f
WB
1485
1486 return "usb-kbd,id=keyboard,bus=ehci.0,port=2";
1487}
1488
a183df68
TL
1489my sub get_drive_id {
1490 my ($drive) = @_;
1491 return "$drive->{interface}$drive->{index}";
1492}
1493
ca916ecc 1494sub print_drivedevice_full {
d559309f 1495 my ($storecfg, $conf, $vmid, $drive, $bridges, $arch, $machine_type) = @_;
ca916ecc
DA
1496
1497 my $device = '';
1498 my $maxdev = 0;
19672434 1499
a183df68 1500 my $drive_id = get_drive_id($drive);
ca916ecc 1501 if ($drive->{interface} eq 'virtio') {
4df98f2f
TL
1502 my $pciaddr = print_pci_addr("$drive_id", $bridges, $arch, $machine_type);
1503 $device = "virtio-blk-pci,drive=drive-$drive_id,id=${drive_id}${pciaddr}";
1504 $device .= ",iothread=iothread-$drive_id" if $drive->{iothread};
2ed36a41 1505 } elsif ($drive->{interface} eq 'scsi') {
6731a4cf 1506
ee034f5c 1507 my ($maxdev, $controller, $controller_prefix) = scsihw_infos($conf, $drive);
2ed36a41
DM
1508 my $unit = $drive->{index} % $maxdev;
1509 my $devicetype = 'hd';
69bcf246
WB
1510 my $path = '';
1511 if (drive_is_cdrom($drive)) {
1512 $devicetype = 'cd';
29b19529 1513 } else {
69bcf246
WB
1514 if ($drive->{file} =~ m|^/|) {
1515 $path = $drive->{file};
1516 if (my $info = path_is_scsi($path)) {
8e3c33ab 1517 if ($info->{type} == 0 && $drive->{scsiblock}) {
69bcf246
WB
1518 $devicetype = 'block';
1519 } elsif ($info->{type} == 1) { # tape
1520 $devicetype = 'generic';
1521 }
1522 }
1523 } else {
1524 $path = PVE::Storage::path($storecfg, $drive->{file});
1525 }
1526
a034e3d6 1527 # for compatibility only, we prefer scsi-hd (#2408, #2355, #2380)
4df98f2f 1528 my $version = extract_version($machine_type, kvm_user_version());
a034e3d6 1529 if ($path =~ m/^iscsi\:\/\// &&
2ea5fb7e 1530 !min_version($version, 4, 1)) {
69bcf246
WB
1531 $devicetype = 'generic';
1532 }
1533 }
1534
ef88eaaa 1535 if (!$conf->{scsihw} || $conf->{scsihw} =~ m/^lsi/ || $conf->{scsihw} eq 'pvscsi') {
4df98f2f 1536 $device = "scsi-$devicetype,bus=$controller_prefix$controller.0,scsi-id=$unit";
69bcf246 1537 } else {
4df98f2f
TL
1538 $device = "scsi-$devicetype,bus=$controller_prefix$controller.0,channel=0,scsi-id=0"
1539 .",lun=$drive->{index}";
69bcf246 1540 }
4df98f2f 1541 $device .= ",drive=drive-$drive_id,id=$drive_id";
cdd20088 1542
6c875f9f
NC
1543 if ($drive->{ssd} && ($devicetype eq 'block' || $devicetype eq 'hd')) {
1544 $device .= ",rotation_rate=1";
1545 }
e741c516 1546 $device .= ",wwn=$drive->{wwn}" if $drive->{wwn};
6c875f9f
NC
1547
1548 } elsif ($drive->{interface} eq 'ide' || $drive->{interface} eq 'sata') {
e0fd2b2f 1549 my $maxdev = ($drive->{interface} eq 'sata') ? $PVE::QemuServer::Drive::MAX_SATA_DISKS : 2;
2ed36a41
DM
1550 my $controller = int($drive->{index} / $maxdev);
1551 my $unit = $drive->{index} % $maxdev;
1552 my $devicetype = ($drive->{media} && $drive->{media} eq 'cdrom') ? "cd" : "hd";
1553
6c875f9f
NC
1554 $device = "ide-$devicetype";
1555 if ($drive->{interface} eq 'ide') {
1556 $device .= ",bus=ide.$controller,unit=$unit";
1557 } else {
1558 $device .= ",bus=ahci$controller.$unit";
1559 }
4df98f2f 1560 $device .= ",drive=drive-$drive_id,id=$drive_id";
6c875f9f
NC
1561
1562 if ($devicetype eq 'hd') {
1563 if (my $model = $drive->{model}) {
1564 $model = URI::Escape::uri_unescape($model);
1565 $device .= ",model=$model";
1566 }
1567 if ($drive->{ssd}) {
1568 $device .= ",rotation_rate=1";
1569 }
0f2812c2 1570 }
e741c516 1571 $device .= ",wwn=$drive->{wwn}" if $drive->{wwn};
2ed36a41
DM
1572 } elsif ($drive->{interface} eq 'usb') {
1573 die "implement me";
1574 # -device ide-drive,bus=ide.1,unit=0,drive=drive-ide0-1-0,id=ide0-1-0
1575 } else {
1576 die "unsupported interface type";
ca916ecc
DA
1577 }
1578
3b408e82
DM
1579 $device .= ",bootindex=$drive->{bootindex}" if $drive->{bootindex};
1580
a70e7e6c
TL
1581 if (my $serial = $drive->{serial}) {
1582 $serial = URI::Escape::uri_unescape($serial);
1583 $device .= ",serial=$serial";
1584 }
1585
1586
ca916ecc
DA
1587 return $device;
1588}
1589
15b21acc 1590sub get_initiator_name {
46f58b5f 1591 my $initiator;
15b21acc 1592
d1c1af4b 1593 my $fh = IO::File->new('/etc/iscsi/initiatorname.iscsi') || return;
46f58b5f
DM
1594 while (defined(my $line = <$fh>)) {
1595 next if $line !~ m/^\s*InitiatorName\s*=\s*([\.\-:\w]+)/;
15b21acc
MR
1596 $initiator = $1;
1597 last;
1598 }
46f58b5f
DM
1599 $fh->close();
1600
15b21acc
MR
1601 return $initiator;
1602}
1603
776c5f50 1604sub print_drive_commandline_full {
6d5673c3 1605 my ($storecfg, $vmid, $drive, $pbs_name, $io_uring) = @_;
1e3baf05 1606
d81f0f09
DM
1607 my $path;
1608 my $volid = $drive->{file};
5921764c 1609 my $format = $drive->{format};
a183df68 1610 my $drive_id = get_drive_id($drive);
370b05e7 1611
0fe779a6
WB
1612 my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
1613 my $scfg = $storeid ? PVE::Storage::storage_config($storecfg, $storeid) : undef;
1614
d81f0f09
DM
1615 if (drive_is_cdrom($drive)) {
1616 $path = get_iso_path($storecfg, $vmid, $volid);
a183df68 1617 die "$drive_id: cannot back cdrom drive with PBS snapshot\n" if $pbs_name;
d81f0f09 1618 } else {
d81f0f09
DM
1619 if ($storeid) {
1620 $path = PVE::Storage::path($storecfg, $volid);
5921764c 1621 $format //= qemu_img_format($scfg, $volname);
d81f0f09
DM
1622 } else {
1623 $path = $volid;
5921764c 1624 $format //= "raw";
d81f0f09
DM
1625 }
1626 }
1627
5921764c
SR
1628 my $is_rbd = $path =~ m/^rbd:/;
1629
1e3baf05 1630 my $opts = '';
5921764c 1631 my @qemu_drive_options = qw(heads secs cyls trans media cache rerror werror aio discard);
1e3baf05 1632 foreach my $o (@qemu_drive_options) {
5fc74861 1633 $opts .= ",$o=$drive->{$o}" if defined($drive->{$o});
19672434 1634 }
8a267708
DC
1635
1636 # snapshot only accepts on|off
1637 if (defined($drive->{snapshot})) {
1638 my $v = $drive->{snapshot} ? 'on' : 'off';
1639 $opts .= ",snapshot=$v";
1640 }
1641
1f91f7b4
TL
1642 if (defined($drive->{ro})) { # ro maps to QEMUs `readonly`, which accepts `on` or `off` only
1643 $opts .= ",readonly=" . ($drive->{ro} ? 'on' : 'off');
12e1d472
DC
1644 }
1645
fb8e95a2
WB
1646 foreach my $type (['', '-total'], [_rd => '-read'], [_wr => '-write']) {
1647 my ($dir, $qmpname) = @$type;
1648 if (my $v = $drive->{"mbps$dir"}) {
1649 $opts .= ",throttling.bps$qmpname=".int($v*1024*1024);
1650 }
1651 if (my $v = $drive->{"mbps${dir}_max"}) {
1652 $opts .= ",throttling.bps$qmpname-max=".int($v*1024*1024);
1653 }
1654 if (my $v = $drive->{"bps${dir}_max_length"}) {
1655 $opts .= ",throttling.bps$qmpname-max-length=$v";
1656 }
1657 if (my $v = $drive->{"iops${dir}"}) {
1658 $opts .= ",throttling.iops$qmpname=$v";
1659 }
1660 if (my $v = $drive->{"iops${dir}_max"}) {
8aca1654 1661 $opts .= ",throttling.iops$qmpname-max=$v";
fb8e95a2
WB
1662 }
1663 if (my $v = $drive->{"iops${dir}_max_length"}) {
8aca1654 1664 $opts .= ",throttling.iops$qmpname-max-length=$v";
fb8e95a2
WB
1665 }
1666 }
1667
5921764c
SR
1668 if ($pbs_name) {
1669 $format = "rbd" if $is_rbd;
a183df68
TL
1670 die "$drive_id: Proxmox Backup Server backed drive cannot auto-detect the format\n"
1671 if !$format;
5921764c
SR
1672 $opts .= ",format=alloc-track,file.driver=$format";
1673 } elsif ($format) {
1674 $opts .= ",format=$format";
1675 }
d81f0f09 1676
b2ee900e
WB
1677 my $cache_direct = 0;
1678
1679 if (my $cache = $drive->{cache}) {
1680 $cache_direct = $cache =~ /^(?:off|none|directsync)$/;
0fe779a6 1681 } elsif (!drive_is_cdrom($drive) && !($scfg && $scfg->{type} eq 'btrfs' && !$scfg->{nocow})) {
b2ee900e
WB
1682 $opts .= ",cache=none";
1683 $cache_direct = 1;
1684 }
1685
628937f5
SR
1686 # io_uring with cache mode writeback or writethrough on krbd will hang...
1687 my $rbd_no_io_uring = $scfg && $scfg->{type} eq 'rbd' && $scfg->{krbd} && !$cache_direct;
1688
78a3ada7
TL
1689 # io_uring with cache mode writeback or writethrough on LVM will hang, without cache only
1690 # sometimes, just plain disable...
1691 my $lvm_no_io_uring = $scfg && $scfg->{type} eq 'lvm';
ec5d198e 1692
e31762f2
FE
1693 # io_uring causes problems when used with CIFS since kernel 5.15
1694 # Some discussion: https://www.spinics.net/lists/linux-cifs/msg26734.html
1695 my $cifs_no_io_uring = $scfg && $scfg->{type} eq 'cifs';
1696
b2ee900e 1697 if (!$drive->{aio}) {
e31762f2 1698 if ($io_uring && !$rbd_no_io_uring && !$lvm_no_io_uring && !$cifs_no_io_uring) {
6d5673c3
SR
1699 # io_uring supports all cache modes
1700 $opts .= ",aio=io_uring";
b2ee900e 1701 } else {
6d5673c3
SR
1702 # aio native works only with O_DIRECT
1703 if($cache_direct) {
1704 $opts .= ",aio=native";
1705 } else {
1706 $opts .= ",aio=threads";
1707 }
b2ee900e
WB
1708 }
1709 }
11490cf2 1710
6e47c3b4
WB
1711 if (!drive_is_cdrom($drive)) {
1712 my $detectzeroes;
7d4e30f3 1713 if (defined($drive->{detect_zeroes}) && !$drive->{detect_zeroes}) {
6e47c3b4
WB
1714 $detectzeroes = 'off';
1715 } elsif ($drive->{discard}) {
1716 $detectzeroes = $drive->{discard} eq 'on' ? 'unmap' : 'on';
1717 } else {
1718 # This used to be our default with discard not being specified:
1719 $detectzeroes = 'on';
1720 }
5921764c
SR
1721
1722 # note: 'detect-zeroes' works per blockdev and we want it to persist
1723 # after the alloc-track is removed, so put it on 'file' directly
1724 my $dz_param = $pbs_name ? "file.detect-zeroes" : "detect-zeroes";
1725 $opts .= ",$dz_param=$detectzeroes" if $detectzeroes;
6e47c3b4 1726 }
f1e05305 1727
5921764c
SR
1728 if ($pbs_name) {
1729 $opts .= ",backing=$pbs_name";
1730 $opts .= ",auto-remove=on";
1731 }
1732
1733 # my $file_param = $pbs_name ? "file.file.filename" : "file";
1734 my $file_param = "file";
1735 if ($pbs_name) {
1736 # non-rbd drivers require the underlying file to be a seperate block
1737 # node, so add a second .file indirection
1738 $file_param .= ".file" if !$is_rbd;
1739 $file_param .= ".filename";
1740 }
1741 my $pathinfo = $path ? "$file_param=$path," : '';
1e3baf05 1742
3ebfcc86 1743 return "${pathinfo}if=none,id=drive-$drive->{interface}$drive->{index}$opts";
1e3baf05
DM
1744}
1745
5921764c
SR
1746sub print_pbs_blockdev {
1747 my ($pbs_conf, $pbs_name) = @_;
1748 my $blockdev = "driver=pbs,node-name=$pbs_name,read-only=on";
1749 $blockdev .= ",repository=$pbs_conf->{repository}";
2dda626d 1750 $blockdev .= ",namespace=$pbs_conf->{namespace}" if $pbs_conf->{namespace};
5921764c
SR
1751 $blockdev .= ",snapshot=$pbs_conf->{snapshot}";
1752 $blockdev .= ",archive=$pbs_conf->{archive}";
1753 $blockdev .= ",keyfile=$pbs_conf->{keyfile}" if $pbs_conf->{keyfile};
1754 return $blockdev;
1755}
1756
cc4d6182 1757sub print_netdevice_full {
0c03a390 1758 my ($vmid, $conf, $net, $netid, $bridges, $use_old_bios_files, $arch, $machine_type, $machine_version) = @_;
cc4d6182 1759
cc4d6182
DA
1760 my $device = $net->{model};
1761 if ($net->{model} eq 'virtio') {
1762 $device = 'virtio-net-pci';
1763 };
1764
d559309f 1765 my $pciaddr = print_pci_addr("$netid", $bridges, $arch, $machine_type);
5e2068d2 1766 my $tmpstr = "$device,mac=$net->{macaddr},netdev=$netid$pciaddr,id=$netid";
a9410357 1767 if ($net->{queues} && $net->{queues} > 1 && $net->{model} eq 'virtio'){
4df98f2f
TL
1768 # Consider we have N queues, the number of vectors needed is 2 * N + 2, i.e., one per in
1769 # and out of each queue plus one config interrupt and control vector queue
a9410357
AD
1770 my $vectors = $net->{queues} * 2 + 2;
1771 $tmpstr .= ",vectors=$vectors,mq=on";
0c03a390
AD
1772 if (min_version($machine_version, 7, 1)) {
1773 $tmpstr .= ",packed=on";
1774 }
a9410357 1775 }
620d6b32
AD
1776
1777 if (min_version($machine_version, 7, 1) && $net->{model} eq 'virtio'){
1778 $tmpstr .= ",rx_queue_size=1024,tx_queue_size=1024";
1779 }
1780
cc4d6182 1781 $tmpstr .= ",bootindex=$net->{bootindex}" if $net->{bootindex} ;
ba9e1000 1782
0530177b
TL
1783 if (my $mtu = $net->{mtu}) {
1784 if ($net->{model} eq 'virtio' && $net->{bridge}) {
1785 my $bridge_mtu = PVE::Network::read_bridge_mtu($net->{bridge});
1786 if ($mtu == 1) {
1787 $mtu = $bridge_mtu;
1788 } elsif ($mtu < 576) {
1789 die "netdev $netid: MTU '$mtu' is smaller than the IP minimum MTU '576'\n";
1790 } elsif ($mtu > $bridge_mtu) {
1791 die "netdev $netid: MTU '$mtu' is bigger than the bridge MTU '$bridge_mtu'\n";
1792 }
1793 $tmpstr .= ",host_mtu=$mtu";
1794 } else {
1795 warn "WARN: netdev $netid: ignoring MTU '$mtu', not using VirtIO or no bridge configured.\n";
61a14cde 1796 }
61a14cde
AD
1797 }
1798
ba9e1000
DM
1799 if ($use_old_bios_files) {
1800 my $romfile;
1801 if ($device eq 'virtio-net-pci') {
1802 $romfile = 'pxe-virtio.rom';
1803 } elsif ($device eq 'e1000') {
1804 $romfile = 'pxe-e1000.rom';
e83dd50a
TL
1805 } elsif ($device eq 'e1000e') {
1806 $romfile = 'pxe-e1000e.rom';
ba9e1000
DM
1807 } elsif ($device eq 'ne2k') {
1808 $romfile = 'pxe-ne2k_pci.rom';
1809 } elsif ($device eq 'pcnet') {
1810 $romfile = 'pxe-pcnet.rom';
1811 } elsif ($device eq 'rtl8139') {
1812 $romfile = 'pxe-rtl8139.rom';
1813 }
1814 $tmpstr .= ",romfile=$romfile" if $romfile;
1815 }
1816
cc4d6182
DA
1817 return $tmpstr;
1818}
1819
1820sub print_netdev_full {
d559309f 1821 my ($vmid, $conf, $arch, $net, $netid, $hotplug) = @_;
cc4d6182
DA
1822
1823 my $i = '';
1824 if ($netid =~ m/^net(\d+)$/) {
1825 $i = int($1);
1826 }
1827
1828 die "got strange net id '$i'\n" if $i >= ${MAX_NETS};
1829
1830 my $ifname = "tap${vmid}i$i";
1831
1832 # kvm uses TUNSETIFF ioctl, and that limits ifname length
1833 die "interface name '$ifname' is too long (max 15 character)\n"
1834 if length($ifname) >= 16;
1835
1836 my $vhostparam = '';
6f0cb675 1837 if (is_native($arch)) {
db70021b 1838 $vhostparam = ',vhost=on' if kernel_has_vhost_net() && $net->{model} eq 'virtio';
6f0cb675 1839 }
cc4d6182
DA
1840
1841 my $vmname = $conf->{name} || "vm$vmid";
1842
a9410357 1843 my $netdev = "";
208ba94e 1844 my $script = $hotplug ? "pve-bridge-hotplug" : "pve-bridge";
a9410357 1845
cc4d6182 1846 if ($net->{bridge}) {
4df98f2f
TL
1847 $netdev = "type=tap,id=$netid,ifname=${ifname},script=/var/lib/qemu-server/$script"
1848 .",downscript=/var/lib/qemu-server/pve-bridgedown$vhostparam";
cc4d6182 1849 } else {
a9410357 1850 $netdev = "type=user,id=$netid,hostname=$vmname";
cc4d6182 1851 }
a9410357
AD
1852
1853 $netdev .= ",queues=$net->{queues}" if ($net->{queues} && $net->{model} eq 'virtio');
1854
1855 return $netdev;
cc4d6182 1856}
1e3baf05 1857
55655ebc
DC
1858my $vga_map = {
1859 'cirrus' => 'cirrus-vga',
1860 'std' => 'VGA',
1861 'vmware' => 'vmware-svga',
1862 'virtio' => 'virtio-vga',
6f070e39 1863 'virtio-gl' => 'virtio-vga-gl',
55655ebc
DC
1864};
1865
1866sub print_vga_device {
2ea5fb7e 1867 my ($conf, $vga, $arch, $machine_version, $machine, $id, $qxlnum, $bridges) = @_;
55655ebc
DC
1868
1869 my $type = $vga_map->{$vga->{type}};
86c9fafe 1870 if ($arch eq 'aarch64' && defined($type) && $type eq 'virtio-vga') {
d559309f
WB
1871 $type = 'virtio-gpu';
1872 }
55655ebc 1873 my $vgamem_mb = $vga->{memory};
6021c7a5
AL
1874
1875 my $max_outputs = '';
55655ebc
DC
1876 if ($qxlnum) {
1877 $type = $id ? 'qxl' : 'qxl-vga';
6021c7a5 1878
c5a4c92c 1879 if (!$conf->{ostype} || $conf->{ostype} =~ m/^(?:l\d\d)|(?:other)$/) {
6021c7a5 1880 # set max outputs so linux can have up to 4 qxl displays with one device
2ea5fb7e 1881 if (min_version($machine_version, 4, 1)) {
9e8976ea
TL
1882 $max_outputs = ",max_outputs=4";
1883 }
6021c7a5 1884 }
55655ebc 1885 }
6021c7a5 1886
55655ebc
DC
1887 die "no devicetype for $vga->{type}\n" if !$type;
1888
1889 my $memory = "";
1890 if ($vgamem_mb) {
6f070e39 1891 if ($vga->{type} =~ /^virtio/) {
55655ebc
DC
1892 my $bytes = PVE::Tools::convert_size($vgamem_mb, "mb" => "b");
1893 $memory = ",max_hostmem=$bytes";
1894 } elsif ($qxlnum) {
1895 # from https://www.spice-space.org/multiple-monitors.html
1896 $memory = ",vgamem_mb=$vga->{memory}";
1897 my $ram = $vgamem_mb * 4;
1898 my $vram = $vgamem_mb * 2;
1899 $memory .= ",ram_size_mb=$ram,vram_size_mb=$vram";
1900 } else {
1901 $memory = ",vgamem_mb=$vga->{memory}";
1902 }
1903 } elsif ($qxlnum && $id) {
1904 $memory = ",ram_size=67108864,vram_size=33554432";
1905 }
1906
789fe8e8
AL
1907 my $edidoff = "";
1908 if ($type eq 'VGA' && windows_version($conf->{ostype})) {
b5d32c6b 1909 $edidoff=",edid=off" if (!defined($conf->{bios}) || $conf->{bios} ne 'ovmf');
789fe8e8
AL
1910 }
1911
3392d6ca 1912 my $q35 = PVE::QemuServer::Machine::machine_type_is_q35($conf);
55655ebc
DC
1913 my $vgaid = "vga" . ($id // '');
1914 my $pciaddr;
1915 if ($q35 && $vgaid eq 'vga') {
daadd5a4 1916 # the first display uses pcie.0 bus on q35 machines
d559309f 1917 $pciaddr = print_pcie_addr($vgaid, $bridges, $arch, $machine);
55655ebc 1918 } else {
d559309f 1919 $pciaddr = print_pci_addr($vgaid, $bridges, $arch, $machine);
55655ebc
DC
1920 }
1921
9f979d9f 1922 if ($vga->{type} eq 'virtio-gl') {
8884a8bf
TL
1923 my $base = '/usr/lib/x86_64-linux-gnu/lib';
1924 die "missing libraries for '$vga->{type}' detected! Please install 'libgl1' and 'libegl1'\n"
1925 if !-e "${base}EGL.so.1" || !-e "${base}GL.so.1";
9f979d9f 1926
8884a8bf
TL
1927 die "no DRM render node detected (/dev/dri/renderD*), no GPU? - needed for '$vga->{type}' display\n"
1928 if !PVE::Tools::dir_glob_regex('/dev/dri/', "renderD.*");
9f979d9f
SI
1929 }
1930
789fe8e8 1931 return "$type,id=${vgaid}${memory}${max_outputs}${pciaddr}${edidoff}";
55655ebc
DC
1932}
1933
ffc0d8c7
WB
1934sub parse_number_sets {
1935 my ($set) = @_;
1936 my $res = [];
1937 foreach my $part (split(/;/, $set)) {
1938 if ($part =~ /^\s*(\d+)(?:-(\d+))?\s*$/) {
1939 die "invalid range: $part ($2 < $1)\n" if defined($2) && $2 < $1;
1940 push @$res, [ $1, $2 ];
2ed5d572 1941 } else {
ffc0d8c7 1942 die "invalid range: $part\n";
2ed5d572
AD
1943 }
1944 }
ffc0d8c7
WB
1945 return $res;
1946}
2ed5d572 1947
ffc0d8c7
WB
1948sub parse_numa {
1949 my ($data) = @_;
1950
4df98f2f 1951 my $res = parse_property_string($numa_fmt, $data);
ffc0d8c7
WB
1952 $res->{cpus} = parse_number_sets($res->{cpus}) if defined($res->{cpus});
1953 $res->{hostnodes} = parse_number_sets($res->{hostnodes}) if defined($res->{hostnodes});
2ed5d572
AD
1954 return $res;
1955}
1956
1e3baf05
DM
1957# netX: e1000=XX:XX:XX:XX:XX:XX,bridge=vmbr0,rate=<mbps>
1958sub parse_net {
4ddd2ca2 1959 my ($data, $disable_mac_autogen) = @_;
1e3baf05 1960
4df98f2f 1961 my $res = eval { parse_property_string($net_fmt, $data) };
cd9c34d1
WB
1962 if ($@) {
1963 warn $@;
d1c1af4b 1964 return;
1e3baf05 1965 }
4ddd2ca2 1966 if (!defined($res->{macaddr}) && !$disable_mac_autogen) {
b5b99790
WB
1967 my $dc = PVE::Cluster::cfs_read_file('datacenter.cfg');
1968 $res->{macaddr} = PVE::Tools::random_ether_addr($dc->{mac_prefix});
1969 }
0c9a7596
AD
1970 return $res;
1971}
1972
1973# ipconfigX ip=cidr,gw=ip,ip6=cidr,gw6=ip
1974sub parse_ipconfig {
1975 my ($data) = @_;
1976
4df98f2f 1977 my $res = eval { parse_property_string($ipconfig_fmt, $data) };
0c9a7596
AD
1978 if ($@) {
1979 warn $@;
d1c1af4b 1980 return;
0c9a7596
AD
1981 }
1982
1983 if ($res->{gw} && !$res->{ip}) {
1984 warn 'gateway specified without specifying an IP address';
d1c1af4b 1985 return;
0c9a7596
AD
1986 }
1987 if ($res->{gw6} && !$res->{ip6}) {
1988 warn 'IPv6 gateway specified without specifying an IPv6 address';
d1c1af4b 1989 return;
0c9a7596
AD
1990 }
1991 if ($res->{gw} && $res->{ip} eq 'dhcp') {
1992 warn 'gateway specified together with DHCP';
d1c1af4b 1993 return;
0c9a7596
AD
1994 }
1995 if ($res->{gw6} && $res->{ip6} !~ /^$IPV6RE/) {
1996 # gw6 + auto/dhcp
1997 warn "IPv6 gateway specified together with $res->{ip6} address";
d1c1af4b 1998 return;
0c9a7596
AD
1999 }
2000
2001 if (!$res->{ip} && !$res->{ip6}) {
2002 return { ip => 'dhcp', ip6 => 'dhcp' };
2003 }
2004
1e3baf05
DM
2005 return $res;
2006}
2007
2008sub print_net {
2009 my $net = shift;
2010
cd9c34d1 2011 return PVE::JSONSchema::print_property_string($net, $net_fmt);
1e3baf05
DM
2012}
2013
2014sub add_random_macs {
2015 my ($settings) = @_;
2016
2017 foreach my $opt (keys %$settings) {
2018 next if $opt !~ m/^net(\d+)$/;
2019 my $net = parse_net($settings->{$opt});
2020 next if !$net;
2021 $settings->{$opt} = print_net($net);
2022 }
2023}
2024
055d554d
DM
2025sub vm_is_volid_owner {
2026 my ($storecfg, $vmid, $volid) = @_;
2027
2028 if ($volid !~ m|^/|) {
2029 my ($path, $owner);
2030 eval { ($path, $owner) = PVE::Storage::path($storecfg, $volid); };
2031 if ($owner && ($owner == $vmid)) {
2032 return 1;
2033 }
2034 }
2035
d1c1af4b 2036 return;
055d554d
DM
2037}
2038
055d554d
DM
2039sub vmconfig_register_unused_drive {
2040 my ($storecfg, $vmid, $conf, $drive) = @_;
2041
2d9ddec5
WB
2042 if (drive_is_cloudinit($drive)) {
2043 eval { PVE::Storage::vdisk_free($storecfg, $drive->{file}) };
2044 warn $@ if $@;
95a5135d 2045 delete $conf->{cloudinit};
2d9ddec5 2046 } elsif (!drive_is_cdrom($drive)) {
055d554d
DM
2047 my $volid = $drive->{file};
2048 if (vm_is_volid_owner($storecfg, $vmid, $volid)) {
8793d495 2049 PVE::QemuConfig->add_unused_volume($conf, $volid, $vmid);
055d554d
DM
2050 }
2051 }
2052}
2053
1f30ac3a 2054# smbios: [manufacturer=str][,product=str][,version=str][,serial=str][,uuid=uuid][,sku=str][,family=str][,base64=bool]
ff6ffe20 2055my $smbios1_fmt = {
bd27e851
WB
2056 uuid => {
2057 type => 'string',
2058 pattern => '[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}',
2059 format_description => 'UUID',
52261945 2060 description => "Set SMBIOS1 UUID.",
bd27e851
WB
2061 optional => 1,
2062 },
2063 version => {
2064 type => 'string',
1f30ac3a
CE
2065 pattern => '[A-Za-z0-9+\/]+={0,2}',
2066 format_description => 'Base64 encoded string',
52261945 2067 description => "Set SMBIOS1 version.",
bd27e851
WB
2068 optional => 1,
2069 },
2070 serial => {
2071 type => 'string',
1f30ac3a
CE
2072 pattern => '[A-Za-z0-9+\/]+={0,2}',
2073 format_description => 'Base64 encoded string',
52261945 2074 description => "Set SMBIOS1 serial number.",
bd27e851
WB
2075 optional => 1,
2076 },
2077 manufacturer => {
2078 type => 'string',
1f30ac3a
CE
2079 pattern => '[A-Za-z0-9+\/]+={0,2}',
2080 format_description => 'Base64 encoded string',
52261945 2081 description => "Set SMBIOS1 manufacturer.",
bd27e851
WB
2082 optional => 1,
2083 },
2084 product => {
2085 type => 'string',
1f30ac3a
CE
2086 pattern => '[A-Za-z0-9+\/]+={0,2}',
2087 format_description => 'Base64 encoded string',
52261945 2088 description => "Set SMBIOS1 product ID.",
bd27e851
WB
2089 optional => 1,
2090 },
2091 sku => {
2092 type => 'string',
1f30ac3a
CE
2093 pattern => '[A-Za-z0-9+\/]+={0,2}',
2094 format_description => 'Base64 encoded string',
52261945 2095 description => "Set SMBIOS1 SKU string.",
bd27e851
WB
2096 optional => 1,
2097 },
2098 family => {
2099 type => 'string',
1f30ac3a
CE
2100 pattern => '[A-Za-z0-9+\/]+={0,2}',
2101 format_description => 'Base64 encoded string',
52261945 2102 description => "Set SMBIOS1 family string.",
bd27e851
WB
2103 optional => 1,
2104 },
1f30ac3a
CE
2105 base64 => {
2106 type => 'boolean',
2107 description => 'Flag to indicate that the SMBIOS values are base64 encoded',
2108 optional => 1,
2109 },
2796e7d5
DM
2110};
2111
2796e7d5
DM
2112sub parse_smbios1 {
2113 my ($data) = @_;
2114
4df98f2f 2115 my $res = eval { parse_property_string($smbios1_fmt, $data) };
bd27e851 2116 warn $@ if $@;
2796e7d5
DM
2117 return $res;
2118}
2119
cd11416f
DM
2120sub print_smbios1 {
2121 my ($smbios1) = @_;
ff6ffe20 2122 return PVE::JSONSchema::print_property_string($smbios1, $smbios1_fmt);
cd11416f
DM
2123}
2124
ff6ffe20 2125PVE::JSONSchema::register_format('pve-qm-smbios1', $smbios1_fmt);
2796e7d5 2126
0ea9541d
DM
2127sub parse_watchdog {
2128 my ($value) = @_;
2129
d1c1af4b 2130 return if !$value;
0ea9541d 2131
4df98f2f 2132 my $res = eval { parse_property_string($watchdog_fmt, $value) };
ec3582b5 2133 warn $@ if $@;
0ea9541d
DM
2134 return $res;
2135}
2136
9d66b397 2137sub parse_guest_agent {
a2af1bbe 2138 my ($conf) = @_;
9d66b397 2139
a2af1bbe 2140 return {} if !defined($conf->{agent});
9d66b397 2141
a2af1bbe 2142 my $res = eval { parse_property_string($agent_fmt, $conf->{agent}) };
9d66b397
SI
2143 warn $@ if $@;
2144
2145 # if the agent is disabled ignore the other potentially set properties
2146 return {} if !$res->{enabled};
2147 return $res;
2148}
2149
a2af1bbe
TL
2150sub get_qga_key {
2151 my ($conf, $key) = @_;
2152 return undef if !defined($conf->{agent});
2153
2154 my $agent = parse_guest_agent($conf);
2155 return $agent->{$key};
2156}
2157
55655ebc
DC
2158sub parse_vga {
2159 my ($value) = @_;
2160
2161 return {} if !$value;
4df98f2f 2162 my $res = eval { parse_property_string($vga_fmt, $value) };
55655ebc
DC
2163 warn $@ if $@;
2164 return $res;
2165}
2166
2cf61f33
SR
2167sub parse_rng {
2168 my ($value) = @_;
2169
d1c1af4b 2170 return if !$value;
2cf61f33 2171
4df98f2f 2172 my $res = eval { parse_property_string($rng_fmt, $value) };
2cf61f33
SR
2173 warn $@ if $@;
2174 return $res;
2175}
2176
26b443c8
TL
2177sub parse_meta_info {
2178 my ($value) = @_;
2179
2180 return if !$value;
2181
2182 my $res = eval { parse_property_string($meta_info_fmt, $value) };
2183 warn $@ if $@;
2184 return $res;
2185}
2186
2187sub new_meta_info_string {
2188 my () = @_; # for now do not allow to override any value
2189
2190 return PVE::JSONSchema::print_property_string(
2191 {
af2a1a1c 2192 'creation-qemu' => kvm_user_version(),
26b443c8
TL
2193 ctime => "". int(time()),
2194 },
2195 $meta_info_fmt
2196 );
2197}
2198
cc181036
TL
2199sub qemu_created_version_fixups {
2200 my ($conf, $forcemachine, $kvmver) = @_;
2201
2202 my $meta = parse_meta_info($conf->{meta}) // {};
2203 my $forced_vers = PVE::QemuServer::Machine::extract_version($forcemachine);
2204
2205 # check if we need to apply some handling for VMs that always use the latest machine version but
2206 # had a machine version transition happen that affected HW such that, e.g., an OS config change
2207 # would be required (we do not want to pin machine version for non-windows OS type)
2208 if (
2209 (!defined($conf->{machine}) || $conf->{machine} =~ m/^(?:pc|q35|virt)$/) # non-versioned machine
2210 && (!defined($meta->{'creation-qemu'}) || !min_version($meta->{'creation-qemu'}, 6, 1)) # created before 6.1
2211 && (!$forced_vers || min_version($forced_vers, 6, 1)) # handle snapshot-rollback/migrations
2212 && min_version($kvmver, 6, 1) # only need to apply the change since 6.1
2213 ) {
2214 my $q35 = PVE::QemuServer::Machine::machine_type_is_q35($conf);
2215 if ($q35 && $conf->{ostype} && $conf->{ostype} eq 'l26') {
2216 # this changed to default-on in Q 6.1 for q35 machines, it will mess with PCI slot view
2217 # and thus with the predictable interface naming of systemd
2218 return ['-global', 'ICH9-LPC.acpi-pci-hotplug-with-bridge-support=off'];
2219 }
2220 }
2221 return;
2222}
2223
1e3baf05
DM
2224PVE::JSONSchema::register_format('pve-qm-usb-device', \&verify_usb_device);
2225sub verify_usb_device {
2226 my ($value, $noerr) = @_;
2227
2228 return $value if parse_usb_device($value);
2229
d1c1af4b 2230 return if $noerr;
19672434 2231
1e3baf05
DM
2232 die "unable to parse usb device\n";
2233}
2234
1e3baf05
DM
2235# add JSON properties for create and set function
2236sub json_config_properties {
c1accf9d 2237 my ($prop, $with_disk_alloc) = @_;
1e3baf05 2238
5a08fb9c
TL
2239 my $skip_json_config_opts = {
2240 parent => 1,
2241 snaptime => 1,
2242 vmstate => 1,
2243 runningmachine => 1,
2244 runningcpu => 1,
26b443c8 2245 meta => 1,
5a08fb9c
TL
2246 };
2247
1e3baf05 2248 foreach my $opt (keys %$confdesc) {
5a08fb9c 2249 next if $skip_json_config_opts->{$opt};
c1accf9d
FE
2250
2251 if ($with_disk_alloc && is_valid_drivename($opt)) {
2252 $prop->{$opt} = $PVE::QemuServer::Drive::drivedesc_hash_with_alloc->{$opt};
2253 } else {
2254 $prop->{$opt} = $confdesc->{$opt};
2255 }
1e3baf05
DM
2256 }
2257
2258 return $prop;
2259}
2260
39051ac0
FE
2261# Properties that we can read from an OVF file
2262sub json_ovf_properties {
2263 my $prop = {};
2264
2265 for my $device (PVE::QemuServer::Drive::valid_drive_names()) {
2266 $prop->{$device} = {
2267 type => 'string',
2268 format => 'pve-volume-id-or-absolute-path',
2269 description => "Disk image that gets imported to $device",
2270 optional => 1,
2271 };
2272 }
2273
2274 $prop->{cores} = {
2275 type => 'integer',
2276 description => "The number of CPU cores.",
2277 optional => 1,
2278 };
2279 $prop->{memory} = {
2280 type => 'integer',
2281 description => "Amount of RAM for the VM in MB.",
2282 optional => 1,
2283 };
2284 $prop->{name} = {
2285 type => 'string',
2286 description => "Name of the VM.",
2287 optional => 1,
2288 };
2289
2290 return $prop;
2291}
2292
d41121fd
DM
2293# return copy of $confdesc_cloudinit to generate documentation
2294sub cloudinit_config_properties {
2295
2296 return dclone($confdesc_cloudinit);
2297}
2298
f16cf6c3
WB
2299sub cloudinit_pending_properties {
2300 my $p = {
2301 map { $_ => 1 } keys $confdesc_cloudinit->%*,
2302 name => 1,
2303 };
2304 $p->{"net$_"} = 1 for 0..($MAX_NETS-1);
2305 return $p;
2306}
2307
1e3baf05
DM
2308sub check_type {
2309 my ($key, $value) = @_;
2310
2311 die "unknown setting '$key'\n" if !$confdesc->{$key};
2312
2313 my $type = $confdesc->{$key}->{type};
2314
6b64503e 2315 if (!defined($value)) {
1e3baf05
DM
2316 die "got undefined value\n";
2317 }
2318
2319 if ($value =~ m/[\n\r]/) {
2320 die "property contains a line feed\n";
2321 }
2322
2323 if ($type eq 'boolean') {
19672434
DM
2324 return 1 if ($value eq '1') || ($value =~ m/^(on|yes|true)$/i);
2325 return 0 if ($value eq '0') || ($value =~ m/^(off|no|false)$/i);
2326 die "type check ('boolean') failed - got '$value'\n";
1e3baf05
DM
2327 } elsif ($type eq 'integer') {
2328 return int($1) if $value =~ m/^(\d+)$/;
2329 die "type check ('integer') failed - got '$value'\n";
04432191
AD
2330 } elsif ($type eq 'number') {
2331 return $value if $value =~ m/^(\d+)(\.\d+)?$/;
2332 die "type check ('number') failed - got '$value'\n";
1e3baf05
DM
2333 } elsif ($type eq 'string') {
2334 if (my $fmt = $confdesc->{$key}->{format}) {
1e3baf05 2335 PVE::JSONSchema::check_format($fmt, $value);
19672434
DM
2336 return $value;
2337 }
1e3baf05 2338 $value =~ s/^\"(.*)\"$/$1/;
19672434 2339 return $value;
1e3baf05
DM
2340 } else {
2341 die "internal error"
2342 }
2343}
2344
1e3baf05 2345sub destroy_vm {
75854662 2346 my ($storecfg, $vmid, $skiplock, $replacement_conf, $purge_unreferenced) = @_;
1e3baf05 2347
ffda963f 2348 my $conf = PVE::QemuConfig->load_config($vmid);
1e3baf05 2349
30fdf99c
SH
2350 if (!$skiplock && !PVE::QemuConfig->has_lock($conf, 'suspended')) {
2351 PVE::QemuConfig->check_lock($conf);
2352 }
1e3baf05 2353
5e67a2d2
DC
2354 if ($conf->{template}) {
2355 # check if any base image is still used by a linked clone
3ab0f925 2356 PVE::QemuConfig->foreach_volume_full($conf, { include_unused => 1 }, sub {
5e67a2d2 2357 my ($ds, $drive) = @_;
5e67a2d2
DC
2358 return if drive_is_cdrom($drive);
2359
2360 my $volid = $drive->{file};
5e67a2d2
DC
2361 return if !$volid || $volid =~ m|^/|;
2362
2363 die "base volume '$volid' is still in use by linked cloned\n"
2364 if PVE::Storage::volume_is_base_and_used($storecfg, $volid);
2365
2366 });
2367 }
2368
3e07c6d5 2369 my $volids = {};
ba1a1984 2370 my $remove_owned_drive = sub {
1e3baf05 2371 my ($ds, $drive) = @_;
9c52f5ed 2372 return if drive_is_cdrom($drive, 1);
1e3baf05
DM
2373
2374 my $volid = $drive->{file};
ff1a2432 2375 return if !$volid || $volid =~ m|^/|;
3e07c6d5 2376 return if $volids->{$volid};
1e3baf05 2377
6b64503e 2378 my ($path, $owner) = PVE::Storage::path($storecfg, $volid);
ff1a2432 2379 return if !$path || !$owner || ($owner != $vmid);
1e3baf05 2380
3e07c6d5 2381 $volids->{$volid} = 1;
a2f50f01 2382 eval { PVE::Storage::vdisk_free($storecfg, $volid) };
31b52247 2383 warn "Could not remove disk '$volid', check manually: $@" if $@;
ba1a1984
FE
2384 };
2385
2386 # only remove disks owned by this VM (referenced in the config)
2387 my $include_opts = {
2388 include_unused => 1,
2389 extra_keys => ['vmstate'],
2390 };
2391 PVE::QemuConfig->foreach_volume_full($conf, $include_opts, $remove_owned_drive);
2392
2393 for my $snap (values %{$conf->{snapshots}}) {
2394 next if !defined($snap->{vmstate});
2395 my $drive = PVE::QemuConfig->parse_volume('vmstate', $snap->{vmstate}, 1);
2396 next if !defined($drive);
2397 $remove_owned_drive->('vmstate', $drive);
2398 }
19672434 2399
3e07c6d5
FG
2400 PVE::QemuConfig->foreach_volume_full($conf->{pending}, $include_opts, $remove_owned_drive);
2401
75854662 2402 if ($purge_unreferenced) { # also remove unreferenced disk
d0ff75d9 2403 my $vmdisks = PVE::Storage::vdisk_list($storecfg, undef, $vmid, undef, 'images');
75854662
TL
2404 PVE::Storage::foreach_volid($vmdisks, sub {
2405 my ($volid, $sid, $volname, $d) = @_;
2406 eval { PVE::Storage::vdisk_free($storecfg, $volid) };
2407 warn $@ if $@;
2408 });
2409 }
dfda979e 2410
b04ea584 2411 if (defined $replacement_conf) {
8baf8bc7 2412 PVE::QemuConfig->write_config($vmid, $replacement_conf);
dfda979e
DJ
2413 } else {
2414 PVE::QemuConfig->destroy_config($vmid);
2415 }
1e3baf05
DM
2416}
2417
1e3baf05 2418sub parse_vm_config {
ad5812d8 2419 my ($filename, $raw, $strict) = @_;
1e3baf05 2420
d1c1af4b 2421 return if !defined($raw);
1e3baf05 2422
554ac7e7 2423 my $res = {
fc1ddcdc 2424 digest => Digest::SHA::sha1_hex($raw),
0d18dcfc 2425 snapshots => {},
0d732d16 2426 pending => {},
95a5135d 2427 cloudinit => {},
554ac7e7 2428 };
1e3baf05 2429
ad5812d8
FG
2430 my $handle_error = sub {
2431 my ($msg) = @_;
2432
2433 if ($strict) {
2434 die $msg;
2435 } else {
2436 warn $msg;
2437 }
2438 };
2439
19672434 2440 $filename =~ m|/qemu-server/(\d+)\.conf$|
1e3baf05
DM
2441 || die "got strange filename '$filename'";
2442
2443 my $vmid = $1;
2444
0d18dcfc 2445 my $conf = $res;
b0ec896e 2446 my $descr;
cbfc9d75
TL
2447 my $finish_description = sub {
2448 if (defined($descr)) {
2449 $descr =~ s/\s+$//;
2450 $conf->{description} = $descr;
2451 }
2452 $descr = undef;
2453 };
e297c490 2454 my $section = '';
0581fe4f 2455
0d18dcfc
DM
2456 my @lines = split(/\n/, $raw);
2457 foreach my $line (@lines) {
1e3baf05 2458 next if $line =~ m/^\s*$/;
be190583 2459
eab09f4e 2460 if ($line =~ m/^\[PENDING\]\s*$/i) {
e297c490 2461 $section = 'pending';
cbfc9d75 2462 $finish_description->();
e297c490 2463 $conf = $res->{$section} = {};
eab09f4e 2464 next;
95a5135d
AD
2465 } elsif ($line =~ m/^\[special:cloudinit\]\s*$/i) {
2466 $section = 'cloudinit';
eb9923f9 2467 $finish_description->();
95a5135d
AD
2468 $conf = $res->{$section} = {};
2469 next;
eab09f4e 2470
0d732d16 2471 } elsif ($line =~ m/^\[([a-z][a-z0-9_\-]+)\]\s*$/i) {
e297c490 2472 $section = $1;
cbfc9d75 2473 $finish_description->();
e297c490 2474 $conf = $res->{snapshots}->{$section} = {};
0d18dcfc
DM
2475 next;
2476 }
1e3baf05 2477
d1e7b922 2478 if ($line =~ m/^\#(.*)$/) {
b0ec896e 2479 $descr = '' if !defined($descr);
0581fe4f
DM
2480 $descr .= PVE::Tools::decode_text($1) . "\n";
2481 next;
2482 }
2483
1e3baf05 2484 if ($line =~ m/^(description):\s*(.*\S)\s*$/) {
b0ec896e 2485 $descr = '' if !defined($descr);
0581fe4f 2486 $descr .= PVE::Tools::decode_text($2);
0d18dcfc
DM
2487 } elsif ($line =~ m/snapstate:\s*(prepare|delete)\s*$/) {
2488 $conf->{snapstate} = $1;
1e3baf05
DM
2489 } elsif ($line =~ m/^(args):\s*(.*\S)\s*$/) {
2490 my $key = $1;
2491 my $value = $2;
0d18dcfc 2492 $conf->{$key} = $value;
ef824322 2493 } elsif ($line =~ m/^delete:\s*(.*\S)\s*$/) {
e297c490 2494 my $value = $1;
ef824322
DM
2495 if ($section eq 'pending') {
2496 $conf->{delete} = $value; # we parse this later
2497 } else {
ad5812d8 2498 $handle_error->("vm $vmid - property 'delete' is only allowed in [PENDING]\n");
eab09f4e 2499 }
15cf7698 2500 } elsif ($line =~ m/^([a-z][a-z_]*\d*):\s*(.+?)\s*$/) {
1e3baf05
DM
2501 my $key = $1;
2502 my $value = $2;
c229961a
TL
2503 if ($section eq 'cloudinit') {
2504 # ignore validation only used for informative purpose
2505 $conf->{$key} = $value;
2506 next;
2507 }
1e3baf05
DM
2508 eval { $value = check_type($key, $value); };
2509 if ($@) {
ad5812d8 2510 $handle_error->("vm $vmid - unable to parse value of '$key' - $@");
1e3baf05 2511 } else {
b799312f 2512 $key = 'ide2' if $key eq 'cdrom';
1e3baf05 2513 my $fmt = $confdesc->{$key}->{format};
b799312f 2514 if ($fmt && $fmt =~ /^pve-qm-(?:ide|scsi|virtio|sata)$/) {
1e3baf05
DM
2515 my $v = parse_drive($key, $value);
2516 if (my $volid = filename_to_volume_id($vmid, $v->{file}, $v->{media})) {
2517 $v->{file} = $volid;
71c58bb7 2518 $value = print_drive($v);
1e3baf05 2519 } else {
ad5812d8 2520 $handle_error->("vm $vmid - unable to parse value of '$key'\n");
1e3baf05
DM
2521 next;
2522 }
2523 }
2524
b799312f 2525 $conf->{$key} = $value;
1e3baf05 2526 }
f8d2a1ce 2527 } else {
ad5812d8 2528 $handle_error->("vm $vmid - unable to parse config: $line\n");
1e3baf05
DM
2529 }
2530 }
2531
cbfc9d75 2532 $finish_description->();
0d18dcfc 2533 delete $res->{snapstate}; # just to be sure
1e3baf05
DM
2534
2535 return $res;
2536}
2537
1858638f
DM
2538sub write_vm_config {
2539 my ($filename, $conf) = @_;
1e3baf05 2540
0d18dcfc
DM
2541 delete $conf->{snapstate}; # just to be sure
2542
1858638f
DM
2543 if ($conf->{cdrom}) {
2544 die "option ide2 conflicts with cdrom\n" if $conf->{ide2};
2545 $conf->{ide2} = $conf->{cdrom};
2546 delete $conf->{cdrom};
2547 }
1e3baf05
DM
2548
2549 # we do not use 'smp' any longer
1858638f
DM
2550 if ($conf->{sockets}) {
2551 delete $conf->{smp};
2552 } elsif ($conf->{smp}) {
2553 $conf->{sockets} = $conf->{smp};
2554 delete $conf->{cores};
2555 delete $conf->{smp};
1e3baf05
DM
2556 }
2557
ee2f90b1 2558 my $used_volids = {};
0d18dcfc 2559
ee2f90b1 2560 my $cleanup_config = sub {
ef824322 2561 my ($cref, $pending, $snapname) = @_;
1858638f 2562
ee2f90b1
DM
2563 foreach my $key (keys %$cref) {
2564 next if $key eq 'digest' || $key eq 'description' || $key eq 'snapshots' ||
95a5135d 2565 $key eq 'snapstate' || $key eq 'pending' || $key eq 'cloudinit';
ee2f90b1 2566 my $value = $cref->{$key};
ef824322
DM
2567 if ($key eq 'delete') {
2568 die "propertry 'delete' is only allowed in [PENDING]\n"
2569 if !$pending;
2570 # fixme: check syntax?
2571 next;
2572 }
ee2f90b1
DM
2573 eval { $value = check_type($key, $value); };
2574 die "unable to parse value of '$key' - $@" if $@;
1858638f 2575
ee2f90b1
DM
2576 $cref->{$key} = $value;
2577
74479ee9 2578 if (!$snapname && is_valid_drivename($key)) {
ed221350 2579 my $drive = parse_drive($key, $value);
ee2f90b1
DM
2580 $used_volids->{$drive->{file}} = 1 if $drive && $drive->{file};
2581 }
1e3baf05 2582 }
ee2f90b1
DM
2583 };
2584
2585 &$cleanup_config($conf);
ef824322
DM
2586
2587 &$cleanup_config($conf->{pending}, 1);
2588
ee2f90b1 2589 foreach my $snapname (keys %{$conf->{snapshots}}) {
15c6e277 2590 die "internal error: snapshot name '$snapname' is forbidden" if lc($snapname) eq 'pending';
ef824322 2591 &$cleanup_config($conf->{snapshots}->{$snapname}, undef, $snapname);
1e3baf05
DM
2592 }
2593
1858638f
DM
2594 # remove 'unusedX' settings if we re-add a volume
2595 foreach my $key (keys %$conf) {
2596 my $value = $conf->{$key};
ee2f90b1 2597 if ($key =~ m/^unused/ && $used_volids->{$value}) {
1858638f 2598 delete $conf->{$key};
1e3baf05 2599 }
1858638f 2600 }
be190583 2601
0d18dcfc 2602 my $generate_raw_config = sub {
b0ec896e 2603 my ($conf, $pending) = @_;
0581fe4f 2604
0d18dcfc
DM
2605 my $raw = '';
2606
2607 # add description as comment to top of file
b0ec896e
DM
2608 if (defined(my $descr = $conf->{description})) {
2609 if ($descr) {
2610 foreach my $cl (split(/\n/, $descr)) {
2611 $raw .= '#' . PVE::Tools::encode_text($cl) . "\n";
2612 }
2613 } else {
2614 $raw .= "#\n" if $pending;
2615 }
0d18dcfc
DM
2616 }
2617
2618 foreach my $key (sort keys %$conf) {
95a5135d 2619 next if $key =~ /^(digest|description|pending|cloudinit|snapshots)$/;
0d18dcfc
DM
2620 $raw .= "$key: $conf->{$key}\n";
2621 }
2622 return $raw;
2623 };
0581fe4f 2624
0d18dcfc 2625 my $raw = &$generate_raw_config($conf);
ef824322
DM
2626
2627 if (scalar(keys %{$conf->{pending}})){
2628 $raw .= "\n[PENDING]\n";
b0ec896e 2629 $raw .= &$generate_raw_config($conf->{pending}, 1);
ef824322
DM
2630 }
2631
1e1d6f58 2632 if (scalar(keys %{$conf->{cloudinit}}) && PVE::QemuConfig->has_cloudinit($conf)){
95a5135d
AD
2633 $raw .= "\n[special:cloudinit]\n";
2634 $raw .= &$generate_raw_config($conf->{cloudinit});
2635 }
2636
0d18dcfc
DM
2637 foreach my $snapname (sort keys %{$conf->{snapshots}}) {
2638 $raw .= "\n[$snapname]\n";
2639 $raw .= &$generate_raw_config($conf->{snapshots}->{$snapname});
1858638f 2640 }
1e3baf05 2641
1858638f
DM
2642 return $raw;
2643}
1e3baf05 2644
19672434 2645sub load_defaults {
1e3baf05
DM
2646
2647 my $res = {};
2648
2649 # we use static defaults from our JSON schema configuration
2650 foreach my $key (keys %$confdesc) {
2651 if (defined(my $default = $confdesc->{$key}->{default})) {
2652 $res->{$key} = $default;
2653 }
2654 }
19672434 2655
1e3baf05
DM
2656 return $res;
2657}
2658
2659sub config_list {
2660 my $vmlist = PVE::Cluster::get_vmlist();
2661 my $res = {};
2662 return $res if !$vmlist || !$vmlist->{ids};
2663 my $ids = $vmlist->{ids};
38277afc 2664 my $nodename = nodename();
1e3baf05 2665
1e3baf05
DM
2666 foreach my $vmid (keys %$ids) {
2667 my $d = $ids->{$vmid};
2668 next if !$d->{node} || $d->{node} ne $nodename;
5ee957cc 2669 next if !$d->{type} || $d->{type} ne 'qemu';
1e3baf05
DM
2670 $res->{$vmid}->{exists} = 1;
2671 }
2672 return $res;
2673}
2674
64e13401
DM
2675# test if VM uses local resources (to prevent migration)
2676sub check_local_resources {
2677 my ($conf, $noerr) = @_;
2678
ca6abacf 2679 my @loc_res = ();
19672434 2680
ca6abacf
TM
2681 push @loc_res, "hostusb" if $conf->{hostusb}; # old syntax
2682 push @loc_res, "hostpci" if $conf->{hostpci}; # old syntax
64e13401 2683
ca6abacf 2684 push @loc_res, "ivshmem" if $conf->{ivshmem};
6dbcb073 2685
0d29ab3b 2686 foreach my $k (keys %$conf) {
a9ce7583 2687 next if $k =~ m/^usb/ && ($conf->{$k} =~ m/^spice(?![^,])/);
d44712fc
EK
2688 # sockets are safe: they will recreated be on the target side post-migrate
2689 next if $k =~ m/^serial/ && ($conf->{$k} eq 'socket');
ca6abacf 2690 push @loc_res, $k if $k =~ m/^(usb|hostpci|serial|parallel)\d+$/;
64e13401
DM
2691 }
2692
ca6abacf 2693 die "VM uses local resources\n" if scalar @loc_res && !$noerr;
64e13401 2694
ca6abacf 2695 return \@loc_res;
64e13401
DM
2696}
2697
719893a9 2698# check if used storages are available on all nodes (use by migrate)
47152e2e
DM
2699sub check_storage_availability {
2700 my ($storecfg, $conf, $node) = @_;
2701
912792e2 2702 PVE::QemuConfig->foreach_volume($conf, sub {
47152e2e
DM
2703 my ($ds, $drive) = @_;
2704
2705 my $volid = $drive->{file};
2706 return if !$volid;
2707
2708 my ($sid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
2709 return if !$sid;
2710
2711 # check if storage is available on both nodes
0d2db084
FE
2712 my $scfg = PVE::Storage::storage_check_enabled($storecfg, $sid);
2713 PVE::Storage::storage_check_enabled($storecfg, $sid, $node);
24b84b47 2714
3148f0b0
TL
2715 my ($vtype) = PVE::Storage::parse_volname($storecfg, $volid);
2716
2717 die "$volid: content type '$vtype' is not available on storage '$sid'\n"
2718 if !$scfg->{content}->{$vtype};
47152e2e
DM
2719 });
2720}
2721
719893a9
DM
2722# list nodes where all VM images are available (used by has_feature API)
2723sub shared_nodes {
2724 my ($conf, $storecfg) = @_;
2725
2726 my $nodelist = PVE::Cluster::get_nodelist();
2727 my $nodehash = { map { $_ => 1 } @$nodelist };
38277afc 2728 my $nodename = nodename();
be190583 2729
912792e2 2730 PVE::QemuConfig->foreach_volume($conf, sub {
719893a9
DM
2731 my ($ds, $drive) = @_;
2732
2733 my $volid = $drive->{file};
2734 return if !$volid;
2735
2736 my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
2737 if ($storeid) {
2738 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
2739 if ($scfg->{disable}) {
2740 $nodehash = {};
2741 } elsif (my $avail = $scfg->{nodes}) {
2742 foreach my $node (keys %$nodehash) {
2743 delete $nodehash->{$node} if !$avail->{$node};
2744 }
2745 } elsif (!$scfg->{shared}) {
2746 foreach my $node (keys %$nodehash) {
2747 delete $nodehash->{$node} if $node ne $nodename
2748 }
2749 }
2750 }
2751 });
2752
2753 return $nodehash
2754}
2755
f25852c2
TM
2756sub check_local_storage_availability {
2757 my ($conf, $storecfg) = @_;
2758
2759 my $nodelist = PVE::Cluster::get_nodelist();
2760 my $nodehash = { map { $_ => {} } @$nodelist };
2761
912792e2 2762 PVE::QemuConfig->foreach_volume($conf, sub {
f25852c2
TM
2763 my ($ds, $drive) = @_;
2764
2765 my $volid = $drive->{file};
2766 return if !$volid;
2767
2768 my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
2769 if ($storeid) {
2770 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
2771
2772 if ($scfg->{disable}) {
2773 foreach my $node (keys %$nodehash) {
32075a2c 2774 $nodehash->{$node}->{unavailable_storages}->{$storeid} = 1;
f25852c2
TM
2775 }
2776 } elsif (my $avail = $scfg->{nodes}) {
2777 foreach my $node (keys %$nodehash) {
2778 if (!$avail->{$node}) {
32075a2c 2779 $nodehash->{$node}->{unavailable_storages}->{$storeid} = 1;
f25852c2
TM
2780 }
2781 }
2782 }
2783 }
2784 });
2785
32075a2c
TL
2786 foreach my $node (values %$nodehash) {
2787 if (my $unavail = $node->{unavailable_storages}) {
2788 $node->{unavailable_storages} = [ sort keys %$unavail ];
2789 }
2790 }
2791
f25852c2
TM
2792 return $nodehash
2793}
2794
babf613a 2795# Compat only, use assert_config_exists_on_node and vm_running_locally where possible
1e3baf05 2796sub check_running {
7e8dcf2c 2797 my ($vmid, $nocheck, $node) = @_;
1e3baf05 2798
a20dc58a
FG
2799 # $nocheck is set when called during a migration, in which case the config
2800 # file might still or already reside on the *other* node
2801 # - because rename has already happened, and current node is source
2802 # - because rename hasn't happened yet, and current node is target
2803 # - because rename has happened, current node is target, but hasn't yet
2804 # processed it yet
babf613a
SR
2805 PVE::QemuConfig::assert_config_exists_on_node($vmid, $node) if !$nocheck;
2806 return PVE::QemuServer::Helpers::vm_running_locally($vmid);
1e3baf05
DM
2807}
2808
2809sub vzlist {
19672434 2810
1e3baf05
DM
2811 my $vzlist = config_list();
2812
d036e418 2813 my $fd = IO::Dir->new($PVE::QemuServer::Helpers::var_run_tmpdir) || return $vzlist;
1e3baf05 2814
19672434 2815 while (defined(my $de = $fd->read)) {
1e3baf05
DM
2816 next if $de !~ m/^(\d+)\.pid$/;
2817 my $vmid = $1;
6b64503e
DM
2818 next if !defined($vzlist->{$vmid});
2819 if (my $pid = check_running($vmid)) {
1e3baf05
DM
2820 $vzlist->{$vmid}->{pid} = $pid;
2821 }
2822 }
2823
2824 return $vzlist;
2825}
2826
b1a70cab
DM
2827our $vmstatus_return_properties = {
2828 vmid => get_standard_option('pve-vmid'),
2829 status => {
7bd9abd2 2830 description => "QEMU process status.",
b1a70cab
DM
2831 type => 'string',
2832 enum => ['stopped', 'running'],
2833 },
2834 maxmem => {
2835 description => "Maximum memory in bytes.",
2836 type => 'integer',
2837 optional => 1,
2838 renderer => 'bytes',
2839 },
2840 maxdisk => {
2841 description => "Root disk size in bytes.",
2842 type => 'integer',
2843 optional => 1,
2844 renderer => 'bytes',
2845 },
2846 name => {
2847 description => "VM name.",
2848 type => 'string',
2849 optional => 1,
2850 },
2851 qmpstatus => {
7bd9abd2 2852 description => "QEMU QMP agent status.",
b1a70cab
DM
2853 type => 'string',
2854 optional => 1,
2855 },
2856 pid => {
2857 description => "PID of running qemu process.",
2858 type => 'integer',
2859 optional => 1,
2860 },
2861 uptime => {
2862 description => "Uptime.",
2863 type => 'integer',
2864 optional => 1,
2865 renderer => 'duration',
2866 },
2867 cpus => {
2868 description => "Maximum usable CPUs.",
2869 type => 'number',
2870 optional => 1,
2871 },
e6ed61b4 2872 lock => {
11efdfa5 2873 description => "The current config lock, if any.",
e6ed61b4
DC
2874 type => 'string',
2875 optional => 1,
b8e7068a
DC
2876 },
2877 tags => {
2878 description => "The current configured tags, if any",
2879 type => 'string',
2880 optional => 1,
2881 },
949112c3
FE
2882 'running-machine' => {
2883 description => "The currently running machine type (if running).",
2884 type => 'string',
2885 optional => 1,
2886 },
2887 'running-qemu' => {
2888 description => "The currently running QEMU version (if running).",
2889 type => 'string',
2890 optional => 1,
2891 },
b1a70cab
DM
2892};
2893
1e3baf05
DM
2894my $last_proc_pid_stat;
2895
03a33f30
DM
2896# get VM status information
2897# This must be fast and should not block ($full == false)
2898# We only query KVM using QMP if $full == true (this can be slow)
1e3baf05 2899sub vmstatus {
03a33f30 2900 my ($opt_vmid, $full) = @_;
1e3baf05
DM
2901
2902 my $res = {};
2903
19672434 2904 my $storecfg = PVE::Storage::config();
1e3baf05
DM
2905
2906 my $list = vzlist();
3618ee99
EK
2907 my $defaults = load_defaults();
2908
694fcad4 2909 my ($uptime) = PVE::ProcFSTools::read_proc_uptime(1);
1e3baf05 2910
ae4915a2
DM
2911 my $cpucount = $cpuinfo->{cpus} || 1;
2912
1e3baf05
DM
2913 foreach my $vmid (keys %$list) {
2914 next if $opt_vmid && ($vmid ne $opt_vmid);
2915
9f78b695 2916 my $conf = PVE::QemuConfig->load_config($vmid);
1e3baf05 2917
ad2cad72 2918 my $d = { vmid => int($vmid) };
8a0addab 2919 $d->{pid} = int($list->{$vmid}->{pid}) if $list->{$vmid}->{pid};
1e3baf05
DM
2920
2921 # fixme: better status?
2922 $d->{status} = $list->{$vmid}->{pid} ? 'running' : 'stopped';
2923
776c5f50 2924 my $size = PVE::QemuServer::Drive::bootdisk_size($storecfg, $conf);
af990afe
DM
2925 if (defined($size)) {
2926 $d->{disk} = 0; # no info available
1e3baf05
DM
2927 $d->{maxdisk} = $size;
2928 } else {
2929 $d->{disk} = 0;
2930 $d->{maxdisk} = 0;
2931 }
2932
3618ee99
EK
2933 $d->{cpus} = ($conf->{sockets} || $defaults->{sockets})
2934 * ($conf->{cores} || $defaults->{cores});
ae4915a2 2935 $d->{cpus} = $cpucount if $d->{cpus} > $cpucount;
d7c8364b 2936 $d->{cpus} = $conf->{vcpus} if $conf->{vcpus};
ae4915a2 2937
1e3baf05 2938 $d->{name} = $conf->{name} || "VM $vmid";
3618ee99
EK
2939 $d->{maxmem} = $conf->{memory} ? $conf->{memory}*(1024*1024)
2940 : $defaults->{memory}*(1024*1024);
1e3baf05 2941
8b1accf7 2942 if ($conf->{balloon}) {
4bdb0514 2943 $d->{balloon_min} = $conf->{balloon}*(1024*1024);
3618ee99
EK
2944 $d->{shares} = defined($conf->{shares}) ? $conf->{shares}
2945 : $defaults->{shares};
8b1accf7
DM
2946 }
2947
1e3baf05
DM
2948 $d->{uptime} = 0;
2949 $d->{cpu} = 0;
1e3baf05
DM
2950 $d->{mem} = 0;
2951
2952 $d->{netout} = 0;
2953 $d->{netin} = 0;
2954
2955 $d->{diskread} = 0;
2956 $d->{diskwrite} = 0;
2957
75a2a423 2958 $d->{template} = 1 if PVE::QemuConfig->is_template($conf);
4d8c851b 2959
8107b378 2960 $d->{serial} = 1 if conf_has_serial($conf);
e6ed61b4 2961 $d->{lock} = $conf->{lock} if $conf->{lock};
b8e7068a 2962 $d->{tags} = $conf->{tags} if defined($conf->{tags});
8107b378 2963
1e3baf05
DM
2964 $res->{$vmid} = $d;
2965 }
2966
2967 my $netdev = PVE::ProcFSTools::read_proc_net_dev();
2968 foreach my $dev (keys %$netdev) {
2969 next if $dev !~ m/^tap([1-9]\d*)i/;
2970 my $vmid = $1;
2971 my $d = $res->{$vmid};
2972 next if !$d;
19672434 2973
1e3baf05
DM
2974 $d->{netout} += $netdev->{$dev}->{receive};
2975 $d->{netin} += $netdev->{$dev}->{transmit};
604ea644
AD
2976
2977 if ($full) {
ad2cad72
FE
2978 $d->{nics}->{$dev}->{netout} = int($netdev->{$dev}->{receive});
2979 $d->{nics}->{$dev}->{netin} = int($netdev->{$dev}->{transmit});
604ea644
AD
2980 }
2981
1e3baf05
DM
2982 }
2983
1e3baf05
DM
2984 my $ctime = gettimeofday;
2985
2986 foreach my $vmid (keys %$list) {
2987
2988 my $d = $res->{$vmid};
2989 my $pid = $d->{pid};
2990 next if !$pid;
2991
694fcad4
DM
2992 my $pstat = PVE::ProcFSTools::read_proc_pid_stat($pid);
2993 next if !$pstat; # not running
19672434 2994
694fcad4 2995 my $used = $pstat->{utime} + $pstat->{stime};
1e3baf05 2996
694fcad4 2997 $d->{uptime} = int(($uptime - $pstat->{starttime})/$cpuinfo->{user_hz});
1e3baf05 2998
694fcad4 2999 if ($pstat->{vsize}) {
6b64503e 3000 $d->{mem} = int(($pstat->{rss}/$pstat->{vsize})*$d->{maxmem});
1e3baf05
DM
3001 }
3002
3003 my $old = $last_proc_pid_stat->{$pid};
3004 if (!$old) {
19672434
DM
3005 $last_proc_pid_stat->{$pid} = {
3006 time => $ctime,
1e3baf05
DM
3007 used => $used,
3008 cpu => 0,
1e3baf05
DM
3009 };
3010 next;
3011 }
3012
7f0b5beb 3013 my $dtime = ($ctime - $old->{time}) * $cpucount * $cpuinfo->{user_hz};
1e3baf05
DM
3014
3015 if ($dtime > 1000) {
3016 my $dutime = $used - $old->{used};
3017
ae4915a2 3018 $d->{cpu} = (($dutime/$dtime)* $cpucount) / $d->{cpus};
1e3baf05 3019 $last_proc_pid_stat->{$pid} = {
19672434 3020 time => $ctime,
1e3baf05
DM
3021 used => $used,
3022 cpu => $d->{cpu},
1e3baf05
DM
3023 };
3024 } else {
3025 $d->{cpu} = $old->{cpu};
1e3baf05
DM
3026 }
3027 }
3028
f5eb281a 3029 return $res if !$full;
03a33f30
DM
3030
3031 my $qmpclient = PVE::QMPClient->new();
3032
64e7fcf2
DM
3033 my $ballooncb = sub {
3034 my ($vmid, $resp) = @_;
3035
3036 my $info = $resp->{'return'};
38babf81
DM
3037 return if !$info->{max_mem};
3038
64e7fcf2
DM
3039 my $d = $res->{$vmid};
3040
38babf81
DM
3041 # use memory assigned to VM
3042 $d->{maxmem} = $info->{max_mem};
3043 $d->{balloon} = $info->{actual};
3044
3045 if (defined($info->{total_mem}) && defined($info->{free_mem})) {
3046 $d->{mem} = $info->{total_mem} - $info->{free_mem};
3047 $d->{freemem} = $info->{free_mem};
64e7fcf2
DM
3048 }
3049
604ea644 3050 $d->{ballooninfo} = $info;
64e7fcf2
DM
3051 };
3052
03a33f30
DM
3053 my $blockstatscb = sub {
3054 my ($vmid, $resp) = @_;
3055 my $data = $resp->{'return'} || [];
3056 my $totalrdbytes = 0;
3057 my $totalwrbytes = 0;
604ea644 3058
03a33f30
DM
3059 for my $blockstat (@$data) {
3060 $totalrdbytes = $totalrdbytes + $blockstat->{stats}->{rd_bytes};
3061 $totalwrbytes = $totalwrbytes + $blockstat->{stats}->{wr_bytes};
604ea644
AD
3062
3063 $blockstat->{device} =~ s/drive-//;
3064 $res->{$vmid}->{blockstat}->{$blockstat->{device}} = $blockstat->{stats};
03a33f30
DM
3065 }
3066 $res->{$vmid}->{diskread} = $totalrdbytes;
3067 $res->{$vmid}->{diskwrite} = $totalwrbytes;
3068 };
3069
949112c3
FE
3070 my $machinecb = sub {
3071 my ($vmid, $resp) = @_;
3072 my $data = $resp->{'return'} || [];
3073
3074 $res->{$vmid}->{'running-machine'} =
3075 PVE::QemuServer::Machine::current_from_query_machines($data);
3076 };
3077
3078 my $versioncb = sub {
3079 my ($vmid, $resp) = @_;
3080 my $data = $resp->{'return'} // {};
3081 my $version = 'unknown';
3082
3083 if (my $v = $data->{qemu}) {
3084 $version = $v->{major} . "." . $v->{minor} . "." . $v->{micro};
3085 }
3086
3087 $res->{$vmid}->{'running-qemu'} = $version;
3088 };
3089
03a33f30
DM
3090 my $statuscb = sub {
3091 my ($vmid, $resp) = @_;
64e7fcf2 3092
03a33f30 3093 $qmpclient->queue_cmd($vmid, $blockstatscb, 'query-blockstats');
949112c3
FE
3094 $qmpclient->queue_cmd($vmid, $machinecb, 'query-machines');
3095 $qmpclient->queue_cmd($vmid, $versioncb, 'query-version');
64e7fcf2
DM
3096 # this fails if ballon driver is not loaded, so this must be
3097 # the last commnand (following command are aborted if this fails).
38babf81 3098 $qmpclient->queue_cmd($vmid, $ballooncb, 'query-balloon');
03a33f30
DM
3099
3100 my $status = 'unknown';
3101 if (!defined($status = $resp->{'return'}->{status})) {
3102 warn "unable to get VM status\n";
3103 return;
3104 }
3105
3106 $res->{$vmid}->{qmpstatus} = $resp->{'return'}->{status};
3107 };
3108
3109 foreach my $vmid (keys %$list) {
3110 next if $opt_vmid && ($vmid ne $opt_vmid);
3111 next if !$res->{$vmid}->{pid}; # not running
3112 $qmpclient->queue_cmd($vmid, $statuscb, 'query-status');
3113 }
3114
b017fbda 3115 $qmpclient->queue_execute(undef, 2);
03a33f30 3116
6891fd70
SR
3117 foreach my $vmid (keys %$list) {
3118 next if $opt_vmid && ($vmid ne $opt_vmid);
e5b18771
FG
3119 next if !$res->{$vmid}->{pid}; #not running
3120
6891fd70
SR
3121 # we can't use the $qmpclient since it might have already aborted on
3122 # 'query-balloon', but this might also fail for older versions...
3123 my $qemu_support = eval { mon_cmd($vmid, "query-proxmox-support") };
3124 $res->{$vmid}->{'proxmox-support'} = $qemu_support // {};
3125 }
3126
03a33f30
DM
3127 foreach my $vmid (keys %$list) {
3128 next if $opt_vmid && ($vmid ne $opt_vmid);
3129 $res->{$vmid}->{qmpstatus} = $res->{$vmid}->{status} if !$res->{$vmid}->{qmpstatus};
3130 }
3131
1e3baf05
DM
3132 return $res;
3133}
3134
8107b378
DC
3135sub conf_has_serial {
3136 my ($conf) = @_;
3137
3138 for (my $i = 0; $i < $MAX_SERIAL_PORTS; $i++) {
3139 if ($conf->{"serial$i"}) {
3140 return 1;
3141 }
3142 }
3143
3144 return 0;
3145}
3146
d5535a00
TL
3147sub conf_has_audio {
3148 my ($conf, $id) = @_;
3149
3150 $id //= 0;
3151 my $audio = $conf->{"audio$id"};
d1c1af4b 3152 return if !defined($audio);
d5535a00 3153
4df98f2f 3154 my $audioproperties = parse_property_string($audio_fmt, $audio);
d5535a00
TL
3155 my $audiodriver = $audioproperties->{driver} // 'spice';
3156
3157 return {
3158 dev => $audioproperties->{device},
b0f96836 3159 dev_id => "audiodev$id",
d5535a00
TL
3160 backend => $audiodriver,
3161 backend_id => "$audiodriver-backend${id}",
3162 };
3163}
3164
b01de199 3165sub audio_devs {
1cc5ed1b 3166 my ($audio, $audiopciaddr, $machine_version) = @_;
b01de199
TL
3167
3168 my $devs = [];
3169
3170 my $id = $audio->{dev_id};
1cc5ed1b
AL
3171 my $audiodev = "";
3172 if (min_version($machine_version, 4, 2)) {
3173 $audiodev = ",audiodev=$audio->{backend_id}";
3174 }
b01de199
TL
3175
3176 if ($audio->{dev} eq 'AC97') {
1cc5ed1b 3177 push @$devs, '-device', "AC97,id=${id}${audiopciaddr}$audiodev";
b01de199
TL
3178 } elsif ($audio->{dev} =~ /intel\-hda$/) {
3179 push @$devs, '-device', "$audio->{dev},id=${id}${audiopciaddr}";
1cc5ed1b
AL
3180 push @$devs, '-device', "hda-micro,id=${id}-codec0,bus=${id}.0,cad=0$audiodev";
3181 push @$devs, '-device', "hda-duplex,id=${id}-codec1,bus=${id}.0,cad=1$audiodev";
b01de199
TL
3182 } else {
3183 die "unkown audio device '$audio->{dev}', implement me!";
3184 }
3185
3186 push @$devs, '-audiodev', "$audio->{backend},id=$audio->{backend_id}";
3187
3188 return $devs;
3189}
3190
f9dde219
SR
3191sub get_tpm_paths {
3192 my ($vmid) = @_;
3193 return {
3194 socket => "/var/run/qemu-server/$vmid.swtpm",
3195 pid => "/var/run/qemu-server/$vmid.swtpm.pid",
3196 };
3197}
3198
3199sub add_tpm_device {
3200 my ($vmid, $devices, $conf) = @_;
3201
3202 return if !$conf->{tpmstate0};
3203
3204 my $paths = get_tpm_paths($vmid);
3205
3206 push @$devices, "-chardev", "socket,id=tpmchar,path=$paths->{socket}";
3207 push @$devices, "-tpmdev", "emulator,id=tpmdev,chardev=tpmchar";
3208 push @$devices, "-device", "tpm-tis,tpmdev=tpmdev";
3209}
3210
3211sub start_swtpm {
3212 my ($storecfg, $vmid, $tpmdrive, $migration) = @_;
3213
3214 return if !$tpmdrive;
3215
3216 my $state;
3217 my $tpm = parse_drive("tpmstate0", $tpmdrive);
3218 my ($storeid, $volname) = PVE::Storage::parse_volume_id($tpm->{file}, 1);
3219 if ($storeid) {
3220 $state = PVE::Storage::map_volume($storecfg, $tpm->{file});
3221 } else {
3222 $state = $tpm->{file};
3223 }
3224
3225 my $paths = get_tpm_paths($vmid);
3226
3227 # during migration, we will get state from remote
3228 #
3229 if (!$migration) {
3230 # run swtpm_setup to create a new TPM state if it doesn't exist yet
3231 my $setup_cmd = [
3232 "swtpm_setup",
3233 "--tpmstate",
3234 "file://$state",
3235 "--createek",
3236 "--create-ek-cert",
3237 "--create-platform-cert",
3238 "--lock-nvram",
3239 "--config",
3240 "/etc/swtpm_setup.conf", # do not use XDG configs
3241 "--runas",
3242 "0", # force creation as root, error if not possible
3243 "--not-overwrite", # ignore existing state, do not modify
3244 ];
3245
3246 push @$setup_cmd, "--tpm2" if $tpm->{version} eq 'v2.0';
3247 # TPM 2.0 supports ECC crypto, use if possible
3248 push @$setup_cmd, "--ecc" if $tpm->{version} eq 'v2.0';
3249
3250 run_command($setup_cmd, outfunc => sub {
3251 print "swtpm_setup: $1\n";
3252 });
3253 }
3254
3255 my $emulator_cmd = [
3256 "swtpm",
3257 "socket",
3258 "--tpmstate",
3259 "backend-uri=file://$state,mode=0600",
3260 "--ctrl",
3261 "type=unixio,path=$paths->{socket},mode=0600",
3262 "--pid",
3263 "file=$paths->{pid}",
3264 "--terminate", # terminate on QEMU disconnect
3265 "--daemon",
3266 ];
3267 push @$emulator_cmd, "--tpm2" if $tpm->{version} eq 'v2.0';
3268 run_command($emulator_cmd, outfunc => sub { print $1; });
3269
6bbcd71f 3270 my $tries = 100; # swtpm may take a bit to start before daemonizing, wait up to 5s for pid
f85951dc 3271 while (! -e $paths->{pid}) {
90c41bac 3272 die "failed to start swtpm: pid file '$paths->{pid}' wasn't created.\n" if --$tries == 0;
6bbcd71f 3273 usleep(50_000);
f85951dc
SR
3274 }
3275
f9dde219
SR
3276 # return untainted PID of swtpm daemon so it can be killed on error
3277 file_read_firstline($paths->{pid}) =~ m/(\d+)/;
3278 return $1;
3279}
3280
86b8228b
DM
3281sub vga_conf_has_spice {
3282 my ($vga) = @_;
3283
55655ebc
DC
3284 my $vgaconf = parse_vga($vga);
3285 my $vgatype = $vgaconf->{type};
3286 return 0 if !$vgatype || $vgatype !~ m/^qxl([234])?$/;
590e698c
DM
3287
3288 return $1 || 1;
86b8228b
DM
3289}
3290
d731ecbe
WB
3291sub is_native($) {
3292 my ($arch) = @_;
3293 return get_host_arch() eq $arch;
3294}
3295
045749f2
TL
3296sub get_vm_arch {
3297 my ($conf) = @_;
3298 return $conf->{arch} // get_host_arch();
3299}
3300
d731ecbe
WB
3301my $default_machines = {
3302 x86_64 => 'pc',
3303 aarch64 => 'virt',
3304};
3305
0761e619
TL
3306sub get_installed_machine_version {
3307 my ($kvmversion) = @_;
3308 $kvmversion = kvm_user_version() if !defined($kvmversion);
3309 $kvmversion =~ m/^(\d+\.\d+)/;
3310 return $1;
3311}
3312
3313sub windows_get_pinned_machine_version {
3314 my ($machine, $base_version, $kvmversion) = @_;
3315
3316 my $pin_version = $base_version;
3317 if (!defined($base_version) ||
3318 !PVE::QemuServer::Machine::can_run_pve_machine_version($base_version, $kvmversion)
3319 ) {
3320 $pin_version = get_installed_machine_version($kvmversion);
3321 }
3322 if (!$machine || $machine eq 'pc') {
3323 $machine = "pc-i440fx-$pin_version";
3324 } elsif ($machine eq 'q35') {
3325 $machine = "pc-q35-$pin_version";
3326 } elsif ($machine eq 'virt') {
3327 $machine = "virt-$pin_version";
3328 } else {
3329 warn "unknown machine type '$machine', not touching that!\n";
3330 }
3331
3332 return $machine;
3333}
3334
045749f2 3335sub get_vm_machine {
ac0077cc 3336 my ($conf, $forcemachine, $arch, $add_pve_version, $kvmversion) = @_;
045749f2
TL
3337
3338 my $machine = $forcemachine || $conf->{machine};
d731ecbe 3339
9471e48b 3340 if (!$machine || $machine =~ m/^(?:pc|q35|virt)$/) {
4dd1e83c
TL
3341 $kvmversion //= kvm_user_version();
3342 # we must pin Windows VMs without a specific version to 5.1, as 5.2 fixed a bug in ACPI
3343 # layout which confuses windows quite a bit and may result in various regressions..
3344 # see: https://lists.gnu.org/archive/html/qemu-devel/2021-02/msg08484.html
3345 if (windows_version($conf->{ostype})) {
0761e619 3346 $machine = windows_get_pinned_machine_version($machine, '5.1', $kvmversion);
4dd1e83c 3347 }
045749f2
TL
3348 $arch //= 'x86_64';
3349 $machine ||= $default_machines->{$arch};
ac0077cc 3350 if ($add_pve_version) {
ac0077cc
SR
3351 my $pvever = PVE::QemuServer::Machine::get_pve_version($kvmversion);
3352 $machine .= "+pve$pvever";
3353 }
3354 }
3355
d4be7f31
SR
3356 if ($add_pve_version && $machine !~ m/\+pve\d+?(?:\.pxe)?$/) {
3357 my $is_pxe = $machine =~ m/^(.*?)\.pxe$/;
3358 $machine = $1 if $is_pxe;
3359
ac0077cc
SR
3360 # for version-pinned machines that do not include a pve-version (e.g.
3361 # pc-q35-4.1), we assume 0 to keep them stable in case we bump
3362 $machine .= '+pve0';
d4be7f31
SR
3363
3364 $machine .= '.pxe' if $is_pxe;
045749f2
TL
3365 }
3366
3367 return $machine;
d731ecbe
WB
3368}
3369
90b20b15
DC
3370sub get_ovmf_files($$$) {
3371 my ($arch, $efidisk, $smm) = @_;
96ed3574 3372
b5099b4f 3373 my $types = $OVMF->{$arch}
96ed3574
WB
3374 or die "no OVMF images known for architecture '$arch'\n";
3375
b5099b4f
SR
3376 my $type = 'default';
3377 if (defined($efidisk->{efitype}) && $efidisk->{efitype} eq '4m') {
90b20b15
DC
3378 $type = $smm ? "4m" : "4m-no-smm";
3379 $type .= '-ms' if $efidisk->{'pre-enrolled-keys'};
b5099b4f
SR
3380 }
3381
3382 return $types->{$type}->@*;
96ed3574
WB
3383}
3384
6908fd9b
WB
3385my $Arch2Qemu = {
3386 aarch64 => '/usr/bin/qemu-system-aarch64',
3387 x86_64 => '/usr/bin/qemu-system-x86_64',
3388};
3389sub get_command_for_arch($) {
3390 my ($arch) = @_;
3391 return '/usr/bin/kvm' if is_native($arch);
3392
3393 my $cmd = $Arch2Qemu->{$arch}
3394 or die "don't know how to emulate architecture '$arch'\n";
3395 return $cmd;
3396}
3397
05a4c550
SR
3398# To use query_supported_cpu_flags and query_understood_cpu_flags to get flags
3399# to use in a QEMU command line (-cpu element), first array_intersect the result
3400# of query_supported_ with query_understood_. This is necessary because:
3401#
3402# a) query_understood_ returns flags the host cannot use and
3403# b) query_supported_ (rather the QMP call) doesn't actually return CPU
3404# flags, but CPU settings - with most of them being flags. Those settings
3405# (and some flags, curiously) cannot be specified as a "-cpu" argument.
3406#
3407# query_supported_ needs to start up to 2 temporary VMs and is therefore rather
3408# expensive. If you need the value returned from this, you can get it much
3409# cheaper from pmxcfs using PVE::Cluster::get_node_kv('cpuflags-$accel') with
3410# $accel being 'kvm' or 'tcg'.
3411#
3412# pvestatd calls this function on startup and whenever the QEMU/KVM version
3413# changes, automatically populating pmxcfs.
3414#
3415# Returns: { kvm => [ flagX, flagY, ... ], tcg => [ flag1, flag2, ... ] }
3416# since kvm and tcg machines support different flags
3417#
3418sub query_supported_cpu_flags {
52cffab6 3419 my ($arch) = @_;
05a4c550 3420
52cffab6
SR
3421 $arch //= get_host_arch();
3422 my $default_machine = $default_machines->{$arch};
3423
3424 my $flags = {};
05a4c550
SR
3425
3426 # FIXME: Once this is merged, the code below should work for ARM as well:
3427 # https://lists.nongnu.org/archive/html/qemu-devel/2019-06/msg04947.html
3428 die "QEMU/KVM cannot detect CPU flags on ARM (aarch64)\n" if
3429 $arch eq "aarch64";
3430
3431 my $kvm_supported = defined(kvm_version());
3432 my $qemu_cmd = get_command_for_arch($arch);
3433 my $fakevmid = -1;
3434 my $pidfile = PVE::QemuServer::Helpers::pidfile_name($fakevmid);
3435
3436 # Start a temporary (frozen) VM with vmid -1 to allow sending a QMP command
3437 my $query_supported_run_qemu = sub {
3438 my ($kvm) = @_;
3439
3440 my $flags = {};
3441 my $cmd = [
3442 $qemu_cmd,
3443 '-machine', $default_machine,
3444 '-display', 'none',
378ad769 3445 '-chardev', "socket,id=qmp,path=/var/run/qemu-server/$fakevmid.qmp,server=on,wait=off",
05a4c550
SR
3446 '-mon', 'chardev=qmp,mode=control',
3447 '-pidfile', $pidfile,
3448 '-S', '-daemonize'
3449 ];
3450
3451 if (!$kvm) {
3452 push @$cmd, '-accel', 'tcg';
3453 }
3454
3455 my $rc = run_command($cmd, noerr => 1, quiet => 0);
3456 die "QEMU flag querying VM exited with code " . $rc if $rc;
3457
3458 eval {
3459 my $cmd_result = mon_cmd(
3460 $fakevmid,
3461 'query-cpu-model-expansion',
3462 type => 'full',
3463 model => { name => 'host' }
3464 );
3465
3466 my $props = $cmd_result->{model}->{props};
3467 foreach my $prop (keys %$props) {
3468 next if $props->{$prop} ne '1';
3469 # QEMU returns some flags multiple times, with '_', '.' or '-'
3470 # (e.g. lahf_lm and lahf-lm; sse4.2, sse4-2 and sse4_2; ...).
3471 # We only keep those with underscores, to match /proc/cpuinfo
3472 $prop =~ s/\.|-/_/g;
3473 $flags->{$prop} = 1;
3474 }
3475 };
3476 my $err = $@;
3477
6bbcd71f 3478 # force stop with 10 sec timeout and 'nocheck', always stop, even if QMP failed
05a4c550
SR
3479 vm_stop(undef, $fakevmid, 1, 1, 10, 0, 1);
3480
3481 die $err if $err;
3482
3483 return [ sort keys %$flags ];
3484 };
3485
3486 # We need to query QEMU twice, since KVM and TCG have different supported flags
3487 PVE::QemuConfig->lock_config($fakevmid, sub {
3488 $flags->{tcg} = eval { $query_supported_run_qemu->(0) };
3489 warn "warning: failed querying supported tcg flags: $@\n" if $@;
3490
3491 if ($kvm_supported) {
3492 $flags->{kvm} = eval { $query_supported_run_qemu->(1) };
3493 warn "warning: failed querying supported kvm flags: $@\n" if $@;
3494 }
3495 });
3496
3497 return $flags;
3498}
3499
3500# Understood CPU flags are written to a file at 'pve-qemu' compile time
3501my $understood_cpu_flag_dir = "/usr/share/kvm";
3502sub query_understood_cpu_flags {
3503 my $arch = get_host_arch();
3504 my $filepath = "$understood_cpu_flag_dir/recognized-CPUID-flags-$arch";
3505
3506 die "Cannot query understood QEMU CPU flags for architecture: $arch (file not found)\n"
3507 if ! -e $filepath;
3508
3509 my $raw = file_get_contents($filepath);
3510 $raw =~ s/^\s+|\s+$//g;
3511 my @flags = split(/\s+/, $raw);
3512
3513 return \@flags;
3514}
3515
e5a6919c
FE
3516# Since commit 277d33454f77ec1d1e0bc04e37621e4dd2424b67 in pve-qemu, smm is not off by default
3517# anymore. But smm=off seems to be required when using SeaBIOS and serial display.
3518my sub should_disable_smm {
3519 my ($conf, $vga) = @_;
3520
3521 return (!defined($conf->{bios}) || $conf->{bios} eq 'seabios') &&
bec87424 3522 $vga->{type} && $vga->{type} =~ m/^(serial\d+|none)$/;
e5a6919c
FE
3523}
3524
b7d80c79
FE
3525my sub print_ovmf_drive_commandlines {
3526 my ($conf, $storecfg, $vmid, $arch, $q35, $version_guard) = @_;
3527
3d07669c 3528 my $d = $conf->{efidisk0} ? parse_drive('efidisk0', $conf->{efidisk0}) : undef;
b7d80c79
FE
3529
3530 my ($ovmf_code, $ovmf_vars) = get_ovmf_files($arch, $d, $q35);
3531 die "uefi base image '$ovmf_code' not found\n" if ! -f $ovmf_code;
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};
6779f1ac 5049 PVE::QemuServer::Memory::qemu_memory_hotplug($vmid, $conf, $defaults, $opt);
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};
6779f1ac 5124 $value = PVE::QemuServer::Memory::qemu_memory_hotplug($vmid, $conf, $defaults, $opt, $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
3898a563
FG
6034 mon_cmd($vmid, 'qom-set',
6035 path => "machine/peripheral/balloon0",
6036 property => "guest-stats-polling-interval",
6037 value => 2) if (!defined($conf->{balloon}) || $conf->{balloon});
eb065317 6038
3898a563
FG
6039 if ($resume) {
6040 print "Resumed VM, removing state\n";
6041 if (my $vmstate = $conf->{vmstate}) {
6042 PVE::Storage::deactivate_volumes($storecfg, [$vmstate]);
6043 PVE::Storage::vdisk_free($storecfg, $vmstate);
7ceade4c 6044 }
ea1c2110 6045 delete $conf->@{qw(lock vmstate runningmachine runningcpu)};
3898a563
FG
6046 PVE::QemuConfig->write_config($vmid, $conf);
6047 }
7ceade4c 6048
3898a563 6049 PVE::GuestHelpers::exec_hookscript($conf, $vmid, 'post-start');
84da8217
FG
6050
6051 return $res;
1e3baf05
DM
6052}
6053
1e3baf05 6054sub vm_commandline {
b14477e7 6055 my ($storecfg, $vmid, $snapname) = @_;
1e3baf05 6056
ffda963f 6057 my $conf = PVE::QemuConfig->load_config($vmid);
1e3baf05 6058
e8a26810 6059 my ($forcemachine, $forcecpu);
b14477e7
RV
6060 if ($snapname) {
6061 my $snapshot = $conf->{snapshots}->{$snapname};
87d92707
TL
6062 die "snapshot '$snapname' does not exist\n" if !defined($snapshot);
6063
ea1c2110
SR
6064 # check for machine or CPU overrides in snapshot
6065 $forcemachine = $snapshot->{runningmachine};
6066 $forcecpu = $snapshot->{runningcpu};
092868c4 6067
87d92707 6068 $snapshot->{digest} = $conf->{digest}; # keep file digest for API
b14477e7 6069
b14477e7
RV
6070 $conf = $snapshot;
6071 }
6072
1e3baf05
DM
6073 my $defaults = load_defaults();
6074
e8a26810 6075 my $cmd = config_to_command($storecfg, $vmid, $conf, $defaults, $forcemachine, $forcecpu);
1e3baf05 6076
5930c1ff 6077 return PVE::Tools::cmd2string($cmd);
1e3baf05
DM
6078}
6079
6080sub vm_reset {
6081 my ($vmid, $skiplock) = @_;
6082
ffda963f 6083 PVE::QemuConfig->lock_config($vmid, sub {
1e3baf05 6084
ffda963f 6085 my $conf = PVE::QemuConfig->load_config($vmid);
1e3baf05 6086
ffda963f 6087 PVE::QemuConfig->check_lock($conf) if !$skiplock;
1e3baf05 6088
0a13e08e 6089 mon_cmd($vmid, "system_reset");
ff1a2432
DM
6090 });
6091}
6092
6093sub get_vm_volumes {
6094 my ($conf) = @_;
1e3baf05 6095
ff1a2432 6096 my $vollist = [];
d5769dc2 6097 foreach_volid($conf, sub {
392f8b5d 6098 my ($volid, $attr) = @_;
ff1a2432 6099
d5769dc2 6100 return if $volid =~ m|^/|;
ff1a2432 6101
d5769dc2
DM
6102 my ($sid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
6103 return if !$sid;
ff1a2432
DM
6104
6105 push @$vollist, $volid;
1e3baf05 6106 });
ff1a2432
DM
6107
6108 return $vollist;
6109}
6110
1b189121
DC
6111sub cleanup_pci_devices {
6112 my ($vmid, $conf) = @_;
6113
6114 foreach my $key (keys %$conf) {
6115 next if $key !~ m/^hostpci(\d+)$/;
6116 my $hostpciindex = $1;
6117 my $uuid = PVE::SysFSTools::generate_mdev_uuid($vmid, $hostpciindex);
6118 my $d = parse_hostpci($conf->{$key});
faf72d6c
TL
6119 if ($d->{mdev}) {
6120 # NOTE: avoid PVE::SysFSTools::pci_cleanup_mdev_device as it requires PCI ID and we
6121 # don't want to break ABI just for this two liner
6122 my $dev_sysfs_dir = "/sys/bus/mdev/devices/$uuid";
6123 PVE::SysFSTools::file_write("$dev_sysfs_dir/remove", "1") if -e $dev_sysfs_dir;
6124 }
1b189121
DC
6125 }
6126 PVE::QemuServer::PCI::remove_pci_reservation($vmid);
6127}
6128
ff1a2432 6129sub vm_stop_cleanup {
70b04821 6130 my ($storecfg, $vmid, $conf, $keepActive, $apply_pending_changes) = @_;
ff1a2432 6131
745fed70 6132 eval {
ff1a2432 6133
254575e9
DM
6134 if (!$keepActive) {
6135 my $vollist = get_vm_volumes($conf);
6136 PVE::Storage::deactivate_volumes($storecfg, $vollist);
f9dde219
SR
6137
6138 if (my $tpmdrive = $conf->{tpmstate0}) {
6139 my $tpm = parse_drive("tpmstate0", $tpmdrive);
6140 my ($storeid, $volname) = PVE::Storage::parse_volume_id($tpm->{file}, 1);
6141 if ($storeid) {
6142 PVE::Storage::unmap_volume($storecfg, $tpm->{file});
6143 }
6144 }
254575e9 6145 }
a1b7d579 6146
ab6a046f 6147 foreach my $ext (qw(mon qmp pid vnc qga)) {
961bfcb2
DM
6148 unlink "/var/run/qemu-server/${vmid}.$ext";
6149 }
a1b7d579 6150
6dbcb073 6151 if ($conf->{ivshmem}) {
4df98f2f 6152 my $ivshmem = parse_property_string($ivshmem_fmt, $conf->{ivshmem});
4c5a6a24
TL
6153 # just delete it for now, VMs which have this already open do not
6154 # are affected, but new VMs will get a separated one. If this
6155 # becomes an issue we either add some sort of ref-counting or just
6156 # add a "don't delete on stop" flag to the ivshmem format.
6dbcb073
DC
6157 unlink '/dev/shm/pve-shm-' . ($ivshmem->{name} // $vmid);
6158 }
6159
1b189121 6160 cleanup_pci_devices($vmid, $conf);
6ab45bd7 6161
70b04821 6162 vmconfig_apply_pending($vmid, $conf, $storecfg) if $apply_pending_changes;
745fed70
DM
6163 };
6164 warn $@ if $@; # avoid errors - just warn
1e3baf05
DM
6165}
6166
575d19da
DC
6167# call only in locked context
6168sub _do_vm_stop {
6169 my ($storecfg, $vmid, $skiplock, $nocheck, $timeout, $shutdown, $force, $keepActive) = @_;
9269013a 6170
575d19da
DC
6171 my $pid = check_running($vmid, $nocheck);
6172 return if !$pid;
1e3baf05 6173
575d19da
DC
6174 my $conf;
6175 if (!$nocheck) {
6176 $conf = PVE::QemuConfig->load_config($vmid);
6177 PVE::QemuConfig->check_lock($conf) if !$skiplock;
6178 if (!defined($timeout) && $shutdown && $conf->{startup}) {
6179 my $opts = PVE::JSONSchema::pve_parse_startup_order($conf->{startup});
6180 $timeout = $opts->{down} if $opts->{down};
e6c3b671 6181 }
575d19da
DC
6182 PVE::GuestHelpers::exec_hookscript($conf, $vmid, 'pre-stop');
6183 }
19672434 6184
575d19da
DC
6185 eval {
6186 if ($shutdown) {
a2af1bbe 6187 if (defined($conf) && get_qga_key($conf, 'enabled')) {
0a13e08e 6188 mon_cmd($vmid, "guest-shutdown", timeout => $timeout);
9269013a 6189 } else {
0a13e08e 6190 mon_cmd($vmid, "system_powerdown");
1e3baf05
DM
6191 }
6192 } else {
0a13e08e 6193 mon_cmd($vmid, "quit");
1e3baf05 6194 }
575d19da
DC
6195 };
6196 my $err = $@;
1e3baf05 6197
575d19da
DC
6198 if (!$err) {
6199 $timeout = 60 if !defined($timeout);
1e3baf05
DM
6200
6201 my $count = 0;
e6c3b671 6202 while (($count < $timeout) && check_running($vmid, $nocheck)) {
1e3baf05
DM
6203 $count++;
6204 sleep 1;
6205 }
6206
6207 if ($count >= $timeout) {
575d19da
DC
6208 if ($force) {
6209 warn "VM still running - terminating now with SIGTERM\n";
6210 kill 15, $pid;
6211 } else {
6212 die "VM quit/powerdown failed - got timeout\n";
6213 }
6214 } else {
6215 vm_stop_cleanup($storecfg, $vmid, $conf, $keepActive, 1) if $conf;
6216 return;
1e3baf05 6217 }
575d19da 6218 } else {
d60cbb97
TL
6219 if (!check_running($vmid, $nocheck)) {
6220 warn "Unexpected: VM shutdown command failed, but VM not running anymore..\n";
6221 return;
6222 }
6223 if ($force) {
575d19da
DC
6224 warn "VM quit/powerdown failed - terminating now with SIGTERM\n";
6225 kill 15, $pid;
6226 } else {
6227 die "VM quit/powerdown failed\n";
6228 }
6229 }
6230
6231 # wait again
6232 $timeout = 10;
6233
6234 my $count = 0;
6235 while (($count < $timeout) && check_running($vmid, $nocheck)) {
6236 $count++;
6237 sleep 1;
6238 }
6239
6240 if ($count >= $timeout) {
6241 warn "VM still running - terminating now with SIGKILL\n";
6242 kill 9, $pid;
6243 sleep 1;
6244 }
1e3baf05 6245
575d19da
DC
6246 vm_stop_cleanup($storecfg, $vmid, $conf, $keepActive, 1) if $conf;
6247}
6248
6249# Note: use $nocheck to skip tests if VM configuration file exists.
6250# We need that when migration VMs to other nodes (files already moved)
6251# Note: we set $keepActive in vzdump stop mode - volumes need to stay active
6252sub vm_stop {
6253 my ($storecfg, $vmid, $skiplock, $nocheck, $timeout, $shutdown, $force, $keepActive, $migratedfrom) = @_;
6254
6255 $force = 1 if !defined($force) && !$shutdown;
6256
6257 if ($migratedfrom){
6258 my $pid = check_running($vmid, $nocheck, $migratedfrom);
6259 kill 15, $pid if $pid;
6260 my $conf = PVE::QemuConfig->load_config($vmid, $migratedfrom);
6261 vm_stop_cleanup($storecfg, $vmid, $conf, $keepActive, 0);
6262 return;
6263 }
6264
6265 PVE::QemuConfig->lock_config($vmid, sub {
6266 _do_vm_stop($storecfg, $vmid, $skiplock, $nocheck, $timeout, $shutdown, $force, $keepActive);
ff1a2432 6267 });
1e3baf05
DM
6268}
6269
165411f0
DC
6270sub vm_reboot {
6271 my ($vmid, $timeout) = @_;
6272
6273 PVE::QemuConfig->lock_config($vmid, sub {
66026117 6274 eval {
165411f0 6275
66026117
OB
6276 # only reboot if running, as qmeventd starts it again on a stop event
6277 return if !check_running($vmid);
165411f0 6278
66026117 6279 create_reboot_request($vmid);
165411f0 6280
66026117
OB
6281 my $storecfg = PVE::Storage::config();
6282 _do_vm_stop($storecfg, $vmid, undef, undef, $timeout, 1);
165411f0 6283
66026117
OB
6284 };
6285 if (my $err = $@) {
3c1c3fe6 6286 # avoid that the next normal shutdown will be confused for a reboot
66026117
OB
6287 clear_reboot_request($vmid);
6288 die $err;
6289 }
165411f0
DC
6290 });
6291}
6292
75c24bba 6293# note: if using the statestorage parameter, the caller has to check privileges
1e3baf05 6294sub vm_suspend {
48b4cdc2 6295 my ($vmid, $skiplock, $includestate, $statestorage) = @_;
159719e5
DC
6296
6297 my $conf;
6298 my $path;
6299 my $storecfg;
6300 my $vmstate;
1e3baf05 6301
ffda963f 6302 PVE::QemuConfig->lock_config($vmid, sub {
1e3baf05 6303
159719e5 6304 $conf = PVE::QemuConfig->load_config($vmid);
1e3baf05 6305
159719e5 6306 my $is_backing_up = PVE::QemuConfig->has_lock($conf, 'backup');
e79706d4 6307 PVE::QemuConfig->check_lock($conf)
159719e5
DC
6308 if !($skiplock || $is_backing_up);
6309
6310 die "cannot suspend to disk during backup\n"
6311 if $is_backing_up && $includestate;
bcb7c9cf 6312
159719e5
DC
6313 if ($includestate) {
6314 $conf->{lock} = 'suspending';
6315 my $date = strftime("%Y-%m-%d", localtime(time()));
6316 $storecfg = PVE::Storage::config();
75c24bba
DC
6317 if (!$statestorage) {
6318 $statestorage = find_vmstate_storage($conf, $storecfg);
6319 # check permissions for the storage
6320 my $rpcenv = PVE::RPCEnvironment::get();
6321 if ($rpcenv->{type} ne 'cli') {
6322 my $authuser = $rpcenv->get_user();
6323 $rpcenv->check($authuser, "/storage/$statestorage", ['Datastore.AllocateSpace']);
6324 }
6325 }
6326
6327
4df98f2f
TL
6328 $vmstate = PVE::QemuConfig->__snapshot_save_vmstate(
6329 $vmid, $conf, "suspend-$date", $storecfg, $statestorage, 1);
159719e5
DC
6330 $path = PVE::Storage::path($storecfg, $vmstate);
6331 PVE::QemuConfig->write_config($vmid, $conf);
6332 } else {
0a13e08e 6333 mon_cmd($vmid, "stop");
159719e5 6334 }
1e3baf05 6335 });
159719e5
DC
6336
6337 if ($includestate) {
6338 # save vm state
6339 PVE::Storage::activate_volumes($storecfg, [$vmstate]);
6340
6341 eval {
27a5be53 6342 set_migration_caps($vmid, 1);
0a13e08e 6343 mon_cmd($vmid, "savevm-start", statefile => $path);
159719e5 6344 for(;;) {
0a13e08e 6345 my $state = mon_cmd($vmid, "query-savevm");
159719e5
DC
6346 if (!$state->{status}) {
6347 die "savevm not active\n";
6348 } elsif ($state->{status} eq 'active') {
6349 sleep(1);
6350 next;
6351 } elsif ($state->{status} eq 'completed') {
b0a9a385 6352 print "State saved, quitting\n";
159719e5
DC
6353 last;
6354 } elsif ($state->{status} eq 'failed' && $state->{error}) {
6355 die "query-savevm failed with error '$state->{error}'\n"
6356 } else {
6357 die "query-savevm returned status '$state->{status}'\n";
6358 }
6359 }
6360 };
6361 my $err = $@;
6362
6363 PVE::QemuConfig->lock_config($vmid, sub {
6364 $conf = PVE::QemuConfig->load_config($vmid);
6365 if ($err) {
6366 # cleanup, but leave suspending lock, to indicate something went wrong
6367 eval {
0a13e08e 6368 mon_cmd($vmid, "savevm-end");
159719e5
DC
6369 PVE::Storage::deactivate_volumes($storecfg, [$vmstate]);
6370 PVE::Storage::vdisk_free($storecfg, $vmstate);
ea1c2110 6371 delete $conf->@{qw(vmstate runningmachine runningcpu)};
159719e5
DC
6372 PVE::QemuConfig->write_config($vmid, $conf);
6373 };
6374 warn $@ if $@;
6375 die $err;
6376 }
6377
6378 die "lock changed unexpectedly\n"
6379 if !PVE::QemuConfig->has_lock($conf, 'suspending');
6380
0a13e08e 6381 mon_cmd($vmid, "quit");
159719e5
DC
6382 $conf->{lock} = 'suspended';
6383 PVE::QemuConfig->write_config($vmid, $conf);
6384 });
6385 }
1e3baf05
DM
6386}
6387
a20dc58a
FG
6388# $nocheck is set when called as part of a migration - in this context the
6389# location of the config file (source or target node) is not deterministic,
6390# since migration cannot wait for pmxcfs to process the rename
1e3baf05 6391sub vm_resume {
289e0b85 6392 my ($vmid, $skiplock, $nocheck) = @_;
1e3baf05 6393
ffda963f 6394 PVE::QemuConfig->lock_config($vmid, sub {
0a13e08e 6395 my $res = mon_cmd($vmid, 'query-status');
c2786bed 6396 my $resume_cmd = 'cont';
8e0c97bb 6397 my $reset = 0;
270bfff2
FG
6398 my $conf;
6399 if ($nocheck) {
ad9e347c
FG
6400 $conf = eval { PVE::QemuConfig->load_config($vmid) }; # try on target node
6401 if ($@) {
6402 my $vmlist = PVE::Cluster::get_vmlist();
6403 if (exists($vmlist->{ids}->{$vmid})) {
6404 my $node = $vmlist->{ids}->{$vmid}->{node};
6405 $conf = eval { PVE::QemuConfig->load_config($vmid, $node) }; # try on source node
6406 }
6407 if (!$conf) {
6408 PVE::Cluster::cfs_update(); # vmlist was wrong, invalidate cache
6409 $conf = PVE::QemuConfig->load_config($vmid); # last try on target node again
6410 }
270bfff2 6411 }
270bfff2
FG
6412 } else {
6413 $conf = PVE::QemuConfig->load_config($vmid);
6414 }
c2786bed 6415
8e0c97bb
SR
6416 if ($res->{status}) {
6417 return if $res->{status} eq 'running'; # job done, go home
6418 $resume_cmd = 'system_wakeup' if $res->{status} eq 'suspended';
6419 $reset = 1 if $res->{status} eq 'shutdown';
c2786bed
DC
6420 }
6421
289e0b85 6422 if (!$nocheck) {
e79706d4
FG
6423 PVE::QemuConfig->check_lock($conf)
6424 if !($skiplock || PVE::QemuConfig->has_lock($conf, 'backup'));
289e0b85 6425 }
3e24733b 6426
8e0c97bb
SR
6427 if ($reset) {
6428 # required if a VM shuts down during a backup and we get a resume
6429 # request before the backup finishes for example
6430 mon_cmd($vmid, "system_reset");
6431 }
21947fea
AD
6432
6433 add_nets_bridge_fdb($conf, $vmid) if $resume_cmd eq 'cont';
6434
0a13e08e 6435 mon_cmd($vmid, $resume_cmd);
1e3baf05
DM
6436 });
6437}
6438
5fdbe4f0
DM
6439sub vm_sendkey {
6440 my ($vmid, $skiplock, $key) = @_;
1e3baf05 6441
ffda963f 6442 PVE::QemuConfig->lock_config($vmid, sub {
1e3baf05 6443
ffda963f 6444 my $conf = PVE::QemuConfig->load_config($vmid);
f5eb281a 6445
7b7c6d1b 6446 # there is no qmp command, so we use the human monitor command
0a13e08e 6447 my $res = PVE::QemuServer::Monitor::hmp_cmd($vmid, "sendkey $key");
d30820d6 6448 die $res if $res ne '';
1e3baf05
DM
6449 });
6450}
6451
3e16d5fc
DM
6452# vzdump restore implementaion
6453
ed221350 6454sub tar_archive_read_firstfile {
3e16d5fc 6455 my $archive = shift;
afdb31d5 6456
3e16d5fc
DM
6457 die "ERROR: file '$archive' does not exist\n" if ! -f $archive;
6458
6459 # try to detect archive type first
387ba257 6460 my $pid = open (my $fh, '-|', 'tar', 'tf', $archive) ||
3e16d5fc 6461 die "unable to open file '$archive'\n";
387ba257 6462 my $firstfile = <$fh>;
3e16d5fc 6463 kill 15, $pid;
387ba257 6464 close $fh;
3e16d5fc
DM
6465
6466 die "ERROR: archive contaions no data\n" if !$firstfile;
6467 chomp $firstfile;
6468
6469 return $firstfile;
6470}
6471
ed221350
DM
6472sub tar_restore_cleanup {
6473 my ($storecfg, $statfile) = @_;
3e16d5fc
DM
6474
6475 print STDERR "starting cleanup\n";
6476
6477 if (my $fd = IO::File->new($statfile, "r")) {
6478 while (defined(my $line = <$fd>)) {
6479 if ($line =~ m/vzdump:([^\s:]*):(\S+)$/) {
6480 my $volid = $2;
6481 eval {
6482 if ($volid =~ m|^/|) {
6483 unlink $volid || die 'unlink failed\n';
6484 } else {
ed221350 6485 PVE::Storage::vdisk_free($storecfg, $volid);
3e16d5fc 6486 }
afdb31d5 6487 print STDERR "temporary volume '$volid' sucessfuly removed\n";
3e16d5fc
DM
6488 };
6489 print STDERR "unable to cleanup '$volid' - $@" if $@;
6490 } else {
6491 print STDERR "unable to parse line in statfile - $line";
afdb31d5 6492 }
3e16d5fc
DM
6493 }
6494 $fd->close();
6495 }
6496}
6497
d1e92cf6 6498sub restore_file_archive {
a0d1b1a2 6499 my ($archive, $vmid, $user, $opts) = @_;
3e16d5fc 6500
a2ec5a67
FG
6501 return restore_vma_archive($archive, $vmid, $user, $opts)
6502 if $archive eq '-';
6503
c6d51783
AA
6504 my $info = PVE::Storage::archive_info($archive);
6505 my $format = $opts->{format} // $info->{format};
6506 my $comp = $info->{compression};
91bd6c90
DM
6507
6508 # try to detect archive format
6509 if ($format eq 'tar') {
6510 return restore_tar_archive($archive, $vmid, $user, $opts);
6511 } else {
6512 return restore_vma_archive($archive, $vmid, $user, $opts, $comp);
6513 }
6514}
6515
d1e92cf6
DM
6516# hepler to remove disks that will not be used after restore
6517my $restore_cleanup_oldconf = sub {
6518 my ($storecfg, $vmid, $oldconf, $virtdev_hash) = @_;
6519
01a4377f
FE
6520 my $kept_disks = {};
6521
912792e2 6522 PVE::QemuConfig->foreach_volume($oldconf, sub {
d1e92cf6
DM
6523 my ($ds, $drive) = @_;
6524
6525 return if drive_is_cdrom($drive, 1);
6526
6527 my $volid = $drive->{file};
6528 return if !$volid || $volid =~ m|^/|;
6529
6530 my ($path, $owner) = PVE::Storage::path($storecfg, $volid);
6531 return if !$path || !$owner || ($owner != $vmid);
6532
6533 # Note: only delete disk we want to restore
6534 # other volumes will become unused
6535 if ($virtdev_hash->{$ds}) {
6536 eval { PVE::Storage::vdisk_free($storecfg, $volid); };
6537 if (my $err = $@) {
6538 warn $err;
6539 }
01a4377f
FE
6540 } else {
6541 $kept_disks->{$volid} = 1;
d1e92cf6
DM
6542 }
6543 });
6544
01a4377f
FE
6545 # after the restore we have no snapshots anymore
6546 for my $snapname (keys $oldconf->{snapshots}->%*) {
d1e92cf6
DM
6547 my $snap = $oldconf->{snapshots}->{$snapname};
6548 if ($snap->{vmstate}) {
6549 eval { PVE::Storage::vdisk_free($storecfg, $snap->{vmstate}); };
6550 if (my $err = $@) {
6551 warn $err;
6552 }
6553 }
01a4377f
FE
6554
6555 for my $volid (keys $kept_disks->%*) {
6556 eval { PVE::Storage::volume_snapshot_delete($storecfg, $volid, $snapname); };
6557 warn $@ if $@;
6558 }
d1e92cf6
DM
6559 }
6560};
6561
9f3d73bc
DM
6562# Helper to parse vzdump backup device hints
6563#
6564# $rpcenv: Environment, used to ckeck storage permissions
6565# $user: User ID, to check storage permissions
6566# $storecfg: Storage configuration
6567# $fh: the file handle for reading the configuration
6568# $devinfo: should contain device sizes for all backu-up'ed devices
6569# $options: backup options (pool, default storage)
6570#
6571# Return: $virtdev_hash, updates $devinfo (add devname, virtdev, format, storeid)
6572my $parse_backup_hints = sub {
6573 my ($rpcenv, $user, $storecfg, $fh, $devinfo, $options) = @_;
d1e92cf6 6574
36d4bdcb
TL
6575 my $check_storage = sub { # assert if an image can be allocate
6576 my ($storeid, $scfg) = @_;
6577 die "Content type 'images' is not available on storage '$storeid'\n"
6578 if !$scfg->{content}->{images};
6579 $rpcenv->check($user, "/storage/$storeid", ['Datastore.AllocateSpace'])
6580 if $user ne 'root@pam';
6581 };
d1e92cf6 6582
36d4bdcb 6583 my $virtdev_hash = {};
9f3d73bc
DM
6584 while (defined(my $line = <$fh>)) {
6585 if ($line =~ m/^\#qmdump\#map:(\S+):(\S+):(\S*):(\S*):$/) {
6586 my ($virtdev, $devname, $storeid, $format) = ($1, $2, $3, $4);
6587 die "archive does not contain data for drive '$virtdev'\n"
6588 if !$devinfo->{$devname};
6589
6590 if (defined($options->{storage})) {
6591 $storeid = $options->{storage} || 'local';
6592 } elsif (!$storeid) {
6593 $storeid = 'local';
d1e92cf6 6594 }
9f3d73bc
DM
6595 $format = 'raw' if !$format;
6596 $devinfo->{$devname}->{devname} = $devname;
6597 $devinfo->{$devname}->{virtdev} = $virtdev;
6598 $devinfo->{$devname}->{format} = $format;
6599 $devinfo->{$devname}->{storeid} = $storeid;
6600
62af60cd 6601 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
36d4bdcb 6602 $check_storage->($storeid, $scfg); # permission and content type check
d1e92cf6 6603
9f3d73bc
DM
6604 $virtdev_hash->{$virtdev} = $devinfo->{$devname};
6605 } elsif ($line =~ m/^((?:ide|sata|scsi)\d+):\s*(.*)\s*$/) {
6606 my $virtdev = $1;
6607 my $drive = parse_drive($virtdev, $2);
36d4bdcb 6608
9f3d73bc
DM
6609 if (drive_is_cloudinit($drive)) {
6610 my ($storeid, $volname) = PVE::Storage::parse_volume_id($drive->{file});
5364990d
TL
6611 $storeid = $options->{storage} if defined ($options->{storage});
6612 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
9f3d73bc 6613 my $format = qemu_img_format($scfg, $volname); # has 'raw' fallback
d1e92cf6 6614
36d4bdcb 6615 $check_storage->($storeid, $scfg); # permission and content type check
9f8ba326 6616
9f3d73bc
DM
6617 $virtdev_hash->{$virtdev} = {
6618 format => $format,
5364990d 6619 storeid => $storeid,
9f3d73bc
DM
6620 size => PVE::QemuServer::Cloudinit::CLOUDINIT_DISK_SIZE,
6621 is_cloudinit => 1,
6622 };
d1e92cf6 6623 }
9f3d73bc
DM
6624 }
6625 }
d1e92cf6 6626
9f3d73bc
DM
6627 return $virtdev_hash;
6628};
d1e92cf6 6629
9f3d73bc
DM
6630# Helper to allocate and activate all volumes required for a restore
6631#
6632# $storecfg: Storage configuration
6633# $virtdev_hash: as returned by parse_backup_hints()
6634#
6635# Returns: { $virtdev => $volid }
6636my $restore_allocate_devices = sub {
6637 my ($storecfg, $virtdev_hash, $vmid) = @_;
d1e92cf6 6638
9f3d73bc
DM
6639 my $map = {};
6640 foreach my $virtdev (sort keys %$virtdev_hash) {
6641 my $d = $virtdev_hash->{$virtdev};
6642 my $alloc_size = int(($d->{size} + 1024 - 1)/1024);
6643 my $storeid = $d->{storeid};
6644 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
d1e92cf6 6645
9f3d73bc
DM
6646 # test if requested format is supported
6647 my ($defFormat, $validFormats) = PVE::Storage::storage_default_format($storecfg, $storeid);
6648 my $supported = grep { $_ eq $d->{format} } @$validFormats;
6649 $d->{format} = $defFormat if !$supported;
d1e92cf6 6650
9f3d73bc
DM
6651 my $name;
6652 if ($d->{is_cloudinit}) {
6653 $name = "vm-$vmid-cloudinit";
c997e24a
ML
6654 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
6655 if ($scfg->{path}) {
6656 $name .= ".$d->{format}";
6657 }
d1e92cf6
DM
6658 }
6659
4df98f2f
TL
6660 my $volid = PVE::Storage::vdisk_alloc(
6661 $storecfg, $storeid, $vmid, $d->{format}, $name, $alloc_size);
d1e92cf6 6662
9f3d73bc
DM
6663 print STDERR "new volume ID is '$volid'\n";
6664 $d->{volid} = $volid;
d1e92cf6 6665
9f3d73bc 6666 PVE::Storage::activate_volumes($storecfg, [$volid]);
d1e92cf6 6667
9f3d73bc 6668 $map->{$virtdev} = $volid;
d1e92cf6
DM
6669 }
6670
9f3d73bc
DM
6671 return $map;
6672};
d1e92cf6 6673
c62d7cf5 6674sub restore_update_config_line {
eabac302 6675 my ($cookie, $map, $line, $unique) = @_;
91bd6c90 6676
98a4b3fb
FE
6677 return '' if $line =~ m/^\#qmdump\#/;
6678 return '' if $line =~ m/^\#vzdump\#/;
6679 return '' if $line =~ m/^lock:/;
6680 return '' if $line =~ m/^unused\d+:/;
6681 return '' if $line =~ m/^parent:/;
6682
6683 my $res = '';
91bd6c90 6684
b5b99790 6685 my $dc = PVE::Cluster::cfs_read_file('datacenter.cfg');
91bd6c90
DM
6686 if (($line =~ m/^(vlan(\d+)):\s*(\S+)\s*$/)) {
6687 # try to convert old 1.X settings
6688 my ($id, $ind, $ethcfg) = ($1, $2, $3);
6689 foreach my $devconfig (PVE::Tools::split_list($ethcfg)) {
6690 my ($model, $macaddr) = split(/\=/, $devconfig);
b5b99790 6691 $macaddr = PVE::Tools::random_ether_addr($dc->{mac_prefix}) if !$macaddr || $unique;
91bd6c90
DM
6692 my $net = {
6693 model => $model,
6694 bridge => "vmbr$ind",
6695 macaddr => $macaddr,
6696 };
6697 my $netstr = print_net($net);
6698
98a4b3fb 6699 $res .= "net$cookie->{netcount}: $netstr\n";
91bd6c90
DM
6700 $cookie->{netcount}++;
6701 }
6702 } elsif (($line =~ m/^(net\d+):\s*(\S+)\s*$/) && $unique) {
6703 my ($id, $netstr) = ($1, $2);
6704 my $net = parse_net($netstr);
b5b99790 6705 $net->{macaddr} = PVE::Tools::random_ether_addr($dc->{mac_prefix}) if $net->{macaddr};
91bd6c90 6706 $netstr = print_net($net);
98a4b3fb 6707 $res .= "$id: $netstr\n";
f9dde219 6708 } elsif ($line =~ m/^((ide|scsi|virtio|sata|efidisk|tpmstate)\d+):\s*(\S+)\s*$/) {
91bd6c90 6709 my $virtdev = $1;
907ea891 6710 my $value = $3;
d9faf790
WB
6711 my $di = parse_drive($virtdev, $value);
6712 if (defined($di->{backup}) && !$di->{backup}) {
98a4b3fb 6713 $res .= "#$line";
c0f7406e 6714 } elsif ($map->{$virtdev}) {
8fd57431 6715 delete $di->{format}; # format can change on restore
91bd6c90 6716 $di->{file} = $map->{$virtdev};
71c58bb7 6717 $value = print_drive($di);
98a4b3fb 6718 $res .= "$virtdev: $value\n";
91bd6c90 6719 } else {
98a4b3fb 6720 $res .= $line;
91bd6c90 6721 }
1a0c2f03 6722 } elsif (($line =~ m/^vmgenid: (.*)/)) {
babecffe 6723 my $vmgenid = $1;
6ee499ff 6724 if ($vmgenid ne '0') {
1a0c2f03 6725 # always generate a new vmgenid if there was a valid one setup
6ee499ff
DC
6726 $vmgenid = generate_uuid();
6727 }
98a4b3fb 6728 $res .= "vmgenid: $vmgenid\n";
19a5dd55
WL
6729 } elsif (($line =~ m/^(smbios1: )(.*)/) && $unique) {
6730 my ($uuid, $uuid_str);
6731 UUID::generate($uuid);
6732 UUID::unparse($uuid, $uuid_str);
6733 my $smbios1 = parse_smbios1($2);
6734 $smbios1->{uuid} = $uuid_str;
98a4b3fb 6735 $res .= $1.print_smbios1($smbios1)."\n";
91bd6c90 6736 } else {
98a4b3fb 6737 $res .= $line;
91bd6c90 6738 }
98a4b3fb
FE
6739
6740 return $res;
c62d7cf5 6741}
9f3d73bc
DM
6742
6743my $restore_deactivate_volumes = sub {
e8b07b29 6744 my ($storecfg, $virtdev_hash) = @_;
9f3d73bc
DM
6745
6746 my $vollist = [];
e8b07b29
FE
6747 for my $dev (values $virtdev_hash->%*) {
6748 push $vollist->@*, $dev->{volid} if $dev->{volid};
9f3d73bc
DM
6749 }
6750
ff86112c
FE
6751 eval { PVE::Storage::deactivate_volumes($storecfg, $vollist); };
6752 print STDERR $@ if $@;
9f3d73bc
DM
6753};
6754
6755my $restore_destroy_volumes = sub {
e8b07b29 6756 my ($storecfg, $virtdev_hash) = @_;
9f3d73bc 6757
e8b07b29
FE
6758 for my $dev (values $virtdev_hash->%*) {
6759 my $volid = $dev->{volid} or next;
9f3d73bc 6760 eval {
e60afe82 6761 PVE::Storage::vdisk_free($storecfg, $volid);
9f3d73bc
DM
6762 print STDERR "temporary volume '$volid' sucessfuly removed\n";
6763 };
6764 print STDERR "unable to cleanup '$volid' - $@" if $@;
6765 }
6766};
91bd6c90 6767
202a2a0b
FE
6768my $restore_merge_config = sub {
6769 my ($filename, $backup_conf_raw, $override_conf) = @_;
6770
6771 my $backup_conf = parse_vm_config($filename, $backup_conf_raw);
6772 for my $key (keys $override_conf->%*) {
6773 $backup_conf->{$key} = $override_conf->{$key};
6774 }
6775
6776 return $backup_conf;
6777};
6778
91bd6c90 6779sub scan_volids {
9a8ba127 6780 my ($cfg, $vmid) = @_;
91bd6c90 6781
9a8ba127 6782 my $info = PVE::Storage::vdisk_list($cfg, undef, $vmid, undef, 'images');
91bd6c90
DM
6783
6784 my $volid_hash = {};
6785 foreach my $storeid (keys %$info) {
6786 foreach my $item (@{$info->{$storeid}}) {
6787 next if !($item->{volid} && $item->{size});
5996a936 6788 $item->{path} = PVE::Storage::path($cfg, $item->{volid});
91bd6c90
DM
6789 $volid_hash->{$item->{volid}} = $item;
6790 }
6791 }
6792
6793 return $volid_hash;
6794}
6795
68b108ee 6796sub update_disk_config {
91bd6c90 6797 my ($vmid, $conf, $volid_hash) = @_;
be190583 6798
91bd6c90 6799 my $changes;
9b29cbd0 6800 my $prefix = "VM $vmid";
91bd6c90 6801
c449137a
DC
6802 # used and unused disks
6803 my $referenced = {};
91bd6c90 6804
5996a936
DM
6805 # Note: it is allowed to define multiple storages with same path (alias), so
6806 # we need to check both 'volid' and real 'path' (two different volid can point
6807 # to the same path).
6808
c449137a 6809 my $referencedpath = {};
be190583 6810
91bd6c90 6811 # update size info
0c4fef3f 6812 PVE::QemuConfig->foreach_volume($conf, sub {
ca04977c 6813 my ($opt, $drive) = @_;
91bd6c90 6814
ca04977c
FE
6815 my $volid = $drive->{file};
6816 return if !$volid;
4df98f2f 6817 my $volume = $volid_hash->{$volid};
91bd6c90 6818
ca04977c
FE
6819 # mark volid as "in-use" for next step
6820 $referenced->{$volid} = 1;
4df98f2f 6821 if ($volume && (my $path = $volume->{path})) {
ca04977c 6822 $referencedpath->{$path} = 1;
91bd6c90 6823 }
ca04977c
FE
6824
6825 return if drive_is_cdrom($drive);
4df98f2f 6826 return if !$volume;
ca04977c 6827
4df98f2f 6828 my ($updated, $msg) = PVE::QemuServer::Drive::update_disksize($drive, $volume->{size});
ca04977c
FE
6829 if (defined($updated)) {
6830 $changes = 1;
6831 $conf->{$opt} = print_drive($updated);
9b29cbd0 6832 print "$prefix ($opt): $msg\n";
ca04977c
FE
6833 }
6834 });
91bd6c90 6835
5996a936 6836 # remove 'unusedX' entry if volume is used
ca04977c
FE
6837 PVE::QemuConfig->foreach_unused_volume($conf, sub {
6838 my ($opt, $drive) = @_;
6839
6840 my $volid = $drive->{file};
6841 return if !$volid;
6842
f7d1505b
TL
6843 my $path;
6844 $path = $volid_hash->{$volid}->{path} if $volid_hash->{$volid};
c449137a 6845 if ($referenced->{$volid} || ($path && $referencedpath->{$path})) {
68b108ee 6846 print "$prefix remove entry '$opt', its volume '$volid' is in use\n";
5996a936
DM
6847 $changes = 1;
6848 delete $conf->{$opt};
6849 }
c449137a
DC
6850
6851 $referenced->{$volid} = 1;
6852 $referencedpath->{$path} = 1 if $path;
ca04977c 6853 });
5996a936 6854
91bd6c90
DM
6855 foreach my $volid (sort keys %$volid_hash) {
6856 next if $volid =~ m/vm-$vmid-state-/;
c449137a 6857 next if $referenced->{$volid};
5996a936
DM
6858 my $path = $volid_hash->{$volid}->{path};
6859 next if !$path; # just to be sure
c449137a 6860 next if $referencedpath->{$path};
91bd6c90 6861 $changes = 1;
53b81297 6862 my $key = PVE::QemuConfig->add_unused_volume($conf, $volid);
68b108ee 6863 print "$prefix add unreferenced volume '$volid' as '$key' to config\n";
c449137a 6864 $referencedpath->{$path} = 1; # avoid to add more than once (aliases)
91bd6c90
DM
6865 }
6866
6867 return $changes;
6868}
6869
6870sub rescan {
9224dcee 6871 my ($vmid, $nolock, $dryrun) = @_;
91bd6c90 6872
20519efc 6873 my $cfg = PVE::Storage::config();
91bd6c90 6874
53b81297 6875 print "rescan volumes...\n";
9a8ba127 6876 my $volid_hash = scan_volids($cfg, $vmid);
91bd6c90
DM
6877
6878 my $updatefn = sub {
6879 my ($vmid) = @_;
6880
ffda963f 6881 my $conf = PVE::QemuConfig->load_config($vmid);
be190583 6882
ffda963f 6883 PVE::QemuConfig->check_lock($conf);
91bd6c90 6884
03da3f0d
DM
6885 my $vm_volids = {};
6886 foreach my $volid (keys %$volid_hash) {
6887 my $info = $volid_hash->{$volid};
6888 $vm_volids->{$volid} = $info if $info->{vmid} && $info->{vmid} == $vmid;
6889 }
6890
68b108ee 6891 my $changes = update_disk_config($vmid, $conf, $vm_volids);
91bd6c90 6892
9224dcee 6893 PVE::QemuConfig->write_config($vmid, $conf) if $changes && !$dryrun;
91bd6c90
DM
6894 };
6895
6896 if (defined($vmid)) {
6897 if ($nolock) {
6898 &$updatefn($vmid);
6899 } else {
ffda963f 6900 PVE::QemuConfig->lock_config($vmid, $updatefn, $vmid);
91bd6c90
DM
6901 }
6902 } else {
6903 my $vmlist = config_list();
6904 foreach my $vmid (keys %$vmlist) {
6905 if ($nolock) {
6906 &$updatefn($vmid);
6907 } else {
ffda963f 6908 PVE::QemuConfig->lock_config($vmid, $updatefn, $vmid);
be190583 6909 }
91bd6c90
DM
6910 }
6911 }
6912}
6913
9f3d73bc
DM
6914sub restore_proxmox_backup_archive {
6915 my ($archive, $vmid, $user, $options) = @_;
6916
6917 my $storecfg = PVE::Storage::config();
6918
6919 my ($storeid, $volname) = PVE::Storage::parse_volume_id($archive);
6920 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
6921
9f3d73bc 6922 my $fingerprint = $scfg->{fingerprint};
503e96f8 6923 my $keyfile = PVE::Storage::PBSPlugin::pbs_encryption_key_file_name($storecfg, $storeid);
9f3d73bc 6924
fbec3f89 6925 my $repo = PVE::PBSClient::get_repository($scfg);
2dda626d 6926 my $namespace = $scfg->{namespace};
dea4b04c 6927
26731a3c 6928 # This is only used for `pbs-restore` and the QEMU PBS driver (live-restore)
9f3d73bc
DM
6929 my $password = PVE::Storage::PBSPlugin::pbs_get_password($scfg, $storeid);
6930 local $ENV{PBS_PASSWORD} = $password;
6931 local $ENV{PBS_FINGERPRINT} = $fingerprint if defined($fingerprint);
6932
6933 my ($vtype, $pbs_backup_name, undef, undef, undef, undef, $format) =
6934 PVE::Storage::parse_volname($storecfg, $archive);
6935
6936 die "got unexpected vtype '$vtype'\n" if $vtype ne 'backup';
6937
6938 die "got unexpected backup format '$format'\n" if $format ne 'pbs-vm';
6939
6940 my $tmpdir = "/var/tmp/vzdumptmp$$";
6941 rmtree $tmpdir;
6942 mkpath $tmpdir;
6943
6944 my $conffile = PVE::QemuConfig->config_file($vmid);
9f3d73bc
DM
6945 # disable interrupts (always do cleanups)
6946 local $SIG{INT} =
6947 local $SIG{TERM} =
6948 local $SIG{QUIT} =
6949 local $SIG{HUP} = sub { print STDERR "got interrupt - ignored\n"; };
6950
6951 # Note: $oldconf is undef if VM does not exists
6952 my $cfs_path = PVE::QemuConfig->cfs_config_path($vmid);
6953 my $oldconf = PVE::Cluster::cfs_read_file($cfs_path);
98a4b3fb 6954 my $new_conf_raw = '';
9f3d73bc
DM
6955
6956 my $rpcenv = PVE::RPCEnvironment::get();
e8b07b29
FE
6957 my $devinfo = {}; # info about drives included in backup
6958 my $virtdev_hash = {}; # info about allocated drives
9f3d73bc
DM
6959
6960 eval {
6961 # enable interrupts
6962 local $SIG{INT} =
6963 local $SIG{TERM} =
6964 local $SIG{QUIT} =
6965 local $SIG{HUP} =
6966 local $SIG{PIPE} = sub { die "interrupted by signal\n"; };
6967
6968 my $cfgfn = "$tmpdir/qemu-server.conf";
6969 my $firewall_config_fn = "$tmpdir/fw.conf";
6970 my $index_fn = "$tmpdir/index.json";
6971
6972 my $cmd = "restore";
6973
6974 my $param = [$pbs_backup_name, "index.json", $index_fn];
6975 PVE::Storage::PBSPlugin::run_raw_client_cmd($scfg, $storeid, $cmd, $param);
6976 my $index = PVE::Tools::file_get_contents($index_fn);
6977 $index = decode_json($index);
6978
9f3d73bc
DM
6979 foreach my $info (@{$index->{files}}) {
6980 if ($info->{filename} =~ m/^(drive-\S+).img.fidx$/) {
6981 my $devname = $1;
6982 if ($info->{size} =~ m/^(\d+)$/) { # untaint size
6983 $devinfo->{$devname}->{size} = $1;
6984 } else {
6985 die "unable to parse file size in 'index.json' - got '$info->{size}'\n";
6986 }
6987 }
6988 }
6989
4df98f2f
TL
6990 my $is_qemu_server_backup = scalar(
6991 grep { $_->{filename} eq 'qemu-server.conf.blob' } @{$index->{files}}
6992 );
9f3d73bc
DM
6993 if (!$is_qemu_server_backup) {
6994 die "backup does not look like a qemu-server backup (missing 'qemu-server.conf' file)\n";
6995 }
6996 my $has_firewall_config = scalar(grep { $_->{filename} eq 'fw.conf.blob' } @{$index->{files}});
6997
6998 $param = [$pbs_backup_name, "qemu-server.conf", $cfgfn];
6999 PVE::Storage::PBSPlugin::run_raw_client_cmd($scfg, $storeid, $cmd, $param);
7000
7001 if ($has_firewall_config) {
7002 $param = [$pbs_backup_name, "fw.conf", $firewall_config_fn];
7003 PVE::Storage::PBSPlugin::run_raw_client_cmd($scfg, $storeid, $cmd, $param);
7004
7005 my $pve_firewall_dir = '/etc/pve/firewall';
7006 mkdir $pve_firewall_dir; # make sure the dir exists
7007 PVE::Tools::file_copy($firewall_config_fn, "${pve_firewall_dir}/$vmid.fw");
7008 }
7009
7010 my $fh = IO::File->new($cfgfn, "r") ||
a1cbe55c 7011 die "unable to read qemu-server.conf - $!\n";
9f3d73bc 7012
e8b07b29 7013 $virtdev_hash = $parse_backup_hints->($rpcenv, $user, $storecfg, $fh, $devinfo, $options);
9f3d73bc
DM
7014
7015 # fixme: rate limit?
7016
7017 # create empty/temp config
7018 PVE::Tools::file_set_contents($conffile, "memory: 128\nlock: create");
7019
7020 $restore_cleanup_oldconf->($storecfg, $vmid, $oldconf, $virtdev_hash) if $oldconf;
7021
7022 # allocate volumes
7023 my $map = $restore_allocate_devices->($storecfg, $virtdev_hash, $vmid);
7024
6f94e162
SR
7025 foreach my $virtdev (sort keys %$virtdev_hash) {
7026 my $d = $virtdev_hash->{$virtdev};
7027 next if $d->{is_cloudinit}; # no need to restore cloudinit
9f3d73bc 7028
55c7f9cf 7029 # this fails if storage is unavailable
6f94e162 7030 my $volid = $d->{volid};
6f94e162 7031 my $path = PVE::Storage::path($storecfg, $volid);
9f3d73bc 7032
f9dde219
SR
7033 # for live-restore we only want to preload the efidisk and TPM state
7034 next if $options->{live} && $virtdev ne 'efidisk0' && $virtdev ne 'tpmstate0';
55c7f9cf 7035
21a9ec2a
WB
7036 my @ns_arg;
7037 if (defined(my $ns = $scfg->{namespace})) {
7038 @ns_arg = ('--ns', $ns);
7039 }
7040
6f94e162
SR
7041 my $pbs_restore_cmd = [
7042 '/usr/bin/pbs-restore',
7043 '--repository', $repo,
21a9ec2a 7044 @ns_arg,
6f94e162
SR
7045 $pbs_backup_name,
7046 "$d->{devname}.img.fidx",
7047 $path,
7048 '--verbose',
7049 ];
55fb78aa 7050
6f94e162
SR
7051 push @$pbs_restore_cmd, '--format', $d->{format} if $d->{format};
7052 push @$pbs_restore_cmd, '--keyfile', $keyfile if -e $keyfile;
9f3d73bc 7053
6f94e162
SR
7054 if (PVE::Storage::volume_has_feature($storecfg, 'sparseinit', $volid)) {
7055 push @$pbs_restore_cmd, '--skip-zero';
26731a3c 7056 }
6f94e162
SR
7057
7058 my $dbg_cmdstring = PVE::Tools::cmd2string($pbs_restore_cmd);
7059 print "restore proxmox backup image: $dbg_cmdstring\n";
7060 run_command($pbs_restore_cmd);
9f3d73bc
DM
7061 }
7062
7063 $fh->seek(0, 0) || die "seek failed - $!\n";
7064
9f3d73bc
DM
7065 my $cookie = { netcount => 0 };
7066 while (defined(my $line = <$fh>)) {
c62d7cf5 7067 $new_conf_raw .= restore_update_config_line(
98a4b3fb 7068 $cookie,
98a4b3fb
FE
7069 $map,
7070 $line,
7071 $options->{unique},
7072 );
9f3d73bc
DM
7073 }
7074
7075 $fh->close();
9f3d73bc
DM
7076 };
7077 my $err = $@;
7078
26731a3c 7079 if ($err || !$options->{live}) {
e8b07b29 7080 $restore_deactivate_volumes->($storecfg, $virtdev_hash);
26731a3c 7081 }
9f3d73bc
DM
7082
7083 rmtree $tmpdir;
7084
7085 if ($err) {
e8b07b29 7086 $restore_destroy_volumes->($storecfg, $virtdev_hash);
9f3d73bc
DM
7087 die $err;
7088 }
7089
f7551170
SR
7090 if ($options->{live}) {
7091 # keep lock during live-restore
7092 $new_conf_raw .= "\nlock: create";
7093 }
7094
202a2a0b
FE
7095 my $new_conf = $restore_merge_config->($conffile, $new_conf_raw, $options->{override_conf});
7096 PVE::QemuConfig->write_config($vmid, $new_conf);
9f3d73bc
DM
7097
7098 eval { rescan($vmid, 1); };
7099 warn $@ if $@;
26731a3c
SR
7100
7101 PVE::AccessControl::add_vm_to_pool($vmid, $options->{pool}) if $options->{pool};
7102
7103 if ($options->{live}) {
fefd65a1
SR
7104 # enable interrupts
7105 local $SIG{INT} =
7106 local $SIG{TERM} =
7107 local $SIG{QUIT} =
7108 local $SIG{HUP} =
7109 local $SIG{PIPE} = sub { die "got signal ($!) - abort\n"; };
26731a3c 7110
fefd65a1
SR
7111 my $conf = PVE::QemuConfig->load_config($vmid);
7112 die "cannot do live-restore for template\n" if PVE::QemuConfig->is_template($conf);
26731a3c 7113
f9dde219
SR
7114 # these special drives are already restored before start
7115 delete $devinfo->{'drive-efidisk0'};
7116 delete $devinfo->{'drive-tpmstate0-backup'};
2dda626d
DC
7117
7118 my $pbs_opts = {
7119 repo => $repo,
7120 keyfile => $keyfile,
7121 snapshot => $pbs_backup_name,
7122 namespace => $namespace,
7123 };
7124 pbs_live_restore($vmid, $conf, $storecfg, $devinfo, $pbs_opts);
f7551170
SR
7125
7126 PVE::QemuConfig->remove_lock($vmid, "create");
26731a3c
SR
7127 }
7128}
7129
7130sub pbs_live_restore {
2dda626d 7131 my ($vmid, $conf, $storecfg, $restored_disks, $opts) = @_;
26731a3c 7132
88cabb62 7133 print "starting VM for live-restore\n";
2dda626d 7134 print "repository: '$opts->{repo}', snapshot: '$opts->{snapshot}'\n";
26731a3c
SR
7135
7136 my $pbs_backing = {};
8986e36e 7137 for my $ds (keys %$restored_disks) {
26731a3c 7138 $ds =~ m/^drive-(.*)$/;
88cabb62
SR
7139 my $confname = $1;
7140 $pbs_backing->{$confname} = {
2dda626d
DC
7141 repository => $opts->{repo},
7142 snapshot => $opts->{snapshot},
26731a3c
SR
7143 archive => "$ds.img.fidx",
7144 };
2dda626d
DC
7145 $pbs_backing->{$confname}->{keyfile} = $opts->{keyfile} if -e $opts->{keyfile};
7146 $pbs_backing->{$confname}->{namespace} = $opts->{namespace} if defined($opts->{namespace});
88cabb62
SR
7147
7148 my $drive = parse_drive($confname, $conf->{$confname});
7149 print "restoring '$ds' to '$drive->{file}'\n";
26731a3c
SR
7150 }
7151
fd70c843 7152 my $drives_streamed = 0;
26731a3c
SR
7153 eval {
7154 # make sure HA doesn't interrupt our restore by stopping the VM
7155 if (PVE::HA::Config::vm_is_ha_managed($vmid)) {
fd70c843 7156 run_command(['ha-manager', 'set', "vm:$vmid", '--state', 'started']);
26731a3c
SR
7157 }
7158
fd70c843
TL
7159 # start VM with backing chain pointing to PBS backup, environment vars for PBS driver
7160 # in QEMU (PBS_PASSWORD and PBS_FINGERPRINT) are already set by our caller
bfb12678 7161 vm_start_nolock($storecfg, $vmid, $conf, {paused => 1, 'pbs-backing' => $pbs_backing}, {});
26731a3c 7162
26697640
SR
7163 my $qmeventd_fd = register_qmeventd_handle($vmid);
7164
26731a3c
SR
7165 # begin streaming, i.e. data copy from PBS to target disk for every vol,
7166 # this will effectively collapse the backing image chain consisting of
7167 # [target <- alloc-track -> PBS snapshot] to just [target] (alloc-track
7168 # removes itself once all backing images vanish with 'auto-remove=on')
7169 my $jobs = {};
8986e36e 7170 for my $ds (sort keys %$restored_disks) {
26731a3c
SR
7171 my $job_id = "restore-$ds";
7172 mon_cmd($vmid, 'block-stream',
7173 'job-id' => $job_id,
7174 device => "$ds",
7175 );
7176 $jobs->{$job_id} = {};
7177 }
7178
7179 mon_cmd($vmid, 'cont');
7180 qemu_drive_mirror_monitor($vmid, undef, $jobs, 'auto', 0, 'stream');
7181
a09b39f1
TL
7182 print "restore-drive jobs finished successfully, removing all tracking block devices"
7183 ." to disconnect from Proxmox Backup Server\n";
7184
8986e36e 7185 for my $ds (sort keys %$restored_disks) {
26731a3c
SR
7186 mon_cmd($vmid, 'blockdev-del', 'node-name' => "$ds-pbs");
7187 }
26697640
SR
7188
7189 close($qmeventd_fd);
26731a3c
SR
7190 };
7191
7192 my $err = $@;
7193
7194 if ($err) {
8b8893c3 7195 warn "An error occurred during live-restore: $err\n";
26731a3c
SR
7196 _do_vm_stop($storecfg, $vmid, 1, 1, 10, 0, 1);
7197 die "live-restore failed\n";
7198 }
9f3d73bc
DM
7199}
7200
91bd6c90
DM
7201sub restore_vma_archive {
7202 my ($archive, $vmid, $user, $opts, $comp) = @_;
7203
91bd6c90
DM
7204 my $readfrom = $archive;
7205
7c536e11
WB
7206 my $cfg = PVE::Storage::config();
7207 my $commands = [];
7208 my $bwlimit = $opts->{bwlimit};
7209
7210 my $dbg_cmdstring = '';
7211 my $add_pipe = sub {
7212 my ($cmd) = @_;
7213 push @$commands, $cmd;
7214 $dbg_cmdstring .= ' | ' if length($dbg_cmdstring);
7215 $dbg_cmdstring .= PVE::Tools::cmd2string($cmd);
91bd6c90 7216 $readfrom = '-';
7c536e11
WB
7217 };
7218
7219 my $input = undef;
7220 if ($archive eq '-') {
7221 $input = '<&STDIN';
7222 } else {
7223 # If we use a backup from a PVE defined storage we also consider that
7224 # storage's rate limit:
7225 my (undef, $volid) = PVE::Storage::path_to_volume_id($cfg, $archive);
7226 if (defined($volid)) {
7227 my ($sid, undef) = PVE::Storage::parse_volume_id($volid);
7228 my $readlimit = PVE::Storage::get_bandwidth_limit('restore', [$sid], $bwlimit);
7229 if ($readlimit) {
7230 print STDERR "applying read rate limit: $readlimit\n";
9444c6e4 7231 my $cstream = ['cstream', '-t', $readlimit*1024, '--', $readfrom];
7c536e11
WB
7232 $add_pipe->($cstream);
7233 }
7234 }
7235 }
7236
7237 if ($comp) {
c6d51783
AA
7238 my $info = PVE::Storage::decompressor_info('vma', $comp);
7239 my $cmd = $info->{decompressor};
7240 push @$cmd, $readfrom;
7c536e11 7241 $add_pipe->($cmd);
91bd6c90
DM
7242 }
7243
7244 my $tmpdir = "/var/tmp/vzdumptmp$$";
7245 rmtree $tmpdir;
7246
7247 # disable interrupts (always do cleanups)
5b97ef24
TL
7248 local $SIG{INT} =
7249 local $SIG{TERM} =
7250 local $SIG{QUIT} =
7251 local $SIG{HUP} = sub { warn "got interrupt - ignored\n"; };
91bd6c90
DM
7252
7253 my $mapfifo = "/var/tmp/vzdumptmp$$.fifo";
7254 POSIX::mkfifo($mapfifo, 0600);
7255 my $fifofh;
808a65b5 7256 my $openfifo = sub { open($fifofh, '>', $mapfifo) or die $! };
91bd6c90 7257
7c536e11 7258 $add_pipe->(['vma', 'extract', '-v', '-r', $mapfifo, $readfrom, $tmpdir]);
91bd6c90
DM
7259
7260 my $oldtimeout;
7261 my $timeout = 5;
7262
e8b07b29
FE
7263 my $devinfo = {}; # info about drives included in backup
7264 my $virtdev_hash = {}; # info about allocated drives
91bd6c90
DM
7265
7266 my $rpcenv = PVE::RPCEnvironment::get();
7267
ffda963f 7268 my $conffile = PVE::QemuConfig->config_file($vmid);
91bd6c90 7269
ae200950 7270 # Note: $oldconf is undef if VM does not exist
ffda963f
FG
7271 my $cfs_path = PVE::QemuConfig->cfs_config_path($vmid);
7272 my $oldconf = PVE::Cluster::cfs_read_file($cfs_path);
98a4b3fb 7273 my $new_conf_raw = '';
ed221350 7274
7c536e11
WB
7275 my %storage_limits;
7276
91bd6c90 7277 my $print_devmap = sub {
91bd6c90
DM
7278 my $cfgfn = "$tmpdir/qemu-server.conf";
7279
7280 # we can read the config - that is already extracted
7281 my $fh = IO::File->new($cfgfn, "r") ||
a1cbe55c 7282 die "unable to read qemu-server.conf - $!\n";
91bd6c90 7283
6738ab9c 7284 my $fwcfgfn = "$tmpdir/qemu-server.fw";
3457d090
WL
7285 if (-f $fwcfgfn) {
7286 my $pve_firewall_dir = '/etc/pve/firewall';
7287 mkdir $pve_firewall_dir; # make sure the dir exists
7288 PVE::Tools::file_copy($fwcfgfn, "${pve_firewall_dir}/$vmid.fw");
7289 }
6738ab9c 7290
e8b07b29 7291 $virtdev_hash = $parse_backup_hints->($rpcenv, $user, $cfg, $fh, $devinfo, $opts);
91bd6c90 7292
c8964278
FE
7293 foreach my $info (values %{$virtdev_hash}) {
7294 my $storeid = $info->{storeid};
7295 next if defined($storage_limits{$storeid});
7296
7297 my $limit = PVE::Storage::get_bandwidth_limit('restore', [$storeid], $bwlimit) // 0;
7298 print STDERR "rate limit for storage $storeid: $limit KiB/s\n" if $limit;
7299 $storage_limits{$storeid} = $limit * 1024;
7c536e11
WB
7300 }
7301
91bd6c90 7302 foreach my $devname (keys %$devinfo) {
be190583
DM
7303 die "found no device mapping information for device '$devname'\n"
7304 if !$devinfo->{$devname}->{virtdev};
91bd6c90
DM
7305 }
7306
ed221350 7307 # create empty/temp config
be190583 7308 if ($oldconf) {
ed221350 7309 PVE::Tools::file_set_contents($conffile, "memory: 128\n");
d1e92cf6 7310 $restore_cleanup_oldconf->($cfg, $vmid, $oldconf, $virtdev_hash);
ed221350
DM
7311 }
7312
9f3d73bc
DM
7313 # allocate volumes
7314 my $map = $restore_allocate_devices->($cfg, $virtdev_hash, $vmid);
7315
7316 # print restore information to $fifofh
91bd6c90
DM
7317 foreach my $virtdev (sort keys %$virtdev_hash) {
7318 my $d = $virtdev_hash->{$virtdev};
9f3d73bc
DM
7319 next if $d->{is_cloudinit}; # no need to restore cloudinit
7320
7c536e11 7321 my $storeid = $d->{storeid};
9f3d73bc 7322 my $volid = $d->{volid};
7c536e11
WB
7323
7324 my $map_opts = '';
7325 if (my $limit = $storage_limits{$storeid}) {
7326 $map_opts .= "throttling.bps=$limit:throttling.group=$storeid:";
7327 }
8fd57431 7328
91bd6c90 7329 my $write_zeros = 1;
88240a83 7330 if (PVE::Storage::volume_has_feature($cfg, 'sparseinit', $volid)) {
91bd6c90
DM
7331 $write_zeros = 0;
7332 }
7333
9f3d73bc 7334 my $path = PVE::Storage::path($cfg, $volid);
87056e18 7335
9f3d73bc 7336 print $fifofh "${map_opts}format=$d->{format}:${write_zeros}:$d->{devname}=$path\n";
91bd6c90 7337
9f3d73bc 7338 print "map '$d->{devname}' to '$path' (write zeros = ${write_zeros})\n";
91bd6c90
DM
7339 }
7340
7341 $fh->seek(0, 0) || die "seek failed - $!\n";
7342
91bd6c90
DM
7343 my $cookie = { netcount => 0 };
7344 while (defined(my $line = <$fh>)) {
c62d7cf5 7345 $new_conf_raw .= restore_update_config_line(
98a4b3fb 7346 $cookie,
98a4b3fb
FE
7347 $map,
7348 $line,
7349 $opts->{unique},
7350 );
91bd6c90
DM
7351 }
7352
7353 $fh->close();
91bd6c90
DM
7354 };
7355
7356 eval {
7357 # enable interrupts
6cb0144a
EK
7358 local $SIG{INT} =
7359 local $SIG{TERM} =
7360 local $SIG{QUIT} =
7361 local $SIG{HUP} =
7362 local $SIG{PIPE} = sub { die "interrupted by signal\n"; };
91bd6c90
DM
7363 local $SIG{ALRM} = sub { die "got timeout\n"; };
7364
7365 $oldtimeout = alarm($timeout);
7366
7367 my $parser = sub {
7368 my $line = shift;
7369
7370 print "$line\n";
7371
7372 if ($line =~ m/^DEV:\sdev_id=(\d+)\ssize:\s(\d+)\sdevname:\s(\S+)$/) {
7373 my ($dev_id, $size, $devname) = ($1, $2, $3);
7374 $devinfo->{$devname} = { size => $size, dev_id => $dev_id };
7375 } elsif ($line =~ m/^CTIME: /) {
46f58b5f 7376 # we correctly received the vma config, so we can disable
3cf90d7a
DM
7377 # the timeout now for disk allocation (set to 10 minutes, so
7378 # that we always timeout if something goes wrong)
7379 alarm(600);
91bd6c90
DM
7380 &$print_devmap();
7381 print $fifofh "done\n";
7382 my $tmp = $oldtimeout || 0;
7383 $oldtimeout = undef;
7384 alarm($tmp);
7385 close($fifofh);
808a65b5 7386 $fifofh = undef;
91bd6c90
DM
7387 }
7388 };
be190583 7389
7c536e11
WB
7390 print "restore vma archive: $dbg_cmdstring\n";
7391 run_command($commands, input => $input, outfunc => $parser, afterfork => $openfifo);
91bd6c90
DM
7392 };
7393 my $err = $@;
7394
7395 alarm($oldtimeout) if $oldtimeout;
7396
e8b07b29 7397 $restore_deactivate_volumes->($cfg, $virtdev_hash);
5f96f4df 7398
808a65b5 7399 close($fifofh) if $fifofh;
91bd6c90 7400 unlink $mapfifo;
9f3d73bc 7401 rmtree $tmpdir;
91bd6c90
DM
7402
7403 if ($err) {
e8b07b29 7404 $restore_destroy_volumes->($cfg, $virtdev_hash);
91bd6c90
DM
7405 die $err;
7406 }
7407
202a2a0b
FE
7408 my $new_conf = $restore_merge_config->($conffile, $new_conf_raw, $opts->{override_conf});
7409 PVE::QemuConfig->write_config($vmid, $new_conf);
ed221350 7410
91bd6c90
DM
7411 eval { rescan($vmid, 1); };
7412 warn $@ if $@;
26731a3c
SR
7413
7414 PVE::AccessControl::add_vm_to_pool($vmid, $opts->{pool}) if $opts->{pool};
91bd6c90
DM
7415}
7416
7417sub restore_tar_archive {
7418 my ($archive, $vmid, $user, $opts) = @_;
7419
202a2a0b
FE
7420 if (scalar(keys $opts->{override_conf}->%*) > 0) {
7421 my $keystring = join(' ', keys $opts->{override_conf}->%*);
7422 die "cannot pass along options ($keystring) when restoring from tar archive\n";
7423 }
7424
9c502e26 7425 if ($archive ne '-') {
ed221350 7426 my $firstfile = tar_archive_read_firstfile($archive);
32e54050 7427 die "ERROR: file '$archive' does not look like a QemuServer vzdump backup\n"
9c502e26
DM
7428 if $firstfile ne 'qemu-server.conf';
7429 }
3e16d5fc 7430
20519efc 7431 my $storecfg = PVE::Storage::config();
ebb55558 7432
4b026937
TL
7433 # avoid zombie disks when restoring over an existing VM -> cleanup first
7434 # pass keep_empty_config=1 to keep the config (thus VMID) reserved for us
7435 # skiplock=1 because qmrestore has set the 'create' lock itself already
ffda963f 7436 my $vmcfgfn = PVE::QemuConfig->config_file($vmid);
b04ea584 7437 destroy_vm($storecfg, $vmid, 1, { lock => 'restore' }) if -f $vmcfgfn;
ed221350 7438
3e16d5fc
DM
7439 my $tocmd = "/usr/lib/qemu-server/qmextract";
7440
2415a446 7441 $tocmd .= " --storage " . PVE::Tools::shellquote($opts->{storage}) if $opts->{storage};
a0d1b1a2 7442 $tocmd .= " --pool " . PVE::Tools::shellquote($opts->{pool}) if $opts->{pool};
3e16d5fc
DM
7443 $tocmd .= ' --prealloc' if $opts->{prealloc};
7444 $tocmd .= ' --info' if $opts->{info};
7445
a0d1b1a2 7446 # tar option "xf" does not autodetect compression when read from STDIN,
9c502e26 7447 # so we pipe to zcat
2415a446
DM
7448 my $cmd = "zcat -f|tar xf " . PVE::Tools::shellquote($archive) . " " .
7449 PVE::Tools::shellquote("--to-command=$tocmd");
3e16d5fc
DM
7450
7451 my $tmpdir = "/var/tmp/vzdumptmp$$";
7452 mkpath $tmpdir;
7453
7454 local $ENV{VZDUMP_TMPDIR} = $tmpdir;
7455 local $ENV{VZDUMP_VMID} = $vmid;
a0d1b1a2 7456 local $ENV{VZDUMP_USER} = $user;
3e16d5fc 7457
ffda963f 7458 my $conffile = PVE::QemuConfig->config_file($vmid);
98a4b3fb 7459 my $new_conf_raw = '';
3e16d5fc
DM
7460
7461 # disable interrupts (always do cleanups)
6cb0144a
EK
7462 local $SIG{INT} =
7463 local $SIG{TERM} =
7464 local $SIG{QUIT} =
7465 local $SIG{HUP} = sub { print STDERR "got interrupt - ignored\n"; };
3e16d5fc 7466
afdb31d5 7467 eval {
3e16d5fc 7468 # enable interrupts
6cb0144a
EK
7469 local $SIG{INT} =
7470 local $SIG{TERM} =
7471 local $SIG{QUIT} =
7472 local $SIG{HUP} =
7473 local $SIG{PIPE} = sub { die "interrupted by signal\n"; };
3e16d5fc 7474
9c502e26
DM
7475 if ($archive eq '-') {
7476 print "extracting archive from STDIN\n";
7477 run_command($cmd, input => "<&STDIN");
7478 } else {
7479 print "extracting archive '$archive'\n";
7480 run_command($cmd);
7481 }
3e16d5fc
DM
7482
7483 return if $opts->{info};
7484
7485 # read new mapping
7486 my $map = {};
7487 my $statfile = "$tmpdir/qmrestore.stat";
7488 if (my $fd = IO::File->new($statfile, "r")) {
7489 while (defined (my $line = <$fd>)) {
7490 if ($line =~ m/vzdump:([^\s:]*):(\S+)$/) {
7491 $map->{$1} = $2 if $1;
7492 } else {
7493 print STDERR "unable to parse line in statfile - $line\n";
7494 }
7495 }
7496 $fd->close();
7497 }
7498
7499 my $confsrc = "$tmpdir/qemu-server.conf";
7500
f7d1505b 7501 my $srcfd = IO::File->new($confsrc, "r") || die "unable to open file '$confsrc'\n";
3e16d5fc 7502
91bd6c90 7503 my $cookie = { netcount => 0 };
3e16d5fc 7504 while (defined (my $line = <$srcfd>)) {
c62d7cf5 7505 $new_conf_raw .= restore_update_config_line(
98a4b3fb 7506 $cookie,
98a4b3fb
FE
7507 $map,
7508 $line,
7509 $opts->{unique},
7510 );
3e16d5fc
DM
7511 }
7512
7513 $srcfd->close();
3e16d5fc 7514 };
7dc7f315 7515 if (my $err = $@) {
ed221350 7516 tar_restore_cleanup($storecfg, "$tmpdir/qmrestore.stat") if !$opts->{info};
3e16d5fc 7517 die $err;
afdb31d5 7518 }
3e16d5fc
DM
7519
7520 rmtree $tmpdir;
7521
98a4b3fb 7522 PVE::Tools::file_set_contents($conffile, $new_conf_raw);
91bd6c90 7523
ed221350
DM
7524 PVE::Cluster::cfs_update(); # make sure we read new file
7525
91bd6c90
DM
7526 eval { rescan($vmid, 1); };
7527 warn $@ if $@;
3e16d5fc
DM
7528};
7529
65a5ce88 7530sub foreach_storage_used_by_vm {
18bfb361
DM
7531 my ($conf, $func) = @_;
7532
7533 my $sidhash = {};
7534
912792e2 7535 PVE::QemuConfig->foreach_volume($conf, sub {
8ddbcf8b
FG
7536 my ($ds, $drive) = @_;
7537 return if drive_is_cdrom($drive);
18bfb361
DM
7538
7539 my $volid = $drive->{file};
7540
7541 my ($sid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
be190583 7542 $sidhash->{$sid} = $sid if $sid;
8ddbcf8b 7543 });
18bfb361
DM
7544
7545 foreach my $sid (sort keys %$sidhash) {
7546 &$func($sid);
7547 }
7548}
7549
6c9f59c1
TL
7550my $qemu_snap_storage = {
7551 rbd => 1,
7552};
e5eaa028 7553sub do_snapshots_with_qemu {
9d83932d
SR
7554 my ($storecfg, $volid, $deviceid) = @_;
7555
7556 return if $deviceid =~ m/tpmstate0/;
e5eaa028
WL
7557
7558 my $storage_name = PVE::Storage::parse_volume_id($volid);
8aa2ed7c 7559 my $scfg = $storecfg->{ids}->{$storage_name};
f7d1505b 7560 die "could not find storage '$storage_name'\n" if !defined($scfg);
e5eaa028 7561
8aa2ed7c 7562 if ($qemu_snap_storage->{$scfg->{type}} && !$scfg->{krbd}){
e5eaa028
WL
7563 return 1;
7564 }
7565
7566 if ($volid =~ m/\.(qcow2|qed)$/){
7567 return 1;
7568 }
7569
d1c1af4b 7570 return;
e5eaa028
WL
7571}
7572
4dcc780c 7573sub qga_check_running {
a4938c72 7574 my ($vmid, $nowarn) = @_;
4dcc780c 7575
0a13e08e 7576 eval { mon_cmd($vmid, "guest-ping", timeout => 3); };
4dcc780c 7577 if ($@) {
7bd9abd2 7578 warn "QEMU Guest Agent is not running - $@" if !$nowarn;
4dcc780c
WL
7579 return 0;
7580 }
7581 return 1;
7582}
7583
04a69bb4
AD
7584sub template_create {
7585 my ($vmid, $conf, $disk) = @_;
7586
04a69bb4 7587 my $storecfg = PVE::Storage::config();
04a69bb4 7588
912792e2 7589 PVE::QemuConfig->foreach_volume($conf, sub {
9cd07842
DM
7590 my ($ds, $drive) = @_;
7591
7592 return if drive_is_cdrom($drive);
7593 return if $disk && $ds ne $disk;
7594
7595 my $volid = $drive->{file};
bbd56097 7596 return if !PVE::Storage::volume_has_feature($storecfg, 'template', $volid);
9cd07842 7597
04a69bb4
AD
7598 my $voliddst = PVE::Storage::vdisk_create_base($storecfg, $volid);
7599 $drive->{file} = $voliddst;
71c58bb7 7600 $conf->{$ds} = print_drive($drive);
ffda963f 7601 PVE::QemuConfig->write_config($vmid, $conf);
04a69bb4 7602 });
04a69bb4
AD
7603}
7604
92bdc3f0
DC
7605sub convert_iscsi_path {
7606 my ($path) = @_;
7607
7608 if ($path =~ m|^iscsi://([^/]+)/([^/]+)/(.+)$|) {
7609 my $portal = $1;
7610 my $target = $2;
7611 my $lun = $3;
7612
7613 my $initiator_name = get_initiator_name();
7614
7615 return "file.driver=iscsi,file.transport=tcp,file.initiator-name=$initiator_name,".
7616 "file.portal=$portal,file.target=$target,file.lun=$lun,driver=raw";
7617 }
7618
7619 die "cannot convert iscsi path '$path', unkown format\n";
7620}
7621
5133de42 7622sub qemu_img_convert {
988e2714 7623 my ($src_volid, $dst_volid, $size, $snapname, $is_zero_initialized) = @_;
5133de42
AD
7624
7625 my $storecfg = PVE::Storage::config();
7626 my ($src_storeid, $src_volname) = PVE::Storage::parse_volume_id($src_volid, 1);
7627 my ($dst_storeid, $dst_volname) = PVE::Storage::parse_volume_id($dst_volid, 1);
7628
af1f1ec0 7629 die "destination '$dst_volid' is not a valid volid form qemu-img convert\n" if !$dst_storeid;
6bb91c17 7630
af1f1ec0
DC
7631 my $cachemode;
7632 my $src_path;
7633 my $src_is_iscsi = 0;
bdd1feef 7634 my $src_format;
6bb91c17 7635
af1f1ec0
DC
7636 if ($src_storeid) {
7637 PVE::Storage::activate_volumes($storecfg, [$src_volid], $snapname);
5133de42 7638 my $src_scfg = PVE::Storage::storage_config($storecfg, $src_storeid);
af1f1ec0
DC
7639 $src_format = qemu_img_format($src_scfg, $src_volname);
7640 $src_path = PVE::Storage::path($storecfg, $src_volid, $snapname);
7641 $src_is_iscsi = ($src_path =~ m|^iscsi://|);
7642 $cachemode = 'none' if $src_scfg->{type} eq 'zfspool';
a23d57d5 7643 } elsif (-f $src_volid || -b $src_volid) {
af1f1ec0 7644 $src_path = $src_volid;
e0fd2b2f 7645 if ($src_path =~ m/\.($PVE::QemuServer::Drive::QEMU_FORMAT_RE)$/) {
af1f1ec0
DC
7646 $src_format = $1;
7647 }
7648 }
5133de42 7649
af1f1ec0 7650 die "source '$src_volid' is not a valid volid nor path for qemu-img convert\n" if !$src_path;
5133de42 7651
af1f1ec0
DC
7652 my $dst_scfg = PVE::Storage::storage_config($storecfg, $dst_storeid);
7653 my $dst_format = qemu_img_format($dst_scfg, $dst_volname);
7654 my $dst_path = PVE::Storage::path($storecfg, $dst_volid);
7655 my $dst_is_iscsi = ($dst_path =~ m|^iscsi://|);
5133de42 7656
af1f1ec0
DC
7657 my $cmd = [];
7658 push @$cmd, '/usr/bin/qemu-img', 'convert', '-p', '-n';
bdd1feef
TL
7659 push @$cmd, '-l', "snapshot.name=$snapname"
7660 if $snapname && $src_format && $src_format eq "qcow2";
af1f1ec0
DC
7661 push @$cmd, '-t', 'none' if $dst_scfg->{type} eq 'zfspool';
7662 push @$cmd, '-T', $cachemode if defined($cachemode);
7663
7664 if ($src_is_iscsi) {
7665 push @$cmd, '--image-opts';
7666 $src_path = convert_iscsi_path($src_path);
bdd1feef 7667 } elsif ($src_format) {
af1f1ec0
DC
7668 push @$cmd, '-f', $src_format;
7669 }
92bdc3f0 7670
af1f1ec0
DC
7671 if ($dst_is_iscsi) {
7672 push @$cmd, '--target-image-opts';
7673 $dst_path = convert_iscsi_path($dst_path);
7674 } else {
7675 push @$cmd, '-O', $dst_format;
7676 }
92bdc3f0 7677
af1f1ec0 7678 push @$cmd, $src_path;
92bdc3f0 7679
af1f1ec0
DC
7680 if (!$dst_is_iscsi && $is_zero_initialized) {
7681 push @$cmd, "zeroinit:$dst_path";
7682 } else {
7683 push @$cmd, $dst_path;
7684 }
92bdc3f0 7685
af1f1ec0
DC
7686 my $parser = sub {
7687 my $line = shift;
7688 if($line =~ m/\((\S+)\/100\%\)/){
7689 my $percent = $1;
7690 my $transferred = int($size * $percent / 100);
b5e9d97b
TL
7691 my $total_h = render_bytes($size, 1);
7692 my $transferred_h = render_bytes($transferred, 1);
92bdc3f0 7693
6629f976 7694 print "transferred $transferred_h of $total_h ($percent%)\n";
988e2714 7695 }
5133de42 7696
af1f1ec0 7697 };
5133de42 7698
af1f1ec0
DC
7699 eval { run_command($cmd, timeout => undef, outfunc => $parser); };
7700 my $err = $@;
7701 die "copy failed: $err" if $err;
5133de42
AD
7702}
7703
7704sub qemu_img_format {
7705 my ($scfg, $volname) = @_;
7706
e0fd2b2f 7707 if ($scfg->{path} && $volname =~ m/\.($PVE::QemuServer::Drive::QEMU_FORMAT_RE)$/) {
5133de42 7708 return $1;
be190583 7709 } else {
5133de42 7710 return "raw";
5133de42
AD
7711 }
7712}
7713
cfad42af 7714sub qemu_drive_mirror {
bc6c8231 7715 my ($vmid, $drive, $dst_volid, $vmiddst, $is_zero_initialized, $jobs, $completion, $qga, $bwlimit, $src_bitmap) = @_;
cfad42af 7716
5a345967
AD
7717 $jobs = {} if !$jobs;
7718
7719 my $qemu_target;
7720 my $format;
35e4ab04 7721 $jobs->{"drive-$drive"} = {};
152fe752 7722
1e5143de 7723 if ($dst_volid =~ /^nbd:/) {
87955688 7724 $qemu_target = $dst_volid;
5a345967 7725 $format = "nbd";
5a345967 7726 } else {
5a345967
AD
7727 my $storecfg = PVE::Storage::config();
7728 my ($dst_storeid, $dst_volname) = PVE::Storage::parse_volume_id($dst_volid);
7729
7730 my $dst_scfg = PVE::Storage::storage_config($storecfg, $dst_storeid);
cfad42af 7731
5a345967 7732 $format = qemu_img_format($dst_scfg, $dst_volname);
21ccdb50 7733
5a345967 7734 my $dst_path = PVE::Storage::path($storecfg, $dst_volid);
21ccdb50 7735
5a345967
AD
7736 $qemu_target = $is_zero_initialized ? "zeroinit:$dst_path" : $dst_path;
7737 }
988e2714
WB
7738
7739 my $opts = { timeout => 10, device => "drive-$drive", mode => "existing", sync => "full", target => $qemu_target };
88383920
DM
7740 $opts->{format} = $format if $format;
7741
bc6c8231
FG
7742 if (defined($src_bitmap)) {
7743 $opts->{sync} = 'incremental';
7744 $opts->{bitmap} = $src_bitmap;
7745 print "drive mirror re-using dirty bitmap '$src_bitmap'\n";
7746 }
7747
9fa05d31 7748 if (defined($bwlimit)) {
f6409f61
TL
7749 $opts->{speed} = $bwlimit * 1024;
7750 print "drive mirror is starting for drive-$drive with bandwidth limit: ${bwlimit} KB/s\n";
9fa05d31
SI
7751 } else {
7752 print "drive mirror is starting for drive-$drive\n";
7753 }
21ccdb50 7754
6dde5ea2 7755 # if a job already runs for this device we get an error, catch it for cleanup
0a13e08e 7756 eval { mon_cmd($vmid, "drive-mirror", %$opts); };
5a345967
AD
7757 if (my $err = $@) {
7758 eval { PVE::QemuServer::qemu_blockjobs_cancel($vmid, $jobs) };
6dde5ea2
TL
7759 warn "$@\n" if $@;
7760 die "mirroring error: $err\n";
5a345967
AD
7761 }
7762
e02fb126 7763 qemu_drive_mirror_monitor ($vmid, $vmiddst, $jobs, $completion, $qga);
5a345967
AD
7764}
7765
db1f8b39
FG
7766# $completion can be either
7767# 'complete': wait until all jobs are ready, block-job-complete them (default)
7768# 'cancel': wait until all jobs are ready, block-job-cancel them
7769# 'skip': wait until all jobs are ready, return with block jobs in ready state
9e671722 7770# 'auto': wait until all jobs disappear, only use for jobs which complete automatically
5a345967 7771sub qemu_drive_mirror_monitor {
9e671722 7772 my ($vmid, $vmiddst, $jobs, $completion, $qga, $op) = @_;
e02fb126 7773
db1f8b39 7774 $completion //= 'complete';
9e671722 7775 $op //= "mirror";
2e953867 7776
08ac653f 7777 eval {
5a345967
AD
7778 my $err_complete = 0;
7779
3b56383b 7780 my $starttime = time ();
08ac653f 7781 while (1) {
9e671722 7782 die "block job ('$op') timed out\n" if $err_complete > 300;
5a345967 7783
0a13e08e 7784 my $stats = mon_cmd($vmid, "query-block-jobs");
3b56383b 7785 my $ctime = time();
08ac653f 7786
9e671722 7787 my $running_jobs = {};
0ea24bf0 7788 for my $stat (@$stats) {
9e671722
SR
7789 next if $stat->{type} ne $op;
7790 $running_jobs->{$stat->{device}} = $stat;
5a345967 7791 }
08ac653f 7792
5a345967 7793 my $readycounter = 0;
67fb9de6 7794
0ea24bf0 7795 for my $job_id (sort keys %$jobs) {
1057fc74 7796 my $job = $running_jobs->{$job_id};
5a345967 7797
1057fc74 7798 my $vanished = !defined($job);
0ea24bf0 7799 my $complete = defined($jobs->{$job_id}->{complete}) && $vanished;
9e671722 7800 if($complete || ($vanished && $completion eq 'auto')) {
3b56383b 7801 print "$job_id: $op-job finished\n";
0ea24bf0 7802 delete $jobs->{$job_id};
5a345967
AD
7803 next;
7804 }
7805
1057fc74 7806 die "$job_id: '$op' has been cancelled\n" if !defined($job);
f34ebd52 7807
1057fc74
TL
7808 my $busy = $job->{busy};
7809 my $ready = $job->{ready};
7810 if (my $total = $job->{len}) {
7811 my $transferred = $job->{offset} || 0;
5a345967
AD
7812 my $remaining = $total - $transferred;
7813 my $percent = sprintf "%.2f", ($transferred * 100 / $total);
08ac653f 7814
3b56383b
TL
7815 my $duration = $ctime - $starttime;
7816 my $total_h = render_bytes($total, 1);
7817 my $transferred_h = render_bytes($transferred, 1);
7818
7819 my $status = sprintf(
7820 "transferred $transferred_h of $total_h ($percent%%) in %s",
7821 render_duration($duration),
7822 );
7823
7824 if ($ready) {
7825 if ($busy) {
7826 $status .= ", still busy"; # shouldn't even happen? but mirror is weird
7827 } else {
7828 $status .= ", ready";
7829 }
7830 }
67daf692
TL
7831 print "$job_id: $status\n" if !$jobs->{$job_id}->{ready};
7832 $jobs->{$job_id}->{ready} = $ready;
5a345967 7833 }
f34ebd52 7834
1057fc74 7835 $readycounter++ if $job->{ready};
5a345967 7836 }
b467f79a 7837
5a345967
AD
7838 last if scalar(keys %$jobs) == 0;
7839
7840 if ($readycounter == scalar(keys %$jobs)) {
9e671722
SR
7841 print "all '$op' jobs are ready\n";
7842
7843 # do the complete later (or has already been done)
7844 last if $completion eq 'skip' || $completion eq 'auto';
5a345967
AD
7845
7846 if ($vmiddst && $vmiddst != $vmid) {
1a988fd2
DC
7847 my $agent_running = $qga && qga_check_running($vmid);
7848 if ($agent_running) {
5619e74a 7849 print "freeze filesystem\n";
0a13e08e 7850 eval { mon_cmd($vmid, "guest-fsfreeze-freeze"); };
d6cdfae4 7851 warn $@ if $@;
5619e74a
AD
7852 } else {
7853 print "suspend vm\n";
7854 eval { PVE::QemuServer::vm_suspend($vmid, 1); };
d6cdfae4 7855 warn $@ if $@;
5619e74a
AD
7856 }
7857
5a345967
AD
7858 # if we clone a disk for a new target vm, we don't switch the disk
7859 PVE::QemuServer::qemu_blockjobs_cancel($vmid, $jobs);
5619e74a 7860
1a988fd2 7861 if ($agent_running) {
5619e74a 7862 print "unfreeze filesystem\n";
0a13e08e 7863 eval { mon_cmd($vmid, "guest-fsfreeze-thaw"); };
d6cdfae4 7864 warn $@ if $@;
5619e74a
AD
7865 } else {
7866 print "resume vm\n";
d6cdfae4
FE
7867 eval { PVE::QemuServer::vm_resume($vmid, 1, 1); };
7868 warn $@ if $@;
5619e74a
AD
7869 }
7870
2e953867 7871 last;
5a345967
AD
7872 } else {
7873
0ea24bf0 7874 for my $job_id (sort keys %$jobs) {
5a345967 7875 # try to switch the disk if source and destination are on the same guest
0ea24bf0 7876 print "$job_id: Completing block job_id...\n";
5a345967 7877
e02fb126 7878 my $op;
db1f8b39 7879 if ($completion eq 'complete') {
e02fb126 7880 $op = 'block-job-complete';
db1f8b39 7881 } elsif ($completion eq 'cancel') {
e02fb126
ML
7882 $op = 'block-job-cancel';
7883 } else {
7884 die "invalid completion value: $completion\n";
7885 }
0ea24bf0 7886 eval { mon_cmd($vmid, $op, device => $job_id) };
5a345967 7887 if ($@ =~ m/cannot be completed/) {
3b56383b 7888 print "$job_id: block job cannot be completed, trying again.\n";
5a345967
AD
7889 $err_complete++;
7890 }else {
0ea24bf0
TL
7891 print "$job_id: Completed successfully.\n";
7892 $jobs->{$job_id}->{complete} = 1;
5a345967
AD
7893 }
7894 }
2e953867 7895 }
08ac653f 7896 }
08ac653f 7897 sleep 1;
cfad42af 7898 }
08ac653f 7899 };
88383920 7900 my $err = $@;
08ac653f 7901
88383920 7902 if ($err) {
5a345967 7903 eval { PVE::QemuServer::qemu_blockjobs_cancel($vmid, $jobs) };
3b56383b 7904 die "block job ($op) error: $err";
88383920 7905 }
5a345967
AD
7906}
7907
7908sub qemu_blockjobs_cancel {
7909 my ($vmid, $jobs) = @_;
7910
7911 foreach my $job (keys %$jobs) {
bd2d5fe6 7912 print "$job: Cancelling block job\n";
0a13e08e 7913 eval { mon_cmd($vmid, "block-job-cancel", device => $job); };
5a345967
AD
7914 $jobs->{$job}->{cancel} = 1;
7915 }
7916
7917 while (1) {
0a13e08e 7918 my $stats = mon_cmd($vmid, "query-block-jobs");
5a345967
AD
7919
7920 my $running_jobs = {};
7921 foreach my $stat (@$stats) {
7922 $running_jobs->{$stat->{device}} = $stat;
7923 }
7924
7925 foreach my $job (keys %$jobs) {
7926
bd2d5fe6
WB
7927 if (defined($jobs->{$job}->{cancel}) && !defined($running_jobs->{$job})) {
7928 print "$job: Done.\n";
5a345967
AD
7929 delete $jobs->{$job};
7930 }
7931 }
7932
7933 last if scalar(keys %$jobs) == 0;
7934
7935 sleep 1;
cfad42af
AD
7936 }
7937}
7938
152fe752 7939sub clone_disk {
1196086f
FE
7940 my ($storecfg, $source, $dest, $full, $newvollist, $jobs, $completion, $qga, $bwlimit) = @_;
7941
7942 my ($vmid, $running) = $source->@{qw(vmid running)};
25166060 7943 my ($src_drivename, $drive, $snapname) = $source->@{qw(drivename drive snapname)};
1196086f 7944
25166060 7945 my ($newvmid, $dst_drivename, $efisize) = $dest->@{qw(vmid drivename efisize)};
1196086f 7946 my ($storage, $format) = $dest->@{qw(storage format)};
152fe752 7947
5f957592
FE
7948 my $use_drive_mirror = $full && $running && $src_drivename && !$snapname;
7949
25166060
FE
7950 if ($src_drivename && $dst_drivename && $src_drivename ne $dst_drivename) {
7951 die "cloning from/to EFI disk requires EFI disk\n"
7952 if $src_drivename eq 'efidisk0' || $dst_drivename eq 'efidisk0';
7953 die "cloning from/to TPM state requires TPM state\n"
7954 if $src_drivename eq 'tpmstate0' || $dst_drivename eq 'tpmstate0';
5f957592
FE
7955
7956 # This would lead to two device nodes in QEMU pointing to the same backing image!
7957 die "cannot change drive name when cloning disk from/to the same VM\n"
7958 if $use_drive_mirror && $vmid == $newvmid;
25166060
FE
7959 }
7960
1d1f8f9a
FE
7961 die "cannot move TPM state while VM is running\n"
7962 if $use_drive_mirror && $src_drivename eq 'tpmstate0';
7963
152fe752
DM
7964 my $newvolid;
7965
25166060
FE
7966 print "create " . ($full ? 'full' : 'linked') . " clone of drive ";
7967 print "$src_drivename " if $src_drivename;
7968 print "($drive->{file})\n";
7969
152fe752 7970 if (!$full) {
258e646c 7971 $newvolid = PVE::Storage::vdisk_clone($storecfg, $drive->{file}, $newvmid, $snapname);
152fe752
DM
7972 push @$newvollist, $newvolid;
7973 } else {
5a345967 7974
152fe752
DM
7975 my ($storeid, $volname) = PVE::Storage::parse_volume_id($drive->{file});
7976 $storeid = $storage if $storage;
7977
44549149 7978 my $dst_format = resolve_dst_disk_format($storecfg, $storeid, $volname, $format);
152fe752 7979
931432bd 7980 my $name = undef;
d0abc774 7981 my $size = undef;
7fe8b44c
TL
7982 if (drive_is_cloudinit($drive)) {
7983 $name = "vm-$newvmid-cloudinit";
c997e24a
ML
7984 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
7985 if ($scfg->{path}) {
7986 $name .= ".$dst_format";
7987 }
7fe8b44c
TL
7988 $snapname = undef;
7989 $size = PVE::QemuServer::Cloudinit::CLOUDINIT_DISK_SIZE;
25166060 7990 } elsif ($dst_drivename eq 'efidisk0') {
7344af7b 7991 $size = $efisize or die "internal error - need to specify EFI disk size\n";
25166060 7992 } elsif ($dst_drivename eq 'tpmstate0') {
5f5aba25 7993 $dst_format = 'raw';
f9dde219 7994 $size = PVE::QemuServer::Drive::TPMSTATE_DISK_SIZE;
d0abc774 7995 } else {
3bae384f 7996 ($size) = PVE::Storage::volume_size_info($storecfg, $drive->{file}, 10);
7fe8b44c 7997 }
b5688f69
FE
7998 $newvolid = PVE::Storage::vdisk_alloc(
7999 $storecfg, $storeid, $newvmid, $dst_format, $name, ($size/1024)
8000 );
152fe752
DM
8001 push @$newvollist, $newvolid;
8002
3999f370 8003 PVE::Storage::activate_volumes($storecfg, [$newvolid]);
1dbd6d30 8004
7fe8b44c 8005 if (drive_is_cloudinit($drive)) {
1b485263
ML
8006 # when cloning multiple disks (e.g. during clone_vm) it might be the last disk
8007 # if this is the case, we have to complete any block-jobs still there from
8008 # previous drive-mirrors
8009 if (($completion eq 'complete') && (scalar(keys %$jobs) > 0)) {
8010 qemu_drive_mirror_monitor($vmid, $newvmid, $jobs, $completion, $qga);
8011 }
7fe8b44c
TL
8012 goto no_data_clone;
8013 }
8014
988e2714 8015 my $sparseinit = PVE::Storage::volume_has_feature($storecfg, 'sparseinit', $newvolid);
5f957592 8016 if ($use_drive_mirror) {
5f957592
FE
8017 qemu_drive_mirror($vmid, $src_drivename, $newvolid, $newvmid, $sparseinit, $jobs,
8018 $completion, $qga, $bwlimit);
8019 } else {
d189e590 8020 # TODO: handle bwlimits
25166060 8021 if ($dst_drivename eq 'efidisk0') {
818ce80e
DC
8022 # the relevant data on the efidisk may be smaller than the source
8023 # e.g. on RBD/ZFS, so we use dd to copy only the amount
8024 # that is given by the OVMF_VARS.fd
62375438 8025 my $src_path = PVE::Storage::path($storecfg, $drive->{file}, $snapname);
818ce80e 8026 my $dst_path = PVE::Storage::path($storecfg, $newvolid);
fdfdc80e 8027
62375438
FE
8028 my $src_format = (PVE::Storage::parse_volname($storecfg, $drive->{file}))[6];
8029
fdfdc80e
FE
8030 # better for Ceph if block size is not too small, see bug #3324
8031 my $bs = 1024*1024;
8032
62375438 8033 my $cmd = ['qemu-img', 'dd', '-n', '-O', $dst_format];
a9c45bd4
FE
8034
8035 if ($src_format eq 'qcow2' && $snapname) {
8036 die "cannot clone qcow2 EFI disk snapshot - requires QEMU >= 6.2\n"
8037 if !min_version(kvm_user_version(), 6, 2);
8038 push $cmd->@*, '-l', $snapname;
8039 }
62375438
FE
8040 push $cmd->@*, "bs=$bs", "osize=$size", "if=$src_path", "of=$dst_path";
8041 run_command($cmd);
818ce80e
DC
8042 } else {
8043 qemu_img_convert($drive->{file}, $newvolid, $size, $snapname, $sparseinit);
8044 }
be190583 8045 }
152fe752
DM
8046 }
8047
7fe8b44c 8048no_data_clone:
3bae384f 8049 my ($size) = eval { PVE::Storage::volume_size_info($storecfg, $newvolid, 10) };
152fe752 8050
3b53c471
FE
8051 my $disk = dclone($drive);
8052 delete $disk->{format};
152fe752 8053 $disk->{file} = $newvolid;
3bae384f 8054 $disk->{size} = $size if defined($size);
152fe752
DM
8055
8056 return $disk;
8057}
8058
98cfd8b6
AD
8059sub get_running_qemu_version {
8060 my ($vmid) = @_;
0a13e08e 8061 my $res = mon_cmd($vmid, "query-version");
98cfd8b6
AD
8062 return "$res->{qemu}->{major}.$res->{qemu}->{minor}";
8063}
8064
249c4a6c
AD
8065sub qemu_use_old_bios_files {
8066 my ($machine_type) = @_;
8067
8068 return if !$machine_type;
8069
8070 my $use_old_bios_files = undef;
8071
8072 if ($machine_type =~ m/^(\S+)\.pxe$/) {
8073 $machine_type = $1;
8074 $use_old_bios_files = 1;
8075 } else {
4df98f2f 8076 my $version = extract_version($machine_type, kvm_user_version());
249c4a6c
AD
8077 # Note: kvm version < 2.4 use non-efi pxe files, and have problems when we
8078 # load new efi bios files on migration. So this hack is required to allow
8079 # live migration from qemu-2.2 to qemu-2.4, which is sometimes used when
8080 # updrading from proxmox-ve-3.X to proxmox-ve 4.0
2ea5fb7e 8081 $use_old_bios_files = !min_version($version, 2, 4);
249c4a6c
AD
8082 }
8083
8084 return ($use_old_bios_files, $machine_type);
8085}
8086
818ce80e 8087sub get_efivars_size {
ff84f0e3
FE
8088 my ($conf, $efidisk) = @_;
8089
818ce80e 8090 my $arch = get_vm_arch($conf);
ff84f0e3 8091 $efidisk //= $conf->{efidisk0} ? parse_drive('efidisk0', $conf->{efidisk0}) : undef;
90b20b15
DC
8092 my $smm = PVE::QemuServer::Machine::machine_type_is_q35($conf);
8093 my (undef, $ovmf_vars) = get_ovmf_files($arch, $efidisk, $smm);
818ce80e
DC
8094 die "uefi vars image '$ovmf_vars' not found\n" if ! -f $ovmf_vars;
8095 return -s $ovmf_vars;
8096}
8097
8098sub update_efidisk_size {
8099 my ($conf) = @_;
8100
8101 return if !defined($conf->{efidisk0});
8102
8103 my $disk = PVE::QemuServer::parse_drive('efidisk0', $conf->{efidisk0});
8104 $disk->{size} = get_efivars_size($conf);
8105 $conf->{efidisk0} = print_drive($disk);
8106
8107 return;
8108}
8109
f9dde219
SR
8110sub update_tpmstate_size {
8111 my ($conf) = @_;
8112
8113 my $disk = PVE::QemuServer::parse_drive('tpmstate0', $conf->{tpmstate0});
8114 $disk->{size} = PVE::QemuServer::Drive::TPMSTATE_DISK_SIZE;
8115 $conf->{tpmstate0} = print_drive($disk);
8116}
8117
90b20b15
DC
8118sub create_efidisk($$$$$$$) {
8119 my ($storecfg, $storeid, $vmid, $fmt, $arch, $efidisk, $smm) = @_;
3e1f1122 8120
90b20b15 8121 my (undef, $ovmf_vars) = get_ovmf_files($arch, $efidisk, $smm);
96ed3574 8122 die "EFI vars default image not found\n" if ! -f $ovmf_vars;
3e1f1122 8123
af1f1ec0
DC
8124 my $vars_size_b = -s $ovmf_vars;
8125 my $vars_size = PVE::Tools::convert_size($vars_size_b, 'b' => 'kb');
3e1f1122
TL
8126 my $volid = PVE::Storage::vdisk_alloc($storecfg, $storeid, $vmid, $fmt, undef, $vars_size);
8127 PVE::Storage::activate_volumes($storecfg, [$volid]);
8128
af1f1ec0 8129 qemu_img_convert($ovmf_vars, $volid, $vars_size_b, undef, 0);
340dbcf7 8130 my ($size) = PVE::Storage::volume_size_info($storecfg, $volid, 3);
3e1f1122 8131
340dbcf7 8132 return ($volid, $size/1024);
3e1f1122
TL
8133}
8134
22de899a
AD
8135sub vm_iothreads_list {
8136 my ($vmid) = @_;
8137
0a13e08e 8138 my $res = mon_cmd($vmid, 'query-iothreads');
22de899a
AD
8139
8140 my $iothreads = {};
8141 foreach my $iothread (@$res) {
8142 $iothreads->{ $iothread->{id} } = $iothread->{"thread-id"};
8143 }
8144
8145 return $iothreads;
8146}
8147
ee034f5c
AD
8148sub scsihw_infos {
8149 my ($conf, $drive) = @_;
8150
8151 my $maxdev = 0;
8152
7fe1b688 8153 if (!$conf->{scsihw} || ($conf->{scsihw} =~ m/^lsi/)) {
ee034f5c 8154 $maxdev = 7;
a1511b3c 8155 } elsif ($conf->{scsihw} && ($conf->{scsihw} eq 'virtio-scsi-single')) {
ee034f5c
AD
8156 $maxdev = 1;
8157 } else {
8158 $maxdev = 256;
8159 }
8160
8161 my $controller = int($drive->{index} / $maxdev);
4df98f2f
TL
8162 my $controller_prefix = ($conf->{scsihw} && $conf->{scsihw} eq 'virtio-scsi-single')
8163 ? "virtioscsi"
8164 : "scsihw";
ee034f5c
AD
8165
8166 return ($maxdev, $controller, $controller_prefix);
8167}
a1511b3c 8168
44549149
EK
8169sub resolve_dst_disk_format {
8170 my ($storecfg, $storeid, $src_volname, $format) = @_;
8171 my ($defFormat, $validFormats) = PVE::Storage::storage_default_format($storecfg, $storeid);
8172
8173 if (!$format) {
8174 # if no target format is specified, use the source disk format as hint
8175 if ($src_volname) {
8176 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
8177 $format = qemu_img_format($scfg, $src_volname);
8178 } else {
8179 return $defFormat;
8180 }
8181 }
8182
8183 # test if requested format is supported - else use default
8184 my $supported = grep { $_ eq $format } @$validFormats;
8185 $format = $defFormat if !$supported;
8186 return $format;
8187}
8188
66cebc46
DC
8189# NOTE: if this logic changes, please update docs & possibly gui logic
8190sub find_vmstate_storage {
8191 my ($conf, $storecfg) = @_;
8192
8193 # first, return storage from conf if set
8194 return $conf->{vmstatestorage} if $conf->{vmstatestorage};
8195
8196 my ($target, $shared, $local);
8197
8198 foreach_storage_used_by_vm($conf, sub {
8199 my ($sid) = @_;
8200 my $scfg = PVE::Storage::storage_config($storecfg, $sid);
8201 my $dst = $scfg->{shared} ? \$shared : \$local;
8202 $$dst = $sid if !$$dst || $scfg->{path}; # prefer file based storage
8203 });
8204
8205 # second, use shared storage where VM has at least one disk
8206 # third, use local storage where VM has at least one disk
8207 # fall back to local storage
8208 $target = $shared // $local // 'local';
8209
8210 return $target;
8211}
8212
6ee499ff 8213sub generate_uuid {
ae2fcb3b
EK
8214 my ($uuid, $uuid_str);
8215 UUID::generate($uuid);
8216 UUID::unparse($uuid, $uuid_str);
6ee499ff
DC
8217 return $uuid_str;
8218}
8219
8220sub generate_smbios1_uuid {
8221 return "uuid=".generate_uuid();
ae2fcb3b
EK
8222}
8223
9c152e87
TL
8224sub nbd_stop {
8225 my ($vmid) = @_;
8226
0a13e08e 8227 mon_cmd($vmid, 'nbd-server-stop');
9c152e87
TL
8228}
8229
dae98db9
DC
8230sub create_reboot_request {
8231 my ($vmid) = @_;
8232 open(my $fh, '>', "/run/qemu-server/$vmid.reboot")
8233 or die "failed to create reboot trigger file: $!\n";
8234 close($fh);
8235}
8236
8237sub clear_reboot_request {
8238 my ($vmid) = @_;
8239 my $path = "/run/qemu-server/$vmid.reboot";
8240 my $res = 0;
8241
8242 $res = unlink($path);
8243 die "could not remove reboot request for $vmid: $!"
8244 if !$res && $! != POSIX::ENOENT;
8245
8246 return $res;
8247}
8248
5cfa9f5f
SR
8249sub bootorder_from_legacy {
8250 my ($conf, $bootcfg) = @_;
8251
8252 my $boot = $bootcfg->{legacy} || $boot_fmt->{legacy}->{default};
8253 my $bootindex_hash = {};
8254 my $i = 1;
8255 foreach my $o (split(//, $boot)) {
8256 $bootindex_hash->{$o} = $i*100;
8257 $i++;
8258 }
8259
8260 my $bootorder = {};
8261
8262 PVE::QemuConfig->foreach_volume($conf, sub {
8263 my ($ds, $drive) = @_;
8264
8265 if (drive_is_cdrom ($drive, 1)) {
8266 if ($bootindex_hash->{d}) {
8267 $bootorder->{$ds} = $bootindex_hash->{d};
8268 $bootindex_hash->{d} += 1;
8269 }
8270 } elsif ($bootindex_hash->{c}) {
8271 $bootorder->{$ds} = $bootindex_hash->{c}
8272 if $conf->{bootdisk} && $conf->{bootdisk} eq $ds;
8273 $bootindex_hash->{c} += 1;
8274 }
8275 });
8276
8277 if ($bootindex_hash->{n}) {
8278 for (my $i = 0; $i < $MAX_NETS; $i++) {
8279 my $netname = "net$i";
8280 next if !$conf->{$netname};
8281 $bootorder->{$netname} = $bootindex_hash->{n};
8282 $bootindex_hash->{n} += 1;
8283 }
8284 }
8285
8286 return $bootorder;
8287}
8288
8289# Generate default device list for 'boot: order=' property. Matches legacy
8290# default boot order, but with explicit device names. This is important, since
8291# the fallback for when neither 'order' nor the old format is specified relies
8292# on 'bootorder_from_legacy' above, and it would be confusing if this diverges.
8293sub get_default_bootdevices {
8294 my ($conf) = @_;
8295
8296 my @ret = ();
8297
8298 # harddisk
8299 my $first = PVE::QemuServer::Drive::resolve_first_disk($conf, 0);
8300 push @ret, $first if $first;
8301
8302 # cdrom
8303 $first = PVE::QemuServer::Drive::resolve_first_disk($conf, 1);
8304 push @ret, $first if $first;
8305
8306 # network
8307 for (my $i = 0; $i < $MAX_NETS; $i++) {
8308 my $netname = "net$i";
8309 next if !$conf->{$netname};
8310 push @ret, $netname;
8311 last;
8312 }
8313
8314 return \@ret;
8315}
8316
e5d611c3
TL
8317sub device_bootorder {
8318 my ($conf) = @_;
8319
8320 return bootorder_from_legacy($conf) if !defined($conf->{boot});
8321
8322 my $boot = parse_property_string($boot_fmt, $conf->{boot});
8323
8324 my $bootorder = {};
8325 if (!defined($boot) || $boot->{legacy}) {
8326 $bootorder = bootorder_from_legacy($conf, $boot);
8327 } elsif ($boot->{order}) {
8328 my $i = 100; # start at 100 to allow user to insert devices before us with -args
8329 for my $dev (PVE::Tools::split_list($boot->{order})) {
8330 $bootorder->{$dev} = $i++;
8331 }
8332 }
8333
8334 return $bootorder;
8335}
8336
65911545
SR
8337sub register_qmeventd_handle {
8338 my ($vmid) = @_;
8339
8340 my $fh;
8341 my $peer = "/var/run/qmeventd.sock";
8342 my $count = 0;
8343
8344 for (;;) {
8345 $count++;
8346 $fh = IO::Socket::UNIX->new(Peer => $peer, Blocking => 0, Timeout => 1);
8347 last if $fh;
8348 if ($! != EINTR && $! != EAGAIN) {
8349 die "unable to connect to qmeventd socket (vmid: $vmid) - $!\n";
8350 }
8351 if ($count > 4) {
8352 die "unable to connect to qmeventd socket (vmid: $vmid) - timeout "
8353 . "after $count retries\n";
8354 }
8355 usleep(25000);
8356 }
8357
8358 # send handshake to mark VM as backing up
8359 print $fh to_json({vzdump => {vmid => "$vmid"}});
8360
8361 # return handle to be closed later when inhibit is no longer required
8362 return $fh;
8363}
8364
65e866e5
DM
8365# bash completion helper
8366
8367sub complete_backup_archives {
8368 my ($cmdname, $pname, $cvalue) = @_;
8369
8370 my $cfg = PVE::Storage::config();
8371
8372 my $storeid;
8373
8374 if ($cvalue =~ m/^([^:]+):/) {
8375 $storeid = $1;
8376 }
8377
8378 my $data = PVE::Storage::template_list($cfg, $storeid, 'backup');
8379
8380 my $res = [];
8381 foreach my $id (keys %$data) {
8382 foreach my $item (@{$data->{$id}}) {
f43a4f12 8383 next if $item->{format} !~ m/^vma\.(${\PVE::Storage::Plugin::COMPRESSOR_RE})$/;
65e866e5
DM
8384 push @$res, $item->{volid} if defined($item->{volid});
8385 }
8386 }
8387
8388 return $res;
8389}
8390
8391my $complete_vmid_full = sub {
8392 my ($running) = @_;
8393
8394 my $idlist = vmstatus();
8395
8396 my $res = [];
8397
8398 foreach my $id (keys %$idlist) {
8399 my $d = $idlist->{$id};
8400 if (defined($running)) {
8401 next if $d->{template};
8402 next if $running && $d->{status} ne 'running';
8403 next if !$running && $d->{status} eq 'running';
8404 }
8405 push @$res, $id;
8406
8407 }
8408 return $res;
8409};
8410
8411sub complete_vmid {
8412 return &$complete_vmid_full();
8413}
8414
8415sub complete_vmid_stopped {
8416 return &$complete_vmid_full(0);
8417}
8418
8419sub complete_vmid_running {
8420 return &$complete_vmid_full(1);
8421}
8422
335af808
DM
8423sub complete_storage {
8424
8425 my $cfg = PVE::Storage::config();
8426 my $ids = $cfg->{ids};
8427
8428 my $res = [];
8429 foreach my $sid (keys %$ids) {
8430 next if !PVE::Storage::storage_check_enabled($cfg, $sid, undef, 1);
c4c844ef 8431 next if !$ids->{$sid}->{content}->{images};
335af808
DM
8432 push @$res, $sid;
8433 }
8434
8435 return $res;
8436}
8437
255e9c54
AL
8438sub complete_migration_storage {
8439 my ($cmd, $param, $current_value, $all_args) = @_;
8440
8441 my $targetnode = @$all_args[1];
8442
8443 my $cfg = PVE::Storage::config();
8444 my $ids = $cfg->{ids};
8445
8446 my $res = [];
8447 foreach my $sid (keys %$ids) {
8448 next if !PVE::Storage::storage_check_enabled($cfg, $sid, $targetnode, 1);
8449 next if !$ids->{$sid}->{content}->{images};
8450 push @$res, $sid;
8451 }
8452
8453 return $res;
8454}
8455
b08c37c3
DC
8456sub vm_is_paused {
8457 my ($vmid) = @_;
8458 my $qmpstatus = eval {
8459 PVE::QemuConfig::assert_config_exists_on_node($vmid);
8460 mon_cmd($vmid, "query-status");
8461 };
8462 warn "$@\n" if $@;
8463 return $qmpstatus && $qmpstatus->{status} eq "paused";
8464}
8465
3f11f0d7
LS
8466sub check_volume_storage_type {
8467 my ($storecfg, $vol) = @_;
8468
8469 my ($storeid, $volname) = PVE::Storage::parse_volume_id($vol);
8470 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
8471 my ($vtype) = PVE::Storage::parse_volname($storecfg, $vol);
8472
8473 die "storage '$storeid' does not support content-type '$vtype'\n"
8474 if !$scfg->{content}->{$vtype};
8475
8476 return 1;
8477}
8478
21947fea
AD
8479sub add_nets_bridge_fdb {
8480 my ($conf, $vmid) = @_;
8481
1b5ba4dd
TL
8482 for my $opt (keys %$conf) {
8483 next if $opt !~ m/^net(\d+)$/;
8484 my $iface = "tap${vmid}i$1";
4ddd2ca2
TL
8485 # NOTE: expect setups with learning off to *not* use auto-random-generation of MAC on start
8486 my $net = parse_net($conf->{$opt}, 1) or next;
8487
8488 my $mac = $net->{macaddr};
8489 if (!$mac) {
8490 log_warn("MAC learning disabled, but vNIC '$iface' has no static MAC to add to forwarding DB!")
8491 if !file_read_firstline("/sys/class/net/$iface/brport/learning");
8492 next;
8493 }
21947fea 8494
f81c9843 8495 my $bridge = $net->{bridge};
1b5ba4dd 8496 if ($have_sdn) {
f81c9843 8497 PVE::Network::SDN::Zones::add_bridge_fdb($iface, $mac, $bridge, $net->{firewall});
fe62da4f 8498 } elsif (-d "/sys/class/net/$bridge/bridge") { # avoid fdb management with OVS for now
1b5ba4dd 8499 PVE::Network::add_bridge_fdb($iface, $mac, $net->{firewall});
21947fea
AD
8500 }
8501 }
8502}
1b5ba4dd 8503
73ed6496
AD
8504sub del_nets_bridge_fdb {
8505 my ($conf, $vmid) = @_;
8506
8507 for my $opt (keys %$conf) {
8508 next if $opt !~ m/^net(\d+)$/;
8509 my $iface = "tap${vmid}i$1";
8510
8511 my $net = parse_net($conf->{$opt}) or next;
8512 my $mac = $net->{macaddr} or next;
8513
f81c9843 8514 my $bridge = $net->{bridge};
73ed6496 8515 if ($have_sdn) {
f81c9843 8516 PVE::Network::SDN::Zones::del_bridge_fdb($iface, $mac, $bridge, $net->{firewall});
fe62da4f 8517 } elsif (-d "/sys/class/net/$bridge/bridge") { # avoid fdb management with OVS for now
73ed6496
AD
8518 PVE::Network::del_bridge_fdb($iface, $mac, $net->{firewall});
8519 }
8520 }
8521}
8522
1e3baf05 85231;