2 *------------------------------------------------------------------
3 * interface_api.c - vnet interface api
5 * Copyright (c) 2016 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *------------------------------------------------------------------
20 #include <vnet/vnet.h>
21 #include <vlibmemory/api.h>
23 #include <vnet/interface.h>
24 #include <vnet/api_errno.h>
25 #include <vnet/ethernet/ethernet.h>
26 #include <vnet/ip/ip.h>
27 #include <vnet/fib/fib_table.h>
28 #include <vnet/mfib/mfib_table.h>
29 #include <vnet/l2/l2_vtr.h>
30 #include <vnet/vnet_msg_enum.h>
31 #include <vnet/fib/fib_api.h>
32 #include <vnet/mfib/mfib_table.h>
34 #define vl_typedefs /* define message structures */
35 #include <vnet/vnet_all_api_h.h>
38 #define vl_endianfun /* define message structures */
39 #include <vnet/vnet_all_api_h.h>
42 /* instantiate all the print functions we know about */
43 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
45 #include <vnet/vnet_all_api_h.h>
48 #include <vlibapi/api_helper_macros.h>
49 vpe_api_main_t vpe_api_main;
51 #define foreach_vpe_api_msg \
52 _(SW_INTERFACE_SET_FLAGS, sw_interface_set_flags) \
53 _(HW_INTERFACE_SET_MTU, hw_interface_set_mtu) \
54 _(SW_INTERFACE_SET_MTU, sw_interface_set_mtu) \
55 _(WANT_INTERFACE_EVENTS, want_interface_events) \
56 _(SW_INTERFACE_DUMP, sw_interface_dump) \
57 _(SW_INTERFACE_ADD_DEL_ADDRESS, sw_interface_add_del_address) \
58 _(SW_INTERFACE_SET_RX_MODE, sw_interface_set_rx_mode) \
59 _(SW_INTERFACE_RX_PLACEMENT_DUMP, sw_interface_rx_placement_dump) \
60 _(SW_INTERFACE_SET_RX_PLACEMENT, sw_interface_set_rx_placement) \
61 _(SW_INTERFACE_SET_TABLE, sw_interface_set_table) \
62 _(SW_INTERFACE_GET_TABLE, sw_interface_get_table) \
63 _(SW_INTERFACE_SET_UNNUMBERED, sw_interface_set_unnumbered) \
64 _(SW_INTERFACE_CLEAR_STATS, sw_interface_clear_stats) \
65 _(SW_INTERFACE_TAG_ADD_DEL, sw_interface_tag_add_del) \
66 _(SW_INTERFACE_SET_MAC_ADDRESS, sw_interface_set_mac_address) \
67 _(SW_INTERFACE_GET_MAC_ADDRESS, sw_interface_get_mac_address) \
68 _(CREATE_VLAN_SUBIF, create_vlan_subif) \
69 _(CREATE_SUBIF, create_subif) \
70 _(DELETE_SUBIF, delete_subif) \
71 _(CREATE_LOOPBACK, create_loopback) \
72 _(CREATE_LOOPBACK_INSTANCE, create_loopback_instance) \
73 _(DELETE_LOOPBACK, delete_loopback) \
74 _(INTERFACE_NAME_RENUMBER, interface_name_renumber) \
75 _(COLLECT_DETAILED_INTERFACE_STATS, collect_detailed_interface_stats) \
76 _(SW_INTERFACE_SET_IP_DIRECTED_BROADCAST, \
77 sw_interface_set_ip_directed_broadcast)
80 vl_api_sw_interface_set_flags_t_handler (vl_api_sw_interface_set_flags_t * mp)
82 vl_api_sw_interface_set_flags_reply_t *rmp;
83 vnet_main_t *vnm = vnet_get_main ();
88 VALIDATE_SW_IF_INDEX (mp);
90 flags = mp->admin_up_down ? VNET_SW_INTERFACE_FLAG_ADMIN_UP : 0;
92 error = vnet_sw_interface_set_flags (vnm, ntohl (mp->sw_if_index), flags);
96 clib_error_report (error);
99 BAD_SW_IF_INDEX_LABEL;
100 REPLY_MACRO (VL_API_SW_INTERFACE_SET_FLAGS_REPLY);
104 vl_api_hw_interface_set_mtu_t_handler (vl_api_hw_interface_set_mtu_t * mp)
106 vl_api_hw_interface_set_mtu_reply_t *rmp;
107 vnet_main_t *vnm = vnet_get_main ();
108 u32 sw_if_index = ntohl (mp->sw_if_index);
109 u16 mtu = ntohs (mp->mtu);
110 ethernet_main_t *em = ðernet_main;
113 VALIDATE_SW_IF_INDEX (mp);
115 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
116 if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
118 rv = VNET_API_ERROR_INVALID_VALUE;
119 goto bad_sw_if_index;
122 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, si->hw_if_index);
123 ethernet_interface_t *eif = ethernet_get_interface (em, si->hw_if_index);
127 rv = VNET_API_ERROR_FEATURE_DISABLED;
128 goto bad_sw_if_index;
131 if (mtu < hi->min_supported_packet_bytes)
133 rv = VNET_API_ERROR_INVALID_VALUE;
134 goto bad_sw_if_index;
137 if (mtu > hi->max_supported_packet_bytes)
139 rv = VNET_API_ERROR_INVALID_VALUE;
140 goto bad_sw_if_index;
143 vnet_hw_interface_set_mtu (vnm, si->hw_if_index, mtu);
145 BAD_SW_IF_INDEX_LABEL;
146 REPLY_MACRO (VL_API_HW_INTERFACE_SET_MTU_REPLY);
150 vl_api_sw_interface_set_mtu_t_handler (vl_api_sw_interface_set_mtu_t * mp)
152 vl_api_sw_interface_set_mtu_reply_t *rmp;
153 vnet_main_t *vnm = vnet_get_main ();
154 u32 sw_if_index = ntohl (mp->sw_if_index);
157 u32 per_protocol_mtu[VNET_N_MTU];
159 VALIDATE_SW_IF_INDEX (mp);
161 for (i = 0; i < VNET_N_MTU; i++)
162 per_protocol_mtu[i] = ntohl (mp->mtu[i]);
164 vnet_sw_interface_set_protocol_mtu (vnm, sw_if_index, per_protocol_mtu);
166 BAD_SW_IF_INDEX_LABEL;
167 REPLY_MACRO (VL_API_SW_INTERFACE_SET_MTU_REPLY);
171 vl_api_sw_interface_set_ip_directed_broadcast_t_handler
172 (vl_api_sw_interface_set_ip_directed_broadcast_t * mp)
174 vl_api_sw_interface_set_ip_directed_broadcast_reply_t *rmp;
175 u32 sw_if_index = ntohl (mp->sw_if_index);
178 VALIDATE_SW_IF_INDEX (mp);
180 vnet_sw_interface_ip_directed_broadcast (vnet_get_main (),
181 sw_if_index, mp->enable);
183 BAD_SW_IF_INDEX_LABEL;
184 REPLY_MACRO (VL_API_SW_INTERFACE_SET_IP_DIRECTED_BROADCAST_REPLY);
188 send_sw_interface_details (vpe_api_main_t * am,
189 vl_api_registration_t * rp,
190 vnet_sw_interface_t * swif,
191 u8 * interface_name, u32 context)
193 vnet_hw_interface_t *hi =
194 vnet_get_sup_hw_interface (am->vnet_main, swif->sw_if_index);
196 vl_api_sw_interface_details_t *mp = vl_msg_api_alloc (sizeof (*mp));
197 clib_memset (mp, 0, sizeof (*mp));
198 mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_DETAILS);
199 mp->sw_if_index = ntohl (swif->sw_if_index);
200 mp->sup_sw_if_index = ntohl (swif->sup_sw_if_index);
201 mp->admin_up_down = (swif->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? 1 : 0;
202 mp->link_up_down = (hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP) ? 1 : 0;
203 mp->link_duplex = ((hi->flags & VNET_HW_INTERFACE_FLAG_DUPLEX_MASK) >>
204 VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT);
205 mp->link_speed = ntohl (hi->link_speed);
206 mp->link_mtu = ntohs (hi->max_packet_bytes);
207 mp->mtu[VNET_MTU_L3] = ntohl (swif->mtu[VNET_MTU_L3]);
208 mp->mtu[VNET_MTU_IP4] = ntohl (swif->mtu[VNET_MTU_IP4]);
209 mp->mtu[VNET_MTU_IP6] = ntohl (swif->mtu[VNET_MTU_IP6]);
210 mp->mtu[VNET_MTU_MPLS] = ntohl (swif->mtu[VNET_MTU_MPLS]);
212 mp->context = context;
214 strncpy ((char *) mp->interface_name,
215 (char *) interface_name, ARRAY_LEN (mp->interface_name) - 1);
217 /* Send the L2 address for ethernet physical intfcs */
218 if (swif->sup_sw_if_index == swif->sw_if_index
219 && hi->hw_class_index == ethernet_hw_interface_class.index)
221 ethernet_main_t *em = ethernet_get_main (am->vlib_main);
222 ethernet_interface_t *ei;
224 ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
225 ASSERT (sizeof (mp->l2_address) >= sizeof (ei->address));
226 clib_memcpy (mp->l2_address, ei->address, sizeof (ei->address));
227 mp->l2_address_length = ntohl (sizeof (ei->address));
229 else if (swif->sup_sw_if_index != swif->sw_if_index)
231 vnet_sub_interface_t *sub = &swif->sub;
232 mp->sub_id = ntohl (sub->id);
233 mp->sub_dot1ad = sub->eth.flags.dot1ad;
234 mp->sub_number_of_tags =
235 sub->eth.flags.one_tag + sub->eth.flags.two_tags * 2;
236 mp->sub_outer_vlan_id = ntohs (sub->eth.outer_vlan_id);
237 mp->sub_inner_vlan_id = ntohs (sub->eth.inner_vlan_id);
238 mp->sub_exact_match = sub->eth.flags.exact_match;
239 mp->sub_default = sub->eth.flags.default_sub;
240 mp->sub_outer_vlan_id_any = sub->eth.flags.outer_vlan_id_any;
241 mp->sub_inner_vlan_id_any = sub->eth.flags.inner_vlan_id_any;
244 /* vlan tag rewrite data */
245 u32 vtr_op = L2_VTR_DISABLED;
246 u32 vtr_push_dot1q = 0, vtr_tag1 = 0, vtr_tag2 = 0;
248 if (l2vtr_get (am->vlib_main, am->vnet_main, swif->sw_if_index,
249 &vtr_op, &vtr_push_dot1q, &vtr_tag1, &vtr_tag2) != 0)
251 // error - default to disabled
252 mp->vtr_op = ntohl (L2_VTR_DISABLED);
253 clib_warning ("cannot get vlan tag rewrite for sw_if_index %d",
258 mp->vtr_op = ntohl (vtr_op);
259 mp->vtr_push_dot1q = ntohl (vtr_push_dot1q);
260 mp->vtr_tag1 = ntohl (vtr_tag1);
261 mp->vtr_tag2 = ntohl (vtr_tag2);
264 /* pbb tag rewrite data */
265 ethernet_header_t eth_hdr;
266 u32 pbb_vtr_op = L2_VTR_DISABLED;
270 clib_memset (ð_hdr, 0, sizeof (eth_hdr));
272 if (!l2pbb_get (am->vlib_main, am->vnet_main, swif->sw_if_index,
273 &pbb_vtr_op, &outer_tag, ð_hdr, &b_vlanid, &i_sid))
276 clib_memcpy (mp->b_dmac, eth_hdr.dst_address,
277 sizeof (eth_hdr.dst_address));
278 clib_memcpy (mp->b_smac, eth_hdr.src_address,
279 sizeof (eth_hdr.src_address));
280 mp->b_vlanid = b_vlanid;
284 u8 *tag = vnet_get_sw_interface_tag (vnet_get_main (), swif->sw_if_index);
286 strncpy ((char *) mp->tag, (char *) tag, ARRAY_LEN (mp->tag) - 1);
288 vl_api_send_msg (rp, (u8 *) mp);
292 vl_api_sw_interface_dump_t_handler (vl_api_sw_interface_dump_t * mp)
294 vpe_api_main_t *am = &vpe_api_main;
295 vnet_sw_interface_t *swif;
296 vnet_interface_main_t *im = &am->vnet_main->interface_main;
297 vl_api_registration_t *rp;
300 rp = vl_api_client_index_to_registration (mp->client_index);
304 clib_warning ("Client %d AWOL", mp->client_index);
308 u8 *filter = 0, *name = 0;
309 sw_if_index = ntohl (mp->sw_if_index);
311 if (!mp->name_filter_valid && sw_if_index != ~0 && sw_if_index != 0)
313 /* is it a valid sw_if_index? */
314 if (!vnet_sw_if_index_is_api_valid (sw_if_index))
317 swif = vec_elt_at_index (im->sw_interfaces, sw_if_index);
319 vec_reset_length (name);
321 format (name, "%U%c", format_vnet_sw_interface_name, am->vnet_main,
323 send_sw_interface_details (am, rp, swif, name, mp->context);
328 if (mp->name_filter_valid)
331 format (0, ".*%s", vl_api_string_len (&mp->name_filter),
332 vl_api_from_api_string (&mp->name_filter), 0);
335 char *strcasestr (char *, char *); /* lnx hdr file botch */
337 pool_foreach (swif, im->sw_interfaces,
339 if (!vnet_swif_is_api_visible (swif))
341 vec_reset_length(name);
342 name = format (name, "%U%c", format_vnet_sw_interface_name, am->vnet_main,
345 if (filter && !strcasestr((char *) name, (char *) filter))
348 send_sw_interface_details (am, rp, swif, name, mp->context);
357 vl_api_sw_interface_add_del_address_t_handler
358 (vl_api_sw_interface_add_del_address_t * mp)
360 vlib_main_t *vm = vlib_get_main ();
361 vnet_main_t *vnm = vnet_get_main ();
362 vl_api_sw_interface_add_del_address_reply_t *rmp;
365 clib_error_t *error = 0;
367 VALIDATE_SW_IF_INDEX (mp);
369 is_del = mp->is_add == 0;
373 ip_del_all_interface_addresses (vm, ntohl (mp->sw_if_index));
374 else if (mp->is_ipv6)
375 error = ip6_add_del_interface_address (vm, ntohl (mp->sw_if_index),
376 (void *) mp->address,
377 mp->address_length, is_del);
379 error = ip4_add_del_interface_address (vm, ntohl (mp->sw_if_index),
380 (void *) mp->address,
381 mp->address_length, is_del);
386 clib_error_report (error);
390 BAD_SW_IF_INDEX_LABEL;
393 REPLY_MACRO (VL_API_SW_INTERFACE_ADD_DEL_ADDRESS_REPLY);
397 vl_api_sw_interface_set_table_t_handler (vl_api_sw_interface_set_table_t * mp)
399 vl_api_sw_interface_set_table_reply_t *rmp;
400 u32 sw_if_index = ntohl (mp->sw_if_index);
401 u32 table_id = ntohl (mp->vrf_id);
404 VALIDATE_SW_IF_INDEX (mp);
407 rv = ip_table_bind (FIB_PROTOCOL_IP6, sw_if_index, table_id, 1);
409 rv = ip_table_bind (FIB_PROTOCOL_IP4, sw_if_index, table_id, 1);
411 BAD_SW_IF_INDEX_LABEL;
413 REPLY_MACRO (VL_API_SW_INTERFACE_SET_TABLE_REPLY);
417 ip_table_bind (fib_protocol_t fproto,
418 u32 sw_if_index, u32 table_id, u8 is_api)
420 CLIB_UNUSED (ip_interface_address_t * ia);
421 u32 fib_index, mfib_index;
427 src = FIB_SOURCE_API;
428 msrc = MFIB_SOURCE_API;
432 src = FIB_SOURCE_CLI;
433 msrc = MFIB_SOURCE_CLI;
437 * This if table does not exist = error is what we want in the end.
439 fib_index = fib_table_find (fproto, table_id);
440 mfib_index = mfib_table_find (fproto, table_id);
442 if (~0 == fib_index || ~0 == mfib_index)
444 return (VNET_API_ERROR_NO_SUCH_FIB);
447 if (FIB_PROTOCOL_IP6 == fproto)
450 * If the interface already has in IP address, then a change int
451 * VRF is not allowed. The IP address applied must first be removed.
452 * We do not do that automatically here, since VPP has no knowledge
453 * of whether those subnets are valid in the destination VRF.
456 foreach_ip_interface_address (&ip6_main.lookup_main,
458 1 /* honor unnumbered */ ,
460 return (VNET_API_ERROR_ADDRESS_FOUND_FOR_INTERFACE);
464 vec_validate (ip6_main.fib_index_by_sw_if_index, sw_if_index);
465 vec_validate (ip6_main.mfib_index_by_sw_if_index, sw_if_index);
468 * tell those that are interested that the binding is changing.
470 ip6_table_bind_callback_t *cb;
471 vec_foreach (cb, ip6_main.table_bind_callbacks)
472 cb->function (&ip6_main, cb->function_opaque,
475 ip6_main.fib_index_by_sw_if_index[sw_if_index]);
479 /* reset back to default */
480 if (0 != ip6_main.fib_index_by_sw_if_index[sw_if_index])
481 fib_table_unlock (ip6_main.fib_index_by_sw_if_index[sw_if_index],
482 FIB_PROTOCOL_IP6, src);
483 if (0 != ip6_main.mfib_index_by_sw_if_index[sw_if_index])
484 mfib_table_unlock (ip6_main.mfib_index_by_sw_if_index
485 [sw_if_index], FIB_PROTOCOL_IP6, msrc);
490 /* we need to lock the table now it's inuse */
491 fib_table_lock (fib_index, FIB_PROTOCOL_IP6, src);
492 mfib_table_lock (mfib_index, FIB_PROTOCOL_IP6, msrc);
495 ip6_main.fib_index_by_sw_if_index[sw_if_index] = fib_index;
496 ip6_main.mfib_index_by_sw_if_index[sw_if_index] = mfib_index;
501 * If the interface already has in IP address, then a change int
502 * VRF is not allowed. The IP address applied must first be removed.
503 * We do not do that automatically here, since VPP has no knowledge
504 * of whether those subnets are valid in the destination VRF.
507 foreach_ip_interface_address (&ip4_main.lookup_main,
509 1 /* honor unnumbered */ ,
511 return (VNET_API_ERROR_ADDRESS_FOUND_FOR_INTERFACE);
515 vec_validate (ip4_main.fib_index_by_sw_if_index, sw_if_index);
516 vec_validate (ip4_main.mfib_index_by_sw_if_index, sw_if_index);
519 * tell those that are interested that the binding is changing.
521 ip4_table_bind_callback_t *cb;
522 vec_foreach (cb, ip4_main.table_bind_callbacks)
523 cb->function (&ip4_main, cb->function_opaque,
526 ip4_main.fib_index_by_sw_if_index[sw_if_index]);
530 /* reset back to default */
531 if (0 != ip4_main.fib_index_by_sw_if_index[sw_if_index])
532 fib_table_unlock (ip4_main.fib_index_by_sw_if_index[sw_if_index],
533 FIB_PROTOCOL_IP4, src);
534 if (0 != ip4_main.mfib_index_by_sw_if_index[sw_if_index])
535 mfib_table_unlock (ip4_main.mfib_index_by_sw_if_index
536 [sw_if_index], FIB_PROTOCOL_IP4, msrc);
541 /* we need to lock the table now it's inuse */
542 fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
545 mfib_index = mfib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
549 ip4_main.fib_index_by_sw_if_index[sw_if_index] = fib_index;
550 ip4_main.mfib_index_by_sw_if_index[sw_if_index] = mfib_index;
557 send_sw_interface_get_table_reply (vl_api_registration_t * reg,
558 u32 context, int retval, u32 vrf_id)
560 vl_api_sw_interface_get_table_reply_t *mp;
562 mp = vl_msg_api_alloc (sizeof (*mp));
563 clib_memset (mp, 0, sizeof (*mp));
564 mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_GET_TABLE_REPLY);
565 mp->context = context;
566 mp->retval = htonl (retval);
567 mp->vrf_id = htonl (vrf_id);
569 vl_api_send_msg (reg, (u8 *) mp);
573 vl_api_sw_interface_get_table_t_handler (vl_api_sw_interface_get_table_t * mp)
575 vl_api_registration_t *reg;
576 fib_table_t *fib_table = 0;
577 u32 sw_if_index = ~0;
580 fib_protocol_t fib_proto = FIB_PROTOCOL_IP4;
583 reg = vl_api_client_index_to_registration (mp->client_index);
587 VALIDATE_SW_IF_INDEX (mp);
589 sw_if_index = ntohl (mp->sw_if_index);
592 fib_proto = FIB_PROTOCOL_IP6;
594 fib_index = fib_table_get_index_for_sw_if_index (fib_proto, sw_if_index);
597 fib_table = fib_table_get (fib_index, fib_proto);
598 table_id = fib_table->ft_table_id;
601 BAD_SW_IF_INDEX_LABEL;
603 send_sw_interface_get_table_reply (reg, mp->context, rv, table_id);
606 static void vl_api_sw_interface_set_unnumbered_t_handler
607 (vl_api_sw_interface_set_unnumbered_t * mp)
609 vl_api_sw_interface_set_unnumbered_reply_t *rmp;
611 vnet_main_t *vnm = vnet_get_main ();
612 u32 sw_if_index = ntohl (mp->sw_if_index);
613 u32 unnumbered_sw_if_index = ntohl (mp->unnumbered_sw_if_index);
616 * The API message field names are backwards from
617 * the underlying data structure names.
618 * It's not worth changing them now.
620 if (!vnet_sw_interface_is_api_valid (vnm, unnumbered_sw_if_index))
622 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
626 /* Only check the "use loop0" field when setting the binding */
627 if (mp->is_add && !vnet_sw_interface_is_api_valid (vnm, sw_if_index))
629 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX_2;
633 vnet_sw_interface_update_unnumbered (unnumbered_sw_if_index,
634 sw_if_index, mp->is_add);
636 REPLY_MACRO (VL_API_SW_INTERFACE_SET_UNNUMBERED_REPLY);
640 vl_api_sw_interface_clear_stats_t_handler (vl_api_sw_interface_clear_stats_t *
643 vl_api_sw_interface_clear_stats_reply_t *rmp;
645 vnet_main_t *vnm = vnet_get_main ();
646 vnet_interface_main_t *im = &vnm->interface_main;
647 vlib_simple_counter_main_t *sm;
648 vlib_combined_counter_main_t *cm;
652 if (mp->sw_if_index != ~0)
653 VALIDATE_SW_IF_INDEX (mp);
655 n_counters = vec_len (im->combined_sw_if_counters);
657 for (j = 0; j < n_counters; j++)
659 im = &vnm->interface_main;
660 cm = im->combined_sw_if_counters + j;
661 if (mp->sw_if_index == (u32) ~ 0)
662 vlib_clear_combined_counters (cm);
664 vlib_zero_combined_counter (cm, ntohl (mp->sw_if_index));
667 n_counters = vec_len (im->sw_if_counters);
669 for (j = 0; j < n_counters; j++)
671 im = &vnm->interface_main;
672 sm = im->sw_if_counters + j;
673 if (mp->sw_if_index == (u32) ~ 0)
674 vlib_clear_simple_counters (sm);
676 vlib_zero_simple_counter (sm, ntohl (mp->sw_if_index));
679 BAD_SW_IF_INDEX_LABEL;
681 REPLY_MACRO (VL_API_SW_INTERFACE_CLEAR_STATS_REPLY);
685 * Events used for sw_interface_events
689 API_LINK_STATE_UP_EVENT = 1 << 1,
690 API_LINK_STATE_DOWN_EVENT = 1 << 2,
691 API_ADMIN_UP_EVENT = 1 << 3,
692 API_ADMIN_DOWN_EVENT = 1 << 4,
693 API_SW_INTERFACE_ADD_EVENT = 1 << 5,
694 API_SW_INTERFACE_DEL_EVENT = 1 << 6,
698 send_sw_interface_event (vpe_api_main_t * am,
699 vpe_client_registration_t * reg,
700 vl_api_registration_t * vl_reg,
701 u32 sw_if_index, enum api_events events)
703 vl_api_sw_interface_event_t *mp;
705 mp = vl_msg_api_alloc (sizeof (*mp));
706 clib_memset (mp, 0, sizeof (*mp));
707 mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_EVENT);
708 mp->sw_if_index = ntohl (sw_if_index);
709 mp->client_index = reg->client_index;
710 mp->pid = reg->client_pid;
711 mp->admin_up_down = events & API_ADMIN_UP_EVENT ? 1 : 0;
712 mp->link_up_down = events & API_LINK_STATE_UP_EVENT ? 1 : 0;
713 mp->deleted = events & API_SW_INTERFACE_DEL_EVENT ? 1 : 0;
714 vl_api_send_msg (vl_reg, (u8 *) mp);
718 link_state_process (vlib_main_t * vm,
719 vlib_node_runtime_t * rt, vlib_frame_t * f)
721 vpe_api_main_t *vam = &vpe_api_main;
722 uword *event_by_sw_if_index = 0;
723 vpe_client_registration_t *reg;
725 vl_api_registration_t *vl_reg;
727 uword *event_data = 0;
730 vam->link_state_process_up = 1;
734 vlib_process_wait_for_event (vm);
736 /* Batch up events */
737 while ((event_type = vlib_process_get_events (vm, &event_data)) != ~0)
739 for (i = 0; i < vec_len (event_data); i++)
741 sw_if_index = event_data[i];
742 vec_validate_init_empty (event_by_sw_if_index, sw_if_index, 0);
743 event_by_sw_if_index[sw_if_index] |= event_type;
745 vec_reset_length (event_data);
748 for (i = 0; i < vec_len (event_by_sw_if_index); i++)
750 if (event_by_sw_if_index[i] == 0)
754 pool_foreach(reg, vam->interface_events_registrations,
756 vl_reg = vl_api_client_index_to_registration (reg->client_index);
758 send_sw_interface_event (vam, reg, vl_reg, i, event_by_sw_if_index[i]);
762 vec_reset_length (event_by_sw_if_index);
768 static clib_error_t *link_up_down_function (vnet_main_t * vm, u32 hw_if_index,
770 static clib_error_t *admin_up_down_function (vnet_main_t * vm,
771 u32 hw_if_index, u32 flags);
772 static clib_error_t *sw_interface_add_del_function (vnet_main_t * vm,
777 VLIB_REGISTER_NODE (link_state_process_node,static) = {
778 .function = link_state_process,
779 .type = VLIB_NODE_TYPE_PROCESS,
780 .name = "vpe-link-state-process",
784 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (admin_up_down_function);
785 VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION (link_up_down_function);
786 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (sw_interface_add_del_function);
788 static clib_error_t *
789 link_up_down_function (vnet_main_t * vm, u32 hw_if_index, u32 flags)
791 vpe_api_main_t *vam = &vpe_api_main;
792 vnet_hw_interface_t *hi = vnet_get_hw_interface (vm, hw_if_index);
794 if (vam->link_state_process_up)
796 enum api_events event =
797 flags ? API_LINK_STATE_UP_EVENT : API_LINK_STATE_DOWN_EVENT;
798 vlib_process_signal_event (vam->vlib_main,
799 link_state_process_node.index, event,
805 static clib_error_t *
806 admin_up_down_function (vnet_main_t * vm, u32 sw_if_index, u32 flags)
808 vpe_api_main_t *vam = &vpe_api_main;
811 * Note: it's perfectly fair to set a subif admin up / admin down.
812 * Note the subtle distinction between this routine and the previous
815 if (vam->link_state_process_up)
817 enum api_events event =
818 flags ? API_ADMIN_UP_EVENT : API_ADMIN_DOWN_EVENT;
819 vlib_process_signal_event (vam->vlib_main,
820 link_state_process_node.index, event,
826 static clib_error_t *
827 sw_interface_add_del_function (vnet_main_t * vm, u32 sw_if_index, u32 flags)
829 vpe_api_main_t *vam = &vpe_api_main;
831 if (vam->link_state_process_up)
833 enum api_events event =
834 flags ? API_SW_INTERFACE_ADD_EVENT : API_SW_INTERFACE_DEL_EVENT;
835 vlib_process_signal_event (vam->vlib_main,
836 link_state_process_node.index, event,
842 static void vl_api_sw_interface_tag_add_del_t_handler
843 (vl_api_sw_interface_tag_add_del_t * mp)
845 vnet_main_t *vnm = vnet_get_main ();
846 vl_api_sw_interface_tag_add_del_reply_t *rmp;
849 u32 sw_if_index = ntohl (mp->sw_if_index);
851 VALIDATE_SW_IF_INDEX (mp);
857 rv = VNET_API_ERROR_INVALID_VALUE;
861 mp->tag[ARRAY_LEN (mp->tag) - 1] = 0;
862 tag = format (0, "%s%c", mp->tag, 0);
863 vnet_set_sw_interface_tag (vnm, tag, sw_if_index);
866 vnet_clear_sw_interface_tag (vnm, sw_if_index);
868 BAD_SW_IF_INDEX_LABEL;
870 REPLY_MACRO (VL_API_SW_INTERFACE_TAG_ADD_DEL_REPLY);
873 static void vl_api_sw_interface_set_mac_address_t_handler
874 (vl_api_sw_interface_set_mac_address_t * mp)
876 vl_api_sw_interface_set_mac_address_reply_t *rmp;
877 vnet_main_t *vnm = vnet_get_main ();
878 u32 sw_if_index = ntohl (mp->sw_if_index);
879 vnet_sw_interface_t *si;
883 VALIDATE_SW_IF_INDEX (mp);
885 si = vnet_get_sw_interface (vnm, sw_if_index);
886 error = vnet_hw_interface_change_mac_address (vnm, si->hw_if_index,
890 rv = VNET_API_ERROR_UNIMPLEMENTED;
891 clib_error_report (error);
895 BAD_SW_IF_INDEX_LABEL;
897 REPLY_MACRO (VL_API_SW_INTERFACE_SET_MAC_ADDRESS_REPLY);
900 static void vl_api_sw_interface_get_mac_address_t_handler
901 (vl_api_sw_interface_get_mac_address_t * mp)
903 vl_api_sw_interface_get_mac_address_reply_t *rmp;
904 vl_api_registration_t *reg;
905 vnet_main_t *vnm = vnet_get_main ();
906 u32 sw_if_index = ntohl (mp->sw_if_index);
907 vnet_sw_interface_t *si;
908 ethernet_interface_t *eth_if = 0;
911 VALIDATE_SW_IF_INDEX (mp);
913 si = vnet_get_sup_sw_interface (vnm, sw_if_index);
914 if (si->type == VNET_SW_INTERFACE_TYPE_HARDWARE)
915 eth_if = ethernet_get_interface (ðernet_main, si->hw_if_index);
917 BAD_SW_IF_INDEX_LABEL;
919 reg = vl_api_client_index_to_registration (mp->client_index);
922 rmp = vl_msg_api_alloc (sizeof (*rmp));
923 rmp->_vl_msg_id = htons (VL_API_SW_INTERFACE_GET_MAC_ADDRESS_REPLY);
924 rmp->context = mp->context;
925 rmp->retval = htonl (rv);
927 memcpy (rmp->mac_address, eth_if->address, 6);
928 vl_api_send_msg (reg, (u8 *) rmp);
931 static void vl_api_sw_interface_set_rx_mode_t_handler
932 (vl_api_sw_interface_set_rx_mode_t * mp)
934 vl_api_sw_interface_set_rx_mode_reply_t *rmp;
935 vnet_main_t *vnm = vnet_get_main ();
936 u32 sw_if_index = ntohl (mp->sw_if_index);
937 vnet_sw_interface_t *si;
941 VALIDATE_SW_IF_INDEX (mp);
943 si = vnet_get_sw_interface (vnm, sw_if_index);
944 if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
946 rv = VNET_API_ERROR_INVALID_VALUE;
947 goto bad_sw_if_index;
950 error = set_hw_interface_change_rx_mode (vnm, si->hw_if_index,
952 ntohl (mp->queue_id), mp->mode);
955 rv = VNET_API_ERROR_UNIMPLEMENTED;
956 clib_error_report (error);
960 BAD_SW_IF_INDEX_LABEL;
962 REPLY_MACRO (VL_API_SW_INTERFACE_SET_RX_MODE_REPLY);
966 send_interface_rx_placement_details (vpe_api_main_t * am,
967 vl_api_registration_t * rp,
968 u32 sw_if_index, u32 worker_id,
969 u32 queue_id, u8 mode, u32 context)
971 vl_api_sw_interface_rx_placement_details_t *mp;
972 mp = vl_msg_api_alloc (sizeof (*mp));
973 clib_memset (mp, 0, sizeof (*mp));
975 mp->_vl_msg_id = htons (VL_API_SW_INTERFACE_RX_PLACEMENT_DETAILS);
976 mp->sw_if_index = htonl (sw_if_index);
977 mp->queue_id = htonl (queue_id);
978 mp->worker_id = htonl (worker_id);
980 mp->context = context;
982 vl_api_send_msg (rp, (u8 *) mp);
985 static void vl_api_sw_interface_rx_placement_dump_t_handler
986 (vl_api_sw_interface_rx_placement_dump_t * mp)
988 vnet_main_t *vnm = vnet_get_main ();
989 vpe_api_main_t *am = &vpe_api_main;
990 u32 sw_if_index = ntohl (mp->sw_if_index);
991 vl_api_registration_t *reg;
993 reg = vl_api_client_index_to_registration (mp->client_index);
997 if (sw_if_index == ~0)
999 vnet_device_input_runtime_t *rt;
1000 vnet_device_and_queue_t *dq;
1001 vlib_node_t *pn = vlib_get_node_by_name (am->vlib_main,
1002 (u8 *) "device-input");
1007 foreach_vlib_main (({
1008 clib_bitmap_foreach (si, pn->sibling_bitmap,
1010 rt = vlib_node_get_runtime_data (this_vlib_main, si);
1011 vec_foreach (dq, rt->devices_and_queues)
1013 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm,
1015 send_interface_rx_placement_details (am, reg, hw->sw_if_index, index,
1016 dq->queue_id, dq->mode, mp->context);
1026 vnet_sw_interface_t *si;
1028 if (!vnet_sw_if_index_is_api_valid (sw_if_index))
1030 clib_warning ("sw_if_index %u does not exist", sw_if_index);
1031 goto bad_sw_if_index;
1034 si = vnet_get_sw_interface (vnm, sw_if_index);
1035 if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
1037 clib_warning ("interface type is not HARDWARE! P2P, PIPE and SUB"
1038 " interfaces are not supported");
1039 goto bad_sw_if_index;
1042 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, si->hw_if_index);
1044 for (i = 0; i < vec_len (hw->dq_runtime_index_by_queue); i++)
1046 send_interface_rx_placement_details (am, reg, hw->sw_if_index,
1047 hw->input_node_thread_index_by_queue
1049 hw->rx_mode_by_queue[i],
1054 BAD_SW_IF_INDEX_LABEL;
1057 static void vl_api_sw_interface_set_rx_placement_t_handler
1058 (vl_api_sw_interface_set_rx_placement_t * mp)
1060 vl_api_sw_interface_set_rx_placement_reply_t *rmp;
1061 vnet_main_t *vnm = vnet_get_main ();
1062 u32 sw_if_index = ntohl (mp->sw_if_index);
1063 vnet_sw_interface_t *si;
1064 clib_error_t *error = 0;
1067 VALIDATE_SW_IF_INDEX (mp);
1069 si = vnet_get_sw_interface (vnm, sw_if_index);
1070 if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
1072 rv = VNET_API_ERROR_INVALID_VALUE;
1073 goto bad_sw_if_index;
1076 error = set_hw_interface_rx_placement (si->hw_if_index,
1077 ntohl (mp->queue_id),
1078 ntohl (mp->worker_id), mp->is_main);
1081 rv = VNET_API_ERROR_UNIMPLEMENTED;
1082 clib_error_report (error);
1086 BAD_SW_IF_INDEX_LABEL;
1088 REPLY_MACRO (VL_API_SW_INTERFACE_SET_RX_PLACEMENT_REPLY);
1092 vl_api_create_vlan_subif_t_handler (vl_api_create_vlan_subif_t * mp)
1094 vl_api_create_vlan_subif_reply_t *rmp;
1095 vnet_main_t *vnm = vnet_get_main ();
1096 u32 sw_if_index = (u32) ~ 0;
1097 vnet_hw_interface_t *hi;
1100 vnet_sw_interface_t template;
1102 vnet_interface_main_t *im = &vnm->interface_main;
1103 u64 sup_and_sub_key;
1104 vl_api_registration_t *reg;
1105 clib_error_t *error;
1107 VALIDATE_SW_IF_INDEX (mp);
1109 hi = vnet_get_sup_hw_interface (vnm, ntohl (mp->sw_if_index));
1111 if (hi->bond_info == VNET_HW_INTERFACE_BOND_INFO_SLAVE)
1113 rv = VNET_API_ERROR_BOND_SLAVE_NOT_ALLOWED;
1117 id = ntohl (mp->vlan_id);
1118 if (id == 0 || id > 4095)
1120 rv = VNET_API_ERROR_INVALID_VLAN;
1124 sup_and_sub_key = ((u64) (hi->sw_if_index) << 32) | (u64) id;
1126 p = hash_get_mem (im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
1129 rv = VNET_API_ERROR_VLAN_ALREADY_EXISTS;
1133 clib_memset (&template, 0, sizeof (template));
1134 template.type = VNET_SW_INTERFACE_TYPE_SUB;
1135 template.flood_class = VNET_FLOOD_CLASS_NORMAL;
1136 template.sup_sw_if_index = hi->sw_if_index;
1137 template.sub.id = id;
1138 template.sub.eth.raw_flags = 0;
1139 template.sub.eth.flags.one_tag = 1;
1140 template.sub.eth.outer_vlan_id = id;
1141 template.sub.eth.flags.exact_match = 1;
1143 error = vnet_create_sw_interface (vnm, &template, &sw_if_index);
1146 clib_error_report (error);
1147 rv = VNET_API_ERROR_INVALID_REGISTRATION;
1151 u64 *kp = clib_mem_alloc (sizeof (*kp));
1152 *kp = sup_and_sub_key;
1154 hash_set (hi->sub_interface_sw_if_index_by_id, id, sw_if_index);
1155 hash_set_mem (im->sw_if_index_by_sup_and_sub, kp, sw_if_index);
1157 BAD_SW_IF_INDEX_LABEL;
1160 reg = vl_api_client_index_to_registration (mp->client_index);
1164 rmp = vl_msg_api_alloc (sizeof (*rmp));
1165 rmp->_vl_msg_id = htons (VL_API_CREATE_VLAN_SUBIF_REPLY);
1166 rmp->context = mp->context;
1167 rmp->retval = htonl (rv);
1168 rmp->sw_if_index = htonl (sw_if_index);
1169 vl_api_send_msg (reg, (u8 *) rmp);
1173 vl_api_create_subif_t_handler (vl_api_create_subif_t * mp)
1175 vl_api_create_subif_reply_t *rmp;
1176 vnet_main_t *vnm = vnet_get_main ();
1177 u32 sw_if_index = ~0;
1180 vnet_sw_interface_t *si;
1181 vnet_hw_interface_t *hi;
1182 vnet_sw_interface_t template;
1184 vnet_interface_main_t *im = &vnm->interface_main;
1185 u64 sup_and_sub_key;
1186 clib_error_t *error;
1188 VALIDATE_SW_IF_INDEX (mp);
1190 si = vnet_get_sup_sw_interface (vnm, ntohl (mp->sw_if_index));
1191 hi = vnet_get_sup_hw_interface (vnm, ntohl (mp->sw_if_index));
1193 if (hi->bond_info == VNET_HW_INTERFACE_BOND_INFO_SLAVE)
1195 rv = VNET_API_ERROR_BOND_SLAVE_NOT_ALLOWED;
1199 sw_if_index = si->sw_if_index;
1200 sub_id = ntohl (mp->sub_id);
1202 sup_and_sub_key = ((u64) (sw_if_index) << 32) | (u64) sub_id;
1204 p = hash_get_mem (im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
1208 clib_warning ("sup sw_if_index %d, sub id %d already exists\n",
1209 sw_if_index, sub_id);
1210 rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
1214 clib_memset (&template, 0, sizeof (template));
1215 template.type = VNET_SW_INTERFACE_TYPE_SUB;
1216 template.flood_class = VNET_FLOOD_CLASS_NORMAL;
1217 template.sup_sw_if_index = sw_if_index;
1218 template.sub.id = sub_id;
1219 template.sub.eth.flags.no_tags = mp->no_tags;
1220 template.sub.eth.flags.one_tag = mp->one_tag;
1221 template.sub.eth.flags.two_tags = mp->two_tags;
1222 template.sub.eth.flags.dot1ad = mp->dot1ad;
1223 template.sub.eth.flags.exact_match = mp->exact_match;
1224 template.sub.eth.flags.default_sub = mp->default_sub;
1225 template.sub.eth.flags.outer_vlan_id_any = mp->outer_vlan_id_any;
1226 template.sub.eth.flags.inner_vlan_id_any = mp->inner_vlan_id_any;
1227 template.sub.eth.outer_vlan_id = ntohs (mp->outer_vlan_id);
1228 template.sub.eth.inner_vlan_id = ntohs (mp->inner_vlan_id);
1230 error = vnet_create_sw_interface (vnm, &template, &sw_if_index);
1233 clib_error_report (error);
1234 rv = VNET_API_ERROR_SUBIF_CREATE_FAILED;
1238 u64 *kp = clib_mem_alloc (sizeof (*kp));
1239 *kp = sup_and_sub_key;
1241 hash_set (hi->sub_interface_sw_if_index_by_id, sub_id, sw_if_index);
1242 hash_set_mem (im->sw_if_index_by_sup_and_sub, kp, sw_if_index);
1244 BAD_SW_IF_INDEX_LABEL;
1249 REPLY_MACRO2(VL_API_CREATE_SUBIF_REPLY,
1251 rmp->sw_if_index = ntohl(sw_if_index);
1257 vl_api_delete_subif_t_handler (vl_api_delete_subif_t * mp)
1259 vl_api_delete_subif_reply_t *rmp;
1262 rv = vnet_delete_sub_interface (ntohl (mp->sw_if_index));
1264 REPLY_MACRO (VL_API_DELETE_SUBIF_REPLY);
1268 vl_api_interface_name_renumber_t_handler (vl_api_interface_name_renumber_t *
1271 vl_api_interface_name_renumber_reply_t *rmp;
1274 VALIDATE_SW_IF_INDEX (mp);
1276 rv = vnet_interface_name_renumber
1277 (ntohl (mp->sw_if_index), ntohl (mp->new_show_dev_instance));
1279 BAD_SW_IF_INDEX_LABEL;
1281 REPLY_MACRO (VL_API_INTERFACE_NAME_RENUMBER_REPLY);
1285 vl_api_create_loopback_t_handler (vl_api_create_loopback_t * mp)
1287 vl_api_create_loopback_reply_t *rmp;
1291 rv = vnet_create_loopback_interface (&sw_if_index, mp->mac_address, 0, 0);
1294 REPLY_MACRO2(VL_API_CREATE_LOOPBACK_REPLY,
1296 rmp->sw_if_index = ntohl (sw_if_index);
1301 static void vl_api_create_loopback_instance_t_handler
1302 (vl_api_create_loopback_instance_t * mp)
1304 vl_api_create_loopback_instance_reply_t *rmp;
1306 u8 is_specified = mp->is_specified;
1307 u32 user_instance = ntohl (mp->user_instance);
1310 rv = vnet_create_loopback_interface (&sw_if_index, mp->mac_address,
1311 is_specified, user_instance);
1314 REPLY_MACRO2(VL_API_CREATE_LOOPBACK_INSTANCE_REPLY,
1316 rmp->sw_if_index = ntohl (sw_if_index);
1322 vl_api_delete_loopback_t_handler (vl_api_delete_loopback_t * mp)
1324 vl_api_delete_loopback_reply_t *rmp;
1328 sw_if_index = ntohl (mp->sw_if_index);
1329 rv = vnet_delete_loopback_interface (sw_if_index);
1331 REPLY_MACRO (VL_API_DELETE_LOOPBACK_REPLY);
1335 vl_api_collect_detailed_interface_stats_t_handler
1336 (vl_api_collect_detailed_interface_stats_t * mp)
1338 vl_api_collect_detailed_interface_stats_reply_t *rmp;
1342 vnet_sw_interface_stats_collect_enable_disable (ntohl (mp->sw_if_index),
1343 mp->enable_disable);
1345 REPLY_MACRO (VL_API_COLLECT_DETAILED_INTERFACE_STATS_REPLY);
1350 * Add vpe's API message handlers to the table.
1351 * vlib has already mapped shared memory and
1352 * added the client registration handlers.
1353 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
1355 #define vl_msg_name_crc_list
1356 #include <vnet/interface.api.h>
1357 #undef vl_msg_name_crc_list
1360 setup_message_id_table (api_main_t * am)
1362 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
1363 foreach_vl_msg_name_crc_interface;
1367 pub_sub_handler (interface_events, INTERFACE_EVENTS);
1369 static clib_error_t *
1370 interface_api_hookup (vlib_main_t * vm)
1372 api_main_t *am = &api_main;
1375 vl_msg_api_set_handlers(VL_API_##N, #n, \
1376 vl_api_##n##_t_handler, \
1378 vl_api_##n##_t_endian, \
1379 vl_api_##n##_t_print, \
1380 sizeof(vl_api_##n##_t), 1);
1381 foreach_vpe_api_msg;
1384 /* Mark these APIs as mp safe */
1385 am->is_mp_safe[VL_API_SW_INTERFACE_DUMP] = 1;
1386 am->is_mp_safe[VL_API_SW_INTERFACE_DETAILS] = 1;
1387 am->is_mp_safe[VL_API_SW_INTERFACE_TAG_ADD_DEL] = 1;
1389 /* Do not replay VL_API_SW_INTERFACE_DUMP messages */
1390 am->api_trace_cfg[VL_API_SW_INTERFACE_DUMP].replay_enable = 0;
1393 * Set up the (msg_name, crc, message-id) table
1395 setup_message_id_table (am);
1400 VLIB_API_INIT_FUNCTION (interface_api_hookup);
1403 * fd.io coding-style-patch-verification: ON
1406 * eval: (c-set-style "gnu")