datapath/tunnel.h

   1 /*
   2  * Copyright (c) 2007-2012 Nicira, Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of version 2 of the GNU General Public
   6  * License as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; if not, write to the Free Software
  15  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  16  * 02110-1301, USA
  17  */
  18
  19 #ifndef TUNNEL_H
  20 #define TUNNEL_H 1
  21
  22 #include <linux/version.h>
  23 #include <net/net_namespace.h>
  24 #include <net/netns/generic.h>
  25
  26 #include "flow.h"
  27 #include "openvswitch/tunnel.h"
  28 #include "vport.h"
  29
  30 /*
  31  * The absolute minimum fragment size.  Note that there are many other
  32  * definitions of the minimum MTU.
  33  */
  34 #define IP_MIN_MTU 68
  35
  36 /*
  37  * One of these goes in struct tnl_ops and in tnl_find_port().
  38  * These values are in the same namespace as other TNL_T_* values, so
  39  * only the least significant 10 bits are available to define protocol
  40  * identifiers.
  41  */
  42 #define TNL_T_PROTO_GRE         0
  43 #define TNL_T_PROTO_GRE64       1
  44 #define TNL_T_PROTO_VXLAN       3
  45
  46 /* These flags are only needed when calling tnl_find_port(). */
  47 #define TNL_T_KEY_EXACT         (1 << 10)
  48 #define TNL_T_KEY_MATCH         (1 << 11)
  49
  50 /* Private flags not exposed to userspace in this form. */
  51 #define TNL_F_IN_KEY_MATCH      (1 << 16) /* Store the key in tun_id to
  52                                            * match in flow table. */
  53 #define TNL_F_OUT_KEY_ACTION    (1 << 17) /* Get the key from a SET_TUNNEL
  54                                            * action. */
  55
  56 /* All public tunnel flags. */
  57 #define TNL_F_PUBLIC (TNL_F_CSUM | TNL_F_TOS_INHERIT | TNL_F_TTL_INHERIT | \
  58                       TNL_F_DF_DEFAULT)
  59
  60 /**
  61  * struct port_lookup_key - Tunnel port key, used as hash table key.
  62  * @in_key: Key to match on input, 0 for wildcard.
  63  * @net: Network namespace of the port.
  64  * @saddr: IPv4 source address to match, 0 to accept any source address.
  65  * @daddr: IPv4 destination of tunnel.
  66  * @tunnel_type: Set of TNL_T_* flags that define lookup.
  67  */
  68 struct port_lookup_key {
  69         __be64 in_key;
  70 #ifdef CONFIG_NET_NS
  71         struct net *net;
  72 #endif
  73         __be32 saddr;
  74         __be32 daddr;
  75         u32    tunnel_type;
  76 };
  77
  78 #define PORT_KEY_LEN    (offsetof(struct port_lookup_key, tunnel_type) + \
  79                          FIELD_SIZEOF(struct port_lookup_key, tunnel_type))
  80
  81 static inline struct net *port_key_get_net(const struct port_lookup_key *key)
  82 {
  83         return read_pnet(&key->net);
  84 }
  85
  86 static inline void port_key_set_net(struct port_lookup_key *key, struct net *net)
  87 {
  88         write_pnet(&key->net, net);
  89 }
  90
  91 /**
  92  * struct tnl_mutable_config - modifiable configuration for a tunnel.
  93  * @key: Used as key for tunnel port.  Configured via OVS_TUNNEL_ATTR_*
  94  * attributes.
  95  * @rcu: RCU callback head for deferred destruction.
  96  * @tunnel_hlen: Tunnel header length.
  97  * @out_key: Key to use on output, 0 if this tunnel has no fixed output key.
  98  * @flags: TNL_F_* flags.
  99  * @tos: IPv4 TOS value to use for tunnel, 0 if no fixed TOS.
 100  * @ttl: IPv4 TTL value to use for tunnel, 0 if no fixed TTL.
 101  */
 102 struct tnl_mutable_config {
 103         struct port_lookup_key key;
 104         struct rcu_head rcu;
 105
 106         /* Configured via OVS_TUNNEL_ATTR_* attributes. */
 107         __be64  out_key;
 108         u32     flags;
 109         u8      tos;
 110         u8      ttl;
 111         __be16  dst_port;
 112
 113         /* Multicast configuration. */
 114         int     mlink;
 115 };
 116
 117 struct tnl_ops {
 118         u32 tunnel_type;        /* Put the TNL_T_PROTO_* type in here. */
 119         u8 ipproto;             /* The IP protocol for the tunnel. */
 120
 121         /*
 122          * Returns the length of the tunnel header that will be added in
 123          * build_header() (i.e. excludes the IP header).  Returns a negative
 124          * error code if the configuration is invalid.
 125          */
 126         int (*hdr_len)(const struct tnl_mutable_config *,
 127                        const struct ovs_key_ipv4_tunnel *);
 128         /*
 129          * Returns a linked list of SKBs with tunnel headers (multiple
 130          * packets may be generated in the event of fragmentation).  Space
 131          * will have already been allocated at the start of the packet equal
 132          * to sizeof(struct iphdr) + value returned by hdr_len().  The IP
 133          * header will have already been constructed.
 134          */
 135         struct sk_buff *(*build_header)(const struct vport *,
 136                                          const struct tnl_mutable_config *,
 137                                          struct dst_entry *, struct sk_buff *,
 138                                          int tunnel_hlen);
 139 };
 140
 141 struct tnl_vport {
 142         struct rcu_head rcu;
 143         struct hlist_node hash_node;
 144
 145         char name[IFNAMSIZ];
 146         const struct tnl_ops *tnl_ops;
 147
 148         struct tnl_mutable_config __rcu *mutable;
 149 };
 150
 151 struct vport *ovs_tnl_create(const struct vport_parms *, const struct vport_ops *,
 152                              const struct tnl_ops *);
 153 void ovs_tnl_destroy(struct vport *);
 154
 155 int ovs_tnl_set_options(struct vport *, struct nlattr *);
 156 int ovs_tnl_get_options(const struct vport *, struct sk_buff *);
 157
 158 const char *ovs_tnl_get_name(const struct vport *vport);
 159 int ovs_tnl_send(struct vport *vport, struct sk_buff *skb);
 160 void ovs_tnl_rcv(struct vport *vport, struct sk_buff *skb);
 161
 162 struct vport *ovs_tnl_find_port(struct net *net, __be32 saddr, __be32 daddr,
 163                                 __be64 key, int tunnel_type,
 164                                 const struct tnl_mutable_config **mutable);
 165 bool ovs_tnl_frag_needed(struct vport *vport,
 166                          const struct tnl_mutable_config *mutable,
 167                          struct sk_buff *skb, unsigned int mtu);
 168 void ovs_tnl_free_linked_skbs(struct sk_buff *skb);
 169
 170 int ovs_tnl_init(void);
 171 void ovs_tnl_exit(void);
 172 static inline struct tnl_vport *tnl_vport_priv(const struct vport *vport)
 173 {
 174         return vport_priv(vport);
 175 }
 176
 177 static inline void tnl_tun_key_init(struct ovs_key_ipv4_tunnel *tun_key,
 178                                     const struct iphdr *iph, __be64 tun_id, u32 tun_flags)
 179 {
 180         tun_key->tun_id = tun_id;
 181         tun_key->ipv4_src = iph->saddr;
 182         tun_key->ipv4_dst = iph->daddr;
 183         tun_key->ipv4_tos = iph->tos;
 184         tun_key->ipv4_ttl = iph->ttl;
 185         tun_key->tun_flags = tun_flags;
 186
 187         /* clear struct padding. */
 188         memset((unsigned char*) tun_key + OVS_TUNNEL_KEY_SIZE, 0,
 189                sizeof(*tun_key) - OVS_TUNNEL_KEY_SIZE);
 190 }
 191
 192 static inline void tnl_get_param(const struct tnl_mutable_config *mutable,
 193                                  const struct ovs_key_ipv4_tunnel *tun_key,
 194                                  u32 *flags,  __be64 *out_key)
 195 {
 196         if (tun_key->ipv4_dst) {
 197                 *flags = 0;
 198
 199                 if (tun_key->tun_flags & OVS_TNL_F_KEY)
 200                         *flags = TNL_F_OUT_KEY_ACTION;
 201                 if (tun_key->tun_flags & OVS_TNL_F_CSUM)
 202                         *flags |= TNL_F_CSUM;
 203                 *out_key = tun_key->tun_id;
 204         } else {
 205                 *flags = mutable->flags;
 206                 if (mutable->flags & TNL_F_OUT_KEY_ACTION)
 207                         *out_key = tun_key->tun_id;
 208                 else
 209                         *out_key = mutable->out_key;
 210         }
 211 }
 212
 213 #endif /* tunnel.h */