[mirror_frr.git] / bgpd / bgp_route.h

/* BGP routing information base
 * Copyright (C) 1996, 97, 98, 2000 Kunihiro Ishiguro
 *
 * This file is part of GNU Zebra.
 *
 * GNU Zebra is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2, or (at your option) any
 * later version.
 *
 * GNU Zebra is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef _QUAGGA_BGP_ROUTE_H
#define _QUAGGA_BGP_ROUTE_H

#include "queue.h"
#include "bgp_table.h"

struct bgp_nexthop_cache;
struct bgp_route_evpn;

enum bgp_show_type
{
  bgp_show_type_normal,
  bgp_show_type_regexp,
  bgp_show_type_prefix_list,
  bgp_show_type_filter_list,
  bgp_show_type_route_map,
  bgp_show_type_neighbor,
  bgp_show_type_cidr_only,
  bgp_show_type_prefix_longer,
  bgp_show_type_community_all,
  bgp_show_type_community,
  bgp_show_type_community_exact,
  bgp_show_type_community_list,
  bgp_show_type_community_list_exact,
  bgp_show_type_lcommunity_all,
  bgp_show_type_lcommunity,
  bgp_show_type_lcommunity_list,
  bgp_show_type_flap_statistics,
  bgp_show_type_flap_neighbor,
  bgp_show_type_dampend_paths,
  bgp_show_type_damp_neighbor
};


#define BGP_SHOW_SCODE_HEADER "Status codes: s suppressed, d damped, "\
                              "h history, * valid, > best, = multipath,\n"\
                "              i internal, r RIB-failure, S Stale, R Removed\n"
#define BGP_SHOW_OCODE_HEADER "Origin codes: i - IGP, e - EGP, ? - incomplete\n\n"
#define BGP_SHOW_HEADER "   Network          Next Hop            Metric LocPrf Weight Path\n"

/* Ancillary information to struct bgp_info, 
 * used for uncommonly used data (aggregation, MPLS, etc.)
 * and lazily allocated to save memory.
 */
struct bgp_info_extra
{
  /* Pointer to dampening structure.  */
  struct bgp_damp_info *damp_info;

  /* This route is suppressed with aggregation.  */
  int suppress;

  /* Nexthop reachability check.  */
  u_int32_t igpmetric;

  /* MPLS label.  */
  mpls_label_t label;

#if ENABLE_BGP_VNC
  union {

      struct {
	  void *rfapi_handle;	/* export: NVE advertising this route */
	  struct list	*local_nexthops; /* optional, for static routes */
      } export;

      struct {
	  struct thread *timer;
	  void *hme;		/* encap monitor, if this is a VPN route */
	  struct prefix_rd rd;	/* import: route's route-distinguisher */
	  u_char un_family;	/* family of cached un address, 0 if unset */
	  union {
	    struct in_addr addr4;
	    struct in6_addr addr6;
	  } un;			/* cached un address */
	  time_t create_time;
	  struct prefix aux_prefix; /* AFI_L2VPN: the IP addr, if family set */
      } import;

  } vnc;
#endif

  /* For imported routes into a VNI (or VRF), this points to the parent. */
  void *parent;
};

struct bgp_info
{
  /* For linked list. */
  struct bgp_info *next;
  struct bgp_info *prev;

  /* For nexthop linked list */
  LIST_ENTRY(bgp_info) nh_thread;

  /* Back pointer to the prefix node */
  struct bgp_node *net;

  /* Back pointer to the nexthop structure */
  struct bgp_nexthop_cache *nexthop;

  /* Peer structure.  */
  struct peer *peer;

  /* Attribute structure.  */
  struct attr *attr;
  
  /* Extra information */
  struct bgp_info_extra *extra;
  

  /* Multipath information */
  struct bgp_info_mpath *mpath;

  /* Uptime.  */
  time_t uptime;

  /* reference count */
  int lock;
  
  /* BGP information status.  */
  u_int16_t flags;
#define BGP_INFO_IGP_CHANGED    (1 << 0)
#define BGP_INFO_DAMPED         (1 << 1)
#define BGP_INFO_HISTORY        (1 << 2)
#define BGP_INFO_SELECTED       (1 << 3)
#define BGP_INFO_VALID          (1 << 4)
#define BGP_INFO_ATTR_CHANGED   (1 << 5)
#define BGP_INFO_DMED_CHECK     (1 << 6)
#define BGP_INFO_DMED_SELECTED  (1 << 7)
#define BGP_INFO_STALE          (1 << 8)
#define BGP_INFO_REMOVED        (1 << 9)
#define BGP_INFO_COUNTED	(1 << 10)
#define BGP_INFO_MULTIPATH      (1 << 11)
#define BGP_INFO_MULTIPATH_CHG  (1 << 12)
#define BGP_INFO_RIB_ATTR_CHG   (1 << 13)

  /* BGP route type.  This can be static, RIP, OSPF, BGP etc.  */
  u_char type;

  /* When above type is BGP.  This sub type specify BGP sub type
     information.  */
  u_char sub_type;
#define BGP_ROUTE_NORMAL       0
#define BGP_ROUTE_STATIC       1
#define BGP_ROUTE_AGGREGATE    2
#define BGP_ROUTE_REDISTRIBUTE 3 
#ifdef ENABLE_BGP_VNC
# define BGP_ROUTE_RFP          4 
#endif

  u_short instance;

  /* Addpath identifiers */
  u_int32_t addpath_rx_id;
  u_int32_t addpath_tx_id;

};

/* Structure used in BGP path selection */
struct bgp_info_pair
{
  struct bgp_info *old;
  struct bgp_info *new;
};

/* BGP static route configuration. */
struct bgp_static
{
  /* Backdoor configuration.  */
  int backdoor;

  /* Label index configuration; applies to LU prefixes. */
  u_int32_t label_index;
#define BGP_INVALID_LABEL_INDEX   0xFFFFFFFF

  /* Import check status.  */
  u_char valid;

  /* IGP metric. */
  u_int32_t igpmetric;

  /* IGP nexthop. */
  struct in_addr igpnexthop;

  /* Atomic set reference count (ie cause of pathlimit) */
  u_int32_t atomic;
  
  /* BGP redistribute route-map.  */
  struct
  {
    char *name;
    struct route_map *map;
  } rmap;

  /* Route Distinguisher */
  struct prefix_rd     prd;

  /* MPLS label.  */
  mpls_label_t label;

  /* EVPN */
  struct eth_segment_id *eth_s_id;
  struct ethaddr *router_mac;
  uint16_t   encap_tunneltype;
  struct prefix gatewayIp;
};

#define BGP_NEXTHOP_AFI_FROM_NHLEN(nhlen) \
  ((nhlen) < IPV4_MAX_BYTELEN  ? 0 : \
   ((nhlen) < IPV6_MAX_BYTELEN ? AFI_IP : AFI_IP6))

#define BGP_ATTR_NEXTHOP_AFI_IP6(attr) \
  (! CHECK_FLAG (attr->flag, ATTR_FLAG_BIT (BGP_ATTR_NEXT_HOP)) && \
    ((attr)->mp_nexthop_len == 16 || \
    (attr)->mp_nexthop_len == 32))
#define BGP_INFO_COUNTABLE(BI) \
  (! CHECK_FLAG ((BI)->flags, BGP_INFO_HISTORY) \
   && ! CHECK_FLAG ((BI)->flags, BGP_INFO_REMOVED))

/* Flags which indicate a route is unuseable in some form */
#define BGP_INFO_UNUSEABLE \
  (BGP_INFO_HISTORY|BGP_INFO_DAMPED|BGP_INFO_REMOVED)
/* Macro to check BGP information is alive or not.  Sadly,
 * not equivalent to just checking previous, because of the
 * sense of the additional VALID flag.
 */
#define BGP_INFO_HOLDDOWN(BI) \
  (! CHECK_FLAG ((BI)->flags, BGP_INFO_VALID) \
   || CHECK_FLAG ((BI)->flags, BGP_INFO_UNUSEABLE))

#define DISTRIBUTE_IN_NAME(F)   ((F)->dlist[FILTER_IN].name)
#define DISTRIBUTE_IN(F)        ((F)->dlist[FILTER_IN].alist)
#define DISTRIBUTE_OUT_NAME(F)  ((F)->dlist[FILTER_OUT].name)
#define DISTRIBUTE_OUT(F)       ((F)->dlist[FILTER_OUT].alist)

#define PREFIX_LIST_IN_NAME(F)  ((F)->plist[FILTER_IN].name)
#define PREFIX_LIST_IN(F)       ((F)->plist[FILTER_IN].plist)
#define PREFIX_LIST_OUT_NAME(F) ((F)->plist[FILTER_OUT].name)
#define PREFIX_LIST_OUT(F)      ((F)->plist[FILTER_OUT].plist)

#define FILTER_LIST_IN_NAME(F)  ((F)->aslist[FILTER_IN].name)
#define FILTER_LIST_IN(F)       ((F)->aslist[FILTER_IN].aslist)
#define FILTER_LIST_OUT_NAME(F) ((F)->aslist[FILTER_OUT].name)
#define FILTER_LIST_OUT(F)      ((F)->aslist[FILTER_OUT].aslist)

#define ROUTE_MAP_IN_NAME(F)    ((F)->map[RMAP_IN].name)
#define ROUTE_MAP_IN(F)         ((F)->map[RMAP_IN].map)
#define ROUTE_MAP_OUT_NAME(F)   ((F)->map[RMAP_OUT].name)
#define ROUTE_MAP_OUT(F)        ((F)->map[RMAP_OUT].map)

#define UNSUPPRESS_MAP_NAME(F)  ((F)->usmap.name)
#define UNSUPPRESS_MAP(F)       ((F)->usmap.map)

/* path PREFIX (addpath rxid NUMBER) */
#define PATH_ADDPATH_STR_BUFFER PREFIX2STR_BUFFER + 32

enum bgp_path_type
{
  BGP_PATH_ALL,
  BGP_PATH_BESTPATH,
  BGP_PATH_MULTIPATH
};

static inline void
bgp_bump_version (struct bgp_node *node)
{
  node->version = bgp_table_next_version(bgp_node_table(node));
}

static inline int
bgp_fibupd_safi (safi_t safi)
{
  if (safi == SAFI_UNICAST ||
      safi == SAFI_MULTICAST ||
      safi == SAFI_LABELED_UNICAST)
    return 1;
  return 0;
}

/* Prototypes. */
extern void bgp_process_queue_init (void);
extern void bgp_route_init (void);
extern void bgp_route_finish (void);
extern void bgp_cleanup_routes (struct bgp *);
extern void bgp_announce_route (struct peer *, afi_t, safi_t);
extern void bgp_stop_announce_route_timer(struct peer_af *paf);
extern void bgp_announce_route_all (struct peer *);
extern void bgp_default_originate (struct peer *, afi_t, safi_t, int);
extern void bgp_soft_reconfig_in (struct peer *, afi_t, safi_t);
extern void bgp_clear_route (struct peer *, afi_t, safi_t);
extern void bgp_clear_route_all (struct peer *);
extern void bgp_clear_adj_in (struct peer *, afi_t, safi_t);
extern void bgp_clear_stale_route (struct peer *, afi_t, safi_t);

extern struct bgp_node *bgp_afi_node_get (struct bgp_table *table, afi_t afi,
                                          safi_t safi, struct prefix *p,
                                          struct prefix_rd *prd);
extern struct bgp_info *bgp_info_lock (struct bgp_info *);
extern struct bgp_info *bgp_info_unlock (struct bgp_info *);
extern void bgp_info_add (struct bgp_node *rn, struct bgp_info *ri);
extern void bgp_info_reap (struct bgp_node *rn, struct bgp_info *ri);
extern void bgp_info_delete (struct bgp_node *rn, struct bgp_info *ri);
extern struct bgp_info_extra *bgp_info_extra_get (struct bgp_info *);
extern void bgp_info_set_flag (struct bgp_node *, struct bgp_info *, u_int32_t);
extern void bgp_info_unset_flag (struct bgp_node *, struct bgp_info *, u_int32_t);
extern void bgp_info_path_with_addpath_rx_str (struct bgp_info *ri, char *buf);

extern int bgp_nlri_parse_ip (struct peer *, struct attr *, struct bgp_nlri *);

extern int bgp_maximum_prefix_overflow (struct peer *, afi_t, safi_t, int);

extern void bgp_redistribute_add (struct bgp *, struct prefix *, const struct in_addr *,
				  const struct in6_addr *, unsigned int ifindex,
				  u_int32_t, u_char, u_short, route_tag_t);
extern void bgp_redistribute_delete (struct bgp *, struct prefix *, u_char, u_short);
extern void bgp_redistribute_withdraw (struct bgp *, afi_t, int, u_short);

extern void bgp_static_add (struct bgp *);
extern void bgp_static_delete (struct bgp *);
extern void bgp_static_redo_import_check (struct bgp *);
extern void bgp_purge_static_redist_routes (struct bgp *bgp);
extern void bgp_static_update (struct bgp *, struct prefix *, struct bgp_static *,
			afi_t, safi_t);
extern void bgp_static_withdraw (struct bgp *, struct prefix *, afi_t, safi_t);
                     
extern int bgp_static_set_safi (afi_t afi, safi_t safi, struct vty *vty, const char *,
                                const char *, const char *, const char *,
                                int, const char *, const char *, const char *, const char *);

extern int bgp_static_unset_safi (afi_t afi, safi_t safi, struct vty *, const char *,
                                  const char *, const char *,
                                  int, const char *, const char *, const char *);

/* this is primarily for MPLS-VPN */
extern int bgp_update (struct peer *, struct prefix *, u_int32_t, struct attr *,
		       afi_t, safi_t, int, int, struct prefix_rd *,
		       mpls_label_t *, int, struct bgp_route_evpn *);
extern int bgp_withdraw (struct peer *, struct prefix *, u_int32_t, struct attr *,
			 afi_t, safi_t, int, int, struct prefix_rd *, mpls_label_t *,
                         struct bgp_route_evpn *);

/* for bgp_nexthop and bgp_damp */
extern void bgp_process (struct bgp *, struct bgp_node *, afi_t, safi_t);

/*
 * Add an end-of-initial-update marker to the process queue. This is just a
 * queue element with NULL bgp node.
 */
extern void bgp_add_eoiu_mark (struct bgp *);
extern int bgp_config_write_table_map (struct vty *, struct bgp *, afi_t, safi_t,
                                       int *);
extern int bgp_config_write_network (struct vty *, struct bgp *, afi_t, safi_t, int *);
extern int bgp_config_write_distance (struct vty *, struct bgp *, afi_t, safi_t, int *);

extern void bgp_aggregate_increment (struct bgp *, struct prefix *, struct bgp_info *,
			      afi_t, safi_t);
extern void bgp_aggregate_decrement (struct bgp *, struct prefix *, struct bgp_info *,
			      afi_t, safi_t);

extern u_char bgp_distance_apply (struct prefix *, struct bgp_info *, afi_t, safi_t, struct bgp *);

extern afi_t bgp_node_afi (struct vty *);
extern safi_t bgp_node_safi (struct vty *);

extern struct bgp_info *
info_make (int type, int sub_type, u_short instance, struct peer *peer,
           struct attr *attr, struct bgp_node *rn);

extern void route_vty_out (struct vty *, struct prefix *, struct bgp_info *, int, safi_t, json_object *);
extern void route_vty_out_tag (struct vty *, struct prefix *, struct bgp_info *, int, safi_t, json_object *);
extern void route_vty_out_tmp (struct vty *, struct prefix *, struct attr *, safi_t, u_char, json_object *);
extern void
route_vty_out_overlay (struct vty *vty, struct prefix *p,
                       struct bgp_info *binfo, int display, json_object *json);

extern int
subgroup_process_announce_selected (struct update_subgroup *subgrp,
				    struct bgp_info *selected,
                                    struct bgp_node *rn,
                                    u_int32_t addpath_tx_id);

extern int subgroup_announce_check(struct bgp_node *rn, struct bgp_info *ri,
				   struct update_subgroup *subgrp,
				   struct prefix *p, struct attr *attr);

extern void bgp_peer_clear_node_queue_drain_immediate (struct peer *peer);
extern void bgp_process_queues_drain_immediate (void);

/* for encap/vpn */
extern struct bgp_node *
bgp_afi_node_get (struct bgp_table *, afi_t , safi_t , struct prefix *,
 		  struct prefix_rd *);
extern struct bgp_node *
bgp_afi_node_lookup (struct bgp_table *table, afi_t afi, safi_t safi,
                     struct prefix *p, struct prefix_rd *prd);
extern struct bgp_info *bgp_info_new (void);
extern void bgp_info_restore (struct bgp_node *, struct bgp_info *);

extern int
bgp_info_cmp_compatible (struct bgp *, struct bgp_info *, struct bgp_info *,
                         char *pfx_buf, afi_t afi, safi_t safi);

extern void
bgp_best_selection (struct bgp *bgp, struct bgp_node *rn,
		    struct bgp_maxpaths_cfg *mpath_cfg,
		    struct bgp_info_pair *result,
                    afi_t afi, safi_t safi);
extern void bgp_zebra_clear_route_change_flags (struct bgp_node *rn);
extern int
bgp_zebra_has_route_changed (struct bgp_node *rn, struct bgp_info *selected);

extern void
route_vty_out_detail_header (struct vty *vty, struct bgp *bgp,
			     struct bgp_node *rn,
                             struct prefix_rd *prd, afi_t afi, safi_t safi,
                             json_object *json);
extern void
route_vty_out_detail (struct vty *vty, struct bgp *bgp, struct prefix *p, 
		      struct bgp_info *binfo, afi_t afi, safi_t safi,
                      json_object *json_paths);
#endif /* _QUAGGA_BGP_ROUTE_H */
Commit	Line	Data
718e3744	1	/* BGP routing information base
896014f4 DL	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	*/
718e3744	20
00d252cb	21	#ifndef _QUAGGA_BGP_ROUTE_H
	22	#define _QUAGGA_BGP_ROUTE_H
	23
fb018d25	24	#include "queue.h"
200df115	25	#include "bgp_table.h"
200df115	26
fb018d25	27	struct bgp_nexthop_cache;
7ef5a232	28	struct bgp_route_evpn;
fb018d25	29
b2f0fa55 PG	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,
c016b6c7 DS	45	bgp_show_type_lcommunity_all,
	46	bgp_show_type_lcommunity,
	47	bgp_show_type_lcommunity_list,
b2f0fa55 PG	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
3f9c7369	55	#define BGP_SHOW_SCODE_HEADER "Status codes: s suppressed, d damped, "\
181039f3 DL	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"
3f9c7369	60
fb982c25 PJ	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. */
9bedbb1e	77	mpls_label_t label;
65efcfce LB	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 {
b210b827	88	struct thread *timer;
65efcfce LB	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;
5ef6cd69	97	struct prefix aux_prefix; /* AFI_L2VPN: the IP addr, if family set */
65efcfce LB	98	} import;
	99
	100	} vnc;
	101	#endif
128ea8ab	102
	103	/* For imported routes into a VNI (or VRF), this points to the parent. */
	104	void *parent;
fb982c25 PJ	105	};
fb982c25 PJ	106
718e3744	107	struct bgp_info
	108	{
	109	/* For linked list. */
	110	struct bgp_info *next;
	111	struct bgp_info *prev;
fb018d25 DS	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
cbdfbaa5 PJ	122	/* Peer structure. */
	123	struct peer *peer;
	124
	125	/* Attribute structure. */
	126	struct attr *attr;
fb982c25 PJ	127
	128	/* Extra information */
	129	struct bgp_info_extra *extra;
	130
de8d5dff JB	131
	132	/* Multipath information */
	133	struct bgp_info_mpath *mpath;
	134
cbdfbaa5 PJ	135	/* Uptime. */
	136	time_t uptime;
	137
200df115	138	/* reference count */
228da428	139	int lock;
200df115	140
718e3744	141	/* BGP information status. */
93406d87	142	u_int16_t flags;
718e3744	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)
93406d87	151	#define BGP_INFO_STALE (1 << 8)
b40d939b	152	#define BGP_INFO_REMOVED (1 << 9)
902212c3	153	#define BGP_INFO_COUNTED (1 << 10)
de8d5dff JB	154	#define BGP_INFO_MULTIPATH (1 << 11)
de8d5dff JB	155	#define BGP_INFO_MULTIPATH_CHG (1 << 12)
cd1964ff	156	#define BGP_INFO_RIB_ATTR_CHG (1 << 13)
718e3744	157
cbdfbaa5 PJ	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
65efcfce LB	168	#ifdef ENABLE_BGP_VNC
	169	# define BGP_ROUTE_RFP 4
	170	#endif
7c8ff89e DS	171
	172	u_short instance;
	173
a82478b9 DS	174	/* Addpath identifiers */
	175	u_int32_t addpath_rx_id;
	176	u_int32_t addpath_tx_id;
	177
718e3744	178	};
718e3744	179
128ea8ab	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
718e3744	187	/* BGP static route configuration. */
	188	struct bgp_static
	189	{
	190	/* Backdoor configuration. */
	191	int backdoor;
	192
1b6d5c7e VV	193	/* Label index configuration; applies to LU prefixes. */
	194	u_int32_t label_index;
	195	#define BGP_INVALID_LABEL_INDEX 0xFFFFFFFF
	196
718e3744	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
41367172 PJ	206	/* Atomic set reference count (ie cause of pathlimit) */
	207	u_int32_t atomic;
	208
718e3744	209	/* BGP redistribute route-map. */
	210	struct
	211	{
	212	char *name;
	213	struct route_map *map;
	214	} rmap;
	215
137446f9 LB	216	/* Route Distinguisher */
	217	struct prefix_rd prd;
	218
718e3744	219	/* MPLS label. */
9bedbb1e	220	mpls_label_t label;
684a7227 PG	221
	222	/* EVPN */
	223	struct eth_segment_id *eth_s_id;
31689a53	224	struct ethaddr *router_mac;
aee875b5	225	uint16_t encap_tunneltype;
a2dac1ef	226	struct prefix gatewayIp;
718e3744	227	};
718e3744	228
fe3ca08f LB	229	#define BGP_NEXTHOP_AFI_FROM_NHLEN(nhlen) \
	230	((nhlen) < IPV4_MAX_BYTELEN ? 0 : \
	231	((nhlen) < IPV6_MAX_BYTELEN ? AFI_IP : AFI_IP6))
	232
8a92a8a0 DS	233	#define BGP_ATTR_NEXTHOP_AFI_IP6(attr) \
8a92a8a0 DS	234	(! CHECK_FLAG (attr->flag, ATTR_FLAG_BIT (BGP_ATTR_NEXT_HOP)) && \
aadc0905 DS	235	((attr)->mp_nexthop_len == 16 \|\| \
aadc0905 DS	236	(attr)->mp_nexthop_len == 32))
80e0ad24 DS	237	#define BGP_INFO_COUNTABLE(BI) \
	238	(! CHECK_FLAG ((BI)->flags, BGP_INFO_HISTORY) \
	239	&& ! CHECK_FLAG ((BI)->flags, BGP_INFO_REMOVED))
	240
1a392d46 PJ	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
718e3744	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
fee0f4c6	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
718e3744	272	#define UNSUPPRESS_MAP_NAME(F) ((F)->usmap.name)
	273	#define UNSUPPRESS_MAP(F) ((F)->usmap.map)
	274
2ec1e66f DW	275	/* path PREFIX (addpath rxid NUMBER) */
	276	#define PATH_ADDPATH_STR_BUFFER PREFIX2STR_BUFFER + 32
	277
4092b06c DS	278	enum bgp_path_type
	279	{
	280	BGP_PATH_ALL,
	281	BGP_PATH_BESTPATH,
	282	BGP_PATH_MULTIPATH
	283	};
	284
3f9c7369 DS	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
cd1964ff DS	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
718e3744	301	/* Prototypes. */
f188f2c4	302	extern void bgp_process_queue_init (void);
94f2b392	303	extern void bgp_route_init (void);
228da428	304	extern void bgp_route_finish (void);
0c6262ed	305	extern void bgp_cleanup_routes (struct bgp *);
94f2b392	306	extern void bgp_announce_route (struct peer *, afi_t, safi_t);
3f9c7369	307	extern void bgp_stop_announce_route_timer(struct peer_af *paf);
94f2b392	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);
2a3d5731	311	extern void bgp_clear_route (struct peer *, afi_t, safi_t);
94f2b392	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);
718e3744	315
4125bb67 DS	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);
200df115	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);
128ea8ab	322	extern void bgp_info_reap (struct bgp_node rn, struct bgp_info ri);
200df115	323	extern void bgp_info_delete (struct bgp_node rn, struct bgp_info ri);
fb982c25	324	extern struct bgp_info_extra bgp_info_extra_get (struct bgp_info );
1a392d46 PJ	325	extern void bgp_info_set_flag (struct bgp_node , struct bgp_info , u_int32_t);
1a392d46 PJ	326	extern void bgp_info_unset_flag (struct bgp_node , struct bgp_info , u_int32_t);
2ec1e66f	327	extern void bgp_info_path_with_addpath_rx_str (struct bgp_info ri, char buf);
200df115	328
96e52474	329	extern int bgp_nlri_parse_ip (struct peer , struct attr , struct bgp_nlri *);
718e3744	330
94f2b392	331	extern int bgp_maximum_prefix_overflow (struct peer *, afi_t, safi_t, int);
718e3744	332
6aeb9e78	333	extern void bgp_redistribute_add (struct bgp , struct prefix , const struct in_addr *,
bc413143	334	const struct in6_addr *, unsigned int ifindex,
dc9ffce8	335	u_int32_t, u_char, u_short, route_tag_t);
6aeb9e78	336	extern void bgp_redistribute_delete (struct bgp , struct prefix , u_char, u_short);
7c8ff89e	337	extern void bgp_redistribute_withdraw (struct bgp *, afi_t, int, u_short);
718e3744	338
6aeb9e78	339	extern void bgp_static_add (struct bgp *);
94f2b392	340	extern void bgp_static_delete (struct bgp *);
078430f6	341	extern void bgp_static_redo_import_check (struct bgp *);
ad4cbda1	342	extern void bgp_purge_static_redist_routes (struct bgp *bgp);
94f2b392	343	extern void bgp_static_update (struct bgp , struct prefix , struct bgp_static *,
718e3744	344	afi_t, safi_t);
94f2b392	345	extern void bgp_static_withdraw (struct bgp , struct prefix , afi_t, safi_t);
718e3744	346
201c3dac	347	extern int bgp_static_set_safi (afi_t afi, safi_t safi, struct vty vty, const char ,
3da6fcd5 PG	348	const char , const char , const char *,
3da6fcd5 PG	349	int, const char , const char , const char , const char );
718e3744	350
201c3dac	351	extern int bgp_static_unset_safi (afi_t afi, safi_t safi, struct vty , const char ,
3da6fcd5 PG	352	const char , const char ,
3da6fcd5 PG	353	int, const char , const char , const char *);
718e3744	354
94f2b392	355	/* this is primarily for MPLS-VPN */
a82478b9	356	extern int bgp_update (struct peer , struct prefix , u_int32_t, struct attr *,
7ef5a232	357	afi_t, safi_t, int, int, struct prefix_rd *,
9bedbb1e	358	mpls_label_t , int, struct bgp_route_evpn );
a82478b9	359	extern int bgp_withdraw (struct peer , struct prefix , u_int32_t, struct attr *,
9bedbb1e	360	afi_t, safi_t, int, int, struct prefix_rd , mpls_label_t ,
7ef5a232	361	struct bgp_route_evpn *);
718e3744	362
94f2b392	363	/* for bgp_nexthop and bgp_damp */
94f2b392	364	extern void bgp_process (struct bgp , struct bgp_node , afi_t, safi_t);
cb1faec9 DS	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	*/
2a3d5731	370	extern void bgp_add_eoiu_mark (struct bgp *);
73ac8160 DS	371	extern int bgp_config_write_table_map (struct vty , struct bgp , afi_t, safi_t,
73ac8160 DS	372	int *);
94f2b392	373	extern int bgp_config_write_network (struct vty , struct bgp , afi_t, safi_t, int *);
734b349e	374	extern int bgp_config_write_distance (struct vty , struct bgp , afi_t, safi_t, int *);
94f2b392	375
94f2b392	376	extern void bgp_aggregate_increment (struct bgp , struct prefix , struct bgp_info *,
718e3744	377	afi_t, safi_t);
94f2b392	378	extern void bgp_aggregate_decrement (struct bgp , struct prefix , struct bgp_info *,
718e3744	379	afi_t, safi_t);
718e3744	380
734b349e	381	extern u_char bgp_distance_apply (struct prefix , struct bgp_info , afi_t, safi_t, struct bgp *);
718e3744	382
94f2b392	383	extern afi_t bgp_node_afi (struct vty *);
94f2b392	384	extern safi_t bgp_node_safi (struct vty *);
5a646650	385
128ea8ab	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
b05a1c8b	390	extern void route_vty_out (struct vty , struct prefix , struct bgp_info , int, safi_t, json_object );
856ca177 MS	391	extern void route_vty_out_tag (struct vty , struct prefix , struct bgp_info , int, safi_t, json_object );
856ca177 MS	392	extern void route_vty_out_tmp (struct vty , struct prefix , struct attr , safi_t, u_char, json_object );
784d3a42 PG	393	extern void
	394	route_vty_out_overlay (struct vty vty, struct prefix p,
	395	struct bgp_info binfo, int display, json_object json);
00d252cb	396
3f9c7369 DS	397	extern int
	398	subgroup_process_announce_selected (struct update_subgroup *subgrp,
	399	struct bgp_info *selected,
adbac85e DW	400	struct bgp_node *rn,
adbac85e DW	401	u_int32_t addpath_tx_id);
3f9c7369	402
cd1964ff	403	extern int subgroup_announce_check(struct bgp_node rn, struct bgp_info ri,
3f9c7369 DS	404	struct update_subgroup *subgrp,
	405	struct prefix p, struct attr attr);
	406
bb86c601 LB	407	extern void bgp_peer_clear_node_queue_drain_immediate (struct peer *peer);
	408	extern void bgp_process_queues_drain_immediate (void);
	409
65efcfce LB	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 *);
128ea8ab	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);
65efcfce LB	417	extern struct bgp_info *bgp_info_new (void);
	418	extern void bgp_info_restore (struct bgp_node , struct bgp_info );
	419
128ea8ab	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);
65efcfce	432
520d5d76	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);
00d252cb	442	#endif /* _QUAGGA_BGP_ROUTE_H */