bgpd/bgp_route.h

   1 /* BGP routing information base
   2  * Copyright (C) 1996, 97, 98, 2000 Kunihiro Ishiguro
   3  *
   4  * This file is part of GNU Zebra.
   5  *
   6  * GNU Zebra is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; either version 2, or (at your option) any
   9  * later version.
  10  *
  11  * GNU Zebra is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; see the file COPYING; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef _QUAGGA_BGP_ROUTE_H
  22 #define _QUAGGA_BGP_ROUTE_H
  23
  24 #include "queue.h"
  25 #include "nexthop.h"
  26 #include "bgp_table.h"
  27
  28 struct bgp_nexthop_cache;
  29 struct bgp_route_evpn;
  30
  31 enum bgp_show_type {
  32         bgp_show_type_normal,
  33         bgp_show_type_regexp,
  34         bgp_show_type_prefix_list,
  35         bgp_show_type_filter_list,
  36         bgp_show_type_route_map,
  37         bgp_show_type_neighbor,
  38         bgp_show_type_cidr_only,
  39         bgp_show_type_prefix_longer,
  40         bgp_show_type_community_all,
  41         bgp_show_type_community,
  42         bgp_show_type_community_exact,
  43         bgp_show_type_community_list,
  44         bgp_show_type_community_list_exact,
  45         bgp_show_type_lcommunity_all,
  46         bgp_show_type_lcommunity,
  47         bgp_show_type_lcommunity_list,
  48         bgp_show_type_flap_statistics,
  49         bgp_show_type_flap_neighbor,
  50         bgp_show_type_dampend_paths,
  51         bgp_show_type_damp_neighbor
  52 };
  53
  54
  55 #define BGP_SHOW_SCODE_HEADER                                                  \
  56         "Status codes: s suppressed, d damped, "                               \
  57         "h history, * valid, > best, = multipath,\n"                           \
  58         "              i internal, r RIB-failure, S Stale, R Removed\n"
  59 #define BGP_SHOW_OCODE_HEADER "Origin codes: i - IGP, e - EGP, ? - incomplete\n\n"
  60 #define BGP_SHOW_HEADER "   Network          Next Hop            Metric LocPrf Weight Path\n"
  61
  62 /* Maximum number of labels we can process or send with a prefix. We
  63  * really do only 1 for MPLS (BGP-LU) but we can do 2 for EVPN-VxLAN.
  64  */
  65 #define BGP_MAX_LABELS 2
  66
  67 /* Ancillary information to struct bgp_info,
  68  * used for uncommonly used data (aggregation, MPLS, etc.)
  69  * and lazily allocated to save memory.
  70  */
  71 struct bgp_info_extra {
  72         /* Pointer to dampening structure.  */
  73         struct bgp_damp_info *damp_info;
  74
  75         /* This route is suppressed with aggregation.  */
  76         int suppress;
  77
  78         /* Nexthop reachability check.  */
  79         u_int32_t igpmetric;
  80
  81         /* MPLS label(s) - VNI(s) for EVPN-VxLAN  */
  82         mpls_label_t label[BGP_MAX_LABELS];
  83         u_int32_t num_labels;
  84
  85 #if ENABLE_BGP_VNC
  86         union {
  87
  88                 struct {
  89                         void *rfapi_handle; /* export: NVE advertising this
  90                                                route */
  91                         struct list *local_nexthops; /* optional, for static
  92                                                         routes */
  93                 } export;
  94
  95                 struct {
  96                         struct thread *timer;
  97                         void *hme; /* encap monitor, if this is a VPN route */
  98                         struct prefix_rd
  99                                 rd; /* import: route's route-distinguisher */
 100                         u_char un_family; /* family of cached un address, 0 if
 101                                              unset */
 102                         union {
 103                                 struct in_addr addr4;
 104                                 struct in6_addr addr6;
 105                         } un; /* cached un address */
 106                         time_t create_time;
 107                         struct prefix aux_prefix; /* AFI_L2VPN: the IP addr,
 108                                                      if family set */
 109                 } import;
 110
 111         } vnc;
 112 #endif
 113
 114         /* For imported routes into a VNI (or VRF), this points to the parent.
 115          */
 116         void *parent;
 117 };
 118
 119 struct bgp_info {
 120         /* For linked list. */
 121         struct bgp_info *next;
 122         struct bgp_info *prev;
 123
 124         /* For nexthop linked list */
 125         LIST_ENTRY(bgp_info) nh_thread;
 126
 127         /* Back pointer to the prefix node */
 128         struct bgp_node *net;
 129
 130         /* Back pointer to the nexthop structure */
 131         struct bgp_nexthop_cache *nexthop;
 132
 133         /* Peer structure.  */
 134         struct peer *peer;
 135
 136         /* Attribute structure.  */
 137         struct attr *attr;
 138
 139         /* Extra information */
 140         struct bgp_info_extra *extra;
 141
 142
 143         /* Multipath information */
 144         struct bgp_info_mpath *mpath;
 145
 146         /* Uptime.  */
 147         time_t uptime;
 148
 149         /* reference count */
 150         int lock;
 151
 152         /* BGP information status.  */
 153         u_int16_t flags;
 154 #define BGP_INFO_IGP_CHANGED    (1 << 0)
 155 #define BGP_INFO_DAMPED         (1 << 1)
 156 #define BGP_INFO_HISTORY        (1 << 2)
 157 #define BGP_INFO_SELECTED       (1 << 3)
 158 #define BGP_INFO_VALID          (1 << 4)
 159 #define BGP_INFO_ATTR_CHANGED   (1 << 5)
 160 #define BGP_INFO_DMED_CHECK     (1 << 6)
 161 #define BGP_INFO_DMED_SELECTED  (1 << 7)
 162 #define BGP_INFO_STALE          (1 << 8)
 163 #define BGP_INFO_REMOVED        (1 << 9)
 164 #define BGP_INFO_COUNTED        (1 << 10)
 165 #define BGP_INFO_MULTIPATH      (1 << 11)
 166 #define BGP_INFO_MULTIPATH_CHG  (1 << 12)
 167 #define BGP_INFO_RIB_ATTR_CHG   (1 << 13)
 168
 169         /* BGP route type.  This can be static, RIP, OSPF, BGP etc.  */
 170         u_char type;
 171
 172         /* When above type is BGP.  This sub type specify BGP sub type
 173            information.  */
 174         u_char sub_type;
 175 #define BGP_ROUTE_NORMAL       0
 176 #define BGP_ROUTE_STATIC       1
 177 #define BGP_ROUTE_AGGREGATE    2
 178 #define BGP_ROUTE_REDISTRIBUTE 3
 179 #ifdef ENABLE_BGP_VNC
 180 # define BGP_ROUTE_RFP          4
 181 #endif
 182
 183         u_short instance;
 184
 185         /* Addpath identifiers */
 186         u_int32_t addpath_rx_id;
 187         u_int32_t addpath_tx_id;
 188 };
 189
 190 /* Structure used in BGP path selection */
 191 struct bgp_info_pair {
 192         struct bgp_info *old;
 193         struct bgp_info *new;
 194 };
 195
 196 /* BGP static route configuration. */
 197 struct bgp_static {
 198         /* Backdoor configuration.  */
 199         int backdoor;
 200
 201         /* Label index configuration; applies to LU prefixes. */
 202         u_int32_t label_index;
 203 #define BGP_INVALID_LABEL_INDEX   0xFFFFFFFF
 204
 205         /* Import check status.  */
 206         u_char valid;
 207
 208         /* IGP metric. */
 209         u_int32_t igpmetric;
 210
 211         /* IGP nexthop. */
 212         struct in_addr igpnexthop;
 213
 214         /* Atomic set reference count (ie cause of pathlimit) */
 215         u_int32_t atomic;
 216
 217         /* BGP redistribute route-map.  */
 218         struct {
 219                 char *name;
 220                 struct route_map *map;
 221         } rmap;
 222
 223         /* Route Distinguisher */
 224         struct prefix_rd prd;
 225
 226         /* MPLS label.  */
 227         mpls_label_t label;
 228
 229         /* EVPN */
 230         struct eth_segment_id *eth_s_id;
 231         struct ethaddr *router_mac;
 232         uint16_t encap_tunneltype;
 233         struct prefix gatewayIp;
 234 };
 235
 236 #define BGP_NEXTHOP_AFI_FROM_NHLEN(nhlen)                                      \
 237         ((nhlen) < IPV4_MAX_BYTELEN                                            \
 238                  ? 0                                                           \
 239                  : ((nhlen) < IPV6_MAX_BYTELEN ? AFI_IP : AFI_IP6))
 240
 241 #define BGP_ATTR_NEXTHOP_AFI_IP6(attr)                                         \
 242         (!CHECK_FLAG(attr->flag, ATTR_FLAG_BIT(BGP_ATTR_NEXT_HOP))             \
 243          && ((attr)->mp_nexthop_len == 16 || (attr)->mp_nexthop_len == 32))
 244 #define BGP_INFO_COUNTABLE(BI)                                                 \
 245         (!CHECK_FLAG((BI)->flags, BGP_INFO_HISTORY)                            \
 246          && !CHECK_FLAG((BI)->flags, BGP_INFO_REMOVED))
 247
 248 /* Flags which indicate a route is unuseable in some form */
 249 #define BGP_INFO_UNUSEABLE                                                     \
 250         (BGP_INFO_HISTORY | BGP_INFO_DAMPED | BGP_INFO_REMOVED)
 251 /* Macro to check BGP information is alive or not.  Sadly,
 252  * not equivalent to just checking previous, because of the
 253  * sense of the additional VALID flag.
 254  */
 255 #define BGP_INFO_HOLDDOWN(BI)                                                  \
 256         (!CHECK_FLAG((BI)->flags, BGP_INFO_VALID)                              \
 257          || CHECK_FLAG((BI)->flags, BGP_INFO_UNUSEABLE))
 258
 259 #define DISTRIBUTE_IN_NAME(F)   ((F)->dlist[FILTER_IN].name)
 260 #define DISTRIBUTE_IN(F)        ((F)->dlist[FILTER_IN].alist)
 261 #define DISTRIBUTE_OUT_NAME(F)  ((F)->dlist[FILTER_OUT].name)
 262 #define DISTRIBUTE_OUT(F)       ((F)->dlist[FILTER_OUT].alist)
 263
 264 #define PREFIX_LIST_IN_NAME(F)  ((F)->plist[FILTER_IN].name)
 265 #define PREFIX_LIST_IN(F)       ((F)->plist[FILTER_IN].plist)
 266 #define PREFIX_LIST_OUT_NAME(F) ((F)->plist[FILTER_OUT].name)
 267 #define PREFIX_LIST_OUT(F)      ((F)->plist[FILTER_OUT].plist)
 268
 269 #define FILTER_LIST_IN_NAME(F)  ((F)->aslist[FILTER_IN].name)
 270 #define FILTER_LIST_IN(F)       ((F)->aslist[FILTER_IN].aslist)
 271 #define FILTER_LIST_OUT_NAME(F) ((F)->aslist[FILTER_OUT].name)
 272 #define FILTER_LIST_OUT(F)      ((F)->aslist[FILTER_OUT].aslist)
 273
 274 #define ROUTE_MAP_IN_NAME(F)    ((F)->map[RMAP_IN].name)
 275 #define ROUTE_MAP_IN(F)         ((F)->map[RMAP_IN].map)
 276 #define ROUTE_MAP_OUT_NAME(F)   ((F)->map[RMAP_OUT].name)
 277 #define ROUTE_MAP_OUT(F)        ((F)->map[RMAP_OUT].map)
 278
 279 #define UNSUPPRESS_MAP_NAME(F)  ((F)->usmap.name)
 280 #define UNSUPPRESS_MAP(F)       ((F)->usmap.map)
 281
 282 /* path PREFIX (addpath rxid NUMBER) */
 283 #define PATH_ADDPATH_STR_BUFFER PREFIX2STR_BUFFER + 32
 284
 285 enum bgp_path_type { BGP_PATH_ALL, BGP_PATH_BESTPATH, BGP_PATH_MULTIPATH };
 286
 287 static inline void bgp_bump_version(struct bgp_node *node)
 288 {
 289         node->version = bgp_table_next_version(bgp_node_table(node));
 290 }
 291
 292 static inline int bgp_fibupd_safi(safi_t safi)
 293 {
 294         if (safi == SAFI_UNICAST || safi == SAFI_MULTICAST
 295             || safi == SAFI_LABELED_UNICAST)
 296                 return 1;
 297         return 0;
 298 }
 299
 300 /* Prototypes. */
 301 extern void bgp_rib_remove(struct bgp_node *rn, struct bgp_info *ri,
 302                            struct peer *peer, afi_t afi, safi_t safi);
 303 extern void bgp_process_queue_init(void);
 304 extern void bgp_route_init(void);
 305 extern void bgp_route_finish(void);
 306 extern void bgp_cleanup_routes(struct bgp *);
 307 extern void bgp_announce_route(struct peer *, afi_t, safi_t);
 308 extern void bgp_stop_announce_route_timer(struct peer_af *paf);
 309 extern void bgp_announce_route_all(struct peer *);
 310 extern void bgp_default_originate(struct peer *, afi_t, safi_t, int);
 311 extern void bgp_soft_reconfig_in(struct peer *, afi_t, safi_t);
 312 extern void bgp_clear_route(struct peer *, afi_t, safi_t);
 313 extern void bgp_clear_route_all(struct peer *);
 314 extern void bgp_clear_adj_in(struct peer *, afi_t, safi_t);
 315 extern void bgp_clear_stale_route(struct peer *, afi_t, safi_t);
 316
 317 extern struct bgp_node *bgp_afi_node_get(struct bgp_table *table, afi_t afi,
 318                                          safi_t safi, struct prefix *p,
 319                                          struct prefix_rd *prd);
 320 extern struct bgp_info *bgp_info_lock(struct bgp_info *);
 321 extern struct bgp_info *bgp_info_unlock(struct bgp_info *);
 322 extern void bgp_info_add(struct bgp_node *rn, struct bgp_info *ri);
 323 extern void bgp_info_reap(struct bgp_node *rn, struct bgp_info *ri);
 324 extern void bgp_info_delete(struct bgp_node *rn, struct bgp_info *ri);
 325 extern struct bgp_info_extra *bgp_info_extra_get(struct bgp_info *);
 326 extern void bgp_info_set_flag(struct bgp_node *, struct bgp_info *, u_int32_t);
 327 extern void bgp_info_unset_flag(struct bgp_node *, struct bgp_info *,
 328                                 u_int32_t);
 329 extern void bgp_info_path_with_addpath_rx_str(struct bgp_info *ri, char *buf);
 330
 331 extern int bgp_nlri_parse_ip(struct peer *, struct attr *, struct bgp_nlri *);
 332
 333 extern int bgp_maximum_prefix_overflow(struct peer *, afi_t, safi_t, int);
 334
 335 extern void bgp_redistribute_add(struct bgp *bgp, struct prefix *p,
 336                                  const union g_addr *nexthop, ifindex_t ifindex,
 337                                  enum nexthop_types_t nhtype, uint32_t metric,
 338                                  u_char type, u_short instance,
 339                                  route_tag_t tag);
 340 extern void bgp_redistribute_delete(struct bgp *, struct prefix *, u_char,
 341                                     u_short);
 342 extern void bgp_redistribute_withdraw(struct bgp *, afi_t, int, u_short);
 343
 344 extern void bgp_static_add(struct bgp *);
 345 extern void bgp_static_delete(struct bgp *);
 346 extern void bgp_static_redo_import_check(struct bgp *);
 347 extern void bgp_purge_static_redist_routes(struct bgp *bgp);
 348 extern void bgp_static_update(struct bgp *, struct prefix *,
 349                               struct bgp_static *, afi_t, safi_t);
 350 extern void bgp_static_withdraw(struct bgp *, struct prefix *, afi_t, safi_t);
 351
 352 extern int bgp_static_set_safi(afi_t afi, safi_t safi, struct vty *vty,
 353                                const char *, const char *, const char *,
 354                                const char *, int, const char *, const char *,
 355                                const char *, const char *);
 356
 357 extern int bgp_static_unset_safi(afi_t afi, safi_t safi, struct vty *,
 358                                  const char *, const char *, const char *, int,
 359                                  const char *, const char *, const char *);
 360
 361 /* this is primarily for MPLS-VPN */
 362 extern int bgp_update(struct peer *, struct prefix *, u_int32_t, struct attr *,
 363                       afi_t, safi_t, int, int, struct prefix_rd *,
 364                       mpls_label_t *, u_int32_t, int, struct bgp_route_evpn *);
 365 extern int bgp_withdraw(struct peer *, struct prefix *, u_int32_t,
 366                         struct attr *, afi_t, safi_t, int, int,
 367                         struct prefix_rd *, mpls_label_t *, u_int32_t,
 368                         struct bgp_route_evpn *);
 369
 370 /* for bgp_nexthop and bgp_damp */
 371 extern void bgp_process(struct bgp *, struct bgp_node *, afi_t, safi_t);
 372
 373 /*
 374  * Add an end-of-initial-update marker to the process queue. This is just a
 375  * queue element with NULL bgp node.
 376  */
 377 extern void bgp_add_eoiu_mark(struct bgp *);
 378 extern void bgp_config_write_table_map(struct vty *, struct bgp *, afi_t,
 379                                        safi_t);
 380 extern void bgp_config_write_network(struct vty *, struct bgp *, afi_t, safi_t);
 381 extern void bgp_config_write_distance(struct vty *, struct bgp *, afi_t,
 382                                       safi_t);
 383
 384 extern void bgp_aggregate_increment(struct bgp *, struct prefix *,
 385                                     struct bgp_info *, afi_t, safi_t);
 386 extern void bgp_aggregate_decrement(struct bgp *, struct prefix *,
 387                                     struct bgp_info *, afi_t, safi_t);
 388
 389 extern u_char bgp_distance_apply(struct prefix *, struct bgp_info *, afi_t,
 390                                  safi_t, struct bgp *);
 391
 392 extern afi_t bgp_node_afi(struct vty *);
 393 extern safi_t bgp_node_safi(struct vty *);
 394
 395 extern struct bgp_info *info_make(int type, int sub_type, u_short instance,
 396                                   struct peer *peer, struct attr *attr,
 397                                   struct bgp_node *rn);
 398
 399 extern void route_vty_out(struct vty *, struct prefix *, struct bgp_info *, int,
 400                           safi_t, json_object *);
 401 extern void route_vty_out_tag(struct vty *, struct prefix *, struct bgp_info *,
 402                               int, safi_t, json_object *);
 403 extern void route_vty_out_tmp(struct vty *, struct prefix *, struct attr *,
 404                               safi_t, u_char, json_object *);
 405 extern void route_vty_out_overlay(struct vty *vty, struct prefix *p,
 406                                   struct bgp_info *binfo, int display,
 407                                   json_object *json);
 408
 409 extern int subgroup_process_announce_selected(struct update_subgroup *subgrp,
 410                                               struct bgp_info *selected,
 411                                               struct bgp_node *rn,
 412                                               u_int32_t addpath_tx_id);
 413
 414 extern int subgroup_announce_check(struct bgp_node *rn, struct bgp_info *ri,
 415                                    struct update_subgroup *subgrp,
 416                                    struct prefix *p, struct attr *attr);
 417
 418 extern void bgp_peer_clear_node_queue_drain_immediate(struct peer *peer);
 419 extern void bgp_process_queues_drain_immediate(void);
 420
 421 /* for encap/vpn */
 422 extern struct bgp_node *bgp_afi_node_lookup(struct bgp_table *table, afi_t afi,
 423                                             safi_t safi, struct prefix *p,
 424                                             struct prefix_rd *prd);
 425 extern struct bgp_info *bgp_info_new(void);
 426 extern void bgp_info_restore(struct bgp_node *, struct bgp_info *);
 427
 428 extern int bgp_info_cmp_compatible(struct bgp *, struct bgp_info *,
 429                                    struct bgp_info *, char *pfx_buf, afi_t afi,
 430                                    safi_t safi);
 431 extern void bgp_attr_add_gshut_community(struct attr *attr);
 432
 433 extern void bgp_best_selection(struct bgp *bgp, struct bgp_node *rn,
 434                                struct bgp_maxpaths_cfg *mpath_cfg,
 435                                struct bgp_info_pair *result, afi_t afi,
 436                                safi_t safi);
 437 extern void bgp_zebra_clear_route_change_flags(struct bgp_node *rn);
 438 extern int bgp_zebra_has_route_changed(struct bgp_node *rn,
 439                                        struct bgp_info *selected);
 440
 441 extern void route_vty_out_detail_header(struct vty *vty, struct bgp *bgp,
 442                                         struct bgp_node *rn,
 443                                         struct prefix_rd *prd, afi_t afi,
 444                                         safi_t safi, json_object *json);
 445 extern void route_vty_out_detail(struct vty *vty, struct bgp *bgp,
 446                                  struct prefix *p, struct bgp_info *binfo,
 447                                  afi_t afi, safi_t safi,
 448                                  json_object *json_paths);
 449 extern int bgp_show_table_rd(struct vty *vty, struct bgp *bgp, safi_t safi,
 450                              struct bgp_table *table, struct prefix_rd *prd,
 451                              enum bgp_show_type type, void *output_arg,
 452                              u_char use_json);
 453 #endif /* _QUAGGA_BGP_ROUTE_H */