[mirror_frr.git] / bgpd / bgp_attr.h

/* BGP attributes. 
   Copyright (C) 1996, 97, 98 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_ATTR_H
#define _QUAGGA_BGP_ATTR_H

/* Simple bit mapping. */
#define BITMAP_NBBY 8

#define SET_BITMAP(MAP, NUM) \
        SET_FLAG (MAP[(NUM) / BITMAP_NBBY], 1 << ((NUM) % BITMAP_NBBY))

#define CHECK_BITMAP(MAP, NUM) \
        CHECK_FLAG (MAP[(NUM) / BITMAP_NBBY], 1 << ((NUM) % BITMAP_NBBY))

#define BGP_MED_MAX UINT32_MAX


/* BGP Attribute type range. */
#define BGP_ATTR_TYPE_RANGE     256
#define BGP_ATTR_BITMAP_SIZE    (BGP_ATTR_TYPE_RANGE / BITMAP_NBBY)

/* BGP Attribute flags. */
#define BGP_ATTR_FLAG_OPTIONAL  0x80	/* Attribute is optional. */
#define BGP_ATTR_FLAG_TRANS     0x40	/* Attribute is transitive. */
#define BGP_ATTR_FLAG_PARTIAL   0x20	/* Attribute is partial. */
#define BGP_ATTR_FLAG_EXTLEN    0x10	/* Extended length flag. */

/* BGP attribute header must bigger than 2. */
#define BGP_ATTR_MIN_LEN        3       /* Attribute flag, type length. */
#define BGP_ATTR_DEFAULT_WEIGHT 32768

/* Additional/uncommon BGP attributes.
 * lazily allocated as and when a struct attr
 * requires it.
 */
struct attr_extra
{
  /* Multi-Protocol Nexthop, AFI IPv6 */
#ifdef HAVE_IPV6
  struct in6_addr mp_nexthop_global;
  struct in6_addr mp_nexthop_local;
#endif /* HAVE_IPV6 */

  /* Extended Communities attribute. */
  struct ecommunity *ecommunity;
  
  /* Route-Reflector Cluster attribute */
  struct cluster_list *cluster;
  
  /* Unknown transitive attribute. */
  struct transit *transit;

  struct in_addr mp_nexthop_global_in;
  struct in_addr mp_nexthop_local_in;
  
  /* Aggregator Router ID attribute */
  struct in_addr aggregator_addr;
  
  /* Route Reflector Originator attribute */
  struct in_addr originator_id;
  
  /* Local weight, not actually an attribute */
  u_int32_t weight;
  
  /* Aggregator ASN */
  as_t aggregator_as;
  
  /* MP Nexthop length */
  u_char mp_nexthop_len;
};

/* BGP core attribute structure. */
struct attr
{
  /* AS Path structure */
  struct aspath *aspath;

  /* Community structure */
  struct community *community;	
  
  /* Lazily allocated pointer to extra attributes */
  struct attr_extra *extra;
  
  /* Reference count of this attribute. */
  unsigned long refcnt;

  /* Flag of attribute is set or not. */
  u_int32_t flag;
  
  /* Apart from in6_addr, the remaining static attributes */
  struct in_addr nexthop;
  u_int32_t med;
  u_int32_t local_pref;
  
  /* Path origin attribute */
  u_char origin;
};

/* Router Reflector related structure. */
struct cluster_list
{
  unsigned long refcnt;
  int length;
  struct in_addr *list;
};

/* Unknown transit attribute. */
struct transit
{
  unsigned long refcnt;
  int length;
  u_char *val;
};

#define ATTR_FLAG_BIT(X)  (1 << ((X) - 1))

typedef enum {
 BGP_ATTR_PARSE_PROCEED = 0,
 BGP_ATTR_PARSE_ERROR = -1,
 BGP_ATTR_PARSE_WITHDRAW = -2,

 /* only used internally, send notify + convert to BGP_ATTR_PARSE_ERROR */
 BGP_ATTR_PARSE_ERROR_NOTIFYPLS = -3,
} bgp_attr_parse_ret_t;

/* Prototypes. */
extern void bgp_attr_init (void);
extern void bgp_attr_finish (void);
extern bgp_attr_parse_ret_t bgp_attr_parse (struct peer *, struct attr *,
                                           bgp_size_t, struct bgp_nlri *,
                                           struct bgp_nlri *);
extern int bgp_attr_check (struct peer *, struct attr *);
extern struct attr_extra *bgp_attr_extra_get (struct attr *);
extern void bgp_attr_extra_free (struct attr *);
extern void bgp_attr_dup (struct attr *, struct attr *);
extern struct attr *bgp_attr_intern (struct attr *attr);
extern void bgp_attr_unintern_sub (struct attr *);
extern void bgp_attr_unintern (struct attr **);
extern void bgp_attr_flush (struct attr *);
extern struct attr *bgp_attr_default_set (struct attr *attr, u_char);
extern struct attr *bgp_attr_default_intern (u_char);
extern struct attr *bgp_attr_aggregate_intern (struct bgp *, u_char,
                                        struct aspath *, 
                                        struct community *, int as_set);
extern bgp_size_t bgp_packet_attribute (struct bgp *bgp, struct peer *,
					struct stream *, struct attr *,
					struct prefix *, afi_t, safi_t,
					struct peer *, struct prefix_rd *,
					u_char *);
extern void bgp_dump_routes_attr (struct stream *, struct attr *,
				  struct prefix *);
extern int attrhash_cmp (const void *, const void *);
extern unsigned int attrhash_key_make (void *);
extern void attr_show_all (struct vty *);
extern unsigned long int attr_count (void);
extern unsigned long int attr_unknown_count (void);

/* Cluster list prototypes. */
extern int cluster_loop_check (struct cluster_list *, struct in_addr);
extern void cluster_unintern (struct cluster_list *);

/* Transit attribute prototypes. */
void transit_unintern (struct transit *);

/* Below exported for unit-test purposes only */
struct bgp_attr_parser_args {
  struct peer *peer;
  bgp_size_t length; /* attribute data length; */
  bgp_size_t total; /* total length, inc header */
  struct attr *attr;
  u_int8_t type;
  u_int8_t flags;
  u_char *startp;   
};
extern int bgp_mp_reach_parse (struct bgp_attr_parser_args *args, 
			       struct bgp_nlri *);
extern int bgp_mp_unreach_parse (struct bgp_attr_parser_args *args,
                                 struct bgp_nlri *);

/**
 * Set of functions to encode MP_REACH_NLRI and MP_UNREACH_NLRI attributes.
 * Typical call sequence is to call _start(), followed by multiple _prefix(),
 * one for each NLRI that needs to be encoded into the UPDATE message, and
 * finally the _end() function.
 */
extern size_t bgp_packet_mpattr_start(struct stream *s, afi_t afi, safi_t safi,
				      struct attr *attr);
extern void bgp_packet_mpattr_prefix(struct stream *s, afi_t afi, safi_t safi,
				     struct prefix *p, struct prefix_rd *prd,
				     u_char *tag);
extern void bgp_packet_mpattr_end(struct stream *s, size_t sizep);

extern size_t bgp_packet_mpunreach_start (struct stream *s, afi_t afi,
					  safi_t safi);
extern void bgp_packet_mpunreach_prefix (struct stream *s, struct prefix *p,
			     afi_t afi, safi_t safi, struct prefix_rd *prd,
			     u_char *tag);
extern void bgp_packet_mpunreach_end (struct stream *s, size_t attrlen_pnt);

#endif /* _QUAGGA_BGP_ATTR_H */
Commit	Line	Data
718e3744	1	/* BGP attributes.
	2	Copyright (C) 1996, 97, 98 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_ATTR_H
	22	#define _QUAGGA_BGP_ATTR_H
	23
718e3744	24	/* Simple bit mapping. */
	25	#define BITMAP_NBBY 8
	26
	27	#define SET_BITMAP(MAP, NUM) \
	28	SET_FLAG (MAP[(NUM) / BITMAP_NBBY], 1 << ((NUM) % BITMAP_NBBY))
	29
	30	#define CHECK_BITMAP(MAP, NUM) \
	31	CHECK_FLAG (MAP[(NUM) / BITMAP_NBBY], 1 << ((NUM) % BITMAP_NBBY))
	32
3b424979	33	#define BGP_MED_MAX UINT32_MAX
3b424979	34
03e214c8	35
718e3744	36	/* BGP Attribute type range. */
	37	#define BGP_ATTR_TYPE_RANGE 256
	38	#define BGP_ATTR_BITMAP_SIZE (BGP_ATTR_TYPE_RANGE / BITMAP_NBBY)
	39
	40	/* BGP Attribute flags. */
	41	#define BGP_ATTR_FLAG_OPTIONAL 0x80 /* Attribute is optional. */
	42	#define BGP_ATTR_FLAG_TRANS 0x40 /* Attribute is transitive. */
	43	#define BGP_ATTR_FLAG_PARTIAL 0x20 /* Attribute is partial. */
	44	#define BGP_ATTR_FLAG_EXTLEN 0x10 /* Extended length flag. */
	45
	46	/* BGP attribute header must bigger than 2. */
370b64a2	47	#define BGP_ATTR_MIN_LEN 3 /* Attribute flag, type length. */
03e214c8 PJ	48	#define BGP_ATTR_DEFAULT_WEIGHT 32768
03e214c8 PJ	49
fb982c25 PJ	50	/* Additional/uncommon BGP attributes.
	51	* lazily allocated as and when a struct attr
	52	* requires it.
	53	*/
	54	struct attr_extra
718e3744	55	{
fb982c25	56	/* Multi-Protocol Nexthop, AFI IPv6 */
718e3744	57	#ifdef HAVE_IPV6
	58	struct in6_addr mp_nexthop_global;
	59	struct in6_addr mp_nexthop_local;
	60	#endif /* HAVE_IPV6 */
718e3744	61
718e3744	62	/* Extended Communities attribute. */
718e3744	63	struct ecommunity *ecommunity;
cbdfbaa5 PJ	64
	65	/* Route-Reflector Cluster attribute */
	66	struct cluster_list *cluster;
	67
718e3744	68	/* Unknown transitive attribute. */
718e3744	69	struct transit *transit;
cbdfbaa5	70
fb982c25 PJ	71	struct in_addr mp_nexthop_global_in;
	72	struct in_addr mp_nexthop_local_in;
	73
	74	/* Aggregator Router ID attribute */
	75	struct in_addr aggregator_addr;
	76
	77	/* Route Reflector Originator attribute */
	78	struct in_addr originator_id;
	79
	80	/* Local weight, not actually an attribute */
	81	u_int32_t weight;
	82
	83	/* Aggregator ASN */
	84	as_t aggregator_as;
	85
	86	/* MP Nexthop length */
	87	u_char mp_nexthop_len;
	88	};
	89
	90	/* BGP core attribute structure. */
	91	struct attr
	92	{
	93	/* AS Path structure */
	94	struct aspath *aspath;
	95
	96	/* Community structure */
	97	struct community *community;
	98
	99	/* Lazily allocated pointer to extra attributes */
	100	struct attr_extra *extra;
	101
cbdfbaa5 PJ	102	/* Reference count of this attribute. */
	103	unsigned long refcnt;
	104
	105	/* Flag of attribute is set or not. */
	106	u_int32_t flag;
	107
	108	/* Apart from in6_addr, the remaining static attributes */
	109	struct in_addr nexthop;
	110	u_int32_t med;
	111	u_int32_t local_pref;
41367172	112
fb982c25	113	/* Path origin attribute */
cbdfbaa5	114	u_char origin;
718e3744	115	};
	116
	117	/* Router Reflector related structure. */
	118	struct cluster_list
	119	{
	120	unsigned long refcnt;
	121	int length;
	122	struct in_addr *list;
	123	};
	124
	125	/* Unknown transit attribute. */
	126	struct transit
	127	{
	128	unsigned long refcnt;
	129	int length;
	130	u_char *val;
	131	};
	132
	133	#define ATTR_FLAG_BIT(X) (1 << ((X) - 1))
	134
b881c707 PJ	135	typedef enum {
	136	BGP_ATTR_PARSE_PROCEED = 0,
	137	BGP_ATTR_PARSE_ERROR = -1,
	138	BGP_ATTR_PARSE_WITHDRAW = -2,
f57000c0 DL	139
	140	/* only used internally, send notify + convert to BGP_ATTR_PARSE_ERROR */
	141	BGP_ATTR_PARSE_ERROR_NOTIFYPLS = -3,
b881c707 PJ	142	} bgp_attr_parse_ret_t;
b881c707 PJ	143
718e3744	144	/* Prototypes. */
94f2b392	145	extern void bgp_attr_init (void);
228da428	146	extern void bgp_attr_finish (void);
b881c707 PJ	147	extern bgp_attr_parse_ret_t bgp_attr_parse (struct peer , struct attr ,
	148	bgp_size_t, struct bgp_nlri *,
	149	struct bgp_nlri *);
94f2b392	150	extern int bgp_attr_check (struct peer , struct attr );
fb982c25 PJ	151	extern struct attr_extra bgp_attr_extra_get (struct attr );
	152	extern void bgp_attr_extra_free (struct attr *);
	153	extern void bgp_attr_dup (struct attr , struct attr );
94f2b392	154	extern struct attr bgp_attr_intern (struct attr attr);
b881c707	155	extern void bgp_attr_unintern_sub (struct attr *);
f6f434b2	156	extern void bgp_attr_unintern (struct attr **);
94f2b392	157	extern void bgp_attr_flush (struct attr *);
	158	extern struct attr bgp_attr_default_set (struct attr attr, u_char);
	159	extern struct attr *bgp_attr_default_intern (u_char);
	160	extern struct attr bgp_attr_aggregate_intern (struct bgp , u_char,
5228ad27	161	struct aspath *,
5228ad27	162	struct community *, int as_set);
8c71e481 PM	163	extern bgp_size_t bgp_packet_attribute (struct bgp bgp, struct peer ,
	164	struct stream , struct attr ,
	165	struct prefix *, afi_t, safi_t,
	166	struct peer , struct prefix_rd ,
	167	u_char *);
94f2b392	168	extern void bgp_dump_routes_attr (struct stream , struct attr ,
94f2b392	169	struct prefix *);
ffe11cfb	170	extern int attrhash_cmp (const void , const void );
923de654	171	extern unsigned int attrhash_key_make (void *);
94f2b392	172	extern void attr_show_all (struct vty *);
cbdfbaa5 PJ	173	extern unsigned long int attr_count (void);
cbdfbaa5 PJ	174	extern unsigned long int attr_unknown_count (void);
718e3744	175
718e3744	176	/* Cluster list prototypes. */
94f2b392	177	extern int cluster_loop_check (struct cluster_list *, struct in_addr);
94f2b392	178	extern void cluster_unintern (struct cluster_list *);
718e3744	179
	180	/* Transit attribute prototypes. */
	181	void transit_unintern (struct transit *);
00d252cb	182
835315bf PJ	183	/* Below exported for unit-test purposes only */
	184	struct bgp_attr_parser_args {
	185	struct peer *peer;
	186	bgp_size_t length; /* attribute data length; */
	187	bgp_size_t total; /* total length, inc header */
	188	struct attr *attr;
	189	u_int8_t type;
	190	u_int8_t flags;
	191	u_char *startp;
	192	};
	193	extern int bgp_mp_reach_parse (struct bgp_attr_parser_args *args,
	194	struct bgp_nlri *);
	195	extern int bgp_mp_unreach_parse (struct bgp_attr_parser_args *args,
	196	struct bgp_nlri *);
03292809	197
8c71e481 PM	198	/**
	199	* Set of functions to encode MP_REACH_NLRI and MP_UNREACH_NLRI attributes.
	200	* Typical call sequence is to call _start(), followed by multiple _prefix(),
	201	* one for each NLRI that needs to be encoded into the UPDATE message, and
	202	* finally the _end() function.
	203	*/
	204	extern size_t bgp_packet_mpattr_start(struct stream *s, afi_t afi, safi_t safi,
	205	struct attr *attr);
	206	extern void bgp_packet_mpattr_prefix(struct stream *s, afi_t afi, safi_t safi,
	207	struct prefix p, struct prefix_rd prd,
	208	u_char *tag);
	209	extern void bgp_packet_mpattr_end(struct stream *s, size_t sizep);
	210
	211	extern size_t bgp_packet_mpunreach_start (struct stream *s, afi_t afi,
	212	safi_t safi);
	213	extern void bgp_packet_mpunreach_prefix (struct stream s, struct prefix p,
	214	afi_t afi, safi_t safi, struct prefix_rd *prd,
	215	u_char *tag);
	216	extern void bgp_packet_mpunreach_end (struct stream *s, size_t attrlen_pnt);
	217
00d252cb	218	#endif /* _QUAGGA_BGP_ATTR_H */