]> git.proxmox.com Git - qemu-server.git/blame - PVE/QemuServer.pm
bump version to 6.2-18
[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) = @_;
4c27b18c 1151 return "" if !@$devs;
5cfa9f5f
SR
1152 my $data = { order => join(';', @$devs) };
1153 return PVE::JSONSchema::print_property_string($data, $boot_fmt);
1154}
1155
1e3baf05
DM
1156my $kvm_api_version = 0;
1157
1158sub kvm_version {
1e3baf05
DM
1159 return $kvm_api_version if $kvm_api_version;
1160
808a65b5 1161 open my $fh, '<', '/dev/kvm' or return;
1e3baf05 1162
646f2df4
WB
1163 # 0xae00 => KVM_GET_API_VERSION
1164 $kvm_api_version = ioctl($fh, 0xae00, 0);
808a65b5 1165 close($fh);
1e3baf05 1166
646f2df4 1167 return $kvm_api_version;
1e3baf05
DM
1168}
1169
1476b99f
DC
1170my $kvm_user_version = {};
1171my $kvm_mtime = {};
1e3baf05
DM
1172
1173sub kvm_user_version {
1476b99f 1174 my ($binary) = @_;
1e3baf05 1175
1476b99f
DC
1176 $binary //= get_command_for_arch(get_host_arch()); # get the native arch by default
1177 my $st = stat($binary);
1e3baf05 1178
1476b99f
DC
1179 my $cachedmtime = $kvm_mtime->{$binary} // -1;
1180 return $kvm_user_version->{$binary} if $kvm_user_version->{$binary} &&
1181 $cachedmtime == $st->mtime;
1182
1183 $kvm_user_version->{$binary} = 'unknown';
1184 $kvm_mtime->{$binary} = $st->mtime;
1e3baf05 1185
09b11429
TL
1186 my $code = sub {
1187 my $line = shift;
1188 if ($line =~ m/^QEMU( PC)? emulator version (\d+\.\d+(\.\d+)?)(\.\d+)?[,\s]/) {
1476b99f 1189 $kvm_user_version->{$binary} = $2;
09b11429
TL
1190 }
1191 };
19672434 1192
1476b99f 1193 eval { run_command([$binary, '--version'], outfunc => $code); };
09b11429 1194 warn $@ if $@;
1e3baf05 1195
1476b99f 1196 return $kvm_user_version->{$binary};
1e3baf05
DM
1197
1198}
4df98f2f
TL
1199my sub extract_version {
1200 my ($machine_type, $version) = @_;
1201 $version = kvm_user_version() if !defined($version);
1202 PVE::QemuServer::Machine::extract_version($machine_type, $version)
1203}
1e3baf05 1204
db70021b
TL
1205sub kernel_has_vhost_net {
1206 return -c '/dev/vhost-net';
1207}
1e3baf05 1208
1e3baf05
DM
1209sub option_exists {
1210 my $key = shift;
1211 return defined($confdesc->{$key});
19672434 1212}
1e3baf05 1213
1e3baf05 1214my $cdrom_path;
1e3baf05
DM
1215sub get_cdrom_path {
1216
1217 return $cdrom_path if $cdrom_path;
1218
1219 return $cdrom_path = "/dev/cdrom" if -l "/dev/cdrom";
1220 return $cdrom_path = "/dev/cdrom1" if -l "/dev/cdrom1";
1221 return $cdrom_path = "/dev/cdrom2" if -l "/dev/cdrom2";
1222}
1223
1224sub get_iso_path {
1225 my ($storecfg, $vmid, $cdrom) = @_;
1226
1227 if ($cdrom eq 'cdrom') {
1228 return get_cdrom_path();
1229 } elsif ($cdrom eq 'none') {
1230 return '';
1231 } elsif ($cdrom =~ m|^/|) {
1232 return $cdrom;
1233 } else {
6b64503e 1234 return PVE::Storage::path($storecfg, $cdrom);
1e3baf05
DM
1235 }
1236}
1237
1238# try to convert old style file names to volume IDs
1239sub filename_to_volume_id {
1240 my ($vmid, $file, $media) = @_;
1241
0c9a7596 1242 if (!($file eq 'none' || $file eq 'cdrom' ||
1e3baf05 1243 $file =~ m|^/dev/.+| || $file =~ m/^([^:]+):(.+)$/)) {
19672434 1244
d1c1af4b 1245 return if $file =~ m|/|;
19672434 1246
1e3baf05
DM
1247 if ($media && $media eq 'cdrom') {
1248 $file = "local:iso/$file";
1249 } else {
1250 $file = "local:$vmid/$file";
1251 }
1252 }
1253
1254 return $file;
1255}
1256
1257sub verify_media_type {
1258 my ($opt, $vtype, $media) = @_;
1259
1260 return if !$media;
1261
1262 my $etype;
1263 if ($media eq 'disk') {
a125592c 1264 $etype = 'images';
1e3baf05
DM
1265 } elsif ($media eq 'cdrom') {
1266 $etype = 'iso';
1267 } else {
1268 die "internal error";
1269 }
1270
1271 return if ($vtype eq $etype);
19672434 1272
1e3baf05
DM
1273 raise_param_exc({ $opt => "unexpected media type ($vtype != $etype)" });
1274}
1275
1276sub cleanup_drive_path {
1277 my ($opt, $storecfg, $drive) = @_;
1278
1279 # try to convert filesystem paths to volume IDs
1280
1281 if (($drive->{file} !~ m/^(cdrom|none)$/) &&
1282 ($drive->{file} !~ m|^/dev/.+|) &&
1283 ($drive->{file} !~ m/^([^:]+):(.+)$/) &&
19672434 1284 ($drive->{file} !~ m/^\d+$/)) {
1e3baf05 1285 my ($vtype, $volid) = PVE::Storage::path_to_volume_id($storecfg, $drive->{file});
4df98f2f
TL
1286 raise_param_exc({ $opt => "unable to associate path '$drive->{file}' to any storage"})
1287 if !$vtype;
1e3baf05
DM
1288 $drive->{media} = 'cdrom' if !$drive->{media} && $vtype eq 'iso';
1289 verify_media_type($opt, $vtype, $drive->{media});
1290 $drive->{file} = $volid;
1291 }
1292
1293 $drive->{media} = 'cdrom' if !$drive->{media} && $drive->{file} =~ m/^(cdrom|none)$/;
1294}
1295
b3c2bdd1
DM
1296sub parse_hotplug_features {
1297 my ($data) = @_;
1298
1299 my $res = {};
1300
1301 return $res if $data eq '0';
a1b7d579 1302
b3c2bdd1
DM
1303 $data = $confdesc->{hotplug}->{default} if $data eq '1';
1304
45827685 1305 foreach my $feature (PVE::Tools::split_list($data)) {
b3c2bdd1
DM
1306 if ($feature =~ m/^(network|disk|cpu|memory|usb)$/) {
1307 $res->{$1} = 1;
1308 } else {
596a0a20 1309 die "invalid hotplug feature '$feature'\n";
b3c2bdd1
DM
1310 }
1311 }
1312 return $res;
1313}
1314
1315PVE::JSONSchema::register_format('pve-hotplug-features', \&pve_verify_hotplug_features);
1316sub pve_verify_hotplug_features {
1317 my ($value, $noerr) = @_;
1318
1319 return $value if parse_hotplug_features($value);
1320
d1c1af4b 1321 return if $noerr;
b3c2bdd1
DM
1322
1323 die "unable to parse hotplug option\n";
1324}
1325
28ef82d3
DM
1326sub scsi_inquiry {
1327 my($fh, $noerr) = @_;
1328
1329 my $SG_IO = 0x2285;
1330 my $SG_GET_VERSION_NUM = 0x2282;
1331
1332 my $versionbuf = "\x00" x 8;
1333 my $ret = ioctl($fh, $SG_GET_VERSION_NUM, $versionbuf);
1334 if (!$ret) {
1335 die "scsi ioctl SG_GET_VERSION_NUM failoed - $!\n" if !$noerr;
d1c1af4b 1336 return;
28ef82d3 1337 }
97d62eb7 1338 my $version = unpack("I", $versionbuf);
28ef82d3
DM
1339 if ($version < 30000) {
1340 die "scsi generic interface too old\n" if !$noerr;
d1c1af4b 1341 return;
28ef82d3 1342 }
97d62eb7 1343
28ef82d3
DM
1344 my $buf = "\x00" x 36;
1345 my $sensebuf = "\x00" x 8;
f334aa3e 1346 my $cmd = pack("C x3 C x1", 0x12, 36);
97d62eb7 1347
28ef82d3
DM
1348 # see /usr/include/scsi/sg.h
1349 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";
1350
97d62eb7
DM
1351 my $packet = pack($sg_io_hdr_t, ord('S'), -3, length($cmd),
1352 length($sensebuf), 0, length($buf), $buf,
28ef82d3
DM
1353 $cmd, $sensebuf, 6000);
1354
1355 $ret = ioctl($fh, $SG_IO, $packet);
1356 if (!$ret) {
1357 die "scsi ioctl SG_IO failed - $!\n" if !$noerr;
d1c1af4b 1358 return;
28ef82d3 1359 }
97d62eb7 1360
28ef82d3
DM
1361 my @res = unpack($sg_io_hdr_t, $packet);
1362 if ($res[17] || $res[18]) {
1363 die "scsi ioctl SG_IO status error - $!\n" if !$noerr;
d1c1af4b 1364 return;
28ef82d3
DM
1365 }
1366
1367 my $res = {};
09984754 1368 (my $byte0, my $byte1, $res->{vendor},
28ef82d3
DM
1369 $res->{product}, $res->{revision}) = unpack("C C x6 A8 A16 A4", $buf);
1370
09984754
DM
1371 $res->{removable} = $byte1 & 128 ? 1 : 0;
1372 $res->{type} = $byte0 & 31;
1373
28ef82d3
DM
1374 return $res;
1375}
1376
1377sub path_is_scsi {
1378 my ($path) = @_;
1379
d1c1af4b 1380 my $fh = IO::File->new("+<$path") || return;
28ef82d3
DM
1381 my $res = scsi_inquiry($fh, 1);
1382 close($fh);
1383
1384 return $res;
1385}
1386
db656e5f 1387sub print_tabletdevice_full {
d559309f 1388 my ($conf, $arch) = @_;
b467f79a 1389
3392d6ca 1390 my $q35 = PVE::QemuServer::Machine::machine_type_is_q35($conf);
db656e5f
DM
1391
1392 # we use uhci for old VMs because tablet driver was buggy in older qemu
d559309f 1393 my $usbbus;
3392d6ca 1394 if (PVE::QemuServer::Machine::machine_type_is_q35($conf) || $arch eq 'aarch64') {
d559309f
WB
1395 $usbbus = 'ehci';
1396 } else {
1397 $usbbus = 'uhci';
1398 }
b467f79a 1399
db656e5f
DM
1400 return "usb-tablet,id=tablet,bus=$usbbus.0,port=1";
1401}
1402
d559309f
WB
1403sub print_keyboarddevice_full {
1404 my ($conf, $arch, $machine) = @_;
1405
d1c1af4b 1406 return if $arch ne 'aarch64';
d559309f
WB
1407
1408 return "usb-kbd,id=keyboard,bus=ehci.0,port=2";
1409}
1410
ca916ecc 1411sub print_drivedevice_full {
d559309f 1412 my ($storecfg, $conf, $vmid, $drive, $bridges, $arch, $machine_type) = @_;
ca916ecc
DA
1413
1414 my $device = '';
1415 my $maxdev = 0;
19672434 1416
4df98f2f 1417 my $drive_id = "$drive->{interface}$drive->{index}";
ca916ecc 1418 if ($drive->{interface} eq 'virtio') {
4df98f2f
TL
1419 my $pciaddr = print_pci_addr("$drive_id", $bridges, $arch, $machine_type);
1420 $device = "virtio-blk-pci,drive=drive-$drive_id,id=${drive_id}${pciaddr}";
1421 $device .= ",iothread=iothread-$drive_id" if $drive->{iothread};
2ed36a41 1422 } elsif ($drive->{interface} eq 'scsi') {
6731a4cf 1423
ee034f5c 1424 my ($maxdev, $controller, $controller_prefix) = scsihw_infos($conf, $drive);
2ed36a41
DM
1425 my $unit = $drive->{index} % $maxdev;
1426 my $devicetype = 'hd';
69bcf246
WB
1427 my $path = '';
1428 if (drive_is_cdrom($drive)) {
1429 $devicetype = 'cd';
29b19529 1430 } else {
69bcf246
WB
1431 if ($drive->{file} =~ m|^/|) {
1432 $path = $drive->{file};
1433 if (my $info = path_is_scsi($path)) {
8e3c33ab 1434 if ($info->{type} == 0 && $drive->{scsiblock}) {
69bcf246
WB
1435 $devicetype = 'block';
1436 } elsif ($info->{type} == 1) { # tape
1437 $devicetype = 'generic';
1438 }
1439 }
1440 } else {
1441 $path = PVE::Storage::path($storecfg, $drive->{file});
1442 }
1443
a034e3d6 1444 # for compatibility only, we prefer scsi-hd (#2408, #2355, #2380)
4df98f2f 1445 my $version = extract_version($machine_type, kvm_user_version());
a034e3d6 1446 if ($path =~ m/^iscsi\:\/\// &&
2ea5fb7e 1447 !min_version($version, 4, 1)) {
69bcf246
WB
1448 $devicetype = 'generic';
1449 }
1450 }
1451
1452 if (!$conf->{scsihw} || ($conf->{scsihw} =~ m/^lsi/)){
4df98f2f 1453 $device = "scsi-$devicetype,bus=$controller_prefix$controller.0,scsi-id=$unit";
69bcf246 1454 } else {
4df98f2f
TL
1455 $device = "scsi-$devicetype,bus=$controller_prefix$controller.0,channel=0,scsi-id=0"
1456 .",lun=$drive->{index}";
69bcf246 1457 }
4df98f2f 1458 $device .= ",drive=drive-$drive_id,id=$drive_id";
cdd20088 1459
6c875f9f
NC
1460 if ($drive->{ssd} && ($devicetype eq 'block' || $devicetype eq 'hd')) {
1461 $device .= ",rotation_rate=1";
1462 }
e741c516 1463 $device .= ",wwn=$drive->{wwn}" if $drive->{wwn};
6c875f9f
NC
1464
1465 } elsif ($drive->{interface} eq 'ide' || $drive->{interface} eq 'sata') {
e0fd2b2f 1466 my $maxdev = ($drive->{interface} eq 'sata') ? $PVE::QemuServer::Drive::MAX_SATA_DISKS : 2;
2ed36a41
DM
1467 my $controller = int($drive->{index} / $maxdev);
1468 my $unit = $drive->{index} % $maxdev;
1469 my $devicetype = ($drive->{media} && $drive->{media} eq 'cdrom') ? "cd" : "hd";
1470
6c875f9f
NC
1471 $device = "ide-$devicetype";
1472 if ($drive->{interface} eq 'ide') {
1473 $device .= ",bus=ide.$controller,unit=$unit";
1474 } else {
1475 $device .= ",bus=ahci$controller.$unit";
1476 }
4df98f2f 1477 $device .= ",drive=drive-$drive_id,id=$drive_id";
6c875f9f
NC
1478
1479 if ($devicetype eq 'hd') {
1480 if (my $model = $drive->{model}) {
1481 $model = URI::Escape::uri_unescape($model);
1482 $device .= ",model=$model";
1483 }
1484 if ($drive->{ssd}) {
1485 $device .= ",rotation_rate=1";
1486 }
0f2812c2 1487 }
e741c516 1488 $device .= ",wwn=$drive->{wwn}" if $drive->{wwn};
2ed36a41
DM
1489 } elsif ($drive->{interface} eq 'usb') {
1490 die "implement me";
1491 # -device ide-drive,bus=ide.1,unit=0,drive=drive-ide0-1-0,id=ide0-1-0
1492 } else {
1493 die "unsupported interface type";
ca916ecc
DA
1494 }
1495
3b408e82
DM
1496 $device .= ",bootindex=$drive->{bootindex}" if $drive->{bootindex};
1497
a70e7e6c
TL
1498 if (my $serial = $drive->{serial}) {
1499 $serial = URI::Escape::uri_unescape($serial);
1500 $device .= ",serial=$serial";
1501 }
1502
1503
ca916ecc
DA
1504 return $device;
1505}
1506
15b21acc 1507sub get_initiator_name {
46f58b5f 1508 my $initiator;
15b21acc 1509
d1c1af4b 1510 my $fh = IO::File->new('/etc/iscsi/initiatorname.iscsi') || return;
46f58b5f
DM
1511 while (defined(my $line = <$fh>)) {
1512 next if $line !~ m/^\s*InitiatorName\s*=\s*([\.\-:\w]+)/;
15b21acc
MR
1513 $initiator = $1;
1514 last;
1515 }
46f58b5f
DM
1516 $fh->close();
1517
15b21acc
MR
1518 return $initiator;
1519}
1520
776c5f50 1521sub print_drive_commandline_full {
1e3baf05
DM
1522 my ($storecfg, $vmid, $drive) = @_;
1523
d81f0f09
DM
1524 my $path;
1525 my $volid = $drive->{file};
1526 my $format;
370b05e7 1527
d81f0f09
DM
1528 if (drive_is_cdrom($drive)) {
1529 $path = get_iso_path($storecfg, $vmid, $volid);
1530 } else {
1531 my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
1532 if ($storeid) {
1533 $path = PVE::Storage::path($storecfg, $volid);
1534 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
1535 $format = qemu_img_format($scfg, $volname);
1536 } else {
1537 $path = $volid;
5b61bff2 1538 $format = "raw";
d81f0f09
DM
1539 }
1540 }
1541
1e3baf05 1542 my $opts = '';
8a267708 1543 my @qemu_drive_options = qw(heads secs cyls trans media format cache rerror werror aio discard);
1e3baf05 1544 foreach my $o (@qemu_drive_options) {
5fc74861 1545 $opts .= ",$o=$drive->{$o}" if defined($drive->{$o});
19672434 1546 }
8a267708
DC
1547
1548 # snapshot only accepts on|off
1549 if (defined($drive->{snapshot})) {
1550 my $v = $drive->{snapshot} ? 'on' : 'off';
1551 $opts .= ",snapshot=$v";
1552 }
1553
fb8e95a2
WB
1554 foreach my $type (['', '-total'], [_rd => '-read'], [_wr => '-write']) {
1555 my ($dir, $qmpname) = @$type;
1556 if (my $v = $drive->{"mbps$dir"}) {
1557 $opts .= ",throttling.bps$qmpname=".int($v*1024*1024);
1558 }
1559 if (my $v = $drive->{"mbps${dir}_max"}) {
1560 $opts .= ",throttling.bps$qmpname-max=".int($v*1024*1024);
1561 }
1562 if (my $v = $drive->{"bps${dir}_max_length"}) {
1563 $opts .= ",throttling.bps$qmpname-max-length=$v";
1564 }
1565 if (my $v = $drive->{"iops${dir}"}) {
1566 $opts .= ",throttling.iops$qmpname=$v";
1567 }
1568 if (my $v = $drive->{"iops${dir}_max"}) {
8aca1654 1569 $opts .= ",throttling.iops$qmpname-max=$v";
fb8e95a2
WB
1570 }
1571 if (my $v = $drive->{"iops${dir}_max_length"}) {
8aca1654 1572 $opts .= ",throttling.iops$qmpname-max-length=$v";
fb8e95a2
WB
1573 }
1574 }
1575
d81f0f09
DM
1576 $opts .= ",format=$format" if $format && !$drive->{format};
1577
b2ee900e
WB
1578 my $cache_direct = 0;
1579
1580 if (my $cache = $drive->{cache}) {
1581 $cache_direct = $cache =~ /^(?:off|none|directsync)$/;
1582 } elsif (!drive_is_cdrom($drive)) {
1583 $opts .= ",cache=none";
1584 $cache_direct = 1;
1585 }
1586
1587 # aio native works only with O_DIRECT
1588 if (!$drive->{aio}) {
1589 if($cache_direct) {
1590 $opts .= ",aio=native";
1591 } else {
1592 $opts .= ",aio=threads";
1593 }
1594 }
11490cf2 1595
6e47c3b4
WB
1596 if (!drive_is_cdrom($drive)) {
1597 my $detectzeroes;
7d4e30f3 1598 if (defined($drive->{detect_zeroes}) && !$drive->{detect_zeroes}) {
6e47c3b4
WB
1599 $detectzeroes = 'off';
1600 } elsif ($drive->{discard}) {
1601 $detectzeroes = $drive->{discard} eq 'on' ? 'unmap' : 'on';
1602 } else {
1603 # This used to be our default with discard not being specified:
1604 $detectzeroes = 'on';
1605 }
1606 $opts .= ",detect-zeroes=$detectzeroes" if $detectzeroes;
1607 }
f1e05305 1608
1e3baf05
DM
1609 my $pathinfo = $path ? "file=$path," : '';
1610
3ebfcc86 1611 return "${pathinfo}if=none,id=drive-$drive->{interface}$drive->{index}$opts";
1e3baf05
DM
1612}
1613
cc4d6182 1614sub print_netdevice_full {
d559309f 1615 my ($vmid, $conf, $net, $netid, $bridges, $use_old_bios_files, $arch, $machine_type) = @_;
cc4d6182 1616
cc4d6182
DA
1617 my $device = $net->{model};
1618 if ($net->{model} eq 'virtio') {
1619 $device = 'virtio-net-pci';
1620 };
1621
d559309f 1622 my $pciaddr = print_pci_addr("$netid", $bridges, $arch, $machine_type);
5e2068d2 1623 my $tmpstr = "$device,mac=$net->{macaddr},netdev=$netid$pciaddr,id=$netid";
a9410357 1624 if ($net->{queues} && $net->{queues} > 1 && $net->{model} eq 'virtio'){
4df98f2f
TL
1625 # Consider we have N queues, the number of vectors needed is 2 * N + 2, i.e., one per in
1626 # and out of each queue plus one config interrupt and control vector queue
a9410357
AD
1627 my $vectors = $net->{queues} * 2 + 2;
1628 $tmpstr .= ",vectors=$vectors,mq=on";
1629 }
cc4d6182 1630 $tmpstr .= ",bootindex=$net->{bootindex}" if $net->{bootindex} ;
ba9e1000 1631
0530177b
TL
1632 if (my $mtu = $net->{mtu}) {
1633 if ($net->{model} eq 'virtio' && $net->{bridge}) {
1634 my $bridge_mtu = PVE::Network::read_bridge_mtu($net->{bridge});
1635 if ($mtu == 1) {
1636 $mtu = $bridge_mtu;
1637 } elsif ($mtu < 576) {
1638 die "netdev $netid: MTU '$mtu' is smaller than the IP minimum MTU '576'\n";
1639 } elsif ($mtu > $bridge_mtu) {
1640 die "netdev $netid: MTU '$mtu' is bigger than the bridge MTU '$bridge_mtu'\n";
1641 }
1642 $tmpstr .= ",host_mtu=$mtu";
1643 } else {
1644 warn "WARN: netdev $netid: ignoring MTU '$mtu', not using VirtIO or no bridge configured.\n";
61a14cde 1645 }
61a14cde
AD
1646 }
1647
ba9e1000
DM
1648 if ($use_old_bios_files) {
1649 my $romfile;
1650 if ($device eq 'virtio-net-pci') {
1651 $romfile = 'pxe-virtio.rom';
1652 } elsif ($device eq 'e1000') {
1653 $romfile = 'pxe-e1000.rom';
1654 } elsif ($device eq 'ne2k') {
1655 $romfile = 'pxe-ne2k_pci.rom';
1656 } elsif ($device eq 'pcnet') {
1657 $romfile = 'pxe-pcnet.rom';
1658 } elsif ($device eq 'rtl8139') {
1659 $romfile = 'pxe-rtl8139.rom';
1660 }
1661 $tmpstr .= ",romfile=$romfile" if $romfile;
1662 }
1663
cc4d6182
DA
1664 return $tmpstr;
1665}
1666
1667sub print_netdev_full {
d559309f 1668 my ($vmid, $conf, $arch, $net, $netid, $hotplug) = @_;
cc4d6182
DA
1669
1670 my $i = '';
1671 if ($netid =~ m/^net(\d+)$/) {
1672 $i = int($1);
1673 }
1674
1675 die "got strange net id '$i'\n" if $i >= ${MAX_NETS};
1676
1677 my $ifname = "tap${vmid}i$i";
1678
1679 # kvm uses TUNSETIFF ioctl, and that limits ifname length
1680 die "interface name '$ifname' is too long (max 15 character)\n"
1681 if length($ifname) >= 16;
1682
1683 my $vhostparam = '';
6f0cb675 1684 if (is_native($arch)) {
db70021b 1685 $vhostparam = ',vhost=on' if kernel_has_vhost_net() && $net->{model} eq 'virtio';
6f0cb675 1686 }
cc4d6182
DA
1687
1688 my $vmname = $conf->{name} || "vm$vmid";
1689
a9410357 1690 my $netdev = "";
208ba94e 1691 my $script = $hotplug ? "pve-bridge-hotplug" : "pve-bridge";
a9410357 1692
cc4d6182 1693 if ($net->{bridge}) {
4df98f2f
TL
1694 $netdev = "type=tap,id=$netid,ifname=${ifname},script=/var/lib/qemu-server/$script"
1695 .",downscript=/var/lib/qemu-server/pve-bridgedown$vhostparam";
cc4d6182 1696 } else {
a9410357 1697 $netdev = "type=user,id=$netid,hostname=$vmname";
cc4d6182 1698 }
a9410357
AD
1699
1700 $netdev .= ",queues=$net->{queues}" if ($net->{queues} && $net->{model} eq 'virtio');
1701
1702 return $netdev;
cc4d6182 1703}
1e3baf05 1704
55655ebc
DC
1705my $vga_map = {
1706 'cirrus' => 'cirrus-vga',
1707 'std' => 'VGA',
1708 'vmware' => 'vmware-svga',
1709 'virtio' => 'virtio-vga',
1710};
1711
1712sub print_vga_device {
2ea5fb7e 1713 my ($conf, $vga, $arch, $machine_version, $machine, $id, $qxlnum, $bridges) = @_;
55655ebc
DC
1714
1715 my $type = $vga_map->{$vga->{type}};
86c9fafe 1716 if ($arch eq 'aarch64' && defined($type) && $type eq 'virtio-vga') {
d559309f
WB
1717 $type = 'virtio-gpu';
1718 }
55655ebc 1719 my $vgamem_mb = $vga->{memory};
6021c7a5
AL
1720
1721 my $max_outputs = '';
55655ebc
DC
1722 if ($qxlnum) {
1723 $type = $id ? 'qxl' : 'qxl-vga';
6021c7a5 1724
c5a4c92c 1725 if (!$conf->{ostype} || $conf->{ostype} =~ m/^(?:l\d\d)|(?:other)$/) {
6021c7a5 1726 # set max outputs so linux can have up to 4 qxl displays with one device
2ea5fb7e 1727 if (min_version($machine_version, 4, 1)) {
9e8976ea
TL
1728 $max_outputs = ",max_outputs=4";
1729 }
6021c7a5 1730 }
55655ebc 1731 }
6021c7a5 1732
55655ebc
DC
1733 die "no devicetype for $vga->{type}\n" if !$type;
1734
1735 my $memory = "";
1736 if ($vgamem_mb) {
1737 if ($vga->{type} eq 'virtio') {
1738 my $bytes = PVE::Tools::convert_size($vgamem_mb, "mb" => "b");
1739 $memory = ",max_hostmem=$bytes";
1740 } elsif ($qxlnum) {
1741 # from https://www.spice-space.org/multiple-monitors.html
1742 $memory = ",vgamem_mb=$vga->{memory}";
1743 my $ram = $vgamem_mb * 4;
1744 my $vram = $vgamem_mb * 2;
1745 $memory .= ",ram_size_mb=$ram,vram_size_mb=$vram";
1746 } else {
1747 $memory = ",vgamem_mb=$vga->{memory}";
1748 }
1749 } elsif ($qxlnum && $id) {
1750 $memory = ",ram_size=67108864,vram_size=33554432";
1751 }
1752
789fe8e8
AL
1753 my $edidoff = "";
1754 if ($type eq 'VGA' && windows_version($conf->{ostype})) {
b5d32c6b 1755 $edidoff=",edid=off" if (!defined($conf->{bios}) || $conf->{bios} ne 'ovmf');
789fe8e8
AL
1756 }
1757
3392d6ca 1758 my $q35 = PVE::QemuServer::Machine::machine_type_is_q35($conf);
55655ebc
DC
1759 my $vgaid = "vga" . ($id // '');
1760 my $pciaddr;
daadd5a4 1761
55655ebc 1762 if ($q35 && $vgaid eq 'vga') {
daadd5a4 1763 # the first display uses pcie.0 bus on q35 machines
d559309f 1764 $pciaddr = print_pcie_addr($vgaid, $bridges, $arch, $machine);
55655ebc 1765 } else {
d559309f 1766 $pciaddr = print_pci_addr($vgaid, $bridges, $arch, $machine);
55655ebc
DC
1767 }
1768
789fe8e8 1769 return "$type,id=${vgaid}${memory}${max_outputs}${pciaddr}${edidoff}";
55655ebc
DC
1770}
1771
ffc0d8c7
WB
1772sub parse_number_sets {
1773 my ($set) = @_;
1774 my $res = [];
1775 foreach my $part (split(/;/, $set)) {
1776 if ($part =~ /^\s*(\d+)(?:-(\d+))?\s*$/) {
1777 die "invalid range: $part ($2 < $1)\n" if defined($2) && $2 < $1;
1778 push @$res, [ $1, $2 ];
2ed5d572 1779 } else {
ffc0d8c7 1780 die "invalid range: $part\n";
2ed5d572
AD
1781 }
1782 }
ffc0d8c7
WB
1783 return $res;
1784}
2ed5d572 1785
ffc0d8c7
WB
1786sub parse_numa {
1787 my ($data) = @_;
1788
4df98f2f 1789 my $res = parse_property_string($numa_fmt, $data);
ffc0d8c7
WB
1790 $res->{cpus} = parse_number_sets($res->{cpus}) if defined($res->{cpus});
1791 $res->{hostnodes} = parse_number_sets($res->{hostnodes}) if defined($res->{hostnodes});
2ed5d572
AD
1792 return $res;
1793}
1794
1e3baf05
DM
1795# netX: e1000=XX:XX:XX:XX:XX:XX,bridge=vmbr0,rate=<mbps>
1796sub parse_net {
1797 my ($data) = @_;
1798
4df98f2f 1799 my $res = eval { parse_property_string($net_fmt, $data) };
cd9c34d1
WB
1800 if ($@) {
1801 warn $@;
d1c1af4b 1802 return;
1e3baf05 1803 }
b5b99790
WB
1804 if (!defined($res->{macaddr})) {
1805 my $dc = PVE::Cluster::cfs_read_file('datacenter.cfg');
1806 $res->{macaddr} = PVE::Tools::random_ether_addr($dc->{mac_prefix});
1807 }
0c9a7596
AD
1808 return $res;
1809}
1810
1811# ipconfigX ip=cidr,gw=ip,ip6=cidr,gw6=ip
1812sub parse_ipconfig {
1813 my ($data) = @_;
1814
4df98f2f 1815 my $res = eval { parse_property_string($ipconfig_fmt, $data) };
0c9a7596
AD
1816 if ($@) {
1817 warn $@;
d1c1af4b 1818 return;
0c9a7596
AD
1819 }
1820
1821 if ($res->{gw} && !$res->{ip}) {
1822 warn 'gateway specified without specifying an IP address';
d1c1af4b 1823 return;
0c9a7596
AD
1824 }
1825 if ($res->{gw6} && !$res->{ip6}) {
1826 warn 'IPv6 gateway specified without specifying an IPv6 address';
d1c1af4b 1827 return;
0c9a7596
AD
1828 }
1829 if ($res->{gw} && $res->{ip} eq 'dhcp') {
1830 warn 'gateway specified together with DHCP';
d1c1af4b 1831 return;
0c9a7596
AD
1832 }
1833 if ($res->{gw6} && $res->{ip6} !~ /^$IPV6RE/) {
1834 # gw6 + auto/dhcp
1835 warn "IPv6 gateway specified together with $res->{ip6} address";
d1c1af4b 1836 return;
0c9a7596
AD
1837 }
1838
1839 if (!$res->{ip} && !$res->{ip6}) {
1840 return { ip => 'dhcp', ip6 => 'dhcp' };
1841 }
1842
1e3baf05
DM
1843 return $res;
1844}
1845
1846sub print_net {
1847 my $net = shift;
1848
cd9c34d1 1849 return PVE::JSONSchema::print_property_string($net, $net_fmt);
1e3baf05
DM
1850}
1851
1852sub add_random_macs {
1853 my ($settings) = @_;
1854
1855 foreach my $opt (keys %$settings) {
1856 next if $opt !~ m/^net(\d+)$/;
1857 my $net = parse_net($settings->{$opt});
1858 next if !$net;
1859 $settings->{$opt} = print_net($net);
1860 }
1861}
1862
055d554d
DM
1863sub vm_is_volid_owner {
1864 my ($storecfg, $vmid, $volid) = @_;
1865
1866 if ($volid !~ m|^/|) {
1867 my ($path, $owner);
1868 eval { ($path, $owner) = PVE::Storage::path($storecfg, $volid); };
1869 if ($owner && ($owner == $vmid)) {
1870 return 1;
1871 }
1872 }
1873
d1c1af4b 1874 return;
055d554d
DM
1875}
1876
055d554d
DM
1877sub vmconfig_register_unused_drive {
1878 my ($storecfg, $vmid, $conf, $drive) = @_;
1879
2d9ddec5
WB
1880 if (drive_is_cloudinit($drive)) {
1881 eval { PVE::Storage::vdisk_free($storecfg, $drive->{file}) };
1882 warn $@ if $@;
1883 } elsif (!drive_is_cdrom($drive)) {
055d554d
DM
1884 my $volid = $drive->{file};
1885 if (vm_is_volid_owner($storecfg, $vmid, $volid)) {
8793d495 1886 PVE::QemuConfig->add_unused_volume($conf, $volid, $vmid);
055d554d
DM
1887 }
1888 }
1889}
1890
1f30ac3a 1891# smbios: [manufacturer=str][,product=str][,version=str][,serial=str][,uuid=uuid][,sku=str][,family=str][,base64=bool]
ff6ffe20 1892my $smbios1_fmt = {
bd27e851
WB
1893 uuid => {
1894 type => 'string',
1895 pattern => '[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}',
1896 format_description => 'UUID',
52261945 1897 description => "Set SMBIOS1 UUID.",
bd27e851
WB
1898 optional => 1,
1899 },
1900 version => {
1901 type => 'string',
1f30ac3a
CE
1902 pattern => '[A-Za-z0-9+\/]+={0,2}',
1903 format_description => 'Base64 encoded string',
52261945 1904 description => "Set SMBIOS1 version.",
bd27e851
WB
1905 optional => 1,
1906 },
1907 serial => {
1908 type => 'string',
1f30ac3a
CE
1909 pattern => '[A-Za-z0-9+\/]+={0,2}',
1910 format_description => 'Base64 encoded string',
52261945 1911 description => "Set SMBIOS1 serial number.",
bd27e851
WB
1912 optional => 1,
1913 },
1914 manufacturer => {
1915 type => 'string',
1f30ac3a
CE
1916 pattern => '[A-Za-z0-9+\/]+={0,2}',
1917 format_description => 'Base64 encoded string',
52261945 1918 description => "Set SMBIOS1 manufacturer.",
bd27e851
WB
1919 optional => 1,
1920 },
1921 product => {
1922 type => 'string',
1f30ac3a
CE
1923 pattern => '[A-Za-z0-9+\/]+={0,2}',
1924 format_description => 'Base64 encoded string',
52261945 1925 description => "Set SMBIOS1 product ID.",
bd27e851
WB
1926 optional => 1,
1927 },
1928 sku => {
1929 type => 'string',
1f30ac3a
CE
1930 pattern => '[A-Za-z0-9+\/]+={0,2}',
1931 format_description => 'Base64 encoded string',
52261945 1932 description => "Set SMBIOS1 SKU string.",
bd27e851
WB
1933 optional => 1,
1934 },
1935 family => {
1936 type => 'string',
1f30ac3a
CE
1937 pattern => '[A-Za-z0-9+\/]+={0,2}',
1938 format_description => 'Base64 encoded string',
52261945 1939 description => "Set SMBIOS1 family string.",
bd27e851
WB
1940 optional => 1,
1941 },
1f30ac3a
CE
1942 base64 => {
1943 type => 'boolean',
1944 description => 'Flag to indicate that the SMBIOS values are base64 encoded',
1945 optional => 1,
1946 },
2796e7d5
DM
1947};
1948
2796e7d5
DM
1949sub parse_smbios1 {
1950 my ($data) = @_;
1951
4df98f2f 1952 my $res = eval { parse_property_string($smbios1_fmt, $data) };
bd27e851 1953 warn $@ if $@;
2796e7d5
DM
1954 return $res;
1955}
1956
cd11416f
DM
1957sub print_smbios1 {
1958 my ($smbios1) = @_;
ff6ffe20 1959 return PVE::JSONSchema::print_property_string($smbios1, $smbios1_fmt);
cd11416f
DM
1960}
1961
ff6ffe20 1962PVE::JSONSchema::register_format('pve-qm-smbios1', $smbios1_fmt);
2796e7d5 1963
0ea9541d
DM
1964sub parse_watchdog {
1965 my ($value) = @_;
1966
d1c1af4b 1967 return if !$value;
0ea9541d 1968
4df98f2f 1969 my $res = eval { parse_property_string($watchdog_fmt, $value) };
ec3582b5 1970 warn $@ if $@;
0ea9541d
DM
1971 return $res;
1972}
1973
9d66b397
SI
1974sub parse_guest_agent {
1975 my ($value) = @_;
1976
1977 return {} if !defined($value->{agent});
1978
4df98f2f 1979 my $res = eval { parse_property_string($agent_fmt, $value->{agent}) };
9d66b397
SI
1980 warn $@ if $@;
1981
1982 # if the agent is disabled ignore the other potentially set properties
1983 return {} if !$res->{enabled};
1984 return $res;
1985}
1986
55655ebc
DC
1987sub parse_vga {
1988 my ($value) = @_;
1989
1990 return {} if !$value;
4df98f2f 1991 my $res = eval { parse_property_string($vga_fmt, $value) };
55655ebc
DC
1992 warn $@ if $@;
1993 return $res;
1994}
1995
2cf61f33
SR
1996sub parse_rng {
1997 my ($value) = @_;
1998
d1c1af4b 1999 return if !$value;
2cf61f33 2000
4df98f2f 2001 my $res = eval { parse_property_string($rng_fmt, $value) };
2cf61f33
SR
2002 warn $@ if $@;
2003 return $res;
2004}
2005
1e3baf05
DM
2006PVE::JSONSchema::register_format('pve-qm-usb-device', \&verify_usb_device);
2007sub verify_usb_device {
2008 my ($value, $noerr) = @_;
2009
2010 return $value if parse_usb_device($value);
2011
d1c1af4b 2012 return if $noerr;
19672434 2013
1e3baf05
DM
2014 die "unable to parse usb device\n";
2015}
2016
1e3baf05
DM
2017# add JSON properties for create and set function
2018sub json_config_properties {
2019 my $prop = shift;
2020
2021 foreach my $opt (keys %$confdesc) {
ea1c2110
SR
2022 next if $opt eq 'parent' || $opt eq 'snaptime' || $opt eq 'vmstate' ||
2023 $opt eq 'runningmachine' || $opt eq 'runningcpu';
1e3baf05
DM
2024 $prop->{$opt} = $confdesc->{$opt};
2025 }
2026
2027 return $prop;
2028}
2029
d41121fd
DM
2030# return copy of $confdesc_cloudinit to generate documentation
2031sub cloudinit_config_properties {
2032
2033 return dclone($confdesc_cloudinit);
2034}
2035
1e3baf05
DM
2036sub check_type {
2037 my ($key, $value) = @_;
2038
2039 die "unknown setting '$key'\n" if !$confdesc->{$key};
2040
2041 my $type = $confdesc->{$key}->{type};
2042
6b64503e 2043 if (!defined($value)) {
1e3baf05
DM
2044 die "got undefined value\n";
2045 }
2046
2047 if ($value =~ m/[\n\r]/) {
2048 die "property contains a line feed\n";
2049 }
2050
2051 if ($type eq 'boolean') {
19672434
DM
2052 return 1 if ($value eq '1') || ($value =~ m/^(on|yes|true)$/i);
2053 return 0 if ($value eq '0') || ($value =~ m/^(off|no|false)$/i);
2054 die "type check ('boolean') failed - got '$value'\n";
1e3baf05
DM
2055 } elsif ($type eq 'integer') {
2056 return int($1) if $value =~ m/^(\d+)$/;
2057 die "type check ('integer') failed - got '$value'\n";
04432191
AD
2058 } elsif ($type eq 'number') {
2059 return $value if $value =~ m/^(\d+)(\.\d+)?$/;
2060 die "type check ('number') failed - got '$value'\n";
1e3baf05
DM
2061 } elsif ($type eq 'string') {
2062 if (my $fmt = $confdesc->{$key}->{format}) {
1e3baf05 2063 PVE::JSONSchema::check_format($fmt, $value);
19672434
DM
2064 return $value;
2065 }
1e3baf05 2066 $value =~ s/^\"(.*)\"$/$1/;
19672434 2067 return $value;
1e3baf05
DM
2068 } else {
2069 die "internal error"
2070 }
2071}
2072
1e3baf05 2073sub destroy_vm {
b04ea584 2074 my ($storecfg, $vmid, $skiplock, $replacement_conf) = @_;
1e3baf05 2075
ffda963f 2076 my $conf = PVE::QemuConfig->load_config($vmid);
1e3baf05 2077
ffda963f 2078 PVE::QemuConfig->check_lock($conf) if !$skiplock;
1e3baf05 2079
5e67a2d2
DC
2080 if ($conf->{template}) {
2081 # check if any base image is still used by a linked clone
912792e2 2082 PVE::QemuConfig->foreach_volume($conf, sub {
5e67a2d2 2083 my ($ds, $drive) = @_;
5e67a2d2
DC
2084 return if drive_is_cdrom($drive);
2085
2086 my $volid = $drive->{file};
5e67a2d2
DC
2087 return if !$volid || $volid =~ m|^/|;
2088
2089 die "base volume '$volid' is still in use by linked cloned\n"
2090 if PVE::Storage::volume_is_base_and_used($storecfg, $volid);
2091
2092 });
2093 }
2094
19672434 2095 # only remove disks owned by this VM
912792e2 2096 PVE::QemuConfig->foreach_volume($conf, sub {
1e3baf05 2097 my ($ds, $drive) = @_;
9c52f5ed 2098 return if drive_is_cdrom($drive, 1);
1e3baf05
DM
2099
2100 my $volid = $drive->{file};
ff1a2432 2101 return if !$volid || $volid =~ m|^/|;
1e3baf05 2102
6b64503e 2103 my ($path, $owner) = PVE::Storage::path($storecfg, $volid);
ff1a2432 2104 return if !$path || !$owner || ($owner != $vmid);
1e3baf05 2105
a2f50f01 2106 eval { PVE::Storage::vdisk_free($storecfg, $volid) };
31b52247 2107 warn "Could not remove disk '$volid', check manually: $@" if $@;
1e3baf05 2108 });
19672434 2109
1e3baf05 2110 # also remove unused disk
a2f50f01
TL
2111 my $vmdisks = PVE::Storage::vdisk_list($storecfg, undef, $vmid);
2112 PVE::Storage::foreach_volid($vmdisks, sub {
2113 my ($volid, $sid, $volname, $d) = @_;
2114 eval { PVE::Storage::vdisk_free($storecfg, $volid) };
1e3baf05 2115 warn $@ if $@;
a2f50f01 2116 });
dfda979e 2117
b04ea584 2118 if (defined $replacement_conf) {
8baf8bc7 2119 PVE::QemuConfig->write_config($vmid, $replacement_conf);
dfda979e
DJ
2120 } else {
2121 PVE::QemuConfig->destroy_config($vmid);
2122 }
1e3baf05
DM
2123}
2124
1e3baf05
DM
2125sub parse_vm_config {
2126 my ($filename, $raw) = @_;
2127
d1c1af4b 2128 return if !defined($raw);
1e3baf05 2129
554ac7e7 2130 my $res = {
fc1ddcdc 2131 digest => Digest::SHA::sha1_hex($raw),
0d18dcfc 2132 snapshots => {},
0d732d16 2133 pending => {},
554ac7e7 2134 };
1e3baf05 2135
19672434 2136 $filename =~ m|/qemu-server/(\d+)\.conf$|
1e3baf05
DM
2137 || die "got strange filename '$filename'";
2138
2139 my $vmid = $1;
2140
0d18dcfc 2141 my $conf = $res;
b0ec896e 2142 my $descr;
e297c490 2143 my $section = '';
0581fe4f 2144
0d18dcfc
DM
2145 my @lines = split(/\n/, $raw);
2146 foreach my $line (@lines) {
1e3baf05 2147 next if $line =~ m/^\s*$/;
be190583 2148
eab09f4e 2149 if ($line =~ m/^\[PENDING\]\s*$/i) {
e297c490 2150 $section = 'pending';
b0ec896e
DM
2151 if (defined($descr)) {
2152 $descr =~ s/\s+$//;
2153 $conf->{description} = $descr;
2154 }
2155 $descr = undef;
e297c490 2156 $conf = $res->{$section} = {};
eab09f4e
AD
2157 next;
2158
0d732d16 2159 } elsif ($line =~ m/^\[([a-z][a-z0-9_\-]+)\]\s*$/i) {
e297c490 2160 $section = $1;
b0ec896e
DM
2161 if (defined($descr)) {
2162 $descr =~ s/\s+$//;
2163 $conf->{description} = $descr;
2164 }
2165 $descr = undef;
e297c490 2166 $conf = $res->{snapshots}->{$section} = {};
0d18dcfc
DM
2167 next;
2168 }
1e3baf05 2169
0581fe4f 2170 if ($line =~ m/^\#(.*)\s*$/) {
b0ec896e 2171 $descr = '' if !defined($descr);
0581fe4f
DM
2172 $descr .= PVE::Tools::decode_text($1) . "\n";
2173 next;
2174 }
2175
1e3baf05 2176 if ($line =~ m/^(description):\s*(.*\S)\s*$/) {
b0ec896e 2177 $descr = '' if !defined($descr);
0581fe4f 2178 $descr .= PVE::Tools::decode_text($2);
0d18dcfc
DM
2179 } elsif ($line =~ m/snapstate:\s*(prepare|delete)\s*$/) {
2180 $conf->{snapstate} = $1;
1e3baf05
DM
2181 } elsif ($line =~ m/^(args):\s*(.*\S)\s*$/) {
2182 my $key = $1;
2183 my $value = $2;
0d18dcfc 2184 $conf->{$key} = $value;
ef824322 2185 } elsif ($line =~ m/^delete:\s*(.*\S)\s*$/) {
e297c490 2186 my $value = $1;
ef824322
DM
2187 if ($section eq 'pending') {
2188 $conf->{delete} = $value; # we parse this later
2189 } else {
2190 warn "vm $vmid - propertry 'delete' is only allowed in [PENDING]\n";
eab09f4e 2191 }
15cf7698 2192 } elsif ($line =~ m/^([a-z][a-z_]*\d*):\s*(.+?)\s*$/) {
1e3baf05
DM
2193 my $key = $1;
2194 my $value = $2;
2195 eval { $value = check_type($key, $value); };
2196 if ($@) {
2197 warn "vm $vmid - unable to parse value of '$key' - $@";
2198 } else {
b799312f 2199 $key = 'ide2' if $key eq 'cdrom';
1e3baf05 2200 my $fmt = $confdesc->{$key}->{format};
b799312f 2201 if ($fmt && $fmt =~ /^pve-qm-(?:ide|scsi|virtio|sata)$/) {
1e3baf05
DM
2202 my $v = parse_drive($key, $value);
2203 if (my $volid = filename_to_volume_id($vmid, $v->{file}, $v->{media})) {
2204 $v->{file} = $volid;
71c58bb7 2205 $value = print_drive($v);
1e3baf05
DM
2206 } else {
2207 warn "vm $vmid - unable to parse value of '$key'\n";
2208 next;
2209 }
2210 }
2211
b799312f 2212 $conf->{$key} = $value;
1e3baf05
DM
2213 }
2214 }
2215 }
2216
b0ec896e
DM
2217 if (defined($descr)) {
2218 $descr =~ s/\s+$//;
2219 $conf->{description} = $descr;
2220 }
0d18dcfc 2221 delete $res->{snapstate}; # just to be sure
1e3baf05
DM
2222
2223 return $res;
2224}
2225
1858638f
DM
2226sub write_vm_config {
2227 my ($filename, $conf) = @_;
1e3baf05 2228
0d18dcfc
DM
2229 delete $conf->{snapstate}; # just to be sure
2230
1858638f
DM
2231 if ($conf->{cdrom}) {
2232 die "option ide2 conflicts with cdrom\n" if $conf->{ide2};
2233 $conf->{ide2} = $conf->{cdrom};
2234 delete $conf->{cdrom};
2235 }
1e3baf05
DM
2236
2237 # we do not use 'smp' any longer
1858638f
DM
2238 if ($conf->{sockets}) {
2239 delete $conf->{smp};
2240 } elsif ($conf->{smp}) {
2241 $conf->{sockets} = $conf->{smp};
2242 delete $conf->{cores};
2243 delete $conf->{smp};
1e3baf05
DM
2244 }
2245
ee2f90b1 2246 my $used_volids = {};
0d18dcfc 2247
ee2f90b1 2248 my $cleanup_config = sub {
ef824322 2249 my ($cref, $pending, $snapname) = @_;
1858638f 2250
ee2f90b1
DM
2251 foreach my $key (keys %$cref) {
2252 next if $key eq 'digest' || $key eq 'description' || $key eq 'snapshots' ||
ef824322 2253 $key eq 'snapstate' || $key eq 'pending';
ee2f90b1 2254 my $value = $cref->{$key};
ef824322
DM
2255 if ($key eq 'delete') {
2256 die "propertry 'delete' is only allowed in [PENDING]\n"
2257 if !$pending;
2258 # fixme: check syntax?
2259 next;
2260 }
ee2f90b1
DM
2261 eval { $value = check_type($key, $value); };
2262 die "unable to parse value of '$key' - $@" if $@;
1858638f 2263
ee2f90b1
DM
2264 $cref->{$key} = $value;
2265
74479ee9 2266 if (!$snapname && is_valid_drivename($key)) {
ed221350 2267 my $drive = parse_drive($key, $value);
ee2f90b1
DM
2268 $used_volids->{$drive->{file}} = 1 if $drive && $drive->{file};
2269 }
1e3baf05 2270 }
ee2f90b1
DM
2271 };
2272
2273 &$cleanup_config($conf);
ef824322
DM
2274
2275 &$cleanup_config($conf->{pending}, 1);
2276
ee2f90b1 2277 foreach my $snapname (keys %{$conf->{snapshots}}) {
15c6e277 2278 die "internal error: snapshot name '$snapname' is forbidden" if lc($snapname) eq 'pending';
ef824322 2279 &$cleanup_config($conf->{snapshots}->{$snapname}, undef, $snapname);
1e3baf05
DM
2280 }
2281
1858638f
DM
2282 # remove 'unusedX' settings if we re-add a volume
2283 foreach my $key (keys %$conf) {
2284 my $value = $conf->{$key};
ee2f90b1 2285 if ($key =~ m/^unused/ && $used_volids->{$value}) {
1858638f 2286 delete $conf->{$key};
1e3baf05 2287 }
1858638f 2288 }
be190583 2289
0d18dcfc 2290 my $generate_raw_config = sub {
b0ec896e 2291 my ($conf, $pending) = @_;
0581fe4f 2292
0d18dcfc
DM
2293 my $raw = '';
2294
2295 # add description as comment to top of file
b0ec896e
DM
2296 if (defined(my $descr = $conf->{description})) {
2297 if ($descr) {
2298 foreach my $cl (split(/\n/, $descr)) {
2299 $raw .= '#' . PVE::Tools::encode_text($cl) . "\n";
2300 }
2301 } else {
2302 $raw .= "#\n" if $pending;
2303 }
0d18dcfc
DM
2304 }
2305
2306 foreach my $key (sort keys %$conf) {
4df98f2f 2307 next if $key =~ /^(digest|description|pending|snapshots)$/;
0d18dcfc
DM
2308 $raw .= "$key: $conf->{$key}\n";
2309 }
2310 return $raw;
2311 };
0581fe4f 2312
0d18dcfc 2313 my $raw = &$generate_raw_config($conf);
ef824322
DM
2314
2315 if (scalar(keys %{$conf->{pending}})){
2316 $raw .= "\n[PENDING]\n";
b0ec896e 2317 $raw .= &$generate_raw_config($conf->{pending}, 1);
ef824322
DM
2318 }
2319
0d18dcfc
DM
2320 foreach my $snapname (sort keys %{$conf->{snapshots}}) {
2321 $raw .= "\n[$snapname]\n";
2322 $raw .= &$generate_raw_config($conf->{snapshots}->{$snapname});
1858638f 2323 }
1e3baf05 2324
1858638f
DM
2325 return $raw;
2326}
1e3baf05 2327
19672434 2328sub load_defaults {
1e3baf05
DM
2329
2330 my $res = {};
2331
2332 # we use static defaults from our JSON schema configuration
2333 foreach my $key (keys %$confdesc) {
2334 if (defined(my $default = $confdesc->{$key}->{default})) {
2335 $res->{$key} = $default;
2336 }
2337 }
19672434 2338
1e3baf05
DM
2339 return $res;
2340}
2341
2342sub config_list {
2343 my $vmlist = PVE::Cluster::get_vmlist();
2344 my $res = {};
2345 return $res if !$vmlist || !$vmlist->{ids};
2346 my $ids = $vmlist->{ids};
38277afc 2347 my $nodename = nodename();
1e3baf05 2348
1e3baf05
DM
2349 foreach my $vmid (keys %$ids) {
2350 my $d = $ids->{$vmid};
2351 next if !$d->{node} || $d->{node} ne $nodename;
5ee957cc 2352 next if !$d->{type} || $d->{type} ne 'qemu';
1e3baf05
DM
2353 $res->{$vmid}->{exists} = 1;
2354 }
2355 return $res;
2356}
2357
64e13401
DM
2358# test if VM uses local resources (to prevent migration)
2359sub check_local_resources {
2360 my ($conf, $noerr) = @_;
2361
ca6abacf 2362 my @loc_res = ();
19672434 2363
ca6abacf
TM
2364 push @loc_res, "hostusb" if $conf->{hostusb}; # old syntax
2365 push @loc_res, "hostpci" if $conf->{hostpci}; # old syntax
64e13401 2366
ca6abacf 2367 push @loc_res, "ivshmem" if $conf->{ivshmem};
6dbcb073 2368
0d29ab3b 2369 foreach my $k (keys %$conf) {
a9ce7583 2370 next if $k =~ m/^usb/ && ($conf->{$k} =~ m/^spice(?![^,])/);
d44712fc
EK
2371 # sockets are safe: they will recreated be on the target side post-migrate
2372 next if $k =~ m/^serial/ && ($conf->{$k} eq 'socket');
ca6abacf 2373 push @loc_res, $k if $k =~ m/^(usb|hostpci|serial|parallel)\d+$/;
64e13401
DM
2374 }
2375
ca6abacf 2376 die "VM uses local resources\n" if scalar @loc_res && !$noerr;
64e13401 2377
ca6abacf 2378 return \@loc_res;
64e13401
DM
2379}
2380
719893a9 2381# check if used storages are available on all nodes (use by migrate)
47152e2e
DM
2382sub check_storage_availability {
2383 my ($storecfg, $conf, $node) = @_;
2384
912792e2 2385 PVE::QemuConfig->foreach_volume($conf, sub {
47152e2e
DM
2386 my ($ds, $drive) = @_;
2387
2388 my $volid = $drive->{file};
2389 return if !$volid;
2390
2391 my ($sid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
2392 return if !$sid;
2393
2394 # check if storage is available on both nodes
2395 my $scfg = PVE::Storage::storage_check_node($storecfg, $sid);
2396 PVE::Storage::storage_check_node($storecfg, $sid, $node);
2397 });
2398}
2399
719893a9
DM
2400# list nodes where all VM images are available (used by has_feature API)
2401sub shared_nodes {
2402 my ($conf, $storecfg) = @_;
2403
2404 my $nodelist = PVE::Cluster::get_nodelist();
2405 my $nodehash = { map { $_ => 1 } @$nodelist };
38277afc 2406 my $nodename = nodename();
be190583 2407
912792e2 2408 PVE::QemuConfig->foreach_volume($conf, sub {
719893a9
DM
2409 my ($ds, $drive) = @_;
2410
2411 my $volid = $drive->{file};
2412 return if !$volid;
2413
2414 my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
2415 if ($storeid) {
2416 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
2417 if ($scfg->{disable}) {
2418 $nodehash = {};
2419 } elsif (my $avail = $scfg->{nodes}) {
2420 foreach my $node (keys %$nodehash) {
2421 delete $nodehash->{$node} if !$avail->{$node};
2422 }
2423 } elsif (!$scfg->{shared}) {
2424 foreach my $node (keys %$nodehash) {
2425 delete $nodehash->{$node} if $node ne $nodename
2426 }
2427 }
2428 }
2429 });
2430
2431 return $nodehash
2432}
2433
f25852c2
TM
2434sub check_local_storage_availability {
2435 my ($conf, $storecfg) = @_;
2436
2437 my $nodelist = PVE::Cluster::get_nodelist();
2438 my $nodehash = { map { $_ => {} } @$nodelist };
2439
912792e2 2440 PVE::QemuConfig->foreach_volume($conf, sub {
f25852c2
TM
2441 my ($ds, $drive) = @_;
2442
2443 my $volid = $drive->{file};
2444 return if !$volid;
2445
2446 my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
2447 if ($storeid) {
2448 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
2449
2450 if ($scfg->{disable}) {
2451 foreach my $node (keys %$nodehash) {
32075a2c 2452 $nodehash->{$node}->{unavailable_storages}->{$storeid} = 1;
f25852c2
TM
2453 }
2454 } elsif (my $avail = $scfg->{nodes}) {
2455 foreach my $node (keys %$nodehash) {
2456 if (!$avail->{$node}) {
32075a2c 2457 $nodehash->{$node}->{unavailable_storages}->{$storeid} = 1;
f25852c2
TM
2458 }
2459 }
2460 }
2461 }
2462 });
2463
32075a2c
TL
2464 foreach my $node (values %$nodehash) {
2465 if (my $unavail = $node->{unavailable_storages}) {
2466 $node->{unavailable_storages} = [ sort keys %$unavail ];
2467 }
2468 }
2469
f25852c2
TM
2470 return $nodehash
2471}
2472
babf613a 2473# Compat only, use assert_config_exists_on_node and vm_running_locally where possible
1e3baf05 2474sub check_running {
7e8dcf2c 2475 my ($vmid, $nocheck, $node) = @_;
1e3baf05 2476
babf613a
SR
2477 PVE::QemuConfig::assert_config_exists_on_node($vmid, $node) if !$nocheck;
2478 return PVE::QemuServer::Helpers::vm_running_locally($vmid);
1e3baf05
DM
2479}
2480
2481sub vzlist {
19672434 2482
1e3baf05
DM
2483 my $vzlist = config_list();
2484
d036e418 2485 my $fd = IO::Dir->new($PVE::QemuServer::Helpers::var_run_tmpdir) || return $vzlist;
1e3baf05 2486
19672434 2487 while (defined(my $de = $fd->read)) {
1e3baf05
DM
2488 next if $de !~ m/^(\d+)\.pid$/;
2489 my $vmid = $1;
6b64503e
DM
2490 next if !defined($vzlist->{$vmid});
2491 if (my $pid = check_running($vmid)) {
1e3baf05
DM
2492 $vzlist->{$vmid}->{pid} = $pid;
2493 }
2494 }
2495
2496 return $vzlist;
2497}
2498
b1a70cab
DM
2499our $vmstatus_return_properties = {
2500 vmid => get_standard_option('pve-vmid'),
2501 status => {
2502 description => "Qemu process status.",
2503 type => 'string',
2504 enum => ['stopped', 'running'],
2505 },
2506 maxmem => {
2507 description => "Maximum memory in bytes.",
2508 type => 'integer',
2509 optional => 1,
2510 renderer => 'bytes',
2511 },
2512 maxdisk => {
2513 description => "Root disk size in bytes.",
2514 type => 'integer',
2515 optional => 1,
2516 renderer => 'bytes',
2517 },
2518 name => {
2519 description => "VM name.",
2520 type => 'string',
2521 optional => 1,
2522 },
2523 qmpstatus => {
2524 description => "Qemu QMP agent status.",
2525 type => 'string',
2526 optional => 1,
2527 },
2528 pid => {
2529 description => "PID of running qemu process.",
2530 type => 'integer',
2531 optional => 1,
2532 },
2533 uptime => {
2534 description => "Uptime.",
2535 type => 'integer',
2536 optional => 1,
2537 renderer => 'duration',
2538 },
2539 cpus => {
2540 description => "Maximum usable CPUs.",
2541 type => 'number',
2542 optional => 1,
2543 },
e6ed61b4 2544 lock => {
11efdfa5 2545 description => "The current config lock, if any.",
e6ed61b4
DC
2546 type => 'string',
2547 optional => 1,
b8e7068a
DC
2548 },
2549 tags => {
2550 description => "The current configured tags, if any",
2551 type => 'string',
2552 optional => 1,
2553 },
b1a70cab
DM
2554};
2555
1e3baf05
DM
2556my $last_proc_pid_stat;
2557
03a33f30
DM
2558# get VM status information
2559# This must be fast and should not block ($full == false)
2560# We only query KVM using QMP if $full == true (this can be slow)
1e3baf05 2561sub vmstatus {
03a33f30 2562 my ($opt_vmid, $full) = @_;
1e3baf05
DM
2563
2564 my $res = {};
2565
19672434 2566 my $storecfg = PVE::Storage::config();
1e3baf05
DM
2567
2568 my $list = vzlist();
3618ee99
EK
2569 my $defaults = load_defaults();
2570
694fcad4 2571 my ($uptime) = PVE::ProcFSTools::read_proc_uptime(1);
1e3baf05 2572
ae4915a2
DM
2573 my $cpucount = $cpuinfo->{cpus} || 1;
2574
1e3baf05
DM
2575 foreach my $vmid (keys %$list) {
2576 next if $opt_vmid && ($vmid ne $opt_vmid);
2577
9f78b695 2578 my $conf = PVE::QemuConfig->load_config($vmid);
1e3baf05 2579
b1a70cab 2580 my $d = { vmid => $vmid };
1e3baf05
DM
2581 $d->{pid} = $list->{$vmid}->{pid};
2582
2583 # fixme: better status?
2584 $d->{status} = $list->{$vmid}->{pid} ? 'running' : 'stopped';
2585
776c5f50 2586 my $size = PVE::QemuServer::Drive::bootdisk_size($storecfg, $conf);
af990afe
DM
2587 if (defined($size)) {
2588 $d->{disk} = 0; # no info available
1e3baf05
DM
2589 $d->{maxdisk} = $size;
2590 } else {
2591 $d->{disk} = 0;
2592 $d->{maxdisk} = 0;
2593 }
2594
3618ee99
EK
2595 $d->{cpus} = ($conf->{sockets} || $defaults->{sockets})
2596 * ($conf->{cores} || $defaults->{cores});
ae4915a2 2597 $d->{cpus} = $cpucount if $d->{cpus} > $cpucount;
d7c8364b 2598 $d->{cpus} = $conf->{vcpus} if $conf->{vcpus};
ae4915a2 2599
1e3baf05 2600 $d->{name} = $conf->{name} || "VM $vmid";
3618ee99
EK
2601 $d->{maxmem} = $conf->{memory} ? $conf->{memory}*(1024*1024)
2602 : $defaults->{memory}*(1024*1024);
1e3baf05 2603
8b1accf7 2604 if ($conf->{balloon}) {
4bdb0514 2605 $d->{balloon_min} = $conf->{balloon}*(1024*1024);
3618ee99
EK
2606 $d->{shares} = defined($conf->{shares}) ? $conf->{shares}
2607 : $defaults->{shares};
8b1accf7
DM
2608 }
2609
1e3baf05
DM
2610 $d->{uptime} = 0;
2611 $d->{cpu} = 0;
1e3baf05
DM
2612 $d->{mem} = 0;
2613
2614 $d->{netout} = 0;
2615 $d->{netin} = 0;
2616
2617 $d->{diskread} = 0;
2618 $d->{diskwrite} = 0;
2619
ffda963f 2620 $d->{template} = PVE::QemuConfig->is_template($conf);
4d8c851b 2621
8107b378 2622 $d->{serial} = 1 if conf_has_serial($conf);
e6ed61b4 2623 $d->{lock} = $conf->{lock} if $conf->{lock};
b8e7068a 2624 $d->{tags} = $conf->{tags} if defined($conf->{tags});
8107b378 2625
1e3baf05
DM
2626 $res->{$vmid} = $d;
2627 }
2628
2629 my $netdev = PVE::ProcFSTools::read_proc_net_dev();
2630 foreach my $dev (keys %$netdev) {
2631 next if $dev !~ m/^tap([1-9]\d*)i/;
2632 my $vmid = $1;
2633 my $d = $res->{$vmid};
2634 next if !$d;
19672434 2635
1e3baf05
DM
2636 $d->{netout} += $netdev->{$dev}->{receive};
2637 $d->{netin} += $netdev->{$dev}->{transmit};
604ea644
AD
2638
2639 if ($full) {
2640 $d->{nics}->{$dev}->{netout} = $netdev->{$dev}->{receive};
2641 $d->{nics}->{$dev}->{netin} = $netdev->{$dev}->{transmit};
2642 }
2643
1e3baf05
DM
2644 }
2645
1e3baf05
DM
2646 my $ctime = gettimeofday;
2647
2648 foreach my $vmid (keys %$list) {
2649
2650 my $d = $res->{$vmid};
2651 my $pid = $d->{pid};
2652 next if !$pid;
2653
694fcad4
DM
2654 my $pstat = PVE::ProcFSTools::read_proc_pid_stat($pid);
2655 next if !$pstat; # not running
19672434 2656
694fcad4 2657 my $used = $pstat->{utime} + $pstat->{stime};
1e3baf05 2658
694fcad4 2659 $d->{uptime} = int(($uptime - $pstat->{starttime})/$cpuinfo->{user_hz});
1e3baf05 2660
694fcad4 2661 if ($pstat->{vsize}) {
6b64503e 2662 $d->{mem} = int(($pstat->{rss}/$pstat->{vsize})*$d->{maxmem});
1e3baf05
DM
2663 }
2664
2665 my $old = $last_proc_pid_stat->{$pid};
2666 if (!$old) {
19672434
DM
2667 $last_proc_pid_stat->{$pid} = {
2668 time => $ctime,
1e3baf05
DM
2669 used => $used,
2670 cpu => 0,
1e3baf05
DM
2671 };
2672 next;
2673 }
2674
7f0b5beb 2675 my $dtime = ($ctime - $old->{time}) * $cpucount * $cpuinfo->{user_hz};
1e3baf05
DM
2676
2677 if ($dtime > 1000) {
2678 my $dutime = $used - $old->{used};
2679
ae4915a2 2680 $d->{cpu} = (($dutime/$dtime)* $cpucount) / $d->{cpus};
1e3baf05 2681 $last_proc_pid_stat->{$pid} = {
19672434 2682 time => $ctime,
1e3baf05
DM
2683 used => $used,
2684 cpu => $d->{cpu},
1e3baf05
DM
2685 };
2686 } else {
2687 $d->{cpu} = $old->{cpu};
1e3baf05
DM
2688 }
2689 }
2690
f5eb281a 2691 return $res if !$full;
03a33f30
DM
2692
2693 my $qmpclient = PVE::QMPClient->new();
2694
64e7fcf2
DM
2695 my $ballooncb = sub {
2696 my ($vmid, $resp) = @_;
2697
2698 my $info = $resp->{'return'};
38babf81
DM
2699 return if !$info->{max_mem};
2700
64e7fcf2
DM
2701 my $d = $res->{$vmid};
2702
38babf81
DM
2703 # use memory assigned to VM
2704 $d->{maxmem} = $info->{max_mem};
2705 $d->{balloon} = $info->{actual};
2706
2707 if (defined($info->{total_mem}) && defined($info->{free_mem})) {
2708 $d->{mem} = $info->{total_mem} - $info->{free_mem};
2709 $d->{freemem} = $info->{free_mem};
64e7fcf2
DM
2710 }
2711
604ea644 2712 $d->{ballooninfo} = $info;
64e7fcf2
DM
2713 };
2714
03a33f30
DM
2715 my $blockstatscb = sub {
2716 my ($vmid, $resp) = @_;
2717 my $data = $resp->{'return'} || [];
2718 my $totalrdbytes = 0;
2719 my $totalwrbytes = 0;
604ea644 2720
03a33f30
DM
2721 for my $blockstat (@$data) {
2722 $totalrdbytes = $totalrdbytes + $blockstat->{stats}->{rd_bytes};
2723 $totalwrbytes = $totalwrbytes + $blockstat->{stats}->{wr_bytes};
604ea644
AD
2724
2725 $blockstat->{device} =~ s/drive-//;
2726 $res->{$vmid}->{blockstat}->{$blockstat->{device}} = $blockstat->{stats};
03a33f30
DM
2727 }
2728 $res->{$vmid}->{diskread} = $totalrdbytes;
2729 $res->{$vmid}->{diskwrite} = $totalwrbytes;
2730 };
2731
2732 my $statuscb = sub {
2733 my ($vmid, $resp) = @_;
64e7fcf2 2734
03a33f30 2735 $qmpclient->queue_cmd($vmid, $blockstatscb, 'query-blockstats');
64e7fcf2
DM
2736 # this fails if ballon driver is not loaded, so this must be
2737 # the last commnand (following command are aborted if this fails).
38babf81 2738 $qmpclient->queue_cmd($vmid, $ballooncb, 'query-balloon');
03a33f30
DM
2739
2740 my $status = 'unknown';
2741 if (!defined($status = $resp->{'return'}->{status})) {
2742 warn "unable to get VM status\n";
2743 return;
2744 }
2745
2746 $res->{$vmid}->{qmpstatus} = $resp->{'return'}->{status};
2747 };
2748
2749 foreach my $vmid (keys %$list) {
2750 next if $opt_vmid && ($vmid ne $opt_vmid);
2751 next if !$res->{$vmid}->{pid}; # not running
2752 $qmpclient->queue_cmd($vmid, $statuscb, 'query-status');
2753 }
2754
b017fbda 2755 $qmpclient->queue_execute(undef, 2);
03a33f30
DM
2756
2757 foreach my $vmid (keys %$list) {
2758 next if $opt_vmid && ($vmid ne $opt_vmid);
2759 $res->{$vmid}->{qmpstatus} = $res->{$vmid}->{status} if !$res->{$vmid}->{qmpstatus};
2760 }
2761
1e3baf05
DM
2762 return $res;
2763}
2764
8107b378
DC
2765sub conf_has_serial {
2766 my ($conf) = @_;
2767
2768 for (my $i = 0; $i < $MAX_SERIAL_PORTS; $i++) {
2769 if ($conf->{"serial$i"}) {
2770 return 1;
2771 }
2772 }
2773
2774 return 0;
2775}
2776
d5535a00
TL
2777sub conf_has_audio {
2778 my ($conf, $id) = @_;
2779
2780 $id //= 0;
2781 my $audio = $conf->{"audio$id"};
d1c1af4b 2782 return if !defined($audio);
d5535a00 2783
4df98f2f 2784 my $audioproperties = parse_property_string($audio_fmt, $audio);
d5535a00
TL
2785 my $audiodriver = $audioproperties->{driver} // 'spice';
2786
2787 return {
2788 dev => $audioproperties->{device},
b0f96836 2789 dev_id => "audiodev$id",
d5535a00
TL
2790 backend => $audiodriver,
2791 backend_id => "$audiodriver-backend${id}",
2792 };
2793}
2794
b01de199 2795sub audio_devs {
1cc5ed1b 2796 my ($audio, $audiopciaddr, $machine_version) = @_;
b01de199
TL
2797
2798 my $devs = [];
2799
2800 my $id = $audio->{dev_id};
1cc5ed1b
AL
2801 my $audiodev = "";
2802 if (min_version($machine_version, 4, 2)) {
2803 $audiodev = ",audiodev=$audio->{backend_id}";
2804 }
b01de199
TL
2805
2806 if ($audio->{dev} eq 'AC97') {
1cc5ed1b 2807 push @$devs, '-device', "AC97,id=${id}${audiopciaddr}$audiodev";
b01de199
TL
2808 } elsif ($audio->{dev} =~ /intel\-hda$/) {
2809 push @$devs, '-device', "$audio->{dev},id=${id}${audiopciaddr}";
1cc5ed1b
AL
2810 push @$devs, '-device', "hda-micro,id=${id}-codec0,bus=${id}.0,cad=0$audiodev";
2811 push @$devs, '-device', "hda-duplex,id=${id}-codec1,bus=${id}.0,cad=1$audiodev";
b01de199
TL
2812 } else {
2813 die "unkown audio device '$audio->{dev}', implement me!";
2814 }
2815
2816 push @$devs, '-audiodev', "$audio->{backend},id=$audio->{backend_id}";
2817
2818 return $devs;
2819}
2820
86b8228b
DM
2821sub vga_conf_has_spice {
2822 my ($vga) = @_;
2823
55655ebc
DC
2824 my $vgaconf = parse_vga($vga);
2825 my $vgatype = $vgaconf->{type};
2826 return 0 if !$vgatype || $vgatype !~ m/^qxl([234])?$/;
590e698c
DM
2827
2828 return $1 || 1;
86b8228b
DM
2829}
2830
d731ecbe
WB
2831sub is_native($) {
2832 my ($arch) = @_;
2833 return get_host_arch() eq $arch;
2834}
2835
045749f2
TL
2836sub get_vm_arch {
2837 my ($conf) = @_;
2838 return $conf->{arch} // get_host_arch();
2839}
2840
d731ecbe
WB
2841my $default_machines = {
2842 x86_64 => 'pc',
2843 aarch64 => 'virt',
2844};
2845
045749f2 2846sub get_vm_machine {
ac0077cc 2847 my ($conf, $forcemachine, $arch, $add_pve_version, $kvmversion) = @_;
045749f2
TL
2848
2849 my $machine = $forcemachine || $conf->{machine};
d731ecbe 2850
9471e48b 2851 if (!$machine || $machine =~ m/^(?:pc|q35|virt)$/) {
045749f2
TL
2852 $arch //= 'x86_64';
2853 $machine ||= $default_machines->{$arch};
ac0077cc
SR
2854 if ($add_pve_version) {
2855 $kvmversion //= kvm_user_version();
2856 my $pvever = PVE::QemuServer::Machine::get_pve_version($kvmversion);
2857 $machine .= "+pve$pvever";
2858 }
2859 }
2860
2861 if ($add_pve_version && $machine !~ m/\+pve\d+$/) {
2862 # for version-pinned machines that do not include a pve-version (e.g.
2863 # pc-q35-4.1), we assume 0 to keep them stable in case we bump
2864 $machine .= '+pve0';
045749f2
TL
2865 }
2866
2867 return $machine;
d731ecbe
WB
2868}
2869
96ed3574
WB
2870sub get_ovmf_files($) {
2871 my ($arch) = @_;
2872
2873 my $ovmf = $OVMF->{$arch}
2874 or die "no OVMF images known for architecture '$arch'\n";
2875
2876 return @$ovmf;
2877}
2878
6908fd9b
WB
2879my $Arch2Qemu = {
2880 aarch64 => '/usr/bin/qemu-system-aarch64',
2881 x86_64 => '/usr/bin/qemu-system-x86_64',
2882};
2883sub get_command_for_arch($) {
2884 my ($arch) = @_;
2885 return '/usr/bin/kvm' if is_native($arch);
2886
2887 my $cmd = $Arch2Qemu->{$arch}
2888 or die "don't know how to emulate architecture '$arch'\n";
2889 return $cmd;
2890}
2891
05a4c550
SR
2892# To use query_supported_cpu_flags and query_understood_cpu_flags to get flags
2893# to use in a QEMU command line (-cpu element), first array_intersect the result
2894# of query_supported_ with query_understood_. This is necessary because:
2895#
2896# a) query_understood_ returns flags the host cannot use and
2897# b) query_supported_ (rather the QMP call) doesn't actually return CPU
2898# flags, but CPU settings - with most of them being flags. Those settings
2899# (and some flags, curiously) cannot be specified as a "-cpu" argument.
2900#
2901# query_supported_ needs to start up to 2 temporary VMs and is therefore rather
2902# expensive. If you need the value returned from this, you can get it much
2903# cheaper from pmxcfs using PVE::Cluster::get_node_kv('cpuflags-$accel') with
2904# $accel being 'kvm' or 'tcg'.
2905#
2906# pvestatd calls this function on startup and whenever the QEMU/KVM version
2907# changes, automatically populating pmxcfs.
2908#
2909# Returns: { kvm => [ flagX, flagY, ... ], tcg => [ flag1, flag2, ... ] }
2910# since kvm and tcg machines support different flags
2911#
2912sub query_supported_cpu_flags {
52cffab6 2913 my ($arch) = @_;
05a4c550 2914
52cffab6
SR
2915 $arch //= get_host_arch();
2916 my $default_machine = $default_machines->{$arch};
2917
2918 my $flags = {};
05a4c550
SR
2919
2920 # FIXME: Once this is merged, the code below should work for ARM as well:
2921 # https://lists.nongnu.org/archive/html/qemu-devel/2019-06/msg04947.html
2922 die "QEMU/KVM cannot detect CPU flags on ARM (aarch64)\n" if
2923 $arch eq "aarch64";
2924
2925 my $kvm_supported = defined(kvm_version());
2926 my $qemu_cmd = get_command_for_arch($arch);
2927 my $fakevmid = -1;
2928 my $pidfile = PVE::QemuServer::Helpers::pidfile_name($fakevmid);
2929
2930 # Start a temporary (frozen) VM with vmid -1 to allow sending a QMP command
2931 my $query_supported_run_qemu = sub {
2932 my ($kvm) = @_;
2933
2934 my $flags = {};
2935 my $cmd = [
2936 $qemu_cmd,
2937 '-machine', $default_machine,
2938 '-display', 'none',
2939 '-chardev', "socket,id=qmp,path=/var/run/qemu-server/$fakevmid.qmp,server,nowait",
2940 '-mon', 'chardev=qmp,mode=control',
2941 '-pidfile', $pidfile,
2942 '-S', '-daemonize'
2943 ];
2944
2945 if (!$kvm) {
2946 push @$cmd, '-accel', 'tcg';
2947 }
2948
2949 my $rc = run_command($cmd, noerr => 1, quiet => 0);
2950 die "QEMU flag querying VM exited with code " . $rc if $rc;
2951
2952 eval {
2953 my $cmd_result = mon_cmd(
2954 $fakevmid,
2955 'query-cpu-model-expansion',
2956 type => 'full',
2957 model => { name => 'host' }
2958 );
2959
2960 my $props = $cmd_result->{model}->{props};
2961 foreach my $prop (keys %$props) {
2962 next if $props->{$prop} ne '1';
2963 # QEMU returns some flags multiple times, with '_', '.' or '-'
2964 # (e.g. lahf_lm and lahf-lm; sse4.2, sse4-2 and sse4_2; ...).
2965 # We only keep those with underscores, to match /proc/cpuinfo
2966 $prop =~ s/\.|-/_/g;
2967 $flags->{$prop} = 1;
2968 }
2969 };
2970 my $err = $@;
2971
2972 # force stop with 10 sec timeout and 'nocheck'
2973 # always stop, even if QMP failed
2974 vm_stop(undef, $fakevmid, 1, 1, 10, 0, 1);
2975
2976 die $err if $err;
2977
2978 return [ sort keys %$flags ];
2979 };
2980
2981 # We need to query QEMU twice, since KVM and TCG have different supported flags
2982 PVE::QemuConfig->lock_config($fakevmid, sub {
2983 $flags->{tcg} = eval { $query_supported_run_qemu->(0) };
2984 warn "warning: failed querying supported tcg flags: $@\n" if $@;
2985
2986 if ($kvm_supported) {
2987 $flags->{kvm} = eval { $query_supported_run_qemu->(1) };
2988 warn "warning: failed querying supported kvm flags: $@\n" if $@;
2989 }
2990 });
2991
2992 return $flags;
2993}
2994
2995# Understood CPU flags are written to a file at 'pve-qemu' compile time
2996my $understood_cpu_flag_dir = "/usr/share/kvm";
2997sub query_understood_cpu_flags {
2998 my $arch = get_host_arch();
2999 my $filepath = "$understood_cpu_flag_dir/recognized-CPUID-flags-$arch";
3000
3001 die "Cannot query understood QEMU CPU flags for architecture: $arch (file not found)\n"
3002 if ! -e $filepath;
3003
3004 my $raw = file_get_contents($filepath);
3005 $raw =~ s/^\s+|\s+$//g;
3006 my @flags = split(/\s+/, $raw);
3007
3008 return \@flags;
3009}
3010
1e3baf05 3011sub config_to_command {
58c64ad5 3012 my ($storecfg, $vmid, $conf, $defaults, $forcemachine, $forcecpu) = @_;
1e3baf05
DM
3013
3014 my $cmd = [];
8c559505
DM
3015 my $globalFlags = [];
3016 my $machineFlags = [];
3017 my $rtcFlags = [];
5bdcf937 3018 my $devices = [];
b78ebef7 3019 my $pciaddr = '';
5bdcf937 3020 my $bridges = {};
b42d3cf9 3021 my $ostype = $conf->{ostype};
4317f69f 3022 my $winversion = windows_version($ostype);
d731ecbe 3023 my $kvm = $conf->{kvm};
38277afc 3024 my $nodename = nodename();
d731ecbe 3025
045749f2 3026 my $arch = get_vm_arch($conf);
1476b99f
DC
3027 my $kvm_binary = get_command_for_arch($arch);
3028 my $kvmver = kvm_user_version($kvm_binary);
045749f2 3029
a04dd5c4
SR
3030 if (!$kvmver || $kvmver !~ m/^(\d+)\.(\d+)/ || $1 < 3) {
3031 $kvmver //= "undefined";
3032 die "Detected old QEMU binary ('$kvmver', at least 3.0 is required)\n";
3033 }
3034
9471e48b
TL
3035 my $add_pve_version = min_version($kvmver, 4, 1);
3036
3037 my $machine_type = get_vm_machine($conf, $forcemachine, $arch, $add_pve_version);
4df98f2f 3038 my $machine_version = extract_version($machine_type, $kvmver);
d731ecbe 3039 $kvm //= 1 if is_native($arch);
4317f69f 3040
a77a53ae 3041 $machine_version =~ m/(\d+)\.(\d+)/;
ac0077cc 3042 my ($machine_major, $machine_minor) = ($1, $2);
ac0077cc 3043
b516c848
SR
3044 if ($kvmver =~ m/^\d+\.\d+\.(\d+)/ && $1 >= 90) {
3045 warn "warning: Installed QEMU version ($kvmver) is a release candidate, ignoring version checks\n";
3046 } elsif (!min_version($kvmver, $machine_major, $machine_minor)) {
4df98f2f
TL
3047 die "Installed QEMU version '$kvmver' is too old to run machine type '$machine_type',"
3048 ." please upgrade node '$nodename'\n"
b516c848 3049 } elsif (!PVE::QemuServer::Machine::can_run_pve_machine_version($machine_version, $kvmver)) {
ac0077cc 3050 my $max_pve_version = PVE::QemuServer::Machine::get_pve_version($machine_version);
4df98f2f
TL
3051 die "Installed qemu-server (max feature level for $machine_major.$machine_minor is"
3052 ." pve$max_pve_version) is too old to run machine type '$machine_type', please upgrade"
3053 ." node '$nodename'\n";
ac0077cc
SR
3054 }
3055
3056 # if a specific +pve version is required for a feature, use $version_guard
3057 # instead of min_version to allow machines to be run with the minimum
3058 # required version
3059 my $required_pve_version = 0;
3060 my $version_guard = sub {
3061 my ($major, $minor, $pve) = @_;
3062 return 0 if !min_version($machine_version, $major, $minor, $pve);
47f35977
SR
3063 my $max_pve = PVE::QemuServer::Machine::get_pve_version("$major.$minor");
3064 return 1 if min_version($machine_version, $major, $minor, $max_pve+1);
ac0077cc
SR
3065 $required_pve_version = $pve if $pve && $pve > $required_pve_version;
3066 return 1;
3067 };
a77a53ae 3068
4df98f2f
TL
3069 if ($kvm && !defined kvm_version()) {
3070 die "KVM virtualisation configured, but not available. Either disable in VM configuration"
3071 ." or enable in BIOS.\n";
d731ecbe 3072 }
bfcd9b7e 3073
3392d6ca 3074 my $q35 = PVE::QemuServer::Machine::machine_type_is_q35($conf);
4d3f29ed 3075 my $hotplug_features = parse_hotplug_features(defined($conf->{hotplug}) ? $conf->{hotplug} : '1');
249c4a6c
AD
3076 my $use_old_bios_files = undef;
3077 ($use_old_bios_files, $machine_type) = qemu_use_old_bios_files($machine_type);
db656e5f 3078
f08e17c7
AD
3079 my $cpuunits = defined($conf->{cpuunits}) ?
3080 $conf->{cpuunits} : $defaults->{cpuunits};
3081
1476b99f 3082 push @$cmd, $kvm_binary;
1e3baf05
DM
3083
3084 push @$cmd, '-id', $vmid;
3085
e4d4cda1
HR
3086 my $vmname = $conf->{name} || "vm$vmid";
3087
3088 push @$cmd, '-name', $vmname;
3089
1e3baf05
DM
3090 my $use_virtio = 0;
3091
d036e418 3092 my $qmpsocket = PVE::QemuServer::Helpers::qmp_socket($vmid);
c971c4f2
AD
3093 push @$cmd, '-chardev', "socket,id=qmp,path=$qmpsocket,server,nowait";
3094 push @$cmd, '-mon', "chardev=qmp,mode=control";
3095
2ea5fb7e 3096 if (min_version($machine_version, 2, 12)) {
b4496b9e 3097 push @$cmd, '-chardev', "socket,id=qmp-event,path=/var/run/qmeventd.sock,reconnect=5";
71bd73b5
DC
3098 push @$cmd, '-mon', "chardev=qmp-event,mode=control";
3099 }
1e3baf05 3100
d036e418 3101 push @$cmd, '-pidfile' , PVE::QemuServer::Helpers::pidfile_name($vmid);
19672434 3102
1e3baf05
DM
3103 push @$cmd, '-daemonize';
3104
2796e7d5 3105 if ($conf->{smbios1}) {
1f30ac3a
CE
3106 my $smbios_conf = parse_smbios1($conf->{smbios1});
3107 if ($smbios_conf->{base64}) {
3108 # Do not pass base64 flag to qemu
3109 delete $smbios_conf->{base64};
3110 my $smbios_string = "";
3111 foreach my $key (keys %$smbios_conf) {
3112 my $value;
3113 if ($key eq "uuid") {
3114 $value = $smbios_conf->{uuid}
3115 } else {
3116 $value = decode_base64($smbios_conf->{$key});
3117 }
3118 # qemu accepts any binary data, only commas need escaping by double comma
3119 $value =~ s/,/,,/g;
3120 $smbios_string .= "," . $key . "=" . $value if $value;
3121 }
3122 push @$cmd, '-smbios', "type=1" . $smbios_string;
3123 } else {
3124 push @$cmd, '-smbios', "type=1,$conf->{smbios1}";
3125 }
2796e7d5
DM
3126 }
3127
3edb45e7 3128 if ($conf->{bios} && $conf->{bios} eq 'ovmf') {
818c3b8d
TL
3129 my ($ovmf_code, $ovmf_vars) = get_ovmf_files($arch);
3130 die "uefi base image '$ovmf_code' not found\n" if ! -f $ovmf_code;
2ddc0a5c 3131
818c3b8d 3132 my ($path, $format);
b57d4863
SR
3133 if (my $efidisk = $conf->{efidisk0}) {
3134 my $d = parse_drive('efidisk0', $efidisk);
2ddc0a5c 3135 my ($storeid, $volname) = PVE::Storage::parse_volume_id($d->{file}, 1);
13bca7b4 3136 $format = $d->{format};
2ddc0a5c
DC
3137 if ($storeid) {
3138 $path = PVE::Storage::path($storecfg, $d->{file});
13bca7b4
WB
3139 if (!defined($format)) {
3140 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
3141 $format = qemu_img_format($scfg, $volname);
3142 }
2ddc0a5c
DC
3143 } else {
3144 $path = $d->{file};
13bca7b4
WB
3145 die "efidisk format must be specified\n"
3146 if !defined($format);
2ddc0a5c 3147 }
2ddc0a5c 3148 } else {
4dcce9ee
TL
3149 warn "no efidisk configured! Using temporary efivars disk.\n";
3150 $path = "/tmp/$vmid-ovmf.fd";
96ed3574 3151 PVE::Tools::file_copy($ovmf_vars, $path, -s $ovmf_vars);
13bca7b4 3152 $format = 'raw';
2ddc0a5c 3153 }
4dcce9ee 3154
818ce80e
DC
3155 my $size_str = "";
3156
3157 if ($format eq 'raw' && $version_guard->(4, 1, 2)) {
3158 $size_str = ",size=" . (-s $ovmf_vars);
3159 }
3160
96ed3574 3161 push @$cmd, '-drive', "if=pflash,unit=0,format=raw,readonly,file=$ovmf_code";
818ce80e 3162 push @$cmd, '-drive', "if=pflash,unit=1,format=$format,id=drive-efidisk0$size_str,file=$path";
a783c78e
AD
3163 }
3164
7583d156
DC
3165 # load q35 config
3166 if ($q35) {
3167 # we use different pcie-port hardware for qemu >= 4.0 for passthrough
2ea5fb7e 3168 if (min_version($machine_version, 4, 0)) {
7583d156
DC
3169 push @$devices, '-readconfig', '/usr/share/qemu-server/pve-q35-4.0.cfg';
3170 } else {
3171 push @$devices, '-readconfig', '/usr/share/qemu-server/pve-q35.cfg';
3172 }
3173 }
da8b4189 3174
844d8fa6
DC
3175 if ($conf->{vmgenid}) {
3176 push @$devices, '-device', 'vmgenid,guid='.$conf->{vmgenid};
3177 }
3178
d40e5e18 3179 # add usb controllers
4df98f2f
TL
3180 my @usbcontrollers = PVE::QemuServer::USB::get_usb_controllers(
3181 $conf, $bridges, $arch, $machine_type, $usbdesc->{format}, $MAX_USB_DEVICES);
d40e5e18 3182 push @$devices, @usbcontrollers if @usbcontrollers;
55655ebc 3183 my $vga = parse_vga($conf->{vga});
2fa3151e 3184
55655ebc
DC
3185 my $qxlnum = vga_conf_has_spice($conf->{vga});
3186 $vga->{type} = 'qxl' if $qxlnum;
2fa3151e 3187
55655ebc 3188 if (!$vga->{type}) {
869ad4a7
WB
3189 if ($arch eq 'aarch64') {
3190 $vga->{type} = 'virtio';
2ea5fb7e 3191 } elsif (min_version($machine_version, 2, 9)) {
55655ebc 3192 $vga->{type} = (!$winversion || $winversion >= 6) ? 'std' : 'cirrus';
a2a5cd64 3193 } else {
55655ebc 3194 $vga->{type} = ($winversion >= 6) ? 'std' : 'cirrus';
a2a5cd64 3195 }
5acbfe9e
DM
3196 }
3197
1e3baf05 3198 # enable absolute mouse coordinates (needed by vnc)
5acbfe9e
DM
3199 my $tablet;
3200 if (defined($conf->{tablet})) {
3201 $tablet = $conf->{tablet};
3202 } else {
3203 $tablet = $defaults->{tablet};
590e698c 3204 $tablet = 0 if $qxlnum; # disable for spice because it is not needed
55655ebc 3205 $tablet = 0 if $vga->{type} =~ m/^serial\d+$/; # disable if we use serial terminal (no vga card)
5acbfe9e
DM
3206 }
3207
d559309f
WB
3208 if ($tablet) {
3209 push @$devices, '-device', print_tabletdevice_full($conf, $arch) if $tablet;
3210 my $kbd = print_keyboarddevice_full($conf, $arch);
3211 push @$devices, '-device', $kbd if defined($kbd);
3212 }
b467f79a 3213
e5d611c3 3214 my $bootorder = device_bootorder($conf);
2141a802 3215
74c17b7a 3216 # host pci device passthrough
13d68979 3217 my ($kvm_off, $gpu_passthrough, $legacy_igd) = PVE::QemuServer::PCI::print_hostpci_devices(
41af2dfc 3218 $vmid, $conf, $devices, $vga, $winversion, $q35, $bridges, $arch, $machine_type, $bootorder);
1e3baf05
DM
3219
3220 # usb devices
ae36393d 3221 my $usb_dev_features = {};
2ea5fb7e 3222 $usb_dev_features->{spice_usb3} = 1 if min_version($machine_version, 4, 0);
ae36393d 3223
4df98f2f 3224 my @usbdevices = PVE::QemuServer::USB::get_usb_devices(
2141a802 3225 $conf, $usbdesc->{format}, $MAX_USB_DEVICES, $usb_dev_features, $bootorder);
d40e5e18 3226 push @$devices, @usbdevices if @usbdevices;
2141a802 3227
1e3baf05 3228 # serial devices
bae179aa 3229 for (my $i = 0; $i < $MAX_SERIAL_PORTS; $i++) {
34978be3 3230 if (my $path = $conf->{"serial$i"}) {
9f9d2fb2
DM
3231 if ($path eq 'socket') {
3232 my $socket = "/var/run/qemu-server/${vmid}.serial$i";
3233 push @$devices, '-chardev', "socket,id=serial$i,path=$socket,server,nowait";
91b01bbb
WB
3234 # On aarch64, serial0 is the UART device. Qemu only allows
3235 # connecting UART devices via the '-serial' command line, as
3236 # the device has a fixed slot on the hardware...
3237 if ($arch eq 'aarch64' && $i == 0) {
3238 push @$devices, '-serial', "chardev:serial$i";
3239 } else {
3240 push @$devices, '-device', "isa-serial,chardev=serial$i";
3241 }
9f9d2fb2
DM
3242 } else {
3243 die "no such serial device\n" if ! -c $path;
3244 push @$devices, '-chardev', "tty,id=serial$i,path=$path";
3245 push @$devices, '-device', "isa-serial,chardev=serial$i";
3246 }
34978be3 3247 }
1e3baf05
DM
3248 }
3249
3250 # parallel devices
1989a89c 3251 for (my $i = 0; $i < $MAX_PARALLEL_PORTS; $i++) {
34978be3 3252 if (my $path = $conf->{"parallel$i"}) {
19672434 3253 die "no such parallel device\n" if ! -c $path;
32e69805 3254 my $devtype = $path =~ m!^/dev/usb/lp! ? 'tty' : 'parport';
4c5dbaf6 3255 push @$devices, '-chardev', "$devtype,id=parallel$i,path=$path";
5bdcf937 3256 push @$devices, '-device', "isa-parallel,chardev=parallel$i";
34978be3 3257 }
1e3baf05
DM
3258 }
3259
b01de199 3260 if (min_version($machine_version, 4, 0) && (my $audio = conf_has_audio($conf))) {
2e7b5925 3261 my $audiopciaddr = print_pci_addr("audio0", $bridges, $arch, $machine_type);
1cc5ed1b 3262 my $audio_devs = audio_devs($audio, $audiopciaddr, $machine_version);
b01de199 3263 push @$devices, @$audio_devs;
2e7b5925 3264 }
19672434 3265
1e3baf05
DM
3266 my $sockets = 1;
3267 $sockets = $conf->{smp} if $conf->{smp}; # old style - no longer iused
3268 $sockets = $conf->{sockets} if $conf->{sockets};
3269
3270 my $cores = $conf->{cores} || 1;
3bd18e48 3271
de9d1e55 3272 my $maxcpus = $sockets * $cores;
76267728 3273
de9d1e55 3274 my $vcpus = $conf->{vcpus} ? $conf->{vcpus} : $maxcpus;
76267728 3275
de9d1e55
AD
3276 my $allowed_vcpus = $cpuinfo->{cpus};
3277
6965d5d1 3278 die "MAX $allowed_vcpus vcpus allowed per VM on this node\n"
de9d1e55
AD
3279 if ($allowed_vcpus < $maxcpus);
3280
2ea5fb7e 3281 if($hotplug_features->{cpu} && min_version($machine_version, 2, 7)) {
1e3baf05 3282
69c81430
AD
3283 push @$cmd, '-smp', "1,sockets=$sockets,cores=$cores,maxcpus=$maxcpus";
3284 for (my $i = 2; $i <= $vcpus; $i++) {
3285 my $cpustr = print_cpu_device($conf,$i);
3286 push @$cmd, '-device', $cpustr;
3287 }
3288
3289 } else {
3290
3291 push @$cmd, '-smp', "$vcpus,sockets=$sockets,cores=$cores,maxcpus=$maxcpus";
3292 }
1e3baf05
DM
3293 push @$cmd, '-nodefaults';
3294
dbea4415 3295 push @$cmd, '-boot', "menu=on,strict=on,reboot-timeout=1000,splash=/usr/share/qemu-server/bootsplash.jpg";
1e3baf05 3296
6b64503e 3297 push @$cmd, '-no-acpi' if defined($conf->{acpi}) && $conf->{acpi} == 0;
1e3baf05 3298
6b64503e 3299 push @$cmd, '-no-reboot' if defined($conf->{reboot}) && $conf->{reboot} == 0;
1e3baf05 3300
84902837 3301 if ($vga->{type} && $vga->{type} !~ m/^serial\d+$/ && $vga->{type} ne 'none'){
4df98f2f
TL
3302 push @$devices, '-device', print_vga_device(
3303 $conf, $vga, $arch, $machine_version, $machine_type, undef, $qxlnum, $bridges);
d036e418 3304 my $socket = PVE::QemuServer::Helpers::vnc_socket($vmid);
dc62a7fa 3305 push @$cmd, '-vnc', "unix:$socket,password";
b7be4ba9 3306 } else {
55655ebc 3307 push @$cmd, '-vga', 'none' if $vga->{type} eq 'none';
b7be4ba9
AD
3308 push @$cmd, '-nographic';
3309 }
3310
1e3baf05 3311 # time drift fix
6b64503e 3312 my $tdf = defined($conf->{tdf}) ? $conf->{tdf} : $defaults->{tdf};
8c559505 3313 my $useLocaltime = $conf->{localtime};
1e3baf05 3314
4317f69f
AD
3315 if ($winversion >= 5) { # windows
3316 $useLocaltime = 1 if !defined($conf->{localtime});
7a131888 3317
4317f69f
AD
3318 # use time drift fix when acpi is enabled
3319 if (!(defined($conf->{acpi}) && $conf->{acpi} == 0)) {
3320 $tdf = 1 if !defined($conf->{tdf});
462e8d19 3321 }
4317f69f 3322 }
462e8d19 3323
4317f69f
AD
3324 if ($winversion >= 6) {
3325 push @$globalFlags, 'kvm-pit.lost_tick_policy=discard';
3326 push @$cmd, '-no-hpet';
1e3baf05
DM
3327 }
3328
8c559505
DM
3329 push @$rtcFlags, 'driftfix=slew' if $tdf;
3330
2f6f002c 3331 if ($conf->{startdate} && $conf->{startdate} ne 'now') {
8c559505
DM
3332 push @$rtcFlags, "base=$conf->{startdate}";
3333 } elsif ($useLocaltime) {
3334 push @$rtcFlags, 'base=localtime';
3335 }
1e3baf05 3336
58c64ad5
SR
3337 if ($forcecpu) {
3338 push @$cmd, '-cpu', $forcecpu;
3339 } else {
2f6f002c 3340 push @$cmd, get_cpu_options($conf, $arch, $kvm, $kvm_off, $machine_version, $winversion, $gpu_passthrough);
58c64ad5 3341 }
519ed28c 3342
0567a4d5 3343 PVE::QemuServer::Memory::config($conf, $vmid, $sockets, $cores, $defaults, $hotplug_features, $cmd);
370b05e7 3344
1e3baf05
DM
3345 push @$cmd, '-S' if $conf->{freeze};
3346
b20df606 3347 push @$cmd, '-k', $conf->{keyboard} if defined($conf->{keyboard});
1e3baf05 3348
48657158
MD
3349 my $guest_agent = parse_guest_agent($conf);
3350
3351 if ($guest_agent->{enabled}) {
d036e418 3352 my $qgasocket = PVE::QemuServer::Helpers::qmp_socket($vmid, 1);
ab6a046f 3353 push @$devices, '-chardev', "socket,path=$qgasocket,server,nowait,id=qga0";
48657158 3354
60f03a11 3355 if (!$guest_agent->{type} || $guest_agent->{type} eq 'virtio') {
48657158
MD
3356 my $pciaddr = print_pci_addr("qga0", $bridges, $arch, $machine_type);
3357 push @$devices, '-device', "virtio-serial,id=qga0$pciaddr";
3358 push @$devices, '-device', 'virtserialport,chardev=qga0,name=org.qemu.guest_agent.0';
3359 } elsif ($guest_agent->{type} eq 'isa') {
3360 push @$devices, '-device', "isa-serial,chardev=qga0";
3361 }
ab6a046f
AD
3362 }
3363
e5d611c3
TL
3364 my $rng = $conf->{rng0} ? parse_rng($conf->{rng0}) : undef;
3365 if ($rng && $version_guard->(4, 1, 2)) {
05853188
SR
3366 check_rng_source($rng->{source});
3367
2cf61f33
SR
3368 my $max_bytes = $rng->{max_bytes} // $rng_fmt->{max_bytes}->{default};
3369 my $period = $rng->{period} // $rng_fmt->{period}->{default};
2cf61f33
SR
3370 my $limiter_str = "";
3371 if ($max_bytes) {
3372 $limiter_str = ",max-bytes=$max_bytes,period=$period";
3373 }
3374
2cf61f33 3375 my $rng_addr = print_pci_addr("rng0", $bridges, $arch, $machine_type);
2cf61f33
SR
3376 push @$devices, '-object', "rng-random,filename=$rng->{source},id=rng0";
3377 push @$devices, '-device', "virtio-rng-pci,rng=rng0$limiter_str$rng_addr";
3378 }
3379
1d794448 3380 my $spice_port;
2fa3151e 3381
590e698c
DM
3382 if ($qxlnum) {
3383 if ($qxlnum > 1) {
ac087616 3384 if ($winversion){
2f6f002c 3385 for (my $i = 1; $i < $qxlnum; $i++){
4df98f2f
TL
3386 push @$devices, '-device', print_vga_device(
3387 $conf, $vga, $arch, $machine_version, $machine_type, $i, $qxlnum, $bridges);
590e698c
DM
3388 }
3389 } else {
3390 # assume other OS works like Linux
55655ebc
DC
3391 my ($ram, $vram) = ("134217728", "67108864");
3392 if ($vga->{memory}) {
3393 $ram = PVE::Tools::convert_size($qxlnum*4*$vga->{memory}, 'mb' => 'b');
3394 $vram = PVE::Tools::convert_size($qxlnum*2*$vga->{memory}, 'mb' => 'b');
3395 }
3396 push @$cmd, '-global', "qxl-vga.ram_size=$ram";
3397 push @$cmd, '-global', "qxl-vga.vram_size=$vram";
2fa3151e
AD
3398 }
3399 }
3400
d559309f 3401 my $pciaddr = print_pci_addr("spice", $bridges, $arch, $machine_type);
95a4b4a9 3402
af0eba7e 3403 my $pfamily = PVE::Tools::get_host_address_family($nodename);
91152441
WB
3404 my @nodeaddrs = PVE::Tools::getaddrinfo_all('localhost', family => $pfamily);
3405 die "failed to get an ip address of type $pfamily for 'localhost'\n" if !@nodeaddrs;
4d316a63
AL
3406
3407 push @$devices, '-device', "virtio-serial,id=spice$pciaddr";
3408 push @$devices, '-chardev', "spicevmc,id=vdagent,name=vdagent";
3409 push @$devices, '-device', "virtserialport,chardev=vdagent,name=com.redhat.spice.0";
3410
91152441
WB
3411 my $localhost = PVE::Network::addr_to_ip($nodeaddrs[0]->{addr});
3412 $spice_port = PVE::Tools::next_spice_port($pfamily, $localhost);
943340a6 3413
4df98f2f
TL
3414 my $spice_enhancement_str = $conf->{spice_enhancements} // '';
3415 my $spice_enhancement = parse_property_string($spice_enhancements_fmt, $spice_enhancement_str);
caab114a
TL
3416 if ($spice_enhancement->{foldersharing}) {
3417 push @$devices, '-chardev', "spiceport,id=foldershare,name=org.spice-space.webdav.0";
3418 push @$devices, '-device', "virtserialport,chardev=foldershare,name=org.spice-space.webdav.0";
3419 }
c4df18db 3420
caab114a 3421 my $spice_opts = "tls-port=${spice_port},addr=$localhost,tls-ciphers=HIGH,seamless-migration=on";
4df98f2f
TL
3422 $spice_opts .= ",streaming-video=$spice_enhancement->{videostreaming}"
3423 if $spice_enhancement->{videostreaming};
3424
caab114a 3425 push @$devices, '-spice', "$spice_opts";
1011b570
DM
3426 }
3427
8d9ae0d2
DM
3428 # enable balloon by default, unless explicitly disabled
3429 if (!defined($conf->{balloon}) || $conf->{balloon}) {
d559309f 3430 $pciaddr = print_pci_addr("balloon0", $bridges, $arch, $machine_type);
8d9ae0d2
DM
3431 push @$devices, '-device', "virtio-balloon-pci,id=balloon0$pciaddr";
3432 }
1e3baf05 3433
0ea9541d
DM
3434 if ($conf->{watchdog}) {
3435 my $wdopts = parse_watchdog($conf->{watchdog});
d559309f 3436 $pciaddr = print_pci_addr("watchdog", $bridges, $arch, $machine_type);
0a40e8ea 3437 my $watchdog = $wdopts->{model} || 'i6300esb';
5bdcf937
AD
3438 push @$devices, '-device', "$watchdog$pciaddr";
3439 push @$devices, '-watchdog-action', $wdopts->{action} if $wdopts->{action};
0ea9541d
DM
3440 }
3441
1e3baf05 3442 my $vollist = [];
941e0c42 3443 my $scsicontroller = {};
26ee04b6 3444 my $ahcicontroller = {};
cdd20088 3445 my $scsihw = defined($conf->{scsihw}) ? $conf->{scsihw} : $defaults->{scsihw};
1e3baf05 3446
5881b913
DM
3447 # Add iscsi initiator name if available
3448 if (my $initiator = get_initiator_name()) {
3449 push @$devices, '-iscsi', "initiator-name=$initiator";
3450 }
3451
912792e2 3452 PVE::QemuConfig->foreach_volume($conf, sub {
1e3baf05
DM
3453 my ($ds, $drive) = @_;
3454
ff1a2432 3455 if (PVE::Storage::parse_volume_id($drive->{file}, 1)) {
1e3baf05 3456 push @$vollist, $drive->{file};
ff1a2432 3457 }
afdb31d5 3458
4dcce9ee
TL
3459 # ignore efidisk here, already added in bios/fw handling code above
3460 return if $drive->{interface} eq 'efidisk';
3461
1e3baf05 3462 $use_virtio = 1 if $ds =~ m/^virtio/;
3b408e82 3463
2141a802 3464 $drive->{bootindex} = $bootorder->{$ds} if $bootorder->{$ds};
3b408e82 3465
2f6f002c 3466 if ($drive->{interface} eq 'virtio'){
51f492cd
AD
3467 push @$cmd, '-object', "iothread,id=iothread-$ds" if $drive->{iothread};
3468 }
3469
2f6f002c 3470 if ($drive->{interface} eq 'scsi') {
cdd20088 3471
ee034f5c 3472 my ($maxdev, $controller, $controller_prefix) = scsihw_infos($conf, $drive);
6731a4cf 3473
b8fb1c03
SR
3474 die "scsi$drive->{index}: machine version 4.1~pve2 or higher is required to use more than 14 SCSI disks\n"
3475 if $drive->{index} > 13 && !&$version_guard(4, 1, 2);
3476
d559309f 3477 $pciaddr = print_pci_addr("$controller_prefix$controller", $bridges, $arch, $machine_type);
a1b7d579 3478 my $scsihw_type = $scsihw =~ m/^virtio-scsi-single/ ? "virtio-scsi-pci" : $scsihw;
fc8b40fd
AD
3479
3480 my $iothread = '';
3481 if($conf->{scsihw} && $conf->{scsihw} eq "virtio-scsi-single" && $drive->{iothread}){
3482 $iothread .= ",iothread=iothread-$controller_prefix$controller";
3483 push @$cmd, '-object', "iothread,id=iothread-$controller_prefix$controller";
e7a5104d
DC
3484 } elsif ($drive->{iothread}) {
3485 warn "iothread is only valid with virtio disk or virtio-scsi-single controller, ignoring\n";
fc8b40fd
AD
3486 }
3487
6e11f143
AD
3488 my $queues = '';
3489 if($conf->{scsihw} && $conf->{scsihw} eq "virtio-scsi-single" && $drive->{queues}){
3490 $queues = ",num_queues=$drive->{queues}";
370b05e7 3491 }
6e11f143 3492
4df98f2f
TL
3493 push @$devices, '-device', "$scsihw_type,id=$controller_prefix$controller$pciaddr$iothread$queues"
3494 if !$scsicontroller->{$controller};
cdd20088 3495 $scsicontroller->{$controller}=1;
2f6f002c 3496 }
3b408e82 3497
26ee04b6 3498 if ($drive->{interface} eq 'sata') {
2f6f002c
TL
3499 my $controller = int($drive->{index} / $PVE::QemuServer::Drive::MAX_SATA_DISKS);
3500 $pciaddr = print_pci_addr("ahci$controller", $bridges, $arch, $machine_type);
4df98f2f
TL
3501 push @$devices, '-device', "ahci,id=ahci$controller,multifunction=on$pciaddr"
3502 if !$ahcicontroller->{$controller};
2f6f002c 3503 $ahcicontroller->{$controller}=1;
26ee04b6 3504 }
46f58b5f 3505
776c5f50 3506 my $drive_cmd = print_drive_commandline_full($storecfg, $vmid, $drive);
4ef13a7f
FG
3507 $drive_cmd .= ',readonly' if PVE::QemuConfig->is_template($conf);
3508
15b21acc 3509 push @$devices, '-drive',$drive_cmd;
4df98f2f
TL
3510 push @$devices, '-device', print_drivedevice_full(
3511 $storecfg, $conf, $vmid, $drive, $bridges, $arch, $machine_type);
1e3baf05
DM
3512 });
3513
cc4d6182 3514 for (my $i = 0; $i < $MAX_NETS; $i++) {
2141a802
SR
3515 my $netname = "net$i";
3516
3517 next if !$conf->{$netname};
3518 my $d = parse_net($conf->{$netname});
d0a86b24 3519 next if !$d;
1e3baf05 3520
d0a86b24 3521 $use_virtio = 1 if $d->{model} eq 'virtio';
1e3baf05 3522
2141a802 3523 $d->{bootindex} = $bootorder->{$netname} if $bootorder->{$netname};
1e3baf05 3524
2141a802 3525 my $netdevfull = print_netdev_full($vmid, $conf, $arch, $d, $netname);
d0a86b24 3526 push @$devices, '-netdev', $netdevfull;
5bdcf937 3527
d0a86b24 3528 my $netdevicefull = print_netdevice_full(
2141a802 3529 $vmid, $conf, $d, $netname, $bridges, $use_old_bios_files, $arch, $machine_type);
4df98f2f 3530
d0a86b24 3531 push @$devices, '-device', $netdevicefull;
5bdcf937 3532 }
1e3baf05 3533
6dbcb073 3534 if ($conf->{ivshmem}) {
4df98f2f 3535 my $ivshmem = parse_property_string($ivshmem_fmt, $conf->{ivshmem});
e3c27a6a 3536
6dbcb073
DC
3537 my $bus;
3538 if ($q35) {
3539 $bus = print_pcie_addr("ivshmem");
3540 } else {
3541 $bus = print_pci_addr("ivshmem", $bridges, $arch, $machine_type);
3542 }
e3c27a6a
TL
3543
3544 my $ivshmem_name = $ivshmem->{name} // $vmid;
3545 my $path = '/dev/shm/pve-shm-' . $ivshmem_name;
3546
6dbcb073 3547 push @$devices, '-device', "ivshmem-plain,memdev=ivshmem$bus,";
4df98f2f
TL
3548 push @$devices, '-object', "memory-backend-file,id=ivshmem,share=on,mem-path=$path"
3549 .",size=$ivshmem->{size}M";
6dbcb073
DC
3550 }
3551
2513b862
DC
3552 # pci.4 is nested in pci.1
3553 $bridges->{1} = 1 if $bridges->{4};
3554
db656e5f
DM
3555 if (!$q35) {
3556 # add pci bridges
2ea5fb7e 3557 if (min_version($machine_version, 2, 3)) {
fc79e813
AD
3558 $bridges->{1} = 1;
3559 $bridges->{2} = 1;
3560 }
3561
6731a4cf
AD
3562 $bridges->{3} = 1 if $scsihw =~ m/^virtio-scsi-single/;
3563
2513b862
DC
3564 }
3565
3566 for my $k (sort {$b cmp $a} keys %$bridges) {
3567 next if $q35 && $k < 4; # q35.cfg already includes bridges up to 3
13d68979
SR
3568
3569 my $k_name = $k;
3570 if ($k == 2 && $legacy_igd) {
3571 $k_name = "$k-igd";
3572 }
3573 $pciaddr = print_pci_addr("pci.$k_name", undef, $arch, $machine_type);
3574
2513b862
DC
3575 my $devstr = "pci-bridge,id=pci.$k,chassis_nr=$k$pciaddr";
3576 if ($q35) {
3577 # add after -readconfig pve-q35.cfg
3578 splice @$devices, 2, 0, '-device', $devstr;
3579 } else {
3580 unshift @$devices, '-device', $devstr if $k > 0;
f8e83f05 3581 }
19672434
DM
3582 }
3583
ac0077cc
SR
3584 if (!$kvm) {
3585 push @$machineFlags, 'accel=tcg';
3586 }
3587
3588 my $machine_type_min = $machine_type;
3589 if ($add_pve_version) {
3590 $machine_type_min =~ s/\+pve\d+$//;
3591 $machine_type_min .= "+pve$required_pve_version";
3592 }
3593 push @$machineFlags, "type=${machine_type_min}";
3594
5bdcf937 3595 push @$cmd, @$devices;
2f6f002c
TL
3596 push @$cmd, '-rtc', join(',', @$rtcFlags) if scalar(@$rtcFlags);
3597 push @$cmd, '-machine', join(',', @$machineFlags) if scalar(@$machineFlags);
3598 push @$cmd, '-global', join(',', @$globalFlags) if scalar(@$globalFlags);
8c559505 3599
7ceade4c
DC
3600 if (my $vmstate = $conf->{vmstate}) {
3601 my $statepath = PVE::Storage::path($storecfg, $vmstate);
24d1f93a 3602 push @$vollist, $vmstate;
7ceade4c 3603 push @$cmd, '-loadstate', $statepath;
b85666cf 3604 print "activating and using '$vmstate' as vmstate\n";
7ceade4c
DC
3605 }
3606
76350670
DC
3607 # add custom args
3608 if ($conf->{args}) {
3609 my $aa = PVE::Tools::split_args($conf->{args});
3610 push @$cmd, @$aa;
3611 }
3612
1d794448 3613 return wantarray ? ($cmd, $vollist, $spice_port) : $cmd;
1e3baf05 3614}
19672434 3615
05853188
SR
3616sub check_rng_source {
3617 my ($source) = @_;
3618
3619 # mostly relevant for /dev/hwrng, but doesn't hurt to check others too
3620 die "cannot create VirtIO RNG device: source file '$source' doesn't exist\n"
3621 if ! -e $source;
3622
3623 my $rng_current = '/sys/devices/virtual/misc/hw_random/rng_current';
3624 if ($source eq '/dev/hwrng' && file_read_firstline($rng_current) eq 'none') {
4df98f2f
TL
3625 # Needs to abort, otherwise QEMU crashes on first rng access. Note that rng_current cannot
3626 # be changed to 'none' manually, so once the VM is past this point, it's no longer an issue.
3627 die "Cannot start VM with passed-through RNG device: '/dev/hwrng' exists, but"
3628 ." '$rng_current' is set to 'none'. Ensure that a compatible hardware-RNG is attached"
3629 ." to the host.\n";
05853188
SR
3630 }
3631}
3632
943340a6 3633sub spice_port {
1011b570 3634 my ($vmid) = @_;
943340a6 3635
0a13e08e 3636 my $res = mon_cmd($vmid, 'query-spice');
943340a6
DM
3637
3638 return $res->{'tls-port'} || $res->{'port'} || die "no spice port\n";
1011b570
DM
3639}
3640
86fdcfb2
DA
3641sub vm_devices_list {
3642 my ($vmid) = @_;
3643
0a13e08e 3644 my $res = mon_cmd($vmid, 'query-pci');
f721624b 3645 my $devices_to_check = [];
ceea9078
DM
3646 my $devices = {};
3647 foreach my $pcibus (@$res) {
f721624b
DC
3648 push @$devices_to_check, @{$pcibus->{devices}},
3649 }
3650
3651 while (@$devices_to_check) {
3652 my $to_check = [];
3653 for my $d (@$devices_to_check) {
3654 $devices->{$d->{'qdev_id'}} = 1 if $d->{'qdev_id'};
3655 next if !$d->{'pci_bridge'};
3656
3657 $devices->{$d->{'qdev_id'}} += scalar(@{$d->{'pci_bridge'}->{devices}});
3658 push @$to_check, @{$d->{'pci_bridge'}->{devices}};
f78cc802 3659 }
f721624b 3660 $devices_to_check = $to_check;
f78cc802
AD
3661 }
3662
0a13e08e 3663 my $resblock = mon_cmd($vmid, 'query-block');
f78cc802
AD
3664 foreach my $block (@$resblock) {
3665 if($block->{device} =~ m/^drive-(\S+)/){
3666 $devices->{$1} = 1;
1dc4f496
DM
3667 }
3668 }
86fdcfb2 3669
0a13e08e 3670 my $resmice = mon_cmd($vmid, 'query-mice');
3d7389fe
DM
3671 foreach my $mice (@$resmice) {
3672 if ($mice->{name} eq 'QEMU HID Tablet') {
3673 $devices->{tablet} = 1;
3674 last;
3675 }
3676 }
3677
deb091c5
DC
3678 # for usb devices there is no query-usb
3679 # but we can iterate over the entries in
3680 # qom-list path=/machine/peripheral
0a13e08e 3681 my $resperipheral = mon_cmd($vmid, 'qom-list', path => '/machine/peripheral');
deb091c5
DC
3682 foreach my $per (@$resperipheral) {
3683 if ($per->{name} =~ m/^usb\d+$/) {
3684 $devices->{$per->{name}} = 1;
3685 }
3686 }
3687
1dc4f496 3688 return $devices;
86fdcfb2
DA
3689}
3690
ec21aa11 3691sub vm_deviceplug {
d559309f 3692 my ($storecfg, $conf, $vmid, $deviceid, $device, $arch, $machine_type) = @_;
ae57f6b3 3693
3392d6ca 3694 my $q35 = PVE::QemuServer::Machine::machine_type_is_q35($conf);
db656e5f 3695
95d6343b
DA
3696 my $devices_list = vm_devices_list($vmid);
3697 return 1 if defined($devices_list->{$deviceid});
3698
4df98f2f
TL
3699 # add PCI bridge if we need it for the device
3700 qemu_add_pci_bridge($storecfg, $conf, $vmid, $deviceid, $arch, $machine_type);
fee46675 3701
3d7389fe 3702 if ($deviceid eq 'tablet') {
fee46675 3703
d559309f
WB
3704 qemu_deviceadd($vmid, print_tabletdevice_full($conf, $arch));
3705
3706 } elsif ($deviceid eq 'keyboard') {
3707
3708 qemu_deviceadd($vmid, print_keyboarddevice_full($conf, $arch));
3d7389fe 3709
4eb68604
DC
3710 } elsif ($deviceid =~ m/^usb(\d+)$/) {
3711
f745762b 3712 die "usb hotplug currently not reliable\n";
50bbe377
TL
3713 # since we can't reliably hot unplug all added usb devices and usb
3714 # passthrough breaks live migration we disable usb hotplugging for now
3715 #qemu_deviceadd($vmid, PVE::QemuServer::USB::print_usbdevice_full($conf, $deviceid, $device));
4eb68604 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 3819 die "usb hotplug currently not reliable\n";
50bbe377
TL
3820 # when unplugging usb devices this way, there may be remaining usb
3821 # controllers/hubs so we disable it for now
3822 #qemu_devicedel($vmid, $deviceid);
3823 #qemu_devicedelverify($vmid, $deviceid);
4eb68604 3824
63c2da2f 3825 } elsif ($deviceid =~ m/^(virtio)(\d+)$/) {
f19d1c47 3826
5e5dcb73 3827 qemu_devicedel($vmid, $deviceid);
63c2da2f
DM
3828 qemu_devicedelverify($vmid, $deviceid);
3829 qemu_drivedel($vmid, $deviceid);
22de899a
AD
3830 qemu_iothread_del($conf, $vmid, $deviceid);
3831
2733141c 3832 } elsif ($deviceid =~ m/^(virtioscsi|scsihw)(\d+)$/) {
a1b7d579 3833
63c2da2f 3834 qemu_devicedel($vmid, $deviceid);
8ce30dde 3835 qemu_devicedelverify($vmid, $deviceid);
fc8b40fd 3836 qemu_iothread_del($conf, $vmid, $deviceid);
a1b7d579 3837
63c2da2f 3838 } elsif ($deviceid =~ m/^(scsi)(\d+)$/) {
cfc817c7 3839
63c2da2f
DM
3840 qemu_devicedel($vmid, $deviceid);
3841 qemu_drivedel($vmid, $deviceid);
a1b7d579 3842 qemu_deletescsihw($conf, $vmid, $deviceid);
8ce30dde 3843
63c2da2f 3844 } elsif ($deviceid =~ m/^(net)(\d+)$/) {
a4f091a0 3845
2630d2a9 3846 qemu_devicedel($vmid, $deviceid);
63c2da2f
DM
3847 qemu_devicedelverify($vmid, $deviceid);
3848 qemu_netdevdel($vmid, $deviceid);
3849
3850 } else {
3851 die "can't unplug device '$deviceid'\n";
2630d2a9
DA
3852 }
3853
5e5dcb73
DA
3854 return 1;
3855}
3856
3857sub qemu_deviceadd {
3858 my ($vmid, $devicefull) = @_;
873c2d69 3859
d695b5b7
AD
3860 $devicefull = "driver=".$devicefull;
3861 my %options = split(/[=,]/, $devicefull);
f19d1c47 3862
0a13e08e 3863 mon_cmd($vmid, "device_add" , %options);
5e5dcb73 3864}
afdb31d5 3865
5e5dcb73 3866sub qemu_devicedel {
fee46675 3867 my ($vmid, $deviceid) = @_;
63c2da2f 3868
0a13e08e 3869 my $ret = mon_cmd($vmid, "device_del", id => $deviceid);
5e5dcb73
DA
3870}
3871
22de899a
AD
3872sub qemu_iothread_add {
3873 my($vmid, $deviceid, $device) = @_;
3874
3875 if ($device->{iothread}) {
3876 my $iothreads = vm_iothreads_list($vmid);
3877 qemu_objectadd($vmid, "iothread-$deviceid", "iothread") if !$iothreads->{"iothread-$deviceid"};
3878 }
3879}
3880
3881sub qemu_iothread_del {
3882 my($conf, $vmid, $deviceid) = @_;
3883
7820eae4
DC
3884 my $confid = $deviceid;
3885 if ($deviceid =~ m/^(?:virtioscsi|scsihw)(\d+)$/) {
3886 $confid = 'scsi' . $1;
3887 }
3888 my $device = parse_drive($confid, $conf->{$confid});
22de899a
AD
3889 if ($device->{iothread}) {
3890 my $iothreads = vm_iothreads_list($vmid);
3891 qemu_objectdel($vmid, "iothread-$deviceid") if $iothreads->{"iothread-$deviceid"};
3892 }
3893}
3894
4d3f29ed
AD
3895sub qemu_objectadd {
3896 my($vmid, $objectid, $qomtype) = @_;
3897
0a13e08e 3898 mon_cmd($vmid, "object-add", id => $objectid, "qom-type" => $qomtype);
4d3f29ed
AD
3899
3900 return 1;
3901}
3902
3903sub qemu_objectdel {
3904 my($vmid, $objectid) = @_;
3905
0a13e08e 3906 mon_cmd($vmid, "object-del", id => $objectid);
4d3f29ed
AD
3907
3908 return 1;
3909}
3910
5e5dcb73 3911sub qemu_driveadd {
fee46675 3912 my ($storecfg, $vmid, $device) = @_;
5e5dcb73 3913
776c5f50 3914 my $drive = print_drive_commandline_full($storecfg, $vmid, $device);
7a69fc3c 3915 $drive =~ s/\\/\\\\/g;
0a13e08e 3916 my $ret = PVE::QemuServer::Monitor::hmp_cmd($vmid, "drive_add auto \"$drive\"");
fee46675 3917
5e5dcb73 3918 # If the command succeeds qemu prints: "OK"
fee46675
DM
3919 return 1 if $ret =~ m/OK/s;
3920
3921 die "adding drive failed: $ret\n";
5e5dcb73 3922}
afdb31d5 3923
5e5dcb73
DA
3924sub qemu_drivedel {
3925 my($vmid, $deviceid) = @_;
873c2d69 3926
0a13e08e 3927 my $ret = PVE::QemuServer::Monitor::hmp_cmd($vmid, "drive_del drive-$deviceid");
5e5dcb73 3928 $ret =~ s/^\s+//;
a1b7d579 3929
63c2da2f 3930 return 1 if $ret eq "";
a1b7d579 3931
63c2da2f 3932 # NB: device not found errors mean the drive was auto-deleted and we ignore the error
a1b7d579
DM
3933 return 1 if $ret =~ m/Device \'.*?\' not found/s;
3934
63c2da2f 3935 die "deleting drive $deviceid failed : $ret\n";
5e5dcb73 3936}
f19d1c47 3937
5e5dcb73 3938sub qemu_deviceaddverify {
fee46675 3939 my ($vmid, $deviceid) = @_;
873c2d69 3940
5e5dcb73
DA
3941 for (my $i = 0; $i <= 5; $i++) {
3942 my $devices_list = vm_devices_list($vmid);
3943 return 1 if defined($devices_list->{$deviceid});
3944 sleep 1;
afdb31d5 3945 }
fee46675
DM
3946
3947 die "error on hotplug device '$deviceid'\n";
5e5dcb73 3948}
afdb31d5 3949
5e5dcb73
DA
3950
3951sub qemu_devicedelverify {
63c2da2f
DM
3952 my ($vmid, $deviceid) = @_;
3953
a1b7d579 3954 # need to verify that the device is correctly removed as device_del
63c2da2f 3955 # is async and empty return is not reliable
5e5dcb73 3956
5e5dcb73
DA
3957 for (my $i = 0; $i <= 5; $i++) {
3958 my $devices_list = vm_devices_list($vmid);
3959 return 1 if !defined($devices_list->{$deviceid});
3960 sleep 1;
afdb31d5 3961 }
63c2da2f
DM
3962
3963 die "error on hot-unplugging device '$deviceid'\n";
873c2d69
DA
3964}
3965
cdd20088 3966sub qemu_findorcreatescsihw {
d559309f 3967 my ($storecfg, $conf, $vmid, $device, $arch, $machine_type) = @_;
cfc817c7 3968
ee034f5c 3969 my ($maxdev, $controller, $controller_prefix) = scsihw_infos($conf, $device);
2733141c
AD
3970
3971 my $scsihwid="$controller_prefix$controller";
cfc817c7
DA
3972 my $devices_list = vm_devices_list($vmid);
3973
cdd20088 3974 if(!defined($devices_list->{$scsihwid})) {
d559309f 3975 vm_deviceplug($storecfg, $conf, $vmid, $scsihwid, $device, $arch, $machine_type);
cfc817c7 3976 }
fee46675 3977
cfc817c7
DA
3978 return 1;
3979}
3980
8ce30dde
AD
3981sub qemu_deletescsihw {
3982 my ($conf, $vmid, $opt) = @_;
3983
3984 my $device = parse_drive($opt, $conf->{$opt});
3985
a1511b3c 3986 if ($conf->{scsihw} && ($conf->{scsihw} eq 'virtio-scsi-single')) {
2733141c
AD
3987 vm_deviceunplug($vmid, $conf, "virtioscsi$device->{index}");
3988 return 1;
3989 }
3990
ee034f5c 3991 my ($maxdev, $controller, $controller_prefix) = scsihw_infos($conf, $device);
8ce30dde
AD
3992
3993 my $devices_list = vm_devices_list($vmid);
3994 foreach my $opt (keys %{$devices_list}) {
e0fd2b2f
FE
3995 if (is_valid_drivename($opt)) {
3996 my $drive = parse_drive($opt, $conf->{$opt});
8ce30dde
AD
3997 if($drive->{interface} eq 'scsi' && $drive->{index} < (($maxdev-1)*($controller+1))) {
3998 return 1;
3999 }
4000 }
4001 }
4002
4003 my $scsihwid="scsihw$controller";
4004
4005 vm_deviceunplug($vmid, $conf, $scsihwid);
4006
4007 return 1;
4008}
4009
281fedb3 4010sub qemu_add_pci_bridge {
d559309f 4011 my ($storecfg, $conf, $vmid, $device, $arch, $machine_type) = @_;
40f28a9f
AD
4012
4013 my $bridges = {};
281fedb3
DM
4014
4015 my $bridgeid;
4016
d559309f 4017 print_pci_addr($device, $bridges, $arch, $machine_type);
40f28a9f
AD
4018
4019 while (my ($k, $v) = each %$bridges) {
4020 $bridgeid = $k;
4021 }
fee46675 4022 return 1 if !defined($bridgeid) || $bridgeid < 1;
281fedb3 4023
40f28a9f
AD
4024 my $bridge = "pci.$bridgeid";
4025 my $devices_list = vm_devices_list($vmid);
4026
281fedb3 4027 if (!defined($devices_list->{$bridge})) {
d559309f 4028 vm_deviceplug($storecfg, $conf, $vmid, $bridge, $arch, $machine_type);
40f28a9f 4029 }
281fedb3 4030
40f28a9f
AD
4031 return 1;
4032}
4033
25088687
DM
4034sub qemu_set_link_status {
4035 my ($vmid, $device, $up) = @_;
4036
0a13e08e 4037 mon_cmd($vmid, "set_link", name => $device,
25088687
DM
4038 up => $up ? JSON::true : JSON::false);
4039}
4040
2630d2a9 4041sub qemu_netdevadd {
d559309f 4042 my ($vmid, $conf, $arch, $device, $deviceid) = @_;
2630d2a9 4043
d559309f 4044 my $netdev = print_netdev_full($vmid, $conf, $arch, $device, $deviceid, 1);
73aa03b8 4045 my %options = split(/[=,]/, $netdev);
2630d2a9 4046
bf5aef9b
DC
4047 if (defined(my $vhost = $options{vhost})) {
4048 $options{vhost} = JSON::boolean(PVE::JSONSchema::parse_boolean($vhost));
4049 }
4050
4051 if (defined(my $queues = $options{queues})) {
4052 $options{queues} = $queues + 0;
4053 }
4054
0a13e08e 4055 mon_cmd($vmid, "netdev_add", %options);
73aa03b8 4056 return 1;
2630d2a9
DA
4057}
4058
4059sub qemu_netdevdel {
4060 my ($vmid, $deviceid) = @_;
4061
0a13e08e 4062 mon_cmd($vmid, "netdev_del", id => $deviceid);
2630d2a9
DA
4063}
4064
16521d63 4065sub qemu_usb_hotplug {
d559309f 4066 my ($storecfg, $conf, $vmid, $deviceid, $device, $arch, $machine_type) = @_;
16521d63
DC
4067
4068 return if !$device;
4069
4070 # remove the old one first
4071 vm_deviceunplug($vmid, $conf, $deviceid);
4072
4073 # check if xhci controller is necessary and available
4074 if ($device->{usb3}) {
4075
4076 my $devicelist = vm_devices_list($vmid);
4077
4078 if (!$devicelist->{xhci}) {
d559309f 4079 my $pciaddr = print_pci_addr("xhci", undef, $arch, $machine_type);
16521d63
DC
4080 qemu_deviceadd($vmid, "nec-usb-xhci,id=xhci$pciaddr");
4081 }
4082 }
4083 my $d = parse_usb_device($device->{host});
4084 $d->{usb3} = $device->{usb3};
4085
4086 # add the new one
d559309f 4087 vm_deviceplug($storecfg, $conf, $vmid, $deviceid, $d, $arch, $machine_type);
16521d63
DC
4088}
4089
838776ab 4090sub qemu_cpu_hotplug {
8edc9c08 4091 my ($vmid, $conf, $vcpus) = @_;
838776ab 4092
3392d6ca 4093 my $machine_type = PVE::QemuServer::Machine::get_current_qemu_machine($vmid);
1e881b75 4094
8edc9c08
AD
4095 my $sockets = 1;
4096 $sockets = $conf->{smp} if $conf->{smp}; # old style - no longer iused
4097 $sockets = $conf->{sockets} if $conf->{sockets};
4098 my $cores = $conf->{cores} || 1;
4099 my $maxcpus = $sockets * $cores;
838776ab 4100
8edc9c08 4101 $vcpus = $maxcpus if !$vcpus;
3a11fadb 4102
8edc9c08
AD
4103 die "you can't add more vcpus than maxcpus\n"
4104 if $vcpus > $maxcpus;
3a11fadb 4105
8edc9c08 4106 my $currentvcpus = $conf->{vcpus} || $maxcpus;
1e881b75 4107
eba3e64d 4108 if ($vcpus < $currentvcpus) {
1e881b75 4109
2ea5fb7e 4110 if (PVE::QemuServer::Machine::machine_version($machine_type, 2, 7)) {
1e881b75
AD
4111
4112 for (my $i = $currentvcpus; $i > $vcpus; $i--) {
4113 qemu_devicedel($vmid, "cpu$i");
4114 my $retry = 0;
4115 my $currentrunningvcpus = undef;
4116 while (1) {
65af8c31 4117 $currentrunningvcpus = mon_cmd($vmid, "query-cpus-fast");
1e881b75 4118 last if scalar(@{$currentrunningvcpus}) == $i-1;
961af8a3 4119 raise_param_exc({ vcpus => "error unplugging cpu$i" }) if $retry > 5;
1e881b75
AD
4120 $retry++;
4121 sleep 1;
4122 }
4123 #update conf after each succesfull cpu unplug
4124 $conf->{vcpus} = scalar(@{$currentrunningvcpus});
4125 PVE::QemuConfig->write_config($vmid, $conf);
4126 }
4127 } else {
961af8a3 4128 die "cpu hot-unplugging requires qemu version 2.7 or higher\n";
1e881b75
AD
4129 }
4130
4131 return;
4132 }
838776ab 4133
65af8c31 4134 my $currentrunningvcpus = mon_cmd($vmid, "query-cpus-fast");
961af8a3 4135 die "vcpus in running vm does not match its configuration\n"
8edc9c08 4136 if scalar(@{$currentrunningvcpus}) != $currentvcpus;
838776ab 4137
2ea5fb7e 4138 if (PVE::QemuServer::Machine::machine_version($machine_type, 2, 7)) {
eba3e64d
AD
4139
4140 for (my $i = $currentvcpus+1; $i <= $vcpus; $i++) {
4141 my $cpustr = print_cpu_device($conf, $i);
4142 qemu_deviceadd($vmid, $cpustr);
4143
4144 my $retry = 0;
4145 my $currentrunningvcpus = undef;
4146 while (1) {
65af8c31 4147 $currentrunningvcpus = mon_cmd($vmid, "query-cpus-fast");
eba3e64d 4148 last if scalar(@{$currentrunningvcpus}) == $i;
961af8a3 4149 raise_param_exc({ vcpus => "error hotplugging cpu$i" }) if $retry > 10;
eba3e64d
AD
4150 sleep 1;
4151 $retry++;
4152 }
4153 #update conf after each succesfull cpu hotplug
4154 $conf->{vcpus} = scalar(@{$currentrunningvcpus});
4155 PVE::QemuConfig->write_config($vmid, $conf);
4156 }
4157 } else {
4158
4159 for (my $i = $currentvcpus; $i < $vcpus; $i++) {
0a13e08e 4160 mon_cmd($vmid, "cpu-add", id => int($i));
eba3e64d 4161 }
838776ab
AD
4162 }
4163}
4164
affd2f88 4165sub qemu_block_set_io_throttle {
277ca170
WB
4166 my ($vmid, $deviceid,
4167 $bps, $bps_rd, $bps_wr, $iops, $iops_rd, $iops_wr,
9196a8ec
WB
4168 $bps_max, $bps_rd_max, $bps_wr_max, $iops_max, $iops_rd_max, $iops_wr_max,
4169 $bps_max_length, $bps_rd_max_length, $bps_wr_max_length,
4170 $iops_max_length, $iops_rd_max_length, $iops_wr_max_length) = @_;
affd2f88 4171
f3f323a3
AD
4172 return if !check_running($vmid) ;
4173
0a13e08e 4174 mon_cmd($vmid, "block_set_io_throttle", device => $deviceid,
277ca170
WB
4175 bps => int($bps),
4176 bps_rd => int($bps_rd),
4177 bps_wr => int($bps_wr),
4178 iops => int($iops),
4179 iops_rd => int($iops_rd),
4180 iops_wr => int($iops_wr),
4181 bps_max => int($bps_max),
4182 bps_rd_max => int($bps_rd_max),
4183 bps_wr_max => int($bps_wr_max),
4184 iops_max => int($iops_max),
4185 iops_rd_max => int($iops_rd_max),
9196a8ec
WB
4186 iops_wr_max => int($iops_wr_max),
4187 bps_max_length => int($bps_max_length),
4188 bps_rd_max_length => int($bps_rd_max_length),
4189 bps_wr_max_length => int($bps_wr_max_length),
4190 iops_max_length => int($iops_max_length),
4191 iops_rd_max_length => int($iops_rd_max_length),
4192 iops_wr_max_length => int($iops_wr_max_length),
277ca170 4193 );
f3f323a3 4194
affd2f88
AD
4195}
4196
c1175c92
AD
4197sub qemu_block_resize {
4198 my ($vmid, $deviceid, $storecfg, $volid, $size) = @_;
4199
ed221350 4200 my $running = check_running($vmid);
c1175c92 4201
7246e8f9 4202 $size = 0 if !PVE::Storage::volume_resize($storecfg, $volid, $size, $running);
c1175c92
AD
4203
4204 return if !$running;
4205
375db731
FE
4206 my $padding = (1024 - $size % 1024) % 1024;
4207 $size = $size + $padding;
4208
0a13e08e 4209 mon_cmd($vmid, "block_resize", device => $deviceid, size => int($size));
c1175c92
AD
4210
4211}
4212
1ab0057c
AD
4213sub qemu_volume_snapshot {
4214 my ($vmid, $deviceid, $storecfg, $volid, $snap) = @_;
4215
ed221350 4216 my $running = check_running($vmid);
1ab0057c 4217
e5eaa028 4218 if ($running && do_snapshots_with_qemu($storecfg, $volid)){
0a13e08e 4219 mon_cmd($vmid, 'blockdev-snapshot-internal-sync', device => $deviceid, name => $snap);
e5eaa028
WL
4220 } else {
4221 PVE::Storage::volume_snapshot($storecfg, $volid, $snap);
4222 }
1ab0057c
AD
4223}
4224
fc46aff9
AD
4225sub qemu_volume_snapshot_delete {
4226 my ($vmid, $deviceid, $storecfg, $volid, $snap) = @_;
4227
ed221350 4228 my $running = check_running($vmid);
fc46aff9 4229
a2f1554b
AD
4230 if($running) {
4231
4232 $running = undef;
4233 my $conf = PVE::QemuConfig->load_config($vmid);
912792e2 4234 PVE::QemuConfig->foreach_volume($conf, sub {
a2f1554b
AD
4235 my ($ds, $drive) = @_;
4236 $running = 1 if $drive->{file} eq $volid;
4237 });
4238 }
4239
1ef7592f 4240 if ($running && do_snapshots_with_qemu($storecfg, $volid)){
0a13e08e 4241 mon_cmd($vmid, 'blockdev-snapshot-delete-internal-sync', device => $deviceid, name => $snap);
1ef7592f
AD
4242 } else {
4243 PVE::Storage::volume_snapshot_delete($storecfg, $volid, $snap, $running);
4244 }
fc46aff9
AD
4245}
4246
264e519f
DM
4247sub set_migration_caps {
4248 my ($vmid) = @_;
a89fded1 4249
acc10e51
SR
4250 my $qemu_support = eval { mon_cmd($vmid, "query-proxmox-support") };
4251
8b8345f3 4252 my $cap_ref = [];
a89fded1
AD
4253
4254 my $enabled_cap = {
8b8345f3 4255 "auto-converge" => 1,
0b0a47e8 4256 "xbzrle" => 1,
8b8345f3
DM
4257 "x-rdma-pin-all" => 0,
4258 "zero-blocks" => 0,
acc10e51
SR
4259 "compress" => 0,
4260 "dirty-bitmaps" => $qemu_support->{'pbs-dirty-bitmap-migration'} ? 1 : 0,
a89fded1
AD
4261 };
4262
0a13e08e 4263 my $supported_capabilities = mon_cmd($vmid, "query-migrate-capabilities");
a89fded1 4264
8b8345f3 4265 for my $supported_capability (@$supported_capabilities) {
b463a3ce
SP
4266 push @$cap_ref, {
4267 capability => $supported_capability->{capability},
22430fa2
DM
4268 state => $enabled_cap->{$supported_capability->{capability}} ? JSON::true : JSON::false,
4269 };
a89fded1
AD
4270 }
4271
0a13e08e 4272 mon_cmd($vmid, "migrate-set-capabilities", capabilities => $cap_ref);
8b8345f3 4273}
a89fded1 4274
912792e2
FE
4275sub foreach_volid {
4276 my ($conf, $func, @param) = @_;
4277
4278 my $volhash = {};
4279
4280 my $test_volid = sub {
ae180b8f 4281 my ($key, $drive, $snapname) = @_;
912792e2 4282
ae180b8f 4283 my $volid = $drive->{file};
912792e2
FE
4284 return if !$volid;
4285
4286 $volhash->{$volid}->{cdrom} //= 1;
ae180b8f 4287 $volhash->{$volid}->{cdrom} = 0 if !drive_is_cdrom($drive);
912792e2 4288
ae180b8f 4289 my $replicate = $drive->{replicate} // 1;
912792e2
FE
4290 $volhash->{$volid}->{replicate} //= 0;
4291 $volhash->{$volid}->{replicate} = 1 if $replicate;
4292
4293 $volhash->{$volid}->{shared} //= 0;
ae180b8f 4294 $volhash->{$volid}->{shared} = 1 if $drive->{shared};
912792e2
FE
4295
4296 $volhash->{$volid}->{referenced_in_config} //= 0;
4297 $volhash->{$volid}->{referenced_in_config} = 1 if !defined($snapname);
4298
4299 $volhash->{$volid}->{referenced_in_snapshot}->{$snapname} = 1
4300 if defined($snapname);
ae180b8f
FE
4301
4302 my $size = $drive->{size};
4303 $volhash->{$volid}->{size} //= $size if $size;
4304
4305 $volhash->{$volid}->{is_vmstate} //= 0;
4306 $volhash->{$volid}->{is_vmstate} = 1 if $key eq 'vmstate';
4307
4308 $volhash->{$volid}->{is_unused} //= 0;
4309 $volhash->{$volid}->{is_unused} = 1 if $key =~ /^unused\d+$/;
912792e2
FE
4310 };
4311
ae180b8f
FE
4312 my $include_opts = {
4313 extra_keys => ['vmstate'],
4314 include_unused => 1,
4315 };
4316
0b953b8e 4317 PVE::QemuConfig->foreach_volume_full($conf, $include_opts, $test_volid);
912792e2
FE
4318 foreach my $snapname (keys %{$conf->{snapshots}}) {
4319 my $snap = $conf->{snapshots}->{$snapname};
0b953b8e 4320 PVE::QemuConfig->foreach_volume_full($snap, $include_opts, $test_volid, $snapname);
912792e2
FE
4321 }
4322
4323 foreach my $volid (keys %$volhash) {
4324 &$func($volid, $volhash->{$volid}, @param);
4325 }
4326}
4327
81d95ae1 4328my $fast_plug_option = {
7498eb64 4329 'lock' => 1,
81d95ae1 4330 'name' => 1,
a1b7d579 4331 'onboot' => 1,
81d95ae1
DM
4332 'shares' => 1,
4333 'startup' => 1,
b0ec896e 4334 'description' => 1,
ec647db4 4335 'protection' => 1,
8cad5e9b 4336 'vmstatestorage' => 1,
9e784b11 4337 'hookscript' => 1,
b8e7068a 4338 'tags' => 1,
81d95ae1
DM
4339};
4340
3a11fadb
DM
4341# hotplug changes in [PENDING]
4342# $selection hash can be used to only apply specified options, for
4343# example: { cores => 1 } (only apply changed 'cores')
4344# $errors ref is used to return error messages
c427973b 4345sub vmconfig_hotplug_pending {
3a11fadb 4346 my ($vmid, $conf, $storecfg, $selection, $errors) = @_;
c427973b 4347
8e90138a 4348 my $defaults = load_defaults();
045749f2
TL
4349 my $arch = get_vm_arch($conf);
4350 my $machine_type = get_vm_machine($conf, undef, $arch);
c427973b
DM
4351
4352 # commit values which do not have any impact on running VM first
3a11fadb
DM
4353 # Note: those option cannot raise errors, we we do not care about
4354 # $selection and always apply them.
4355
4356 my $add_error = sub {
4357 my ($opt, $msg) = @_;
4358 $errors->{$opt} = "hotplug problem - $msg";
4359 };
c427973b
DM
4360
4361 my $changes = 0;
4362 foreach my $opt (keys %{$conf->{pending}}) { # add/change
81d95ae1 4363 if ($fast_plug_option->{$opt}) {
c427973b
DM
4364 $conf->{$opt} = $conf->{pending}->{$opt};
4365 delete $conf->{pending}->{$opt};
4366 $changes = 1;
4367 }
4368 }
4369
4370 if ($changes) {
ffda963f 4371 PVE::QemuConfig->write_config($vmid, $conf);
c427973b
DM
4372 }
4373
b3c2bdd1 4374 my $hotplug_features = parse_hotplug_features(defined($conf->{hotplug}) ? $conf->{hotplug} : '1');
c427973b 4375
98bc3aeb 4376 my $pending_delete_hash = PVE::QemuConfig->parse_pending_delete($conf->{pending}->{delete});
d321c4a9 4377 foreach my $opt (sort keys %$pending_delete_hash) {
3a11fadb 4378 next if $selection && !$selection->{$opt};
d321c4a9 4379 my $force = $pending_delete_hash->{$opt}->{force};
3a11fadb 4380 eval {
51a6f637
AD
4381 if ($opt eq 'hotplug') {
4382 die "skip\n" if ($conf->{hotplug} =~ /memory/);
4383 } elsif ($opt eq 'tablet') {
b3c2bdd1 4384 die "skip\n" if !$hotplug_features->{usb};
3a11fadb 4385 if ($defaults->{tablet}) {
d559309f
WB
4386 vm_deviceplug($storecfg, $conf, $vmid, 'tablet', $arch, $machine_type);
4387 vm_deviceplug($storecfg, $conf, $vmid, 'keyboard', $arch, $machine_type)
4388 if $arch eq 'aarch64';
3a11fadb 4389 } else {
d559309f
WB
4390 vm_deviceunplug($vmid, $conf, 'tablet');
4391 vm_deviceunplug($vmid, $conf, 'keyboard') if $arch eq 'aarch64';
3a11fadb 4392 }
4eb68604 4393 } elsif ($opt =~ m/^usb\d+/) {
f745762b 4394 die "skip\n";
50bbe377
TL
4395 # since we cannot reliably hot unplug usb devices we are disabling it
4396 #die "skip\n" if !$hotplug_features->{usb} || $conf->{$opt} =~ m/spice/i;
4397 #vm_deviceunplug($vmid, $conf, $opt);
8edc9c08 4398 } elsif ($opt eq 'vcpus') {
b3c2bdd1 4399 die "skip\n" if !$hotplug_features->{cpu};
8edc9c08 4400 qemu_cpu_hotplug($vmid, $conf, undef);
9c2f7069 4401 } elsif ($opt eq 'balloon') {
81d95ae1 4402 # enable balloon device is not hotpluggable
75b51053
DC
4403 die "skip\n" if defined($conf->{balloon}) && $conf->{balloon} == 0;
4404 # here we reset the ballooning value to memory
4405 my $balloon = $conf->{memory} || $defaults->{memory};
0a13e08e 4406 mon_cmd($vmid, "balloon", value => $balloon*1024*1024);
81d95ae1
DM
4407 } elsif ($fast_plug_option->{$opt}) {
4408 # do nothing
3eec5767 4409 } elsif ($opt =~ m/^net(\d+)$/) {
b3c2bdd1 4410 die "skip\n" if !$hotplug_features->{network};
3eec5767 4411 vm_deviceunplug($vmid, $conf, $opt);
74479ee9 4412 } elsif (is_valid_drivename($opt)) {
b3c2bdd1 4413 die "skip\n" if !$hotplug_features->{disk} || $opt =~ m/(ide|sata)(\d+)/;
19120f99 4414 vm_deviceunplug($vmid, $conf, $opt);
3dc38fbb 4415 vmconfig_delete_or_detach_drive($vmid, $storecfg, $conf, $opt, $force);
4d3f29ed
AD
4416 } elsif ($opt =~ m/^memory$/) {
4417 die "skip\n" if !$hotplug_features->{memory};
6779f1ac 4418 PVE::QemuServer::Memory::qemu_memory_hotplug($vmid, $conf, $defaults, $opt);
c8effec3
AD
4419 } elsif ($opt eq 'cpuunits') {
4420 cgroups_write("cpu", $vmid, "cpu.shares", $defaults->{cpuunits});
58be00f1
AD
4421 } elsif ($opt eq 'cpulimit') {
4422 cgroups_write("cpu", $vmid, "cpu.cfs_quota_us", -1);
3d7389fe 4423 } else {
e56beeda 4424 die "skip\n";
3d7389fe 4425 }
3a11fadb
DM
4426 };
4427 if (my $err = $@) {
e56beeda
DM
4428 &$add_error($opt, $err) if $err ne "skip\n";
4429 } else {
3a11fadb 4430 delete $conf->{$opt};
98bc3aeb 4431 PVE::QemuConfig->remove_from_pending_delete($conf, $opt);
3d7389fe 4432 }
3d7389fe
DM
4433 }
4434
e5a66e48 4435 my ($apply_pending_cloudinit, $apply_pending_cloudinit_done);
9ed7a77c 4436 $apply_pending_cloudinit = sub {
e5a66e48
WB
4437 return if $apply_pending_cloudinit_done; # once is enough
4438 $apply_pending_cloudinit_done = 1; # once is enough
4439
9ed7a77c 4440 my ($key, $value) = @_;
9ed7a77c
WB
4441
4442 my @cloudinit_opts = keys %$confdesc_cloudinit;
4443 foreach my $opt (keys %{$conf->{pending}}) {
4444 next if !grep { $_ eq $opt } @cloudinit_opts;
4445 $conf->{$opt} = delete $conf->{pending}->{$opt};
4446 }
4447
4448 my $new_conf = { %$conf };
4449 $new_conf->{$key} = $value;
4450 PVE::QemuServer::Cloudinit::generate_cloudinitconfig($new_conf, $vmid);
4451 };
4452
3d7389fe 4453 foreach my $opt (keys %{$conf->{pending}}) {
3a11fadb 4454 next if $selection && !$selection->{$opt};
3d7389fe 4455 my $value = $conf->{pending}->{$opt};
3a11fadb 4456 eval {
51a6f637
AD
4457 if ($opt eq 'hotplug') {
4458 die "skip\n" if ($value =~ /memory/) || ($value !~ /memory/ && $conf->{hotplug} =~ /memory/);
4459 } elsif ($opt eq 'tablet') {
b3c2bdd1 4460 die "skip\n" if !$hotplug_features->{usb};
3a11fadb 4461 if ($value == 1) {
d559309f
WB
4462 vm_deviceplug($storecfg, $conf, $vmid, 'tablet', $arch, $machine_type);
4463 vm_deviceplug($storecfg, $conf, $vmid, 'keyboard', $arch, $machine_type)
4464 if $arch eq 'aarch64';
3a11fadb 4465 } elsif ($value == 0) {
d559309f
WB
4466 vm_deviceunplug($vmid, $conf, 'tablet');
4467 vm_deviceunplug($vmid, $conf, 'keyboard') if $arch eq 'aarch64';
3a11fadb 4468 }
4eb68604 4469 } elsif ($opt =~ m/^usb\d+$/) {
f745762b 4470 die "skip\n";
50bbe377
TL
4471 # since we cannot reliably hot unplug usb devices we disable it for now
4472 #die "skip\n" if !$hotplug_features->{usb} || $value =~ m/spice/i;
4473 #my $d = eval { parse_property_string($usbdesc->{format}, $value) };
4474 #die "skip\n" if !$d;
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 {
50bbe377 5038 die "can't unbind/bind PCI group to VFIO '$pciid'\n"
3898a563 5039 if !PVE::SysFSTools::pci_dev_group_bind_to_vfio($pciid);
50bbe377
TL
5040 die "can't reset PCI device '$pciid'\n"
5041 if $info->{has_fl_reset} && !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;
808a65b5 6247 my $openfifo = sub { open($fifofh, '>', $mapfifo) or die $! };
91bd6c90 6248
7c536e11 6249 $add_pipe->(['vma', 'extract', '-v', '-r', $mapfifo, $readfrom, $tmpdir]);
91bd6c90
DM
6250
6251 my $oldtimeout;
6252 my $timeout = 5;
6253
6254 my $devinfo = {};
6255
6256 my $rpcenv = PVE::RPCEnvironment::get();
6257
ffda963f 6258 my $conffile = PVE::QemuConfig->config_file($vmid);
91bd6c90
DM
6259 my $tmpfn = "$conffile.$$.tmp";
6260
ae200950 6261 # Note: $oldconf is undef if VM does not exist
ffda963f
FG
6262 my $cfs_path = PVE::QemuConfig->cfs_config_path($vmid);
6263 my $oldconf = PVE::Cluster::cfs_read_file($cfs_path);
ed221350 6264
7c536e11
WB
6265 my %storage_limits;
6266
91bd6c90 6267 my $print_devmap = sub {
91bd6c90
DM
6268 my $cfgfn = "$tmpdir/qemu-server.conf";
6269
6270 # we can read the config - that is already extracted
6271 my $fh = IO::File->new($cfgfn, "r") ||
a1cbe55c 6272 die "unable to read qemu-server.conf - $!\n";
91bd6c90 6273
6738ab9c 6274 my $fwcfgfn = "$tmpdir/qemu-server.fw";
3457d090
WL
6275 if (-f $fwcfgfn) {
6276 my $pve_firewall_dir = '/etc/pve/firewall';
6277 mkdir $pve_firewall_dir; # make sure the dir exists
6278 PVE::Tools::file_copy($fwcfgfn, "${pve_firewall_dir}/$vmid.fw");
6279 }
6738ab9c 6280
9f3d73bc 6281 my $virtdev_hash = $parse_backup_hints->($rpcenv, $user, $cfg, $fh, $devinfo, $opts);
91bd6c90 6282
7c536e11
WB
6283 foreach my $key (keys %storage_limits) {
6284 my $limit = PVE::Storage::get_bandwidth_limit('restore', [$key], $bwlimit);
6285 next if !$limit;
6286 print STDERR "rate limit for storage $key: $limit KiB/s\n";
6287 $storage_limits{$key} = $limit * 1024;
6288 }
6289
91bd6c90 6290 foreach my $devname (keys %$devinfo) {
be190583
DM
6291 die "found no device mapping information for device '$devname'\n"
6292 if !$devinfo->{$devname}->{virtdev};
91bd6c90
DM
6293 }
6294
ed221350 6295 # create empty/temp config
be190583 6296 if ($oldconf) {
ed221350 6297 PVE::Tools::file_set_contents($conffile, "memory: 128\n");
d1e92cf6 6298 $restore_cleanup_oldconf->($cfg, $vmid, $oldconf, $virtdev_hash);
ed221350
DM
6299 }
6300
9f3d73bc
DM
6301 # allocate volumes
6302 my $map = $restore_allocate_devices->($cfg, $virtdev_hash, $vmid);
6303
6304 # print restore information to $fifofh
91bd6c90
DM
6305 foreach my $virtdev (sort keys %$virtdev_hash) {
6306 my $d = $virtdev_hash->{$virtdev};
9f3d73bc
DM
6307 next if $d->{is_cloudinit}; # no need to restore cloudinit
6308
7c536e11 6309 my $storeid = $d->{storeid};
9f3d73bc 6310 my $volid = $d->{volid};
7c536e11
WB
6311
6312 my $map_opts = '';
6313 if (my $limit = $storage_limits{$storeid}) {
6314 $map_opts .= "throttling.bps=$limit:throttling.group=$storeid:";
6315 }
8fd57431 6316
91bd6c90 6317 my $write_zeros = 1;
88240a83 6318 if (PVE::Storage::volume_has_feature($cfg, 'sparseinit', $volid)) {
91bd6c90
DM
6319 $write_zeros = 0;
6320 }
6321
9f3d73bc 6322 my $path = PVE::Storage::path($cfg, $volid);
87056e18 6323
9f3d73bc 6324 print $fifofh "${map_opts}format=$d->{format}:${write_zeros}:$d->{devname}=$path\n";
91bd6c90 6325
9f3d73bc 6326 print "map '$d->{devname}' to '$path' (write zeros = ${write_zeros})\n";
91bd6c90
DM
6327 }
6328
6329 $fh->seek(0, 0) || die "seek failed - $!\n";
6330
f7d1505b 6331 my $outfd = IO::File->new($tmpfn, "w") || die "unable to write config for VM $vmid\n";
91bd6c90
DM
6332
6333 my $cookie = { netcount => 0 };
6334 while (defined(my $line = <$fh>)) {
9f3d73bc 6335 $restore_update_config_line->($outfd, $cookie, $vmid, $map, $line, $opts->{unique});
91bd6c90
DM
6336 }
6337
6338 $fh->close();
6339 $outfd->close();
6340 };
6341
6342 eval {
6343 # enable interrupts
6cb0144a
EK
6344 local $SIG{INT} =
6345 local $SIG{TERM} =
6346 local $SIG{QUIT} =
6347 local $SIG{HUP} =
6348 local $SIG{PIPE} = sub { die "interrupted by signal\n"; };
91bd6c90
DM
6349 local $SIG{ALRM} = sub { die "got timeout\n"; };
6350
6351 $oldtimeout = alarm($timeout);
6352
6353 my $parser = sub {
6354 my $line = shift;
6355
6356 print "$line\n";
6357
6358 if ($line =~ m/^DEV:\sdev_id=(\d+)\ssize:\s(\d+)\sdevname:\s(\S+)$/) {
6359 my ($dev_id, $size, $devname) = ($1, $2, $3);
6360 $devinfo->{$devname} = { size => $size, dev_id => $dev_id };
6361 } elsif ($line =~ m/^CTIME: /) {
46f58b5f 6362 # we correctly received the vma config, so we can disable
3cf90d7a
DM
6363 # the timeout now for disk allocation (set to 10 minutes, so
6364 # that we always timeout if something goes wrong)
6365 alarm(600);
91bd6c90
DM
6366 &$print_devmap();
6367 print $fifofh "done\n";
6368 my $tmp = $oldtimeout || 0;
6369 $oldtimeout = undef;
6370 alarm($tmp);
6371 close($fifofh);
808a65b5 6372 $fifofh = undef;
91bd6c90
DM
6373 }
6374 };
be190583 6375
7c536e11
WB
6376 print "restore vma archive: $dbg_cmdstring\n";
6377 run_command($commands, input => $input, outfunc => $parser, afterfork => $openfifo);
91bd6c90
DM
6378 };
6379 my $err = $@;
6380
6381 alarm($oldtimeout) if $oldtimeout;
6382
9f3d73bc 6383 $restore_deactivate_volumes->($cfg, $devinfo);
5f96f4df 6384
808a65b5 6385 close($fifofh) if $fifofh;
91bd6c90 6386 unlink $mapfifo;
9f3d73bc 6387 rmtree $tmpdir;
91bd6c90
DM
6388
6389 if ($err) {
91bd6c90 6390 unlink $tmpfn;
9f3d73bc 6391 $restore_destroy_volumes->($cfg, $devinfo);
91bd6c90
DM
6392 die $err;
6393 }
6394
ed221350 6395 rename($tmpfn, $conffile) ||
91bd6c90
DM
6396 die "unable to commit configuration file '$conffile'\n";
6397
ed221350
DM
6398 PVE::Cluster::cfs_update(); # make sure we read new file
6399
91bd6c90
DM
6400 eval { rescan($vmid, 1); };
6401 warn $@ if $@;
6402}
6403
6404sub restore_tar_archive {
6405 my ($archive, $vmid, $user, $opts) = @_;
6406
9c502e26 6407 if ($archive ne '-') {
ed221350 6408 my $firstfile = tar_archive_read_firstfile($archive);
32e54050 6409 die "ERROR: file '$archive' does not look like a QemuServer vzdump backup\n"
9c502e26
DM
6410 if $firstfile ne 'qemu-server.conf';
6411 }
3e16d5fc 6412
20519efc 6413 my $storecfg = PVE::Storage::config();
ebb55558 6414
4b026937
TL
6415 # avoid zombie disks when restoring over an existing VM -> cleanup first
6416 # pass keep_empty_config=1 to keep the config (thus VMID) reserved for us
6417 # skiplock=1 because qmrestore has set the 'create' lock itself already
ffda963f 6418 my $vmcfgfn = PVE::QemuConfig->config_file($vmid);
b04ea584 6419 destroy_vm($storecfg, $vmid, 1, { lock => 'restore' }) if -f $vmcfgfn;
ed221350 6420
3e16d5fc
DM
6421 my $tocmd = "/usr/lib/qemu-server/qmextract";
6422
2415a446 6423 $tocmd .= " --storage " . PVE::Tools::shellquote($opts->{storage}) if $opts->{storage};
a0d1b1a2 6424 $tocmd .= " --pool " . PVE::Tools::shellquote($opts->{pool}) if $opts->{pool};
3e16d5fc
DM
6425 $tocmd .= ' --prealloc' if $opts->{prealloc};
6426 $tocmd .= ' --info' if $opts->{info};
6427
a0d1b1a2 6428 # tar option "xf" does not autodetect compression when read from STDIN,
9c502e26 6429 # so we pipe to zcat
2415a446
DM
6430 my $cmd = "zcat -f|tar xf " . PVE::Tools::shellquote($archive) . " " .
6431 PVE::Tools::shellquote("--to-command=$tocmd");
3e16d5fc
DM
6432
6433 my $tmpdir = "/var/tmp/vzdumptmp$$";
6434 mkpath $tmpdir;
6435
6436 local $ENV{VZDUMP_TMPDIR} = $tmpdir;
6437 local $ENV{VZDUMP_VMID} = $vmid;
a0d1b1a2 6438 local $ENV{VZDUMP_USER} = $user;
3e16d5fc 6439
ffda963f 6440 my $conffile = PVE::QemuConfig->config_file($vmid);
3e16d5fc
DM
6441 my $tmpfn = "$conffile.$$.tmp";
6442
6443 # disable interrupts (always do cleanups)
6cb0144a
EK
6444 local $SIG{INT} =
6445 local $SIG{TERM} =
6446 local $SIG{QUIT} =
6447 local $SIG{HUP} = sub { print STDERR "got interrupt - ignored\n"; };
3e16d5fc 6448
afdb31d5 6449 eval {
3e16d5fc 6450 # enable interrupts
6cb0144a
EK
6451 local $SIG{INT} =
6452 local $SIG{TERM} =
6453 local $SIG{QUIT} =
6454 local $SIG{HUP} =
6455 local $SIG{PIPE} = sub { die "interrupted by signal\n"; };
3e16d5fc 6456
9c502e26
DM
6457 if ($archive eq '-') {
6458 print "extracting archive from STDIN\n";
6459 run_command($cmd, input => "<&STDIN");
6460 } else {
6461 print "extracting archive '$archive'\n";
6462 run_command($cmd);
6463 }
3e16d5fc
DM
6464
6465 return if $opts->{info};
6466
6467 # read new mapping
6468 my $map = {};
6469 my $statfile = "$tmpdir/qmrestore.stat";
6470 if (my $fd = IO::File->new($statfile, "r")) {
6471 while (defined (my $line = <$fd>)) {
6472 if ($line =~ m/vzdump:([^\s:]*):(\S+)$/) {
6473 $map->{$1} = $2 if $1;
6474 } else {
6475 print STDERR "unable to parse line in statfile - $line\n";
6476 }
6477 }
6478 $fd->close();
6479 }
6480
6481 my $confsrc = "$tmpdir/qemu-server.conf";
6482
f7d1505b 6483 my $srcfd = IO::File->new($confsrc, "r") || die "unable to open file '$confsrc'\n";
3e16d5fc 6484
f7d1505b 6485 my $outfd = IO::File->new($tmpfn, "w") || die "unable to write config for VM $vmid\n";
3e16d5fc 6486
91bd6c90 6487 my $cookie = { netcount => 0 };
3e16d5fc 6488 while (defined (my $line = <$srcfd>)) {
9f3d73bc 6489 $restore_update_config_line->($outfd, $cookie, $vmid, $map, $line, $opts->{unique});
3e16d5fc
DM
6490 }
6491
6492 $srcfd->close();
6493 $outfd->close();
6494 };
7dc7f315 6495 if (my $err = $@) {
3e16d5fc 6496 unlink $tmpfn;
ed221350 6497 tar_restore_cleanup($storecfg, "$tmpdir/qmrestore.stat") if !$opts->{info};
3e16d5fc 6498 die $err;
afdb31d5 6499 }
3e16d5fc
DM
6500
6501 rmtree $tmpdir;
6502
6503 rename $tmpfn, $conffile ||
6504 die "unable to commit configuration file '$conffile'\n";
91bd6c90 6505
ed221350
DM
6506 PVE::Cluster::cfs_update(); # make sure we read new file
6507
91bd6c90
DM
6508 eval { rescan($vmid, 1); };
6509 warn $@ if $@;
3e16d5fc
DM
6510};
6511
65a5ce88 6512sub foreach_storage_used_by_vm {
18bfb361
DM
6513 my ($conf, $func) = @_;
6514
6515 my $sidhash = {};
6516
912792e2 6517 PVE::QemuConfig->foreach_volume($conf, sub {
8ddbcf8b
FG
6518 my ($ds, $drive) = @_;
6519 return if drive_is_cdrom($drive);
18bfb361
DM
6520
6521 my $volid = $drive->{file};
6522
6523 my ($sid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
be190583 6524 $sidhash->{$sid} = $sid if $sid;
8ddbcf8b 6525 });
18bfb361
DM
6526
6527 foreach my $sid (sort keys %$sidhash) {
6528 &$func($sid);
6529 }
6530}
6531
6c9f59c1
TL
6532my $qemu_snap_storage = {
6533 rbd => 1,
6534};
e5eaa028
WL
6535sub do_snapshots_with_qemu {
6536 my ($storecfg, $volid) = @_;
6537
6538 my $storage_name = PVE::Storage::parse_volume_id($volid);
8aa2ed7c 6539 my $scfg = $storecfg->{ids}->{$storage_name};
f7d1505b 6540 die "could not find storage '$storage_name'\n" if !defined($scfg);
e5eaa028 6541
8aa2ed7c 6542 if ($qemu_snap_storage->{$scfg->{type}} && !$scfg->{krbd}){
e5eaa028
WL
6543 return 1;
6544 }
6545
6546 if ($volid =~ m/\.(qcow2|qed)$/){
6547 return 1;
6548 }
6549
d1c1af4b 6550 return;
e5eaa028
WL
6551}
6552
4dcc780c 6553sub qga_check_running {
a4938c72 6554 my ($vmid, $nowarn) = @_;
4dcc780c 6555
0a13e08e 6556 eval { mon_cmd($vmid, "guest-ping", timeout => 3); };
4dcc780c 6557 if ($@) {
a4938c72 6558 warn "Qemu Guest Agent is not running - $@" if !$nowarn;
4dcc780c
WL
6559 return 0;
6560 }
6561 return 1;
6562}
6563
04a69bb4
AD
6564sub template_create {
6565 my ($vmid, $conf, $disk) = @_;
6566
04a69bb4 6567 my $storecfg = PVE::Storage::config();
04a69bb4 6568
912792e2 6569 PVE::QemuConfig->foreach_volume($conf, sub {
9cd07842
DM
6570 my ($ds, $drive) = @_;
6571
6572 return if drive_is_cdrom($drive);
6573 return if $disk && $ds ne $disk;
6574
6575 my $volid = $drive->{file};
bbd56097 6576 return if !PVE::Storage::volume_has_feature($storecfg, 'template', $volid);
9cd07842 6577
04a69bb4
AD
6578 my $voliddst = PVE::Storage::vdisk_create_base($storecfg, $volid);
6579 $drive->{file} = $voliddst;
71c58bb7 6580 $conf->{$ds} = print_drive($drive);
ffda963f 6581 PVE::QemuConfig->write_config($vmid, $conf);
04a69bb4 6582 });
04a69bb4
AD
6583}
6584
92bdc3f0
DC
6585sub convert_iscsi_path {
6586 my ($path) = @_;
6587
6588 if ($path =~ m|^iscsi://([^/]+)/([^/]+)/(.+)$|) {
6589 my $portal = $1;
6590 my $target = $2;
6591 my $lun = $3;
6592
6593 my $initiator_name = get_initiator_name();
6594
6595 return "file.driver=iscsi,file.transport=tcp,file.initiator-name=$initiator_name,".
6596 "file.portal=$portal,file.target=$target,file.lun=$lun,driver=raw";
6597 }
6598
6599 die "cannot convert iscsi path '$path', unkown format\n";
6600}
6601
5133de42 6602sub qemu_img_convert {
988e2714 6603 my ($src_volid, $dst_volid, $size, $snapname, $is_zero_initialized) = @_;
5133de42
AD
6604
6605 my $storecfg = PVE::Storage::config();
6606 my ($src_storeid, $src_volname) = PVE::Storage::parse_volume_id($src_volid, 1);
6607 my ($dst_storeid, $dst_volname) = PVE::Storage::parse_volume_id($dst_volid, 1);
6608
af1f1ec0 6609 die "destination '$dst_volid' is not a valid volid form qemu-img convert\n" if !$dst_storeid;
6bb91c17 6610
af1f1ec0
DC
6611 my $cachemode;
6612 my $src_path;
6613 my $src_is_iscsi = 0;
bdd1feef 6614 my $src_format;
6bb91c17 6615
af1f1ec0
DC
6616 if ($src_storeid) {
6617 PVE::Storage::activate_volumes($storecfg, [$src_volid], $snapname);
5133de42 6618 my $src_scfg = PVE::Storage::storage_config($storecfg, $src_storeid);
af1f1ec0
DC
6619 $src_format = qemu_img_format($src_scfg, $src_volname);
6620 $src_path = PVE::Storage::path($storecfg, $src_volid, $snapname);
6621 $src_is_iscsi = ($src_path =~ m|^iscsi://|);
6622 $cachemode = 'none' if $src_scfg->{type} eq 'zfspool';
6623 } elsif (-f $src_volid) {
6624 $src_path = $src_volid;
e0fd2b2f 6625 if ($src_path =~ m/\.($PVE::QemuServer::Drive::QEMU_FORMAT_RE)$/) {
af1f1ec0
DC
6626 $src_format = $1;
6627 }
6628 }
5133de42 6629
af1f1ec0 6630 die "source '$src_volid' is not a valid volid nor path for qemu-img convert\n" if !$src_path;
5133de42 6631
af1f1ec0
DC
6632 my $dst_scfg = PVE::Storage::storage_config($storecfg, $dst_storeid);
6633 my $dst_format = qemu_img_format($dst_scfg, $dst_volname);
6634 my $dst_path = PVE::Storage::path($storecfg, $dst_volid);
6635 my $dst_is_iscsi = ($dst_path =~ m|^iscsi://|);
5133de42 6636
af1f1ec0
DC
6637 my $cmd = [];
6638 push @$cmd, '/usr/bin/qemu-img', 'convert', '-p', '-n';
bdd1feef
TL
6639 push @$cmd, '-l', "snapshot.name=$snapname"
6640 if $snapname && $src_format && $src_format eq "qcow2";
af1f1ec0
DC
6641 push @$cmd, '-t', 'none' if $dst_scfg->{type} eq 'zfspool';
6642 push @$cmd, '-T', $cachemode if defined($cachemode);
6643
6644 if ($src_is_iscsi) {
6645 push @$cmd, '--image-opts';
6646 $src_path = convert_iscsi_path($src_path);
bdd1feef 6647 } elsif ($src_format) {
af1f1ec0
DC
6648 push @$cmd, '-f', $src_format;
6649 }
92bdc3f0 6650
af1f1ec0
DC
6651 if ($dst_is_iscsi) {
6652 push @$cmd, '--target-image-opts';
6653 $dst_path = convert_iscsi_path($dst_path);
6654 } else {
6655 push @$cmd, '-O', $dst_format;
6656 }
92bdc3f0 6657
af1f1ec0 6658 push @$cmd, $src_path;
92bdc3f0 6659
af1f1ec0
DC
6660 if (!$dst_is_iscsi && $is_zero_initialized) {
6661 push @$cmd, "zeroinit:$dst_path";
6662 } else {
6663 push @$cmd, $dst_path;
6664 }
92bdc3f0 6665
af1f1ec0
DC
6666 my $parser = sub {
6667 my $line = shift;
6668 if($line =~ m/\((\S+)\/100\%\)/){
6669 my $percent = $1;
6670 my $transferred = int($size * $percent / 100);
6671 my $remaining = $size - $transferred;
92bdc3f0 6672
af1f1ec0 6673 print "transferred: $transferred bytes remaining: $remaining bytes total: $size bytes progression: $percent %\n";
988e2714 6674 }
5133de42 6675
af1f1ec0 6676 };
5133de42 6677
af1f1ec0
DC
6678 eval { run_command($cmd, timeout => undef, outfunc => $parser); };
6679 my $err = $@;
6680 die "copy failed: $err" if $err;
5133de42
AD
6681}
6682
6683sub qemu_img_format {
6684 my ($scfg, $volname) = @_;
6685
e0fd2b2f 6686 if ($scfg->{path} && $volname =~ m/\.($PVE::QemuServer::Drive::QEMU_FORMAT_RE)$/) {
5133de42 6687 return $1;
be190583 6688 } else {
5133de42 6689 return "raw";
5133de42
AD
6690 }
6691}
6692
cfad42af 6693sub qemu_drive_mirror {
bc6c8231 6694 my ($vmid, $drive, $dst_volid, $vmiddst, $is_zero_initialized, $jobs, $completion, $qga, $bwlimit, $src_bitmap) = @_;
cfad42af 6695
5a345967
AD
6696 $jobs = {} if !$jobs;
6697
6698 my $qemu_target;
6699 my $format;
35e4ab04 6700 $jobs->{"drive-$drive"} = {};
152fe752 6701
1e5143de 6702 if ($dst_volid =~ /^nbd:/) {
87955688 6703 $qemu_target = $dst_volid;
5a345967 6704 $format = "nbd";
5a345967 6705 } else {
5a345967
AD
6706 my $storecfg = PVE::Storage::config();
6707 my ($dst_storeid, $dst_volname) = PVE::Storage::parse_volume_id($dst_volid);
6708
6709 my $dst_scfg = PVE::Storage::storage_config($storecfg, $dst_storeid);
cfad42af 6710
5a345967 6711 $format = qemu_img_format($dst_scfg, $dst_volname);
21ccdb50 6712
5a345967 6713 my $dst_path = PVE::Storage::path($storecfg, $dst_volid);
21ccdb50 6714
5a345967
AD
6715 $qemu_target = $is_zero_initialized ? "zeroinit:$dst_path" : $dst_path;
6716 }
988e2714
WB
6717
6718 my $opts = { timeout => 10, device => "drive-$drive", mode => "existing", sync => "full", target => $qemu_target };
88383920
DM
6719 $opts->{format} = $format if $format;
6720
bc6c8231
FG
6721 if (defined($src_bitmap)) {
6722 $opts->{sync} = 'incremental';
6723 $opts->{bitmap} = $src_bitmap;
6724 print "drive mirror re-using dirty bitmap '$src_bitmap'\n";
6725 }
6726
9fa05d31 6727 if (defined($bwlimit)) {
f6409f61
TL
6728 $opts->{speed} = $bwlimit * 1024;
6729 print "drive mirror is starting for drive-$drive with bandwidth limit: ${bwlimit} KB/s\n";
9fa05d31
SI
6730 } else {
6731 print "drive mirror is starting for drive-$drive\n";
6732 }
21ccdb50 6733
6dde5ea2 6734 # if a job already runs for this device we get an error, catch it for cleanup
0a13e08e 6735 eval { mon_cmd($vmid, "drive-mirror", %$opts); };
5a345967
AD
6736 if (my $err = $@) {
6737 eval { PVE::QemuServer::qemu_blockjobs_cancel($vmid, $jobs) };
6dde5ea2
TL
6738 warn "$@\n" if $@;
6739 die "mirroring error: $err\n";
5a345967
AD
6740 }
6741
e02fb126 6742 qemu_drive_mirror_monitor ($vmid, $vmiddst, $jobs, $completion, $qga);
5a345967
AD
6743}
6744
db1f8b39
FG
6745# $completion can be either
6746# 'complete': wait until all jobs are ready, block-job-complete them (default)
6747# 'cancel': wait until all jobs are ready, block-job-cancel them
6748# 'skip': wait until all jobs are ready, return with block jobs in ready state
5a345967 6749sub qemu_drive_mirror_monitor {
e02fb126
ML
6750 my ($vmid, $vmiddst, $jobs, $completion, $qga) = @_;
6751
db1f8b39 6752 $completion //= 'complete';
2e953867 6753
08ac653f 6754 eval {
5a345967
AD
6755 my $err_complete = 0;
6756
08ac653f 6757 while (1) {
5a345967
AD
6758 die "storage migration timed out\n" if $err_complete > 300;
6759
0a13e08e 6760 my $stats = mon_cmd($vmid, "query-block-jobs");
08ac653f 6761
5a345967
AD
6762 my $running_mirror_jobs = {};
6763 foreach my $stat (@$stats) {
6764 next if $stat->{type} ne 'mirror';
6765 $running_mirror_jobs->{$stat->{device}} = $stat;
6766 }
08ac653f 6767
5a345967 6768 my $readycounter = 0;
67fb9de6 6769
5a345967
AD
6770 foreach my $job (keys %$jobs) {
6771
6772 if(defined($jobs->{$job}->{complete}) && !defined($running_mirror_jobs->{$job})) {
6773 print "$job : finished\n";
6774 delete $jobs->{$job};
6775 next;
6776 }
6777
bd2d5fe6 6778 die "$job: mirroring has been cancelled\n" if !defined($running_mirror_jobs->{$job});
f34ebd52 6779
5a345967
AD
6780 my $busy = $running_mirror_jobs->{$job}->{busy};
6781 my $ready = $running_mirror_jobs->{$job}->{ready};
6782 if (my $total = $running_mirror_jobs->{$job}->{len}) {
6783 my $transferred = $running_mirror_jobs->{$job}->{offset} || 0;
6784 my $remaining = $total - $transferred;
6785 my $percent = sprintf "%.2f", ($transferred * 100 / $total);
08ac653f 6786
5a345967
AD
6787 print "$job: transferred: $transferred bytes remaining: $remaining bytes total: $total bytes progression: $percent % busy: $busy ready: $ready \n";
6788 }
f34ebd52 6789
d1782eba 6790 $readycounter++ if $running_mirror_jobs->{$job}->{ready};
5a345967 6791 }
b467f79a 6792
5a345967
AD
6793 last if scalar(keys %$jobs) == 0;
6794
6795 if ($readycounter == scalar(keys %$jobs)) {
6796 print "all mirroring jobs are ready \n";
e02fb126 6797 last if $completion eq 'skip'; #do the complete later
5a345967
AD
6798
6799 if ($vmiddst && $vmiddst != $vmid) {
1a988fd2
DC
6800 my $agent_running = $qga && qga_check_running($vmid);
6801 if ($agent_running) {
5619e74a 6802 print "freeze filesystem\n";
0a13e08e 6803 eval { mon_cmd($vmid, "guest-fsfreeze-freeze"); };
5619e74a
AD
6804 } else {
6805 print "suspend vm\n";
6806 eval { PVE::QemuServer::vm_suspend($vmid, 1); };
6807 }
6808
5a345967
AD
6809 # if we clone a disk for a new target vm, we don't switch the disk
6810 PVE::QemuServer::qemu_blockjobs_cancel($vmid, $jobs);
5619e74a 6811
1a988fd2 6812 if ($agent_running) {
5619e74a 6813 print "unfreeze filesystem\n";
0a13e08e 6814 eval { mon_cmd($vmid, "guest-fsfreeze-thaw"); };
5619e74a
AD
6815 } else {
6816 print "resume vm\n";
6817 eval { PVE::QemuServer::vm_resume($vmid, 1, 1); };
6818 }
6819
2e953867 6820 last;
5a345967
AD
6821 } else {
6822
6823 foreach my $job (keys %$jobs) {
6824 # try to switch the disk if source and destination are on the same guest
bd2d5fe6 6825 print "$job: Completing block job...\n";
5a345967 6826
e02fb126 6827 my $op;
db1f8b39 6828 if ($completion eq 'complete') {
e02fb126 6829 $op = 'block-job-complete';
db1f8b39 6830 } elsif ($completion eq 'cancel') {
e02fb126
ML
6831 $op = 'block-job-cancel';
6832 } else {
6833 die "invalid completion value: $completion\n";
6834 }
6835 eval { mon_cmd($vmid, $op, device => $job) };
5a345967 6836 if ($@ =~ m/cannot be completed/) {
bd2d5fe6 6837 print "$job: Block job cannot be completed, try again.\n";
5a345967
AD
6838 $err_complete++;
6839 }else {
bd2d5fe6 6840 print "$job: Completed successfully.\n";
5a345967
AD
6841 $jobs->{$job}->{complete} = 1;
6842 }
6843 }
2e953867 6844 }
08ac653f 6845 }
08ac653f 6846 sleep 1;
cfad42af 6847 }
08ac653f 6848 };
88383920 6849 my $err = $@;
08ac653f 6850
88383920 6851 if ($err) {
5a345967 6852 eval { PVE::QemuServer::qemu_blockjobs_cancel($vmid, $jobs) };
88383920
DM
6853 die "mirroring error: $err";
6854 }
6855
5a345967
AD
6856}
6857
6858sub qemu_blockjobs_cancel {
6859 my ($vmid, $jobs) = @_;
6860
6861 foreach my $job (keys %$jobs) {
bd2d5fe6 6862 print "$job: Cancelling block job\n";
0a13e08e 6863 eval { mon_cmd($vmid, "block-job-cancel", device => $job); };
5a345967
AD
6864 $jobs->{$job}->{cancel} = 1;
6865 }
6866
6867 while (1) {
0a13e08e 6868 my $stats = mon_cmd($vmid, "query-block-jobs");
5a345967
AD
6869
6870 my $running_jobs = {};
6871 foreach my $stat (@$stats) {
6872 $running_jobs->{$stat->{device}} = $stat;
6873 }
6874
6875 foreach my $job (keys %$jobs) {
6876
bd2d5fe6
WB
6877 if (defined($jobs->{$job}->{cancel}) && !defined($running_jobs->{$job})) {
6878 print "$job: Done.\n";
5a345967
AD
6879 delete $jobs->{$job};
6880 }
6881 }
6882
6883 last if scalar(keys %$jobs) == 0;
6884
6885 sleep 1;
cfad42af
AD
6886 }
6887}
6888
152fe752 6889sub clone_disk {
be190583 6890 my ($storecfg, $vmid, $running, $drivename, $drive, $snapname,
818ce80e 6891 $newvmid, $storage, $format, $full, $newvollist, $jobs, $completion, $qga, $bwlimit, $conf) = @_;
152fe752
DM
6892
6893 my $newvolid;
6894
6895 if (!$full) {
6896 print "create linked clone of drive $drivename ($drive->{file})\n";
258e646c 6897 $newvolid = PVE::Storage::vdisk_clone($storecfg, $drive->{file}, $newvmid, $snapname);
152fe752
DM
6898 push @$newvollist, $newvolid;
6899 } else {
5a345967 6900
152fe752
DM
6901 my ($storeid, $volname) = PVE::Storage::parse_volume_id($drive->{file});
6902 $storeid = $storage if $storage;
6903
44549149 6904 my $dst_format = resolve_dst_disk_format($storecfg, $storeid, $volname, $format);
152fe752
DM
6905
6906 print "create full clone of drive $drivename ($drive->{file})\n";
931432bd 6907 my $name = undef;
d0abc774 6908 my $size = undef;
7fe8b44c
TL
6909 if (drive_is_cloudinit($drive)) {
6910 $name = "vm-$newvmid-cloudinit";
6911 $name .= ".$dst_format" if $dst_format ne 'raw';
6912 $snapname = undef;
6913 $size = PVE::QemuServer::Cloudinit::CLOUDINIT_DISK_SIZE;
818ce80e
DC
6914 } elsif ($drivename eq 'efidisk0') {
6915 $size = get_efivars_size($conf);
d0abc774
ML
6916 } else {
6917 ($size) = PVE::Storage::volume_size_info($storecfg, $drive->{file}, 3);
7fe8b44c 6918 }
4df98f2f
TL
6919 $size /= 1024;
6920 $newvolid = PVE::Storage::vdisk_alloc($storecfg, $storeid, $newvmid, $dst_format, $name, $size);
152fe752
DM
6921 push @$newvollist, $newvolid;
6922
3999f370 6923 PVE::Storage::activate_volumes($storecfg, [$newvolid]);
1dbd6d30 6924
7fe8b44c
TL
6925 if (drive_is_cloudinit($drive)) {
6926 goto no_data_clone;
6927 }
6928
988e2714 6929 my $sparseinit = PVE::Storage::volume_has_feature($storecfg, 'sparseinit', $newvolid);
152fe752 6930 if (!$running || $snapname) {
d189e590 6931 # TODO: handle bwlimits
818ce80e
DC
6932 if ($drivename eq 'efidisk0') {
6933 # the relevant data on the efidisk may be smaller than the source
6934 # e.g. on RBD/ZFS, so we use dd to copy only the amount
6935 # that is given by the OVMF_VARS.fd
6936 my $src_path = PVE::Storage::path($storecfg, $drive->{file});
6937 my $dst_path = PVE::Storage::path($storecfg, $newvolid);
4df98f2f
TL
6938 run_command(['qemu-img', 'dd', '-n', '-O', $dst_format, "bs=1", "count=$size",
6939 "if=$src_path", "of=$dst_path"]);
818ce80e
DC
6940 } else {
6941 qemu_img_convert($drive->{file}, $newvolid, $size, $snapname, $sparseinit);
6942 }
152fe752 6943 } else {
2e541679
AD
6944
6945 my $kvmver = get_running_qemu_version ($vmid);
2ea5fb7e 6946 if (!min_version($kvmver, 2, 7)) {
961af8a3
WB
6947 die "drive-mirror with iothread requires qemu version 2.7 or higher\n"
6948 if $drive->{iothread};
2e541679 6949 }
2af848a2 6950
4df98f2f
TL
6951 qemu_drive_mirror($vmid, $drivename, $newvolid, $newvmid, $sparseinit, $jobs,
6952 $completion, $qga, $bwlimit);
be190583 6953 }
152fe752
DM
6954 }
6955
7fe8b44c 6956no_data_clone:
152fe752
DM
6957 my ($size) = PVE::Storage::volume_size_info($storecfg, $newvolid, 3);
6958
6959 my $disk = $drive;
6960 $disk->{format} = undef;
6961 $disk->{file} = $newvolid;
6962 $disk->{size} = $size;
6963
6964 return $disk;
6965}
6966
98cfd8b6
AD
6967sub get_running_qemu_version {
6968 my ($vmid) = @_;
0a13e08e 6969 my $res = mon_cmd($vmid, "query-version");
98cfd8b6
AD
6970 return "$res->{qemu}->{major}.$res->{qemu}->{minor}";
6971}
6972
249c4a6c
AD
6973sub qemu_use_old_bios_files {
6974 my ($machine_type) = @_;
6975
6976 return if !$machine_type;
6977
6978 my $use_old_bios_files = undef;
6979
6980 if ($machine_type =~ m/^(\S+)\.pxe$/) {
6981 $machine_type = $1;
6982 $use_old_bios_files = 1;
6983 } else {
4df98f2f 6984 my $version = extract_version($machine_type, kvm_user_version());
249c4a6c
AD
6985 # Note: kvm version < 2.4 use non-efi pxe files, and have problems when we
6986 # load new efi bios files on migration. So this hack is required to allow
6987 # live migration from qemu-2.2 to qemu-2.4, which is sometimes used when
6988 # updrading from proxmox-ve-3.X to proxmox-ve 4.0
2ea5fb7e 6989 $use_old_bios_files = !min_version($version, 2, 4);
249c4a6c
AD
6990 }
6991
6992 return ($use_old_bios_files, $machine_type);
6993}
6994
818ce80e
DC
6995sub get_efivars_size {
6996 my ($conf) = @_;
6997 my $arch = get_vm_arch($conf);
6998 my (undef, $ovmf_vars) = get_ovmf_files($arch);
6999 die "uefi vars image '$ovmf_vars' not found\n" if ! -f $ovmf_vars;
7000 return -s $ovmf_vars;
7001}
7002
7003sub update_efidisk_size {
7004 my ($conf) = @_;
7005
7006 return if !defined($conf->{efidisk0});
7007
7008 my $disk = PVE::QemuServer::parse_drive('efidisk0', $conf->{efidisk0});
7009 $disk->{size} = get_efivars_size($conf);
7010 $conf->{efidisk0} = print_drive($disk);
7011
7012 return;
7013}
7014
96ed3574
WB
7015sub create_efidisk($$$$$) {
7016 my ($storecfg, $storeid, $vmid, $fmt, $arch) = @_;
3e1f1122 7017
96ed3574
WB
7018 my (undef, $ovmf_vars) = get_ovmf_files($arch);
7019 die "EFI vars default image not found\n" if ! -f $ovmf_vars;
3e1f1122 7020
af1f1ec0
DC
7021 my $vars_size_b = -s $ovmf_vars;
7022 my $vars_size = PVE::Tools::convert_size($vars_size_b, 'b' => 'kb');
3e1f1122
TL
7023 my $volid = PVE::Storage::vdisk_alloc($storecfg, $storeid, $vmid, $fmt, undef, $vars_size);
7024 PVE::Storage::activate_volumes($storecfg, [$volid]);
7025
af1f1ec0 7026 qemu_img_convert($ovmf_vars, $volid, $vars_size_b, undef, 0);
340dbcf7 7027 my ($size) = PVE::Storage::volume_size_info($storecfg, $volid, 3);
3e1f1122 7028
340dbcf7 7029 return ($volid, $size/1024);
3e1f1122
TL
7030}
7031
22de899a
AD
7032sub vm_iothreads_list {
7033 my ($vmid) = @_;
7034
0a13e08e 7035 my $res = mon_cmd($vmid, 'query-iothreads');
22de899a
AD
7036
7037 my $iothreads = {};
7038 foreach my $iothread (@$res) {
7039 $iothreads->{ $iothread->{id} } = $iothread->{"thread-id"};
7040 }
7041
7042 return $iothreads;
7043}
7044
ee034f5c
AD
7045sub scsihw_infos {
7046 my ($conf, $drive) = @_;
7047
7048 my $maxdev = 0;
7049
7fe1b688 7050 if (!$conf->{scsihw} || ($conf->{scsihw} =~ m/^lsi/)) {
ee034f5c 7051 $maxdev = 7;
a1511b3c 7052 } elsif ($conf->{scsihw} && ($conf->{scsihw} eq 'virtio-scsi-single')) {
ee034f5c
AD
7053 $maxdev = 1;
7054 } else {
7055 $maxdev = 256;
7056 }
7057
7058 my $controller = int($drive->{index} / $maxdev);
4df98f2f
TL
7059 my $controller_prefix = ($conf->{scsihw} && $conf->{scsihw} eq 'virtio-scsi-single')
7060 ? "virtioscsi"
7061 : "scsihw";
ee034f5c
AD
7062
7063 return ($maxdev, $controller, $controller_prefix);
7064}
a1511b3c 7065
4317f69f
AD
7066sub windows_version {
7067 my ($ostype) = @_;
7068
7069 return 0 if !$ostype;
7070
7071 my $winversion = 0;
7072
7073 if($ostype eq 'wxp' || $ostype eq 'w2k3' || $ostype eq 'w2k') {
7074 $winversion = 5;
7075 } elsif($ostype eq 'w2k8' || $ostype eq 'wvista') {
7076 $winversion = 6;
7077 } elsif ($ostype =~ m/^win(\d+)$/) {
7078 $winversion = $1;
7079 }
7080
7081 return $winversion;
7082}
7083
44549149
EK
7084sub resolve_dst_disk_format {
7085 my ($storecfg, $storeid, $src_volname, $format) = @_;
7086 my ($defFormat, $validFormats) = PVE::Storage::storage_default_format($storecfg, $storeid);
7087
7088 if (!$format) {
7089 # if no target format is specified, use the source disk format as hint
7090 if ($src_volname) {
7091 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
7092 $format = qemu_img_format($scfg, $src_volname);
7093 } else {
7094 return $defFormat;
7095 }
7096 }
7097
7098 # test if requested format is supported - else use default
7099 my $supported = grep { $_ eq $format } @$validFormats;
7100 $format = $defFormat if !$supported;
7101 return $format;
7102}
7103
66cebc46
DC
7104# NOTE: if this logic changes, please update docs & possibly gui logic
7105sub find_vmstate_storage {
7106 my ($conf, $storecfg) = @_;
7107
7108 # first, return storage from conf if set
7109 return $conf->{vmstatestorage} if $conf->{vmstatestorage};
7110
7111 my ($target, $shared, $local);
7112
7113 foreach_storage_used_by_vm($conf, sub {
7114 my ($sid) = @_;
7115 my $scfg = PVE::Storage::storage_config($storecfg, $sid);
7116 my $dst = $scfg->{shared} ? \$shared : \$local;
7117 $$dst = $sid if !$$dst || $scfg->{path}; # prefer file based storage
7118 });
7119
7120 # second, use shared storage where VM has at least one disk
7121 # third, use local storage where VM has at least one disk
7122 # fall back to local storage
7123 $target = $shared // $local // 'local';
7124
7125 return $target;
7126}
7127
6ee499ff 7128sub generate_uuid {
ae2fcb3b
EK
7129 my ($uuid, $uuid_str);
7130 UUID::generate($uuid);
7131 UUID::unparse($uuid, $uuid_str);
6ee499ff
DC
7132 return $uuid_str;
7133}
7134
7135sub generate_smbios1_uuid {
7136 return "uuid=".generate_uuid();
ae2fcb3b
EK
7137}
7138
9c152e87
TL
7139sub nbd_stop {
7140 my ($vmid) = @_;
7141
0a13e08e 7142 mon_cmd($vmid, 'nbd-server-stop');
9c152e87
TL
7143}
7144
dae98db9
DC
7145sub create_reboot_request {
7146 my ($vmid) = @_;
7147 open(my $fh, '>', "/run/qemu-server/$vmid.reboot")
7148 or die "failed to create reboot trigger file: $!\n";
7149 close($fh);
7150}
7151
7152sub clear_reboot_request {
7153 my ($vmid) = @_;
7154 my $path = "/run/qemu-server/$vmid.reboot";
7155 my $res = 0;
7156
7157 $res = unlink($path);
7158 die "could not remove reboot request for $vmid: $!"
7159 if !$res && $! != POSIX::ENOENT;
7160
7161 return $res;
7162}
7163
5cfa9f5f
SR
7164sub bootorder_from_legacy {
7165 my ($conf, $bootcfg) = @_;
7166
7167 my $boot = $bootcfg->{legacy} || $boot_fmt->{legacy}->{default};
7168 my $bootindex_hash = {};
7169 my $i = 1;
7170 foreach my $o (split(//, $boot)) {
7171 $bootindex_hash->{$o} = $i*100;
7172 $i++;
7173 }
7174
7175 my $bootorder = {};
7176
7177 PVE::QemuConfig->foreach_volume($conf, sub {
7178 my ($ds, $drive) = @_;
7179
7180 if (drive_is_cdrom ($drive, 1)) {
7181 if ($bootindex_hash->{d}) {
7182 $bootorder->{$ds} = $bootindex_hash->{d};
7183 $bootindex_hash->{d} += 1;
7184 }
7185 } elsif ($bootindex_hash->{c}) {
7186 $bootorder->{$ds} = $bootindex_hash->{c}
7187 if $conf->{bootdisk} && $conf->{bootdisk} eq $ds;
7188 $bootindex_hash->{c} += 1;
7189 }
7190 });
7191
7192 if ($bootindex_hash->{n}) {
7193 for (my $i = 0; $i < $MAX_NETS; $i++) {
7194 my $netname = "net$i";
7195 next if !$conf->{$netname};
7196 $bootorder->{$netname} = $bootindex_hash->{n};
7197 $bootindex_hash->{n} += 1;
7198 }
7199 }
7200
7201 return $bootorder;
7202}
7203
7204# Generate default device list for 'boot: order=' property. Matches legacy
7205# default boot order, but with explicit device names. This is important, since
7206# the fallback for when neither 'order' nor the old format is specified relies
7207# on 'bootorder_from_legacy' above, and it would be confusing if this diverges.
7208sub get_default_bootdevices {
7209 my ($conf) = @_;
7210
7211 my @ret = ();
7212
7213 # harddisk
7214 my $first = PVE::QemuServer::Drive::resolve_first_disk($conf, 0);
7215 push @ret, $first if $first;
7216
7217 # cdrom
7218 $first = PVE::QemuServer::Drive::resolve_first_disk($conf, 1);
7219 push @ret, $first if $first;
7220
7221 # network
7222 for (my $i = 0; $i < $MAX_NETS; $i++) {
7223 my $netname = "net$i";
7224 next if !$conf->{$netname};
7225 push @ret, $netname;
7226 last;
7227 }
7228
7229 return \@ret;
7230}
7231
e5d611c3
TL
7232sub device_bootorder {
7233 my ($conf) = @_;
7234
7235 return bootorder_from_legacy($conf) if !defined($conf->{boot});
7236
7237 my $boot = parse_property_string($boot_fmt, $conf->{boot});
7238
7239 my $bootorder = {};
7240 if (!defined($boot) || $boot->{legacy}) {
7241 $bootorder = bootorder_from_legacy($conf, $boot);
7242 } elsif ($boot->{order}) {
7243 my $i = 100; # start at 100 to allow user to insert devices before us with -args
7244 for my $dev (PVE::Tools::split_list($boot->{order})) {
7245 $bootorder->{$dev} = $i++;
7246 }
7247 }
7248
7249 return $bootorder;
7250}
7251
65e866e5
DM
7252# bash completion helper
7253
7254sub complete_backup_archives {
7255 my ($cmdname, $pname, $cvalue) = @_;
7256
7257 my $cfg = PVE::Storage::config();
7258
7259 my $storeid;
7260
7261 if ($cvalue =~ m/^([^:]+):/) {
7262 $storeid = $1;
7263 }
7264
7265 my $data = PVE::Storage::template_list($cfg, $storeid, 'backup');
7266
7267 my $res = [];
7268 foreach my $id (keys %$data) {
7269 foreach my $item (@{$data->{$id}}) {
f43a4f12 7270 next if $item->{format} !~ m/^vma\.(${\PVE::Storage::Plugin::COMPRESSOR_RE})$/;
65e866e5
DM
7271 push @$res, $item->{volid} if defined($item->{volid});
7272 }
7273 }
7274
7275 return $res;
7276}
7277
7278my $complete_vmid_full = sub {
7279 my ($running) = @_;
7280
7281 my $idlist = vmstatus();
7282
7283 my $res = [];
7284
7285 foreach my $id (keys %$idlist) {
7286 my $d = $idlist->{$id};
7287 if (defined($running)) {
7288 next if $d->{template};
7289 next if $running && $d->{status} ne 'running';
7290 next if !$running && $d->{status} eq 'running';
7291 }
7292 push @$res, $id;
7293
7294 }
7295 return $res;
7296};
7297
7298sub complete_vmid {
7299 return &$complete_vmid_full();
7300}
7301
7302sub complete_vmid_stopped {
7303 return &$complete_vmid_full(0);
7304}
7305
7306sub complete_vmid_running {
7307 return &$complete_vmid_full(1);
7308}
7309
335af808
DM
7310sub complete_storage {
7311
7312 my $cfg = PVE::Storage::config();
7313 my $ids = $cfg->{ids};
7314
7315 my $res = [];
7316 foreach my $sid (keys %$ids) {
7317 next if !PVE::Storage::storage_check_enabled($cfg, $sid, undef, 1);
c4c844ef 7318 next if !$ids->{$sid}->{content}->{images};
335af808
DM
7319 push @$res, $sid;
7320 }
7321
7322 return $res;
7323}
7324
255e9c54
AL
7325sub complete_migration_storage {
7326 my ($cmd, $param, $current_value, $all_args) = @_;
7327
7328 my $targetnode = @$all_args[1];
7329
7330 my $cfg = PVE::Storage::config();
7331 my $ids = $cfg->{ids};
7332
7333 my $res = [];
7334 foreach my $sid (keys %$ids) {
7335 next if !PVE::Storage::storage_check_enabled($cfg, $sid, $targetnode, 1);
7336 next if !$ids->{$sid}->{content}->{images};
7337 push @$res, $sid;
7338 }
7339
7340 return $res;
7341}
7342
1e3baf05 73431;