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