bgpd/bgp_ecommunity.h

   1 /* BGP Extended Communities Attribute.
   2    Copyright (C) 2000 Kunihiro Ishiguro <kunihiro@zebra.org>
   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
  21 #ifndef _QUAGGA_BGP_ECOMMUNITY_H
  22 #define _QUAGGA_BGP_ECOMMUNITY_H
  23
  24 /* High-order octet of the Extended Communities type field.  */
  25 #define ECOMMUNITY_ENCODE_AS                0x00
  26 #define ECOMMUNITY_ENCODE_IP                0x01
  27 #define ECOMMUNITY_ENCODE_AS4               0x02
  28 #define ECOMMUNITY_ENCODE_OPAQUE            0x03
  29 #define ECOMMUNITY_ENCODE_EVPN              0x06
  30
  31 /* Low-order octet of the Extended Communities type field.  */
  32 #define ECOMMUNITY_ROUTE_TARGET             0x02
  33 #define ECOMMUNITY_SITE_ORIGIN              0x03
  34
  35 #define ECOMMUNITY_EVPN_SUBTYPE_MACMOBILITY  0x00
  36 #define ECOMMUNITY_EVPN_SUBTYPE_ESI_LABEL    0x01
  37 #define ECOMMUNITY_EVPN_SUBTYPE_ES_IMPORT_RT 0x02
  38 #define ECOMMUNITY_EVPN_SUBTYPE_ROUTERMAC    0x03
  39 #define ECOMMUNITY_EVPN_SUBTYPE_DEF_GW       0x0d
  40
  41 /* Low-order octet of the Extended Communities type field for OPAQUE types */
  42 #define ECOMMUNITY_OPAQUE_SUBTYPE_ENCAP     0x0c
  43
  44 /* Extended communities attribute string format.  */
  45 #define ECOMMUNITY_FORMAT_ROUTE_MAP            0
  46 #define ECOMMUNITY_FORMAT_COMMUNITY_LIST       1
  47 #define ECOMMUNITY_FORMAT_DISPLAY              2
  48
  49 /* Extended Communities value is eight octet long.  */
  50 #define ECOMMUNITY_SIZE                        8
  51
  52 /* Extended Communities type flag.  */
  53 #define ECOMMUNITY_FLAG_NON_TRANSITIVE      0x40
  54
  55 /* Extended Communities attribute.  */
  56 struct ecommunity
  57 {
  58   /* Reference counter.  */
  59   unsigned long refcnt;
  60
  61   /* Size of Extended Communities attribute.  */
  62   int size;
  63
  64   /* Extended Communities value.  */
  65   u_int8_t *val;
  66
  67   /* Human readable format string.  */
  68   char *str;
  69 };
  70
  71 /* Extended community value is eight octet.  */
  72 struct ecommunity_val
  73 {
  74   char val[ECOMMUNITY_SIZE];
  75 };
  76
  77 #define ecom_length(X)    ((X)->size * ECOMMUNITY_SIZE)
  78
  79 extern void ecommunity_init (void);
  80 extern void ecommunity_finish (void);
  81 extern void ecommunity_free (struct ecommunity **);
  82 extern struct ecommunity *ecommunity_parse (u_int8_t *, u_short);
  83 extern struct ecommunity *ecommunity_dup (struct ecommunity *);
  84 extern struct ecommunity *ecommunity_merge (struct ecommunity *, struct ecommunity *);
  85 extern struct ecommunity *ecommunity_uniq_sort (struct ecommunity *);
  86 extern struct ecommunity *ecommunity_intern (struct ecommunity *);
  87 extern int ecommunity_cmp (const void *, const void *);
  88 extern void ecommunity_unintern (struct ecommunity **);
  89 extern unsigned int ecommunity_hash_make (void *);
  90 extern struct ecommunity *ecommunity_str2com (const char *, int, int);
  91 extern char *ecommunity_ecom2str (struct ecommunity *, int, int);
  92 extern int ecommunity_match (const struct ecommunity *, const struct ecommunity *);
  93 extern char *ecommunity_str (struct ecommunity *);
  94 extern struct ecommunity_val *ecommunity_lookup (const struct ecommunity *, uint8_t, uint8_t );
  95 extern int ecommunity_add_val (struct ecommunity *ecom, struct ecommunity_val *eval);
  96
  97 /* for vpn */
  98 extern struct ecommunity *ecommunity_new (void);
  99 extern int ecommunity_add_val (struct ecommunity *, struct ecommunity_val *);
 100 extern int ecommunity_strip (struct ecommunity *ecom, uint8_t type, uint8_t subtype);
 101 extern struct ecommunity *ecommunity_new (void);
 102 #endif /* _QUAGGA_BGP_ECOMMUNITY_H */