]> git.proxmox.com Git - pve-container.git/blame - src/PVE/LXC/Config.pm
config: implement method to calculate derived properties from a config
[pve-container.git] / src / PVE / LXC / Config.pm
CommitLineData
67afe46e
FG
1package PVE::LXC::Config;
2
3use strict;
4use warnings;
f89af842 5
8463099d 6use Fcntl qw(O_RDONLY);
67afe46e
FG
7
8use PVE::AbstractConfig;
9use PVE::Cluster qw(cfs_register_file);
8b076579 10use PVE::DataCenterConfig;
1a416433 11use PVE::GuestHelpers;
67afe46e
FG
12use PVE::INotify;
13use PVE::JSONSchema qw(get_standard_option);
14use PVE::Tools;
15
11066f6b
TL
16use PVE::LXC;
17
67afe46e
FG
18use base qw(PVE::AbstractConfig);
19
f89af842
TL
20use constant {
21 FIFREEZE => 0xc0045877,
22 FITHAW => 0xc0045878,
23};
40cd2e89 24
67afe46e
FG
25my $nodename = PVE::INotify::nodename();
26my $lock_handles = {};
27my $lockdir = "/run/lock/lxc";
28mkdir $lockdir;
29mkdir "/etc/pve/nodes/$nodename/lxc";
717f70b7 30my $MAX_MOUNT_POINTS = 256;
67afe46e
FG
31my $MAX_UNUSED_DISKS = $MAX_MOUNT_POINTS;
32
33# BEGIN implemented abstract methods from PVE::AbstractConfig
34
35sub guest_type {
36 return "CT";
37}
38
4518000b
FG
39sub __config_max_unused_disks {
40 my ($class) = @_;
41
42 return $MAX_UNUSED_DISKS;
43}
44
67afe46e
FG
45sub config_file_lock {
46 my ($class, $vmid) = @_;
47
48 return "$lockdir/pve-config-${vmid}.lock";
49}
50
51sub cfs_config_path {
52 my ($class, $vmid, $node) = @_;
53
54 $node = $nodename if !$node;
55 return "nodes/$node/lxc/$vmid.conf";
56}
57
1a8269bc 58sub mountpoint_backup_enabled {
ec7f0f09 59 my ($class, $mp_key, $mountpoint) = @_;
1a8269bc 60
dd4fa308
AL
61 my $enabled;
62 my $reason;
63
64 if ($mp_key eq 'rootfs') {
65 $enabled = 1;
66 $reason = 'rootfs';
67 } elsif ($mountpoint->{type} ne 'volume') {
68 $enabled = 0;
69 $reason = 'not a volume';
70 } elsif ($mountpoint->{backup}) {
71 $enabled = 1;
72 $reason = 'enabled';
73 } else {
74 $enabled = 0;
75 $reason = 'disabled';
76 }
77 return wantarray ? ($enabled, $reason) : $enabled;
1a8269bc
DM
78}
79
4518000b
FG
80sub has_feature {
81 my ($class, $feature, $conf, $storecfg, $snapname, $running, $backup_only) = @_;
82 my $err;
83
4a954457
FE
84 my $opts;
85 if ($feature eq 'copy' || $feature eq 'clone') {
86 $opts = {'valid_target_formats' => ['raw', 'subvol']};
87 }
88
015740e6 89 $class->foreach_volume($conf, sub {
4518000b
FG
90 my ($ms, $mountpoint) = @_;
91
92 return if $err; # skip further test
ec7f0f09 93 return if $backup_only && !$class->mountpoint_backup_enabled($ms, $mountpoint);
4518000b 94
a12caf82
TL
95 $err = 1 if !PVE::Storage::volume_has_feature(
96 $storecfg, $feature, $mountpoint->{volume}, $snapname, $running, $opts);
4518000b
FG
97 });
98
99 return $err ? 0 : 1;
100}
101
102sub __snapshot_save_vmstate {
103 my ($class, $vmid, $conf, $snapname, $storecfg) = @_;
104 die "implement me - snapshot_save_vmstate\n";
105}
106
7402b360
FE
107sub __snapshot_activate_storages {
108 my ($class, $conf, $include_vmstate) = @_;
109
110 my $storecfg = PVE::Storage::config();
111 my $opts = $include_vmstate ? { 'extra_keys' => ['vmstate'] } : {};
112 my $storage_hash = {};
113
114 $class->foreach_volume_full($conf, $opts, sub {
115 my ($vs, $mountpoint) = @_;
116
117 return if $mountpoint->{type} ne 'volume';
118
119 my ($storeid) = PVE::Storage::parse_volume_id($mountpoint->{volume});
120 $storage_hash->{$storeid} = 1;
121 });
122
123 PVE::Storage::activate_storage_list($storecfg, [ sort keys $storage_hash->%* ]);
124}
125
4518000b
FG
126sub __snapshot_check_running {
127 my ($class, $vmid) = @_;
128 return PVE::LXC::check_running($vmid);
129}
130
131sub __snapshot_check_freeze_needed {
132 my ($class, $vmid, $config, $save_vmstate) = @_;
133
134 my $ret = $class->__snapshot_check_running($vmid);
135 return ($ret, $ret);
136}
137
40cd2e89
SI
138# implements similar functionality to fsfreeze(8)
139sub fsfreeze_mountpoint {
140 my ($path, $thaw) = @_;
141
142 my $op = $thaw ? 'thaw' : 'freeze';
143 my $ioctl = $thaw ? FITHAW : FIFREEZE;
144
145 sysopen my $fd, $path, O_RDONLY or die "failed to open $path: $!\n";
146 my $ioctl_err;
147 if (!ioctl($fd, $ioctl, 0)) {
148 $ioctl_err = "$!";
149 }
150 close($fd);
151 die "fs$op '$path' failed - $ioctl_err\n" if defined $ioctl_err;
152}
153
4518000b
FG
154sub __snapshot_freeze {
155 my ($class, $vmid, $unfreeze) = @_;
156
8463099d
SI
157 my $conf = $class->load_config($vmid);
158 my $storagecfg = PVE::Storage::config();
159
160 my $freeze_mps = [];
161 $class->foreach_volume($conf, sub {
162 my ($ms, $mountpoint) = @_;
163
7a8591e8
SI
164 return if $mountpoint->{type} ne 'volume';
165
8463099d
SI
166 if (PVE::Storage::volume_snapshot_needs_fsfreeze($storagecfg, $mountpoint->{volume})) {
167 push @$freeze_mps, $mountpoint->{mp};
168 }
169 });
170
171 my $freeze_mountpoints = sub {
172 my ($thaw) = @_;
173
174 return if scalar(@$freeze_mps) == 0;
175
176 my $pid = PVE::LXC::find_lxc_pid($vmid);
177
178 for my $mp (@$freeze_mps) {
179 eval{ fsfreeze_mountpoint("/proc/${pid}/root/${mp}", $thaw); };
180 warn $@ if $@;
181 }
182 };
183
4518000b 184 if ($unfreeze) {
89424a8b 185 eval { PVE::LXC::thaw($vmid); };
4518000b 186 warn $@ if $@;
8463099d 187 $freeze_mountpoints->(1);
4518000b 188 } else {
89424a8b 189 PVE::LXC::freeze($vmid);
4518000b 190 PVE::LXC::sync_container_namespace($vmid);
8463099d 191 $freeze_mountpoints->(0);
4518000b
FG
192 }
193}
194
195sub __snapshot_create_vol_snapshot {
196 my ($class, $vmid, $ms, $mountpoint, $snapname) = @_;
197
198 my $storecfg = PVE::Storage::config();
199
1a8269bc 200 return if $snapname eq 'vzdump' &&
ec7f0f09 201 !$class->mountpoint_backup_enabled($ms, $mountpoint);
1a8269bc 202
4518000b
FG
203 PVE::Storage::volume_snapshot($storecfg, $mountpoint->{volume}, $snapname);
204}
205
206sub __snapshot_delete_remove_drive {
207 my ($class, $snap, $remove_drive) = @_;
208
209 if ($remove_drive eq 'vmstate') {
210 die "implement me - saving vmstate\n";
211 } else {
212 my $value = $snap->{$remove_drive};
e4034859 213 my $mountpoint = $class->parse_volume($remove_drive, $value, 1);
4518000b 214 delete $snap->{$remove_drive};
d103721f
FG
215
216 $class->add_unused_volume($snap, $mountpoint->{volume})
db2b28c7 217 if $mountpoint && ($mountpoint->{type} eq 'volume');
4518000b
FG
218 }
219}
220
221sub __snapshot_delete_vmstate_file {
222 my ($class, $snap, $force) = @_;
223
224 die "implement me - saving vmstate\n";
225}
226
227sub __snapshot_delete_vol_snapshot {
a8e9a4ea 228 my ($class, $vmid, $ms, $mountpoint, $snapname, $unused) = @_;
4518000b 229
d103721f
FG
230 return if $snapname eq 'vzdump' &&
231 !$class->mountpoint_backup_enabled($ms, $mountpoint);
232
4518000b
FG
233 my $storecfg = PVE::Storage::config();
234 PVE::Storage::volume_snapshot_delete($storecfg, $mountpoint->{volume}, $snapname);
a8e9a4ea 235 push @$unused, $mountpoint->{volume};
4518000b
FG
236}
237
238sub __snapshot_rollback_vol_possible {
199df356 239 my ($class, $mountpoint, $snapname, $blockers) = @_;
4518000b
FG
240
241 my $storecfg = PVE::Storage::config();
199df356
FE
242 PVE::Storage::volume_rollback_is_possible(
243 $storecfg,
244 $mountpoint->{volume},
245 $snapname,
246 $blockers,
247 );
4518000b
FG
248}
249
250sub __snapshot_rollback_vol_rollback {
251 my ($class, $mountpoint, $snapname) = @_;
252
253 my $storecfg = PVE::Storage::config();
254 PVE::Storage::volume_snapshot_rollback($storecfg, $mountpoint->{volume}, $snapname);
255}
256
257sub __snapshot_rollback_vm_stop {
258 my ($class, $vmid) = @_;
259
b1bad293 260 PVE::LXC::vm_stop($vmid, 1)
4518000b
FG
261 if $class->__snapshot_check_running($vmid);
262}
263
264sub __snapshot_rollback_vm_start {
67779c3c 265 my ($class, $vmid, $vmstate, $data);
4518000b
FG
266
267 die "implement me - save vmstate\n";
268}
269
a8656869
FG
270sub __snapshot_rollback_get_unused {
271 my ($class, $conf, $snap) = @_;
272
273 my $unused = [];
274
5e5d76cf 275 $class->foreach_volume($conf, sub {
a8656869
FG
276 my ($vs, $volume) = @_;
277
278 return if $volume->{type} ne 'volume';
279
280 my $found = 0;
281 my $volid = $volume->{volume};
282
5e5d76cf 283 $class->foreach_volume($snap, sub {
a8656869
FG
284 my ($ms, $mountpoint) = @_;
285
286 return if $found;
287 return if ($mountpoint->{type} ne 'volume');
288
289 $found = 1
290 if ($mountpoint->{volume} && $mountpoint->{volume} eq $volid);
291 });
292
293 push @$unused, $volid if !$found;
294 });
295
296 return $unused;
297}
298
67afe46e
FG
299# END implemented abstract methods from PVE::AbstractConfig
300
1b4cf758
FG
301# BEGIN JSON config code
302
303cfs_register_file('/lxc/', \&parse_pct_config, \&write_pct_config);
304
2bf24eb3 305
7a89429c 306my $valid_mount_option_re = qr/(noatime|lazytime|nodev|nosuid|noexec)/;
e80cb0cd
TL
307
308sub is_valid_mount_option {
309 my ($option) = @_;
310 return $option =~ $valid_mount_option_re;
2bf24eb3
OB
311}
312
1b4cf758
FG
313my $rootfs_desc = {
314 volume => {
315 type => 'string',
316 default_key => 1,
317 format => 'pve-lxc-mp-string',
318 format_description => 'volume',
319 description => 'Volume, device or directory to mount into the container.',
320 },
1b4cf758
FG
321 size => {
322 type => 'string',
323 format => 'disk-size',
324 format_description => 'DiskSize',
325 description => 'Volume size (read only value).',
326 optional => 1,
327 },
328 acl => {
329 type => 'boolean',
1b4cf758
FG
330 description => 'Explicitly enable or disable ACL support.',
331 optional => 1,
332 },
2bf24eb3
OB
333 mountoptions => {
334 optional => 1,
335 type => 'string',
336 description => 'Extra mount options for rootfs/mps.',
337 format_description => 'opt[;opt...]',
e80cb0cd 338 pattern => qr/$valid_mount_option_re(;$valid_mount_option_re)*/,
2bf24eb3 339 },
1b4cf758
FG
340 ro => {
341 type => 'boolean',
235dbdf3 342 description => 'Read-only mount point',
1b4cf758
FG
343 optional => 1,
344 },
345 quota => {
346 type => 'boolean',
1b4cf758
FG
347 description => 'Enable user quotas inside the container (not supported with zfs subvolumes)',
348 optional => 1,
349 },
76ec0820 350 replicate => {
f8aa3d35
WL
351 type => 'boolean',
352 description => 'Will include this volume to a storage replica job.',
353 optional => 1,
354 default => 1,
355 },
552e168f
FG
356 shared => {
357 type => 'boolean',
358 description => 'Mark this non-volume mount point as available on multiple nodes (see \'nodes\')',
359 verbose_description => "Mark this non-volume mount point as available on all nodes.\n\nWARNING: This option does not share the mount point automatically, it assumes it is shared already!",
360 optional => 1,
361 default => 0,
362 },
1b4cf758
FG
363};
364
365PVE::JSONSchema::register_standard_option('pve-ct-rootfs', {
366 type => 'string', format => $rootfs_desc,
367 description => "Use volume as container root.",
368 optional => 1,
369});
370
08a58f12
WB
371# IP address with optional interface suffix for link local ipv6 addresses
372PVE::JSONSchema::register_format('lxc-ip-with-ll-iface', \&verify_ip_with_ll_iface);
373sub verify_ip_with_ll_iface {
374 my ($addr, $noerr) = @_;
375
376 if (my ($addr, $iface) = ($addr =~ /^(fe80:[^%]+)%(.*)$/)) {
377 if (PVE::JSONSchema::pve_verify_ip($addr, 1)
378 && PVE::JSONSchema::pve_verify_iface($iface, 1))
379 {
380 return $addr;
381 }
382 }
383
384 return PVE::JSONSchema::pve_verify_ip($addr, $noerr);
385}
386
387
5a63f1c5
WB
388my $features_desc = {
389 mount => {
390 optional => 1,
391 type => 'string',
392 description => "Allow mounting file systems of specific types."
393 ." This should be a list of file system types as used with the mount command."
394 ." Note that this can have negative effects on the container's security."
395 ." With access to a loop device, mounting a file can circumvent the mknod"
396 ." permission of the devices cgroup, mounting an NFS file system can"
397 ." block the host's I/O completely and prevent it from rebooting, etc.",
398 format_description => 'fstype;fstype;...',
e188f1bb 399 pattern => qr/[a-zA-Z0-9_; ]+/,
5a63f1c5
WB
400 },
401 nesting => {
402 optional => 1,
403 type => 'boolean',
404 default => 0,
405 description => "Allow nesting."
406 ." Best used with unprivileged containers with additional id mapping."
407 ." Note that this will expose procfs and sysfs contents of the host"
408 ." to the guest.",
409 },
410 keyctl => {
411 optional => 1,
412 type => 'boolean',
413 default => 0,
414 description => "For unprivileged containers only: Allow the use of the keyctl() system call."
415 ." This is required to use docker inside a container."
416 ." By default unprivileged containers will see this system call as non-existent."
417 ." This is mostly a workaround for systemd-networkd, as it will treat it as a fatal"
418 ." error when some keyctl() operations are denied by the kernel due to lacking permissions."
419 ." Essentially, you can choose between running systemd-networkd or docker.",
420 },
96f8d2a2
WB
421 fuse => {
422 optional => 1,
423 type => 'boolean',
424 default => 0,
425 description => "Allow using 'fuse' file systems in a container."
426 ." Note that interactions between fuse and the freezer cgroup can potentially cause I/O deadlocks.",
427 },
2df08734
WB
428 mknod => {
429 optional => 1,
430 type => 'boolean',
431 default => 0,
432 description => "Allow unprivileged containers to use mknod() to add certain device nodes."
433 ." This requires a kernel with seccomp trap to user space support (5.3 or newer)."
434 ." This is experimental.",
435 },
741b7737
TL
436 force_rw_sys => {
437 optional => 1,
438 type => 'boolean',
439 default => 0,
440 description => "Mount /sys in unprivileged containers as `rw` instead of `mixed`."
441 ." This can break networking under newer (>= v245) systemd-network use."
442 },
5a63f1c5
WB
443};
444
1b4cf758
FG
445my $confdesc = {
446 lock => {
447 optional => 1,
448 type => 'string',
ddce1df5 449 description => "Lock/unlock the container.",
7fc1d9eb 450 enum => [qw(backup create destroyed disk fstrim migrate mounted rollback snapshot snapshot-delete)],
1b4cf758
FG
451 },
452 onboot => {
453 optional => 1,
454 type => 'boolean',
ddce1df5 455 description => "Specifies whether a container will be started during system bootup.",
1b4cf758
FG
456 default => 0,
457 },
458 startup => get_standard_option('pve-startup-order'),
459 template => {
460 optional => 1,
461 type => 'boolean',
462 description => "Enable/disable Template.",
463 default => 0,
464 },
465 arch => {
466 optional => 1,
467 type => 'string',
c7a78752 468 enum => ['amd64', 'i386', 'arm64', 'armhf', 'riscv32', 'riscv64'],
1b4cf758
FG
469 description => "OS architecture type.",
470 default => 'amd64',
471 },
472 ostype => {
473 optional => 1,
474 type => 'string',
6226d010 475 enum => [qw(debian devuan ubuntu centos fedora opensuse archlinux alpine gentoo nixos unmanaged)],
1b4cf758
FG
476 description => "OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.",
477 },
478 console => {
479 optional => 1,
480 type => 'boolean',
481 description => "Attach a console device (/dev/console) to the container.",
482 default => 1,
483 },
484 tty => {
485 optional => 1,
486 type => 'integer',
487 description => "Specify the number of tty available to the container",
488 minimum => 0,
489 maximum => 6,
490 default => 2,
491 },
f2357408
DM
492 cores => {
493 optional => 1,
494 type => 'integer',
495 description => "The number of cores assigned to the container. A container can use all available cores by default.",
496 minimum => 1,
a804f2d1 497 maximum => 8192,
f2357408 498 },
1b4cf758
FG
499 cpulimit => {
500 optional => 1,
501 type => 'number',
064529c3 502 description => "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.",
1b4cf758 503 minimum => 0,
a804f2d1 504 maximum => 8192,
1b4cf758
FG
505 default => 0,
506 },
507 cpuunits => {
508 optional => 1,
509 type => 'integer',
a3d114d7
FE
510 description => "CPU weight for a container, will be clamped to [1, 10000] in cgroup v2.",
511 verbose_description => "CPU weight for a container. Argument is used in the kernel fair "
512 ."scheduler. The larger the number is, the more CPU time this container gets. Number "
513 ."is relative to the weights of all the other running guests.",
1b4cf758
FG
514 minimum => 0,
515 maximum => 500000,
44e1405e 516 default => 'cgroup v1: 1024, cgroup v2: 100',
1b4cf758
FG
517 },
518 memory => {
519 optional => 1,
520 type => 'integer',
ddce1df5 521 description => "Amount of RAM for the container in MB.",
1b4cf758
FG
522 minimum => 16,
523 default => 512,
524 },
525 swap => {
526 optional => 1,
527 type => 'integer',
ddce1df5 528 description => "Amount of SWAP for the container in MB.",
1b4cf758
FG
529 minimum => 0,
530 default => 512,
531 },
532 hostname => {
533 optional => 1,
534 description => "Set a host name for the container.",
535 type => 'string', format => 'dns-name',
536 maxLength => 255,
537 },
538 description => {
539 optional => 1,
540 type => 'string',
422e7a1b
TL
541 description => "Description for the Container. Shown in the web-interface CT's summary."
542 ." This is saved as comment inside the configuration file.",
543 maxLength => 1024 * 8,
1b4cf758
FG
544 },
545 searchdomain => {
546 optional => 1,
547 type => 'string', format => 'dns-name-list',
548 description => "Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.",
549 },
550 nameserver => {
551 optional => 1,
08a58f12 552 type => 'string', format => 'lxc-ip-with-ll-iface-list',
1b4cf758
FG
553 description => "Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.",
554 },
e6e308ae
OB
555 timezone => {
556 optional => 1,
557 type => 'string', format => 'pve-ct-timezone',
558 description => "Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab",
559 },
1b4cf758
FG
560 rootfs => get_standard_option('pve-ct-rootfs'),
561 parent => {
562 optional => 1,
563 type => 'string', format => 'pve-configid',
564 maxLength => 40,
565 description => "Parent snapshot name. This is used internally, and should not be modified.",
566 },
567 snaptime => {
568 optional => 1,
569 description => "Timestamp for snapshots.",
570 type => 'integer',
571 minimum => 0,
572 },
573 cmode => {
574 optional => 1,
575 description => "Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).",
576 type => 'string',
577 enum => ['shell', 'console', 'tty'],
578 default => 'tty',
579 },
580 protection => {
581 optional => 1,
582 type => 'boolean',
583 description => "Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.",
584 default => 0,
585 },
586 unprivileged => {
587 optional => 1,
588 type => 'boolean',
589 description => "Makes the container run as unprivileged user. (Should not be modified manually.)",
590 default => 0,
591 },
5a63f1c5
WB
592 features => {
593 optional => 1,
594 type => 'string',
595 format => $features_desc,
596 description => "Allow containers access to advanced features.",
597 },
1a416433
DC
598 hookscript => {
599 optional => 1,
600 type => 'string',
601 format => 'pve-volume-id',
602 description => 'Script that will be exectued during various steps in the containers lifetime.',
603 },
733e52ec
DC
604 tags => {
605 type => 'string', format => 'pve-tag-list',
606 description => 'Tags of the Container. This is only meta information.',
607 optional => 1,
608 },
cc9967d2
TL
609 debug => {
610 optional => 1,
611 type => 'boolean',
612 description => "Try to be more verbose. For now this only enables debug log-level on start.",
613 default => 0,
614 },
1b4cf758
FG
615};
616
617my $valid_lxc_conf_keys = {
108c6cab
WB
618 'lxc.apparmor.profile' => 1,
619 'lxc.apparmor.allow_incomplete' => 1,
d494e03c
WB
620 'lxc.apparmor.allow_nesting' => 1,
621 'lxc.apparmor.raw' => 1,
108c6cab 622 'lxc.selinux.context' => 1,
1b4cf758
FG
623 'lxc.include' => 1,
624 'lxc.arch' => 1,
108c6cab
WB
625 'lxc.uts.name' => 1,
626 'lxc.signal.halt' => 1,
627 'lxc.signal.reboot' => 1,
628 'lxc.signal.stop' => 1,
629 'lxc.init.cmd' => 1,
630 'lxc.pty.max' => 1,
1b4cf758 631 'lxc.console.logfile' => 1,
108c6cab
WB
632 'lxc.console.path' => 1,
633 'lxc.tty.max' => 1,
634 'lxc.devtty.dir' => 1,
1b4cf758
FG
635 'lxc.hook.autodev' => 1,
636 'lxc.autodev' => 1,
637 'lxc.kmsg' => 1,
108c6cab 638 'lxc.mount.fstab' => 1,
1b4cf758
FG
639 'lxc.mount.entry' => 1,
640 'lxc.mount.auto' => 1,
108c6cab 641 'lxc.rootfs.path' => 'lxc.rootfs.path is auto generated from rootfs',
1b4cf758
FG
642 'lxc.rootfs.mount' => 1,
643 'lxc.rootfs.options' => 'lxc.rootfs.options is not supported' .
235dbdf3 644 ', please use mount point options in the "rootfs" key',
1b4cf758 645 # lxc.cgroup.*
108c6cab 646 # lxc.prlimit.*
6eb23d1e 647 # lxc.net.*
1b4cf758
FG
648 'lxc.cap.drop' => 1,
649 'lxc.cap.keep' => 1,
108c6cab 650 'lxc.seccomp.profile' => 1,
832b4a02
WB
651 'lxc.seccomp.notify.proxy' => 1,
652 'lxc.seccomp.notify.cookie' => 1,
108c6cab 653 'lxc.idmap' => 1,
1b4cf758
FG
654 'lxc.hook.pre-start' => 1,
655 'lxc.hook.pre-mount' => 1,
656 'lxc.hook.mount' => 1,
657 'lxc.hook.start' => 1,
658 'lxc.hook.stop' => 1,
659 'lxc.hook.post-stop' => 1,
660 'lxc.hook.clone' => 1,
661 'lxc.hook.destroy' => 1,
f71db91b 662 'lxc.hook.version' => 1,
108c6cab
WB
663 'lxc.log.level' => 1,
664 'lxc.log.file' => 1,
1b4cf758
FG
665 'lxc.start.auto' => 1,
666 'lxc.start.delay' => 1,
667 'lxc.start.order' => 1,
668 'lxc.group' => 1,
669 'lxc.environment' => 1,
d4a135f7
WB
670
671 # All these are namespaced via CLONE_NEWIPC (see namespaces(7)).
672 'lxc.sysctl.fs.mqueue' => 1,
673 'lxc.sysctl.kernel.msgmax' => 1,
674 'lxc.sysctl.kernel.msgmnb' => 1,
675 'lxc.sysctl.kernel.msgmni' => 1,
676 'lxc.sysctl.kernel.sem' => 1,
677 'lxc.sysctl.kernel.shmall' => 1,
678 'lxc.sysctl.kernel.shmmax' => 1,
679 'lxc.sysctl.kernel.shmmni' => 1,
680 'lxc.sysctl.kernel.shm_rmid_forced' => 1,
1b4cf758
FG
681};
682
108c6cab
WB
683my $deprecated_lxc_conf_keys = {
684 # Deprecated (removed with lxc 3.0):
685 'lxc.aa_profile' => 'lxc.apparmor.profile',
686 'lxc.aa_allow_incomplete' => 'lxc.apparmor.allow_incomplete',
687 'lxc.console' => 'lxc.console.path',
688 'lxc.devttydir' => 'lxc.tty.dir',
689 'lxc.haltsignal' => 'lxc.signal.halt',
690 'lxc.rebootsignal' => 'lxc.signal.reboot',
691 'lxc.stopsignal' => 'lxc.signal.stop',
692 'lxc.id_map' => 'lxc.idmap',
693 'lxc.init_cmd' => 'lxc.init.cmd',
694 'lxc.loglevel' => 'lxc.log.level',
695 'lxc.logfile' => 'lxc.log.file',
696 'lxc.mount' => 'lxc.mount.fstab',
697 'lxc.network.type' => 'lxc.net.INDEX.type',
698 'lxc.network.flags' => 'lxc.net.INDEX.flags',
699 'lxc.network.link' => 'lxc.net.INDEX.link',
700 'lxc.network.mtu' => 'lxc.net.INDEX.mtu',
701 'lxc.network.name' => 'lxc.net.INDEX.name',
702 'lxc.network.hwaddr' => 'lxc.net.INDEX.hwaddr',
703 'lxc.network.ipv4' => 'lxc.net.INDEX.ipv4.address',
704 'lxc.network.ipv4.gateway' => 'lxc.net.INDEX.ipv4.gateway',
705 'lxc.network.ipv6' => 'lxc.net.INDEX.ipv6.address',
706 'lxc.network.ipv6.gateway' => 'lxc.net.INDEX.ipv6.gateway',
707 'lxc.network.script.up' => 'lxc.net.INDEX.script.up',
708 'lxc.network.script.down' => 'lxc.net.INDEX.script.down',
709 'lxc.pts' => 'lxc.pty.max',
710 'lxc.se_context' => 'lxc.selinux.context',
711 'lxc.seccomp' => 'lxc.seccomp.profile',
712 'lxc.tty' => 'lxc.tty.max',
713 'lxc.utsname' => 'lxc.uts.name',
714};
715
716sub is_valid_lxc_conf_key {
717 my ($vmid, $key) = @_;
718 if ($key =~ /^lxc\.limit\./) {
719 warn "vm $vmid - $key: lxc.limit.* was renamed to lxc.prlimit.*\n";
720 return 1;
721 }
722 if (defined(my $new_name = $deprecated_lxc_conf_keys->{$key})) {
723 warn "vm $vmid - $key is deprecated and was renamed to $new_name\n";
724 return 1;
725 }
726 my $validity = $valid_lxc_conf_keys->{$key};
727 return $validity if defined($validity);
979ea389 728 return 1 if $key =~ /^lxc\.cgroup2?\./ # allow all cgroup values
108c6cab
WB
729 || $key =~ /^lxc\.prlimit\./ # allow all prlimits
730 || $key =~ /^lxc\.net\./; # allow custom network definitions
731 return 0;
732}
733
5e5915c5 734our $netconf_desc = {
1b4cf758
FG
735 type => {
736 type => 'string',
737 optional => 1,
738 description => "Network interface type.",
739 enum => [qw(veth)],
740 },
741 name => {
742 type => 'string',
a069f163
DM
743 format_description => 'string',
744 description => 'Name of the network device as seen from inside the container. (lxc.network.name)',
1b4cf758
FG
745 pattern => '[-_.\w\d]+',
746 },
747 bridge => {
748 type => 'string',
a069f163 749 format_description => 'bridge',
1b4cf758
FG
750 description => 'Bridge to attach the network device to.',
751 pattern => '[-_.\w\d]+',
752 optional => 1,
753 },
603536e0 754 hwaddr => get_standard_option('mac-addr', {
e6f20294 755 description => 'The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr)',
603536e0 756 }),
1b4cf758
FG
757 mtu => {
758 type => 'integer',
1b4cf758
FG
759 description => 'Maximum transfer unit of the interface. (lxc.network.mtu)',
760 minimum => 64, # minimum ethernet frame is 64 bytes
5fbd58cb 761 maximum => 65535,
1b4cf758
FG
762 optional => 1,
763 },
764 ip => {
765 type => 'string',
766 format => 'pve-ipv4-config',
718a67d6 767 format_description => '(IPv4/CIDR|dhcp|manual)',
1b4cf758
FG
768 description => 'IPv4 address in CIDR format.',
769 optional => 1,
770 },
771 gw => {
772 type => 'string',
773 format => 'ipv4',
774 format_description => 'GatewayIPv4',
775 description => 'Default gateway for IPv4 traffic.',
776 optional => 1,
777 },
778 ip6 => {
779 type => 'string',
780 format => 'pve-ipv6-config',
6ea7095c 781 format_description => '(IPv6/CIDR|auto|dhcp|manual)',
1b4cf758
FG
782 description => 'IPv6 address in CIDR format.',
783 optional => 1,
784 },
785 gw6 => {
786 type => 'string',
787 format => 'ipv6',
788 format_description => 'GatewayIPv6',
789 description => 'Default gateway for IPv6 traffic.',
790 optional => 1,
791 },
792 firewall => {
793 type => 'boolean',
1b4cf758
FG
794 description => "Controls whether this interface's firewall rules should be used.",
795 optional => 1,
796 },
797 tag => {
798 type => 'integer',
6b202dd5
DM
799 minimum => 1,
800 maximum => 4094,
1b4cf758
FG
801 description => "VLAN tag for this interface.",
802 optional => 1,
803 },
804 trunks => {
805 type => 'string',
806 pattern => qr/\d+(?:;\d+)*/,
807 format_description => 'vlanid[;vlanid...]',
808 description => "VLAN ids to pass through the interface",
809 optional => 1,
810 },
380962c7
WB
811 rate => {
812 type => 'number',
813 format_description => 'mbps',
814 description => "Apply rate limiting to the interface",
815 optional => 1,
816 },
9e569488
CH
817 # TODO: Rename this option and the qemu-server one to `link-down` for PVE 8.0
818 link_down => {
819 type => 'boolean',
820 description => 'Whether this interface should be disconnected (like pulling the plug).',
821 optional => 1,
822 },
1b4cf758
FG
823};
824PVE::JSONSchema::register_format('pve-lxc-network', $netconf_desc);
825
6dd2d4cd 826my $MAX_LXC_NETWORKS = 32;
1b4cf758
FG
827for (my $i = 0; $i < $MAX_LXC_NETWORKS; $i++) {
828 $confdesc->{"net$i"} = {
829 optional => 1,
830 type => 'string', format => $netconf_desc,
831 description => "Specifies network interfaces for the container.",
832 };
833}
834
e6e308ae
OB
835PVE::JSONSchema::register_format('pve-ct-timezone', \&verify_ct_timezone);
836sub verify_ct_timezone {
837 my ($timezone, $noerr) = @_;
838
839 return if $timezone eq 'host'; # using host settings
840
841 PVE::JSONSchema::pve_verify_timezone($timezone);
842}
843
1b4cf758
FG
844PVE::JSONSchema::register_format('pve-lxc-mp-string', \&verify_lxc_mp_string);
845sub verify_lxc_mp_string {
846 my ($mp, $noerr) = @_;
847
848 # do not allow:
849 # /./ or /../
850 # /. or /.. at the end
851 # ../ at the beginning
852
853 if($mp =~ m@/\.\.?/@ ||
854 $mp =~ m@/\.\.?$@ ||
855 $mp =~ m@^\.\./@) {
856 return undef if $noerr;
857 die "$mp contains illegal character sequences\n";
858 }
859 return $mp;
860}
861
862my $mp_desc = {
863 %$rootfs_desc,
84820d40
DM
864 backup => {
865 type => 'boolean',
235dbdf3
FG
866 description => 'Whether to include the mount point in backups.',
867 verbose_description => 'Whether to include the mount point in backups '.
868 '(only used for volume mount points).',
84820d40
DM
869 optional => 1,
870 },
1b4cf758
FG
871 mp => {
872 type => 'string',
873 format => 'pve-lxc-mp-string',
874 format_description => 'Path',
235dbdf3 875 description => 'Path to the mount point as seen from inside the container '.
52b6f941 876 '(must not contain symlinks).',
235dbdf3 877 verbose_description => "Path to the mount point as seen from inside the container.\n\n".
52b6f941 878 "NOTE: Must not contain any symlinks for security reasons."
1b4cf758
FG
879 },
880};
881PVE::JSONSchema::register_format('pve-ct-mountpoint', $mp_desc);
882
9dabb518
FE
883my $unused_desc = {
884 volume => {
885 type => 'string',
886 default_key => 1,
887 format => 'pve-volume-id',
888 format_description => 'volume',
889 description => 'The volume that is not used currently.',
890 }
1b4cf758
FG
891};
892
893for (my $i = 0; $i < $MAX_MOUNT_POINTS; $i++) {
894 $confdesc->{"mp$i"} = {
895 optional => 1,
896 type => 'string', format => $mp_desc,
f2593307
FE
897 description => "Use volume as container mount point. Use the special " .
898 "syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.",
1b4cf758
FG
899 optional => 1,
900 };
901}
902
9dabb518
FE
903for (my $i = 0; $i < $MAX_UNUSED_DISKS; $i++) {
904 $confdesc->{"unused$i"} = {
905 optional => 1,
906 type => 'string', format => $unused_desc,
907 description => "Reference to unused volumes. This is used internally, and should not be modified manually.",
908 }
1b4cf758
FG
909}
910
911sub parse_pct_config {
3f031adb 912 my ($filename, $raw, $strict) = @_;
1b4cf758
FG
913
914 return undef if !defined($raw);
915
916 my $res = {
917 digest => Digest::SHA::sha1_hex($raw),
918 snapshots => {},
7547dc63 919 pending => {},
1b4cf758
FG
920 };
921
3f031adb
FG
922 my $handle_error = sub {
923 my ($msg) = @_;
924
925 if ($strict) {
926 die $msg;
927 } else {
928 warn $msg;
929 }
930 };
931
1b4cf758
FG
932 $filename =~ m|/lxc/(\d+).conf$|
933 || die "got strange filename '$filename'";
934
935 my $vmid = $1;
936
937 my $conf = $res;
938 my $descr = '';
939 my $section = '';
940
941 my @lines = split(/\n/, $raw);
942 foreach my $line (@lines) {
943 next if $line =~ m/^\s*$/;
944
7547dc63
OB
945 if ($line =~ m/^\[pve:pending\]\s*$/i) {
946 $section = 'pending';
947 $conf->{description} = $descr if $descr;
948 $descr = '';
949 $conf = $res->{$section} = {};
950 next;
951 } elsif ($line =~ m/^\[([a-z][a-z0-9_\-]+)\]\s*$/i) {
1b4cf758
FG
952 $section = $1;
953 $conf->{description} = $descr if $descr;
954 $descr = '';
955 $conf = $res->{snapshots}->{$section} = {};
956 next;
957 }
958
6f0d5e63 959 if ($line =~ m/^\#(.*)$/) {
1b4cf758
FG
960 $descr .= PVE::Tools::decode_text($1) . "\n";
961 next;
962 }
963
964 if ($line =~ m/^(lxc\.[a-z0-9_\-\.]+)(:|\s*=)\s*(.*?)\s*$/) {
965 my $key = $1;
966 my $value = $3;
108c6cab
WB
967 my $validity = is_valid_lxc_conf_key($vmid, $key);
968 if ($validity eq 1) {
1b4cf758
FG
969 push @{$conf->{lxc}}, [$key, $value];
970 } elsif (my $errmsg = $validity) {
3f031adb 971 $handle_error->("vm $vmid - $key: $errmsg\n");
1b4cf758 972 } else {
3f031adb 973 $handle_error->("vm $vmid - unable to parse config: $line\n");
1b4cf758
FG
974 }
975 } elsif ($line =~ m/^(description):\s*(.*\S)\s*$/) {
976 $descr .= PVE::Tools::decode_text($2);
977 } elsif ($line =~ m/snapstate:\s*(prepare|delete)\s*$/) {
978 $conf->{snapstate} = $1;
7547dc63
OB
979 } elsif ($line =~ m/^delete:\s*(.*\S)\s*$/) {
980 my $value = $1;
981 if ($section eq 'pending') {
982 $conf->{delete} = $value;
983 } else {
3f031adb 984 $handle_error->("vm $vmid - property 'delete' is only allowed in [pve:pending]\n");
7547dc63 985 }
648529ba 986 } elsif ($line =~ m/^([a-z][a-z_]*\d*):\s*(.+?)\s*$/) {
1b4cf758
FG
987 my $key = $1;
988 my $value = $2;
989 eval { $value = PVE::LXC::Config->check_type($key, $value); };
3f031adb 990 $handle_error->("vm $vmid - unable to parse value of '$key' - $@") if $@;
1b4cf758
FG
991 $conf->{$key} = $value;
992 } else {
3f031adb 993 $handle_error->("vm $vmid - unable to parse config: $line\n");
1b4cf758
FG
994 }
995 }
996
997 $conf->{description} = $descr if $descr;
998
999 delete $res->{snapstate}; # just to be sure
1000
1001 return $res;
1002}
1003
1004sub write_pct_config {
1005 my ($filename, $conf) = @_;
1006
1007 delete $conf->{snapstate}; # just to be sure
1008
1009 my $volidlist = PVE::LXC::Config->get_vm_volumes($conf);
1010 my $used_volids = {};
1011 foreach my $vid (@$volidlist) {
1012 $used_volids->{$vid} = 1;
1013 }
1014
1015 # remove 'unusedX' settings if the volume is still used
1016 foreach my $key (keys %$conf) {
1017 my $value = $conf->{$key};
1018 if ($key =~ m/^unused/ && $used_volids->{$value}) {
1019 delete $conf->{$key};
1020 }
1021 }
1022
1023 my $generate_raw_config = sub {
1024 my ($conf) = @_;
1025
1026 my $raw = '';
1027
1028 # add description as comment to top of file
1029 my $descr = $conf->{description} || '';
1030 foreach my $cl (split(/\n/, $descr)) {
7547dc63 1031 $raw .= '#' . PVE::Tools::encode_text($cl) . "\n";
1b4cf758
FG
1032 }
1033
1034 foreach my $key (sort keys %$conf) {
1035 next if $key eq 'digest' || $key eq 'description' ||
1036 $key eq 'pending' || $key eq 'snapshots' ||
1037 $key eq 'snapname' || $key eq 'lxc';
1038 my $value = $conf->{$key};
1039 die "detected invalid newline inside property '$key'\n"
1040 if $value =~ m/\n/;
1041 $raw .= "$key: $value\n";
1042 }
1043
1044 if (my $lxcconf = $conf->{lxc}) {
1045 foreach my $entry (@$lxcconf) {
1046 my ($k, $v) = @$entry;
1047 $raw .= "$k: $v\n";
1048 }
1049 }
1050
1051 return $raw;
1052 };
1053
1054 my $raw = &$generate_raw_config($conf);
1055
7547dc63
OB
1056 if (scalar(keys %{$conf->{pending}})){
1057 $raw .= "\n[pve:pending]\n";
1058 $raw .= &$generate_raw_config($conf->{pending});
1059 }
1060
1b4cf758
FG
1061 foreach my $snapname (sort keys %{$conf->{snapshots}}) {
1062 $raw .= "\n[$snapname]\n";
1063 $raw .= &$generate_raw_config($conf->{snapshots}->{$snapname});
1064 }
1065
1066 return $raw;
1067}
1068
1069sub update_pct_config {
6517e001 1070 my ($class, $vmid, $conf, $running, $param, $delete, $revert) = @_;
1b4cf758 1071
6517e001 1072 my $storage_cfg = PVE::Storage::config();
1b4cf758 1073
6517e001
OB
1074 foreach my $opt (@$revert) {
1075 delete $conf->{pending}->{$opt};
1076 $class->remove_from_pending_delete($conf, $opt); # also remove from deletion queue
1b4cf758
FG
1077 }
1078
6517e001
OB
1079 # write updates to pending section
1080 my $modified = {}; # record modified options
1b4cf758 1081
6517e001
OB
1082 foreach my $opt (@$delete) {
1083 if (!defined($conf->{$opt}) && !defined($conf->{pending}->{$opt})) {
1084 warn "cannot delete '$opt' - not set in current configuration!\n";
1085 next;
1b4cf758 1086 }
6517e001
OB
1087 $modified->{$opt} = 1;
1088 if ($opt eq 'memory' || $opt eq 'rootfs' || $opt eq 'ostype') {
1089 die "unable to delete required option '$opt'\n";
1090 } elsif ($opt =~ m/^unused(\d+)$/) {
1091 $class->check_protection($conf, "can't remove CT $vmid drive '$opt'");
1092 } elsif ($opt =~ m/^mp(\d+)$/) {
1093 $class->check_protection($conf, "can't remove CT $vmid drive '$opt'");
1094 } elsif ($opt eq 'unprivileged') {
1095 die "unable to delete read-only option: '$opt'\n";
1b4cf758 1096 }
6517e001 1097 $class->add_to_pending_delete($conf, $opt);
1b4cf758
FG
1098 }
1099
1b3213ae
FG
1100 my $check_content_type = sub {
1101 my ($mp) = @_;
1102 my $sid = PVE::Storage::parse_volume_id($mp->{volume});
6517e001 1103 my $storage_config = PVE::Storage::storage_config($storage_cfg, $sid);
1b3213ae
FG
1104 die "storage '$sid' does not allow content type 'rootdir' (Container)\n"
1105 if !$storage_config->{content}->{rootdir};
1106 };
1b4cf758 1107
c10951f7 1108 foreach my $opt (sort keys %$param) { # add/change
6517e001 1109 $modified->{$opt} = 1;
1b4cf758 1110 my $value = $param->{$opt};
6517e001
OB
1111 if ($opt =~ m/^mp(\d+)$/ || $opt eq 'rootfs') {
1112 $class->check_protection($conf, "can't update CT $vmid drive '$opt'");
e4034859 1113 my $mp = $class->parse_volume($opt, $value);
3927ae96 1114 $check_content_type->($mp) if ($mp->{type} eq 'volume');
6517e001
OB
1115 } elsif ($opt eq 'hookscript') {
1116 PVE::GuestHelpers::check_hookscript($value);
1b4cf758 1117 } elsif ($opt eq 'nameserver') {
6517e001 1118 $value = PVE::LXC::verify_nameserver_list($value);
1b4cf758 1119 } elsif ($opt eq 'searchdomain') {
6517e001 1120 $value = PVE::LXC::verify_searchdomain_list($value);
1b4cf758
FG
1121 } elsif ($opt eq 'unprivileged') {
1122 die "unable to modify read-only option: '$opt'\n";
9a6af580
TL
1123 } elsif ($opt eq 'tags') {
1124 $value = PVE::GuestHelpers::get_unique_tags($value);
5fbd58cb
DT
1125 } elsif ($opt =~ m/^net(\d+)$/) {
1126 my $res = PVE::JSONSchema::parse_property_string($netconf_desc, $value);
1127
1128 if (my $mtu = $res->{mtu}) {
1129 my $bridge_mtu = PVE::Network::read_bridge_mtu($res->{bridge});
1130 die "$opt: MTU size '$mtu' is bigger than bridge MTU '$bridge_mtu'\n"
1131 if ($mtu > $bridge_mtu);
1132 }
1b4cf758 1133 }
6517e001
OB
1134 $conf->{pending}->{$opt} = $value;
1135 $class->remove_from_pending_delete($conf, $opt);
f8aa3d35
WL
1136 }
1137
6517e001 1138 my $changes = $class->cleanup_pending($conf);
1b4cf758 1139
6517e001
OB
1140 my $errors = {};
1141 if ($running) {
1142 $class->vmconfig_hotplug_pending($vmid, $conf, $storage_cfg, $modified, $errors);
1143 } else {
1144 $class->vmconfig_apply_pending($vmid, $conf, $storage_cfg, $modified, $errors);
1b4cf758
FG
1145 }
1146
6517e001 1147 return $errors;
1b4cf758
FG
1148}
1149
1150sub check_type {
1151 my ($class, $key, $value) = @_;
1152
1153 die "unknown setting '$key'\n" if !$confdesc->{$key};
1154
1155 my $type = $confdesc->{$key}->{type};
1156
1157 if (!defined($value)) {
1158 die "got undefined value\n";
1159 }
1160
1161 if ($value =~ m/[\n\r]/) {
1162 die "property contains a line feed\n";
1163 }
1164
1165 if ($type eq 'boolean') {
1166 return 1 if ($value eq '1') || ($value =~ m/^(on|yes|true)$/i);
1167 return 0 if ($value eq '0') || ($value =~ m/^(off|no|false)$/i);
1168 die "type check ('boolean') failed - got '$value'\n";
1169 } elsif ($type eq 'integer') {
1170 return int($1) if $value =~ m/^(\d+)$/;
1171 die "type check ('integer') failed - got '$value'\n";
1172 } elsif ($type eq 'number') {
1173 return $value if $value =~ m/^(\d+)(\.\d+)?$/;
1174 die "type check ('number') failed - got '$value'\n";
1175 } elsif ($type eq 'string') {
1176 if (my $fmt = $confdesc->{$key}->{format}) {
1177 PVE::JSONSchema::check_format($fmt, $value);
1178 return $value;
1179 }
1180 return $value;
1181 } else {
1182 die "internal error"
1183 }
1184}
1185
1186
1187# add JSON properties for create and set function
1188sub json_config_properties {
1189 my ($class, $prop) = @_;
1190
1191 foreach my $opt (keys %$confdesc) {
1192 next if $opt eq 'parent' || $opt eq 'snaptime';
1193 next if $prop->{$opt};
1194 $prop->{$opt} = $confdesc->{$opt};
1195 }
1196
1197 return $prop;
1198}
1199
c0a17956 1200my $parse_ct_mountpoint_full = sub {
1b4cf758
FG
1201 my ($class, $desc, $data, $noerr) = @_;
1202
1203 $data //= '';
1204
1205 my $res;
1206 eval { $res = PVE::JSONSchema::parse_property_string($desc, $data) };
1207 if ($@) {
1208 return undef if $noerr;
1209 die $@;
1210 }
1211
1212 if (defined(my $size = $res->{size})) {
1213 $size = PVE::JSONSchema::parse_size($size);
1214 if (!defined($size)) {
1215 return undef if $noerr;
1216 die "invalid size: $size\n";
1217 }
1218 $res->{size} = $size;
1219 }
1220
1221 $res->{type} = $class->classify_mountpoint($res->{volume});
1222
1223 return $res;
1224};
1225
1b4cf758
FG
1226sub print_ct_mountpoint {
1227 my ($class, $info, $nomp) = @_;
1228 my $skip = [ 'type' ];
1229 push @$skip, 'mp' if $nomp;
1230 return PVE::JSONSchema::print_property_string($info, $mp_desc, $skip);
1231}
1232
a66c8869
FE
1233sub print_ct_unused {
1234 my ($class, $info) = @_;
1235
1236 my $skip = [ 'type' ];
1237 return PVE::JSONSchema::print_property_string($info, $unused_desc, $skip);
1238}
1239
5e5d76cf
FE
1240sub parse_volume {
1241 my ($class, $key, $volume_string, $noerr) = @_;
1242
1243 if ($key eq 'rootfs') {
c0a17956 1244 my $res = $parse_ct_mountpoint_full->($class, $rootfs_desc, $volume_string, $noerr);
e4034859
FE
1245 $res->{mp} = '/' if defined($res);
1246 return $res;
9dabb518 1247 } elsif ($key =~ m/^mp\d+$/) {
c0a17956 1248 return $parse_ct_mountpoint_full->($class, $mp_desc, $volume_string, $noerr);
9dabb518
FE
1249 } elsif ($key =~ m/^unused\d+$/) {
1250 return $parse_ct_mountpoint_full->($class, $unused_desc, $volume_string, $noerr);
5e5d76cf
FE
1251 }
1252
c2be33b8
FE
1253 die "parse_volume - unknown type: $key\n" if !$noerr;
1254
1255 return;
5e5d76cf
FE
1256}
1257
1258sub print_volume {
1259 my ($class, $key, $volume) = @_;
1260
a66c8869
FE
1261 return $class->print_ct_unused($volume) if $key =~ m/^unused(\d+)$/;
1262
5e5d76cf
FE
1263 return $class->print_ct_mountpoint($volume, $key eq 'rootfs');
1264}
1265
1266sub volid_key {
1267 my ($class) = @_;
1268
1269 return 'volume';
1270}
1271
1b4cf758
FG
1272sub print_lxc_network {
1273 my ($class, $net) = @_;
1274 return PVE::JSONSchema::print_property_string($net, $netconf_desc);
1275}
1276
1277sub parse_lxc_network {
1278 my ($class, $data) = @_;
1279
f89af842 1280 return {} if !$data;
1b4cf758 1281
f89af842 1282 my $res = PVE::JSONSchema::parse_property_string($netconf_desc, $data);
1b4cf758
FG
1283
1284 $res->{type} = 'veth';
2f19133b
WB
1285 if (!$res->{hwaddr}) {
1286 my $dc = PVE::Cluster::cfs_read_file('datacenter.cfg');
1287 $res->{hwaddr} = PVE::Tools::random_ether_addr($dc->{mac_prefix});
1288 }
1b4cf758
FG
1289
1290 return $res;
1291}
1292
5a63f1c5
WB
1293sub parse_features {
1294 my ($class, $data) = @_;
1295 return {} if !$data;
1296 return PVE::JSONSchema::parse_property_string($features_desc, $data);
1297}
1298
1b4cf758
FG
1299sub option_exists {
1300 my ($class, $name) = @_;
1301
1302 return defined($confdesc->{$name});
1303}
1304# END JSON config code
1305
926b193e
TL
1306# takes a max memory value as KiB and returns an tuple with max and high values
1307sub calculate_memory_constraints {
1308 my ($memory) = @_;
1309
1310 return if !defined($memory);
1311
1312 # cgroup memory usage is limited by the hard 'max' limit (OOM-killer enforced) and the soft
1313 # 'high' limit (cgroup processes get throttled and put under heavy reclaim pressure).
1314 my $memory_max = int($memory * 1024 * 1024);
1315 # Set the high to 1016/1024 (~99.2%) of the 'max' hard limit clamped to 128 MiB max, to scale
1316 # it for the lower range while having a decent 2^x based rest for 2^y memory configs.
1317 my $memory_high = $memory >= 16 * 1024 ? int(($memory - 128) * 1024 * 1024) : int($memory * 1024 * 1016);
1318
1319 return ($memory_max, $memory_high);
1320}
1321
32e15a2b
OB
1322my $LXC_FASTPLUG_OPTIONS= {
1323 'description' => 1,
1324 'onboot' => 1,
1325 'startup' => 1,
1326 'protection' => 1,
1327 'hostname' => 1,
1328 'hookscript' => 1,
1329 'cores' => 1,
1330 'tags' => 1,
db15c375 1331 'lock' => 1,
32e15a2b
OB
1332};
1333
1334sub vmconfig_hotplug_pending {
1335 my ($class, $vmid, $conf, $storecfg, $selection, $errors) = @_;
1336
1337 my $pid = PVE::LXC::find_lxc_pid($vmid);
1338 my $rootdir = "/proc/$pid/root";
1339
1340 my $add_hotplug_error = sub {
1341 my ($opt, $msg) = @_;
1342 $errors->{$opt} = "unable to hotplug $opt: $msg";
1343 };
1344
c10951f7 1345 foreach my $opt (sort keys %{$conf->{pending}}) { # add/change
32e15a2b
OB
1346 next if $selection && !$selection->{$opt};
1347 if ($LXC_FASTPLUG_OPTIONS->{$opt}) {
1348 $conf->{$opt} = delete $conf->{pending}->{$opt};
32e15a2b
OB
1349 }
1350 }
1351
2a4fddef
WB
1352 my $cgroup = PVE::LXC::CGroup->new($vmid);
1353
32e15a2b
OB
1354 # There's no separate swap size to configure, there's memory and "total"
1355 # memory (iow. memory+swap). This means we have to change them together.
1356 my $hotplug_memory_done;
1357 my $hotplug_memory = sub {
926b193e 1358 my ($new_memory, $new_swap) = @_;
2a4fddef 1359
926b193e
TL
1360 ($new_memory, my $new_memory_high) = calculate_memory_constraints($new_memory);
1361 $new_swap = int($new_swap * 1024 * 1024) if defined($new_swap);
1362 $cgroup->change_memory_limit($new_memory, $new_swap, $new_memory_high);
2a4fddef 1363
32e15a2b
OB
1364 $hotplug_memory_done = 1;
1365 };
1366
1367 my $pending_delete_hash = $class->parse_pending_delete($conf->{pending}->{delete});
1368 # FIXME: $force deletion is not implemented for CTs
8ec10817 1369 foreach my $opt (sort keys %$pending_delete_hash) {
32e15a2b
OB
1370 next if $selection && !$selection->{$opt};
1371 eval {
1372 if ($LXC_FASTPLUG_OPTIONS->{$opt}) {
1373 # pass
1374 } elsif ($opt =~ m/^unused(\d+)$/) {
1375 PVE::LXC::delete_mountpoint_volume($storecfg, $vmid, $conf->{$opt})
1376 if !$class->is_volume_in_use($conf, $conf->{$opt}, 1, 1);
1377 } elsif ($opt eq 'swap') {
1378 $hotplug_memory->(undef, 0);
1379 } elsif ($opt eq 'cpulimit') {
04a62bd0 1380 $cgroup->change_cpu_quota(undef, undef); # reset, cgroup module can better decide values
32e15a2b 1381 } elsif ($opt eq 'cpuunits') {
c439efab 1382 $cgroup->change_cpu_shares(undef);
32e15a2b
OB
1383 } elsif ($opt =~ m/^net(\d)$/) {
1384 my $netid = $1;
1385 PVE::Network::veth_delete("veth${vmid}i$netid");
1386 } else {
1387 die "skip\n"; # skip non-hotpluggable opts
1388 }
1389 };
1390 if (my $err = $@) {
1391 $add_hotplug_error->($opt, $err) if $err ne "skip\n";
1392 } else {
1393 delete $conf->{$opt};
1394 $class->remove_from_pending_delete($conf, $opt);
1395 }
1396 }
1397
c10951f7 1398 foreach my $opt (sort keys %{$conf->{pending}}) {
32e15a2b
OB
1399 next if $opt eq 'delete'; # just to be sure
1400 next if $selection && !$selection->{$opt};
1401 my $value = $conf->{pending}->{$opt};
1402 eval {
1403 if ($opt eq 'cpulimit') {
6e8ce610
WB
1404 my $quota = 100000 * $value;
1405 $cgroup->change_cpu_quota(int(100000 * $value), 100000);
32e15a2b 1406 } elsif ($opt eq 'cpuunits') {
c439efab 1407 $cgroup->change_cpu_shares($value);
32e15a2b
OB
1408 } elsif ($opt =~ m/^net(\d+)$/) {
1409 my $netid = $1;
1410 my $net = $class->parse_lxc_network($value);
7eff309b 1411 $value = $class->print_lxc_network($net);
32e15a2b
OB
1412 PVE::LXC::update_net($vmid, $conf, $opt, $net, $netid, $rootdir);
1413 } elsif ($opt eq 'memory' || $opt eq 'swap') {
1414 if (!$hotplug_memory_done) { # don't call twice if both opts are passed
1415 $hotplug_memory->($conf->{pending}->{memory}, $conf->{pending}->{swap});
1416 }
b2de4c04
WB
1417 } elsif ($opt =~ m/^mp(\d+)$/) {
1418 if (!PVE::LXC::Tools::can_use_new_mount_api()) {
1419 die "skip\n";
1420 }
1421
c7ce07e0
OB
1422 if (exists($conf->{$opt})) {
1423 die "skip\n"; # don't try to hotplug over existing mp
1424 }
1425
b2de4c04
WB
1426 $class->apply_pending_mountpoint($vmid, $conf, $opt, $storecfg, 1);
1427 # apply_pending_mountpoint modifies the value if it creates a new disk
1428 $value = $conf->{pending}->{$opt};
32e15a2b
OB
1429 } else {
1430 die "skip\n"; # skip non-hotpluggable
1431 }
1432 };
1433 if (my $err = $@) {
1434 $add_hotplug_error->($opt, $err) if $err ne "skip\n";
1435 } else {
1436 $conf->{$opt} = $value;
1437 delete $conf->{pending}->{$opt};
1438 }
1439 }
32e15a2b
OB
1440}
1441
1442sub vmconfig_apply_pending {
1443 my ($class, $vmid, $conf, $storecfg, $selection, $errors) = @_;
1444
1445 my $add_apply_error = sub {
1446 my ($opt, $msg) = @_;
1447 my $err_msg = "unable to apply pending change $opt : $msg";
1448 $errors->{$opt} = $err_msg;
1449 warn $err_msg;
1450 };
1451
32e15a2b
OB
1452 my $pending_delete_hash = $class->parse_pending_delete($conf->{pending}->{delete});
1453 # FIXME: $force deletion is not implemented for CTs
8ec10817 1454 foreach my $opt (sort keys %$pending_delete_hash) {
32e15a2b 1455 next if $selection && !$selection->{$opt};
32e15a2b
OB
1456 eval {
1457 if ($opt =~ m/^mp(\d+)$/) {
e4034859 1458 my $mp = $class->parse_volume($opt, $conf->{$opt});
32e15a2b
OB
1459 if ($mp->{type} eq 'volume') {
1460 $class->add_unused_volume($conf, $mp->{volume})
1461 if !$class->is_volume_in_use($conf, $conf->{$opt}, 1, 1);
1462 }
1463 } elsif ($opt =~ m/^unused(\d+)$/) {
1464 PVE::LXC::delete_mountpoint_volume($storecfg, $vmid, $conf->{$opt})
1465 if !$class->is_volume_in_use($conf, $conf->{$opt}, 1, 1);
1466 }
1467 };
1468 if (my $err = $@) {
1469 $add_apply_error->($opt, $err);
1470 } else {
1471 delete $conf->{$opt};
1472 $class->remove_from_pending_delete($conf, $opt);
1473 }
1474 }
1475
132c0a90
OB
1476 $class->cleanup_pending($conf);
1477
c10951f7 1478 foreach my $opt (sort keys %{$conf->{pending}}) { # add/change
32e15a2b
OB
1479 next if $opt eq 'delete'; # just to be sure
1480 next if $selection && !$selection->{$opt};
1481 eval {
1482 if ($opt =~ m/^mp(\d+)$/) {
869081a2 1483 $class->apply_pending_mountpoint($vmid, $conf, $opt, $storecfg, 0);
7eff309b
OB
1484 } elsif ($opt =~ m/^net(\d+)$/) {
1485 my $netid = $1;
1486 my $net = $class->parse_lxc_network($conf->{pending}->{$opt});
1487 $conf->{pending}->{$opt} = $class->print_lxc_network($net);
32e15a2b
OB
1488 }
1489 };
1490 if (my $err = $@) {
1491 $add_apply_error->($opt, $err);
1492 } else {
32e15a2b
OB
1493 $conf->{$opt} = delete $conf->{pending}->{$opt};
1494 }
1495 }
32e15a2b
OB
1496}
1497
869081a2
WB
1498my $rescan_volume = sub {
1499 my ($storecfg, $mp) = @_;
1500 eval {
0c69dcfc 1501 $mp->{size} = PVE::Storage::volume_size_info($storecfg, $mp->{volume}, 5);
869081a2
WB
1502 };
1503 warn "Could not rescan volume size - $@\n" if $@;
1504};
1505
1506sub apply_pending_mountpoint {
1507 my ($class, $vmid, $conf, $opt, $storecfg, $running) = @_;
1508
e4034859 1509 my $mp = $class->parse_volume($opt, $conf->{pending}->{$opt});
869081a2 1510 my $old = $conf->{$opt};
ec99cbdc
FE
1511 if ($mp->{type} eq 'volume' && $mp->{volume} =~ $PVE::LXC::NEW_DISK_RE) {
1512 my $original_value = $conf->{pending}->{$opt};
1513 my $vollist = PVE::LXC::create_disks(
1514 $storecfg,
1515 $vmid,
1516 { $opt => $original_value },
1517 $conf,
1518 1,
1519 );
1520 if ($running) {
1521 # Re-parse mount point:
1522 my $mp = $class->parse_volume($opt, $conf->{pending}->{$opt});
1523 eval {
b2de4c04 1524 PVE::LXC::mountpoint_hotplug($vmid, $conf, $opt, $mp, $storecfg);
ec99cbdc
FE
1525 };
1526 my $err = $@;
1527 if ($err) {
1528 PVE::LXC::destroy_disks($storecfg, $vollist);
1529 # The pending-changes code collects errors but keeps on looping through further
1530 # pending changes, so unroll the change in $conf as well if destroy_disks()
1531 # didn't die().
1532 $conf->{pending}->{$opt} = $original_value;
1533 die $err;
b2de4c04 1534 }
869081a2 1535 }
ec99cbdc
FE
1536 } else {
1537 die "skip\n" if $running && defined($old); # TODO: "changing" mount points?
1538 $rescan_volume->($storecfg, $mp) if $mp->{type} eq 'volume';
1539 if ($running) {
1540 PVE::LXC::mountpoint_hotplug($vmid, $conf, $opt, $mp, $storecfg);
1541 }
1542 $conf->{pending}->{$opt} = $class->print_ct_mountpoint($mp);
869081a2
WB
1543 }
1544
1545 if (defined($old)) {
e4034859 1546 my $mp = $class->parse_volume($opt, $old);
869081a2
WB
1547 if ($mp->{type} eq 'volume') {
1548 $class->add_unused_volume($conf, $mp->{volume})
1549 if !$class->is_volume_in_use($conf, $conf->{$opt}, 1, 1);
1550 }
1551 }
1552}
1553
d250604f
FG
1554sub classify_mountpoint {
1555 my ($class, $vol) = @_;
1556 if ($vol =~ m!^/!) {
1557 return 'device' if $vol =~ m!^/dev/!;
1558 return 'bind';
1559 }
1560 return 'volume';
1561}
1562
7b4237c5 1563my $__is_volume_in_use = sub {
72e6bc20 1564 my ($class, $config, $volid) = @_;
d250604f
FG
1565 my $used = 0;
1566
015740e6 1567 $class->foreach_volume($config, sub {
d250604f
FG
1568 my ($ms, $mountpoint) = @_;
1569 return if $used;
1570 $used = $mountpoint->{type} eq 'volume' && $mountpoint->{volume} eq $volid;
1571 });
1572
72e6bc20
WB
1573 return $used;
1574};
1575
1576sub is_volume_in_use_by_snapshots {
1577 my ($class, $config, $volid) = @_;
1578
1579 if (my $snapshots = $config->{snapshots}) {
d250604f 1580 foreach my $snap (keys %$snapshots) {
7b4237c5 1581 return 1 if $__is_volume_in_use->($class, $snapshots->{$snap}, $volid);
d250604f
FG
1582 }
1583 }
1584
72e6bc20 1585 return 0;
7b4237c5 1586}
72e6bc20
WB
1587
1588sub is_volume_in_use {
d063af00 1589 my ($class, $config, $volid, $include_snapshots, $include_pending) = @_;
7b4237c5 1590 return 1 if $__is_volume_in_use->($class, $config, $volid);
72e6bc20 1591 return 1 if $include_snapshots && $class->is_volume_in_use_by_snapshots($config, $volid);
d063af00 1592 return 1 if $include_pending && $__is_volume_in_use->($class, $config->{pending}, $volid);
72e6bc20 1593 return 0;
d250604f
FG
1594}
1595
1596sub has_dev_console {
1597 my ($class, $conf) = @_;
1598
1599 return !(defined($conf->{console}) && !$conf->{console});
1600}
1601
be7942f0
DM
1602sub has_lxc_entry {
1603 my ($class, $conf, $keyname) = @_;
1604
1605 if (my $lxcconf = $conf->{lxc}) {
1606 foreach my $entry (@$lxcconf) {
1607 my ($key, undef) = @$entry;
1608 return 1 if $key eq $keyname;
1609 }
1610 }
1611
1612 return 0;
1613}
1614
1b4cf758
FG
1615sub get_tty_count {
1616 my ($class, $conf) = @_;
1617
1618 return $conf->{tty} // $confdesc->{tty}->{default};
1619}
1620
1621sub get_cmode {
1622 my ($class, $conf) = @_;
1623
1624 return $conf->{cmode} // $confdesc->{cmode}->{default};
1625}
1626
5e5d76cf 1627sub valid_volume_keys {
d250604f
FG
1628 my ($class, $reverse) = @_;
1629
1630 my @names = ('rootfs');
1631
1632 for (my $i = 0; $i < $MAX_MOUNT_POINTS; $i++) {
1633 push @names, "mp$i";
1634 }
1635
1636 return $reverse ? reverse @names : @names;
1637}
1638
eacc42f0
AL
1639sub valid_volume_keys_with_unused {
1640 my ($class, $reverse) = @_;
1641 my @names = $class->valid_volume_keys();
1642 for (my $i = 0; $i < $MAX_UNUSED_DISKS; $i++) {
1643 push @names, "unused$i";
1644 }
1645 return $reverse ? reverse @names : @names;
1646}
1647
d250604f
FG
1648sub get_vm_volumes {
1649 my ($class, $conf, $excludes) = @_;
1650
1651 my $vollist = [];
1652
015740e6 1653 $class->foreach_volume($conf, sub {
d250604f
FG
1654 my ($ms, $mountpoint) = @_;
1655
1656 return if $excludes && $ms eq $excludes;
1657
1658 my $volid = $mountpoint->{volume};
1659 return if !$volid || $mountpoint->{type} ne 'volume';
1660
1661 my ($sid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
1662 return if !$sid;
1663
1664 push @$vollist, $volid;
1665 });
1666
1667 return $vollist;
1668}
1669
f78c87a8 1670sub get_replicatable_volumes {
70996986 1671 my ($class, $storecfg, $vmid, $conf, $cleanup, $noerr) = @_;
f78c87a8
DM
1672
1673 my $volhash = {};
1674
1675 my $test_volid = sub {
1676 my ($volid, $mountpoint) = @_;
1677
1678 return if !$volid;
1679
5cf90b0c 1680 my $mptype = $mountpoint->{type};
896cd762 1681 my $replicate = $mountpoint->{replicate} // 1;
d2a046b7
DC
1682
1683 if ($mptype ne 'volume') {
1684 # skip bindmounts if replicate = 0 even for cleanup,
1685 # since bind mounts could not have been replicated ever
1686 return if !$replicate;
1687 die "unable to replicate mountpoint type '$mptype'\n";
1688 }
5cf90b0c
DM
1689
1690 my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, $noerr);
1691 return if !$storeid;
1692
af21e699 1693 my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
5cf90b0c
DM
1694 return if $scfg->{shared};
1695
1696 my ($path, $owner, $vtype) = PVE::Storage::path($storecfg, $volid);
1697 return if !$owner || ($owner != $vmid);
1698
1699 die "unable to replicate volume '$volid', type '$vtype'\n" if $vtype ne 'images';
1700
d2a046b7 1701 return if !$cleanup && !$replicate;
f78c87a8
DM
1702
1703 if (!PVE::Storage::volume_has_feature($storecfg, 'replicate', $volid)) {
e65dce6b 1704 return if $cleanup || $noerr;
f78c87a8
DM
1705 die "missing replicate feature on volume '$volid'\n";
1706 }
1707
1708 $volhash->{$volid} = 1;
1709 };
1710
015740e6 1711 $class->foreach_volume($conf, sub {
f78c87a8
DM
1712 my ($ms, $mountpoint) = @_;
1713 $test_volid->($mountpoint->{volume}, $mountpoint);
1714 });
1715
1716 foreach my $snapname (keys %{$conf->{snapshots}}) {
1717 my $snap = $conf->{snapshots}->{$snapname};
015740e6 1718 $class->foreach_volume($snap, sub {
f78c87a8
DM
1719 my ($ms, $mountpoint) = @_;
1720 $test_volid->($mountpoint->{volume}, $mountpoint);
1721 });
1722 }
1723
b03664ae
DM
1724 # add 'unusedX' volumes to volhash
1725 foreach my $key (keys %$conf) {
1726 if ($key =~ m/^unused/) {
1727 $test_volid->($conf->{$key}, { type => 'volume', replicate => 1 });
1728 }
1729 }
1730
f78c87a8
DM
1731 return $volhash;
1732}
1733
efd1706d
AL
1734sub get_backup_volumes {
1735 my ($class, $conf) = @_;
1736
1737 my $return_volumes = [];
1738
1739 my $test_mountpoint = sub {
1740 my ($key, $volume) = @_;
1741
1742 my ($included, $reason) = $class->mountpoint_backup_enabled($key, $volume);
1743
efd1706d
AL
1744 push @$return_volumes, {
1745 key => $key,
1746 included => $included,
1747 reason => $reason,
1748 volume_config => $volume,
1749 };
1750 };
1751
1752 PVE::LXC::Config->foreach_volume($conf, $test_mountpoint);
1753
1754 return $return_volumes;
1755}
1756
c86f8957
FE
1757sub get_derived_property {
1758 my ($class, $conf, $name) = @_;
1759
1760 if ($name eq 'max-cpu') {
1761 return $conf->{cpulimit} || $conf->{cores} || 0;
1762 } elsif ($name eq 'max-memory') {
1763 return ($conf->{memory} || 512) * 1024 * 1024;
1764 } else {
1765 die "unknown derived property - $name\n";
1766 }
1767}
1768
f78c87a8 17691;