1 /* Copyright (c) 2013 Nicira, Inc.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License. */
20 #include "ofproto/ofproto-provider.h"
21 #include "byte-order.h"
22 #include "dynamic-string.h"
25 #include "netdev-vport.h"
29 #include "socket-util.h"
35 * Ability to generate actions on input for ECN
36 * Ability to generate metadata for packet-outs
37 * Disallow netdevs with names like "gre64_system" to prevent collisions. */
39 VLOG_DEFINE_THIS_MODULE(tunnel);
41 /* skb mark used for IPsec tunnel packets */
54 struct hmap_node match_node;
56 const struct ofport *ofport;
57 unsigned int netdev_seq;
58 struct tnl_match match;
61 static struct hmap tnl_match_map = HMAP_INITIALIZER(&tnl_match_map);
63 /* Returned to callers when their ofport will never be used to receive or send
64 * tunnel traffic. Alternatively, we could ask the caller to delete their
65 * ofport, but this would be unclean in the reconfguration case. For the first
66 * time, an ofproto provider would have to call ofproto_port_del() on itself.*/
67 static struct tnl_port void_tnl_port;
69 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
70 static struct vlog_rate_limit dbg_rl = VLOG_RATE_LIMIT_INIT(60, 60);
72 static struct tnl_port *tnl_find(struct tnl_match *);
73 static struct tnl_port *tnl_find_exact(struct tnl_match *);
74 static uint32_t tnl_hash(struct tnl_match *);
75 static void tnl_match_fmt(const struct tnl_match *, struct ds *);
76 static char *tnl_port_fmt(const struct tnl_port *);
77 static void tnl_port_mod_log(const struct tnl_port *, const char *action);
78 static const char *tnl_port_get_name(const struct tnl_port *);
80 static struct tnl_port *
81 tnl_port_add__(const struct ofport *ofport, uint32_t odp_port,
84 const struct netdev_tunnel_config *cfg;
85 struct tnl_port *existing_port;
86 struct tnl_port *tnl_port;
88 cfg = netdev_get_tunnel_config(ofport->netdev);
91 tnl_port = xzalloc(sizeof *tnl_port);
92 tnl_port->ofport = ofport;
93 tnl_port->netdev_seq = netdev_change_seq(tnl_port->ofport->netdev);
95 tnl_port->match.in_key = cfg->in_key;
96 tnl_port->match.ip_src = cfg->ip_src;
97 tnl_port->match.ip_dst = cfg->ip_dst;
98 tnl_port->match.skb_mark = cfg->ipsec ? IPSEC_MARK : 0;
99 tnl_port->match.in_key_flow = cfg->in_key_flow;
100 tnl_port->match.odp_port = odp_port;
102 existing_port = tnl_find_exact(&tnl_port->match);
105 struct ds ds = DS_EMPTY_INITIALIZER;
106 tnl_match_fmt(&tnl_port->match, &ds);
107 VLOG_WARN("%s: attempting to add tunnel port with same config as "
108 "port '%s' (%s)", tnl_port_get_name(tnl_port),
109 tnl_port_get_name(existing_port), ds_cstr(&ds));
113 return &void_tnl_port;
116 hmap_insert(&tnl_match_map, &tnl_port->match_node,
117 tnl_hash(&tnl_port->match));
118 tnl_port_mod_log(tnl_port, "adding");
122 /* Adds 'ofport' to the module with datapath port number 'odp_port'. 'ofport's
123 * must be added before they can be used by the module. 'ofport' must be a
126 tnl_port_add(const struct ofport *ofport, uint32_t odp_port)
128 return tnl_port_add__(ofport, odp_port, true);
131 /* Checks if the tnl_port pointed to by 'tnl_portp' needs reconfiguration due
132 * to changes in its netdev_tunnel_config. If it does, updates 'tnl_portp' to
133 * point to a new tnl_port and returns true. Otherwise, returns false.
134 * 'ofport' and 'odp_port' should be the same as would be passed to
137 tnl_port_reconfigure(const struct ofport *ofport, uint32_t odp_port,
138 struct tnl_port **tnl_portp)
140 struct tnl_port *tnl_port = *tnl_portp;
142 if (tnl_port == &void_tnl_port) {
143 *tnl_portp = tnl_port_add__(ofport, odp_port, false);
144 return *tnl_portp != &void_tnl_port;
145 } else if (tnl_port->ofport != ofport
146 || tnl_port->match.odp_port != odp_port
147 || tnl_port->netdev_seq != netdev_change_seq(ofport->netdev)) {
148 VLOG_DBG("reconfiguring %s", tnl_port_get_name(tnl_port));
149 tnl_port_del(tnl_port);
150 *tnl_portp = tnl_port_add(ofport, odp_port);
156 /* Removes 'tnl_port' from the module. */
158 tnl_port_del(struct tnl_port *tnl_port)
160 if (tnl_port && tnl_port != &void_tnl_port) {
161 tnl_port_mod_log(tnl_port, "removing");
162 hmap_remove(&tnl_match_map, &tnl_port->match_node);
167 /* Transforms 'flow' so that it appears to have been received by a tunnel
168 * OpenFlow port controlled by this module instead of the datapath port it
169 * actually came in on. Sets 'flow''s in_port to the appropriate OpenFlow port
170 * number. Returns the 'ofport' corresponding to the new in_port.
172 * Callers should verify that 'flow' needs to be received by calling
173 * tnl_port_should_receive() before this function.
175 * Leaves 'flow' untouched and returns null if unsuccessful. */
176 const struct ofport *
177 tnl_port_receive(struct flow *flow)
179 char *pre_flow_str = NULL;
180 struct tnl_port *tnl_port;
181 struct tnl_match match;
183 memset(&match, 0, sizeof match);
184 match.odp_port = flow->in_port;
185 match.ip_src = flow->tunnel.ip_dst;
186 match.ip_dst = flow->tunnel.ip_src;
187 match.in_key = flow->tunnel.tun_id;
188 match.skb_mark = flow->skb_mark;
190 tnl_port = tnl_find(&match);
192 struct ds ds = DS_EMPTY_INITIALIZER;
194 tnl_match_fmt(&match, &ds);
195 VLOG_WARN_RL(&rl, "receive tunnel port not found (%s)", ds_cstr(&ds));
200 if (!VLOG_DROP_DBG(&dbg_rl)) {
201 pre_flow_str = flow_to_string(flow);
204 flow->in_port = tnl_port->ofport->ofp_port;
205 memset(&flow->tunnel, 0, sizeof flow->tunnel);
206 flow->tunnel.tun_id = match.in_key;
209 char *post_flow_str = flow_to_string(flow);
210 char *tnl_str = tnl_port_fmt(tnl_port);
211 VLOG_DBG("flow received\n"
215 tnl_str, pre_flow_str, post_flow_str);
220 return tnl_port->ofport;
223 /* Given that 'flow' should be output to the ofport corresponding to
224 * 'tnl_port', updates 'flow''s tunnel headers and returns the actual datapath
225 * port that the output should happen on. May return OVSP_NONE if the output
226 * shouldn't occur. */
228 tnl_port_send(const struct tnl_port *tnl_port, struct flow *flow)
230 const struct netdev_tunnel_config *cfg;
231 char *pre_flow_str = NULL;
233 if (tnl_port == &void_tnl_port) {
237 cfg = netdev_get_tunnel_config(tnl_port->ofport->netdev);
240 if (!VLOG_DROP_DBG(&dbg_rl)) {
241 pre_flow_str = flow_to_string(flow);
244 flow->tunnel.ip_src = tnl_port->match.ip_src;
245 flow->tunnel.ip_dst = tnl_port->match.ip_dst;
246 flow->skb_mark = tnl_port->match.skb_mark;
248 if (!cfg->out_key_flow) {
249 flow->tunnel.tun_id = cfg->out_key;
252 if (cfg->ttl_inherit && is_ip_any(flow)) {
253 flow->tunnel.ip_ttl = flow->nw_ttl;
255 flow->tunnel.ip_ttl = cfg->ttl;
258 if (cfg->tos_inherit && is_ip_any(flow)) {
259 flow->tunnel.ip_tos = flow->nw_tos & IP_DSCP_MASK;
261 flow->tunnel.ip_tos = cfg->tos;
264 if ((flow->nw_tos & IP_ECN_MASK) == IP_ECN_CE) {
265 flow->tunnel.ip_tos |= IP_ECN_ECT_0;
267 flow->tunnel.ip_tos |= flow->nw_tos & IP_ECN_MASK;
270 flow->tunnel.flags = (cfg->dont_fragment ? FLOW_TNL_F_DONT_FRAGMENT : 0)
271 | (cfg->csum ? FLOW_TNL_F_CSUM : 0)
272 | (cfg->out_key_present ? FLOW_TNL_F_KEY : 0);
275 char *post_flow_str = flow_to_string(flow);
276 char *tnl_str = tnl_port_fmt(tnl_port);
277 VLOG_DBG("flow sent\n"
281 tnl_str, pre_flow_str, post_flow_str);
287 return tnl_port->match.odp_port;
291 tnl_hash(struct tnl_match *match)
293 BUILD_ASSERT_DECL(sizeof *match % sizeof(uint32_t) == 0);
294 return hash_words((uint32_t *) match, sizeof *match / sizeof(uint32_t), 0);
297 static struct tnl_port *
298 tnl_find_exact(struct tnl_match *match)
300 struct tnl_port *tnl_port;
302 HMAP_FOR_EACH_WITH_HASH (tnl_port, match_node, tnl_hash(match),
304 if (!memcmp(match, &tnl_port->match, sizeof *match)) {
311 static struct tnl_port *
312 tnl_find(struct tnl_match *match_)
314 struct tnl_match match = *match_;
315 struct tnl_port *tnl_port;
317 /* remote_ip, local_ip, in_key */
318 tnl_port = tnl_find_exact(&match);
323 /* remote_ip, in_key */
325 tnl_port = tnl_find_exact(&match);
329 match.ip_src = match_->ip_src;
331 /* remote_ip, local_ip */
333 match.in_key_flow = true;
334 tnl_port = tnl_find_exact(&match);
341 tnl_port = tnl_find_exact(&match);
350 tnl_match_fmt(const struct tnl_match *match, struct ds *ds)
352 ds_put_format(ds, IP_FMT"->"IP_FMT, IP_ARGS(match->ip_src),
353 IP_ARGS(match->ip_dst));
355 if (match->in_key_flow) {
356 ds_put_cstr(ds, ", key=flow");
358 ds_put_format(ds, ", key=%#"PRIx64, ntohll(match->in_key));
361 ds_put_format(ds, ", dp port=%"PRIu32, match->odp_port);
362 ds_put_format(ds, ", skb mark=%"PRIu32, match->skb_mark);
366 tnl_port_mod_log(const struct tnl_port *tnl_port, const char *action)
368 if (VLOG_IS_DBG_ENABLED()) {
369 struct ds ds = DS_EMPTY_INITIALIZER;
371 tnl_match_fmt(&tnl_port->match, &ds);
372 VLOG_INFO("%s tunnel port %s (%s)", action,
373 tnl_port_get_name(tnl_port), ds_cstr(&ds));
379 tnl_port_fmt(const struct tnl_port *tnl_port)
381 const struct netdev_tunnel_config *cfg =
382 netdev_get_tunnel_config(tnl_port->ofport->netdev);
383 struct ds ds = DS_EMPTY_INITIALIZER;
385 ds_put_format(&ds, "port %"PRIu32": %s (%s: ", tnl_port->match.odp_port,
386 tnl_port_get_name(tnl_port),
387 netdev_get_type(tnl_port->ofport->netdev));
388 tnl_match_fmt(&tnl_port->match, &ds);
390 if (cfg->out_key != cfg->in_key ||
391 cfg->out_key_present != cfg->in_key_present ||
392 cfg->out_key_flow != cfg->in_key_flow) {
393 ds_put_cstr(&ds, ", out_key=");
394 if (!cfg->out_key_present) {
395 ds_put_cstr(&ds, "none");
396 } else if (cfg->out_key_flow) {
397 ds_put_cstr(&ds, "flow");
399 ds_put_format(&ds, "%#"PRIx64, ntohll(cfg->out_key));
403 if (cfg->ttl_inherit) {
404 ds_put_cstr(&ds, ", ttl=inherit");
406 ds_put_format(&ds, ", ttl=%"PRIu8, cfg->ttl);
409 if (cfg->tos_inherit) {
410 ds_put_cstr(&ds, ", tos=inherit");
411 } else if (cfg->tos) {
412 ds_put_format(&ds, ", tos=%#"PRIx8, cfg->tos);
415 if (!cfg->dont_fragment) {
416 ds_put_cstr(&ds, ", df=false");
420 ds_put_cstr(&ds, ", csum=true");
423 ds_put_cstr(&ds, ")\n");
425 return ds_steal_cstr(&ds);
429 tnl_port_get_name(const struct tnl_port *tnl_port)
431 return netdev_get_name(tnl_port->ofport->netdev);