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