protocol.h 15.8 KB
Newer Older
1 2 3
/*
 *	BIRD Internet Routing Daemon -- Protocols
 *
4
 *	(c) 1998--2000 Martin Mares <mj@ucw.cz>
5 6 7 8 9 10 11
 *
 *	Can be freely distributed and used under the terms of the GNU GPL.
 */

#ifndef _BIRD_PROTOCOL_H_
#define _BIRD_PROTOCOL_H_

12
#include "lib/lists.h"
13
#include "lib/resource.h"
14
#include "lib/timer.h"
15
#include "conf/conf.h"
16

17
struct iface;
18
struct ifa;
19
struct rtable;
20 21
struct rte;
struct neighbor;
22
struct rta;
23
struct network;
24 25 26
struct proto_config;
struct config;
struct proto;
27
struct event;
28
struct ea_list;
29
struct eattr;
30
struct symbol;
31

32 33 34 35 36
/*
 *	Routing Protocol
 */

struct protocol {
37
  node n;
38
  char *name;
39
  char *template;			/* Template for automatic generation of names */
40
  int name_counter;			/* Counter for automatic name generation */
41
  int attr_class;			/* Attribute class known to this protocol */
42
  int multitable;			/* Protocol handles all announce hooks itself */
43
  unsigned preference;			/* Default protocol preference */
44

45 46 47
  void (*preconfig)(struct protocol *, struct config *);	/* Just before configuring */
  void (*postconfig)(struct proto_config *);			/* After configuring each instance */
  struct proto * (*init)(struct proto_config *);		/* Create new instance */
48
  int (*reconfigure)(struct proto *, struct proto_config *);	/* Try to reconfigure instance, returns success */
49
  void (*dump)(struct proto *);			/* Debugging dump */
50
  void (*dump_attrs)(struct rte *);		/* Dump protocol-dependent attributes */
51 52
  int (*start)(struct proto *);			/* Start the instance */
  int (*shutdown)(struct proto *);		/* Stop the instance */
53
  void (*cleanup)(struct proto *);		/* Called after shutdown when protocol became hungry/down */
54
  void (*get_status)(struct proto *, byte *buf); /* Get instance status (for `show protocols' command) */
55
  void (*get_route_info)(struct rte *, byte *buf, struct ea_list *attrs); /* Get route information (for `show route' command) */
56
  int (*get_attr)(struct eattr *, byte *buf, int buflen);	/* ASCIIfy dynamic attribute (returns GA_*) */
57
  void (*show_proto_info)(struct proto *);	/* Show protocol info (for `show protocols all' command) */
58
  void (*copy_config)(struct proto_config *, struct proto_config *);	/* Copy config from given protocol instance */
59 60
};

61
void protos_build(void);
62
void proto_build(struct protocol *);
63 64
void protos_preconfig(struct config *);
void protos_postconfig(struct config *);
65
void protos_commit(struct config *new, struct config *old, int force_restart, int type);
66
void protos_dump_all(void);
67

68 69 70
#define GA_UNKNOWN	0		/* Attribute not recognized */
#define GA_NAME		1		/* Result = name */
#define GA_FULL		2		/* Result = both name and value */
71 72 73 74 75

/*
 *	Known protocols
 */

Martin Mareš's avatar
Martin Mareš committed
76
extern struct protocol
77
  proto_device, proto_radv, proto_rip, proto_static,
Martin Mareš's avatar
Martin Mareš committed
78
  proto_ospf, proto_pipe, proto_bgp;
79 80 81 82 83

/*
 *	Routing Protocol Instance
 */

84 85 86
struct proto_config {
  node n;
  struct config *global;		/* Global configuration data */
87 88
  struct protocol *protocol;		/* Protocol */
  struct proto *proto;			/* Instance we've created */
89
  char *name;
90
  char *dsc;
91
  int class;				/* SYM_PROTO or SYM_TEMPLATE */
92 93
  u32 debug, mrtdump;			/* Debugging bitfields, both use D_* constants */
  unsigned preference, disabled;	/* Generic parameters */
94
  u32 router_id;			/* Protocol specific router ID */
95
  struct rtable_config *table;		/* Table we're attached to */
96
  struct filter *in_filter, *out_filter; /* Attached filters */
97
  struct proto_limit *in_limit;		/* Limit for importing routes from protocol */
98
  struct proto_limit *out_limit;	/* Limit for exporting routes to protocol */
99

100 101
  /* Check proto_reconfigure() and proto_copy_config() after changing struct proto_config */

102 103 104
  /* Protocol-specific data follow... */
};

105
/* Protocol statistics */
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
struct proto_stats {
  /* Import - from protocol to core */
  u32 imp_routes;		/* Number of routes successfully imported to the (adjacent) routing table */
  u32 pref_routes;		/* Number of routes that are preferred, sum over all routing table */
  u32 imp_updates_received;	/* Number of route updates received */
  u32 imp_updates_invalid;	/* Number of route updates rejected as invalid */
  u32 imp_updates_filtered;	/* Number of route updates rejected by filters */
  u32 imp_updates_ignored;	/* Number of route updates rejected as already in route table */
  u32 imp_updates_accepted;	/* Number of route updates accepted and imported */
  u32 imp_withdraws_received;	/* Number of route withdraws received */
  u32 imp_withdraws_invalid;	/* Number of route withdraws rejected as invalid */
  u32 imp_withdraws_ignored;	/* Number of route withdraws rejected as already not in route table */
  u32 imp_withdraws_accepted;	/* Number of route withdraws accepted and processed */

  /* Export - from core to protocol */
  u32 exp_routes;		/* Number of routes successfully exported to the protocol */
  u32 exp_updates_received;	/* Number of route updates received */
  u32 exp_updates_rejected;	/* Number of route updates rejected by protocol */
  u32 exp_updates_filtered;	/* Number of route updates rejected by filters */
  u32 exp_updates_accepted;	/* Number of route updates accepted and exported */ 
  u32 exp_withdraws_received;	/* Number of route withdraws received */
  u32 exp_withdraws_accepted;	/* Number of route withdraws accepted and processed */
};

130
struct proto {
131 132
  node n;				/* Node in *_proto_list */
  node glob_node;			/* Node in global proto_list */
133
  struct protocol *proto;		/* Protocol */
134
  struct proto_config *cf;		/* Configuration data */
135
  struct proto_config *cf_new;		/* Configuration we want to switch to after shutdown (NULL=delete) */
136
  pool *pool;				/* Pool containing local objects */
137
  struct event *attn;			/* "Pay attention" event */
138

139
  char *name;				/* Name of this instance (== cf->name) */
140 141
  u32 debug;				/* Debugging flags */
  u32 mrtdump;				/* MRTDump flags */
142
  unsigned preference;			/* Default route preference */
143 144 145 146 147 148 149 150 151 152
  byte accept_ra_types;			/* Which types of route announcements are accepted (RA_OPTIMAL or RA_ANY) */
  byte disabled;			/* Manually disabled */
  byte proto_state;			/* Protocol state machine (PS_*, see below) */
  byte core_state;			/* Core state machine (FS_*, see below) */
  byte core_goal;			/* State we want to reach (FS_*, see below) */
  byte reconfiguring;			/* We're shutting down due to reconfiguration */
  byte refeeding;			/* We are refeeding (valid only if core_state == FS_FEEDING) */
  byte flushing;			/* Protocol is flushed in current flush loop round */
  byte down_sched;			/* Shutdown is scheduled for later (PDS_*) */
  byte down_code;			/* Reason for shutdown (PDC_* codes) */
153
  u32 hash_key;				/* Random key used for hashing of neighbors */
154
  bird_clock_t last_state_change;	/* Time of last state transition */
155
  char *last_state_name_announced;	/* Last state name we've announced to the user */
156
  struct proto_stats stats;		/* Current protocol statistics */
157

158 159 160 161
  /*
   *	General protocol hooks:
   *
   *	   if_notify	Notify protocol about interface state changes.
162
   *	   ifa_notify	Notify protocol about interface address changes.
163 164 165 166 167 168 169 170
   *	   rt_notify	Notify protocol about routing table updates.
   *	   neigh_notify	Notify protocol about neighbor cache events.
   *	   make_tmp_attrs  Construct ea_list from private attrs stored in rte.
   *	   store_tmp_attrs Store private attrs back to the rte.
   *	   import_control  Called as the first step of the route importing process.
   *			It can construct a new rte, add private attributes and
   *			decide whether the route shall be imported: 1=yes, -1=no,
   *			0=process it through the import filter set by the user.
171 172 173
   *	   reload_routes   Request protocol to reload all its routes to the core
   *			(using rte_update()). Returns: 0=reload cannot be done,
   *			1= reload is scheduled and will happen (asynchronously).
174 175
   */

176 177
  void (*if_notify)(struct proto *, unsigned flags, struct iface *i);
  void (*ifa_notify)(struct proto *, unsigned flags, struct ifa *a);
178
  void (*rt_notify)(struct proto *, struct rtable *table, struct network *net, struct rte *new, struct rte *old, struct ea_list *attrs);
179
  void (*neigh_notify)(struct neighbor *neigh);
180 181 182
  struct ea_list *(*make_tmp_attrs)(struct rte *rt, struct linpool *pool);
  void (*store_tmp_attrs)(struct rte *rt, struct ea_list *attrs);
  int (*import_control)(struct proto *, struct rte **rt, struct ea_list **attrs, struct linpool *pool);
183
  int (*reload_routes)(struct proto *);
184 185 186 187

  /*
   *	Routing entry hooks (called only for rte's belonging to this protocol):
   *
188
   *	   rte_recalculate Called at the beginning of the best route selection  
189
   *	   rte_better	Compare two rte's and decide which one is better (1=first, 0=second).
190
   *       rte_same	Compare two rte's and decide whether they are identical (1=yes, 0=no).
191 192 193
   *	   rte_insert	Called whenever a rte is inserted to a routing table.
   *	   rte_remove	Called whenever a rte is removed from the routing table.
   */
194

195
  int (*rte_recalculate)(struct rtable *, struct network *, struct rte *, struct rte *, struct rte *);
196
  int (*rte_better)(struct rte *, struct rte *);
197
  int (*rte_same)(struct rte *, struct rte *);
198 199
  void (*rte_insert)(struct network *, struct rte *);
  void (*rte_remove)(struct network *, struct rte *);
200

201
  struct rtable *table;			/* Our primary routing table */
202
  struct announce_hook *main_ahook;	/* Primary announcement hook */
203
  struct announce_hook *ahooks;		/* Announcement hooks for this protocol */
204

205 206 207
  struct fib_iterator *feed_iterator;	/* Routing table iterator used during protocol feeding */
  struct announce_hook *feed_ahook;	/* Announce hook we currently feed */

208 209 210
  /* Hic sunt protocol-specific data */
};

211 212 213 214 215 216
struct proto_spec {
  void *ptr;
  int patt;
};


217 218 219 220 221 222 223 224 225 226 227 228
#define PDS_DISABLE		1	/* Proto disable scheduled */
#define PDS_RESTART		2	/* Proto restart scheduled */

#define PDC_CF_REMOVE		0x01	/* Removed in new config */
#define PDC_CF_DISABLE		0x02	/* Disabled in new config */
#define PDC_CF_RESTART		0x03	/* Restart due to reconfiguration */
#define PDC_CMD_DISABLE		0x11	/* Result of disable command */
#define PDC_CMD_RESTART		0x12	/* Result of restart command */
#define PDC_IN_LIMIT_HIT	0x21	/* Route import limit reached */
#define PDC_OUT_LIMIT_HIT	0x22	/* Route export limit reached - not implemented */


229
void *proto_new(struct proto_config *, unsigned size);
230 231
void *proto_config_new(struct protocol *, unsigned size, int class);
void proto_copy_config(struct proto_config *dest, struct proto_config *src);
232
void proto_request_feeding(struct proto *p);
233

234 235 236 237
static inline void
proto_copy_rest(struct proto_config *dest, struct proto_config *src, unsigned size)
{ memcpy(dest + 1, src + 1, size - sizeof(struct proto_config)); }

238

239
void proto_show_limit(struct proto_limit *l, const char *dsc);
240 241
void proto_show_basic_info(struct proto *p);

242 243 244 245 246 247 248 249
void proto_cmd_show(struct proto *, unsigned int, int);
void proto_cmd_disable(struct proto *, unsigned int, int);
void proto_cmd_enable(struct proto *, unsigned int, int);
void proto_cmd_restart(struct proto *, unsigned int, int);
void proto_cmd_reload(struct proto *, unsigned int, int);
void proto_cmd_debug(struct proto *, unsigned int, int);
void proto_cmd_mrtdump(struct proto *, unsigned int, int);

Ondřej Zajíček's avatar
Ondřej Zajíček committed
250
void proto_apply_cmd(struct proto_spec ps, void (* cmd)(struct proto *, unsigned int, int), int restricted, unsigned int arg);
251
struct proto *proto_get_named(struct symbol *, struct protocol *);
252 253 254 255

#define CMD_RELOAD	0
#define CMD_RELOAD_IN	1
#define CMD_RELOAD_OUT	2
256

257 258 259 260 261 262
static inline u32
proto_get_router_id(struct proto_config *pc)
{
  return pc->router_id ? pc->router_id : pc->global->router_id;
}

263
extern list active_proto_list;
264

265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
/*
 *  Each protocol instance runs two different state machines:
 *
 *  [P] The protocol machine: (implemented inside protocol)
 *
 *		DOWN    ---->    START
 *		  ^		   |
 *		  |		   V
 *		STOP    <----     UP
 *
 *	States:	DOWN	Protocol is down and it's waiting for the core
 *			requesting protocol start.
 *		START	Protocol is waiting for connection with the rest
 *			of the network and it's not willing to accept
 *			packets. When it connects, it goes to UP state.
 *		UP	Protocol is up and running. When the network
 *			connection breaks down or the core requests
 *			protocol to be terminated, it goes to STOP state.
 *		STOP	Protocol is disconnecting from the network.
 *			After it disconnects, it returns to DOWN state.
 *
 *	In:	start()	Called in DOWN state to request protocol startup.
 *			Returns new state: either UP or START (in this
 *			case, the protocol will notify the core when it
 *			finally comes UP).
 *		stop()	Called in START, UP or STOP state to request
 *			protocol shutdown. Returns new state: either
 *			DOWN or STOP (in this case, the protocol will
 *			notify the core when it finally comes DOWN).
 *
 *	Out:	proto_notify_state() -- called by protocol instance when
 *			it does any state transition not covered by
 *			return values of start() and stop(). This includes
 *			START->UP (delayed protocol startup), UP->STOP
 *			(spontaneous shutdown) and STOP->DOWN (delayed
 *			shutdown).
 */

#define PS_DOWN 0
#define PS_START 1
#define PS_UP 2
#define PS_STOP 3

void proto_notify_state(struct proto *p, unsigned state);

/*
 *  [F] The feeder machine: (implemented in core routines)
 *
 *		HUNGRY    ---->   FEEDING
 *		 ^		     |
 *		 | 		     V
 *		FLUSHING  <----   HAPPY
 *
 *	States:	HUNGRY	Protocol either administratively down (i.e.,
 *			disabled by the user) or temporarily down
 *			(i.e., [P] is not UP)
 *		FEEDING	The protocol came up and we're feeding it
 *			initial routes. [P] is UP.
 *		HAPPY	The protocol is up and it's receiving normal
 *			routing updates. [P] is UP.
 *		FLUSHING The protocol is down and we're removing its
 *			routes from the table. [P] is STOP or DOWN.
 *
 *	Normal lifecycle of a protocol looks like:
 *
 *		HUNGRY/DOWN --> HUNGRY/START --> HUNGRY/UP -->
 *		FEEDING/UP --> HAPPY/UP --> FLUSHING/STOP|DOWN -->
 *		HUNGRY/STOP|DOWN --> HUNGRY/DOWN
333 334 335 336
 *
 *	Sometimes, protocol might switch from HAPPY/UP to FEEDING/UP 
 *	if it wants to refeed the routes (for example BGP does so
 *	as a result of received ROUTE-REFRESH request).
337 338 339 340 341 342 343
 */

#define FS_HUNGRY 0
#define FS_FEEDING 1
#define FS_HAPPY 2
#define FS_FLUSHING 3

344 345 346 347 348 349
/*
 *	Debugging flags
 */

#define D_STATES 1		/* [core] State transitions */
#define D_ROUTES 2		/* [core] Routes passed by the filters */
350 351 352 353
#define D_FILTERS 4		/* [core] Routes rejected by the filters */
#define D_IFACES 8		/* [core] Interface events */
#define D_EVENTS 16		/* Protocol events */
#define D_PACKETS 32		/* Packets sent/received */
354

355 356 357 358 359 360 361
/*
 *	MRTDump flags
 */

#define MD_STATES	1		/* Protocol state changes (BGP4MP_MESSAGE_AS4) */
#define MD_MESSAGES	2		/* Protocol packets (BGP4MP_MESSAGE_AS4) */

362 363 364 365
/*
 *	Known unique protocol instances as referenced by config routines
 */

366
extern struct proto_config *cf_dev_proto;
367

368 369 370 371 372 373 374 375 376 377

/*
 * Protocol limits
 */

#define PLA_WARN	1	/* Issue log warning */
#define PLA_BLOCK	2	/* Block new routes */
#define PLA_RESTART	4	/* Force protocol restart */
#define PLA_DISABLE	5	/* Shutdown and disable protocol */

378 379 380 381
#define PLS_INITIAL	0	/* Initial limit state after protocol start */
#define PLS_ACTIVE	1	/* Limit was hit */
#define PLS_BLOCKED	2	/* Limit is active and blocking new routes */

382 383 384
struct proto_limit {
  u32 limit;			/* Maximum number of prefixes */
  byte action;			/* Action to take (PLA_*) */
385
  byte state;			/* State of limit (PLS_*) */
386 387
};

388 389 390 391 392 393 394 395
void proto_notify_limit(struct announce_hook *ah, struct proto_limit *l, u32 rt_count);

static inline void proto_reset_limit(struct proto_limit *l)
{
  if (l)
    l->state = PLS_INITIAL;
}

396
 
397 398 399 400 401 402 403 404
/*
 *	Route Announcement Hook
 */

struct announce_hook {
  node n;
  struct rtable *table;
  struct proto *proto;
405 406
  struct filter *in_filter;		/* Input filter */
  struct filter *out_filter;		/* Output filter */
407
  struct proto_limit *in_limit;		/* Input limit */
408
  struct proto_limit *out_limit;	/* Output limit */
409
  struct proto_stats *stats;		/* Per-table protocol statistics */
410 411 412
  struct announce_hook *next;		/* Next hook for the same protocol */
};

413
struct announce_hook *proto_add_announce_hook(struct proto *p, struct rtable *t, struct proto_stats *stats);
414
struct announce_hook *proto_find_announce_hook(struct proto *p, struct rtable *t);
415

416
#endif