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