FD.io VPP  v20.05.1-6-gf53edbc3b
Vector Packet Processing
ip_neighbor_api.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * ip_api.c - vnet ip api
4  *
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:
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
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  *------------------------------------------------------------------
18  */
19 
20 #include <stddef.h>
21 
24 #include <vnet/ip/ip_types_api.h>
26 
27 #include <vlibapi/api.h>
28 #include <vlibmemory/api.h>
29 
30 #include <vnet/ip-neighbor/ip_neighbor.api_enum.h>
31 #include <vnet/ip-neighbor/ip_neighbor.api_types.h>
32 
34 #define REPLY_MSG_ID_BASE msg_id_base
35 
37 
38 #include <vnet/format_fns.h>
39 
40 
41 static ip46_type_t
43 {
44  return (AF_IP4 == af ? IP46_TYPE_IP4 : IP46_TYPE_IP6);
45 }
46 
47 static vl_api_ip_neighbor_flags_t
49 {
50  vl_api_ip_neighbor_flags_t v = IP_API_NEIGHBOR_FLAG_NONE;
51 
52  if (f & IP_NEIGHBOR_FLAG_STATIC)
54  if (f & IP_NEIGHBOR_FLAG_NO_FIB_ENTRY)
56 
57  return (v);
58 }
59 
60 static void
61 ip_neighbor_encode (vl_api_ip_neighbor_t * api, const ip_neighbor_t * ipn)
62 {
63  api->sw_if_index = htonl (ipn->ipn_key->ipnk_sw_if_index);
64  api->flags = ip_neighbor_flags_encode (ipn->ipn_flags);
65 
67  ipn->ipn_key->ipnk_type, &api->ip_address);
68  mac_address_encode (&ipn->ipn_mac, api->mac_address);
69 }
70 
71 void
73 {
76  const ip_neighbor_t *ipn;
77 
78  ipn = ip_neighbor_get (ipne->ipne_index);
79 
80  if (NULL == ipn)
81  /* Client can cancel, die, etc. */
82  return;
83 
84  /* Customer(s) requesting event for this neighbor */
86  if (!reg)
87  return;
88 
89  if (vl_api_can_send_msg (reg))
90  {
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);
95  mp->pid = ipne->ipne_watch.ipw_pid;
96 
97  ip_neighbor_encode (&mp->neighbor, ipn);
98 
99  vl_api_send_msg (reg, (u8 *) mp);
100  }
101  else
102  {
103  static f64 last_time;
104  /*
105  * Throttle syslog msgs.
106  * It's pretty tempting to just revoke the registration...
107  */
108  if (vlib_time_now (vlib_get_main ()) > last_time + 10.0)
109  {
110  clib_warning ("ip6 nd event for %U to pid %d: queue stuffed!",
113  last_time = vlib_time_now (vlib_get_main ());
114  }
115  }
116 }
117 
119 {
123 
124 static walk_rc_t
126 {
129  ip_neighbor_t *ipn;
130 
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  mp->age =
138  ipn->ipn_time_last_updated));
139  ip_neighbor_encode (&mp->neighbor, ipn);
140 
141  vl_api_send_msg (ctx->reg, (u8 *) mp);
142 
143  return (WALK_CONTINUE);
144 }
145 
146 static void
148 {
151  int rv;
152 
154  if (!reg)
155  return;
156 
157  u32 sw_if_index = ntohl (mp->sw_if_index);
158 
159  rv = ip_address_family_decode (mp->af, &af);
160 
161  if (rv)
162  return;
163 
165  .reg = reg,
166  .context = mp->context,
167  };
168 
169  // walk all neighbours on all interfaces
170  ip_neighbor_walk ((af == AF_IP4 ?
171  IP46_TYPE_IP4 :
172  IP46_TYPE_IP6),
173  sw_if_index, send_ip_neighbor_details, &ctx);
174 }
175 
176 static ip_neighbor_flags_t
177 ip_neighbor_flags_decode (vl_api_ip_neighbor_flags_t v)
178 {
180 
182  f |= IP_NEIGHBOR_FLAG_STATIC;
184  f |= IP_NEIGHBOR_FLAG_NO_FIB_ENTRY;
185 
186  return (f);
187 }
188 
189 static void
191  vlib_main_t * vm)
192 {
195  u32 stats_index = ~0;
196  ip46_address_t ip = ip46_address_initializer;
199  int rv;
200 
202 
203  flags = ip_neighbor_flags_decode (mp->neighbor.flags);
204  type = ip_address_decode (&mp->neighbor.ip_address, &ip);
205  mac_address_decode (mp->neighbor.mac_address, &mac);
206 
207  /* must be static or dynamic, default to dynamic */
208  if (!(flags & IP_NEIGHBOR_FLAG_STATIC) &&
209  !(flags & IP_NEIGHBOR_FLAG_DYNAMIC))
210  flags |= IP_NEIGHBOR_FLAG_DYNAMIC;
211 
212  /*
213  * there's no validation here of the ND/ARP entry being added.
214  * The expectation is that the FIB will ensure that nothing bad
215  * will come of adding bogus entries.
216  */
217  if (mp->is_add)
218  rv = ip_neighbor_add (&ip, type, &mac,
219  ntohl (mp->neighbor.sw_if_index),
220  flags, &stats_index);
221  else
222  rv = ip_neighbor_del (&ip, type, ntohl (mp->neighbor.sw_if_index));
223 
225 
226  /* *INDENT-OFF* */
227  REPLY_MACRO2 (VL_API_IP_NEIGHBOR_ADD_DEL_REPLY,
228  ({
229  rmp->stats_index = htonl (stats_index);
230  }));
231  /* *INDENT-ON* */
232 }
233 
234 static void
236  mp)
237 {
238  vl_api_want_ip_neighbor_events_reply_t *rmp;
239  ip46_address_t ip;
240  ip46_type_t itype;
241  int rv = 0;
242 
243  if (mp->sw_if_index != ~0)
245  itype = ip_address_decode (&mp->ip, &ip);
246 
247  ip_neighbor_watcher_t watch = {
248  .ipw_client = mp->client_index,
249  .ipw_pid = mp->pid,
250  };
251 
252  if (mp->enable)
253  ip_neighbor_watch (&ip, itype, ntohl (mp->sw_if_index), &watch);
254  else
255  ip_neighbor_unwatch (&ip, itype, ntohl (mp->sw_if_index), &watch);
256 
258  REPLY_MACRO (VL_API_WANT_IP_NEIGHBOR_EVENTS_REPLY);
259 }
260 
261 static void
263 {
264  vl_api_ip_neighbor_config_reply_t *rmp;
266  int rv;
267 
268  rv = ip_address_family_decode (mp->af, &af);
269 
270  if (!rv)
272  ntohl (mp->max_number),
273  ntohl (mp->max_age), mp->recycle);
274 
275  REPLY_MACRO (VL_API_IP_NEIGHBOR_CONFIG_REPLY);
276 }
277 
278 static void
280  * mp)
281 {
282  vl_api_ip_neighbor_replace_begin_reply_t *rmp;
283  int rv = 0;
284 
287 
288  REPLY_MACRO (VL_API_IP_NEIGHBOR_REPLACE_BEGIN_REPLY);
289 }
290 
291 static void
293  mp)
294 {
295  vl_api_ip_neighbor_replace_end_reply_t *rmp;
296  int rv = 0;
297 
300 
301  REPLY_MACRO (VL_API_IP_NEIGHBOR_REPLACE_END_REPLY);
302 }
303 
304 static void
306 {
307  vl_api_ip_neighbor_flush_reply_t *rmp;
309  int rv;
310 
311  if (mp->sw_if_index != ~0)
313 
314  rv = ip_address_family_decode (mp->af, &af);
315 
316  if (!rv)
318 
320  REPLY_MACRO (VL_API_IP_NEIGHBOR_FLUSH_REPLY);
321 }
322 
323 #define vl_msg_name_crc_list
324 #include <vnet/ip-neighbor/ip_neighbor.api.h>
325 #undef vl_msg_name_crc_list
326 
327 #include <vnet/ip-neighbor/ip_neighbor.api.c>
328 
329 static clib_error_t *
331 {
332  /* Ask for a correctly-sized block of API message decode slots */
334 
335  return 0;
336 }
337 
339 
340 /*
341  * fd.io coding-style-patch-verification: ON
342  *
343  * Local Variables:
344  * eval: (c-set-style "gnu")
345  * End:
346  */
int ip_address_family_decode(vl_api_address_family_t af, ip_address_family_t *out)
Conversion functions to/from (decode/encode) API types to VPP internal types.
Definition: ip_types_api.c:34
Enable/disable periodic IP neighbor scan.
static void ip_neighbor_encode(vl_api_ip_neighbor_t *api, const ip_neighbor_t *ipn)
f64 ipn_time_last_updated
Aging related data.
Dump IP neighbors.
Definition: ip_neighbor.api:88
vl_api_mac_address_t mac
Definition: l2.api:502
vl_api_address_family_t af
Definition: ip_neighbor.api:93
void mac_address_encode(const mac_address_t *in, u8 *out)
vl_api_ip_neighbor_t neighbor
Definition: ip_neighbor.api:67
ip46_address_t ipnk_ip
static ip_neighbor_flags_t ip_neighbor_flags_decode(vl_api_ip_neighbor_flags_t v)
void ip_neighbor_del_all(ip46_type_t type, u32 sw_if_index)
Definition: ip_neighbor.c:595
int ip_neighbor_add(const ip46_address_t *ip, ip46_type_t type, const mac_address_t *mac, u32 sw_if_index, ip_neighbor_flags_t flags, u32 *stats_index)
Definition: ip_neighbor.c:453
void ip_neighbor_sweep(ip46_type_t type)
Definition: ip_neighbor.c:1264
#define REPLY_MACRO2(t, body)
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:291
static void vl_api_send_msg(vl_api_registration_t *rp, u8 *elem)
Definition: api.h:35
static walk_rc_t send_ip_neighbor_details(index_t ipni, void *arg)
u32 index_t
A Data-Path Object is an object that represents actions that are applied to packets are they are swit...
Definition: dpo.h:41
vl_api_interface_index_t sw_if_index[default=0xffffffff]
int ip_neighbor_config(ip46_type_t type, u32 limit, u32 age, bool recycle)
Definition: ip_neighbor.c:1675
void * vl_msg_api_alloc(int nbytes)
unsigned char u8
Definition: types.h:56
double f64
Definition: types.h:142
int ip_neighbor_del(const ip46_address_t *ip, ip46_type_t type, u32 sw_if_index)
Definition: ip_neighbor.c:552
enum walk_rc_t_ walk_rc_t
Walk return code.
static int vl_api_can_send_msg(vl_api_registration_t *rp)
Definition: api.h:48
vl_api_interface_index_t sw_if_index
Definition: gre.api:53
static void vl_api_ip_neighbor_config_t_handler(vl_api_ip_neighbor_config_t *mp)
A representation of an IP neighbour/peer.
void ip_neighbor_handle_event(const ip_neighbor_event_t *ipne)
From the watcher to the API to publish a new neighbor.
static void vl_api_ip_neighbor_add_del_t_handler(vl_api_ip_neighbor_add_del_t *mp, vlib_main_t *vm)
unsigned int u32
Definition: types.h:88
ip46_type_t ip_address_decode(const vl_api_address_t *in, ip46_address_t *out)
Decode/Encode for struct/union types.
Definition: ip_types_api.c:160
void ip_neighbor_watch(const ip46_address_t *ip, ip46_type_t type, u32 sw_if_index, const ip_neighbor_watcher_t *watch)
vl_api_fib_path_type_t type
Definition: fib_types.api:123
static clib_error_t * ip_neighbor_api_init(vlib_main_t *vm)
vl_api_interface_index_t sw_if_index[default=0xffffffff]
void ip_neighbor_mark(ip46_type_t type)
Definition: ip_neighbor.c:1237
VLIB_API_INIT_FUNCTION(ip_neighbor_api_init)
long ctx[MAX_CONNS]
Definition: main.c:144
unsigned short u16
Definition: types.h:57
static u16 msg_id_base
#define REPLY_MACRO(t)
mac_address_t ipn_mac
The learned MAC address of the neighbour.
static void vl_api_ip_neighbor_flush_t_handler(vl_api_ip_neighbor_flush_t *mp)
vlib_main_t * vm
Definition: in2out_ed.c:1599
format_function_t format_ip46_address
Definition: ip46_address.h:50
An API client registration, only in vpp/vlib.
Definition: api_common.h:47
static void vl_api_want_ip_neighbor_events_t_handler(vl_api_want_ip_neighbor_events_t *mp)
#define BAD_SW_IF_INDEX_LABEL
u32 flags
Definition: vhost_user.h:248
vl_api_registration_t * reg
void ip_neighbor_walk(ip46_type_t type, u32 sw_if_index, ip_neighbor_walk_cb_t cb, void *ctx)
Definition: ip_neighbor.c:1034
#define clib_warning(format, args...)
Definition: error.h:59
IP neighbor add / del reply.
Definition: ip_neighbor.api:75
Tell client about an IP4 ARP resolution event or MAC/IP info from ARP requests in L2 BDs...
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:57
static void vl_api_ip_neighbor_replace_end_t_handler(vl_api_ip_neighbor_replace_end_t *mp)
static vl_api_ip_neighbor_flags_t ip_neighbor_flags_encode(ip_neighbor_flags_t f)
u32 stats_index
Definition: ip.api:143
IP neighbor add / del request.
Definition: ip_neighbor.api:61
static f64 clib_host_to_net_f64(f64 x)
Definition: byte_order.h:216
#define REPLY_MSG_ID_BASE
ip_neighbor_key_t * ipn_key
The idempotent key.
static void vl_api_ip_neighbor_dump_t_handler(vl_api_ip_neighbor_dump_t *mp)
IP neighbour replace end.
IP neighbors dump response.
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
enum ip_address_family_t_ ip_address_family_t
vl_api_ip_neighbor_t neighbor
vl_api_address_t ip
Definition: l2.api:501
Register for IP4 ARP resolution event on receiving ARP reply or MAC/IP info from ARP requests in L2 B...
vl_api_ip_neighbor_t neighbor
IP neighbor flush request - removes all neighbours.
struct ip_neighbor_dump_ctx_t_ ip_neighbor_dump_ctx_t
vl_api_interface_index_t sw_if_index[default=0xffffffff]
Definition: ip_neighbor.api:92
ip_neighbor_flags_t ipn_flags
Falgs for this object.
IP neighbour replace begin.
void ip_address_encode(const ip46_address_t *in, ip46_type_t type, vl_api_address_t *out)
Definition: ip_types_api.c:194
static void vl_api_ip_neighbor_replace_begin_t_handler(vl_api_ip_neighbor_replace_begin_t *mp)
ip_neighbor_t * ip_neighbor_get(index_t ipni)
Definition: ip_neighbor.c:88
vl_api_address_family_t af
static void setup_message_id_table(snat_main_t *sm, api_main_t *am)
Definition: nat_api.c:3256
vl_api_address_family_t af
static ip46_type_t ip46_type_from_af(ip_address_family_t af)
import vnet interface_types api
Definition: sample.api:20
enum ip_neighbor_flags_t_ ip_neighbor_flags_t
void mac_address_decode(const u8 *in, mac_address_t *out)
Conversion functions to/from (decode/encode) API types to VPP internal types.
#define ip46_address_initializer
Definition: ip46_address.h:52
ip_neighbor_watcher_t ipne_watch
#define VALIDATE_SW_IF_INDEX(mp)
ip46_type_t
Definition: ip46_address.h:22
void ip_neighbor_unwatch(const ip46_address_t *ip, ip46_type_t type, u32 sw_if_index, const ip_neighbor_watcher_t *watch)