libnl 1.1.4
neightbl.c
1/*
2 * lib/route/neightbl.c neighbour tables
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation version 2.1
7 * of the License.
8 *
9 * Copyright (c) 2003-2006 Thomas Graf <tgraf@suug.ch>
10 */
11
12/**
13 * @ingroup rtnl
14 * @defgroup neightbl Neighbour Tables
15 * @brief
16 * @{
17 */
18
19#include <netlink-local.h>
20#include <netlink/netlink.h>
21#include <netlink/utils.h>
22#include <netlink/route/rtnl.h>
23#include <netlink/route/neightbl.h>
24#include <netlink/route/link.h>
25
26/** @cond SKIP */
27#define NEIGHTBL_ATTR_FAMILY 0x001
28#define NEIGHTBL_ATTR_STATS 0x002
29#define NEIGHTBL_ATTR_NAME 0x004
30#define NEIGHTBL_ATTR_THRESH1 0x008
31#define NEIGHTBL_ATTR_THRESH2 0x010
32#define NEIGHTBL_ATTR_THRESH3 0x020
33#define NEIGHTBL_ATTR_CONFIG 0x040
34#define NEIGHTBL_ATTR_PARMS 0x080
35#define NEIGHTBL_ATTR_GC_INTERVAL 0x100
36
37#define NEIGHTBLPARM_ATTR_IFINDEX 0x0001
38#define NEIGHTBLPARM_ATTR_REFCNT 0x0002
39#define NEIGHTBLPARM_ATTR_QUEUE_LEN 0x0004
40#define NEIGHTBLPARM_ATTR_APP_PROBES 0x0008
41#define NEIGHTBLPARM_ATTR_UCAST_PROBES 0x0010
42#define NEIGHTBLPARM_ATTR_MCAST_PROBES 0x0020
43#define NEIGHTBLPARM_ATTR_PROXY_QLEN 0x0040
44#define NEIGHTBLPARM_ATTR_REACHABLE_TIME 0x0080
45#define NEIGHTBLPARM_ATTR_BASE_REACHABLE_TIME 0x0100
46#define NEIGHTBLPARM_ATTR_RETRANS_TIME 0x0200
47#define NEIGHTBLPARM_ATTR_GC_STALETIME 0x0400
48#define NEIGHTBLPARM_ATTR_DELAY_PROBE_TIME 0x0800
49#define NEIGHTBLPARM_ATTR_ANYCAST_DELAY 0x1000
50#define NEIGHTBLPARM_ATTR_PROXY_DELAY 0x2000
51#define NEIGHTBLPARM_ATTR_LOCKTIME 0x4000
52
53static struct nl_cache_ops rtnl_neightbl_ops;
54static struct nl_object_ops neightbl_obj_ops;
55/** @endcond */
56
57static int neightbl_compare(struct nl_object *_a, struct nl_object *_b,
58 uint32_t attrs, int flags)
59{
60 struct rtnl_neightbl *a = (struct rtnl_neightbl *) _a;
61 struct rtnl_neightbl *b = (struct rtnl_neightbl *) _b;
62 int diff = 0;
63
64#define NT_DIFF(ATTR, EXPR) ATTR_DIFF(attrs, NEIGHTBL_ATTR_##ATTR, a, b, EXPR)
65
66 diff |= NT_DIFF(FAMILY, a->nt_family != b->nt_family);
67 diff |= NT_DIFF(NAME, strcmp(a->nt_name, b->nt_name));
68 diff |= NT_DIFF(THRESH1, a->nt_gc_thresh1 != b->nt_gc_thresh1);
69 diff |= NT_DIFF(THRESH2, a->nt_gc_thresh2 != b->nt_gc_thresh2);
70 diff |= NT_DIFF(THRESH3, a->nt_gc_thresh3 != b->nt_gc_thresh3);
71 diff |= NT_DIFF(GC_INTERVAL, a->nt_gc_interval != b->nt_gc_interval);
72
73#undef NT_DIFF
74
75 if (!(a->ce_mask & NEIGHTBL_ATTR_PARMS) &&
76 !(b->ce_mask & NEIGHTBL_ATTR_PARMS))
77 return diff;
78
79 /* XXX: FIXME: Compare parameter table */
80
81
82#if 0
83#define REQ(F) (fp->ntp_mask & NEIGHTBLPARM_ATTR_##F)
84#define AVAIL(F) (op->ntp_mask & NEIGHTBLPARM_ATTR_##F)
85#define _C(F, N) (REQ(F) && (!AVAIL(F) || (op->N != fp->N)))
86 if (_C(IFINDEX, ntp_ifindex) ||
87 _C(QUEUE_LEN, ntp_queue_len) ||
88 _C(APP_PROBES, ntp_app_probes) ||
89 _C(UCAST_PROBES, ntp_ucast_probes) ||
90 _C(MCAST_PROBES, ntp_mcast_probes) ||
91 _C(PROXY_QLEN, ntp_proxy_qlen) ||
92 _C(LOCKTIME, ntp_locktime) ||
93 _C(RETRANS_TIME, ntp_retrans_time) ||
94 _C(BASE_REACHABLE_TIME, ntp_base_reachable_time) ||
95 _C(GC_STALETIME, ntp_gc_stale_time) ||
96 _C(DELAY_PROBE_TIME, ntp_probe_delay) ||
97 _C(ANYCAST_DELAY, ntp_anycast_delay) ||
98 _C(PROXY_DELAY, ntp_proxy_delay))
99 return 0;
100#undef REQ
101#undef AVAIL
102#undef _C
103#endif
104
105 return diff;
106}
107
108
109static struct nla_policy neightbl_policy[NDTA_MAX+1] = {
110 [NDTA_NAME] = { .type = NLA_STRING,
111 .maxlen = NTBLNAMSIZ },
112 [NDTA_THRESH1] = { .type = NLA_U32 },
113 [NDTA_THRESH2] = { .type = NLA_U32 },
114 [NDTA_THRESH3] = { .type = NLA_U32 },
115 [NDTA_GC_INTERVAL] = { .type = NLA_U32 },
116 [NDTA_CONFIG] = { .minlen = sizeof(struct ndt_config) },
117 [NDTA_STATS] = { .minlen = sizeof(struct ndt_stats) },
118 [NDTA_PARMS] = { .type = NLA_NESTED },
119};
120
121static int neightbl_msg_parser(struct nl_cache_ops *ops,
122 struct sockaddr_nl *who, struct nlmsghdr *n,
123 struct nl_parser_param *pp)
124{
125 struct rtnl_neightbl *ntbl;
126 struct nlattr *tb[NDTA_MAX + 1];
127 struct rtgenmsg *rtmsg;
128 int err;
129
130 ntbl = rtnl_neightbl_alloc();
131 if (!ntbl) {
132 err = nl_errno(ENOMEM);
133 goto errout;
134 }
135
136 ntbl->ce_msgtype = n->nlmsg_type;
137 rtmsg = nlmsg_data(n);
138
139 err = nlmsg_parse(n, sizeof(*rtmsg), tb, NDTA_MAX, neightbl_policy);
140 if (err < 0)
141 goto errout;
142
143 ntbl->nt_family = rtmsg->rtgen_family;
144
145 if (tb[NDTA_NAME] == NULL) {
146 err = nl_error(EINVAL, "NDTA_NAME is missing");
147 goto errout;
148 }
149
150 nla_strlcpy(ntbl->nt_name, tb[NDTA_NAME], NTBLNAMSIZ);
151 ntbl->ce_mask |= NEIGHTBL_ATTR_NAME;
152
153 if (tb[NDTA_THRESH1]) {
154 ntbl->nt_gc_thresh1 = nla_get_u32(tb[NDTA_THRESH1]);
155 ntbl->ce_mask |= NEIGHTBL_ATTR_THRESH1;
156 }
157
158 if (tb[NDTA_THRESH2]) {
159 ntbl->nt_gc_thresh2 = nla_get_u32(tb[NDTA_THRESH2]);
160 ntbl->ce_mask |= NEIGHTBL_ATTR_THRESH2;
161 }
162
163 if (tb[NDTA_THRESH3]) {
164 ntbl->nt_gc_thresh3 = nla_get_u32(tb[NDTA_THRESH3]);
165 ntbl->ce_mask |= NEIGHTBL_ATTR_THRESH3;
166 }
167
168 if (tb[NDTA_GC_INTERVAL]) {
169 ntbl->nt_gc_interval = nla_get_u32(tb[NDTA_GC_INTERVAL]);
170 ntbl->ce_mask |= NEIGHTBL_ATTR_GC_INTERVAL;
171 }
172
173 if (tb[NDTA_CONFIG]) {
174 nla_memcpy(&ntbl->nt_config, tb[NDTA_CONFIG],
175 sizeof(ntbl->nt_config));
176 ntbl->ce_mask |= NEIGHTBL_ATTR_CONFIG;
177 }
178
179 if (tb[NDTA_STATS]) {
180 nla_memcpy(&ntbl->nt_stats, tb[NDTA_STATS],
181 sizeof(ntbl->nt_stats));
182 ntbl->ce_mask |= NEIGHTBL_ATTR_STATS;
183 }
184
185 if (tb[NDTA_PARMS]) {
186 struct nlattr *tbp[NDTPA_MAX + 1];
187 struct rtnl_neightbl_parms *p = &ntbl->nt_parms;
188
189 err = nla_parse_nested(tbp, NDTPA_MAX, tb[NDTA_PARMS], NULL);
190 if (err < 0)
191 goto errout;
192
193#define COPY_ENTRY(name, var) \
194 if (tbp[NDTPA_ ##name]) { \
195 p->ntp_ ##var = nla_get_u32(tbp[NDTPA_ ##name]); \
196 p->ntp_mask |= NEIGHTBLPARM_ATTR_ ##name; \
197 }
198
199 COPY_ENTRY(IFINDEX, ifindex);
200 COPY_ENTRY(REFCNT, refcnt);
201 COPY_ENTRY(QUEUE_LEN, queue_len);
202 COPY_ENTRY(APP_PROBES, app_probes);
203 COPY_ENTRY(UCAST_PROBES, ucast_probes);
204 COPY_ENTRY(MCAST_PROBES, mcast_probes);
205 COPY_ENTRY(PROXY_QLEN, proxy_qlen);
206 COPY_ENTRY(PROXY_DELAY, proxy_delay);
207 COPY_ENTRY(ANYCAST_DELAY, anycast_delay);
208 COPY_ENTRY(LOCKTIME, locktime);
209 COPY_ENTRY(REACHABLE_TIME, reachable_time);
210 COPY_ENTRY(BASE_REACHABLE_TIME, base_reachable_time);
211 COPY_ENTRY(RETRANS_TIME, retrans_time);
212 COPY_ENTRY(GC_STALETIME, gc_stale_time);
213 COPY_ENTRY(DELAY_PROBE_TIME, probe_delay);
214#undef COPY_ENTRY
215
216 ntbl->ce_mask |= NEIGHTBL_ATTR_PARMS;
217 }
218
219 err = pp->pp_cb((struct nl_object *) ntbl, pp);
220 if (err < 0)
221 goto errout;
222
223 err = P_ACCEPT;
224errout:
225 rtnl_neightbl_put(ntbl);
226 return err;
227}
228
229static int neightbl_request_update(struct nl_cache *c, struct nl_handle *h)
230{
231 return nl_rtgen_request(h, RTM_GETNEIGHTBL, AF_UNSPEC, NLM_F_DUMP);
232}
233
234
235static int neightbl_dump_brief(struct nl_object *arg, struct nl_dump_params *p)
236{
237 int line = 1;
238 struct rtnl_neightbl *ntbl = (struct rtnl_neightbl *) arg;
239
240 dp_dump(p, "%s", ntbl->nt_name);
241
242 if (ntbl->nt_parms.ntp_mask & NEIGHTBLPARM_ATTR_IFINDEX) {
243 struct nl_cache *link_cache;
244
245 link_cache = nl_cache_mngt_require("route/link");
246
247 if (link_cache) {
248 char buf[32];
249 dp_dump(p, "<%s> ",
250 rtnl_link_i2name(link_cache,
251 ntbl->nt_parms.ntp_ifindex,
252 buf, sizeof(buf)));
253 } else
254 dp_dump(p, "<%u> ", ntbl->nt_parms.ntp_ifindex);
255 } else
256 dp_dump(p, " ");
257
258 if (ntbl->ce_mask & NEIGHTBL_ATTR_CONFIG)
259 dp_dump(p, "entries %u ", ntbl->nt_config.ndtc_entries);
260
261 if (ntbl->ce_mask & NEIGHTBL_ATTR_PARMS) {
262 char rt[32], rt2[32];
263 struct rtnl_neightbl_parms *pa = &ntbl->nt_parms;
264
265 dp_dump(p, "reachable-time %s retransmit-time %s",
266 nl_msec2str(pa->ntp_reachable_time, rt, sizeof(rt)),
267 nl_msec2str(pa->ntp_retrans_time, rt2, sizeof(rt2)));
268 }
269
270 dp_dump(p, "\n");
271
272 return line;
273}
274
275static int neightbl_dump_full(struct nl_object *arg, struct nl_dump_params *p)
276{
277 char x[32], y[32], z[32];
278 struct rtnl_neightbl *ntbl = (struct rtnl_neightbl *) arg;
279
280 int line = neightbl_dump_brief(arg, p);
281
282 if (ntbl->ce_mask & NEIGHTBL_ATTR_CONFIG) {
283 dp_new_line(p, line++);
284 dp_dump(p, " key-len %u entry-size %u last-flush %s\n",
285 ntbl->nt_config.ndtc_key_len,
286 ntbl->nt_config.ndtc_entry_size,
287 nl_msec2str(ntbl->nt_config.ndtc_last_flush,
288 x, sizeof(x)));
289
290 dp_new_line(p, line++);
291 dp_dump(p, " gc threshold %u/%u/%u interval %s " \
292 "chain-position %u\n",
293 ntbl->nt_gc_thresh1, ntbl->nt_gc_thresh2,
294 ntbl->nt_gc_thresh3,
295 nl_msec2str(ntbl->nt_gc_interval, x, sizeof(x)),
296 ntbl->nt_config.ndtc_hash_chain_gc);
297
298 dp_new_line(p, line++);
299 dp_dump(p, " hash-rand 0x%08X/0x%08X last-rand %s\n",
300 ntbl->nt_config.ndtc_hash_rnd,
301 ntbl->nt_config.ndtc_hash_mask,
302 nl_msec2str(ntbl->nt_config.ndtc_last_rand,
303 x, sizeof(x)));
304 }
305
306 if (ntbl->ce_mask & NEIGHTBL_ATTR_PARMS) {
307 struct rtnl_neightbl_parms *pa = &ntbl->nt_parms;
308
309 dp_new_line(p, line++);
310 dp_dump(p, " refcnt %u pending-queue-limit %u " \
311 "proxy-delayed-queue-limit %u\n",
312 pa->ntp_refcnt,
313 pa->ntp_queue_len,
314 pa->ntp_proxy_qlen);
315
316 dp_new_line(p, line++);
317 dp_dump(p, " num-userspace-probes %u num-unicast-probes " \
318 "%u num-multicast-probes %u\n",
319 pa->ntp_app_probes,
320 pa->ntp_ucast_probes,
321 pa->ntp_mcast_probes);
322
323 dp_new_line(p, line++);
324 dp_dump(p, " min-age %s base-reachable-time %s " \
325 "stale-check-interval %s\n",
326 nl_msec2str(pa->ntp_locktime, x, sizeof(x)),
327 nl_msec2str(pa->ntp_base_reachable_time,
328 y, sizeof(y)),
329 nl_msec2str(pa->ntp_gc_stale_time, z, sizeof(z)));
330
331 dp_new_line(p, line++);
332 dp_dump(p, " initial-probe-delay %s answer-delay %s " \
333 "proxy-answer-delay %s\n",
334 nl_msec2str(pa->ntp_probe_delay, x, sizeof(x)),
335 nl_msec2str(pa->ntp_anycast_delay, y, sizeof(y)),
336 nl_msec2str(pa->ntp_proxy_delay, z, sizeof(z)));
337 }
338
339 return line;
340}
341
342static int neightbl_dump_stats(struct nl_object *arg, struct nl_dump_params *p)
343{
344 struct rtnl_neightbl *ntbl = (struct rtnl_neightbl *) arg;
345 int line = neightbl_dump_full(arg, p);
346
347 if (!(ntbl->ce_mask & NEIGHTBL_ATTR_STATS))
348 return line;
349
350 dp_new_line(p, line++);
351 dp_dump(p, " lookups %lld hits %lld failed %lld " \
352 "allocations %lld destroys %lld\n",
353 ntbl->nt_stats.ndts_lookups,
354 ntbl->nt_stats.ndts_hits,
355 ntbl->nt_stats.ndts_res_failed,
356 ntbl->nt_stats.ndts_allocs,
357 ntbl->nt_stats.ndts_destroys);
358
359 dp_new_line(p, line++);
360 dp_dump(p, " hash-grows %lld forced-gc-runs %lld " \
361 "periodic-gc-runs %lld\n",
362 ntbl->nt_stats.ndts_hash_grows,
363 ntbl->nt_stats.ndts_forced_gc_runs,
364 ntbl->nt_stats.ndts_periodic_gc_runs);
365
366 dp_dump(p, " rcv-unicast-probes %lld rcv-multicast-probes %lld\n",
367 ntbl->nt_stats.ndts_rcv_probes_ucast,
368 ntbl->nt_stats.ndts_rcv_probes_mcast);
369
370 return line;
371}
372
373/**
374 * @name Allocation/Freeing
375 * @{
376 */
377
378struct rtnl_neightbl *rtnl_neightbl_alloc(void)
379{
380 return (struct rtnl_neightbl *) nl_object_alloc(&neightbl_obj_ops);
381}
382
383void rtnl_neightbl_put(struct rtnl_neightbl *neightbl)
384{
385 nl_object_put((struct nl_object *) neightbl);
386}
387
388/** @} */
389
390/**
391 * @name Neighbour Table Cache Management
392 * @{
393 */
394
395/**
396 * Build a neighbour table cache including all neighbour tables currently configured in the kernel.
397 * @arg handle netlink handle
398 *
399 * Allocates a new neighbour table cache, initializes it properly and
400 * updates it to include all neighbour tables currently configured in
401 * the kernel.
402 *
403 * @note The caller is responsible for destroying and freeing the
404 * cache after using it.
405 * @return The new cache or NULL if an error occured.
406 */
407struct nl_cache * rtnl_neightbl_alloc_cache(struct nl_handle *handle)
408{
409 struct nl_cache * cache;
410
411 cache = nl_cache_alloc(&rtnl_neightbl_ops);
412 if (cache == NULL)
413 return NULL;
414
415 if (handle && nl_cache_refill(handle, cache) < 0) {
416 nl_cache_free(cache);
417 return NULL;
418 }
419
420 return cache;
421}
422
423/**
424 * Lookup neighbour table by name and optional interface index
425 * @arg cache neighbour table cache
426 * @arg name name of table
427 * @arg ifindex optional interface index
428 *
429 * Looks up the neighbour table matching the specified name and
430 * optionally the specified ifindex to retrieve device specific
431 * parameter sets.
432 *
433 * @return ptr to neighbour table inside the cache or NULL if no
434 * match was found.
435 */
436struct rtnl_neightbl *rtnl_neightbl_get(struct nl_cache *cache,
437 const char *name, int ifindex)
438{
439 struct rtnl_neightbl *nt;
440
441 if (cache->c_ops != &rtnl_neightbl_ops)
442 return NULL;
443
444 nl_list_for_each_entry(nt, &cache->c_items, ce_list) {
445 if (!strcasecmp(nt->nt_name, name) &&
446 ((!ifindex && !nt->nt_parms.ntp_ifindex) ||
447 (ifindex && ifindex == nt->nt_parms.ntp_ifindex))) {
448 nl_object_get((struct nl_object *) nt);
449 return nt;
450 }
451 }
452
453 return NULL;
454}
455
456/** @} */
457
458/**
459 * @name Neighbour Table Modifications
460 * @{
461 */
462
463/**
464 * Builds a netlink change request message to change neighbour table attributes
465 * @arg old neighbour table to change
466 * @arg tmpl template with requested changes
467 *
468 * Builds a new netlink message requesting a change of neighbour table
469 * attributes. The netlink message header isn't fully equipped with all
470 * relevant fields and must be sent out via nl_send_auto_complete() or
471 * supplemented as needed.
472 * \a old must point to a neighbour table currently configured in the
473 * kernel and \a tmpl must contain the attributes to be changed set via
474 * \c rtnl_neightbl_set_* functions.
475 *
476 * @return New netlink message
477 */
478struct nl_msg * rtnl_neightbl_build_change_request(struct rtnl_neightbl *old,
479 struct rtnl_neightbl *tmpl)
480{
481 struct nl_msg *m;
482 struct ndtmsg ndt = {
483 .ndtm_family = old->nt_family,
484 };
485
486 m = nlmsg_alloc_simple(RTM_SETNEIGHTBL, 0);
487 nlmsg_append(m, &ndt, sizeof(ndt), NLMSG_ALIGNTO);
488
489 nla_put_string(m, NDTA_NAME, old->nt_name);
490
491 if (tmpl->ce_mask & NEIGHTBL_ATTR_THRESH1)
492 nla_put_u32(m, NDTA_THRESH1, tmpl->nt_gc_thresh1);
493
494 if (tmpl->ce_mask & NEIGHTBL_ATTR_THRESH2)
495 nla_put_u32(m, NDTA_THRESH2, tmpl->nt_gc_thresh2);
496
497 if (tmpl->ce_mask & NEIGHTBL_ATTR_THRESH2)
498 nla_put_u32(m, NDTA_THRESH2, tmpl->nt_gc_thresh2);
499
500 if (tmpl->ce_mask & NEIGHTBL_ATTR_GC_INTERVAL)
501 nla_put_u64(m, NDTA_GC_INTERVAL,
502 tmpl->nt_gc_interval);
503
504 if (tmpl->ce_mask & NEIGHTBL_ATTR_PARMS) {
505 struct rtnl_neightbl_parms *p = &tmpl->nt_parms;
506 struct nl_msg *parms = nlmsg_alloc();
507
508 if (old->nt_parms.ntp_mask & NEIGHTBLPARM_ATTR_IFINDEX)
509 nla_put_u32(parms, NDTPA_IFINDEX,
510 old->nt_parms.ntp_ifindex);
511
512
513 if (p->ntp_mask & NEIGHTBLPARM_ATTR_QUEUE_LEN)
514 nla_put_u32(parms, NDTPA_QUEUE_LEN, p->ntp_queue_len);
515
516 if (p->ntp_mask & NEIGHTBLPARM_ATTR_APP_PROBES)
517 nla_put_u32(parms, NDTPA_APP_PROBES, p->ntp_app_probes);
518
519 if (p->ntp_mask & NEIGHTBLPARM_ATTR_UCAST_PROBES)
520 nla_put_u32(parms, NDTPA_UCAST_PROBES,
521 p->ntp_ucast_probes);
522
523 if (p->ntp_mask & NEIGHTBLPARM_ATTR_MCAST_PROBES)
524 nla_put_u32(parms, NDTPA_MCAST_PROBES,
525 p->ntp_mcast_probes);
526
527 if (p->ntp_mask & NEIGHTBLPARM_ATTR_PROXY_QLEN)
528 nla_put_u32(parms, NDTPA_PROXY_QLEN,
529 p->ntp_proxy_qlen);
530
531 if (p->ntp_mask & NEIGHTBLPARM_ATTR_BASE_REACHABLE_TIME)
532 nla_put_u64(parms, NDTPA_BASE_REACHABLE_TIME,
533 p->ntp_base_reachable_time);
534
535 if (p->ntp_mask & NEIGHTBLPARM_ATTR_RETRANS_TIME)
536 nla_put_u64(parms, NDTPA_RETRANS_TIME,
537 p->ntp_retrans_time);
538
539 if (p->ntp_mask & NEIGHTBLPARM_ATTR_GC_STALETIME)
540 nla_put_u64(parms, NDTPA_GC_STALETIME,
541 p->ntp_gc_stale_time);
542
543 if (p->ntp_mask & NEIGHTBLPARM_ATTR_DELAY_PROBE_TIME)
544 nla_put_u64(parms, NDTPA_DELAY_PROBE_TIME,
545 p->ntp_proxy_delay);
546
547 if (p->ntp_mask & NEIGHTBLPARM_ATTR_ANYCAST_DELAY)
548 nla_put_u64(parms, NDTPA_ANYCAST_DELAY,
549 p->ntp_anycast_delay);
550
551 if (p->ntp_mask & NEIGHTBLPARM_ATTR_PROXY_DELAY)
552 nla_put_u64(parms, NDTPA_PROXY_DELAY,
553 p->ntp_proxy_delay);
554
555 if (p->ntp_mask & NEIGHTBLPARM_ATTR_LOCKTIME)
556 nla_put_u64(parms, NDTPA_LOCKTIME, p->ntp_locktime);
557
558 nla_put_nested(m, NDTA_PARMS, parms);
559 nlmsg_free(parms);
560 }
561
562 return m;
563}
564
565/**
566 * Change neighbour table attributes
567 * @arg handle netlink handle
568 * @arg old neighbour table to be changed
569 * @arg tmpl template with requested changes
570 *
571 * Builds a new netlink message by calling
572 * rtnl_neightbl_build_change_request(), sends the request to the
573 * kernel and waits for the next ACK to be received, i.e. blocks
574 * until the request has been processed.
575 *
576 * @return 0 on success or a negative error code
577 */
578int rtnl_neightbl_change(struct nl_handle *handle, struct rtnl_neightbl *old,
579 struct rtnl_neightbl *tmpl)
580{
581 int err;
582 struct nl_msg *msg;
583
584 msg = rtnl_neightbl_build_change_request(old, tmpl);
585 err = nl_send_auto_complete(handle, msg);
586 nlmsg_free(msg);
587 if (err < 0)
588 return err;
589
590 return nl_wait_for_ack(handle);
591}
592
593/** @} */
594
595/**
596 * @name Attribute Modification
597 * @{
598 */
599
600void rtnl_neightbl_set_family(struct rtnl_neightbl *ntbl, int family)
601{
602 ntbl->nt_family = family;
603 ntbl->ce_mask |= NEIGHTBL_ATTR_FAMILY;
604}
605
606void rtnl_neightbl_set_gc_interval(struct rtnl_neightbl *ntbl, uint64_t ms)
607{
608 ntbl->nt_gc_interval = ms;
609 ntbl->ce_mask |= NEIGHTBL_ATTR_GC_INTERVAL;
610}
611
612void rtnl_neightbl_set_gc_tresh1(struct rtnl_neightbl *ntbl, int thresh)
613{
614 ntbl->nt_gc_thresh1 = thresh;
615 ntbl->ce_mask |= NEIGHTBL_ATTR_THRESH1;
616}
617
618void rtnl_neightbl_set_gc_tresh2(struct rtnl_neightbl *ntbl, int thresh)
619{
620 ntbl->nt_gc_thresh2 = thresh;
621 ntbl->ce_mask |= NEIGHTBL_ATTR_THRESH2;
622}
623
624void rtnl_neightbl_set_gc_tresh3(struct rtnl_neightbl *ntbl, int thresh)
625{
626 ntbl->nt_gc_thresh3 = thresh;
627 ntbl->ce_mask |= NEIGHTBL_ATTR_THRESH3;
628}
629
630void rtnl_neightbl_set_name(struct rtnl_neightbl *ntbl, const char *name)
631{
632 strncpy(ntbl->nt_name, name, sizeof(ntbl->nt_name) - 1);
633 ntbl->ce_mask |= NEIGHTBL_ATTR_NAME;
634}
635
636void rtnl_neightbl_set_dev(struct rtnl_neightbl *ntbl, int ifindex)
637{
638 ntbl->nt_parms.ntp_ifindex = ifindex;
639 ntbl->nt_parms.ntp_mask |= NEIGHTBLPARM_ATTR_IFINDEX;
640 ntbl->ce_mask |= NEIGHTBL_ATTR_PARMS;
641}
642
643/**
644 * Set the queue length for pending requests of a neighbour table to the specified value
645 * @arg ntbl neighbour table to change
646 * @arg len new queue len
647 */
648void rtnl_neightbl_set_queue_len(struct rtnl_neightbl *ntbl, int len)
649{
650 ntbl->nt_parms.ntp_queue_len = len;
651 ntbl->nt_parms.ntp_mask |= NEIGHTBLPARM_ATTR_QUEUE_LEN;
652 ntbl->ce_mask |= NEIGHTBL_ATTR_PARMS;
653}
654
655/**
656 * Set the queue length for delay proxy arp requests of a neighbour table to the specified value
657 * @arg ntbl neighbour table to change
658 * @arg len new queue len
659 */
660void rtnl_neightbl_set_proxy_queue_len(struct rtnl_neightbl *ntbl, int len)
661{
662 ntbl->nt_parms.ntp_proxy_qlen = len;
663 ntbl->nt_parms.ntp_mask |= NEIGHTBLPARM_ATTR_PROXY_QLEN;
664 ntbl->ce_mask |= NEIGHTBL_ATTR_PARMS;
665}
666
667/**
668 * Set the number of application probes of a neighbour table to the specified value
669 * @arg ntbl neighbour table to change
670 * @arg probes new probes value
671 */
672void rtnl_neightbl_set_app_probes(struct rtnl_neightbl *ntbl, int probes)
673{
674 ntbl->nt_parms.ntp_app_probes = probes;
675 ntbl->nt_parms.ntp_mask |= NEIGHTBLPARM_ATTR_APP_PROBES;
676 ntbl->ce_mask |= NEIGHTBL_ATTR_PARMS;
677}
678
679/**
680 * Set the number of unicast probes of a neighbour table to the specified value
681 * @arg ntbl neighbour table to change
682 * @arg probes new probes value
683 */
684void rtnl_neightbl_set_ucast_probes(struct rtnl_neightbl *ntbl, int probes)
685{
686 ntbl->nt_parms.ntp_ucast_probes = probes;
687 ntbl->nt_parms.ntp_mask |= NEIGHTBLPARM_ATTR_UCAST_PROBES;
688 ntbl->ce_mask |= NEIGHTBL_ATTR_PARMS;
689}
690
691/**
692 * Set the number of multicast probes of a neighbour table to the specified value
693 * @arg ntbl neighbour table to change
694 * @arg probes new probes value
695 */
696void rtnl_neightbl_set_mcast_probes(struct rtnl_neightbl *ntbl, int probes)
697{
698 ntbl->nt_parms.ntp_mcast_probes = probes;
699 ntbl->nt_parms.ntp_mask |= NEIGHTBLPARM_ATTR_MCAST_PROBES;
700 ntbl->ce_mask |= NEIGHTBL_ATTR_PARMS;
701}
702
703/**
704 * Set the base reachable time of a neighbour table to the specified value
705 * @arg ntbl neighbour table to change
706 * @arg ms new base reachable time in milliseconds
707 */
708void rtnl_neightbl_set_base_reachable_time(struct rtnl_neightbl *ntbl,
709 uint64_t ms)
710{
711 ntbl->nt_parms.ntp_base_reachable_time = ms;
712 ntbl->nt_parms.ntp_mask |= NEIGHTBLPARM_ATTR_BASE_REACHABLE_TIME;
713 ntbl->ce_mask |= NEIGHTBL_ATTR_PARMS;
714}
715
716/**
717 * Set the retransmit time of a neighbour table to the specified value
718 * @arg ntbl neighbour table to change
719 * @arg ms new retransmit time
720 */
721void rtnl_neightbl_set_retrans_time(struct rtnl_neightbl *ntbl, uint64_t ms)
722{
723 ntbl->nt_parms.ntp_retrans_time = ms;
724 ntbl->nt_parms.ntp_mask |= NEIGHTBLPARM_ATTR_RETRANS_TIME;
725 ntbl->ce_mask |= NEIGHTBL_ATTR_PARMS;
726}
727
728/**
729 * Set the gc stale time of a neighbour table to the specified value
730 * @arg ntbl neighbour table to change
731 * @arg ms new gc stale time in milliseconds
732 */
733void rtnl_neightbl_set_gc_stale_time(struct rtnl_neightbl *ntbl, uint64_t ms)
734{
735 ntbl->nt_parms.ntp_gc_stale_time = ms;
736 ntbl->nt_parms.ntp_mask |= NEIGHTBLPARM_ATTR_GC_STALETIME;
737 ntbl->ce_mask |= NEIGHTBL_ATTR_PARMS;
738}
739
740/**
741 * Set the first probe delay time of a neighbour table to the specified value
742 * @arg ntbl neighbour table to change
743 * @arg ms new first probe delay time in milliseconds
744 */
745void rtnl_neightbl_set_delay_probe_time(struct rtnl_neightbl *ntbl, uint64_t ms)
746{
747 ntbl->nt_parms.ntp_probe_delay = ms;
748 ntbl->nt_parms.ntp_mask |= NEIGHTBLPARM_ATTR_DELAY_PROBE_TIME;
749 ntbl->ce_mask |= NEIGHTBL_ATTR_PARMS;
750}
751
752/**
753 * Set the anycast delay of a neighbour table to the specified value
754 * @arg ntbl neighbour table to change
755 * @arg ms new anycast delay in milliseconds
756 */
757void rtnl_neightbl_set_anycast_delay(struct rtnl_neightbl *ntbl, uint64_t ms)
758{
759 ntbl->nt_parms.ntp_anycast_delay = ms;
760 ntbl->nt_parms.ntp_mask |= NEIGHTBLPARM_ATTR_ANYCAST_DELAY;
761 ntbl->ce_mask |= NEIGHTBL_ATTR_PARMS;
762}
763
764/**
765 * Set the proxy delay of a neighbour table to the specified value
766 * @arg ntbl neighbour table to change
767 * @arg ms new proxy delay in milliseconds
768 */
769void rtnl_neightbl_set_proxy_delay(struct rtnl_neightbl *ntbl, uint64_t ms)
770{
771 ntbl->nt_parms.ntp_proxy_delay = ms;
772 ntbl->nt_parms.ntp_mask |= NEIGHTBLPARM_ATTR_PROXY_DELAY;
773 ntbl->ce_mask |= NEIGHTBL_ATTR_PARMS;
774}
775
776/**
777 * Set the locktime of a neighbour table to the specified value
778 * @arg ntbl neighbour table to change
779 * @arg ms new locktime in milliseconds
780 */
781void rtnl_neightbl_set_locktime(struct rtnl_neightbl *ntbl, uint64_t ms)
782{
783 ntbl->nt_parms.ntp_locktime = ms;
784 ntbl->nt_parms.ntp_mask |= NEIGHTBLPARM_ATTR_LOCKTIME;
785 ntbl->ce_mask |= NEIGHTBL_ATTR_PARMS;
786}
787
788/** @} */
789
790static struct nl_object_ops neightbl_obj_ops = {
791 .oo_name = "route/neightbl",
792 .oo_size = sizeof(struct rtnl_neightbl),
793 .oo_dump[NL_DUMP_BRIEF] = neightbl_dump_brief,
794 .oo_dump[NL_DUMP_FULL] = neightbl_dump_full,
795 .oo_dump[NL_DUMP_STATS] = neightbl_dump_stats,
796 .oo_compare = neightbl_compare,
797};
798
799static struct nl_cache_ops rtnl_neightbl_ops = {
800 .co_name = "route/neightbl",
801 .co_hdrsize = sizeof(struct rtgenmsg),
802 .co_msgtypes = {
803 { RTM_NEWNEIGHTBL, NL_ACT_NEW, "new" },
804 { RTM_SETNEIGHTBL, NL_ACT_SET, "set" },
805 { RTM_GETNEIGHTBL, NL_ACT_GET, "get" },
806 END_OF_MSGTYPES_LIST,
807 },
808 .co_protocol = NETLINK_ROUTE,
809 .co_request_update = neightbl_request_update,
810 .co_msg_parser = neightbl_msg_parser,
811 .co_obj_ops = &neightbl_obj_ops,
812};
813
814static void __init neightbl_init(void)
815{
816 nl_cache_mngt_register(&rtnl_neightbl_ops);
817}
818
819static void __exit neightbl_exit(void)
820{
821 nl_cache_mngt_unregister(&rtnl_neightbl_ops);
822}
823
824/** @} */
int nla_parse_nested(struct nlattr *tb[], int maxtype, struct nlattr *nla, struct nla_policy *policy)
parse nested attributes
Definition: attr.c:307
int nla_put_u32(struct nl_msg *n, int attrtype, uint32_t value)
Add a u32 netlink attribute to a netlink message.
Definition: attr.c:569
size_t nla_strlcpy(char *dst, const struct nlattr *nla, size_t dstsize)
Copy string attribute payload into a sized buffer.
Definition: attr.c:407
uint32_t nla_get_u32(struct nlattr *nla)
Return payload of u32 attribute.
Definition: attr.c:693
int nla_put_string(struct nl_msg *n, int attrtype, const char *str)
Add a string netlink attribute to a netlink message.
Definition: attr.c:591
int nla_put_u64(struct nl_msg *n, int attrtype, uint64_t value)
Add a u64 netlink attribute to a netlink message.
Definition: attr.c:580
int nla_memcpy(void *dest, struct nlattr *src, int count)
Copy a netlink attribute into another memory area.
Definition: attr.c:382
int nla_put_nested(struct nl_msg *n, int attrtype, struct nl_msg *nested)
Add a nested netlink attribute to a netlink message.
Definition: attr.c:535
@ NLA_STRING
character string
Definition: attr.h:41
@ NLA_NESTED
nested attributes
Definition: attr.h:44
@ NLA_U32
32bit integer
Definition: attr.h:39
int nl_cache_mngt_unregister(struct nl_cache_ops *ops)
Unregister a set of cache operations.
Definition: cache_mngt.c:261
int nl_cache_mngt_register(struct nl_cache_ops *ops)
Register a set of cache operations.
Definition: cache_mngt.c:226
struct nl_cache * nl_cache_mngt_require(const char *name)
Demand the use of a global cache.
Definition: cache_mngt.c:356
void nl_cache_free(struct nl_cache *cache)
Free a cache.
Definition: cache.c:277
struct nl_cache * nl_cache_alloc(struct nl_cache_ops *ops)
Allocate an empty cache.
Definition: cache.c:170
int nl_cache_refill(struct nl_handle *handle, struct nl_cache *cache)
(Re)fill a cache with the contents in the kernel.
Definition: cache.c:680
struct nl_msg * nlmsg_alloc_simple(int nlmsgtype, int flags)
Allocate a new netlink message.
Definition: msg.c:448
void nlmsg_free(struct nl_msg *n)
Free a netlink message.
Definition: msg.c:656
int nlmsg_parse(struct nlmsghdr *nlh, int hdrlen, struct nlattr *tb[], int maxtype, struct nla_policy *policy)
parse attributes of a netlink message
Definition: msg.c:319
void * nlmsg_data(const struct nlmsghdr *nlh)
head of message payload
Definition: msg.c:218
#define NLM_F_DUMP
Dump all entries.
struct nl_msg * nlmsg_alloc(void)
Allocate a new netlink message with the default maximum payload size.
Definition: msg.c:401
int nlmsg_append(struct nl_msg *n, void *data, size_t len, int pad)
Append data to tail of a netlink message.
Definition: msg.c:549
struct nl_msg * rtnl_neightbl_build_change_request(struct rtnl_neightbl *old, struct rtnl_neightbl *tmpl)
Builds a netlink change request message to change neighbour table attributes.
Definition: neightbl.c:478
void rtnl_neightbl_set_proxy_delay(struct rtnl_neightbl *ntbl, uint64_t ms)
Set the proxy delay of a neighbour table to the specified value.
Definition: neightbl.c:769
struct nl_cache * rtnl_neightbl_alloc_cache(struct nl_handle *handle)
Build a neighbour table cache including all neighbour tables currently configured in the kernel.
Definition: neightbl.c:407
int rtnl_neightbl_change(struct nl_handle *handle, struct rtnl_neightbl *old, struct rtnl_neightbl *tmpl)
Change neighbour table attributes.
Definition: neightbl.c:578
struct rtnl_neightbl * rtnl_neightbl_get(struct nl_cache *cache, const char *name, int ifindex)
Lookup neighbour table by name and optional interface index.
Definition: neightbl.c:436
void rtnl_neightbl_set_locktime(struct rtnl_neightbl *ntbl, uint64_t ms)
Set the locktime of a neighbour table to the specified value.
Definition: neightbl.c:781
void rtnl_neightbl_set_gc_stale_time(struct rtnl_neightbl *ntbl, uint64_t ms)
Set the gc stale time of a neighbour table to the specified value.
Definition: neightbl.c:733
void rtnl_neightbl_set_queue_len(struct rtnl_neightbl *ntbl, int len)
Set the queue length for pending requests of a neighbour table to the specified value.
Definition: neightbl.c:648
void rtnl_neightbl_set_app_probes(struct rtnl_neightbl *ntbl, int probes)
Set the number of application probes of a neighbour table to the specified value.
Definition: neightbl.c:672
void rtnl_neightbl_set_anycast_delay(struct rtnl_neightbl *ntbl, uint64_t ms)
Set the anycast delay of a neighbour table to the specified value.
Definition: neightbl.c:757
void rtnl_neightbl_set_delay_probe_time(struct rtnl_neightbl *ntbl, uint64_t ms)
Set the first probe delay time of a neighbour table to the specified value.
Definition: neightbl.c:745
void rtnl_neightbl_set_retrans_time(struct rtnl_neightbl *ntbl, uint64_t ms)
Set the retransmit time of a neighbour table to the specified value.
Definition: neightbl.c:721
void rtnl_neightbl_set_mcast_probes(struct rtnl_neightbl *ntbl, int probes)
Set the number of multicast probes of a neighbour table to the specified value.
Definition: neightbl.c:696
void rtnl_neightbl_set_proxy_queue_len(struct rtnl_neightbl *ntbl, int len)
Set the queue length for delay proxy arp requests of a neighbour table to the specified value.
Definition: neightbl.c:660
void rtnl_neightbl_set_base_reachable_time(struct rtnl_neightbl *ntbl, uint64_t ms)
Set the base reachable time of a neighbour table to the specified value.
Definition: neightbl.c:708
void rtnl_neightbl_set_ucast_probes(struct rtnl_neightbl *ntbl, int probes)
Set the number of unicast probes of a neighbour table to the specified value.
Definition: neightbl.c:684
int nl_send_auto_complete(struct nl_handle *handle, struct nl_msg *msg)
Send netlink message and check & extend header values as needed.
Definition: nl.c:373
int nl_wait_for_ack(struct nl_handle *handle)
Wait for ACK.
Definition: nl.c:801
void nl_object_put(struct nl_object *obj)
Release a reference from an object.
Definition: object.c:178
void nl_object_get(struct nl_object *obj)
Acquire a reference on a object.
Definition: object.c:167
struct nl_object * nl_object_alloc(struct nl_object_ops *ops)
Allocate a new object of kind specified by the operations handle.
Definition: object.c:42
int nl_rtgen_request(struct nl_handle *handle, int type, int family, int flags)
Send routing netlink request message.
Definition: rtnl.c:40
char * nl_msec2str(uint64_t msec, char *buf, size_t len)
Convert milliseconds to a character string.
Definition: utils.c:488
@ NL_DUMP_FULL
Dump all attributes but no statistics.
Definition: types.h:23
@ NL_DUMP_BRIEF
Dump object in a brief one-liner.
Definition: types.h:22
@ NL_DUMP_STATS
Dump all attributes including statistics.
Definition: types.h:24
Cache Operations.
Definition: cache-api.h:164
Dumping parameters.
Definition: types.h:37
Object Operations.
Definition: object-api.h:255
char * oo_name
Unique name of object type.
Definition: object-api.h:261
attribute validation policy
Definition: attr.h:73
uint16_t type
Type of attribute or NLA_UNSPEC.
Definition: attr.h:75
Netlink message header.
uint16_t nlmsg_type
Message type (content type)
Netlink socket address.
Definition: netlink-kernel.h:9