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