2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 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"
35 #include "dp-packet.h"
36 #include "openflow/openflow.h"
40 #include "unaligned.h"
42 COVERAGE_DEFINE(flow_extract);
43 COVERAGE_DEFINE(miniflow_malloc);
45 /* U64 indices for segmented flow classification. */
46 const uint8_t flow_segment_u64s[4] = {
47 FLOW_SEGMENT_1_ENDS_AT / sizeof(uint64_t),
48 FLOW_SEGMENT_2_ENDS_AT / sizeof(uint64_t),
49 FLOW_SEGMENT_3_ENDS_AT / sizeof(uint64_t),
53 /* Asserts that field 'f1' follows immediately after 'f0' in struct flow,
54 * without any intervening padding. */
55 #define ASSERT_SEQUENTIAL(f0, f1) \
56 BUILD_ASSERT_DECL(offsetof(struct flow, f0) \
57 + MEMBER_SIZEOF(struct flow, f0) \
58 == offsetof(struct flow, f1))
60 /* Asserts that fields 'f0' and 'f1' are in the same 32-bit aligned word within
62 #define ASSERT_SAME_WORD(f0, f1) \
63 BUILD_ASSERT_DECL(offsetof(struct flow, f0) / 4 \
64 == offsetof(struct flow, f1) / 4)
66 /* Asserts that 'f0' and 'f1' are both sequential and within the same 32-bit
67 * aligned word in struct flow. */
68 #define ASSERT_SEQUENTIAL_SAME_WORD(f0, f1) \
69 ASSERT_SEQUENTIAL(f0, f1); \
70 ASSERT_SAME_WORD(f0, f1)
72 /* miniflow_extract() assumes the following to be true to optimize the
73 * extraction process. */
74 ASSERT_SEQUENTIAL_SAME_WORD(dl_type, vlan_tci);
76 ASSERT_SEQUENTIAL_SAME_WORD(nw_frag, nw_tos);
77 ASSERT_SEQUENTIAL_SAME_WORD(nw_tos, nw_ttl);
78 ASSERT_SEQUENTIAL_SAME_WORD(nw_ttl, nw_proto);
80 /* TCP flags in the middle of a BE64, zeroes in the other half. */
81 BUILD_ASSERT_DECL(offsetof(struct flow, tcp_flags) % 8 == 4);
84 #define TCP_FLAGS_BE32(tcp_ctl) ((OVS_FORCE ovs_be32)TCP_FLAGS_BE16(tcp_ctl) \
87 #define TCP_FLAGS_BE32(tcp_ctl) ((OVS_FORCE ovs_be32)TCP_FLAGS_BE16(tcp_ctl))
90 ASSERT_SEQUENTIAL_SAME_WORD(tp_src, tp_dst);
92 /* Removes 'size' bytes from the head end of '*datap', of size '*sizep', which
93 * must contain at least 'size' bytes of data. Returns the first byte of data
95 static inline const void *
96 data_pull(const void **datap, size_t *sizep, size_t size)
98 const char *data = *datap;
104 /* If '*datap' has at least 'size' bytes of data, removes that many bytes from
105 * the head end of '*datap' and returns the first byte removed. Otherwise,
106 * returns a null pointer without modifying '*datap'. */
107 static inline const void *
108 data_try_pull(const void **datap, size_t *sizep, size_t size)
110 return OVS_LIKELY(*sizep >= size) ? data_pull(datap, sizep, size) : NULL;
113 /* Context for pushing data to a miniflow. */
117 uint64_t * const end;
120 /* miniflow_push_* macros allow filling in a miniflow data values in order.
121 * Assertions are needed only when the layout of the struct flow is modified.
122 * 'ofs' is a compile-time constant, which allows most of the code be optimized
123 * away. Some GCC versions gave warnings on ALWAYS_INLINE, so these are
124 * defined as macros. */
126 #if (FLOW_WC_SEQ != 32)
127 #define MINIFLOW_ASSERT(X) ovs_assert(X)
128 BUILD_MESSAGE("FLOW_WC_SEQ changed: miniflow_extract() will have runtime "
129 "assertions enabled. Consider updating FLOW_WC_SEQ after "
132 #define MINIFLOW_ASSERT(X)
135 #define miniflow_push_uint64_(MF, OFS, VALUE) \
137 MINIFLOW_ASSERT(MF.data < MF.end && (OFS) % 8 == 0 \
138 && !(MF.map & (UINT64_MAX << (OFS) / 8))); \
139 *MF.data++ = VALUE; \
140 MF.map |= UINT64_C(1) << (OFS) / 8; \
143 #define miniflow_push_be64_(MF, OFS, VALUE) \
144 miniflow_push_uint64_(MF, OFS, (OVS_FORCE uint64_t)(VALUE))
146 #define miniflow_push_uint32_(MF, OFS, VALUE) \
148 MINIFLOW_ASSERT(MF.data < MF.end && \
149 (((OFS) % 8 == 0 && !(MF.map & (UINT64_MAX << (OFS) / 8))) \
150 || ((OFS) % 8 == 4 && MF.map & (UINT64_C(1) << (OFS) / 8) \
151 && !(MF.map & (UINT64_MAX << ((OFS) / 8 + 1)))))); \
153 if ((OFS) % 8 == 0) { \
154 *(uint32_t *)MF.data = VALUE; \
155 MF.map |= UINT64_C(1) << (OFS) / 8; \
156 } else if ((OFS) % 8 == 4) { \
157 *((uint32_t *)MF.data + 1) = VALUE; \
162 #define miniflow_push_be32_(MF, OFS, VALUE) \
163 miniflow_push_uint32_(MF, OFS, (OVS_FORCE uint32_t)(VALUE))
165 #define miniflow_push_uint16_(MF, OFS, VALUE) \
167 MINIFLOW_ASSERT(MF.data < MF.end && \
168 (((OFS) % 8 == 0 && !(MF.map & (UINT64_MAX << (OFS) / 8))) \
169 || ((OFS) % 2 == 0 && MF.map & (UINT64_C(1) << (OFS) / 8) \
170 && !(MF.map & (UINT64_MAX << ((OFS) / 8 + 1)))))); \
172 if ((OFS) % 8 == 0) { \
173 *(uint16_t *)MF.data = VALUE; \
174 MF.map |= UINT64_C(1) << (OFS) / 8; \
175 } else if ((OFS) % 8 == 2) { \
176 *((uint16_t *)MF.data + 1) = VALUE; \
177 } else if ((OFS) % 8 == 4) { \
178 *((uint16_t *)MF.data + 2) = VALUE; \
179 } else if ((OFS) % 8 == 6) { \
180 *((uint16_t *)MF.data + 3) = VALUE; \
185 #define miniflow_pad_to_64_(MF, OFS) \
187 MINIFLOW_ASSERT((OFS) % 8 != 0); \
188 MINIFLOW_ASSERT(MF.map & (UINT64_C(1) << (OFS) / 8)); \
189 MINIFLOW_ASSERT(!(MF.map & (UINT64_MAX << ((OFS) / 8 + 1)))); \
191 memset((uint8_t *)MF.data + (OFS) % 8, 0, 8 - (OFS) % 8); \
195 #define miniflow_push_be16_(MF, OFS, VALUE) \
196 miniflow_push_uint16_(MF, OFS, (OVS_FORCE uint16_t)VALUE);
198 /* Data at 'valuep' may be unaligned. */
199 #define miniflow_push_words_(MF, OFS, VALUEP, N_WORDS) \
201 int ofs64 = (OFS) / 8; \
203 MINIFLOW_ASSERT(MF.data + (N_WORDS) <= MF.end && (OFS) % 8 == 0 \
204 && !(MF.map & (UINT64_MAX << ofs64))); \
206 memcpy(MF.data, (VALUEP), (N_WORDS) * sizeof *MF.data); \
207 MF.data += (N_WORDS); \
208 MF.map |= ((UINT64_MAX >> (64 - (N_WORDS))) << ofs64); \
211 /* Push 32-bit words padded to 64-bits. */
212 #define miniflow_push_words_32_(MF, OFS, VALUEP, N_WORDS) \
214 int ofs64 = (OFS) / 8; \
216 MINIFLOW_ASSERT(MF.data + DIV_ROUND_UP(N_WORDS, 2) <= MF.end \
218 && !(MF.map & (UINT64_MAX << ofs64))); \
220 memcpy(MF.data, (VALUEP), (N_WORDS) * sizeof(uint32_t)); \
221 MF.data += DIV_ROUND_UP(N_WORDS, 2); \
222 MF.map |= ((UINT64_MAX >> (64 - DIV_ROUND_UP(N_WORDS, 2))) << ofs64); \
223 if ((N_WORDS) & 1) { \
224 *((uint32_t *)MF.data - 1) = 0; \
228 /* Data at 'valuep' may be unaligned. */
229 /* MACs start 64-aligned, and must be followed by other data or padding. */
230 #define miniflow_push_macs_(MF, OFS, VALUEP) \
232 int ofs64 = (OFS) / 8; \
234 MINIFLOW_ASSERT(MF.data + 2 <= MF.end && (OFS) % 8 == 0 \
235 && !(MF.map & (UINT64_MAX << ofs64))); \
237 memcpy(MF.data, (VALUEP), 2 * ETH_ADDR_LEN); \
238 MF.data += 1; /* First word only. */ \
239 MF.map |= UINT64_C(3) << ofs64; /* Both words. */ \
242 #define miniflow_push_uint32(MF, FIELD, VALUE) \
243 miniflow_push_uint32_(MF, offsetof(struct flow, FIELD), VALUE)
245 #define miniflow_push_be32(MF, FIELD, VALUE) \
246 miniflow_push_be32_(MF, offsetof(struct flow, FIELD), VALUE)
248 #define miniflow_push_uint16(MF, FIELD, VALUE) \
249 miniflow_push_uint16_(MF, offsetof(struct flow, FIELD), VALUE)
251 #define miniflow_push_be16(MF, FIELD, VALUE) \
252 miniflow_push_be16_(MF, offsetof(struct flow, FIELD), VALUE)
254 #define miniflow_pad_to_64(MF, FIELD) \
255 miniflow_pad_to_64_(MF, offsetof(struct flow, FIELD))
257 #define miniflow_push_words(MF, FIELD, VALUEP, N_WORDS) \
258 miniflow_push_words_(MF, offsetof(struct flow, FIELD), VALUEP, N_WORDS)
260 #define miniflow_push_words_32(MF, FIELD, VALUEP, N_WORDS) \
261 miniflow_push_words_32_(MF, offsetof(struct flow, FIELD), VALUEP, N_WORDS)
263 #define miniflow_push_macs(MF, FIELD, VALUEP) \
264 miniflow_push_macs_(MF, offsetof(struct flow, FIELD), VALUEP)
266 /* Pulls the MPLS headers at '*datap' and returns the count of them. */
268 parse_mpls(const void **datap, size_t *sizep)
270 const struct mpls_hdr *mh;
273 while ((mh = data_try_pull(datap, sizep, sizeof *mh))) {
275 if (mh->mpls_lse.lo & htons(1 << MPLS_BOS_SHIFT)) {
279 return MIN(count, FLOW_MAX_MPLS_LABELS);
282 static inline ovs_be16
283 parse_vlan(const void **datap, size_t *sizep)
285 const struct eth_header *eth = *datap;
288 ovs_be16 eth_type; /* ETH_TYPE_VLAN */
292 data_pull(datap, sizep, ETH_ADDR_LEN * 2);
294 if (eth->eth_type == htons(ETH_TYPE_VLAN)) {
295 if (OVS_LIKELY(*sizep
296 >= sizeof(struct qtag_prefix) + sizeof(ovs_be16))) {
297 const struct qtag_prefix *qp = data_pull(datap, sizep, sizeof *qp);
298 return qp->tci | htons(VLAN_CFI);
304 static inline ovs_be16
305 parse_ethertype(const void **datap, size_t *sizep)
307 const struct llc_snap_header *llc;
310 proto = *(ovs_be16 *) data_pull(datap, sizep, sizeof proto);
311 if (OVS_LIKELY(ntohs(proto) >= ETH_TYPE_MIN)) {
315 if (OVS_UNLIKELY(*sizep < sizeof *llc)) {
316 return htons(FLOW_DL_TYPE_NONE);
320 if (OVS_UNLIKELY(llc->llc.llc_dsap != LLC_DSAP_SNAP
321 || llc->llc.llc_ssap != LLC_SSAP_SNAP
322 || llc->llc.llc_cntl != LLC_CNTL_SNAP
323 || memcmp(llc->snap.snap_org, SNAP_ORG_ETHERNET,
324 sizeof llc->snap.snap_org))) {
325 return htons(FLOW_DL_TYPE_NONE);
328 data_pull(datap, sizep, sizeof *llc);
330 if (OVS_LIKELY(ntohs(llc->snap.snap_type) >= ETH_TYPE_MIN)) {
331 return llc->snap.snap_type;
334 return htons(FLOW_DL_TYPE_NONE);
338 parse_icmpv6(const void **datap, size_t *sizep, const struct icmp6_hdr *icmp,
339 const struct in6_addr **nd_target,
340 uint8_t arp_buf[2][ETH_ADDR_LEN])
342 if (icmp->icmp6_code == 0 &&
343 (icmp->icmp6_type == ND_NEIGHBOR_SOLICIT ||
344 icmp->icmp6_type == ND_NEIGHBOR_ADVERT)) {
346 *nd_target = data_try_pull(datap, sizep, sizeof **nd_target);
347 if (OVS_UNLIKELY(!*nd_target)) {
351 while (*sizep >= 8) {
352 /* The minimum size of an option is 8 bytes, which also is
353 * the size of Ethernet link-layer options. */
354 const struct nd_opt_hdr *nd_opt = *datap;
355 int opt_len = nd_opt->nd_opt_len * 8;
357 if (!opt_len || opt_len > *sizep) {
361 /* Store the link layer address if the appropriate option is
362 * provided. It is considered an error if the same link
363 * layer option is specified twice. */
364 if (nd_opt->nd_opt_type == ND_OPT_SOURCE_LINKADDR
366 if (OVS_LIKELY(eth_addr_is_zero(arp_buf[0]))) {
367 memcpy(arp_buf[0], nd_opt + 1, ETH_ADDR_LEN);
371 } else if (nd_opt->nd_opt_type == ND_OPT_TARGET_LINKADDR
373 if (OVS_LIKELY(eth_addr_is_zero(arp_buf[1]))) {
374 memcpy(arp_buf[1], nd_opt + 1, ETH_ADDR_LEN);
380 if (OVS_UNLIKELY(!data_try_pull(datap, sizep, opt_len))) {
392 /* Initializes 'flow' members from 'packet' and 'md'
394 * Initializes 'packet' header l2 pointer to the start of the Ethernet
395 * header, and the layer offsets as follows:
397 * - packet->l2_5_ofs to the start of the MPLS shim header, or UINT16_MAX
398 * when there is no MPLS shim header.
400 * - packet->l3_ofs to just past the Ethernet header, or just past the
401 * vlan_header if one is present, to the first byte of the payload of the
402 * Ethernet frame. UINT16_MAX if the frame is too short to contain an
405 * - packet->l4_ofs to just past the IPv4 header, if one is present and
406 * has at least the content used for the fields of interest for the flow,
407 * otherwise UINT16_MAX.
410 flow_extract(struct dp_packet *packet, struct flow *flow)
414 uint64_t buf[FLOW_U64S];
417 COVERAGE_INC(flow_extract);
419 miniflow_initialize(&m.mf, m.buf);
420 miniflow_extract(packet, &m.mf);
421 miniflow_expand(&m.mf, flow);
424 /* Caller is responsible for initializing 'dst' with enough storage for
425 * FLOW_U64S * 8 bytes. */
427 miniflow_extract(struct dp_packet *packet, struct miniflow *dst)
429 const struct pkt_metadata *md = &packet->md;
430 const void *data = dp_packet_data(packet);
431 size_t size = dp_packet_size(packet);
432 uint64_t *values = miniflow_values(dst);
433 struct mf_ctx mf = { 0, values, values + FLOW_U64S };
436 uint8_t nw_frag, nw_tos, nw_ttl, nw_proto;
439 if (md->tunnel.ip_dst) {
440 miniflow_push_words(mf, tunnel, &md->tunnel,
441 sizeof md->tunnel / sizeof(uint64_t));
443 if (md->skb_priority || md->pkt_mark) {
444 miniflow_push_uint32(mf, skb_priority, md->skb_priority);
445 miniflow_push_uint32(mf, pkt_mark, md->pkt_mark);
447 miniflow_push_uint32(mf, dp_hash, md->dp_hash);
448 miniflow_push_uint32(mf, in_port, odp_to_u32(md->in_port.odp_port));
450 miniflow_push_uint32(mf, recirc_id, md->recirc_id);
451 miniflow_pad_to_64(mf, conj_id);
454 /* Initialize packet's layer pointer and offsets. */
456 dp_packet_reset_offsets(packet);
458 /* Must have full Ethernet header to proceed. */
459 if (OVS_UNLIKELY(size < sizeof(struct eth_header))) {
465 ASSERT_SEQUENTIAL(dl_dst, dl_src);
466 miniflow_push_macs(mf, dl_dst, data);
467 /* dl_type, vlan_tci. */
468 vlan_tci = parse_vlan(&data, &size);
469 dl_type = parse_ethertype(&data, &size);
470 miniflow_push_be16(mf, dl_type, dl_type);
471 miniflow_push_be16(mf, vlan_tci, vlan_tci);
475 if (OVS_UNLIKELY(eth_type_mpls(dl_type))) {
477 const void *mpls = data;
479 packet->l2_5_ofs = (char *)data - l2;
480 count = parse_mpls(&data, &size);
481 miniflow_push_words_32(mf, mpls_lse, mpls, count);
485 packet->l3_ofs = (char *)data - l2;
488 if (OVS_LIKELY(dl_type == htons(ETH_TYPE_IP))) {
489 const struct ip_header *nh = data;
493 if (OVS_UNLIKELY(size < IP_HEADER_LEN)) {
496 ip_len = IP_IHL(nh->ip_ihl_ver) * 4;
498 if (OVS_UNLIKELY(ip_len < IP_HEADER_LEN)) {
501 if (OVS_UNLIKELY(size < ip_len)) {
504 tot_len = ntohs(nh->ip_tot_len);
505 if (OVS_UNLIKELY(tot_len > size)) {
508 if (OVS_UNLIKELY(size - tot_len > UINT8_MAX)) {
511 dp_packet_set_l2_pad_size(packet, size - tot_len);
512 size = tot_len; /* Never pull padding. */
514 /* Push both source and destination address at once. */
515 miniflow_push_words(mf, nw_src, &nh->ip_src, 1);
517 miniflow_push_be32(mf, ipv6_label, 0); /* Padding for IPv4. */
521 nw_proto = nh->ip_proto;
522 if (OVS_UNLIKELY(IP_IS_FRAGMENT(nh->ip_frag_off))) {
523 nw_frag = FLOW_NW_FRAG_ANY;
524 if (nh->ip_frag_off & htons(IP_FRAG_OFF_MASK)) {
525 nw_frag |= FLOW_NW_FRAG_LATER;
528 data_pull(&data, &size, ip_len);
529 } else if (dl_type == htons(ETH_TYPE_IPV6)) {
530 const struct ovs_16aligned_ip6_hdr *nh;
534 if (OVS_UNLIKELY(size < sizeof *nh)) {
537 nh = data_pull(&data, &size, sizeof *nh);
539 plen = ntohs(nh->ip6_plen);
540 if (OVS_UNLIKELY(plen > size)) {
543 /* Jumbo Payload option not supported yet. */
544 if (OVS_UNLIKELY(size - plen > UINT8_MAX)) {
547 dp_packet_set_l2_pad_size(packet, size - plen);
548 size = plen; /* Never pull padding. */
550 miniflow_push_words(mf, ipv6_src, &nh->ip6_src,
551 sizeof nh->ip6_src / 8);
552 miniflow_push_words(mf, ipv6_dst, &nh->ip6_dst,
553 sizeof nh->ip6_dst / 8);
555 tc_flow = get_16aligned_be32(&nh->ip6_flow);
557 ovs_be32 label = tc_flow & htonl(IPV6_LABEL_MASK);
558 miniflow_push_be32(mf, ipv6_label, label);
561 nw_tos = ntohl(tc_flow) >> 20;
562 nw_ttl = nh->ip6_hlim;
563 nw_proto = nh->ip6_nxt;
566 if (OVS_LIKELY((nw_proto != IPPROTO_HOPOPTS)
567 && (nw_proto != IPPROTO_ROUTING)
568 && (nw_proto != IPPROTO_DSTOPTS)
569 && (nw_proto != IPPROTO_AH)
570 && (nw_proto != IPPROTO_FRAGMENT))) {
571 /* It's either a terminal header (e.g., TCP, UDP) or one we
572 * don't understand. In either case, we're done with the
573 * packet, so use it to fill in 'nw_proto'. */
577 /* We only verify that at least 8 bytes of the next header are
578 * available, but many of these headers are longer. Ensure that
579 * accesses within the extension header are within those first 8
580 * bytes. All extension headers are required to be at least 8
582 if (OVS_UNLIKELY(size < 8)) {
586 if ((nw_proto == IPPROTO_HOPOPTS)
587 || (nw_proto == IPPROTO_ROUTING)
588 || (nw_proto == IPPROTO_DSTOPTS)) {
589 /* These headers, while different, have the fields we care
590 * about in the same location and with the same
592 const struct ip6_ext *ext_hdr = data;
593 nw_proto = ext_hdr->ip6e_nxt;
594 if (OVS_UNLIKELY(!data_try_pull(&data, &size,
595 (ext_hdr->ip6e_len + 1) * 8))) {
598 } else if (nw_proto == IPPROTO_AH) {
599 /* A standard AH definition isn't available, but the fields
600 * we care about are in the same location as the generic
601 * option header--only the header length is calculated
603 const struct ip6_ext *ext_hdr = data;
604 nw_proto = ext_hdr->ip6e_nxt;
605 if (OVS_UNLIKELY(!data_try_pull(&data, &size,
606 (ext_hdr->ip6e_len + 2) * 4))) {
609 } else if (nw_proto == IPPROTO_FRAGMENT) {
610 const struct ovs_16aligned_ip6_frag *frag_hdr = data;
612 nw_proto = frag_hdr->ip6f_nxt;
613 if (!data_try_pull(&data, &size, sizeof *frag_hdr)) {
617 /* We only process the first fragment. */
618 if (frag_hdr->ip6f_offlg != htons(0)) {
619 nw_frag = FLOW_NW_FRAG_ANY;
620 if ((frag_hdr->ip6f_offlg & IP6F_OFF_MASK) != htons(0)) {
621 nw_frag |= FLOW_NW_FRAG_LATER;
622 nw_proto = IPPROTO_FRAGMENT;
629 if (dl_type == htons(ETH_TYPE_ARP) ||
630 dl_type == htons(ETH_TYPE_RARP)) {
631 uint8_t arp_buf[2][ETH_ADDR_LEN];
632 const struct arp_eth_header *arp = (const struct arp_eth_header *)
633 data_try_pull(&data, &size, ARP_ETH_HEADER_LEN);
635 if (OVS_LIKELY(arp) && OVS_LIKELY(arp->ar_hrd == htons(1))
636 && OVS_LIKELY(arp->ar_pro == htons(ETH_TYPE_IP))
637 && OVS_LIKELY(arp->ar_hln == ETH_ADDR_LEN)
638 && OVS_LIKELY(arp->ar_pln == 4)) {
639 miniflow_push_be32(mf, nw_src,
640 get_16aligned_be32(&arp->ar_spa));
641 miniflow_push_be32(mf, nw_dst,
642 get_16aligned_be32(&arp->ar_tpa));
644 /* We only match on the lower 8 bits of the opcode. */
645 if (OVS_LIKELY(ntohs(arp->ar_op) <= 0xff)) {
646 miniflow_push_be32(mf, ipv6_label, 0); /* Pad with ARP. */
647 miniflow_push_be32(mf, nw_frag, htonl(ntohs(arp->ar_op)));
650 /* Must be adjacent. */
651 ASSERT_SEQUENTIAL(arp_sha, arp_tha);
653 memcpy(arp_buf[0], arp->ar_sha, ETH_ADDR_LEN);
654 memcpy(arp_buf[1], arp->ar_tha, ETH_ADDR_LEN);
655 miniflow_push_macs(mf, arp_sha, arp_buf);
656 miniflow_pad_to_64(mf, tcp_flags);
662 packet->l4_ofs = (char *)data - l2;
663 miniflow_push_be32(mf, nw_frag,
664 BYTES_TO_BE32(nw_frag, nw_tos, nw_ttl, nw_proto));
666 if (OVS_LIKELY(!(nw_frag & FLOW_NW_FRAG_LATER))) {
667 if (OVS_LIKELY(nw_proto == IPPROTO_TCP)) {
668 if (OVS_LIKELY(size >= TCP_HEADER_LEN)) {
669 const struct tcp_header *tcp = data;
671 miniflow_push_be32(mf, arp_tha[2], 0);
672 miniflow_push_be32(mf, tcp_flags,
673 TCP_FLAGS_BE32(tcp->tcp_ctl));
674 miniflow_push_be16(mf, tp_src, tcp->tcp_src);
675 miniflow_push_be16(mf, tp_dst, tcp->tcp_dst);
676 miniflow_pad_to_64(mf, igmp_group_ip4);
678 } else if (OVS_LIKELY(nw_proto == IPPROTO_UDP)) {
679 if (OVS_LIKELY(size >= UDP_HEADER_LEN)) {
680 const struct udp_header *udp = data;
682 miniflow_push_be16(mf, tp_src, udp->udp_src);
683 miniflow_push_be16(mf, tp_dst, udp->udp_dst);
684 miniflow_pad_to_64(mf, igmp_group_ip4);
686 } else if (OVS_LIKELY(nw_proto == IPPROTO_SCTP)) {
687 if (OVS_LIKELY(size >= SCTP_HEADER_LEN)) {
688 const struct sctp_header *sctp = data;
690 miniflow_push_be16(mf, tp_src, sctp->sctp_src);
691 miniflow_push_be16(mf, tp_dst, sctp->sctp_dst);
692 miniflow_pad_to_64(mf, igmp_group_ip4);
694 } else if (OVS_LIKELY(nw_proto == IPPROTO_ICMP)) {
695 if (OVS_LIKELY(size >= ICMP_HEADER_LEN)) {
696 const struct icmp_header *icmp = data;
698 miniflow_push_be16(mf, tp_src, htons(icmp->icmp_type));
699 miniflow_push_be16(mf, tp_dst, htons(icmp->icmp_code));
700 miniflow_pad_to_64(mf, igmp_group_ip4);
702 } else if (OVS_LIKELY(nw_proto == IPPROTO_IGMP)) {
703 if (OVS_LIKELY(size >= IGMP_HEADER_LEN)) {
704 const struct igmp_header *igmp = data;
706 miniflow_push_be16(mf, tp_src, htons(igmp->igmp_type));
707 miniflow_push_be16(mf, tp_dst, htons(igmp->igmp_code));
708 miniflow_push_be32(mf, igmp_group_ip4,
709 get_16aligned_be32(&igmp->group));
711 } else if (OVS_LIKELY(nw_proto == IPPROTO_ICMPV6)) {
712 if (OVS_LIKELY(size >= sizeof(struct icmp6_hdr))) {
713 const struct in6_addr *nd_target = NULL;
714 uint8_t arp_buf[2][ETH_ADDR_LEN];
715 const struct icmp6_hdr *icmp = data_pull(&data, &size,
717 memset(arp_buf, 0, sizeof arp_buf);
718 if (OVS_LIKELY(parse_icmpv6(&data, &size, icmp, &nd_target,
721 miniflow_push_words(mf, nd_target, nd_target,
722 sizeof *nd_target / 8);
724 miniflow_push_macs(mf, arp_sha, arp_buf);
725 miniflow_pad_to_64(mf, tcp_flags);
726 miniflow_push_be16(mf, tp_src, htons(icmp->icmp6_type));
727 miniflow_push_be16(mf, tp_dst, htons(icmp->icmp6_code));
728 miniflow_pad_to_64(mf, igmp_group_ip4);
737 /* For every bit of a field that is wildcarded in 'wildcards', sets the
738 * corresponding bit in 'flow' to zero. */
740 flow_zero_wildcards(struct flow *flow, const struct flow_wildcards *wildcards)
742 uint64_t *flow_u64 = (uint64_t *) flow;
743 const uint64_t *wc_u64 = (const uint64_t *) &wildcards->masks;
746 for (i = 0; i < FLOW_U64S; i++) {
747 flow_u64[i] &= wc_u64[i];
752 flow_unwildcard_tp_ports(const struct flow *flow, struct flow_wildcards *wc)
754 if (flow->nw_proto != IPPROTO_ICMP) {
755 memset(&wc->masks.tp_src, 0xff, sizeof wc->masks.tp_src);
756 memset(&wc->masks.tp_dst, 0xff, sizeof wc->masks.tp_dst);
758 wc->masks.tp_src = htons(0xff);
759 wc->masks.tp_dst = htons(0xff);
763 /* Initializes 'flow_metadata' with the metadata found in 'flow'. */
765 flow_get_metadata(const struct flow *flow, struct match *flow_metadata)
769 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 32);
771 match_init_catchall(flow_metadata);
772 if (flow->tunnel.tun_id != htonll(0)) {
773 match_set_tun_id(flow_metadata, flow->tunnel.tun_id);
775 if (flow->tunnel.ip_src != htonl(0)) {
776 match_set_tun_src(flow_metadata, flow->tunnel.ip_src);
778 if (flow->tunnel.ip_dst != htonl(0)) {
779 match_set_tun_dst(flow_metadata, flow->tunnel.ip_dst);
781 if (flow->tunnel.gbp_id != htons(0)) {
782 match_set_tun_gbp_id(flow_metadata, flow->tunnel.gbp_id);
784 if (flow->tunnel.gbp_flags) {
785 match_set_tun_gbp_flags(flow_metadata, flow->tunnel.gbp_flags);
787 tun_metadata_get_fmd(&flow->tunnel.metadata, flow_metadata);
788 if (flow->metadata != htonll(0)) {
789 match_set_metadata(flow_metadata, flow->metadata);
792 for (i = 0; i < FLOW_N_REGS; i++) {
794 match_set_reg(flow_metadata, i, flow->regs[i]);
798 if (flow->pkt_mark != 0) {
799 match_set_pkt_mark(flow_metadata, flow->pkt_mark);
802 match_set_in_port(flow_metadata, flow->in_port.ofp_port);
806 flow_to_string(const struct flow *flow)
808 struct ds ds = DS_EMPTY_INITIALIZER;
809 flow_format(&ds, flow);
814 flow_tun_flag_to_string(uint32_t flags)
817 case FLOW_TNL_F_DONT_FRAGMENT:
819 case FLOW_TNL_F_CSUM:
831 format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t),
832 uint32_t flags, char del)
840 uint32_t bit = rightmost_1bit(flags);
843 s = bit_to_string(bit);
845 ds_put_format(ds, "%s%c", s, del);
854 ds_put_format(ds, "0x%"PRIx32"%c", bad, del);
860 format_flags_masked(struct ds *ds, const char *name,
861 const char *(*bit_to_string)(uint32_t), uint32_t flags,
865 ds_put_format(ds, "%s=", name);
868 uint32_t bit = rightmost_1bit(mask);
869 const char *s = bit_to_string(bit);
871 ds_put_format(ds, "%s%s", (flags & bit) ? "+" : "-",
872 s ? s : "[Unknown]");
878 flow_format(struct ds *ds, const struct flow *flow)
881 struct flow_wildcards *wc = &match.wc;
883 match_wc_init(&match, flow);
885 /* As this function is most often used for formatting a packet in a
886 * packet-in message, skip formatting the packet context fields that are
887 * all-zeroes to make the print-out easier on the eyes. This means that a
888 * missing context field implies a zero value for that field. This is
889 * similar to OpenFlow encoding of these fields, as the specification
890 * states that all-zeroes context fields should not be encoded in the
891 * packet-in messages. */
892 if (!flow->in_port.ofp_port) {
893 WC_UNMASK_FIELD(wc, in_port);
895 if (!flow->skb_priority) {
896 WC_UNMASK_FIELD(wc, skb_priority);
898 if (!flow->pkt_mark) {
899 WC_UNMASK_FIELD(wc, pkt_mark);
901 if (!flow->recirc_id) {
902 WC_UNMASK_FIELD(wc, recirc_id);
904 if (!flow->dp_hash) {
905 WC_UNMASK_FIELD(wc, dp_hash);
907 for (int i = 0; i < FLOW_N_REGS; i++) {
908 if (!flow->regs[i]) {
909 WC_UNMASK_FIELD(wc, regs[i]);
912 if (!flow->metadata) {
913 WC_UNMASK_FIELD(wc, metadata);
916 match_format(&match, ds, OFP_DEFAULT_PRIORITY);
920 flow_print(FILE *stream, const struct flow *flow)
922 char *s = flow_to_string(flow);
927 /* flow_wildcards functions. */
929 /* Initializes 'wc' as a set of wildcards that matches every packet. */
931 flow_wildcards_init_catchall(struct flow_wildcards *wc)
933 memset(&wc->masks, 0, sizeof wc->masks);
936 /* Converts a flow into flow wildcards. It sets the wildcard masks based on
937 * the packet headers extracted to 'flow'. It will not set the mask for fields
938 * that do not make sense for the packet type. OpenFlow-only metadata is
939 * wildcarded, but other metadata is unconditionally exact-matched. */
940 void flow_wildcards_init_for_packet(struct flow_wildcards *wc,
941 const struct flow *flow)
943 memset(&wc->masks, 0x0, sizeof wc->masks);
945 /* Update this function whenever struct flow changes. */
946 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 32);
948 if (flow->tunnel.ip_dst) {
949 if (flow->tunnel.flags & FLOW_TNL_F_KEY) {
950 WC_MASK_FIELD(wc, tunnel.tun_id);
952 WC_MASK_FIELD(wc, tunnel.ip_src);
953 WC_MASK_FIELD(wc, tunnel.ip_dst);
954 WC_MASK_FIELD(wc, tunnel.flags);
955 WC_MASK_FIELD(wc, tunnel.ip_tos);
956 WC_MASK_FIELD(wc, tunnel.ip_ttl);
957 WC_MASK_FIELD(wc, tunnel.tp_src);
958 WC_MASK_FIELD(wc, tunnel.tp_dst);
959 WC_MASK_FIELD(wc, tunnel.gbp_id);
960 WC_MASK_FIELD(wc, tunnel.gbp_flags);
962 if (flow->tunnel.metadata.opt_map) {
963 wc->masks.tunnel.metadata.opt_map = flow->tunnel.metadata.opt_map;
964 WC_MASK_FIELD(wc, tunnel.metadata.opts);
966 } else if (flow->tunnel.tun_id) {
967 WC_MASK_FIELD(wc, tunnel.tun_id);
970 /* metadata, regs, and conj_id wildcarded. */
972 WC_MASK_FIELD(wc, skb_priority);
973 WC_MASK_FIELD(wc, pkt_mark);
974 WC_MASK_FIELD(wc, recirc_id);
975 WC_MASK_FIELD(wc, dp_hash);
976 WC_MASK_FIELD(wc, in_port);
978 /* actset_output wildcarded. */
980 WC_MASK_FIELD(wc, dl_dst);
981 WC_MASK_FIELD(wc, dl_src);
982 WC_MASK_FIELD(wc, dl_type);
983 WC_MASK_FIELD(wc, vlan_tci);
985 if (flow->dl_type == htons(ETH_TYPE_IP)) {
986 WC_MASK_FIELD(wc, nw_src);
987 WC_MASK_FIELD(wc, nw_dst);
988 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
989 WC_MASK_FIELD(wc, ipv6_src);
990 WC_MASK_FIELD(wc, ipv6_dst);
991 WC_MASK_FIELD(wc, ipv6_label);
992 } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
993 flow->dl_type == htons(ETH_TYPE_RARP)) {
994 WC_MASK_FIELD(wc, nw_src);
995 WC_MASK_FIELD(wc, nw_dst);
996 WC_MASK_FIELD(wc, nw_proto);
997 WC_MASK_FIELD(wc, arp_sha);
998 WC_MASK_FIELD(wc, arp_tha);
1000 } else if (eth_type_mpls(flow->dl_type)) {
1001 for (int i = 0; i < FLOW_MAX_MPLS_LABELS; i++) {
1002 WC_MASK_FIELD(wc, mpls_lse[i]);
1003 if (flow->mpls_lse[i] & htonl(MPLS_BOS_MASK)) {
1009 return; /* Unknown ethertype. */
1013 WC_MASK_FIELD(wc, nw_frag);
1014 WC_MASK_FIELD(wc, nw_tos);
1015 WC_MASK_FIELD(wc, nw_ttl);
1016 WC_MASK_FIELD(wc, nw_proto);
1018 /* No transport layer header in later fragments. */
1019 if (!(flow->nw_frag & FLOW_NW_FRAG_LATER) &&
1020 (flow->nw_proto == IPPROTO_ICMP ||
1021 flow->nw_proto == IPPROTO_ICMPV6 ||
1022 flow->nw_proto == IPPROTO_TCP ||
1023 flow->nw_proto == IPPROTO_UDP ||
1024 flow->nw_proto == IPPROTO_SCTP ||
1025 flow->nw_proto == IPPROTO_IGMP)) {
1026 WC_MASK_FIELD(wc, tp_src);
1027 WC_MASK_FIELD(wc, tp_dst);
1029 if (flow->nw_proto == IPPROTO_TCP) {
1030 WC_MASK_FIELD(wc, tcp_flags);
1031 } else if (flow->nw_proto == IPPROTO_ICMPV6) {
1032 WC_MASK_FIELD(wc, arp_sha);
1033 WC_MASK_FIELD(wc, arp_tha);
1034 WC_MASK_FIELD(wc, nd_target);
1035 } else if (flow->nw_proto == IPPROTO_IGMP) {
1036 WC_MASK_FIELD(wc, igmp_group_ip4);
1041 /* Return a map of possible fields for a packet of the same type as 'flow'.
1042 * Including extra bits in the returned mask is not wrong, it is just less
1045 * This is a less precise version of flow_wildcards_init_for_packet() above. */
1047 flow_wc_map(const struct flow *flow)
1049 /* Update this function whenever struct flow changes. */
1050 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 32);
1052 uint64_t map = (flow->tunnel.ip_dst) ? MINIFLOW_MAP(tunnel) : 0;
1054 /* Metadata fields that can appear on packet input. */
1055 map |= MINIFLOW_MAP(skb_priority) | MINIFLOW_MAP(pkt_mark)
1056 | MINIFLOW_MAP(recirc_id) | MINIFLOW_MAP(dp_hash)
1057 | MINIFLOW_MAP(in_port)
1058 | MINIFLOW_MAP(dl_dst) | MINIFLOW_MAP(dl_src)
1059 | MINIFLOW_MAP(dl_type) | MINIFLOW_MAP(vlan_tci);
1061 /* Ethertype-dependent fields. */
1062 if (OVS_LIKELY(flow->dl_type == htons(ETH_TYPE_IP))) {
1063 map |= MINIFLOW_MAP(nw_src) | MINIFLOW_MAP(nw_dst)
1064 | MINIFLOW_MAP(nw_proto) | MINIFLOW_MAP(nw_frag)
1065 | MINIFLOW_MAP(nw_tos) | MINIFLOW_MAP(nw_ttl);
1066 if (OVS_UNLIKELY(flow->nw_proto == IPPROTO_IGMP)) {
1067 map |= MINIFLOW_MAP(igmp_group_ip4);
1069 map |= MINIFLOW_MAP(tcp_flags)
1070 | MINIFLOW_MAP(tp_src) | MINIFLOW_MAP(tp_dst);
1072 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1073 map |= MINIFLOW_MAP(ipv6_src) | MINIFLOW_MAP(ipv6_dst)
1074 | MINIFLOW_MAP(ipv6_label)
1075 | MINIFLOW_MAP(nw_proto) | MINIFLOW_MAP(nw_frag)
1076 | MINIFLOW_MAP(nw_tos) | MINIFLOW_MAP(nw_ttl);
1077 if (OVS_UNLIKELY(flow->nw_proto == IPPROTO_ICMPV6)) {
1078 map |= MINIFLOW_MAP(nd_target)
1079 | MINIFLOW_MAP(arp_sha) | MINIFLOW_MAP(arp_tha);
1081 map |= MINIFLOW_MAP(tcp_flags)
1082 | MINIFLOW_MAP(tp_src) | MINIFLOW_MAP(tp_dst);
1084 } else if (eth_type_mpls(flow->dl_type)) {
1085 map |= MINIFLOW_MAP(mpls_lse);
1086 } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
1087 flow->dl_type == htons(ETH_TYPE_RARP)) {
1088 map |= MINIFLOW_MAP(nw_src) | MINIFLOW_MAP(nw_dst)
1089 | MINIFLOW_MAP(nw_proto)
1090 | MINIFLOW_MAP(arp_sha) | MINIFLOW_MAP(arp_tha);
1096 /* Clear the metadata and register wildcard masks. They are not packet
1099 flow_wildcards_clear_non_packet_fields(struct flow_wildcards *wc)
1101 /* Update this function whenever struct flow changes. */
1102 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 32);
1104 memset(&wc->masks.metadata, 0, sizeof wc->masks.metadata);
1105 memset(&wc->masks.regs, 0, sizeof wc->masks.regs);
1106 wc->masks.actset_output = 0;
1107 wc->masks.conj_id = 0;
1110 /* Returns true if 'wc' matches every packet, false if 'wc' fixes any bits or
1113 flow_wildcards_is_catchall(const struct flow_wildcards *wc)
1115 const uint64_t *wc_u64 = (const uint64_t *) &wc->masks;
1118 for (i = 0; i < FLOW_U64S; i++) {
1126 /* Sets 'dst' as the bitwise AND of wildcards in 'src1' and 'src2'.
1127 * That is, a bit or a field is wildcarded in 'dst' if it is wildcarded
1128 * in 'src1' or 'src2' or both. */
1130 flow_wildcards_and(struct flow_wildcards *dst,
1131 const struct flow_wildcards *src1,
1132 const struct flow_wildcards *src2)
1134 uint64_t *dst_u64 = (uint64_t *) &dst->masks;
1135 const uint64_t *src1_u64 = (const uint64_t *) &src1->masks;
1136 const uint64_t *src2_u64 = (const uint64_t *) &src2->masks;
1139 for (i = 0; i < FLOW_U64S; i++) {
1140 dst_u64[i] = src1_u64[i] & src2_u64[i];
1144 /* Sets 'dst' as the bitwise OR of wildcards in 'src1' and 'src2'. That
1145 * is, a bit or a field is wildcarded in 'dst' if it is neither
1146 * wildcarded in 'src1' nor 'src2'. */
1148 flow_wildcards_or(struct flow_wildcards *dst,
1149 const struct flow_wildcards *src1,
1150 const struct flow_wildcards *src2)
1152 uint64_t *dst_u64 = (uint64_t *) &dst->masks;
1153 const uint64_t *src1_u64 = (const uint64_t *) &src1->masks;
1154 const uint64_t *src2_u64 = (const uint64_t *) &src2->masks;
1157 for (i = 0; i < FLOW_U64S; i++) {
1158 dst_u64[i] = src1_u64[i] | src2_u64[i];
1162 /* Returns a hash of the wildcards in 'wc'. */
1164 flow_wildcards_hash(const struct flow_wildcards *wc, uint32_t basis)
1166 return flow_hash(&wc->masks, basis);
1169 /* Returns true if 'a' and 'b' represent the same wildcards, false if they are
1172 flow_wildcards_equal(const struct flow_wildcards *a,
1173 const struct flow_wildcards *b)
1175 return flow_equal(&a->masks, &b->masks);
1178 /* Returns true if at least one bit or field is wildcarded in 'a' but not in
1179 * 'b', false otherwise. */
1181 flow_wildcards_has_extra(const struct flow_wildcards *a,
1182 const struct flow_wildcards *b)
1184 const uint64_t *a_u64 = (const uint64_t *) &a->masks;
1185 const uint64_t *b_u64 = (const uint64_t *) &b->masks;
1188 for (i = 0; i < FLOW_U64S; i++) {
1189 if ((a_u64[i] & b_u64[i]) != b_u64[i]) {
1196 /* Returns true if 'a' and 'b' are equal, except that 0-bits (wildcarded bits)
1197 * in 'wc' do not need to be equal in 'a' and 'b'. */
1199 flow_equal_except(const struct flow *a, const struct flow *b,
1200 const struct flow_wildcards *wc)
1202 const uint64_t *a_u64 = (const uint64_t *) a;
1203 const uint64_t *b_u64 = (const uint64_t *) b;
1204 const uint64_t *wc_u64 = (const uint64_t *) &wc->masks;
1207 for (i = 0; i < FLOW_U64S; i++) {
1208 if ((a_u64[i] ^ b_u64[i]) & wc_u64[i]) {
1215 /* Sets the wildcard mask for register 'idx' in 'wc' to 'mask'.
1216 * (A 0-bit indicates a wildcard bit.) */
1218 flow_wildcards_set_reg_mask(struct flow_wildcards *wc, int idx, uint32_t mask)
1220 wc->masks.regs[idx] = mask;
1223 /* Sets the wildcard mask for register 'idx' in 'wc' to 'mask'.
1224 * (A 0-bit indicates a wildcard bit.) */
1226 flow_wildcards_set_xreg_mask(struct flow_wildcards *wc, int idx, uint64_t mask)
1228 flow_set_xreg(&wc->masks, idx, mask);
1231 /* Calculates the 5-tuple hash from the given miniflow.
1232 * This returns the same value as flow_hash_5tuple for the corresponding
1235 miniflow_hash_5tuple(const struct miniflow *flow, uint32_t basis)
1237 uint32_t hash = basis;
1240 ovs_be16 dl_type = MINIFLOW_GET_BE16(flow, dl_type);
1242 hash = hash_add(hash, MINIFLOW_GET_U8(flow, nw_proto));
1244 /* Separate loops for better optimization. */
1245 if (dl_type == htons(ETH_TYPE_IPV6)) {
1246 uint64_t map = MINIFLOW_MAP(ipv6_src) | MINIFLOW_MAP(ipv6_dst);
1249 MINIFLOW_FOR_EACH_IN_MAP(value, flow, map) {
1250 hash = hash_add64(hash, value);
1253 hash = hash_add(hash, MINIFLOW_GET_U32(flow, nw_src));
1254 hash = hash_add(hash, MINIFLOW_GET_U32(flow, nw_dst));
1256 /* Add both ports at once. */
1257 hash = hash_add(hash, MINIFLOW_GET_U32(flow, tp_src));
1258 hash = hash_finish(hash, 42); /* Arbitrary number. */
1263 ASSERT_SEQUENTIAL_SAME_WORD(tp_src, tp_dst);
1264 ASSERT_SEQUENTIAL(ipv6_src, ipv6_dst);
1266 /* Calculates the 5-tuple hash from the given flow. */
1268 flow_hash_5tuple(const struct flow *flow, uint32_t basis)
1270 uint32_t hash = basis;
1273 hash = hash_add(hash, flow->nw_proto);
1275 if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1276 const uint64_t *flow_u64 = (const uint64_t *)flow;
1277 int ofs = offsetof(struct flow, ipv6_src) / 8;
1278 int end = ofs + 2 * sizeof flow->ipv6_src / 8;
1280 for (;ofs < end; ofs++) {
1281 hash = hash_add64(hash, flow_u64[ofs]);
1284 hash = hash_add(hash, (OVS_FORCE uint32_t) flow->nw_src);
1285 hash = hash_add(hash, (OVS_FORCE uint32_t) flow->nw_dst);
1287 /* Add both ports at once. */
1288 hash = hash_add(hash,
1289 ((const uint32_t *)flow)[offsetof(struct flow, tp_src)
1290 / sizeof(uint32_t)]);
1291 hash = hash_finish(hash, 42); /* Arbitrary number. */
1296 /* Hashes 'flow' based on its L2 through L4 protocol information. */
1298 flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis)
1303 struct in6_addr ipv6_addr;
1308 uint8_t eth_addr[ETH_ADDR_LEN];
1314 memset(&fields, 0, sizeof fields);
1315 for (i = 0; i < ETH_ADDR_LEN; i++) {
1316 fields.eth_addr[i] = flow->dl_src[i] ^ flow->dl_dst[i];
1318 fields.vlan_tci = flow->vlan_tci & htons(VLAN_VID_MASK);
1319 fields.eth_type = flow->dl_type;
1321 /* UDP source and destination port are not taken into account because they
1322 * will not necessarily be symmetric in a bidirectional flow. */
1323 if (fields.eth_type == htons(ETH_TYPE_IP)) {
1324 fields.ipv4_addr = flow->nw_src ^ flow->nw_dst;
1325 fields.ip_proto = flow->nw_proto;
1326 if (fields.ip_proto == IPPROTO_TCP || fields.ip_proto == IPPROTO_SCTP) {
1327 fields.tp_port = flow->tp_src ^ flow->tp_dst;
1329 } else if (fields.eth_type == htons(ETH_TYPE_IPV6)) {
1330 const uint8_t *a = &flow->ipv6_src.s6_addr[0];
1331 const uint8_t *b = &flow->ipv6_dst.s6_addr[0];
1332 uint8_t *ipv6_addr = &fields.ipv6_addr.s6_addr[0];
1334 for (i=0; i<16; i++) {
1335 ipv6_addr[i] = a[i] ^ b[i];
1337 fields.ip_proto = flow->nw_proto;
1338 if (fields.ip_proto == IPPROTO_TCP || fields.ip_proto == IPPROTO_SCTP) {
1339 fields.tp_port = flow->tp_src ^ flow->tp_dst;
1342 return jhash_bytes(&fields, sizeof fields, basis);
1345 /* Initialize a flow with random fields that matter for nx_hash_fields. */
1347 flow_random_hash_fields(struct flow *flow)
1349 uint16_t rnd = random_uint16();
1351 /* Initialize to all zeros. */
1352 memset(flow, 0, sizeof *flow);
1354 eth_addr_random(flow->dl_src);
1355 eth_addr_random(flow->dl_dst);
1357 flow->vlan_tci = (OVS_FORCE ovs_be16) (random_uint16() & VLAN_VID_MASK);
1359 /* Make most of the random flows IPv4, some IPv6, and rest random. */
1360 flow->dl_type = rnd < 0x8000 ? htons(ETH_TYPE_IP) :
1361 rnd < 0xc000 ? htons(ETH_TYPE_IPV6) : (OVS_FORCE ovs_be16)rnd;
1363 if (dl_type_is_ip_any(flow->dl_type)) {
1364 if (flow->dl_type == htons(ETH_TYPE_IP)) {
1365 flow->nw_src = (OVS_FORCE ovs_be32)random_uint32();
1366 flow->nw_dst = (OVS_FORCE ovs_be32)random_uint32();
1368 random_bytes(&flow->ipv6_src, sizeof flow->ipv6_src);
1369 random_bytes(&flow->ipv6_dst, sizeof flow->ipv6_dst);
1371 /* Make most of IP flows TCP, some UDP or SCTP, and rest random. */
1372 rnd = random_uint16();
1373 flow->nw_proto = rnd < 0x8000 ? IPPROTO_TCP :
1374 rnd < 0xc000 ? IPPROTO_UDP :
1375 rnd < 0xd000 ? IPPROTO_SCTP : (uint8_t)rnd;
1376 if (flow->nw_proto == IPPROTO_TCP ||
1377 flow->nw_proto == IPPROTO_UDP ||
1378 flow->nw_proto == IPPROTO_SCTP) {
1379 flow->tp_src = (OVS_FORCE ovs_be16)random_uint16();
1380 flow->tp_dst = (OVS_FORCE ovs_be16)random_uint16();
1385 /* Masks the fields in 'wc' that are used by the flow hash 'fields'. */
1387 flow_mask_hash_fields(const struct flow *flow, struct flow_wildcards *wc,
1388 enum nx_hash_fields fields)
1391 case NX_HASH_FIELDS_ETH_SRC:
1392 memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
1395 case NX_HASH_FIELDS_SYMMETRIC_L4:
1396 memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
1397 memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
1398 if (flow->dl_type == htons(ETH_TYPE_IP)) {
1399 memset(&wc->masks.nw_src, 0xff, sizeof wc->masks.nw_src);
1400 memset(&wc->masks.nw_dst, 0xff, sizeof wc->masks.nw_dst);
1401 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1402 memset(&wc->masks.ipv6_src, 0xff, sizeof wc->masks.ipv6_src);
1403 memset(&wc->masks.ipv6_dst, 0xff, sizeof wc->masks.ipv6_dst);
1405 if (is_ip_any(flow)) {
1406 memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
1407 flow_unwildcard_tp_ports(flow, wc);
1409 wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
1417 /* Hashes the portions of 'flow' designated by 'fields'. */
1419 flow_hash_fields(const struct flow *flow, enum nx_hash_fields fields,
1424 case NX_HASH_FIELDS_ETH_SRC:
1425 return jhash_bytes(flow->dl_src, sizeof flow->dl_src, basis);
1427 case NX_HASH_FIELDS_SYMMETRIC_L4:
1428 return flow_hash_symmetric_l4(flow, basis);
1434 /* Returns a string representation of 'fields'. */
1436 flow_hash_fields_to_str(enum nx_hash_fields fields)
1439 case NX_HASH_FIELDS_ETH_SRC: return "eth_src";
1440 case NX_HASH_FIELDS_SYMMETRIC_L4: return "symmetric_l4";
1441 default: return "<unknown>";
1445 /* Returns true if the value of 'fields' is supported. Otherwise false. */
1447 flow_hash_fields_valid(enum nx_hash_fields fields)
1449 return fields == NX_HASH_FIELDS_ETH_SRC
1450 || fields == NX_HASH_FIELDS_SYMMETRIC_L4;
1453 /* Returns a hash value for the bits of 'flow' that are active based on
1454 * 'wc', given 'basis'. */
1456 flow_hash_in_wildcards(const struct flow *flow,
1457 const struct flow_wildcards *wc, uint32_t basis)
1459 const uint64_t *wc_u64 = (const uint64_t *) &wc->masks;
1460 const uint64_t *flow_u64 = (const uint64_t *) flow;
1465 for (i = 0; i < FLOW_U64S; i++) {
1466 hash = hash_add64(hash, flow_u64[i] & wc_u64[i]);
1468 return hash_finish(hash, 8 * FLOW_U64S);
1471 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
1472 * OpenFlow 1.0 "dl_vlan" value:
1474 * - If it is in the range 0...4095, 'flow->vlan_tci' is set to match
1475 * that VLAN. Any existing PCP match is unchanged (it becomes 0 if
1476 * 'flow' previously matched packets without a VLAN header).
1478 * - If it is OFP_VLAN_NONE, 'flow->vlan_tci' is set to match a packet
1479 * without a VLAN tag.
1481 * - Other values of 'vid' should not be used. */
1483 flow_set_dl_vlan(struct flow *flow, ovs_be16 vid)
1485 if (vid == htons(OFP10_VLAN_NONE)) {
1486 flow->vlan_tci = htons(0);
1488 vid &= htons(VLAN_VID_MASK);
1489 flow->vlan_tci &= ~htons(VLAN_VID_MASK);
1490 flow->vlan_tci |= htons(VLAN_CFI) | vid;
1494 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
1495 * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
1498 flow_set_vlan_vid(struct flow *flow, ovs_be16 vid)
1500 ovs_be16 mask = htons(VLAN_VID_MASK | VLAN_CFI);
1501 flow->vlan_tci &= ~mask;
1502 flow->vlan_tci |= vid & mask;
1505 /* Sets the VLAN PCP that 'flow' matches to 'pcp', which should be in the
1508 * This function has no effect on the VLAN ID that 'flow' matches.
1510 * After calling this function, 'flow' will not match packets without a VLAN
1513 flow_set_vlan_pcp(struct flow *flow, uint8_t pcp)
1516 flow->vlan_tci &= ~htons(VLAN_PCP_MASK);
1517 flow->vlan_tci |= htons((pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
1520 /* Returns the number of MPLS LSEs present in 'flow'
1522 * Returns 0 if the 'dl_type' of 'flow' is not an MPLS ethernet type.
1523 * Otherwise traverses 'flow''s MPLS label stack stopping at the
1524 * first entry that has the BoS bit set. If no such entry exists then
1525 * the maximum number of LSEs that can be stored in 'flow' is returned.
1528 flow_count_mpls_labels(const struct flow *flow, struct flow_wildcards *wc)
1530 /* dl_type is always masked. */
1531 if (eth_type_mpls(flow->dl_type)) {
1536 for (i = 0; i < FLOW_MAX_MPLS_LABELS; i++) {
1538 wc->masks.mpls_lse[i] |= htonl(MPLS_BOS_MASK);
1540 if (flow->mpls_lse[i] & htonl(MPLS_BOS_MASK)) {
1543 if (flow->mpls_lse[i]) {
1553 /* Returns the number consecutive of MPLS LSEs, starting at the
1554 * innermost LSE, that are common in 'a' and 'b'.
1556 * 'an' must be flow_count_mpls_labels(a).
1557 * 'bn' must be flow_count_mpls_labels(b).
1560 flow_count_common_mpls_labels(const struct flow *a, int an,
1561 const struct flow *b, int bn,
1562 struct flow_wildcards *wc)
1564 int min_n = MIN(an, bn);
1569 int a_last = an - 1;
1570 int b_last = bn - 1;
1573 for (i = 0; i < min_n; i++) {
1575 wc->masks.mpls_lse[a_last - i] = OVS_BE32_MAX;
1576 wc->masks.mpls_lse[b_last - i] = OVS_BE32_MAX;
1578 if (a->mpls_lse[a_last - i] != b->mpls_lse[b_last - i]) {
1589 /* Adds a new outermost MPLS label to 'flow' and changes 'flow''s Ethernet type
1590 * to 'mpls_eth_type', which must be an MPLS Ethertype.
1592 * If the new label is the first MPLS label in 'flow', it is generated as;
1594 * - label: 2, if 'flow' is IPv6, otherwise 0.
1596 * - TTL: IPv4 or IPv6 TTL, if present and nonzero, otherwise 64.
1598 * - TC: IPv4 or IPv6 TOS, if present, otherwise 0.
1602 * If the new label is the second or later label MPLS label in 'flow', it is
1605 * - label: Copied from outer label.
1607 * - TTL: Copied from outer label.
1609 * - TC: Copied from outer label.
1613 * 'n' must be flow_count_mpls_labels(flow). 'n' must be less than
1614 * FLOW_MAX_MPLS_LABELS (because otherwise flow->mpls_lse[] would overflow).
1617 flow_push_mpls(struct flow *flow, int n, ovs_be16 mpls_eth_type,
1618 struct flow_wildcards *wc)
1620 ovs_assert(eth_type_mpls(mpls_eth_type));
1621 ovs_assert(n < FLOW_MAX_MPLS_LABELS);
1627 memset(&wc->masks.mpls_lse, 0xff, sizeof *wc->masks.mpls_lse * n);
1629 for (i = n; i >= 1; i--) {
1630 flow->mpls_lse[i] = flow->mpls_lse[i - 1];
1632 flow->mpls_lse[0] = (flow->mpls_lse[1] & htonl(~MPLS_BOS_MASK));
1634 int label = 0; /* IPv4 Explicit Null. */
1638 if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1642 if (is_ip_any(flow)) {
1643 tc = (flow->nw_tos & IP_DSCP_MASK) >> 2;
1645 wc->masks.nw_tos |= IP_DSCP_MASK;
1646 wc->masks.nw_ttl = 0xff;
1654 flow->mpls_lse[0] = set_mpls_lse_values(ttl, tc, 1, htonl(label));
1656 /* Clear all L3 and L4 fields and dp_hash. */
1657 BUILD_ASSERT(FLOW_WC_SEQ == 32);
1658 memset((char *) flow + FLOW_SEGMENT_2_ENDS_AT, 0,
1659 sizeof(struct flow) - FLOW_SEGMENT_2_ENDS_AT);
1662 flow->dl_type = mpls_eth_type;
1665 /* Tries to remove the outermost MPLS label from 'flow'. Returns true if
1666 * successful, false otherwise. On success, sets 'flow''s Ethernet type to
1669 * 'n' must be flow_count_mpls_labels(flow). */
1671 flow_pop_mpls(struct flow *flow, int n, ovs_be16 eth_type,
1672 struct flow_wildcards *wc)
1677 /* Nothing to pop. */
1679 } else if (n == FLOW_MAX_MPLS_LABELS) {
1681 wc->masks.mpls_lse[n - 1] |= htonl(MPLS_BOS_MASK);
1683 if (!(flow->mpls_lse[n - 1] & htonl(MPLS_BOS_MASK))) {
1684 /* Can't pop because don't know what to fill in mpls_lse[n - 1]. */
1690 memset(&wc->masks.mpls_lse[1], 0xff,
1691 sizeof *wc->masks.mpls_lse * (n - 1));
1693 for (i = 1; i < n; i++) {
1694 flow->mpls_lse[i - 1] = flow->mpls_lse[i];
1696 flow->mpls_lse[n - 1] = 0;
1697 flow->dl_type = eth_type;
1701 /* Sets the MPLS Label that 'flow' matches to 'label', which is interpreted
1702 * as an OpenFlow 1.1 "mpls_label" value. */
1704 flow_set_mpls_label(struct flow *flow, int idx, ovs_be32 label)
1706 set_mpls_lse_label(&flow->mpls_lse[idx], label);
1709 /* Sets the MPLS TTL that 'flow' matches to 'ttl', which should be in the
1712 flow_set_mpls_ttl(struct flow *flow, int idx, uint8_t ttl)
1714 set_mpls_lse_ttl(&flow->mpls_lse[idx], ttl);
1717 /* Sets the MPLS TC that 'flow' matches to 'tc', which should be in the
1720 flow_set_mpls_tc(struct flow *flow, int idx, uint8_t tc)
1722 set_mpls_lse_tc(&flow->mpls_lse[idx], tc);
1725 /* Sets the MPLS BOS bit that 'flow' matches to which should be 0 or 1. */
1727 flow_set_mpls_bos(struct flow *flow, int idx, uint8_t bos)
1729 set_mpls_lse_bos(&flow->mpls_lse[idx], bos);
1732 /* Sets the entire MPLS LSE. */
1734 flow_set_mpls_lse(struct flow *flow, int idx, ovs_be32 lse)
1736 flow->mpls_lse[idx] = lse;
1740 flow_compose_l4(struct dp_packet *p, const struct flow *flow)
1744 if (!(flow->nw_frag & FLOW_NW_FRAG_ANY)
1745 || !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1746 if (flow->nw_proto == IPPROTO_TCP) {
1747 struct tcp_header *tcp;
1749 l4_len = sizeof *tcp;
1750 tcp = dp_packet_put_zeros(p, l4_len);
1751 tcp->tcp_src = flow->tp_src;
1752 tcp->tcp_dst = flow->tp_dst;
1753 tcp->tcp_ctl = TCP_CTL(ntohs(flow->tcp_flags), 5);
1754 } else if (flow->nw_proto == IPPROTO_UDP) {
1755 struct udp_header *udp;
1757 l4_len = sizeof *udp;
1758 udp = dp_packet_put_zeros(p, l4_len);
1759 udp->udp_src = flow->tp_src;
1760 udp->udp_dst = flow->tp_dst;
1761 } else if (flow->nw_proto == IPPROTO_SCTP) {
1762 struct sctp_header *sctp;
1764 l4_len = sizeof *sctp;
1765 sctp = dp_packet_put_zeros(p, l4_len);
1766 sctp->sctp_src = flow->tp_src;
1767 sctp->sctp_dst = flow->tp_dst;
1768 } else if (flow->nw_proto == IPPROTO_ICMP) {
1769 struct icmp_header *icmp;
1771 l4_len = sizeof *icmp;
1772 icmp = dp_packet_put_zeros(p, l4_len);
1773 icmp->icmp_type = ntohs(flow->tp_src);
1774 icmp->icmp_code = ntohs(flow->tp_dst);
1775 icmp->icmp_csum = csum(icmp, ICMP_HEADER_LEN);
1776 } else if (flow->nw_proto == IPPROTO_IGMP) {
1777 struct igmp_header *igmp;
1779 l4_len = sizeof *igmp;
1780 igmp = dp_packet_put_zeros(p, l4_len);
1781 igmp->igmp_type = ntohs(flow->tp_src);
1782 igmp->igmp_code = ntohs(flow->tp_dst);
1783 put_16aligned_be32(&igmp->group, flow->igmp_group_ip4);
1784 igmp->igmp_csum = csum(igmp, IGMP_HEADER_LEN);
1785 } else if (flow->nw_proto == IPPROTO_ICMPV6) {
1786 struct icmp6_hdr *icmp;
1788 l4_len = sizeof *icmp;
1789 icmp = dp_packet_put_zeros(p, l4_len);
1790 icmp->icmp6_type = ntohs(flow->tp_src);
1791 icmp->icmp6_code = ntohs(flow->tp_dst);
1793 if (icmp->icmp6_code == 0 &&
1794 (icmp->icmp6_type == ND_NEIGHBOR_SOLICIT ||
1795 icmp->icmp6_type == ND_NEIGHBOR_ADVERT)) {
1796 struct in6_addr *nd_target;
1797 struct nd_opt_hdr *nd_opt;
1799 l4_len += sizeof *nd_target;
1800 nd_target = dp_packet_put_zeros(p, sizeof *nd_target);
1801 *nd_target = flow->nd_target;
1803 if (!eth_addr_is_zero(flow->arp_sha)) {
1805 nd_opt = dp_packet_put_zeros(p, 8);
1806 nd_opt->nd_opt_len = 1;
1807 nd_opt->nd_opt_type = ND_OPT_SOURCE_LINKADDR;
1808 memcpy(nd_opt + 1, flow->arp_sha, ETH_ADDR_LEN);
1810 if (!eth_addr_is_zero(flow->arp_tha)) {
1812 nd_opt = dp_packet_put_zeros(p, 8);
1813 nd_opt->nd_opt_len = 1;
1814 nd_opt->nd_opt_type = ND_OPT_TARGET_LINKADDR;
1815 memcpy(nd_opt + 1, flow->arp_tha, ETH_ADDR_LEN);
1818 icmp->icmp6_cksum = (OVS_FORCE uint16_t)
1819 csum(icmp, (char *)dp_packet_tail(p) - (char *)icmp);
1825 /* Puts into 'b' a packet that flow_extract() would parse as having the given
1828 * (This is useful only for testing, obviously, and the packet isn't really
1829 * valid. It hasn't got some checksums filled in, for one, and lots of fields
1830 * are just zeroed.) */
1832 flow_compose(struct dp_packet *p, const struct flow *flow)
1836 /* eth_compose() sets l3 pointer and makes sure it is 32-bit aligned. */
1837 eth_compose(p, flow->dl_dst, flow->dl_src, ntohs(flow->dl_type), 0);
1838 if (flow->dl_type == htons(FLOW_DL_TYPE_NONE)) {
1839 struct eth_header *eth = dp_packet_l2(p);
1840 eth->eth_type = htons(dp_packet_size(p));
1844 if (flow->vlan_tci & htons(VLAN_CFI)) {
1845 eth_push_vlan(p, htons(ETH_TYPE_VLAN), flow->vlan_tci);
1848 if (flow->dl_type == htons(ETH_TYPE_IP)) {
1849 struct ip_header *ip;
1851 ip = dp_packet_put_zeros(p, sizeof *ip);
1852 ip->ip_ihl_ver = IP_IHL_VER(5, 4);
1853 ip->ip_tos = flow->nw_tos;
1854 ip->ip_ttl = flow->nw_ttl;
1855 ip->ip_proto = flow->nw_proto;
1856 put_16aligned_be32(&ip->ip_src, flow->nw_src);
1857 put_16aligned_be32(&ip->ip_dst, flow->nw_dst);
1859 if (flow->nw_frag & FLOW_NW_FRAG_ANY) {
1860 ip->ip_frag_off |= htons(IP_MORE_FRAGMENTS);
1861 if (flow->nw_frag & FLOW_NW_FRAG_LATER) {
1862 ip->ip_frag_off |= htons(100);
1866 dp_packet_set_l4(p, dp_packet_tail(p));
1868 l4_len = flow_compose_l4(p, flow);
1870 ip = dp_packet_l3(p);
1871 ip->ip_tot_len = htons(p->l4_ofs - p->l3_ofs + l4_len);
1872 ip->ip_csum = csum(ip, sizeof *ip);
1873 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1874 struct ovs_16aligned_ip6_hdr *nh;
1876 nh = dp_packet_put_zeros(p, sizeof *nh);
1877 put_16aligned_be32(&nh->ip6_flow, htonl(6 << 28) |
1878 htonl(flow->nw_tos << 20) | flow->ipv6_label);
1879 nh->ip6_hlim = flow->nw_ttl;
1880 nh->ip6_nxt = flow->nw_proto;
1882 memcpy(&nh->ip6_src, &flow->ipv6_src, sizeof(nh->ip6_src));
1883 memcpy(&nh->ip6_dst, &flow->ipv6_dst, sizeof(nh->ip6_dst));
1885 dp_packet_set_l4(p, dp_packet_tail(p));
1887 l4_len = flow_compose_l4(p, flow);
1889 nh = dp_packet_l3(p);
1890 nh->ip6_plen = htons(l4_len);
1891 } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
1892 flow->dl_type == htons(ETH_TYPE_RARP)) {
1893 struct arp_eth_header *arp;
1895 arp = dp_packet_put_zeros(p, sizeof *arp);
1896 dp_packet_set_l3(p, arp);
1897 arp->ar_hrd = htons(1);
1898 arp->ar_pro = htons(ETH_TYPE_IP);
1899 arp->ar_hln = ETH_ADDR_LEN;
1901 arp->ar_op = htons(flow->nw_proto);
1903 if (flow->nw_proto == ARP_OP_REQUEST ||
1904 flow->nw_proto == ARP_OP_REPLY) {
1905 put_16aligned_be32(&arp->ar_spa, flow->nw_src);
1906 put_16aligned_be32(&arp->ar_tpa, flow->nw_dst);
1907 memcpy(arp->ar_sha, flow->arp_sha, ETH_ADDR_LEN);
1908 memcpy(arp->ar_tha, flow->arp_tha, ETH_ADDR_LEN);
1912 if (eth_type_mpls(flow->dl_type)) {
1915 p->l2_5_ofs = p->l3_ofs;
1916 for (n = 1; n < FLOW_MAX_MPLS_LABELS; n++) {
1917 if (flow->mpls_lse[n - 1] & htonl(MPLS_BOS_MASK)) {
1922 push_mpls(p, flow->dl_type, flow->mpls_lse[--n]);
1927 /* Compressed flow. */
1930 miniflow_n_values(const struct miniflow *flow)
1932 return count_1bits(flow->map);
1936 miniflow_alloc_values(struct miniflow *flow, int n)
1938 int size = MINIFLOW_VALUES_SIZE(n);
1940 if (size <= sizeof flow->inline_values) {
1941 flow->values_inline = true;
1942 return flow->inline_values;
1944 COVERAGE_INC(miniflow_malloc);
1945 flow->values_inline = false;
1946 flow->offline_values = xmalloc(size);
1947 return flow->offline_values;
1951 /* Completes an initialization of 'dst' as a miniflow copy of 'src' begun by
1952 * the caller. The caller must have already initialized 'dst->map' properly
1953 * to indicate the significant uint64_t elements of 'src'. 'n' must be the
1954 * number of 1-bits in 'dst->map'.
1956 * Normally the significant elements are the ones that are non-zero. However,
1957 * when a miniflow is initialized from a (mini)mask, the values can be zeroes,
1958 * so that the flow and mask always have the same maps.
1960 * This function initializes values (either inline if possible or with
1961 * malloc() otherwise) and copies the uint64_t elements of 'src' indicated by
1962 * 'dst->map' into it. */
1964 miniflow_init__(struct miniflow *dst, const struct flow *src, int n)
1966 const uint64_t *src_u64 = (const uint64_t *) src;
1967 uint64_t *dst_u64 = miniflow_alloc_values(dst, n);
1970 MAP_FOR_EACH_INDEX(idx, dst->map) {
1971 *dst_u64++ = src_u64[idx];
1975 /* Initializes 'dst' as a copy of 'src'. The caller must eventually free 'dst'
1976 * with miniflow_destroy().
1977 * Always allocates offline storage. */
1979 miniflow_init(struct miniflow *dst, const struct flow *src)
1981 const uint64_t *src_u64 = (const uint64_t *) src;
1985 /* Initialize dst->map, counting the number of nonzero elements. */
1989 for (i = 0; i < FLOW_U64S; i++) {
1991 dst->map |= UINT64_C(1) << i;
1996 miniflow_init__(dst, src, n);
1999 /* Initializes 'dst' as a copy of 'src', using 'mask->map' as 'dst''s map. The
2000 * caller must eventually free 'dst' with miniflow_destroy(). */
2002 miniflow_init_with_minimask(struct miniflow *dst, const struct flow *src,
2003 const struct minimask *mask)
2005 dst->map = mask->masks.map;
2006 miniflow_init__(dst, src, miniflow_n_values(dst));
2009 /* Initializes 'dst' as a copy of 'src'. The caller must eventually free 'dst'
2010 * with miniflow_destroy(). */
2012 miniflow_clone(struct miniflow *dst, const struct miniflow *src)
2014 int size = MINIFLOW_VALUES_SIZE(miniflow_n_values(src));
2017 dst->map = src->map;
2018 if (size <= sizeof dst->inline_values) {
2019 dst->values_inline = true;
2020 values = dst->inline_values;
2022 dst->values_inline = false;
2023 COVERAGE_INC(miniflow_malloc);
2024 dst->offline_values = xmalloc(size);
2025 values = dst->offline_values;
2027 memcpy(values, miniflow_get_values(src), size);
2030 /* Initializes 'dst' as a copy of 'src'. The caller must have allocated
2031 * 'dst' to have inline space all data in 'src'. */
2033 miniflow_clone_inline(struct miniflow *dst, const struct miniflow *src,
2036 dst->values_inline = true;
2037 dst->map = src->map;
2038 memcpy(dst->inline_values, miniflow_get_values(src),
2039 MINIFLOW_VALUES_SIZE(n_values));
2042 /* Initializes 'dst' with the data in 'src', destroying 'src'.
2043 * The caller must eventually free 'dst' with miniflow_destroy().
2044 * 'dst' must be regularly sized miniflow, but 'src' can have
2045 * storage for more than the default MINI_N_INLINE inline
2048 miniflow_move(struct miniflow *dst, struct miniflow *src)
2050 int size = MINIFLOW_VALUES_SIZE(miniflow_n_values(src));
2052 dst->map = src->map;
2053 if (size <= sizeof dst->inline_values) {
2054 dst->values_inline = true;
2055 memcpy(dst->inline_values, miniflow_get_values(src), size);
2056 miniflow_destroy(src);
2057 } else if (src->values_inline) {
2058 dst->values_inline = false;
2059 COVERAGE_INC(miniflow_malloc);
2060 dst->offline_values = xmalloc(size);
2061 memcpy(dst->offline_values, src->inline_values, size);
2063 dst->values_inline = false;
2064 dst->offline_values = src->offline_values;
2068 /* Frees any memory owned by 'flow'. Does not free the storage in which 'flow'
2069 * itself resides; the caller is responsible for that. */
2071 miniflow_destroy(struct miniflow *flow)
2073 if (!flow->values_inline) {
2074 free(flow->offline_values);
2078 /* Initializes 'dst' as a copy of 'src'. */
2080 miniflow_expand(const struct miniflow *src, struct flow *dst)
2082 memset(dst, 0, sizeof *dst);
2083 flow_union_with_miniflow(dst, src);
2086 /* Returns true if 'a' and 'b' are the equal miniflow, false otherwise. */
2088 miniflow_equal(const struct miniflow *a, const struct miniflow *b)
2090 const uint64_t *ap = miniflow_get_values(a);
2091 const uint64_t *bp = miniflow_get_values(b);
2093 if (OVS_LIKELY(a->map == b->map)) {
2094 int count = miniflow_n_values(a);
2096 return !memcmp(ap, bp, count * sizeof *ap);
2100 for (map = a->map | b->map; map; map = zero_rightmost_1bit(map)) {
2101 uint64_t bit = rightmost_1bit(map);
2103 if ((a->map & bit ? *ap++ : 0) != (b->map & bit ? *bp++ : 0)) {
2112 /* Returns false if 'a' and 'b' differ at the places where there are 1-bits
2113 * in 'mask', true otherwise. */
2115 miniflow_equal_in_minimask(const struct miniflow *a, const struct miniflow *b,
2116 const struct minimask *mask)
2118 const uint64_t *p = miniflow_get_values(&mask->masks);
2121 MAP_FOR_EACH_INDEX(idx, mask->masks.map) {
2122 if ((miniflow_get(a, idx) ^ miniflow_get(b, idx)) & *p++) {
2130 /* Returns true if 'a' and 'b' are equal at the places where there are 1-bits
2131 * in 'mask', false if they differ. */
2133 miniflow_equal_flow_in_minimask(const struct miniflow *a, const struct flow *b,
2134 const struct minimask *mask)
2136 const uint64_t *b_u64 = (const uint64_t *) b;
2137 const uint64_t *p = miniflow_get_values(&mask->masks);
2140 MAP_FOR_EACH_INDEX(idx, mask->masks.map) {
2141 if ((miniflow_get(a, idx) ^ b_u64[idx]) & *p++) {
2150 /* Initializes 'dst' as a copy of 'src'. The caller must eventually free 'dst'
2151 * with minimask_destroy(). */
2153 minimask_init(struct minimask *mask, const struct flow_wildcards *wc)
2155 miniflow_init(&mask->masks, &wc->masks);
2158 /* Initializes 'dst' as a copy of 'src'. The caller must eventually free 'dst'
2159 * with minimask_destroy(). */
2161 minimask_clone(struct minimask *dst, const struct minimask *src)
2163 miniflow_clone(&dst->masks, &src->masks);
2166 /* Initializes 'dst' with the data in 'src', destroying 'src'.
2167 * The caller must eventually free 'dst' with minimask_destroy(). */
2169 minimask_move(struct minimask *dst, struct minimask *src)
2171 miniflow_move(&dst->masks, &src->masks);
2174 /* Initializes 'dst_' as the bit-wise "and" of 'a_' and 'b_'.
2176 * The caller must provide room for FLOW_U64S "uint64_t"s in 'storage', for use
2177 * by 'dst_'. The caller must *not* free 'dst_' with minimask_destroy(). */
2179 minimask_combine(struct minimask *dst_,
2180 const struct minimask *a_, const struct minimask *b_,
2181 uint64_t storage[FLOW_U64S])
2183 struct miniflow *dst = &dst_->masks;
2184 uint64_t *dst_values = storage;
2185 const struct miniflow *a = &a_->masks;
2186 const struct miniflow *b = &b_->masks;
2189 dst->values_inline = false;
2190 dst->offline_values = storage;
2193 MAP_FOR_EACH_INDEX(idx, a->map & b->map) {
2194 /* Both 'a' and 'b' have non-zero data at 'idx'. */
2195 uint64_t mask = miniflow_get__(a, idx) & miniflow_get__(b, idx);
2198 dst->map |= UINT64_C(1) << idx;
2199 *dst_values++ = mask;
2204 /* Frees any memory owned by 'mask'. Does not free the storage in which 'mask'
2205 * itself resides; the caller is responsible for that. */
2207 minimask_destroy(struct minimask *mask)
2209 miniflow_destroy(&mask->masks);
2212 /* Initializes 'dst' as a copy of 'src'. */
2214 minimask_expand(const struct minimask *mask, struct flow_wildcards *wc)
2216 miniflow_expand(&mask->masks, &wc->masks);
2219 /* Returns true if 'a' and 'b' are the same flow mask, false otherwise.
2220 * Minimasks may not have zero data values, so for the minimasks to be the
2221 * same, they need to have the same map and the same data values. */
2223 minimask_equal(const struct minimask *a, const struct minimask *b)
2225 return a->masks.map == b->masks.map &&
2226 !memcmp(miniflow_get_values(&a->masks),
2227 miniflow_get_values(&b->masks),
2228 count_1bits(a->masks.map) * sizeof *a->masks.inline_values);
2231 /* Returns true if at least one bit matched by 'b' is wildcarded by 'a',
2232 * false otherwise. */
2234 minimask_has_extra(const struct minimask *a, const struct minimask *b)
2236 const uint64_t *ap = miniflow_get_values(&a->masks);
2237 const uint64_t *bp = miniflow_get_values(&b->masks);
2240 MAP_FOR_EACH_INDEX(idx, b->masks.map) {
2241 uint64_t b_u64 = *bp++;
2243 /* 'b_u64' is non-zero, check if the data in 'a' is either zero
2244 * or misses some of the bits in 'b_u64'. */
2245 if (!(a->masks.map & (UINT64_C(1) << idx))
2246 || ((miniflow_values_get__(ap, a->masks.map, idx) & b_u64)
2248 return true; /* 'a' wildcards some bits 'b' doesn't. */