1 #include <linux/module.h>
2 #include <linux/errno.h>
3 #include <linux/socket.h>
4 #include <linux/skbuff.h>
7 #include <linux/types.h>
8 #include <linux/kernel.h>
9 #include <net/genetlink.h>
12 #include <net/protocol.h>
14 #include <net/udp_tunnel.h>
16 #include <uapi/linux/fou.h>
17 #include <uapi/linux/genetlink.h>
25 struct udp_offload udp_offloads;
26 struct list_head list;
29 #define FOU_F_REMCSUM_NOPARTIAL BIT(0)
35 struct udp_port_cfg udp_config;
38 static unsigned int fou_net_id;
41 struct list_head fou_list;
42 struct mutex fou_lock;
45 static inline struct fou *fou_from_sock(struct sock *sk)
47 return sk->sk_user_data;
50 static void fou_recv_pull(struct sk_buff *skb, size_t len)
52 struct iphdr *iph = ip_hdr(skb);
54 /* Remove 'len' bytes from the packet (UDP header and
55 * FOU header if present).
57 iph->tot_len = htons(ntohs(iph->tot_len) - len);
59 skb_postpull_rcsum(skb, udp_hdr(skb), len);
60 skb_reset_transport_header(skb);
63 static int fou_udp_recv(struct sock *sk, struct sk_buff *skb)
65 struct fou *fou = fou_from_sock(sk);
70 fou_recv_pull(skb, sizeof(struct udphdr));
72 return -fou->protocol;
75 static struct guehdr *gue_remcsum(struct sk_buff *skb, struct guehdr *guehdr,
76 void *data, size_t hdrlen, u8 ipproto,
80 size_t start = ntohs(pd[0]);
81 size_t offset = ntohs(pd[1]);
82 size_t plen = hdrlen + max_t(size_t, offset + sizeof(u16), start);
84 if (!pskb_may_pull(skb, plen))
86 guehdr = (struct guehdr *)&udp_hdr(skb)[1];
88 skb_remcsum_process(skb, (void *)guehdr + hdrlen,
89 start, offset, nopartial);
94 static int gue_control_message(struct sk_buff *skb, struct guehdr *guehdr)
101 static int gue_udp_recv(struct sock *sk, struct sk_buff *skb)
103 struct fou *fou = fou_from_sock(sk);
104 size_t len, optlen, hdrlen;
105 struct guehdr *guehdr;
112 len = sizeof(struct udphdr) + sizeof(struct guehdr);
113 if (!pskb_may_pull(skb, len))
116 guehdr = (struct guehdr *)&udp_hdr(skb)[1];
118 optlen = guehdr->hlen << 2;
121 if (!pskb_may_pull(skb, len))
124 /* guehdr may change after pull */
125 guehdr = (struct guehdr *)&udp_hdr(skb)[1];
127 hdrlen = sizeof(struct guehdr) + optlen;
129 if (guehdr->version != 0 || validate_gue_flags(guehdr, optlen))
132 hdrlen = sizeof(struct guehdr) + optlen;
134 ip_hdr(skb)->tot_len = htons(ntohs(ip_hdr(skb)->tot_len) - len);
136 /* Pull csum through the guehdr now . This can be used if
137 * there is a remote checksum offload.
139 skb_postpull_rcsum(skb, udp_hdr(skb), len);
143 if (guehdr->flags & GUE_FLAG_PRIV) {
144 __be32 flags = *(__be32 *)(data + doffset);
146 doffset += GUE_LEN_PRIV;
148 if (flags & GUE_PFLAG_REMCSUM) {
149 guehdr = gue_remcsum(skb, guehdr, data + doffset,
150 hdrlen, guehdr->proto_ctype,
152 FOU_F_REMCSUM_NOPARTIAL));
158 doffset += GUE_PLEN_REMCSUM;
162 if (unlikely(guehdr->control))
163 return gue_control_message(skb, guehdr);
165 __skb_pull(skb, sizeof(struct udphdr) + hdrlen);
166 skb_reset_transport_header(skb);
168 return -guehdr->proto_ctype;
175 static struct sk_buff **fou_gro_receive(struct sk_buff **head,
177 struct udp_offload *uoff)
179 const struct net_offload *ops;
180 struct sk_buff **pp = NULL;
181 u8 proto = NAPI_GRO_CB(skb)->proto;
182 const struct net_offload **offloads;
185 offloads = NAPI_GRO_CB(skb)->is_ipv6 ? inet6_offloads : inet_offloads;
186 ops = rcu_dereference(offloads[proto]);
187 if (!ops || !ops->callbacks.gro_receive)
190 pp = ops->callbacks.gro_receive(head, skb);
198 static int fou_gro_complete(struct sk_buff *skb, int nhoff,
199 struct udp_offload *uoff)
201 const struct net_offload *ops;
202 u8 proto = NAPI_GRO_CB(skb)->proto;
204 const struct net_offload **offloads;
206 udp_tunnel_gro_complete(skb, nhoff);
209 offloads = NAPI_GRO_CB(skb)->is_ipv6 ? inet6_offloads : inet_offloads;
210 ops = rcu_dereference(offloads[proto]);
211 if (WARN_ON(!ops || !ops->callbacks.gro_complete))
214 err = ops->callbacks.gro_complete(skb, nhoff);
222 static struct guehdr *gue_gro_remcsum(struct sk_buff *skb, unsigned int off,
223 struct guehdr *guehdr, void *data,
224 size_t hdrlen, u8 ipproto,
225 struct gro_remcsum *grc, bool nopartial)
228 size_t start = ntohs(pd[0]);
229 size_t offset = ntohs(pd[1]);
230 size_t plen = hdrlen + max_t(size_t, offset + sizeof(u16), start);
232 if (skb->remcsum_offload)
235 if (!NAPI_GRO_CB(skb)->csum_valid)
238 /* Pull checksum that will be written */
239 if (skb_gro_header_hard(skb, off + plen)) {
240 guehdr = skb_gro_header_slow(skb, off + plen, off);
245 skb_gro_remcsum_process(skb, (void *)guehdr + hdrlen,
246 start, offset, grc, nopartial);
248 skb->remcsum_offload = 1;
253 static struct sk_buff **gue_gro_receive(struct sk_buff **head,
255 struct udp_offload *uoff)
257 const struct net_offload **offloads;
258 const struct net_offload *ops;
259 struct sk_buff **pp = NULL;
261 struct guehdr *guehdr;
262 size_t len, optlen, hdrlen, off;
266 struct fou *fou = container_of(uoff, struct fou, udp_offloads);
267 struct gro_remcsum grc;
269 skb_gro_remcsum_init(&grc);
271 off = skb_gro_offset(skb);
272 len = off + sizeof(*guehdr);
274 guehdr = skb_gro_header_fast(skb, off);
275 if (skb_gro_header_hard(skb, len)) {
276 guehdr = skb_gro_header_slow(skb, len, off);
277 if (unlikely(!guehdr))
281 optlen = guehdr->hlen << 2;
284 if (skb_gro_header_hard(skb, len)) {
285 guehdr = skb_gro_header_slow(skb, len, off);
286 if (unlikely(!guehdr))
290 if (unlikely(guehdr->control) || guehdr->version != 0 ||
291 validate_gue_flags(guehdr, optlen))
294 hdrlen = sizeof(*guehdr) + optlen;
296 /* Adjust NAPI_GRO_CB(skb)->csum to account for guehdr,
297 * this is needed if there is a remote checkcsum offload.
299 skb_gro_postpull_rcsum(skb, guehdr, hdrlen);
303 if (guehdr->flags & GUE_FLAG_PRIV) {
304 __be32 flags = *(__be32 *)(data + doffset);
306 doffset += GUE_LEN_PRIV;
308 if (flags & GUE_PFLAG_REMCSUM) {
309 guehdr = gue_gro_remcsum(skb, off, guehdr,
310 data + doffset, hdrlen,
311 guehdr->proto_ctype, &grc,
313 FOU_F_REMCSUM_NOPARTIAL));
319 doffset += GUE_PLEN_REMCSUM;
323 skb_gro_pull(skb, hdrlen);
327 for (p = *head; p; p = p->next) {
328 const struct guehdr *guehdr2;
330 if (!NAPI_GRO_CB(p)->same_flow)
333 guehdr2 = (struct guehdr *)(p->data + off);
335 /* Compare base GUE header to be equal (covers
336 * hlen, version, proto_ctype, and flags.
338 if (guehdr->word != guehdr2->word) {
339 NAPI_GRO_CB(p)->same_flow = 0;
343 /* Compare optional fields are the same. */
344 if (guehdr->hlen && memcmp(&guehdr[1], &guehdr2[1],
345 guehdr->hlen << 2)) {
346 NAPI_GRO_CB(p)->same_flow = 0;
352 offloads = NAPI_GRO_CB(skb)->is_ipv6 ? inet6_offloads : inet_offloads;
353 ops = rcu_dereference(offloads[guehdr->proto_ctype]);
354 if (WARN_ON(!ops || !ops->callbacks.gro_receive))
357 pp = ops->callbacks.gro_receive(head, skb);
362 NAPI_GRO_CB(skb)->flush |= flush;
363 skb_gro_remcsum_cleanup(skb, &grc);
368 static int gue_gro_complete(struct sk_buff *skb, int nhoff,
369 struct udp_offload *uoff)
371 const struct net_offload **offloads;
372 struct guehdr *guehdr = (struct guehdr *)(skb->data + nhoff);
373 const struct net_offload *ops;
374 unsigned int guehlen;
378 proto = guehdr->proto_ctype;
380 guehlen = sizeof(*guehdr) + (guehdr->hlen << 2);
383 offloads = NAPI_GRO_CB(skb)->is_ipv6 ? inet6_offloads : inet_offloads;
384 ops = rcu_dereference(offloads[proto]);
385 if (WARN_ON(!ops || !ops->callbacks.gro_complete))
388 err = ops->callbacks.gro_complete(skb, nhoff + guehlen);
395 static int fou_add_to_port_list(struct net *net, struct fou *fou)
397 struct fou_net *fn = net_generic(net, fou_net_id);
400 mutex_lock(&fn->fou_lock);
401 list_for_each_entry(fout, &fn->fou_list, list) {
402 if (fou->port == fout->port) {
403 mutex_unlock(&fn->fou_lock);
408 list_add(&fou->list, &fn->fou_list);
409 mutex_unlock(&fn->fou_lock);
414 static void fou_release(struct fou *fou)
416 struct socket *sock = fou->sock;
417 struct sock *sk = sock->sk;
419 if (sk->sk_family == AF_INET)
420 udp_del_offload(&fou->udp_offloads);
421 list_del(&fou->list);
422 udp_tunnel_sock_release(sock);
427 static int fou_encap_init(struct sock *sk, struct fou *fou, struct fou_cfg *cfg)
429 udp_sk(sk)->encap_rcv = fou_udp_recv;
430 fou->protocol = cfg->protocol;
431 fou->udp_offloads.callbacks.gro_receive = fou_gro_receive;
432 fou->udp_offloads.callbacks.gro_complete = fou_gro_complete;
433 fou->udp_offloads.port = cfg->udp_config.local_udp_port;
434 fou->udp_offloads.ipproto = cfg->protocol;
439 static int gue_encap_init(struct sock *sk, struct fou *fou, struct fou_cfg *cfg)
441 udp_sk(sk)->encap_rcv = gue_udp_recv;
442 fou->udp_offloads.callbacks.gro_receive = gue_gro_receive;
443 fou->udp_offloads.callbacks.gro_complete = gue_gro_complete;
444 fou->udp_offloads.port = cfg->udp_config.local_udp_port;
449 static int fou_create(struct net *net, struct fou_cfg *cfg,
450 struct socket **sockp)
452 struct socket *sock = NULL;
453 struct fou *fou = NULL;
457 /* Open UDP socket */
458 err = udp_sock_create(net, &cfg->udp_config, &sock);
462 /* Allocate FOU port structure */
463 fou = kzalloc(sizeof(*fou), GFP_KERNEL);
471 fou->flags = cfg->flags;
472 fou->port = cfg->udp_config.local_udp_port;
474 /* Initial for fou type */
476 case FOU_ENCAP_DIRECT:
477 err = fou_encap_init(sk, fou, cfg);
482 err = gue_encap_init(sk, fou, cfg);
491 fou->type = cfg->type;
493 udp_sk(sk)->encap_type = 1;
496 sk->sk_user_data = fou;
499 inet_inc_convert_csum(sk);
501 sk->sk_allocation = GFP_ATOMIC;
503 if (cfg->udp_config.family == AF_INET) {
504 err = udp_add_offload(&fou->udp_offloads);
509 err = fou_add_to_port_list(net, fou);
521 udp_tunnel_sock_release(sock);
526 static int fou_destroy(struct net *net, struct fou_cfg *cfg)
528 struct fou_net *fn = net_generic(net, fou_net_id);
529 __be16 port = cfg->udp_config.local_udp_port;
533 mutex_lock(&fn->fou_lock);
534 list_for_each_entry(fou, &fn->fou_list, list) {
535 if (fou->port == port) {
541 mutex_unlock(&fn->fou_lock);
546 static struct genl_family fou_nl_family = {
547 .id = GENL_ID_GENERATE,
549 .name = FOU_GENL_NAME,
550 .version = FOU_GENL_VERSION,
551 .maxattr = FOU_ATTR_MAX,
555 static struct nla_policy fou_nl_policy[FOU_ATTR_MAX + 1] = {
556 [FOU_ATTR_PORT] = { .type = NLA_U16, },
557 [FOU_ATTR_AF] = { .type = NLA_U8, },
558 [FOU_ATTR_IPPROTO] = { .type = NLA_U8, },
559 [FOU_ATTR_TYPE] = { .type = NLA_U8, },
560 [FOU_ATTR_REMCSUM_NOPARTIAL] = { .type = NLA_FLAG, },
563 static int parse_nl_config(struct genl_info *info,
566 memset(cfg, 0, sizeof(*cfg));
568 cfg->udp_config.family = AF_INET;
570 if (info->attrs[FOU_ATTR_AF]) {
571 u8 family = nla_get_u8(info->attrs[FOU_ATTR_AF]);
573 if (family != AF_INET && family != AF_INET6)
576 cfg->udp_config.family = family;
579 if (info->attrs[FOU_ATTR_PORT]) {
580 __be16 port = nla_get_be16(info->attrs[FOU_ATTR_PORT]);
582 cfg->udp_config.local_udp_port = port;
585 if (info->attrs[FOU_ATTR_IPPROTO])
586 cfg->protocol = nla_get_u8(info->attrs[FOU_ATTR_IPPROTO]);
588 if (info->attrs[FOU_ATTR_TYPE])
589 cfg->type = nla_get_u8(info->attrs[FOU_ATTR_TYPE]);
591 if (info->attrs[FOU_ATTR_REMCSUM_NOPARTIAL])
592 cfg->flags |= FOU_F_REMCSUM_NOPARTIAL;
597 static int fou_nl_cmd_add_port(struct sk_buff *skb, struct genl_info *info)
599 struct net *net = genl_info_net(info);
603 err = parse_nl_config(info, &cfg);
607 return fou_create(net, &cfg, NULL);
610 static int fou_nl_cmd_rm_port(struct sk_buff *skb, struct genl_info *info)
612 struct net *net = genl_info_net(info);
616 err = parse_nl_config(info, &cfg);
620 return fou_destroy(net, &cfg);
623 static int fou_fill_info(struct fou *fou, struct sk_buff *msg)
625 if (nla_put_u8(msg, FOU_ATTR_AF, fou->sock->sk->sk_family) ||
626 nla_put_be16(msg, FOU_ATTR_PORT, fou->port) ||
627 nla_put_u8(msg, FOU_ATTR_IPPROTO, fou->protocol) ||
628 nla_put_u8(msg, FOU_ATTR_TYPE, fou->type))
631 if (fou->flags & FOU_F_REMCSUM_NOPARTIAL)
632 if (nla_put_flag(msg, FOU_ATTR_REMCSUM_NOPARTIAL))
637 static int fou_dump_info(struct fou *fou, u32 portid, u32 seq,
638 u32 flags, struct sk_buff *skb, u8 cmd)
642 hdr = genlmsg_put(skb, portid, seq, &fou_nl_family, flags, cmd);
646 if (fou_fill_info(fou, skb) < 0)
647 goto nla_put_failure;
649 genlmsg_end(skb, hdr);
653 genlmsg_cancel(skb, hdr);
657 static int fou_nl_cmd_get_port(struct sk_buff *skb, struct genl_info *info)
659 struct net *net = genl_info_net(info);
660 struct fou_net *fn = net_generic(net, fou_net_id);
667 ret = parse_nl_config(info, &cfg);
670 port = cfg.udp_config.local_udp_port;
674 msg = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_KERNEL);
679 mutex_lock(&fn->fou_lock);
680 list_for_each_entry(fout, &fn->fou_list, list) {
681 if (port == fout->port) {
682 ret = fou_dump_info(fout, info->snd_portid,
683 info->snd_seq, 0, msg,
688 mutex_unlock(&fn->fou_lock);
692 return genlmsg_reply(msg, info);
699 static int fou_nl_dump(struct sk_buff *skb, struct netlink_callback *cb)
701 struct net *net = sock_net(skb->sk);
702 struct fou_net *fn = net_generic(net, fou_net_id);
706 mutex_lock(&fn->fou_lock);
707 list_for_each_entry(fout, &fn->fou_list, list) {
708 if (idx++ < cb->args[0])
710 ret = fou_dump_info(fout, NETLINK_CB(cb->skb).portid,
711 cb->nlh->nlmsg_seq, NLM_F_MULTI,
716 mutex_unlock(&fn->fou_lock);
723 static const struct genl_ops fou_nl_ops[] = {
726 .doit = fou_nl_cmd_add_port,
727 .policy = fou_nl_policy,
728 .flags = GENL_ADMIN_PERM,
732 .doit = fou_nl_cmd_rm_port,
733 .policy = fou_nl_policy,
734 .flags = GENL_ADMIN_PERM,
738 .doit = fou_nl_cmd_get_port,
739 .dumpit = fou_nl_dump,
740 .policy = fou_nl_policy,
744 size_t fou_encap_hlen(struct ip_tunnel_encap *e)
746 return sizeof(struct udphdr);
748 EXPORT_SYMBOL(fou_encap_hlen);
750 size_t gue_encap_hlen(struct ip_tunnel_encap *e)
753 bool need_priv = false;
755 len = sizeof(struct udphdr) + sizeof(struct guehdr);
757 if (e->flags & TUNNEL_ENCAP_FLAG_REMCSUM) {
758 len += GUE_PLEN_REMCSUM;
762 len += need_priv ? GUE_LEN_PRIV : 0;
766 EXPORT_SYMBOL(gue_encap_hlen);
768 static void fou_build_udp(struct sk_buff *skb, struct ip_tunnel_encap *e,
769 struct flowi4 *fl4, u8 *protocol, __be16 sport)
773 skb_push(skb, sizeof(struct udphdr));
774 skb_reset_transport_header(skb);
780 uh->len = htons(skb->len);
782 udp_set_csum(!(e->flags & TUNNEL_ENCAP_FLAG_CSUM), skb,
783 fl4->saddr, fl4->daddr, skb->len);
785 *protocol = IPPROTO_UDP;
788 int fou_build_header(struct sk_buff *skb, struct ip_tunnel_encap *e,
789 u8 *protocol, struct flowi4 *fl4)
791 bool csum = !!(e->flags & TUNNEL_ENCAP_FLAG_CSUM);
792 int type = csum ? SKB_GSO_UDP_TUNNEL_CSUM : SKB_GSO_UDP_TUNNEL;
795 skb = iptunnel_handle_offloads(skb, csum, type);
800 sport = e->sport ? : udp_flow_src_port(dev_net(skb->dev),
802 fou_build_udp(skb, e, fl4, protocol, sport);
806 EXPORT_SYMBOL(fou_build_header);
808 int gue_build_header(struct sk_buff *skb, struct ip_tunnel_encap *e,
809 u8 *protocol, struct flowi4 *fl4)
811 bool csum = !!(e->flags & TUNNEL_ENCAP_FLAG_CSUM);
812 int type = csum ? SKB_GSO_UDP_TUNNEL_CSUM : SKB_GSO_UDP_TUNNEL;
813 struct guehdr *guehdr;
814 size_t hdrlen, optlen = 0;
817 bool need_priv = false;
819 if ((e->flags & TUNNEL_ENCAP_FLAG_REMCSUM) &&
820 skb->ip_summed == CHECKSUM_PARTIAL) {
822 optlen += GUE_PLEN_REMCSUM;
823 type |= SKB_GSO_TUNNEL_REMCSUM;
827 optlen += need_priv ? GUE_LEN_PRIV : 0;
829 skb = iptunnel_handle_offloads(skb, csum, type);
834 /* Get source port (based on flow hash) before skb_push */
835 sport = e->sport ? : udp_flow_src_port(dev_net(skb->dev),
838 hdrlen = sizeof(struct guehdr) + optlen;
840 skb_push(skb, hdrlen);
842 guehdr = (struct guehdr *)skb->data;
846 guehdr->hlen = optlen >> 2;
848 guehdr->proto_ctype = *protocol;
853 __be32 *flags = data;
855 guehdr->flags |= GUE_FLAG_PRIV;
857 data += GUE_LEN_PRIV;
859 if (type & SKB_GSO_TUNNEL_REMCSUM) {
860 u16 csum_start = skb_checksum_start_offset(skb);
863 if (csum_start < hdrlen)
866 csum_start -= hdrlen;
867 pd[0] = htons(csum_start);
868 pd[1] = htons(csum_start + skb->csum_offset);
870 if (!skb_is_gso(skb)) {
871 skb->ip_summed = CHECKSUM_NONE;
872 skb->encapsulation = 0;
875 *flags |= GUE_PFLAG_REMCSUM;
876 data += GUE_PLEN_REMCSUM;
881 fou_build_udp(skb, e, fl4, protocol, sport);
885 EXPORT_SYMBOL(gue_build_header);
887 #ifdef CONFIG_NET_FOU_IP_TUNNELS
889 static const struct ip_tunnel_encap_ops fou_iptun_ops = {
890 .encap_hlen = fou_encap_hlen,
891 .build_header = fou_build_header,
894 static const struct ip_tunnel_encap_ops gue_iptun_ops = {
895 .encap_hlen = gue_encap_hlen,
896 .build_header = gue_build_header,
899 static int ip_tunnel_encap_add_fou_ops(void)
903 ret = ip_tunnel_encap_add_ops(&fou_iptun_ops, TUNNEL_ENCAP_FOU);
905 pr_err("can't add fou ops\n");
909 ret = ip_tunnel_encap_add_ops(&gue_iptun_ops, TUNNEL_ENCAP_GUE);
911 pr_err("can't add gue ops\n");
912 ip_tunnel_encap_del_ops(&fou_iptun_ops, TUNNEL_ENCAP_FOU);
919 static void ip_tunnel_encap_del_fou_ops(void)
921 ip_tunnel_encap_del_ops(&fou_iptun_ops, TUNNEL_ENCAP_FOU);
922 ip_tunnel_encap_del_ops(&gue_iptun_ops, TUNNEL_ENCAP_GUE);
927 static int ip_tunnel_encap_add_fou_ops(void)
932 static void ip_tunnel_encap_del_fou_ops(void)
938 static __net_init int fou_init_net(struct net *net)
940 struct fou_net *fn = net_generic(net, fou_net_id);
942 INIT_LIST_HEAD(&fn->fou_list);
943 mutex_init(&fn->fou_lock);
947 static __net_exit void fou_exit_net(struct net *net)
949 struct fou_net *fn = net_generic(net, fou_net_id);
950 struct fou *fou, *next;
952 /* Close all the FOU sockets */
953 mutex_lock(&fn->fou_lock);
954 list_for_each_entry_safe(fou, next, &fn->fou_list, list)
956 mutex_unlock(&fn->fou_lock);
959 static struct pernet_operations fou_net_ops = {
960 .init = fou_init_net,
961 .exit = fou_exit_net,
963 .size = sizeof(struct fou_net),
966 static int __init fou_init(void)
970 ret = register_pernet_device(&fou_net_ops);
974 ret = genl_register_family_with_ops(&fou_nl_family,
979 ret = ip_tunnel_encap_add_fou_ops();
983 genl_unregister_family(&fou_nl_family);
985 unregister_pernet_device(&fou_net_ops);
990 static void __exit fou_fini(void)
992 ip_tunnel_encap_del_fou_ops();
993 genl_unregister_family(&fou_nl_family);
994 unregister_pernet_device(&fou_net_ops);
997 module_init(fou_init);
998 module_exit(fou_fini);
1000 MODULE_LICENSE("GPL");