lib/flow.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 #include <config.h>
  17 #include <sys/types.h>
  18 #include "flow.h"
  19 #include <errno.h>
  20 #include <inttypes.h>
  21 #include <limits.h>
  22 #include <netinet/in.h>
  23 #include <netinet/icmp6.h>
  24 #include <netinet/ip6.h>
  25 #include <stdint.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include "byte-order.h"
  29 #include "coverage.h"
  30 #include "csum.h"
  31 #include "dynamic-string.h"
  32 #include "hash.h"
  33 #include "jhash.h"
  34 #include "match.h"
  35 #include "ofpbuf.h"
  36 #include "openflow/openflow.h"
  37 #include "packets.h"
  38 #include "odp-util.h"
  39 #include "random.h"
  40 #include "unaligned.h"
  41
  42 COVERAGE_DEFINE(flow_extract);
  43 COVERAGE_DEFINE(miniflow_malloc);
  44
  45 /* U32 indices for segmented flow classification. */
  46 const uint8_t flow_segment_u32s[4] = {
  47     FLOW_SEGMENT_1_ENDS_AT / 4,
  48     FLOW_SEGMENT_2_ENDS_AT / 4,
  49     FLOW_SEGMENT_3_ENDS_AT / 4,
  50     FLOW_U32S
  51 };
  52
  53 static struct arp_eth_header *
  54 pull_arp(struct ofpbuf *packet)
  55 {
  56     return ofpbuf_try_pull(packet, ARP_ETH_HEADER_LEN);
  57 }
  58
  59 static struct ip_header *
  60 pull_ip(struct ofpbuf *packet)
  61 {
  62     if (ofpbuf_size(packet) >= IP_HEADER_LEN) {
  63         struct ip_header *ip = ofpbuf_data(packet);
  64         int ip_len = IP_IHL(ip->ip_ihl_ver) * 4;
  65         if (ip_len >= IP_HEADER_LEN && ofpbuf_size(packet) >= ip_len) {
  66             return ofpbuf_pull(packet, ip_len);
  67         }
  68     }
  69     return NULL;
  70 }
  71
  72 static struct icmp_header *
  73 pull_icmp(struct ofpbuf *packet)
  74 {
  75     return ofpbuf_try_pull(packet, ICMP_HEADER_LEN);
  76 }
  77
  78 static struct icmp6_hdr *
  79 pull_icmpv6(struct ofpbuf *packet)
  80 {
  81     return ofpbuf_try_pull(packet, sizeof(struct icmp6_hdr));
  82 }
  83
  84 static void
  85 parse_mpls(struct ofpbuf *b, struct flow *flow)
  86 {
  87     struct mpls_hdr *mh;
  88     int idx = 0;
  89
  90     while ((mh = ofpbuf_try_pull(b, sizeof *mh))) {
  91         if (idx < FLOW_MAX_MPLS_LABELS) {
  92             flow->mpls_lse[idx++] = mh->mpls_lse;
  93         }
  94         if (mh->mpls_lse & htonl(MPLS_BOS_MASK)) {
  95             break;
  96         }
  97     }
  98 }
  99
 100 static void
 101 parse_vlan(struct ofpbuf *b, struct flow *flow)
 102 {
 103     struct qtag_prefix {
 104         ovs_be16 eth_type;      /* ETH_TYPE_VLAN */
 105         ovs_be16 tci;
 106     };
 107
 108     if (ofpbuf_size(b) >= sizeof(struct qtag_prefix) + sizeof(ovs_be16)) {
 109         struct qtag_prefix *qp = ofpbuf_pull(b, sizeof *qp);
 110         flow->vlan_tci = qp->tci | htons(VLAN_CFI);
 111     }
 112 }
 113
 114 static ovs_be16
 115 parse_ethertype(struct ofpbuf *b)
 116 {
 117     struct llc_snap_header *llc;
 118     ovs_be16 proto;
 119
 120     proto = *(ovs_be16 *) ofpbuf_pull(b, sizeof proto);
 121     if (ntohs(proto) >= ETH_TYPE_MIN) {
 122         return proto;
 123     }
 124
 125     if (ofpbuf_size(b) < sizeof *llc) {
 126         return htons(FLOW_DL_TYPE_NONE);
 127     }
 128
 129     llc = ofpbuf_data(b);
 130     if (llc->llc.llc_dsap != LLC_DSAP_SNAP
 131         || llc->llc.llc_ssap != LLC_SSAP_SNAP
 132         || llc->llc.llc_cntl != LLC_CNTL_SNAP
 133         || memcmp(llc->snap.snap_org, SNAP_ORG_ETHERNET,
 134                   sizeof llc->snap.snap_org)) {
 135         return htons(FLOW_DL_TYPE_NONE);
 136     }
 137
 138     ofpbuf_pull(b, sizeof *llc);
 139
 140     if (ntohs(llc->snap.snap_type) >= ETH_TYPE_MIN) {
 141         return llc->snap.snap_type;
 142     }
 143
 144     return htons(FLOW_DL_TYPE_NONE);
 145 }
 146
 147 static int
 148 parse_ipv6(struct ofpbuf *packet, struct flow *flow)
 149 {
 150     const struct ovs_16aligned_ip6_hdr *nh;
 151     ovs_be32 tc_flow;
 152     int nexthdr;
 153
 154     nh = ofpbuf_try_pull(packet, sizeof *nh);
 155     if (!nh) {
 156         return EINVAL;
 157     }
 158
 159     nexthdr = nh->ip6_nxt;
 160
 161     memcpy(&flow->ipv6_src, &nh->ip6_src, sizeof flow->ipv6_src);
 162     memcpy(&flow->ipv6_dst, &nh->ip6_dst, sizeof flow->ipv6_dst);
 163
 164     tc_flow = get_16aligned_be32(&nh->ip6_flow);
 165     flow->nw_tos = ntohl(tc_flow) >> 20;
 166     flow->ipv6_label = tc_flow & htonl(IPV6_LABEL_MASK);
 167     flow->nw_ttl = nh->ip6_hlim;
 168     flow->nw_proto = IPPROTO_NONE;
 169
 170     while (1) {
 171         if ((nexthdr != IPPROTO_HOPOPTS)
 172                 && (nexthdr != IPPROTO_ROUTING)
 173                 && (nexthdr != IPPROTO_DSTOPTS)
 174                 && (nexthdr != IPPROTO_AH)
 175                 && (nexthdr != IPPROTO_FRAGMENT)) {
 176             /* It's either a terminal header (e.g., TCP, UDP) or one we
 177              * don't understand.  In either case, we're done with the
 178              * packet, so use it to fill in 'nw_proto'. */
 179             break;
 180         }
 181
 182         /* We only verify that at least 8 bytes of the next header are
 183          * available, but many of these headers are longer.  Ensure that
 184          * accesses within the extension header are within those first 8
 185          * bytes. All extension headers are required to be at least 8
 186          * bytes. */
 187         if (ofpbuf_size(packet) < 8) {
 188             return EINVAL;
 189         }
 190
 191         if ((nexthdr == IPPROTO_HOPOPTS)
 192                 || (nexthdr == IPPROTO_ROUTING)
 193                 || (nexthdr == IPPROTO_DSTOPTS)) {
 194             /* These headers, while different, have the fields we care about
 195              * in the same location and with the same interpretation. */
 196             const struct ip6_ext *ext_hdr = ofpbuf_data(packet);
 197             nexthdr = ext_hdr->ip6e_nxt;
 198             if (!ofpbuf_try_pull(packet, (ext_hdr->ip6e_len + 1) * 8)) {
 199                 return EINVAL;
 200             }
 201         } else if (nexthdr == IPPROTO_AH) {
 202             /* A standard AH definition isn't available, but the fields
 203              * we care about are in the same location as the generic
 204              * option header--only the header length is calculated
 205              * differently. */
 206             const struct ip6_ext *ext_hdr = ofpbuf_data(packet);
 207             nexthdr = ext_hdr->ip6e_nxt;
 208             if (!ofpbuf_try_pull(packet, (ext_hdr->ip6e_len + 2) * 4)) {
 209                return EINVAL;
 210             }
 211         } else if (nexthdr == IPPROTO_FRAGMENT) {
 212             const struct ovs_16aligned_ip6_frag *frag_hdr = ofpbuf_data(packet);
 213
 214             nexthdr = frag_hdr->ip6f_nxt;
 215             if (!ofpbuf_try_pull(packet, sizeof *frag_hdr)) {
 216                 return EINVAL;
 217             }
 218
 219             /* We only process the first fragment. */
 220             if (frag_hdr->ip6f_offlg != htons(0)) {
 221                 flow->nw_frag = FLOW_NW_FRAG_ANY;
 222                 if ((frag_hdr->ip6f_offlg & IP6F_OFF_MASK) != htons(0)) {
 223                     flow->nw_frag |= FLOW_NW_FRAG_LATER;
 224                     nexthdr = IPPROTO_FRAGMENT;
 225                     break;
 226                 }
 227             }
 228         }
 229     }
 230
 231     flow->nw_proto = nexthdr;
 232     return 0;
 233 }
 234
 235 static void
 236 parse_tcp(struct ofpbuf *b, struct flow *flow)
 237 {
 238     if (ofpbuf_size(b) >= TCP_HEADER_LEN) {
 239         const struct tcp_header *tcp = ofpbuf_data(b);
 240
 241         flow->tp_src = tcp->tcp_src;
 242         flow->tp_dst = tcp->tcp_dst;
 243         flow->tcp_flags = tcp->tcp_ctl & htons(0x0fff);
 244     }
 245 }
 246
 247 static void
 248 parse_udp(struct ofpbuf *b, struct flow *flow)
 249 {
 250     if (ofpbuf_size(b) >= UDP_HEADER_LEN) {
 251         const struct udp_header *udp = ofpbuf_data(b);
 252
 253         flow->tp_src = udp->udp_src;
 254         flow->tp_dst = udp->udp_dst;
 255     }
 256 }
 257
 258 static void
 259 parse_sctp(struct ofpbuf *b, struct flow *flow)
 260 {
 261     if (ofpbuf_size(b) >= SCTP_HEADER_LEN) {
 262         const struct sctp_header *sctp = ofpbuf_data(b);
 263
 264         flow->tp_src = sctp->sctp_src;
 265         flow->tp_dst = sctp->sctp_dst;
 266     }
 267 }
 268
 269 static void
 270 parse_icmpv6(struct ofpbuf *b, struct flow *flow)
 271 {
 272     const struct icmp6_hdr *icmp = pull_icmpv6(b);
 273
 274     if (!icmp) {
 275         return;
 276     }
 277
 278     /* The ICMPv6 type and code fields use the 16-bit transport port
 279      * fields, so we need to store them in 16-bit network byte order. */
 280     flow->tp_src = htons(icmp->icmp6_type);
 281     flow->tp_dst = htons(icmp->icmp6_code);
 282
 283     if (icmp->icmp6_code == 0 &&
 284         (icmp->icmp6_type == ND_NEIGHBOR_SOLICIT ||
 285          icmp->icmp6_type == ND_NEIGHBOR_ADVERT)) {
 286         const struct in6_addr *nd_target;
 287
 288         nd_target = ofpbuf_try_pull(b, sizeof *nd_target);
 289         if (!nd_target) {
 290             return;
 291         }
 292         flow->nd_target = *nd_target;
 293
 294         while (ofpbuf_size(b) >= 8) {
 295             /* The minimum size of an option is 8 bytes, which also is
 296              * the size of Ethernet link-layer options. */
 297             const struct nd_opt_hdr *nd_opt = ofpbuf_data(b);
 298             int opt_len = nd_opt->nd_opt_len * 8;
 299
 300             if (!opt_len || opt_len > ofpbuf_size(b)) {
 301                 goto invalid;
 302             }
 303
 304             /* Store the link layer address if the appropriate option is
 305              * provided.  It is considered an error if the same link
 306              * layer option is specified twice. */
 307             if (nd_opt->nd_opt_type == ND_OPT_SOURCE_LINKADDR
 308                     && opt_len == 8) {
 309                 if (eth_addr_is_zero(flow->arp_sha)) {
 310                     memcpy(flow->arp_sha, nd_opt + 1, ETH_ADDR_LEN);
 311                 } else {
 312                     goto invalid;
 313                 }
 314             } else if (nd_opt->nd_opt_type == ND_OPT_TARGET_LINKADDR
 315                     && opt_len == 8) {
 316                 if (eth_addr_is_zero(flow->arp_tha)) {
 317                     memcpy(flow->arp_tha, nd_opt + 1, ETH_ADDR_LEN);
 318                 } else {
 319                     goto invalid;
 320                 }
 321             }
 322
 323             if (!ofpbuf_try_pull(b, opt_len)) {
 324                 goto invalid;
 325             }
 326         }
 327     }
 328
 329     return;
 330
 331 invalid:
 332     memset(&flow->nd_target, 0, sizeof(flow->nd_target));
 333     memset(flow->arp_sha, 0, sizeof(flow->arp_sha));
 334     memset(flow->arp_tha, 0, sizeof(flow->arp_tha));
 335
 336     return;
 337 }
 338
 339 /* Initializes 'flow' members from 'packet' and 'md'
 340  *
 341  * Initializes 'packet' header l2 pointer to the start of the Ethernet
 342  * header, and the layer offsets as follows:
 343  *
 344  *    - packet->l2_5_ofs to the start of the MPLS shim header, or UINT16_MAX
 345  *      when there is no MPLS shim header.
 346  *
 347  *    - packet->l3_ofs to just past the Ethernet header, or just past the
 348  *      vlan_header if one is present, to the first byte of the payload of the
 349  *      Ethernet frame.  UINT16_MAX if the frame is too short to contain an
 350  *      Ethernet header.
 351  *
 352  *    - packet->l4_ofs to just past the IPv4 header, if one is present and
 353  *      has at least the content used for the fields of interest for the flow,
 354  *      otherwise UINT16_MAX.
 355  */
 356 void
 357 flow_extract(struct ofpbuf *packet, const struct pkt_metadata *md,
 358              struct flow *flow)
 359 {
 360     struct ofpbuf b = *packet;
 361     struct eth_header *eth;
 362
 363     COVERAGE_INC(flow_extract);
 364
 365     memset(flow, 0, sizeof *flow);
 366
 367     if (md) {
 368         flow->tunnel = md->tunnel;
 369         flow->in_port = md->in_port;
 370         flow->skb_priority = md->skb_priority;
 371         flow->pkt_mark = md->pkt_mark;
 372     }
 373
 374     ofpbuf_set_frame(packet, ofpbuf_data(packet));
 375
 376     if (ofpbuf_size(&b) < sizeof *eth) {
 377         return;
 378     }
 379
 380     /* Link layer. */
 381     eth = ofpbuf_data(&b);
 382     memcpy(flow->dl_src, eth->eth_src, ETH_ADDR_LEN);
 383     memcpy(flow->dl_dst, eth->eth_dst, ETH_ADDR_LEN);
 384
 385     /* dl_type, vlan_tci. */
 386     ofpbuf_pull(&b, ETH_ADDR_LEN * 2);
 387     if (eth->eth_type == htons(ETH_TYPE_VLAN)) {
 388         parse_vlan(&b, flow);
 389     }
 390     flow->dl_type = parse_ethertype(&b);
 391
 392     /* Parse mpls, copy l3 ttl. */
 393     if (eth_type_mpls(flow->dl_type)) {
 394         ofpbuf_set_l2_5(packet, ofpbuf_data(&b));
 395         parse_mpls(&b, flow);
 396     }
 397
 398     /* Network layer. */
 399     ofpbuf_set_l3(packet, ofpbuf_data(&b));
 400     if (flow->dl_type == htons(ETH_TYPE_IP)) {
 401         const struct ip_header *nh = pull_ip(&b);
 402         if (nh) {
 403             ofpbuf_set_l4(packet, ofpbuf_data(&b));
 404
 405             flow->nw_src = get_16aligned_be32(&nh->ip_src);
 406             flow->nw_dst = get_16aligned_be32(&nh->ip_dst);
 407             flow->nw_proto = nh->ip_proto;
 408
 409             flow->nw_tos = nh->ip_tos;
 410             if (IP_IS_FRAGMENT(nh->ip_frag_off)) {
 411                 flow->nw_frag = FLOW_NW_FRAG_ANY;
 412                 if (nh->ip_frag_off & htons(IP_FRAG_OFF_MASK)) {
 413                     flow->nw_frag |= FLOW_NW_FRAG_LATER;
 414                 }
 415             }
 416             flow->nw_ttl = nh->ip_ttl;
 417
 418             if (!(nh->ip_frag_off & htons(IP_FRAG_OFF_MASK))) {
 419                 if (flow->nw_proto == IPPROTO_TCP) {
 420                     parse_tcp(&b, flow);
 421                 } else if (flow->nw_proto == IPPROTO_UDP) {
 422                     parse_udp(&b, flow);
 423                 } else if (flow->nw_proto == IPPROTO_SCTP) {
 424                     parse_sctp(&b, flow);
 425                 } else if (flow->nw_proto == IPPROTO_ICMP) {
 426                     const struct icmp_header *icmp = pull_icmp(&b);
 427                     if (icmp) {
 428                         flow->tp_src = htons(icmp->icmp_type);
 429                         flow->tp_dst = htons(icmp->icmp_code);
 430                     }
 431                 }
 432             }
 433         }
 434     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
 435         if (parse_ipv6(&b, flow)) {
 436             return;
 437         }
 438
 439         ofpbuf_set_l4(packet, ofpbuf_data(&b));
 440         if (flow->nw_proto == IPPROTO_TCP) {
 441             parse_tcp(&b, flow);
 442         } else if (flow->nw_proto == IPPROTO_UDP) {
 443             parse_udp(&b, flow);
 444         } else if (flow->nw_proto == IPPROTO_SCTP) {
 445             parse_sctp(&b, flow);
 446         } else if (flow->nw_proto == IPPROTO_ICMPV6) {
 447             parse_icmpv6(&b, flow);
 448         }
 449     } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
 450                flow->dl_type == htons(ETH_TYPE_RARP)) {
 451         const struct arp_eth_header *arp = pull_arp(&b);
 452         if (arp && arp->ar_hrd == htons(1)
 453             && arp->ar_pro == htons(ETH_TYPE_IP)
 454             && arp->ar_hln == ETH_ADDR_LEN
 455             && arp->ar_pln == 4) {
 456             /* We only match on the lower 8 bits of the opcode. */
 457             if (ntohs(arp->ar_op) <= 0xff) {
 458                 flow->nw_proto = ntohs(arp->ar_op);
 459             }
 460
 461             flow->nw_src = get_16aligned_be32(&arp->ar_spa);
 462             flow->nw_dst = get_16aligned_be32(&arp->ar_tpa);
 463             memcpy(flow->arp_sha, arp->ar_sha, ETH_ADDR_LEN);
 464             memcpy(flow->arp_tha, arp->ar_tha, ETH_ADDR_LEN);
 465         }
 466     }
 467 }
 468
 469 /* For every bit of a field that is wildcarded in 'wildcards', sets the
 470  * corresponding bit in 'flow' to zero. */
 471 void
 472 flow_zero_wildcards(struct flow *flow, const struct flow_wildcards *wildcards)
 473 {
 474     uint32_t *flow_u32 = (uint32_t *) flow;
 475     const uint32_t *wc_u32 = (const uint32_t *) &wildcards->masks;
 476     size_t i;
 477
 478     for (i = 0; i < FLOW_U32S; i++) {
 479         flow_u32[i] &= wc_u32[i];
 480     }
 481 }
 482
 483 void
 484 flow_unwildcard_tp_ports(const struct flow *flow, struct flow_wildcards *wc)
 485 {
 486     if (flow->nw_proto != IPPROTO_ICMP) {
 487         memset(&wc->masks.tp_src, 0xff, sizeof wc->masks.tp_src);
 488         memset(&wc->masks.tp_dst, 0xff, sizeof wc->masks.tp_dst);
 489     } else {
 490         wc->masks.tp_src = htons(0xff);
 491         wc->masks.tp_dst = htons(0xff);
 492     }
 493 }
 494
 495 /* Initializes 'fmd' with the metadata found in 'flow'. */
 496 void
 497 flow_get_metadata(const struct flow *flow, struct flow_metadata *fmd)
 498 {
 499     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 25);
 500
 501     fmd->dp_hash = flow->dp_hash;
 502     fmd->recirc_id = flow->recirc_id;
 503     fmd->tun_id = flow->tunnel.tun_id;
 504     fmd->tun_src = flow->tunnel.ip_src;
 505     fmd->tun_dst = flow->tunnel.ip_dst;
 506     fmd->metadata = flow->metadata;
 507     memcpy(fmd->regs, flow->regs, sizeof fmd->regs);
 508     fmd->pkt_mark = flow->pkt_mark;
 509     fmd->in_port = flow->in_port.ofp_port;
 510 }
 511
 512 char *
 513 flow_to_string(const struct flow *flow)
 514 {
 515     struct ds ds = DS_EMPTY_INITIALIZER;
 516     flow_format(&ds, flow);
 517     return ds_cstr(&ds);
 518 }
 519
 520 const char *
 521 flow_tun_flag_to_string(uint32_t flags)
 522 {
 523     switch (flags) {
 524     case FLOW_TNL_F_DONT_FRAGMENT:
 525         return "df";
 526     case FLOW_TNL_F_CSUM:
 527         return "csum";
 528     case FLOW_TNL_F_KEY:
 529         return "key";
 530     default:
 531         return NULL;
 532     }
 533 }
 534
 535 void
 536 format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t),
 537              uint32_t flags, char del)
 538 {
 539     uint32_t bad = 0;
 540
 541     if (!flags) {
 542         return;
 543     }
 544     while (flags) {
 545         uint32_t bit = rightmost_1bit(flags);
 546         const char *s;
 547
 548         s = bit_to_string(bit);
 549         if (s) {
 550             ds_put_format(ds, "%s%c", s, del);
 551         } else {
 552             bad |= bit;
 553         }
 554
 555         flags &= ~bit;
 556     }
 557
 558     if (bad) {
 559         ds_put_format(ds, "0x%"PRIx32"%c", bad, del);
 560     }
 561     ds_chomp(ds, del);
 562 }
 563
 564 void
 565 format_flags_masked(struct ds *ds, const char *name,
 566                     const char *(*bit_to_string)(uint32_t), uint32_t flags,
 567                     uint32_t mask)
 568 {
 569     if (name) {
 570         ds_put_format(ds, "%s=", name);
 571     }
 572     while (mask) {
 573         uint32_t bit = rightmost_1bit(mask);
 574         const char *s = bit_to_string(bit);
 575
 576         ds_put_format(ds, "%s%s", (flags & bit) ? "+" : "-",
 577                       s ? s : "[Unknown]");
 578         mask &= ~bit;
 579     }
 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 /* Clear the metadata and register wildcard masks. They are not packet
 609  * header fields. */
 610 void
 611 flow_wildcards_clear_non_packet_fields(struct flow_wildcards *wc)
 612 {
 613     memset(&wc->masks.metadata, 0, sizeof wc->masks.metadata);
 614     memset(&wc->masks.regs, 0, sizeof wc->masks.regs);
 615 }
 616
 617 /* Returns true if 'wc' matches every packet, false if 'wc' fixes any bits or
 618  * fields. */
 619 bool
 620 flow_wildcards_is_catchall(const struct flow_wildcards *wc)
 621 {
 622     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
 623     size_t i;
 624
 625     for (i = 0; i < FLOW_U32S; i++) {
 626         if (wc_u32[i]) {
 627             return false;
 628         }
 629     }
 630     return true;
 631 }
 632
 633 /* Sets 'dst' as the bitwise AND of wildcards in 'src1' and 'src2'.
 634  * That is, a bit or a field is wildcarded in 'dst' if it is wildcarded
 635  * in 'src1' or 'src2' or both.  */
 636 void
 637 flow_wildcards_and(struct flow_wildcards *dst,
 638                    const struct flow_wildcards *src1,
 639                    const struct flow_wildcards *src2)
 640 {
 641     uint32_t *dst_u32 = (uint32_t *) &dst->masks;
 642     const uint32_t *src1_u32 = (const uint32_t *) &src1->masks;
 643     const uint32_t *src2_u32 = (const uint32_t *) &src2->masks;
 644     size_t i;
 645
 646     for (i = 0; i < FLOW_U32S; i++) {
 647         dst_u32[i] = src1_u32[i] & src2_u32[i];
 648     }
 649 }
 650
 651 /* Sets 'dst' as the bitwise OR of wildcards in 'src1' and 'src2'.  That
 652  * is, a bit or a field is wildcarded in 'dst' if it is neither
 653  * wildcarded in 'src1' nor 'src2'. */
 654 void
 655 flow_wildcards_or(struct flow_wildcards *dst,
 656                   const struct flow_wildcards *src1,
 657                   const struct flow_wildcards *src2)
 658 {
 659     uint32_t *dst_u32 = (uint32_t *) &dst->masks;
 660     const uint32_t *src1_u32 = (const uint32_t *) &src1->masks;
 661     const uint32_t *src2_u32 = (const uint32_t *) &src2->masks;
 662     size_t i;
 663
 664     for (i = 0; i < FLOW_U32S; i++) {
 665         dst_u32[i] = src1_u32[i] | src2_u32[i];
 666     }
 667 }
 668
 669 /* Perform a bitwise OR of miniflow 'src' flow data with the equivalent
 670  * fields in 'dst', storing the result in 'dst'. */
 671 static void
 672 flow_union_with_miniflow(struct flow *dst, const struct miniflow *src)
 673 {
 674     uint32_t *dst_u32 = (uint32_t *) dst;
 675     const uint32_t *p = src->values;
 676     uint64_t map;
 677
 678     for (map = src->map; map; map = zero_rightmost_1bit(map)) {
 679         dst_u32[raw_ctz(map)] |= *p++;
 680     }
 681 }
 682
 683 /* Fold minimask 'mask''s wildcard mask into 'wc's wildcard mask. */
 684 void
 685 flow_wildcards_fold_minimask(struct flow_wildcards *wc,
 686                              const struct minimask *mask)
 687 {
 688     flow_union_with_miniflow(&wc->masks, &mask->masks);
 689 }
 690
 691 uint64_t
 692 miniflow_get_map_in_range(const struct miniflow *miniflow,
 693                           uint8_t start, uint8_t end, unsigned int *offset)
 694 {
 695     uint64_t map = miniflow->map;
 696     *offset = 0;
 697
 698     if (start > 0) {
 699         uint64_t msk = (UINT64_C(1) << start) - 1; /* 'start' LSBs set */
 700         *offset = count_1bits(map & msk);
 701         map &= ~msk;
 702     }
 703     if (end < FLOW_U32S) {
 704         uint64_t msk = (UINT64_C(1) << end) - 1; /* 'end' LSBs set */
 705         map &= msk;
 706     }
 707     return map;
 708 }
 709
 710 /* Fold minimask 'mask''s wildcard mask into 'wc's wildcard mask
 711  * in range [start, end). */
 712 void
 713 flow_wildcards_fold_minimask_range(struct flow_wildcards *wc,
 714                                    const struct minimask *mask,
 715                                    uint8_t start, uint8_t end)
 716 {
 717     uint32_t *dst_u32 = (uint32_t *)&wc->masks;
 718     unsigned int offset;
 719     uint64_t map = miniflow_get_map_in_range(&mask->masks, start, end,
 720                                              &offset);
 721     const uint32_t *p = mask->masks.values + offset;
 722
 723     for (; map; map = zero_rightmost_1bit(map)) {
 724         dst_u32[raw_ctz(map)] |= *p++;
 725     }
 726 }
 727
 728 /* Returns a hash of the wildcards in 'wc'. */
 729 uint32_t
 730 flow_wildcards_hash(const struct flow_wildcards *wc, uint32_t basis)
 731 {
 732     return flow_hash(&wc->masks, basis);
 733 }
 734
 735 /* Returns true if 'a' and 'b' represent the same wildcards, false if they are
 736  * different. */
 737 bool
 738 flow_wildcards_equal(const struct flow_wildcards *a,
 739                      const struct flow_wildcards *b)
 740 {
 741     return flow_equal(&a->masks, &b->masks);
 742 }
 743
 744 /* Returns true if at least one bit or field is wildcarded in 'a' but not in
 745  * 'b', false otherwise. */
 746 bool
 747 flow_wildcards_has_extra(const struct flow_wildcards *a,
 748                          const struct flow_wildcards *b)
 749 {
 750     const uint32_t *a_u32 = (const uint32_t *) &a->masks;
 751     const uint32_t *b_u32 = (const uint32_t *) &b->masks;
 752     size_t i;
 753
 754     for (i = 0; i < FLOW_U32S; i++) {
 755         if ((a_u32[i] & b_u32[i]) != b_u32[i]) {
 756             return true;
 757         }
 758     }
 759     return false;
 760 }
 761
 762 /* Returns true if 'a' and 'b' are equal, except that 0-bits (wildcarded bits)
 763  * in 'wc' do not need to be equal in 'a' and 'b'. */
 764 bool
 765 flow_equal_except(const struct flow *a, const struct flow *b,
 766                   const struct flow_wildcards *wc)
 767 {
 768     const uint32_t *a_u32 = (const uint32_t *) a;
 769     const uint32_t *b_u32 = (const uint32_t *) b;
 770     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
 771     size_t i;
 772
 773     for (i = 0; i < FLOW_U32S; i++) {
 774         if ((a_u32[i] ^ b_u32[i]) & wc_u32[i]) {
 775             return false;
 776         }
 777     }
 778     return true;
 779 }
 780
 781 /* Sets the wildcard mask for register 'idx' in 'wc' to 'mask'.
 782  * (A 0-bit indicates a wildcard bit.) */
 783 void
 784 flow_wildcards_set_reg_mask(struct flow_wildcards *wc, int idx, uint32_t mask)
 785 {
 786     wc->masks.regs[idx] = mask;
 787 }
 788
 789 /* Calculates the 5-tuple hash from the given flow. */
 790 uint32_t
 791 flow_hash_5tuple(const struct flow *flow, uint32_t basis)
 792 {
 793     uint32_t hash = 0;
 794
 795     if (!flow) {
 796         return 0;
 797     }
 798
 799     hash = mhash_add(basis, (OVS_FORCE uint32_t) flow->nw_src);
 800     hash = mhash_add(hash, (OVS_FORCE uint32_t) flow->nw_dst);
 801     hash = mhash_add(hash, ((OVS_FORCE uint32_t) flow->tp_src << 16)
 802                            | (OVS_FORCE uint32_t) flow->tp_dst);
 803     hash = mhash_add(hash, flow->nw_proto);
 804
 805     return mhash_finish(hash, 13);
 806 }
 807
 808 /* Hashes 'flow' based on its L2 through L4 protocol information. */
 809 uint32_t
 810 flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis)
 811 {
 812     struct {
 813         union {
 814             ovs_be32 ipv4_addr;
 815             struct in6_addr ipv6_addr;
 816         };
 817         ovs_be16 eth_type;
 818         ovs_be16 vlan_tci;
 819         ovs_be16 tp_port;
 820         uint8_t eth_addr[ETH_ADDR_LEN];
 821         uint8_t ip_proto;
 822     } fields;
 823
 824     int i;
 825
 826     memset(&fields, 0, sizeof fields);
 827     for (i = 0; i < ETH_ADDR_LEN; i++) {
 828         fields.eth_addr[i] = flow->dl_src[i] ^ flow->dl_dst[i];
 829     }
 830     fields.vlan_tci = flow->vlan_tci & htons(VLAN_VID_MASK);
 831     fields.eth_type = flow->dl_type;
 832
 833     /* UDP source and destination port are not taken into account because they
 834      * will not necessarily be symmetric in a bidirectional flow. */
 835     if (fields.eth_type == htons(ETH_TYPE_IP)) {
 836         fields.ipv4_addr = flow->nw_src ^ flow->nw_dst;
 837         fields.ip_proto = flow->nw_proto;
 838         if (fields.ip_proto == IPPROTO_TCP || fields.ip_proto == IPPROTO_SCTP) {
 839             fields.tp_port = flow->tp_src ^ flow->tp_dst;
 840         }
 841     } else if (fields.eth_type == htons(ETH_TYPE_IPV6)) {
 842         const uint8_t *a = &flow->ipv6_src.s6_addr[0];
 843         const uint8_t *b = &flow->ipv6_dst.s6_addr[0];
 844         uint8_t *ipv6_addr = &fields.ipv6_addr.s6_addr[0];
 845
 846         for (i=0; i<16; i++) {
 847             ipv6_addr[i] = a[i] ^ b[i];
 848         }
 849         fields.ip_proto = flow->nw_proto;
 850         if (fields.ip_proto == IPPROTO_TCP || fields.ip_proto == IPPROTO_SCTP) {
 851             fields.tp_port = flow->tp_src ^ flow->tp_dst;
 852         }
 853     }
 854     return jhash_bytes(&fields, sizeof fields, basis);
 855 }
 856
 857 /* Initialize a flow with random fields that matter for nx_hash_fields. */
 858 void
 859 flow_random_hash_fields(struct flow *flow)
 860 {
 861     uint16_t rnd = random_uint16();
 862
 863     /* Initialize to all zeros. */
 864     memset(flow, 0, sizeof *flow);
 865
 866     eth_addr_random(flow->dl_src);
 867     eth_addr_random(flow->dl_dst);
 868
 869     flow->vlan_tci = (OVS_FORCE ovs_be16) (random_uint16() & VLAN_VID_MASK);
 870
 871     /* Make most of the random flows IPv4, some IPv6, and rest random. */
 872     flow->dl_type = rnd < 0x8000 ? htons(ETH_TYPE_IP) :
 873         rnd < 0xc000 ? htons(ETH_TYPE_IPV6) : (OVS_FORCE ovs_be16)rnd;
 874
 875     if (dl_type_is_ip_any(flow->dl_type)) {
 876         if (flow->dl_type == htons(ETH_TYPE_IP)) {
 877             flow->nw_src = (OVS_FORCE ovs_be32)random_uint32();
 878             flow->nw_dst = (OVS_FORCE ovs_be32)random_uint32();
 879         } else {
 880             random_bytes(&flow->ipv6_src, sizeof flow->ipv6_src);
 881             random_bytes(&flow->ipv6_dst, sizeof flow->ipv6_dst);
 882         }
 883         /* Make most of IP flows TCP, some UDP or SCTP, and rest random. */
 884         rnd = random_uint16();
 885         flow->nw_proto = rnd < 0x8000 ? IPPROTO_TCP :
 886             rnd < 0xc000 ? IPPROTO_UDP :
 887             rnd < 0xd000 ? IPPROTO_SCTP : (uint8_t)rnd;
 888         if (flow->nw_proto == IPPROTO_TCP ||
 889             flow->nw_proto == IPPROTO_UDP ||
 890             flow->nw_proto == IPPROTO_SCTP) {
 891             flow->tp_src = (OVS_FORCE ovs_be16)random_uint16();
 892             flow->tp_dst = (OVS_FORCE ovs_be16)random_uint16();
 893         }
 894     }
 895 }
 896
 897 /* Masks the fields in 'wc' that are used by the flow hash 'fields'. */
 898 void
 899 flow_mask_hash_fields(const struct flow *flow, struct flow_wildcards *wc,
 900                       enum nx_hash_fields fields)
 901 {
 902     switch (fields) {
 903     case NX_HASH_FIELDS_ETH_SRC:
 904         memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
 905         break;
 906
 907     case NX_HASH_FIELDS_SYMMETRIC_L4:
 908         memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
 909         memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
 910         if (flow->dl_type == htons(ETH_TYPE_IP)) {
 911             memset(&wc->masks.nw_src, 0xff, sizeof wc->masks.nw_src);
 912             memset(&wc->masks.nw_dst, 0xff, sizeof wc->masks.nw_dst);
 913         } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
 914             memset(&wc->masks.ipv6_src, 0xff, sizeof wc->masks.ipv6_src);
 915             memset(&wc->masks.ipv6_dst, 0xff, sizeof wc->masks.ipv6_dst);
 916         }
 917         if (is_ip_any(flow)) {
 918             memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
 919             flow_unwildcard_tp_ports(flow, wc);
 920         }
 921         wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
 922         break;
 923
 924     default:
 925         OVS_NOT_REACHED();
 926     }
 927 }
 928
 929 /* Hashes the portions of 'flow' designated by 'fields'. */
 930 uint32_t
 931 flow_hash_fields(const struct flow *flow, enum nx_hash_fields fields,
 932                  uint16_t basis)
 933 {
 934     switch (fields) {
 935
 936     case NX_HASH_FIELDS_ETH_SRC:
 937         return jhash_bytes(flow->dl_src, sizeof flow->dl_src, basis);
 938
 939     case NX_HASH_FIELDS_SYMMETRIC_L4:
 940         return flow_hash_symmetric_l4(flow, basis);
 941     }
 942
 943     OVS_NOT_REACHED();
 944 }
 945
 946 /* Returns a string representation of 'fields'. */
 947 const char *
 948 flow_hash_fields_to_str(enum nx_hash_fields fields)
 949 {
 950     switch (fields) {
 951     case NX_HASH_FIELDS_ETH_SRC: return "eth_src";
 952     case NX_HASH_FIELDS_SYMMETRIC_L4: return "symmetric_l4";
 953     default: return "<unknown>";
 954     }
 955 }
 956
 957 /* Returns true if the value of 'fields' is supported. Otherwise false. */
 958 bool
 959 flow_hash_fields_valid(enum nx_hash_fields fields)
 960 {
 961     return fields == NX_HASH_FIELDS_ETH_SRC
 962         || fields == NX_HASH_FIELDS_SYMMETRIC_L4;
 963 }
 964
 965 /* Returns a hash value for the bits of 'flow' that are active based on
 966  * 'wc', given 'basis'. */
 967 uint32_t
 968 flow_hash_in_wildcards(const struct flow *flow,
 969                        const struct flow_wildcards *wc, uint32_t basis)
 970 {
 971     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
 972     const uint32_t *flow_u32 = (const uint32_t *) flow;
 973     uint32_t hash;
 974     size_t i;
 975
 976     hash = basis;
 977     for (i = 0; i < FLOW_U32S; i++) {
 978         hash = mhash_add(hash, flow_u32[i] & wc_u32[i]);
 979     }
 980     return mhash_finish(hash, 4 * FLOW_U32S);
 981 }
 982
 983 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
 984  * OpenFlow 1.0 "dl_vlan" value:
 985  *
 986  *      - If it is in the range 0...4095, 'flow->vlan_tci' is set to match
 987  *        that VLAN.  Any existing PCP match is unchanged (it becomes 0 if
 988  *        'flow' previously matched packets without a VLAN header).
 989  *
 990  *      - If it is OFP_VLAN_NONE, 'flow->vlan_tci' is set to match a packet
 991  *        without a VLAN tag.
 992  *
 993  *      - Other values of 'vid' should not be used. */
 994 void
 995 flow_set_dl_vlan(struct flow *flow, ovs_be16 vid)
 996 {
 997     if (vid == htons(OFP10_VLAN_NONE)) {
 998         flow->vlan_tci = htons(0);
 999     } else {
1000         vid &= htons(VLAN_VID_MASK);
1001         flow->vlan_tci &= ~htons(VLAN_VID_MASK);
1002         flow->vlan_tci |= htons(VLAN_CFI) | vid;
1003     }
1004 }
1005
1006 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
1007  * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
1008  * plus CFI). */
1009 void
1010 flow_set_vlan_vid(struct flow *flow, ovs_be16 vid)
1011 {
1012     ovs_be16 mask = htons(VLAN_VID_MASK | VLAN_CFI);
1013     flow->vlan_tci &= ~mask;
1014     flow->vlan_tci |= vid & mask;
1015 }
1016
1017 /* Sets the VLAN PCP that 'flow' matches to 'pcp', which should be in the
1018  * range 0...7.
1019  *
1020  * This function has no effect on the VLAN ID that 'flow' matches.
1021  *
1022  * After calling this function, 'flow' will not match packets without a VLAN
1023  * header. */
1024 void
1025 flow_set_vlan_pcp(struct flow *flow, uint8_t pcp)
1026 {
1027     pcp &= 0x07;
1028     flow->vlan_tci &= ~htons(VLAN_PCP_MASK);
1029     flow->vlan_tci |= htons((pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
1030 }
1031
1032 /* Returns the number of MPLS LSEs present in 'flow'
1033  *
1034  * Returns 0 if the 'dl_type' of 'flow' is not an MPLS ethernet type.
1035  * Otherwise traverses 'flow''s MPLS label stack stopping at the
1036  * first entry that has the BoS bit set. If no such entry exists then
1037  * the maximum number of LSEs that can be stored in 'flow' is returned.
1038  */
1039 int
1040 flow_count_mpls_labels(const struct flow *flow, struct flow_wildcards *wc)
1041 {
1042     if (wc) {
1043         wc->masks.dl_type = OVS_BE16_MAX;
1044     }
1045     if (eth_type_mpls(flow->dl_type)) {
1046         int i;
1047         int len = FLOW_MAX_MPLS_LABELS;
1048
1049         for (i = 0; i < len; i++) {
1050             if (wc) {
1051                 wc->masks.mpls_lse[i] |= htonl(MPLS_BOS_MASK);
1052             }
1053             if (flow->mpls_lse[i] & htonl(MPLS_BOS_MASK)) {
1054                 return i + 1;
1055             }
1056         }
1057
1058         return len;
1059     } else {
1060         return 0;
1061     }
1062 }
1063
1064 /* Returns the number consecutive of MPLS LSEs, starting at the
1065  * innermost LSE, that are common in 'a' and 'b'.
1066  *
1067  * 'an' must be flow_count_mpls_labels(a).
1068  * 'bn' must be flow_count_mpls_labels(b).
1069  */
1070 int
1071 flow_count_common_mpls_labels(const struct flow *a, int an,
1072                               const struct flow *b, int bn,
1073                               struct flow_wildcards *wc)
1074 {
1075     int min_n = MIN(an, bn);
1076     if (min_n == 0) {
1077         return 0;
1078     } else {
1079         int common_n = 0;
1080         int a_last = an - 1;
1081         int b_last = bn - 1;
1082         int i;
1083
1084         for (i = 0; i < min_n; i++) {
1085             if (wc) {
1086                 wc->masks.mpls_lse[a_last - i] = OVS_BE32_MAX;
1087                 wc->masks.mpls_lse[b_last - i] = OVS_BE32_MAX;
1088             }
1089             if (a->mpls_lse[a_last - i] != b->mpls_lse[b_last - i]) {
1090                 break;
1091             } else {
1092                 common_n++;
1093             }
1094         }
1095
1096         return common_n;
1097     }
1098 }
1099
1100 /* Adds a new outermost MPLS label to 'flow' and changes 'flow''s Ethernet type
1101  * to 'mpls_eth_type', which must be an MPLS Ethertype.
1102  *
1103  * If the new label is the first MPLS label in 'flow', it is generated as;
1104  *
1105  *     - label: 2, if 'flow' is IPv6, otherwise 0.
1106  *
1107  *     - TTL: IPv4 or IPv6 TTL, if present and nonzero, otherwise 64.
1108  *
1109  *     - TC: IPv4 or IPv6 TOS, if present, otherwise 0.
1110  *
1111  *     - BoS: 1.
1112  *
1113  * If the new label is the second or label MPLS label in 'flow', it is
1114  * generated as;
1115  *
1116  *     - label: Copied from outer label.
1117  *
1118  *     - TTL: Copied from outer label.
1119  *
1120  *     - TC: Copied from outer label.
1121  *
1122  *     - BoS: 0.
1123  *
1124  * 'n' must be flow_count_mpls_labels(flow).  'n' must be less than
1125  * FLOW_MAX_MPLS_LABELS (because otherwise flow->mpls_lse[] would overflow).
1126  */
1127 void
1128 flow_push_mpls(struct flow *flow, int n, ovs_be16 mpls_eth_type,
1129                struct flow_wildcards *wc)
1130 {
1131     ovs_assert(eth_type_mpls(mpls_eth_type));
1132     ovs_assert(n < FLOW_MAX_MPLS_LABELS);
1133
1134     memset(wc->masks.mpls_lse, 0xff, sizeof wc->masks.mpls_lse);
1135     if (n) {
1136         int i;
1137
1138         for (i = n; i >= 1; i--) {
1139             flow->mpls_lse[i] = flow->mpls_lse[i - 1];
1140         }
1141         flow->mpls_lse[0] = (flow->mpls_lse[1]
1142                              & htonl(~MPLS_BOS_MASK));
1143     } else {
1144         int label = 0;          /* IPv4 Explicit Null. */
1145         int tc = 0;
1146         int ttl = 64;
1147
1148         if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1149             label = 2;
1150         }
1151
1152         if (is_ip_any(flow)) {
1153             tc = (flow->nw_tos & IP_DSCP_MASK) >> 2;
1154             wc->masks.nw_tos |= IP_DSCP_MASK;
1155
1156             if (flow->nw_ttl) {
1157                 ttl = flow->nw_ttl;
1158             }
1159             wc->masks.nw_ttl = 0xff;
1160         }
1161
1162         flow->mpls_lse[0] = set_mpls_lse_values(ttl, tc, 1, htonl(label));
1163
1164         /* Clear all L3 and L4 fields. */
1165         BUILD_ASSERT(FLOW_WC_SEQ == 25);
1166         memset((char *) flow + FLOW_SEGMENT_2_ENDS_AT, 0,
1167                sizeof(struct flow) - FLOW_SEGMENT_2_ENDS_AT);
1168     }
1169     flow->dl_type = mpls_eth_type;
1170 }
1171
1172 /* Tries to remove the outermost MPLS label from 'flow'.  Returns true if
1173  * successful, false otherwise.  On success, sets 'flow''s Ethernet type to
1174  * 'eth_type'.
1175  *
1176  * 'n' must be flow_count_mpls_labels(flow). */
1177 bool
1178 flow_pop_mpls(struct flow *flow, int n, ovs_be16 eth_type,
1179               struct flow_wildcards *wc)
1180 {
1181     int i;
1182
1183     if (n == 0) {
1184         /* Nothing to pop. */
1185         return false;
1186     } else if (n == FLOW_MAX_MPLS_LABELS
1187                && !(flow->mpls_lse[n - 1] & htonl(MPLS_BOS_MASK))) {
1188         /* Can't pop because we don't know what to fill in mpls_lse[n - 1]. */
1189         return false;
1190     }
1191
1192     memset(wc->masks.mpls_lse, 0xff, sizeof wc->masks.mpls_lse);
1193     for (i = 1; i < n; i++) {
1194         flow->mpls_lse[i - 1] = flow->mpls_lse[i];
1195     }
1196     flow->mpls_lse[n - 1] = 0;
1197     flow->dl_type = eth_type;
1198     return true;
1199 }
1200
1201 /* Sets the MPLS Label that 'flow' matches to 'label', which is interpreted
1202  * as an OpenFlow 1.1 "mpls_label" value. */
1203 void
1204 flow_set_mpls_label(struct flow *flow, int idx, ovs_be32 label)
1205 {
1206     set_mpls_lse_label(&flow->mpls_lse[idx], label);
1207 }
1208
1209 /* Sets the MPLS TTL that 'flow' matches to 'ttl', which should be in the
1210  * range 0...255. */
1211 void
1212 flow_set_mpls_ttl(struct flow *flow, int idx, uint8_t ttl)
1213 {
1214     set_mpls_lse_ttl(&flow->mpls_lse[idx], ttl);
1215 }
1216
1217 /* Sets the MPLS TC that 'flow' matches to 'tc', which should be in the
1218  * range 0...7. */
1219 void
1220 flow_set_mpls_tc(struct flow *flow, int idx, uint8_t tc)
1221 {
1222     set_mpls_lse_tc(&flow->mpls_lse[idx], tc);
1223 }
1224
1225 /* Sets the MPLS BOS bit that 'flow' matches to which should be 0 or 1. */
1226 void
1227 flow_set_mpls_bos(struct flow *flow, int idx, uint8_t bos)
1228 {
1229     set_mpls_lse_bos(&flow->mpls_lse[idx], bos);
1230 }
1231
1232 /* Sets the entire MPLS LSE. */
1233 void
1234 flow_set_mpls_lse(struct flow *flow, int idx, ovs_be32 lse)
1235 {
1236     flow->mpls_lse[idx] = lse;
1237 }
1238
1239 static size_t
1240 flow_compose_l4(struct ofpbuf *b, const struct flow *flow)
1241 {
1242     size_t l4_len = 0;
1243
1244     if (!(flow->nw_frag & FLOW_NW_FRAG_ANY)
1245         || !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1246         if (flow->nw_proto == IPPROTO_TCP) {
1247             struct tcp_header *tcp;
1248
1249             l4_len = sizeof *tcp;
1250             tcp = ofpbuf_put_zeros(b, l4_len);
1251             tcp->tcp_src = flow->tp_src;
1252             tcp->tcp_dst = flow->tp_dst;
1253             tcp->tcp_ctl = TCP_CTL(ntohs(flow->tcp_flags), 5);
1254         } else if (flow->nw_proto == IPPROTO_UDP) {
1255             struct udp_header *udp;
1256
1257             l4_len = sizeof *udp;
1258             udp = ofpbuf_put_zeros(b, l4_len);
1259             udp->udp_src = flow->tp_src;
1260             udp->udp_dst = flow->tp_dst;
1261         } else if (flow->nw_proto == IPPROTO_SCTP) {
1262             struct sctp_header *sctp;
1263
1264             l4_len = sizeof *sctp;
1265             sctp = ofpbuf_put_zeros(b, l4_len);
1266             sctp->sctp_src = flow->tp_src;
1267             sctp->sctp_dst = flow->tp_dst;
1268         } else if (flow->nw_proto == IPPROTO_ICMP) {
1269             struct icmp_header *icmp;
1270
1271             l4_len = sizeof *icmp;
1272             icmp = ofpbuf_put_zeros(b, l4_len);
1273             icmp->icmp_type = ntohs(flow->tp_src);
1274             icmp->icmp_code = ntohs(flow->tp_dst);
1275             icmp->icmp_csum = csum(icmp, ICMP_HEADER_LEN);
1276         } else if (flow->nw_proto == IPPROTO_ICMPV6) {
1277             struct icmp6_hdr *icmp;
1278
1279             l4_len = sizeof *icmp;
1280             icmp = ofpbuf_put_zeros(b, l4_len);
1281             icmp->icmp6_type = ntohs(flow->tp_src);
1282             icmp->icmp6_code = ntohs(flow->tp_dst);
1283
1284             if (icmp->icmp6_code == 0 &&
1285                 (icmp->icmp6_type == ND_NEIGHBOR_SOLICIT ||
1286                  icmp->icmp6_type == ND_NEIGHBOR_ADVERT)) {
1287                 struct in6_addr *nd_target;
1288                 struct nd_opt_hdr *nd_opt;
1289
1290                 l4_len += sizeof *nd_target;
1291                 nd_target = ofpbuf_put_zeros(b, sizeof *nd_target);
1292                 *nd_target = flow->nd_target;
1293
1294                 if (!eth_addr_is_zero(flow->arp_sha)) {
1295                     l4_len += 8;
1296                     nd_opt = ofpbuf_put_zeros(b, 8);
1297                     nd_opt->nd_opt_len = 1;
1298                     nd_opt->nd_opt_type = ND_OPT_SOURCE_LINKADDR;
1299                     memcpy(nd_opt + 1, flow->arp_sha, ETH_ADDR_LEN);
1300                 }
1301                 if (!eth_addr_is_zero(flow->arp_tha)) {
1302                     l4_len += 8;
1303                     nd_opt = ofpbuf_put_zeros(b, 8);
1304                     nd_opt->nd_opt_len = 1;
1305                     nd_opt->nd_opt_type = ND_OPT_TARGET_LINKADDR;
1306                     memcpy(nd_opt + 1, flow->arp_tha, ETH_ADDR_LEN);
1307                 }
1308             }
1309             icmp->icmp6_cksum = (OVS_FORCE uint16_t)
1310                 csum(icmp, (char *)ofpbuf_tail(b) - (char *)icmp);
1311         }
1312     }
1313     return l4_len;
1314 }
1315
1316 /* Puts into 'b' a packet that flow_extract() would parse as having the given
1317  * 'flow'.
1318  *
1319  * (This is useful only for testing, obviously, and the packet isn't really
1320  * valid. It hasn't got some checksums filled in, for one, and lots of fields
1321  * are just zeroed.) */
1322 void
1323 flow_compose(struct ofpbuf *b, const struct flow *flow)
1324 {
1325     size_t l4_len;
1326
1327     /* eth_compose() sets l3 pointer and makes sure it is 32-bit aligned. */
1328     eth_compose(b, flow->dl_dst, flow->dl_src, ntohs(flow->dl_type), 0);
1329     if (flow->dl_type == htons(FLOW_DL_TYPE_NONE)) {
1330         struct eth_header *eth = ofpbuf_l2(b);
1331         eth->eth_type = htons(ofpbuf_size(b));
1332         return;
1333     }
1334
1335     if (flow->vlan_tci & htons(VLAN_CFI)) {
1336         eth_push_vlan(b, htons(ETH_TYPE_VLAN), flow->vlan_tci);
1337     }
1338
1339     if (flow->dl_type == htons(ETH_TYPE_IP)) {
1340         struct ip_header *ip;
1341
1342         ip = ofpbuf_put_zeros(b, sizeof *ip);
1343         ip->ip_ihl_ver = IP_IHL_VER(5, 4);
1344         ip->ip_tos = flow->nw_tos;
1345         ip->ip_ttl = flow->nw_ttl;
1346         ip->ip_proto = flow->nw_proto;
1347         put_16aligned_be32(&ip->ip_src, flow->nw_src);
1348         put_16aligned_be32(&ip->ip_dst, flow->nw_dst);
1349
1350         if (flow->nw_frag & FLOW_NW_FRAG_ANY) {
1351             ip->ip_frag_off |= htons(IP_MORE_FRAGMENTS);
1352             if (flow->nw_frag & FLOW_NW_FRAG_LATER) {
1353                 ip->ip_frag_off |= htons(100);
1354             }
1355         }
1356
1357         ofpbuf_set_l4(b, ofpbuf_tail(b));
1358
1359         l4_len = flow_compose_l4(b, flow);
1360
1361         ip->ip_tot_len = htons(b->l4_ofs - b->l3_ofs + l4_len);
1362         ip->ip_csum = csum(ip, sizeof *ip);
1363     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1364         struct ovs_16aligned_ip6_hdr *nh;
1365
1366         nh = ofpbuf_put_zeros(b, sizeof *nh);
1367         put_16aligned_be32(&nh->ip6_flow, htonl(6 << 28) |
1368                            htonl(flow->nw_tos << 20) | flow->ipv6_label);
1369         nh->ip6_hlim = flow->nw_ttl;
1370         nh->ip6_nxt = flow->nw_proto;
1371
1372         memcpy(&nh->ip6_src, &flow->ipv6_src, sizeof(nh->ip6_src));
1373         memcpy(&nh->ip6_dst, &flow->ipv6_dst, sizeof(nh->ip6_dst));
1374
1375         ofpbuf_set_l4(b, ofpbuf_tail(b));
1376
1377         l4_len = flow_compose_l4(b, flow);
1378
1379         nh->ip6_plen = htons(l4_len);
1380     } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
1381                flow->dl_type == htons(ETH_TYPE_RARP)) {
1382         struct arp_eth_header *arp;
1383
1384         arp = ofpbuf_put_zeros(b, sizeof *arp);
1385         ofpbuf_set_l3(b, arp);
1386         arp->ar_hrd = htons(1);
1387         arp->ar_pro = htons(ETH_TYPE_IP);
1388         arp->ar_hln = ETH_ADDR_LEN;
1389         arp->ar_pln = 4;
1390         arp->ar_op = htons(flow->nw_proto);
1391
1392         if (flow->nw_proto == ARP_OP_REQUEST ||
1393             flow->nw_proto == ARP_OP_REPLY) {
1394             put_16aligned_be32(&arp->ar_spa, flow->nw_src);
1395             put_16aligned_be32(&arp->ar_tpa, flow->nw_dst);
1396             memcpy(arp->ar_sha, flow->arp_sha, ETH_ADDR_LEN);
1397             memcpy(arp->ar_tha, flow->arp_tha, ETH_ADDR_LEN);
1398         }
1399     }
1400
1401     if (eth_type_mpls(flow->dl_type)) {
1402         int n;
1403
1404         b->l2_5_ofs = b->l3_ofs;
1405         for (n = 1; n < FLOW_MAX_MPLS_LABELS; n++) {
1406             if (flow->mpls_lse[n - 1] & htonl(MPLS_BOS_MASK)) {
1407                 break;
1408             }
1409         }
1410         while (n > 0) {
1411             push_mpls(b, flow->dl_type, flow->mpls_lse[--n]);
1412         }
1413     }
1414 }
1415 \f
1416 /* Compressed flow. */
1417
1418 static int
1419 miniflow_n_values(const struct miniflow *flow)
1420 {
1421     return count_1bits(flow->map);
1422 }
1423
1424 static uint32_t *
1425 miniflow_alloc_values(struct miniflow *flow, int n)
1426 {
1427     if (n <= MINI_N_INLINE) {
1428         return flow->inline_values;
1429     } else {
1430         COVERAGE_INC(miniflow_malloc);
1431         return xmalloc(n * sizeof *flow->values);
1432     }
1433 }
1434
1435 /* Completes an initialization of 'dst' as a miniflow copy of 'src' begun by
1436  * the caller.  The caller must have already initialized 'dst->map' properly
1437  * to indicate the significant uint32_t elements of 'src'.  'n' must be the
1438  * number of 1-bits in 'dst->map'.
1439  *
1440  * Normally the significant elements are the ones that are non-zero.  However,
1441  * when a miniflow is initialized from a (mini)mask, the values can be zeroes,
1442  * so that the flow and mask always have the same maps.
1443  *
1444  * This function initializes 'dst->values' (either inline if possible or with
1445  * malloc() otherwise) and copies the uint32_t elements of 'src' indicated by
1446  * 'dst->map' into it. */
1447 static void
1448 miniflow_init__(struct miniflow *dst, const struct flow *src, int n)
1449 {
1450     const uint32_t *src_u32 = (const uint32_t *) src;
1451     unsigned int ofs;
1452     uint64_t map;
1453
1454     dst->values = miniflow_alloc_values(dst, n);
1455     ofs = 0;
1456     for (map = dst->map; map; map = zero_rightmost_1bit(map)) {
1457         dst->values[ofs++] = src_u32[raw_ctz(map)];
1458     }
1459 }
1460
1461 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1462  * with miniflow_destroy(). */
1463 void
1464 miniflow_init(struct miniflow *dst, const struct flow *src)
1465 {
1466     const uint32_t *src_u32 = (const uint32_t *) src;
1467     unsigned int i;
1468     int n;
1469
1470     /* Initialize dst->map, counting the number of nonzero elements. */
1471     n = 0;
1472     dst->map = 0;
1473
1474     for (i = 0; i < FLOW_U32S; i++) {
1475         if (src_u32[i]) {
1476             dst->map |= UINT64_C(1) << i;
1477             n++;
1478         }
1479     }
1480
1481     miniflow_init__(dst, src, n);
1482 }
1483
1484 /* Initializes 'dst' as a copy of 'src', using 'mask->map' as 'dst''s map.  The
1485  * caller must eventually free 'dst' with miniflow_destroy(). */
1486 void
1487 miniflow_init_with_minimask(struct miniflow *dst, const struct flow *src,
1488                             const struct minimask *mask)
1489 {
1490     dst->map = mask->masks.map;
1491     miniflow_init__(dst, src, miniflow_n_values(dst));
1492 }
1493
1494 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1495  * with miniflow_destroy(). */
1496 void
1497 miniflow_clone(struct miniflow *dst, const struct miniflow *src)
1498 {
1499     int n = miniflow_n_values(src);
1500     dst->map = src->map;
1501     dst->values = miniflow_alloc_values(dst, n);
1502     memcpy(dst->values, src->values, n * sizeof *dst->values);
1503 }
1504
1505 /* Initializes 'dst' with the data in 'src', destroying 'src'.
1506  * The caller must eventually free 'dst' with miniflow_destroy(). */
1507 void
1508 miniflow_move(struct miniflow *dst, struct miniflow *src)
1509 {
1510     if (src->values == src->inline_values) {
1511         dst->values = dst->inline_values;
1512         memcpy(dst->values, src->values,
1513                miniflow_n_values(src) * sizeof *dst->values);
1514     } else {
1515         dst->values = src->values;
1516     }
1517     dst->map = src->map;
1518 }
1519
1520 /* Frees any memory owned by 'flow'.  Does not free the storage in which 'flow'
1521  * itself resides; the caller is responsible for that. */
1522 void
1523 miniflow_destroy(struct miniflow *flow)
1524 {
1525     if (flow->values != flow->inline_values) {
1526         free(flow->values);
1527     }
1528 }
1529
1530 /* Initializes 'dst' as a copy of 'src'. */
1531 void
1532 miniflow_expand(const struct miniflow *src, struct flow *dst)
1533 {
1534     memset(dst, 0, sizeof *dst);
1535     flow_union_with_miniflow(dst, src);
1536 }
1537
1538 static const uint32_t *
1539 miniflow_get__(const struct miniflow *flow, unsigned int u32_ofs)
1540 {
1541     if (!(flow->map & (UINT64_C(1) << u32_ofs))) {
1542         static const uint32_t zero = 0;
1543         return &zero;
1544     }
1545     return flow->values +
1546            count_1bits(flow->map & ((UINT64_C(1) << u32_ofs) - 1));
1547 }
1548
1549 /* Returns the uint32_t that would be at byte offset '4 * u32_ofs' if 'flow'
1550  * were expanded into a "struct flow". */
1551 uint32_t
1552 miniflow_get(const struct miniflow *flow, unsigned int u32_ofs)
1553 {
1554     return *miniflow_get__(flow, u32_ofs);
1555 }
1556
1557 /* Returns the ovs_be16 that would be at byte offset 'u8_ofs' if 'flow' were
1558  * expanded into a "struct flow". */
1559 static ovs_be16
1560 miniflow_get_be16(const struct miniflow *flow, unsigned int u8_ofs)
1561 {
1562     const uint32_t *u32p = miniflow_get__(flow, u8_ofs / 4);
1563     const ovs_be16 *be16p = (const ovs_be16 *) u32p;
1564     return be16p[u8_ofs % 4 != 0];
1565 }
1566
1567 /* Returns the VID within the vlan_tci member of the "struct flow" represented
1568  * by 'flow'. */
1569 uint16_t
1570 miniflow_get_vid(const struct miniflow *flow)
1571 {
1572     ovs_be16 tci = miniflow_get_be16(flow, offsetof(struct flow, vlan_tci));
1573     return vlan_tci_to_vid(tci);
1574 }
1575
1576 /* Returns true if 'a' and 'b' are the same flow, false otherwise.  */
1577 bool
1578 miniflow_equal(const struct miniflow *a, const struct miniflow *b)
1579 {
1580     const uint32_t *ap = a->values;
1581     const uint32_t *bp = b->values;
1582     const uint64_t a_map = a->map;
1583     const uint64_t b_map = b->map;
1584     uint64_t map;
1585
1586     if (a_map == b_map) {
1587         for (map = a_map; map; map = zero_rightmost_1bit(map)) {
1588             if (*ap++ != *bp++) {
1589                 return false;
1590             }
1591         }
1592     } else {
1593         for (map = a_map | b_map; map; map = zero_rightmost_1bit(map)) {
1594             uint64_t bit = rightmost_1bit(map);
1595             uint64_t a_value = a_map & bit ? *ap++ : 0;
1596             uint64_t b_value = b_map & bit ? *bp++ : 0;
1597
1598             if (a_value != b_value) {
1599                 return false;
1600             }
1601         }
1602     }
1603
1604     return true;
1605 }
1606
1607 /* Returns true if 'a' and 'b' are equal at the places where there are 1-bits
1608  * in 'mask', false if they differ. */
1609 bool
1610 miniflow_equal_in_minimask(const struct miniflow *a, const struct miniflow *b,
1611                            const struct minimask *mask)
1612 {
1613     const uint32_t *p;
1614     uint64_t map;
1615
1616     p = mask->masks.values;
1617
1618     for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1619         int ofs = raw_ctz(map);
1620
1621         if ((miniflow_get(a, ofs) ^ miniflow_get(b, ofs)) & *p) {
1622             return false;
1623         }
1624         p++;
1625     }
1626
1627     return true;
1628 }
1629
1630 /* Returns true if 'a' and 'b' are equal at the places where there are 1-bits
1631  * in 'mask', false if they differ. */
1632 bool
1633 miniflow_equal_flow_in_minimask(const struct miniflow *a, const struct flow *b,
1634                                 const struct minimask *mask)
1635 {
1636     const uint32_t *b_u32 = (const uint32_t *) b;
1637     const uint32_t *p;
1638     uint64_t map;
1639
1640     p = mask->masks.values;
1641
1642     for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1643         int ofs = raw_ctz(map);
1644
1645         if ((miniflow_get(a, ofs) ^ b_u32[ofs]) & *p) {
1646             return false;
1647         }
1648         p++;
1649     }
1650
1651     return true;
1652 }
1653
1654 /* Returns a hash value for 'flow', given 'basis'. */
1655 uint32_t
1656 miniflow_hash(const struct miniflow *flow, uint32_t basis)
1657 {
1658     const uint32_t *p = flow->values;
1659     uint32_t hash = basis;
1660     uint64_t hash_map = 0;
1661     uint64_t map;
1662
1663     for (map = flow->map; map; map = zero_rightmost_1bit(map)) {
1664         if (*p) {
1665             hash = mhash_add(hash, *p);
1666             hash_map |= rightmost_1bit(map);
1667         }
1668         p++;
1669     }
1670     hash = mhash_add(hash, hash_map);
1671     hash = mhash_add(hash, hash_map >> 32);
1672
1673     return mhash_finish(hash, p - flow->values);
1674 }
1675
1676 /* Returns a hash value for the bits of 'flow' where there are 1-bits in
1677  * 'mask', given 'basis'.
1678  *
1679  * The hash values returned by this function are the same as those returned by
1680  * flow_hash_in_minimask(), only the form of the arguments differ. */
1681 uint32_t
1682 miniflow_hash_in_minimask(const struct miniflow *flow,
1683                           const struct minimask *mask, uint32_t basis)
1684 {
1685     const uint32_t *p = mask->masks.values;
1686     uint32_t hash;
1687     uint64_t map;
1688
1689     hash = basis;
1690
1691     for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1692         hash = mhash_add(hash, miniflow_get(flow, raw_ctz(map)) & *p++);
1693     }
1694
1695     return mhash_finish(hash, (p - mask->masks.values) * 4);
1696 }
1697
1698 /* Returns a hash value for the bits of 'flow' where there are 1-bits in
1699  * 'mask', given 'basis'.
1700  *
1701  * The hash values returned by this function are the same as those returned by
1702  * miniflow_hash_in_minimask(), only the form of the arguments differ. */
1703 uint32_t
1704 flow_hash_in_minimask(const struct flow *flow, const struct minimask *mask,
1705                       uint32_t basis)
1706 {
1707     const uint32_t *flow_u32 = (const uint32_t *)flow;
1708     const uint32_t *p = mask->masks.values;
1709     uint32_t hash;
1710     uint64_t map;
1711
1712     hash = basis;
1713     for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1714         hash = mhash_add(hash, flow_u32[raw_ctz(map)] & *p++);
1715     }
1716
1717     return mhash_finish(hash, (p - mask->masks.values) * 4);
1718 }
1719
1720 /* Returns a hash value for the bits of range [start, end) in 'flow',
1721  * where there are 1-bits in 'mask', given 'hash'.
1722  *
1723  * The hash values returned by this function are the same as those returned by
1724  * minimatch_hash_range(), only the form of the arguments differ. */
1725 uint32_t
1726 flow_hash_in_minimask_range(const struct flow *flow,
1727                             const struct minimask *mask,
1728                             uint8_t start, uint8_t end, uint32_t *basis)
1729 {
1730     const uint32_t *flow_u32 = (const uint32_t *)flow;
1731     unsigned int offset;
1732     uint64_t map = miniflow_get_map_in_range(&mask->masks, start, end,
1733                                              &offset);
1734     const uint32_t *p = mask->masks.values + offset;
1735     uint32_t hash = *basis;
1736
1737     for (; map; map = zero_rightmost_1bit(map)) {
1738         hash = mhash_add(hash, flow_u32[raw_ctz(map)] & *p++);
1739     }
1740
1741     *basis = hash; /* Allow continuation from the unfinished value. */
1742     return mhash_finish(hash, (p - mask->masks.values) * 4);
1743 }
1744
1745 \f
1746 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1747  * with minimask_destroy(). */
1748 void
1749 minimask_init(struct minimask *mask, const struct flow_wildcards *wc)
1750 {
1751     miniflow_init(&mask->masks, &wc->masks);
1752 }
1753
1754 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1755  * with minimask_destroy(). */
1756 void
1757 minimask_clone(struct minimask *dst, const struct minimask *src)
1758 {
1759     miniflow_clone(&dst->masks, &src->masks);
1760 }
1761
1762 /* Initializes 'dst' with the data in 'src', destroying 'src'.
1763  * The caller must eventually free 'dst' with minimask_destroy(). */
1764 void
1765 minimask_move(struct minimask *dst, struct minimask *src)
1766 {
1767     miniflow_move(&dst->masks, &src->masks);
1768 }
1769
1770 /* Initializes 'dst_' as the bit-wise "and" of 'a_' and 'b_'.
1771  *
1772  * The caller must provide room for FLOW_U32S "uint32_t"s in 'storage', for use
1773  * by 'dst_'.  The caller must *not* free 'dst_' with minimask_destroy(). */
1774 void
1775 minimask_combine(struct minimask *dst_,
1776                  const struct minimask *a_, const struct minimask *b_,
1777                  uint32_t storage[FLOW_U32S])
1778 {
1779     struct miniflow *dst = &dst_->masks;
1780     const struct miniflow *a = &a_->masks;
1781     const struct miniflow *b = &b_->masks;
1782     uint64_t map;
1783     int n = 0;
1784
1785     dst->values = storage;
1786
1787     dst->map = 0;
1788     for (map = a->map & b->map; map; map = zero_rightmost_1bit(map)) {
1789         int ofs = raw_ctz(map);
1790         uint32_t mask = miniflow_get(a, ofs) & miniflow_get(b, ofs);
1791
1792         if (mask) {
1793             dst->map |= rightmost_1bit(map);
1794             dst->values[n++] = mask;
1795         }
1796     }
1797 }
1798
1799 /* Frees any memory owned by 'mask'.  Does not free the storage in which 'mask'
1800  * itself resides; the caller is responsible for that. */
1801 void
1802 minimask_destroy(struct minimask *mask)
1803 {
1804     miniflow_destroy(&mask->masks);
1805 }
1806
1807 /* Initializes 'dst' as a copy of 'src'. */
1808 void
1809 minimask_expand(const struct minimask *mask, struct flow_wildcards *wc)
1810 {
1811     miniflow_expand(&mask->masks, &wc->masks);
1812 }
1813
1814 /* Returns the uint32_t that would be at byte offset '4 * u32_ofs' if 'mask'
1815  * were expanded into a "struct flow_wildcards". */
1816 uint32_t
1817 minimask_get(const struct minimask *mask, unsigned int u32_ofs)
1818 {
1819     return miniflow_get(&mask->masks, u32_ofs);
1820 }
1821
1822 /* Returns the VID mask within the vlan_tci member of the "struct
1823  * flow_wildcards" represented by 'mask'. */
1824 uint16_t
1825 minimask_get_vid_mask(const struct minimask *mask)
1826 {
1827     return miniflow_get_vid(&mask->masks);
1828 }
1829
1830 /* Returns true if 'a' and 'b' are the same flow mask, false otherwise.  */
1831 bool
1832 minimask_equal(const struct minimask *a, const struct minimask *b)
1833 {
1834     return miniflow_equal(&a->masks, &b->masks);
1835 }
1836
1837 /* Returns a hash value for 'mask', given 'basis'. */
1838 uint32_t
1839 minimask_hash(const struct minimask *mask, uint32_t basis)
1840 {
1841     return miniflow_hash(&mask->masks, basis);
1842 }
1843
1844 /* Returns true if at least one bit is wildcarded in 'a_' but not in 'b_',
1845  * false otherwise. */
1846 bool
1847 minimask_has_extra(const struct minimask *a_, const struct minimask *b_)
1848 {
1849     const struct miniflow *a = &a_->masks;
1850     const struct miniflow *b = &b_->masks;
1851     uint64_t map;
1852
1853     for (map = a->map | b->map; map; map = zero_rightmost_1bit(map)) {
1854         int ofs = raw_ctz(map);
1855         uint32_t a_u32 = miniflow_get(a, ofs);
1856         uint32_t b_u32 = miniflow_get(b, ofs);
1857
1858         if ((a_u32 & b_u32) != b_u32) {
1859             return true;
1860         }
1861     }
1862
1863     return false;
1864 }
1865
1866 /* Returns true if 'mask' matches every packet, false if 'mask' fixes any bits
1867  * or fields. */
1868 bool
1869 minimask_is_catchall(const struct minimask *mask_)
1870 {
1871     const struct miniflow *mask = &mask_->masks;
1872     const uint32_t *p = mask->values;
1873     uint64_t map;
1874
1875     for (map = mask->map; map; map = zero_rightmost_1bit(map)) {
1876         if (*p++) {
1877             return false;
1878         }
1879     }
1880     return true;
1881 }