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 * IPsec using skb mark.
39 * Multicast group management (possibly).
40 * Disallow netdevs with names like "gre64_system" to prevent collisions. */
42 VLOG_DEFINE_THIS_MODULE(tunnel);
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.in_key_present = cfg->in_key_present;
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.in_key_present = flow->tunnel.flags & FLOW_TNL_F_KEY;
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));
201 && ((flow->tunnel.ip_tos & IP_ECN_MASK) == IP_ECN_CE)
202 && (flow->nw_tos & IP_ECN_MASK) == IP_ECN_NOT_ECT) {
203 VLOG_WARN_RL(&rl, "dropping tunnel packet marked ECN CE but is not ECN"
208 if (!VLOG_DROP_DBG(&dbg_rl)) {
209 pre_flow_str = flow_to_string(flow);
212 flow->in_port = tnl_port->ofport->ofp_port;
213 memset(&flow->tunnel, 0, sizeof flow->tunnel);
214 flow->tunnel.tun_id = match.in_key;
217 char *post_flow_str = flow_to_string(flow);
218 char *tnl_str = tnl_port_fmt(tnl_port);
219 VLOG_DBG("flow received\n"
223 tnl_str, pre_flow_str, post_flow_str);
228 return tnl_port->ofport;
231 /* Given that 'flow' should be output to the ofport corresponding to
232 * 'tnl_port', updates 'flow''s tunnel headers and returns the actual datapath
233 * port that the output should happen on. May return OVSP_NONE if the output
234 * shouldn't occur. */
236 tnl_port_send(const struct tnl_port *tnl_port, struct flow *flow)
238 const struct netdev_tunnel_config *cfg;
239 char *pre_flow_str = NULL;
241 if (tnl_port == &void_tnl_port) {
245 cfg = netdev_get_tunnel_config(tnl_port->ofport->netdev);
248 if (!VLOG_DROP_DBG(&dbg_rl)) {
249 pre_flow_str = flow_to_string(flow);
252 flow->tunnel.ip_src = tnl_port->match.ip_src;
253 flow->tunnel.ip_dst = tnl_port->match.ip_dst;
255 if (!cfg->out_key_flow) {
256 flow->tunnel.tun_id = cfg->out_key;
259 if (cfg->ttl_inherit && is_ip_any(flow)) {
260 flow->tunnel.ip_ttl = flow->nw_ttl;
262 flow->tunnel.ip_ttl = cfg->ttl;
265 if (cfg->tos_inherit && is_ip_any(flow)) {
266 flow->tunnel.ip_tos = flow->nw_tos & IP_DSCP_MASK;
268 flow->tunnel.ip_tos = cfg->tos;
271 if ((flow->nw_tos & IP_ECN_MASK) == IP_ECN_CE) {
272 flow->tunnel.ip_tos |= IP_ECN_ECT_0;
274 flow->tunnel.ip_tos |= flow->nw_tos & IP_ECN_MASK;
277 flow->tunnel.flags = (cfg->dont_fragment ? FLOW_TNL_F_DONT_FRAGMENT : 0)
278 | (cfg->csum ? FLOW_TNL_F_CSUM : 0)
279 | (cfg->out_key_present ? FLOW_TNL_F_KEY : 0);
282 char *post_flow_str = flow_to_string(flow);
283 char *tnl_str = tnl_port_fmt(tnl_port);
284 VLOG_DBG("flow sent\n"
288 tnl_str, pre_flow_str, post_flow_str);
294 return tnl_port->match.odp_port;
298 tnl_hash(struct tnl_match *match)
300 BUILD_ASSERT_DECL(sizeof *match % sizeof(uint32_t) == 0);
301 return hash_words((uint32_t *) match, sizeof *match / sizeof(uint32_t), 0);
304 static struct tnl_port *
305 tnl_find_exact(struct tnl_match *match)
307 struct tnl_port *tnl_port;
309 HMAP_FOR_EACH_WITH_HASH (tnl_port, match_node, tnl_hash(match),
311 if (!memcmp(match, &tnl_port->match, sizeof *match)) {
318 static struct tnl_port *
319 tnl_find(struct tnl_match *match_)
321 struct tnl_match match = *match_;
322 bool is_multicast = ip_is_multicast(match.ip_src);
323 struct tnl_port *tnl_port;
325 /* remote_ip, local_ip, in_key */
327 tnl_port = tnl_find_exact(&match);
333 /* remote_ip, in_key */
335 tnl_port = tnl_find_exact(&match);
339 match.ip_src = match_->ip_src;
341 /* remote_ip, local_ip */
344 match.in_key_flow = true;
345 tnl_port = tnl_find_exact(&match);
349 match.in_key = match_->in_key;
350 match.in_key_flow = false;
356 match.in_key_flow = true;
357 tnl_port = tnl_find_exact(&match);
361 match.ip_src = match_->ip_src;
362 match.in_key = match_->in_key;
363 match.in_key_flow = false;
367 match.ip_dst = match_->ip_src;
369 /* multicast remote_ip, in_key */
370 tnl_port = tnl_find_exact(&match);
375 /* multicast remote_ip */
377 match.in_key_flow = true;
378 tnl_port = tnl_find_exact(&match);
387 tnl_match_fmt(const struct tnl_match *match, struct ds *ds)
389 ds_put_format(ds, IP_FMT"->"IP_FMT, IP_ARGS(match->ip_src),
390 IP_ARGS(match->ip_dst));
392 if (match->in_key_present) {
393 if (match->in_key_flow) {
394 ds_put_cstr(ds, ", key=flow");
396 ds_put_format(ds, ", key=%#"PRIx64, ntohll(match->in_key));
400 ds_put_format(ds, ", dp port=%"PRIu32, match->odp_port);
404 tnl_port_mod_log(const struct tnl_port *tnl_port, const char *action)
406 if (VLOG_IS_DBG_ENABLED()) {
407 struct ds ds = DS_EMPTY_INITIALIZER;
409 tnl_match_fmt(&tnl_port->match, &ds);
410 VLOG_DBG("%s tunnel port %s (%s)", action, tnl_port_get_name(tnl_port),
417 tnl_port_fmt(const struct tnl_port *tnl_port)
419 const struct netdev_tunnel_config *cfg =
420 netdev_get_tunnel_config(tnl_port->ofport->netdev);
421 struct ds ds = DS_EMPTY_INITIALIZER;
423 ds_put_format(&ds, "port %"PRIu32": %s (%s: ", tnl_port->match.odp_port,
424 tnl_port_get_name(tnl_port),
425 netdev_get_type(tnl_port->ofport->netdev));
426 tnl_match_fmt(&tnl_port->match, &ds);
428 if (cfg->out_key != cfg->in_key ||
429 cfg->out_key_present != cfg->in_key_present ||
430 cfg->out_key_flow != cfg->in_key_flow) {
431 ds_put_cstr(&ds, ", out_key=");
432 if (!cfg->out_key_present) {
433 ds_put_cstr(&ds, "none");
434 } else if (cfg->out_key_flow) {
435 ds_put_cstr(&ds, "flow");
437 ds_put_format(&ds, "%#"PRIx64, ntohll(cfg->out_key));
441 if (cfg->ttl_inherit) {
442 ds_put_cstr(&ds, ", ttl=inherit");
444 ds_put_format(&ds, ", ttl=%"PRIu8, cfg->ttl);
447 if (cfg->tos_inherit) {
448 ds_put_cstr(&ds, ", tos=inherit");
449 } else if (cfg->tos) {
450 ds_put_format(&ds, ", tos=%#"PRIx8, cfg->tos);
453 if (!cfg->dont_fragment) {
454 ds_put_cstr(&ds, ", df=false");
458 ds_put_cstr(&ds, ", csum=true");
461 ds_put_cstr(&ds, ")\n");
463 return ds_steal_cstr(&ds);
467 tnl_port_get_name(const struct tnl_port *tnl_port)
469 return netdev_get_name(tnl_port->ofport->netdev);