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