lib/flow.c

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