2 * l2_input.h : layer 2 input packet processing
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:
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #ifndef included_vnet_l2_input_h
19 #define included_vnet_l2_input_h
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>
27 /* Per-subinterface L2 feature configuration */
34 u16 bd_index; /* bridge domain id */
35 u32 output_sw_if_index; /* for xconnect */
38 /* Interface mode. If both are 0, this interface is in L3 mode */
42 /* this is the bvi interface for the bridge-domain */
45 /* config for which input features are configured on this interface */
48 /* some of these flags are also in the feature bitmap */
53 /* split horizon group */
62 /* Next nodes for the feature bitmap */
63 u32 feat_next_node_index[32];
65 /* config vector indexed by sw_if_index */
66 l2_input_config_t *configs;
68 /* bridge domain config vector indexed by bd_index */
69 l2_bridge_domain_t *bd_configs;
71 /* convenience variables */
72 vlib_main_t *vlib_main;
73 vnet_main_t *vnet_main;
76 extern l2input_main_t l2input_main;
78 extern vlib_node_registration_t l2input_node;
80 static_always_inline l2_bridge_domain_t *
81 l2input_bd_config_from_index (l2input_main_t * l2im, u32 bd_index)
83 l2_bridge_domain_t *bd_config;
85 bd_config = vec_elt_at_index (l2im->bd_configs, bd_index);
86 return bd_is_valid (bd_config) ? bd_config : NULL;
89 static_always_inline l2_bridge_domain_t *
90 l2input_bd_config (u32 bd_index)
92 l2input_main_t *mp = &l2input_main;
93 l2_bridge_domain_t *bd_config;
95 vec_validate (mp->bd_configs, bd_index);
96 bd_config = vec_elt_at_index (mp->bd_configs, bd_index);
100 /* L2 input indication packet is from BVI, using -2 */
101 #define L2INPUT_BVI ((u32) (~0-1))
103 /* L2 input features */
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") \
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")
122 /* Feature bitmap positions */
125 #define _(sym,str) L2INPUT_FEAT_##sym##_BIT,
131 STATIC_ASSERT (L2INPUT_N_FEAT <= 32, "too many l2 input features");
133 /* Feature bit masks */
136 #define _(sym,str) L2INPUT_FEAT_##sym = (1<<L2INPUT_FEAT_##sym##_BIT),
140 #define _(sym,str) L2INPUT_FEAT_##sym |
144 } l2input_feat_masks_t;
146 STATIC_ASSERT ((u64) L2INPUT_VALID_MASK == (1ull << L2INPUT_N_FEAT) - 1, "");
148 /** Return an array of strings containing graph node names of each feature */
149 char **l2input_get_feat_names (void);
151 /* arg0 - u32 feature_bitmap */
152 u8 *format_l2_input_features (u8 * s, va_list * args);
154 static_always_inline u8
155 bd_feature_flood (l2_bridge_domain_t * bd_config)
157 return ((bd_config->feature_bitmap & L2INPUT_FEAT_FLOOD) ==
161 static_always_inline u8
162 bd_feature_uu_flood (l2_bridge_domain_t * bd_config)
164 return ((bd_config->feature_bitmap & L2INPUT_FEAT_UU_FLOOD) ==
165 L2INPUT_FEAT_UU_FLOOD);
168 static_always_inline u8
169 bd_feature_forward (l2_bridge_domain_t * bd_config)
171 return ((bd_config->feature_bitmap & L2INPUT_FEAT_FWD) == L2INPUT_FEAT_FWD);
174 static_always_inline u8
175 bd_feature_learn (l2_bridge_domain_t * bd_config)
177 return ((bd_config->feature_bitmap & L2INPUT_FEAT_LEARN) ==
181 static_always_inline u8
182 bd_feature_arp_term (l2_bridge_domain_t * bd_config)
184 return ((bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM) ==
185 L2INPUT_FEAT_ARP_TERM);
188 /** Masks for eliminating features that do not apply to a packet */
190 /** Get a pointer to the config for the given interface */
191 l2_input_config_t *l2input_intf_config (u32 sw_if_index);
193 /* Enable (or disable) the feature in the bitmap for the given interface */
194 u32 l2input_intf_bitmap_enable (u32 sw_if_index,
195 u32 feature_bitmap, u32 enable);
197 /* Sets modifies flags from a bridge domain */
198 u32 l2input_set_bridge_features (u32 bd_index, u32 feat_mask, u32 feat_value);
202 #define MODE_L2_BRIDGE 1
204 #define MODE_L2_CLASSIFY 3
206 #define MODE_ERROR_ETH 1
207 #define MODE_ERROR_BVI_DEF 2
209 u32 set_int_l2_mode (vlib_main_t * vm,
210 vnet_main_t * vnet_main,
213 u32 bd_index, u32 bvi, u32 shg, u32 xc_sw_if_index);
216 vnet_update_l2_len (vlib_buffer_t * b)
218 ethernet_header_t *eth;
222 /* point at currrent l2 hdr */
223 eth = vlib_buffer_get_current (b);
226 * l2-output pays no attention to this
227 * but the tag push/pop code on an l2 subif needs it.
229 * Determine l2 header len, check for up to 2 vlans
231 vnet_buffer (b)->l2.l2_len = sizeof (ethernet_header_t);
232 ethertype = clib_net_to_host_u16 (eth->type);
233 if (ethernet_frame_is_tagged (ethertype))
235 ethernet_vlan_header_t *vlan;
236 vnet_buffer (b)->l2.l2_len += sizeof (*vlan);
238 vlan = (void *) (eth + 1);
239 ethertype = clib_net_to_host_u16 (vlan->type);
240 if (ethertype == ETHERNET_TYPE_VLAN)
242 vnet_buffer (b)->l2.l2_len += sizeof (*vlan);
246 ethernet_buffer_set_vlan_count (b, vlan_count);
250 * Compute flow hash of an ethernet packet, use 5-tuple hash if L3 packet
251 * is ip4 or ip6. Otherwise hash on smac/dmac/etype.
252 * The vlib buffer current pointer is expected to be at ethernet header
253 * and vnet l2.l2_len is exppected to be setup already.
256 vnet_l2_compute_flow_hash (vlib_buffer_t * b)
258 ethernet_header_t *eh = vlib_buffer_get_current (b);
259 u8 *l3h = (u8 *) eh + vnet_buffer (b)->l2.l2_len;
260 u16 ethertype = clib_net_to_host_u16 (*(u16 *) (l3h - 2));
262 if (ethertype == ETHERNET_TYPE_IP4)
263 return ip4_compute_flow_hash ((ip4_header_t *) l3h, IP_FLOW_HASH_DEFAULT);
264 else if (ethertype == ETHERNET_TYPE_IP6)
265 return ip6_compute_flow_hash ((ip6_header_t *) l3h, IP_FLOW_HASH_DEFAULT);
269 u32 *ap = (u32 *) & eh->dst_address[2];
270 u32 *bp = (u32 *) & eh->src_address[2];
274 hash_v3_mix32 (a, b, c);
275 hash_v3_finalize32 (a, b, c);
284 * fd.io coding-style-patch-verification: ON
287 * eval: (c-set-style "gnu")