lib/flow.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 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 "unaligned.h"
  39 #include "vlog.h"
  40
  41 VLOG_DEFINE_THIS_MODULE(flow);
  42
  43 COVERAGE_DEFINE(flow_extract);
  44 COVERAGE_DEFINE(miniflow_malloc);
  45
  46 static struct arp_eth_header *
  47 pull_arp(struct ofpbuf *packet)
  48 {
  49     return ofpbuf_try_pull(packet, ARP_ETH_HEADER_LEN);
  50 }
  51
  52 static struct ip_header *
  53 pull_ip(struct ofpbuf *packet)
  54 {
  55     if (packet->size >= IP_HEADER_LEN) {
  56         struct ip_header *ip = packet->data;
  57         int ip_len = IP_IHL(ip->ip_ihl_ver) * 4;
  58         if (ip_len >= IP_HEADER_LEN && packet->size >= ip_len) {
  59             return ofpbuf_pull(packet, ip_len);
  60         }
  61     }
  62     return NULL;
  63 }
  64
  65 static struct tcp_header *
  66 pull_tcp(struct ofpbuf *packet)
  67 {
  68     if (packet->size >= TCP_HEADER_LEN) {
  69         struct tcp_header *tcp = packet->data;
  70         int tcp_len = TCP_OFFSET(tcp->tcp_ctl) * 4;
  71         if (tcp_len >= TCP_HEADER_LEN && packet->size >= tcp_len) {
  72             return ofpbuf_pull(packet, tcp_len);
  73         }
  74     }
  75     return NULL;
  76 }
  77
  78 static struct udp_header *
  79 pull_udp(struct ofpbuf *packet)
  80 {
  81     return ofpbuf_try_pull(packet, UDP_HEADER_LEN);
  82 }
  83
  84 static struct icmp_header *
  85 pull_icmp(struct ofpbuf *packet)
  86 {
  87     return ofpbuf_try_pull(packet, ICMP_HEADER_LEN);
  88 }
  89
  90 static struct icmp6_hdr *
  91 pull_icmpv6(struct ofpbuf *packet)
  92 {
  93     return ofpbuf_try_pull(packet, sizeof(struct icmp6_hdr));
  94 }
  95
  96 static void
  97 parse_mpls(struct ofpbuf *b, struct flow *flow)
  98 {
  99     struct mpls_hdr *mh;
 100
 101     while ((mh = ofpbuf_try_pull(b, sizeof *mh))) {
 102         if (flow->mpls_depth++ == 0) {
 103             flow->mpls_lse = mh->mpls_lse;
 104         }
 105         if (mh->mpls_lse & htonl(MPLS_BOS_MASK)) {
 106             break;
 107         }
 108     }
 109 }
 110
 111 static void
 112 parse_vlan(struct ofpbuf *b, struct flow *flow)
 113 {
 114     struct qtag_prefix {
 115         ovs_be16 eth_type;      /* ETH_TYPE_VLAN */
 116         ovs_be16 tci;
 117     };
 118
 119     if (b->size >= sizeof(struct qtag_prefix) + sizeof(ovs_be16)) {
 120         struct qtag_prefix *qp = ofpbuf_pull(b, sizeof *qp);
 121         flow->vlan_tci = qp->tci | htons(VLAN_CFI);
 122     }
 123 }
 124
 125 static ovs_be16
 126 parse_ethertype(struct ofpbuf *b)
 127 {
 128     struct llc_snap_header *llc;
 129     ovs_be16 proto;
 130
 131     proto = *(ovs_be16 *) ofpbuf_pull(b, sizeof proto);
 132     if (ntohs(proto) >= ETH_TYPE_MIN) {
 133         return proto;
 134     }
 135
 136     if (b->size < sizeof *llc) {
 137         return htons(FLOW_DL_TYPE_NONE);
 138     }
 139
 140     llc = b->data;
 141     if (llc->llc.llc_dsap != LLC_DSAP_SNAP
 142         || llc->llc.llc_ssap != LLC_SSAP_SNAP
 143         || llc->llc.llc_cntl != LLC_CNTL_SNAP
 144         || memcmp(llc->snap.snap_org, SNAP_ORG_ETHERNET,
 145                   sizeof llc->snap.snap_org)) {
 146         return htons(FLOW_DL_TYPE_NONE);
 147     }
 148
 149     ofpbuf_pull(b, sizeof *llc);
 150
 151     if (ntohs(llc->snap.snap_type) >= ETH_TYPE_MIN) {
 152         return llc->snap.snap_type;
 153     }
 154
 155     return htons(FLOW_DL_TYPE_NONE);
 156 }
 157
 158 static int
 159 parse_ipv6(struct ofpbuf *packet, struct flow *flow)
 160 {
 161     const struct ip6_hdr *nh;
 162     ovs_be32 tc_flow;
 163     int nexthdr;
 164
 165     nh = ofpbuf_try_pull(packet, sizeof *nh);
 166     if (!nh) {
 167         return EINVAL;
 168     }
 169
 170     nexthdr = nh->ip6_nxt;
 171
 172     flow->ipv6_src = nh->ip6_src;
 173     flow->ipv6_dst = nh->ip6_dst;
 174
 175     tc_flow = get_unaligned_be32(&nh->ip6_flow);
 176     flow->nw_tos = ntohl(tc_flow) >> 20;
 177     flow->ipv6_label = tc_flow & htonl(IPV6_LABEL_MASK);
 178     flow->nw_ttl = nh->ip6_hlim;
 179     flow->nw_proto = IPPROTO_NONE;
 180
 181     while (1) {
 182         if ((nexthdr != IPPROTO_HOPOPTS)
 183                 && (nexthdr != IPPROTO_ROUTING)
 184                 && (nexthdr != IPPROTO_DSTOPTS)
 185                 && (nexthdr != IPPROTO_AH)
 186                 && (nexthdr != IPPROTO_FRAGMENT)) {
 187             /* It's either a terminal header (e.g., TCP, UDP) or one we
 188              * don't understand.  In either case, we're done with the
 189              * packet, so use it to fill in 'nw_proto'. */
 190             break;
 191         }
 192
 193         /* We only verify that at least 8 bytes of the next header are
 194          * available, but many of these headers are longer.  Ensure that
 195          * accesses within the extension header are within those first 8
 196          * bytes. All extension headers are required to be at least 8
 197          * bytes. */
 198         if (packet->size < 8) {
 199             return EINVAL;
 200         }
 201
 202         if ((nexthdr == IPPROTO_HOPOPTS)
 203                 || (nexthdr == IPPROTO_ROUTING)
 204                 || (nexthdr == IPPROTO_DSTOPTS)) {
 205             /* These headers, while different, have the fields we care about
 206              * in the same location and with the same interpretation. */
 207             const struct ip6_ext *ext_hdr = packet->data;
 208             nexthdr = ext_hdr->ip6e_nxt;
 209             if (!ofpbuf_try_pull(packet, (ext_hdr->ip6e_len + 1) * 8)) {
 210                 return EINVAL;
 211             }
 212         } else if (nexthdr == IPPROTO_AH) {
 213             /* A standard AH definition isn't available, but the fields
 214              * we care about are in the same location as the generic
 215              * option header--only the header length is calculated
 216              * differently. */
 217             const struct ip6_ext *ext_hdr = packet->data;
 218             nexthdr = ext_hdr->ip6e_nxt;
 219             if (!ofpbuf_try_pull(packet, (ext_hdr->ip6e_len + 2) * 4)) {
 220                return EINVAL;
 221             }
 222         } else if (nexthdr == IPPROTO_FRAGMENT) {
 223             const struct ip6_frag *frag_hdr = packet->data;
 224
 225             nexthdr = frag_hdr->ip6f_nxt;
 226             if (!ofpbuf_try_pull(packet, sizeof *frag_hdr)) {
 227                 return EINVAL;
 228             }
 229
 230             /* We only process the first fragment. */
 231             if (frag_hdr->ip6f_offlg != htons(0)) {
 232                 flow->nw_frag = FLOW_NW_FRAG_ANY;
 233                 if ((frag_hdr->ip6f_offlg & IP6F_OFF_MASK) != htons(0)) {
 234                     flow->nw_frag |= FLOW_NW_FRAG_LATER;
 235                     nexthdr = IPPROTO_FRAGMENT;
 236                     break;
 237                 }
 238             }
 239         }
 240     }
 241
 242     flow->nw_proto = nexthdr;
 243     return 0;
 244 }
 245
 246 static void
 247 parse_tcp(struct ofpbuf *packet, struct ofpbuf *b, struct flow *flow)
 248 {
 249     const struct tcp_header *tcp = pull_tcp(b);
 250     if (tcp) {
 251         flow->tp_src = tcp->tcp_src;
 252         flow->tp_dst = tcp->tcp_dst;
 253         packet->l7 = b->data;
 254     }
 255 }
 256
 257 static void
 258 parse_udp(struct ofpbuf *packet, struct ofpbuf *b, struct flow *flow)
 259 {
 260     const struct udp_header *udp = pull_udp(b);
 261     if (udp) {
 262         flow->tp_src = udp->udp_src;
 263         flow->tp_dst = udp->udp_dst;
 264         packet->l7 = b->data;
 265     }
 266 }
 267
 268 static bool
 269 parse_icmpv6(struct ofpbuf *b, struct flow *flow)
 270 {
 271     const struct icmp6_hdr *icmp = pull_icmpv6(b);
 272
 273     if (!icmp) {
 274         return false;
 275     }
 276
 277     /* The ICMPv6 type and code fields use the 16-bit transport port
 278      * fields, so we need to store them in 16-bit network byte order. */
 279     flow->tp_src = htons(icmp->icmp6_type);
 280     flow->tp_dst = htons(icmp->icmp6_code);
 281
 282     if (icmp->icmp6_code == 0 &&
 283         (icmp->icmp6_type == ND_NEIGHBOR_SOLICIT ||
 284          icmp->icmp6_type == ND_NEIGHBOR_ADVERT)) {
 285         const struct in6_addr *nd_target;
 286
 287         nd_target = ofpbuf_try_pull(b, sizeof *nd_target);
 288         if (!nd_target) {
 289             return false;
 290         }
 291         flow->nd_target = *nd_target;
 292
 293         while (b->size >= 8) {
 294             /* The minimum size of an option is 8 bytes, which also is
 295              * the size of Ethernet link-layer options. */
 296             const struct nd_opt_hdr *nd_opt = b->data;
 297             int opt_len = nd_opt->nd_opt_len * 8;
 298
 299             if (!opt_len || opt_len > b->size) {
 300                 goto invalid;
 301             }
 302
 303             /* Store the link layer address if the appropriate option is
 304              * provided.  It is considered an error if the same link
 305              * layer option is specified twice. */
 306             if (nd_opt->nd_opt_type == ND_OPT_SOURCE_LINKADDR
 307                     && opt_len == 8) {
 308                 if (eth_addr_is_zero(flow->arp_sha)) {
 309                     memcpy(flow->arp_sha, nd_opt + 1, ETH_ADDR_LEN);
 310                 } else {
 311                     goto invalid;
 312                 }
 313             } else if (nd_opt->nd_opt_type == ND_OPT_TARGET_LINKADDR
 314                     && opt_len == 8) {
 315                 if (eth_addr_is_zero(flow->arp_tha)) {
 316                     memcpy(flow->arp_tha, nd_opt + 1, ETH_ADDR_LEN);
 317                 } else {
 318                     goto invalid;
 319                 }
 320             }
 321
 322             if (!ofpbuf_try_pull(b, opt_len)) {
 323                 goto invalid;
 324             }
 325         }
 326     }
 327
 328     return true;
 329
 330 invalid:
 331     memset(&flow->nd_target, 0, sizeof(flow->nd_target));
 332     memset(flow->arp_sha, 0, sizeof(flow->arp_sha));
 333     memset(flow->arp_tha, 0, sizeof(flow->arp_tha));
 334
 335     return false;
 336
 337 }
 338
 339 /* Initializes 'flow' members from 'packet', 'skb_priority', 'tnl', and
 340  * 'ofp_in_port'.
 341  *
 342  * Initializes 'packet' header pointers as follows:
 343  *
 344  *    - packet->l2 to the start of the Ethernet header.
 345  *
 346  *    - packet->l2_5 to the start of the MPLS shim header.
 347  *
 348  *    - packet->l3 to just past the Ethernet header, or just past the
 349  *      vlan_header if one is present, to the first byte of the payload of the
 350  *      Ethernet frame.
 351  *
 352  *    - packet->l4 to just past the IPv4 header, if one is present and has a
 353  *      correct length, and otherwise NULL.
 354  *
 355  *    - packet->l7 to just past the TCP or UDP or ICMP header, if one is
 356  *      present and has a correct length, and otherwise NULL.
 357  */
 358 void
 359 flow_extract(struct ofpbuf *packet, uint32_t skb_priority, uint32_t skb_mark,
 360              const struct flow_tnl *tnl, uint16_t ofp_in_port,
 361              struct flow *flow)
 362 {
 363     struct ofpbuf b = *packet;
 364     struct eth_header *eth;
 365
 366     COVERAGE_INC(flow_extract);
 367
 368     memset(flow, 0, sizeof *flow);
 369
 370     if (tnl) {
 371         ovs_assert(tnl != &flow->tunnel);
 372         flow->tunnel = *tnl;
 373     }
 374     flow->in_port = ofp_in_port;
 375     flow->skb_priority = skb_priority;
 376     flow->skb_mark = skb_mark;
 377
 378     packet->l2   = b.data;
 379     packet->l2_5 = NULL;
 380     packet->l3   = NULL;
 381     packet->l4   = NULL;
 382     packet->l7   = NULL;
 383
 384     if (b.size < sizeof *eth) {
 385         return;
 386     }
 387
 388     /* Link layer. */
 389     eth = b.data;
 390     memcpy(flow->dl_src, eth->eth_src, ETH_ADDR_LEN);
 391     memcpy(flow->dl_dst, eth->eth_dst, ETH_ADDR_LEN);
 392
 393     /* dl_type, vlan_tci. */
 394     ofpbuf_pull(&b, ETH_ADDR_LEN * 2);
 395     if (eth->eth_type == htons(ETH_TYPE_VLAN)) {
 396         parse_vlan(&b, flow);
 397     }
 398     flow->dl_type = parse_ethertype(&b);
 399
 400     /* Parse mpls, copy l3 ttl. */
 401     if (eth_type_mpls(flow->dl_type)) {
 402         packet->l2_5 = b.data;
 403         parse_mpls(&b, flow);
 404     }
 405
 406     /* Network layer. */
 407     packet->l3 = b.data;
 408     if (flow->dl_type == htons(ETH_TYPE_IP)) {
 409         const struct ip_header *nh = pull_ip(&b);
 410         if (nh) {
 411             packet->l4 = b.data;
 412
 413             flow->nw_src = get_unaligned_be32(&nh->ip_src);
 414             flow->nw_dst = get_unaligned_be32(&nh->ip_dst);
 415             flow->nw_proto = nh->ip_proto;
 416
 417             flow->nw_tos = nh->ip_tos;
 418             if (IP_IS_FRAGMENT(nh->ip_frag_off)) {
 419                 flow->nw_frag = FLOW_NW_FRAG_ANY;
 420                 if (nh->ip_frag_off & htons(IP_FRAG_OFF_MASK)) {
 421                     flow->nw_frag |= FLOW_NW_FRAG_LATER;
 422                 }
 423             }
 424             flow->nw_ttl = nh->ip_ttl;
 425
 426             if (!(nh->ip_frag_off & htons(IP_FRAG_OFF_MASK))) {
 427                 if (flow->nw_proto == IPPROTO_TCP) {
 428                     parse_tcp(packet, &b, flow);
 429                 } else if (flow->nw_proto == IPPROTO_UDP) {
 430                     parse_udp(packet, &b, flow);
 431                 } else if (flow->nw_proto == IPPROTO_ICMP) {
 432                     const struct icmp_header *icmp = pull_icmp(&b);
 433                     if (icmp) {
 434                         flow->tp_src = htons(icmp->icmp_type);
 435                         flow->tp_dst = htons(icmp->icmp_code);
 436                         packet->l7 = b.data;
 437                     }
 438                 }
 439             }
 440         }
 441     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
 442         if (parse_ipv6(&b, flow)) {
 443             return;
 444         }
 445
 446         packet->l4 = b.data;
 447         if (flow->nw_proto == IPPROTO_TCP) {
 448             parse_tcp(packet, &b, flow);
 449         } else if (flow->nw_proto == IPPROTO_UDP) {
 450             parse_udp(packet, &b, flow);
 451         } else if (flow->nw_proto == IPPROTO_ICMPV6) {
 452             if (parse_icmpv6(&b, flow)) {
 453                 packet->l7 = b.data;
 454             }
 455         }
 456     } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
 457                flow->dl_type == htons(ETH_TYPE_RARP)) {
 458         const struct arp_eth_header *arp = pull_arp(&b);
 459         if (arp && arp->ar_hrd == htons(1)
 460             && arp->ar_pro == htons(ETH_TYPE_IP)
 461             && arp->ar_hln == ETH_ADDR_LEN
 462             && arp->ar_pln == 4) {
 463             /* We only match on the lower 8 bits of the opcode. */
 464             if (ntohs(arp->ar_op) <= 0xff) {
 465                 flow->nw_proto = ntohs(arp->ar_op);
 466             }
 467
 468             flow->nw_src = arp->ar_spa;
 469             flow->nw_dst = arp->ar_tpa;
 470             memcpy(flow->arp_sha, arp->ar_sha, ETH_ADDR_LEN);
 471             memcpy(flow->arp_tha, arp->ar_tha, ETH_ADDR_LEN);
 472         }
 473     }
 474 }
 475
 476 /* For every bit of a field that is wildcarded in 'wildcards', sets the
 477  * corresponding bit in 'flow' to zero. */
 478 void
 479 flow_zero_wildcards(struct flow *flow, const struct flow_wildcards *wildcards)
 480 {
 481     uint32_t *flow_u32 = (uint32_t *) flow;
 482     const uint32_t *wc_u32 = (const uint32_t *) &wildcards->masks;
 483     size_t i;
 484
 485     for (i = 0; i < FLOW_U32S; i++) {
 486         flow_u32[i] &= wc_u32[i];
 487     }
 488 }
 489
 490 /* Initializes 'fmd' with the metadata found in 'flow'. */
 491 void
 492 flow_get_metadata(const struct flow *flow, struct flow_metadata *fmd)
 493 {
 494     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 20);
 495
 496     fmd->tun_id = flow->tunnel.tun_id;
 497     fmd->tun_src = flow->tunnel.ip_src;
 498     fmd->tun_dst = flow->tunnel.ip_dst;
 499     fmd->metadata = flow->metadata;
 500     memcpy(fmd->regs, flow->regs, sizeof fmd->regs);
 501     fmd->in_port = flow->in_port;
 502 }
 503
 504 char *
 505 flow_to_string(const struct flow *flow)
 506 {
 507     struct ds ds = DS_EMPTY_INITIALIZER;
 508     flow_format(&ds, flow);
 509     return ds_cstr(&ds);
 510 }
 511
 512 const char *
 513 flow_tun_flag_to_string(uint32_t flags)
 514 {
 515     switch (flags) {
 516     case FLOW_TNL_F_DONT_FRAGMENT:
 517         return "df";
 518     case FLOW_TNL_F_CSUM:
 519         return "csum";
 520     case FLOW_TNL_F_KEY:
 521         return "key";
 522     default:
 523         return NULL;
 524     }
 525 }
 526
 527 void
 528 format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t),
 529              uint32_t flags, char del)
 530 {
 531     uint32_t bad = 0;
 532
 533     if (!flags) {
 534         return;
 535     }
 536     while (flags) {
 537         uint32_t bit = rightmost_1bit(flags);
 538         const char *s;
 539
 540         s = bit_to_string(bit);
 541         if (s) {
 542             ds_put_format(ds, "%s%c", s, del);
 543         } else {
 544             bad |= bit;
 545         }
 546
 547         flags &= ~bit;
 548     }
 549
 550     if (bad) {
 551         ds_put_format(ds, "0x%"PRIx32"%c", bad, del);
 552     }
 553     ds_chomp(ds, del);
 554 }
 555
 556 void
 557 flow_format(struct ds *ds, const struct flow *flow)
 558 {
 559     struct match match;
 560
 561     match_wc_init(&match, flow);
 562     match_format(&match, ds, OFP_DEFAULT_PRIORITY);
 563 }
 564
 565 void
 566 flow_print(FILE *stream, const struct flow *flow)
 567 {
 568     char *s = flow_to_string(flow);
 569     fputs(s, stream);
 570     free(s);
 571 }
 572 \f
 573 /* flow_wildcards functions. */
 574
 575 /* Initializes 'wc' as a set of wildcards that matches every packet. */
 576 void
 577 flow_wildcards_init_catchall(struct flow_wildcards *wc)
 578 {
 579     memset(&wc->masks, 0, sizeof wc->masks);
 580 }
 581
 582 /* Initializes 'wc' as an exact-match set of wildcards; that is, 'wc' does not
 583  * wildcard any bits or fields. */
 584 void
 585 flow_wildcards_init_exact(struct flow_wildcards *wc)
 586 {
 587     memset(&wc->masks, 0xff, sizeof wc->masks);
 588     memset(wc->masks.zeros, 0, sizeof wc->masks.zeros);
 589 }
 590
 591 /* Returns true if 'wc' matches every packet, false if 'wc' fixes any bits or
 592  * fields. */
 593 bool
 594 flow_wildcards_is_catchall(const struct flow_wildcards *wc)
 595 {
 596     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
 597     size_t i;
 598
 599     for (i = 0; i < FLOW_U32S; i++) {
 600         if (wc_u32[i]) {
 601             return false;
 602         }
 603     }
 604     return true;
 605 }
 606
 607 /* Initializes 'dst' as the combination of wildcards in 'src1' and 'src2'.
 608  * That is, a bit or a field is wildcarded in 'dst' if it is wildcarded in
 609  * 'src1' or 'src2' or both.  */
 610 void
 611 flow_wildcards_combine(struct flow_wildcards *dst,
 612                        const struct flow_wildcards *src1,
 613                        const struct flow_wildcards *src2)
 614 {
 615     uint32_t *dst_u32 = (uint32_t *) &dst->masks;
 616     const uint32_t *src1_u32 = (const uint32_t *) &src1->masks;
 617     const uint32_t *src2_u32 = (const uint32_t *) &src2->masks;
 618     size_t i;
 619
 620     for (i = 0; i < FLOW_U32S; i++) {
 621         dst_u32[i] = src1_u32[i] & src2_u32[i];
 622     }
 623 }
 624
 625 /* Returns a hash of the wildcards in 'wc'. */
 626 uint32_t
 627 flow_wildcards_hash(const struct flow_wildcards *wc, uint32_t basis)
 628 {
 629     return flow_hash(&wc->masks, basis);
 630 }
 631
 632 /* Returns true if 'a' and 'b' represent the same wildcards, false if they are
 633  * different. */
 634 bool
 635 flow_wildcards_equal(const struct flow_wildcards *a,
 636                      const struct flow_wildcards *b)
 637 {
 638     return flow_equal(&a->masks, &b->masks);
 639 }
 640
 641 /* Returns true if at least one bit or field is wildcarded in 'a' but not in
 642  * 'b', false otherwise. */
 643 bool
 644 flow_wildcards_has_extra(const struct flow_wildcards *a,
 645                          const struct flow_wildcards *b)
 646 {
 647     const uint32_t *a_u32 = (const uint32_t *) &a->masks;
 648     const uint32_t *b_u32 = (const uint32_t *) &b->masks;
 649     size_t i;
 650
 651     for (i = 0; i < FLOW_U32S; i++) {
 652         if ((a_u32[i] & b_u32[i]) != b_u32[i]) {
 653             return true;
 654         }
 655     }
 656     return false;
 657 }
 658
 659 /* Returns true if 'a' and 'b' are equal, except that 0-bits (wildcarded bits)
 660  * in 'wc' do not need to be equal in 'a' and 'b'. */
 661 bool
 662 flow_equal_except(const struct flow *a, const struct flow *b,
 663                   const struct flow_wildcards *wc)
 664 {
 665     const uint32_t *a_u32 = (const uint32_t *) a;
 666     const uint32_t *b_u32 = (const uint32_t *) b;
 667     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
 668     size_t i;
 669
 670     for (i = 0; i < FLOW_U32S; i++) {
 671         if ((a_u32[i] ^ b_u32[i]) & wc_u32[i]) {
 672             return false;
 673         }
 674     }
 675     return true;
 676 }
 677
 678 /* Sets the wildcard mask for register 'idx' in 'wc' to 'mask'.
 679  * (A 0-bit indicates a wildcard bit.) */
 680 void
 681 flow_wildcards_set_reg_mask(struct flow_wildcards *wc, int idx, uint32_t mask)
 682 {
 683     wc->masks.regs[idx] = mask;
 684 }
 685
 686 /* Hashes 'flow' based on its L2 through L4 protocol information. */
 687 uint32_t
 688 flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis)
 689 {
 690     struct {
 691         union {
 692             ovs_be32 ipv4_addr;
 693             struct in6_addr ipv6_addr;
 694         };
 695         ovs_be16 eth_type;
 696         ovs_be16 vlan_tci;
 697         ovs_be16 tp_port;
 698         uint8_t eth_addr[ETH_ADDR_LEN];
 699         uint8_t ip_proto;
 700     } fields;
 701
 702     int i;
 703
 704     memset(&fields, 0, sizeof fields);
 705     for (i = 0; i < ETH_ADDR_LEN; i++) {
 706         fields.eth_addr[i] = flow->dl_src[i] ^ flow->dl_dst[i];
 707     }
 708     fields.vlan_tci = flow->vlan_tci & htons(VLAN_VID_MASK);
 709     fields.eth_type = flow->dl_type;
 710
 711     /* UDP source and destination port are not taken into account because they
 712      * will not necessarily be symmetric in a bidirectional flow. */
 713     if (fields.eth_type == htons(ETH_TYPE_IP)) {
 714         fields.ipv4_addr = flow->nw_src ^ flow->nw_dst;
 715         fields.ip_proto = flow->nw_proto;
 716         if (fields.ip_proto == IPPROTO_TCP) {
 717             fields.tp_port = flow->tp_src ^ flow->tp_dst;
 718         }
 719     } else if (fields.eth_type == htons(ETH_TYPE_IPV6)) {
 720         const uint8_t *a = &flow->ipv6_src.s6_addr[0];
 721         const uint8_t *b = &flow->ipv6_dst.s6_addr[0];
 722         uint8_t *ipv6_addr = &fields.ipv6_addr.s6_addr[0];
 723
 724         for (i=0; i<16; i++) {
 725             ipv6_addr[i] = a[i] ^ b[i];
 726         }
 727         fields.ip_proto = flow->nw_proto;
 728         if (fields.ip_proto == IPPROTO_TCP) {
 729             fields.tp_port = flow->tp_src ^ flow->tp_dst;
 730         }
 731     }
 732     return jhash_bytes(&fields, sizeof fields, basis);
 733 }
 734
 735 /* Hashes the portions of 'flow' designated by 'fields'. */
 736 uint32_t
 737 flow_hash_fields(const struct flow *flow, enum nx_hash_fields fields,
 738                  uint16_t basis)
 739 {
 740     switch (fields) {
 741
 742     case NX_HASH_FIELDS_ETH_SRC:
 743         return jhash_bytes(flow->dl_src, sizeof flow->dl_src, basis);
 744
 745     case NX_HASH_FIELDS_SYMMETRIC_L4:
 746         return flow_hash_symmetric_l4(flow, basis);
 747     }
 748
 749     NOT_REACHED();
 750 }
 751
 752 /* Returns a string representation of 'fields'. */
 753 const char *
 754 flow_hash_fields_to_str(enum nx_hash_fields fields)
 755 {
 756     switch (fields) {
 757     case NX_HASH_FIELDS_ETH_SRC: return "eth_src";
 758     case NX_HASH_FIELDS_SYMMETRIC_L4: return "symmetric_l4";
 759     default: return "<unknown>";
 760     }
 761 }
 762
 763 /* Returns true if the value of 'fields' is supported. Otherwise false. */
 764 bool
 765 flow_hash_fields_valid(enum nx_hash_fields fields)
 766 {
 767     return fields == NX_HASH_FIELDS_ETH_SRC
 768         || fields == NX_HASH_FIELDS_SYMMETRIC_L4;
 769 }
 770
 771 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
 772  * OpenFlow 1.0 "dl_vlan" value:
 773  *
 774  *      - If it is in the range 0...4095, 'flow->vlan_tci' is set to match
 775  *        that VLAN.  Any existing PCP match is unchanged (it becomes 0 if
 776  *        'flow' previously matched packets without a VLAN header).
 777  *
 778  *      - If it is OFP_VLAN_NONE, 'flow->vlan_tci' is set to match a packet
 779  *        without a VLAN tag.
 780  *
 781  *      - Other values of 'vid' should not be used. */
 782 void
 783 flow_set_dl_vlan(struct flow *flow, ovs_be16 vid)
 784 {
 785     if (vid == htons(OFP10_VLAN_NONE)) {
 786         flow->vlan_tci = htons(0);
 787     } else {
 788         vid &= htons(VLAN_VID_MASK);
 789         flow->vlan_tci &= ~htons(VLAN_VID_MASK);
 790         flow->vlan_tci |= htons(VLAN_CFI) | vid;
 791     }
 792 }
 793
 794 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
 795  * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
 796  * plus CFI). */
 797 void
 798 flow_set_vlan_vid(struct flow *flow, ovs_be16 vid)
 799 {
 800     ovs_be16 mask = htons(VLAN_VID_MASK | VLAN_CFI);
 801     flow->vlan_tci &= ~mask;
 802     flow->vlan_tci |= vid & mask;
 803 }
 804
 805 /* Sets the VLAN PCP that 'flow' matches to 'pcp', which should be in the
 806  * range 0...7.
 807  *
 808  * This function has no effect on the VLAN ID that 'flow' matches.
 809  *
 810  * After calling this function, 'flow' will not match packets without a VLAN
 811  * header. */
 812 void
 813 flow_set_vlan_pcp(struct flow *flow, uint8_t pcp)
 814 {
 815     pcp &= 0x07;
 816     flow->vlan_tci &= ~htons(VLAN_PCP_MASK);
 817     flow->vlan_tci |= htons((pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
 818 }
 819
 820 /* Sets the MPLS Label that 'flow' matches to 'label', which is interpreted
 821  * as an OpenFlow 1.1 "mpls_label" value. */
 822 void
 823 flow_set_mpls_label(struct flow *flow, ovs_be32 label)
 824 {
 825     set_mpls_lse_label(&flow->mpls_lse, label);
 826 }
 827
 828 /* Sets the MPLS TTL that 'flow' matches to 'ttl', which should be in the
 829  * range 0...255. */
 830 void
 831 flow_set_mpls_ttl(struct flow *flow, uint8_t ttl)
 832 {
 833     set_mpls_lse_ttl(&flow->mpls_lse, ttl);
 834 }
 835
 836 /* Sets the MPLS TC that 'flow' matches to 'tc', which should be in the
 837  * range 0...7. */
 838 void
 839 flow_set_mpls_tc(struct flow *flow, uint8_t tc)
 840 {
 841     set_mpls_lse_tc(&flow->mpls_lse, tc);
 842 }
 843
 844 /* Sets the MPLS BOS bit that 'flow' matches to which should be 0 or 1. */
 845 void
 846 flow_set_mpls_bos(struct flow *flow, uint8_t bos)
 847 {
 848     set_mpls_lse_bos(&flow->mpls_lse, bos);
 849 }
 850
 851 /* Puts into 'b' a packet that flow_extract() would parse as having the given
 852  * 'flow'.
 853  *
 854  * (This is useful only for testing, obviously, and the packet isn't really
 855  * valid. It hasn't got some checksums filled in, for one, and lots of fields
 856  * are just zeroed.) */
 857 void
 858 flow_compose(struct ofpbuf *b, const struct flow *flow)
 859 {
 860     eth_compose(b, flow->dl_dst, flow->dl_src, ntohs(flow->dl_type), 0);
 861     if (flow->dl_type == htons(FLOW_DL_TYPE_NONE)) {
 862         struct eth_header *eth = b->l2;
 863         eth->eth_type = htons(b->size);
 864         return;
 865     }
 866
 867     if (flow->vlan_tci & htons(VLAN_CFI)) {
 868         eth_push_vlan(b, flow->vlan_tci);
 869     }
 870
 871     if (flow->dl_type == htons(ETH_TYPE_IP)) {
 872         struct ip_header *ip;
 873
 874         b->l3 = ip = ofpbuf_put_zeros(b, sizeof *ip);
 875         ip->ip_ihl_ver = IP_IHL_VER(5, 4);
 876         ip->ip_tos = flow->nw_tos;
 877         ip->ip_ttl = flow->nw_ttl;
 878         ip->ip_proto = flow->nw_proto;
 879         ip->ip_src = flow->nw_src;
 880         ip->ip_dst = flow->nw_dst;
 881
 882         if (flow->nw_frag & FLOW_NW_FRAG_ANY) {
 883             ip->ip_frag_off |= htons(IP_MORE_FRAGMENTS);
 884             if (flow->nw_frag & FLOW_NW_FRAG_LATER) {
 885                 ip->ip_frag_off |= htons(100);
 886             }
 887         }
 888         if (!(flow->nw_frag & FLOW_NW_FRAG_ANY)
 889             || !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
 890             if (flow->nw_proto == IPPROTO_TCP) {
 891                 struct tcp_header *tcp;
 892
 893                 b->l4 = tcp = ofpbuf_put_zeros(b, sizeof *tcp);
 894                 tcp->tcp_src = flow->tp_src;
 895                 tcp->tcp_dst = flow->tp_dst;
 896                 tcp->tcp_ctl = TCP_CTL(0, 5);
 897             } else if (flow->nw_proto == IPPROTO_UDP) {
 898                 struct udp_header *udp;
 899
 900                 b->l4 = udp = ofpbuf_put_zeros(b, sizeof *udp);
 901                 udp->udp_src = flow->tp_src;
 902                 udp->udp_dst = flow->tp_dst;
 903             } else if (flow->nw_proto == IPPROTO_ICMP) {
 904                 struct icmp_header *icmp;
 905
 906                 b->l4 = icmp = ofpbuf_put_zeros(b, sizeof *icmp);
 907                 icmp->icmp_type = ntohs(flow->tp_src);
 908                 icmp->icmp_code = ntohs(flow->tp_dst);
 909                 icmp->icmp_csum = csum(icmp, ICMP_HEADER_LEN);
 910             }
 911         }
 912
 913         ip = b->l3;
 914         ip->ip_tot_len = htons((uint8_t *) b->data + b->size
 915                                - (uint8_t *) b->l3);
 916         ip->ip_csum = csum(ip, sizeof *ip);
 917     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
 918         /* XXX */
 919     } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
 920                flow->dl_type == htons(ETH_TYPE_RARP)) {
 921         struct arp_eth_header *arp;
 922
 923         b->l3 = arp = ofpbuf_put_zeros(b, sizeof *arp);
 924         arp->ar_hrd = htons(1);
 925         arp->ar_pro = htons(ETH_TYPE_IP);
 926         arp->ar_hln = ETH_ADDR_LEN;
 927         arp->ar_pln = 4;
 928         arp->ar_op = htons(flow->nw_proto);
 929
 930         if (flow->nw_proto == ARP_OP_REQUEST ||
 931             flow->nw_proto == ARP_OP_REPLY) {
 932             arp->ar_spa = flow->nw_src;
 933             arp->ar_tpa = flow->nw_dst;
 934             memcpy(arp->ar_sha, flow->arp_sha, ETH_ADDR_LEN);
 935             memcpy(arp->ar_tha, flow->arp_tha, ETH_ADDR_LEN);
 936         }
 937     }
 938
 939     if (eth_type_mpls(flow->dl_type)) {
 940         b->l2_5 = b->l3;
 941         push_mpls(b, flow->dl_type, flow->mpls_lse);
 942     }
 943 }
 944 \f
 945 /* Compressed flow. */
 946
 947 static int
 948 miniflow_n_values(const struct miniflow *flow)
 949 {
 950     int n, i;
 951
 952     n = 0;
 953     for (i = 0; i < MINI_N_MAPS; i++) {
 954         n += popcount(flow->map[i]);
 955     }
 956     return n;
 957 }
 958
 959 static uint32_t *
 960 miniflow_alloc_values(struct miniflow *flow, int n)
 961 {
 962     if (n <= MINI_N_INLINE) {
 963         return flow->inline_values;
 964     } else {
 965         COVERAGE_INC(miniflow_malloc);
 966         return xmalloc(n * sizeof *flow->values);
 967     }
 968 }
 969
 970 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
 971  * with miniflow_destroy(). */
 972 void
 973 miniflow_init(struct miniflow *dst, const struct flow *src)
 974 {
 975     const uint32_t *src_u32 = (const uint32_t *) src;
 976     unsigned int ofs;
 977     unsigned int i;
 978     int n;
 979
 980     /* Initialize dst->map, counting the number of nonzero elements. */
 981     n = 0;
 982     memset(dst->map, 0, sizeof dst->map);
 983     for (i = 0; i < FLOW_U32S; i++) {
 984         if (src_u32[i]) {
 985             dst->map[i / 32] |= 1u << (i % 32);
 986             n++;
 987         }
 988     }
 989
 990     /* Initialize dst->values. */
 991     dst->values = miniflow_alloc_values(dst, n);
 992     ofs = 0;
 993     for (i = 0; i < MINI_N_MAPS; i++) {
 994         uint32_t map;
 995
 996         for (map = dst->map[i]; map; map = zero_rightmost_1bit(map)) {
 997             dst->values[ofs++] = src_u32[raw_ctz(map) + i * 32];
 998         }
 999     }
1000 }
1001
1002 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1003  * with miniflow_destroy(). */
1004 void
1005 miniflow_clone(struct miniflow *dst, const struct miniflow *src)
1006 {
1007     int n = miniflow_n_values(src);
1008     memcpy(dst->map, src->map, sizeof dst->map);
1009     dst->values = miniflow_alloc_values(dst, n);
1010     memcpy(dst->values, src->values, n * sizeof *dst->values);
1011 }
1012
1013 /* Frees any memory owned by 'flow'.  Does not free the storage in which 'flow'
1014  * itself resides; the caller is responsible for that. */
1015 void
1016 miniflow_destroy(struct miniflow *flow)
1017 {
1018     if (flow->values != flow->inline_values) {
1019         free(flow->values);
1020     }
1021 }
1022
1023 /* Initializes 'dst' as a copy of 'src'. */
1024 void
1025 miniflow_expand(const struct miniflow *src, struct flow *dst)
1026 {
1027     uint32_t *dst_u32 = (uint32_t *) dst;
1028     int ofs;
1029     int i;
1030
1031     memset(dst_u32, 0, sizeof *dst);
1032
1033     ofs = 0;
1034     for (i = 0; i < MINI_N_MAPS; i++) {
1035         uint32_t map;
1036
1037         for (map = src->map[i]; map; map = zero_rightmost_1bit(map)) {
1038             dst_u32[raw_ctz(map) + i * 32] = src->values[ofs++];
1039         }
1040     }
1041 }
1042
1043 static const uint32_t *
1044 miniflow_get__(const struct miniflow *flow, unsigned int u32_ofs)
1045 {
1046     if (!(flow->map[u32_ofs / 32] & (1u << (u32_ofs % 32)))) {
1047         static const uint32_t zero = 0;
1048         return &zero;
1049     } else {
1050         const uint32_t *p = flow->values;
1051
1052         BUILD_ASSERT(MINI_N_MAPS == 2);
1053         if (u32_ofs < 32) {
1054             p += popcount(flow->map[0] & ((1u << u32_ofs) - 1));
1055         } else {
1056             p += popcount(flow->map[0]);
1057             p += popcount(flow->map[1] & ((1u << (u32_ofs - 32)) - 1));
1058         }
1059         return p;
1060     }
1061 }
1062
1063 /* Returns the uint32_t that would be at byte offset '4 * u32_ofs' if 'flow'
1064  * were expanded into a "struct flow". */
1065 uint32_t
1066 miniflow_get(const struct miniflow *flow, unsigned int u32_ofs)
1067 {
1068     return *miniflow_get__(flow, u32_ofs);
1069 }
1070
1071 /* Returns the ovs_be16 that would be at byte offset 'u8_ofs' if 'flow' were
1072  * expanded into a "struct flow". */
1073 static ovs_be16
1074 miniflow_get_be16(const struct miniflow *flow, unsigned int u8_ofs)
1075 {
1076     const uint32_t *u32p = miniflow_get__(flow, u8_ofs / 4);
1077     const ovs_be16 *be16p = (const ovs_be16 *) u32p;
1078     return be16p[u8_ofs % 4 != 0];
1079 }
1080
1081 /* Returns the VID within the vlan_tci member of the "struct flow" represented
1082  * by 'flow'. */
1083 uint16_t
1084 miniflow_get_vid(const struct miniflow *flow)
1085 {
1086     ovs_be16 tci = miniflow_get_be16(flow, offsetof(struct flow, vlan_tci));
1087     return vlan_tci_to_vid(tci);
1088 }
1089
1090 /* Returns true if 'a' and 'b' are the same flow, false otherwise.  */
1091 bool
1092 miniflow_equal(const struct miniflow *a, const struct miniflow *b)
1093 {
1094     int i;
1095
1096     for (i = 0; i < MINI_N_MAPS; i++) {
1097         if (a->map[i] != b->map[i]) {
1098             return false;
1099         }
1100     }
1101
1102     return !memcmp(a->values, b->values,
1103                    miniflow_n_values(a) * sizeof *a->values);
1104 }
1105
1106 /* Returns true if 'a' and 'b' are equal at the places where there are 1-bits
1107  * in 'mask', false if they differ. */
1108 bool
1109 miniflow_equal_in_minimask(const struct miniflow *a, const struct miniflow *b,
1110                            const struct minimask *mask)
1111 {
1112     const uint32_t *p;
1113     int i;
1114
1115     p = mask->masks.values;
1116     for (i = 0; i < MINI_N_MAPS; i++) {
1117         uint32_t map;
1118
1119         for (map = mask->masks.map[i]; map; map = zero_rightmost_1bit(map)) {
1120             int ofs = raw_ctz(map) + i * 32;
1121
1122             if ((miniflow_get(a, ofs) ^ miniflow_get(b, ofs)) & *p) {
1123                 return false;
1124             }
1125             p++;
1126         }
1127     }
1128
1129     return true;
1130 }
1131
1132 /* Returns true if 'a' and 'b' are equal at the places where there are 1-bits
1133  * in 'mask', false if they differ. */
1134 bool
1135 miniflow_equal_flow_in_minimask(const struct miniflow *a, const struct flow *b,
1136                                 const struct minimask *mask)
1137 {
1138     const uint32_t *b_u32 = (const uint32_t *) b;
1139     const uint32_t *p;
1140     int i;
1141
1142     p = mask->masks.values;
1143     for (i = 0; i < MINI_N_MAPS; i++) {
1144         uint32_t map;
1145
1146         for (map = mask->masks.map[i]; map; map = zero_rightmost_1bit(map)) {
1147             int ofs = raw_ctz(map) + i * 32;
1148
1149             if ((miniflow_get(a, ofs) ^ b_u32[ofs]) & *p) {
1150                 return false;
1151             }
1152             p++;
1153         }
1154     }
1155
1156     return true;
1157 }
1158
1159 /* Returns a hash value for 'flow', given 'basis'. */
1160 uint32_t
1161 miniflow_hash(const struct miniflow *flow, uint32_t basis)
1162 {
1163     BUILD_ASSERT_DECL(MINI_N_MAPS == 2);
1164     return hash_3words(flow->map[0], flow->map[1],
1165                        hash_words(flow->values, miniflow_n_values(flow),
1166                                   basis));
1167 }
1168
1169 /* Returns a hash value for the bits of 'flow' where there are 1-bits in
1170  * 'mask', given 'basis'.
1171  *
1172  * The hash values returned by this function are the same as those returned by
1173  * flow_hash_in_minimask(), only the form of the arguments differ. */
1174 uint32_t
1175 miniflow_hash_in_minimask(const struct miniflow *flow,
1176                           const struct minimask *mask, uint32_t basis)
1177 {
1178     const uint32_t *p = mask->masks.values;
1179     uint32_t hash;
1180     int i;
1181
1182     hash = basis;
1183     for (i = 0; i < MINI_N_MAPS; i++) {
1184         uint32_t map;
1185
1186         for (map = mask->masks.map[i]; map; map = zero_rightmost_1bit(map)) {
1187             int ofs = raw_ctz(map) + i * 32;
1188
1189             hash = mhash_add(hash, miniflow_get(flow, ofs) & *p);
1190             p++;
1191         }
1192     }
1193
1194     return mhash_finish(hash, (p - mask->masks.values) * 4);
1195 }
1196
1197 /* Returns a hash value for the bits of 'flow' where there are 1-bits in
1198  * 'mask', given 'basis'.
1199  *
1200  * The hash values returned by this function are the same as those returned by
1201  * miniflow_hash_in_minimask(), only the form of the arguments differ. */
1202 uint32_t
1203 flow_hash_in_minimask(const struct flow *flow, const struct minimask *mask,
1204                       uint32_t basis)
1205 {
1206     const uint32_t *flow_u32 = (const uint32_t *) flow;
1207     const uint32_t *p = mask->masks.values;
1208     uint32_t hash;
1209     int i;
1210
1211     hash = basis;
1212     for (i = 0; i < MINI_N_MAPS; i++) {
1213         uint32_t map;
1214
1215         for (map = mask->masks.map[i]; map; map = zero_rightmost_1bit(map)) {
1216             int ofs = raw_ctz(map) + i * 32;
1217
1218             hash = mhash_add(hash, flow_u32[ofs] & *p);
1219             p++;
1220         }
1221     }
1222
1223     return mhash_finish(hash, (p - mask->masks.values) * 4);
1224 }
1225 \f
1226 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1227  * with minimask_destroy(). */
1228 void
1229 minimask_init(struct minimask *mask, const struct flow_wildcards *wc)
1230 {
1231     miniflow_init(&mask->masks, &wc->masks);
1232 }
1233
1234 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1235  * with minimask_destroy(). */
1236 void
1237 minimask_clone(struct minimask *dst, const struct minimask *src)
1238 {
1239     miniflow_clone(&dst->masks, &src->masks);
1240 }
1241
1242 /* Initializes 'dst_' as the bit-wise "and" of 'a_' and 'b_'.
1243  *
1244  * The caller must provide room for FLOW_U32S "uint32_t"s in 'storage', for use
1245  * by 'dst_'.  The caller must *not* free 'dst_' with minimask_destroy(). */
1246 void
1247 minimask_combine(struct minimask *dst_,
1248                  const struct minimask *a_, const struct minimask *b_,
1249                  uint32_t storage[FLOW_U32S])
1250 {
1251     struct miniflow *dst = &dst_->masks;
1252     const struct miniflow *a = &a_->masks;
1253     const struct miniflow *b = &b_->masks;
1254     int i, n;
1255
1256     n = 0;
1257     dst->values = storage;
1258     for (i = 0; i < MINI_N_MAPS; i++) {
1259         uint32_t map;
1260
1261         dst->map[i] = 0;
1262         for (map = a->map[i] & b->map[i]; map;
1263              map = zero_rightmost_1bit(map)) {
1264             int ofs = raw_ctz(map) + i * 32;
1265             uint32_t mask = miniflow_get(a, ofs) & miniflow_get(b, ofs);
1266
1267             if (mask) {
1268                 dst->map[i] |= rightmost_1bit(map);
1269                 dst->values[n++] = mask;
1270             }
1271         }
1272     }
1273 }
1274
1275 /* Frees any memory owned by 'mask'.  Does not free the storage in which 'mask'
1276  * itself resides; the caller is responsible for that. */
1277 void
1278 minimask_destroy(struct minimask *mask)
1279 {
1280     miniflow_destroy(&mask->masks);
1281 }
1282
1283 /* Initializes 'dst' as a copy of 'src'. */
1284 void
1285 minimask_expand(const struct minimask *mask, struct flow_wildcards *wc)
1286 {
1287     miniflow_expand(&mask->masks, &wc->masks);
1288 }
1289
1290 /* Returns the uint32_t that would be at byte offset '4 * u32_ofs' if 'mask'
1291  * were expanded into a "struct flow_wildcards". */
1292 uint32_t
1293 minimask_get(const struct minimask *mask, unsigned int u32_ofs)
1294 {
1295     return miniflow_get(&mask->masks, u32_ofs);
1296 }
1297
1298 /* Returns the VID mask within the vlan_tci member of the "struct
1299  * flow_wildcards" represented by 'mask'. */
1300 uint16_t
1301 minimask_get_vid_mask(const struct minimask *mask)
1302 {
1303     return miniflow_get_vid(&mask->masks);
1304 }
1305
1306 /* Returns true if 'a' and 'b' are the same flow mask, false otherwise.  */
1307 bool
1308 minimask_equal(const struct minimask *a, const struct minimask *b)
1309 {
1310     return miniflow_equal(&a->masks, &b->masks);
1311 }
1312
1313 /* Returns a hash value for 'mask', given 'basis'. */
1314 uint32_t
1315 minimask_hash(const struct minimask *mask, uint32_t basis)
1316 {
1317     return miniflow_hash(&mask->masks, basis);
1318 }
1319
1320 /* Returns true if at least one bit is wildcarded in 'a_' but not in 'b_',
1321  * false otherwise. */
1322 bool
1323 minimask_has_extra(const struct minimask *a_, const struct minimask *b_)
1324 {
1325     const struct miniflow *a = &a_->masks;
1326     const struct miniflow *b = &b_->masks;
1327     int i;
1328
1329     for (i = 0; i < MINI_N_MAPS; i++) {
1330         uint32_t map;
1331
1332         for (map = a->map[i] | b->map[i]; map;
1333              map = zero_rightmost_1bit(map)) {
1334             int ofs = raw_ctz(map) + i * 32;
1335             uint32_t a_u32 = miniflow_get(a, ofs);
1336             uint32_t b_u32 = miniflow_get(b, ofs);
1337
1338             if ((a_u32 & b_u32) != b_u32) {
1339                 return true;
1340             }
1341         }
1342     }
1343
1344     return false;
1345 }
1346
1347 /* Returns true if 'mask' matches every packet, false if 'mask' fixes any bits
1348  * or fields. */
1349 bool
1350 minimask_is_catchall(const struct minimask *mask_)
1351 {
1352     const struct miniflow *mask = &mask_->masks;
1353
1354     BUILD_ASSERT(MINI_N_MAPS == 2);
1355     return !(mask->map[0] | mask->map[1]);
1356 }