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     struct {
 348         struct miniflow mf;
 349         uint32_t buf[FLOW_U32S];
 350     } m;
 351
 352     COVERAGE_INC(flow_extract);
 353
 354     miniflow_initialize(&m.mf, m.buf);
 355     miniflow_extract(packet, md, &m.mf);
 356     miniflow_expand(&m.mf, flow);
 357 }
 358
 359 /* Caller is responsible for initializing 'dst' with enough storage for
 360  * FLOW_U32S * 4 bytes. */
 361 void
 362 miniflow_extract(struct ofpbuf *packet, const struct pkt_metadata *md,
 363                  struct miniflow *dst)
 364 {
 365     void *data = ofpbuf_data(packet);
 366     size_t size = ofpbuf_size(packet);
 367     uint32_t *values = miniflow_values(dst);
 368     struct mf_ctx mf = { 0, values, values + FLOW_U32S };
 369     char *l2;
 370     ovs_be16 dl_type;
 371     uint8_t nw_frag, nw_tos, nw_ttl, nw_proto;
 372
 373     /* Metadata. */
 374     if (md) {
 375         if (md->tunnel.ip_dst) {
 376             miniflow_push_words(mf, tunnel, &md->tunnel,
 377                                 sizeof md->tunnel / 4);
 378         }
 379         miniflow_push_uint32_check(mf, skb_priority, md->skb_priority);
 380         miniflow_push_uint32_check(mf, pkt_mark, md->pkt_mark);
 381         miniflow_push_uint32_check(mf, recirc_id, md->recirc_id);
 382         miniflow_push_uint32(mf, in_port, odp_to_u32(md->in_port.odp_port));
 383     }
 384
 385     /* Initialize packet's layer pointer and offsets. */
 386     l2 = data;
 387     ofpbuf_set_frame(packet, data);
 388
 389     /* Must have full Ethernet header to proceed. */
 390     if (OVS_UNLIKELY(size < sizeof(struct eth_header))) {
 391         goto out;
 392     } else {
 393         ovs_be16 vlan_tci;
 394
 395         /* Link layer. */
 396         BUILD_ASSERT(offsetof(struct flow, dl_dst) + 6
 397                      == offsetof(struct flow, dl_src));
 398         miniflow_push_words(mf, dl_dst, data, ETH_ADDR_LEN * 2 / 4);
 399         /* dl_type, vlan_tci. */
 400         vlan_tci = parse_vlan(&data, &size);
 401         dl_type = parse_ethertype(&data, &size);
 402         miniflow_push_be16(mf, dl_type, dl_type);
 403         miniflow_push_be16(mf, vlan_tci, vlan_tci);
 404     }
 405
 406     /* Parse mpls. */
 407     if (OVS_UNLIKELY(eth_type_mpls(dl_type))) {
 408         int count;
 409         const void *mpls = data;
 410
 411         packet->l2_5_ofs = (char *)data - l2;
 412         count = parse_mpls(&data, &size);
 413         miniflow_push_words(mf, mpls_lse, mpls, count);
 414     }
 415
 416     /* Network layer. */
 417     packet->l3_ofs = (char *)data - l2;
 418
 419     nw_frag = 0;
 420     if (OVS_LIKELY(dl_type == htons(ETH_TYPE_IP))) {
 421         const struct ip_header *nh = data;
 422         int ip_len;
 423
 424         if (OVS_UNLIKELY(size < IP_HEADER_LEN)) {
 425             goto out;
 426         }
 427         ip_len = IP_IHL(nh->ip_ihl_ver) * 4;
 428
 429         if (OVS_UNLIKELY(ip_len < IP_HEADER_LEN)) {
 430             goto out;
 431         }
 432
 433         /* Push both source and destination address at once. */
 434         miniflow_push_words(mf, nw_src, &nh->ip_src, 2);
 435
 436         nw_tos = nh->ip_tos;
 437         nw_ttl = nh->ip_ttl;
 438         nw_proto = nh->ip_proto;
 439         if (OVS_UNLIKELY(IP_IS_FRAGMENT(nh->ip_frag_off))) {
 440             nw_frag = FLOW_NW_FRAG_ANY;
 441             if (nh->ip_frag_off & htons(IP_FRAG_OFF_MASK)) {
 442                 nw_frag |= FLOW_NW_FRAG_LATER;
 443             }
 444         }
 445         if (OVS_UNLIKELY(size < ip_len)) {
 446             goto out;
 447         }
 448         data_pull(&data, &size, ip_len);
 449
 450     } else if (dl_type == htons(ETH_TYPE_IPV6)) {
 451         const struct ovs_16aligned_ip6_hdr *nh;
 452         ovs_be32 tc_flow;
 453
 454         if (OVS_UNLIKELY(size < sizeof *nh)) {
 455             goto out;
 456         }
 457         nh = data_pull(&data, &size, sizeof *nh);
 458
 459         miniflow_push_words(mf, ipv6_src, &nh->ip6_src,
 460                             sizeof nh->ip6_src / 4);
 461         miniflow_push_words(mf, ipv6_dst, &nh->ip6_dst,
 462                             sizeof nh->ip6_dst / 4);
 463
 464         tc_flow = get_16aligned_be32(&nh->ip6_flow);
 465         {
 466             ovs_be32 label = tc_flow & htonl(IPV6_LABEL_MASK);
 467             miniflow_push_be32_check(mf, ipv6_label, label);
 468         }
 469
 470         nw_tos = ntohl(tc_flow) >> 20;
 471         nw_ttl = nh->ip6_hlim;
 472         nw_proto = nh->ip6_nxt;
 473
 474         while (1) {
 475             if (OVS_LIKELY((nw_proto != IPPROTO_HOPOPTS)
 476                            && (nw_proto != IPPROTO_ROUTING)
 477                            && (nw_proto != IPPROTO_DSTOPTS)
 478                            && (nw_proto != IPPROTO_AH)
 479                            && (nw_proto != IPPROTO_FRAGMENT))) {
 480                 /* It's either a terminal header (e.g., TCP, UDP) or one we
 481                  * don't understand.  In either case, we're done with the
 482                  * packet, so use it to fill in 'nw_proto'. */
 483                 break;
 484             }
 485
 486             /* We only verify that at least 8 bytes of the next header are
 487              * available, but many of these headers are longer.  Ensure that
 488              * accesses within the extension header are within those first 8
 489              * bytes. All extension headers are required to be at least 8
 490              * bytes. */
 491             if (OVS_UNLIKELY(size < 8)) {
 492                 goto out;
 493             }
 494
 495             if ((nw_proto == IPPROTO_HOPOPTS)
 496                 || (nw_proto == IPPROTO_ROUTING)
 497                 || (nw_proto == IPPROTO_DSTOPTS)) {
 498                 /* These headers, while different, have the fields we care
 499                  * about in the same location and with the same
 500                  * interpretation. */
 501                 const struct ip6_ext *ext_hdr = data;
 502                 nw_proto = ext_hdr->ip6e_nxt;
 503                 if (OVS_UNLIKELY(!data_try_pull(&data, &size,
 504                                                 (ext_hdr->ip6e_len + 1) * 8))) {
 505                     goto out;
 506                 }
 507             } else if (nw_proto == IPPROTO_AH) {
 508                 /* A standard AH definition isn't available, but the fields
 509                  * we care about are in the same location as the generic
 510                  * option header--only the header length is calculated
 511                  * differently. */
 512                 const struct ip6_ext *ext_hdr = data;
 513                 nw_proto = ext_hdr->ip6e_nxt;
 514                 if (OVS_UNLIKELY(!data_try_pull(&data, &size,
 515                                                 (ext_hdr->ip6e_len + 2) * 4))) {
 516                     goto out;
 517                 }
 518             } else if (nw_proto == IPPROTO_FRAGMENT) {
 519                 const struct ovs_16aligned_ip6_frag *frag_hdr = data;
 520
 521                 nw_proto = frag_hdr->ip6f_nxt;
 522                 if (!data_try_pull(&data, &size, sizeof *frag_hdr)) {
 523                     goto out;
 524                 }
 525
 526                 /* We only process the first fragment. */
 527                 if (frag_hdr->ip6f_offlg != htons(0)) {
 528                     nw_frag = FLOW_NW_FRAG_ANY;
 529                     if ((frag_hdr->ip6f_offlg & IP6F_OFF_MASK) != htons(0)) {
 530                         nw_frag |= FLOW_NW_FRAG_LATER;
 531                         nw_proto = IPPROTO_FRAGMENT;
 532                         break;
 533                     }
 534                 }
 535             }
 536         }
 537     } else {
 538         if (dl_type == htons(ETH_TYPE_ARP) ||
 539             dl_type == htons(ETH_TYPE_RARP)) {
 540             uint8_t arp_buf[2][ETH_ADDR_LEN];
 541             const struct arp_eth_header *arp = (const struct arp_eth_header *)
 542                 data_try_pull(&data, &size, ARP_ETH_HEADER_LEN);
 543
 544             if (OVS_LIKELY(arp) && OVS_LIKELY(arp->ar_hrd == htons(1))
 545                 && OVS_LIKELY(arp->ar_pro == htons(ETH_TYPE_IP))
 546                 && OVS_LIKELY(arp->ar_hln == ETH_ADDR_LEN)
 547                 && OVS_LIKELY(arp->ar_pln == 4)) {
 548                 miniflow_push_words(mf, nw_src, &arp->ar_spa, 1);
 549                 miniflow_push_words(mf, nw_dst, &arp->ar_tpa, 1);
 550
 551                 /* We only match on the lower 8 bits of the opcode. */
 552                 if (OVS_LIKELY(ntohs(arp->ar_op) <= 0xff)) {
 553                     miniflow_push_be32(mf, nw_frag, htonl(ntohs(arp->ar_op)));
 554                 }
 555
 556                 /* Must be adjacent. */
 557                 BUILD_ASSERT(offsetof(struct flow, arp_sha) + 6
 558                              == offsetof(struct flow, arp_tha));
 559
 560                 memcpy(arp_buf[0], arp->ar_sha, ETH_ADDR_LEN);
 561                 memcpy(arp_buf[1], arp->ar_tha, ETH_ADDR_LEN);
 562                 miniflow_push_words(mf, arp_sha, arp_buf,
 563                                     ETH_ADDR_LEN * 2 / 4);
 564             }
 565         }
 566         goto out;
 567     }
 568
 569     packet->l4_ofs = (char *)data - l2;
 570     miniflow_push_be32(mf, nw_frag,
 571                        BYTES_TO_BE32(nw_frag, nw_tos, nw_ttl, nw_proto));
 572
 573     if (OVS_LIKELY(!(nw_frag & FLOW_NW_FRAG_LATER))) {
 574         if (OVS_LIKELY(nw_proto == IPPROTO_TCP)) {
 575             if (OVS_LIKELY(size >= TCP_HEADER_LEN)) {
 576                 const struct tcp_header *tcp = data;
 577
 578                 miniflow_push_be32(mf, tcp_flags,
 579                                    TCP_FLAGS_BE32(tcp->tcp_ctl));
 580                 miniflow_push_words(mf, tp_src, &tcp->tcp_src, 1);
 581             }
 582         } else if (OVS_LIKELY(nw_proto == IPPROTO_UDP)) {
 583             if (OVS_LIKELY(size >= UDP_HEADER_LEN)) {
 584                 const struct udp_header *udp = data;
 585
 586                 miniflow_push_words(mf, tp_src, &udp->udp_src, 1);
 587             }
 588         } else if (OVS_LIKELY(nw_proto == IPPROTO_SCTP)) {
 589             if (OVS_LIKELY(size >= SCTP_HEADER_LEN)) {
 590                 const struct sctp_header *sctp = data;
 591
 592                 miniflow_push_words(mf, tp_src, &sctp->sctp_src, 1);
 593             }
 594         } else if (OVS_LIKELY(nw_proto == IPPROTO_ICMP)) {
 595             if (OVS_LIKELY(size >= ICMP_HEADER_LEN)) {
 596                 const struct icmp_header *icmp = data;
 597
 598                 miniflow_push_be16(mf, tp_src, htons(icmp->icmp_type));
 599                 miniflow_push_be16(mf, tp_dst, htons(icmp->icmp_code));
 600             }
 601         } else if (OVS_LIKELY(nw_proto == IPPROTO_ICMPV6)) {
 602             if (OVS_LIKELY(size >= sizeof(struct icmp6_hdr))) {
 603                 const struct in6_addr *nd_target = NULL;
 604                 uint8_t arp_buf[2][ETH_ADDR_LEN];
 605                 const struct icmp6_hdr *icmp = data_pull(&data, &size,
 606                                                          sizeof *icmp);
 607                 memset(arp_buf, 0, sizeof arp_buf);
 608                 if (OVS_LIKELY(parse_icmpv6(&data, &size, icmp, &nd_target,
 609                                             arp_buf))) {
 610                     miniflow_push_words(mf, arp_sha, arp_buf,
 611                                              ETH_ADDR_LEN * 2 / 4);
 612                     if (nd_target) {
 613                         miniflow_push_words(mf, nd_target, nd_target,
 614                                             sizeof *nd_target / 4);
 615                     }
 616                     miniflow_push_be16(mf, tp_src, htons(icmp->icmp6_type));
 617                     miniflow_push_be16(mf, tp_dst, htons(icmp->icmp6_code));
 618                 }
 619             }
 620         }
 621     }
 622     if (md) {
 623         miniflow_push_uint32_check(mf, dp_hash, md->dp_hash);
 624     }
 625  out:
 626     dst->map = mf.map;
 627 }
 628
 629 /* For every bit of a field that is wildcarded in 'wildcards', sets the
 630  * corresponding bit in 'flow' to zero. */
 631 void
 632 flow_zero_wildcards(struct flow *flow, const struct flow_wildcards *wildcards)
 633 {
 634     uint32_t *flow_u32 = (uint32_t *) flow;
 635     const uint32_t *wc_u32 = (const uint32_t *) &wildcards->masks;
 636     size_t i;
 637
 638     for (i = 0; i < FLOW_U32S; i++) {
 639         flow_u32[i] &= wc_u32[i];
 640     }
 641 }
 642
 643 void
 644 flow_unwildcard_tp_ports(const struct flow *flow, struct flow_wildcards *wc)
 645 {
 646     if (flow->nw_proto != IPPROTO_ICMP) {
 647         memset(&wc->masks.tp_src, 0xff, sizeof wc->masks.tp_src);
 648         memset(&wc->masks.tp_dst, 0xff, sizeof wc->masks.tp_dst);
 649     } else {
 650         wc->masks.tp_src = htons(0xff);
 651         wc->masks.tp_dst = htons(0xff);
 652     }
 653 }
 654
 655 /* Initializes 'fmd' with the metadata found in 'flow'. */
 656 void
 657 flow_get_metadata(const struct flow *flow, struct flow_metadata *fmd)
 658 {
 659     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 26);
 660
 661     fmd->dp_hash = flow->dp_hash;
 662     fmd->recirc_id = flow->recirc_id;
 663     fmd->tun_id = flow->tunnel.tun_id;
 664     fmd->tun_src = flow->tunnel.ip_src;
 665     fmd->tun_dst = flow->tunnel.ip_dst;
 666     fmd->metadata = flow->metadata;
 667     memcpy(fmd->regs, flow->regs, sizeof fmd->regs);
 668     fmd->pkt_mark = flow->pkt_mark;
 669     fmd->in_port = flow->in_port.ofp_port;
 670 }
 671
 672 char *
 673 flow_to_string(const struct flow *flow)
 674 {
 675     struct ds ds = DS_EMPTY_INITIALIZER;
 676     flow_format(&ds, flow);
 677     return ds_cstr(&ds);
 678 }
 679
 680 const char *
 681 flow_tun_flag_to_string(uint32_t flags)
 682 {
 683     switch (flags) {
 684     case FLOW_TNL_F_DONT_FRAGMENT:
 685         return "df";
 686     case FLOW_TNL_F_CSUM:
 687         return "csum";
 688     case FLOW_TNL_F_KEY:
 689         return "key";
 690     case FLOW_TNL_F_OAM:
 691         return "oam";
 692     default:
 693         return NULL;
 694     }
 695 }
 696
 697 void
 698 format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t),
 699              uint32_t flags, char del)
 700 {
 701     uint32_t bad = 0;
 702
 703     if (!flags) {
 704         return;
 705     }
 706     while (flags) {
 707         uint32_t bit = rightmost_1bit(flags);
 708         const char *s;
 709
 710         s = bit_to_string(bit);
 711         if (s) {
 712             ds_put_format(ds, "%s%c", s, del);
 713         } else {
 714             bad |= bit;
 715         }
 716
 717         flags &= ~bit;
 718     }
 719
 720     if (bad) {
 721         ds_put_format(ds, "0x%"PRIx32"%c", bad, del);
 722     }
 723     ds_chomp(ds, del);
 724 }
 725
 726 void
 727 format_flags_masked(struct ds *ds, const char *name,
 728                     const char *(*bit_to_string)(uint32_t), uint32_t flags,
 729                     uint32_t mask)
 730 {
 731     if (name) {
 732         ds_put_format(ds, "%s=", name);
 733     }
 734     while (mask) {
 735         uint32_t bit = rightmost_1bit(mask);
 736         const char *s = bit_to_string(bit);
 737
 738         ds_put_format(ds, "%s%s", (flags & bit) ? "+" : "-",
 739                       s ? s : "[Unknown]");
 740         mask &= ~bit;
 741     }
 742 }
 743
 744 void
 745 flow_format(struct ds *ds, const struct flow *flow)
 746 {
 747     struct match match;
 748
 749     match_wc_init(&match, flow);
 750     match_format(&match, ds, OFP_DEFAULT_PRIORITY);
 751 }
 752
 753 void
 754 flow_print(FILE *stream, const struct flow *flow)
 755 {
 756     char *s = flow_to_string(flow);
 757     fputs(s, stream);
 758     free(s);
 759 }
 760 \f
 761 /* flow_wildcards functions. */
 762
 763 /* Initializes 'wc' as a set of wildcards that matches every packet. */
 764 void
 765 flow_wildcards_init_catchall(struct flow_wildcards *wc)
 766 {
 767     memset(&wc->masks, 0, sizeof wc->masks);
 768 }
 769
 770 /* Clear the metadata and register wildcard masks. They are not packet
 771  * header fields. */
 772 void
 773 flow_wildcards_clear_non_packet_fields(struct flow_wildcards *wc)
 774 {
 775     memset(&wc->masks.metadata, 0, sizeof wc->masks.metadata);
 776     memset(&wc->masks.regs, 0, sizeof wc->masks.regs);
 777 }
 778
 779 /* Returns true if 'wc' matches every packet, false if 'wc' fixes any bits or
 780  * fields. */
 781 bool
 782 flow_wildcards_is_catchall(const struct flow_wildcards *wc)
 783 {
 784     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
 785     size_t i;
 786
 787     for (i = 0; i < FLOW_U32S; i++) {
 788         if (wc_u32[i]) {
 789             return false;
 790         }
 791     }
 792     return true;
 793 }
 794
 795 /* Sets 'dst' as the bitwise AND of wildcards in 'src1' and 'src2'.
 796  * That is, a bit or a field is wildcarded in 'dst' if it is wildcarded
 797  * in 'src1' or 'src2' or both.  */
 798 void
 799 flow_wildcards_and(struct flow_wildcards *dst,
 800                    const struct flow_wildcards *src1,
 801                    const struct flow_wildcards *src2)
 802 {
 803     uint32_t *dst_u32 = (uint32_t *) &dst->masks;
 804     const uint32_t *src1_u32 = (const uint32_t *) &src1->masks;
 805     const uint32_t *src2_u32 = (const uint32_t *) &src2->masks;
 806     size_t i;
 807
 808     for (i = 0; i < FLOW_U32S; i++) {
 809         dst_u32[i] = src1_u32[i] & src2_u32[i];
 810     }
 811 }
 812
 813 /* Sets 'dst' as the bitwise OR of wildcards in 'src1' and 'src2'.  That
 814  * is, a bit or a field is wildcarded in 'dst' if it is neither
 815  * wildcarded in 'src1' nor 'src2'. */
 816 void
 817 flow_wildcards_or(struct flow_wildcards *dst,
 818                   const struct flow_wildcards *src1,
 819                   const struct flow_wildcards *src2)
 820 {
 821     uint32_t *dst_u32 = (uint32_t *) &dst->masks;
 822     const uint32_t *src1_u32 = (const uint32_t *) &src1->masks;
 823     const uint32_t *src2_u32 = (const uint32_t *) &src2->masks;
 824     size_t i;
 825
 826     for (i = 0; i < FLOW_U32S; i++) {
 827         dst_u32[i] = src1_u32[i] | src2_u32[i];
 828     }
 829 }
 830
 831 /* Returns a hash of the wildcards in 'wc'. */
 832 uint32_t
 833 flow_wildcards_hash(const struct flow_wildcards *wc, uint32_t basis)
 834 {
 835     return flow_hash(&wc->masks, basis);
 836 }
 837
 838 /* Returns true if 'a' and 'b' represent the same wildcards, false if they are
 839  * different. */
 840 bool
 841 flow_wildcards_equal(const struct flow_wildcards *a,
 842                      const struct flow_wildcards *b)
 843 {
 844     return flow_equal(&a->masks, &b->masks);
 845 }
 846
 847 /* Returns true if at least one bit or field is wildcarded in 'a' but not in
 848  * 'b', false otherwise. */
 849 bool
 850 flow_wildcards_has_extra(const struct flow_wildcards *a,
 851                          const struct flow_wildcards *b)
 852 {
 853     const uint32_t *a_u32 = (const uint32_t *) &a->masks;
 854     const uint32_t *b_u32 = (const uint32_t *) &b->masks;
 855     size_t i;
 856
 857     for (i = 0; i < FLOW_U32S; i++) {
 858         if ((a_u32[i] & b_u32[i]) != b_u32[i]) {
 859             return true;
 860         }
 861     }
 862     return false;
 863 }
 864
 865 /* Returns true if 'a' and 'b' are equal, except that 0-bits (wildcarded bits)
 866  * in 'wc' do not need to be equal in 'a' and 'b'. */
 867 bool
 868 flow_equal_except(const struct flow *a, const struct flow *b,
 869                   const struct flow_wildcards *wc)
 870 {
 871     const uint32_t *a_u32 = (const uint32_t *) a;
 872     const uint32_t *b_u32 = (const uint32_t *) b;
 873     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
 874     size_t i;
 875
 876     for (i = 0; i < FLOW_U32S; i++) {
 877         if ((a_u32[i] ^ b_u32[i]) & wc_u32[i]) {
 878             return false;
 879         }
 880     }
 881     return true;
 882 }
 883
 884 /* Sets the wildcard mask for register 'idx' in 'wc' to 'mask'.
 885  * (A 0-bit indicates a wildcard bit.) */
 886 void
 887 flow_wildcards_set_reg_mask(struct flow_wildcards *wc, int idx, uint32_t mask)
 888 {
 889     wc->masks.regs[idx] = mask;
 890 }
 891
 892 /* Calculates the 5-tuple hash from the given miniflow.
 893  * This returns the same value as flow_hash_5tuple for the corresponding
 894  * flow. */
 895 uint32_t
 896 miniflow_hash_5tuple(const struct miniflow *flow, uint32_t basis)
 897 {
 898     uint32_t hash = basis;
 899
 900     if (flow) {
 901         ovs_be16 dl_type = MINIFLOW_GET_BE16(flow, dl_type);
 902
 903         hash = mhash_add(hash, MINIFLOW_GET_U8(flow, nw_proto));
 904
 905         /* Separate loops for better optimization. */
 906         if (dl_type == htons(ETH_TYPE_IPV6)) {
 907             uint64_t map = MINIFLOW_MAP(ipv6_src) | MINIFLOW_MAP(ipv6_dst)
 908                 | MINIFLOW_MAP(tp_src); /* Covers both ports */
 909             uint32_t value;
 910
 911             MINIFLOW_FOR_EACH_IN_MAP(value, flow, map) {
 912                 hash = mhash_add(hash, value);
 913             }
 914         } else {
 915             uint64_t map = MINIFLOW_MAP(nw_src) | MINIFLOW_MAP(nw_dst)
 916                 | MINIFLOW_MAP(tp_src); /* Covers both ports */
 917             uint32_t value;
 918
 919             MINIFLOW_FOR_EACH_IN_MAP(value, flow, map) {
 920                 hash = mhash_add(hash, value);
 921             }
 922         }
 923         hash = mhash_finish(hash, 42); /* Arbitrary number. */
 924     }
 925     return hash;
 926 }
 927
 928 BUILD_ASSERT_DECL(offsetof(struct flow, tp_src) + 2
 929                   == offsetof(struct flow, tp_dst) &&
 930                   offsetof(struct flow, tp_src) / 4
 931                   == offsetof(struct flow, tp_dst) / 4);
 932 BUILD_ASSERT_DECL(offsetof(struct flow, ipv6_src) + 16
 933                   == offsetof(struct flow, ipv6_dst));
 934
 935 /* Calculates the 5-tuple hash from the given flow. */
 936 uint32_t
 937 flow_hash_5tuple(const struct flow *flow, uint32_t basis)
 938 {
 939     uint32_t hash = basis;
 940
 941     if (flow) {
 942         const uint32_t *flow_u32 = (const uint32_t *)flow;
 943
 944         hash = mhash_add(hash, flow->nw_proto);
 945
 946         if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
 947             int ofs = offsetof(struct flow, ipv6_src) / 4;
 948             int end = ofs + 2 * sizeof flow->ipv6_src / 4;
 949
 950             while (ofs < end) {
 951                 hash = mhash_add(hash, flow_u32[ofs++]);
 952             }
 953         } else {
 954             hash = mhash_add(hash, (OVS_FORCE uint32_t) flow->nw_src);
 955             hash = mhash_add(hash, (OVS_FORCE uint32_t) flow->nw_dst);
 956         }
 957         hash = mhash_add(hash, flow_u32[offsetof(struct flow, tp_src) / 4]);
 958
 959         hash = mhash_finish(hash, 42); /* Arbitrary number. */
 960     }
 961     return hash;
 962 }
 963
 964 /* Hashes 'flow' based on its L2 through L4 protocol information. */
 965 uint32_t
 966 flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis)
 967 {
 968     struct {
 969         union {
 970             ovs_be32 ipv4_addr;
 971             struct in6_addr ipv6_addr;
 972         };
 973         ovs_be16 eth_type;
 974         ovs_be16 vlan_tci;
 975         ovs_be16 tp_port;
 976         uint8_t eth_addr[ETH_ADDR_LEN];
 977         uint8_t ip_proto;
 978     } fields;
 979
 980     int i;
 981
 982     memset(&fields, 0, sizeof fields);
 983     for (i = 0; i < ETH_ADDR_LEN; i++) {
 984         fields.eth_addr[i] = flow->dl_src[i] ^ flow->dl_dst[i];
 985     }
 986     fields.vlan_tci = flow->vlan_tci & htons(VLAN_VID_MASK);
 987     fields.eth_type = flow->dl_type;
 988
 989     /* UDP source and destination port are not taken into account because they
 990      * will not necessarily be symmetric in a bidirectional flow. */
 991     if (fields.eth_type == htons(ETH_TYPE_IP)) {
 992         fields.ipv4_addr = flow->nw_src ^ flow->nw_dst;
 993         fields.ip_proto = flow->nw_proto;
 994         if (fields.ip_proto == IPPROTO_TCP || fields.ip_proto == IPPROTO_SCTP) {
 995             fields.tp_port = flow->tp_src ^ flow->tp_dst;
 996         }
 997     } else if (fields.eth_type == htons(ETH_TYPE_IPV6)) {
 998         const uint8_t *a = &flow->ipv6_src.s6_addr[0];
 999         const uint8_t *b = &flow->ipv6_dst.s6_addr[0];
1000         uint8_t *ipv6_addr = &fields.ipv6_addr.s6_addr[0];
1001
1002         for (i=0; i<16; i++) {
1003             ipv6_addr[i] = a[i] ^ b[i];
1004         }
1005         fields.ip_proto = flow->nw_proto;
1006         if (fields.ip_proto == IPPROTO_TCP || fields.ip_proto == IPPROTO_SCTP) {
1007             fields.tp_port = flow->tp_src ^ flow->tp_dst;
1008         }
1009     }
1010     return jhash_bytes(&fields, sizeof fields, basis);
1011 }
1012
1013 /* Initialize a flow with random fields that matter for nx_hash_fields. */
1014 void
1015 flow_random_hash_fields(struct flow *flow)
1016 {
1017     uint16_t rnd = random_uint16();
1018
1019     /* Initialize to all zeros. */
1020     memset(flow, 0, sizeof *flow);
1021
1022     eth_addr_random(flow->dl_src);
1023     eth_addr_random(flow->dl_dst);
1024
1025     flow->vlan_tci = (OVS_FORCE ovs_be16) (random_uint16() & VLAN_VID_MASK);
1026
1027     /* Make most of the random flows IPv4, some IPv6, and rest random. */
1028     flow->dl_type = rnd < 0x8000 ? htons(ETH_TYPE_IP) :
1029         rnd < 0xc000 ? htons(ETH_TYPE_IPV6) : (OVS_FORCE ovs_be16)rnd;
1030
1031     if (dl_type_is_ip_any(flow->dl_type)) {
1032         if (flow->dl_type == htons(ETH_TYPE_IP)) {
1033             flow->nw_src = (OVS_FORCE ovs_be32)random_uint32();
1034             flow->nw_dst = (OVS_FORCE ovs_be32)random_uint32();
1035         } else {
1036             random_bytes(&flow->ipv6_src, sizeof flow->ipv6_src);
1037             random_bytes(&flow->ipv6_dst, sizeof flow->ipv6_dst);
1038         }
1039         /* Make most of IP flows TCP, some UDP or SCTP, and rest random. */
1040         rnd = random_uint16();
1041         flow->nw_proto = rnd < 0x8000 ? IPPROTO_TCP :
1042             rnd < 0xc000 ? IPPROTO_UDP :
1043             rnd < 0xd000 ? IPPROTO_SCTP : (uint8_t)rnd;
1044         if (flow->nw_proto == IPPROTO_TCP ||
1045             flow->nw_proto == IPPROTO_UDP ||
1046             flow->nw_proto == IPPROTO_SCTP) {
1047             flow->tp_src = (OVS_FORCE ovs_be16)random_uint16();
1048             flow->tp_dst = (OVS_FORCE ovs_be16)random_uint16();
1049         }
1050     }
1051 }
1052
1053 /* Masks the fields in 'wc' that are used by the flow hash 'fields'. */
1054 void
1055 flow_mask_hash_fields(const struct flow *flow, struct flow_wildcards *wc,
1056                       enum nx_hash_fields fields)
1057 {
1058     switch (fields) {
1059     case NX_HASH_FIELDS_ETH_SRC:
1060         memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
1061         break;
1062
1063     case NX_HASH_FIELDS_SYMMETRIC_L4:
1064         memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
1065         memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
1066         if (flow->dl_type == htons(ETH_TYPE_IP)) {
1067             memset(&wc->masks.nw_src, 0xff, sizeof wc->masks.nw_src);
1068             memset(&wc->masks.nw_dst, 0xff, sizeof wc->masks.nw_dst);
1069         } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1070             memset(&wc->masks.ipv6_src, 0xff, sizeof wc->masks.ipv6_src);
1071             memset(&wc->masks.ipv6_dst, 0xff, sizeof wc->masks.ipv6_dst);
1072         }
1073         if (is_ip_any(flow)) {
1074             memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
1075             flow_unwildcard_tp_ports(flow, wc);
1076         }
1077         wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
1078         break;
1079
1080     default:
1081         OVS_NOT_REACHED();
1082     }
1083 }
1084
1085 /* Hashes the portions of 'flow' designated by 'fields'. */
1086 uint32_t
1087 flow_hash_fields(const struct flow *flow, enum nx_hash_fields fields,
1088                  uint16_t basis)
1089 {
1090     switch (fields) {
1091
1092     case NX_HASH_FIELDS_ETH_SRC:
1093         return jhash_bytes(flow->dl_src, sizeof flow->dl_src, basis);
1094
1095     case NX_HASH_FIELDS_SYMMETRIC_L4:
1096         return flow_hash_symmetric_l4(flow, basis);
1097     }
1098
1099     OVS_NOT_REACHED();
1100 }
1101
1102 /* Returns a string representation of 'fields'. */
1103 const char *
1104 flow_hash_fields_to_str(enum nx_hash_fields fields)
1105 {
1106     switch (fields) {
1107     case NX_HASH_FIELDS_ETH_SRC: return "eth_src";
1108     case NX_HASH_FIELDS_SYMMETRIC_L4: return "symmetric_l4";
1109     default: return "<unknown>";
1110     }
1111 }
1112
1113 /* Returns true if the value of 'fields' is supported. Otherwise false. */
1114 bool
1115 flow_hash_fields_valid(enum nx_hash_fields fields)
1116 {
1117     return fields == NX_HASH_FIELDS_ETH_SRC
1118         || fields == NX_HASH_FIELDS_SYMMETRIC_L4;
1119 }
1120
1121 /* Returns a hash value for the bits of 'flow' that are active based on
1122  * 'wc', given 'basis'. */
1123 uint32_t
1124 flow_hash_in_wildcards(const struct flow *flow,
1125                        const struct flow_wildcards *wc, uint32_t basis)
1126 {
1127     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
1128     const uint32_t *flow_u32 = (const uint32_t *) flow;
1129     uint32_t hash;
1130     size_t i;
1131
1132     hash = basis;
1133     for (i = 0; i < FLOW_U32S; i++) {
1134         hash = mhash_add(hash, flow_u32[i] & wc_u32[i]);
1135     }
1136     return mhash_finish(hash, 4 * FLOW_U32S);
1137 }
1138
1139 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
1140  * OpenFlow 1.0 "dl_vlan" value:
1141  *
1142  *      - If it is in the range 0...4095, 'flow->vlan_tci' is set to match
1143  *        that VLAN.  Any existing PCP match is unchanged (it becomes 0 if
1144  *        'flow' previously matched packets without a VLAN header).
1145  *
1146  *      - If it is OFP_VLAN_NONE, 'flow->vlan_tci' is set to match a packet
1147  *        without a VLAN tag.
1148  *
1149  *      - Other values of 'vid' should not be used. */
1150 void
1151 flow_set_dl_vlan(struct flow *flow, ovs_be16 vid)
1152 {
1153     if (vid == htons(OFP10_VLAN_NONE)) {
1154         flow->vlan_tci = htons(0);
1155     } else {
1156         vid &= htons(VLAN_VID_MASK);
1157         flow->vlan_tci &= ~htons(VLAN_VID_MASK);
1158         flow->vlan_tci |= htons(VLAN_CFI) | vid;
1159     }
1160 }
1161
1162 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
1163  * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
1164  * plus CFI). */
1165 void
1166 flow_set_vlan_vid(struct flow *flow, ovs_be16 vid)
1167 {
1168     ovs_be16 mask = htons(VLAN_VID_MASK | VLAN_CFI);
1169     flow->vlan_tci &= ~mask;
1170     flow->vlan_tci |= vid & mask;
1171 }
1172
1173 /* Sets the VLAN PCP that 'flow' matches to 'pcp', which should be in the
1174  * range 0...7.
1175  *
1176  * This function has no effect on the VLAN ID that 'flow' matches.
1177  *
1178  * After calling this function, 'flow' will not match packets without a VLAN
1179  * header. */
1180 void
1181 flow_set_vlan_pcp(struct flow *flow, uint8_t pcp)
1182 {
1183     pcp &= 0x07;
1184     flow->vlan_tci &= ~htons(VLAN_PCP_MASK);
1185     flow->vlan_tci |= htons((pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
1186 }
1187
1188 /* Returns the number of MPLS LSEs present in 'flow'
1189  *
1190  * Returns 0 if the 'dl_type' of 'flow' is not an MPLS ethernet type.
1191  * Otherwise traverses 'flow''s MPLS label stack stopping at the
1192  * first entry that has the BoS bit set. If no such entry exists then
1193  * the maximum number of LSEs that can be stored in 'flow' is returned.
1194  */
1195 int
1196 flow_count_mpls_labels(const struct flow *flow, struct flow_wildcards *wc)
1197 {
1198     if (wc) {
1199         wc->masks.dl_type = OVS_BE16_MAX;
1200     }
1201     if (eth_type_mpls(flow->dl_type)) {
1202         int i;
1203         int len = FLOW_MAX_MPLS_LABELS;
1204
1205         for (i = 0; i < len; i++) {
1206             if (wc) {
1207                 wc->masks.mpls_lse[i] |= htonl(MPLS_BOS_MASK);
1208             }
1209             if (flow->mpls_lse[i] & htonl(MPLS_BOS_MASK)) {
1210                 return i + 1;
1211             }
1212         }
1213
1214         return len;
1215     } else {
1216         return 0;
1217     }
1218 }
1219
1220 /* Returns the number consecutive of MPLS LSEs, starting at the
1221  * innermost LSE, that are common in 'a' and 'b'.
1222  *
1223  * 'an' must be flow_count_mpls_labels(a).
1224  * 'bn' must be flow_count_mpls_labels(b).
1225  */
1226 int
1227 flow_count_common_mpls_labels(const struct flow *a, int an,
1228                               const struct flow *b, int bn,
1229                               struct flow_wildcards *wc)
1230 {
1231     int min_n = MIN(an, bn);
1232     if (min_n == 0) {
1233         return 0;
1234     } else {
1235         int common_n = 0;
1236         int a_last = an - 1;
1237         int b_last = bn - 1;
1238         int i;
1239
1240         for (i = 0; i < min_n; i++) {
1241             if (wc) {
1242                 wc->masks.mpls_lse[a_last - i] = OVS_BE32_MAX;
1243                 wc->masks.mpls_lse[b_last - i] = OVS_BE32_MAX;
1244             }
1245             if (a->mpls_lse[a_last - i] != b->mpls_lse[b_last - i]) {
1246                 break;
1247             } else {
1248                 common_n++;
1249             }
1250         }
1251
1252         return common_n;
1253     }
1254 }
1255
1256 /* Adds a new outermost MPLS label to 'flow' and changes 'flow''s Ethernet type
1257  * to 'mpls_eth_type', which must be an MPLS Ethertype.
1258  *
1259  * If the new label is the first MPLS label in 'flow', it is generated as;
1260  *
1261  *     - label: 2, if 'flow' is IPv6, otherwise 0.
1262  *
1263  *     - TTL: IPv4 or IPv6 TTL, if present and nonzero, otherwise 64.
1264  *
1265  *     - TC: IPv4 or IPv6 TOS, if present, otherwise 0.
1266  *
1267  *     - BoS: 1.
1268  *
1269  * If the new label is the second or label MPLS label in 'flow', it is
1270  * generated as;
1271  *
1272  *     - label: Copied from outer label.
1273  *
1274  *     - TTL: Copied from outer label.
1275  *
1276  *     - TC: Copied from outer label.
1277  *
1278  *     - BoS: 0.
1279  *
1280  * 'n' must be flow_count_mpls_labels(flow).  'n' must be less than
1281  * FLOW_MAX_MPLS_LABELS (because otherwise flow->mpls_lse[] would overflow).
1282  */
1283 void
1284 flow_push_mpls(struct flow *flow, int n, ovs_be16 mpls_eth_type,
1285                struct flow_wildcards *wc)
1286 {
1287     ovs_assert(eth_type_mpls(mpls_eth_type));
1288     ovs_assert(n < FLOW_MAX_MPLS_LABELS);
1289
1290     memset(wc->masks.mpls_lse, 0xff, sizeof wc->masks.mpls_lse);
1291     if (n) {
1292         int i;
1293
1294         for (i = n; i >= 1; i--) {
1295             flow->mpls_lse[i] = flow->mpls_lse[i - 1];
1296         }
1297         flow->mpls_lse[0] = (flow->mpls_lse[1]
1298                              & htonl(~MPLS_BOS_MASK));
1299     } else {
1300         int label = 0;          /* IPv4 Explicit Null. */
1301         int tc = 0;
1302         int ttl = 64;
1303
1304         if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1305             label = 2;
1306         }
1307
1308         if (is_ip_any(flow)) {
1309             tc = (flow->nw_tos & IP_DSCP_MASK) >> 2;
1310             wc->masks.nw_tos |= IP_DSCP_MASK;
1311
1312             if (flow->nw_ttl) {
1313                 ttl = flow->nw_ttl;
1314             }
1315             wc->masks.nw_ttl = 0xff;
1316         }
1317
1318         flow->mpls_lse[0] = set_mpls_lse_values(ttl, tc, 1, htonl(label));
1319
1320         /* Clear all L3 and L4 fields. */
1321         BUILD_ASSERT(FLOW_WC_SEQ == 26);
1322         memset((char *) flow + FLOW_SEGMENT_2_ENDS_AT, 0,
1323                sizeof(struct flow) - FLOW_SEGMENT_2_ENDS_AT);
1324     }
1325     flow->dl_type = mpls_eth_type;
1326 }
1327
1328 /* Tries to remove the outermost MPLS label from 'flow'.  Returns true if
1329  * successful, false otherwise.  On success, sets 'flow''s Ethernet type to
1330  * 'eth_type'.
1331  *
1332  * 'n' must be flow_count_mpls_labels(flow). */
1333 bool
1334 flow_pop_mpls(struct flow *flow, int n, ovs_be16 eth_type,
1335               struct flow_wildcards *wc)
1336 {
1337     int i;
1338
1339     if (n == 0) {
1340         /* Nothing to pop. */
1341         return false;
1342     } else if (n == FLOW_MAX_MPLS_LABELS
1343                && !(flow->mpls_lse[n - 1] & htonl(MPLS_BOS_MASK))) {
1344         /* Can't pop because we don't know what to fill in mpls_lse[n - 1]. */
1345         return false;
1346     }
1347
1348     memset(wc->masks.mpls_lse, 0xff, sizeof wc->masks.mpls_lse);
1349     for (i = 1; i < n; i++) {
1350         flow->mpls_lse[i - 1] = flow->mpls_lse[i];
1351     }
1352     flow->mpls_lse[n - 1] = 0;
1353     flow->dl_type = eth_type;
1354     return true;
1355 }
1356
1357 /* Sets the MPLS Label that 'flow' matches to 'label', which is interpreted
1358  * as an OpenFlow 1.1 "mpls_label" value. */
1359 void
1360 flow_set_mpls_label(struct flow *flow, int idx, ovs_be32 label)
1361 {
1362     set_mpls_lse_label(&flow->mpls_lse[idx], label);
1363 }
1364
1365 /* Sets the MPLS TTL that 'flow' matches to 'ttl', which should be in the
1366  * range 0...255. */
1367 void
1368 flow_set_mpls_ttl(struct flow *flow, int idx, uint8_t ttl)
1369 {
1370     set_mpls_lse_ttl(&flow->mpls_lse[idx], ttl);
1371 }
1372
1373 /* Sets the MPLS TC that 'flow' matches to 'tc', which should be in the
1374  * range 0...7. */
1375 void
1376 flow_set_mpls_tc(struct flow *flow, int idx, uint8_t tc)
1377 {
1378     set_mpls_lse_tc(&flow->mpls_lse[idx], tc);
1379 }
1380
1381 /* Sets the MPLS BOS bit that 'flow' matches to which should be 0 or 1. */
1382 void
1383 flow_set_mpls_bos(struct flow *flow, int idx, uint8_t bos)
1384 {
1385     set_mpls_lse_bos(&flow->mpls_lse[idx], bos);
1386 }
1387
1388 /* Sets the entire MPLS LSE. */
1389 void
1390 flow_set_mpls_lse(struct flow *flow, int idx, ovs_be32 lse)
1391 {
1392     flow->mpls_lse[idx] = lse;
1393 }
1394
1395 static size_t
1396 flow_compose_l4(struct ofpbuf *b, const struct flow *flow)
1397 {
1398     size_t l4_len = 0;
1399
1400     if (!(flow->nw_frag & FLOW_NW_FRAG_ANY)
1401         || !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1402         if (flow->nw_proto == IPPROTO_TCP) {
1403             struct tcp_header *tcp;
1404
1405             l4_len = sizeof *tcp;
1406             tcp = ofpbuf_put_zeros(b, l4_len);
1407             tcp->tcp_src = flow->tp_src;
1408             tcp->tcp_dst = flow->tp_dst;
1409             tcp->tcp_ctl = TCP_CTL(ntohs(flow->tcp_flags), 5);
1410         } else if (flow->nw_proto == IPPROTO_UDP) {
1411             struct udp_header *udp;
1412
1413             l4_len = sizeof *udp;
1414             udp = ofpbuf_put_zeros(b, l4_len);
1415             udp->udp_src = flow->tp_src;
1416             udp->udp_dst = flow->tp_dst;
1417         } else if (flow->nw_proto == IPPROTO_SCTP) {
1418             struct sctp_header *sctp;
1419
1420             l4_len = sizeof *sctp;
1421             sctp = ofpbuf_put_zeros(b, l4_len);
1422             sctp->sctp_src = flow->tp_src;
1423             sctp->sctp_dst = flow->tp_dst;
1424         } else if (flow->nw_proto == IPPROTO_ICMP) {
1425             struct icmp_header *icmp;
1426
1427             l4_len = sizeof *icmp;
1428             icmp = ofpbuf_put_zeros(b, l4_len);
1429             icmp->icmp_type = ntohs(flow->tp_src);
1430             icmp->icmp_code = ntohs(flow->tp_dst);
1431             icmp->icmp_csum = csum(icmp, ICMP_HEADER_LEN);
1432         } else if (flow->nw_proto == IPPROTO_ICMPV6) {
1433             struct icmp6_hdr *icmp;
1434
1435             l4_len = sizeof *icmp;
1436             icmp = ofpbuf_put_zeros(b, l4_len);
1437             icmp->icmp6_type = ntohs(flow->tp_src);
1438             icmp->icmp6_code = ntohs(flow->tp_dst);
1439
1440             if (icmp->icmp6_code == 0 &&
1441                 (icmp->icmp6_type == ND_NEIGHBOR_SOLICIT ||
1442                  icmp->icmp6_type == ND_NEIGHBOR_ADVERT)) {
1443                 struct in6_addr *nd_target;
1444                 struct nd_opt_hdr *nd_opt;
1445
1446                 l4_len += sizeof *nd_target;
1447                 nd_target = ofpbuf_put_zeros(b, sizeof *nd_target);
1448                 *nd_target = flow->nd_target;
1449
1450                 if (!eth_addr_is_zero(flow->arp_sha)) {
1451                     l4_len += 8;
1452                     nd_opt = ofpbuf_put_zeros(b, 8);
1453                     nd_opt->nd_opt_len = 1;
1454                     nd_opt->nd_opt_type = ND_OPT_SOURCE_LINKADDR;
1455                     memcpy(nd_opt + 1, flow->arp_sha, ETH_ADDR_LEN);
1456                 }
1457                 if (!eth_addr_is_zero(flow->arp_tha)) {
1458                     l4_len += 8;
1459                     nd_opt = ofpbuf_put_zeros(b, 8);
1460                     nd_opt->nd_opt_len = 1;
1461                     nd_opt->nd_opt_type = ND_OPT_TARGET_LINKADDR;
1462                     memcpy(nd_opt + 1, flow->arp_tha, ETH_ADDR_LEN);
1463                 }
1464             }
1465             icmp->icmp6_cksum = (OVS_FORCE uint16_t)
1466                 csum(icmp, (char *)ofpbuf_tail(b) - (char *)icmp);
1467         }
1468     }
1469     return l4_len;
1470 }
1471
1472 /* Puts into 'b' a packet that flow_extract() would parse as having the given
1473  * 'flow'.
1474  *
1475  * (This is useful only for testing, obviously, and the packet isn't really
1476  * valid. It hasn't got some checksums filled in, for one, and lots of fields
1477  * are just zeroed.) */
1478 void
1479 flow_compose(struct ofpbuf *b, const struct flow *flow)
1480 {
1481     size_t l4_len;
1482
1483     /* eth_compose() sets l3 pointer and makes sure it is 32-bit aligned. */
1484     eth_compose(b, flow->dl_dst, flow->dl_src, ntohs(flow->dl_type), 0);
1485     if (flow->dl_type == htons(FLOW_DL_TYPE_NONE)) {
1486         struct eth_header *eth = ofpbuf_l2(b);
1487         eth->eth_type = htons(ofpbuf_size(b));
1488         return;
1489     }
1490
1491     if (flow->vlan_tci & htons(VLAN_CFI)) {
1492         eth_push_vlan(b, htons(ETH_TYPE_VLAN), flow->vlan_tci);
1493     }
1494
1495     if (flow->dl_type == htons(ETH_TYPE_IP)) {
1496         struct ip_header *ip;
1497
1498         ip = ofpbuf_put_zeros(b, sizeof *ip);
1499         ip->ip_ihl_ver = IP_IHL_VER(5, 4);
1500         ip->ip_tos = flow->nw_tos;
1501         ip->ip_ttl = flow->nw_ttl;
1502         ip->ip_proto = flow->nw_proto;
1503         put_16aligned_be32(&ip->ip_src, flow->nw_src);
1504         put_16aligned_be32(&ip->ip_dst, flow->nw_dst);
1505
1506         if (flow->nw_frag & FLOW_NW_FRAG_ANY) {
1507             ip->ip_frag_off |= htons(IP_MORE_FRAGMENTS);
1508             if (flow->nw_frag & FLOW_NW_FRAG_LATER) {
1509                 ip->ip_frag_off |= htons(100);
1510             }
1511         }
1512
1513         ofpbuf_set_l4(b, ofpbuf_tail(b));
1514
1515         l4_len = flow_compose_l4(b, flow);
1516
1517         ip = ofpbuf_l3(b);
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 = ofpbuf_l3(b);
1537         nh->ip6_plen = htons(l4_len);
1538     } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
1539                flow->dl_type == htons(ETH_TYPE_RARP)) {
1540         struct arp_eth_header *arp;
1541
1542         arp = ofpbuf_put_zeros(b, sizeof *arp);
1543         ofpbuf_set_l3(b, arp);
1544         arp->ar_hrd = htons(1);
1545         arp->ar_pro = htons(ETH_TYPE_IP);
1546         arp->ar_hln = ETH_ADDR_LEN;
1547         arp->ar_pln = 4;
1548         arp->ar_op = htons(flow->nw_proto);
1549
1550         if (flow->nw_proto == ARP_OP_REQUEST ||
1551             flow->nw_proto == ARP_OP_REPLY) {
1552             put_16aligned_be32(&arp->ar_spa, flow->nw_src);
1553             put_16aligned_be32(&arp->ar_tpa, flow->nw_dst);
1554             memcpy(arp->ar_sha, flow->arp_sha, ETH_ADDR_LEN);
1555             memcpy(arp->ar_tha, flow->arp_tha, ETH_ADDR_LEN);
1556         }
1557     }
1558
1559     if (eth_type_mpls(flow->dl_type)) {
1560         int n;
1561
1562         b->l2_5_ofs = b->l3_ofs;
1563         for (n = 1; n < FLOW_MAX_MPLS_LABELS; n++) {
1564             if (flow->mpls_lse[n - 1] & htonl(MPLS_BOS_MASK)) {
1565                 break;
1566             }
1567         }
1568         while (n > 0) {
1569             push_mpls(b, flow->dl_type, flow->mpls_lse[--n]);
1570         }
1571     }
1572 }
1573 \f
1574 /* Compressed flow. */
1575
1576 static int
1577 miniflow_n_values(const struct miniflow *flow)
1578 {
1579     return count_1bits(flow->map);
1580 }
1581
1582 static uint32_t *
1583 miniflow_alloc_values(struct miniflow *flow, int n)
1584 {
1585     int size = MINIFLOW_VALUES_SIZE(n);
1586
1587     if (size <= sizeof flow->inline_values) {
1588         flow->values_inline = true;
1589         return flow->inline_values;
1590     } else {
1591         COVERAGE_INC(miniflow_malloc);
1592         flow->values_inline = false;
1593         flow->offline_values = xmalloc(size);
1594         return flow->offline_values;
1595     }
1596 }
1597
1598 /* Completes an initialization of 'dst' as a miniflow copy of 'src' begun by
1599  * the caller.  The caller must have already initialized 'dst->map' properly
1600  * to indicate the significant uint32_t elements of 'src'.  'n' must be the
1601  * number of 1-bits in 'dst->map'.
1602  *
1603  * Normally the significant elements are the ones that are non-zero.  However,
1604  * when a miniflow is initialized from a (mini)mask, the values can be zeroes,
1605  * so that the flow and mask always have the same maps.
1606  *
1607  * This function initializes values (either inline if possible or with
1608  * malloc() otherwise) and copies the uint32_t elements of 'src' indicated by
1609  * 'dst->map' into it. */
1610 static void
1611 miniflow_init__(struct miniflow *dst, const struct flow *src, int n)
1612 {
1613     const uint32_t *src_u32 = (const uint32_t *) src;
1614     uint32_t *dst_u32 = miniflow_alloc_values(dst, n);
1615     uint64_t map;
1616
1617     for (map = dst->map; map; map = zero_rightmost_1bit(map)) {
1618         *dst_u32++ = src_u32[raw_ctz(map)];
1619     }
1620 }
1621
1622 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1623  * with miniflow_destroy().
1624  * Always allocates offline storage. */
1625 void
1626 miniflow_init(struct miniflow *dst, const struct flow *src)
1627 {
1628     const uint32_t *src_u32 = (const uint32_t *) src;
1629     unsigned int i;
1630     int n;
1631
1632     /* Initialize dst->map, counting the number of nonzero elements. */
1633     n = 0;
1634     dst->map = 0;
1635
1636     for (i = 0; i < FLOW_U32S; i++) {
1637         if (src_u32[i]) {
1638             dst->map |= UINT64_C(1) << i;
1639             n++;
1640         }
1641     }
1642
1643     miniflow_init__(dst, src, n);
1644 }
1645
1646 /* Initializes 'dst' as a copy of 'src', using 'mask->map' as 'dst''s map.  The
1647  * caller must eventually free 'dst' with miniflow_destroy(). */
1648 void
1649 miniflow_init_with_minimask(struct miniflow *dst, const struct flow *src,
1650                             const struct minimask *mask)
1651 {
1652     dst->map = mask->masks.map;
1653     miniflow_init__(dst, src, miniflow_n_values(dst));
1654 }
1655
1656 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1657  * with miniflow_destroy(). */
1658 void
1659 miniflow_clone(struct miniflow *dst, const struct miniflow *src)
1660 {
1661     int size = MINIFLOW_VALUES_SIZE(miniflow_n_values(src));
1662     uint32_t *values;
1663
1664     dst->map = src->map;
1665     if (size <= sizeof dst->inline_values) {
1666         dst->values_inline = true;
1667         values = dst->inline_values;
1668     } else {
1669         dst->values_inline = false;
1670         COVERAGE_INC(miniflow_malloc);
1671         dst->offline_values = xmalloc(size);
1672         values = dst->offline_values;
1673     }
1674     memcpy(values, miniflow_get_values(src), size);
1675 }
1676
1677 /* Initializes 'dst' as a copy of 'src'.  The caller must have allocated
1678  * 'dst' to have inline space all data in 'src'. */
1679 void
1680 miniflow_clone_inline(struct miniflow *dst, const struct miniflow *src,
1681                       size_t n_values)
1682 {
1683     dst->values_inline = true;
1684     dst->map = src->map;
1685     memcpy(dst->inline_values, miniflow_get_values(src),
1686            MINIFLOW_VALUES_SIZE(n_values));
1687 }
1688
1689 /* Initializes 'dst' with the data in 'src', destroying 'src'.
1690  * The caller must eventually free 'dst' with miniflow_destroy().
1691  * 'dst' must be regularly sized miniflow, but 'src' can have
1692  * larger than default inline values. */
1693 void
1694 miniflow_move(struct miniflow *dst, struct miniflow *src)
1695 {
1696     int size = MINIFLOW_VALUES_SIZE(miniflow_n_values(src));
1697
1698     dst->map = src->map;
1699     if (size <= sizeof dst->inline_values) {
1700         dst->values_inline = true;
1701         memcpy(dst->inline_values, miniflow_get_values(src), size);
1702         miniflow_destroy(src);
1703     } else if (src->values_inline) {
1704         dst->values_inline = false;
1705         COVERAGE_INC(miniflow_malloc);
1706         dst->offline_values = xmalloc(size);
1707         memcpy(dst->offline_values, src->inline_values, size);
1708     } else {
1709         dst->values_inline = false;
1710         dst->offline_values = src->offline_values;
1711     }
1712 }
1713
1714 /* Frees any memory owned by 'flow'.  Does not free the storage in which 'flow'
1715  * itself resides; the caller is responsible for that. */
1716 void
1717 miniflow_destroy(struct miniflow *flow)
1718 {
1719     if (!flow->values_inline) {
1720         free(flow->offline_values);
1721     }
1722 }
1723
1724 /* Initializes 'dst' as a copy of 'src'. */
1725 void
1726 miniflow_expand(const struct miniflow *src, struct flow *dst)
1727 {
1728     memset(dst, 0, sizeof *dst);
1729     flow_union_with_miniflow(dst, src);
1730 }
1731
1732 /* Returns the uint32_t that would be at byte offset '4 * u32_ofs' if 'flow'
1733  * were expanded into a "struct flow". */
1734 static uint32_t
1735 miniflow_get(const struct miniflow *flow, unsigned int u32_ofs)
1736 {
1737     return (flow->map & UINT64_C(1) << u32_ofs)
1738         ? *(miniflow_get_u32_values(flow) +
1739             count_1bits(flow->map & ((UINT64_C(1) << u32_ofs) - 1)))
1740         : 0;
1741 }
1742
1743 /* Returns true if 'a' and 'b' are the same flow, false otherwise.  */
1744 bool
1745 miniflow_equal(const struct miniflow *a, const struct miniflow *b)
1746 {
1747     const uint32_t *ap = miniflow_get_u32_values(a);
1748     const uint32_t *bp = miniflow_get_u32_values(b);
1749     const uint64_t a_map = a->map;
1750     const uint64_t b_map = b->map;
1751
1752     if (OVS_LIKELY(a_map == b_map)) {
1753         int count = miniflow_n_values(a);
1754
1755         return !memcmp(ap, bp, count * sizeof *ap);
1756     } else {
1757         uint64_t map;
1758
1759         for (map = a_map | b_map; map; map = zero_rightmost_1bit(map)) {
1760             uint64_t bit = rightmost_1bit(map);
1761             uint64_t a_value = a_map & bit ? *ap++ : 0;
1762             uint64_t b_value = b_map & bit ? *bp++ : 0;
1763
1764             if (a_value != b_value) {
1765                 return false;
1766             }
1767         }
1768     }
1769
1770     return true;
1771 }
1772
1773 /* Returns true if 'a' and 'b' are equal at the places where there are 1-bits
1774  * in 'mask', false if they differ. */
1775 bool
1776 miniflow_equal_in_minimask(const struct miniflow *a, const struct miniflow *b,
1777                            const struct minimask *mask)
1778 {
1779     const uint32_t *p = miniflow_get_u32_values(&mask->masks);
1780     uint64_t map;
1781
1782     for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1783         int ofs = raw_ctz(map);
1784
1785         if ((miniflow_get(a, ofs) ^ miniflow_get(b, ofs)) & *p++) {
1786             return false;
1787         }
1788     }
1789
1790     return true;
1791 }
1792
1793 /* Returns true if 'a' and 'b' are equal at the places where there are 1-bits
1794  * in 'mask', false if they differ. */
1795 bool
1796 miniflow_equal_flow_in_minimask(const struct miniflow *a, const struct flow *b,
1797                                 const struct minimask *mask)
1798 {
1799     const uint32_t *b_u32 = (const uint32_t *) b;
1800     const uint32_t *p = miniflow_get_u32_values(&mask->masks);
1801     uint64_t map;
1802
1803     for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1804         int ofs = raw_ctz(map);
1805
1806         if ((miniflow_get(a, ofs) ^ b_u32[ofs]) & *p++) {
1807             return false;
1808         }
1809     }
1810
1811     return true;
1812 }
1813
1814 \f
1815 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1816  * with minimask_destroy(). */
1817 void
1818 minimask_init(struct minimask *mask, const struct flow_wildcards *wc)
1819 {
1820     miniflow_init(&mask->masks, &wc->masks);
1821 }
1822
1823 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1824  * with minimask_destroy(). */
1825 void
1826 minimask_clone(struct minimask *dst, const struct minimask *src)
1827 {
1828     miniflow_clone(&dst->masks, &src->masks);
1829 }
1830
1831 /* Initializes 'dst' with the data in 'src', destroying 'src'.
1832  * The caller must eventually free 'dst' with minimask_destroy(). */
1833 void
1834 minimask_move(struct minimask *dst, struct minimask *src)
1835 {
1836     miniflow_move(&dst->masks, &src->masks);
1837 }
1838
1839 /* Initializes 'dst_' as the bit-wise "and" of 'a_' and 'b_'.
1840  *
1841  * The caller must provide room for FLOW_U32S "uint32_t"s in 'storage', for use
1842  * by 'dst_'.  The caller must *not* free 'dst_' with minimask_destroy(). */
1843 void
1844 minimask_combine(struct minimask *dst_,
1845                  const struct minimask *a_, const struct minimask *b_,
1846                  uint32_t storage[FLOW_U32S])
1847 {
1848     struct miniflow *dst = &dst_->masks;
1849     uint32_t *dst_values = storage;
1850     const struct miniflow *a = &a_->masks;
1851     const struct miniflow *b = &b_->masks;
1852     uint64_t map;
1853     int n = 0;
1854
1855     dst->values_inline = false;
1856     dst->offline_values = storage;
1857
1858     dst->map = 0;
1859     for (map = a->map & b->map; map; map = zero_rightmost_1bit(map)) {
1860         int ofs = raw_ctz(map);
1861         uint32_t mask = miniflow_get(a, ofs) & miniflow_get(b, ofs);
1862
1863         if (mask) {
1864             dst->map |= rightmost_1bit(map);
1865             dst_values[n++] = mask;
1866         }
1867     }
1868 }
1869
1870 /* Frees any memory owned by 'mask'.  Does not free the storage in which 'mask'
1871  * itself resides; the caller is responsible for that. */
1872 void
1873 minimask_destroy(struct minimask *mask)
1874 {
1875     miniflow_destroy(&mask->masks);
1876 }
1877
1878 /* Initializes 'dst' as a copy of 'src'. */
1879 void
1880 minimask_expand(const struct minimask *mask, struct flow_wildcards *wc)
1881 {
1882     miniflow_expand(&mask->masks, &wc->masks);
1883 }
1884
1885 /* Returns the uint32_t that would be at byte offset '4 * u32_ofs' if 'mask'
1886  * were expanded into a "struct flow_wildcards". */
1887 uint32_t
1888 minimask_get(const struct minimask *mask, unsigned int u32_ofs)
1889 {
1890     return miniflow_get(&mask->masks, u32_ofs);
1891 }
1892
1893 /* Returns true if 'a' and 'b' are the same flow mask, false otherwise.  */
1894 bool
1895 minimask_equal(const struct minimask *a, const struct minimask *b)
1896 {
1897     return miniflow_equal(&a->masks, &b->masks);
1898 }
1899
1900 /* Returns true if at least one bit matched by 'b' is wildcarded by 'a',
1901  * false otherwise. */
1902 bool
1903 minimask_has_extra(const struct minimask *a, const struct minimask *b)
1904 {
1905     const uint32_t *p = miniflow_get_u32_values(&b->masks);
1906     uint64_t map;
1907
1908     for (map = b->masks.map; map; map = zero_rightmost_1bit(map)) {
1909         uint32_t a_u32 = minimask_get(a, raw_ctz(map));
1910         uint32_t b_u32 = *p++;
1911
1912         if ((a_u32 & b_u32) != b_u32) {
1913             return true;
1914         }
1915     }
1916
1917     return false;
1918 }