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