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