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.
16 * ethernet_interface.c: ethernet interfaces
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
40 #include <vnet/vnet.h>
41 #include <vnet/ip/ip.h>
42 #include <vnet/pg/pg.h>
43 #include <vnet/ethernet/ethernet.h>
44 #include <vnet/l2/l2_input.h>
48 * @brief Loopback Interfaces.
50 * This file contains code to manage loopback interfaces.
54 ethernet_set_rewrite (vnet_main_t * vnm,
58 void *rewrite, uword max_rewrite_bytes)
60 vnet_sw_interface_t *sub_sw = vnet_get_sw_interface (vnm, sw_if_index);
61 vnet_sw_interface_t *sup_sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
62 vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
63 ethernet_main_t *em = ðernet_main;
64 ethernet_interface_t *ei;
65 ethernet_header_t *h = rewrite;
67 uword n_bytes = sizeof (h[0]);
71 if (sub_sw->sub.eth.flags.one_tag)
73 n_bytes += sizeof (ethernet_vlan_header_t);
75 else if (sub_sw->sub.eth.flags.two_tags)
77 n_bytes += 2 * (sizeof (ethernet_vlan_header_t));
79 // Check for encaps that are not supported for L3 interfaces
80 if (!(sub_sw->sub.eth.flags.exact_match) ||
81 (sub_sw->sub.eth.flags.default_sub) ||
82 (sub_sw->sub.eth.flags.outer_vlan_id_any) ||
83 (sub_sw->sub.eth.flags.inner_vlan_id_any))
89 if (n_bytes > max_rewrite_bytes)
94 #define _(a,b) case VNET_L3_PACKET_TYPE_##a: type = ETHERNET_TYPE_##b; break
97 _(MPLS_UNICAST, MPLS_UNICAST);
98 _(MPLS_MULTICAST, MPLS_MULTICAST);
105 ei = pool_elt_at_index (em->interfaces, hw->hw_instance);
106 clib_memcpy (h->src_address, ei->address, sizeof (h->src_address));
108 clib_memcpy (h->dst_address, dst_address, sizeof (h->dst_address));
110 memset (h->dst_address, ~0, sizeof (h->dst_address)); /* broadcast */
112 if (sub_sw->sub.eth.flags.one_tag)
114 ethernet_vlan_header_t *outer = (void *) (h + 1);
116 h->type = sub_sw->sub.eth.flags.dot1ad ?
117 clib_host_to_net_u16 (ETHERNET_TYPE_DOT1AD) :
118 clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
119 outer->priority_cfi_and_id =
120 clib_host_to_net_u16 (sub_sw->sub.eth.outer_vlan_id);
121 outer->type = clib_host_to_net_u16 (type);
124 else if (sub_sw->sub.eth.flags.two_tags)
126 ethernet_vlan_header_t *outer = (void *) (h + 1);
127 ethernet_vlan_header_t *inner = (void *) (outer + 1);
129 h->type = sub_sw->sub.eth.flags.dot1ad ?
130 clib_host_to_net_u16 (ETHERNET_TYPE_DOT1AD) :
131 clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
132 outer->priority_cfi_and_id =
133 clib_host_to_net_u16 (sub_sw->sub.eth.outer_vlan_id);
134 outer->type = clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
135 inner->priority_cfi_and_id =
136 clib_host_to_net_u16 (sub_sw->sub.eth.inner_vlan_id);
137 inner->type = clib_host_to_net_u16 (type);
142 h->type = clib_host_to_net_u16 (type);
149 VNET_HW_INTERFACE_CLASS (ethernet_hw_interface_class) = {
151 .format_address = format_ethernet_address,
152 .format_header = format_ethernet_header_with_length,
153 .unformat_hw_address = unformat_ethernet_address,
154 .unformat_header = unformat_ethernet_header,
155 .set_rewrite = ethernet_set_rewrite,
160 unformat_ethernet_interface (unformat_input_t * input, va_list * args)
162 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
163 u32 *result = va_arg (*args, u32 *);
165 ethernet_main_t *em = ðernet_main;
166 ethernet_interface_t *eif;
168 if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
171 eif = ethernet_get_interface (em, hw_if_index);
174 *result = hw_if_index;
181 ethernet_register_interface (vnet_main_t * vnm,
185 u32 * hw_if_index_return,
186 ethernet_flag_change_function_t flag_change)
188 ethernet_main_t *em = ðernet_main;
189 ethernet_interface_t *ei;
190 vnet_hw_interface_t *hi;
191 clib_error_t *error = 0;
194 pool_get (em->interfaces, ei);
195 ei->flag_change = flag_change;
197 hw_if_index = vnet_register_interface
199 dev_class_index, dev_instance,
200 ethernet_hw_interface_class.index, ei - em->interfaces);
201 *hw_if_index_return = hw_if_index;
203 hi = vnet_get_hw_interface (vnm, hw_if_index);
205 ethernet_setup_node (vnm->vlib_main, hi->output_node_index);
207 hi->min_packet_bytes = hi->min_supported_packet_bytes =
208 ETHERNET_MIN_PACKET_BYTES;
209 hi->max_packet_bytes = hi->max_supported_packet_bytes =
210 ETHERNET_MAX_PACKET_BYTES;
211 hi->per_packet_overhead_bytes =
212 /* preamble */ 8 + /* inter frame gap */ 12;
214 /* Standard default ethernet MTU. */
215 hi->max_l3_packet_bytes[VLIB_RX] = hi->max_l3_packet_bytes[VLIB_TX] = 9000;
217 clib_memcpy (ei->address, address, sizeof (ei->address));
218 vec_free (hi->hw_address);
219 vec_add (hi->hw_address, address, sizeof (ei->address));
223 pool_put (em->interfaces, ei);
230 ethernet_delete_interface (vnet_main_t * vnm, u32 hw_if_index)
232 ethernet_main_t *em = ðernet_main;
233 ethernet_interface_t *ei;
234 vnet_hw_interface_t *hi;
235 main_intf_t *main_intf;
236 vlan_table_t *vlan_table;
239 hi = vnet_get_hw_interface (vnm, hw_if_index);
240 ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
242 /* Delete vlan mapping table for dot1q and dot1ad. */
243 main_intf = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
244 if (main_intf->dot1q_vlans)
246 vlan_table = vec_elt_at_index (em->vlan_pool, main_intf->dot1q_vlans);
247 for (idx = 0; idx < ETHERNET_N_VLAN; idx++)
249 if (vlan_table->vlans[idx].qinqs)
251 pool_put_index (em->qinq_pool, vlan_table->vlans[idx].qinqs);
254 pool_put_index (em->vlan_pool, main_intf->dot1q_vlans);
256 if (main_intf->dot1ad_vlans)
258 vlan_table = vec_elt_at_index (em->vlan_pool, main_intf->dot1ad_vlans);
259 for (idx = 0; idx < ETHERNET_N_VLAN; idx++)
261 if (vlan_table->vlans[idx].qinqs)
263 pool_put_index (em->qinq_pool, vlan_table->vlans[idx].qinqs);
266 pool_put_index (em->vlan_pool, main_intf->dot1ad_vlans);
269 vnet_delete_hw_interface (vnm, hw_if_index);
270 pool_put (em->interfaces, ei);
274 ethernet_set_flags (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
276 ethernet_main_t *em = ðernet_main;
277 vnet_hw_interface_t *hi;
278 ethernet_interface_t *ei;
280 hi = vnet_get_hw_interface (vnm, hw_if_index);
282 ASSERT (hi->hw_class_index == ethernet_hw_interface_class.index);
284 ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
286 return ei->flag_change (vnm, hi, flags);
290 /* Echo packets back to ethernet/l2-input. */
292 simulated_ethernet_interface_tx (vlib_main_t * vm,
293 vlib_node_runtime_t * node,
294 vlib_frame_t * frame)
296 u32 n_left_from, n_left_to_next, n_copy, *from, *to_next;
297 u32 next_index = VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT;
298 u32 i, next_node_index, bvi_flag, sw_if_index;
299 u32 n_pkts = 0, n_bytes = 0;
300 u32 cpu_index = vm->cpu_index;
301 vnet_main_t *vnm = vnet_get_main ();
302 vnet_interface_main_t *im = &vnm->interface_main;
303 vlib_node_main_t *nm = &vm->node_main;
304 vlib_node_t *loop_node;
307 // check tx node index, it is ethernet-input on loopback create
308 // but can be changed to l2-input if loopback is configured as
309 // BVI of a BD (Bridge Domain).
310 loop_node = vec_elt (nm->nodes, node->node_index);
311 next_node_index = loop_node->next_nodes[next_index];
312 bvi_flag = (next_node_index == l2input_node.index) ? 1 : 0;
314 n_left_from = frame->n_vectors;
315 from = vlib_frame_args (frame);
317 while (n_left_from > 0)
319 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
321 n_copy = clib_min (n_left_from, n_left_to_next);
323 clib_memcpy (to_next, from, n_copy * sizeof (from[0]));
324 n_left_to_next -= n_copy;
325 n_left_from -= n_copy;
327 b = vlib_get_buffer (vm, from[i]);
328 sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_TX];
331 // Set up RX and TX indices as if received from a real driver
332 // unless loopback is used as a BVI. For BVI case, leave TX index
333 // and update l2_len in packet as required for l2 forwarding path
334 vnet_buffer (b)->sw_if_index[VLIB_RX] = sw_if_index;
336 vnet_update_l2_len (b);
338 vnet_buffer (b)->sw_if_index[VLIB_TX] = (u32) ~ 0;
342 n_bytes += vlib_buffer_length_in_chain (vm, b);
345 b = vlib_get_buffer (vm, from[i]);
350 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
352 /* increment TX interface stat */
353 vlib_increment_combined_counter (im->combined_sw_if_counters +
354 VNET_INTERFACE_COUNTER_TX, cpu_index,
355 sw_if_index, n_pkts, n_bytes);
362 format_simulated_ethernet_name (u8 * s, va_list * args)
364 u32 dev_instance = va_arg (*args, u32);
365 return format (s, "loop%d", dev_instance);
368 static clib_error_t *
369 simulated_ethernet_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
372 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
373 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
374 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
379 VNET_DEVICE_CLASS (ethernet_simulated_device_class) = {
381 .format_device_name = format_simulated_ethernet_name,
382 .tx_function = simulated_ethernet_interface_tx,
383 .admin_up_down_function = simulated_ethernet_admin_up_down,
384 .no_flatten_output_chains = 1,
389 vnet_create_loopback_interface (u32 * sw_if_indexp, u8 * mac_address)
391 vnet_main_t *vnm = vnet_get_main ();
392 vlib_main_t *vm = vlib_get_main ();
397 vnet_hw_interface_t *hw_if;
401 ASSERT (sw_if_indexp);
403 *sw_if_indexp = (u32) ~ 0;
405 memset (address, 0, sizeof (address));
408 * Default MAC address (dead:0000:0000 + instance) is allocated
409 * if zero mac_address is configured. Otherwise, user-configurable MAC
410 * address is programmed on the loopback interface.
412 if (memcmp (address, mac_address, sizeof (address)))
413 clib_memcpy (address, mac_address, sizeof (address));
418 address[5] = instance;
421 error = ethernet_register_interface
423 ethernet_simulated_device_class.index, instance++, address, &hw_if_index,
424 /* flag change */ 0);
428 rv = VNET_API_ERROR_INVALID_REGISTRATION;
429 clib_error_report (error);
433 hw_if = vnet_get_hw_interface (vnm, hw_if_index);
434 slot = vlib_node_add_named_next_with_slot
435 (vm, hw_if->tx_node_index,
436 "ethernet-input", VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
437 ASSERT (slot == VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
440 vnet_sw_interface_t *si = vnet_get_hw_sw_interface (vnm, hw_if_index);
441 *sw_if_indexp = si->sw_if_index;
447 static clib_error_t *
448 create_simulated_ethernet_interfaces (vlib_main_t * vm,
449 unformat_input_t * input,
450 vlib_cli_command_t * cmd)
456 memset (mac_address, 0, sizeof (mac_address));
458 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
460 if (unformat (input, "mac %U", unformat_ethernet_address, mac_address))
466 rv = vnet_create_loopback_interface (&sw_if_index, mac_address);
469 return clib_error_return (0, "vnet_create_loopback_interface failed");
471 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
477 * Create a loopback interface. Optionally, a MAC Address can be
478 * provided. If not provided, de:ad:00:00:00:<loopId> will be used.
481 * The following two command syntaxes are equivalent:
482 * @cliexcmd{loopback create-interface [mac <mac-addr>]}
483 * @cliexcmd{create loopback interface [mac <mac-addr>]}
484 * Example of how to create a loopback interface:
485 * @cliexcmd{loopback create-interface}
488 VLIB_CLI_COMMAND (create_simulated_ethernet_interface_command, static) = {
489 .path = "loopback create-interface",
490 .short_help = "loopback create-interface [mac <mac-addr>]",
491 .function = create_simulated_ethernet_interfaces,
496 * Create a loopback interface. Optionally, a MAC Address can be
497 * provided. If not provided, de:ad:00:00:00:<loopId> will be used.
500 * The following two command syntaxes are equivalent:
501 * @cliexcmd{loopback create-interface [mac <mac-addr>]}
502 * @cliexcmd{create loopback interface [mac <mac-addr>]}
503 * Example of how to create a loopback interface:
504 * @cliexcmd{create loopback interface}
507 VLIB_CLI_COMMAND (create_loopback_interface_command, static) = {
508 .path = "create loopback interface",
509 .short_help = "create loopback interface [mac <mac-addr>]",
510 .function = create_simulated_ethernet_interfaces,
514 ethernet_interface_t *
515 ethernet_get_interface (ethernet_main_t * em, u32 hw_if_index)
517 vnet_hw_interface_t *i =
518 vnet_get_hw_interface (vnet_get_main (), hw_if_index);
519 return (i->hw_class_index ==
520 ethernet_hw_interface_class.
521 index ? pool_elt_at_index (em->interfaces, i->hw_instance) : 0);
525 vnet_delete_loopback_interface (u32 sw_if_index)
527 vnet_main_t *vnm = vnet_get_main ();
528 vnet_sw_interface_t *si;
530 if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
531 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
533 si = vnet_get_sw_interface (vnm, sw_if_index);
534 ethernet_delete_interface (vnm, si->hw_if_index);
540 vnet_delete_sub_interface (u32 sw_if_index)
542 vnet_main_t *vnm = vnet_get_main ();
545 if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
546 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
549 vnet_interface_main_t *im = &vnm->interface_main;
550 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
552 if (si->type == VNET_SW_INTERFACE_TYPE_SUB)
554 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
555 u64 sup_and_sub_key =
556 ((u64) (si->sup_sw_if_index) << 32) | (u64) si->sub.id;
558 hash_unset_mem (im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
559 vnet_delete_sw_interface (vnm, sw_if_index);
563 rv = VNET_API_ERROR_INVALID_SUB_SW_IF_INDEX;
568 static clib_error_t *
569 delete_simulated_ethernet_interfaces (vlib_main_t * vm,
570 unformat_input_t * input,
571 vlib_cli_command_t * cmd)
574 u32 sw_if_index = ~0;
575 vnet_main_t *vnm = vnet_get_main ();
577 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
579 if (unformat (input, "intfc %U",
580 unformat_vnet_sw_interface, vnm, &sw_if_index))
586 if (sw_if_index == ~0)
587 return clib_error_return (0, "interface not specified");
589 rv = vnet_delete_loopback_interface (sw_if_index);
592 return clib_error_return (0, "vnet_delete_loopback_interface failed");
597 static clib_error_t *
598 delete_sub_interface (vlib_main_t * vm,
599 unformat_input_t * input, vlib_cli_command_t * cmd)
602 u32 sw_if_index = ~0;
603 vnet_main_t *vnm = vnet_get_main ();
605 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
608 (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
613 if (sw_if_index == ~0)
614 return clib_error_return (0, "interface doesn't exist");
616 if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
617 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
619 rv = vnet_delete_sub_interface (sw_if_index);
621 return clib_error_return (0, "delete_subinterface_interface failed");
626 * Delete a loopback interface.
629 * The following two command syntaxes are equivalent:
630 * @cliexcmd{loopback delete-interface intfc <interface>}
631 * @cliexcmd{delete loopback interface intfc <interface>}
632 * Example of how to delete a loopback interface:
633 * @cliexcmd{loopback delete-interface intfc loop0}
636 VLIB_CLI_COMMAND (delete_simulated_ethernet_interface_command, static) = {
637 .path = "loopback delete-interface",
638 .short_help = "loopback delete-interface intfc <interface>",
639 .function = delete_simulated_ethernet_interfaces,
644 * Delete a loopback interface.
647 * The following two command syntaxes are equivalent:
648 * @cliexcmd{loopback delete-interface intfc <interface>}
649 * @cliexcmd{delete loopback interface intfc <interface>}
650 * Example of how to delete a loopback interface:
651 * @cliexcmd{delete loopback interface intfc loop0}
654 VLIB_CLI_COMMAND (delete_loopback_interface_command, static) = {
655 .path = "delete loopback interface",
656 .short_help = "delete loopback interface intfc <interface>",
657 .function = delete_simulated_ethernet_interfaces,
662 * Delete a sub-interface.
665 * Example of how to delete a sub-interface:
666 * @cliexcmd{delete sub-interface GigabitEthernet0/8/0.200}
669 VLIB_CLI_COMMAND (delete_sub_interface_command, static) = {
670 .path = "delete sub-interface",
671 .short_help = "delete sub-interface <interface>",
672 .function = delete_sub_interface,
677 * fd.io coding-style-patch-verification: ON
680 * eval: (c-set-style "gnu")