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 #include <vlibapi/api_types.h>
36 #include <vnet/ip/ip_types_api.h>
37 #include <vnet/ethernet/ethernet_types_api.h>
39 #define vl_typedefs /* define message structures */
40 #include <vnet/vnet_all_api_h.h>
43 #define vl_endianfun /* define message structures */
44 #include <vnet/vnet_all_api_h.h>
47 /* instantiate all the print functions we know about */
48 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
50 #include <vnet/vnet_all_api_h.h>
53 #include <vlibapi/api_helper_macros.h>
54 vpe_api_main_t vpe_api_main;
56 #define foreach_vpe_api_msg \
57 _(SW_INTERFACE_SET_FLAGS, sw_interface_set_flags) \
58 _(HW_INTERFACE_SET_MTU, hw_interface_set_mtu) \
59 _(SW_INTERFACE_SET_MTU, sw_interface_set_mtu) \
60 _(WANT_INTERFACE_EVENTS, want_interface_events) \
61 _(SW_INTERFACE_DUMP, sw_interface_dump) \
62 _(SW_INTERFACE_ADD_DEL_ADDRESS, sw_interface_add_del_address) \
63 _(SW_INTERFACE_SET_RX_MODE, sw_interface_set_rx_mode) \
64 _(SW_INTERFACE_RX_PLACEMENT_DUMP, sw_interface_rx_placement_dump) \
65 _(SW_INTERFACE_SET_RX_PLACEMENT, sw_interface_set_rx_placement) \
66 _(SW_INTERFACE_SET_TABLE, sw_interface_set_table) \
67 _(SW_INTERFACE_GET_TABLE, sw_interface_get_table) \
68 _(SW_INTERFACE_SET_UNNUMBERED, sw_interface_set_unnumbered) \
69 _(SW_INTERFACE_CLEAR_STATS, sw_interface_clear_stats) \
70 _(SW_INTERFACE_TAG_ADD_DEL, sw_interface_tag_add_del) \
71 _(SW_INTERFACE_ADD_DEL_MAC_ADDRESS, sw_interface_add_del_mac_address) \
72 _(SW_INTERFACE_SET_MAC_ADDRESS, sw_interface_set_mac_address) \
73 _(SW_INTERFACE_GET_MAC_ADDRESS, sw_interface_get_mac_address) \
74 _(CREATE_VLAN_SUBIF, create_vlan_subif) \
75 _(CREATE_SUBIF, create_subif) \
76 _(DELETE_SUBIF, delete_subif) \
77 _(CREATE_LOOPBACK, create_loopback) \
78 _(CREATE_LOOPBACK_INSTANCE, create_loopback_instance) \
79 _(DELETE_LOOPBACK, delete_loopback) \
80 _(INTERFACE_NAME_RENUMBER, interface_name_renumber) \
81 _(COLLECT_DETAILED_INTERFACE_STATS, collect_detailed_interface_stats) \
82 _(SW_INTERFACE_SET_IP_DIRECTED_BROADCAST, \
83 sw_interface_set_ip_directed_broadcast)
86 vl_api_sw_interface_set_flags_t_handler (vl_api_sw_interface_set_flags_t * mp)
88 vl_api_sw_interface_set_flags_reply_t *rmp;
89 vnet_main_t *vnm = vnet_get_main ();
94 VALIDATE_SW_IF_INDEX (mp);
97 ((ntohl (mp->flags)) & IF_STATUS_API_FLAG_ADMIN_UP) ?
98 VNET_SW_INTERFACE_FLAG_ADMIN_UP : 0;
100 error = vnet_sw_interface_set_flags (vnm, ntohl (mp->sw_if_index), flags);
104 clib_error_report (error);
107 BAD_SW_IF_INDEX_LABEL;
108 REPLY_MACRO (VL_API_SW_INTERFACE_SET_FLAGS_REPLY);
112 vl_api_hw_interface_set_mtu_t_handler (vl_api_hw_interface_set_mtu_t * mp)
114 vl_api_hw_interface_set_mtu_reply_t *rmp;
115 vnet_main_t *vnm = vnet_get_main ();
116 u32 sw_if_index = ntohl (mp->sw_if_index);
117 u16 mtu = ntohs (mp->mtu);
118 ethernet_main_t *em = ðernet_main;
121 VALIDATE_SW_IF_INDEX (mp);
123 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
124 if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
126 rv = VNET_API_ERROR_INVALID_VALUE;
127 goto bad_sw_if_index;
130 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, si->hw_if_index);
131 ethernet_interface_t *eif = ethernet_get_interface (em, si->hw_if_index);
135 rv = VNET_API_ERROR_FEATURE_DISABLED;
136 goto bad_sw_if_index;
139 if (mtu < hi->min_supported_packet_bytes)
141 rv = VNET_API_ERROR_INVALID_VALUE;
142 goto bad_sw_if_index;
145 if (mtu > hi->max_supported_packet_bytes)
147 rv = VNET_API_ERROR_INVALID_VALUE;
148 goto bad_sw_if_index;
151 vnet_hw_interface_set_mtu (vnm, si->hw_if_index, mtu);
153 BAD_SW_IF_INDEX_LABEL;
154 REPLY_MACRO (VL_API_HW_INTERFACE_SET_MTU_REPLY);
158 vl_api_sw_interface_set_mtu_t_handler (vl_api_sw_interface_set_mtu_t * mp)
160 vl_api_sw_interface_set_mtu_reply_t *rmp;
161 vnet_main_t *vnm = vnet_get_main ();
162 u32 sw_if_index = ntohl (mp->sw_if_index);
165 u32 per_protocol_mtu[VNET_N_MTU];
167 VALIDATE_SW_IF_INDEX (mp);
169 for (i = 0; i < VNET_N_MTU; i++)
171 per_protocol_mtu[i] = ntohl (mp->mtu[i]);
173 vnet_sw_interface_set_protocol_mtu (vnm, sw_if_index, per_protocol_mtu);
175 BAD_SW_IF_INDEX_LABEL;
176 REPLY_MACRO (VL_API_SW_INTERFACE_SET_MTU_REPLY);
180 vl_api_sw_interface_set_ip_directed_broadcast_t_handler
181 (vl_api_sw_interface_set_ip_directed_broadcast_t * mp)
183 vl_api_sw_interface_set_ip_directed_broadcast_reply_t *rmp;
184 u32 sw_if_index = ntohl (mp->sw_if_index);
187 VALIDATE_SW_IF_INDEX (mp);
189 vnet_sw_interface_ip_directed_broadcast (vnet_get_main (),
190 sw_if_index, mp->enable);
192 BAD_SW_IF_INDEX_LABEL;
193 REPLY_MACRO (VL_API_SW_INTERFACE_SET_IP_DIRECTED_BROADCAST_REPLY);
197 send_sw_interface_details (vpe_api_main_t * am,
198 vl_api_registration_t * rp,
199 vnet_sw_interface_t * swif,
200 u8 * interface_name, u32 context)
202 vnet_hw_interface_t *hi =
203 vnet_get_sup_hw_interface (am->vnet_main, swif->sw_if_index);
204 vnet_device_class_t *dev_class =
205 vnet_get_device_class (am->vnet_main, hi->dev_class_index);
207 vl_api_sw_interface_details_t *mp = vl_msg_api_alloc (sizeof (*mp));
208 clib_memset (mp, 0, sizeof (*mp));
209 mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_DETAILS);
210 mp->sw_if_index = ntohl (swif->sw_if_index);
211 mp->sup_sw_if_index = ntohl (swif->sup_sw_if_index);
213 mp->flags |= (swif->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
214 IF_STATUS_API_FLAG_ADMIN_UP : 0;
215 mp->flags |= (hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP) ?
216 IF_STATUS_API_FLAG_LINK_UP : 0;
217 mp->flags = ntohl (mp->flags);
221 case VNET_SW_INTERFACE_TYPE_SUB:
222 mp->type = IF_API_TYPE_SUB;
224 case VNET_SW_INTERFACE_TYPE_P2P:
225 mp->type = IF_API_TYPE_P2P;
227 case VNET_SW_INTERFACE_TYPE_PIPE:
228 mp->type = IF_API_TYPE_PIPE;
231 mp->type = IF_API_TYPE_HARDWARE;
233 mp->type = ntohl (mp->type);
235 mp->link_duplex = ((hi->flags & VNET_HW_INTERFACE_FLAG_DUPLEX_MASK) >>
236 VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT);
237 mp->link_speed = ntohl (hi->link_speed);
238 mp->link_mtu = ntohs (hi->max_packet_bytes);
239 mp->mtu[VNET_MTU_L3] = ntohl (swif->mtu[VNET_MTU_L3]);
240 mp->mtu[VNET_MTU_IP4] = ntohl (swif->mtu[VNET_MTU_IP4]);
241 mp->mtu[VNET_MTU_IP6] = ntohl (swif->mtu[VNET_MTU_IP6]);
242 mp->mtu[VNET_MTU_MPLS] = ntohl (swif->mtu[VNET_MTU_MPLS]);
244 mp->context = context;
246 strncpy ((char *) mp->interface_name,
247 (char *) interface_name, ARRAY_LEN (mp->interface_name) - 1);
249 if (dev_class && dev_class->name)
250 strncpy ((char *) mp->interface_dev_type, (char *) dev_class->name,
251 ARRAY_LEN (mp->interface_dev_type) - 1);
253 /* Send the L2 address for ethernet physical intfcs */
254 if (swif->sup_sw_if_index == swif->sw_if_index
255 && hi->hw_class_index == ethernet_hw_interface_class.index)
257 ethernet_main_t *em = ethernet_get_main (am->vlib_main);
258 ethernet_interface_t *ei;
260 ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
261 ASSERT (sizeof (mp->l2_address) >= sizeof (ei->address));
262 mac_address_encode ((mac_address_t *) ei->address, mp->l2_address);
264 else if (swif->sup_sw_if_index != swif->sw_if_index)
266 vnet_sub_interface_t *sub = &swif->sub;
267 mp->sub_id = ntohl (sub->id);
268 mp->sub_number_of_tags =
269 sub->eth.flags.one_tag + sub->eth.flags.two_tags * 2;
270 mp->sub_outer_vlan_id = ntohs (sub->eth.outer_vlan_id);
271 mp->sub_inner_vlan_id = ntohs (sub->eth.inner_vlan_id);
273 ntohl (sub->eth.raw_flags & SUB_IF_API_FLAG_MASK_VNET);
276 /* vlan tag rewrite data */
277 u32 vtr_op = L2_VTR_DISABLED;
278 u32 vtr_push_dot1q = 0, vtr_tag1 = 0, vtr_tag2 = 0;
280 if (l2vtr_get (am->vlib_main, am->vnet_main, swif->sw_if_index,
281 &vtr_op, &vtr_push_dot1q, &vtr_tag1, &vtr_tag2) != 0)
283 // error - default to disabled
284 mp->vtr_op = ntohl (L2_VTR_DISABLED);
285 clib_warning ("cannot get vlan tag rewrite for sw_if_index %d",
290 mp->vtr_op = ntohl (vtr_op);
291 mp->vtr_push_dot1q = ntohl (vtr_push_dot1q);
292 mp->vtr_tag1 = ntohl (vtr_tag1);
293 mp->vtr_tag2 = ntohl (vtr_tag2);
296 /* pbb tag rewrite data */
297 ethernet_header_t eth_hdr;
298 u32 pbb_vtr_op = L2_VTR_DISABLED;
302 clib_memset (ð_hdr, 0, sizeof (eth_hdr));
304 if (!l2pbb_get (am->vlib_main, am->vnet_main, swif->sw_if_index,
305 &pbb_vtr_op, &outer_tag, ð_hdr, &b_vlanid, &i_sid))
307 mp->sub_if_flags |= ntohl (SUB_IF_API_FLAG_DOT1AH);
308 mac_address_encode ((mac_address_t *) eth_hdr.dst_address, mp->b_dmac);
309 mac_address_encode ((mac_address_t *) eth_hdr.src_address, mp->b_smac);
310 mp->b_vlanid = b_vlanid;
314 u8 *tag = vnet_get_sw_interface_tag (vnet_get_main (), swif->sw_if_index);
316 strncpy ((char *) mp->tag, (char *) tag, ARRAY_LEN (mp->tag) - 1);
318 vl_api_send_msg (rp, (u8 *) mp);
322 vl_api_sw_interface_dump_t_handler (vl_api_sw_interface_dump_t * mp)
324 vpe_api_main_t *am = &vpe_api_main;
325 vnet_sw_interface_t *swif;
326 vnet_interface_main_t *im = &am->vnet_main->interface_main;
327 vl_api_registration_t *rp;
330 rp = vl_api_client_index_to_registration (mp->client_index);
334 clib_warning ("Client %d AWOL", mp->client_index);
338 u8 *filter = 0, *name = 0;
339 sw_if_index = ntohl (mp->sw_if_index);
341 if (!mp->name_filter_valid && sw_if_index != ~0 && sw_if_index != 0)
343 /* is it a valid sw_if_index? */
344 if (!vnet_sw_if_index_is_api_valid (sw_if_index))
347 swif = vec_elt_at_index (im->sw_interfaces, sw_if_index);
349 vec_reset_length (name);
351 format (name, "%U%c", format_vnet_sw_interface_name, am->vnet_main,
353 send_sw_interface_details (am, rp, swif, name, mp->context);
358 if (mp->name_filter_valid)
360 filter = vl_api_from_api_to_new_vec (&mp->name_filter);
361 vec_add1 (filter, 0); /* Ensure it's a C string for strcasecmp() */
364 char *strcasestr (char *, char *); /* lnx hdr file botch */
366 pool_foreach (swif, im->sw_interfaces,
368 if (!vnet_swif_is_api_visible (swif))
370 vec_reset_length(name);
371 name = format (name, "%U%c", format_vnet_sw_interface_name, am->vnet_main,
374 if (filter && !strcasestr((char *) name, (char *) filter))
377 send_sw_interface_details (am, rp, swif, name, mp->context);
386 vl_api_sw_interface_add_del_address_t_handler
387 (vl_api_sw_interface_add_del_address_t * mp)
389 vlib_main_t *vm = vlib_get_main ();
390 vnet_main_t *vnm = vnet_get_main ();
391 vl_api_sw_interface_add_del_address_reply_t *rmp;
394 clib_error_t *error = 0;
395 ip46_address_t address;
397 VALIDATE_SW_IF_INDEX (mp);
399 is_del = mp->is_add == 0;
403 ip_del_all_interface_addresses (vm, ntohl (mp->sw_if_index));
404 else if (ip_address_decode (&mp->prefix.address, &address) == IP46_TYPE_IP6)
405 error = ip6_add_del_interface_address (vm, ntohl (mp->sw_if_index),
406 (void *) &address.ip6,
407 mp->prefix.len, is_del);
409 error = ip4_add_del_interface_address (vm, ntohl (mp->sw_if_index),
410 (void *) &address.ip4,
411 mp->prefix.len, is_del);
416 clib_error_report (error);
420 BAD_SW_IF_INDEX_LABEL;
423 REPLY_MACRO (VL_API_SW_INTERFACE_ADD_DEL_ADDRESS_REPLY);
427 vl_api_sw_interface_set_table_t_handler (vl_api_sw_interface_set_table_t * mp)
429 vl_api_sw_interface_set_table_reply_t *rmp;
430 u32 sw_if_index = ntohl (mp->sw_if_index);
431 u32 table_id = ntohl (mp->vrf_id);
434 VALIDATE_SW_IF_INDEX (mp);
437 rv = ip_table_bind (FIB_PROTOCOL_IP6, sw_if_index, table_id, 1);
439 rv = ip_table_bind (FIB_PROTOCOL_IP4, sw_if_index, table_id, 1);
441 BAD_SW_IF_INDEX_LABEL;
443 REPLY_MACRO (VL_API_SW_INTERFACE_SET_TABLE_REPLY);
447 ip_table_bind (fib_protocol_t fproto,
448 u32 sw_if_index, u32 table_id, u8 is_api)
450 CLIB_UNUSED (ip_interface_address_t * ia);
451 u32 fib_index, mfib_index;
457 src = FIB_SOURCE_API;
458 msrc = MFIB_SOURCE_API;
462 src = FIB_SOURCE_CLI;
463 msrc = MFIB_SOURCE_CLI;
467 * This if table does not exist = error is what we want in the end.
469 fib_index = fib_table_find (fproto, table_id);
470 mfib_index = mfib_table_find (fproto, table_id);
472 if (~0 == fib_index || ~0 == mfib_index)
474 return (VNET_API_ERROR_NO_SUCH_FIB);
477 if (FIB_PROTOCOL_IP6 == fproto)
480 * If the interface already has in IP address, then a change int
481 * VRF is not allowed. The IP address applied must first be removed.
482 * We do not do that automatically here, since VPP has no knowledge
483 * of whether those subnets are valid in the destination VRF.
486 foreach_ip_interface_address (&ip6_main.lookup_main,
488 1 /* honor unnumbered */ ,
490 return (VNET_API_ERROR_ADDRESS_FOUND_FOR_INTERFACE);
494 vec_validate (ip6_main.fib_index_by_sw_if_index, sw_if_index);
495 vec_validate (ip6_main.mfib_index_by_sw_if_index, sw_if_index);
498 * tell those that are interested that the binding is changing.
500 ip6_table_bind_callback_t *cb;
501 vec_foreach (cb, ip6_main.table_bind_callbacks)
502 cb->function (&ip6_main, cb->function_opaque,
505 ip6_main.fib_index_by_sw_if_index[sw_if_index]);
509 /* reset back to default */
510 if (0 != ip6_main.fib_index_by_sw_if_index[sw_if_index])
511 fib_table_unlock (ip6_main.fib_index_by_sw_if_index[sw_if_index],
512 FIB_PROTOCOL_IP6, src);
513 if (0 != ip6_main.mfib_index_by_sw_if_index[sw_if_index])
514 mfib_table_unlock (ip6_main.mfib_index_by_sw_if_index
515 [sw_if_index], FIB_PROTOCOL_IP6, msrc);
520 /* we need to lock the table now it's inuse */
521 fib_table_lock (fib_index, FIB_PROTOCOL_IP6, src);
522 mfib_table_lock (mfib_index, FIB_PROTOCOL_IP6, msrc);
525 ip6_main.fib_index_by_sw_if_index[sw_if_index] = fib_index;
526 ip6_main.mfib_index_by_sw_if_index[sw_if_index] = mfib_index;
531 * If the interface already has in IP address, then a change int
532 * VRF is not allowed. The IP address applied must first be removed.
533 * We do not do that automatically here, since VPP has no knowledge
534 * of whether those subnets are valid in the destination VRF.
537 foreach_ip_interface_address (&ip4_main.lookup_main,
539 1 /* honor unnumbered */ ,
541 return (VNET_API_ERROR_ADDRESS_FOUND_FOR_INTERFACE);
545 vec_validate (ip4_main.fib_index_by_sw_if_index, sw_if_index);
546 vec_validate (ip4_main.mfib_index_by_sw_if_index, sw_if_index);
549 * tell those that are interested that the binding is changing.
551 ip4_table_bind_callback_t *cb;
552 vec_foreach (cb, ip4_main.table_bind_callbacks)
553 cb->function (&ip4_main, cb->function_opaque,
556 ip4_main.fib_index_by_sw_if_index[sw_if_index]);
560 /* reset back to default */
561 if (0 != ip4_main.fib_index_by_sw_if_index[sw_if_index])
562 fib_table_unlock (ip4_main.fib_index_by_sw_if_index[sw_if_index],
563 FIB_PROTOCOL_IP4, src);
564 if (0 != ip4_main.mfib_index_by_sw_if_index[sw_if_index])
565 mfib_table_unlock (ip4_main.mfib_index_by_sw_if_index
566 [sw_if_index], FIB_PROTOCOL_IP4, msrc);
571 /* we need to lock the table now it's inuse */
572 fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
575 mfib_index = mfib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
579 ip4_main.fib_index_by_sw_if_index[sw_if_index] = fib_index;
580 ip4_main.mfib_index_by_sw_if_index[sw_if_index] = mfib_index;
587 send_sw_interface_get_table_reply (vl_api_registration_t * reg,
588 u32 context, int retval, u32 vrf_id)
590 vl_api_sw_interface_get_table_reply_t *mp;
592 mp = vl_msg_api_alloc (sizeof (*mp));
593 clib_memset (mp, 0, sizeof (*mp));
594 mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_GET_TABLE_REPLY);
595 mp->context = context;
596 mp->retval = htonl (retval);
597 mp->vrf_id = htonl (vrf_id);
599 vl_api_send_msg (reg, (u8 *) mp);
603 vl_api_sw_interface_get_table_t_handler (vl_api_sw_interface_get_table_t * mp)
605 vl_api_registration_t *reg;
606 fib_table_t *fib_table = 0;
607 u32 sw_if_index = ~0;
610 fib_protocol_t fib_proto = FIB_PROTOCOL_IP4;
613 reg = vl_api_client_index_to_registration (mp->client_index);
617 VALIDATE_SW_IF_INDEX (mp);
619 sw_if_index = ntohl (mp->sw_if_index);
622 fib_proto = FIB_PROTOCOL_IP6;
624 fib_index = fib_table_get_index_for_sw_if_index (fib_proto, sw_if_index);
627 fib_table = fib_table_get (fib_index, fib_proto);
628 table_id = fib_table->ft_table_id;
631 BAD_SW_IF_INDEX_LABEL;
633 send_sw_interface_get_table_reply (reg, mp->context, rv, table_id);
636 static void vl_api_sw_interface_set_unnumbered_t_handler
637 (vl_api_sw_interface_set_unnumbered_t * mp)
639 vl_api_sw_interface_set_unnumbered_reply_t *rmp;
641 vnet_main_t *vnm = vnet_get_main ();
642 u32 sw_if_index = ntohl (mp->sw_if_index);
643 u32 unnumbered_sw_if_index = ntohl (mp->unnumbered_sw_if_index);
646 * The API message field names are backwards from
647 * the underlying data structure names.
648 * It's not worth changing them now.
650 if (!vnet_sw_interface_is_api_valid (vnm, unnumbered_sw_if_index))
652 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
656 /* Only check the "use loop0" field when setting the binding */
657 if (mp->is_add && !vnet_sw_interface_is_api_valid (vnm, sw_if_index))
659 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX_2;
663 vnet_sw_interface_update_unnumbered (unnumbered_sw_if_index,
664 sw_if_index, mp->is_add);
666 REPLY_MACRO (VL_API_SW_INTERFACE_SET_UNNUMBERED_REPLY);
670 vl_api_sw_interface_clear_stats_t_handler (vl_api_sw_interface_clear_stats_t *
673 vl_api_sw_interface_clear_stats_reply_t *rmp;
675 vnet_main_t *vnm = vnet_get_main ();
676 vnet_interface_main_t *im = &vnm->interface_main;
677 vlib_simple_counter_main_t *sm;
678 vlib_combined_counter_main_t *cm;
682 if (mp->sw_if_index != ~0)
683 VALIDATE_SW_IF_INDEX (mp);
685 n_counters = vec_len (im->combined_sw_if_counters);
687 for (j = 0; j < n_counters; j++)
689 im = &vnm->interface_main;
690 cm = im->combined_sw_if_counters + j;
691 if (mp->sw_if_index == (u32) ~ 0)
692 vlib_clear_combined_counters (cm);
694 vlib_zero_combined_counter (cm, ntohl (mp->sw_if_index));
697 n_counters = vec_len (im->sw_if_counters);
699 for (j = 0; j < n_counters; j++)
701 im = &vnm->interface_main;
702 sm = im->sw_if_counters + j;
703 if (mp->sw_if_index == (u32) ~ 0)
704 vlib_clear_simple_counters (sm);
706 vlib_zero_simple_counter (sm, ntohl (mp->sw_if_index));
709 BAD_SW_IF_INDEX_LABEL;
711 REPLY_MACRO (VL_API_SW_INTERFACE_CLEAR_STATS_REPLY);
715 * Events used for sw_interface_events
719 API_LINK_STATE_UP_EVENT = 1 << 1,
720 API_LINK_STATE_DOWN_EVENT = 1 << 2,
721 API_ADMIN_UP_EVENT = 1 << 3,
722 API_ADMIN_DOWN_EVENT = 1 << 4,
723 API_SW_INTERFACE_ADD_EVENT = 1 << 5,
724 API_SW_INTERFACE_DEL_EVENT = 1 << 6,
728 send_sw_interface_event (vpe_api_main_t * am,
729 vpe_client_registration_t * reg,
730 vl_api_registration_t * vl_reg,
731 u32 sw_if_index, enum api_events events)
733 vl_api_sw_interface_event_t *mp;
735 mp = vl_msg_api_alloc (sizeof (*mp));
736 clib_memset (mp, 0, sizeof (*mp));
737 mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_EVENT);
738 mp->sw_if_index = ntohl (sw_if_index);
739 mp->client_index = reg->client_index;
740 mp->pid = reg->client_pid;
742 mp->flags |= (events & API_ADMIN_UP_EVENT) ?
743 IF_STATUS_API_FLAG_ADMIN_UP : 0;
744 mp->flags |= (events & API_LINK_STATE_UP_EVENT) ?
745 IF_STATUS_API_FLAG_LINK_UP : 0;
746 mp->flags = ntohl (mp->flags);
747 mp->deleted = events & API_SW_INTERFACE_DEL_EVENT ? true : false;
748 vl_api_send_msg (vl_reg, (u8 *) mp);
752 link_state_process (vlib_main_t * vm,
753 vlib_node_runtime_t * rt, vlib_frame_t * f)
755 vpe_api_main_t *vam = &vpe_api_main;
756 uword *event_by_sw_if_index = 0;
757 vpe_client_registration_t *reg;
759 vl_api_registration_t *vl_reg;
761 uword *event_data = 0;
764 vam->link_state_process_up = 1;
768 vlib_process_wait_for_event (vm);
770 /* Batch up events */
771 while ((event_type = vlib_process_get_events (vm, &event_data)) != ~0)
773 for (i = 0; i < vec_len (event_data); i++)
775 sw_if_index = event_data[i];
776 vec_validate_init_empty (event_by_sw_if_index, sw_if_index, 0);
777 event_by_sw_if_index[sw_if_index] |= event_type;
779 vec_reset_length (event_data);
782 for (i = 0; i < vec_len (event_by_sw_if_index); i++)
784 if (event_by_sw_if_index[i] == 0)
788 pool_foreach(reg, vam->interface_events_registrations,
790 vl_reg = vl_api_client_index_to_registration (reg->client_index);
792 send_sw_interface_event (vam, reg, vl_reg, i, event_by_sw_if_index[i]);
796 vec_reset_length (event_by_sw_if_index);
802 static clib_error_t *link_up_down_function (vnet_main_t * vm, u32 hw_if_index,
804 static clib_error_t *admin_up_down_function (vnet_main_t * vm,
805 u32 hw_if_index, u32 flags);
806 static clib_error_t *sw_interface_add_del_function (vnet_main_t * vm,
811 VLIB_REGISTER_NODE (link_state_process_node,static) = {
812 .function = link_state_process,
813 .type = VLIB_NODE_TYPE_PROCESS,
814 .name = "vpe-link-state-process",
818 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (admin_up_down_function);
819 VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION (link_up_down_function);
820 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (sw_interface_add_del_function);
822 static clib_error_t *
823 link_up_down_function (vnet_main_t * vm, u32 hw_if_index, u32 flags)
825 vpe_api_main_t *vam = &vpe_api_main;
826 vnet_hw_interface_t *hi = vnet_get_hw_interface (vm, hw_if_index);
828 if (vam->link_state_process_up)
830 enum api_events event = ((flags & VNET_HW_INTERFACE_FLAG_LINK_UP) ?
831 API_LINK_STATE_UP_EVENT :
832 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 = ((flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
853 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_add_del_mac_address_t_handler
909 (vl_api_sw_interface_add_del_mac_address_t * mp)
911 vl_api_sw_interface_add_del_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_hw_interface_t *hi;
918 VALIDATE_SW_IF_INDEX (mp);
920 /* for subifs, the MAC should be changed on the actual hw if */
921 hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
922 error = vnet_hw_interface_add_del_mac_address (vnm, hi->hw_if_index,
923 mp->addr, mp->is_add);
926 rv = VNET_API_ERROR_UNIMPLEMENTED;
927 clib_error_report (error);
931 BAD_SW_IF_INDEX_LABEL;
933 REPLY_MACRO (VL_API_SW_INTERFACE_ADD_DEL_MAC_ADDRESS_REPLY);
936 static void vl_api_sw_interface_set_mac_address_t_handler
937 (vl_api_sw_interface_set_mac_address_t * mp)
939 vl_api_sw_interface_set_mac_address_reply_t *rmp;
940 vnet_main_t *vnm = vnet_get_main ();
941 u32 sw_if_index = ntohl (mp->sw_if_index);
942 vnet_sw_interface_t *si;
947 VALIDATE_SW_IF_INDEX (mp);
949 si = vnet_get_sw_interface (vnm, sw_if_index);
950 mac_address_decode (mp->mac_address, &mac);
952 vnet_hw_interface_change_mac_address (vnm, si->hw_if_index, (u8 *) & mac);
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_MAC_ADDRESS_REPLY);
965 static void vl_api_sw_interface_get_mac_address_t_handler
966 (vl_api_sw_interface_get_mac_address_t * mp)
968 vl_api_sw_interface_get_mac_address_reply_t *rmp;
969 vl_api_registration_t *reg;
970 vnet_main_t *vnm = vnet_get_main ();
971 u32 sw_if_index = ntohl (mp->sw_if_index);
972 vnet_sw_interface_t *si;
973 ethernet_interface_t *eth_if = 0;
976 VALIDATE_SW_IF_INDEX (mp);
978 si = vnet_get_sup_sw_interface (vnm, sw_if_index);
979 if (si->type == VNET_SW_INTERFACE_TYPE_HARDWARE)
980 eth_if = ethernet_get_interface (ðernet_main, si->hw_if_index);
982 BAD_SW_IF_INDEX_LABEL;
984 reg = vl_api_client_index_to_registration (mp->client_index);
987 rmp = vl_msg_api_alloc (sizeof (*rmp));
988 rmp->_vl_msg_id = htons (VL_API_SW_INTERFACE_GET_MAC_ADDRESS_REPLY);
989 rmp->context = mp->context;
990 rmp->retval = htonl (rv);
992 mac_address_encode ((mac_address_t *) eth_if->address, rmp->mac_address);
993 vl_api_send_msg (reg, (u8 *) rmp);
996 static void vl_api_sw_interface_set_rx_mode_t_handler
997 (vl_api_sw_interface_set_rx_mode_t * mp)
999 vl_api_sw_interface_set_rx_mode_reply_t *rmp;
1000 vnet_main_t *vnm = vnet_get_main ();
1001 u32 sw_if_index = ntohl (mp->sw_if_index);
1002 vnet_sw_interface_t *si;
1003 clib_error_t *error;
1006 VALIDATE_SW_IF_INDEX (mp);
1008 si = vnet_get_sw_interface (vnm, sw_if_index);
1009 if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
1011 rv = VNET_API_ERROR_INVALID_VALUE;
1012 goto bad_sw_if_index;
1015 error = set_hw_interface_change_rx_mode (vnm, si->hw_if_index,
1017 ntohl (mp->queue_id),
1018 (vnet_hw_interface_rx_mode)
1023 rv = VNET_API_ERROR_UNIMPLEMENTED;
1024 clib_error_report (error);
1028 BAD_SW_IF_INDEX_LABEL;
1030 REPLY_MACRO (VL_API_SW_INTERFACE_SET_RX_MODE_REPLY);
1034 send_interface_rx_placement_details (vpe_api_main_t * am,
1035 vl_api_registration_t * rp,
1036 u32 sw_if_index, u32 worker_id,
1037 u32 queue_id, u8 mode, u32 context)
1039 vl_api_sw_interface_rx_placement_details_t *mp;
1040 mp = vl_msg_api_alloc (sizeof (*mp));
1041 clib_memset (mp, 0, sizeof (*mp));
1043 mp->_vl_msg_id = htons (VL_API_SW_INTERFACE_RX_PLACEMENT_DETAILS);
1044 mp->sw_if_index = htonl (sw_if_index);
1045 mp->queue_id = htonl (queue_id);
1046 mp->worker_id = htonl (worker_id);
1048 mp->context = context;
1050 vl_api_send_msg (rp, (u8 *) mp);
1053 static void vl_api_sw_interface_rx_placement_dump_t_handler
1054 (vl_api_sw_interface_rx_placement_dump_t * mp)
1056 vnet_main_t *vnm = vnet_get_main ();
1057 vpe_api_main_t *am = &vpe_api_main;
1058 u32 sw_if_index = ntohl (mp->sw_if_index);
1059 vl_api_registration_t *reg;
1061 reg = vl_api_client_index_to_registration (mp->client_index);
1065 if (sw_if_index == ~0)
1067 vnet_device_input_runtime_t *rt;
1068 vnet_device_and_queue_t *dq;
1069 vlib_node_t *pn = vlib_get_node_by_name (am->vlib_main,
1070 (u8 *) "device-input");
1075 foreach_vlib_main (({
1076 clib_bitmap_foreach (si, pn->sibling_bitmap,
1078 rt = vlib_node_get_runtime_data (this_vlib_main, si);
1079 vec_foreach (dq, rt->devices_and_queues)
1081 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm,
1083 send_interface_rx_placement_details (am, reg, hw->sw_if_index, index,
1084 dq->queue_id, dq->mode, mp->context);
1094 vnet_sw_interface_t *si;
1096 if (!vnet_sw_if_index_is_api_valid (sw_if_index))
1098 clib_warning ("sw_if_index %u does not exist", sw_if_index);
1099 goto bad_sw_if_index;
1102 si = vnet_get_sw_interface (vnm, sw_if_index);
1103 if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
1105 clib_warning ("interface type is not HARDWARE! P2P, PIPE and SUB"
1106 " interfaces are not supported");
1107 goto bad_sw_if_index;
1110 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, si->hw_if_index);
1112 for (i = 0; i < vec_len (hw->dq_runtime_index_by_queue); i++)
1114 send_interface_rx_placement_details (am, reg, hw->sw_if_index,
1115 hw->input_node_thread_index_by_queue
1117 hw->rx_mode_by_queue[i],
1122 BAD_SW_IF_INDEX_LABEL;
1125 static void vl_api_sw_interface_set_rx_placement_t_handler
1126 (vl_api_sw_interface_set_rx_placement_t * mp)
1128 vl_api_sw_interface_set_rx_placement_reply_t *rmp;
1129 vnet_main_t *vnm = vnet_get_main ();
1130 u32 sw_if_index = ntohl (mp->sw_if_index);
1131 vnet_sw_interface_t *si;
1132 clib_error_t *error = 0;
1135 VALIDATE_SW_IF_INDEX (mp);
1137 si = vnet_get_sw_interface (vnm, sw_if_index);
1138 if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
1140 rv = VNET_API_ERROR_INVALID_VALUE;
1141 goto bad_sw_if_index;
1144 error = set_hw_interface_rx_placement (si->hw_if_index,
1145 ntohl (mp->queue_id),
1146 ntohl (mp->worker_id), mp->is_main);
1149 rv = VNET_API_ERROR_UNIMPLEMENTED;
1150 clib_error_report (error);
1154 BAD_SW_IF_INDEX_LABEL;
1156 REPLY_MACRO (VL_API_SW_INTERFACE_SET_RX_PLACEMENT_REPLY);
1160 vl_api_create_vlan_subif_t_handler (vl_api_create_vlan_subif_t * mp)
1162 vl_api_create_vlan_subif_reply_t *rmp;
1163 vnet_main_t *vnm = vnet_get_main ();
1164 u32 sw_if_index = (u32) ~ 0;
1165 vnet_hw_interface_t *hi;
1168 vnet_sw_interface_t template;
1170 vnet_interface_main_t *im = &vnm->interface_main;
1171 u64 sup_and_sub_key;
1172 vl_api_registration_t *reg;
1173 clib_error_t *error;
1175 VALIDATE_SW_IF_INDEX (mp);
1177 hi = vnet_get_sup_hw_interface (vnm, ntohl (mp->sw_if_index));
1179 if (hi->bond_info == VNET_HW_INTERFACE_BOND_INFO_SLAVE)
1181 rv = VNET_API_ERROR_BOND_SLAVE_NOT_ALLOWED;
1185 id = ntohl (mp->vlan_id);
1186 if (id == 0 || id > 4095)
1188 rv = VNET_API_ERROR_INVALID_VLAN;
1192 sup_and_sub_key = ((u64) (hi->sw_if_index) << 32) | (u64) id;
1194 p = hash_get_mem (im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
1197 rv = VNET_API_ERROR_VLAN_ALREADY_EXISTS;
1201 clib_memset (&template, 0, sizeof (template));
1202 template.type = VNET_SW_INTERFACE_TYPE_SUB;
1203 template.flood_class = VNET_FLOOD_CLASS_NORMAL;
1204 template.sup_sw_if_index = hi->sw_if_index;
1205 template.sub.id = id;
1206 template.sub.eth.raw_flags = 0;
1207 template.sub.eth.flags.one_tag = 1;
1208 template.sub.eth.outer_vlan_id = id;
1209 template.sub.eth.flags.exact_match = 1;
1211 error = vnet_create_sw_interface (vnm, &template, &sw_if_index);
1214 clib_error_report (error);
1215 rv = VNET_API_ERROR_INVALID_REGISTRATION;
1219 u64 *kp = clib_mem_alloc (sizeof (*kp));
1220 *kp = sup_and_sub_key;
1222 hash_set (hi->sub_interface_sw_if_index_by_id, id, sw_if_index);
1223 hash_set_mem (im->sw_if_index_by_sup_and_sub, kp, sw_if_index);
1225 BAD_SW_IF_INDEX_LABEL;
1228 reg = vl_api_client_index_to_registration (mp->client_index);
1232 rmp = vl_msg_api_alloc (sizeof (*rmp));
1233 rmp->_vl_msg_id = htons (VL_API_CREATE_VLAN_SUBIF_REPLY);
1234 rmp->context = mp->context;
1235 rmp->retval = htonl (rv);
1236 rmp->sw_if_index = htonl (sw_if_index);
1237 vl_api_send_msg (reg, (u8 *) rmp);
1241 vl_api_create_subif_t_handler (vl_api_create_subif_t * mp)
1243 vl_api_create_subif_reply_t *rmp;
1244 vnet_main_t *vnm = vnet_get_main ();
1245 u32 sub_sw_if_index = ~0;
1246 vnet_hw_interface_t *hi;
1249 VALIDATE_SW_IF_INDEX (mp);
1251 hi = vnet_get_sup_hw_interface (vnm, ntohl (mp->sw_if_index));
1253 if (hi->bond_info == VNET_HW_INTERFACE_BOND_INFO_SLAVE)
1254 rv = VNET_API_ERROR_BOND_SLAVE_NOT_ALLOWED;
1256 rv = vnet_create_sub_interface (ntohl (mp->sw_if_index),
1258 ntohl (mp->sub_if_flags),
1259 ntohs (mp->inner_vlan_id),
1260 ntohs (mp->outer_vlan_id),
1263 BAD_SW_IF_INDEX_LABEL;
1266 REPLY_MACRO2(VL_API_CREATE_SUBIF_REPLY,
1268 rmp->sw_if_index = ntohl(sub_sw_if_index);
1274 vl_api_delete_subif_t_handler (vl_api_delete_subif_t * mp)
1276 vl_api_delete_subif_reply_t *rmp;
1279 rv = vnet_delete_sub_interface (ntohl (mp->sw_if_index));
1281 REPLY_MACRO (VL_API_DELETE_SUBIF_REPLY);
1285 vl_api_interface_name_renumber_t_handler (vl_api_interface_name_renumber_t *
1288 vl_api_interface_name_renumber_reply_t *rmp;
1291 VALIDATE_SW_IF_INDEX (mp);
1293 rv = vnet_interface_name_renumber
1294 (ntohl (mp->sw_if_index), ntohl (mp->new_show_dev_instance));
1296 BAD_SW_IF_INDEX_LABEL;
1298 REPLY_MACRO (VL_API_INTERFACE_NAME_RENUMBER_REPLY);
1302 vl_api_create_loopback_t_handler (vl_api_create_loopback_t * mp)
1304 vl_api_create_loopback_reply_t *rmp;
1309 mac_address_decode (mp->mac_address, &mac);
1310 rv = vnet_create_loopback_interface (&sw_if_index, (u8 *) & mac, 0, 0);
1313 REPLY_MACRO2(VL_API_CREATE_LOOPBACK_REPLY,
1315 rmp->sw_if_index = ntohl (sw_if_index);
1320 static void vl_api_create_loopback_instance_t_handler
1321 (vl_api_create_loopback_instance_t * mp)
1323 vl_api_create_loopback_instance_reply_t *rmp;
1325 u8 is_specified = mp->is_specified;
1326 u32 user_instance = ntohl (mp->user_instance);
1330 mac_address_decode (mp->mac_address, &mac);
1331 rv = vnet_create_loopback_interface (&sw_if_index, (u8 *) & mac,
1332 is_specified, user_instance);
1335 REPLY_MACRO2(VL_API_CREATE_LOOPBACK_INSTANCE_REPLY,
1337 rmp->sw_if_index = ntohl (sw_if_index);
1343 vl_api_delete_loopback_t_handler (vl_api_delete_loopback_t * mp)
1345 vl_api_delete_loopback_reply_t *rmp;
1349 sw_if_index = ntohl (mp->sw_if_index);
1350 rv = vnet_delete_loopback_interface (sw_if_index);
1352 REPLY_MACRO (VL_API_DELETE_LOOPBACK_REPLY);
1356 vl_api_collect_detailed_interface_stats_t_handler
1357 (vl_api_collect_detailed_interface_stats_t * mp)
1359 vl_api_collect_detailed_interface_stats_reply_t *rmp;
1363 vnet_sw_interface_stats_collect_enable_disable (ntohl (mp->sw_if_index),
1364 mp->enable_disable);
1366 REPLY_MACRO (VL_API_COLLECT_DETAILED_INTERFACE_STATS_REPLY);
1371 * Add vpe's API message handlers to the table.
1372 * vlib has already mapped shared memory and
1373 * added the client registration handlers.
1374 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
1376 #define vl_msg_name_crc_list
1377 #include <vnet/interface.api.h>
1378 #undef vl_msg_name_crc_list
1381 setup_message_id_table (api_main_t * am)
1383 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
1384 foreach_vl_msg_name_crc_interface;
1388 pub_sub_handler (interface_events, INTERFACE_EVENTS);
1390 static clib_error_t *
1391 interface_api_hookup (vlib_main_t * vm)
1393 api_main_t *am = vlibapi_get_main ();
1396 vl_msg_api_set_handlers(VL_API_##N, #n, \
1397 vl_api_##n##_t_handler, \
1399 vl_api_##n##_t_endian, \
1400 vl_api_##n##_t_print, \
1401 sizeof(vl_api_##n##_t), 1);
1402 foreach_vpe_api_msg;
1405 /* Mark these APIs as mp safe */
1406 am->is_mp_safe[VL_API_SW_INTERFACE_DUMP] = 1;
1407 am->is_mp_safe[VL_API_SW_INTERFACE_DETAILS] = 1;
1408 am->is_mp_safe[VL_API_SW_INTERFACE_TAG_ADD_DEL] = 1;
1410 /* Do not replay VL_API_SW_INTERFACE_DUMP messages */
1411 am->api_trace_cfg[VL_API_SW_INTERFACE_DUMP].replay_enable = 0;
1414 * Set up the (msg_name, crc, message-id) table
1416 setup_message_id_table (am);
1421 VLIB_API_INIT_FUNCTION (interface_api_hookup);
1424 * fd.io coding-style-patch-verification: ON
1427 * eval: (c-set-style "gnu")