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