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