lib/route_types.pl

   1 #!/usr/bin/perl
   2 ##
   3 ## Scan a file of route-type definitions (see eg route_types.txt) and
   4 ## generate a corresponding header file with:
   5 ##
   6 ## - enum of Zserv route-types
   7 ## - redistribute strings for the various Quagga daemons
   8 ##
   9 ## See route_types.txt for the format.
  10 ##
  11 ##
  12 ## Copyright (C) 2009 David Lamparter.
  13 ## This file is part of GNU Zebra.
  14 ##
  15 ## GNU Zebra is free software; you can redistribute it and/or modify it
  16 ## under the terms of the GNU General Public License as published by the
  17 ## Free Software Foundation; either version 2, or (at your option) any
  18 ## later version.
  19 ##
  20 ## GNU Zebra is distributed in the hope that it will be useful, but
  21 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  22 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  23 ## General Public License for more details.
  24 ##
  25 ## You should have received a copy of the GNU General Public License
  26 ## along with GNU Zebra; see the file COPYING.  If not, write to the Free
  27 ## Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  28 ## 02111-1307, USA.
  29 ##
  30
  31 use strict;
  32
  33 # input processing
  34 #
  35 my @protos;
  36 my %protodetail;
  37
  38 my %daemons;
  39
  40 while (<STDIN>) {
  41         # skip comments and empty lines
  42         next if (/^\s*(#|$)/);
  43
  44         # strip whitespace
  45         chomp;
  46         $_ =~ s/^\s*//;
  47         $_ =~ s/\s*$//;
  48
  49         # match help strings
  50         if (/^(ZEBRA_ROUTE_[^\s]+)\s*,\s*"(.*)"$/) {
  51                 $protodetail{$1}->{'longhelp'} = $2;
  52                 next;
  53         }
  54
  55         $_ =~ s/\s*,\s*/,/g;
  56
  57         # else: 8-field line
  58         my @f = split(/,/, $_);
  59         unless (@f == 8 || @f == 9) {
  60                 die "invalid input on route_types line $.\n";
  61         }
  62
  63         my $proto = $f[0];
  64         $f[3] = $1 if ($f[3] =~ /^'(.*)'$/);
  65         $f[7] = $1 if ($f[7] =~ /^"(.*)"$/);
  66
  67         $protodetail{$proto} = {
  68                 "number" => scalar @protos,
  69                 "type" => $f[0],
  70                 "cname" => $f[1],
  71                 "daemon" => $f[2],
  72                 "char" => $f[3],
  73                 "ipv4" => int($f[4]),
  74                 "ipv6" => int($f[5]),
  75                 "redist" => int($f[6]),
  76                 "shorthelp" => $f[7],
  77                 "restrict2" => $f[8],
  78         };
  79         push @protos, $proto;
  80         $daemons{$f[2]} = {
  81                 "ipv4" => int($f[4]),
  82                 "ipv6" => int($f[5])
  83         } unless ($f[2] eq "NULL");
  84 }
  85
  86 # output
  87 printf <<EOF, $ARGV[0];
  88 /* Auto-generated from route_types.txt by %s. */
  89 /* Do not edit! */
  90
  91 #ifndef _FRR_ROUTE_TYPES_H
  92 #define _FRR_ROUTE_TYPES_H
  93
  94 /* Zebra route's' types. */
  95 EOF
  96
  97 push @protos, "ZEBRA_ROUTE_MAX";
  98 my (@protosv4, @protosv6) = ((), ());
  99 for (my $c = 0; $c < @protos; $c++) {
 100         my $p = $protos[$c];
 101         printf "#define %-32s %d\n", $p, $c;
 102         push @protosv4, $p if ($protodetail{$p}->{"ipv4"});
 103         push @protosv6, $p if ($protodetail{$p}->{"ipv6"});
 104 }
 105 pop @protos;
 106
 107 sub codelist {
 108         my (@protos) = @_;
 109         my (@lines) = ();
 110         my $str = "  \"Codes: ";
 111         for my $p (@protos) {
 112                 my $s = sprintf("%s - %s, ",
 113                         $protodetail{$p}->{"char"},
 114                         $protodetail{$p}->{"shorthelp"});
 115                 if (length($str . $s) > 70) {
 116                         $str =~ s/ $//;
 117                         push @lines, $str . "\\n\" \\\n";
 118                         $str = "  \"       ";
 119                 }
 120                 $str .= $s;
 121         }
 122         $str =~ s/ $//;
 123         push @lines, $str . "\\n\" \\\n";
 124         push @lines, "  \"       > - selected route, * - FIB route\\n\\n\"";
 125         return join("", @lines);
 126 }
 127
 128 print "\n";
 129 printf "#define SHOW_ROUTE_V4_HEADER \\\n%s\n", codelist(@protosv4);
 130 printf "#define SHOW_ROUTE_V6_HEADER \\\n%s\n", codelist(@protosv6);
 131 print "\n";
 132
 133 sub collect {
 134         my ($daemon, $ipv4, $ipv6, $any) = @_;
 135         my (@names, @help) = ((), ());
 136         for my $p (@protos) {
 137                 next if ($protodetail{$p}->{"daemon"} eq $daemon && $daemon ne "zebra");
 138                 next if ($protodetail{$p}->{"restrict2"} ne "" &&
 139                          $protodetail{$p}->{"restrict2"} ne $daemon);
 140                 next if ($protodetail{$p}->{"redist"} eq 0);
 141                 next unless (($ipv4 && $protodetail{$p}->{"ipv4"})
 142                              || ($ipv6 && $protodetail{$p}->{"ipv6"}));
 143                 push @names, $protodetail{$p}->{"cname"};
 144                 push @help, "  \"".$protodetail{$p}->{"longhelp"}."\\n\"";
 145         }
 146         if ($any == 1) {
 147                 push @names, "any";
 148                 push @help, "  \"Any of the above protocols\\n\"";
 149         }
 150         return ("\"<" . join("|", @names) . ">\"", join(" \\\n", @help));
 151 }
 152
 153 for my $daemon (sort keys %daemons) {
 154         next unless ($daemons{$daemon}->{"ipv4"} || $daemons{$daemon}->{"ipv6"});
 155         printf "/* %s */\n", $daemon;
 156         if ($daemons{$daemon}->{"ipv4"} && $daemons{$daemon}->{"ipv6"}) {
 157                 my ($names, $help) = collect($daemon, 1, 1, 0);
 158                 printf "#define FRR_REDIST_STR_%s \\\n  %s\n", uc $daemon, $names;
 159                 printf "#define FRR_REDIST_HELP_STR_%s \\\n%s\n", uc $daemon, $help;
 160
 161                 ($names, $help) = collect($daemon, 1, 0, 0);
 162                 printf "#define FRR_IP_REDIST_STR_%s \\\n  %s\n", uc $daemon, $names;
 163                 printf "#define FRR_IP_REDIST_HELP_STR_%s \\\n%s\n", uc $daemon, $help;
 164
 165                 ($names, $help) = collect($daemon, 0, 1, 0);
 166                 printf "#define FRR_IP6_REDIST_STR_%s \\\n  %s\n", uc $daemon, $names;
 167                 printf "#define FRR_IP6_REDIST_HELP_STR_%s \\\n%s\n", uc $daemon, $help;
 168
 169                 if ($daemon eq "zebra") {
 170                         ($names, $help) = collect($daemon, 1, 0, 1);
 171                         printf "#define FRR_IP_PROTOCOL_MAP_STR_%s \\\n  %s\n", uc $daemon, $names;
 172                         printf "#define FRR_IP_PROTOCOL_MAP_HELP_STR_%s \\\n%s\n", uc $daemon, $help;
 173
 174                         ($names, $help) = collect($daemon, 0, 1, 1);
 175                         printf "#define FRR_IP6_PROTOCOL_MAP_STR_%s \\\n  %s\n", uc $daemon, $names;
 176                         printf "#define FRR_IP6_PROTOCOL_MAP_HELP_STR_%s \\\n%s\n", uc $daemon, $help;
 177                 }
 178         } else {
 179                 my ($names, $help) = collect($daemon,
 180                         $daemons{$daemon}->{"ipv4"}, $daemons{$daemon}->{"ipv6"}, 0);
 181                 printf "#define FRR_REDIST_STR_%s \\\n  %s\n", uc $daemon, $names;
 182                 printf "#define FRR_REDIST_HELP_STR_%s \\\n%s\n", uc $daemon, $help;
 183         }
 184         print "\n";
 185 }
 186
 187 print <<EOF;
 188
 189 #ifdef FRR_DEFINE_DESC_TABLE
 190
 191 struct zebra_desc_table
 192 {
 193   unsigned int type;
 194   const char *string;
 195   char chr;
 196 };
 197
 198 #define DESC_ENTRY(T,S,C) [(T)] = { (T), (S), (C) }
 199 static const struct zebra_desc_table route_types[] = {
 200 EOF
 201
 202 for (my $c = 0; $c < @protos; $c++) {
 203         my $p = $protos[$c];
 204         printf "  DESC_ENTRY\t(%s\t \"%s\",\t'%s' ),\n",
 205                $p.",", $protodetail{$p}->{"cname"}, $protodetail{$p}->{"char"};
 206 }
 207
 208 print <<EOF;
 209 };
 210 #undef DESC_ENTRY
 211
 212 #endif /* FRR_DEFINE_DESC_TABLE */
 213
 214 #endif /* _FRR_ROUTE_TYPES_H */
 215 EOF
 216