ofproto-dpif-rid: Don't carry actset_output explicitly in metadata.
[cascardo/ovs.git] / 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-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         tnl_port_map_insert(odp_port, cfg->dst_port, name);
198     }
199     return true;
200 }
201
202 /* Adds 'ofport' to the module with datapath port number 'odp_port'. 'ofport's
203  * must be added before they can be used by the module. 'ofport' must be a
204  * tunnel.
205  *
206  * Returns 0 if successful, otherwise a positive errno value. */
207 int
208 tnl_port_add(const struct ofport_dpif *ofport, const struct netdev *netdev,
209              odp_port_t odp_port, bool native_tnl, const char name[]) OVS_EXCLUDED(rwlock)
210 {
211     bool ok;
212
213     fat_rwlock_wrlock(&rwlock);
214     ok = tnl_port_add__(ofport, netdev, odp_port, true, native_tnl, name);
215     fat_rwlock_unlock(&rwlock);
216
217     return ok ? 0 : EEXIST;
218 }
219
220 /* Checks if the tunnel represented by 'ofport' reconfiguration due to changes
221  * in its netdev_tunnel_config.  If it does, returns true. Otherwise, returns
222  * false.  'ofport' and 'odp_port' should be the same as would be passed to
223  * tnl_port_add(). */
224 bool
225 tnl_port_reconfigure(const struct ofport_dpif *ofport,
226                      const struct netdev *netdev, odp_port_t odp_port,
227                      bool native_tnl, const char name[])
228     OVS_EXCLUDED(rwlock)
229 {
230     struct tnl_port *tnl_port;
231     bool changed = false;
232
233     fat_rwlock_wrlock(&rwlock);
234     tnl_port = tnl_find_ofport(ofport);
235     if (!tnl_port) {
236         changed = tnl_port_add__(ofport, netdev, odp_port, false, native_tnl, name);
237     } else if (tnl_port->netdev != netdev
238                || tnl_port->match.odp_port != odp_port
239                || tnl_port->change_seq != netdev_get_change_seq(tnl_port->netdev)) {
240         VLOG_DBG("reconfiguring %s", tnl_port_get_name(tnl_port));
241         tnl_port_del__(ofport);
242         tnl_port_add__(ofport, netdev, odp_port, true, native_tnl, name);
243         changed = true;
244     }
245     fat_rwlock_unlock(&rwlock);
246     return changed;
247 }
248
249 static void
250 tnl_port_del__(const struct ofport_dpif *ofport) OVS_REQ_WRLOCK(rwlock)
251 {
252     struct tnl_port *tnl_port;
253
254     if (!ofport) {
255         return;
256     }
257
258     tnl_port = tnl_find_ofport(ofport);
259     if (tnl_port) {
260         const struct netdev_tunnel_config *cfg =
261             netdev_get_tunnel_config(tnl_port->netdev);
262         struct hmap **map;
263
264         tnl_port_map_delete(cfg->dst_port);
265         tnl_port_mod_log(tnl_port, "removing");
266         map = tnl_match_map(&tnl_port->match);
267         hmap_remove(*map, &tnl_port->match_node);
268         if (hmap_is_empty(*map)) {
269             hmap_destroy(*map);
270             free(*map);
271             *map = NULL;
272         }
273         hmap_remove(ofport_map, &tnl_port->ofport_node);
274         netdev_close(tnl_port->netdev);
275         free(tnl_port);
276     }
277 }
278
279 /* Removes 'ofport' from the module. */
280 void
281 tnl_port_del(const struct ofport_dpif *ofport) OVS_EXCLUDED(rwlock)
282 {
283     fat_rwlock_wrlock(&rwlock);
284     tnl_port_del__(ofport);
285     fat_rwlock_unlock(&rwlock);
286 }
287
288 /* Looks in the table of tunnels for a tunnel matching the metadata in 'flow'.
289  * Returns the 'ofport' corresponding to the new in_port, or a null pointer if
290  * none is found.
291  *
292  * Callers should verify that 'flow' needs to be received by calling
293  * tnl_port_should_receive() before this function. */
294 const struct ofport_dpif *
295 tnl_port_receive(const struct flow *flow) OVS_EXCLUDED(rwlock)
296 {
297     char *pre_flow_str = NULL;
298     const struct ofport_dpif *ofport;
299     struct tnl_port *tnl_port;
300
301     fat_rwlock_rdlock(&rwlock);
302     tnl_port = tnl_find(flow);
303     ofport = tnl_port ? tnl_port->ofport : NULL;
304     if (!tnl_port) {
305         char *flow_str = flow_to_string(flow);
306
307         VLOG_WARN_RL(&rl, "receive tunnel port not found (%s)", flow_str);
308         free(flow_str);
309         goto out;
310     }
311
312     if (!VLOG_DROP_DBG(&dbg_rl)) {
313         pre_flow_str = flow_to_string(flow);
314     }
315
316     if (pre_flow_str) {
317         char *post_flow_str = flow_to_string(flow);
318         char *tnl_str = tnl_port_fmt(tnl_port);
319         VLOG_DBG("flow received\n"
320                  "%s"
321                  " pre: %s\n"
322                  "post: %s",
323                  tnl_str, pre_flow_str, post_flow_str);
324         free(tnl_str);
325         free(pre_flow_str);
326         free(post_flow_str);
327     }
328
329 out:
330     fat_rwlock_unlock(&rwlock);
331     return ofport;
332 }
333
334 /* Should be called at the beginning of action translation to initialize
335  * wildcards and perform any actions based on receiving on tunnel port.
336  *
337  * Returns false if the packet must be dropped. */
338 bool
339 tnl_process_ecn(struct flow *flow)
340 {
341     if (!tnl_port_should_receive(flow)) {
342         return true;
343     }
344
345     if (is_ip_any(flow) && (flow->tunnel.ip_tos & IP_ECN_MASK) == IP_ECN_CE) {
346         if ((flow->nw_tos & IP_ECN_MASK) == IP_ECN_NOT_ECT) {
347             VLOG_WARN_RL(&rl, "dropping tunnel packet marked ECN CE"
348                          " but is not ECN capable");
349             return false;
350         }
351
352         /* Set the ECN CE value in the tunneled packet. */
353         flow->nw_tos |= IP_ECN_CE;
354     }
355
356     flow->pkt_mark &= ~IPSEC_MARK;
357     return true;
358 }
359
360 void
361 tnl_wc_init(struct flow *flow, struct flow_wildcards *wc)
362 {
363     if (tnl_port_should_receive(flow)) {
364         wc->masks.tunnel.tun_id = OVS_BE64_MAX;
365         if (flow->tunnel.ip_dst) {
366             wc->masks.tunnel.ip_src = OVS_BE32_MAX;
367             wc->masks.tunnel.ip_dst = OVS_BE32_MAX;
368         } else {
369             wc->masks.tunnel.ipv6_src = in6addr_exact;
370             wc->masks.tunnel.ipv6_dst = in6addr_exact;
371         }
372         wc->masks.tunnel.flags = (FLOW_TNL_F_DONT_FRAGMENT |
373                                   FLOW_TNL_F_CSUM |
374                                   FLOW_TNL_F_KEY);
375         wc->masks.tunnel.ip_tos = UINT8_MAX;
376         wc->masks.tunnel.ip_ttl = 0;
377         /* The tp_src and tp_dst members in flow_tnl are set to be always
378          * wildcarded, not to unwildcard them here. */
379         wc->masks.tunnel.tp_src = 0;
380         wc->masks.tunnel.tp_dst = 0;
381
382         memset(&wc->masks.pkt_mark, 0xff, sizeof wc->masks.pkt_mark);
383
384         if (is_ip_any(flow)
385             && (flow->tunnel.ip_tos & IP_ECN_MASK) == IP_ECN_CE) {
386             wc->masks.nw_tos |= IP_ECN_MASK;
387         }
388     }
389 }
390
391 /* Given that 'flow' should be output to the ofport corresponding to
392  * 'tnl_port', updates 'flow''s tunnel headers and returns the actual datapath
393  * port that the output should happen on.  May return ODPP_NONE if the output
394  * shouldn't occur. */
395 odp_port_t
396 tnl_port_send(const struct ofport_dpif *ofport, struct flow *flow,
397               struct flow_wildcards *wc) OVS_EXCLUDED(rwlock)
398 {
399     const struct netdev_tunnel_config *cfg;
400     struct tnl_port *tnl_port;
401     char *pre_flow_str = NULL;
402     odp_port_t out_port;
403
404     fat_rwlock_rdlock(&rwlock);
405     tnl_port = tnl_find_ofport(ofport);
406     out_port = tnl_port ? tnl_port->match.odp_port : ODPP_NONE;
407     if (!tnl_port) {
408         goto out;
409     }
410
411     cfg = netdev_get_tunnel_config(tnl_port->netdev);
412     ovs_assert(cfg);
413
414     if (!VLOG_DROP_DBG(&dbg_rl)) {
415         pre_flow_str = flow_to_string(flow);
416     }
417
418     if (!cfg->ip_src_flow) {
419         flow->tunnel.ip_src = in6_addr_get_mapped_ipv4(&tnl_port->match.ipv6_src);
420         if (!flow->tunnel.ip_src) {
421             flow->tunnel.ipv6_src = tnl_port->match.ipv6_src;
422         }
423     }
424     if (!cfg->ip_dst_flow) {
425         flow->tunnel.ip_dst = in6_addr_get_mapped_ipv4(&tnl_port->match.ipv6_dst);
426         if (!flow->tunnel.ip_dst) {
427             flow->tunnel.ipv6_dst = tnl_port->match.ipv6_dst;
428         }
429     }
430     flow->pkt_mark = tnl_port->match.pkt_mark;
431
432     if (!cfg->out_key_flow) {
433         flow->tunnel.tun_id = cfg->out_key;
434     }
435
436     if (cfg->ttl_inherit && is_ip_any(flow)) {
437         wc->masks.nw_ttl = 0xff;
438         flow->tunnel.ip_ttl = flow->nw_ttl;
439     } else {
440         flow->tunnel.ip_ttl = cfg->ttl;
441     }
442
443     if (cfg->tos_inherit && is_ip_any(flow)) {
444         wc->masks.nw_tos |= IP_DSCP_MASK;
445         flow->tunnel.ip_tos = flow->nw_tos & IP_DSCP_MASK;
446     } else {
447         flow->tunnel.ip_tos = cfg->tos;
448     }
449
450     /* ECN fields are always inherited. */
451     if (is_ip_any(flow)) {
452         wc->masks.nw_tos |= IP_ECN_MASK;
453
454         if ((flow->nw_tos & IP_ECN_MASK) == IP_ECN_CE) {
455             flow->tunnel.ip_tos |= IP_ECN_ECT_0;
456         } else {
457             flow->tunnel.ip_tos |= flow->nw_tos & IP_ECN_MASK;
458         }
459     }
460
461     flow->tunnel.flags |= (cfg->dont_fragment ? FLOW_TNL_F_DONT_FRAGMENT : 0)
462         | (cfg->csum ? FLOW_TNL_F_CSUM : 0)
463         | (cfg->out_key_present ? FLOW_TNL_F_KEY : 0);
464
465     if (pre_flow_str) {
466         char *post_flow_str = flow_to_string(flow);
467         char *tnl_str = tnl_port_fmt(tnl_port);
468         VLOG_DBG("flow sent\n"
469                  "%s"
470                  " pre: %s\n"
471                  "post: %s",
472                  tnl_str, pre_flow_str, post_flow_str);
473         free(tnl_str);
474         free(pre_flow_str);
475         free(post_flow_str);
476     }
477
478 out:
479     fat_rwlock_unlock(&rwlock);
480     return out_port;
481 }
482
483 static uint32_t
484 tnl_hash(struct tnl_match *match)
485 {
486     BUILD_ASSERT_DECL(sizeof *match % sizeof(uint32_t) == 0);
487     return hash_words((uint32_t *) match, sizeof *match / sizeof(uint32_t), 0);
488 }
489
490 static struct tnl_port *
491 tnl_find_ofport(const struct ofport_dpif *ofport) OVS_REQ_RDLOCK(rwlock)
492 {
493     struct tnl_port *tnl_port;
494
495     HMAP_FOR_EACH_IN_BUCKET (tnl_port, ofport_node, hash_pointer(ofport, 0),
496                              ofport_map) {
497         if (tnl_port->ofport == ofport) {
498             return tnl_port;
499         }
500     }
501     return NULL;
502 }
503
504 static struct tnl_port *
505 tnl_find_exact(struct tnl_match *match, struct hmap *map)
506     OVS_REQ_RDLOCK(rwlock)
507 {
508     if (map) {
509         struct tnl_port *tnl_port;
510
511         HMAP_FOR_EACH_WITH_HASH (tnl_port, match_node, tnl_hash(match), map) {
512             if (!memcmp(match, &tnl_port->match, sizeof *match)) {
513                 return tnl_port;
514             }
515         }
516     }
517     return NULL;
518 }
519
520 /* Returns the tnl_port that is the best match for the tunnel data in 'flow',
521  * or NULL if no tnl_port matches 'flow'. */
522 static struct tnl_port *
523 tnl_find(const struct flow *flow) OVS_REQ_RDLOCK(rwlock)
524 {
525     enum ip_src_type ip_src;
526     int in_key_flow;
527     int ip_dst_flow;
528     int i;
529
530     i = 0;
531     for (in_key_flow = 0; in_key_flow < 2; in_key_flow++) {
532         for (ip_dst_flow = 0; ip_dst_flow < 2; ip_dst_flow++) {
533             for (ip_src = 0; ip_src < 3; ip_src++) {
534                 struct hmap *map = tnl_match_maps[i];
535
536                 if (map) {
537                     struct tnl_port *tnl_port;
538                     struct tnl_match match;
539
540                     memset(&match, 0, sizeof match);
541
542                     /* The apparent mix-up of 'ip_dst' and 'ip_src' below is
543                      * correct, because "struct tnl_match" is expressed in
544                      * terms of packets being sent out, but we are using it
545                      * here as a description of how to treat received
546                      * packets. */
547                     match.in_key = in_key_flow ? 0 : flow->tunnel.tun_id;
548                     if (ip_src == IP_SRC_CFG) {
549                         match.ipv6_src = flow_tnl_dst(&flow->tunnel);
550                     }
551                     if (!ip_dst_flow) {
552                         match.ipv6_dst = flow_tnl_src(&flow->tunnel);
553                     }
554                     match.odp_port = flow->in_port.odp_port;
555                     match.pkt_mark = flow->pkt_mark;
556                     match.in_key_flow = in_key_flow;
557                     match.ip_dst_flow = ip_dst_flow;
558                     match.ip_src_flow = ip_src == IP_SRC_FLOW;
559
560                     tnl_port = tnl_find_exact(&match, map);
561                     if (tnl_port) {
562                         return tnl_port;
563                     }
564                 }
565
566                 i++;
567             }
568         }
569     }
570
571     return NULL;
572 }
573
574 /* Returns a pointer to the 'tnl_match_maps' element corresponding to 'm''s
575  * matching criteria. */
576 static struct hmap **
577 tnl_match_map(const struct tnl_match *m)
578 {
579     enum ip_src_type ip_src;
580
581     ip_src = (m->ip_src_flow ? IP_SRC_FLOW
582               : ipv6_addr_is_set(&m->ipv6_src) ? IP_SRC_CFG
583               : IP_SRC_ANY);
584
585     return &tnl_match_maps[6 * m->in_key_flow + 3 * m->ip_dst_flow + ip_src];
586 }
587
588 static void
589 tnl_match_fmt(const struct tnl_match *match, struct ds *ds)
590     OVS_REQ_RDLOCK(rwlock)
591 {
592     if (!match->ip_dst_flow) {
593         ipv6_format_mapped(&match->ipv6_src, ds);
594         ds_put_cstr(ds, "->");
595         ipv6_format_mapped(&match->ipv6_dst, ds);
596     } else if (!match->ip_src_flow) {
597         ipv6_format_mapped(&match->ipv6_src, ds);
598         ds_put_cstr(ds, "->flow");
599     } else {
600         ds_put_cstr(ds, "flow->flow");
601     }
602
603     if (match->in_key_flow) {
604         ds_put_cstr(ds, ", key=flow");
605     } else {
606         ds_put_format(ds, ", key=%#"PRIx64, ntohll(match->in_key));
607     }
608
609     ds_put_format(ds, ", dp port=%"PRIu32, match->odp_port);
610     ds_put_format(ds, ", pkt mark=%"PRIu32, match->pkt_mark);
611 }
612
613 static void
614 tnl_port_mod_log(const struct tnl_port *tnl_port, const char *action)
615     OVS_REQ_RDLOCK(rwlock)
616 {
617     if (VLOG_IS_DBG_ENABLED()) {
618         struct ds ds = DS_EMPTY_INITIALIZER;
619
620         tnl_match_fmt(&tnl_port->match, &ds);
621         VLOG_INFO("%s tunnel port %s (%s)", action,
622                   tnl_port_get_name(tnl_port), ds_cstr(&ds));
623         ds_destroy(&ds);
624     }
625 }
626
627 static char *
628 tnl_port_fmt(const struct tnl_port *tnl_port) OVS_REQ_RDLOCK(rwlock)
629 {
630     const struct netdev_tunnel_config *cfg =
631         netdev_get_tunnel_config(tnl_port->netdev);
632     struct ds ds = DS_EMPTY_INITIALIZER;
633
634     ds_put_format(&ds, "port %"PRIu32": %s (%s: ", tnl_port->match.odp_port,
635                   tnl_port_get_name(tnl_port),
636                   netdev_get_type(tnl_port->netdev));
637     tnl_match_fmt(&tnl_port->match, &ds);
638
639     if (cfg->out_key != cfg->in_key ||
640         cfg->out_key_present != cfg->in_key_present ||
641         cfg->out_key_flow != cfg->in_key_flow) {
642         ds_put_cstr(&ds, ", out_key=");
643         if (!cfg->out_key_present) {
644             ds_put_cstr(&ds, "none");
645         } else if (cfg->out_key_flow) {
646             ds_put_cstr(&ds, "flow");
647         } else {
648             ds_put_format(&ds, "%#"PRIx64, ntohll(cfg->out_key));
649         }
650     }
651
652     if (cfg->ttl_inherit) {
653         ds_put_cstr(&ds, ", ttl=inherit");
654     } else {
655         ds_put_format(&ds, ", ttl=%"PRIu8, cfg->ttl);
656     }
657
658     if (cfg->tos_inherit) {
659         ds_put_cstr(&ds, ", tos=inherit");
660     } else if (cfg->tos) {
661         ds_put_format(&ds, ", tos=%#"PRIx8, cfg->tos);
662     }
663
664     if (!cfg->dont_fragment) {
665         ds_put_cstr(&ds, ", df=false");
666     }
667
668     if (cfg->csum) {
669         ds_put_cstr(&ds, ", csum=true");
670     }
671
672     ds_put_cstr(&ds, ")\n");
673
674     return ds_steal_cstr(&ds);
675 }
676
677 static const char *
678 tnl_port_get_name(const struct tnl_port *tnl_port) OVS_REQ_RDLOCK(rwlock)
679 {
680     return netdev_get_name(tnl_port->netdev);
681 }
682
683 int
684 tnl_port_build_header(const struct ofport_dpif *ofport,
685                       const struct flow *tnl_flow,
686                       const struct eth_addr dmac,
687                       const struct eth_addr smac,
688                       const struct in6_addr * ipv6_src,
689                       struct ovs_action_push_tnl *data)
690 {
691     struct tnl_port *tnl_port;
692     struct eth_header *eth;
693     struct ip_header *ip;
694     struct ovs_16aligned_ip6_hdr *ip6;
695     void *l3;
696     int res;
697     ovs_be32 ip_src;
698
699     fat_rwlock_rdlock(&rwlock);
700     tnl_port = tnl_find_ofport(ofport);
701     ovs_assert(tnl_port);
702
703     ip_src = in6_addr_get_mapped_ipv4(ipv6_src);
704
705     /* Build Ethernet and IP headers. */
706     memset(data->header, 0, sizeof data->header);
707
708     eth = (struct eth_header *)data->header;
709     eth->eth_dst = dmac;
710     eth->eth_src = smac;
711     eth->eth_type = ip_src ? htons(ETH_TYPE_IP) : htons(ETH_TYPE_IPV6);
712
713     l3 = (eth + 1);
714
715     if (ip_src) {
716         ip = (struct ip_header *) l3;
717
718         ip->ip_ihl_ver = IP_IHL_VER(5, 4);
719         ip->ip_tos = tnl_flow->tunnel.ip_tos;
720         ip->ip_ttl = tnl_flow->tunnel.ip_ttl;
721         ip->ip_frag_off = (tnl_flow->tunnel.flags & FLOW_TNL_F_DONT_FRAGMENT) ?
722                           htons(IP_DF) : 0;
723
724         put_16aligned_be32(&ip->ip_src, ip_src);
725         put_16aligned_be32(&ip->ip_dst, tnl_flow->tunnel.ip_dst);
726     } else {
727         ip6 = (struct ovs_16aligned_ip6_hdr *) l3;
728
729         ip6->ip6_vfc = 0x60;
730         ip6->ip6_hlim = tnl_flow->tunnel.ip_ttl;
731
732         /* next header, plen - at netdev_build_header? */
733
734         memcpy(&ip6->ip6_src, ipv6_src, sizeof(ovs_be32[4]));
735         memcpy(&ip6->ip6_dst, &tnl_flow->tunnel.ipv6_dst, sizeof(ovs_be32[4]));
736     }
737
738     res = netdev_build_header(tnl_port->netdev, data, tnl_flow);
739
740     if (ip_src) {
741         ip->ip_csum = csum(ip, sizeof *ip);
742     }
743
744     fat_rwlock_unlock(&rwlock);
745
746     return res;
747 }