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