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;
243 /* vlan tag rewrite data */
244 u32 vtr_op = L2_VTR_DISABLED;
245 u32 vtr_push_dot1q = 0, vtr_tag1 = 0, vtr_tag2 = 0;
247 if (l2vtr_get (am->vlib_main, am->vnet_main, swif->sw_if_index,
248 &vtr_op, &vtr_push_dot1q, &vtr_tag1, &vtr_tag2) != 0)
250 // error - default to disabled
251 mp->vtr_op = ntohl (L2_VTR_DISABLED);
252 clib_warning ("cannot get vlan tag rewrite for sw_if_index %d",
257 mp->vtr_op = ntohl (vtr_op);
258 mp->vtr_push_dot1q = ntohl (vtr_push_dot1q);
259 mp->vtr_tag1 = ntohl (vtr_tag1);
260 mp->vtr_tag2 = ntohl (vtr_tag2);
264 /* pbb tag rewrite data */
265 ethernet_header_t eth_hdr;
266 u32 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 &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 (sw_if_index != ~0)
313 /* is it a valid sw_if_index/ */
314 if (vec_len (im->sw_interfaces) <= sw_if_index)
317 swif = vec_elt_at_index (im->sw_interfaces, sw_if_index);
319 /* If we have a sw_if_index, ignore the name filter. */
320 mp->name_filter_valid = 0;
321 vec_reset_length (name);
323 format (name, "%U%c", format_vnet_sw_interface_name, am->vnet_main,
325 send_sw_interface_details (am, rp, swif, name, mp->context);
330 if (mp->name_filter_valid)
332 mp->name_filter[ARRAY_LEN (mp->name_filter) - 1] = 0;
333 filter = format (0, "%s%c", mp->name_filter, 0);
336 char *strcasestr (char *, char *); /* lnx hdr file botch */
338 pool_foreach (swif, im->sw_interfaces,
340 if (!vnet_swif_is_api_visible (swif))
342 vec_reset_length(name);
343 name = format (name, "%U%c", format_vnet_sw_interface_name, am->vnet_main,
346 if (filter && !strcasestr((char *) name, (char *) filter))
349 send_sw_interface_details (am, rp, swif, name, mp->context);
358 vl_api_sw_interface_add_del_address_t_handler
359 (vl_api_sw_interface_add_del_address_t * mp)
361 vlib_main_t *vm = vlib_get_main ();
362 vnet_main_t *vnm = vnet_get_main ();
363 vl_api_sw_interface_add_del_address_reply_t *rmp;
366 clib_error_t *error = 0;
368 VALIDATE_SW_IF_INDEX (mp);
370 is_del = mp->is_add == 0;
374 ip_del_all_interface_addresses (vm, ntohl (mp->sw_if_index));
375 else if (mp->is_ipv6)
376 error = ip6_add_del_interface_address (vm, ntohl (mp->sw_if_index),
377 (void *) mp->address,
378 mp->address_length, is_del);
380 error = ip4_add_del_interface_address (vm, ntohl (mp->sw_if_index),
381 (void *) mp->address,
382 mp->address_length, is_del);
387 clib_error_report (error);
391 BAD_SW_IF_INDEX_LABEL;
394 REPLY_MACRO (VL_API_SW_INTERFACE_ADD_DEL_ADDRESS_REPLY);
397 void stats_dslock_with_hint (int hint, int tag) __attribute__ ((weak));
399 stats_dslock_with_hint (int hint, int tag)
403 void stats_dsunlock (void) __attribute__ ((weak));
405 stats_dsunlock (void)
410 vl_api_sw_interface_set_table_t_handler (vl_api_sw_interface_set_table_t * mp)
412 vl_api_sw_interface_set_table_reply_t *rmp;
413 u32 sw_if_index = ntohl (mp->sw_if_index);
414 u32 table_id = ntohl (mp->vrf_id);
417 VALIDATE_SW_IF_INDEX (mp);
419 stats_dslock_with_hint (1 /* release hint */ , 4 /* tag */ );
422 rv = ip_table_bind (FIB_PROTOCOL_IP6, sw_if_index, table_id, 1);
424 rv = ip_table_bind (FIB_PROTOCOL_IP4, sw_if_index, table_id, 1);
428 BAD_SW_IF_INDEX_LABEL;
430 REPLY_MACRO (VL_API_SW_INTERFACE_SET_TABLE_REPLY);
434 ip_table_bind (fib_protocol_t fproto,
435 u32 sw_if_index, u32 table_id, u8 is_api)
437 CLIB_UNUSED (ip_interface_address_t * ia);
438 u32 fib_index, mfib_index;
444 src = FIB_SOURCE_API;
445 msrc = MFIB_SOURCE_API;
449 src = FIB_SOURCE_CLI;
450 msrc = MFIB_SOURCE_CLI;
454 * This if table does not exist = error is what we want in the end.
456 fib_index = fib_table_find (fproto, table_id);
457 mfib_index = mfib_table_find (fproto, table_id);
459 if (~0 == fib_index || ~0 == mfib_index)
461 return (VNET_API_ERROR_NO_SUCH_FIB);
464 if (FIB_PROTOCOL_IP6 == fproto)
467 * If the interface already has in IP address, then a change int
468 * VRF is not allowed. The IP address applied must first be removed.
469 * We do not do that automatically here, since VPP has no knowledge
470 * of whether those subnets are valid in the destination VRF.
473 foreach_ip_interface_address (&ip6_main.lookup_main,
475 1 /* honor unnumbered */ ,
477 return (VNET_API_ERROR_ADDRESS_FOUND_FOR_INTERFACE);
481 vec_validate (ip6_main.fib_index_by_sw_if_index, sw_if_index);
482 vec_validate (ip6_main.mfib_index_by_sw_if_index, sw_if_index);
485 * tell those that are interested that the binding is changing.
487 ip6_table_bind_callback_t *cb;
488 vec_foreach (cb, ip6_main.table_bind_callbacks)
489 cb->function (&ip6_main, cb->function_opaque,
492 ip6_main.fib_index_by_sw_if_index[sw_if_index]);
496 /* reset back to default */
497 if (0 != ip6_main.fib_index_by_sw_if_index[sw_if_index])
498 fib_table_unlock (ip6_main.fib_index_by_sw_if_index[sw_if_index],
499 FIB_PROTOCOL_IP6, src);
500 if (0 != ip6_main.mfib_index_by_sw_if_index[sw_if_index])
501 mfib_table_unlock (ip6_main.mfib_index_by_sw_if_index
502 [sw_if_index], FIB_PROTOCOL_IP6, msrc);
507 /* we need to lock the table now it's inuse */
508 fib_table_lock (fib_index, FIB_PROTOCOL_IP6, src);
509 mfib_table_lock (mfib_index, FIB_PROTOCOL_IP6, msrc);
512 ip6_main.fib_index_by_sw_if_index[sw_if_index] = fib_index;
513 ip6_main.mfib_index_by_sw_if_index[sw_if_index] = mfib_index;
518 * If the interface already has in IP address, then a change int
519 * VRF is not allowed. The IP address applied must first be removed.
520 * We do not do that automatically here, since VPP has no knowledge
521 * of whether those subnets are valid in the destination VRF.
524 foreach_ip_interface_address (&ip4_main.lookup_main,
526 1 /* honor unnumbered */ ,
528 return (VNET_API_ERROR_ADDRESS_FOUND_FOR_INTERFACE);
532 vec_validate (ip4_main.fib_index_by_sw_if_index, sw_if_index);
533 vec_validate (ip4_main.mfib_index_by_sw_if_index, sw_if_index);
536 * tell those that are interested that the binding is changing.
538 ip4_table_bind_callback_t *cb;
539 vec_foreach (cb, ip4_main.table_bind_callbacks)
540 cb->function (&ip4_main, cb->function_opaque,
543 ip4_main.fib_index_by_sw_if_index[sw_if_index]);
547 /* reset back to default */
548 if (0 != ip4_main.fib_index_by_sw_if_index[sw_if_index])
549 fib_table_unlock (ip4_main.fib_index_by_sw_if_index[sw_if_index],
550 FIB_PROTOCOL_IP4, src);
551 if (0 != ip4_main.mfib_index_by_sw_if_index[sw_if_index])
552 mfib_table_unlock (ip4_main.mfib_index_by_sw_if_index
553 [sw_if_index], FIB_PROTOCOL_IP4, msrc);
558 /* we need to lock the table now it's inuse */
559 fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
562 mfib_index = mfib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
566 ip4_main.fib_index_by_sw_if_index[sw_if_index] = fib_index;
567 ip4_main.mfib_index_by_sw_if_index[sw_if_index] = mfib_index;
574 send_sw_interface_get_table_reply (vl_api_registration_t * reg,
575 u32 context, int retval, u32 vrf_id)
577 vl_api_sw_interface_get_table_reply_t *mp;
579 mp = vl_msg_api_alloc (sizeof (*mp));
580 clib_memset (mp, 0, sizeof (*mp));
581 mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_GET_TABLE_REPLY);
582 mp->context = context;
583 mp->retval = htonl (retval);
584 mp->vrf_id = htonl (vrf_id);
586 vl_api_send_msg (reg, (u8 *) mp);
590 vl_api_sw_interface_get_table_t_handler (vl_api_sw_interface_get_table_t * mp)
592 vl_api_registration_t *reg;
593 fib_table_t *fib_table = 0;
594 u32 sw_if_index = ~0;
597 fib_protocol_t fib_proto = FIB_PROTOCOL_IP4;
600 reg = vl_api_client_index_to_registration (mp->client_index);
604 VALIDATE_SW_IF_INDEX (mp);
606 sw_if_index = ntohl (mp->sw_if_index);
609 fib_proto = FIB_PROTOCOL_IP6;
611 fib_index = fib_table_get_index_for_sw_if_index (fib_proto, sw_if_index);
614 fib_table = fib_table_get (fib_index, fib_proto);
615 table_id = fib_table->ft_table_id;
618 BAD_SW_IF_INDEX_LABEL;
620 send_sw_interface_get_table_reply (reg, mp->context, rv, table_id);
623 static void vl_api_sw_interface_set_unnumbered_t_handler
624 (vl_api_sw_interface_set_unnumbered_t * mp)
626 vl_api_sw_interface_set_unnumbered_reply_t *rmp;
628 vnet_main_t *vnm = vnet_get_main ();
629 u32 sw_if_index = ntohl (mp->sw_if_index);
630 u32 unnumbered_sw_if_index = ntohl (mp->unnumbered_sw_if_index);
633 * The API message field names are backwards from
634 * the underlying data structure names.
635 * It's not worth changing them now.
637 if (!vnet_sw_interface_is_api_valid (vnm, unnumbered_sw_if_index))
639 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
643 /* Only check the "use loop0" field when setting the binding */
644 if (mp->is_add && !vnet_sw_interface_is_api_valid (vnm, sw_if_index))
646 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX_2;
650 vnet_sw_interface_update_unnumbered (unnumbered_sw_if_index,
651 sw_if_index, mp->is_add);
653 REPLY_MACRO (VL_API_SW_INTERFACE_SET_UNNUMBERED_REPLY);
657 vl_api_sw_interface_clear_stats_t_handler (vl_api_sw_interface_clear_stats_t *
660 vl_api_sw_interface_clear_stats_reply_t *rmp;
662 vnet_main_t *vnm = vnet_get_main ();
663 vnet_interface_main_t *im = &vnm->interface_main;
664 vlib_simple_counter_main_t *sm;
665 vlib_combined_counter_main_t *cm;
666 static vnet_main_t **my_vnet_mains;
667 int i, j, n_counters;
670 if (mp->sw_if_index != ~0)
671 VALIDATE_SW_IF_INDEX (mp);
673 vec_reset_length (my_vnet_mains);
675 for (i = 0; i < vec_len (vnet_mains); i++)
678 vec_add1 (my_vnet_mains, vnet_mains[i]);
681 if (vec_len (vnet_mains) == 0)
682 vec_add1 (my_vnet_mains, vnm);
684 n_counters = vec_len (im->combined_sw_if_counters);
686 for (j = 0; j < n_counters; j++)
688 for (i = 0; i < vec_len (my_vnet_mains); i++)
690 im = &my_vnet_mains[i]->interface_main;
691 cm = im->combined_sw_if_counters + j;
692 if (mp->sw_if_index == (u32) ~ 0)
693 vlib_clear_combined_counters (cm);
695 vlib_zero_combined_counter (cm, ntohl (mp->sw_if_index));
699 n_counters = vec_len (im->sw_if_counters);
701 for (j = 0; j < n_counters; j++)
703 for (i = 0; i < vec_len (my_vnet_mains); i++)
705 im = &my_vnet_mains[i]->interface_main;
706 sm = im->sw_if_counters + j;
707 if (mp->sw_if_index == (u32) ~ 0)
708 vlib_clear_simple_counters (sm);
710 vlib_zero_simple_counter (sm, ntohl (mp->sw_if_index));
714 BAD_SW_IF_INDEX_LABEL;
716 REPLY_MACRO (VL_API_SW_INTERFACE_CLEAR_STATS_REPLY);
720 * Events used for sw_interface_events
724 API_LINK_STATE_UP_EVENT = 1 << 1,
725 API_LINK_STATE_DOWN_EVENT = 1 << 2,
726 API_ADMIN_UP_EVENT = 1 << 3,
727 API_ADMIN_DOWN_EVENT = 1 << 4,
728 API_SW_INTERFACE_ADD_EVENT = 1 << 5,
729 API_SW_INTERFACE_DEL_EVENT = 1 << 6,
733 send_sw_interface_event (vpe_api_main_t * am,
734 vpe_client_registration_t * reg,
735 vl_api_registration_t * vl_reg,
736 u32 sw_if_index, enum api_events events)
738 vl_api_sw_interface_event_t *mp;
740 mp = vl_msg_api_alloc (sizeof (*mp));
741 clib_memset (mp, 0, sizeof (*mp));
742 mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_EVENT);
743 mp->sw_if_index = ntohl (sw_if_index);
744 mp->client_index = reg->client_index;
745 mp->pid = reg->client_pid;
746 mp->admin_up_down = events & API_ADMIN_UP_EVENT ? 1 : 0;
747 mp->link_up_down = events & API_LINK_STATE_UP_EVENT ? 1 : 0;
748 mp->deleted = events & API_SW_INTERFACE_DEL_EVENT ? 1 : 0;
749 vl_api_send_msg (vl_reg, (u8 *) mp);
753 link_state_process (vlib_main_t * vm,
754 vlib_node_runtime_t * rt, vlib_frame_t * f)
756 vpe_api_main_t *vam = &vpe_api_main;
757 uword *event_by_sw_if_index = 0;
758 vpe_client_registration_t *reg;
760 vl_api_registration_t *vl_reg;
762 uword *event_data = 0;
765 vam->link_state_process_up = 1;
769 vlib_process_wait_for_event (vm);
771 /* Batch up events */
772 while ((event_type = vlib_process_get_events (vm, &event_data)) != ~0)
774 for (i = 0; i < vec_len (event_data); i++)
776 sw_if_index = event_data[i];
777 vec_validate_init_empty (event_by_sw_if_index, sw_if_index, 0);
778 event_by_sw_if_index[sw_if_index] |= event_type;
780 vec_reset_length (event_data);
783 for (i = 0; i < vec_len (event_by_sw_if_index); i++)
785 if (event_by_sw_if_index[i] == 0)
789 pool_foreach(reg, vam->interface_events_registrations,
791 vl_reg = vl_api_client_index_to_registration (reg->client_index);
793 send_sw_interface_event (vam, reg, vl_reg, i, event_by_sw_if_index[i]);
797 vec_reset_length (event_by_sw_if_index);
803 static clib_error_t *link_up_down_function (vnet_main_t * vm, u32 hw_if_index,
805 static clib_error_t *admin_up_down_function (vnet_main_t * vm,
806 u32 hw_if_index, u32 flags);
807 static clib_error_t *sw_interface_add_del_function (vnet_main_t * vm,
812 VLIB_REGISTER_NODE (link_state_process_node,static) = {
813 .function = link_state_process,
814 .type = VLIB_NODE_TYPE_PROCESS,
815 .name = "vpe-link-state-process",
819 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (admin_up_down_function);
820 VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION (link_up_down_function);
821 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (sw_interface_add_del_function);
823 static clib_error_t *
824 link_up_down_function (vnet_main_t * vm, u32 hw_if_index, u32 flags)
826 vpe_api_main_t *vam = &vpe_api_main;
827 vnet_hw_interface_t *hi = vnet_get_hw_interface (vm, hw_if_index);
829 if (vam->link_state_process_up)
831 enum api_events event =
832 flags ? API_LINK_STATE_UP_EVENT : API_LINK_STATE_DOWN_EVENT;
833 vlib_process_signal_event (vam->vlib_main,
834 link_state_process_node.index, event,
840 static clib_error_t *
841 admin_up_down_function (vnet_main_t * vm, u32 sw_if_index, u32 flags)
843 vpe_api_main_t *vam = &vpe_api_main;
846 * Note: it's perfectly fair to set a subif admin up / admin down.
847 * Note the subtle distinction between this routine and the previous
850 if (vam->link_state_process_up)
852 enum api_events event =
853 flags ? API_ADMIN_UP_EVENT : API_ADMIN_DOWN_EVENT;
854 vlib_process_signal_event (vam->vlib_main,
855 link_state_process_node.index, event,
861 static clib_error_t *
862 sw_interface_add_del_function (vnet_main_t * vm, u32 sw_if_index, u32 flags)
864 vpe_api_main_t *vam = &vpe_api_main;
866 if (vam->link_state_process_up)
868 enum api_events event =
869 flags ? API_SW_INTERFACE_ADD_EVENT : API_SW_INTERFACE_DEL_EVENT;
870 vlib_process_signal_event (vam->vlib_main,
871 link_state_process_node.index, event,
877 static void vl_api_sw_interface_tag_add_del_t_handler
878 (vl_api_sw_interface_tag_add_del_t * mp)
880 vnet_main_t *vnm = vnet_get_main ();
881 vl_api_sw_interface_tag_add_del_reply_t *rmp;
884 u32 sw_if_index = ntohl (mp->sw_if_index);
886 VALIDATE_SW_IF_INDEX (mp);
892 rv = VNET_API_ERROR_INVALID_VALUE;
896 mp->tag[ARRAY_LEN (mp->tag) - 1] = 0;
897 tag = format (0, "%s%c", mp->tag, 0);
898 vnet_set_sw_interface_tag (vnm, tag, sw_if_index);
901 vnet_clear_sw_interface_tag (vnm, sw_if_index);
903 BAD_SW_IF_INDEX_LABEL;
905 REPLY_MACRO (VL_API_SW_INTERFACE_TAG_ADD_DEL_REPLY);
908 static void vl_api_sw_interface_set_mac_address_t_handler
909 (vl_api_sw_interface_set_mac_address_t * mp)
911 vl_api_sw_interface_set_mac_address_reply_t *rmp;
912 vnet_main_t *vnm = vnet_get_main ();
913 u32 sw_if_index = ntohl (mp->sw_if_index);
914 vnet_sw_interface_t *si;
918 VALIDATE_SW_IF_INDEX (mp);
920 si = vnet_get_sw_interface (vnm, sw_if_index);
921 error = vnet_hw_interface_change_mac_address (vnm, si->hw_if_index,
925 rv = VNET_API_ERROR_UNIMPLEMENTED;
926 clib_error_report (error);
930 BAD_SW_IF_INDEX_LABEL;
932 REPLY_MACRO (VL_API_SW_INTERFACE_SET_MAC_ADDRESS_REPLY);
935 static void vl_api_sw_interface_get_mac_address_t_handler
936 (vl_api_sw_interface_get_mac_address_t * mp)
938 vl_api_sw_interface_get_mac_address_reply_t *rmp;
939 vl_api_registration_t *reg;
940 vnet_main_t *vnm = vnet_get_main ();
941 u32 sw_if_index = ntohl (mp->sw_if_index);
942 vnet_sw_interface_t *si;
943 ethernet_interface_t *eth_if = 0;
946 VALIDATE_SW_IF_INDEX (mp);
948 si = vnet_get_sup_sw_interface (vnm, sw_if_index);
949 if (si->type == VNET_SW_INTERFACE_TYPE_HARDWARE)
950 eth_if = ethernet_get_interface (ðernet_main, si->hw_if_index);
952 BAD_SW_IF_INDEX_LABEL;
954 reg = vl_api_client_index_to_registration (mp->client_index);
957 rmp = vl_msg_api_alloc (sizeof (*rmp));
958 rmp->_vl_msg_id = htons (VL_API_SW_INTERFACE_GET_MAC_ADDRESS_REPLY);
959 rmp->context = mp->context;
960 rmp->retval = htonl (rv);
962 memcpy (rmp->mac_address, eth_if->address, 6);
963 vl_api_send_msg (reg, (u8 *) rmp);
966 static void vl_api_sw_interface_set_rx_mode_t_handler
967 (vl_api_sw_interface_set_rx_mode_t * mp)
969 vl_api_sw_interface_set_rx_mode_reply_t *rmp;
970 vnet_main_t *vnm = vnet_get_main ();
971 u32 sw_if_index = ntohl (mp->sw_if_index);
972 vnet_sw_interface_t *si;
976 VALIDATE_SW_IF_INDEX (mp);
978 si = vnet_get_sw_interface (vnm, sw_if_index);
979 if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
981 rv = VNET_API_ERROR_INVALID_VALUE;
982 goto bad_sw_if_index;
985 error = set_hw_interface_change_rx_mode (vnm, si->hw_if_index,
987 ntohl (mp->queue_id), mp->mode);
990 rv = VNET_API_ERROR_UNIMPLEMENTED;
991 clib_error_report (error);
995 BAD_SW_IF_INDEX_LABEL;
997 REPLY_MACRO (VL_API_SW_INTERFACE_SET_RX_MODE_REPLY);
1001 send_interface_rx_placement_details (vpe_api_main_t * am,
1002 vl_api_registration_t * rp,
1003 u32 sw_if_index, u32 worker_id,
1004 u32 queue_id, u8 mode, u32 context)
1006 vl_api_sw_interface_rx_placement_details_t *mp;
1007 mp = vl_msg_api_alloc (sizeof (*mp));
1008 clib_memset (mp, 0, sizeof (*mp));
1010 mp->_vl_msg_id = htons (VL_API_SW_INTERFACE_RX_PLACEMENT_DETAILS);
1011 mp->sw_if_index = htonl (sw_if_index);
1012 mp->queue_id = htonl (queue_id);
1013 mp->worker_id = htonl (worker_id);
1015 mp->context = context;
1017 vl_api_send_msg (rp, (u8 *) mp);
1020 static void vl_api_sw_interface_rx_placement_dump_t_handler
1021 (vl_api_sw_interface_rx_placement_dump_t * mp)
1023 vnet_main_t *vnm = vnet_get_main ();
1024 vpe_api_main_t *am = &vpe_api_main;
1025 u32 sw_if_index = ntohl (mp->sw_if_index);
1026 vl_api_registration_t *reg;
1028 reg = vl_api_client_index_to_registration (mp->client_index);
1032 if (sw_if_index == ~0)
1034 vnet_device_input_runtime_t *rt;
1035 vnet_device_and_queue_t *dq;
1036 vlib_node_t *pn = vlib_get_node_by_name (am->vlib_main,
1037 (u8 *) "device-input");
1042 foreach_vlib_main (({
1043 clib_bitmap_foreach (si, pn->sibling_bitmap,
1045 rt = vlib_node_get_runtime_data (this_vlib_main, si);
1046 vec_foreach (dq, rt->devices_and_queues)
1048 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm,
1050 send_interface_rx_placement_details (am, reg, hw->sw_if_index, index,
1051 dq->queue_id, dq->mode, mp->context);
1061 vnet_sw_interface_t *si;
1063 if (!vnet_sw_if_index_is_api_valid (sw_if_index))
1065 clib_warning ("sw_if_index %u does not exist", sw_if_index);
1066 goto bad_sw_if_index;
1069 si = vnet_get_sw_interface (vnm, sw_if_index);
1070 if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
1072 clib_warning ("interface type is not HARDWARE! P2P, PIPE and SUB"
1073 " interfaces are not supported");
1074 goto bad_sw_if_index;
1077 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, si->hw_if_index);
1079 for (i = 0; i < vec_len (hw->dq_runtime_index_by_queue); i++)
1081 send_interface_rx_placement_details (am, reg, hw->sw_if_index,
1082 hw->input_node_thread_index_by_queue
1084 hw->rx_mode_by_queue[i],
1089 BAD_SW_IF_INDEX_LABEL;
1092 static void vl_api_sw_interface_set_rx_placement_t_handler
1093 (vl_api_sw_interface_set_rx_placement_t * mp)
1095 vl_api_sw_interface_set_rx_placement_reply_t *rmp;
1096 vnet_main_t *vnm = vnet_get_main ();
1097 u32 sw_if_index = ntohl (mp->sw_if_index);
1098 vnet_sw_interface_t *si;
1099 clib_error_t *error = 0;
1102 VALIDATE_SW_IF_INDEX (mp);
1104 si = vnet_get_sw_interface (vnm, sw_if_index);
1105 if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
1107 rv = VNET_API_ERROR_INVALID_VALUE;
1108 goto bad_sw_if_index;
1111 error = set_hw_interface_rx_placement (si->hw_if_index,
1112 ntohl (mp->queue_id),
1113 ntohl (mp->worker_id), mp->is_main);
1116 rv = VNET_API_ERROR_UNIMPLEMENTED;
1117 clib_error_report (error);
1121 BAD_SW_IF_INDEX_LABEL;
1123 REPLY_MACRO (VL_API_SW_INTERFACE_SET_RX_PLACEMENT_REPLY);
1127 vl_api_create_vlan_subif_t_handler (vl_api_create_vlan_subif_t * mp)
1129 vl_api_create_vlan_subif_reply_t *rmp;
1130 vnet_main_t *vnm = vnet_get_main ();
1131 u32 sw_if_index = (u32) ~ 0;
1132 vnet_hw_interface_t *hi;
1135 vnet_sw_interface_t template;
1137 vnet_interface_main_t *im = &vnm->interface_main;
1138 u64 sup_and_sub_key;
1139 vl_api_registration_t *reg;
1140 clib_error_t *error;
1142 VALIDATE_SW_IF_INDEX (mp);
1144 hi = vnet_get_sup_hw_interface (vnm, ntohl (mp->sw_if_index));
1146 if (hi->bond_info == VNET_HW_INTERFACE_BOND_INFO_SLAVE)
1148 rv = VNET_API_ERROR_BOND_SLAVE_NOT_ALLOWED;
1152 id = ntohl (mp->vlan_id);
1153 if (id == 0 || id > 4095)
1155 rv = VNET_API_ERROR_INVALID_VLAN;
1159 sup_and_sub_key = ((u64) (hi->sw_if_index) << 32) | (u64) id;
1161 p = hash_get_mem (im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
1164 rv = VNET_API_ERROR_VLAN_ALREADY_EXISTS;
1168 clib_memset (&template, 0, sizeof (template));
1169 template.type = VNET_SW_INTERFACE_TYPE_SUB;
1170 template.flood_class = VNET_FLOOD_CLASS_NORMAL;
1171 template.sup_sw_if_index = hi->sw_if_index;
1172 template.sub.id = id;
1173 template.sub.eth.raw_flags = 0;
1174 template.sub.eth.flags.one_tag = 1;
1175 template.sub.eth.outer_vlan_id = id;
1176 template.sub.eth.flags.exact_match = 1;
1178 error = vnet_create_sw_interface (vnm, &template, &sw_if_index);
1181 clib_error_report (error);
1182 rv = VNET_API_ERROR_INVALID_REGISTRATION;
1186 u64 *kp = clib_mem_alloc (sizeof (*kp));
1187 *kp = sup_and_sub_key;
1189 hash_set (hi->sub_interface_sw_if_index_by_id, id, sw_if_index);
1190 hash_set_mem (im->sw_if_index_by_sup_and_sub, kp, sw_if_index);
1192 BAD_SW_IF_INDEX_LABEL;
1195 reg = vl_api_client_index_to_registration (mp->client_index);
1199 rmp = vl_msg_api_alloc (sizeof (*rmp));
1200 rmp->_vl_msg_id = htons (VL_API_CREATE_VLAN_SUBIF_REPLY);
1201 rmp->context = mp->context;
1202 rmp->retval = htonl (rv);
1203 rmp->sw_if_index = htonl (sw_if_index);
1204 vl_api_send_msg (reg, (u8 *) rmp);
1208 vl_api_create_subif_t_handler (vl_api_create_subif_t * mp)
1210 vl_api_create_subif_reply_t *rmp;
1211 vnet_main_t *vnm = vnet_get_main ();
1212 u32 sw_if_index = ~0;
1215 vnet_sw_interface_t *si;
1216 vnet_hw_interface_t *hi;
1217 vnet_sw_interface_t template;
1219 vnet_interface_main_t *im = &vnm->interface_main;
1220 u64 sup_and_sub_key;
1221 clib_error_t *error;
1223 VALIDATE_SW_IF_INDEX (mp);
1225 si = vnet_get_sup_sw_interface (vnm, ntohl (mp->sw_if_index));
1226 hi = vnet_get_sup_hw_interface (vnm, ntohl (mp->sw_if_index));
1228 if (hi->bond_info == VNET_HW_INTERFACE_BOND_INFO_SLAVE)
1230 rv = VNET_API_ERROR_BOND_SLAVE_NOT_ALLOWED;
1234 sw_if_index = si->sw_if_index;
1235 sub_id = ntohl (mp->sub_id);
1237 sup_and_sub_key = ((u64) (sw_if_index) << 32) | (u64) sub_id;
1239 p = hash_get_mem (im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
1243 clib_warning ("sup sw_if_index %d, sub id %d already exists\n",
1244 sw_if_index, sub_id);
1245 rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
1249 clib_memset (&template, 0, sizeof (template));
1250 template.type = VNET_SW_INTERFACE_TYPE_SUB;
1251 template.flood_class = VNET_FLOOD_CLASS_NORMAL;
1252 template.sup_sw_if_index = sw_if_index;
1253 template.sub.id = sub_id;
1254 template.sub.eth.flags.no_tags = mp->no_tags;
1255 template.sub.eth.flags.one_tag = mp->one_tag;
1256 template.sub.eth.flags.two_tags = mp->two_tags;
1257 template.sub.eth.flags.dot1ad = mp->dot1ad;
1258 template.sub.eth.flags.exact_match = mp->exact_match;
1259 template.sub.eth.flags.default_sub = mp->default_sub;
1260 template.sub.eth.flags.outer_vlan_id_any = mp->outer_vlan_id_any;
1261 template.sub.eth.flags.inner_vlan_id_any = mp->inner_vlan_id_any;
1262 template.sub.eth.outer_vlan_id = ntohs (mp->outer_vlan_id);
1263 template.sub.eth.inner_vlan_id = ntohs (mp->inner_vlan_id);
1265 error = vnet_create_sw_interface (vnm, &template, &sw_if_index);
1268 clib_error_report (error);
1269 rv = VNET_API_ERROR_SUBIF_CREATE_FAILED;
1273 u64 *kp = clib_mem_alloc (sizeof (*kp));
1274 *kp = sup_and_sub_key;
1276 hash_set (hi->sub_interface_sw_if_index_by_id, sub_id, sw_if_index);
1277 hash_set_mem (im->sw_if_index_by_sup_and_sub, kp, sw_if_index);
1279 BAD_SW_IF_INDEX_LABEL;
1284 REPLY_MACRO2(VL_API_CREATE_SUBIF_REPLY,
1286 rmp->sw_if_index = ntohl(sw_if_index);
1292 vl_api_delete_subif_t_handler (vl_api_delete_subif_t * mp)
1294 vl_api_delete_subif_reply_t *rmp;
1297 rv = vnet_delete_sub_interface (ntohl (mp->sw_if_index));
1299 REPLY_MACRO (VL_API_DELETE_SUBIF_REPLY);
1303 vl_api_interface_name_renumber_t_handler (vl_api_interface_name_renumber_t *
1306 vl_api_interface_name_renumber_reply_t *rmp;
1309 VALIDATE_SW_IF_INDEX (mp);
1311 rv = vnet_interface_name_renumber
1312 (ntohl (mp->sw_if_index), ntohl (mp->new_show_dev_instance));
1314 BAD_SW_IF_INDEX_LABEL;
1316 REPLY_MACRO (VL_API_INTERFACE_NAME_RENUMBER_REPLY);
1320 vl_api_create_loopback_t_handler (vl_api_create_loopback_t * mp)
1322 vl_api_create_loopback_reply_t *rmp;
1326 rv = vnet_create_loopback_interface (&sw_if_index, mp->mac_address, 0, 0);
1329 REPLY_MACRO2(VL_API_CREATE_LOOPBACK_REPLY,
1331 rmp->sw_if_index = ntohl (sw_if_index);
1336 static void vl_api_create_loopback_instance_t_handler
1337 (vl_api_create_loopback_instance_t * mp)
1339 vl_api_create_loopback_instance_reply_t *rmp;
1341 u8 is_specified = mp->is_specified;
1342 u32 user_instance = ntohl (mp->user_instance);
1345 rv = vnet_create_loopback_interface (&sw_if_index, mp->mac_address,
1346 is_specified, user_instance);
1349 REPLY_MACRO2(VL_API_CREATE_LOOPBACK_INSTANCE_REPLY,
1351 rmp->sw_if_index = ntohl (sw_if_index);
1357 vl_api_delete_loopback_t_handler (vl_api_delete_loopback_t * mp)
1359 vl_api_delete_loopback_reply_t *rmp;
1363 sw_if_index = ntohl (mp->sw_if_index);
1364 rv = vnet_delete_loopback_interface (sw_if_index);
1366 REPLY_MACRO (VL_API_DELETE_LOOPBACK_REPLY);
1370 vl_api_collect_detailed_interface_stats_t_handler
1371 (vl_api_collect_detailed_interface_stats_t * mp)
1373 vl_api_collect_detailed_interface_stats_reply_t *rmp;
1377 vnet_sw_interface_stats_collect_enable_disable (ntohl (mp->sw_if_index),
1378 mp->enable_disable);
1380 REPLY_MACRO (VL_API_COLLECT_DETAILED_INTERFACE_STATS_REPLY);
1385 * Add vpe's API message handlers to the table.
1386 * vlib has already mapped shared memory and
1387 * added the client registration handlers.
1388 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
1390 #define vl_msg_name_crc_list
1391 #include <vnet/interface.api.h>
1392 #undef vl_msg_name_crc_list
1395 setup_message_id_table (api_main_t * am)
1397 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
1398 foreach_vl_msg_name_crc_interface;
1402 pub_sub_handler (interface_events, INTERFACE_EVENTS);
1404 static clib_error_t *
1405 interface_api_hookup (vlib_main_t * vm)
1407 api_main_t *am = &api_main;
1410 vl_msg_api_set_handlers(VL_API_##N, #n, \
1411 vl_api_##n##_t_handler, \
1413 vl_api_##n##_t_endian, \
1414 vl_api_##n##_t_print, \
1415 sizeof(vl_api_##n##_t), 1);
1416 foreach_vpe_api_msg;
1420 * Set up the (msg_name, crc, message-id) table
1422 setup_message_id_table (am);
1427 VLIB_API_INIT_FUNCTION (interface_api_hookup);
1430 * fd.io coding-style-patch-verification: ON
1433 * eval: (c-set-style "gnu")