[mirror_frr.git] / lib / route_types.pl

#!/usr/bin/perl
##
## Scan a file of route-type definitions (see eg route_types.txt) and
## generate a corresponding header file with:
##
## - enum of Zserv route-types
## - redistribute strings for the various Quagga daemons
##
## See route_types.txt for the format.
##
##
## Copyright (C) 2009 David Lamparter.
## This file is part of GNU Zebra.
##
## GNU Zebra is free software; you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by the
## Free Software Foundation; either version 2, or (at your option) any
## later version.
##
## GNU Zebra is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with GNU Zebra; see the file COPYING.  If not, write to the Free
## Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
## 02111-1307, USA.
##

use strict;

# input processing
#
my @protos;
my %protodetail;

my %daemons;

while (<STDIN>) {
	# skip comments and empty lines
	next if (/^\s*(#|$)/);

	# strip whitespace
	chomp;
	$_ =~ s/^\s*//;
	$_ =~ s/\s*$//;

	# match help strings
	if (/^(ZEBRA_ROUTE_[^\s]+)\s*,\s*"(.*)"$/) {
		$protodetail{$1}->{'longhelp'} = $2;
		next;
	}

	$_ =~ s/\s*,\s*/,/g;

	# else: 8-field line
	my @f = split(/,/, $_);
	unless (@f == 8 || @f == 9) {
		die "invalid input on route_types line $.\n";
	}

	my $proto = $f[0];
	$f[3] = $1 if ($f[3] =~ /^'(.*)'$/);
	$f[7] = $1 if ($f[7] =~ /^"(.*)"$/);

	$protodetail{$proto} = {
		"number" => scalar @protos,
		"type" => $f[0],
		"cname" => $f[1],
		"daemon" => $f[2],
		"char" => $f[3],
		"ipv4" => int($f[4]),
		"ipv6" => int($f[5]),
		"redist" => int($f[6]),
		"shorthelp" => $f[7],
		"restrict2" => $f[8],
	};
	push @protos, $proto;
	$daemons{$f[2]} = {
		"ipv4" => int($f[4]),
		"ipv6" => int($f[5])
	} unless ($f[2] eq "NULL");
}

# output
printf <<EOF, $ARGV[0];
/* Auto-generated from route_types.txt by %s. */
/* Do not edit! */

#ifndef _FRR_ROUTE_TYPES_H
#define _FRR_ROUTE_TYPES_H

/* Zebra route's' types. */
EOF

push @protos, "ZEBRA_ROUTE_MAX";
my (@protosv4, @protosv6) = ((), ());
for (my $c = 0; $c < @protos; $c++) {
	my $p = $protos[$c];
	printf "#define %-32s %d\n", $p, $c;
	push @protosv4, $p if ($protodetail{$p}->{"ipv4"});
	push @protosv6, $p if ($protodetail{$p}->{"ipv6"});
}
pop @protos;

sub codelist {
	my (@protos) = @_;
	my (@lines) = ();
	my $str = "  \"Codes: ";
	for my $p (@protos) {
		my $s = sprintf("%s - %s, ",
			$protodetail{$p}->{"char"},
			$protodetail{$p}->{"shorthelp"});
		if (length($str . $s) > 70) {
			$str =~ s/ $//;
			push @lines, $str . "\\n\" \\\n";
			$str = "  \"       ";
		}
		$str .= $s;
	}
	$str =~ s/ $//;
	push @lines, $str . "\\n\" \\\n";
	push @lines, "  \"       > - selected route, * - FIB route\\n\\n\"";
	return join("", @lines);
}

print "\n";
printf "#define SHOW_ROUTE_V4_HEADER \\\n%s\n", codelist(@protosv4);
printf "#define SHOW_ROUTE_V6_HEADER \\\n%s\n", codelist(@protosv6);
print "\n";

sub collect {
	my ($daemon, $ipv4, $ipv6, $any) = @_;
	my (@names, @help) = ((), ());
	for my $p (@protos) {
		next if ($protodetail{$p}->{"daemon"} eq $daemon && $daemon ne "zebra");
		next if ($protodetail{$p}->{"restrict2"} ne "" && 
		         $protodetail{$p}->{"restrict2"} ne $daemon);
		next if ($protodetail{$p}->{"redist"} eq 0);
		next unless (($ipv4 && $protodetail{$p}->{"ipv4"})
			     || ($ipv6 && $protodetail{$p}->{"ipv6"}));
		push @names, $protodetail{$p}->{"cname"};
		push @help, "  \"".$protodetail{$p}->{"longhelp"}."\\n\"";
	}
	if ($any == 1) {
		push @names, "any";
		push @help, "  \"Any of the above protocols\\n\"";
	}
	return ("\"<" . join("|", @names) . ">\"", join(" \\\n", @help));
}

for my $daemon (sort keys %daemons) {
	next unless ($daemons{$daemon}->{"ipv4"} || $daemons{$daemon}->{"ipv6"});
	printf "/* %s */\n", $daemon;
	if ($daemons{$daemon}->{"ipv4"} && $daemons{$daemon}->{"ipv6"}) {
		my ($names, $help) = collect($daemon, 1, 1, 0);
		printf "#define FRR_REDIST_STR_%s \\\n  %s\n", uc $daemon, $names;
		printf "#define FRR_REDIST_HELP_STR_%s \\\n%s\n", uc $daemon, $help;

		($names, $help) = collect($daemon, 1, 0, 0);
		printf "#define FRR_IP_REDIST_STR_%s \\\n  %s\n", uc $daemon, $names;
		printf "#define FRR_IP_REDIST_HELP_STR_%s \\\n%s\n", uc $daemon, $help;

		($names, $help) = collect($daemon, 0, 1, 0);
		printf "#define FRR_IP6_REDIST_STR_%s \\\n  %s\n", uc $daemon, $names;
		printf "#define FRR_IP6_REDIST_HELP_STR_%s \\\n%s\n", uc $daemon, $help;

		if ($daemon eq "zebra") {
			($names, $help) = collect($daemon, 1, 0, 1);
			printf "#define FRR_IP_PROTOCOL_MAP_STR_%s \\\n  %s\n", uc $daemon, $names;
			printf "#define FRR_IP_PROTOCOL_MAP_HELP_STR_%s \\\n%s\n", uc $daemon, $help;

			($names, $help) = collect($daemon, 0, 1, 1);
			printf "#define FRR_IP6_PROTOCOL_MAP_STR_%s \\\n  %s\n", uc $daemon, $names;
			printf "#define FRR_IP6_PROTOCOL_MAP_HELP_STR_%s \\\n%s\n", uc $daemon, $help;
		}
	} else {
		my ($names, $help) = collect($daemon,
			$daemons{$daemon}->{"ipv4"}, $daemons{$daemon}->{"ipv6"}, 0);
		printf "#define FRR_REDIST_STR_%s \\\n  %s\n", uc $daemon, $names;
		printf "#define FRR_REDIST_HELP_STR_%s \\\n%s\n", uc $daemon, $help;
	}
	print "\n";
}

print <<EOF;

#ifdef FRR_DEFINE_DESC_TABLE

struct zebra_desc_table
{
  unsigned int type;
  const char *string;
  char chr;
};

#define DESC_ENTRY(T,S,C) [(T)] = { (T), (S), (C) }
static const struct zebra_desc_table route_types[] = {
EOF

for (my $c = 0; $c < @protos; $c++) {
	my $p = $protos[$c];
	printf "  DESC_ENTRY\t(%s\t \"%s\",\t'%s' ),\n",
	       $p.",", $protodetail{$p}->{"cname"}, $protodetail{$p}->{"char"};
}

print <<EOF;
};
#undef DESC_ENTRY

#endif /* FRR_DEFINE_DESC_TABLE */

#endif /* _FRR_ROUTE_TYPES_H */
EOF
Commit	Line	Data
e0ca5fde DL	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
82557cf0	57	# else: 8-field line
e0ca5fde	58	my @f = split(/,/, $_);
82557cf0	59	unless (@f == 8 \|\| @f == 9) {
e0ca5fde DL	60	die "invalid input on route_types line $.\n";
	61	}
	62
	63	my $proto = $f[0];
	64	$f[3] = $1 if ($f[3] =~ /^'(.*)'$/);
82557cf0	65	$f[7] = $1 if ($f[7] =~ /^"(.*)"$/);
e0ca5fde DL	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]),
82557cf0 DS	75	"redist" => int($f[6]),
	76	"shorthelp" => $f[7],
	77	"restrict2" => $f[8],
e0ca5fde DL	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
ab0181ee DL	91	#ifndef _FRR_ROUTE_TYPES_H
ab0181ee DL	92	#define _FRR_ROUTE_TYPES_H
e0ca5fde	93
9f0ea7d4	94	/* Zebra route's' types. */
e0ca5fde DL	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/ $//;
625e016d	117	push @lines, $str . "\\n\" \\\n";
e0ca5fde DL	118	$str = " \" ";
	119	}
	120	$str .= $s;
	121	}
	122	$str =~ s/ $//;
625e016d DL	123	push @lines, $str . "\\n\" \\\n";
	124	push @lines, " \" > - selected route, * - FIB route\\n\\n\"";
	125	return join("", @lines);
e0ca5fde DL	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 {
9f0ea7d4	134	my ($daemon, $ipv4, $ipv6, $any) = @_;
e0ca5fde DL	135	my (@names, @help) = ((), ());
	136	for my $p (@protos) {
	137	next if ($protodetail{$p}->{"daemon"} eq $daemon && $daemon ne "zebra");
5ee62c66 PZ	138	next if ($protodetail{$p}->{"restrict2"} ne "" &&
5ee62c66 PZ	139	$protodetail{$p}->{"restrict2"} ne $daemon);
82557cf0	140	next if ($protodetail{$p}->{"redist"} eq 0);
e0ca5fde	141	next unless (($ipv4 && $protodetail{$p}->{"ipv4"})
82557cf0	142	\|\| ($ipv6 && $protodetail{$p}->{"ipv6"}));
e0ca5fde DL	143	push @names, $protodetail{$p}->{"cname"};
	144	push @help, " \"".$protodetail{$p}->{"longhelp"}."\\n\"";
	145	}
9f0ea7d4 DS	146	if ($any == 1) {
	147	push @names, "any";
	148	push @help, " \"Any of the above protocols\\n\"";
	149	}
c3d89003	150	return ("\"<" . join("\|", @names) . ">\"", join(" \\\n", @help));
e0ca5fde DL	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"}) {
9f0ea7d4	157	my ($names, $help) = collect($daemon, 1, 1, 0);
ab0181ee DL	158	printf "#define FRR_REDIST_STR_%s \\\n %s\n", uc $daemon, $names;
ab0181ee DL	159	printf "#define FRR_REDIST_HELP_STR_%s \\\n%s\n", uc $daemon, $help;
de69c444	160
9f0ea7d4	161	($names, $help) = collect($daemon, 1, 0, 0);
ab0181ee DL	162	printf "#define FRR_IP_REDIST_STR_%s \\\n %s\n", uc $daemon, $names;
ab0181ee DL	163	printf "#define FRR_IP_REDIST_HELP_STR_%s \\\n%s\n", uc $daemon, $help;
de69c444	164
9f0ea7d4	165	($names, $help) = collect($daemon, 0, 1, 0);
ab0181ee DL	166	printf "#define FRR_IP6_REDIST_STR_%s \\\n %s\n", uc $daemon, $names;
ab0181ee DL	167	printf "#define FRR_IP6_REDIST_HELP_STR_%s \\\n%s\n", uc $daemon, $help;
de69c444	168
9f0ea7d4	169	if ($daemon eq "zebra") {
de69c444	170	($names, $help) = collect($daemon, 1, 0, 1);
ab0181ee DL	171	printf "#define FRR_IP_PROTOCOL_MAP_STR_%s \\\n %s\n", uc $daemon, $names;
ab0181ee DL	172	printf "#define FRR_IP_PROTOCOL_MAP_HELP_STR_%s \\\n%s\n", uc $daemon, $help;
de69c444 DW	173
de69c444 DW	174	($names, $help) = collect($daemon, 0, 1, 1);
ab0181ee DL	175	printf "#define FRR_IP6_PROTOCOL_MAP_STR_%s \\\n %s\n", uc $daemon, $names;
ab0181ee DL	176	printf "#define FRR_IP6_PROTOCOL_MAP_HELP_STR_%s \\\n%s\n", uc $daemon, $help;
9f0ea7d4	177	}
e0ca5fde DL	178	} else {
e0ca5fde DL	179	my ($names, $help) = collect($daemon,
9f0ea7d4	180	$daemons{$daemon}->{"ipv4"}, $daemons{$daemon}->{"ipv6"}, 0);
ab0181ee DL	181	printf "#define FRR_REDIST_STR_%s \\\n %s\n", uc $daemon, $names;
ab0181ee DL	182	printf "#define FRR_REDIST_HELP_STR_%s \\\n%s\n", uc $daemon, $help;
e0ca5fde DL	183	}
	184	print "\n";
	185	}
	186
	187	print <<EOF;
	188
ab0181ee	189	#ifdef FRR_DEFINE_DESC_TABLE
e0ca5fde DL	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
ab0181ee	212	#endif /* FRR_DEFINE_DESC_TABLE */
e0ca5fde	213
ab0181ee	214	#endif /* _FRR_ROUTE_TYPES_H */
e0ca5fde DL	215	EOF
e0ca5fde DL	216