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_SET_MAC_ADDRESS, sw_interface_set_mac_address) \
72 _(SW_INTERFACE_GET_MAC_ADDRESS, sw_interface_get_mac_address) \
73 _(CREATE_VLAN_SUBIF, create_vlan_subif) \
74 _(CREATE_SUBIF, create_subif) \
75 _(DELETE_SUBIF, delete_subif) \
76 _(CREATE_LOOPBACK, create_loopback) \
77 _(CREATE_LOOPBACK_INSTANCE, create_loopback_instance) \
78 _(DELETE_LOOPBACK, delete_loopback) \
79 _(INTERFACE_NAME_RENUMBER, interface_name_renumber) \
80 _(COLLECT_DETAILED_INTERFACE_STATS, collect_detailed_interface_stats) \
81 _(SW_INTERFACE_SET_IP_DIRECTED_BROADCAST, \
82 sw_interface_set_ip_directed_broadcast)
85 vl_api_sw_interface_set_flags_t_handler (vl_api_sw_interface_set_flags_t * mp)
87 vl_api_sw_interface_set_flags_reply_t *rmp;
88 vnet_main_t *vnm = vnet_get_main ();
93 VALIDATE_SW_IF_INDEX (mp);
96 ((ntohl (mp->flags)) & IF_STATUS_API_FLAG_ADMIN_UP) ?
97 VNET_SW_INTERFACE_FLAG_ADMIN_UP : 0;
99 error = vnet_sw_interface_set_flags (vnm, ntohl (mp->sw_if_index), flags);
103 clib_error_report (error);
106 BAD_SW_IF_INDEX_LABEL;
107 REPLY_MACRO (VL_API_SW_INTERFACE_SET_FLAGS_REPLY);
111 vl_api_hw_interface_set_mtu_t_handler (vl_api_hw_interface_set_mtu_t * mp)
113 vl_api_hw_interface_set_mtu_reply_t *rmp;
114 vnet_main_t *vnm = vnet_get_main ();
115 u32 sw_if_index = ntohl (mp->sw_if_index);
116 u16 mtu = ntohs (mp->mtu);
117 ethernet_main_t *em = ðernet_main;
120 VALIDATE_SW_IF_INDEX (mp);
122 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
123 if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
125 rv = VNET_API_ERROR_INVALID_VALUE;
126 goto bad_sw_if_index;
129 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, si->hw_if_index);
130 ethernet_interface_t *eif = ethernet_get_interface (em, si->hw_if_index);
134 rv = VNET_API_ERROR_FEATURE_DISABLED;
135 goto bad_sw_if_index;
138 if (mtu < hi->min_supported_packet_bytes)
140 rv = VNET_API_ERROR_INVALID_VALUE;
141 goto bad_sw_if_index;
144 if (mtu > hi->max_supported_packet_bytes)
146 rv = VNET_API_ERROR_INVALID_VALUE;
147 goto bad_sw_if_index;
150 vnet_hw_interface_set_mtu (vnm, si->hw_if_index, mtu);
152 BAD_SW_IF_INDEX_LABEL;
153 REPLY_MACRO (VL_API_HW_INTERFACE_SET_MTU_REPLY);
157 vl_api_sw_interface_set_mtu_t_handler (vl_api_sw_interface_set_mtu_t * mp)
159 vl_api_sw_interface_set_mtu_reply_t *rmp;
160 vnet_main_t *vnm = vnet_get_main ();
161 u32 sw_if_index = ntohl (mp->sw_if_index);
164 u32 per_protocol_mtu[VNET_N_MTU];
166 VALIDATE_SW_IF_INDEX (mp);
168 for (i = 0; i < VNET_N_MTU; i++)
169 per_protocol_mtu[i] = ntohl (mp->mtu[i]);
171 vnet_sw_interface_set_protocol_mtu (vnm, sw_if_index, per_protocol_mtu);
173 BAD_SW_IF_INDEX_LABEL;
174 REPLY_MACRO (VL_API_SW_INTERFACE_SET_MTU_REPLY);
178 vl_api_sw_interface_set_ip_directed_broadcast_t_handler
179 (vl_api_sw_interface_set_ip_directed_broadcast_t * mp)
181 vl_api_sw_interface_set_ip_directed_broadcast_reply_t *rmp;
182 u32 sw_if_index = ntohl (mp->sw_if_index);
185 VALIDATE_SW_IF_INDEX (mp);
187 vnet_sw_interface_ip_directed_broadcast (vnet_get_main (),
188 sw_if_index, mp->enable);
190 BAD_SW_IF_INDEX_LABEL;
191 REPLY_MACRO (VL_API_SW_INTERFACE_SET_IP_DIRECTED_BROADCAST_REPLY);
195 send_sw_interface_details (vpe_api_main_t * am,
196 vl_api_registration_t * rp,
197 vnet_sw_interface_t * swif,
198 u8 * interface_name, u32 context)
200 vnet_hw_interface_t *hi =
201 vnet_get_sup_hw_interface (am->vnet_main, swif->sw_if_index);
203 vl_api_sw_interface_details_t *mp = vl_msg_api_alloc (sizeof (*mp));
204 clib_memset (mp, 0, sizeof (*mp));
205 mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_DETAILS);
206 mp->sw_if_index = ntohl (swif->sw_if_index);
207 mp->sup_sw_if_index = ntohl (swif->sup_sw_if_index);
209 mp->flags |= (swif->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
210 IF_STATUS_API_FLAG_ADMIN_UP : 0;
211 mp->flags |= (hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP) ?
212 IF_STATUS_API_FLAG_LINK_UP : 0;
213 mp->flags = ntohl (mp->flags);
217 case VNET_SW_INTERFACE_TYPE_SUB:
218 mp->type = IF_API_TYPE_SUB;
220 case VNET_SW_INTERFACE_TYPE_P2P:
221 mp->type = IF_API_TYPE_P2P;
223 case VNET_SW_INTERFACE_TYPE_PIPE:
224 mp->type = IF_API_TYPE_PIPE;
227 mp->type = IF_API_TYPE_HARDWARE;
229 mp->type = ntohl (mp->type);
231 mp->link_duplex = ((hi->flags & VNET_HW_INTERFACE_FLAG_DUPLEX_MASK) >>
232 VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT);
233 mp->link_speed = ntohl (hi->link_speed);
234 mp->link_mtu = ntohs (hi->max_packet_bytes);
235 mp->mtu[VNET_MTU_L3] = ntohl (swif->mtu[VNET_MTU_L3]);
236 mp->mtu[VNET_MTU_IP4] = ntohl (swif->mtu[VNET_MTU_IP4]);
237 mp->mtu[VNET_MTU_IP6] = ntohl (swif->mtu[VNET_MTU_IP6]);
238 mp->mtu[VNET_MTU_MPLS] = ntohl (swif->mtu[VNET_MTU_MPLS]);
240 mp->context = context;
242 strncpy ((char *) mp->interface_name,
243 (char *) interface_name, ARRAY_LEN (mp->interface_name) - 1);
245 /* Send the L2 address for ethernet physical intfcs */
246 if (swif->sup_sw_if_index == swif->sw_if_index
247 && hi->hw_class_index == ethernet_hw_interface_class.index)
249 ethernet_main_t *em = ethernet_get_main (am->vlib_main);
250 ethernet_interface_t *ei;
252 ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
253 ASSERT (sizeof (mp->l2_address) >= sizeof (ei->address));
254 mac_address_encode ((mac_address_t *) ei->address, mp->l2_address);
256 else if (swif->sup_sw_if_index != swif->sw_if_index)
258 vnet_sub_interface_t *sub = &swif->sub;
259 mp->sub_id = ntohl (sub->id);
260 mp->sub_number_of_tags =
261 sub->eth.flags.one_tag + sub->eth.flags.two_tags * 2;
262 mp->sub_outer_vlan_id = ntohs (sub->eth.outer_vlan_id);
263 mp->sub_inner_vlan_id = ntohs (sub->eth.inner_vlan_id);
265 ntohl (sub->eth.raw_flags & SUB_IF_API_FLAG_MASK_VNET);
267 /* vlan tag rewrite data */
268 u32 vtr_op = L2_VTR_DISABLED;
269 u32 vtr_push_dot1q = 0, vtr_tag1 = 0, vtr_tag2 = 0;
271 if (l2vtr_get (am->vlib_main, am->vnet_main, swif->sw_if_index,
272 &vtr_op, &vtr_push_dot1q, &vtr_tag1, &vtr_tag2) != 0)
274 // error - default to disabled
275 mp->vtr_op = ntohl (L2_VTR_DISABLED);
276 clib_warning ("cannot get vlan tag rewrite for sw_if_index %d",
281 mp->vtr_op = ntohl (vtr_op);
282 mp->vtr_push_dot1q = ntohl (vtr_push_dot1q);
283 mp->vtr_tag1 = ntohl (vtr_tag1);
284 mp->vtr_tag2 = ntohl (vtr_tag2);
288 /* pbb tag rewrite data */
289 ethernet_header_t eth_hdr;
290 u32 pbb_vtr_op = L2_VTR_DISABLED;
294 clib_memset (ð_hdr, 0, sizeof (eth_hdr));
296 if (!l2pbb_get (am->vlib_main, am->vnet_main, swif->sw_if_index,
297 &pbb_vtr_op, &outer_tag, ð_hdr, &b_vlanid, &i_sid))
299 mp->sub_if_flags |= ntohl (SUB_IF_API_FLAG_DOT1AH);
300 mac_address_encode ((mac_address_t *) eth_hdr.dst_address, mp->b_dmac);
301 mac_address_encode ((mac_address_t *) eth_hdr.src_address, mp->b_smac);
302 mp->b_vlanid = b_vlanid;
306 u8 *tag = vnet_get_sw_interface_tag (vnet_get_main (), swif->sw_if_index);
308 strncpy ((char *) mp->tag, (char *) tag, ARRAY_LEN (mp->tag) - 1);
310 vl_api_send_msg (rp, (u8 *) mp);
314 vl_api_sw_interface_dump_t_handler (vl_api_sw_interface_dump_t * mp)
316 vpe_api_main_t *am = &vpe_api_main;
317 vnet_sw_interface_t *swif;
318 vnet_interface_main_t *im = &am->vnet_main->interface_main;
319 vl_api_registration_t *rp;
322 rp = vl_api_client_index_to_registration (mp->client_index);
326 clib_warning ("Client %d AWOL", mp->client_index);
330 u8 *filter = 0, *name = 0;
331 sw_if_index = ntohl (mp->sw_if_index);
333 if (!mp->name_filter_valid && sw_if_index != ~0 && sw_if_index != 0)
335 /* is it a valid sw_if_index? */
336 if (!vnet_sw_if_index_is_api_valid (sw_if_index))
339 swif = vec_elt_at_index (im->sw_interfaces, sw_if_index);
341 vec_reset_length (name);
343 format (name, "%U%c", format_vnet_sw_interface_name, am->vnet_main,
345 send_sw_interface_details (am, rp, swif, name, mp->context);
350 if (mp->name_filter_valid)
353 format (0, ".*%s", vl_api_string_len (&mp->name_filter),
354 vl_api_from_api_string (&mp->name_filter), 0);
357 char *strcasestr (char *, char *); /* lnx hdr file botch */
359 pool_foreach (swif, im->sw_interfaces,
361 if (!vnet_swif_is_api_visible (swif))
363 vec_reset_length(name);
364 name = format (name, "%U%c", format_vnet_sw_interface_name, am->vnet_main,
367 if (filter && !strcasestr((char *) name, (char *) filter))
370 send_sw_interface_details (am, rp, swif, name, mp->context);
379 vl_api_sw_interface_add_del_address_t_handler
380 (vl_api_sw_interface_add_del_address_t * mp)
382 vlib_main_t *vm = vlib_get_main ();
383 vnet_main_t *vnm = vnet_get_main ();
384 vl_api_sw_interface_add_del_address_reply_t *rmp;
387 clib_error_t *error = 0;
388 ip46_address_t address;
390 VALIDATE_SW_IF_INDEX (mp);
392 is_del = mp->is_add == 0;
396 ip_del_all_interface_addresses (vm, ntohl (mp->sw_if_index));
397 else if (ip_address_decode (&mp->prefix.address, &address) == IP46_TYPE_IP6)
398 error = ip6_add_del_interface_address (vm, ntohl (mp->sw_if_index),
399 (void *) &address.ip6,
400 mp->prefix.len, is_del);
402 error = ip4_add_del_interface_address (vm, ntohl (mp->sw_if_index),
403 (void *) &address.ip4,
404 mp->prefix.len, is_del);
409 clib_error_report (error);
413 BAD_SW_IF_INDEX_LABEL;
416 REPLY_MACRO (VL_API_SW_INTERFACE_ADD_DEL_ADDRESS_REPLY);
420 vl_api_sw_interface_set_table_t_handler (vl_api_sw_interface_set_table_t * mp)
422 vl_api_sw_interface_set_table_reply_t *rmp;
423 u32 sw_if_index = ntohl (mp->sw_if_index);
424 u32 table_id = ntohl (mp->vrf_id);
427 VALIDATE_SW_IF_INDEX (mp);
430 rv = ip_table_bind (FIB_PROTOCOL_IP6, sw_if_index, table_id, 1);
432 rv = ip_table_bind (FIB_PROTOCOL_IP4, sw_if_index, table_id, 1);
434 BAD_SW_IF_INDEX_LABEL;
436 REPLY_MACRO (VL_API_SW_INTERFACE_SET_TABLE_REPLY);
440 ip_table_bind (fib_protocol_t fproto,
441 u32 sw_if_index, u32 table_id, u8 is_api)
443 CLIB_UNUSED (ip_interface_address_t * ia);
444 u32 fib_index, mfib_index;
450 src = FIB_SOURCE_API;
451 msrc = MFIB_SOURCE_API;
455 src = FIB_SOURCE_CLI;
456 msrc = MFIB_SOURCE_CLI;
460 * This if table does not exist = error is what we want in the end.
462 fib_index = fib_table_find (fproto, table_id);
463 mfib_index = mfib_table_find (fproto, table_id);
465 if (~0 == fib_index || ~0 == mfib_index)
467 return (VNET_API_ERROR_NO_SUCH_FIB);
470 if (FIB_PROTOCOL_IP6 == fproto)
473 * If the interface already has in IP address, then a change int
474 * VRF is not allowed. The IP address applied must first be removed.
475 * We do not do that automatically here, since VPP has no knowledge
476 * of whether those subnets are valid in the destination VRF.
479 foreach_ip_interface_address (&ip6_main.lookup_main,
481 1 /* honor unnumbered */ ,
483 return (VNET_API_ERROR_ADDRESS_FOUND_FOR_INTERFACE);
487 vec_validate (ip6_main.fib_index_by_sw_if_index, sw_if_index);
488 vec_validate (ip6_main.mfib_index_by_sw_if_index, sw_if_index);
491 * tell those that are interested that the binding is changing.
493 ip6_table_bind_callback_t *cb;
494 vec_foreach (cb, ip6_main.table_bind_callbacks)
495 cb->function (&ip6_main, cb->function_opaque,
498 ip6_main.fib_index_by_sw_if_index[sw_if_index]);
502 /* reset back to default */
503 if (0 != ip6_main.fib_index_by_sw_if_index[sw_if_index])
504 fib_table_unlock (ip6_main.fib_index_by_sw_if_index[sw_if_index],
505 FIB_PROTOCOL_IP6, src);
506 if (0 != ip6_main.mfib_index_by_sw_if_index[sw_if_index])
507 mfib_table_unlock (ip6_main.mfib_index_by_sw_if_index
508 [sw_if_index], FIB_PROTOCOL_IP6, msrc);
513 /* we need to lock the table now it's inuse */
514 fib_table_lock (fib_index, FIB_PROTOCOL_IP6, src);
515 mfib_table_lock (mfib_index, FIB_PROTOCOL_IP6, msrc);
518 ip6_main.fib_index_by_sw_if_index[sw_if_index] = fib_index;
519 ip6_main.mfib_index_by_sw_if_index[sw_if_index] = mfib_index;
524 * If the interface already has in IP address, then a change int
525 * VRF is not allowed. The IP address applied must first be removed.
526 * We do not do that automatically here, since VPP has no knowledge
527 * of whether those subnets are valid in the destination VRF.
530 foreach_ip_interface_address (&ip4_main.lookup_main,
532 1 /* honor unnumbered */ ,
534 return (VNET_API_ERROR_ADDRESS_FOUND_FOR_INTERFACE);
538 vec_validate (ip4_main.fib_index_by_sw_if_index, sw_if_index);
539 vec_validate (ip4_main.mfib_index_by_sw_if_index, sw_if_index);
542 * tell those that are interested that the binding is changing.
544 ip4_table_bind_callback_t *cb;
545 vec_foreach (cb, ip4_main.table_bind_callbacks)
546 cb->function (&ip4_main, cb->function_opaque,
549 ip4_main.fib_index_by_sw_if_index[sw_if_index]);
553 /* reset back to default */
554 if (0 != ip4_main.fib_index_by_sw_if_index[sw_if_index])
555 fib_table_unlock (ip4_main.fib_index_by_sw_if_index[sw_if_index],
556 FIB_PROTOCOL_IP4, src);
557 if (0 != ip4_main.mfib_index_by_sw_if_index[sw_if_index])
558 mfib_table_unlock (ip4_main.mfib_index_by_sw_if_index
559 [sw_if_index], FIB_PROTOCOL_IP4, msrc);
564 /* we need to lock the table now it's inuse */
565 fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
568 mfib_index = mfib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
572 ip4_main.fib_index_by_sw_if_index[sw_if_index] = fib_index;
573 ip4_main.mfib_index_by_sw_if_index[sw_if_index] = mfib_index;
580 send_sw_interface_get_table_reply (vl_api_registration_t * reg,
581 u32 context, int retval, u32 vrf_id)
583 vl_api_sw_interface_get_table_reply_t *mp;
585 mp = vl_msg_api_alloc (sizeof (*mp));
586 clib_memset (mp, 0, sizeof (*mp));
587 mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_GET_TABLE_REPLY);
588 mp->context = context;
589 mp->retval = htonl (retval);
590 mp->vrf_id = htonl (vrf_id);
592 vl_api_send_msg (reg, (u8 *) mp);
596 vl_api_sw_interface_get_table_t_handler (vl_api_sw_interface_get_table_t * mp)
598 vl_api_registration_t *reg;
599 fib_table_t *fib_table = 0;
600 u32 sw_if_index = ~0;
603 fib_protocol_t fib_proto = FIB_PROTOCOL_IP4;
606 reg = vl_api_client_index_to_registration (mp->client_index);
610 VALIDATE_SW_IF_INDEX (mp);
612 sw_if_index = ntohl (mp->sw_if_index);
615 fib_proto = FIB_PROTOCOL_IP6;
617 fib_index = fib_table_get_index_for_sw_if_index (fib_proto, sw_if_index);
620 fib_table = fib_table_get (fib_index, fib_proto);
621 table_id = fib_table->ft_table_id;
624 BAD_SW_IF_INDEX_LABEL;
626 send_sw_interface_get_table_reply (reg, mp->context, rv, table_id);
629 static void vl_api_sw_interface_set_unnumbered_t_handler
630 (vl_api_sw_interface_set_unnumbered_t * mp)
632 vl_api_sw_interface_set_unnumbered_reply_t *rmp;
634 vnet_main_t *vnm = vnet_get_main ();
635 u32 sw_if_index = ntohl (mp->sw_if_index);
636 u32 unnumbered_sw_if_index = ntohl (mp->unnumbered_sw_if_index);
639 * The API message field names are backwards from
640 * the underlying data structure names.
641 * It's not worth changing them now.
643 if (!vnet_sw_interface_is_api_valid (vnm, unnumbered_sw_if_index))
645 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
649 /* Only check the "use loop0" field when setting the binding */
650 if (mp->is_add && !vnet_sw_interface_is_api_valid (vnm, sw_if_index))
652 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX_2;
656 vnet_sw_interface_update_unnumbered (unnumbered_sw_if_index,
657 sw_if_index, mp->is_add);
659 REPLY_MACRO (VL_API_SW_INTERFACE_SET_UNNUMBERED_REPLY);
663 vl_api_sw_interface_clear_stats_t_handler (vl_api_sw_interface_clear_stats_t *
666 vl_api_sw_interface_clear_stats_reply_t *rmp;
668 vnet_main_t *vnm = vnet_get_main ();
669 vnet_interface_main_t *im = &vnm->interface_main;
670 vlib_simple_counter_main_t *sm;
671 vlib_combined_counter_main_t *cm;
675 if (mp->sw_if_index != ~0)
676 VALIDATE_SW_IF_INDEX (mp);
678 n_counters = vec_len (im->combined_sw_if_counters);
680 for (j = 0; j < n_counters; j++)
682 im = &vnm->interface_main;
683 cm = im->combined_sw_if_counters + j;
684 if (mp->sw_if_index == (u32) ~ 0)
685 vlib_clear_combined_counters (cm);
687 vlib_zero_combined_counter (cm, ntohl (mp->sw_if_index));
690 n_counters = vec_len (im->sw_if_counters);
692 for (j = 0; j < n_counters; j++)
694 im = &vnm->interface_main;
695 sm = im->sw_if_counters + j;
696 if (mp->sw_if_index == (u32) ~ 0)
697 vlib_clear_simple_counters (sm);
699 vlib_zero_simple_counter (sm, ntohl (mp->sw_if_index));
702 BAD_SW_IF_INDEX_LABEL;
704 REPLY_MACRO (VL_API_SW_INTERFACE_CLEAR_STATS_REPLY);
708 * Events used for sw_interface_events
712 API_LINK_STATE_UP_EVENT = 1 << 1,
713 API_LINK_STATE_DOWN_EVENT = 1 << 2,
714 API_ADMIN_UP_EVENT = 1 << 3,
715 API_ADMIN_DOWN_EVENT = 1 << 4,
716 API_SW_INTERFACE_ADD_EVENT = 1 << 5,
717 API_SW_INTERFACE_DEL_EVENT = 1 << 6,
721 send_sw_interface_event (vpe_api_main_t * am,
722 vpe_client_registration_t * reg,
723 vl_api_registration_t * vl_reg,
724 u32 sw_if_index, enum api_events events)
726 vl_api_sw_interface_event_t *mp;
728 mp = vl_msg_api_alloc (sizeof (*mp));
729 clib_memset (mp, 0, sizeof (*mp));
730 mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_EVENT);
731 mp->sw_if_index = ntohl (sw_if_index);
732 mp->client_index = reg->client_index;
733 mp->pid = reg->client_pid;
735 mp->flags |= (events & API_ADMIN_UP_EVENT) ?
736 IF_STATUS_API_FLAG_ADMIN_UP : 0;
737 mp->flags |= (events & API_LINK_STATE_UP_EVENT) ?
738 IF_STATUS_API_FLAG_LINK_UP : 0;
739 mp->flags = ntohl (mp->flags);
740 mp->deleted = events & API_SW_INTERFACE_DEL_EVENT ? true : false;
741 vl_api_send_msg (vl_reg, (u8 *) mp);
745 link_state_process (vlib_main_t * vm,
746 vlib_node_runtime_t * rt, vlib_frame_t * f)
748 vpe_api_main_t *vam = &vpe_api_main;
749 uword *event_by_sw_if_index = 0;
750 vpe_client_registration_t *reg;
752 vl_api_registration_t *vl_reg;
754 uword *event_data = 0;
757 vam->link_state_process_up = 1;
761 vlib_process_wait_for_event (vm);
763 /* Batch up events */
764 while ((event_type = vlib_process_get_events (vm, &event_data)) != ~0)
766 for (i = 0; i < vec_len (event_data); i++)
768 sw_if_index = event_data[i];
769 vec_validate_init_empty (event_by_sw_if_index, sw_if_index, 0);
770 event_by_sw_if_index[sw_if_index] |= event_type;
772 vec_reset_length (event_data);
775 for (i = 0; i < vec_len (event_by_sw_if_index); i++)
777 if (event_by_sw_if_index[i] == 0)
781 pool_foreach(reg, vam->interface_events_registrations,
783 vl_reg = vl_api_client_index_to_registration (reg->client_index);
785 send_sw_interface_event (vam, reg, vl_reg, i, event_by_sw_if_index[i]);
789 vec_reset_length (event_by_sw_if_index);
795 static clib_error_t *link_up_down_function (vnet_main_t * vm, u32 hw_if_index,
797 static clib_error_t *admin_up_down_function (vnet_main_t * vm,
798 u32 hw_if_index, u32 flags);
799 static clib_error_t *sw_interface_add_del_function (vnet_main_t * vm,
804 VLIB_REGISTER_NODE (link_state_process_node,static) = {
805 .function = link_state_process,
806 .type = VLIB_NODE_TYPE_PROCESS,
807 .name = "vpe-link-state-process",
811 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (admin_up_down_function);
812 VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION (link_up_down_function);
813 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (sw_interface_add_del_function);
815 static clib_error_t *
816 link_up_down_function (vnet_main_t * vm, u32 hw_if_index, u32 flags)
818 vpe_api_main_t *vam = &vpe_api_main;
819 vnet_hw_interface_t *hi = vnet_get_hw_interface (vm, hw_if_index);
821 if (vam->link_state_process_up)
823 enum api_events event =
824 flags ? API_LINK_STATE_UP_EVENT : API_LINK_STATE_DOWN_EVENT;
825 vlib_process_signal_event (vam->vlib_main,
826 link_state_process_node.index, event,
832 static clib_error_t *
833 admin_up_down_function (vnet_main_t * vm, u32 sw_if_index, u32 flags)
835 vpe_api_main_t *vam = &vpe_api_main;
838 * Note: it's perfectly fair to set a subif admin up / admin down.
839 * Note the subtle distinction between this routine and the previous
842 if (vam->link_state_process_up)
844 enum api_events event =
845 flags ? API_ADMIN_UP_EVENT : API_ADMIN_DOWN_EVENT;
846 vlib_process_signal_event (vam->vlib_main,
847 link_state_process_node.index, event,
853 static clib_error_t *
854 sw_interface_add_del_function (vnet_main_t * vm, u32 sw_if_index, u32 flags)
856 vpe_api_main_t *vam = &vpe_api_main;
858 if (vam->link_state_process_up)
860 enum api_events event =
861 flags ? API_SW_INTERFACE_ADD_EVENT : API_SW_INTERFACE_DEL_EVENT;
862 vlib_process_signal_event (vam->vlib_main,
863 link_state_process_node.index, event,
869 static void vl_api_sw_interface_tag_add_del_t_handler
870 (vl_api_sw_interface_tag_add_del_t * mp)
872 vnet_main_t *vnm = vnet_get_main ();
873 vl_api_sw_interface_tag_add_del_reply_t *rmp;
876 u32 sw_if_index = ntohl (mp->sw_if_index);
878 VALIDATE_SW_IF_INDEX (mp);
884 rv = VNET_API_ERROR_INVALID_VALUE;
888 mp->tag[ARRAY_LEN (mp->tag) - 1] = 0;
889 tag = format (0, "%s%c", mp->tag, 0);
890 vnet_set_sw_interface_tag (vnm, tag, sw_if_index);
893 vnet_clear_sw_interface_tag (vnm, sw_if_index);
895 BAD_SW_IF_INDEX_LABEL;
897 REPLY_MACRO (VL_API_SW_INTERFACE_TAG_ADD_DEL_REPLY);
900 static void vl_api_sw_interface_set_mac_address_t_handler
901 (vl_api_sw_interface_set_mac_address_t * mp)
903 vl_api_sw_interface_set_mac_address_reply_t *rmp;
904 vnet_main_t *vnm = vnet_get_main ();
905 u32 sw_if_index = ntohl (mp->sw_if_index);
906 vnet_sw_interface_t *si;
911 VALIDATE_SW_IF_INDEX (mp);
913 si = vnet_get_sw_interface (vnm, sw_if_index);
914 mac_address_decode (mp->mac_address, &mac);
916 vnet_hw_interface_change_mac_address (vnm, si->hw_if_index, (u8 *) & mac);
919 rv = VNET_API_ERROR_UNIMPLEMENTED;
920 clib_error_report (error);
924 BAD_SW_IF_INDEX_LABEL;
926 REPLY_MACRO (VL_API_SW_INTERFACE_SET_MAC_ADDRESS_REPLY);
929 static void vl_api_sw_interface_get_mac_address_t_handler
930 (vl_api_sw_interface_get_mac_address_t * mp)
932 vl_api_sw_interface_get_mac_address_reply_t *rmp;
933 vl_api_registration_t *reg;
934 vnet_main_t *vnm = vnet_get_main ();
935 u32 sw_if_index = ntohl (mp->sw_if_index);
936 vnet_sw_interface_t *si;
937 ethernet_interface_t *eth_if = 0;
940 VALIDATE_SW_IF_INDEX (mp);
942 si = vnet_get_sup_sw_interface (vnm, sw_if_index);
943 if (si->type == VNET_SW_INTERFACE_TYPE_HARDWARE)
944 eth_if = ethernet_get_interface (ðernet_main, si->hw_if_index);
946 BAD_SW_IF_INDEX_LABEL;
948 reg = vl_api_client_index_to_registration (mp->client_index);
951 rmp = vl_msg_api_alloc (sizeof (*rmp));
952 rmp->_vl_msg_id = htons (VL_API_SW_INTERFACE_GET_MAC_ADDRESS_REPLY);
953 rmp->context = mp->context;
954 rmp->retval = htonl (rv);
956 mac_address_encode ((mac_address_t *) eth_if->address, rmp->mac_address);
957 vl_api_send_msg (reg, (u8 *) rmp);
960 static void vl_api_sw_interface_set_rx_mode_t_handler
961 (vl_api_sw_interface_set_rx_mode_t * mp)
963 vl_api_sw_interface_set_rx_mode_reply_t *rmp;
964 vnet_main_t *vnm = vnet_get_main ();
965 u32 sw_if_index = ntohl (mp->sw_if_index);
966 vnet_sw_interface_t *si;
970 VALIDATE_SW_IF_INDEX (mp);
972 si = vnet_get_sw_interface (vnm, sw_if_index);
973 if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
975 rv = VNET_API_ERROR_INVALID_VALUE;
976 goto bad_sw_if_index;
979 error = set_hw_interface_change_rx_mode (vnm, si->hw_if_index,
981 ntohl (mp->queue_id),
982 (vnet_hw_interface_rx_mode)
987 rv = VNET_API_ERROR_UNIMPLEMENTED;
988 clib_error_report (error);
992 BAD_SW_IF_INDEX_LABEL;
994 REPLY_MACRO (VL_API_SW_INTERFACE_SET_RX_MODE_REPLY);
998 send_interface_rx_placement_details (vpe_api_main_t * am,
999 vl_api_registration_t * rp,
1000 u32 sw_if_index, u32 worker_id,
1001 u32 queue_id, u8 mode, u32 context)
1003 vl_api_sw_interface_rx_placement_details_t *mp;
1004 mp = vl_msg_api_alloc (sizeof (*mp));
1005 clib_memset (mp, 0, sizeof (*mp));
1007 mp->_vl_msg_id = htons (VL_API_SW_INTERFACE_RX_PLACEMENT_DETAILS);
1008 mp->sw_if_index = htonl (sw_if_index);
1009 mp->queue_id = htonl (queue_id);
1010 mp->worker_id = htonl (worker_id);
1012 mp->context = context;
1014 vl_api_send_msg (rp, (u8 *) mp);
1017 static void vl_api_sw_interface_rx_placement_dump_t_handler
1018 (vl_api_sw_interface_rx_placement_dump_t * mp)
1020 vnet_main_t *vnm = vnet_get_main ();
1021 vpe_api_main_t *am = &vpe_api_main;
1022 u32 sw_if_index = ntohl (mp->sw_if_index);
1023 vl_api_registration_t *reg;
1025 reg = vl_api_client_index_to_registration (mp->client_index);
1029 if (sw_if_index == ~0)
1031 vnet_device_input_runtime_t *rt;
1032 vnet_device_and_queue_t *dq;
1033 vlib_node_t *pn = vlib_get_node_by_name (am->vlib_main,
1034 (u8 *) "device-input");
1039 foreach_vlib_main (({
1040 clib_bitmap_foreach (si, pn->sibling_bitmap,
1042 rt = vlib_node_get_runtime_data (this_vlib_main, si);
1043 vec_foreach (dq, rt->devices_and_queues)
1045 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm,
1047 send_interface_rx_placement_details (am, reg, hw->sw_if_index, index,
1048 dq->queue_id, dq->mode, mp->context);
1058 vnet_sw_interface_t *si;
1060 if (!vnet_sw_if_index_is_api_valid (sw_if_index))
1062 clib_warning ("sw_if_index %u does not exist", sw_if_index);
1063 goto bad_sw_if_index;
1066 si = vnet_get_sw_interface (vnm, sw_if_index);
1067 if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
1069 clib_warning ("interface type is not HARDWARE! P2P, PIPE and SUB"
1070 " interfaces are not supported");
1071 goto bad_sw_if_index;
1074 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, si->hw_if_index);
1076 for (i = 0; i < vec_len (hw->dq_runtime_index_by_queue); i++)
1078 send_interface_rx_placement_details (am, reg, hw->sw_if_index,
1079 hw->input_node_thread_index_by_queue
1081 hw->rx_mode_by_queue[i],
1086 BAD_SW_IF_INDEX_LABEL;
1089 static void vl_api_sw_interface_set_rx_placement_t_handler
1090 (vl_api_sw_interface_set_rx_placement_t * mp)
1092 vl_api_sw_interface_set_rx_placement_reply_t *rmp;
1093 vnet_main_t *vnm = vnet_get_main ();
1094 u32 sw_if_index = ntohl (mp->sw_if_index);
1095 vnet_sw_interface_t *si;
1096 clib_error_t *error = 0;
1099 VALIDATE_SW_IF_INDEX (mp);
1101 si = vnet_get_sw_interface (vnm, sw_if_index);
1102 if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
1104 rv = VNET_API_ERROR_INVALID_VALUE;
1105 goto bad_sw_if_index;
1108 error = set_hw_interface_rx_placement (si->hw_if_index,
1109 ntohl (mp->queue_id),
1110 ntohl (mp->worker_id), mp->is_main);
1113 rv = VNET_API_ERROR_UNIMPLEMENTED;
1114 clib_error_report (error);
1118 BAD_SW_IF_INDEX_LABEL;
1120 REPLY_MACRO (VL_API_SW_INTERFACE_SET_RX_PLACEMENT_REPLY);
1124 vl_api_create_vlan_subif_t_handler (vl_api_create_vlan_subif_t * mp)
1126 vl_api_create_vlan_subif_reply_t *rmp;
1127 vnet_main_t *vnm = vnet_get_main ();
1128 u32 sw_if_index = (u32) ~ 0;
1129 vnet_hw_interface_t *hi;
1132 vnet_sw_interface_t template;
1134 vnet_interface_main_t *im = &vnm->interface_main;
1135 u64 sup_and_sub_key;
1136 vl_api_registration_t *reg;
1137 clib_error_t *error;
1139 VALIDATE_SW_IF_INDEX (mp);
1141 hi = vnet_get_sup_hw_interface (vnm, ntohl (mp->sw_if_index));
1143 if (hi->bond_info == VNET_HW_INTERFACE_BOND_INFO_SLAVE)
1145 rv = VNET_API_ERROR_BOND_SLAVE_NOT_ALLOWED;
1149 id = ntohl (mp->vlan_id);
1150 if (id == 0 || id > 4095)
1152 rv = VNET_API_ERROR_INVALID_VLAN;
1156 sup_and_sub_key = ((u64) (hi->sw_if_index) << 32) | (u64) id;
1158 p = hash_get_mem (im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
1161 rv = VNET_API_ERROR_VLAN_ALREADY_EXISTS;
1165 clib_memset (&template, 0, sizeof (template));
1166 template.type = VNET_SW_INTERFACE_TYPE_SUB;
1167 template.flood_class = VNET_FLOOD_CLASS_NORMAL;
1168 template.sup_sw_if_index = hi->sw_if_index;
1169 template.sub.id = id;
1170 template.sub.eth.raw_flags = 0;
1171 template.sub.eth.flags.one_tag = 1;
1172 template.sub.eth.outer_vlan_id = id;
1173 template.sub.eth.flags.exact_match = 1;
1175 error = vnet_create_sw_interface (vnm, &template, &sw_if_index);
1178 clib_error_report (error);
1179 rv = VNET_API_ERROR_INVALID_REGISTRATION;
1183 u64 *kp = clib_mem_alloc (sizeof (*kp));
1184 *kp = sup_and_sub_key;
1186 hash_set (hi->sub_interface_sw_if_index_by_id, id, sw_if_index);
1187 hash_set_mem (im->sw_if_index_by_sup_and_sub, kp, sw_if_index);
1189 BAD_SW_IF_INDEX_LABEL;
1192 reg = vl_api_client_index_to_registration (mp->client_index);
1196 rmp = vl_msg_api_alloc (sizeof (*rmp));
1197 rmp->_vl_msg_id = htons (VL_API_CREATE_VLAN_SUBIF_REPLY);
1198 rmp->context = mp->context;
1199 rmp->retval = htonl (rv);
1200 rmp->sw_if_index = htonl (sw_if_index);
1201 vl_api_send_msg (reg, (u8 *) rmp);
1205 vl_api_create_subif_t_handler (vl_api_create_subif_t * mp)
1207 vl_api_create_subif_reply_t *rmp;
1208 vnet_main_t *vnm = vnet_get_main ();
1209 u32 sw_if_index = ~0;
1212 vnet_sw_interface_t *si;
1213 vnet_hw_interface_t *hi;
1214 vnet_sw_interface_t template;
1216 vnet_interface_main_t *im = &vnm->interface_main;
1217 u64 sup_and_sub_key;
1218 clib_error_t *error;
1220 VALIDATE_SW_IF_INDEX (mp);
1222 si = vnet_get_sup_sw_interface (vnm, ntohl (mp->sw_if_index));
1223 hi = vnet_get_sup_hw_interface (vnm, ntohl (mp->sw_if_index));
1225 if (hi->bond_info == VNET_HW_INTERFACE_BOND_INFO_SLAVE)
1227 rv = VNET_API_ERROR_BOND_SLAVE_NOT_ALLOWED;
1231 sw_if_index = si->sw_if_index;
1232 sub_id = ntohl (mp->sub_id);
1234 sup_and_sub_key = ((u64) (sw_if_index) << 32) | (u64) sub_id;
1236 p = hash_get_mem (im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
1240 clib_warning ("sup sw_if_index %d, sub id %d already exists\n",
1241 sw_if_index, sub_id);
1242 rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
1246 clib_memset (&template, 0, sizeof (template));
1247 template.type = VNET_SW_INTERFACE_TYPE_SUB;
1248 template.flood_class = VNET_FLOOD_CLASS_NORMAL;
1249 template.sup_sw_if_index = sw_if_index;
1250 template.sub.id = sub_id;
1251 template.sub.eth.raw_flags = ntohl (mp->sub_if_flags);
1252 template.sub.eth.outer_vlan_id = ntohs (mp->outer_vlan_id);
1253 template.sub.eth.inner_vlan_id = ntohs (mp->inner_vlan_id);
1255 error = vnet_create_sw_interface (vnm, &template, &sw_if_index);
1258 clib_error_report (error);
1259 rv = VNET_API_ERROR_SUBIF_CREATE_FAILED;
1263 u64 *kp = clib_mem_alloc (sizeof (*kp));
1264 *kp = sup_and_sub_key;
1266 hash_set (hi->sub_interface_sw_if_index_by_id, sub_id, sw_if_index);
1267 hash_set_mem (im->sw_if_index_by_sup_and_sub, kp, sw_if_index);
1269 BAD_SW_IF_INDEX_LABEL;
1274 REPLY_MACRO2(VL_API_CREATE_SUBIF_REPLY,
1276 rmp->sw_if_index = ntohl(sw_if_index);
1282 vl_api_delete_subif_t_handler (vl_api_delete_subif_t * mp)
1284 vl_api_delete_subif_reply_t *rmp;
1287 rv = vnet_delete_sub_interface (ntohl (mp->sw_if_index));
1289 REPLY_MACRO (VL_API_DELETE_SUBIF_REPLY);
1293 vl_api_interface_name_renumber_t_handler (vl_api_interface_name_renumber_t *
1296 vl_api_interface_name_renumber_reply_t *rmp;
1299 VALIDATE_SW_IF_INDEX (mp);
1301 rv = vnet_interface_name_renumber
1302 (ntohl (mp->sw_if_index), ntohl (mp->new_show_dev_instance));
1304 BAD_SW_IF_INDEX_LABEL;
1306 REPLY_MACRO (VL_API_INTERFACE_NAME_RENUMBER_REPLY);
1310 vl_api_create_loopback_t_handler (vl_api_create_loopback_t * mp)
1312 vl_api_create_loopback_reply_t *rmp;
1317 mac_address_decode (mp->mac_address, &mac);
1318 rv = vnet_create_loopback_interface (&sw_if_index, (u8 *) & mac, 0, 0);
1321 REPLY_MACRO2(VL_API_CREATE_LOOPBACK_REPLY,
1323 rmp->sw_if_index = ntohl (sw_if_index);
1328 static void vl_api_create_loopback_instance_t_handler
1329 (vl_api_create_loopback_instance_t * mp)
1331 vl_api_create_loopback_instance_reply_t *rmp;
1333 u8 is_specified = mp->is_specified;
1334 u32 user_instance = ntohl (mp->user_instance);
1338 mac_address_decode (mp->mac_address, &mac);
1339 rv = vnet_create_loopback_interface (&sw_if_index, (u8 *) & mac,
1340 is_specified, user_instance);
1343 REPLY_MACRO2(VL_API_CREATE_LOOPBACK_INSTANCE_REPLY,
1345 rmp->sw_if_index = ntohl (sw_if_index);
1351 vl_api_delete_loopback_t_handler (vl_api_delete_loopback_t * mp)
1353 vl_api_delete_loopback_reply_t *rmp;
1357 sw_if_index = ntohl (mp->sw_if_index);
1358 rv = vnet_delete_loopback_interface (sw_if_index);
1360 REPLY_MACRO (VL_API_DELETE_LOOPBACK_REPLY);
1364 vl_api_collect_detailed_interface_stats_t_handler
1365 (vl_api_collect_detailed_interface_stats_t * mp)
1367 vl_api_collect_detailed_interface_stats_reply_t *rmp;
1371 vnet_sw_interface_stats_collect_enable_disable (ntohl (mp->sw_if_index),
1372 mp->enable_disable);
1374 REPLY_MACRO (VL_API_COLLECT_DETAILED_INTERFACE_STATS_REPLY);
1379 * Add vpe's API message handlers to the table.
1380 * vlib has already mapped shared memory and
1381 * added the client registration handlers.
1382 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
1384 #define vl_msg_name_crc_list
1385 #include <vnet/interface.api.h>
1386 #undef vl_msg_name_crc_list
1389 setup_message_id_table (api_main_t * am)
1391 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
1392 foreach_vl_msg_name_crc_interface;
1396 pub_sub_handler (interface_events, INTERFACE_EVENTS);
1398 static clib_error_t *
1399 interface_api_hookup (vlib_main_t * vm)
1401 api_main_t *am = &api_main;
1404 vl_msg_api_set_handlers(VL_API_##N, #n, \
1405 vl_api_##n##_t_handler, \
1407 vl_api_##n##_t_endian, \
1408 vl_api_##n##_t_print, \
1409 sizeof(vl_api_##n##_t), 1);
1410 foreach_vpe_api_msg;
1413 /* Mark these APIs as mp safe */
1414 am->is_mp_safe[VL_API_SW_INTERFACE_DUMP] = 1;
1415 am->is_mp_safe[VL_API_SW_INTERFACE_DETAILS] = 1;
1416 am->is_mp_safe[VL_API_SW_INTERFACE_TAG_ADD_DEL] = 1;
1418 /* Do not replay VL_API_SW_INTERFACE_DUMP messages */
1419 am->api_trace_cfg[VL_API_SW_INTERFACE_DUMP].replay_enable = 0;
1422 * Set up the (msg_name, crc, message-id) table
1424 setup_message_id_table (am);
1429 VLIB_API_INIT_FUNCTION (interface_api_hookup);
1432 * fd.io coding-style-patch-verification: ON
1435 * eval: (c-set-style "gnu")