[mirror_frr.git] / bgpd / bgp_community.h

/* Community attribute related functions.
 * Copyright (C) 1998 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_COMMUNITY_H
#define _QUAGGA_BGP_COMMUNITY_H

#include "lib/json.h"
#include "bgpd/bgp_route.h"

/* Communities attribute.  */
struct community {
	/* Reference count of communities value.  */
	unsigned long refcnt;

	/* Communities value size.  */
	int size;

	/* Communities value.  */
	uint32_t *val;

	/* Communities as a json object */
	json_object *json;

	/* String of community attribute.  This sring is used by vty output
	   and expanded community-list for regular expression match.  */
	char *str;
};

/* Well-known communities value.  */
#define COMMUNITY_INTERNET                      0x0
#define COMMUNITY_GSHUT                         0xFFFF0000
#define COMMUNITY_ACCEPT_OWN                    0xFFFF0001
#define COMMUNITY_ROUTE_FILTER_TRANSLATED_v4    0xFFFF0002
#define COMMUNITY_ROUTE_FILTER_v4               0xFFFF0003
#define COMMUNITY_ROUTE_FILTER_TRANSLATED_v6    0xFFFF0004
#define COMMUNITY_ROUTE_FILTER_v6               0xFFFF0005
#define COMMUNITY_LLGR_STALE                    0xFFFF0006
#define COMMUNITY_NO_LLGR                       0xFFFF0007
#define COMMUNITY_ACCEPT_OWN_NEXTHOP            0xFFFF0008
#define COMMUNITY_BLACKHOLE                     0xFFFF029A
#define COMMUNITY_NO_EXPORT                     0xFFFFFF01
#define COMMUNITY_NO_ADVERTISE                  0xFFFFFF02
#define COMMUNITY_NO_EXPORT_SUBCONFED           0xFFFFFF03
#define COMMUNITY_LOCAL_AS                      0xFFFFFF03
#define COMMUNITY_NO_PEER                       0xFFFFFF04

#define COMMUNITY_SIZE 4

/* Macros of community attribute.  */
#define com_length(X)    ((X)->size * COMMUNITY_SIZE)
#define com_lastval(X)   ((X)->val + (X)->size - 1)
#define com_nthval(X,n)  ((X)->val + (n))

/* Prototypes of communities attribute functions.  */
extern void community_init(void);
extern void community_finish(void);
extern void community_free(struct community **comm);
extern struct community *community_uniq_sort(struct community *com);
extern struct community *community_parse(uint32_t *pnt, unsigned short length);
extern struct community *community_intern(struct community *com);
extern void community_unintern(struct community **com);
extern char *community_str(struct community *com, bool make_json,
			   bool translate_alias);
extern unsigned int community_hash_make(const struct community *com);
extern struct community *community_str2com(const char *str);
extern bool community_match(const struct community *com1,
			    const struct community *com2);
extern bool community_cmp(const struct community *c1,
			  const struct community *c2);
extern struct community *community_merge(struct community *com1,
					 struct community *com2);
extern struct community *community_delete(struct community *com1,
					  struct community *com2);
extern struct community *community_dup(struct community *com);
extern bool community_include(struct community *com, uint32_t val);
extern void community_add_val(struct community *com, uint32_t val);
extern void community_del_val(struct community *com, uint32_t *val);
extern unsigned long community_count(void);
extern struct hash *community_hash(void);
extern uint32_t community_val_get(struct community *com, int i);
extern void bgp_compute_aggregate_community(struct bgp_aggregate *aggregate,
					    struct community *community);

extern void bgp_compute_aggregate_community_val(
					       struct bgp_aggregate *aggregate);
extern void bgp_compute_aggregate_community_hash(
						struct bgp_aggregate *aggregate,
						struct community *community);
extern void bgp_remove_community_from_aggregate(struct bgp_aggregate *aggregate,
						struct community *community);
extern void bgp_remove_comm_from_aggregate_hash(struct bgp_aggregate *aggregate,
						struct community *community);
extern void bgp_aggr_community_remove(void *arg);

#endif /* _QUAGGA_BGP_COMMUNITY_H */
Commit	Line	Data
718e3744	1	/* Community attribute related functions.
896014f4 DL	2	* Copyright (C) 1998 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_COMMUNITY_H
	22	#define _QUAGGA_BGP_COMMUNITY_H
	23
f1aa5d8a	24	#include "lib/json.h"
c0d7a6cc	25	#include "bgpd/bgp_route.h"
f1aa5d8a	26
718e3744	27	/* Communities attribute. */
d62a17ae	28	struct community {
	29	/* Reference count of communities value. */
	30	unsigned long refcnt;
718e3744	31
d62a17ae	32	/* Communities value size. */
d62a17ae	33	int size;
718e3744	34
d62a17ae	35	/* Communities value. */
d7c0a89a	36	uint32_t *val;
718e3744	37
d62a17ae	38	/* Communities as a json object */
d62a17ae	39	json_object *json;
f1aa5d8a	40
d62a17ae	41	/* String of community attribute. This sring is used by vty output
	42	and expanded community-list for regular expression match. */
	43	char *str;
718e3744	44	};
	45
	46	/* Well-known communities value. */
aa861c10 C	47	#define COMMUNITY_INTERNET 0x0
	48	#define COMMUNITY_GSHUT 0xFFFF0000
	49	#define COMMUNITY_ACCEPT_OWN 0xFFFF0001
	50	#define COMMUNITY_ROUTE_FILTER_TRANSLATED_v4 0xFFFF0002
	51	#define COMMUNITY_ROUTE_FILTER_v4 0xFFFF0003
	52	#define COMMUNITY_ROUTE_FILTER_TRANSLATED_v6 0xFFFF0004
	53	#define COMMUNITY_ROUTE_FILTER_v6 0xFFFF0005
	54	#define COMMUNITY_LLGR_STALE 0xFFFF0006
	55	#define COMMUNITY_NO_LLGR 0xFFFF0007
	56	#define COMMUNITY_ACCEPT_OWN_NEXTHOP 0xFFFF0008
	57	#define COMMUNITY_BLACKHOLE 0xFFFF029A
	58	#define COMMUNITY_NO_EXPORT 0xFFFFFF01
	59	#define COMMUNITY_NO_ADVERTISE 0xFFFFFF02
	60	#define COMMUNITY_NO_EXPORT_SUBCONFED 0xFFFFFF03
	61	#define COMMUNITY_LOCAL_AS 0xFFFFFF03
	62	#define COMMUNITY_NO_PEER 0xFFFFFF04
718e3744	63
11400e73 DA	64	#define COMMUNITY_SIZE 4
11400e73 DA	65
718e3744	66	/* Macros of community attribute. */
11400e73	67	#define com_length(X) ((X)->size * COMMUNITY_SIZE)
718e3744	68	#define com_lastval(X) ((X)->val + (X)->size - 1)
	69	#define com_nthval(X,n) ((X)->val + (n))
	70
	71	/* Prototypes of communities attribute functions. */
d62a17ae	72	extern void community_init(void);
d62a17ae	73	extern void community_finish(void);
3c1f53de	74	extern void community_free(struct community **comm);
4627226d DS	75	extern struct community community_uniq_sort(struct community com);
	76	extern struct community community_parse(uint32_t pnt, unsigned short length);
	77	extern struct community community_intern(struct community com);
	78	extern void community_unintern(struct community **com);
	79	extern char community_str(struct community com, bool make_json,
c0945b78	80	bool translate_alias);
4627226d DS	81	extern unsigned int community_hash_make(const struct community *com);
	82	extern struct community community_str2com(const char str);
	83	extern bool community_match(const struct community *com1,
	84	const struct community *com2);
74df8d6d DS	85	extern bool community_cmp(const struct community *c1,
74df8d6d DS	86	const struct community *c2);
4627226d DS	87	extern struct community community_merge(struct community com1,
	88	struct community *com2);
	89	extern struct community community_delete(struct community com1,
	90	struct community *com2);
	91	extern struct community community_dup(struct community com);
	92	extern bool community_include(struct community *com, uint32_t val);
2721dd61	93	extern void community_add_val(struct community *com, uint32_t val);
4627226d	94	extern void community_del_val(struct community com, uint32_t val);
d62a17ae	95	extern unsigned long community_count(void);
d62a17ae	96	extern struct hash *community_hash(void);
d7c0a89a	97	extern uint32_t community_val_get(struct community *com, int i);
c0d7a6cc NT	98	extern void bgp_compute_aggregate_community(struct bgp_aggregate *aggregate,
c0d7a6cc NT	99	struct community *community);
21fec674	100
	101	extern void bgp_compute_aggregate_community_val(
	102	struct bgp_aggregate *aggregate);
	103	extern void bgp_compute_aggregate_community_hash(
	104	struct bgp_aggregate *aggregate,
	105	struct community *community);
c0d7a6cc NT	106	extern void bgp_remove_community_from_aggregate(struct bgp_aggregate *aggregate,
c0d7a6cc NT	107	struct community *community);
21fec674	108	extern void bgp_remove_comm_from_aggregate_hash(struct bgp_aggregate *aggregate,
21fec674	109	struct community *community);
c0d7a6cc	110	extern void bgp_aggr_community_remove(void *arg);
00d252cb	111
00d252cb	112	#endif /* _QUAGGA_BGP_COMMUNITY_H */