libnl  3.2.7
addr.c
1 /*
2  * lib/route/addr.c Addresses
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-2011 Thomas Graf <tgraf@suug.ch>
10  * Copyright (c) 2003-2006 Baruch Even <baruch@ev-en.org>,
11  * Mediatrix Telecom, inc. <ericb@mediatrix.com>
12  */
13 
14 /**
15  * @ingroup rtnl
16  * @defgroup rtaddr Addresses
17  * @brief
18  *
19  * @note The maximum size of an address label is IFNAMSIZ.
20  *
21  * @note The address may not contain a prefix length if the peer address
22  * has been specified already.
23  *
24  * @par 1) Address Addition
25  * @code
26  * // Allocate an empty address object to be filled out with the attributes
27  * // of the new address.
28  * struct rtnl_addr *addr = rtnl_addr_alloc();
29  *
30  * // Fill out the mandatory attributes of the new address. Setting the
31  * // local address will automatically set the address family and the
32  * // prefix length to the correct values.
33  * rtnl_addr_set_ifindex(addr, ifindex);
34  * rtnl_addr_set_local(addr, local_addr);
35  *
36  * // The label of the address can be specified, currently only supported
37  * // by IPv4 and DECnet.
38  * rtnl_addr_set_label(addr, "mylabel");
39  *
40  * // The peer address can be specified if necessary, in either case a peer
41  * // address will be sent to the kernel in order to fullfil the interface
42  * // requirements. If none is set, it will equal the local address.
43  * // Note: Real peer addresses are only supported by IPv4 for now.
44  * rtnl_addr_set_peer(addr, peer_addr);
45  *
46  * // In case you want to have the address have a scope other than global
47  * // it may be overwritten using rtnl_addr_set_scope(). The scope currently
48  * // cannot be set for IPv6 addresses.
49  * rtnl_addr_set_scope(addr, rtnl_str2scope("site"));
50  *
51  * // Broadcast address may be specified using the relevant
52  * // functions, the address family will be verified if one of the other
53  * // addresses has been set already. Currently only works for IPv4.
54  * rtnl_addr_set_broadcast(addr, broadcast_addr);
55  *
56  * // Build the netlink message and send it to the kernel, the operation will
57  * // block until the operation has been completed. Alternatively the required
58  * // netlink message can be built using rtnl_addr_build_add_request() to be
59  * // sent out using nl_send_auto_complete().
60  * rtnl_addr_add(sk, addr, 0);
61  *
62  * // Free the memory
63  * rtnl_addr_put(addr);
64  * @endcode
65  *
66  * @par 2) Address Deletion
67  * @code
68  * // Allocate an empty address object to be filled out with the attributes
69  * // matching the address to be deleted. Alternatively a fully equipped
70  * // address object out of a cache can be used instead.
71  * struct rtnl_addr *addr = rtnl_addr_alloc();
72  *
73  * // The only mandatory parameter besides the address family is the interface
74  * // index the address is on, i.e. leaving out all other parameters will
75  * // result in all addresses of the specified address family interface tuple
76  * // to be deleted.
77  * rtnl_addr_set_ifindex(addr, ifindex);
78  *
79  * // Specyfing the address family manually is only required if neither the
80  * // local nor peer address have been specified.
81  * rtnl_addr_set_family(addr, AF_INET);
82  *
83  * // Specyfing the local address is optional but the best choice to delete
84  * // specific addresses.
85  * rtnl_addr_set_local(addr, local_addr);
86  *
87  * // The label of the address can be specified, currently only supported
88  * // by IPv4 and DECnet.
89  * rtnl_addr_set_label(addr, "mylabel");
90  *
91  * // The peer address can be specified if necessary, in either case a peer
92  * // address will be sent to the kernel in order to fullfil the interface
93  * // requirements. If none is set, it will equal the local address.
94  * // Note: Real peer addresses are only supported by IPv4 for now.
95  * rtnl_addr_set_peer(addr, peer_addr);
96  *
97  * // Build the netlink message and send it to the kernel, the operation will
98  * // block until the operation has been completed. Alternatively the required
99  * // netlink message can be built using rtnl_addr_build_delete_request()
100  * // to be sent out using nl_send_auto_complete().
101  * rtnl_addr_delete(sk, addr, 0);
102  *
103  * // Free the memory
104  * rtnl_addr_put(addr);
105  * @endcode
106  * @{
107  */
108 
109 #include <netlink-local.h>
110 #include <netlink/netlink.h>
111 #include <netlink/route/rtnl.h>
112 #include <netlink/route/addr.h>
113 #include <netlink/route/route.h>
114 #include <netlink/route/link.h>
115 #include <netlink/utils.h>
116 
117 /** @cond SKIP */
118 #define ADDR_ATTR_FAMILY 0x0001
119 #define ADDR_ATTR_PREFIXLEN 0x0002
120 #define ADDR_ATTR_FLAGS 0x0004
121 #define ADDR_ATTR_SCOPE 0x0008
122 #define ADDR_ATTR_IFINDEX 0x0010
123 #define ADDR_ATTR_LABEL 0x0020
124 #define ADDR_ATTR_CACHEINFO 0x0040
125 #define ADDR_ATTR_PEER 0x0080
126 #define ADDR_ATTR_LOCAL 0x0100
127 #define ADDR_ATTR_BROADCAST 0x0200
128 #define ADDR_ATTR_MULTICAST 0x0400
129 #define ADDR_ATTR_ANYCAST 0x0800
130 
131 static struct nl_cache_ops rtnl_addr_ops;
132 static struct nl_object_ops addr_obj_ops;
133 /** @endcond */
134 
135 static void addr_constructor(struct nl_object *obj)
136 {
137  struct rtnl_addr *addr = nl_object_priv(obj);
138 
139  addr->a_scope = RT_SCOPE_NOWHERE;
140 }
141 
142 static void addr_free_data(struct nl_object *obj)
143 {
144  struct rtnl_addr *addr = nl_object_priv(obj);
145 
146  if (!addr)
147  return;
148 
149  nl_addr_put(addr->a_peer);
150  nl_addr_put(addr->a_local);
151  nl_addr_put(addr->a_bcast);
152  nl_addr_put(addr->a_multicast);
153  nl_addr_put(addr->a_anycast);
154  rtnl_link_put(addr->a_link);
155 }
156 
157 static int addr_clone(struct nl_object *_dst, struct nl_object *_src)
158 {
159  struct rtnl_addr *dst = nl_object_priv(_dst);
160  struct rtnl_addr *src = nl_object_priv(_src);
161 
162  if (src->a_link) {
163  nl_object_get(OBJ_CAST(src->a_link));
164  dst->a_link = src->a_link;
165  }
166 
167  if (src->a_peer)
168  if (!(dst->a_peer = nl_addr_clone(src->a_peer)))
169  return -NLE_NOMEM;
170 
171  if (src->a_local)
172  if (!(dst->a_local = nl_addr_clone(src->a_local)))
173  return -NLE_NOMEM;
174 
175  if (src->a_bcast)
176  if (!(dst->a_bcast = nl_addr_clone(src->a_bcast)))
177  return -NLE_NOMEM;
178 
179  if (src->a_multicast)
180  if (!(dst->a_multicast = nl_addr_clone(src->a_multicast)))
181  return -NLE_NOMEM;
182 
183  if (src->a_anycast)
184  if (!(dst->a_anycast = nl_addr_clone(src->a_anycast)))
185  return -NLE_NOMEM;
186 
187  return 0;
188 }
189 
190 static struct nla_policy addr_policy[IFA_MAX+1] = {
191  [IFA_LABEL] = { .type = NLA_STRING,
192  .maxlen = IFNAMSIZ },
193  [IFA_CACHEINFO] = { .minlen = sizeof(struct ifa_cacheinfo) },
194 };
195 
196 static int addr_msg_parser(struct nl_cache_ops *ops, struct sockaddr_nl *who,
197  struct nlmsghdr *nlh, struct nl_parser_param *pp)
198 {
199  struct rtnl_addr *addr;
200  struct ifaddrmsg *ifa;
201  struct nlattr *tb[IFA_MAX+1];
202  int err, peer_prefix = 0, family;
203  struct nl_cache *link_cache;
204 
205  addr = rtnl_addr_alloc();
206  if (!addr)
207  return -NLE_NOMEM;
208 
209  addr->ce_msgtype = nlh->nlmsg_type;
210 
211  err = nlmsg_parse(nlh, sizeof(*ifa), tb, IFA_MAX, addr_policy);
212  if (err < 0)
213  goto errout;
214 
215  ifa = nlmsg_data(nlh);
216  addr->a_family = family = ifa->ifa_family;
217  addr->a_prefixlen = ifa->ifa_prefixlen;
218  addr->a_flags = ifa->ifa_flags;
219  addr->a_scope = ifa->ifa_scope;
220  addr->a_ifindex = ifa->ifa_index;
221 
222  addr->ce_mask = (ADDR_ATTR_FAMILY | ADDR_ATTR_PREFIXLEN |
223  ADDR_ATTR_FLAGS | ADDR_ATTR_SCOPE | ADDR_ATTR_IFINDEX);
224 
225  if (tb[IFA_LABEL]) {
226  nla_strlcpy(addr->a_label, tb[IFA_LABEL], IFNAMSIZ);
227  addr->ce_mask |= ADDR_ATTR_LABEL;
228  }
229 
230  if (tb[IFA_CACHEINFO]) {
231  struct ifa_cacheinfo *ca;
232 
233  ca = nla_data(tb[IFA_CACHEINFO]);
234  addr->a_cacheinfo.aci_prefered = ca->ifa_prefered;
235  addr->a_cacheinfo.aci_valid = ca->ifa_valid;
236  addr->a_cacheinfo.aci_cstamp = ca->cstamp;
237  addr->a_cacheinfo.aci_tstamp = ca->tstamp;
238  addr->ce_mask |= ADDR_ATTR_CACHEINFO;
239  }
240 
241  if (tb[IFA_LOCAL]) {
242  addr->a_local = nl_addr_alloc_attr(tb[IFA_LOCAL], family);
243  if (!addr->a_local)
244  goto errout_nomem;
245  addr->ce_mask |= ADDR_ATTR_LOCAL;
246  }
247 
248  if (tb[IFA_ADDRESS]) {
249  struct nl_addr *a;
250 
251  a = nl_addr_alloc_attr(tb[IFA_ADDRESS], family);
252  if (!a)
253  goto errout_nomem;
254 
255  /* IPv6 sends the local address as IFA_ADDRESS with
256  * no IFA_LOCAL, IPv4 sends both IFA_LOCAL and IFA_ADDRESS
257  * with IFA_ADDRESS being the peer address if they differ */
258  if (!tb[IFA_LOCAL] || !nl_addr_cmp(a, addr->a_local)) {
259  nl_addr_put(addr->a_local);
260  addr->a_local = a;
261  addr->ce_mask |= ADDR_ATTR_LOCAL;
262  } else {
263  addr->a_peer = a;
264  addr->ce_mask |= ADDR_ATTR_PEER;
265  peer_prefix = 1;
266  }
267  }
268 
269  nl_addr_set_prefixlen(peer_prefix ? addr->a_peer : addr->a_local,
270  addr->a_prefixlen);
271 
272  if (tb[IFA_BROADCAST]) {
273  addr->a_bcast = nl_addr_alloc_attr(tb[IFA_BROADCAST], family);
274  if (!addr->a_bcast)
275  goto errout_nomem;
276 
277  addr->ce_mask |= ADDR_ATTR_BROADCAST;
278  }
279 
280  if (tb[IFA_MULTICAST]) {
281  addr->a_multicast = nl_addr_alloc_attr(tb[IFA_MULTICAST],
282  family);
283  if (!addr->a_multicast)
284  goto errout_nomem;
285 
286  addr->ce_mask |= ADDR_ATTR_MULTICAST;
287  }
288 
289  if (tb[IFA_ANYCAST]) {
290  addr->a_anycast = nl_addr_alloc_attr(tb[IFA_ANYCAST],
291  family);
292  if (!addr->a_anycast)
293  goto errout_nomem;
294 
295  addr->ce_mask |= ADDR_ATTR_ANYCAST;
296  }
297 
298  if ((link_cache = __nl_cache_mngt_require("route/link"))) {
299  struct rtnl_link *link;
300 
301  if ((link = rtnl_link_get(link_cache, addr->a_ifindex))) {
302  rtnl_addr_set_link(addr, link);
303 
304  /* rtnl_addr_set_link incs refcnt */
305  rtnl_link_put(link);
306  }
307  }
308 
309  err = pp->pp_cb((struct nl_object *) addr, pp);
310 errout:
311  rtnl_addr_put(addr);
312 
313  return err;
314 
315 errout_nomem:
316  err = -NLE_NOMEM;
317  goto errout;
318 }
319 
320 static int addr_request_update(struct nl_cache *cache, struct nl_sock *sk)
321 {
322  return nl_rtgen_request(sk, RTM_GETADDR, AF_UNSPEC, NLM_F_DUMP);
323 }
324 
325 static void addr_dump_line(struct nl_object *obj, struct nl_dump_params *p)
326 {
327  struct rtnl_addr *addr = (struct rtnl_addr *) obj;
328  struct nl_cache *link_cache;
329  char buf[128];
330 
331  link_cache = nl_cache_mngt_require("route/link");
332 
333  if (addr->ce_mask & ADDR_ATTR_LOCAL)
334  nl_dump_line(p, "%s",
335  nl_addr2str(addr->a_local, buf, sizeof(buf)));
336  else
337  nl_dump_line(p, "none");
338 
339  if (addr->ce_mask & ADDR_ATTR_PEER)
340  nl_dump(p, " peer %s",
341  nl_addr2str(addr->a_peer, buf, sizeof(buf)));
342 
343  nl_dump(p, " %s ", nl_af2str(addr->a_family, buf, sizeof(buf)));
344 
345  if (link_cache)
346  nl_dump(p, "dev %s ",
347  rtnl_link_i2name(link_cache, addr->a_ifindex,
348  buf, sizeof(buf)));
349  else
350  nl_dump(p, "dev %d ", addr->a_ifindex);
351 
352  nl_dump(p, "scope %s",
353  rtnl_scope2str(addr->a_scope, buf, sizeof(buf)));
354 
355  rtnl_addr_flags2str(addr->a_flags, buf, sizeof(buf));
356  if (buf[0])
357  nl_dump(p, " <%s>", buf);
358 
359  nl_dump(p, "\n");
360 }
361 
362 static void addr_dump_details(struct nl_object *obj, struct nl_dump_params *p)
363 {
364  struct rtnl_addr *addr = (struct rtnl_addr *) obj;
365  char buf[128];
366 
367  addr_dump_line(obj, p);
368 
369  if (addr->ce_mask & (ADDR_ATTR_LABEL | ADDR_ATTR_BROADCAST |
370  ADDR_ATTR_MULTICAST)) {
371  nl_dump_line(p, " ");
372 
373  if (addr->ce_mask & ADDR_ATTR_LABEL)
374  nl_dump(p, " label %s", addr->a_label);
375 
376  if (addr->ce_mask & ADDR_ATTR_BROADCAST)
377  nl_dump(p, " broadcast %s",
378  nl_addr2str(addr->a_bcast, buf, sizeof(buf)));
379 
380  if (addr->ce_mask & ADDR_ATTR_MULTICAST)
381  nl_dump(p, " multicast %s",
382  nl_addr2str(addr->a_multicast, buf,
383  sizeof(buf)));
384 
385  if (addr->ce_mask & ADDR_ATTR_ANYCAST)
386  nl_dump(p, " anycast %s",
387  nl_addr2str(addr->a_anycast, buf,
388  sizeof(buf)));
389 
390  nl_dump(p, "\n");
391  }
392 
393  if (addr->ce_mask & ADDR_ATTR_CACHEINFO) {
394  struct rtnl_addr_cacheinfo *ci = &addr->a_cacheinfo;
395 
396  nl_dump_line(p, " valid-lifetime %s",
397  ci->aci_valid == 0xFFFFFFFFU ? "forever" :
398  nl_msec2str(ci->aci_valid * 1000,
399  buf, sizeof(buf)));
400 
401  nl_dump(p, " preferred-lifetime %s\n",
402  ci->aci_prefered == 0xFFFFFFFFU ? "forever" :
403  nl_msec2str(ci->aci_prefered * 1000,
404  buf, sizeof(buf)));
405 
406  nl_dump_line(p, " created boot-time+%s ",
407  nl_msec2str(addr->a_cacheinfo.aci_cstamp * 10,
408  buf, sizeof(buf)));
409 
410  nl_dump(p, "last-updated boot-time+%s\n",
411  nl_msec2str(addr->a_cacheinfo.aci_tstamp * 10,
412  buf, sizeof(buf)));
413  }
414 }
415 
416 static void addr_dump_stats(struct nl_object *obj, struct nl_dump_params *p)
417 {
418  addr_dump_details(obj, p);
419 }
420 
421 static int addr_compare(struct nl_object *_a, struct nl_object *_b,
422  uint32_t attrs, int flags)
423 {
424  struct rtnl_addr *a = (struct rtnl_addr *) _a;
425  struct rtnl_addr *b = (struct rtnl_addr *) _b;
426  int diff = 0;
427 
428 #define ADDR_DIFF(ATTR, EXPR) ATTR_DIFF(attrs, ADDR_ATTR_##ATTR, a, b, EXPR)
429 
430  diff |= ADDR_DIFF(IFINDEX, a->a_ifindex != b->a_ifindex);
431  diff |= ADDR_DIFF(FAMILY, a->a_family != b->a_family);
432  diff |= ADDR_DIFF(SCOPE, a->a_scope != b->a_scope);
433  diff |= ADDR_DIFF(LABEL, strcmp(a->a_label, b->a_label));
434  diff |= ADDR_DIFF(PEER, nl_addr_cmp(a->a_peer, b->a_peer));
435  diff |= ADDR_DIFF(LOCAL, nl_addr_cmp(a->a_local, b->a_local));
436  diff |= ADDR_DIFF(MULTICAST, nl_addr_cmp(a->a_multicast,
437  b->a_multicast));
438  diff |= ADDR_DIFF(BROADCAST, nl_addr_cmp(a->a_bcast, b->a_bcast));
439  diff |= ADDR_DIFF(ANYCAST, nl_addr_cmp(a->a_anycast, b->a_anycast));
440 
441  if (flags & LOOSE_COMPARISON)
442  diff |= ADDR_DIFF(FLAGS,
443  (a->a_flags ^ b->a_flags) & b->a_flag_mask);
444  else
445  diff |= ADDR_DIFF(FLAGS, a->a_flags != b->a_flags);
446 
447 #undef ADDR_DIFF
448 
449  return diff;
450 }
451 
452 static const struct trans_tbl addr_attrs[] = {
453  __ADD(ADDR_ATTR_FAMILY, family)
454  __ADD(ADDR_ATTR_PREFIXLEN, prefixlen)
455  __ADD(ADDR_ATTR_FLAGS, flags)
456  __ADD(ADDR_ATTR_SCOPE, scope)
457  __ADD(ADDR_ATTR_IFINDEX, ifindex)
458  __ADD(ADDR_ATTR_LABEL, label)
459  __ADD(ADDR_ATTR_CACHEINFO, cacheinfo)
460  __ADD(ADDR_ATTR_PEER, peer)
461  __ADD(ADDR_ATTR_LOCAL, local)
462  __ADD(ADDR_ATTR_BROADCAST, broadcast)
463  __ADD(ADDR_ATTR_MULTICAST, multicast)
464 };
465 
466 static char *addr_attrs2str(int attrs, char *buf, size_t len)
467 {
468  return __flags2str(attrs, buf, len, addr_attrs,
469  ARRAY_SIZE(addr_attrs));
470 }
471 
472 /**
473  * @name Allocation/Freeing
474  * @{
475  */
476 
477 struct rtnl_addr *rtnl_addr_alloc(void)
478 {
479  return (struct rtnl_addr *) nl_object_alloc(&addr_obj_ops);
480 }
481 
482 void rtnl_addr_put(struct rtnl_addr *addr)
483 {
484  nl_object_put((struct nl_object *) addr);
485 }
486 
487 /** @} */
488 
489 /**
490  * @name Cache Management
491  * @{
492  */
493 
494 int rtnl_addr_alloc_cache(struct nl_sock *sk, struct nl_cache **result)
495 {
496  return nl_cache_alloc_and_fill(&rtnl_addr_ops, sk, result);
497 }
498 
499 /**
500  * Search address in cache
501  * @arg cache Address cache
502  * @arg ifindex Interface index of address
503  * @arg addr Local address part
504  *
505  * Searches address cache previously allocated with rtnl_addr_alloc_cache()
506  * for an address with a matching local address.
507  *
508  * The reference counter is incremented before returning the address, therefore
509  * the reference must be given back with rtnl_addr_put() after usage.
510  *
511  * @return Address object or NULL if no match was found.
512  */
513 struct rtnl_addr *rtnl_addr_get(struct nl_cache *cache, int ifindex,
514  struct nl_addr *addr)
515 {
516  struct rtnl_addr *a;
517 
518  if (cache->c_ops != &rtnl_addr_ops)
519  return NULL;
520 
521  nl_list_for_each_entry(a, &cache->c_items, ce_list) {
522  if (ifindex && a->a_ifindex != ifindex)
523  continue;
524 
525  if (a->ce_mask & ADDR_ATTR_LOCAL &&
526  !nl_addr_cmp(a->a_local, addr)) {
527  nl_object_get((struct nl_object *) a);
528  return a;
529  }
530  }
531 
532  return NULL;
533 }
534 
535 /** @} */
536 
537 static int build_addr_msg(struct rtnl_addr *tmpl, int cmd, int flags,
538  struct nl_msg **result)
539 {
540  struct nl_msg *msg;
541  struct ifaddrmsg am = {
542  .ifa_family = tmpl->a_family,
543  .ifa_index = tmpl->a_ifindex,
544  .ifa_prefixlen = tmpl->a_prefixlen,
545  };
546 
547  if (tmpl->ce_mask & ADDR_ATTR_SCOPE)
548  am.ifa_scope = tmpl->a_scope;
549  else {
550  /* compatibility hack */
551  if (tmpl->a_family == AF_INET &&
552  tmpl->ce_mask & ADDR_ATTR_LOCAL &&
553  *((char *) nl_addr_get_binary_addr(tmpl->a_local)) == 127)
554  am.ifa_scope = RT_SCOPE_HOST;
555  else
556  am.ifa_scope = RT_SCOPE_UNIVERSE;
557  }
558 
559  msg = nlmsg_alloc_simple(cmd, flags);
560  if (!msg)
561  return -NLE_NOMEM;
562 
563  if (nlmsg_append(msg, &am, sizeof(am), NLMSG_ALIGNTO) < 0)
564  goto nla_put_failure;
565 
566  if (tmpl->ce_mask & ADDR_ATTR_LOCAL)
567  NLA_PUT_ADDR(msg, IFA_LOCAL, tmpl->a_local);
568 
569  if (tmpl->ce_mask & ADDR_ATTR_PEER)
570  NLA_PUT_ADDR(msg, IFA_ADDRESS, tmpl->a_peer);
571  else if (tmpl->ce_mask & ADDR_ATTR_LOCAL)
572  NLA_PUT_ADDR(msg, IFA_ADDRESS, tmpl->a_local);
573 
574  if (tmpl->ce_mask & ADDR_ATTR_LABEL)
575  NLA_PUT_STRING(msg, IFA_LABEL, tmpl->a_label);
576 
577  if (tmpl->ce_mask & ADDR_ATTR_BROADCAST)
578  NLA_PUT_ADDR(msg, IFA_BROADCAST, tmpl->a_bcast);
579 
580  if (tmpl->ce_mask & ADDR_ATTR_CACHEINFO) {
581  struct ifa_cacheinfo ca = {
582  .ifa_valid = tmpl->a_cacheinfo.aci_valid,
583  .ifa_prefered = tmpl->a_cacheinfo.aci_prefered,
584  };
585 
586  NLA_PUT(msg, IFA_CACHEINFO, sizeof(ca), &ca);
587  }
588 
589 
590  *result = msg;
591  return 0;
592 
593 nla_put_failure:
594  nlmsg_free(msg);
595  return -NLE_MSGSIZE;
596 }
597 
598 /**
599  * @name Addition
600  * @{
601  */
602 
603 /**
604  * Build netlink request message to request addition of new address
605  * @arg addr Address object representing the new address.
606  * @arg flags Additional netlink message flags.
607  * @arg result Pointer to store resulting message.
608  *
609  * Builds a new netlink message requesting the addition of a new
610  * address. The netlink message header isn't fully equipped with
611  * all relevant fields and must thus be sent out via nl_send_auto_complete()
612  * or supplemented as needed.
613  *
614  * Minimal required attributes:
615  * - interface index (rtnl_addr_set_ifindex())
616  * - local address (rtnl_addr_set_local())
617  *
618  * The scope will default to universe except for loopback addresses in
619  * which case a host scope is used if not specified otherwise.
620  *
621  * @note Free the memory after usage using nlmsg_free().
622  *
623  * @return 0 on success or a negative error code.
624  */
625 int rtnl_addr_build_add_request(struct rtnl_addr *addr, int flags,
626  struct nl_msg **result)
627 {
628  int required = ADDR_ATTR_IFINDEX | ADDR_ATTR_FAMILY |
629  ADDR_ATTR_PREFIXLEN | ADDR_ATTR_LOCAL;
630 
631  if ((addr->ce_mask & required) != required)
632  return -NLE_MISSING_ATTR;
633 
634  return build_addr_msg(addr, RTM_NEWADDR, NLM_F_CREATE | flags, result);
635 }
636 
637 /**
638  * Request addition of new address
639  * @arg sk Netlink socket.
640  * @arg addr Address object representing the new address.
641  * @arg flags Additional netlink message flags.
642  *
643  * Builds a netlink message by calling rtnl_addr_build_add_request(),
644  * sends the request to the kernel and waits for the next ACK to be
645  * received and thus blocks until the request has been fullfilled.
646  *
647  * @see rtnl_addr_build_add_request()
648  *
649  * @return 0 on sucess or a negative error if an error occured.
650  */
651 int rtnl_addr_add(struct nl_sock *sk, struct rtnl_addr *addr, int flags)
652 {
653  struct nl_msg *msg;
654  int err;
655 
656  if ((err = rtnl_addr_build_add_request(addr, flags, &msg)) < 0)
657  return err;
658 
659  err = nl_send_auto_complete(sk, msg);
660  nlmsg_free(msg);
661  if (err < 0)
662  return err;
663 
664  return wait_for_ack(sk);
665 }
666 
667 /** @} */
668 
669 /**
670  * @name Deletion
671  * @{
672  */
673 
674 /**
675  * Build a netlink request message to request deletion of an address
676  * @arg addr Address object to be deleteted.
677  * @arg flags Additional netlink message flags.
678  * @arg result Pointer to store resulting message.
679  *
680  * Builds a new netlink message requesting a deletion of an address.
681  * The netlink message header isn't fully equipped with all relevant
682  * fields and must thus be sent out via nl_send_auto_complete()
683  * or supplemented as needed.
684  *
685  * Minimal required attributes:
686  * - interface index (rtnl_addr_set_ifindex())
687  * - address family (rtnl_addr_set_family())
688  *
689  * Optional attributes:
690  * - local address (rtnl_addr_set_local())
691  * - label (rtnl_addr_set_label(), IPv4/DECnet only)
692  * - peer address (rtnl_addr_set_peer(), IPv4 only)
693  *
694  * @note Free the memory after usage using nlmsg_free().
695  *
696  * @return 0 on success or a negative error code.
697  */
698 int rtnl_addr_build_delete_request(struct rtnl_addr *addr, int flags,
699  struct nl_msg **result)
700 {
701  int required = ADDR_ATTR_IFINDEX | ADDR_ATTR_FAMILY;
702 
703  if ((addr->ce_mask & required) != required)
704  return -NLE_MISSING_ATTR;
705 
706  return build_addr_msg(addr, RTM_DELADDR, flags, result);
707 }
708 
709 /**
710  * Request deletion of an address
711  * @arg sk Netlink socket.
712  * @arg addr Address object to be deleted.
713  * @arg flags Additional netlink message flags.
714  *
715  * Builds a netlink message by calling rtnl_addr_build_delete_request(),
716  * sends the request to the kernel and waits for the next ACK to be
717  * received and thus blocks until the request has been fullfilled.
718  *
719  * @see rtnl_addr_build_delete_request();
720  *
721  * @return 0 on sucess or a negative error if an error occured.
722  */
723 int rtnl_addr_delete(struct nl_sock *sk, struct rtnl_addr *addr, int flags)
724 {
725  struct nl_msg *msg;
726  int err;
727 
728  if ((err = rtnl_addr_build_delete_request(addr, flags, &msg)) < 0)
729  return err;
730 
731  err = nl_send_auto_complete(sk, msg);
732  nlmsg_free(msg);
733  if (err < 0)
734  return err;
735 
736  return wait_for_ack(sk);
737 }
738 
739 /** @} */
740 
741 /**
742  * @name Attributes
743  * @{
744  */
745 
746 int rtnl_addr_set_label(struct rtnl_addr *addr, const char *label)
747 {
748  if (strlen(label) > sizeof(addr->a_label) - 1)
749  return -NLE_RANGE;
750 
751  strcpy(addr->a_label, label);
752  addr->ce_mask |= ADDR_ATTR_LABEL;
753 
754  return 0;
755 }
756 
757 char *rtnl_addr_get_label(struct rtnl_addr *addr)
758 {
759  if (addr->ce_mask & ADDR_ATTR_LABEL)
760  return addr->a_label;
761  else
762  return NULL;
763 }
764 
765 void rtnl_addr_set_ifindex(struct rtnl_addr *addr, int ifindex)
766 {
767  addr->a_ifindex = ifindex;
768  addr->ce_mask |= ADDR_ATTR_IFINDEX;
769 }
770 
771 int rtnl_addr_get_ifindex(struct rtnl_addr *addr)
772 {
773  return addr->a_ifindex;
774 }
775 
776 void rtnl_addr_set_link(struct rtnl_addr *addr, struct rtnl_link *link)
777 {
778  rtnl_link_put(addr->a_link);
779 
780  if (!link)
781  return;
782 
783  nl_object_get(OBJ_CAST(link));
784  addr->a_link = link;
785  addr->a_ifindex = link->l_index;
786  addr->ce_mask |= ADDR_ATTR_IFINDEX;
787 }
788 
789 struct rtnl_link *rtnl_addr_get_link(struct rtnl_addr *addr)
790 {
791  if (addr->a_link) {
792  nl_object_get(OBJ_CAST(addr->a_link));
793  return addr->a_link;
794  }
795 
796  return NULL;
797 }
798 
799 void rtnl_addr_set_family(struct rtnl_addr *addr, int family)
800 {
801  addr->a_family = family;
802  addr->ce_mask |= ADDR_ATTR_FAMILY;
803 }
804 
805 int rtnl_addr_get_family(struct rtnl_addr *addr)
806 {
807  return addr->a_family;
808 }
809 
810 void rtnl_addr_set_prefixlen(struct rtnl_addr *addr, int prefix)
811 {
812  addr->a_prefixlen = prefix;
813  addr->ce_mask |= ADDR_ATTR_PREFIXLEN;
814 }
815 
816 int rtnl_addr_get_prefixlen(struct rtnl_addr *addr)
817 {
818  return addr->a_prefixlen;
819 }
820 
821 void rtnl_addr_set_scope(struct rtnl_addr *addr, int scope)
822 {
823  addr->a_scope = scope;
824  addr->ce_mask |= ADDR_ATTR_SCOPE;
825 }
826 
827 int rtnl_addr_get_scope(struct rtnl_addr *addr)
828 {
829  return addr->a_scope;
830 }
831 
832 void rtnl_addr_set_flags(struct rtnl_addr *addr, unsigned int flags)
833 {
834  addr->a_flag_mask |= flags;
835  addr->a_flags |= flags;
836  addr->ce_mask |= ADDR_ATTR_FLAGS;
837 }
838 
839 void rtnl_addr_unset_flags(struct rtnl_addr *addr, unsigned int flags)
840 {
841  addr->a_flag_mask |= flags;
842  addr->a_flags &= ~flags;
843  addr->ce_mask |= ADDR_ATTR_FLAGS;
844 }
845 
846 unsigned int rtnl_addr_get_flags(struct rtnl_addr *addr)
847 {
848  return addr->a_flags;
849 }
850 
851 static inline int __assign_addr(struct rtnl_addr *addr, struct nl_addr **pos,
852  struct nl_addr *new, int flag)
853 {
854  if (addr->ce_mask & ADDR_ATTR_FAMILY) {
855  if (new->a_family != addr->a_family)
856  return -NLE_AF_MISMATCH;
857  } else
858  addr->a_family = new->a_family;
859 
860  if (*pos)
861  nl_addr_put(*pos);
862 
863  *pos = nl_addr_get(new);
864  addr->ce_mask |= (flag | ADDR_ATTR_FAMILY);
865 
866  return 0;
867 }
868 
869 int rtnl_addr_set_local(struct rtnl_addr *addr, struct nl_addr *local)
870 {
871  int err;
872 
873  err = __assign_addr(addr, &addr->a_local, local, ADDR_ATTR_LOCAL);
874  if (err < 0)
875  return err;
876 
877  if (!(addr->ce_mask & ADDR_ATTR_PEER)) {
878  addr->a_prefixlen = nl_addr_get_prefixlen(addr->a_local);
879  addr->ce_mask |= ADDR_ATTR_PREFIXLEN;
880  }
881 
882  return 0;
883 }
884 
885 struct nl_addr *rtnl_addr_get_local(struct rtnl_addr *addr)
886 {
887  return addr->a_local;
888 }
889 
890 int rtnl_addr_set_peer(struct rtnl_addr *addr, struct nl_addr *peer)
891 {
892  return __assign_addr(addr, &addr->a_peer, peer, ADDR_ATTR_PEER);
893 
894  addr->a_prefixlen = nl_addr_get_prefixlen(addr->a_peer);
895  addr->ce_mask |= ADDR_ATTR_PREFIXLEN;
896 
897  return 0;
898 }
899 
900 struct nl_addr *rtnl_addr_get_peer(struct rtnl_addr *addr)
901 {
902  return addr->a_peer;
903 }
904 
905 int rtnl_addr_set_broadcast(struct rtnl_addr *addr, struct nl_addr *bcast)
906 {
907  return __assign_addr(addr, &addr->a_bcast, bcast, ADDR_ATTR_BROADCAST);
908 }
909 
910 struct nl_addr *rtnl_addr_get_broadcast(struct rtnl_addr *addr)
911 {
912  return addr->a_bcast;
913 }
914 
915 int rtnl_addr_set_multicast(struct rtnl_addr *addr, struct nl_addr *multicast)
916 {
917  return __assign_addr(addr, &addr->a_multicast, multicast,
918  ADDR_ATTR_MULTICAST);
919 }
920 
921 struct nl_addr *rtnl_addr_get_multicast(struct rtnl_addr *addr)
922 {
923  return addr->a_multicast;
924 }
925 
926 int rtnl_addr_set_anycast(struct rtnl_addr *addr, struct nl_addr *anycast)
927 {
928  return __assign_addr(addr, &addr->a_anycast, anycast,
929  ADDR_ATTR_ANYCAST);
930 }
931 
932 struct nl_addr *rtnl_addr_get_anycast(struct rtnl_addr *addr)
933 {
934  return addr->a_anycast;
935 }
936 
937 uint32_t rtnl_addr_get_valid_lifetime(struct rtnl_addr *addr)
938 {
939  if (addr->ce_mask & ADDR_ATTR_CACHEINFO)
940  return addr->a_cacheinfo.aci_valid;
941  else
942  return 0xFFFFFFFFU;
943 }
944 
945 void rtnl_addr_set_valid_lifetime(struct rtnl_addr *addr, uint32_t lifetime)
946 {
947  addr->a_cacheinfo.aci_valid = lifetime;
948  addr->ce_mask |= ADDR_ATTR_CACHEINFO;
949 }
950 
951 uint32_t rtnl_addr_get_preferred_lifetime(struct rtnl_addr *addr)
952 {
953  if (addr->ce_mask & ADDR_ATTR_CACHEINFO)
954  return addr->a_cacheinfo.aci_prefered;
955  else
956  return 0xFFFFFFFFU;
957 }
958 
959 void rtnl_addr_set_preferred_lifetime(struct rtnl_addr *addr, uint32_t lifetime)
960 {
961  addr->a_cacheinfo.aci_prefered = lifetime;
962  addr->ce_mask |= ADDR_ATTR_CACHEINFO;
963 }
964 
965 uint32_t rtnl_addr_get_create_time(struct rtnl_addr *addr)
966 {
967  return addr->a_cacheinfo.aci_cstamp;
968 }
969 
970 uint32_t rtnl_addr_get_last_update_time(struct rtnl_addr *addr)
971 {
972  return addr->a_cacheinfo.aci_tstamp;
973 }
974 
975 /** @} */
976 
977 /**
978  * @name Flags Translations
979  * @{
980  */
981 
982 static const struct trans_tbl addr_flags[] = {
983  __ADD(IFA_F_SECONDARY, secondary)
984  __ADD(IFA_F_NODAD, nodad)
985  __ADD(IFA_F_OPTIMISTIC, optimistic)
986  __ADD(IFA_F_HOMEADDRESS, homeaddress)
987  __ADD(IFA_F_DEPRECATED, deprecated)
988  __ADD(IFA_F_TENTATIVE, tentative)
989  __ADD(IFA_F_PERMANENT, permanent)
990 };
991 
992 char *rtnl_addr_flags2str(int flags, char *buf, size_t size)
993 {
994  return __flags2str(flags, buf, size, addr_flags,
995  ARRAY_SIZE(addr_flags));
996 }
997 
998 int rtnl_addr_str2flags(const char *name)
999 {
1000  return __str2flags(name, addr_flags, ARRAY_SIZE(addr_flags));
1001 }
1002 
1003 /** @} */
1004 
1005 static struct nl_object_ops addr_obj_ops = {
1006  .oo_name = "route/addr",
1007  .oo_size = sizeof(struct rtnl_addr),
1008  .oo_constructor = addr_constructor,
1009  .oo_free_data = addr_free_data,
1010  .oo_clone = addr_clone,
1011  .oo_dump = {
1012  [NL_DUMP_LINE] = addr_dump_line,
1013  [NL_DUMP_DETAILS] = addr_dump_details,
1014  [NL_DUMP_STATS] = addr_dump_stats,
1015  },
1016  .oo_compare = addr_compare,
1017  .oo_attrs2str = addr_attrs2str,
1018  .oo_id_attrs = (ADDR_ATTR_FAMILY | ADDR_ATTR_IFINDEX |
1019  ADDR_ATTR_LOCAL | ADDR_ATTR_PREFIXLEN),
1020 };
1021 
1022 static struct nl_af_group addr_groups[] = {
1023  { AF_INET, RTNLGRP_IPV4_IFADDR },
1024  { AF_INET6, RTNLGRP_IPV6_IFADDR },
1025  { END_OF_GROUP_LIST },
1026 };
1027 
1028 static struct nl_cache_ops rtnl_addr_ops = {
1029  .co_name = "route/addr",
1030  .co_hdrsize = sizeof(struct ifaddrmsg),
1031  .co_msgtypes = {
1032  { RTM_NEWADDR, NL_ACT_NEW, "new" },
1033  { RTM_DELADDR, NL_ACT_DEL, "del" },
1034  { RTM_GETADDR, NL_ACT_GET, "get" },
1035  END_OF_MSGTYPES_LIST,
1036  },
1037  .co_protocol = NETLINK_ROUTE,
1038  .co_groups = addr_groups,
1039  .co_request_update = addr_request_update,
1040  .co_msg_parser = addr_msg_parser,
1041  .co_obj_ops = &addr_obj_ops,
1042 };
1043 
1044 static void __init addr_init(void)
1045 {
1046  nl_cache_mngt_register(&rtnl_addr_ops);
1047 }
1048 
1049 static void __exit addr_exit(void)
1050 {
1051  nl_cache_mngt_unregister(&rtnl_addr_ops);
1052 }
1053 
1054 /** @} */