datapath/tunnel.h

   1 /*
   2  * Copyright (c) 2010, 2011 Nicira Networks.
   3  * Distributed under the terms of the GNU GPL version 2.
   4  *
   5  * Significant portions of this file may be copied from parts of the Linux
   6  * kernel, by Linus Torvalds and others.
   7  */
   8
   9 #ifndef TUNNEL_H
  10 #define TUNNEL_H 1
  11
  12 #include <linux/version.h>
  13
  14 #include "flow.h"
  15 #include "openvswitch/tunnel.h"
  16 #include "vport.h"
  17
  18 /*
  19  * The absolute minimum fragment size.  Note that there are many other
  20  * definitions of the minimum MTU.
  21  */
  22 #define IP_MIN_MTU 68
  23
  24 /*
  25  * One of these goes in struct tnl_ops and in tnl_find_port().
  26  * These values are in the same namespace as other TNL_T_* values, so
  27  * only the least significant 10 bits are available to define protocol
  28  * identifiers.
  29  */
  30 #define TNL_T_PROTO_GRE         0
  31 #define TNL_T_PROTO_CAPWAP      1
  32
  33 /* These flags are only needed when calling tnl_find_port(). */
  34 #define TNL_T_KEY_EXACT         (1 << 10)
  35 #define TNL_T_KEY_MATCH         (1 << 11)
  36
  37 /* Private flags not exposed to userspace in this form. */
  38 #define TNL_F_IN_KEY_MATCH      (1 << 16) /* Store the key in tun_id to
  39                                            * match in flow table. */
  40 #define TNL_F_OUT_KEY_ACTION    (1 << 17) /* Get the key from a SET_TUNNEL
  41                                            * action. */
  42
  43 /* All public tunnel flags. */
  44 #define TNL_F_PUBLIC (TNL_F_CSUM | TNL_F_TOS_INHERIT | TNL_F_TTL_INHERIT | \
  45                       TNL_F_DF_INHERIT | TNL_F_DF_DEFAULT | TNL_F_PMTUD | \
  46                       TNL_F_HDR_CACHE | TNL_F_IPSEC)
  47
  48 /**
  49  * struct port_lookup_key - Tunnel port key, used as hash table key.
  50  * @in_key: Key to match on input, 0 for wildcard.
  51  * @saddr: IPv4 source address to match, 0 to accept any source address.
  52  * @daddr: IPv4 destination of tunnel.
  53  * @tunnel_type: Set of TNL_T_* flags that define lookup.
  54  */
  55 struct port_lookup_key {
  56         __be64 in_key;
  57         __be32 saddr;
  58         __be32 daddr;
  59         u32    tunnel_type;
  60 };
  61
  62 #define PORT_KEY_LEN    (offsetof(struct port_lookup_key, tunnel_type) + \
  63                          FIELD_SIZEOF(struct port_lookup_key, tunnel_type))
  64
  65 /**
  66  * struct tnl_mutable_config - modifiable configuration for a tunnel.
  67  * @key: Used as key for tunnel port.  Configured via OVS_TUNNEL_ATTR_*
  68  * attributes.
  69  * @rcu: RCU callback head for deferred destruction.
  70  * @seq: Sequence number for distinguishing configuration versions.
  71  * @tunnel_hlen: Tunnel header length.
  72  * @eth_addr: Source address for packets generated by tunnel itself
  73  * (e.g. ICMP fragmentation needed messages).
  74  * @out_key: Key to use on output, 0 if this tunnel has no fixed output key.
  75  * @flags: TNL_F_* flags.
  76  * @tos: IPv4 TOS value to use for tunnel, 0 if no fixed TOS.
  77  * @ttl: IPv4 TTL value to use for tunnel, 0 if no fixed TTL.
  78  */
  79 struct tnl_mutable_config {
  80         struct port_lookup_key key;
  81         struct rcu_head rcu;
  82
  83         unsigned seq;
  84
  85         unsigned tunnel_hlen;
  86
  87         unsigned char eth_addr[ETH_ALEN];
  88
  89         /* Configured via OVS_TUNNEL_ATTR_* attributes. */
  90         __be64  out_key;
  91         u32     flags;
  92         u8      tos;
  93         u8      ttl;
  94
  95         /* Multicast configuration. */
  96         int     mlink;
  97 };
  98
  99 struct tnl_ops {
 100         u32 tunnel_type;        /* Put the TNL_T_PROTO_* type in here. */
 101         u8 ipproto;             /* The IP protocol for the tunnel. */
 102
 103         /*
 104          * Returns the length of the tunnel header that will be added in
 105          * build_header() (i.e. excludes the IP header).  Returns a negative
 106          * error code if the configuration is invalid.
 107          */
 108         int (*hdr_len)(const struct tnl_mutable_config *);
 109
 110         /*
 111          * Builds the static portion of the tunnel header, which is stored in
 112          * the header cache.  In general the performance of this function is
 113          * not too important as we try to only call it when building the cache
 114          * so it is preferable to shift as much work as possible here.  However,
 115          * in some circumstances caching is disabled and this function will be
 116          * called for every packet, so try not to make it too slow.
 117          */
 118         void (*build_header)(const struct vport *,
 119                              const struct tnl_mutable_config *, void *header);
 120
 121         /*
 122          * Updates the cached header of a packet to match the actual packet
 123          * data.  Typical things that might need to be updated are length,
 124          * checksum, etc.  The IP header will have already been updated and this
 125          * is the final step before transmission.  Returns a linked list of
 126          * completed SKBs (multiple packets may be generated in the event
 127          * of fragmentation).
 128          */
 129         struct sk_buff *(*update_header)(const struct vport *,
 130                                          const struct tnl_mutable_config *,
 131                                          struct dst_entry *, struct sk_buff *);
 132 };
 133
 134 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,20)
 135 /*
 136  * On these kernels we have a fast mechanism to tell if the ARP cache for a
 137  * particular destination has changed.
 138  */
 139 #define HAVE_HH_SEQ
 140 #endif
 141 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,27)
 142 /*
 143  * On these kernels we have a fast mechanism to tell if the routing table
 144  * has changed.
 145  */
 146 #define HAVE_RT_GENID
 147 #endif
 148 #if !defined(HAVE_HH_SEQ) || !defined(HAVE_RT_GENID)
 149 /* If we can't detect all system changes directly we need to use a timeout. */
 150 #define NEED_CACHE_TIMEOUT
 151 #endif
 152 struct tnl_cache {
 153         struct rcu_head rcu;
 154
 155         int len;                /* Length of data to be memcpy'd from cache. */
 156         int hh_len;             /* Hardware hdr length, cached from hh_cache. */
 157
 158         /* Sequence number of mutable->seq from which this cache was
 159          * generated. */
 160         unsigned mutable_seq;
 161
 162 #ifdef HAVE_HH_SEQ
 163         /*
 164          * The sequence number from the seqlock protecting the hardware header
 165          * cache (in the ARP cache).  Since every write increments the counter
 166          * this gives us an easy way to tell if it has changed.
 167          */
 168         unsigned hh_seq;
 169 #endif
 170
 171 #ifdef NEED_CACHE_TIMEOUT
 172         /*
 173          * If we don't have direct mechanisms to detect all important changes in
 174          * the system fall back to an expiration time.  This expiration time
 175          * can be relatively short since at high rates there will be millions of
 176          * packets per second, so we'll still get plenty of benefit from the
 177          * cache.  Note that if something changes we may blackhole packets
 178          * until the expiration time (depending on what changed and the kernel
 179          * version we may be able to detect the change sooner).  Expiration is
 180          * expressed as a time in jiffies.
 181          */
 182         unsigned long expiration;
 183 #endif
 184
 185         /*
 186          * The routing table entry that is the result of looking up the tunnel
 187          * endpoints.  It also contains a sequence number (called a generation
 188          * ID) that can be compared to a global sequence to tell if the routing
 189          * table has changed (and therefore there is a potential that this
 190          * cached route has been invalidated).
 191          */
 192         struct rtable *rt;
 193
 194         /*
 195          * If the output device for tunnel traffic is an OVS internal device,
 196          * the flow of that datapath.  Since all tunnel traffic will have the
 197          * same headers this allows us to cache the flow lookup.  NULL if the
 198          * output device is not OVS or if there is no flow installed.
 199          */
 200         struct sw_flow *flow;
 201
 202         /* The cached header follows after padding for alignment. */
 203 };
 204
 205 struct tnl_vport {
 206         struct rcu_head rcu;
 207         struct hlist_node hash_node;
 208
 209         char name[IFNAMSIZ];
 210         const struct tnl_ops *tnl_ops;
 211
 212         struct tnl_mutable_config __rcu *mutable;
 213
 214         /*
 215          * ID of last fragment sent (for tunnel protocols with direct support
 216          * fragmentation).  If the protocol relies on IP fragmentation then
 217          * this is not needed.
 218          */
 219         atomic_t frag_id;
 220
 221         spinlock_t cache_lock;
 222         struct tnl_cache __rcu *cache;  /* Protected by RCU/cache_lock. */
 223
 224 #ifdef NEED_CACHE_TIMEOUT
 225         /*
 226          * If we must rely on expiration time to invalidate the cache, this is
 227          * the interval.  It is randomized within a range (defined by
 228          * MAX_CACHE_EXP in tunnel.c) to avoid synchronized expirations caused
 229          * by creation of a large number of tunnels at a one time.
 230          */
 231         unsigned long cache_exp_interval;
 232 #endif
 233 };
 234
 235 struct vport *tnl_create(const struct vport_parms *, const struct vport_ops *,
 236                          const struct tnl_ops *);
 237 void tnl_destroy(struct vport *);
 238
 239 int tnl_set_options(struct vport *, struct nlattr *);
 240 int tnl_get_options(const struct vport *, struct sk_buff *);
 241
 242 int tnl_set_addr(struct vport *vport, const unsigned char *addr);
 243 const char *tnl_get_name(const struct vport *vport);
 244 const unsigned char *tnl_get_addr(const struct vport *vport);
 245 int tnl_send(struct vport *vport, struct sk_buff *skb);
 246 void tnl_rcv(struct vport *vport, struct sk_buff *skb, u8 tos);
 247
 248 struct vport *tnl_find_port(__be32 saddr, __be32 daddr, __be64 key,
 249                             int tunnel_type,
 250                             const struct tnl_mutable_config **mutable);
 251 bool tnl_frag_needed(struct vport *vport,
 252                      const struct tnl_mutable_config *mutable,
 253                      struct sk_buff *skb, unsigned int mtu, __be64 flow_key);
 254 void tnl_free_linked_skbs(struct sk_buff *skb);
 255
 256 int tnl_init(void);
 257 void tnl_exit(void);
 258 static inline struct tnl_vport *tnl_vport_priv(const struct vport *vport)
 259 {
 260         return vport_priv(vport);
 261 }
 262
 263
 264 #endif /* tunnel.h */