ofproto/tunnel.c

   1 /* Copyright (c) 2013 Nicira, Inc.
   2  *
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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. */
  14
  15 #include <config.h>
  16 #include "tunnel.h"
  17
  18 #include <errno.h>
  19
  20 #include "ofproto/ofproto-provider.h"
  21 #include "byte-order.h"
  22 #include "dynamic-string.h"
  23 #include "hash.h"
  24 #include "hmap.h"
  25 #include "netdev-vport.h"
  26 #include "odp-util.h"
  27 #include "packets.h"
  28 #include "smap.h"
  29 #include "socket-util.h"
  30 #include "tunnel.h"
  31 #include "vlog.h"
  32
  33 VLOG_DEFINE_THIS_MODULE(tunnel);
  34
  35 struct tnl_match {
  36     ovs_be64 in_key;
  37     ovs_be32 ip_src;
  38     ovs_be32 ip_dst;
  39     odp_port_t odp_port;
  40     uint32_t skb_mark;
  41     bool in_key_flow;
  42     bool ip_src_flow;
  43     bool ip_dst_flow;
  44 };
  45
  46 struct tnl_port {
  47     struct hmap_node match_node;
  48
  49     const struct ofport *ofport;
  50     unsigned int netdev_seq;
  51     struct tnl_match match;
  52 };
  53
  54 static struct hmap tnl_match_map = HMAP_INITIALIZER(&tnl_match_map);
  55
  56 /* Returned to callers when their ofport will never be used to receive or send
  57  * tunnel traffic. Alternatively, we could ask the caller to delete their
  58  * ofport, but this would be unclean in the reconfguration case.  For the first
  59  * time, an ofproto provider would have to call ofproto_port_del() on itself.*/
  60 static struct tnl_port void_tnl_port;
  61
  62 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
  63 static struct vlog_rate_limit dbg_rl = VLOG_RATE_LIMIT_INIT(60, 60);
  64
  65 static struct tnl_port *tnl_find(struct tnl_match *);
  66 static struct tnl_port *tnl_find_exact(struct tnl_match *);
  67 static uint32_t tnl_hash(struct tnl_match *);
  68 static void tnl_match_fmt(const struct tnl_match *, struct ds *);
  69 static char *tnl_port_fmt(const struct tnl_port *);
  70 static void tnl_port_mod_log(const struct tnl_port *, const char *action);
  71 static const char *tnl_port_get_name(const struct tnl_port *);
  72
  73 static struct tnl_port *
  74 tnl_port_add__(const struct ofport *ofport, odp_port_t odp_port,
  75                bool warn)
  76 {
  77     const struct netdev_tunnel_config *cfg;
  78     struct tnl_port *existing_port;
  79     struct tnl_port *tnl_port;
  80
  81     cfg = netdev_get_tunnel_config(ofport->netdev);
  82     ovs_assert(cfg);
  83
  84     tnl_port = xzalloc(sizeof *tnl_port);
  85     tnl_port->ofport = ofport;
  86     tnl_port->netdev_seq = netdev_change_seq(tnl_port->ofport->netdev);
  87
  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;
  96
  97     existing_port = tnl_find_exact(&tnl_port->match);
  98     if (existing_port) {
  99         if (warn) {
 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));
 105             ds_destroy(&ds);
 106             free(tnl_port);
 107         }
 108         return &void_tnl_port;
 109     }
 110
 111     hmap_insert(&tnl_match_map, &tnl_port->match_node,
 112                 tnl_hash(&tnl_port->match));
 113     tnl_port_mod_log(tnl_port, "adding");
 114     return tnl_port;
 115 }
 116
 117 /* Adds 'ofport' to the module with datapath port number 'odp_port'. 'ofport's
 118  * must be added before they can be used by the module. 'ofport' must be a
 119  * tunnel. */
 120 struct tnl_port *
 121 tnl_port_add(const struct ofport *ofport, odp_port_t odp_port)
 122 {
 123     return tnl_port_add__(ofport, odp_port, true);
 124 }
 125
 126 /* Checks if the tnl_port pointed to by 'tnl_portp' needs reconfiguration due
 127  * to changes in its netdev_tunnel_config.  If it does, updates 'tnl_portp' to
 128  * point to a new tnl_port and returns true.  Otherwise, returns false.
 129  * 'ofport' and 'odp_port' should be the same as would be passed to
 130  * tnl_port_add(). */
 131 bool
 132 tnl_port_reconfigure(const struct ofport *ofport, odp_port_t odp_port,
 133                      struct tnl_port **tnl_portp)
 134 {
 135     struct tnl_port *tnl_port = *tnl_portp;
 136
 137     if (tnl_port == &void_tnl_port) {
 138         *tnl_portp = tnl_port_add__(ofport, odp_port, false);
 139         return *tnl_portp != &void_tnl_port;
 140     } else if (tnl_port->ofport != ofport
 141                || tnl_port->match.odp_port != odp_port
 142                || tnl_port->netdev_seq != netdev_change_seq(ofport->netdev)) {
 143         VLOG_DBG("reconfiguring %s", tnl_port_get_name(tnl_port));
 144         tnl_port_del(tnl_port);
 145         *tnl_portp = tnl_port_add(ofport, odp_port);
 146         return true;
 147     }
 148     return false;
 149 }
 150
 151 /* Removes 'tnl_port' from the module. */
 152 void
 153 tnl_port_del(struct tnl_port *tnl_port)
 154 {
 155     if (tnl_port && tnl_port != &void_tnl_port) {
 156         tnl_port_mod_log(tnl_port, "removing");
 157         hmap_remove(&tnl_match_map, &tnl_port->match_node);
 158         free(tnl_port);
 159     }
 160 }
 161
 162 /* Looks in the table of tunnels for a tunnel matching the metadata in 'flow'.
 163  * Returns the 'ofport' corresponding to the new in_port, or a null pointer if
 164  * none is found.
 165  *
 166  * Callers should verify that 'flow' needs to be received by calling
 167  * tnl_port_should_receive() before this function. */
 168 const struct ofport *
 169 tnl_port_receive(const struct flow *flow)
 170 {
 171     char *pre_flow_str = NULL;
 172     struct tnl_port *tnl_port;
 173     struct tnl_match match;
 174
 175     memset(&match, 0, sizeof match);
 176     match.odp_port = flow->in_port.odp_port;
 177     match.ip_src = flow->tunnel.ip_dst;
 178     match.ip_dst = flow->tunnel.ip_src;
 179     match.in_key = flow->tunnel.tun_id;
 180     match.skb_mark = flow->skb_mark;
 181
 182     tnl_port = tnl_find(&match);
 183     if (!tnl_port) {
 184         struct ds ds = DS_EMPTY_INITIALIZER;
 185
 186         tnl_match_fmt(&match, &ds);
 187         VLOG_WARN_RL(&rl, "receive tunnel port not found (%s)", ds_cstr(&ds));
 188         ds_destroy(&ds);
 189         return NULL;
 190     }
 191
 192     if (!VLOG_DROP_DBG(&dbg_rl)) {
 193         pre_flow_str = flow_to_string(flow);
 194     }
 195
 196     if (pre_flow_str) {
 197         char *post_flow_str = flow_to_string(flow);
 198         char *tnl_str = tnl_port_fmt(tnl_port);
 199         VLOG_DBG("flow received\n"
 200                  "%s"
 201                  " pre: %s\n"
 202                  "post: %s",
 203                  tnl_str, pre_flow_str, post_flow_str);
 204         free(tnl_str);
 205         free(pre_flow_str);
 206         free(post_flow_str);
 207     }
 208     return tnl_port->ofport;
 209 }
 210
 211 /* Given that 'flow' should be output to the ofport corresponding to
 212  * 'tnl_port', updates 'flow''s tunnel headers and returns the actual datapath
 213  * port that the output should happen on.  May return ODPP_NONE if the output
 214  * shouldn't occur. */
 215 odp_port_t
 216 tnl_port_send(const struct tnl_port *tnl_port, struct flow *flow,
 217               struct flow_wildcards *wc)
 218 {
 219     const struct netdev_tunnel_config *cfg;
 220     char *pre_flow_str = NULL;
 221
 222     if (tnl_port == &void_tnl_port) {
 223         return ODPP_NONE;
 224     }
 225
 226     cfg = netdev_get_tunnel_config(tnl_port->ofport->netdev);
 227     ovs_assert(cfg);
 228
 229     if (!VLOG_DROP_DBG(&dbg_rl)) {
 230         pre_flow_str = flow_to_string(flow);
 231     }
 232
 233     if (!cfg->ip_src_flow) {
 234         flow->tunnel.ip_src = tnl_port->match.ip_src;
 235     }
 236     if (!cfg->ip_dst_flow) {
 237         flow->tunnel.ip_dst = tnl_port->match.ip_dst;
 238     }
 239     flow->skb_mark = tnl_port->match.skb_mark;
 240
 241     if (!cfg->out_key_flow) {
 242         flow->tunnel.tun_id = cfg->out_key;
 243     }
 244
 245     if (cfg->ttl_inherit && is_ip_any(flow)) {
 246         wc->masks.nw_ttl = 0xff;
 247         flow->tunnel.ip_ttl = flow->nw_ttl;
 248     } else {
 249         flow->tunnel.ip_ttl = cfg->ttl;
 250     }
 251
 252     if (cfg->tos_inherit && is_ip_any(flow)) {
 253         wc->masks.nw_tos = 0xff;
 254         flow->tunnel.ip_tos = flow->nw_tos & IP_DSCP_MASK;
 255     } else {
 256         flow->tunnel.ip_tos = cfg->tos;
 257     }
 258
 259     /* ECN fields are always inherited. */
 260     if (is_ip_any(flow)) {
 261         wc->masks.nw_tos |= IP_ECN_MASK;
 262     }
 263
 264     if ((flow->nw_tos & IP_ECN_MASK) == IP_ECN_CE) {
 265         flow->tunnel.ip_tos |= IP_ECN_ECT_0;
 266     } else {
 267         flow->tunnel.ip_tos |= flow->nw_tos & IP_ECN_MASK;
 268     }
 269
 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);
 273
 274     if (pre_flow_str) {
 275         char *post_flow_str = flow_to_string(flow);
 276         char *tnl_str = tnl_port_fmt(tnl_port);
 277         VLOG_DBG("flow sent\n"
 278                  "%s"
 279                  " pre: %s\n"
 280                  "post: %s",
 281                  tnl_str, pre_flow_str, post_flow_str);
 282         free(tnl_str);
 283         free(pre_flow_str);
 284         free(post_flow_str);
 285     }
 286
 287     return tnl_port->match.odp_port;
 288 }
 289
 290 static uint32_t
 291 tnl_hash(struct tnl_match *match)
 292 {
 293     BUILD_ASSERT_DECL(sizeof *match % sizeof(uint32_t) == 0);
 294     return hash_words((uint32_t *) match, sizeof *match / sizeof(uint32_t), 0);
 295 }
 296
 297 static struct tnl_port *
 298 tnl_find_exact(struct tnl_match *match)
 299 {
 300     struct tnl_port *tnl_port;
 301
 302     HMAP_FOR_EACH_WITH_HASH (tnl_port, match_node, tnl_hash(match),
 303                              &tnl_match_map) {
 304         if (!memcmp(match, &tnl_port->match, sizeof *match)) {
 305             return tnl_port;
 306         }
 307     }
 308     return NULL;
 309 }
 310
 311 static struct tnl_port *
 312 tnl_find(struct tnl_match *match_)
 313 {
 314     struct tnl_match match = *match_;
 315     struct tnl_port *tnl_port;
 316
 317     /* remote_ip, local_ip, in_key */
 318     tnl_port = tnl_find_exact(&match);
 319     if (tnl_port) {
 320         return tnl_port;
 321     }
 322
 323     /* remote_ip, in_key */
 324     match.ip_src = 0;
 325     tnl_port = tnl_find_exact(&match);
 326     if (tnl_port) {
 327         return tnl_port;
 328     }
 329     match.ip_src = match_->ip_src;
 330
 331     /* remote_ip, local_ip */
 332     match.in_key = 0;
 333     match.in_key_flow = true;
 334     tnl_port = tnl_find_exact(&match);
 335     if (tnl_port) {
 336         return tnl_port;
 337     }
 338
 339     /* remote_ip */
 340     match.ip_src = 0;
 341     tnl_port = tnl_find_exact(&match);
 342     if (tnl_port) {
 343         return tnl_port;
 344     }
 345
 346     /* Flow-based remote */
 347     match.ip_dst = 0;
 348     match.ip_dst_flow = true;
 349     tnl_port = tnl_find_exact(&match);
 350     if (tnl_port) {
 351         return tnl_port;
 352     }
 353
 354     /* Flow-based everything */
 355     match.ip_src = 0;
 356     match.ip_src_flow = true;
 357     tnl_port = tnl_find_exact(&match);
 358     if (tnl_port) {
 359         return tnl_port;
 360     }
 361
 362     return NULL;
 363 }
 364
 365 static void
 366 tnl_match_fmt(const struct tnl_match *match, struct ds *ds)
 367 {
 368     if (!match->ip_dst_flow) {
 369         ds_put_format(ds, IP_FMT"->"IP_FMT, IP_ARGS(match->ip_src),
 370                       IP_ARGS(match->ip_dst));
 371     } else if (!match->ip_src_flow) {
 372         ds_put_format(ds, IP_FMT"->flow", IP_ARGS(match->ip_src));
 373     } else {
 374         ds_put_cstr(ds, "flow->flow");
 375     }
 376
 377     if (match->in_key_flow) {
 378         ds_put_cstr(ds, ", key=flow");
 379     } else {
 380         ds_put_format(ds, ", key=%#"PRIx64, ntohll(match->in_key));
 381     }
 382
 383     ds_put_format(ds, ", dp port=%"PRIu32, match->odp_port);
 384     ds_put_format(ds, ", skb mark=%"PRIu32, match->skb_mark);
 385 }
 386
 387 static void
 388 tnl_port_mod_log(const struct tnl_port *tnl_port, const char *action)
 389 {
 390     if (VLOG_IS_DBG_ENABLED()) {
 391         struct ds ds = DS_EMPTY_INITIALIZER;
 392
 393         tnl_match_fmt(&tnl_port->match, &ds);
 394         VLOG_INFO("%s tunnel port %s (%s)", action,
 395                   tnl_port_get_name(tnl_port), ds_cstr(&ds));
 396         ds_destroy(&ds);
 397     }
 398 }
 399
 400 static char *
 401 tnl_port_fmt(const struct tnl_port *tnl_port)
 402 {
 403     const struct netdev_tunnel_config *cfg =
 404         netdev_get_tunnel_config(tnl_port->ofport->netdev);
 405     struct ds ds = DS_EMPTY_INITIALIZER;
 406
 407     ds_put_format(&ds, "port %"PRIu32": %s (%s: ", tnl_port->match.odp_port,
 408                   tnl_port_get_name(tnl_port),
 409                   netdev_get_type(tnl_port->ofport->netdev));
 410     tnl_match_fmt(&tnl_port->match, &ds);
 411
 412     if (cfg->out_key != cfg->in_key ||
 413         cfg->out_key_present != cfg->in_key_present ||
 414         cfg->out_key_flow != cfg->in_key_flow) {
 415         ds_put_cstr(&ds, ", out_key=");
 416         if (!cfg->out_key_present) {
 417             ds_put_cstr(&ds, "none");
 418         } else if (cfg->out_key_flow) {
 419             ds_put_cstr(&ds, "flow");
 420         } else {
 421             ds_put_format(&ds, "%#"PRIx64, ntohll(cfg->out_key));
 422         }
 423     }
 424
 425     if (cfg->ttl_inherit) {
 426         ds_put_cstr(&ds, ", ttl=inherit");
 427     } else {
 428         ds_put_format(&ds, ", ttl=%"PRIu8, cfg->ttl);
 429     }
 430
 431     if (cfg->tos_inherit) {
 432         ds_put_cstr(&ds, ", tos=inherit");
 433     } else if (cfg->tos) {
 434         ds_put_format(&ds, ", tos=%#"PRIx8, cfg->tos);
 435     }
 436
 437     if (!cfg->dont_fragment) {
 438         ds_put_cstr(&ds, ", df=false");
 439     }
 440
 441     if (cfg->csum) {
 442         ds_put_cstr(&ds, ", csum=true");
 443     }
 444
 445     ds_put_cstr(&ds, ")\n");
 446
 447     return ds_steal_cstr(&ds);
 448 }
 449
 450 static const char *
 451 tnl_port_get_name(const struct tnl_port *tnl_port)
 452 {
 453     return netdev_get_name(tnl_port->ofport->netdev);
 454 }