[mirror_frr.git] / lib / route_types.pl

#!/usr/bin/perl
# SPDX-License-Identifier: GPL-2.0-or-later
##
## 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.
##

use strict;
use Getopt::Long;

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

my %daemons;

my @enabled;

GetOptions ("enabled=s" => \@enabled);
@enabled = split(/,/,join(',',@enabled));

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 == 9 || @f == 10) {
		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],
		"enabled" => $f[8],
		"restrict2" => $f[9],
	};
	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) {
		next unless (grep $_ eq $protodetail{$p}->{"enabled"}, @enabled);
		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, q - queued, r - rejected, b - backup\\n\"";
	push @lines, "  \"       t - trapped, o - offload failure\\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 (grep $_ eq $protodetail{$p}->{"enabled"}, @enabled);
		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	1	#!/usr/bin/perl
47a3a827	2	# SPDX-License-Identifier: GPL-2.0-or-later
e0ca5fde DL	3	##
	4	## Scan a file of route-type definitions (see eg route_types.txt) and
	5	## generate a corresponding header file with:
	6	##
	7	## - enum of Zserv route-types
	8	## - redistribute strings for the various Quagga daemons
	9	##
	10	## See route_types.txt for the format.
	11	##
	12	##
	13	## Copyright (C) 2009 David Lamparter.
e0ca5fde DL	14	##
	15
	16	use strict;
b3b4dfa5	17	use Getopt::Long;
e0ca5fde DL	18
	19	# input processing
	20	#
	21	my @protos;
	22	my %protodetail;
	23
	24	my %daemons;
	25
b3b4dfa5 IR	26	my @enabled;
	27
	28	GetOptions ("enabled=s" => \@enabled);
	29	@enabled = split(/,/,join(',',@enabled));
	30
e0ca5fde DL	31	while (<STDIN>) {
	32	# skip comments and empty lines
	33	next if (/^\s*(#\|$)/);
	34
	35	# strip whitespace
	36	chomp;
	37	$_ =~ s/^\s*//;
	38	$_ =~ s/\s*$//;
	39
	40	# match help strings
	41	if (/^(ZEBRA_ROUTE_[^\s]+)\s,\s"(.*)"$/) {
	42	$protodetail{$1}->{'longhelp'} = $2;
	43	next;
	44	}
	45
	46	$_ =~ s/\s,\s/,/g;
	47
82557cf0	48	# else: 8-field line
e0ca5fde	49	my @f = split(/,/, $_);
b3b4dfa5	50	unless (@f == 9 \|\| @f == 10) {
e0ca5fde DL	51	die "invalid input on route_types line $.\n";
	52	}
	53
	54	my $proto = $f[0];
	55	$f[3] = $1 if ($f[3] =~ /^'(.*)'$/);
82557cf0	56	$f[7] = $1 if ($f[7] =~ /^"(.*)"$/);
e0ca5fde DL	57
	58	$protodetail{$proto} = {
	59	"number" => scalar @protos,
	60	"type" => $f[0],
	61	"cname" => $f[1],
	62	"daemon" => $f[2],
	63	"char" => $f[3],
	64	"ipv4" => int($f[4]),
	65	"ipv6" => int($f[5]),
82557cf0 DS	66	"redist" => int($f[6]),
82557cf0 DS	67	"shorthelp" => $f[7],
b3b4dfa5 IR	68	"enabled" => $f[8],
b3b4dfa5 IR	69	"restrict2" => $f[9],
e0ca5fde DL	70	};
	71	push @protos, $proto;
	72	$daemons{$f[2]} = {
	73	"ipv4" => int($f[4]),
	74	"ipv6" => int($f[5])
	75	} unless ($f[2] eq "NULL");
	76	}
	77
	78	# output
	79	printf <<EOF, $ARGV[0];
	80	/* Auto-generated from route_types.txt by %s. */
	81	/* Do not edit! */
	82
ab0181ee DL	83	#ifndef _FRR_ROUTE_TYPES_H
ab0181ee DL	84	#define _FRR_ROUTE_TYPES_H
e0ca5fde	85
9f0ea7d4	86	/* Zebra route's' types. */
e0ca5fde DL	87	EOF
	88
	89	push @protos, "ZEBRA_ROUTE_MAX";
	90	my (@protosv4, @protosv6) = ((), ());
	91	for (my $c = 0; $c < @protos; $c++) {
	92	my $p = $protos[$c];
	93	printf "#define %-32s %d\n", $p, $c;
	94	push @protosv4, $p if ($protodetail{$p}->{"ipv4"});
	95	push @protosv6, $p if ($protodetail{$p}->{"ipv6"});
	96	}
	97	pop @protos;
	98
	99	sub codelist {
	100	my (@protos) = @_;
	101	my (@lines) = ();
	102	my $str = " \"Codes: ";
	103	for my $p (@protos) {
b3b4dfa5	104	next unless (grep $_ eq $protodetail{$p}->{"enabled"}, @enabled);
e0ca5fde DL	105	my $s = sprintf("%s - %s, ",
	106	$protodetail{$p}->{"char"},
	107	$protodetail{$p}->{"shorthelp"});
	108	if (length($str . $s) > 70) {
	109	$str =~ s/ $//;
625e016d	110	push @lines, $str . "\\n\" \\\n";
e0ca5fde DL	111	$str = " \" ";
	112	}
	113	$str .= $s;
	114	}
	115	$str =~ s/ $//;
625e016d	116	push @lines, $str . "\\n\" \\\n";
5a3cf853	117	push @lines, " \" > - selected route, * - FIB route, q - queued, r - rejected, b - backup\\n\"";
e3490d1f	118	push @lines, " \" t - trapped, o - offload failure\\n\\n\"";
5a3cf853 DS	119
5a3cf853 DS	120
625e016d	121	return join("", @lines);
e0ca5fde DL	122	}
	123
	124	print "\n";
	125	printf "#define SHOW_ROUTE_V4_HEADER \\\n%s\n", codelist(@protosv4);
	126	printf "#define SHOW_ROUTE_V6_HEADER \\\n%s\n", codelist(@protosv6);
	127	print "\n";
	128
	129	sub collect {
9f0ea7d4	130	my ($daemon, $ipv4, $ipv6, $any) = @_;
e0ca5fde DL	131	my (@names, @help) = ((), ());
	132	for my $p (@protos) {
	133	next if ($protodetail{$p}->{"daemon"} eq $daemon && $daemon ne "zebra");
5ee62c66 PZ	134	next if ($protodetail{$p}->{"restrict2"} ne "" &&
5ee62c66 PZ	135	$protodetail{$p}->{"restrict2"} ne $daemon);
82557cf0	136	next if ($protodetail{$p}->{"redist"} eq 0);
b3b4dfa5	137	next unless (grep $_ eq $protodetail{$p}->{"enabled"}, @enabled);
e0ca5fde	138	next unless (($ipv4 && $protodetail{$p}->{"ipv4"})
82557cf0	139	\|\| ($ipv6 && $protodetail{$p}->{"ipv6"}));
e0ca5fde DL	140	push @names, $protodetail{$p}->{"cname"};
	141	push @help, " \"".$protodetail{$p}->{"longhelp"}."\\n\"";
	142	}
9f0ea7d4 DS	143	if ($any == 1) {
	144	push @names, "any";
	145	push @help, " \"Any of the above protocols\\n\"";
	146	}
c3d89003	147	return ("\"<" . join("\|", @names) . ">\"", join(" \\\n", @help));
e0ca5fde DL	148	}
	149
	150	for my $daemon (sort keys %daemons) {
	151	next unless ($daemons{$daemon}->{"ipv4"} \|\| $daemons{$daemon}->{"ipv6"});
	152	printf "/* %s */\n", $daemon;
	153	if ($daemons{$daemon}->{"ipv4"} && $daemons{$daemon}->{"ipv6"}) {
9f0ea7d4	154	my ($names, $help) = collect($daemon, 1, 1, 0);
ab0181ee DL	155	printf "#define FRR_REDIST_STR_%s \\\n %s\n", uc $daemon, $names;
ab0181ee DL	156	printf "#define FRR_REDIST_HELP_STR_%s \\\n%s\n", uc $daemon, $help;
de69c444	157
9f0ea7d4	158	($names, $help) = collect($daemon, 1, 0, 0);
ab0181ee DL	159	printf "#define FRR_IP_REDIST_STR_%s \\\n %s\n", uc $daemon, $names;
ab0181ee DL	160	printf "#define FRR_IP_REDIST_HELP_STR_%s \\\n%s\n", uc $daemon, $help;
de69c444	161
9f0ea7d4	162	($names, $help) = collect($daemon, 0, 1, 0);
ab0181ee DL	163	printf "#define FRR_IP6_REDIST_STR_%s \\\n %s\n", uc $daemon, $names;
ab0181ee DL	164	printf "#define FRR_IP6_REDIST_HELP_STR_%s \\\n%s\n", uc $daemon, $help;
de69c444	165
9f0ea7d4	166	if ($daemon eq "zebra") {
de69c444	167	($names, $help) = collect($daemon, 1, 0, 1);
ab0181ee DL	168	printf "#define FRR_IP_PROTOCOL_MAP_STR_%s \\\n %s\n", uc $daemon, $names;
ab0181ee DL	169	printf "#define FRR_IP_PROTOCOL_MAP_HELP_STR_%s \\\n%s\n", uc $daemon, $help;
de69c444 DW	170
de69c444 DW	171	($names, $help) = collect($daemon, 0, 1, 1);
ab0181ee DL	172	printf "#define FRR_IP6_PROTOCOL_MAP_STR_%s \\\n %s\n", uc $daemon, $names;
ab0181ee DL	173	printf "#define FRR_IP6_PROTOCOL_MAP_HELP_STR_%s \\\n%s\n", uc $daemon, $help;
9f0ea7d4	174	}
e0ca5fde DL	175	} else {
e0ca5fde DL	176	my ($names, $help) = collect($daemon,
9f0ea7d4	177	$daemons{$daemon}->{"ipv4"}, $daemons{$daemon}->{"ipv6"}, 0);
ab0181ee DL	178	printf "#define FRR_REDIST_STR_%s \\\n %s\n", uc $daemon, $names;
ab0181ee DL	179	printf "#define FRR_REDIST_HELP_STR_%s \\\n%s\n", uc $daemon, $help;
e0ca5fde DL	180	}
	181	print "\n";
	182	}
	183
	184	print <<EOF;
	185
ab0181ee	186	#ifdef FRR_DEFINE_DESC_TABLE
e0ca5fde DL	187
	188	struct zebra_desc_table
	189	{
	190	unsigned int type;
	191	const char *string;
	192	char chr;
	193	};
	194
	195	#define DESC_ENTRY(T,S,C) [(T)] = { (T), (S), (C) }
	196	static const struct zebra_desc_table route_types[] = {
	197	EOF
	198
	199	for (my $c = 0; $c < @protos; $c++) {
	200	my $p = $protos[$c];
	201	printf " DESC_ENTRY\t(%s\t \"%s\",\t'%s' ),\n",
	202	$p.",", $protodetail{$p}->{"cname"}, $protodetail{$p}->{"char"};
	203	}
	204
	205	print <<EOF;
	206	};
	207	#undef DESC_ENTRY
	208
ab0181ee	209	#endif /* FRR_DEFINE_DESC_TABLE */
e0ca5fde	210
ab0181ee	211	#endif /* _FRR_ROUTE_TYPES_H */
e0ca5fde DL	212	EOF
e0ca5fde DL	213