2 * l2_emulation.h : Extract L3 packets from the L2 input and feed
3 * them into the L3 path.
5 * Copyright (c) 2013 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
19 #include <plugins/l2e/l2e.h>
20 #include <vnet/l2/l2_input.h>
23 * Grouping of global data for the L2 emulation feature
25 typedef struct l2_emulation_main_t_
28 * Next nodes for L2 output features
30 u32 l2_input_feat_next[32];
31 } l2_emulation_main_t;
33 static l2_emulation_main_t l2_emulation_main;
36 * Per-interface L2 configuration
38 typedef struct l2_emulation_t_
41 * Enabled or Disabled.
42 * this is required since one L3 protocl can be enabled, but others not
48 * A zero'd out struct we can use in the vec_validate
50 static const l2_emulation_t ezero = { };
53 * Per-interface vector of emulation configs
55 l2_emulation_t *l2_emulations;
58 l2_emulation_enable (u32 sw_if_index)
60 vec_validate_init_empty (l2_emulations, sw_if_index, ezero);
62 l2_emulation_t *l23e = &l2_emulations[sw_if_index];
67 * L3 enable the interface - using IP unnumbered from the control
68 * plane may not be possible since there may be no BVI interface
69 * to which to unnumber
71 ip4_sw_interface_enable_disable (sw_if_index, 1);
72 ip6_sw_interface_enable_disable (sw_if_index, 1);
74 l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_L2_EMULATION, 1);
79 l2_emulation_disable (u32 sw_if_index)
81 if (vec_len (l2_emulations) >= sw_if_index)
83 l2_emulation_t *l23e = &l2_emulations[sw_if_index];
84 memset (l23e, 0, sizeof (*l23e));
86 l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_L2_EMULATION, 0);
87 ip4_sw_interface_enable_disable (sw_if_index, 0);
88 ip6_sw_interface_enable_disable (sw_if_index, 0);
93 l2_emulation_interface_add_del (vnet_main_t * vnm,
94 u32 sw_if_index, u32 is_add)
98 vec_validate_init_empty (l2_emulations, sw_if_index, ezero);
104 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (l2_emulation_interface_add_del);
106 static clib_error_t *
107 l2_emulation_cli (vlib_main_t * vm,
108 unformat_input_t * input, vlib_cli_command_t * cmd)
110 vnet_main_t *vnm = vnet_get_main ();
111 u32 sw_if_index = ~0;
114 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
116 if (unformat (input, "%U", unformat_vnet_sw_interface,
119 else if (unformat (input, "enable"))
121 else if (unformat (input, "disable"))
127 if (~0 == sw_if_index)
128 return clib_error_return (0, "interface must be specified");
131 l2_emulation_enable (sw_if_index);
133 l2_emulation_disable (sw_if_index);
139 * Configure l2 emulation.
140 * When the interface is in L2 mode, configure the extraction of L3
141 * packets out of the L2 path and into the L3 path.
144 * @cliexstart{set interface l2 input l2-emulation <interface-name> [disable]}
148 VLIB_CLI_COMMAND (l2_emulation_cli_node, static) = {
149 .path = "set interface l2 l2-emulation",
151 "set interface l2 l2-emulation <interface-name> [disable|enable]\n",
152 .function = l2_emulation_cli,
156 static clib_error_t *
157 l2_emulation_show (vlib_main_t * vm,
158 unformat_input_t * input, vlib_cli_command_t * cmd)
160 vnet_main_t *vnm = vnet_get_main ();
161 l2_emulation_t *l23e;
164 vec_foreach_index (sw_if_index, l2_emulations)
166 l23e = &l2_emulations[sw_if_index];
169 vlib_cli_output (vm, "%U\n",
170 format_vnet_sw_if_index_name, vnm, sw_if_index);
178 * When the interface is in L2 mode, configure the extraction of L3
179 * packets out of the L2 path and into the L3 path.
182 * @cliexstart{show interface l2 l2-emulation}
186 VLIB_CLI_COMMAND (l2_emulation_show_node, static) = {
187 .path = "show interface l2 l2-emulation",
188 .short_help = "show interface l2 l2-emulation\n",
189 .function = l2_emulation_show,
193 #define foreach_l2_emulation \
194 _(IP4, "Extract IPv4") \
195 _(IP6, "Extract IPv6")
199 #define _(sym,str) L2_EMULATION_ERROR_##sym,
202 L2_EMULATION_N_ERROR,
203 } l2_emulation_error_t;
205 static char *l2_emulation_error_strings[] = {
206 #define _(sym,string) string,
213 #define _(sym,str) L2_EMULATION_NEXT_##sym,
217 } l2_emulation_next_t;
220 * per-packet trace data
222 typedef struct l2_emulation_trace_t_
224 /* per-pkt trace data */
226 } l2_emulation_trace_t;
229 l2_emulation_node_fn (vlib_main_t * vm,
230 vlib_node_runtime_t * node, vlib_frame_t * frame)
232 l2_emulation_main_t *em = &l2_emulation_main;
233 u32 n_left_from, *from, *to_next;
234 l2_emulation_next_t next_index;
239 n_left_from = frame->n_vectors;
240 from = vlib_frame_vector_args (frame);
242 while (n_left_from > 0)
246 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
247 while (n_left_from >= 4 && n_left_to_next >= 2)
249 vlib_buffer_t *b0, *b1;
250 u32 sw_if_index0, sw_if_index1;
251 u16 ether_type0, ether_type1;
252 u32 next0 = ~0, next1 = ~0;
257 bi0 = to_next[0] = from[0];
258 bi1 = to_next[1] = from[1];
265 b0 = vlib_get_buffer (vm, bi0);
266 b1 = vlib_get_buffer (vm, bi1);
267 l2_len0 = vnet_buffer (b0)->l2.l2_len;
268 l2_len1 = vnet_buffer (b1)->l2.l2_len;
270 h0 = vlib_buffer_get_current (b0);
271 h1 = vlib_buffer_get_current (b1);
273 ether_type0 = clib_net_to_host_u16 (*(u16 *) (h0 + l2_len0 - 2));
274 ether_type1 = clib_net_to_host_u16 (*(u16 *) (h1 + l2_len1 - 2));
275 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
276 sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
279 * only extract unicast
281 if (PREDICT_TRUE (!(h0[0] & 0x1)))
285 case ETHERNET_TYPE_IP4:
286 ASSERT (l2_emulations[sw_if_index0].enabled);
288 next0 = L2_EMULATION_NEXT_IP4;
289 vlib_buffer_advance (b0, l2_len0);
291 case ETHERNET_TYPE_IP6:
292 ASSERT (l2_emulations[sw_if_index0].enabled);
294 next0 = L2_EMULATION_NEXT_IP6;
295 vlib_buffer_advance (b0, l2_len0);
300 if (PREDICT_TRUE (!(h1[0] & 0x1)))
304 case ETHERNET_TYPE_IP4:
305 ASSERT (l2_emulations[sw_if_index1].enabled);
307 next1 = L2_EMULATION_NEXT_IP4;
308 vlib_buffer_advance (b1, l2_len1);
310 case ETHERNET_TYPE_IP6:
311 ASSERT (l2_emulations[sw_if_index1].enabled);
313 next1 = L2_EMULATION_NEXT_IP6;
314 vlib_buffer_advance (b1, l2_len1);
319 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
320 && (b0->flags & VLIB_BUFFER_IS_TRACED)))
322 l2_emulation_trace_t *t =
323 vlib_add_trace (vm, node, b0, sizeof (*t));
324 t->extracted = (next0 != ~0);
326 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
327 && (b1->flags & VLIB_BUFFER_IS_TRACED)))
329 l2_emulation_trace_t *t =
330 vlib_add_trace (vm, node, b1, sizeof (*t));
331 t->extracted = (next1 != ~0);
334 /* Determine the next node and remove ourself from bitmap */
335 if (PREDICT_TRUE (next0 == ~0))
336 next0 = vnet_l2_feature_next (b0, em->l2_input_feat_next,
337 L2INPUT_FEAT_L2_EMULATION);
339 /* Determine the next node and remove ourself from bitmap */
340 if (PREDICT_TRUE (next1 == ~0))
341 next1 = vnet_l2_feature_next (b1, em->l2_input_feat_next,
342 L2INPUT_FEAT_L2_EMULATION);
344 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
345 to_next, n_left_to_next,
346 bi0, bi1, next0, next1);
348 while (n_left_from > 0 && n_left_to_next > 0)
365 b0 = vlib_get_buffer (vm, bi0);
366 l2_len0 = vnet_buffer (b0)->l2.l2_len;
368 h0 = vlib_buffer_get_current (b0);
369 ether_type0 = clib_net_to_host_u16 (*(u16 *) (h0 + l2_len0 - 2));
370 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
373 * only extract unicast
375 if (PREDICT_TRUE (!(h0[0] & 0x1)))
379 case ETHERNET_TYPE_IP4:
380 ASSERT (l2_emulations[sw_if_index0].enabled);
382 next0 = L2_EMULATION_NEXT_IP4;
383 vlib_buffer_advance (b0, l2_len0);
385 case ETHERNET_TYPE_IP6:
386 ASSERT (l2_emulations[sw_if_index0].enabled);
388 next0 = L2_EMULATION_NEXT_IP6;
389 vlib_buffer_advance (b0, l2_len0);
395 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
396 && (b0->flags & VLIB_BUFFER_IS_TRACED)))
398 l2_emulation_trace_t *t =
399 vlib_add_trace (vm, node, b0, sizeof (*t));
400 t->extracted = (next0 != ~0);
403 /* Determine the next node and remove ourself from bitmap */
404 if (PREDICT_TRUE (next0 == ~0))
405 next0 = vnet_l2_feature_next (b0, em->l2_input_feat_next,
406 L2INPUT_FEAT_L2_EMULATION);
408 /* verify speculative enqueue, maybe switch current next frame */
409 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
410 to_next, n_left_to_next,
414 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
417 vlib_node_increment_counter (vm, node->node_index,
418 L2_EMULATION_ERROR_IP4, ip4_hits);
419 vlib_node_increment_counter (vm, node->node_index,
420 L2_EMULATION_ERROR_IP6, ip6_hits);
422 return frame->n_vectors;
425 /* packet trace format function */
427 format_l2_emulation_trace (u8 * s, va_list * args)
429 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
430 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
431 l2_emulation_trace_t *t = va_arg (*args, l2_emulation_trace_t *);
433 s = format (s, "l2-emulation: %s", (t->extracted ? "yes" : "no"));
439 VLIB_REGISTER_NODE (l2_emulation_node) = {
440 .function = l2_emulation_node_fn,
441 .name = "l2-emulation",
442 .vector_size = sizeof (u32),
443 .format_trace = format_l2_emulation_trace,
444 .type = VLIB_NODE_TYPE_INTERNAL,
446 .n_errors = ARRAY_LEN(l2_emulation_error_strings),
447 .error_strings = l2_emulation_error_strings,
449 .n_next_nodes = L2_EMULATION_N_NEXT,
451 /* edit / add dispositions here */
453 [L2_EMULATION_NEXT_IP4] = "ip4-input",
454 [L2_EMULATION_NEXT_IP6] = "ip6-input",
459 VLIB_NODE_FUNCTION_MULTIARCH (l2_emulation_node, l2_emulation_node_fn);
462 static clib_error_t *
463 l2_emulation_init (vlib_main_t * vm)
465 l2_emulation_main_t *em = &l2_emulation_main;
467 /* Initialize the feature next-node indexes */
468 feat_bitmap_init_next_nodes (vm,
469 l2_emulation_node.index,
471 l2input_get_feat_names (),
472 em->l2_input_feat_next);
477 VLIB_INIT_FUNCTION (l2_emulation_init);
480 * fd.io coding-style-patch-verification: ON
483 * eval: (c-set-style "gnu")