src/vnet/l2/l2_input.h

   1 /*
   2  * l2_input.h : layer 2 input packet processing
   3  *
   4  * Copyright (c) 2013 Cisco and/or its affiliates.
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #ifndef included_vnet_l2_input_h
  19 #define included_vnet_l2_input_h
  20
  21 #include <vlib/vlib.h>
  22 #include <vnet/vnet.h>
  23 #include <vnet/l2/l2_bd.h>
  24 #include <vnet/ethernet/packet.h>
  25 #include <vnet/ip/ip.h>
  26
  27 /* Per-subinterface L2 feature configuration */
  28
  29 typedef struct
  30 {
  31
  32   union
  33   {
  34     u16 bd_index;               /* bridge domain id */
  35     u32 output_sw_if_index;     /* for xconnect */
  36   };
  37
  38   /* Interface mode. If both are 0, this interface is in L3 mode */
  39   u8 xconnect;
  40   u8 bridge;
  41
  42   /* this is the bvi interface for the bridge-domain */
  43   u8 bvi;
  44
  45   /* config for which input features are configured on this interface */
  46   u32 feature_bitmap;
  47
  48   /* some of these flags are also in the feature bitmap */
  49   u8 learn_enable;
  50   u8 fwd_enable;
  51   u8 flood_enable;
  52
  53   /* split horizon group */
  54   u8 shg;
  55
  56 } l2_input_config_t;
  57
  58
  59 typedef struct
  60 {
  61
  62   /* Next nodes for the feature bitmap */
  63   u32 feat_next_node_index[32];
  64
  65   /* config vector indexed by sw_if_index */
  66   l2_input_config_t *configs;
  67
  68   /* bridge domain config vector indexed by bd_index */
  69   l2_bridge_domain_t *bd_configs;
  70
  71   /* convenience variables */
  72   vlib_main_t *vlib_main;
  73   vnet_main_t *vnet_main;
  74 } l2input_main_t;
  75
  76 extern l2input_main_t l2input_main;
  77
  78 extern vlib_node_registration_t l2input_node;
  79
  80 static_always_inline l2_bridge_domain_t *
  81 l2input_bd_config_from_index (l2input_main_t * l2im, u32 bd_index)
  82 {
  83   l2_bridge_domain_t *bd_config;
  84
  85   bd_config = vec_elt_at_index (l2im->bd_configs, bd_index);
  86   return bd_is_valid (bd_config) ? bd_config : NULL;
  87 }
  88
  89 static_always_inline l2_bridge_domain_t *
  90 l2input_bd_config (u32 bd_index)
  91 {
  92   l2input_main_t *mp = &l2input_main;
  93   l2_bridge_domain_t *bd_config;
  94
  95   vec_validate (mp->bd_configs, bd_index);
  96   bd_config = vec_elt_at_index (mp->bd_configs, bd_index);
  97   return bd_config;
  98 }
  99
 100 /* L2 input indication packet is from BVI, using -2 */
 101 #define L2INPUT_BVI ((u32) (~0-1))
 102
 103 /* L2 input features */
 104
 105 /* Mappings from feature ID to graph node name in reverse order */
 106 #define foreach_l2input_feat                    \
 107  _(DROP,          "feature-bitmap-drop")        \
 108  _(XCONNECT,      "l2-output")                  \
 109  _(FLOOD,         "l2-flood")                   \
 110  _(ARP_TERM,      "arp-term-l2bd")              \
 111  _(UU_FLOOD,      "l2-flood")                   \
 112  _(FWD,           "l2-fwd")                     \
 113  _(RW,            "l2-rw")                      \
 114  _(LEARN,         "l2-learn")                   \
 115  _(VTR,           "l2-input-vtr")               \
 116  _(VPATH,         "vpath-input-l2")             \
 117  _(ACL,           "l2-input-acl")               \
 118  _(POLICER_CLAS,  "l2-policer-classify")        \
 119  _(INPUT_CLASSIFY, "l2-input-classify")         \
 120  _(SPAN,          "span-l2-input")
 121
 122 /* Feature bitmap positions */
 123 typedef enum
 124 {
 125 #define _(sym,str) L2INPUT_FEAT_##sym##_BIT,
 126   foreach_l2input_feat
 127 #undef _
 128   L2INPUT_N_FEAT
 129 } l2input_feat_t;
 130
 131 STATIC_ASSERT (L2INPUT_N_FEAT <= 32, "too many l2 input features");
 132
 133 /* Feature bit masks */
 134 typedef enum
 135 {
 136 #define _(sym,str) L2INPUT_FEAT_##sym = (1<<L2INPUT_FEAT_##sym##_BIT),
 137   foreach_l2input_feat
 138 #undef _
 139     L2INPUT_VALID_MASK =
 140 #define _(sym,str) L2INPUT_FEAT_##sym |
 141     foreach_l2input_feat
 142 #undef _
 143   0
 144 } l2input_feat_masks_t;
 145
 146 STATIC_ASSERT ((u64) L2INPUT_VALID_MASK == (1ull << L2INPUT_N_FEAT) - 1, "");
 147
 148 /** Return an array of strings containing graph node names of each feature */
 149 char **l2input_get_feat_names (void);
 150
 151
 152 static_always_inline u8
 153 bd_feature_flood (l2_bridge_domain_t * bd_config)
 154 {
 155   return ((bd_config->feature_bitmap & L2INPUT_FEAT_FLOOD) ==
 156           L2INPUT_FEAT_FLOOD);
 157 }
 158
 159 static_always_inline u8
 160 bd_feature_uu_flood (l2_bridge_domain_t * bd_config)
 161 {
 162   return ((bd_config->feature_bitmap & L2INPUT_FEAT_UU_FLOOD) ==
 163           L2INPUT_FEAT_UU_FLOOD);
 164 }
 165
 166 static_always_inline u8
 167 bd_feature_forward (l2_bridge_domain_t * bd_config)
 168 {
 169   return ((bd_config->feature_bitmap & L2INPUT_FEAT_FWD) == L2INPUT_FEAT_FWD);
 170 }
 171
 172 static_always_inline u8
 173 bd_feature_learn (l2_bridge_domain_t * bd_config)
 174 {
 175   return ((bd_config->feature_bitmap & L2INPUT_FEAT_LEARN) ==
 176           L2INPUT_FEAT_LEARN);
 177 }
 178
 179 static_always_inline u8
 180 bd_feature_arp_term (l2_bridge_domain_t * bd_config)
 181 {
 182   return ((bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM) ==
 183           L2INPUT_FEAT_ARP_TERM);
 184 }
 185
 186 /** Masks for eliminating features that do not apply to a packet */
 187
 188 /** Get a pointer to the config for the given interface */
 189 l2_input_config_t *l2input_intf_config (u32 sw_if_index);
 190
 191 /* Enable (or disable) the feature in the bitmap for the given interface */
 192 u32 l2input_intf_bitmap_enable (u32 sw_if_index,
 193                                 u32 feature_bitmap, u32 enable);
 194
 195 /* Sets modifies flags from a bridge domain */
 196 u32 l2input_set_bridge_features (u32 bd_index, u32 feat_mask, u32 feat_value);
 197
 198
 199 #define MODE_L3        0
 200 #define MODE_L2_BRIDGE 1
 201 #define MODE_L2_XC     2
 202 #define MODE_L2_CLASSIFY 3
 203
 204 #define MODE_ERROR_ETH        1
 205 #define MODE_ERROR_BVI_DEF    2
 206
 207 u32 set_int_l2_mode (vlib_main_t * vm,
 208                      vnet_main_t * vnet_main,
 209                      u32 mode,
 210                      u32 sw_if_index,
 211                      u32 bd_index, u32 bvi, u32 shg, u32 xc_sw_if_index);
 212
 213 static inline void
 214 vnet_update_l2_len (vlib_buffer_t * b)
 215 {
 216   ethernet_header_t *eth;
 217   u16 ethertype;
 218   u8 vlan_count = 0;
 219
 220   /* point at currrent l2 hdr */
 221   eth = vlib_buffer_get_current (b);
 222
 223   /*
 224    * l2-output pays no attention to this
 225    * but the tag push/pop code on an l2 subif needs it.
 226    *
 227    * Determine l2 header len, check for up to 2 vlans
 228    */
 229   vnet_buffer (b)->l2.l2_len = sizeof (ethernet_header_t);
 230   ethertype = clib_net_to_host_u16 (eth->type);
 231   if (ethernet_frame_is_tagged (ethertype))
 232     {
 233       ethernet_vlan_header_t *vlan;
 234       vnet_buffer (b)->l2.l2_len += sizeof (*vlan);
 235       vlan_count = 1;
 236       vlan = (void *) (eth + 1);
 237       ethertype = clib_net_to_host_u16 (vlan->type);
 238       if (ethertype == ETHERNET_TYPE_VLAN)
 239         {
 240           vnet_buffer (b)->l2.l2_len += sizeof (*vlan);
 241           vlan_count = 2;
 242         }
 243     }
 244   ethernet_buffer_set_vlan_count (b, vlan_count);
 245 }
 246
 247 /*
 248  * Compute flow hash of an ethernet packet, use 5-tuple hash if L3 packet
 249  * is ip4 or ip6. Otherwise hash on smac/dmac/etype.
 250  * The vlib buffer current pointer is expected to be at ethernet header
 251  * and vnet l2.l2_len is exppected to be setup already.
 252  */
 253 static inline u32
 254 vnet_l2_compute_flow_hash (vlib_buffer_t * b)
 255 {
 256   ethernet_header_t *eh = vlib_buffer_get_current (b);
 257   u8 *l3h = (u8 *) eh + vnet_buffer (b)->l2.l2_len;
 258   u16 ethertype = clib_net_to_host_u16 (*(u16 *) (l3h - 2));
 259
 260   if (ethertype == ETHERNET_TYPE_IP4)
 261     return ip4_compute_flow_hash ((ip4_header_t *) l3h, IP_FLOW_HASH_DEFAULT);
 262   else if (ethertype == ETHERNET_TYPE_IP6)
 263     return ip6_compute_flow_hash ((ip6_header_t *) l3h, IP_FLOW_HASH_DEFAULT);
 264   else
 265     {
 266       u32 a, b, c;
 267       u32 *ap = (u32 *) & eh->dst_address[2];
 268       u32 *bp = (u32 *) & eh->src_address[2];
 269       a = *ap;
 270       b = *bp;
 271       c = ethertype;
 272       hash_v3_mix32 (a, b, c);
 273       hash_v3_finalize32 (a, b, c);
 274       return c;
 275     }
 276 }
 277
 278 #endif
 279
 280
 281 /*
 282  * fd.io coding-style-patch-verification: ON
 283  *
 284  * Local Variables:
 285  * eval: (c-set-style "gnu")
 286  * End:
 287  */