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/srp/srp.h>
46 #include <vnet/lisp-gpe/lisp_gpe.h>
47 #include <vnet/devices/af_packet/af_packet.h>
50 vnet_sw_interface_is_p2p (vnet_main_t * vnm, u32 sw_if_index)
52 // FIXME - use flags on the HW itf
53 vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
54 return (!(hw->hw_class_index == ethernet_hw_interface_class.index ||
55 hw->hw_class_index == af_packet_device_class.index ||
56 hw->hw_class_index == lisp_gpe_hw_class.index ||
57 hw->hw_class_index == srp_hw_interface_class.index));
62 * @brief Loopback Interfaces.
64 * This file contains code to manage loopback interfaces.
68 ethernet_set_rewrite (vnet_main_t * vnm,
72 void *rewrite, uword max_rewrite_bytes)
74 vnet_sw_interface_t *sub_sw = vnet_get_sw_interface (vnm, sw_if_index);
75 vnet_sw_interface_t *sup_sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
76 vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
77 ethernet_main_t *em = ðernet_main;
78 ethernet_interface_t *ei;
79 ethernet_header_t *h = rewrite;
81 uword n_bytes = sizeof (h[0]);
85 if (sub_sw->sub.eth.flags.one_tag)
87 n_bytes += sizeof (ethernet_vlan_header_t);
89 else if (sub_sw->sub.eth.flags.two_tags)
91 n_bytes += 2 * (sizeof (ethernet_vlan_header_t));
93 // Check for encaps that are not supported for L3 interfaces
94 if (!(sub_sw->sub.eth.flags.exact_match) ||
95 (sub_sw->sub.eth.flags.default_sub) ||
96 (sub_sw->sub.eth.flags.outer_vlan_id_any) ||
97 (sub_sw->sub.eth.flags.inner_vlan_id_any))
103 if (n_bytes > max_rewrite_bytes)
108 #define _(a,b) case VNET_L3_PACKET_TYPE_##a: type = ETHERNET_TYPE_##b; break
111 _(MPLS_UNICAST, MPLS_UNICAST);
112 _(MPLS_MULTICAST, MPLS_MULTICAST);
119 ei = pool_elt_at_index (em->interfaces, hw->hw_instance);
120 clib_memcpy (h->src_address, ei->address, sizeof (h->src_address));
122 clib_memcpy (h->dst_address, dst_address, sizeof (h->dst_address));
124 memset (h->dst_address, ~0, sizeof (h->dst_address)); /* broadcast */
126 if (sub_sw->sub.eth.flags.one_tag)
128 ethernet_vlan_header_t *outer = (void *) (h + 1);
130 h->type = sub_sw->sub.eth.flags.dot1ad ?
131 clib_host_to_net_u16 (ETHERNET_TYPE_DOT1AD) :
132 clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
133 outer->priority_cfi_and_id =
134 clib_host_to_net_u16 (sub_sw->sub.eth.outer_vlan_id);
135 outer->type = clib_host_to_net_u16 (type);
138 else if (sub_sw->sub.eth.flags.two_tags)
140 ethernet_vlan_header_t *outer = (void *) (h + 1);
141 ethernet_vlan_header_t *inner = (void *) (outer + 1);
143 h->type = sub_sw->sub.eth.flags.dot1ad ?
144 clib_host_to_net_u16 (ETHERNET_TYPE_DOT1AD) :
145 clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
146 outer->priority_cfi_and_id =
147 clib_host_to_net_u16 (sub_sw->sub.eth.outer_vlan_id);
148 outer->type = clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
149 inner->priority_cfi_and_id =
150 clib_host_to_net_u16 (sub_sw->sub.eth.inner_vlan_id);
151 inner->type = clib_host_to_net_u16 (type);
156 h->type = clib_host_to_net_u16 (type);
163 VNET_HW_INTERFACE_CLASS (ethernet_hw_interface_class) = {
165 .format_address = format_ethernet_address,
166 .format_header = format_ethernet_header_with_length,
167 .unformat_hw_address = unformat_ethernet_address,
168 .unformat_header = unformat_ethernet_header,
169 .set_rewrite = ethernet_set_rewrite,
174 unformat_ethernet_interface (unformat_input_t * input, va_list * args)
176 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
177 u32 *result = va_arg (*args, u32 *);
179 ethernet_main_t *em = ðernet_main;
180 ethernet_interface_t *eif;
182 if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
185 eif = ethernet_get_interface (em, hw_if_index);
188 *result = hw_if_index;
195 ethernet_register_interface (vnet_main_t * vnm,
199 u32 * hw_if_index_return,
200 ethernet_flag_change_function_t flag_change)
202 ethernet_main_t *em = ðernet_main;
203 ethernet_interface_t *ei;
204 vnet_hw_interface_t *hi;
205 clib_error_t *error = 0;
208 pool_get (em->interfaces, ei);
209 ei->flag_change = flag_change;
211 hw_if_index = vnet_register_interface
213 dev_class_index, dev_instance,
214 ethernet_hw_interface_class.index, ei - em->interfaces);
215 *hw_if_index_return = hw_if_index;
217 hi = vnet_get_hw_interface (vnm, hw_if_index);
219 ethernet_setup_node (vnm->vlib_main, hi->output_node_index);
221 hi->min_packet_bytes = hi->min_supported_packet_bytes =
222 ETHERNET_MIN_PACKET_BYTES;
223 hi->max_packet_bytes = hi->max_supported_packet_bytes =
224 ETHERNET_MAX_PACKET_BYTES;
225 hi->per_packet_overhead_bytes =
226 /* preamble */ 8 + /* inter frame gap */ 12;
228 /* Standard default ethernet MTU. */
229 hi->max_l3_packet_bytes[VLIB_RX] = hi->max_l3_packet_bytes[VLIB_TX] = 9000;
231 clib_memcpy (ei->address, address, sizeof (ei->address));
232 vec_free (hi->hw_address);
233 vec_add (hi->hw_address, address, sizeof (ei->address));
237 pool_put (em->interfaces, ei);
244 ethernet_delete_interface (vnet_main_t * vnm, u32 hw_if_index)
246 ethernet_main_t *em = ðernet_main;
247 ethernet_interface_t *ei;
248 vnet_hw_interface_t *hi;
249 main_intf_t *main_intf;
250 vlan_table_t *vlan_table;
253 hi = vnet_get_hw_interface (vnm, hw_if_index);
254 ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
256 /* Delete vlan mapping table for dot1q and dot1ad. */
257 main_intf = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
258 if (main_intf->dot1q_vlans)
260 vlan_table = vec_elt_at_index (em->vlan_pool, main_intf->dot1q_vlans);
261 for (idx = 0; idx < ETHERNET_N_VLAN; idx++)
263 if (vlan_table->vlans[idx].qinqs)
265 pool_put_index (em->qinq_pool, vlan_table->vlans[idx].qinqs);
268 pool_put_index (em->vlan_pool, main_intf->dot1q_vlans);
270 if (main_intf->dot1ad_vlans)
272 vlan_table = vec_elt_at_index (em->vlan_pool, main_intf->dot1ad_vlans);
273 for (idx = 0; idx < ETHERNET_N_VLAN; idx++)
275 if (vlan_table->vlans[idx].qinqs)
277 pool_put_index (em->qinq_pool, vlan_table->vlans[idx].qinqs);
280 pool_put_index (em->vlan_pool, main_intf->dot1ad_vlans);
283 vnet_delete_hw_interface (vnm, hw_if_index);
284 pool_put (em->interfaces, ei);
288 ethernet_set_flags (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
290 ethernet_main_t *em = ðernet_main;
291 vnet_hw_interface_t *hi;
292 ethernet_interface_t *ei;
294 hi = vnet_get_hw_interface (vnm, hw_if_index);
296 ASSERT (hi->hw_class_index == ethernet_hw_interface_class.index);
298 ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
300 return ei->flag_change (vnm, hi, flags);
304 /* Echo packets back to ethernet/l2-input. */
306 simulated_ethernet_interface_tx (vlib_main_t * vm,
307 vlib_node_runtime_t * node,
308 vlib_frame_t * frame)
310 u32 n_left_from, n_left_to_next, n_copy, *from, *to_next;
311 u32 next_index = VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT;
312 u32 i, next_node_index, bvi_flag, sw_if_index;
313 u32 n_pkts = 0, n_bytes = 0;
314 u32 cpu_index = vm->cpu_index;
315 vnet_main_t *vnm = vnet_get_main ();
316 vnet_interface_main_t *im = &vnm->interface_main;
317 vlib_node_main_t *nm = &vm->node_main;
318 vlib_node_t *loop_node;
321 // check tx node index, it is ethernet-input on loopback create
322 // but can be changed to l2-input if loopback is configured as
323 // BVI of a BD (Bridge Domain).
324 loop_node = vec_elt (nm->nodes, node->node_index);
325 next_node_index = loop_node->next_nodes[next_index];
326 bvi_flag = (next_node_index == l2input_node.index) ? 1 : 0;
328 n_left_from = frame->n_vectors;
329 from = vlib_frame_args (frame);
331 while (n_left_from > 0)
333 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
335 n_copy = clib_min (n_left_from, n_left_to_next);
337 clib_memcpy (to_next, from, n_copy * sizeof (from[0]));
338 n_left_to_next -= n_copy;
339 n_left_from -= n_copy;
341 b = vlib_get_buffer (vm, from[i]);
342 sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_TX];
345 // Set up RX and TX indices as if received from a real driver
346 // unless loopback is used as a BVI. For BVI case, leave TX index
347 // and update l2_len in packet as required for l2 forwarding path
348 vnet_buffer (b)->sw_if_index[VLIB_RX] = sw_if_index;
351 vnet_update_l2_len (b);
352 vnet_buffer (b)->sw_if_index[VLIB_TX] = L2INPUT_BVI;
355 vnet_buffer (b)->sw_if_index[VLIB_TX] = (u32) ~ 0;
359 n_bytes += vlib_buffer_length_in_chain (vm, b);
362 b = vlib_get_buffer (vm, from[i]);
368 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
370 /* increment TX interface stat */
371 vlib_increment_combined_counter (im->combined_sw_if_counters +
372 VNET_INTERFACE_COUNTER_TX, cpu_index,
373 sw_if_index, n_pkts, n_bytes);
380 format_simulated_ethernet_name (u8 * s, va_list * args)
382 u32 dev_instance = va_arg (*args, u32);
383 return format (s, "loop%d", dev_instance);
386 static clib_error_t *
387 simulated_ethernet_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
390 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
391 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
392 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
397 VNET_DEVICE_CLASS (ethernet_simulated_device_class) = {
399 .format_device_name = format_simulated_ethernet_name,
400 .tx_function = simulated_ethernet_interface_tx,
401 .admin_up_down_function = simulated_ethernet_admin_up_down,
402 .no_flatten_output_chains = 1,
407 vnet_create_loopback_interface (u32 * sw_if_indexp, u8 * mac_address)
409 vnet_main_t *vnm = vnet_get_main ();
410 vlib_main_t *vm = vlib_get_main ();
415 vnet_hw_interface_t *hw_if;
419 ASSERT (sw_if_indexp);
421 *sw_if_indexp = (u32) ~ 0;
423 memset (address, 0, sizeof (address));
426 * Default MAC address (dead:0000:0000 + instance) is allocated
427 * if zero mac_address is configured. Otherwise, user-configurable MAC
428 * address is programmed on the loopback interface.
430 if (memcmp (address, mac_address, sizeof (address)))
431 clib_memcpy (address, mac_address, sizeof (address));
436 address[5] = instance;
439 error = ethernet_register_interface
441 ethernet_simulated_device_class.index, instance++, address, &hw_if_index,
442 /* flag change */ 0);
446 rv = VNET_API_ERROR_INVALID_REGISTRATION;
447 clib_error_report (error);
451 hw_if = vnet_get_hw_interface (vnm, hw_if_index);
452 slot = vlib_node_add_named_next_with_slot
453 (vm, hw_if->tx_node_index,
454 "ethernet-input", VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
455 ASSERT (slot == VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
458 vnet_sw_interface_t *si = vnet_get_hw_sw_interface (vnm, hw_if_index);
459 *sw_if_indexp = si->sw_if_index;
465 static clib_error_t *
466 create_simulated_ethernet_interfaces (vlib_main_t * vm,
467 unformat_input_t * input,
468 vlib_cli_command_t * cmd)
474 memset (mac_address, 0, sizeof (mac_address));
476 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
478 if (unformat (input, "mac %U", unformat_ethernet_address, mac_address))
484 rv = vnet_create_loopback_interface (&sw_if_index, mac_address);
487 return clib_error_return (0, "vnet_create_loopback_interface failed");
489 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
495 * Create a loopback interface. Optionally, a MAC Address can be
496 * provided. If not provided, de:ad:00:00:00:<loopId> will be used.
499 * The following two command syntaxes are equivalent:
500 * @cliexcmd{loopback create-interface [mac <mac-addr>]}
501 * @cliexcmd{create loopback interface [mac <mac-addr>]}
502 * Example of how to create a loopback interface:
503 * @cliexcmd{loopback create-interface}
506 VLIB_CLI_COMMAND (create_simulated_ethernet_interface_command, static) = {
507 .path = "loopback create-interface",
508 .short_help = "loopback create-interface [mac <mac-addr>]",
509 .function = create_simulated_ethernet_interfaces,
514 * Create a loopback interface. Optionally, a MAC Address can be
515 * provided. If not provided, de:ad:00:00:00:<loopId> will be used.
518 * The following two command syntaxes are equivalent:
519 * @cliexcmd{loopback create-interface [mac <mac-addr>]}
520 * @cliexcmd{create loopback interface [mac <mac-addr>]}
521 * Example of how to create a loopback interface:
522 * @cliexcmd{create loopback interface}
525 VLIB_CLI_COMMAND (create_loopback_interface_command, static) = {
526 .path = "create loopback interface",
527 .short_help = "create loopback interface [mac <mac-addr>]",
528 .function = create_simulated_ethernet_interfaces,
532 ethernet_interface_t *
533 ethernet_get_interface (ethernet_main_t * em, u32 hw_if_index)
535 vnet_hw_interface_t *i =
536 vnet_get_hw_interface (vnet_get_main (), hw_if_index);
537 return (i->hw_class_index ==
538 ethernet_hw_interface_class.
539 index ? pool_elt_at_index (em->interfaces, i->hw_instance) : 0);
543 vnet_delete_loopback_interface (u32 sw_if_index)
545 vnet_main_t *vnm = vnet_get_main ();
546 vnet_sw_interface_t *si;
548 if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
549 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
551 si = vnet_get_sw_interface (vnm, sw_if_index);
552 ethernet_delete_interface (vnm, si->hw_if_index);
558 vnet_delete_sub_interface (u32 sw_if_index)
560 vnet_main_t *vnm = vnet_get_main ();
563 if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
564 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
567 vnet_interface_main_t *im = &vnm->interface_main;
568 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
570 if (si->type == VNET_SW_INTERFACE_TYPE_SUB)
572 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
573 u64 sup_and_sub_key =
574 ((u64) (si->sup_sw_if_index) << 32) | (u64) si->sub.id;
576 hash_unset_mem (im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
577 vnet_delete_sw_interface (vnm, sw_if_index);
581 rv = VNET_API_ERROR_INVALID_SUB_SW_IF_INDEX;
586 static clib_error_t *
587 delete_simulated_ethernet_interfaces (vlib_main_t * vm,
588 unformat_input_t * input,
589 vlib_cli_command_t * cmd)
592 u32 sw_if_index = ~0;
593 vnet_main_t *vnm = vnet_get_main ();
595 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
597 if (unformat (input, "intfc %U",
598 unformat_vnet_sw_interface, vnm, &sw_if_index))
604 if (sw_if_index == ~0)
605 return clib_error_return (0, "interface not specified");
607 rv = vnet_delete_loopback_interface (sw_if_index);
610 return clib_error_return (0, "vnet_delete_loopback_interface failed");
615 static clib_error_t *
616 delete_sub_interface (vlib_main_t * vm,
617 unformat_input_t * input, vlib_cli_command_t * cmd)
620 u32 sw_if_index = ~0;
621 vnet_main_t *vnm = vnet_get_main ();
623 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
626 (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
631 if (sw_if_index == ~0)
632 return clib_error_return (0, "interface doesn't exist");
634 if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
635 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
637 rv = vnet_delete_sub_interface (sw_if_index);
639 return clib_error_return (0, "delete_subinterface_interface failed");
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{loopback delete-interface intfc loop0}
654 VLIB_CLI_COMMAND (delete_simulated_ethernet_interface_command, static) = {
655 .path = "loopback delete-interface",
656 .short_help = "loopback delete-interface intfc <interface>",
657 .function = delete_simulated_ethernet_interfaces,
662 * Delete a loopback interface.
665 * The following two command syntaxes are equivalent:
666 * @cliexcmd{loopback delete-interface intfc <interface>}
667 * @cliexcmd{delete loopback interface intfc <interface>}
668 * Example of how to delete a loopback interface:
669 * @cliexcmd{delete loopback interface intfc loop0}
672 VLIB_CLI_COMMAND (delete_loopback_interface_command, static) = {
673 .path = "delete loopback interface",
674 .short_help = "delete loopback interface intfc <interface>",
675 .function = delete_simulated_ethernet_interfaces,
680 * Delete a sub-interface.
683 * Example of how to delete a sub-interface:
684 * @cliexcmd{delete sub-interface GigabitEthernet0/8/0.200}
687 VLIB_CLI_COMMAND (delete_sub_interface_command, static) = {
688 .path = "delete sub-interface",
689 .short_help = "delete sub-interface <interface>",
690 .function = delete_sub_interface,
695 * fd.io coding-style-patch-verification: ON
698 * eval: (c-set-style "gnu")