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 /* config for which input features are configured on this interface */
41 /* split horizon group */
44 /* Interface mode. If both are 0, this interface is in L3 mode */
48 /* this is the bvi interface for the bridge-domain */
57 /* Next nodes for the feature bitmap */
58 u32 feat_next_node_index[32];
60 /* config vector indexed by sw_if_index */
61 l2_input_config_t *configs;
63 /* bridge domain config vector indexed by bd_index */
64 l2_bridge_domain_t *bd_configs;
66 /* convenience variables */
67 vlib_main_t *vlib_main;
68 vnet_main_t *vnet_main;
71 extern l2input_main_t l2input_main;
73 extern vlib_node_registration_t l2input_node;
75 static_always_inline l2_bridge_domain_t *
76 l2input_bd_config_from_index (l2input_main_t * l2im, u32 bd_index)
78 l2_bridge_domain_t *bd_config;
80 bd_config = vec_elt_at_index (l2im->bd_configs, bd_index);
81 return bd_is_valid (bd_config) ? bd_config : NULL;
84 static_always_inline l2_bridge_domain_t *
85 l2input_bd_config (u32 bd_index)
87 l2input_main_t *mp = &l2input_main;
88 l2_bridge_domain_t *bd_config;
90 vec_validate (mp->bd_configs, bd_index);
91 bd_config = vec_elt_at_index (mp->bd_configs, bd_index);
95 /* L2 input indication packet is from BVI, using -2 */
96 #define L2INPUT_BVI ((u32) (~0-1))
98 /* L2 input features */
100 /* Mappings from feature ID to graph node name in reverse order */
101 #define foreach_l2input_feat \
102 _(DROP, "feature-bitmap-drop") \
103 _(XCONNECT, "l2-output") \
104 _(FLOOD, "l2-flood") \
105 _(ARP_TERM, "arp-term-l2bd") \
106 _(UU_FLOOD, "l2-flood") \
107 _(GBP_FWD, "gbp-fwd") \
108 _(UU_FWD, "l2-uu-fwd") \
111 _(LEARN, "l2-learn") \
112 _(L2_EMULATION, "l2-emulation") \
113 _(GBP_LEARN, "gbp-learn-l2") \
114 _(GBP_NULL_CLASSIFY, "gbp-null-classify") \
115 _(GBP_SRC_CLASSIFY, "gbp-src-classify") \
116 _(GBP_LPM_CLASSIFY, "l2-gbp-lpm-classify") \
117 _(GBP_SCLASS_2_ID, "l2-gbp-sclass-2-id") \
118 _(VTR, "l2-input-vtr") \
119 _(L2_IP_QOS_RECORD, "l2-ip-qos-record") \
120 _(VPATH, "vpath-input-l2") \
121 _(ACL, "l2-input-acl") \
122 _(POLICER_CLAS, "l2-policer-classify") \
123 _(INPUT_FEAT_ARC, "l2-input-feat-arc") \
124 _(INPUT_CLASSIFY, "l2-input-classify") \
125 _(SPAN, "span-l2-input")
127 /* Feature bitmap positions */
130 #define _(sym,str) L2INPUT_FEAT_##sym##_BIT,
136 STATIC_ASSERT (L2INPUT_N_FEAT <= 32, "too many l2 input features");
138 /* Feature bit masks */
141 L2INPUT_FEAT_NONE = 0,
142 #define _(sym,str) L2INPUT_FEAT_##sym = (1<<L2INPUT_FEAT_##sym##_BIT),
146 #define _(sym,str) L2INPUT_FEAT_##sym |
150 } l2input_feat_masks_t;
152 STATIC_ASSERT ((u64) L2INPUT_VALID_MASK == (1ull << L2INPUT_N_FEAT) - 1, "");
154 /** Return an array of strings containing graph node names of each feature */
155 char **l2input_get_feat_names (void);
157 /* arg0 - u32 feature_bitmap, arg1 - u32 verbose */
158 u8 *format_l2_input_features (u8 * s, va_list * args);
160 static_always_inline u8
161 bd_feature_flood (l2_bridge_domain_t * bd_config)
163 return ((bd_config->feature_bitmap & L2INPUT_FEAT_FLOOD) ==
167 static_always_inline u8
168 bd_feature_uu_flood (l2_bridge_domain_t * bd_config)
170 return ((bd_config->feature_bitmap & L2INPUT_FEAT_UU_FLOOD) ==
171 L2INPUT_FEAT_UU_FLOOD);
174 static_always_inline u8
175 bd_feature_forward (l2_bridge_domain_t * bd_config)
177 return ((bd_config->feature_bitmap & L2INPUT_FEAT_FWD) == L2INPUT_FEAT_FWD);
180 static_always_inline u8
181 bd_feature_learn (l2_bridge_domain_t * bd_config)
183 return ((bd_config->feature_bitmap & L2INPUT_FEAT_LEARN) ==
187 static_always_inline u8
188 bd_feature_arp_term (l2_bridge_domain_t * bd_config)
190 return ((bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM) ==
191 L2INPUT_FEAT_ARP_TERM);
194 /** Masks for eliminating features that do not apply to a packet */
196 /** Get a pointer to the config for the given interface */
197 l2_input_config_t *l2input_intf_config (u32 sw_if_index);
199 /* Enable (or disable) the feature in the bitmap for the given interface */
200 u32 l2input_intf_bitmap_enable (u32 sw_if_index,
201 l2input_feat_masks_t feature_bitmap,
204 /* Sets modifies flags from a bridge domain */
205 u32 l2input_set_bridge_features (u32 bd_index, u32 feat_mask, u32 feat_value);
207 void l2input_interface_mac_change (u32 sw_if_index,
208 const u8 * old_address,
209 const u8 * new_address);
212 #define MODE_L2_BRIDGE 1
214 #define MODE_L2_CLASSIFY 3
216 #define MODE_ERROR_ETH 1
217 #define MODE_ERROR_BVI_DEF 2
219 u32 set_int_l2_mode (vlib_main_t * vm,
220 vnet_main_t * vnet_main,
223 u32 bd_index, l2_bd_port_type_t port_type,
224 u32 shg, u32 xc_sw_if_index);
227 vnet_update_l2_len (vlib_buffer_t * b)
229 ethernet_header_t *eth;
233 /* point at current l2 hdr */
234 eth = vlib_buffer_get_current (b);
237 * l2-output pays no attention to this
238 * but the tag push/pop code on an l2 subif needs it.
240 * Determine l2 header len, check for up to 2 vlans
242 vnet_buffer (b)->l2.l2_len = sizeof (ethernet_header_t);
243 ethertype = clib_net_to_host_u16 (eth->type);
244 if (ethernet_frame_is_tagged (ethertype))
246 ethernet_vlan_header_t *vlan;
247 vnet_buffer (b)->l2.l2_len += sizeof (*vlan);
249 vlan = (void *) (eth + 1);
250 ethertype = clib_net_to_host_u16 (vlan->type);
251 if (ethertype == ETHERNET_TYPE_VLAN)
253 vnet_buffer (b)->l2.l2_len += sizeof (*vlan);
257 ethernet_buffer_set_vlan_count (b, vlan_count);
261 * Compute flow hash of an ethernet packet, use 5-tuple hash if L3 packet
262 * is ip4 or ip6. Otherwise hash on smac/dmac/etype.
263 * The vlib buffer current pointer is expected to be at ethernet header
264 * and vnet l2.l2_len is expected to be setup already.
267 vnet_l2_compute_flow_hash (vlib_buffer_t * b)
269 ethernet_header_t *eh = vlib_buffer_get_current (b);
270 u8 *l3h = (u8 *) eh + vnet_buffer (b)->l2.l2_len;
271 u16 ethertype = clib_net_to_host_u16 (*(u16 *) (l3h - 2));
273 if (ethertype == ETHERNET_TYPE_IP4)
274 return ip4_compute_flow_hash ((ip4_header_t *) l3h, IP_FLOW_HASH_DEFAULT);
275 else if (ethertype == ETHERNET_TYPE_IP6)
276 return ip6_compute_flow_hash ((ip6_header_t *) l3h, IP_FLOW_HASH_DEFAULT);
280 u32 *ap = (u32 *) & eh->dst_address[2];
281 u32 *bp = (u32 *) & eh->src_address[2];
285 hash_v3_mix32 (a, b, c);
286 hash_v3_finalize32 (a, b, c);
295 * fd.io coding-style-patch-verification: ON
298 * eval: (c-set-style "gnu")