2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 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.
19 #include <sys/types.h>
20 #include <netinet/in.h>
24 #include "byte-order.h"
25 #include "openflow/nicira-ext.h"
26 #include "openflow/openflow.h"
31 struct dpif_flow_stats;
33 struct flow_wildcards;
38 /* This sequence number should be incremented whenever anything involving flows
39 * or the wildcarding of flows changes. This will cause build assertion
40 * failures in places which likely need to be updated. */
41 #define FLOW_WC_SEQ 27
44 BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS);
46 /* Used for struct flow's dl_type member for frames that have no Ethernet
47 * type, that is, pure 802.2 frames. */
48 #define FLOW_DL_TYPE_NONE 0x5ff
50 /* Fragment bits, used for IPv4 and IPv6, always zero for non-IP flows. */
51 #define FLOW_NW_FRAG_ANY (1 << 0) /* Set for any IP frag. */
52 #define FLOW_NW_FRAG_LATER (1 << 1) /* Set for IP frag with nonzero offset. */
53 #define FLOW_NW_FRAG_MASK (FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER)
55 BUILD_ASSERT_DECL(FLOW_NW_FRAG_ANY == NX_IP_FRAG_ANY);
56 BUILD_ASSERT_DECL(FLOW_NW_FRAG_LATER == NX_IP_FRAG_LATER);
58 #define FLOW_TNL_F_DONT_FRAGMENT (1 << 0)
59 #define FLOW_TNL_F_CSUM (1 << 1)
60 #define FLOW_TNL_F_KEY (1 << 2)
61 #define FLOW_TNL_F_OAM (1 << 3)
63 const char *flow_tun_flag_to_string(uint32_t flags);
65 /* Maximum number of supported MPLS labels. */
66 #define FLOW_MAX_MPLS_LABELS 3
69 * A flow in the network.
71 * Must be initialized to all zeros to make any compiler-induced padding
72 * zeroed. Helps also in keeping unused fields (such as mutually exclusive
73 * IPv4 and IPv6 addresses) zeroed out.
75 * The meaning of 'in_port' is context-dependent. In most cases, it is a
76 * 16-bit OpenFlow 1.0 port number. In the software datapath interface (dpif)
77 * layer and its implementations (e.g. dpif-linux, dpif-netdev), it is instead
78 * a 32-bit datapath port number.
80 * The fields are organized in four segments to facilitate staged lookup, where
81 * lower layer fields are first used to determine if the later fields need to
82 * be looked at. This enables better wildcarding for datapath flows.
84 * NOTE: Order of the fields is significant, any change in the order must be
85 * reflected in miniflow_extract()!
89 struct flow_tnl tunnel; /* Encapsulating tunnel parameters. */
90 ovs_be64 metadata; /* OpenFlow Metadata. */
91 uint32_t regs[FLOW_N_REGS]; /* Registers. */
92 uint32_t skb_priority; /* Packet priority for QoS. */
93 uint32_t pkt_mark; /* Packet mark. */
94 uint32_t recirc_id; /* Must be exact match. */
95 union flow_in_port in_port; /* Input port.*/
97 /* L2, Order the same as in the Ethernet header! */
98 uint8_t dl_dst[6]; /* Ethernet destination address. */
99 uint8_t dl_src[6]; /* Ethernet source address. */
100 ovs_be16 dl_type; /* Ethernet frame type. */
101 ovs_be16 vlan_tci; /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */
102 ovs_be32 mpls_lse[FLOW_MAX_MPLS_LABELS]; /* MPLS label stack entry. */
105 struct in6_addr ipv6_src; /* IPv6 source address. */
106 struct in6_addr ipv6_dst; /* IPv6 destination address. */
107 ovs_be32 ipv6_label; /* IPv6 flow label. */
108 ovs_be32 nw_src; /* IPv4 source address. */
109 ovs_be32 nw_dst; /* IPv4 destination address. */
110 uint8_t nw_frag; /* FLOW_FRAG_* flags. */
111 uint8_t nw_tos; /* IP ToS (including DSCP and ECN). */
112 uint8_t nw_ttl; /* IP TTL/Hop Limit. */
113 uint8_t nw_proto; /* IP protocol or low 8 bits of ARP opcode. */
114 uint8_t arp_sha[6]; /* ARP/ND source hardware address. */
115 uint8_t arp_tha[6]; /* ARP/ND target hardware address. */
116 struct in6_addr nd_target; /* IPv6 neighbor discovery (ND) target. */
117 ovs_be16 tcp_flags; /* TCP flags. With L3 to avoid matching L4. */
118 ovs_be16 pad; /* Padding. */
121 ovs_be16 tp_src; /* TCP/UDP/SCTP source port. */
122 ovs_be16 tp_dst; /* TCP/UDP/SCTP destination port. */
123 ovs_be32 igmp_group_ip4; /* IGMP group IPv4 address */
124 uint32_t dp_hash; /* Datapath computed hash value. The exact
125 * computation is opaque to the user space.
126 * Keep last for BUILD_ASSERT_DECL below. */
128 BUILD_ASSERT_DECL(sizeof(struct flow) % 4 == 0);
130 #define FLOW_U32S (sizeof(struct flow) / 4)
132 /* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */
133 BUILD_ASSERT_DECL(offsetof(struct flow, dp_hash) + sizeof(uint32_t)
134 == sizeof(struct flow_tnl) + 176
135 && FLOW_WC_SEQ == 27);
137 /* Incremental points at which flow classification may be performed in
139 * This is located here since this is dependent on the structure of the
140 * struct flow defined above:
141 * Each offset must be on a distinct, successive U32 boundary strictly
142 * within the struct flow. */
144 FLOW_SEGMENT_1_ENDS_AT = offsetof(struct flow, dl_dst),
145 FLOW_SEGMENT_2_ENDS_AT = offsetof(struct flow, ipv6_src),
146 FLOW_SEGMENT_3_ENDS_AT = offsetof(struct flow, tp_src),
148 BUILD_ASSERT_DECL(FLOW_SEGMENT_1_ENDS_AT % 4 == 0);
149 BUILD_ASSERT_DECL(FLOW_SEGMENT_2_ENDS_AT % 4 == 0);
150 BUILD_ASSERT_DECL(FLOW_SEGMENT_3_ENDS_AT % 4 == 0);
151 BUILD_ASSERT_DECL( 0 < FLOW_SEGMENT_1_ENDS_AT);
152 BUILD_ASSERT_DECL(FLOW_SEGMENT_1_ENDS_AT < FLOW_SEGMENT_2_ENDS_AT);
153 BUILD_ASSERT_DECL(FLOW_SEGMENT_2_ENDS_AT < FLOW_SEGMENT_3_ENDS_AT);
154 BUILD_ASSERT_DECL(FLOW_SEGMENT_3_ENDS_AT < sizeof(struct flow));
156 extern const uint8_t flow_segment_u32s[];
158 /* Represents the metadata fields of struct flow. */
159 struct flow_metadata {
160 uint32_t dp_hash; /* Datapath computed hash field. */
161 uint32_t recirc_id; /* Recirculation ID. */
162 ovs_be64 tun_id; /* Encapsulating tunnel ID. */
163 ovs_be32 tun_src; /* Tunnel outer IPv4 src addr */
164 ovs_be32 tun_dst; /* Tunnel outer IPv4 dst addr */
165 ovs_be64 metadata; /* OpenFlow 1.1+ metadata field. */
166 uint32_t regs[FLOW_N_REGS]; /* Registers. */
167 uint32_t pkt_mark; /* Packet mark. */
168 ofp_port_t in_port; /* OpenFlow port or zero. */
171 void flow_extract(struct ofpbuf *, const struct pkt_metadata *md,
174 void flow_zero_wildcards(struct flow *, const struct flow_wildcards *);
175 void flow_unwildcard_tp_ports(const struct flow *, struct flow_wildcards *);
176 void flow_get_metadata(const struct flow *, struct flow_metadata *);
178 char *flow_to_string(const struct flow *);
179 void format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t),
180 uint32_t flags, char del);
181 void format_flags_masked(struct ds *ds, const char *name,
182 const char *(*bit_to_string)(uint32_t),
183 uint32_t flags, uint32_t mask);
185 void flow_format(struct ds *, const struct flow *);
186 void flow_print(FILE *, const struct flow *);
187 static inline int flow_compare_3way(const struct flow *, const struct flow *);
188 static inline bool flow_equal(const struct flow *, const struct flow *);
189 static inline size_t flow_hash(const struct flow *, uint32_t basis);
191 void flow_set_dl_vlan(struct flow *, ovs_be16 vid);
192 void flow_set_vlan_vid(struct flow *, ovs_be16 vid);
193 void flow_set_vlan_pcp(struct flow *, uint8_t pcp);
195 int flow_count_mpls_labels(const struct flow *, struct flow_wildcards *);
196 int flow_count_common_mpls_labels(const struct flow *a, int an,
197 const struct flow *b, int bn,
198 struct flow_wildcards *wc);
199 void flow_push_mpls(struct flow *, int n, ovs_be16 mpls_eth_type,
200 struct flow_wildcards *);
201 bool flow_pop_mpls(struct flow *, int n, ovs_be16 eth_type,
202 struct flow_wildcards *);
203 void flow_set_mpls_label(struct flow *, int idx, ovs_be32 label);
204 void flow_set_mpls_ttl(struct flow *, int idx, uint8_t ttl);
205 void flow_set_mpls_tc(struct flow *, int idx, uint8_t tc);
206 void flow_set_mpls_bos(struct flow *, int idx, uint8_t stack);
207 void flow_set_mpls_lse(struct flow *, int idx, ovs_be32 lse);
209 void flow_compose(struct ofpbuf *, const struct flow *);
212 flow_compare_3way(const struct flow *a, const struct flow *b)
214 return memcmp(a, b, sizeof *a);
218 flow_equal(const struct flow *a, const struct flow *b)
220 return !flow_compare_3way(a, b);
224 flow_hash(const struct flow *flow, uint32_t basis)
226 return hash_words((const uint32_t *) flow, sizeof *flow / 4, basis);
229 static inline uint16_t
230 ofp_to_u16(ofp_port_t ofp_port)
232 return (OVS_FORCE uint16_t) ofp_port;
235 static inline uint32_t
236 odp_to_u32(odp_port_t odp_port)
238 return (OVS_FORCE uint32_t) odp_port;
241 static inline uint32_t
242 ofp11_to_u32(ofp11_port_t ofp11_port)
244 return (OVS_FORCE uint32_t) ofp11_port;
247 static inline ofp_port_t
248 u16_to_ofp(uint16_t port)
250 return OFP_PORT_C(port);
253 static inline odp_port_t
254 u32_to_odp(uint32_t port)
256 return ODP_PORT_C(port);
259 static inline ofp11_port_t
260 u32_to_ofp11(uint32_t port)
262 return OFP11_PORT_C(port);
265 static inline uint32_t
266 hash_ofp_port(ofp_port_t ofp_port)
268 return hash_int(ofp_to_u16(ofp_port), 0);
271 static inline uint32_t
272 hash_odp_port(odp_port_t odp_port)
274 return hash_int(odp_to_u32(odp_port), 0);
277 /* Wildcards for a flow.
279 * A 1-bit in each bit in 'masks' indicates that the corresponding bit of
280 * the flow is significant (must match). A 0-bit indicates that the
281 * corresponding bit of the flow is wildcarded (need not match). */
282 struct flow_wildcards {
286 void flow_wildcards_init_catchall(struct flow_wildcards *);
288 void flow_wildcards_clear_non_packet_fields(struct flow_wildcards *);
290 bool flow_wildcards_is_catchall(const struct flow_wildcards *);
292 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
293 int idx, uint32_t mask);
295 void flow_wildcards_and(struct flow_wildcards *dst,
296 const struct flow_wildcards *src1,
297 const struct flow_wildcards *src2);
298 void flow_wildcards_or(struct flow_wildcards *dst,
299 const struct flow_wildcards *src1,
300 const struct flow_wildcards *src2);
301 bool flow_wildcards_has_extra(const struct flow_wildcards *,
302 const struct flow_wildcards *);
303 uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis);
304 bool flow_wildcards_equal(const struct flow_wildcards *,
305 const struct flow_wildcards *);
306 uint32_t flow_hash_5tuple(const struct flow *flow, uint32_t basis);
307 uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
309 /* Initialize a flow with random fields that matter for nx_hash_fields. */
310 void flow_random_hash_fields(struct flow *);
311 void flow_mask_hash_fields(const struct flow *, struct flow_wildcards *,
312 enum nx_hash_fields);
313 uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields,
315 const char *flow_hash_fields_to_str(enum nx_hash_fields);
316 bool flow_hash_fields_valid(enum nx_hash_fields);
318 uint32_t flow_hash_in_wildcards(const struct flow *,
319 const struct flow_wildcards *,
322 bool flow_equal_except(const struct flow *a, const struct flow *b,
323 const struct flow_wildcards *);
325 /* Compressed flow. */
327 #define MINI_N_INLINE (sizeof(void *) == 4 ? 7 : 8)
328 BUILD_ASSERT_DECL(FLOW_U32S <= 63);
330 /* A sparse representation of a "struct flow".
332 * A "struct flow" is fairly large and tends to be mostly zeros. Sparse
333 * representation has two advantages. First, it saves memory. Second, it
334 * saves time when the goal is to iterate over only the nonzero parts of the
337 * The 'map' member holds one bit for each uint32_t in a "struct flow". Each
338 * 0-bit indicates that the corresponding uint32_t is zero, each 1-bit that it
339 * *may* be nonzero (see below how this applies to minimasks).
341 * The 'values_inline' boolean member indicates that the values are at
342 * 'inline_values'. If 'values_inline' is zero, then the values are
343 * offline at 'offline_values'. In either case, values is an array that has
344 * one element for each 1-bit in 'map'. The least-numbered 1-bit is in
345 * the first element of the values array, the next 1-bit is in the next array
346 * element, and so on.
348 * Elements in values array are allowed to be zero. This is useful for "struct
349 * minimatch", for which ensuring that the miniflow and minimask members have
350 * same 'map' allows optimization. This allowance applies only to a miniflow
351 * that is not a mask. That is, a minimask may NOT have zero elements in
356 uint64_t values_inline:1;
358 uint32_t *offline_values;
359 uint32_t inline_values[MINI_N_INLINE];
363 #define MINIFLOW_VALUES_SIZE(COUNT) ((COUNT) * sizeof(uint32_t))
365 static inline uint32_t *miniflow_values(struct miniflow *mf)
367 return OVS_LIKELY(mf->values_inline)
368 ? mf->inline_values : mf->offline_values;
371 static inline const uint32_t *miniflow_get_values(const struct miniflow *mf)
373 return OVS_LIKELY(mf->values_inline)
374 ? mf->inline_values : mf->offline_values;
377 static inline const uint32_t *miniflow_get_u32_values(const struct miniflow *mf)
379 return miniflow_get_values(mf);
382 static inline const ovs_be32 *miniflow_get_be32_values(const struct miniflow *mf)
384 return (OVS_FORCE const ovs_be32 *)miniflow_get_values(mf);
387 /* This is useful for initializing a miniflow for a miniflow_extract() call. */
388 static inline void miniflow_initialize(struct miniflow *mf,
389 uint32_t buf[FLOW_U32S])
392 mf->values_inline = (buf == (uint32_t *)(mf + 1));
393 if (!mf->values_inline) {
394 mf->offline_values = buf;
400 /* The 'dst->values' must be initialized with a buffer with space for
401 * FLOW_U32S. 'dst->map' is ignored on input and set on output to
402 * indicate which fields were extracted. */
403 void miniflow_extract(struct ofpbuf *packet, const struct pkt_metadata *,
404 struct miniflow *dst);
405 void miniflow_init(struct miniflow *, const struct flow *);
406 void miniflow_init_with_minimask(struct miniflow *, const struct flow *,
407 const struct minimask *);
408 void miniflow_clone(struct miniflow *, const struct miniflow *);
409 void miniflow_clone_inline(struct miniflow *, const struct miniflow *,
411 void miniflow_move(struct miniflow *dst, struct miniflow *);
412 void miniflow_destroy(struct miniflow *);
414 void miniflow_expand(const struct miniflow *, struct flow *);
416 static inline uint32_t flow_u32_value(const struct flow *flow, size_t index)
418 return ((uint32_t *)(flow))[index];
421 static inline uint32_t *flow_u32_lvalue(struct flow *flow, size_t index)
423 return &((uint32_t *)(flow))[index];
427 flow_get_next_in_map(const struct flow *flow, uint64_t map, uint32_t *value)
430 *value = flow_u32_value(flow, raw_ctz(map));
436 /* Iterate through all flow u32 values specified by 'MAP'. */
437 #define FLOW_FOR_EACH_IN_MAP(VALUE, FLOW, MAP) \
438 for (uint64_t map__ = (MAP); \
439 flow_get_next_in_map(FLOW, map__, &(VALUE)); \
440 map__ = zero_rightmost_1bit(map__))
442 /* Iterate through all struct flow u32 indices specified by 'MAP'. */
443 #define MAP_FOR_EACH_INDEX(U32IDX, MAP) \
444 for (uint64_t map__ = (MAP); \
445 ((U32IDX) = ctz64(map__)) < FLOW_U32S; \
446 map__ = zero_rightmost_1bit(map__))
448 #define FLOW_U32_SIZE(FIELD) \
449 DIV_ROUND_UP(sizeof(((struct flow *)0)->FIELD), sizeof(uint32_t))
451 #define MINIFLOW_MAP(FIELD) \
452 (((UINT64_C(1) << FLOW_U32_SIZE(FIELD)) - 1) \
453 << (offsetof(struct flow, FIELD) / 4))
455 static inline uint32_t
456 mf_get_next_in_map(uint64_t *fmap, uint64_t rm1bit, const uint32_t **fp,
460 if (*fmap & rm1bit) {
461 uint64_t trash = *fmap & (rm1bit - 1);
465 *fp += count_1bits(trash);
472 /* Iterate through all miniflow u32 values specified by 'MAP'.
473 * This works as the first statement in a block.*/
474 #define MINIFLOW_FOR_EACH_IN_MAP(VALUE, FLOW, MAP) \
475 const uint32_t *fp_ = miniflow_get_u32_values(FLOW); \
476 uint64_t rm1bit_, fmap_, map_; \
477 for (fmap_ = (FLOW)->map, map_ = (MAP), rm1bit_ = rightmost_1bit(map_); \
478 mf_get_next_in_map(&fmap_, rm1bit_, &fp_, &(VALUE)); \
479 map_ -= rm1bit_, rm1bit_ = rightmost_1bit(map_))
481 /* Get the value of 'FIELD' of an up to 4 byte wide integer type 'TYPE' of
483 #define MINIFLOW_GET_TYPE(MF, TYPE, OFS) \
484 (((MF)->map & (UINT64_C(1) << (OFS) / 4)) \
485 ? ((OVS_FORCE const TYPE *) \
486 (miniflow_get_u32_values(MF) \
487 + count_1bits((MF)->map & ((UINT64_C(1) << (OFS) / 4) - 1)))) \
488 [(OFS) % 4 / sizeof(TYPE)] \
491 #define MINIFLOW_GET_U8(FLOW, FIELD) \
492 MINIFLOW_GET_TYPE(FLOW, uint8_t, offsetof(struct flow, FIELD))
493 #define MINIFLOW_GET_U16(FLOW, FIELD) \
494 MINIFLOW_GET_TYPE(FLOW, uint16_t, offsetof(struct flow, FIELD))
495 #define MINIFLOW_GET_BE16(FLOW, FIELD) \
496 MINIFLOW_GET_TYPE(FLOW, ovs_be16, offsetof(struct flow, FIELD))
497 #define MINIFLOW_GET_U32(FLOW, FIELD) \
498 MINIFLOW_GET_TYPE(FLOW, uint32_t, offsetof(struct flow, FIELD))
499 #define MINIFLOW_GET_BE32(FLOW, FIELD) \
500 MINIFLOW_GET_TYPE(FLOW, ovs_be32, offsetof(struct flow, FIELD))
502 static inline uint16_t miniflow_get_vid(const struct miniflow *);
503 static inline uint16_t miniflow_get_tcp_flags(const struct miniflow *);
504 static inline ovs_be64 miniflow_get_metadata(const struct miniflow *);
506 bool miniflow_equal(const struct miniflow *a, const struct miniflow *b);
507 bool miniflow_equal_in_minimask(const struct miniflow *a,
508 const struct miniflow *b,
509 const struct minimask *);
510 bool miniflow_equal_flow_in_minimask(const struct miniflow *a,
511 const struct flow *b,
512 const struct minimask *);
513 uint32_t miniflow_hash_5tuple(const struct miniflow *flow, uint32_t basis);
516 /* Compressed flow wildcards. */
518 /* A sparse representation of a "struct flow_wildcards".
520 * See the large comment on struct miniflow for details.
522 * Note: While miniflow can have zero data for a 1-bit in the map,
523 * a minimask may not! We rely on this in the implementation. */
525 struct miniflow masks;
528 void minimask_init(struct minimask *, const struct flow_wildcards *);
529 void minimask_clone(struct minimask *, const struct minimask *);
530 void minimask_move(struct minimask *dst, struct minimask *src);
531 void minimask_combine(struct minimask *dst,
532 const struct minimask *a, const struct minimask *b,
533 uint32_t storage[FLOW_U32S]);
534 void minimask_destroy(struct minimask *);
536 void minimask_expand(const struct minimask *, struct flow_wildcards *);
538 uint32_t minimask_get(const struct minimask *, unsigned int u32_ofs);
539 static inline uint16_t minimask_get_vid_mask(const struct minimask *);
540 static inline ovs_be64 minimask_get_metadata_mask(const struct minimask *);
542 bool minimask_equal(const struct minimask *a, const struct minimask *b);
543 bool minimask_has_extra(const struct minimask *, const struct minimask *);
546 /* Returns true if 'mask' matches every packet, false if 'mask' fixes any bits
549 minimask_is_catchall(const struct minimask *mask)
551 /* For every 1-bit in mask's map, the corresponding value is non-zero,
552 * so the only way the mask can not fix any bits or fields is for the
553 * map the be zero. */
554 return mask->masks.map == 0;
557 /* Returns the VID within the vlan_tci member of the "struct flow" represented
559 static inline uint16_t
560 miniflow_get_vid(const struct miniflow *flow)
562 ovs_be16 tci = MINIFLOW_GET_BE16(flow, vlan_tci);
563 return vlan_tci_to_vid(tci);
566 /* Returns the VID mask within the vlan_tci member of the "struct
567 * flow_wildcards" represented by 'mask'. */
568 static inline uint16_t
569 minimask_get_vid_mask(const struct minimask *mask)
571 return miniflow_get_vid(&mask->masks);
574 /* Returns the value of the "tcp_flags" field in 'flow'. */
575 static inline uint16_t
576 miniflow_get_tcp_flags(const struct miniflow *flow)
578 return ntohs(MINIFLOW_GET_BE16(flow, tcp_flags));
581 /* Returns the value of the OpenFlow 1.1+ "metadata" field in 'flow'. */
582 static inline ovs_be64
583 miniflow_get_metadata(const struct miniflow *flow)
593 enum { MD_OFS = offsetof(struct flow, metadata) };
594 BUILD_ASSERT_DECL(MD_OFS % sizeof(uint32_t) == 0);
595 value.hi = MINIFLOW_GET_TYPE(flow, ovs_be32, MD_OFS);
596 value.lo = MINIFLOW_GET_TYPE(flow, ovs_be32, MD_OFS + 4);
601 /* Returns the mask for the OpenFlow 1.1+ "metadata" field in 'mask'.
603 * The return value is all-1-bits if 'mask' matches on the whole value of the
604 * metadata field, all-0-bits if 'mask' entirely wildcards the metadata field,
605 * or some other value if the metadata field is partially matched, partially
607 static inline ovs_be64
608 minimask_get_metadata_mask(const struct minimask *mask)
610 return miniflow_get_metadata(&mask->masks);
613 /* Perform a bitwise OR of miniflow 'src' flow data with the equivalent
614 * fields in 'dst', storing the result in 'dst'. */
616 flow_union_with_miniflow(struct flow *dst, const struct miniflow *src)
618 uint32_t *dst_u32 = (uint32_t *) dst;
619 const uint32_t *p = miniflow_get_u32_values(src);
622 for (map = src->map; map; map = zero_rightmost_1bit(map)) {
623 dst_u32[raw_ctz(map)] |= *p++;
627 static inline struct pkt_metadata
628 pkt_metadata_from_flow(const struct flow *flow)
630 struct pkt_metadata md;
632 md.recirc_id = flow->recirc_id;
633 md.dp_hash = flow->dp_hash;
634 md.tunnel = flow->tunnel;
635 md.skb_priority = flow->skb_priority;
636 md.pkt_mark = flow->pkt_mark;
637 md.in_port = flow->in_port;
642 static inline bool is_ip_any(const struct flow *flow)
644 return dl_type_is_ip_any(flow->dl_type);
647 static inline bool is_icmpv4(const struct flow *flow)
649 return (flow->dl_type == htons(ETH_TYPE_IP)
650 && flow->nw_proto == IPPROTO_ICMP);
653 static inline bool is_icmpv6(const struct flow *flow)
655 return (flow->dl_type == htons(ETH_TYPE_IPV6)
656 && flow->nw_proto == IPPROTO_ICMPV6);
659 static inline bool is_stp(const struct flow *flow)
661 return (eth_addr_equals(flow->dl_dst, eth_addr_stp)
662 && flow->dl_type == htons(FLOW_DL_TYPE_NONE));