lib/flow.c

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