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);
172 VNET_HW_INTERFACE_CLASS (ethernet_hw_interface_class) = {
174 .format_address = format_ethernet_address,
175 .format_header = format_ethernet_header_with_length,
176 .unformat_hw_address = unformat_ethernet_address,
177 .unformat_header = unformat_ethernet_header,
178 .build_rewrite = ethernet_build_rewrite,
179 .update_adjacency = ethernet_update_adjacency,
184 unformat_ethernet_interface (unformat_input_t * input, va_list * args)
186 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
187 u32 *result = va_arg (*args, u32 *);
189 ethernet_main_t *em = ðernet_main;
190 ethernet_interface_t *eif;
192 if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
195 eif = ethernet_get_interface (em, hw_if_index);
198 *result = hw_if_index;
205 ethernet_register_interface (vnet_main_t * vnm,
209 u32 * hw_if_index_return,
210 ethernet_flag_change_function_t flag_change)
212 ethernet_main_t *em = ðernet_main;
213 ethernet_interface_t *ei;
214 vnet_hw_interface_t *hi;
215 clib_error_t *error = 0;
218 pool_get (em->interfaces, ei);
219 ei->flag_change = flag_change;
221 hw_if_index = vnet_register_interface
223 dev_class_index, dev_instance,
224 ethernet_hw_interface_class.index, ei - em->interfaces);
225 *hw_if_index_return = hw_if_index;
227 hi = vnet_get_hw_interface (vnm, hw_if_index);
229 ethernet_setup_node (vnm->vlib_main, hi->output_node_index);
231 hi->min_packet_bytes = hi->min_supported_packet_bytes =
232 ETHERNET_MIN_PACKET_BYTES;
233 hi->max_packet_bytes = hi->max_supported_packet_bytes =
234 ETHERNET_MAX_PACKET_BYTES;
235 hi->per_packet_overhead_bytes =
236 /* preamble */ 8 + /* inter frame gap */ 12;
238 /* Standard default ethernet MTU. */
239 hi->max_l3_packet_bytes[VLIB_RX] = hi->max_l3_packet_bytes[VLIB_TX] = 9000;
241 clib_memcpy (ei->address, address, sizeof (ei->address));
242 vec_free (hi->hw_address);
243 vec_add (hi->hw_address, address, sizeof (ei->address));
247 pool_put (em->interfaces, ei);
254 ethernet_delete_interface (vnet_main_t * vnm, u32 hw_if_index)
256 ethernet_main_t *em = ðernet_main;
257 ethernet_interface_t *ei;
258 vnet_hw_interface_t *hi;
259 main_intf_t *main_intf;
260 vlan_table_t *vlan_table;
263 hi = vnet_get_hw_interface (vnm, hw_if_index);
264 ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
266 /* Delete vlan mapping table for dot1q and dot1ad. */
267 main_intf = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
268 if (main_intf->dot1q_vlans)
270 vlan_table = vec_elt_at_index (em->vlan_pool, main_intf->dot1q_vlans);
271 for (idx = 0; idx < ETHERNET_N_VLAN; idx++)
273 if (vlan_table->vlans[idx].qinqs)
275 pool_put_index (em->qinq_pool, vlan_table->vlans[idx].qinqs);
278 pool_put_index (em->vlan_pool, main_intf->dot1q_vlans);
280 if (main_intf->dot1ad_vlans)
282 vlan_table = vec_elt_at_index (em->vlan_pool, main_intf->dot1ad_vlans);
283 for (idx = 0; idx < ETHERNET_N_VLAN; idx++)
285 if (vlan_table->vlans[idx].qinqs)
287 pool_put_index (em->qinq_pool, vlan_table->vlans[idx].qinqs);
290 pool_put_index (em->vlan_pool, main_intf->dot1ad_vlans);
293 vnet_delete_hw_interface (vnm, hw_if_index);
294 pool_put (em->interfaces, ei);
298 ethernet_set_flags (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
300 ethernet_main_t *em = ðernet_main;
301 vnet_hw_interface_t *hi;
302 ethernet_interface_t *ei;
304 hi = vnet_get_hw_interface (vnm, hw_if_index);
306 ASSERT (hi->hw_class_index == ethernet_hw_interface_class.index);
308 ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
310 return ei->flag_change (vnm, hi, flags);
314 /* Echo packets back to ethernet/l2-input. */
316 simulated_ethernet_interface_tx (vlib_main_t * vm,
317 vlib_node_runtime_t * node,
318 vlib_frame_t * frame)
320 u32 n_left_from, n_left_to_next, n_copy, *from, *to_next;
321 u32 next_index = VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT;
322 u32 i, next_node_index, bvi_flag, sw_if_index;
323 u32 n_pkts = 0, n_bytes = 0;
324 u32 cpu_index = vm->cpu_index;
325 vnet_main_t *vnm = vnet_get_main ();
326 vnet_interface_main_t *im = &vnm->interface_main;
327 vlib_node_main_t *nm = &vm->node_main;
328 vlib_node_t *loop_node;
331 // check tx node index, it is ethernet-input on loopback create
332 // but can be changed to l2-input if loopback is configured as
333 // BVI of a BD (Bridge Domain).
334 loop_node = vec_elt (nm->nodes, node->node_index);
335 next_node_index = loop_node->next_nodes[next_index];
336 bvi_flag = (next_node_index == l2input_node.index) ? 1 : 0;
338 n_left_from = frame->n_vectors;
339 from = vlib_frame_args (frame);
341 while (n_left_from > 0)
343 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
345 n_copy = clib_min (n_left_from, n_left_to_next);
347 clib_memcpy (to_next, from, n_copy * sizeof (from[0]));
348 n_left_to_next -= n_copy;
349 n_left_from -= n_copy;
351 b = vlib_get_buffer (vm, from[i]);
352 sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_TX];
355 // Set up RX and TX indices as if received from a real driver
356 // unless loopback is used as a BVI. For BVI case, leave TX index
357 // and update l2_len in packet as required for l2 forwarding path
358 vnet_buffer (b)->sw_if_index[VLIB_RX] = sw_if_index;
361 vnet_update_l2_len (b);
362 vnet_buffer (b)->sw_if_index[VLIB_TX] = L2INPUT_BVI;
365 vnet_buffer (b)->sw_if_index[VLIB_TX] = (u32) ~ 0;
369 n_bytes += vlib_buffer_length_in_chain (vm, b);
372 b = vlib_get_buffer (vm, from[i]);
378 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
380 /* increment TX interface stat */
381 vlib_increment_combined_counter (im->combined_sw_if_counters +
382 VNET_INTERFACE_COUNTER_TX, cpu_index,
383 sw_if_index, n_pkts, n_bytes);
390 format_simulated_ethernet_name (u8 * s, va_list * args)
392 u32 dev_instance = va_arg (*args, u32);
393 return format (s, "loop%d", dev_instance);
396 static clib_error_t *
397 simulated_ethernet_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
400 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
401 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
402 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
407 VNET_DEVICE_CLASS (ethernet_simulated_device_class) = {
409 .format_device_name = format_simulated_ethernet_name,
410 .tx_function = simulated_ethernet_interface_tx,
411 .admin_up_down_function = simulated_ethernet_admin_up_down,
416 vnet_create_loopback_interface (u32 * sw_if_indexp, u8 * mac_address)
418 vnet_main_t *vnm = vnet_get_main ();
419 vlib_main_t *vm = vlib_get_main ();
424 vnet_hw_interface_t *hw_if;
428 ASSERT (sw_if_indexp);
430 *sw_if_indexp = (u32) ~ 0;
432 memset (address, 0, sizeof (address));
435 * Default MAC address (dead:0000:0000 + instance) is allocated
436 * if zero mac_address is configured. Otherwise, user-configurable MAC
437 * address is programmed on the loopback interface.
439 if (memcmp (address, mac_address, sizeof (address)))
440 clib_memcpy (address, mac_address, sizeof (address));
445 address[5] = instance;
448 error = ethernet_register_interface
450 ethernet_simulated_device_class.index, instance++, address, &hw_if_index,
451 /* flag change */ 0);
455 rv = VNET_API_ERROR_INVALID_REGISTRATION;
456 clib_error_report (error);
460 hw_if = vnet_get_hw_interface (vnm, hw_if_index);
461 slot = vlib_node_add_named_next_with_slot
462 (vm, hw_if->tx_node_index,
463 "ethernet-input", VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
464 ASSERT (slot == VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
467 vnet_sw_interface_t *si = vnet_get_hw_sw_interface (vnm, hw_if_index);
468 *sw_if_indexp = si->sw_if_index;
474 static clib_error_t *
475 create_simulated_ethernet_interfaces (vlib_main_t * vm,
476 unformat_input_t * input,
477 vlib_cli_command_t * cmd)
483 memset (mac_address, 0, sizeof (mac_address));
485 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
487 if (unformat (input, "mac %U", unformat_ethernet_address, mac_address))
493 rv = vnet_create_loopback_interface (&sw_if_index, mac_address);
496 return clib_error_return (0, "vnet_create_loopback_interface failed");
498 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
504 * Create a loopback interface. Optionally, a MAC Address can be
505 * provided. If not provided, de:ad:00:00:00:<loopId> will be used.
508 * The following two command syntaxes are equivalent:
509 * @cliexcmd{loopback create-interface [mac <mac-addr>]}
510 * @cliexcmd{create loopback interface [mac <mac-addr>]}
511 * Example of how to create a loopback interface:
512 * @cliexcmd{loopback create-interface}
515 VLIB_CLI_COMMAND (create_simulated_ethernet_interface_command, static) = {
516 .path = "loopback create-interface",
517 .short_help = "loopback create-interface [mac <mac-addr>]",
518 .function = create_simulated_ethernet_interfaces,
523 * Create a loopback interface. Optionally, a MAC Address can be
524 * provided. If not provided, de:ad:00:00:00:<loopId> will be used.
527 * The following two command syntaxes are equivalent:
528 * @cliexcmd{loopback create-interface [mac <mac-addr>]}
529 * @cliexcmd{create loopback interface [mac <mac-addr>]}
530 * Example of how to create a loopback interface:
531 * @cliexcmd{create loopback interface}
534 VLIB_CLI_COMMAND (create_loopback_interface_command, static) = {
535 .path = "create loopback interface",
536 .short_help = "create loopback interface [mac <mac-addr>]",
537 .function = create_simulated_ethernet_interfaces,
541 ethernet_interface_t *
542 ethernet_get_interface (ethernet_main_t * em, u32 hw_if_index)
544 vnet_hw_interface_t *i =
545 vnet_get_hw_interface (vnet_get_main (), hw_if_index);
546 return (i->hw_class_index ==
547 ethernet_hw_interface_class.
548 index ? pool_elt_at_index (em->interfaces, i->hw_instance) : 0);
552 vnet_delete_loopback_interface (u32 sw_if_index)
554 vnet_main_t *vnm = vnet_get_main ();
555 vnet_sw_interface_t *si;
557 if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
558 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
560 si = vnet_get_sw_interface (vnm, sw_if_index);
561 ethernet_delete_interface (vnm, si->hw_if_index);
567 vnet_delete_sub_interface (u32 sw_if_index)
569 vnet_main_t *vnm = vnet_get_main ();
572 if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
573 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
576 vnet_interface_main_t *im = &vnm->interface_main;
577 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
579 if (si->type == VNET_SW_INTERFACE_TYPE_SUB)
581 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
582 u64 sup_and_sub_key =
583 ((u64) (si->sup_sw_if_index) << 32) | (u64) si->sub.id;
585 hash_unset_mem (im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
586 vnet_delete_sw_interface (vnm, sw_if_index);
590 rv = VNET_API_ERROR_INVALID_SUB_SW_IF_INDEX;
595 static clib_error_t *
596 delete_simulated_ethernet_interfaces (vlib_main_t * vm,
597 unformat_input_t * input,
598 vlib_cli_command_t * cmd)
601 u32 sw_if_index = ~0;
602 vnet_main_t *vnm = vnet_get_main ();
604 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
606 if (unformat (input, "intfc %U",
607 unformat_vnet_sw_interface, vnm, &sw_if_index))
613 if (sw_if_index == ~0)
614 return clib_error_return (0, "interface not specified");
616 rv = vnet_delete_loopback_interface (sw_if_index);
619 return clib_error_return (0, "vnet_delete_loopback_interface failed");
624 static clib_error_t *
625 delete_sub_interface (vlib_main_t * vm,
626 unformat_input_t * input, vlib_cli_command_t * cmd)
629 u32 sw_if_index = ~0;
630 vnet_main_t *vnm = vnet_get_main ();
632 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
635 (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
640 if (sw_if_index == ~0)
641 return clib_error_return (0, "interface doesn't exist");
643 if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
644 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
646 rv = vnet_delete_sub_interface (sw_if_index);
648 return clib_error_return (0, "delete_subinterface_interface failed");
653 * Delete a loopback interface.
656 * The following two command syntaxes are equivalent:
657 * @cliexcmd{loopback delete-interface intfc <interface>}
658 * @cliexcmd{delete loopback interface intfc <interface>}
659 * Example of how to delete a loopback interface:
660 * @cliexcmd{loopback delete-interface intfc loop0}
663 VLIB_CLI_COMMAND (delete_simulated_ethernet_interface_command, static) = {
664 .path = "loopback delete-interface",
665 .short_help = "loopback delete-interface intfc <interface>",
666 .function = delete_simulated_ethernet_interfaces,
671 * Delete a loopback interface.
674 * The following two command syntaxes are equivalent:
675 * @cliexcmd{loopback delete-interface intfc <interface>}
676 * @cliexcmd{delete loopback interface intfc <interface>}
677 * Example of how to delete a loopback interface:
678 * @cliexcmd{delete loopback interface intfc loop0}
681 VLIB_CLI_COMMAND (delete_loopback_interface_command, static) = {
682 .path = "delete loopback interface",
683 .short_help = "delete loopback interface intfc <interface>",
684 .function = delete_simulated_ethernet_interfaces,
689 * Delete a sub-interface.
692 * Example of how to delete a sub-interface:
693 * @cliexcmd{delete sub-interface GigabitEthernet0/8/0.200}
696 VLIB_CLI_COMMAND (delete_sub_interface_command, static) = {
697 .path = "delete sub-interface",
698 .short_help = "delete sub-interface <interface>",
699 .function = delete_sub_interface,
704 * fd.io coding-style-patch-verification: ON
707 * eval: (c-set-style "gnu")