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