nest/protocol.h

   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   unsigned preference;                  /* Default protocol preference */
  44
  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 */
  59 };
  60
  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);
  67
  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 */
  71
  72 /*
  73  *      Known protocols
  74  */
  75
  76 extern struct protocol
  77   proto_device, proto_radv, proto_rip, proto_static,
  78   proto_ospf, proto_pipe, proto_bgp, proto_bfd;
  79
  80 /*
  81  *      Routing Protocol Instance
  82  */
  83
  84 struct proto_config {
  85   node n;
  86   struct config *global;                /* Global configuration data */
  87   struct protocol *protocol;            /* Protocol */
  88   struct proto *proto;                  /* Instance we've created */
  89   char *name;
  90   char *dsc;
  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 */
 102
 103   /* Check proto_reconfigure() and proto_copy_config() after changing struct proto_config */
 104
 105   /* Protocol-specific data follow... */
 106 };
 107
 108 /* Protocol statistics */
 109 struct proto_stats {
 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 */
 123
 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 */
 132 };
 133
 134 struct proto {
 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 */
 142
 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 core_goal;                       /* State we want to reach (FS_*, see below) */
 152   byte reconfiguring;                   /* We're shutting down due to reconfiguration */
 153   byte refeeding;                       /* We are refeeding (valid only if core_state == FS_FEEDING) */
 154   byte flushing;                        /* Protocol is flushed in current flush loop round */
 155   byte down_sched;                      /* Shutdown is scheduled for later (PDS_*) */
 156   byte down_code;                       /* Reason for shutdown (PDC_* codes) */
 157   u32 hash_key;                         /* Random key used for hashing of neighbors */
 158   bird_clock_t last_state_change;       /* Time of last state transition */
 159   char *last_state_name_announced;      /* Last state name we've announced to the user */
 160   struct proto_stats stats;             /* Current protocol statistics */
 161
 162   /*
 163    *    General protocol hooks:
 164    *
 165    *       if_notify    Notify protocol about interface state changes.
 166    *       ifa_notify   Notify protocol about interface address changes.
 167    *       rt_notify    Notify protocol about routing table updates.
 168    *       neigh_notify Notify protocol about neighbor cache events.
 169    *       make_tmp_attrs  Construct ea_list from private attrs stored in rte.
 170    *       store_tmp_attrs Store private attrs back to the rte.
 171    *       import_control  Called as the first step of the route importing process.
 172    *                    It can construct a new rte, add private attributes and
 173    *                    decide whether the route shall be imported: 1=yes, -1=no,
 174    *                    0=process it through the import filter set by the user.
 175    *       reload_routes   Request protocol to reload all its routes to the core
 176    *                    (using rte_update()). Returns: 0=reload cannot be done,
 177    *                    1= reload is scheduled and will happen (asynchronously).
 178    */
 179
 180   void (*if_notify)(struct proto *, unsigned flags, struct iface *i);
 181   void (*ifa_notify)(struct proto *, unsigned flags, struct ifa *a);
 182   void (*rt_notify)(struct proto *, struct rtable *table, struct network *net, struct rte *new, struct rte *old, struct ea_list *attrs);
 183   void (*neigh_notify)(struct neighbor *neigh);
 184   struct ea_list *(*make_tmp_attrs)(struct rte *rt, struct linpool *pool);
 185   void (*store_tmp_attrs)(struct rte *rt, struct ea_list *attrs);
 186   int (*import_control)(struct proto *, struct rte **rt, struct ea_list **attrs, struct linpool *pool);
 187   int (*reload_routes)(struct proto *);
 188
 189   /*
 190    *    Routing entry hooks (called only for routes belonging to this protocol):
 191    *
 192    *       rte_recalculate Called at the beginning of the best route selection
 193    *       rte_better   Compare two rte's and decide which one is better (1=first, 0=second).
 194    *       rte_same     Compare two rte's and decide whether they are identical (1=yes, 0=no).
 195    *       rte_insert   Called whenever a rte is inserted to a routing table.
 196    *       rte_remove   Called whenever a rte is removed from the routing table.
 197    */
 198
 199   int (*rte_recalculate)(struct rtable *, struct network *, struct rte *, struct rte *, struct rte *);
 200   int (*rte_better)(struct rte *, struct rte *);
 201   int (*rte_same)(struct rte *, struct rte *);
 202   void (*rte_insert)(struct network *, struct rte *);
 203   void (*rte_remove)(struct network *, struct rte *);
 204
 205   struct rtable *table;                 /* Our primary routing table */
 206   struct rte_src *main_source;          /* Primary route source */
 207   struct announce_hook *main_ahook;     /* Primary announcement hook */
 208   struct announce_hook *ahooks;         /* Announcement hooks for this protocol */
 209
 210   struct fib_iterator *feed_iterator;   /* Routing table iterator used during protocol feeding */
 211   struct announce_hook *feed_ahook;     /* Announce hook we currently feed */
 212
 213   /* Hic sunt protocol-specific data */
 214 };
 215
 216 struct proto_spec {
 217   void *ptr;
 218   int patt;
 219 };
 220
 221
 222 #define PDS_DISABLE             1       /* Proto disable scheduled */
 223 #define PDS_RESTART             2       /* Proto restart scheduled */
 224
 225 #define PDC_CF_REMOVE           0x01    /* Removed in new config */
 226 #define PDC_CF_DISABLE          0x02    /* Disabled in new config */
 227 #define PDC_CF_RESTART          0x03    /* Restart due to reconfiguration */
 228 #define PDC_CMD_DISABLE         0x11    /* Result of disable command */
 229 #define PDC_CMD_RESTART         0x12    /* Result of restart command */
 230 #define PDC_CMD_SHUTDOWN        0x13    /* Result of global shutdown */
 231 #define PDC_RX_LIMIT_HIT        0x21    /* Route receive limit reached */
 232 #define PDC_IN_LIMIT_HIT        0x22    /* Route import limit reached */
 233 #define PDC_OUT_LIMIT_HIT       0x23    /* Route export limit reached */
 234
 235
 236 void *proto_new(struct proto_config *, unsigned size);
 237 void *proto_config_new(struct protocol *, unsigned size, int class);
 238 void proto_copy_config(struct proto_config *dest, struct proto_config *src);
 239 void proto_request_feeding(struct proto *p);
 240
 241 static inline void
 242 proto_copy_rest(struct proto_config *dest, struct proto_config *src, unsigned size)
 243 { memcpy(dest + 1, src + 1, size - sizeof(struct proto_config)); }
 244
 245
 246 void proto_show_limit(struct proto_limit *l, const char *dsc);
 247 void proto_show_basic_info(struct proto *p);
 248
 249 void proto_cmd_show(struct proto *, unsigned int, int);
 250 void proto_cmd_disable(struct proto *, unsigned int, int);
 251 void proto_cmd_enable(struct proto *, unsigned int, int);
 252 void proto_cmd_restart(struct proto *, unsigned int, int);
 253 void proto_cmd_reload(struct proto *, unsigned int, int);
 254 void proto_cmd_debug(struct proto *, unsigned int, int);
 255 void proto_cmd_mrtdump(struct proto *, unsigned int, int);
 256
 257 void proto_apply_cmd(struct proto_spec ps, void (* cmd)(struct proto *, unsigned int, int), int restricted, unsigned int arg);
 258 struct proto *proto_get_named(struct symbol *, struct protocol *);
 259
 260 #define CMD_RELOAD      0
 261 #define CMD_RELOAD_IN   1
 262 #define CMD_RELOAD_OUT  2
 263
 264 static inline u32
 265 proto_get_router_id(struct proto_config *pc)
 266 {
 267   return pc->router_id ? pc->router_id : pc->global->router_id;
 268 }
 269
 270 extern list active_proto_list;
 271
 272 /*
 273  *  Each protocol instance runs two different state machines:
 274  *
 275  *  [P] The protocol machine: (implemented inside protocol)
 276  *
 277  *              DOWN    ---->    START
 278  *                ^                |
 279  *                |                V
 280  *              STOP    <----     UP
 281  *
 282  *      States: DOWN    Protocol is down and it's waiting for the core
 283  *                      requesting protocol start.
 284  *              START   Protocol is waiting for connection with the rest
 285  *                      of the network and it's not willing to accept
 286  *                      packets. When it connects, it goes to UP state.
 287  *              UP      Protocol is up and running. When the network
 288  *                      connection breaks down or the core requests
 289  *                      protocol to be terminated, it goes to STOP state.
 290  *              STOP    Protocol is disconnecting from the network.
 291  *                      After it disconnects, it returns to DOWN state.
 292  *
 293  *      In:     start() Called in DOWN state to request protocol startup.
 294  *                      Returns new state: either UP or START (in this
 295  *                      case, the protocol will notify the core when it
 296  *                      finally comes UP).
 297  *              stop()  Called in START, UP or STOP state to request
 298  *                      protocol shutdown. Returns new state: either
 299  *                      DOWN or STOP (in this case, the protocol will
 300  *                      notify the core when it finally comes DOWN).
 301  *
 302  *      Out:    proto_notify_state() -- called by protocol instance when
 303  *                      it does any state transition not covered by
 304  *                      return values of start() and stop(). This includes
 305  *                      START->UP (delayed protocol startup), UP->STOP
 306  *                      (spontaneous shutdown) and STOP->DOWN (delayed
 307  *                      shutdown).
 308  */
 309
 310 #define PS_DOWN 0
 311 #define PS_START 1
 312 #define PS_UP 2
 313 #define PS_STOP 3
 314
 315 void proto_notify_state(struct proto *p, unsigned state);
 316
 317 /*
 318  *  [F] The feeder machine: (implemented in core routines)
 319  *
 320  *              HUNGRY    ---->   FEEDING
 321  *               ^                   |
 322  *               |                   V
 323  *              FLUSHING  <----   HAPPY
 324  *
 325  *      States: HUNGRY  Protocol either administratively down (i.e.,
 326  *                      disabled by the user) or temporarily down
 327  *                      (i.e., [P] is not UP)
 328  *              FEEDING The protocol came up and we're feeding it
 329  *                      initial routes. [P] is UP.
 330  *              HAPPY   The protocol is up and it's receiving normal
 331  *                      routing updates. [P] is UP.
 332  *              FLUSHING The protocol is down and we're removing its
 333  *                      routes from the table. [P] is STOP or DOWN.
 334  *
 335  *      Normal lifecycle of a protocol looks like:
 336  *
 337  *              HUNGRY/DOWN --> HUNGRY/START --> HUNGRY/UP -->
 338  *              FEEDING/UP --> HAPPY/UP --> FLUSHING/STOP|DOWN -->
 339  *              HUNGRY/STOP|DOWN --> HUNGRY/DOWN
 340  *
 341  *      Sometimes, protocol might switch from HAPPY/UP to FEEDING/UP
 342  *      if it wants to refeed the routes (for example BGP does so
 343  *      as a result of received ROUTE-REFRESH request).
 344  */
 345
 346 #define FS_HUNGRY 0
 347 #define FS_FEEDING 1
 348 #define FS_HAPPY 2
 349 #define FS_FLUSHING 3
 350
 351 /*
 352  *      Debugging flags
 353  */
 354
 355 #define D_STATES 1              /* [core] State transitions */
 356 #define D_ROUTES 2              /* [core] Routes passed by the filters */
 357 #define D_FILTERS 4             /* [core] Routes rejected by the filters */
 358 #define D_IFACES 8              /* [core] Interface events */
 359 #define D_EVENTS 16             /* Protocol events */
 360 #define D_PACKETS 32            /* Packets sent/received */
 361
 362 #ifndef PARSER
 363 #define TRACE(flags, msg, args...) \
 364   do { if (p->p.debug & flags) log(L_TRACE "%s: " msg, p->p.name , ## args ); } while(0)
 365 #endif
 366
 367
 368 /*
 369  *      MRTDump flags
 370  */
 371
 372 #define MD_STATES       1               /* Protocol state changes (BGP4MP_MESSAGE_AS4) */
 373 #define MD_MESSAGES     2               /* Protocol packets (BGP4MP_MESSAGE_AS4) */
 374
 375 /*
 376  *      Known unique protocol instances as referenced by config routines
 377  */
 378
 379 extern struct proto_config *cf_dev_proto;
 380
 381
 382 /*
 383  * Protocol limits
 384  */
 385
 386 #define PLD_RX          0       /* Receive limit */
 387 #define PLD_IN          1       /* Import limit */
 388 #define PLD_OUT         2       /* Export limit */
 389 #define PLD_MAX         3
 390
 391 #define PLA_WARN        1       /* Issue log warning */
 392 #define PLA_BLOCK       2       /* Block new routes */
 393 #define PLA_RESTART     4       /* Force protocol restart */
 394 #define PLA_DISABLE     5       /* Shutdown and disable protocol */
 395
 396 #define PLS_INITIAL     0       /* Initial limit state after protocol start */
 397 #define PLS_ACTIVE      1       /* Limit was hit */
 398 #define PLS_BLOCKED     2       /* Limit is active and blocking new routes */
 399
 400 struct proto_limit {
 401   u32 limit;                    /* Maximum number of prefixes */
 402   byte action;                  /* Action to take (PLA_*) */
 403   byte state;                   /* State of limit (PLS_*) */
 404 };
 405
 406 void proto_notify_limit(struct announce_hook *ah, struct proto_limit *l, int dir, u32 rt_count);
 407
 408 static inline void
 409 proto_reset_limit(struct proto_limit *l)
 410 {
 411   if (l)
 412     l->state = PLS_INITIAL;
 413 }
 414
 415
 416 /*
 417  *      Route Announcement Hook
 418  */
 419
 420 struct announce_hook {
 421   node n;
 422   struct rtable *table;
 423   struct proto *proto;
 424   struct filter *in_filter;             /* Input filter */
 425   struct filter *out_filter;            /* Output filter */
 426   struct proto_limit *rx_limit;         /* Receive limit (for in_keep_filtered) */
 427   struct proto_limit *in_limit;         /* Input limit */
 428   struct proto_limit *out_limit;        /* Output limit */
 429   struct proto_stats *stats;            /* Per-table protocol statistics */
 430   struct announce_hook *next;           /* Next hook for the same protocol */
 431   int in_keep_filtered;                 /* Routes rejected in import filter are kept */
 432 };
 433
 434 struct announce_hook *proto_add_announce_hook(struct proto *p, struct rtable *t, struct proto_stats *stats);
 435 struct announce_hook *proto_find_announce_hook(struct proto *p, struct rtable *t);
 436
 437 #endif