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