1 /* SPDX-License-Identifier: GPL-2.0 */
3 #define __NET_VXLAN_H 1
5 #include <linux/if_vlan.h>
6 #include <net/udp_tunnel.h>
7 #include <net/dst_metadata.h>
8 #include <net/rtnetlink.h>
9 #include <net/switchdev.h>
10 #include <net/nexthop.h>
12 #define IANA_VXLAN_UDP_PORT 4789
13 #define IANA_VXLAN_GPE_UDP_PORT 4790
15 /* VXLAN protocol (RFC 7348) header:
16 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
17 * |R|R|R|R|I|R|R|R| Reserved |
18 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
19 * | VXLAN Network Identifier (VNI) | Reserved |
20 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
22 * I = VXLAN Network Identifier (VNI) present.
29 /* VXLAN header flags. */
30 #define VXLAN_HF_VNI cpu_to_be32(BIT(27))
32 #define VXLAN_N_VID (1u << 24)
33 #define VXLAN_VID_MASK (VXLAN_N_VID - 1)
34 #define VXLAN_VNI_MASK cpu_to_be32(VXLAN_VID_MASK << 8)
35 #define VXLAN_HLEN (sizeof(struct udphdr) + sizeof(struct vxlanhdr))
37 #define VNI_HASH_BITS 10
38 #define VNI_HASH_SIZE (1<<VNI_HASH_BITS)
39 #define FDB_HASH_BITS 8
40 #define FDB_HASH_SIZE (1<<FDB_HASH_BITS)
42 /* Remote checksum offload for VXLAN (VXLAN_F_REMCSUM_[RT]X):
43 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
44 * |R|R|R|R|I|R|R|R|R|R|C| Reserved |
45 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
46 * | VXLAN Network Identifier (VNI) |O| Csum start |
47 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
49 * C = Remote checksum offload bit. When set indicates that the
50 * remote checksum offload data is present.
52 * O = Offset bit. Indicates the checksum offset relative to
55 * Csum start = Checksum start divided by two.
57 * http://tools.ietf.org/html/draft-herbert-vxlan-rco
60 /* VXLAN-RCO header flags. */
61 #define VXLAN_HF_RCO cpu_to_be32(BIT(21))
63 /* Remote checksum offload header option */
64 #define VXLAN_RCO_MASK cpu_to_be32(0x7f) /* Last byte of vni field */
65 #define VXLAN_RCO_UDP cpu_to_be32(0x80) /* Indicate UDP RCO (TCP when not set *) */
66 #define VXLAN_RCO_SHIFT 1 /* Left shift of start */
67 #define VXLAN_RCO_SHIFT_MASK ((1 << VXLAN_RCO_SHIFT) - 1)
68 #define VXLAN_MAX_REMCSUM_START (0x7f << VXLAN_RCO_SHIFT)
71 * VXLAN Group Based Policy Extension (VXLAN_F_GBP):
72 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
73 * |G|R|R|R|I|R|R|R|R|D|R|R|A|R|R|R| Group Policy ID |
74 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
75 * | VXLAN Network Identifier (VNI) | Reserved |
76 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
78 * G = Group Policy ID present.
80 * D = Don't Learn bit. When set, this bit indicates that the egress
81 * VTEP MUST NOT learn the source address of the encapsulated frame.
83 * A = Indicates that the group policy has already been applied to
84 * this packet. Policies MUST NOT be applied by devices when the
87 * https://tools.ietf.org/html/draft-smith-vxlan-group-policy
91 #ifdef __LITTLE_ENDIAN_BITFIELD
97 #elif defined(__BIG_ENDIAN_BITFIELD)
104 #error "Please fix <asm/byteorder.h>"
110 /* VXLAN-GBP header flags. */
111 #define VXLAN_HF_GBP cpu_to_be32(BIT(31))
113 #define VXLAN_GBP_USED_BITS (VXLAN_HF_GBP | cpu_to_be32(0xFFFFFF))
117 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
118 * |R|R|R|R|R|R|R|R|R|D|R|R|A|R|R|R| Group Policy ID |
119 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
121 #define VXLAN_GBP_DONT_LEARN (BIT(6) << 16)
122 #define VXLAN_GBP_POLICY_APPLIED (BIT(3) << 16)
123 #define VXLAN_GBP_ID_MASK (0xFFFF)
125 #define VXLAN_GBP_MASK (VXLAN_GBP_DONT_LEARN | VXLAN_GBP_POLICY_APPLIED | \
129 * VXLAN Generic Protocol Extension (VXLAN_F_GPE):
130 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
131 * |R|R|Ver|I|P|R|O| Reserved |Next Protocol |
132 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
133 * | VXLAN Network Identifier (VNI) | Reserved |
134 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
136 * Ver = Version. Indicates VXLAN GPE protocol version.
138 * P = Next Protocol Bit. The P bit is set to indicate that the
139 * Next Protocol field is present.
141 * O = OAM Flag Bit. The O bit is set to indicate that the packet
144 * Next Protocol = This 8 bit field indicates the protocol header
145 * immediately following the VXLAN GPE header.
147 * https://tools.ietf.org/html/draft-ietf-nvo3-vxlan-gpe-01
150 struct vxlanhdr_gpe {
151 #if defined(__LITTLE_ENDIAN_BITFIELD)
158 #elif defined(__BIG_ENDIAN_BITFIELD)
159 u8 reserved_flags2:2,
172 /* VXLAN-GPE header flags. */
173 #define VXLAN_HF_VER cpu_to_be32(BIT(29) | BIT(28))
174 #define VXLAN_HF_NP cpu_to_be32(BIT(26))
175 #define VXLAN_HF_OAM cpu_to_be32(BIT(24))
177 #define VXLAN_GPE_USED_BITS (VXLAN_HF_VER | VXLAN_HF_NP | VXLAN_HF_OAM | \
180 struct vxlan_metadata {
184 /* per UDP socket information */
186 struct hlist_node hlist;
188 struct hlist_head vni_list[VNI_HASH_SIZE];
194 struct sockaddr_in sin;
195 struct sockaddr_in6 sin6;
200 union vxlan_addr remote_ip;
205 struct net_device *remote_dev;
206 struct list_head list;
208 struct dst_cache dst_cache;
211 struct vxlan_config {
212 union vxlan_addr remote_ip;
213 union vxlan_addr saddr;
224 unsigned long age_interval;
225 unsigned int addrmax;
227 enum ifla_vxlan_df df;
232 VXLAN_VNI_STATS_RX_DROPS,
233 VXLAN_VNI_STATS_RX_ERRORS,
235 VXLAN_VNI_STATS_TX_DROPS,
236 VXLAN_VNI_STATS_TX_ERRORS,
239 struct vxlan_vni_stats {
250 struct vxlan_vni_stats_pcpu {
251 struct vxlan_vni_stats stats;
252 struct u64_stats_sync syncp;
255 struct vxlan_dev_node {
256 struct hlist_node hlist;
257 struct vxlan_dev *vxlan;
260 struct vxlan_vni_node {
261 struct rhash_head vnode;
262 struct vxlan_dev_node hlist4; /* vni hash table for IPv4 socket */
263 #if IS_ENABLED(CONFIG_IPV6)
264 struct vxlan_dev_node hlist6; /* vni hash table for IPv6 socket */
266 struct list_head vlist;
268 union vxlan_addr remote_ip; /* default remote ip for this vni */
269 struct vxlan_vni_stats_pcpu __percpu *stats;
274 struct vxlan_vni_group {
275 struct rhashtable vni_hash;
276 struct list_head vni_list;
280 /* Pseudo network device */
282 struct vxlan_dev_node hlist4; /* vni hash table for IPv4 socket */
283 #if IS_ENABLED(CONFIG_IPV6)
284 struct vxlan_dev_node hlist6; /* vni hash table for IPv6 socket */
286 struct list_head next; /* vxlan's per namespace list */
287 struct vxlan_sock __rcu *vn4_sock; /* listening socket for IPv4 */
288 #if IS_ENABLED(CONFIG_IPV6)
289 struct vxlan_sock __rcu *vn6_sock; /* listening socket for IPv6 */
291 struct net_device *dev;
292 struct net *net; /* netns for packet i/o */
293 struct vxlan_rdst default_dst; /* default destination */
295 struct timer_list age_timer;
296 spinlock_t hash_lock[FDB_HASH_SIZE];
297 unsigned int addrcnt;
298 struct gro_cells gro_cells;
300 struct vxlan_config cfg;
302 struct vxlan_vni_group __rcu *vnigrp;
304 struct hlist_head fdb_head[FDB_HASH_SIZE];
307 #define VXLAN_F_LEARN 0x01
308 #define VXLAN_F_PROXY 0x02
309 #define VXLAN_F_RSC 0x04
310 #define VXLAN_F_L2MISS 0x08
311 #define VXLAN_F_L3MISS 0x10
312 #define VXLAN_F_IPV6 0x20
313 #define VXLAN_F_UDP_ZERO_CSUM_TX 0x40
314 #define VXLAN_F_UDP_ZERO_CSUM6_TX 0x80
315 #define VXLAN_F_UDP_ZERO_CSUM6_RX 0x100
316 #define VXLAN_F_REMCSUM_TX 0x200
317 #define VXLAN_F_REMCSUM_RX 0x400
318 #define VXLAN_F_GBP 0x800
319 #define VXLAN_F_REMCSUM_NOPARTIAL 0x1000
320 #define VXLAN_F_COLLECT_METADATA 0x2000
321 #define VXLAN_F_GPE 0x4000
322 #define VXLAN_F_IPV6_LINKLOCAL 0x8000
323 #define VXLAN_F_TTL_INHERIT 0x10000
324 #define VXLAN_F_VNIFILTER 0x20000
326 /* Flags that are used in the receive path. These flags must match in
327 * order for a socket to be shareable
329 #define VXLAN_F_RCV_FLAGS (VXLAN_F_GBP | \
331 VXLAN_F_UDP_ZERO_CSUM6_RX | \
332 VXLAN_F_REMCSUM_RX | \
333 VXLAN_F_REMCSUM_NOPARTIAL | \
334 VXLAN_F_COLLECT_METADATA | \
337 /* Flags that can be set together with VXLAN_F_GPE. */
338 #define VXLAN_F_ALLOWED_GPE (VXLAN_F_GPE | \
340 VXLAN_F_IPV6_LINKLOCAL | \
341 VXLAN_F_UDP_ZERO_CSUM_TX | \
342 VXLAN_F_UDP_ZERO_CSUM6_TX | \
343 VXLAN_F_UDP_ZERO_CSUM6_RX | \
344 VXLAN_F_COLLECT_METADATA | \
347 struct net_device *vxlan_dev_create(struct net *net, const char *name,
348 u8 name_assign_type, struct vxlan_config *conf);
350 static inline netdev_features_t vxlan_features_check(struct sk_buff *skb,
351 netdev_features_t features)
355 if (!skb->encapsulation)
358 switch (vlan_get_protocol(skb)) {
359 case htons(ETH_P_IP):
360 l4_hdr = ip_hdr(skb)->protocol;
362 case htons(ETH_P_IPV6):
363 l4_hdr = ipv6_hdr(skb)->nexthdr;
369 if ((l4_hdr == IPPROTO_UDP) &&
370 (skb->inner_protocol_type != ENCAP_TYPE_ETHER ||
371 skb->inner_protocol != htons(ETH_P_TEB) ||
372 (skb_inner_mac_header(skb) - skb_transport_header(skb) !=
373 sizeof(struct udphdr) + sizeof(struct vxlanhdr)) ||
374 (skb->ip_summed != CHECKSUM_NONE &&
375 !can_checksum_protocol(features, inner_eth_hdr(skb)->h_proto))))
376 return features & ~(NETIF_F_CSUM_MASK | NETIF_F_GSO_MASK);
381 /* IP header + UDP + VXLAN + Ethernet header */
382 #define VXLAN_HEADROOM (20 + 8 + 8 + 14)
383 /* IPv6 header + UDP + VXLAN + Ethernet header */
384 #define VXLAN6_HEADROOM (40 + 8 + 8 + 14)
386 static inline struct vxlanhdr *vxlan_hdr(struct sk_buff *skb)
388 return (struct vxlanhdr *)(udp_hdr(skb) + 1);
391 static inline __be32 vxlan_vni(__be32 vni_field)
393 #if defined(__BIG_ENDIAN)
394 return (__force __be32)((__force u32)vni_field >> 8);
396 return (__force __be32)((__force u32)(vni_field & VXLAN_VNI_MASK) << 8);
400 static inline __be32 vxlan_vni_field(__be32 vni)
402 #if defined(__BIG_ENDIAN)
403 return (__force __be32)((__force u32)vni << 8);
405 return (__force __be32)((__force u32)vni >> 8);
409 static inline size_t vxlan_rco_start(__be32 vni_field)
411 return be32_to_cpu(vni_field & VXLAN_RCO_MASK) << VXLAN_RCO_SHIFT;
414 static inline size_t vxlan_rco_offset(__be32 vni_field)
416 return (vni_field & VXLAN_RCO_UDP) ?
417 offsetof(struct udphdr, check) :
418 offsetof(struct tcphdr, check);
421 static inline __be32 vxlan_compute_rco(unsigned int start, unsigned int offset)
423 __be32 vni_field = cpu_to_be32(start >> VXLAN_RCO_SHIFT);
425 if (offset == offsetof(struct udphdr, check))
426 vni_field |= VXLAN_RCO_UDP;
430 static inline unsigned short vxlan_get_sk_family(struct vxlan_sock *vs)
432 return vs->sock->sk->sk_family;
435 #if IS_ENABLED(CONFIG_IPV6)
437 static inline bool vxlan_addr_any(const union vxlan_addr *ipa)
439 if (ipa->sa.sa_family == AF_INET6)
440 return ipv6_addr_any(&ipa->sin6.sin6_addr);
442 return ipa->sin.sin_addr.s_addr == htonl(INADDR_ANY);
445 static inline bool vxlan_addr_multicast(const union vxlan_addr *ipa)
447 if (ipa->sa.sa_family == AF_INET6)
448 return ipv6_addr_is_multicast(&ipa->sin6.sin6_addr);
450 return ipv4_is_multicast(ipa->sin.sin_addr.s_addr);
453 #else /* !IS_ENABLED(CONFIG_IPV6) */
455 static inline bool vxlan_addr_any(const union vxlan_addr *ipa)
457 return ipa->sin.sin_addr.s_addr == htonl(INADDR_ANY);
460 static inline bool vxlan_addr_multicast(const union vxlan_addr *ipa)
462 return ipv4_is_multicast(ipa->sin.sin_addr.s_addr);
465 #endif /* IS_ENABLED(CONFIG_IPV6) */
467 static inline bool netif_is_vxlan(const struct net_device *dev)
469 return dev->rtnl_link_ops &&
470 !strcmp(dev->rtnl_link_ops->kind, "vxlan");
473 struct switchdev_notifier_vxlan_fdb_info {
474 struct switchdev_notifier_info info; /* must be first */
475 union vxlan_addr remote_ip;
479 u8 eth_addr[ETH_ALEN];
485 #if IS_ENABLED(CONFIG_VXLAN)
486 int vxlan_fdb_find_uc(struct net_device *dev, const u8 *mac, __be32 vni,
487 struct switchdev_notifier_vxlan_fdb_info *fdb_info);
488 int vxlan_fdb_replay(const struct net_device *dev, __be32 vni,
489 struct notifier_block *nb,
490 struct netlink_ext_ack *extack);
491 void vxlan_fdb_clear_offload(const struct net_device *dev, __be32 vni);
495 vxlan_fdb_find_uc(struct net_device *dev, const u8 *mac, __be32 vni,
496 struct switchdev_notifier_vxlan_fdb_info *fdb_info)
501 static inline int vxlan_fdb_replay(const struct net_device *dev, __be32 vni,
502 struct notifier_block *nb,
503 struct netlink_ext_ack *extack)
509 vxlan_fdb_clear_offload(const struct net_device *dev, __be32 vni)
514 static inline void vxlan_flag_attr_error(int attrtype,
515 struct netlink_ext_ack *extack)
517 #define VXLAN_FLAG(flg) \
518 case IFLA_VXLAN_##flg: \
519 NL_SET_ERR_MSG_MOD(extack, \
520 "cannot change " #flg " flag"); \
523 VXLAN_FLAG(TTL_INHERIT);
524 VXLAN_FLAG(LEARNING);
529 VXLAN_FLAG(COLLECT_METADATA);
530 VXLAN_FLAG(UDP_ZERO_CSUM6_TX);
531 VXLAN_FLAG(UDP_ZERO_CSUM6_RX);
532 VXLAN_FLAG(REMCSUM_TX);
533 VXLAN_FLAG(REMCSUM_RX);
536 VXLAN_FLAG(REMCSUM_NOPARTIAL);
538 NL_SET_ERR_MSG_MOD(extack, \
539 "cannot change flag");
545 static inline bool vxlan_fdb_nh_path_select(struct nexthop *nh,
547 struct vxlan_rdst *rdst)
549 struct fib_nh_common *nhc;
551 nhc = nexthop_path_fdb_result(nh, hash);
555 switch (nhc->nhc_gw_family) {
557 rdst->remote_ip.sin.sin_addr.s_addr = nhc->nhc_gw.ipv4;
558 rdst->remote_ip.sa.sa_family = AF_INET;
561 rdst->remote_ip.sin6.sin6_addr = nhc->nhc_gw.ipv6;
562 rdst->remote_ip.sa.sa_family = AF_INET6;