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