]> git.ipfire.org Git - thirdparty/bird.git/blobdiff - nest/protocol.h
Backport some minor changes from int-new
[thirdparty/bird.git] / nest / protocol.h
index cf2ca0a4fd2e22830cab4f226c120028eb6cf950..18dfbd6fb71ff2138fde6ecf3b2156799f1e2504 100644 (file)
@@ -12,6 +12,7 @@
 #include "lib/lists.h"
 #include "lib/resource.h"
 #include "lib/timer.h"
+#include "nest/route.h"
 #include "conf/conf.h"
 
 struct iface;
@@ -40,7 +41,8 @@ struct protocol {
   int name_counter;                    /* Counter for automatic name generation */
   int attr_class;                      /* Attribute class known to this protocol */
   int multitable;                      /* Protocol handles all announce hooks itself */
-  unsigned preference;                 /* Default protocol preference */
+  uint preference;                     /* Default protocol preference */
+  uint config_size;                    /* Size of protocol config */
 
   void (*preconfig)(struct protocol *, struct config *);       /* Just before configuring */
   void (*postconfig)(struct proto_config *);                   /* After configuring each instance */
@@ -75,7 +77,7 @@ void protos_dump_all(void);
 
 extern struct protocol
   proto_device, proto_radv, proto_rip, proto_static,
-  proto_ospf, proto_pipe, proto_bgp;
+  proto_ospf, proto_pipe, proto_bgp, proto_bfd, proto_babel;
 
 /*
  *     Routing Protocol Instance
@@ -93,8 +95,11 @@ struct proto_config {
   unsigned preference, disabled;       /* Generic parameters */
   int in_keep_filtered;                        /* Routes rejected in import filter are kept */
   u32 router_id;                       /* Protocol specific router ID */
+  struct iface *vrf;                   /* Related VRF instance, NULL if global */
   struct rtable_config *table;         /* Table we're attached to */
   struct filter *in_filter, *out_filter; /* Attached filters */
+  struct proto_limit *rx_limit;                /* Limit for receiving routes from protocol
+                                          (relevant when in_keep_filtered is active) */
   struct proto_limit *in_limit;                /* Limit for importing routes from protocol */
   struct proto_limit *out_limit;       /* Limit for exporting routes to protocol */
 
@@ -124,7 +129,7 @@ struct proto_stats {
   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_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 */
 };
@@ -146,12 +151,16 @@ struct proto {
   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 export_state;                   /* Route export state (ES_*, see below) */
   byte reconfiguring;                  /* We're shutting down due to reconfiguration */
-  byte refeeding;                      /* We are refeeding (valid only if core_state == FS_FEEDING) */
+  byte refeeding;                      /* We are refeeding (valid only if export_state == ES_FEEDING) */
   byte flushing;                       /* Protocol is flushed in current flush loop round */
+  byte gr_recovery;                    /* Protocol should participate in graceful restart recovery */
+  byte gr_lock;                                /* Graceful restart mechanism should wait for this proto */
+  byte gr_wait;                                /* Route export to protocol is postponed until graceful restart */
   byte down_sched;                     /* Shutdown is scheduled for later (PDS_*) */
   byte down_code;                      /* Reason for shutdown (PDC_* codes) */
+  byte merge_limit;                    /* Maximal number of nexthops for RA_MERGED */
   u32 hash_key;                                /* Random key used for hashing of neighbors */
   bird_clock_t last_state_change;      /* Time of last state transition */
   char *last_state_name_announced;     /* Last state name we've announced to the user */
@@ -173,6 +182,8 @@ struct proto {
    *      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).
+   *      feed_begin   Notify protocol about beginning of route feeding.
+   *      feed_end     Notify protocol about finish of route feeding.
    */
 
   void (*if_notify)(struct proto *, unsigned flags, struct iface *i);
@@ -183,13 +194,16 @@ struct proto {
   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);
   int (*reload_routes)(struct proto *);
+  void (*feed_begin)(struct proto *, int initial);
+  void (*feed_end)(struct proto *);
 
   /*
-   *   Routing entry hooks (called only for rte's belonging to this protocol):
+   *   Routing entry hooks (called only for routes belonging to this protocol):
    *
-   *      rte_recalculate Called at the beginning of the best route selection  
+   *      rte_recalculate Called at the beginning of the best route selection
    *      rte_better   Compare two rte's and decide which one is better (1=first, 0=second).
    *       rte_same    Compare two rte's and decide whether they are identical (1=yes, 0=no).
+   *       rte_mergable        Compare two rte's and decide whether they could be merged (1=yes, 0=no).
    *      rte_insert   Called whenever a rte is inserted to a routing table.
    *      rte_remove   Called whenever a rte is removed from the routing table.
    */
@@ -197,10 +211,13 @@ struct proto {
   int (*rte_recalculate)(struct rtable *, struct network *, struct rte *, struct rte *, struct rte *);
   int (*rte_better)(struct rte *, struct rte *);
   int (*rte_same)(struct rte *, struct rte *);
+  int (*rte_mergable)(struct rte *, struct rte *);
   void (*rte_insert)(struct network *, struct rte *);
   void (*rte_remove)(struct network *, struct rte *);
 
+  struct iface *vrf;                   /* Related VRF instance, NULL if global */
   struct rtable *table;                        /* Our primary routing table */
+  struct rte_src *main_source;         /* Primary route source */
   struct announce_hook *main_ahook;    /* Primary announcement hook */
   struct announce_hook *ahooks;                /* Announcement hooks for this protocol */
 
@@ -225,12 +242,13 @@ struct proto_spec {
 #define PDC_CMD_DISABLE                0x11    /* Result of disable command */
 #define PDC_CMD_RESTART                0x12    /* Result of restart command */
 #define PDC_CMD_SHUTDOWN       0x13    /* Result of global shutdown */
-#define PDC_IN_LIMIT_HIT       0x21    /* Route import limit reached */
-#define PDC_OUT_LIMIT_HIT      0x22    /* Route export limit reached */
+#define PDC_RX_LIMIT_HIT       0x21    /* Route receive limit reached */
+#define PDC_IN_LIMIT_HIT       0x22    /* Route import limit reached */
+#define PDC_OUT_LIMIT_HIT      0x23    /* Route export limit reached */
 
 
 void *proto_new(struct proto_config *, unsigned size);
-void *proto_config_new(struct protocol *, unsigned size, int class);
+void *proto_config_new(struct protocol *, int class);
 void proto_copy_config(struct proto_config *dest, struct proto_config *src);
 void proto_request_feeding(struct proto *p);
 
@@ -238,19 +256,26 @@ 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)); }
 
+void graceful_restart_recovery(void);
+void graceful_restart_init(void);
+void graceful_restart_show_status(void);
+void proto_graceful_restart_lock(struct proto *p);
+void proto_graceful_restart_unlock(struct proto *p);
+
+#define DEFAULT_GR_WAIT        240
 
 void proto_show_limit(struct proto_limit *l, const char *dsc);
 void proto_show_basic_info(struct proto *p);
 
-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);
+void proto_cmd_show(struct proto *, uint, int);
+void proto_cmd_disable(struct proto *, uint, int);
+void proto_cmd_enable(struct proto *, uint, int);
+void proto_cmd_restart(struct proto *, uint, int);
+void proto_cmd_reload(struct proto *, uint, int);
+void proto_cmd_debug(struct proto *, uint, int);
+void proto_cmd_mrtdump(struct proto *, uint, int);
 
-void proto_apply_cmd(struct proto_spec ps, void (* cmd)(struct proto *, unsigned int, int), int restricted, unsigned int arg);
+void proto_apply_cmd(struct proto_spec ps, void (* cmd)(struct proto *, uint, int), int restricted, uint arg);
 struct proto *proto_get_named(struct symbol *, struct protocol *);
 
 #define CMD_RELOAD     0
@@ -263,6 +288,17 @@ proto_get_router_id(struct proto_config *pc)
   return pc->router_id ? pc->router_id : pc->global->router_id;
 }
 
+static inline struct ea_list *
+rte_make_tmp_attrs(struct rte *rt, struct linpool *pool)
+{
+  struct ea_list *(*mta)(struct rte *rt, struct linpool *pool);
+  mta = rt->attrs->src->proto->make_tmp_attrs;
+  return mta ? mta(rt, pool) : NULL;
+}
+
+/* Moved from route.h to avoid dependency conflicts */
+static inline void rte_update(struct proto *p, net *net, rte *new) { rte_update2(p->main_ahook, net, new, p->main_source); }
+
 extern list active_proto_list;
 
 /*
@@ -334,15 +370,22 @@ void proto_notify_state(struct proto *p, unsigned state);
  *             FEEDING/UP --> HAPPY/UP --> FLUSHING/STOP|DOWN -->
  *             HUNGRY/STOP|DOWN --> HUNGRY/DOWN
  *
- *     Sometimes, protocol might switch from HAPPY/UP to FEEDING/UP 
+ *     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).
  */
 
-#define FS_HUNGRY 0
-#define FS_FEEDING 1
-#define FS_HAPPY 2
-#define FS_FLUSHING 3
+#define FS_HUNGRY      0
+#define FS_FEEDING     1       /* obsolete */
+#define FS_HAPPY       2
+#define FS_FLUSHING    3
+
+
+#define ES_DOWN                0
+#define ES_FEEDING     1
+#define ES_READY       2
+
+
 
 /*
  *     Debugging flags
@@ -355,6 +398,12 @@ void proto_notify_state(struct proto *p, unsigned state);
 #define D_EVENTS 16            /* Protocol events */
 #define D_PACKETS 32           /* Packets sent/received */
 
+#ifndef PARSER
+#define TRACE(flags, msg, args...) \
+  do { if (p->p.debug & flags) log(L_TRACE "%s: " msg, p->p.name , ## args ); } while(0)
+#endif
+
+
 /*
  *     MRTDump flags
  */
@@ -373,6 +422,11 @@ extern struct proto_config *cf_dev_proto;
  * Protocol limits
  */
 
+#define PLD_RX         0       /* Receive limit */
+#define PLD_IN         1       /* Import limit */
+#define PLD_OUT                2       /* Export limit */
+#define PLD_MAX                3
+
 #define PLA_WARN       1       /* Issue log warning */
 #define PLA_BLOCK      2       /* Block new routes */
 #define PLA_RESTART    4       /* Force protocol restart */
@@ -388,7 +442,8 @@ struct proto_limit {
   byte state;                  /* State of limit (PLS_*) */
 };
 
-void proto_notify_limit(struct announce_hook *ah, struct proto_limit *l, u32 rt_count);
+void proto_notify_limit(struct announce_hook *ah, struct proto_limit *l, int dir, u32 rt_count);
+void proto_verify_limits(struct announce_hook *ah);
 
 static inline void
 proto_reset_limit(struct proto_limit *l)
@@ -397,7 +452,7 @@ proto_reset_limit(struct proto_limit *l)
     l->state = PLS_INITIAL;
 }
 
+
 /*
  *     Route Announcement Hook
  */
@@ -408,6 +463,7 @@ struct announce_hook {
   struct proto *proto;
   struct filter *in_filter;            /* Input filter */
   struct filter *out_filter;           /* Output filter */
+  struct proto_limit *rx_limit;                /* Receive limit (for in_keep_filtered) */
   struct proto_limit *in_limit;                /* Input limit */
   struct proto_limit *out_limit;       /* Output limit */
   struct proto_stats *stats;           /* Per-table protocol statistics */