tools: getaddrinfo: code/indentation cleanup
[pve-common.git] / src / PVE / INotify.pm
1 package PVE::INotify;
2
3 # todo: maybe we do not need update_file() ?
4
5 use strict;
6 use warnings;
7
8 use POSIX;
9 use IO::File;
10 use IO::Dir;
11 use File::stat;
12 use File::Basename;
13 use Fcntl qw(:DEFAULT :flock);
14 use PVE::SafeSyslog;
15 use PVE::Exception qw(raise_param_exc);
16 use PVE::Network;
17 use PVE::Tools;
18 use PVE::ProcFSTools;
19 use Clone qw(clone);
20 use Linux::Inotify2;
21 use base 'Exporter';
22 use JSON;
23
24 our @EXPORT_OK = qw(read_file write_file register_file);
25
26 my $ccache;
27 my $ccachemap;
28 my $ccacheregex;
29 my $inotify;
30 my $inotify_pid = 0;
31 my $versions;
32 my $shadowfiles = {
33 '/etc/network/interfaces' => '/etc/network/interfaces.new',
34 };
35
36 # to enable cached operation, you need to call 'inotify_init'
37 # inotify handles are a limited resource, so use with care (only
38 # enable the cache if you really need it)
39
40 # Note: please close the inotify handle after you fork
41
42 sub ccache_default_writer {
43 my ($filename, $data) = @_;
44
45 die "undefined config writer for '$filename' :ERROR";
46 }
47
48 sub ccache_default_parser {
49 my ($filename, $srcfd) = @_;
50
51 die "undefined config reader for '$filename' :ERROR";
52 }
53
54 sub ccache_compute_diff {
55 my ($filename, $shadow) = @_;
56
57 my $diff = '';
58
59 open (TMP, "diff -b -N -u '$filename' '$shadow'|");
60
61 while (my $line = <TMP>) {
62 $diff .= $line;
63 }
64
65 close (TMP);
66
67 $diff = undef if !$diff;
68
69 return $diff;
70 }
71
72 sub ccache_info {
73 my ($filename) = @_;
74
75 foreach my $uid (keys %$ccacheregex) {
76 my $ccinfo = $ccacheregex->{$uid};
77 my $dir = $ccinfo->{dir};
78 my $regex = $ccinfo->{regex};
79 if ($filename =~ m|^$dir/+$regex$|) {
80 if (!$ccache->{$filename}) {
81 my $cp = {};
82 while (my ($k, $v) = each %$ccinfo) {
83 $cp->{$k} = $v;
84 }
85 $ccache->{$filename} = $cp;
86 }
87 return ($ccache->{$filename}, $filename);
88 }
89 }
90
91 $filename = $ccachemap->{$filename} if defined ($ccachemap->{$filename});
92
93 die "file '$filename' not added :ERROR" if !defined ($ccache->{$filename});
94
95 return ($ccache->{$filename}, $filename);
96 }
97
98 sub write_file {
99 my ($fileid, $data, $full) = @_;
100
101 my ($ccinfo, $filename) = ccache_info($fileid);
102
103 my $writer = $ccinfo->{writer};
104
105 my $realname = $filename;
106
107 my $shadow;
108 if ($shadow = $shadowfiles->{$filename}) {
109 $realname = $shadow;
110 }
111
112 my $perm = $ccinfo->{perm} || 0644;
113
114 my $tmpname = "$realname.tmp.$$";
115
116 my $res;
117 eval {
118 my $fh = IO::File->new($tmpname, O_WRONLY|O_CREAT, $perm);
119 die "unable to open file '$tmpname' - $!\n" if !$fh;
120
121 $res = &$writer($filename, $fh, $data);
122
123 die "closing file '$tmpname' failed - $!\n" unless close $fh;
124 };
125 my $err = $@;
126
127 $ccinfo->{version} = undef;
128
129 if ($err) {
130 unlink $tmpname;
131 die $err;
132 }
133
134 if (!rename($tmpname, $realname)) {
135 my $msg = "close (rename) atomic file '$filename' failed: $!\n";
136 unlink $tmpname;
137 die $msg;
138 }
139
140 my $diff;
141 if ($shadow && $full) {
142 $diff = ccache_compute_diff ($filename, $shadow);
143 }
144
145 if ($full) {
146 return { data => $res, changes => $diff };
147 }
148
149 return $res;
150 }
151
152 sub update_file {
153 my ($fileid, $data, @args) = @_;
154
155 my ($ccinfo, $filename) = ccache_info($fileid);
156
157 my $update = $ccinfo->{update};
158
159 die "unable to update/merge data" if !$update;
160
161 my $lkfn = "$filename.lock";
162
163 my $timeout = 10;
164
165 my $fd;
166
167 my $code = sub {
168
169 $fd = IO::File->new ($filename, "r");
170
171 my $new = &$update($filename, $fd, $data, @args);
172
173 if (defined($new)) {
174 PVE::Tools::file_set_contents($filename, $new, $ccinfo->{perm});
175 } else {
176 unlink $filename;
177 }
178 };
179
180 PVE::Tools::lock_file($lkfn, $timeout, $code);
181 my $err = $@;
182
183 close($fd) if defined($fd);
184
185 die $err if $err;
186
187 return undef;
188 }
189
190 sub discard_changes {
191 my ($fileid, $full) = @_;
192
193 my ($ccinfo, $filename) = ccache_info($fileid);
194
195 if (my $copy = $shadowfiles->{$filename}) {
196 unlink $copy;
197 }
198
199 return read_file ($filename, $full);
200 }
201
202 sub poll_changes {
203 my ($filename) = @_;
204
205 poll() if $inotify; # read new inotify events
206
207 $versions->{$filename} = 0 if !defined ($versions->{$filename});
208
209 return $versions->{$filename};
210 }
211
212 sub read_file {
213 my ($fileid, $full) = @_;
214
215 my $parser;
216
217 my ($ccinfo, $filename) = ccache_info($fileid);
218
219 $parser = $ccinfo->{parser};
220
221 my $fd;
222 my $shadow;
223
224 my $cver = poll_changes($filename);
225
226 if (my $copy = $shadowfiles->{$filename}) {
227 if ($fd = IO::File->new ($copy, "r")) {
228 $shadow = $copy;
229 } else {
230 $fd = IO::File->new ($filename, "r");
231 }
232 } else {
233 $fd = IO::File->new ($filename, "r");
234 }
235
236 my $acp = $ccinfo->{always_call_parser};
237
238 if (!$fd) {
239 $ccinfo->{version} = undef;
240 $ccinfo->{data} = undef;
241 $ccinfo->{diff} = undef;
242 return undef if !$acp;
243 }
244
245 my $noclone = $ccinfo->{noclone};
246
247 # file unchanged?
248 if (!$ccinfo->{nocache} &&
249 $inotify && $cver &&
250 defined ($ccinfo->{data}) &&
251 defined ($ccinfo->{version}) &&
252 ($ccinfo->{readonce} ||
253 ($ccinfo->{version} == $cver))) {
254
255 my $ret;
256 if (!$noclone && ref ($ccinfo->{data})) {
257 $ret->{data} = clone ($ccinfo->{data});
258 } else {
259 $ret->{data} = $ccinfo->{data};
260 }
261 $ret->{changes} = $ccinfo->{diff};
262
263 return $full ? $ret : $ret->{data};
264 }
265
266 my $diff;
267
268 if ($shadow) {
269 $diff = ccache_compute_diff ($filename, $shadow);
270 }
271
272 my $res = &$parser($filename, $fd);
273
274 if (!$ccinfo->{nocache}) {
275 $ccinfo->{version} = $cver;
276 }
277
278 # we cache data with references, so we always need to
279 # clone this data. Else the original data may get
280 # modified.
281 $ccinfo->{data} = $res;
282
283 # also store diff
284 $ccinfo->{diff} = $diff;
285
286 my $ret;
287 if (!$noclone && ref ($ccinfo->{data})) {
288 $ret->{data} = clone ($ccinfo->{data});
289 } else {
290 $ret->{data} = $ccinfo->{data};
291 }
292 $ret->{changes} = $ccinfo->{diff};
293
294 return $full ? $ret : $ret->{data};
295 }
296
297 sub parse_ccache_options {
298 my ($ccinfo, %options) = @_;
299
300 foreach my $opt (keys %options) {
301 my $v = $options{$opt};
302 if ($opt eq 'readonce') {
303 $ccinfo->{$opt} = $v;
304 } elsif ($opt eq 'nocache') {
305 $ccinfo->{$opt} = $v;
306 } elsif ($opt eq 'shadow') {
307 $ccinfo->{$opt} = $v;
308 } elsif ($opt eq 'perm') {
309 $ccinfo->{$opt} = $v;
310 } elsif ($opt eq 'noclone') {
311 # noclone flag for large read-only data chunks like aplinfo
312 $ccinfo->{$opt} = $v;
313 } elsif ($opt eq 'always_call_parser') {
314 # when set, we call parser even when the file does not exists.
315 # this allows the parser to return some default
316 $ccinfo->{$opt} = $v;
317 } else {
318 die "internal error - unsupported option '$opt'";
319 }
320 }
321 }
322
323 sub register_file {
324 my ($id, $filename, $parser, $writer, $update, %options) = @_;
325
326 die "can't register file '$filename' after inotify_init" if $inotify;
327
328 die "file '$filename' already added :ERROR" if defined ($ccache->{$filename});
329 die "ID '$id' already used :ERROR" if defined ($ccachemap->{$id});
330
331 my $ccinfo = {};
332
333 $ccinfo->{id} = $id;
334 $ccinfo->{parser} = $parser || \&ccache_default_parser;
335 $ccinfo->{writer} = $writer || \&ccache_default_writer;
336 $ccinfo->{update} = $update;
337
338 parse_ccache_options($ccinfo, %options);
339
340 if ($options{shadow}) {
341 $shadowfiles->{$filename} = $options{shadow};
342 }
343
344 $ccachemap->{$id} = $filename;
345 $ccache->{$filename} = $ccinfo;
346 }
347
348 sub register_regex {
349 my ($dir, $regex, $parser, $writer, $update, %options) = @_;
350
351 die "can't register regex after inotify_init" if $inotify;
352
353 my $uid = "$dir/$regex";
354 die "regular expression '$uid' already added :ERROR" if defined ($ccacheregex->{$uid});
355
356 my $ccinfo = {};
357
358 $ccinfo->{dir} = $dir;
359 $ccinfo->{regex} = $regex;
360 $ccinfo->{parser} = $parser || \&ccache_default_parser;
361 $ccinfo->{writer} = $writer || \&ccache_default_writer;
362 $ccinfo->{update} = $update;
363
364 parse_ccache_options($ccinfo, %options);
365
366 $ccacheregex->{$uid} = $ccinfo;
367 }
368
369 sub poll {
370 return if !$inotify;
371
372 if ($inotify_pid != $$) {
373 syslog ('err', "got inotify poll request in wrong process - disabling inotify");
374 $inotify = undef;
375 } else {
376 1 while $inotify && $inotify->poll;
377 }
378 }
379
380 sub flushcache {
381 foreach my $filename (keys %$ccache) {
382 $ccache->{$filename}->{version} = undef;
383 $ccache->{$filename}->{data} = undef;
384 $ccache->{$filename}->{diff} = undef;
385 }
386 }
387
388 sub inotify_close {
389 $inotify = undef;
390 }
391
392 sub inotify_init {
393
394 die "only one inotify instance allowed" if $inotify;
395
396 $inotify = Linux::Inotify2->new()
397 || die "Unable to create new inotify object: $!";
398
399 $inotify->blocking (0);
400
401 $versions = {};
402
403 my $dirhash = {};
404 foreach my $fn (keys %$ccache) {
405 my $dir = dirname ($fn);
406 my $base = basename ($fn);
407
408 $dirhash->{$dir}->{$base} = $fn;
409
410 if (my $sf = $shadowfiles->{$fn}) {
411 $base = basename ($sf);
412 $dir = dirname ($sf);
413 $dirhash->{$dir}->{$base} = $fn; # change version of original file!
414 }
415 }
416
417 foreach my $uid (keys %$ccacheregex) {
418 my $ccinfo = $ccacheregex->{$uid};
419 $dirhash->{$ccinfo->{dir}}->{_regex} = 1;
420 }
421
422 $inotify_pid = $$;
423
424 foreach my $dir (keys %$dirhash) {
425
426 my $evlist = IN_MODIFY|IN_ATTRIB|IN_MOVED_FROM|IN_MOVED_TO|IN_DELETE|IN_CREATE;
427 $inotify->watch ($dir, $evlist, sub {
428 my $e = shift;
429 my $name = $e->name;
430
431 if ($inotify_pid != $$) {
432 syslog ('err', "got inotify event in wrong process");
433 }
434
435 if ($e->IN_ISDIR || !$name) {
436 return;
437 }
438
439 if ($e->IN_Q_OVERFLOW) {
440 syslog ('info', "got inotify overflow - flushing cache");
441 flushcache();
442 return;
443 }
444
445 if ($e->IN_UNMOUNT) {
446 syslog ('err', "got 'unmount' event on '$name' - disabling inotify");
447 $inotify = undef;
448 }
449 if ($e->IN_IGNORED) {
450 syslog ('err', "got 'ignored' event on '$name' - disabling inotify");
451 $inotify = undef;
452 }
453
454 if ($dirhash->{$dir}->{_regex}) {
455 foreach my $uid (keys %$ccacheregex) {
456 my $ccinfo = $ccacheregex->{$uid};
457 next if $dir ne $ccinfo->{dir};
458 my $regex = $ccinfo->{regex};
459 if ($regex && ($name =~ m|^$regex$|)) {
460
461 my $fn = "$dir/$name";
462 $versions->{$fn}++;
463 #print "VERSION:$fn:$versions->{$fn}\n";
464 }
465 }
466 } elsif (my $fn = $dirhash->{$dir}->{$name}) {
467
468 $versions->{$fn}++;
469 #print "VERSION:$fn:$versions->{$fn}\n";
470 }
471 });
472 }
473
474 foreach my $dir (keys %$dirhash) {
475 foreach my $name (keys %{$dirhash->{$dir}}) {
476 if ($name eq '_regex') {
477 foreach my $uid (keys %$ccacheregex) {
478 my $ccinfo = $ccacheregex->{$uid};
479 next if $dir ne $ccinfo->{dir};
480 my $re = $ccinfo->{regex};
481 if (my $fd = IO::Dir->new ($dir)) {
482 while (defined(my $de = $fd->read)) {
483 if ($de =~ m/^$re$/) {
484 my $fn = "$dir/$de";
485 $versions->{$fn}++; # init with version
486 #print "init:$fn:$versions->{$fn}\n";
487 }
488 }
489 }
490 }
491 } else {
492 my $fn = $dirhash->{$dir}->{$name};
493 $versions->{$fn}++; # init with version
494 #print "init:$fn:$versions->{$fn}\n";
495 }
496 }
497 }
498 }
499
500 my $cached_nodename;
501
502 sub nodename {
503
504 return $cached_nodename if $cached_nodename;
505
506 my ($sysname, $nodename) = POSIX::uname();
507
508 $nodename =~ s/\..*$//; # strip domain part, if any
509
510 die "unable to read node name\n" if !$nodename;
511
512 $cached_nodename = $nodename;
513
514 return $cached_nodename;
515 }
516
517 sub read_etc_hostname {
518 my ($filename, $fd) = @_;
519
520 my $hostname = <$fd>;
521
522 chomp $hostname;
523
524 $hostname =~ s/\..*$//; # strip domain part, if any
525
526 return $hostname;
527 }
528
529 sub write_etc_hostname {
530 my ($filename, $fh, $hostname) = @_;
531
532 die "write failed: $!" unless print $fh "$hostname\n";
533
534 return $hostname;
535 }
536
537 register_file('hostname', "/etc/hostname",
538 \&read_etc_hostname,
539 \&write_etc_hostname);
540
541 sub read_etc_resolv_conf {
542 my ($filename, $fh) = @_;
543
544 my $res = {};
545
546 my $nscount = 0;
547 while (my $line = <$fh>) {
548 chomp $line;
549 if ($line =~ m/^(search|domain)\s+(\S+)\s*/) {
550 $res->{search} = $2;
551 } elsif ($line =~ m/^\s*nameserver\s+($PVE::Tools::IPRE)\s*/) {
552 $nscount++;
553 if ($nscount <= 3) {
554 $res->{"dns$nscount"} = $1;
555 }
556 }
557 }
558
559 return $res;
560 }
561
562 sub update_etc_resolv_conf {
563 my ($filename, $fh, $resolv, @args) = @_;
564
565 my $data = "";
566
567 $data = "search $resolv->{search}\n"
568 if $resolv->{search};
569
570 my $written = {};
571 foreach my $k ("dns1", "dns2", "dns3") {
572 my $ns = $resolv->{$k};
573 if ($ns && $ns ne '0.0.0.0' && !$written->{$ns}) {
574 $written->{$ns} = 1;
575 $data .= "nameserver $ns\n";
576 }
577 }
578
579 while (my $line = <$fh>) {
580 next if $line =~ m/^(search|domain|nameserver)\s+/;
581 $data .= $line
582 }
583
584 return $data;
585 }
586
587 register_file('resolvconf', "/etc/resolv.conf",
588 \&read_etc_resolv_conf, undef,
589 \&update_etc_resolv_conf);
590
591 sub read_etc_timezone {
592 my ($filename, $fd) = @_;
593
594 my $timezone = <$fd>;
595
596 chomp $timezone;
597
598 return $timezone;
599 }
600
601 sub write_etc_timezone {
602 my ($filename, $fh, $timezone) = @_;
603
604 my $tzinfo = "/usr/share/zoneinfo/$timezone";
605
606 raise_param_exc({ 'timezone' => "No such timezone" })
607 if (! -f $tzinfo);
608
609 ($timezone) = $timezone =~ m/^(.*)$/; # untaint
610
611 print $fh "$timezone\n";
612
613 unlink ("/etc/localtime");
614 symlink ("/usr/share/zoneinfo/$timezone", "/etc/localtime");
615
616 }
617
618 register_file('timezone', "/etc/timezone",
619 \&read_etc_timezone,
620 \&write_etc_timezone);
621
622 sub read_active_workers {
623 my ($filename, $fh) = @_;
624
625 return [] if !$fh;
626
627 my $res = [];
628 while (defined (my $line = <$fh>)) {
629 if ($line =~ m/^(\S+)\s(0|1)(\s([0-9A-Za-z]{8})(\s(\s*\S.*))?)?$/) {
630 my $upid = $1;
631 my $saved = $2;
632 my $endtime = $4;
633 my $status = $6;
634 if ((my $task = PVE::Tools::upid_decode($upid, 1))) {
635 $task->{upid} = $upid;
636 $task->{saved} = $saved;
637 $task->{endtime} = hex($endtime) if $endtime;
638 $task->{status} = $status if $status;
639 push @$res, $task;
640 }
641 } else {
642 warn "unable to parse line: $line";
643 }
644 }
645
646 return $res;
647
648 }
649
650 sub write_active_workers {
651 my ($filename, $fh, $tasklist) = @_;
652
653 my $raw = '';
654 foreach my $task (@$tasklist) {
655 my $upid = $task->{upid};
656 my $saved = $task->{saved} ? 1 : 0;
657 if ($task->{endtime}) {
658 if ($task->{status}) {
659 $raw .= sprintf("%s %s %08X %s\n", $upid, $saved, $task->{endtime}, $task->{status});
660 } else {
661 $raw .= sprintf("%s %s %08X\n", $upid, $saved, $task->{endtime});
662 }
663 } else {
664 $raw .= "$upid $saved\n";
665 }
666 }
667
668 PVE::Tools::safe_print($filename, $fh, $raw) if $raw;
669 }
670
671 register_file('active', "/var/log/pve/tasks/active",
672 \&read_active_workers,
673 \&write_active_workers);
674
675
676 our $bond_modes = { 'balance-rr' => 0,
677 'active-backup' => 1,
678 'balance-xor' => 2,
679 'broadcast' => 3,
680 '802.3ad' => 4,
681 'balance-tlb' => 5,
682 'balance-alb' => 6,
683 };
684
685 my $ovs_bond_modes = {
686 'active-backup' => 1,
687 'balance-slb' => 1,
688 'lacp-balance-slb' => 1,
689 'lacp-balance-tcp' => 1,
690 };
691
692 #sub get_bond_modes {
693 # return $bond_modes;
694 #}
695
696 my $parse_ovs_option = sub {
697 my ($data) = @_;
698
699 my $opts = {};
700 foreach my $kv (split (/\s+/, $data || '')) {
701 my ($k, $v) = split('=', $kv, 2);
702 $opts->{$k} = $v if $k && $v;
703 }
704 return $opts;
705 };
706
707 my $set_ovs_option = sub {
708 my ($d, %params) = @_;
709
710 my $opts = &$parse_ovs_option($d->{ovs_options});
711
712 foreach my $k (keys %params) {
713 my $v = $params{$k};
714 if ($v) {
715 $opts->{$k} = $v;
716 } else {
717 delete $opts->{$k};
718 }
719 }
720
721 my $res = [];
722 foreach my $k (keys %$opts) {
723 push @$res, "$k=$opts->{$k}";
724 }
725
726 if (my $new = join(' ', @$res)) {
727 $d->{ovs_options} = $new;
728 return $d->{ovs_options};
729 } else {
730 delete $d->{ovs_options};
731 return undef;
732 }
733 };
734
735 my $extract_ovs_option = sub {
736 my ($d, $name) = @_;
737
738 my $opts = &$parse_ovs_option($d->{ovs_options});
739
740 my $v = delete $opts->{$name};
741
742 my $res = [];
743 foreach my $k (keys %$opts) {
744 push @$res, "$k=$opts->{$k}";
745 }
746
747 if (my $new = join(' ', @$res)) {
748 $d->{ovs_options} = $new;
749 } else {
750 delete $d->{ovs_options};
751 }
752
753 return $v;
754 };
755
756 # config => {
757 # ifaces => {
758 # $ifname => {
759 # <optional> exists => BOOL,
760 # <optional> active => BOOL,
761 # <optional> autostart => BOOL,
762 # <auto> priority => INT,
763 #
764 # type => "eth" | "bridge" | "bond" | "loopback" | "OVS*" | ... ,
765 #
766 # families => ["inet", "inet6", ...],
767 #
768 # method => "manual" | "static" | "dhcp" | ... ,
769 # address => IP,
770 # netmask => SUBNET,
771 # broadcast => IP,
772 # gateway => IP,
773 # comments => [ "..." ],
774 #
775 # method6 => "manual" | "static" | "dhcp" | ... ,
776 # address6 => IP,
777 # netmask6 => SUBNET,
778 # gateway6 => IP,
779 # comments6 => [ "..." ],
780 #
781 # <known options>, # like bridge_ports, ovs_*
782 #
783 # # extra/unknown options stored by-family:
784 # options => { <inet options>... }
785 # options6 => { <inet6 options>... }
786 # }
787 # },
788 # options => [
789 # # mappings end up here as well, as we don't need to understand them
790 # [priority,line]
791 # ]
792 # }
793 sub read_etc_network_interfaces {
794 my ($filename, $fh) = @_;
795 my $proc_net_dev = IO::File->new('/proc/net/dev', 'r');
796 my $active = PVE::ProcFSTools::get_active_network_interfaces();
797 return __read_etc_network_interfaces($fh, $proc_net_dev, $active);
798 }
799
800 sub __read_etc_network_interfaces {
801 my ($fh, $proc_net_dev, $active_ifaces) = @_;
802
803 my $config = {};
804 my $ifaces = $config->{ifaces} = {};
805 my $options = $config->{options} = [];
806
807 my $options_alternatives = {
808 'bond-slaves' => 'slaves',
809 'bond_slaves' => 'slaves',
810 'bond-xmit-hash-policy' => 'bond_xmit_hash_policy',
811 'bond-mode' => 'bond_mode',
812 'bond-miimon' =>'bond_miimon',
813 'bridge-vlan-aware' => 'bridge_vlan_aware',
814 'bridge-fd' => 'bridge_fd',
815 'bridge-stp' => 'bridge_stp',
816 'bridge-ports' => 'bridge_ports',
817 'bridge-vids' => 'bridge_vids'
818 };
819
820 my $line;
821
822 if ($proc_net_dev) {
823 while (defined ($line = <$proc_net_dev>)) {
824 if ($line =~ m/^\s*($PVE::Network::PHYSICAL_NIC_RE):.*/) {
825 $ifaces->{$1}->{exists} = 1;
826 }
827 }
828 close($proc_net_dev);
829 }
830
831 # we try to keep order inside the file
832 my $priority = 2; # 1 is reserved for lo
833
834 SECTION: while (defined ($line = <$fh>)) {
835 chomp ($line);
836 next if $line =~ m/^\s*#/;
837
838 if ($line =~ m/^\s*auto\s+(.*)$/) {
839 my @aa = split (/\s+/, $1);
840
841 foreach my $a (@aa) {
842 $ifaces->{$a}->{autostart} = 1;
843 }
844
845 } elsif ($line =~ m/^\s*iface\s+(\S+)\s+(inet6?)\s+(\S+)\s*$/) {
846 my $i = $1;
847 my $family = $2;
848 my $f = { method => $3 }; # by family, merged to $d with a $suffix
849 (my $suffix = $family) =~ s/^inet//;
850
851 my $d = $ifaces->{$i} ||= {};
852 $d->{priority} = $priority++ if !$d->{priority};
853 push @{$d->{families}}, $family;
854
855 while (defined ($line = <$fh>)) {
856 chomp $line;
857 if ($line =~ m/^\s*#(.*?)\s*$/) {
858 # NOTE: we use 'comments' instead of 'comment' to
859 # avoid automatic utf8 conversion
860 $f->{comments} = '' if !$f->{comments};
861 $f->{comments} .= "$1\n";
862 } elsif ($line =~ m/^\s*(?:iface\s
863 |mapping\s
864 |auto\s
865 |allow-
866 |source\s
867 |source-directory\s
868 )/x) {
869 last;
870 } elsif ($line =~ m/^\s*((\S+)\s+(.+))$/) {
871 my $option = $1;
872 my ($id, $value) = ($2, $3);
873
874 $id = $options_alternatives->{$id} if $options_alternatives->{$id};
875
876 if (($id eq 'address') || ($id eq 'netmask') || ($id eq 'broadcast') || ($id eq 'gateway')) {
877 $f->{$id} = $value;
878 } elsif ($id eq 'ovs_type' || $id eq 'ovs_options'|| $id eq 'ovs_bridge' ||
879 $id eq 'ovs_bonds' || $id eq 'ovs_ports') {
880 $d->{$id} = $value;
881 } elsif ($id eq 'slaves' || $id eq 'bridge_ports') {
882 my $devs = {};
883 foreach my $p (split (/\s+/, $value)) {
884 next if $p eq 'none';
885 $devs->{$p} = 1;
886 }
887 my $str = join (' ', sort keys %{$devs});
888 if ($d->{$id}) {
889 $d->{$id} .= ' ' . $str if $str;
890 } else {
891 $d->{$id} = $str || '';
892 }
893 } elsif ($id eq 'bridge_stp') {
894 if ($value =~ m/^\s*(on|yes)\s*$/i) {
895 $d->{$id} = 'on';
896 } else {
897 $d->{$id} = 'off';
898 }
899 } elsif ($id eq 'bridge_fd' || $id eq 'bridge_vids') {
900 $d->{$id} = $value;
901 } elsif ($id eq 'bridge_vlan_aware') {
902 $d->{$id} = 1;
903 } elsif ($id eq 'bond_miimon') {
904 $d->{$id} = $value;
905 } elsif ($id eq 'bond_xmit_hash_policy') {
906 $d->{$id} = $value;
907 } elsif ($id eq 'bond_mode') {
908 # always use names
909 foreach my $bm (keys %$bond_modes) {
910 my $id = $bond_modes->{$bm};
911 if ($id eq $value) {
912 $value = $bm;
913 last;
914 }
915 }
916 $d->{$id} = $value;
917 } else {
918 push @{$f->{options}}, $option;
919 }
920 } else {
921 last;
922 }
923 }
924 $d->{"$_$suffix"} = $f->{$_} foreach (keys %$f);
925 last SECTION if !defined($line);
926 redo SECTION;
927 } elsif ($line =~ /\w/) {
928 push @$options, [$priority++, $line];
929 }
930 }
931
932 foreach my $ifname (@$active_ifaces) {
933 if (my $iface = $ifaces->{$ifname}) {
934 $iface->{active} = 1;
935 }
936 }
937
938 if (!$ifaces->{lo}) {
939 $ifaces->{lo}->{priority} = 1;
940 $ifaces->{lo}->{method} = 'loopback';
941 $ifaces->{lo}->{type} = 'loopback';
942 $ifaces->{lo}->{autostart} = 1;
943 }
944
945 foreach my $iface (keys %$ifaces) {
946 my $d = $ifaces->{$iface};
947 if ($iface =~ m/^bond\d+$/) {
948 if (!$d->{ovs_type}) {
949 $d->{type} = 'bond';
950 } elsif ($d->{ovs_type} eq 'OVSBond') {
951 $d->{type} = $d->{ovs_type};
952 # translate: ovs_options => bond_mode
953 $d->{'bond_mode'} = &$extract_ovs_option($d, 'bond_mode');
954 my $lacp = &$extract_ovs_option($d, 'lacp');
955 if ($lacp && $lacp eq 'active') {
956 if ($d->{'bond_mode'} eq 'balance-slb') {
957 $d->{'bond_mode'} = 'lacp-balance-slb';
958 }
959 }
960 # Note: balance-tcp needs lacp
961 if ($d->{'bond_mode'} eq 'balance-tcp') {
962 $d->{'bond_mode'} = 'lacp-balance-tcp';
963 }
964 my $tag = &$extract_ovs_option($d, 'tag');
965 $d->{ovs_tag} = $tag if defined($tag);
966 } else {
967 $d->{type} = 'unknown';
968 }
969 } elsif ($iface =~ m/^vmbr\d+$/) {
970 if (!$d->{ovs_type}) {
971 $d->{type} = 'bridge';
972
973 if (!defined ($d->{bridge_fd})) {
974 $d->{bridge_fd} = 0;
975 }
976 if (!defined ($d->{bridge_stp})) {
977 $d->{bridge_stp} = 'off';
978 }
979 } elsif ($d->{ovs_type} eq 'OVSBridge') {
980 $d->{type} = $d->{ovs_type};
981 } else {
982 $d->{type} = 'unknown';
983 }
984 } elsif ($iface =~ m/^(\S+):\d+$/) {
985 $d->{type} = 'alias';
986 if (defined ($ifaces->{$1})) {
987 $d->{exists} = $ifaces->{$1}->{exists};
988 } else {
989 $ifaces->{$1}->{exists} = 0;
990 $d->{exists} = 0;
991 }
992 } elsif ($iface =~ m/^(\S+)\.\d+$/) {
993 $d->{type} = 'vlan';
994 if (defined ($ifaces->{$1})) {
995 $d->{exists} = $ifaces->{$1}->{exists};
996 } else {
997 $ifaces->{$1}->{exists} = 0;
998 $d->{exists} = 0;
999 }
1000 } elsif ($iface =~ m/^$PVE::Network::PHYSICAL_NIC_RE$/) {
1001 if (!$d->{ovs_type}) {
1002 $d->{type} = 'eth';
1003 } elsif ($d->{ovs_type} eq 'OVSPort') {
1004 $d->{type} = $d->{ovs_type};
1005 my $tag = &$extract_ovs_option($d, 'tag');
1006 $d->{ovs_tag} = $tag if defined($tag);
1007 } else {
1008 $d->{type} = 'unknown';
1009 }
1010 } elsif ($iface =~ m/^lo$/) {
1011 $d->{type} = 'loopback';
1012 } else {
1013 if (!$d->{ovs_type}) {
1014 $d->{type} = 'unknown';
1015 } elsif ($d->{ovs_type} eq 'OVSIntPort') {
1016 $d->{type} = $d->{ovs_type};
1017 my $tag = &$extract_ovs_option($d, 'tag');
1018 $d->{ovs_tag} = $tag if defined($tag);
1019 }
1020 }
1021
1022 $d->{method} = 'manual' if !$d->{method};
1023 $d->{method6} = 'manual' if !$d->{method6};
1024
1025 $d->{families} ||= ['inet'];
1026 }
1027
1028 # OVS bridges create "allow-$BRIDGE $IFACE" lines which we need to remove
1029 # from the {options} hash for them to be removed correctly.
1030 @$options = grep {defined($_)} map {
1031 my ($pri, $line) = @$_;
1032 if ($line =~ /^allow-(\S+)\s+(.*)$/) {
1033 my $bridge = $1;
1034 my @ports = split(/\s+/, $2);
1035 if (defined(my $br = $ifaces->{$bridge})) {
1036 # if this port is part of a bridge, remove it
1037 my %in_ovs_ports = map {$_=>1} split(/\s+/, $br->{ovs_ports});
1038 @ports = grep { not $in_ovs_ports{$_} } @ports;
1039 }
1040 # create the allow line for the remaining ports, or delete if empty
1041 if (@ports) {
1042 [$pri, "allow-$bridge " . join(' ', @ports)];
1043 } else {
1044 undef;
1045 }
1046 } else {
1047 # don't modify other lines
1048 $_;
1049 }
1050 } @$options;
1051
1052 return $config;
1053 }
1054
1055 sub __interface_to_string {
1056 my ($iface, $d, $family, $first_block, $ifupdown2) = @_;
1057
1058 (my $suffix = $family) =~ s/^inet//;
1059
1060 return '' if !($d && $d->{"method$suffix"});
1061
1062 my $raw = '';
1063
1064 $raw .= "iface $iface $family " . $d->{"method$suffix"} . "\n";
1065 $raw .= "\taddress " . $d->{"address$suffix"} . "\n" if $d->{"address$suffix"};
1066 $raw .= "\tnetmask " . $d->{"netmask$suffix"} . "\n" if $d->{"netmask$suffix"};
1067 $raw .= "\tgateway " . $d->{"gateway$suffix"} . "\n" if $d->{"gateway$suffix"};
1068 $raw .= "\tbroadcast " . $d->{"broadcast$suffix"} . "\n" if $d->{"broadcast$suffix"};
1069
1070 my $done = { type => 1, priority => 1, method => 1, active => 1, exists => 1,
1071 comments => 1, autostart => 1, options => 1,
1072 address => 1, netmask => 1, gateway => 1, broadcast => 1,
1073 method6 => 1, families => 1, options6 => 1,
1074 address6 => 1, netmask6 => 1, gateway6 => 1, broadcast6 => 1 };
1075
1076 if (!$first_block) {
1077 # not printing out options
1078 } elsif ($d->{type} eq 'bridge') {
1079
1080 $d->{bridge_ports} =~ s/[;,\s]+/ /g;
1081 my $ports = $d->{bridge_ports} || 'none';
1082 $raw .= "\tbridge-ports $ports\n";
1083 $done->{bridge_ports} = 1;
1084
1085 my $v = defined($d->{bridge_stp}) ? $d->{bridge_stp} : 'off';
1086 $raw .= "\tbridge-stp $v\n";
1087 $done->{bridge_stp} = 1;
1088
1089 $v = defined($d->{bridge_fd}) ? $d->{bridge_fd} : 0;
1090 $raw .= "\tbridge-fd $v\n";
1091 $done->{bridge_fd} = 1;
1092
1093 if( defined($d->{bridge_vlan_aware})) {
1094 $raw .= "\tbridge-vlan-aware yes\n";
1095 $v = defined($d->{bridge_vids}) ? $d->{bridge_vids} : "2-4094";
1096 $raw .= "\tbridge-vids $v\n";
1097 }
1098 $done->{bridge_vlan_aware} = 1;
1099 $done->{bridge_vids} = 1;
1100
1101 } elsif ($d->{type} eq 'bond') {
1102
1103 $d->{slaves} =~ s/[;,\s]+/ /g;
1104 my $slaves = $d->{slaves} || 'none';
1105 $raw .= "\tbond-slaves $slaves\n";
1106 $done->{slaves} = 1;
1107
1108 my $v = defined ($d->{'bond_miimon'}) ? $d->{'bond_miimon'} : 100;
1109 $raw .= "\tbond-miimon $v\n";
1110 $done->{'bond_miimon'} = 1;
1111
1112 $v = defined ($d->{'bond_mode'}) ? $d->{'bond_mode'} : 'balance-rr';
1113 $raw .= "\tbond-mode $v\n";
1114 $done->{'bond_mode'} = 1;
1115
1116 if ($d->{'bond_mode'} && $d->{'bond_xmit_hash_policy'} &&
1117 ($d->{'bond_mode'} eq 'balance-xor' || $d->{'bond_mode'} eq '802.3ad')) {
1118 $raw .= "\tbond-xmit-hash-policy $d->{'bond_xmit_hash_policy'}\n";
1119 }
1120 $done->{'bond_xmit_hash_policy'} = 1;
1121
1122 } elsif ($d->{type} eq 'OVSBridge') {
1123
1124 $raw .= "\tovs_type $d->{type}\n";
1125 $done->{ovs_type} = 1;
1126
1127 $raw .= "\tovs_ports $d->{ovs_ports}\n" if $d->{ovs_ports};
1128 $done->{ovs_ports} = 1;
1129 } elsif ($d->{type} eq 'OVSPort' || $d->{type} eq 'OVSIntPort' ||
1130 $d->{type} eq 'OVSBond') {
1131
1132 $d->{autostart} = 0; # started by the bridge
1133
1134 if (defined($d->{ovs_tag})) {
1135 &$set_ovs_option($d, tag => $d->{ovs_tag});
1136 }
1137 $done->{ovs_tag} = 1;
1138
1139 if ($d->{type} eq 'OVSBond') {
1140
1141 $d->{bond_mode} = 'active-backup' if !$d->{bond_mode};
1142
1143 $ovs_bond_modes->{$d->{bond_mode}} ||
1144 die "OVS does not support bond mode '$d->{bond_mode}\n";
1145
1146 if ($d->{bond_mode} eq 'lacp-balance-slb') {
1147 &$set_ovs_option($d, lacp => 'active');
1148 &$set_ovs_option($d, bond_mode => 'balance-slb');
1149 } elsif ($d->{bond_mode} eq 'lacp-balance-tcp') {
1150 &$set_ovs_option($d, lacp => 'active');
1151 &$set_ovs_option($d, bond_mode => 'balance-tcp');
1152 } else {
1153 &$set_ovs_option($d, lacp => undef);
1154 &$set_ovs_option($d, bond_mode => $d->{bond_mode});
1155 }
1156 $done->{bond_mode} = 1;
1157
1158 $raw .= "\tovs_bonds $d->{ovs_bonds}\n" if $d->{ovs_bonds};
1159 $done->{ovs_bonds} = 1;
1160 }
1161
1162 $raw .= "\tovs_type $d->{type}\n";
1163 $done->{ovs_type} = 1;
1164
1165 if ($d->{ovs_bridge}) {
1166
1167 if ($ifupdown2) {
1168 $raw = "auto $iface\n$raw";
1169 } else {
1170 $raw = "allow-$d->{ovs_bridge} $iface\n$raw";
1171 }
1172
1173 $raw .= "\tovs_bridge $d->{ovs_bridge}\n";
1174 $done->{ovs_bridge} = 1;
1175 }
1176 }
1177
1178 if ($first_block) {
1179 # print other settings
1180 foreach my $k (keys %$d) {
1181 next if $done->{$k};
1182 next if !$d->{$k};
1183 $raw .= "\t$k $d->{$k}\n";
1184 }
1185 }
1186
1187 foreach my $option (@{$d->{"options$suffix"}}) {
1188 $raw .= "\t$option\n";
1189 }
1190
1191 # add comments
1192 my $comments = $d->{"comments$suffix"} || '';
1193 foreach my $cl (split(/\n/, $comments)) {
1194 $raw .= "#$cl\n";
1195 }
1196
1197 $raw .= "\n";
1198
1199 return $raw;
1200 }
1201
1202
1203 sub write_etc_network_interfaces {
1204 my ($filename, $fh, $config) = @_;
1205 my $ifupdown2 = -e '/usr/share/ifupdown2';
1206 my $raw = __write_etc_network_interfaces($config, $ifupdown2);
1207 PVE::Tools::safe_print($filename, $fh, $raw);
1208 }
1209 sub __write_etc_network_interfaces {
1210 my ($config, $ifupdown2) = @_;
1211
1212 my $ifaces = $config->{ifaces};
1213 my @options = @{$config->{options}};
1214
1215 my $used_ports = {};
1216
1217 foreach my $iface (keys %$ifaces) {
1218 my $d = $ifaces->{$iface};
1219
1220 my $ports = '';
1221 foreach my $k (qw(bridge_ports ovs_ports slaves ovs_bonds)) {
1222 $ports .= " $d->{$k}" if $d->{$k};
1223 }
1224
1225 foreach my $p (PVE::Tools::split_list($ports)) {
1226 die "port '$p' is already used on interface '$used_ports->{$p}'\n"
1227 if $used_ports->{$p} && $used_ports->{$p} ne $iface;
1228 $used_ports->{$p} = $iface;
1229 }
1230 }
1231
1232 # delete unused OVS ports
1233 foreach my $iface (keys %$ifaces) {
1234 my $d = $ifaces->{$iface};
1235 if ($d->{type} eq 'OVSPort' || $d->{type} eq 'OVSIntPort' ||
1236 $d->{type} eq 'OVSBond') {
1237 my $brname = $used_ports->{$iface};
1238 if (!$brname || !$ifaces->{$brname}) {
1239 if ($iface =~ /^$PVE::Network::PHYSICAL_NIC_RE/) {
1240 $ifaces->{$iface} = { type => 'eth',
1241 exists => 1,
1242 method => 'manual',
1243 families => ['inet'] };
1244 } else {
1245 delete $ifaces->{$iface};
1246 }
1247 next;
1248 }
1249 my $bd = $ifaces->{$brname};
1250 if ($bd->{type} ne 'OVSBridge') {
1251 delete $ifaces->{$iface};
1252 next;
1253 }
1254 }
1255 }
1256
1257 # create OVS bridge ports
1258 foreach my $iface (keys %$ifaces) {
1259 my $d = $ifaces->{$iface};
1260 if ($d->{type} eq 'OVSBridge' && $d->{ovs_ports}) {
1261 foreach my $p (split (/\s+/, $d->{ovs_ports})) {
1262 my $n = $ifaces->{$p};
1263 die "OVS bridge '$iface' - unable to find port '$p'\n"
1264 if !$n;
1265 $n->{autostart} = 0;
1266 if ($n->{type} eq 'eth') {
1267 $n->{type} = 'OVSPort';
1268 $n->{ovs_bridge} = $iface;
1269 } elsif ($n->{type} eq 'OVSBond' || $n->{type} eq 'OVSPort' ||
1270 $n->{type} eq 'OVSIntPort') {
1271 $n->{ovs_bridge} = $iface;
1272 } else {
1273 die "interface '$p' is not defined as OVS port/bond\n";
1274 }
1275 }
1276 }
1277 }
1278
1279 # check OVS bond ports
1280 foreach my $iface (keys %$ifaces) {
1281 my $d = $ifaces->{$iface};
1282 if ($d->{type} eq 'OVSBond' && $d->{ovs_bonds}) {
1283 foreach my $p (split (/\s+/, $d->{ovs_bonds})) {
1284 my $n = $ifaces->{$p};
1285 die "OVS bond '$iface' - unable to find slave '$p'\n"
1286 if !$n;
1287 die "OVS bond '$iface' - wrong interface type on slave '$p' " .
1288 "('$n->{type}' != 'eth')\n" if $n->{type} ne 'eth';
1289 }
1290 }
1291 }
1292
1293 my $raw = <<'NETWORKDOC';
1294 # network interface settings; autogenerated
1295 # Please do NOT modify this file directly, unless you know what
1296 # you're doing.
1297 #
1298 # If you want to manage part of the network configuration manually,
1299 # please utilize the 'source' or 'source-directory' directives to do
1300 # so.
1301 # PVE will preserve these directives, but will NOT its network
1302 # configuration from sourced files, so do not attempt to move any of
1303 # the PVE managed interfaces into external files!
1304
1305 NETWORKDOC
1306
1307 my $printed = {};
1308
1309 my $if_type_hash = {
1310 loopback => 100000,
1311 eth => 200000,
1312 bond => 300000,
1313 bridge => 400000,
1314 };
1315
1316 my $lookup_type_prio = sub {
1317 my $iface = shift;
1318
1319 my $child = 0;
1320 if ($iface =~ m/^(\S+)(\.|:)\d+$/) {
1321 $iface = $1;
1322 $child = 1;
1323 }
1324
1325 my $pri;
1326 if ($iface eq 'lo') {
1327 $pri = $if_type_hash->{loopback};
1328 } elsif ($iface =~ m/^$PVE::Network::PHYSICAL_NIC_RE$/) {
1329 $pri = $if_type_hash->{eth} + $child;
1330 } elsif ($iface =~ m/^bond\d+$/) {
1331 $pri = $if_type_hash->{bond} + $child;
1332 } elsif ($iface =~ m/^vmbr\d+$/) {
1333 $pri = $if_type_hash->{bridge} + $child;
1334 }
1335
1336 return $pri;
1337 };
1338
1339 foreach my $iface (sort {
1340 my $ref1 = $ifaces->{$a};
1341 my $ref2 = $ifaces->{$b};
1342 my $tp1 = &$lookup_type_prio($a);
1343 my $tp2 = &$lookup_type_prio($b);
1344
1345 # Only recognized types are in relation to each other. If one type
1346 # is unknown then only consider the interfaces' priority attributes.
1347 $tp1 = $tp2 = 0 if !defined($tp1) || !defined($tp2);
1348
1349 my $p1 = $tp1 + ($ref1->{priority} // 50000);
1350 my $p2 = $tp2 + ($ref2->{priority} // 50000);
1351
1352 return $p1 <=> $p2 if $p1 != $p2;
1353
1354 return $a cmp $b;
1355 } keys %$ifaces) {
1356 next if $printed->{$iface};
1357
1358 my $d = $ifaces->{$iface};
1359 my $pri = $d->{priority} // 0;
1360 if (@options && $options[0]->[0] < $pri) {
1361 do {
1362 $raw .= (shift @options)->[1] . "\n";
1363 } while (@options && $options[0]->[0] < $pri);
1364 $raw .= "\n";
1365 }
1366
1367 $printed->{$iface} = 1;
1368 $raw .= "auto $iface\n" if $d->{autostart};
1369 my $i = 0; # some options should be printed only once
1370 $raw .= __interface_to_string($iface, $d, $_, !$i++, $ifupdown2) foreach @{$d->{families}};
1371 }
1372
1373 $raw .= $_->[1] . "\n" foreach @options;
1374 return $raw;
1375 }
1376
1377 register_file('interfaces', "/etc/network/interfaces",
1378 \&read_etc_network_interfaces,
1379 \&write_etc_network_interfaces);
1380
1381
1382 sub read_iscsi_initiatorname {
1383 my ($filename, $fd) = @_;
1384
1385 while (defined(my $line = <$fd>)) {
1386 if ($line =~ m/^InitiatorName=(\S+)$/) {
1387 return $1;
1388 }
1389 }
1390
1391 return 'undefined';
1392 }
1393
1394 register_file('initiatorname', "/etc/iscsi/initiatorname.iscsi",
1395 \&read_iscsi_initiatorname);
1396
1397 sub read_apt_auth {
1398 my ($filename, $fd) = @_;
1399
1400 local $/;
1401
1402 my $raw = defined($fd) ? <$fd> : '';
1403
1404 $raw =~ s/^\s+//;
1405
1406
1407 my @tokens = split(/\s+/, $raw);
1408
1409 my $data = {};
1410
1411 my $machine;
1412 while (defined(my $tok = shift @tokens)) {
1413
1414 $machine = shift @tokens if $tok eq 'machine';
1415 next if !$machine;
1416 $data->{$machine} = {} if !$data->{$machine};
1417
1418 $data->{$machine}->{login} = shift @tokens if $tok eq 'login';
1419 $data->{$machine}->{password} = shift @tokens if $tok eq 'password';
1420 };
1421
1422 return $data;
1423 }
1424
1425 my $format_apt_auth_data = sub {
1426 my $data = shift;
1427
1428 my $raw = '';
1429
1430 foreach my $machine (sort keys %$data) {
1431 my $d = $data->{$machine};
1432 $raw .= "machine $machine\n";
1433 $raw .= " login $d->{login}\n" if $d->{login};
1434 $raw .= " password $d->{password}\n" if $d->{password};
1435 $raw .= "\n";
1436 }
1437
1438 return $raw;
1439 };
1440
1441 sub write_apt_auth {
1442 my ($filename, $fh, $data) = @_;
1443
1444 my $raw = &$format_apt_auth_data($data);
1445
1446 die "write failed: $!" unless print $fh "$raw\n";
1447
1448 return $data;
1449 }
1450
1451 sub update_apt_auth {
1452 my ($filename, $fh, $data) = @_;
1453
1454 my $orig = read_apt_auth($filename, $fh);
1455
1456 foreach my $machine (keys %$data) {
1457 $orig->{$machine} = $data->{$machine};
1458 }
1459
1460 return &$format_apt_auth_data($orig);
1461 }
1462
1463 register_file('apt-auth', "/etc/apt/auth.conf",
1464 \&read_apt_auth, \&write_apt_auth,
1465 \&update_apt_auth, perm => 0640);
1466
1467 1;