lib/flow.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 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 "ofpbuf.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 /* U32 indices for segmented flow classification. */
  46 const uint8_t flow_segment_u32s[4] = {
  47     FLOW_SEGMENT_1_ENDS_AT / 4,
  48     FLOW_SEGMENT_2_ENDS_AT / 4,
  49     FLOW_SEGMENT_3_ENDS_AT / 4,
  50     FLOW_U32S
  51 };
  52
  53 /* miniflow_extract() assumes the following to be true to optimize the
  54  * extraction process. */
  55 BUILD_ASSERT_DECL(offsetof(struct flow, dl_type) + 2
  56                   == offsetof(struct flow, vlan_tci) &&
  57                   offsetof(struct flow, dl_type) / 4
  58                   == offsetof(struct flow, vlan_tci) / 4 );
  59
  60 BUILD_ASSERT_DECL(offsetof(struct flow, nw_frag) + 3
  61                   == offsetof(struct flow, nw_proto) &&
  62                   offsetof(struct flow, nw_tos) + 2
  63                   == offsetof(struct flow, nw_proto) &&
  64                   offsetof(struct flow, nw_ttl) + 1
  65                   == offsetof(struct flow, nw_proto) &&
  66                   offsetof(struct flow, nw_frag) / 4
  67                   == offsetof(struct flow, nw_tos) / 4 &&
  68                   offsetof(struct flow, nw_ttl) / 4
  69                   == offsetof(struct flow, nw_tos) / 4 &&
  70                   offsetof(struct flow, nw_proto) / 4
  71                   == offsetof(struct flow, nw_tos) / 4);
  72
  73 /* TCP flags in the first half of a BE32, zeroes in the other half. */
  74 BUILD_ASSERT_DECL(offsetof(struct flow, tcp_flags) + 2
  75                   == offsetof(struct flow, pad) &&
  76                   offsetof(struct flow, tcp_flags) / 4
  77                   == offsetof(struct flow, pad) / 4);
  78 #if WORDS_BIGENDIAN
  79 #define TCP_FLAGS_BE32(tcp_ctl) ((OVS_FORCE ovs_be32)TCP_FLAGS_BE16(tcp_ctl) \
  80                                  << 16)
  81 #else
  82 #define TCP_FLAGS_BE32(tcp_ctl) ((OVS_FORCE ovs_be32)TCP_FLAGS_BE16(tcp_ctl))
  83 #endif
  84
  85 BUILD_ASSERT_DECL(offsetof(struct flow, tp_src) + 2
  86                   == offsetof(struct flow, tp_dst) &&
  87                   offsetof(struct flow, tp_src) / 4
  88                   == offsetof(struct flow, tp_dst) / 4);
  89
  90 /* Removes 'size' bytes from the head end of '*datap', of size '*sizep', which
  91  * must contain at least 'size' bytes of data.  Returns the first byte of data
  92  * removed. */
  93 static inline const void *
  94 data_pull(void **datap, size_t *sizep, size_t size)
  95 {
  96     char *data = (char *)*datap;
  97     *datap = data + size;
  98     *sizep -= size;
  99     return data;
 100 }
 101
 102 /* If '*datap' has at least 'size' bytes of data, removes that many bytes from
 103  * the head end of '*datap' and returns the first byte removed.  Otherwise,
 104  * returns a null pointer without modifying '*datap'. */
 105 static inline const void *
 106 data_try_pull(void **datap, size_t *sizep, size_t size)
 107 {
 108     return OVS_LIKELY(*sizep >= size) ? data_pull(datap, sizep, size) : NULL;
 109 }
 110
 111 /* Context for pushing data to a miniflow. */
 112 struct mf_ctx {
 113     uint64_t map;
 114     uint32_t *data;
 115     uint32_t * const end;
 116 };
 117
 118 /* miniflow_push_* macros allow filling in a miniflow data values in order.
 119  * Assertions are needed only when the layout of the struct flow is modified.
 120  * 'ofs' is a compile-time constant, which allows most of the code be optimized
 121  * away.  Some GCC versions gave warnigns on ALWAYS_INLINE, so these are
 122  * defined as macros. */
 123
 124 #if (FLOW_WC_SEQ != 26)
 125 #define MINIFLOW_ASSERT(X) ovs_assert(X)
 126 #else
 127 #define MINIFLOW_ASSERT(X)
 128 #endif
 129
 130 #define miniflow_push_uint32_(MF, OFS, VALUE)                   \
 131 {                                                               \
 132     MINIFLOW_ASSERT(MF.data < MF.end && (OFS) % 4 == 0          \
 133                     && !(MF.map & (UINT64_MAX << (OFS) / 4)));  \
 134     *MF.data++ = VALUE;                                         \
 135     MF.map |= UINT64_C(1) << (OFS) / 4;                         \
 136 }
 137
 138 #define miniflow_push_be32_(MF, OFS, VALUE) \
 139     miniflow_push_uint32_(MF, OFS, (OVS_FORCE uint32_t)(VALUE))
 140
 141 #define miniflow_push_uint16_(MF, OFS, VALUE)                   \
 142 {                                                               \
 143     MINIFLOW_ASSERT(MF.data < MF.end &&                                 \
 144                     (((OFS) % 4 == 0 && !(MF.map & (UINT64_MAX << (OFS) / 4))) \
 145                      || ((OFS) % 4 == 2 && MF.map & (UINT64_C(1) << (OFS) / 4) \
 146                          && !(MF.map & (UINT64_MAX << ((OFS) / 4 + 1)))))); \
 147                                                                         \
 148     if ((OFS) % 4 == 0) {                                               \
 149         *(uint16_t *)MF.data = VALUE;                                   \
 150         MF.map |= UINT64_C(1) << (OFS) / 4;                             \
 151     } else if ((OFS) % 4 == 2) {                                        \
 152         *((uint16_t *)MF.data + 1) = VALUE;                             \
 153         MF.data++;                                                      \
 154     }                                                                   \
 155 }
 156
 157 #define miniflow_push_be16_(MF, OFS, VALUE)             \
 158     miniflow_push_uint16_(MF, OFS, (OVS_FORCE uint16_t)VALUE);
 159
 160 /* Data at 'valuep' may be unaligned. */
 161 #define miniflow_push_words_(MF, OFS, VALUEP, N_WORDS)          \
 162 {                                                               \
 163     int ofs32 = (OFS) / 4;                                      \
 164                                                                         \
 165     MINIFLOW_ASSERT(MF.data + (N_WORDS) <= MF.end && (OFS) % 4 == 0     \
 166                     && !(MF.map & (UINT64_MAX << ofs32)));              \
 167                                                                         \
 168     memcpy(MF.data, (VALUEP), (N_WORDS) * sizeof *MF.data);             \
 169     MF.data += (N_WORDS);                                               \
 170     MF.map |= ((UINT64_MAX >> (64 - (N_WORDS))) << ofs32);              \
 171 }
 172
 173 #define miniflow_push_uint32(MF, FIELD, VALUE)                          \
 174     miniflow_push_uint32_(MF, offsetof(struct flow, FIELD), VALUE)
 175
 176 #define miniflow_push_be32(MF, FIELD, VALUE)                            \
 177     miniflow_push_be32_(MF, offsetof(struct flow, FIELD), VALUE)
 178
 179 #define miniflow_push_uint32_check(MF, FIELD, VALUE)                    \
 180     { if (OVS_LIKELY(VALUE)) {                                          \
 181             miniflow_push_uint32_(MF, offsetof(struct flow, FIELD), VALUE); \
 182         }                                                               \
 183     }
 184
 185 #define miniflow_push_be32_check(MF, FIELD, VALUE)                      \
 186     { if (OVS_LIKELY(VALUE)) {                                          \
 187             miniflow_push_be32_(MF, offsetof(struct flow, FIELD), VALUE); \
 188         }                                                               \
 189     }
 190
 191 #define miniflow_push_uint16(MF, FIELD, VALUE)                          \
 192     miniflow_push_uint16_(MF, offsetof(struct flow, FIELD), VALUE)
 193
 194 #define miniflow_push_be16(MF, FIELD, VALUE)                            \
 195     miniflow_push_be16_(MF, offsetof(struct flow, FIELD), VALUE)
 196
 197 #define miniflow_push_words(MF, FIELD, VALUEP, N_WORDS)                 \
 198     miniflow_push_words_(MF, offsetof(struct flow, FIELD), VALUEP, N_WORDS)
 199
 200 /* Pulls the MPLS headers at '*datap' and returns the count of them. */
 201 static inline int
 202 parse_mpls(void **datap, size_t *sizep)
 203 {
 204     const struct mpls_hdr *mh;
 205     int count = 0;
 206
 207     while ((mh = data_try_pull(datap, sizep, sizeof *mh))) {
 208         count++;
 209         if (mh->mpls_lse.lo & htons(1 << MPLS_BOS_SHIFT)) {
 210             break;
 211         }
 212     }
 213     return MAX(count, FLOW_MAX_MPLS_LABELS);
 214 }
 215
 216 static inline ovs_be16
 217 parse_vlan(void **datap, size_t *sizep)
 218 {
 219     const struct eth_header *eth = *datap;
 220
 221     struct qtag_prefix {
 222         ovs_be16 eth_type;      /* ETH_TYPE_VLAN */
 223         ovs_be16 tci;
 224     };
 225
 226     data_pull(datap, sizep, ETH_ADDR_LEN * 2);
 227
 228     if (eth->eth_type == htons(ETH_TYPE_VLAN)) {
 229         if (OVS_LIKELY(*sizep
 230                        >= sizeof(struct qtag_prefix) + sizeof(ovs_be16))) {
 231             const struct qtag_prefix *qp = data_pull(datap, sizep, sizeof *qp);
 232             return qp->tci | htons(VLAN_CFI);
 233         }
 234     }
 235     return 0;
 236 }
 237
 238 static inline ovs_be16
 239 parse_ethertype(void **datap, size_t *sizep)
 240 {
 241     const struct llc_snap_header *llc;
 242     ovs_be16 proto;
 243
 244     proto = *(ovs_be16 *) data_pull(datap, sizep, sizeof proto);
 245     if (OVS_LIKELY(ntohs(proto) >= ETH_TYPE_MIN)) {
 246         return proto;
 247     }
 248
 249     if (OVS_UNLIKELY(*sizep < sizeof *llc)) {
 250         return htons(FLOW_DL_TYPE_NONE);
 251     }
 252
 253     llc = *datap;
 254     if (OVS_UNLIKELY(llc->llc.llc_dsap != LLC_DSAP_SNAP
 255                      || llc->llc.llc_ssap != LLC_SSAP_SNAP
 256                      || llc->llc.llc_cntl != LLC_CNTL_SNAP
 257                      || memcmp(llc->snap.snap_org, SNAP_ORG_ETHERNET,
 258                                sizeof llc->snap.snap_org))) {
 259         return htons(FLOW_DL_TYPE_NONE);
 260     }
 261
 262     data_pull(datap, sizep, sizeof *llc);
 263
 264     if (OVS_LIKELY(ntohs(llc->snap.snap_type) >= ETH_TYPE_MIN)) {
 265         return llc->snap.snap_type;
 266     }
 267
 268     return htons(FLOW_DL_TYPE_NONE);
 269 }
 270
 271 static inline bool
 272 parse_icmpv6(void **datap, size_t *sizep, const struct icmp6_hdr *icmp,
 273              const struct in6_addr **nd_target,
 274              uint8_t arp_buf[2][ETH_ADDR_LEN])
 275 {
 276     if (icmp->icmp6_code == 0 &&
 277         (icmp->icmp6_type == ND_NEIGHBOR_SOLICIT ||
 278          icmp->icmp6_type == ND_NEIGHBOR_ADVERT)) {
 279
 280         *nd_target = data_try_pull(datap, sizep, sizeof *nd_target);
 281         if (OVS_UNLIKELY(!*nd_target)) {
 282             return false;
 283         }
 284
 285         while (*sizep >= 8) {
 286             /* The minimum size of an option is 8 bytes, which also is
 287              * the size of Ethernet link-layer options. */
 288             const struct nd_opt_hdr *nd_opt = *datap;
 289             int opt_len = nd_opt->nd_opt_len * 8;
 290
 291             if (!opt_len || opt_len > *sizep) {
 292                 goto invalid;
 293             }
 294
 295             /* Store the link layer address if the appropriate option is
 296              * provided.  It is considered an error if the same link
 297              * layer option is specified twice. */
 298             if (nd_opt->nd_opt_type == ND_OPT_SOURCE_LINKADDR
 299                     && opt_len == 8) {
 300                 if (OVS_LIKELY(eth_addr_is_zero(arp_buf[0]))) {
 301                     memcpy(arp_buf[0], nd_opt + 1, ETH_ADDR_LEN);
 302                 } else {
 303                     goto invalid;
 304                 }
 305             } else if (nd_opt->nd_opt_type == ND_OPT_TARGET_LINKADDR
 306                     && opt_len == 8) {
 307                 if (OVS_LIKELY(eth_addr_is_zero(arp_buf[1]))) {
 308                     memcpy(arp_buf[1], nd_opt + 1, ETH_ADDR_LEN);
 309                 } else {
 310                     goto invalid;
 311                 }
 312             }
 313
 314             if (OVS_UNLIKELY(!data_try_pull(datap, sizep, opt_len))) {
 315                 goto invalid;
 316             }
 317         }
 318     }
 319
 320     return true;
 321
 322 invalid:
 323     return false;
 324 }
 325
 326 /* Initializes 'flow' members from 'packet' and 'md'
 327  *
 328  * Initializes 'packet' header l2 pointer to the start of the Ethernet
 329  * header, and the layer offsets as follows:
 330  *
 331  *    - packet->l2_5_ofs to the start of the MPLS shim header, or UINT16_MAX
 332  *      when there is no MPLS shim header.
 333  *
 334  *    - packet->l3_ofs to just past the Ethernet header, or just past the
 335  *      vlan_header if one is present, to the first byte of the payload of the
 336  *      Ethernet frame.  UINT16_MAX if the frame is too short to contain an
 337  *      Ethernet header.
 338  *
 339  *    - packet->l4_ofs to just past the IPv4 header, if one is present and
 340  *      has at least the content used for the fields of interest for the flow,
 341  *      otherwise UINT16_MAX.
 342  */
 343 void
 344 flow_extract(struct ofpbuf *packet, const struct pkt_metadata *md,
 345              struct flow *flow)
 346 {
 347     uint32_t buf[FLOW_U32S];
 348     struct miniflow mf;
 349
 350     COVERAGE_INC(flow_extract);
 351
 352     miniflow_initialize(&mf, buf);
 353     miniflow_extract(packet, md, &mf);
 354     miniflow_expand(&mf, flow);
 355 }
 356
 357 /* Caller is responsible for initializing 'dst->values' with enough storage
 358  * (FLOW_U64S * 8 bytes is enough). */
 359 void
 360 miniflow_extract(struct ofpbuf *packet, const struct pkt_metadata *md,
 361                  struct miniflow *dst)
 362 {
 363     void *data = ofpbuf_data(packet);
 364     size_t size = ofpbuf_size(packet);
 365     char *l2;
 366     struct mf_ctx mf = { 0, dst->values, dst->values + FLOW_U32S };
 367     ovs_be16 dl_type;
 368     uint8_t nw_frag, nw_tos, nw_ttl, nw_proto;
 369
 370     /* Metadata. */
 371     if (md) {
 372         if (md->tunnel.ip_dst) {
 373             miniflow_push_words(mf, tunnel, &md->tunnel,
 374                                 sizeof md->tunnel / 4);
 375         }
 376         miniflow_push_uint32_check(mf, skb_priority, md->skb_priority);
 377         miniflow_push_uint32_check(mf, pkt_mark, md->pkt_mark);
 378         miniflow_push_uint32_check(mf, recirc_id, md->recirc_id);
 379         miniflow_push_uint32(mf, in_port, odp_to_u32(md->in_port.odp_port));
 380     }
 381
 382     /* Initialize packet's layer pointer and offsets. */
 383     l2 = data;
 384     ofpbuf_set_frame(packet, data);
 385
 386     /* Must have full Ethernet header to proceed. */
 387     if (OVS_UNLIKELY(size < sizeof(struct eth_header))) {
 388         goto out;
 389     } else {
 390         ovs_be16 vlan_tci;
 391
 392         /* Link layer. */
 393         BUILD_ASSERT(offsetof(struct flow, dl_dst) + 6
 394                      == offsetof(struct flow, dl_src));
 395         miniflow_push_words(mf, dl_dst, data, ETH_ADDR_LEN * 2 / 4);
 396         /* dl_type, vlan_tci. */
 397         vlan_tci = parse_vlan(&data, &size);
 398         dl_type = parse_ethertype(&data, &size);
 399         miniflow_push_be16(mf, dl_type, dl_type);
 400         miniflow_push_be16(mf, vlan_tci, vlan_tci);
 401     }
 402
 403     /* Parse mpls. */
 404     if (OVS_UNLIKELY(eth_type_mpls(dl_type))) {
 405         int count;
 406         const void *mpls = data;
 407
 408         packet->l2_5_ofs = (char *)data - l2;
 409         count = parse_mpls(&data, &size);
 410         miniflow_push_words(mf, mpls_lse, mpls, count);
 411     }
 412
 413     /* Network layer. */
 414     packet->l3_ofs = (char *)data - l2;
 415
 416     nw_frag = 0;
 417     if (OVS_LIKELY(dl_type == htons(ETH_TYPE_IP))) {
 418         const struct ip_header *nh = data;
 419         int ip_len;
 420
 421         if (OVS_UNLIKELY(size < IP_HEADER_LEN)) {
 422             goto out;
 423         }
 424         ip_len = IP_IHL(nh->ip_ihl_ver) * 4;
 425
 426         if (OVS_UNLIKELY(ip_len < IP_HEADER_LEN)) {
 427             goto out;
 428         }
 429
 430         /* Push both source and destination address at once. */
 431         miniflow_push_words(mf, nw_src, &nh->ip_src, 2);
 432
 433         nw_tos = nh->ip_tos;
 434         nw_ttl = nh->ip_ttl;
 435         nw_proto = nh->ip_proto;
 436         if (OVS_UNLIKELY(IP_IS_FRAGMENT(nh->ip_frag_off))) {
 437             nw_frag = FLOW_NW_FRAG_ANY;
 438             if (nh->ip_frag_off & htons(IP_FRAG_OFF_MASK)) {
 439                 nw_frag |= FLOW_NW_FRAG_LATER;
 440             }
 441         }
 442         if (OVS_UNLIKELY(size < ip_len)) {
 443             goto out;
 444         }
 445         data_pull(&data, &size, ip_len);
 446
 447     } else if (dl_type == htons(ETH_TYPE_IPV6)) {
 448         const struct ovs_16aligned_ip6_hdr *nh;
 449         ovs_be32 tc_flow;
 450
 451         if (OVS_UNLIKELY(size < sizeof *nh)) {
 452             goto out;
 453         }
 454         nh = data_pull(&data, &size, sizeof *nh);
 455
 456         miniflow_push_words(mf, ipv6_src, &nh->ip6_src,
 457                             sizeof nh->ip6_src / 4);
 458         miniflow_push_words(mf, ipv6_dst, &nh->ip6_dst,
 459                             sizeof nh->ip6_dst / 4);
 460
 461         tc_flow = get_16aligned_be32(&nh->ip6_flow);
 462         {
 463             ovs_be32 label = tc_flow & htonl(IPV6_LABEL_MASK);
 464             miniflow_push_be32_check(mf, ipv6_label, label);
 465         }
 466
 467         nw_tos = ntohl(tc_flow) >> 20;
 468         nw_ttl = nh->ip6_hlim;
 469         nw_proto = nh->ip6_nxt;
 470
 471         while (1) {
 472             if (OVS_LIKELY((nw_proto != IPPROTO_HOPOPTS)
 473                            && (nw_proto != IPPROTO_ROUTING)
 474                            && (nw_proto != IPPROTO_DSTOPTS)
 475                            && (nw_proto != IPPROTO_AH)
 476                            && (nw_proto != IPPROTO_FRAGMENT))) {
 477                 /* It's either a terminal header (e.g., TCP, UDP) or one we
 478                  * don't understand.  In either case, we're done with the
 479                  * packet, so use it to fill in 'nw_proto'. */
 480                 break;
 481             }
 482
 483             /* We only verify that at least 8 bytes of the next header are
 484              * available, but many of these headers are longer.  Ensure that
 485              * accesses within the extension header are within those first 8
 486              * bytes. All extension headers are required to be at least 8
 487              * bytes. */
 488             if (OVS_UNLIKELY(size < 8)) {
 489                 goto out;
 490             }
 491
 492             if ((nw_proto == IPPROTO_HOPOPTS)
 493                 || (nw_proto == IPPROTO_ROUTING)
 494                 || (nw_proto == IPPROTO_DSTOPTS)) {
 495                 /* These headers, while different, have the fields we care
 496                  * about in the same location and with the same
 497                  * interpretation. */
 498                 const struct ip6_ext *ext_hdr = data;
 499                 nw_proto = ext_hdr->ip6e_nxt;
 500                 if (OVS_UNLIKELY(!data_try_pull(&data, &size,
 501                                                 (ext_hdr->ip6e_len + 1) * 8))) {
 502                     goto out;
 503                 }
 504             } else if (nw_proto == IPPROTO_AH) {
 505                 /* A standard AH definition isn't available, but the fields
 506                  * we care about are in the same location as the generic
 507                  * option header--only the header length is calculated
 508                  * differently. */
 509                 const struct ip6_ext *ext_hdr = data;
 510                 nw_proto = ext_hdr->ip6e_nxt;
 511                 if (OVS_UNLIKELY(!data_try_pull(&data, &size,
 512                                                 (ext_hdr->ip6e_len + 2) * 4))) {
 513                     goto out;
 514                 }
 515             } else if (nw_proto == IPPROTO_FRAGMENT) {
 516                 const struct ovs_16aligned_ip6_frag *frag_hdr = data;
 517
 518                 nw_proto = frag_hdr->ip6f_nxt;
 519                 if (!data_try_pull(&data, &size, sizeof *frag_hdr)) {
 520                     goto out;
 521                 }
 522
 523                 /* We only process the first fragment. */
 524                 if (frag_hdr->ip6f_offlg != htons(0)) {
 525                     nw_frag = FLOW_NW_FRAG_ANY;
 526                     if ((frag_hdr->ip6f_offlg & IP6F_OFF_MASK) != htons(0)) {
 527                         nw_frag |= FLOW_NW_FRAG_LATER;
 528                         nw_proto = IPPROTO_FRAGMENT;
 529                         break;
 530                     }
 531                 }
 532             }
 533         }
 534     } else {
 535         if (dl_type == htons(ETH_TYPE_ARP) ||
 536             dl_type == htons(ETH_TYPE_RARP)) {
 537             uint8_t arp_buf[2][ETH_ADDR_LEN];
 538             const struct arp_eth_header *arp = (const struct arp_eth_header *)
 539                 data_try_pull(&data, &size, ARP_ETH_HEADER_LEN);
 540
 541             if (OVS_LIKELY(arp) && OVS_LIKELY(arp->ar_hrd == htons(1))
 542                 && OVS_LIKELY(arp->ar_pro == htons(ETH_TYPE_IP))
 543                 && OVS_LIKELY(arp->ar_hln == ETH_ADDR_LEN)
 544                 && OVS_LIKELY(arp->ar_pln == 4)) {
 545                 miniflow_push_words(mf, nw_src, &arp->ar_spa, 1);
 546                 miniflow_push_words(mf, nw_dst, &arp->ar_tpa, 1);
 547
 548                 /* We only match on the lower 8 bits of the opcode. */
 549                 if (OVS_LIKELY(ntohs(arp->ar_op) <= 0xff)) {
 550                     miniflow_push_be32(mf, nw_frag, htonl(ntohs(arp->ar_op)));
 551                 }
 552
 553                 /* Must be adjacent. */
 554                 BUILD_ASSERT(offsetof(struct flow, arp_sha) + 6
 555                              == offsetof(struct flow, arp_tha));
 556
 557                 memcpy(arp_buf[0], arp->ar_sha, ETH_ADDR_LEN);
 558                 memcpy(arp_buf[1], arp->ar_tha, ETH_ADDR_LEN);
 559                 miniflow_push_words(mf, arp_sha, arp_buf,
 560                                     ETH_ADDR_LEN * 2 / 4);
 561             }
 562         }
 563         goto out;
 564     }
 565
 566     packet->l4_ofs = (char *)data - l2;
 567     miniflow_push_be32(mf, nw_frag,
 568                        BYTES_TO_BE32(nw_frag, nw_tos, nw_ttl, nw_proto));
 569
 570     if (OVS_LIKELY(!(nw_frag & FLOW_NW_FRAG_LATER))) {
 571         if (OVS_LIKELY(nw_proto == IPPROTO_TCP)) {
 572             if (OVS_LIKELY(size >= TCP_HEADER_LEN)) {
 573                 const struct tcp_header *tcp = data;
 574
 575                 miniflow_push_be32(mf, tcp_flags,
 576                                    TCP_FLAGS_BE32(tcp->tcp_ctl));
 577                 miniflow_push_words(mf, tp_src, &tcp->tcp_src, 1);
 578             }
 579         } else if (OVS_LIKELY(nw_proto == IPPROTO_UDP)) {
 580             if (OVS_LIKELY(size >= UDP_HEADER_LEN)) {
 581                 const struct udp_header *udp = data;
 582
 583                 miniflow_push_words(mf, tp_src, &udp->udp_src, 1);
 584             }
 585         } else if (OVS_LIKELY(nw_proto == IPPROTO_SCTP)) {
 586             if (OVS_LIKELY(size >= SCTP_HEADER_LEN)) {
 587                 const struct sctp_header *sctp = data;
 588
 589                 miniflow_push_words(mf, tp_src, &sctp->sctp_src, 1);
 590             }
 591         } else if (OVS_LIKELY(nw_proto == IPPROTO_ICMP)) {
 592             if (OVS_LIKELY(size >= ICMP_HEADER_LEN)) {
 593                 const struct icmp_header *icmp = data;
 594
 595                 miniflow_push_be16(mf, tp_src, htons(icmp->icmp_type));
 596                 miniflow_push_be16(mf, tp_dst, htons(icmp->icmp_code));
 597             }
 598         } else if (OVS_LIKELY(nw_proto == IPPROTO_ICMPV6)) {
 599             if (OVS_LIKELY(size >= sizeof(struct icmp6_hdr))) {
 600                 const struct in6_addr *nd_target = NULL;
 601                 uint8_t arp_buf[2][ETH_ADDR_LEN];
 602                 const struct icmp6_hdr *icmp = data_pull(&data, &size,
 603                                                          sizeof *icmp);
 604                 memset(arp_buf, 0, sizeof arp_buf);
 605                 if (OVS_LIKELY(parse_icmpv6(&data, &size, icmp, &nd_target,
 606                                             arp_buf))) {
 607                     if (nd_target) {
 608                         miniflow_push_words(mf, nd_target, nd_target,
 609                                             sizeof *nd_target / 4);
 610                     }
 611                     miniflow_push_words(mf, arp_sha, arp_buf,
 612                                              ETH_ADDR_LEN * 2 / 4);
 613                     miniflow_push_be16(mf, tp_src, htons(icmp->icmp6_type));
 614                     miniflow_push_be16(mf, tp_dst, htons(icmp->icmp6_code));
 615                 }
 616             }
 617         }
 618     }
 619     if (md) {
 620         miniflow_push_uint32_check(mf, dp_hash, md->dp_hash);
 621     }
 622  out:
 623     dst->map = mf.map;
 624 }
 625
 626 /* For every bit of a field that is wildcarded in 'wildcards', sets the
 627  * corresponding bit in 'flow' to zero. */
 628 void
 629 flow_zero_wildcards(struct flow *flow, const struct flow_wildcards *wildcards)
 630 {
 631     uint32_t *flow_u32 = (uint32_t *) flow;
 632     const uint32_t *wc_u32 = (const uint32_t *) &wildcards->masks;
 633     size_t i;
 634
 635     for (i = 0; i < FLOW_U32S; i++) {
 636         flow_u32[i] &= wc_u32[i];
 637     }
 638 }
 639
 640 void
 641 flow_unwildcard_tp_ports(const struct flow *flow, struct flow_wildcards *wc)
 642 {
 643     if (flow->nw_proto != IPPROTO_ICMP) {
 644         memset(&wc->masks.tp_src, 0xff, sizeof wc->masks.tp_src);
 645         memset(&wc->masks.tp_dst, 0xff, sizeof wc->masks.tp_dst);
 646     } else {
 647         wc->masks.tp_src = htons(0xff);
 648         wc->masks.tp_dst = htons(0xff);
 649     }
 650 }
 651
 652 /* Initializes 'fmd' with the metadata found in 'flow'. */
 653 void
 654 flow_get_metadata(const struct flow *flow, struct flow_metadata *fmd)
 655 {
 656     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 26);
 657
 658     fmd->dp_hash = flow->dp_hash;
 659     fmd->recirc_id = flow->recirc_id;
 660     fmd->tun_id = flow->tunnel.tun_id;
 661     fmd->tun_src = flow->tunnel.ip_src;
 662     fmd->tun_dst = flow->tunnel.ip_dst;
 663     fmd->metadata = flow->metadata;
 664     memcpy(fmd->regs, flow->regs, sizeof fmd->regs);
 665     fmd->pkt_mark = flow->pkt_mark;
 666     fmd->in_port = flow->in_port.ofp_port;
 667 }
 668
 669 char *
 670 flow_to_string(const struct flow *flow)
 671 {
 672     struct ds ds = DS_EMPTY_INITIALIZER;
 673     flow_format(&ds, flow);
 674     return ds_cstr(&ds);
 675 }
 676
 677 const char *
 678 flow_tun_flag_to_string(uint32_t flags)
 679 {
 680     switch (flags) {
 681     case FLOW_TNL_F_DONT_FRAGMENT:
 682         return "df";
 683     case FLOW_TNL_F_CSUM:
 684         return "csum";
 685     case FLOW_TNL_F_KEY:
 686         return "key";
 687     default:
 688         return NULL;
 689     }
 690 }
 691
 692 void
 693 format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t),
 694              uint32_t flags, char del)
 695 {
 696     uint32_t bad = 0;
 697
 698     if (!flags) {
 699         return;
 700     }
 701     while (flags) {
 702         uint32_t bit = rightmost_1bit(flags);
 703         const char *s;
 704
 705         s = bit_to_string(bit);
 706         if (s) {
 707             ds_put_format(ds, "%s%c", s, del);
 708         } else {
 709             bad |= bit;
 710         }
 711
 712         flags &= ~bit;
 713     }
 714
 715     if (bad) {
 716         ds_put_format(ds, "0x%"PRIx32"%c", bad, del);
 717     }
 718     ds_chomp(ds, del);
 719 }
 720
 721 void
 722 format_flags_masked(struct ds *ds, const char *name,
 723                     const char *(*bit_to_string)(uint32_t), uint32_t flags,
 724                     uint32_t mask)
 725 {
 726     if (name) {
 727         ds_put_format(ds, "%s=", name);
 728     }
 729     while (mask) {
 730         uint32_t bit = rightmost_1bit(mask);
 731         const char *s = bit_to_string(bit);
 732
 733         ds_put_format(ds, "%s%s", (flags & bit) ? "+" : "-",
 734                       s ? s : "[Unknown]");
 735         mask &= ~bit;
 736     }
 737 }
 738
 739 void
 740 flow_format(struct ds *ds, const struct flow *flow)
 741 {
 742     struct match match;
 743
 744     match_wc_init(&match, flow);
 745     match_format(&match, ds, OFP_DEFAULT_PRIORITY);
 746 }
 747
 748 void
 749 flow_print(FILE *stream, const struct flow *flow)
 750 {
 751     char *s = flow_to_string(flow);
 752     fputs(s, stream);
 753     free(s);
 754 }
 755 \f
 756 /* flow_wildcards functions. */
 757
 758 /* Initializes 'wc' as a set of wildcards that matches every packet. */
 759 void
 760 flow_wildcards_init_catchall(struct flow_wildcards *wc)
 761 {
 762     memset(&wc->masks, 0, sizeof wc->masks);
 763 }
 764
 765 /* Clear the metadata and register wildcard masks. They are not packet
 766  * header fields. */
 767 void
 768 flow_wildcards_clear_non_packet_fields(struct flow_wildcards *wc)
 769 {
 770     memset(&wc->masks.metadata, 0, sizeof wc->masks.metadata);
 771     memset(&wc->masks.regs, 0, sizeof wc->masks.regs);
 772 }
 773
 774 /* Returns true if 'wc' matches every packet, false if 'wc' fixes any bits or
 775  * fields. */
 776 bool
 777 flow_wildcards_is_catchall(const struct flow_wildcards *wc)
 778 {
 779     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
 780     size_t i;
 781
 782     for (i = 0; i < FLOW_U32S; i++) {
 783         if (wc_u32[i]) {
 784             return false;
 785         }
 786     }
 787     return true;
 788 }
 789
 790 /* Sets 'dst' as the bitwise AND of wildcards in 'src1' and 'src2'.
 791  * That is, a bit or a field is wildcarded in 'dst' if it is wildcarded
 792  * in 'src1' or 'src2' or both.  */
 793 void
 794 flow_wildcards_and(struct flow_wildcards *dst,
 795                    const struct flow_wildcards *src1,
 796                    const struct flow_wildcards *src2)
 797 {
 798     uint32_t *dst_u32 = (uint32_t *) &dst->masks;
 799     const uint32_t *src1_u32 = (const uint32_t *) &src1->masks;
 800     const uint32_t *src2_u32 = (const uint32_t *) &src2->masks;
 801     size_t i;
 802
 803     for (i = 0; i < FLOW_U32S; i++) {
 804         dst_u32[i] = src1_u32[i] & src2_u32[i];
 805     }
 806 }
 807
 808 /* Sets 'dst' as the bitwise OR of wildcards in 'src1' and 'src2'.  That
 809  * is, a bit or a field is wildcarded in 'dst' if it is neither
 810  * wildcarded in 'src1' nor 'src2'. */
 811 void
 812 flow_wildcards_or(struct flow_wildcards *dst,
 813                   const struct flow_wildcards *src1,
 814                   const struct flow_wildcards *src2)
 815 {
 816     uint32_t *dst_u32 = (uint32_t *) &dst->masks;
 817     const uint32_t *src1_u32 = (const uint32_t *) &src1->masks;
 818     const uint32_t *src2_u32 = (const uint32_t *) &src2->masks;
 819     size_t i;
 820
 821     for (i = 0; i < FLOW_U32S; i++) {
 822         dst_u32[i] = src1_u32[i] | src2_u32[i];
 823     }
 824 }
 825
 826 /* Perform a bitwise OR of miniflow 'src' flow data with the equivalent
 827  * fields in 'dst', storing the result in 'dst'. */
 828 static void
 829 flow_union_with_miniflow(struct flow *dst, const struct miniflow *src)
 830 {
 831     uint32_t *dst_u32 = (uint32_t *) dst;
 832     const uint32_t *p = src->values;
 833     uint64_t map;
 834
 835     for (map = src->map; map; map = zero_rightmost_1bit(map)) {
 836         dst_u32[raw_ctz(map)] |= *p++;
 837     }
 838 }
 839
 840 /* Fold minimask 'mask''s wildcard mask into 'wc's wildcard mask. */
 841 void
 842 flow_wildcards_fold_minimask(struct flow_wildcards *wc,
 843                              const struct minimask *mask)
 844 {
 845     flow_union_with_miniflow(&wc->masks, &mask->masks);
 846 }
 847
 848 uint64_t
 849 miniflow_get_map_in_range(const struct miniflow *miniflow,
 850                           uint8_t start, uint8_t end, unsigned int *offset)
 851 {
 852     uint64_t map = miniflow->map;
 853     *offset = 0;
 854
 855     if (start > 0) {
 856         uint64_t msk = (UINT64_C(1) << start) - 1; /* 'start' LSBs set */
 857         *offset = count_1bits(map & msk);
 858         map &= ~msk;
 859     }
 860     if (end < FLOW_U32S) {
 861         uint64_t msk = (UINT64_C(1) << end) - 1; /* 'end' LSBs set */
 862         map &= msk;
 863     }
 864     return map;
 865 }
 866
 867 /* Fold minimask 'mask''s wildcard mask into 'wc's wildcard mask
 868  * in range [start, end). */
 869 void
 870 flow_wildcards_fold_minimask_range(struct flow_wildcards *wc,
 871                                    const struct minimask *mask,
 872                                    uint8_t start, uint8_t end)
 873 {
 874     uint32_t *dst_u32 = (uint32_t *)&wc->masks;
 875     unsigned int offset;
 876     uint64_t map = miniflow_get_map_in_range(&mask->masks, start, end,
 877                                              &offset);
 878     const uint32_t *p = mask->masks.values + offset;
 879
 880     for (; map; map = zero_rightmost_1bit(map)) {
 881         dst_u32[raw_ctz(map)] |= *p++;
 882     }
 883 }
 884
 885 /* Returns a hash of the wildcards in 'wc'. */
 886 uint32_t
 887 flow_wildcards_hash(const struct flow_wildcards *wc, uint32_t basis)
 888 {
 889     return flow_hash(&wc->masks, basis);
 890 }
 891
 892 /* Returns true if 'a' and 'b' represent the same wildcards, false if they are
 893  * different. */
 894 bool
 895 flow_wildcards_equal(const struct flow_wildcards *a,
 896                      const struct flow_wildcards *b)
 897 {
 898     return flow_equal(&a->masks, &b->masks);
 899 }
 900
 901 /* Returns true if at least one bit or field is wildcarded in 'a' but not in
 902  * 'b', false otherwise. */
 903 bool
 904 flow_wildcards_has_extra(const struct flow_wildcards *a,
 905                          const struct flow_wildcards *b)
 906 {
 907     const uint32_t *a_u32 = (const uint32_t *) &a->masks;
 908     const uint32_t *b_u32 = (const uint32_t *) &b->masks;
 909     size_t i;
 910
 911     for (i = 0; i < FLOW_U32S; i++) {
 912         if ((a_u32[i] & b_u32[i]) != b_u32[i]) {
 913             return true;
 914         }
 915     }
 916     return false;
 917 }
 918
 919 /* Returns true if 'a' and 'b' are equal, except that 0-bits (wildcarded bits)
 920  * in 'wc' do not need to be equal in 'a' and 'b'. */
 921 bool
 922 flow_equal_except(const struct flow *a, const struct flow *b,
 923                   const struct flow_wildcards *wc)
 924 {
 925     const uint32_t *a_u32 = (const uint32_t *) a;
 926     const uint32_t *b_u32 = (const uint32_t *) b;
 927     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
 928     size_t i;
 929
 930     for (i = 0; i < FLOW_U32S; i++) {
 931         if ((a_u32[i] ^ b_u32[i]) & wc_u32[i]) {
 932             return false;
 933         }
 934     }
 935     return true;
 936 }
 937
 938 /* Sets the wildcard mask for register 'idx' in 'wc' to 'mask'.
 939  * (A 0-bit indicates a wildcard bit.) */
 940 void
 941 flow_wildcards_set_reg_mask(struct flow_wildcards *wc, int idx, uint32_t mask)
 942 {
 943     wc->masks.regs[idx] = mask;
 944 }
 945
 946 /* Calculates the 5-tuple hash from the given flow. */
 947 uint32_t
 948 flow_hash_5tuple(const struct flow *flow, uint32_t basis)
 949 {
 950     uint32_t hash = 0;
 951
 952     if (!flow) {
 953         return 0;
 954     }
 955
 956     hash = mhash_add(basis, (OVS_FORCE uint32_t) flow->nw_src);
 957     hash = mhash_add(hash, (OVS_FORCE uint32_t) flow->nw_dst);
 958     hash = mhash_add(hash, ((OVS_FORCE uint32_t) flow->tp_src << 16)
 959                            | (OVS_FORCE uint32_t) flow->tp_dst);
 960     hash = mhash_add(hash, flow->nw_proto);
 961
 962     return mhash_finish(hash, 13);
 963 }
 964
 965 /* Hashes 'flow' based on its L2 through L4 protocol information. */
 966 uint32_t
 967 flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis)
 968 {
 969     struct {
 970         union {
 971             ovs_be32 ipv4_addr;
 972             struct in6_addr ipv6_addr;
 973         };
 974         ovs_be16 eth_type;
 975         ovs_be16 vlan_tci;
 976         ovs_be16 tp_port;
 977         uint8_t eth_addr[ETH_ADDR_LEN];
 978         uint8_t ip_proto;
 979     } fields;
 980
 981     int i;
 982
 983     memset(&fields, 0, sizeof fields);
 984     for (i = 0; i < ETH_ADDR_LEN; i++) {
 985         fields.eth_addr[i] = flow->dl_src[i] ^ flow->dl_dst[i];
 986     }
 987     fields.vlan_tci = flow->vlan_tci & htons(VLAN_VID_MASK);
 988     fields.eth_type = flow->dl_type;
 989
 990     /* UDP source and destination port are not taken into account because they
 991      * will not necessarily be symmetric in a bidirectional flow. */
 992     if (fields.eth_type == htons(ETH_TYPE_IP)) {
 993         fields.ipv4_addr = flow->nw_src ^ flow->nw_dst;
 994         fields.ip_proto = flow->nw_proto;
 995         if (fields.ip_proto == IPPROTO_TCP || fields.ip_proto == IPPROTO_SCTP) {
 996             fields.tp_port = flow->tp_src ^ flow->tp_dst;
 997         }
 998     } else if (fields.eth_type == htons(ETH_TYPE_IPV6)) {
 999         const uint8_t *a = &flow->ipv6_src.s6_addr[0];
1000         const uint8_t *b = &flow->ipv6_dst.s6_addr[0];
1001         uint8_t *ipv6_addr = &fields.ipv6_addr.s6_addr[0];
1002
1003         for (i=0; i<16; i++) {
1004             ipv6_addr[i] = a[i] ^ b[i];
1005         }
1006         fields.ip_proto = flow->nw_proto;
1007         if (fields.ip_proto == IPPROTO_TCP || fields.ip_proto == IPPROTO_SCTP) {
1008             fields.tp_port = flow->tp_src ^ flow->tp_dst;
1009         }
1010     }
1011     return jhash_bytes(&fields, sizeof fields, basis);
1012 }
1013
1014 /* Initialize a flow with random fields that matter for nx_hash_fields. */
1015 void
1016 flow_random_hash_fields(struct flow *flow)
1017 {
1018     uint16_t rnd = random_uint16();
1019
1020     /* Initialize to all zeros. */
1021     memset(flow, 0, sizeof *flow);
1022
1023     eth_addr_random(flow->dl_src);
1024     eth_addr_random(flow->dl_dst);
1025
1026     flow->vlan_tci = (OVS_FORCE ovs_be16) (random_uint16() & VLAN_VID_MASK);
1027
1028     /* Make most of the random flows IPv4, some IPv6, and rest random. */
1029     flow->dl_type = rnd < 0x8000 ? htons(ETH_TYPE_IP) :
1030         rnd < 0xc000 ? htons(ETH_TYPE_IPV6) : (OVS_FORCE ovs_be16)rnd;
1031
1032     if (dl_type_is_ip_any(flow->dl_type)) {
1033         if (flow->dl_type == htons(ETH_TYPE_IP)) {
1034             flow->nw_src = (OVS_FORCE ovs_be32)random_uint32();
1035             flow->nw_dst = (OVS_FORCE ovs_be32)random_uint32();
1036         } else {
1037             random_bytes(&flow->ipv6_src, sizeof flow->ipv6_src);
1038             random_bytes(&flow->ipv6_dst, sizeof flow->ipv6_dst);
1039         }
1040         /* Make most of IP flows TCP, some UDP or SCTP, and rest random. */
1041         rnd = random_uint16();
1042         flow->nw_proto = rnd < 0x8000 ? IPPROTO_TCP :
1043             rnd < 0xc000 ? IPPROTO_UDP :
1044             rnd < 0xd000 ? IPPROTO_SCTP : (uint8_t)rnd;
1045         if (flow->nw_proto == IPPROTO_TCP ||
1046             flow->nw_proto == IPPROTO_UDP ||
1047             flow->nw_proto == IPPROTO_SCTP) {
1048             flow->tp_src = (OVS_FORCE ovs_be16)random_uint16();
1049             flow->tp_dst = (OVS_FORCE ovs_be16)random_uint16();
1050         }
1051     }
1052 }
1053
1054 /* Masks the fields in 'wc' that are used by the flow hash 'fields'. */
1055 void
1056 flow_mask_hash_fields(const struct flow *flow, struct flow_wildcards *wc,
1057                       enum nx_hash_fields fields)
1058 {
1059     switch (fields) {
1060     case NX_HASH_FIELDS_ETH_SRC:
1061         memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
1062         break;
1063
1064     case NX_HASH_FIELDS_SYMMETRIC_L4:
1065         memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
1066         memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
1067         if (flow->dl_type == htons(ETH_TYPE_IP)) {
1068             memset(&wc->masks.nw_src, 0xff, sizeof wc->masks.nw_src);
1069             memset(&wc->masks.nw_dst, 0xff, sizeof wc->masks.nw_dst);
1070         } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1071             memset(&wc->masks.ipv6_src, 0xff, sizeof wc->masks.ipv6_src);
1072             memset(&wc->masks.ipv6_dst, 0xff, sizeof wc->masks.ipv6_dst);
1073         }
1074         if (is_ip_any(flow)) {
1075             memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
1076             flow_unwildcard_tp_ports(flow, wc);
1077         }
1078         wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
1079         break;
1080
1081     default:
1082         OVS_NOT_REACHED();
1083     }
1084 }
1085
1086 /* Hashes the portions of 'flow' designated by 'fields'. */
1087 uint32_t
1088 flow_hash_fields(const struct flow *flow, enum nx_hash_fields fields,
1089                  uint16_t basis)
1090 {
1091     switch (fields) {
1092
1093     case NX_HASH_FIELDS_ETH_SRC:
1094         return jhash_bytes(flow->dl_src, sizeof flow->dl_src, basis);
1095
1096     case NX_HASH_FIELDS_SYMMETRIC_L4:
1097         return flow_hash_symmetric_l4(flow, basis);
1098     }
1099
1100     OVS_NOT_REACHED();
1101 }
1102
1103 /* Returns a string representation of 'fields'. */
1104 const char *
1105 flow_hash_fields_to_str(enum nx_hash_fields fields)
1106 {
1107     switch (fields) {
1108     case NX_HASH_FIELDS_ETH_SRC: return "eth_src";
1109     case NX_HASH_FIELDS_SYMMETRIC_L4: return "symmetric_l4";
1110     default: return "<unknown>";
1111     }
1112 }
1113
1114 /* Returns true if the value of 'fields' is supported. Otherwise false. */
1115 bool
1116 flow_hash_fields_valid(enum nx_hash_fields fields)
1117 {
1118     return fields == NX_HASH_FIELDS_ETH_SRC
1119         || fields == NX_HASH_FIELDS_SYMMETRIC_L4;
1120 }
1121
1122 /* Returns a hash value for the bits of 'flow' that are active based on
1123  * 'wc', given 'basis'. */
1124 uint32_t
1125 flow_hash_in_wildcards(const struct flow *flow,
1126                        const struct flow_wildcards *wc, uint32_t basis)
1127 {
1128     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
1129     const uint32_t *flow_u32 = (const uint32_t *) flow;
1130     uint32_t hash;
1131     size_t i;
1132
1133     hash = basis;
1134     for (i = 0; i < FLOW_U32S; i++) {
1135         hash = mhash_add(hash, flow_u32[i] & wc_u32[i]);
1136     }
1137     return mhash_finish(hash, 4 * FLOW_U32S);
1138 }
1139
1140 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
1141  * OpenFlow 1.0 "dl_vlan" value:
1142  *
1143  *      - If it is in the range 0...4095, 'flow->vlan_tci' is set to match
1144  *        that VLAN.  Any existing PCP match is unchanged (it becomes 0 if
1145  *        'flow' previously matched packets without a VLAN header).
1146  *
1147  *      - If it is OFP_VLAN_NONE, 'flow->vlan_tci' is set to match a packet
1148  *        without a VLAN tag.
1149  *
1150  *      - Other values of 'vid' should not be used. */
1151 void
1152 flow_set_dl_vlan(struct flow *flow, ovs_be16 vid)
1153 {
1154     if (vid == htons(OFP10_VLAN_NONE)) {
1155         flow->vlan_tci = htons(0);
1156     } else {
1157         vid &= htons(VLAN_VID_MASK);
1158         flow->vlan_tci &= ~htons(VLAN_VID_MASK);
1159         flow->vlan_tci |= htons(VLAN_CFI) | vid;
1160     }
1161 }
1162
1163 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
1164  * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
1165  * plus CFI). */
1166 void
1167 flow_set_vlan_vid(struct flow *flow, ovs_be16 vid)
1168 {
1169     ovs_be16 mask = htons(VLAN_VID_MASK | VLAN_CFI);
1170     flow->vlan_tci &= ~mask;
1171     flow->vlan_tci |= vid & mask;
1172 }
1173
1174 /* Sets the VLAN PCP that 'flow' matches to 'pcp', which should be in the
1175  * range 0...7.
1176  *
1177  * This function has no effect on the VLAN ID that 'flow' matches.
1178  *
1179  * After calling this function, 'flow' will not match packets without a VLAN
1180  * header. */
1181 void
1182 flow_set_vlan_pcp(struct flow *flow, uint8_t pcp)
1183 {
1184     pcp &= 0x07;
1185     flow->vlan_tci &= ~htons(VLAN_PCP_MASK);
1186     flow->vlan_tci |= htons((pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
1187 }
1188
1189 /* Returns the number of MPLS LSEs present in 'flow'
1190  *
1191  * Returns 0 if the 'dl_type' of 'flow' is not an MPLS ethernet type.
1192  * Otherwise traverses 'flow''s MPLS label stack stopping at the
1193  * first entry that has the BoS bit set. If no such entry exists then
1194  * the maximum number of LSEs that can be stored in 'flow' is returned.
1195  */
1196 int
1197 flow_count_mpls_labels(const struct flow *flow, struct flow_wildcards *wc)
1198 {
1199     if (wc) {
1200         wc->masks.dl_type = OVS_BE16_MAX;
1201     }
1202     if (eth_type_mpls(flow->dl_type)) {
1203         int i;
1204         int len = FLOW_MAX_MPLS_LABELS;
1205
1206         for (i = 0; i < len; i++) {
1207             if (wc) {
1208                 wc->masks.mpls_lse[i] |= htonl(MPLS_BOS_MASK);
1209             }
1210             if (flow->mpls_lse[i] & htonl(MPLS_BOS_MASK)) {
1211                 return i + 1;
1212             }
1213         }
1214
1215         return len;
1216     } else {
1217         return 0;
1218     }
1219 }
1220
1221 /* Returns the number consecutive of MPLS LSEs, starting at the
1222  * innermost LSE, that are common in 'a' and 'b'.
1223  *
1224  * 'an' must be flow_count_mpls_labels(a).
1225  * 'bn' must be flow_count_mpls_labels(b).
1226  */
1227 int
1228 flow_count_common_mpls_labels(const struct flow *a, int an,
1229                               const struct flow *b, int bn,
1230                               struct flow_wildcards *wc)
1231 {
1232     int min_n = MIN(an, bn);
1233     if (min_n == 0) {
1234         return 0;
1235     } else {
1236         int common_n = 0;
1237         int a_last = an - 1;
1238         int b_last = bn - 1;
1239         int i;
1240
1241         for (i = 0; i < min_n; i++) {
1242             if (wc) {
1243                 wc->masks.mpls_lse[a_last - i] = OVS_BE32_MAX;
1244                 wc->masks.mpls_lse[b_last - i] = OVS_BE32_MAX;
1245             }
1246             if (a->mpls_lse[a_last - i] != b->mpls_lse[b_last - i]) {
1247                 break;
1248             } else {
1249                 common_n++;
1250             }
1251         }
1252
1253         return common_n;
1254     }
1255 }
1256
1257 /* Adds a new outermost MPLS label to 'flow' and changes 'flow''s Ethernet type
1258  * to 'mpls_eth_type', which must be an MPLS Ethertype.
1259  *
1260  * If the new label is the first MPLS label in 'flow', it is generated as;
1261  *
1262  *     - label: 2, if 'flow' is IPv6, otherwise 0.
1263  *
1264  *     - TTL: IPv4 or IPv6 TTL, if present and nonzero, otherwise 64.
1265  *
1266  *     - TC: IPv4 or IPv6 TOS, if present, otherwise 0.
1267  *
1268  *     - BoS: 1.
1269  *
1270  * If the new label is the second or label MPLS label in 'flow', it is
1271  * generated as;
1272  *
1273  *     - label: Copied from outer label.
1274  *
1275  *     - TTL: Copied from outer label.
1276  *
1277  *     - TC: Copied from outer label.
1278  *
1279  *     - BoS: 0.
1280  *
1281  * 'n' must be flow_count_mpls_labels(flow).  'n' must be less than
1282  * FLOW_MAX_MPLS_LABELS (because otherwise flow->mpls_lse[] would overflow).
1283  */
1284 void
1285 flow_push_mpls(struct flow *flow, int n, ovs_be16 mpls_eth_type,
1286                struct flow_wildcards *wc)
1287 {
1288     ovs_assert(eth_type_mpls(mpls_eth_type));
1289     ovs_assert(n < FLOW_MAX_MPLS_LABELS);
1290
1291     memset(wc->masks.mpls_lse, 0xff, sizeof wc->masks.mpls_lse);
1292     if (n) {
1293         int i;
1294
1295         for (i = n; i >= 1; i--) {
1296             flow->mpls_lse[i] = flow->mpls_lse[i - 1];
1297         }
1298         flow->mpls_lse[0] = (flow->mpls_lse[1]
1299                              & htonl(~MPLS_BOS_MASK));
1300     } else {
1301         int label = 0;          /* IPv4 Explicit Null. */
1302         int tc = 0;
1303         int ttl = 64;
1304
1305         if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1306             label = 2;
1307         }
1308
1309         if (is_ip_any(flow)) {
1310             tc = (flow->nw_tos & IP_DSCP_MASK) >> 2;
1311             wc->masks.nw_tos |= IP_DSCP_MASK;
1312
1313             if (flow->nw_ttl) {
1314                 ttl = flow->nw_ttl;
1315             }
1316             wc->masks.nw_ttl = 0xff;
1317         }
1318
1319         flow->mpls_lse[0] = set_mpls_lse_values(ttl, tc, 1, htonl(label));
1320
1321         /* Clear all L3 and L4 fields. */
1322         BUILD_ASSERT(FLOW_WC_SEQ == 26);
1323         memset((char *) flow + FLOW_SEGMENT_2_ENDS_AT, 0,
1324                sizeof(struct flow) - FLOW_SEGMENT_2_ENDS_AT);
1325     }
1326     flow->dl_type = mpls_eth_type;
1327 }
1328
1329 /* Tries to remove the outermost MPLS label from 'flow'.  Returns true if
1330  * successful, false otherwise.  On success, sets 'flow''s Ethernet type to
1331  * 'eth_type'.
1332  *
1333  * 'n' must be flow_count_mpls_labels(flow). */
1334 bool
1335 flow_pop_mpls(struct flow *flow, int n, ovs_be16 eth_type,
1336               struct flow_wildcards *wc)
1337 {
1338     int i;
1339
1340     if (n == 0) {
1341         /* Nothing to pop. */
1342         return false;
1343     } else if (n == FLOW_MAX_MPLS_LABELS
1344                && !(flow->mpls_lse[n - 1] & htonl(MPLS_BOS_MASK))) {
1345         /* Can't pop because we don't know what to fill in mpls_lse[n - 1]. */
1346         return false;
1347     }
1348
1349     memset(wc->masks.mpls_lse, 0xff, sizeof wc->masks.mpls_lse);
1350     for (i = 1; i < n; i++) {
1351         flow->mpls_lse[i - 1] = flow->mpls_lse[i];
1352     }
1353     flow->mpls_lse[n - 1] = 0;
1354     flow->dl_type = eth_type;
1355     return true;
1356 }
1357
1358 /* Sets the MPLS Label that 'flow' matches to 'label', which is interpreted
1359  * as an OpenFlow 1.1 "mpls_label" value. */
1360 void
1361 flow_set_mpls_label(struct flow *flow, int idx, ovs_be32 label)
1362 {
1363     set_mpls_lse_label(&flow->mpls_lse[idx], label);
1364 }
1365
1366 /* Sets the MPLS TTL that 'flow' matches to 'ttl', which should be in the
1367  * range 0...255. */
1368 void
1369 flow_set_mpls_ttl(struct flow *flow, int idx, uint8_t ttl)
1370 {
1371     set_mpls_lse_ttl(&flow->mpls_lse[idx], ttl);
1372 }
1373
1374 /* Sets the MPLS TC that 'flow' matches to 'tc', which should be in the
1375  * range 0...7. */
1376 void
1377 flow_set_mpls_tc(struct flow *flow, int idx, uint8_t tc)
1378 {
1379     set_mpls_lse_tc(&flow->mpls_lse[idx], tc);
1380 }
1381
1382 /* Sets the MPLS BOS bit that 'flow' matches to which should be 0 or 1. */
1383 void
1384 flow_set_mpls_bos(struct flow *flow, int idx, uint8_t bos)
1385 {
1386     set_mpls_lse_bos(&flow->mpls_lse[idx], bos);
1387 }
1388
1389 /* Sets the entire MPLS LSE. */
1390 void
1391 flow_set_mpls_lse(struct flow *flow, int idx, ovs_be32 lse)
1392 {
1393     flow->mpls_lse[idx] = lse;
1394 }
1395
1396 static size_t
1397 flow_compose_l4(struct ofpbuf *b, const struct flow *flow)
1398 {
1399     size_t l4_len = 0;
1400
1401     if (!(flow->nw_frag & FLOW_NW_FRAG_ANY)
1402         || !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1403         if (flow->nw_proto == IPPROTO_TCP) {
1404             struct tcp_header *tcp;
1405
1406             l4_len = sizeof *tcp;
1407             tcp = ofpbuf_put_zeros(b, l4_len);
1408             tcp->tcp_src = flow->tp_src;
1409             tcp->tcp_dst = flow->tp_dst;
1410             tcp->tcp_ctl = TCP_CTL(ntohs(flow->tcp_flags), 5);
1411         } else if (flow->nw_proto == IPPROTO_UDP) {
1412             struct udp_header *udp;
1413
1414             l4_len = sizeof *udp;
1415             udp = ofpbuf_put_zeros(b, l4_len);
1416             udp->udp_src = flow->tp_src;
1417             udp->udp_dst = flow->tp_dst;
1418         } else if (flow->nw_proto == IPPROTO_SCTP) {
1419             struct sctp_header *sctp;
1420
1421             l4_len = sizeof *sctp;
1422             sctp = ofpbuf_put_zeros(b, l4_len);
1423             sctp->sctp_src = flow->tp_src;
1424             sctp->sctp_dst = flow->tp_dst;
1425         } else if (flow->nw_proto == IPPROTO_ICMP) {
1426             struct icmp_header *icmp;
1427
1428             l4_len = sizeof *icmp;
1429             icmp = ofpbuf_put_zeros(b, l4_len);
1430             icmp->icmp_type = ntohs(flow->tp_src);
1431             icmp->icmp_code = ntohs(flow->tp_dst);
1432             icmp->icmp_csum = csum(icmp, ICMP_HEADER_LEN);
1433         } else if (flow->nw_proto == IPPROTO_ICMPV6) {
1434             struct icmp6_hdr *icmp;
1435
1436             l4_len = sizeof *icmp;
1437             icmp = ofpbuf_put_zeros(b, l4_len);
1438             icmp->icmp6_type = ntohs(flow->tp_src);
1439             icmp->icmp6_code = ntohs(flow->tp_dst);
1440
1441             if (icmp->icmp6_code == 0 &&
1442                 (icmp->icmp6_type == ND_NEIGHBOR_SOLICIT ||
1443                  icmp->icmp6_type == ND_NEIGHBOR_ADVERT)) {
1444                 struct in6_addr *nd_target;
1445                 struct nd_opt_hdr *nd_opt;
1446
1447                 l4_len += sizeof *nd_target;
1448                 nd_target = ofpbuf_put_zeros(b, sizeof *nd_target);
1449                 *nd_target = flow->nd_target;
1450
1451                 if (!eth_addr_is_zero(flow->arp_sha)) {
1452                     l4_len += 8;
1453                     nd_opt = ofpbuf_put_zeros(b, 8);
1454                     nd_opt->nd_opt_len = 1;
1455                     nd_opt->nd_opt_type = ND_OPT_SOURCE_LINKADDR;
1456                     memcpy(nd_opt + 1, flow->arp_sha, ETH_ADDR_LEN);
1457                 }
1458                 if (!eth_addr_is_zero(flow->arp_tha)) {
1459                     l4_len += 8;
1460                     nd_opt = ofpbuf_put_zeros(b, 8);
1461                     nd_opt->nd_opt_len = 1;
1462                     nd_opt->nd_opt_type = ND_OPT_TARGET_LINKADDR;
1463                     memcpy(nd_opt + 1, flow->arp_tha, ETH_ADDR_LEN);
1464                 }
1465             }
1466             icmp->icmp6_cksum = (OVS_FORCE uint16_t)
1467                 csum(icmp, (char *)ofpbuf_tail(b) - (char *)icmp);
1468         }
1469     }
1470     return l4_len;
1471 }
1472
1473 /* Puts into 'b' a packet that flow_extract() would parse as having the given
1474  * 'flow'.
1475  *
1476  * (This is useful only for testing, obviously, and the packet isn't really
1477  * valid. It hasn't got some checksums filled in, for one, and lots of fields
1478  * are just zeroed.) */
1479 void
1480 flow_compose(struct ofpbuf *b, const struct flow *flow)
1481 {
1482     size_t l4_len;
1483
1484     /* eth_compose() sets l3 pointer and makes sure it is 32-bit aligned. */
1485     eth_compose(b, flow->dl_dst, flow->dl_src, ntohs(flow->dl_type), 0);
1486     if (flow->dl_type == htons(FLOW_DL_TYPE_NONE)) {
1487         struct eth_header *eth = ofpbuf_l2(b);
1488         eth->eth_type = htons(ofpbuf_size(b));
1489         return;
1490     }
1491
1492     if (flow->vlan_tci & htons(VLAN_CFI)) {
1493         eth_push_vlan(b, htons(ETH_TYPE_VLAN), flow->vlan_tci);
1494     }
1495
1496     if (flow->dl_type == htons(ETH_TYPE_IP)) {
1497         struct ip_header *ip;
1498
1499         ip = ofpbuf_put_zeros(b, sizeof *ip);
1500         ip->ip_ihl_ver = IP_IHL_VER(5, 4);
1501         ip->ip_tos = flow->nw_tos;
1502         ip->ip_ttl = flow->nw_ttl;
1503         ip->ip_proto = flow->nw_proto;
1504         put_16aligned_be32(&ip->ip_src, flow->nw_src);
1505         put_16aligned_be32(&ip->ip_dst, flow->nw_dst);
1506
1507         if (flow->nw_frag & FLOW_NW_FRAG_ANY) {
1508             ip->ip_frag_off |= htons(IP_MORE_FRAGMENTS);
1509             if (flow->nw_frag & FLOW_NW_FRAG_LATER) {
1510                 ip->ip_frag_off |= htons(100);
1511             }
1512         }
1513
1514         ofpbuf_set_l4(b, ofpbuf_tail(b));
1515
1516         l4_len = flow_compose_l4(b, flow);
1517
1518         ip->ip_tot_len = htons(b->l4_ofs - b->l3_ofs + l4_len);
1519         ip->ip_csum = csum(ip, sizeof *ip);
1520     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1521         struct ovs_16aligned_ip6_hdr *nh;
1522
1523         nh = ofpbuf_put_zeros(b, sizeof *nh);
1524         put_16aligned_be32(&nh->ip6_flow, htonl(6 << 28) |
1525                            htonl(flow->nw_tos << 20) | flow->ipv6_label);
1526         nh->ip6_hlim = flow->nw_ttl;
1527         nh->ip6_nxt = flow->nw_proto;
1528
1529         memcpy(&nh->ip6_src, &flow->ipv6_src, sizeof(nh->ip6_src));
1530         memcpy(&nh->ip6_dst, &flow->ipv6_dst, sizeof(nh->ip6_dst));
1531
1532         ofpbuf_set_l4(b, ofpbuf_tail(b));
1533
1534         l4_len = flow_compose_l4(b, flow);
1535
1536         nh->ip6_plen = htons(l4_len);
1537     } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
1538                flow->dl_type == htons(ETH_TYPE_RARP)) {
1539         struct arp_eth_header *arp;
1540
1541         arp = ofpbuf_put_zeros(b, sizeof *arp);
1542         ofpbuf_set_l3(b, arp);
1543         arp->ar_hrd = htons(1);
1544         arp->ar_pro = htons(ETH_TYPE_IP);
1545         arp->ar_hln = ETH_ADDR_LEN;
1546         arp->ar_pln = 4;
1547         arp->ar_op = htons(flow->nw_proto);
1548
1549         if (flow->nw_proto == ARP_OP_REQUEST ||
1550             flow->nw_proto == ARP_OP_REPLY) {
1551             put_16aligned_be32(&arp->ar_spa, flow->nw_src);
1552             put_16aligned_be32(&arp->ar_tpa, flow->nw_dst);
1553             memcpy(arp->ar_sha, flow->arp_sha, ETH_ADDR_LEN);
1554             memcpy(arp->ar_tha, flow->arp_tha, ETH_ADDR_LEN);
1555         }
1556     }
1557
1558     if (eth_type_mpls(flow->dl_type)) {
1559         int n;
1560
1561         b->l2_5_ofs = b->l3_ofs;
1562         for (n = 1; n < FLOW_MAX_MPLS_LABELS; n++) {
1563             if (flow->mpls_lse[n - 1] & htonl(MPLS_BOS_MASK)) {
1564                 break;
1565             }
1566         }
1567         while (n > 0) {
1568             push_mpls(b, flow->dl_type, flow->mpls_lse[--n]);
1569         }
1570     }
1571 }
1572 \f
1573 /* Compressed flow. */
1574
1575 static int
1576 miniflow_n_values(const struct miniflow *flow)
1577 {
1578     return count_1bits(flow->map);
1579 }
1580
1581 static uint32_t *
1582 miniflow_alloc_values(struct miniflow *flow, int n)
1583 {
1584     if (n <= MINI_N_INLINE) {
1585         return flow->inline_values;
1586     } else {
1587         COVERAGE_INC(miniflow_malloc);
1588         return xmalloc(n * sizeof *flow->values);
1589     }
1590 }
1591
1592 /* Completes an initialization of 'dst' as a miniflow copy of 'src' begun by
1593  * the caller.  The caller must have already initialized 'dst->map' properly
1594  * to indicate the significant uint32_t elements of 'src'.  'n' must be the
1595  * number of 1-bits in 'dst->map'.
1596  *
1597  * Normally the significant elements are the ones that are non-zero.  However,
1598  * when a miniflow is initialized from a (mini)mask, the values can be zeroes,
1599  * so that the flow and mask always have the same maps.
1600  *
1601  * This function initializes 'dst->values' (either inline if possible or with
1602  * malloc() otherwise) and copies the uint32_t elements of 'src' indicated by
1603  * 'dst->map' into it. */
1604 static void
1605 miniflow_init__(struct miniflow *dst, const struct flow *src, int n)
1606 {
1607     const uint32_t *src_u32 = (const uint32_t *) src;
1608     unsigned int ofs;
1609     uint64_t map;
1610
1611     dst->values = miniflow_alloc_values(dst, n);
1612     ofs = 0;
1613     for (map = dst->map; map; map = zero_rightmost_1bit(map)) {
1614         dst->values[ofs++] = src_u32[raw_ctz(map)];
1615     }
1616 }
1617
1618 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1619  * with miniflow_destroy(). */
1620 void
1621 miniflow_init(struct miniflow *dst, const struct flow *src)
1622 {
1623     const uint32_t *src_u32 = (const uint32_t *) src;
1624     unsigned int i;
1625     int n;
1626
1627     /* Initialize dst->map, counting the number of nonzero elements. */
1628     n = 0;
1629     dst->map = 0;
1630
1631     for (i = 0; i < FLOW_U32S; i++) {
1632         if (src_u32[i]) {
1633             dst->map |= UINT64_C(1) << i;
1634             n++;
1635         }
1636     }
1637
1638     miniflow_init__(dst, src, n);
1639 }
1640
1641 /* Initializes 'dst' as a copy of 'src', using 'mask->map' as 'dst''s map.  The
1642  * caller must eventually free 'dst' with miniflow_destroy(). */
1643 void
1644 miniflow_init_with_minimask(struct miniflow *dst, const struct flow *src,
1645                             const struct minimask *mask)
1646 {
1647     dst->map = mask->masks.map;
1648     miniflow_init__(dst, src, miniflow_n_values(dst));
1649 }
1650
1651 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1652  * with miniflow_destroy(). */
1653 void
1654 miniflow_clone(struct miniflow *dst, const struct miniflow *src)
1655 {
1656     int n = miniflow_n_values(src);
1657     dst->map = src->map;
1658     dst->values = miniflow_alloc_values(dst, n);
1659     memcpy(dst->values, src->values, n * sizeof *dst->values);
1660 }
1661
1662 /* Initializes 'dst' with the data in 'src', destroying 'src'.
1663  * The caller must eventually free 'dst' with miniflow_destroy(). */
1664 void
1665 miniflow_move(struct miniflow *dst, struct miniflow *src)
1666 {
1667     if (src->values == src->inline_values) {
1668         dst->values = dst->inline_values;
1669         memcpy(dst->values, src->values,
1670                miniflow_n_values(src) * sizeof *dst->values);
1671     } else {
1672         dst->values = src->values;
1673     }
1674     dst->map = src->map;
1675 }
1676
1677 /* Frees any memory owned by 'flow'.  Does not free the storage in which 'flow'
1678  * itself resides; the caller is responsible for that. */
1679 void
1680 miniflow_destroy(struct miniflow *flow)
1681 {
1682     if (flow->values != flow->inline_values) {
1683         free(flow->values);
1684     }
1685 }
1686
1687 /* Initializes 'dst' as a copy of 'src'. */
1688 void
1689 miniflow_expand(const struct miniflow *src, struct flow *dst)
1690 {
1691     memset(dst, 0, sizeof *dst);
1692     flow_union_with_miniflow(dst, src);
1693 }
1694
1695 static const uint32_t *
1696 miniflow_get__(const struct miniflow *flow, unsigned int u32_ofs)
1697 {
1698     if (!(flow->map & (UINT64_C(1) << u32_ofs))) {
1699         static const uint32_t zero = 0;
1700         return &zero;
1701     }
1702     return flow->values +
1703            count_1bits(flow->map & ((UINT64_C(1) << u32_ofs) - 1));
1704 }
1705
1706 /* Returns the uint32_t that would be at byte offset '4 * u32_ofs' if 'flow'
1707  * were expanded into a "struct flow". */
1708 uint32_t
1709 miniflow_get(const struct miniflow *flow, unsigned int u32_ofs)
1710 {
1711     return *miniflow_get__(flow, u32_ofs);
1712 }
1713
1714 /* Returns the ovs_be16 that would be at byte offset 'u8_ofs' if 'flow' were
1715  * expanded into a "struct flow". */
1716 static ovs_be16
1717 miniflow_get_be16(const struct miniflow *flow, unsigned int u8_ofs)
1718 {
1719     const uint32_t *u32p = miniflow_get__(flow, u8_ofs / 4);
1720     const ovs_be16 *be16p = (const ovs_be16 *) u32p;
1721     return be16p[u8_ofs % 4 != 0];
1722 }
1723
1724 /* Returns the VID within the vlan_tci member of the "struct flow" represented
1725  * by 'flow'. */
1726 uint16_t
1727 miniflow_get_vid(const struct miniflow *flow)
1728 {
1729     ovs_be16 tci = miniflow_get_be16(flow, offsetof(struct flow, vlan_tci));
1730     return vlan_tci_to_vid(tci);
1731 }
1732
1733 /* Returns true if 'a' and 'b' are the same flow, false otherwise.  */
1734 bool
1735 miniflow_equal(const struct miniflow *a, const struct miniflow *b)
1736 {
1737     const uint32_t *ap = a->values;
1738     const uint32_t *bp = b->values;
1739     const uint64_t a_map = a->map;
1740     const uint64_t b_map = b->map;
1741     uint64_t map;
1742
1743     if (a_map == b_map) {
1744         for (map = a_map; map; map = zero_rightmost_1bit(map)) {
1745             if (*ap++ != *bp++) {
1746                 return false;
1747             }
1748         }
1749     } else {
1750         for (map = a_map | b_map; map; map = zero_rightmost_1bit(map)) {
1751             uint64_t bit = rightmost_1bit(map);
1752             uint64_t a_value = a_map & bit ? *ap++ : 0;
1753             uint64_t b_value = b_map & bit ? *bp++ : 0;
1754
1755             if (a_value != b_value) {
1756                 return false;
1757             }
1758         }
1759     }
1760
1761     return true;
1762 }
1763
1764 /* Returns true if 'a' and 'b' are equal at the places where there are 1-bits
1765  * in 'mask', false if they differ. */
1766 bool
1767 miniflow_equal_in_minimask(const struct miniflow *a, const struct miniflow *b,
1768                            const struct minimask *mask)
1769 {
1770     const uint32_t *p;
1771     uint64_t map;
1772
1773     p = mask->masks.values;
1774
1775     for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1776         int ofs = raw_ctz(map);
1777
1778         if ((miniflow_get(a, ofs) ^ miniflow_get(b, ofs)) & *p) {
1779             return false;
1780         }
1781         p++;
1782     }
1783
1784     return true;
1785 }
1786
1787 /* Returns true if 'a' and 'b' are equal at the places where there are 1-bits
1788  * in 'mask', false if they differ. */
1789 bool
1790 miniflow_equal_flow_in_minimask(const struct miniflow *a, const struct flow *b,
1791                                 const struct minimask *mask)
1792 {
1793     const uint32_t *b_u32 = (const uint32_t *) b;
1794     const uint32_t *p;
1795     uint64_t map;
1796
1797     p = mask->masks.values;
1798
1799     for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1800         int ofs = raw_ctz(map);
1801
1802         if ((miniflow_get(a, ofs) ^ b_u32[ofs]) & *p) {
1803             return false;
1804         }
1805         p++;
1806     }
1807
1808     return true;
1809 }
1810
1811 /* Returns a hash value for 'flow', given 'basis'. */
1812 uint32_t
1813 miniflow_hash(const struct miniflow *flow, uint32_t basis)
1814 {
1815     const uint32_t *p = flow->values;
1816     uint32_t hash = basis;
1817     uint64_t hash_map = 0;
1818     uint64_t map;
1819
1820     for (map = flow->map; map; map = zero_rightmost_1bit(map)) {
1821         if (*p) {
1822             hash = mhash_add(hash, *p);
1823             hash_map |= rightmost_1bit(map);
1824         }
1825         p++;
1826     }
1827     hash = mhash_add(hash, hash_map);
1828     hash = mhash_add(hash, hash_map >> 32);
1829
1830     return mhash_finish(hash, p - flow->values);
1831 }
1832
1833 /* Returns a hash value for the bits of 'flow' where there are 1-bits in
1834  * 'mask', given 'basis'.
1835  *
1836  * The hash values returned by this function are the same as those returned by
1837  * flow_hash_in_minimask(), only the form of the arguments differ. */
1838 uint32_t
1839 miniflow_hash_in_minimask(const struct miniflow *flow,
1840                           const struct minimask *mask, uint32_t basis)
1841 {
1842     const uint32_t *p = mask->masks.values;
1843     uint32_t hash;
1844     uint64_t map;
1845
1846     hash = basis;
1847
1848     for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1849         hash = mhash_add(hash, miniflow_get(flow, raw_ctz(map)) & *p++);
1850     }
1851
1852     return mhash_finish(hash, (p - mask->masks.values) * 4);
1853 }
1854
1855 /* Returns a hash value for the bits of 'flow' where there are 1-bits in
1856  * 'mask', given 'basis'.
1857  *
1858  * The hash values returned by this function are the same as those returned by
1859  * miniflow_hash_in_minimask(), only the form of the arguments differ. */
1860 uint32_t
1861 flow_hash_in_minimask(const struct flow *flow, const struct minimask *mask,
1862                       uint32_t basis)
1863 {
1864     const uint32_t *flow_u32 = (const uint32_t *)flow;
1865     const uint32_t *p = mask->masks.values;
1866     uint32_t hash;
1867     uint64_t map;
1868
1869     hash = basis;
1870     for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1871         hash = mhash_add(hash, flow_u32[raw_ctz(map)] & *p++);
1872     }
1873
1874     return mhash_finish(hash, (p - mask->masks.values) * 4);
1875 }
1876
1877 /* Returns a hash value for the bits of range [start, end) in 'flow',
1878  * where there are 1-bits in 'mask', given 'hash'.
1879  *
1880  * The hash values returned by this function are the same as those returned by
1881  * minimatch_hash_range(), only the form of the arguments differ. */
1882 uint32_t
1883 flow_hash_in_minimask_range(const struct flow *flow,
1884                             const struct minimask *mask,
1885                             uint8_t start, uint8_t end, uint32_t *basis)
1886 {
1887     const uint32_t *flow_u32 = (const uint32_t *)flow;
1888     unsigned int offset;
1889     uint64_t map = miniflow_get_map_in_range(&mask->masks, start, end,
1890                                              &offset);
1891     const uint32_t *p = mask->masks.values + offset;
1892     uint32_t hash = *basis;
1893
1894     for (; map; map = zero_rightmost_1bit(map)) {
1895         hash = mhash_add(hash, flow_u32[raw_ctz(map)] & *p++);
1896     }
1897
1898     *basis = hash; /* Allow continuation from the unfinished value. */
1899     return mhash_finish(hash, (p - mask->masks.values) * 4);
1900 }
1901
1902 \f
1903 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1904  * with minimask_destroy(). */
1905 void
1906 minimask_init(struct minimask *mask, const struct flow_wildcards *wc)
1907 {
1908     miniflow_init(&mask->masks, &wc->masks);
1909 }
1910
1911 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1912  * with minimask_destroy(). */
1913 void
1914 minimask_clone(struct minimask *dst, const struct minimask *src)
1915 {
1916     miniflow_clone(&dst->masks, &src->masks);
1917 }
1918
1919 /* Initializes 'dst' with the data in 'src', destroying 'src'.
1920  * The caller must eventually free 'dst' with minimask_destroy(). */
1921 void
1922 minimask_move(struct minimask *dst, struct minimask *src)
1923 {
1924     miniflow_move(&dst->masks, &src->masks);
1925 }
1926
1927 /* Initializes 'dst_' as the bit-wise "and" of 'a_' and 'b_'.
1928  *
1929  * The caller must provide room for FLOW_U32S "uint32_t"s in 'storage', for use
1930  * by 'dst_'.  The caller must *not* free 'dst_' with minimask_destroy(). */
1931 void
1932 minimask_combine(struct minimask *dst_,
1933                  const struct minimask *a_, const struct minimask *b_,
1934                  uint32_t storage[FLOW_U32S])
1935 {
1936     struct miniflow *dst = &dst_->masks;
1937     const struct miniflow *a = &a_->masks;
1938     const struct miniflow *b = &b_->masks;
1939     uint64_t map;
1940     int n = 0;
1941
1942     dst->values = storage;
1943
1944     dst->map = 0;
1945     for (map = a->map & b->map; map; map = zero_rightmost_1bit(map)) {
1946         int ofs = raw_ctz(map);
1947         uint32_t mask = miniflow_get(a, ofs) & miniflow_get(b, ofs);
1948
1949         if (mask) {
1950             dst->map |= rightmost_1bit(map);
1951             dst->values[n++] = mask;
1952         }
1953     }
1954 }
1955
1956 /* Frees any memory owned by 'mask'.  Does not free the storage in which 'mask'
1957  * itself resides; the caller is responsible for that. */
1958 void
1959 minimask_destroy(struct minimask *mask)
1960 {
1961     miniflow_destroy(&mask->masks);
1962 }
1963
1964 /* Initializes 'dst' as a copy of 'src'. */
1965 void
1966 minimask_expand(const struct minimask *mask, struct flow_wildcards *wc)
1967 {
1968     miniflow_expand(&mask->masks, &wc->masks);
1969 }
1970
1971 /* Returns the uint32_t that would be at byte offset '4 * u32_ofs' if 'mask'
1972  * were expanded into a "struct flow_wildcards". */
1973 uint32_t
1974 minimask_get(const struct minimask *mask, unsigned int u32_ofs)
1975 {
1976     return miniflow_get(&mask->masks, u32_ofs);
1977 }
1978
1979 /* Returns the VID mask within the vlan_tci member of the "struct
1980  * flow_wildcards" represented by 'mask'. */
1981 uint16_t
1982 minimask_get_vid_mask(const struct minimask *mask)
1983 {
1984     return miniflow_get_vid(&mask->masks);
1985 }
1986
1987 /* Returns true if 'a' and 'b' are the same flow mask, false otherwise.  */
1988 bool
1989 minimask_equal(const struct minimask *a, const struct minimask *b)
1990 {
1991     return miniflow_equal(&a->masks, &b->masks);
1992 }
1993
1994 /* Returns a hash value for 'mask', given 'basis'. */
1995 uint32_t
1996 minimask_hash(const struct minimask *mask, uint32_t basis)
1997 {
1998     return miniflow_hash(&mask->masks, basis);
1999 }
2000
2001 /* Returns true if at least one bit is wildcarded in 'a_' but not in 'b_',
2002  * false otherwise. */
2003 bool
2004 minimask_has_extra(const struct minimask *a_, const struct minimask *b_)
2005 {
2006     const struct miniflow *a = &a_->masks;
2007     const struct miniflow *b = &b_->masks;
2008     uint64_t map;
2009
2010     for (map = a->map | b->map; map; map = zero_rightmost_1bit(map)) {
2011         int ofs = raw_ctz(map);
2012         uint32_t a_u32 = miniflow_get(a, ofs);
2013         uint32_t b_u32 = miniflow_get(b, ofs);
2014
2015         if ((a_u32 & b_u32) != b_u32) {
2016             return true;
2017         }
2018     }
2019
2020     return false;
2021 }
2022
2023 /* Returns true if 'mask' matches every packet, false if 'mask' fixes any bits
2024  * or fields. */
2025 bool
2026 minimask_is_catchall(const struct minimask *mask_)
2027 {
2028     const struct miniflow *mask = &mask_->masks;
2029     const uint32_t *p = mask->values;
2030     uint64_t map;
2031
2032     for (map = mask->map; map; map = zero_rightmost_1bit(map)) {
2033         if (*p++) {
2034             return false;
2035         }
2036     }
2037     return true;
2038 }