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