lib/flow.c

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