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