back to topotato report
topotato coverage report
Current view: top level - bgpd - bgp_route.h (source / functions) Hit Total Coverage
Test: test_bgp_set_aspath_replace.py::BGPSetAspathReplace Lines: 12 45 26.7 %
Date: 2023-02-24 18:37:49 Functions: 2 4 50.0 %

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

Generated by: LCOV version v1.16-topotato