]> git.proxmox.com Git - pve-common.git/blame - src/PVE/INotify.pm
INotify: add support for dummy interfaces type
[pve-common.git] / src / PVE / INotify.pm
CommitLineData
e143e9d8
DM
1package PVE::INotify;
2
3# todo: maybe we do not need update_file() ?
e143e9d8 4use strict;
c36f332e
DM
5use warnings;
6
afd50f0d
TL
7use Clone qw(clone);
8use Digest::SHA;
9use Encode qw(encode decode);
e143e9d8 10use Fcntl qw(:DEFAULT :flock);
afd50f0d
TL
11use File::Basename;
12use File::stat;
13use IO::Dir;
14use IO::File;
15use JSON;
16use Linux::Inotify2;
17use POSIX;
18
e143e9d8 19use PVE::Exception qw(raise_param_exc);
afd50f0d 20use PVE::JSONSchema;
3dabe28a 21use PVE::Network;
f0d1b04f 22use PVE::ProcFSTools;
afd50f0d
TL
23use PVE::SafeSyslog;
24use PVE::Tools;
25
e143e9d8 26use base 'Exporter';
e143e9d8
DM
27
28our @EXPORT_OK = qw(read_file write_file register_file);
29
30my $ccache;
31my $ccachemap;
32my $ccacheregex;
33my $inotify;
34my $inotify_pid = 0;
35my $versions;
36my $shadowfiles = {
37 '/etc/network/interfaces' => '/etc/network/interfaces.new',
38};
39
40# to enable cached operation, you need to call 'inotify_init'
41# inotify handles are a limited resource, so use with care (only
42# enable the cache if you really need it)
43
44# Note: please close the inotify handle after you fork
45
46sub ccache_default_writer {
47 my ($filename, $data) = @_;
48
49 die "undefined config writer for '$filename' :ERROR";
50}
51
52sub ccache_default_parser {
53 my ($filename, $srcfd) = @_;
54
55 die "undefined config reader for '$filename' :ERROR";
56}
57
58sub ccache_compute_diff {
59 my ($filename, $shadow) = @_;
60
61 my $diff = '';
62
69758574
DC
63 my $cmd = ['/usr/bin/diff', '-b', '-N', '-u', $filename, $shadow];
64 PVE::Tools::run_command($cmd, noerr => 1, outfunc => sub {
65 my ($line) = @_;
66 $diff .= decode('UTF-8', $line) . "\n";
67 });
e143e9d8
DM
68
69 $diff = undef if !$diff;
70
71 return $diff;
72}
73
74sub ccache_info {
75 my ($filename) = @_;
76
77 foreach my $uid (keys %$ccacheregex) {
78 my $ccinfo = $ccacheregex->{$uid};
79 my $dir = $ccinfo->{dir};
80 my $regex = $ccinfo->{regex};
81 if ($filename =~ m|^$dir/+$regex$|) {
82 if (!$ccache->{$filename}) {
83 my $cp = {};
84 while (my ($k, $v) = each %$ccinfo) {
85 $cp->{$k} = $v;
86 }
87 $ccache->{$filename} = $cp;
9bbc4e17 88 }
e143e9d8
DM
89 return ($ccache->{$filename}, $filename);
90 }
91 }
9bbc4e17 92
e143e9d8
DM
93 $filename = $ccachemap->{$filename} if defined ($ccachemap->{$filename});
94
95 die "file '$filename' not added :ERROR" if !defined ($ccache->{$filename});
9bbc4e17 96
e143e9d8
DM
97 return ($ccache->{$filename}, $filename);
98}
99
100sub write_file {
101 my ($fileid, $data, $full) = @_;
102
103 my ($ccinfo, $filename) = ccache_info($fileid);
104
105 my $writer = $ccinfo->{writer};
106
107 my $realname = $filename;
108
109 my $shadow;
110 if ($shadow = $shadowfiles->{$filename}) {
111 $realname = $shadow;
112 }
113
114 my $perm = $ccinfo->{perm} || 0644;
115
116 my $tmpname = "$realname.tmp.$$";
117
118 my $res;
119 eval {
120 my $fh = IO::File->new($tmpname, O_WRONLY|O_CREAT, $perm);
121 die "unable to open file '$tmpname' - $!\n" if !$fh;
122
123 $res = &$writer($filename, $fh, $data);
124
125 die "closing file '$tmpname' failed - $!\n" unless close $fh;
126 };
127 my $err = $@;
128
129 $ccinfo->{version} = undef;
130
131 if ($err) {
132 unlink $tmpname;
133 die $err;
134 }
135
136 if (!rename($tmpname, $realname)) {
137 my $msg = "close (rename) atomic file '$filename' failed: $!\n";
138 unlink $tmpname;
9bbc4e17 139 die $msg;
e143e9d8
DM
140 }
141
142 my $diff;
143 if ($shadow && $full) {
144 $diff = ccache_compute_diff ($filename, $shadow);
145 }
146
147 if ($full) {
148 return { data => $res, changes => $diff };
149 }
150
151 return $res;
152}
153
154sub update_file {
155 my ($fileid, $data, @args) = @_;
156
157 my ($ccinfo, $filename) = ccache_info($fileid);
158
159 my $update = $ccinfo->{update};
160
161 die "unable to update/merge data" if !$update;
162
163 my $lkfn = "$filename.lock";
164
165 my $timeout = 10;
166
167 my $fd;
168
169 my $code = sub {
170
171 $fd = IO::File->new ($filename, "r");
9bbc4e17 172
e143e9d8
DM
173 my $new = &$update($filename, $fd, $data, @args);
174
175 if (defined($new)) {
176 PVE::Tools::file_set_contents($filename, $new, $ccinfo->{perm});
177 } else {
178 unlink $filename;
179 }
180 };
181
182 PVE::Tools::lock_file($lkfn, $timeout, $code);
183 my $err = $@;
184
185 close($fd) if defined($fd);
186
187 die $err if $err;
188
189 return undef;
190}
191
192sub discard_changes {
193 my ($fileid, $full) = @_;
194
195 my ($ccinfo, $filename) = ccache_info($fileid);
196
197 if (my $copy = $shadowfiles->{$filename}) {
198 unlink $copy;
199 }
200
201 return read_file ($filename, $full);
202}
203
3b671d82
DM
204sub poll_changes {
205 my ($filename) = @_;
206
207 poll() if $inotify; # read new inotify events
208
209 $versions->{$filename} = 0 if !defined ($versions->{$filename});
210
211 return $versions->{$filename};
212}
213
e143e9d8
DM
214sub read_file {
215 my ($fileid, $full) = @_;
216
217 my $parser;
218
219 my ($ccinfo, $filename) = ccache_info($fileid);
9bbc4e17 220
e143e9d8 221 $parser = $ccinfo->{parser};
9bbc4e17 222
e143e9d8
DM
223 my $fd;
224 my $shadow;
225
3b671d82 226 my $cver = poll_changes($filename);
e143e9d8
DM
227
228 if (my $copy = $shadowfiles->{$filename}) {
229 if ($fd = IO::File->new ($copy, "r")) {
230 $shadow = $copy;
231 } else {
232 $fd = IO::File->new ($filename, "r");
233 }
234 } else {
235 $fd = IO::File->new ($filename, "r");
236 }
237
238 my $acp = $ccinfo->{always_call_parser};
239
240 if (!$fd) {
241 $ccinfo->{version} = undef;
9bbc4e17 242 $ccinfo->{data} = undef;
e143e9d8
DM
243 $ccinfo->{diff} = undef;
244 return undef if !$acp;
245 }
246
247 my $noclone = $ccinfo->{noclone};
248
249 # file unchanged?
250 if (!$ccinfo->{nocache} &&
04cba6c8 251 $inotify && $cver &&
e143e9d8
DM
252 defined ($ccinfo->{data}) &&
253 defined ($ccinfo->{version}) &&
254 ($ccinfo->{readonce} ||
04cba6c8 255 ($ccinfo->{version} == $cver))) {
e143e9d8
DM
256
257 my $ret;
258 if (!$noclone && ref ($ccinfo->{data})) {
32ef45ae 259 $ret->{data} = clone ($ccinfo->{data});
e143e9d8
DM
260 } else {
261 $ret->{data} = $ccinfo->{data};
262 }
263 $ret->{changes} = $ccinfo->{diff};
9bbc4e17 264
e143e9d8
DM
265 return $full ? $ret : $ret->{data};
266 }
267
268 my $diff;
269
270 if ($shadow) {
271 $diff = ccache_compute_diff ($filename, $shadow);
272 }
273
274 my $res = &$parser($filename, $fd);
275
276 if (!$ccinfo->{nocache}) {
277 $ccinfo->{version} = $cver;
278 }
279
280 # we cache data with references, so we always need to
32ef45ae 281 # clone this data. Else the original data may get
e143e9d8
DM
282 # modified.
283 $ccinfo->{data} = $res;
284
285 # also store diff
286 $ccinfo->{diff} = $diff;
287
288 my $ret;
289 if (!$noclone && ref ($ccinfo->{data})) {
32ef45ae 290 $ret->{data} = clone ($ccinfo->{data});
e143e9d8
DM
291 } else {
292 $ret->{data} = $ccinfo->{data};
293 }
294 $ret->{changes} = $ccinfo->{diff};
295
296 return $full ? $ret : $ret->{data};
9bbc4e17 297}
e143e9d8
DM
298
299sub parse_ccache_options {
300 my ($ccinfo, %options) = @_;
301
302 foreach my $opt (keys %options) {
303 my $v = $options{$opt};
304 if ($opt eq 'readonce') {
305 $ccinfo->{$opt} = $v;
306 } elsif ($opt eq 'nocache') {
307 $ccinfo->{$opt} = $v;
308 } elsif ($opt eq 'shadow') {
309 $ccinfo->{$opt} = $v;
310 } elsif ($opt eq 'perm') {
311 $ccinfo->{$opt} = $v;
312 } elsif ($opt eq 'noclone') {
313 # noclone flag for large read-only data chunks like aplinfo
314 $ccinfo->{$opt} = $v;
315 } elsif ($opt eq 'always_call_parser') {
1f929ade 316 # when set, we call parser even when the file does not exist.
e143e9d8
DM
317 # this allows the parser to return some default
318 $ccinfo->{$opt} = $v;
319 } else {
320 die "internal error - unsupported option '$opt'";
321 }
322 }
323}
324
325sub register_file {
326 my ($id, $filename, $parser, $writer, $update, %options) = @_;
327
26a8d824 328 die "can't register file '$filename' after inotify_init" if $inotify;
e143e9d8
DM
329
330 die "file '$filename' already added :ERROR" if defined ($ccache->{$filename});
331 die "ID '$id' already used :ERROR" if defined ($ccachemap->{$id});
332
333 my $ccinfo = {};
334
335 $ccinfo->{id} = $id;
336 $ccinfo->{parser} = $parser || \&ccache_default_parser;
337 $ccinfo->{writer} = $writer || \&ccache_default_writer;
338 $ccinfo->{update} = $update;
339
340 parse_ccache_options($ccinfo, %options);
9bbc4e17 341
e143e9d8
DM
342 if ($options{shadow}) {
343 $shadowfiles->{$filename} = $options{shadow};
344 }
345
346 $ccachemap->{$id} = $filename;
347 $ccache->{$filename} = $ccinfo;
348}
349
350sub register_regex {
351 my ($dir, $regex, $parser, $writer, $update, %options) = @_;
352
b8246bfc 353 die "can't register regex after inotify_init" if $inotify;
e143e9d8
DM
354
355 my $uid = "$dir/$regex";
356 die "regular expression '$uid' already added :ERROR" if defined ($ccacheregex->{$uid});
9bbc4e17 357
e143e9d8
DM
358 my $ccinfo = {};
359
360 $ccinfo->{dir} = $dir;
361 $ccinfo->{regex} = $regex;
362 $ccinfo->{parser} = $parser || \&ccache_default_parser;
363 $ccinfo->{writer} = $writer || \&ccache_default_writer;
364 $ccinfo->{update} = $update;
365
366 parse_ccache_options($ccinfo, %options);
367
368 $ccacheregex->{$uid} = $ccinfo;
369}
370
371sub poll {
372 return if !$inotify;
373
374 if ($inotify_pid != $$) {
375 syslog ('err', "got inotify poll request in wrong process - disabling inotify");
376 $inotify = undef;
377 } else {
378 1 while $inotify && $inotify->poll;
379 }
380}
381
382sub flushcache {
383 foreach my $filename (keys %$ccache) {
384 $ccache->{$filename}->{version} = undef;
385 $ccache->{$filename}->{data} = undef;
386 $ccache->{$filename}->{diff} = undef;
387 }
388}
389
390sub inotify_close {
391 $inotify = undef;
392}
393
394sub inotify_init {
395
396 die "only one inotify instance allowed" if $inotify;
397
398 $inotify = Linux::Inotify2->new()
399 || die "Unable to create new inotify object: $!";
400
401 $inotify->blocking (0);
402
403 $versions = {};
404
405 my $dirhash = {};
406 foreach my $fn (keys %$ccache) {
407 my $dir = dirname ($fn);
408 my $base = basename ($fn);
409
410 $dirhash->{$dir}->{$base} = $fn;
411
412 if (my $sf = $shadowfiles->{$fn}) {
413 $base = basename ($sf);
414 $dir = dirname ($sf);
415 $dirhash->{$dir}->{$base} = $fn; # change version of original file!
416 }
417 }
418
419 foreach my $uid (keys %$ccacheregex) {
420 my $ccinfo = $ccacheregex->{$uid};
9bbc4e17 421 $dirhash->{$ccinfo->{dir}}->{_regex} = 1;
e143e9d8
DM
422 }
423
424 $inotify_pid = $$;
425
426 foreach my $dir (keys %$dirhash) {
427
428 my $evlist = IN_MODIFY|IN_ATTRIB|IN_MOVED_FROM|IN_MOVED_TO|IN_DELETE|IN_CREATE;
429 $inotify->watch ($dir, $evlist, sub {
430 my $e = shift;
431 my $name = $e->name;
432
433 if ($inotify_pid != $$) {
434 syslog ('err', "got inotify event in wrong process");
435 }
436
437 if ($e->IN_ISDIR || !$name) {
438 return;
439 }
440
441 if ($e->IN_Q_OVERFLOW) {
442 syslog ('info', "got inotify overflow - flushing cache");
443 flushcache();
444 return;
445 }
446
447 if ($e->IN_UNMOUNT) {
448 syslog ('err', "got 'unmount' event on '$name' - disabling inotify");
449 $inotify = undef;
450 }
9bbc4e17 451 if ($e->IN_IGNORED) {
e143e9d8
DM
452 syslog ('err', "got 'ignored' event on '$name' - disabling inotify");
453 $inotify = undef;
454 }
455
456 if ($dirhash->{$dir}->{_regex}) {
457 foreach my $uid (keys %$ccacheregex) {
458 my $ccinfo = $ccacheregex->{$uid};
459 next if $dir ne $ccinfo->{dir};
460 my $regex = $ccinfo->{regex};
461 if ($regex && ($name =~ m|^$regex$|)) {
462
463 my $fn = "$dir/$name";
464 $versions->{$fn}++;
465 #print "VERSION:$fn:$versions->{$fn}\n";
466 }
467 }
468 } elsif (my $fn = $dirhash->{$dir}->{$name}) {
469
470 $versions->{$fn}++;
471 #print "VERSION:$fn:$versions->{$fn}\n";
472 }
473 });
474 }
475
476 foreach my $dir (keys %$dirhash) {
477 foreach my $name (keys %{$dirhash->{$dir}}) {
478 if ($name eq '_regex') {
479 foreach my $uid (keys %$ccacheregex) {
480 my $ccinfo = $ccacheregex->{$uid};
481 next if $dir ne $ccinfo->{dir};
482 my $re = $ccinfo->{regex};
483 if (my $fd = IO::Dir->new ($dir)) {
9bbc4e17 484 while (defined(my $de = $fd->read)) {
e143e9d8
DM
485 if ($de =~ m/^$re$/) {
486 my $fn = "$dir/$de";
487 $versions->{$fn}++; # init with version
488 #print "init:$fn:$versions->{$fn}\n";
489 }
490 }
491 }
492 }
493 } else {
494 my $fn = $dirhash->{$dir}->{$name};
495 $versions->{$fn}++; # init with version
496 #print "init:$fn:$versions->{$fn}\n";
497 }
498 }
499 }
500}
501
502my $cached_nodename;
503
504sub nodename {
505
506 return $cached_nodename if $cached_nodename;
507
508 my ($sysname, $nodename) = POSIX::uname();
509
510 $nodename =~ s/\..*$//; # strip domain part, if any
511
512 die "unable to read node name\n" if !$nodename;
513
514 $cached_nodename = $nodename;
515
516 return $cached_nodename;
517}
518
519sub read_etc_hostname {
520 my ($filename, $fd) = @_;
521
522 my $hostname = <$fd>;
523
524 chomp $hostname;
525
526 $hostname =~ s/\..*$//; # strip domain part, if any
527
528 return $hostname;
529}
530
531sub write_etc_hostname {
532 my ($filename, $fh, $hostname) = @_;
533
534 die "write failed: $!" unless print $fh "$hostname\n";
535
536 return $hostname;
537}
538
9bbc4e17
TL
539register_file('hostname', "/etc/hostname",
540 \&read_etc_hostname,
e143e9d8
DM
541 \&write_etc_hostname);
542
9194ee06
DC
543sub read_etc_hosts {
544 my ($filename, $fh) = @_;
545
546 my $raw = '';
547 my $data = '';
548
549 while (my $line = <$fh>) {
550 $raw .= $line;
551 if ($line =~ m/^\s*#/) {
552 $line = decode('UTF-8', $line);
553 }
554 $data .= $line;
555 }
556
557 return {
558 digest => Digest::SHA::sha1_hex($raw),
559 data => $data,
560 }
561}
562
563sub write_etc_hosts {
564 my ($filename, $fh, $hosts, @args) = @_;
565
566 # check validity of ips/names
567 for my $line (split("\n", $hosts)) {
568 next if $line =~ m/^\s*#/; # comments
569 next if $line =~ m/^\s*$/; # whitespace/empty lines
570
571 my ($ip, @names) = split(/\s+/, $line);
572
573 raise_param_exc({ 'data' => "Invalid IP '$ip'" })
574 if $ip !~ m/^$PVE::Tools::IPRE$/;
575
576 for my $name (@names) {
577 raise_param_exc({ 'data' => "Invalid Hostname '$name'" })
578 if $name !~ m/^[.\-a-zA-Z0-9]+$/;
579 }
580 }
581
582 die "write failed: $!" if !print $fh encode('UTF-8', $hosts);
583
584 return $hosts;
585}
586
587register_file('etchosts', "/etc/hosts",
588 \&read_etc_hosts,
589 \&write_etc_hosts);
590
e143e9d8
DM
591sub read_etc_resolv_conf {
592 my ($filename, $fh) = @_;
593
594 my $res = {};
595
596 my $nscount = 0;
597 while (my $line = <$fh>) {
598 chomp $line;
599 if ($line =~ m/^(search|domain)\s+(\S+)\s*/) {
600 $res->{search} = $2;
176b1186 601 } elsif ($line =~ m/^\s*nameserver\s+($PVE::Tools::IPRE)\s*/) {
e143e9d8
DM
602 $nscount++;
603 if ($nscount <= 3) {
604 $res->{"dns$nscount"} = $1;
605 }
606 }
607 }
608
609 return $res;
610}
611
612sub update_etc_resolv_conf {
613 my ($filename, $fh, $resolv, @args) = @_;
614
615 my $data = "";
616
617 $data = "search $resolv->{search}\n"
618 if $resolv->{search};
619
620 my $written = {};
621 foreach my $k ("dns1", "dns2", "dns3") {
622 my $ns = $resolv->{$k};
623 if ($ns && $ns ne '0.0.0.0' && !$written->{$ns}) {
624 $written->{$ns} = 1;
625 $data .= "nameserver $ns\n";
626 }
627 }
628
629 while (my $line = <$fh>) {
630 next if $line =~ m/^(search|domain|nameserver)\s+/;
631 $data .= $line
632 }
9bbc4e17 633
e143e9d8
DM
634 return $data;
635}
636
9bbc4e17
TL
637register_file('resolvconf', "/etc/resolv.conf",
638 \&read_etc_resolv_conf, undef,
e143e9d8
DM
639 \&update_etc_resolv_conf);
640
641sub read_etc_timezone {
642 my ($filename, $fd) = @_;
643
644 my $timezone = <$fd>;
645
646 chomp $timezone;
647
648 return $timezone;
649}
650
651sub write_etc_timezone {
652 my ($filename, $fh, $timezone) = @_;
653
654 my $tzinfo = "/usr/share/zoneinfo/$timezone";
655
656 raise_param_exc({ 'timezone' => "No such timezone" })
657 if (! -f $tzinfo);
658
659 ($timezone) = $timezone =~ m/^(.*)$/; # untaint
660
661 print $fh "$timezone\n";
662
663 unlink ("/etc/localtime");
664 symlink ("/usr/share/zoneinfo/$timezone", "/etc/localtime");
665
666}
667
9bbc4e17
TL
668register_file('timezone', "/etc/timezone",
669 \&read_etc_timezone,
e143e9d8
DM
670 \&write_etc_timezone);
671
672sub read_active_workers {
673 my ($filename, $fh) = @_;
674
675 return [] if !$fh;
676
9bbc4e17 677 my $res = [];
e143e9d8 678 while (defined (my $line = <$fh>)) {
75ed54f1 679 if ($line =~ m/^(\S+)\s(0|1)(\s([0-9A-Za-z]{8})(\s(\s*\S.*))?)?$/) {
e143e9d8
DM
680 my $upid = $1;
681 my $saved = $2;
682 my $endtime = $4;
683 my $status = $6;
684 if ((my $task = PVE::Tools::upid_decode($upid, 1))) {
685 $task->{upid} = $upid;
686 $task->{saved} = $saved;
687 $task->{endtime} = hex($endtime) if $endtime;
688 $task->{status} = $status if $status;
689 push @$res, $task;
690 }
691 } else {
692 warn "unable to parse line: $line";
693 }
694 }
695
696 return $res;
697
698}
699
700sub write_active_workers {
701 my ($filename, $fh, $tasklist) = @_;
702
703 my $raw = '';
704 foreach my $task (@$tasklist) {
705 my $upid = $task->{upid};
706 my $saved = $task->{saved} ? 1 : 0;
707 if ($task->{endtime}) {
708 if ($task->{status}) {
e34c27f4 709 $raw .= sprintf("%s %s %08X %s\n", $upid, $saved, $task->{endtime}, $task->{status});
e143e9d8 710 } else {
e34c27f4 711 $raw .= sprintf("%s %s %08X\n", $upid, $saved, $task->{endtime});
e143e9d8
DM
712 }
713 } else {
714 $raw .= "$upid $saved\n";
715 }
716 }
717
718 PVE::Tools::safe_print($filename, $fh, $raw) if $raw;
719}
720
9bbc4e17 721register_file('active', "/var/log/pve/tasks/active",
e143e9d8
DM
722 \&read_active_workers,
723 \&write_active_workers);
724
725
c8e5d28e 726our $bond_modes = { 'balance-rr' => 0,
e143e9d8
DM
727 'active-backup' => 1,
728 'balance-xor' => 2,
729 'broadcast' => 3,
730 '802.3ad' => 4,
731 'balance-tlb' => 5,
732 'balance-alb' => 6,
733 };
734
9b7b13a1
DM
735my $ovs_bond_modes = {
736 'active-backup' => 1,
9b7b13a1 737 'balance-slb' => 1,
a68760b6 738 'lacp-balance-slb' => 1,
9bbc4e17 739 'lacp-balance-tcp' => 1,
9b7b13a1
DM
740};
741
e143e9d8
DM
742#sub get_bond_modes {
743# return $bond_modes;
744#}
745
9b7b13a1
DM
746my $parse_ovs_option = sub {
747 my ($data) = @_;
748
749 my $opts = {};
750 foreach my $kv (split (/\s+/, $data || '')) {
751 my ($k, $v) = split('=', $kv, 2);
752 $opts->{$k} = $v if $k && $v;
753 }
754 return $opts;
755};
756
757my $set_ovs_option = sub {
758 my ($d, %params) = @_;
759
760 my $opts = &$parse_ovs_option($d->{ovs_options});
761
762 foreach my $k (keys %params) {
763 my $v = $params{$k};
764 if ($v) {
765 $opts->{$k} = $v;
766 } else {
767 delete $opts->{$k};
768 }
769 }
770
771 my $res = [];
772 foreach my $k (keys %$opts) {
773 push @$res, "$k=$opts->{$k}";
774 }
775
776 if (my $new = join(' ', @$res)) {
777 $d->{ovs_options} = $new;
778 return $d->{ovs_options};
779 } else {
780 delete $d->{ovs_options};
781 return undef;
782 }
783};
784
785my $extract_ovs_option = sub {
786 my ($d, $name) = @_;
787
788 my $opts = &$parse_ovs_option($d->{ovs_options});
789
790 my $v = delete $opts->{$name};
791
792 my $res = [];
793 foreach my $k (keys %$opts) {
794 push @$res, "$k=$opts->{$k}";
795 }
796
797 if (my $new = join(' ', @$res)) {
798 $d->{ovs_options} = $new;
799 } else {
800 delete $d->{ovs_options};
801 }
802
803 return $v;
804};
805
9b053d70 806my $check_mtu = sub {
cebd1c85 807 my ($ifaces, $parent, $child) = @_;
9b053d70 808
cebd1c85
WB
809 die "check mtu - missing parent interface\n" if !$parent;
810 die "check mtu - missing child interface\n" if !$child;
9b053d70 811
000e32bc
AD
812 my $cmtu = $ifaces->{$child}->{mtu};
813 return if !$cmtu;
9b053d70 814
000e32bc
AD
815 my $parentdata = $ifaces->{$parent};
816 my $pmtu = $parentdata->{mtu};
817 $pmtu = $cmtu if $parentdata->{type} eq 'bond' && !$pmtu;
818 $pmtu = 1500 if !$pmtu;
819
820 die "interface '$parent' - mtu $pmtu is lower than '$child' - mtu $cmtu\n"
821 if $pmtu < $cmtu;
9b053d70
AD
822};
823
48ab17b3
WB
824# config => {
825# ifaces => {
826# $ifname => {
827# <optional> exists => BOOL,
828# <optional> active => BOOL,
829# <optional> autostart => BOOL,
830# <auto> priority => INT,
831#
832# type => "eth" | "bridge" | "bond" | "loopback" | "OVS*" | ... ,
833#
834# families => ["inet", "inet6", ...],
835#
836# method => "manual" | "static" | "dhcp" | ... ,
837# address => IP,
838# netmask => SUBNET,
839# broadcast => IP,
840# gateway => IP,
841# comments => [ "..." ],
842#
843# method6 => "manual" | "static" | "dhcp" | ... ,
844# address6 => IP,
845# netmask6 => SUBNET,
846# gateway6 => IP,
847# comments6 => [ "..." ],
848#
849# <known options>, # like bridge_ports, ovs_*
850#
851# # extra/unknown options stored by-family:
852# options => { <inet options>... }
853# options6 => { <inet6 options>... }
854# }
855# },
856# options => [
857# # mappings end up here as well, as we don't need to understand them
858# [priority,line]
859# ]
860# }
e143e9d8
DM
861sub read_etc_network_interfaces {
862 my ($filename, $fh) = @_;
78325766 863 my $proc_net_dev = IO::File->new('/proc/net/dev', 'r');
f0d1b04f 864 my $active = PVE::ProcFSTools::get_active_network_interfaces();
12a235d6 865 return __read_etc_network_interfaces($fh, $proc_net_dev, $active);
78325766
WB
866}
867
868sub __read_etc_network_interfaces {
12a235d6 869 my ($fh, $proc_net_dev, $active_ifaces) = @_;
e143e9d8 870
48ab17b3
WB
871 my $config = {};
872 my $ifaces = $config->{ifaces} = {};
873 my $options = $config->{options} = [];
e143e9d8 874
1b1fb9f7 875 my $options_alternatives = {
2d1e9a02 876 'ovs_mtu' => 'mtu',
1b1fb9f7
AD
877 'bond-slaves' => 'slaves',
878 'bond_slaves' => 'slaves',
879 'bond-xmit-hash-policy' => 'bond_xmit_hash_policy',
880 'bond-mode' => 'bond_mode',
881 'bond-miimon' =>'bond_miimon',
882 'bridge-vlan-aware' => 'bridge_vlan_aware',
883 'bridge-fd' => 'bridge_fd',
884 'bridge-stp' => 'bridge_stp',
95d0e633
AD
885 'bridge-ports' => 'bridge_ports',
886 'bridge-vids' => 'bridge_vids'
1b1fb9f7
AD
887 };
888
e143e9d8
DM
889 my $line;
890
78325766
WB
891 if ($proc_net_dev) {
892 while (defined ($line = <$proc_net_dev>)) {
3dabe28a 893 if ($line =~ m/^\s*($PVE::Network::PHYSICAL_NIC_RE):.*/) {
e143e9d8
DM
894 $ifaces->{$1}->{exists} = 1;
895 }
896 }
78325766 897 close($proc_net_dev);
e143e9d8
DM
898 }
899
c9dc8645 900 # we try to keep order inside the file
9bbc4e17 901 my $priority = 2; # 1 is reserved for lo
c9dc8645 902
b1d7951f 903 SECTION: while (defined ($line = <$fh>)) {
e143e9d8 904 chomp ($line);
b1d7951f 905 next if $line =~ m/^\s*#/;
c86cfb8b 906 next if $line =~ m/^\s*(allow-hotplug)\s+(.*)$/;
9bbc4e17 907
f48815f8
AD
908 if ($line =~ m/^\s*(auto|allow-ovs)\s+(.*)$/) {
909 my @aa = split (/\s+/, $2);
e143e9d8
DM
910
911 foreach my $a (@aa) {
912 $ifaces->{$a}->{autostart} = 1;
913 }
914
48ab17b3 915 } elsif ($line =~ m/^\s*iface\s+(\S+)\s+(inet6?)\s+(\S+)\s*$/) {
e143e9d8 916 my $i = $1;
48ab17b3
WB
917 my $family = $2;
918 my $f = { method => $3 }; # by family, merged to $d with a $suffix
919 (my $suffix = $family) =~ s/^inet//;
e143e9d8 920
cb07ff78 921 my $d = $ifaces->{$i} ||= {};
48ab17b3
WB
922 $d->{priority} = $priority++ if !$d->{priority};
923 push @{$d->{families}}, $family;
924
72ca6520 925 while (defined ($line = <$fh>)) {
de906ba3 926 $line =~ s/\s+$//; # drop trailing whitespaces
684e07f2 927
b1d7951f 928 if ($line =~ m/^\s*#(.*?)\s*$/) {
48ab17b3 929 $f->{comments} = '' if !$f->{comments};
1b505ae2
DC
930 my $comment = decode('UTF-8', $1);
931 $f->{comments} .= "$comment\n";
b1d7951f
WB
932 } elsif ($line =~ m/^\s*(?:iface\s
933 |mapping\s
934 |auto\s
935 |allow-
936 |source\s
937 |source-directory\s
938 )/x) {
939 last;
940 } elsif ($line =~ m/^\s*((\S+)\s+(.+))$/) {
72ca6520
DM
941 my $option = $1;
942 my ($id, $value) = ($2, $3);
1b1fb9f7
AD
943
944 $id = $options_alternatives->{$id} if $options_alternatives->{$id};
945
9a052564 946 my $simple_options = {
9b053d70 947 'mtu' => 1,
9a052564
AD
948 'ovs_type' => 1,
949 'ovs_options' => 1,
950 'ovs_bridge' => 1,
951 'ovs_bonds' => 1,
952 'ovs_ports' => 1,
953 'bridge_fd' => 1,
954 'bridge_vids' => 1,
955 'bridge-access' => 1,
956 'bridge-learning' => 1,
957 'bridge-arp-nd-suppress' => 1,
958 'bridge-unicast-flood' => 1,
959 'bridge-multicast-flood' => 1,
960 'bond_miimon' => 1,
961 'bond_xmit_hash_policy' => 1,
b94d05ec 962 'bond-primary' => 1,
a85812af 963 'link-type' => 1,
d949babe 964 'uplink-id' => 1,
8f5d56bf 965 'vlan-protocol' => 1,
bbe7d3ed
AD
966 'vlan-raw-device' => 1,
967 'vlan-id' => 1,
9a052564
AD
968 'vxlan-id' => 1,
969 'vxlan-svcnodeip' => 1,
970 'vxlan-physdev' => 1,
971 'vxlan-local-tunnelip' => 1 };
972
0541ec90 973 if (($id eq 'address') || ($id eq 'netmask') || ($id eq 'broadcast') || ($id eq 'gateway')) {
48ab17b3 974 $f->{$id} = $value;
9a052564 975 } elsif ($simple_options->{$id}) {
9b7b13a1 976 $d->{$id} = $value;
72ca6520
DM
977 } elsif ($id eq 'slaves' || $id eq 'bridge_ports') {
978 my $devs = {};
979 foreach my $p (split (/\s+/, $value)) {
980 next if $p eq 'none';
981 $devs->{$p} = 1;
e143e9d8 982 }
72ca6520 983 my $str = join (' ', sort keys %{$devs});
48ab17b3
WB
984 if ($d->{$id}) {
985 $d->{$id} .= ' ' . $str if $str;
986 } else {
987 $d->{$id} = $str || '';
988 }
72ca6520
DM
989 } elsif ($id eq 'bridge_stp') {
990 if ($value =~ m/^\s*(on|yes)\s*$/i) {
991 $d->{$id} = 'on';
992 } else {
993 $d->{$id} = 'off';
994 }
685a2528
AD
995 } elsif ($id eq 'bridge_vlan_aware') {
996 $d->{$id} = 1;
72ca6520
DM
997 } elsif ($id eq 'bond_mode') {
998 # always use names
999 foreach my $bm (keys %$bond_modes) {
1000 my $id = $bond_modes->{$bm};
1001 if ($id eq $value) {
1002 $value = $bm;
1003 last;
1004 }
1005 }
1006 $d->{$id} = $value;
95aa8788
AD
1007 } elsif ($id eq 'vxlan-remoteip') {
1008 push @{$d->{$id}}, $value;
72ca6520 1009 } else {
48ab17b3 1010 push @{$f->{options}}, $option;
e143e9d8 1011 }
e143e9d8 1012 } else {
72ca6520 1013 last;
e143e9d8
DM
1014 }
1015 }
48ab17b3 1016 $d->{"$_$suffix"} = $f->{$_} foreach (keys %$f);
b1d7951f
WB
1017 last SECTION if !defined($line);
1018 redo SECTION;
48ab17b3
WB
1019 } elsif ($line =~ /\w/) {
1020 push @$options, [$priority++, $line];
e143e9d8
DM
1021 }
1022 }
1023
12a235d6
WB
1024 foreach my $ifname (@$active_ifaces) {
1025 if (my $iface = $ifaces->{$ifname}) {
1026 $iface->{active} = 1;
1027 }
1028 }
e143e9d8
DM
1029
1030 if (!$ifaces->{lo}) {
c9dc8645 1031 $ifaces->{lo}->{priority} = 1;
e143e9d8
DM
1032 $ifaces->{lo}->{method} = 'loopback';
1033 $ifaces->{lo}->{type} = 'loopback';
1034 $ifaces->{lo}->{autostart} = 1;
1035 }
1036
1037 foreach my $iface (keys %$ifaces) {
1038 my $d = $ifaces->{$iface};
c688b8e6 1039 $d->{type} = 'unknown';
e143e9d8 1040 if ($iface =~ m/^bond\d+$/) {
9b7b13a1
DM
1041 if (!$d->{ovs_type}) {
1042 $d->{type} = 'bond';
1043 } elsif ($d->{ovs_type} eq 'OVSBond') {
1044 $d->{type} = $d->{ovs_type};
1045 # translate: ovs_options => bond_mode
1046 $d->{'bond_mode'} = &$extract_ovs_option($d, 'bond_mode');
a68760b6
DM
1047 my $lacp = &$extract_ovs_option($d, 'lacp');
1048 if ($lacp && $lacp eq 'active') {
1049 if ($d->{'bond_mode'} eq 'balance-slb') {
1050 $d->{'bond_mode'} = 'lacp-balance-slb';
1051 }
1052 }
1053 # Note: balance-tcp needs lacp
1054 if ($d->{'bond_mode'} eq 'balance-tcp') {
1055 $d->{'bond_mode'} = 'lacp-balance-tcp';
1056 }
2a751938
DM
1057 my $tag = &$extract_ovs_option($d, 'tag');
1058 $d->{ovs_tag} = $tag if defined($tag);
e143e9d8 1059 }
9b7b13a1
DM
1060 } elsif ($iface =~ m/^vmbr\d+$/) {
1061 if (!$d->{ovs_type}) {
1062 $d->{type} = 'bridge';
1063
1064 if (!defined ($d->{bridge_fd})) {
1065 $d->{bridge_fd} = 0;
1066 }
1067 if (!defined ($d->{bridge_stp})) {
1068 $d->{bridge_stp} = 'off';
1069 }
1070 } elsif ($d->{ovs_type} eq 'OVSBridge') {
1071 $d->{type} = $d->{ovs_type};
e143e9d8
DM
1072 }
1073 } elsif ($iface =~ m/^(\S+):\d+$/) {
1074 $d->{type} = 'alias';
1075 if (defined ($ifaces->{$1})) {
1076 $d->{exists} = $ifaces->{$1}->{exists};
1077 } else {
1078 $ifaces->{$1}->{exists} = 0;
1079 $d->{exists} = 0;
1080 }
bbe7d3ed 1081 } elsif ($iface =~ m/^(\S+)\.\d+$/ || $d->{'vlan-raw-device'}) {
9c808945 1082 $d->{type} = 'vlan';
bbe7d3ed
AD
1083
1084 my $raw_iface = $d->{'vlan-raw-device'} ? $d->{'vlan-raw-device'} : $1;
1085 if (defined ($ifaces->{$raw_iface})) {
1086 $d->{exists} = $ifaces->{$raw_iface}->{exists};
9c808945 1087 } else {
bbe7d3ed 1088 $ifaces->{$raw_iface}->{exists} = 0;
9c808945
AD
1089 $d->{exists} = 0;
1090 }
3dabe28a 1091 } elsif ($iface =~ m/^$PVE::Network::PHYSICAL_NIC_RE$/) {
9b7b13a1
DM
1092 if (!$d->{ovs_type}) {
1093 $d->{type} = 'eth';
1094 } elsif ($d->{ovs_type} eq 'OVSPort') {
1095 $d->{type} = $d->{ovs_type};
2a751938
DM
1096 my $tag = &$extract_ovs_option($d, 'tag');
1097 $d->{ovs_tag} = $tag if defined($tag);
9b7b13a1 1098 }
e143e9d8
DM
1099 } elsif ($iface =~ m/^lo$/) {
1100 $d->{type} = 'loopback';
1101 } else {
95aa8788
AD
1102 if ($d->{'vxlan-id'}) {
1103 $d->{type} = 'vxlan';
d2513a84
TL
1104 } elsif (defined($d->{ovs_type})) {
1105 if ($d->{ovs_type} eq 'OVSIntPort') {
1106 $d->{type} = $d->{ovs_type};
1107 my $tag = &$extract_ovs_option($d, 'tag');
1108 $d->{ovs_tag} = $tag if defined($tag);
1109 }
a85812af
AD
1110 } elsif (defined($d->{'link-type'})) {
1111 $d->{type} = $d->{'link-type'} if $d->{'link-type'} eq 'dummy';
9b7b13a1 1112 }
e143e9d8
DM
1113 }
1114
2896245e 1115 # map address and netmask to cidr
fa6e6946
TL
1116 if (my $addr = $d->{address}) {
1117 if (_address_is_cidr($addr)) {
1118 $d->{cidr} = $addr;
1119 my ($baseaddr, $mask) = _cidr_split($addr);
1120 $d->{address} = $baseaddr;
1121 $d->{netmask} = $mask;
1122 } elsif (my $cidr = _get_cidr($d->{address}, $d->{netmask})) {
1123 $d->{cidr} = $cidr;
1124 (undef, $d->{netmask}) = _cidr_split($cidr);
1125 } else {
1126 # no mask, else we'd got a cidr above
1127 $d->{cidr} = $addr ."/32";
2896245e
DC
1128 }
1129 }
1130
1131 # map address6 and netmask6 to cidr6
fa6e6946
TL
1132 if (my $addr6 = $d->{address6}) {
1133 if (_address_is_cidr($addr6)) {
1134 $d->{cidr6} = $addr6;
1135 my ($baseaddr, $mask) = _cidr_split($addr6);
1136 $d->{address6} = $baseaddr;
1137 $d->{netmask6} = $mask;
1138 } elsif (my $cidr6 = _get_cidr($d->{address6}, $d->{netmask6})) {
1139 $d->{cidr6} = $cidr6;
1140 } else {
1141 # no mask, else we'd got a cidr above
1142 $d->{cidr6} = $addr6 ."/128";
1143 }
2896245e
DC
1144 }
1145
e143e9d8 1146 $d->{method} = 'manual' if !$d->{method};
48ab17b3 1147 $d->{method6} = 'manual' if !$d->{method6};
78325766
WB
1148
1149 $d->{families} ||= ['inet'];
e143e9d8
DM
1150 }
1151
516a50a4
WB
1152 # OVS bridges create "allow-$BRIDGE $IFACE" lines which we need to remove
1153 # from the {options} hash for them to be removed correctly.
1154 @$options = grep {defined($_)} map {
1155 my ($pri, $line) = @$_;
4ac94c72
AD
1156 if ($line =~ /^allow-ovs\s+(.*)$/) {
1157 undef;
1158 } elsif ($line =~ /^allow-(\S+)\s+(.*)$/) {
516a50a4
WB
1159 my $bridge = $1;
1160 my @ports = split(/\s+/, $2);
1161 if (defined(my $br = $ifaces->{$bridge})) {
1162 # if this port is part of a bridge, remove it
1163 my %in_ovs_ports = map {$_=>1} split(/\s+/, $br->{ovs_ports});
1164 @ports = grep { not $in_ovs_ports{$_} } @ports;
1165 }
1166 # create the allow line for the remaining ports, or delete if empty
1167 if (@ports) {
1168 [$pri, "allow-$bridge " . join(' ', @ports)];
1169 } else {
1170 undef;
1171 }
1172 } else {
1173 # don't modify other lines
1174 $_;
1175 }
1176 } @$options;
1177
48ab17b3 1178 return $config;
e143e9d8
DM
1179}
1180
fa6e6946
TL
1181sub _address_is_cidr {
1182 my ($addr) = @_;
1183 return $addr =~ /\/\d+$/ ? 1 : 0;
1184}
1185
1186sub _cidr_split {
1187 my ($cidr) = @_;
1188 $cidr =~ /^(.+)\/(\d+)$/;
1189 return ($1, $2); # (address, mask)
1190}
1191
1192sub _get_cidr {
1193 my ($addr, $mask) = @_;
1194
1195 return $addr if _address_is_cidr($addr);
1196 return undef if !$mask;
1197
1198 if ($mask =~ m/^\d+$/) { # cidr notation
1199 return $addr . "/" . $mask;
1200 } elsif (my $cidrmask = PVE::JSONSchema::get_netmask_bits($mask)) {
1201 return $addr . "/" . $cidrmask;
1202 }
1203 return undef;
1204}
1205
e143e9d8 1206sub __interface_to_string {
b7c4f378 1207 my ($iface, $d, $family, $first_block, $ifupdown2) = @_;
48ab17b3
WB
1208
1209 (my $suffix = $family) =~ s/^inet//;
e143e9d8 1210
48ab17b3 1211 return '' if !($d && $d->{"method$suffix"});
e143e9d8
DM
1212
1213 my $raw = '';
1214
48ab17b3 1215 $raw .= "iface $iface $family " . $d->{"method$suffix"} . "\n";
f6c9d9a4
TL
1216
1217 if (my $addr = $d->{"address$suffix"}) {
1218
1219 if ($addr !~ /\/\d+$/ && $d->{"netmask$suffix"}) {
1220 if ($d->{"netmask$suffix"} =~ m/^\d+$/) {
1221 $addr .= "/" . $d->{"netmask$suffix"};
1222 } elsif (my $mask = PVE::JSONSchema::get_netmask_bits($d->{"netmask$suffix"})) {
1223 $addr .= "/" . $mask;
1224 }
1225 }
1226
1227 $raw .= "\taddress " . $addr . "\n";
1228 }
1229
beedabb4 1230 $raw .= "\tgateway " . $d->{"gateway$suffix"} . "\n" if $d->{"gateway$suffix"};
e143e9d8 1231
9b7b13a1
DM
1232 my $done = { type => 1, priority => 1, method => 1, active => 1, exists => 1,
1233 comments => 1, autostart => 1, options => 1,
48ab17b3
WB
1234 address => 1, netmask => 1, gateway => 1, broadcast => 1,
1235 method6 => 1, families => 1, options6 => 1,
d949babe 1236 address6 => 1, netmask6 => 1, gateway6 => 1, broadcast6 => 1, 'uplink-id' => 1 };
48ab17b3
WB
1237
1238 if (!$first_block) {
1239 # not printing out options
1240 } elsif ($d->{type} eq 'bridge') {
9b7b13a1 1241
e143e9d8 1242 my $ports = $d->{bridge_ports} || 'none';
8342b610 1243 $ports =~ s/[;,\s]+/ /g;
1accc6da 1244 $raw .= "\tbridge-ports $ports\n";
9b7b13a1 1245 $done->{bridge_ports} = 1;
e143e9d8 1246
9b7b13a1 1247 my $v = defined($d->{bridge_stp}) ? $d->{bridge_stp} : 'off';
1accc6da 1248 $raw .= "\tbridge-stp $v\n";
9b7b13a1 1249 $done->{bridge_stp} = 1;
e143e9d8 1250
9b7b13a1 1251 $v = defined($d->{bridge_fd}) ? $d->{bridge_fd} : 0;
1accc6da 1252 $raw .= "\tbridge-fd $v\n";
9b7b13a1 1253 $done->{bridge_fd} = 1;
685a2528
AD
1254
1255 if( defined($d->{bridge_vlan_aware})) {
1accc6da 1256 $raw .= "\tbridge-vlan-aware yes\n";
95d0e633
AD
1257 $v = defined($d->{bridge_vids}) ? $d->{bridge_vids} : "2-4094";
1258 $raw .= "\tbridge-vids $v\n";
685a2528
AD
1259 }
1260 $done->{bridge_vlan_aware} = 1;
f6c4a563 1261 $done->{bridge_vids} = 1;
9bbc4e17 1262
2d1e9a02
AD
1263 $raw .= "\tmtu $d->{mtu}\n" if $d->{mtu};
1264 $done->{mtu} = 1;
1265
9b7b13a1 1266 } elsif ($d->{type} eq 'bond') {
e143e9d8 1267
fb3a6db1 1268 $d->{slaves} =~ s/[;,\s]+/ /g;
e143e9d8 1269 my $slaves = $d->{slaves} || 'none';
1accc6da 1270 $raw .= "\tbond-slaves $slaves\n";
9b7b13a1 1271 $done->{slaves} = 1;
e143e9d8 1272
9b7b13a1 1273 my $v = defined ($d->{'bond_miimon'}) ? $d->{'bond_miimon'} : 100;
1accc6da 1274 $raw .= "\tbond-miimon $v\n";
9b7b13a1 1275 $done->{'bond_miimon'} = 1;
e143e9d8 1276
9b7b13a1 1277 $v = defined ($d->{'bond_mode'}) ? $d->{'bond_mode'} : 'balance-rr';
1accc6da 1278 $raw .= "\tbond-mode $v\n";
9b7b13a1
DM
1279 $done->{'bond_mode'} = 1;
1280
40fae2b3
DM
1281 if ($d->{'bond_mode'} && $d->{'bond_xmit_hash_policy'} &&
1282 ($d->{'bond_mode'} eq 'balance-xor' || $d->{'bond_mode'} eq '802.3ad')) {
1accc6da 1283 $raw .= "\tbond-xmit-hash-policy $d->{'bond_xmit_hash_policy'}\n";
40fae2b3
DM
1284 }
1285 $done->{'bond_xmit_hash_policy'} = 1;
b94d05ec
AD
1286
1287 if ($d->{'bond_mode'} && $d->{'bond_mode'} eq 'active-backup' && $d->{'bond-primary'}) {
1288 $raw .= "\tbond-primary $d->{'bond-primary'}\n";
1289 }
1290 $done->{'bond-primary'} = 1;
1291
2d1e9a02
AD
1292 $raw .= "\tmtu $d->{mtu}\n" if $d->{mtu};
1293 $done->{mtu} = 1;
1294
8f5d56bf 1295 } elsif ($d->{type} eq 'vlan') {
9bbc4e17 1296 die "$iface: wrong vlan-protocol $d->{'vlan-protocol'}\n"
8f5d56bf 1297 if $d->{'vlan-protocol'} && $d->{'vlan-protocol'} ne '802.1ad' && $d->{'vlan-protocol'} ne '802.1q';
9bbc4e17 1298
95aa8788
AD
1299 } elsif ($d->{type} eq 'vxlan') {
1300
94d786b3
WB
1301 foreach my $k (qw(vxlan-id vxlan-svcnodeip vxlan-physdev vxlan-local-tunnelip)) {
1302 $raw .= "\t$k $d->{$k}\n" if defined $d->{$k};
95aa8788 1303 $done->{$k} = 1;
94d786b3 1304 }
95aa8788
AD
1305
1306 if ($d->{'vxlan-remoteip'}) {
1307 foreach my $remoteip (@{$d->{'vxlan-remoteip'}}) {
1308 $raw .= "\tvxlan-remoteip $remoteip\n";
1309 }
1310 $done->{'vxlan-remoteip'} = 1;
1311 }
2d1e9a02
AD
1312
1313 $raw .= "\tmtu $d->{mtu}\n" if $d->{mtu};
1314 $done->{mtu} = 1;
1315
9b7b13a1
DM
1316 } elsif ($d->{type} eq 'OVSBridge') {
1317
1318 $raw .= "\tovs_type $d->{type}\n";
1319 $done->{ovs_type} = 1;
1320
1321 $raw .= "\tovs_ports $d->{ovs_ports}\n" if $d->{ovs_ports};
1322 $done->{ovs_ports} = 1;
2d1e9a02
AD
1323
1324 $raw .= "\tovs_mtu $d->{mtu}\n" if $d->{mtu};
1325 $done->{mtu} = 1;
1326
9b7b13a1
DM
1327 } elsif ($d->{type} eq 'OVSPort' || $d->{type} eq 'OVSIntPort' ||
1328 $d->{type} eq 'OVSBond') {
1329
1330 $d->{autostart} = 0; # started by the bridge
1331
2a751938
DM
1332 if (defined($d->{ovs_tag})) {
1333 &$set_ovs_option($d, tag => $d->{ovs_tag});
1334 }
1335 $done->{ovs_tag} = 1;
1336
9b7b13a1
DM
1337 if ($d->{type} eq 'OVSBond') {
1338
1339 $d->{bond_mode} = 'active-backup' if !$d->{bond_mode};
1340
1341 $ovs_bond_modes->{$d->{bond_mode}} ||
1342 die "OVS does not support bond mode '$d->{bond_mode}\n";
1343
a68760b6
DM
1344 if ($d->{bond_mode} eq 'lacp-balance-slb') {
1345 &$set_ovs_option($d, lacp => 'active');
1346 &$set_ovs_option($d, bond_mode => 'balance-slb');
1347 } elsif ($d->{bond_mode} eq 'lacp-balance-tcp') {
1348 &$set_ovs_option($d, lacp => 'active');
1349 &$set_ovs_option($d, bond_mode => 'balance-tcp');
1350 } else {
1351 &$set_ovs_option($d, lacp => undef);
1352 &$set_ovs_option($d, bond_mode => $d->{bond_mode});
1353 }
9b7b13a1
DM
1354 $done->{bond_mode} = 1;
1355
1356 $raw .= "\tovs_bonds $d->{ovs_bonds}\n" if $d->{ovs_bonds};
1357 $done->{ovs_bonds} = 1;
1358 }
1359
9b7b13a1
DM
1360 $raw .= "\tovs_type $d->{type}\n";
1361 $done->{ovs_type} = 1;
1362
bd9cc42d 1363 if (my $bridge = $d->{ovs_bridge}) {
d34d7393
AD
1364 if ($ifupdown2) {
1365 $raw = "auto $iface\n$raw";
1366 } else {
1367 $raw = "allow-$bridge $iface\n$raw";
1368 }
1369
bd9cc42d 1370 $raw .= "\tovs_bridge $bridge\n";
9b7b13a1
DM
1371 $done->{ovs_bridge} = 1;
1372 }
2d1e9a02
AD
1373
1374 $raw .= "\tovs_mtu $d->{mtu}\n" if $d->{mtu};
1375 $done->{mtu} = 1;
9b7b13a1
DM
1376 }
1377
48ab17b3
WB
1378 if ($first_block) {
1379 # print other settings
9a052564 1380 foreach my $k (sort keys %$d) {
48ab17b3
WB
1381 next if $done->{$k};
1382 next if !$d->{$k};
1383 $raw .= "\t$k $d->{$k}\n";
1384 }
e143e9d8
DM
1385 }
1386
48ab17b3 1387 foreach my $option (@{$d->{"options$suffix"}}) {
e143e9d8
DM
1388 $raw .= "\t$option\n";
1389 }
1390
ed4e6e0c 1391 # add comments
48ab17b3 1392 my $comments = $d->{"comments$suffix"} || '';
ed4e6e0c
DM
1393 foreach my $cl (split(/\n/, $comments)) {
1394 $raw .= "#$cl\n";
72ca6520
DM
1395 }
1396
e143e9d8
DM
1397 $raw .= "\n";
1398
1399 return $raw;
1400}
1401
78325766 1402
e143e9d8 1403sub write_etc_network_interfaces {
48ab17b3 1404 my ($filename, $fh, $config) = @_;
bc6713df 1405 my $ifupdown2 = -e '/usr/share/ifupdown2/ifupdown2';
b7c4f378 1406 my $raw = __write_etc_network_interfaces($config, $ifupdown2);
1b505ae2 1407 PVE::Tools::safe_print($filename, $fh, encode('UTF-8', $raw));
78325766
WB
1408}
1409sub __write_etc_network_interfaces {
b7c4f378 1410 my ($config, $ifupdown2) = @_;
48ab17b3
WB
1411
1412 my $ifaces = $config->{ifaces};
1413 my @options = @{$config->{options}};
e143e9d8 1414
9b7b13a1
DM
1415 my $used_ports = {};
1416
1417 foreach my $iface (keys %$ifaces) {
1418 my $d = $ifaces->{$iface};
1419
9197b046
TL
1420 my ($cidr, $cidr6) = (delete $d->{cidr}, delete $d->{cidr6});
1421 $d->{address} //= $cidr;
1422 $d->{address6} //= $cidr6;
2896245e 1423
9b7b13a1
DM
1424 my $ports = '';
1425 foreach my $k (qw(bridge_ports ovs_ports slaves ovs_bonds)) {
1426 $ports .= " $d->{$k}" if $d->{$k};
1427 }
1428
1429 foreach my $p (PVE::Tools::split_list($ports)) {
1430 die "port '$p' is already used on interface '$used_ports->{$p}'\n"
1431 if $used_ports->{$p} && $used_ports->{$p} ne $iface;
1432 $used_ports->{$p} = $iface;
1433 }
1434 }
1435
1436 # delete unused OVS ports
1437 foreach my $iface (keys %$ifaces) {
1438 my $d = $ifaces->{$iface};
94d786b3 1439 if ($d->{type} eq 'OVSPort' || $d->{type} eq 'OVSIntPort' ||
9b7b13a1
DM
1440 $d->{type} eq 'OVSBond') {
1441 my $brname = $used_ports->{$iface};
94d786b3 1442 if (!$brname || !$ifaces->{$brname}) {
3dabe28a 1443 if ($iface =~ /^$PVE::Network::PHYSICAL_NIC_RE/) {
040fc87d
TL
1444 $ifaces->{$iface} = {
1445 type => 'eth',
1446 exists => 1,
1447 method => 'manual',
1448 families => ['inet'],
1449 };
516a50a4
WB
1450 } else {
1451 delete $ifaces->{$iface};
1452 }
9b7b13a1
DM
1453 next;
1454 }
1455 my $bd = $ifaces->{$brname};
1456 if ($bd->{type} ne 'OVSBridge') {
1457 delete $ifaces->{$iface};
1458 next;
1459 }
1460 }
1461 }
1462
1463 # create OVS bridge ports
1464 foreach my $iface (keys %$ifaces) {
1465 my $d = $ifaces->{$iface};
1466 if ($d->{type} eq 'OVSBridge' && $d->{ovs_ports}) {
1467 foreach my $p (split (/\s+/, $d->{ovs_ports})) {
1468 my $n = $ifaces->{$p};
1469 die "OVS bridge '$iface' - unable to find port '$p'\n"
1470 if !$n;
21d32c95 1471 $n->{autostart} = 0;
9b7b13a1
DM
1472 if ($n->{type} eq 'eth') {
1473 $n->{type} = 'OVSPort';
94d786b3 1474 $n->{ovs_bridge} = $iface;
9b7b13a1
DM
1475 } elsif ($n->{type} eq 'OVSBond' || $n->{type} eq 'OVSPort' ||
1476 $n->{type} eq 'OVSIntPort') {
1477 $n->{ovs_bridge} = $iface;
1478 } else {
1479 die "interface '$p' is not defined as OVS port/bond\n";
1480 }
9b053d70
AD
1481
1482 &$check_mtu($ifaces, $iface, $p);
9b7b13a1
DM
1483 }
1484 }
1485 }
1486
1487 # check OVS bond ports
1488 foreach my $iface (keys %$ifaces) {
1489 my $d = $ifaces->{$iface};
1490 if ($d->{type} eq 'OVSBond' && $d->{ovs_bonds}) {
1491 foreach my $p (split (/\s+/, $d->{ovs_bonds})) {
1492 my $n = $ifaces->{$p};
fe2a773c 1493 $n->{autostart} = 1;
9b7b13a1
DM
1494 die "OVS bond '$iface' - unable to find slave '$p'\n"
1495 if !$n;
1496 die "OVS bond '$iface' - wrong interface type on slave '$p' " .
1497 "('$n->{type}' != 'eth')\n" if $n->{type} ne 'eth';
9b053d70 1498 &$check_mtu($ifaces, $iface, $p);
9b7b13a1
DM
1499 }
1500 }
1501 }
1502
0115696f
AD
1503 # check bond
1504 foreach my $iface (keys %$ifaces) {
1505 my $d = $ifaces->{$iface};
329dfb64 1506 next if !($d->{type} eq 'bond' && $d->{slaves});
6f830d1d 1507
329dfb64
TL
1508 my $bond_primary_is_slave = undef;
1509 foreach my $p (split (/\s+/, $d->{slaves})) {
1510 my $n = $ifaces->{$p};
1511 $n->{autostart} = 1;
1512
1513 die "bond '$iface' - unable to find slave '$p'\n" if !$n;
1514 die "bond '$iface' - wrong interface type on slave '$p' ('$n->{type}' != 'eth or bond')\n"
1515 if ($n->{type} ne 'eth' && $n->{type} ne 'bond');
1516
1517 $check_mtu->($ifaces, $iface, $p);
1518 $bond_primary_is_slave = 1 if $d->{'bond-primary'} && $d->{'bond-primary'} eq $p;
0115696f 1519 }
329dfb64 1520 die "bond '$iface' - bond-primary interface is not a slave" if $d->{'bond-primary'} && !$bond_primary_is_slave;
0115696f
AD
1521 }
1522
95aa8788
AD
1523 # check vxlan
1524 my $vxlans = {};
1525 foreach my $iface (keys %$ifaces) {
1526 my $d = $ifaces->{$iface};
1527
1528 if ($d->{type} eq 'vxlan' && $d->{'vxlan-id'}) {
1529 my $vxlanid = $d->{'vxlan-id'};
94d786b3 1530 die "iface $iface - duplicate vxlan-id $vxlanid already used in $vxlans->{$vxlanid}\n" if $vxlans->{$vxlanid};
95aa8788
AD
1531 $vxlans->{$vxlanid} = $iface;
1532 }
1533
1534 my $ips = 0;
1535 ++$ips if defined $d->{'vxlan-svcnodeip'};
1536 ++$ips if defined $d->{'vxlan-remoteip'};
1537 ++$ips if defined $d->{'vxlan-local-tunnelip'};
1538 if ($ips > 1) {
94d786b3 1539 die "iface $iface - vxlan-svcnodeip, vxlan-remoteip and vxlan-localtunnelip are mutually exclusive\n";
95aa8788
AD
1540 }
1541
1542 if (defined($d->{'vxlan-svcnodeip'}) != defined($d->{'vxlan-physdev'})) {
94d786b3 1543 die "iface $iface - vxlan-svcnodeip and vxlan-physdev must be define together\n";
95aa8788 1544 }
9b053d70 1545 #fixme : check if vxlan mtu is lower than 50bytes than physical interface where tunnel is going out
95aa8788
AD
1546 }
1547
c4e56470
AD
1548 # check vlan
1549 foreach my $iface (keys %$ifaces) {
1550 my $d = $ifaces->{$iface};
bbe7d3ed
AD
1551 if ($d->{type} eq 'vlan') {
1552
1553 my $p = undef;
1554 my $vlanid = undef;
1555
1556 if ($iface =~ m/^(\S+)\.(\d+)$/) {
1557 $p = $1;
1558 $vlanid = $2;
1559 delete $d->{'vlan-raw-device'} if $d->{'vlan-raw-device'};
9ca89b87
AD
1560 delete $d->{'vlan-id'} if $d->{'vlan-id'};
1561
bbe7d3ed
AD
1562 } else {
1563 die "missing vlan-raw-device option" if !$d->{'vlan-raw-device'};
1564 $p = $d->{'vlan-raw-device'};
1565
1566 if ($iface =~ m/^vlan(\d+)$/) {
1567 $vlanid = $1;
1568 delete $d->{'vlan-id'} if $d->{'vlan-id'};
1569 } else {
1570 die "custom vlan interface name need ifupdown2" if !$ifupdown2;
1571 die "missing vlan-id option" if !$d->{'vlan-id'};
1572 $vlanid = $d->{'vlan-id'};
1573 }
1574 }
c4e56470
AD
1575 my $n = $ifaces->{$p};
1576
bbe7d3ed 1577 die "vlan '$iface' - vlan-id $vlanid should be <= 4094\n" if $vlanid > 4094;
c4e56470 1578 die "vlan '$iface' - unable to find parent '$p'\n"
fc158d0d 1579 if !$n;
c4e56470 1580
c8ff0bdf 1581 if ($n->{type} ne 'eth' && $n->{type} ne 'bridge' && $n->{type} ne 'bond' && $n->{type} ne 'vlan') {
c4e56470 1582 die "vlan '$iface' - wrong interface type on parent '$p' " .
8f5d56bf 1583 "('$n->{type}' != 'eth|bond|bridge|vlan' )\n";
c4e56470 1584 }
8f5d56bf 1585
000e32bc 1586 &$check_mtu($ifaces, $p, $iface);
8f5d56bf 1587
c4e56470
AD
1588 }
1589 }
1590
d949babe
AD
1591 # check uplink
1592 my $uplinks = {};
1593 foreach my $iface (keys %$ifaces) {
1594 my $d = $ifaces->{$iface};
1595 if (my $uplinkid = $d->{'uplink-id'}) {
1596 die "iface '$iface' - uplink-id $uplinkid is only allowed on physical and linux bond interfaces\n"
9bbc4e17 1597 if $d->{type} ne 'eth' && $d->{type} ne 'bond';
d949babe
AD
1598
1599 die "iface '$iface' - uplink-id $uplinkid is already assigned on '$uplinks->{$uplinkid}'\n"
1600 if $uplinks->{$uplinkid};
1601
1602 $uplinks->{$uplinkid} = $iface;
1603 }
1604 }
1605
9a052564
AD
1606 # check bridgeport option
1607 my $bridgeports = {};
1608 my $bridges = {};
a70e9925
AD
1609 my $ifaces_copy = { %$ifaces };
1610 foreach my $iface (keys %$ifaces_copy) {
1611 my $d = $ifaces_copy->{$iface};
9a052564 1612 if ($d->{type} eq 'bridge') {
8342b610 1613 foreach my $p (split (/\s+/, $d->{bridge_ports} // '')) {
a70e9925
AD
1614 if($p =~ m/(\S+)\.(\d+)$/) {
1615 my $vlanparent = $1;
1616 if (!defined($ifaces_copy->{$p})) {
1617 $ifaces_copy->{$p}->{type} = 'vlan';
1618 $ifaces_copy->{$p}->{method} = 'manual';
1619 $ifaces_copy->{$p}->{method6} = 'manual';
1620 $ifaces_copy->{$p}->{mtu} = $ifaces_copy->{$vlanparent}->{mtu} if defined($ifaces_copy->{$1}->{mtu});
1621 }
1622 }
1623 my $n = $ifaces_copy->{$p};
055f076b 1624 die "bridge '$iface' - unable to find bridge port '$p'\n" if !$n;
6f830d1d 1625 die "iface $p - ip address can't be set on interface if bridged in $iface\n"
dd3004e2 1626 if ($n->{method} && $n->{method} eq 'static' && $n->{address} ne '0.0.0.0') ||
eeafe02d 1627 ($n->{method6} && $n->{method6} eq 'static' && $n->{address6} ne '::');
a70e9925 1628 &$check_mtu($ifaces_copy, $p, $iface);
9a052564
AD
1629 $bridgeports->{$p} = $iface;
1630 }
1631 $bridges->{$iface} = $d;
1632 }
1633 }
1634
1635 foreach my $iface (keys %$ifaces) {
1636 my $d = $ifaces->{$iface};
1637
1638 foreach my $k (qw(bridge-learning bridge-arp-nd-suppress bridge-unicast-flood bridge-multicast-flood bridge-access)) {
94d786b3 1639 die "iface $iface - $k: bridge port specific options can be used only on interfaces attached to a bridge\n"
9a052564
AD
1640 if $d->{$k} && !$bridgeports->{$iface};
1641 }
1642
1643 if ($d->{'bridge-access'} && !$bridges->{$bridgeports->{$iface}}->{bridge_vlan_aware}) {
94d786b3 1644 die "iface $iface - bridge-access option can be only used if interface is in a vlan aware bridge\n";
9a052564
AD
1645 }
1646 }
1647
9d27ef41
WB
1648 my $raw = <<'NETWORKDOC';
1649# network interface settings; autogenerated
1650# Please do NOT modify this file directly, unless you know what
1651# you're doing.
1652#
b3e3b51b 1653# If you want to manage parts of the network configuration manually,
9d27ef41
WB
1654# please utilize the 'source' or 'source-directory' directives to do
1655# so.
b3e3b51b 1656# PVE will preserve these directives, but will NOT read its network
9d27ef41
WB
1657# configuration from sourced files, so do not attempt to move any of
1658# the PVE managed interfaces into external files!
1659
1660NETWORKDOC
e143e9d8
DM
1661
1662 my $printed = {};
1663
ed4e6e0c 1664 my $if_type_hash = {
562fad0b 1665 loopback => 100000,
a85812af 1666 dummy => 100000,
562fad0b 1667 eth => 200000,
51eec390 1668 OVSPort => 200000,
36bbe29d
AD
1669 OVSIntPort => 300000,
1670 OVSBond => 400000,
1671 bond => 400000,
1672 bridge => 500000,
1673 OVSBridge => 500000,
1674 vlan => 600000,
1675 vxlan => 600000,
9b7b13a1 1676 };
ed4e6e0c
DM
1677
1678 my $lookup_type_prio = sub {
51eec390 1679 my ($iface, $ifaces) = @_;
ed4e6e0c 1680
0c0bcf7c
WB
1681 my ($rootiface, @rest) = split(/[.:]/, $iface);
1682 my $childlevel = scalar(@rest);
87ff065c
TL
1683 my $type = $ifaces->{$rootiface}->{type};
1684 return if !$type || $type eq 'unknown';
ed4e6e0c 1685
87ff065c 1686 return $if_type_hash->{$type} + $childlevel
ed4e6e0c
DM
1687 };
1688
c9dc8645
DM
1689 foreach my $iface (sort {
1690 my $ref1 = $ifaces->{$a};
1691 my $ref2 = $ifaces->{$b};
51eec390
AD
1692 my $tp1 = &$lookup_type_prio($a, $ifaces);
1693 my $tp2 = &$lookup_type_prio($b, $ifaces);
e143e9d8 1694
7a822100
WB
1695 # Only recognized types are in relation to each other. If one type
1696 # is unknown then only consider the interfaces' priority attributes.
1697 $tp1 = $tp2 = 0 if !defined($tp1) || !defined($tp2);
1698
1699 my $p1 = $tp1 + ($ref1->{priority} // 50000);
1700 my $p2 = $tp2 + ($ref2->{priority} // 50000);
ed4e6e0c
DM
1701
1702 return $p1 <=> $p2 if $p1 != $p2;
c9dc8645
DM
1703
1704 return $a cmp $b;
11e7facb 1705 } keys %$ifaces) {
c9dc8645 1706 next if $printed->{$iface};
11e7facb 1707 my $d = $ifaces->{$iface};
562fad0b
WB
1708 my $pri = $d->{priority} // 0;
1709 if (@options && $options[0]->[0] < $pri) {
48ab17b3
WB
1710 do {
1711 $raw .= (shift @options)->[1] . "\n";
562fad0b 1712 } while (@options && $options[0]->[0] < $pri);
48ab17b3
WB
1713 $raw .= "\n";
1714 }
1715
c9dc8645 1716 $printed->{$iface} = 1;
f48815f8 1717 if ($d->{autostart}) {
d34d7393 1718 if ($d->{type} eq 'OVSBridge' && !$ifupdown2) {
f48815f8
AD
1719 # cannot use 'auto' for OVS, would add race with systemd ifup@.service
1720 $raw .= "allow-ovs $iface\n";
1721 } else {
1722 $raw .= "auto $iface\n";
1723 }
4ac94c72
AD
1724 }
1725
48ab17b3 1726 my $i = 0; # some options should be printed only once
b7c4f378 1727 $raw .= __interface_to_string($iface, $d, $_, !$i++, $ifupdown2) foreach @{$d->{families}};
e143e9d8 1728 }
48ab17b3
WB
1729
1730 $raw .= $_->[1] . "\n" foreach @options;
78325766 1731 return $raw;
e143e9d8
DM
1732}
1733
1734register_file('interfaces', "/etc/network/interfaces",
1735 \&read_etc_network_interfaces,
1736 \&write_etc_network_interfaces);
1737
ddd3d224
DM
1738
1739sub read_iscsi_initiatorname {
1740 my ($filename, $fd) = @_;
1741
1742 while (defined(my $line = <$fd>)) {
1743 if ($line =~ m/^InitiatorName=(\S+)$/) {
1744 return $1;
1745 }
1746 }
1747
1748 return 'undefined';
1749}
1750
9bbc4e17 1751register_file('initiatorname', "/etc/iscsi/initiatorname.iscsi",
ddd3d224
DM
1752 \&read_iscsi_initiatorname);
1753
6c3aef09
DM
1754sub read_apt_auth {
1755 my ($filename, $fd) = @_;
1756
1757 local $/;
1758
b8e02bc2 1759 my $raw = defined($fd) ? <$fd> : '';
6c3aef09
DM
1760
1761 $raw =~ s/^\s+//;
1762
9bbc4e17 1763
6c3aef09
DM
1764 my @tokens = split(/\s+/, $raw);
1765
1766 my $data = {};
1767
1768 my $machine;
1769 while (defined(my $tok = shift @tokens)) {
1770
1771 $machine = shift @tokens if $tok eq 'machine';
1772 next if !$machine;
1773 $data->{$machine} = {} if !$data->{$machine};
1774
1775 $data->{$machine}->{login} = shift @tokens if $tok eq 'login';
1776 $data->{$machine}->{password} = shift @tokens if $tok eq 'password';
1777 };
1778
1779 return $data;
1780}
1781
1782my $format_apt_auth_data = sub {
1783 my $data = shift;
1784
1785 my $raw = '';
1786
1d15203c
TL
1787 # sort longer entries first, so machine definitions with higher granularity are preferred
1788 for my $machine (sort { length($b) <=> length($a) || $a cmp $b} keys %$data) {
6c3aef09 1789 my $d = $data->{$machine};
1d15203c
TL
1790 next if !defined($d); # allow "deleting" set entries
1791
6c3aef09
DM
1792 $raw .= "machine $machine\n";
1793 $raw .= " login $d->{login}\n" if $d->{login};
1794 $raw .= " password $d->{password}\n" if $d->{password};
1795 $raw .= "\n";
1796 }
1797
1798 return $raw;
1799};
1800
1801sub write_apt_auth {
1802 my ($filename, $fh, $data) = @_;
1803
1d15203c 1804 my $raw = $format_apt_auth_data->($data);
6c3aef09
DM
1805
1806 die "write failed: $!" unless print $fh "$raw\n";
9bbc4e17 1807
6c3aef09
DM
1808 return $data;
1809}
1810
1811sub update_apt_auth {
1812 my ($filename, $fh, $data) = @_;
1813
1814 my $orig = read_apt_auth($filename, $fh);
1815
1816 foreach my $machine (keys %$data) {
1817 $orig->{$machine} = $data->{$machine};
1818 }
1819
1d15203c 1820 return $format_apt_auth_data->($orig);
6c3aef09
DM
1821}
1822
1d15203c
TL
1823register_file(
1824 'apt-auth',
1825 "/etc/apt/auth.conf",
1826 \&read_apt_auth,
1827 \&write_apt_auth,
1828 \&update_apt_auth,
1829 perm => 0640,
1830);
6c3aef09 1831
e143e9d8 18321;