libnl  3.2.28
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  struct rtnl_link *parent;
174 
175  if (ipvti->ipvti_mask & IPVTI_ATTR_LINK) {
176  nl_dump(p, " link ");
177 
178  name = NULL;
179  parent = link_lookup(link->ce_cache, ipvti->link);
180  if (parent)
181  name = rtnl_link_get_name(parent);
182 
183  if (name)
184  nl_dump_line(p, "%s\n", name);
185  else
186  nl_dump_line(p, "%u\n", ipvti->link);
187  }
188 
189  if (ipvti->ipvti_mask & IPVTI_ATTR_IKEY) {
190  nl_dump(p, " ikey ");
191  nl_dump_line(p, "%x\n",ipvti->ikey);
192  }
193 
194  if (ipvti->ipvti_mask & IPVTI_ATTR_OKEY) {
195  nl_dump(p, " okey ");
196  nl_dump_line(p, "%x\n", ipvti->okey);
197  }
198 
199  if (ipvti->ipvti_mask & IPVTI_ATTR_LOCAL) {
200  nl_dump(p, " local ");
201  if(inet_ntop(AF_INET, &ipvti->local, addr, sizeof(addr)))
202  nl_dump_line(p, "%s\n", addr);
203  else
204  nl_dump_line(p, "%#x\n", ntohs(ipvti->local));
205  }
206 
207  if (ipvti->ipvti_mask & IPVTI_ATTR_REMOTE) {
208  nl_dump(p, " remote ");
209  if(inet_ntop(AF_INET, &ipvti->remote, addr, sizeof(addr)))
210  nl_dump_line(p, "%s\n", addr);
211  else
212  nl_dump_line(p, "%#x\n", ntohs(ipvti->remote));
213  }
214 }
215 
216 static int ipvti_clone(struct rtnl_link *dst, struct rtnl_link *src)
217 {
218  struct ipvti_info *ipvti_dst, *ipvti_src = src->l_info;
219  int err;
220 
221  dst->l_info = NULL;
222 
223  err = rtnl_link_set_type(dst, "vti");
224  if (err < 0)
225  return err;
226 
227  ipvti_dst = dst->l_info;
228 
229  if (!ipvti_dst || !ipvti_src)
230  BUG();
231 
232  memcpy(ipvti_dst, ipvti_src, sizeof(struct ipvti_info));
233 
234  return 0;
235 }
236 
237 static struct rtnl_link_info_ops ipvti_info_ops = {
238  .io_name = "vti",
239  .io_alloc = ipvti_alloc,
240  .io_parse = ipvti_parse,
241  .io_dump = {
242  [NL_DUMP_LINE] = ipvti_dump_line,
243  [NL_DUMP_DETAILS] = ipvti_dump_details,
244  },
245  .io_clone = ipvti_clone,
246  .io_put_attrs = ipvti_put_attrs,
247  .io_free = ipvti_free,
248 };
249 
250 #define IS_IPVTI_LINK_ASSERT(link) \
251  if ((link)->l_info_ops != &ipvti_info_ops) { \
252  APPBUG("Link is not a ipvti link. set type \vti\" first."); \
253  return -NLE_OPNOTSUPP; \
254  }
255 
256 struct rtnl_link *rtnl_link_ipvti_alloc(void)
257 {
258  struct rtnl_link *link;
259  int err;
260 
261  link = rtnl_link_alloc();
262  if (!link)
263  return NULL;
264 
265  err = rtnl_link_set_type(link, "vti");
266  if (err < 0) {
267  rtnl_link_put(link);
268  return NULL;
269  }
270 
271  return link;
272 }
273 
274 /**
275  * Check if link is a IPVTI link
276  * @arg link Link object
277  *
278  * @return True if link is a IPVTI link, otherwise 0 is returned.
279  */
280 int rtnl_link_is_ipvti(struct rtnl_link *link)
281 {
282  return link->l_info_ops && !strcmp(link->l_info_ops->io_name, "vti");
283 }
284 /**
285  * Create a new ipvti tunnel device
286  * @arg sock netlink socket
287  * @arg name name of the tunnel deviceL
288  *
289  * Creates a new ipvti tunnel device in the kernel
290  * @return 0 on success or a negative error code
291  */
292 int rtnl_link_ipvti_add(struct nl_sock *sk, const char *name)
293 {
294  struct rtnl_link *link;
295  int err;
296 
297  link = rtnl_link_ipvti_alloc();
298  if (!link)
299  return -NLE_NOMEM;
300 
301  if(name)
302  rtnl_link_set_name(link, name);
303 
304  err = rtnl_link_add(sk, link, NLM_F_CREATE);
305  rtnl_link_put(link);
306 
307  return err;
308 }
309 /**
310  * Set IPVTI tunnel interface index
311  * @arg link Link object
312  * @arg index interface index
313  *
314  * @return 0 on success or a negative error code
315  */
316 int rtnl_link_ipvti_set_link(struct rtnl_link *link, uint32_t index)
317 {
318  struct ipvti_info *ipvti = link->l_info;
319 
320  IS_IPVTI_LINK_ASSERT(link);
321 
322  ipvti->link = index;
323  ipvti->ipvti_mask |= IPVTI_ATTR_LINK;
324 
325  return 0;
326 }
327 
328 /**
329  * Get IPVTI tunnel interface index
330  * @arg link Link object
331  *
332  * @return interface index
333  */
334 uint32_t rtnl_link_ipvti_get_link(struct rtnl_link *link)
335 {
336  struct ipvti_info *ipvti = link->l_info;
337 
338  IS_IPVTI_LINK_ASSERT(link);
339 
340  return ipvti->link;
341 }
342 
343 /**
344  * Set IPVTI tunnel set ikey
345  * @arg link Link object
346  * @arg ikey gre ikey
347  *
348  * @return 0 on success or a negative error code
349  */
350 int rtnl_link_ipvti_set_ikey(struct rtnl_link *link, uint32_t ikey)
351 {
352  struct ipvti_info *ipvti = link->l_info;
353 
354  IS_IPVTI_LINK_ASSERT(link);
355 
356  ipvti->ikey = ikey;
357  ipvti->ipvti_mask |= IPVTI_ATTR_IKEY;
358 
359  return 0;
360 }
361 
362 /**
363  * Get IPVTI tunnel ikey
364  * @arg link Link object
365  *
366  * @return ikey
367  */
368 uint32_t rtnl_link_ipvti_get_ikey(struct rtnl_link *link)
369 {
370  struct ipvti_info *ipvti = link->l_info;
371 
372  IS_IPVTI_LINK_ASSERT(link);
373 
374  return ipvti->ikey;
375 }
376 
377 /**
378  * Set IPVTI tunnel set okey
379  * @arg link Link object
380  * @arg okey gre okey
381  *
382  * @return 0 on success or a negative error code
383  */
384 int rtnl_link_ipvti_set_okey(struct rtnl_link *link, uint32_t okey)
385 {
386  struct ipvti_info *ipvti = link->l_info;
387 
388  IS_IPVTI_LINK_ASSERT(link);
389 
390  ipvti->okey = okey;
391  ipvti->ipvti_mask |= IPVTI_ATTR_OKEY;
392 
393  return 0;
394 }
395 
396 /**
397  * Get IPVTI tunnel okey
398  * @arg link Link object
399  *
400  * @return okey value
401  */
402 uint32_t rtnl_link_ipvti_get_okey(struct rtnl_link *link)
403 {
404  struct ipvti_info *ipvti = link->l_info;
405 
406  IS_IPVTI_LINK_ASSERT(link);
407 
408  return ipvti->okey;
409 }
410 
411 /**
412  * Set IPVTI tunnel local address
413  * @arg link Link object
414  * @arg addr local address
415  *
416  * @return 0 on success or a negative error code
417  */
418 int rtnl_link_ipvti_set_local(struct rtnl_link *link, uint32_t addr)
419 {
420  struct ipvti_info *ipvti = link->l_info;
421 
422  IS_IPVTI_LINK_ASSERT(link);
423 
424  ipvti->local = addr;
425  ipvti->ipvti_mask |= IPVTI_ATTR_LOCAL;
426 
427  return 0;
428 }
429 
430 /**
431  * Get IPVTI tunnel local address
432  * @arg link Link object
433  *
434  * @return local address
435  */
436 uint32_t rtnl_link_ipvti_get_local(struct rtnl_link *link)
437 {
438  struct ipvti_info *ipvti = link->l_info;
439 
440  IS_IPVTI_LINK_ASSERT(link);
441 
442  return ipvti->local;
443 }
444 
445 /**
446  * Set IPVTI tunnel remote address
447  * @arg link Link object
448  * @arg remote remote address
449  *
450  * @return 0 on success or a negative error code
451  */
452 int rtnl_link_ipvti_set_remote(struct rtnl_link *link, uint32_t remote)
453 {
454  struct ipvti_info *ipvti = link->l_info;
455 
456  IS_IPVTI_LINK_ASSERT(link);
457 
458  ipvti->remote = remote;
459  ipvti->ipvti_mask |= IPVTI_ATTR_REMOTE;
460 
461  return 0;
462 }
463 
464 /**
465  * Get IPVTI tunnel remote address
466  * @arg link Link object
467  *
468  * @return remote address on success or a negative error code
469  */
470 uint32_t rtnl_link_ipvti_get_remote(struct rtnl_link *link)
471 {
472  struct ipvti_info *ipvti = link->l_info;
473 
474  IS_IPVTI_LINK_ASSERT(link);
475 
476  return ipvti->remote;
477 }
478 
479 static void __init ipvti_init(void)
480 {
481  rtnl_link_register_info(&ipvti_info_ops);
482 }
483 
484 static void __exit ipvti_exit(void)
485 {
486  rtnl_link_unregister_info(&ipvti_info_ops);
487 }
uint32_t rtnl_link_ipvti_get_ikey(struct rtnl_link *link)
Get IPVTI tunnel ikey.
Definition: ipvti.c:368
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:470
int rtnl_link_ipvti_set_okey(struct rtnl_link *link, uint32_t okey)
Set IPVTI tunnel set okey.
Definition: ipvti.c:384
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:280
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:292
int rtnl_link_ipvti_set_ikey(struct rtnl_link *link, uint32_t ikey)
Set IPVTI tunnel set ikey.
Definition: ipvti.c:350
uint32_t rtnl_link_ipvti_get_okey(struct rtnl_link *link)
Get IPVTI tunnel okey.
Definition: ipvti.c:402
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:992
#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:436
int rtnl_link_ipvti_set_link(struct rtnl_link *link, uint32_t index)
Set IPVTI tunnel interface index.
Definition: ipvti.c:316
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:418
uint32_t rtnl_link_ipvti_get_link(struct rtnl_link *link)
Get IPVTI tunnel interface index.
Definition: ipvti.c:334
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:452