lib/flow.c

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