Commit 11fabd2d authored by Pavel Tvrdík's avatar Pavel Tvrdík
Browse files

Integrate MRT Table Dump (RFC 6396) into BIRD 

Asynchronous periodic mrt table dumps of routes configuration in bird.conf:
mrtdump routes {
  [ filename "<format>"; ]
  [ table <name>|"<wildcard name>"; ]
  [ period <num>; ]
  [ filter <filter>|where <condition>; ]
}

Synchronous mrt table dumps of routes in BIRD client:
mrtdump routes [table <name>|"<wildcard name>"] [to "<filename format>"] [filter <filter>|where <condition>]
parent de77e5cd

conf/conf.c

+2 −1
Original line number Diff line number Diff line
@@ -53,6 +53,7 @@ 
#include "lib/string.h"

#include "lib/event.h"

#include "lib/timer.h"

#include "lib/unix.h"

#include "conf/conf.h"

#include "filter/filter.h"
@@ -91,7 +92,7 @@ config_alloc(byte *name) 
  linpool *l = lp_new(p, 4080);

  struct config *c = lp_allocz(l, sizeof(struct config));



  c->mrtdump_file = -1; /* Hack, this should be sysdep-specific */

  c->mrt_proto_file = -1; 		/* Indication that the file descriptor should not be used */

  c->pool = p;

  cfg_mem = c->mem = l;

  c->file_name = cfg_strdup(name);

conf/conf.h

+32 −3
Original line number Diff line number Diff line
@@ -14,8 +14,36 @@ 
#include "lib/resource.h"

#include "lib/timer.h"



/* Configuration structures */



#define MRT_TABLE_NOT_CONFIGURED -1

#define MRT_TABLE_DEFAULT_PERIOD 60

#define MRT_TABLE_DEFAULT_FILENAME_FMT "%f_%F_%T.mrt"

#define MRT_TABLE_DEFAULT_TABLENAME_PATTERN "*"



struct mrt_table_common_config {

  u32 period;				/* Time in seconds between Table Dump */

  char *filename_fmt;

  struct filter *filter;

  struct cli *cli;			/* Client console or NULL */

  struct config *config;		/* Configuration or NULL */

};



/* Template of configuration that can be apply at any table */

struct mrt_table_config {

  node n;				/* Node in config->mrt_table_dumps */

  struct mrt_table_common_config c;

  char *rtable_wildcard_name;

};



/* Configuration structure */

/* Configuration that is specific per table */

struct mrt_table_individual_config {

  node n;				/* Node in rtable_config->mrt_table_dumps */

  struct mrt_table_common_config c;

  timer *timer;				/* Timer for periodic dumps */

  struct rtable_config *table_cf;

  bird_clock_t next_dump;

};



struct config {

  pool *pool;				/* Pool the configuration is stored in */
@@ -23,9 +51,10 @@ struct config { 
  list protos;				/* Configured protocol instances (struct proto_config) */

  list tables;				/* Configured routing tables (struct rtable_config) */

  list roa_tables;			/* Configured ROA tables (struct roa_table_config) */

  list logfiles;			/* Configured log fils (sysdep) */

  list logfiles;			/* Configured log files (sysdep) */

  list mrt_table_dumps;			/* Configured MRT table dumps (struct mrt_table_config) */



  int mrtdump_file;			/* Configured MRTDump file (sysdep, fd in unix) */

  int mrt_proto_file;			/* Configured MRTDump file (sysdep, fd in unix) for Protocols*/

  char *syslog_name;			/* Name used for syslog (NULL -> no syslog) */

  struct rtable_config *master_rtc;	/* Configuration of master routing table */

  struct iface_patt *router_id_from;	/* Configured list of router ID iface patterns */

doc/bird.sgml

+56 −17
Original line number Diff line number Diff line
@@ -362,16 +362,49 @@ protocol rip { 
	seconds, zero means disabled. Default: disabled (0).



	<tag>mrtdump "<m/filename/"</tag>

	Set MRTdump file name. This option must be specified to allow MRTdump

	feature. Default: no dump file.

	Set MRTdump protocols file name. This option must be specified to allow MRTdump

	protocols feature. Default: no dump file.



	<tag>mrtdump protocols all|off|{ states, messages }</tag>

	Set global defaults of MRTdump options. See <cf/mrtdump/ in the

	Set global defaults of MRTdump protocol options. See <ref id="protocol-mrtdump" name="mrtdump"> in the

	following section. Default: off.



	<tag><label id="dsc-mrtdump-routes">mrtdump routes [ { <m/option1; option2; .../ } ]</tag>



	Configure periodic <htmlurl url="https://tools.ietf.org/html/rfc6396#section-4.3" name="MRT Table Dump v2 (RFC 6396)">

	of routes (not only BGP).

	All mrtdump options are optional. Default: disabled



	<descrip>

		<tag/ <cf>filename "<m/format/" </cf> /

			Configure file to output.

			Filename format is the <it/strftime(3)/-like format (see

			<it/man strftime/ for details) extended of a key <cf/%f/ for replacing with the name of the table.

			Default: <cf>"%f_%F_%T.mrt"</cf>

		<tag/ <cf>table <m/name/|"<m/pattern/" </cf> /

			Choosing tables from which will be routes taken.

			Can be used wildcards <cf>*</cf> and <cf>?</cf>.

			Default: <cf>"*"</cf> for all tables

		<tag/ <cf>period <m/num/ </cf> /

			Configures the interval in seconds between mrt table dumps.

			Default: <cf>60</cf> seconds

		<tag/ <cf>filter <m/filter/ | where <m/condition/</cf> /

			Configure filtering dumping routes. Filters are more described in <ref id="chapt-filters" name="the chapter Filters">.

			Default: Accept all

	</descrip>



	Example:

<p><code>

mrtdump routes {

	filename "%f-%s.mrt";	# dumps will be saved into files named like 'tableA-1437119435.mrt'

	table "t*";		# only routes from tables starts with character 't'

	period 10;		# 10 seconds interval between dumps

	where source = RTS_BGP;	# only routes from BGP protocols

}

mrtdump routes;			# another mrtdump route config with default options</code>



	<tag>filter <m/name local variables/ { <m/commands/ }</tag>

	Define a filter. You can learn more about filters in the following

	chapter.

	Define a filter. You can learn more about filters in <ref id="chapt-filters" name="the chapter Filters">.



	<tag>function <m/name/ (<m/parameters/) <m/local variables/ { <m/commands/ }</tag>

	Define a function. You can learn more about functions in the following chapter.
@@ -454,12 +487,12 @@ protocol rip { 
	<cf/old short/ and <cf/old long/ compatibility shorthands.



	<tag>table <m/name/ [sorted] </tag>

	Create a new routing table. The default routing table is created

	Create a new routing table. The default <cf/master/ routing table is created

	implicitly, other routing tables have to be added by this command.

	Option <cf/sorted/ can be used to enable sorting of routes, see

	<ref id="dsc-sorted" name="sorted table"> description for details.



	<tag>roa table <m/name/ [ { roa table options ... } ]</tag>

	<tag>roa table <m/name/ [ { <m/roa table options/ } ]</tag>

	Create a new ROA (Route Origin Authorization) table. ROA tables can be

	used to validate route origination of BGP routes. A ROA table contains

	ROA entries, each consist of a network prefix, a max prefix length and
@@ -511,8 +544,9 @@ agreement"). 
	protocol, <cf/events/ for events internal to the protocol and <cf/packets/

	for packets sent and received by the protocol. Default: off.



	<tag>mrtdump all|off|{ states, messages }</tag>

	Set protocol MRTdump flags. MRTdump is a standard binary format for

	<tag><label id="protocol-mrtdump">mrtdump all|off|{ states, messages }</tag>

	Set protocol MRTdump flags. MRTdump is a standard binary format (see

	<htmlurl url="https://tools.ietf.org/html/rfc6396#section-4.4" name="BGP4MP in RFC 6396">)) for

	logging information from routing protocols and daemons. These flags

	control what kind of information is logged from the protocol to the

	MRTdump file (which must be specified by global <cf/mrtdump/ option, see
@@ -752,7 +786,7 @@ This argument can be omitted if there exists only a single instance. 
	Show the list of symbols defined in the configuration (names of

	protocols, routing tables etc.).



	<tag>show route [[for] <m/prefix/|<m/IP/] [table <m/sym/] [filter <m/f/|where <m/c/] [(export|preexport|noexport) <m/p/] [protocol <m/p/] [<m/options/]</tag>

	<tag>show route [[for] <m/prefix/|<m/IP/] [table <m/name/] [filter <m/f/|where <m/c/] [(export|preexport|noexport) <m/p/] [protocol <m/p/] [<m/options/]</tag>

	Show contents of a routing table (by default of the main one or the

	table attached to a respective protocol), that is routes, their metrics

	and (in case the <cf/all/ switch is given) all their attributes.
@@ -787,7 +821,7 @@ This argument can be omitted if there exists only a single instance. 
	number of networks, number of routes before and after filtering). If

	you use <cf/count/ instead, only the statistics will be printed.



	<tag>show roa [<m/prefix/ | in <m/prefix/ | for <m/prefix/] [as <m/num/] [table <m/t/>]</tag>

	<tag>show roa [<m/prefix/ | in <m/prefix/ | for <m/prefix/] [as <m/num/] [table <m/name/]</tag>

	Show contents of a ROA table (by default of the first one). You can

	specify a <m/prefix/ to print ROA entries for a specific network. If you

	use <cf>for <m/prefix/</cf>, you'll get all entries relevant for route
@@ -796,16 +830,16 @@ This argument can be omitted if there exists only a single instance. 
	entries covered by the network prefix. You could also use <cf/as/ option

	to show just entries for given AS.



	<tag>add roa <m/prefix/ max <m/num/] as <m/num/ [table <m/t/>]</tag>

	<tag>add roa <m/prefix/ max <m/num/ as <m/num/ [table <m/name/]</tag>

	Add a new ROA entry to a ROA table. Such entry is called <it/dynamic/

	compared to <it/static/ entries specified in the config file. These

	dynamic entries survive reconfiguration.



	<tag>delete roa <m/prefix/ max <m/num/] as <m/num/ [table <m/t/>]</tag>

	<tag>delete roa <m/prefix/ max <m/num/ as <m/num/ [table <m/name/]</tag>

	Delete the specified ROA entry from a ROA table. Only dynamic ROA

	entries (i.e., the ones added by <cf/add roa/ command) can be deleted.



	<tag>flush roa [table <m/t/>]</tag>

	<tag>flush roa [table <m/name/]</tag>

	Remove all dynamic ROA entries from a ROA table.



	<tag>configure [soft] ["<m/config file/"] [timeout [<m/num/]]</tag>
@@ -873,6 +907,11 @@ This argument can be omitted if there exists only a single instance. 
	<tag>dump resources|sockets|interfaces|neighbors|attributes|routes|protocols</tag>

	Dump contents of internal data structures to the debugging output.



	<tag>mrtdump routes [table <m/name/|"<m/pattern/"] [to "<m/filename/"] [filter <m/filter/ | where <m/condition/]</tag>



	Once the specified routes will be saved into file(s) named based on <m/filename/ format.

	For more details about mrtdump options see <ref id="dsc-mrtdump-routes" name="mrtdump routes in the chapter Configuration">.



	<tag>echo all|off|{ <m/list of log classes/ } [ <m/buffer-size/ ]</tag>

	Control echoing of log messages to the command-line output.

	See <ref id="dsc-log" name="log option"> for a list of log classes.
@@ -882,7 +921,7 @@ This argument can be omitted if there exists only a single instance. 
</descrip>





<chapt>Filters

<chapt><label id="chapt-filters">Filters



<sect>Introduction

lib/patmatch.c

+1 −1
Original line number Diff line number Diff line
@@ -16,7 +16,7 @@ 
#endif



int

MATCH_FUNC_NAME(byte *p, byte *s)

MATCH_FUNC_NAME(const byte *p, const byte *s)

{

  while (*p)

    {

lib/string.h

+1 −1
Original line number Diff line number Diff line
@@ -24,6 +24,6 @@ int buffer_vprint(buffer *buf, const char *fmt, va_list args); 
int buffer_print(buffer *buf, const char *fmt, ...);

void buffer_puts(buffer *buf, const char *str);



int patmatch(byte *pat, byte *str);

int patmatch(const byte *pat, const byte *str);



#endif

CRA Git | Maintained and supported by SUSTech CRA and CCSE