2 *------------------------------------------------------------------
3 * ip_api.c - vnet ip 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 *------------------------------------------------------------------
22 #include <vnet/ip-neighbor/ip_neighbor.h>
23 #include <vnet/ip-neighbor/ip_neighbor_watch.h>
24 #include <vnet/ip/ip_types_api.h>
25 #include <vnet/ethernet/ethernet_types_api.h>
27 #include <vlibapi/api.h>
28 #include <vlibmemory/api.h>
30 #include <vnet/ip-neighbor/ip_neighbor.api_enum.h>
31 #include <vnet/ip-neighbor/ip_neighbor.api_types.h>
33 static u16 msg_id_base;
34 #define REPLY_MSG_ID_BASE msg_id_base
36 #include <vlibapi/api_helper_macros.h>
38 #include <vnet/format_fns.h>
42 ip46_type_from_af (ip_address_family_t af)
44 return (AF_IP4 == af ? IP46_TYPE_IP4 : IP46_TYPE_IP6);
47 static vl_api_ip_neighbor_flags_t
48 ip_neighbor_flags_encode (ip_neighbor_flags_t f)
50 vl_api_ip_neighbor_flags_t v = IP_API_NEIGHBOR_FLAG_NONE;
52 if (f & IP_NEIGHBOR_FLAG_STATIC)
53 v |= IP_API_NEIGHBOR_FLAG_STATIC;
54 if (f & IP_NEIGHBOR_FLAG_NO_FIB_ENTRY)
55 v |= IP_API_NEIGHBOR_FLAG_NO_FIB_ENTRY;
61 ip_neighbor_encode (vl_api_ip_neighbor_t * api, const ip_neighbor_t * ipn)
63 api->sw_if_index = htonl (ipn->ipn_key->ipnk_sw_if_index);
64 api->flags = ip_neighbor_flags_encode (ipn->ipn_flags);
66 ip_address_encode (&ipn->ipn_key->ipnk_ip,
67 ipn->ipn_key->ipnk_type, &api->ip_address);
68 mac_address_encode (&ipn->ipn_mac, api->mac_address);
72 ip_neighbor_handle_event (const ip_neighbor_event_t * ipne)
74 vl_api_ip_neighbor_event_t *mp;
75 vl_api_registration_t *reg;
76 const ip_neighbor_t *ipn;
78 ipn = ip_neighbor_get (ipne->ipne_index);
81 /* Client can cancel, die, etc. */
84 /* Customer(s) requesting event for this neighbor */
85 reg = vl_api_client_index_to_registration (ipne->ipne_watch.ipw_client);
89 if (vl_api_can_send_msg (reg))
91 mp = vl_msg_api_alloc (sizeof (*mp));
92 clib_memset (mp, 0, sizeof (*mp));
93 mp->_vl_msg_id = ntohs (VL_API_IP_NEIGHBOR_EVENT + REPLY_MSG_ID_BASE);
94 mp->client_index = ipne->ipne_watch.ipw_client;
95 mp->pid = ipne->ipne_watch.ipw_pid;
97 ip_neighbor_encode (&mp->neighbor, ipn);
99 vl_api_send_msg (reg, (u8 *) mp);
103 static f64 last_time;
105 * Throttle syslog msgs.
106 * It's pretty tempting to just revoke the registration...
108 if (vlib_time_now (vlib_get_main ()) > last_time + 10.0)
110 clib_warning ("ip6 nd event for %U to pid %d: queue stuffed!",
111 format_ip46_address, &ipn->ipn_key->ipnk_ip,
112 IP46_TYPE_ANY, ipne->ipne_watch.ipw_pid);
113 last_time = vlib_time_now (vlib_get_main ());
118 typedef struct ip_neighbor_dump_ctx_t_
120 vl_api_registration_t *reg;
122 } ip_neighbor_dump_ctx_t;
125 send_ip_neighbor_details (index_t ipni, void *arg)
127 ip_neighbor_dump_ctx_t *ctx = arg;
128 vl_api_ip_neighbor_details_t *mp;
131 ipn = ip_neighbor_get (ipni);
132 mp = vl_msg_api_alloc (sizeof (*mp));
133 clib_memset (mp, 0, sizeof (*mp));
134 mp->_vl_msg_id = ntohs (VL_API_IP_NEIGHBOR_DETAILS + REPLY_MSG_ID_BASE);
135 mp->context = ctx->context;
136 ip_neighbor_encode (&mp->neighbor, ipn);
138 vl_api_send_msg (ctx->reg, (u8 *) mp);
140 return (WALK_CONTINUE);
144 vl_api_ip_neighbor_dump_t_handler (vl_api_ip_neighbor_dump_t * mp)
146 vl_api_registration_t *reg;
147 ip_address_family_t af;
150 reg = vl_api_client_index_to_registration (mp->client_index);
154 u32 sw_if_index = ntohl (mp->sw_if_index);
156 rv = ip_address_family_decode (mp->af, &af);
161 ip_neighbor_dump_ctx_t ctx = {
163 .context = mp->context,
166 // walk all neighbours on all interfaces
167 ip_neighbor_walk ((af == AF_IP4 ?
170 sw_if_index, send_ip_neighbor_details, &ctx);
173 static ip_neighbor_flags_t
174 ip_neighbor_flags_decode (vl_api_ip_neighbor_flags_t v)
176 ip_neighbor_flags_t f = IP_NEIGHBOR_FLAG_NONE;
178 if (v & IP_API_NEIGHBOR_FLAG_STATIC)
179 f |= IP_NEIGHBOR_FLAG_STATIC;
180 if (v & IP_API_NEIGHBOR_FLAG_NO_FIB_ENTRY)
181 f |= IP_NEIGHBOR_FLAG_NO_FIB_ENTRY;
187 vl_api_ip_neighbor_add_del_t_handler (vl_api_ip_neighbor_add_del_t * mp,
190 vl_api_ip_neighbor_add_del_reply_t *rmp;
191 ip_neighbor_flags_t flags;
192 u32 stats_index = ~0;
193 ip46_address_t ip = ip46_address_initializer;
198 VALIDATE_SW_IF_INDEX ((&mp->neighbor));
200 flags = ip_neighbor_flags_decode (mp->neighbor.flags);
201 type = ip_address_decode (&mp->neighbor.ip_address, &ip);
202 mac_address_decode (mp->neighbor.mac_address, &mac);
204 /* must be static or dynamic, default to dynamic */
205 if (!(flags & IP_NEIGHBOR_FLAG_STATIC) &&
206 !(flags & IP_NEIGHBOR_FLAG_DYNAMIC))
207 flags |= IP_NEIGHBOR_FLAG_DYNAMIC;
210 * there's no validation here of the ND/ARP entry being added.
211 * The expectation is that the FIB will ensure that nothing bad
212 * will come of adding bogus entries.
215 rv = ip_neighbor_add (&ip, type, &mac,
216 ntohl (mp->neighbor.sw_if_index),
217 flags, &stats_index);
219 rv = ip_neighbor_del (&ip, type, ntohl (mp->neighbor.sw_if_index));
221 BAD_SW_IF_INDEX_LABEL;
224 REPLY_MACRO2 (VL_API_IP_NEIGHBOR_ADD_DEL_REPLY,
226 rmp->stats_index = htonl (stats_index);
232 vl_api_want_ip_neighbor_events_t_handler (vl_api_want_ip_neighbor_events_t *
235 vl_api_want_ip_neighbor_events_reply_t *rmp;
240 if (mp->sw_if_index != ~0)
241 VALIDATE_SW_IF_INDEX (mp);
242 itype = ip_address_decode (&mp->ip, &ip);
244 ip_neighbor_watcher_t watch = {
245 .ipw_client = mp->client_index,
250 ip_neighbor_watch (&ip, itype, ntohl (mp->sw_if_index), &watch);
252 ip_neighbor_unwatch (&ip, itype, ntohl (mp->sw_if_index), &watch);
254 BAD_SW_IF_INDEX_LABEL;
255 REPLY_MACRO (VL_API_WANT_IP_NEIGHBOR_EVENTS_REPLY);
259 vl_api_ip_neighbor_config_t_handler (vl_api_ip_neighbor_config_t * mp)
261 vl_api_ip_neighbor_config_reply_t *rmp;
262 ip_address_family_t af;
265 rv = ip_address_family_decode (mp->af, &af);
268 rv = ip_neighbor_config (ip46_type_from_af (af),
269 ntohl (mp->max_number),
270 ntohl (mp->max_age), mp->recycle);
272 REPLY_MACRO (VL_API_IP_NEIGHBOR_CONFIG_REPLY);
275 #define vl_msg_name_crc_list
276 #include <vnet/ip-neighbor/ip_neighbor.api.h>
277 #undef vl_msg_name_crc_list
279 #include <vnet/ip-neighbor/ip_neighbor.api.c>
281 static clib_error_t *
282 ip_neighbor_api_init (vlib_main_t * vm)
284 /* Ask for a correctly-sized block of API message decode slots */
285 msg_id_base = setup_message_id_table ();
290 VLIB_API_INIT_FUNCTION (ip_neighbor_api_init);
293 * fd.io coding-style-patch-verification: ON
296 * eval: (c-set-style "gnu")