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