2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #include <sys/types.h>
22 #include <netinet/in.h>
23 #include <netinet/icmp6.h>
24 #include <netinet/ip6.h>
28 #include "byte-order.h"
31 #include "dynamic-string.h"
36 #include "openflow/openflow.h"
39 #include "unaligned.h"
41 COVERAGE_DEFINE(flow_extract);
42 COVERAGE_DEFINE(miniflow_malloc);
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,
52 static struct arp_eth_header *
53 pull_arp(struct ofpbuf *packet)
55 return ofpbuf_try_pull(packet, ARP_ETH_HEADER_LEN);
58 static struct ip_header *
59 pull_ip(struct ofpbuf *packet)
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);
71 static struct tcp_header *
72 pull_tcp(struct ofpbuf *packet)
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);
84 static struct udp_header *
85 pull_udp(struct ofpbuf *packet)
87 return ofpbuf_try_pull(packet, UDP_HEADER_LEN);
90 static struct sctp_header *
91 pull_sctp(struct ofpbuf *packet)
93 return ofpbuf_try_pull(packet, SCTP_HEADER_LEN);
96 static struct icmp_header *
97 pull_icmp(struct ofpbuf *packet)
99 return ofpbuf_try_pull(packet, ICMP_HEADER_LEN);
102 static struct icmp6_hdr *
103 pull_icmpv6(struct ofpbuf *packet)
105 return ofpbuf_try_pull(packet, sizeof(struct icmp6_hdr));
109 parse_mpls(struct ofpbuf *b, struct flow *flow)
114 while ((mh = ofpbuf_try_pull(b, sizeof *mh))) {
117 flow->mpls_lse = mh->mpls_lse;
119 if (mh->mpls_lse & htonl(MPLS_BOS_MASK)) {
126 parse_vlan(struct ofpbuf *b, struct flow *flow)
129 ovs_be16 eth_type; /* ETH_TYPE_VLAN */
133 if (b->size >= sizeof(struct qtag_prefix) + sizeof(ovs_be16)) {
134 struct qtag_prefix *qp = ofpbuf_pull(b, sizeof *qp);
135 flow->vlan_tci = qp->tci | htons(VLAN_CFI);
140 parse_ethertype(struct ofpbuf *b)
142 struct llc_snap_header *llc;
145 proto = *(ovs_be16 *) ofpbuf_pull(b, sizeof proto);
146 if (ntohs(proto) >= ETH_TYPE_MIN) {
150 if (b->size < sizeof *llc) {
151 return htons(FLOW_DL_TYPE_NONE);
155 if (llc->llc.llc_dsap != LLC_DSAP_SNAP
156 || llc->llc.llc_ssap != LLC_SSAP_SNAP
157 || llc->llc.llc_cntl != LLC_CNTL_SNAP
158 || memcmp(llc->snap.snap_org, SNAP_ORG_ETHERNET,
159 sizeof llc->snap.snap_org)) {
160 return htons(FLOW_DL_TYPE_NONE);
163 ofpbuf_pull(b, sizeof *llc);
165 if (ntohs(llc->snap.snap_type) >= ETH_TYPE_MIN) {
166 return llc->snap.snap_type;
169 return htons(FLOW_DL_TYPE_NONE);
173 parse_ipv6(struct ofpbuf *packet, struct flow *flow)
175 const struct ovs_16aligned_ip6_hdr *nh;
179 nh = ofpbuf_try_pull(packet, sizeof *nh);
184 nexthdr = nh->ip6_nxt;
186 memcpy(&flow->ipv6_src, &nh->ip6_src, sizeof flow->ipv6_src);
187 memcpy(&flow->ipv6_dst, &nh->ip6_dst, sizeof flow->ipv6_dst);
189 tc_flow = get_16aligned_be32(&nh->ip6_flow);
190 flow->nw_tos = ntohl(tc_flow) >> 20;
191 flow->ipv6_label = tc_flow & htonl(IPV6_LABEL_MASK);
192 flow->nw_ttl = nh->ip6_hlim;
193 flow->nw_proto = IPPROTO_NONE;
196 if ((nexthdr != IPPROTO_HOPOPTS)
197 && (nexthdr != IPPROTO_ROUTING)
198 && (nexthdr != IPPROTO_DSTOPTS)
199 && (nexthdr != IPPROTO_AH)
200 && (nexthdr != IPPROTO_FRAGMENT)) {
201 /* It's either a terminal header (e.g., TCP, UDP) or one we
202 * don't understand. In either case, we're done with the
203 * packet, so use it to fill in 'nw_proto'. */
207 /* We only verify that at least 8 bytes of the next header are
208 * available, but many of these headers are longer. Ensure that
209 * accesses within the extension header are within those first 8
210 * bytes. All extension headers are required to be at least 8
212 if (packet->size < 8) {
216 if ((nexthdr == IPPROTO_HOPOPTS)
217 || (nexthdr == IPPROTO_ROUTING)
218 || (nexthdr == IPPROTO_DSTOPTS)) {
219 /* These headers, while different, have the fields we care about
220 * in the same location and with the same interpretation. */
221 const struct ip6_ext *ext_hdr = packet->data;
222 nexthdr = ext_hdr->ip6e_nxt;
223 if (!ofpbuf_try_pull(packet, (ext_hdr->ip6e_len + 1) * 8)) {
226 } else if (nexthdr == IPPROTO_AH) {
227 /* A standard AH definition isn't available, but the fields
228 * we care about are in the same location as the generic
229 * option header--only the header length is calculated
231 const struct ip6_ext *ext_hdr = packet->data;
232 nexthdr = ext_hdr->ip6e_nxt;
233 if (!ofpbuf_try_pull(packet, (ext_hdr->ip6e_len + 2) * 4)) {
236 } else if (nexthdr == IPPROTO_FRAGMENT) {
237 const struct ovs_16aligned_ip6_frag *frag_hdr = packet->data;
239 nexthdr = frag_hdr->ip6f_nxt;
240 if (!ofpbuf_try_pull(packet, sizeof *frag_hdr)) {
244 /* We only process the first fragment. */
245 if (frag_hdr->ip6f_offlg != htons(0)) {
246 flow->nw_frag = FLOW_NW_FRAG_ANY;
247 if ((frag_hdr->ip6f_offlg & IP6F_OFF_MASK) != htons(0)) {
248 flow->nw_frag |= FLOW_NW_FRAG_LATER;
249 nexthdr = IPPROTO_FRAGMENT;
256 flow->nw_proto = nexthdr;
261 parse_tcp(struct ofpbuf *packet, struct ofpbuf *b, struct flow *flow)
263 const struct tcp_header *tcp = pull_tcp(b);
265 flow->tp_src = tcp->tcp_src;
266 flow->tp_dst = tcp->tcp_dst;
267 flow->tcp_flags = tcp->tcp_ctl & htons(0x0fff);
268 packet->l7 = b->data;
273 parse_udp(struct ofpbuf *packet, struct ofpbuf *b, struct flow *flow)
275 const struct udp_header *udp = pull_udp(b);
277 flow->tp_src = udp->udp_src;
278 flow->tp_dst = udp->udp_dst;
279 packet->l7 = b->data;
284 parse_sctp(struct ofpbuf *packet, struct ofpbuf *b, struct flow *flow)
286 const struct sctp_header *sctp = pull_sctp(b);
288 flow->tp_src = sctp->sctp_src;
289 flow->tp_dst = sctp->sctp_dst;
290 packet->l7 = b->data;
295 parse_icmpv6(struct ofpbuf *b, struct flow *flow)
297 const struct icmp6_hdr *icmp = pull_icmpv6(b);
303 /* The ICMPv6 type and code fields use the 16-bit transport port
304 * fields, so we need to store them in 16-bit network byte order. */
305 flow->tp_src = htons(icmp->icmp6_type);
306 flow->tp_dst = htons(icmp->icmp6_code);
308 if (icmp->icmp6_code == 0 &&
309 (icmp->icmp6_type == ND_NEIGHBOR_SOLICIT ||
310 icmp->icmp6_type == ND_NEIGHBOR_ADVERT)) {
311 const struct in6_addr *nd_target;
313 nd_target = ofpbuf_try_pull(b, sizeof *nd_target);
317 flow->nd_target = *nd_target;
319 while (b->size >= 8) {
320 /* The minimum size of an option is 8 bytes, which also is
321 * the size of Ethernet link-layer options. */
322 const struct nd_opt_hdr *nd_opt = b->data;
323 int opt_len = nd_opt->nd_opt_len * 8;
325 if (!opt_len || opt_len > b->size) {
329 /* Store the link layer address if the appropriate option is
330 * provided. It is considered an error if the same link
331 * layer option is specified twice. */
332 if (nd_opt->nd_opt_type == ND_OPT_SOURCE_LINKADDR
334 if (eth_addr_is_zero(flow->arp_sha)) {
335 memcpy(flow->arp_sha, nd_opt + 1, ETH_ADDR_LEN);
339 } else if (nd_opt->nd_opt_type == ND_OPT_TARGET_LINKADDR
341 if (eth_addr_is_zero(flow->arp_tha)) {
342 memcpy(flow->arp_tha, nd_opt + 1, ETH_ADDR_LEN);
348 if (!ofpbuf_try_pull(b, opt_len)) {
357 memset(&flow->nd_target, 0, sizeof(flow->nd_target));
358 memset(flow->arp_sha, 0, sizeof(flow->arp_sha));
359 memset(flow->arp_tha, 0, sizeof(flow->arp_tha));
365 /* Initializes 'flow' members from 'packet', 'skb_priority', 'tnl', and
368 * Initializes 'packet' header pointers as follows:
370 * - packet->l2 to the start of the Ethernet header.
372 * - packet->l2_5 to the start of the MPLS shim header.
374 * - packet->l3 to just past the Ethernet header, or just past the
375 * vlan_header if one is present, to the first byte of the payload of the
378 * - packet->l4 to just past the IPv4 header, if one is present and has a
379 * correct length, and otherwise NULL.
381 * - packet->l7 to just past the TCP/UDP/SCTP/ICMP header, if one is
382 * present and has a correct length, and otherwise NULL.
385 flow_extract(struct ofpbuf *packet, uint32_t skb_priority, uint32_t pkt_mark,
386 const struct flow_tnl *tnl, const union flow_in_port *in_port,
389 struct ofpbuf b = *packet;
390 struct eth_header *eth;
392 COVERAGE_INC(flow_extract);
394 memset(flow, 0, sizeof *flow);
397 ovs_assert(tnl != &flow->tunnel);
401 flow->in_port = *in_port;
403 flow->skb_priority = skb_priority;
404 flow->pkt_mark = pkt_mark;
412 if (b.size < sizeof *eth) {
418 memcpy(flow->dl_src, eth->eth_src, ETH_ADDR_LEN);
419 memcpy(flow->dl_dst, eth->eth_dst, ETH_ADDR_LEN);
421 /* dl_type, vlan_tci. */
422 ofpbuf_pull(&b, ETH_ADDR_LEN * 2);
423 if (eth->eth_type == htons(ETH_TYPE_VLAN)) {
424 parse_vlan(&b, flow);
426 flow->dl_type = parse_ethertype(&b);
428 /* Parse mpls, copy l3 ttl. */
429 if (eth_type_mpls(flow->dl_type)) {
430 packet->l2_5 = b.data;
431 parse_mpls(&b, flow);
436 if (flow->dl_type == htons(ETH_TYPE_IP)) {
437 const struct ip_header *nh = pull_ip(&b);
441 flow->nw_src = get_16aligned_be32(&nh->ip_src);
442 flow->nw_dst = get_16aligned_be32(&nh->ip_dst);
443 flow->nw_proto = nh->ip_proto;
445 flow->nw_tos = nh->ip_tos;
446 if (IP_IS_FRAGMENT(nh->ip_frag_off)) {
447 flow->nw_frag = FLOW_NW_FRAG_ANY;
448 if (nh->ip_frag_off & htons(IP_FRAG_OFF_MASK)) {
449 flow->nw_frag |= FLOW_NW_FRAG_LATER;
452 flow->nw_ttl = nh->ip_ttl;
454 if (!(nh->ip_frag_off & htons(IP_FRAG_OFF_MASK))) {
455 if (flow->nw_proto == IPPROTO_TCP) {
456 parse_tcp(packet, &b, flow);
457 } else if (flow->nw_proto == IPPROTO_UDP) {
458 parse_udp(packet, &b, flow);
459 } else if (flow->nw_proto == IPPROTO_SCTP) {
460 parse_sctp(packet, &b, flow);
461 } else if (flow->nw_proto == IPPROTO_ICMP) {
462 const struct icmp_header *icmp = pull_icmp(&b);
464 flow->tp_src = htons(icmp->icmp_type);
465 flow->tp_dst = htons(icmp->icmp_code);
471 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
472 if (parse_ipv6(&b, flow)) {
477 if (flow->nw_proto == IPPROTO_TCP) {
478 parse_tcp(packet, &b, flow);
479 } else if (flow->nw_proto == IPPROTO_UDP) {
480 parse_udp(packet, &b, flow);
481 } else if (flow->nw_proto == IPPROTO_SCTP) {
482 parse_sctp(packet, &b, flow);
483 } else if (flow->nw_proto == IPPROTO_ICMPV6) {
484 if (parse_icmpv6(&b, flow)) {
488 } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
489 flow->dl_type == htons(ETH_TYPE_RARP)) {
490 const struct arp_eth_header *arp = pull_arp(&b);
491 if (arp && arp->ar_hrd == htons(1)
492 && arp->ar_pro == htons(ETH_TYPE_IP)
493 && arp->ar_hln == ETH_ADDR_LEN
494 && arp->ar_pln == 4) {
495 /* We only match on the lower 8 bits of the opcode. */
496 if (ntohs(arp->ar_op) <= 0xff) {
497 flow->nw_proto = ntohs(arp->ar_op);
500 flow->nw_src = get_16aligned_be32(&arp->ar_spa);
501 flow->nw_dst = get_16aligned_be32(&arp->ar_tpa);
502 memcpy(flow->arp_sha, arp->ar_sha, ETH_ADDR_LEN);
503 memcpy(flow->arp_tha, arp->ar_tha, ETH_ADDR_LEN);
508 /* For every bit of a field that is wildcarded in 'wildcards', sets the
509 * corresponding bit in 'flow' to zero. */
511 flow_zero_wildcards(struct flow *flow, const struct flow_wildcards *wildcards)
513 uint32_t *flow_u32 = (uint32_t *) flow;
514 const uint32_t *wc_u32 = (const uint32_t *) &wildcards->masks;
517 for (i = 0; i < FLOW_U32S; i++) {
518 flow_u32[i] &= wc_u32[i];
522 /* Initializes 'fmd' with the metadata found in 'flow'. */
524 flow_get_metadata(const struct flow *flow, struct flow_metadata *fmd)
526 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 23);
528 fmd->tun_id = flow->tunnel.tun_id;
529 fmd->tun_src = flow->tunnel.ip_src;
530 fmd->tun_dst = flow->tunnel.ip_dst;
531 fmd->metadata = flow->metadata;
532 memcpy(fmd->regs, flow->regs, sizeof fmd->regs);
533 fmd->pkt_mark = flow->pkt_mark;
534 fmd->in_port = flow->in_port.ofp_port;
538 flow_to_string(const struct flow *flow)
540 struct ds ds = DS_EMPTY_INITIALIZER;
541 flow_format(&ds, flow);
546 flow_tun_flag_to_string(uint32_t flags)
549 case FLOW_TNL_F_DONT_FRAGMENT:
551 case FLOW_TNL_F_CSUM:
561 format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t),
562 uint32_t flags, char del)
570 uint32_t bit = rightmost_1bit(flags);
573 s = bit_to_string(bit);
575 ds_put_format(ds, "%s%c", s, del);
584 ds_put_format(ds, "0x%"PRIx32"%c", bad, del);
590 format_flags_masked(struct ds *ds, const char *name,
591 const char *(*bit_to_string)(uint32_t), uint32_t flags,
595 ds_put_format(ds, "%s=", name);
598 uint32_t bit = rightmost_1bit(mask);
599 const char *s = bit_to_string(bit);
601 ds_put_format(ds, "%s%s", (flags & bit) ? "+" : "-",
602 s ? s : "[Unknown]");
608 flow_format(struct ds *ds, const struct flow *flow)
612 match_wc_init(&match, flow);
613 match_format(&match, ds, OFP_DEFAULT_PRIORITY);
617 flow_print(FILE *stream, const struct flow *flow)
619 char *s = flow_to_string(flow);
624 /* flow_wildcards functions. */
626 /* Initializes 'wc' as a set of wildcards that matches every packet. */
628 flow_wildcards_init_catchall(struct flow_wildcards *wc)
630 memset(&wc->masks, 0, sizeof wc->masks);
633 /* Clear the metadata and register wildcard masks. They are not packet
636 flow_wildcards_clear_non_packet_fields(struct flow_wildcards *wc)
638 memset(&wc->masks.metadata, 0, sizeof wc->masks.metadata);
639 memset(&wc->masks.regs, 0, sizeof wc->masks.regs);
642 /* Returns true if 'wc' matches every packet, false if 'wc' fixes any bits or
645 flow_wildcards_is_catchall(const struct flow_wildcards *wc)
647 const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
650 for (i = 0; i < FLOW_U32S; i++) {
658 /* Sets 'dst' as the bitwise AND of wildcards in 'src1' and 'src2'.
659 * That is, a bit or a field is wildcarded in 'dst' if it is wildcarded
660 * in 'src1' or 'src2' or both. */
662 flow_wildcards_and(struct flow_wildcards *dst,
663 const struct flow_wildcards *src1,
664 const struct flow_wildcards *src2)
666 uint32_t *dst_u32 = (uint32_t *) &dst->masks;
667 const uint32_t *src1_u32 = (const uint32_t *) &src1->masks;
668 const uint32_t *src2_u32 = (const uint32_t *) &src2->masks;
671 for (i = 0; i < FLOW_U32S; i++) {
672 dst_u32[i] = src1_u32[i] & src2_u32[i];
676 /* Sets 'dst' as the bitwise OR of wildcards in 'src1' and 'src2'. That
677 * is, a bit or a field is wildcarded in 'dst' if it is neither
678 * wildcarded in 'src1' nor 'src2'. */
680 flow_wildcards_or(struct flow_wildcards *dst,
681 const struct flow_wildcards *src1,
682 const struct flow_wildcards *src2)
684 uint32_t *dst_u32 = (uint32_t *) &dst->masks;
685 const uint32_t *src1_u32 = (const uint32_t *) &src1->masks;
686 const uint32_t *src2_u32 = (const uint32_t *) &src2->masks;
689 for (i = 0; i < FLOW_U32S; i++) {
690 dst_u32[i] = src1_u32[i] | src2_u32[i];
694 /* Perform a bitwise OR of miniflow 'src' flow data with the equivalent
695 * fields in 'dst', storing the result in 'dst'. */
697 flow_union_with_miniflow(struct flow *dst, const struct miniflow *src)
699 uint32_t *dst_u32 = (uint32_t *) dst;
700 const uint32_t *p = src->values;
703 for (map = src->map; map; map = zero_rightmost_1bit(map)) {
704 dst_u32[raw_ctz(map)] |= *p++;
708 /* Fold minimask 'mask''s wildcard mask into 'wc's wildcard mask. */
710 flow_wildcards_fold_minimask(struct flow_wildcards *wc,
711 const struct minimask *mask)
713 flow_union_with_miniflow(&wc->masks, &mask->masks);
717 miniflow_get_map_in_range(const struct miniflow *miniflow,
718 uint8_t start, uint8_t end, const uint32_t **data)
720 uint64_t map = miniflow->map;
721 uint32_t *p = miniflow->values;
724 uint64_t msk = (UINT64_C(1) << start) - 1; /* 'start' LSBs set */
725 p += count_1bits(map & msk); /* Skip to start. */
728 if (end < FLOW_U32S) {
729 uint64_t msk = (UINT64_C(1) << end) - 1; /* 'end' LSBs set */
737 /* Fold minimask 'mask''s wildcard mask into 'wc's wildcard mask
738 * in range [start, end). */
740 flow_wildcards_fold_minimask_range(struct flow_wildcards *wc,
741 const struct minimask *mask,
742 uint8_t start, uint8_t end)
744 uint32_t *dst_u32 = (uint32_t *)&wc->masks;
746 uint64_t map = miniflow_get_map_in_range(&mask->masks, start, end, &p);
748 for (; map; map = zero_rightmost_1bit(map)) {
749 dst_u32[raw_ctz(map)] |= *p++;
753 /* Returns a hash of the wildcards in 'wc'. */
755 flow_wildcards_hash(const struct flow_wildcards *wc, uint32_t basis)
757 return flow_hash(&wc->masks, basis);
760 /* Returns true if 'a' and 'b' represent the same wildcards, false if they are
763 flow_wildcards_equal(const struct flow_wildcards *a,
764 const struct flow_wildcards *b)
766 return flow_equal(&a->masks, &b->masks);
769 /* Returns true if at least one bit or field is wildcarded in 'a' but not in
770 * 'b', false otherwise. */
772 flow_wildcards_has_extra(const struct flow_wildcards *a,
773 const struct flow_wildcards *b)
775 const uint32_t *a_u32 = (const uint32_t *) &a->masks;
776 const uint32_t *b_u32 = (const uint32_t *) &b->masks;
779 for (i = 0; i < FLOW_U32S; i++) {
780 if ((a_u32[i] & b_u32[i]) != b_u32[i]) {
787 /* Returns true if 'a' and 'b' are equal, except that 0-bits (wildcarded bits)
788 * in 'wc' do not need to be equal in 'a' and 'b'. */
790 flow_equal_except(const struct flow *a, const struct flow *b,
791 const struct flow_wildcards *wc)
793 const uint32_t *a_u32 = (const uint32_t *) a;
794 const uint32_t *b_u32 = (const uint32_t *) b;
795 const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
798 for (i = 0; i < FLOW_U32S; i++) {
799 if ((a_u32[i] ^ b_u32[i]) & wc_u32[i]) {
806 /* Sets the wildcard mask for register 'idx' in 'wc' to 'mask'.
807 * (A 0-bit indicates a wildcard bit.) */
809 flow_wildcards_set_reg_mask(struct flow_wildcards *wc, int idx, uint32_t mask)
811 wc->masks.regs[idx] = mask;
814 /* Hashes 'flow' based on its L2 through L4 protocol information. */
816 flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis)
821 struct in6_addr ipv6_addr;
826 uint8_t eth_addr[ETH_ADDR_LEN];
832 memset(&fields, 0, sizeof fields);
833 for (i = 0; i < ETH_ADDR_LEN; i++) {
834 fields.eth_addr[i] = flow->dl_src[i] ^ flow->dl_dst[i];
836 fields.vlan_tci = flow->vlan_tci & htons(VLAN_VID_MASK);
837 fields.eth_type = flow->dl_type;
839 /* UDP source and destination port are not taken into account because they
840 * will not necessarily be symmetric in a bidirectional flow. */
841 if (fields.eth_type == htons(ETH_TYPE_IP)) {
842 fields.ipv4_addr = flow->nw_src ^ flow->nw_dst;
843 fields.ip_proto = flow->nw_proto;
844 if (fields.ip_proto == IPPROTO_TCP || fields.ip_proto == IPPROTO_SCTP) {
845 fields.tp_port = flow->tp_src ^ flow->tp_dst;
847 } else if (fields.eth_type == htons(ETH_TYPE_IPV6)) {
848 const uint8_t *a = &flow->ipv6_src.s6_addr[0];
849 const uint8_t *b = &flow->ipv6_dst.s6_addr[0];
850 uint8_t *ipv6_addr = &fields.ipv6_addr.s6_addr[0];
852 for (i=0; i<16; i++) {
853 ipv6_addr[i] = a[i] ^ b[i];
855 fields.ip_proto = flow->nw_proto;
856 if (fields.ip_proto == IPPROTO_TCP || fields.ip_proto == IPPROTO_SCTP) {
857 fields.tp_port = flow->tp_src ^ flow->tp_dst;
860 return jhash_bytes(&fields, sizeof fields, basis);
863 /* Initialize a flow with random fields that matter for nx_hash_fields. */
865 flow_random_hash_fields(struct flow *flow)
867 uint16_t rnd = random_uint16();
869 /* Initialize to all zeros. */
870 memset(flow, 0, sizeof *flow);
872 eth_addr_random(flow->dl_src);
873 eth_addr_random(flow->dl_dst);
875 flow->vlan_tci = (OVS_FORCE ovs_be16) (random_uint16() & VLAN_VID_MASK);
877 /* Make most of the random flows IPv4, some IPv6, and rest random. */
878 flow->dl_type = rnd < 0x8000 ? htons(ETH_TYPE_IP) :
879 rnd < 0xc000 ? htons(ETH_TYPE_IPV6) : (OVS_FORCE ovs_be16)rnd;
881 if (dl_type_is_ip_any(flow->dl_type)) {
882 if (flow->dl_type == htons(ETH_TYPE_IP)) {
883 flow->nw_src = (OVS_FORCE ovs_be32)random_uint32();
884 flow->nw_dst = (OVS_FORCE ovs_be32)random_uint32();
886 random_bytes(&flow->ipv6_src, sizeof flow->ipv6_src);
887 random_bytes(&flow->ipv6_dst, sizeof flow->ipv6_dst);
889 /* Make most of IP flows TCP, some UDP or SCTP, and rest random. */
890 rnd = random_uint16();
891 flow->nw_proto = rnd < 0x8000 ? IPPROTO_TCP :
892 rnd < 0xc000 ? IPPROTO_UDP :
893 rnd < 0xd000 ? IPPROTO_SCTP : (uint8_t)rnd;
894 if (flow->nw_proto == IPPROTO_TCP ||
895 flow->nw_proto == IPPROTO_UDP ||
896 flow->nw_proto == IPPROTO_SCTP) {
897 flow->tp_src = (OVS_FORCE ovs_be16)random_uint16();
898 flow->tp_dst = (OVS_FORCE ovs_be16)random_uint16();
903 /* Masks the fields in 'wc' that are used by the flow hash 'fields'. */
905 flow_mask_hash_fields(const struct flow *flow, struct flow_wildcards *wc,
906 enum nx_hash_fields fields)
909 case NX_HASH_FIELDS_ETH_SRC:
910 memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
913 case NX_HASH_FIELDS_SYMMETRIC_L4:
914 memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
915 memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
916 if (flow->dl_type == htons(ETH_TYPE_IP)) {
917 memset(&wc->masks.nw_src, 0xff, sizeof wc->masks.nw_src);
918 memset(&wc->masks.nw_dst, 0xff, sizeof wc->masks.nw_dst);
919 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
920 memset(&wc->masks.ipv6_src, 0xff, sizeof wc->masks.ipv6_src);
921 memset(&wc->masks.ipv6_dst, 0xff, sizeof wc->masks.ipv6_dst);
923 if (is_ip_any(flow)) {
924 memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
925 memset(&wc->masks.tp_src, 0xff, sizeof wc->masks.tp_src);
926 memset(&wc->masks.tp_dst, 0xff, sizeof wc->masks.tp_dst);
928 wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
936 /* Hashes the portions of 'flow' designated by 'fields'. */
938 flow_hash_fields(const struct flow *flow, enum nx_hash_fields fields,
943 case NX_HASH_FIELDS_ETH_SRC:
944 return jhash_bytes(flow->dl_src, sizeof flow->dl_src, basis);
946 case NX_HASH_FIELDS_SYMMETRIC_L4:
947 return flow_hash_symmetric_l4(flow, basis);
953 /* Returns a string representation of 'fields'. */
955 flow_hash_fields_to_str(enum nx_hash_fields fields)
958 case NX_HASH_FIELDS_ETH_SRC: return "eth_src";
959 case NX_HASH_FIELDS_SYMMETRIC_L4: return "symmetric_l4";
960 default: return "<unknown>";
964 /* Returns true if the value of 'fields' is supported. Otherwise false. */
966 flow_hash_fields_valid(enum nx_hash_fields fields)
968 return fields == NX_HASH_FIELDS_ETH_SRC
969 || fields == NX_HASH_FIELDS_SYMMETRIC_L4;
972 /* Returns a hash value for the bits of 'flow' that are active based on
973 * 'wc', given 'basis'. */
975 flow_hash_in_wildcards(const struct flow *flow,
976 const struct flow_wildcards *wc, uint32_t basis)
978 const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
979 const uint32_t *flow_u32 = (const uint32_t *) flow;
984 for (i = 0; i < FLOW_U32S; i++) {
985 hash = mhash_add(hash, flow_u32[i] & wc_u32[i]);
987 return mhash_finish(hash, 4 * FLOW_U32S);
990 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
991 * OpenFlow 1.0 "dl_vlan" value:
993 * - If it is in the range 0...4095, 'flow->vlan_tci' is set to match
994 * that VLAN. Any existing PCP match is unchanged (it becomes 0 if
995 * 'flow' previously matched packets without a VLAN header).
997 * - If it is OFP_VLAN_NONE, 'flow->vlan_tci' is set to match a packet
998 * without a VLAN tag.
1000 * - Other values of 'vid' should not be used. */
1002 flow_set_dl_vlan(struct flow *flow, ovs_be16 vid)
1004 if (vid == htons(OFP10_VLAN_NONE)) {
1005 flow->vlan_tci = htons(0);
1007 vid &= htons(VLAN_VID_MASK);
1008 flow->vlan_tci &= ~htons(VLAN_VID_MASK);
1009 flow->vlan_tci |= htons(VLAN_CFI) | vid;
1013 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
1014 * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
1017 flow_set_vlan_vid(struct flow *flow, ovs_be16 vid)
1019 ovs_be16 mask = htons(VLAN_VID_MASK | VLAN_CFI);
1020 flow->vlan_tci &= ~mask;
1021 flow->vlan_tci |= vid & mask;
1024 /* Sets the VLAN PCP that 'flow' matches to 'pcp', which should be in the
1027 * This function has no effect on the VLAN ID that 'flow' matches.
1029 * After calling this function, 'flow' will not match packets without a VLAN
1032 flow_set_vlan_pcp(struct flow *flow, uint8_t pcp)
1035 flow->vlan_tci &= ~htons(VLAN_PCP_MASK);
1036 flow->vlan_tci |= htons((pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
1039 /* Sets the MPLS Label that 'flow' matches to 'label', which is interpreted
1040 * as an OpenFlow 1.1 "mpls_label" value. */
1042 flow_set_mpls_label(struct flow *flow, ovs_be32 label)
1044 set_mpls_lse_label(&flow->mpls_lse, label);
1047 /* Sets the MPLS TTL that 'flow' matches to 'ttl', which should be in the
1050 flow_set_mpls_ttl(struct flow *flow, uint8_t ttl)
1052 set_mpls_lse_ttl(&flow->mpls_lse, ttl);
1055 /* Sets the MPLS TC that 'flow' matches to 'tc', which should be in the
1058 flow_set_mpls_tc(struct flow *flow, uint8_t tc)
1060 set_mpls_lse_tc(&flow->mpls_lse, tc);
1063 /* Sets the MPLS BOS bit that 'flow' matches to which should be 0 or 1. */
1065 flow_set_mpls_bos(struct flow *flow, uint8_t bos)
1067 set_mpls_lse_bos(&flow->mpls_lse, bos);
1072 flow_compose_l4(struct ofpbuf *b, const struct flow *flow)
1074 if (!(flow->nw_frag & FLOW_NW_FRAG_ANY)
1075 || !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1076 if (flow->nw_proto == IPPROTO_TCP) {
1077 struct tcp_header *tcp;
1079 tcp = ofpbuf_put_zeros(b, sizeof *tcp);
1080 tcp->tcp_src = flow->tp_src;
1081 tcp->tcp_dst = flow->tp_dst;
1082 tcp->tcp_ctl = TCP_CTL(ntohs(flow->tcp_flags), 5);
1083 b->l7 = ofpbuf_tail(b);
1084 } else if (flow->nw_proto == IPPROTO_UDP) {
1085 struct udp_header *udp;
1087 udp = ofpbuf_put_zeros(b, sizeof *udp);
1088 udp->udp_src = flow->tp_src;
1089 udp->udp_dst = flow->tp_dst;
1090 b->l7 = ofpbuf_tail(b);
1091 } else if (flow->nw_proto == IPPROTO_SCTP) {
1092 struct sctp_header *sctp;
1094 sctp = ofpbuf_put_zeros(b, sizeof *sctp);
1095 sctp->sctp_src = flow->tp_src;
1096 sctp->sctp_dst = flow->tp_dst;
1097 b->l7 = ofpbuf_tail(b);
1098 } else if (flow->nw_proto == IPPROTO_ICMP) {
1099 struct icmp_header *icmp;
1101 icmp = ofpbuf_put_zeros(b, sizeof *icmp);
1102 icmp->icmp_type = ntohs(flow->tp_src);
1103 icmp->icmp_code = ntohs(flow->tp_dst);
1104 icmp->icmp_csum = csum(icmp, ICMP_HEADER_LEN);
1105 b->l7 = ofpbuf_tail(b);
1106 } else if (flow->nw_proto == IPPROTO_ICMPV6) {
1107 struct icmp6_hdr *icmp;
1109 icmp = ofpbuf_put_zeros(b, sizeof *icmp);
1110 icmp->icmp6_type = ntohs(flow->tp_src);
1111 icmp->icmp6_code = ntohs(flow->tp_dst);
1113 if (icmp->icmp6_code == 0 &&
1114 (icmp->icmp6_type == ND_NEIGHBOR_SOLICIT ||
1115 icmp->icmp6_type == ND_NEIGHBOR_ADVERT)) {
1116 struct in6_addr *nd_target;
1117 struct nd_opt_hdr *nd_opt;
1119 nd_target = ofpbuf_put_zeros(b, sizeof *nd_target);
1120 *nd_target = flow->nd_target;
1122 if (!eth_addr_is_zero(flow->arp_sha)) {
1123 nd_opt = ofpbuf_put_zeros(b, 8);
1124 nd_opt->nd_opt_len = 1;
1125 nd_opt->nd_opt_type = ND_OPT_SOURCE_LINKADDR;
1126 memcpy(nd_opt + 1, flow->arp_sha, ETH_ADDR_LEN);
1128 if (!eth_addr_is_zero(flow->arp_tha)) {
1129 nd_opt = ofpbuf_put_zeros(b, 8);
1130 nd_opt->nd_opt_len = 1;
1131 nd_opt->nd_opt_type = ND_OPT_TARGET_LINKADDR;
1132 memcpy(nd_opt + 1, flow->arp_tha, ETH_ADDR_LEN);
1135 icmp->icmp6_cksum = (OVS_FORCE uint16_t)
1136 csum(icmp, (char *)ofpbuf_tail(b) - (char *)icmp);
1137 b->l7 = ofpbuf_tail(b);
1142 /* Puts into 'b' a packet that flow_extract() would parse as having the given
1145 * (This is useful only for testing, obviously, and the packet isn't really
1146 * valid. It hasn't got some checksums filled in, for one, and lots of fields
1147 * are just zeroed.) */
1149 flow_compose(struct ofpbuf *b, const struct flow *flow)
1151 /* eth_compose() sets l3 pointer and makes sure it is 32-bit aligned. */
1152 eth_compose(b, flow->dl_dst, flow->dl_src, ntohs(flow->dl_type), 0);
1153 if (flow->dl_type == htons(FLOW_DL_TYPE_NONE)) {
1154 struct eth_header *eth = b->l2;
1155 eth->eth_type = htons(b->size);
1159 if (flow->vlan_tci & htons(VLAN_CFI)) {
1160 eth_push_vlan(b, flow->vlan_tci);
1163 if (flow->dl_type == htons(ETH_TYPE_IP)) {
1164 struct ip_header *ip;
1166 ip = ofpbuf_put_zeros(b, sizeof *ip);
1167 ip->ip_ihl_ver = IP_IHL_VER(5, 4);
1168 ip->ip_tos = flow->nw_tos;
1169 ip->ip_ttl = flow->nw_ttl;
1170 ip->ip_proto = flow->nw_proto;
1171 put_16aligned_be32(&ip->ip_src, flow->nw_src);
1172 put_16aligned_be32(&ip->ip_dst, flow->nw_dst);
1174 if (flow->nw_frag & FLOW_NW_FRAG_ANY) {
1175 ip->ip_frag_off |= htons(IP_MORE_FRAGMENTS);
1176 if (flow->nw_frag & FLOW_NW_FRAG_LATER) {
1177 ip->ip_frag_off |= htons(100);
1181 b->l4 = ofpbuf_tail(b);
1183 flow_compose_l4(b, flow);
1185 ip->ip_tot_len = htons((uint8_t *) b->data + b->size
1186 - (uint8_t *) b->l3);
1187 ip->ip_csum = csum(ip, sizeof *ip);
1188 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1189 struct ovs_16aligned_ip6_hdr *nh;
1191 nh = ofpbuf_put_zeros(b, sizeof *nh);
1192 put_16aligned_be32(&nh->ip6_flow, htonl(6 << 28) |
1193 htonl(flow->nw_tos << 20) | flow->ipv6_label);
1194 nh->ip6_hlim = flow->nw_ttl;
1195 nh->ip6_nxt = flow->nw_proto;
1197 memcpy(&nh->ip6_src, &flow->ipv6_src, sizeof(nh->ip6_src));
1198 memcpy(&nh->ip6_dst, &flow->ipv6_dst, sizeof(nh->ip6_dst));
1200 b->l4 = ofpbuf_tail(b);
1202 flow_compose_l4(b, flow);
1205 b->l7 ? htons((uint8_t *) b->l7 - (uint8_t *) b->l4) : htons(0);
1206 } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
1207 flow->dl_type == htons(ETH_TYPE_RARP)) {
1208 struct arp_eth_header *arp;
1210 b->l3 = arp = ofpbuf_put_zeros(b, sizeof *arp);
1211 arp->ar_hrd = htons(1);
1212 arp->ar_pro = htons(ETH_TYPE_IP);
1213 arp->ar_hln = ETH_ADDR_LEN;
1215 arp->ar_op = htons(flow->nw_proto);
1217 if (flow->nw_proto == ARP_OP_REQUEST ||
1218 flow->nw_proto == ARP_OP_REPLY) {
1219 put_16aligned_be32(&arp->ar_spa, flow->nw_src);
1220 put_16aligned_be32(&arp->ar_tpa, flow->nw_dst);
1221 memcpy(arp->ar_sha, flow->arp_sha, ETH_ADDR_LEN);
1222 memcpy(arp->ar_tha, flow->arp_tha, ETH_ADDR_LEN);
1226 if (eth_type_mpls(flow->dl_type)) {
1228 push_mpls(b, flow->dl_type, flow->mpls_lse);
1232 /* Compressed flow. */
1235 miniflow_n_values(const struct miniflow *flow)
1237 return count_1bits(flow->map);
1241 miniflow_alloc_values(struct miniflow *flow, int n)
1243 if (n <= MINI_N_INLINE) {
1244 return flow->inline_values;
1246 COVERAGE_INC(miniflow_malloc);
1247 return xmalloc(n * sizeof *flow->values);
1251 /* Completes an initialization of 'dst' as a miniflow copy of 'src' begun by
1252 * the caller. The caller must have already initialized 'dst->map' properly
1253 * to indicate the significant uint32_t elements of 'src'. 'n' must be the
1254 * number of 1-bits in 'dst->map'.
1256 * Normally the significant elements are the ones that are non-zero. However,
1257 * when a miniflow is initialized from a (mini)mask, the values can be zeroes,
1258 * so that the flow and mask always have the same maps.
1260 * This function initializes 'dst->values' (either inline if possible or with
1261 * malloc() otherwise) and copies the uint32_t elements of 'src' indicated by
1262 * 'dst->map' into it. */
1264 miniflow_init__(struct miniflow *dst, const struct flow *src, int n)
1266 const uint32_t *src_u32 = (const uint32_t *) src;
1270 dst->values = miniflow_alloc_values(dst, n);
1272 for (map = dst->map; map; map = zero_rightmost_1bit(map)) {
1273 dst->values[ofs++] = src_u32[raw_ctz(map)];
1277 /* Initializes 'dst' as a copy of 'src'. The caller must eventually free 'dst'
1278 * with miniflow_destroy(). */
1280 miniflow_init(struct miniflow *dst, const struct flow *src)
1282 const uint32_t *src_u32 = (const uint32_t *) src;
1286 /* Initialize dst->map, counting the number of nonzero elements. */
1290 for (i = 0; i < FLOW_U32S; i++) {
1292 dst->map |= UINT64_C(1) << i;
1297 miniflow_init__(dst, src, n);
1300 /* Initializes 'dst' as a copy of 'src', using 'mask->map' as 'dst''s map. The
1301 * caller must eventually free 'dst' with miniflow_destroy(). */
1303 miniflow_init_with_minimask(struct miniflow *dst, const struct flow *src,
1304 const struct minimask *mask)
1306 dst->map = mask->masks.map;
1307 miniflow_init__(dst, src, miniflow_n_values(dst));
1310 /* Initializes 'dst' as a copy of 'src'. The caller must eventually free 'dst'
1311 * with miniflow_destroy(). */
1313 miniflow_clone(struct miniflow *dst, const struct miniflow *src)
1315 int n = miniflow_n_values(src);
1316 dst->map = src->map;
1317 dst->values = miniflow_alloc_values(dst, n);
1318 memcpy(dst->values, src->values, n * sizeof *dst->values);
1321 /* Initializes 'dst' with the data in 'src', destroying 'src'.
1322 * The caller must eventually free 'dst' with miniflow_destroy(). */
1324 miniflow_move(struct miniflow *dst, struct miniflow *src)
1326 if (src->values == src->inline_values) {
1327 dst->values = dst->inline_values;
1328 memcpy(dst->values, src->values,
1329 miniflow_n_values(src) * sizeof *dst->values);
1331 dst->values = src->values;
1333 dst->map = src->map;
1336 /* Frees any memory owned by 'flow'. Does not free the storage in which 'flow'
1337 * itself resides; the caller is responsible for that. */
1339 miniflow_destroy(struct miniflow *flow)
1341 if (flow->values != flow->inline_values) {
1346 /* Initializes 'dst' as a copy of 'src'. */
1348 miniflow_expand(const struct miniflow *src, struct flow *dst)
1350 memset(dst, 0, sizeof *dst);
1351 flow_union_with_miniflow(dst, src);
1354 static const uint32_t *
1355 miniflow_get__(const struct miniflow *flow, unsigned int u32_ofs)
1357 if (!(flow->map & (UINT64_C(1) << u32_ofs))) {
1358 static const uint32_t zero = 0;
1361 return flow->values +
1362 count_1bits(flow->map & ((UINT64_C(1) << u32_ofs) - 1));
1365 /* Returns the uint32_t that would be at byte offset '4 * u32_ofs' if 'flow'
1366 * were expanded into a "struct flow". */
1368 miniflow_get(const struct miniflow *flow, unsigned int u32_ofs)
1370 return *miniflow_get__(flow, u32_ofs);
1373 /* Returns the ovs_be16 that would be at byte offset 'u8_ofs' if 'flow' were
1374 * expanded into a "struct flow". */
1376 miniflow_get_be16(const struct miniflow *flow, unsigned int u8_ofs)
1378 const uint32_t *u32p = miniflow_get__(flow, u8_ofs / 4);
1379 const ovs_be16 *be16p = (const ovs_be16 *) u32p;
1380 return be16p[u8_ofs % 4 != 0];
1383 /* Returns the VID within the vlan_tci member of the "struct flow" represented
1386 miniflow_get_vid(const struct miniflow *flow)
1388 ovs_be16 tci = miniflow_get_be16(flow, offsetof(struct flow, vlan_tci));
1389 return vlan_tci_to_vid(tci);
1392 /* Returns true if 'a' and 'b' are the same flow, false otherwise. */
1394 miniflow_equal(const struct miniflow *a, const struct miniflow *b)
1396 const uint32_t *ap = a->values;
1397 const uint32_t *bp = b->values;
1398 const uint64_t a_map = a->map;
1399 const uint64_t b_map = b->map;
1402 if (a_map == b_map) {
1403 for (map = a_map; map; map = zero_rightmost_1bit(map)) {
1404 if (*ap++ != *bp++) {
1409 for (map = a_map | b_map; map; map = zero_rightmost_1bit(map)) {
1410 uint64_t bit = rightmost_1bit(map);
1411 uint64_t a_value = a_map & bit ? *ap++ : 0;
1412 uint64_t b_value = b_map & bit ? *bp++ : 0;
1414 if (a_value != b_value) {
1423 /* Returns true if 'a' and 'b' are equal at the places where there are 1-bits
1424 * in 'mask', false if they differ. */
1426 miniflow_equal_in_minimask(const struct miniflow *a, const struct miniflow *b,
1427 const struct minimask *mask)
1432 p = mask->masks.values;
1434 for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1435 int ofs = raw_ctz(map);
1437 if ((miniflow_get(a, ofs) ^ miniflow_get(b, ofs)) & *p) {
1446 /* Returns true if 'a' and 'b' are equal at the places where there are 1-bits
1447 * in 'mask', false if they differ. */
1449 miniflow_equal_flow_in_minimask(const struct miniflow *a, const struct flow *b,
1450 const struct minimask *mask)
1452 const uint32_t *b_u32 = (const uint32_t *) b;
1456 p = mask->masks.values;
1458 for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1459 int ofs = raw_ctz(map);
1461 if ((miniflow_get(a, ofs) ^ b_u32[ofs]) & *p) {
1470 /* Returns a hash value for 'flow', given 'basis'. */
1472 miniflow_hash(const struct miniflow *flow, uint32_t basis)
1474 const uint32_t *p = flow->values;
1475 uint32_t hash = basis;
1476 uint64_t hash_map = 0;
1479 for (map = flow->map; map; map = zero_rightmost_1bit(map)) {
1481 hash = mhash_add(hash, *p);
1482 hash_map |= rightmost_1bit(map);
1486 hash = mhash_add(hash, hash_map);
1487 hash = mhash_add(hash, hash_map >> 32);
1489 return mhash_finish(hash, p - flow->values);
1492 /* Returns a hash value for the bits of 'flow' where there are 1-bits in
1493 * 'mask', given 'basis'.
1495 * The hash values returned by this function are the same as those returned by
1496 * flow_hash_in_minimask(), only the form of the arguments differ. */
1498 miniflow_hash_in_minimask(const struct miniflow *flow,
1499 const struct minimask *mask, uint32_t basis)
1501 const uint32_t *p = mask->masks.values;
1507 for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1509 int ofs = raw_ctz(map);
1510 hash = mhash_add(hash, miniflow_get(flow, ofs) & *p);
1515 return mhash_finish(hash, (p - mask->masks.values) * 4);
1518 /* Returns a hash value for the bits of 'flow' where there are 1-bits in
1519 * 'mask', given 'basis'.
1521 * The hash values returned by this function are the same as those returned by
1522 * miniflow_hash_in_minimask(), only the form of the arguments differ. */
1524 flow_hash_in_minimask(const struct flow *flow, const struct minimask *mask,
1527 const uint32_t *flow_u32 = (const uint32_t *)flow;
1528 const uint32_t *p = mask->masks.values;
1533 for (map = mask->masks.map; map; map = zero_rightmost_1bit(map)) {
1535 hash = mhash_add(hash, flow_u32[raw_ctz(map)] & *p);
1540 return mhash_finish(hash, (p - mask->masks.values) * 4);
1543 /* Returns a hash value for the bits of range [start, end) in 'flow',
1544 * where there are 1-bits in 'mask', given 'hash'.
1546 * The hash values returned by this function are the same as those returned by
1547 * minimatch_hash_range(), only the form of the arguments differ. */
1549 flow_hash_in_minimask_range(const struct flow *flow,
1550 const struct minimask *mask,
1551 uint8_t start, uint8_t end, uint32_t *basis)
1553 const uint32_t *flow_u32 = (const uint32_t *)flow;
1555 uint64_t map = miniflow_get_map_in_range(&mask->masks, start, end, &p);
1556 uint32_t hash = *basis;
1558 for (; map; map = zero_rightmost_1bit(map)) {
1560 hash = mhash_add(hash, flow_u32[raw_ctz(map)] & *p);
1565 *basis = hash; /* Allow continuation from the unfinished value. */
1566 return mhash_finish(hash, (p - mask->masks.values) * 4);
1570 /* Initializes 'dst' as a copy of 'src'. The caller must eventually free 'dst'
1571 * with minimask_destroy(). */
1573 minimask_init(struct minimask *mask, const struct flow_wildcards *wc)
1575 miniflow_init(&mask->masks, &wc->masks);
1578 /* Initializes 'dst' as a copy of 'src'. The caller must eventually free 'dst'
1579 * with minimask_destroy(). */
1581 minimask_clone(struct minimask *dst, const struct minimask *src)
1583 miniflow_clone(&dst->masks, &src->masks);
1586 /* Initializes 'dst' with the data in 'src', destroying 'src'.
1587 * The caller must eventually free 'dst' with minimask_destroy(). */
1589 minimask_move(struct minimask *dst, struct minimask *src)
1591 miniflow_move(&dst->masks, &src->masks);
1594 /* Initializes 'dst_' as the bit-wise "and" of 'a_' and 'b_'.
1596 * The caller must provide room for FLOW_U32S "uint32_t"s in 'storage', for use
1597 * by 'dst_'. The caller must *not* free 'dst_' with minimask_destroy(). */
1599 minimask_combine(struct minimask *dst_,
1600 const struct minimask *a_, const struct minimask *b_,
1601 uint32_t storage[FLOW_U32S])
1603 struct miniflow *dst = &dst_->masks;
1604 const struct miniflow *a = &a_->masks;
1605 const struct miniflow *b = &b_->masks;
1609 dst->values = storage;
1612 for (map = a->map & b->map; map; map = zero_rightmost_1bit(map)) {
1613 int ofs = raw_ctz(map);
1614 uint32_t mask = miniflow_get(a, ofs) & miniflow_get(b, ofs);
1617 dst->map |= rightmost_1bit(map);
1618 dst->values[n++] = mask;
1623 /* Frees any memory owned by 'mask'. Does not free the storage in which 'mask'
1624 * itself resides; the caller is responsible for that. */
1626 minimask_destroy(struct minimask *mask)
1628 miniflow_destroy(&mask->masks);
1631 /* Initializes 'dst' as a copy of 'src'. */
1633 minimask_expand(const struct minimask *mask, struct flow_wildcards *wc)
1635 miniflow_expand(&mask->masks, &wc->masks);
1638 /* Returns the uint32_t that would be at byte offset '4 * u32_ofs' if 'mask'
1639 * were expanded into a "struct flow_wildcards". */
1641 minimask_get(const struct minimask *mask, unsigned int u32_ofs)
1643 return miniflow_get(&mask->masks, u32_ofs);
1646 /* Returns the VID mask within the vlan_tci member of the "struct
1647 * flow_wildcards" represented by 'mask'. */
1649 minimask_get_vid_mask(const struct minimask *mask)
1651 return miniflow_get_vid(&mask->masks);
1654 /* Returns true if 'a' and 'b' are the same flow mask, false otherwise. */
1656 minimask_equal(const struct minimask *a, const struct minimask *b)
1658 return miniflow_equal(&a->masks, &b->masks);
1661 /* Returns a hash value for 'mask', given 'basis'. */
1663 minimask_hash(const struct minimask *mask, uint32_t basis)
1665 return miniflow_hash(&mask->masks, basis);
1668 /* Returns true if at least one bit is wildcarded in 'a_' but not in 'b_',
1669 * false otherwise. */
1671 minimask_has_extra(const struct minimask *a_, const struct minimask *b_)
1673 const struct miniflow *a = &a_->masks;
1674 const struct miniflow *b = &b_->masks;
1677 for (map = a->map | b->map; map; map = zero_rightmost_1bit(map)) {
1678 int ofs = raw_ctz(map);
1679 uint32_t a_u32 = miniflow_get(a, ofs);
1680 uint32_t b_u32 = miniflow_get(b, ofs);
1682 if ((a_u32 & b_u32) != b_u32) {
1690 /* Returns true if 'mask' matches every packet, false if 'mask' fixes any bits
1693 minimask_is_catchall(const struct minimask *mask_)
1695 const struct miniflow *mask = &mask_->masks;
1696 const uint32_t *p = mask->values;
1699 for (map = mask->map; map; map = zero_rightmost_1bit(map)) {