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