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 "byte-order.h"
21 #include "connectivity.h"
22 #include "dynamic-string.h"
30 #include "socket-util.h"
34 VLOG_DEFINE_THIS_MODULE(tunnel);
36 /* skb mark used for IPsec tunnel packets */
51 struct hmap_node ofport_node;
52 struct hmap_node match_node;
54 const struct ofport_dpif *ofport;
55 unsigned int change_seq;
56 struct netdev *netdev;
58 struct tnl_match match;
61 static struct ovs_rwlock rwlock = OVS_RWLOCK_INITIALIZER;
63 static struct hmap tnl_match_map__ = HMAP_INITIALIZER(&tnl_match_map__);
64 static struct hmap *tnl_match_map OVS_GUARDED_BY(rwlock) = &tnl_match_map__;
66 static struct hmap ofport_map__ = HMAP_INITIALIZER(&ofport_map__);
67 static struct hmap *ofport_map OVS_GUARDED_BY(rwlock) = &ofport_map__;
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(const struct flow *) OVS_REQ_RDLOCK(rwlock);
73 static struct tnl_port *tnl_find_exact(struct tnl_match *)
74 OVS_REQ_RDLOCK(rwlock);
75 static struct tnl_port *tnl_find_ofport(const struct ofport_dpif *)
76 OVS_REQ_RDLOCK(rwlock);
78 static uint32_t tnl_hash(struct tnl_match *);
79 static void tnl_match_fmt(const struct tnl_match *, struct ds *);
80 static char *tnl_port_fmt(const struct tnl_port *) OVS_REQ_RDLOCK(rwlock);
81 static void tnl_port_mod_log(const struct tnl_port *, const char *action)
82 OVS_REQ_RDLOCK(rwlock);
83 static const char *tnl_port_get_name(const struct tnl_port *)
84 OVS_REQ_RDLOCK(rwlock);
85 static void tnl_port_del__(const struct ofport_dpif *) OVS_REQ_WRLOCK(rwlock);
88 tnl_port_add__(const struct ofport_dpif *ofport, const struct netdev *netdev,
89 odp_port_t odp_port, bool warn)
90 OVS_REQ_WRLOCK(rwlock)
92 const struct netdev_tunnel_config *cfg;
93 struct tnl_port *existing_port;
94 struct tnl_port *tnl_port;
96 cfg = netdev_get_tunnel_config(netdev);
99 tnl_port = xzalloc(sizeof *tnl_port);
100 tnl_port->ofport = ofport;
101 tnl_port->netdev = netdev_ref(netdev);
102 tnl_port->change_seq = seq_read(connectivity_seq_get());
104 tnl_port->match.in_key = cfg->in_key;
105 tnl_port->match.ip_src = cfg->ip_src;
106 tnl_port->match.ip_dst = cfg->ip_dst;
107 tnl_port->match.ip_src_flow = cfg->ip_src_flow;
108 tnl_port->match.ip_dst_flow = cfg->ip_dst_flow;
109 tnl_port->match.pkt_mark = cfg->ipsec ? IPSEC_MARK : 0;
110 tnl_port->match.in_key_flow = cfg->in_key_flow;
111 tnl_port->match.odp_port = odp_port;
113 existing_port = tnl_find_exact(&tnl_port->match);
116 struct ds ds = DS_EMPTY_INITIALIZER;
117 tnl_match_fmt(&tnl_port->match, &ds);
118 VLOG_WARN("%s: attempting to add tunnel port with same config as "
119 "port '%s' (%s)", tnl_port_get_name(tnl_port),
120 tnl_port_get_name(existing_port), ds_cstr(&ds));
127 hmap_insert(ofport_map, &tnl_port->ofport_node, hash_pointer(ofport, 0));
128 hmap_insert(tnl_match_map, &tnl_port->match_node,
129 tnl_hash(&tnl_port->match));
130 tnl_port_mod_log(tnl_port, "adding");
134 /* Adds 'ofport' to the module with datapath port number 'odp_port'. 'ofport's
135 * must be added before they can be used by the module. 'ofport' must be a
138 tnl_port_add(const struct ofport_dpif *ofport, const struct netdev *netdev,
139 odp_port_t odp_port) OVS_EXCLUDED(rwlock)
141 ovs_rwlock_wrlock(&rwlock);
142 tnl_port_add__(ofport, netdev, odp_port, true);
143 ovs_rwlock_unlock(&rwlock);
146 /* Checks if the tunnel represented by 'ofport' reconfiguration due to changes
147 * in its netdev_tunnel_config. If it does, returns true. Otherwise, returns
148 * false. 'ofport' and 'odp_port' should be the same as would be passed to
151 tnl_port_reconfigure(const struct ofport_dpif *ofport,
152 const struct netdev *netdev, odp_port_t odp_port)
155 struct tnl_port *tnl_port;
156 bool changed = false;
158 ovs_rwlock_wrlock(&rwlock);
159 tnl_port = tnl_find_ofport(ofport);
161 changed = tnl_port_add__(ofport, netdev, odp_port, false);
162 } else if (tnl_port->netdev != netdev
163 || tnl_port->match.odp_port != odp_port
164 || tnl_port->change_seq != seq_read(connectivity_seq_get())) {
165 VLOG_DBG("reconfiguring %s", tnl_port_get_name(tnl_port));
166 tnl_port_del__(ofport);
167 tnl_port_add__(ofport, netdev, odp_port, true);
170 ovs_rwlock_unlock(&rwlock);
175 tnl_port_del__(const struct ofport_dpif *ofport) OVS_REQ_WRLOCK(rwlock)
177 struct tnl_port *tnl_port;
183 tnl_port = tnl_find_ofport(ofport);
185 tnl_port_mod_log(tnl_port, "removing");
186 hmap_remove(tnl_match_map, &tnl_port->match_node);
187 hmap_remove(ofport_map, &tnl_port->ofport_node);
188 netdev_close(tnl_port->netdev);
193 /* Removes 'ofport' from the module. */
195 tnl_port_del(const struct ofport_dpif *ofport) OVS_EXCLUDED(rwlock)
197 ovs_rwlock_wrlock(&rwlock);
198 tnl_port_del__(ofport);
199 ovs_rwlock_unlock(&rwlock);
202 /* Looks in the table of tunnels for a tunnel matching the metadata in 'flow'.
203 * Returns the 'ofport' corresponding to the new in_port, or a null pointer if
206 * Callers should verify that 'flow' needs to be received by calling
207 * tnl_port_should_receive() before this function. */
208 const struct ofport_dpif *
209 tnl_port_receive(const struct flow *flow) OVS_EXCLUDED(rwlock)
211 char *pre_flow_str = NULL;
212 const struct ofport_dpif *ofport;
213 struct tnl_port *tnl_port;
215 ovs_rwlock_rdlock(&rwlock);
216 tnl_port = tnl_find(flow);
217 ofport = tnl_port ? tnl_port->ofport : NULL;
219 char *flow_str = flow_to_string(flow);
221 VLOG_WARN_RL(&rl, "receive tunnel port not found (%s)", flow_str);
226 if (!VLOG_DROP_DBG(&dbg_rl)) {
227 pre_flow_str = flow_to_string(flow);
231 char *post_flow_str = flow_to_string(flow);
232 char *tnl_str = tnl_port_fmt(tnl_port);
233 VLOG_DBG("flow received\n"
237 tnl_str, pre_flow_str, post_flow_str);
244 ovs_rwlock_unlock(&rwlock);
249 tnl_ecn_ok(const struct flow *base_flow, struct flow *flow)
251 if (is_ip_any(base_flow)
252 && (flow->tunnel.ip_tos & IP_ECN_MASK) == IP_ECN_CE) {
253 if ((base_flow->nw_tos & IP_ECN_MASK) == IP_ECN_NOT_ECT) {
254 VLOG_WARN_RL(&rl, "dropping tunnel packet marked ECN CE"
255 " but is not ECN capable");
258 /* Set the ECN CE value in the tunneled packet. */
259 flow->nw_tos |= IP_ECN_CE;
266 /* Should be called at the beginning of action translation to initialize
267 * wildcards and perform any actions based on receiving on tunnel port.
269 * Returns false if the packet must be dropped. */
271 tnl_xlate_init(const struct flow *base_flow, struct flow *flow,
272 struct flow_wildcards *wc)
274 if (tnl_port_should_receive(flow)) {
275 memset(&wc->masks.tunnel, 0xff, sizeof wc->masks.tunnel);
276 memset(&wc->masks.pkt_mark, 0xff, sizeof wc->masks.pkt_mark);
278 if (!tnl_ecn_ok(base_flow, flow)) {
282 flow->pkt_mark &= ~IPSEC_MARK;
288 /* Given that 'flow' should be output to the ofport corresponding to
289 * 'tnl_port', updates 'flow''s tunnel headers and returns the actual datapath
290 * port that the output should happen on. May return ODPP_NONE if the output
291 * shouldn't occur. */
293 tnl_port_send(const struct ofport_dpif *ofport, struct flow *flow,
294 struct flow_wildcards *wc) OVS_EXCLUDED(rwlock)
296 const struct netdev_tunnel_config *cfg;
297 struct tnl_port *tnl_port;
298 char *pre_flow_str = NULL;
301 ovs_rwlock_rdlock(&rwlock);
302 tnl_port = tnl_find_ofport(ofport);
303 out_port = tnl_port ? tnl_port->match.odp_port : ODPP_NONE;
308 cfg = netdev_get_tunnel_config(tnl_port->netdev);
311 if (!VLOG_DROP_DBG(&dbg_rl)) {
312 pre_flow_str = flow_to_string(flow);
315 if (!cfg->ip_src_flow) {
316 flow->tunnel.ip_src = tnl_port->match.ip_src;
318 if (!cfg->ip_dst_flow) {
319 flow->tunnel.ip_dst = tnl_port->match.ip_dst;
321 flow->pkt_mark = tnl_port->match.pkt_mark;
323 if (!cfg->out_key_flow) {
324 flow->tunnel.tun_id = cfg->out_key;
327 if (cfg->ttl_inherit && is_ip_any(flow)) {
328 wc->masks.nw_ttl = 0xff;
329 flow->tunnel.ip_ttl = flow->nw_ttl;
331 flow->tunnel.ip_ttl = cfg->ttl;
334 if (cfg->tos_inherit && is_ip_any(flow)) {
335 wc->masks.nw_tos = 0xff;
336 flow->tunnel.ip_tos = flow->nw_tos & IP_DSCP_MASK;
338 flow->tunnel.ip_tos = cfg->tos;
341 /* ECN fields are always inherited. */
342 if (is_ip_any(flow)) {
343 wc->masks.nw_tos |= IP_ECN_MASK;
346 if ((flow->nw_tos & IP_ECN_MASK) == IP_ECN_CE) {
347 flow->tunnel.ip_tos |= IP_ECN_ECT_0;
349 flow->tunnel.ip_tos |= flow->nw_tos & IP_ECN_MASK;
352 flow->tunnel.flags = (cfg->dont_fragment ? FLOW_TNL_F_DONT_FRAGMENT : 0)
353 | (cfg->csum ? FLOW_TNL_F_CSUM : 0)
354 | (cfg->out_key_present ? FLOW_TNL_F_KEY : 0);
357 char *post_flow_str = flow_to_string(flow);
358 char *tnl_str = tnl_port_fmt(tnl_port);
359 VLOG_DBG("flow sent\n"
363 tnl_str, pre_flow_str, post_flow_str);
370 ovs_rwlock_unlock(&rwlock);
375 tnl_hash(struct tnl_match *match)
377 BUILD_ASSERT_DECL(sizeof *match % sizeof(uint32_t) == 0);
378 return hash_words((uint32_t *) match, sizeof *match / sizeof(uint32_t), 0);
381 static struct tnl_port *
382 tnl_find_ofport(const struct ofport_dpif *ofport) OVS_REQ_RDLOCK(rwlock)
384 struct tnl_port *tnl_port;
386 HMAP_FOR_EACH_IN_BUCKET (tnl_port, ofport_node, hash_pointer(ofport, 0),
388 if (tnl_port->ofport == ofport) {
395 static struct tnl_port *
396 tnl_find_exact(struct tnl_match *match) OVS_REQ_RDLOCK(rwlock)
398 struct tnl_port *tnl_port;
400 HMAP_FOR_EACH_WITH_HASH (tnl_port, match_node, tnl_hash(match),
402 if (!memcmp(match, &tnl_port->match, sizeof *match)) {
409 /* Returns the tnl_port that is the best match for the tunnel data in 'flow',
410 * or NULL if no tnl_port matches 'flow'. */
411 static struct tnl_port *
412 tnl_find(const struct flow *flow) OVS_REQ_RDLOCK(rwlock)
415 IP_SRC_CFG, /* ip_src must equal configured address. */
416 IP_SRC_ANY, /* Any ip_src is acceptable. */
417 IP_SRC_FLOW /* ip_src is handled in flow table. */
420 struct tnl_match_pattern {
423 enum ip_src_type ip_src;
426 static const struct tnl_match_pattern patterns[] = {
427 { false, false, IP_SRC_CFG }, /* remote_ip, local_ip, in_key. */
428 { false, false, IP_SRC_ANY }, /* remote_ip, in_key. */
429 { true, false, IP_SRC_CFG }, /* remote_ip, local_ip. */
430 { true, false, IP_SRC_ANY }, /* remote_ip. */
431 { true, true, IP_SRC_ANY }, /* Flow-based remote. */
432 { true, true, IP_SRC_FLOW }, /* Flow-based everything. */
435 const struct tnl_match_pattern *p;
436 struct tnl_match match;
438 memset(&match, 0, sizeof match);
439 match.odp_port = flow->in_port.odp_port;
440 match.pkt_mark = flow->pkt_mark;
442 for (p = patterns; p < &patterns[ARRAY_SIZE(patterns)]; p++) {
443 struct tnl_port *tnl_port;
445 match.in_key_flow = p->in_key_flow;
446 match.in_key = p->in_key_flow ? 0 : flow->tunnel.tun_id;
448 match.ip_dst_flow = p->ip_dst_flow;
449 match.ip_dst = p->ip_dst_flow ? 0 : flow->tunnel.ip_src;
451 match.ip_src_flow = p->ip_src == IP_SRC_FLOW;
452 match.ip_src = p->ip_src == IP_SRC_CFG ? flow->tunnel.ip_dst : 0;
454 tnl_port = tnl_find_exact(&match);
464 tnl_match_fmt(const struct tnl_match *match, struct ds *ds)
465 OVS_REQ_RDLOCK(rwlock)
467 if (!match->ip_dst_flow) {
468 ds_put_format(ds, IP_FMT"->"IP_FMT, IP_ARGS(match->ip_src),
469 IP_ARGS(match->ip_dst));
470 } else if (!match->ip_src_flow) {
471 ds_put_format(ds, IP_FMT"->flow", IP_ARGS(match->ip_src));
473 ds_put_cstr(ds, "flow->flow");
476 if (match->in_key_flow) {
477 ds_put_cstr(ds, ", key=flow");
479 ds_put_format(ds, ", key=%#"PRIx64, ntohll(match->in_key));
482 ds_put_format(ds, ", dp port=%"PRIu32, match->odp_port);
483 ds_put_format(ds, ", pkt mark=%"PRIu32, match->pkt_mark);
487 tnl_port_mod_log(const struct tnl_port *tnl_port, const char *action)
488 OVS_REQ_RDLOCK(rwlock)
490 if (VLOG_IS_DBG_ENABLED()) {
491 struct ds ds = DS_EMPTY_INITIALIZER;
493 tnl_match_fmt(&tnl_port->match, &ds);
494 VLOG_INFO("%s tunnel port %s (%s)", action,
495 tnl_port_get_name(tnl_port), ds_cstr(&ds));
501 tnl_port_fmt(const struct tnl_port *tnl_port) OVS_REQ_RDLOCK(rwlock)
503 const struct netdev_tunnel_config *cfg =
504 netdev_get_tunnel_config(tnl_port->netdev);
505 struct ds ds = DS_EMPTY_INITIALIZER;
507 ds_put_format(&ds, "port %"PRIu32": %s (%s: ", tnl_port->match.odp_port,
508 tnl_port_get_name(tnl_port),
509 netdev_get_type(tnl_port->netdev));
510 tnl_match_fmt(&tnl_port->match, &ds);
512 if (cfg->out_key != cfg->in_key ||
513 cfg->out_key_present != cfg->in_key_present ||
514 cfg->out_key_flow != cfg->in_key_flow) {
515 ds_put_cstr(&ds, ", out_key=");
516 if (!cfg->out_key_present) {
517 ds_put_cstr(&ds, "none");
518 } else if (cfg->out_key_flow) {
519 ds_put_cstr(&ds, "flow");
521 ds_put_format(&ds, "%#"PRIx64, ntohll(cfg->out_key));
525 if (cfg->ttl_inherit) {
526 ds_put_cstr(&ds, ", ttl=inherit");
528 ds_put_format(&ds, ", ttl=%"PRIu8, cfg->ttl);
531 if (cfg->tos_inherit) {
532 ds_put_cstr(&ds, ", tos=inherit");
533 } else if (cfg->tos) {
534 ds_put_format(&ds, ", tos=%#"PRIx8, cfg->tos);
537 if (!cfg->dont_fragment) {
538 ds_put_cstr(&ds, ", df=false");
542 ds_put_cstr(&ds, ", csum=true");
545 ds_put_cstr(&ds, ")\n");
547 return ds_steal_cstr(&ds);
551 tnl_port_get_name(const struct tnl_port *tnl_port) OVS_REQ_RDLOCK(rwlock)
553 return netdev_get_name(tnl_port->netdev);