lib/flow.c

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