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