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