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 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_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 #define ECOMMUNITY_ENCODE_TRANS_EXP         0x80 /* Flow Spec */
  31 /* RFC7674 */
  32 #define ECOMMUNITY_EXTENDED_COMMUNITY_PART_2 0x81
  33 #define ECOMMUNITY_EXTENDED_COMMUNITY_PART_3 0x82
  34
  35 /* Low-order octet of the Extended Communities type field.  */
  36 #define ECOMMUNITY_ROUTE_TARGET             0x02
  37 #define ECOMMUNITY_SITE_ORIGIN              0x03
  38 #define ECOMMUNITY_TRAFFIC_RATE             0x06 /* Flow Spec */
  39 #define ECOMMUNITY_TRAFFIC_ACTION           0x07
  40 #define ECOMMUNITY_REDIRECT_VRF             0x08
  41 #define ECOMMUNITY_TRAFFIC_MARKING          0x09
  42 #define ECOMMUNITY_REDIRECT_IP_NH           0x00
  43
  44 /* Low-order octet of the Extended Communities type field for EVPN types */
  45 #define ECOMMUNITY_EVPN_SUBTYPE_MACMOBILITY  0x00
  46 #define ECOMMUNITY_EVPN_SUBTYPE_ESI_LABEL    0x01
  47 #define ECOMMUNITY_EVPN_SUBTYPE_ES_IMPORT_RT 0x02
  48 #define ECOMMUNITY_EVPN_SUBTYPE_ROUTERMAC    0x03
  49 #define ECOMMUNITY_EVPN_SUBTYPE_DEF_GW       0x0d
  50
  51 #define ECOMMUNITY_EVPN_SUBTYPE_MACMOBILITY_FLAG_STICKY 0x01
  52
  53 /* Low-order octet of the Extended Communities type field for OPAQUE types */
  54 #define ECOMMUNITY_OPAQUE_SUBTYPE_ENCAP     0x0c
  55
  56 /* Extended communities attribute string format.  */
  57 #define ECOMMUNITY_FORMAT_ROUTE_MAP            0
  58 #define ECOMMUNITY_FORMAT_COMMUNITY_LIST       1
  59 #define ECOMMUNITY_FORMAT_DISPLAY              2
  60
  61 /* Extended Communities value is eight octet long.  */
  62 #define ECOMMUNITY_SIZE                        8
  63
  64 /* Extended Communities type flag.  */
  65 #define ECOMMUNITY_FLAG_NON_TRANSITIVE      0x40
  66
  67 /* Extended Communities attribute.  */
  68 struct ecommunity {
  69         /* Reference counter.  */
  70         unsigned long refcnt;
  71
  72         /* Size of Extended Communities attribute.  */
  73         int size;
  74
  75         /* Extended Communities value.  */
  76         uint8_t *val;
  77
  78         /* Human readable format string.  */
  79         char *str;
  80 };
  81
  82 struct ecommunity_as {
  83         as_t as;
  84         uint32_t val;
  85 };
  86
  87 struct ecommunity_ip {
  88         struct in_addr ip;
  89         uint16_t val;
  90 };
  91
  92 /* Extended community value is eight octet.  */
  93 struct ecommunity_val {
  94         char val[ECOMMUNITY_SIZE];
  95 };
  96
  97 #define ecom_length(X)    ((X)->size * ECOMMUNITY_SIZE)
  98
  99 /*
 100  * Encode BGP Route Target AS:nn.
 101  */
 102 static inline void encode_route_target_as(as_t as, uint32_t val,
 103                                           struct ecommunity_val *eval)
 104 {
 105         eval->val[0] = ECOMMUNITY_ENCODE_AS;
 106         eval->val[1] = ECOMMUNITY_ROUTE_TARGET;
 107         eval->val[2] = (as >> 8) & 0xff;
 108         eval->val[3] = as & 0xff;
 109         eval->val[4] = (val >> 24) & 0xff;
 110         eval->val[5] = (val >> 16) & 0xff;
 111         eval->val[6] = (val >> 8) & 0xff;
 112         eval->val[7] = val & 0xff;
 113 }
 114
 115 /*
 116  * Encode BGP Route Target IP:nn.
 117  */
 118 static inline void encode_route_target_ip(struct in_addr ip, uint16_t val,
 119                                           struct ecommunity_val *eval)
 120 {
 121         eval->val[0] = ECOMMUNITY_ENCODE_IP;
 122         eval->val[1] = ECOMMUNITY_ROUTE_TARGET;
 123         memcpy(&eval->val[2], &ip, sizeof(struct in_addr));
 124         eval->val[6] = (val >> 8) & 0xff;
 125         eval->val[7] = val & 0xff;
 126 }
 127
 128 /*
 129  * Encode BGP Route Target AS4:nn.
 130  */
 131 static inline void encode_route_target_as4(as_t as, uint16_t val,
 132                                            struct ecommunity_val *eval)
 133 {
 134         eval->val[0] = ECOMMUNITY_ENCODE_AS4;
 135         eval->val[1] = ECOMMUNITY_ROUTE_TARGET;
 136         eval->val[2] = (as >> 24) & 0xff;
 137         eval->val[3] = (as >> 16) & 0xff;
 138         eval->val[4] = (as >> 8) & 0xff;
 139         eval->val[5] = as & 0xff;
 140         eval->val[6] = (val >> 8) & 0xff;
 141         eval->val[7] = val & 0xff;
 142 }
 143
 144 extern void ecommunity_init(void);
 145 extern void ecommunity_finish(void);
 146 extern void ecommunity_free(struct ecommunity **);
 147 extern struct ecommunity *ecommunity_parse(uint8_t *, unsigned short);
 148 extern struct ecommunity *ecommunity_dup(struct ecommunity *);
 149 extern struct ecommunity *ecommunity_merge(struct ecommunity *,
 150                                            struct ecommunity *);
 151 extern struct ecommunity *ecommunity_uniq_sort(struct ecommunity *);
 152 extern struct ecommunity *ecommunity_intern(struct ecommunity *);
 153 extern int ecommunity_cmp(const void *, const void *);
 154 extern void ecommunity_unintern(struct ecommunity **);
 155 extern unsigned int ecommunity_hash_make(void *);
 156 extern struct ecommunity *ecommunity_str2com(const char *, int, int);
 157 extern char *ecommunity_ecom2str(struct ecommunity *, int, int);
 158 extern int ecommunity_match(const struct ecommunity *,
 159                             const struct ecommunity *);
 160 extern char *ecommunity_str(struct ecommunity *);
 161 extern struct ecommunity_val *ecommunity_lookup(const struct ecommunity *,
 162                                                 uint8_t, uint8_t);
 163 extern int ecommunity_add_val(struct ecommunity *ecom,
 164                               struct ecommunity_val *eval);
 165
 166 /* for vpn */
 167 extern struct ecommunity *ecommunity_new(void);
 168 extern int ecommunity_add_val(struct ecommunity *, struct ecommunity_val *);
 169 extern int ecommunity_strip(struct ecommunity *ecom, uint8_t type,
 170                             uint8_t subtype);
 171 extern struct ecommunity *ecommunity_new(void);
 172 #endif /* _QUAGGA_BGP_ECOMMUNITY_H */