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