bgpd/bgp_community.h

   1 /* Community attribute related functions.
   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  */
  20
  21 #ifndef _QUAGGA_BGP_COMMUNITY_H
  22 #define _QUAGGA_BGP_COMMUNITY_H
  23
  24 #include "lib/json.h"
  25
  26 /* Communities attribute.  */
  27 struct community {
  28         /* Reference count of communities value.  */
  29         unsigned long refcnt;
  30
  31         /* Communities value size.  */
  32         int size;
  33
  34         /* Communities value.  */
  35         u_int32_t *val;
  36
  37         /* Communities as a json object */
  38         json_object *json;
  39
  40         /* String of community attribute.  This sring is used by vty output
  41            and expanded community-list for regular expression match.  */
  42         char *str;
  43 };
  44
  45 /* Well-known communities value.  */
  46 #define COMMUNITY_INTERNET              0x0
  47 #define COMMUNITY_NO_EXPORT             0xFFFFFF01
  48 #define COMMUNITY_NO_ADVERTISE          0xFFFFFF02
  49 #define COMMUNITY_NO_EXPORT_SUBCONFED   0xFFFFFF03
  50 #define COMMUNITY_LOCAL_AS              0xFFFFFF03
  51 #define COMMUNITY_GSHUT                 0xFFFF0000
  52
  53 /* Macros of community attribute.  */
  54 #define com_length(X)    ((X)->size * 4)
  55 #define com_lastval(X)   ((X)->val + (X)->size - 1)
  56 #define com_nthval(X,n)  ((X)->val + (n))
  57
  58 /* Prototypes of communities attribute functions.  */
  59 extern void community_init(void);
  60 extern void community_finish(void);
  61 extern void community_free(struct community *);
  62 extern struct community *community_uniq_sort(struct community *);
  63 extern struct community *community_parse(u_int32_t *, u_short);
  64 extern struct community *community_intern(struct community *);
  65 extern void community_unintern(struct community **);
  66 extern char *community_str(struct community *, bool make_json);
  67 extern unsigned int community_hash_make(struct community *);
  68 extern struct community *community_str2com(const char *);
  69 extern int community_match(const struct community *, const struct community *);
  70 extern int community_cmp(const struct community *, const struct community *);
  71 extern struct community *community_merge(struct community *,
  72                                          struct community *);
  73 extern struct community *community_delete(struct community *,
  74                                           struct community *);
  75 extern struct community *community_dup(struct community *);
  76 extern int community_include(struct community *, u_int32_t);
  77 extern void community_del_val(struct community *, u_int32_t *);
  78 extern unsigned long community_count(void);
  79 extern struct hash *community_hash(void);
  80 extern u_int32_t community_val_get(struct community *com, int i);
  81
  82 #endif /* _QUAGGA_BGP_COMMUNITY_H */