2 * BIRD Internet Routing Daemon -- Protocols
4 * (c) 1998--2000 Martin Mares <mj@ucw.cz>
6 * Can be freely distributed and used under the terms of the GNU GPL.
9 #ifndef _BIRD_PROTOCOL_H_
10 #define _BIRD_PROTOCOL_H_
12 #include "lib/lists.h"
13 #include "lib/resource.h"
14 #include "lib/timer.h"
15 #include "conf/conf.h"
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 */
45 void (*preconfig
)(struct protocol
*, struct config
*); /* Just before configuring */
46 void (*postconfig
)(struct proto_config
*); /* After configuring each instance */
47 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 int (*start
)(struct proto
*); /* Start the instance */
52 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 */
61 void protos_build(void);
62 void proto_build(struct protocol
*);
63 void protos_preconfig(struct config
*);
64 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);
68 #define GA_UNKNOWN 0 /* Attribute not recognized */
69 #define GA_NAME 1 /* Result = name */
70 #define GA_FULL 2 /* Result = both name and value */
76 extern struct protocol
77 proto_device
, proto_radv
, proto_rip
, proto_static
,
78 proto_ospf
, proto_pipe
, proto_bgp
, proto_bfd
;
81 * Routing Protocol Instance
86 struct config
*global
; /* Global configuration data */
87 struct protocol
*protocol
; /* Protocol */
88 struct proto
*proto
; /* Instance we've created */
91 int class; /* SYM_PROTO or SYM_TEMPLATE */
92 u32 debug
, mrtdump
; /* Debugging bitfields, both use D_* constants */
93 unsigned preference
, disabled
; /* Generic parameters */
94 int in_keep_filtered
; /* Routes rejected in import filter are kept */
95 u32 router_id
; /* Protocol specific router ID */
96 struct rtable_config
*table
; /* Table we're attached to */
97 struct filter
*in_filter
, *out_filter
; /* Attached filters */
98 struct proto_limit
*rx_limit
; /* Limit for receiving routes from protocol
99 (relevant when in_keep_filtered is active) */
100 struct proto_limit
*in_limit
; /* Limit for importing routes from protocol */
101 struct proto_limit
*out_limit
; /* Limit for exporting routes to protocol */
103 /* Check proto_reconfigure() and proto_copy_config() after changing struct proto_config */
105 /* Protocol-specific data follow... */
108 /* Protocol statistics */
110 /* Import - from protocol to core */
111 u32 imp_routes
; /* Number of routes successfully imported to the (adjacent) routing table */
112 u32 filt_routes
; /* Number of routes rejected in import filter but kept in the routing table */
113 u32 pref_routes
; /* Number of routes that are preferred, sum over all routing tables */
114 u32 imp_updates_received
; /* Number of route updates received */
115 u32 imp_updates_invalid
; /* Number of route updates rejected as invalid */
116 u32 imp_updates_filtered
; /* Number of route updates rejected by filters */
117 u32 imp_updates_ignored
; /* Number of route updates rejected as already in route table */
118 u32 imp_updates_accepted
; /* Number of route updates accepted and imported */
119 u32 imp_withdraws_received
; /* Number of route withdraws received */
120 u32 imp_withdraws_invalid
; /* Number of route withdraws rejected as invalid */
121 u32 imp_withdraws_ignored
; /* Number of route withdraws rejected as already not in route table */
122 u32 imp_withdraws_accepted
; /* Number of route withdraws accepted and processed */
124 /* Export - from core to protocol */
125 u32 exp_routes
; /* Number of routes successfully exported to the protocol */
126 u32 exp_updates_received
; /* Number of route updates received */
127 u32 exp_updates_rejected
; /* Number of route updates rejected by protocol */
128 u32 exp_updates_filtered
; /* Number of route updates rejected by filters */
129 u32 exp_updates_accepted
; /* Number of route updates accepted and exported */
130 u32 exp_withdraws_received
; /* Number of route withdraws received */
131 u32 exp_withdraws_accepted
; /* Number of route withdraws accepted and processed */
135 node n
; /* Node in *_proto_list */
136 node glob_node
; /* Node in global proto_list */
137 struct protocol
*proto
; /* Protocol */
138 struct proto_config
*cf
; /* Configuration data */
139 struct proto_config
*cf_new
; /* Configuration we want to switch to after shutdown (NULL=delete) */
140 pool
*pool
; /* Pool containing local objects */
141 struct event
*attn
; /* "Pay attention" event */
143 char *name
; /* Name of this instance (== cf->name) */
144 u32 debug
; /* Debugging flags */
145 u32 mrtdump
; /* MRTDump flags */
146 unsigned preference
; /* Default route preference */
147 byte accept_ra_types
; /* Which types of route announcements are accepted (RA_OPTIMAL or RA_ANY) */
148 byte disabled
; /* Manually disabled */
149 byte proto_state
; /* Protocol state machine (PS_*, see below) */
150 byte core_state
; /* Core state machine (FS_*, see below) */
151 byte export_state
; /* Route export state (ES_*, see below) */
152 byte reconfiguring
; /* We're shutting down due to reconfiguration */
153 byte refeeding
; /* We are refeeding (valid only if export_state == ES_FEEDING) */
154 byte flushing
; /* Protocol is flushed in current flush loop round */
155 byte gr_recovery
; /* Protocol should participate in graceful restart recovery */
156 byte gr_lock
; /* Graceful restart mechanism should wait for this proto */
157 byte gr_wait
; /* Route export to protocol is postponed until graceful restart */
158 byte down_sched
; /* Shutdown is scheduled for later (PDS_*) */
159 byte down_code
; /* Reason for shutdown (PDC_* codes) */
160 u32 hash_key
; /* Random key used for hashing of neighbors */
161 bird_clock_t last_state_change
; /* Time of last state transition */
162 char *last_state_name_announced
; /* Last state name we've announced to the user */
163 struct proto_stats stats
; /* Current protocol statistics */
166 * General protocol hooks:
168 * if_notify Notify protocol about interface state changes.
169 * ifa_notify Notify protocol about interface address changes.
170 * rt_notify Notify protocol about routing table updates.
171 * neigh_notify Notify protocol about neighbor cache events.
172 * make_tmp_attrs Construct ea_list from private attrs stored in rte.
173 * store_tmp_attrs Store private attrs back to the rte.
174 * import_control Called as the first step of the route importing process.
175 * It can construct a new rte, add private attributes and
176 * decide whether the route shall be imported: 1=yes, -1=no,
177 * 0=process it through the import filter set by the user.
178 * reload_routes Request protocol to reload all its routes to the core
179 * (using rte_update()). Returns: 0=reload cannot be done,
180 * 1= reload is scheduled and will happen (asynchronously).
181 * feed_done Notify protocol about finish of route feeding.
184 void (*if_notify
)(struct proto
*, unsigned flags
, struct iface
*i
);
185 void (*ifa_notify
)(struct proto
*, unsigned flags
, struct ifa
*a
);
186 void (*rt_notify
)(struct proto
*, struct rtable
*table
, struct network
*net
, struct rte
*new, struct rte
*old
, struct ea_list
*attrs
);
187 void (*neigh_notify
)(struct neighbor
*neigh
);
188 struct ea_list
*(*make_tmp_attrs
)(struct rte
*rt
, struct linpool
*pool
);
189 void (*store_tmp_attrs
)(struct rte
*rt
, struct ea_list
*attrs
);
190 int (*import_control
)(struct proto
*, struct rte
**rt
, struct ea_list
**attrs
, struct linpool
*pool
);
191 int (*reload_routes
)(struct proto
*);
192 void (*feed_done
)(struct proto
*);
195 * Routing entry hooks (called only for routes belonging to this protocol):
197 * rte_recalculate Called at the beginning of the best route selection
198 * rte_better Compare two rte's and decide which one is better (1=first, 0=second).
199 * rte_same Compare two rte's and decide whether they are identical (1=yes, 0=no).
200 * rte_insert Called whenever a rte is inserted to a routing table.
201 * rte_remove Called whenever a rte is removed from the routing table.
204 int (*rte_recalculate
)(struct rtable
*, struct network
*, struct rte
*, struct rte
*, struct rte
*);
205 int (*rte_better
)(struct rte
*, struct rte
*);
206 int (*rte_same
)(struct rte
*, struct rte
*);
207 void (*rte_insert
)(struct network
*, struct rte
*);
208 void (*rte_remove
)(struct network
*, struct rte
*);
210 struct rtable
*table
; /* Our primary routing table */
211 struct rte_src
*main_source
; /* Primary route source */
212 struct announce_hook
*main_ahook
; /* Primary announcement hook */
213 struct announce_hook
*ahooks
; /* Announcement hooks for this protocol */
215 struct fib_iterator
*feed_iterator
; /* Routing table iterator used during protocol feeding */
216 struct announce_hook
*feed_ahook
; /* Announce hook we currently feed */
218 /* Hic sunt protocol-specific data */
227 #define PDS_DISABLE 1 /* Proto disable scheduled */
228 #define PDS_RESTART 2 /* Proto restart scheduled */
230 #define PDC_CF_REMOVE 0x01 /* Removed in new config */
231 #define PDC_CF_DISABLE 0x02 /* Disabled in new config */
232 #define PDC_CF_RESTART 0x03 /* Restart due to reconfiguration */
233 #define PDC_CMD_DISABLE 0x11 /* Result of disable command */
234 #define PDC_CMD_RESTART 0x12 /* Result of restart command */
235 #define PDC_CMD_SHUTDOWN 0x13 /* Result of global shutdown */
236 #define PDC_RX_LIMIT_HIT 0x21 /* Route receive limit reached */
237 #define PDC_IN_LIMIT_HIT 0x22 /* Route import limit reached */
238 #define PDC_OUT_LIMIT_HIT 0x23 /* Route export limit reached */
241 void *proto_new(struct proto_config
*, unsigned size
);
242 void *proto_config_new(struct protocol
*, unsigned size
, int class);
243 void proto_copy_config(struct proto_config
*dest
, struct proto_config
*src
);
244 void proto_request_feeding(struct proto
*p
);
247 proto_copy_rest(struct proto_config
*dest
, struct proto_config
*src
, unsigned size
)
248 { memcpy(dest
+ 1, src
+ 1, size
- sizeof(struct proto_config
)); }
250 void graceful_restart_recovery(void);
251 void graceful_restart_init(void);
252 void graceful_restart_show_status(void);
253 void proto_graceful_restart_lock(struct proto
*p
);
254 void proto_graceful_restart_unlock(struct proto
*p
);
256 #define DEFAULT_GR_WAIT 240
258 void proto_show_limit(struct proto_limit
*l
, const char *dsc
);
259 void proto_show_basic_info(struct proto
*p
);
261 void proto_cmd_show(struct proto
*, unsigned int, int);
262 void proto_cmd_disable(struct proto
*, unsigned int, int);
263 void proto_cmd_enable(struct proto
*, unsigned int, int);
264 void proto_cmd_restart(struct proto
*, unsigned int, int);
265 void proto_cmd_reload(struct proto
*, unsigned int, int);
266 void proto_cmd_debug(struct proto
*, unsigned int, int);
267 void proto_cmd_mrtdump(struct proto
*, unsigned int, int);
269 void proto_apply_cmd(struct proto_spec ps
, void (* cmd
)(struct proto
*, unsigned int, int), int restricted
, unsigned int arg
);
270 struct proto
*proto_get_named(struct symbol
*, struct protocol
*);
273 #define CMD_RELOAD_IN 1
274 #define CMD_RELOAD_OUT 2
277 proto_get_router_id(struct proto_config
*pc
)
279 return pc
->router_id
? pc
->router_id
: pc
->global
->router_id
;
282 extern list active_proto_list
;
285 * Each protocol instance runs two different state machines:
287 * [P] The protocol machine: (implemented inside protocol)
294 * States: DOWN Protocol is down and it's waiting for the core
295 * requesting protocol start.
296 * START Protocol is waiting for connection with the rest
297 * of the network and it's not willing to accept
298 * packets. When it connects, it goes to UP state.
299 * UP Protocol is up and running. When the network
300 * connection breaks down or the core requests
301 * protocol to be terminated, it goes to STOP state.
302 * STOP Protocol is disconnecting from the network.
303 * After it disconnects, it returns to DOWN state.
305 * In: start() Called in DOWN state to request protocol startup.
306 * Returns new state: either UP or START (in this
307 * case, the protocol will notify the core when it
309 * stop() Called in START, UP or STOP state to request
310 * protocol shutdown. Returns new state: either
311 * DOWN or STOP (in this case, the protocol will
312 * notify the core when it finally comes DOWN).
314 * Out: proto_notify_state() -- called by protocol instance when
315 * it does any state transition not covered by
316 * return values of start() and stop(). This includes
317 * START->UP (delayed protocol startup), UP->STOP
318 * (spontaneous shutdown) and STOP->DOWN (delayed
327 void proto_notify_state(struct proto
*p
, unsigned state
);
330 * [F] The feeder machine: (implemented in core routines)
332 * HUNGRY ----> FEEDING
335 * FLUSHING <---- HAPPY
337 * States: HUNGRY Protocol either administratively down (i.e.,
338 * disabled by the user) or temporarily down
339 * (i.e., [P] is not UP)
340 * FEEDING The protocol came up and we're feeding it
341 * initial routes. [P] is UP.
342 * HAPPY The protocol is up and it's receiving normal
343 * routing updates. [P] is UP.
344 * FLUSHING The protocol is down and we're removing its
345 * routes from the table. [P] is STOP or DOWN.
347 * Normal lifecycle of a protocol looks like:
349 * HUNGRY/DOWN --> HUNGRY/START --> HUNGRY/UP -->
350 * FEEDING/UP --> HAPPY/UP --> FLUSHING/STOP|DOWN -->
351 * HUNGRY/STOP|DOWN --> HUNGRY/DOWN
353 * Sometimes, protocol might switch from HAPPY/UP to FEEDING/UP
354 * if it wants to refeed the routes (for example BGP does so
355 * as a result of received ROUTE-REFRESH request).
359 #define FS_FEEDING 1 /* obsolete */
361 #define FS_FLUSHING 3
374 #define D_STATES 1 /* [core] State transitions */
375 #define D_ROUTES 2 /* [core] Routes passed by the filters */
376 #define D_FILTERS 4 /* [core] Routes rejected by the filters */
377 #define D_IFACES 8 /* [core] Interface events */
378 #define D_EVENTS 16 /* Protocol events */
379 #define D_PACKETS 32 /* Packets sent/received */
382 #define TRACE(flags, msg, args...) \
383 do { if (p->p.debug & flags) log(L_TRACE "%s: " msg, p->p.name , ## args ); } while(0)
391 #define MD_STATES 1 /* Protocol state changes (BGP4MP_MESSAGE_AS4) */
392 #define MD_MESSAGES 2 /* Protocol packets (BGP4MP_MESSAGE_AS4) */
395 * Known unique protocol instances as referenced by config routines
398 extern struct proto_config
*cf_dev_proto
;
405 #define PLD_RX 0 /* Receive limit */
406 #define PLD_IN 1 /* Import limit */
407 #define PLD_OUT 2 /* Export limit */
410 #define PLA_WARN 1 /* Issue log warning */
411 #define PLA_BLOCK 2 /* Block new routes */
412 #define PLA_RESTART 4 /* Force protocol restart */
413 #define PLA_DISABLE 5 /* Shutdown and disable protocol */
415 #define PLS_INITIAL 0 /* Initial limit state after protocol start */
416 #define PLS_ACTIVE 1 /* Limit was hit */
417 #define PLS_BLOCKED 2 /* Limit is active and blocking new routes */
420 u32 limit
; /* Maximum number of prefixes */
421 byte action
; /* Action to take (PLA_*) */
422 byte state
; /* State of limit (PLS_*) */
425 void proto_notify_limit(struct announce_hook
*ah
, struct proto_limit
*l
, int dir
, u32 rt_count
);
426 void proto_verify_limits(struct announce_hook
*ah
);
429 proto_reset_limit(struct proto_limit
*l
)
432 l
->state
= PLS_INITIAL
;
437 * Route Announcement Hook
440 struct announce_hook
{
442 struct rtable
*table
;
444 struct filter
*in_filter
; /* Input filter */
445 struct filter
*out_filter
; /* Output filter */
446 struct proto_limit
*rx_limit
; /* Receive limit (for in_keep_filtered) */
447 struct proto_limit
*in_limit
; /* Input limit */
448 struct proto_limit
*out_limit
; /* Output limit */
449 struct proto_stats
*stats
; /* Per-table protocol statistics */
450 struct announce_hook
*next
; /* Next hook for the same protocol */
451 int in_keep_filtered
; /* Routes rejected in import filter are kept */
454 struct announce_hook
*proto_add_announce_hook(struct proto
*p
, struct rtable
*t
, struct proto_stats
*stats
);
455 struct announce_hook
*proto_find_announce_hook(struct proto
*p
, struct rtable
*t
);