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