bgpd/bgp_route.h

   1 /* BGP routing information base
   2    Copyright (C) 1996, 97, 98, 2000 Kunihiro Ishiguro
   3
   4 This file is part of GNU Zebra.
   5
   6 GNU Zebra is free software; you can redistribute it and/or modify it
   7 under the terms of the GNU General Public License as published by the
   8 Free Software Foundation; either version 2, or (at your option) any
   9 later version.
  10
  11 GNU Zebra is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Zebra; see the file COPYING.  If not, write to the Free
  18 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  19 02111-1307, USA.  */
  20
  21 #ifndef _QUAGGA_BGP_ROUTE_H
  22 #define _QUAGGA_BGP_ROUTE_H
  23
  24 #include "queue.h"
  25 #include "bgp_table.h"
  26
  27 struct bgp_nexthop_cache;
  28
  29 #define BGP_SHOW_SCODE_HEADER "Status codes: s suppressed, d damped, "\
  30                               "h history, * valid, > best, = multipath,%s"\
  31                 "              i internal, r RIB-failure, S Stale, R Removed%s"
  32 #define BGP_SHOW_OCODE_HEADER "Origin codes: i - IGP, e - EGP, ? - incomplete%s%s"
  33 #define BGP_SHOW_HEADER "   Network          Next Hop            Metric LocPrf Weight Path%s"
  34
  35 /* Ancillary information to struct bgp_info,
  36  * used for uncommonly used data (aggregation, MPLS, etc.)
  37  * and lazily allocated to save memory.
  38  */
  39 struct bgp_info_extra
  40 {
  41   /* Pointer to dampening structure.  */
  42   struct bgp_damp_info *damp_info;
  43
  44   /* This route is suppressed with aggregation.  */
  45   int suppress;
  46
  47   /* Nexthop reachability check.  */
  48   u_int32_t igpmetric;
  49
  50   /* MPLS label.  */
  51   u_char tag[3];
  52 };
  53
  54 struct bgp_info
  55 {
  56   /* For linked list. */
  57   struct bgp_info *next;
  58   struct bgp_info *prev;
  59
  60   /* For nexthop linked list */
  61   LIST_ENTRY(bgp_info) nh_thread;
  62
  63   /* Back pointer to the prefix node */
  64   struct bgp_node *net;
  65
  66   /* Back pointer to the nexthop structure */
  67   struct bgp_nexthop_cache *nexthop;
  68
  69   /* Peer structure.  */
  70   struct peer *peer;
  71
  72   /* Attribute structure.  */
  73   struct attr *attr;
  74
  75   /* Extra information */
  76   struct bgp_info_extra *extra;
  77
  78
  79   /* Multipath information */
  80   struct bgp_info_mpath *mpath;
  81
  82   /* Uptime.  */
  83   time_t uptime;
  84
  85   /* reference count */
  86   int lock;
  87
  88   /* BGP information status.  */
  89   u_int16_t flags;
  90 #define BGP_INFO_IGP_CHANGED    (1 << 0)
  91 #define BGP_INFO_DAMPED         (1 << 1)
  92 #define BGP_INFO_HISTORY        (1 << 2)
  93 #define BGP_INFO_SELECTED       (1 << 3)
  94 #define BGP_INFO_VALID          (1 << 4)
  95 #define BGP_INFO_ATTR_CHANGED   (1 << 5)
  96 #define BGP_INFO_DMED_CHECK     (1 << 6)
  97 #define BGP_INFO_DMED_SELECTED  (1 << 7)
  98 #define BGP_INFO_STALE          (1 << 8)
  99 #define BGP_INFO_REMOVED        (1 << 9)
 100 #define BGP_INFO_COUNTED        (1 << 10)
 101 #define BGP_INFO_MULTIPATH      (1 << 11)
 102 #define BGP_INFO_MULTIPATH_CHG  (1 << 12)
 103
 104   /* BGP route type.  This can be static, RIP, OSPF, BGP etc.  */
 105   u_char type;
 106
 107   /* When above type is BGP.  This sub type specify BGP sub type
 108      information.  */
 109   u_char sub_type;
 110 #define BGP_ROUTE_NORMAL       0
 111 #define BGP_ROUTE_STATIC       1
 112 #define BGP_ROUTE_AGGREGATE    2
 113 #define BGP_ROUTE_REDISTRIBUTE 3
 114
 115   u_short instance;
 116
 117   /* Addpath identifiers */
 118   u_int32_t addpath_rx_id;
 119   u_int32_t addpath_tx_id;
 120
 121 };
 122
 123 /* BGP static route configuration. */
 124 struct bgp_static
 125 {
 126   /* Backdoor configuration.  */
 127   int backdoor;
 128
 129   /* Import check status.  */
 130   u_char valid;
 131
 132   /* IGP metric. */
 133   u_int32_t igpmetric;
 134
 135   /* IGP nexthop. */
 136   struct in_addr igpnexthop;
 137
 138   /* Atomic set reference count (ie cause of pathlimit) */
 139   u_int32_t atomic;
 140
 141   /* BGP redistribute route-map.  */
 142   struct
 143   {
 144     char *name;
 145     struct route_map *map;
 146   } rmap;
 147
 148   /* Route Distinguisher */
 149   struct prefix_rd     prd;
 150
 151   /* MPLS label.  */
 152   u_char tag[3];
 153 };
 154
 155 #define BGP_ATTR_NEXTHOP_AFI_IP6(attr) \
 156   (! CHECK_FLAG (attr->flag, ATTR_FLAG_BIT (BGP_ATTR_NEXT_HOP)) && \
 157    (attr)->extra && ((attr)->extra->mp_nexthop_len == 16 || \
 158     (attr)->extra->mp_nexthop_len == 32))
 159 #define BGP_INFO_COUNTABLE(BI) \
 160   (! CHECK_FLAG ((BI)->flags, BGP_INFO_HISTORY) \
 161    && ! CHECK_FLAG ((BI)->flags, BGP_INFO_REMOVED))
 162
 163 /* Flags which indicate a route is unuseable in some form */
 164 #define BGP_INFO_UNUSEABLE \
 165   (BGP_INFO_HISTORY|BGP_INFO_DAMPED|BGP_INFO_REMOVED)
 166 /* Macro to check BGP information is alive or not.  Sadly,
 167  * not equivalent to just checking previous, because of the
 168  * sense of the additional VALID flag.
 169  */
 170 #define BGP_INFO_HOLDDOWN(BI) \
 171   (! CHECK_FLAG ((BI)->flags, BGP_INFO_VALID) \
 172    || CHECK_FLAG ((BI)->flags, BGP_INFO_UNUSEABLE))
 173
 174 #define DISTRIBUTE_IN_NAME(F)   ((F)->dlist[FILTER_IN].name)
 175 #define DISTRIBUTE_IN(F)        ((F)->dlist[FILTER_IN].alist)
 176 #define DISTRIBUTE_OUT_NAME(F)  ((F)->dlist[FILTER_OUT].name)
 177 #define DISTRIBUTE_OUT(F)       ((F)->dlist[FILTER_OUT].alist)
 178
 179 #define PREFIX_LIST_IN_NAME(F)  ((F)->plist[FILTER_IN].name)
 180 #define PREFIX_LIST_IN(F)       ((F)->plist[FILTER_IN].plist)
 181 #define PREFIX_LIST_OUT_NAME(F) ((F)->plist[FILTER_OUT].name)
 182 #define PREFIX_LIST_OUT(F)      ((F)->plist[FILTER_OUT].plist)
 183
 184 #define FILTER_LIST_IN_NAME(F)  ((F)->aslist[FILTER_IN].name)
 185 #define FILTER_LIST_IN(F)       ((F)->aslist[FILTER_IN].aslist)
 186 #define FILTER_LIST_OUT_NAME(F) ((F)->aslist[FILTER_OUT].name)
 187 #define FILTER_LIST_OUT(F)      ((F)->aslist[FILTER_OUT].aslist)
 188
 189 #define ROUTE_MAP_IN_NAME(F)    ((F)->map[RMAP_IN].name)
 190 #define ROUTE_MAP_IN(F)         ((F)->map[RMAP_IN].map)
 191 #define ROUTE_MAP_OUT_NAME(F)   ((F)->map[RMAP_OUT].name)
 192 #define ROUTE_MAP_OUT(F)        ((F)->map[RMAP_OUT].map)
 193
 194 #define UNSUPPRESS_MAP_NAME(F)  ((F)->usmap.name)
 195 #define UNSUPPRESS_MAP(F)       ((F)->usmap.map)
 196
 197 /* path PREFIX (addpath rxid NUMBER) */
 198 #define PATH_ADDPATH_STR_BUFFER PREFIX2STR_BUFFER + 32
 199
 200 enum bgp_path_type
 201 {
 202   BGP_PATH_ALL,
 203   BGP_PATH_BESTPATH,
 204   BGP_PATH_MULTIPATH
 205 };
 206
 207 static inline void
 208 bgp_bump_version (struct bgp_node *node)
 209 {
 210   node->version = bgp_table_next_version(bgp_node_table(node));
 211 }
 212
 213 /* Prototypes. */
 214 extern void bgp_process_queue_init (void);
 215 extern void bgp_route_init (void);
 216 extern void bgp_route_finish (void);
 217 extern void bgp_cleanup_routes (void);
 218 extern void bgp_announce_route (struct peer *, afi_t, safi_t);
 219 extern void bgp_stop_announce_route_timer(struct peer_af *paf);
 220 extern void bgp_announce_route_all (struct peer *);
 221 extern void bgp_default_originate (struct peer *, afi_t, safi_t, int);
 222 extern void bgp_soft_reconfig_in (struct peer *, afi_t, safi_t);
 223 extern void bgp_clear_route (struct peer *, afi_t, safi_t);
 224 extern void bgp_clear_route_all (struct peer *);
 225 extern void bgp_clear_adj_in (struct peer *, afi_t, safi_t);
 226 extern void bgp_clear_stale_route (struct peer *, afi_t, safi_t);
 227
 228 extern struct bgp_node *bgp_afi_node_get (struct bgp_table *table, afi_t afi,
 229                                           safi_t safi, struct prefix *p,
 230                                           struct prefix_rd *prd);
 231 extern struct bgp_info *bgp_info_lock (struct bgp_info *);
 232 extern struct bgp_info *bgp_info_unlock (struct bgp_info *);
 233 extern void bgp_info_add (struct bgp_node *rn, struct bgp_info *ri);
 234 extern void bgp_info_delete (struct bgp_node *rn, struct bgp_info *ri);
 235 extern struct bgp_info_extra *bgp_info_extra_get (struct bgp_info *);
 236 extern void bgp_info_set_flag (struct bgp_node *, struct bgp_info *, u_int32_t);
 237 extern void bgp_info_unset_flag (struct bgp_node *, struct bgp_info *, u_int32_t);
 238 extern void bgp_info_path_with_addpath_rx_str (struct bgp_info *ri, char *buf);
 239
 240 extern int bgp_nlri_sanity_check (struct peer *, int, safi_t, u_char *, bgp_size_t, int *);
 241 extern int bgp_nlri_parse (struct peer *, struct attr *, struct bgp_nlri *);
 242
 243 extern int bgp_maximum_prefix_overflow (struct peer *, afi_t, safi_t, int);
 244
 245 extern void bgp_redistribute_add (struct bgp *, struct prefix *, const struct in_addr *,
 246                                   const struct in6_addr *, unsigned int ifindex,
 247                                   u_int32_t, u_char, u_short, u_short);
 248 extern void bgp_redistribute_delete (struct bgp *, struct prefix *, u_char, u_short);
 249 extern void bgp_redistribute_withdraw (struct bgp *, afi_t, int, u_short);
 250
 251 extern void bgp_static_add (struct bgp *);
 252 extern void bgp_static_delete (struct bgp *);
 253 extern void bgp_static_redo_import_check (struct bgp *);
 254 extern void bgp_purge_static_redist_routes (struct bgp *bgp);
 255 extern void bgp_static_update (struct bgp *, struct prefix *, struct bgp_static *,
 256                         afi_t, safi_t);
 257 extern void bgp_static_withdraw (struct bgp *, struct prefix *, afi_t, safi_t);
 258
 259 extern int bgp_static_set_safi (safi_t safi, struct vty *vty, const char *,
 260                           const char *, const char *, const char *);
 261
 262 extern int bgp_static_unset_safi (safi_t safi, struct vty *, const char *,
 263                             const char *, const char *);
 264
 265 /* this is primarily for MPLS-VPN */
 266 extern int bgp_update (struct peer *, struct prefix *, u_int32_t, struct attr *,
 267                        afi_t, safi_t, int, int, struct prefix_rd *,
 268                        u_char *, int);
 269 extern int bgp_withdraw (struct peer *, struct prefix *, u_int32_t, struct attr *,
 270                          afi_t, safi_t, int, int, struct prefix_rd *, u_char *);
 271
 272 /* for bgp_nexthop and bgp_damp */
 273 extern void bgp_process (struct bgp *, struct bgp_node *, afi_t, safi_t);
 274
 275 /*
 276  * Add an end-of-initial-update marker to the process queue. This is just a
 277  * queue element with NULL bgp node.
 278  */
 279 extern void bgp_add_eoiu_mark (struct bgp *);
 280 extern int bgp_config_write_table_map (struct vty *, struct bgp *, afi_t, safi_t,
 281                                        int *);
 282 extern int bgp_config_write_network (struct vty *, struct bgp *, afi_t, safi_t, int *);
 283 extern int bgp_config_write_distance (struct vty *, struct bgp *);
 284
 285 extern void bgp_aggregate_increment (struct bgp *, struct prefix *, struct bgp_info *,
 286                               afi_t, safi_t);
 287 extern void bgp_aggregate_decrement (struct bgp *, struct prefix *, struct bgp_info *,
 288                               afi_t, safi_t);
 289
 290 extern u_char bgp_distance_apply (struct prefix *, struct bgp_info *, struct bgp *);
 291
 292 extern afi_t bgp_node_afi (struct vty *);
 293 extern safi_t bgp_node_safi (struct vty *);
 294
 295 extern void route_vty_out (struct vty *, struct prefix *, struct bgp_info *, int, safi_t, json_object *);
 296 extern void route_vty_out_tag (struct vty *, struct prefix *, struct bgp_info *, int, safi_t, json_object *);
 297 extern void route_vty_out_tmp (struct vty *, struct prefix *, struct attr *, safi_t, u_char, json_object *);
 298
 299 extern int
 300 subgroup_process_announce_selected (struct update_subgroup *subgrp,
 301                                     struct bgp_info *selected,
 302                                     struct bgp_node *rn,
 303                                     u_int32_t addpath_tx_id);
 304
 305 extern int subgroup_announce_check(struct bgp_info *ri,
 306                                    struct update_subgroup *subgrp,
 307                                    struct prefix *p, struct attr *attr);
 308
 309 extern void bgp_peer_clear_node_queue_drain_immediate (struct peer *peer);
 310 extern void bgp_process_queues_drain_immediate (void);
 311
 312 #endif /* _QUAGGA_BGP_ROUTE_H */