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/rculist.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/hash.h>
30 #include <linux/ethtool.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 #define PORT_HASH_BITS 8
54 #define PORT_HASH_SIZE (1<<PORT_HASH_BITS)
56 /* per-network namespace private data for this module */
58 struct hlist_head sock_list[PORT_HASH_SIZE];
59 spinlock_t sock_lock; /* Protects sock_list */
62 static int geneve_net_id;
64 static struct workqueue_struct *geneve_wq;
66 static inline struct genevehdr *geneve_hdr(const struct sk_buff *skb)
68 return (struct genevehdr *)(udp_hdr(skb) + 1);
71 static struct hlist_head *gs_head(struct net *net, __be16 port)
73 struct geneve_net *gn = net_generic(net, geneve_net_id);
75 return &gn->sock_list[hash_32(ntohs(port), PORT_HASH_BITS)];
78 /* Find geneve socket based on network namespace and UDP port */
79 static struct geneve_sock *geneve_find_sock(struct net *net, __be16 port)
81 struct geneve_sock *gs;
83 hlist_for_each_entry_rcu(gs, gs_head(net, port), hlist) {
84 if (inet_sk(gs->sock->sk)->inet_sport == port)
91 static void geneve_build_header(struct genevehdr *geneveh,
92 __be16 tun_flags, u8 vni[3],
93 u8 options_len, u8 *options)
95 geneveh->ver = GENEVE_VER;
96 geneveh->opt_len = options_len / 4;
97 geneveh->oam = !!(tun_flags & TUNNEL_OAM);
98 geneveh->critical = !!(tun_flags & TUNNEL_CRIT_OPT);
100 memcpy(geneveh->vni, vni, 3);
101 geneveh->proto_type = htons(ETH_P_TEB);
104 memcpy(geneveh->options, options, options_len);
107 /* Transmit a fully formatted Geneve frame.
109 * When calling this function. The skb->data should point
110 * to the geneve header which is fully formed.
112 * This function will add other UDP tunnel headers.
114 int geneve_xmit_skb(struct geneve_sock *gs, struct rtable *rt,
115 struct sk_buff *skb, __be32 src, __be32 dst, __u8 tos,
116 __u8 ttl, __be16 df, __be16 src_port, __be16 dst_port,
117 __be16 tun_flags, u8 vni[3], u8 opt_len, u8 *opt,
120 struct genevehdr *gnvh;
124 skb = udp_tunnel_handle_offloads(skb, !gs->sock->sk->sk_no_check_tx);
126 min_headroom = LL_RESERVED_SPACE(rt->dst.dev) + rt->dst.header_len
127 + GENEVE_BASE_HLEN + opt_len + sizeof(struct iphdr)
128 + (vlan_tx_tag_present(skb) ? VLAN_HLEN : 0);
130 err = skb_cow_head(skb, min_headroom);
134 skb = vlan_hwaccel_push_inside(skb);
138 gnvh = (struct genevehdr *)__skb_push(skb, sizeof(*gnvh) + opt_len);
139 geneve_build_header(gnvh, tun_flags, vni, opt_len, opt);
141 skb_set_inner_protocol(skb, htons(ETH_P_TEB));
143 return udp_tunnel_xmit_skb(gs->sock, rt, skb, src, dst,
144 tos, ttl, df, src_port, dst_port, xnet);
146 EXPORT_SYMBOL_GPL(geneve_xmit_skb);
148 static void geneve_notify_add_rx_port(struct geneve_sock *gs)
150 struct sock *sk = gs->sock->sk;
151 sa_family_t sa_family = sk->sk_family;
154 if (sa_family == AF_INET) {
155 err = udp_add_offload(&gs->udp_offloads);
157 pr_warn("geneve: udp_add_offload failed with status %d\n",
162 static void geneve_notify_del_rx_port(struct geneve_sock *gs)
164 struct sock *sk = gs->sock->sk;
165 sa_family_t sa_family = sk->sk_family;
167 if (sa_family == AF_INET)
168 udp_del_offload(&gs->udp_offloads);
171 /* Callback from net/ipv4/udp.c to receive packets */
172 static int geneve_udp_encap_recv(struct sock *sk, struct sk_buff *skb)
174 struct genevehdr *geneveh;
175 struct geneve_sock *gs;
178 /* Need Geneve and inner Ethernet header to be present */
179 if (unlikely(!pskb_may_pull(skb, GENEVE_BASE_HLEN)))
182 /* Return packets with reserved bits set */
183 geneveh = geneve_hdr(skb);
185 if (unlikely(geneveh->ver != GENEVE_VER))
188 if (unlikely(geneveh->proto_type != htons(ETH_P_TEB)))
191 opts_len = geneveh->opt_len * 4;
192 if (iptunnel_pull_header(skb, GENEVE_BASE_HLEN + opts_len,
196 gs = rcu_dereference_sk_user_data(sk);
204 /* Consume bad packet */
209 /* Let the UDP layer deal with the skb */
213 static void geneve_del_work(struct work_struct *work)
215 struct geneve_sock *gs = container_of(work, struct geneve_sock,
218 udp_tunnel_sock_release(gs->sock);
222 static struct socket *geneve_create_sock(struct net *net, bool ipv6,
226 struct udp_port_cfg udp_conf;
229 memset(&udp_conf, 0, sizeof(udp_conf));
232 udp_conf.family = AF_INET6;
234 udp_conf.family = AF_INET;
235 udp_conf.local_ip.s_addr = htonl(INADDR_ANY);
238 udp_conf.local_udp_port = port;
240 /* Open UDP socket */
241 err = udp_sock_create(net, &udp_conf, &sock);
248 /* Create new listen socket if needed */
249 static struct geneve_sock *geneve_socket_create(struct net *net, __be16 port,
250 geneve_rcv_t *rcv, void *data,
253 struct geneve_net *gn = net_generic(net, geneve_net_id);
254 struct geneve_sock *gs;
256 struct udp_tunnel_sock_cfg tunnel_cfg;
258 gs = kzalloc(sizeof(*gs), GFP_KERNEL);
260 return ERR_PTR(-ENOMEM);
262 INIT_WORK(&gs->del_work, geneve_del_work);
264 sock = geneve_create_sock(net, ipv6, port);
267 return ERR_CAST(sock);
271 atomic_set(&gs->refcnt, 1);
275 /* Initialize the geneve udp offloads structure */
276 gs->udp_offloads.port = port;
277 gs->udp_offloads.callbacks.gro_receive = NULL;
278 gs->udp_offloads.callbacks.gro_complete = NULL;
280 spin_lock(&gn->sock_lock);
281 hlist_add_head_rcu(&gs->hlist, gs_head(net, port));
282 geneve_notify_add_rx_port(gs);
283 spin_unlock(&gn->sock_lock);
285 /* Mark socket as an encapsulation socket */
286 tunnel_cfg.sk_user_data = gs;
287 tunnel_cfg.encap_type = 1;
288 tunnel_cfg.encap_rcv = geneve_udp_encap_recv;
289 tunnel_cfg.encap_destroy = NULL;
290 setup_udp_tunnel_sock(net, sock, &tunnel_cfg);
295 struct geneve_sock *geneve_sock_add(struct net *net, __be16 port,
296 geneve_rcv_t *rcv, void *data,
297 bool no_share, bool ipv6)
299 struct geneve_net *gn = net_generic(net, geneve_net_id);
300 struct geneve_sock *gs;
302 gs = geneve_socket_create(net, port, rcv, data, ipv6);
306 if (no_share) /* Return error if sharing is not allowed. */
307 return ERR_PTR(-EINVAL);
309 spin_lock(&gn->sock_lock);
310 gs = geneve_find_sock(net, port);
311 if (gs && ((gs->rcv != rcv) ||
312 !atomic_add_unless(&gs->refcnt, 1, 0)))
313 gs = ERR_PTR(-EBUSY);
314 spin_unlock(&gn->sock_lock);
317 gs = ERR_PTR(-EINVAL);
321 EXPORT_SYMBOL_GPL(geneve_sock_add);
323 void geneve_sock_release(struct geneve_sock *gs)
325 struct net *net = sock_net(gs->sock->sk);
326 struct geneve_net *gn = net_generic(net, geneve_net_id);
328 if (!atomic_dec_and_test(&gs->refcnt))
331 spin_lock(&gn->sock_lock);
332 hlist_del_rcu(&gs->hlist);
333 geneve_notify_del_rx_port(gs);
334 spin_unlock(&gn->sock_lock);
336 queue_work(geneve_wq, &gs->del_work);
338 EXPORT_SYMBOL_GPL(geneve_sock_release);
340 static __net_init int geneve_init_net(struct net *net)
342 struct geneve_net *gn = net_generic(net, geneve_net_id);
345 spin_lock_init(&gn->sock_lock);
347 for (h = 0; h < PORT_HASH_SIZE; ++h)
348 INIT_HLIST_HEAD(&gn->sock_list[h]);
353 static struct pernet_operations geneve_net_ops = {
354 .init = geneve_init_net,
356 .id = &geneve_net_id,
357 .size = sizeof(struct geneve_net),
360 static int __init geneve_init_module(void)
364 geneve_wq = alloc_workqueue("geneve", 0, 0);
368 rc = register_pernet_subsys(&geneve_net_ops);
372 pr_info("Geneve driver\n");
376 late_initcall(geneve_init_module);
378 static void __exit geneve_cleanup_module(void)
380 destroy_workqueue(geneve_wq);
381 unregister_pernet_subsys(&geneve_net_ops);
383 module_exit(geneve_cleanup_module);
385 MODULE_LICENSE("GPL");
386 MODULE_AUTHOR("Jesse Gross <jesse@nicira.com>");
387 MODULE_DESCRIPTION("Driver for GENEVE encapsulated traffic");
388 MODULE_ALIAS_RTNL_LINK("geneve");