net/ipv4/geneve.c

   1 /*
   2  * Geneve: Generic Network Virtualization Encapsulation
   3  *
   4  * Copyright (c) 2014 Nicira, Inc.
   5  *
   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.
  10  */
  11
  12 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  13
  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>
  22 #include <linux/in.h>
  23 #include <linux/ip.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>
  31 #include <net/arp.h>
  32 #include <net/ndisc.h>
  33 #include <net/ip.h>
  34 #include <net/ip_tunnels.h>
  35 #include <net/icmp.h>
  36 #include <net/udp.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)
  47 #include <net/ipv6.h>
  48 #include <net/addrconf.h>
  49 #include <net/ip6_tunnel.h>
  50 #include <net/ip6_checksum.h>
  51 #endif
  52
  53 #define PORT_HASH_BITS 8
  54 #define PORT_HASH_SIZE (1<<PORT_HASH_BITS)
  55
  56 /* per-network namespace private data for this module */
  57 struct geneve_net {
  58         struct hlist_head       sock_list[PORT_HASH_SIZE];
  59         spinlock_t              sock_lock;   /* Protects sock_list */
  60 };
  61
  62 static int geneve_net_id;
  63
  64 static struct workqueue_struct *geneve_wq;
  65
  66 static inline struct genevehdr *geneve_hdr(const struct sk_buff *skb)
  67 {
  68         return (struct genevehdr *)(udp_hdr(skb) + 1);
  69 }
  70
  71 static struct hlist_head *gs_head(struct net *net, __be16 port)
  72 {
  73         struct geneve_net *gn = net_generic(net, geneve_net_id);
  74
  75         return &gn->sock_list[hash_32(ntohs(port), PORT_HASH_BITS)];
  76 }
  77
  78 /* Find geneve socket based on network namespace and UDP port */
  79 static struct geneve_sock *geneve_find_sock(struct net *net, __be16 port)
  80 {
  81         struct geneve_sock *gs;
  82
  83         hlist_for_each_entry_rcu(gs, gs_head(net, port), hlist) {
  84                 if (inet_sk(gs->sock->sk)->inet_sport == port)
  85                         return gs;
  86         }
  87
  88         return NULL;
  89 }
  90
  91 static void geneve_build_header(struct genevehdr *geneveh,
  92                                 __be16 tun_flags, u8 vni[3],
  93                                 u8 options_len, u8 *options)
  94 {
  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);
  99         geneveh->rsvd1 = 0;
 100         memcpy(geneveh->vni, vni, 3);
 101         geneveh->proto_type = htons(ETH_P_TEB);
 102         geneveh->rsvd2 = 0;
 103
 104         memcpy(geneveh->options, options, options_len);
 105 }
 106
 107 /* Transmit a fully formated Geneve frame.
 108  *
 109  * When calling this function. The skb->data should point
 110  * to the geneve header which is fully formed.
 111  *
 112  * This function will add other UDP tunnel headers.
 113  */
 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,
 118                     bool xnet)
 119 {
 120         struct genevehdr *gnvh;
 121         int min_headroom;
 122         int err;
 123
 124         min_headroom = LL_RESERVED_SPACE(rt->dst.dev) + rt->dst.header_len
 125                         + GENEVE_BASE_HLEN + opt_len + sizeof(struct iphdr)
 126                         + (vlan_tx_tag_present(skb) ? VLAN_HLEN : 0);
 127
 128         err = skb_cow_head(skb, min_headroom);
 129         if (unlikely(err))
 130                 return err;
 131
 132         skb = vlan_hwaccel_push_inside(skb);
 133         if (unlikely(!skb))
 134                 return -ENOMEM;
 135
 136         skb = udp_tunnel_handle_offloads(skb, !gs->sock->sk->sk_no_check_tx);
 137         if (IS_ERR(skb))
 138                 return PTR_ERR(skb);
 139
 140         gnvh = (struct genevehdr *)__skb_push(skb, sizeof(*gnvh) + opt_len);
 141         geneve_build_header(gnvh, tun_flags, vni, opt_len, opt);
 142
 143         skb_set_inner_protocol(skb, htons(ETH_P_TEB));
 144
 145         return udp_tunnel_xmit_skb(gs->sock, rt, skb, src, dst,
 146                                    tos, ttl, df, src_port, dst_port, xnet);
 147 }
 148 EXPORT_SYMBOL_GPL(geneve_xmit_skb);
 149
 150 static void geneve_notify_add_rx_port(struct geneve_sock *gs)
 151 {
 152         struct sock *sk = gs->sock->sk;
 153         sa_family_t sa_family = sk->sk_family;
 154         int err;
 155
 156         if (sa_family == AF_INET) {
 157                 err = udp_add_offload(&gs->udp_offloads);
 158                 if (err)
 159                         pr_warn("geneve: udp_add_offload failed with status %d\n",
 160                                 err);
 161         }
 162 }
 163
 164 static void geneve_notify_del_rx_port(struct geneve_sock *gs)
 165 {
 166         struct sock *sk = gs->sock->sk;
 167         sa_family_t sa_family = sk->sk_family;
 168
 169         if (sa_family == AF_INET)
 170                 udp_del_offload(&gs->udp_offloads);
 171 }
 172
 173 /* Callback from net/ipv4/udp.c to receive packets */
 174 static int geneve_udp_encap_recv(struct sock *sk, struct sk_buff *skb)
 175 {
 176         struct genevehdr *geneveh;
 177         struct geneve_sock *gs;
 178         int opts_len;
 179
 180         /* Need Geneve and inner Ethernet header to be present */
 181         if (unlikely(!pskb_may_pull(skb, GENEVE_BASE_HLEN)))
 182                 goto error;
 183
 184         /* Return packets with reserved bits set */
 185         geneveh = geneve_hdr(skb);
 186
 187         if (unlikely(geneveh->ver != GENEVE_VER))
 188                 goto error;
 189
 190         if (unlikely(geneveh->proto_type != htons(ETH_P_TEB)))
 191                 goto error;
 192
 193         opts_len = geneveh->opt_len * 4;
 194         if (iptunnel_pull_header(skb, GENEVE_BASE_HLEN + opts_len,
 195                                  htons(ETH_P_TEB)))
 196                 goto drop;
 197
 198         gs = rcu_dereference_sk_user_data(sk);
 199         if (!gs)
 200                 goto drop;
 201
 202         gs->rcv(gs, skb);
 203         return 0;
 204
 205 drop:
 206         /* Consume bad packet */
 207         kfree_skb(skb);
 208         return 0;
 209
 210 error:
 211         /* Let the UDP layer deal with the skb */
 212         return 1;
 213 }
 214
 215 static void geneve_del_work(struct work_struct *work)
 216 {
 217         struct geneve_sock *gs = container_of(work, struct geneve_sock,
 218                                               del_work);
 219
 220         udp_tunnel_sock_release(gs->sock);
 221         kfree_rcu(gs, rcu);
 222 }
 223
 224 static struct socket *geneve_create_sock(struct net *net, bool ipv6,
 225                                          __be16 port)
 226 {
 227         struct socket *sock;
 228         struct udp_port_cfg udp_conf;
 229         int err;
 230
 231         memset(&udp_conf, 0, sizeof(udp_conf));
 232
 233         if (ipv6) {
 234                 udp_conf.family = AF_INET6;
 235         } else {
 236                 udp_conf.family = AF_INET;
 237                 udp_conf.local_ip.s_addr = htonl(INADDR_ANY);
 238         }
 239
 240         udp_conf.local_udp_port = port;
 241
 242         /* Open UDP socket */
 243         err = udp_sock_create(net, &udp_conf, &sock);
 244         if (err < 0)
 245                 return ERR_PTR(err);
 246
 247         return sock;
 248 }
 249
 250 /* Create new listen socket if needed */
 251 static struct geneve_sock *geneve_socket_create(struct net *net, __be16 port,
 252                                                 geneve_rcv_t *rcv, void *data,
 253                                                 bool ipv6)
 254 {
 255         struct geneve_net *gn = net_generic(net, geneve_net_id);
 256         struct geneve_sock *gs;
 257         struct socket *sock;
 258         struct udp_tunnel_sock_cfg tunnel_cfg;
 259
 260         gs = kzalloc(sizeof(*gs), GFP_KERNEL);
 261         if (!gs)
 262                 return ERR_PTR(-ENOMEM);
 263
 264         INIT_WORK(&gs->del_work, geneve_del_work);
 265
 266         sock = geneve_create_sock(net, ipv6, port);
 267         if (IS_ERR(sock)) {
 268                 kfree(gs);
 269                 return ERR_CAST(sock);
 270         }
 271
 272         gs->sock = sock;
 273         atomic_set(&gs->refcnt, 1);
 274         gs->rcv = rcv;
 275         gs->rcv_data = data;
 276
 277         /* Initialize the geneve udp offloads structure */
 278         gs->udp_offloads.port = port;
 279         gs->udp_offloads.callbacks.gro_receive = NULL;
 280         gs->udp_offloads.callbacks.gro_complete = NULL;
 281
 282         spin_lock(&gn->sock_lock);
 283         hlist_add_head_rcu(&gs->hlist, gs_head(net, port));
 284         geneve_notify_add_rx_port(gs);
 285         spin_unlock(&gn->sock_lock);
 286
 287         /* Mark socket as an encapsulation socket */
 288         tunnel_cfg.sk_user_data = gs;
 289         tunnel_cfg.encap_type = 1;
 290         tunnel_cfg.encap_rcv = geneve_udp_encap_recv;
 291         tunnel_cfg.encap_destroy = NULL;
 292         setup_udp_tunnel_sock(net, sock, &tunnel_cfg);
 293
 294         return gs;
 295 }
 296
 297 struct geneve_sock *geneve_sock_add(struct net *net, __be16 port,
 298                                     geneve_rcv_t *rcv, void *data,
 299                                     bool no_share, bool ipv6)
 300 {
 301         struct geneve_net *gn = net_generic(net, geneve_net_id);
 302         struct geneve_sock *gs;
 303
 304         gs = geneve_socket_create(net, port, rcv, data, ipv6);
 305         if (!IS_ERR(gs))
 306                 return gs;
 307
 308         if (no_share)   /* Return error if sharing is not allowed. */
 309                 return ERR_PTR(-EINVAL);
 310
 311         spin_lock(&gn->sock_lock);
 312         gs = geneve_find_sock(net, port);
 313         if (gs && ((gs->rcv != rcv) ||
 314                    !atomic_add_unless(&gs->refcnt, 1, 0)))
 315                         gs = ERR_PTR(-EBUSY);
 316         spin_unlock(&gn->sock_lock);
 317
 318         if (!gs)
 319                 gs = ERR_PTR(-EINVAL);
 320
 321         return gs;
 322 }
 323 EXPORT_SYMBOL_GPL(geneve_sock_add);
 324
 325 void geneve_sock_release(struct geneve_sock *gs)
 326 {
 327         struct net *net = sock_net(gs->sock->sk);
 328         struct geneve_net *gn = net_generic(net, geneve_net_id);
 329
 330         if (!atomic_dec_and_test(&gs->refcnt))
 331                 return;
 332
 333         spin_lock(&gn->sock_lock);
 334         hlist_del_rcu(&gs->hlist);
 335         geneve_notify_del_rx_port(gs);
 336         spin_unlock(&gn->sock_lock);
 337
 338         queue_work(geneve_wq, &gs->del_work);
 339 }
 340 EXPORT_SYMBOL_GPL(geneve_sock_release);
 341
 342 static __net_init int geneve_init_net(struct net *net)
 343 {
 344         struct geneve_net *gn = net_generic(net, geneve_net_id);
 345         unsigned int h;
 346
 347         spin_lock_init(&gn->sock_lock);
 348
 349         for (h = 0; h < PORT_HASH_SIZE; ++h)
 350                 INIT_HLIST_HEAD(&gn->sock_list[h]);
 351
 352         return 0;
 353 }
 354
 355 static struct pernet_operations geneve_net_ops = {
 356         .init = geneve_init_net,
 357         .exit = NULL,
 358         .id   = &geneve_net_id,
 359         .size = sizeof(struct geneve_net),
 360 };
 361
 362 static int __init geneve_init_module(void)
 363 {
 364         int rc;
 365
 366         geneve_wq = alloc_workqueue("geneve", 0, 0);
 367         if (!geneve_wq)
 368                 return -ENOMEM;
 369
 370         rc = register_pernet_subsys(&geneve_net_ops);
 371         if (rc)
 372                 return rc;
 373
 374         pr_info("Geneve driver\n");
 375
 376         return 0;
 377 }
 378 late_initcall(geneve_init_module);
 379
 380 static void __exit geneve_cleanup_module(void)
 381 {
 382         destroy_workqueue(geneve_wq);
 383         unregister_pernet_subsys(&geneve_net_ops);
 384 }
 385 module_exit(geneve_cleanup_module);
 386
 387 MODULE_LICENSE("GPL");
 388 MODULE_AUTHOR("Jesse Gross <jesse@nicira.com>");
 389 MODULE_DESCRIPTION("Driver for GENEVE encapsulated traffic");
 390 MODULE_ALIAS_RTNL_LINK("geneve");