lib/flow.c

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