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