[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 GNU Zebra; see the file COPYING.  If not, write to the Free
Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
02111-1307, USA.  */

#ifndef _QUAGGA_BGP_ROUTE_H
#define _QUAGGA_BGP_ROUTE_H

#include "bgp_table.h"

/* 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.  */
  u_char tag[3];  
};

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

  /* Attribute structure.  */
  struct attr *attr;
  
  /* Extra information */
  struct bgp_info_extra *extra;
  
  /* 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)

  /* 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 
};

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

  /* 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;

  /* MPLS label.  */
  u_char tag[3];
};

/* 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 ROUTE_MAP_IMPORT_NAME(F)    ((F)->map[RMAP_IMPORT].name)
#define ROUTE_MAP_IMPORT(F)    ((F)->map[RMAP_IMPORT].map)
#define ROUTE_MAP_EXPORT_NAME(F)    ((F)->map[RMAP_EXPORT].name)
#define ROUTE_MAP_EXPORT(F)    ((F)->map[RMAP_EXPORT].map)

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

enum bgp_clear_route_type
{
  BGP_CLEAR_ROUTE_NORMAL,
  BGP_CLEAR_ROUTE_MY_RSCLIENT
};

/* Prototypes. */
extern void bgp_route_init (void);
extern void bgp_route_finish (void);
extern void bgp_cleanup_routes (void);
extern void bgp_announce_route (struct peer *, afi_t, safi_t);
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_soft_reconfig_rsclient (struct peer *, afi_t, safi_t);
extern void bgp_check_local_routes_rsclient (struct peer *rsclient, afi_t afi, safi_t safi);
extern void bgp_clear_route (struct peer *, afi_t, safi_t,
                             enum bgp_clear_route_type);
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_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_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 int bgp_nlri_sanity_check (struct peer *, int, u_char *, bgp_size_t);
extern int bgp_nlri_parse (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 prefix *, struct in_addr *, u_int32_t, u_char);
extern void bgp_redistribute_delete (struct prefix *, u_char);
extern void bgp_redistribute_withdraw (struct bgp *, afi_t, int);

extern void bgp_static_delete (struct 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_vpnv4 (struct vty *vty, const char *, 
                          const char *, const char *);

extern int bgp_static_unset_vpnv4 (struct vty *, const char *, 
                            const char *, const char *);

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

/* for bgp_nexthop and bgp_damp */
extern void bgp_process (struct bgp *, struct bgp_node *, afi_t, safi_t);
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 *);

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 *, struct bgp *);

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

extern void route_vty_out (struct vty *, struct prefix *, struct bgp_info *, int, safi_t);
extern void route_vty_out_tag (struct vty *, struct prefix *, struct bgp_info *, int, safi_t);
extern void route_vty_out_tmp (struct vty *, struct prefix *, struct attr *, safi_t);

#endif /* _QUAGGA_BGP_ROUTE_H */
Commit	Line	Data
718e3744	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
	17	along with GNU Zebra; see the file COPYING. If not, write to the Free
	18	Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
	19	02111-1307, USA. */
	20
00d252cb	21	#ifndef _QUAGGA_BGP_ROUTE_H
	22	#define _QUAGGA_BGP_ROUTE_H
	23
200df115	24	#include "bgp_table.h"
200df115	25
fb982c25 PJ	26	/* Ancillary information to struct bgp_info,
	27	* used for uncommonly used data (aggregation, MPLS, etc.)
	28	* and lazily allocated to save memory.
	29	*/
	30	struct bgp_info_extra
	31	{
	32	/* Pointer to dampening structure. */
	33	struct bgp_damp_info *damp_info;
	34
	35	/* This route is suppressed with aggregation. */
	36	int suppress;
	37
	38	/* Nexthop reachability check. */
	39	u_int32_t igpmetric;
	40
	41	/* MPLS label. */
	42	u_char tag[3];
	43	};
	44
718e3744	45	struct bgp_info
	46	{
	47	/* For linked list. */
	48	struct bgp_info *next;
	49	struct bgp_info *prev;
200df115	50
cbdfbaa5 PJ	51	/* Peer structure. */
	52	struct peer *peer;
	53
	54	/* Attribute structure. */
	55	struct attr *attr;
fb982c25 PJ	56
	57	/* Extra information */
	58	struct bgp_info_extra *extra;
	59
cbdfbaa5 PJ	60	/* Uptime. */
	61	time_t uptime;
	62
200df115	63	/* reference count */
228da428	64	int lock;
200df115	65
718e3744	66	/* BGP information status. */
93406d87	67	u_int16_t flags;
718e3744	68	#define BGP_INFO_IGP_CHANGED (1 << 0)
	69	#define BGP_INFO_DAMPED (1 << 1)
	70	#define BGP_INFO_HISTORY (1 << 2)
	71	#define BGP_INFO_SELECTED (1 << 3)
	72	#define BGP_INFO_VALID (1 << 4)
	73	#define BGP_INFO_ATTR_CHANGED (1 << 5)
	74	#define BGP_INFO_DMED_CHECK (1 << 6)
	75	#define BGP_INFO_DMED_SELECTED (1 << 7)
93406d87	76	#define BGP_INFO_STALE (1 << 8)
b40d939b	77	#define BGP_INFO_REMOVED (1 << 9)
902212c3	78	#define BGP_INFO_COUNTED (1 << 10)
718e3744	79
cbdfbaa5 PJ	80	/* BGP route type. This can be static, RIP, OSPF, BGP etc. */
	81	u_char type;
	82
	83	/* When above type is BGP. This sub type specify BGP sub type
	84	information. */
	85	u_char sub_type;
	86	#define BGP_ROUTE_NORMAL 0
	87	#define BGP_ROUTE_STATIC 1
	88	#define BGP_ROUTE_AGGREGATE 2
	89	#define BGP_ROUTE_REDISTRIBUTE 3
718e3744	90	};
	91
	92	/* BGP static route configuration. */
	93	struct bgp_static
	94	{
	95	/* Backdoor configuration. */
	96	int backdoor;
	97
	98	/* Import check status. */
	99	u_char valid;
	100
	101	/* IGP metric. */
	102	u_int32_t igpmetric;
	103
	104	/* IGP nexthop. */
	105	struct in_addr igpnexthop;
	106
41367172 PJ	107	/* Atomic set reference count (ie cause of pathlimit) */
	108	u_int32_t atomic;
	109
718e3744	110	/* BGP redistribute route-map. */
	111	struct
	112	{
	113	char *name;
	114	struct route_map *map;
	115	} rmap;
	116
	117	/* MPLS label. */
	118	u_char tag[3];
	119	};
	120
1a392d46 PJ	121	/* Flags which indicate a route is unuseable in some form */
	122	#define BGP_INFO_UNUSEABLE \
	123	(BGP_INFO_HISTORY\|BGP_INFO_DAMPED\|BGP_INFO_REMOVED)
	124	/* Macro to check BGP information is alive or not. Sadly,
	125	* not equivalent to just checking previous, because of the
	126	* sense of the additional VALID flag.
	127	*/
	128	#define BGP_INFO_HOLDDOWN(BI) \
	129	(! CHECK_FLAG ((BI)->flags, BGP_INFO_VALID) \
	130	\|\| CHECK_FLAG ((BI)->flags, BGP_INFO_UNUSEABLE))
	131
718e3744	132	#define DISTRIBUTE_IN_NAME(F) ((F)->dlist[FILTER_IN].name)
	133	#define DISTRIBUTE_IN(F) ((F)->dlist[FILTER_IN].alist)
	134	#define DISTRIBUTE_OUT_NAME(F) ((F)->dlist[FILTER_OUT].name)
	135	#define DISTRIBUTE_OUT(F) ((F)->dlist[FILTER_OUT].alist)
	136
	137	#define PREFIX_LIST_IN_NAME(F) ((F)->plist[FILTER_IN].name)
	138	#define PREFIX_LIST_IN(F) ((F)->plist[FILTER_IN].plist)
	139	#define PREFIX_LIST_OUT_NAME(F) ((F)->plist[FILTER_OUT].name)
	140	#define PREFIX_LIST_OUT(F) ((F)->plist[FILTER_OUT].plist)
	141
	142	#define FILTER_LIST_IN_NAME(F) ((F)->aslist[FILTER_IN].name)
	143	#define FILTER_LIST_IN(F) ((F)->aslist[FILTER_IN].aslist)
	144	#define FILTER_LIST_OUT_NAME(F) ((F)->aslist[FILTER_OUT].name)
	145	#define FILTER_LIST_OUT(F) ((F)->aslist[FILTER_OUT].aslist)
	146
fee0f4c6	147	#define ROUTE_MAP_IN_NAME(F) ((F)->map[RMAP_IN].name)
	148	#define ROUTE_MAP_IN(F) ((F)->map[RMAP_IN].map)
	149	#define ROUTE_MAP_OUT_NAME(F) ((F)->map[RMAP_OUT].name)
	150	#define ROUTE_MAP_OUT(F) ((F)->map[RMAP_OUT].map)
	151
	152	#define ROUTE_MAP_IMPORT_NAME(F) ((F)->map[RMAP_IMPORT].name)
	153	#define ROUTE_MAP_IMPORT(F) ((F)->map[RMAP_IMPORT].map)
	154	#define ROUTE_MAP_EXPORT_NAME(F) ((F)->map[RMAP_EXPORT].name)
	155	#define ROUTE_MAP_EXPORT(F) ((F)->map[RMAP_EXPORT].map)
718e3744	156
	157	#define UNSUPPRESS_MAP_NAME(F) ((F)->usmap.name)
	158	#define UNSUPPRESS_MAP(F) ((F)->usmap.map)
	159
228da428 CC	160	enum bgp_clear_route_type
	161	{
	162	BGP_CLEAR_ROUTE_NORMAL,
	163	BGP_CLEAR_ROUTE_MY_RSCLIENT
	164	};
	165
718e3744	166	/* Prototypes. */
94f2b392	167	extern void bgp_route_init (void);
228da428	168	extern void bgp_route_finish (void);
94f2b392	169	extern void bgp_cleanup_routes (void);
	170	extern void bgp_announce_route (struct peer *, afi_t, safi_t);
	171	extern void bgp_announce_route_all (struct peer *);
	172	extern void bgp_default_originate (struct peer *, afi_t, safi_t, int);
	173	extern void bgp_soft_reconfig_in (struct peer *, afi_t, safi_t);
	174	extern void bgp_soft_reconfig_rsclient (struct peer *, afi_t, safi_t);
	175	extern void bgp_check_local_routes_rsclient (struct peer *rsclient, afi_t afi, safi_t safi);
228da428 CC	176	extern void bgp_clear_route (struct peer *, afi_t, safi_t,
228da428 CC	177	enum bgp_clear_route_type);
94f2b392	178	extern void bgp_clear_route_all (struct peer *);
	179	extern void bgp_clear_adj_in (struct peer *, afi_t, safi_t);
	180	extern void bgp_clear_stale_route (struct peer *, afi_t, safi_t);
718e3744	181
200df115	182	extern struct bgp_info bgp_info_lock (struct bgp_info );
	183	extern struct bgp_info bgp_info_unlock (struct bgp_info );
	184	extern void bgp_info_add (struct bgp_node rn, struct bgp_info ri);
	185	extern void bgp_info_delete (struct bgp_node rn, struct bgp_info ri);
fb982c25	186	extern struct bgp_info_extra bgp_info_extra_get (struct bgp_info );
1a392d46 PJ	187	extern void bgp_info_set_flag (struct bgp_node , struct bgp_info , u_int32_t);
1a392d46 PJ	188	extern void bgp_info_unset_flag (struct bgp_node , struct bgp_info , u_int32_t);
200df115	189
94f2b392	190	extern int bgp_nlri_sanity_check (struct peer , int, u_char , bgp_size_t);
94f2b392	191	extern int bgp_nlri_parse (struct peer , struct attr , struct bgp_nlri *);
718e3744	192
94f2b392	193	extern int bgp_maximum_prefix_overflow (struct peer *, afi_t, safi_t, int);
718e3744	194
94f2b392	195	extern void bgp_redistribute_add (struct prefix , struct in_addr , u_int32_t, u_char);
	196	extern void bgp_redistribute_delete (struct prefix *, u_char);
	197	extern void bgp_redistribute_withdraw (struct bgp *, afi_t, int);
718e3744	198
94f2b392	199	extern void bgp_static_delete (struct bgp *);
94f2b392	200	extern void bgp_static_update (struct bgp , struct prefix , struct bgp_static *,
718e3744	201	afi_t, safi_t);
94f2b392	202	extern void bgp_static_withdraw (struct bgp , struct prefix , afi_t, safi_t);
718e3744	203
94f2b392	204	extern int bgp_static_set_vpnv4 (struct vty vty, const char ,
fd79ac91	205	const char , const char );
718e3744	206
94f2b392	207	extern int bgp_static_unset_vpnv4 (struct vty , const char ,
fd79ac91	208	const char , const char );
718e3744	209
94f2b392	210	/* this is primarily for MPLS-VPN */
	211	extern int bgp_update (struct peer , struct prefix , struct attr *,
	212	afi_t, safi_t, int, int, struct prefix_rd *,
	213	u_char *, int);
	214	extern int bgp_withdraw (struct peer , struct prefix , struct attr *,
	215	afi_t, safi_t, int, int, struct prefix_rd , u_char );
718e3744	216
94f2b392	217	/* for bgp_nexthop and bgp_damp */
94f2b392	218	extern void bgp_process (struct bgp , struct bgp_node , afi_t, safi_t);
94f2b392	219	extern int bgp_config_write_network (struct vty , struct bgp , afi_t, safi_t, int *);
	220	extern int bgp_config_write_distance (struct vty , struct bgp );
	221
	222	extern void bgp_aggregate_increment (struct bgp , struct prefix , struct bgp_info *,
718e3744	223	afi_t, safi_t);
94f2b392	224	extern void bgp_aggregate_decrement (struct bgp , struct prefix , struct bgp_info *,
718e3744	225	afi_t, safi_t);
718e3744	226
94f2b392	227	extern u_char bgp_distance_apply (struct prefix , struct bgp_info , struct bgp *);
718e3744	228
94f2b392	229	extern afi_t bgp_node_afi (struct vty *);
94f2b392	230	extern safi_t bgp_node_safi (struct vty *);
5a646650	231
94f2b392	232	extern void route_vty_out (struct vty , struct prefix , struct bgp_info *, int, safi_t);
	233	extern void route_vty_out_tag (struct vty , struct prefix , struct bgp_info *, int, safi_t);
	234	extern void route_vty_out_tmp (struct vty , struct prefix , struct attr *, safi_t);
00d252cb	235
00d252cb	236	#endif /* _QUAGGA_BGP_ROUTE_H */