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 /* XXX:
  34  *
  35  * Disallow netdevs with names like "gre64_system" to prevent collisions. */
  36
  37 VLOG_DEFINE_THIS_MODULE(tunnel);
  38
  39 struct tnl_match {
  40     ovs_be64 in_key;
  41     ovs_be32 ip_src;
  42     ovs_be32 ip_dst;
  43     uint32_t odp_port;
  44     uint32_t skb_mark;
  45     bool in_key_flow;
  46 };
  47
  48 struct tnl_port {
  49     struct hmap_node match_node;
  50
  51     const struct ofport *ofport;
  52     unsigned int netdev_seq;
  53     struct tnl_match match;
  54 };
  55
  56 static struct hmap tnl_match_map = HMAP_INITIALIZER(&tnl_match_map);
  57
  58 /* Returned to callers when their ofport will never be used to receive or send
  59  * tunnel traffic. Alternatively, we could ask the caller to delete their
  60  * ofport, but this would be unclean in the reconfguration case.  For the first
  61  * time, an ofproto provider would have to call ofproto_port_del() on itself.*/
  62 static struct tnl_port void_tnl_port;
  63
  64 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
  65 static struct vlog_rate_limit dbg_rl = VLOG_RATE_LIMIT_INIT(60, 60);
  66
  67 static struct tnl_port *tnl_find(struct tnl_match *);
  68 static struct tnl_port *tnl_find_exact(struct tnl_match *);
  69 static uint32_t tnl_hash(struct tnl_match *);
  70 static void tnl_match_fmt(const struct tnl_match *, struct ds *);
  71 static char *tnl_port_fmt(const struct tnl_port *);
  72 static void tnl_port_mod_log(const struct tnl_port *, const char *action);
  73 static const char *tnl_port_get_name(const struct tnl_port *);
  74
  75 static struct tnl_port *
  76 tnl_port_add__(const struct ofport *ofport, uint32_t odp_port,
  77                bool warn)
  78 {
  79     const struct netdev_tunnel_config *cfg;
  80     struct tnl_port *existing_port;
  81     struct tnl_port *tnl_port;
  82
  83     cfg = netdev_get_tunnel_config(ofport->netdev);
  84     ovs_assert(cfg);
  85
  86     tnl_port = xzalloc(sizeof *tnl_port);
  87     tnl_port->ofport = ofport;
  88     tnl_port->netdev_seq = netdev_change_seq(tnl_port->ofport->netdev);
  89
  90     tnl_port->match.in_key = cfg->in_key;
  91     tnl_port->match.ip_src = cfg->ip_src;
  92     tnl_port->match.ip_dst = cfg->ip_dst;
  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, uint32_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, uint32_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;
 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 OVSP_NONE if the output
 214  * shouldn't occur. */
 215 uint32_t
 216 tnl_port_send(const struct tnl_port *tnl_port, struct flow *flow)
 217 {
 218     const struct netdev_tunnel_config *cfg;
 219     char *pre_flow_str = NULL;
 220
 221     if (tnl_port == &void_tnl_port) {
 222         return OVSP_NONE;
 223     }
 224
 225     cfg = netdev_get_tunnel_config(tnl_port->ofport->netdev);
 226     ovs_assert(cfg);
 227
 228     if (!VLOG_DROP_DBG(&dbg_rl)) {
 229         pre_flow_str = flow_to_string(flow);
 230     }
 231
 232     flow->tunnel.ip_src = tnl_port->match.ip_src;
 233     flow->tunnel.ip_dst = tnl_port->match.ip_dst;
 234     flow->skb_mark = tnl_port->match.skb_mark;
 235
 236     if (!cfg->out_key_flow) {
 237         flow->tunnel.tun_id = cfg->out_key;
 238     }
 239
 240     if (cfg->ttl_inherit && is_ip_any(flow)) {
 241         flow->tunnel.ip_ttl = flow->nw_ttl;
 242     } else {
 243         flow->tunnel.ip_ttl = cfg->ttl;
 244     }
 245
 246     if (cfg->tos_inherit && is_ip_any(flow)) {
 247         flow->tunnel.ip_tos = flow->nw_tos & IP_DSCP_MASK;
 248     } else {
 249         flow->tunnel.ip_tos = cfg->tos;
 250     }
 251
 252     if ((flow->nw_tos & IP_ECN_MASK) == IP_ECN_CE) {
 253         flow->tunnel.ip_tos |= IP_ECN_ECT_0;
 254     } else {
 255         flow->tunnel.ip_tos |= flow->nw_tos & IP_ECN_MASK;
 256     }
 257
 258     flow->tunnel.flags = (cfg->dont_fragment ? FLOW_TNL_F_DONT_FRAGMENT : 0)
 259         | (cfg->csum ? FLOW_TNL_F_CSUM : 0)
 260         | (cfg->out_key_present ? FLOW_TNL_F_KEY : 0);
 261
 262     if (pre_flow_str) {
 263         char *post_flow_str = flow_to_string(flow);
 264         char *tnl_str = tnl_port_fmt(tnl_port);
 265         VLOG_DBG("flow sent\n"
 266                  "%s"
 267                  " pre: %s\n"
 268                  "post: %s",
 269                  tnl_str, pre_flow_str, post_flow_str);
 270         free(tnl_str);
 271         free(pre_flow_str);
 272         free(post_flow_str);
 273     }
 274
 275     return tnl_port->match.odp_port;
 276 }
 277
 278 static uint32_t
 279 tnl_hash(struct tnl_match *match)
 280 {
 281     BUILD_ASSERT_DECL(sizeof *match % sizeof(uint32_t) == 0);
 282     return hash_words((uint32_t *) match, sizeof *match / sizeof(uint32_t), 0);
 283 }
 284
 285 static struct tnl_port *
 286 tnl_find_exact(struct tnl_match *match)
 287 {
 288     struct tnl_port *tnl_port;
 289
 290     HMAP_FOR_EACH_WITH_HASH (tnl_port, match_node, tnl_hash(match),
 291                              &tnl_match_map) {
 292         if (!memcmp(match, &tnl_port->match, sizeof *match)) {
 293             return tnl_port;
 294         }
 295     }
 296     return NULL;
 297 }
 298
 299 static struct tnl_port *
 300 tnl_find(struct tnl_match *match_)
 301 {
 302     struct tnl_match match = *match_;
 303     struct tnl_port *tnl_port;
 304
 305     /* remote_ip, local_ip, in_key */
 306     tnl_port = tnl_find_exact(&match);
 307     if (tnl_port) {
 308         return tnl_port;
 309     }
 310
 311     /* remote_ip, in_key */
 312     match.ip_src = 0;
 313     tnl_port = tnl_find_exact(&match);
 314     if (tnl_port) {
 315         return tnl_port;
 316     }
 317     match.ip_src = match_->ip_src;
 318
 319     /* remote_ip, local_ip */
 320     match.in_key = 0;
 321     match.in_key_flow = true;
 322     tnl_port = tnl_find_exact(&match);
 323     if (tnl_port) {
 324         return tnl_port;
 325     }
 326
 327     /* remote_ip */
 328     match.ip_src = 0;
 329     tnl_port = tnl_find_exact(&match);
 330     if (tnl_port) {
 331         return tnl_port;
 332     }
 333
 334     return NULL;
 335 }
 336
 337 static void
 338 tnl_match_fmt(const struct tnl_match *match, struct ds *ds)
 339 {
 340     ds_put_format(ds, IP_FMT"->"IP_FMT, IP_ARGS(match->ip_src),
 341                   IP_ARGS(match->ip_dst));
 342
 343     if (match->in_key_flow) {
 344         ds_put_cstr(ds, ", key=flow");
 345     } else {
 346         ds_put_format(ds, ", key=%#"PRIx64, ntohll(match->in_key));
 347     }
 348
 349     ds_put_format(ds, ", dp port=%"PRIu32, match->odp_port);
 350     ds_put_format(ds, ", skb mark=%"PRIu32, match->skb_mark);
 351 }
 352
 353 static void
 354 tnl_port_mod_log(const struct tnl_port *tnl_port, const char *action)
 355 {
 356     if (VLOG_IS_DBG_ENABLED()) {
 357         struct ds ds = DS_EMPTY_INITIALIZER;
 358
 359         tnl_match_fmt(&tnl_port->match, &ds);
 360         VLOG_INFO("%s tunnel port %s (%s)", action,
 361                   tnl_port_get_name(tnl_port), ds_cstr(&ds));
 362         ds_destroy(&ds);
 363     }
 364 }
 365
 366 static char *
 367 tnl_port_fmt(const struct tnl_port *tnl_port)
 368 {
 369     const struct netdev_tunnel_config *cfg =
 370         netdev_get_tunnel_config(tnl_port->ofport->netdev);
 371     struct ds ds = DS_EMPTY_INITIALIZER;
 372
 373     ds_put_format(&ds, "port %"PRIu32": %s (%s: ", tnl_port->match.odp_port,
 374                   tnl_port_get_name(tnl_port),
 375                   netdev_get_type(tnl_port->ofport->netdev));
 376     tnl_match_fmt(&tnl_port->match, &ds);
 377
 378     if (cfg->out_key != cfg->in_key ||
 379         cfg->out_key_present != cfg->in_key_present ||
 380         cfg->out_key_flow != cfg->in_key_flow) {
 381         ds_put_cstr(&ds, ", out_key=");
 382         if (!cfg->out_key_present) {
 383             ds_put_cstr(&ds, "none");
 384         } else if (cfg->out_key_flow) {
 385             ds_put_cstr(&ds, "flow");
 386         } else {
 387             ds_put_format(&ds, "%#"PRIx64, ntohll(cfg->out_key));
 388         }
 389     }
 390
 391     if (cfg->ttl_inherit) {
 392         ds_put_cstr(&ds, ", ttl=inherit");
 393     } else {
 394         ds_put_format(&ds, ", ttl=%"PRIu8, cfg->ttl);
 395     }
 396
 397     if (cfg->tos_inherit) {
 398         ds_put_cstr(&ds, ", tos=inherit");
 399     } else if (cfg->tos) {
 400         ds_put_format(&ds, ", tos=%#"PRIx8, cfg->tos);
 401     }
 402
 403     if (!cfg->dont_fragment) {
 404         ds_put_cstr(&ds, ", df=false");
 405     }
 406
 407     if (cfg->csum) {
 408         ds_put_cstr(&ds, ", csum=true");
 409     }
 410
 411     ds_put_cstr(&ds, ")\n");
 412
 413     return ds_steal_cstr(&ds);
 414 }
 415
 416 static const char *
 417 tnl_port_get_name(const struct tnl_port *tnl_port)
 418 {
 419     return netdev_get_name(tnl_port->ofport->netdev);
 420 }