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