2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
15 #include <vnet/l2/l2_xcrw.h>
18 * General L2 / L3 cross-connect, used to set up
19 * "L2 interface <--> your-favorite-tunnel-encap" tunnels.
21 * We set up a typical L2 cross-connect or (future) bridge
22 * to hook L2 interface(s) up to the L3 stack in arbitrary ways.
24 * Each l2_xcrw adjacency specifies 3 things:
26 * 1. The next graph node (presumably in the L3 stack) to
27 * process the (L2 -> L3) packet
29 * 2. A new value for vnet_buffer(b)->sw_if_index[VLIB_TX]
30 * (i.e. a lookup FIB index),
32 * 3. A rewrite string to apply.
34 * Example: to cross-connect an L2 interface or (future) bridge
35 * to an mpls-o-gre tunnel, set up the L2 rewrite string as shown in
36 * mpls_gre_rewrite, and use "mpls-post-rewrite" to fix the
37 * GRE IP header checksum and length fields.
45 /* packet trace format function */
46 static u8 * format_l2_xcrw_trace (u8 * s, va_list * args)
48 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
49 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
50 l2_xcrw_trace_t * t = va_arg (*args, l2_xcrw_trace_t *);
52 s = format (s, "L2_XCRW: next index %d tx_fib_index %d",
53 t->next_index, t->tx_fib_index);
57 l2_xcrw_main_t l2_xcrw_main;
59 static vlib_node_registration_t l2_xcrw_node;
61 static char * l2_xcrw_error_strings[] = {
62 #define _(sym,string) string,
68 l2_xcrw_node_fn (vlib_main_t * vm,
69 vlib_node_runtime_t * node,
72 u32 n_left_from, * from, * to_next;
73 l2_xcrw_next_t next_index;
74 l2_xcrw_main_t * xcm = &l2_xcrw_main;
75 vlib_node_t *n = vlib_get_node (vm, l2_xcrw_node.index);
76 u32 node_counter_base_index = n->error_heap_index;
77 vlib_error_main_t * em = &vm->error_main;
79 from = vlib_frame_vector_args (frame);
80 n_left_from = frame->n_vectors;
81 next_index = node->cached_next_index;
83 while (n_left_from > 0)
87 vlib_get_next_frame (vm, node, next_index,
88 to_next, n_left_to_next);
90 while (n_left_from >= 4 && n_left_to_next >= 2)
93 vlib_buffer_t * b0, * b1;
95 u32 sw_if_index0, sw_if_index1;
96 l2_xcrw_adjacency_t * adj0, * adj1;
98 /* Prefetch next iteration. */
100 vlib_buffer_t * p2, * p3;
102 p2 = vlib_get_buffer (vm, from[2]);
103 p3 = vlib_get_buffer (vm, from[3]);
105 vlib_prefetch_buffer_header (p2, LOAD);
106 vlib_prefetch_buffer_header (p3, LOAD);
108 CLIB_PREFETCH (p2->data, CLIB_CACHE_LINE_BYTES, STORE);
109 CLIB_PREFETCH (p3->data, CLIB_CACHE_LINE_BYTES, STORE);
112 /* speculatively enqueue b0 and b1 to the current next frame */
113 to_next[0] = bi0 = from[0];
114 to_next[1] = bi1 = from[1];
120 b0 = vlib_get_buffer (vm, bi0);
121 b1 = vlib_get_buffer (vm, bi1);
123 sw_if_index0 = vnet_buffer(b0)->sw_if_index[VLIB_RX];
124 sw_if_index1 = vnet_buffer(b1)->sw_if_index[VLIB_RX];
126 adj0 = vec_elt_at_index (xcm->adj_by_sw_if_index, sw_if_index0);
127 adj1 = vec_elt_at_index (xcm->adj_by_sw_if_index, sw_if_index1);
129 next0 = adj0->rewrite_header.next_index;
130 vnet_buffer(b0)->sw_if_index[VLIB_TX] =
131 adj0->rewrite_header.sw_if_index;
133 next1 = adj1->rewrite_header.next_index;
134 vnet_buffer(b1)->sw_if_index[VLIB_TX] =
135 adj1->rewrite_header.sw_if_index;
137 em->counters[node_counter_base_index + next1]++;
139 if (PREDICT_TRUE(next0 > 0))
141 u8 * h0 = vlib_buffer_get_current (b0);
142 vnet_rewrite_one_header (adj0[0], h0,
143 adj0->rewrite_header.data_bytes);
144 vlib_buffer_advance (b0, -adj0->rewrite_header.data_bytes);
145 em->counters[node_counter_base_index + L2_XCRW_ERROR_FWD]++;
148 if (PREDICT_TRUE(next1 > 0))
150 u8 * h1 = vlib_buffer_get_current (b1);
151 vnet_rewrite_one_header (adj1[0], h1,
152 adj1->rewrite_header.data_bytes);
153 vlib_buffer_advance (b1, -adj1->rewrite_header.data_bytes);
154 em->counters[node_counter_base_index + L2_XCRW_ERROR_FWD]++;
158 if (PREDICT_FALSE((node->flags & VLIB_NODE_FLAG_TRACE)))
160 if (PREDICT_FALSE((node->flags & VLIB_NODE_FLAG_TRACE)
161 && (b0->flags & VLIB_BUFFER_IS_TRACED)))
164 vlib_add_trace (vm, node, b0, sizeof (*t));
165 t->next_index = next0;
166 t->tx_fib_index = adj0->rewrite_header.sw_if_index;
168 if (PREDICT_FALSE((node->flags & VLIB_NODE_FLAG_TRACE)
169 && (b1->flags & VLIB_BUFFER_IS_TRACED)))
172 vlib_add_trace (vm, node, b1, sizeof (*t));
173 t->next_index = next1;
174 t->tx_fib_index = adj1->rewrite_header.sw_if_index;
178 /* verify speculative enqueues, maybe switch current next frame */
179 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
180 to_next, n_left_to_next,
181 bi0, bi1, next0, next1);
184 while (n_left_from > 0 && n_left_to_next > 0)
190 l2_xcrw_adjacency_t * adj0;
192 /* speculatively enqueue b0 to the current next frame */
200 b0 = vlib_get_buffer (vm, bi0);
202 sw_if_index0 = vnet_buffer(b0)->sw_if_index[VLIB_RX];
204 adj0 = vec_elt_at_index (xcm->adj_by_sw_if_index, sw_if_index0);
206 next0 = adj0->rewrite_header.next_index;
207 vnet_buffer(b0)->sw_if_index[VLIB_TX] =
208 adj0->rewrite_header.sw_if_index;
210 if (PREDICT_TRUE(next0 > 0))
212 u8 *h0 = vlib_buffer_get_current (b0);
213 vnet_rewrite_one_header (adj0[0], h0,
214 adj0->rewrite_header.data_bytes);
215 vlib_buffer_advance (b0, -adj0->rewrite_header.data_bytes);
216 em->counters[node_counter_base_index + L2_XCRW_ERROR_FWD]++;
219 if (PREDICT_FALSE((node->flags & VLIB_NODE_FLAG_TRACE)
220 && (b0->flags & VLIB_BUFFER_IS_TRACED)))
223 vlib_add_trace (vm, node, b0, sizeof (*t));
224 t->next_index = next0;
225 t->tx_fib_index = adj0->rewrite_header.sw_if_index;
228 /* verify speculative enqueue, maybe switch current next frame */
229 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
230 to_next, n_left_to_next,
234 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
237 return frame->n_vectors;
240 VLIB_REGISTER_NODE (l2_xcrw_node, static) = {
241 .function = l2_xcrw_node_fn,
243 .vector_size = sizeof (u32),
244 .format_trace = format_l2_xcrw_trace,
245 .type = VLIB_NODE_TYPE_INTERNAL,
247 .n_errors = ARRAY_LEN(l2_xcrw_error_strings),
248 .error_strings = l2_xcrw_error_strings,
250 .n_next_nodes = L2_XCRW_N_NEXT,
252 /* edit / add dispositions here */
254 [L2_XCRW_NEXT_DROP] = "error-drop",
258 VLIB_NODE_FUNCTION_MULTIARCH (l2_xcrw_node, l2_xcrw_node_fn)
260 clib_error_t *l2_xcrw_init (vlib_main_t *vm)
262 l2_xcrw_main_t * mp = &l2_xcrw_main;
265 mp->vnet_main = &vnet_main;
266 mp->tunnel_index_by_l2_sw_if_index = hash_create (0, sizeof(uword));
271 VLIB_INIT_FUNCTION (l2_xcrw_init);
273 static uword dummy_interface_tx (vlib_main_t * vm,
274 vlib_node_runtime_t * node,
275 vlib_frame_t * frame)
277 clib_warning ("you shouldn't be here, leaking buffers...");
278 return frame->n_vectors;
281 static u8 * format_xcrw_name (u8 * s, va_list * args)
283 u32 dev_instance = va_arg (*args, u32);
284 return format (s, "xcrw%d", dev_instance);
287 VNET_DEVICE_CLASS (xcrw_device_class,static) = {
289 .format_device_name = format_xcrw_name,
290 .tx_function = dummy_interface_tx,
293 /* Create a sham tunnel interface and return its sw_if_index */
295 create_xcrw_interface (vlib_main_t * vm)
297 vnet_main_t * vnm = vnet_get_main();
301 vnet_hw_interface_t * hi;
304 /* mac address doesn't really matter */
305 memset (address, 0, sizeof (address));
308 /* can returns error iff phy != 0 */
309 (void) ethernet_register_interface
311 xcrw_device_class.index,
315 /* flag change */ 0);
317 hi = vnet_get_hw_interface (vnm, hw_if_index);
318 sw_if_index = hi->sw_if_index;
319 vnet_sw_interface_set_flags (vnm, sw_if_index,
320 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
322 /* Output to the sham tunnel invokes the encap node */
323 hi->output_node_index = l2_xcrw_node.index;
328 int vnet_configure_l2_xcrw (vlib_main_t * vm, vnet_main_t *vnm,
329 u32 l2_sw_if_index, u32 tx_fib_index,
330 u8 * rewrite, u32 next_node_index, int is_add)
332 l2_xcrw_main_t * xcm = &l2_xcrw_main;
333 l2_xcrw_adjacency_t * a;
334 l2_xcrw_tunnel_t * t;
340 pool_get (xcm->tunnels, t);
342 /* No interface allocated? Do it. Otherwise, set admin up */
343 if (t->tunnel_sw_if_index == 0)
344 t->tunnel_sw_if_index = create_xcrw_interface (vm);
346 vnet_sw_interface_set_flags (vnm, t->tunnel_sw_if_index,
347 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
349 t->l2_sw_if_index = l2_sw_if_index;
351 vec_validate (xcm->adj_by_sw_if_index, t->l2_sw_if_index);
353 a = vec_elt_at_index (xcm->adj_by_sw_if_index, t->l2_sw_if_index);
354 memset (a, 0, sizeof (*a));
356 a->rewrite_header.sw_if_index = tx_fib_index;
359 * Add or find a dynamic disposition for the successor node,
360 * e.g. so we can ship pkts to mpls_post_rewrite...
362 a->rewrite_header.next_index =
363 vlib_node_add_next (vm, l2_xcrw_node.index, next_node_index);
365 if (vec_len (rewrite))
366 vnet_rewrite_set_data (a[0], rewrite, vec_len(rewrite));
368 set_int_l2_mode (vm, vnm, MODE_L2_XC, t->l2_sw_if_index, 0, 0, 0,
369 t->tunnel_sw_if_index);
370 hash_set (xcm->tunnel_index_by_l2_sw_if_index,
371 t->l2_sw_if_index, t - xcm->tunnels);
376 p = hash_get (xcm->tunnel_index_by_l2_sw_if_index, l2_sw_if_index);
378 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
380 t = pool_elt_at_index (xcm->tunnels, p[0]);
382 a = vec_elt_at_index (xcm->adj_by_sw_if_index, t->l2_sw_if_index);
383 /* Reset adj to drop traffic */
384 memset (a, 0, sizeof (*a));
386 set_int_l2_mode (vm, vnm, MODE_L3, t->l2_sw_if_index, 0, 0, 0, 0);
388 vnet_sw_interface_set_flags (vnm, t->tunnel_sw_if_index, 0 /* down */);
390 hash_unset (xcm->tunnel_index_by_l2_sw_if_index, l2_sw_if_index);
391 pool_put (xcm->tunnels, t);
397 static clib_error_t *
398 set_l2_xcrw_command_fn (vlib_main_t * vm,
399 unformat_input_t * input,
400 vlib_cli_command_t * cmd)
402 unformat_input_t _line_input, * line_input = &_line_input;
404 int is_ipv6 = 0; /* for fib id -> fib index mapping */
406 u32 tx_fib_index = ~0;
407 u32 next_node_index = ~0;
410 vnet_main_t * vnm = vnet_get_main();
414 if (! unformat_user (input, unformat_line_input, line_input))
417 if (! unformat (line_input, "%U",
418 unformat_vnet_sw_interface, vnm, &l2_sw_if_index))
419 return clib_error_return (0, "unknown input '%U'",
420 format_unformat_error, line_input);
422 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
424 if (unformat (line_input, "next %U",
425 unformat_vlib_node, vm, &next_node_index))
427 else if (unformat (line_input, "tx-fib-id %d", &tx_fib_id))
429 else if (unformat (line_input, "del"))
431 else if (unformat (line_input, "ipv6"))
433 else if (unformat (line_input, "rw %U",
434 unformat_hex_string, &rw));
439 if (next_node_index == ~0)
440 return clib_error_return (0, "next node not specified");
447 p = hash_get (ip6_main.fib_index_by_table_id, tx_fib_id);
449 p = hash_get (ip4_main.fib_index_by_table_id, tx_fib_id);
452 return clib_error_return (0, "nonexistent tx_fib_id %d",
458 rv = vnet_configure_l2_xcrw (vm, vnm, l2_sw_if_index, tx_fib_index,
459 rw, next_node_index, is_add);
467 case VNET_API_ERROR_INVALID_SW_IF_INDEX:
468 return clib_error_return (0, "%U not cross-connected",
469 format_vnet_sw_if_index_name,
470 vnm, l2_sw_if_index);
472 return clib_error_return (0, "vnet_configure_l2_xcrw returned %d",
481 VLIB_CLI_COMMAND (set_l2_xcrw_command, static) = {
482 .path = "set interface l2 xcrw",
484 "set int l2 xcrw <interface> next <node-name>\n"
485 " [del] [tx-fib-id <id>] [ipv6] rw <hex-bytes>",
486 .function = set_l2_xcrw_command_fn,
489 static u8 * format_l2xcrw (u8 * s, va_list * args)
491 vnet_main_t * vnm = va_arg (*args, vnet_main_t *);
492 l2_xcrw_tunnel_t * t = va_arg (*args, l2_xcrw_tunnel_t *);
493 l2_xcrw_main_t * xcm = &l2_xcrw_main;
494 vlib_main_t * vm = vlib_get_main ();
495 l2_xcrw_adjacency_t * a;
500 s = format (s, "%-25s%s", "L2 interface", "Tunnel Details");
504 s = format (s, "%-25U %U ",
505 format_vnet_sw_if_index_name, vnm, t->l2_sw_if_index,
506 format_vnet_sw_if_index_name, vnm, t->tunnel_sw_if_index);
508 a = vec_elt_at_index (xcm->adj_by_sw_if_index, t->l2_sw_if_index);
510 s = format (s, "next %U ",
511 format_vlib_next_node_name, vm, l2_xcrw_node.index,
512 a->rewrite_header.next_index);
514 if (a->rewrite_header.sw_if_index != ~0)
515 s = format (s, "tx fib index %d ", a->rewrite_header.sw_if_index);
517 if (a->rewrite_header.data_bytes)
519 rewrite_string = (u8 *)(a + 1);
520 rewrite_string -= a->rewrite_header.data_bytes;
521 s = format (s, "rewrite data: %U ",
522 format_hex_bytes, rewrite_string,
523 a->rewrite_header.data_bytes);
526 s = format (s, "\n");
532 static clib_error_t *
533 show_l2xcrw_command_fn (vlib_main_t * vm,
534 unformat_input_t * input,
535 vlib_cli_command_t * cmd)
537 vnet_main_t * vnm = vnet_get_main();
538 l2_xcrw_main_t * xcm = &l2_xcrw_main;
539 l2_xcrw_tunnel_t * t;
541 if (pool_elts (xcm->tunnels) == 0)
543 vlib_cli_output (vm, "No L2 / L3 rewrite cross-connects configured");
547 vlib_cli_output (vm, "%U", format_l2xcrw, 0, 0);
549 pool_foreach (t, xcm->tunnels,
551 vlib_cli_output (vm, "%U", format_l2xcrw, vnm, t);
557 VLIB_CLI_COMMAND (show_l2xcrw_command, static) = {
558 .path = "show l2xcrw",
559 .short_help = "Display L2/L3 rewrite cross-connects",
560 .function = show_l2xcrw_command_fn,