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   /* sequence number for interface based flush of MACs */
  57   u8 seq_num;
  58
  59 } l2_input_config_t;
  60
  61
  62 typedef struct
  63 {
  64
  65   /* Next nodes for the feature bitmap */
  66   u32 feat_next_node_index[32];
  67
  68   /* config vector indexed by sw_if_index */
  69   l2_input_config_t *configs;
  70
  71   /* bridge domain config vector indexed by bd_index */
  72   l2_bridge_domain_t *bd_configs;
  73
  74   /* convenience variables */
  75   vlib_main_t *vlib_main;
  76   vnet_main_t *vnet_main;
  77 } l2input_main_t;
  78
  79 extern l2input_main_t l2input_main;
  80
  81 extern vlib_node_registration_t l2input_node;
  82
  83 static_always_inline l2_bridge_domain_t *
  84 l2input_bd_config_from_index (l2input_main_t * l2im, u32 bd_index)
  85 {
  86   l2_bridge_domain_t *bd_config;
  87
  88   bd_config = vec_elt_at_index (l2im->bd_configs, bd_index);
  89   return bd_is_valid (bd_config) ? bd_config : NULL;
  90 }
  91
  92 /* L2 input indication packet is from BVI, using -2 */
  93 #define L2INPUT_BVI ((u32) (~0-1))
  94
  95 /* L2 input features */
  96
  97 /* Mappings from feature ID to graph node name */
  98 #define foreach_l2input_feat                    \
  99  _(DROP,          "feature-bitmap-drop")        \
 100  _(XCONNECT,      "l2-output")                  \
 101  _(FLOOD,         "l2-flood")                   \
 102  _(ARP_TERM,      "arp-term-l2bd")              \
 103  _(UU_FLOOD,      "l2-flood")                   \
 104  _(FWD,           "l2-fwd")                     \
 105  _(RW,            "l2-rw")                      \
 106  _(LEARN,         "l2-learn")                   \
 107  _(VTR,           "l2-input-vtr")               \
 108  _(VPATH,         "vpath-input-l2")             \
 109  _(ACL,           "l2-input-acl")               \
 110  _(POLICER_CLAS,  "l2-policer-classify")        \
 111  _(INPUT_CLASSIFY, "l2-input-classify")
 112
 113 /* Feature bitmap positions */
 114 typedef enum
 115 {
 116 #define _(sym,str) L2INPUT_FEAT_##sym##_BIT,
 117   foreach_l2input_feat
 118 #undef _
 119     L2INPUT_N_FEAT,
 120   L2INPUT_VALID_MASK =
 121 #define _(sym,str) L2INPUT_FEAT_##sym##_BIT |
 122     foreach_l2input_feat
 123 #undef _
 124     0,
 125 } l2input_feat_t;
 126
 127 /* Feature bit masks */
 128 typedef enum
 129 {
 130 #define _(sym,str) L2INPUT_FEAT_##sym = (1<<L2INPUT_FEAT_##sym##_BIT),
 131   foreach_l2input_feat
 132 #undef _
 133 } l2input_feat_masks_t;
 134
 135 /** Return an array of strings containing graph node names of each feature */
 136 char **l2input_get_feat_names (void);
 137
 138
 139 static_always_inline u8
 140 bd_feature_flood (l2_bridge_domain_t * bd_config)
 141 {
 142   return ((bd_config->feature_bitmap & L2INPUT_FEAT_FLOOD) ==
 143           L2INPUT_FEAT_FLOOD);
 144 }
 145
 146 static_always_inline u8
 147 bd_feature_uu_flood (l2_bridge_domain_t * bd_config)
 148 {
 149   return ((bd_config->feature_bitmap & L2INPUT_FEAT_UU_FLOOD) ==
 150           L2INPUT_FEAT_UU_FLOOD);
 151 }
 152
 153 static_always_inline u8
 154 bd_feature_forward (l2_bridge_domain_t * bd_config)
 155 {
 156   return ((bd_config->feature_bitmap & L2INPUT_FEAT_FWD) == L2INPUT_FEAT_FWD);
 157 }
 158
 159 static_always_inline u8
 160 bd_feature_learn (l2_bridge_domain_t * bd_config)
 161 {
 162   return ((bd_config->feature_bitmap & L2INPUT_FEAT_LEARN) ==
 163           L2INPUT_FEAT_LEARN);
 164 }
 165
 166 static_always_inline u8
 167 bd_feature_arp_term (l2_bridge_domain_t * bd_config)
 168 {
 169   return ((bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM) ==
 170           L2INPUT_FEAT_ARP_TERM);
 171 }
 172
 173 /** Masks for eliminating features that do not apply to a packet */
 174
 175 /** Get a pointer to the config for the given interface */
 176 l2_input_config_t *l2input_intf_config (u32 sw_if_index);
 177
 178 /* Enable (or disable) the feature in the bitmap for the given interface */
 179 u32 l2input_intf_bitmap_enable (u32 sw_if_index,
 180                                 u32 feature_bitmap, u32 enable);
 181
 182 /* Sets modifies flags from a bridge domain */
 183 u32 l2input_set_bridge_features (u32 bd_index, u32 feat_mask, u32 feat_value);
 184
 185
 186 #define MODE_L3        0
 187 #define MODE_L2_BRIDGE 1
 188 #define MODE_L2_XC     2
 189 #define MODE_L2_CLASSIFY 3
 190
 191 #define MODE_ERROR_ETH        1
 192 #define MODE_ERROR_BVI_DEF    2
 193
 194 u32 set_int_l2_mode (vlib_main_t * vm,
 195                      vnet_main_t * vnet_main,
 196                      u32 mode,
 197                      u32 sw_if_index,
 198                      u32 bd_index, u32 bvi, u32 shg, u32 xc_sw_if_index);
 199
 200 static inline void
 201 vnet_update_l2_len (vlib_buffer_t * b)
 202 {
 203   ethernet_header_t *eth;
 204   u16 ethertype;
 205   u8 vlan_count = 0;
 206
 207   /* point at currrent l2 hdr */
 208   eth = vlib_buffer_get_current (b);
 209
 210   /*
 211    * l2-output pays no attention to this
 212    * but the tag push/pop code on an l2 subif needs it.
 213    *
 214    * Determine l2 header len, check for up to 2 vlans
 215    */
 216   vnet_buffer (b)->l2.l2_len = sizeof (ethernet_header_t);
 217   ethertype = clib_net_to_host_u16 (eth->type);
 218   if (ethernet_frame_is_tagged (ethertype))
 219     {
 220       ethernet_vlan_header_t *vlan;
 221       vnet_buffer (b)->l2.l2_len += sizeof (*vlan);
 222       vlan_count = 1;
 223       vlan = (void *) (eth + 1);
 224       ethertype = clib_net_to_host_u16 (vlan->type);
 225       if (ethertype == ETHERNET_TYPE_VLAN)
 226         {
 227           vnet_buffer (b)->l2.l2_len += sizeof (*vlan);
 228           vlan_count = 2;
 229         }
 230     }
 231   ethernet_buffer_set_vlan_count (b, vlan_count);
 232 }
 233
 234 /*
 235  * Compute flow hash of an ethernet packet, use 5-tuple hash if L3 packet
 236  * is ip4 or ip6. Otherwise hash on smac/dmac/etype.
 237  * The vlib buffer current pointer is expected to be at ethernet header
 238  * and vnet l2.l2_len is exppected to be setup already.
 239  */
 240 static inline u32
 241 vnet_l2_compute_flow_hash (vlib_buffer_t * b)
 242 {
 243   ethernet_header_t *eh = vlib_buffer_get_current (b);
 244   u8 *l3h = (u8 *) eh + vnet_buffer (b)->l2.l2_len;
 245   u16 ethertype = clib_net_to_host_u16 (*(u16 *) (l3h - 2));
 246
 247   if (ethertype == ETHERNET_TYPE_IP4)
 248     return ip4_compute_flow_hash ((ip4_header_t *) l3h, IP_FLOW_HASH_DEFAULT);
 249   else if (ethertype == ETHERNET_TYPE_IP6)
 250     return ip6_compute_flow_hash ((ip6_header_t *) l3h, IP_FLOW_HASH_DEFAULT);
 251   else
 252     {
 253       u32 a, b, c;
 254       u32 *ap = (u32 *) & eh->dst_address[2];
 255       u32 *bp = (u32 *) & eh->src_address[2];
 256       a = *ap;
 257       b = *bp;
 258       c = ethertype;
 259       hash_v3_mix32 (a, b, c);
 260       hash_v3_finalize32 (a, b, c);
 261       return c;
 262     }
 263 }
 264
 265 #endif
 266
 267
 268 /*
 269  * fd.io coding-style-patch-verification: ON
 270  *
 271  * Local Variables:
 272  * eval: (c-set-style "gnu")
 273  * End:
 274  */