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>
40 static vl_api_ip_neighbor_flags_t
41 ip_neighbor_flags_encode (ip_neighbor_flags_t f)
43 vl_api_ip_neighbor_flags_t v = IP_API_NEIGHBOR_FLAG_NONE;
45 if (f & IP_NEIGHBOR_FLAG_STATIC)
46 v |= IP_API_NEIGHBOR_FLAG_STATIC;
47 if (f & IP_NEIGHBOR_FLAG_NO_FIB_ENTRY)
48 v |= IP_API_NEIGHBOR_FLAG_NO_FIB_ENTRY;
54 ip_neighbor_encode (vl_api_ip_neighbor_t * api, const ip_neighbor_t * ipn)
56 api->sw_if_index = htonl (ipn->ipn_key->ipnk_sw_if_index);
57 api->flags = ip_neighbor_flags_encode (ipn->ipn_flags);
59 ip_address_encode2 (&ipn->ipn_key->ipnk_ip, &api->ip_address);
60 mac_address_encode (&ipn->ipn_mac, api->mac_address);
64 ip_neighbor_handle_event (ip_neighbor_event_t * ipne)
66 vl_api_registration_t *reg;
69 ipn = &ipne->ipne_nbr;
72 /* Client can cancel, die, etc. */
75 /* Customer(s) requesting event for this neighbor */
76 reg = vl_api_client_index_to_registration (ipne->ipne_watch.ipw_client);
80 if (vl_api_can_send_msg (reg))
82 if (1 == ipne->ipne_watch.ipw_api_version)
84 vl_api_ip_neighbor_event_t *mp;
86 mp = vl_msg_api_alloc (sizeof (*mp));
87 clib_memset (mp, 0, sizeof (*mp));
89 ntohs (VL_API_IP_NEIGHBOR_EVENT + REPLY_MSG_ID_BASE);
90 mp->client_index = ipne->ipne_watch.ipw_client;
91 mp->pid = ipne->ipne_watch.ipw_pid;
93 ip_neighbor_encode (&mp->neighbor, ipn);
95 vl_api_send_msg (reg, (u8 *) mp);
97 else if (2 == ipne->ipne_watch.ipw_api_version)
99 vl_api_ip_neighbor_event_v2_t *mp;
101 mp = vl_msg_api_alloc (sizeof (*mp));
102 clib_memset (mp, 0, sizeof (*mp));
104 ntohs (VL_API_IP_NEIGHBOR_EVENT_V2 + REPLY_MSG_ID_BASE);
105 mp->client_index = ipne->ipne_watch.ipw_client;
106 mp->pid = ipne->ipne_watch.ipw_pid;
107 mp->flags = clib_host_to_net_u32 (ipne->ipne_flags);
109 ip_neighbor_encode (&mp->neighbor, ipn);
111 vl_api_send_msg (reg, (u8 *) mp);
116 static f64 last_time;
118 * Throttle syslog msgs.
119 * It's pretty tempting to just revoke the registration...
121 if (vlib_time_now (vlib_get_main ()) > last_time + 10.0)
123 clib_warning ("neighbor event for %U to pid %d: queue stuffed!",
124 format_ip_address, &ipn->ipn_key->ipnk_ip,
125 ipne->ipne_watch.ipw_pid);
126 last_time = vlib_time_now (vlib_get_main ());
130 ip_neighbor_free (ipn);
133 typedef struct ip_neighbor_dump_ctx_t_
135 vl_api_registration_t *reg;
137 } ip_neighbor_dump_ctx_t;
140 send_ip_neighbor_details (index_t ipni, void *arg)
142 ip_neighbor_dump_ctx_t *ctx = arg;
143 vl_api_ip_neighbor_details_t *mp;
146 ipn = ip_neighbor_get (ipni);
147 mp = vl_msg_api_alloc (sizeof (*mp));
148 clib_memset (mp, 0, sizeof (*mp));
149 mp->_vl_msg_id = ntohs (VL_API_IP_NEIGHBOR_DETAILS + REPLY_MSG_ID_BASE);
150 mp->context = ctx->context;
152 clib_host_to_net_f64 ((vlib_time_now (vlib_get_main ()) -
153 ipn->ipn_time_last_updated));
154 ip_neighbor_encode (&mp->neighbor, ipn);
156 vl_api_send_msg (ctx->reg, (u8 *) mp);
158 return (WALK_CONTINUE);
162 vl_api_ip_neighbor_dump_t_handler (vl_api_ip_neighbor_dump_t * mp)
164 vl_api_registration_t *reg;
165 ip_address_family_t af;
168 reg = vl_api_client_index_to_registration (mp->client_index);
172 u32 sw_if_index = ntohl (mp->sw_if_index);
174 rv = ip_address_family_decode (mp->af, &af);
179 ip_neighbor_dump_ctx_t ctx = {
181 .context = mp->context,
184 // walk all neighbours on all interfaces
185 ip_neighbor_walk (af, sw_if_index, send_ip_neighbor_details, &ctx);
188 static ip_neighbor_flags_t
189 ip_neighbor_flags_decode (vl_api_ip_neighbor_flags_t v)
191 ip_neighbor_flags_t f = IP_NEIGHBOR_FLAG_NONE;
193 if (v & IP_API_NEIGHBOR_FLAG_STATIC)
194 f |= IP_NEIGHBOR_FLAG_STATIC;
195 if (v & IP_API_NEIGHBOR_FLAG_NO_FIB_ENTRY)
196 f |= IP_NEIGHBOR_FLAG_NO_FIB_ENTRY;
202 vl_api_ip_neighbor_add_del_t_handler (vl_api_ip_neighbor_add_del_t * mp,
205 vl_api_ip_neighbor_add_del_reply_t *rmp;
206 ip_neighbor_flags_t flags;
207 u32 stats_index = ~0;
208 ip_address_t ip = ip_address_initializer;
212 VALIDATE_SW_IF_INDEX ((&mp->neighbor));
214 flags = ip_neighbor_flags_decode (mp->neighbor.flags);
215 ip_address_decode2 (&mp->neighbor.ip_address, &ip);
216 mac_address_decode (mp->neighbor.mac_address, &mac);
218 /* must be static or dynamic, default to dynamic */
219 if (!(flags & IP_NEIGHBOR_FLAG_STATIC) &&
220 !(flags & IP_NEIGHBOR_FLAG_DYNAMIC))
221 flags |= IP_NEIGHBOR_FLAG_DYNAMIC;
224 * there's no validation here of the ND/ARP entry being added.
225 * The expectation is that the FIB will ensure that nothing bad
226 * will come of adding bogus entries.
229 rv = ip_neighbor_add (&ip, &mac,
230 ntohl (mp->neighbor.sw_if_index),
231 flags, &stats_index);
233 rv = ip_neighbor_del (&ip, ntohl (mp->neighbor.sw_if_index));
235 BAD_SW_IF_INDEX_LABEL;
238 REPLY_MACRO2 (VL_API_IP_NEIGHBOR_ADD_DEL_REPLY,
240 rmp->stats_index = htonl (stats_index);
246 vl_api_want_ip_neighbor_events_t_handler (vl_api_want_ip_neighbor_events_t *
249 vl_api_want_ip_neighbor_events_reply_t *rmp;
253 if (mp->sw_if_index != ~0)
254 VALIDATE_SW_IF_INDEX (mp);
255 ip_address_decode2 (&mp->ip, &ip);
257 ip_neighbor_watcher_t watch = {
258 .ipw_client = mp->client_index,
260 .ipw_api_version = 1,
264 ip_neighbor_watch (&ip, ntohl (mp->sw_if_index), &watch);
266 ip_neighbor_unwatch (&ip, ntohl (mp->sw_if_index), &watch);
268 BAD_SW_IF_INDEX_LABEL;
269 REPLY_MACRO (VL_API_WANT_IP_NEIGHBOR_EVENTS_REPLY);
273 vl_api_want_ip_neighbor_events_v2_t_handler
274 (vl_api_want_ip_neighbor_events_v2_t * mp)
276 vl_api_want_ip_neighbor_events_reply_t *rmp;
280 if (mp->sw_if_index != ~0)
281 VALIDATE_SW_IF_INDEX (mp);
282 ip_address_decode2 (&mp->ip, &ip);
284 ip_neighbor_watcher_t watch = {
285 .ipw_client = mp->client_index,
287 .ipw_api_version = 2,
291 ip_neighbor_watch (&ip, ntohl (mp->sw_if_index), &watch);
293 ip_neighbor_unwatch (&ip, ntohl (mp->sw_if_index), &watch);
295 BAD_SW_IF_INDEX_LABEL;
296 REPLY_MACRO (VL_API_WANT_IP_NEIGHBOR_EVENTS_V2_REPLY);
300 vl_api_ip_neighbor_config_t_handler (vl_api_ip_neighbor_config_t * mp)
302 vl_api_ip_neighbor_config_reply_t *rmp;
303 ip_address_family_t af;
306 rv = ip_address_family_decode (mp->af, &af);
309 rv = ip_neighbor_config (af,
310 ntohl (mp->max_number),
311 ntohl (mp->max_age), mp->recycle);
313 REPLY_MACRO (VL_API_IP_NEIGHBOR_CONFIG_REPLY);
317 vl_api_ip_neighbor_replace_begin_t_handler (vl_api_ip_neighbor_replace_begin_t
320 vl_api_ip_neighbor_replace_begin_reply_t *rmp;
323 ip_neighbor_mark (AF_IP4);
324 ip_neighbor_mark (AF_IP6);
326 REPLY_MACRO (VL_API_IP_NEIGHBOR_REPLACE_BEGIN_REPLY);
330 vl_api_ip_neighbor_replace_end_t_handler (vl_api_ip_neighbor_replace_end_t *
333 vl_api_ip_neighbor_replace_end_reply_t *rmp;
336 ip_neighbor_sweep (AF_IP4);
337 ip_neighbor_sweep (AF_IP6);
339 REPLY_MACRO (VL_API_IP_NEIGHBOR_REPLACE_END_REPLY);
343 vl_api_ip_neighbor_flush_t_handler (vl_api_ip_neighbor_flush_t * mp)
345 vl_api_ip_neighbor_flush_reply_t *rmp;
346 ip_address_family_t af;
349 if (mp->sw_if_index != ~0)
350 VALIDATE_SW_IF_INDEX (mp);
352 rv = ip_address_family_decode (mp->af, &af);
355 ip_neighbor_del_all (af, ntohl (mp->sw_if_index));
357 BAD_SW_IF_INDEX_LABEL;
358 REPLY_MACRO (VL_API_IP_NEIGHBOR_FLUSH_REPLY);
361 #define vl_msg_name_crc_list
362 #include <vnet/ip-neighbor/ip_neighbor.api.h>
363 #undef vl_msg_name_crc_list
365 #include <vnet/ip-neighbor/ip_neighbor.api.c>
367 static clib_error_t *
368 ip_neighbor_api_init (vlib_main_t * vm)
370 /* Ask for a correctly-sized block of API message decode slots */
371 msg_id_base = setup_message_id_table ();
376 VLIB_API_INIT_FUNCTION (ip_neighbor_api_init);
379 * fd.io coding-style-patch-verification: ON
382 * eval: (c-set-style "gnu")