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  * for FLOW_U32S * 4 bytes. */
 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 /* Returns a hash of the wildcards in 'wc'. */
 827 uint32_t
 828 flow_wildcards_hash(const struct flow_wildcards *wc, uint32_t basis)
 829 {
 830     return flow_hash(&wc->masks, basis);
 831 }
 832
 833 /* Returns true if 'a' and 'b' represent the same wildcards, false if they are
 834  * different. */
 835 bool
 836 flow_wildcards_equal(const struct flow_wildcards *a,
 837                      const struct flow_wildcards *b)
 838 {
 839     return flow_equal(&a->masks, &b->masks);
 840 }
 841
 842 /* Returns true if at least one bit or field is wildcarded in 'a' but not in
 843  * 'b', false otherwise. */
 844 bool
 845 flow_wildcards_has_extra(const struct flow_wildcards *a,
 846                          const struct flow_wildcards *b)
 847 {
 848     const uint32_t *a_u32 = (const uint32_t *) &a->masks;
 849     const uint32_t *b_u32 = (const uint32_t *) &b->masks;
 850     size_t i;
 851
 852     for (i = 0; i < FLOW_U32S; i++) {
 853         if ((a_u32[i] & b_u32[i]) != b_u32[i]) {
 854             return true;
 855         }
 856     }
 857     return false;
 858 }
 859
 860 /* Returns true if 'a' and 'b' are equal, except that 0-bits (wildcarded bits)
 861  * in 'wc' do not need to be equal in 'a' and 'b'. */
 862 bool
 863 flow_equal_except(const struct flow *a, const struct flow *b,
 864                   const struct flow_wildcards *wc)
 865 {
 866     const uint32_t *a_u32 = (const uint32_t *) a;
 867     const uint32_t *b_u32 = (const uint32_t *) b;
 868     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
 869     size_t i;
 870
 871     for (i = 0; i < FLOW_U32S; i++) {
 872         if ((a_u32[i] ^ b_u32[i]) & wc_u32[i]) {
 873             return false;
 874         }
 875     }
 876     return true;
 877 }
 878
 879 /* Sets the wildcard mask for register 'idx' in 'wc' to 'mask'.
 880  * (A 0-bit indicates a wildcard bit.) */
 881 void
 882 flow_wildcards_set_reg_mask(struct flow_wildcards *wc, int idx, uint32_t mask)
 883 {
 884     wc->masks.regs[idx] = mask;
 885 }
 886
 887 /* Calculates the 5-tuple hash from the given miniflow.
 888  * This returns the same value as flow_hash_5tuple for the corresponding
 889  * flow. */
 890 uint32_t
 891 miniflow_hash_5tuple(const struct miniflow *flow, uint32_t basis)
 892 {
 893     uint32_t hash = basis;
 894
 895     if (flow) {
 896         ovs_be16 dl_type = MINIFLOW_GET_BE16(flow, dl_type);
 897
 898         hash = mhash_add(hash, MINIFLOW_GET_U8(flow, nw_proto));
 899
 900         /* Separate loops for better optimization. */
 901         if (dl_type == htons(ETH_TYPE_IPV6)) {
 902             uint64_t map = MINIFLOW_MAP(ipv6_src) | MINIFLOW_MAP(ipv6_dst)
 903                 | MINIFLOW_MAP(tp_src); /* Covers both ports */
 904             uint32_t value;
 905
 906             MINIFLOW_FOR_EACH_IN_MAP(value, flow, map) {
 907                 hash = mhash_add(hash, value);
 908             }
 909         } else {
 910             uint64_t map = MINIFLOW_MAP(nw_src) | MINIFLOW_MAP(nw_dst)
 911                 | MINIFLOW_MAP(tp_src); /* Covers both ports */
 912             uint32_t value;
 913
 914             MINIFLOW_FOR_EACH_IN_MAP(value, flow, map) {
 915                 hash = mhash_add(hash, value);
 916             }
 917         }
 918         hash = mhash_finish(hash, 42); /* Arbitrary number. */
 919     }
 920     return hash;
 921 }
 922
 923 BUILD_ASSERT_DECL(offsetof(struct flow, tp_src) + 2
 924                   == offsetof(struct flow, tp_dst) &&
 925                   offsetof(struct flow, tp_src) / 4
 926                   == offsetof(struct flow, tp_dst) / 4);
 927 BUILD_ASSERT_DECL(offsetof(struct flow, ipv6_src) + 16
 928                   == offsetof(struct flow, ipv6_dst));
 929
 930 /* Calculates the 5-tuple hash from the given flow. */
 931 uint32_t
 932 flow_hash_5tuple(const struct flow *flow, uint32_t basis)
 933 {
 934     uint32_t hash = basis;
 935
 936     if (flow) {
 937         const uint32_t *flow_u32 = (const uint32_t *)flow;
 938
 939         hash = mhash_add(hash, flow->nw_proto);
 940
 941         if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
 942             int ofs = offsetof(struct flow, ipv6_src) / 4;
 943             int end = ofs + 2 * sizeof flow->ipv6_src / 4;
 944
 945             while (ofs < end) {
 946                 hash = mhash_add(hash, flow_u32[ofs++]);
 947             }
 948         } else {
 949             hash = mhash_add(hash, (OVS_FORCE uint32_t) flow->nw_src);
 950             hash = mhash_add(hash, (OVS_FORCE uint32_t) flow->nw_dst);
 951         }
 952         hash = mhash_add(hash, flow_u32[offsetof(struct flow, tp_src) / 4]);
 953
 954         hash = mhash_finish(hash, 42); /* Arbitrary number. */
 955     }
 956     return hash;
 957 }
 958
 959 /* Hashes 'flow' based on its L2 through L4 protocol information. */
 960 uint32_t
 961 flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis)
 962 {
 963     struct {
 964         union {
 965             ovs_be32 ipv4_addr;
 966             struct in6_addr ipv6_addr;
 967         };
 968         ovs_be16 eth_type;
 969         ovs_be16 vlan_tci;
 970         ovs_be16 tp_port;
 971         uint8_t eth_addr[ETH_ADDR_LEN];
 972         uint8_t ip_proto;
 973     } fields;
 974
 975     int i;
 976
 977     memset(&fields, 0, sizeof fields);
 978     for (i = 0; i < ETH_ADDR_LEN; i++) {
 979         fields.eth_addr[i] = flow->dl_src[i] ^ flow->dl_dst[i];
 980     }
 981     fields.vlan_tci = flow->vlan_tci & htons(VLAN_VID_MASK);
 982     fields.eth_type = flow->dl_type;
 983
 984     /* UDP source and destination port are not taken into account because they
 985      * will not necessarily be symmetric in a bidirectional flow. */
 986     if (fields.eth_type == htons(ETH_TYPE_IP)) {
 987         fields.ipv4_addr = flow->nw_src ^ flow->nw_dst;
 988         fields.ip_proto = flow->nw_proto;
 989         if (fields.ip_proto == IPPROTO_TCP || fields.ip_proto == IPPROTO_SCTP) {
 990             fields.tp_port = flow->tp_src ^ flow->tp_dst;
 991         }
 992     } else if (fields.eth_type == htons(ETH_TYPE_IPV6)) {
 993         const uint8_t *a = &flow->ipv6_src.s6_addr[0];
 994         const uint8_t *b = &flow->ipv6_dst.s6_addr[0];
 995         uint8_t *ipv6_addr = &fields.ipv6_addr.s6_addr[0];
 996
 997         for (i=0; i<16; i++) {
 998             ipv6_addr[i] = a[i] ^ b[i];
 999         }
1000         fields.ip_proto = flow->nw_proto;
1001         if (fields.ip_proto == IPPROTO_TCP || fields.ip_proto == IPPROTO_SCTP) {
1002             fields.tp_port = flow->tp_src ^ flow->tp_dst;
1003         }
1004     }
1005     return jhash_bytes(&fields, sizeof fields, basis);
1006 }
1007
1008 /* Initialize a flow with random fields that matter for nx_hash_fields. */
1009 void
1010 flow_random_hash_fields(struct flow *flow)
1011 {
1012     uint16_t rnd = random_uint16();
1013
1014     /* Initialize to all zeros. */
1015     memset(flow, 0, sizeof *flow);
1016
1017     eth_addr_random(flow->dl_src);
1018     eth_addr_random(flow->dl_dst);
1019
1020     flow->vlan_tci = (OVS_FORCE ovs_be16) (random_uint16() & VLAN_VID_MASK);
1021
1022     /* Make most of the random flows IPv4, some IPv6, and rest random. */
1023     flow->dl_type = rnd < 0x8000 ? htons(ETH_TYPE_IP) :
1024         rnd < 0xc000 ? htons(ETH_TYPE_IPV6) : (OVS_FORCE ovs_be16)rnd;
1025
1026     if (dl_type_is_ip_any(flow->dl_type)) {
1027         if (flow->dl_type == htons(ETH_TYPE_IP)) {
1028             flow->nw_src = (OVS_FORCE ovs_be32)random_uint32();
1029             flow->nw_dst = (OVS_FORCE ovs_be32)random_uint32();
1030         } else {
1031             random_bytes(&flow->ipv6_src, sizeof flow->ipv6_src);
1032             random_bytes(&flow->ipv6_dst, sizeof flow->ipv6_dst);
1033         }
1034         /* Make most of IP flows TCP, some UDP or SCTP, and rest random. */
1035         rnd = random_uint16();
1036         flow->nw_proto = rnd < 0x8000 ? IPPROTO_TCP :
1037             rnd < 0xc000 ? IPPROTO_UDP :
1038             rnd < 0xd000 ? IPPROTO_SCTP : (uint8_t)rnd;
1039         if (flow->nw_proto == IPPROTO_TCP ||
1040             flow->nw_proto == IPPROTO_UDP ||
1041             flow->nw_proto == IPPROTO_SCTP) {
1042             flow->tp_src = (OVS_FORCE ovs_be16)random_uint16();
1043             flow->tp_dst = (OVS_FORCE ovs_be16)random_uint16();
1044         }
1045     }
1046 }
1047
1048 /* Masks the fields in 'wc' that are used by the flow hash 'fields'. */
1049 void
1050 flow_mask_hash_fields(const struct flow *flow, struct flow_wildcards *wc,
1051                       enum nx_hash_fields fields)
1052 {
1053     switch (fields) {
1054     case NX_HASH_FIELDS_ETH_SRC:
1055         memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
1056         break;
1057
1058     case NX_HASH_FIELDS_SYMMETRIC_L4:
1059         memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
1060         memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
1061         if (flow->dl_type == htons(ETH_TYPE_IP)) {
1062             memset(&wc->masks.nw_src, 0xff, sizeof wc->masks.nw_src);
1063             memset(&wc->masks.nw_dst, 0xff, sizeof wc->masks.nw_dst);
1064         } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1065             memset(&wc->masks.ipv6_src, 0xff, sizeof wc->masks.ipv6_src);
1066             memset(&wc->masks.ipv6_dst, 0xff, sizeof wc->masks.ipv6_dst);
1067         }
1068         if (is_ip_any(flow)) {
1069             memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
1070             flow_unwildcard_tp_ports(flow, wc);
1071         }
1072         wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
1073         break;
1074
1075     default:
1076         OVS_NOT_REACHED();
1077     }
1078 }
1079
1080 /* Hashes the portions of 'flow' designated by 'fields'. */
1081 uint32_t
1082 flow_hash_fields(const struct flow *flow, enum nx_hash_fields fields,
1083                  uint16_t basis)
1084 {
1085     switch (fields) {
1086
1087     case NX_HASH_FIELDS_ETH_SRC:
1088         return jhash_bytes(flow->dl_src, sizeof flow->dl_src, basis);
1089
1090     case NX_HASH_FIELDS_SYMMETRIC_L4:
1091         return flow_hash_symmetric_l4(flow, basis);
1092     }
1093
1094     OVS_NOT_REACHED();
1095 }
1096
1097 /* Returns a string representation of 'fields'. */
1098 const char *
1099 flow_hash_fields_to_str(enum nx_hash_fields fields)
1100 {
1101     switch (fields) {
1102     case NX_HASH_FIELDS_ETH_SRC: return "eth_src";
1103     case NX_HASH_FIELDS_SYMMETRIC_L4: return "symmetric_l4";
1104     default: return "<unknown>";
1105     }
1106 }
1107
1108 /* Returns true if the value of 'fields' is supported. Otherwise false. */
1109 bool
1110 flow_hash_fields_valid(enum nx_hash_fields fields)
1111 {
1112     return fields == NX_HASH_FIELDS_ETH_SRC
1113         || fields == NX_HASH_FIELDS_SYMMETRIC_L4;
1114 }
1115
1116 /* Returns a hash value for the bits of 'flow' that are active based on
1117  * 'wc', given 'basis'. */
1118 uint32_t
1119 flow_hash_in_wildcards(const struct flow *flow,
1120                        const struct flow_wildcards *wc, uint32_t basis)
1121 {
1122     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
1123     const uint32_t *flow_u32 = (const uint32_t *) flow;
1124     uint32_t hash;
1125     size_t i;
1126
1127     hash = basis;
1128     for (i = 0; i < FLOW_U32S; i++) {
1129         hash = mhash_add(hash, flow_u32[i] & wc_u32[i]);
1130     }
1131     return mhash_finish(hash, 4 * FLOW_U32S);
1132 }
1133
1134 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
1135  * OpenFlow 1.0 "dl_vlan" value:
1136  *
1137  *      - If it is in the range 0...4095, 'flow->vlan_tci' is set to match
1138  *        that VLAN.  Any existing PCP match is unchanged (it becomes 0 if
1139  *        'flow' previously matched packets without a VLAN header).
1140  *
1141  *      - If it is OFP_VLAN_NONE, 'flow->vlan_tci' is set to match a packet
1142  *        without a VLAN tag.
1143  *
1144  *      - Other values of 'vid' should not be used. */
1145 void
1146 flow_set_dl_vlan(struct flow *flow, ovs_be16 vid)
1147 {
1148     if (vid == htons(OFP10_VLAN_NONE)) {
1149         flow->vlan_tci = htons(0);
1150     } else {
1151         vid &= htons(VLAN_VID_MASK);
1152         flow->vlan_tci &= ~htons(VLAN_VID_MASK);
1153         flow->vlan_tci |= htons(VLAN_CFI) | vid;
1154     }
1155 }
1156
1157 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
1158  * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
1159  * plus CFI). */
1160 void
1161 flow_set_vlan_vid(struct flow *flow, ovs_be16 vid)
1162 {
1163     ovs_be16 mask = htons(VLAN_VID_MASK | VLAN_CFI);
1164     flow->vlan_tci &= ~mask;
1165     flow->vlan_tci |= vid & mask;
1166 }
1167
1168 /* Sets the VLAN PCP that 'flow' matches to 'pcp', which should be in the
1169  * range 0...7.
1170  *
1171  * This function has no effect on the VLAN ID that 'flow' matches.
1172  *
1173  * After calling this function, 'flow' will not match packets without a VLAN
1174  * header. */
1175 void
1176 flow_set_vlan_pcp(struct flow *flow, uint8_t pcp)
1177 {
1178     pcp &= 0x07;
1179     flow->vlan_tci &= ~htons(VLAN_PCP_MASK);
1180     flow->vlan_tci |= htons((pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
1181 }
1182
1183 /* Returns the number of MPLS LSEs present in 'flow'
1184  *
1185  * Returns 0 if the 'dl_type' of 'flow' is not an MPLS ethernet type.
1186  * Otherwise traverses 'flow''s MPLS label stack stopping at the
1187  * first entry that has the BoS bit set. If no such entry exists then
1188  * the maximum number of LSEs that can be stored in 'flow' is returned.
1189  */
1190 int
1191 flow_count_mpls_labels(const struct flow *flow, struct flow_wildcards *wc)
1192 {
1193     if (wc) {
1194         wc->masks.dl_type = OVS_BE16_MAX;
1195     }
1196     if (eth_type_mpls(flow->dl_type)) {
1197         int i;
1198         int len = FLOW_MAX_MPLS_LABELS;
1199
1200         for (i = 0; i < len; i++) {
1201             if (wc) {
1202                 wc->masks.mpls_lse[i] |= htonl(MPLS_BOS_MASK);
1203             }
1204             if (flow->mpls_lse[i] & htonl(MPLS_BOS_MASK)) {
1205                 return i + 1;
1206             }
1207         }
1208
1209         return len;
1210     } else {
1211         return 0;
1212     }
1213 }
1214
1215 /* Returns the number consecutive of MPLS LSEs, starting at the
1216  * innermost LSE, that are common in 'a' and 'b'.
1217  *
1218  * 'an' must be flow_count_mpls_labels(a).
1219  * 'bn' must be flow_count_mpls_labels(b).
1220  */
1221 int
1222 flow_count_common_mpls_labels(const struct flow *a, int an,
1223                               const struct flow *b, int bn,
1224                               struct flow_wildcards *wc)
1225 {
1226     int min_n = MIN(an, bn);
1227     if (min_n == 0) {
1228         return 0;
1229     } else {
1230         int common_n = 0;
1231         int a_last = an - 1;
1232         int b_last = bn - 1;
1233         int i;
1234
1235         for (i = 0; i < min_n; i++) {
1236             if (wc) {
1237                 wc->masks.mpls_lse[a_last - i] = OVS_BE32_MAX;
1238                 wc->masks.mpls_lse[b_last - i] = OVS_BE32_MAX;
1239             }
1240             if (a->mpls_lse[a_last - i] != b->mpls_lse[b_last - i]) {
1241                 break;
1242             } else {
1243                 common_n++;
1244             }
1245         }
1246
1247         return common_n;
1248     }
1249 }
1250
1251 /* Adds a new outermost MPLS label to 'flow' and changes 'flow''s Ethernet type
1252  * to 'mpls_eth_type', which must be an MPLS Ethertype.
1253  *
1254  * If the new label is the first MPLS label in 'flow', it is generated as;
1255  *
1256  *     - label: 2, if 'flow' is IPv6, otherwise 0.
1257  *
1258  *     - TTL: IPv4 or IPv6 TTL, if present and nonzero, otherwise 64.
1259  *
1260  *     - TC: IPv4 or IPv6 TOS, if present, otherwise 0.
1261  *
1262  *     - BoS: 1.
1263  *
1264  * If the new label is the second or label MPLS label in 'flow', it is
1265  * generated as;
1266  *
1267  *     - label: Copied from outer label.
1268  *
1269  *     - TTL: Copied from outer label.
1270  *
1271  *     - TC: Copied from outer label.
1272  *
1273  *     - BoS: 0.
1274  *
1275  * 'n' must be flow_count_mpls_labels(flow).  'n' must be less than
1276  * FLOW_MAX_MPLS_LABELS (because otherwise flow->mpls_lse[] would overflow).
1277  */
1278 void
1279 flow_push_mpls(struct flow *flow, int n, ovs_be16 mpls_eth_type,
1280                struct flow_wildcards *wc)
1281 {
1282     ovs_assert(eth_type_mpls(mpls_eth_type));
1283     ovs_assert(n < FLOW_MAX_MPLS_LABELS);
1284
1285     memset(wc->masks.mpls_lse, 0xff, sizeof wc->masks.mpls_lse);
1286     if (n) {
1287         int i;
1288
1289         for (i = n; i >= 1; i--) {
1290             flow->mpls_lse[i] = flow->mpls_lse[i - 1];
1291         }
1292         flow->mpls_lse[0] = (flow->mpls_lse[1]
1293                              & htonl(~MPLS_BOS_MASK));
1294     } else {
1295         int label = 0;          /* IPv4 Explicit Null. */
1296         int tc = 0;
1297         int ttl = 64;
1298
1299         if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1300             label = 2;
1301         }
1302
1303         if (is_ip_any(flow)) {
1304             tc = (flow->nw_tos & IP_DSCP_MASK) >> 2;
1305             wc->masks.nw_tos |= IP_DSCP_MASK;
1306
1307             if (flow->nw_ttl) {
1308                 ttl = flow->nw_ttl;
1309             }
1310             wc->masks.nw_ttl = 0xff;
1311         }
1312
1313         flow->mpls_lse[0] = set_mpls_lse_values(ttl, tc, 1, htonl(label));
1314
1315         /* Clear all L3 and L4 fields. */
1316         BUILD_ASSERT(FLOW_WC_SEQ == 26);
1317         memset((char *) flow + FLOW_SEGMENT_2_ENDS_AT, 0,
1318                sizeof(struct flow) - FLOW_SEGMENT_2_ENDS_AT);
1319     }
1320     flow->dl_type = mpls_eth_type;
1321 }
1322
1323 /* Tries to remove the outermost MPLS label from 'flow'.  Returns true if
1324  * successful, false otherwise.  On success, sets 'flow''s Ethernet type to
1325  * 'eth_type'.
1326  *
1327  * 'n' must be flow_count_mpls_labels(flow). */
1328 bool
1329 flow_pop_mpls(struct flow *flow, int n, ovs_be16 eth_type,
1330               struct flow_wildcards *wc)
1331 {
1332     int i;
1333
1334     if (n == 0) {
1335         /* Nothing to pop. */
1336         return false;
1337     } else if (n == FLOW_MAX_MPLS_LABELS
1338                && !(flow->mpls_lse[n - 1] & htonl(MPLS_BOS_MASK))) {
1339         /* Can't pop because we don't know what to fill in mpls_lse[n - 1]. */
1340         return false;
1341     }
1342
1343     memset(wc->masks.mpls_lse, 0xff, sizeof wc->masks.mpls_lse);
1344     for (i = 1; i < n; i++) {
1345         flow->mpls_lse[i - 1] = flow->mpls_lse[i];
1346     }
1347     flow->mpls_lse[n - 1] = 0;
1348     flow->dl_type = eth_type;
1349     return true;
1350 }
1351
1352 /* Sets the MPLS Label that 'flow' matches to 'label', which is interpreted
1353  * as an OpenFlow 1.1 "mpls_label" value. */
1354 void
1355 flow_set_mpls_label(struct flow *flow, int idx, ovs_be32 label)
1356 {
1357     set_mpls_lse_label(&flow->mpls_lse[idx], label);
1358 }
1359
1360 /* Sets the MPLS TTL that 'flow' matches to 'ttl', which should be in the
1361  * range 0...255. */
1362 void
1363 flow_set_mpls_ttl(struct flow *flow, int idx, uint8_t ttl)
1364 {
1365     set_mpls_lse_ttl(&flow->mpls_lse[idx], ttl);
1366 }
1367
1368 /* Sets the MPLS TC that 'flow' matches to 'tc', which should be in the
1369  * range 0...7. */
1370 void
1371 flow_set_mpls_tc(struct flow *flow, int idx, uint8_t tc)
1372 {
1373     set_mpls_lse_tc(&flow->mpls_lse[idx], tc);
1374 }
1375
1376 /* Sets the MPLS BOS bit that 'flow' matches to which should be 0 or 1. */
1377 void
1378 flow_set_mpls_bos(struct flow *flow, int idx, uint8_t bos)
1379 {
1380     set_mpls_lse_bos(&flow->mpls_lse[idx], bos);
1381 }
1382
1383 /* Sets the entire MPLS LSE. */
1384 void
1385 flow_set_mpls_lse(struct flow *flow, int idx, ovs_be32 lse)
1386 {
1387     flow->mpls_lse[idx] = lse;
1388 }
1389
1390 static size_t
1391 flow_compose_l4(struct ofpbuf *b, const struct flow *flow)
1392 {
1393     size_t l4_len = 0;
1394
1395     if (!(flow->nw_frag & FLOW_NW_FRAG_ANY)
1396         || !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1397         if (flow->nw_proto == IPPROTO_TCP) {
1398             struct tcp_header *tcp;
1399
1400             l4_len = sizeof *tcp;
1401             tcp = ofpbuf_put_zeros(b, l4_len);
1402             tcp->tcp_src = flow->tp_src;
1403             tcp->tcp_dst = flow->tp_dst;
1404             tcp->tcp_ctl = TCP_CTL(ntohs(flow->tcp_flags), 5);
1405         } else if (flow->nw_proto == IPPROTO_UDP) {
1406             struct udp_header *udp;
1407
1408             l4_len = sizeof *udp;
1409             udp = ofpbuf_put_zeros(b, l4_len);
1410             udp->udp_src = flow->tp_src;
1411             udp->udp_dst = flow->tp_dst;
1412         } else if (flow->nw_proto == IPPROTO_SCTP) {
1413             struct sctp_header *sctp;
1414
1415             l4_len = sizeof *sctp;
1416             sctp = ofpbuf_put_zeros(b, l4_len);
1417             sctp->sctp_src = flow->tp_src;
1418             sctp->sctp_dst = flow->tp_dst;
1419         } else if (flow->nw_proto == IPPROTO_ICMP) {
1420             struct icmp_header *icmp;
1421
1422             l4_len = sizeof *icmp;
1423             icmp = ofpbuf_put_zeros(b, l4_len);
1424             icmp->icmp_type = ntohs(flow->tp_src);
1425             icmp->icmp_code = ntohs(flow->tp_dst);
1426             icmp->icmp_csum = csum(icmp, ICMP_HEADER_LEN);
1427         } else if (flow->nw_proto == IPPROTO_ICMPV6) {
1428             struct icmp6_hdr *icmp;
1429
1430             l4_len = sizeof *icmp;
1431             icmp = ofpbuf_put_zeros(b, l4_len);
1432             icmp->icmp6_type = ntohs(flow->tp_src);
1433             icmp->icmp6_code = ntohs(flow->tp_dst);
1434
1435             if (icmp->icmp6_code == 0 &&
1436                 (icmp->icmp6_type == ND_NEIGHBOR_SOLICIT ||
1437                  icmp->icmp6_type == ND_NEIGHBOR_ADVERT)) {
1438                 struct in6_addr *nd_target;
1439                 struct nd_opt_hdr *nd_opt;
1440
1441                 l4_len += sizeof *nd_target;
1442                 nd_target = ofpbuf_put_zeros(b, sizeof *nd_target);
1443                 *nd_target = flow->nd_target;
1444
1445                 if (!eth_addr_is_zero(flow->arp_sha)) {
1446                     l4_len += 8;
1447                     nd_opt = ofpbuf_put_zeros(b, 8);
1448                     nd_opt->nd_opt_len = 1;
1449                     nd_opt->nd_opt_type = ND_OPT_SOURCE_LINKADDR;
1450                     memcpy(nd_opt + 1, flow->arp_sha, ETH_ADDR_LEN);
1451                 }
1452                 if (!eth_addr_is_zero(flow->arp_tha)) {
1453                     l4_len += 8;
1454                     nd_opt = ofpbuf_put_zeros(b, 8);
1455                     nd_opt->nd_opt_len = 1;
1456                     nd_opt->nd_opt_type = ND_OPT_TARGET_LINKADDR;
1457                     memcpy(nd_opt + 1, flow->arp_tha, ETH_ADDR_LEN);
1458                 }
1459             }
1460             icmp->icmp6_cksum = (OVS_FORCE uint16_t)
1461                 csum(icmp, (char *)ofpbuf_tail(b) - (char *)icmp);
1462         }
1463     }
1464     return l4_len;
1465 }
1466
1467 /* Puts into 'b' a packet that flow_extract() would parse as having the given
1468  * 'flow'.
1469  *
1470  * (This is useful only for testing, obviously, and the packet isn't really
1471  * valid. It hasn't got some checksums filled in, for one, and lots of fields
1472  * are just zeroed.) */
1473 void
1474 flow_compose(struct ofpbuf *b, const struct flow *flow)
1475 {
1476     size_t l4_len;
1477
1478     /* eth_compose() sets l3 pointer and makes sure it is 32-bit aligned. */
1479     eth_compose(b, flow->dl_dst, flow->dl_src, ntohs(flow->dl_type), 0);
1480     if (flow->dl_type == htons(FLOW_DL_TYPE_NONE)) {
1481         struct eth_header *eth = ofpbuf_l2(b);
1482         eth->eth_type = htons(ofpbuf_size(b));
1483         return;
1484     }
1485
1486     if (flow->vlan_tci & htons(VLAN_CFI)) {
1487         eth_push_vlan(b, htons(ETH_TYPE_VLAN), flow->vlan_tci);
1488     }
1489
1490     if (flow->dl_type == htons(ETH_TYPE_IP)) {
1491         struct ip_header *ip;
1492
1493         ip = ofpbuf_put_zeros(b, sizeof *ip);
1494         ip->ip_ihl_ver = IP_IHL_VER(5, 4);
1495         ip->ip_tos = flow->nw_tos;
1496         ip->ip_ttl = flow->nw_ttl;
1497         ip->ip_proto = flow->nw_proto;
1498         put_16aligned_be32(&ip->ip_src, flow->nw_src);
1499         put_16aligned_be32(&ip->ip_dst, flow->nw_dst);
1500
1501         if (flow->nw_frag & FLOW_NW_FRAG_ANY) {
1502             ip->ip_frag_off |= htons(IP_MORE_FRAGMENTS);
1503             if (flow->nw_frag & FLOW_NW_FRAG_LATER) {
1504                 ip->ip_frag_off |= htons(100);
1505             }
1506         }
1507
1508         ofpbuf_set_l4(b, ofpbuf_tail(b));
1509
1510         l4_len = flow_compose_l4(b, flow);
1511
1512         ip->ip_tot_len = htons(b->l4_ofs - b->l3_ofs + l4_len);
1513         ip->ip_csum = csum(ip, sizeof *ip);
1514     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1515         struct ovs_16aligned_ip6_hdr *nh;
1516
1517         nh = ofpbuf_put_zeros(b, sizeof *nh);
1518         put_16aligned_be32(&nh->ip6_flow, htonl(6 << 28) |
1519                            htonl(flow->nw_tos << 20) | flow->ipv6_label);
1520         nh->ip6_hlim = flow->nw_ttl;
1521         nh->ip6_nxt = flow->nw_proto;
1522
1523         memcpy(&nh->ip6_src, &flow->ipv6_src, sizeof(nh->ip6_src));
1524         memcpy(&nh->ip6_dst, &flow->ipv6_dst, sizeof(nh->ip6_dst));
1525
1526         ofpbuf_set_l4(b, ofpbuf_tail(b));
1527
1528         l4_len = flow_compose_l4(b, flow);
1529
1530         nh->ip6_plen = htons(l4_len);
1531     } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
1532                flow->dl_type == htons(ETH_TYPE_RARP)) {
1533         struct arp_eth_header *arp;
1534
1535         arp = ofpbuf_put_zeros(b, sizeof *arp);
1536         ofpbuf_set_l3(b, arp);
1537         arp->ar_hrd = htons(1);
1538         arp->ar_pro = htons(ETH_TYPE_IP);
1539         arp->ar_hln = ETH_ADDR_LEN;
1540         arp->ar_pln = 4;
1541         arp->ar_op = htons(flow->nw_proto);
1542
1543         if (flow->nw_proto == ARP_OP_REQUEST ||
1544             flow->nw_proto == ARP_OP_REPLY) {
1545             put_16aligned_be32(&arp->ar_spa, flow->nw_src);
1546             put_16aligned_be32(&arp->ar_tpa, flow->nw_dst);
1547             memcpy(arp->ar_sha, flow->arp_sha, ETH_ADDR_LEN);
1548             memcpy(arp->ar_tha, flow->arp_tha, ETH_ADDR_LEN);
1549         }
1550     }
1551
1552     if (eth_type_mpls(flow->dl_type)) {
1553         int n;
1554
1555         b->l2_5_ofs = b->l3_ofs;
1556         for (n = 1; n < FLOW_MAX_MPLS_LABELS; n++) {
1557             if (flow->mpls_lse[n - 1] & htonl(MPLS_BOS_MASK)) {
1558                 break;
1559             }
1560         }
1561         while (n > 0) {
1562             push_mpls(b, flow->dl_type, flow->mpls_lse[--n]);
1563         }
1564     }
1565 }
1566 \f
1567 /* Compressed flow. */
1568
1569 static int
1570 miniflow_n_values(const struct miniflow *flow)
1571 {
1572     return count_1bits(flow->map);
1573 }
1574
1575 static uint32_t *
1576 miniflow_alloc_values(struct miniflow *flow, int n)
1577 {
1578     if (n <= MINI_N_INLINE) {
1579         return flow->inline_values;
1580     } else {
1581         COVERAGE_INC(miniflow_malloc);
1582         return xmalloc(n * sizeof *flow->values);
1583     }
1584 }
1585
1586 /* Completes an initialization of 'dst' as a miniflow copy of 'src' begun by
1587  * the caller.  The caller must have already initialized 'dst->map' properly
1588  * to indicate the significant uint32_t elements of 'src'.  'n' must be the
1589  * number of 1-bits in 'dst->map'.
1590  *
1591  * Normally the significant elements are the ones that are non-zero.  However,
1592  * when a miniflow is initialized from a (mini)mask, the values can be zeroes,
1593  * so that the flow and mask always have the same maps.
1594  *
1595  * This function initializes 'dst->values' (either inline if possible or with
1596  * malloc() otherwise) and copies the uint32_t elements of 'src' indicated by
1597  * 'dst->map' into it. */
1598 static void
1599 miniflow_init__(struct miniflow *dst, const struct flow *src, int n)
1600 {
1601     const uint32_t *src_u32 = (const uint32_t *) src;
1602     unsigned int ofs;
1603     uint64_t map;
1604
1605     dst->values = miniflow_alloc_values(dst, n);
1606     ofs = 0;
1607     for (map = dst->map; map; map = zero_rightmost_1bit(map)) {
1608         dst->values[ofs++] = src_u32[raw_ctz(map)];
1609     }
1610 }
1611
1612 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1613  * with miniflow_destroy(). */
1614 void
1615 miniflow_init(struct miniflow *dst, const struct flow *src)
1616 {
1617     const uint32_t *src_u32 = (const uint32_t *) src;
1618     unsigned int i;
1619     int n;
1620
1621     /* Initialize dst->map, counting the number of nonzero elements. */
1622     n = 0;
1623     dst->map = 0;
1624
1625     for (i = 0; i < FLOW_U32S; i++) {
1626         if (src_u32[i]) {
1627             dst->map |= UINT64_C(1) << i;
1628             n++;
1629         }
1630     }
1631
1632     miniflow_init__(dst, src, n);
1633 }
1634
1635 /* Initializes 'dst' as a copy of 'src', using 'mask->map' as 'dst''s map.  The
1636  * caller must eventually free 'dst' with miniflow_destroy(). */
1637 void
1638 miniflow_init_with_minimask(struct miniflow *dst, const struct flow *src,
1639                             const struct minimask *mask)
1640 {
1641     dst->map = mask->masks.map;
1642     miniflow_init__(dst, src, miniflow_n_values(dst));
1643 }
1644
1645 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1646  * with miniflow_destroy(). */
1647 void
1648 miniflow_clone(struct miniflow *dst, const struct miniflow *src)
1649 {
1650     int n = miniflow_n_values(src);
1651     dst->map = src->map;
1652     dst->values = miniflow_alloc_values(dst, n);
1653     memcpy(dst->values, src->values, n * sizeof *dst->values);
1654 }
1655
1656 /* Initializes 'dst' with the data in 'src', destroying 'src'.
1657  * The caller must eventually free 'dst' with miniflow_destroy(). */
1658 void
1659 miniflow_move(struct miniflow *dst, struct miniflow *src)
1660 {
1661     if (src->values == src->inline_values) {
1662         dst->values = dst->inline_values;
1663         memcpy(dst->values, src->values,
1664                miniflow_n_values(src) * sizeof *dst->values);
1665     } else {
1666         dst->values = src->values;
1667     }
1668     dst->map = src->map;
1669 }
1670
1671 /* Frees any memory owned by 'flow'.  Does not free the storage in which 'flow'
1672  * itself resides; the caller is responsible for that. */
1673 void
1674 miniflow_destroy(struct miniflow *flow)
1675 {
1676     if (flow->values != flow->inline_values) {
1677         free(flow->values);
1678     }
1679 }
1680
1681 /* Initializes 'dst' as a copy of 'src'. */
1682 void
1683 miniflow_expand(const struct miniflow *src, struct flow *dst)
1684 {
1685     memset(dst, 0, sizeof *dst);
1686     flow_union_with_miniflow(dst, src);
1687 }
1688
1689 /* Returns the uint32_t that would be at byte offset '4 * u32_ofs' if 'flow'
1690  * were expanded into a "struct flow". */
1691 static uint32_t
1692 miniflow_get(const struct miniflow *flow, unsigned int u32_ofs)
1693 {
1694     return (flow->map & UINT64_C(1) << u32_ofs)
1695         ? *(flow->values +
1696             count_1bits(flow->map & ((UINT64_C(1) << u32_ofs) - 1)))
1697         : 0;
1698 }
1699
1700 /* Returns true if 'a' and 'b' are the same flow, false otherwise.  */
1701 bool
1702 miniflow_equal(const struct miniflow *a, const struct miniflow *b)
1703 {
1704     const uint32_t *ap = a->values;
1705     const uint32_t *bp = b->values;
1706     const uint64_t a_map = a->map;
1707     const uint64_t b_map = b->map;
1708     uint64_t map;
1709
1710     if (a_map == b_map) {
1711         for (map = a_map; map; map = zero_rightmost_1bit(map)) {
1712             if (*ap++ != *bp++) {
1713                 return false;
1714             }
1715         }
1716     } else {
1717         for (map = a_map | b_map; map; map = zero_rightmost_1bit(map)) {
1718             uint64_t bit = rightmost_1bit(map);
1719             uint64_t a_value = a_map & bit ? *ap++ : 0;
1720             uint64_t b_value = b_map & bit ? *bp++ : 0;
1721
1722             if (a_value != b_value) {
1723                 return false;
1724             }
1725         }
1726     }
1727
1728     return true;
1729 }
1730
1731 /* Returns true if 'a' and 'b' are equal at the places where there are 1-bits
1732  * in 'mask', false if they differ. */
1733 bool
1734 miniflow_equal_in_minimask(const struct miniflow *a, const struct miniflow *b,
1735                            const struct minimask *mask)
1736 {
1737     const uint32_t *p;
1738     uint64_t map;
1739
1740     p = mask->masks.values;
1741
1742     for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1743         int ofs = raw_ctz(map);
1744
1745         if ((miniflow_get(a, ofs) ^ miniflow_get(b, ofs)) & *p) {
1746             return false;
1747         }
1748         p++;
1749     }
1750
1751     return true;
1752 }
1753
1754 /* Returns true if 'a' and 'b' are equal at the places where there are 1-bits
1755  * in 'mask', false if they differ. */
1756 bool
1757 miniflow_equal_flow_in_minimask(const struct miniflow *a, const struct flow *b,
1758                                 const struct minimask *mask)
1759 {
1760     const uint32_t *b_u32 = (const uint32_t *) b;
1761     const uint32_t *p;
1762     uint64_t map;
1763
1764     p = mask->masks.values;
1765
1766     for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1767         int ofs = raw_ctz(map);
1768
1769         if ((miniflow_get(a, ofs) ^ b_u32[ofs]) & *p) {
1770             return false;
1771         }
1772         p++;
1773     }
1774
1775     return true;
1776 }
1777
1778 \f
1779 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1780  * with minimask_destroy(). */
1781 void
1782 minimask_init(struct minimask *mask, const struct flow_wildcards *wc)
1783 {
1784     miniflow_init(&mask->masks, &wc->masks);
1785 }
1786
1787 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1788  * with minimask_destroy(). */
1789 void
1790 minimask_clone(struct minimask *dst, const struct minimask *src)
1791 {
1792     miniflow_clone(&dst->masks, &src->masks);
1793 }
1794
1795 /* Initializes 'dst' with the data in 'src', destroying 'src'.
1796  * The caller must eventually free 'dst' with minimask_destroy(). */
1797 void
1798 minimask_move(struct minimask *dst, struct minimask *src)
1799 {
1800     miniflow_move(&dst->masks, &src->masks);
1801 }
1802
1803 /* Initializes 'dst_' as the bit-wise "and" of 'a_' and 'b_'.
1804  *
1805  * The caller must provide room for FLOW_U32S "uint32_t"s in 'storage', for use
1806  * by 'dst_'.  The caller must *not* free 'dst_' with minimask_destroy(). */
1807 void
1808 minimask_combine(struct minimask *dst_,
1809                  const struct minimask *a_, const struct minimask *b_,
1810                  uint32_t storage[FLOW_U32S])
1811 {
1812     struct miniflow *dst = &dst_->masks;
1813     const struct miniflow *a = &a_->masks;
1814     const struct miniflow *b = &b_->masks;
1815     uint64_t map;
1816     int n = 0;
1817
1818     dst->values = storage;
1819
1820     dst->map = 0;
1821     for (map = a->map & b->map; map; map = zero_rightmost_1bit(map)) {
1822         int ofs = raw_ctz(map);
1823         uint32_t mask = miniflow_get(a, ofs) & miniflow_get(b, ofs);
1824
1825         if (mask) {
1826             dst->map |= rightmost_1bit(map);
1827             dst->values[n++] = mask;
1828         }
1829     }
1830 }
1831
1832 /* Frees any memory owned by 'mask'.  Does not free the storage in which 'mask'
1833  * itself resides; the caller is responsible for that. */
1834 void
1835 minimask_destroy(struct minimask *mask)
1836 {
1837     miniflow_destroy(&mask->masks);
1838 }
1839
1840 /* Initializes 'dst' as a copy of 'src'. */
1841 void
1842 minimask_expand(const struct minimask *mask, struct flow_wildcards *wc)
1843 {
1844     miniflow_expand(&mask->masks, &wc->masks);
1845 }
1846
1847 /* Returns the uint32_t that would be at byte offset '4 * u32_ofs' if 'mask'
1848  * were expanded into a "struct flow_wildcards". */
1849 uint32_t
1850 minimask_get(const struct minimask *mask, unsigned int u32_ofs)
1851 {
1852     return miniflow_get(&mask->masks, u32_ofs);
1853 }
1854
1855 /* Returns true if 'a' and 'b' are the same flow mask, false otherwise.  */
1856 bool
1857 minimask_equal(const struct minimask *a, const struct minimask *b)
1858 {
1859     return miniflow_equal(&a->masks, &b->masks);
1860 }
1861
1862 /* Returns true if at least one bit is wildcarded in 'a_' but not in 'b_',
1863  * false otherwise. */
1864 bool
1865 minimask_has_extra(const struct minimask *a_, const struct minimask *b_)
1866 {
1867     const struct miniflow *a = &a_->masks;
1868     const struct miniflow *b = &b_->masks;
1869     uint64_t map;
1870
1871     for (map = a->map | b->map; map; map = zero_rightmost_1bit(map)) {
1872         int ofs = raw_ctz(map);
1873         uint32_t a_u32 = miniflow_get(a, ofs);
1874         uint32_t b_u32 = miniflow_get(b, ofs);
1875
1876         if ((a_u32 & b_u32) != b_u32) {
1877             return true;
1878         }
1879     }
1880
1881     return false;
1882 }
1883
1884 /* Returns true if 'mask' matches every packet, false if 'mask' fixes any bits
1885  * or fields. */
1886 bool
1887 minimask_is_catchall(const struct minimask *mask_)
1888 {
1889     const struct miniflow *mask = &mask_->masks;
1890     const uint32_t *p = mask->values;
1891     uint64_t map;
1892
1893     for (map = mask->map; map; map = zero_rightmost_1bit(map)) {
1894         if (*p++) {
1895             return false;
1896         }
1897     }
1898     return true;
1899 }