[mirror_frr.git] / bgpd / bgp_clist.h

/* BGP Community list.
 * Copyright (C) 1999 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_CLIST_H
#define _QUAGGA_BGP_CLIST_H

/* Master Community-list. */
#define COMMUNITY_LIST_MASTER          0
#define EXTCOMMUNITY_LIST_MASTER       1
#define LARGE_COMMUNITY_LIST_MASTER    2

/* Community-list deny and permit.  */
#define COMMUNITY_DENY                 0
#define COMMUNITY_PERMIT               1

/* Number and string based community-list name.  */
#define COMMUNITY_LIST_STRING          0
#define COMMUNITY_LIST_NUMBER          1

/* Community-list entry types.  */
#define COMMUNITY_LIST_STANDARD        0 /* Standard community-list.  */
#define COMMUNITY_LIST_EXPANDED        1 /* Expanded community-list.  */
#define EXTCOMMUNITY_LIST_STANDARD     2 /* Standard extcommunity-list.  */
#define EXTCOMMUNITY_LIST_EXPANDED     3 /* Expanded extcommunity-list.  */
#define LARGE_COMMUNITY_LIST_STANDARD  4 /* Standard Large community-list.  */
#define LARGE_COMMUNITY_LIST_EXPANDED  5 /* Expanded Large community-list.  */

/* Community-list.  */
struct community_list
{
  /* Name of the community-list.  */
  char *name;

  /* String or number.  */
  int sort;

  /* Link to upper list.  */
  struct community_list_list *parent;

  /* Linked list for other community-list.  */
  struct community_list *next;
  struct community_list *prev;

  /* Community-list entry in this community-list.  */
  struct community_entry *head;
  struct community_entry *tail;
};

/* Each entry in community-list.  */
struct community_entry
{
  struct community_entry *next;
  struct community_entry *prev;

  /* Permit or deny.  */
  u_char direct;

  /* Standard or expanded.  */
  u_char style;

  /* Any match.  */
  u_char any;

  /* Community structure.  */
  union
  {
    struct community *com;
    struct ecommunity *ecom;
    struct lcommunity *lcom;
  } u;

  /* Configuration string.  */
  char *config;

  /* Expanded community-list regular expression.  */
  regex_t *reg;
};

/* Linked list of community-list.  */
struct community_list_list
{
  struct community_list *head;
  struct community_list *tail;
};

/* Master structure of community-list and extcommunity-list.  */
struct community_list_master
{
  struct community_list_list num;
  struct community_list_list str;
};

/* Community-list handler.  community_list_init() returns this
   structure as handler.  */
struct community_list_handler
{
  /* Community-list.  */
  struct community_list_master community_list;

  /* Exteded community-list.  */
  struct community_list_master extcommunity_list;

  /* Large community-list.  */
  struct community_list_master lcommunity_list;
};

/* Error code of community-list.  */
#define COMMUNITY_LIST_ERR_CANT_FIND_LIST        -1
#define COMMUNITY_LIST_ERR_MALFORMED_VAL         -2
#define COMMUNITY_LIST_ERR_STANDARD_CONFLICT     -3
#define COMMUNITY_LIST_ERR_EXPANDED_CONFLICT     -4

/* Handler.  */
extern struct community_list_handler *bgp_clist;

/* Prototypes.  */
extern struct community_list_handler *community_list_init (void);
extern void community_list_terminate (struct community_list_handler *);

extern int community_list_set (struct community_list_handler *ch,
			       const char *name, const char *str, int direct,
			       int style);
extern int community_list_unset (struct community_list_handler *ch,
				 const char *name, const char *str,
				 int direct, int style, int delete_all);
extern int extcommunity_list_set (struct community_list_handler *ch,
				  const char *name, const char *str,
				  int direct, int style);
extern int extcommunity_list_unset (struct community_list_handler *ch,
				    const char *name, const char *str,
				    int direct, int style, int delete_all);
extern int lcommunity_list_set (struct community_list_handler *ch,
				const char *name, const char *str,
				int direct, int style);
extern int lcommunity_list_unset (struct community_list_handler *ch,
				  const char *name, const char *str,
				  int direct, int style);

extern struct community_list_master *
community_list_master_lookup (struct community_list_handler *, int);

extern struct community_list *
community_list_lookup (struct community_list_handler *, const char *, int);

extern int community_list_match (struct community *, struct community_list *);
extern int ecommunity_list_match (struct ecommunity *, struct community_list *);
extern int lcommunity_list_match (struct lcommunity *, struct community_list *);
extern int community_list_exact_match (struct community *,
				       struct community_list *);
extern struct community *
community_list_match_delete (struct community *, struct community_list *);
extern struct lcommunity *
lcommunity_list_match_delete (struct lcommunity *lcom,
			      struct community_list *list);
#endif /* _QUAGGA_BGP_CLIST_H */
Commit	Line	Data
718e3744	1	/* BGP Community list.
896014f4 DL	2	* Copyright (C) 1999 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_CLIST_H
	22	#define _QUAGGA_BGP_CLIST_H
	23
fee6e4e4	24	/* Master Community-list. */
	25	#define COMMUNITY_LIST_MASTER 0
	26	#define EXTCOMMUNITY_LIST_MASTER 1
57d187bc	27	#define LARGE_COMMUNITY_LIST_MASTER 2
fee6e4e4	28
718e3744	29	/* Community-list deny and permit. */
	30	#define COMMUNITY_DENY 0
	31	#define COMMUNITY_PERMIT 1
	32
	33	/* Number and string based community-list name. */
	34	#define COMMUNITY_LIST_STRING 0
	35	#define COMMUNITY_LIST_NUMBER 1
	36
	37	/* Community-list entry types. */
	38	#define COMMUNITY_LIST_STANDARD 0 /* Standard community-list. */
	39	#define COMMUNITY_LIST_EXPANDED 1 /* Expanded community-list. */
fee6e4e4	40	#define EXTCOMMUNITY_LIST_STANDARD 2 /* Standard extcommunity-list. */
fee6e4e4	41	#define EXTCOMMUNITY_LIST_EXPANDED 3 /* Expanded extcommunity-list. */
57d187bc JS	42	#define LARGE_COMMUNITY_LIST_STANDARD 4 /* Standard Large community-list. */
57d187bc JS	43	#define LARGE_COMMUNITY_LIST_EXPANDED 5 /* Expanded Large community-list. */
718e3744	44
	45	/* Community-list. */
	46	struct community_list
	47	{
	48	/* Name of the community-list. */
	49	char *name;
	50
	51	/* String or number. */
	52	int sort;
	53
	54	/* Link to upper list. */
	55	struct community_list_list *parent;
	56
	57	/* Linked list for other community-list. */
	58	struct community_list *next;
	59	struct community_list *prev;
	60
	61	/* Community-list entry in this community-list. */
	62	struct community_entry *head;
	63	struct community_entry *tail;
	64	};
	65
	66	/* Each entry in community-list. */
	67	struct community_entry
	68	{
	69	struct community_entry *next;
	70	struct community_entry *prev;
	71
	72	/* Permit or deny. */
	73	u_char direct;
	74
	75	/* Standard or expanded. */
	76	u_char style;
	77
	78	/* Any match. */
	79	u_char any;
	80
	81	/* Community structure. */
	82	union
	83	{
	84	struct community *com;
	85	struct ecommunity *ecom;
57d187bc	86	struct lcommunity *lcom;
718e3744	87	} u;
	88
	89	/* Configuration string. */
	90	char *config;
	91
	92	/* Expanded community-list regular expression. */
	93	regex_t *reg;
	94	};
	95
	96	/* Linked list of community-list. */
	97	struct community_list_list
	98	{
	99	struct community_list *head;
	100	struct community_list *tail;
	101	};
	102
	103	/* Master structure of community-list and extcommunity-list. */
	104	struct community_list_master
	105	{
	106	struct community_list_list num;
	107	struct community_list_list str;
	108	};
	109
	110	/* Community-list handler. community_list_init() returns this
	111	structure as handler. */
	112	struct community_list_handler
	113	{
	114	/* Community-list. */
	115	struct community_list_master community_list;
	116
	117	/* Exteded community-list. */
	118	struct community_list_master extcommunity_list;
57d187bc JS	119
	120	/* Large community-list. */
	121	struct community_list_master lcommunity_list;
718e3744	122	};
	123
	124	/* Error code of community-list. */
	125	#define COMMUNITY_LIST_ERR_CANT_FIND_LIST -1
	126	#define COMMUNITY_LIST_ERR_MALFORMED_VAL -2
	127	#define COMMUNITY_LIST_ERR_STANDARD_CONFLICT -3
	128	#define COMMUNITY_LIST_ERR_EXPANDED_CONFLICT -4
	129
	130	/* Handler. */
	131	extern struct community_list_handler *bgp_clist;
	132
	133	/* Prototypes. */
94f2b392	134	extern struct community_list_handler *community_list_init (void);
228da428	135	extern void community_list_terminate (struct community_list_handler *);
94f2b392	136
	137	extern int community_list_set (struct community_list_handler *ch,
	138	const char name, const char str, int direct,
	139	int style);
	140	extern int community_list_unset (struct community_list_handler *ch,
	141	const char name, const char str,
813d4307	142	int direct, int style, int delete_all);
94f2b392	143	extern int extcommunity_list_set (struct community_list_handler *ch,
	144	const char name, const char str,
	145	int direct, int style);
	146	extern int extcommunity_list_unset (struct community_list_handler *ch,
	147	const char name, const char str,
813d4307	148	int direct, int style, int delete_all);
57d187bc JS	149	extern int lcommunity_list_set (struct community_list_handler *ch,
	150	const char name, const char str,
	151	int direct, int style);
	152	extern int lcommunity_list_unset (struct community_list_handler *ch,
	153	const char name, const char str,
	154	int direct, int style);
94f2b392	155
94f2b392	156	extern struct community_list_master *
718e3744	157	community_list_master_lookup (struct community_list_handler *, int);
718e3744	158
94f2b392	159	extern struct community_list *
fd79ac91	160	community_list_lookup (struct community_list_handler , const char , int);
718e3744	161
94f2b392	162	extern int community_list_match (struct community , struct community_list );
94f2b392	163	extern int ecommunity_list_match (struct ecommunity , struct community_list );
57d187bc	164	extern int lcommunity_list_match (struct lcommunity , struct community_list );
94f2b392	165	extern int community_list_exact_match (struct community *,
	166	struct community_list *);
	167	extern struct community *
	168	community_list_match_delete (struct community , struct community_list );
57d187bc JS	169	extern struct lcommunity *
	170	lcommunity_list_match_delete (struct lcommunity *lcom,
	171	struct community_list *list);
00d252cb	172	#endif /* _QUAGGA_BGP_CLIST_H */