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