/src/frr/bgpd/bgp_clist.h

Source
// SPDX-License-Identifier: GPL-2.0-or-later
/* BGP Community list.
 * Copyright (C) 1999 Kunihiro Ishiguro
 */

#ifndef _QUAGGA_BGP_CLIST_H
#define _QUAGGA_BGP_CLIST_H

#include "jhash.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

#define COMMUNITY_SEQ_NUMBER_AUTO     -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;

  /* Stored hash value of name, to further speed up hash operations */
  uint32_t name_hash;

  /* 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.  */
  uint8_t direct;

  /* Standard or expanded.  */
  uint8_t style;

  /* Sequence number. */
  int64_t seq;

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

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

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

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

extern struct community_list *
community_list_lookup(struct community_list_handler *c, const char *name,
          uint32_t name_hash, int master);

extern bool community_list_match(struct community *com,
         struct community_list *list);
extern bool ecommunity_list_match(struct ecommunity *ecom,
          struct community_list *list);
extern bool lcommunity_list_match(struct lcommunity *lcom,
          struct community_list *list);
extern bool community_list_exact_match(struct community *com,
               struct community_list *list);
extern bool lcommunity_list_exact_match(struct lcommunity *lcom,
          struct community_list *list);
extern struct community *
community_list_match_delete(struct community *com, struct community_list *list);
extern struct lcommunity *
lcommunity_list_match_delete(struct lcommunity *lcom,
           struct community_list *list);

static inline uint32_t bgp_clist_hash_key(char *name)
{
  return jhash(name, strlen(name), 0xdeadbeaf);
}

extern void bgp_community_list_command_completion_setup(void);

#endif /* _QUAGGA_BGP_CLIST_H */

Line	Count	Source
1		// SPDX-License-Identifier: GPL-2.0-or-later
2		/* BGP Community list.
3		* Copyright (C) 1999 Kunihiro Ishiguro
4		*/
5
6		#ifndef _QUAGGA_BGP_CLIST_H
7		#define _QUAGGA_BGP_CLIST_H
8
9		#include "jhash.h"
10
11		/* Master Community-list. */
12	0	#define COMMUNITY_LIST_MASTER 0
13	0	#define EXTCOMMUNITY_LIST_MASTER 1
14	0	#define LARGE_COMMUNITY_LIST_MASTER 2
15
16		/* Community-list deny and permit. */
17	0	#define COMMUNITY_DENY 0
18	0	#define COMMUNITY_PERMIT 1
19
20		/* Number and string based community-list name. */
21	0	#define COMMUNITY_LIST_STRING 0
22	0	#define COMMUNITY_LIST_NUMBER 1
23
24	0	#define COMMUNITY_SEQ_NUMBER_AUTO -1
25
26		/* Community-list entry types. */
27	0	#define COMMUNITY_LIST_STANDARD 0 /* Standard community-list. */
28	0	#define COMMUNITY_LIST_EXPANDED 1 /* Expanded community-list. */
29	0	#define EXTCOMMUNITY_LIST_STANDARD 2 /* Standard extcommunity-list. */
30	0	#define EXTCOMMUNITY_LIST_EXPANDED 3 /* Expanded extcommunity-list. */
31	0	#define LARGE_COMMUNITY_LIST_STANDARD 4 /* Standard Large community-list. */
32	0	#define LARGE_COMMUNITY_LIST_EXPANDED 5 /* Expanded Large community-list. */
33
34		/* Community-list. */
35		struct community_list {
36		/* Name of the community-list. */
37		char *name;
38
39		/* Stored hash value of name, to further speed up hash operations */
40		uint32_t name_hash;
41
42		/* String or number. */
43		int sort;
44
45		/* Link to upper list. */
46		struct community_list_list *parent;
47
48		/* Linked list for other community-list. */
49		struct community_list *next;
50		struct community_list *prev;
51
52		/* Community-list entry in this community-list. */
53		struct community_entry *head;
54		struct community_entry *tail;
55		};
56
57		/* Each entry in community-list. */
58		struct community_entry {
59		struct community_entry *next;
60		struct community_entry *prev;
61
62		/* Permit or deny. */
63		uint8_t direct;
64
65		/* Standard or expanded. */
66		uint8_t style;
67
68		/* Sequence number. */
69		int64_t seq;
70
71		/* Community structure. */
72		union {
73		struct community *com;
74		struct ecommunity *ecom;
75		struct lcommunity *lcom;
76		} u;
77
78		/* Configuration string. */
79		char *config;
80
81		/* Expanded community-list regular expression. */
82		regex_t *reg;
83		};
84
85		/* Linked list of community-list. */
86		struct community_list_list {
87		struct community_list *head;
88		struct community_list *tail;
89		};
90
91		/* Master structure of community-list and extcommunity-list. */
92		struct community_list_master {
93		struct community_list_list num;
94		struct community_list_list str;
95		struct hash *hash;
96		};
97
98		/* Community-list handler. community_list_init() returns this
99		structure as handler. */
100		struct community_list_handler {
101		/* Community-list. */
102		struct community_list_master community_list;
103
104		/* Exteded community-list. */
105		struct community_list_master extcommunity_list;
106
107		/* Large community-list. */
108		struct community_list_master lcommunity_list;
109		};
110
111		/* Error code of community-list. */
112	0	#define COMMUNITY_LIST_ERR_CANT_FIND_LIST -1
113	0	#define COMMUNITY_LIST_ERR_MALFORMED_VAL -2
114	0	#define COMMUNITY_LIST_ERR_STANDARD_CONFLICT -3
115	0	#define COMMUNITY_LIST_ERR_EXPANDED_CONFLICT -4
116
117		/* Handler. */
118		extern struct community_list_handler *bgp_clist;
119
120		/* Prototypes. */
121		extern struct community_list_handler *community_list_init(void);
122		extern void community_list_terminate(struct community_list_handler *ch);
123
124		extern int community_list_set(struct community_list_handler *ch,
125		const char name, const char str,
126		const char *seq, int direct, int style);
127		extern int community_list_unset(struct community_list_handler *ch,
128		const char name, const char str,
129		const char *seq, int direct, int style);
130		extern int extcommunity_list_set(struct community_list_handler *ch,
131		const char name, const char str,
132		const char *seq, int direct, int style);
133		extern int extcommunity_list_unset(struct community_list_handler *ch,
134		const char name, const char str,
135		const char *seq, int direct, int style);
136		extern int lcommunity_list_set(struct community_list_handler *ch,
137		const char name, const char str,
138		const char *seq, int direct, int style);
139		extern bool lcommunity_list_valid(const char *community, int style);
140		extern int lcommunity_list_unset(struct community_list_handler *ch,
141		const char name, const char str,
142		const char *seq, int direct, int style);
143
144		extern struct community_list_master *
145		community_list_master_lookup(struct community_list_handler *ch, int master);
146
147		extern struct community_list *
148		community_list_lookup(struct community_list_handler c, const char name,
149		uint32_t name_hash, int master);
150
151		extern bool community_list_match(struct community *com,
152		struct community_list *list);
153		extern bool ecommunity_list_match(struct ecommunity *ecom,
154		struct community_list *list);
155		extern bool lcommunity_list_match(struct lcommunity *lcom,
156		struct community_list *list);
157		extern bool community_list_exact_match(struct community *com,
158		struct community_list *list);
159		extern bool lcommunity_list_exact_match(struct lcommunity *lcom,
160		struct community_list *list);
161		extern struct community *
162		community_list_match_delete(struct community com, struct community_list list);
163		extern struct lcommunity *
164		lcommunity_list_match_delete(struct lcommunity *lcom,
165		struct community_list *list);
166
167		static inline uint32_t bgp_clist_hash_key(char *name)
168	0	{
169	0	return jhash(name, strlen(name), 0xdeadbeaf);
170	0	} Unexecuted instantiation: bgp_main.c:bgp_clist_hash_key Unexecuted instantiation: bgp_attr.c:bgp_clist_hash_key Unexecuted instantiation: bgp_clist.c:bgp_clist_hash_key Unexecuted instantiation: bgp_community.c:bgp_clist_hash_key Unexecuted instantiation: bgp_community_alias.c:bgp_clist_hash_key Unexecuted instantiation: bgp_debug.c:bgp_clist_hash_key Unexecuted instantiation: bgp_ecommunity.c:bgp_clist_hash_key Unexecuted instantiation: bgp_evpn_vty.c:bgp_clist_hash_key Unexecuted instantiation: bgp_lcommunity.c:bgp_clist_hash_key Unexecuted instantiation: bgp_mpath.c:bgp_clist_hash_key Unexecuted instantiation: bgp_packet.c:bgp_clist_hash_key Unexecuted instantiation: bgp_route.c:bgp_clist_hash_key Unexecuted instantiation: bgp_routemap.c:bgp_clist_hash_key Unexecuted instantiation: bgp_vty.c:bgp_clist_hash_key Unexecuted instantiation: bgp_zebra.c:bgp_clist_hash_key Unexecuted instantiation: bgpd.c:bgp_clist_hash_key
171
172		extern void bgp_community_list_command_completion_setup(void);
173
174		#endif /* _QUAGGA_BGP_CLIST_H */

Coverage Report

Created: 2026-05-04 06:53