Use ODP ports in dpif layer and below.
[openvswitch] / lib / flow.c
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 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 <assert.h>
20 #include <errno.h>
21 #include <inttypes.h>
22 #include <limits.h>
23 #include <netinet/in.h>
24 #include <netinet/icmp6.h>
25 #include <netinet/ip6.h>
26 #include <stdint.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include "byte-order.h"
30 #include "coverage.h"
31 #include "csum.h"
32 #include "dynamic-string.h"
33 #include "hash.h"
34 #include "match.h"
35 #include "ofpbuf.h"
36 #include "openflow/openflow.h"
37 #include "packets.h"
38 #include "unaligned.h"
39 #include "vlog.h"
40
41 VLOG_DEFINE_THIS_MODULE(flow);
42
43 COVERAGE_DEFINE(flow_extract);
44 COVERAGE_DEFINE(miniflow_malloc);
45
46 static struct arp_eth_header *
47 pull_arp(struct ofpbuf *packet)
48 {
49     return ofpbuf_try_pull(packet, ARP_ETH_HEADER_LEN);
50 }
51
52 static struct ip_header *
53 pull_ip(struct ofpbuf *packet)
54 {
55     if (packet->size >= IP_HEADER_LEN) {
56         struct ip_header *ip = packet->data;
57         int ip_len = IP_IHL(ip->ip_ihl_ver) * 4;
58         if (ip_len >= IP_HEADER_LEN && packet->size >= ip_len) {
59             return ofpbuf_pull(packet, ip_len);
60         }
61     }
62     return NULL;
63 }
64
65 static struct tcp_header *
66 pull_tcp(struct ofpbuf *packet)
67 {
68     if (packet->size >= TCP_HEADER_LEN) {
69         struct tcp_header *tcp = packet->data;
70         int tcp_len = TCP_OFFSET(tcp->tcp_ctl) * 4;
71         if (tcp_len >= TCP_HEADER_LEN && packet->size >= tcp_len) {
72             return ofpbuf_pull(packet, tcp_len);
73         }
74     }
75     return NULL;
76 }
77
78 static struct udp_header *
79 pull_udp(struct ofpbuf *packet)
80 {
81     return ofpbuf_try_pull(packet, UDP_HEADER_LEN);
82 }
83
84 static struct icmp_header *
85 pull_icmp(struct ofpbuf *packet)
86 {
87     return ofpbuf_try_pull(packet, ICMP_HEADER_LEN);
88 }
89
90 static struct icmp6_hdr *
91 pull_icmpv6(struct ofpbuf *packet)
92 {
93     return ofpbuf_try_pull(packet, sizeof(struct icmp6_hdr));
94 }
95
96 static void
97 parse_vlan(struct ofpbuf *b, struct flow *flow)
98 {
99     struct qtag_prefix {
100         ovs_be16 eth_type;      /* ETH_TYPE_VLAN */
101         ovs_be16 tci;
102     };
103
104     if (b->size >= sizeof(struct qtag_prefix) + sizeof(ovs_be16)) {
105         struct qtag_prefix *qp = ofpbuf_pull(b, sizeof *qp);
106         flow->vlan_tci = qp->tci | htons(VLAN_CFI);
107     }
108 }
109
110 static ovs_be16
111 parse_ethertype(struct ofpbuf *b)
112 {
113     struct llc_snap_header *llc;
114     ovs_be16 proto;
115
116     proto = *(ovs_be16 *) ofpbuf_pull(b, sizeof proto);
117     if (ntohs(proto) >= ETH_TYPE_MIN) {
118         return proto;
119     }
120
121     if (b->size < sizeof *llc) {
122         return htons(FLOW_DL_TYPE_NONE);
123     }
124
125     llc = b->data;
126     if (llc->llc.llc_dsap != LLC_DSAP_SNAP
127         || llc->llc.llc_ssap != LLC_SSAP_SNAP
128         || llc->llc.llc_cntl != LLC_CNTL_SNAP
129         || memcmp(llc->snap.snap_org, SNAP_ORG_ETHERNET,
130                   sizeof llc->snap.snap_org)) {
131         return htons(FLOW_DL_TYPE_NONE);
132     }
133
134     ofpbuf_pull(b, sizeof *llc);
135     return llc->snap.snap_type;
136 }
137
138 static int
139 parse_ipv6(struct ofpbuf *packet, struct flow *flow)
140 {
141     const struct ip6_hdr *nh;
142     ovs_be32 tc_flow;
143     int nexthdr;
144
145     nh = ofpbuf_try_pull(packet, sizeof *nh);
146     if (!nh) {
147         return EINVAL;
148     }
149
150     nexthdr = nh->ip6_nxt;
151
152     flow->ipv6_src = nh->ip6_src;
153     flow->ipv6_dst = nh->ip6_dst;
154
155     tc_flow = get_unaligned_be32(&nh->ip6_flow);
156     flow->nw_tos = ntohl(tc_flow) >> 20;
157     flow->ipv6_label = tc_flow & htonl(IPV6_LABEL_MASK);
158     flow->nw_ttl = nh->ip6_hlim;
159     flow->nw_proto = IPPROTO_NONE;
160
161     while (1) {
162         if ((nexthdr != IPPROTO_HOPOPTS)
163                 && (nexthdr != IPPROTO_ROUTING)
164                 && (nexthdr != IPPROTO_DSTOPTS)
165                 && (nexthdr != IPPROTO_AH)
166                 && (nexthdr != IPPROTO_FRAGMENT)) {
167             /* It's either a terminal header (e.g., TCP, UDP) or one we
168              * don't understand.  In either case, we're done with the
169              * packet, so use it to fill in 'nw_proto'. */
170             break;
171         }
172
173         /* We only verify that at least 8 bytes of the next header are
174          * available, but many of these headers are longer.  Ensure that
175          * accesses within the extension header are within those first 8
176          * bytes. All extension headers are required to be at least 8
177          * bytes. */
178         if (packet->size < 8) {
179             return EINVAL;
180         }
181
182         if ((nexthdr == IPPROTO_HOPOPTS)
183                 || (nexthdr == IPPROTO_ROUTING)
184                 || (nexthdr == IPPROTO_DSTOPTS)) {
185             /* These headers, while different, have the fields we care about
186              * in the same location and with the same interpretation. */
187             const struct ip6_ext *ext_hdr = packet->data;
188             nexthdr = ext_hdr->ip6e_nxt;
189             if (!ofpbuf_try_pull(packet, (ext_hdr->ip6e_len + 1) * 8)) {
190                 return EINVAL;
191             }
192         } else if (nexthdr == IPPROTO_AH) {
193             /* A standard AH definition isn't available, but the fields
194              * we care about are in the same location as the generic
195              * option header--only the header length is calculated
196              * differently. */
197             const struct ip6_ext *ext_hdr = packet->data;
198             nexthdr = ext_hdr->ip6e_nxt;
199             if (!ofpbuf_try_pull(packet, (ext_hdr->ip6e_len + 2) * 4)) {
200                return EINVAL;
201             }
202         } else if (nexthdr == IPPROTO_FRAGMENT) {
203             const struct ip6_frag *frag_hdr = packet->data;
204
205             nexthdr = frag_hdr->ip6f_nxt;
206             if (!ofpbuf_try_pull(packet, sizeof *frag_hdr)) {
207                 return EINVAL;
208             }
209
210             /* We only process the first fragment. */
211             if (frag_hdr->ip6f_offlg != htons(0)) {
212                 if ((frag_hdr->ip6f_offlg & IP6F_OFF_MASK) == htons(0)) {
213                     flow->nw_frag = FLOW_NW_FRAG_ANY;
214                 } else {
215                     flow->nw_frag |= FLOW_NW_FRAG_LATER;
216                     nexthdr = IPPROTO_FRAGMENT;
217                     break;
218                 }
219             }
220         }
221     }
222
223     flow->nw_proto = nexthdr;
224     return 0;
225 }
226
227 static void
228 parse_tcp(struct ofpbuf *packet, struct ofpbuf *b, struct flow *flow)
229 {
230     const struct tcp_header *tcp = pull_tcp(b);
231     if (tcp) {
232         flow->tp_src = tcp->tcp_src;
233         flow->tp_dst = tcp->tcp_dst;
234         packet->l7 = b->data;
235     }
236 }
237
238 static void
239 parse_udp(struct ofpbuf *packet, struct ofpbuf *b, struct flow *flow)
240 {
241     const struct udp_header *udp = pull_udp(b);
242     if (udp) {
243         flow->tp_src = udp->udp_src;
244         flow->tp_dst = udp->udp_dst;
245         packet->l7 = b->data;
246     }
247 }
248
249 static bool
250 parse_icmpv6(struct ofpbuf *b, struct flow *flow)
251 {
252     const struct icmp6_hdr *icmp = pull_icmpv6(b);
253
254     if (!icmp) {
255         return false;
256     }
257
258     /* The ICMPv6 type and code fields use the 16-bit transport port
259      * fields, so we need to store them in 16-bit network byte order. */
260     flow->tp_src = htons(icmp->icmp6_type);
261     flow->tp_dst = htons(icmp->icmp6_code);
262
263     if (icmp->icmp6_code == 0 &&
264         (icmp->icmp6_type == ND_NEIGHBOR_SOLICIT ||
265          icmp->icmp6_type == ND_NEIGHBOR_ADVERT)) {
266         const struct in6_addr *nd_target;
267
268         nd_target = ofpbuf_try_pull(b, sizeof *nd_target);
269         if (!nd_target) {
270             return false;
271         }
272         flow->nd_target = *nd_target;
273
274         while (b->size >= 8) {
275             /* The minimum size of an option is 8 bytes, which also is
276              * the size of Ethernet link-layer options. */
277             const struct nd_opt_hdr *nd_opt = b->data;
278             int opt_len = nd_opt->nd_opt_len * 8;
279
280             if (!opt_len || opt_len > b->size) {
281                 goto invalid;
282             }
283
284             /* Store the link layer address if the appropriate option is
285              * provided.  It is considered an error if the same link
286              * layer option is specified twice. */
287             if (nd_opt->nd_opt_type == ND_OPT_SOURCE_LINKADDR
288                     && opt_len == 8) {
289                 if (eth_addr_is_zero(flow->arp_sha)) {
290                     memcpy(flow->arp_sha, nd_opt + 1, ETH_ADDR_LEN);
291                 } else {
292                     goto invalid;
293                 }
294             } else if (nd_opt->nd_opt_type == ND_OPT_TARGET_LINKADDR
295                     && opt_len == 8) {
296                 if (eth_addr_is_zero(flow->arp_tha)) {
297                     memcpy(flow->arp_tha, nd_opt + 1, ETH_ADDR_LEN);
298                 } else {
299                     goto invalid;
300                 }
301             }
302
303             if (!ofpbuf_try_pull(b, opt_len)) {
304                 goto invalid;
305             }
306         }
307     }
308
309     return true;
310
311 invalid:
312     memset(&flow->nd_target, 0, sizeof(flow->nd_target));
313     memset(flow->arp_sha, 0, sizeof(flow->arp_sha));
314     memset(flow->arp_tha, 0, sizeof(flow->arp_tha));
315
316     return false;
317
318 }
319
320 /* Initializes 'flow' members from 'packet', 'skb_priority', 'tnl', and
321  * 'ofp_in_port'.
322  *
323  * Initializes 'packet' header pointers as follows:
324  *
325  *    - packet->l2 to the start of the Ethernet header.
326  *
327  *    - packet->l3 to just past the Ethernet header, or just past the
328  *      vlan_header if one is present, to the first byte of the payload of the
329  *      Ethernet frame.
330  *
331  *    - packet->l4 to just past the IPv4 header, if one is present and has a
332  *      correct length, and otherwise NULL.
333  *
334  *    - packet->l7 to just past the TCP or UDP or ICMP header, if one is
335  *      present and has a correct length, and otherwise NULL.
336  */
337 void
338 flow_extract(struct ofpbuf *packet, uint32_t skb_priority,
339              const struct flow_tnl *tnl, uint16_t ofp_in_port,
340              struct flow *flow)
341 {
342     struct ofpbuf b = *packet;
343     struct eth_header *eth;
344
345     COVERAGE_INC(flow_extract);
346
347     memset(flow, 0, sizeof *flow);
348
349     if (tnl) {
350         assert(tnl != &flow->tunnel);
351         flow->tunnel = *tnl;
352     }
353     flow->in_port = ofp_in_port;
354     flow->skb_priority = skb_priority;
355
356     packet->l2 = b.data;
357     packet->l3 = NULL;
358     packet->l4 = NULL;
359     packet->l7 = NULL;
360
361     if (b.size < sizeof *eth) {
362         return;
363     }
364
365     /* Link layer. */
366     eth = b.data;
367     memcpy(flow->dl_src, eth->eth_src, ETH_ADDR_LEN);
368     memcpy(flow->dl_dst, eth->eth_dst, ETH_ADDR_LEN);
369
370     /* dl_type, vlan_tci. */
371     ofpbuf_pull(&b, ETH_ADDR_LEN * 2);
372     if (eth->eth_type == htons(ETH_TYPE_VLAN)) {
373         parse_vlan(&b, flow);
374     }
375     flow->dl_type = parse_ethertype(&b);
376
377     /* Network layer. */
378     packet->l3 = b.data;
379     if (flow->dl_type == htons(ETH_TYPE_IP)) {
380         const struct ip_header *nh = pull_ip(&b);
381         if (nh) {
382             packet->l4 = b.data;
383
384             flow->nw_src = get_unaligned_be32(&nh->ip_src);
385             flow->nw_dst = get_unaligned_be32(&nh->ip_dst);
386             flow->nw_proto = nh->ip_proto;
387
388             flow->nw_tos = nh->ip_tos;
389             if (IP_IS_FRAGMENT(nh->ip_frag_off)) {
390                 flow->nw_frag = FLOW_NW_FRAG_ANY;
391                 if (nh->ip_frag_off & htons(IP_FRAG_OFF_MASK)) {
392                     flow->nw_frag |= FLOW_NW_FRAG_LATER;
393                 }
394             }
395             flow->nw_ttl = nh->ip_ttl;
396
397             if (!(nh->ip_frag_off & htons(IP_FRAG_OFF_MASK))) {
398                 if (flow->nw_proto == IPPROTO_TCP) {
399                     parse_tcp(packet, &b, flow);
400                 } else if (flow->nw_proto == IPPROTO_UDP) {
401                     parse_udp(packet, &b, flow);
402                 } else if (flow->nw_proto == IPPROTO_ICMP) {
403                     const struct icmp_header *icmp = pull_icmp(&b);
404                     if (icmp) {
405                         flow->tp_src = htons(icmp->icmp_type);
406                         flow->tp_dst = htons(icmp->icmp_code);
407                         packet->l7 = b.data;
408                     }
409                 }
410             }
411         }
412     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
413         if (parse_ipv6(&b, flow)) {
414             return;
415         }
416
417         packet->l4 = b.data;
418         if (flow->nw_proto == IPPROTO_TCP) {
419             parse_tcp(packet, &b, flow);
420         } else if (flow->nw_proto == IPPROTO_UDP) {
421             parse_udp(packet, &b, flow);
422         } else if (flow->nw_proto == IPPROTO_ICMPV6) {
423             if (parse_icmpv6(&b, flow)) {
424                 packet->l7 = b.data;
425             }
426         }
427     } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
428         const struct arp_eth_header *arp = pull_arp(&b);
429         if (arp && arp->ar_hrd == htons(1)
430             && arp->ar_pro == htons(ETH_TYPE_IP)
431             && arp->ar_hln == ETH_ADDR_LEN
432             && arp->ar_pln == 4) {
433             /* We only match on the lower 8 bits of the opcode. */
434             if (ntohs(arp->ar_op) <= 0xff) {
435                 flow->nw_proto = ntohs(arp->ar_op);
436             }
437
438             flow->nw_src = arp->ar_spa;
439             flow->nw_dst = arp->ar_tpa;
440             memcpy(flow->arp_sha, arp->ar_sha, ETH_ADDR_LEN);
441             memcpy(flow->arp_tha, arp->ar_tha, ETH_ADDR_LEN);
442         }
443     }
444 }
445
446 /* For every bit of a field that is wildcarded in 'wildcards', sets the
447  * corresponding bit in 'flow' to zero. */
448 void
449 flow_zero_wildcards(struct flow *flow, const struct flow_wildcards *wildcards)
450 {
451     uint32_t *flow_u32 = (uint32_t *) flow;
452     const uint32_t *wc_u32 = (const uint32_t *) &wildcards->masks;
453     size_t i;
454
455     for (i = 0; i < FLOW_U32S; i++) {
456         flow_u32[i] &= wc_u32[i];
457     }
458 }
459
460 /* Initializes 'fmd' with the metadata found in 'flow'. */
461 void
462 flow_get_metadata(const struct flow *flow, struct flow_metadata *fmd)
463 {
464     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 17);
465
466     fmd->tun_id = flow->tunnel.tun_id;
467     fmd->metadata = flow->metadata;
468     memcpy(fmd->regs, flow->regs, sizeof fmd->regs);
469     fmd->in_port = flow->in_port;
470 }
471
472 char *
473 flow_to_string(const struct flow *flow)
474 {
475     struct ds ds = DS_EMPTY_INITIALIZER;
476     flow_format(&ds, flow);
477     return ds_cstr(&ds);
478 }
479
480 void
481 flow_format(struct ds *ds, const struct flow *flow)
482 {
483     struct match match;
484
485     match_wc_init(&match, flow);
486     match_format(&match, ds, flow->skb_priority);
487 }
488
489 void
490 flow_print(FILE *stream, const struct flow *flow)
491 {
492     char *s = flow_to_string(flow);
493     fputs(s, stream);
494     free(s);
495 }
496 \f
497 /* flow_wildcards functions. */
498
499 /* Initializes 'wc' as a set of wildcards that matches every packet. */
500 void
501 flow_wildcards_init_catchall(struct flow_wildcards *wc)
502 {
503     memset(&wc->masks, 0, sizeof wc->masks);
504 }
505
506 /* Initializes 'wc' as an exact-match set of wildcards; that is, 'wc' does not
507  * wildcard any bits or fields. */
508 void
509 flow_wildcards_init_exact(struct flow_wildcards *wc)
510 {
511     memset(&wc->masks, 0xff, sizeof wc->masks);
512 }
513
514 /* Returns true if 'wc' matches every packet, false if 'wc' fixes any bits or
515  * fields. */
516 bool
517 flow_wildcards_is_catchall(const struct flow_wildcards *wc)
518 {
519     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
520     size_t i;
521
522     for (i = 0; i < FLOW_U32S; i++) {
523         if (wc_u32[i]) {
524             return false;
525         }
526     }
527     return true;
528 }
529
530 /* Initializes 'dst' as the combination of wildcards in 'src1' and 'src2'.
531  * That is, a bit or a field is wildcarded in 'dst' if it is wildcarded in
532  * 'src1' or 'src2' or both.  */
533 void
534 flow_wildcards_combine(struct flow_wildcards *dst,
535                        const struct flow_wildcards *src1,
536                        const struct flow_wildcards *src2)
537 {
538     uint32_t *dst_u32 = (uint32_t *) &dst->masks;
539     const uint32_t *src1_u32 = (const uint32_t *) &src1->masks;
540     const uint32_t *src2_u32 = (const uint32_t *) &src2->masks;
541     size_t i;
542
543     for (i = 0; i < FLOW_U32S; i++) {
544         dst_u32[i] = src1_u32[i] & src2_u32[i];
545     }
546 }
547
548 /* Returns a hash of the wildcards in 'wc'. */
549 uint32_t
550 flow_wildcards_hash(const struct flow_wildcards *wc, uint32_t basis)
551 {
552     return flow_hash(&wc->masks, basis);;
553 }
554
555 /* Returns true if 'a' and 'b' represent the same wildcards, false if they are
556  * different. */
557 bool
558 flow_wildcards_equal(const struct flow_wildcards *a,
559                      const struct flow_wildcards *b)
560 {
561     return flow_equal(&a->masks, &b->masks);
562 }
563
564 /* Returns true if at least one bit or field is wildcarded in 'a' but not in
565  * 'b', false otherwise. */
566 bool
567 flow_wildcards_has_extra(const struct flow_wildcards *a,
568                          const struct flow_wildcards *b)
569 {
570     const uint32_t *a_u32 = (const uint32_t *) &a->masks;
571     const uint32_t *b_u32 = (const uint32_t *) &b->masks;
572     size_t i;
573
574     for (i = 0; i < FLOW_U32S; i++) {
575         if ((a_u32[i] & b_u32[i]) != b_u32[i]) {
576             return true;
577         }
578     }
579     return false;
580 }
581
582 /* Returns true if 'a' and 'b' are equal, except that 0-bits (wildcarded bits)
583  * in 'wc' do not need to be equal in 'a' and 'b'. */
584 bool
585 flow_equal_except(const struct flow *a, const struct flow *b,
586                   const struct flow_wildcards *wc)
587 {
588     const uint32_t *a_u32 = (const uint32_t *) a;
589     const uint32_t *b_u32 = (const uint32_t *) b;
590     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
591     size_t i;
592
593     for (i = 0; i < FLOW_U32S; i++) {
594         if ((a_u32[i] ^ b_u32[i]) & wc_u32[i]) {
595             return false;
596         }
597     }
598     return true;
599 }
600
601 /* Sets the wildcard mask for register 'idx' in 'wc' to 'mask'.
602  * (A 0-bit indicates a wildcard bit.) */
603 void
604 flow_wildcards_set_reg_mask(struct flow_wildcards *wc, int idx, uint32_t mask)
605 {
606     wc->masks.regs[idx] = mask;
607 }
608
609 /* Hashes 'flow' based on its L2 through L4 protocol information. */
610 uint32_t
611 flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis)
612 {
613     struct {
614         union {
615             ovs_be32 ipv4_addr;
616             struct in6_addr ipv6_addr;
617         };
618         ovs_be16 eth_type;
619         ovs_be16 vlan_tci;
620         ovs_be16 tp_port;
621         uint8_t eth_addr[ETH_ADDR_LEN];
622         uint8_t ip_proto;
623     } fields;
624
625     int i;
626
627     memset(&fields, 0, sizeof fields);
628     for (i = 0; i < ETH_ADDR_LEN; i++) {
629         fields.eth_addr[i] = flow->dl_src[i] ^ flow->dl_dst[i];
630     }
631     fields.vlan_tci = flow->vlan_tci & htons(VLAN_VID_MASK);
632     fields.eth_type = flow->dl_type;
633
634     /* UDP source and destination port are not taken into account because they
635      * will not necessarily be symmetric in a bidirectional flow. */
636     if (fields.eth_type == htons(ETH_TYPE_IP)) {
637         fields.ipv4_addr = flow->nw_src ^ flow->nw_dst;
638         fields.ip_proto = flow->nw_proto;
639         if (fields.ip_proto == IPPROTO_TCP) {
640             fields.tp_port = flow->tp_src ^ flow->tp_dst;
641         }
642     } else if (fields.eth_type == htons(ETH_TYPE_IPV6)) {
643         const uint8_t *a = &flow->ipv6_src.s6_addr[0];
644         const uint8_t *b = &flow->ipv6_dst.s6_addr[0];
645         uint8_t *ipv6_addr = &fields.ipv6_addr.s6_addr[0];
646
647         for (i=0; i<16; i++) {
648             ipv6_addr[i] = a[i] ^ b[i];
649         }
650         fields.ip_proto = flow->nw_proto;
651         if (fields.ip_proto == IPPROTO_TCP) {
652             fields.tp_port = flow->tp_src ^ flow->tp_dst;
653         }
654     }
655     return hash_bytes(&fields, sizeof fields, basis);
656 }
657
658 /* Hashes the portions of 'flow' designated by 'fields'. */
659 uint32_t
660 flow_hash_fields(const struct flow *flow, enum nx_hash_fields fields,
661                  uint16_t basis)
662 {
663     switch (fields) {
664
665     case NX_HASH_FIELDS_ETH_SRC:
666         return hash_bytes(flow->dl_src, sizeof flow->dl_src, basis);
667
668     case NX_HASH_FIELDS_SYMMETRIC_L4:
669         return flow_hash_symmetric_l4(flow, basis);
670     }
671
672     NOT_REACHED();
673 }
674
675 /* Returns a string representation of 'fields'. */
676 const char *
677 flow_hash_fields_to_str(enum nx_hash_fields fields)
678 {
679     switch (fields) {
680     case NX_HASH_FIELDS_ETH_SRC: return "eth_src";
681     case NX_HASH_FIELDS_SYMMETRIC_L4: return "symmetric_l4";
682     default: return "<unknown>";
683     }
684 }
685
686 /* Returns true if the value of 'fields' is supported. Otherwise false. */
687 bool
688 flow_hash_fields_valid(enum nx_hash_fields fields)
689 {
690     return fields == NX_HASH_FIELDS_ETH_SRC
691         || fields == NX_HASH_FIELDS_SYMMETRIC_L4;
692 }
693
694 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
695  * OpenFlow 1.0 "dl_vlan" value:
696  *
697  *      - If it is in the range 0...4095, 'flow->vlan_tci' is set to match
698  *        that VLAN.  Any existing PCP match is unchanged (it becomes 0 if
699  *        'flow' previously matched packets without a VLAN header).
700  *
701  *      - If it is OFP_VLAN_NONE, 'flow->vlan_tci' is set to match a packet
702  *        without a VLAN tag.
703  *
704  *      - Other values of 'vid' should not be used. */
705 void
706 flow_set_dl_vlan(struct flow *flow, ovs_be16 vid)
707 {
708     if (vid == htons(OFP10_VLAN_NONE)) {
709         flow->vlan_tci = htons(0);
710     } else {
711         vid &= htons(VLAN_VID_MASK);
712         flow->vlan_tci &= ~htons(VLAN_VID_MASK);
713         flow->vlan_tci |= htons(VLAN_CFI) | vid;
714     }
715 }
716
717 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
718  * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
719  * plus CFI). */
720 void
721 flow_set_vlan_vid(struct flow *flow, ovs_be16 vid)
722 {
723     ovs_be16 mask = htons(VLAN_VID_MASK | VLAN_CFI);
724     flow->vlan_tci &= ~mask;
725     flow->vlan_tci |= vid & mask;
726 }
727
728 /* Sets the VLAN PCP that 'flow' matches to 'pcp', which should be in the
729  * range 0...7.
730  *
731  * This function has no effect on the VLAN ID that 'flow' matches.
732  *
733  * After calling this function, 'flow' will not match packets without a VLAN
734  * header. */
735 void
736 flow_set_vlan_pcp(struct flow *flow, uint8_t pcp)
737 {
738     pcp &= 0x07;
739     flow->vlan_tci &= ~htons(VLAN_PCP_MASK);
740     flow->vlan_tci |= htons((pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
741 }
742
743 /* Puts into 'b' a packet that flow_extract() would parse as having the given
744  * 'flow'.
745  *
746  * (This is useful only for testing, obviously, and the packet isn't really
747  * valid. It hasn't got some checksums filled in, for one, and lots of fields
748  * are just zeroed.) */
749 void
750 flow_compose(struct ofpbuf *b, const struct flow *flow)
751 {
752     eth_compose(b, flow->dl_dst, flow->dl_src, ntohs(flow->dl_type), 0);
753     if (flow->dl_type == htons(FLOW_DL_TYPE_NONE)) {
754         struct eth_header *eth = b->l2;
755         eth->eth_type = htons(b->size);
756         return;
757     }
758
759     if (flow->vlan_tci & htons(VLAN_CFI)) {
760         eth_push_vlan(b, flow->vlan_tci);
761     }
762
763     if (flow->dl_type == htons(ETH_TYPE_IP)) {
764         struct ip_header *ip;
765
766         b->l3 = ip = ofpbuf_put_zeros(b, sizeof *ip);
767         ip->ip_ihl_ver = IP_IHL_VER(5, 4);
768         ip->ip_tos = flow->nw_tos;
769         ip->ip_ttl = flow->nw_ttl;
770         ip->ip_proto = flow->nw_proto;
771         ip->ip_src = flow->nw_src;
772         ip->ip_dst = flow->nw_dst;
773
774         if (flow->nw_frag & FLOW_NW_FRAG_ANY) {
775             ip->ip_frag_off |= htons(IP_MORE_FRAGMENTS);
776             if (flow->nw_frag & FLOW_NW_FRAG_LATER) {
777                 ip->ip_frag_off |= htons(100);
778             }
779         }
780         if (!(flow->nw_frag & FLOW_NW_FRAG_ANY)
781             || !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
782             if (flow->nw_proto == IPPROTO_TCP) {
783                 struct tcp_header *tcp;
784
785                 b->l4 = tcp = ofpbuf_put_zeros(b, sizeof *tcp);
786                 tcp->tcp_src = flow->tp_src;
787                 tcp->tcp_dst = flow->tp_dst;
788                 tcp->tcp_ctl = TCP_CTL(0, 5);
789             } else if (flow->nw_proto == IPPROTO_UDP) {
790                 struct udp_header *udp;
791
792                 b->l4 = udp = ofpbuf_put_zeros(b, sizeof *udp);
793                 udp->udp_src = flow->tp_src;
794                 udp->udp_dst = flow->tp_dst;
795             } else if (flow->nw_proto == IPPROTO_ICMP) {
796                 struct icmp_header *icmp;
797
798                 b->l4 = icmp = ofpbuf_put_zeros(b, sizeof *icmp);
799                 icmp->icmp_type = ntohs(flow->tp_src);
800                 icmp->icmp_code = ntohs(flow->tp_dst);
801                 icmp->icmp_csum = csum(icmp, ICMP_HEADER_LEN);
802             }
803         }
804
805         ip = b->l3;
806         ip->ip_tot_len = htons((uint8_t *) b->data + b->size
807                                - (uint8_t *) b->l3);
808         ip->ip_csum = csum(ip, sizeof *ip);
809     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
810         /* XXX */
811     } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
812         struct arp_eth_header *arp;
813
814         b->l3 = arp = ofpbuf_put_zeros(b, sizeof *arp);
815         arp->ar_hrd = htons(1);
816         arp->ar_pro = htons(ETH_TYPE_IP);
817         arp->ar_hln = ETH_ADDR_LEN;
818         arp->ar_pln = 4;
819         arp->ar_op = htons(flow->nw_proto);
820
821         if (flow->nw_proto == ARP_OP_REQUEST ||
822             flow->nw_proto == ARP_OP_REPLY) {
823             arp->ar_spa = flow->nw_src;
824             arp->ar_tpa = flow->nw_dst;
825             memcpy(arp->ar_sha, flow->arp_sha, ETH_ADDR_LEN);
826             memcpy(arp->ar_tha, flow->arp_tha, ETH_ADDR_LEN);
827         }
828     }
829 }
830 \f
831 /* Compressed flow. */
832
833 static int
834 miniflow_n_values(const struct miniflow *flow)
835 {
836     int n, i;
837
838     n = 0;
839     for (i = 0; i < MINI_N_MAPS; i++) {
840         n += popcount(flow->map[i]);
841     }
842     return n;
843 }
844
845 static uint32_t *
846 miniflow_alloc_values(struct miniflow *flow, int n)
847 {
848     if (n <= MINI_N_INLINE) {
849         return flow->inline_values;
850     } else {
851         COVERAGE_INC(miniflow_malloc);
852         return xmalloc(n * sizeof *flow->values);
853     }
854 }
855
856 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
857  * with miniflow_destroy(). */
858 void
859 miniflow_init(struct miniflow *dst, const struct flow *src)
860 {
861     const uint32_t *src_u32 = (const uint32_t *) src;
862     unsigned int ofs;
863     unsigned int i;
864     int n;
865
866     /* Initialize dst->map, counting the number of nonzero elements. */
867     n = 0;
868     memset(dst->map, 0, sizeof dst->map);
869     for (i = 0; i < FLOW_U32S; i++) {
870         if (src_u32[i]) {
871             dst->map[i / 32] |= 1u << (i % 32);
872             n++;
873         }
874     }
875
876     /* Initialize dst->values. */
877     dst->values = miniflow_alloc_values(dst, n);
878     ofs = 0;
879     for (i = 0; i < MINI_N_MAPS; i++) {
880         uint32_t map;
881
882         for (map = dst->map[i]; map; map = zero_rightmost_1bit(map)) {
883             dst->values[ofs++] = src_u32[raw_ctz(map) + i * 32];
884         }
885     }
886 }
887
888 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
889  * with miniflow_destroy(). */
890 void
891 miniflow_clone(struct miniflow *dst, const struct miniflow *src)
892 {
893     int n = miniflow_n_values(src);
894     memcpy(dst->map, src->map, sizeof dst->map);
895     dst->values = miniflow_alloc_values(dst, n);
896     memcpy(dst->values, src->values, n * sizeof *dst->values);
897 }
898
899 /* Frees any memory owned by 'flow'.  Does not free the storage in which 'flow'
900  * itself resides; the caller is responsible for that. */
901 void
902 miniflow_destroy(struct miniflow *flow)
903 {
904     if (flow->values != flow->inline_values) {
905         free(flow->values);
906     }
907 }
908
909 /* Initializes 'dst' as a copy of 'src'. */
910 void
911 miniflow_expand(const struct miniflow *src, struct flow *dst)
912 {
913     uint32_t *dst_u32 = (uint32_t *) dst;
914     int ofs;
915     int i;
916
917     memset(dst_u32, 0, sizeof *dst);
918
919     ofs = 0;
920     for (i = 0; i < MINI_N_MAPS; i++) {
921         uint32_t map;
922
923         for (map = src->map[i]; map; map = zero_rightmost_1bit(map)) {
924             dst_u32[raw_ctz(map) + i * 32] = src->values[ofs++];
925         }
926     }
927 }
928
929 static const uint32_t *
930 miniflow_get__(const struct miniflow *flow, unsigned int u32_ofs)
931 {
932     if (!(flow->map[u32_ofs / 32] & (1u << (u32_ofs % 32)))) {
933         static const uint32_t zero = 0;
934         return &zero;
935     } else {
936         const uint32_t *p = flow->values;
937
938         BUILD_ASSERT(MINI_N_MAPS == 2);
939         if (u32_ofs < 32) {
940             p += popcount(flow->map[0] & ((1u << u32_ofs) - 1));
941         } else {
942             p += popcount(flow->map[0]);
943             p += popcount(flow->map[1] & ((1u << (u32_ofs - 32)) - 1));
944         }
945         return p;
946     }
947 }
948
949 /* Returns the uint32_t that would be at byte offset '4 * u32_ofs' if 'flow'
950  * were expanded into a "struct flow". */
951 uint32_t
952 miniflow_get(const struct miniflow *flow, unsigned int u32_ofs)
953 {
954     return *miniflow_get__(flow, u32_ofs);
955 }
956
957 /* Returns the ovs_be16 that would be at byte offset 'u8_ofs' if 'flow' were
958  * expanded into a "struct flow". */
959 static ovs_be16
960 miniflow_get_be16(const struct miniflow *flow, unsigned int u8_ofs)
961 {
962     const uint32_t *u32p = miniflow_get__(flow, u8_ofs / 4);
963     const ovs_be16 *be16p = (const ovs_be16 *) u32p;
964     return be16p[u8_ofs % 4 != 0];
965 }
966
967 /* Returns the VID within the vlan_tci member of the "struct flow" represented
968  * by 'flow'. */
969 uint16_t
970 miniflow_get_vid(const struct miniflow *flow)
971 {
972     ovs_be16 tci = miniflow_get_be16(flow, offsetof(struct flow, vlan_tci));
973     return vlan_tci_to_vid(tci);
974 }
975
976 /* Returns true if 'a' and 'b' are the same flow, false otherwise.  */
977 bool
978 miniflow_equal(const struct miniflow *a, const struct miniflow *b)
979 {
980     int i;
981
982     for (i = 0; i < MINI_N_MAPS; i++) {
983         if (a->map[i] != b->map[i]) {
984             return false;
985         }
986     }
987
988     return !memcmp(a->values, b->values,
989                    miniflow_n_values(a) * sizeof *a->values);
990 }
991
992 /* Returns true if 'a' and 'b' are equal at the places where there are 1-bits
993  * in 'mask', false if they differ. */
994 bool
995 miniflow_equal_in_minimask(const struct miniflow *a, const struct miniflow *b,
996                            const struct minimask *mask)
997 {
998     const uint32_t *p;
999     int i;
1000
1001     p = mask->masks.values;
1002     for (i = 0; i < MINI_N_MAPS; i++) {
1003         uint32_t map;
1004
1005         for (map = mask->masks.map[i]; map; map = zero_rightmost_1bit(map)) {
1006             int ofs = raw_ctz(map) + i * 32;
1007
1008             if ((miniflow_get(a, ofs) ^ miniflow_get(b, ofs)) & *p) {
1009                 return false;
1010             }
1011             p++;
1012         }
1013     }
1014
1015     return true;
1016 }
1017
1018 /* Returns true if 'a' and 'b' are equal at the places where there are 1-bits
1019  * in 'mask', false if they differ. */
1020 bool
1021 miniflow_equal_flow_in_minimask(const struct miniflow *a, const struct flow *b,
1022                                 const struct minimask *mask)
1023 {
1024     const uint32_t *b_u32 = (const uint32_t *) b;
1025     const uint32_t *p;
1026     int i;
1027
1028     p = mask->masks.values;
1029     for (i = 0; i < MINI_N_MAPS; i++) {
1030         uint32_t map;
1031
1032         for (map = mask->masks.map[i]; map; map = zero_rightmost_1bit(map)) {
1033             int ofs = raw_ctz(map) + i * 32;
1034
1035             if ((miniflow_get(a, ofs) ^ b_u32[ofs]) & *p) {
1036                 return false;
1037             }
1038             p++;
1039         }
1040     }
1041
1042     return true;
1043 }
1044
1045 /* Returns a hash value for 'flow', given 'basis'. */
1046 uint32_t
1047 miniflow_hash(const struct miniflow *flow, uint32_t basis)
1048 {
1049     BUILD_ASSERT_DECL(MINI_N_MAPS == 2);
1050     return hash_3words(flow->map[0], flow->map[1],
1051                        hash_words(flow->values, miniflow_n_values(flow),
1052                                   basis));
1053 }
1054
1055 /* Returns a hash value for the bits of 'flow' where there are 1-bits in
1056  * 'mask', given 'basis'.
1057  *
1058  * The hash values returned by this function are the same as those returned by
1059  * flow_hash_in_minimask(), only the form of the arguments differ. */
1060 uint32_t
1061 miniflow_hash_in_minimask(const struct miniflow *flow,
1062                           const struct minimask *mask, uint32_t basis)
1063 {
1064     const uint32_t *p = mask->masks.values;
1065     uint32_t hash;
1066     int i;
1067
1068     hash = basis;
1069     for (i = 0; i < MINI_N_MAPS; i++) {
1070         uint32_t map;
1071
1072         for (map = mask->masks.map[i]; map; map = zero_rightmost_1bit(map)) {
1073             int ofs = raw_ctz(map) + i * 32;
1074
1075             hash = mhash_add(hash, miniflow_get(flow, ofs) & *p);
1076             p++;
1077         }
1078     }
1079
1080     return mhash_finish(hash, p - mask->masks.values);
1081 }
1082
1083 /* Returns a hash value for the bits of 'flow' where there are 1-bits in
1084  * 'mask', given 'basis'.
1085  *
1086  * The hash values returned by this function are the same as those returned by
1087  * miniflow_hash_in_minimask(), only the form of the arguments differ. */
1088 uint32_t
1089 flow_hash_in_minimask(const struct flow *flow, const struct minimask *mask,
1090                       uint32_t basis)
1091 {
1092     const uint32_t *flow_u32 = (const uint32_t *) flow;
1093     const uint32_t *p = mask->masks.values;
1094     uint32_t hash;
1095     int i;
1096
1097     hash = basis;
1098     for (i = 0; i < MINI_N_MAPS; i++) {
1099         uint32_t map;
1100
1101         for (map = mask->masks.map[i]; map; map = zero_rightmost_1bit(map)) {
1102             int ofs = raw_ctz(map) + i * 32;
1103
1104             hash = mhash_add(hash, flow_u32[ofs] & *p);
1105             p++;
1106         }
1107     }
1108
1109     return mhash_finish(hash, p - mask->masks.values);
1110 }
1111 \f
1112 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1113  * with minimask_destroy(). */
1114 void
1115 minimask_init(struct minimask *mask, const struct flow_wildcards *wc)
1116 {
1117     miniflow_init(&mask->masks, &wc->masks);
1118 }
1119
1120 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1121  * with minimask_destroy(). */
1122 void
1123 minimask_clone(struct minimask *dst, const struct minimask *src)
1124 {
1125     miniflow_clone(&dst->masks, &src->masks);
1126 }
1127
1128 /* Initializes 'dst_' as the bit-wise "and" of 'a_' and 'b_'.
1129  *
1130  * The caller must provide room for FLOW_U32S "uint32_t"s in 'storage', for use
1131  * by 'dst_'.  The caller must *not* free 'dst_' with minimask_destroy(). */
1132 void
1133 minimask_combine(struct minimask *dst_,
1134                  const struct minimask *a_, const struct minimask *b_,
1135                  uint32_t storage[FLOW_U32S])
1136 {
1137     struct miniflow *dst = &dst_->masks;
1138     const struct miniflow *a = &a_->masks;
1139     const struct miniflow *b = &b_->masks;
1140     int i, n;
1141
1142     n = 0;
1143     dst->values = storage;
1144     for (i = 0; i < MINI_N_MAPS; i++) {
1145         uint32_t map;
1146
1147         dst->map[i] = 0;
1148         for (map = a->map[i] & b->map[i]; map;
1149              map = zero_rightmost_1bit(map)) {
1150             int ofs = raw_ctz(map) + i * 32;
1151             uint32_t mask = miniflow_get(a, ofs) & miniflow_get(b, ofs);
1152
1153             if (mask) {
1154                 dst->map[i] |= rightmost_1bit(map);
1155                 dst->values[n++] = mask;
1156             }
1157         }
1158     }
1159 }
1160
1161 /* Frees any memory owned by 'mask'.  Does not free the storage in which 'mask'
1162  * itself resides; the caller is responsible for that. */
1163 void
1164 minimask_destroy(struct minimask *mask)
1165 {
1166     miniflow_destroy(&mask->masks);
1167 }
1168
1169 /* Initializes 'dst' as a copy of 'src'. */
1170 void
1171 minimask_expand(const struct minimask *mask, struct flow_wildcards *wc)
1172 {
1173     miniflow_expand(&mask->masks, &wc->masks);
1174 }
1175
1176 /* Returns the uint32_t that would be at byte offset '4 * u32_ofs' if 'mask'
1177  * were expanded into a "struct flow_wildcards". */
1178 uint32_t
1179 minimask_get(const struct minimask *mask, unsigned int u32_ofs)
1180 {
1181     return miniflow_get(&mask->masks, u32_ofs);
1182 }
1183
1184 /* Returns the VID mask within the vlan_tci member of the "struct
1185  * flow_wildcards" represented by 'mask'. */
1186 uint16_t
1187 minimask_get_vid_mask(const struct minimask *mask)
1188 {
1189     return miniflow_get_vid(&mask->masks);
1190 }
1191
1192 /* Returns true if 'a' and 'b' are the same flow mask, false otherwise.  */
1193 bool
1194 minimask_equal(const struct minimask *a, const struct minimask *b)
1195 {
1196     return miniflow_equal(&a->masks, &b->masks);
1197 }
1198
1199 /* Returns a hash value for 'mask', given 'basis'. */
1200 uint32_t
1201 minimask_hash(const struct minimask *mask, uint32_t basis)
1202 {
1203     return miniflow_hash(&mask->masks, basis);
1204 }
1205
1206 /* Returns true if at least one bit is wildcarded in 'a_' but not in 'b_',
1207  * false otherwise. */
1208 bool
1209 minimask_has_extra(const struct minimask *a_, const struct minimask *b_)
1210 {
1211     const struct miniflow *a = &a_->masks;
1212     const struct miniflow *b = &b_->masks;
1213     int i;
1214
1215     for (i = 0; i < MINI_N_MAPS; i++) {
1216         uint32_t map;
1217
1218         for (map = a->map[i] | b->map[i]; map;
1219              map = zero_rightmost_1bit(map)) {
1220             int ofs = raw_ctz(map) + i * 32;
1221             uint32_t a_u32 = miniflow_get(a, ofs);
1222             uint32_t b_u32 = miniflow_get(b, ofs);
1223
1224             if ((a_u32 & b_u32) != b_u32) {
1225                 return true;
1226             }
1227         }
1228     }
1229
1230     return false;
1231 }
1232
1233 /* Returns true if 'mask' matches every packet, false if 'mask' fixes any bits
1234  * or fields. */
1235 bool
1236 minimask_is_catchall(const struct minimask *mask_)
1237 {
1238     const struct miniflow *mask = &mask_->masks;
1239
1240     BUILD_ASSERT(MINI_N_MAPS == 2);
1241     return !(mask->map[0] | mask->map[1]);
1242 }