Annotation of embedaddon/bird/nest/protocol.h, revision 1.1
1.1 ! misho 1: /*
! 2: * BIRD Internet Routing Daemon -- Protocols
! 3: *
! 4: * (c) 1998--2000 Martin Mares <mj@ucw.cz>
! 5: *
! 6: * Can be freely distributed and used under the terms of the GNU GPL.
! 7: */
! 8:
! 9: #ifndef _BIRD_PROTOCOL_H_
! 10: #define _BIRD_PROTOCOL_H_
! 11:
! 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: struct rte;
! 21: struct neighbor;
! 22: struct rta;
! 23: struct network;
! 24: struct proto_config;
! 25: struct config;
! 26: struct proto;
! 27: struct event;
! 28: struct ea_list;
! 29: struct eattr;
! 30: struct symbol;
! 31:
! 32: /*
! 33: * Routing Protocol
! 34: */
! 35:
! 36: 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: uint preference; /* Default protocol preference */
! 44: uint config_size; /* Size of protocol config */
! 45:
! 46: void (*preconfig)(struct protocol *, struct config *); /* Just before configuring */
! 47: void (*postconfig)(struct proto_config *); /* After configuring each instance */
! 48: struct proto * (*init)(struct proto_config *); /* Create new instance */
! 49: int (*reconfigure)(struct proto *, struct proto_config *); /* Try to reconfigure instance, returns success */
! 50: void (*dump)(struct proto *); /* Debugging dump */
! 51: void (*dump_attrs)(struct rte *); /* Dump protocol-dependent attributes */
! 52: int (*start)(struct proto *); /* Start the instance */
! 53: int (*shutdown)(struct proto *); /* Stop the instance */
! 54: void (*cleanup)(struct proto *); /* Called after shutdown when protocol became hungry/down */
! 55: void (*get_status)(struct proto *, byte *buf); /* Get instance status (for `show protocols' command) */
! 56: void (*get_route_info)(struct rte *, byte *buf, struct ea_list *attrs); /* Get route information (for `show route' command) */
! 57: int (*get_attr)(struct eattr *, byte *buf, int buflen); /* ASCIIfy dynamic attribute (returns GA_*) */
! 58: void (*show_proto_info)(struct proto *); /* Show protocol info (for `show protocols all' command) */
! 59: void (*copy_config)(struct proto_config *, struct proto_config *); /* Copy config from given protocol instance */
! 60: };
! 61:
! 62: void protos_build(void);
! 63: void proto_build(struct protocol *);
! 64: void protos_preconfig(struct config *);
! 65: void protos_postconfig(struct config *);
! 66: void protos_commit(struct config *new, struct config *old, int force_restart, int type);
! 67: void protos_dump_all(void);
! 68:
! 69: #define GA_UNKNOWN 0 /* Attribute not recognized */
! 70: #define GA_NAME 1 /* Result = name */
! 71: #define GA_FULL 2 /* Result = both name and value */
! 72:
! 73: /*
! 74: * Known protocols
! 75: */
! 76:
! 77: extern struct protocol
! 78: proto_device, proto_radv, proto_rip, proto_static,
! 79: proto_ospf, proto_pipe, proto_bgp, proto_bfd, proto_babel;
! 80:
! 81: /*
! 82: * Routing Protocol Instance
! 83: */
! 84:
! 85: struct proto_config {
! 86: node n;
! 87: struct config *global; /* Global configuration data */
! 88: struct protocol *protocol; /* Protocol */
! 89: struct proto *proto; /* Instance we've created */
! 90: char *name;
! 91: char *dsc;
! 92: int class; /* SYM_PROTO or SYM_TEMPLATE */
! 93: u32 debug, mrtdump; /* Debugging bitfields, both use D_* constants */
! 94: unsigned preference, disabled; /* Generic parameters */
! 95: int in_keep_filtered; /* Routes rejected in import filter are kept */
! 96: u32 router_id; /* Protocol specific router ID */
! 97: struct rtable_config *table; /* Table we're attached to */
! 98: struct filter *in_filter, *out_filter; /* Attached filters */
! 99: struct proto_limit *rx_limit; /* Limit for receiving routes from protocol
! 100: (relevant when in_keep_filtered is active) */
! 101: struct proto_limit *in_limit; /* Limit for importing routes from protocol */
! 102: struct proto_limit *out_limit; /* Limit for exporting routes to protocol */
! 103:
! 104: /* Check proto_reconfigure() and proto_copy_config() after changing struct proto_config */
! 105:
! 106: /* Protocol-specific data follow... */
! 107: };
! 108:
! 109: /* Protocol statistics */
! 110: struct proto_stats {
! 111: /* Import - from protocol to core */
! 112: u32 imp_routes; /* Number of routes successfully imported to the (adjacent) routing table */
! 113: u32 filt_routes; /* Number of routes rejected in import filter but kept in the routing table */
! 114: u32 pref_routes; /* Number of routes that are preferred, sum over all routing tables */
! 115: u32 imp_updates_received; /* Number of route updates received */
! 116: u32 imp_updates_invalid; /* Number of route updates rejected as invalid */
! 117: u32 imp_updates_filtered; /* Number of route updates rejected by filters */
! 118: u32 imp_updates_ignored; /* Number of route updates rejected as already in route table */
! 119: u32 imp_updates_accepted; /* Number of route updates accepted and imported */
! 120: u32 imp_withdraws_received; /* Number of route withdraws received */
! 121: u32 imp_withdraws_invalid; /* Number of route withdraws rejected as invalid */
! 122: u32 imp_withdraws_ignored; /* Number of route withdraws rejected as already not in route table */
! 123: u32 imp_withdraws_accepted; /* Number of route withdraws accepted and processed */
! 124:
! 125: /* Export - from core to protocol */
! 126: u32 exp_routes; /* Number of routes successfully exported to the protocol */
! 127: u32 exp_updates_received; /* Number of route updates received */
! 128: u32 exp_updates_rejected; /* Number of route updates rejected by protocol */
! 129: u32 exp_updates_filtered; /* Number of route updates rejected by filters */
! 130: u32 exp_updates_accepted; /* Number of route updates accepted and exported */
! 131: u32 exp_withdraws_received; /* Number of route withdraws received */
! 132: u32 exp_withdraws_accepted; /* Number of route withdraws accepted and processed */
! 133: };
! 134:
! 135: struct proto {
! 136: node n; /* Node in *_proto_list */
! 137: node glob_node; /* Node in global proto_list */
! 138: struct protocol *proto; /* Protocol */
! 139: struct proto_config *cf; /* Configuration data */
! 140: struct proto_config *cf_new; /* Configuration we want to switch to after shutdown (NULL=delete) */
! 141: pool *pool; /* Pool containing local objects */
! 142: struct event *attn; /* "Pay attention" event */
! 143:
! 144: char *name; /* Name of this instance (== cf->name) */
! 145: u32 debug; /* Debugging flags */
! 146: u32 mrtdump; /* MRTDump flags */
! 147: unsigned preference; /* Default route preference */
! 148: byte accept_ra_types; /* Which types of route announcements are accepted (RA_OPTIMAL or RA_ANY) */
! 149: byte disabled; /* Manually disabled */
! 150: byte proto_state; /* Protocol state machine (PS_*, see below) */
! 151: byte core_state; /* Core state machine (FS_*, see below) */
! 152: byte export_state; /* Route export state (ES_*, see below) */
! 153: byte reconfiguring; /* We're shutting down due to reconfiguration */
! 154: byte refeeding; /* We are refeeding (valid only if export_state == ES_FEEDING) */
! 155: byte flushing; /* Protocol is flushed in current flush loop round */
! 156: byte gr_recovery; /* Protocol should participate in graceful restart recovery */
! 157: byte gr_lock; /* Graceful restart mechanism should wait for this proto */
! 158: byte gr_wait; /* Route export to protocol is postponed until graceful restart */
! 159: byte down_sched; /* Shutdown is scheduled for later (PDS_*) */
! 160: byte down_code; /* Reason for shutdown (PDC_* codes) */
! 161: byte merge_limit; /* Maximal number of nexthops for RA_MERGED */
! 162: u32 hash_key; /* Random key used for hashing of neighbors */
! 163: bird_clock_t last_state_change; /* Time of last state transition */
! 164: char *last_state_name_announced; /* Last state name we've announced to the user */
! 165: struct proto_stats stats; /* Current protocol statistics */
! 166:
! 167: /*
! 168: * General protocol hooks:
! 169: *
! 170: * if_notify Notify protocol about interface state changes.
! 171: * ifa_notify Notify protocol about interface address changes.
! 172: * rt_notify Notify protocol about routing table updates.
! 173: * neigh_notify Notify protocol about neighbor cache events.
! 174: * make_tmp_attrs Construct ea_list from private attrs stored in rte.
! 175: * store_tmp_attrs Store private attrs back to the rte.
! 176: * import_control Called as the first step of the route importing process.
! 177: * It can construct a new rte, add private attributes and
! 178: * decide whether the route shall be imported: 1=yes, -1=no,
! 179: * 0=process it through the import filter set by the user.
! 180: * reload_routes Request protocol to reload all its routes to the core
! 181: * (using rte_update()). Returns: 0=reload cannot be done,
! 182: * 1= reload is scheduled and will happen (asynchronously).
! 183: * feed_begin Notify protocol about beginning of route feeding.
! 184: * feed_end Notify protocol about finish of route feeding.
! 185: */
! 186:
! 187: void (*if_notify)(struct proto *, unsigned flags, struct iface *i);
! 188: void (*ifa_notify)(struct proto *, unsigned flags, struct ifa *a);
! 189: void (*rt_notify)(struct proto *, struct rtable *table, struct network *net, struct rte *new, struct rte *old, struct ea_list *attrs);
! 190: void (*neigh_notify)(struct neighbor *neigh);
! 191: struct ea_list *(*make_tmp_attrs)(struct rte *rt, struct linpool *pool);
! 192: void (*store_tmp_attrs)(struct rte *rt, struct ea_list *attrs);
! 193: int (*import_control)(struct proto *, struct rte **rt, struct ea_list **attrs, struct linpool *pool);
! 194: int (*reload_routes)(struct proto *);
! 195: void (*feed_begin)(struct proto *, int initial);
! 196: void (*feed_end)(struct proto *);
! 197:
! 198: /*
! 199: * Routing entry hooks (called only for routes belonging to this protocol):
! 200: *
! 201: * rte_recalculate Called at the beginning of the best route selection
! 202: * rte_better Compare two rte's and decide which one is better (1=first, 0=second).
! 203: * rte_same Compare two rte's and decide whether they are identical (1=yes, 0=no).
! 204: * rte_mergable Compare two rte's and decide whether they could be merged (1=yes, 0=no).
! 205: * rte_insert Called whenever a rte is inserted to a routing table.
! 206: * rte_remove Called whenever a rte is removed from the routing table.
! 207: */
! 208:
! 209: int (*rte_recalculate)(struct rtable *, struct network *, struct rte *, struct rte *, struct rte *);
! 210: int (*rte_better)(struct rte *, struct rte *);
! 211: int (*rte_same)(struct rte *, struct rte *);
! 212: int (*rte_mergable)(struct rte *, struct rte *);
! 213: void (*rte_insert)(struct network *, struct rte *);
! 214: void (*rte_remove)(struct network *, struct rte *);
! 215:
! 216: struct rtable *table; /* Our primary routing table */
! 217: struct rte_src *main_source; /* Primary route source */
! 218: struct announce_hook *main_ahook; /* Primary announcement hook */
! 219: struct announce_hook *ahooks; /* Announcement hooks for this protocol */
! 220:
! 221: struct fib_iterator *feed_iterator; /* Routing table iterator used during protocol feeding */
! 222: struct announce_hook *feed_ahook; /* Announce hook we currently feed */
! 223:
! 224: /* Hic sunt protocol-specific data */
! 225: };
! 226:
! 227: struct proto_spec {
! 228: void *ptr;
! 229: int patt;
! 230: };
! 231:
! 232:
! 233: #define PDS_DISABLE 1 /* Proto disable scheduled */
! 234: #define PDS_RESTART 2 /* Proto restart scheduled */
! 235:
! 236: #define PDC_CF_REMOVE 0x01 /* Removed in new config */
! 237: #define PDC_CF_DISABLE 0x02 /* Disabled in new config */
! 238: #define PDC_CF_RESTART 0x03 /* Restart due to reconfiguration */
! 239: #define PDC_CMD_DISABLE 0x11 /* Result of disable command */
! 240: #define PDC_CMD_RESTART 0x12 /* Result of restart command */
! 241: #define PDC_CMD_SHUTDOWN 0x13 /* Result of global shutdown */
! 242: #define PDC_RX_LIMIT_HIT 0x21 /* Route receive limit reached */
! 243: #define PDC_IN_LIMIT_HIT 0x22 /* Route import limit reached */
! 244: #define PDC_OUT_LIMIT_HIT 0x23 /* Route export limit reached */
! 245:
! 246:
! 247: void *proto_new(struct proto_config *, unsigned size);
! 248: void *proto_config_new(struct protocol *, int class);
! 249: void proto_copy_config(struct proto_config *dest, struct proto_config *src);
! 250: void proto_request_feeding(struct proto *p);
! 251:
! 252: static inline void
! 253: proto_copy_rest(struct proto_config *dest, struct proto_config *src, unsigned size)
! 254: { memcpy(dest + 1, src + 1, size - sizeof(struct proto_config)); }
! 255:
! 256: void graceful_restart_recovery(void);
! 257: void graceful_restart_init(void);
! 258: void graceful_restart_show_status(void);
! 259: void proto_graceful_restart_lock(struct proto *p);
! 260: void proto_graceful_restart_unlock(struct proto *p);
! 261:
! 262: #define DEFAULT_GR_WAIT 240
! 263:
! 264: void proto_show_limit(struct proto_limit *l, const char *dsc);
! 265: void proto_show_basic_info(struct proto *p);
! 266:
! 267: void proto_cmd_show(struct proto *, uint, int);
! 268: void proto_cmd_disable(struct proto *, uint, int);
! 269: void proto_cmd_enable(struct proto *, uint, int);
! 270: void proto_cmd_restart(struct proto *, uint, int);
! 271: void proto_cmd_reload(struct proto *, uint, int);
! 272: void proto_cmd_debug(struct proto *, uint, int);
! 273: void proto_cmd_mrtdump(struct proto *, uint, int);
! 274:
! 275: void proto_apply_cmd(struct proto_spec ps, void (* cmd)(struct proto *, uint, int), int restricted, uint arg);
! 276: struct proto *proto_get_named(struct symbol *, struct protocol *);
! 277:
! 278: #define CMD_RELOAD 0
! 279: #define CMD_RELOAD_IN 1
! 280: #define CMD_RELOAD_OUT 2
! 281:
! 282: static inline u32
! 283: proto_get_router_id(struct proto_config *pc)
! 284: {
! 285: return pc->router_id ? pc->router_id : pc->global->router_id;
! 286: }
! 287:
! 288: extern list active_proto_list;
! 289:
! 290: /*
! 291: * Each protocol instance runs two different state machines:
! 292: *
! 293: * [P] The protocol machine: (implemented inside protocol)
! 294: *
! 295: * DOWN ----> START
! 296: * ^ |
! 297: * | V
! 298: * STOP <---- UP
! 299: *
! 300: * States: DOWN Protocol is down and it's waiting for the core
! 301: * requesting protocol start.
! 302: * START Protocol is waiting for connection with the rest
! 303: * of the network and it's not willing to accept
! 304: * packets. When it connects, it goes to UP state.
! 305: * UP Protocol is up and running. When the network
! 306: * connection breaks down or the core requests
! 307: * protocol to be terminated, it goes to STOP state.
! 308: * STOP Protocol is disconnecting from the network.
! 309: * After it disconnects, it returns to DOWN state.
! 310: *
! 311: * In: start() Called in DOWN state to request protocol startup.
! 312: * Returns new state: either UP or START (in this
! 313: * case, the protocol will notify the core when it
! 314: * finally comes UP).
! 315: * stop() Called in START, UP or STOP state to request
! 316: * protocol shutdown. Returns new state: either
! 317: * DOWN or STOP (in this case, the protocol will
! 318: * notify the core when it finally comes DOWN).
! 319: *
! 320: * Out: proto_notify_state() -- called by protocol instance when
! 321: * it does any state transition not covered by
! 322: * return values of start() and stop(). This includes
! 323: * START->UP (delayed protocol startup), UP->STOP
! 324: * (spontaneous shutdown) and STOP->DOWN (delayed
! 325: * shutdown).
! 326: */
! 327:
! 328: #define PS_DOWN 0
! 329: #define PS_START 1
! 330: #define PS_UP 2
! 331: #define PS_STOP 3
! 332:
! 333: void proto_notify_state(struct proto *p, unsigned state);
! 334:
! 335: /*
! 336: * [F] The feeder machine: (implemented in core routines)
! 337: *
! 338: * HUNGRY ----> FEEDING
! 339: * ^ |
! 340: * | V
! 341: * FLUSHING <---- HAPPY
! 342: *
! 343: * States: HUNGRY Protocol either administratively down (i.e.,
! 344: * disabled by the user) or temporarily down
! 345: * (i.e., [P] is not UP)
! 346: * FEEDING The protocol came up and we're feeding it
! 347: * initial routes. [P] is UP.
! 348: * HAPPY The protocol is up and it's receiving normal
! 349: * routing updates. [P] is UP.
! 350: * FLUSHING The protocol is down and we're removing its
! 351: * routes from the table. [P] is STOP or DOWN.
! 352: *
! 353: * Normal lifecycle of a protocol looks like:
! 354: *
! 355: * HUNGRY/DOWN --> HUNGRY/START --> HUNGRY/UP -->
! 356: * FEEDING/UP --> HAPPY/UP --> FLUSHING/STOP|DOWN -->
! 357: * HUNGRY/STOP|DOWN --> HUNGRY/DOWN
! 358: *
! 359: * Sometimes, protocol might switch from HAPPY/UP to FEEDING/UP
! 360: * if it wants to refeed the routes (for example BGP does so
! 361: * as a result of received ROUTE-REFRESH request).
! 362: */
! 363:
! 364: #define FS_HUNGRY 0
! 365: #define FS_FEEDING 1 /* obsolete */
! 366: #define FS_HAPPY 2
! 367: #define FS_FLUSHING 3
! 368:
! 369:
! 370: #define ES_DOWN 0
! 371: #define ES_FEEDING 1
! 372: #define ES_READY 2
! 373:
! 374:
! 375:
! 376: /*
! 377: * Debugging flags
! 378: */
! 379:
! 380: #define D_STATES 1 /* [core] State transitions */
! 381: #define D_ROUTES 2 /* [core] Routes passed by the filters */
! 382: #define D_FILTERS 4 /* [core] Routes rejected by the filters */
! 383: #define D_IFACES 8 /* [core] Interface events */
! 384: #define D_EVENTS 16 /* Protocol events */
! 385: #define D_PACKETS 32 /* Packets sent/received */
! 386:
! 387: #ifndef PARSER
! 388: #define TRACE(flags, msg, args...) \
! 389: do { if (p->p.debug & flags) log(L_TRACE "%s: " msg, p->p.name , ## args ); } while(0)
! 390: #endif
! 391:
! 392:
! 393: /*
! 394: * MRTDump flags
! 395: */
! 396:
! 397: #define MD_STATES 1 /* Protocol state changes (BGP4MP_MESSAGE_AS4) */
! 398: #define MD_MESSAGES 2 /* Protocol packets (BGP4MP_MESSAGE_AS4) */
! 399:
! 400: /*
! 401: * Known unique protocol instances as referenced by config routines
! 402: */
! 403:
! 404: extern struct proto_config *cf_dev_proto;
! 405:
! 406:
! 407: /*
! 408: * Protocol limits
! 409: */
! 410:
! 411: #define PLD_RX 0 /* Receive limit */
! 412: #define PLD_IN 1 /* Import limit */
! 413: #define PLD_OUT 2 /* Export limit */
! 414: #define PLD_MAX 3
! 415:
! 416: #define PLA_WARN 1 /* Issue log warning */
! 417: #define PLA_BLOCK 2 /* Block new routes */
! 418: #define PLA_RESTART 4 /* Force protocol restart */
! 419: #define PLA_DISABLE 5 /* Shutdown and disable protocol */
! 420:
! 421: #define PLS_INITIAL 0 /* Initial limit state after protocol start */
! 422: #define PLS_ACTIVE 1 /* Limit was hit */
! 423: #define PLS_BLOCKED 2 /* Limit is active and blocking new routes */
! 424:
! 425: struct proto_limit {
! 426: u32 limit; /* Maximum number of prefixes */
! 427: byte action; /* Action to take (PLA_*) */
! 428: byte state; /* State of limit (PLS_*) */
! 429: };
! 430:
! 431: void proto_notify_limit(struct announce_hook *ah, struct proto_limit *l, int dir, u32 rt_count);
! 432: void proto_verify_limits(struct announce_hook *ah);
! 433:
! 434: static inline void
! 435: proto_reset_limit(struct proto_limit *l)
! 436: {
! 437: if (l)
! 438: l->state = PLS_INITIAL;
! 439: }
! 440:
! 441:
! 442: /*
! 443: * Route Announcement Hook
! 444: */
! 445:
! 446: struct announce_hook {
! 447: node n;
! 448: struct rtable *table;
! 449: struct proto *proto;
! 450: struct filter *in_filter; /* Input filter */
! 451: struct filter *out_filter; /* Output filter */
! 452: struct proto_limit *rx_limit; /* Receive limit (for in_keep_filtered) */
! 453: struct proto_limit *in_limit; /* Input limit */
! 454: struct proto_limit *out_limit; /* Output limit */
! 455: struct proto_stats *stats; /* Per-table protocol statistics */
! 456: struct announce_hook *next; /* Next hook for the same protocol */
! 457: int in_keep_filtered; /* Routes rejected in import filter are kept */
! 458: };
! 459:
! 460: struct announce_hook *proto_add_announce_hook(struct proto *p, struct rtable *t, struct proto_stats *stats);
! 461: struct announce_hook *proto_find_announce_hook(struct proto *p, struct rtable *t);
! 462:
! 463: #endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to protocol.h CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / bird / nest