libnl  3.2.27
ipvti.c
1  /*
2  * lib/route/link/ipvti.c IPVTI Link Info
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) 2014 Susant Sahani <susant@redhat.com>
10  */
11 
12 /**
13  * @ingroup link
14  * @defgroup ipvti IPVTI
15  * ipvti link module
16  *
17  * @details
18  * \b Link Type Name: "ipvti"
19  *
20  * @route_doc{link_ipvti, IPVTI Documentation}
21  *
22  * @{
23  */
24 
25 #include <netlink-private/netlink.h>
26 #include <netlink/netlink.h>
27 #include <netlink/attr.h>
28 #include <netlink/utils.h>
29 #include <netlink/object.h>
30 #include <netlink/route/rtnl.h>
31 #include <netlink-private/route/link/api.h>
32 #include <linux/if_tunnel.h>
33 
34 #define IPVTI_ATTR_LINK (1 << 0)
35 #define IPVTI_ATTR_IKEY (1 << 1)
36 #define IPVTI_ATTR_OKEY (1 << 2)
37 #define IPVTI_ATTR_LOCAL (1 << 3)
38 #define IPVTI_ATTR_REMOTE (1 << 4)
39 
40 struct ipvti_info
41 {
42  uint32_t link;
43  uint32_t ikey;
44  uint32_t okey;
45  uint32_t local;
46  uint32_t remote;
47  uint32_t ipvti_mask;
48 };
49 
50 static struct nla_policy ipvti_policy[IFLA_GRE_MAX + 1] = {
51  [IFLA_VTI_LINK] = { .type = NLA_U32 },
52  [IFLA_VTI_IKEY] = { .type = NLA_U32 },
53  [IFLA_VTI_OKEY] = { .type = NLA_U32 },
54  [IFLA_VTI_LOCAL] = { .type = NLA_U32 },
55  [IFLA_VTI_REMOTE] = { .type = NLA_U32 },
56 };
57 
58 static int ipvti_alloc(struct rtnl_link *link)
59 {
60  struct ipvti_info *ipvti;
61 
62  if (link->l_info)
63  memset(link->l_info, 0, sizeof(*ipvti));
64  else {
65  ipvti = calloc(1, sizeof(*ipvti));
66  if (!ipvti)
67  return -NLE_NOMEM;
68 
69  link->l_info = ipvti;
70  }
71 
72  return 0;
73 }
74 
75 static int ipvti_parse(struct rtnl_link *link, struct nlattr *data,
76  struct nlattr *xstats)
77 {
78  struct nlattr *tb[IFLA_IPTUN_MAX + 1];
79  struct ipvti_info *ipvti;
80  int err;
81 
82  NL_DBG(3, "Parsing IPVTI link info\n");
83 
84  err = nla_parse_nested(tb, IFLA_GRE_MAX, data, ipvti_policy);
85  if (err < 0)
86  goto errout;
87 
88  err = ipvti_alloc(link);
89  if (err < 0)
90  goto errout;
91 
92  ipvti = link->l_info;
93 
94  if (tb[IFLA_VTI_LINK]) {
95  ipvti->link = nla_get_u32(tb[IFLA_VTI_LINK]);
96  ipvti->ipvti_mask |= IPVTI_ATTR_LINK;
97  }
98 
99  if (tb[IFLA_VTI_IKEY]) {
100  ipvti->ikey = nla_get_u32(tb[IFLA_VTI_IKEY]);
101  ipvti->ipvti_mask |= IPVTI_ATTR_IKEY;
102  }
103 
104  if (tb[IFLA_VTI_OKEY]) {
105  ipvti->okey = nla_get_u32(tb[IFLA_VTI_OKEY]);
106  ipvti->ipvti_mask |= IPVTI_ATTR_OKEY;
107  }
108 
109  if (tb[IFLA_VTI_LOCAL]) {
110  ipvti->local = nla_get_u32(tb[IFLA_VTI_LOCAL]);
111  ipvti->ipvti_mask |= IPVTI_ATTR_LOCAL;
112  }
113 
114  if (tb[IFLA_VTI_REMOTE]) {
115  ipvti->remote = nla_get_u32(tb[IFLA_VTI_REMOTE]);
116  ipvti->ipvti_mask |= IPVTI_ATTR_REMOTE;
117  }
118 
119  err = 0;
120 
121  errout:
122  return err;
123 }
124 
125 static int ipvti_put_attrs(struct nl_msg *msg, struct rtnl_link *link)
126 {
127  struct ipvti_info *ipvti = link->l_info;
128  struct nlattr *data;
129 
130  data = nla_nest_start(msg, IFLA_INFO_DATA);
131  if (!data)
132  return -NLE_MSGSIZE;
133 
134  if (ipvti->ipvti_mask & IPVTI_ATTR_LINK)
135  NLA_PUT_U32(msg, IFLA_VTI_LINK, ipvti->link);
136 
137  if (ipvti->ipvti_mask & IPVTI_ATTR_IKEY)
138  NLA_PUT_U32(msg, IFLA_VTI_IKEY, ipvti->ikey);
139 
140  if (ipvti->ipvti_mask & IFLA_VTI_IKEY)
141  NLA_PUT_U32(msg, IFLA_VTI_OKEY, ipvti->okey);
142 
143  if (ipvti->ipvti_mask & IPVTI_ATTR_LOCAL)
144  NLA_PUT_U32(msg, IFLA_VTI_LOCAL, ipvti->local);
145 
146  if (ipvti->ipvti_mask & IPVTI_ATTR_REMOTE)
147  NLA_PUT_U32(msg, IFLA_VTI_REMOTE, ipvti->remote);
148 
149  nla_nest_end(msg, data);
150 
151 nla_put_failure:
152 
153  return 0;
154 }
155 
156 static void ipvti_free(struct rtnl_link *link)
157 {
158  struct ipvti_info *ipvti = link->l_info;
159 
160  free(ipvti);
161  link->l_info = NULL;
162 }
163 
164 static void ipvti_dump_line(struct rtnl_link *link, struct nl_dump_params *p)
165 {
166  nl_dump(p, "ipvti : %s", link->l_name);
167 }
168 
169 static void ipvti_dump_details(struct rtnl_link *link, struct nl_dump_params *p)
170 {
171  struct ipvti_info *ipvti = link->l_info;
172  char *name, addr[INET_ADDRSTRLEN];
173 
174  if (ipvti->ipvti_mask & IPVTI_ATTR_LINK) {
175  nl_dump(p, " link ");
176  name = rtnl_link_get_name(link);
177  if (name)
178  nl_dump_line(p, "%s\n", name);
179  else
180  nl_dump_line(p, "%u\n", ipvti->link);
181  }
182 
183  if (ipvti->ipvti_mask & IPVTI_ATTR_IKEY) {
184  nl_dump(p, " ikey ");
185  nl_dump_line(p, "%x\n",ipvti->ikey);
186  }
187 
188  if (ipvti->ipvti_mask & IPVTI_ATTR_OKEY) {
189  nl_dump(p, " okey ");
190  nl_dump_line(p, "%x\n", ipvti->okey);
191  }
192 
193  if (ipvti->ipvti_mask & IPVTI_ATTR_LOCAL) {
194  nl_dump(p, " local ");
195  if(inet_ntop(AF_INET, &ipvti->local, addr, sizeof(addr)))
196  nl_dump_line(p, "%s\n", addr);
197  else
198  nl_dump_line(p, "%#x\n", ntohs(ipvti->local));
199  }
200 
201  if (ipvti->ipvti_mask & IPVTI_ATTR_REMOTE) {
202  nl_dump(p, " remote ");
203  if(inet_ntop(AF_INET, &ipvti->remote, addr, sizeof(addr)))
204  nl_dump_line(p, "%s\n", addr);
205  else
206  nl_dump_line(p, "%#x\n", ntohs(ipvti->remote));
207  }
208 }
209 
210 static int ipvti_clone(struct rtnl_link *dst, struct rtnl_link *src)
211 {
212  struct ipvti_info *ipvti_dst, *ipvti_src = src->l_info;
213  int err;
214 
215  dst->l_info = NULL;
216 
217  err = rtnl_link_set_type(dst, "vti");
218  if (err < 0)
219  return err;
220 
221  ipvti_dst = dst->l_info;
222 
223  if (!ipvti_dst || !ipvti_src)
224  BUG();
225 
226  memcpy(ipvti_dst, ipvti_src, sizeof(struct ipvti_info));
227 
228  return 0;
229 }
230 
231 static struct rtnl_link_info_ops ipvti_info_ops = {
232  .io_name = "vti",
233  .io_alloc = ipvti_alloc,
234  .io_parse = ipvti_parse,
235  .io_dump = {
236  [NL_DUMP_LINE] = ipvti_dump_line,
237  [NL_DUMP_DETAILS] = ipvti_dump_details,
238  },
239  .io_clone = ipvti_clone,
240  .io_put_attrs = ipvti_put_attrs,
241  .io_free = ipvti_free,
242 };
243 
244 #define IS_IPVTI_LINK_ASSERT(link) \
245  if ((link)->l_info_ops != &ipvti_info_ops) { \
246  APPBUG("Link is not a ipvti link. set type \vti\" first."); \
247  return -NLE_OPNOTSUPP; \
248  }
249 
250 struct rtnl_link *rtnl_link_ipvti_alloc(void)
251 {
252  struct rtnl_link *link;
253  int err;
254 
255  link = rtnl_link_alloc();
256  if (!link)
257  return NULL;
258 
259  err = rtnl_link_set_type(link, "vti");
260  if (err < 0) {
261  rtnl_link_put(link);
262  return NULL;
263  }
264 
265  return link;
266 }
267 
268 /**
269  * Check if link is a IPVTI link
270  * @arg link Link object
271  *
272  * @return True if link is a IPVTI link, otherwise 0 is returned.
273  */
274 int rtnl_link_is_ipvti(struct rtnl_link *link)
275 {
276  return link->l_info_ops && !strcmp(link->l_info_ops->io_name, "vti");
277 }
278 /**
279  * Create a new ipvti tunnel device
280  * @arg sock netlink socket
281  * @arg name name of the tunnel deviceL
282  *
283  * Creates a new ipvti tunnel device in the kernel
284  * @return 0 on success or a negative error code
285  */
286 int rtnl_link_ipvti_add(struct nl_sock *sk, const char *name)
287 {
288  struct rtnl_link *link;
289  int err;
290 
291  link = rtnl_link_ipvti_alloc();
292  if (!link)
293  return -NLE_NOMEM;
294 
295  if(name)
296  rtnl_link_set_name(link, name);
297 
298  err = rtnl_link_add(sk, link, NLM_F_CREATE);
299  rtnl_link_put(link);
300 
301  return err;
302 }
303 /**
304  * Set IPVTI tunnel interface index
305  * @arg link Link object
306  * @arg index interface index
307  *
308  * @return 0 on success or a negative error code
309  */
310 int rtnl_link_ipvti_set_link(struct rtnl_link *link, uint32_t index)
311 {
312  struct ipvti_info *ipvti = link->l_info;
313 
314  IS_IPVTI_LINK_ASSERT(link);
315 
316  ipvti->link = index;
317  ipvti->ipvti_mask |= IPVTI_ATTR_LINK;
318 
319  return 0;
320 }
321 
322 /**
323  * Get IPVTI tunnel interface index
324  * @arg link Link object
325  *
326  * @return interface index
327  */
328 uint32_t rtnl_link_ipvti_get_link(struct rtnl_link *link)
329 {
330  struct ipvti_info *ipvti = link->l_info;
331 
332  IS_IPVTI_LINK_ASSERT(link);
333 
334  return ipvti->link;
335 }
336 
337 /**
338  * Set IPVTI tunnel set ikey
339  * @arg link Link object
340  * @arg ikey gre ikey
341  *
342  * @return 0 on success or a negative error code
343  */
344 int rtnl_link_ipvti_set_ikey(struct rtnl_link *link, uint32_t ikey)
345 {
346  struct ipvti_info *ipvti = link->l_info;
347 
348  IS_IPVTI_LINK_ASSERT(link);
349 
350  ipvti->ikey = ikey;
351  ipvti->ipvti_mask |= IPVTI_ATTR_IKEY;
352 
353  return 0;
354 }
355 
356 /**
357  * Get IPVTI tunnel ikey
358  * @arg link Link object
359  *
360  * @return ikey
361  */
362 uint32_t rtnl_link_ipvti_get_ikey(struct rtnl_link *link)
363 {
364  struct ipvti_info *ipvti = link->l_info;
365 
366  IS_IPVTI_LINK_ASSERT(link);
367 
368  return ipvti->ikey;
369 }
370 
371 /**
372  * Set IPVTI tunnel set okey
373  * @arg link Link object
374  * @arg okey gre okey
375  *
376  * @return 0 on success or a negative error code
377  */
378 int rtnl_link_ipvti_set_okey(struct rtnl_link *link, uint32_t okey)
379 {
380  struct ipvti_info *ipvti = link->l_info;
381 
382  IS_IPVTI_LINK_ASSERT(link);
383 
384  ipvti->okey = okey;
385  ipvti->ipvti_mask |= IPVTI_ATTR_OKEY;
386 
387  return 0;
388 }
389 
390 /**
391  * Get IPVTI tunnel okey
392  * @arg link Link object
393  *
394  * @return okey value
395  */
396 uint32_t rtnl_link_ipvti_get_okey(struct rtnl_link *link)
397 {
398  struct ipvti_info *ipvti = link->l_info;
399 
400  IS_IPVTI_LINK_ASSERT(link);
401 
402  return ipvti->okey;
403 }
404 
405 /**
406  * Set IPVTI tunnel local address
407  * @arg link Link object
408  * @arg addr local address
409  *
410  * @return 0 on success or a negative error code
411  */
412 int rtnl_link_ipvti_set_local(struct rtnl_link *link, uint32_t addr)
413 {
414  struct ipvti_info *ipvti = link->l_info;
415 
416  IS_IPVTI_LINK_ASSERT(link);
417 
418  ipvti->local = addr;
419  ipvti->ipvti_mask |= IPVTI_ATTR_LOCAL;
420 
421  return 0;
422 }
423 
424 /**
425  * Get IPVTI tunnel local address
426  * @arg link Link object
427  *
428  * @return local address
429  */
430 uint32_t rtnl_link_ipvti_get_local(struct rtnl_link *link)
431 {
432  struct ipvti_info *ipvti = link->l_info;
433 
434  IS_IPVTI_LINK_ASSERT(link);
435 
436  return ipvti->local;
437 }
438 
439 /**
440  * Set IPVTI tunnel remote address
441  * @arg link Link object
442  * @arg remote remote address
443  *
444  * @return 0 on success or a negative error code
445  */
446 int rtnl_link_ipvti_set_remote(struct rtnl_link *link, uint32_t remote)
447 {
448  struct ipvti_info *ipvti = link->l_info;
449 
450  IS_IPVTI_LINK_ASSERT(link);
451 
452  ipvti->remote = remote;
453  ipvti->ipvti_mask |= IPVTI_ATTR_REMOTE;
454 
455  return 0;
456 }
457 
458 /**
459  * Get IPVTI tunnel remote address
460  * @arg link Link object
461  *
462  * @return remote address on success or a negative error code
463  */
464 uint32_t rtnl_link_ipvti_get_remote(struct rtnl_link *link)
465 {
466  struct ipvti_info *ipvti = link->l_info;
467 
468  IS_IPVTI_LINK_ASSERT(link);
469 
470  return ipvti->remote;
471 }
472 
473 static void __init ipvti_init(void)
474 {
475  rtnl_link_register_info(&ipvti_info_ops);
476 }
477 
478 static void __exit ipvti_exit(void)
479 {
480  rtnl_link_unregister_info(&ipvti_info_ops);
481 }
uint32_t rtnl_link_ipvti_get_ikey(struct rtnl_link *link)
Get IPVTI tunnel ikey.
Definition: ipvti.c:362
Dump object briefly on one line.
Definition: types.h:22
Attribute validation policy.
Definition: attr.h:67
uint32_t rtnl_link_ipvti_get_remote(struct rtnl_link *link)
Get IPVTI tunnel remote address.
Definition: ipvti.c:464
int rtnl_link_ipvti_set_okey(struct rtnl_link *link, uint32_t okey)
Set IPVTI tunnel set okey.
Definition: ipvti.c:378
uint32_t nla_get_u32(const struct nlattr *nla)
Return payload of 32 bit integer attribute.
Definition: attr.c:699
int rtnl_link_is_ipvti(struct rtnl_link *link)
Check if link is a IPVTI link.
Definition: ipvti.c:274
Dump all attributes but no statistics.
Definition: types.h:23
int nla_nest_end(struct nl_msg *msg, struct nlattr *start)
Finalize nesting of attributes.
Definition: attr.c:917
int rtnl_link_ipvti_add(struct nl_sock *sk, const char *name)
Create a new ipvti tunnel device.
Definition: ipvti.c:286
int rtnl_link_ipvti_set_ikey(struct rtnl_link *link, uint32_t ikey)
Set IPVTI tunnel set ikey.
Definition: ipvti.c:344
uint32_t rtnl_link_ipvti_get_okey(struct rtnl_link *link)
Get IPVTI tunnel okey.
Definition: ipvti.c:396
int nla_parse_nested(struct nlattr *tb[], int maxtype, struct nlattr *nla, struct nla_policy *policy)
Create attribute index based on nested attribute.
Definition: attr.c:991
#define NLA_PUT_U32(msg, attrtype, value)
Add 32 bit integer attribute to netlink message.
Definition: attr.h:233
uint32_t rtnl_link_ipvti_get_local(struct rtnl_link *link)
Get IPVTI tunnel local address.
Definition: ipvti.c:430
int rtnl_link_ipvti_set_link(struct rtnl_link *link, uint32_t index)
Set IPVTI tunnel interface index.
Definition: ipvti.c:310
uint16_t type
Type of attribute or NLA_UNSPEC.
Definition: attr.h:69
32 bit integer
Definition: attr.h:41
Dumping parameters.
Definition: types.h:33
void nl_dump(struct nl_dump_params *params, const char *fmt,...)
Dump a formatted character string.
Definition: utils.c:914
int rtnl_link_ipvti_set_local(struct rtnl_link *link, uint32_t addr)
Set IPVTI tunnel local address.
Definition: ipvti.c:412
uint32_t rtnl_link_ipvti_get_link(struct rtnl_link *link)
Get IPVTI tunnel interface index.
Definition: ipvti.c:328
struct nlattr * nla_nest_start(struct nl_msg *msg, int attrtype)
Start a new level of nested attributes.
Definition: attr.c:895
int rtnl_link_ipvti_set_remote(struct rtnl_link *link, uint32_t remote)
Set IPVTI tunnel remote address.
Definition: ipvti.c:446