lib/flow.c

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