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 <stdbool.h>
  25
  26 #include "hook.h"
  27 #include "queue.h"
  28 #include "nexthop.h"
  29 #include "bgp_table.h"
  30 #include "bgp_addpath_types.h"
  31 #include "bgp_rpki.h"
  32
  33 struct bgp_nexthop_cache;
  34 struct bgp_route_evpn;
  35
  36 enum bgp_show_type {
  37         bgp_show_type_normal,
  38         bgp_show_type_regexp,
  39         bgp_show_type_prefix_list,
  40         bgp_show_type_filter_list,
  41         bgp_show_type_route_map,
  42         bgp_show_type_neighbor,
  43         bgp_show_type_cidr_only,
  44         bgp_show_type_prefix_longer,
  45         bgp_show_type_community_alias,
  46         bgp_show_type_community_all,
  47         bgp_show_type_community,
  48         bgp_show_type_community_exact,
  49         bgp_show_type_community_list,
  50         bgp_show_type_community_list_exact,
  51         bgp_show_type_lcommunity_all,
  52         bgp_show_type_lcommunity,
  53         bgp_show_type_lcommunity_exact,
  54         bgp_show_type_lcommunity_list,
  55         bgp_show_type_lcommunity_list_exact,
  56         bgp_show_type_flap_statistics,
  57         bgp_show_type_flap_neighbor,
  58         bgp_show_type_dampend_paths,
  59         bgp_show_type_damp_neighbor,
  60         bgp_show_type_detail,
  61         bgp_show_type_rpki,
  62         bgp_show_type_prefix_version,
  63 };
  64
  65 enum bgp_show_adj_route_type {
  66         bgp_show_adj_route_advertised,
  67         bgp_show_adj_route_received,
  68         bgp_show_adj_route_filtered,
  69         bgp_show_adj_route_bestpath,
  70 };
  71
  72
  73 #define BGP_SHOW_SCODE_HEADER                                                  \
  74         "Status codes:  s suppressed, d damped, "                              \
  75         "h history, * valid, > best, = multipath,\n"                           \
  76         "               i internal, r RIB-failure, S Stale, R Removed\n"
  77 #define BGP_SHOW_OCODE_HEADER                                                  \
  78         "Origin codes:  i - IGP, e - EGP, ? - incomplete\n"
  79 #define BGP_SHOW_NCODE_HEADER "Nexthop codes: @NNN nexthop's vrf id, < announce-nh-self\n"
  80 #define BGP_SHOW_RPKI_HEADER                                                   \
  81         "RPKI validation codes: V valid, I invalid, N Not found\n\n"
  82 #define BGP_SHOW_HEADER "   Network          Next Hop            Metric LocPrf Weight Path\n"
  83 #define BGP_SHOW_HEADER_WIDE "   Network                                      Next Hop                                  Metric LocPrf Weight Path\n"
  84
  85 /* Maximum number of labels we can process or send with a prefix. We
  86  * really do only 1 for MPLS (BGP-LU) but we can do 2 for EVPN-VxLAN.
  87  */
  88 #define BGP_MAX_LABELS 2
  89
  90 /* Maximum number of sids we can process or send with a prefix. */
  91 #define BGP_MAX_SIDS 6
  92
  93 /* Error codes for handling NLRI */
  94 #define BGP_NLRI_PARSE_OK 0
  95 #define BGP_NLRI_PARSE_ERROR_PREFIX_OVERFLOW -1
  96 #define BGP_NLRI_PARSE_ERROR_PACKET_OVERFLOW -2
  97 #define BGP_NLRI_PARSE_ERROR_PREFIX_LENGTH -3
  98 #define BGP_NLRI_PARSE_ERROR_PACKET_LENGTH -4
  99 #define BGP_NLRI_PARSE_ERROR_LABEL_LENGTH -5
 100 #define BGP_NLRI_PARSE_ERROR_EVPN_MISSING_TYPE -6
 101 #define BGP_NLRI_PARSE_ERROR_EVPN_TYPE2_SIZE -7
 102 #define BGP_NLRI_PARSE_ERROR_EVPN_TYPE3_SIZE -8
 103 #define BGP_NLRI_PARSE_ERROR_EVPN_TYPE4_SIZE -9
 104 #define BGP_NLRI_PARSE_ERROR_EVPN_TYPE5_SIZE -10
 105 #define BGP_NLRI_PARSE_ERROR_FLOWSPEC_IPV6_NOT_SUPPORTED -11
 106 #define BGP_NLRI_PARSE_ERROR_FLOWSPEC_NLRI_SIZELIMIT -12
 107 #define BGP_NLRI_PARSE_ERROR_FLOWSPEC_BAD_FORMAT -13
 108 #define BGP_NLRI_PARSE_ERROR_ADDRESS_FAMILY -14
 109 #define BGP_NLRI_PARSE_ERROR_EVPN_TYPE1_SIZE -15
 110 #define BGP_NLRI_PARSE_ERROR -32
 111
 112 /* 1. local MAC-IP/type-2 paths in the VNI routing table are linked to the
 113  * destination ES
 114  * 2. remote MAC-IP paths in the global routing table are linked to the
 115  * destination ES
 116  */
 117 struct bgp_path_es_info {
 118         /* back pointer to the route */
 119         struct bgp_path_info *pi;
 120         vni_t vni;
 121         /* destination ES */
 122         struct bgp_evpn_es *es;
 123         /* memory used for linking the path to the destination ES */
 124         struct listnode es_listnode;
 125         uint8_t flags;
 126 /* Path is linked to the VNI list */
 127 #define BGP_EVPN_PATH_ES_INFO_VNI_LIST (1 << 0)
 128 /* Path is linked to the global list */
 129 #define BGP_EVPN_PATH_ES_INFO_GLOBAL_LIST (1 << 1)
 130 };
 131
 132 /* IP paths imported into the VRF from an EVPN route source
 133  * are linked to the nexthop/VTEP IP
 134  */
 135 struct bgp_path_evpn_nh_info {
 136         /* back pointer to the route */
 137         struct bgp_path_info *pi;
 138         struct bgp_evpn_nh *nh;
 139         /* memory used for linking the path to the nexthop */
 140         struct listnode nh_listnode;
 141 };
 142
 143 struct bgp_path_mh_info {
 144         struct bgp_path_es_info *es_info;
 145         struct bgp_path_evpn_nh_info *nh_info;
 146 };
 147
 148 /* Ancillary information to struct bgp_path_info,
 149  * used for uncommonly used data (aggregation, MPLS, etc.)
 150  * and lazily allocated to save memory.
 151  */
 152 struct bgp_path_info_extra {
 153         /* Pointer to dampening structure.  */
 154         struct bgp_damp_info *damp_info;
 155
 156         /** List of aggregations that suppress this path. */
 157         struct list *aggr_suppressors;
 158
 159         /* Nexthop reachability check.  */
 160         uint32_t igpmetric;
 161
 162         /* MPLS label(s) - VNI(s) for EVPN-VxLAN  */
 163         mpls_label_t label[BGP_MAX_LABELS];
 164         uint32_t num_labels;
 165
 166         /* af specific flags */
 167         uint16_t af_flags;
 168 #define BGP_EVPN_MACIP_TYPE_SVI_IP (1 << 0)
 169
 170         /* SRv6 SID(s) for SRv6-VPN */
 171         struct in6_addr sid[BGP_MAX_SIDS];
 172         uint32_t num_sids;
 173
 174 #ifdef ENABLE_BGP_VNC
 175         union {
 176
 177                 struct {
 178                         void *rfapi_handle; /* export: NVE advertising this
 179                                                route */
 180                         struct list *local_nexthops; /* optional, for static
 181                                                         routes */
 182                 } export;
 183
 184                 struct {
 185                         struct thread *timer;
 186                         void *hme; /* encap monitor, if this is a VPN route */
 187                         struct prefix_rd
 188                                 rd; /* import: route's route-distinguisher */
 189                         uint8_t un_family; /* family of cached un address, 0 if
 190                                              unset */
 191                         union {
 192                                 struct in_addr addr4;
 193                                 struct in6_addr addr6;
 194                         } un; /* cached un address */
 195                         time_t create_time;
 196                         struct prefix aux_prefix; /* AFI_L2VPN: the IP addr,
 197                                                      if family set */
 198                 } import;
 199
 200         } vnc;
 201 #endif
 202
 203         /* For imported routes into a VNI (or VRF), this points to the parent.
 204          */
 205         void *parent;
 206
 207         /*
 208          * Some tunnelish parameters follow. Maybe consolidate into an
 209          * internal tunnel structure?
 210          */
 211
 212         /*
 213          * Original bgp instance for imported routes. Needed for:
 214          * 1. Find all routes from a specific vrf for deletion
 215          * 2. vrf context of original nexthop
 216          *
 217          * Store pointer to bgp instance rather than bgp->vrf_id because
 218          * bgp->vrf_id is not always valid (or may change?).
 219          *
 220          * Set to NULL if route is not imported from another bgp instance.
 221          */
 222         struct bgp *bgp_orig;
 223
 224         /*
 225          * Nexthop in context of original bgp instance. Needed
 226          * for label resolution of core mpls routes exported to a vrf.
 227          * Set nexthop_orig.family to 0 if not valid.
 228          */
 229         struct prefix nexthop_orig;
 230         /* presence of FS pbr firewall based entry */
 231         struct list *bgp_fs_pbr;
 232         /* presence of FS pbr iprule based entry */
 233         struct list *bgp_fs_iprule;
 234         /* Destination Ethernet Segment links for EVPN MH */
 235         struct bgp_path_mh_info *mh_info;
 236 };
 237
 238 struct bgp_path_info {
 239         /* For linked list. */
 240         struct bgp_path_info *next;
 241         struct bgp_path_info *prev;
 242
 243         /* For nexthop linked list */
 244         LIST_ENTRY(bgp_path_info) nh_thread;
 245
 246         /* Back pointer to the prefix node */
 247         struct bgp_dest *net;
 248
 249         /* Back pointer to the nexthop structure */
 250         struct bgp_nexthop_cache *nexthop;
 251
 252         /* Peer structure.  */
 253         struct peer *peer;
 254
 255         /* Attribute structure.  */
 256         struct attr *attr;
 257
 258         /* Extra information */
 259         struct bgp_path_info_extra *extra;
 260
 261
 262         /* Multipath information */
 263         struct bgp_path_info_mpath *mpath;
 264
 265         /* Uptime.  */
 266         time_t uptime;
 267
 268         /* reference count */
 269         int lock;
 270
 271         /* BGP information status.  */
 272         uint16_t flags;
 273 #define BGP_PATH_IGP_CHANGED (1 << 0)
 274 #define BGP_PATH_DAMPED (1 << 1)
 275 #define BGP_PATH_HISTORY (1 << 2)
 276 #define BGP_PATH_SELECTED (1 << 3)
 277 #define BGP_PATH_VALID (1 << 4)
 278 #define BGP_PATH_ATTR_CHANGED (1 << 5)
 279 #define BGP_PATH_DMED_CHECK (1 << 6)
 280 #define BGP_PATH_DMED_SELECTED (1 << 7)
 281 #define BGP_PATH_STALE (1 << 8)
 282 #define BGP_PATH_REMOVED (1 << 9)
 283 #define BGP_PATH_COUNTED (1 << 10)
 284 #define BGP_PATH_MULTIPATH (1 << 11)
 285 #define BGP_PATH_MULTIPATH_CHG (1 << 12)
 286 #define BGP_PATH_RIB_ATTR_CHG (1 << 13)
 287 #define BGP_PATH_ANNC_NH_SELF (1 << 14)
 288 #define BGP_PATH_LINK_BW_CHG (1 << 15)
 289
 290         /* BGP route type.  This can be static, RIP, OSPF, BGP etc.  */
 291         uint8_t type;
 292
 293         /* When above type is BGP.  This sub type specify BGP sub type
 294            information.  */
 295         uint8_t sub_type;
 296 #define BGP_ROUTE_NORMAL       0
 297 #define BGP_ROUTE_STATIC       1
 298 #define BGP_ROUTE_AGGREGATE    2
 299 #define BGP_ROUTE_REDISTRIBUTE 3
 300 #ifdef ENABLE_BGP_VNC
 301 # define BGP_ROUTE_RFP          4
 302 #endif
 303 #define BGP_ROUTE_IMPORTED     5        /* from another bgp instance/safi */
 304
 305         unsigned short instance;
 306
 307         /* Addpath identifiers */
 308         uint32_t addpath_rx_id;
 309         struct bgp_addpath_info_data tx_addpath;
 310 };
 311
 312 /* Structure used in BGP path selection */
 313 struct bgp_path_info_pair {
 314         struct bgp_path_info *old;
 315         struct bgp_path_info *new;
 316 };
 317
 318 /* BGP static route configuration. */
 319 struct bgp_static {
 320         /* Backdoor configuration.  */
 321         int backdoor;
 322
 323         /* Label index configuration; applies to LU prefixes. */
 324         uint32_t label_index;
 325 #define BGP_INVALID_LABEL_INDEX   0xFFFFFFFF
 326
 327         /* Import check status.  */
 328         uint8_t valid;
 329
 330         /* IGP metric. */
 331         uint32_t igpmetric;
 332
 333         /* IGP nexthop. */
 334         struct in_addr igpnexthop;
 335
 336         /* Atomic set reference count (ie cause of pathlimit) */
 337         uint32_t atomic;
 338
 339         /* BGP redistribute route-map.  */
 340         struct {
 341                 char *name;
 342                 struct route_map *map;
 343         } rmap;
 344
 345         /* Route Distinguisher */
 346         struct prefix_rd prd;
 347
 348         /* MPLS label.  */
 349         mpls_label_t label;
 350
 351         /* EVPN */
 352         esi_t *eth_s_id;
 353         struct ethaddr *router_mac;
 354         uint16_t encap_tunneltype;
 355         struct prefix gatewayIp;
 356 };
 357
 358 /* Aggreagete address:
 359  *
 360  *  advertise-map  Set condition to advertise attribute
 361  *  as-set         Generate AS set path information
 362  *  attribute-map  Set attributes of aggregate
 363  *  route-map      Set parameters of aggregate
 364  *  summary-only   Filter more specific routes from updates
 365  *  suppress-map   Conditionally filter more specific routes from updates
 366  *  <cr>
 367  */
 368 struct bgp_aggregate {
 369         /* Summary-only flag. */
 370         uint8_t summary_only;
 371
 372         /* AS set generation. */
 373         uint8_t as_set;
 374
 375         /* Route-map for aggregated route. */
 376         struct {
 377                 char *name;
 378                 struct route_map *map;
 379         } rmap;
 380
 381         /* Suppress-count. */
 382         unsigned long count;
 383
 384         /* Count of routes of origin type incomplete under this aggregate. */
 385         unsigned long incomplete_origin_count;
 386
 387         /* Count of routes of origin type egp under this aggregate. */
 388         unsigned long egp_origin_count;
 389
 390         /* Optional modify flag to override ORIGIN */
 391         uint8_t origin;
 392
 393         /* Hash containing the communities of all the
 394          * routes under this aggregate.
 395          */
 396         struct hash *community_hash;
 397
 398         /* Hash containing the extended communities of all the
 399          * routes under this aggregate.
 400          */
 401         struct hash *ecommunity_hash;
 402
 403         /* Hash containing the large communities of all the
 404          * routes under this aggregate.
 405          */
 406         struct hash *lcommunity_hash;
 407
 408         /* Hash containing the AS-Path of all the
 409          * routes under this aggregate.
 410          */
 411         struct hash *aspath_hash;
 412
 413         /* Aggregate route's community. */
 414         struct community *community;
 415
 416         /* Aggregate route's extended community. */
 417         struct ecommunity *ecommunity;
 418
 419         /* Aggregate route's large community. */
 420         struct lcommunity *lcommunity;
 421
 422         /* Aggregate route's as-path. */
 423         struct aspath *aspath;
 424
 425         /* SAFI configuration. */
 426         safi_t safi;
 427
 428         /** Match only equal MED. */
 429         bool match_med;
 430         /* MED matching state. */
 431         /** Did we get the first MED value? */
 432         bool med_initialized;
 433         /** Are there MED mismatches? */
 434         bool med_mismatched;
 435         /** MED value found in current group. */
 436         uint32_t med_matched_value;
 437
 438         /**
 439          * Test if aggregated address MED of all route match, otherwise
 440          * returns `false`. This macro will also return `true` if MED
 441          * matching is disabled.
 442          */
 443 #define AGGREGATE_MED_VALID(aggregate)                                         \
 444         (((aggregate)->match_med && !(aggregate)->med_mismatched)              \
 445          || !(aggregate)->match_med)
 446
 447         /** Suppress map route map name (`NULL` when disabled). */
 448         char *suppress_map_name;
 449         /** Suppress map route map pointer. */
 450         struct route_map *suppress_map;
 451 };
 452
 453 #define BGP_NEXTHOP_AFI_FROM_NHLEN(nhlen)                                      \
 454         ((nhlen) < IPV4_MAX_BYTELEN                                            \
 455                  ? 0                                                           \
 456                  : ((nhlen) < IPV6_MAX_BYTELEN ? AFI_IP : AFI_IP6))
 457
 458 #define BGP_ATTR_NEXTHOP_AFI_IP6(attr)                                         \
 459         (!CHECK_FLAG(attr->flag, ATTR_FLAG_BIT(BGP_ATTR_NEXT_HOP))             \
 460          && ((attr)->mp_nexthop_len == BGP_ATTR_NHLEN_IPV6_GLOBAL              \
 461              || (attr)->mp_nexthop_len == BGP_ATTR_NHLEN_IPV6_GLOBAL_AND_LL    \
 462              || (attr)->mp_nexthop_len == BGP_ATTR_NHLEN_VPNV6_GLOBAL          \
 463              || (attr)->mp_nexthop_len == BGP_ATTR_NHLEN_VPNV6_GLOBAL_AND_LL))
 464 #define BGP_PATH_COUNTABLE(BI)                                                 \
 465         (!CHECK_FLAG((BI)->flags, BGP_PATH_HISTORY)                            \
 466          && !CHECK_FLAG((BI)->flags, BGP_PATH_REMOVED))
 467
 468 /* Flags which indicate a route is unuseable in some form */
 469 #define BGP_PATH_UNUSEABLE                                                     \
 470         (BGP_PATH_HISTORY | BGP_PATH_DAMPED | BGP_PATH_REMOVED)
 471 /* Macro to check BGP information is alive or not.  Sadly,
 472  * not equivalent to just checking previous, because of the
 473  * sense of the additional VALID flag.
 474  */
 475 #define BGP_PATH_HOLDDOWN(BI)                                                  \
 476         (!CHECK_FLAG((BI)->flags, BGP_PATH_VALID)                              \
 477          || CHECK_FLAG((BI)->flags, BGP_PATH_UNUSEABLE))
 478
 479 #define DISTRIBUTE_IN_NAME(F)   ((F)->dlist[FILTER_IN].name)
 480 #define DISTRIBUTE_IN(F)        ((F)->dlist[FILTER_IN].alist)
 481 #define DISTRIBUTE_OUT_NAME(F)  ((F)->dlist[FILTER_OUT].name)
 482 #define DISTRIBUTE_OUT(F)       ((F)->dlist[FILTER_OUT].alist)
 483
 484 #define PREFIX_LIST_IN_NAME(F)  ((F)->plist[FILTER_IN].name)
 485 #define PREFIX_LIST_IN(F)       ((F)->plist[FILTER_IN].plist)
 486 #define PREFIX_LIST_OUT_NAME(F) ((F)->plist[FILTER_OUT].name)
 487 #define PREFIX_LIST_OUT(F)      ((F)->plist[FILTER_OUT].plist)
 488
 489 #define FILTER_LIST_IN_NAME(F)  ((F)->aslist[FILTER_IN].name)
 490 #define FILTER_LIST_IN(F)       ((F)->aslist[FILTER_IN].aslist)
 491 #define FILTER_LIST_OUT_NAME(F) ((F)->aslist[FILTER_OUT].name)
 492 #define FILTER_LIST_OUT(F)      ((F)->aslist[FILTER_OUT].aslist)
 493
 494 #define ROUTE_MAP_IN_NAME(F)    ((F)->map[RMAP_IN].name)
 495 #define ROUTE_MAP_IN(F)         ((F)->map[RMAP_IN].map)
 496 #define ROUTE_MAP_OUT_NAME(F)   ((F)->map[RMAP_OUT].name)
 497 #define ROUTE_MAP_OUT(F)        ((F)->map[RMAP_OUT].map)
 498
 499 #define UNSUPPRESS_MAP_NAME(F)  ((F)->usmap.name)
 500 #define UNSUPPRESS_MAP(F)       ((F)->usmap.map)
 501
 502 #define ADVERTISE_MAP_NAME(F)   ((F)->advmap.aname)
 503 #define ADVERTISE_MAP(F)        ((F)->advmap.amap)
 504
 505 #define ADVERTISE_CONDITION(F)  ((F)->advmap.condition)
 506
 507 #define CONDITION_MAP_NAME(F)   ((F)->advmap.cname)
 508 #define CONDITION_MAP(F)        ((F)->advmap.cmap)
 509
 510 /* path PREFIX (addpath rxid NUMBER) */
 511 #define PATH_ADDPATH_STR_BUFFER PREFIX2STR_BUFFER + 32
 512
 513 enum bgp_path_type {
 514         BGP_PATH_SHOW_ALL,
 515         BGP_PATH_SHOW_BESTPATH,
 516         BGP_PATH_SHOW_MULTIPATH
 517 };
 518
 519 static inline void bgp_bump_version(struct bgp_dest *dest)
 520 {
 521         dest->version = bgp_table_next_version(bgp_dest_table(dest));
 522 }
 523
 524 static inline int bgp_fibupd_safi(safi_t safi)
 525 {
 526         if (safi == SAFI_UNICAST || safi == SAFI_MULTICAST
 527             || safi == SAFI_LABELED_UNICAST
 528             || safi == SAFI_FLOWSPEC)
 529                 return 1;
 530         return 0;
 531 }
 532
 533 /* Flag if the route path's family matches params. */
 534 static inline bool is_pi_family_matching(struct bgp_path_info *pi,
 535                                          afi_t afi, safi_t safi)
 536 {
 537         struct bgp_table *table;
 538         struct bgp_dest *dest;
 539
 540         dest = pi->net;
 541         if (!dest)
 542                 return false;
 543         table = bgp_dest_table(dest);
 544         if (table &&
 545             table->afi == afi &&
 546             table->safi == safi)
 547                 return true;
 548         return false;
 549 }
 550
 551 static inline void prep_for_rmap_apply(struct bgp_path_info *dst_pi,
 552                                        struct bgp_path_info_extra *dst_pie,
 553                                        struct bgp_dest *dest,
 554                                        struct bgp_path_info *src_pi,
 555                                        struct peer *peer, struct attr *attr)
 556 {
 557         memset(dst_pi, 0, sizeof(struct bgp_path_info));
 558         dst_pi->peer = peer;
 559         dst_pi->attr = attr;
 560         dst_pi->net = dest;
 561         dst_pi->flags = src_pi->flags;
 562         dst_pi->type = src_pi->type;
 563         dst_pi->sub_type = src_pi->sub_type;
 564         dst_pi->mpath = src_pi->mpath;
 565         if (src_pi->extra) {
 566                 memcpy(dst_pie, src_pi->extra,
 567                        sizeof(struct bgp_path_info_extra));
 568                 dst_pi->extra = dst_pie;
 569         }
 570 }
 571
 572 static inline bool bgp_check_advertise(struct bgp *bgp, struct bgp_dest *dest)
 573 {
 574         return (!(BGP_SUPPRESS_FIB_ENABLED(bgp) &&
 575                   CHECK_FLAG(dest->flags, BGP_NODE_FIB_INSTALL_PENDING) &&
 576                  (!bgp_option_check(BGP_OPT_NO_FIB))));
 577 }
 578
 579 /* called before bgp_process() */
 580 DECLARE_HOOK(bgp_process,
 581              (struct bgp * bgp, afi_t afi, safi_t safi, struct bgp_dest *bn,
 582               struct peer *peer, bool withdraw),
 583              (bgp, afi, safi, bn, peer, withdraw));
 584
 585 /* BGP show options */
 586 #define BGP_SHOW_OPT_JSON (1 << 0)
 587 #define BGP_SHOW_OPT_WIDE (1 << 1)
 588 #define BGP_SHOW_OPT_AFI_ALL (1 << 2)
 589 #define BGP_SHOW_OPT_AFI_IP (1 << 3)
 590 #define BGP_SHOW_OPT_AFI_IP6 (1 << 4)
 591 #define BGP_SHOW_OPT_ESTABLISHED (1 << 5)
 592 #define BGP_SHOW_OPT_FAILED (1 << 6)
 593 #define BGP_SHOW_OPT_DETAIL (1 << 7)
 594 #define BGP_SHOW_OPT_TERSE (1 << 8)
 595
 596 /* Prototypes. */
 597 extern void bgp_rib_remove(struct bgp_dest *dest, struct bgp_path_info *pi,
 598                            struct peer *peer, afi_t afi, safi_t safi);
 599 extern void bgp_process_queue_init(struct bgp *bgp);
 600 extern void bgp_route_init(void);
 601 extern void bgp_route_finish(void);
 602 extern void bgp_cleanup_routes(struct bgp *);
 603 extern void bgp_announce_route(struct peer *, afi_t, safi_t);
 604 extern void bgp_stop_announce_route_timer(struct peer_af *paf);
 605 extern void bgp_announce_route_all(struct peer *);
 606 extern void bgp_default_originate(struct peer *, afi_t, safi_t, int);
 607 extern void bgp_soft_reconfig_in(struct peer *, afi_t, safi_t);
 608 extern void bgp_clear_route(struct peer *, afi_t, safi_t);
 609 extern void bgp_clear_route_all(struct peer *);
 610 extern void bgp_clear_adj_in(struct peer *, afi_t, safi_t);
 611 extern void bgp_clear_stale_route(struct peer *, afi_t, safi_t);
 612 extern void bgp_set_stale_route(struct peer *peer, afi_t afi, safi_t safi);
 613 extern bool bgp_outbound_policy_exists(struct peer *, struct bgp_filter *);
 614 extern bool bgp_inbound_policy_exists(struct peer *, struct bgp_filter *);
 615
 616 extern struct bgp_dest *bgp_afi_node_get(struct bgp_table *table, afi_t afi,
 617                                          safi_t safi, const struct prefix *p,
 618                                          struct prefix_rd *prd);
 619 extern struct bgp_path_info *bgp_path_info_lock(struct bgp_path_info *path);
 620 extern struct bgp_path_info *bgp_path_info_unlock(struct bgp_path_info *path);
 621 extern void bgp_path_info_add(struct bgp_dest *dest, struct bgp_path_info *pi);
 622 extern void bgp_path_info_extra_free(struct bgp_path_info_extra **extra);
 623 extern void bgp_path_info_reap(struct bgp_dest *dest, struct bgp_path_info *pi);
 624 extern void bgp_path_info_delete(struct bgp_dest *dest,
 625                                  struct bgp_path_info *pi);
 626 extern struct bgp_path_info_extra *
 627 bgp_path_info_extra_get(struct bgp_path_info *path);
 628 extern void bgp_path_info_set_flag(struct bgp_dest *dest,
 629                                    struct bgp_path_info *path, uint32_t flag);
 630 extern void bgp_path_info_unset_flag(struct bgp_dest *dest,
 631                                      struct bgp_path_info *path, uint32_t flag);
 632 extern void bgp_path_info_path_with_addpath_rx_str(struct bgp_path_info *pi,
 633                                                    char *buf, size_t buf_len);
 634
 635 extern int bgp_nlri_parse_ip(struct peer *, struct attr *, struct bgp_nlri *);
 636
 637 extern bool bgp_maximum_prefix_overflow(struct peer *, afi_t, safi_t, int);
 638
 639 extern void bgp_redistribute_add(struct bgp *bgp, struct prefix *p,
 640                                  const union g_addr *nexthop, ifindex_t ifindex,
 641                                  enum nexthop_types_t nhtype, uint32_t metric,
 642                                  uint8_t type, unsigned short instance,
 643                                  route_tag_t tag);
 644 extern void bgp_redistribute_delete(struct bgp *, struct prefix *, uint8_t,
 645                                     unsigned short);
 646 extern void bgp_redistribute_withdraw(struct bgp *, afi_t, int, unsigned short);
 647
 648 extern void bgp_static_add(struct bgp *);
 649 extern void bgp_static_delete(struct bgp *);
 650 extern void bgp_static_redo_import_check(struct bgp *);
 651 extern void bgp_purge_static_redist_routes(struct bgp *bgp);
 652 extern void bgp_static_update(struct bgp *bgp, const struct prefix *p,
 653                               struct bgp_static *s, afi_t afi, safi_t safi);
 654 extern void bgp_static_withdraw(struct bgp *bgp, const struct prefix *p,
 655                                 afi_t afi, safi_t safi);
 656
 657 extern int bgp_static_set_safi(afi_t afi, safi_t safi, struct vty *vty,
 658                                const char *, const char *, const char *,
 659                                const char *, int, const char *, const char *,
 660                                const char *, const char *);
 661
 662 extern int bgp_static_unset_safi(afi_t afi, safi_t safi, struct vty *,
 663                                  const char *, const char *, const char *, int,
 664                                  const char *, const char *, const char *);
 665
 666 /* this is primarily for MPLS-VPN */
 667 extern int bgp_update(struct peer *peer, const struct prefix *p,
 668                       uint32_t addpath_id, struct attr *attr,
 669                       afi_t afi, safi_t safi, int type, int sub_type,
 670                       struct prefix_rd *prd, mpls_label_t *label,
 671                       uint32_t num_labels, int soft_reconfig,
 672                       struct bgp_route_evpn *evpn);
 673 extern int bgp_withdraw(struct peer *peer, const struct prefix *p,
 674                         uint32_t addpath_id, struct attr *attr, afi_t afi,
 675                         safi_t safi, int type, int sub_type,
 676                         struct prefix_rd *prd, mpls_label_t *label,
 677                         uint32_t num_labels, struct bgp_route_evpn *evpn);
 678
 679 /* for bgp_nexthop and bgp_damp */
 680 extern void bgp_process(struct bgp *, struct bgp_dest *, afi_t, safi_t);
 681
 682 /*
 683  * Add an end-of-initial-update marker to the process queue. This is just a
 684  * queue element with NULL bgp node.
 685  */
 686 extern void bgp_add_eoiu_mark(struct bgp *);
 687 extern void bgp_config_write_table_map(struct vty *, struct bgp *, afi_t,
 688                                        safi_t);
 689 extern void bgp_config_write_network(struct vty *, struct bgp *, afi_t, safi_t);
 690 extern void bgp_config_write_distance(struct vty *, struct bgp *, afi_t,
 691                                       safi_t);
 692
 693 extern void bgp_aggregate_delete(struct bgp *bgp, const struct prefix *p,
 694                                  afi_t afi, safi_t safi,
 695                                  struct bgp_aggregate *aggregate);
 696 extern void bgp_aggregate_route(struct bgp *bgp, const struct prefix *p,
 697                                 afi_t afi, safi_t safi,
 698                                 struct bgp_aggregate *aggregate);
 699 extern void bgp_aggregate_increment(struct bgp *bgp, const struct prefix *p,
 700                                     struct bgp_path_info *path, afi_t afi,
 701                                     safi_t safi);
 702 extern void bgp_aggregate_decrement(struct bgp *bgp, const struct prefix *p,
 703                                     struct bgp_path_info *path, afi_t afi,
 704                                     safi_t safi);
 705
 706 extern uint8_t bgp_distance_apply(const struct prefix *p,
 707                                   struct bgp_path_info *path, afi_t afi,
 708                                   safi_t safi, struct bgp *bgp);
 709
 710 extern afi_t bgp_node_afi(struct vty *);
 711 extern safi_t bgp_node_safi(struct vty *);
 712
 713 extern struct bgp_path_info *info_make(int type, int sub_type,
 714                                        unsigned short instance,
 715                                        struct peer *peer, struct attr *attr,
 716                                        struct bgp_dest *dest);
 717
 718 extern void route_vty_out(struct vty *vty, const struct prefix *p,
 719                           struct bgp_path_info *path, int display, safi_t safi,
 720                           json_object *json_paths, bool wide);
 721 extern void route_vty_out_tag(struct vty *vty, const struct prefix *p,
 722                               struct bgp_path_info *path, int display,
 723                               safi_t safi, json_object *json);
 724 extern void route_vty_out_tmp(struct vty *vty, struct bgp_dest *dest,
 725                               const struct prefix *p, struct attr *attr,
 726                               safi_t safi, bool use_json, json_object *json_ar,
 727                               bool wide);
 728 extern void route_vty_out_overlay(struct vty *vty, const struct prefix *p,
 729                                   struct bgp_path_info *path, int display,
 730                                   json_object *json);
 731
 732 extern void bgp_notify_conditional_adv_scanner(struct update_subgroup *subgrp);
 733
 734 extern void subgroup_process_announce_selected(struct update_subgroup *subgrp,
 735                                                struct bgp_path_info *selected,
 736                                                struct bgp_dest *dest,
 737                                                uint32_t addpath_tx_id);
 738
 739 extern bool subgroup_announce_check(struct bgp_dest *dest,
 740                                     struct bgp_path_info *pi,
 741                                     struct update_subgroup *subgrp,
 742                                     const struct prefix *p, struct attr *attr,
 743                                     bool skip_rmap_check);
 744
 745 extern void bgp_peer_clear_node_queue_drain_immediate(struct peer *peer);
 746 extern void bgp_process_queues_drain_immediate(void);
 747
 748 /* for encap/vpn */
 749 extern struct bgp_dest *bgp_afi_node_lookup(struct bgp_table *table, afi_t afi,
 750                                             safi_t safi, const struct prefix *p,
 751                                             struct prefix_rd *prd);
 752 extern void bgp_path_info_restore(struct bgp_dest *dest,
 753                                   struct bgp_path_info *path);
 754
 755 extern int bgp_path_info_cmp_compatible(struct bgp *bgp,
 756                                         struct bgp_path_info *new,
 757                                         struct bgp_path_info *exist,
 758                                         char *pfx_buf, afi_t afi, safi_t safi,
 759                                         enum bgp_path_selection_reason *reason);
 760 extern void bgp_attr_add_gshut_community(struct attr *attr);
 761
 762 extern void bgp_best_selection(struct bgp *bgp, struct bgp_dest *dest,
 763                                struct bgp_maxpaths_cfg *mpath_cfg,
 764                                struct bgp_path_info_pair *result, afi_t afi,
 765                                safi_t safi);
 766 extern void bgp_zebra_clear_route_change_flags(struct bgp_dest *dest);
 767 extern bool bgp_zebra_has_route_changed(struct bgp_path_info *selected);
 768
 769 extern void route_vty_out_detail_header(struct vty *vty, struct bgp *bgp,
 770                                         struct bgp_dest *dest,
 771                                         struct prefix_rd *prd, afi_t afi,
 772                                         safi_t safi, json_object *json);
 773 extern void route_vty_out_detail(struct vty *vty, struct bgp *bgp,
 774                                  struct bgp_dest *bn,
 775                                  struct bgp_path_info *path, afi_t afi,
 776                                  safi_t safi, enum rpki_states,
 777                                  json_object *json_paths);
 778 extern int bgp_show_table_rd(struct vty *vty, struct bgp *bgp, safi_t safi,
 779                              struct bgp_table *table, struct prefix_rd *prd,
 780                              enum bgp_show_type type, void *output_arg,
 781                              bool use_json);
 782 extern int bgp_best_path_select_defer(struct bgp *bgp, afi_t afi, safi_t safi);
 783 extern bool bgp_update_martian_nexthop(struct bgp *bgp, afi_t afi, safi_t safi,
 784                                        uint8_t type, uint8_t stype,
 785                                        struct attr *attr, struct bgp_dest *dest);
 786 extern int bgp_evpn_path_info_cmp(struct bgp *bgp, struct bgp_path_info *new,
 787                              struct bgp_path_info *exist, int *paths_eq);
 788 extern void bgp_aggregate_toggle_suppressed(struct bgp_aggregate *aggregate,
 789                                             struct bgp *bgp,
 790                                             const struct prefix *p, afi_t afi,
 791                                             safi_t safi, bool suppress);
 792 extern int bgp_static_set(struct bgp *bgp, const char *negate,
 793                           struct prefix *pfx, afi_t afi, safi_t safi,
 794                           const char *rmap, int backdoor, uint32_t label_index,
 795                           char *errmsg, size_t errmsg_len);
 796
 797 extern int bgp_aggregate_set(struct bgp *bgp, struct prefix *prefix, afi_t afi,
 798                              safi_t safi, const char *rmap,
 799                              uint8_t summary_only, uint8_t as_set,
 800                              uint8_t origin, bool match_med,
 801                              const char *suppress_map, char *errmsg,
 802                              size_t errmsg_len);
 803
 804 extern int bgp_aggregate_unset(struct bgp *bgp, struct prefix *prefix,
 805                                afi_t afi, safi_t safi, char *errmsg,
 806                                size_t errmsg_len);
 807
 808 extern void bgp_announce_routes_distance_update(struct bgp *bgp,
 809                                                 afi_t update_afi,
 810                                                 safi_t update_safi);
 811
 812 extern int bgp_distance_set(uint8_t distance, const char *ip_str,
 813                             const char *access_list_str, afi_t afi, safi_t safi,
 814                             char *errmsg, size_t errmsg_len);
 815
 816 extern int bgp_distance_unset(uint8_t distance, const char *ip_str,
 817                               const char *access_list_str, afi_t afi,
 818                               safi_t safi, char *errmsg, size_t errmsg_len);
 819 extern void subgroup_announce_reset_nhop(uint8_t family, struct attr *attr);
 820 #endif /* _QUAGGA_BGP_ROUTE_H */