2 * Geneve: Generic Network Virtualization Encapsulation
4 * Copyright (c) 2014 Nicira, Inc.
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
12 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
14 #include <linux/kernel.h>
15 #include <linux/types.h>
16 #include <linux/module.h>
17 #include <linux/errno.h>
18 #include <linux/slab.h>
19 #include <linux/skbuff.h>
20 #include <linux/list.h>
21 #include <linux/netdevice.h>
24 #include <linux/udp.h>
25 #include <linux/igmp.h>
26 #include <linux/etherdevice.h>
27 #include <linux/if_ether.h>
28 #include <linux/if_vlan.h>
29 #include <linux/ethtool.h>
30 #include <linux/mutex.h>
32 #include <net/ndisc.h>
34 #include <net/ip_tunnels.h>
37 #include <net/rtnetlink.h>
38 #include <net/route.h>
39 #include <net/dsfield.h>
40 #include <net/inet_ecn.h>
41 #include <net/net_namespace.h>
42 #include <net/netns/generic.h>
43 #include <net/geneve.h>
44 #include <net/protocol.h>
45 #include <net/udp_tunnel.h>
46 #if IS_ENABLED(CONFIG_IPV6)
48 #include <net/addrconf.h>
49 #include <net/ip6_tunnel.h>
50 #include <net/ip6_checksum.h>
53 /* Protects sock_list and refcounts. */
54 static DEFINE_MUTEX(geneve_mutex
);
56 /* per-network namespace private data for this module */
58 struct list_head sock_list
;
61 static int geneve_net_id
;
63 static struct geneve_sock
*geneve_find_sock(struct net
*net
,
64 sa_family_t family
, __be16 port
)
66 struct geneve_net
*gn
= net_generic(net
, geneve_net_id
);
67 struct geneve_sock
*gs
;
69 list_for_each_entry(gs
, &gn
->sock_list
, list
) {
70 if (inet_sk(gs
->sock
->sk
)->inet_sport
== port
&&
71 inet_sk(gs
->sock
->sk
)->sk
.sk_family
== family
)
78 static void geneve_build_header(struct genevehdr
*geneveh
,
79 __be16 tun_flags
, u8 vni
[3],
80 u8 options_len
, u8
*options
)
82 geneveh
->ver
= GENEVE_VER
;
83 geneveh
->opt_len
= options_len
/ 4;
84 geneveh
->oam
= !!(tun_flags
& TUNNEL_OAM
);
85 geneveh
->critical
= !!(tun_flags
& TUNNEL_CRIT_OPT
);
87 memcpy(geneveh
->vni
, vni
, 3);
88 geneveh
->proto_type
= htons(ETH_P_TEB
);
91 memcpy(geneveh
->options
, options
, options_len
);
94 /* Transmit a fully formatted Geneve frame.
96 * When calling this function. The skb->data should point
97 * to the geneve header which is fully formed.
99 * This function will add other UDP tunnel headers.
101 int geneve_xmit_skb(struct geneve_sock
*gs
, struct rtable
*rt
,
102 struct sk_buff
*skb
, __be32 src
, __be32 dst
, __u8 tos
,
103 __u8 ttl
, __be16 df
, __be16 src_port
, __be16 dst_port
,
104 __be16 tun_flags
, u8 vni
[3], u8 opt_len
, u8
*opt
,
105 bool csum
, bool xnet
)
107 struct genevehdr
*gnvh
;
111 min_headroom
= LL_RESERVED_SPACE(rt
->dst
.dev
) + rt
->dst
.header_len
112 + GENEVE_BASE_HLEN
+ opt_len
+ sizeof(struct iphdr
)
113 + (skb_vlan_tag_present(skb
) ? VLAN_HLEN
: 0);
115 err
= skb_cow_head(skb
, min_headroom
);
121 skb
= vlan_hwaccel_push_inside(skb
);
125 skb
= udp_tunnel_handle_offloads(skb
, csum
);
129 gnvh
= (struct genevehdr
*)__skb_push(skb
, sizeof(*gnvh
) + opt_len
);
130 geneve_build_header(gnvh
, tun_flags
, vni
, opt_len
, opt
);
132 skb_set_inner_protocol(skb
, htons(ETH_P_TEB
));
134 return udp_tunnel_xmit_skb(rt
, gs
->sock
->sk
, skb
, src
, dst
,
135 tos
, ttl
, df
, src_port
, dst_port
, xnet
,
138 EXPORT_SYMBOL_GPL(geneve_xmit_skb
);
140 static int geneve_hlen(struct genevehdr
*gh
)
142 return sizeof(*gh
) + gh
->opt_len
* 4;
145 static struct sk_buff
**geneve_gro_receive(struct sk_buff
**head
,
147 struct udp_offload
*uoff
)
149 struct sk_buff
*p
, **pp
= NULL
;
150 struct genevehdr
*gh
, *gh2
;
151 unsigned int hlen
, gh_len
, off_gnv
;
152 const struct packet_offload
*ptype
;
156 off_gnv
= skb_gro_offset(skb
);
157 hlen
= off_gnv
+ sizeof(*gh
);
158 gh
= skb_gro_header_fast(skb
, off_gnv
);
159 if (skb_gro_header_hard(skb
, hlen
)) {
160 gh
= skb_gro_header_slow(skb
, hlen
, off_gnv
);
165 if (gh
->ver
!= GENEVE_VER
|| gh
->oam
)
167 gh_len
= geneve_hlen(gh
);
169 hlen
= off_gnv
+ gh_len
;
170 if (skb_gro_header_hard(skb
, hlen
)) {
171 gh
= skb_gro_header_slow(skb
, hlen
, off_gnv
);
178 for (p
= *head
; p
; p
= p
->next
) {
179 if (!NAPI_GRO_CB(p
)->same_flow
)
182 gh2
= (struct genevehdr
*)(p
->data
+ off_gnv
);
183 if (gh
->opt_len
!= gh2
->opt_len
||
184 memcmp(gh
, gh2
, gh_len
)) {
185 NAPI_GRO_CB(p
)->same_flow
= 0;
190 type
= gh
->proto_type
;
193 ptype
= gro_find_receive_by_type(type
);
199 skb_gro_pull(skb
, gh_len
);
200 skb_gro_postpull_rcsum(skb
, gh
, gh_len
);
201 pp
= ptype
->callbacks
.gro_receive(head
, skb
);
206 NAPI_GRO_CB(skb
)->flush
|= flush
;
211 static int geneve_gro_complete(struct sk_buff
*skb
, int nhoff
,
212 struct udp_offload
*uoff
)
214 struct genevehdr
*gh
;
215 struct packet_offload
*ptype
;
220 udp_tunnel_gro_complete(skb
, nhoff
);
222 gh
= (struct genevehdr
*)(skb
->data
+ nhoff
);
223 gh_len
= geneve_hlen(gh
);
224 type
= gh
->proto_type
;
227 ptype
= gro_find_complete_by_type(type
);
229 err
= ptype
->callbacks
.gro_complete(skb
, nhoff
+ gh_len
);
235 static void geneve_notify_add_rx_port(struct geneve_sock
*gs
)
237 struct sock
*sk
= gs
->sock
->sk
;
238 sa_family_t sa_family
= sk
->sk_family
;
241 if (sa_family
== AF_INET
) {
242 err
= udp_add_offload(&gs
->udp_offloads
);
244 pr_warn("geneve: udp_add_offload failed with status %d\n",
249 static void geneve_notify_del_rx_port(struct geneve_sock
*gs
)
251 struct sock
*sk
= gs
->sock
->sk
;
252 sa_family_t sa_family
= sk
->sk_family
;
254 if (sa_family
== AF_INET
)
255 udp_del_offload(&gs
->udp_offloads
);
258 /* Callback from net/ipv4/udp.c to receive packets */
259 static int geneve_udp_encap_recv(struct sock
*sk
, struct sk_buff
*skb
)
261 struct genevehdr
*geneveh
;
262 struct geneve_sock
*gs
;
265 /* Need Geneve and inner Ethernet header to be present */
266 if (unlikely(!pskb_may_pull(skb
, GENEVE_BASE_HLEN
)))
269 /* Return packets with reserved bits set */
270 geneveh
= geneve_hdr(skb
);
272 if (unlikely(geneveh
->ver
!= GENEVE_VER
))
275 if (unlikely(geneveh
->proto_type
!= htons(ETH_P_TEB
)))
278 opts_len
= geneveh
->opt_len
* 4;
279 if (iptunnel_pull_header(skb
, GENEVE_BASE_HLEN
+ opts_len
,
283 gs
= rcu_dereference_sk_user_data(sk
);
291 /* Consume bad packet */
296 /* Let the UDP layer deal with the skb */
300 static struct socket
*geneve_create_sock(struct net
*net
, bool ipv6
,
304 struct udp_port_cfg udp_conf
;
307 memset(&udp_conf
, 0, sizeof(udp_conf
));
310 udp_conf
.family
= AF_INET6
;
312 udp_conf
.family
= AF_INET
;
313 udp_conf
.local_ip
.s_addr
= htonl(INADDR_ANY
);
316 udp_conf
.local_udp_port
= port
;
318 /* Open UDP socket */
319 err
= udp_sock_create(net
, &udp_conf
, &sock
);
326 /* Create new listen socket if needed */
327 static struct geneve_sock
*geneve_socket_create(struct net
*net
, __be16 port
,
328 geneve_rcv_t
*rcv
, void *data
,
331 struct geneve_net
*gn
= net_generic(net
, geneve_net_id
);
332 struct geneve_sock
*gs
;
334 struct udp_tunnel_sock_cfg tunnel_cfg
;
336 gs
= kzalloc(sizeof(*gs
), GFP_KERNEL
);
338 return ERR_PTR(-ENOMEM
);
340 sock
= geneve_create_sock(net
, ipv6
, port
);
343 return ERR_CAST(sock
);
351 /* Initialize the geneve udp offloads structure */
352 gs
->udp_offloads
.port
= port
;
353 gs
->udp_offloads
.callbacks
.gro_receive
= geneve_gro_receive
;
354 gs
->udp_offloads
.callbacks
.gro_complete
= geneve_gro_complete
;
355 geneve_notify_add_rx_port(gs
);
357 /* Mark socket as an encapsulation socket */
358 tunnel_cfg
.sk_user_data
= gs
;
359 tunnel_cfg
.encap_type
= 1;
360 tunnel_cfg
.encap_rcv
= geneve_udp_encap_recv
;
361 tunnel_cfg
.encap_destroy
= NULL
;
362 setup_udp_tunnel_sock(net
, sock
, &tunnel_cfg
);
364 list_add(&gs
->list
, &gn
->sock_list
);
369 struct geneve_sock
*geneve_sock_add(struct net
*net
, __be16 port
,
370 geneve_rcv_t
*rcv
, void *data
,
371 bool no_share
, bool ipv6
)
373 struct geneve_sock
*gs
;
375 mutex_lock(&geneve_mutex
);
377 gs
= geneve_find_sock(net
, ipv6
? AF_INET6
: AF_INET
, port
);
379 if (!no_share
&& gs
->rcv
== rcv
)
382 gs
= ERR_PTR(-EBUSY
);
384 gs
= geneve_socket_create(net
, port
, rcv
, data
, ipv6
);
387 mutex_unlock(&geneve_mutex
);
391 EXPORT_SYMBOL_GPL(geneve_sock_add
);
393 void geneve_sock_release(struct geneve_sock
*gs
)
395 mutex_lock(&geneve_mutex
);
401 geneve_notify_del_rx_port(gs
);
402 udp_tunnel_sock_release(gs
->sock
);
406 mutex_unlock(&geneve_mutex
);
408 EXPORT_SYMBOL_GPL(geneve_sock_release
);
410 static __net_init
int geneve_init_net(struct net
*net
)
412 struct geneve_net
*gn
= net_generic(net
, geneve_net_id
);
414 INIT_LIST_HEAD(&gn
->sock_list
);
419 static struct pernet_operations geneve_net_ops
= {
420 .init
= geneve_init_net
,
421 .id
= &geneve_net_id
,
422 .size
= sizeof(struct geneve_net
),
425 static int __init
geneve_init_module(void)
429 rc
= register_pernet_subsys(&geneve_net_ops
);
433 pr_info("Geneve core logic\n");
437 module_init(geneve_init_module
);
439 static void __exit
geneve_cleanup_module(void)
441 unregister_pernet_subsys(&geneve_net_ops
);
443 module_exit(geneve_cleanup_module
);
445 MODULE_LICENSE("GPL");
446 MODULE_AUTHOR("Jesse Gross <jesse@nicira.com>");
447 MODULE_DESCRIPTION("Driver library for GENEVE encapsulated traffic");