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 along
  17  * with this program; see the file COPYING; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef _QUAGGA_BGP_ROUTE_H
  22 #define _QUAGGA_BGP_ROUTE_H
  23
  24 #include "queue.h"
  25 #include "nexthop.h"
  26 #include "bgp_table.h"
  27 #include "bgp_addpath_types.h"
  28
  29 struct bgp_nexthop_cache;
  30 struct bgp_route_evpn;
  31
  32 enum bgp_show_type {
  33         bgp_show_type_normal,
  34         bgp_show_type_regexp,
  35         bgp_show_type_prefix_list,
  36         bgp_show_type_filter_list,
  37         bgp_show_type_route_map,
  38         bgp_show_type_neighbor,
  39         bgp_show_type_cidr_only,
  40         bgp_show_type_prefix_longer,
  41         bgp_show_type_community_all,
  42         bgp_show_type_community,
  43         bgp_show_type_community_exact,
  44         bgp_show_type_community_list,
  45         bgp_show_type_community_list_exact,
  46         bgp_show_type_lcommunity_all,
  47         bgp_show_type_lcommunity,
  48         bgp_show_type_lcommunity_list,
  49         bgp_show_type_flap_statistics,
  50         bgp_show_type_flap_neighbor,
  51         bgp_show_type_dampend_paths,
  52         bgp_show_type_damp_neighbor,
  53         bgp_show_type_detail,
  54 };
  55
  56 enum bgp_show_adj_route_type {
  57         bgp_show_adj_route_advertised,
  58         bgp_show_adj_route_received,
  59         bgp_show_adj_route_filtered,
  60 };
  61
  62
  63 #define BGP_SHOW_SCODE_HEADER                                                  \
  64         "Status codes:  s suppressed, d damped, "                              \
  65         "h history, * valid, > best, = multipath,\n"                           \
  66         "               i internal, r RIB-failure, S Stale, R Removed\n"
  67 #define BGP_SHOW_OCODE_HEADER "Origin codes:  i - IGP, e - EGP, ? - incomplete\n\n"
  68 #define BGP_SHOW_NCODE_HEADER "Nexthop codes: @NNN nexthop's vrf id, < announce-nh-self\n"
  69 #define BGP_SHOW_HEADER "   Network          Next Hop            Metric LocPrf Weight Path\n"
  70
  71 /* Maximum number of labels we can process or send with a prefix. We
  72  * really do only 1 for MPLS (BGP-LU) but we can do 2 for EVPN-VxLAN.
  73  */
  74 #define BGP_MAX_LABELS 2
  75
  76 /* Ancillary information to struct bgp_path_info,
  77  * used for uncommonly used data (aggregation, MPLS, etc.)
  78  * and lazily allocated to save memory.
  79  */
  80 struct bgp_path_info_extra {
  81         /* Pointer to dampening structure.  */
  82         struct bgp_damp_info *damp_info;
  83
  84         /* This route is suppressed with aggregation.  */
  85         int suppress;
  86
  87         /* Nexthop reachability check.  */
  88         uint32_t igpmetric;
  89
  90         /* MPLS label(s) - VNI(s) for EVPN-VxLAN  */
  91         mpls_label_t label[BGP_MAX_LABELS];
  92         uint32_t num_labels;
  93
  94 #if ENABLE_BGP_VNC
  95         union {
  96
  97                 struct {
  98                         void *rfapi_handle; /* export: NVE advertising this
  99                                                route */
 100                         struct list *local_nexthops; /* optional, for static
 101                                                         routes */
 102                 } export;
 103
 104                 struct {
 105                         struct thread *timer;
 106                         void *hme; /* encap monitor, if this is a VPN route */
 107                         struct prefix_rd
 108                                 rd; /* import: route's route-distinguisher */
 109                         uint8_t un_family; /* family of cached un address, 0 if
 110                                              unset */
 111                         union {
 112                                 struct in_addr addr4;
 113                                 struct in6_addr addr6;
 114                         } un; /* cached un address */
 115                         time_t create_time;
 116                         struct prefix aux_prefix; /* AFI_L2VPN: the IP addr,
 117                                                      if family set */
 118                 } import;
 119
 120         } vnc;
 121 #endif
 122
 123         /* For imported routes into a VNI (or VRF), this points to the parent.
 124          */
 125         void *parent;
 126
 127         /*
 128          * Some tunnelish parameters follow. Maybe consolidate into an
 129          * internal tunnel structure?
 130          */
 131
 132         /*
 133          * Original bgp instance for imported routes. Needed for:
 134          * 1. Find all routes from a specific vrf for deletion
 135          * 2. vrf context of original nexthop
 136          *
 137          * Store pointer to bgp instance rather than bgp->vrf_id because
 138          * bgp->vrf_id is not always valid (or may change?).
 139          *
 140          * Set to NULL if route is not imported from another bgp instance.
 141          */
 142         struct bgp *bgp_orig;
 143
 144         /*
 145          * Nexthop in context of original bgp instance. Needed
 146          * for label resolution of core mpls routes exported to a vrf.
 147          * Set nexthop_orig.family to 0 if not valid.
 148          */
 149         struct prefix nexthop_orig;
 150         /* presence of FS pbr firewall based entry */
 151         struct list *bgp_fs_pbr;
 152         /* presence of FS pbr iprule based entry */
 153         struct list *bgp_fs_iprule;
 154 };
 155
 156 struct bgp_path_info {
 157         /* For linked list. */
 158         struct bgp_path_info *next;
 159         struct bgp_path_info *prev;
 160
 161         /* For nexthop linked list */
 162         LIST_ENTRY(bgp_path_info) nh_thread;
 163
 164         /* Back pointer to the prefix node */
 165         struct bgp_node *net;
 166
 167         /* Back pointer to the nexthop structure */
 168         struct bgp_nexthop_cache *nexthop;
 169
 170         /* Peer structure.  */
 171         struct peer *peer;
 172
 173         /* Attribute structure.  */
 174         struct attr *attr;
 175
 176         /* Extra information */
 177         struct bgp_path_info_extra *extra;
 178
 179
 180         /* Multipath information */
 181         struct bgp_path_info_mpath *mpath;
 182
 183         /* Uptime.  */
 184         time_t uptime;
 185
 186         /* reference count */
 187         int lock;
 188
 189         /* BGP information status.  */
 190         uint16_t flags;
 191 #define BGP_PATH_IGP_CHANGED (1 << 0)
 192 #define BGP_PATH_DAMPED (1 << 1)
 193 #define BGP_PATH_HISTORY (1 << 2)
 194 #define BGP_PATH_SELECTED (1 << 3)
 195 #define BGP_PATH_VALID (1 << 4)
 196 #define BGP_PATH_ATTR_CHANGED (1 << 5)
 197 #define BGP_PATH_DMED_CHECK (1 << 6)
 198 #define BGP_PATH_DMED_SELECTED (1 << 7)
 199 #define BGP_PATH_STALE (1 << 8)
 200 #define BGP_PATH_REMOVED (1 << 9)
 201 #define BGP_PATH_COUNTED (1 << 10)
 202 #define BGP_PATH_MULTIPATH (1 << 11)
 203 #define BGP_PATH_MULTIPATH_CHG (1 << 12)
 204 #define BGP_PATH_RIB_ATTR_CHG (1 << 13)
 205 #define BGP_PATH_ANNC_NH_SELF (1 << 14)
 206
 207         /* BGP route type.  This can be static, RIP, OSPF, BGP etc.  */
 208         uint8_t type;
 209
 210         /* When above type is BGP.  This sub type specify BGP sub type
 211            information.  */
 212         uint8_t sub_type;
 213 #define BGP_ROUTE_NORMAL       0
 214 #define BGP_ROUTE_STATIC       1
 215 #define BGP_ROUTE_AGGREGATE    2
 216 #define BGP_ROUTE_REDISTRIBUTE 3
 217 #ifdef ENABLE_BGP_VNC
 218 # define BGP_ROUTE_RFP          4
 219 #endif
 220 #define BGP_ROUTE_IMPORTED     5        /* from another bgp instance/safi */
 221
 222         unsigned short instance;
 223
 224         /* Addpath identifiers */
 225         uint32_t addpath_rx_id;
 226         struct bgp_addpath_info_data tx_addpath;
 227 };
 228
 229 /* Structure used in BGP path selection */
 230 struct bgp_path_info_pair {
 231         struct bgp_path_info *old;
 232         struct bgp_path_info *new;
 233 };
 234
 235 /* BGP static route configuration. */
 236 struct bgp_static {
 237         /* Backdoor configuration.  */
 238         int backdoor;
 239
 240         /* Label index configuration; applies to LU prefixes. */
 241         uint32_t label_index;
 242 #define BGP_INVALID_LABEL_INDEX   0xFFFFFFFF
 243
 244         /* Import check status.  */
 245         uint8_t valid;
 246
 247         /* IGP metric. */
 248         uint32_t igpmetric;
 249
 250         /* IGP nexthop. */
 251         struct in_addr igpnexthop;
 252
 253         /* Atomic set reference count (ie cause of pathlimit) */
 254         uint32_t atomic;
 255
 256         /* BGP redistribute route-map.  */
 257         struct {
 258                 char *name;
 259                 struct route_map *map;
 260         } rmap;
 261
 262         /* Route Distinguisher */
 263         struct prefix_rd prd;
 264
 265         /* MPLS label.  */
 266         mpls_label_t label;
 267
 268         /* EVPN */
 269         struct eth_segment_id *eth_s_id;
 270         struct ethaddr *router_mac;
 271         uint16_t encap_tunneltype;
 272         struct prefix gatewayIp;
 273 };
 274
 275 #define BGP_NEXTHOP_AFI_FROM_NHLEN(nhlen)                                      \
 276         ((nhlen) < IPV4_MAX_BYTELEN                                            \
 277                  ? 0                                                           \
 278                  : ((nhlen) < IPV6_MAX_BYTELEN ? AFI_IP : AFI_IP6))
 279
 280 #define BGP_ATTR_NEXTHOP_AFI_IP6(attr)                                         \
 281         (!CHECK_FLAG(attr->flag, ATTR_FLAG_BIT(BGP_ATTR_NEXT_HOP))             \
 282          && ((attr)->mp_nexthop_len == 16 || (attr)->mp_nexthop_len == 32))
 283 #define BGP_PATH_COUNTABLE(BI)                                                 \
 284         (!CHECK_FLAG((BI)->flags, BGP_PATH_HISTORY)                            \
 285          && !CHECK_FLAG((BI)->flags, BGP_PATH_REMOVED))
 286
 287 /* Flags which indicate a route is unuseable in some form */
 288 #define BGP_PATH_UNUSEABLE                                                     \
 289         (BGP_PATH_HISTORY | BGP_PATH_DAMPED | BGP_PATH_REMOVED)
 290 /* Macro to check BGP information is alive or not.  Sadly,
 291  * not equivalent to just checking previous, because of the
 292  * sense of the additional VALID flag.
 293  */
 294 #define BGP_PATH_HOLDDOWN(BI)                                                  \
 295         (!CHECK_FLAG((BI)->flags, BGP_PATH_VALID)                              \
 296          || CHECK_FLAG((BI)->flags, BGP_PATH_UNUSEABLE))
 297
 298 #define DISTRIBUTE_IN_NAME(F)   ((F)->dlist[FILTER_IN].name)
 299 #define DISTRIBUTE_IN(F)        ((F)->dlist[FILTER_IN].alist)
 300 #define DISTRIBUTE_OUT_NAME(F)  ((F)->dlist[FILTER_OUT].name)
 301 #define DISTRIBUTE_OUT(F)       ((F)->dlist[FILTER_OUT].alist)
 302
 303 #define PREFIX_LIST_IN_NAME(F)  ((F)->plist[FILTER_IN].name)
 304 #define PREFIX_LIST_IN(F)       ((F)->plist[FILTER_IN].plist)
 305 #define PREFIX_LIST_OUT_NAME(F) ((F)->plist[FILTER_OUT].name)
 306 #define PREFIX_LIST_OUT(F)      ((F)->plist[FILTER_OUT].plist)
 307
 308 #define FILTER_LIST_IN_NAME(F)  ((F)->aslist[FILTER_IN].name)
 309 #define FILTER_LIST_IN(F)       ((F)->aslist[FILTER_IN].aslist)
 310 #define FILTER_LIST_OUT_NAME(F) ((F)->aslist[FILTER_OUT].name)
 311 #define FILTER_LIST_OUT(F)      ((F)->aslist[FILTER_OUT].aslist)
 312
 313 #define ROUTE_MAP_IN_NAME(F)    ((F)->map[RMAP_IN].name)
 314 #define ROUTE_MAP_IN(F)         ((F)->map[RMAP_IN].map)
 315 #define ROUTE_MAP_OUT_NAME(F)   ((F)->map[RMAP_OUT].name)
 316 #define ROUTE_MAP_OUT(F)        ((F)->map[RMAP_OUT].map)
 317
 318 #define UNSUPPRESS_MAP_NAME(F)  ((F)->usmap.name)
 319 #define UNSUPPRESS_MAP(F)       ((F)->usmap.map)
 320
 321 /* path PREFIX (addpath rxid NUMBER) */
 322 #define PATH_ADDPATH_STR_BUFFER PREFIX2STR_BUFFER + 32
 323
 324 enum bgp_path_type {
 325         BGP_PATH_SHOW_ALL,
 326         BGP_PATH_SHOW_BESTPATH,
 327         BGP_PATH_SHOW_MULTIPATH
 328 };
 329
 330 static inline void bgp_bump_version(struct bgp_node *node)
 331 {
 332         node->version = bgp_table_next_version(bgp_node_table(node));
 333 }
 334
 335 static inline int bgp_fibupd_safi(safi_t safi)
 336 {
 337         if (safi == SAFI_UNICAST || safi == SAFI_MULTICAST
 338             || safi == SAFI_LABELED_UNICAST
 339             || safi == SAFI_FLOWSPEC)
 340                 return 1;
 341         return 0;
 342 }
 343
 344 /* Prototypes. */
 345 extern void bgp_rib_remove(struct bgp_node *rn, struct bgp_path_info *pi,
 346                            struct peer *peer, afi_t afi, safi_t safi);
 347 extern void bgp_process_queue_init(void);
 348 extern void bgp_route_init(void);
 349 extern void bgp_route_finish(void);
 350 extern void bgp_cleanup_routes(struct bgp *);
 351 extern void bgp_announce_route(struct peer *, afi_t, safi_t);
 352 extern void bgp_stop_announce_route_timer(struct peer_af *paf);
 353 extern void bgp_announce_route_all(struct peer *);
 354 extern void bgp_default_originate(struct peer *, afi_t, safi_t, int);
 355 extern void bgp_soft_reconfig_in(struct peer *, afi_t, safi_t);
 356 extern void bgp_clear_route(struct peer *, afi_t, safi_t);
 357 extern void bgp_clear_route_all(struct peer *);
 358 extern void bgp_clear_adj_in(struct peer *, afi_t, safi_t);
 359 extern void bgp_clear_stale_route(struct peer *, afi_t, safi_t);
 360
 361 extern struct bgp_node *bgp_afi_node_get(struct bgp_table *table, afi_t afi,
 362                                          safi_t safi, struct prefix *p,
 363                                          struct prefix_rd *prd);
 364 extern struct bgp_path_info *bgp_path_info_lock(struct bgp_path_info *path);
 365 extern struct bgp_path_info *bgp_path_info_unlock(struct bgp_path_info *path);
 366 extern void bgp_path_info_add(struct bgp_node *rn, struct bgp_path_info *pi);
 367 extern void bgp_path_info_extra_free(struct bgp_path_info_extra **extra);
 368 extern void bgp_path_info_reap(struct bgp_node *rn, struct bgp_path_info *pi);
 369 extern void bgp_path_info_delete(struct bgp_node *rn, struct bgp_path_info *pi);
 370 extern struct bgp_path_info_extra *
 371 bgp_path_info_extra_get(struct bgp_path_info *path);
 372 extern void bgp_path_info_set_flag(struct bgp_node *rn,
 373                                    struct bgp_path_info *path, uint32_t flag);
 374 extern void bgp_path_info_unset_flag(struct bgp_node *rn,
 375                                      struct bgp_path_info *path, uint32_t flag);
 376 extern void bgp_path_info_path_with_addpath_rx_str(struct bgp_path_info *pi,
 377                                                    char *buf);
 378
 379 extern int bgp_nlri_parse_ip(struct peer *, struct attr *, struct bgp_nlri *);
 380
 381 extern int bgp_maximum_prefix_overflow(struct peer *, afi_t, safi_t, int);
 382
 383 extern void bgp_redistribute_add(struct bgp *bgp, struct prefix *p,
 384                                  const union g_addr *nexthop, ifindex_t ifindex,
 385                                  enum nexthop_types_t nhtype, uint32_t metric,
 386                                  uint8_t type, unsigned short instance,
 387                                  route_tag_t tag);
 388 extern void bgp_redistribute_delete(struct bgp *, struct prefix *, uint8_t,
 389                                     unsigned short);
 390 extern void bgp_redistribute_withdraw(struct bgp *, afi_t, int, unsigned short);
 391
 392 extern void bgp_static_add(struct bgp *);
 393 extern void bgp_static_delete(struct bgp *);
 394 extern void bgp_static_redo_import_check(struct bgp *);
 395 extern void bgp_purge_static_redist_routes(struct bgp *bgp);
 396 extern void bgp_static_update(struct bgp *, struct prefix *,
 397                               struct bgp_static *, afi_t, safi_t);
 398 extern void bgp_static_withdraw(struct bgp *, struct prefix *, afi_t, safi_t);
 399
 400 extern int bgp_static_set_safi(afi_t afi, safi_t safi, struct vty *vty,
 401                                const char *, const char *, const char *,
 402                                const char *, int, const char *, const char *,
 403                                const char *, const char *);
 404
 405 extern int bgp_static_unset_safi(afi_t afi, safi_t safi, struct vty *,
 406                                  const char *, const char *, const char *, int,
 407                                  const char *, const char *, const char *);
 408
 409 /* this is primarily for MPLS-VPN */
 410 extern int bgp_update(struct peer *, struct prefix *, uint32_t, struct attr *,
 411                       afi_t, safi_t, int, int, struct prefix_rd *,
 412                       mpls_label_t *, uint32_t, int, struct bgp_route_evpn *);
 413 extern int bgp_withdraw(struct peer *, struct prefix *, uint32_t, struct attr *,
 414                         afi_t, safi_t, int, int, struct prefix_rd *,
 415                         mpls_label_t *, uint32_t, struct bgp_route_evpn *);
 416
 417 /* for bgp_nexthop and bgp_damp */
 418 extern void bgp_process(struct bgp *, struct bgp_node *, afi_t, safi_t);
 419
 420 /*
 421  * Add an end-of-initial-update marker to the process queue. This is just a
 422  * queue element with NULL bgp node.
 423  */
 424 extern void bgp_add_eoiu_mark(struct bgp *);
 425 extern void bgp_config_write_table_map(struct vty *, struct bgp *, afi_t,
 426                                        safi_t);
 427 extern void bgp_config_write_network(struct vty *, struct bgp *, afi_t, safi_t);
 428 extern void bgp_config_write_distance(struct vty *, struct bgp *, afi_t,
 429                                       safi_t);
 430
 431 extern void bgp_aggregate_increment(struct bgp *bgp, struct prefix *p,
 432                                     struct bgp_path_info *path, afi_t afi,
 433                                     safi_t safi);
 434 extern void bgp_aggregate_decrement(struct bgp *bgp, struct prefix *p,
 435                                     struct bgp_path_info *path, afi_t afi,
 436                                     safi_t safi);
 437
 438 extern uint8_t bgp_distance_apply(struct prefix *p, struct bgp_path_info *path,
 439                                   afi_t afi, safi_t safi, struct bgp *bgp);
 440
 441 extern afi_t bgp_node_afi(struct vty *);
 442 extern safi_t bgp_node_safi(struct vty *);
 443
 444 extern struct bgp_path_info *info_make(int type, int sub_type,
 445                                        unsigned short instance,
 446                                        struct peer *peer, struct attr *attr,
 447                                        struct bgp_node *rn);
 448
 449 extern void route_vty_out(struct vty *vty, struct prefix *p,
 450                           struct bgp_path_info *path, int display, safi_t safi,
 451                           json_object *json_paths);
 452 extern void route_vty_out_tag(struct vty *vty, struct prefix *p,
 453                               struct bgp_path_info *path, int display,
 454                               safi_t safi, json_object *json);
 455 extern void route_vty_out_tmp(struct vty *vty, struct prefix *p,
 456                               struct attr *attr, safi_t safi, bool use_json,
 457                               json_object *json_ar);
 458 extern void route_vty_out_overlay(struct vty *vty, struct prefix *p,
 459                                   struct bgp_path_info *path, int display,
 460                                   json_object *json);
 461
 462 extern int subgroup_process_announce_selected(struct update_subgroup *subgrp,
 463                                               struct bgp_path_info *selected,
 464                                               struct bgp_node *rn,
 465                                               uint32_t addpath_tx_id);
 466
 467 extern int subgroup_announce_check(struct bgp_node *rn,
 468                                    struct bgp_path_info *pi,
 469                                    struct update_subgroup *subgrp,
 470                                    struct prefix *p, struct attr *attr);
 471
 472 extern void bgp_peer_clear_node_queue_drain_immediate(struct peer *peer);
 473 extern void bgp_process_queues_drain_immediate(void);
 474
 475 /* for encap/vpn */
 476 extern struct bgp_node *bgp_afi_node_lookup(struct bgp_table *table, afi_t afi,
 477                                             safi_t safi, struct prefix *p,
 478                                             struct prefix_rd *prd);
 479 extern struct bgp_path_info *bgp_path_info_new(void);
 480 extern void bgp_path_info_restore(struct bgp_node *rn,
 481                                   struct bgp_path_info *path);
 482
 483 extern int bgp_path_info_cmp_compatible(struct bgp *bgp,
 484                                         struct bgp_path_info *new,
 485                                         struct bgp_path_info *exist,
 486                                         char *pfx_buf, afi_t afi, safi_t safi);
 487 extern void bgp_attr_add_gshut_community(struct attr *attr);
 488
 489 extern void bgp_best_selection(struct bgp *bgp, struct bgp_node *rn,
 490                                struct bgp_maxpaths_cfg *mpath_cfg,
 491                                struct bgp_path_info_pair *result, afi_t afi,
 492                                safi_t safi);
 493 extern void bgp_zebra_clear_route_change_flags(struct bgp_node *rn);
 494 extern int bgp_zebra_has_route_changed(struct bgp_node *rn,
 495                                        struct bgp_path_info *selected);
 496
 497 extern void route_vty_out_detail_header(struct vty *vty, struct bgp *bgp,
 498                                         struct bgp_node *rn,
 499                                         struct prefix_rd *prd, afi_t afi,
 500                                         safi_t safi, json_object *json);
 501 extern void route_vty_out_detail(struct vty *vty, struct bgp *bgp,
 502                                  struct prefix *p, struct bgp_path_info *path,
 503                                  afi_t afi, safi_t safi,
 504                                  json_object *json_paths);
 505 extern int bgp_show_table_rd(struct vty *vty, struct bgp *bgp, safi_t safi,
 506                              struct bgp_table *table, struct prefix_rd *prd,
 507                              enum bgp_show_type type, void *output_arg,
 508                              bool use_json);
 509 #endif /* _QUAGGA_BGP_ROUTE_H */