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 == 25);
 534
 535     fmd->dp_hash = flow->dp_hash;
 536     fmd->recirc_id = flow->recirc_id;
 537     fmd->tun_id = flow->tunnel.tun_id;
 538     fmd->tun_src = flow->tunnel.ip_src;
 539     fmd->tun_dst = flow->tunnel.ip_dst;
 540     fmd->metadata = flow->metadata;
 541     memcpy(fmd->regs, flow->regs, sizeof fmd->regs);
 542     fmd->pkt_mark = flow->pkt_mark;
 543     fmd->in_port = flow->in_port.ofp_port;
 544 }
 545
 546 char *
 547 flow_to_string(const struct flow *flow)
 548 {
 549     struct ds ds = DS_EMPTY_INITIALIZER;
 550     flow_format(&ds, flow);
 551     return ds_cstr(&ds);
 552 }
 553
 554 const char *
 555 flow_tun_flag_to_string(uint32_t flags)
 556 {
 557     switch (flags) {
 558     case FLOW_TNL_F_DONT_FRAGMENT:
 559         return "df";
 560     case FLOW_TNL_F_CSUM:
 561         return "csum";
 562     case FLOW_TNL_F_KEY:
 563         return "key";
 564     default:
 565         return NULL;
 566     }
 567 }
 568
 569 void
 570 format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t),
 571              uint32_t flags, char del)
 572 {
 573     uint32_t bad = 0;
 574
 575     if (!flags) {
 576         return;
 577     }
 578     while (flags) {
 579         uint32_t bit = rightmost_1bit(flags);
 580         const char *s;
 581
 582         s = bit_to_string(bit);
 583         if (s) {
 584             ds_put_format(ds, "%s%c", s, del);
 585         } else {
 586             bad |= bit;
 587         }
 588
 589         flags &= ~bit;
 590     }
 591
 592     if (bad) {
 593         ds_put_format(ds, "0x%"PRIx32"%c", bad, del);
 594     }
 595     ds_chomp(ds, del);
 596 }
 597
 598 void
 599 format_flags_masked(struct ds *ds, const char *name,
 600                     const char *(*bit_to_string)(uint32_t), uint32_t flags,
 601                     uint32_t mask)
 602 {
 603     if (name) {
 604         ds_put_format(ds, "%s=", name);
 605     }
 606     while (mask) {
 607         uint32_t bit = rightmost_1bit(mask);
 608         const char *s = bit_to_string(bit);
 609
 610         ds_put_format(ds, "%s%s", (flags & bit) ? "+" : "-",
 611                       s ? s : "[Unknown]");
 612         mask &= ~bit;
 613     }
 614 }
 615
 616 void
 617 flow_format(struct ds *ds, const struct flow *flow)
 618 {
 619     struct match match;
 620
 621     match_wc_init(&match, flow);
 622     match_format(&match, ds, OFP_DEFAULT_PRIORITY);
 623 }
 624
 625 void
 626 flow_print(FILE *stream, const struct flow *flow)
 627 {
 628     char *s = flow_to_string(flow);
 629     fputs(s, stream);
 630     free(s);
 631 }
 632 \f
 633 /* flow_wildcards functions. */
 634
 635 /* Initializes 'wc' as a set of wildcards that matches every packet. */
 636 void
 637 flow_wildcards_init_catchall(struct flow_wildcards *wc)
 638 {
 639     memset(&wc->masks, 0, sizeof wc->masks);
 640 }
 641
 642 /* Clear the metadata and register wildcard masks. They are not packet
 643  * header fields. */
 644 void
 645 flow_wildcards_clear_non_packet_fields(struct flow_wildcards *wc)
 646 {
 647     memset(&wc->masks.metadata, 0, sizeof wc->masks.metadata);
 648     memset(&wc->masks.regs, 0, sizeof wc->masks.regs);
 649 }
 650
 651 /* Returns true if 'wc' matches every packet, false if 'wc' fixes any bits or
 652  * fields. */
 653 bool
 654 flow_wildcards_is_catchall(const struct flow_wildcards *wc)
 655 {
 656     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
 657     size_t i;
 658
 659     for (i = 0; i < FLOW_U32S; i++) {
 660         if (wc_u32[i]) {
 661             return false;
 662         }
 663     }
 664     return true;
 665 }
 666
 667 /* Sets 'dst' as the bitwise AND of wildcards in 'src1' and 'src2'.
 668  * That is, a bit or a field is wildcarded in 'dst' if it is wildcarded
 669  * in 'src1' or 'src2' or both.  */
 670 void
 671 flow_wildcards_and(struct flow_wildcards *dst,
 672                    const struct flow_wildcards *src1,
 673                    const struct flow_wildcards *src2)
 674 {
 675     uint32_t *dst_u32 = (uint32_t *) &dst->masks;
 676     const uint32_t *src1_u32 = (const uint32_t *) &src1->masks;
 677     const uint32_t *src2_u32 = (const uint32_t *) &src2->masks;
 678     size_t i;
 679
 680     for (i = 0; i < FLOW_U32S; i++) {
 681         dst_u32[i] = src1_u32[i] & src2_u32[i];
 682     }
 683 }
 684
 685 /* Sets 'dst' as the bitwise OR of wildcards in 'src1' and 'src2'.  That
 686  * is, a bit or a field is wildcarded in 'dst' if it is neither
 687  * wildcarded in 'src1' nor 'src2'. */
 688 void
 689 flow_wildcards_or(struct flow_wildcards *dst,
 690                   const struct flow_wildcards *src1,
 691                   const struct flow_wildcards *src2)
 692 {
 693     uint32_t *dst_u32 = (uint32_t *) &dst->masks;
 694     const uint32_t *src1_u32 = (const uint32_t *) &src1->masks;
 695     const uint32_t *src2_u32 = (const uint32_t *) &src2->masks;
 696     size_t i;
 697
 698     for (i = 0; i < FLOW_U32S; i++) {
 699         dst_u32[i] = src1_u32[i] | src2_u32[i];
 700     }
 701 }
 702
 703 /* Perform a bitwise OR of miniflow 'src' flow data with the equivalent
 704  * fields in 'dst', storing the result in 'dst'. */
 705 static void
 706 flow_union_with_miniflow(struct flow *dst, const struct miniflow *src)
 707 {
 708     uint32_t *dst_u32 = (uint32_t *) dst;
 709     const uint32_t *p = src->values;
 710     uint64_t map;
 711
 712     for (map = src->map; map; map = zero_rightmost_1bit(map)) {
 713         dst_u32[raw_ctz(map)] |= *p++;
 714     }
 715 }
 716
 717 /* Fold minimask 'mask''s wildcard mask into 'wc's wildcard mask. */
 718 void
 719 flow_wildcards_fold_minimask(struct flow_wildcards *wc,
 720                              const struct minimask *mask)
 721 {
 722     flow_union_with_miniflow(&wc->masks, &mask->masks);
 723 }
 724
 725 uint64_t
 726 miniflow_get_map_in_range(const struct miniflow *miniflow,
 727                           uint8_t start, uint8_t end, unsigned int *offset)
 728 {
 729     uint64_t map = miniflow->map;
 730     *offset = 0;
 731
 732     if (start > 0) {
 733         uint64_t msk = (UINT64_C(1) << start) - 1; /* 'start' LSBs set */
 734         *offset = count_1bits(map & msk);
 735         map &= ~msk;
 736     }
 737     if (end < FLOW_U32S) {
 738         uint64_t msk = (UINT64_C(1) << end) - 1; /* 'end' LSBs set */
 739         map &= msk;
 740     }
 741     return map;
 742 }
 743
 744 /* Fold minimask 'mask''s wildcard mask into 'wc's wildcard mask
 745  * in range [start, end). */
 746 void
 747 flow_wildcards_fold_minimask_range(struct flow_wildcards *wc,
 748                                    const struct minimask *mask,
 749                                    uint8_t start, uint8_t end)
 750 {
 751     uint32_t *dst_u32 = (uint32_t *)&wc->masks;
 752     unsigned int offset;
 753     uint64_t map = miniflow_get_map_in_range(&mask->masks, start, end,
 754                                              &offset);
 755     const uint32_t *p = mask->masks.values + offset;
 756
 757     for (; map; map = zero_rightmost_1bit(map)) {
 758         dst_u32[raw_ctz(map)] |= *p++;
 759     }
 760 }
 761
 762 /* Returns a hash of the wildcards in 'wc'. */
 763 uint32_t
 764 flow_wildcards_hash(const struct flow_wildcards *wc, uint32_t basis)
 765 {
 766     return flow_hash(&wc->masks, basis);
 767 }
 768
 769 /* Returns true if 'a' and 'b' represent the same wildcards, false if they are
 770  * different. */
 771 bool
 772 flow_wildcards_equal(const struct flow_wildcards *a,
 773                      const struct flow_wildcards *b)
 774 {
 775     return flow_equal(&a->masks, &b->masks);
 776 }
 777
 778 /* Returns true if at least one bit or field is wildcarded in 'a' but not in
 779  * 'b', false otherwise. */
 780 bool
 781 flow_wildcards_has_extra(const struct flow_wildcards *a,
 782                          const struct flow_wildcards *b)
 783 {
 784     const uint32_t *a_u32 = (const uint32_t *) &a->masks;
 785     const uint32_t *b_u32 = (const uint32_t *) &b->masks;
 786     size_t i;
 787
 788     for (i = 0; i < FLOW_U32S; i++) {
 789         if ((a_u32[i] & b_u32[i]) != b_u32[i]) {
 790             return true;
 791         }
 792     }
 793     return false;
 794 }
 795
 796 /* Returns true if 'a' and 'b' are equal, except that 0-bits (wildcarded bits)
 797  * in 'wc' do not need to be equal in 'a' and 'b'. */
 798 bool
 799 flow_equal_except(const struct flow *a, const struct flow *b,
 800                   const struct flow_wildcards *wc)
 801 {
 802     const uint32_t *a_u32 = (const uint32_t *) a;
 803     const uint32_t *b_u32 = (const uint32_t *) b;
 804     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
 805     size_t i;
 806
 807     for (i = 0; i < FLOW_U32S; i++) {
 808         if ((a_u32[i] ^ b_u32[i]) & wc_u32[i]) {
 809             return false;
 810         }
 811     }
 812     return true;
 813 }
 814
 815 /* Sets the wildcard mask for register 'idx' in 'wc' to 'mask'.
 816  * (A 0-bit indicates a wildcard bit.) */
 817 void
 818 flow_wildcards_set_reg_mask(struct flow_wildcards *wc, int idx, uint32_t mask)
 819 {
 820     wc->masks.regs[idx] = mask;
 821 }
 822
 823 /* Calculates the 5-tuple hash from the given flow. */
 824 uint32_t
 825 flow_hash_5tuple(const struct flow *flow, uint32_t basis)
 826 {
 827     uint32_t hash = 0;
 828
 829     if (!flow) {
 830         return 0;
 831     }
 832
 833     hash = mhash_add(basis, (OVS_FORCE uint32_t) flow->nw_src);
 834     hash = mhash_add(hash, (OVS_FORCE uint32_t) flow->nw_dst);
 835     hash = mhash_add(hash, ((OVS_FORCE uint32_t) flow->tp_src << 16)
 836                            | (OVS_FORCE uint32_t) flow->tp_dst);
 837     hash = mhash_add(hash, flow->nw_proto);
 838
 839     return mhash_finish(hash, 13);
 840 }
 841
 842 /* Hashes 'flow' based on its L2 through L4 protocol information. */
 843 uint32_t
 844 flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis)
 845 {
 846     struct {
 847         union {
 848             ovs_be32 ipv4_addr;
 849             struct in6_addr ipv6_addr;
 850         };
 851         ovs_be16 eth_type;
 852         ovs_be16 vlan_tci;
 853         ovs_be16 tp_port;
 854         uint8_t eth_addr[ETH_ADDR_LEN];
 855         uint8_t ip_proto;
 856     } fields;
 857
 858     int i;
 859
 860     memset(&fields, 0, sizeof fields);
 861     for (i = 0; i < ETH_ADDR_LEN; i++) {
 862         fields.eth_addr[i] = flow->dl_src[i] ^ flow->dl_dst[i];
 863     }
 864     fields.vlan_tci = flow->vlan_tci & htons(VLAN_VID_MASK);
 865     fields.eth_type = flow->dl_type;
 866
 867     /* UDP source and destination port are not taken into account because they
 868      * will not necessarily be symmetric in a bidirectional flow. */
 869     if (fields.eth_type == htons(ETH_TYPE_IP)) {
 870         fields.ipv4_addr = flow->nw_src ^ flow->nw_dst;
 871         fields.ip_proto = flow->nw_proto;
 872         if (fields.ip_proto == IPPROTO_TCP || fields.ip_proto == IPPROTO_SCTP) {
 873             fields.tp_port = flow->tp_src ^ flow->tp_dst;
 874         }
 875     } else if (fields.eth_type == htons(ETH_TYPE_IPV6)) {
 876         const uint8_t *a = &flow->ipv6_src.s6_addr[0];
 877         const uint8_t *b = &flow->ipv6_dst.s6_addr[0];
 878         uint8_t *ipv6_addr = &fields.ipv6_addr.s6_addr[0];
 879
 880         for (i=0; i<16; i++) {
 881             ipv6_addr[i] = a[i] ^ b[i];
 882         }
 883         fields.ip_proto = flow->nw_proto;
 884         if (fields.ip_proto == IPPROTO_TCP || fields.ip_proto == IPPROTO_SCTP) {
 885             fields.tp_port = flow->tp_src ^ flow->tp_dst;
 886         }
 887     }
 888     return jhash_bytes(&fields, sizeof fields, basis);
 889 }
 890
 891 /* Initialize a flow with random fields that matter for nx_hash_fields. */
 892 void
 893 flow_random_hash_fields(struct flow *flow)
 894 {
 895     uint16_t rnd = random_uint16();
 896
 897     /* Initialize to all zeros. */
 898     memset(flow, 0, sizeof *flow);
 899
 900     eth_addr_random(flow->dl_src);
 901     eth_addr_random(flow->dl_dst);
 902
 903     flow->vlan_tci = (OVS_FORCE ovs_be16) (random_uint16() & VLAN_VID_MASK);
 904
 905     /* Make most of the random flows IPv4, some IPv6, and rest random. */
 906     flow->dl_type = rnd < 0x8000 ? htons(ETH_TYPE_IP) :
 907         rnd < 0xc000 ? htons(ETH_TYPE_IPV6) : (OVS_FORCE ovs_be16)rnd;
 908
 909     if (dl_type_is_ip_any(flow->dl_type)) {
 910         if (flow->dl_type == htons(ETH_TYPE_IP)) {
 911             flow->nw_src = (OVS_FORCE ovs_be32)random_uint32();
 912             flow->nw_dst = (OVS_FORCE ovs_be32)random_uint32();
 913         } else {
 914             random_bytes(&flow->ipv6_src, sizeof flow->ipv6_src);
 915             random_bytes(&flow->ipv6_dst, sizeof flow->ipv6_dst);
 916         }
 917         /* Make most of IP flows TCP, some UDP or SCTP, and rest random. */
 918         rnd = random_uint16();
 919         flow->nw_proto = rnd < 0x8000 ? IPPROTO_TCP :
 920             rnd < 0xc000 ? IPPROTO_UDP :
 921             rnd < 0xd000 ? IPPROTO_SCTP : (uint8_t)rnd;
 922         if (flow->nw_proto == IPPROTO_TCP ||
 923             flow->nw_proto == IPPROTO_UDP ||
 924             flow->nw_proto == IPPROTO_SCTP) {
 925             flow->tp_src = (OVS_FORCE ovs_be16)random_uint16();
 926             flow->tp_dst = (OVS_FORCE ovs_be16)random_uint16();
 927         }
 928     }
 929 }
 930
 931 /* Masks the fields in 'wc' that are used by the flow hash 'fields'. */
 932 void
 933 flow_mask_hash_fields(const struct flow *flow, struct flow_wildcards *wc,
 934                       enum nx_hash_fields fields)
 935 {
 936     switch (fields) {
 937     case NX_HASH_FIELDS_ETH_SRC:
 938         memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
 939         break;
 940
 941     case NX_HASH_FIELDS_SYMMETRIC_L4:
 942         memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
 943         memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
 944         if (flow->dl_type == htons(ETH_TYPE_IP)) {
 945             memset(&wc->masks.nw_src, 0xff, sizeof wc->masks.nw_src);
 946             memset(&wc->masks.nw_dst, 0xff, sizeof wc->masks.nw_dst);
 947         } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
 948             memset(&wc->masks.ipv6_src, 0xff, sizeof wc->masks.ipv6_src);
 949             memset(&wc->masks.ipv6_dst, 0xff, sizeof wc->masks.ipv6_dst);
 950         }
 951         if (is_ip_any(flow)) {
 952             memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
 953             flow_unwildcard_tp_ports(flow, wc);
 954         }
 955         wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
 956         break;
 957
 958     default:
 959         OVS_NOT_REACHED();
 960     }
 961 }
 962
 963 /* Hashes the portions of 'flow' designated by 'fields'. */
 964 uint32_t
 965 flow_hash_fields(const struct flow *flow, enum nx_hash_fields fields,
 966                  uint16_t basis)
 967 {
 968     switch (fields) {
 969
 970     case NX_HASH_FIELDS_ETH_SRC:
 971         return jhash_bytes(flow->dl_src, sizeof flow->dl_src, basis);
 972
 973     case NX_HASH_FIELDS_SYMMETRIC_L4:
 974         return flow_hash_symmetric_l4(flow, basis);
 975     }
 976
 977     OVS_NOT_REACHED();
 978 }
 979
 980 /* Returns a string representation of 'fields'. */
 981 const char *
 982 flow_hash_fields_to_str(enum nx_hash_fields fields)
 983 {
 984     switch (fields) {
 985     case NX_HASH_FIELDS_ETH_SRC: return "eth_src";
 986     case NX_HASH_FIELDS_SYMMETRIC_L4: return "symmetric_l4";
 987     default: return "<unknown>";
 988     }
 989 }
 990
 991 /* Returns true if the value of 'fields' is supported. Otherwise false. */
 992 bool
 993 flow_hash_fields_valid(enum nx_hash_fields fields)
 994 {
 995     return fields == NX_HASH_FIELDS_ETH_SRC
 996         || fields == NX_HASH_FIELDS_SYMMETRIC_L4;
 997 }
 998
 999 /* Returns a hash value for the bits of 'flow' that are active based on
1000  * 'wc', given 'basis'. */
1001 uint32_t
1002 flow_hash_in_wildcards(const struct flow *flow,
1003                        const struct flow_wildcards *wc, uint32_t basis)
1004 {
1005     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
1006     const uint32_t *flow_u32 = (const uint32_t *) flow;
1007     uint32_t hash;
1008     size_t i;
1009
1010     hash = basis;
1011     for (i = 0; i < FLOW_U32S; i++) {
1012         hash = mhash_add(hash, flow_u32[i] & wc_u32[i]);
1013     }
1014     return mhash_finish(hash, 4 * FLOW_U32S);
1015 }
1016
1017 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
1018  * OpenFlow 1.0 "dl_vlan" value:
1019  *
1020  *      - If it is in the range 0...4095, 'flow->vlan_tci' is set to match
1021  *        that VLAN.  Any existing PCP match is unchanged (it becomes 0 if
1022  *        'flow' previously matched packets without a VLAN header).
1023  *
1024  *      - If it is OFP_VLAN_NONE, 'flow->vlan_tci' is set to match a packet
1025  *        without a VLAN tag.
1026  *
1027  *      - Other values of 'vid' should not be used. */
1028 void
1029 flow_set_dl_vlan(struct flow *flow, ovs_be16 vid)
1030 {
1031     if (vid == htons(OFP10_VLAN_NONE)) {
1032         flow->vlan_tci = htons(0);
1033     } else {
1034         vid &= htons(VLAN_VID_MASK);
1035         flow->vlan_tci &= ~htons(VLAN_VID_MASK);
1036         flow->vlan_tci |= htons(VLAN_CFI) | vid;
1037     }
1038 }
1039
1040 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
1041  * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
1042  * plus CFI). */
1043 void
1044 flow_set_vlan_vid(struct flow *flow, ovs_be16 vid)
1045 {
1046     ovs_be16 mask = htons(VLAN_VID_MASK | VLAN_CFI);
1047     flow->vlan_tci &= ~mask;
1048     flow->vlan_tci |= vid & mask;
1049 }
1050
1051 /* Sets the VLAN PCP that 'flow' matches to 'pcp', which should be in the
1052  * range 0...7.
1053  *
1054  * This function has no effect on the VLAN ID that 'flow' matches.
1055  *
1056  * After calling this function, 'flow' will not match packets without a VLAN
1057  * header. */
1058 void
1059 flow_set_vlan_pcp(struct flow *flow, uint8_t pcp)
1060 {
1061     pcp &= 0x07;
1062     flow->vlan_tci &= ~htons(VLAN_PCP_MASK);
1063     flow->vlan_tci |= htons((pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
1064 }
1065
1066 /* Returns the number of MPLS LSEs present in 'flow'
1067  *
1068  * Returns 0 if the 'dl_type' of 'flow' is not an MPLS ethernet type.
1069  * Otherwise traverses 'flow''s MPLS label stack stopping at the
1070  * first entry that has the BoS bit set. If no such entry exists then
1071  * the maximum number of LSEs that can be stored in 'flow' is returned.
1072  */
1073 int
1074 flow_count_mpls_labels(const struct flow *flow, struct flow_wildcards *wc)
1075 {
1076     if (wc) {
1077         wc->masks.dl_type = OVS_BE16_MAX;
1078     }
1079     if (eth_type_mpls(flow->dl_type)) {
1080         int i;
1081         int len = FLOW_MAX_MPLS_LABELS;
1082
1083         for (i = 0; i < len; i++) {
1084             if (wc) {
1085                 wc->masks.mpls_lse[i] |= htonl(MPLS_BOS_MASK);
1086             }
1087             if (flow->mpls_lse[i] & htonl(MPLS_BOS_MASK)) {
1088                 return i + 1;
1089             }
1090         }
1091
1092         return len;
1093     } else {
1094         return 0;
1095     }
1096 }
1097
1098 /* Returns the number consecutive of MPLS LSEs, starting at the
1099  * innermost LSE, that are common in 'a' and 'b'.
1100  *
1101  * 'an' must be flow_count_mpls_labels(a).
1102  * 'bn' must be flow_count_mpls_labels(b).
1103  */
1104 int
1105 flow_count_common_mpls_labels(const struct flow *a, int an,
1106                               const struct flow *b, int bn,
1107                               struct flow_wildcards *wc)
1108 {
1109     int min_n = MIN(an, bn);
1110     if (min_n == 0) {
1111         return 0;
1112     } else {
1113         int common_n = 0;
1114         int a_last = an - 1;
1115         int b_last = bn - 1;
1116         int i;
1117
1118         for (i = 0; i < min_n; i++) {
1119             if (wc) {
1120                 wc->masks.mpls_lse[a_last - i] = OVS_BE32_MAX;
1121                 wc->masks.mpls_lse[b_last - i] = OVS_BE32_MAX;
1122             }
1123             if (a->mpls_lse[a_last - i] != b->mpls_lse[b_last - i]) {
1124                 break;
1125             } else {
1126                 common_n++;
1127             }
1128         }
1129
1130         return common_n;
1131     }
1132 }
1133
1134 /* Adds a new outermost MPLS label to 'flow' and changes 'flow''s Ethernet type
1135  * to 'mpls_eth_type', which must be an MPLS Ethertype.
1136  *
1137  * If the new label is the first MPLS label in 'flow', it is generated as;
1138  *
1139  *     - label: 2, if 'flow' is IPv6, otherwise 0.
1140  *
1141  *     - TTL: IPv4 or IPv6 TTL, if present and nonzero, otherwise 64.
1142  *
1143  *     - TC: IPv4 or IPv6 TOS, if present, otherwise 0.
1144  *
1145  *     - BoS: 1.
1146  *
1147  * If the new label is the second or label MPLS label in 'flow', it is
1148  * generated as;
1149  *
1150  *     - label: Copied from outer label.
1151  *
1152  *     - TTL: Copied from outer label.
1153  *
1154  *     - TC: Copied from outer label.
1155  *
1156  *     - BoS: 0.
1157  *
1158  * 'n' must be flow_count_mpls_labels(flow).  'n' must be less than
1159  * FLOW_MAX_MPLS_LABELS (because otherwise flow->mpls_lse[] would overflow).
1160  */
1161 void
1162 flow_push_mpls(struct flow *flow, int n, ovs_be16 mpls_eth_type,
1163                struct flow_wildcards *wc)
1164 {
1165     ovs_assert(eth_type_mpls(mpls_eth_type));
1166     ovs_assert(n < FLOW_MAX_MPLS_LABELS);
1167
1168     memset(wc->masks.mpls_lse, 0xff, sizeof wc->masks.mpls_lse);
1169     if (n) {
1170         int i;
1171
1172         for (i = n; i >= 1; i--) {
1173             flow->mpls_lse[i] = flow->mpls_lse[i - 1];
1174         }
1175         flow->mpls_lse[0] = (flow->mpls_lse[1]
1176                              & htonl(~MPLS_BOS_MASK));
1177     } else {
1178         int label = 0;          /* IPv4 Explicit Null. */
1179         int tc = 0;
1180         int ttl = 64;
1181
1182         if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1183             label = 2;
1184         }
1185
1186         if (is_ip_any(flow)) {
1187             tc = (flow->nw_tos & IP_DSCP_MASK) >> 2;
1188             wc->masks.nw_tos |= IP_DSCP_MASK;
1189
1190             if (flow->nw_ttl) {
1191                 ttl = flow->nw_ttl;
1192             }
1193             wc->masks.nw_ttl = 0xff;
1194         }
1195
1196         flow->mpls_lse[0] = set_mpls_lse_values(ttl, tc, 1, htonl(label));
1197
1198         /* Clear all L3 and L4 fields. */
1199         BUILD_ASSERT(FLOW_WC_SEQ == 25);
1200         memset((char *) flow + FLOW_SEGMENT_2_ENDS_AT, 0,
1201                sizeof(struct flow) - FLOW_SEGMENT_2_ENDS_AT);
1202     }
1203     flow->dl_type = mpls_eth_type;
1204 }
1205
1206 /* Tries to remove the outermost MPLS label from 'flow'.  Returns true if
1207  * successful, false otherwise.  On success, sets 'flow''s Ethernet type to
1208  * 'eth_type'.
1209  *
1210  * 'n' must be flow_count_mpls_labels(flow). */
1211 bool
1212 flow_pop_mpls(struct flow *flow, int n, ovs_be16 eth_type,
1213               struct flow_wildcards *wc)
1214 {
1215     int i;
1216
1217     if (n == 0) {
1218         /* Nothing to pop. */
1219         return false;
1220     } else if (n == FLOW_MAX_MPLS_LABELS
1221                && !(flow->mpls_lse[n - 1] & htonl(MPLS_BOS_MASK))) {
1222         /* Can't pop because we don't know what to fill in mpls_lse[n - 1]. */
1223         return false;
1224     }
1225
1226     memset(wc->masks.mpls_lse, 0xff, sizeof wc->masks.mpls_lse);
1227     for (i = 1; i < n; i++) {
1228         flow->mpls_lse[i - 1] = flow->mpls_lse[i];
1229     }
1230     flow->mpls_lse[n - 1] = 0;
1231     flow->dl_type = eth_type;
1232     return true;
1233 }
1234
1235 /* Sets the MPLS Label that 'flow' matches to 'label', which is interpreted
1236  * as an OpenFlow 1.1 "mpls_label" value. */
1237 void
1238 flow_set_mpls_label(struct flow *flow, int idx, ovs_be32 label)
1239 {
1240     set_mpls_lse_label(&flow->mpls_lse[idx], label);
1241 }
1242
1243 /* Sets the MPLS TTL that 'flow' matches to 'ttl', which should be in the
1244  * range 0...255. */
1245 void
1246 flow_set_mpls_ttl(struct flow *flow, int idx, uint8_t ttl)
1247 {
1248     set_mpls_lse_ttl(&flow->mpls_lse[idx], ttl);
1249 }
1250
1251 /* Sets the MPLS TC that 'flow' matches to 'tc', which should be in the
1252  * range 0...7. */
1253 void
1254 flow_set_mpls_tc(struct flow *flow, int idx, uint8_t tc)
1255 {
1256     set_mpls_lse_tc(&flow->mpls_lse[idx], tc);
1257 }
1258
1259 /* Sets the MPLS BOS bit that 'flow' matches to which should be 0 or 1. */
1260 void
1261 flow_set_mpls_bos(struct flow *flow, int idx, uint8_t bos)
1262 {
1263     set_mpls_lse_bos(&flow->mpls_lse[idx], bos);
1264 }
1265
1266 /* Sets the entire MPLS LSE. */
1267 void
1268 flow_set_mpls_lse(struct flow *flow, int idx, ovs_be32 lse)
1269 {
1270     flow->mpls_lse[idx] = lse;
1271 }
1272
1273 static void
1274 flow_compose_l4(struct ofpbuf *b, const struct flow *flow)
1275 {
1276     if (!(flow->nw_frag & FLOW_NW_FRAG_ANY)
1277         || !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1278         if (flow->nw_proto == IPPROTO_TCP) {
1279             struct tcp_header *tcp;
1280
1281             tcp = ofpbuf_put_zeros(b, sizeof *tcp);
1282             tcp->tcp_src = flow->tp_src;
1283             tcp->tcp_dst = flow->tp_dst;
1284             tcp->tcp_ctl = TCP_CTL(ntohs(flow->tcp_flags), 5);
1285             b->l7 = ofpbuf_tail(b);
1286         } else if (flow->nw_proto == IPPROTO_UDP) {
1287             struct udp_header *udp;
1288
1289             udp = ofpbuf_put_zeros(b, sizeof *udp);
1290             udp->udp_src = flow->tp_src;
1291             udp->udp_dst = flow->tp_dst;
1292             b->l7 = ofpbuf_tail(b);
1293         } else if (flow->nw_proto == IPPROTO_SCTP) {
1294             struct sctp_header *sctp;
1295
1296             sctp = ofpbuf_put_zeros(b, sizeof *sctp);
1297             sctp->sctp_src = flow->tp_src;
1298             sctp->sctp_dst = flow->tp_dst;
1299             b->l7 = ofpbuf_tail(b);
1300         } else if (flow->nw_proto == IPPROTO_ICMP) {
1301             struct icmp_header *icmp;
1302
1303             icmp = ofpbuf_put_zeros(b, sizeof *icmp);
1304             icmp->icmp_type = ntohs(flow->tp_src);
1305             icmp->icmp_code = ntohs(flow->tp_dst);
1306             icmp->icmp_csum = csum(icmp, ICMP_HEADER_LEN);
1307             b->l7 = ofpbuf_tail(b);
1308         } else if (flow->nw_proto == IPPROTO_ICMPV6) {
1309             struct icmp6_hdr *icmp;
1310
1311             icmp = ofpbuf_put_zeros(b, sizeof *icmp);
1312             icmp->icmp6_type = ntohs(flow->tp_src);
1313             icmp->icmp6_code = ntohs(flow->tp_dst);
1314
1315             if (icmp->icmp6_code == 0 &&
1316                 (icmp->icmp6_type == ND_NEIGHBOR_SOLICIT ||
1317                  icmp->icmp6_type == ND_NEIGHBOR_ADVERT)) {
1318                 struct in6_addr *nd_target;
1319                 struct nd_opt_hdr *nd_opt;
1320
1321                 nd_target = ofpbuf_put_zeros(b, sizeof *nd_target);
1322                 *nd_target = flow->nd_target;
1323
1324                 if (!eth_addr_is_zero(flow->arp_sha)) {
1325                     nd_opt = ofpbuf_put_zeros(b, 8);
1326                     nd_opt->nd_opt_len = 1;
1327                     nd_opt->nd_opt_type = ND_OPT_SOURCE_LINKADDR;
1328                     memcpy(nd_opt + 1, flow->arp_sha, ETH_ADDR_LEN);
1329                 }
1330                 if (!eth_addr_is_zero(flow->arp_tha)) {
1331                     nd_opt = ofpbuf_put_zeros(b, 8);
1332                     nd_opt->nd_opt_len = 1;
1333                     nd_opt->nd_opt_type = ND_OPT_TARGET_LINKADDR;
1334                     memcpy(nd_opt + 1, flow->arp_tha, ETH_ADDR_LEN);
1335                 }
1336             }
1337             icmp->icmp6_cksum = (OVS_FORCE uint16_t)
1338                 csum(icmp, (char *)ofpbuf_tail(b) - (char *)icmp);
1339             b->l7 = ofpbuf_tail(b);
1340         }
1341     }
1342 }
1343
1344 /* Puts into 'b' a packet that flow_extract() would parse as having the given
1345  * 'flow'.
1346  *
1347  * (This is useful only for testing, obviously, and the packet isn't really
1348  * valid. It hasn't got some checksums filled in, for one, and lots of fields
1349  * are just zeroed.) */
1350 void
1351 flow_compose(struct ofpbuf *b, const struct flow *flow)
1352 {
1353     /* eth_compose() sets l3 pointer and makes sure it is 32-bit aligned. */
1354     eth_compose(b, flow->dl_dst, flow->dl_src, ntohs(flow->dl_type), 0);
1355     if (flow->dl_type == htons(FLOW_DL_TYPE_NONE)) {
1356         struct eth_header *eth = b->l2;
1357         eth->eth_type = htons(b->size);
1358         return;
1359     }
1360
1361     if (flow->vlan_tci & htons(VLAN_CFI)) {
1362         eth_push_vlan(b, htons(ETH_TYPE_VLAN), flow->vlan_tci);
1363     }
1364
1365     if (flow->dl_type == htons(ETH_TYPE_IP)) {
1366         struct ip_header *ip;
1367
1368         ip = ofpbuf_put_zeros(b, sizeof *ip);
1369         ip->ip_ihl_ver = IP_IHL_VER(5, 4);
1370         ip->ip_tos = flow->nw_tos;
1371         ip->ip_ttl = flow->nw_ttl;
1372         ip->ip_proto = flow->nw_proto;
1373         put_16aligned_be32(&ip->ip_src, flow->nw_src);
1374         put_16aligned_be32(&ip->ip_dst, flow->nw_dst);
1375
1376         if (flow->nw_frag & FLOW_NW_FRAG_ANY) {
1377             ip->ip_frag_off |= htons(IP_MORE_FRAGMENTS);
1378             if (flow->nw_frag & FLOW_NW_FRAG_LATER) {
1379                 ip->ip_frag_off |= htons(100);
1380             }
1381         }
1382
1383         b->l4 = ofpbuf_tail(b);
1384
1385         flow_compose_l4(b, flow);
1386
1387         ip->ip_tot_len = htons((uint8_t *) b->data + b->size
1388                                - (uint8_t *) b->l3);
1389         ip->ip_csum = csum(ip, sizeof *ip);
1390     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1391         struct ovs_16aligned_ip6_hdr *nh;
1392
1393         nh = ofpbuf_put_zeros(b, sizeof *nh);
1394         put_16aligned_be32(&nh->ip6_flow, htonl(6 << 28) |
1395                            htonl(flow->nw_tos << 20) | flow->ipv6_label);
1396         nh->ip6_hlim = flow->nw_ttl;
1397         nh->ip6_nxt = flow->nw_proto;
1398
1399         memcpy(&nh->ip6_src, &flow->ipv6_src, sizeof(nh->ip6_src));
1400         memcpy(&nh->ip6_dst, &flow->ipv6_dst, sizeof(nh->ip6_dst));
1401
1402         b->l4 = ofpbuf_tail(b);
1403
1404         flow_compose_l4(b, flow);
1405
1406         nh->ip6_plen =
1407             b->l7 ? htons((uint8_t *) b->l7 - (uint8_t *) b->l4) : htons(0);
1408     } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
1409                flow->dl_type == htons(ETH_TYPE_RARP)) {
1410         struct arp_eth_header *arp;
1411
1412         b->l3 = arp = ofpbuf_put_zeros(b, sizeof *arp);
1413         arp->ar_hrd = htons(1);
1414         arp->ar_pro = htons(ETH_TYPE_IP);
1415         arp->ar_hln = ETH_ADDR_LEN;
1416         arp->ar_pln = 4;
1417         arp->ar_op = htons(flow->nw_proto);
1418
1419         if (flow->nw_proto == ARP_OP_REQUEST ||
1420             flow->nw_proto == ARP_OP_REPLY) {
1421             put_16aligned_be32(&arp->ar_spa, flow->nw_src);
1422             put_16aligned_be32(&arp->ar_tpa, flow->nw_dst);
1423             memcpy(arp->ar_sha, flow->arp_sha, ETH_ADDR_LEN);
1424             memcpy(arp->ar_tha, flow->arp_tha, ETH_ADDR_LEN);
1425         }
1426     }
1427
1428     if (eth_type_mpls(flow->dl_type)) {
1429         int n;
1430
1431         b->l2_5 = b->l3;
1432         for (n = 1; n < FLOW_MAX_MPLS_LABELS; n++) {
1433             if (flow->mpls_lse[n - 1] & htonl(MPLS_BOS_MASK)) {
1434                 break;
1435             }
1436         }
1437         while (n > 0) {
1438             push_mpls(b, flow->dl_type, flow->mpls_lse[--n]);
1439         }
1440     }
1441 }
1442 \f
1443 /* Compressed flow. */
1444
1445 static int
1446 miniflow_n_values(const struct miniflow *flow)
1447 {
1448     return count_1bits(flow->map);
1449 }
1450
1451 static uint32_t *
1452 miniflow_alloc_values(struct miniflow *flow, int n)
1453 {
1454     if (n <= MINI_N_INLINE) {
1455         return flow->inline_values;
1456     } else {
1457         COVERAGE_INC(miniflow_malloc);
1458         return xmalloc(n * sizeof *flow->values);
1459     }
1460 }
1461
1462 /* Completes an initialization of 'dst' as a miniflow copy of 'src' begun by
1463  * the caller.  The caller must have already initialized 'dst->map' properly
1464  * to indicate the significant uint32_t elements of 'src'.  'n' must be the
1465  * number of 1-bits in 'dst->map'.
1466  *
1467  * Normally the significant elements are the ones that are non-zero.  However,
1468  * when a miniflow is initialized from a (mini)mask, the values can be zeroes,
1469  * so that the flow and mask always have the same maps.
1470  *
1471  * This function initializes 'dst->values' (either inline if possible or with
1472  * malloc() otherwise) and copies the uint32_t elements of 'src' indicated by
1473  * 'dst->map' into it. */
1474 static void
1475 miniflow_init__(struct miniflow *dst, const struct flow *src, int n)
1476 {
1477     const uint32_t *src_u32 = (const uint32_t *) src;
1478     unsigned int ofs;
1479     uint64_t map;
1480
1481     dst->values = miniflow_alloc_values(dst, n);
1482     ofs = 0;
1483     for (map = dst->map; map; map = zero_rightmost_1bit(map)) {
1484         dst->values[ofs++] = src_u32[raw_ctz(map)];
1485     }
1486 }
1487
1488 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1489  * with miniflow_destroy(). */
1490 void
1491 miniflow_init(struct miniflow *dst, const struct flow *src)
1492 {
1493     const uint32_t *src_u32 = (const uint32_t *) src;
1494     unsigned int i;
1495     int n;
1496
1497     /* Initialize dst->map, counting the number of nonzero elements. */
1498     n = 0;
1499     dst->map = 0;
1500
1501     for (i = 0; i < FLOW_U32S; i++) {
1502         if (src_u32[i]) {
1503             dst->map |= UINT64_C(1) << i;
1504             n++;
1505         }
1506     }
1507
1508     miniflow_init__(dst, src, n);
1509 }
1510
1511 /* Initializes 'dst' as a copy of 'src', using 'mask->map' as 'dst''s map.  The
1512  * caller must eventually free 'dst' with miniflow_destroy(). */
1513 void
1514 miniflow_init_with_minimask(struct miniflow *dst, const struct flow *src,
1515                             const struct minimask *mask)
1516 {
1517     dst->map = mask->masks.map;
1518     miniflow_init__(dst, src, miniflow_n_values(dst));
1519 }
1520
1521 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1522  * with miniflow_destroy(). */
1523 void
1524 miniflow_clone(struct miniflow *dst, const struct miniflow *src)
1525 {
1526     int n = miniflow_n_values(src);
1527     dst->map = src->map;
1528     dst->values = miniflow_alloc_values(dst, n);
1529     memcpy(dst->values, src->values, n * sizeof *dst->values);
1530 }
1531
1532 /* Initializes 'dst' with the data in 'src', destroying 'src'.
1533  * The caller must eventually free 'dst' with miniflow_destroy(). */
1534 void
1535 miniflow_move(struct miniflow *dst, struct miniflow *src)
1536 {
1537     if (src->values == src->inline_values) {
1538         dst->values = dst->inline_values;
1539         memcpy(dst->values, src->values,
1540                miniflow_n_values(src) * sizeof *dst->values);
1541     } else {
1542         dst->values = src->values;
1543     }
1544     dst->map = src->map;
1545 }
1546
1547 /* Frees any memory owned by 'flow'.  Does not free the storage in which 'flow'
1548  * itself resides; the caller is responsible for that. */
1549 void
1550 miniflow_destroy(struct miniflow *flow)
1551 {
1552     if (flow->values != flow->inline_values) {
1553         free(flow->values);
1554     }
1555 }
1556
1557 /* Initializes 'dst' as a copy of 'src'. */
1558 void
1559 miniflow_expand(const struct miniflow *src, struct flow *dst)
1560 {
1561     memset(dst, 0, sizeof *dst);
1562     flow_union_with_miniflow(dst, src);
1563 }
1564
1565 static const uint32_t *
1566 miniflow_get__(const struct miniflow *flow, unsigned int u32_ofs)
1567 {
1568     if (!(flow->map & (UINT64_C(1) << u32_ofs))) {
1569         static const uint32_t zero = 0;
1570         return &zero;
1571     }
1572     return flow->values +
1573            count_1bits(flow->map & ((UINT64_C(1) << u32_ofs) - 1));
1574 }
1575
1576 /* Returns the uint32_t that would be at byte offset '4 * u32_ofs' if 'flow'
1577  * were expanded into a "struct flow". */
1578 uint32_t
1579 miniflow_get(const struct miniflow *flow, unsigned int u32_ofs)
1580 {
1581     return *miniflow_get__(flow, u32_ofs);
1582 }
1583
1584 /* Returns the ovs_be16 that would be at byte offset 'u8_ofs' if 'flow' were
1585  * expanded into a "struct flow". */
1586 static ovs_be16
1587 miniflow_get_be16(const struct miniflow *flow, unsigned int u8_ofs)
1588 {
1589     const uint32_t *u32p = miniflow_get__(flow, u8_ofs / 4);
1590     const ovs_be16 *be16p = (const ovs_be16 *) u32p;
1591     return be16p[u8_ofs % 4 != 0];
1592 }
1593
1594 /* Returns the VID within the vlan_tci member of the "struct flow" represented
1595  * by 'flow'. */
1596 uint16_t
1597 miniflow_get_vid(const struct miniflow *flow)
1598 {
1599     ovs_be16 tci = miniflow_get_be16(flow, offsetof(struct flow, vlan_tci));
1600     return vlan_tci_to_vid(tci);
1601 }
1602
1603 /* Returns true if 'a' and 'b' are the same flow, false otherwise.  */
1604 bool
1605 miniflow_equal(const struct miniflow *a, const struct miniflow *b)
1606 {
1607     const uint32_t *ap = a->values;
1608     const uint32_t *bp = b->values;
1609     const uint64_t a_map = a->map;
1610     const uint64_t b_map = b->map;
1611     uint64_t map;
1612
1613     if (a_map == b_map) {
1614         for (map = a_map; map; map = zero_rightmost_1bit(map)) {
1615             if (*ap++ != *bp++) {
1616                 return false;
1617             }
1618         }
1619     } else {
1620         for (map = a_map | b_map; map; map = zero_rightmost_1bit(map)) {
1621             uint64_t bit = rightmost_1bit(map);
1622             uint64_t a_value = a_map & bit ? *ap++ : 0;
1623             uint64_t b_value = b_map & bit ? *bp++ : 0;
1624
1625             if (a_value != b_value) {
1626                 return false;
1627             }
1628         }
1629     }
1630
1631     return true;
1632 }
1633
1634 /* Returns true if 'a' and 'b' are equal at the places where there are 1-bits
1635  * in 'mask', false if they differ. */
1636 bool
1637 miniflow_equal_in_minimask(const struct miniflow *a, const struct miniflow *b,
1638                            const struct minimask *mask)
1639 {
1640     const uint32_t *p;
1641     uint64_t map;
1642
1643     p = mask->masks.values;
1644
1645     for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1646         int ofs = raw_ctz(map);
1647
1648         if ((miniflow_get(a, ofs) ^ miniflow_get(b, ofs)) & *p) {
1649             return false;
1650         }
1651         p++;
1652     }
1653
1654     return true;
1655 }
1656
1657 /* Returns true if 'a' and 'b' are equal at the places where there are 1-bits
1658  * in 'mask', false if they differ. */
1659 bool
1660 miniflow_equal_flow_in_minimask(const struct miniflow *a, const struct flow *b,
1661                                 const struct minimask *mask)
1662 {
1663     const uint32_t *b_u32 = (const uint32_t *) b;
1664     const uint32_t *p;
1665     uint64_t map;
1666
1667     p = mask->masks.values;
1668
1669     for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1670         int ofs = raw_ctz(map);
1671
1672         if ((miniflow_get(a, ofs) ^ b_u32[ofs]) & *p) {
1673             return false;
1674         }
1675         p++;
1676     }
1677
1678     return true;
1679 }
1680
1681 /* Returns a hash value for 'flow', given 'basis'. */
1682 uint32_t
1683 miniflow_hash(const struct miniflow *flow, uint32_t basis)
1684 {
1685     const uint32_t *p = flow->values;
1686     uint32_t hash = basis;
1687     uint64_t hash_map = 0;
1688     uint64_t map;
1689
1690     for (map = flow->map; map; map = zero_rightmost_1bit(map)) {
1691         if (*p) {
1692             hash = mhash_add(hash, *p);
1693             hash_map |= rightmost_1bit(map);
1694         }
1695         p++;
1696     }
1697     hash = mhash_add(hash, hash_map);
1698     hash = mhash_add(hash, hash_map >> 32);
1699
1700     return mhash_finish(hash, p - flow->values);
1701 }
1702
1703 /* Returns a hash value for the bits of 'flow' where there are 1-bits in
1704  * 'mask', given 'basis'.
1705  *
1706  * The hash values returned by this function are the same as those returned by
1707  * flow_hash_in_minimask(), only the form of the arguments differ. */
1708 uint32_t
1709 miniflow_hash_in_minimask(const struct miniflow *flow,
1710                           const struct minimask *mask, uint32_t basis)
1711 {
1712     const uint32_t *p = mask->masks.values;
1713     uint32_t hash;
1714     uint64_t map;
1715
1716     hash = basis;
1717
1718     for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1719         hash = mhash_add(hash, miniflow_get(flow, raw_ctz(map)) & *p++);
1720     }
1721
1722     return mhash_finish(hash, (p - mask->masks.values) * 4);
1723 }
1724
1725 /* Returns a hash value for the bits of 'flow' where there are 1-bits in
1726  * 'mask', given 'basis'.
1727  *
1728  * The hash values returned by this function are the same as those returned by
1729  * miniflow_hash_in_minimask(), only the form of the arguments differ. */
1730 uint32_t
1731 flow_hash_in_minimask(const struct flow *flow, const struct minimask *mask,
1732                       uint32_t basis)
1733 {
1734     const uint32_t *flow_u32 = (const uint32_t *)flow;
1735     const uint32_t *p = mask->masks.values;
1736     uint32_t hash;
1737     uint64_t map;
1738
1739     hash = basis;
1740     for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1741         hash = mhash_add(hash, flow_u32[raw_ctz(map)] & *p++);
1742     }
1743
1744     return mhash_finish(hash, (p - mask->masks.values) * 4);
1745 }
1746
1747 /* Returns a hash value for the bits of range [start, end) in 'flow',
1748  * where there are 1-bits in 'mask', given 'hash'.
1749  *
1750  * The hash values returned by this function are the same as those returned by
1751  * minimatch_hash_range(), only the form of the arguments differ. */
1752 uint32_t
1753 flow_hash_in_minimask_range(const struct flow *flow,
1754                             const struct minimask *mask,
1755                             uint8_t start, uint8_t end, uint32_t *basis)
1756 {
1757     const uint32_t *flow_u32 = (const uint32_t *)flow;
1758     unsigned int offset;
1759     uint64_t map = miniflow_get_map_in_range(&mask->masks, start, end,
1760                                              &offset);
1761     const uint32_t *p = mask->masks.values + offset;
1762     uint32_t hash = *basis;
1763
1764     for (; map; map = zero_rightmost_1bit(map)) {
1765         hash = mhash_add(hash, flow_u32[raw_ctz(map)] & *p++);
1766     }
1767
1768     *basis = hash; /* Allow continuation from the unfinished value. */
1769     return mhash_finish(hash, (p - mask->masks.values) * 4);
1770 }
1771
1772 \f
1773 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1774  * with minimask_destroy(). */
1775 void
1776 minimask_init(struct minimask *mask, const struct flow_wildcards *wc)
1777 {
1778     miniflow_init(&mask->masks, &wc->masks);
1779 }
1780
1781 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1782  * with minimask_destroy(). */
1783 void
1784 minimask_clone(struct minimask *dst, const struct minimask *src)
1785 {
1786     miniflow_clone(&dst->masks, &src->masks);
1787 }
1788
1789 /* Initializes 'dst' with the data in 'src', destroying 'src'.
1790  * The caller must eventually free 'dst' with minimask_destroy(). */
1791 void
1792 minimask_move(struct minimask *dst, struct minimask *src)
1793 {
1794     miniflow_move(&dst->masks, &src->masks);
1795 }
1796
1797 /* Initializes 'dst_' as the bit-wise "and" of 'a_' and 'b_'.
1798  *
1799  * The caller must provide room for FLOW_U32S "uint32_t"s in 'storage', for use
1800  * by 'dst_'.  The caller must *not* free 'dst_' with minimask_destroy(). */
1801 void
1802 minimask_combine(struct minimask *dst_,
1803                  const struct minimask *a_, const struct minimask *b_,
1804                  uint32_t storage[FLOW_U32S])
1805 {
1806     struct miniflow *dst = &dst_->masks;
1807     const struct miniflow *a = &a_->masks;
1808     const struct miniflow *b = &b_->masks;
1809     uint64_t map;
1810     int n = 0;
1811
1812     dst->values = storage;
1813
1814     dst->map = 0;
1815     for (map = a->map & b->map; map; map = zero_rightmost_1bit(map)) {
1816         int ofs = raw_ctz(map);
1817         uint32_t mask = miniflow_get(a, ofs) & miniflow_get(b, ofs);
1818
1819         if (mask) {
1820             dst->map |= rightmost_1bit(map);
1821             dst->values[n++] = mask;
1822         }
1823     }
1824 }
1825
1826 /* Frees any memory owned by 'mask'.  Does not free the storage in which 'mask'
1827  * itself resides; the caller is responsible for that. */
1828 void
1829 minimask_destroy(struct minimask *mask)
1830 {
1831     miniflow_destroy(&mask->masks);
1832 }
1833
1834 /* Initializes 'dst' as a copy of 'src'. */
1835 void
1836 minimask_expand(const struct minimask *mask, struct flow_wildcards *wc)
1837 {
1838     miniflow_expand(&mask->masks, &wc->masks);
1839 }
1840
1841 /* Returns the uint32_t that would be at byte offset '4 * u32_ofs' if 'mask'
1842  * were expanded into a "struct flow_wildcards". */
1843 uint32_t
1844 minimask_get(const struct minimask *mask, unsigned int u32_ofs)
1845 {
1846     return miniflow_get(&mask->masks, u32_ofs);
1847 }
1848
1849 /* Returns the VID mask within the vlan_tci member of the "struct
1850  * flow_wildcards" represented by 'mask'. */
1851 uint16_t
1852 minimask_get_vid_mask(const struct minimask *mask)
1853 {
1854     return miniflow_get_vid(&mask->masks);
1855 }
1856
1857 /* Returns true if 'a' and 'b' are the same flow mask, false otherwise.  */
1858 bool
1859 minimask_equal(const struct minimask *a, const struct minimask *b)
1860 {
1861     return miniflow_equal(&a->masks, &b->masks);
1862 }
1863
1864 /* Returns a hash value for 'mask', given 'basis'. */
1865 uint32_t
1866 minimask_hash(const struct minimask *mask, uint32_t basis)
1867 {
1868     return miniflow_hash(&mask->masks, basis);
1869 }
1870
1871 /* Returns true if at least one bit is wildcarded in 'a_' but not in 'b_',
1872  * false otherwise. */
1873 bool
1874 minimask_has_extra(const struct minimask *a_, const struct minimask *b_)
1875 {
1876     const struct miniflow *a = &a_->masks;
1877     const struct miniflow *b = &b_->masks;
1878     uint64_t map;
1879
1880     for (map = a->map | b->map; map; map = zero_rightmost_1bit(map)) {
1881         int ofs = raw_ctz(map);
1882         uint32_t a_u32 = miniflow_get(a, ofs);
1883         uint32_t b_u32 = miniflow_get(b, ofs);
1884
1885         if ((a_u32 & b_u32) != b_u32) {
1886             return true;
1887         }
1888     }
1889
1890     return false;
1891 }
1892
1893 /* Returns true if 'mask' matches every packet, false if 'mask' fixes any bits
1894  * or fields. */
1895 bool
1896 minimask_is_catchall(const struct minimask *mask_)
1897 {
1898     const struct miniflow *mask = &mask_->masks;
1899     const uint32_t *p = mask->values;
1900     uint64_t map;
1901
1902     for (map = mask->map; map; map = zero_rightmost_1bit(map)) {
1903         if (*p++) {
1904             return false;
1905         }
1906     }
1907     return true;
1908 }