2 * iplink_vxlan.c VXLAN device support
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version
7 * 2 of the License, or (at your option) any later version.
9 * Authors: Stephen Hemminger <shemminger@vyatta.com
17 #include <linux/if_link.h>
18 #include <arpa/inet.h>
22 #include "ip_common.h"
24 #define VXLAN_ATTRSET(attrs, type) (((attrs) & (1L << (type))) != 0)
26 static void print_explain(FILE *f
)
29 "Usage: ... vxlan id VNI\n"
30 " [ { group | remote } IP_ADDRESS ]\n"
34 " [ flowlabel LABEL ]\n"
37 " [ srcport MIN MAX ]\n"
43 " [ ageing SECONDS ]\n"
44 " [ maxaddress NUMBER ]\n"
46 " [ [no]udp6zerocsumtx ]\n"
47 " [ [no]udp6zerocsumrx ]\n"
48 " [ [no]remcsumtx ] [ [no]remcsumrx ]\n"
49 " [ [no]external ] [ gbp ] [ gpe ]\n"
51 "Where: VNI := 0-16777215\n"
52 " ADDR := { IP_ADDRESS | any }\n"
53 " TOS := { NUMBER | inherit }\n"
54 " TTL := { 1..255 | inherit }\n"
55 " LABEL := 0-1048575\n"
59 static void explain(void)
61 print_explain(stderr
);
64 static void check_duparg(__u64
*attrs
, int type
, const char *key
,
67 if (!VXLAN_ATTRSET(*attrs
, type
)) {
68 *attrs
|= (1L << type
);
74 static int vxlan_parse_opt(struct link_util
*lu
, int argc
, char **argv
,
84 bool set_op
= (n
->nlmsg_type
== RTM_NEWLINK
&&
85 !(n
->nlmsg_flags
& NLM_F_CREATE
));
87 saddr
.family
= daddr
.family
= AF_UNSPEC
;
88 saddr
.flags
= daddr
.flags
= 0;
91 if (!matches(*argv
, "id") ||
92 !matches(*argv
, "vni")) {
93 /* We will add ID attribute outside of the loop since we
94 * need to consider metadata information as well.
97 check_duparg(&attrs
, IFLA_VXLAN_ID
, "id", *argv
);
98 if (get_u32(&vni
, *argv
, 0) ||
100 invarg("invalid id", *argv
);
101 } else if (!matches(*argv
, "group")) {
102 if (is_addrtype_inet_not_multi(&daddr
)) {
103 fprintf(stderr
, "vxlan: both group and remote");
104 fprintf(stderr
, " cannot be specified\n");
108 check_duparg(&attrs
, IFLA_VXLAN_GROUP
, "group", *argv
);
109 get_addr(&daddr
, *argv
, saddr
.family
);
110 if (!is_addrtype_inet_multi(&daddr
))
111 invarg("invalid group address", *argv
);
112 } else if (!matches(*argv
, "remote")) {
113 if (is_addrtype_inet_multi(&daddr
)) {
114 fprintf(stderr
, "vxlan: both group and remote");
115 fprintf(stderr
, " cannot be specified\n");
119 check_duparg(&attrs
, IFLA_VXLAN_GROUP
, "remote", *argv
);
120 get_addr(&daddr
, *argv
, saddr
.family
);
121 if (!is_addrtype_inet_not_multi(&daddr
))
122 invarg("invalid remote address", *argv
);
123 } else if (!matches(*argv
, "local")) {
125 check_duparg(&attrs
, IFLA_VXLAN_LOCAL
, "local", *argv
);
126 get_addr(&saddr
, *argv
, daddr
.family
);
127 if (!is_addrtype_inet_not_multi(&saddr
))
128 invarg("invalid local address", *argv
);
129 } else if (!matches(*argv
, "dev")) {
133 check_duparg(&attrs
, IFLA_VXLAN_LINK
, "dev", *argv
);
134 link
= if_nametoindex(*argv
);
136 fprintf(stderr
, "Cannot find device \"%s\"\n",
140 addattr32(n
, 1024, IFLA_VXLAN_LINK
, link
);
141 } else if (!matches(*argv
, "ttl") ||
142 !matches(*argv
, "hoplimit")) {
147 check_duparg(&attrs
, IFLA_VXLAN_TTL
, "ttl", *argv
);
148 if (strcmp(*argv
, "inherit") != 0) {
149 if (get_unsigned(&uval
, *argv
, 0))
150 invarg("invalid TTL", *argv
);
152 invarg("TTL must be <= 255", *argv
);
155 addattr8(n
, 1024, IFLA_VXLAN_TTL
, ttl
);
156 } else if (!matches(*argv
, "tos") ||
157 !matches(*argv
, "dsfield")) {
162 check_duparg(&attrs
, IFLA_VXLAN_TOS
, "tos", *argv
);
163 if (strcmp(*argv
, "inherit") != 0) {
164 if (rtnl_dsfield_a2n(&uval
, *argv
))
165 invarg("bad TOS value", *argv
);
169 addattr8(n
, 1024, IFLA_VXLAN_TOS
, tos
);
170 } else if (!matches(*argv
, "label") ||
171 !matches(*argv
, "flowlabel")) {
175 check_duparg(&attrs
, IFLA_VXLAN_LABEL
, "flowlabel",
177 if (get_u32(&uval
, *argv
, 0) ||
178 (uval
& ~LABEL_MAX_MASK
))
179 invarg("invalid flowlabel", *argv
);
180 addattr32(n
, 1024, IFLA_VXLAN_LABEL
, htonl(uval
));
181 } else if (!matches(*argv
, "ageing")) {
185 check_duparg(&attrs
, IFLA_VXLAN_AGEING
, "ageing",
187 if (strcmp(*argv
, "none") == 0)
189 else if (get_u32(&age
, *argv
, 0))
190 invarg("ageing timer", *argv
);
191 addattr32(n
, 1024, IFLA_VXLAN_AGEING
, age
);
192 } else if (!matches(*argv
, "maxaddress")) {
196 check_duparg(&attrs
, IFLA_VXLAN_LIMIT
,
197 "maxaddress", *argv
);
198 if (strcmp(*argv
, "unlimited") == 0)
200 else if (get_u32(&maxaddr
, *argv
, 0))
201 invarg("max addresses", *argv
);
202 addattr32(n
, 1024, IFLA_VXLAN_LIMIT
, maxaddr
);
203 } else if (!matches(*argv
, "port") ||
204 !matches(*argv
, "srcport")) {
205 struct ifla_vxlan_port_range range
= { 0, 0 };
208 check_duparg(&attrs
, IFLA_VXLAN_PORT_RANGE
, "srcport",
210 if (get_be16(&range
.low
, *argv
, 0))
211 invarg("min port", *argv
);
213 if (get_be16(&range
.high
, *argv
, 0))
214 invarg("max port", *argv
);
215 if (range
.low
|| range
.high
) {
216 addattr_l(n
, 1024, IFLA_VXLAN_PORT_RANGE
,
217 &range
, sizeof(range
));
219 } else if (!matches(*argv
, "dstport")) {
221 check_duparg(&attrs
, IFLA_VXLAN_PORT
, "dstport", *argv
);
222 if (get_u16(&dstport
, *argv
, 0))
223 invarg("dst port", *argv
);
224 } else if (!matches(*argv
, "nolearning")) {
225 check_duparg(&attrs
, IFLA_VXLAN_LEARNING
, *argv
, *argv
);
227 } else if (!matches(*argv
, "learning")) {
228 check_duparg(&attrs
, IFLA_VXLAN_LEARNING
, *argv
, *argv
);
230 } else if (!matches(*argv
, "noproxy")) {
231 check_duparg(&attrs
, IFLA_VXLAN_PROXY
, *argv
, *argv
);
232 addattr8(n
, 1024, IFLA_VXLAN_PROXY
, 0);
233 } else if (!matches(*argv
, "proxy")) {
234 check_duparg(&attrs
, IFLA_VXLAN_PROXY
, *argv
, *argv
);
235 addattr8(n
, 1024, IFLA_VXLAN_PROXY
, 1);
236 } else if (!matches(*argv
, "norsc")) {
237 check_duparg(&attrs
, IFLA_VXLAN_RSC
, *argv
, *argv
);
238 addattr8(n
, 1024, IFLA_VXLAN_RSC
, 0);
239 } else if (!matches(*argv
, "rsc")) {
240 check_duparg(&attrs
, IFLA_VXLAN_RSC
, *argv
, *argv
);
241 addattr8(n
, 1024, IFLA_VXLAN_RSC
, 1);
242 } else if (!matches(*argv
, "nol2miss")) {
243 check_duparg(&attrs
, IFLA_VXLAN_L2MISS
, *argv
, *argv
);
244 addattr8(n
, 1024, IFLA_VXLAN_L2MISS
, 0);
245 } else if (!matches(*argv
, "l2miss")) {
246 check_duparg(&attrs
, IFLA_VXLAN_L2MISS
, *argv
, *argv
);
247 addattr8(n
, 1024, IFLA_VXLAN_L2MISS
, 1);
248 } else if (!matches(*argv
, "nol3miss")) {
249 check_duparg(&attrs
, IFLA_VXLAN_L3MISS
, *argv
, *argv
);
250 addattr8(n
, 1024, IFLA_VXLAN_L3MISS
, 0);
251 } else if (!matches(*argv
, "l3miss")) {
252 check_duparg(&attrs
, IFLA_VXLAN_L3MISS
, *argv
, *argv
);
253 addattr8(n
, 1024, IFLA_VXLAN_L3MISS
, 1);
254 } else if (!matches(*argv
, "udpcsum")) {
255 check_duparg(&attrs
, IFLA_VXLAN_UDP_CSUM
, *argv
, *argv
);
256 addattr8(n
, 1024, IFLA_VXLAN_UDP_CSUM
, 1);
257 } else if (!matches(*argv
, "noudpcsum")) {
258 check_duparg(&attrs
, IFLA_VXLAN_UDP_CSUM
, *argv
, *argv
);
259 addattr8(n
, 1024, IFLA_VXLAN_UDP_CSUM
, 0);
260 } else if (!matches(*argv
, "udp6zerocsumtx")) {
261 check_duparg(&attrs
, IFLA_VXLAN_UDP_ZERO_CSUM6_TX
,
263 addattr8(n
, 1024, IFLA_VXLAN_UDP_ZERO_CSUM6_TX
, 1);
264 } else if (!matches(*argv
, "noudp6zerocsumtx")) {
265 check_duparg(&attrs
, IFLA_VXLAN_UDP_ZERO_CSUM6_TX
,
267 addattr8(n
, 1024, IFLA_VXLAN_UDP_ZERO_CSUM6_TX
, 0);
268 } else if (!matches(*argv
, "udp6zerocsumrx")) {
269 check_duparg(&attrs
, IFLA_VXLAN_UDP_ZERO_CSUM6_RX
,
271 addattr8(n
, 1024, IFLA_VXLAN_UDP_ZERO_CSUM6_RX
, 1);
272 } else if (!matches(*argv
, "noudp6zerocsumrx")) {
273 check_duparg(&attrs
, IFLA_VXLAN_UDP_ZERO_CSUM6_RX
,
275 addattr8(n
, 1024, IFLA_VXLAN_UDP_ZERO_CSUM6_RX
, 0);
276 } else if (!matches(*argv
, "remcsumtx")) {
277 check_duparg(&attrs
, IFLA_VXLAN_REMCSUM_TX
,
279 addattr8(n
, 1024, IFLA_VXLAN_REMCSUM_TX
, 1);
280 } else if (!matches(*argv
, "noremcsumtx")) {
281 check_duparg(&attrs
, IFLA_VXLAN_REMCSUM_TX
,
283 addattr8(n
, 1024, IFLA_VXLAN_REMCSUM_TX
, 0);
284 } else if (!matches(*argv
, "remcsumrx")) {
285 check_duparg(&attrs
, IFLA_VXLAN_REMCSUM_RX
,
287 addattr8(n
, 1024, IFLA_VXLAN_REMCSUM_RX
, 1);
288 } else if (!matches(*argv
, "noremcsumrx")) {
289 check_duparg(&attrs
, IFLA_VXLAN_REMCSUM_RX
,
291 addattr8(n
, 1024, IFLA_VXLAN_REMCSUM_RX
, 0);
292 } else if (!matches(*argv
, "external")) {
293 check_duparg(&attrs
, IFLA_VXLAN_COLLECT_METADATA
,
297 /* we will add LEARNING attribute outside of the loop */
298 addattr8(n
, 1024, IFLA_VXLAN_COLLECT_METADATA
,
300 } else if (!matches(*argv
, "noexternal")) {
301 check_duparg(&attrs
, IFLA_VXLAN_COLLECT_METADATA
,
304 addattr8(n
, 1024, IFLA_VXLAN_COLLECT_METADATA
,
306 } else if (!matches(*argv
, "gbp")) {
307 check_duparg(&attrs
, IFLA_VXLAN_GBP
, *argv
, *argv
);
308 addattr_l(n
, 1024, IFLA_VXLAN_GBP
, NULL
, 0);
309 } else if (!matches(*argv
, "gpe")) {
310 check_duparg(&attrs
, IFLA_VXLAN_GPE
, *argv
, *argv
);
311 addattr_l(n
, 1024, IFLA_VXLAN_GPE
, NULL
, 0);
312 } else if (matches(*argv
, "help") == 0) {
316 fprintf(stderr
, "vxlan: unknown command \"%s\"?\n", *argv
);
323 if (metadata
&& VXLAN_ATTRSET(attrs
, IFLA_VXLAN_ID
)) {
324 fprintf(stderr
, "vxlan: both 'external' and vni cannot be specified\n");
328 if (!metadata
&& !VXLAN_ATTRSET(attrs
, IFLA_VXLAN_ID
) && !set_op
) {
329 fprintf(stderr
, "vxlan: missing virtual network identifier\n");
333 if (is_addrtype_inet_multi(&daddr
) &&
334 !VXLAN_ATTRSET(attrs
, IFLA_VXLAN_LINK
)) {
335 fprintf(stderr
, "vxlan: 'group' requires 'dev' to be specified\n");
339 if (!VXLAN_ATTRSET(attrs
, IFLA_VXLAN_PORT
) &&
340 VXLAN_ATTRSET(attrs
, IFLA_VXLAN_GPE
)) {
342 } else if (!VXLAN_ATTRSET(attrs
, IFLA_VXLAN_PORT
) && !set_op
) {
343 fprintf(stderr
, "vxlan: destination port not specified\n"
344 "Will use Linux kernel default (non-standard value)\n");
346 "Use 'dstport 4789' to get the IANA assigned value\n"
347 "Use 'dstport 0' to get default and quiet this message\n");
350 if (VXLAN_ATTRSET(attrs
, IFLA_VXLAN_ID
))
351 addattr32(n
, 1024, IFLA_VXLAN_ID
, vni
);
353 if (is_addrtype_inet(&saddr
)) {
354 int type
= (saddr
.family
== AF_INET
) ? IFLA_VXLAN_LOCAL
356 addattr_l(n
, 1024, type
, saddr
.data
, saddr
.bytelen
);
359 if (is_addrtype_inet(&daddr
)) {
360 int type
= (daddr
.family
== AF_INET
) ? IFLA_VXLAN_GROUP
362 addattr_l(n
, 1024, type
, daddr
.data
, daddr
.bytelen
);
365 if (!set_op
|| VXLAN_ATTRSET(attrs
, IFLA_VXLAN_LEARNING
))
366 addattr8(n
, 1024, IFLA_VXLAN_LEARNING
, learning
);
369 addattr16(n
, 1024, IFLA_VXLAN_PORT
, htons(dstport
));
374 static void vxlan_print_opt(struct link_util
*lu
, FILE *f
, struct rtattr
*tb
[])
384 if (!tb
[IFLA_VXLAN_ID
] ||
385 RTA_PAYLOAD(tb
[IFLA_VXLAN_ID
]) < sizeof(__u32
))
388 vni
= rta_getattr_u32(tb
[IFLA_VXLAN_ID
]);
389 print_uint(PRINT_ANY
, "id", "id %u ", vni
);
391 if (tb
[IFLA_VXLAN_GROUP
]) {
392 __be32 addr
= rta_getattr_u32(tb
[IFLA_VXLAN_GROUP
]);
395 if (IN_MULTICAST(ntohl(addr
)))
396 print_string(PRINT_ANY
,
399 format_host(AF_INET
, 4, &addr
));
401 print_string(PRINT_ANY
,
404 format_host(AF_INET
, 4, &addr
));
406 } else if (tb
[IFLA_VXLAN_GROUP6
]) {
407 struct in6_addr addr
;
409 memcpy(&addr
, RTA_DATA(tb
[IFLA_VXLAN_GROUP6
]), sizeof(struct in6_addr
));
410 if (!IN6_IS_ADDR_UNSPECIFIED(&addr
)) {
411 if (IN6_IS_ADDR_MULTICAST(&addr
))
412 print_string(PRINT_ANY
,
415 format_host(AF_INET6
,
416 sizeof(struct in6_addr
),
419 print_string(PRINT_ANY
,
422 format_host(AF_INET6
,
423 sizeof(struct in6_addr
),
428 if (tb
[IFLA_VXLAN_LOCAL
]) {
429 __be32 addr
= rta_getattr_u32(tb
[IFLA_VXLAN_LOCAL
]);
432 print_string(PRINT_ANY
,
435 format_host(AF_INET
, 4, &addr
));
436 } else if (tb
[IFLA_VXLAN_LOCAL6
]) {
437 struct in6_addr addr
;
439 memcpy(&addr
, RTA_DATA(tb
[IFLA_VXLAN_LOCAL6
]), sizeof(struct in6_addr
));
440 if (!IN6_IS_ADDR_UNSPECIFIED(&addr
))
441 print_string(PRINT_ANY
,
444 format_host(AF_INET6
,
445 sizeof(struct in6_addr
),
449 if (tb
[IFLA_VXLAN_LINK
]) {
450 unsigned int link
= rta_getattr_u32(tb
[IFLA_VXLAN_LINK
]);
453 print_string(PRINT_ANY
, "link", "dev %s ",
454 ll_index_to_name(link
));
458 if (tb
[IFLA_VXLAN_PORT_RANGE
]) {
459 const struct ifla_vxlan_port_range
*r
460 = RTA_DATA(tb
[IFLA_VXLAN_PORT_RANGE
]);
461 if (is_json_context()) {
462 open_json_object("port_range");
463 print_uint(PRINT_JSON
, "low", NULL
, ntohs(r
->low
));
464 print_uint(PRINT_JSON
, "high", NULL
, ntohs(r
->high
));
467 fprintf(f
, "srcport %u %u ",
468 ntohs(r
->low
), ntohs(r
->high
));
472 if (tb
[IFLA_VXLAN_PORT
])
473 print_uint(PRINT_ANY
,
476 rta_getattr_be16(tb
[IFLA_VXLAN_PORT
]));
478 if (tb
[IFLA_VXLAN_LEARNING
]) {
479 __u8 learning
= rta_getattr_u8(tb
[IFLA_VXLAN_LEARNING
]);
481 print_bool(PRINT_JSON
, "learning", NULL
, learning
);
483 print_bool(PRINT_FP
, NULL
, "nolearning ", true);
486 if (tb
[IFLA_VXLAN_PROXY
] && rta_getattr_u8(tb
[IFLA_VXLAN_PROXY
]))
487 print_bool(PRINT_ANY
, "proxy", "proxy ", true);
489 if (tb
[IFLA_VXLAN_RSC
] && rta_getattr_u8(tb
[IFLA_VXLAN_RSC
]))
490 print_bool(PRINT_ANY
, "rsc", "rsc ", true);
492 if (tb
[IFLA_VXLAN_L2MISS
] && rta_getattr_u8(tb
[IFLA_VXLAN_L2MISS
]))
493 print_bool(PRINT_ANY
, "l2miss", "l2miss ", true);
495 if (tb
[IFLA_VXLAN_L3MISS
] && rta_getattr_u8(tb
[IFLA_VXLAN_L3MISS
]))
496 print_bool(PRINT_ANY
, "l3miss", "l3miss ", true);
498 if (tb
[IFLA_VXLAN_TOS
])
499 tos
= rta_getattr_u8(tb
[IFLA_VXLAN_TOS
]);
501 if (is_json_context() || tos
!= 1)
502 print_0xhex(PRINT_ANY
, "tos", "tos 0x%x ", tos
);
504 print_string(PRINT_FP
, NULL
, "tos %s ", "inherit");
507 if (tb
[IFLA_VXLAN_TTL
])
508 ttl
= rta_getattr_u8(tb
[IFLA_VXLAN_TTL
]);
509 if (is_json_context() || ttl
)
510 print_uint(PRINT_ANY
, "ttl", "ttl %u ", ttl
);
512 print_string(PRINT_FP
, NULL
, "ttl %s ", "inherit");
514 if (tb
[IFLA_VXLAN_LABEL
]) {
515 __u32 label
= rta_getattr_u32(tb
[IFLA_VXLAN_LABEL
]);
518 print_0xhex(PRINT_ANY
,
524 if (tb
[IFLA_VXLAN_AGEING
]) {
525 __u32 age
= rta_getattr_u32(tb
[IFLA_VXLAN_AGEING
]);
528 print_uint(PRINT_ANY
, "ageing", "ageing none ", 0);
530 print_uint(PRINT_ANY
, "ageing", "ageing %u ", age
);
533 if (tb
[IFLA_VXLAN_LIMIT
] &&
534 ((maxaddr
= rta_getattr_u32(tb
[IFLA_VXLAN_LIMIT
])) != 0))
535 print_uint(PRINT_ANY
, "limit", "maxaddr %u ", maxaddr
);
537 if (tb
[IFLA_VXLAN_UDP_CSUM
]) {
538 __u8 udp_csum
= rta_getattr_u8(tb
[IFLA_VXLAN_UDP_CSUM
]);
540 if (is_json_context()) {
541 print_bool(PRINT_ANY
, "udp_csum", NULL
, udp_csum
);
545 fputs("udpcsum ", f
);
549 if (tb
[IFLA_VXLAN_UDP_ZERO_CSUM6_TX
]) {
550 __u8 csum6
= rta_getattr_u8(tb
[IFLA_VXLAN_UDP_ZERO_CSUM6_TX
]);
552 if (is_json_context()) {
553 print_bool(PRINT_ANY
,
554 "udp_zero_csum6_tx", NULL
, csum6
);
558 fputs("udp6zerocsumtx ", f
);
562 if (tb
[IFLA_VXLAN_UDP_ZERO_CSUM6_RX
]) {
563 __u8 csum6
= rta_getattr_u8(tb
[IFLA_VXLAN_UDP_ZERO_CSUM6_RX
]);
565 if (is_json_context()) {
566 print_bool(PRINT_ANY
,
573 fputs("udp6zerocsumrx ", f
);
577 if (tb
[IFLA_VXLAN_REMCSUM_TX
] &&
578 rta_getattr_u8(tb
[IFLA_VXLAN_REMCSUM_TX
]))
579 print_bool(PRINT_ANY
, "remcsum_tx", "remcsumtx ", true);
581 if (tb
[IFLA_VXLAN_REMCSUM_RX
] &&
582 rta_getattr_u8(tb
[IFLA_VXLAN_REMCSUM_RX
]))
583 print_bool(PRINT_ANY
, "remcsum_rx", "remcsumrx ", true);
585 if (tb
[IFLA_VXLAN_COLLECT_METADATA
] &&
586 rta_getattr_u8(tb
[IFLA_VXLAN_COLLECT_METADATA
]))
587 print_bool(PRINT_ANY
, "collect_metadata", "external ", true);
589 if (tb
[IFLA_VXLAN_GBP
])
590 print_bool(PRINT_ANY
, "gbp", "gbp ", true);
591 if (tb
[IFLA_VXLAN_GPE
])
592 print_bool(PRINT_ANY
, "gpe", "gpe ", true);
595 static void vxlan_print_help(struct link_util
*lu
, int argc
, char **argv
,
601 struct link_util vxlan_link_util
= {
603 .maxattr
= IFLA_VXLAN_MAX
,
604 .parse_opt
= vxlan_parse_opt
,
605 .print_opt
= vxlan_print_opt
,
606 .print_help
= vxlan_print_help
,