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);
128 min_headroom = LL_RESERVED_SPACE(rt->dst.dev) + rt->dst.header_len
129 + GENEVE_BASE_HLEN + opt_len + sizeof(struct iphdr)
130 + (vlan_tx_tag_present(skb) ? VLAN_HLEN : 0);
132 err = skb_cow_head(skb, min_headroom);
138 skb = vlan_hwaccel_push_inside(skb);
142 gnvh = (struct genevehdr *)__skb_push(skb, sizeof(*gnvh) + opt_len);
143 geneve_build_header(gnvh, tun_flags, vni, opt_len, opt);
145 skb_set_inner_protocol(skb, htons(ETH_P_TEB));
147 return udp_tunnel_xmit_skb(gs->sock, rt, skb, src, dst,
148 tos, ttl, df, src_port, dst_port, xnet);
150 EXPORT_SYMBOL_GPL(geneve_xmit_skb);
152 static void geneve_notify_add_rx_port(struct geneve_sock *gs)
154 struct sock *sk = gs->sock->sk;
155 sa_family_t sa_family = sk->sk_family;
158 if (sa_family == AF_INET) {
159 err = udp_add_offload(&gs->udp_offloads);
161 pr_warn("geneve: udp_add_offload failed with status %d\n",
166 static void geneve_notify_del_rx_port(struct geneve_sock *gs)
168 struct sock *sk = gs->sock->sk;
169 sa_family_t sa_family = sk->sk_family;
171 if (sa_family == AF_INET)
172 udp_del_offload(&gs->udp_offloads);
175 /* Callback from net/ipv4/udp.c to receive packets */
176 static int geneve_udp_encap_recv(struct sock *sk, struct sk_buff *skb)
178 struct genevehdr *geneveh;
179 struct geneve_sock *gs;
182 /* Need Geneve and inner Ethernet header to be present */
183 if (unlikely(!pskb_may_pull(skb, GENEVE_BASE_HLEN)))
186 /* Return packets with reserved bits set */
187 geneveh = geneve_hdr(skb);
189 if (unlikely(geneveh->ver != GENEVE_VER))
192 if (unlikely(geneveh->proto_type != htons(ETH_P_TEB)))
195 opts_len = geneveh->opt_len * 4;
196 if (iptunnel_pull_header(skb, GENEVE_BASE_HLEN + opts_len,
200 gs = rcu_dereference_sk_user_data(sk);
208 /* Consume bad packet */
213 /* Let the UDP layer deal with the skb */
217 static void geneve_del_work(struct work_struct *work)
219 struct geneve_sock *gs = container_of(work, struct geneve_sock,
222 udp_tunnel_sock_release(gs->sock);
226 static struct socket *geneve_create_sock(struct net *net, bool ipv6,
230 struct udp_port_cfg udp_conf;
233 memset(&udp_conf, 0, sizeof(udp_conf));
236 udp_conf.family = AF_INET6;
238 udp_conf.family = AF_INET;
239 udp_conf.local_ip.s_addr = htonl(INADDR_ANY);
242 udp_conf.local_udp_port = port;
244 /* Open UDP socket */
245 err = udp_sock_create(net, &udp_conf, &sock);
252 /* Create new listen socket if needed */
253 static struct geneve_sock *geneve_socket_create(struct net *net, __be16 port,
254 geneve_rcv_t *rcv, void *data,
257 struct geneve_net *gn = net_generic(net, geneve_net_id);
258 struct geneve_sock *gs;
260 struct udp_tunnel_sock_cfg tunnel_cfg;
262 gs = kzalloc(sizeof(*gs), GFP_KERNEL);
264 return ERR_PTR(-ENOMEM);
266 INIT_WORK(&gs->del_work, geneve_del_work);
268 sock = geneve_create_sock(net, ipv6, port);
271 return ERR_CAST(sock);
275 atomic_set(&gs->refcnt, 1);
279 /* Initialize the geneve udp offloads structure */
280 gs->udp_offloads.port = port;
281 gs->udp_offloads.callbacks.gro_receive = NULL;
282 gs->udp_offloads.callbacks.gro_complete = NULL;
284 spin_lock(&gn->sock_lock);
285 hlist_add_head_rcu(&gs->hlist, gs_head(net, port));
286 geneve_notify_add_rx_port(gs);
287 spin_unlock(&gn->sock_lock);
289 /* Mark socket as an encapsulation socket */
290 tunnel_cfg.sk_user_data = gs;
291 tunnel_cfg.encap_type = 1;
292 tunnel_cfg.encap_rcv = geneve_udp_encap_recv;
293 tunnel_cfg.encap_destroy = NULL;
294 setup_udp_tunnel_sock(net, sock, &tunnel_cfg);
299 struct geneve_sock *geneve_sock_add(struct net *net, __be16 port,
300 geneve_rcv_t *rcv, void *data,
301 bool no_share, bool ipv6)
303 struct geneve_net *gn = net_generic(net, geneve_net_id);
304 struct geneve_sock *gs;
306 gs = geneve_socket_create(net, port, rcv, data, ipv6);
310 if (no_share) /* Return error if sharing is not allowed. */
311 return ERR_PTR(-EINVAL);
313 spin_lock(&gn->sock_lock);
314 gs = geneve_find_sock(net, port);
315 if (gs && ((gs->rcv != rcv) ||
316 !atomic_add_unless(&gs->refcnt, 1, 0)))
317 gs = ERR_PTR(-EBUSY);
318 spin_unlock(&gn->sock_lock);
321 gs = ERR_PTR(-EINVAL);
325 EXPORT_SYMBOL_GPL(geneve_sock_add);
327 void geneve_sock_release(struct geneve_sock *gs)
329 struct net *net = sock_net(gs->sock->sk);
330 struct geneve_net *gn = net_generic(net, geneve_net_id);
332 if (!atomic_dec_and_test(&gs->refcnt))
335 spin_lock(&gn->sock_lock);
336 hlist_del_rcu(&gs->hlist);
337 geneve_notify_del_rx_port(gs);
338 spin_unlock(&gn->sock_lock);
340 queue_work(geneve_wq, &gs->del_work);
342 EXPORT_SYMBOL_GPL(geneve_sock_release);
344 static __net_init int geneve_init_net(struct net *net)
346 struct geneve_net *gn = net_generic(net, geneve_net_id);
349 spin_lock_init(&gn->sock_lock);
351 for (h = 0; h < PORT_HASH_SIZE; ++h)
352 INIT_HLIST_HEAD(&gn->sock_list[h]);
357 static struct pernet_operations geneve_net_ops = {
358 .init = geneve_init_net,
360 .id = &geneve_net_id,
361 .size = sizeof(struct geneve_net),
364 static int __init geneve_init_module(void)
368 geneve_wq = alloc_workqueue("geneve", 0, 0);
372 rc = register_pernet_subsys(&geneve_net_ops);
376 pr_info("Geneve driver\n");
380 late_initcall(geneve_init_module);
382 static void __exit geneve_cleanup_module(void)
384 destroy_workqueue(geneve_wq);
385 unregister_pernet_subsys(&geneve_net_ops);
387 module_exit(geneve_cleanup_module);
389 MODULE_LICENSE("GPL");
390 MODULE_AUTHOR("Jesse Gross <jesse@nicira.com>");
391 MODULE_DESCRIPTION("Driver for GENEVE encapsulated traffic");
392 MODULE_ALIAS_RTNL_LINK("geneve");