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