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 "dynamic-string.h"
28 #include "socket-util.h"
32 VLOG_DEFINE_THIS_MODULE(tunnel);
46 struct hmap_node ofport_node;
47 struct hmap_node match_node;
49 const struct ofport_dpif *ofport;
50 unsigned int netdev_seq;
51 struct netdev *netdev;
53 struct tnl_match match;
56 static struct hmap tnl_match_map = HMAP_INITIALIZER(&tnl_match_map);
57 static struct hmap ofport_map = HMAP_INITIALIZER(&ofport_map);
59 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
60 static struct vlog_rate_limit dbg_rl = VLOG_RATE_LIMIT_INIT(60, 60);
62 static struct tnl_port *tnl_find(struct tnl_match *);
63 static struct tnl_port *tnl_find_exact(struct tnl_match *);
64 static struct tnl_port *tnl_find_ofport(const struct ofport_dpif *);
66 static uint32_t tnl_hash(struct tnl_match *);
67 static void tnl_match_fmt(const struct tnl_match *, struct ds *);
68 static char *tnl_port_fmt(const struct tnl_port *);
69 static void tnl_port_mod_log(const struct tnl_port *, const char *action);
70 static const char *tnl_port_get_name(const struct tnl_port *);
73 tnl_port_add__(const struct ofport_dpif *ofport, const struct netdev *netdev,
74 odp_port_t odp_port, bool warn)
76 const struct netdev_tunnel_config *cfg;
77 struct tnl_port *existing_port;
78 struct tnl_port *tnl_port;
80 cfg = netdev_get_tunnel_config(netdev);
83 tnl_port = xzalloc(sizeof *tnl_port);
84 tnl_port->ofport = ofport;
85 tnl_port->netdev = netdev_ref(netdev);
86 tnl_port->netdev_seq = netdev_change_seq(tnl_port->netdev);
88 tnl_port->match.in_key = cfg->in_key;
89 tnl_port->match.ip_src = cfg->ip_src;
90 tnl_port->match.ip_dst = cfg->ip_dst;
91 tnl_port->match.ip_src_flow = cfg->ip_src_flow;
92 tnl_port->match.ip_dst_flow = cfg->ip_dst_flow;
93 tnl_port->match.skb_mark = cfg->ipsec ? IPSEC_MARK : 0;
94 tnl_port->match.in_key_flow = cfg->in_key_flow;
95 tnl_port->match.odp_port = odp_port;
97 existing_port = tnl_find_exact(&tnl_port->match);
100 struct ds ds = DS_EMPTY_INITIALIZER;
101 tnl_match_fmt(&tnl_port->match, &ds);
102 VLOG_WARN("%s: attempting to add tunnel port with same config as "
103 "port '%s' (%s)", tnl_port_get_name(tnl_port),
104 tnl_port_get_name(existing_port), ds_cstr(&ds));
111 hmap_insert(&ofport_map, &tnl_port->ofport_node, hash_pointer(ofport, 0));
112 hmap_insert(&tnl_match_map, &tnl_port->match_node,
113 tnl_hash(&tnl_port->match));
114 tnl_port_mod_log(tnl_port, "adding");
118 /* Adds 'ofport' to the module with datapath port number 'odp_port'. 'ofport's
119 * must be added before they can be used by the module. 'ofport' must be a
122 tnl_port_add(const struct ofport_dpif *ofport, const struct netdev *netdev,
125 tnl_port_add__(ofport, netdev, odp_port, true);
128 /* Checks if the tunnel represented by 'ofport' reconfiguration due to changes
129 * in its netdev_tunnel_config. If it does, returns true. Otherwise, returns
130 * false. 'ofport' and 'odp_port' should be the same as would be passed to
133 tnl_port_reconfigure(const struct ofport_dpif *ofport,
134 const struct netdev *netdev, odp_port_t odp_port)
136 struct tnl_port *tnl_port = tnl_find_ofport(ofport);
139 return tnl_port_add__(ofport, netdev, odp_port, false);
140 } else if (tnl_port->netdev != netdev
141 || tnl_port->match.odp_port != odp_port
142 || tnl_port->netdev_seq != netdev_change_seq(netdev)) {
143 VLOG_DBG("reconfiguring %s", tnl_port_get_name(tnl_port));
144 tnl_port_del(ofport);
145 tnl_port_add(ofport, netdev, odp_port);
151 /* Removes 'ofport' from the module. */
153 tnl_port_del(const struct ofport_dpif *ofport)
155 struct tnl_port *tnl_port = ofport ? tnl_find_ofport(ofport) : NULL;
158 tnl_port_mod_log(tnl_port, "removing");
159 hmap_remove(&tnl_match_map, &tnl_port->match_node);
160 hmap_remove(&ofport_map, &tnl_port->ofport_node);
161 netdev_close(tnl_port->netdev);
166 /* Looks in the table of tunnels for a tunnel matching the metadata in 'flow'.
167 * Returns the 'ofport' corresponding to the new in_port, or a null pointer if
170 * Callers should verify that 'flow' needs to be received by calling
171 * tnl_port_should_receive() before this function. */
172 const struct ofport_dpif *
173 tnl_port_receive(const struct flow *flow)
175 char *pre_flow_str = NULL;
176 struct tnl_port *tnl_port;
177 struct tnl_match match;
179 memset(&match, 0, sizeof match);
180 match.odp_port = flow->in_port.odp_port;
181 match.ip_src = flow->tunnel.ip_dst;
182 match.ip_dst = flow->tunnel.ip_src;
183 match.in_key = flow->tunnel.tun_id;
184 match.skb_mark = flow->skb_mark;
186 tnl_port = tnl_find(&match);
188 struct ds ds = DS_EMPTY_INITIALIZER;
190 tnl_match_fmt(&match, &ds);
191 VLOG_WARN_RL(&rl, "receive tunnel port not found (%s)", ds_cstr(&ds));
196 if (!VLOG_DROP_DBG(&dbg_rl)) {
197 pre_flow_str = flow_to_string(flow);
201 char *post_flow_str = flow_to_string(flow);
202 char *tnl_str = tnl_port_fmt(tnl_port);
203 VLOG_DBG("flow received\n"
207 tnl_str, pre_flow_str, post_flow_str);
212 return tnl_port->ofport;
215 /* Given that 'flow' should be output to the ofport corresponding to
216 * 'tnl_port', updates 'flow''s tunnel headers and returns the actual datapath
217 * port that the output should happen on. May return ODPP_NONE if the output
218 * shouldn't occur. */
220 tnl_port_send(const struct ofport_dpif *ofport, struct flow *flow,
221 struct flow_wildcards *wc)
223 struct tnl_port *tnl_port = tnl_find_ofport(ofport);
224 const struct netdev_tunnel_config *cfg;
225 char *pre_flow_str = NULL;
231 cfg = netdev_get_tunnel_config(tnl_port->netdev);
234 if (!VLOG_DROP_DBG(&dbg_rl)) {
235 pre_flow_str = flow_to_string(flow);
238 if (!cfg->ip_src_flow) {
239 flow->tunnel.ip_src = tnl_port->match.ip_src;
241 if (!cfg->ip_dst_flow) {
242 flow->tunnel.ip_dst = tnl_port->match.ip_dst;
244 flow->skb_mark = tnl_port->match.skb_mark;
246 if (!cfg->out_key_flow) {
247 flow->tunnel.tun_id = cfg->out_key;
250 if (cfg->ttl_inherit && is_ip_any(flow)) {
251 wc->masks.nw_ttl = 0xff;
252 flow->tunnel.ip_ttl = flow->nw_ttl;
254 flow->tunnel.ip_ttl = cfg->ttl;
257 if (cfg->tos_inherit && is_ip_any(flow)) {
258 wc->masks.nw_tos = 0xff;
259 flow->tunnel.ip_tos = flow->nw_tos & IP_DSCP_MASK;
261 flow->tunnel.ip_tos = cfg->tos;
264 /* ECN fields are always inherited. */
265 if (is_ip_any(flow)) {
266 wc->masks.nw_tos |= IP_ECN_MASK;
269 if ((flow->nw_tos & IP_ECN_MASK) == IP_ECN_CE) {
270 flow->tunnel.ip_tos |= IP_ECN_ECT_0;
272 flow->tunnel.ip_tos |= flow->nw_tos & IP_ECN_MASK;
275 flow->tunnel.flags = (cfg->dont_fragment ? FLOW_TNL_F_DONT_FRAGMENT : 0)
276 | (cfg->csum ? FLOW_TNL_F_CSUM : 0)
277 | (cfg->out_key_present ? FLOW_TNL_F_KEY : 0);
280 char *post_flow_str = flow_to_string(flow);
281 char *tnl_str = tnl_port_fmt(tnl_port);
282 VLOG_DBG("flow sent\n"
286 tnl_str, pre_flow_str, post_flow_str);
292 return tnl_port->match.odp_port;
296 tnl_hash(struct tnl_match *match)
298 BUILD_ASSERT_DECL(sizeof *match % sizeof(uint32_t) == 0);
299 return hash_words((uint32_t *) match, sizeof *match / sizeof(uint32_t), 0);
302 static struct tnl_port *
303 tnl_find_ofport(const struct ofport_dpif *ofport)
305 struct tnl_port *tnl_port;
307 HMAP_FOR_EACH_IN_BUCKET (tnl_port, ofport_node, hash_pointer(ofport, 0),
309 if (tnl_port->ofport == ofport) {
316 static struct tnl_port *
317 tnl_find_exact(struct tnl_match *match)
319 struct tnl_port *tnl_port;
321 HMAP_FOR_EACH_WITH_HASH (tnl_port, match_node, tnl_hash(match),
323 if (!memcmp(match, &tnl_port->match, sizeof *match)) {
330 static struct tnl_port *
331 tnl_find(struct tnl_match *match_)
333 struct tnl_match match = *match_;
334 struct tnl_port *tnl_port;
336 /* remote_ip, local_ip, in_key */
337 tnl_port = tnl_find_exact(&match);
342 /* remote_ip, in_key */
344 tnl_port = tnl_find_exact(&match);
348 match.ip_src = match_->ip_src;
350 /* remote_ip, local_ip */
352 match.in_key_flow = true;
353 tnl_port = tnl_find_exact(&match);
360 tnl_port = tnl_find_exact(&match);
365 /* Flow-based remote */
367 match.ip_dst_flow = true;
368 tnl_port = tnl_find_exact(&match);
373 /* Flow-based everything */
375 match.ip_src_flow = true;
376 tnl_port = tnl_find_exact(&match);
385 tnl_match_fmt(const struct tnl_match *match, struct ds *ds)
387 if (!match->ip_dst_flow) {
388 ds_put_format(ds, IP_FMT"->"IP_FMT, IP_ARGS(match->ip_src),
389 IP_ARGS(match->ip_dst));
390 } else if (!match->ip_src_flow) {
391 ds_put_format(ds, IP_FMT"->flow", IP_ARGS(match->ip_src));
393 ds_put_cstr(ds, "flow->flow");
396 if (match->in_key_flow) {
397 ds_put_cstr(ds, ", key=flow");
399 ds_put_format(ds, ", key=%#"PRIx64, ntohll(match->in_key));
402 ds_put_format(ds, ", dp port=%"PRIu32, match->odp_port);
403 ds_put_format(ds, ", skb mark=%"PRIu32, match->skb_mark);
407 tnl_port_mod_log(const struct tnl_port *tnl_port, const char *action)
409 if (VLOG_IS_DBG_ENABLED()) {
410 struct ds ds = DS_EMPTY_INITIALIZER;
412 tnl_match_fmt(&tnl_port->match, &ds);
413 VLOG_INFO("%s tunnel port %s (%s)", action,
414 tnl_port_get_name(tnl_port), ds_cstr(&ds));
420 tnl_port_fmt(const struct tnl_port *tnl_port)
422 const struct netdev_tunnel_config *cfg =
423 netdev_get_tunnel_config(tnl_port->netdev);
424 struct ds ds = DS_EMPTY_INITIALIZER;
426 ds_put_format(&ds, "port %"PRIu32": %s (%s: ", tnl_port->match.odp_port,
427 tnl_port_get_name(tnl_port),
428 netdev_get_type(tnl_port->netdev));
429 tnl_match_fmt(&tnl_port->match, &ds);
431 if (cfg->out_key != cfg->in_key ||
432 cfg->out_key_present != cfg->in_key_present ||
433 cfg->out_key_flow != cfg->in_key_flow) {
434 ds_put_cstr(&ds, ", out_key=");
435 if (!cfg->out_key_present) {
436 ds_put_cstr(&ds, "none");
437 } else if (cfg->out_key_flow) {
438 ds_put_cstr(&ds, "flow");
440 ds_put_format(&ds, "%#"PRIx64, ntohll(cfg->out_key));
444 if (cfg->ttl_inherit) {
445 ds_put_cstr(&ds, ", ttl=inherit");
447 ds_put_format(&ds, ", ttl=%"PRIu8, cfg->ttl);
450 if (cfg->tos_inherit) {
451 ds_put_cstr(&ds, ", tos=inherit");
452 } else if (cfg->tos) {
453 ds_put_format(&ds, ", tos=%#"PRIx8, cfg->tos);
456 if (!cfg->dont_fragment) {
457 ds_put_cstr(&ds, ", df=false");
461 ds_put_cstr(&ds, ", csum=true");
464 ds_put_cstr(&ds, ")\n");
466 return ds_steal_cstr(&ds);
470 tnl_port_get_name(const struct tnl_port *tnl_port)
472 return netdev_get_name(tnl_port->netdev);