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