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 * interface.c: VNET interfaces/sub-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/plugin/plugin.h>
42 #include <vnet/fib/ip6_fib.h>
43 #include <vnet/adj/adj.h>
44 #include <vnet/adj/adj_mcast.h>
46 #define VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE (1 << 0)
47 #define VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE (1 << 1)
49 static clib_error_t *vnet_hw_interface_set_flags_helper (vnet_main_t * vnm,
54 static clib_error_t *vnet_sw_interface_set_flags_helper (vnet_main_t * vnm,
59 static clib_error_t *vnet_hw_interface_set_class_helper (vnet_main_t * vnm,
66 /* Either sw or hw interface index. */
71 } vnet_sw_hw_interface_state_t;
74 serialize_vec_vnet_sw_hw_interface_state (serialize_main_t * m, va_list * va)
76 vnet_sw_hw_interface_state_t *s =
77 va_arg (*va, vnet_sw_hw_interface_state_t *);
78 u32 n = va_arg (*va, u32);
80 for (i = 0; i < n; i++)
82 serialize_integer (m, s[i].sw_hw_if_index,
83 sizeof (s[i].sw_hw_if_index));
84 serialize_integer (m, s[i].flags, sizeof (s[i].flags));
89 unserialize_vec_vnet_sw_hw_interface_state (serialize_main_t * m,
92 vnet_sw_hw_interface_state_t *s =
93 va_arg (*va, vnet_sw_hw_interface_state_t *);
94 u32 n = va_arg (*va, u32);
96 for (i = 0; i < n; i++)
98 unserialize_integer (m, &s[i].sw_hw_if_index,
99 sizeof (s[i].sw_hw_if_index));
100 unserialize_integer (m, &s[i].flags, sizeof (s[i].flags));
105 serialize_vnet_sw_hw_interface_set_flags (serialize_main_t * m, va_list * va)
107 vnet_sw_hw_interface_state_t *s =
108 va_arg (*va, vnet_sw_hw_interface_state_t *);
109 serialize (m, serialize_vec_vnet_sw_hw_interface_state, s, 1);
113 unserialize_vnet_sw_interface_set_flags (serialize_main_t * m, va_list * va)
115 CLIB_UNUSED (mc_main_t * mc) = va_arg (*va, mc_main_t *);
116 vnet_sw_hw_interface_state_t s;
118 unserialize (m, unserialize_vec_vnet_sw_hw_interface_state, &s, 1);
120 vnet_sw_interface_set_flags_helper
121 (vnet_get_main (), s.sw_hw_if_index, s.flags,
122 /* helper_flags no redistribution */ 0);
126 unserialize_vnet_hw_interface_set_flags (serialize_main_t * m, va_list * va)
128 CLIB_UNUSED (mc_main_t * mc) = va_arg (*va, mc_main_t *);
129 vnet_sw_hw_interface_state_t s;
131 unserialize (m, unserialize_vec_vnet_sw_hw_interface_state, &s, 1);
133 vnet_hw_interface_set_flags_helper
134 (vnet_get_main (), s.sw_hw_if_index, s.flags,
135 /* helper_flags no redistribution */ 0);
138 MC_SERIALIZE_MSG (vnet_sw_interface_set_flags_msg, static) =
140 .name = "vnet_sw_interface_set_flags",.serialize =
141 serialize_vnet_sw_hw_interface_set_flags,.unserialize =
142 unserialize_vnet_sw_interface_set_flags,};
144 MC_SERIALIZE_MSG (vnet_hw_interface_set_flags_msg, static) =
146 .name = "vnet_hw_interface_set_flags",.serialize =
147 serialize_vnet_sw_hw_interface_set_flags,.unserialize =
148 unserialize_vnet_hw_interface_set_flags,};
151 serialize_vnet_interface_state (serialize_main_t * m, va_list * va)
153 vnet_main_t *vnm = va_arg (*va, vnet_main_t *);
154 vnet_sw_hw_interface_state_t *sts = 0, *st;
155 vnet_sw_interface_t *sif;
156 vnet_hw_interface_t *hif;
157 vnet_interface_main_t *im = &vnm->interface_main;
159 /* Serialize hardware interface classes since they may have changed.
160 Must do this before sending up/down flags. */
162 pool_foreach (hif, im->hw_interfaces, ({
163 vnet_hw_interface_class_t * hw_class = vnet_get_hw_interface_class (vnm, hif->hw_class_index);
164 serialize_cstring (m, hw_class->name);
168 /* Send sw/hw interface state when non-zero. */
170 pool_foreach (sif, im->sw_interfaces, ({
173 vec_add2 (sts, st, 1);
174 st->sw_hw_if_index = sif->sw_if_index;
175 st->flags = sif->flags;
180 vec_serialize (m, sts, serialize_vec_vnet_sw_hw_interface_state);
186 pool_foreach (hif, im->hw_interfaces, ({
189 vec_add2 (sts, st, 1);
190 st->sw_hw_if_index = hif->hw_if_index;
191 st->flags = hif->flags;
196 vec_serialize (m, sts, serialize_vec_vnet_sw_hw_interface_state);
202 unserialize_vnet_interface_state (serialize_main_t * m, va_list * va)
204 vnet_main_t *vnm = va_arg (*va, vnet_main_t *);
205 vnet_sw_hw_interface_state_t *sts = 0, *st;
207 /* First set interface hardware class. */
209 vnet_interface_main_t *im = &vnm->interface_main;
210 vnet_hw_interface_t *hif;
216 pool_foreach (hif, im->hw_interfaces, ({
217 unserialize_cstring (m, &class_name);
218 p = hash_get_mem (im->hw_interface_class_by_name, class_name);
220 error = vnet_hw_interface_set_class_helper (vnm, hif->hw_if_index, p[0], /* redistribute */ 0);
222 clib_error_report (error);
223 vec_free (class_name);
228 vec_unserialize (m, &sts, unserialize_vec_vnet_sw_hw_interface_state);
229 vec_foreach (st, sts)
230 vnet_sw_interface_set_flags_helper (vnm, st->sw_hw_if_index, st->flags,
231 /* no distribute */ 0);
234 vec_unserialize (m, &sts, unserialize_vec_vnet_sw_hw_interface_state);
235 vec_foreach (st, sts)
236 vnet_hw_interface_set_flags_helper (vnm, st->sw_hw_if_index, st->flags,
237 /* no distribute */ 0);
241 static clib_error_t *
242 call_elf_section_interface_callbacks (vnet_main_t * vnm, u32 if_index,
244 _vnet_interface_function_list_elt_t **
247 _vnet_interface_function_list_elt_t *elt;
248 vnet_interface_function_priority_t prio;
249 clib_error_t *error = 0;
251 for (prio = VNET_ITF_FUNC_PRIORITY_LOW;
252 prio <= VNET_ITF_FUNC_PRIORITY_HIGH; prio++)
258 error = elt->fp (vnm, if_index, flags);
261 elt = elt->next_interface_function;
267 static clib_error_t *
268 call_hw_interface_add_del_callbacks (vnet_main_t * vnm, u32 hw_if_index,
271 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
272 vnet_hw_interface_class_t *hw_class =
273 vnet_get_hw_interface_class (vnm, hi->hw_class_index);
274 vnet_device_class_t *dev_class =
275 vnet_get_device_class (vnm, hi->dev_class_index);
276 clib_error_t *error = 0;
278 if (hw_class->interface_add_del_function
280 hw_class->interface_add_del_function (vnm, hw_if_index, is_create)))
283 if (dev_class->interface_add_del_function
285 dev_class->interface_add_del_function (vnm, hw_if_index,
289 error = call_elf_section_interface_callbacks
290 (vnm, hw_if_index, is_create, vnm->hw_interface_add_del_functions);
295 static clib_error_t *
296 call_sw_interface_add_del_callbacks (vnet_main_t * vnm, u32 sw_if_index,
299 return call_elf_section_interface_callbacks
300 (vnm, sw_if_index, is_create, vnm->sw_interface_add_del_functions);
303 #define VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE (1 << 0)
304 #define VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE (1 << 1)
306 static clib_error_t *
307 vnet_hw_interface_set_flags_helper (vnet_main_t * vnm, u32 hw_if_index,
308 u32 flags, u32 helper_flags)
310 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
311 vnet_hw_interface_class_t *hw_class =
312 vnet_get_hw_interface_class (vnm, hi->hw_class_index);
313 vnet_device_class_t *dev_class =
314 vnet_get_device_class (vnm, hi->dev_class_index);
315 vlib_main_t *vm = vnm->vlib_main;
317 clib_error_t *error = 0;
319 (helper_flags & VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE) != 0;
322 (VNET_HW_INTERFACE_FLAG_LINK_UP | VNET_HW_INTERFACE_FLAG_DUPLEX_MASK |
323 VNET_HW_INTERFACE_FLAG_SPEED_MASK);
326 /* Call hardware interface add/del callbacks. */
328 call_hw_interface_add_del_callbacks (vnm, hw_if_index, is_create);
330 /* Already in the desired state? */
331 if (!is_create && (hi->flags & mask) == flags)
334 /* Some interface classes do not redistribute (e.g. are local). */
335 if (!dev_class->redistribute)
336 helper_flags &= ~VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE;
339 && (helper_flags & VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE))
341 vnet_sw_hw_interface_state_t s;
342 s.sw_hw_if_index = hw_if_index;
344 mc_serialize (vm->mc_main, &vnet_hw_interface_set_flags_msg, &s);
347 if ((hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP) !=
348 (flags & VNET_HW_INTERFACE_FLAG_LINK_UP))
350 /* Do hardware class (e.g. ethernet). */
351 if (hw_class->link_up_down_function
352 && (error = hw_class->link_up_down_function (vnm, hw_if_index,
356 error = call_elf_section_interface_callbacks
357 (vnm, hw_if_index, flags, vnm->hw_interface_link_up_down_functions);
370 static clib_error_t *
371 vnet_sw_interface_set_flags_helper (vnet_main_t * vnm, u32 sw_if_index,
372 u32 flags, u32 helper_flags)
374 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
375 vlib_main_t *vm = vnm->vlib_main;
377 clib_error_t *error = 0;
379 (helper_flags & VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE) != 0;
382 mask = VNET_SW_INTERFACE_FLAG_ADMIN_UP | VNET_SW_INTERFACE_FLAG_PUNT;
388 call_sw_interface_add_del_callbacks (vnm, sw_if_index, is_create);
392 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
394 /* Notify everyone when the interface is created as admin up */
395 error = call_elf_section_interface_callbacks (vnm, sw_if_index,
398 sw_interface_admin_up_down_functions);
405 vnet_sw_interface_t *si_sup = si;
407 /* Check that super interface is in correct state. */
408 if (si->type == VNET_SW_INTERFACE_TYPE_SUB)
410 si_sup = vnet_get_sw_interface (vnm, si->sup_sw_if_index);
412 /* Check to see if we're bringing down the soft interface and if it's parent is up */
413 if ((flags != (si_sup->flags & mask)) &&
415 && ((si_sup->flags & mask) ==
416 VNET_SW_INTERFACE_FLAG_ADMIN_UP))))
418 error = clib_error_return (0, "super-interface %U must be %U",
419 format_vnet_sw_interface_name, vnm,
421 format_vnet_sw_interface_flags,
427 /* Donot change state for slave link of bonded interfaces */
428 if (si->flags & VNET_SW_INTERFACE_FLAG_BOND_SLAVE)
430 error = clib_error_return
431 (0, "not allowed as %U belong to a BondEthernet interface",
432 format_vnet_sw_interface_name, vnm, si);
436 /* Already in the desired state? */
437 if ((si->flags & mask) == flags)
440 /* Sub-interfaces of hardware interfaces that do no redistribute,
441 do not redistribute themselves. */
442 if (si_sup->type == VNET_SW_INTERFACE_TYPE_HARDWARE)
444 vnet_hw_interface_t *hi =
445 vnet_get_hw_interface (vnm, si_sup->hw_if_index);
446 vnet_device_class_t *dev_class =
447 vnet_get_device_class (vnm, hi->dev_class_index);
448 if (!dev_class->redistribute)
450 ~VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE;
455 VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE))
457 vnet_sw_hw_interface_state_t s;
458 s.sw_hw_if_index = sw_if_index;
460 mc_serialize (vm->mc_main, &vnet_sw_interface_set_flags_msg, &s);
463 /* set the flags now before invoking the registered clients
464 * so that the state they query is consistent with the state here notified */
465 old_flags = si->flags;
468 if ((flags | old_flags) & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
469 error = call_elf_section_interface_callbacks
470 (vnm, sw_if_index, flags,
471 vnm->sw_interface_admin_up_down_functions);
472 si->flags = old_flags;
477 if (si->type == VNET_SW_INTERFACE_TYPE_HARDWARE)
479 vnet_hw_interface_t *hi =
480 vnet_get_hw_interface (vnm, si->hw_if_index);
481 vnet_hw_interface_class_t *hw_class =
482 vnet_get_hw_interface_class (vnm, hi->hw_class_index);
483 vnet_device_class_t *dev_class =
484 vnet_get_device_class (vnm, hi->dev_class_index);
486 if ((flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) &&
487 (si->flags & VNET_SW_INTERFACE_FLAG_ERROR))
489 error = clib_error_return (0, "Interface in the error state");
493 /* save the si admin up flag */
494 old_flags = si->flags;
496 /* update si admin up flag in advance if we are going admin down */
497 if (!(flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP))
498 si->flags &= ~VNET_SW_INTERFACE_FLAG_ADMIN_UP;
500 if (dev_class->admin_up_down_function
501 && (error = dev_class->admin_up_down_function (vnm,
505 /* restore si admin up flag to it's original state on errors */
506 si->flags = old_flags;
510 if (hw_class->admin_up_down_function
511 && (error = hw_class->admin_up_down_function (vnm,
515 /* restore si admin up flag to it's original state on errors */
516 si->flags = old_flags;
520 /* Admin down implies link down. */
521 if (!(flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
522 && (hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP))
523 vnet_hw_interface_set_flags_helper (vnm, si->hw_if_index,
525 ~VNET_HW_INTERFACE_FLAG_LINK_UP,
538 vnet_hw_interface_set_flags (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
540 return vnet_hw_interface_set_flags_helper
541 (vnm, hw_if_index, flags,
542 VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE);
546 vnet_sw_interface_set_flags (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
548 return vnet_sw_interface_set_flags_helper
549 (vnm, sw_if_index, flags,
550 VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE);
554 vnet_create_sw_interface_no_callbacks (vnet_main_t * vnm,
555 vnet_sw_interface_t * template)
557 vnet_interface_main_t *im = &vnm->interface_main;
558 vnet_sw_interface_t *sw;
561 pool_get (im->sw_interfaces, sw);
562 sw_if_index = sw - im->sw_interfaces;
567 sw->sw_if_index = sw_if_index;
568 if (sw->type == VNET_SW_INTERFACE_TYPE_HARDWARE)
569 sw->sup_sw_if_index = sw->sw_if_index;
571 /* Allocate counters for this interface. */
575 vnet_interface_counter_lock (im);
577 for (i = 0; i < vec_len (im->sw_if_counters); i++)
579 vlib_validate_simple_counter (&im->sw_if_counters[i], sw_if_index);
580 vlib_zero_simple_counter (&im->sw_if_counters[i], sw_if_index);
583 for (i = 0; i < vec_len (im->combined_sw_if_counters); i++)
585 vlib_validate_combined_counter (&im->combined_sw_if_counters[i],
587 vlib_zero_combined_counter (&im->combined_sw_if_counters[i],
591 vnet_interface_counter_unlock (im);
598 vnet_create_sw_interface (vnet_main_t * vnm, vnet_sw_interface_t * template,
602 vnet_hw_interface_t *hi;
603 vnet_device_class_t *dev_class;
605 hi = vnet_get_sup_hw_interface (vnm, template->sup_sw_if_index);
606 dev_class = vnet_get_device_class (vnm, hi->dev_class_index);
608 if (template->type == VNET_SW_INTERFACE_TYPE_SUB &&
609 dev_class->subif_add_del_function)
611 error = dev_class->subif_add_del_function (vnm, hi->hw_if_index,
612 (struct vnet_sw_interface_t
618 *sw_if_index = vnet_create_sw_interface_no_callbacks (vnm, template);
619 error = vnet_sw_interface_set_flags_helper
620 (vnm, *sw_if_index, template->flags,
621 VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE);
625 /* undo the work done by vnet_create_sw_interface_no_callbacks() */
626 vnet_interface_main_t *im = &vnm->interface_main;
627 vnet_sw_interface_t *sw =
628 pool_elt_at_index (im->sw_interfaces, *sw_if_index);
629 pool_put (im->sw_interfaces, sw);
636 vnet_delete_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
638 vnet_interface_main_t *im = &vnm->interface_main;
639 vnet_sw_interface_t *sw =
640 pool_elt_at_index (im->sw_interfaces, sw_if_index);
642 /* Check if the interface has config and is removed from L2 BD or XConnect */
643 vlib_main_t *vm = vlib_get_main ();
644 l2_input_config_t *config;
645 if (sw_if_index < vec_len (l2input_main.configs))
647 config = vec_elt_at_index (l2input_main.configs, sw_if_index);
648 if (config->xconnect)
649 set_int_l2_mode (vm, vnm, MODE_L3, config->output_sw_if_index, 0, 0,
651 if (config->xconnect || config->bridge)
652 set_int_l2_mode (vm, vnm, MODE_L3, sw_if_index, 0, 0, 0, 0);
655 /* Bring down interface in case it is up. */
657 vnet_sw_interface_set_flags (vnm, sw_if_index, /* flags */ 0);
659 call_sw_interface_add_del_callbacks (vnm, sw_if_index, /* is_create */ 0);
661 pool_put (im->sw_interfaces, sw);
665 setup_tx_node (vlib_main_t * vm,
666 u32 node_index, vnet_device_class_t * dev_class)
668 vlib_node_t *n = vlib_get_node (vm, node_index);
670 n->function = dev_class->tx_function;
671 n->format_trace = dev_class->format_tx_trace;
673 vlib_register_errors (vm, node_index,
674 dev_class->tx_function_n_errors,
675 dev_class->tx_function_error_strings);
679 setup_output_node (vlib_main_t * vm,
680 u32 node_index, vnet_hw_interface_class_t * hw_class)
682 vlib_node_t *n = vlib_get_node (vm, node_index);
683 n->format_buffer = hw_class->format_header;
684 n->unformat_buffer = hw_class->unformat_header;
687 /* Register an interface instance. */
689 vnet_register_interface (vnet_main_t * vnm,
692 u32 hw_class_index, u32 hw_instance)
694 vnet_interface_main_t *im = &vnm->interface_main;
695 vnet_hw_interface_t *hw;
696 vnet_device_class_t *dev_class =
697 vnet_get_device_class (vnm, dev_class_index);
698 vnet_hw_interface_class_t *hw_class =
699 vnet_get_hw_interface_class (vnm, hw_class_index);
700 vlib_main_t *vm = vnm->vlib_main;
701 vnet_feature_config_main_t *fcm;
702 vnet_config_main_t *cm;
704 char *tx_node_name, *output_node_name;
706 pool_get (im->hw_interfaces, hw);
707 memset (hw, 0, sizeof (*hw));
709 hw_index = hw - im->hw_interfaces;
710 hw->hw_if_index = hw_index;
711 hw->default_rx_mode = VNET_HW_INTERFACE_RX_MODE_POLLING;
713 if (dev_class->format_device_name)
714 hw->name = format (0, "%U", dev_class->format_device_name, dev_instance);
715 else if (hw_class->format_interface_name)
716 hw->name = format (0, "%U", hw_class->format_interface_name,
719 hw->name = format (0, "%s%x", hw_class->name, dev_instance);
721 if (!im->hw_interface_by_name)
722 im->hw_interface_by_name = hash_create_vec ( /* size */ 0,
723 sizeof (hw->name[0]),
726 hash_set_mem (im->hw_interface_by_name, hw->name, hw_index);
728 /* Make hardware interface point to software interface. */
730 vnet_sw_interface_t sw = {
731 .type = VNET_SW_INTERFACE_TYPE_HARDWARE,
732 .flood_class = VNET_FLOOD_CLASS_NORMAL,
733 .hw_if_index = hw_index
735 hw->sw_if_index = vnet_create_sw_interface_no_callbacks (vnm, &sw);
738 hw->dev_class_index = dev_class_index;
739 hw->dev_instance = dev_instance;
740 hw->hw_class_index = hw_class_index;
741 hw->hw_instance = hw_instance;
743 hw->max_rate_bits_per_sec = 0;
744 hw->min_packet_bytes = 0;
745 hw->per_packet_overhead_bytes = 0;
746 hw->max_l3_packet_bytes[VLIB_RX] = ~0;
747 hw->max_l3_packet_bytes[VLIB_TX] = ~0;
749 if (dev_class->tx_function == 0)
750 goto no_output_nodes; /* No output/tx nodes to create */
752 tx_node_name = (char *) format (0, "%v-tx", hw->name);
753 output_node_name = (char *) format (0, "%v-output", hw->name);
755 /* If we have previously deleted interface nodes, re-use them. */
756 if (vec_len (im->deleted_hw_interface_nodes) > 0)
758 vnet_hw_interface_nodes_t *hn;
760 vlib_node_runtime_t *nrt;
762 hn = vec_end (im->deleted_hw_interface_nodes) - 1;
764 hw->tx_node_index = hn->tx_node_index;
765 hw->output_node_index = hn->output_node_index;
767 vlib_node_rename (vm, hw->tx_node_index, "%v", tx_node_name);
768 vlib_node_rename (vm, hw->output_node_index, "%v", output_node_name);
772 vnet_interface_output_runtime_t *rt;
774 rt = vlib_node_get_runtime_data (this_vlib_main, hw->output_node_index);
775 ASSERT (rt->is_deleted == 1);
777 rt->hw_if_index = hw_index;
778 rt->sw_if_index = hw->sw_if_index;
779 rt->dev_instance = hw->dev_instance;
781 rt = vlib_node_get_runtime_data (this_vlib_main, hw->tx_node_index);
782 rt->hw_if_index = hw_index;
783 rt->sw_if_index = hw->sw_if_index;
784 rt->dev_instance = hw->dev_instance;
788 /* The new class may differ from the old one.
789 * Functions have to be updated. */
790 node = vlib_get_node (vm, hw->output_node_index);
791 node->function = vnet_interface_output_node_multiarch_select ();
792 node->format_trace = format_vnet_interface_output_trace;
795 nrt = vlib_node_get_runtime (this_vlib_main, hw->output_node_index);
796 nrt->function = node->function;
800 node = vlib_get_node (vm, hw->tx_node_index);
801 node->function = dev_class->tx_function;
802 node->format_trace = dev_class->format_tx_trace;
805 nrt = vlib_node_get_runtime (this_vlib_main, hw->tx_node_index);
806 nrt->function = node->function;
810 _vec_len (im->deleted_hw_interface_nodes) -= 1;
814 vlib_node_registration_t r;
815 vnet_interface_output_runtime_t rt = {
816 .hw_if_index = hw_index,
817 .sw_if_index = hw->sw_if_index,
818 .dev_instance = hw->dev_instance,
822 memset (&r, 0, sizeof (r));
823 r.type = VLIB_NODE_TYPE_INTERNAL;
824 r.runtime_data = &rt;
825 r.runtime_data_bytes = sizeof (rt);
827 r.vector_size = sizeof (u32);
829 r.flags = VLIB_NODE_FLAG_IS_OUTPUT;
830 r.name = tx_node_name;
831 r.function = dev_class->tx_function;
833 hw->tx_node_index = vlib_register_node (vm, &r);
835 vlib_node_add_named_next_with_slot (vm, hw->tx_node_index,
837 VNET_INTERFACE_TX_NEXT_DROP);
840 r.name = output_node_name;
841 r.function = vnet_interface_output_node_multiarch_select ();
842 r.format_trace = format_vnet_interface_output_trace;
847 "interface is deleted",
850 r.n_errors = ARRAY_LEN (e);
853 hw->output_node_index = vlib_register_node (vm, &r);
855 vlib_node_add_named_next_with_slot (vm, hw->output_node_index,
857 VNET_INTERFACE_OUTPUT_NEXT_DROP);
858 vlib_node_add_next_with_slot (vm, hw->output_node_index,
860 VNET_INTERFACE_OUTPUT_NEXT_TX);
862 /* add interface to the list of "output-interface" feature arc start nodes
863 and clone nexts from 1st interface if it exists */
864 fcm = vnet_feature_get_config_main (im->output_feature_arc_index);
865 cm = &fcm->config_main;
866 i = vec_len (cm->start_node_indices);
867 vec_validate (cm->start_node_indices, i);
868 cm->start_node_indices[i] = hw->output_node_index;
871 /* copy nexts from 1st interface */
872 vnet_hw_interface_t *first_hw;
873 vlib_node_t *first_node;
875 first_hw = vnet_get_hw_interface (vnm, /* hw_if_index */ 0);
876 first_node = vlib_get_node (vm, first_hw->output_node_index);
878 /* 1st 2 nexts are already added above */
879 for (i = 2; i < vec_len (first_node->next_nodes); i++)
880 vlib_node_add_next_with_slot (vm, hw->output_node_index,
881 first_node->next_nodes[i], i);
885 setup_output_node (vm, hw->output_node_index, hw_class);
886 setup_tx_node (vm, hw->tx_node_index, dev_class);
889 /* Call all up/down callbacks with zero flags when interface is created. */
890 vnet_sw_interface_set_flags_helper (vnm, hw->sw_if_index, /* flags */ 0,
891 VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE);
892 vnet_hw_interface_set_flags_helper (vnm, hw_index, /* flags */ 0,
893 VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE);
899 vnet_delete_hw_interface (vnet_main_t * vnm, u32 hw_if_index)
901 vnet_interface_main_t *im = &vnm->interface_main;
902 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
903 vlib_main_t *vm = vnm->vlib_main;
904 vnet_device_class_t *dev_class = vnet_get_device_class (vnm,
905 hw->dev_class_index);
906 /* If it is up, mark it down. */
908 vnet_hw_interface_set_flags (vnm, hw_if_index, /* flags */ 0);
910 /* Call delete callbacks. */
911 call_hw_interface_add_del_callbacks (vnm, hw_if_index, /* is_create */ 0);
913 /* Delete any sub-interfaces. */
917 hash_foreach (id, sw_if_index, hw->sub_interface_sw_if_index_by_id,
919 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
920 u64 sup_and_sub_key =
921 ((u64) (si->sup_sw_if_index) << 32) | (u64) si->sub.id;
922 hash_unset_mem_free (&im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
923 vnet_delete_sw_interface (vnm, sw_if_index);
925 hash_free (hw->sub_interface_sw_if_index_by_id);
929 /* Delete software interface corresponding to hardware interface. */
930 vnet_delete_sw_interface (vnm, hw->sw_if_index);
932 if (dev_class->tx_function)
934 /* Put output/tx nodes into recycle pool */
935 vnet_hw_interface_nodes_t *dn;
940 vnet_interface_output_runtime_t *rt =
941 vlib_node_get_runtime_data (this_vlib_main, hw->output_node_index);
943 /* Mark node runtime as deleted so output node (if called)
944 * will drop packets. */
949 vlib_node_rename (vm, hw->output_node_index,
950 "interface-%d-output-deleted", hw_if_index);
951 vlib_node_rename (vm, hw->tx_node_index, "interface-%d-tx-deleted",
953 vec_add2 (im->deleted_hw_interface_nodes, dn, 1);
954 dn->tx_node_index = hw->tx_node_index;
955 dn->output_node_index = hw->output_node_index;
958 hash_unset_mem (im->hw_interface_by_name, hw->name);
960 vec_free (hw->input_node_thread_index_by_queue);
961 vec_free (hw->dq_runtime_index_by_queue);
963 pool_put (im->hw_interfaces, hw);
967 vnet_hw_interface_walk_sw (vnet_main_t * vnm,
969 vnet_hw_sw_interface_walk_t fn, void *ctx)
971 vnet_hw_interface_t *hi;
974 hi = vnet_get_hw_interface (vnm, hw_if_index);
975 /* the super first, then the and sub interfaces */
976 fn (vnm, hi->sw_if_index, ctx);
979 hash_foreach (id, sw_if_index,
980 hi->sub_interface_sw_if_index_by_id,
982 fn (vnm, sw_if_index, ctx);
988 serialize_vnet_hw_interface_set_class (serialize_main_t * m, va_list * va)
990 u32 hw_if_index = va_arg (*va, u32);
991 char *hw_class_name = va_arg (*va, char *);
992 serialize_integer (m, hw_if_index, sizeof (hw_if_index));
993 serialize_cstring (m, hw_class_name);
997 unserialize_vnet_hw_interface_set_class (serialize_main_t * m, va_list * va)
999 CLIB_UNUSED (mc_main_t * mc) = va_arg (*va, mc_main_t *);
1000 vnet_main_t *vnm = vnet_get_main ();
1002 char *hw_class_name;
1004 clib_error_t *error;
1006 unserialize_integer (m, &hw_if_index, sizeof (hw_if_index));
1007 unserialize_cstring (m, &hw_class_name);
1009 hash_get (vnm->interface_main.hw_interface_class_by_name, hw_class_name);
1011 error = vnet_hw_interface_set_class_helper (vnm, hw_if_index, p[0],
1012 /* redistribute */ 0);
1014 clib_error_report (error);
1017 MC_SERIALIZE_MSG (vnet_hw_interface_set_class_msg, static) =
1019 .name = "vnet_hw_interface_set_class",.serialize =
1020 serialize_vnet_hw_interface_set_class,.unserialize =
1021 unserialize_vnet_hw_interface_set_class,};
1024 vnet_hw_interface_init_for_class (vnet_main_t * vnm, u32 hw_if_index,
1025 u32 hw_class_index, u32 hw_instance)
1027 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1028 vnet_hw_interface_class_t *hc =
1029 vnet_get_hw_interface_class (vnm, hw_class_index);
1031 hi->hw_class_index = hw_class_index;
1032 hi->hw_instance = hw_instance;
1033 setup_output_node (vnm->vlib_main, hi->output_node_index, hc);
1036 static clib_error_t *
1037 vnet_hw_interface_set_class_helper (vnet_main_t * vnm, u32 hw_if_index,
1038 u32 hw_class_index, u32 redistribute)
1040 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1041 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, hi->sw_if_index);
1042 vnet_hw_interface_class_t *old_class =
1043 vnet_get_hw_interface_class (vnm, hi->hw_class_index);
1044 vnet_hw_interface_class_t *new_class =
1045 vnet_get_hw_interface_class (vnm, hw_class_index);
1046 vnet_device_class_t *dev_class =
1047 vnet_get_device_class (vnm, hi->dev_class_index);
1048 clib_error_t *error = 0;
1050 /* New class equals old class? Nothing to do. */
1051 if (hi->hw_class_index == hw_class_index)
1054 /* No need (and incorrect since admin up flag may be set) to do error checking when
1055 receiving unserialize message. */
1058 if (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
1059 return clib_error_return (0,
1060 "%v must be admin down to change class from %s to %s",
1061 hi->name, old_class->name, new_class->name);
1063 /* Make sure interface supports given class. */
1064 if ((new_class->is_valid_class_for_interface
1065 && !new_class->is_valid_class_for_interface (vnm, hw_if_index,
1067 || (dev_class->is_valid_class_for_interface
1068 && !dev_class->is_valid_class_for_interface (vnm, hw_if_index,
1070 return clib_error_return (0,
1071 "%v class cannot be changed from %s to %s",
1072 hi->name, old_class->name, new_class->name);
1074 if (vnm->vlib_main->mc_main)
1076 mc_serialize (vnm->vlib_main->mc_main,
1077 &vnet_hw_interface_set_class_msg, hw_if_index,
1083 if (old_class->hw_class_change)
1084 old_class->hw_class_change (vnm, hw_if_index, old_class->index,
1087 vnet_hw_interface_init_for_class (vnm, hw_if_index, new_class->index,
1090 if (new_class->hw_class_change)
1091 new_class->hw_class_change (vnm, hw_if_index, old_class->index,
1094 if (dev_class->hw_class_change)
1095 dev_class->hw_class_change (vnm, hw_if_index, new_class->index);
1101 vnet_hw_interface_set_class (vnet_main_t * vnm, u32 hw_if_index,
1104 return vnet_hw_interface_set_class_helper (vnm, hw_if_index, hw_class_index,
1105 /* redistribute */ 1);
1109 vnet_hw_interface_rx_redirect_to_node_helper (vnet_main_t * vnm,
1114 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1115 vnet_device_class_t *dev_class = vnet_get_device_class
1116 (vnm, hi->dev_class_index);
1120 /* $$$$ fixme someday maybe */
1121 ASSERT (vnm->vlib_main->mc_main == 0);
1123 if (dev_class->rx_redirect_to_node)
1125 dev_class->rx_redirect_to_node (vnm, hw_if_index, node_index);
1129 return VNET_API_ERROR_UNIMPLEMENTED;
1133 vnet_hw_interface_rx_redirect_to_node (vnet_main_t * vnm, u32 hw_if_index,
1136 return vnet_hw_interface_rx_redirect_to_node_helper (vnm, hw_if_index,
1138 1 /* redistribute */ );
1142 vnet_sw_interface_compare (vnet_main_t * vnm,
1143 uword sw_if_index0, uword sw_if_index1)
1145 vnet_sw_interface_t *sup0 = vnet_get_sup_sw_interface (vnm, sw_if_index0);
1146 vnet_sw_interface_t *sup1 = vnet_get_sup_sw_interface (vnm, sw_if_index1);
1147 vnet_hw_interface_t *h0 = vnet_get_hw_interface (vnm, sup0->hw_if_index);
1148 vnet_hw_interface_t *h1 = vnet_get_hw_interface (vnm, sup1->hw_if_index);
1151 return vec_cmp (h0->name, h1->name);
1152 return (word) h0->hw_instance - (word) h1->hw_instance;
1156 vnet_hw_interface_compare (vnet_main_t * vnm,
1157 uword hw_if_index0, uword hw_if_index1)
1159 vnet_hw_interface_t *h0 = vnet_get_hw_interface (vnm, hw_if_index0);
1160 vnet_hw_interface_t *h1 = vnet_get_hw_interface (vnm, hw_if_index1);
1163 return vec_cmp (h0->name, h1->name);
1164 return (word) h0->hw_instance - (word) h1->hw_instance;
1168 vnet_sw_interface_is_p2p (vnet_main_t * vnm, u32 sw_if_index)
1170 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
1171 if (si->type == VNET_SW_INTERFACE_TYPE_P2P)
1174 vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
1175 vnet_hw_interface_class_t *hc =
1176 vnet_get_hw_interface_class (vnm, hw->hw_class_index);
1178 return (hc->flags & VNET_HW_INTERFACE_CLASS_FLAG_P2P);
1182 vnet_interface_init (vlib_main_t * vm)
1184 vnet_main_t *vnm = vnet_get_main ();
1185 vnet_interface_main_t *im = &vnm->interface_main;
1186 vlib_buffer_t *b = 0;
1187 vnet_buffer_opaque_t *o = 0;
1188 clib_error_t *error;
1191 * Keep people from shooting themselves in the foot.
1193 if (sizeof (b->opaque) != sizeof (vnet_buffer_opaque_t))
1195 #define _(a) if (sizeof(o->a) > sizeof (o->unused)) \
1197 ("FATAL: size of opaque union subtype %s is %d (max %d)", \
1198 #a, sizeof(o->a), sizeof (o->unused));
1199 foreach_buffer_opaque_union_subtype;
1202 return clib_error_return
1203 (0, "FATAL: size of vlib buffer opaque %d, size of vnet opaque %d",
1204 sizeof (b->opaque), sizeof (vnet_buffer_opaque_t));
1207 im->sw_if_counter_lock = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES,
1208 CLIB_CACHE_LINE_BYTES);
1209 im->sw_if_counter_lock[0] = 1; /* should be no need */
1211 vec_validate (im->sw_if_counters, VNET_N_SIMPLE_INTERFACE_COUNTER - 1);
1212 im->sw_if_counters[VNET_INTERFACE_COUNTER_DROP].name = "drops";
1213 im->sw_if_counters[VNET_INTERFACE_COUNTER_PUNT].name = "punts";
1214 im->sw_if_counters[VNET_INTERFACE_COUNTER_IP4].name = "ip4";
1215 im->sw_if_counters[VNET_INTERFACE_COUNTER_IP6].name = "ip6";
1216 im->sw_if_counters[VNET_INTERFACE_COUNTER_RX_NO_BUF].name = "rx-no-buf";
1217 im->sw_if_counters[VNET_INTERFACE_COUNTER_RX_MISS].name = "rx-miss";
1218 im->sw_if_counters[VNET_INTERFACE_COUNTER_RX_ERROR].name = "rx-error";
1219 im->sw_if_counters[VNET_INTERFACE_COUNTER_TX_ERROR].name = "tx-error";
1221 vec_validate (im->combined_sw_if_counters,
1222 VNET_N_COMBINED_INTERFACE_COUNTER - 1);
1223 im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_RX].name = "rx";
1224 im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX].name = "tx";
1226 im->sw_if_counter_lock[0] = 0;
1228 im->device_class_by_name = hash_create_string ( /* size */ 0,
1231 vnet_device_class_t *c;
1233 c = vnm->device_class_registrations;
1237 c->index = vec_len (im->device_classes);
1238 hash_set_mem (im->device_class_by_name, c->name, c->index);
1239 vec_add1 (im->device_classes, c[0]);
1240 c = c->next_class_registration;
1244 im->hw_interface_class_by_name = hash_create_string ( /* size */ 0,
1247 im->sw_if_index_by_sup_and_sub = hash_create_mem (0, sizeof (u64),
1250 vnet_hw_interface_class_t *c;
1252 c = vnm->hw_interface_class_registrations;
1256 c->index = vec_len (im->hw_interface_classes);
1257 hash_set_mem (im->hw_interface_class_by_name, c->name, c->index);
1259 if (NULL == c->build_rewrite)
1260 c->build_rewrite = default_build_rewrite;
1261 if (NULL == c->update_adjacency)
1262 c->update_adjacency = default_update_adjacency;
1264 vec_add1 (im->hw_interface_classes, c[0]);
1265 c = c->next_class_registration;
1269 if ((error = vlib_call_init_function (vm, vnet_interface_cli_init)))
1272 vnm->interface_tag_by_sw_if_index = hash_create (0, sizeof (uword));
1274 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
1275 if ((error = vlib_call_init_function (vm, trajectory_trace_init)))
1282 VLIB_INIT_FUNCTION (vnet_interface_init);
1284 /* Kludge to renumber interface names [only!] */
1286 vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance)
1289 vnet_main_t *vnm = vnet_get_main ();
1290 vnet_interface_main_t *im = &vnm->interface_main;
1291 vnet_hw_interface_t *hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
1293 vnet_device_class_t *dev_class = vnet_get_device_class
1294 (vnm, hi->dev_class_index);
1296 if (dev_class->name_renumber == 0 || dev_class->format_device_name == 0)
1297 return VNET_API_ERROR_UNIMPLEMENTED;
1299 rv = dev_class->name_renumber (hi, new_show_dev_instance);
1304 hash_unset_mem (im->hw_interface_by_name, hi->name);
1305 vec_free (hi->name);
1306 /* Use the mapping we set up to call it Ishmael */
1307 hi->name = format (0, "%U", dev_class->format_device_name,
1310 hash_set_mem (im->hw_interface_by_name, hi->name, hi->hw_if_index);
1315 vnet_rename_interface (vnet_main_t * vnm, u32 hw_if_index, char *new_name)
1317 vnet_interface_main_t *im = &vnm->interface_main;
1318 vlib_main_t *vm = vnm->vlib_main;
1319 vnet_hw_interface_t *hw;
1321 clib_error_t *error = 0;
1323 hw = vnet_get_hw_interface (vnm, hw_if_index);
1326 return clib_error_return (0,
1327 "unable to find hw interface for index %u",
1331 old_name = hw->name;
1333 /* set new hw->name */
1334 hw->name = format (0, "%s", new_name);
1336 /* remove the old name to hw_if_index mapping and install the new one */
1337 hash_unset_mem (im->hw_interface_by_name, old_name);
1338 hash_set_mem (im->hw_interface_by_name, hw->name, hw_if_index);
1340 /* rename tx/output nodes */
1341 vlib_node_rename (vm, hw->tx_node_index, "%v-tx", hw->name);
1342 vlib_node_rename (vm, hw->output_node_index, "%v-output", hw->name);
1344 /* free the old name vector */
1345 vec_free (old_name);
1350 static clib_error_t *
1351 vnet_hw_interface_change_mac_address_helper (vnet_main_t * vnm,
1355 clib_error_t *error = 0;
1356 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1360 vnet_device_class_t *dev_class =
1361 vnet_get_device_class (vnm, hi->dev_class_index);
1362 if (dev_class->mac_addr_change_function)
1365 dev_class->mac_addr_change_function (hi, (char *) mac_address);
1369 vnet_hw_interface_class_t *hw_class;
1371 hw_class = vnet_get_hw_interface_class (vnm, hi->hw_class_index);
1373 if (NULL != hw_class->mac_addr_change_function)
1374 hw_class->mac_addr_change_function (hi, (char *) mac_address);
1379 clib_error_return (0,
1380 "MAC Address Change is not supported on this interface");
1386 clib_error_return (0,
1387 "mac address change is not supported for interface index %u",
1394 vnet_hw_interface_change_mac_address (vnet_main_t * vnm, u32 hw_if_index,
1397 return vnet_hw_interface_change_mac_address_helper
1398 (vnm, hw_if_index, mac_address);
1401 vnet_l3_packet_type_t
1402 vnet_link_to_l3_proto (vnet_link_t link)
1407 return (VNET_L3_PACKET_TYPE_IP4);
1409 return (VNET_L3_PACKET_TYPE_IP6);
1410 case VNET_LINK_MPLS:
1411 return (VNET_L3_PACKET_TYPE_MPLS);
1413 return (VNET_L3_PACKET_TYPE_ARP);
1414 case VNET_LINK_ETHERNET:
1424 default_build_rewrite (vnet_main_t * vnm,
1426 vnet_link_t link_type, const void *dst_address)
1432 default_update_adjacency (vnet_main_t * vnm, u32 sw_if_index, u32 ai)
1434 ip_adjacency_t *adj;
1438 switch (adj->lookup_next_index)
1440 case IP_LOOKUP_NEXT_ARP:
1441 case IP_LOOKUP_NEXT_GLEAN:
1443 * default rewirte in neighbour adj
1445 adj_nbr_update_rewrite
1447 ADJ_NBR_REWRITE_FLAG_COMPLETE,
1448 vnet_build_rewrite_for_sw_interface (vnm,
1450 adj_get_link_type (ai), NULL));
1452 case IP_LOOKUP_NEXT_MCAST:
1454 * mcast traffic also uses default rewrite string with no mcast
1455 * switch time updates.
1457 adj_mcast_update_rewrite
1459 vnet_build_rewrite_for_sw_interface (vnm,
1461 adj_get_link_type (ai),
1464 case IP_LOOKUP_NEXT_DROP:
1465 case IP_LOOKUP_NEXT_PUNT:
1466 case IP_LOOKUP_NEXT_LOCAL:
1467 case IP_LOOKUP_NEXT_REWRITE:
1468 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
1469 case IP_LOOKUP_NEXT_MIDCHAIN:
1470 case IP_LOOKUP_NEXT_ICMP_ERROR:
1471 case IP_LOOKUP_N_NEXT:
1478 * fd.io coding-style-patch-verification: ON
1481 * eval: (c-set-style "gnu")