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>
45 #include <vnet/adj/adj.h>
49 * @brief Loopback Interfaces.
51 * This file contains code to manage loopback interfaces.
55 ethernet_ip4_mcast_dst_addr (void)
57 const static u8 ethernet_mcast_dst_mac[] = {
58 0x1, 0x0, 0x5e, 0x0, 0x0, 0x0,
61 return (ethernet_mcast_dst_mac);
65 ethernet_ip6_mcast_dst_addr (void)
67 const static u8 ethernet_mcast_dst_mac[] = {
68 0x33, 0x33, 0x00, 0x0, 0x0, 0x0,
71 return (ethernet_mcast_dst_mac);
75 * @brief build a rewrite string to use for sending packets of type 'link_type'
79 ethernet_build_rewrite (vnet_main_t * vnm,
81 vnet_link_t link_type, const void *dst_address)
83 vnet_sw_interface_t *sub_sw = vnet_get_sw_interface (vnm, sw_if_index);
84 vnet_sw_interface_t *sup_sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
85 vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
86 ethernet_main_t *em = ðernet_main;
87 ethernet_interface_t *ei;
90 uword n_bytes = sizeof (h[0]);
95 if (sub_sw->sub.eth.flags.one_tag)
97 n_bytes += sizeof (ethernet_vlan_header_t);
99 else if (sub_sw->sub.eth.flags.two_tags)
101 n_bytes += 2 * (sizeof (ethernet_vlan_header_t));
103 // Check for encaps that are not supported for L3 interfaces
104 if (!(sub_sw->sub.eth.flags.exact_match) ||
105 (sub_sw->sub.eth.flags.default_sub) ||
106 (sub_sw->sub.eth.flags.outer_vlan_id_any) ||
107 (sub_sw->sub.eth.flags.inner_vlan_id_any))
115 #define _(a,b) case VNET_LINK_##a: type = ETHERNET_TYPE_##b; break
118 _(MPLS, MPLS_UNICAST);
125 vec_validate (rewrite, n_bytes - 1);
126 h = (ethernet_header_t *) rewrite;
127 ei = pool_elt_at_index (em->interfaces, hw->hw_instance);
128 clib_memcpy (h->src_address, ei->address, sizeof (h->src_address));
130 clib_memcpy (h->dst_address, dst_address, sizeof (h->dst_address));
132 memset (h->dst_address, ~0, sizeof (h->dst_address)); /* broadcast */
134 if (sub_sw->sub.eth.flags.one_tag)
136 ethernet_vlan_header_t *outer = (void *) (h + 1);
138 h->type = sub_sw->sub.eth.flags.dot1ad ?
139 clib_host_to_net_u16 (ETHERNET_TYPE_DOT1AD) :
140 clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
141 outer->priority_cfi_and_id =
142 clib_host_to_net_u16 (sub_sw->sub.eth.outer_vlan_id);
143 outer->type = clib_host_to_net_u16 (type);
146 else if (sub_sw->sub.eth.flags.two_tags)
148 ethernet_vlan_header_t *outer = (void *) (h + 1);
149 ethernet_vlan_header_t *inner = (void *) (outer + 1);
151 h->type = sub_sw->sub.eth.flags.dot1ad ?
152 clib_host_to_net_u16 (ETHERNET_TYPE_DOT1AD) :
153 clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
154 outer->priority_cfi_and_id =
155 clib_host_to_net_u16 (sub_sw->sub.eth.outer_vlan_id);
156 outer->type = clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
157 inner->priority_cfi_and_id =
158 clib_host_to_net_u16 (sub_sw->sub.eth.inner_vlan_id);
159 inner->type = clib_host_to_net_u16 (type);
164 h->type = clib_host_to_net_u16 (type);
171 ethernet_update_adjacency (vnet_main_t * vnm, u32 sw_if_index, u32 ai)
177 if (FIB_PROTOCOL_IP4 == adj->ia_nh_proto)
179 arp_update_adjacency (vnm, sw_if_index, ai);
181 else if (FIB_PROTOCOL_IP6 == adj->ia_nh_proto)
183 ip6_ethernet_update_adjacency (vnm, sw_if_index, ai);
191 static clib_error_t *
192 ethernet_mac_change (vnet_hw_interface_t * hi, char *mac_address)
194 ethernet_interface_t *ei;
198 ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
200 vec_validate (hi->hw_address,
201 STRUCT_SIZE_OF (ethernet_header_t, src_address) - 1);
202 clib_memcpy (hi->hw_address, mac_address, vec_len (hi->hw_address));
204 clib_memcpy (ei->address, (u8 *) mac_address, sizeof (ei->address));
205 ethernet_arp_change_mac (hi->sw_if_index);
206 ethernet_ndp_change_mac (hi->sw_if_index);
212 VNET_HW_INTERFACE_CLASS (ethernet_hw_interface_class) = {
214 .format_address = format_ethernet_address,
215 .format_header = format_ethernet_header_with_length,
216 .unformat_hw_address = unformat_ethernet_address,
217 .unformat_header = unformat_ethernet_header,
218 .build_rewrite = ethernet_build_rewrite,
219 .update_adjacency = ethernet_update_adjacency,
220 .mac_addr_change_function = ethernet_mac_change,
225 unformat_ethernet_interface (unformat_input_t * input, va_list * args)
227 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
228 u32 *result = va_arg (*args, u32 *);
230 ethernet_main_t *em = ðernet_main;
231 ethernet_interface_t *eif;
233 if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
236 eif = ethernet_get_interface (em, hw_if_index);
239 *result = hw_if_index;
246 ethernet_register_interface (vnet_main_t * vnm,
250 u32 * hw_if_index_return,
251 ethernet_flag_change_function_t flag_change)
253 ethernet_main_t *em = ðernet_main;
254 ethernet_interface_t *ei;
255 vnet_hw_interface_t *hi;
256 clib_error_t *error = 0;
259 pool_get (em->interfaces, ei);
260 ei->flag_change = flag_change;
262 hw_if_index = vnet_register_interface
264 dev_class_index, dev_instance,
265 ethernet_hw_interface_class.index, ei - em->interfaces);
266 *hw_if_index_return = hw_if_index;
268 hi = vnet_get_hw_interface (vnm, hw_if_index);
270 ethernet_setup_node (vnm->vlib_main, hi->output_node_index);
272 hi->min_packet_bytes = hi->min_supported_packet_bytes =
273 ETHERNET_MIN_PACKET_BYTES;
274 hi->max_packet_bytes = hi->max_supported_packet_bytes =
275 ETHERNET_MAX_PACKET_BYTES;
276 hi->per_packet_overhead_bytes =
277 /* preamble */ 8 + /* inter frame gap */ 12;
279 /* Standard default ethernet MTU. */
280 hi->max_l3_packet_bytes[VLIB_RX] = hi->max_l3_packet_bytes[VLIB_TX] = 9000;
282 clib_memcpy (ei->address, address, sizeof (ei->address));
283 vec_free (hi->hw_address);
284 vec_add (hi->hw_address, address, sizeof (ei->address));
288 pool_put (em->interfaces, ei);
295 ethernet_delete_interface (vnet_main_t * vnm, u32 hw_if_index)
297 ethernet_main_t *em = ðernet_main;
298 ethernet_interface_t *ei;
299 vnet_hw_interface_t *hi;
300 main_intf_t *main_intf;
301 vlan_table_t *vlan_table;
304 hi = vnet_get_hw_interface (vnm, hw_if_index);
305 ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
307 /* Delete vlan mapping table for dot1q and dot1ad. */
308 main_intf = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
309 if (main_intf->dot1q_vlans)
311 vlan_table = vec_elt_at_index (em->vlan_pool, main_intf->dot1q_vlans);
312 for (idx = 0; idx < ETHERNET_N_VLAN; idx++)
314 if (vlan_table->vlans[idx].qinqs)
316 pool_put_index (em->qinq_pool, vlan_table->vlans[idx].qinqs);
319 pool_put_index (em->vlan_pool, main_intf->dot1q_vlans);
321 if (main_intf->dot1ad_vlans)
323 vlan_table = vec_elt_at_index (em->vlan_pool, main_intf->dot1ad_vlans);
324 for (idx = 0; idx < ETHERNET_N_VLAN; idx++)
326 if (vlan_table->vlans[idx].qinqs)
328 pool_put_index (em->qinq_pool, vlan_table->vlans[idx].qinqs);
331 pool_put_index (em->vlan_pool, main_intf->dot1ad_vlans);
334 vnet_delete_hw_interface (vnm, hw_if_index);
335 pool_put (em->interfaces, ei);
339 ethernet_set_flags (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
341 ethernet_main_t *em = ðernet_main;
342 vnet_hw_interface_t *hi;
343 ethernet_interface_t *ei;
345 hi = vnet_get_hw_interface (vnm, hw_if_index);
347 ASSERT (hi->hw_class_index == ethernet_hw_interface_class.index);
349 ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
351 return ei->flag_change (vnm, hi, flags);
355 /* Echo packets back to ethernet/l2-input. */
357 simulated_ethernet_interface_tx (vlib_main_t * vm,
358 vlib_node_runtime_t * node,
359 vlib_frame_t * frame)
361 u32 n_left_from, n_left_to_next, n_copy, *from, *to_next;
362 u32 next_index = VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT;
363 u32 i, next_node_index, bvi_flag, sw_if_index;
364 u32 n_pkts = 0, n_bytes = 0;
365 u32 cpu_index = vm->cpu_index;
366 vnet_main_t *vnm = vnet_get_main ();
367 vnet_interface_main_t *im = &vnm->interface_main;
368 vlib_node_main_t *nm = &vm->node_main;
369 vlib_node_t *loop_node;
372 // check tx node index, it is ethernet-input on loopback create
373 // but can be changed to l2-input if loopback is configured as
374 // BVI of a BD (Bridge Domain).
375 loop_node = vec_elt (nm->nodes, node->node_index);
376 next_node_index = loop_node->next_nodes[next_index];
377 bvi_flag = (next_node_index == l2input_node.index) ? 1 : 0;
379 n_left_from = frame->n_vectors;
380 from = vlib_frame_args (frame);
382 while (n_left_from > 0)
384 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
386 n_copy = clib_min (n_left_from, n_left_to_next);
388 clib_memcpy (to_next, from, n_copy * sizeof (from[0]));
389 n_left_to_next -= n_copy;
390 n_left_from -= n_copy;
392 b = vlib_get_buffer (vm, from[i]);
393 sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_TX];
396 // Set up RX and TX indices as if received from a real driver
397 // unless loopback is used as a BVI. For BVI case, leave TX index
398 // and update l2_len in packet as required for l2 forwarding path
399 vnet_buffer (b)->sw_if_index[VLIB_RX] = sw_if_index;
402 vnet_update_l2_len (b);
403 vnet_buffer (b)->sw_if_index[VLIB_TX] = L2INPUT_BVI;
406 vnet_buffer (b)->sw_if_index[VLIB_TX] = (u32) ~ 0;
410 n_bytes += vlib_buffer_length_in_chain (vm, b);
413 b = vlib_get_buffer (vm, from[i]);
419 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
421 /* increment TX interface stat */
422 vlib_increment_combined_counter (im->combined_sw_if_counters +
423 VNET_INTERFACE_COUNTER_TX, cpu_index,
424 sw_if_index, n_pkts, n_bytes);
431 format_simulated_ethernet_name (u8 * s, va_list * args)
433 u32 dev_instance = va_arg (*args, u32);
434 return format (s, "loop%d", dev_instance);
437 static clib_error_t *
438 simulated_ethernet_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
441 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
442 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
443 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
448 VNET_DEVICE_CLASS (ethernet_simulated_device_class) = {
450 .format_device_name = format_simulated_ethernet_name,
451 .tx_function = simulated_ethernet_interface_tx,
452 .admin_up_down_function = simulated_ethernet_admin_up_down,
457 vnet_create_loopback_interface (u32 * sw_if_indexp, u8 * mac_address)
459 vnet_main_t *vnm = vnet_get_main ();
460 vlib_main_t *vm = vlib_get_main ();
465 vnet_hw_interface_t *hw_if;
469 ASSERT (sw_if_indexp);
471 *sw_if_indexp = (u32) ~ 0;
473 memset (address, 0, sizeof (address));
476 * Default MAC address (dead:0000:0000 + instance) is allocated
477 * if zero mac_address is configured. Otherwise, user-configurable MAC
478 * address is programmed on the loopback interface.
480 if (memcmp (address, mac_address, sizeof (address)))
481 clib_memcpy (address, mac_address, sizeof (address));
486 address[5] = instance;
489 error = ethernet_register_interface
491 ethernet_simulated_device_class.index, instance++, address, &hw_if_index,
492 /* flag change */ 0);
496 rv = VNET_API_ERROR_INVALID_REGISTRATION;
497 clib_error_report (error);
501 hw_if = vnet_get_hw_interface (vnm, hw_if_index);
502 slot = vlib_node_add_named_next_with_slot
503 (vm, hw_if->tx_node_index,
504 "ethernet-input", VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
505 ASSERT (slot == VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
508 vnet_sw_interface_t *si = vnet_get_hw_sw_interface (vnm, hw_if_index);
509 *sw_if_indexp = si->sw_if_index;
515 static clib_error_t *
516 create_simulated_ethernet_interfaces (vlib_main_t * vm,
517 unformat_input_t * input,
518 vlib_cli_command_t * cmd)
524 memset (mac_address, 0, sizeof (mac_address));
526 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
528 if (unformat (input, "mac %U", unformat_ethernet_address, mac_address))
534 rv = vnet_create_loopback_interface (&sw_if_index, mac_address);
537 return clib_error_return (0, "vnet_create_loopback_interface failed");
539 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
545 * Create a loopback interface. Optionally, a MAC Address can be
546 * provided. If not provided, de:ad:00:00:00:<loopId> will be used.
549 * The following two command syntaxes are equivalent:
550 * @cliexcmd{loopback create-interface [mac <mac-addr>]}
551 * @cliexcmd{create loopback interface [mac <mac-addr>]}
552 * Example of how to create a loopback interface:
553 * @cliexcmd{loopback create-interface}
556 VLIB_CLI_COMMAND (create_simulated_ethernet_interface_command, static) = {
557 .path = "loopback create-interface",
558 .short_help = "loopback create-interface [mac <mac-addr>]",
559 .function = create_simulated_ethernet_interfaces,
564 * Create a loopback interface. Optionally, a MAC Address can be
565 * provided. If not provided, de:ad:00:00:00:<loopId> will be used.
568 * The following two command syntaxes are equivalent:
569 * @cliexcmd{loopback create-interface [mac <mac-addr>]}
570 * @cliexcmd{create loopback interface [mac <mac-addr>]}
571 * Example of how to create a loopback interface:
572 * @cliexcmd{create loopback interface}
575 VLIB_CLI_COMMAND (create_loopback_interface_command, static) = {
576 .path = "create loopback interface",
577 .short_help = "create loopback interface [mac <mac-addr>]",
578 .function = create_simulated_ethernet_interfaces,
582 ethernet_interface_t *
583 ethernet_get_interface (ethernet_main_t * em, u32 hw_if_index)
585 vnet_hw_interface_t *i =
586 vnet_get_hw_interface (vnet_get_main (), hw_if_index);
587 return (i->hw_class_index ==
588 ethernet_hw_interface_class.
589 index ? pool_elt_at_index (em->interfaces, i->hw_instance) : 0);
593 vnet_delete_loopback_interface (u32 sw_if_index)
595 vnet_main_t *vnm = vnet_get_main ();
596 vnet_sw_interface_t *si;
598 if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
599 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
601 si = vnet_get_sw_interface (vnm, sw_if_index);
602 ethernet_delete_interface (vnm, si->hw_if_index);
608 vnet_delete_sub_interface (u32 sw_if_index)
610 vnet_main_t *vnm = vnet_get_main ();
613 if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
614 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
617 vnet_interface_main_t *im = &vnm->interface_main;
618 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
620 if (si->type == VNET_SW_INTERFACE_TYPE_SUB)
622 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
623 u64 sup_and_sub_key =
624 ((u64) (si->sup_sw_if_index) << 32) | (u64) si->sub.id;
626 hash_unset_mem (im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
627 vnet_delete_sw_interface (vnm, sw_if_index);
631 rv = VNET_API_ERROR_INVALID_SUB_SW_IF_INDEX;
636 static clib_error_t *
637 delete_simulated_ethernet_interfaces (vlib_main_t * vm,
638 unformat_input_t * input,
639 vlib_cli_command_t * cmd)
642 u32 sw_if_index = ~0;
643 vnet_main_t *vnm = vnet_get_main ();
645 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
647 if (unformat (input, "intfc %U",
648 unformat_vnet_sw_interface, vnm, &sw_if_index))
654 if (sw_if_index == ~0)
655 return clib_error_return (0, "interface not specified");
657 rv = vnet_delete_loopback_interface (sw_if_index);
660 return clib_error_return (0, "vnet_delete_loopback_interface failed");
665 static clib_error_t *
666 delete_sub_interface (vlib_main_t * vm,
667 unformat_input_t * input, vlib_cli_command_t * cmd)
670 u32 sw_if_index = ~0;
671 vnet_main_t *vnm = vnet_get_main ();
673 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
676 (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
681 if (sw_if_index == ~0)
682 return clib_error_return (0, "interface doesn't exist");
684 if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
685 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
687 rv = vnet_delete_sub_interface (sw_if_index);
689 return clib_error_return (0, "delete_subinterface_interface failed");
694 * Delete a loopback interface.
697 * The following two command syntaxes are equivalent:
698 * @cliexcmd{loopback delete-interface intfc <interface>}
699 * @cliexcmd{delete loopback interface intfc <interface>}
700 * Example of how to delete a loopback interface:
701 * @cliexcmd{loopback delete-interface intfc loop0}
704 VLIB_CLI_COMMAND (delete_simulated_ethernet_interface_command, static) = {
705 .path = "loopback delete-interface",
706 .short_help = "loopback delete-interface intfc <interface>",
707 .function = delete_simulated_ethernet_interfaces,
712 * Delete a loopback interface.
715 * The following two command syntaxes are equivalent:
716 * @cliexcmd{loopback delete-interface intfc <interface>}
717 * @cliexcmd{delete loopback interface intfc <interface>}
718 * Example of how to delete a loopback interface:
719 * @cliexcmd{delete loopback interface intfc loop0}
722 VLIB_CLI_COMMAND (delete_loopback_interface_command, static) = {
723 .path = "delete loopback interface",
724 .short_help = "delete loopback interface intfc <interface>",
725 .function = delete_simulated_ethernet_interfaces,
730 * Delete a sub-interface.
733 * Example of how to delete a sub-interface:
734 * @cliexcmd{delete sub-interface GigabitEthernet0/8/0.200}
737 VLIB_CLI_COMMAND (delete_sub_interface_command, static) = {
738 .path = "delete sub-interface",
739 .short_help = "delete sub-interface <interface>",
740 .function = delete_sub_interface,
745 * fd.io coding-style-patch-verification: ON
748 * eval: (c-set-style "gnu")