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