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
43 /* Number of Open vSwitch extension 32-bit registers. */
45 BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS);
47 /* Number of OpenFlow 1.5+ 64-bit registers.
49 * Each of these overlays a pair of Open vSwitch 32-bit registers, so there
50 * are half as many of them.*/
51 #define FLOW_N_XREGS (FLOW_N_REGS / 2)
53 /* Used for struct flow's dl_type member for frames that have no Ethernet
54 * type, that is, pure 802.2 frames. */
55 #define FLOW_DL_TYPE_NONE 0x5ff
57 /* Fragment bits, used for IPv4 and IPv6, always zero for non-IP flows. */
58 #define FLOW_NW_FRAG_ANY (1 << 0) /* Set for any IP frag. */
59 #define FLOW_NW_FRAG_LATER (1 << 1) /* Set for IP frag with nonzero offset. */
60 #define FLOW_NW_FRAG_MASK (FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER)
62 BUILD_ASSERT_DECL(FLOW_NW_FRAG_ANY == NX_IP_FRAG_ANY);
63 BUILD_ASSERT_DECL(FLOW_NW_FRAG_LATER == NX_IP_FRAG_LATER);
65 #define FLOW_TNL_F_DONT_FRAGMENT (1 << 0)
66 #define FLOW_TNL_F_CSUM (1 << 1)
67 #define FLOW_TNL_F_KEY (1 << 2)
68 #define FLOW_TNL_F_OAM (1 << 3)
70 #define FLOW_TNL_F_MASK ((1 << 4) - 1)
72 const char *flow_tun_flag_to_string(uint32_t flags);
74 /* Maximum number of supported MPLS labels. */
75 #define FLOW_MAX_MPLS_LABELS 3
78 * A flow in the network.
80 * Must be initialized to all zeros to make any compiler-induced padding
81 * zeroed. Helps also in keeping unused fields (such as mutually exclusive
82 * IPv4 and IPv6 addresses) zeroed out.
84 * The meaning of 'in_port' is context-dependent. In most cases, it is a
85 * 16-bit OpenFlow 1.0 port number. In the software datapath interface (dpif)
86 * layer and its implementations (e.g. dpif-netlink, dpif-netdev), it is
87 * instead a 32-bit datapath port number.
89 * The fields are organized in four segments to facilitate staged lookup, where
90 * lower layer fields are first used to determine if the later fields need to
91 * be looked at. This enables better wildcarding for datapath flows.
93 * NOTE: Order of the fields is significant, any change in the order must be
94 * reflected in miniflow_extract()!
98 struct flow_tnl tunnel; /* Encapsulating tunnel parameters. */
99 ovs_be64 metadata; /* OpenFlow Metadata. */
100 uint32_t regs[FLOW_N_REGS]; /* Registers. */
101 uint32_t skb_priority; /* Packet priority for QoS. */
102 uint32_t pkt_mark; /* Packet mark. */
103 uint32_t recirc_id; /* Must be exact match. */
104 union flow_in_port in_port; /* Input port.*/
106 /* L2, Order the same as in the Ethernet header! */
107 uint8_t dl_dst[6]; /* Ethernet destination address. */
108 uint8_t dl_src[6]; /* Ethernet source address. */
109 ovs_be16 dl_type; /* Ethernet frame type. */
110 ovs_be16 vlan_tci; /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */
111 ovs_be32 mpls_lse[FLOW_MAX_MPLS_LABELS]; /* MPLS label stack entry. */
114 struct in6_addr ipv6_src; /* IPv6 source address. */
115 struct in6_addr ipv6_dst; /* IPv6 destination address. */
116 ovs_be32 ipv6_label; /* IPv6 flow label. */
117 ovs_be32 nw_src; /* IPv4 source address. */
118 ovs_be32 nw_dst; /* IPv4 destination address. */
119 uint8_t nw_frag; /* FLOW_FRAG_* flags. */
120 uint8_t nw_tos; /* IP ToS (including DSCP and ECN). */
121 uint8_t nw_ttl; /* IP TTL/Hop Limit. */
122 uint8_t nw_proto; /* IP protocol or low 8 bits of ARP opcode. */
123 uint8_t arp_sha[6]; /* ARP/ND source hardware address. */
124 uint8_t arp_tha[6]; /* ARP/ND target hardware address. */
125 struct in6_addr nd_target; /* IPv6 neighbor discovery (ND) target. */
126 ovs_be16 tcp_flags; /* TCP flags. With L3 to avoid matching L4. */
127 ovs_be16 pad; /* Padding. */
130 ovs_be16 tp_src; /* TCP/UDP/SCTP source port. */
131 ovs_be16 tp_dst; /* TCP/UDP/SCTP destination port. */
132 ovs_be32 igmp_group_ip4; /* IGMP group IPv4 address */
133 uint32_t dp_hash; /* Datapath computed hash value. The exact
134 * computation is opaque to the user space.
135 * Keep last for BUILD_ASSERT_DECL below. */
137 BUILD_ASSERT_DECL(sizeof(struct flow) % 4 == 0);
139 #define FLOW_U32S (sizeof(struct flow) / 4)
141 /* Some flow fields are mutually exclusive or only appear within the flow
142 * pipeline. IPv6 headers are bigger than IPv4 and MPLS, and IPv6 ND packets
143 * are bigger than TCP,UDP and IGMP packets. */
144 #define FLOW_MAX_PACKET_U32S (FLOW_U32S \
145 /* Unused in datapath */ - FLOW_U32_SIZE(regs) \
146 - FLOW_U32_SIZE(metadata) \
147 /* L2.5/3 */ - FLOW_U32_SIZE(nw_src) \
148 - FLOW_U32_SIZE(nw_dst) \
149 - FLOW_U32_SIZE(mpls_lse) \
150 /* L4 */ - FLOW_U32_SIZE(tcp_flags) /* incl. pad. */ \
151 - FLOW_U32_SIZE(igmp_group_ip4) \
154 /* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */
155 BUILD_ASSERT_DECL(offsetof(struct flow, dp_hash) + sizeof(uint32_t)
156 == sizeof(struct flow_tnl) + 176
157 && FLOW_WC_SEQ == 27);
159 /* Incremental points at which flow classification may be performed in
161 * This is located here since this is dependent on the structure of the
162 * struct flow defined above:
163 * Each offset must be on a distinct, successive U32 boundary strictly
164 * within the struct flow. */
166 FLOW_SEGMENT_1_ENDS_AT = offsetof(struct flow, dl_dst),
167 FLOW_SEGMENT_2_ENDS_AT = offsetof(struct flow, ipv6_src),
168 FLOW_SEGMENT_3_ENDS_AT = offsetof(struct flow, tp_src),
170 BUILD_ASSERT_DECL(FLOW_SEGMENT_1_ENDS_AT % 4 == 0);
171 BUILD_ASSERT_DECL(FLOW_SEGMENT_2_ENDS_AT % 4 == 0);
172 BUILD_ASSERT_DECL(FLOW_SEGMENT_3_ENDS_AT % 4 == 0);
173 BUILD_ASSERT_DECL( 0 < FLOW_SEGMENT_1_ENDS_AT);
174 BUILD_ASSERT_DECL(FLOW_SEGMENT_1_ENDS_AT < FLOW_SEGMENT_2_ENDS_AT);
175 BUILD_ASSERT_DECL(FLOW_SEGMENT_2_ENDS_AT < FLOW_SEGMENT_3_ENDS_AT);
176 BUILD_ASSERT_DECL(FLOW_SEGMENT_3_ENDS_AT < sizeof(struct flow));
178 extern const uint8_t flow_segment_u32s[];
180 /* Represents the metadata fields of struct flow. */
181 struct flow_metadata {
182 uint32_t dp_hash; /* Datapath computed hash field. */
183 uint32_t recirc_id; /* Recirculation ID. */
184 ovs_be64 tun_id; /* Encapsulating tunnel ID. */
185 ovs_be32 tun_src; /* Tunnel outer IPv4 src addr */
186 ovs_be32 tun_dst; /* Tunnel outer IPv4 dst addr */
187 ovs_be64 metadata; /* OpenFlow 1.1+ metadata field. */
188 uint32_t regs[FLOW_N_REGS]; /* Registers. */
189 uint32_t pkt_mark; /* Packet mark. */
190 ofp_port_t in_port; /* OpenFlow port or zero. */
193 void flow_extract(struct ofpbuf *, const struct pkt_metadata *md,
196 void flow_zero_wildcards(struct flow *, const struct flow_wildcards *);
197 void flow_unwildcard_tp_ports(const struct flow *, struct flow_wildcards *);
198 void flow_get_metadata(const struct flow *, struct flow_metadata *);
200 char *flow_to_string(const struct flow *);
201 void format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t),
202 uint32_t flags, char del);
203 void format_flags_masked(struct ds *ds, const char *name,
204 const char *(*bit_to_string)(uint32_t),
205 uint32_t flags, uint32_t mask);
207 void flow_format(struct ds *, const struct flow *);
208 void flow_print(FILE *, const struct flow *);
209 static inline int flow_compare_3way(const struct flow *, const struct flow *);
210 static inline bool flow_equal(const struct flow *, const struct flow *);
211 static inline size_t flow_hash(const struct flow *, uint32_t basis);
213 void flow_set_dl_vlan(struct flow *, ovs_be16 vid);
214 void flow_set_vlan_vid(struct flow *, ovs_be16 vid);
215 void flow_set_vlan_pcp(struct flow *, uint8_t pcp);
217 int flow_count_mpls_labels(const struct flow *, struct flow_wildcards *);
218 int flow_count_common_mpls_labels(const struct flow *a, int an,
219 const struct flow *b, int bn,
220 struct flow_wildcards *wc);
221 void flow_push_mpls(struct flow *, int n, ovs_be16 mpls_eth_type,
222 struct flow_wildcards *);
223 bool flow_pop_mpls(struct flow *, int n, ovs_be16 eth_type,
224 struct flow_wildcards *);
225 void flow_set_mpls_label(struct flow *, int idx, ovs_be32 label);
226 void flow_set_mpls_ttl(struct flow *, int idx, uint8_t ttl);
227 void flow_set_mpls_tc(struct flow *, int idx, uint8_t tc);
228 void flow_set_mpls_bos(struct flow *, int idx, uint8_t stack);
229 void flow_set_mpls_lse(struct flow *, int idx, ovs_be32 lse);
231 void flow_compose(struct ofpbuf *, const struct flow *);
233 static inline uint64_t
234 flow_get_xreg(const struct flow *flow, int idx)
236 return ((uint64_t) flow->regs[idx * 2] << 32) | flow->regs[idx * 2 + 1];
240 flow_set_xreg(struct flow *flow, int idx, uint64_t value)
242 flow->regs[idx * 2] = value >> 32;
243 flow->regs[idx * 2 + 1] = value;
247 flow_compare_3way(const struct flow *a, const struct flow *b)
249 return memcmp(a, b, sizeof *a);
253 flow_equal(const struct flow *a, const struct flow *b)
255 return !flow_compare_3way(a, b);
259 flow_hash(const struct flow *flow, uint32_t basis)
261 return hash_words((const uint32_t *) flow, sizeof *flow / 4, basis);
264 static inline uint16_t
265 ofp_to_u16(ofp_port_t ofp_port)
267 return (OVS_FORCE uint16_t) ofp_port;
270 static inline uint32_t
271 odp_to_u32(odp_port_t odp_port)
273 return (OVS_FORCE uint32_t) odp_port;
276 static inline uint32_t
277 ofp11_to_u32(ofp11_port_t ofp11_port)
279 return (OVS_FORCE uint32_t) ofp11_port;
282 static inline ofp_port_t
283 u16_to_ofp(uint16_t port)
285 return OFP_PORT_C(port);
288 static inline odp_port_t
289 u32_to_odp(uint32_t port)
291 return ODP_PORT_C(port);
294 static inline ofp11_port_t
295 u32_to_ofp11(uint32_t port)
297 return OFP11_PORT_C(port);
300 static inline uint32_t
301 hash_ofp_port(ofp_port_t ofp_port)
303 return hash_int(ofp_to_u16(ofp_port), 0);
306 static inline uint32_t
307 hash_odp_port(odp_port_t odp_port)
309 return hash_int(odp_to_u32(odp_port), 0);
312 /* Wildcards for a flow.
314 * A 1-bit in each bit in 'masks' indicates that the corresponding bit of
315 * the flow is significant (must match). A 0-bit indicates that the
316 * corresponding bit of the flow is wildcarded (need not match). */
317 struct flow_wildcards {
321 #define WC_MASK_FIELD(WC, FIELD) \
322 memset(&(WC)->masks.FIELD, 0xff, sizeof (WC)->masks.FIELD)
323 #define WC_UNMASK_FIELD(WC, FIELD) \
324 memset(&(WC)->masks.FIELD, 0, sizeof (WC)->masks.FIELD)
326 void flow_wildcards_init_catchall(struct flow_wildcards *);
328 void flow_wildcards_init_for_packet(struct flow_wildcards *,
329 const struct flow *);
331 void flow_wildcards_clear_non_packet_fields(struct flow_wildcards *);
333 bool flow_wildcards_is_catchall(const struct flow_wildcards *);
335 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
336 int idx, uint32_t mask);
337 void flow_wildcards_set_xreg_mask(struct flow_wildcards *,
338 int idx, uint64_t mask);
340 void flow_wildcards_and(struct flow_wildcards *dst,
341 const struct flow_wildcards *src1,
342 const struct flow_wildcards *src2);
343 void flow_wildcards_or(struct flow_wildcards *dst,
344 const struct flow_wildcards *src1,
345 const struct flow_wildcards *src2);
346 bool flow_wildcards_has_extra(const struct flow_wildcards *,
347 const struct flow_wildcards *);
348 uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis);
349 bool flow_wildcards_equal(const struct flow_wildcards *,
350 const struct flow_wildcards *);
351 uint32_t flow_hash_5tuple(const struct flow *flow, uint32_t basis);
352 uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
354 /* Initialize a flow with random fields that matter for nx_hash_fields. */
355 void flow_random_hash_fields(struct flow *);
356 void flow_mask_hash_fields(const struct flow *, struct flow_wildcards *,
357 enum nx_hash_fields);
358 uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields,
360 const char *flow_hash_fields_to_str(enum nx_hash_fields);
361 bool flow_hash_fields_valid(enum nx_hash_fields);
363 uint32_t flow_hash_in_wildcards(const struct flow *,
364 const struct flow_wildcards *,
367 bool flow_equal_except(const struct flow *a, const struct flow *b,
368 const struct flow_wildcards *);
370 /* Compressed flow. */
372 /* Number of 32-bit words present in struct miniflow. */
373 #define MINI_N_INLINE 8
375 /* Maximum number of 32-bit words supported. */
376 BUILD_ASSERT_DECL(FLOW_U32S <= 63);
378 /* A sparse representation of a "struct flow".
380 * A "struct flow" is fairly large and tends to be mostly zeros. Sparse
381 * representation has two advantages. First, it saves memory. Second, it
382 * saves time when the goal is to iterate over only the nonzero parts of the
385 * The 'map' member holds one bit for each uint32_t in a "struct flow". Each
386 * 0-bit indicates that the corresponding uint32_t is zero, each 1-bit that it
387 * *may* be nonzero (see below how this applies to minimasks).
389 * The 'values_inline' boolean member indicates that the values are at
390 * 'inline_values'. If 'values_inline' is zero, then the values are
391 * offline at 'offline_values'. In either case, values is an array that has
392 * one element for each 1-bit in 'map'. The least-numbered 1-bit is in
393 * the first element of the values array, the next 1-bit is in the next array
394 * element, and so on.
396 * MINI_N_INLINE is the default number of inline words. When a miniflow is
397 * dynamically allocated the actual amount of inline storage may be different.
398 * In that case 'inline_values' contains storage at least for the number
399 * of words indicated by 'map' (one uint32_t for each 1-bit in the map).
401 * Elements in values array are allowed to be zero. This is useful for "struct
402 * minimatch", for which ensuring that the miniflow and minimask members have
403 * same 'map' allows optimization. This allowance applies only to a miniflow
404 * that is not a mask. That is, a minimask may NOT have zero elements in
409 uint64_t values_inline:1;
411 uint32_t *offline_values;
412 uint32_t inline_values[MINI_N_INLINE]; /* Minimum inline size. */
415 BUILD_ASSERT_DECL(sizeof(struct miniflow)
416 == sizeof(uint64_t) + MINI_N_INLINE * sizeof(uint32_t));
418 #define MINIFLOW_VALUES_SIZE(COUNT) ((COUNT) * sizeof(uint32_t))
420 static inline uint32_t *miniflow_values(struct miniflow *mf)
422 return OVS_LIKELY(mf->values_inline)
423 ? mf->inline_values : mf->offline_values;
426 static inline const uint32_t *miniflow_get_values(const struct miniflow *mf)
428 return OVS_LIKELY(mf->values_inline)
429 ? mf->inline_values : mf->offline_values;
432 static inline const uint32_t *miniflow_get_u32_values(const struct miniflow *mf)
434 return miniflow_get_values(mf);
437 static inline const ovs_be32 *miniflow_get_be32_values(const struct miniflow *mf)
439 return (OVS_FORCE const ovs_be32 *)miniflow_get_values(mf);
442 /* This is useful for initializing a miniflow for a miniflow_extract() call. */
443 static inline void miniflow_initialize(struct miniflow *mf,
444 uint32_t buf[FLOW_U32S])
447 mf->values_inline = (buf == (uint32_t *)(mf + 1));
448 if (!mf->values_inline) {
449 mf->offline_values = buf;
455 /* The 'dst->values' must be initialized with a buffer with space for
456 * FLOW_U32S. 'dst->map' is ignored on input and set on output to
457 * indicate which fields were extracted. */
458 void miniflow_extract(struct ofpbuf *packet, const struct pkt_metadata *,
459 struct miniflow *dst);
460 void miniflow_init(struct miniflow *, const struct flow *);
461 void miniflow_init_with_minimask(struct miniflow *, const struct flow *,
462 const struct minimask *);
463 void miniflow_clone(struct miniflow *, const struct miniflow *);
464 void miniflow_clone_inline(struct miniflow *, const struct miniflow *,
466 void miniflow_move(struct miniflow *dst, struct miniflow *);
467 void miniflow_destroy(struct miniflow *);
469 void miniflow_expand(const struct miniflow *, struct flow *);
471 static inline uint32_t flow_u32_value(const struct flow *flow, size_t index)
473 return ((uint32_t *)(flow))[index];
476 static inline uint32_t *flow_u32_lvalue(struct flow *flow, size_t index)
478 return &((uint32_t *)(flow))[index];
482 flow_get_next_in_map(const struct flow *flow, uint64_t map, uint32_t *value)
485 *value = flow_u32_value(flow, raw_ctz(map));
491 /* Iterate through all flow u32 values specified by 'MAP'. */
492 #define FLOW_FOR_EACH_IN_MAP(VALUE, FLOW, MAP) \
493 for (uint64_t map__ = (MAP); \
494 flow_get_next_in_map(FLOW, map__, &(VALUE)); \
495 map__ = zero_rightmost_1bit(map__))
497 /* Iterate through all struct flow u32 indices specified by 'MAP'. */
498 #define MAP_FOR_EACH_INDEX(U32IDX, MAP) \
499 for (uint64_t map__ = (MAP); \
500 ((U32IDX) = ctz64(map__)) < FLOW_U32S; \
501 map__ = zero_rightmost_1bit(map__))
503 #define FLOW_U32_SIZE(FIELD) \
504 DIV_ROUND_UP(sizeof(((struct flow *)0)->FIELD), sizeof(uint32_t))
506 #define MINIFLOW_MAP(FIELD) \
507 (((UINT64_C(1) << FLOW_U32_SIZE(FIELD)) - 1) \
508 << (offsetof(struct flow, FIELD) / 4))
510 static inline uint32_t
511 mf_get_next_in_map(uint64_t *fmap, uint64_t rm1bit, const uint32_t **fp,
515 if (*fmap & rm1bit) {
516 uint64_t trash = *fmap & (rm1bit - 1);
520 *fp += count_1bits(trash);
527 /* Iterate through all miniflow u32 values specified by 'MAP'.
528 * This works as the first statement in a block.*/
529 #define MINIFLOW_FOR_EACH_IN_MAP(VALUE, FLOW, MAP) \
530 const uint32_t *fp_ = miniflow_get_u32_values(FLOW); \
531 uint64_t rm1bit_, fmap_, map_; \
532 for (fmap_ = (FLOW)->map, map_ = (MAP), rm1bit_ = rightmost_1bit(map_); \
533 mf_get_next_in_map(&fmap_, rm1bit_, &fp_, &(VALUE)); \
534 map_ -= rm1bit_, rm1bit_ = rightmost_1bit(map_))
536 /* Get the value of 'FIELD' of an up to 4 byte wide integer type 'TYPE' of
538 #define MINIFLOW_GET_TYPE(MF, TYPE, OFS) \
539 (((MF)->map & (UINT64_C(1) << (OFS) / 4)) \
540 ? ((OVS_FORCE const TYPE *) \
541 (miniflow_get_u32_values(MF) \
542 + count_1bits((MF)->map & ((UINT64_C(1) << (OFS) / 4) - 1)))) \
543 [(OFS) % 4 / sizeof(TYPE)] \
546 #define MINIFLOW_GET_U8(FLOW, FIELD) \
547 MINIFLOW_GET_TYPE(FLOW, uint8_t, offsetof(struct flow, FIELD))
548 #define MINIFLOW_GET_U16(FLOW, FIELD) \
549 MINIFLOW_GET_TYPE(FLOW, uint16_t, offsetof(struct flow, FIELD))
550 #define MINIFLOW_GET_BE16(FLOW, FIELD) \
551 MINIFLOW_GET_TYPE(FLOW, ovs_be16, offsetof(struct flow, FIELD))
552 #define MINIFLOW_GET_U32(FLOW, FIELD) \
553 MINIFLOW_GET_TYPE(FLOW, uint32_t, offsetof(struct flow, FIELD))
554 #define MINIFLOW_GET_BE32(FLOW, FIELD) \
555 MINIFLOW_GET_TYPE(FLOW, ovs_be32, offsetof(struct flow, FIELD))
557 static inline uint16_t miniflow_get_vid(const struct miniflow *);
558 static inline uint16_t miniflow_get_tcp_flags(const struct miniflow *);
559 static inline ovs_be64 miniflow_get_metadata(const struct miniflow *);
561 bool miniflow_equal(const struct miniflow *a, const struct miniflow *b);
562 bool miniflow_equal_in_minimask(const struct miniflow *a,
563 const struct miniflow *b,
564 const struct minimask *);
565 bool miniflow_equal_flow_in_minimask(const struct miniflow *a,
566 const struct flow *b,
567 const struct minimask *);
568 uint32_t miniflow_hash_5tuple(const struct miniflow *flow, uint32_t basis);
571 /* Compressed flow wildcards. */
573 /* A sparse representation of a "struct flow_wildcards".
575 * See the large comment on struct miniflow for details.
577 * Note: While miniflow can have zero data for a 1-bit in the map,
578 * a minimask may not! We rely on this in the implementation. */
580 struct miniflow masks;
583 void minimask_init(struct minimask *, const struct flow_wildcards *);
584 void minimask_clone(struct minimask *, const struct minimask *);
585 void minimask_move(struct minimask *dst, struct minimask *src);
586 void minimask_combine(struct minimask *dst,
587 const struct minimask *a, const struct minimask *b,
588 uint32_t storage[FLOW_U32S]);
589 void minimask_destroy(struct minimask *);
591 void minimask_expand(const struct minimask *, struct flow_wildcards *);
593 uint32_t minimask_get(const struct minimask *, unsigned int u32_ofs);
594 static inline uint16_t minimask_get_vid_mask(const struct minimask *);
595 static inline ovs_be64 minimask_get_metadata_mask(const struct minimask *);
597 bool minimask_equal(const struct minimask *a, const struct minimask *b);
598 bool minimask_has_extra(const struct minimask *, const struct minimask *);
601 /* Returns true if 'mask' matches every packet, false if 'mask' fixes any bits
604 minimask_is_catchall(const struct minimask *mask)
606 /* For every 1-bit in mask's map, the corresponding value is non-zero,
607 * so the only way the mask can not fix any bits or fields is for the
608 * map the be zero. */
609 return mask->masks.map == 0;
612 /* Returns the VID within the vlan_tci member of the "struct flow" represented
614 static inline uint16_t
615 miniflow_get_vid(const struct miniflow *flow)
617 ovs_be16 tci = MINIFLOW_GET_BE16(flow, vlan_tci);
618 return vlan_tci_to_vid(tci);
621 /* Returns the VID mask within the vlan_tci member of the "struct
622 * flow_wildcards" represented by 'mask'. */
623 static inline uint16_t
624 minimask_get_vid_mask(const struct minimask *mask)
626 return miniflow_get_vid(&mask->masks);
629 /* Returns the value of the "tcp_flags" field in 'flow'. */
630 static inline uint16_t
631 miniflow_get_tcp_flags(const struct miniflow *flow)
633 return ntohs(MINIFLOW_GET_BE16(flow, tcp_flags));
636 /* Returns the value of the OpenFlow 1.1+ "metadata" field in 'flow'. */
637 static inline ovs_be64
638 miniflow_get_metadata(const struct miniflow *flow)
648 enum { MD_OFS = offsetof(struct flow, metadata) };
649 BUILD_ASSERT_DECL(MD_OFS % sizeof(uint32_t) == 0);
650 value.hi = MINIFLOW_GET_TYPE(flow, ovs_be32, MD_OFS);
651 value.lo = MINIFLOW_GET_TYPE(flow, ovs_be32, MD_OFS + 4);
656 /* Returns the mask for the OpenFlow 1.1+ "metadata" field in 'mask'.
658 * The return value is all-1-bits if 'mask' matches on the whole value of the
659 * metadata field, all-0-bits if 'mask' entirely wildcards the metadata field,
660 * or some other value if the metadata field is partially matched, partially
662 static inline ovs_be64
663 minimask_get_metadata_mask(const struct minimask *mask)
665 return miniflow_get_metadata(&mask->masks);
668 /* Perform a bitwise OR of miniflow 'src' flow data with the equivalent
669 * fields in 'dst', storing the result in 'dst'. */
671 flow_union_with_miniflow(struct flow *dst, const struct miniflow *src)
673 uint32_t *dst_u32 = (uint32_t *) dst;
674 const uint32_t *p = miniflow_get_u32_values(src);
677 for (map = src->map; map; map = zero_rightmost_1bit(map)) {
678 dst_u32[raw_ctz(map)] |= *p++;
682 static inline struct pkt_metadata
683 pkt_metadata_from_flow(const struct flow *flow)
685 struct pkt_metadata md;
687 md.recirc_id = flow->recirc_id;
688 md.dp_hash = flow->dp_hash;
689 md.tunnel = flow->tunnel;
690 md.skb_priority = flow->skb_priority;
691 md.pkt_mark = flow->pkt_mark;
692 md.in_port = flow->in_port;
697 static inline bool is_ip_any(const struct flow *flow)
699 return dl_type_is_ip_any(flow->dl_type);
702 static inline bool is_icmpv4(const struct flow *flow)
704 return (flow->dl_type == htons(ETH_TYPE_IP)
705 && flow->nw_proto == IPPROTO_ICMP);
708 static inline bool is_icmpv6(const struct flow *flow)
710 return (flow->dl_type == htons(ETH_TYPE_IPV6)
711 && flow->nw_proto == IPPROTO_ICMPV6);
714 static inline bool is_stp(const struct flow *flow)
716 return (eth_addr_equals(flow->dl_dst, eth_addr_stp)
717 && flow->dl_type == htons(FLOW_DL_TYPE_NONE));