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