lib/flow.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 #include <config.h>
  17 #include <sys/types.h>
  18 #include "flow.h"
  19 #include <errno.h>
  20 #include <inttypes.h>
  21 #include <limits.h>
  22 #include <netinet/in.h>
  23 #include <netinet/icmp6.h>
  24 #include <netinet/ip6.h>
  25 #include <stdint.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include "byte-order.h"
  29 #include "coverage.h"
  30 #include "csum.h"
  31 #include "dynamic-string.h"
  32 #include "hash.h"
  33 #include "jhash.h"
  34 #include "match.h"
  35 #include "dp-packet.h"
  36 #include "openflow/openflow.h"
  37 #include "packets.h"
  38 #include "odp-util.h"
  39 #include "random.h"
  40 #include "unaligned.h"
  41
  42 COVERAGE_DEFINE(flow_extract);
  43 COVERAGE_DEFINE(miniflow_malloc);
  44
  45 /* U64 indices for segmented flow classification. */
  46 const uint8_t flow_segment_u64s[4] = {
  47     FLOW_SEGMENT_1_ENDS_AT / sizeof(uint64_t),
  48     FLOW_SEGMENT_2_ENDS_AT / sizeof(uint64_t),
  49     FLOW_SEGMENT_3_ENDS_AT / sizeof(uint64_t),
  50     FLOW_U64S
  51 };
  52
  53 /* Asserts that field 'f1' follows immediately after 'f0' in struct flow,
  54  * without any intervening padding. */
  55 #define ASSERT_SEQUENTIAL(f0, f1)                       \
  56     BUILD_ASSERT_DECL(offsetof(struct flow, f0)         \
  57                       + MEMBER_SIZEOF(struct flow, f0)  \
  58                       == offsetof(struct flow, f1))
  59
  60 /* Asserts that fields 'f0' and 'f1' are in the same 32-bit aligned word within
  61  * struct flow. */
  62 #define ASSERT_SAME_WORD(f0, f1)                        \
  63     BUILD_ASSERT_DECL(offsetof(struct flow, f0) / 4     \
  64                       == offsetof(struct flow, f1) / 4)
  65
  66 /* Asserts that 'f0' and 'f1' are both sequential and within the same 32-bit
  67  * aligned word in struct flow. */
  68 #define ASSERT_SEQUENTIAL_SAME_WORD(f0, f1)     \
  69     ASSERT_SEQUENTIAL(f0, f1);                  \
  70     ASSERT_SAME_WORD(f0, f1)
  71
  72 /* miniflow_extract() assumes the following to be true to optimize the
  73  * extraction process. */
  74 ASSERT_SEQUENTIAL_SAME_WORD(dl_type, vlan_tci);
  75
  76 ASSERT_SEQUENTIAL_SAME_WORD(nw_frag, nw_tos);
  77 ASSERT_SEQUENTIAL_SAME_WORD(nw_tos, nw_ttl);
  78 ASSERT_SEQUENTIAL_SAME_WORD(nw_ttl, nw_proto);
  79
  80 /* TCP flags in the middle of a BE64, zeroes in the other half. */
  81 BUILD_ASSERT_DECL(offsetof(struct flow, tcp_flags) % 8 == 4);
  82
  83 #if WORDS_BIGENDIAN
  84 #define TCP_FLAGS_BE32(tcp_ctl) ((OVS_FORCE ovs_be32)TCP_FLAGS_BE16(tcp_ctl) \
  85                                  << 16)
  86 #else
  87 #define TCP_FLAGS_BE32(tcp_ctl) ((OVS_FORCE ovs_be32)TCP_FLAGS_BE16(tcp_ctl))
  88 #endif
  89
  90 ASSERT_SEQUENTIAL_SAME_WORD(tp_src, tp_dst);
  91
  92 /* Removes 'size' bytes from the head end of '*datap', of size '*sizep', which
  93  * must contain at least 'size' bytes of data.  Returns the first byte of data
  94  * removed. */
  95 static inline const void *
  96 data_pull(const void **datap, size_t *sizep, size_t size)
  97 {
  98     const char *data = *datap;
  99     *datap = data + size;
 100     *sizep -= size;
 101     return data;
 102 }
 103
 104 /* If '*datap' has at least 'size' bytes of data, removes that many bytes from
 105  * the head end of '*datap' and returns the first byte removed.  Otherwise,
 106  * returns a null pointer without modifying '*datap'. */
 107 static inline const void *
 108 data_try_pull(const void **datap, size_t *sizep, size_t size)
 109 {
 110     return OVS_LIKELY(*sizep >= size) ? data_pull(datap, sizep, size) : NULL;
 111 }
 112
 113 /* Context for pushing data to a miniflow. */
 114 struct mf_ctx {
 115     struct miniflow maps;
 116     uint64_t *data;
 117     uint64_t * const end;
 118 };
 119
 120 /* miniflow_push_* macros allow filling in a miniflow data values in order.
 121  * Assertions are needed only when the layout of the struct flow is modified.
 122  * 'ofs' is a compile-time constant, which allows most of the code be optimized
 123  * away.  Some GCC versions gave warnings on ALWAYS_INLINE, so these are
 124  * defined as macros. */
 125
 126 #if (FLOW_WC_SEQ != 33)
 127 #define MINIFLOW_ASSERT(X) ovs_assert(X)
 128 BUILD_MESSAGE("FLOW_WC_SEQ changed: miniflow_extract() will have runtime "
 129                "assertions enabled. Consider updating FLOW_WC_SEQ after "
 130                "testing")
 131 #else
 132 #define MINIFLOW_ASSERT(X)
 133 #endif
 134
 135 #define miniflow_set_map(MF, OFS)                                       \
 136     if ((OFS) < FLOW_TNL_U64S) {                                        \
 137         MINIFLOW_ASSERT(!(MF.maps.tnl_map & (UINT64_MAX << (OFS)))      \
 138                         && !MF.maps.pkt_map);                           \
 139         MF.maps.tnl_map |= UINT64_C(1) << (OFS);                        \
 140     } else {                                                            \
 141         MINIFLOW_ASSERT(!(MF.maps.pkt_map                               \
 142                           & UINT64_MAX << ((OFS) - FLOW_TNL_U64S)));    \
 143         MF.maps.pkt_map |= UINT64_C(1) << ((OFS) - FLOW_TNL_U64S);      \
 144     }
 145
 146 #define miniflow_assert_in_map(MF, OFS)                                 \
 147     if ((OFS) < FLOW_TNL_U64S) {                                        \
 148         MINIFLOW_ASSERT(MF.maps.tnl_map & UINT64_C(1) << (OFS)          \
 149                         && !(MF.maps.tnl_map & UINT64_MAX << ((OFS) + 1)) \
 150                         && !MF.maps.pkt_map);                           \
 151     } else {                                                            \
 152         MINIFLOW_ASSERT(MF.maps.pkt_map & UINT64_C(1) << ((OFS) - FLOW_TNL_U64S) \
 153                         && !(MF.maps.pkt_map & UINT64_MAX << ((OFS) - FLOW_TNL_U64S + 1))); \
 154     }
 155
 156 #define miniflow_push_uint64_(MF, OFS, VALUE)                           \
 157 {                                                                       \
 158     MINIFLOW_ASSERT(MF.data < MF.end && (OFS) % 8 == 0);                \
 159     *MF.data++ = VALUE;                                                 \
 160     miniflow_set_map(MF, OFS / 8);                                          \
 161 }
 162
 163 #define miniflow_push_be64_(MF, OFS, VALUE) \
 164     miniflow_push_uint64_(MF, OFS, (OVS_FORCE uint64_t)(VALUE))
 165
 166 #define miniflow_push_uint32_(MF, OFS, VALUE)                           \
 167     {                                                                   \
 168     MINIFLOW_ASSERT(MF.data < MF.end);                                  \
 169                                                                         \
 170     if ((OFS) % 8 == 0) {                                               \
 171         miniflow_set_map(MF, OFS / 8);                                  \
 172         *(uint32_t *)MF.data = VALUE;                                   \
 173     } else if ((OFS) % 8 == 4) {                                        \
 174         miniflow_assert_in_map(MF, OFS / 8);                            \
 175         *((uint32_t *)MF.data + 1) = VALUE;                             \
 176         MF.data++;                                                      \
 177     }                                                                   \
 178 }
 179
 180 #define miniflow_push_be32_(MF, OFS, VALUE)                     \
 181     miniflow_push_uint32_(MF, OFS, (OVS_FORCE uint32_t)(VALUE))
 182
 183 #define miniflow_push_uint16_(MF, OFS, VALUE)                           \
 184 {                                                                       \
 185     MINIFLOW_ASSERT(MF.data < MF.end);                                  \
 186                                                                         \
 187     if ((OFS) % 8 == 0) {                                               \
 188         miniflow_set_map(MF, OFS / 8);                                  \
 189         *(uint16_t *)MF.data = VALUE;                                   \
 190     } else if ((OFS) % 8 == 2) {                                        \
 191         miniflow_assert_in_map(MF, OFS / 8);                            \
 192         *((uint16_t *)MF.data + 1) = VALUE;                             \
 193     } else if ((OFS) % 8 == 4) {                                        \
 194         miniflow_assert_in_map(MF, OFS / 8);                            \
 195         *((uint16_t *)MF.data + 2) = VALUE;                             \
 196     } else if ((OFS) % 8 == 6) {                                        \
 197         miniflow_assert_in_map(MF, OFS / 8);                            \
 198         *((uint16_t *)MF.data + 3) = VALUE;                             \
 199         MF.data++;                                                      \
 200     }                                                                   \
 201 }
 202
 203 #define miniflow_pad_to_64_(MF, OFS)                                    \
 204 {                                                                       \
 205     MINIFLOW_ASSERT((OFS) % 8 != 0);                                    \
 206     miniflow_assert_in_map(MF, OFS / 8);                                \
 207                                                                         \
 208     memset((uint8_t *)MF.data + (OFS) % 8, 0, 8 - (OFS) % 8);           \
 209     MF.data++;                                                          \
 210 }
 211
 212 #define miniflow_push_be16_(MF, OFS, VALUE)                     \
 213     miniflow_push_uint16_(MF, OFS, (OVS_FORCE uint16_t)VALUE);
 214
 215 #define miniflow_set_maps(MF, OFS, N_WORDS)                             \
 216 {                                                                       \
 217     size_t ofs = (OFS);                                                 \
 218     size_t n_words = (N_WORDS);                                         \
 219     uint64_t n_words_mask = UINT64_MAX >> (64 - n_words);               \
 220                                                                         \
 221     MINIFLOW_ASSERT(n_words && MF.data + n_words <= MF.end);            \
 222     if (ofs < FLOW_TNL_U64S) {                                          \
 223         MINIFLOW_ASSERT(!(MF.maps.tnl_map & UINT64_MAX << ofs)          \
 224                         && !MF.maps.pkt_map);                           \
 225         MF.maps.tnl_map |= n_words_mask << ofs;                         \
 226         if (n_words > FLOW_TNL_U64S - ofs) {                            \
 227             MF.maps.pkt_map |= n_words_mask >> (FLOW_TNL_U64S - ofs);   \
 228         }                                                               \
 229     } else {                                                            \
 230         ofs -= FLOW_TNL_U64S;                                           \
 231         MINIFLOW_ASSERT(!(MF.maps.pkt_map & (UINT64_MAX << ofs)));      \
 232         MF.maps.pkt_map |= n_words_mask << ofs;                         \
 233     }                                                                   \
 234 }
 235
 236 /* Data at 'valuep' may be unaligned. */
 237 #define miniflow_push_words_(MF, OFS, VALUEP, N_WORDS)          \
 238 {                                                               \
 239     MINIFLOW_ASSERT((OFS) % 8 == 0);                            \
 240     miniflow_set_maps(MF, (OFS) / 8, (N_WORDS));                \
 241     memcpy(MF.data, (VALUEP), (N_WORDS) * sizeof *MF.data);     \
 242     MF.data += (N_WORDS);                                       \
 243 }
 244
 245 /* Push 32-bit words padded to 64-bits. */
 246 #define miniflow_push_words_32_(MF, OFS, VALUEP, N_WORDS)               \
 247 {                                                                       \
 248     miniflow_set_maps(MF, (OFS) / 8, DIV_ROUND_UP(N_WORDS, 2));         \
 249     memcpy(MF.data, (VALUEP), (N_WORDS) * sizeof(uint32_t));            \
 250     MF.data += DIV_ROUND_UP(N_WORDS, 2);                                \
 251     if ((N_WORDS) & 1) {                                                \
 252         *((uint32_t *)MF.data - 1) = 0;                                 \
 253     }                                                                   \
 254 }
 255
 256 /* Data at 'valuep' may be unaligned. */
 257 /* MACs start 64-aligned, and must be followed by other data or padding. */
 258 #define miniflow_push_macs_(MF, OFS, VALUEP)                    \
 259 {                                                               \
 260     miniflow_set_maps(MF, (OFS) / 8, 2);                        \
 261     memcpy(MF.data, (VALUEP), 2 * ETH_ADDR_LEN);                \
 262     MF.data += 1;                   /* First word only. */      \
 263 }
 264
 265 #define miniflow_push_uint32(MF, FIELD, VALUE)                      \
 266     miniflow_push_uint32_(MF, offsetof(struct flow, FIELD), VALUE)
 267
 268 #define miniflow_push_be32(MF, FIELD, VALUE)                        \
 269     miniflow_push_be32_(MF, offsetof(struct flow, FIELD), VALUE)
 270
 271 #define miniflow_push_uint16(MF, FIELD, VALUE)                      \
 272     miniflow_push_uint16_(MF, offsetof(struct flow, FIELD), VALUE)
 273
 274 #define miniflow_push_be16(MF, FIELD, VALUE)                        \
 275     miniflow_push_be16_(MF, offsetof(struct flow, FIELD), VALUE)
 276
 277 #define miniflow_pad_to_64(MF, FIELD)                       \
 278     miniflow_pad_to_64_(MF, offsetof(struct flow, FIELD))
 279
 280 #define miniflow_push_words(MF, FIELD, VALUEP, N_WORDS)                 \
 281     miniflow_push_words_(MF, offsetof(struct flow, FIELD), VALUEP, N_WORDS)
 282
 283 #define miniflow_push_words_32(MF, FIELD, VALUEP, N_WORDS)              \
 284     miniflow_push_words_32_(MF, offsetof(struct flow, FIELD), VALUEP, N_WORDS)
 285
 286 #define miniflow_push_macs(MF, FIELD, VALUEP)                       \
 287     miniflow_push_macs_(MF, offsetof(struct flow, FIELD), VALUEP)
 288
 289 /* Pulls the MPLS headers at '*datap' and returns the count of them. */
 290 static inline int
 291 parse_mpls(const void **datap, size_t *sizep)
 292 {
 293     const struct mpls_hdr *mh;
 294     int count = 0;
 295
 296     while ((mh = data_try_pull(datap, sizep, sizeof *mh))) {
 297         count++;
 298         if (mh->mpls_lse.lo & htons(1 << MPLS_BOS_SHIFT)) {
 299             break;
 300         }
 301     }
 302     return MIN(count, FLOW_MAX_MPLS_LABELS);
 303 }
 304
 305 static inline ovs_be16
 306 parse_vlan(const void **datap, size_t *sizep)
 307 {
 308     const struct eth_header *eth = *datap;
 309
 310     struct qtag_prefix {
 311         ovs_be16 eth_type;      /* ETH_TYPE_VLAN */
 312         ovs_be16 tci;
 313     };
 314
 315     data_pull(datap, sizep, ETH_ADDR_LEN * 2);
 316
 317     if (eth->eth_type == htons(ETH_TYPE_VLAN)) {
 318         if (OVS_LIKELY(*sizep
 319                        >= sizeof(struct qtag_prefix) + sizeof(ovs_be16))) {
 320             const struct qtag_prefix *qp = data_pull(datap, sizep, sizeof *qp);
 321             return qp->tci | htons(VLAN_CFI);
 322         }
 323     }
 324     return 0;
 325 }
 326
 327 static inline ovs_be16
 328 parse_ethertype(const void **datap, size_t *sizep)
 329 {
 330     const struct llc_snap_header *llc;
 331     ovs_be16 proto;
 332
 333     proto = *(ovs_be16 *) data_pull(datap, sizep, sizeof proto);
 334     if (OVS_LIKELY(ntohs(proto) >= ETH_TYPE_MIN)) {
 335         return proto;
 336     }
 337
 338     if (OVS_UNLIKELY(*sizep < sizeof *llc)) {
 339         return htons(FLOW_DL_TYPE_NONE);
 340     }
 341
 342     llc = *datap;
 343     if (OVS_UNLIKELY(llc->llc.llc_dsap != LLC_DSAP_SNAP
 344                      || llc->llc.llc_ssap != LLC_SSAP_SNAP
 345                      || llc->llc.llc_cntl != LLC_CNTL_SNAP
 346                      || memcmp(llc->snap.snap_org, SNAP_ORG_ETHERNET,
 347                                sizeof llc->snap.snap_org))) {
 348         return htons(FLOW_DL_TYPE_NONE);
 349     }
 350
 351     data_pull(datap, sizep, sizeof *llc);
 352
 353     if (OVS_LIKELY(ntohs(llc->snap.snap_type) >= ETH_TYPE_MIN)) {
 354         return llc->snap.snap_type;
 355     }
 356
 357     return htons(FLOW_DL_TYPE_NONE);
 358 }
 359
 360 static inline bool
 361 parse_icmpv6(const void **datap, size_t *sizep, const struct icmp6_hdr *icmp,
 362              const struct in6_addr **nd_target,
 363              uint8_t arp_buf[2][ETH_ADDR_LEN])
 364 {
 365     if (icmp->icmp6_code == 0 &&
 366         (icmp->icmp6_type == ND_NEIGHBOR_SOLICIT ||
 367          icmp->icmp6_type == ND_NEIGHBOR_ADVERT)) {
 368
 369         *nd_target = data_try_pull(datap, sizep, sizeof **nd_target);
 370         if (OVS_UNLIKELY(!*nd_target)) {
 371             return false;
 372         }
 373
 374         while (*sizep >= 8) {
 375             /* The minimum size of an option is 8 bytes, which also is
 376              * the size of Ethernet link-layer options. */
 377             const struct nd_opt_hdr *nd_opt = *datap;
 378             int opt_len = nd_opt->nd_opt_len * 8;
 379
 380             if (!opt_len || opt_len > *sizep) {
 381                 goto invalid;
 382             }
 383
 384             /* Store the link layer address if the appropriate option is
 385              * provided.  It is considered an error if the same link
 386              * layer option is specified twice. */
 387             if (nd_opt->nd_opt_type == ND_OPT_SOURCE_LINKADDR
 388                     && opt_len == 8) {
 389                 if (OVS_LIKELY(eth_addr_is_zero(arp_buf[0]))) {
 390                     memcpy(arp_buf[0], nd_opt + 1, ETH_ADDR_LEN);
 391                 } else {
 392                     goto invalid;
 393                 }
 394             } else if (nd_opt->nd_opt_type == ND_OPT_TARGET_LINKADDR
 395                     && opt_len == 8) {
 396                 if (OVS_LIKELY(eth_addr_is_zero(arp_buf[1]))) {
 397                     memcpy(arp_buf[1], nd_opt + 1, ETH_ADDR_LEN);
 398                 } else {
 399                     goto invalid;
 400                 }
 401             }
 402
 403             if (OVS_UNLIKELY(!data_try_pull(datap, sizep, opt_len))) {
 404                 goto invalid;
 405             }
 406         }
 407     }
 408
 409     return true;
 410
 411 invalid:
 412     return false;
 413 }
 414
 415 /* Initializes 'flow' members from 'packet' and 'md'
 416  *
 417  * Initializes 'packet' header l2 pointer to the start of the Ethernet
 418  * header, and the layer offsets as follows:
 419  *
 420  *    - packet->l2_5_ofs to the start of the MPLS shim header, or UINT16_MAX
 421  *      when there is no MPLS shim header.
 422  *
 423  *    - packet->l3_ofs to just past the Ethernet header, or just past the
 424  *      vlan_header if one is present, to the first byte of the payload of the
 425  *      Ethernet frame.  UINT16_MAX if the frame is too short to contain an
 426  *      Ethernet header.
 427  *
 428  *    - packet->l4_ofs to just past the IPv4 header, if one is present and
 429  *      has at least the content used for the fields of interest for the flow,
 430  *      otherwise UINT16_MAX.
 431  */
 432 void
 433 flow_extract(struct dp_packet *packet, struct flow *flow)
 434 {
 435     struct {
 436         struct miniflow mf;
 437         uint64_t buf[FLOW_U64S];
 438     } m;
 439
 440     COVERAGE_INC(flow_extract);
 441
 442     miniflow_extract(packet, &m.mf);
 443     miniflow_expand(&m.mf, flow);
 444 }
 445
 446 /* Caller is responsible for initializing 'dst' with enough storage for
 447  * FLOW_U64S * 8 bytes. */
 448 void
 449 miniflow_extract(struct dp_packet *packet, struct miniflow *dst)
 450 {
 451     const struct pkt_metadata *md = &packet->md;
 452     const void *data = dp_packet_data(packet);
 453     size_t size = dp_packet_size(packet);
 454     uint64_t *values = miniflow_values(dst);
 455     struct mf_ctx mf = { { 0, 0 }, values, values + FLOW_U64S };
 456     const char *l2;
 457     ovs_be16 dl_type;
 458     uint8_t nw_frag, nw_tos, nw_ttl, nw_proto;
 459
 460     /* Metadata. */
 461     if (md->tunnel.ip_dst) {
 462         miniflow_push_words(mf, tunnel, &md->tunnel,
 463                             offsetof(struct flow_tnl, metadata) /
 464                             sizeof(uint64_t));
 465
 466         if (!(md->tunnel.flags & FLOW_TNL_F_UDPIF)) {
 467             if (md->tunnel.metadata.present.map) {
 468                 miniflow_push_words(mf, tunnel.metadata, &md->tunnel.metadata,
 469                                     sizeof md->tunnel.metadata /
 470                                     sizeof(uint64_t));
 471             }
 472         } else {
 473             if (md->tunnel.metadata.present.len) {
 474                 miniflow_push_words(mf, tunnel.metadata.present,
 475                                     &md->tunnel.metadata.present, 1);
 476                 miniflow_push_words(mf, tunnel.metadata.opts.gnv,
 477                                     md->tunnel.metadata.opts.gnv,
 478                                     DIV_ROUND_UP(md->tunnel.metadata.present.len,
 479                                                  sizeof(uint64_t)));
 480             }
 481         }
 482     }
 483     if (md->skb_priority || md->pkt_mark) {
 484         miniflow_push_uint32(mf, skb_priority, md->skb_priority);
 485         miniflow_push_uint32(mf, pkt_mark, md->pkt_mark);
 486     }
 487     miniflow_push_uint32(mf, dp_hash, md->dp_hash);
 488     miniflow_push_uint32(mf, in_port, odp_to_u32(md->in_port.odp_port));
 489     if (md->recirc_id) {
 490         miniflow_push_uint32(mf, recirc_id, md->recirc_id);
 491         miniflow_pad_to_64(mf, conj_id);
 492     }
 493
 494     /* Initialize packet's layer pointer and offsets. */
 495     l2 = data;
 496     dp_packet_reset_offsets(packet);
 497
 498     /* Must have full Ethernet header to proceed. */
 499     if (OVS_UNLIKELY(size < sizeof(struct eth_header))) {
 500         goto out;
 501     } else {
 502         ovs_be16 vlan_tci;
 503
 504         /* Link layer. */
 505         ASSERT_SEQUENTIAL(dl_dst, dl_src);
 506         miniflow_push_macs(mf, dl_dst, data);
 507         /* dl_type, vlan_tci. */
 508         vlan_tci = parse_vlan(&data, &size);
 509         dl_type = parse_ethertype(&data, &size);
 510         miniflow_push_be16(mf, dl_type, dl_type);
 511         miniflow_push_be16(mf, vlan_tci, vlan_tci);
 512     }
 513
 514     /* Parse mpls. */
 515     if (OVS_UNLIKELY(eth_type_mpls(dl_type))) {
 516         int count;
 517         const void *mpls = data;
 518
 519         packet->l2_5_ofs = (char *)data - l2;
 520         count = parse_mpls(&data, &size);
 521         miniflow_push_words_32(mf, mpls_lse, mpls, count);
 522     }
 523
 524     /* Network layer. */
 525     packet->l3_ofs = (char *)data - l2;
 526
 527     nw_frag = 0;
 528     if (OVS_LIKELY(dl_type == htons(ETH_TYPE_IP))) {
 529         const struct ip_header *nh = data;
 530         int ip_len;
 531         uint16_t tot_len;
 532
 533         if (OVS_UNLIKELY(size < IP_HEADER_LEN)) {
 534             goto out;
 535         }
 536         ip_len = IP_IHL(nh->ip_ihl_ver) * 4;
 537
 538         if (OVS_UNLIKELY(ip_len < IP_HEADER_LEN)) {
 539             goto out;
 540         }
 541         if (OVS_UNLIKELY(size < ip_len)) {
 542             goto out;
 543         }
 544         tot_len = ntohs(nh->ip_tot_len);
 545         if (OVS_UNLIKELY(tot_len > size)) {
 546             goto out;
 547         }
 548         if (OVS_UNLIKELY(size - tot_len > UINT8_MAX)) {
 549             goto out;
 550         }
 551         dp_packet_set_l2_pad_size(packet, size - tot_len);
 552         size = tot_len;   /* Never pull padding. */
 553
 554         /* Push both source and destination address at once. */
 555         miniflow_push_words(mf, nw_src, &nh->ip_src, 1);
 556
 557         miniflow_push_be32(mf, ipv6_label, 0); /* Padding for IPv4. */
 558
 559         nw_tos = nh->ip_tos;
 560         nw_ttl = nh->ip_ttl;
 561         nw_proto = nh->ip_proto;
 562         if (OVS_UNLIKELY(IP_IS_FRAGMENT(nh->ip_frag_off))) {
 563             nw_frag = FLOW_NW_FRAG_ANY;
 564             if (nh->ip_frag_off & htons(IP_FRAG_OFF_MASK)) {
 565                 nw_frag |= FLOW_NW_FRAG_LATER;
 566             }
 567         }
 568         data_pull(&data, &size, ip_len);
 569     } else if (dl_type == htons(ETH_TYPE_IPV6)) {
 570         const struct ovs_16aligned_ip6_hdr *nh;
 571         ovs_be32 tc_flow;
 572         uint16_t plen;
 573
 574         if (OVS_UNLIKELY(size < sizeof *nh)) {
 575             goto out;
 576         }
 577         nh = data_pull(&data, &size, sizeof *nh);
 578
 579         plen = ntohs(nh->ip6_plen);
 580         if (OVS_UNLIKELY(plen > size)) {
 581             goto out;
 582         }
 583         /* Jumbo Payload option not supported yet. */
 584         if (OVS_UNLIKELY(size - plen > UINT8_MAX)) {
 585             goto out;
 586         }
 587         dp_packet_set_l2_pad_size(packet, size - plen);
 588         size = plen;   /* Never pull padding. */
 589
 590         miniflow_push_words(mf, ipv6_src, &nh->ip6_src,
 591                             sizeof nh->ip6_src / 8);
 592         miniflow_push_words(mf, ipv6_dst, &nh->ip6_dst,
 593                             sizeof nh->ip6_dst / 8);
 594
 595         tc_flow = get_16aligned_be32(&nh->ip6_flow);
 596         {
 597             ovs_be32 label = tc_flow & htonl(IPV6_LABEL_MASK);
 598             miniflow_push_be32(mf, ipv6_label, label);
 599         }
 600
 601         nw_tos = ntohl(tc_flow) >> 20;
 602         nw_ttl = nh->ip6_hlim;
 603         nw_proto = nh->ip6_nxt;
 604
 605         while (1) {
 606             if (OVS_LIKELY((nw_proto != IPPROTO_HOPOPTS)
 607                            && (nw_proto != IPPROTO_ROUTING)
 608                            && (nw_proto != IPPROTO_DSTOPTS)
 609                            && (nw_proto != IPPROTO_AH)
 610                            && (nw_proto != IPPROTO_FRAGMENT))) {
 611                 /* It's either a terminal header (e.g., TCP, UDP) or one we
 612                  * don't understand.  In either case, we're done with the
 613                  * packet, so use it to fill in 'nw_proto'. */
 614                 break;
 615             }
 616
 617             /* We only verify that at least 8 bytes of the next header are
 618              * available, but many of these headers are longer.  Ensure that
 619              * accesses within the extension header are within those first 8
 620              * bytes. All extension headers are required to be at least 8
 621              * bytes. */
 622             if (OVS_UNLIKELY(size < 8)) {
 623                 goto out;
 624             }
 625
 626             if ((nw_proto == IPPROTO_HOPOPTS)
 627                 || (nw_proto == IPPROTO_ROUTING)
 628                 || (nw_proto == IPPROTO_DSTOPTS)) {
 629                 /* These headers, while different, have the fields we care
 630                  * about in the same location and with the same
 631                  * interpretation. */
 632                 const struct ip6_ext *ext_hdr = data;
 633                 nw_proto = ext_hdr->ip6e_nxt;
 634                 if (OVS_UNLIKELY(!data_try_pull(&data, &size,
 635                                                 (ext_hdr->ip6e_len + 1) * 8))) {
 636                     goto out;
 637                 }
 638             } else if (nw_proto == IPPROTO_AH) {
 639                 /* A standard AH definition isn't available, but the fields
 640                  * we care about are in the same location as the generic
 641                  * option header--only the header length is calculated
 642                  * differently. */
 643                 const struct ip6_ext *ext_hdr = data;
 644                 nw_proto = ext_hdr->ip6e_nxt;
 645                 if (OVS_UNLIKELY(!data_try_pull(&data, &size,
 646                                                 (ext_hdr->ip6e_len + 2) * 4))) {
 647                     goto out;
 648                 }
 649             } else if (nw_proto == IPPROTO_FRAGMENT) {
 650                 const struct ovs_16aligned_ip6_frag *frag_hdr = data;
 651
 652                 nw_proto = frag_hdr->ip6f_nxt;
 653                 if (!data_try_pull(&data, &size, sizeof *frag_hdr)) {
 654                     goto out;
 655                 }
 656
 657                 /* We only process the first fragment. */
 658                 if (frag_hdr->ip6f_offlg != htons(0)) {
 659                     nw_frag = FLOW_NW_FRAG_ANY;
 660                     if ((frag_hdr->ip6f_offlg & IP6F_OFF_MASK) != htons(0)) {
 661                         nw_frag |= FLOW_NW_FRAG_LATER;
 662                         nw_proto = IPPROTO_FRAGMENT;
 663                         break;
 664                     }
 665                 }
 666             }
 667         }
 668     } else {
 669         if (dl_type == htons(ETH_TYPE_ARP) ||
 670             dl_type == htons(ETH_TYPE_RARP)) {
 671             uint8_t arp_buf[2][ETH_ADDR_LEN];
 672             const struct arp_eth_header *arp = (const struct arp_eth_header *)
 673                 data_try_pull(&data, &size, ARP_ETH_HEADER_LEN);
 674
 675             if (OVS_LIKELY(arp) && OVS_LIKELY(arp->ar_hrd == htons(1))
 676                 && OVS_LIKELY(arp->ar_pro == htons(ETH_TYPE_IP))
 677                 && OVS_LIKELY(arp->ar_hln == ETH_ADDR_LEN)
 678                 && OVS_LIKELY(arp->ar_pln == 4)) {
 679                 miniflow_push_be32(mf, nw_src,
 680                                    get_16aligned_be32(&arp->ar_spa));
 681                 miniflow_push_be32(mf, nw_dst,
 682                                    get_16aligned_be32(&arp->ar_tpa));
 683
 684                 /* We only match on the lower 8 bits of the opcode. */
 685                 if (OVS_LIKELY(ntohs(arp->ar_op) <= 0xff)) {
 686                     miniflow_push_be32(mf, ipv6_label, 0); /* Pad with ARP. */
 687                     miniflow_push_be32(mf, nw_frag, htonl(ntohs(arp->ar_op)));
 688                 }
 689
 690                 /* Must be adjacent. */
 691                 ASSERT_SEQUENTIAL(arp_sha, arp_tha);
 692
 693                 memcpy(arp_buf[0], arp->ar_sha, ETH_ADDR_LEN);
 694                 memcpy(arp_buf[1], arp->ar_tha, ETH_ADDR_LEN);
 695                 miniflow_push_macs(mf, arp_sha, arp_buf);
 696                 miniflow_pad_to_64(mf, tcp_flags);
 697             }
 698         }
 699         goto out;
 700     }
 701
 702     packet->l4_ofs = (char *)data - l2;
 703     miniflow_push_be32(mf, nw_frag,
 704                        BYTES_TO_BE32(nw_frag, nw_tos, nw_ttl, nw_proto));
 705
 706     if (OVS_LIKELY(!(nw_frag & FLOW_NW_FRAG_LATER))) {
 707         if (OVS_LIKELY(nw_proto == IPPROTO_TCP)) {
 708             if (OVS_LIKELY(size >= TCP_HEADER_LEN)) {
 709                 const struct tcp_header *tcp = data;
 710
 711                 miniflow_push_be32(mf, arp_tha[2], 0);
 712                 miniflow_push_be32(mf, tcp_flags,
 713                                    TCP_FLAGS_BE32(tcp->tcp_ctl));
 714                 miniflow_push_be16(mf, tp_src, tcp->tcp_src);
 715                 miniflow_push_be16(mf, tp_dst, tcp->tcp_dst);
 716                 miniflow_pad_to_64(mf, igmp_group_ip4);
 717             }
 718         } else if (OVS_LIKELY(nw_proto == IPPROTO_UDP)) {
 719             if (OVS_LIKELY(size >= UDP_HEADER_LEN)) {
 720                 const struct udp_header *udp = data;
 721
 722                 miniflow_push_be16(mf, tp_src, udp->udp_src);
 723                 miniflow_push_be16(mf, tp_dst, udp->udp_dst);
 724                 miniflow_pad_to_64(mf, igmp_group_ip4);
 725             }
 726         } else if (OVS_LIKELY(nw_proto == IPPROTO_SCTP)) {
 727             if (OVS_LIKELY(size >= SCTP_HEADER_LEN)) {
 728                 const struct sctp_header *sctp = data;
 729
 730                 miniflow_push_be16(mf, tp_src, sctp->sctp_src);
 731                 miniflow_push_be16(mf, tp_dst, sctp->sctp_dst);
 732                 miniflow_pad_to_64(mf, igmp_group_ip4);
 733             }
 734         } else if (OVS_LIKELY(nw_proto == IPPROTO_ICMP)) {
 735             if (OVS_LIKELY(size >= ICMP_HEADER_LEN)) {
 736                 const struct icmp_header *icmp = data;
 737
 738                 miniflow_push_be16(mf, tp_src, htons(icmp->icmp_type));
 739                 miniflow_push_be16(mf, tp_dst, htons(icmp->icmp_code));
 740                 miniflow_pad_to_64(mf, igmp_group_ip4);
 741             }
 742         } else if (OVS_LIKELY(nw_proto == IPPROTO_IGMP)) {
 743             if (OVS_LIKELY(size >= IGMP_HEADER_LEN)) {
 744                 const struct igmp_header *igmp = data;
 745
 746                 miniflow_push_be16(mf, tp_src, htons(igmp->igmp_type));
 747                 miniflow_push_be16(mf, tp_dst, htons(igmp->igmp_code));
 748                 miniflow_push_be32(mf, igmp_group_ip4,
 749                                    get_16aligned_be32(&igmp->group));
 750             }
 751         } else if (OVS_LIKELY(nw_proto == IPPROTO_ICMPV6)) {
 752             if (OVS_LIKELY(size >= sizeof(struct icmp6_hdr))) {
 753                 const struct in6_addr *nd_target = NULL;
 754                 uint8_t arp_buf[2][ETH_ADDR_LEN];
 755                 const struct icmp6_hdr *icmp = data_pull(&data, &size,
 756                                                          sizeof *icmp);
 757                 memset(arp_buf, 0, sizeof arp_buf);
 758                 if (OVS_LIKELY(parse_icmpv6(&data, &size, icmp, &nd_target,
 759                                             arp_buf))) {
 760                     if (nd_target) {
 761                         miniflow_push_words(mf, nd_target, nd_target,
 762                                             sizeof *nd_target / 8);
 763                     }
 764                     miniflow_push_macs(mf, arp_sha, arp_buf);
 765                     miniflow_pad_to_64(mf, tcp_flags);
 766                     miniflow_push_be16(mf, tp_src, htons(icmp->icmp6_type));
 767                     miniflow_push_be16(mf, tp_dst, htons(icmp->icmp6_code));
 768                     miniflow_pad_to_64(mf, igmp_group_ip4);
 769                 }
 770             }
 771         }
 772     }
 773  out:
 774     *dst = mf.maps;
 775 }
 776
 777 /* For every bit of a field that is wildcarded in 'wildcards', sets the
 778  * corresponding bit in 'flow' to zero. */
 779 void
 780 flow_zero_wildcards(struct flow *flow, const struct flow_wildcards *wildcards)
 781 {
 782     uint64_t *flow_u64 = (uint64_t *) flow;
 783     const uint64_t *wc_u64 = (const uint64_t *) &wildcards->masks;
 784     size_t i;
 785
 786     for (i = 0; i < FLOW_U64S; i++) {
 787         flow_u64[i] &= wc_u64[i];
 788     }
 789 }
 790
 791 void
 792 flow_unwildcard_tp_ports(const struct flow *flow, struct flow_wildcards *wc)
 793 {
 794     if (flow->nw_proto != IPPROTO_ICMP) {
 795         memset(&wc->masks.tp_src, 0xff, sizeof wc->masks.tp_src);
 796         memset(&wc->masks.tp_dst, 0xff, sizeof wc->masks.tp_dst);
 797     } else {
 798         wc->masks.tp_src = htons(0xff);
 799         wc->masks.tp_dst = htons(0xff);
 800     }
 801 }
 802
 803 /* Initializes 'flow_metadata' with the metadata found in 'flow'. */
 804 void
 805 flow_get_metadata(const struct flow *flow, struct match *flow_metadata)
 806 {
 807     int i;
 808
 809     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 33);
 810
 811     match_init_catchall(flow_metadata);
 812     if (flow->tunnel.tun_id != htonll(0)) {
 813         match_set_tun_id(flow_metadata, flow->tunnel.tun_id);
 814     }
 815     if (flow->tunnel.flags & FLOW_TNL_PUB_F_MASK) {
 816         match_set_tun_flags(flow_metadata,
 817                             flow->tunnel.flags & FLOW_TNL_PUB_F_MASK);
 818     }
 819     if (flow->tunnel.ip_src != htonl(0)) {
 820         match_set_tun_src(flow_metadata, flow->tunnel.ip_src);
 821     }
 822     if (flow->tunnel.ip_dst != htonl(0)) {
 823         match_set_tun_dst(flow_metadata, flow->tunnel.ip_dst);
 824     }
 825     if (flow->tunnel.gbp_id != htons(0)) {
 826         match_set_tun_gbp_id(flow_metadata, flow->tunnel.gbp_id);
 827     }
 828     if (flow->tunnel.gbp_flags) {
 829         match_set_tun_gbp_flags(flow_metadata, flow->tunnel.gbp_flags);
 830     }
 831     tun_metadata_get_fmd(&flow->tunnel, flow_metadata);
 832     if (flow->metadata != htonll(0)) {
 833         match_set_metadata(flow_metadata, flow->metadata);
 834     }
 835
 836     for (i = 0; i < FLOW_N_REGS; i++) {
 837         if (flow->regs[i]) {
 838             match_set_reg(flow_metadata, i, flow->regs[i]);
 839         }
 840     }
 841
 842     if (flow->pkt_mark != 0) {
 843         match_set_pkt_mark(flow_metadata, flow->pkt_mark);
 844     }
 845
 846     match_set_in_port(flow_metadata, flow->in_port.ofp_port);
 847 }
 848
 849 char *
 850 flow_to_string(const struct flow *flow)
 851 {
 852     struct ds ds = DS_EMPTY_INITIALIZER;
 853     flow_format(&ds, flow);
 854     return ds_cstr(&ds);
 855 }
 856
 857 const char *
 858 flow_tun_flag_to_string(uint32_t flags)
 859 {
 860     switch (flags) {
 861     case FLOW_TNL_F_DONT_FRAGMENT:
 862         return "df";
 863     case FLOW_TNL_F_CSUM:
 864         return "csum";
 865     case FLOW_TNL_F_KEY:
 866         return "key";
 867     case FLOW_TNL_F_OAM:
 868         return "oam";
 869     default:
 870         return NULL;
 871     }
 872 }
 873
 874 void
 875 format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t),
 876              uint32_t flags, char del)
 877 {
 878     uint32_t bad = 0;
 879
 880     if (!flags) {
 881         ds_put_char(ds, '0');
 882         return;
 883     }
 884     while (flags) {
 885         uint32_t bit = rightmost_1bit(flags);
 886         const char *s;
 887
 888         s = bit_to_string(bit);
 889         if (s) {
 890             ds_put_format(ds, "%s%c", s, del);
 891         } else {
 892             bad |= bit;
 893         }
 894
 895         flags &= ~bit;
 896     }
 897
 898     if (bad) {
 899         ds_put_format(ds, "0x%"PRIx32"%c", bad, del);
 900     }
 901     ds_chomp(ds, del);
 902 }
 903
 904 void
 905 format_flags_masked(struct ds *ds, const char *name,
 906                     const char *(*bit_to_string)(uint32_t), uint32_t flags,
 907                     uint32_t mask, uint32_t max_mask)
 908 {
 909     if (name) {
 910         ds_put_format(ds, "%s=", name);
 911     }
 912
 913     if (mask == max_mask) {
 914         format_flags(ds, bit_to_string, flags, '|');
 915         return;
 916     }
 917
 918     if (!mask) {
 919         ds_put_cstr(ds, "0/0");
 920         return;
 921     }
 922
 923     while (mask) {
 924         uint32_t bit = rightmost_1bit(mask);
 925         const char *s = bit_to_string(bit);
 926
 927         ds_put_format(ds, "%s%s", (flags & bit) ? "+" : "-",
 928                       s ? s : "[Unknown]");
 929         mask &= ~bit;
 930     }
 931 }
 932
 933 /* Scans a string 's' of flags to determine their numerical value and
 934  * returns the number of characters parsed using 'bit_to_string' to
 935  * lookup flag names. Scanning continues until the character 'end' is
 936  * reached.
 937  *
 938  * In the event of a failure, a negative error code will be returned. In
 939  * addition, if 'res_string' is non-NULL then a descriptive string will
 940  * be returned incorporating the identifying string 'field_name'. This
 941  * error string must be freed by the caller.
 942  *
 943  * Upon success, the flag values will be stored in 'res_flags' and
 944  * optionally 'res_mask', if it is non-NULL (if it is NULL then any masks
 945  * present in the original string will be considered an error). The
 946  * caller may restrict the acceptable set of values through the mask
 947  * 'allowed'. */
 948 int
 949 parse_flags(const char *s, const char *(*bit_to_string)(uint32_t),
 950             char end, const char *field_name, char **res_string,
 951             uint32_t *res_flags, uint32_t allowed, uint32_t *res_mask)
 952 {
 953     uint32_t result = 0;
 954     int n;
 955
 956     /* Parse masked flags in numeric format? */
 957     if (res_mask && ovs_scan(s, "%"SCNi32"/%"SCNi32"%n",
 958                              res_flags, res_mask, &n) && n > 0) {
 959         if (*res_flags & ~allowed || *res_mask & ~allowed) {
 960             goto unknown;
 961         }
 962         return n;
 963     }
 964
 965     n = 0;
 966
 967     if (res_mask && (*s == '+' || *s == '-')) {
 968         uint32_t flags = 0, mask = 0;
 969
 970         /* Parse masked flags. */
 971         while (s[0] != end) {
 972             bool set;
 973             uint32_t bit;
 974             size_t len;
 975
 976             if (s[0] == '+') {
 977                 set = true;
 978             } else if (s[0] == '-') {
 979                 set = false;
 980             } else {
 981                 if (res_string) {
 982                     *res_string = xasprintf("%s: %s must be preceded by '+' "
 983                                             "(for SET) or '-' (NOT SET)", s,
 984                                             field_name);
 985                 }
 986                 return -EINVAL;
 987             }
 988             s++;
 989             n++;
 990
 991             for (bit = 1; bit; bit <<= 1) {
 992                 const char *fname = bit_to_string(bit);
 993
 994                 if (!fname) {
 995                     continue;
 996                 }
 997
 998                 len = strlen(fname);
 999                 if (strncmp(s, fname, len) ||
1000                     (s[len] != '+' && s[len] != '-' && s[len] != end)) {
1001                     continue;
1002                 }
1003
1004                 if (mask & bit) {
1005                     /* bit already set. */
1006                     if (res_string) {
1007                         *res_string = xasprintf("%s: Each %s flag can be "
1008                                                 "specified only once", s,
1009                                                 field_name);
1010                     }
1011                     return -EINVAL;
1012                 }
1013                 if (!(bit & allowed)) {
1014                     goto unknown;
1015                 }
1016                 if (set) {
1017                    flags |= bit;
1018                 }
1019                 mask |= bit;
1020                 break;
1021             }
1022
1023             if (!bit) {
1024                 goto unknown;
1025             }
1026             s += len;
1027             n += len;
1028         }
1029
1030         *res_flags = flags;
1031         *res_mask = mask;
1032         return n;
1033     }
1034
1035     /* Parse unmasked flags.  If a flag is present, it is set, otherwise
1036      * it is not set. */
1037     while (s[n] != end) {
1038         unsigned long long int flags;
1039         uint32_t bit;
1040         int n0;
1041
1042         if (ovs_scan(&s[n], "%lli%n", &flags, &n0)) {
1043             if (flags & ~allowed) {
1044                 goto unknown;
1045             }
1046             n += n0 + (s[n + n0] == '|');
1047             result |= flags;
1048             continue;
1049         }
1050
1051         for (bit = 1; bit; bit <<= 1) {
1052             const char *name = bit_to_string(bit);
1053             size_t len;
1054
1055             if (!name) {
1056                 continue;
1057             }
1058
1059             len = strlen(name);
1060             if (!strncmp(s + n, name, len) &&
1061                 (s[n + len] == '|' || s[n + len] == end)) {
1062                 if (!(bit & allowed)) {
1063                     goto unknown;
1064                 }
1065                 result |= bit;
1066                 n += len + (s[n + len] == '|');
1067                 break;
1068             }
1069         }
1070
1071         if (!bit) {
1072             goto unknown;
1073         }
1074     }
1075
1076     *res_flags = result;
1077     if (res_mask) {
1078         *res_mask = UINT32_MAX;
1079     }
1080     if (res_string) {
1081         *res_string = NULL;
1082     }
1083     return n;
1084
1085 unknown:
1086     if (res_string) {
1087         *res_string = xasprintf("%s: unknown %s flag(s)", s, field_name);
1088     }
1089     return -EINVAL;
1090 }
1091
1092 void
1093 flow_format(struct ds *ds, const struct flow *flow)
1094 {
1095     struct match match;
1096     struct flow_wildcards *wc = &match.wc;
1097
1098     match_wc_init(&match, flow);
1099
1100     /* As this function is most often used for formatting a packet in a
1101      * packet-in message, skip formatting the packet context fields that are
1102      * all-zeroes to make the print-out easier on the eyes.  This means that a
1103      * missing context field implies a zero value for that field.  This is
1104      * similar to OpenFlow encoding of these fields, as the specification
1105      * states that all-zeroes context fields should not be encoded in the
1106      * packet-in messages. */
1107     if (!flow->in_port.ofp_port) {
1108         WC_UNMASK_FIELD(wc, in_port);
1109     }
1110     if (!flow->skb_priority) {
1111         WC_UNMASK_FIELD(wc, skb_priority);
1112     }
1113     if (!flow->pkt_mark) {
1114         WC_UNMASK_FIELD(wc, pkt_mark);
1115     }
1116     if (!flow->recirc_id) {
1117         WC_UNMASK_FIELD(wc, recirc_id);
1118     }
1119     if (!flow->dp_hash) {
1120         WC_UNMASK_FIELD(wc, dp_hash);
1121     }
1122     for (int i = 0; i < FLOW_N_REGS; i++) {
1123         if (!flow->regs[i]) {
1124             WC_UNMASK_FIELD(wc, regs[i]);
1125         }
1126     }
1127     if (!flow->metadata) {
1128         WC_UNMASK_FIELD(wc, metadata);
1129     }
1130
1131     match_format(&match, ds, OFP_DEFAULT_PRIORITY);
1132 }
1133
1134 void
1135 flow_print(FILE *stream, const struct flow *flow)
1136 {
1137     char *s = flow_to_string(flow);
1138     fputs(s, stream);
1139     free(s);
1140 }
1141 \f
1142 /* flow_wildcards functions. */
1143
1144 /* Initializes 'wc' as a set of wildcards that matches every packet. */
1145 void
1146 flow_wildcards_init_catchall(struct flow_wildcards *wc)
1147 {
1148     memset(&wc->masks, 0, sizeof wc->masks);
1149 }
1150
1151 /* Converts a flow into flow wildcards.  It sets the wildcard masks based on
1152  * the packet headers extracted to 'flow'.  It will not set the mask for fields
1153  * that do not make sense for the packet type.  OpenFlow-only metadata is
1154  * wildcarded, but other metadata is unconditionally exact-matched. */
1155 void flow_wildcards_init_for_packet(struct flow_wildcards *wc,
1156                                     const struct flow *flow)
1157 {
1158     memset(&wc->masks, 0x0, sizeof wc->masks);
1159
1160     /* Update this function whenever struct flow changes. */
1161     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 33);
1162
1163     if (flow->tunnel.ip_dst) {
1164         if (flow->tunnel.flags & FLOW_TNL_F_KEY) {
1165             WC_MASK_FIELD(wc, tunnel.tun_id);
1166         }
1167         WC_MASK_FIELD(wc, tunnel.ip_src);
1168         WC_MASK_FIELD(wc, tunnel.ip_dst);
1169         WC_MASK_FIELD(wc, tunnel.flags);
1170         WC_MASK_FIELD(wc, tunnel.ip_tos);
1171         WC_MASK_FIELD(wc, tunnel.ip_ttl);
1172         WC_MASK_FIELD(wc, tunnel.tp_src);
1173         WC_MASK_FIELD(wc, tunnel.tp_dst);
1174         WC_MASK_FIELD(wc, tunnel.gbp_id);
1175         WC_MASK_FIELD(wc, tunnel.gbp_flags);
1176
1177         if (!(flow->tunnel.flags & FLOW_TNL_F_UDPIF)) {
1178             if (flow->tunnel.metadata.present.map) {
1179                 wc->masks.tunnel.metadata.present.map =
1180                                               flow->tunnel.metadata.present.map;
1181                 WC_MASK_FIELD(wc, tunnel.metadata.opts.u8);
1182             }
1183         } else {
1184             WC_MASK_FIELD(wc, tunnel.metadata.present.len);
1185             memset(wc->masks.tunnel.metadata.opts.gnv, 0xff,
1186                    flow->tunnel.metadata.present.len);
1187         }
1188     } else if (flow->tunnel.tun_id) {
1189         WC_MASK_FIELD(wc, tunnel.tun_id);
1190     }
1191
1192     /* metadata, regs, and conj_id wildcarded. */
1193
1194     WC_MASK_FIELD(wc, skb_priority);
1195     WC_MASK_FIELD(wc, pkt_mark);
1196     WC_MASK_FIELD(wc, recirc_id);
1197     WC_MASK_FIELD(wc, dp_hash);
1198     WC_MASK_FIELD(wc, in_port);
1199
1200     /* actset_output wildcarded. */
1201
1202     WC_MASK_FIELD(wc, dl_dst);
1203     WC_MASK_FIELD(wc, dl_src);
1204     WC_MASK_FIELD(wc, dl_type);
1205     WC_MASK_FIELD(wc, vlan_tci);
1206
1207     if (flow->dl_type == htons(ETH_TYPE_IP)) {
1208         WC_MASK_FIELD(wc, nw_src);
1209         WC_MASK_FIELD(wc, nw_dst);
1210     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1211         WC_MASK_FIELD(wc, ipv6_src);
1212         WC_MASK_FIELD(wc, ipv6_dst);
1213         WC_MASK_FIELD(wc, ipv6_label);
1214     } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
1215                flow->dl_type == htons(ETH_TYPE_RARP)) {
1216         WC_MASK_FIELD(wc, nw_src);
1217         WC_MASK_FIELD(wc, nw_dst);
1218         WC_MASK_FIELD(wc, nw_proto);
1219         WC_MASK_FIELD(wc, arp_sha);
1220         WC_MASK_FIELD(wc, arp_tha);
1221         return;
1222     } else if (eth_type_mpls(flow->dl_type)) {
1223         for (int i = 0; i < FLOW_MAX_MPLS_LABELS; i++) {
1224             WC_MASK_FIELD(wc, mpls_lse[i]);
1225             if (flow->mpls_lse[i] & htonl(MPLS_BOS_MASK)) {
1226                 break;
1227             }
1228         }
1229         return;
1230     } else {
1231         return; /* Unknown ethertype. */
1232     }
1233
1234     /* IPv4 or IPv6. */
1235     WC_MASK_FIELD(wc, nw_frag);
1236     WC_MASK_FIELD(wc, nw_tos);
1237     WC_MASK_FIELD(wc, nw_ttl);
1238     WC_MASK_FIELD(wc, nw_proto);
1239
1240     /* No transport layer header in later fragments. */
1241     if (!(flow->nw_frag & FLOW_NW_FRAG_LATER) &&
1242         (flow->nw_proto == IPPROTO_ICMP ||
1243          flow->nw_proto == IPPROTO_ICMPV6 ||
1244          flow->nw_proto == IPPROTO_TCP ||
1245          flow->nw_proto == IPPROTO_UDP ||
1246          flow->nw_proto == IPPROTO_SCTP ||
1247          flow->nw_proto == IPPROTO_IGMP)) {
1248         WC_MASK_FIELD(wc, tp_src);
1249         WC_MASK_FIELD(wc, tp_dst);
1250
1251         if (flow->nw_proto == IPPROTO_TCP) {
1252             WC_MASK_FIELD(wc, tcp_flags);
1253         } else if (flow->nw_proto == IPPROTO_ICMPV6) {
1254             WC_MASK_FIELD(wc, arp_sha);
1255             WC_MASK_FIELD(wc, arp_tha);
1256             WC_MASK_FIELD(wc, nd_target);
1257         } else if (flow->nw_proto == IPPROTO_IGMP) {
1258             WC_MASK_FIELD(wc, igmp_group_ip4);
1259         }
1260     }
1261 }
1262
1263 /* Return a map of possible fields for a packet of the same type as 'flow'.
1264  * Including extra bits in the returned mask is not wrong, it is just less
1265  * optimal.
1266  *
1267  * This is a less precise version of flow_wildcards_init_for_packet() above. */
1268 void
1269 flow_wc_map(const struct flow *flow, struct miniflow *map)
1270 {
1271     /* Update this function whenever struct flow changes. */
1272     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 33);
1273
1274     map->tnl_map = 0;
1275     if (flow->tunnel.ip_dst) {
1276         map->tnl_map |= MINIFLOW_TNL_MAP__(tunnel,
1277                                           offsetof(struct flow_tnl, metadata));
1278         if (!(flow->tunnel.flags & FLOW_TNL_F_UDPIF)) {
1279             if (flow->tunnel.metadata.present.map) {
1280                 map->tnl_map |= MINIFLOW_TNL_MAP(tunnel.metadata);
1281             }
1282         } else {
1283             map->tnl_map |= MINIFLOW_TNL_MAP(tunnel.metadata.present.len);
1284             map->tnl_map |= MINIFLOW_TNL_MAP__(tunnel.metadata.opts.gnv,
1285                                              flow->tunnel.metadata.present.len);
1286         }
1287     }
1288
1289     /* Metadata fields that can appear on packet input. */
1290     map->pkt_map = MINIFLOW_PKT_MAP(skb_priority) | MINIFLOW_PKT_MAP(pkt_mark)
1291         | MINIFLOW_PKT_MAP(recirc_id) | MINIFLOW_PKT_MAP(dp_hash)
1292         | MINIFLOW_PKT_MAP(in_port)
1293         | MINIFLOW_PKT_MAP(dl_dst) | MINIFLOW_PKT_MAP(dl_src)
1294         | MINIFLOW_PKT_MAP(dl_type) | MINIFLOW_PKT_MAP(vlan_tci);
1295
1296     /* Ethertype-dependent fields. */
1297     if (OVS_LIKELY(flow->dl_type == htons(ETH_TYPE_IP))) {
1298         map->pkt_map |= MINIFLOW_PKT_MAP(nw_src) | MINIFLOW_PKT_MAP(nw_dst)
1299             | MINIFLOW_PKT_MAP(nw_proto) | MINIFLOW_PKT_MAP(nw_frag)
1300             | MINIFLOW_PKT_MAP(nw_tos) | MINIFLOW_PKT_MAP(nw_ttl);
1301         if (OVS_UNLIKELY(flow->nw_proto == IPPROTO_IGMP)) {
1302             map->pkt_map |= MINIFLOW_PKT_MAP(igmp_group_ip4);
1303         } else {
1304             map->pkt_map |= MINIFLOW_PKT_MAP(tcp_flags)
1305                 | MINIFLOW_PKT_MAP(tp_src) | MINIFLOW_PKT_MAP(tp_dst);
1306         }
1307     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1308         map->pkt_map |= MINIFLOW_PKT_MAP(ipv6_src) | MINIFLOW_PKT_MAP(ipv6_dst)
1309             | MINIFLOW_PKT_MAP(ipv6_label)
1310             | MINIFLOW_PKT_MAP(nw_proto) | MINIFLOW_PKT_MAP(nw_frag)
1311             | MINIFLOW_PKT_MAP(nw_tos) | MINIFLOW_PKT_MAP(nw_ttl);
1312         if (OVS_UNLIKELY(flow->nw_proto == IPPROTO_ICMPV6)) {
1313             map->pkt_map |= MINIFLOW_PKT_MAP(nd_target)
1314                 | MINIFLOW_PKT_MAP(arp_sha) | MINIFLOW_PKT_MAP(arp_tha);
1315         } else {
1316             map->pkt_map |= MINIFLOW_PKT_MAP(tcp_flags)
1317                 | MINIFLOW_PKT_MAP(tp_src) | MINIFLOW_PKT_MAP(tp_dst);
1318         }
1319     } else if (eth_type_mpls(flow->dl_type)) {
1320         map->pkt_map |= MINIFLOW_PKT_MAP(mpls_lse);
1321     } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
1322                flow->dl_type == htons(ETH_TYPE_RARP)) {
1323         map->pkt_map |= MINIFLOW_PKT_MAP(nw_src) | MINIFLOW_PKT_MAP(nw_dst)
1324             | MINIFLOW_PKT_MAP(nw_proto)
1325             | MINIFLOW_PKT_MAP(arp_sha) | MINIFLOW_PKT_MAP(arp_tha);
1326     }
1327 }
1328
1329 /* Clear the metadata and register wildcard masks. They are not packet
1330  * header fields. */
1331 void
1332 flow_wildcards_clear_non_packet_fields(struct flow_wildcards *wc)
1333 {
1334     /* Update this function whenever struct flow changes. */
1335     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 33);
1336
1337     memset(&wc->masks.metadata, 0, sizeof wc->masks.metadata);
1338     memset(&wc->masks.regs, 0, sizeof wc->masks.regs);
1339     wc->masks.actset_output = 0;
1340     wc->masks.conj_id = 0;
1341 }
1342
1343 /* Returns true if 'wc' matches every packet, false if 'wc' fixes any bits or
1344  * fields. */
1345 bool
1346 flow_wildcards_is_catchall(const struct flow_wildcards *wc)
1347 {
1348     const uint64_t *wc_u64 = (const uint64_t *) &wc->masks;
1349     size_t i;
1350
1351     for (i = 0; i < FLOW_U64S; i++) {
1352         if (wc_u64[i]) {
1353             return false;
1354         }
1355     }
1356     return true;
1357 }
1358
1359 /* Sets 'dst' as the bitwise AND of wildcards in 'src1' and 'src2'.
1360  * That is, a bit or a field is wildcarded in 'dst' if it is wildcarded
1361  * in 'src1' or 'src2' or both.  */
1362 void
1363 flow_wildcards_and(struct flow_wildcards *dst,
1364                    const struct flow_wildcards *src1,
1365                    const struct flow_wildcards *src2)
1366 {
1367     uint64_t *dst_u64 = (uint64_t *) &dst->masks;
1368     const uint64_t *src1_u64 = (const uint64_t *) &src1->masks;
1369     const uint64_t *src2_u64 = (const uint64_t *) &src2->masks;
1370     size_t i;
1371
1372     for (i = 0; i < FLOW_U64S; i++) {
1373         dst_u64[i] = src1_u64[i] & src2_u64[i];
1374     }
1375 }
1376
1377 /* Sets 'dst' as the bitwise OR of wildcards in 'src1' and 'src2'.  That
1378  * is, a bit or a field is wildcarded in 'dst' if it is neither
1379  * wildcarded in 'src1' nor 'src2'. */
1380 void
1381 flow_wildcards_or(struct flow_wildcards *dst,
1382                   const struct flow_wildcards *src1,
1383                   const struct flow_wildcards *src2)
1384 {
1385     uint64_t *dst_u64 = (uint64_t *) &dst->masks;
1386     const uint64_t *src1_u64 = (const uint64_t *) &src1->masks;
1387     const uint64_t *src2_u64 = (const uint64_t *) &src2->masks;
1388     size_t i;
1389
1390     for (i = 0; i < FLOW_U64S; i++) {
1391         dst_u64[i] = src1_u64[i] | src2_u64[i];
1392     }
1393 }
1394
1395 /* Returns a hash of the wildcards in 'wc'. */
1396 uint32_t
1397 flow_wildcards_hash(const struct flow_wildcards *wc, uint32_t basis)
1398 {
1399     return flow_hash(&wc->masks, basis);
1400 }
1401
1402 /* Returns true if 'a' and 'b' represent the same wildcards, false if they are
1403  * different. */
1404 bool
1405 flow_wildcards_equal(const struct flow_wildcards *a,
1406                      const struct flow_wildcards *b)
1407 {
1408     return flow_equal(&a->masks, &b->masks);
1409 }
1410
1411 /* Returns true if at least one bit or field is wildcarded in 'a' but not in
1412  * 'b', false otherwise. */
1413 bool
1414 flow_wildcards_has_extra(const struct flow_wildcards *a,
1415                          const struct flow_wildcards *b)
1416 {
1417     const uint64_t *a_u64 = (const uint64_t *) &a->masks;
1418     const uint64_t *b_u64 = (const uint64_t *) &b->masks;
1419     size_t i;
1420
1421     for (i = 0; i < FLOW_U64S; i++) {
1422         if ((a_u64[i] & b_u64[i]) != b_u64[i]) {
1423             return true;
1424         }
1425     }
1426     return false;
1427 }
1428
1429 /* Returns true if 'a' and 'b' are equal, except that 0-bits (wildcarded bits)
1430  * in 'wc' do not need to be equal in 'a' and 'b'. */
1431 bool
1432 flow_equal_except(const struct flow *a, const struct flow *b,
1433                   const struct flow_wildcards *wc)
1434 {
1435     const uint64_t *a_u64 = (const uint64_t *) a;
1436     const uint64_t *b_u64 = (const uint64_t *) b;
1437     const uint64_t *wc_u64 = (const uint64_t *) &wc->masks;
1438     size_t i;
1439
1440     for (i = 0; i < FLOW_U64S; i++) {
1441         if ((a_u64[i] ^ b_u64[i]) & wc_u64[i]) {
1442             return false;
1443         }
1444     }
1445     return true;
1446 }
1447
1448 /* Sets the wildcard mask for register 'idx' in 'wc' to 'mask'.
1449  * (A 0-bit indicates a wildcard bit.) */
1450 void
1451 flow_wildcards_set_reg_mask(struct flow_wildcards *wc, int idx, uint32_t mask)
1452 {
1453     wc->masks.regs[idx] = mask;
1454 }
1455
1456 /* Sets the wildcard mask for register 'idx' in 'wc' to 'mask'.
1457  * (A 0-bit indicates a wildcard bit.) */
1458 void
1459 flow_wildcards_set_xreg_mask(struct flow_wildcards *wc, int idx, uint64_t mask)
1460 {
1461     flow_set_xreg(&wc->masks, idx, mask);
1462 }
1463
1464 /* Calculates the 5-tuple hash from the given miniflow.
1465  * This returns the same value as flow_hash_5tuple for the corresponding
1466  * flow. */
1467 uint32_t
1468 miniflow_hash_5tuple(const struct miniflow *flow, uint32_t basis)
1469 {
1470     uint32_t hash = basis;
1471
1472     if (flow) {
1473         ovs_be16 dl_type = MINIFLOW_GET_BE16(flow, dl_type);
1474
1475         hash = hash_add(hash, MINIFLOW_GET_U8(flow, nw_proto));
1476
1477         /* Separate loops for better optimization. */
1478         if (dl_type == htons(ETH_TYPE_IPV6)) {
1479             struct miniflow maps = { 0, MINIFLOW_PKT_MAP(ipv6_src)
1480                                      | MINIFLOW_PKT_MAP(ipv6_dst) };
1481             uint64_t value;
1482
1483             MINIFLOW_FOR_EACH_IN_PKT_MAP(value, flow, maps) {
1484                 hash = hash_add64(hash, value);
1485             }
1486         } else {
1487             hash = hash_add(hash, MINIFLOW_GET_U32(flow, nw_src));
1488             hash = hash_add(hash, MINIFLOW_GET_U32(flow, nw_dst));
1489         }
1490         /* Add both ports at once. */
1491         hash = hash_add(hash, MINIFLOW_GET_U32(flow, tp_src));
1492         hash = hash_finish(hash, 42); /* Arbitrary number. */
1493     }
1494     return hash;
1495 }
1496
1497 ASSERT_SEQUENTIAL_SAME_WORD(tp_src, tp_dst);
1498 ASSERT_SEQUENTIAL(ipv6_src, ipv6_dst);
1499
1500 /* Calculates the 5-tuple hash from the given flow. */
1501 uint32_t
1502 flow_hash_5tuple(const struct flow *flow, uint32_t basis)
1503 {
1504     uint32_t hash = basis;
1505
1506     if (flow) {
1507         hash = hash_add(hash, flow->nw_proto);
1508
1509         if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1510             const uint64_t *flow_u64 = (const uint64_t *)flow;
1511             int ofs = offsetof(struct flow, ipv6_src) / 8;
1512             int end = ofs + 2 * sizeof flow->ipv6_src / 8;
1513
1514             for (;ofs < end; ofs++) {
1515                 hash = hash_add64(hash, flow_u64[ofs]);
1516             }
1517         } else {
1518             hash = hash_add(hash, (OVS_FORCE uint32_t) flow->nw_src);
1519             hash = hash_add(hash, (OVS_FORCE uint32_t) flow->nw_dst);
1520         }
1521         /* Add both ports at once. */
1522         hash = hash_add(hash,
1523                         ((const uint32_t *)flow)[offsetof(struct flow, tp_src)
1524                                                  / sizeof(uint32_t)]);
1525         hash = hash_finish(hash, 42); /* Arbitrary number. */
1526     }
1527     return hash;
1528 }
1529
1530 /* Hashes 'flow' based on its L2 through L4 protocol information. */
1531 uint32_t
1532 flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis)
1533 {
1534     struct {
1535         union {
1536             ovs_be32 ipv4_addr;
1537             struct in6_addr ipv6_addr;
1538         };
1539         ovs_be16 eth_type;
1540         ovs_be16 vlan_tci;
1541         ovs_be16 tp_port;
1542         uint8_t eth_addr[ETH_ADDR_LEN];
1543         uint8_t ip_proto;
1544     } fields;
1545
1546     int i;
1547
1548     memset(&fields, 0, sizeof fields);
1549     for (i = 0; i < ETH_ADDR_LEN; i++) {
1550         fields.eth_addr[i] = flow->dl_src[i] ^ flow->dl_dst[i];
1551     }
1552     fields.vlan_tci = flow->vlan_tci & htons(VLAN_VID_MASK);
1553     fields.eth_type = flow->dl_type;
1554
1555     /* UDP source and destination port are not taken into account because they
1556      * will not necessarily be symmetric in a bidirectional flow. */
1557     if (fields.eth_type == htons(ETH_TYPE_IP)) {
1558         fields.ipv4_addr = flow->nw_src ^ flow->nw_dst;
1559         fields.ip_proto = flow->nw_proto;
1560         if (fields.ip_proto == IPPROTO_TCP || fields.ip_proto == IPPROTO_SCTP) {
1561             fields.tp_port = flow->tp_src ^ flow->tp_dst;
1562         }
1563     } else if (fields.eth_type == htons(ETH_TYPE_IPV6)) {
1564         const uint8_t *a = &flow->ipv6_src.s6_addr[0];
1565         const uint8_t *b = &flow->ipv6_dst.s6_addr[0];
1566         uint8_t *ipv6_addr = &fields.ipv6_addr.s6_addr[0];
1567
1568         for (i=0; i<16; i++) {
1569             ipv6_addr[i] = a[i] ^ b[i];
1570         }
1571         fields.ip_proto = flow->nw_proto;
1572         if (fields.ip_proto == IPPROTO_TCP || fields.ip_proto == IPPROTO_SCTP) {
1573             fields.tp_port = flow->tp_src ^ flow->tp_dst;
1574         }
1575     }
1576     return jhash_bytes(&fields, sizeof fields, basis);
1577 }
1578
1579 /* Hashes 'flow' based on its L3 through L4 protocol information */
1580 uint32_t
1581 flow_hash_symmetric_l3l4(const struct flow *flow, uint32_t basis,
1582                          bool inc_udp_ports)
1583 {
1584     uint32_t hash = basis;
1585
1586     /* UDP source and destination port are also taken into account. */
1587     if (flow->dl_type == htons(ETH_TYPE_IP)) {
1588         hash = hash_add(hash,
1589                         (OVS_FORCE uint32_t) (flow->nw_src ^ flow->nw_dst));
1590     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1591         /* IPv6 addresses are 64-bit aligned inside struct flow. */
1592         const uint64_t *a = ALIGNED_CAST(uint64_t *, flow->ipv6_src.s6_addr);
1593         const uint64_t *b = ALIGNED_CAST(uint64_t *, flow->ipv6_dst.s6_addr);
1594
1595         for (int i = 0; i < 4; i++) {
1596             hash = hash_add64(hash, a[i] ^ b[i]);
1597         }
1598     } else {
1599         /* Cannot hash non-IP flows */
1600         return 0;
1601     }
1602
1603     hash = hash_add(hash, flow->nw_proto);
1604     if (flow->nw_proto == IPPROTO_TCP || flow->nw_proto == IPPROTO_SCTP ||
1605          (inc_udp_ports && flow->nw_proto == IPPROTO_UDP)) {
1606         hash = hash_add(hash,
1607                         (OVS_FORCE uint16_t) (flow->tp_src ^ flow->tp_dst));
1608     }
1609
1610     return hash_finish(hash, basis);
1611 }
1612
1613 /* Initialize a flow with random fields that matter for nx_hash_fields. */
1614 void
1615 flow_random_hash_fields(struct flow *flow)
1616 {
1617     uint16_t rnd = random_uint16();
1618
1619     /* Initialize to all zeros. */
1620     memset(flow, 0, sizeof *flow);
1621
1622     eth_addr_random(flow->dl_src);
1623     eth_addr_random(flow->dl_dst);
1624
1625     flow->vlan_tci = (OVS_FORCE ovs_be16) (random_uint16() & VLAN_VID_MASK);
1626
1627     /* Make most of the random flows IPv4, some IPv6, and rest random. */
1628     flow->dl_type = rnd < 0x8000 ? htons(ETH_TYPE_IP) :
1629         rnd < 0xc000 ? htons(ETH_TYPE_IPV6) : (OVS_FORCE ovs_be16)rnd;
1630
1631     if (dl_type_is_ip_any(flow->dl_type)) {
1632         if (flow->dl_type == htons(ETH_TYPE_IP)) {
1633             flow->nw_src = (OVS_FORCE ovs_be32)random_uint32();
1634             flow->nw_dst = (OVS_FORCE ovs_be32)random_uint32();
1635         } else {
1636             random_bytes(&flow->ipv6_src, sizeof flow->ipv6_src);
1637             random_bytes(&flow->ipv6_dst, sizeof flow->ipv6_dst);
1638         }
1639         /* Make most of IP flows TCP, some UDP or SCTP, and rest random. */
1640         rnd = random_uint16();
1641         flow->nw_proto = rnd < 0x8000 ? IPPROTO_TCP :
1642             rnd < 0xc000 ? IPPROTO_UDP :
1643             rnd < 0xd000 ? IPPROTO_SCTP : (uint8_t)rnd;
1644         if (flow->nw_proto == IPPROTO_TCP ||
1645             flow->nw_proto == IPPROTO_UDP ||
1646             flow->nw_proto == IPPROTO_SCTP) {
1647             flow->tp_src = (OVS_FORCE ovs_be16)random_uint16();
1648             flow->tp_dst = (OVS_FORCE ovs_be16)random_uint16();
1649         }
1650     }
1651 }
1652
1653 /* Masks the fields in 'wc' that are used by the flow hash 'fields'. */
1654 void
1655 flow_mask_hash_fields(const struct flow *flow, struct flow_wildcards *wc,
1656                       enum nx_hash_fields fields)
1657 {
1658     switch (fields) {
1659     case NX_HASH_FIELDS_ETH_SRC:
1660         memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
1661         break;
1662
1663     case NX_HASH_FIELDS_SYMMETRIC_L4:
1664         memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
1665         memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
1666         if (flow->dl_type == htons(ETH_TYPE_IP)) {
1667             memset(&wc->masks.nw_src, 0xff, sizeof wc->masks.nw_src);
1668             memset(&wc->masks.nw_dst, 0xff, sizeof wc->masks.nw_dst);
1669         } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1670             memset(&wc->masks.ipv6_src, 0xff, sizeof wc->masks.ipv6_src);
1671             memset(&wc->masks.ipv6_dst, 0xff, sizeof wc->masks.ipv6_dst);
1672         }
1673         if (is_ip_any(flow)) {
1674             memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
1675             flow_unwildcard_tp_ports(flow, wc);
1676         }
1677         wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
1678         break;
1679
1680     case NX_HASH_FIELDS_SYMMETRIC_L3L4_UDP:
1681         if (is_ip_any(flow) && flow->nw_proto == IPPROTO_UDP) {
1682             memset(&wc->masks.tp_src, 0xff, sizeof wc->masks.tp_src);
1683             memset(&wc->masks.tp_dst, 0xff, sizeof wc->masks.tp_dst);
1684         }
1685         /* no break */
1686     case NX_HASH_FIELDS_SYMMETRIC_L3L4:
1687         if (flow->dl_type == htons(ETH_TYPE_IP)) {
1688             memset(&wc->masks.nw_src, 0xff, sizeof wc->masks.nw_src);
1689             memset(&wc->masks.nw_dst, 0xff, sizeof wc->masks.nw_dst);
1690         } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1691             memset(&wc->masks.ipv6_src, 0xff, sizeof wc->masks.ipv6_src);
1692             memset(&wc->masks.ipv6_dst, 0xff, sizeof wc->masks.ipv6_dst);
1693         } else {
1694             break; /* non-IP flow */
1695         }
1696
1697         memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
1698         if (flow->nw_proto == IPPROTO_TCP || flow->nw_proto == IPPROTO_SCTP) {
1699             memset(&wc->masks.tp_src, 0xff, sizeof wc->masks.tp_src);
1700             memset(&wc->masks.tp_dst, 0xff, sizeof wc->masks.tp_dst);
1701         }
1702         break;
1703
1704     default:
1705         OVS_NOT_REACHED();
1706     }
1707 }
1708
1709 /* Hashes the portions of 'flow' designated by 'fields'. */
1710 uint32_t
1711 flow_hash_fields(const struct flow *flow, enum nx_hash_fields fields,
1712                  uint16_t basis)
1713 {
1714     switch (fields) {
1715
1716     case NX_HASH_FIELDS_ETH_SRC:
1717         return jhash_bytes(flow->dl_src, sizeof flow->dl_src, basis);
1718
1719     case NX_HASH_FIELDS_SYMMETRIC_L4:
1720         return flow_hash_symmetric_l4(flow, basis);
1721
1722     case NX_HASH_FIELDS_SYMMETRIC_L3L4:
1723         return flow_hash_symmetric_l3l4(flow, basis, false);
1724
1725     case NX_HASH_FIELDS_SYMMETRIC_L3L4_UDP:
1726         return flow_hash_symmetric_l3l4(flow, basis, true);
1727
1728     }
1729
1730     OVS_NOT_REACHED();
1731 }
1732
1733 /* Returns a string representation of 'fields'. */
1734 const char *
1735 flow_hash_fields_to_str(enum nx_hash_fields fields)
1736 {
1737     switch (fields) {
1738     case NX_HASH_FIELDS_ETH_SRC: return "eth_src";
1739     case NX_HASH_FIELDS_SYMMETRIC_L4: return "symmetric_l4";
1740     case NX_HASH_FIELDS_SYMMETRIC_L3L4: return "symmetric_l3l4";
1741     case NX_HASH_FIELDS_SYMMETRIC_L3L4_UDP: return "symmetric_l3l4+udp";
1742     default: return "<unknown>";
1743     }
1744 }
1745
1746 /* Returns true if the value of 'fields' is supported. Otherwise false. */
1747 bool
1748 flow_hash_fields_valid(enum nx_hash_fields fields)
1749 {
1750     return fields == NX_HASH_FIELDS_ETH_SRC
1751         || fields == NX_HASH_FIELDS_SYMMETRIC_L4
1752         || fields == NX_HASH_FIELDS_SYMMETRIC_L3L4
1753         || fields == NX_HASH_FIELDS_SYMMETRIC_L3L4_UDP;
1754 }
1755
1756 /* Returns a hash value for the bits of 'flow' that are active based on
1757  * 'wc', given 'basis'. */
1758 uint32_t
1759 flow_hash_in_wildcards(const struct flow *flow,
1760                        const struct flow_wildcards *wc, uint32_t basis)
1761 {
1762     const uint64_t *wc_u64 = (const uint64_t *) &wc->masks;
1763     const uint64_t *flow_u64 = (const uint64_t *) flow;
1764     uint32_t hash;
1765     size_t i;
1766
1767     hash = basis;
1768     for (i = 0; i < FLOW_U64S; i++) {
1769         hash = hash_add64(hash, flow_u64[i] & wc_u64[i]);
1770     }
1771     return hash_finish(hash, 8 * FLOW_U64S);
1772 }
1773
1774 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
1775  * OpenFlow 1.0 "dl_vlan" value:
1776  *
1777  *      - If it is in the range 0...4095, 'flow->vlan_tci' is set to match
1778  *        that VLAN.  Any existing PCP match is unchanged (it becomes 0 if
1779  *        'flow' previously matched packets without a VLAN header).
1780  *
1781  *      - If it is OFP_VLAN_NONE, 'flow->vlan_tci' is set to match a packet
1782  *        without a VLAN tag.
1783  *
1784  *      - Other values of 'vid' should not be used. */
1785 void
1786 flow_set_dl_vlan(struct flow *flow, ovs_be16 vid)
1787 {
1788     if (vid == htons(OFP10_VLAN_NONE)) {
1789         flow->vlan_tci = htons(0);
1790     } else {
1791         vid &= htons(VLAN_VID_MASK);
1792         flow->vlan_tci &= ~htons(VLAN_VID_MASK);
1793         flow->vlan_tci |= htons(VLAN_CFI) | vid;
1794     }
1795 }
1796
1797 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
1798  * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
1799  * plus CFI). */
1800 void
1801 flow_set_vlan_vid(struct flow *flow, ovs_be16 vid)
1802 {
1803     ovs_be16 mask = htons(VLAN_VID_MASK | VLAN_CFI);
1804     flow->vlan_tci &= ~mask;
1805     flow->vlan_tci |= vid & mask;
1806 }
1807
1808 /* Sets the VLAN PCP that 'flow' matches to 'pcp', which should be in the
1809  * range 0...7.
1810  *
1811  * This function has no effect on the VLAN ID that 'flow' matches.
1812  *
1813  * After calling this function, 'flow' will not match packets without a VLAN
1814  * header. */
1815 void
1816 flow_set_vlan_pcp(struct flow *flow, uint8_t pcp)
1817 {
1818     pcp &= 0x07;
1819     flow->vlan_tci &= ~htons(VLAN_PCP_MASK);
1820     flow->vlan_tci |= htons((pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
1821 }
1822
1823 /* Returns the number of MPLS LSEs present in 'flow'
1824  *
1825  * Returns 0 if the 'dl_type' of 'flow' is not an MPLS ethernet type.
1826  * Otherwise traverses 'flow''s MPLS label stack stopping at the
1827  * first entry that has the BoS bit set. If no such entry exists then
1828  * the maximum number of LSEs that can be stored in 'flow' is returned.
1829  */
1830 int
1831 flow_count_mpls_labels(const struct flow *flow, struct flow_wildcards *wc)
1832 {
1833     /* dl_type is always masked. */
1834     if (eth_type_mpls(flow->dl_type)) {
1835         int i;
1836         int cnt;
1837
1838         cnt = 0;
1839         for (i = 0; i < FLOW_MAX_MPLS_LABELS; i++) {
1840             if (wc) {
1841                 wc->masks.mpls_lse[i] |= htonl(MPLS_BOS_MASK);
1842             }
1843             if (flow->mpls_lse[i] & htonl(MPLS_BOS_MASK)) {
1844                 return i + 1;
1845             }
1846             if (flow->mpls_lse[i]) {
1847                 cnt++;
1848             }
1849         }
1850         return cnt;
1851     } else {
1852         return 0;
1853     }
1854 }
1855
1856 /* Returns the number consecutive of MPLS LSEs, starting at the
1857  * innermost LSE, that are common in 'a' and 'b'.
1858  *
1859  * 'an' must be flow_count_mpls_labels(a).
1860  * 'bn' must be flow_count_mpls_labels(b).
1861  */
1862 int
1863 flow_count_common_mpls_labels(const struct flow *a, int an,
1864                               const struct flow *b, int bn,
1865                               struct flow_wildcards *wc)
1866 {
1867     int min_n = MIN(an, bn);
1868     if (min_n == 0) {
1869         return 0;
1870     } else {
1871         int common_n = 0;
1872         int a_last = an - 1;
1873         int b_last = bn - 1;
1874         int i;
1875
1876         for (i = 0; i < min_n; i++) {
1877             if (wc) {
1878                 wc->masks.mpls_lse[a_last - i] = OVS_BE32_MAX;
1879                 wc->masks.mpls_lse[b_last - i] = OVS_BE32_MAX;
1880             }
1881             if (a->mpls_lse[a_last - i] != b->mpls_lse[b_last - i]) {
1882                 break;
1883             } else {
1884                 common_n++;
1885             }
1886         }
1887
1888         return common_n;
1889     }
1890 }
1891
1892 /* Adds a new outermost MPLS label to 'flow' and changes 'flow''s Ethernet type
1893  * to 'mpls_eth_type', which must be an MPLS Ethertype.
1894  *
1895  * If the new label is the first MPLS label in 'flow', it is generated as;
1896  *
1897  *     - label: 2, if 'flow' is IPv6, otherwise 0.
1898  *
1899  *     - TTL: IPv4 or IPv6 TTL, if present and nonzero, otherwise 64.
1900  *
1901  *     - TC: IPv4 or IPv6 TOS, if present, otherwise 0.
1902  *
1903  *     - BoS: 1.
1904  *
1905  * If the new label is the second or later label MPLS label in 'flow', it is
1906  * generated as;
1907  *
1908  *     - label: Copied from outer label.
1909  *
1910  *     - TTL: Copied from outer label.
1911  *
1912  *     - TC: Copied from outer label.
1913  *
1914  *     - BoS: 0.
1915  *
1916  * 'n' must be flow_count_mpls_labels(flow).  'n' must be less than
1917  * FLOW_MAX_MPLS_LABELS (because otherwise flow->mpls_lse[] would overflow).
1918  */
1919 void
1920 flow_push_mpls(struct flow *flow, int n, ovs_be16 mpls_eth_type,
1921                struct flow_wildcards *wc)
1922 {
1923     ovs_assert(eth_type_mpls(mpls_eth_type));
1924     ovs_assert(n < FLOW_MAX_MPLS_LABELS);
1925
1926     if (n) {
1927         int i;
1928
1929         if (wc) {
1930             memset(&wc->masks.mpls_lse, 0xff, sizeof *wc->masks.mpls_lse * n);
1931         }
1932         for (i = n; i >= 1; i--) {
1933             flow->mpls_lse[i] = flow->mpls_lse[i - 1];
1934         }
1935         flow->mpls_lse[0] = (flow->mpls_lse[1] & htonl(~MPLS_BOS_MASK));
1936     } else {
1937         int label = 0;          /* IPv4 Explicit Null. */
1938         int tc = 0;
1939         int ttl = 64;
1940
1941         if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1942             label = 2;
1943         }
1944
1945         if (is_ip_any(flow)) {
1946             tc = (flow->nw_tos & IP_DSCP_MASK) >> 2;
1947             if (wc) {
1948                 wc->masks.nw_tos |= IP_DSCP_MASK;
1949                 wc->masks.nw_ttl = 0xff;
1950             }
1951
1952             if (flow->nw_ttl) {
1953                 ttl = flow->nw_ttl;
1954             }
1955         }
1956
1957         flow->mpls_lse[0] = set_mpls_lse_values(ttl, tc, 1, htonl(label));
1958
1959         /* Clear all L3 and L4 fields and dp_hash. */
1960         BUILD_ASSERT(FLOW_WC_SEQ == 33);
1961         memset((char *) flow + FLOW_SEGMENT_2_ENDS_AT, 0,
1962                sizeof(struct flow) - FLOW_SEGMENT_2_ENDS_AT);
1963         flow->dp_hash = 0;
1964     }
1965     flow->dl_type = mpls_eth_type;
1966 }
1967
1968 /* Tries to remove the outermost MPLS label from 'flow'.  Returns true if
1969  * successful, false otherwise.  On success, sets 'flow''s Ethernet type to
1970  * 'eth_type'.
1971  *
1972  * 'n' must be flow_count_mpls_labels(flow). */
1973 bool
1974 flow_pop_mpls(struct flow *flow, int n, ovs_be16 eth_type,
1975               struct flow_wildcards *wc)
1976 {
1977     int i;
1978
1979     if (n == 0) {
1980         /* Nothing to pop. */
1981         return false;
1982     } else if (n == FLOW_MAX_MPLS_LABELS) {
1983         if (wc) {
1984             wc->masks.mpls_lse[n - 1] |= htonl(MPLS_BOS_MASK);
1985         }
1986         if (!(flow->mpls_lse[n - 1] & htonl(MPLS_BOS_MASK))) {
1987             /* Can't pop because don't know what to fill in mpls_lse[n - 1]. */
1988             return false;
1989         }
1990     }
1991
1992     if (wc) {
1993         memset(&wc->masks.mpls_lse[1], 0xff,
1994                sizeof *wc->masks.mpls_lse * (n - 1));
1995     }
1996     for (i = 1; i < n; i++) {
1997         flow->mpls_lse[i - 1] = flow->mpls_lse[i];
1998     }
1999     flow->mpls_lse[n - 1] = 0;
2000     flow->dl_type = eth_type;
2001     return true;
2002 }
2003
2004 /* Sets the MPLS Label that 'flow' matches to 'label', which is interpreted
2005  * as an OpenFlow 1.1 "mpls_label" value. */
2006 void
2007 flow_set_mpls_label(struct flow *flow, int idx, ovs_be32 label)
2008 {
2009     set_mpls_lse_label(&flow->mpls_lse[idx], label);
2010 }
2011
2012 /* Sets the MPLS TTL that 'flow' matches to 'ttl', which should be in the
2013  * range 0...255. */
2014 void
2015 flow_set_mpls_ttl(struct flow *flow, int idx, uint8_t ttl)
2016 {
2017     set_mpls_lse_ttl(&flow->mpls_lse[idx], ttl);
2018 }
2019
2020 /* Sets the MPLS TC that 'flow' matches to 'tc', which should be in the
2021  * range 0...7. */
2022 void
2023 flow_set_mpls_tc(struct flow *flow, int idx, uint8_t tc)
2024 {
2025     set_mpls_lse_tc(&flow->mpls_lse[idx], tc);
2026 }
2027
2028 /* Sets the MPLS BOS bit that 'flow' matches to which should be 0 or 1. */
2029 void
2030 flow_set_mpls_bos(struct flow *flow, int idx, uint8_t bos)
2031 {
2032     set_mpls_lse_bos(&flow->mpls_lse[idx], bos);
2033 }
2034
2035 /* Sets the entire MPLS LSE. */
2036 void
2037 flow_set_mpls_lse(struct flow *flow, int idx, ovs_be32 lse)
2038 {
2039     flow->mpls_lse[idx] = lse;
2040 }
2041
2042 static size_t
2043 flow_compose_l4(struct dp_packet *p, const struct flow *flow)
2044 {
2045     size_t l4_len = 0;
2046
2047     if (!(flow->nw_frag & FLOW_NW_FRAG_ANY)
2048         || !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
2049         if (flow->nw_proto == IPPROTO_TCP) {
2050             struct tcp_header *tcp;
2051
2052             l4_len = sizeof *tcp;
2053             tcp = dp_packet_put_zeros(p, l4_len);
2054             tcp->tcp_src = flow->tp_src;
2055             tcp->tcp_dst = flow->tp_dst;
2056             tcp->tcp_ctl = TCP_CTL(ntohs(flow->tcp_flags), 5);
2057         } else if (flow->nw_proto == IPPROTO_UDP) {
2058             struct udp_header *udp;
2059
2060             l4_len = sizeof *udp;
2061             udp = dp_packet_put_zeros(p, l4_len);
2062             udp->udp_src = flow->tp_src;
2063             udp->udp_dst = flow->tp_dst;
2064         } else if (flow->nw_proto == IPPROTO_SCTP) {
2065             struct sctp_header *sctp;
2066
2067             l4_len = sizeof *sctp;
2068             sctp = dp_packet_put_zeros(p, l4_len);
2069             sctp->sctp_src = flow->tp_src;
2070             sctp->sctp_dst = flow->tp_dst;
2071         } else if (flow->nw_proto == IPPROTO_ICMP) {
2072             struct icmp_header *icmp;
2073
2074             l4_len = sizeof *icmp;
2075             icmp = dp_packet_put_zeros(p, l4_len);
2076             icmp->icmp_type = ntohs(flow->tp_src);
2077             icmp->icmp_code = ntohs(flow->tp_dst);
2078             icmp->icmp_csum = csum(icmp, ICMP_HEADER_LEN);
2079         } else if (flow->nw_proto == IPPROTO_IGMP) {
2080             struct igmp_header *igmp;
2081
2082             l4_len = sizeof *igmp;
2083             igmp = dp_packet_put_zeros(p, l4_len);
2084             igmp->igmp_type = ntohs(flow->tp_src);
2085             igmp->igmp_code = ntohs(flow->tp_dst);
2086             put_16aligned_be32(&igmp->group, flow->igmp_group_ip4);
2087             igmp->igmp_csum = csum(igmp, IGMP_HEADER_LEN);
2088         } else if (flow->nw_proto == IPPROTO_ICMPV6) {
2089             struct icmp6_hdr *icmp;
2090
2091             l4_len = sizeof *icmp;
2092             icmp = dp_packet_put_zeros(p, l4_len);
2093             icmp->icmp6_type = ntohs(flow->tp_src);
2094             icmp->icmp6_code = ntohs(flow->tp_dst);
2095
2096             if (icmp->icmp6_code == 0 &&
2097                 (icmp->icmp6_type == ND_NEIGHBOR_SOLICIT ||
2098                  icmp->icmp6_type == ND_NEIGHBOR_ADVERT)) {
2099                 struct in6_addr *nd_target;
2100                 struct nd_opt_hdr *nd_opt;
2101
2102                 l4_len += sizeof *nd_target;
2103                 nd_target = dp_packet_put_zeros(p, sizeof *nd_target);
2104                 *nd_target = flow->nd_target;
2105
2106                 if (!eth_addr_is_zero(flow->arp_sha)) {
2107                     l4_len += 8;
2108                     nd_opt = dp_packet_put_zeros(p, 8);
2109                     nd_opt->nd_opt_len = 1;
2110                     nd_opt->nd_opt_type = ND_OPT_SOURCE_LINKADDR;
2111                     memcpy(nd_opt + 1, flow->arp_sha, ETH_ADDR_LEN);
2112                 }
2113                 if (!eth_addr_is_zero(flow->arp_tha)) {
2114                     l4_len += 8;
2115                     nd_opt = dp_packet_put_zeros(p, 8);
2116                     nd_opt->nd_opt_len = 1;
2117                     nd_opt->nd_opt_type = ND_OPT_TARGET_LINKADDR;
2118                     memcpy(nd_opt + 1, flow->arp_tha, ETH_ADDR_LEN);
2119                 }
2120             }
2121             icmp->icmp6_cksum = (OVS_FORCE uint16_t)
2122                 csum(icmp, (char *)dp_packet_tail(p) - (char *)icmp);
2123         }
2124     }
2125     return l4_len;
2126 }
2127
2128 /* Puts into 'b' a packet that flow_extract() would parse as having the given
2129  * 'flow'.
2130  *
2131  * (This is useful only for testing, obviously, and the packet isn't really
2132  * valid. It hasn't got some checksums filled in, for one, and lots of fields
2133  * are just zeroed.) */
2134 void
2135 flow_compose(struct dp_packet *p, const struct flow *flow)
2136 {
2137     size_t l4_len;
2138
2139     /* eth_compose() sets l3 pointer and makes sure it is 32-bit aligned. */
2140     eth_compose(p, flow->dl_dst, flow->dl_src, ntohs(flow->dl_type), 0);
2141     if (flow->dl_type == htons(FLOW_DL_TYPE_NONE)) {
2142         struct eth_header *eth = dp_packet_l2(p);
2143         eth->eth_type = htons(dp_packet_size(p));
2144         return;
2145     }
2146
2147     if (flow->vlan_tci & htons(VLAN_CFI)) {
2148         eth_push_vlan(p, htons(ETH_TYPE_VLAN), flow->vlan_tci);
2149     }
2150
2151     if (flow->dl_type == htons(ETH_TYPE_IP)) {
2152         struct ip_header *ip;
2153
2154         ip = dp_packet_put_zeros(p, sizeof *ip);
2155         ip->ip_ihl_ver = IP_IHL_VER(5, 4);
2156         ip->ip_tos = flow->nw_tos;
2157         ip->ip_ttl = flow->nw_ttl;
2158         ip->ip_proto = flow->nw_proto;
2159         put_16aligned_be32(&ip->ip_src, flow->nw_src);
2160         put_16aligned_be32(&ip->ip_dst, flow->nw_dst);
2161
2162         if (flow->nw_frag & FLOW_NW_FRAG_ANY) {
2163             ip->ip_frag_off |= htons(IP_MORE_FRAGMENTS);
2164             if (flow->nw_frag & FLOW_NW_FRAG_LATER) {
2165                 ip->ip_frag_off |= htons(100);
2166             }
2167         }
2168
2169         dp_packet_set_l4(p, dp_packet_tail(p));
2170
2171         l4_len = flow_compose_l4(p, flow);
2172
2173         ip = dp_packet_l3(p);
2174         ip->ip_tot_len = htons(p->l4_ofs - p->l3_ofs + l4_len);
2175         ip->ip_csum = csum(ip, sizeof *ip);
2176     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
2177         struct ovs_16aligned_ip6_hdr *nh;
2178
2179         nh = dp_packet_put_zeros(p, sizeof *nh);
2180         put_16aligned_be32(&nh->ip6_flow, htonl(6 << 28) |
2181                            htonl(flow->nw_tos << 20) | flow->ipv6_label);
2182         nh->ip6_hlim = flow->nw_ttl;
2183         nh->ip6_nxt = flow->nw_proto;
2184
2185         memcpy(&nh->ip6_src, &flow->ipv6_src, sizeof(nh->ip6_src));
2186         memcpy(&nh->ip6_dst, &flow->ipv6_dst, sizeof(nh->ip6_dst));
2187
2188         dp_packet_set_l4(p, dp_packet_tail(p));
2189
2190         l4_len = flow_compose_l4(p, flow);
2191
2192         nh = dp_packet_l3(p);
2193         nh->ip6_plen = htons(l4_len);
2194     } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
2195                flow->dl_type == htons(ETH_TYPE_RARP)) {
2196         struct arp_eth_header *arp;
2197
2198         arp = dp_packet_put_zeros(p, sizeof *arp);
2199         dp_packet_set_l3(p, arp);
2200         arp->ar_hrd = htons(1);
2201         arp->ar_pro = htons(ETH_TYPE_IP);
2202         arp->ar_hln = ETH_ADDR_LEN;
2203         arp->ar_pln = 4;
2204         arp->ar_op = htons(flow->nw_proto);
2205
2206         if (flow->nw_proto == ARP_OP_REQUEST ||
2207             flow->nw_proto == ARP_OP_REPLY) {
2208             put_16aligned_be32(&arp->ar_spa, flow->nw_src);
2209             put_16aligned_be32(&arp->ar_tpa, flow->nw_dst);
2210             memcpy(arp->ar_sha, flow->arp_sha, ETH_ADDR_LEN);
2211             memcpy(arp->ar_tha, flow->arp_tha, ETH_ADDR_LEN);
2212         }
2213     }
2214
2215     if (eth_type_mpls(flow->dl_type)) {
2216         int n;
2217
2218         p->l2_5_ofs = p->l3_ofs;
2219         for (n = 1; n < FLOW_MAX_MPLS_LABELS; n++) {
2220             if (flow->mpls_lse[n - 1] & htonl(MPLS_BOS_MASK)) {
2221                 break;
2222             }
2223         }
2224         while (n > 0) {
2225             push_mpls(p, flow->dl_type, flow->mpls_lse[--n]);
2226         }
2227     }
2228 }
2229 \f
2230 /* Compressed flow. */
2231
2232 /* Completes an initialization of 'dst' as a miniflow copy of 'src' begun by
2233  * the caller.  The caller must have already computed 'dst->tnl_map' and
2234  * 'dst->pkt_map' properly to indicate the significant uint64_t elements of
2235  * 'src'.
2236  *
2237  * Normally the significant elements are the ones that are non-zero.  However,
2238  * when a miniflow is initialized from a (mini)mask, the values can be zeroes,
2239  * so that the flow and mask always have the same maps. */
2240 void
2241 miniflow_init(struct miniflow *dst, const struct flow *src)
2242 {
2243     const uint64_t *src_u64 = (const uint64_t *) src;
2244     uint64_t *dst_u64 = miniflow_values(dst);
2245     size_t idx;
2246
2247     MAPS_FOR_EACH_INDEX(idx, *dst) {
2248         *dst_u64++ = src_u64[idx];
2249     }
2250 }
2251
2252 /* Initialize the maps of 'flow' from 'src'. */
2253 void
2254 miniflow_map_init(struct miniflow *flow, const struct flow *src)
2255 {
2256     const uint64_t *src_u64 = (const uint64_t *) src;
2257     int i;
2258
2259     /* Initialize map, counting the number of nonzero elements. */
2260     flow->tnl_map = 0;
2261     for (i = 0; i < FLOW_TNL_U64S; i++) {
2262         if (src_u64[i]) {
2263             flow->tnl_map |= UINT64_C(1) << i;
2264         }
2265     }
2266     src_u64 += FLOW_TNL_U64S;
2267     flow->pkt_map = 0;
2268     for (i = 0; i < FLOW_U64S - FLOW_TNL_U64S; i++) {
2269         if (src_u64[i]) {
2270             flow->pkt_map |= UINT64_C(1) << i;
2271         }
2272     }
2273 }
2274
2275 /* Allocates 'n' count of miniflows, consecutive in memory, initializing the
2276  * map of each from 'src'.
2277  * Returns the size of the miniflow data. */
2278 size_t
2279 miniflow_alloc(struct miniflow *dsts[], size_t n, const struct miniflow *src)
2280 {
2281     size_t n_values = miniflow_n_values(src);
2282     size_t data_size = MINIFLOW_VALUES_SIZE(n_values);
2283     struct miniflow *dst = xmalloc(n * (sizeof *src + data_size));
2284     unsigned int i;
2285
2286     COVERAGE_INC(miniflow_malloc);
2287
2288     for (i = 0; i < n; i++) {
2289         *dst = *src;   /* Copy maps. */
2290         dsts[i] = dst;
2291         dst += 1;      /* Just past the maps. */
2292         dst = (struct miniflow *)((uint64_t *)dst + n_values); /* Skip data. */
2293     }
2294     return data_size;
2295 }
2296
2297 /* Returns a miniflow copy of 'src'.  The caller must eventually free() the
2298  * returned miniflow. */
2299 struct miniflow *
2300 miniflow_create(const struct flow *src)
2301 {
2302     struct miniflow tmp;
2303     struct miniflow *dst;
2304
2305     miniflow_map_init(&tmp, src);
2306
2307     miniflow_alloc(&dst, 1, &tmp);
2308     miniflow_init(dst, src);
2309     return dst;
2310 }
2311
2312 /* Initializes 'dst' as a copy of 'src'.  The caller must have allocated
2313  * 'dst' to have inline space for 'n_values' data in 'src'. */
2314 void
2315 miniflow_clone(struct miniflow *dst, const struct miniflow *src,
2316                size_t n_values)
2317 {
2318     *dst = *src;   /* Copy maps. */
2319     memcpy(miniflow_values(dst), miniflow_get_values(src),
2320            MINIFLOW_VALUES_SIZE(n_values));
2321 }
2322
2323 /* Initializes 'dst' as a copy of 'src'. */
2324 void
2325 miniflow_expand(const struct miniflow *src, struct flow *dst)
2326 {
2327     memset(dst, 0, sizeof *dst);
2328     flow_union_with_miniflow(dst, src);
2329 }
2330
2331 /* Returns true if 'a' and 'b' are equal miniflows, false otherwise. */
2332 bool
2333 miniflow_equal(const struct miniflow *a, const struct miniflow *b)
2334 {
2335     const uint64_t *ap = miniflow_get_values(a);
2336     const uint64_t *bp = miniflow_get_values(b);
2337
2338     if (OVS_LIKELY(a->tnl_map == b->tnl_map && a->pkt_map == b->pkt_map)) {
2339         return !memcmp(ap, bp, miniflow_n_values(a) * sizeof *ap);
2340     } else {
2341         uint64_t map;
2342
2343         map = a->tnl_map | b->tnl_map;
2344         for (; map; map = zero_rightmost_1bit(map)) {
2345             uint64_t bit = rightmost_1bit(map);
2346
2347             if ((a->tnl_map & bit ? *ap++ : 0)
2348                 != (b->tnl_map & bit ? *bp++ : 0)) {
2349                 return false;
2350             }
2351         }
2352         map = a->pkt_map | b->pkt_map;
2353         for (; map; map = zero_rightmost_1bit(map)) {
2354             uint64_t bit = rightmost_1bit(map);
2355
2356             if ((a->pkt_map & bit ? *ap++ : 0)
2357                 != (b->pkt_map & bit ? *bp++ : 0)) {
2358                 return false;
2359             }
2360         }
2361     }
2362
2363     return true;
2364 }
2365
2366 /* Returns false if 'a' and 'b' differ at the places where there are 1-bits
2367  * in 'mask', true otherwise. */
2368 bool
2369 miniflow_equal_in_minimask(const struct miniflow *a, const struct miniflow *b,
2370                            const struct minimask *mask)
2371 {
2372     const uint64_t *p = miniflow_get_values(&mask->masks);
2373     size_t idx;
2374
2375     MAPS_FOR_EACH_INDEX(idx, mask->masks) {
2376         if ((miniflow_get(a, idx) ^ miniflow_get(b, idx)) & *p++) {
2377             return false;
2378         }
2379     }
2380
2381     return true;
2382 }
2383
2384 /* Returns true if 'a' and 'b' are equal at the places where there are 1-bits
2385  * in 'mask', false if they differ. */
2386 bool
2387 miniflow_equal_flow_in_minimask(const struct miniflow *a, const struct flow *b,
2388                                 const struct minimask *mask)
2389 {
2390     const uint64_t *b_u64 = (const uint64_t *) b;
2391     const uint64_t *p = miniflow_get_values(&mask->masks);
2392     size_t idx;
2393
2394     MAPS_FOR_EACH_INDEX(idx, mask->masks) {
2395         if ((miniflow_get(a, idx) ^ b_u64[idx]) & *p++) {
2396             return false;
2397         }
2398     }
2399
2400     return true;
2401 }
2402
2403 \f
2404 void
2405 minimask_init(struct minimask *mask, const struct flow_wildcards *wc)
2406 {
2407     miniflow_init(&mask->masks, &wc->masks);
2408 }
2409
2410 /* Returns a minimask copy of 'wc'.  The caller must eventually free the
2411  * returned minimask with free(). */
2412 struct minimask *
2413 minimask_create(const struct flow_wildcards *wc)
2414 {
2415     return (struct minimask *)miniflow_create(&wc->masks);
2416 }
2417
2418 /* Initializes 'dst_' as the bit-wise "and" of 'a_' and 'b_'.
2419  *
2420  * The caller must provide room for FLOW_U64S "uint64_t"s in 'storage', which
2421  * must follow '*dst_' in memory, for use by 'dst_'.  The caller must *not*
2422  * free 'dst_' free(). */
2423 void
2424 minimask_combine(struct minimask *dst_,
2425                  const struct minimask *a_, const struct minimask *b_,
2426                  uint64_t storage[FLOW_U64S])
2427 {
2428     struct miniflow *dst = &dst_->masks;
2429     uint64_t *dst_values = storage;
2430     const struct miniflow *a = &a_->masks;
2431     const struct miniflow *b = &b_->masks;
2432     const uint64_t *ap = miniflow_get_values(a);
2433     const uint64_t *bp = miniflow_get_values(b);
2434     size_t idx;
2435
2436     dst->tnl_map = 0;
2437     MAP_FOR_EACH_INDEX(idx, a->tnl_map & b->tnl_map) {
2438         /* Both 'a' and 'b' have non-zero data at 'idx'. */
2439         uint64_t mask = *miniflow_values_get__(ap, a->tnl_map, idx)
2440             & *miniflow_values_get__(bp, b->tnl_map, idx);
2441
2442         if (mask) {
2443             dst->tnl_map |= UINT64_C(1) << idx;
2444             *dst_values++ = mask;
2445         }
2446     }
2447     dst->pkt_map = 0;
2448     ap += count_1bits(a->tnl_map);   /* Skip tnl_map values. */
2449     bp += count_1bits(b->tnl_map);   /* Skip tnl_map values. */
2450     MAP_FOR_EACH_INDEX(idx, a->pkt_map & b->pkt_map) {
2451         /* Both 'a' and 'b' have non-zero data at 'idx'. */
2452         uint64_t mask = *miniflow_values_get__(ap, a->pkt_map, idx)
2453             & *miniflow_values_get__(bp, b->pkt_map, idx);
2454
2455         if (mask) {
2456             dst->pkt_map |= UINT64_C(1) << idx;
2457             *dst_values++ = mask;
2458         }
2459     }
2460 }
2461
2462 /* Initializes 'wc' as a copy of 'mask'. */
2463 void
2464 minimask_expand(const struct minimask *mask, struct flow_wildcards *wc)
2465 {
2466     miniflow_expand(&mask->masks, &wc->masks);
2467 }
2468
2469 /* Returns true if 'a' and 'b' are the same flow mask, false otherwise.
2470  * Minimasks may not have zero data values, so for the minimasks to be the
2471  * same, they need to have the same map and the same data values. */
2472 bool
2473 minimask_equal(const struct minimask *a, const struct minimask *b)
2474 {
2475     return a->masks.tnl_map == b->masks.tnl_map
2476         && a->masks.pkt_map == b->masks.pkt_map &&
2477         !memcmp(miniflow_get_values(&a->masks), miniflow_get_values(&b->masks),
2478                 MINIFLOW_VALUES_SIZE(miniflow_n_values(&a->masks)));
2479 }
2480
2481 /* Returns true if at least one bit matched by 'b' is wildcarded by 'a',
2482  * false otherwise. */
2483 bool
2484 minimask_has_extra(const struct minimask *a, const struct minimask *b)
2485 {
2486     const uint64_t *ap = miniflow_get_values(&a->masks);
2487     const uint64_t *bp = miniflow_get_values(&b->masks);
2488     size_t idx;
2489
2490     MAP_FOR_EACH_INDEX(idx, b->masks.tnl_map) {
2491         uint64_t b_u64 = *bp++;
2492
2493         /* 'b_u64' is non-zero, check if the data in 'a' is either zero
2494          * or misses some of the bits in 'b_u64'. */
2495         if (!(a->masks.tnl_map & (UINT64_C(1) << idx))
2496             || ((*miniflow_values_get__(ap, a->masks.tnl_map, idx) & b_u64)
2497                 != b_u64)) {
2498             return true; /* 'a' wildcards some bits 'b' doesn't. */
2499         }
2500     }
2501     ap += count_1bits(a->masks.tnl_map);   /* Skip tnl_map values. */
2502     MAP_FOR_EACH_INDEX(idx, b->masks.pkt_map) {
2503         uint64_t b_u64 = *bp++;
2504
2505         if (!(a->masks.pkt_map & (UINT64_C(1) << idx))
2506             || ((*miniflow_values_get__(ap, a->masks.pkt_map, idx) & b_u64)
2507                 != b_u64)) {
2508             return true; /* 'a' wildcards some bits 'b' doesn't. */
2509         }
2510     }
2511
2512     return false;
2513 }