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 format_flags_masked(struct ds *ds, const char *name,
 591                     const char *(*bit_to_string)(uint32_t), uint32_t flags,
 592                     uint32_t mask)
 593 {
 594     if (name) {
 595         ds_put_format(ds, "%s=", name);
 596     }
 597     while (mask) {
 598         uint32_t bit = rightmost_1bit(mask);
 599         const char *s = bit_to_string(bit);
 600
 601         ds_put_format(ds, "%s%s", (flags & bit) ? "+" : "-",
 602                       s ? s : "[Unknown]");
 603         mask &= ~bit;
 604     }
 605 }
 606
 607 void
 608 flow_format(struct ds *ds, const struct flow *flow)
 609 {
 610     struct match match;
 611
 612     match_wc_init(&match, flow);
 613     match_format(&match, ds, OFP_DEFAULT_PRIORITY);
 614 }
 615
 616 void
 617 flow_print(FILE *stream, const struct flow *flow)
 618 {
 619     char *s = flow_to_string(flow);
 620     fputs(s, stream);
 621     free(s);
 622 }
 623 \f
 624 /* flow_wildcards functions. */
 625
 626 /* Initializes 'wc' as a set of wildcards that matches every packet. */
 627 void
 628 flow_wildcards_init_catchall(struct flow_wildcards *wc)
 629 {
 630     memset(&wc->masks, 0, sizeof wc->masks);
 631 }
 632
 633 /* Returns true if 'wc' matches every packet, false if 'wc' fixes any bits or
 634  * fields. */
 635 bool
 636 flow_wildcards_is_catchall(const struct flow_wildcards *wc)
 637 {
 638     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
 639     size_t i;
 640
 641     for (i = 0; i < FLOW_U32S; i++) {
 642         if (wc_u32[i]) {
 643             return false;
 644         }
 645     }
 646     return true;
 647 }
 648
 649 /* Sets 'dst' as the bitwise AND of wildcards in 'src1' and 'src2'.
 650  * That is, a bit or a field is wildcarded in 'dst' if it is wildcarded
 651  * in 'src1' or 'src2' or both.  */
 652 void
 653 flow_wildcards_and(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 /* Sets 'dst' as the bitwise OR of wildcards in 'src1' and 'src2'.  That
 668  * is, a bit or a field is wildcarded in 'dst' if it is neither
 669  * wildcarded in 'src1' nor 'src2'. */
 670 void
 671 flow_wildcards_or(struct flow_wildcards *dst,
 672                   const struct flow_wildcards *src1,
 673                   const struct flow_wildcards *src2)
 674 {
 675     uint32_t *dst_u32 = (uint32_t *) &dst->masks;
 676     const uint32_t *src1_u32 = (const uint32_t *) &src1->masks;
 677     const uint32_t *src2_u32 = (const uint32_t *) &src2->masks;
 678     size_t i;
 679
 680     for (i = 0; i < FLOW_U32S; i++) {
 681         dst_u32[i] = src1_u32[i] | src2_u32[i];
 682     }
 683 }
 684
 685 /* Perform a bitwise OR of miniflow 'src' flow data with the equivalent
 686  * fields in 'dst', storing the result in 'dst'. */
 687 static void
 688 flow_union_with_miniflow(struct flow *dst, const struct miniflow *src)
 689 {
 690     uint32_t *dst_u32 = (uint32_t *) dst;
 691     const uint32_t *p = src->values;
 692     uint64_t map;
 693
 694     for (map = src->map; map; map = zero_rightmost_1bit(map)) {
 695         dst_u32[raw_ctz(map)] |= *p++;
 696     }
 697 }
 698
 699 /* Fold minimask 'mask''s wildcard mask into 'wc's wildcard mask. */
 700 void
 701 flow_wildcards_fold_minimask(struct flow_wildcards *wc,
 702                              const struct minimask *mask)
 703 {
 704     flow_union_with_miniflow(&wc->masks, &mask->masks);
 705 }
 706
 707 inline uint64_t
 708 miniflow_get_map_in_range(const struct miniflow *miniflow,
 709                           uint8_t start, uint8_t end, const uint32_t **data)
 710 {
 711     uint64_t map = miniflow->map;
 712     uint32_t *p = miniflow->values;
 713
 714     if (start > 0) {
 715         uint64_t msk = (UINT64_C(1) << start) - 1; /* 'start' LSBs set */
 716         p += count_1bits(map & msk);  /* Skip to start. */
 717         map &= ~msk;
 718     }
 719     if (end < FLOW_U32S) {
 720         uint64_t msk = (UINT64_C(1) << end) - 1; /* 'end' LSBs set */
 721         map &= msk;
 722     }
 723
 724     *data = p;
 725     return map;
 726 }
 727
 728 /* Fold minimask 'mask''s wildcard mask into 'wc's wildcard mask
 729  * in range [start, end). */
 730 void
 731 flow_wildcards_fold_minimask_range(struct flow_wildcards *wc,
 732                                    const struct minimask *mask,
 733                                    uint8_t start, uint8_t end)
 734 {
 735     uint32_t *dst_u32 = (uint32_t *)&wc->masks;
 736     const uint32_t *p;
 737     uint64_t map = miniflow_get_map_in_range(&mask->masks, start, end, &p);
 738
 739     for (; map; map = zero_rightmost_1bit(map)) {
 740         dst_u32[raw_ctz(map)] |= *p++;
 741     }
 742 }
 743
 744 /* Returns a hash of the wildcards in 'wc'. */
 745 uint32_t
 746 flow_wildcards_hash(const struct flow_wildcards *wc, uint32_t basis)
 747 {
 748     return flow_hash(&wc->masks, basis);
 749 }
 750
 751 /* Returns true if 'a' and 'b' represent the same wildcards, false if they are
 752  * different. */
 753 bool
 754 flow_wildcards_equal(const struct flow_wildcards *a,
 755                      const struct flow_wildcards *b)
 756 {
 757     return flow_equal(&a->masks, &b->masks);
 758 }
 759
 760 /* Returns true if at least one bit or field is wildcarded in 'a' but not in
 761  * 'b', false otherwise. */
 762 bool
 763 flow_wildcards_has_extra(const struct flow_wildcards *a,
 764                          const struct flow_wildcards *b)
 765 {
 766     const uint32_t *a_u32 = (const uint32_t *) &a->masks;
 767     const uint32_t *b_u32 = (const uint32_t *) &b->masks;
 768     size_t i;
 769
 770     for (i = 0; i < FLOW_U32S; i++) {
 771         if ((a_u32[i] & b_u32[i]) != b_u32[i]) {
 772             return true;
 773         }
 774     }
 775     return false;
 776 }
 777
 778 /* Returns true if 'a' and 'b' are equal, except that 0-bits (wildcarded bits)
 779  * in 'wc' do not need to be equal in 'a' and 'b'. */
 780 bool
 781 flow_equal_except(const struct flow *a, const struct flow *b,
 782                   const struct flow_wildcards *wc)
 783 {
 784     const uint32_t *a_u32 = (const uint32_t *) a;
 785     const uint32_t *b_u32 = (const uint32_t *) b;
 786     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
 787     size_t i;
 788
 789     for (i = 0; i < FLOW_U32S; i++) {
 790         if ((a_u32[i] ^ b_u32[i]) & wc_u32[i]) {
 791             return false;
 792         }
 793     }
 794     return true;
 795 }
 796
 797 /* Sets the wildcard mask for register 'idx' in 'wc' to 'mask'.
 798  * (A 0-bit indicates a wildcard bit.) */
 799 void
 800 flow_wildcards_set_reg_mask(struct flow_wildcards *wc, int idx, uint32_t mask)
 801 {
 802     wc->masks.regs[idx] = mask;
 803 }
 804
 805 /* Hashes 'flow' based on its L2 through L4 protocol information. */
 806 uint32_t
 807 flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis)
 808 {
 809     struct {
 810         union {
 811             ovs_be32 ipv4_addr;
 812             struct in6_addr ipv6_addr;
 813         };
 814         ovs_be16 eth_type;
 815         ovs_be16 vlan_tci;
 816         ovs_be16 tp_port;
 817         uint8_t eth_addr[ETH_ADDR_LEN];
 818         uint8_t ip_proto;
 819     } fields;
 820
 821     int i;
 822
 823     memset(&fields, 0, sizeof fields);
 824     for (i = 0; i < ETH_ADDR_LEN; i++) {
 825         fields.eth_addr[i] = flow->dl_src[i] ^ flow->dl_dst[i];
 826     }
 827     fields.vlan_tci = flow->vlan_tci & htons(VLAN_VID_MASK);
 828     fields.eth_type = flow->dl_type;
 829
 830     /* UDP source and destination port are not taken into account because they
 831      * will not necessarily be symmetric in a bidirectional flow. */
 832     if (fields.eth_type == htons(ETH_TYPE_IP)) {
 833         fields.ipv4_addr = flow->nw_src ^ flow->nw_dst;
 834         fields.ip_proto = flow->nw_proto;
 835         if (fields.ip_proto == IPPROTO_TCP || fields.ip_proto == IPPROTO_SCTP) {
 836             fields.tp_port = flow->tp_src ^ flow->tp_dst;
 837         }
 838     } else if (fields.eth_type == htons(ETH_TYPE_IPV6)) {
 839         const uint8_t *a = &flow->ipv6_src.s6_addr[0];
 840         const uint8_t *b = &flow->ipv6_dst.s6_addr[0];
 841         uint8_t *ipv6_addr = &fields.ipv6_addr.s6_addr[0];
 842
 843         for (i=0; i<16; i++) {
 844             ipv6_addr[i] = a[i] ^ b[i];
 845         }
 846         fields.ip_proto = flow->nw_proto;
 847         if (fields.ip_proto == IPPROTO_TCP || fields.ip_proto == IPPROTO_SCTP) {
 848             fields.tp_port = flow->tp_src ^ flow->tp_dst;
 849         }
 850     }
 851     return jhash_bytes(&fields, sizeof fields, basis);
 852 }
 853
 854 /* Initialize a flow with random fields that matter for nx_hash_fields. */
 855 void
 856 flow_random_hash_fields(struct flow *flow)
 857 {
 858     uint16_t rnd = random_uint16();
 859
 860     /* Initialize to all zeros. */
 861     memset(flow, 0, sizeof *flow);
 862
 863     eth_addr_random(flow->dl_src);
 864     eth_addr_random(flow->dl_dst);
 865
 866     flow->vlan_tci = (OVS_FORCE ovs_be16) (random_uint16() & VLAN_VID_MASK);
 867
 868     /* Make most of the random flows IPv4, some IPv6, and rest random. */
 869     flow->dl_type = rnd < 0x8000 ? htons(ETH_TYPE_IP) :
 870         rnd < 0xc000 ? htons(ETH_TYPE_IPV6) : (OVS_FORCE ovs_be16)rnd;
 871
 872     if (dl_type_is_ip_any(flow->dl_type)) {
 873         if (flow->dl_type == htons(ETH_TYPE_IP)) {
 874             flow->nw_src = (OVS_FORCE ovs_be32)random_uint32();
 875             flow->nw_dst = (OVS_FORCE ovs_be32)random_uint32();
 876         } else {
 877             random_bytes(&flow->ipv6_src, sizeof flow->ipv6_src);
 878             random_bytes(&flow->ipv6_dst, sizeof flow->ipv6_dst);
 879         }
 880         /* Make most of IP flows TCP, some UDP or SCTP, and rest random. */
 881         rnd = random_uint16();
 882         flow->nw_proto = rnd < 0x8000 ? IPPROTO_TCP :
 883             rnd < 0xc000 ? IPPROTO_UDP :
 884             rnd < 0xd000 ? IPPROTO_SCTP : (uint8_t)rnd;
 885         if (flow->nw_proto == IPPROTO_TCP ||
 886             flow->nw_proto == IPPROTO_UDP ||
 887             flow->nw_proto == IPPROTO_SCTP) {
 888             flow->tp_src = (OVS_FORCE ovs_be16)random_uint16();
 889             flow->tp_dst = (OVS_FORCE ovs_be16)random_uint16();
 890         }
 891     }
 892 }
 893
 894 /* Masks the fields in 'wc' that are used by the flow hash 'fields'. */
 895 void
 896 flow_mask_hash_fields(const struct flow *flow, struct flow_wildcards *wc,
 897                       enum nx_hash_fields fields)
 898 {
 899     switch (fields) {
 900     case NX_HASH_FIELDS_ETH_SRC:
 901         memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
 902         break;
 903
 904     case NX_HASH_FIELDS_SYMMETRIC_L4:
 905         memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
 906         memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
 907         if (flow->dl_type == htons(ETH_TYPE_IP)) {
 908             memset(&wc->masks.nw_src, 0xff, sizeof wc->masks.nw_src);
 909             memset(&wc->masks.nw_dst, 0xff, sizeof wc->masks.nw_dst);
 910         } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
 911             memset(&wc->masks.ipv6_src, 0xff, sizeof wc->masks.ipv6_src);
 912             memset(&wc->masks.ipv6_dst, 0xff, sizeof wc->masks.ipv6_dst);
 913         }
 914         if (is_ip_any(flow)) {
 915             memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
 916             memset(&wc->masks.tp_src, 0xff, sizeof wc->masks.tp_src);
 917             memset(&wc->masks.tp_dst, 0xff, sizeof wc->masks.tp_dst);
 918         }
 919         wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
 920         break;
 921
 922     default:
 923         NOT_REACHED();
 924     }
 925 }
 926
 927 /* Hashes the portions of 'flow' designated by 'fields'. */
 928 uint32_t
 929 flow_hash_fields(const struct flow *flow, enum nx_hash_fields fields,
 930                  uint16_t basis)
 931 {
 932     switch (fields) {
 933
 934     case NX_HASH_FIELDS_ETH_SRC:
 935         return jhash_bytes(flow->dl_src, sizeof flow->dl_src, basis);
 936
 937     case NX_HASH_FIELDS_SYMMETRIC_L4:
 938         return flow_hash_symmetric_l4(flow, basis);
 939     }
 940
 941     NOT_REACHED();
 942 }
 943
 944 /* Returns a string representation of 'fields'. */
 945 const char *
 946 flow_hash_fields_to_str(enum nx_hash_fields fields)
 947 {
 948     switch (fields) {
 949     case NX_HASH_FIELDS_ETH_SRC: return "eth_src";
 950     case NX_HASH_FIELDS_SYMMETRIC_L4: return "symmetric_l4";
 951     default: return "<unknown>";
 952     }
 953 }
 954
 955 /* Returns true if the value of 'fields' is supported. Otherwise false. */
 956 bool
 957 flow_hash_fields_valid(enum nx_hash_fields fields)
 958 {
 959     return fields == NX_HASH_FIELDS_ETH_SRC
 960         || fields == NX_HASH_FIELDS_SYMMETRIC_L4;
 961 }
 962
 963 /* Returns a hash value for the bits of 'flow' that are active based on
 964  * 'wc', given 'basis'. */
 965 uint32_t
 966 flow_hash_in_wildcards(const struct flow *flow,
 967                        const struct flow_wildcards *wc, uint32_t basis)
 968 {
 969     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
 970     const uint32_t *flow_u32 = (const uint32_t *) flow;
 971     uint32_t hash;
 972     size_t i;
 973
 974     hash = basis;
 975     for (i = 0; i < FLOW_U32S; i++) {
 976         hash = mhash_add(hash, flow_u32[i] & wc_u32[i]);
 977     }
 978     return mhash_finish(hash, 4 * FLOW_U32S);
 979 }
 980
 981 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
 982  * OpenFlow 1.0 "dl_vlan" value:
 983  *
 984  *      - If it is in the range 0...4095, 'flow->vlan_tci' is set to match
 985  *        that VLAN.  Any existing PCP match is unchanged (it becomes 0 if
 986  *        'flow' previously matched packets without a VLAN header).
 987  *
 988  *      - If it is OFP_VLAN_NONE, 'flow->vlan_tci' is set to match a packet
 989  *        without a VLAN tag.
 990  *
 991  *      - Other values of 'vid' should not be used. */
 992 void
 993 flow_set_dl_vlan(struct flow *flow, ovs_be16 vid)
 994 {
 995     if (vid == htons(OFP10_VLAN_NONE)) {
 996         flow->vlan_tci = htons(0);
 997     } else {
 998         vid &= htons(VLAN_VID_MASK);
 999         flow->vlan_tci &= ~htons(VLAN_VID_MASK);
1000         flow->vlan_tci |= htons(VLAN_CFI) | vid;
1001     }
1002 }
1003
1004 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
1005  * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
1006  * plus CFI). */
1007 void
1008 flow_set_vlan_vid(struct flow *flow, ovs_be16 vid)
1009 {
1010     ovs_be16 mask = htons(VLAN_VID_MASK | VLAN_CFI);
1011     flow->vlan_tci &= ~mask;
1012     flow->vlan_tci |= vid & mask;
1013 }
1014
1015 /* Sets the VLAN PCP that 'flow' matches to 'pcp', which should be in the
1016  * range 0...7.
1017  *
1018  * This function has no effect on the VLAN ID that 'flow' matches.
1019  *
1020  * After calling this function, 'flow' will not match packets without a VLAN
1021  * header. */
1022 void
1023 flow_set_vlan_pcp(struct flow *flow, uint8_t pcp)
1024 {
1025     pcp &= 0x07;
1026     flow->vlan_tci &= ~htons(VLAN_PCP_MASK);
1027     flow->vlan_tci |= htons((pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
1028 }
1029
1030 /* Sets the MPLS Label that 'flow' matches to 'label', which is interpreted
1031  * as an OpenFlow 1.1 "mpls_label" value. */
1032 void
1033 flow_set_mpls_label(struct flow *flow, ovs_be32 label)
1034 {
1035     set_mpls_lse_label(&flow->mpls_lse, label);
1036 }
1037
1038 /* Sets the MPLS TTL that 'flow' matches to 'ttl', which should be in the
1039  * range 0...255. */
1040 void
1041 flow_set_mpls_ttl(struct flow *flow, uint8_t ttl)
1042 {
1043     set_mpls_lse_ttl(&flow->mpls_lse, ttl);
1044 }
1045
1046 /* Sets the MPLS TC that 'flow' matches to 'tc', which should be in the
1047  * range 0...7. */
1048 void
1049 flow_set_mpls_tc(struct flow *flow, uint8_t tc)
1050 {
1051     set_mpls_lse_tc(&flow->mpls_lse, tc);
1052 }
1053
1054 /* Sets the MPLS BOS bit that 'flow' matches to which should be 0 or 1. */
1055 void
1056 flow_set_mpls_bos(struct flow *flow, uint8_t bos)
1057 {
1058     set_mpls_lse_bos(&flow->mpls_lse, bos);
1059 }
1060
1061 /* Puts into 'b' a packet that flow_extract() would parse as having the given
1062  * 'flow'.
1063  *
1064  * (This is useful only for testing, obviously, and the packet isn't really
1065  * valid. It hasn't got some checksums filled in, for one, and lots of fields
1066  * are just zeroed.) */
1067 void
1068 flow_compose(struct ofpbuf *b, const struct flow *flow)
1069 {
1070     eth_compose(b, flow->dl_dst, flow->dl_src, ntohs(flow->dl_type), 0);
1071     if (flow->dl_type == htons(FLOW_DL_TYPE_NONE)) {
1072         struct eth_header *eth = b->l2;
1073         eth->eth_type = htons(b->size);
1074         return;
1075     }
1076
1077     if (flow->vlan_tci & htons(VLAN_CFI)) {
1078         eth_push_vlan(b, flow->vlan_tci);
1079     }
1080
1081     if (flow->dl_type == htons(ETH_TYPE_IP)) {
1082         struct ip_header *ip;
1083
1084         b->l3 = ip = ofpbuf_put_zeros(b, sizeof *ip);
1085         ip->ip_ihl_ver = IP_IHL_VER(5, 4);
1086         ip->ip_tos = flow->nw_tos;
1087         ip->ip_ttl = flow->nw_ttl;
1088         ip->ip_proto = flow->nw_proto;
1089         put_16aligned_be32(&ip->ip_src, flow->nw_src);
1090         put_16aligned_be32(&ip->ip_dst, flow->nw_dst);
1091
1092         if (flow->nw_frag & FLOW_NW_FRAG_ANY) {
1093             ip->ip_frag_off |= htons(IP_MORE_FRAGMENTS);
1094             if (flow->nw_frag & FLOW_NW_FRAG_LATER) {
1095                 ip->ip_frag_off |= htons(100);
1096             }
1097         }
1098         if (!(flow->nw_frag & FLOW_NW_FRAG_ANY)
1099             || !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1100             if (flow->nw_proto == IPPROTO_TCP) {
1101                 struct tcp_header *tcp;
1102
1103                 b->l4 = tcp = ofpbuf_put_zeros(b, sizeof *tcp);
1104                 tcp->tcp_src = flow->tp_src;
1105                 tcp->tcp_dst = flow->tp_dst;
1106                 tcp->tcp_ctl = TCP_CTL(ntohs(flow->tcp_flags), 5);
1107             } else if (flow->nw_proto == IPPROTO_UDP) {
1108                 struct udp_header *udp;
1109
1110                 b->l4 = udp = ofpbuf_put_zeros(b, sizeof *udp);
1111                 udp->udp_src = flow->tp_src;
1112                 udp->udp_dst = flow->tp_dst;
1113             } else if (flow->nw_proto == IPPROTO_SCTP) {
1114                 struct sctp_header *sctp;
1115
1116                 b->l4 = sctp = ofpbuf_put_zeros(b, sizeof *sctp);
1117                 sctp->sctp_src = flow->tp_src;
1118                 sctp->sctp_dst = flow->tp_dst;
1119             } else if (flow->nw_proto == IPPROTO_ICMP) {
1120                 struct icmp_header *icmp;
1121
1122                 b->l4 = icmp = ofpbuf_put_zeros(b, sizeof *icmp);
1123                 icmp->icmp_type = ntohs(flow->tp_src);
1124                 icmp->icmp_code = ntohs(flow->tp_dst);
1125                 icmp->icmp_csum = csum(icmp, ICMP_HEADER_LEN);
1126             }
1127             b->l7 = ofpbuf_tail(b);
1128         }
1129
1130         ip = b->l3;
1131         ip->ip_tot_len = htons((uint8_t *) b->data + b->size
1132                                - (uint8_t *) b->l3);
1133         ip->ip_csum = csum(ip, sizeof *ip);
1134     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1135         /* XXX */
1136     } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
1137                flow->dl_type == htons(ETH_TYPE_RARP)) {
1138         struct arp_eth_header *arp;
1139
1140         b->l3 = arp = ofpbuf_put_zeros(b, sizeof *arp);
1141         arp->ar_hrd = htons(1);
1142         arp->ar_pro = htons(ETH_TYPE_IP);
1143         arp->ar_hln = ETH_ADDR_LEN;
1144         arp->ar_pln = 4;
1145         arp->ar_op = htons(flow->nw_proto);
1146
1147         if (flow->nw_proto == ARP_OP_REQUEST ||
1148             flow->nw_proto == ARP_OP_REPLY) {
1149             put_16aligned_be32(&arp->ar_spa, flow->nw_src);
1150             put_16aligned_be32(&arp->ar_tpa, flow->nw_dst);
1151             memcpy(arp->ar_sha, flow->arp_sha, ETH_ADDR_LEN);
1152             memcpy(arp->ar_tha, flow->arp_tha, ETH_ADDR_LEN);
1153         }
1154     }
1155
1156     if (eth_type_mpls(flow->dl_type)) {
1157         b->l2_5 = b->l3;
1158         push_mpls(b, flow->dl_type, flow->mpls_lse);
1159     }
1160 }
1161 \f
1162 /* Compressed flow. */
1163
1164 static int
1165 miniflow_n_values(const struct miniflow *flow)
1166 {
1167     return count_1bits(flow->map);
1168 }
1169
1170 static uint32_t *
1171 miniflow_alloc_values(struct miniflow *flow, int n)
1172 {
1173     if (n <= MINI_N_INLINE) {
1174         return flow->inline_values;
1175     } else {
1176         COVERAGE_INC(miniflow_malloc);
1177         return xmalloc(n * sizeof *flow->values);
1178     }
1179 }
1180
1181 /* Completes an initialization of 'dst' as a miniflow copy of 'src' begun by
1182  * the caller.  The caller must have already initialized 'dst->map' properly
1183  * to indicate the nonzero uint32_t elements of 'src'.  'n' must be the number
1184  * of 1-bits in 'dst->map'.
1185  *
1186  * This function initializes 'dst->values' (either inline if possible or with
1187  * malloc() otherwise) and copies the nonzero uint32_t elements of 'src' into
1188  * it. */
1189 static void
1190 miniflow_init__(struct miniflow *dst, const struct flow *src, int n)
1191 {
1192     const uint32_t *src_u32 = (const uint32_t *) src;
1193     unsigned int ofs;
1194     uint64_t map;
1195
1196     dst->values = miniflow_alloc_values(dst, n);
1197     ofs = 0;
1198     for (map = dst->map; map; map = zero_rightmost_1bit(map)) {
1199         dst->values[ofs++] = src_u32[raw_ctz(map)];
1200     }
1201 }
1202
1203 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1204  * with miniflow_destroy(). */
1205 void
1206 miniflow_init(struct miniflow *dst, const struct flow *src)
1207 {
1208     const uint32_t *src_u32 = (const uint32_t *) src;
1209     unsigned int i;
1210     int n;
1211
1212     /* Initialize dst->map, counting the number of nonzero elements. */
1213     n = 0;
1214     dst->map = 0;
1215
1216     for (i = 0; i < FLOW_U32S; i++) {
1217         if (src_u32[i]) {
1218             dst->map |= UINT64_C(1) << i;
1219             n++;
1220         }
1221     }
1222
1223     miniflow_init__(dst, src, n);
1224 }
1225
1226 /* Initializes 'dst' as a copy of 'src', using 'mask->map' as 'dst''s map.  The
1227  * caller must eventually free 'dst' with miniflow_destroy(). */
1228 void
1229 miniflow_init_with_minimask(struct miniflow *dst, const struct flow *src,
1230                             const struct minimask *mask)
1231 {
1232     dst->map = mask->masks.map;
1233     miniflow_init__(dst, src, miniflow_n_values(dst));
1234 }
1235
1236 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1237  * with miniflow_destroy(). */
1238 void
1239 miniflow_clone(struct miniflow *dst, const struct miniflow *src)
1240 {
1241     int n = miniflow_n_values(src);
1242     dst->map = src->map;
1243     dst->values = miniflow_alloc_values(dst, n);
1244     memcpy(dst->values, src->values, n * sizeof *dst->values);
1245 }
1246
1247 /* Initializes 'dst' with the data in 'src', destroying 'src'.
1248  * The caller must eventually free 'dst' with miniflow_destroy(). */
1249 void
1250 miniflow_move(struct miniflow *dst, struct miniflow *src)
1251 {
1252     if (src->values == src->inline_values) {
1253         dst->values = dst->inline_values;
1254         memcpy(dst->values, src->values,
1255                miniflow_n_values(src) * sizeof *dst->values);
1256     } else {
1257         dst->values = src->values;
1258     }
1259     dst->map = src->map;
1260 }
1261
1262 /* Frees any memory owned by 'flow'.  Does not free the storage in which 'flow'
1263  * itself resides; the caller is responsible for that. */
1264 void
1265 miniflow_destroy(struct miniflow *flow)
1266 {
1267     if (flow->values != flow->inline_values) {
1268         free(flow->values);
1269     }
1270 }
1271
1272 /* Initializes 'dst' as a copy of 'src'. */
1273 void
1274 miniflow_expand(const struct miniflow *src, struct flow *dst)
1275 {
1276     memset(dst, 0, sizeof *dst);
1277     flow_union_with_miniflow(dst, src);
1278 }
1279
1280 static const uint32_t *
1281 miniflow_get__(const struct miniflow *flow, unsigned int u32_ofs)
1282 {
1283     if (!(flow->map & (UINT64_C(1) << u32_ofs))) {
1284         static const uint32_t zero = 0;
1285         return &zero;
1286     }
1287     return flow->values +
1288            count_1bits(flow->map & ((UINT64_C(1) << u32_ofs) - 1));
1289 }
1290
1291 /* Returns the uint32_t that would be at byte offset '4 * u32_ofs' if 'flow'
1292  * were expanded into a "struct flow". */
1293 uint32_t
1294 miniflow_get(const struct miniflow *flow, unsigned int u32_ofs)
1295 {
1296     return *miniflow_get__(flow, u32_ofs);
1297 }
1298
1299 /* Returns the ovs_be16 that would be at byte offset 'u8_ofs' if 'flow' were
1300  * expanded into a "struct flow". */
1301 static ovs_be16
1302 miniflow_get_be16(const struct miniflow *flow, unsigned int u8_ofs)
1303 {
1304     const uint32_t *u32p = miniflow_get__(flow, u8_ofs / 4);
1305     const ovs_be16 *be16p = (const ovs_be16 *) u32p;
1306     return be16p[u8_ofs % 4 != 0];
1307 }
1308
1309 /* Returns the VID within the vlan_tci member of the "struct flow" represented
1310  * by 'flow'. */
1311 uint16_t
1312 miniflow_get_vid(const struct miniflow *flow)
1313 {
1314     ovs_be16 tci = miniflow_get_be16(flow, offsetof(struct flow, vlan_tci));
1315     return vlan_tci_to_vid(tci);
1316 }
1317
1318 /* Returns true if 'a' and 'b' are the same flow, false otherwise.  */
1319 bool
1320 miniflow_equal(const struct miniflow *a, const struct miniflow *b)
1321 {
1322     const uint32_t *ap = a->values;
1323     const uint32_t *bp = b->values;
1324     const uint64_t a_map = a->map;
1325     const uint64_t b_map = b->map;
1326     uint64_t map;
1327
1328     if (a_map == b_map) {
1329         for (map = a_map; map; map = zero_rightmost_1bit(map)) {
1330             if (*ap++ != *bp++) {
1331                 return false;
1332             }
1333         }
1334     } else {
1335         for (map = a_map | b_map; map; map = zero_rightmost_1bit(map)) {
1336             uint64_t bit = rightmost_1bit(map);
1337             uint64_t a_value = a_map & bit ? *ap++ : 0;
1338             uint64_t b_value = b_map & bit ? *bp++ : 0;
1339
1340             if (a_value != b_value) {
1341                 return false;
1342             }
1343         }
1344     }
1345
1346     return true;
1347 }
1348
1349 /* Returns true if 'a' and 'b' are equal at the places where there are 1-bits
1350  * in 'mask', false if they differ. */
1351 bool
1352 miniflow_equal_in_minimask(const struct miniflow *a, const struct miniflow *b,
1353                            const struct minimask *mask)
1354 {
1355     const uint32_t *p;
1356     uint64_t map;
1357
1358     p = mask->masks.values;
1359
1360     for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1361         int ofs = raw_ctz(map);
1362
1363         if ((miniflow_get(a, ofs) ^ miniflow_get(b, ofs)) & *p) {
1364             return false;
1365         }
1366         p++;
1367     }
1368
1369     return true;
1370 }
1371
1372 /* Returns true if 'a' and 'b' are equal at the places where there are 1-bits
1373  * in 'mask', false if they differ. */
1374 bool
1375 miniflow_equal_flow_in_minimask(const struct miniflow *a, const struct flow *b,
1376                                 const struct minimask *mask)
1377 {
1378     const uint32_t *b_u32 = (const uint32_t *) b;
1379     const uint32_t *p;
1380     uint64_t map;
1381
1382     p = mask->masks.values;
1383
1384     for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1385         int ofs = raw_ctz(map);
1386
1387         if ((miniflow_get(a, ofs) ^ b_u32[ofs]) & *p) {
1388             return false;
1389         }
1390         p++;
1391     }
1392
1393     return true;
1394 }
1395
1396 /* Returns a hash value for 'flow', given 'basis'. */
1397 uint32_t
1398 miniflow_hash(const struct miniflow *flow, uint32_t basis)
1399 {
1400     const uint32_t *p = flow->values;
1401     uint32_t hash = basis;
1402     uint64_t hash_map = 0;
1403     uint64_t map;
1404
1405     for (map = flow->map; map; map = zero_rightmost_1bit(map)) {
1406         if (*p) {
1407             hash = mhash_add(hash, *p);
1408             hash_map |= rightmost_1bit(map);
1409         }
1410         p++;
1411     }
1412     hash = mhash_add(hash, hash_map);
1413     hash = mhash_add(hash, hash_map >> 32);
1414
1415     return mhash_finish(hash, p - flow->values);
1416 }
1417
1418 /* Returns a hash value for the bits of 'flow' where there are 1-bits in
1419  * 'mask', given 'basis'.
1420  *
1421  * The hash values returned by this function are the same as those returned by
1422  * flow_hash_in_minimask(), only the form of the arguments differ. */
1423 uint32_t
1424 miniflow_hash_in_minimask(const struct miniflow *flow,
1425                           const struct minimask *mask, uint32_t basis)
1426 {
1427     const uint32_t *p = mask->masks.values;
1428     uint32_t hash;
1429     uint64_t map;
1430
1431     hash = basis;
1432
1433     for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1434         if (*p) {
1435             int ofs = raw_ctz(map);
1436             hash = mhash_add(hash, miniflow_get(flow, ofs) & *p);
1437         }
1438         p++;
1439     }
1440
1441     return mhash_finish(hash, (p - mask->masks.values) * 4);
1442 }
1443
1444 /* Returns a hash value for the bits of 'flow' where there are 1-bits in
1445  * 'mask', given 'basis'.
1446  *
1447  * The hash values returned by this function are the same as those returned by
1448  * miniflow_hash_in_minimask(), only the form of the arguments differ. */
1449 uint32_t
1450 flow_hash_in_minimask(const struct flow *flow, const struct minimask *mask,
1451                       uint32_t basis)
1452 {
1453     const uint32_t *flow_u32 = (const uint32_t *)flow;
1454     const uint32_t *p = mask->masks.values;
1455     uint32_t hash;
1456     uint64_t map;
1457
1458     hash = basis;
1459     for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1460         if (*p) {
1461             hash = mhash_add(hash, flow_u32[raw_ctz(map)] & *p);
1462         }
1463         p++;
1464     }
1465
1466     return mhash_finish(hash, (p - mask->masks.values) * 4);
1467 }
1468
1469 /* Returns a hash value for the bits of range [start, end) in 'flow',
1470  * where there are 1-bits in 'mask', given 'hash'.
1471  *
1472  * The hash values returned by this function are the same as those returned by
1473  * minimatch_hash_range(), only the form of the arguments differ. */
1474 uint32_t
1475 flow_hash_in_minimask_range(const struct flow *flow,
1476                             const struct minimask *mask,
1477                             uint8_t start, uint8_t end, uint32_t *basis)
1478 {
1479     const uint32_t *flow_u32 = (const uint32_t *)flow;
1480     const uint32_t *p;
1481     uint64_t map = miniflow_get_map_in_range(&mask->masks, start, end, &p);
1482     uint32_t hash = *basis;
1483
1484     for (; map; map = zero_rightmost_1bit(map)) {
1485         if (*p) {
1486             hash = mhash_add(hash, flow_u32[raw_ctz(map)] & *p);
1487         }
1488         p++;
1489     }
1490
1491     *basis = hash; /* Allow continuation from the unfinished value. */
1492     return mhash_finish(hash, (p - mask->masks.values) * 4);
1493 }
1494
1495 \f
1496 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1497  * with minimask_destroy(). */
1498 void
1499 minimask_init(struct minimask *mask, const struct flow_wildcards *wc)
1500 {
1501     miniflow_init(&mask->masks, &wc->masks);
1502 }
1503
1504 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1505  * with minimask_destroy(). */
1506 void
1507 minimask_clone(struct minimask *dst, const struct minimask *src)
1508 {
1509     miniflow_clone(&dst->masks, &src->masks);
1510 }
1511
1512 /* Initializes 'dst' with the data in 'src', destroying 'src'.
1513  * The caller must eventually free 'dst' with minimask_destroy(). */
1514 void
1515 minimask_move(struct minimask *dst, struct minimask *src)
1516 {
1517     miniflow_move(&dst->masks, &src->masks);
1518 }
1519
1520 /* Initializes 'dst_' as the bit-wise "and" of 'a_' and 'b_'.
1521  *
1522  * The caller must provide room for FLOW_U32S "uint32_t"s in 'storage', for use
1523  * by 'dst_'.  The caller must *not* free 'dst_' with minimask_destroy(). */
1524 void
1525 minimask_combine(struct minimask *dst_,
1526                  const struct minimask *a_, const struct minimask *b_,
1527                  uint32_t storage[FLOW_U32S])
1528 {
1529     struct miniflow *dst = &dst_->masks;
1530     const struct miniflow *a = &a_->masks;
1531     const struct miniflow *b = &b_->masks;
1532     uint64_t map;
1533     int n = 0;
1534
1535     dst->values = storage;
1536
1537     dst->map = 0;
1538     for (map = a->map & b->map; map; map = zero_rightmost_1bit(map)) {
1539         int ofs = raw_ctz(map);
1540         uint32_t mask = miniflow_get(a, ofs) & miniflow_get(b, ofs);
1541
1542         if (mask) {
1543             dst->map |= rightmost_1bit(map);
1544             dst->values[n++] = mask;
1545         }
1546     }
1547 }
1548
1549 /* Frees any memory owned by 'mask'.  Does not free the storage in which 'mask'
1550  * itself resides; the caller is responsible for that. */
1551 void
1552 minimask_destroy(struct minimask *mask)
1553 {
1554     miniflow_destroy(&mask->masks);
1555 }
1556
1557 /* Initializes 'dst' as a copy of 'src'. */
1558 void
1559 minimask_expand(const struct minimask *mask, struct flow_wildcards *wc)
1560 {
1561     miniflow_expand(&mask->masks, &wc->masks);
1562 }
1563
1564 /* Returns the uint32_t that would be at byte offset '4 * u32_ofs' if 'mask'
1565  * were expanded into a "struct flow_wildcards". */
1566 uint32_t
1567 minimask_get(const struct minimask *mask, unsigned int u32_ofs)
1568 {
1569     return miniflow_get(&mask->masks, u32_ofs);
1570 }
1571
1572 /* Returns the VID mask within the vlan_tci member of the "struct
1573  * flow_wildcards" represented by 'mask'. */
1574 uint16_t
1575 minimask_get_vid_mask(const struct minimask *mask)
1576 {
1577     return miniflow_get_vid(&mask->masks);
1578 }
1579
1580 /* Returns true if 'a' and 'b' are the same flow mask, false otherwise.  */
1581 bool
1582 minimask_equal(const struct minimask *a, const struct minimask *b)
1583 {
1584     return miniflow_equal(&a->masks, &b->masks);
1585 }
1586
1587 /* Returns a hash value for 'mask', given 'basis'. */
1588 uint32_t
1589 minimask_hash(const struct minimask *mask, uint32_t basis)
1590 {
1591     return miniflow_hash(&mask->masks, basis);
1592 }
1593
1594 /* Returns true if at least one bit is wildcarded in 'a_' but not in 'b_',
1595  * false otherwise. */
1596 bool
1597 minimask_has_extra(const struct minimask *a_, const struct minimask *b_)
1598 {
1599     const struct miniflow *a = &a_->masks;
1600     const struct miniflow *b = &b_->masks;
1601     uint64_t map;
1602
1603     for (map = a->map | b->map; map; map = zero_rightmost_1bit(map)) {
1604         int ofs = raw_ctz(map);
1605         uint32_t a_u32 = miniflow_get(a, ofs);
1606         uint32_t b_u32 = miniflow_get(b, ofs);
1607
1608         if ((a_u32 & b_u32) != b_u32) {
1609             return true;
1610         }
1611     }
1612
1613     return false;
1614 }
1615
1616 /* Returns true if 'mask' matches every packet, false if 'mask' fixes any bits
1617  * or fields. */
1618 bool
1619 minimask_is_catchall(const struct minimask *mask_)
1620 {
1621     const struct miniflow *mask = &mask_->masks;
1622     const uint32_t *p = mask->values;
1623     uint64_t map;
1624
1625     for (map = mask->map; map; map = zero_rightmost_1bit(map)) {
1626         if (*p++) {
1627             return false;
1628         }
1629     }
1630     return true;
1631 }