ofproto/tunnel.c

   1 /* Copyright (c) 2013, 2014, 2015 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 "byte-order.h"
  21 #include "connectivity.h"
  22 #include "csum.h"
  23 #include "dpif.h"
  24 #include "dynamic-string.h"
  25 #include "fat-rwlock.h"
  26 #include "hash.h"
  27 #include "hmap.h"
  28 #include "netdev.h"
  29 #include "odp-util.h"
  30 #include "ofpbuf.h"
  31 #include "packets.h"
  32 #include "route-table.h"
  33 #include "seq.h"
  34 #include "smap.h"
  35 #include "socket-util.h"
  36 #include "tnl-arp-cache.h"
  37 #include "tnl-ports.h"
  38 #include "tunnel.h"
  39 #include "openvswitch/vlog.h"
  40 #include "unaligned.h"
  41 #include "ofproto-dpif.h"
  42
  43 VLOG_DEFINE_THIS_MODULE(tunnel);
  44
  45 /* skb mark used for IPsec tunnel packets */
  46 #define IPSEC_MARK 1
  47
  48 struct tnl_match {
  49     ovs_be64 in_key;
  50     struct in6_addr ipv6_src;
  51     struct in6_addr ipv6_dst;
  52     odp_port_t odp_port;
  53     uint32_t pkt_mark;
  54     bool in_key_flow;
  55     bool ip_src_flow;
  56     bool ip_dst_flow;
  57 };
  58
  59 struct tnl_port {
  60     struct hmap_node ofport_node;
  61     struct hmap_node match_node;
  62
  63     const struct ofport_dpif *ofport;
  64     uint64_t change_seq;
  65     struct netdev *netdev;
  66
  67     struct tnl_match match;
  68 };
  69
  70 static struct fat_rwlock rwlock;
  71
  72 /* Tunnel matches.
  73  *
  74  * This module maps packets received over tunnel protocols to vports.  The
  75  * tunnel protocol and, for some protocols, tunnel-specific information (e.g.,
  76  * for VXLAN, the UDP destination port number) are always use as part of the
  77  * mapping.  Which other fields are used for the mapping depends on the vports
  78  * themselves (the parenthesized notations refer to "struct tnl_match" fields):
  79  *
  80  *     - in_key: A vport may match a specific tunnel ID (in_key_flow == false)
  81  *       or arrange for the tunnel ID to be matched as tunnel.tun_id in the
  82  *       OpenFlow flow (in_key_flow == true).
  83  *
  84  *     - ip_dst: A vport may match a specific destination IP address
  85  *       (ip_dst_flow == false) or arrange for the destination IP to be matched
  86  *       as tunnel.ip_dst in the OpenFlow flow (ip_dst_flow == true).
  87  *
  88  *     - ip_src: A vport may match a specific IP source address (ip_src_flow ==
  89  *       false, ip_src != 0), wildcard all source addresses (ip_src_flow ==
  90  *       false, ip_src == 0), or arrange for the IP source address to be
  91  *       handled in the OpenFlow flow table (ip_src_flow == true).
  92  *
  93  * Thus, there are 2 * 2 * 3 == 12 possible ways a vport can match against a
  94  * tunnel packet.  We number the possibilities for each field in increasing
  95  * order as listed in each bullet above.  We order the 12 overall combinations
  96  * in lexicographic order considering in_key first, then ip_dst, then
  97  * ip_src. */
  98 #define N_MATCH_TYPES (2 * 2 * 3)
  99
 100 /* The three possibilities (see above) for vport ip_src matches. */
 101 enum ip_src_type {
 102     IP_SRC_CFG,             /* ip_src must equal configured address. */
 103     IP_SRC_ANY,             /* Any ip_src is acceptable. */
 104     IP_SRC_FLOW             /* ip_src is handled in flow table. */
 105 };
 106
 107 /* Each hmap contains "struct tnl_port"s.
 108  * The index is a combination of how each of the fields listed under "Tunnel
 109  * matches" above matches, see the final paragraph for ordering. */
 110 static struct hmap *tnl_match_maps[N_MATCH_TYPES] OVS_GUARDED_BY(rwlock);
 111 static struct hmap **tnl_match_map(const struct tnl_match *);
 112
 113 static struct hmap ofport_map__ = HMAP_INITIALIZER(&ofport_map__);
 114 static struct hmap *ofport_map OVS_GUARDED_BY(rwlock) = &ofport_map__;
 115
 116 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 117 static struct vlog_rate_limit dbg_rl = VLOG_RATE_LIMIT_INIT(60, 60);
 118
 119 static struct tnl_port *tnl_find(const struct flow *) OVS_REQ_RDLOCK(rwlock);
 120 static struct tnl_port *tnl_find_exact(struct tnl_match *, struct hmap *)
 121     OVS_REQ_RDLOCK(rwlock);
 122 static struct tnl_port *tnl_find_ofport(const struct ofport_dpif *)
 123     OVS_REQ_RDLOCK(rwlock);
 124
 125 static uint32_t tnl_hash(struct tnl_match *);
 126 static void tnl_match_fmt(const struct tnl_match *, struct ds *);
 127 static char *tnl_port_fmt(const struct tnl_port *) OVS_REQ_RDLOCK(rwlock);
 128 static void tnl_port_mod_log(const struct tnl_port *, const char *action)
 129     OVS_REQ_RDLOCK(rwlock);
 130 static const char *tnl_port_get_name(const struct tnl_port *)
 131     OVS_REQ_RDLOCK(rwlock);
 132 static void tnl_port_del__(const struct ofport_dpif *) OVS_REQ_WRLOCK(rwlock);
 133
 134 void
 135 ofproto_tunnel_init(void)
 136 {
 137     static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
 138
 139     if (ovsthread_once_start(&once)) {
 140         fat_rwlock_init(&rwlock);
 141         ovsthread_once_done(&once);
 142     }
 143 }
 144
 145 static bool
 146 tnl_port_add__(const struct ofport_dpif *ofport, const struct netdev *netdev,
 147                odp_port_t odp_port, bool warn, bool native_tnl, const char name[])
 148     OVS_REQ_WRLOCK(rwlock)
 149 {
 150     const struct netdev_tunnel_config *cfg;
 151     struct tnl_port *existing_port;
 152     struct tnl_port *tnl_port;
 153     struct hmap **map;
 154
 155     cfg = netdev_get_tunnel_config(netdev);
 156     ovs_assert(cfg);
 157
 158     tnl_port = xzalloc(sizeof *tnl_port);
 159     tnl_port->ofport = ofport;
 160     tnl_port->netdev = netdev_ref(netdev);
 161     tnl_port->change_seq = netdev_get_change_seq(tnl_port->netdev);
 162
 163     tnl_port->match.in_key = cfg->in_key;
 164     tnl_port->match.ipv6_src = cfg->ipv6_src;
 165     tnl_port->match.ipv6_dst = cfg->ipv6_dst;
 166     tnl_port->match.ip_src_flow = cfg->ip_src_flow;
 167     tnl_port->match.ip_dst_flow = cfg->ip_dst_flow;
 168     tnl_port->match.pkt_mark = cfg->ipsec ? IPSEC_MARK : 0;
 169     tnl_port->match.in_key_flow = cfg->in_key_flow;
 170     tnl_port->match.odp_port = odp_port;
 171
 172     map = tnl_match_map(&tnl_port->match);
 173     existing_port = tnl_find_exact(&tnl_port->match, *map);
 174     if (existing_port) {
 175         if (warn) {
 176             struct ds ds = DS_EMPTY_INITIALIZER;
 177             tnl_match_fmt(&tnl_port->match, &ds);
 178             VLOG_WARN("%s: attempting to add tunnel port with same config as "
 179                       "port '%s' (%s)", tnl_port_get_name(tnl_port),
 180                       tnl_port_get_name(existing_port), ds_cstr(&ds));
 181             ds_destroy(&ds);
 182         }
 183         netdev_close(tnl_port->netdev);
 184         free(tnl_port);
 185         return false;
 186     }
 187
 188     hmap_insert(ofport_map, &tnl_port->ofport_node, hash_pointer(ofport, 0));
 189
 190     if (!*map) {
 191         *map = xmalloc(sizeof **map);
 192         hmap_init(*map);
 193     }
 194     hmap_insert(*map, &tnl_port->match_node, tnl_hash(&tnl_port->match));
 195     tnl_port_mod_log(tnl_port, "adding");
 196
 197     if (native_tnl) {
 198         tnl_port_map_insert(odp_port, cfg->dst_port, name);
 199     }
 200     return true;
 201 }
 202
 203 /* Adds 'ofport' to the module with datapath port number 'odp_port'. 'ofport's
 204  * must be added before they can be used by the module. 'ofport' must be a
 205  * tunnel.
 206  *
 207  * Returns 0 if successful, otherwise a positive errno value. */
 208 int
 209 tnl_port_add(const struct ofport_dpif *ofport, const struct netdev *netdev,
 210              odp_port_t odp_port, bool native_tnl, const char name[]) OVS_EXCLUDED(rwlock)
 211 {
 212     bool ok;
 213
 214     fat_rwlock_wrlock(&rwlock);
 215     ok = tnl_port_add__(ofport, netdev, odp_port, true, native_tnl, name);
 216     fat_rwlock_unlock(&rwlock);
 217
 218     return ok ? 0 : EEXIST;
 219 }
 220
 221 /* Checks if the tunnel represented by 'ofport' reconfiguration due to changes
 222  * in its netdev_tunnel_config.  If it does, returns true. Otherwise, returns
 223  * false.  'ofport' and 'odp_port' should be the same as would be passed to
 224  * tnl_port_add(). */
 225 bool
 226 tnl_port_reconfigure(const struct ofport_dpif *ofport,
 227                      const struct netdev *netdev, odp_port_t odp_port,
 228                      bool native_tnl, const char name[])
 229     OVS_EXCLUDED(rwlock)
 230 {
 231     struct tnl_port *tnl_port;
 232     bool changed = false;
 233
 234     fat_rwlock_wrlock(&rwlock);
 235     tnl_port = tnl_find_ofport(ofport);
 236     if (!tnl_port) {
 237         changed = tnl_port_add__(ofport, netdev, odp_port, false, native_tnl, name);
 238     } else if (tnl_port->netdev != netdev
 239                || tnl_port->match.odp_port != odp_port
 240                || tnl_port->change_seq != netdev_get_change_seq(tnl_port->netdev)) {
 241         VLOG_DBG("reconfiguring %s", tnl_port_get_name(tnl_port));
 242         tnl_port_del__(ofport);
 243         tnl_port_add__(ofport, netdev, odp_port, true, native_tnl, name);
 244         changed = true;
 245     }
 246     fat_rwlock_unlock(&rwlock);
 247     return changed;
 248 }
 249
 250 static void
 251 tnl_port_del__(const struct ofport_dpif *ofport) OVS_REQ_WRLOCK(rwlock)
 252 {
 253     struct tnl_port *tnl_port;
 254
 255     if (!ofport) {
 256         return;
 257     }
 258
 259     tnl_port = tnl_find_ofport(ofport);
 260     if (tnl_port) {
 261         const struct netdev_tunnel_config *cfg =
 262             netdev_get_tunnel_config(tnl_port->netdev);
 263         struct hmap **map;
 264
 265         tnl_port_map_delete(cfg->dst_port);
 266         tnl_port_mod_log(tnl_port, "removing");
 267         map = tnl_match_map(&tnl_port->match);
 268         hmap_remove(*map, &tnl_port->match_node);
 269         if (hmap_is_empty(*map)) {
 270             hmap_destroy(*map);
 271             free(*map);
 272             *map = NULL;
 273         }
 274         hmap_remove(ofport_map, &tnl_port->ofport_node);
 275         netdev_close(tnl_port->netdev);
 276         free(tnl_port);
 277     }
 278 }
 279
 280 /* Removes 'ofport' from the module. */
 281 void
 282 tnl_port_del(const struct ofport_dpif *ofport) OVS_EXCLUDED(rwlock)
 283 {
 284     fat_rwlock_wrlock(&rwlock);
 285     tnl_port_del__(ofport);
 286     fat_rwlock_unlock(&rwlock);
 287 }
 288
 289 /* Looks in the table of tunnels for a tunnel matching the metadata in 'flow'.
 290  * Returns the 'ofport' corresponding to the new in_port, or a null pointer if
 291  * none is found.
 292  *
 293  * Callers should verify that 'flow' needs to be received by calling
 294  * tnl_port_should_receive() before this function. */
 295 const struct ofport_dpif *
 296 tnl_port_receive(const struct flow *flow) OVS_EXCLUDED(rwlock)
 297 {
 298     char *pre_flow_str = NULL;
 299     const struct ofport_dpif *ofport;
 300     struct tnl_port *tnl_port;
 301
 302     fat_rwlock_rdlock(&rwlock);
 303     tnl_port = tnl_find(flow);
 304     ofport = tnl_port ? tnl_port->ofport : NULL;
 305     if (!tnl_port) {
 306         char *flow_str = flow_to_string(flow);
 307
 308         VLOG_WARN_RL(&rl, "receive tunnel port not found (%s)", flow_str);
 309         free(flow_str);
 310         goto out;
 311     }
 312
 313     if (!VLOG_DROP_DBG(&dbg_rl)) {
 314         pre_flow_str = flow_to_string(flow);
 315     }
 316
 317     if (pre_flow_str) {
 318         char *post_flow_str = flow_to_string(flow);
 319         char *tnl_str = tnl_port_fmt(tnl_port);
 320         VLOG_DBG("flow received\n"
 321                  "%s"
 322                  " pre: %s\n"
 323                  "post: %s",
 324                  tnl_str, pre_flow_str, post_flow_str);
 325         free(tnl_str);
 326         free(pre_flow_str);
 327         free(post_flow_str);
 328     }
 329
 330 out:
 331     fat_rwlock_unlock(&rwlock);
 332     return ofport;
 333 }
 334
 335 /* Should be called at the beginning of action translation to initialize
 336  * wildcards and perform any actions based on receiving on tunnel port.
 337  *
 338  * Returns false if the packet must be dropped. */
 339 bool
 340 tnl_process_ecn(struct flow *flow)
 341 {
 342     if (!tnl_port_should_receive(flow)) {
 343         return true;
 344     }
 345
 346     if (is_ip_any(flow) && (flow->tunnel.ip_tos & IP_ECN_MASK) == IP_ECN_CE) {
 347         if ((flow->nw_tos & IP_ECN_MASK) == IP_ECN_NOT_ECT) {
 348             VLOG_WARN_RL(&rl, "dropping tunnel packet marked ECN CE"
 349                          " but is not ECN capable");
 350             return false;
 351         }
 352
 353         /* Set the ECN CE value in the tunneled packet. */
 354         flow->nw_tos |= IP_ECN_CE;
 355     }
 356
 357     flow->pkt_mark &= ~IPSEC_MARK;
 358     return true;
 359 }
 360
 361 void
 362 tnl_wc_init(struct flow *flow, struct flow_wildcards *wc)
 363 {
 364     if (tnl_port_should_receive(flow)) {
 365         wc->masks.tunnel.tun_id = OVS_BE64_MAX;
 366         wc->masks.tunnel.ip_src = OVS_BE32_MAX;
 367         wc->masks.tunnel.ip_dst = OVS_BE32_MAX;
 368         wc->masks.tunnel.flags = (FLOW_TNL_F_DONT_FRAGMENT |
 369                                   FLOW_TNL_F_CSUM |
 370                                   FLOW_TNL_F_KEY);
 371         wc->masks.tunnel.ip_tos = UINT8_MAX;
 372         wc->masks.tunnel.ip_ttl = UINT8_MAX;
 373         /* The tp_src and tp_dst members in flow_tnl are set to be always
 374          * wildcarded, not to unwildcard them here. */
 375         wc->masks.tunnel.tp_src = 0;
 376         wc->masks.tunnel.tp_dst = 0;
 377
 378         memset(&wc->masks.pkt_mark, 0xff, sizeof wc->masks.pkt_mark);
 379
 380         if (is_ip_any(flow)
 381             && (flow->tunnel.ip_tos & IP_ECN_MASK) == IP_ECN_CE) {
 382             wc->masks.nw_tos |= IP_ECN_MASK;
 383         }
 384     }
 385 }
 386
 387 /* Given that 'flow' should be output to the ofport corresponding to
 388  * 'tnl_port', updates 'flow''s tunnel headers and returns the actual datapath
 389  * port that the output should happen on.  May return ODPP_NONE if the output
 390  * shouldn't occur. */
 391 odp_port_t
 392 tnl_port_send(const struct ofport_dpif *ofport, struct flow *flow,
 393               struct flow_wildcards *wc) OVS_EXCLUDED(rwlock)
 394 {
 395     const struct netdev_tunnel_config *cfg;
 396     struct tnl_port *tnl_port;
 397     char *pre_flow_str = NULL;
 398     odp_port_t out_port;
 399
 400     fat_rwlock_rdlock(&rwlock);
 401     tnl_port = tnl_find_ofport(ofport);
 402     out_port = tnl_port ? tnl_port->match.odp_port : ODPP_NONE;
 403     if (!tnl_port) {
 404         goto out;
 405     }
 406
 407     cfg = netdev_get_tunnel_config(tnl_port->netdev);
 408     ovs_assert(cfg);
 409
 410     if (!VLOG_DROP_DBG(&dbg_rl)) {
 411         pre_flow_str = flow_to_string(flow);
 412     }
 413
 414     if (!cfg->ip_src_flow) {
 415         flow->tunnel.ip_src = in6_addr_get_mapped_ipv4(&tnl_port->match.ipv6_src);
 416     }
 417     if (!cfg->ip_dst_flow) {
 418         flow->tunnel.ip_dst = in6_addr_get_mapped_ipv4(&tnl_port->match.ipv6_dst);
 419     }
 420     flow->pkt_mark = tnl_port->match.pkt_mark;
 421
 422     if (!cfg->out_key_flow) {
 423         flow->tunnel.tun_id = cfg->out_key;
 424     }
 425
 426     if (cfg->ttl_inherit && is_ip_any(flow)) {
 427         wc->masks.nw_ttl = 0xff;
 428         flow->tunnel.ip_ttl = flow->nw_ttl;
 429     } else {
 430         flow->tunnel.ip_ttl = cfg->ttl;
 431     }
 432
 433     if (cfg->tos_inherit && is_ip_any(flow)) {
 434         wc->masks.nw_tos |= IP_DSCP_MASK;
 435         flow->tunnel.ip_tos = flow->nw_tos & IP_DSCP_MASK;
 436     } else {
 437         flow->tunnel.ip_tos = cfg->tos;
 438     }
 439
 440     /* ECN fields are always inherited. */
 441     if (is_ip_any(flow)) {
 442         wc->masks.nw_tos |= IP_ECN_MASK;
 443
 444         if ((flow->nw_tos & IP_ECN_MASK) == IP_ECN_CE) {
 445             flow->tunnel.ip_tos |= IP_ECN_ECT_0;
 446         } else {
 447             flow->tunnel.ip_tos |= flow->nw_tos & IP_ECN_MASK;
 448         }
 449     }
 450
 451     flow->tunnel.flags |= (cfg->dont_fragment ? FLOW_TNL_F_DONT_FRAGMENT : 0)
 452         | (cfg->csum ? FLOW_TNL_F_CSUM : 0)
 453         | (cfg->out_key_present ? FLOW_TNL_F_KEY : 0);
 454
 455     if (pre_flow_str) {
 456         char *post_flow_str = flow_to_string(flow);
 457         char *tnl_str = tnl_port_fmt(tnl_port);
 458         VLOG_DBG("flow sent\n"
 459                  "%s"
 460                  " pre: %s\n"
 461                  "post: %s",
 462                  tnl_str, pre_flow_str, post_flow_str);
 463         free(tnl_str);
 464         free(pre_flow_str);
 465         free(post_flow_str);
 466     }
 467
 468 out:
 469     fat_rwlock_unlock(&rwlock);
 470     return out_port;
 471 }
 472
 473 static uint32_t
 474 tnl_hash(struct tnl_match *match)
 475 {
 476     BUILD_ASSERT_DECL(sizeof *match % sizeof(uint32_t) == 0);
 477     return hash_words((uint32_t *) match, sizeof *match / sizeof(uint32_t), 0);
 478 }
 479
 480 static struct tnl_port *
 481 tnl_find_ofport(const struct ofport_dpif *ofport) OVS_REQ_RDLOCK(rwlock)
 482 {
 483     struct tnl_port *tnl_port;
 484
 485     HMAP_FOR_EACH_IN_BUCKET (tnl_port, ofport_node, hash_pointer(ofport, 0),
 486                              ofport_map) {
 487         if (tnl_port->ofport == ofport) {
 488             return tnl_port;
 489         }
 490     }
 491     return NULL;
 492 }
 493
 494 static struct tnl_port *
 495 tnl_find_exact(struct tnl_match *match, struct hmap *map)
 496     OVS_REQ_RDLOCK(rwlock)
 497 {
 498     if (map) {
 499         struct tnl_port *tnl_port;
 500
 501         HMAP_FOR_EACH_WITH_HASH (tnl_port, match_node, tnl_hash(match), map) {
 502             if (!memcmp(match, &tnl_port->match, sizeof *match)) {
 503                 return tnl_port;
 504             }
 505         }
 506     }
 507     return NULL;
 508 }
 509
 510 /* Returns the tnl_port that is the best match for the tunnel data in 'flow',
 511  * or NULL if no tnl_port matches 'flow'. */
 512 static struct tnl_port *
 513 tnl_find(const struct flow *flow) OVS_REQ_RDLOCK(rwlock)
 514 {
 515     enum ip_src_type ip_src;
 516     int in_key_flow;
 517     int ip_dst_flow;
 518     int i;
 519
 520     i = 0;
 521     for (in_key_flow = 0; in_key_flow < 2; in_key_flow++) {
 522         for (ip_dst_flow = 0; ip_dst_flow < 2; ip_dst_flow++) {
 523             for (ip_src = 0; ip_src < 3; ip_src++) {
 524                 struct hmap *map = tnl_match_maps[i];
 525
 526                 if (map) {
 527                     struct tnl_port *tnl_port;
 528                     struct tnl_match match;
 529
 530                     memset(&match, 0, sizeof match);
 531
 532                     /* The apparent mix-up of 'ip_dst' and 'ip_src' below is
 533                      * correct, because "struct tnl_match" is expressed in
 534                      * terms of packets being sent out, but we are using it
 535                      * here as a description of how to treat received
 536                      * packets. */
 537                     match.in_key = in_key_flow ? 0 : flow->tunnel.tun_id;
 538                     if (ip_src == IP_SRC_CFG && flow->tunnel.ip_dst) {
 539                         in6_addr_set_mapped_ipv4(&match.ipv6_src, flow->tunnel.ip_dst);
 540                     }
 541                     if (!ip_dst_flow && flow->tunnel.ip_src) {
 542                         in6_addr_set_mapped_ipv4(&match.ipv6_dst, flow->tunnel.ip_src);
 543                     }
 544                     match.odp_port = flow->in_port.odp_port;
 545                     match.pkt_mark = flow->pkt_mark;
 546                     match.in_key_flow = in_key_flow;
 547                     match.ip_dst_flow = ip_dst_flow;
 548                     match.ip_src_flow = ip_src == IP_SRC_FLOW;
 549
 550                     tnl_port = tnl_find_exact(&match, map);
 551                     if (tnl_port) {
 552                         return tnl_port;
 553                     }
 554                 }
 555
 556                 i++;
 557             }
 558         }
 559     }
 560
 561     return NULL;
 562 }
 563
 564 /* Returns a pointer to the 'tnl_match_maps' element corresponding to 'm''s
 565  * matching criteria. */
 566 static struct hmap **
 567 tnl_match_map(const struct tnl_match *m)
 568 {
 569     enum ip_src_type ip_src;
 570
 571     ip_src = (m->ip_src_flow ? IP_SRC_FLOW
 572               : ipv6_addr_is_set(&m->ipv6_src) ? IP_SRC_CFG
 573               : IP_SRC_ANY);
 574
 575     return &tnl_match_maps[6 * m->in_key_flow + 3 * m->ip_dst_flow + ip_src];
 576 }
 577
 578 static void
 579 tnl_match_fmt(const struct tnl_match *match, struct ds *ds)
 580     OVS_REQ_RDLOCK(rwlock)
 581 {
 582     if (!match->ip_dst_flow) {
 583         ipv6_format_mapped(&match->ipv6_src, ds);
 584         ds_put_cstr(ds, "->");
 585         ipv6_format_mapped(&match->ipv6_dst, ds);
 586     } else if (!match->ip_src_flow) {
 587         ipv6_format_mapped(&match->ipv6_src, ds);
 588         ds_put_cstr(ds, "->flow");
 589     } else {
 590         ds_put_cstr(ds, "flow->flow");
 591     }
 592
 593     if (match->in_key_flow) {
 594         ds_put_cstr(ds, ", key=flow");
 595     } else {
 596         ds_put_format(ds, ", key=%#"PRIx64, ntohll(match->in_key));
 597     }
 598
 599     ds_put_format(ds, ", dp port=%"PRIu32, match->odp_port);
 600     ds_put_format(ds, ", pkt mark=%"PRIu32, match->pkt_mark);
 601 }
 602
 603 static void
 604 tnl_port_mod_log(const struct tnl_port *tnl_port, const char *action)
 605     OVS_REQ_RDLOCK(rwlock)
 606 {
 607     if (VLOG_IS_DBG_ENABLED()) {
 608         struct ds ds = DS_EMPTY_INITIALIZER;
 609
 610         tnl_match_fmt(&tnl_port->match, &ds);
 611         VLOG_INFO("%s tunnel port %s (%s)", action,
 612                   tnl_port_get_name(tnl_port), ds_cstr(&ds));
 613         ds_destroy(&ds);
 614     }
 615 }
 616
 617 static char *
 618 tnl_port_fmt(const struct tnl_port *tnl_port) OVS_REQ_RDLOCK(rwlock)
 619 {
 620     const struct netdev_tunnel_config *cfg =
 621         netdev_get_tunnel_config(tnl_port->netdev);
 622     struct ds ds = DS_EMPTY_INITIALIZER;
 623
 624     ds_put_format(&ds, "port %"PRIu32": %s (%s: ", tnl_port->match.odp_port,
 625                   tnl_port_get_name(tnl_port),
 626                   netdev_get_type(tnl_port->netdev));
 627     tnl_match_fmt(&tnl_port->match, &ds);
 628
 629     if (cfg->out_key != cfg->in_key ||
 630         cfg->out_key_present != cfg->in_key_present ||
 631         cfg->out_key_flow != cfg->in_key_flow) {
 632         ds_put_cstr(&ds, ", out_key=");
 633         if (!cfg->out_key_present) {
 634             ds_put_cstr(&ds, "none");
 635         } else if (cfg->out_key_flow) {
 636             ds_put_cstr(&ds, "flow");
 637         } else {
 638             ds_put_format(&ds, "%#"PRIx64, ntohll(cfg->out_key));
 639         }
 640     }
 641
 642     if (cfg->ttl_inherit) {
 643         ds_put_cstr(&ds, ", ttl=inherit");
 644     } else {
 645         ds_put_format(&ds, ", ttl=%"PRIu8, cfg->ttl);
 646     }
 647
 648     if (cfg->tos_inherit) {
 649         ds_put_cstr(&ds, ", tos=inherit");
 650     } else if (cfg->tos) {
 651         ds_put_format(&ds, ", tos=%#"PRIx8, cfg->tos);
 652     }
 653
 654     if (!cfg->dont_fragment) {
 655         ds_put_cstr(&ds, ", df=false");
 656     }
 657
 658     if (cfg->csum) {
 659         ds_put_cstr(&ds, ", csum=true");
 660     }
 661
 662     ds_put_cstr(&ds, ")\n");
 663
 664     return ds_steal_cstr(&ds);
 665 }
 666
 667 static const char *
 668 tnl_port_get_name(const struct tnl_port *tnl_port) OVS_REQ_RDLOCK(rwlock)
 669 {
 670     return netdev_get_name(tnl_port->netdev);
 671 }
 672
 673 int
 674 tnl_port_build_header(const struct ofport_dpif *ofport,
 675                       const struct flow *tnl_flow,
 676                       const struct eth_addr dmac,
 677                       const struct eth_addr smac,
 678                       ovs_be32 ip_src, struct ovs_action_push_tnl *data)
 679 {
 680     struct tnl_port *tnl_port;
 681     struct eth_header *eth;
 682     struct ip_header *ip;
 683     void *l3;
 684     int res;
 685
 686     fat_rwlock_rdlock(&rwlock);
 687     tnl_port = tnl_find_ofport(ofport);
 688     ovs_assert(tnl_port);
 689
 690     /* Build Ethernet and IP headers. */
 691     memset(data->header, 0, sizeof data->header);
 692
 693     eth = (struct eth_header *)data->header;
 694     eth->eth_dst = dmac;
 695     eth->eth_src = smac;
 696     eth->eth_type = htons(ETH_TYPE_IP);
 697
 698     l3 = (eth + 1);
 699     ip = (struct ip_header *) l3;
 700
 701     ip->ip_ihl_ver = IP_IHL_VER(5, 4);
 702     ip->ip_tos = tnl_flow->tunnel.ip_tos;
 703     ip->ip_ttl = tnl_flow->tunnel.ip_ttl;
 704     ip->ip_frag_off = (tnl_flow->tunnel.flags & FLOW_TNL_F_DONT_FRAGMENT) ?
 705                       htons(IP_DF) : 0;
 706
 707     put_16aligned_be32(&ip->ip_src, ip_src);
 708     put_16aligned_be32(&ip->ip_dst, tnl_flow->tunnel.ip_dst);
 709
 710     res = netdev_build_header(tnl_port->netdev, data, tnl_flow);
 711     ip->ip_csum = csum(ip, sizeof *ip);
 712     fat_rwlock_unlock(&rwlock);
 713
 714     return res;
 715 }