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 * @brief build a rewrite string to use for sending packets of type 'link_type'
59 ethernet_build_rewrite (vnet_main_t * vnm,
61 vnet_link_t link_type, const void *dst_address)
63 vnet_sw_interface_t *sub_sw = vnet_get_sw_interface (vnm, sw_if_index);
64 vnet_sw_interface_t *sup_sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
65 vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
66 ethernet_main_t *em = ðernet_main;
67 ethernet_interface_t *ei;
70 uword n_bytes = sizeof (h[0]);
75 if (sub_sw->sub.eth.flags.one_tag)
77 n_bytes += sizeof (ethernet_vlan_header_t);
79 else if (sub_sw->sub.eth.flags.two_tags)
81 n_bytes += 2 * (sizeof (ethernet_vlan_header_t));
83 // Check for encaps that are not supported for L3 interfaces
84 if (!(sub_sw->sub.eth.flags.exact_match) ||
85 (sub_sw->sub.eth.flags.default_sub) ||
86 (sub_sw->sub.eth.flags.outer_vlan_id_any) ||
87 (sub_sw->sub.eth.flags.inner_vlan_id_any))
95 #define _(a,b) case VNET_LINK_##a: type = ETHERNET_TYPE_##b; break
98 _(MPLS, MPLS_UNICAST);
105 vec_validate (rewrite, n_bytes - 1);
106 h = (ethernet_header_t *) rewrite;
107 ei = pool_elt_at_index (em->interfaces, hw->hw_instance);
108 clib_memcpy (h->src_address, ei->address, sizeof (h->src_address));
110 clib_memcpy (h->dst_address, dst_address, sizeof (h->dst_address));
112 memset (h->dst_address, ~0, sizeof (h->dst_address)); /* broadcast */
114 if (sub_sw->sub.eth.flags.one_tag)
116 ethernet_vlan_header_t *outer = (void *) (h + 1);
118 h->type = sub_sw->sub.eth.flags.dot1ad ?
119 clib_host_to_net_u16 (ETHERNET_TYPE_DOT1AD) :
120 clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
121 outer->priority_cfi_and_id =
122 clib_host_to_net_u16 (sub_sw->sub.eth.outer_vlan_id);
123 outer->type = clib_host_to_net_u16 (type);
126 else if (sub_sw->sub.eth.flags.two_tags)
128 ethernet_vlan_header_t *outer = (void *) (h + 1);
129 ethernet_vlan_header_t *inner = (void *) (outer + 1);
131 h->type = sub_sw->sub.eth.flags.dot1ad ?
132 clib_host_to_net_u16 (ETHERNET_TYPE_DOT1AD) :
133 clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
134 outer->priority_cfi_and_id =
135 clib_host_to_net_u16 (sub_sw->sub.eth.outer_vlan_id);
136 outer->type = clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
137 inner->priority_cfi_and_id =
138 clib_host_to_net_u16 (sub_sw->sub.eth.inner_vlan_id);
139 inner->type = clib_host_to_net_u16 (type);
144 h->type = clib_host_to_net_u16 (type);
151 ethernet_update_adjacency (vnet_main_t * vnm, u32 sw_if_index, u32 ai)
157 if (FIB_PROTOCOL_IP4 == adj->ia_nh_proto)
159 arp_update_adjacency (vnm, sw_if_index, ai);
161 else if (FIB_PROTOCOL_IP6 == adj->ia_nh_proto)
163 ip6_ethernet_update_adjacency (vnm, sw_if_index, ai);
171 static clib_error_t *
172 ethernet_mac_change (vnet_hw_interface_t * hi, char *mac_address)
174 ethernet_interface_t *ei;
178 ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
180 vec_validate (hi->hw_address,
181 STRUCT_SIZE_OF (ethernet_header_t, src_address) - 1);
182 clib_memcpy (hi->hw_address, mac_address, vec_len (hi->hw_address));
184 clib_memcpy (ei->address, (u8 *) mac_address, sizeof (ei->address));
185 ethernet_arp_change_mac (hi->sw_if_index);
186 ethernet_ndp_change_mac (hi->sw_if_index);
192 VNET_HW_INTERFACE_CLASS (ethernet_hw_interface_class) = {
194 .format_address = format_ethernet_address,
195 .format_header = format_ethernet_header_with_length,
196 .unformat_hw_address = unformat_ethernet_address,
197 .unformat_header = unformat_ethernet_header,
198 .build_rewrite = ethernet_build_rewrite,
199 .update_adjacency = ethernet_update_adjacency,
200 .mac_addr_change_function = ethernet_mac_change,
205 unformat_ethernet_interface (unformat_input_t * input, va_list * args)
207 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
208 u32 *result = va_arg (*args, u32 *);
210 ethernet_main_t *em = ðernet_main;
211 ethernet_interface_t *eif;
213 if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
216 eif = ethernet_get_interface (em, hw_if_index);
219 *result = hw_if_index;
226 ethernet_register_interface (vnet_main_t * vnm,
230 u32 * hw_if_index_return,
231 ethernet_flag_change_function_t flag_change)
233 ethernet_main_t *em = ðernet_main;
234 ethernet_interface_t *ei;
235 vnet_hw_interface_t *hi;
236 clib_error_t *error = 0;
239 pool_get (em->interfaces, ei);
240 ei->flag_change = flag_change;
242 hw_if_index = vnet_register_interface
244 dev_class_index, dev_instance,
245 ethernet_hw_interface_class.index, ei - em->interfaces);
246 *hw_if_index_return = hw_if_index;
248 hi = vnet_get_hw_interface (vnm, hw_if_index);
250 ethernet_setup_node (vnm->vlib_main, hi->output_node_index);
252 hi->min_packet_bytes = hi->min_supported_packet_bytes =
253 ETHERNET_MIN_PACKET_BYTES;
254 hi->max_packet_bytes = hi->max_supported_packet_bytes =
255 ETHERNET_MAX_PACKET_BYTES;
256 hi->per_packet_overhead_bytes =
257 /* preamble */ 8 + /* inter frame gap */ 12;
259 /* Standard default ethernet MTU. */
260 hi->max_l3_packet_bytes[VLIB_RX] = hi->max_l3_packet_bytes[VLIB_TX] = 9000;
262 clib_memcpy (ei->address, address, sizeof (ei->address));
263 vec_free (hi->hw_address);
264 vec_add (hi->hw_address, address, sizeof (ei->address));
268 pool_put (em->interfaces, ei);
275 ethernet_delete_interface (vnet_main_t * vnm, u32 hw_if_index)
277 ethernet_main_t *em = ðernet_main;
278 ethernet_interface_t *ei;
279 vnet_hw_interface_t *hi;
280 main_intf_t *main_intf;
281 vlan_table_t *vlan_table;
284 hi = vnet_get_hw_interface (vnm, hw_if_index);
285 ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
287 /* Delete vlan mapping table for dot1q and dot1ad. */
288 main_intf = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
289 if (main_intf->dot1q_vlans)
291 vlan_table = vec_elt_at_index (em->vlan_pool, main_intf->dot1q_vlans);
292 for (idx = 0; idx < ETHERNET_N_VLAN; idx++)
294 if (vlan_table->vlans[idx].qinqs)
296 pool_put_index (em->qinq_pool, vlan_table->vlans[idx].qinqs);
299 pool_put_index (em->vlan_pool, main_intf->dot1q_vlans);
301 if (main_intf->dot1ad_vlans)
303 vlan_table = vec_elt_at_index (em->vlan_pool, main_intf->dot1ad_vlans);
304 for (idx = 0; idx < ETHERNET_N_VLAN; idx++)
306 if (vlan_table->vlans[idx].qinqs)
308 pool_put_index (em->qinq_pool, vlan_table->vlans[idx].qinqs);
311 pool_put_index (em->vlan_pool, main_intf->dot1ad_vlans);
314 vnet_delete_hw_interface (vnm, hw_if_index);
315 pool_put (em->interfaces, ei);
319 ethernet_set_flags (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
321 ethernet_main_t *em = ðernet_main;
322 vnet_hw_interface_t *hi;
323 ethernet_interface_t *ei;
325 hi = vnet_get_hw_interface (vnm, hw_if_index);
327 ASSERT (hi->hw_class_index == ethernet_hw_interface_class.index);
329 ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
331 return ei->flag_change (vnm, hi, flags);
335 /* Echo packets back to ethernet/l2-input. */
337 simulated_ethernet_interface_tx (vlib_main_t * vm,
338 vlib_node_runtime_t * node,
339 vlib_frame_t * frame)
341 u32 n_left_from, n_left_to_next, n_copy, *from, *to_next;
342 u32 next_index = VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT;
343 u32 i, next_node_index, bvi_flag, sw_if_index;
344 u32 n_pkts = 0, n_bytes = 0;
345 u32 cpu_index = vm->cpu_index;
346 vnet_main_t *vnm = vnet_get_main ();
347 vnet_interface_main_t *im = &vnm->interface_main;
348 vlib_node_main_t *nm = &vm->node_main;
349 vlib_node_t *loop_node;
352 // check tx node index, it is ethernet-input on loopback create
353 // but can be changed to l2-input if loopback is configured as
354 // BVI of a BD (Bridge Domain).
355 loop_node = vec_elt (nm->nodes, node->node_index);
356 next_node_index = loop_node->next_nodes[next_index];
357 bvi_flag = (next_node_index == l2input_node.index) ? 1 : 0;
359 n_left_from = frame->n_vectors;
360 from = vlib_frame_args (frame);
362 while (n_left_from > 0)
364 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
366 n_copy = clib_min (n_left_from, n_left_to_next);
368 clib_memcpy (to_next, from, n_copy * sizeof (from[0]));
369 n_left_to_next -= n_copy;
370 n_left_from -= n_copy;
372 b = vlib_get_buffer (vm, from[i]);
373 sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_TX];
376 // Set up RX and TX indices as if received from a real driver
377 // unless loopback is used as a BVI. For BVI case, leave TX index
378 // and update l2_len in packet as required for l2 forwarding path
379 vnet_buffer (b)->sw_if_index[VLIB_RX] = sw_if_index;
382 vnet_update_l2_len (b);
383 vnet_buffer (b)->sw_if_index[VLIB_TX] = L2INPUT_BVI;
386 vnet_buffer (b)->sw_if_index[VLIB_TX] = (u32) ~ 0;
390 n_bytes += vlib_buffer_length_in_chain (vm, b);
393 b = vlib_get_buffer (vm, from[i]);
399 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
401 /* increment TX interface stat */
402 vlib_increment_combined_counter (im->combined_sw_if_counters +
403 VNET_INTERFACE_COUNTER_TX, cpu_index,
404 sw_if_index, n_pkts, n_bytes);
411 format_simulated_ethernet_name (u8 * s, va_list * args)
413 u32 dev_instance = va_arg (*args, u32);
414 return format (s, "loop%d", dev_instance);
417 static clib_error_t *
418 simulated_ethernet_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
421 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
422 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
423 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
428 VNET_DEVICE_CLASS (ethernet_simulated_device_class) = {
430 .format_device_name = format_simulated_ethernet_name,
431 .tx_function = simulated_ethernet_interface_tx,
432 .admin_up_down_function = simulated_ethernet_admin_up_down,
437 vnet_create_loopback_interface (u32 * sw_if_indexp, u8 * mac_address)
439 vnet_main_t *vnm = vnet_get_main ();
440 vlib_main_t *vm = vlib_get_main ();
445 vnet_hw_interface_t *hw_if;
449 ASSERT (sw_if_indexp);
451 *sw_if_indexp = (u32) ~ 0;
453 memset (address, 0, sizeof (address));
456 * Default MAC address (dead:0000:0000 + instance) is allocated
457 * if zero mac_address is configured. Otherwise, user-configurable MAC
458 * address is programmed on the loopback interface.
460 if (memcmp (address, mac_address, sizeof (address)))
461 clib_memcpy (address, mac_address, sizeof (address));
466 address[5] = instance;
469 error = ethernet_register_interface
471 ethernet_simulated_device_class.index, instance++, address, &hw_if_index,
472 /* flag change */ 0);
476 rv = VNET_API_ERROR_INVALID_REGISTRATION;
477 clib_error_report (error);
481 hw_if = vnet_get_hw_interface (vnm, hw_if_index);
482 slot = vlib_node_add_named_next_with_slot
483 (vm, hw_if->tx_node_index,
484 "ethernet-input", VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
485 ASSERT (slot == VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
488 vnet_sw_interface_t *si = vnet_get_hw_sw_interface (vnm, hw_if_index);
489 *sw_if_indexp = si->sw_if_index;
495 static clib_error_t *
496 create_simulated_ethernet_interfaces (vlib_main_t * vm,
497 unformat_input_t * input,
498 vlib_cli_command_t * cmd)
504 memset (mac_address, 0, sizeof (mac_address));
506 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
508 if (unformat (input, "mac %U", unformat_ethernet_address, mac_address))
514 rv = vnet_create_loopback_interface (&sw_if_index, mac_address);
517 return clib_error_return (0, "vnet_create_loopback_interface failed");
519 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
525 * Create a loopback interface. Optionally, a MAC Address can be
526 * provided. If not provided, de:ad:00:00:00:<loopId> will be used.
529 * The following two command syntaxes are equivalent:
530 * @cliexcmd{loopback create-interface [mac <mac-addr>]}
531 * @cliexcmd{create loopback interface [mac <mac-addr>]}
532 * Example of how to create a loopback interface:
533 * @cliexcmd{loopback create-interface}
536 VLIB_CLI_COMMAND (create_simulated_ethernet_interface_command, static) = {
537 .path = "loopback create-interface",
538 .short_help = "loopback create-interface [mac <mac-addr>]",
539 .function = create_simulated_ethernet_interfaces,
544 * Create a loopback interface. Optionally, a MAC Address can be
545 * provided. If not provided, de:ad:00:00:00:<loopId> will be used.
548 * The following two command syntaxes are equivalent:
549 * @cliexcmd{loopback create-interface [mac <mac-addr>]}
550 * @cliexcmd{create loopback interface [mac <mac-addr>]}
551 * Example of how to create a loopback interface:
552 * @cliexcmd{create loopback interface}
555 VLIB_CLI_COMMAND (create_loopback_interface_command, static) = {
556 .path = "create loopback interface",
557 .short_help = "create loopback interface [mac <mac-addr>]",
558 .function = create_simulated_ethernet_interfaces,
562 ethernet_interface_t *
563 ethernet_get_interface (ethernet_main_t * em, u32 hw_if_index)
565 vnet_hw_interface_t *i =
566 vnet_get_hw_interface (vnet_get_main (), hw_if_index);
567 return (i->hw_class_index ==
568 ethernet_hw_interface_class.
569 index ? pool_elt_at_index (em->interfaces, i->hw_instance) : 0);
573 vnet_delete_loopback_interface (u32 sw_if_index)
575 vnet_main_t *vnm = vnet_get_main ();
576 vnet_sw_interface_t *si;
578 if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
579 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
581 si = vnet_get_sw_interface (vnm, sw_if_index);
582 ethernet_delete_interface (vnm, si->hw_if_index);
588 vnet_delete_sub_interface (u32 sw_if_index)
590 vnet_main_t *vnm = vnet_get_main ();
593 if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
594 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
597 vnet_interface_main_t *im = &vnm->interface_main;
598 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
600 if (si->type == VNET_SW_INTERFACE_TYPE_SUB)
602 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
603 u64 sup_and_sub_key =
604 ((u64) (si->sup_sw_if_index) << 32) | (u64) si->sub.id;
606 hash_unset_mem (im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
607 vnet_delete_sw_interface (vnm, sw_if_index);
611 rv = VNET_API_ERROR_INVALID_SUB_SW_IF_INDEX;
616 static clib_error_t *
617 delete_simulated_ethernet_interfaces (vlib_main_t * vm,
618 unformat_input_t * input,
619 vlib_cli_command_t * cmd)
622 u32 sw_if_index = ~0;
623 vnet_main_t *vnm = vnet_get_main ();
625 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
627 if (unformat (input, "intfc %U",
628 unformat_vnet_sw_interface, vnm, &sw_if_index))
634 if (sw_if_index == ~0)
635 return clib_error_return (0, "interface not specified");
637 rv = vnet_delete_loopback_interface (sw_if_index);
640 return clib_error_return (0, "vnet_delete_loopback_interface failed");
645 static clib_error_t *
646 delete_sub_interface (vlib_main_t * vm,
647 unformat_input_t * input, vlib_cli_command_t * cmd)
650 u32 sw_if_index = ~0;
651 vnet_main_t *vnm = vnet_get_main ();
653 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
656 (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
661 if (sw_if_index == ~0)
662 return clib_error_return (0, "interface doesn't exist");
664 if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
665 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
667 rv = vnet_delete_sub_interface (sw_if_index);
669 return clib_error_return (0, "delete_subinterface_interface failed");
674 * Delete a loopback interface.
677 * The following two command syntaxes are equivalent:
678 * @cliexcmd{loopback delete-interface intfc <interface>}
679 * @cliexcmd{delete loopback interface intfc <interface>}
680 * Example of how to delete a loopback interface:
681 * @cliexcmd{loopback delete-interface intfc loop0}
684 VLIB_CLI_COMMAND (delete_simulated_ethernet_interface_command, static) = {
685 .path = "loopback delete-interface",
686 .short_help = "loopback delete-interface intfc <interface>",
687 .function = delete_simulated_ethernet_interfaces,
692 * Delete a loopback interface.
695 * The following two command syntaxes are equivalent:
696 * @cliexcmd{loopback delete-interface intfc <interface>}
697 * @cliexcmd{delete loopback interface intfc <interface>}
698 * Example of how to delete a loopback interface:
699 * @cliexcmd{delete loopback interface intfc loop0}
702 VLIB_CLI_COMMAND (delete_loopback_interface_command, static) = {
703 .path = "delete loopback interface",
704 .short_help = "delete loopback interface intfc <interface>",
705 .function = delete_simulated_ethernet_interfaces,
710 * Delete a sub-interface.
713 * Example of how to delete a sub-interface:
714 * @cliexcmd{delete sub-interface GigabitEthernet0/8/0.200}
717 VLIB_CLI_COMMAND (delete_sub_interface_command, static) = {
718 .path = "delete sub-interface",
719 .short_help = "delete sub-interface <interface>",
720 .function = delete_sub_interface,
725 * fd.io coding-style-patch-verification: ON
728 * eval: (c-set-style "gnu")