2 * Copyright (c) 2007-2012 Nicira, Inc.
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.
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.
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
22 #include <linux/version.h>
23 #include <net/net_namespace.h>
24 #include <net/netns/generic.h>
27 #include "openvswitch/tunnel.h"
31 * The absolute minimum fragment size. Note that there are many other
32 * definitions of the minimum MTU.
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
42 #define TNL_T_PROTO_GRE 0
43 #define TNL_T_PROTO_GRE64 1
44 #define TNL_T_PROTO_VXLAN 3
45 #define TNL_T_PROTO_LISP 4
47 /* These flags are only needed when calling tnl_find_port(). */
48 #define TNL_T_KEY_EXACT (1 << 10)
49 #define TNL_T_KEY_MATCH (1 << 11)
51 /* Private flags not exposed to userspace in this form. */
52 #define TNL_F_IN_KEY_MATCH (1 << 16) /* Store the key in tun_id to
53 * match in flow table. */
54 #define TNL_F_OUT_KEY_ACTION (1 << 17) /* Get the key from a SET_TUNNEL
57 /* All public tunnel flags. */
58 #define TNL_F_PUBLIC (TNL_F_CSUM | TNL_F_TOS_INHERIT | TNL_F_TTL_INHERIT | \
62 * struct port_lookup_key - Tunnel port key, used as hash table key.
63 * @in_key: Key to match on input, 0 for wildcard.
64 * @net: Network namespace of the port.
65 * @saddr: IPv4 source address to match, 0 to accept any source address.
66 * @daddr: IPv4 destination of tunnel.
67 * @tunnel_type: Set of TNL_T_* flags that define lookup.
69 struct port_lookup_key {
79 #define PORT_KEY_LEN (offsetof(struct port_lookup_key, tunnel_type) + \
80 FIELD_SIZEOF(struct port_lookup_key, tunnel_type))
82 static inline struct net *port_key_get_net(const struct port_lookup_key *key)
84 return read_pnet(&key->net);
87 static inline void port_key_set_net(struct port_lookup_key *key, struct net *net)
89 write_pnet(&key->net, net);
93 * struct tnl_mutable_config - modifiable configuration for a tunnel.
94 * @key: Used as key for tunnel port. Configured via OVS_TUNNEL_ATTR_*
96 * @rcu: RCU callback head for deferred destruction.
97 * @tunnel_hlen: Tunnel header length.
98 * @out_key: Key to use on output, 0 if this tunnel has no fixed output key.
99 * @flags: TNL_F_* flags.
100 * @tos: IPv4 TOS value to use for tunnel, 0 if no fixed TOS.
101 * @ttl: IPv4 TTL value to use for tunnel, 0 if no fixed TTL.
103 struct tnl_mutable_config {
104 struct port_lookup_key key;
107 /* Configured via OVS_TUNNEL_ATTR_* attributes. */
114 /* Multicast configuration. */
119 u32 tunnel_type; /* Put the TNL_T_PROTO_* type in here. */
120 u8 ipproto; /* The IP protocol for the tunnel. */
123 * Returns the length of the tunnel header that will be added in
124 * build_header() (i.e. excludes the IP header). Returns a negative
125 * error code if the configuration is invalid.
127 int (*hdr_len)(const struct tnl_mutable_config *,
128 const struct ovs_key_ipv4_tunnel *);
130 * Returns a linked list of SKBs with tunnel headers (multiple
131 * packets may be generated in the event of fragmentation). Space
132 * will have already been allocated at the start of the packet equal
133 * to sizeof(struct iphdr) + value returned by hdr_len(). The IP
134 * header will have already been constructed.
136 struct sk_buff *(*build_header)(const struct vport *,
137 const struct tnl_mutable_config *,
138 struct dst_entry *, struct sk_buff *,
144 struct hlist_node hash_node;
147 const struct tnl_ops *tnl_ops;
149 struct tnl_mutable_config __rcu *mutable;
152 struct vport *ovs_tnl_create(const struct vport_parms *, const struct vport_ops *,
153 const struct tnl_ops *);
154 void ovs_tnl_destroy(struct vport *);
156 int ovs_tnl_set_options(struct vport *, struct nlattr *);
157 int ovs_tnl_get_options(const struct vport *, struct sk_buff *);
159 const char *ovs_tnl_get_name(const struct vport *vport);
160 int ovs_tnl_send(struct vport *vport, struct sk_buff *skb);
161 void ovs_tnl_rcv(struct vport *vport, struct sk_buff *skb);
162 u16 ovs_tnl_get_src_port(struct sk_buff *skb);
164 struct vport *ovs_tnl_find_port(struct net *net, __be32 saddr, __be32 daddr,
165 __be64 key, int tunnel_type,
166 const struct tnl_mutable_config **mutable);
167 bool ovs_tnl_frag_needed(struct vport *vport,
168 const struct tnl_mutable_config *mutable,
169 struct sk_buff *skb, unsigned int mtu);
170 void ovs_tnl_free_linked_skbs(struct sk_buff *skb);
172 int ovs_tnl_init(void);
173 void ovs_tnl_exit(void);
174 static inline struct tnl_vport *tnl_vport_priv(const struct vport *vport)
176 return vport_priv(vport);
179 static inline void tnl_tun_key_init(struct ovs_key_ipv4_tunnel *tun_key,
180 const struct iphdr *iph, __be64 tun_id, u32 tun_flags)
182 tun_key->tun_id = tun_id;
183 tun_key->ipv4_src = iph->saddr;
184 tun_key->ipv4_dst = iph->daddr;
185 tun_key->ipv4_tos = iph->tos;
186 tun_key->ipv4_ttl = iph->ttl;
187 tun_key->tun_flags = tun_flags;
189 /* clear struct padding. */
190 memset((unsigned char*) tun_key + OVS_TUNNEL_KEY_SIZE, 0,
191 sizeof(*tun_key) - OVS_TUNNEL_KEY_SIZE);
194 static inline void tnl_get_param(const struct tnl_mutable_config *mutable,
195 const struct ovs_key_ipv4_tunnel *tun_key,
196 u32 *flags, __be64 *out_key)
198 if (tun_key->ipv4_dst) {
201 if (tun_key->tun_flags & OVS_TNL_F_KEY)
202 *flags = TNL_F_OUT_KEY_ACTION;
203 if (tun_key->tun_flags & OVS_TNL_F_CSUM)
204 *flags |= TNL_F_CSUM;
205 *out_key = tun_key->tun_id;
207 *flags = mutable->flags;
208 if (mutable->flags & TNL_F_OUT_KEY_ACTION)
209 *out_key = tun_key->tun_id;
211 *out_key = mutable->out_key;
215 #endif /* tunnel.h */