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 struct bgp_route_evpn;
  29
  30 enum bgp_show_type
  31 {
  32   bgp_show_type_normal,
  33   bgp_show_type_regexp,
  34   bgp_show_type_prefix_list,
  35   bgp_show_type_filter_list,
  36   bgp_show_type_route_map,
  37   bgp_show_type_neighbor,
  38   bgp_show_type_cidr_only,
  39   bgp_show_type_prefix_longer,
  40   bgp_show_type_community_all,
  41   bgp_show_type_community,
  42   bgp_show_type_community_exact,
  43   bgp_show_type_community_list,
  44   bgp_show_type_community_list_exact,
  45   bgp_show_type_lcommunity_all,
  46   bgp_show_type_lcommunity,
  47   bgp_show_type_lcommunity_list,
  48   bgp_show_type_flap_statistics,
  49   bgp_show_type_flap_neighbor,
  50   bgp_show_type_dampend_paths,
  51   bgp_show_type_damp_neighbor
  52 };
  53
  54
  55 #define BGP_SHOW_SCODE_HEADER "Status codes: s suppressed, d damped, "\
  56                               "h history, * valid, > best, = multipath,%s"\
  57                 "              i internal, r RIB-failure, S Stale, R Removed%s"
  58 #define BGP_SHOW_OCODE_HEADER "Origin codes: i - IGP, e - EGP, ? - incomplete%s%s"
  59 #define BGP_SHOW_HEADER "   Network          Next Hop            Metric LocPrf Weight Path%s"
  60
  61 /* Ancillary information to struct bgp_info,
  62  * used for uncommonly used data (aggregation, MPLS, etc.)
  63  * and lazily allocated to save memory.
  64  */
  65 struct bgp_info_extra
  66 {
  67   /* Pointer to dampening structure.  */
  68   struct bgp_damp_info *damp_info;
  69
  70   /* This route is suppressed with aggregation.  */
  71   int suppress;
  72
  73   /* Nexthop reachability check.  */
  74   u_int32_t igpmetric;
  75
  76   /* MPLS label.  */
  77   u_char tag[3];
  78
  79 #if ENABLE_BGP_VNC
  80   union {
  81
  82       struct {
  83           void *rfapi_handle;   /* export: NVE advertising this route */
  84           struct list   *local_nexthops; /* optional, for static routes */
  85       } export;
  86
  87       struct {
  88           void *timer;
  89           void *hme;            /* encap monitor, if this is a VPN route */
  90           struct prefix_rd rd;  /* import: route's route-distinguisher */
  91           u_char un_family;     /* family of cached un address, 0 if unset */
  92           union {
  93             struct in_addr addr4;
  94             struct in6_addr addr6;
  95           } un;                 /* cached un address */
  96           time_t create_time;
  97           struct prefix aux_prefix; /* AFI_L2VPN: the IP addr, if family set */
  98       } import;
  99
 100   } vnc;
 101 #endif
 102 };
 103
 104 struct bgp_info
 105 {
 106   /* For linked list. */
 107   struct bgp_info *next;
 108   struct bgp_info *prev;
 109
 110   /* For nexthop linked list */
 111   LIST_ENTRY(bgp_info) nh_thread;
 112
 113   /* Back pointer to the prefix node */
 114   struct bgp_node *net;
 115
 116   /* Back pointer to the nexthop structure */
 117   struct bgp_nexthop_cache *nexthop;
 118
 119   /* Peer structure.  */
 120   struct peer *peer;
 121
 122   /* Attribute structure.  */
 123   struct attr *attr;
 124
 125   /* Extra information */
 126   struct bgp_info_extra *extra;
 127
 128
 129   /* Multipath information */
 130   struct bgp_info_mpath *mpath;
 131
 132   /* Uptime.  */
 133   time_t uptime;
 134
 135   /* reference count */
 136   int lock;
 137
 138   /* BGP information status.  */
 139   u_int16_t flags;
 140 #define BGP_INFO_IGP_CHANGED    (1 << 0)
 141 #define BGP_INFO_DAMPED         (1 << 1)
 142 #define BGP_INFO_HISTORY        (1 << 2)
 143 #define BGP_INFO_SELECTED       (1 << 3)
 144 #define BGP_INFO_VALID          (1 << 4)
 145 #define BGP_INFO_ATTR_CHANGED   (1 << 5)
 146 #define BGP_INFO_DMED_CHECK     (1 << 6)
 147 #define BGP_INFO_DMED_SELECTED  (1 << 7)
 148 #define BGP_INFO_STALE          (1 << 8)
 149 #define BGP_INFO_REMOVED        (1 << 9)
 150 #define BGP_INFO_COUNTED        (1 << 10)
 151 #define BGP_INFO_MULTIPATH      (1 << 11)
 152 #define BGP_INFO_MULTIPATH_CHG  (1 << 12)
 153
 154   /* BGP route type.  This can be static, RIP, OSPF, BGP etc.  */
 155   u_char type;
 156
 157   /* When above type is BGP.  This sub type specify BGP sub type
 158      information.  */
 159   u_char sub_type;
 160 #define BGP_ROUTE_NORMAL       0
 161 #define BGP_ROUTE_STATIC       1
 162 #define BGP_ROUTE_AGGREGATE    2
 163 #define BGP_ROUTE_REDISTRIBUTE 3
 164 #ifdef ENABLE_BGP_VNC
 165 # define BGP_ROUTE_RFP          4
 166 #endif
 167
 168   u_short instance;
 169
 170   /* Addpath identifiers */
 171   u_int32_t addpath_rx_id;
 172   u_int32_t addpath_tx_id;
 173
 174 };
 175
 176 /* BGP static route configuration. */
 177 struct bgp_static
 178 {
 179   /* Backdoor configuration.  */
 180   int backdoor;
 181
 182   /* Import check status.  */
 183   u_char valid;
 184
 185   /* IGP metric. */
 186   u_int32_t igpmetric;
 187
 188   /* IGP nexthop. */
 189   struct in_addr igpnexthop;
 190
 191   /* Atomic set reference count (ie cause of pathlimit) */
 192   u_int32_t atomic;
 193
 194   /* BGP redistribute route-map.  */
 195   struct
 196   {
 197     char *name;
 198     struct route_map *map;
 199   } rmap;
 200
 201   /* Route Distinguisher */
 202   struct prefix_rd     prd;
 203
 204   /* MPLS label.  */
 205   u_char tag[3];
 206
 207   /* EVPN */
 208   struct eth_segment_id *eth_s_id;
 209   struct ethaddr *router_mac;
 210   uint16_t   encap_tunneltype;
 211   struct prefix gatewayIp;
 212 };
 213
 214 #define BGP_NEXTHOP_AFI_FROM_NHLEN(nhlen) \
 215   ((nhlen) < IPV4_MAX_BYTELEN  ? 0 : \
 216    ((nhlen) < IPV6_MAX_BYTELEN ? AFI_IP : AFI_IP6))
 217
 218 #define BGP_ATTR_NEXTHOP_AFI_IP6(attr) \
 219   (! CHECK_FLAG (attr->flag, ATTR_FLAG_BIT (BGP_ATTR_NEXT_HOP)) && \
 220    (attr)->extra && ((attr)->extra->mp_nexthop_len == 16 || \
 221     (attr)->extra->mp_nexthop_len == 32))
 222 #define BGP_INFO_COUNTABLE(BI) \
 223   (! CHECK_FLAG ((BI)->flags, BGP_INFO_HISTORY) \
 224    && ! CHECK_FLAG ((BI)->flags, BGP_INFO_REMOVED))
 225
 226 /* Flags which indicate a route is unuseable in some form */
 227 #define BGP_INFO_UNUSEABLE \
 228   (BGP_INFO_HISTORY|BGP_INFO_DAMPED|BGP_INFO_REMOVED)
 229 /* Macro to check BGP information is alive or not.  Sadly,
 230  * not equivalent to just checking previous, because of the
 231  * sense of the additional VALID flag.
 232  */
 233 #define BGP_INFO_HOLDDOWN(BI) \
 234   (! CHECK_FLAG ((BI)->flags, BGP_INFO_VALID) \
 235    || CHECK_FLAG ((BI)->flags, BGP_INFO_UNUSEABLE))
 236
 237 #define DISTRIBUTE_IN_NAME(F)   ((F)->dlist[FILTER_IN].name)
 238 #define DISTRIBUTE_IN(F)        ((F)->dlist[FILTER_IN].alist)
 239 #define DISTRIBUTE_OUT_NAME(F)  ((F)->dlist[FILTER_OUT].name)
 240 #define DISTRIBUTE_OUT(F)       ((F)->dlist[FILTER_OUT].alist)
 241
 242 #define PREFIX_LIST_IN_NAME(F)  ((F)->plist[FILTER_IN].name)
 243 #define PREFIX_LIST_IN(F)       ((F)->plist[FILTER_IN].plist)
 244 #define PREFIX_LIST_OUT_NAME(F) ((F)->plist[FILTER_OUT].name)
 245 #define PREFIX_LIST_OUT(F)      ((F)->plist[FILTER_OUT].plist)
 246
 247 #define FILTER_LIST_IN_NAME(F)  ((F)->aslist[FILTER_IN].name)
 248 #define FILTER_LIST_IN(F)       ((F)->aslist[FILTER_IN].aslist)
 249 #define FILTER_LIST_OUT_NAME(F) ((F)->aslist[FILTER_OUT].name)
 250 #define FILTER_LIST_OUT(F)      ((F)->aslist[FILTER_OUT].aslist)
 251
 252 #define ROUTE_MAP_IN_NAME(F)    ((F)->map[RMAP_IN].name)
 253 #define ROUTE_MAP_IN(F)         ((F)->map[RMAP_IN].map)
 254 #define ROUTE_MAP_OUT_NAME(F)   ((F)->map[RMAP_OUT].name)
 255 #define ROUTE_MAP_OUT(F)        ((F)->map[RMAP_OUT].map)
 256
 257 #define UNSUPPRESS_MAP_NAME(F)  ((F)->usmap.name)
 258 #define UNSUPPRESS_MAP(F)       ((F)->usmap.map)
 259
 260 /* path PREFIX (addpath rxid NUMBER) */
 261 #define PATH_ADDPATH_STR_BUFFER PREFIX2STR_BUFFER + 32
 262
 263 enum bgp_path_type
 264 {
 265   BGP_PATH_ALL,
 266   BGP_PATH_BESTPATH,
 267   BGP_PATH_MULTIPATH
 268 };
 269
 270 static inline void
 271 bgp_bump_version (struct bgp_node *node)
 272 {
 273   node->version = bgp_table_next_version(bgp_node_table(node));
 274 }
 275
 276 /* Prototypes. */
 277 extern void bgp_process_queue_init (void);
 278 extern void bgp_route_init (void);
 279 extern void bgp_route_finish (void);
 280 extern void bgp_cleanup_routes (struct bgp *);
 281 extern void bgp_announce_route (struct peer *, afi_t, safi_t);
 282 extern void bgp_stop_announce_route_timer(struct peer_af *paf);
 283 extern void bgp_announce_route_all (struct peer *);
 284 extern void bgp_default_originate (struct peer *, afi_t, safi_t, int);
 285 extern void bgp_soft_reconfig_in (struct peer *, afi_t, safi_t);
 286 extern void bgp_clear_route (struct peer *, afi_t, safi_t);
 287 extern void bgp_clear_route_all (struct peer *);
 288 extern void bgp_clear_adj_in (struct peer *, afi_t, safi_t);
 289 extern void bgp_clear_stale_route (struct peer *, afi_t, safi_t);
 290
 291 extern struct bgp_node *bgp_afi_node_get (struct bgp_table *table, afi_t afi,
 292                                           safi_t safi, struct prefix *p,
 293                                           struct prefix_rd *prd);
 294 extern struct bgp_info *bgp_info_lock (struct bgp_info *);
 295 extern struct bgp_info *bgp_info_unlock (struct bgp_info *);
 296 extern void bgp_info_add (struct bgp_node *rn, struct bgp_info *ri);
 297 extern void bgp_info_delete (struct bgp_node *rn, struct bgp_info *ri);
 298 extern struct bgp_info_extra *bgp_info_extra_get (struct bgp_info *);
 299 extern void bgp_info_set_flag (struct bgp_node *, struct bgp_info *, u_int32_t);
 300 extern void bgp_info_unset_flag (struct bgp_node *, struct bgp_info *, u_int32_t);
 301 extern void bgp_info_path_with_addpath_rx_str (struct bgp_info *ri, char *buf);
 302
 303 extern int bgp_nlri_parse_ip (struct peer *, struct attr *, struct bgp_nlri *);
 304
 305 extern int bgp_maximum_prefix_overflow (struct peer *, afi_t, safi_t, int);
 306
 307 extern void bgp_redistribute_add (struct bgp *, struct prefix *, const struct in_addr *,
 308                                   const struct in6_addr *, unsigned int ifindex,
 309                                   u_int32_t, u_char, u_short, route_tag_t);
 310 extern void bgp_redistribute_delete (struct bgp *, struct prefix *, u_char, u_short);
 311 extern void bgp_redistribute_withdraw (struct bgp *, afi_t, int, u_short);
 312
 313 extern void bgp_static_add (struct bgp *);
 314 extern void bgp_static_delete (struct bgp *);
 315 extern void bgp_static_redo_import_check (struct bgp *);
 316 extern void bgp_purge_static_redist_routes (struct bgp *bgp);
 317 extern void bgp_static_update (struct bgp *, struct prefix *, struct bgp_static *,
 318                         afi_t, safi_t);
 319 extern void bgp_static_withdraw (struct bgp *, struct prefix *, afi_t, safi_t);
 320
 321 extern int bgp_static_set_safi (afi_t afi, safi_t safi, struct vty *vty, const char *,
 322                                 const char *, const char *, const char *,
 323                                 int, const char *, const char *, const char *, const char *);
 324
 325 extern int bgp_static_unset_safi (afi_t afi, safi_t safi, struct vty *, const char *,
 326                                   const char *, const char *,
 327                                   int, const char *, const char *, const char *);
 328
 329 /* this is primarily for MPLS-VPN */
 330 extern int bgp_update (struct peer *, struct prefix *, u_int32_t, struct attr *,
 331                        afi_t, safi_t, int, int, struct prefix_rd *,
 332                        u_char *, int, struct bgp_route_evpn *);
 333 extern int bgp_withdraw (struct peer *, struct prefix *, u_int32_t, struct attr *,
 334                          afi_t, safi_t, int, int, struct prefix_rd *, u_char *,
 335                          struct bgp_route_evpn *);
 336
 337 /* for bgp_nexthop and bgp_damp */
 338 extern void bgp_process (struct bgp *, struct bgp_node *, afi_t, safi_t);
 339
 340 /*
 341  * Add an end-of-initial-update marker to the process queue. This is just a
 342  * queue element with NULL bgp node.
 343  */
 344 extern void bgp_add_eoiu_mark (struct bgp *);
 345 extern int bgp_config_write_table_map (struct vty *, struct bgp *, afi_t, safi_t,
 346                                        int *);
 347 extern int bgp_config_write_network (struct vty *, struct bgp *, afi_t, safi_t, int *);
 348 extern int bgp_config_write_distance (struct vty *, struct bgp *, afi_t, safi_t, int *);
 349
 350 extern void bgp_aggregate_increment (struct bgp *, struct prefix *, struct bgp_info *,
 351                               afi_t, safi_t);
 352 extern void bgp_aggregate_decrement (struct bgp *, struct prefix *, struct bgp_info *,
 353                               afi_t, safi_t);
 354
 355 extern u_char bgp_distance_apply (struct prefix *, struct bgp_info *, afi_t, safi_t, struct bgp *);
 356
 357 extern afi_t bgp_node_afi (struct vty *);
 358 extern safi_t bgp_node_safi (struct vty *);
 359
 360 extern void route_vty_out (struct vty *, struct prefix *, struct bgp_info *, int, safi_t, json_object *);
 361 extern void route_vty_out_tag (struct vty *, struct prefix *, struct bgp_info *, int, safi_t, json_object *);
 362 extern void route_vty_out_tmp (struct vty *, struct prefix *, struct attr *, safi_t, u_char, json_object *);
 363 extern void
 364 route_vty_out_overlay (struct vty *vty, struct prefix *p,
 365                        struct bgp_info *binfo, int display, json_object *json);
 366
 367 extern int
 368 subgroup_process_announce_selected (struct update_subgroup *subgrp,
 369                                     struct bgp_info *selected,
 370                                     struct bgp_node *rn,
 371                                     u_int32_t addpath_tx_id);
 372
 373 extern int subgroup_announce_check(struct bgp_info *ri,
 374                                    struct update_subgroup *subgrp,
 375                                    struct prefix *p, struct attr *attr);
 376
 377 extern void bgp_peer_clear_node_queue_drain_immediate (struct peer *peer);
 378 extern void bgp_process_queues_drain_immediate (void);
 379
 380 /* for encap/vpn */
 381 extern struct bgp_node *
 382 bgp_afi_node_get (struct bgp_table *, afi_t , safi_t , struct prefix *,
 383                   struct prefix_rd *);
 384 extern struct bgp_info *bgp_info_new (void);
 385 extern void bgp_info_restore (struct bgp_node *, struct bgp_info *);
 386
 387 extern int bgp_info_cmp_compatible (struct bgp *, struct bgp_info *,
 388                                     struct bgp_info *, afi_t, safi_t );
 389
 390 #endif /* _QUAGGA_BGP_ROUTE_H */