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