include/net/ip_tunnels.h

   1 #ifndef __NET_IP_TUNNELS_H
   2 #define __NET_IP_TUNNELS_H 1
   3
   4 #include <linux/if_tunnel.h>
   5 #include <linux/netdevice.h>
   6 #include <linux/skbuff.h>
   7 #include <linux/types.h>
   8 #include <linux/u64_stats_sync.h>
   9 #include <net/dsfield.h>
  10 #include <net/gro_cells.h>
  11 #include <net/inet_ecn.h>
  12 #include <net/netns/generic.h>
  13 #include <net/rtnetlink.h>
  14 #include <net/lwtunnel.h>
  15
  16 #if IS_ENABLED(CONFIG_IPV6)
  17 #include <net/ipv6.h>
  18 #include <net/ip6_fib.h>
  19 #include <net/ip6_route.h>
  20 #endif
  21
  22 /* Keep error state on tunnel for 30 sec */
  23 #define IPTUNNEL_ERR_TIMEO      (30*HZ)
  24
  25 /* Used to memset ip_tunnel padding. */
  26 #define IP_TUNNEL_KEY_SIZE      offsetofend(struct ip_tunnel_key, tp_dst)
  27
  28 /* Used to memset ipv4 address padding. */
  29 #define IP_TUNNEL_KEY_IPV4_PAD  offsetofend(struct ip_tunnel_key, u.ipv4.dst)
  30 #define IP_TUNNEL_KEY_IPV4_PAD_LEN                              \
  31         (FIELD_SIZEOF(struct ip_tunnel_key, u) -                \
  32          FIELD_SIZEOF(struct ip_tunnel_key, u.ipv4))
  33
  34 struct ip_tunnel_key {
  35         __be64                  tun_id;
  36         union {
  37                 struct {
  38                         __be32  src;
  39                         __be32  dst;
  40                 } ipv4;
  41                 struct {
  42                         struct in6_addr src;
  43                         struct in6_addr dst;
  44                 } ipv6;
  45         } u;
  46         __be16                  tun_flags;
  47         u8                      tos;            /* TOS for IPv4, TC for IPv6 */
  48         u8                      ttl;            /* TTL for IPv4, HL for IPv6 */
  49         __be16                  tp_src;
  50         __be16                  tp_dst;
  51 };
  52
  53 /* Indicates whether the tunnel info structure represents receive
  54  * or transmit tunnel parameters.
  55  */
  56 enum {
  57         IP_TUNNEL_INFO_RX,
  58         IP_TUNNEL_INFO_TX,
  59 };
  60
  61 struct ip_tunnel_info {
  62         struct ip_tunnel_key    key;
  63         const void              *options;
  64         u8                      options_len;
  65         u8                      mode;
  66 };
  67
  68 /* 6rd prefix/relay information */
  69 #ifdef CONFIG_IPV6_SIT_6RD
  70 struct ip_tunnel_6rd_parm {
  71         struct in6_addr         prefix;
  72         __be32                  relay_prefix;
  73         u16                     prefixlen;
  74         u16                     relay_prefixlen;
  75 };
  76 #endif
  77
  78 struct ip_tunnel_encap {
  79         u16                     type;
  80         u16                     flags;
  81         __be16                  sport;
  82         __be16                  dport;
  83 };
  84
  85 struct ip_tunnel_prl_entry {
  86         struct ip_tunnel_prl_entry __rcu *next;
  87         __be32                          addr;
  88         u16                             flags;
  89         struct rcu_head                 rcu_head;
  90 };
  91
  92 struct ip_tunnel_dst {
  93         struct dst_entry __rcu          *dst;
  94         __be32                           saddr;
  95 };
  96
  97 struct metadata_dst;
  98
  99 struct ip_tunnel {
 100         struct ip_tunnel __rcu  *next;
 101         struct hlist_node hash_node;
 102         struct net_device       *dev;
 103         struct net              *net;   /* netns for packet i/o */
 104
 105         int             err_count;      /* Number of arrived ICMP errors */
 106         unsigned long   err_time;       /* Time when the last ICMP error
 107                                          * arrived */
 108
 109         /* These four fields used only by GRE */
 110         u32             i_seqno;        /* The last seen seqno  */
 111         u32             o_seqno;        /* The last output seqno */
 112         int             tun_hlen;       /* Precalculated header length */
 113         int             mlink;
 114
 115         struct ip_tunnel_dst __percpu *dst_cache;
 116
 117         struct ip_tunnel_parm parms;
 118
 119         int             encap_hlen;     /* Encap header length (FOU,GUE) */
 120         struct ip_tunnel_encap encap;
 121
 122         int             hlen;           /* tun_hlen + encap_hlen */
 123
 124         /* for SIT */
 125 #ifdef CONFIG_IPV6_SIT_6RD
 126         struct ip_tunnel_6rd_parm ip6rd;
 127 #endif
 128         struct ip_tunnel_prl_entry __rcu *prl;  /* potential router list */
 129         unsigned int            prl_count;      /* # of entries in PRL */
 130         int                     ip_tnl_net_id;
 131         struct gro_cells        gro_cells;
 132         bool                    collect_md;
 133 };
 134
 135 #define TUNNEL_CSUM             __cpu_to_be16(0x01)
 136 #define TUNNEL_ROUTING          __cpu_to_be16(0x02)
 137 #define TUNNEL_KEY              __cpu_to_be16(0x04)
 138 #define TUNNEL_SEQ              __cpu_to_be16(0x08)
 139 #define TUNNEL_STRICT           __cpu_to_be16(0x10)
 140 #define TUNNEL_REC              __cpu_to_be16(0x20)
 141 #define TUNNEL_VERSION          __cpu_to_be16(0x40)
 142 #define TUNNEL_NO_KEY           __cpu_to_be16(0x80)
 143 #define TUNNEL_DONT_FRAGMENT    __cpu_to_be16(0x0100)
 144 #define TUNNEL_OAM              __cpu_to_be16(0x0200)
 145 #define TUNNEL_CRIT_OPT         __cpu_to_be16(0x0400)
 146 #define TUNNEL_GENEVE_OPT       __cpu_to_be16(0x0800)
 147 #define TUNNEL_VXLAN_OPT        __cpu_to_be16(0x1000)
 148
 149 #define TUNNEL_OPTIONS_PRESENT  (TUNNEL_GENEVE_OPT | TUNNEL_VXLAN_OPT)
 150
 151 struct tnl_ptk_info {
 152         __be16 flags;
 153         __be16 proto;
 154         __be32 key;
 155         __be32 seq;
 156 };
 157
 158 #define PACKET_RCVD     0
 159 #define PACKET_REJECT   1
 160
 161 #define IP_TNL_HASH_BITS   7
 162 #define IP_TNL_HASH_SIZE   (1 << IP_TNL_HASH_BITS)
 163
 164 struct ip_tunnel_net {
 165         struct net_device *fb_tunnel_dev;
 166         struct hlist_head tunnels[IP_TNL_HASH_SIZE];
 167         struct ip_tunnel __rcu *collect_md_tun;
 168 };
 169
 170 struct ip_tunnel_encap_ops {
 171         size_t (*encap_hlen)(struct ip_tunnel_encap *e);
 172         int (*build_header)(struct sk_buff *skb, struct ip_tunnel_encap *e,
 173                             u8 *protocol, struct flowi4 *fl4);
 174 };
 175
 176 #define MAX_IPTUN_ENCAP_OPS 8
 177
 178 extern const struct ip_tunnel_encap_ops __rcu *
 179                 iptun_encaps[MAX_IPTUN_ENCAP_OPS];
 180
 181 int ip_tunnel_encap_add_ops(const struct ip_tunnel_encap_ops *op,
 182                             unsigned int num);
 183 int ip_tunnel_encap_del_ops(const struct ip_tunnel_encap_ops *op,
 184                             unsigned int num);
 185
 186 static inline void __ip_tunnel_info_init(struct ip_tunnel_info *tun_info,
 187                                          __be32 saddr, __be32 daddr,
 188                                          u8 tos, u8 ttl,
 189                                          __be16 tp_src, __be16 tp_dst,
 190                                          __be64 tun_id, __be16 tun_flags,
 191                                          const void *opts, u8 opts_len)
 192 {
 193         tun_info->key.tun_id = tun_id;
 194         tun_info->key.u.ipv4.src = saddr;
 195         tun_info->key.u.ipv4.dst = daddr;
 196         memset((unsigned char *)&tun_info->key + IP_TUNNEL_KEY_IPV4_PAD,
 197                0, IP_TUNNEL_KEY_IPV4_PAD_LEN);
 198         tun_info->key.tos = tos;
 199         tun_info->key.ttl = ttl;
 200         tun_info->key.tun_flags = tun_flags;
 201
 202         /* For the tunnel types on the top of IPsec, the tp_src and tp_dst of
 203          * the upper tunnel are used.
 204          * E.g: GRE over IPSEC, the tp_src and tp_port are zero.
 205          */
 206         tun_info->key.tp_src = tp_src;
 207         tun_info->key.tp_dst = tp_dst;
 208
 209         /* Clear struct padding. */
 210         if (sizeof(tun_info->key) != IP_TUNNEL_KEY_SIZE)
 211                 memset((unsigned char *)&tun_info->key + IP_TUNNEL_KEY_SIZE,
 212                        0, sizeof(tun_info->key) - IP_TUNNEL_KEY_SIZE);
 213
 214         tun_info->options = opts;
 215         tun_info->options_len = opts_len;
 216 }
 217
 218 static inline void ip_tunnel_info_init(struct ip_tunnel_info *tun_info,
 219                                        const struct iphdr *iph,
 220                                        __be16 tp_src, __be16 tp_dst,
 221                                        __be64 tun_id, __be16 tun_flags,
 222                                        const void *opts, u8 opts_len)
 223 {
 224         __ip_tunnel_info_init(tun_info, iph->saddr, iph->daddr,
 225                               iph->tos, iph->ttl, tp_src, tp_dst,
 226                               tun_id, tun_flags, opts, opts_len);
 227 }
 228
 229 #ifdef CONFIG_INET
 230
 231 int ip_tunnel_init(struct net_device *dev);
 232 void ip_tunnel_uninit(struct net_device *dev);
 233 void  ip_tunnel_dellink(struct net_device *dev, struct list_head *head);
 234 struct net *ip_tunnel_get_link_net(const struct net_device *dev);
 235 int ip_tunnel_get_iflink(const struct net_device *dev);
 236 int ip_tunnel_init_net(struct net *net, int ip_tnl_net_id,
 237                        struct rtnl_link_ops *ops, char *devname);
 238
 239 void ip_tunnel_delete_net(struct ip_tunnel_net *itn, struct rtnl_link_ops *ops);
 240
 241 void ip_tunnel_xmit(struct sk_buff *skb, struct net_device *dev,
 242                     const struct iphdr *tnl_params, const u8 protocol);
 243 int ip_tunnel_ioctl(struct net_device *dev, struct ip_tunnel_parm *p, int cmd);
 244 int ip_tunnel_encap(struct sk_buff *skb, struct ip_tunnel *t,
 245                     u8 *protocol, struct flowi4 *fl4);
 246 int ip_tunnel_change_mtu(struct net_device *dev, int new_mtu);
 247
 248 struct rtnl_link_stats64 *ip_tunnel_get_stats64(struct net_device *dev,
 249                                                 struct rtnl_link_stats64 *tot);
 250 struct ip_tunnel *ip_tunnel_lookup(struct ip_tunnel_net *itn,
 251                                    int link, __be16 flags,
 252                                    __be32 remote, __be32 local,
 253                                    __be32 key);
 254
 255 int ip_tunnel_rcv(struct ip_tunnel *tunnel, struct sk_buff *skb,
 256                   const struct tnl_ptk_info *tpi, struct metadata_dst *tun_dst,
 257                   bool log_ecn_error);
 258 int ip_tunnel_changelink(struct net_device *dev, struct nlattr *tb[],
 259                          struct ip_tunnel_parm *p);
 260 int ip_tunnel_newlink(struct net_device *dev, struct nlattr *tb[],
 261                       struct ip_tunnel_parm *p);
 262 void ip_tunnel_setup(struct net_device *dev, int net_id);
 263 void ip_tunnel_dst_reset_all(struct ip_tunnel *t);
 264 int ip_tunnel_encap_setup(struct ip_tunnel *t,
 265                           struct ip_tunnel_encap *ipencap);
 266
 267 /* Extract dsfield from inner protocol */
 268 static inline u8 ip_tunnel_get_dsfield(const struct iphdr *iph,
 269                                        const struct sk_buff *skb)
 270 {
 271         if (skb->protocol == htons(ETH_P_IP))
 272                 return iph->tos;
 273         else if (skb->protocol == htons(ETH_P_IPV6))
 274                 return ipv6_get_dsfield((const struct ipv6hdr *)iph);
 275         else
 276                 return 0;
 277 }
 278
 279 /* Propogate ECN bits out */
 280 static inline u8 ip_tunnel_ecn_encap(u8 tos, const struct iphdr *iph,
 281                                      const struct sk_buff *skb)
 282 {
 283         u8 inner = ip_tunnel_get_dsfield(iph, skb);
 284
 285         return INET_ECN_encapsulate(tos, inner);
 286 }
 287
 288 int iptunnel_pull_header(struct sk_buff *skb, int hdr_len, __be16 inner_proto);
 289 int iptunnel_xmit(struct sock *sk, struct rtable *rt, struct sk_buff *skb,
 290                   __be32 src, __be32 dst, u8 proto,
 291                   u8 tos, u8 ttl, __be16 df, bool xnet);
 292
 293 struct sk_buff *iptunnel_handle_offloads(struct sk_buff *skb, bool gre_csum,
 294                                          int gso_type_mask);
 295
 296 static inline void iptunnel_xmit_stats(int err,
 297                                        struct net_device_stats *err_stats,
 298                                        struct pcpu_sw_netstats __percpu *stats)
 299 {
 300         if (err > 0) {
 301                 struct pcpu_sw_netstats *tstats = this_cpu_ptr(stats);
 302
 303                 u64_stats_update_begin(&tstats->syncp);
 304                 tstats->tx_bytes += err;
 305                 tstats->tx_packets++;
 306                 u64_stats_update_end(&tstats->syncp);
 307         } else if (err < 0) {
 308                 err_stats->tx_errors++;
 309                 err_stats->tx_aborted_errors++;
 310         } else {
 311                 err_stats->tx_dropped++;
 312         }
 313 }
 314
 315 static inline void *ip_tunnel_info_opts(struct ip_tunnel_info *info, size_t n)
 316 {
 317         return info + 1;
 318 }
 319
 320 static inline struct ip_tunnel_info *lwt_tun_info(struct lwtunnel_state *lwtstate)
 321 {
 322         return (struct ip_tunnel_info *)lwtstate->data;
 323 }
 324
 325 extern struct static_key ip_tunnel_metadata_cnt;
 326
 327 /* Returns > 0 if metadata should be collected */
 328 static inline int ip_tunnel_collect_metadata(void)
 329 {
 330         return static_key_false(&ip_tunnel_metadata_cnt);
 331 }
 332
 333 void __init ip_tunnel_core_init(void);
 334
 335 void ip_tunnel_need_metadata(void);
 336 void ip_tunnel_unneed_metadata(void);
 337
 338 #else /* CONFIG_INET */
 339
 340 static inline struct ip_tunnel_info *lwt_tun_info(struct lwtunnel_state *lwtstate)
 341 {
 342         return NULL;
 343 }
 344
 345 static inline void ip_tunnel_need_metadata(void)
 346 {
 347 }
 348
 349 static inline void ip_tunnel_unneed_metadata(void)
 350 {
 351 }
 352
 353 #endif /* CONFIG_INET */
 354
 355 #endif /* __NET_IP_TUNNELS_H */