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>
47 ethernet_set_rewrite (vnet_main_t * vnm,
51 void *rewrite, uword max_rewrite_bytes)
53 vnet_sw_interface_t *sub_sw = vnet_get_sw_interface (vnm, sw_if_index);
54 vnet_sw_interface_t *sup_sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
55 vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
56 ethernet_main_t *em = ðernet_main;
57 ethernet_interface_t *ei;
58 ethernet_header_t *h = rewrite;
60 uword n_bytes = sizeof (h[0]);
64 if (sub_sw->sub.eth.flags.one_tag)
66 n_bytes += sizeof (ethernet_vlan_header_t);
68 else if (sub_sw->sub.eth.flags.two_tags)
70 n_bytes += 2 * (sizeof (ethernet_vlan_header_t));
72 // Check for encaps that are not supported for L3 interfaces
73 if (!(sub_sw->sub.eth.flags.exact_match) ||
74 (sub_sw->sub.eth.flags.default_sub) ||
75 (sub_sw->sub.eth.flags.outer_vlan_id_any) ||
76 (sub_sw->sub.eth.flags.inner_vlan_id_any))
82 if (n_bytes > max_rewrite_bytes)
87 #define _(a,b) case VNET_L3_PACKET_TYPE_##a: type = ETHERNET_TYPE_##b; break
90 _(MPLS_UNICAST, MPLS_UNICAST);
91 _(MPLS_MULTICAST, MPLS_MULTICAST);
98 ei = pool_elt_at_index (em->interfaces, hw->hw_instance);
99 clib_memcpy (h->src_address, ei->address, sizeof (h->src_address));
101 clib_memcpy (h->dst_address, dst_address, sizeof (h->dst_address));
103 memset (h->dst_address, ~0, sizeof (h->dst_address)); /* broadcast */
105 if (sub_sw->sub.eth.flags.one_tag)
107 ethernet_vlan_header_t *outer = (void *) (h + 1);
109 h->type = sub_sw->sub.eth.flags.dot1ad ?
110 clib_host_to_net_u16 (ETHERNET_TYPE_DOT1AD) :
111 clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
112 outer->priority_cfi_and_id =
113 clib_host_to_net_u16 (sub_sw->sub.eth.outer_vlan_id);
114 outer->type = clib_host_to_net_u16 (type);
117 else if (sub_sw->sub.eth.flags.two_tags)
119 ethernet_vlan_header_t *outer = (void *) (h + 1);
120 ethernet_vlan_header_t *inner = (void *) (outer + 1);
122 h->type = sub_sw->sub.eth.flags.dot1ad ?
123 clib_host_to_net_u16 (ETHERNET_TYPE_DOT1AD) :
124 clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
125 outer->priority_cfi_and_id =
126 clib_host_to_net_u16 (sub_sw->sub.eth.outer_vlan_id);
127 outer->type = clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
128 inner->priority_cfi_and_id =
129 clib_host_to_net_u16 (sub_sw->sub.eth.inner_vlan_id);
130 inner->type = clib_host_to_net_u16 (type);
135 h->type = clib_host_to_net_u16 (type);
142 VNET_HW_INTERFACE_CLASS (ethernet_hw_interface_class) = {
144 .format_address = format_ethernet_address,
145 .format_header = format_ethernet_header_with_length,
146 .unformat_hw_address = unformat_ethernet_address,
147 .unformat_header = unformat_ethernet_header,
148 .set_rewrite = ethernet_set_rewrite,
153 unformat_ethernet_interface (unformat_input_t * input, va_list * args)
155 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
156 u32 *result = va_arg (*args, u32 *);
158 ethernet_main_t *em = ðernet_main;
159 ethernet_interface_t *eif;
161 if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
164 eif = ethernet_get_interface (em, hw_if_index);
167 *result = hw_if_index;
174 ethernet_register_interface (vnet_main_t * vnm,
178 u32 * hw_if_index_return,
179 ethernet_flag_change_function_t flag_change)
181 ethernet_main_t *em = ðernet_main;
182 ethernet_interface_t *ei;
183 vnet_hw_interface_t *hi;
184 clib_error_t *error = 0;
187 pool_get (em->interfaces, ei);
188 ei->flag_change = flag_change;
190 hw_if_index = vnet_register_interface
192 dev_class_index, dev_instance,
193 ethernet_hw_interface_class.index, ei - em->interfaces);
194 *hw_if_index_return = hw_if_index;
196 hi = vnet_get_hw_interface (vnm, hw_if_index);
198 ethernet_setup_node (vnm->vlib_main, hi->output_node_index);
200 hi->min_packet_bytes = hi->min_supported_packet_bytes =
201 ETHERNET_MIN_PACKET_BYTES;
202 hi->max_packet_bytes = hi->max_supported_packet_bytes =
203 ETHERNET_MAX_PACKET_BYTES;
204 hi->per_packet_overhead_bytes =
205 /* preamble */ 8 + /* inter frame gap */ 12;
207 /* Standard default ethernet MTU. */
208 hi->max_l3_packet_bytes[VLIB_RX] = hi->max_l3_packet_bytes[VLIB_TX] = 9000;
210 clib_memcpy (ei->address, address, sizeof (ei->address));
211 vec_free (hi->hw_address);
212 vec_add (hi->hw_address, address, sizeof (ei->address));
216 pool_put (em->interfaces, ei);
223 ethernet_delete_interface (vnet_main_t * vnm, u32 hw_if_index)
225 ethernet_main_t *em = ðernet_main;
226 ethernet_interface_t *ei;
227 vnet_hw_interface_t *hi;
228 main_intf_t *main_intf;
229 vlan_table_t *vlan_table;
232 hi = vnet_get_hw_interface (vnm, hw_if_index);
233 ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
235 /* Delete vlan mapping table for dot1q and dot1ad. */
236 main_intf = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
237 if (main_intf->dot1q_vlans)
239 vlan_table = vec_elt_at_index (em->vlan_pool, main_intf->dot1q_vlans);
240 for (idx = 0; idx < ETHERNET_N_VLAN; idx++)
242 if (vlan_table->vlans[idx].qinqs)
244 pool_put_index (em->qinq_pool, vlan_table->vlans[idx].qinqs);
247 pool_put_index (em->vlan_pool, main_intf->dot1q_vlans);
249 if (main_intf->dot1ad_vlans)
251 vlan_table = vec_elt_at_index (em->vlan_pool, main_intf->dot1ad_vlans);
252 for (idx = 0; idx < ETHERNET_N_VLAN; idx++)
254 if (vlan_table->vlans[idx].qinqs)
256 pool_put_index (em->qinq_pool, vlan_table->vlans[idx].qinqs);
259 pool_put_index (em->vlan_pool, main_intf->dot1ad_vlans);
262 vnet_delete_hw_interface (vnm, hw_if_index);
263 pool_put (em->interfaces, ei);
267 ethernet_set_flags (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
269 ethernet_main_t *em = ðernet_main;
270 vnet_hw_interface_t *hi;
271 ethernet_interface_t *ei;
273 hi = vnet_get_hw_interface (vnm, hw_if_index);
275 ASSERT (hi->hw_class_index == ethernet_hw_interface_class.index);
277 ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
279 return ei->flag_change (vnm, hi, flags);
283 /* Echo packets back to ethernet/l2-input. */
285 simulated_ethernet_interface_tx (vlib_main_t * vm,
286 vlib_node_runtime_t * node,
287 vlib_frame_t * frame)
289 u32 n_left_from, n_left_to_next, n_copy, *from, *to_next;
290 u32 next_index = VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT;
291 u32 i, next_node_index, bvi_flag, sw_if_index;
292 u32 n_pkts = 0, n_bytes = 0;
293 u32 cpu_index = vm->cpu_index;
294 vnet_main_t *vnm = vnet_get_main ();
295 vnet_interface_main_t *im = &vnm->interface_main;
296 vlib_node_main_t *nm = &vm->node_main;
297 vlib_node_t *loop_node;
300 // check tx node index, it is ethernet-input on loopback create
301 // but can be changed to l2-input if loopback is configured as
302 // BVI of a BD (Bridge Domain).
303 loop_node = vec_elt (nm->nodes, node->node_index);
304 next_node_index = loop_node->next_nodes[next_index];
305 bvi_flag = (next_node_index == l2input_node.index) ? 1 : 0;
307 n_left_from = frame->n_vectors;
308 from = vlib_frame_args (frame);
310 while (n_left_from > 0)
312 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
314 n_copy = clib_min (n_left_from, n_left_to_next);
316 clib_memcpy (to_next, from, n_copy * sizeof (from[0]));
317 n_left_to_next -= n_copy;
318 n_left_from -= n_copy;
320 b = vlib_get_buffer (vm, from[i]);
321 sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_TX];
324 // Set up RX and TX indices as if received from a real driver
325 // unless loopback is used as a BVI. For BVI case, leave TX index
326 // and update l2_len in packet as required for l2 forwarding path
327 vnet_buffer (b)->sw_if_index[VLIB_RX] = sw_if_index;
329 vnet_update_l2_len (b);
331 vnet_buffer (b)->sw_if_index[VLIB_TX] = (u32) ~ 0;
335 n_bytes += vlib_buffer_length_in_chain (vm, b);
338 b = vlib_get_buffer (vm, from[i]);
343 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
345 /* increment TX interface stat */
346 vlib_increment_combined_counter (im->combined_sw_if_counters +
347 VNET_INTERFACE_COUNTER_TX, cpu_index,
348 sw_if_index, n_pkts, n_bytes);
355 format_simulated_ethernet_name (u8 * s, va_list * args)
357 u32 dev_instance = va_arg (*args, u32);
358 return format (s, "loop%d", dev_instance);
361 static clib_error_t *
362 simulated_ethernet_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
365 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
366 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
367 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
372 VNET_DEVICE_CLASS (ethernet_simulated_device_class) = {
374 .format_device_name = format_simulated_ethernet_name,
375 .tx_function = simulated_ethernet_interface_tx,
376 .admin_up_down_function = simulated_ethernet_admin_up_down,
377 .no_flatten_output_chains = 1,
382 vnet_create_loopback_interface (u32 * sw_if_indexp, u8 * mac_address)
384 vnet_main_t *vnm = vnet_get_main ();
385 vlib_main_t *vm = vlib_get_main ();
390 vnet_hw_interface_t *hw_if;
394 ASSERT (sw_if_indexp);
396 *sw_if_indexp = (u32) ~ 0;
398 memset (address, 0, sizeof (address));
401 * Default MAC address (dead:0000:0000 + instance) is allocated
402 * if zero mac_address is configured. Otherwise, user-configurable MAC
403 * address is programmed on the loopback interface.
405 if (memcmp (address, mac_address, sizeof (address)))
406 clib_memcpy (address, mac_address, sizeof (address));
411 address[5] = instance;
414 error = ethernet_register_interface
416 ethernet_simulated_device_class.index, instance++, address, &hw_if_index,
417 /* flag change */ 0);
421 rv = VNET_API_ERROR_INVALID_REGISTRATION;
422 clib_error_report (error);
426 hw_if = vnet_get_hw_interface (vnm, hw_if_index);
427 slot = vlib_node_add_named_next_with_slot
428 (vm, hw_if->tx_node_index,
429 "ethernet-input", VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
430 ASSERT (slot == VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
433 vnet_sw_interface_t *si = vnet_get_hw_sw_interface (vnm, hw_if_index);
434 *sw_if_indexp = si->sw_if_index;
440 static clib_error_t *
441 create_simulated_ethernet_interfaces (vlib_main_t * vm,
442 unformat_input_t * input,
443 vlib_cli_command_t * cmd)
449 memset (mac_address, 0, sizeof (mac_address));
451 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
453 if (unformat (input, "mac %U", unformat_ethernet_address, mac_address))
459 rv = vnet_create_loopback_interface (&sw_if_index, mac_address);
462 return clib_error_return (0, "vnet_create_loopback_interface failed");
464 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
470 VLIB_CLI_COMMAND (create_simulated_ethernet_interface_command, static) = {
471 .path = "loopback create-interface",
472 .short_help = "Create Loopback ethernet interface [mac <mac-addr>]",
473 .function = create_simulated_ethernet_interfaces,
478 VLIB_CLI_COMMAND (create_loopback_interface_command, static) = {
479 .path = "create loopback interface",
480 .short_help = "create loopback interface [mac <mac-addr>]",
481 .function = create_simulated_ethernet_interfaces,
485 ethernet_interface_t *
486 ethernet_get_interface (ethernet_main_t * em, u32 hw_if_index)
488 vnet_hw_interface_t *i =
489 vnet_get_hw_interface (vnet_get_main (), hw_if_index);
490 return (i->hw_class_index ==
491 ethernet_hw_interface_class.
492 index ? pool_elt_at_index (em->interfaces, i->hw_instance) : 0);
496 vnet_delete_loopback_interface (u32 sw_if_index)
498 vnet_main_t *vnm = vnet_get_main ();
499 vnet_sw_interface_t *si;
501 if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
502 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
504 si = vnet_get_sw_interface (vnm, sw_if_index);
505 ethernet_delete_interface (vnm, si->hw_if_index);
510 static clib_error_t *
511 delete_simulated_ethernet_interfaces (vlib_main_t * vm,
512 unformat_input_t * input,
513 vlib_cli_command_t * cmd)
516 u32 sw_if_index = ~0;
517 vnet_main_t *vnm = vnet_get_main ();
519 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
521 if (unformat (input, "intfc %U",
522 unformat_vnet_sw_interface, vnm, &sw_if_index))
528 if (sw_if_index == ~0)
529 return clib_error_return (0, "interface not specified");
531 rv = vnet_delete_loopback_interface (sw_if_index);
534 return clib_error_return (0, "vnet_delete_loopback_interface failed");
540 VLIB_CLI_COMMAND (delete_simulated_ethernet_interface_command, static) = {
541 .path = "loopback delete-interface",
542 .short_help = "Delete Loopback ethernet interface intfc <interface>",
543 .function = delete_simulated_ethernet_interfaces,
548 VLIB_CLI_COMMAND (delete_loopback_interface_command, static) = {
549 .path = "delete loopback interface",
550 .short_help = "delete loopback interface intfc <interface>",
551 .function = delete_simulated_ethernet_interfaces,
556 * fd.io coding-style-patch-verification: ON
559 * eval: (c-set-style "gnu")