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
,
77 inet_prefix saddr
, daddr
;
83 bool set_op
= (n
->nlmsg_type
== RTM_NEWLINK
&&
84 !(n
->nlmsg_flags
& NLM_F_CREATE
));
86 saddr
.family
= daddr
.family
= AF_UNSPEC
;
88 inet_prefix_reset(&saddr
);
89 inet_prefix_reset(&daddr
);
92 if (!matches(*argv
, "id") ||
93 !matches(*argv
, "vni")) {
94 /* We will add ID attribute outside of the loop since we
95 * need to consider metadata information as well.
98 check_duparg(&attrs
, IFLA_VXLAN_ID
, "id", *argv
);
99 if (get_u32(&vni
, *argv
, 0) ||
101 invarg("invalid id", *argv
);
102 } else if (!matches(*argv
, "group")) {
103 if (is_addrtype_inet_not_multi(&daddr
)) {
104 fprintf(stderr
, "vxlan: both group and remote");
105 fprintf(stderr
, " cannot be specified\n");
109 check_duparg(&attrs
, IFLA_VXLAN_GROUP
, "group", *argv
);
110 get_addr(&daddr
, *argv
, saddr
.family
);
111 if (!is_addrtype_inet_multi(&daddr
))
112 invarg("invalid group address", *argv
);
113 } else if (!matches(*argv
, "remote")) {
114 if (is_addrtype_inet_multi(&daddr
)) {
115 fprintf(stderr
, "vxlan: both group and remote");
116 fprintf(stderr
, " cannot be specified\n");
120 check_duparg(&attrs
, IFLA_VXLAN_GROUP
, "remote", *argv
);
121 get_addr(&daddr
, *argv
, saddr
.family
);
122 if (!is_addrtype_inet_not_multi(&daddr
))
123 invarg("invalid remote address", *argv
);
124 } else if (!matches(*argv
, "local")) {
126 check_duparg(&attrs
, IFLA_VXLAN_LOCAL
, "local", *argv
);
127 get_addr(&saddr
, *argv
, daddr
.family
);
128 if (!is_addrtype_inet_not_multi(&saddr
))
129 invarg("invalid local address", *argv
);
130 } else if (!matches(*argv
, "dev")) {
134 check_duparg(&attrs
, IFLA_VXLAN_LINK
, "dev", *argv
);
135 link
= ll_name_to_index(*argv
);
138 addattr32(n
, 1024, IFLA_VXLAN_LINK
, link
);
139 } else if (!matches(*argv
, "ttl") ||
140 !matches(*argv
, "hoplimit")) {
145 check_duparg(&attrs
, IFLA_VXLAN_TTL
, "ttl", *argv
);
146 if (strcmp(*argv
, "inherit") != 0) {
147 if (get_unsigned(&uval
, *argv
, 0))
148 invarg("invalid TTL", *argv
);
150 invarg("TTL must be <= 255", *argv
);
153 addattr8(n
, 1024, IFLA_VXLAN_TTL
, ttl
);
154 } else if (!matches(*argv
, "tos") ||
155 !matches(*argv
, "dsfield")) {
160 check_duparg(&attrs
, IFLA_VXLAN_TOS
, "tos", *argv
);
161 if (strcmp(*argv
, "inherit") != 0) {
162 if (rtnl_dsfield_a2n(&uval
, *argv
))
163 invarg("bad TOS value", *argv
);
167 addattr8(n
, 1024, IFLA_VXLAN_TOS
, tos
);
168 } else if (!matches(*argv
, "label") ||
169 !matches(*argv
, "flowlabel")) {
173 check_duparg(&attrs
, IFLA_VXLAN_LABEL
, "flowlabel",
175 if (get_u32(&uval
, *argv
, 0) ||
176 (uval
& ~LABEL_MAX_MASK
))
177 invarg("invalid flowlabel", *argv
);
178 addattr32(n
, 1024, IFLA_VXLAN_LABEL
, htonl(uval
));
179 } else if (!matches(*argv
, "ageing")) {
183 check_duparg(&attrs
, IFLA_VXLAN_AGEING
, "ageing",
185 if (strcmp(*argv
, "none") == 0)
187 else if (get_u32(&age
, *argv
, 0))
188 invarg("ageing timer", *argv
);
189 addattr32(n
, 1024, IFLA_VXLAN_AGEING
, age
);
190 } else if (!matches(*argv
, "maxaddress")) {
194 check_duparg(&attrs
, IFLA_VXLAN_LIMIT
,
195 "maxaddress", *argv
);
196 if (strcmp(*argv
, "unlimited") == 0)
198 else if (get_u32(&maxaddr
, *argv
, 0))
199 invarg("max addresses", *argv
);
200 addattr32(n
, 1024, IFLA_VXLAN_LIMIT
, maxaddr
);
201 } else if (!matches(*argv
, "port") ||
202 !matches(*argv
, "srcport")) {
203 struct ifla_vxlan_port_range range
= { 0, 0 };
206 check_duparg(&attrs
, IFLA_VXLAN_PORT_RANGE
, "srcport",
208 if (get_be16(&range
.low
, *argv
, 0))
209 invarg("min port", *argv
);
211 if (get_be16(&range
.high
, *argv
, 0))
212 invarg("max port", *argv
);
213 if (range
.low
|| range
.high
) {
214 addattr_l(n
, 1024, IFLA_VXLAN_PORT_RANGE
,
215 &range
, sizeof(range
));
217 } else if (!matches(*argv
, "dstport")) {
219 check_duparg(&attrs
, IFLA_VXLAN_PORT
, "dstport", *argv
);
220 if (get_u16(&dstport
, *argv
, 0))
221 invarg("dst port", *argv
);
222 } else if (!matches(*argv
, "nolearning")) {
223 check_duparg(&attrs
, IFLA_VXLAN_LEARNING
, *argv
, *argv
);
225 } else if (!matches(*argv
, "learning")) {
226 check_duparg(&attrs
, IFLA_VXLAN_LEARNING
, *argv
, *argv
);
228 } else if (!matches(*argv
, "noproxy")) {
229 check_duparg(&attrs
, IFLA_VXLAN_PROXY
, *argv
, *argv
);
230 addattr8(n
, 1024, IFLA_VXLAN_PROXY
, 0);
231 } else if (!matches(*argv
, "proxy")) {
232 check_duparg(&attrs
, IFLA_VXLAN_PROXY
, *argv
, *argv
);
233 addattr8(n
, 1024, IFLA_VXLAN_PROXY
, 1);
234 } else if (!matches(*argv
, "norsc")) {
235 check_duparg(&attrs
, IFLA_VXLAN_RSC
, *argv
, *argv
);
236 addattr8(n
, 1024, IFLA_VXLAN_RSC
, 0);
237 } else if (!matches(*argv
, "rsc")) {
238 check_duparg(&attrs
, IFLA_VXLAN_RSC
, *argv
, *argv
);
239 addattr8(n
, 1024, IFLA_VXLAN_RSC
, 1);
240 } else if (!matches(*argv
, "nol2miss")) {
241 check_duparg(&attrs
, IFLA_VXLAN_L2MISS
, *argv
, *argv
);
242 addattr8(n
, 1024, IFLA_VXLAN_L2MISS
, 0);
243 } else if (!matches(*argv
, "l2miss")) {
244 check_duparg(&attrs
, IFLA_VXLAN_L2MISS
, *argv
, *argv
);
245 addattr8(n
, 1024, IFLA_VXLAN_L2MISS
, 1);
246 } else if (!matches(*argv
, "nol3miss")) {
247 check_duparg(&attrs
, IFLA_VXLAN_L3MISS
, *argv
, *argv
);
248 addattr8(n
, 1024, IFLA_VXLAN_L3MISS
, 0);
249 } else if (!matches(*argv
, "l3miss")) {
250 check_duparg(&attrs
, IFLA_VXLAN_L3MISS
, *argv
, *argv
);
251 addattr8(n
, 1024, IFLA_VXLAN_L3MISS
, 1);
252 } else if (!matches(*argv
, "udpcsum")) {
253 check_duparg(&attrs
, IFLA_VXLAN_UDP_CSUM
, *argv
, *argv
);
254 addattr8(n
, 1024, IFLA_VXLAN_UDP_CSUM
, 1);
255 } else if (!matches(*argv
, "noudpcsum")) {
256 check_duparg(&attrs
, IFLA_VXLAN_UDP_CSUM
, *argv
, *argv
);
257 addattr8(n
, 1024, IFLA_VXLAN_UDP_CSUM
, 0);
258 } else if (!matches(*argv
, "udp6zerocsumtx")) {
259 check_duparg(&attrs
, IFLA_VXLAN_UDP_ZERO_CSUM6_TX
,
261 addattr8(n
, 1024, IFLA_VXLAN_UDP_ZERO_CSUM6_TX
, 1);
262 } else if (!matches(*argv
, "noudp6zerocsumtx")) {
263 check_duparg(&attrs
, IFLA_VXLAN_UDP_ZERO_CSUM6_TX
,
265 addattr8(n
, 1024, IFLA_VXLAN_UDP_ZERO_CSUM6_TX
, 0);
266 } else if (!matches(*argv
, "udp6zerocsumrx")) {
267 check_duparg(&attrs
, IFLA_VXLAN_UDP_ZERO_CSUM6_RX
,
269 addattr8(n
, 1024, IFLA_VXLAN_UDP_ZERO_CSUM6_RX
, 1);
270 } else if (!matches(*argv
, "noudp6zerocsumrx")) {
271 check_duparg(&attrs
, IFLA_VXLAN_UDP_ZERO_CSUM6_RX
,
273 addattr8(n
, 1024, IFLA_VXLAN_UDP_ZERO_CSUM6_RX
, 0);
274 } else if (!matches(*argv
, "remcsumtx")) {
275 check_duparg(&attrs
, IFLA_VXLAN_REMCSUM_TX
,
277 addattr8(n
, 1024, IFLA_VXLAN_REMCSUM_TX
, 1);
278 } else if (!matches(*argv
, "noremcsumtx")) {
279 check_duparg(&attrs
, IFLA_VXLAN_REMCSUM_TX
,
281 addattr8(n
, 1024, IFLA_VXLAN_REMCSUM_TX
, 0);
282 } else if (!matches(*argv
, "remcsumrx")) {
283 check_duparg(&attrs
, IFLA_VXLAN_REMCSUM_RX
,
285 addattr8(n
, 1024, IFLA_VXLAN_REMCSUM_RX
, 1);
286 } else if (!matches(*argv
, "noremcsumrx")) {
287 check_duparg(&attrs
, IFLA_VXLAN_REMCSUM_RX
,
289 addattr8(n
, 1024, IFLA_VXLAN_REMCSUM_RX
, 0);
290 } else if (!matches(*argv
, "external")) {
291 check_duparg(&attrs
, IFLA_VXLAN_COLLECT_METADATA
,
295 /* we will add LEARNING attribute outside of the loop */
296 addattr8(n
, 1024, IFLA_VXLAN_COLLECT_METADATA
,
298 } else if (!matches(*argv
, "noexternal")) {
299 check_duparg(&attrs
, IFLA_VXLAN_COLLECT_METADATA
,
302 addattr8(n
, 1024, IFLA_VXLAN_COLLECT_METADATA
,
304 } else if (!matches(*argv
, "gbp")) {
305 check_duparg(&attrs
, IFLA_VXLAN_GBP
, *argv
, *argv
);
306 addattr_l(n
, 1024, IFLA_VXLAN_GBP
, NULL
, 0);
307 } else if (!matches(*argv
, "gpe")) {
308 check_duparg(&attrs
, IFLA_VXLAN_GPE
, *argv
, *argv
);
309 addattr_l(n
, 1024, IFLA_VXLAN_GPE
, NULL
, 0);
310 } else if (matches(*argv
, "help") == 0) {
314 fprintf(stderr
, "vxlan: unknown command \"%s\"?\n", *argv
);
321 if (metadata
&& VXLAN_ATTRSET(attrs
, IFLA_VXLAN_ID
)) {
322 fprintf(stderr
, "vxlan: both 'external' and vni cannot be specified\n");
326 if (!metadata
&& !VXLAN_ATTRSET(attrs
, IFLA_VXLAN_ID
) && !set_op
) {
327 fprintf(stderr
, "vxlan: missing virtual network identifier\n");
331 if (is_addrtype_inet_multi(&daddr
) &&
332 !VXLAN_ATTRSET(attrs
, IFLA_VXLAN_LINK
)) {
333 fprintf(stderr
, "vxlan: 'group' requires 'dev' to be specified\n");
337 if (!VXLAN_ATTRSET(attrs
, IFLA_VXLAN_PORT
) &&
338 VXLAN_ATTRSET(attrs
, IFLA_VXLAN_GPE
)) {
340 } else if (!VXLAN_ATTRSET(attrs
, IFLA_VXLAN_PORT
) && !set_op
) {
341 fprintf(stderr
, "vxlan: destination port not specified\n"
342 "Will use Linux kernel default (non-standard value)\n");
344 "Use 'dstport 4789' to get the IANA assigned value\n"
345 "Use 'dstport 0' to get default and quiet this message\n");
348 if (VXLAN_ATTRSET(attrs
, IFLA_VXLAN_ID
))
349 addattr32(n
, 1024, IFLA_VXLAN_ID
, vni
);
351 if (is_addrtype_inet(&saddr
)) {
352 int type
= (saddr
.family
== AF_INET
) ? IFLA_VXLAN_LOCAL
354 addattr_l(n
, 1024, type
, saddr
.data
, saddr
.bytelen
);
357 if (is_addrtype_inet(&daddr
)) {
358 int type
= (daddr
.family
== AF_INET
) ? IFLA_VXLAN_GROUP
360 addattr_l(n
, 1024, type
, daddr
.data
, daddr
.bytelen
);
363 if (!set_op
|| VXLAN_ATTRSET(attrs
, IFLA_VXLAN_LEARNING
))
364 addattr8(n
, 1024, IFLA_VXLAN_LEARNING
, learning
);
367 addattr16(n
, 1024, IFLA_VXLAN_PORT
, htons(dstport
));
372 static void vxlan_print_opt(struct link_util
*lu
, FILE *f
, struct rtattr
*tb
[])
382 if (tb
[IFLA_VXLAN_COLLECT_METADATA
] &&
383 rta_getattr_u8(tb
[IFLA_VXLAN_COLLECT_METADATA
])) {
384 print_bool(PRINT_ANY
, "external", "external", true);
388 if (!tb
[IFLA_VXLAN_ID
] ||
389 RTA_PAYLOAD(tb
[IFLA_VXLAN_ID
]) < sizeof(__u32
))
392 vni
= rta_getattr_u32(tb
[IFLA_VXLAN_ID
]);
393 print_uint(PRINT_ANY
, "id", "id %u ", vni
);
395 if (tb
[IFLA_VXLAN_GROUP
]) {
396 __be32 addr
= rta_getattr_u32(tb
[IFLA_VXLAN_GROUP
]);
399 if (IN_MULTICAST(ntohl(addr
)))
400 print_string(PRINT_ANY
,
403 format_host(AF_INET
, 4, &addr
));
405 print_string(PRINT_ANY
,
408 format_host(AF_INET
, 4, &addr
));
410 } else if (tb
[IFLA_VXLAN_GROUP6
]) {
411 struct in6_addr addr
;
413 memcpy(&addr
, RTA_DATA(tb
[IFLA_VXLAN_GROUP6
]), sizeof(struct in6_addr
));
414 if (!IN6_IS_ADDR_UNSPECIFIED(&addr
)) {
415 if (IN6_IS_ADDR_MULTICAST(&addr
))
416 print_string(PRINT_ANY
,
419 format_host(AF_INET6
,
420 sizeof(struct in6_addr
),
423 print_string(PRINT_ANY
,
426 format_host(AF_INET6
,
427 sizeof(struct in6_addr
),
432 if (tb
[IFLA_VXLAN_LOCAL
]) {
433 __be32 addr
= rta_getattr_u32(tb
[IFLA_VXLAN_LOCAL
]);
436 print_string(PRINT_ANY
,
439 format_host(AF_INET
, 4, &addr
));
440 } else if (tb
[IFLA_VXLAN_LOCAL6
]) {
441 struct in6_addr addr
;
443 memcpy(&addr
, RTA_DATA(tb
[IFLA_VXLAN_LOCAL6
]), sizeof(struct in6_addr
));
444 if (!IN6_IS_ADDR_UNSPECIFIED(&addr
))
445 print_string(PRINT_ANY
,
448 format_host(AF_INET6
,
449 sizeof(struct in6_addr
),
453 if (tb
[IFLA_VXLAN_LINK
]) {
454 unsigned int link
= rta_getattr_u32(tb
[IFLA_VXLAN_LINK
]);
457 print_string(PRINT_ANY
, "link", "dev %s ",
458 ll_index_to_name(link
));
462 if (tb
[IFLA_VXLAN_PORT_RANGE
]) {
463 const struct ifla_vxlan_port_range
*r
464 = RTA_DATA(tb
[IFLA_VXLAN_PORT_RANGE
]);
465 if (is_json_context()) {
466 open_json_object("port_range");
467 print_uint(PRINT_JSON
, "low", NULL
, ntohs(r
->low
));
468 print_uint(PRINT_JSON
, "high", NULL
, ntohs(r
->high
));
471 fprintf(f
, "srcport %u %u ",
472 ntohs(r
->low
), ntohs(r
->high
));
476 if (tb
[IFLA_VXLAN_PORT
])
477 print_uint(PRINT_ANY
,
480 rta_getattr_be16(tb
[IFLA_VXLAN_PORT
]));
482 if (tb
[IFLA_VXLAN_LEARNING
]) {
483 __u8 learning
= rta_getattr_u8(tb
[IFLA_VXLAN_LEARNING
]);
485 print_bool(PRINT_JSON
, "learning", NULL
, learning
);
487 print_bool(PRINT_FP
, NULL
, "nolearning ", true);
490 if (tb
[IFLA_VXLAN_PROXY
] && rta_getattr_u8(tb
[IFLA_VXLAN_PROXY
]))
491 print_bool(PRINT_ANY
, "proxy", "proxy ", true);
493 if (tb
[IFLA_VXLAN_RSC
] && rta_getattr_u8(tb
[IFLA_VXLAN_RSC
]))
494 print_bool(PRINT_ANY
, "rsc", "rsc ", true);
496 if (tb
[IFLA_VXLAN_L2MISS
] && rta_getattr_u8(tb
[IFLA_VXLAN_L2MISS
]))
497 print_bool(PRINT_ANY
, "l2miss", "l2miss ", true);
499 if (tb
[IFLA_VXLAN_L3MISS
] && rta_getattr_u8(tb
[IFLA_VXLAN_L3MISS
]))
500 print_bool(PRINT_ANY
, "l3miss", "l3miss ", true);
502 if (tb
[IFLA_VXLAN_TOS
])
503 tos
= rta_getattr_u8(tb
[IFLA_VXLAN_TOS
]);
505 if (is_json_context() || tos
!= 1)
506 print_0xhex(PRINT_ANY
, "tos", "tos 0x%x ", tos
);
508 print_string(PRINT_FP
, NULL
, "tos %s ", "inherit");
511 if (tb
[IFLA_VXLAN_TTL
])
512 ttl
= rta_getattr_u8(tb
[IFLA_VXLAN_TTL
]);
513 if (is_json_context() || ttl
)
514 print_uint(PRINT_ANY
, "ttl", "ttl %u ", ttl
);
516 print_string(PRINT_FP
, NULL
, "ttl %s ", "inherit");
518 if (tb
[IFLA_VXLAN_LABEL
]) {
519 __u32 label
= rta_getattr_u32(tb
[IFLA_VXLAN_LABEL
]);
522 print_0xhex(PRINT_ANY
,
528 if (tb
[IFLA_VXLAN_AGEING
]) {
529 __u32 age
= rta_getattr_u32(tb
[IFLA_VXLAN_AGEING
]);
532 print_uint(PRINT_ANY
, "ageing", "ageing none ", 0);
534 print_uint(PRINT_ANY
, "ageing", "ageing %u ", age
);
537 if (tb
[IFLA_VXLAN_LIMIT
] &&
538 ((maxaddr
= rta_getattr_u32(tb
[IFLA_VXLAN_LIMIT
])) != 0))
539 print_uint(PRINT_ANY
, "limit", "maxaddr %u ", maxaddr
);
541 if (tb
[IFLA_VXLAN_UDP_CSUM
]) {
542 __u8 udp_csum
= rta_getattr_u8(tb
[IFLA_VXLAN_UDP_CSUM
]);
544 if (is_json_context()) {
545 print_bool(PRINT_ANY
, "udp_csum", NULL
, udp_csum
);
549 fputs("udpcsum ", f
);
553 if (tb
[IFLA_VXLAN_UDP_ZERO_CSUM6_TX
]) {
554 __u8 csum6
= rta_getattr_u8(tb
[IFLA_VXLAN_UDP_ZERO_CSUM6_TX
]);
556 if (is_json_context()) {
557 print_bool(PRINT_ANY
,
558 "udp_zero_csum6_tx", NULL
, csum6
);
562 fputs("udp6zerocsumtx ", f
);
566 if (tb
[IFLA_VXLAN_UDP_ZERO_CSUM6_RX
]) {
567 __u8 csum6
= rta_getattr_u8(tb
[IFLA_VXLAN_UDP_ZERO_CSUM6_RX
]);
569 if (is_json_context()) {
570 print_bool(PRINT_ANY
,
577 fputs("udp6zerocsumrx ", f
);
581 if (tb
[IFLA_VXLAN_REMCSUM_TX
] &&
582 rta_getattr_u8(tb
[IFLA_VXLAN_REMCSUM_TX
]))
583 print_bool(PRINT_ANY
, "remcsum_tx", "remcsumtx ", true);
585 if (tb
[IFLA_VXLAN_REMCSUM_RX
] &&
586 rta_getattr_u8(tb
[IFLA_VXLAN_REMCSUM_RX
]))
587 print_bool(PRINT_ANY
, "remcsum_rx", "remcsumrx ", 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
,