]> git.proxmox.com Git - qemu-server.git/blame - PVE/QemuServer.pm
explain 'nocheck' in more places
[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
DC
118PVE::JSONSchema::register_standard_option('pve-qemu-machine', {
119 description => "Specifies the Qemu machine type.",
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 => {
8d88a594 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,
8d88a594 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
ffda963f 2344 PVE::QemuConfig->check_lock($conf) if !$skiplock;
1e3baf05 2345
5e67a2d2
DC
2346 if ($conf->{template}) {
2347 # check if any base image is still used by a linked clone
3ab0f925 2348 PVE::QemuConfig->foreach_volume_full($conf, { include_unused => 1 }, sub {
5e67a2d2 2349 my ($ds, $drive) = @_;
5e67a2d2
DC
2350 return if drive_is_cdrom($drive);
2351
2352 my $volid = $drive->{file};
5e67a2d2
DC
2353 return if !$volid || $volid =~ m|^/|;
2354
2355 die "base volume '$volid' is still in use by linked cloned\n"
2356 if PVE::Storage::volume_is_base_and_used($storecfg, $volid);
2357
2358 });
2359 }
2360
3e07c6d5 2361 my $volids = {};
ba1a1984 2362 my $remove_owned_drive = sub {
1e3baf05 2363 my ($ds, $drive) = @_;
9c52f5ed 2364 return if drive_is_cdrom($drive, 1);
1e3baf05
DM
2365
2366 my $volid = $drive->{file};
ff1a2432 2367 return if !$volid || $volid =~ m|^/|;
3e07c6d5 2368 return if $volids->{$volid};
1e3baf05 2369
6b64503e 2370 my ($path, $owner) = PVE::Storage::path($storecfg, $volid);
ff1a2432 2371 return if !$path || !$owner || ($owner != $vmid);
1e3baf05 2372
3e07c6d5 2373 $volids->{$volid} = 1;
a2f50f01 2374 eval { PVE::Storage::vdisk_free($storecfg, $volid) };
31b52247 2375 warn "Could not remove disk '$volid', check manually: $@" if $@;
ba1a1984
FE
2376 };
2377
2378 # only remove disks owned by this VM (referenced in the config)
2379 my $include_opts = {
2380 include_unused => 1,
2381 extra_keys => ['vmstate'],
2382 };
2383 PVE::QemuConfig->foreach_volume_full($conf, $include_opts, $remove_owned_drive);
2384
2385 for my $snap (values %{$conf->{snapshots}}) {
2386 next if !defined($snap->{vmstate});
2387 my $drive = PVE::QemuConfig->parse_volume('vmstate', $snap->{vmstate}, 1);
2388 next if !defined($drive);
2389 $remove_owned_drive->('vmstate', $drive);
2390 }
19672434 2391
3e07c6d5
FG
2392 PVE::QemuConfig->foreach_volume_full($conf->{pending}, $include_opts, $remove_owned_drive);
2393
75854662 2394 if ($purge_unreferenced) { # also remove unreferenced disk
d0ff75d9 2395 my $vmdisks = PVE::Storage::vdisk_list($storecfg, undef, $vmid, undef, 'images');
75854662
TL
2396 PVE::Storage::foreach_volid($vmdisks, sub {
2397 my ($volid, $sid, $volname, $d) = @_;
2398 eval { PVE::Storage::vdisk_free($storecfg, $volid) };
2399 warn $@ if $@;
2400 });
2401 }
dfda979e 2402
b04ea584 2403 if (defined $replacement_conf) {
8baf8bc7 2404 PVE::QemuConfig->write_config($vmid, $replacement_conf);
dfda979e
DJ
2405 } else {
2406 PVE::QemuConfig->destroy_config($vmid);
2407 }
1e3baf05
DM
2408}
2409
1e3baf05 2410sub parse_vm_config {
ad5812d8 2411 my ($filename, $raw, $strict) = @_;
1e3baf05 2412
d1c1af4b 2413 return if !defined($raw);
1e3baf05 2414
554ac7e7 2415 my $res = {
fc1ddcdc 2416 digest => Digest::SHA::sha1_hex($raw),
0d18dcfc 2417 snapshots => {},
0d732d16 2418 pending => {},
95a5135d 2419 cloudinit => {},
554ac7e7 2420 };
1e3baf05 2421
ad5812d8
FG
2422 my $handle_error = sub {
2423 my ($msg) = @_;
2424
2425 if ($strict) {
2426 die $msg;
2427 } else {
2428 warn $msg;
2429 }
2430 };
2431
19672434 2432 $filename =~ m|/qemu-server/(\d+)\.conf$|
1e3baf05
DM
2433 || die "got strange filename '$filename'";
2434
2435 my $vmid = $1;
2436
0d18dcfc 2437 my $conf = $res;
b0ec896e 2438 my $descr;
cbfc9d75
TL
2439 my $finish_description = sub {
2440 if (defined($descr)) {
2441 $descr =~ s/\s+$//;
2442 $conf->{description} = $descr;
2443 }
2444 $descr = undef;
2445 };
e297c490 2446 my $section = '';
0581fe4f 2447
0d18dcfc
DM
2448 my @lines = split(/\n/, $raw);
2449 foreach my $line (@lines) {
1e3baf05 2450 next if $line =~ m/^\s*$/;
be190583 2451
eab09f4e 2452 if ($line =~ m/^\[PENDING\]\s*$/i) {
e297c490 2453 $section = 'pending';
cbfc9d75 2454 $finish_description->();
e297c490 2455 $conf = $res->{$section} = {};
eab09f4e 2456 next;
95a5135d
AD
2457 } elsif ($line =~ m/^\[special:cloudinit\]\s*$/i) {
2458 $section = 'cloudinit';
eb9923f9 2459 $finish_description->();
95a5135d
AD
2460 $conf = $res->{$section} = {};
2461 next;
eab09f4e 2462
0d732d16 2463 } elsif ($line =~ m/^\[([a-z][a-z0-9_\-]+)\]\s*$/i) {
e297c490 2464 $section = $1;
cbfc9d75 2465 $finish_description->();
e297c490 2466 $conf = $res->{snapshots}->{$section} = {};
0d18dcfc
DM
2467 next;
2468 }
1e3baf05 2469
d1e7b922 2470 if ($line =~ m/^\#(.*)$/) {
b0ec896e 2471 $descr = '' if !defined($descr);
0581fe4f
DM
2472 $descr .= PVE::Tools::decode_text($1) . "\n";
2473 next;
2474 }
2475
1e3baf05 2476 if ($line =~ m/^(description):\s*(.*\S)\s*$/) {
b0ec896e 2477 $descr = '' if !defined($descr);
0581fe4f 2478 $descr .= PVE::Tools::decode_text($2);
0d18dcfc
DM
2479 } elsif ($line =~ m/snapstate:\s*(prepare|delete)\s*$/) {
2480 $conf->{snapstate} = $1;
1e3baf05
DM
2481 } elsif ($line =~ m/^(args):\s*(.*\S)\s*$/) {
2482 my $key = $1;
2483 my $value = $2;
0d18dcfc 2484 $conf->{$key} = $value;
ef824322 2485 } elsif ($line =~ m/^delete:\s*(.*\S)\s*$/) {
e297c490 2486 my $value = $1;
ef824322
DM
2487 if ($section eq 'pending') {
2488 $conf->{delete} = $value; # we parse this later
2489 } else {
ad5812d8 2490 $handle_error->("vm $vmid - property 'delete' is only allowed in [PENDING]\n");
eab09f4e 2491 }
15cf7698 2492 } elsif ($line =~ m/^([a-z][a-z_]*\d*):\s*(.+?)\s*$/) {
1e3baf05
DM
2493 my $key = $1;
2494 my $value = $2;
c229961a
TL
2495 if ($section eq 'cloudinit') {
2496 # ignore validation only used for informative purpose
2497 $conf->{$key} = $value;
2498 next;
2499 }
1e3baf05
DM
2500 eval { $value = check_type($key, $value); };
2501 if ($@) {
ad5812d8 2502 $handle_error->("vm $vmid - unable to parse value of '$key' - $@");
1e3baf05 2503 } else {
b799312f 2504 $key = 'ide2' if $key eq 'cdrom';
1e3baf05 2505 my $fmt = $confdesc->{$key}->{format};
b799312f 2506 if ($fmt && $fmt =~ /^pve-qm-(?:ide|scsi|virtio|sata)$/) {
1e3baf05
DM
2507 my $v = parse_drive($key, $value);
2508 if (my $volid = filename_to_volume_id($vmid, $v->{file}, $v->{media})) {
2509 $v->{file} = $volid;
71c58bb7 2510 $value = print_drive($v);
1e3baf05 2511 } else {
ad5812d8 2512 $handle_error->("vm $vmid - unable to parse value of '$key'\n");
1e3baf05
DM
2513 next;
2514 }
2515 }
2516
b799312f 2517 $conf->{$key} = $value;
1e3baf05 2518 }
f8d2a1ce 2519 } else {
ad5812d8 2520 $handle_error->("vm $vmid - unable to parse config: $line\n");
1e3baf05
DM
2521 }
2522 }
2523
cbfc9d75 2524 $finish_description->();
0d18dcfc 2525 delete $res->{snapstate}; # just to be sure
1e3baf05
DM
2526
2527 return $res;
2528}
2529
1858638f
DM
2530sub write_vm_config {
2531 my ($filename, $conf) = @_;
1e3baf05 2532
0d18dcfc
DM
2533 delete $conf->{snapstate}; # just to be sure
2534
1858638f
DM
2535 if ($conf->{cdrom}) {
2536 die "option ide2 conflicts with cdrom\n" if $conf->{ide2};
2537 $conf->{ide2} = $conf->{cdrom};
2538 delete $conf->{cdrom};
2539 }
1e3baf05
DM
2540
2541 # we do not use 'smp' any longer
1858638f
DM
2542 if ($conf->{sockets}) {
2543 delete $conf->{smp};
2544 } elsif ($conf->{smp}) {
2545 $conf->{sockets} = $conf->{smp};
2546 delete $conf->{cores};
2547 delete $conf->{smp};
1e3baf05
DM
2548 }
2549
ee2f90b1 2550 my $used_volids = {};
0d18dcfc 2551
ee2f90b1 2552 my $cleanup_config = sub {
ef824322 2553 my ($cref, $pending, $snapname) = @_;
1858638f 2554
ee2f90b1
DM
2555 foreach my $key (keys %$cref) {
2556 next if $key eq 'digest' || $key eq 'description' || $key eq 'snapshots' ||
95a5135d 2557 $key eq 'snapstate' || $key eq 'pending' || $key eq 'cloudinit';
ee2f90b1 2558 my $value = $cref->{$key};
ef824322
DM
2559 if ($key eq 'delete') {
2560 die "propertry 'delete' is only allowed in [PENDING]\n"
2561 if !$pending;
2562 # fixme: check syntax?
2563 next;
2564 }
ee2f90b1
DM
2565 eval { $value = check_type($key, $value); };
2566 die "unable to parse value of '$key' - $@" if $@;
1858638f 2567
ee2f90b1
DM
2568 $cref->{$key} = $value;
2569
74479ee9 2570 if (!$snapname && is_valid_drivename($key)) {
ed221350 2571 my $drive = parse_drive($key, $value);
ee2f90b1
DM
2572 $used_volids->{$drive->{file}} = 1 if $drive && $drive->{file};
2573 }
1e3baf05 2574 }
ee2f90b1
DM
2575 };
2576
2577 &$cleanup_config($conf);
ef824322
DM
2578
2579 &$cleanup_config($conf->{pending}, 1);
2580
ee2f90b1 2581 foreach my $snapname (keys %{$conf->{snapshots}}) {
15c6e277 2582 die "internal error: snapshot name '$snapname' is forbidden" if lc($snapname) eq 'pending';
ef824322 2583 &$cleanup_config($conf->{snapshots}->{$snapname}, undef, $snapname);
1e3baf05
DM
2584 }
2585
1858638f
DM
2586 # remove 'unusedX' settings if we re-add a volume
2587 foreach my $key (keys %$conf) {
2588 my $value = $conf->{$key};
ee2f90b1 2589 if ($key =~ m/^unused/ && $used_volids->{$value}) {
1858638f 2590 delete $conf->{$key};
1e3baf05 2591 }
1858638f 2592 }
be190583 2593
0d18dcfc 2594 my $generate_raw_config = sub {
b0ec896e 2595 my ($conf, $pending) = @_;
0581fe4f 2596
0d18dcfc
DM
2597 my $raw = '';
2598
2599 # add description as comment to top of file
b0ec896e
DM
2600 if (defined(my $descr = $conf->{description})) {
2601 if ($descr) {
2602 foreach my $cl (split(/\n/, $descr)) {
2603 $raw .= '#' . PVE::Tools::encode_text($cl) . "\n";
2604 }
2605 } else {
2606 $raw .= "#\n" if $pending;
2607 }
0d18dcfc
DM
2608 }
2609
2610 foreach my $key (sort keys %$conf) {
95a5135d 2611 next if $key =~ /^(digest|description|pending|cloudinit|snapshots)$/;
0d18dcfc
DM
2612 $raw .= "$key: $conf->{$key}\n";
2613 }
2614 return $raw;
2615 };
0581fe4f 2616
0d18dcfc 2617 my $raw = &$generate_raw_config($conf);
ef824322
DM
2618
2619 if (scalar(keys %{$conf->{pending}})){
2620 $raw .= "\n[PENDING]\n";
b0ec896e 2621 $raw .= &$generate_raw_config($conf->{pending}, 1);
ef824322
DM
2622 }
2623
1e1d6f58 2624 if (scalar(keys %{$conf->{cloudinit}}) && PVE::QemuConfig->has_cloudinit($conf)){
95a5135d
AD
2625 $raw .= "\n[special:cloudinit]\n";
2626 $raw .= &$generate_raw_config($conf->{cloudinit});
2627 }
2628
0d18dcfc
DM
2629 foreach my $snapname (sort keys %{$conf->{snapshots}}) {
2630 $raw .= "\n[$snapname]\n";
2631 $raw .= &$generate_raw_config($conf->{snapshots}->{$snapname});
1858638f 2632 }
1e3baf05 2633
1858638f
DM
2634 return $raw;
2635}
1e3baf05 2636
19672434 2637sub load_defaults {
1e3baf05
DM
2638
2639 my $res = {};
2640
2641 # we use static defaults from our JSON schema configuration
2642 foreach my $key (keys %$confdesc) {
2643 if (defined(my $default = $confdesc->{$key}->{default})) {
2644 $res->{$key} = $default;
2645 }
2646 }
19672434 2647
1e3baf05
DM
2648 return $res;
2649}
2650
2651sub config_list {
2652 my $vmlist = PVE::Cluster::get_vmlist();
2653 my $res = {};
2654 return $res if !$vmlist || !$vmlist->{ids};
2655 my $ids = $vmlist->{ids};
38277afc 2656 my $nodename = nodename();
1e3baf05 2657
1e3baf05
DM
2658 foreach my $vmid (keys %$ids) {
2659 my $d = $ids->{$vmid};
2660 next if !$d->{node} || $d->{node} ne $nodename;
5ee957cc 2661 next if !$d->{type} || $d->{type} ne 'qemu';
1e3baf05
DM
2662 $res->{$vmid}->{exists} = 1;
2663 }
2664 return $res;
2665}
2666
64e13401
DM
2667# test if VM uses local resources (to prevent migration)
2668sub check_local_resources {
2669 my ($conf, $noerr) = @_;
2670
ca6abacf 2671 my @loc_res = ();
19672434 2672
ca6abacf
TM
2673 push @loc_res, "hostusb" if $conf->{hostusb}; # old syntax
2674 push @loc_res, "hostpci" if $conf->{hostpci}; # old syntax
64e13401 2675
ca6abacf 2676 push @loc_res, "ivshmem" if $conf->{ivshmem};
6dbcb073 2677
0d29ab3b 2678 foreach my $k (keys %$conf) {
a9ce7583 2679 next if $k =~ m/^usb/ && ($conf->{$k} =~ m/^spice(?![^,])/);
d44712fc
EK
2680 # sockets are safe: they will recreated be on the target side post-migrate
2681 next if $k =~ m/^serial/ && ($conf->{$k} eq 'socket');
ca6abacf 2682 push @loc_res, $k if $k =~ m/^(usb|hostpci|serial|parallel)\d+$/;
64e13401
DM
2683 }
2684
ca6abacf 2685 die "VM uses local resources\n" if scalar @loc_res && !$noerr;
64e13401 2686
ca6abacf 2687 return \@loc_res;
64e13401
DM
2688}
2689
719893a9 2690# check if used storages are available on all nodes (use by migrate)
47152e2e
DM
2691sub check_storage_availability {
2692 my ($storecfg, $conf, $node) = @_;
2693
912792e2 2694 PVE::QemuConfig->foreach_volume($conf, sub {
47152e2e
DM
2695 my ($ds, $drive) = @_;
2696
2697 my $volid = $drive->{file};
2698 return if !$volid;
2699
2700 my ($sid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
2701 return if !$sid;
2702
2703 # check if storage is available on both nodes
0d2db084
FE
2704 my $scfg = PVE::Storage::storage_check_enabled($storecfg, $sid);
2705 PVE::Storage::storage_check_enabled($storecfg, $sid, $node);
24b84b47 2706
3148f0b0
TL
2707 my ($vtype) = PVE::Storage::parse_volname($storecfg, $volid);
2708
2709 die "$volid: content type '$vtype' is not available on storage '$sid'\n"
2710 if !$scfg->{content}->{$vtype};
47152e2e
DM
2711 });
2712}
2713
719893a9
DM
2714# list nodes where all VM images are available (used by has_feature API)
2715sub shared_nodes {
2716 my ($conf, $storecfg) = @_;
2717
2718 my $nodelist = PVE::Cluster::get_nodelist();
2719 my $nodehash = { map { $_ => 1 } @$nodelist };
38277afc 2720 my $nodename = nodename();
be190583 2721
912792e2 2722 PVE::QemuConfig->foreach_volume($conf, sub {
719893a9
DM
2723 my ($ds, $drive) = @_;
2724
2725 my $volid = $drive->{file};
2726 return if !$volid;
2727
2728 my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
2729 if ($storeid) {
2730 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
2731 if ($scfg->{disable}) {
2732 $nodehash = {};
2733 } elsif (my $avail = $scfg->{nodes}) {
2734 foreach my $node (keys %$nodehash) {
2735 delete $nodehash->{$node} if !$avail->{$node};
2736 }
2737 } elsif (!$scfg->{shared}) {
2738 foreach my $node (keys %$nodehash) {
2739 delete $nodehash->{$node} if $node ne $nodename
2740 }
2741 }
2742 }
2743 });
2744
2745 return $nodehash
2746}
2747
f25852c2
TM
2748sub check_local_storage_availability {
2749 my ($conf, $storecfg) = @_;
2750
2751 my $nodelist = PVE::Cluster::get_nodelist();
2752 my $nodehash = { map { $_ => {} } @$nodelist };
2753
912792e2 2754 PVE::QemuConfig->foreach_volume($conf, sub {
f25852c2
TM
2755 my ($ds, $drive) = @_;
2756
2757 my $volid = $drive->{file};
2758 return if !$volid;
2759
2760 my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
2761 if ($storeid) {
2762 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
2763
2764 if ($scfg->{disable}) {
2765 foreach my $node (keys %$nodehash) {
32075a2c 2766 $nodehash->{$node}->{unavailable_storages}->{$storeid} = 1;
f25852c2
TM
2767 }
2768 } elsif (my $avail = $scfg->{nodes}) {
2769 foreach my $node (keys %$nodehash) {
2770 if (!$avail->{$node}) {
32075a2c 2771 $nodehash->{$node}->{unavailable_storages}->{$storeid} = 1;
f25852c2
TM
2772 }
2773 }
2774 }
2775 }
2776 });
2777
32075a2c
TL
2778 foreach my $node (values %$nodehash) {
2779 if (my $unavail = $node->{unavailable_storages}) {
2780 $node->{unavailable_storages} = [ sort keys %$unavail ];
2781 }
2782 }
2783
f25852c2
TM
2784 return $nodehash
2785}
2786
babf613a 2787# Compat only, use assert_config_exists_on_node and vm_running_locally where possible
1e3baf05 2788sub check_running {
7e8dcf2c 2789 my ($vmid, $nocheck, $node) = @_;
1e3baf05 2790
a20dc58a
FG
2791 # $nocheck is set when called during a migration, in which case the config
2792 # file might still or already reside on the *other* node
2793 # - because rename has already happened, and current node is source
2794 # - because rename hasn't happened yet, and current node is target
2795 # - because rename has happened, current node is target, but hasn't yet
2796 # processed it yet
babf613a
SR
2797 PVE::QemuConfig::assert_config_exists_on_node($vmid, $node) if !$nocheck;
2798 return PVE::QemuServer::Helpers::vm_running_locally($vmid);
1e3baf05
DM
2799}
2800
2801sub vzlist {
19672434 2802
1e3baf05
DM
2803 my $vzlist = config_list();
2804
d036e418 2805 my $fd = IO::Dir->new($PVE::QemuServer::Helpers::var_run_tmpdir) || return $vzlist;
1e3baf05 2806
19672434 2807 while (defined(my $de = $fd->read)) {
1e3baf05
DM
2808 next if $de !~ m/^(\d+)\.pid$/;
2809 my $vmid = $1;
6b64503e
DM
2810 next if !defined($vzlist->{$vmid});
2811 if (my $pid = check_running($vmid)) {
1e3baf05
DM
2812 $vzlist->{$vmid}->{pid} = $pid;
2813 }
2814 }
2815
2816 return $vzlist;
2817}
2818
b1a70cab
DM
2819our $vmstatus_return_properties = {
2820 vmid => get_standard_option('pve-vmid'),
2821 status => {
2822 description => "Qemu process status.",
2823 type => 'string',
2824 enum => ['stopped', 'running'],
2825 },
2826 maxmem => {
2827 description => "Maximum memory in bytes.",
2828 type => 'integer',
2829 optional => 1,
2830 renderer => 'bytes',
2831 },
2832 maxdisk => {
2833 description => "Root disk size in bytes.",
2834 type => 'integer',
2835 optional => 1,
2836 renderer => 'bytes',
2837 },
2838 name => {
2839 description => "VM name.",
2840 type => 'string',
2841 optional => 1,
2842 },
2843 qmpstatus => {
2844 description => "Qemu QMP agent status.",
2845 type => 'string',
2846 optional => 1,
2847 },
2848 pid => {
2849 description => "PID of running qemu process.",
2850 type => 'integer',
2851 optional => 1,
2852 },
2853 uptime => {
2854 description => "Uptime.",
2855 type => 'integer',
2856 optional => 1,
2857 renderer => 'duration',
2858 },
2859 cpus => {
2860 description => "Maximum usable CPUs.",
2861 type => 'number',
2862 optional => 1,
2863 },
e6ed61b4 2864 lock => {
11efdfa5 2865 description => "The current config lock, if any.",
e6ed61b4
DC
2866 type => 'string',
2867 optional => 1,
b8e7068a
DC
2868 },
2869 tags => {
2870 description => "The current configured tags, if any",
2871 type => 'string',
2872 optional => 1,
2873 },
949112c3
FE
2874 'running-machine' => {
2875 description => "The currently running machine type (if running).",
2876 type => 'string',
2877 optional => 1,
2878 },
2879 'running-qemu' => {
2880 description => "The currently running QEMU version (if running).",
2881 type => 'string',
2882 optional => 1,
2883 },
b1a70cab
DM
2884};
2885
1e3baf05
DM
2886my $last_proc_pid_stat;
2887
03a33f30
DM
2888# get VM status information
2889# This must be fast and should not block ($full == false)
2890# We only query KVM using QMP if $full == true (this can be slow)
1e3baf05 2891sub vmstatus {
03a33f30 2892 my ($opt_vmid, $full) = @_;
1e3baf05
DM
2893
2894 my $res = {};
2895
19672434 2896 my $storecfg = PVE::Storage::config();
1e3baf05
DM
2897
2898 my $list = vzlist();
3618ee99
EK
2899 my $defaults = load_defaults();
2900
694fcad4 2901 my ($uptime) = PVE::ProcFSTools::read_proc_uptime(1);
1e3baf05 2902
ae4915a2
DM
2903 my $cpucount = $cpuinfo->{cpus} || 1;
2904
1e3baf05
DM
2905 foreach my $vmid (keys %$list) {
2906 next if $opt_vmid && ($vmid ne $opt_vmid);
2907
9f78b695 2908 my $conf = PVE::QemuConfig->load_config($vmid);
1e3baf05 2909
ad2cad72 2910 my $d = { vmid => int($vmid) };
8a0addab 2911 $d->{pid} = int($list->{$vmid}->{pid}) if $list->{$vmid}->{pid};
1e3baf05
DM
2912
2913 # fixme: better status?
2914 $d->{status} = $list->{$vmid}->{pid} ? 'running' : 'stopped';
2915
776c5f50 2916 my $size = PVE::QemuServer::Drive::bootdisk_size($storecfg, $conf);
af990afe
DM
2917 if (defined($size)) {
2918 $d->{disk} = 0; # no info available
1e3baf05
DM
2919 $d->{maxdisk} = $size;
2920 } else {
2921 $d->{disk} = 0;
2922 $d->{maxdisk} = 0;
2923 }
2924
3618ee99
EK
2925 $d->{cpus} = ($conf->{sockets} || $defaults->{sockets})
2926 * ($conf->{cores} || $defaults->{cores});
ae4915a2 2927 $d->{cpus} = $cpucount if $d->{cpus} > $cpucount;
d7c8364b 2928 $d->{cpus} = $conf->{vcpus} if $conf->{vcpus};
ae4915a2 2929
1e3baf05 2930 $d->{name} = $conf->{name} || "VM $vmid";
3618ee99
EK
2931 $d->{maxmem} = $conf->{memory} ? $conf->{memory}*(1024*1024)
2932 : $defaults->{memory}*(1024*1024);
1e3baf05 2933
8b1accf7 2934 if ($conf->{balloon}) {
4bdb0514 2935 $d->{balloon_min} = $conf->{balloon}*(1024*1024);
3618ee99
EK
2936 $d->{shares} = defined($conf->{shares}) ? $conf->{shares}
2937 : $defaults->{shares};
8b1accf7
DM
2938 }
2939
1e3baf05
DM
2940 $d->{uptime} = 0;
2941 $d->{cpu} = 0;
1e3baf05
DM
2942 $d->{mem} = 0;
2943
2944 $d->{netout} = 0;
2945 $d->{netin} = 0;
2946
2947 $d->{diskread} = 0;
2948 $d->{diskwrite} = 0;
2949
75a2a423 2950 $d->{template} = 1 if PVE::QemuConfig->is_template($conf);
4d8c851b 2951
8107b378 2952 $d->{serial} = 1 if conf_has_serial($conf);
e6ed61b4 2953 $d->{lock} = $conf->{lock} if $conf->{lock};
b8e7068a 2954 $d->{tags} = $conf->{tags} if defined($conf->{tags});
8107b378 2955
1e3baf05
DM
2956 $res->{$vmid} = $d;
2957 }
2958
2959 my $netdev = PVE::ProcFSTools::read_proc_net_dev();
2960 foreach my $dev (keys %$netdev) {
2961 next if $dev !~ m/^tap([1-9]\d*)i/;
2962 my $vmid = $1;
2963 my $d = $res->{$vmid};
2964 next if !$d;
19672434 2965
1e3baf05
DM
2966 $d->{netout} += $netdev->{$dev}->{receive};
2967 $d->{netin} += $netdev->{$dev}->{transmit};
604ea644
AD
2968
2969 if ($full) {
ad2cad72
FE
2970 $d->{nics}->{$dev}->{netout} = int($netdev->{$dev}->{receive});
2971 $d->{nics}->{$dev}->{netin} = int($netdev->{$dev}->{transmit});
604ea644
AD
2972 }
2973
1e3baf05
DM
2974 }
2975
1e3baf05
DM
2976 my $ctime = gettimeofday;
2977
2978 foreach my $vmid (keys %$list) {
2979
2980 my $d = $res->{$vmid};
2981 my $pid = $d->{pid};
2982 next if !$pid;
2983
694fcad4
DM
2984 my $pstat = PVE::ProcFSTools::read_proc_pid_stat($pid);
2985 next if !$pstat; # not running
19672434 2986
694fcad4 2987 my $used = $pstat->{utime} + $pstat->{stime};
1e3baf05 2988
694fcad4 2989 $d->{uptime} = int(($uptime - $pstat->{starttime})/$cpuinfo->{user_hz});
1e3baf05 2990
694fcad4 2991 if ($pstat->{vsize}) {
6b64503e 2992 $d->{mem} = int(($pstat->{rss}/$pstat->{vsize})*$d->{maxmem});
1e3baf05
DM
2993 }
2994
2995 my $old = $last_proc_pid_stat->{$pid};
2996 if (!$old) {
19672434
DM
2997 $last_proc_pid_stat->{$pid} = {
2998 time => $ctime,
1e3baf05
DM
2999 used => $used,
3000 cpu => 0,
1e3baf05
DM
3001 };
3002 next;
3003 }
3004
7f0b5beb 3005 my $dtime = ($ctime - $old->{time}) * $cpucount * $cpuinfo->{user_hz};
1e3baf05
DM
3006
3007 if ($dtime > 1000) {
3008 my $dutime = $used - $old->{used};
3009
ae4915a2 3010 $d->{cpu} = (($dutime/$dtime)* $cpucount) / $d->{cpus};
1e3baf05 3011 $last_proc_pid_stat->{$pid} = {
19672434 3012 time => $ctime,
1e3baf05
DM
3013 used => $used,
3014 cpu => $d->{cpu},
1e3baf05
DM
3015 };
3016 } else {
3017 $d->{cpu} = $old->{cpu};
1e3baf05
DM
3018 }
3019 }
3020
f5eb281a 3021 return $res if !$full;
03a33f30
DM
3022
3023 my $qmpclient = PVE::QMPClient->new();
3024
64e7fcf2
DM
3025 my $ballooncb = sub {
3026 my ($vmid, $resp) = @_;
3027
3028 my $info = $resp->{'return'};
38babf81
DM
3029 return if !$info->{max_mem};
3030
64e7fcf2
DM
3031 my $d = $res->{$vmid};
3032
38babf81
DM
3033 # use memory assigned to VM
3034 $d->{maxmem} = $info->{max_mem};
3035 $d->{balloon} = $info->{actual};
3036
3037 if (defined($info->{total_mem}) && defined($info->{free_mem})) {
3038 $d->{mem} = $info->{total_mem} - $info->{free_mem};
3039 $d->{freemem} = $info->{free_mem};
64e7fcf2
DM
3040 }
3041
604ea644 3042 $d->{ballooninfo} = $info;
64e7fcf2
DM
3043 };
3044
03a33f30
DM
3045 my $blockstatscb = sub {
3046 my ($vmid, $resp) = @_;
3047 my $data = $resp->{'return'} || [];
3048 my $totalrdbytes = 0;
3049 my $totalwrbytes = 0;
604ea644 3050
03a33f30
DM
3051 for my $blockstat (@$data) {
3052 $totalrdbytes = $totalrdbytes + $blockstat->{stats}->{rd_bytes};
3053 $totalwrbytes = $totalwrbytes + $blockstat->{stats}->{wr_bytes};
604ea644
AD
3054
3055 $blockstat->{device} =~ s/drive-//;
3056 $res->{$vmid}->{blockstat}->{$blockstat->{device}} = $blockstat->{stats};
03a33f30
DM
3057 }
3058 $res->{$vmid}->{diskread} = $totalrdbytes;
3059 $res->{$vmid}->{diskwrite} = $totalwrbytes;
3060 };
3061
949112c3
FE
3062 my $machinecb = sub {
3063 my ($vmid, $resp) = @_;
3064 my $data = $resp->{'return'} || [];
3065
3066 $res->{$vmid}->{'running-machine'} =
3067 PVE::QemuServer::Machine::current_from_query_machines($data);
3068 };
3069
3070 my $versioncb = sub {
3071 my ($vmid, $resp) = @_;
3072 my $data = $resp->{'return'} // {};
3073 my $version = 'unknown';
3074
3075 if (my $v = $data->{qemu}) {
3076 $version = $v->{major} . "." . $v->{minor} . "." . $v->{micro};
3077 }
3078
3079 $res->{$vmid}->{'running-qemu'} = $version;
3080 };
3081
03a33f30
DM
3082 my $statuscb = sub {
3083 my ($vmid, $resp) = @_;
64e7fcf2 3084
03a33f30 3085 $qmpclient->queue_cmd($vmid, $blockstatscb, 'query-blockstats');
949112c3
FE
3086 $qmpclient->queue_cmd($vmid, $machinecb, 'query-machines');
3087 $qmpclient->queue_cmd($vmid, $versioncb, 'query-version');
64e7fcf2
DM
3088 # this fails if ballon driver is not loaded, so this must be
3089 # the last commnand (following command are aborted if this fails).
38babf81 3090 $qmpclient->queue_cmd($vmid, $ballooncb, 'query-balloon');
03a33f30
DM
3091
3092 my $status = 'unknown';
3093 if (!defined($status = $resp->{'return'}->{status})) {
3094 warn "unable to get VM status\n";
3095 return;
3096 }
3097
3098 $res->{$vmid}->{qmpstatus} = $resp->{'return'}->{status};
3099 };
3100
3101 foreach my $vmid (keys %$list) {
3102 next if $opt_vmid && ($vmid ne $opt_vmid);
3103 next if !$res->{$vmid}->{pid}; # not running
3104 $qmpclient->queue_cmd($vmid, $statuscb, 'query-status');
3105 }
3106
b017fbda 3107 $qmpclient->queue_execute(undef, 2);
03a33f30 3108
6891fd70
SR
3109 foreach my $vmid (keys %$list) {
3110 next if $opt_vmid && ($vmid ne $opt_vmid);
e5b18771
FG
3111 next if !$res->{$vmid}->{pid}; #not running
3112
6891fd70
SR
3113 # we can't use the $qmpclient since it might have already aborted on
3114 # 'query-balloon', but this might also fail for older versions...
3115 my $qemu_support = eval { mon_cmd($vmid, "query-proxmox-support") };
3116 $res->{$vmid}->{'proxmox-support'} = $qemu_support // {};
3117 }
3118
03a33f30
DM
3119 foreach my $vmid (keys %$list) {
3120 next if $opt_vmid && ($vmid ne $opt_vmid);
3121 $res->{$vmid}->{qmpstatus} = $res->{$vmid}->{status} if !$res->{$vmid}->{qmpstatus};
3122 }
3123
1e3baf05
DM
3124 return $res;
3125}
3126
8107b378
DC
3127sub conf_has_serial {
3128 my ($conf) = @_;
3129
3130 for (my $i = 0; $i < $MAX_SERIAL_PORTS; $i++) {
3131 if ($conf->{"serial$i"}) {
3132 return 1;
3133 }
3134 }
3135
3136 return 0;
3137}
3138
d5535a00
TL
3139sub conf_has_audio {
3140 my ($conf, $id) = @_;
3141
3142 $id //= 0;
3143 my $audio = $conf->{"audio$id"};
d1c1af4b 3144 return if !defined($audio);
d5535a00 3145
4df98f2f 3146 my $audioproperties = parse_property_string($audio_fmt, $audio);
d5535a00
TL
3147 my $audiodriver = $audioproperties->{driver} // 'spice';
3148
3149 return {
3150 dev => $audioproperties->{device},
b0f96836 3151 dev_id => "audiodev$id",
d5535a00
TL
3152 backend => $audiodriver,
3153 backend_id => "$audiodriver-backend${id}",
3154 };
3155}
3156
b01de199 3157sub audio_devs {
1cc5ed1b 3158 my ($audio, $audiopciaddr, $machine_version) = @_;
b01de199
TL
3159
3160 my $devs = [];
3161
3162 my $id = $audio->{dev_id};
1cc5ed1b
AL
3163 my $audiodev = "";
3164 if (min_version($machine_version, 4, 2)) {
3165 $audiodev = ",audiodev=$audio->{backend_id}";
3166 }
b01de199
TL
3167
3168 if ($audio->{dev} eq 'AC97') {
1cc5ed1b 3169 push @$devs, '-device', "AC97,id=${id}${audiopciaddr}$audiodev";
b01de199
TL
3170 } elsif ($audio->{dev} =~ /intel\-hda$/) {
3171 push @$devs, '-device', "$audio->{dev},id=${id}${audiopciaddr}";
1cc5ed1b
AL
3172 push @$devs, '-device', "hda-micro,id=${id}-codec0,bus=${id}.0,cad=0$audiodev";
3173 push @$devs, '-device', "hda-duplex,id=${id}-codec1,bus=${id}.0,cad=1$audiodev";
b01de199
TL
3174 } else {
3175 die "unkown audio device '$audio->{dev}', implement me!";
3176 }
3177
3178 push @$devs, '-audiodev', "$audio->{backend},id=$audio->{backend_id}";
3179
3180 return $devs;
3181}
3182
f9dde219
SR
3183sub get_tpm_paths {
3184 my ($vmid) = @_;
3185 return {
3186 socket => "/var/run/qemu-server/$vmid.swtpm",
3187 pid => "/var/run/qemu-server/$vmid.swtpm.pid",
3188 };
3189}
3190
3191sub add_tpm_device {
3192 my ($vmid, $devices, $conf) = @_;
3193
3194 return if !$conf->{tpmstate0};
3195
3196 my $paths = get_tpm_paths($vmid);
3197
3198 push @$devices, "-chardev", "socket,id=tpmchar,path=$paths->{socket}";
3199 push @$devices, "-tpmdev", "emulator,id=tpmdev,chardev=tpmchar";
3200 push @$devices, "-device", "tpm-tis,tpmdev=tpmdev";
3201}
3202
3203sub start_swtpm {
3204 my ($storecfg, $vmid, $tpmdrive, $migration) = @_;
3205
3206 return if !$tpmdrive;
3207
3208 my $state;
3209 my $tpm = parse_drive("tpmstate0", $tpmdrive);
3210 my ($storeid, $volname) = PVE::Storage::parse_volume_id($tpm->{file}, 1);
3211 if ($storeid) {
3212 $state = PVE::Storage::map_volume($storecfg, $tpm->{file});
3213 } else {
3214 $state = $tpm->{file};
3215 }
3216
3217 my $paths = get_tpm_paths($vmid);
3218
3219 # during migration, we will get state from remote
3220 #
3221 if (!$migration) {
3222 # run swtpm_setup to create a new TPM state if it doesn't exist yet
3223 my $setup_cmd = [
3224 "swtpm_setup",
3225 "--tpmstate",
3226 "file://$state",
3227 "--createek",
3228 "--create-ek-cert",
3229 "--create-platform-cert",
3230 "--lock-nvram",
3231 "--config",
3232 "/etc/swtpm_setup.conf", # do not use XDG configs
3233 "--runas",
3234 "0", # force creation as root, error if not possible
3235 "--not-overwrite", # ignore existing state, do not modify
3236 ];
3237
3238 push @$setup_cmd, "--tpm2" if $tpm->{version} eq 'v2.0';
3239 # TPM 2.0 supports ECC crypto, use if possible
3240 push @$setup_cmd, "--ecc" if $tpm->{version} eq 'v2.0';
3241
3242 run_command($setup_cmd, outfunc => sub {
3243 print "swtpm_setup: $1\n";
3244 });
3245 }
3246
3247 my $emulator_cmd = [
3248 "swtpm",
3249 "socket",
3250 "--tpmstate",
3251 "backend-uri=file://$state,mode=0600",
3252 "--ctrl",
3253 "type=unixio,path=$paths->{socket},mode=0600",
3254 "--pid",
3255 "file=$paths->{pid}",
3256 "--terminate", # terminate on QEMU disconnect
3257 "--daemon",
3258 ];
3259 push @$emulator_cmd, "--tpm2" if $tpm->{version} eq 'v2.0';
3260 run_command($emulator_cmd, outfunc => sub { print $1; });
3261
6bbcd71f 3262 my $tries = 100; # swtpm may take a bit to start before daemonizing, wait up to 5s for pid
f85951dc 3263 while (! -e $paths->{pid}) {
90c41bac 3264 die "failed to start swtpm: pid file '$paths->{pid}' wasn't created.\n" if --$tries == 0;
6bbcd71f 3265 usleep(50_000);
f85951dc
SR
3266 }
3267
f9dde219
SR
3268 # return untainted PID of swtpm daemon so it can be killed on error
3269 file_read_firstline($paths->{pid}) =~ m/(\d+)/;
3270 return $1;
3271}
3272
86b8228b
DM
3273sub vga_conf_has_spice {
3274 my ($vga) = @_;
3275
55655ebc
DC
3276 my $vgaconf = parse_vga($vga);
3277 my $vgatype = $vgaconf->{type};
3278 return 0 if !$vgatype || $vgatype !~ m/^qxl([234])?$/;
590e698c
DM
3279
3280 return $1 || 1;
86b8228b
DM
3281}
3282
d731ecbe
WB
3283sub is_native($) {
3284 my ($arch) = @_;
3285 return get_host_arch() eq $arch;
3286}
3287
045749f2
TL
3288sub get_vm_arch {
3289 my ($conf) = @_;
3290 return $conf->{arch} // get_host_arch();
3291}
3292
d731ecbe
WB
3293my $default_machines = {
3294 x86_64 => 'pc',
3295 aarch64 => 'virt',
3296};
3297
0761e619
TL
3298sub get_installed_machine_version {
3299 my ($kvmversion) = @_;
3300 $kvmversion = kvm_user_version() if !defined($kvmversion);
3301 $kvmversion =~ m/^(\d+\.\d+)/;
3302 return $1;
3303}
3304
3305sub windows_get_pinned_machine_version {
3306 my ($machine, $base_version, $kvmversion) = @_;
3307
3308 my $pin_version = $base_version;
3309 if (!defined($base_version) ||
3310 !PVE::QemuServer::Machine::can_run_pve_machine_version($base_version, $kvmversion)
3311 ) {
3312 $pin_version = get_installed_machine_version($kvmversion);
3313 }
3314 if (!$machine || $machine eq 'pc') {
3315 $machine = "pc-i440fx-$pin_version";
3316 } elsif ($machine eq 'q35') {
3317 $machine = "pc-q35-$pin_version";
3318 } elsif ($machine eq 'virt') {
3319 $machine = "virt-$pin_version";
3320 } else {
3321 warn "unknown machine type '$machine', not touching that!\n";
3322 }
3323
3324 return $machine;
3325}
3326
045749f2 3327sub get_vm_machine {
ac0077cc 3328 my ($conf, $forcemachine, $arch, $add_pve_version, $kvmversion) = @_;
045749f2
TL
3329
3330 my $machine = $forcemachine || $conf->{machine};
d731ecbe 3331
9471e48b 3332 if (!$machine || $machine =~ m/^(?:pc|q35|virt)$/) {
4dd1e83c
TL
3333 $kvmversion //= kvm_user_version();
3334 # we must pin Windows VMs without a specific version to 5.1, as 5.2 fixed a bug in ACPI
3335 # layout which confuses windows quite a bit and may result in various regressions..
3336 # see: https://lists.gnu.org/archive/html/qemu-devel/2021-02/msg08484.html
3337 if (windows_version($conf->{ostype})) {
0761e619 3338 $machine = windows_get_pinned_machine_version($machine, '5.1', $kvmversion);
4dd1e83c 3339 }
045749f2
TL
3340 $arch //= 'x86_64';
3341 $machine ||= $default_machines->{$arch};
ac0077cc 3342 if ($add_pve_version) {
ac0077cc
SR
3343 my $pvever = PVE::QemuServer::Machine::get_pve_version($kvmversion);
3344 $machine .= "+pve$pvever";
3345 }
3346 }
3347
d4be7f31
SR
3348 if ($add_pve_version && $machine !~ m/\+pve\d+?(?:\.pxe)?$/) {
3349 my $is_pxe = $machine =~ m/^(.*?)\.pxe$/;
3350 $machine = $1 if $is_pxe;
3351
ac0077cc
SR
3352 # for version-pinned machines that do not include a pve-version (e.g.
3353 # pc-q35-4.1), we assume 0 to keep them stable in case we bump
3354 $machine .= '+pve0';
d4be7f31
SR
3355
3356 $machine .= '.pxe' if $is_pxe;
045749f2
TL
3357 }
3358
3359 return $machine;
d731ecbe
WB
3360}
3361
90b20b15
DC
3362sub get_ovmf_files($$$) {
3363 my ($arch, $efidisk, $smm) = @_;
96ed3574 3364
b5099b4f 3365 my $types = $OVMF->{$arch}
96ed3574
WB
3366 or die "no OVMF images known for architecture '$arch'\n";
3367
b5099b4f
SR
3368 my $type = 'default';
3369 if (defined($efidisk->{efitype}) && $efidisk->{efitype} eq '4m') {
90b20b15
DC
3370 $type = $smm ? "4m" : "4m-no-smm";
3371 $type .= '-ms' if $efidisk->{'pre-enrolled-keys'};
b5099b4f
SR
3372 }
3373
3374 return $types->{$type}->@*;
96ed3574
WB
3375}
3376
6908fd9b
WB
3377my $Arch2Qemu = {
3378 aarch64 => '/usr/bin/qemu-system-aarch64',
3379 x86_64 => '/usr/bin/qemu-system-x86_64',
3380};
3381sub get_command_for_arch($) {
3382 my ($arch) = @_;
3383 return '/usr/bin/kvm' if is_native($arch);
3384
3385 my $cmd = $Arch2Qemu->{$arch}
3386 or die "don't know how to emulate architecture '$arch'\n";
3387 return $cmd;
3388}
3389
05a4c550
SR
3390# To use query_supported_cpu_flags and query_understood_cpu_flags to get flags
3391# to use in a QEMU command line (-cpu element), first array_intersect the result
3392# of query_supported_ with query_understood_. This is necessary because:
3393#
3394# a) query_understood_ returns flags the host cannot use and
3395# b) query_supported_ (rather the QMP call) doesn't actually return CPU
3396# flags, but CPU settings - with most of them being flags. Those settings
3397# (and some flags, curiously) cannot be specified as a "-cpu" argument.
3398#
3399# query_supported_ needs to start up to 2 temporary VMs and is therefore rather
3400# expensive. If you need the value returned from this, you can get it much
3401# cheaper from pmxcfs using PVE::Cluster::get_node_kv('cpuflags-$accel') with
3402# $accel being 'kvm' or 'tcg'.
3403#
3404# pvestatd calls this function on startup and whenever the QEMU/KVM version
3405# changes, automatically populating pmxcfs.
3406#
3407# Returns: { kvm => [ flagX, flagY, ... ], tcg => [ flag1, flag2, ... ] }
3408# since kvm and tcg machines support different flags
3409#
3410sub query_supported_cpu_flags {
52cffab6 3411 my ($arch) = @_;
05a4c550 3412
52cffab6
SR
3413 $arch //= get_host_arch();
3414 my $default_machine = $default_machines->{$arch};
3415
3416 my $flags = {};
05a4c550
SR
3417
3418 # FIXME: Once this is merged, the code below should work for ARM as well:
3419 # https://lists.nongnu.org/archive/html/qemu-devel/2019-06/msg04947.html
3420 die "QEMU/KVM cannot detect CPU flags on ARM (aarch64)\n" if
3421 $arch eq "aarch64";
3422
3423 my $kvm_supported = defined(kvm_version());
3424 my $qemu_cmd = get_command_for_arch($arch);
3425 my $fakevmid = -1;
3426 my $pidfile = PVE::QemuServer::Helpers::pidfile_name($fakevmid);
3427
3428 # Start a temporary (frozen) VM with vmid -1 to allow sending a QMP command
3429 my $query_supported_run_qemu = sub {
3430 my ($kvm) = @_;
3431
3432 my $flags = {};
3433 my $cmd = [
3434 $qemu_cmd,
3435 '-machine', $default_machine,
3436 '-display', 'none',
378ad769 3437 '-chardev', "socket,id=qmp,path=/var/run/qemu-server/$fakevmid.qmp,server=on,wait=off",
05a4c550
SR
3438 '-mon', 'chardev=qmp,mode=control',
3439 '-pidfile', $pidfile,
3440 '-S', '-daemonize'
3441 ];
3442
3443 if (!$kvm) {
3444 push @$cmd, '-accel', 'tcg';
3445 }
3446
3447 my $rc = run_command($cmd, noerr => 1, quiet => 0);
3448 die "QEMU flag querying VM exited with code " . $rc if $rc;
3449
3450 eval {
3451 my $cmd_result = mon_cmd(
3452 $fakevmid,
3453 'query-cpu-model-expansion',
3454 type => 'full',
3455 model => { name => 'host' }
3456 );
3457
3458 my $props = $cmd_result->{model}->{props};
3459 foreach my $prop (keys %$props) {
3460 next if $props->{$prop} ne '1';
3461 # QEMU returns some flags multiple times, with '_', '.' or '-'
3462 # (e.g. lahf_lm and lahf-lm; sse4.2, sse4-2 and sse4_2; ...).
3463 # We only keep those with underscores, to match /proc/cpuinfo
3464 $prop =~ s/\.|-/_/g;
3465 $flags->{$prop} = 1;
3466 }
3467 };
3468 my $err = $@;
3469
6bbcd71f 3470 # force stop with 10 sec timeout and 'nocheck', always stop, even if QMP failed
05a4c550
SR
3471 vm_stop(undef, $fakevmid, 1, 1, 10, 0, 1);
3472
3473 die $err if $err;
3474
3475 return [ sort keys %$flags ];
3476 };
3477
3478 # We need to query QEMU twice, since KVM and TCG have different supported flags
3479 PVE::QemuConfig->lock_config($fakevmid, sub {
3480 $flags->{tcg} = eval { $query_supported_run_qemu->(0) };
3481 warn "warning: failed querying supported tcg flags: $@\n" if $@;
3482
3483 if ($kvm_supported) {
3484 $flags->{kvm} = eval { $query_supported_run_qemu->(1) };
3485 warn "warning: failed querying supported kvm flags: $@\n" if $@;
3486 }
3487 });
3488
3489 return $flags;
3490}
3491
3492# Understood CPU flags are written to a file at 'pve-qemu' compile time
3493my $understood_cpu_flag_dir = "/usr/share/kvm";
3494sub query_understood_cpu_flags {
3495 my $arch = get_host_arch();
3496 my $filepath = "$understood_cpu_flag_dir/recognized-CPUID-flags-$arch";
3497
3498 die "Cannot query understood QEMU CPU flags for architecture: $arch (file not found)\n"
3499 if ! -e $filepath;
3500
3501 my $raw = file_get_contents($filepath);
3502 $raw =~ s/^\s+|\s+$//g;
3503 my @flags = split(/\s+/, $raw);
3504
3505 return \@flags;
3506}
3507
e5a6919c
FE
3508# Since commit 277d33454f77ec1d1e0bc04e37621e4dd2424b67 in pve-qemu, smm is not off by default
3509# anymore. But smm=off seems to be required when using SeaBIOS and serial display.
3510my sub should_disable_smm {
3511 my ($conf, $vga) = @_;
3512
3513 return (!defined($conf->{bios}) || $conf->{bios} eq 'seabios') &&
bec87424 3514 $vga->{type} && $vga->{type} =~ m/^(serial\d+|none)$/;
e5a6919c
FE
3515}
3516
1e3baf05 3517sub config_to_command {
5921764c
SR
3518 my ($storecfg, $vmid, $conf, $defaults, $forcemachine, $forcecpu,
3519 $pbs_backing) = @_;
1e3baf05 3520
3326ae19 3521 my ($globalFlags, $machineFlags, $rtcFlags) = ([], [], []);
5bdcf937 3522 my $devices = [];
5bdcf937 3523 my $bridges = {};
b42d3cf9 3524 my $ostype = $conf->{ostype};
4317f69f 3525 my $winversion = windows_version($ostype);
d731ecbe 3526 my $kvm = $conf->{kvm};
38277afc 3527 my $nodename = nodename();
d731ecbe 3528
045749f2 3529 my $arch = get_vm_arch($conf);
1476b99f
DC
3530 my $kvm_binary = get_command_for_arch($arch);
3531 my $kvmver = kvm_user_version($kvm_binary);
045749f2 3532
a04dd5c4
SR
3533 if (!$kvmver || $kvmver !~ m/^(\d+)\.(\d+)/ || $1 < 3) {
3534 $kvmver //= "undefined";
3535 die "Detected old QEMU binary ('$kvmver', at least 3.0 is required)\n";
3536 }
3537
9471e48b
TL
3538 my $add_pve_version = min_version($kvmver, 4, 1);
3539
3540 my $machine_type = get_vm_machine($conf, $forcemachine, $arch, $add_pve_version);
4df98f2f 3541 my $machine_version = extract_version($machine_type, $kvmver);
d731ecbe 3542 $kvm //= 1 if is_native($arch);
4317f69f 3543
a77a53ae 3544 $machine_version =~ m/(\d+)\.(\d+)/;
ac0077cc 3545 my ($machine_major, $machine_minor) = ($1, $2);
ac0077cc 3546
b516c848
SR
3547 if ($kvmver =~ m/^\d+\.\d+\.(\d+)/ && $1 >= 90) {
3548 warn "warning: Installed QEMU version ($kvmver) is a release candidate, ignoring version checks\n";
3549 } elsif (!min_version($kvmver, $machine_major, $machine_minor)) {
4df98f2f
TL
3550 die "Installed QEMU version '$kvmver' is too old to run machine type '$machine_type',"
3551 ." please upgrade node '$nodename'\n"
b516c848 3552 } elsif (!PVE::QemuServer::Machine::can_run_pve_machine_version($machine_version, $kvmver)) {
ac0077cc 3553 my $max_pve_version = PVE::QemuServer::Machine::get_pve_version($machine_version);
4df98f2f
TL
3554 die "Installed qemu-server (max feature level for $machine_major.$machine_minor is"
3555 ." pve$max_pve_version) is too old to run machine type '$machine_type', please upgrade"
3556 ." node '$nodename'\n";
ac0077cc
SR
3557 }
3558
3559 # if a specific +pve version is required for a feature, use $version_guard
3560 # instead of min_version to allow machines to be run with the minimum
3561 # required version
3562 my $required_pve_version = 0;
3563 my $version_guard = sub {
3564 my ($major, $minor, $pve) = @_;
3565 return 0 if !min_version($machine_version, $major, $minor, $pve);
47f35977
SR
3566 my $max_pve = PVE::QemuServer::Machine::get_pve_version("$major.$minor");
3567 return 1 if min_version($machine_version, $major, $minor, $max_pve+1);
ac0077cc
SR
3568 $required_pve_version = $pve if $pve && $pve > $required_pve_version;
3569 return 1;
3570 };
a77a53ae 3571
4df98f2f
TL
3572 if ($kvm && !defined kvm_version()) {
3573 die "KVM virtualisation configured, but not available. Either disable in VM configuration"
3574 ." or enable in BIOS.\n";
d731ecbe 3575 }
bfcd9b7e 3576
3392d6ca 3577 my $q35 = PVE::QemuServer::Machine::machine_type_is_q35($conf);
4d3f29ed 3578 my $hotplug_features = parse_hotplug_features(defined($conf->{hotplug}) ? $conf->{hotplug} : '1');
249c4a6c
AD
3579 my $use_old_bios_files = undef;
3580 ($use_old_bios_files, $machine_type) = qemu_use_old_bios_files($machine_type);
db656e5f 3581
74fe3d9a 3582 my $cmd = [];
83870398 3583 if ($conf->{affinity}) {
74fe3d9a 3584 push @$cmd, '/usr/bin/taskset', '--cpu-list', '--all-tasks', $conf->{affinity};
83870398
DB
3585 }
3586
1476b99f 3587 push @$cmd, $kvm_binary;
1e3baf05
DM
3588
3589 push @$cmd, '-id', $vmid;
3590
e4d4cda1
HR
3591 my $vmname = $conf->{name} || "vm$vmid";
3592
6884a7d7 3593 push @$cmd, '-name', "$vmname,debug-threads=on";
e4d4cda1 3594
27b25d03
SR
3595 push @$cmd, '-no-shutdown';
3596
1e3baf05
DM
3597 my $use_virtio = 0;
3598
d036e418 3599 my $qmpsocket = PVE::QemuServer::Helpers::qmp_socket($vmid);
378ad769 3600 push @$cmd, '-chardev', "socket,id=qmp,path=$qmpsocket,server=on,wait=off";
c971c4f2
AD
3601 push @$cmd, '-mon', "chardev=qmp,mode=control";
3602
2ea5fb7e 3603 if (min_version($machine_version, 2, 12)) {
b4496b9e 3604 push @$cmd, '-chardev', "socket,id=qmp-event,path=/var/run/qmeventd.sock,reconnect=5";
71bd73b5
DC
3605 push @$cmd, '-mon', "chardev=qmp-event,mode=control";
3606 }
1e3baf05 3607
d036e418 3608 push @$cmd, '-pidfile' , PVE::QemuServer::Helpers::pidfile_name($vmid);
19672434 3609
1e3baf05
DM
3610 push @$cmd, '-daemonize';
3611
2796e7d5 3612 if ($conf->{smbios1}) {
1f30ac3a
CE
3613 my $smbios_conf = parse_smbios1($conf->{smbios1});
3614 if ($smbios_conf->{base64}) {
3615 # Do not pass base64 flag to qemu
3616 delete $smbios_conf->{base64};
3617 my $smbios_string = "";
3618 foreach my $key (keys %$smbios_conf) {
3619 my $value;
3620 if ($key eq "uuid") {
3621 $value = $smbios_conf->{uuid}
3622 } else {
3623 $value = decode_base64($smbios_conf->{$key});
3624 }
3625 # qemu accepts any binary data, only commas need escaping by double comma
3626 $value =~ s/,/,,/g;
3627 $smbios_string .= "," . $key . "=" . $value if $value;
3628 }
3629 push @$cmd, '-smbios', "type=1" . $smbios_string;
3630 } else {
3631 push @$cmd, '-smbios', "type=1,$conf->{smbios1}";
3632 }
2796e7d5
DM
3633 }
3634
3edb45e7 3635 if ($conf->{bios} && $conf->{bios} eq 'ovmf') {
b5099b4f
SR
3636 my $d;
3637 if (my $efidisk = $conf->{efidisk0}) {
3638 $d = parse_drive('efidisk0', $efidisk);
3639 }
3640
90b20b15 3641 my ($ovmf_code, $ovmf_vars) = get_ovmf_files($arch, $d, $q35);
818c3b8d 3642 die "uefi base image '$ovmf_code' not found\n" if ! -f $ovmf_code;
2ddc0a5c 3643
818c3b8d 3644 my ($path, $format);
b4dc6475 3645 my $read_only_str = '';
b5099b4f 3646 if ($d) {
2ddc0a5c 3647 my ($storeid, $volname) = PVE::Storage::parse_volume_id($d->{file}, 1);
13bca7b4 3648 $format = $d->{format};
2ddc0a5c
DC
3649 if ($storeid) {
3650 $path = PVE::Storage::path($storecfg, $d->{file});
13bca7b4
WB
3651 if (!defined($format)) {
3652 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
3653 $format = qemu_img_format($scfg, $volname);
3654 }
2ddc0a5c
DC
3655 } else {
3656 $path = $d->{file};
13bca7b4
WB
3657 die "efidisk format must be specified\n"
3658 if !defined($format);
2ddc0a5c 3659 }
b4dc6475
FG
3660
3661 $read_only_str = ',readonly=on' if drive_is_read_only($conf, $d);
2ddc0a5c 3662 } else {
34e82fa2 3663 log_warn("no efidisk configured! Using temporary efivars disk.");
4dcce9ee 3664 $path = "/tmp/$vmid-ovmf.fd";
96ed3574 3665 PVE::Tools::file_copy($ovmf_vars, $path, -s $ovmf_vars);
13bca7b4 3666 $format = 'raw';
2ddc0a5c 3667 }
4dcce9ee 3668
818ce80e
DC
3669 my $size_str = "";
3670
3671 if ($format eq 'raw' && $version_guard->(4, 1, 2)) {
3672 $size_str = ",size=" . (-s $ovmf_vars);
3673 }
3674
738dc81c
TL
3675 # SPI flash does lots of read-modify-write OPs, without writeback this gets really slow #3329
3676 my $cache = "";
3677 if ($path =~ m/^rbd:/) {
3678 $cache = ',cache=writeback';
3679 $path .= ':rbd_cache_policy=writeback'; # avoid write-around, we *need* to cache writes too
3680 }
6aaad230 3681
378ad769 3682 push @$cmd, '-drive', "if=pflash,unit=0,format=raw,readonly=on,file=$ovmf_code";
b4dc6475 3683 push @$cmd, '-drive', "if=pflash,unit=1$cache,format=$format,id=drive-efidisk0$size_str,file=${path}${read_only_str}";
a783c78e
AD
3684 }
3685
483ceeab 3686 if ($q35) { # tell QEMU to load q35 config early
7583d156 3687 # we use different pcie-port hardware for qemu >= 4.0 for passthrough
2ea5fb7e 3688 if (min_version($machine_version, 4, 0)) {
7583d156
DC
3689 push @$devices, '-readconfig', '/usr/share/qemu-server/pve-q35-4.0.cfg';
3690 } else {
3691 push @$devices, '-readconfig', '/usr/share/qemu-server/pve-q35.cfg';
3692 }
3693 }
da8b4189 3694
cc181036
TL
3695 if (defined(my $fixups = qemu_created_version_fixups($conf, $forcemachine, $kvmver))) {
3696 push @$cmd, $fixups->@*;
3697 }
3698
844d8fa6
DC
3699 if ($conf->{vmgenid}) {
3700 push @$devices, '-device', 'vmgenid,guid='.$conf->{vmgenid};
3701 }
3702
d40e5e18 3703 # add usb controllers
4df98f2f 3704 my @usbcontrollers = PVE::QemuServer::USB::get_usb_controllers(
4862922a 3705 $conf, $bridges, $arch, $machine_type, $usbdesc->{format}, $MAX_USB_DEVICES, $machine_version);
d40e5e18 3706 push @$devices, @usbcontrollers if @usbcontrollers;
55655ebc 3707 my $vga = parse_vga($conf->{vga});
2fa3151e 3708
55655ebc
DC
3709 my $qxlnum = vga_conf_has_spice($conf->{vga});
3710 $vga->{type} = 'qxl' if $qxlnum;
2fa3151e 3711
55655ebc 3712 if (!$vga->{type}) {
869ad4a7
WB
3713 if ($arch eq 'aarch64') {
3714 $vga->{type} = 'virtio';
2ea5fb7e 3715 } elsif (min_version($machine_version, 2, 9)) {
55655ebc 3716 $vga->{type} = (!$winversion || $winversion >= 6) ? 'std' : 'cirrus';
a2a5cd64 3717 } else {
55655ebc 3718 $vga->{type} = ($winversion >= 6) ? 'std' : 'cirrus';
a2a5cd64 3719 }
5acbfe9e
DM
3720 }
3721
1e3baf05 3722 # enable absolute mouse coordinates (needed by vnc)
fa3b3ce0
TL
3723 my $tablet = $conf->{tablet};
3724 if (!defined($tablet)) {
5acbfe9e 3725 $tablet = $defaults->{tablet};
590e698c 3726 $tablet = 0 if $qxlnum; # disable for spice because it is not needed
55655ebc 3727 $tablet = 0 if $vga->{type} =~ m/^serial\d+$/; # disable if we use serial terminal (no vga card)
5acbfe9e
DM
3728 }
3729
d559309f
WB
3730 if ($tablet) {
3731 push @$devices, '-device', print_tabletdevice_full($conf, $arch) if $tablet;
3732 my $kbd = print_keyboarddevice_full($conf, $arch);
3733 push @$devices, '-device', $kbd if defined($kbd);
3734 }
b467f79a 3735
e5d611c3 3736 my $bootorder = device_bootorder($conf);
2141a802 3737
74c17b7a 3738 # host pci device passthrough
13d68979 3739 my ($kvm_off, $gpu_passthrough, $legacy_igd) = PVE::QemuServer::PCI::print_hostpci_devices(
41af2dfc 3740 $vmid, $conf, $devices, $vga, $winversion, $q35, $bridges, $arch, $machine_type, $bootorder);
1e3baf05
DM
3741
3742 # usb devices
ae36393d 3743 my $usb_dev_features = {};
2ea5fb7e 3744 $usb_dev_features->{spice_usb3} = 1 if min_version($machine_version, 4, 0);
ae36393d 3745
4df98f2f 3746 my @usbdevices = PVE::QemuServer::USB::get_usb_devices(
4862922a 3747 $conf, $usbdesc->{format}, $MAX_USB_DEVICES, $usb_dev_features, $bootorder, $machine_version);
d40e5e18 3748 push @$devices, @usbdevices if @usbdevices;
2141a802 3749
1e3baf05 3750 # serial devices
bae179aa 3751 for (my $i = 0; $i < $MAX_SERIAL_PORTS; $i++) {
fa3b3ce0
TL
3752 my $path = $conf->{"serial$i"} or next;
3753 if ($path eq 'socket') {
3754 my $socket = "/var/run/qemu-server/${vmid}.serial$i";
3755 push @$devices, '-chardev', "socket,id=serial$i,path=$socket,server=on,wait=off";
3756 # On aarch64, serial0 is the UART device. Qemu only allows
3757 # connecting UART devices via the '-serial' command line, as
3758 # the device has a fixed slot on the hardware...
3759 if ($arch eq 'aarch64' && $i == 0) {
3760 push @$devices, '-serial', "chardev:serial$i";
9f9d2fb2 3761 } else {
9f9d2fb2
DM
3762 push @$devices, '-device', "isa-serial,chardev=serial$i";
3763 }
fa3b3ce0
TL
3764 } else {
3765 die "no such serial device\n" if ! -c $path;
3766 push @$devices, '-chardev', "tty,id=serial$i,path=$path";
3767 push @$devices, '-device', "isa-serial,chardev=serial$i";
34978be3 3768 }
1e3baf05
DM
3769 }
3770
3771 # parallel devices
1989a89c 3772 for (my $i = 0; $i < $MAX_PARALLEL_PORTS; $i++) {
34978be3 3773 if (my $path = $conf->{"parallel$i"}) {
19672434 3774 die "no such parallel device\n" if ! -c $path;
32e69805 3775 my $devtype = $path =~ m!^/dev/usb/lp! ? 'tty' : 'parport';
4c5dbaf6 3776 push @$devices, '-chardev', "$devtype,id=parallel$i,path=$path";
5bdcf937 3777 push @$devices, '-device', "isa-parallel,chardev=parallel$i";
34978be3 3778 }
1e3baf05
DM
3779 }
3780
b01de199 3781 if (min_version($machine_version, 4, 0) && (my $audio = conf_has_audio($conf))) {
2e7b5925 3782 my $audiopciaddr = print_pci_addr("audio0", $bridges, $arch, $machine_type);
1cc5ed1b 3783 my $audio_devs = audio_devs($audio, $audiopciaddr, $machine_version);
b01de199 3784 push @$devices, @$audio_devs;
2e7b5925 3785 }
19672434 3786
f9dde219
SR
3787 add_tpm_device($vmid, $devices, $conf);
3788
1e3baf05
DM
3789 my $sockets = 1;
3790 $sockets = $conf->{smp} if $conf->{smp}; # old style - no longer iused
3791 $sockets = $conf->{sockets} if $conf->{sockets};
3792
3793 my $cores = $conf->{cores} || 1;
3bd18e48 3794
de9d1e55 3795 my $maxcpus = $sockets * $cores;
76267728 3796
de9d1e55 3797 my $vcpus = $conf->{vcpus} ? $conf->{vcpus} : $maxcpus;
76267728 3798
de9d1e55
AD
3799 my $allowed_vcpus = $cpuinfo->{cpus};
3800
483ceeab 3801 die "MAX $allowed_vcpus vcpus allowed per VM on this node\n" if ($allowed_vcpus < $maxcpus);
1e3baf05 3802
483ceeab 3803 if ($hotplug_features->{cpu} && min_version($machine_version, 2, 7)) {
69c81430
AD
3804 push @$cmd, '-smp', "1,sockets=$sockets,cores=$cores,maxcpus=$maxcpus";
3805 for (my $i = 2; $i <= $vcpus; $i++) {
3806 my $cpustr = print_cpu_device($conf,$i);
3807 push @$cmd, '-device', $cpustr;
3808 }
3809
3810 } else {
3811
3812 push @$cmd, '-smp', "$vcpus,sockets=$sockets,cores=$cores,maxcpus=$maxcpus";
3813 }
1e3baf05
DM
3814 push @$cmd, '-nodefaults';
3815
dbea4415 3816 push @$cmd, '-boot', "menu=on,strict=on,reboot-timeout=1000,splash=/usr/share/qemu-server/bootsplash.jpg";
1e3baf05 3817
6b64503e 3818 push @$cmd, '-no-acpi' if defined($conf->{acpi}) && $conf->{acpi} == 0;
1e3baf05 3819
6b64503e 3820 push @$cmd, '-no-reboot' if defined($conf->{reboot}) && $conf->{reboot} == 0;
1e3baf05 3821
84902837 3822 if ($vga->{type} && $vga->{type} !~ m/^serial\d+$/ && $vga->{type} ne 'none'){
4df98f2f
TL
3823 push @$devices, '-device', print_vga_device(
3824 $conf, $vga, $arch, $machine_version, $machine_type, undef, $qxlnum, $bridges);
6f070e39
TL
3825
3826 push @$cmd, '-display', 'egl-headless,gl=core' if $vga->{type} eq 'virtio-gl'; # VIRGL
3827
d036e418 3828 my $socket = PVE::QemuServer::Helpers::vnc_socket($vmid);
378ad769 3829 push @$cmd, '-vnc', "unix:$socket,password=on";
b7be4ba9 3830 } else {
55655ebc 3831 push @$cmd, '-vga', 'none' if $vga->{type} eq 'none';
b7be4ba9
AD
3832 push @$cmd, '-nographic';
3833 }
3834
1e3baf05 3835 # time drift fix
6b64503e 3836 my $tdf = defined($conf->{tdf}) ? $conf->{tdf} : $defaults->{tdf};
8c559505 3837 my $useLocaltime = $conf->{localtime};
1e3baf05 3838
4317f69f
AD
3839 if ($winversion >= 5) { # windows
3840 $useLocaltime = 1 if !defined($conf->{localtime});
7a131888 3841
4317f69f
AD
3842 # use time drift fix when acpi is enabled
3843 if (!(defined($conf->{acpi}) && $conf->{acpi} == 0)) {
3844 $tdf = 1 if !defined($conf->{tdf});
462e8d19 3845 }
4317f69f 3846 }
462e8d19 3847
4317f69f
AD
3848 if ($winversion >= 6) {
3849 push @$globalFlags, 'kvm-pit.lost_tick_policy=discard';
3850 push @$cmd, '-no-hpet';
1e3baf05
DM
3851 }
3852
8c559505
DM
3853 push @$rtcFlags, 'driftfix=slew' if $tdf;
3854
2f6f002c 3855 if ($conf->{startdate} && $conf->{startdate} ne 'now') {
8c559505
DM
3856 push @$rtcFlags, "base=$conf->{startdate}";
3857 } elsif ($useLocaltime) {
3858 push @$rtcFlags, 'base=localtime';
3859 }
1e3baf05 3860
58c64ad5
SR
3861 if ($forcecpu) {
3862 push @$cmd, '-cpu', $forcecpu;
3863 } else {
2f6f002c 3864 push @$cmd, get_cpu_options($conf, $arch, $kvm, $kvm_off, $machine_version, $winversion, $gpu_passthrough);
58c64ad5 3865 }
519ed28c 3866
0567a4d5 3867 PVE::QemuServer::Memory::config($conf, $vmid, $sockets, $cores, $defaults, $hotplug_features, $cmd);
370b05e7 3868
1e3baf05
DM
3869 push @$cmd, '-S' if $conf->{freeze};
3870
b20df606 3871 push @$cmd, '-k', $conf->{keyboard} if defined($conf->{keyboard});
1e3baf05 3872
48657158
MD
3873 my $guest_agent = parse_guest_agent($conf);
3874
3875 if ($guest_agent->{enabled}) {
d036e418 3876 my $qgasocket = PVE::QemuServer::Helpers::qmp_socket($vmid, 1);
378ad769 3877 push @$devices, '-chardev', "socket,path=$qgasocket,server=on,wait=off,id=qga0";
48657158 3878
60f03a11 3879 if (!$guest_agent->{type} || $guest_agent->{type} eq 'virtio') {
48657158
MD
3880 my $pciaddr = print_pci_addr("qga0", $bridges, $arch, $machine_type);
3881 push @$devices, '-device', "virtio-serial,id=qga0$pciaddr";
3882 push @$devices, '-device', 'virtserialport,chardev=qga0,name=org.qemu.guest_agent.0';
3883 } elsif ($guest_agent->{type} eq 'isa') {
3884 push @$devices, '-device', "isa-serial,chardev=qga0";
3885 }
ab6a046f
AD
3886 }
3887
e5d611c3
TL
3888 my $rng = $conf->{rng0} ? parse_rng($conf->{rng0}) : undef;
3889 if ($rng && $version_guard->(4, 1, 2)) {
05853188
SR
3890 check_rng_source($rng->{source});
3891
2cf61f33
SR
3892 my $max_bytes = $rng->{max_bytes} // $rng_fmt->{max_bytes}->{default};
3893 my $period = $rng->{period} // $rng_fmt->{period}->{default};
2cf61f33
SR
3894 my $limiter_str = "";
3895 if ($max_bytes) {
3896 $limiter_str = ",max-bytes=$max_bytes,period=$period";
3897 }
3898
2cf61f33 3899 my $rng_addr = print_pci_addr("rng0", $bridges, $arch, $machine_type);
2cf61f33
SR
3900 push @$devices, '-object', "rng-random,filename=$rng->{source},id=rng0";
3901 push @$devices, '-device', "virtio-rng-pci,rng=rng0$limiter_str$rng_addr";
3902 }
3903
1d794448 3904 my $spice_port;
2fa3151e 3905
f8ea1b30 3906 if ($qxlnum || $vga->{type} =~ /^virtio/) {
590e698c 3907 if ($qxlnum > 1) {
ac087616 3908 if ($winversion){
2f6f002c 3909 for (my $i = 1; $i < $qxlnum; $i++){
4df98f2f
TL
3910 push @$devices, '-device', print_vga_device(
3911 $conf, $vga, $arch, $machine_version, $machine_type, $i, $qxlnum, $bridges);
590e698c
DM
3912 }
3913 } else {
3914 # assume other OS works like Linux
55655ebc
DC
3915 my ($ram, $vram) = ("134217728", "67108864");
3916 if ($vga->{memory}) {
3917 $ram = PVE::Tools::convert_size($qxlnum*4*$vga->{memory}, 'mb' => 'b');
3918 $vram = PVE::Tools::convert_size($qxlnum*2*$vga->{memory}, 'mb' => 'b');
3919 }
3920 push @$cmd, '-global', "qxl-vga.ram_size=$ram";
3921 push @$cmd, '-global', "qxl-vga.vram_size=$vram";
2fa3151e
AD
3922 }
3923 }
3924
d559309f 3925 my $pciaddr = print_pci_addr("spice", $bridges, $arch, $machine_type);
95a4b4a9 3926
af0eba7e 3927 my $pfamily = PVE::Tools::get_host_address_family($nodename);
91152441
WB
3928 my @nodeaddrs = PVE::Tools::getaddrinfo_all('localhost', family => $pfamily);
3929 die "failed to get an ip address of type $pfamily for 'localhost'\n" if !@nodeaddrs;
4d316a63
AL
3930
3931 push @$devices, '-device', "virtio-serial,id=spice$pciaddr";
3932 push @$devices, '-chardev', "spicevmc,id=vdagent,name=vdagent";
3933 push @$devices, '-device', "virtserialport,chardev=vdagent,name=com.redhat.spice.0";
3934
91152441
WB
3935 my $localhost = PVE::Network::addr_to_ip($nodeaddrs[0]->{addr});
3936 $spice_port = PVE::Tools::next_spice_port($pfamily, $localhost);
943340a6 3937
4df98f2f
TL
3938 my $spice_enhancement_str = $conf->{spice_enhancements} // '';
3939 my $spice_enhancement = parse_property_string($spice_enhancements_fmt, $spice_enhancement_str);
caab114a
TL
3940 if ($spice_enhancement->{foldersharing}) {
3941 push @$devices, '-chardev', "spiceport,id=foldershare,name=org.spice-space.webdav.0";
3942 push @$devices, '-device', "virtserialport,chardev=foldershare,name=org.spice-space.webdav.0";
3943 }
c4df18db 3944
caab114a 3945 my $spice_opts = "tls-port=${spice_port},addr=$localhost,tls-ciphers=HIGH,seamless-migration=on";
4df98f2f
TL
3946 $spice_opts .= ",streaming-video=$spice_enhancement->{videostreaming}"
3947 if $spice_enhancement->{videostreaming};
3948
caab114a 3949 push @$devices, '-spice', "$spice_opts";
1011b570
DM
3950 }
3951
8d9ae0d2
DM
3952 # enable balloon by default, unless explicitly disabled
3953 if (!defined($conf->{balloon}) || $conf->{balloon}) {
3326ae19 3954 my $pciaddr = print_pci_addr("balloon0", $bridges, $arch, $machine_type);
c70e4ec3
AD
3955 my $ballooncmd = "virtio-balloon-pci,id=balloon0$pciaddr";
3956 $ballooncmd .= ",free-page-reporting=on" if min_version($machine_version, 6, 2);
3957 push @$devices, '-device', $ballooncmd;
8d9ae0d2 3958 }
1e3baf05 3959
0ea9541d
DM
3960 if ($conf->{watchdog}) {
3961 my $wdopts = parse_watchdog($conf->{watchdog});
3326ae19 3962 my $pciaddr = print_pci_addr("watchdog", $bridges, $arch, $machine_type);
0a40e8ea 3963 my $watchdog = $wdopts->{model} || 'i6300esb';
5bdcf937
AD
3964 push @$devices, '-device', "$watchdog$pciaddr";
3965 push @$devices, '-watchdog-action', $wdopts->{action} if $wdopts->{action};
0ea9541d
DM
3966 }
3967
1e3baf05 3968 my $vollist = [];
941e0c42 3969 my $scsicontroller = {};
26ee04b6 3970 my $ahcicontroller = {};
cdd20088 3971 my $scsihw = defined($conf->{scsihw}) ? $conf->{scsihw} : $defaults->{scsihw};
1e3baf05 3972
5881b913
DM
3973 # Add iscsi initiator name if available
3974 if (my $initiator = get_initiator_name()) {
3975 push @$devices, '-iscsi', "initiator-name=$initiator";
3976 }
3977
912792e2 3978 PVE::QemuConfig->foreach_volume($conf, sub {
1e3baf05
DM
3979 my ($ds, $drive) = @_;
3980
ff1a2432 3981 if (PVE::Storage::parse_volume_id($drive->{file}, 1)) {
3f11f0d7 3982 check_volume_storage_type($storecfg, $drive->{file});
1e3baf05 3983 push @$vollist, $drive->{file};
ff1a2432 3984 }
afdb31d5 3985
4dcce9ee
TL
3986 # ignore efidisk here, already added in bios/fw handling code above
3987 return if $drive->{interface} eq 'efidisk';
f9dde219
SR
3988 # similar for TPM
3989 return if $drive->{interface} eq 'tpmstate';
4dcce9ee 3990
1e3baf05 3991 $use_virtio = 1 if $ds =~ m/^virtio/;
3b408e82 3992
2141a802 3993 $drive->{bootindex} = $bootorder->{$ds} if $bootorder->{$ds};
3b408e82 3994
2f6f002c 3995 if ($drive->{interface} eq 'virtio'){
51f492cd
AD
3996 push @$cmd, '-object', "iothread,id=iothread-$ds" if $drive->{iothread};
3997 }
3998
2f6f002c 3999 if ($drive->{interface} eq 'scsi') {
cdd20088 4000
ee034f5c 4001 my ($maxdev, $controller, $controller_prefix) = scsihw_infos($conf, $drive);
6731a4cf 4002
b8fb1c03
SR
4003 die "scsi$drive->{index}: machine version 4.1~pve2 or higher is required to use more than 14 SCSI disks\n"
4004 if $drive->{index} > 13 && !&$version_guard(4, 1, 2);
4005
3326ae19 4006 my $pciaddr = print_pci_addr("$controller_prefix$controller", $bridges, $arch, $machine_type);
a1b7d579 4007 my $scsihw_type = $scsihw =~ m/^virtio-scsi-single/ ? "virtio-scsi-pci" : $scsihw;
fc8b40fd
AD
4008
4009 my $iothread = '';
4010 if($conf->{scsihw} && $conf->{scsihw} eq "virtio-scsi-single" && $drive->{iothread}){
4011 $iothread .= ",iothread=iothread-$controller_prefix$controller";
4012 push @$cmd, '-object', "iothread,id=iothread-$controller_prefix$controller";
e7a5104d 4013 } elsif ($drive->{iothread}) {
d80ad18c
MH
4014 log_warn(
4015 "iothread is only valid with virtio disk or virtio-scsi-single controller, ignoring\n"
4016 );
fc8b40fd
AD
4017 }
4018
6e11f143
AD
4019 my $queues = '';
4020 if($conf->{scsihw} && $conf->{scsihw} eq "virtio-scsi-single" && $drive->{queues}){
4021 $queues = ",num_queues=$drive->{queues}";
370b05e7 4022 }
6e11f143 4023
4df98f2f
TL
4024 push @$devices, '-device', "$scsihw_type,id=$controller_prefix$controller$pciaddr$iothread$queues"
4025 if !$scsicontroller->{$controller};
cdd20088 4026 $scsicontroller->{$controller}=1;
2f6f002c 4027 }
3b408e82 4028
26ee04b6 4029 if ($drive->{interface} eq 'sata') {
2f6f002c 4030 my $controller = int($drive->{index} / $PVE::QemuServer::Drive::MAX_SATA_DISKS);
3326ae19 4031 my $pciaddr = print_pci_addr("ahci$controller", $bridges, $arch, $machine_type);
4df98f2f
TL
4032 push @$devices, '-device', "ahci,id=ahci$controller,multifunction=on$pciaddr"
4033 if !$ahcicontroller->{$controller};
2f6f002c 4034 $ahcicontroller->{$controller}=1;
26ee04b6 4035 }
46f58b5f 4036
5921764c
SR
4037 my $pbs_conf = $pbs_backing->{$ds};
4038 my $pbs_name = undef;
4039 if ($pbs_conf) {
4040 $pbs_name = "drive-$ds-pbs";
4041 push @$devices, '-blockdev', print_pbs_blockdev($pbs_conf, $pbs_name);
4042 }
4043
6d5673c3
SR
4044 my $drive_cmd = print_drive_commandline_full(
4045 $storecfg, $vmid, $drive, $pbs_name, min_version($kvmver, 6, 0));
3dc33a72
FG
4046
4047 # extra protection for templates, but SATA and IDE don't support it..
75748d44 4048 $drive_cmd .= ',readonly=on' if drive_is_read_only($conf, $drive);
4ef13a7f 4049
15b21acc 4050 push @$devices, '-drive',$drive_cmd;
4df98f2f
TL
4051 push @$devices, '-device', print_drivedevice_full(
4052 $storecfg, $conf, $vmid, $drive, $bridges, $arch, $machine_type);
1e3baf05
DM
4053 });
4054
cc4d6182 4055 for (my $i = 0; $i < $MAX_NETS; $i++) {
2141a802
SR
4056 my $netname = "net$i";
4057
4058 next if !$conf->{$netname};
4059 my $d = parse_net($conf->{$netname});
d0a86b24 4060 next if !$d;
4ddd2ca2 4061 # save the MAC addr here (could be auto-gen. in some odd setups) for FDB registering later?
1e3baf05 4062
d0a86b24 4063 $use_virtio = 1 if $d->{model} eq 'virtio';
1e3baf05 4064
2141a802 4065 $d->{bootindex} = $bootorder->{$netname} if $bootorder->{$netname};
1e3baf05 4066
2141a802 4067 my $netdevfull = print_netdev_full($vmid, $conf, $arch, $d, $netname);
d0a86b24 4068 push @$devices, '-netdev', $netdevfull;
5bdcf937 4069
d0a86b24 4070 my $netdevicefull = print_netdevice_full(
0c03a390 4071 $vmid, $conf, $d, $netname, $bridges, $use_old_bios_files, $arch, $machine_type, $machine_version);
4df98f2f 4072
d0a86b24 4073 push @$devices, '-device', $netdevicefull;
5bdcf937 4074 }
1e3baf05 4075
6dbcb073 4076 if ($conf->{ivshmem}) {
4df98f2f 4077 my $ivshmem = parse_property_string($ivshmem_fmt, $conf->{ivshmem});
e3c27a6a 4078
6dbcb073
DC
4079 my $bus;
4080 if ($q35) {
4081 $bus = print_pcie_addr("ivshmem");
4082 } else {
4083 $bus = print_pci_addr("ivshmem", $bridges, $arch, $machine_type);
4084 }
e3c27a6a
TL
4085
4086 my $ivshmem_name = $ivshmem->{name} // $vmid;
4087 my $path = '/dev/shm/pve-shm-' . $ivshmem_name;
4088
6dbcb073 4089 push @$devices, '-device', "ivshmem-plain,memdev=ivshmem$bus,";
4df98f2f
TL
4090 push @$devices, '-object', "memory-backend-file,id=ivshmem,share=on,mem-path=$path"
4091 .",size=$ivshmem->{size}M";
6dbcb073
DC
4092 }
4093
2513b862
DC
4094 # pci.4 is nested in pci.1
4095 $bridges->{1} = 1 if $bridges->{4};
4096
3326ae19
TL
4097 if (!$q35) { # add pci bridges
4098 if (min_version($machine_version, 2, 3)) {
fc79e813
AD
4099 $bridges->{1} = 1;
4100 $bridges->{2} = 1;
4101 }
6731a4cf 4102 $bridges->{3} = 1 if $scsihw =~ m/^virtio-scsi-single/;
2513b862
DC
4103 }
4104
4105 for my $k (sort {$b cmp $a} keys %$bridges) {
4106 next if $q35 && $k < 4; # q35.cfg already includes bridges up to 3
13d68979
SR
4107
4108 my $k_name = $k;
4109 if ($k == 2 && $legacy_igd) {
4110 $k_name = "$k-igd";
4111 }
3326ae19 4112 my $pciaddr = print_pci_addr("pci.$k_name", undef, $arch, $machine_type);
2513b862 4113 my $devstr = "pci-bridge,id=pci.$k,chassis_nr=$k$pciaddr";
3326ae19
TL
4114
4115 if ($q35) { # add after -readconfig pve-q35.cfg
2513b862
DC
4116 splice @$devices, 2, 0, '-device', $devstr;
4117 } else {
4118 unshift @$devices, '-device', $devstr if $k > 0;
f8e83f05 4119 }
19672434
DM
4120 }
4121
ac0077cc
SR
4122 if (!$kvm) {
4123 push @$machineFlags, 'accel=tcg';
4124 }
4125
e5a6919c
FE
4126 push @$machineFlags, 'smm=off' if should_disable_smm($conf, $vga);
4127
ac0077cc
SR
4128 my $machine_type_min = $machine_type;
4129 if ($add_pve_version) {
4130 $machine_type_min =~ s/\+pve\d+$//;
4131 $machine_type_min .= "+pve$required_pve_version";
4132 }
4133 push @$machineFlags, "type=${machine_type_min}";
4134
5bdcf937 4135 push @$cmd, @$devices;
2f6f002c
TL
4136 push @$cmd, '-rtc', join(',', @$rtcFlags) if scalar(@$rtcFlags);
4137 push @$cmd, '-machine', join(',', @$machineFlags) if scalar(@$machineFlags);
4138 push @$cmd, '-global', join(',', @$globalFlags) if scalar(@$globalFlags);
8c559505 4139
7ceade4c
DC
4140 if (my $vmstate = $conf->{vmstate}) {
4141 my $statepath = PVE::Storage::path($storecfg, $vmstate);
24d1f93a 4142 push @$vollist, $vmstate;
7ceade4c 4143 push @$cmd, '-loadstate', $statepath;
b85666cf 4144 print "activating and using '$vmstate' as vmstate\n";
7ceade4c
DC
4145 }
4146
85fcf79e
FG
4147 if (PVE::QemuConfig->is_template($conf)) {
4148 # needed to workaround base volumes being read-only
4149 push @$cmd, '-snapshot';
4150 }
4151
76350670
DC
4152 # add custom args
4153 if ($conf->{args}) {
4154 my $aa = PVE::Tools::split_args($conf->{args});
4155 push @$cmd, @$aa;
4156 }
4157
1d794448 4158 return wantarray ? ($cmd, $vollist, $spice_port) : $cmd;
1e3baf05 4159}
19672434 4160
05853188
SR
4161sub check_rng_source {
4162 my ($source) = @_;
4163
4164 # mostly relevant for /dev/hwrng, but doesn't hurt to check others too
4165 die "cannot create VirtIO RNG device: source file '$source' doesn't exist\n"
4166 if ! -e $source;
4167
4168 my $rng_current = '/sys/devices/virtual/misc/hw_random/rng_current';
4169 if ($source eq '/dev/hwrng' && file_read_firstline($rng_current) eq 'none') {
4df98f2f
TL
4170 # Needs to abort, otherwise QEMU crashes on first rng access. Note that rng_current cannot
4171 # be changed to 'none' manually, so once the VM is past this point, it's no longer an issue.
4172 die "Cannot start VM with passed-through RNG device: '/dev/hwrng' exists, but"
4173 ." '$rng_current' is set to 'none'. Ensure that a compatible hardware-RNG is attached"
4174 ." to the host.\n";
05853188
SR
4175 }
4176}
4177
943340a6 4178sub spice_port {
1011b570 4179 my ($vmid) = @_;
943340a6 4180
0a13e08e 4181 my $res = mon_cmd($vmid, 'query-spice');
943340a6
DM
4182
4183 return $res->{'tls-port'} || $res->{'port'} || die "no spice port\n";
1011b570
DM
4184}
4185
86fdcfb2
DA
4186sub vm_devices_list {
4187 my ($vmid) = @_;
4188
0a13e08e 4189 my $res = mon_cmd($vmid, 'query-pci');
f721624b 4190 my $devices_to_check = [];
ceea9078
DM
4191 my $devices = {};
4192 foreach my $pcibus (@$res) {
f721624b
DC
4193 push @$devices_to_check, @{$pcibus->{devices}},
4194 }
4195
4196 while (@$devices_to_check) {
4197 my $to_check = [];
4198 for my $d (@$devices_to_check) {
4199 $devices->{$d->{'qdev_id'}} = 1 if $d->{'qdev_id'};
4200 next if !$d->{'pci_bridge'};
4201
4202 $devices->{$d->{'qdev_id'}} += scalar(@{$d->{'pci_bridge'}->{devices}});
4203 push @$to_check, @{$d->{'pci_bridge'}->{devices}};
f78cc802 4204 }
f721624b 4205 $devices_to_check = $to_check;
f78cc802
AD
4206 }
4207
0a13e08e 4208 my $resblock = mon_cmd($vmid, 'query-block');
f78cc802
AD
4209 foreach my $block (@$resblock) {
4210 if($block->{device} =~ m/^drive-(\S+)/){
4211 $devices->{$1} = 1;
1dc4f496
DM
4212 }
4213 }
86fdcfb2 4214
0a13e08e 4215 my $resmice = mon_cmd($vmid, 'query-mice');
3d7389fe
DM
4216 foreach my $mice (@$resmice) {
4217 if ($mice->{name} eq 'QEMU HID Tablet') {
4218 $devices->{tablet} = 1;
4219 last;
4220 }
4221 }
4222
deb091c5
DC
4223 # for usb devices there is no query-usb
4224 # but we can iterate over the entries in
4225 # qom-list path=/machine/peripheral
0a13e08e 4226 my $resperipheral = mon_cmd($vmid, 'qom-list', path => '/machine/peripheral');
deb091c5 4227 foreach my $per (@$resperipheral) {
c60cad61 4228 if ($per->{name} =~ m/^usb(?:redirdev)?\d+$/) {
deb091c5
DC
4229 $devices->{$per->{name}} = 1;
4230 }
4231 }
4232
1dc4f496 4233 return $devices;
86fdcfb2
DA
4234}
4235
ec21aa11 4236sub vm_deviceplug {
d559309f 4237 my ($storecfg, $conf, $vmid, $deviceid, $device, $arch, $machine_type) = @_;
ae57f6b3 4238
3392d6ca 4239 my $q35 = PVE::QemuServer::Machine::machine_type_is_q35($conf);
db656e5f 4240
95d6343b
DA
4241 my $devices_list = vm_devices_list($vmid);
4242 return 1 if defined($devices_list->{$deviceid});
4243
4df98f2f
TL
4244 # add PCI bridge if we need it for the device
4245 qemu_add_pci_bridge($storecfg, $conf, $vmid, $deviceid, $arch, $machine_type);
fee46675 4246
3d7389fe 4247 if ($deviceid eq 'tablet') {
d559309f 4248 qemu_deviceadd($vmid, print_tabletdevice_full($conf, $arch));
d559309f 4249 } elsif ($deviceid eq 'keyboard') {
d559309f 4250 qemu_deviceadd($vmid, print_keyboarddevice_full($conf, $arch));
c60cad61
DC
4251 } elsif ($deviceid =~ m/^usbredirdev(\d+)$/) {
4252 my $id = $1;
4253 qemu_spice_usbredir_chardev_add($vmid, "usbredirchardev$id");
4254 qemu_deviceadd($vmid, PVE::QemuServer::USB::print_spice_usbdevice($id, "xhci", $id + 1));
4eb68604 4255 } elsif ($deviceid =~ m/^usb(\d+)$/) {
c60cad61 4256 qemu_deviceadd($vmid, PVE::QemuServer::USB::print_usbdevice_full($conf, $deviceid, $device, {}, $1 + 1));
fee46675 4257 } elsif ($deviceid =~ m/^(virtio)(\d+)$/) {
22de899a
AD
4258 qemu_iothread_add($vmid, $deviceid, $device);
4259
3326ae19
TL
4260 qemu_driveadd($storecfg, $vmid, $device);
4261 my $devicefull = print_drivedevice_full($storecfg, $conf, $vmid, $device, undef, $arch, $machine_type);
fee46675 4262
3326ae19 4263 qemu_deviceadd($vmid, $devicefull);
fee46675
DM
4264 eval { qemu_deviceaddverify($vmid, $deviceid); };
4265 if (my $err = $@) {
63c2da2f
DM
4266 eval { qemu_drivedel($vmid, $deviceid); };
4267 warn $@ if $@;
fee46675 4268 die $err;
5e5dcb73 4269 }
2733141c 4270 } elsif ($deviceid =~ m/^(virtioscsi|scsihw)(\d+)$/) {
3326ae19
TL
4271 my $scsihw = defined($conf->{scsihw}) ? $conf->{scsihw} : "lsi";
4272 my $pciaddr = print_pci_addr($deviceid, undef, $arch, $machine_type);
a1b7d579 4273 my $scsihw_type = $scsihw eq 'virtio-scsi-single' ? "virtio-scsi-pci" : $scsihw;
2733141c 4274
3326ae19 4275 my $devicefull = "$scsihw_type,id=$deviceid$pciaddr";
fee46675 4276
fc8b40fd
AD
4277 if($deviceid =~ m/^virtioscsi(\d+)$/ && $device->{iothread}) {
4278 qemu_iothread_add($vmid, $deviceid, $device);
4279 $devicefull .= ",iothread=iothread-$deviceid";
4280 }
4281
6e11f143
AD
4282 if($deviceid =~ m/^virtioscsi(\d+)$/ && $device->{queues}) {
4283 $devicefull .= ",num_queues=$device->{queues}";
4284 }
4285
3326ae19
TL
4286 qemu_deviceadd($vmid, $devicefull);
4287 qemu_deviceaddverify($vmid, $deviceid);
fee46675 4288 } elsif ($deviceid =~ m/^(scsi)(\d+)$/) {
d559309f 4289 qemu_findorcreatescsihw($storecfg,$conf, $vmid, $device, $arch, $machine_type);
fee46675 4290 qemu_driveadd($storecfg, $vmid, $device);
a1b7d579 4291
acfc6ef8 4292 my $devicefull = print_drivedevice_full($storecfg, $conf, $vmid, $device, undef, $arch, $machine_type);
fee46675
DM
4293 eval { qemu_deviceadd($vmid, $devicefull); };
4294 if (my $err = $@) {
63c2da2f
DM
4295 eval { qemu_drivedel($vmid, $deviceid); };
4296 warn $@ if $@;
fee46675 4297 die $err;
a4f091a0 4298 }
fee46675 4299 } elsif ($deviceid =~ m/^(net)(\d+)$/) {
d1c1af4b 4300 return if !qemu_netdevadd($vmid, $conf, $arch, $device, $deviceid);
8718099c 4301
3392d6ca 4302 my $machine_type = PVE::QemuServer::Machine::qemu_machine_pxe($vmid, $conf);
0c03a390 4303 my $machine_version = PVE::QemuServer::Machine::extract_version($machine_type);
95d3be58
DC
4304 my $use_old_bios_files = undef;
4305 ($use_old_bios_files, $machine_type) = qemu_use_old_bios_files($machine_type);
8718099c 4306
4df98f2f 4307 my $netdevicefull = print_netdevice_full(
0c03a390 4308 $vmid, $conf, $device, $deviceid, undef, $use_old_bios_files, $arch, $machine_type, $machine_version);
95d3be58 4309 qemu_deviceadd($vmid, $netdevicefull);
79046fd1
DC
4310 eval {
4311 qemu_deviceaddverify($vmid, $deviceid);
4312 qemu_set_link_status($vmid, $deviceid, !$device->{link_down});
4313 };
fee46675
DM
4314 if (my $err = $@) {
4315 eval { qemu_netdevdel($vmid, $deviceid); };
4316 warn $@ if $@;
4317 die $err;
95d3be58 4318 }
fee46675 4319 } elsif (!$q35 && $deviceid =~ m/^(pci\.)(\d+)$/) {
40f28a9f 4320 my $bridgeid = $2;
d559309f 4321 my $pciaddr = print_pci_addr($deviceid, undef, $arch, $machine_type);
40f28a9f 4322 my $devicefull = "pci-bridge,id=pci.$bridgeid,chassis_nr=$bridgeid$pciaddr";
a1b7d579 4323
40f28a9f 4324 qemu_deviceadd($vmid, $devicefull);
fee46675 4325 qemu_deviceaddverify($vmid, $deviceid);
fee46675 4326 } else {
a1b7d579 4327 die "can't hotplug device '$deviceid'\n";
40f28a9f
AD
4328 }
4329
5e5dcb73 4330 return 1;
a4dea331
DA
4331}
4332
3eec5767 4333# fixme: this should raise exceptions on error!
ec21aa11 4334sub vm_deviceunplug {
f19d1c47 4335 my ($vmid, $conf, $deviceid) = @_;
873c2d69 4336
95d6343b
DA
4337 my $devices_list = vm_devices_list($vmid);
4338 return 1 if !defined($devices_list->{$deviceid});
4339
2141a802
SR
4340 my $bootdisks = PVE::QemuServer::Drive::get_bootdisks($conf);
4341 die "can't unplug bootdisk '$deviceid'\n" if grep {$_ eq $deviceid} @$bootdisks;
63c2da2f 4342
c60cad61 4343 if ($deviceid eq 'tablet' || $deviceid eq 'keyboard' || $deviceid eq 'xhci') {
3d7389fe 4344 qemu_devicedel($vmid, $deviceid);
c60cad61
DC
4345 } elsif ($deviceid =~ m/^usbredirdev\d+$/) {
4346 qemu_devicedel($vmid, $deviceid);
4347 qemu_devicedelverify($vmid, $deviceid);
4eb68604 4348 } elsif ($deviceid =~ m/^usb\d+$/) {
c60cad61
DC
4349 qemu_devicedel($vmid, $deviceid);
4350 qemu_devicedelverify($vmid, $deviceid);
63c2da2f 4351 } elsif ($deviceid =~ m/^(virtio)(\d+)$/) {
9a66c311 4352 my $device = parse_drive($deviceid, $conf->{$deviceid});
f19d1c47 4353
a8d0fec3
TL
4354 qemu_devicedel($vmid, $deviceid);
4355 qemu_devicedelverify($vmid, $deviceid);
4356 qemu_drivedel($vmid, $deviceid);
9a66c311 4357 qemu_iothread_del($vmid, $deviceid, $device);
2733141c 4358 } elsif ($deviceid =~ m/^(virtioscsi|scsihw)(\d+)$/) {
63c2da2f 4359 qemu_devicedel($vmid, $deviceid);
8ce30dde 4360 qemu_devicedelverify($vmid, $deviceid);
63c2da2f 4361 } elsif ($deviceid =~ m/^(scsi)(\d+)$/) {
9a66c311 4362 my $device = parse_drive($deviceid, $conf->{$deviceid});
cfc817c7 4363
a8d0fec3 4364 qemu_devicedel($vmid, $deviceid);
52b361af 4365 qemu_devicedelverify($vmid, $deviceid);
a8d0fec3 4366 qemu_drivedel($vmid, $deviceid);
a1b7d579 4367 qemu_deletescsihw($conf, $vmid, $deviceid);
8ce30dde 4368
9a66c311
FG
4369 qemu_iothread_del($vmid, "virtioscsi$device->{index}", $device)
4370 if $conf->{scsihw} && ($conf->{scsihw} eq 'virtio-scsi-single');
63c2da2f 4371 } elsif ($deviceid =~ m/^(net)(\d+)$/) {
a8d0fec3
TL
4372 qemu_devicedel($vmid, $deviceid);
4373 qemu_devicedelverify($vmid, $deviceid);
4374 qemu_netdevdel($vmid, $deviceid);
63c2da2f
DM
4375 } else {
4376 die "can't unplug device '$deviceid'\n";
2630d2a9
DA
4377 }
4378
5e5dcb73
DA
4379 return 1;
4380}
4381
c60cad61
DC
4382sub qemu_spice_usbredir_chardev_add {
4383 my ($vmid, $id) = @_;
4384
4385 mon_cmd($vmid, "chardev-add" , (
4386 id => $id,
4387 backend => {
4388 type => 'spicevmc',
4389 data => {
4390 type => "usbredir",
4391 },
4392 },
4393 ));
4394}
4395
5e5dcb73
DA
4396sub qemu_deviceadd {
4397 my ($vmid, $devicefull) = @_;
873c2d69 4398
d695b5b7
AD
4399 $devicefull = "driver=".$devicefull;
4400 my %options = split(/[=,]/, $devicefull);
f19d1c47 4401
0a13e08e 4402 mon_cmd($vmid, "device_add" , %options);
5e5dcb73 4403}
afdb31d5 4404
5e5dcb73 4405sub qemu_devicedel {
fee46675 4406 my ($vmid, $deviceid) = @_;
63c2da2f 4407
0a13e08e 4408 my $ret = mon_cmd($vmid, "device_del", id => $deviceid);
5e5dcb73
DA
4409}
4410
22de899a 4411sub qemu_iothread_add {
a8d0fec3 4412 my ($vmid, $deviceid, $device) = @_;
22de899a
AD
4413
4414 if ($device->{iothread}) {
4415 my $iothreads = vm_iothreads_list($vmid);
4416 qemu_objectadd($vmid, "iothread-$deviceid", "iothread") if !$iothreads->{"iothread-$deviceid"};
4417 }
4418}
4419
4420sub qemu_iothread_del {
a8d0fec3 4421 my ($vmid, $deviceid, $device) = @_;
22de899a 4422
22de899a
AD
4423 if ($device->{iothread}) {
4424 my $iothreads = vm_iothreads_list($vmid);
4425 qemu_objectdel($vmid, "iothread-$deviceid") if $iothreads->{"iothread-$deviceid"};
4426 }
4427}
4428
4d3f29ed 4429sub qemu_objectadd {
a8d0fec3 4430 my ($vmid, $objectid, $qomtype) = @_;
4d3f29ed 4431
0a13e08e 4432 mon_cmd($vmid, "object-add", id => $objectid, "qom-type" => $qomtype);
4d3f29ed
AD
4433
4434 return 1;
4435}
4436
4437sub qemu_objectdel {
a8d0fec3 4438 my ($vmid, $objectid) = @_;
4d3f29ed 4439
0a13e08e 4440 mon_cmd($vmid, "object-del", id => $objectid);
4d3f29ed
AD
4441
4442 return 1;
4443}
4444
5e5dcb73 4445sub qemu_driveadd {
fee46675 4446 my ($storecfg, $vmid, $device) = @_;
5e5dcb73 4447
6d5673c3
SR
4448 my $kvmver = get_running_qemu_version($vmid);
4449 my $io_uring = min_version($kvmver, 6, 0);
4450 my $drive = print_drive_commandline_full($storecfg, $vmid, $device, undef, $io_uring);
7a69fc3c 4451 $drive =~ s/\\/\\\\/g;
0a13e08e 4452 my $ret = PVE::QemuServer::Monitor::hmp_cmd($vmid, "drive_add auto \"$drive\"");
fee46675 4453
5e5dcb73 4454 # If the command succeeds qemu prints: "OK"
fee46675
DM
4455 return 1 if $ret =~ m/OK/s;
4456
4457 die "adding drive failed: $ret\n";
5e5dcb73 4458}
afdb31d5 4459
5e5dcb73 4460sub qemu_drivedel {
a8d0fec3 4461 my ($vmid, $deviceid) = @_;
873c2d69 4462
0a13e08e 4463 my $ret = PVE::QemuServer::Monitor::hmp_cmd($vmid, "drive_del drive-$deviceid");
5e5dcb73 4464 $ret =~ s/^\s+//;
a1b7d579 4465
63c2da2f 4466 return 1 if $ret eq "";
a1b7d579 4467
63c2da2f 4468 # NB: device not found errors mean the drive was auto-deleted and we ignore the error
a1b7d579
DM
4469 return 1 if $ret =~ m/Device \'.*?\' not found/s;
4470
63c2da2f 4471 die "deleting drive $deviceid failed : $ret\n";
5e5dcb73 4472}
f19d1c47 4473
5e5dcb73 4474sub qemu_deviceaddverify {
fee46675 4475 my ($vmid, $deviceid) = @_;
873c2d69 4476
5e5dcb73
DA
4477 for (my $i = 0; $i <= 5; $i++) {
4478 my $devices_list = vm_devices_list($vmid);
4479 return 1 if defined($devices_list->{$deviceid});
4480 sleep 1;
afdb31d5 4481 }
fee46675
DM
4482
4483 die "error on hotplug device '$deviceid'\n";
5e5dcb73 4484}
afdb31d5 4485
5e5dcb73
DA
4486
4487sub qemu_devicedelverify {
63c2da2f
DM
4488 my ($vmid, $deviceid) = @_;
4489
a1b7d579 4490 # need to verify that the device is correctly removed as device_del
63c2da2f 4491 # is async and empty return is not reliable
5e5dcb73 4492
5e5dcb73
DA
4493 for (my $i = 0; $i <= 5; $i++) {
4494 my $devices_list = vm_devices_list($vmid);
4495 return 1 if !defined($devices_list->{$deviceid});
4496 sleep 1;
afdb31d5 4497 }
63c2da2f
DM
4498
4499 die "error on hot-unplugging device '$deviceid'\n";
873c2d69
DA
4500}
4501
cdd20088 4502sub qemu_findorcreatescsihw {
d559309f 4503 my ($storecfg, $conf, $vmid, $device, $arch, $machine_type) = @_;
cfc817c7 4504
ee034f5c 4505 my ($maxdev, $controller, $controller_prefix) = scsihw_infos($conf, $device);
2733141c
AD
4506
4507 my $scsihwid="$controller_prefix$controller";
cfc817c7
DA
4508 my $devices_list = vm_devices_list($vmid);
4509
a8d0fec3 4510 if (!defined($devices_list->{$scsihwid})) {
d559309f 4511 vm_deviceplug($storecfg, $conf, $vmid, $scsihwid, $device, $arch, $machine_type);
cfc817c7 4512 }
fee46675 4513
cfc817c7
DA
4514 return 1;
4515}
4516
8ce30dde
AD
4517sub qemu_deletescsihw {
4518 my ($conf, $vmid, $opt) = @_;
4519
4520 my $device = parse_drive($opt, $conf->{$opt});
4521
a1511b3c 4522 if ($conf->{scsihw} && ($conf->{scsihw} eq 'virtio-scsi-single')) {
2733141c
AD
4523 vm_deviceunplug($vmid, $conf, "virtioscsi$device->{index}");
4524 return 1;
4525 }
4526
ee034f5c 4527 my ($maxdev, $controller, $controller_prefix) = scsihw_infos($conf, $device);
8ce30dde
AD
4528
4529 my $devices_list = vm_devices_list($vmid);
4530 foreach my $opt (keys %{$devices_list}) {
e0fd2b2f
FE
4531 if (is_valid_drivename($opt)) {
4532 my $drive = parse_drive($opt, $conf->{$opt});
a8d0fec3 4533 if ($drive->{interface} eq 'scsi' && $drive->{index} < (($maxdev-1)*($controller+1))) {
8ce30dde
AD
4534 return 1;
4535 }
4536 }
4537 }
4538
4539 my $scsihwid="scsihw$controller";
4540
4541 vm_deviceunplug($vmid, $conf, $scsihwid);
4542
4543 return 1;
4544}
4545
281fedb3 4546sub qemu_add_pci_bridge {
d559309f 4547 my ($storecfg, $conf, $vmid, $device, $arch, $machine_type) = @_;
40f28a9f
AD
4548
4549 my $bridges = {};
281fedb3
DM
4550
4551 my $bridgeid;
4552
d559309f 4553 print_pci_addr($device, $bridges, $arch, $machine_type);
40f28a9f
AD
4554
4555 while (my ($k, $v) = each %$bridges) {
4556 $bridgeid = $k;
4557 }
fee46675 4558 return 1 if !defined($bridgeid) || $bridgeid < 1;
281fedb3 4559
40f28a9f
AD
4560 my $bridge = "pci.$bridgeid";
4561 my $devices_list = vm_devices_list($vmid);
4562
281fedb3 4563 if (!defined($devices_list->{$bridge})) {
d559309f 4564 vm_deviceplug($storecfg, $conf, $vmid, $bridge, $arch, $machine_type);
40f28a9f 4565 }
281fedb3 4566
40f28a9f
AD
4567 return 1;
4568}
4569
25088687
DM
4570sub qemu_set_link_status {
4571 my ($vmid, $device, $up) = @_;
4572
0a13e08e 4573 mon_cmd($vmid, "set_link", name => $device,
25088687
DM
4574 up => $up ? JSON::true : JSON::false);
4575}
4576
2630d2a9 4577sub qemu_netdevadd {
d559309f 4578 my ($vmid, $conf, $arch, $device, $deviceid) = @_;
2630d2a9 4579
d559309f 4580 my $netdev = print_netdev_full($vmid, $conf, $arch, $device, $deviceid, 1);
73aa03b8 4581 my %options = split(/[=,]/, $netdev);
2630d2a9 4582
bf5aef9b
DC
4583 if (defined(my $vhost = $options{vhost})) {
4584 $options{vhost} = JSON::boolean(PVE::JSONSchema::parse_boolean($vhost));
4585 }
4586
4587 if (defined(my $queues = $options{queues})) {
4588 $options{queues} = $queues + 0;
4589 }
4590
0a13e08e 4591 mon_cmd($vmid, "netdev_add", %options);
73aa03b8 4592 return 1;
2630d2a9
DA
4593}
4594
4595sub qemu_netdevdel {
4596 my ($vmid, $deviceid) = @_;
4597
0a13e08e 4598 mon_cmd($vmid, "netdev_del", id => $deviceid);
2630d2a9
DA
4599}
4600
16521d63 4601sub qemu_usb_hotplug {
d559309f 4602 my ($storecfg, $conf, $vmid, $deviceid, $device, $arch, $machine_type) = @_;
16521d63
DC
4603
4604 return if !$device;
4605
4606 # remove the old one first
4607 vm_deviceunplug($vmid, $conf, $deviceid);
4608
4609 # check if xhci controller is necessary and available
c60cad61 4610 my $devicelist = vm_devices_list($vmid);
16521d63 4611
c60cad61
DC
4612 if (!$devicelist->{xhci}) {
4613 my $pciaddr = print_pci_addr("xhci", undef, $arch, $machine_type);
4614 qemu_deviceadd($vmid, PVE::QemuServer::USB::print_qemu_xhci_controller($pciaddr));
16521d63 4615 }
c60cad61
DC
4616
4617 # print_usbdevice_full expects the parsed device
16521d63
DC
4618 my $d = parse_usb_device($device->{host});
4619 $d->{usb3} = $device->{usb3};
4620
4621 # add the new one
d559309f 4622 vm_deviceplug($storecfg, $conf, $vmid, $deviceid, $d, $arch, $machine_type);
16521d63
DC
4623}
4624
838776ab 4625sub qemu_cpu_hotplug {
8edc9c08 4626 my ($vmid, $conf, $vcpus) = @_;
838776ab 4627
3392d6ca 4628 my $machine_type = PVE::QemuServer::Machine::get_current_qemu_machine($vmid);
1e881b75 4629
8edc9c08
AD
4630 my $sockets = 1;
4631 $sockets = $conf->{smp} if $conf->{smp}; # old style - no longer iused
4632 $sockets = $conf->{sockets} if $conf->{sockets};
4633 my $cores = $conf->{cores} || 1;
4634 my $maxcpus = $sockets * $cores;
838776ab 4635
8edc9c08 4636 $vcpus = $maxcpus if !$vcpus;
3a11fadb 4637
8edc9c08
AD
4638 die "you can't add more vcpus than maxcpus\n"
4639 if $vcpus > $maxcpus;
3a11fadb 4640
8edc9c08 4641 my $currentvcpus = $conf->{vcpus} || $maxcpus;
1e881b75 4642
eba3e64d 4643 if ($vcpus < $currentvcpus) {
1e881b75 4644
2ea5fb7e 4645 if (PVE::QemuServer::Machine::machine_version($machine_type, 2, 7)) {
1e881b75
AD
4646
4647 for (my $i = $currentvcpus; $i > $vcpus; $i--) {
4648 qemu_devicedel($vmid, "cpu$i");
4649 my $retry = 0;
4650 my $currentrunningvcpus = undef;
4651 while (1) {
65af8c31 4652 $currentrunningvcpus = mon_cmd($vmid, "query-cpus-fast");
1e881b75 4653 last if scalar(@{$currentrunningvcpus}) == $i-1;
961af8a3 4654 raise_param_exc({ vcpus => "error unplugging cpu$i" }) if $retry > 5;
1e881b75
AD
4655 $retry++;
4656 sleep 1;
4657 }
4658 #update conf after each succesfull cpu unplug
4659 $conf->{vcpus} = scalar(@{$currentrunningvcpus});
4660 PVE::QemuConfig->write_config($vmid, $conf);
4661 }
4662 } else {
961af8a3 4663 die "cpu hot-unplugging requires qemu version 2.7 or higher\n";
1e881b75
AD
4664 }
4665
4666 return;
4667 }
838776ab 4668
65af8c31 4669 my $currentrunningvcpus = mon_cmd($vmid, "query-cpus-fast");
961af8a3 4670 die "vcpus in running vm does not match its configuration\n"
8edc9c08 4671 if scalar(@{$currentrunningvcpus}) != $currentvcpus;
838776ab 4672
2ea5fb7e 4673 if (PVE::QemuServer::Machine::machine_version($machine_type, 2, 7)) {
eba3e64d
AD
4674
4675 for (my $i = $currentvcpus+1; $i <= $vcpus; $i++) {
4676 my $cpustr = print_cpu_device($conf, $i);
4677 qemu_deviceadd($vmid, $cpustr);
4678
4679 my $retry = 0;
4680 my $currentrunningvcpus = undef;
4681 while (1) {
65af8c31 4682 $currentrunningvcpus = mon_cmd($vmid, "query-cpus-fast");
eba3e64d 4683 last if scalar(@{$currentrunningvcpus}) == $i;
961af8a3 4684 raise_param_exc({ vcpus => "error hotplugging cpu$i" }) if $retry > 10;
eba3e64d
AD
4685 sleep 1;
4686 $retry++;
4687 }
4688 #update conf after each succesfull cpu hotplug
4689 $conf->{vcpus} = scalar(@{$currentrunningvcpus});
4690 PVE::QemuConfig->write_config($vmid, $conf);
4691 }
4692 } else {
4693
4694 for (my $i = $currentvcpus; $i < $vcpus; $i++) {
0a13e08e 4695 mon_cmd($vmid, "cpu-add", id => int($i));
eba3e64d 4696 }
838776ab
AD
4697 }
4698}
4699
affd2f88 4700sub qemu_block_set_io_throttle {
277ca170
WB
4701 my ($vmid, $deviceid,
4702 $bps, $bps_rd, $bps_wr, $iops, $iops_rd, $iops_wr,
9196a8ec
WB
4703 $bps_max, $bps_rd_max, $bps_wr_max, $iops_max, $iops_rd_max, $iops_wr_max,
4704 $bps_max_length, $bps_rd_max_length, $bps_wr_max_length,
4705 $iops_max_length, $iops_rd_max_length, $iops_wr_max_length) = @_;
affd2f88 4706
f3f323a3
AD
4707 return if !check_running($vmid) ;
4708
0a13e08e 4709 mon_cmd($vmid, "block_set_io_throttle", device => $deviceid,
277ca170
WB
4710 bps => int($bps),
4711 bps_rd => int($bps_rd),
4712 bps_wr => int($bps_wr),
4713 iops => int($iops),
4714 iops_rd => int($iops_rd),
4715 iops_wr => int($iops_wr),
4716 bps_max => int($bps_max),
4717 bps_rd_max => int($bps_rd_max),
4718 bps_wr_max => int($bps_wr_max),
4719 iops_max => int($iops_max),
4720 iops_rd_max => int($iops_rd_max),
9196a8ec
WB
4721 iops_wr_max => int($iops_wr_max),
4722 bps_max_length => int($bps_max_length),
4723 bps_rd_max_length => int($bps_rd_max_length),
4724 bps_wr_max_length => int($bps_wr_max_length),
4725 iops_max_length => int($iops_max_length),
4726 iops_rd_max_length => int($iops_rd_max_length),
4727 iops_wr_max_length => int($iops_wr_max_length),
277ca170 4728 );
f3f323a3 4729
affd2f88
AD
4730}
4731
c1175c92
AD
4732sub qemu_block_resize {
4733 my ($vmid, $deviceid, $storecfg, $volid, $size) = @_;
4734
ed221350 4735 my $running = check_running($vmid);
c1175c92 4736
7246e8f9 4737 $size = 0 if !PVE::Storage::volume_resize($storecfg, $volid, $size, $running);
c1175c92
AD
4738
4739 return if !$running;
4740
375db731
FE
4741 my $padding = (1024 - $size % 1024) % 1024;
4742 $size = $size + $padding;
4743
190c8461
SR
4744 mon_cmd(
4745 $vmid,
4746 "block_resize",
4747 device => $deviceid,
4748 size => int($size),
4749 timeout => 60,
4750 );
c1175c92
AD
4751}
4752
1ab0057c
AD
4753sub qemu_volume_snapshot {
4754 my ($vmid, $deviceid, $storecfg, $volid, $snap) = @_;
4755
ed221350 4756 my $running = check_running($vmid);
1ab0057c 4757
9d83932d 4758 if ($running && do_snapshots_with_qemu($storecfg, $volid, $deviceid)) {
0a13e08e 4759 mon_cmd($vmid, 'blockdev-snapshot-internal-sync', device => $deviceid, name => $snap);
e5eaa028
WL
4760 } else {
4761 PVE::Storage::volume_snapshot($storecfg, $volid, $snap);
4762 }
1ab0057c
AD
4763}
4764
fc46aff9
AD
4765sub qemu_volume_snapshot_delete {
4766 my ($vmid, $deviceid, $storecfg, $volid, $snap) = @_;
4767
ed221350 4768 my $running = check_running($vmid);
fc46aff9 4769
a2f1554b
AD
4770 if($running) {
4771
4772 $running = undef;
4773 my $conf = PVE::QemuConfig->load_config($vmid);
912792e2 4774 PVE::QemuConfig->foreach_volume($conf, sub {
a2f1554b
AD
4775 my ($ds, $drive) = @_;
4776 $running = 1 if $drive->{file} eq $volid;
4777 });
4778 }
4779
9d83932d 4780 if ($running && do_snapshots_with_qemu($storecfg, $volid, $deviceid)) {
0a13e08e 4781 mon_cmd($vmid, 'blockdev-snapshot-delete-internal-sync', device => $deviceid, name => $snap);
1ef7592f
AD
4782 } else {
4783 PVE::Storage::volume_snapshot_delete($storecfg, $volid, $snap, $running);
4784 }
fc46aff9
AD
4785}
4786
264e519f 4787sub set_migration_caps {
27a5be53 4788 my ($vmid, $savevm) = @_;
a89fded1 4789
acc10e51
SR
4790 my $qemu_support = eval { mon_cmd($vmid, "query-proxmox-support") };
4791
27a5be53
SR
4792 my $bitmap_prop = $savevm ? 'pbs-dirty-bitmap-savevm' : 'pbs-dirty-bitmap-migration';
4793 my $dirty_bitmaps = $qemu_support->{$bitmap_prop} ? 1 : 0;
4794
8b8345f3 4795 my $cap_ref = [];
a89fded1
AD
4796
4797 my $enabled_cap = {
8b8345f3 4798 "auto-converge" => 1,
0b0a47e8 4799 "xbzrle" => 1,
8b8345f3
DM
4800 "x-rdma-pin-all" => 0,
4801 "zero-blocks" => 0,
acc10e51 4802 "compress" => 0,
27a5be53 4803 "dirty-bitmaps" => $dirty_bitmaps,
a89fded1
AD
4804 };
4805
0a13e08e 4806 my $supported_capabilities = mon_cmd($vmid, "query-migrate-capabilities");
a89fded1 4807
8b8345f3 4808 for my $supported_capability (@$supported_capabilities) {
b463a3ce
SP
4809 push @$cap_ref, {
4810 capability => $supported_capability->{capability},
22430fa2
DM
4811 state => $enabled_cap->{$supported_capability->{capability}} ? JSON::true : JSON::false,
4812 };
a89fded1
AD
4813 }
4814
0a13e08e 4815 mon_cmd($vmid, "migrate-set-capabilities", capabilities => $cap_ref);
8b8345f3 4816}
a89fded1 4817
912792e2
FE
4818sub foreach_volid {
4819 my ($conf, $func, @param) = @_;
4820
4821 my $volhash = {};
4822
4823 my $test_volid = sub {
ae180b8f 4824 my ($key, $drive, $snapname) = @_;
912792e2 4825
ae180b8f 4826 my $volid = $drive->{file};
912792e2
FE
4827 return if !$volid;
4828
4829 $volhash->{$volid}->{cdrom} //= 1;
ae180b8f 4830 $volhash->{$volid}->{cdrom} = 0 if !drive_is_cdrom($drive);
912792e2 4831
ae180b8f 4832 my $replicate = $drive->{replicate} // 1;
912792e2
FE
4833 $volhash->{$volid}->{replicate} //= 0;
4834 $volhash->{$volid}->{replicate} = 1 if $replicate;
4835
4836 $volhash->{$volid}->{shared} //= 0;
ae180b8f 4837 $volhash->{$volid}->{shared} = 1 if $drive->{shared};
912792e2
FE
4838
4839 $volhash->{$volid}->{referenced_in_config} //= 0;
4840 $volhash->{$volid}->{referenced_in_config} = 1 if !defined($snapname);
4841
4842 $volhash->{$volid}->{referenced_in_snapshot}->{$snapname} = 1
4843 if defined($snapname);
ae180b8f
FE
4844
4845 my $size = $drive->{size};
4846 $volhash->{$volid}->{size} //= $size if $size;
4847
4848 $volhash->{$volid}->{is_vmstate} //= 0;
4849 $volhash->{$volid}->{is_vmstate} = 1 if $key eq 'vmstate';
4850
f9dde219
SR
4851 $volhash->{$volid}->{is_tpmstate} //= 0;
4852 $volhash->{$volid}->{is_tpmstate} = 1 if $key eq 'tpmstate0';
4853
ae180b8f
FE
4854 $volhash->{$volid}->{is_unused} //= 0;
4855 $volhash->{$volid}->{is_unused} = 1 if $key =~ /^unused\d+$/;
a6be63ac
FE
4856
4857 $volhash->{$volid}->{drivename} = $key if is_valid_drivename($key);
912792e2
FE
4858 };
4859
ae180b8f
FE
4860 my $include_opts = {
4861 extra_keys => ['vmstate'],
4862 include_unused => 1,
4863 };
4864
0b953b8e 4865 PVE::QemuConfig->foreach_volume_full($conf, $include_opts, $test_volid);
912792e2
FE
4866 foreach my $snapname (keys %{$conf->{snapshots}}) {
4867 my $snap = $conf->{snapshots}->{$snapname};
0b953b8e 4868 PVE::QemuConfig->foreach_volume_full($snap, $include_opts, $test_volid, $snapname);
912792e2
FE
4869 }
4870
4871 foreach my $volid (keys %$volhash) {
4872 &$func($volid, $volhash->{$volid}, @param);
4873 }
4874}
4875
81d95ae1 4876my $fast_plug_option = {
7498eb64 4877 'lock' => 1,
81d95ae1 4878 'name' => 1,
a1b7d579 4879 'onboot' => 1,
81d95ae1
DM
4880 'shares' => 1,
4881 'startup' => 1,
b0ec896e 4882 'description' => 1,
ec647db4 4883 'protection' => 1,
8cad5e9b 4884 'vmstatestorage' => 1,
9e784b11 4885 'hookscript' => 1,
b8e7068a 4886 'tags' => 1,
81d95ae1
DM
4887};
4888
71d9006b
AD
4889for my $opt (keys %$confdesc_cloudinit) {
4890 $fast_plug_option->{$opt} = 1;
4891};
4892
3a11fadb
DM
4893# hotplug changes in [PENDING]
4894# $selection hash can be used to only apply specified options, for
4895# example: { cores => 1 } (only apply changed 'cores')
4896# $errors ref is used to return error messages
c427973b 4897sub vmconfig_hotplug_pending {
3a11fadb 4898 my ($vmid, $conf, $storecfg, $selection, $errors) = @_;
c427973b 4899
8e90138a 4900 my $defaults = load_defaults();
045749f2
TL
4901 my $arch = get_vm_arch($conf);
4902 my $machine_type = get_vm_machine($conf, undef, $arch);
c427973b
DM
4903
4904 # commit values which do not have any impact on running VM first
3a11fadb
DM
4905 # Note: those option cannot raise errors, we we do not care about
4906 # $selection and always apply them.
4907
4908 my $add_error = sub {
4909 my ($opt, $msg) = @_;
4910 $errors->{$opt} = "hotplug problem - $msg";
4911 };
c427973b 4912
f16cf6c3
WB
4913 my $cloudinit_pending_properties = PVE::QemuServer::cloudinit_pending_properties();
4914
4915 my $cloudinit_record_changed = sub {
4916 my ($conf, $opt, $old, $new) = @_;
4917 return if !$cloudinit_pending_properties->{$opt};
4918
4919 my $ci = ($conf->{cloudinit} //= {});
4920
4921 my $recorded = $ci->{$opt};
a5409851
WB
4922 my %added = map { $_ => 1 } PVE::Tools::split_list(delete($ci->{added}) // '');
4923
4924 if (defined($new)) {
4925 if (defined($old)) {
4926 # an existing value is being modified
4927 if (defined($recorded)) {
4928 # the value was already not in sync
4929 if ($new eq $recorded) {
4930 # a value is being reverted to the cloud-init state:
4931 delete $ci->{$opt};
4932 delete $added{$opt};
4933 } else {
4934 # the value was changed multiple times, do nothing
4935 }
4936 } elsif ($added{$opt}) {
4937 # the value had been marked as added and is being changed, do nothing
4938 } else {
4939 # the value is new, record it:
4940 $ci->{$opt} = $old;
4941 }
f16cf6c3 4942 } else {
a5409851
WB
4943 # a new value is being added
4944 if (defined($recorded)) {
4945 # it was already not in sync
4946 if ($new eq $recorded) {
4947 # a value is being reverted to the cloud-init state:
4948 delete $ci->{$opt};
4949 delete $added{$opt};
4950 } else {
4951 # the value had temporarily been removed, do nothing
4952 }
4953 } elsif ($added{$opt}) {
4954 # the value had been marked as added already, do nothing
4955 } else {
4956 # the value is new, add it
4957 $added{$opt} = 1;
4958 }
f16cf6c3 4959 }
a5409851
WB
4960 } elsif (!defined($old)) {
4961 # a non-existent value is being removed? ignore...
f16cf6c3 4962 } else {
a5409851
WB
4963 # a value is being deleted
4964 if (defined($recorded)) {
4965 # a value was already recorded, just keep it
4966 } elsif ($added{$opt}) {
4967 # the value was marked as added, remove it
4968 delete $added{$opt};
f16cf6c3 4969 } else {
a5409851
WB
4970 # a previously unrecorded value is being removed, record the old value:
4971 $ci->{$opt} = $old;
f16cf6c3
WB
4972 }
4973 }
a5409851
WB
4974
4975 my $added = join(',', sort keys %added);
4976 $ci->{added} = $added if length($added);
f16cf6c3
WB
4977 };
4978
c427973b
DM
4979 my $changes = 0;
4980 foreach my $opt (keys %{$conf->{pending}}) { # add/change
81d95ae1 4981 if ($fast_plug_option->{$opt}) {
f16cf6c3
WB
4982 my $new = delete $conf->{pending}->{$opt};
4983 $cloudinit_record_changed->($conf, $opt, $conf->{$opt}, $new);
4984 $conf->{$opt} = $new;
c427973b
DM
4985 $changes = 1;
4986 }
4987 }
4988
4989 if ($changes) {
ffda963f 4990 PVE::QemuConfig->write_config($vmid, $conf);
c427973b
DM
4991 }
4992
c60cad61
DC
4993 my $ostype = $conf->{ostype};
4994 my $version = extract_version($machine_type, get_running_qemu_version($vmid));
b3c2bdd1 4995 my $hotplug_features = parse_hotplug_features(defined($conf->{hotplug}) ? $conf->{hotplug} : '1');
c60cad61
DC
4996 my $usb_hotplug = $hotplug_features->{usb}
4997 && min_version($version, 7, 1)
4998 && defined($ostype) && ($ostype eq 'l26' || windows_version($ostype) > 7);
c427973b 4999
5b65b00d 5000 my $cgroup = PVE::QemuServer::CGroup->new($vmid);
98bc3aeb 5001 my $pending_delete_hash = PVE::QemuConfig->parse_pending_delete($conf->{pending}->{delete});
f16cf6c3 5002
d321c4a9 5003 foreach my $opt (sort keys %$pending_delete_hash) {
3a11fadb 5004 next if $selection && !$selection->{$opt};
d321c4a9 5005 my $force = $pending_delete_hash->{$opt}->{force};
3a11fadb 5006 eval {
51a6f637
AD
5007 if ($opt eq 'hotplug') {
5008 die "skip\n" if ($conf->{hotplug} =~ /memory/);
5009 } elsif ($opt eq 'tablet') {
b3c2bdd1 5010 die "skip\n" if !$hotplug_features->{usb};
3a11fadb 5011 if ($defaults->{tablet}) {
d559309f
WB
5012 vm_deviceplug($storecfg, $conf, $vmid, 'tablet', $arch, $machine_type);
5013 vm_deviceplug($storecfg, $conf, $vmid, 'keyboard', $arch, $machine_type)
5014 if $arch eq 'aarch64';
3a11fadb 5015 } else {
d559309f
WB
5016 vm_deviceunplug($vmid, $conf, 'tablet');
5017 vm_deviceunplug($vmid, $conf, 'keyboard') if $arch eq 'aarch64';
3a11fadb 5018 }
c60cad61
DC
5019 } elsif ($opt =~ m/^usb(\d+)$/) {
5020 my $index = $1;
5021 die "skip\n" if !$usb_hotplug;
5022 vm_deviceunplug($vmid, $conf, "usbredirdev$index"); # if it's a spice port
5023 vm_deviceunplug($vmid, $conf, $opt);
8edc9c08 5024 } elsif ($opt eq 'vcpus') {
b3c2bdd1 5025 die "skip\n" if !$hotplug_features->{cpu};
8edc9c08 5026 qemu_cpu_hotplug($vmid, $conf, undef);
9c2f7069 5027 } elsif ($opt eq 'balloon') {
81d95ae1 5028 # enable balloon device is not hotpluggable
75b51053
DC
5029 die "skip\n" if defined($conf->{balloon}) && $conf->{balloon} == 0;
5030 # here we reset the ballooning value to memory
5031 my $balloon = $conf->{memory} || $defaults->{memory};
0a13e08e 5032 mon_cmd($vmid, "balloon", value => $balloon*1024*1024);
81d95ae1
DM
5033 } elsif ($fast_plug_option->{$opt}) {
5034 # do nothing
3eec5767 5035 } elsif ($opt =~ m/^net(\d+)$/) {
b3c2bdd1 5036 die "skip\n" if !$hotplug_features->{network};
3eec5767 5037 vm_deviceunplug($vmid, $conf, $opt);
74479ee9 5038 } elsif (is_valid_drivename($opt)) {
b3c2bdd1 5039 die "skip\n" if !$hotplug_features->{disk} || $opt =~ m/(ide|sata)(\d+)/;
19120f99 5040 vm_deviceunplug($vmid, $conf, $opt);
3dc38fbb 5041 vmconfig_delete_or_detach_drive($vmid, $storecfg, $conf, $opt, $force);
4d3f29ed
AD
5042 } elsif ($opt =~ m/^memory$/) {
5043 die "skip\n" if !$hotplug_features->{memory};
6779f1ac 5044 PVE::QemuServer::Memory::qemu_memory_hotplug($vmid, $conf, $defaults, $opt);
c8effec3 5045 } elsif ($opt eq 'cpuunits') {
0d318453 5046 $cgroup->change_cpu_shares(undef);
58be00f1 5047 } elsif ($opt eq 'cpulimit') {
25de70ae 5048 $cgroup->change_cpu_quota(undef, undef); # reset, cgroup module can better decide values
3d7389fe 5049 } else {
e56beeda 5050 die "skip\n";
3d7389fe 5051 }
3a11fadb
DM
5052 };
5053 if (my $err = $@) {
e56beeda
DM
5054 &$add_error($opt, $err) if $err ne "skip\n";
5055 } else {
f16cf6c3
WB
5056 my $old = delete $conf->{$opt};
5057 $cloudinit_record_changed->($conf, $opt, $old, undef);
98bc3aeb 5058 PVE::QemuConfig->remove_from_pending_delete($conf, $opt);
3d7389fe 5059 }
3d7389fe
DM
5060 }
5061
4b785da1 5062 my $cloudinit_opt;
3d7389fe 5063 foreach my $opt (keys %{$conf->{pending}}) {
3a11fadb 5064 next if $selection && !$selection->{$opt};
3d7389fe 5065 my $value = $conf->{pending}->{$opt};
3a11fadb 5066 eval {
51a6f637
AD
5067 if ($opt eq 'hotplug') {
5068 die "skip\n" if ($value =~ /memory/) || ($value !~ /memory/ && $conf->{hotplug} =~ /memory/);
5069 } elsif ($opt eq 'tablet') {
b3c2bdd1 5070 die "skip\n" if !$hotplug_features->{usb};
3a11fadb 5071 if ($value == 1) {
d559309f
WB
5072 vm_deviceplug($storecfg, $conf, $vmid, 'tablet', $arch, $machine_type);
5073 vm_deviceplug($storecfg, $conf, $vmid, 'keyboard', $arch, $machine_type)
5074 if $arch eq 'aarch64';
3a11fadb 5075 } elsif ($value == 0) {
d559309f
WB
5076 vm_deviceunplug($vmid, $conf, 'tablet');
5077 vm_deviceunplug($vmid, $conf, 'keyboard') if $arch eq 'aarch64';
3a11fadb 5078 }
c60cad61
DC
5079 } elsif ($opt =~ m/^usb(\d+)$/) {
5080 my $index = $1;
5081 die "skip\n" if !$usb_hotplug;
5082 my $d = eval { parse_property_string($usbdesc->{format}, $value) };
5083 my $id = $opt;
5084 if ($d->{host} eq 'spice') {
5085 $id = "usbredirdev$index";
5086 }
5087 qemu_usb_hotplug($storecfg, $conf, $vmid, $id, $d, $arch, $machine_type);
8edc9c08 5088 } elsif ($opt eq 'vcpus') {
b3c2bdd1 5089 die "skip\n" if !$hotplug_features->{cpu};
3a11fadb
DM
5090 qemu_cpu_hotplug($vmid, $conf, $value);
5091 } elsif ($opt eq 'balloon') {
81d95ae1 5092 # enable/disable balloning device is not hotpluggable
8fe689e7 5093 my $old_balloon_enabled = !!(!defined($conf->{balloon}) || $conf->{balloon});
a1b7d579 5094 my $new_balloon_enabled = !!(!defined($conf->{pending}->{balloon}) || $conf->{pending}->{balloon});
81d95ae1
DM
5095 die "skip\n" if $old_balloon_enabled != $new_balloon_enabled;
5096
3a11fadb 5097 # allow manual ballooning if shares is set to zero
4cc1efa6 5098 if ((defined($conf->{shares}) && ($conf->{shares} == 0))) {
9c2f7069 5099 my $balloon = $conf->{pending}->{balloon} || $conf->{memory} || $defaults->{memory};
0a13e08e 5100 mon_cmd($vmid, "balloon", value => $balloon*1024*1024);
9c2f7069 5101 }
a1b7d579 5102 } elsif ($opt =~ m/^net(\d+)$/) {
3eec5767 5103 # some changes can be done without hotplug
a1b7d579 5104 vmconfig_update_net($storecfg, $conf, $hotplug_features->{network},
d559309f 5105 $vmid, $opt, $value, $arch, $machine_type);
74479ee9 5106 } elsif (is_valid_drivename($opt)) {
f9dde219 5107 die "skip\n" if $opt eq 'efidisk0' || $opt eq 'tpmstate0';
a05cff86 5108 # some changes can be done without hotplug
9ed7a77c
WB
5109 my $drive = parse_drive($opt, $value);
5110 if (drive_is_cloudinit($drive)) {
4b785da1
WB
5111 $cloudinit_opt = [$opt, $drive];
5112 # apply all the other changes first, then generate the cloudinit disk
5113 die "skip\n";
9ed7a77c 5114 }
b3c2bdd1 5115 vmconfig_update_disk($storecfg, $conf, $hotplug_features->{disk},
9e7bce2c 5116 $vmid, $opt, $value, $arch, $machine_type);
4d3f29ed
AD
5117 } elsif ($opt =~ m/^memory$/) { #dimms
5118 die "skip\n" if !$hotplug_features->{memory};
6779f1ac 5119 $value = PVE::QemuServer::Memory::qemu_memory_hotplug($vmid, $conf, $defaults, $opt, $value);
c8effec3 5120 } elsif ($opt eq 'cpuunits') {
6b7ef5e5 5121 my $new_cpuunits = PVE::CGroup::clamp_cpu_shares($conf->{pending}->{$opt}); #clamp
0d318453 5122 $cgroup->change_cpu_shares($new_cpuunits);
58be00f1 5123 } elsif ($opt eq 'cpulimit') {
c6f773b8 5124 my $cpulimit = $conf->{pending}->{$opt} == 0 ? -1 : int($conf->{pending}->{$opt} * 100000);
5b65b00d 5125 $cgroup->change_cpu_quota($cpulimit, 100000);
74ea2c65
AD
5126 } elsif ($opt eq 'agent') {
5127 vmconfig_update_agent($conf, $opt, $value);
3a11fadb 5128 } else {
e56beeda 5129 die "skip\n"; # skip non-hot-pluggable options
3d7389fe 5130 }
3a11fadb 5131 };
4b785da1
WB
5132 if (my $err = $@) {
5133 &$add_error($opt, $err) if $err ne "skip\n";
5134 } else {
5135 $cloudinit_record_changed->($conf, $opt, $conf->{$opt}, $value);
5136 $conf->{$opt} = $value;
5137 delete $conf->{pending}->{$opt};
5138 }
5139 }
5140
5141 if (defined($cloudinit_opt)) {
5142 my ($opt, $drive) = @$cloudinit_opt;
5143 my $value = $conf->{pending}->{$opt};
5144 eval {
9660e606
WB
5145 my $temp = {%$conf, $opt => $value};
5146 PVE::QemuServer::Cloudinit::apply_cloudinit_config($temp, $vmid);
4b785da1
WB
5147 vmconfig_update_disk($storecfg, $conf, $hotplug_features->{disk},
5148 $vmid, $opt, $value, $arch, $machine_type);
5149 };
3a11fadb 5150 if (my $err = $@) {
e56beeda
DM
5151 &$add_error($opt, $err) if $err ne "skip\n";
5152 } else {
3a11fadb
DM
5153 $conf->{$opt} = $value;
5154 delete $conf->{pending}->{$opt};
3d7389fe 5155 }
3d7389fe 5156 }
c60cad61
DC
5157
5158 # unplug xhci controller if no usb device is left
5159 if ($usb_hotplug) {
5160 my $has_usb = 0;
5161 for (my $i = 0; $i < $MAX_USB_DEVICES; $i++) {
5162 next if !defined($conf->{"usb$i"});
5163 $has_usb = 1;
5164 last;
5165 }
5166 if (!$has_usb) {
5167 vm_deviceunplug($vmid, $conf, 'xhci');
5168 }
5169 }
5170
4df15a03 5171 PVE::QemuConfig->write_config($vmid, $conf);
94ec5e7c 5172
4b785da1
WB
5173 if ($hotplug_features->{cloudinit} && PVE::QemuServer::Cloudinit::has_changes($conf)) {
5174 PVE::QemuServer::vmconfig_update_cloudinit_drive($storecfg, $conf, $vmid);
94ec5e7c 5175 }
c427973b 5176}
055d554d 5177
3dc38fbb
WB
5178sub try_deallocate_drive {
5179 my ($storecfg, $vmid, $conf, $key, $drive, $rpcenv, $authuser, $force) = @_;
5180
5181 if (($force || $key =~ /^unused/) && !drive_is_cdrom($drive, 1)) {
5182 my $volid = $drive->{file};
5183 if (vm_is_volid_owner($storecfg, $vmid, $volid)) {
5184 my $sid = PVE::Storage::parse_volume_id($volid);
5185 $rpcenv->check($authuser, "/storage/$sid", ['Datastore.AllocateSpace']);
cee01bcb
WB
5186
5187 # check if the disk is really unused
cee01bcb 5188 die "unable to delete '$volid' - volume is still in use (snapshot?)\n"
e0fd2b2f 5189 if PVE::QemuServer::Drive::is_volume_in_use($storecfg, $conf, $key, $volid);
cee01bcb 5190 PVE::Storage::vdisk_free($storecfg, $volid);
3dc38fbb 5191 return 1;
40b977f3
WL
5192 } else {
5193 # If vm is not owner of this disk remove from config
5194 return 1;
3dc38fbb
WB
5195 }
5196 }
5197
d1c1af4b 5198 return;
3dc38fbb
WB
5199}
5200
5201sub vmconfig_delete_or_detach_drive {
5202 my ($vmid, $storecfg, $conf, $opt, $force) = @_;
5203
5204 my $drive = parse_drive($opt, $conf->{$opt});
5205
5206 my $rpcenv = PVE::RPCEnvironment::get();
5207 my $authuser = $rpcenv->get_user();
5208
5209 if ($force) {
5210 $rpcenv->check_vm_perm($authuser, $vmid, undef, ['VM.Config.Disk']);
5211 try_deallocate_drive($storecfg, $vmid, $conf, $opt, $drive, $rpcenv, $authuser, $force);
5212 } else {
5213 vmconfig_register_unused_drive($storecfg, $vmid, $conf, $drive);
5214 }
5215}
5216
98bc3aeb
OB
5217
5218
055d554d 5219sub vmconfig_apply_pending {
e97bbbb6 5220 my ($vmid, $conf, $storecfg, $errors, $skip_cloud_init) = @_;
eb5e482d 5221
a644de29
OB
5222 return if !scalar(keys %{$conf->{pending}});
5223
eb5e482d
OB
5224 my $add_apply_error = sub {
5225 my ($opt, $msg) = @_;
5226 my $err_msg = "unable to apply pending change $opt : $msg";
5227 $errors->{$opt} = $err_msg;
5228 warn $err_msg;
5229 };
c427973b
DM
5230
5231 # cold plug
055d554d 5232
98bc3aeb 5233 my $pending_delete_hash = PVE::QemuConfig->parse_pending_delete($conf->{pending}->{delete});
d321c4a9 5234 foreach my $opt (sort keys %$pending_delete_hash) {
fb4d1ba2 5235 my $force = $pending_delete_hash->{$opt}->{force};
eb5e482d 5236 eval {
3d48b95a
OB
5237 if ($opt =~ m/^unused/) {
5238 die "internal error";
5239 } elsif (defined($conf->{$opt}) && is_valid_drivename($opt)) {
eb5e482d 5240 vmconfig_delete_or_detach_drive($vmid, $storecfg, $conf, $opt, $force);
eb5e482d
OB
5241 }
5242 };
5243 if (my $err = $@) {
5244 $add_apply_error->($opt, $err);
055d554d 5245 } else {
98bc3aeb 5246 PVE::QemuConfig->remove_from_pending_delete($conf, $opt);
055d554d 5247 delete $conf->{$opt};
055d554d
DM
5248 }
5249 }
5250
3d48b95a 5251 PVE::QemuConfig->cleanup_pending($conf);
055d554d 5252
7a24c98a 5253 my $generate_cloudinit = $skip_cloud_init ? 0 : undef;
c930f99e 5254
055d554d 5255 foreach my $opt (keys %{$conf->{pending}}) { # add/change
3d48b95a 5256 next if $opt eq 'delete'; # just to be sure
eb5e482d 5257 eval {
3d48b95a 5258 if (defined($conf->{$opt}) && is_valid_drivename($opt)) {
eb5e482d 5259 vmconfig_register_unused_drive($storecfg, $vmid, $conf, parse_drive($opt, $conf->{$opt}))
eb5e482d
OB
5260 }
5261 };
5262 if (my $err = $@) {
5263 $add_apply_error->($opt, $err);
055d554d 5264 } else {
c930f99e
AD
5265
5266 if (is_valid_drivename($opt)) {
5267 my $drive = parse_drive($opt, $conf->{pending}->{$opt});
7a24c98a 5268 $generate_cloudinit //= 1 if drive_is_cloudinit($drive);
c930f99e
AD
5269 }
5270
eb5e482d 5271 $conf->{$opt} = delete $conf->{pending}->{$opt};
055d554d 5272 }
055d554d 5273 }
3d48b95a
OB
5274
5275 # write all changes at once to avoid unnecessary i/o
5276 PVE::QemuConfig->write_config($vmid, $conf);
7a24c98a 5277 if ($generate_cloudinit) {
4b785da1
WB
5278 if (PVE::QemuServer::Cloudinit::apply_cloudinit_config($conf, $vmid)) {
5279 # After successful generation and if there were changes to be applied, update the
5280 # config to drop the {cloudinit} entry.
5281 PVE::QemuConfig->write_config($vmid, $conf);
5282 }
5283 }
055d554d
DM
5284}
5285
3eec5767 5286sub vmconfig_update_net {
d559309f 5287 my ($storecfg, $conf, $hotplug, $vmid, $opt, $value, $arch, $machine_type) = @_;
3eec5767
DM
5288
5289 my $newnet = parse_net($value);
5290
5291 if ($conf->{$opt}) {
5292 my $oldnet = parse_net($conf->{$opt});
5293
0f1af9e7
OB
5294 if (safe_string_ne($oldnet->{model}, $newnet->{model}) ||
5295 safe_string_ne($oldnet->{macaddr}, $newnet->{macaddr}) ||
5296 safe_num_ne($oldnet->{queues}, $newnet->{queues}) ||
3eec5767
DM
5297 !($newnet->{bridge} && $oldnet->{bridge})) { # bridge/nat mode change
5298
5299 # for non online change, we try to hot-unplug
7196b757 5300 die "skip\n" if !$hotplug;
3eec5767
DM
5301 vm_deviceunplug($vmid, $conf, $opt);
5302 } else {
5303
5304 die "internal error" if $opt !~ m/net(\d+)/;
5305 my $iface = "tap${vmid}i$1";
a1b7d579 5306
0f1af9e7
OB
5307 if (safe_string_ne($oldnet->{bridge}, $newnet->{bridge}) ||
5308 safe_num_ne($oldnet->{tag}, $newnet->{tag}) ||
5309 safe_string_ne($oldnet->{trunks}, $newnet->{trunks}) ||
5310 safe_num_ne($oldnet->{firewall}, $newnet->{firewall})) {
3eec5767 5311 PVE::Network::tap_unplug($iface);
28e129cc
AD
5312
5313 if ($have_sdn) {
5314 PVE::Network::SDN::Zones::tap_plug($iface, $newnet->{bridge}, $newnet->{tag}, $newnet->{firewall}, $newnet->{trunks}, $newnet->{rate});
5315 } else {
5316 PVE::Network::tap_plug($iface, $newnet->{bridge}, $newnet->{tag}, $newnet->{firewall}, $newnet->{trunks}, $newnet->{rate});
5317 }
0f1af9e7 5318 } elsif (safe_num_ne($oldnet->{rate}, $newnet->{rate})) {
4f4fbeb0
WB
5319 # Rate can be applied on its own but any change above needs to
5320 # include the rate in tap_plug since OVS resets everything.
5321 PVE::Network::tap_rate_limit($iface, $newnet->{rate});
3eec5767 5322 }
38c590d9 5323
0f1af9e7 5324 if (safe_string_ne($oldnet->{link_down}, $newnet->{link_down})) {
25088687
DM
5325 qemu_set_link_status($vmid, $opt, !$newnet->{link_down});
5326 }
5327
38c590d9 5328 return 1;
3eec5767
DM
5329 }
5330 }
a1b7d579 5331
7196b757 5332 if ($hotplug) {
d559309f 5333 vm_deviceplug($storecfg, $conf, $vmid, $opt, $newnet, $arch, $machine_type);
38c590d9
DM
5334 } else {
5335 die "skip\n";
5336 }
3eec5767
DM
5337}
5338
74ea2c65
AD
5339sub vmconfig_update_agent {
5340 my ($conf, $opt, $value) = @_;
5341
5342 die "skip\n" if !$conf->{$opt};
5343
5344 my $hotplug_options = { fstrim_cloned_disks => 1 };
5345
5346 my $old_agent = parse_guest_agent($conf);
5347 my $agent = parse_guest_agent({$opt => $value});
5348
33f8b887 5349 for my $option (keys %$agent) { # added/changed options
74ea2c65
AD
5350 next if defined($hotplug_options->{$option});
5351 die "skip\n" if safe_string_ne($agent->{$option}, $old_agent->{$option});
5352 }
5353
33f8b887 5354 for my $option (keys %$old_agent) { # removed options
74ea2c65
AD
5355 next if defined($hotplug_options->{$option});
5356 die "skip\n" if safe_string_ne($old_agent->{$option}, $agent->{$option});
5357 }
33f8b887
TL
5358
5359 return; # either no actual change (e.g., format string reordered) or just hotpluggable changes
74ea2c65
AD
5360}
5361
a05cff86 5362sub vmconfig_update_disk {
9e7bce2c 5363 my ($storecfg, $conf, $hotplug, $vmid, $opt, $value, $arch, $machine_type) = @_;
a05cff86
DM
5364
5365 my $drive = parse_drive($opt, $value);
5366
4df98f2f
TL
5367 if ($conf->{$opt} && (my $old_drive = parse_drive($opt, $conf->{$opt}))) {
5368 my $media = $drive->{media} || 'disk';
5369 my $oldmedia = $old_drive->{media} || 'disk';
5370 die "unable to change media type\n" if $media ne $oldmedia;
a05cff86 5371
4df98f2f 5372 if (!drive_is_cdrom($old_drive)) {
a05cff86 5373
4df98f2f 5374 if ($drive->{file} ne $old_drive->{file}) {
a05cff86 5375
4df98f2f 5376 die "skip\n" if !$hotplug;
a05cff86 5377
4df98f2f
TL
5378 # unplug and register as unused
5379 vm_deviceunplug($vmid, $conf, $opt);
5380 vmconfig_register_unused_drive($storecfg, $vmid, $conf, $old_drive)
a1b7d579 5381
4df98f2f
TL
5382 } else {
5383 # update existing disk
5384
5385 # skip non hotpluggable value
5386 if (safe_string_ne($drive->{discard}, $old_drive->{discard}) ||
5387 safe_string_ne($drive->{iothread}, $old_drive->{iothread}) ||
5388 safe_string_ne($drive->{queues}, $old_drive->{queues}) ||
5389 safe_string_ne($drive->{cache}, $old_drive->{cache}) ||
e0e036e1
LN
5390 safe_string_ne($drive->{ssd}, $old_drive->{ssd}) ||
5391 safe_string_ne($drive->{ro}, $old_drive->{ro})) {
4df98f2f
TL
5392 die "skip\n";
5393 }
a05cff86 5394
4df98f2f
TL
5395 # apply throttle
5396 if (safe_num_ne($drive->{mbps}, $old_drive->{mbps}) ||
5397 safe_num_ne($drive->{mbps_rd}, $old_drive->{mbps_rd}) ||
5398 safe_num_ne($drive->{mbps_wr}, $old_drive->{mbps_wr}) ||
5399 safe_num_ne($drive->{iops}, $old_drive->{iops}) ||
5400 safe_num_ne($drive->{iops_rd}, $old_drive->{iops_rd}) ||
5401 safe_num_ne($drive->{iops_wr}, $old_drive->{iops_wr}) ||
5402 safe_num_ne($drive->{mbps_max}, $old_drive->{mbps_max}) ||
5403 safe_num_ne($drive->{mbps_rd_max}, $old_drive->{mbps_rd_max}) ||
5404 safe_num_ne($drive->{mbps_wr_max}, $old_drive->{mbps_wr_max}) ||
5405 safe_num_ne($drive->{iops_max}, $old_drive->{iops_max}) ||
5406 safe_num_ne($drive->{iops_rd_max}, $old_drive->{iops_rd_max}) ||
5407 safe_num_ne($drive->{iops_wr_max}, $old_drive->{iops_wr_max}) ||
5408 safe_num_ne($drive->{bps_max_length}, $old_drive->{bps_max_length}) ||
5409 safe_num_ne($drive->{bps_rd_max_length}, $old_drive->{bps_rd_max_length}) ||
5410 safe_num_ne($drive->{bps_wr_max_length}, $old_drive->{bps_wr_max_length}) ||
5411 safe_num_ne($drive->{iops_max_length}, $old_drive->{iops_max_length}) ||
5412 safe_num_ne($drive->{iops_rd_max_length}, $old_drive->{iops_rd_max_length}) ||
5413 safe_num_ne($drive->{iops_wr_max_length}, $old_drive->{iops_wr_max_length})) {
5414
5415 qemu_block_set_io_throttle(
5416 $vmid,"drive-$opt",
5417 ($drive->{mbps} || 0)*1024*1024,
5418 ($drive->{mbps_rd} || 0)*1024*1024,
5419 ($drive->{mbps_wr} || 0)*1024*1024,
5420 $drive->{iops} || 0,
5421 $drive->{iops_rd} || 0,
5422 $drive->{iops_wr} || 0,
5423 ($drive->{mbps_max} || 0)*1024*1024,
5424 ($drive->{mbps_rd_max} || 0)*1024*1024,
5425 ($drive->{mbps_wr_max} || 0)*1024*1024,
5426 $drive->{iops_max} || 0,
5427 $drive->{iops_rd_max} || 0,
5428 $drive->{iops_wr_max} || 0,
5429 $drive->{bps_max_length} || 1,
5430 $drive->{bps_rd_max_length} || 1,
5431 $drive->{bps_wr_max_length} || 1,
5432 $drive->{iops_max_length} || 1,
5433 $drive->{iops_rd_max_length} || 1,
5434 $drive->{iops_wr_max_length} || 1,
5435 );
a05cff86 5436
4df98f2f 5437 }
a1b7d579 5438
4df98f2f
TL
5439 return 1;
5440 }
4de1bb25 5441
4df98f2f 5442 } else { # cdrom
a1b7d579 5443
4df98f2f
TL
5444 if ($drive->{file} eq 'none') {
5445 mon_cmd($vmid, "eject", force => JSON::true, id => "$opt");
5446 if (drive_is_cloudinit($old_drive)) {
5447 vmconfig_register_unused_drive($storecfg, $vmid, $conf, $old_drive);
5448 }
5449 } else {
5450 my $path = get_iso_path($storecfg, $vmid, $drive->{file});
ce9fce79 5451
4df98f2f
TL
5452 # force eject if locked
5453 mon_cmd($vmid, "eject", force => JSON::true, id => "$opt");
ce9fce79 5454
4df98f2f
TL
5455 if ($path) {
5456 mon_cmd($vmid, "blockdev-change-medium",
5457 id => "$opt", filename => "$path");
4de1bb25 5458 }
a05cff86 5459 }
4df98f2f
TL
5460
5461 return 1;
a05cff86
DM
5462 }
5463 }
5464
a1b7d579 5465 die "skip\n" if !$hotplug || $opt =~ m/(ide|sata)(\d+)/;
4de1bb25 5466 # hotplug new disks
f7b4356f 5467 PVE::Storage::activate_volumes($storecfg, [$drive->{file}]) if $drive->{file} !~ m|^/dev/.+|;
d559309f 5468 vm_deviceplug($storecfg, $conf, $vmid, $opt, $drive, $arch, $machine_type);
a05cff86
DM
5469}
5470
9687287b
AD
5471sub vmconfig_update_cloudinit_drive {
5472 my ($storecfg, $conf, $vmid) = @_;
5473
5474 my $cloudinit_ds = undef;
5475 my $cloudinit_drive = undef;
5476
5477 PVE::QemuConfig->foreach_volume($conf, sub {
5478 my ($ds, $drive) = @_;
5479 if (PVE::QemuServer::drive_is_cloudinit($drive)) {
5480 $cloudinit_ds = $ds;
5481 $cloudinit_drive = $drive;
5482 }
5483 });
5484
5485 return if !$cloudinit_drive;
5486
4b785da1
WB
5487 if (PVE::QemuServer::Cloudinit::apply_cloudinit_config($conf, $vmid)) {
5488 PVE::QemuConfig->write_config($vmid, $conf);
5489 }
5490
9687287b
AD
5491 my $running = PVE::QemuServer::check_running($vmid);
5492
5493 if ($running) {
5494 my $path = PVE::Storage::path($storecfg, $cloudinit_drive->{file});
5495 if ($path) {
5496 mon_cmd($vmid, "eject", force => JSON::true, id => "$cloudinit_ds");
5497 mon_cmd($vmid, "blockdev-change-medium", id => "$cloudinit_ds", filename => "$path");
5498 }
5499 }
5500}
5501
13cfe3b7 5502# called in locked context by incoming migration
ba5396b5
FG
5503sub vm_migrate_get_nbd_disks {
5504 my ($storecfg, $conf, $replicated_volumes) = @_;
13cfe3b7
FG
5505
5506 my $local_volumes = {};
912792e2 5507 PVE::QemuConfig->foreach_volume($conf, sub {
13cfe3b7
FG
5508 my ($ds, $drive) = @_;
5509
5510 return if drive_is_cdrom($drive);
41c8671e 5511 return if $ds eq 'tpmstate0';
13cfe3b7
FG
5512
5513 my $volid = $drive->{file};
5514
5515 return if !$volid;
5516
5517 my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid);
5518
5519 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
5520 return if $scfg->{shared};
ba5396b5
FG
5521
5522 # replicated disks re-use existing state via bitmap
5523 my $use_existing = $replicated_volumes->{$volid} ? 1 : 0;
5524 $local_volumes->{$ds} = [$volid, $storeid, $volname, $drive, $use_existing];
13cfe3b7 5525 });
ba5396b5
FG
5526 return $local_volumes;
5527}
5528
5529# called in locked context by incoming migration
5530sub vm_migrate_alloc_nbd_disks {
5531 my ($storecfg, $vmid, $source_volumes, $storagemap) = @_;
13cfe3b7 5532
13cfe3b7 5533 my $nbd = {};
ba5396b5 5534 foreach my $opt (sort keys %$source_volumes) {
5668463b 5535 my ($volid, $storeid, $volname, $drive, $use_existing, $format) = @{$source_volumes->{$opt}};
ba5396b5
FG
5536
5537 if ($use_existing) {
5538 $nbd->{$opt}->{drivestr} = print_drive($drive);
5539 $nbd->{$opt}->{volid} = $volid;
5540 $nbd->{$opt}->{replicated} = 1;
13cfe3b7
FG
5541 next;
5542 }
13cfe3b7 5543
5668463b
FG
5544 # storage mapping + volname = regular migration
5545 # storage mapping + format = remote migration
5546 # order of precedence, filtered by whether storage supports it:
5547 # 1. explicit requested format
5548 # 2. format of current volume
5549 # 3. default format of storage
bf8fc5a3 5550 if (!$storagemap->{identity}) {
82a03671 5551 $storeid = PVE::JSONSchema::map_id($storagemap, $storeid);
13cfe3b7 5552 my ($defFormat, $validFormats) = PVE::Storage::storage_default_format($storecfg, $storeid);
5668463b
FG
5553 if (!$format || !grep { $format eq $_ } @$validFormats) {
5554 if ($volname) {
5555 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
5556 my $fileFormat = qemu_img_format($scfg, $volname);
5557 $format = $fileFormat
5558 if grep { $fileFormat eq $_ } @$validFormats;
5559 }
5560 $format //= $defFormat;
5561 }
13cfe3b7 5562 } else {
5668463b 5563 # can't happen for remote migration, so $volname is always defined
13cfe3b7
FG
5564 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
5565 $format = qemu_img_format($scfg, $volname);
5566 }
5567
4df98f2f
TL
5568 my $size = $drive->{size} / 1024;
5569 my $newvolid = PVE::Storage::vdisk_alloc($storecfg, $storeid, $vmid, $format, undef, $size);
13cfe3b7
FG
5570 my $newdrive = $drive;
5571 $newdrive->{format} = $format;
5572 $newdrive->{file} = $newvolid;
5573 my $drivestr = print_drive($newdrive);
ba5396b5
FG
5574 $nbd->{$opt}->{drivestr} = $drivestr;
5575 $nbd->{$opt}->{volid} = $newvolid;
13cfe3b7
FG
5576 }
5577
5578 return $nbd;
5579}
5580
5581# see vm_start_nolock for parameters, additionally:
5582# migrate_opts:
bf8fc5a3 5583# storagemap = parsed storage map for allocating NBD disks
3898a563
FG
5584sub vm_start {
5585 my ($storecfg, $vmid, $params, $migrate_opts) = @_;
5586
84da8217 5587 return PVE::QemuConfig->lock_config($vmid, sub {
3898a563
FG
5588 my $conf = PVE::QemuConfig->load_config($vmid, $migrate_opts->{migratedfrom});
5589
4ef13a7f
FG
5590 die "you can't start a vm if it's a template\n"
5591 if !$params->{skiptemplate} && PVE::QemuConfig->is_template($conf);
3898a563 5592
d544e0e0 5593 my $has_suspended_lock = PVE::QemuConfig->has_lock($conf, 'suspended');
8e0c97bb
SR
5594 my $has_backup_lock = PVE::QemuConfig->has_lock($conf, 'backup');
5595
5596 my $running = check_running($vmid, undef, $migrate_opts->{migratedfrom});
5597
5598 if ($has_backup_lock && $running) {
5599 # a backup is currently running, attempt to start the guest in the
5600 # existing QEMU instance
5601 return vm_resume($vmid);
5602 }
3898a563
FG
5603
5604 PVE::QemuConfig->check_lock($conf)
d544e0e0
FE
5605 if !($params->{skiplock} || $has_suspended_lock);
5606
5607 $params->{resume} = $has_suspended_lock || defined($conf->{vmstate});
3898a563 5608
8e0c97bb 5609 die "VM $vmid already running\n" if $running;
3898a563 5610
ba5396b5
FG
5611 if (my $storagemap = $migrate_opts->{storagemap}) {
5612 my $replicated = $migrate_opts->{replicated_volumes};
5613 my $disks = vm_migrate_get_nbd_disks($storecfg, $conf, $replicated);
5614 $migrate_opts->{nbd} = vm_migrate_alloc_nbd_disks($storecfg, $vmid, $disks, $storagemap);
5615
5616 foreach my $opt (keys %{$migrate_opts->{nbd}}) {
5617 $conf->{$opt} = $migrate_opts->{nbd}->{$opt}->{drivestr};
5618 }
5619 }
13cfe3b7 5620
84da8217 5621 return vm_start_nolock($storecfg, $vmid, $conf, $params, $migrate_opts);
3898a563
FG
5622 });
5623}
5624
5625
0c498cca
FG
5626# params:
5627# statefile => 'tcp', 'unix' for migration or path/volid for RAM state
5628# skiplock => 0/1, skip checking for config lock
4ef13a7f 5629# skiptemplate => 0/1, skip checking whether VM is template
0c498cca 5630# forcemachine => to force Qemu machine (rollback/migration)
58c64ad5 5631# forcecpu => a QEMU '-cpu' argument string to override get_cpu_options
0c498cca
FG
5632# timeout => in seconds
5633# paused => start VM in paused state (backup)
3898a563 5634# resume => resume from hibernation
5921764c
SR
5635# pbs-backing => {
5636# sata0 => {
5637# repository
5638# snapshot
5639# keyfile
5640# archive
5641# },
5642# virtio2 => ...
5643# }
0c498cca 5644# migrate_opts:
ba5396b5 5645# nbd => volumes for NBD exports (vm_migrate_alloc_nbd_disks)
0c498cca
FG
5646# migratedfrom => source node
5647# spice_ticket => used for spice migration, passed via tunnel/stdin
5648# network => CIDR of migration network
5649# type => secure/insecure - tunnel over encrypted connection or plain-text
0c498cca 5650# nbd_proto_version => int, 0 for TCP, 1 for UNIX
fd95d780 5651# replicated_volumes => which volids should be re-used with bitmaps for nbd migration
13d121d7
FE
5652# offline_volumes => new volids of offline migrated disks like tpmstate and cloudinit, not yet
5653# contained in config
3898a563
FG
5654sub vm_start_nolock {
5655 my ($storecfg, $vmid, $conf, $params, $migrate_opts) = @_;
1e3baf05 5656
3898a563
FG
5657 my $statefile = $params->{statefile};
5658 my $resume = $params->{resume};
3dcb98d5 5659
3898a563
FG
5660 my $migratedfrom = $migrate_opts->{migratedfrom};
5661 my $migration_type = $migrate_opts->{type};
7ceade4c 5662
84da8217
FG
5663 my $res = {};
5664
3898a563
FG
5665 # clean up leftover reboot request files
5666 eval { clear_reboot_request($vmid); };
5667 warn $@ if $@;
1e3baf05 5668
3898a563
FG
5669 if (!$statefile && scalar(keys %{$conf->{pending}})) {
5670 vmconfig_apply_pending($vmid, $conf, $storecfg);
5671 $conf = PVE::QemuConfig->load_config($vmid); # update/reload
5672 }
64457ed4 5673
3de134ef
WB
5674 # don't regenerate the ISO if the VM is started as part of a live migration
5675 # this way we can reuse the old ISO with the correct config
4b785da1
WB
5676 if (!$migratedfrom) {
5677 if (PVE::QemuServer::Cloudinit::apply_cloudinit_config($conf, $vmid)) {
5678 # FIXME: apply_cloudinit_config updates $conf in this case, and it would only drop
5679 # $conf->{cloudinit}, so we could just not do this?
5680 # But we do it above, so for now let's be consistent.
5681 $conf = PVE::QemuConfig->load_config($vmid); # update/reload
5682 }
5683 }
3de134ef 5684
13d121d7
FE
5685 # override offline migrated volumes, conf is out of date still
5686 if (my $offline_volumes = $migrate_opts->{offline_volumes}) {
5687 for my $key (sort keys $offline_volumes->%*) {
5688 my $parsed = parse_drive($key, $conf->{$key});
5689 $parsed->{file} = $offline_volumes->{$key};
5690 $conf->{$key} = print_drive($parsed);
5691 }
fd95d780
FG
5692 }
5693
3898a563 5694 my $defaults = load_defaults();
0c9a7596 5695
3898a563 5696 # set environment variable useful inside network script
eef93bc5
FG
5697 # for remote migration the config is available on the target node!
5698 if (!$migrate_opts->{remote_node}) {
5699 $ENV{PVE_MIGRATED_FROM} = $migratedfrom;
5700 }
6c47d546 5701
3898a563 5702 PVE::GuestHelpers::exec_hookscript($conf, $vmid, 'pre-start', 1);
9e784b11 5703
3898a563 5704 my $forcemachine = $params->{forcemachine};
ea1c2110 5705 my $forcecpu = $params->{forcecpu};
3898a563 5706 if ($resume) {
ea1c2110 5707 # enforce machine and CPU type on suspended vm to ensure HW compatibility
3898a563 5708 $forcemachine = $conf->{runningmachine};
ea1c2110 5709 $forcecpu = $conf->{runningcpu};
3898a563
FG
5710 print "Resuming suspended VM\n";
5711 }
7ceade4c 5712
5921764c
SR
5713 my ($cmd, $vollist, $spice_port) = config_to_command($storecfg, $vmid,
5714 $conf, $defaults, $forcemachine, $forcecpu, $params->{'pbs-backing'});
6c47d546 5715
3898a563
FG
5716 my $migration_ip;
5717 my $get_migration_ip = sub {
5718 my ($nodename) = @_;
b24e1ac2 5719
3898a563 5720 return $migration_ip if defined($migration_ip);
b24e1ac2 5721
3898a563 5722 my $cidr = $migrate_opts->{network};
0c498cca 5723
3898a563
FG
5724 if (!defined($cidr)) {
5725 my $dc_conf = PVE::Cluster::cfs_read_file('datacenter.cfg');
5726 $cidr = $dc_conf->{migration}->{network};
5727 }
b24e1ac2 5728
3898a563
FG
5729 if (defined($cidr)) {
5730 my $ips = PVE::Network::get_local_ip_from_cidr($cidr);
b24e1ac2 5731
3898a563
FG
5732 die "could not get IP: no address configured on local " .
5733 "node for network '$cidr'\n" if scalar(@$ips) == 0;
b24e1ac2 5734
3898a563
FG
5735 die "could not get IP: multiple addresses configured on local " .
5736 "node for network '$cidr'\n" if scalar(@$ips) > 1;
b24e1ac2 5737
3898a563
FG
5738 $migration_ip = @$ips[0];
5739 }
b24e1ac2 5740
3898a563
FG
5741 $migration_ip = PVE::Cluster::remote_node_ip($nodename, 1)
5742 if !defined($migration_ip);
b24e1ac2 5743
3898a563
FG
5744 return $migration_ip;
5745 };
b24e1ac2 5746
3898a563
FG
5747 if ($statefile) {
5748 if ($statefile eq 'tcp') {
05b2a4ae
FG
5749 my $migrate = $res->{migrate} = { proto => 'tcp' };
5750 $migrate->{addr} = "localhost";
3898a563
FG
5751 my $datacenterconf = PVE::Cluster::cfs_read_file('datacenter.cfg');
5752 my $nodename = nodename();
2de2d6f7 5753
3898a563
FG
5754 if (!defined($migration_type)) {
5755 if (defined($datacenterconf->{migration}->{type})) {
5756 $migration_type = $datacenterconf->{migration}->{type};
5757 } else {
5758 $migration_type = 'secure';
b7a5a225 5759 }
3898a563 5760 }
b7a5a225 5761
3898a563 5762 if ($migration_type eq 'insecure') {
05b2a4ae
FG
5763 $migrate->{addr} = $get_migration_ip->($nodename);
5764 $migrate->{addr} = "[$migrate->{addr}]" if Net::IP::ip_is_ipv6($migrate->{addr});
3898a563 5765 }
2de2d6f7 5766
3898a563 5767 my $pfamily = PVE::Tools::get_host_address_family($nodename);
05b2a4ae
FG
5768 $migrate->{port} = PVE::Tools::next_migrate_port($pfamily);
5769 $migrate->{uri} = "tcp:$migrate->{addr}:$migrate->{port}";
5770 push @$cmd, '-incoming', $migrate->{uri};
3898a563 5771 push @$cmd, '-S';
1c9d54bf 5772
3898a563
FG
5773 } elsif ($statefile eq 'unix') {
5774 # should be default for secure migrations as a ssh TCP forward
5775 # tunnel is not deterministic reliable ready and fails regurarly
5776 # to set up in time, so use UNIX socket forwards
05b2a4ae
FG
5777 my $migrate = $res->{migrate} = { proto => 'unix' };
5778 $migrate->{addr} = "/run/qemu-server/$vmid.migrate";
5779 unlink $migrate->{addr};
54323eed 5780
05b2a4ae
FG
5781 $migrate->{uri} = "unix:$migrate->{addr}";
5782 push @$cmd, '-incoming', $migrate->{uri};
3898a563 5783 push @$cmd, '-S';
1c9d54bf 5784
3898a563
FG
5785 } elsif (-e $statefile) {
5786 push @$cmd, '-loadstate', $statefile;
5787 } else {
5788 my $statepath = PVE::Storage::path($storecfg, $statefile);
5789 push @$vollist, $statefile;
5790 push @$cmd, '-loadstate', $statepath;
5791 }
5792 } elsif ($params->{paused}) {
5793 push @$cmd, '-S';
5794 }
5795
1fb1822e
DC
5796 my $start_timeout = $params->{timeout} // config_aware_timeout($conf, $resume);
5797
5798 my $pci_devices = {}; # host pci devices
74c17b7a 5799 for (my $i = 0; $i < $PVE::QemuServer::PCI::MAX_HOSTPCI_DEVICES; $i++) {
1fb1822e
DC
5800 my $dev = $conf->{"hostpci$i"} or next;
5801 $pci_devices->{$i} = parse_hostpci($dev);
5802 }
5803
9c85548f
DC
5804 # do not reserve pciid for mediated devices, sysfs will error out for duplicate assignment
5805 my $real_pci_devices = [ grep { !(defined($_->{mdev}) && scalar($_->{pciid}->@*) == 1) } values $pci_devices->%* ];
5806
5807 # map to a flat list of pci ids
5808 my $pci_id_list = [ map { $_->{id} } map { $_->{pciid}->@* } $real_pci_devices->@* ];
5809
1fb1822e
DC
5810 # reserve all PCI IDs before actually doing anything with them
5811 PVE::QemuServer::PCI::reserve_pci_usage($pci_id_list, $vmid, $start_timeout);
5812
5813 eval {
bbf96e0f 5814 my $uuid;
1fb1822e
DC
5815 for my $id (sort keys %$pci_devices) {
5816 my $d = $pci_devices->{$id};
5817 for my $dev ($d->{pciid}->@*) {
bbf96e0f
DC
5818 my $info = PVE::QemuServer::PCI::prepare_pci_device($vmid, $dev->{id}, $id, $d->{mdev});
5819
5820 # nvidia grid needs the uuid of the mdev as qemu parameter
5821 if ($d->{mdev} && !defined($uuid) && $info->{vendor} eq '10de') {
5822 $uuid = PVE::QemuServer::PCI::generate_mdev_uuid($vmid, $id);
5823 }
1fb1822e
DC
5824 }
5825 }
bbf96e0f 5826 push @$cmd, '-uuid', $uuid if defined($uuid);
1fb1822e
DC
5827 };
5828 if (my $err = $@) {
1b189121 5829 eval { cleanup_pci_devices($vmid, $conf) };
1fb1822e
DC
5830 warn $@ if $@;
5831 die $err;
3898a563 5832 }
1e3baf05 5833
3898a563 5834 PVE::Storage::activate_volumes($storecfg, $vollist);
1e3baf05 5835
3898a563 5836 eval {
6bbcd71f 5837 run_command(['/bin/systemctl', 'stop', "$vmid.scope"], outfunc => sub{}, errfunc => sub{});
3898a563
FG
5838 };
5839 # Issues with the above 'stop' not being fully completed are extremely rare, a very low
5840 # timeout should be more than enough here...
39abafc8 5841 PVE::Systemd::wait_for_unit_removed("$vmid.scope", 20);
3898a563 5842
6b7ef5e5 5843 my $cpuunits = PVE::CGroup::clamp_cpu_shares($conf->{cpuunits});
3898a563 5844
3898a563
FG
5845 my %run_params = (
5846 timeout => $statefile ? undef : $start_timeout,
5847 umask => 0077,
5848 noerr => 1,
5849 );
1e3baf05 5850
3898a563
FG
5851 # when migrating, prefix QEMU output so other side can pick up any
5852 # errors that might occur and show the user
5853 if ($migratedfrom) {
5854 $run_params{quiet} = 1;
5855 $run_params{logfunc} = sub { print "QEMU: $_[0]\n" };
5856 }
8bf30c2a 5857
212220a4 5858 my %systemd_properties = (
3898a563 5859 Slice => 'qemu.slice',
354e61aa
SR
5860 KillMode => 'process',
5861 SendSIGKILL => 0,
5862 TimeoutStopUSec => ULONG_MAX, # infinity
3898a563 5863 );
7023f3ea 5864
6cbd3eb8 5865 if (PVE::CGroup::cgroup_mode() == 2) {
212220a4 5866 $systemd_properties{CPUWeight} = $cpuunits;
6cbd3eb8 5867 } else {
212220a4 5868 $systemd_properties{CPUShares} = $cpuunits;
6cbd3eb8
AD
5869 }
5870
3898a563 5871 if (my $cpulimit = $conf->{cpulimit}) {
212220a4 5872 $systemd_properties{CPUQuota} = int($cpulimit * 100);
3898a563 5873 }
212220a4 5874 $systemd_properties{timeout} = 10 if $statefile; # setting up the scope shoul be quick
7023f3ea 5875
3898a563
FG
5876 my $run_qemu = sub {
5877 PVE::Tools::run_fork sub {
212220a4 5878 PVE::Systemd::enter_systemd_scope($vmid, "Proxmox VE VM $vmid", %systemd_properties);
6e0216d8 5879
f9dde219
SR
5880 my $tpmpid;
5881 if (my $tpm = $conf->{tpmstate0}) {
5882 # start the TPM emulator so QEMU can connect on start
5883 $tpmpid = start_swtpm($storecfg, $vmid, $tpm, $migratedfrom);
5884 }
5885
3898a563 5886 my $exitcode = run_command($cmd, %run_params);
f9dde219 5887 if ($exitcode) {
23bee97d
FE
5888 if ($tpmpid) {
5889 warn "stopping swtpm instance (pid $tpmpid) due to QEMU startup error\n";
5890 kill 'TERM', $tpmpid;
5891 }
f9dde219
SR
5892 die "QEMU exited with code $exitcode\n";
5893 }
503308ed 5894 };
3898a563 5895 };
503308ed 5896
3898a563 5897 if ($conf->{hugepages}) {
7023f3ea 5898
3898a563
FG
5899 my $code = sub {
5900 my $hugepages_topology = PVE::QemuServer::Memory::hugepages_topology($conf);
5901 my $hugepages_host_topology = PVE::QemuServer::Memory::hugepages_host_topology();
7023f3ea 5902
3898a563
FG
5903 PVE::QemuServer::Memory::hugepages_mount();
5904 PVE::QemuServer::Memory::hugepages_allocate($hugepages_topology, $hugepages_host_topology);
7023f3ea 5905
503308ed 5906 eval { $run_qemu->() };
3898a563 5907 if (my $err = $@) {
f36e9894
SR
5908 PVE::QemuServer::Memory::hugepages_reset($hugepages_host_topology)
5909 if !$conf->{keephugepages};
3898a563
FG
5910 die $err;
5911 }
77cde36b 5912
f36e9894
SR
5913 PVE::QemuServer::Memory::hugepages_pre_deallocate($hugepages_topology)
5914 if !$conf->{keephugepages};
3898a563
FG
5915 };
5916 eval { PVE::QemuServer::Memory::hugepages_update_locked($code); };
1e3baf05 5917
3898a563
FG
5918 } else {
5919 eval { $run_qemu->() };
5920 }
afdb31d5 5921
3898a563
FG
5922 if (my $err = $@) {
5923 # deactivate volumes if start fails
5924 eval { PVE::Storage::deactivate_volumes($storecfg, $vollist); };
1b189121
DC
5925 warn $@ if $@;
5926 eval { cleanup_pci_devices($vmid, $conf) };
5927 warn $@ if $@;
1fb1822e 5928
3898a563
FG
5929 die "start failed: $err";
5930 }
62de2cbd 5931
1fb1822e
DC
5932 # re-reserve all PCI IDs now that we can know the actual VM PID
5933 my $pid = PVE::QemuServer::Helpers::vm_running_locally($vmid);
5934 eval { PVE::QemuServer::PCI::reserve_pci_usage($pci_id_list, $vmid, undef, $pid) };
5935 warn $@ if $@;
5936
05b2a4ae
FG
5937 if (defined($res->{migrate})) {
5938 print "migration listens on $res->{migrate}->{uri}\n";
5939 } elsif ($statefile) {
3898a563
FG
5940 eval { mon_cmd($vmid, "cont"); };
5941 warn $@ if $@;
5942 }
2189246c 5943
3898a563 5944 #start nbd server for storage migration
13cfe3b7 5945 if (my $nbd = $migrate_opts->{nbd}) {
3898a563 5946 my $nbd_protocol_version = $migrate_opts->{nbd_proto_version} // 0;
2189246c 5947
3898a563
FG
5948 my $migrate_storage_uri;
5949 # nbd_protocol_version > 0 for unix socket support
eef93bc5 5950 if ($nbd_protocol_version > 0 && ($migration_type eq 'secure' || $migration_type eq 'websocket')) {
3898a563
FG
5951 my $socket_path = "/run/qemu-server/$vmid\_nbd.migrate";
5952 mon_cmd($vmid, "nbd-server-start", addr => { type => 'unix', data => { path => $socket_path } } );
5953 $migrate_storage_uri = "nbd:unix:$socket_path";
05b2a4ae 5954 $res->{migrate}->{unix_sockets} = [$socket_path];
3898a563
FG
5955 } else {
5956 my $nodename = nodename();
5957 my $localip = $get_migration_ip->($nodename);
5958 my $pfamily = PVE::Tools::get_host_address_family($nodename);
5959 my $storage_migrate_port = PVE::Tools::next_migrate_port($pfamily);
5960
4df98f2f
TL
5961 mon_cmd($vmid, "nbd-server-start", addr => {
5962 type => 'inet',
5963 data => {
5964 host => "${localip}",
5965 port => "${storage_migrate_port}",
5966 },
5967 });
3898a563
FG
5968 $localip = "[$localip]" if Net::IP::ip_is_ipv6($localip);
5969 $migrate_storage_uri = "nbd:${localip}:${storage_migrate_port}";
2189246c
AD
5970 }
5971
13cfe3b7 5972 foreach my $opt (sort keys %$nbd) {
ba5396b5
FG
5973 my $drivestr = $nbd->{$opt}->{drivestr};
5974 my $volid = $nbd->{$opt}->{volid};
3898a563 5975 mon_cmd($vmid, "nbd-server-add", device => "drive-$opt", writable => JSON::true );
84da8217
FG
5976 my $nbd_uri = "$migrate_storage_uri:exportname=drive-$opt";
5977 print "storage migration listens on $nbd_uri volume:$drivestr\n";
ba5396b5
FG
5978 print "re-using replicated volume: $opt - $volid\n"
5979 if $nbd->{$opt}->{replicated};
84da8217
FG
5980
5981 $res->{drives}->{$opt} = $nbd->{$opt};
5982 $res->{drives}->{$opt}->{nbd_uri} = $nbd_uri;
3898a563
FG
5983 }
5984 }
a89fded1 5985
3898a563
FG
5986 if ($migratedfrom) {
5987 eval {
5988 set_migration_caps($vmid);
5989 };
5990 warn $@ if $@;
5991
5992 if ($spice_port) {
5993 print "spice listens on port $spice_port\n";
84da8217 5994 $res->{spice_port} = $spice_port;
3898a563 5995 if ($migrate_opts->{spice_ticket}) {
4df98f2f
TL
5996 mon_cmd($vmid, "set_password", protocol => 'spice', password =>
5997 $migrate_opts->{spice_ticket});
3898a563 5998 mon_cmd($vmid, "expire_password", protocol => 'spice', time => "+30");
95a4b4a9 5999 }
3898a563 6000 }
95a4b4a9 6001
3898a563
FG
6002 } else {
6003 mon_cmd($vmid, "balloon", value => $conf->{balloon}*1024*1024)
6004 if !$statefile && $conf->{balloon};
25088687 6005
3898a563
FG
6006 foreach my $opt (keys %$conf) {
6007 next if $opt !~ m/^net\d+$/;
6008 my $nicconf = parse_net($conf->{$opt});
6009 qemu_set_link_status($vmid, $opt, 0) if $nicconf->{link_down};
e18b0b99 6010 }
21947fea 6011 add_nets_bridge_fdb($conf, $vmid);
3898a563 6012 }
a1b7d579 6013
3898a563
FG
6014 mon_cmd($vmid, 'qom-set',
6015 path => "machine/peripheral/balloon0",
6016 property => "guest-stats-polling-interval",
6017 value => 2) if (!defined($conf->{balloon}) || $conf->{balloon});
eb065317 6018
3898a563
FG
6019 if ($resume) {
6020 print "Resumed VM, removing state\n";
6021 if (my $vmstate = $conf->{vmstate}) {
6022 PVE::Storage::deactivate_volumes($storecfg, [$vmstate]);
6023 PVE::Storage::vdisk_free($storecfg, $vmstate);
7ceade4c 6024 }
ea1c2110 6025 delete $conf->@{qw(lock vmstate runningmachine runningcpu)};
3898a563
FG
6026 PVE::QemuConfig->write_config($vmid, $conf);
6027 }
7ceade4c 6028
3898a563 6029 PVE::GuestHelpers::exec_hookscript($conf, $vmid, 'post-start');
84da8217
FG
6030
6031 return $res;
1e3baf05
DM
6032}
6033
1e3baf05 6034sub vm_commandline {
b14477e7 6035 my ($storecfg, $vmid, $snapname) = @_;
1e3baf05 6036
ffda963f 6037 my $conf = PVE::QemuConfig->load_config($vmid);
1e3baf05 6038
e8a26810 6039 my ($forcemachine, $forcecpu);
b14477e7
RV
6040 if ($snapname) {
6041 my $snapshot = $conf->{snapshots}->{$snapname};
87d92707
TL
6042 die "snapshot '$snapname' does not exist\n" if !defined($snapshot);
6043
ea1c2110
SR
6044 # check for machine or CPU overrides in snapshot
6045 $forcemachine = $snapshot->{runningmachine};
6046 $forcecpu = $snapshot->{runningcpu};
092868c4 6047
87d92707 6048 $snapshot->{digest} = $conf->{digest}; # keep file digest for API
b14477e7 6049
b14477e7
RV
6050 $conf = $snapshot;
6051 }
6052
1e3baf05
DM
6053 my $defaults = load_defaults();
6054
e8a26810 6055 my $cmd = config_to_command($storecfg, $vmid, $conf, $defaults, $forcemachine, $forcecpu);
1e3baf05 6056
5930c1ff 6057 return PVE::Tools::cmd2string($cmd);
1e3baf05
DM
6058}
6059
6060sub vm_reset {
6061 my ($vmid, $skiplock) = @_;
6062
ffda963f 6063 PVE::QemuConfig->lock_config($vmid, sub {
1e3baf05 6064
ffda963f 6065 my $conf = PVE::QemuConfig->load_config($vmid);
1e3baf05 6066
ffda963f 6067 PVE::QemuConfig->check_lock($conf) if !$skiplock;
1e3baf05 6068
0a13e08e 6069 mon_cmd($vmid, "system_reset");
ff1a2432
DM
6070 });
6071}
6072
6073sub get_vm_volumes {
6074 my ($conf) = @_;
1e3baf05 6075
ff1a2432 6076 my $vollist = [];
d5769dc2 6077 foreach_volid($conf, sub {
392f8b5d 6078 my ($volid, $attr) = @_;
ff1a2432 6079
d5769dc2 6080 return if $volid =~ m|^/|;
ff1a2432 6081
d5769dc2
DM
6082 my ($sid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
6083 return if !$sid;
ff1a2432
DM
6084
6085 push @$vollist, $volid;
1e3baf05 6086 });
ff1a2432
DM
6087
6088 return $vollist;
6089}
6090
1b189121
DC
6091sub cleanup_pci_devices {
6092 my ($vmid, $conf) = @_;
6093
6094 foreach my $key (keys %$conf) {
6095 next if $key !~ m/^hostpci(\d+)$/;
6096 my $hostpciindex = $1;
6097 my $uuid = PVE::SysFSTools::generate_mdev_uuid($vmid, $hostpciindex);
6098 my $d = parse_hostpci($conf->{$key});
faf72d6c
TL
6099 if ($d->{mdev}) {
6100 # NOTE: avoid PVE::SysFSTools::pci_cleanup_mdev_device as it requires PCI ID and we
6101 # don't want to break ABI just for this two liner
6102 my $dev_sysfs_dir = "/sys/bus/mdev/devices/$uuid";
6103 PVE::SysFSTools::file_write("$dev_sysfs_dir/remove", "1") if -e $dev_sysfs_dir;
6104 }
1b189121
DC
6105 }
6106 PVE::QemuServer::PCI::remove_pci_reservation($vmid);
6107}
6108
ff1a2432 6109sub vm_stop_cleanup {
70b04821 6110 my ($storecfg, $vmid, $conf, $keepActive, $apply_pending_changes) = @_;
ff1a2432 6111
745fed70 6112 eval {
ff1a2432 6113
254575e9
DM
6114 if (!$keepActive) {
6115 my $vollist = get_vm_volumes($conf);
6116 PVE::Storage::deactivate_volumes($storecfg, $vollist);
f9dde219
SR
6117
6118 if (my $tpmdrive = $conf->{tpmstate0}) {
6119 my $tpm = parse_drive("tpmstate0", $tpmdrive);
6120 my ($storeid, $volname) = PVE::Storage::parse_volume_id($tpm->{file}, 1);
6121 if ($storeid) {
6122 PVE::Storage::unmap_volume($storecfg, $tpm->{file});
6123 }
6124 }
254575e9 6125 }
a1b7d579 6126
ab6a046f 6127 foreach my $ext (qw(mon qmp pid vnc qga)) {
961bfcb2
DM
6128 unlink "/var/run/qemu-server/${vmid}.$ext";
6129 }
a1b7d579 6130
6dbcb073 6131 if ($conf->{ivshmem}) {
4df98f2f 6132 my $ivshmem = parse_property_string($ivshmem_fmt, $conf->{ivshmem});
4c5a6a24
TL
6133 # just delete it for now, VMs which have this already open do not
6134 # are affected, but new VMs will get a separated one. If this
6135 # becomes an issue we either add some sort of ref-counting or just
6136 # add a "don't delete on stop" flag to the ivshmem format.
6dbcb073
DC
6137 unlink '/dev/shm/pve-shm-' . ($ivshmem->{name} // $vmid);
6138 }
6139
1b189121 6140 cleanup_pci_devices($vmid, $conf);
6ab45bd7 6141
70b04821 6142 vmconfig_apply_pending($vmid, $conf, $storecfg) if $apply_pending_changes;
745fed70
DM
6143 };
6144 warn $@ if $@; # avoid errors - just warn
1e3baf05
DM
6145}
6146
575d19da
DC
6147# call only in locked context
6148sub _do_vm_stop {
6149 my ($storecfg, $vmid, $skiplock, $nocheck, $timeout, $shutdown, $force, $keepActive) = @_;
9269013a 6150
575d19da
DC
6151 my $pid = check_running($vmid, $nocheck);
6152 return if !$pid;
1e3baf05 6153
575d19da
DC
6154 my $conf;
6155 if (!$nocheck) {
6156 $conf = PVE::QemuConfig->load_config($vmid);
6157 PVE::QemuConfig->check_lock($conf) if !$skiplock;
6158 if (!defined($timeout) && $shutdown && $conf->{startup}) {
6159 my $opts = PVE::JSONSchema::pve_parse_startup_order($conf->{startup});
6160 $timeout = $opts->{down} if $opts->{down};
e6c3b671 6161 }
575d19da
DC
6162 PVE::GuestHelpers::exec_hookscript($conf, $vmid, 'pre-stop');
6163 }
19672434 6164
575d19da
DC
6165 eval {
6166 if ($shutdown) {
a2af1bbe 6167 if (defined($conf) && get_qga_key($conf, 'enabled')) {
0a13e08e 6168 mon_cmd($vmid, "guest-shutdown", timeout => $timeout);
9269013a 6169 } else {
0a13e08e 6170 mon_cmd($vmid, "system_powerdown");
1e3baf05
DM
6171 }
6172 } else {
0a13e08e 6173 mon_cmd($vmid, "quit");
1e3baf05 6174 }
575d19da
DC
6175 };
6176 my $err = $@;
1e3baf05 6177
575d19da
DC
6178 if (!$err) {
6179 $timeout = 60 if !defined($timeout);
1e3baf05
DM
6180
6181 my $count = 0;
e6c3b671 6182 while (($count < $timeout) && check_running($vmid, $nocheck)) {
1e3baf05
DM
6183 $count++;
6184 sleep 1;
6185 }
6186
6187 if ($count >= $timeout) {
575d19da
DC
6188 if ($force) {
6189 warn "VM still running - terminating now with SIGTERM\n";
6190 kill 15, $pid;
6191 } else {
6192 die "VM quit/powerdown failed - got timeout\n";
6193 }
6194 } else {
6195 vm_stop_cleanup($storecfg, $vmid, $conf, $keepActive, 1) if $conf;
6196 return;
1e3baf05 6197 }
575d19da 6198 } else {
d60cbb97
TL
6199 if (!check_running($vmid, $nocheck)) {
6200 warn "Unexpected: VM shutdown command failed, but VM not running anymore..\n";
6201 return;
6202 }
6203 if ($force) {
575d19da
DC
6204 warn "VM quit/powerdown failed - terminating now with SIGTERM\n";
6205 kill 15, $pid;
6206 } else {
6207 die "VM quit/powerdown failed\n";
6208 }
6209 }
6210
6211 # wait again
6212 $timeout = 10;
6213
6214 my $count = 0;
6215 while (($count < $timeout) && check_running($vmid, $nocheck)) {
6216 $count++;
6217 sleep 1;
6218 }
6219
6220 if ($count >= $timeout) {
6221 warn "VM still running - terminating now with SIGKILL\n";
6222 kill 9, $pid;
6223 sleep 1;
6224 }
1e3baf05 6225
575d19da
DC
6226 vm_stop_cleanup($storecfg, $vmid, $conf, $keepActive, 1) if $conf;
6227}
6228
6229# Note: use $nocheck to skip tests if VM configuration file exists.
6230# We need that when migration VMs to other nodes (files already moved)
6231# Note: we set $keepActive in vzdump stop mode - volumes need to stay active
6232sub vm_stop {
6233 my ($storecfg, $vmid, $skiplock, $nocheck, $timeout, $shutdown, $force, $keepActive, $migratedfrom) = @_;
6234
6235 $force = 1 if !defined($force) && !$shutdown;
6236
6237 if ($migratedfrom){
6238 my $pid = check_running($vmid, $nocheck, $migratedfrom);
6239 kill 15, $pid if $pid;
6240 my $conf = PVE::QemuConfig->load_config($vmid, $migratedfrom);
6241 vm_stop_cleanup($storecfg, $vmid, $conf, $keepActive, 0);
6242 return;
6243 }
6244
6245 PVE::QemuConfig->lock_config($vmid, sub {
6246 _do_vm_stop($storecfg, $vmid, $skiplock, $nocheck, $timeout, $shutdown, $force, $keepActive);
ff1a2432 6247 });
1e3baf05
DM
6248}
6249
165411f0
DC
6250sub vm_reboot {
6251 my ($vmid, $timeout) = @_;
6252
6253 PVE::QemuConfig->lock_config($vmid, sub {
66026117 6254 eval {
165411f0 6255
66026117
OB
6256 # only reboot if running, as qmeventd starts it again on a stop event
6257 return if !check_running($vmid);
165411f0 6258
66026117 6259 create_reboot_request($vmid);
165411f0 6260
66026117
OB
6261 my $storecfg = PVE::Storage::config();
6262 _do_vm_stop($storecfg, $vmid, undef, undef, $timeout, 1);
165411f0 6263
66026117
OB
6264 };
6265 if (my $err = $@) {
3c1c3fe6 6266 # avoid that the next normal shutdown will be confused for a reboot
66026117
OB
6267 clear_reboot_request($vmid);
6268 die $err;
6269 }
165411f0
DC
6270 });
6271}
6272
75c24bba 6273# note: if using the statestorage parameter, the caller has to check privileges
1e3baf05 6274sub vm_suspend {
48b4cdc2 6275 my ($vmid, $skiplock, $includestate, $statestorage) = @_;
159719e5
DC
6276
6277 my $conf;
6278 my $path;
6279 my $storecfg;
6280 my $vmstate;
1e3baf05 6281
ffda963f 6282 PVE::QemuConfig->lock_config($vmid, sub {
1e3baf05 6283
159719e5 6284 $conf = PVE::QemuConfig->load_config($vmid);
1e3baf05 6285
159719e5 6286 my $is_backing_up = PVE::QemuConfig->has_lock($conf, 'backup');
e79706d4 6287 PVE::QemuConfig->check_lock($conf)
159719e5
DC
6288 if !($skiplock || $is_backing_up);
6289
6290 die "cannot suspend to disk during backup\n"
6291 if $is_backing_up && $includestate;
bcb7c9cf 6292
159719e5
DC
6293 if ($includestate) {
6294 $conf->{lock} = 'suspending';
6295 my $date = strftime("%Y-%m-%d", localtime(time()));
6296 $storecfg = PVE::Storage::config();
75c24bba
DC
6297 if (!$statestorage) {
6298 $statestorage = find_vmstate_storage($conf, $storecfg);
6299 # check permissions for the storage
6300 my $rpcenv = PVE::RPCEnvironment::get();
6301 if ($rpcenv->{type} ne 'cli') {
6302 my $authuser = $rpcenv->get_user();
6303 $rpcenv->check($authuser, "/storage/$statestorage", ['Datastore.AllocateSpace']);
6304 }
6305 }
6306
6307
4df98f2f
TL
6308 $vmstate = PVE::QemuConfig->__snapshot_save_vmstate(
6309 $vmid, $conf, "suspend-$date", $storecfg, $statestorage, 1);
159719e5
DC
6310 $path = PVE::Storage::path($storecfg, $vmstate);
6311 PVE::QemuConfig->write_config($vmid, $conf);
6312 } else {
0a13e08e 6313 mon_cmd($vmid, "stop");
159719e5 6314 }
1e3baf05 6315 });
159719e5
DC
6316
6317 if ($includestate) {
6318 # save vm state
6319 PVE::Storage::activate_volumes($storecfg, [$vmstate]);
6320
6321 eval {
27a5be53 6322 set_migration_caps($vmid, 1);
0a13e08e 6323 mon_cmd($vmid, "savevm-start", statefile => $path);
159719e5 6324 for(;;) {
0a13e08e 6325 my $state = mon_cmd($vmid, "query-savevm");
159719e5
DC
6326 if (!$state->{status}) {
6327 die "savevm not active\n";
6328 } elsif ($state->{status} eq 'active') {
6329 sleep(1);
6330 next;
6331 } elsif ($state->{status} eq 'completed') {
b0a9a385 6332 print "State saved, quitting\n";
159719e5
DC
6333 last;
6334 } elsif ($state->{status} eq 'failed' && $state->{error}) {
6335 die "query-savevm failed with error '$state->{error}'\n"
6336 } else {
6337 die "query-savevm returned status '$state->{status}'\n";
6338 }
6339 }
6340 };
6341 my $err = $@;
6342
6343 PVE::QemuConfig->lock_config($vmid, sub {
6344 $conf = PVE::QemuConfig->load_config($vmid);
6345 if ($err) {
6346 # cleanup, but leave suspending lock, to indicate something went wrong
6347 eval {
0a13e08e 6348 mon_cmd($vmid, "savevm-end");
159719e5
DC
6349 PVE::Storage::deactivate_volumes($storecfg, [$vmstate]);
6350 PVE::Storage::vdisk_free($storecfg, $vmstate);
ea1c2110 6351 delete $conf->@{qw(vmstate runningmachine runningcpu)};
159719e5
DC
6352 PVE::QemuConfig->write_config($vmid, $conf);
6353 };
6354 warn $@ if $@;
6355 die $err;
6356 }
6357
6358 die "lock changed unexpectedly\n"
6359 if !PVE::QemuConfig->has_lock($conf, 'suspending');
6360
0a13e08e 6361 mon_cmd($vmid, "quit");
159719e5
DC
6362 $conf->{lock} = 'suspended';
6363 PVE::QemuConfig->write_config($vmid, $conf);
6364 });
6365 }
1e3baf05
DM
6366}
6367
a20dc58a
FG
6368# $nocheck is set when called as part of a migration - in this context the
6369# location of the config file (source or target node) is not deterministic,
6370# since migration cannot wait for pmxcfs to process the rename
1e3baf05 6371sub vm_resume {
289e0b85 6372 my ($vmid, $skiplock, $nocheck) = @_;
1e3baf05 6373
ffda963f 6374 PVE::QemuConfig->lock_config($vmid, sub {
0a13e08e 6375 my $res = mon_cmd($vmid, 'query-status');
c2786bed 6376 my $resume_cmd = 'cont';
8e0c97bb 6377 my $reset = 0;
270bfff2
FG
6378 my $conf;
6379 if ($nocheck) {
6380 my $vmlist = PVE::Cluster::get_vmlist();
6381 my $node;
6382 if (exists($vmlist->{ids}->{$vmid})) {
6383 $node = $vmlist->{ids}->{$vmid}->{node};
6384 }
6385 $conf = PVE::QemuConfig->load_config($vmid, $node);
6386 } else {
6387 $conf = PVE::QemuConfig->load_config($vmid);
6388 }
c2786bed 6389
8e0c97bb
SR
6390 if ($res->{status}) {
6391 return if $res->{status} eq 'running'; # job done, go home
6392 $resume_cmd = 'system_wakeup' if $res->{status} eq 'suspended';
6393 $reset = 1 if $res->{status} eq 'shutdown';
c2786bed
DC
6394 }
6395
289e0b85 6396 if (!$nocheck) {
e79706d4
FG
6397 PVE::QemuConfig->check_lock($conf)
6398 if !($skiplock || PVE::QemuConfig->has_lock($conf, 'backup'));
289e0b85 6399 }
3e24733b 6400
8e0c97bb
SR
6401 if ($reset) {
6402 # required if a VM shuts down during a backup and we get a resume
6403 # request before the backup finishes for example
6404 mon_cmd($vmid, "system_reset");
6405 }
21947fea
AD
6406
6407 add_nets_bridge_fdb($conf, $vmid) if $resume_cmd eq 'cont';
6408
0a13e08e 6409 mon_cmd($vmid, $resume_cmd);
1e3baf05
DM
6410 });
6411}
6412
5fdbe4f0
DM
6413sub vm_sendkey {
6414 my ($vmid, $skiplock, $key) = @_;
1e3baf05 6415
ffda963f 6416 PVE::QemuConfig->lock_config($vmid, sub {
1e3baf05 6417
ffda963f 6418 my $conf = PVE::QemuConfig->load_config($vmid);
f5eb281a 6419
7b7c6d1b 6420 # there is no qmp command, so we use the human monitor command
0a13e08e 6421 my $res = PVE::QemuServer::Monitor::hmp_cmd($vmid, "sendkey $key");
d30820d6 6422 die $res if $res ne '';
1e3baf05
DM
6423 });
6424}
6425
3e16d5fc
DM
6426# vzdump restore implementaion
6427
ed221350 6428sub tar_archive_read_firstfile {
3e16d5fc 6429 my $archive = shift;
afdb31d5 6430
3e16d5fc
DM
6431 die "ERROR: file '$archive' does not exist\n" if ! -f $archive;
6432
6433 # try to detect archive type first
387ba257 6434 my $pid = open (my $fh, '-|', 'tar', 'tf', $archive) ||
3e16d5fc 6435 die "unable to open file '$archive'\n";
387ba257 6436 my $firstfile = <$fh>;
3e16d5fc 6437 kill 15, $pid;
387ba257 6438 close $fh;
3e16d5fc
DM
6439
6440 die "ERROR: archive contaions no data\n" if !$firstfile;
6441 chomp $firstfile;
6442
6443 return $firstfile;
6444}
6445
ed221350
DM
6446sub tar_restore_cleanup {
6447 my ($storecfg, $statfile) = @_;
3e16d5fc
DM
6448
6449 print STDERR "starting cleanup\n";
6450
6451 if (my $fd = IO::File->new($statfile, "r")) {
6452 while (defined(my $line = <$fd>)) {
6453 if ($line =~ m/vzdump:([^\s:]*):(\S+)$/) {
6454 my $volid = $2;
6455 eval {
6456 if ($volid =~ m|^/|) {
6457 unlink $volid || die 'unlink failed\n';
6458 } else {
ed221350 6459 PVE::Storage::vdisk_free($storecfg, $volid);
3e16d5fc 6460 }
afdb31d5 6461 print STDERR "temporary volume '$volid' sucessfuly removed\n";
3e16d5fc
DM
6462 };
6463 print STDERR "unable to cleanup '$volid' - $@" if $@;
6464 } else {
6465 print STDERR "unable to parse line in statfile - $line";
afdb31d5 6466 }
3e16d5fc
DM
6467 }
6468 $fd->close();
6469 }
6470}
6471
d1e92cf6 6472sub restore_file_archive {
a0d1b1a2 6473 my ($archive, $vmid, $user, $opts) = @_;
3e16d5fc 6474
a2ec5a67
FG
6475 return restore_vma_archive($archive, $vmid, $user, $opts)
6476 if $archive eq '-';
6477
c6d51783
AA
6478 my $info = PVE::Storage::archive_info($archive);
6479 my $format = $opts->{format} // $info->{format};
6480 my $comp = $info->{compression};
91bd6c90
DM
6481
6482 # try to detect archive format
6483 if ($format eq 'tar') {
6484 return restore_tar_archive($archive, $vmid, $user, $opts);
6485 } else {
6486 return restore_vma_archive($archive, $vmid, $user, $opts, $comp);
6487 }
6488}
6489
d1e92cf6
DM
6490# hepler to remove disks that will not be used after restore
6491my $restore_cleanup_oldconf = sub {
6492 my ($storecfg, $vmid, $oldconf, $virtdev_hash) = @_;
6493
01a4377f
FE
6494 my $kept_disks = {};
6495
912792e2 6496 PVE::QemuConfig->foreach_volume($oldconf, sub {
d1e92cf6
DM
6497 my ($ds, $drive) = @_;
6498
6499 return if drive_is_cdrom($drive, 1);
6500
6501 my $volid = $drive->{file};
6502 return if !$volid || $volid =~ m|^/|;
6503
6504 my ($path, $owner) = PVE::Storage::path($storecfg, $volid);
6505 return if !$path || !$owner || ($owner != $vmid);
6506
6507 # Note: only delete disk we want to restore
6508 # other volumes will become unused
6509 if ($virtdev_hash->{$ds}) {
6510 eval { PVE::Storage::vdisk_free($storecfg, $volid); };
6511 if (my $err = $@) {
6512 warn $err;
6513 }
01a4377f
FE
6514 } else {
6515 $kept_disks->{$volid} = 1;
d1e92cf6
DM
6516 }
6517 });
6518
01a4377f
FE
6519 # after the restore we have no snapshots anymore
6520 for my $snapname (keys $oldconf->{snapshots}->%*) {
d1e92cf6
DM
6521 my $snap = $oldconf->{snapshots}->{$snapname};
6522 if ($snap->{vmstate}) {
6523 eval { PVE::Storage::vdisk_free($storecfg, $snap->{vmstate}); };
6524 if (my $err = $@) {
6525 warn $err;
6526 }
6527 }
01a4377f
FE
6528
6529 for my $volid (keys $kept_disks->%*) {
6530 eval { PVE::Storage::volume_snapshot_delete($storecfg, $volid, $snapname); };
6531 warn $@ if $@;
6532 }
d1e92cf6
DM
6533 }
6534};
6535
9f3d73bc
DM
6536# Helper to parse vzdump backup device hints
6537#
6538# $rpcenv: Environment, used to ckeck storage permissions
6539# $user: User ID, to check storage permissions
6540# $storecfg: Storage configuration
6541# $fh: the file handle for reading the configuration
6542# $devinfo: should contain device sizes for all backu-up'ed devices
6543# $options: backup options (pool, default storage)
6544#
6545# Return: $virtdev_hash, updates $devinfo (add devname, virtdev, format, storeid)
6546my $parse_backup_hints = sub {
6547 my ($rpcenv, $user, $storecfg, $fh, $devinfo, $options) = @_;
d1e92cf6 6548
36d4bdcb
TL
6549 my $check_storage = sub { # assert if an image can be allocate
6550 my ($storeid, $scfg) = @_;
6551 die "Content type 'images' is not available on storage '$storeid'\n"
6552 if !$scfg->{content}->{images};
6553 $rpcenv->check($user, "/storage/$storeid", ['Datastore.AllocateSpace'])
6554 if $user ne 'root@pam';
6555 };
d1e92cf6 6556
36d4bdcb 6557 my $virtdev_hash = {};
9f3d73bc
DM
6558 while (defined(my $line = <$fh>)) {
6559 if ($line =~ m/^\#qmdump\#map:(\S+):(\S+):(\S*):(\S*):$/) {
6560 my ($virtdev, $devname, $storeid, $format) = ($1, $2, $3, $4);
6561 die "archive does not contain data for drive '$virtdev'\n"
6562 if !$devinfo->{$devname};
6563
6564 if (defined($options->{storage})) {
6565 $storeid = $options->{storage} || 'local';
6566 } elsif (!$storeid) {
6567 $storeid = 'local';
d1e92cf6 6568 }
9f3d73bc
DM
6569 $format = 'raw' if !$format;
6570 $devinfo->{$devname}->{devname} = $devname;
6571 $devinfo->{$devname}->{virtdev} = $virtdev;
6572 $devinfo->{$devname}->{format} = $format;
6573 $devinfo->{$devname}->{storeid} = $storeid;
6574
62af60cd 6575 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
36d4bdcb 6576 $check_storage->($storeid, $scfg); # permission and content type check
d1e92cf6 6577
9f3d73bc
DM
6578 $virtdev_hash->{$virtdev} = $devinfo->{$devname};
6579 } elsif ($line =~ m/^((?:ide|sata|scsi)\d+):\s*(.*)\s*$/) {
6580 my $virtdev = $1;
6581 my $drive = parse_drive($virtdev, $2);
36d4bdcb 6582
9f3d73bc
DM
6583 if (drive_is_cloudinit($drive)) {
6584 my ($storeid, $volname) = PVE::Storage::parse_volume_id($drive->{file});
5364990d
TL
6585 $storeid = $options->{storage} if defined ($options->{storage});
6586 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
9f3d73bc 6587 my $format = qemu_img_format($scfg, $volname); # has 'raw' fallback
d1e92cf6 6588
36d4bdcb 6589 $check_storage->($storeid, $scfg); # permission and content type check
9f8ba326 6590
9f3d73bc
DM
6591 $virtdev_hash->{$virtdev} = {
6592 format => $format,
5364990d 6593 storeid => $storeid,
9f3d73bc
DM
6594 size => PVE::QemuServer::Cloudinit::CLOUDINIT_DISK_SIZE,
6595 is_cloudinit => 1,
6596 };
d1e92cf6 6597 }
9f3d73bc
DM
6598 }
6599 }
d1e92cf6 6600
9f3d73bc
DM
6601 return $virtdev_hash;
6602};
d1e92cf6 6603
9f3d73bc
DM
6604# Helper to allocate and activate all volumes required for a restore
6605#
6606# $storecfg: Storage configuration
6607# $virtdev_hash: as returned by parse_backup_hints()
6608#
6609# Returns: { $virtdev => $volid }
6610my $restore_allocate_devices = sub {
6611 my ($storecfg, $virtdev_hash, $vmid) = @_;
d1e92cf6 6612
9f3d73bc
DM
6613 my $map = {};
6614 foreach my $virtdev (sort keys %$virtdev_hash) {
6615 my $d = $virtdev_hash->{$virtdev};
6616 my $alloc_size = int(($d->{size} + 1024 - 1)/1024);
6617 my $storeid = $d->{storeid};
6618 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
d1e92cf6 6619
9f3d73bc
DM
6620 # test if requested format is supported
6621 my ($defFormat, $validFormats) = PVE::Storage::storage_default_format($storecfg, $storeid);
6622 my $supported = grep { $_ eq $d->{format} } @$validFormats;
6623 $d->{format} = $defFormat if !$supported;
d1e92cf6 6624
9f3d73bc
DM
6625 my $name;
6626 if ($d->{is_cloudinit}) {
6627 $name = "vm-$vmid-cloudinit";
c997e24a
ML
6628 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
6629 if ($scfg->{path}) {
6630 $name .= ".$d->{format}";
6631 }
d1e92cf6
DM
6632 }
6633
4df98f2f
TL
6634 my $volid = PVE::Storage::vdisk_alloc(
6635 $storecfg, $storeid, $vmid, $d->{format}, $name, $alloc_size);
d1e92cf6 6636
9f3d73bc
DM
6637 print STDERR "new volume ID is '$volid'\n";
6638 $d->{volid} = $volid;
d1e92cf6 6639
9f3d73bc 6640 PVE::Storage::activate_volumes($storecfg, [$volid]);
d1e92cf6 6641
9f3d73bc 6642 $map->{$virtdev} = $volid;
d1e92cf6
DM
6643 }
6644
9f3d73bc
DM
6645 return $map;
6646};
d1e92cf6 6647
c62d7cf5 6648sub restore_update_config_line {
eabac302 6649 my ($cookie, $map, $line, $unique) = @_;
91bd6c90 6650
98a4b3fb
FE
6651 return '' if $line =~ m/^\#qmdump\#/;
6652 return '' if $line =~ m/^\#vzdump\#/;
6653 return '' if $line =~ m/^lock:/;
6654 return '' if $line =~ m/^unused\d+:/;
6655 return '' if $line =~ m/^parent:/;
6656
6657 my $res = '';
91bd6c90 6658
b5b99790 6659 my $dc = PVE::Cluster::cfs_read_file('datacenter.cfg');
91bd6c90
DM
6660 if (($line =~ m/^(vlan(\d+)):\s*(\S+)\s*$/)) {
6661 # try to convert old 1.X settings
6662 my ($id, $ind, $ethcfg) = ($1, $2, $3);
6663 foreach my $devconfig (PVE::Tools::split_list($ethcfg)) {
6664 my ($model, $macaddr) = split(/\=/, $devconfig);
b5b99790 6665 $macaddr = PVE::Tools::random_ether_addr($dc->{mac_prefix}) if !$macaddr || $unique;
91bd6c90
DM
6666 my $net = {
6667 model => $model,
6668 bridge => "vmbr$ind",
6669 macaddr => $macaddr,
6670 };
6671 my $netstr = print_net($net);
6672
98a4b3fb 6673 $res .= "net$cookie->{netcount}: $netstr\n";
91bd6c90
DM
6674 $cookie->{netcount}++;
6675 }
6676 } elsif (($line =~ m/^(net\d+):\s*(\S+)\s*$/) && $unique) {
6677 my ($id, $netstr) = ($1, $2);
6678 my $net = parse_net($netstr);
b5b99790 6679 $net->{macaddr} = PVE::Tools::random_ether_addr($dc->{mac_prefix}) if $net->{macaddr};
91bd6c90 6680 $netstr = print_net($net);
98a4b3fb 6681 $res .= "$id: $netstr\n";
f9dde219 6682 } elsif ($line =~ m/^((ide|scsi|virtio|sata|efidisk|tpmstate)\d+):\s*(\S+)\s*$/) {
91bd6c90 6683 my $virtdev = $1;
907ea891 6684 my $value = $3;
d9faf790
WB
6685 my $di = parse_drive($virtdev, $value);
6686 if (defined($di->{backup}) && !$di->{backup}) {
98a4b3fb 6687 $res .= "#$line";
c0f7406e 6688 } elsif ($map->{$virtdev}) {
8fd57431 6689 delete $di->{format}; # format can change on restore
91bd6c90 6690 $di->{file} = $map->{$virtdev};
71c58bb7 6691 $value = print_drive($di);
98a4b3fb 6692 $res .= "$virtdev: $value\n";
91bd6c90 6693 } else {
98a4b3fb 6694 $res .= $line;
91bd6c90 6695 }
1a0c2f03 6696 } elsif (($line =~ m/^vmgenid: (.*)/)) {
babecffe 6697 my $vmgenid = $1;
6ee499ff 6698 if ($vmgenid ne '0') {
1a0c2f03 6699 # always generate a new vmgenid if there was a valid one setup
6ee499ff
DC
6700 $vmgenid = generate_uuid();
6701 }
98a4b3fb 6702 $res .= "vmgenid: $vmgenid\n";
19a5dd55
WL
6703 } elsif (($line =~ m/^(smbios1: )(.*)/) && $unique) {
6704 my ($uuid, $uuid_str);
6705 UUID::generate($uuid);
6706 UUID::unparse($uuid, $uuid_str);
6707 my $smbios1 = parse_smbios1($2);
6708 $smbios1->{uuid} = $uuid_str;
98a4b3fb 6709 $res .= $1.print_smbios1($smbios1)."\n";
91bd6c90 6710 } else {
98a4b3fb 6711 $res .= $line;
91bd6c90 6712 }
98a4b3fb
FE
6713
6714 return $res;
c62d7cf5 6715}
9f3d73bc
DM
6716
6717my $restore_deactivate_volumes = sub {
e8b07b29 6718 my ($storecfg, $virtdev_hash) = @_;
9f3d73bc
DM
6719
6720 my $vollist = [];
e8b07b29
FE
6721 for my $dev (values $virtdev_hash->%*) {
6722 push $vollist->@*, $dev->{volid} if $dev->{volid};
9f3d73bc
DM
6723 }
6724
ff86112c
FE
6725 eval { PVE::Storage::deactivate_volumes($storecfg, $vollist); };
6726 print STDERR $@ if $@;
9f3d73bc
DM
6727};
6728
6729my $restore_destroy_volumes = sub {
e8b07b29 6730 my ($storecfg, $virtdev_hash) = @_;
9f3d73bc 6731
e8b07b29
FE
6732 for my $dev (values $virtdev_hash->%*) {
6733 my $volid = $dev->{volid} or next;
9f3d73bc 6734 eval {
e60afe82 6735 PVE::Storage::vdisk_free($storecfg, $volid);
9f3d73bc
DM
6736 print STDERR "temporary volume '$volid' sucessfuly removed\n";
6737 };
6738 print STDERR "unable to cleanup '$volid' - $@" if $@;
6739 }
6740};
91bd6c90 6741
202a2a0b
FE
6742my $restore_merge_config = sub {
6743 my ($filename, $backup_conf_raw, $override_conf) = @_;
6744
6745 my $backup_conf = parse_vm_config($filename, $backup_conf_raw);
6746 for my $key (keys $override_conf->%*) {
6747 $backup_conf->{$key} = $override_conf->{$key};
6748 }
6749
6750 return $backup_conf;
6751};
6752
91bd6c90 6753sub scan_volids {
9a8ba127 6754 my ($cfg, $vmid) = @_;
91bd6c90 6755
9a8ba127 6756 my $info = PVE::Storage::vdisk_list($cfg, undef, $vmid, undef, 'images');
91bd6c90
DM
6757
6758 my $volid_hash = {};
6759 foreach my $storeid (keys %$info) {
6760 foreach my $item (@{$info->{$storeid}}) {
6761 next if !($item->{volid} && $item->{size});
5996a936 6762 $item->{path} = PVE::Storage::path($cfg, $item->{volid});
91bd6c90
DM
6763 $volid_hash->{$item->{volid}} = $item;
6764 }
6765 }
6766
6767 return $volid_hash;
6768}
6769
68b108ee 6770sub update_disk_config {
91bd6c90 6771 my ($vmid, $conf, $volid_hash) = @_;
be190583 6772
91bd6c90 6773 my $changes;
9b29cbd0 6774 my $prefix = "VM $vmid";
91bd6c90 6775
c449137a
DC
6776 # used and unused disks
6777 my $referenced = {};
91bd6c90 6778
5996a936
DM
6779 # Note: it is allowed to define multiple storages with same path (alias), so
6780 # we need to check both 'volid' and real 'path' (two different volid can point
6781 # to the same path).
6782
c449137a 6783 my $referencedpath = {};
be190583 6784
91bd6c90 6785 # update size info
0c4fef3f 6786 PVE::QemuConfig->foreach_volume($conf, sub {
ca04977c 6787 my ($opt, $drive) = @_;
91bd6c90 6788
ca04977c
FE
6789 my $volid = $drive->{file};
6790 return if !$volid;
4df98f2f 6791 my $volume = $volid_hash->{$volid};
91bd6c90 6792
ca04977c
FE
6793 # mark volid as "in-use" for next step
6794 $referenced->{$volid} = 1;
4df98f2f 6795 if ($volume && (my $path = $volume->{path})) {
ca04977c 6796 $referencedpath->{$path} = 1;
91bd6c90 6797 }
ca04977c
FE
6798
6799 return if drive_is_cdrom($drive);
4df98f2f 6800 return if !$volume;
ca04977c 6801
4df98f2f 6802 my ($updated, $msg) = PVE::QemuServer::Drive::update_disksize($drive, $volume->{size});
ca04977c
FE
6803 if (defined($updated)) {
6804 $changes = 1;
6805 $conf->{$opt} = print_drive($updated);
9b29cbd0 6806 print "$prefix ($opt): $msg\n";
ca04977c
FE
6807 }
6808 });
91bd6c90 6809
5996a936 6810 # remove 'unusedX' entry if volume is used
ca04977c
FE
6811 PVE::QemuConfig->foreach_unused_volume($conf, sub {
6812 my ($opt, $drive) = @_;
6813
6814 my $volid = $drive->{file};
6815 return if !$volid;
6816
f7d1505b
TL
6817 my $path;
6818 $path = $volid_hash->{$volid}->{path} if $volid_hash->{$volid};
c449137a 6819 if ($referenced->{$volid} || ($path && $referencedpath->{$path})) {
68b108ee 6820 print "$prefix remove entry '$opt', its volume '$volid' is in use\n";
5996a936
DM
6821 $changes = 1;
6822 delete $conf->{$opt};
6823 }
c449137a
DC
6824
6825 $referenced->{$volid} = 1;
6826 $referencedpath->{$path} = 1 if $path;
ca04977c 6827 });
5996a936 6828
91bd6c90
DM
6829 foreach my $volid (sort keys %$volid_hash) {
6830 next if $volid =~ m/vm-$vmid-state-/;
c449137a 6831 next if $referenced->{$volid};
5996a936
DM
6832 my $path = $volid_hash->{$volid}->{path};
6833 next if !$path; # just to be sure
c449137a 6834 next if $referencedpath->{$path};
91bd6c90 6835 $changes = 1;
53b81297 6836 my $key = PVE::QemuConfig->add_unused_volume($conf, $volid);
68b108ee 6837 print "$prefix add unreferenced volume '$volid' as '$key' to config\n";
c449137a 6838 $referencedpath->{$path} = 1; # avoid to add more than once (aliases)
91bd6c90
DM
6839 }
6840
6841 return $changes;
6842}
6843
6844sub rescan {
9224dcee 6845 my ($vmid, $nolock, $dryrun) = @_;
91bd6c90 6846
20519efc 6847 my $cfg = PVE::Storage::config();
91bd6c90 6848
53b81297 6849 print "rescan volumes...\n";
9a8ba127 6850 my $volid_hash = scan_volids($cfg, $vmid);
91bd6c90
DM
6851
6852 my $updatefn = sub {
6853 my ($vmid) = @_;
6854
ffda963f 6855 my $conf = PVE::QemuConfig->load_config($vmid);
be190583 6856
ffda963f 6857 PVE::QemuConfig->check_lock($conf);
91bd6c90 6858
03da3f0d
DM
6859 my $vm_volids = {};
6860 foreach my $volid (keys %$volid_hash) {
6861 my $info = $volid_hash->{$volid};
6862 $vm_volids->{$volid} = $info if $info->{vmid} && $info->{vmid} == $vmid;
6863 }
6864
68b108ee 6865 my $changes = update_disk_config($vmid, $conf, $vm_volids);
91bd6c90 6866
9224dcee 6867 PVE::QemuConfig->write_config($vmid, $conf) if $changes && !$dryrun;
91bd6c90
DM
6868 };
6869
6870 if (defined($vmid)) {
6871 if ($nolock) {
6872 &$updatefn($vmid);
6873 } else {
ffda963f 6874 PVE::QemuConfig->lock_config($vmid, $updatefn, $vmid);
91bd6c90
DM
6875 }
6876 } else {
6877 my $vmlist = config_list();
6878 foreach my $vmid (keys %$vmlist) {
6879 if ($nolock) {
6880 &$updatefn($vmid);
6881 } else {
ffda963f 6882 PVE::QemuConfig->lock_config($vmid, $updatefn, $vmid);
be190583 6883 }
91bd6c90
DM
6884 }
6885 }
6886}
6887
9f3d73bc
DM
6888sub restore_proxmox_backup_archive {
6889 my ($archive, $vmid, $user, $options) = @_;
6890
6891 my $storecfg = PVE::Storage::config();
6892
6893 my ($storeid, $volname) = PVE::Storage::parse_volume_id($archive);
6894 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
6895
9f3d73bc 6896 my $fingerprint = $scfg->{fingerprint};
503e96f8 6897 my $keyfile = PVE::Storage::PBSPlugin::pbs_encryption_key_file_name($storecfg, $storeid);
9f3d73bc 6898
fbec3f89 6899 my $repo = PVE::PBSClient::get_repository($scfg);
2dda626d 6900 my $namespace = $scfg->{namespace};
dea4b04c 6901
26731a3c 6902 # This is only used for `pbs-restore` and the QEMU PBS driver (live-restore)
9f3d73bc
DM
6903 my $password = PVE::Storage::PBSPlugin::pbs_get_password($scfg, $storeid);
6904 local $ENV{PBS_PASSWORD} = $password;
6905 local $ENV{PBS_FINGERPRINT} = $fingerprint if defined($fingerprint);
6906
6907 my ($vtype, $pbs_backup_name, undef, undef, undef, undef, $format) =
6908 PVE::Storage::parse_volname($storecfg, $archive);
6909
6910 die "got unexpected vtype '$vtype'\n" if $vtype ne 'backup';
6911
6912 die "got unexpected backup format '$format'\n" if $format ne 'pbs-vm';
6913
6914 my $tmpdir = "/var/tmp/vzdumptmp$$";
6915 rmtree $tmpdir;
6916 mkpath $tmpdir;
6917
6918 my $conffile = PVE::QemuConfig->config_file($vmid);
9f3d73bc
DM
6919 # disable interrupts (always do cleanups)
6920 local $SIG{INT} =
6921 local $SIG{TERM} =
6922 local $SIG{QUIT} =
6923 local $SIG{HUP} = sub { print STDERR "got interrupt - ignored\n"; };
6924
6925 # Note: $oldconf is undef if VM does not exists
6926 my $cfs_path = PVE::QemuConfig->cfs_config_path($vmid);
6927 my $oldconf = PVE::Cluster::cfs_read_file($cfs_path);
98a4b3fb 6928 my $new_conf_raw = '';
9f3d73bc
DM
6929
6930 my $rpcenv = PVE::RPCEnvironment::get();
e8b07b29
FE
6931 my $devinfo = {}; # info about drives included in backup
6932 my $virtdev_hash = {}; # info about allocated drives
9f3d73bc
DM
6933
6934 eval {
6935 # enable interrupts
6936 local $SIG{INT} =
6937 local $SIG{TERM} =
6938 local $SIG{QUIT} =
6939 local $SIG{HUP} =
6940 local $SIG{PIPE} = sub { die "interrupted by signal\n"; };
6941
6942 my $cfgfn = "$tmpdir/qemu-server.conf";
6943 my $firewall_config_fn = "$tmpdir/fw.conf";
6944 my $index_fn = "$tmpdir/index.json";
6945
6946 my $cmd = "restore";
6947
6948 my $param = [$pbs_backup_name, "index.json", $index_fn];
6949 PVE::Storage::PBSPlugin::run_raw_client_cmd($scfg, $storeid, $cmd, $param);
6950 my $index = PVE::Tools::file_get_contents($index_fn);
6951 $index = decode_json($index);
6952
9f3d73bc
DM
6953 foreach my $info (@{$index->{files}}) {
6954 if ($info->{filename} =~ m/^(drive-\S+).img.fidx$/) {
6955 my $devname = $1;
6956 if ($info->{size} =~ m/^(\d+)$/) { # untaint size
6957 $devinfo->{$devname}->{size} = $1;
6958 } else {
6959 die "unable to parse file size in 'index.json' - got '$info->{size}'\n";
6960 }
6961 }
6962 }
6963
4df98f2f
TL
6964 my $is_qemu_server_backup = scalar(
6965 grep { $_->{filename} eq 'qemu-server.conf.blob' } @{$index->{files}}
6966 );
9f3d73bc
DM
6967 if (!$is_qemu_server_backup) {
6968 die "backup does not look like a qemu-server backup (missing 'qemu-server.conf' file)\n";
6969 }
6970 my $has_firewall_config = scalar(grep { $_->{filename} eq 'fw.conf.blob' } @{$index->{files}});
6971
6972 $param = [$pbs_backup_name, "qemu-server.conf", $cfgfn];
6973 PVE::Storage::PBSPlugin::run_raw_client_cmd($scfg, $storeid, $cmd, $param);
6974
6975 if ($has_firewall_config) {
6976 $param = [$pbs_backup_name, "fw.conf", $firewall_config_fn];
6977 PVE::Storage::PBSPlugin::run_raw_client_cmd($scfg, $storeid, $cmd, $param);
6978
6979 my $pve_firewall_dir = '/etc/pve/firewall';
6980 mkdir $pve_firewall_dir; # make sure the dir exists
6981 PVE::Tools::file_copy($firewall_config_fn, "${pve_firewall_dir}/$vmid.fw");
6982 }
6983
6984 my $fh = IO::File->new($cfgfn, "r") ||
a1cbe55c 6985 die "unable to read qemu-server.conf - $!\n";
9f3d73bc 6986
e8b07b29 6987 $virtdev_hash = $parse_backup_hints->($rpcenv, $user, $storecfg, $fh, $devinfo, $options);
9f3d73bc
DM
6988
6989 # fixme: rate limit?
6990
6991 # create empty/temp config
6992 PVE::Tools::file_set_contents($conffile, "memory: 128\nlock: create");
6993
6994 $restore_cleanup_oldconf->($storecfg, $vmid, $oldconf, $virtdev_hash) if $oldconf;
6995
6996 # allocate volumes
6997 my $map = $restore_allocate_devices->($storecfg, $virtdev_hash, $vmid);
6998
6f94e162
SR
6999 foreach my $virtdev (sort keys %$virtdev_hash) {
7000 my $d = $virtdev_hash->{$virtdev};
7001 next if $d->{is_cloudinit}; # no need to restore cloudinit
9f3d73bc 7002
55c7f9cf 7003 # this fails if storage is unavailable
6f94e162 7004 my $volid = $d->{volid};
6f94e162 7005 my $path = PVE::Storage::path($storecfg, $volid);
9f3d73bc 7006
f9dde219
SR
7007 # for live-restore we only want to preload the efidisk and TPM state
7008 next if $options->{live} && $virtdev ne 'efidisk0' && $virtdev ne 'tpmstate0';
55c7f9cf 7009
21a9ec2a
WB
7010 my @ns_arg;
7011 if (defined(my $ns = $scfg->{namespace})) {
7012 @ns_arg = ('--ns', $ns);
7013 }
7014
6f94e162
SR
7015 my $pbs_restore_cmd = [
7016 '/usr/bin/pbs-restore',
7017 '--repository', $repo,
21a9ec2a 7018 @ns_arg,
6f94e162
SR
7019 $pbs_backup_name,
7020 "$d->{devname}.img.fidx",
7021 $path,
7022 '--verbose',
7023 ];
55fb78aa 7024
6f94e162
SR
7025 push @$pbs_restore_cmd, '--format', $d->{format} if $d->{format};
7026 push @$pbs_restore_cmd, '--keyfile', $keyfile if -e $keyfile;
9f3d73bc 7027
6f94e162
SR
7028 if (PVE::Storage::volume_has_feature($storecfg, 'sparseinit', $volid)) {
7029 push @$pbs_restore_cmd, '--skip-zero';
26731a3c 7030 }
6f94e162
SR
7031
7032 my $dbg_cmdstring = PVE::Tools::cmd2string($pbs_restore_cmd);
7033 print "restore proxmox backup image: $dbg_cmdstring\n";
7034 run_command($pbs_restore_cmd);
9f3d73bc
DM
7035 }
7036
7037 $fh->seek(0, 0) || die "seek failed - $!\n";
7038
9f3d73bc
DM
7039 my $cookie = { netcount => 0 };
7040 while (defined(my $line = <$fh>)) {
c62d7cf5 7041 $new_conf_raw .= restore_update_config_line(
98a4b3fb 7042 $cookie,
98a4b3fb
FE
7043 $map,
7044 $line,
7045 $options->{unique},
7046 );
9f3d73bc
DM
7047 }
7048
7049 $fh->close();
9f3d73bc
DM
7050 };
7051 my $err = $@;
7052
26731a3c 7053 if ($err || !$options->{live}) {
e8b07b29 7054 $restore_deactivate_volumes->($storecfg, $virtdev_hash);
26731a3c 7055 }
9f3d73bc
DM
7056
7057 rmtree $tmpdir;
7058
7059 if ($err) {
e8b07b29 7060 $restore_destroy_volumes->($storecfg, $virtdev_hash);
9f3d73bc
DM
7061 die $err;
7062 }
7063
f7551170
SR
7064 if ($options->{live}) {
7065 # keep lock during live-restore
7066 $new_conf_raw .= "\nlock: create";
7067 }
7068
202a2a0b
FE
7069 my $new_conf = $restore_merge_config->($conffile, $new_conf_raw, $options->{override_conf});
7070 PVE::QemuConfig->write_config($vmid, $new_conf);
9f3d73bc
DM
7071
7072 eval { rescan($vmid, 1); };
7073 warn $@ if $@;
26731a3c
SR
7074
7075 PVE::AccessControl::add_vm_to_pool($vmid, $options->{pool}) if $options->{pool};
7076
7077 if ($options->{live}) {
fefd65a1
SR
7078 # enable interrupts
7079 local $SIG{INT} =
7080 local $SIG{TERM} =
7081 local $SIG{QUIT} =
7082 local $SIG{HUP} =
7083 local $SIG{PIPE} = sub { die "got signal ($!) - abort\n"; };
26731a3c 7084
fefd65a1
SR
7085 my $conf = PVE::QemuConfig->load_config($vmid);
7086 die "cannot do live-restore for template\n" if PVE::QemuConfig->is_template($conf);
26731a3c 7087
f9dde219
SR
7088 # these special drives are already restored before start
7089 delete $devinfo->{'drive-efidisk0'};
7090 delete $devinfo->{'drive-tpmstate0-backup'};
2dda626d
DC
7091
7092 my $pbs_opts = {
7093 repo => $repo,
7094 keyfile => $keyfile,
7095 snapshot => $pbs_backup_name,
7096 namespace => $namespace,
7097 };
7098 pbs_live_restore($vmid, $conf, $storecfg, $devinfo, $pbs_opts);
f7551170
SR
7099
7100 PVE::QemuConfig->remove_lock($vmid, "create");
26731a3c
SR
7101 }
7102}
7103
7104sub pbs_live_restore {
2dda626d 7105 my ($vmid, $conf, $storecfg, $restored_disks, $opts) = @_;
26731a3c 7106
88cabb62 7107 print "starting VM for live-restore\n";
2dda626d 7108 print "repository: '$opts->{repo}', snapshot: '$opts->{snapshot}'\n";
26731a3c
SR
7109
7110 my $pbs_backing = {};
8986e36e 7111 for my $ds (keys %$restored_disks) {
26731a3c 7112 $ds =~ m/^drive-(.*)$/;
88cabb62
SR
7113 my $confname = $1;
7114 $pbs_backing->{$confname} = {
2dda626d
DC
7115 repository => $opts->{repo},
7116 snapshot => $opts->{snapshot},
26731a3c
SR
7117 archive => "$ds.img.fidx",
7118 };
2dda626d
DC
7119 $pbs_backing->{$confname}->{keyfile} = $opts->{keyfile} if -e $opts->{keyfile};
7120 $pbs_backing->{$confname}->{namespace} = $opts->{namespace} if defined($opts->{namespace});
88cabb62
SR
7121
7122 my $drive = parse_drive($confname, $conf->{$confname});
7123 print "restoring '$ds' to '$drive->{file}'\n";
26731a3c
SR
7124 }
7125
fd70c843 7126 my $drives_streamed = 0;
26731a3c
SR
7127 eval {
7128 # make sure HA doesn't interrupt our restore by stopping the VM
7129 if (PVE::HA::Config::vm_is_ha_managed($vmid)) {
fd70c843 7130 run_command(['ha-manager', 'set', "vm:$vmid", '--state', 'started']);
26731a3c
SR
7131 }
7132
fd70c843
TL
7133 # start VM with backing chain pointing to PBS backup, environment vars for PBS driver
7134 # in QEMU (PBS_PASSWORD and PBS_FINGERPRINT) are already set by our caller
bfb12678 7135 vm_start_nolock($storecfg, $vmid, $conf, {paused => 1, 'pbs-backing' => $pbs_backing}, {});
26731a3c 7136
26697640
SR
7137 my $qmeventd_fd = register_qmeventd_handle($vmid);
7138
26731a3c
SR
7139 # begin streaming, i.e. data copy from PBS to target disk for every vol,
7140 # this will effectively collapse the backing image chain consisting of
7141 # [target <- alloc-track -> PBS snapshot] to just [target] (alloc-track
7142 # removes itself once all backing images vanish with 'auto-remove=on')
7143 my $jobs = {};
8986e36e 7144 for my $ds (sort keys %$restored_disks) {
26731a3c
SR
7145 my $job_id = "restore-$ds";
7146 mon_cmd($vmid, 'block-stream',
7147 'job-id' => $job_id,
7148 device => "$ds",
7149 );
7150 $jobs->{$job_id} = {};
7151 }
7152
7153 mon_cmd($vmid, 'cont');
7154 qemu_drive_mirror_monitor($vmid, undef, $jobs, 'auto', 0, 'stream');
7155
a09b39f1
TL
7156 print "restore-drive jobs finished successfully, removing all tracking block devices"
7157 ." to disconnect from Proxmox Backup Server\n";
7158
8986e36e 7159 for my $ds (sort keys %$restored_disks) {
26731a3c
SR
7160 mon_cmd($vmid, 'blockdev-del', 'node-name' => "$ds-pbs");
7161 }
26697640
SR
7162
7163 close($qmeventd_fd);
26731a3c
SR
7164 };
7165
7166 my $err = $@;
7167
7168 if ($err) {
8b8893c3 7169 warn "An error occurred during live-restore: $err\n";
26731a3c
SR
7170 _do_vm_stop($storecfg, $vmid, 1, 1, 10, 0, 1);
7171 die "live-restore failed\n";
7172 }
9f3d73bc
DM
7173}
7174
91bd6c90
DM
7175sub restore_vma_archive {
7176 my ($archive, $vmid, $user, $opts, $comp) = @_;
7177
91bd6c90
DM
7178 my $readfrom = $archive;
7179
7c536e11
WB
7180 my $cfg = PVE::Storage::config();
7181 my $commands = [];
7182 my $bwlimit = $opts->{bwlimit};
7183
7184 my $dbg_cmdstring = '';
7185 my $add_pipe = sub {
7186 my ($cmd) = @_;
7187 push @$commands, $cmd;
7188 $dbg_cmdstring .= ' | ' if length($dbg_cmdstring);
7189 $dbg_cmdstring .= PVE::Tools::cmd2string($cmd);
91bd6c90 7190 $readfrom = '-';
7c536e11
WB
7191 };
7192
7193 my $input = undef;
7194 if ($archive eq '-') {
7195 $input = '<&STDIN';
7196 } else {
7197 # If we use a backup from a PVE defined storage we also consider that
7198 # storage's rate limit:
7199 my (undef, $volid) = PVE::Storage::path_to_volume_id($cfg, $archive);
7200 if (defined($volid)) {
7201 my ($sid, undef) = PVE::Storage::parse_volume_id($volid);
7202 my $readlimit = PVE::Storage::get_bandwidth_limit('restore', [$sid], $bwlimit);
7203 if ($readlimit) {
7204 print STDERR "applying read rate limit: $readlimit\n";
9444c6e4 7205 my $cstream = ['cstream', '-t', $readlimit*1024, '--', $readfrom];
7c536e11
WB
7206 $add_pipe->($cstream);
7207 }
7208 }
7209 }
7210
7211 if ($comp) {
c6d51783
AA
7212 my $info = PVE::Storage::decompressor_info('vma', $comp);
7213 my $cmd = $info->{decompressor};
7214 push @$cmd, $readfrom;
7c536e11 7215 $add_pipe->($cmd);
91bd6c90
DM
7216 }
7217
7218 my $tmpdir = "/var/tmp/vzdumptmp$$";
7219 rmtree $tmpdir;
7220
7221 # disable interrupts (always do cleanups)
5b97ef24
TL
7222 local $SIG{INT} =
7223 local $SIG{TERM} =
7224 local $SIG{QUIT} =
7225 local $SIG{HUP} = sub { warn "got interrupt - ignored\n"; };
91bd6c90
DM
7226
7227 my $mapfifo = "/var/tmp/vzdumptmp$$.fifo";
7228 POSIX::mkfifo($mapfifo, 0600);
7229 my $fifofh;
808a65b5 7230 my $openfifo = sub { open($fifofh, '>', $mapfifo) or die $! };
91bd6c90 7231
7c536e11 7232 $add_pipe->(['vma', 'extract', '-v', '-r', $mapfifo, $readfrom, $tmpdir]);
91bd6c90
DM
7233
7234 my $oldtimeout;
7235 my $timeout = 5;
7236
e8b07b29
FE
7237 my $devinfo = {}; # info about drives included in backup
7238 my $virtdev_hash = {}; # info about allocated drives
91bd6c90
DM
7239
7240 my $rpcenv = PVE::RPCEnvironment::get();
7241
ffda963f 7242 my $conffile = PVE::QemuConfig->config_file($vmid);
91bd6c90 7243
ae200950 7244 # Note: $oldconf is undef if VM does not exist
ffda963f
FG
7245 my $cfs_path = PVE::QemuConfig->cfs_config_path($vmid);
7246 my $oldconf = PVE::Cluster::cfs_read_file($cfs_path);
98a4b3fb 7247 my $new_conf_raw = '';
ed221350 7248
7c536e11
WB
7249 my %storage_limits;
7250
91bd6c90 7251 my $print_devmap = sub {
91bd6c90
DM
7252 my $cfgfn = "$tmpdir/qemu-server.conf";
7253
7254 # we can read the config - that is already extracted
7255 my $fh = IO::File->new($cfgfn, "r") ||
a1cbe55c 7256 die "unable to read qemu-server.conf - $!\n";
91bd6c90 7257
6738ab9c 7258 my $fwcfgfn = "$tmpdir/qemu-server.fw";
3457d090
WL
7259 if (-f $fwcfgfn) {
7260 my $pve_firewall_dir = '/etc/pve/firewall';
7261 mkdir $pve_firewall_dir; # make sure the dir exists
7262 PVE::Tools::file_copy($fwcfgfn, "${pve_firewall_dir}/$vmid.fw");
7263 }
6738ab9c 7264
e8b07b29 7265 $virtdev_hash = $parse_backup_hints->($rpcenv, $user, $cfg, $fh, $devinfo, $opts);
91bd6c90 7266
c8964278
FE
7267 foreach my $info (values %{$virtdev_hash}) {
7268 my $storeid = $info->{storeid};
7269 next if defined($storage_limits{$storeid});
7270
7271 my $limit = PVE::Storage::get_bandwidth_limit('restore', [$storeid], $bwlimit) // 0;
7272 print STDERR "rate limit for storage $storeid: $limit KiB/s\n" if $limit;
7273 $storage_limits{$storeid} = $limit * 1024;
7c536e11
WB
7274 }
7275
91bd6c90 7276 foreach my $devname (keys %$devinfo) {
be190583
DM
7277 die "found no device mapping information for device '$devname'\n"
7278 if !$devinfo->{$devname}->{virtdev};
91bd6c90
DM
7279 }
7280
ed221350 7281 # create empty/temp config
be190583 7282 if ($oldconf) {
ed221350 7283 PVE::Tools::file_set_contents($conffile, "memory: 128\n");
d1e92cf6 7284 $restore_cleanup_oldconf->($cfg, $vmid, $oldconf, $virtdev_hash);
ed221350
DM
7285 }
7286
9f3d73bc
DM
7287 # allocate volumes
7288 my $map = $restore_allocate_devices->($cfg, $virtdev_hash, $vmid);
7289
7290 # print restore information to $fifofh
91bd6c90
DM
7291 foreach my $virtdev (sort keys %$virtdev_hash) {
7292 my $d = $virtdev_hash->{$virtdev};
9f3d73bc
DM
7293 next if $d->{is_cloudinit}; # no need to restore cloudinit
7294
7c536e11 7295 my $storeid = $d->{storeid};
9f3d73bc 7296 my $volid = $d->{volid};
7c536e11
WB
7297
7298 my $map_opts = '';
7299 if (my $limit = $storage_limits{$storeid}) {
7300 $map_opts .= "throttling.bps=$limit:throttling.group=$storeid:";
7301 }
8fd57431 7302
91bd6c90 7303 my $write_zeros = 1;
88240a83 7304 if (PVE::Storage::volume_has_feature($cfg, 'sparseinit', $volid)) {
91bd6c90
DM
7305 $write_zeros = 0;
7306 }
7307
9f3d73bc 7308 my $path = PVE::Storage::path($cfg, $volid);
87056e18 7309
9f3d73bc 7310 print $fifofh "${map_opts}format=$d->{format}:${write_zeros}:$d->{devname}=$path\n";
91bd6c90 7311
9f3d73bc 7312 print "map '$d->{devname}' to '$path' (write zeros = ${write_zeros})\n";
91bd6c90
DM
7313 }
7314
7315 $fh->seek(0, 0) || die "seek failed - $!\n";
7316
91bd6c90
DM
7317 my $cookie = { netcount => 0 };
7318 while (defined(my $line = <$fh>)) {
c62d7cf5 7319 $new_conf_raw .= restore_update_config_line(
98a4b3fb 7320 $cookie,
98a4b3fb
FE
7321 $map,
7322 $line,
7323 $opts->{unique},
7324 );
91bd6c90
DM
7325 }
7326
7327 $fh->close();
91bd6c90
DM
7328 };
7329
7330 eval {
7331 # enable interrupts
6cb0144a
EK
7332 local $SIG{INT} =
7333 local $SIG{TERM} =
7334 local $SIG{QUIT} =
7335 local $SIG{HUP} =
7336 local $SIG{PIPE} = sub { die "interrupted by signal\n"; };
91bd6c90
DM
7337 local $SIG{ALRM} = sub { die "got timeout\n"; };
7338
7339 $oldtimeout = alarm($timeout);
7340
7341 my $parser = sub {
7342 my $line = shift;
7343
7344 print "$line\n";
7345
7346 if ($line =~ m/^DEV:\sdev_id=(\d+)\ssize:\s(\d+)\sdevname:\s(\S+)$/) {
7347 my ($dev_id, $size, $devname) = ($1, $2, $3);
7348 $devinfo->{$devname} = { size => $size, dev_id => $dev_id };
7349 } elsif ($line =~ m/^CTIME: /) {
46f58b5f 7350 # we correctly received the vma config, so we can disable
3cf90d7a
DM
7351 # the timeout now for disk allocation (set to 10 minutes, so
7352 # that we always timeout if something goes wrong)
7353 alarm(600);
91bd6c90
DM
7354 &$print_devmap();
7355 print $fifofh "done\n";
7356 my $tmp = $oldtimeout || 0;
7357 $oldtimeout = undef;
7358 alarm($tmp);
7359 close($fifofh);
808a65b5 7360 $fifofh = undef;
91bd6c90
DM
7361 }
7362 };
be190583 7363
7c536e11
WB
7364 print "restore vma archive: $dbg_cmdstring\n";
7365 run_command($commands, input => $input, outfunc => $parser, afterfork => $openfifo);
91bd6c90
DM
7366 };
7367 my $err = $@;
7368
7369 alarm($oldtimeout) if $oldtimeout;
7370
e8b07b29 7371 $restore_deactivate_volumes->($cfg, $virtdev_hash);
5f96f4df 7372
808a65b5 7373 close($fifofh) if $fifofh;
91bd6c90 7374 unlink $mapfifo;
9f3d73bc 7375 rmtree $tmpdir;
91bd6c90
DM
7376
7377 if ($err) {
e8b07b29 7378 $restore_destroy_volumes->($cfg, $virtdev_hash);
91bd6c90
DM
7379 die $err;
7380 }
7381
202a2a0b
FE
7382 my $new_conf = $restore_merge_config->($conffile, $new_conf_raw, $opts->{override_conf});
7383 PVE::QemuConfig->write_config($vmid, $new_conf);
ed221350 7384
91bd6c90
DM
7385 eval { rescan($vmid, 1); };
7386 warn $@ if $@;
26731a3c
SR
7387
7388 PVE::AccessControl::add_vm_to_pool($vmid, $opts->{pool}) if $opts->{pool};
91bd6c90
DM
7389}
7390
7391sub restore_tar_archive {
7392 my ($archive, $vmid, $user, $opts) = @_;
7393
202a2a0b
FE
7394 if (scalar(keys $opts->{override_conf}->%*) > 0) {
7395 my $keystring = join(' ', keys $opts->{override_conf}->%*);
7396 die "cannot pass along options ($keystring) when restoring from tar archive\n";
7397 }
7398
9c502e26 7399 if ($archive ne '-') {
ed221350 7400 my $firstfile = tar_archive_read_firstfile($archive);
32e54050 7401 die "ERROR: file '$archive' does not look like a QemuServer vzdump backup\n"
9c502e26
DM
7402 if $firstfile ne 'qemu-server.conf';
7403 }
3e16d5fc 7404
20519efc 7405 my $storecfg = PVE::Storage::config();
ebb55558 7406
4b026937
TL
7407 # avoid zombie disks when restoring over an existing VM -> cleanup first
7408 # pass keep_empty_config=1 to keep the config (thus VMID) reserved for us
7409 # skiplock=1 because qmrestore has set the 'create' lock itself already
ffda963f 7410 my $vmcfgfn = PVE::QemuConfig->config_file($vmid);
b04ea584 7411 destroy_vm($storecfg, $vmid, 1, { lock => 'restore' }) if -f $vmcfgfn;
ed221350 7412
3e16d5fc
DM
7413 my $tocmd = "/usr/lib/qemu-server/qmextract";
7414
2415a446 7415 $tocmd .= " --storage " . PVE::Tools::shellquote($opts->{storage}) if $opts->{storage};
a0d1b1a2 7416 $tocmd .= " --pool " . PVE::Tools::shellquote($opts->{pool}) if $opts->{pool};
3e16d5fc
DM
7417 $tocmd .= ' --prealloc' if $opts->{prealloc};
7418 $tocmd .= ' --info' if $opts->{info};
7419
a0d1b1a2 7420 # tar option "xf" does not autodetect compression when read from STDIN,
9c502e26 7421 # so we pipe to zcat
2415a446
DM
7422 my $cmd = "zcat -f|tar xf " . PVE::Tools::shellquote($archive) . " " .
7423 PVE::Tools::shellquote("--to-command=$tocmd");
3e16d5fc
DM
7424
7425 my $tmpdir = "/var/tmp/vzdumptmp$$";
7426 mkpath $tmpdir;
7427
7428 local $ENV{VZDUMP_TMPDIR} = $tmpdir;
7429 local $ENV{VZDUMP_VMID} = $vmid;
a0d1b1a2 7430 local $ENV{VZDUMP_USER} = $user;
3e16d5fc 7431
ffda963f 7432 my $conffile = PVE::QemuConfig->config_file($vmid);
98a4b3fb 7433 my $new_conf_raw = '';
3e16d5fc
DM
7434
7435 # disable interrupts (always do cleanups)
6cb0144a
EK
7436 local $SIG{INT} =
7437 local $SIG{TERM} =
7438 local $SIG{QUIT} =
7439 local $SIG{HUP} = sub { print STDERR "got interrupt - ignored\n"; };
3e16d5fc 7440
afdb31d5 7441 eval {
3e16d5fc 7442 # enable interrupts
6cb0144a
EK
7443 local $SIG{INT} =
7444 local $SIG{TERM} =
7445 local $SIG{QUIT} =
7446 local $SIG{HUP} =
7447 local $SIG{PIPE} = sub { die "interrupted by signal\n"; };
3e16d5fc 7448
9c502e26
DM
7449 if ($archive eq '-') {
7450 print "extracting archive from STDIN\n";
7451 run_command($cmd, input => "<&STDIN");
7452 } else {
7453 print "extracting archive '$archive'\n";
7454 run_command($cmd);
7455 }
3e16d5fc
DM
7456
7457 return if $opts->{info};
7458
7459 # read new mapping
7460 my $map = {};
7461 my $statfile = "$tmpdir/qmrestore.stat";
7462 if (my $fd = IO::File->new($statfile, "r")) {
7463 while (defined (my $line = <$fd>)) {
7464 if ($line =~ m/vzdump:([^\s:]*):(\S+)$/) {
7465 $map->{$1} = $2 if $1;
7466 } else {
7467 print STDERR "unable to parse line in statfile - $line\n";
7468 }
7469 }
7470 $fd->close();
7471 }
7472
7473 my $confsrc = "$tmpdir/qemu-server.conf";
7474
f7d1505b 7475 my $srcfd = IO::File->new($confsrc, "r") || die "unable to open file '$confsrc'\n";
3e16d5fc 7476
91bd6c90 7477 my $cookie = { netcount => 0 };
3e16d5fc 7478 while (defined (my $line = <$srcfd>)) {
c62d7cf5 7479 $new_conf_raw .= restore_update_config_line(
98a4b3fb 7480 $cookie,
98a4b3fb
FE
7481 $map,
7482 $line,
7483 $opts->{unique},
7484 );
3e16d5fc
DM
7485 }
7486
7487 $srcfd->close();
3e16d5fc 7488 };
7dc7f315 7489 if (my $err = $@) {
ed221350 7490 tar_restore_cleanup($storecfg, "$tmpdir/qmrestore.stat") if !$opts->{info};
3e16d5fc 7491 die $err;
afdb31d5 7492 }
3e16d5fc
DM
7493
7494 rmtree $tmpdir;
7495
98a4b3fb 7496 PVE::Tools::file_set_contents($conffile, $new_conf_raw);
91bd6c90 7497
ed221350
DM
7498 PVE::Cluster::cfs_update(); # make sure we read new file
7499
91bd6c90
DM
7500 eval { rescan($vmid, 1); };
7501 warn $@ if $@;
3e16d5fc
DM
7502};
7503
65a5ce88 7504sub foreach_storage_used_by_vm {
18bfb361
DM
7505 my ($conf, $func) = @_;
7506
7507 my $sidhash = {};
7508
912792e2 7509 PVE::QemuConfig->foreach_volume($conf, sub {
8ddbcf8b
FG
7510 my ($ds, $drive) = @_;
7511 return if drive_is_cdrom($drive);
18bfb361
DM
7512
7513 my $volid = $drive->{file};
7514
7515 my ($sid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
be190583 7516 $sidhash->{$sid} = $sid if $sid;
8ddbcf8b 7517 });
18bfb361
DM
7518
7519 foreach my $sid (sort keys %$sidhash) {
7520 &$func($sid);
7521 }
7522}
7523
6c9f59c1
TL
7524my $qemu_snap_storage = {
7525 rbd => 1,
7526};
e5eaa028 7527sub do_snapshots_with_qemu {
9d83932d
SR
7528 my ($storecfg, $volid, $deviceid) = @_;
7529
7530 return if $deviceid =~ m/tpmstate0/;
e5eaa028
WL
7531
7532 my $storage_name = PVE::Storage::parse_volume_id($volid);
8aa2ed7c 7533 my $scfg = $storecfg->{ids}->{$storage_name};
f7d1505b 7534 die "could not find storage '$storage_name'\n" if !defined($scfg);
e5eaa028 7535
8aa2ed7c 7536 if ($qemu_snap_storage->{$scfg->{type}} && !$scfg->{krbd}){
e5eaa028
WL
7537 return 1;
7538 }
7539
7540 if ($volid =~ m/\.(qcow2|qed)$/){
7541 return 1;
7542 }
7543
d1c1af4b 7544 return;
e5eaa028
WL
7545}
7546
4dcc780c 7547sub qga_check_running {
a4938c72 7548 my ($vmid, $nowarn) = @_;
4dcc780c 7549
0a13e08e 7550 eval { mon_cmd($vmid, "guest-ping", timeout => 3); };
4dcc780c 7551 if ($@) {
a4938c72 7552 warn "Qemu Guest Agent is not running - $@" if !$nowarn;
4dcc780c
WL
7553 return 0;
7554 }
7555 return 1;
7556}
7557
04a69bb4
AD
7558sub template_create {
7559 my ($vmid, $conf, $disk) = @_;
7560
04a69bb4 7561 my $storecfg = PVE::Storage::config();
04a69bb4 7562
912792e2 7563 PVE::QemuConfig->foreach_volume($conf, sub {
9cd07842
DM
7564 my ($ds, $drive) = @_;
7565
7566 return if drive_is_cdrom($drive);
7567 return if $disk && $ds ne $disk;
7568
7569 my $volid = $drive->{file};
bbd56097 7570 return if !PVE::Storage::volume_has_feature($storecfg, 'template', $volid);
9cd07842 7571
04a69bb4
AD
7572 my $voliddst = PVE::Storage::vdisk_create_base($storecfg, $volid);
7573 $drive->{file} = $voliddst;
71c58bb7 7574 $conf->{$ds} = print_drive($drive);
ffda963f 7575 PVE::QemuConfig->write_config($vmid, $conf);
04a69bb4 7576 });
04a69bb4
AD
7577}
7578
92bdc3f0
DC
7579sub convert_iscsi_path {
7580 my ($path) = @_;
7581
7582 if ($path =~ m|^iscsi://([^/]+)/([^/]+)/(.+)$|) {
7583 my $portal = $1;
7584 my $target = $2;
7585 my $lun = $3;
7586
7587 my $initiator_name = get_initiator_name();
7588
7589 return "file.driver=iscsi,file.transport=tcp,file.initiator-name=$initiator_name,".
7590 "file.portal=$portal,file.target=$target,file.lun=$lun,driver=raw";
7591 }
7592
7593 die "cannot convert iscsi path '$path', unkown format\n";
7594}
7595
5133de42 7596sub qemu_img_convert {
988e2714 7597 my ($src_volid, $dst_volid, $size, $snapname, $is_zero_initialized) = @_;
5133de42
AD
7598
7599 my $storecfg = PVE::Storage::config();
7600 my ($src_storeid, $src_volname) = PVE::Storage::parse_volume_id($src_volid, 1);
7601 my ($dst_storeid, $dst_volname) = PVE::Storage::parse_volume_id($dst_volid, 1);
7602
af1f1ec0 7603 die "destination '$dst_volid' is not a valid volid form qemu-img convert\n" if !$dst_storeid;
6bb91c17 7604
af1f1ec0
DC
7605 my $cachemode;
7606 my $src_path;
7607 my $src_is_iscsi = 0;
bdd1feef 7608 my $src_format;
6bb91c17 7609
af1f1ec0
DC
7610 if ($src_storeid) {
7611 PVE::Storage::activate_volumes($storecfg, [$src_volid], $snapname);
5133de42 7612 my $src_scfg = PVE::Storage::storage_config($storecfg, $src_storeid);
af1f1ec0
DC
7613 $src_format = qemu_img_format($src_scfg, $src_volname);
7614 $src_path = PVE::Storage::path($storecfg, $src_volid, $snapname);
7615 $src_is_iscsi = ($src_path =~ m|^iscsi://|);
7616 $cachemode = 'none' if $src_scfg->{type} eq 'zfspool';
a23d57d5 7617 } elsif (-f $src_volid || -b $src_volid) {
af1f1ec0 7618 $src_path = $src_volid;
e0fd2b2f 7619 if ($src_path =~ m/\.($PVE::QemuServer::Drive::QEMU_FORMAT_RE)$/) {
af1f1ec0
DC
7620 $src_format = $1;
7621 }
7622 }
5133de42 7623
af1f1ec0 7624 die "source '$src_volid' is not a valid volid nor path for qemu-img convert\n" if !$src_path;
5133de42 7625
af1f1ec0
DC
7626 my $dst_scfg = PVE::Storage::storage_config($storecfg, $dst_storeid);
7627 my $dst_format = qemu_img_format($dst_scfg, $dst_volname);
7628 my $dst_path = PVE::Storage::path($storecfg, $dst_volid);
7629 my $dst_is_iscsi = ($dst_path =~ m|^iscsi://|);
5133de42 7630
af1f1ec0
DC
7631 my $cmd = [];
7632 push @$cmd, '/usr/bin/qemu-img', 'convert', '-p', '-n';
bdd1feef
TL
7633 push @$cmd, '-l', "snapshot.name=$snapname"
7634 if $snapname && $src_format && $src_format eq "qcow2";
af1f1ec0
DC
7635 push @$cmd, '-t', 'none' if $dst_scfg->{type} eq 'zfspool';
7636 push @$cmd, '-T', $cachemode if defined($cachemode);
7637
7638 if ($src_is_iscsi) {
7639 push @$cmd, '--image-opts';
7640 $src_path = convert_iscsi_path($src_path);
bdd1feef 7641 } elsif ($src_format) {
af1f1ec0
DC
7642 push @$cmd, '-f', $src_format;
7643 }
92bdc3f0 7644
af1f1ec0
DC
7645 if ($dst_is_iscsi) {
7646 push @$cmd, '--target-image-opts';
7647 $dst_path = convert_iscsi_path($dst_path);
7648 } else {
7649 push @$cmd, '-O', $dst_format;
7650 }
92bdc3f0 7651
af1f1ec0 7652 push @$cmd, $src_path;
92bdc3f0 7653
af1f1ec0
DC
7654 if (!$dst_is_iscsi && $is_zero_initialized) {
7655 push @$cmd, "zeroinit:$dst_path";
7656 } else {
7657 push @$cmd, $dst_path;
7658 }
92bdc3f0 7659
af1f1ec0
DC
7660 my $parser = sub {
7661 my $line = shift;
7662 if($line =~ m/\((\S+)\/100\%\)/){
7663 my $percent = $1;
7664 my $transferred = int($size * $percent / 100);
b5e9d97b
TL
7665 my $total_h = render_bytes($size, 1);
7666 my $transferred_h = render_bytes($transferred, 1);
92bdc3f0 7667
6629f976 7668 print "transferred $transferred_h of $total_h ($percent%)\n";
988e2714 7669 }
5133de42 7670
af1f1ec0 7671 };
5133de42 7672
af1f1ec0
DC
7673 eval { run_command($cmd, timeout => undef, outfunc => $parser); };
7674 my $err = $@;
7675 die "copy failed: $err" if $err;
5133de42
AD
7676}
7677
7678sub qemu_img_format {
7679 my ($scfg, $volname) = @_;
7680
e0fd2b2f 7681 if ($scfg->{path} && $volname =~ m/\.($PVE::QemuServer::Drive::QEMU_FORMAT_RE)$/) {
5133de42 7682 return $1;
be190583 7683 } else {
5133de42 7684 return "raw";
5133de42
AD
7685 }
7686}
7687
cfad42af 7688sub qemu_drive_mirror {
bc6c8231 7689 my ($vmid, $drive, $dst_volid, $vmiddst, $is_zero_initialized, $jobs, $completion, $qga, $bwlimit, $src_bitmap) = @_;
cfad42af 7690
5a345967
AD
7691 $jobs = {} if !$jobs;
7692
7693 my $qemu_target;
7694 my $format;
35e4ab04 7695 $jobs->{"drive-$drive"} = {};
152fe752 7696
1e5143de 7697 if ($dst_volid =~ /^nbd:/) {
87955688 7698 $qemu_target = $dst_volid;
5a345967 7699 $format = "nbd";
5a345967 7700 } else {
5a345967
AD
7701 my $storecfg = PVE::Storage::config();
7702 my ($dst_storeid, $dst_volname) = PVE::Storage::parse_volume_id($dst_volid);
7703
7704 my $dst_scfg = PVE::Storage::storage_config($storecfg, $dst_storeid);
cfad42af 7705
5a345967 7706 $format = qemu_img_format($dst_scfg, $dst_volname);
21ccdb50 7707
5a345967 7708 my $dst_path = PVE::Storage::path($storecfg, $dst_volid);
21ccdb50 7709
5a345967
AD
7710 $qemu_target = $is_zero_initialized ? "zeroinit:$dst_path" : $dst_path;
7711 }
988e2714
WB
7712
7713 my $opts = { timeout => 10, device => "drive-$drive", mode => "existing", sync => "full", target => $qemu_target };
88383920
DM
7714 $opts->{format} = $format if $format;
7715
bc6c8231
FG
7716 if (defined($src_bitmap)) {
7717 $opts->{sync} = 'incremental';
7718 $opts->{bitmap} = $src_bitmap;
7719 print "drive mirror re-using dirty bitmap '$src_bitmap'\n";
7720 }
7721
9fa05d31 7722 if (defined($bwlimit)) {
f6409f61
TL
7723 $opts->{speed} = $bwlimit * 1024;
7724 print "drive mirror is starting for drive-$drive with bandwidth limit: ${bwlimit} KB/s\n";
9fa05d31
SI
7725 } else {
7726 print "drive mirror is starting for drive-$drive\n";
7727 }
21ccdb50 7728
6dde5ea2 7729 # if a job already runs for this device we get an error, catch it for cleanup
0a13e08e 7730 eval { mon_cmd($vmid, "drive-mirror", %$opts); };
5a345967
AD
7731 if (my $err = $@) {
7732 eval { PVE::QemuServer::qemu_blockjobs_cancel($vmid, $jobs) };
6dde5ea2
TL
7733 warn "$@\n" if $@;
7734 die "mirroring error: $err\n";
5a345967
AD
7735 }
7736
e02fb126 7737 qemu_drive_mirror_monitor ($vmid, $vmiddst, $jobs, $completion, $qga);
5a345967
AD
7738}
7739
db1f8b39
FG
7740# $completion can be either
7741# 'complete': wait until all jobs are ready, block-job-complete them (default)
7742# 'cancel': wait until all jobs are ready, block-job-cancel them
7743# 'skip': wait until all jobs are ready, return with block jobs in ready state
9e671722 7744# 'auto': wait until all jobs disappear, only use for jobs which complete automatically
5a345967 7745sub qemu_drive_mirror_monitor {
9e671722 7746 my ($vmid, $vmiddst, $jobs, $completion, $qga, $op) = @_;
e02fb126 7747
db1f8b39 7748 $completion //= 'complete';
9e671722 7749 $op //= "mirror";
2e953867 7750
08ac653f 7751 eval {
5a345967
AD
7752 my $err_complete = 0;
7753
3b56383b 7754 my $starttime = time ();
08ac653f 7755 while (1) {
9e671722 7756 die "block job ('$op') timed out\n" if $err_complete > 300;
5a345967 7757
0a13e08e 7758 my $stats = mon_cmd($vmid, "query-block-jobs");
3b56383b 7759 my $ctime = time();
08ac653f 7760
9e671722 7761 my $running_jobs = {};
0ea24bf0 7762 for my $stat (@$stats) {
9e671722
SR
7763 next if $stat->{type} ne $op;
7764 $running_jobs->{$stat->{device}} = $stat;
5a345967 7765 }
08ac653f 7766
5a345967 7767 my $readycounter = 0;
67fb9de6 7768
0ea24bf0 7769 for my $job_id (sort keys %$jobs) {
1057fc74 7770 my $job = $running_jobs->{$job_id};
5a345967 7771
1057fc74 7772 my $vanished = !defined($job);
0ea24bf0 7773 my $complete = defined($jobs->{$job_id}->{complete}) && $vanished;
9e671722 7774 if($complete || ($vanished && $completion eq 'auto')) {
3b56383b 7775 print "$job_id: $op-job finished\n";
0ea24bf0 7776 delete $jobs->{$job_id};
5a345967
AD
7777 next;
7778 }
7779
1057fc74 7780 die "$job_id: '$op' has been cancelled\n" if !defined($job);
f34ebd52 7781
1057fc74
TL
7782 my $busy = $job->{busy};
7783 my $ready = $job->{ready};
7784 if (my $total = $job->{len}) {
7785 my $transferred = $job->{offset} || 0;
5a345967
AD
7786 my $remaining = $total - $transferred;
7787 my $percent = sprintf "%.2f", ($transferred * 100 / $total);
08ac653f 7788
3b56383b
TL
7789 my $duration = $ctime - $starttime;
7790 my $total_h = render_bytes($total, 1);
7791 my $transferred_h = render_bytes($transferred, 1);
7792
7793 my $status = sprintf(
7794 "transferred $transferred_h of $total_h ($percent%%) in %s",
7795 render_duration($duration),
7796 );
7797
7798 if ($ready) {
7799 if ($busy) {
7800 $status .= ", still busy"; # shouldn't even happen? but mirror is weird
7801 } else {
7802 $status .= ", ready";
7803 }
7804 }
67daf692
TL
7805 print "$job_id: $status\n" if !$jobs->{$job_id}->{ready};
7806 $jobs->{$job_id}->{ready} = $ready;
5a345967 7807 }
f34ebd52 7808
1057fc74 7809 $readycounter++ if $job->{ready};
5a345967 7810 }
b467f79a 7811
5a345967
AD
7812 last if scalar(keys %$jobs) == 0;
7813
7814 if ($readycounter == scalar(keys %$jobs)) {
9e671722
SR
7815 print "all '$op' jobs are ready\n";
7816
7817 # do the complete later (or has already been done)
7818 last if $completion eq 'skip' || $completion eq 'auto';
5a345967
AD
7819
7820 if ($vmiddst && $vmiddst != $vmid) {
1a988fd2
DC
7821 my $agent_running = $qga && qga_check_running($vmid);
7822 if ($agent_running) {
5619e74a 7823 print "freeze filesystem\n";
0a13e08e 7824 eval { mon_cmd($vmid, "guest-fsfreeze-freeze"); };
d6cdfae4 7825 warn $@ if $@;
5619e74a
AD
7826 } else {
7827 print "suspend vm\n";
7828 eval { PVE::QemuServer::vm_suspend($vmid, 1); };
d6cdfae4 7829 warn $@ if $@;
5619e74a
AD
7830 }
7831
5a345967
AD
7832 # if we clone a disk for a new target vm, we don't switch the disk
7833 PVE::QemuServer::qemu_blockjobs_cancel($vmid, $jobs);
5619e74a 7834
1a988fd2 7835 if ($agent_running) {
5619e74a 7836 print "unfreeze filesystem\n";
0a13e08e 7837 eval { mon_cmd($vmid, "guest-fsfreeze-thaw"); };
d6cdfae4 7838 warn $@ if $@;
5619e74a
AD
7839 } else {
7840 print "resume vm\n";
d6cdfae4
FE
7841 eval { PVE::QemuServer::vm_resume($vmid, 1, 1); };
7842 warn $@ if $@;
5619e74a
AD
7843 }
7844
2e953867 7845 last;
5a345967
AD
7846 } else {
7847
0ea24bf0 7848 for my $job_id (sort keys %$jobs) {
5a345967 7849 # try to switch the disk if source and destination are on the same guest
0ea24bf0 7850 print "$job_id: Completing block job_id...\n";
5a345967 7851
e02fb126 7852 my $op;
db1f8b39 7853 if ($completion eq 'complete') {
e02fb126 7854 $op = 'block-job-complete';
db1f8b39 7855 } elsif ($completion eq 'cancel') {
e02fb126
ML
7856 $op = 'block-job-cancel';
7857 } else {
7858 die "invalid completion value: $completion\n";
7859 }
0ea24bf0 7860 eval { mon_cmd($vmid, $op, device => $job_id) };
5a345967 7861 if ($@ =~ m/cannot be completed/) {
3b56383b 7862 print "$job_id: block job cannot be completed, trying again.\n";
5a345967
AD
7863 $err_complete++;
7864 }else {
0ea24bf0
TL
7865 print "$job_id: Completed successfully.\n";
7866 $jobs->{$job_id}->{complete} = 1;
5a345967
AD
7867 }
7868 }
2e953867 7869 }
08ac653f 7870 }
08ac653f 7871 sleep 1;
cfad42af 7872 }
08ac653f 7873 };
88383920 7874 my $err = $@;
08ac653f 7875
88383920 7876 if ($err) {
5a345967 7877 eval { PVE::QemuServer::qemu_blockjobs_cancel($vmid, $jobs) };
3b56383b 7878 die "block job ($op) error: $err";
88383920 7879 }
5a345967
AD
7880}
7881
7882sub qemu_blockjobs_cancel {
7883 my ($vmid, $jobs) = @_;
7884
7885 foreach my $job (keys %$jobs) {
bd2d5fe6 7886 print "$job: Cancelling block job\n";
0a13e08e 7887 eval { mon_cmd($vmid, "block-job-cancel", device => $job); };
5a345967
AD
7888 $jobs->{$job}->{cancel} = 1;
7889 }
7890
7891 while (1) {
0a13e08e 7892 my $stats = mon_cmd($vmid, "query-block-jobs");
5a345967
AD
7893
7894 my $running_jobs = {};
7895 foreach my $stat (@$stats) {
7896 $running_jobs->{$stat->{device}} = $stat;
7897 }
7898
7899 foreach my $job (keys %$jobs) {
7900
bd2d5fe6
WB
7901 if (defined($jobs->{$job}->{cancel}) && !defined($running_jobs->{$job})) {
7902 print "$job: Done.\n";
5a345967
AD
7903 delete $jobs->{$job};
7904 }
7905 }
7906
7907 last if scalar(keys %$jobs) == 0;
7908
7909 sleep 1;
cfad42af
AD
7910 }
7911}
7912
152fe752 7913sub clone_disk {
1196086f
FE
7914 my ($storecfg, $source, $dest, $full, $newvollist, $jobs, $completion, $qga, $bwlimit) = @_;
7915
7916 my ($vmid, $running) = $source->@{qw(vmid running)};
25166060 7917 my ($src_drivename, $drive, $snapname) = $source->@{qw(drivename drive snapname)};
1196086f 7918
25166060 7919 my ($newvmid, $dst_drivename, $efisize) = $dest->@{qw(vmid drivename efisize)};
1196086f 7920 my ($storage, $format) = $dest->@{qw(storage format)};
152fe752 7921
5f957592
FE
7922 my $use_drive_mirror = $full && $running && $src_drivename && !$snapname;
7923
25166060
FE
7924 if ($src_drivename && $dst_drivename && $src_drivename ne $dst_drivename) {
7925 die "cloning from/to EFI disk requires EFI disk\n"
7926 if $src_drivename eq 'efidisk0' || $dst_drivename eq 'efidisk0';
7927 die "cloning from/to TPM state requires TPM state\n"
7928 if $src_drivename eq 'tpmstate0' || $dst_drivename eq 'tpmstate0';
5f957592
FE
7929
7930 # This would lead to two device nodes in QEMU pointing to the same backing image!
7931 die "cannot change drive name when cloning disk from/to the same VM\n"
7932 if $use_drive_mirror && $vmid == $newvmid;
25166060
FE
7933 }
7934
1d1f8f9a
FE
7935 die "cannot move TPM state while VM is running\n"
7936 if $use_drive_mirror && $src_drivename eq 'tpmstate0';
7937
152fe752
DM
7938 my $newvolid;
7939
25166060
FE
7940 print "create " . ($full ? 'full' : 'linked') . " clone of drive ";
7941 print "$src_drivename " if $src_drivename;
7942 print "($drive->{file})\n";
7943
152fe752 7944 if (!$full) {
258e646c 7945 $newvolid = PVE::Storage::vdisk_clone($storecfg, $drive->{file}, $newvmid, $snapname);
152fe752
DM
7946 push @$newvollist, $newvolid;
7947 } else {
5a345967 7948
152fe752
DM
7949 my ($storeid, $volname) = PVE::Storage::parse_volume_id($drive->{file});
7950 $storeid = $storage if $storage;
7951
44549149 7952 my $dst_format = resolve_dst_disk_format($storecfg, $storeid, $volname, $format);
152fe752 7953
931432bd 7954 my $name = undef;
d0abc774 7955 my $size = undef;
7fe8b44c
TL
7956 if (drive_is_cloudinit($drive)) {
7957 $name = "vm-$newvmid-cloudinit";
c997e24a
ML
7958 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
7959 if ($scfg->{path}) {
7960 $name .= ".$dst_format";
7961 }
7fe8b44c
TL
7962 $snapname = undef;
7963 $size = PVE::QemuServer::Cloudinit::CLOUDINIT_DISK_SIZE;
25166060 7964 } elsif ($dst_drivename eq 'efidisk0') {
7344af7b 7965 $size = $efisize or die "internal error - need to specify EFI disk size\n";
25166060 7966 } elsif ($dst_drivename eq 'tpmstate0') {
5f5aba25 7967 $dst_format = 'raw';
f9dde219 7968 $size = PVE::QemuServer::Drive::TPMSTATE_DISK_SIZE;
d0abc774 7969 } else {
3bae384f 7970 ($size) = PVE::Storage::volume_size_info($storecfg, $drive->{file}, 10);
7fe8b44c 7971 }
b5688f69
FE
7972 $newvolid = PVE::Storage::vdisk_alloc(
7973 $storecfg, $storeid, $newvmid, $dst_format, $name, ($size/1024)
7974 );
152fe752
DM
7975 push @$newvollist, $newvolid;
7976
3999f370 7977 PVE::Storage::activate_volumes($storecfg, [$newvolid]);
1dbd6d30 7978
7fe8b44c 7979 if (drive_is_cloudinit($drive)) {
1b485263
ML
7980 # when cloning multiple disks (e.g. during clone_vm) it might be the last disk
7981 # if this is the case, we have to complete any block-jobs still there from
7982 # previous drive-mirrors
7983 if (($completion eq 'complete') && (scalar(keys %$jobs) > 0)) {
7984 qemu_drive_mirror_monitor($vmid, $newvmid, $jobs, $completion, $qga);
7985 }
7fe8b44c
TL
7986 goto no_data_clone;
7987 }
7988
988e2714 7989 my $sparseinit = PVE::Storage::volume_has_feature($storecfg, 'sparseinit', $newvolid);
5f957592 7990 if ($use_drive_mirror) {
5f957592
FE
7991 qemu_drive_mirror($vmid, $src_drivename, $newvolid, $newvmid, $sparseinit, $jobs,
7992 $completion, $qga, $bwlimit);
7993 } else {
d189e590 7994 # TODO: handle bwlimits
25166060 7995 if ($dst_drivename eq 'efidisk0') {
818ce80e
DC
7996 # the relevant data on the efidisk may be smaller than the source
7997 # e.g. on RBD/ZFS, so we use dd to copy only the amount
7998 # that is given by the OVMF_VARS.fd
62375438 7999 my $src_path = PVE::Storage::path($storecfg, $drive->{file}, $snapname);
818ce80e 8000 my $dst_path = PVE::Storage::path($storecfg, $newvolid);
fdfdc80e 8001
62375438
FE
8002 my $src_format = (PVE::Storage::parse_volname($storecfg, $drive->{file}))[6];
8003
fdfdc80e
FE
8004 # better for Ceph if block size is not too small, see bug #3324
8005 my $bs = 1024*1024;
8006
62375438 8007 my $cmd = ['qemu-img', 'dd', '-n', '-O', $dst_format];
a9c45bd4
FE
8008
8009 if ($src_format eq 'qcow2' && $snapname) {
8010 die "cannot clone qcow2 EFI disk snapshot - requires QEMU >= 6.2\n"
8011 if !min_version(kvm_user_version(), 6, 2);
8012 push $cmd->@*, '-l', $snapname;
8013 }
62375438
FE
8014 push $cmd->@*, "bs=$bs", "osize=$size", "if=$src_path", "of=$dst_path";
8015 run_command($cmd);
818ce80e
DC
8016 } else {
8017 qemu_img_convert($drive->{file}, $newvolid, $size, $snapname, $sparseinit);
8018 }
be190583 8019 }
152fe752
DM
8020 }
8021
7fe8b44c 8022no_data_clone:
3bae384f 8023 my ($size) = eval { PVE::Storage::volume_size_info($storecfg, $newvolid, 10) };
152fe752 8024
3b53c471
FE
8025 my $disk = dclone($drive);
8026 delete $disk->{format};
152fe752 8027 $disk->{file} = $newvolid;
3bae384f 8028 $disk->{size} = $size if defined($size);
152fe752
DM
8029
8030 return $disk;
8031}
8032
98cfd8b6
AD
8033sub get_running_qemu_version {
8034 my ($vmid) = @_;
0a13e08e 8035 my $res = mon_cmd($vmid, "query-version");
98cfd8b6
AD
8036 return "$res->{qemu}->{major}.$res->{qemu}->{minor}";
8037}
8038
249c4a6c
AD
8039sub qemu_use_old_bios_files {
8040 my ($machine_type) = @_;
8041
8042 return if !$machine_type;
8043
8044 my $use_old_bios_files = undef;
8045
8046 if ($machine_type =~ m/^(\S+)\.pxe$/) {
8047 $machine_type = $1;
8048 $use_old_bios_files = 1;
8049 } else {
4df98f2f 8050 my $version = extract_version($machine_type, kvm_user_version());
249c4a6c
AD
8051 # Note: kvm version < 2.4 use non-efi pxe files, and have problems when we
8052 # load new efi bios files on migration. So this hack is required to allow
8053 # live migration from qemu-2.2 to qemu-2.4, which is sometimes used when
8054 # updrading from proxmox-ve-3.X to proxmox-ve 4.0
2ea5fb7e 8055 $use_old_bios_files = !min_version($version, 2, 4);
249c4a6c
AD
8056 }
8057
8058 return ($use_old_bios_files, $machine_type);
8059}
8060
818ce80e 8061sub get_efivars_size {
ff84f0e3
FE
8062 my ($conf, $efidisk) = @_;
8063
818ce80e 8064 my $arch = get_vm_arch($conf);
ff84f0e3 8065 $efidisk //= $conf->{efidisk0} ? parse_drive('efidisk0', $conf->{efidisk0}) : undef;
90b20b15
DC
8066 my $smm = PVE::QemuServer::Machine::machine_type_is_q35($conf);
8067 my (undef, $ovmf_vars) = get_ovmf_files($arch, $efidisk, $smm);
818ce80e
DC
8068 die "uefi vars image '$ovmf_vars' not found\n" if ! -f $ovmf_vars;
8069 return -s $ovmf_vars;
8070}
8071
8072sub update_efidisk_size {
8073 my ($conf) = @_;
8074
8075 return if !defined($conf->{efidisk0});
8076
8077 my $disk = PVE::QemuServer::parse_drive('efidisk0', $conf->{efidisk0});
8078 $disk->{size} = get_efivars_size($conf);
8079 $conf->{efidisk0} = print_drive($disk);
8080
8081 return;
8082}
8083
f9dde219
SR
8084sub update_tpmstate_size {
8085 my ($conf) = @_;
8086
8087 my $disk = PVE::QemuServer::parse_drive('tpmstate0', $conf->{tpmstate0});
8088 $disk->{size} = PVE::QemuServer::Drive::TPMSTATE_DISK_SIZE;
8089 $conf->{tpmstate0} = print_drive($disk);
8090}
8091
90b20b15
DC
8092sub create_efidisk($$$$$$$) {
8093 my ($storecfg, $storeid, $vmid, $fmt, $arch, $efidisk, $smm) = @_;
3e1f1122 8094
90b20b15 8095 my (undef, $ovmf_vars) = get_ovmf_files($arch, $efidisk, $smm);
96ed3574 8096 die "EFI vars default image not found\n" if ! -f $ovmf_vars;
3e1f1122 8097
af1f1ec0
DC
8098 my $vars_size_b = -s $ovmf_vars;
8099 my $vars_size = PVE::Tools::convert_size($vars_size_b, 'b' => 'kb');
3e1f1122
TL
8100 my $volid = PVE::Storage::vdisk_alloc($storecfg, $storeid, $vmid, $fmt, undef, $vars_size);
8101 PVE::Storage::activate_volumes($storecfg, [$volid]);
8102
af1f1ec0 8103 qemu_img_convert($ovmf_vars, $volid, $vars_size_b, undef, 0);
340dbcf7 8104 my ($size) = PVE::Storage::volume_size_info($storecfg, $volid, 3);
3e1f1122 8105
340dbcf7 8106 return ($volid, $size/1024);
3e1f1122
TL
8107}
8108
22de899a
AD
8109sub vm_iothreads_list {
8110 my ($vmid) = @_;
8111
0a13e08e 8112 my $res = mon_cmd($vmid, 'query-iothreads');
22de899a
AD
8113
8114 my $iothreads = {};
8115 foreach my $iothread (@$res) {
8116 $iothreads->{ $iothread->{id} } = $iothread->{"thread-id"};
8117 }
8118
8119 return $iothreads;
8120}
8121
ee034f5c
AD
8122sub scsihw_infos {
8123 my ($conf, $drive) = @_;
8124
8125 my $maxdev = 0;
8126
7fe1b688 8127 if (!$conf->{scsihw} || ($conf->{scsihw} =~ m/^lsi/)) {
ee034f5c 8128 $maxdev = 7;
a1511b3c 8129 } elsif ($conf->{scsihw} && ($conf->{scsihw} eq 'virtio-scsi-single')) {
ee034f5c
AD
8130 $maxdev = 1;
8131 } else {
8132 $maxdev = 256;
8133 }
8134
8135 my $controller = int($drive->{index} / $maxdev);
4df98f2f
TL
8136 my $controller_prefix = ($conf->{scsihw} && $conf->{scsihw} eq 'virtio-scsi-single')
8137 ? "virtioscsi"
8138 : "scsihw";
ee034f5c
AD
8139
8140 return ($maxdev, $controller, $controller_prefix);
8141}
a1511b3c 8142
44549149
EK
8143sub resolve_dst_disk_format {
8144 my ($storecfg, $storeid, $src_volname, $format) = @_;
8145 my ($defFormat, $validFormats) = PVE::Storage::storage_default_format($storecfg, $storeid);
8146
8147 if (!$format) {
8148 # if no target format is specified, use the source disk format as hint
8149 if ($src_volname) {
8150 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
8151 $format = qemu_img_format($scfg, $src_volname);
8152 } else {
8153 return $defFormat;
8154 }
8155 }
8156
8157 # test if requested format is supported - else use default
8158 my $supported = grep { $_ eq $format } @$validFormats;
8159 $format = $defFormat if !$supported;
8160 return $format;
8161}
8162
66cebc46
DC
8163# NOTE: if this logic changes, please update docs & possibly gui logic
8164sub find_vmstate_storage {
8165 my ($conf, $storecfg) = @_;
8166
8167 # first, return storage from conf if set
8168 return $conf->{vmstatestorage} if $conf->{vmstatestorage};
8169
8170 my ($target, $shared, $local);
8171
8172 foreach_storage_used_by_vm($conf, sub {
8173 my ($sid) = @_;
8174 my $scfg = PVE::Storage::storage_config($storecfg, $sid);
8175 my $dst = $scfg->{shared} ? \$shared : \$local;
8176 $$dst = $sid if !$$dst || $scfg->{path}; # prefer file based storage
8177 });
8178
8179 # second, use shared storage where VM has at least one disk
8180 # third, use local storage where VM has at least one disk
8181 # fall back to local storage
8182 $target = $shared // $local // 'local';
8183
8184 return $target;
8185}
8186
6ee499ff 8187sub generate_uuid {
ae2fcb3b
EK
8188 my ($uuid, $uuid_str);
8189 UUID::generate($uuid);
8190 UUID::unparse($uuid, $uuid_str);
6ee499ff
DC
8191 return $uuid_str;
8192}
8193
8194sub generate_smbios1_uuid {
8195 return "uuid=".generate_uuid();
ae2fcb3b
EK
8196}
8197
9c152e87
TL
8198sub nbd_stop {
8199 my ($vmid) = @_;
8200
0a13e08e 8201 mon_cmd($vmid, 'nbd-server-stop');
9c152e87
TL
8202}
8203
dae98db9
DC
8204sub create_reboot_request {
8205 my ($vmid) = @_;
8206 open(my $fh, '>', "/run/qemu-server/$vmid.reboot")
8207 or die "failed to create reboot trigger file: $!\n";
8208 close($fh);
8209}
8210
8211sub clear_reboot_request {
8212 my ($vmid) = @_;
8213 my $path = "/run/qemu-server/$vmid.reboot";
8214 my $res = 0;
8215
8216 $res = unlink($path);
8217 die "could not remove reboot request for $vmid: $!"
8218 if !$res && $! != POSIX::ENOENT;
8219
8220 return $res;
8221}
8222
5cfa9f5f
SR
8223sub bootorder_from_legacy {
8224 my ($conf, $bootcfg) = @_;
8225
8226 my $boot = $bootcfg->{legacy} || $boot_fmt->{legacy}->{default};
8227 my $bootindex_hash = {};
8228 my $i = 1;
8229 foreach my $o (split(//, $boot)) {
8230 $bootindex_hash->{$o} = $i*100;
8231 $i++;
8232 }
8233
8234 my $bootorder = {};
8235
8236 PVE::QemuConfig->foreach_volume($conf, sub {
8237 my ($ds, $drive) = @_;
8238
8239 if (drive_is_cdrom ($drive, 1)) {
8240 if ($bootindex_hash->{d}) {
8241 $bootorder->{$ds} = $bootindex_hash->{d};
8242 $bootindex_hash->{d} += 1;
8243 }
8244 } elsif ($bootindex_hash->{c}) {
8245 $bootorder->{$ds} = $bootindex_hash->{c}
8246 if $conf->{bootdisk} && $conf->{bootdisk} eq $ds;
8247 $bootindex_hash->{c} += 1;
8248 }
8249 });
8250
8251 if ($bootindex_hash->{n}) {
8252 for (my $i = 0; $i < $MAX_NETS; $i++) {
8253 my $netname = "net$i";
8254 next if !$conf->{$netname};
8255 $bootorder->{$netname} = $bootindex_hash->{n};
8256 $bootindex_hash->{n} += 1;
8257 }
8258 }
8259
8260 return $bootorder;
8261}
8262
8263# Generate default device list for 'boot: order=' property. Matches legacy
8264# default boot order, but with explicit device names. This is important, since
8265# the fallback for when neither 'order' nor the old format is specified relies
8266# on 'bootorder_from_legacy' above, and it would be confusing if this diverges.
8267sub get_default_bootdevices {
8268 my ($conf) = @_;
8269
8270 my @ret = ();
8271
8272 # harddisk
8273 my $first = PVE::QemuServer::Drive::resolve_first_disk($conf, 0);
8274 push @ret, $first if $first;
8275
8276 # cdrom
8277 $first = PVE::QemuServer::Drive::resolve_first_disk($conf, 1);
8278 push @ret, $first if $first;
8279
8280 # network
8281 for (my $i = 0; $i < $MAX_NETS; $i++) {
8282 my $netname = "net$i";
8283 next if !$conf->{$netname};
8284 push @ret, $netname;
8285 last;
8286 }
8287
8288 return \@ret;
8289}
8290
e5d611c3
TL
8291sub device_bootorder {
8292 my ($conf) = @_;
8293
8294 return bootorder_from_legacy($conf) if !defined($conf->{boot});
8295
8296 my $boot = parse_property_string($boot_fmt, $conf->{boot});
8297
8298 my $bootorder = {};
8299 if (!defined($boot) || $boot->{legacy}) {
8300 $bootorder = bootorder_from_legacy($conf, $boot);
8301 } elsif ($boot->{order}) {
8302 my $i = 100; # start at 100 to allow user to insert devices before us with -args
8303 for my $dev (PVE::Tools::split_list($boot->{order})) {
8304 $bootorder->{$dev} = $i++;
8305 }
8306 }
8307
8308 return $bootorder;
8309}
8310
65911545
SR
8311sub register_qmeventd_handle {
8312 my ($vmid) = @_;
8313
8314 my $fh;
8315 my $peer = "/var/run/qmeventd.sock";
8316 my $count = 0;
8317
8318 for (;;) {
8319 $count++;
8320 $fh = IO::Socket::UNIX->new(Peer => $peer, Blocking => 0, Timeout => 1);
8321 last if $fh;
8322 if ($! != EINTR && $! != EAGAIN) {
8323 die "unable to connect to qmeventd socket (vmid: $vmid) - $!\n";
8324 }
8325 if ($count > 4) {
8326 die "unable to connect to qmeventd socket (vmid: $vmid) - timeout "
8327 . "after $count retries\n";
8328 }
8329 usleep(25000);
8330 }
8331
8332 # send handshake to mark VM as backing up
8333 print $fh to_json({vzdump => {vmid => "$vmid"}});
8334
8335 # return handle to be closed later when inhibit is no longer required
8336 return $fh;
8337}
8338
65e866e5
DM
8339# bash completion helper
8340
8341sub complete_backup_archives {
8342 my ($cmdname, $pname, $cvalue) = @_;
8343
8344 my $cfg = PVE::Storage::config();
8345
8346 my $storeid;
8347
8348 if ($cvalue =~ m/^([^:]+):/) {
8349 $storeid = $1;
8350 }
8351
8352 my $data = PVE::Storage::template_list($cfg, $storeid, 'backup');
8353
8354 my $res = [];
8355 foreach my $id (keys %$data) {
8356 foreach my $item (@{$data->{$id}}) {
f43a4f12 8357 next if $item->{format} !~ m/^vma\.(${\PVE::Storage::Plugin::COMPRESSOR_RE})$/;
65e866e5
DM
8358 push @$res, $item->{volid} if defined($item->{volid});
8359 }
8360 }
8361
8362 return $res;
8363}
8364
8365my $complete_vmid_full = sub {
8366 my ($running) = @_;
8367
8368 my $idlist = vmstatus();
8369
8370 my $res = [];
8371
8372 foreach my $id (keys %$idlist) {
8373 my $d = $idlist->{$id};
8374 if (defined($running)) {
8375 next if $d->{template};
8376 next if $running && $d->{status} ne 'running';
8377 next if !$running && $d->{status} eq 'running';
8378 }
8379 push @$res, $id;
8380
8381 }
8382 return $res;
8383};
8384
8385sub complete_vmid {
8386 return &$complete_vmid_full();
8387}
8388
8389sub complete_vmid_stopped {
8390 return &$complete_vmid_full(0);
8391}
8392
8393sub complete_vmid_running {
8394 return &$complete_vmid_full(1);
8395}
8396
335af808
DM
8397sub complete_storage {
8398
8399 my $cfg = PVE::Storage::config();
8400 my $ids = $cfg->{ids};
8401
8402 my $res = [];
8403 foreach my $sid (keys %$ids) {
8404 next if !PVE::Storage::storage_check_enabled($cfg, $sid, undef, 1);
c4c844ef 8405 next if !$ids->{$sid}->{content}->{images};
335af808
DM
8406 push @$res, $sid;
8407 }
8408
8409 return $res;
8410}
8411
255e9c54
AL
8412sub complete_migration_storage {
8413 my ($cmd, $param, $current_value, $all_args) = @_;
8414
8415 my $targetnode = @$all_args[1];
8416
8417 my $cfg = PVE::Storage::config();
8418 my $ids = $cfg->{ids};
8419
8420 my $res = [];
8421 foreach my $sid (keys %$ids) {
8422 next if !PVE::Storage::storage_check_enabled($cfg, $sid, $targetnode, 1);
8423 next if !$ids->{$sid}->{content}->{images};
8424 push @$res, $sid;
8425 }
8426
8427 return $res;
8428}
8429
b08c37c3
DC
8430sub vm_is_paused {
8431 my ($vmid) = @_;
8432 my $qmpstatus = eval {
8433 PVE::QemuConfig::assert_config_exists_on_node($vmid);
8434 mon_cmd($vmid, "query-status");
8435 };
8436 warn "$@\n" if $@;
8437 return $qmpstatus && $qmpstatus->{status} eq "paused";
8438}
8439
3f11f0d7
LS
8440sub check_volume_storage_type {
8441 my ($storecfg, $vol) = @_;
8442
8443 my ($storeid, $volname) = PVE::Storage::parse_volume_id($vol);
8444 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
8445 my ($vtype) = PVE::Storage::parse_volname($storecfg, $vol);
8446
8447 die "storage '$storeid' does not support content-type '$vtype'\n"
8448 if !$scfg->{content}->{$vtype};
8449
8450 return 1;
8451}
8452
21947fea
AD
8453sub add_nets_bridge_fdb {
8454 my ($conf, $vmid) = @_;
8455
1b5ba4dd
TL
8456 for my $opt (keys %$conf) {
8457 next if $opt !~ m/^net(\d+)$/;
8458 my $iface = "tap${vmid}i$1";
4ddd2ca2
TL
8459 # NOTE: expect setups with learning off to *not* use auto-random-generation of MAC on start
8460 my $net = parse_net($conf->{$opt}, 1) or next;
8461
8462 my $mac = $net->{macaddr};
8463 if (!$mac) {
8464 log_warn("MAC learning disabled, but vNIC '$iface' has no static MAC to add to forwarding DB!")
8465 if !file_read_firstline("/sys/class/net/$iface/brport/learning");
8466 next;
8467 }
21947fea 8468
f81c9843 8469 my $bridge = $net->{bridge};
1b5ba4dd 8470 if ($have_sdn) {
f81c9843 8471 PVE::Network::SDN::Zones::add_bridge_fdb($iface, $mac, $bridge, $net->{firewall});
fe62da4f 8472 } elsif (-d "/sys/class/net/$bridge/bridge") { # avoid fdb management with OVS for now
1b5ba4dd 8473 PVE::Network::add_bridge_fdb($iface, $mac, $net->{firewall});
21947fea
AD
8474 }
8475 }
8476}
1b5ba4dd 8477
73ed6496
AD
8478sub del_nets_bridge_fdb {
8479 my ($conf, $vmid) = @_;
8480
8481 for my $opt (keys %$conf) {
8482 next if $opt !~ m/^net(\d+)$/;
8483 my $iface = "tap${vmid}i$1";
8484
8485 my $net = parse_net($conf->{$opt}) or next;
8486 my $mac = $net->{macaddr} or next;
8487
f81c9843 8488 my $bridge = $net->{bridge};
73ed6496 8489 if ($have_sdn) {
f81c9843 8490 PVE::Network::SDN::Zones::del_bridge_fdb($iface, $mac, $bridge, $net->{firewall});
fe62da4f 8491 } elsif (-d "/sys/class/net/$bridge/bridge") { # avoid fdb management with OVS for now
73ed6496
AD
8492 PVE::Network::del_bridge_fdb($iface, $mac, $net->{firewall});
8493 }
8494 }
8495}
8496
1e3baf05 84971;