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 29
43 /* Number of Open vSwitch extension 32-bit registers. */
45 BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS);
46 BUILD_ASSERT_DECL(FLOW_N_REGS % 2 == 0); /* Even. */
48 /* Number of OpenFlow 1.5+ 64-bit registers.
50 * Each of these overlays a pair of Open vSwitch 32-bit registers, so there
51 * are half as many of them.*/
52 #define FLOW_N_XREGS (FLOW_N_REGS / 2)
54 /* Used for struct flow's dl_type member for frames that have no Ethernet
55 * type, that is, pure 802.2 frames. */
56 #define FLOW_DL_TYPE_NONE 0x5ff
58 /* Fragment bits, used for IPv4 and IPv6, always zero for non-IP flows. */
59 #define FLOW_NW_FRAG_ANY (1 << 0) /* Set for any IP frag. */
60 #define FLOW_NW_FRAG_LATER (1 << 1) /* Set for IP frag with nonzero offset. */
61 #define FLOW_NW_FRAG_MASK (FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER)
63 BUILD_ASSERT_DECL(FLOW_NW_FRAG_ANY == NX_IP_FRAG_ANY);
64 BUILD_ASSERT_DECL(FLOW_NW_FRAG_LATER == NX_IP_FRAG_LATER);
66 #define FLOW_TNL_F_DONT_FRAGMENT (1 << 0)
67 #define FLOW_TNL_F_CSUM (1 << 1)
68 #define FLOW_TNL_F_KEY (1 << 2)
69 #define FLOW_TNL_F_OAM (1 << 3)
71 #define FLOW_TNL_F_MASK ((1 << 4) - 1)
73 const char *flow_tun_flag_to_string(uint32_t flags);
75 /* Maximum number of supported MPLS labels. */
76 #define FLOW_MAX_MPLS_LABELS 3
79 * A flow in the network.
81 * Must be initialized to all zeros to make any compiler-induced padding
82 * zeroed. Helps also in keeping unused fields (such as mutually exclusive
83 * IPv4 and IPv6 addresses) zeroed out.
85 * The meaning of 'in_port' is context-dependent. In most cases, it is a
86 * 16-bit OpenFlow 1.0 port number. In the software datapath interface (dpif)
87 * layer and its implementations (e.g. dpif-netlink, dpif-netdev), it is
88 * instead a 32-bit datapath port number.
90 * The fields are organized in four segments to facilitate staged lookup, where
91 * lower layer fields are first used to determine if the later fields need to
92 * be looked at. This enables better wildcarding for datapath flows.
94 * NOTE: Order of the fields is significant, any change in the order must be
95 * reflected in miniflow_extract()!
99 struct flow_tnl tunnel; /* Encapsulating tunnel parameters. */
100 ovs_be64 metadata; /* OpenFlow Metadata. */
101 uint32_t regs[FLOW_N_REGS]; /* Registers. */
102 uint32_t skb_priority; /* Packet priority for QoS. */
103 uint32_t pkt_mark; /* Packet mark. */
104 uint32_t dp_hash; /* Datapath computed hash value. The exact
105 * computation is opaque to the user space. */
106 union flow_in_port in_port; /* Input port.*/
107 uint32_t recirc_id; /* Must be exact match. */
108 ofp_port_t actset_output; /* Output port in action set. */
109 ovs_be16 pad1; /* Pad to 64 bits. */
111 /* L2, Order the same as in the Ethernet header! (64-bit aligned) */
112 uint8_t dl_dst[ETH_ADDR_LEN]; /* Ethernet destination address. */
113 uint8_t dl_src[ETH_ADDR_LEN]; /* Ethernet source address. */
114 ovs_be16 dl_type; /* Ethernet frame type. */
115 ovs_be16 vlan_tci; /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */
116 ovs_be32 mpls_lse[ROUND_UP(FLOW_MAX_MPLS_LABELS, 2)]; /* MPLS label stack
118 /* L3 (64-bit aligned) */
119 ovs_be32 nw_src; /* IPv4 source address. */
120 ovs_be32 nw_dst; /* IPv4 destination address. */
121 struct in6_addr ipv6_src; /* IPv6 source address. */
122 struct in6_addr ipv6_dst; /* IPv6 destination address. */
123 ovs_be32 ipv6_label; /* IPv6 flow label. */
124 uint8_t nw_frag; /* FLOW_FRAG_* flags. */
125 uint8_t nw_tos; /* IP ToS (including DSCP and ECN). */
126 uint8_t nw_ttl; /* IP TTL/Hop Limit. */
127 uint8_t nw_proto; /* IP protocol or low 8 bits of ARP opcode. */
128 struct in6_addr nd_target; /* IPv6 neighbor discovery (ND) target. */
129 uint8_t arp_sha[ETH_ADDR_LEN]; /* ARP/ND source hardware address. */
130 uint8_t arp_tha[ETH_ADDR_LEN]; /* ARP/ND target hardware address. */
131 ovs_be16 tcp_flags; /* TCP flags. With L3 to avoid matching L4. */
132 ovs_be16 pad2; /* Pad to 64 bits. */
134 /* L4 (64-bit aligned) */
135 ovs_be16 tp_src; /* TCP/UDP/SCTP source port. */
136 ovs_be16 tp_dst; /* TCP/UDP/SCTP destination port. */
137 ovs_be32 igmp_group_ip4; /* IGMP group IPv4 address.
138 * Keep last for BUILD_ASSERT_DECL below. */
140 BUILD_ASSERT_DECL(sizeof(struct flow) % sizeof(uint64_t) == 0);
142 #define FLOW_U64S (sizeof(struct flow) / sizeof(uint64_t))
144 /* Some flow fields are mutually exclusive or only appear within the flow
145 * pipeline. IPv6 headers are bigger than IPv4 and MPLS, and IPv6 ND packets
146 * are bigger than TCP,UDP and IGMP packets. */
147 #define FLOW_MAX_PACKET_U64S (FLOW_U64S \
148 /* Unused in datapath */ - FLOW_U64_SIZE(regs) \
149 - FLOW_U64_SIZE(metadata) \
150 /* L2.5/3 */ - FLOW_U64_SIZE(nw_src) /* incl. nw_dst */ \
151 - FLOW_U64_SIZE(mpls_lse) \
152 /* L4 */ - FLOW_U64_SIZE(tp_src) \
155 /* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */
156 BUILD_ASSERT_DECL(offsetof(struct flow, igmp_group_ip4) + sizeof(uint32_t)
157 == sizeof(struct flow_tnl) + 184
158 && FLOW_WC_SEQ == 29);
160 /* Incremental points at which flow classification may be performed in
162 * This is located here since this is dependent on the structure of the
163 * struct flow defined above:
164 * Each offset must be on a distinct, successive U64 boundary strictly
165 * within the struct flow. */
167 FLOW_SEGMENT_1_ENDS_AT = offsetof(struct flow, dl_dst),
168 FLOW_SEGMENT_2_ENDS_AT = offsetof(struct flow, nw_src),
169 FLOW_SEGMENT_3_ENDS_AT = offsetof(struct flow, tp_src),
171 BUILD_ASSERT_DECL(FLOW_SEGMENT_1_ENDS_AT % sizeof(uint64_t) == 0);
172 BUILD_ASSERT_DECL(FLOW_SEGMENT_2_ENDS_AT % sizeof(uint64_t) == 0);
173 BUILD_ASSERT_DECL(FLOW_SEGMENT_3_ENDS_AT % sizeof(uint64_t) == 0);
174 BUILD_ASSERT_DECL( 0 < FLOW_SEGMENT_1_ENDS_AT);
175 BUILD_ASSERT_DECL(FLOW_SEGMENT_1_ENDS_AT < FLOW_SEGMENT_2_ENDS_AT);
176 BUILD_ASSERT_DECL(FLOW_SEGMENT_2_ENDS_AT < FLOW_SEGMENT_3_ENDS_AT);
177 BUILD_ASSERT_DECL(FLOW_SEGMENT_3_ENDS_AT < sizeof(struct flow));
179 extern const uint8_t flow_segment_u64s[];
181 /* Represents the metadata fields of struct flow. */
182 struct flow_metadata {
183 uint32_t dp_hash; /* Datapath computed hash field. */
184 uint32_t recirc_id; /* Recirculation ID. */
185 ovs_be64 tun_id; /* Encapsulating tunnel ID. */
186 ovs_be32 tun_src; /* Tunnel outer IPv4 src addr */
187 ovs_be32 tun_dst; /* Tunnel outer IPv4 dst addr */
188 ovs_be64 metadata; /* OpenFlow 1.1+ metadata field. */
189 uint32_t regs[FLOW_N_REGS]; /* Registers. */
190 uint32_t pkt_mark; /* Packet mark. */
191 ofp_port_t in_port; /* OpenFlow port or zero. */
194 void flow_extract(struct ofpbuf *, const struct pkt_metadata *md,
197 void flow_zero_wildcards(struct flow *, const struct flow_wildcards *);
198 void flow_unwildcard_tp_ports(const struct flow *, struct flow_wildcards *);
199 void flow_get_metadata(const struct flow *, struct flow_metadata *);
201 char *flow_to_string(const struct flow *);
202 void format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t),
203 uint32_t flags, char del);
204 void format_flags_masked(struct ds *ds, const char *name,
205 const char *(*bit_to_string)(uint32_t),
206 uint32_t flags, uint32_t mask);
208 void flow_format(struct ds *, const struct flow *);
209 void flow_print(FILE *, const struct flow *);
210 static inline int flow_compare_3way(const struct flow *, const struct flow *);
211 static inline bool flow_equal(const struct flow *, const struct flow *);
212 static inline size_t flow_hash(const struct flow *, uint32_t basis);
214 void flow_set_dl_vlan(struct flow *, ovs_be16 vid);
215 void flow_set_vlan_vid(struct flow *, ovs_be16 vid);
216 void flow_set_vlan_pcp(struct flow *, uint8_t pcp);
218 int flow_count_mpls_labels(const struct flow *, struct flow_wildcards *);
219 int flow_count_common_mpls_labels(const struct flow *a, int an,
220 const struct flow *b, int bn,
221 struct flow_wildcards *wc);
222 void flow_push_mpls(struct flow *, int n, ovs_be16 mpls_eth_type,
223 struct flow_wildcards *);
224 bool flow_pop_mpls(struct flow *, int n, ovs_be16 eth_type,
225 struct flow_wildcards *);
226 void flow_set_mpls_label(struct flow *, int idx, ovs_be32 label);
227 void flow_set_mpls_ttl(struct flow *, int idx, uint8_t ttl);
228 void flow_set_mpls_tc(struct flow *, int idx, uint8_t tc);
229 void flow_set_mpls_bos(struct flow *, int idx, uint8_t stack);
230 void flow_set_mpls_lse(struct flow *, int idx, ovs_be32 lse);
232 void flow_compose(struct ofpbuf *, const struct flow *);
234 static inline uint64_t
235 flow_get_xreg(const struct flow *flow, int idx)
237 return ((uint64_t) flow->regs[idx * 2] << 32) | flow->regs[idx * 2 + 1];
241 flow_set_xreg(struct flow *flow, int idx, uint64_t value)
243 flow->regs[idx * 2] = value >> 32;
244 flow->regs[idx * 2 + 1] = value;
248 flow_compare_3way(const struct flow *a, const struct flow *b)
250 return memcmp(a, b, sizeof *a);
254 flow_equal(const struct flow *a, const struct flow *b)
256 return !flow_compare_3way(a, b);
260 flow_hash(const struct flow *flow, uint32_t basis)
262 return hash_words64((const uint64_t *)flow,
263 sizeof *flow / sizeof(uint64_t), basis);
266 static inline uint16_t
267 ofp_to_u16(ofp_port_t ofp_port)
269 return (OVS_FORCE uint16_t) ofp_port;
272 static inline uint32_t
273 odp_to_u32(odp_port_t odp_port)
275 return (OVS_FORCE uint32_t) odp_port;
278 static inline uint32_t
279 ofp11_to_u32(ofp11_port_t ofp11_port)
281 return (OVS_FORCE uint32_t) ofp11_port;
284 static inline ofp_port_t
285 u16_to_ofp(uint16_t port)
287 return OFP_PORT_C(port);
290 static inline odp_port_t
291 u32_to_odp(uint32_t port)
293 return ODP_PORT_C(port);
296 static inline ofp11_port_t
297 u32_to_ofp11(uint32_t port)
299 return OFP11_PORT_C(port);
302 static inline uint32_t
303 hash_ofp_port(ofp_port_t ofp_port)
305 return hash_int(ofp_to_u16(ofp_port), 0);
308 static inline uint32_t
309 hash_odp_port(odp_port_t odp_port)
311 return hash_int(odp_to_u32(odp_port), 0);
314 /* Wildcards for a flow.
316 * A 1-bit in each bit in 'masks' indicates that the corresponding bit of
317 * the flow is significant (must match). A 0-bit indicates that the
318 * corresponding bit of the flow is wildcarded (need not match). */
319 struct flow_wildcards {
323 #define WC_MASK_FIELD(WC, FIELD) \
324 memset(&(WC)->masks.FIELD, 0xff, sizeof (WC)->masks.FIELD)
325 #define WC_UNMASK_FIELD(WC, FIELD) \
326 memset(&(WC)->masks.FIELD, 0, sizeof (WC)->masks.FIELD)
328 void flow_wildcards_init_catchall(struct flow_wildcards *);
330 void flow_wildcards_init_for_packet(struct flow_wildcards *,
331 const struct flow *);
332 uint64_t flow_wc_map(const struct flow *);
334 void flow_wildcards_clear_non_packet_fields(struct flow_wildcards *);
336 bool flow_wildcards_is_catchall(const struct flow_wildcards *);
338 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
339 int idx, uint32_t mask);
340 void flow_wildcards_set_xreg_mask(struct flow_wildcards *,
341 int idx, uint64_t mask);
343 void flow_wildcards_and(struct flow_wildcards *dst,
344 const struct flow_wildcards *src1,
345 const struct flow_wildcards *src2);
346 void flow_wildcards_or(struct flow_wildcards *dst,
347 const struct flow_wildcards *src1,
348 const struct flow_wildcards *src2);
349 bool flow_wildcards_has_extra(const struct flow_wildcards *,
350 const struct flow_wildcards *);
351 uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis);
352 bool flow_wildcards_equal(const struct flow_wildcards *,
353 const struct flow_wildcards *);
354 uint32_t flow_hash_5tuple(const struct flow *flow, uint32_t basis);
355 uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
357 /* Initialize a flow with random fields that matter for nx_hash_fields. */
358 void flow_random_hash_fields(struct flow *);
359 void flow_mask_hash_fields(const struct flow *, struct flow_wildcards *,
360 enum nx_hash_fields);
361 uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields,
363 const char *flow_hash_fields_to_str(enum nx_hash_fields);
364 bool flow_hash_fields_valid(enum nx_hash_fields);
366 uint32_t flow_hash_in_wildcards(const struct flow *,
367 const struct flow_wildcards *,
370 bool flow_equal_except(const struct flow *a, const struct flow *b,
371 const struct flow_wildcards *);
373 /* Compressed flow. */
375 /* Number of 64-bit words present in struct miniflow. */
376 #define MINI_N_INLINE 4
378 /* Maximum number of 64-bit words supported. */
379 BUILD_ASSERT_DECL(FLOW_U64S <= 63);
381 /* A sparse representation of a "struct flow".
383 * A "struct flow" is fairly large and tends to be mostly zeros. Sparse
384 * representation has two advantages. First, it saves memory. Second, it
385 * saves time when the goal is to iterate over only the nonzero parts of the
388 * The 'map' member holds one bit for each uint64_t in a "struct flow". Each
389 * 0-bit indicates that the corresponding uint64_t is zero, each 1-bit that it
390 * *may* be nonzero (see below how this applies to minimasks).
392 * The 'values_inline' boolean member indicates that the values are at
393 * 'inline_values'. If 'values_inline' is zero, then the values are
394 * offline at 'offline_values'. In either case, values is an array that has
395 * one element for each 1-bit in 'map'. The least-numbered 1-bit is in
396 * the first element of the values array, the next 1-bit is in the next array
397 * element, and so on.
399 * MINI_N_INLINE is the default number of inline words. When a miniflow is
400 * dynamically allocated the actual amount of inline storage may be different.
401 * In that case 'inline_values' contains storage at least for the number
402 * of words indicated by 'map' (one uint64_t for each 1-bit in the map).
404 * Elements in values array are allowed to be zero. This is useful for "struct
405 * minimatch", for which ensuring that the miniflow and minimask members have
406 * same 'map' allows optimization. This allowance applies only to a miniflow
407 * that is not a mask. That is, a minimask may NOT have zero elements in
412 uint64_t values_inline:1;
414 uint64_t *offline_values;
415 uint64_t inline_values[MINI_N_INLINE]; /* Minimum inline size. */
418 BUILD_ASSERT_DECL(sizeof(struct miniflow)
419 == sizeof(uint64_t) + MINI_N_INLINE * sizeof(uint64_t));
421 #define MINIFLOW_VALUES_SIZE(COUNT) ((COUNT) * sizeof(uint64_t))
423 static inline uint64_t *miniflow_values(struct miniflow *mf)
425 return OVS_LIKELY(mf->values_inline)
426 ? mf->inline_values : mf->offline_values;
429 static inline const uint64_t *miniflow_get_values(const struct miniflow *mf)
431 return OVS_LIKELY(mf->values_inline)
432 ? mf->inline_values : mf->offline_values;
435 /* This is useful for initializing a miniflow for a miniflow_extract() call. */
436 static inline void miniflow_initialize(struct miniflow *mf,
437 uint64_t buf[FLOW_U64S])
440 mf->values_inline = (buf == (uint64_t *)(mf + 1));
441 if (!mf->values_inline) {
442 mf->offline_values = buf;
448 /* The 'dst->values' must be initialized with a buffer with space for
449 * FLOW_U64S. 'dst->map' is ignored on input and set on output to
450 * indicate which fields were extracted. */
451 void miniflow_extract(struct ofpbuf *packet, const struct pkt_metadata *,
452 struct miniflow *dst);
453 void miniflow_init(struct miniflow *, const struct flow *);
454 void miniflow_init_with_minimask(struct miniflow *, const struct flow *,
455 const struct minimask *);
456 void miniflow_clone(struct miniflow *, const struct miniflow *);
457 void miniflow_clone_inline(struct miniflow *, const struct miniflow *,
459 void miniflow_move(struct miniflow *dst, struct miniflow *);
460 void miniflow_destroy(struct miniflow *);
462 void miniflow_expand(const struct miniflow *, struct flow *);
464 static inline uint64_t flow_u64_value(const struct flow *flow, size_t index)
466 return ((uint64_t *)(flow))[index];
469 static inline uint64_t *flow_u64_lvalue(struct flow *flow, size_t index)
471 return &((uint64_t *)(flow))[index];
475 flow_get_next_in_map(const struct flow *flow, uint64_t map, uint64_t *value)
478 *value = flow_u64_value(flow, raw_ctz(map));
484 /* Iterate through all flow u64 values specified by 'MAP'. */
485 #define FLOW_FOR_EACH_IN_MAP(VALUE, FLOW, MAP) \
486 for (uint64_t map__ = (MAP); \
487 flow_get_next_in_map(FLOW, map__, &(VALUE)); \
488 map__ = zero_rightmost_1bit(map__))
490 /* Iterate through all struct flow u64 indices specified by 'MAP'. */
491 #define MAP_FOR_EACH_INDEX(U64IDX, MAP) \
492 for (uint64_t map__ = (MAP); \
493 map__ && ((U64IDX) = raw_ctz(map__), true); \
494 map__ = zero_rightmost_1bit(map__))
496 #define FLOW_U64_SIZE(FIELD) \
497 DIV_ROUND_UP(sizeof(((struct flow *)0)->FIELD), sizeof(uint64_t))
499 #define MINIFLOW_MAP(FIELD) \
500 (((UINT64_C(1) << FLOW_U64_SIZE(FIELD)) - 1) \
501 << (offsetof(struct flow, FIELD) / sizeof(uint64_t)))
503 struct mf_for_each_in_map_aux {
504 const uint64_t *values;
510 mf_get_next_in_map(struct mf_for_each_in_map_aux *aux, uint64_t *value)
513 uint64_t rm1bit = rightmost_1bit(aux->map);
516 if (aux->fmap & rm1bit) {
517 /* Advance 'aux->values' to point to the value for 'rm1bit'. */
518 uint64_t trash = aux->fmap & (rm1bit - 1);
521 aux->values += count_1bits(trash);
524 /* Retrieve the value for 'rm1bit' then advance past it. */
526 *value = *aux->values++;
536 /* Iterate through all miniflow u64 values specified by 'MAP'. */
537 #define MINIFLOW_FOR_EACH_IN_MAP(VALUE, FLOW, MAP) \
538 for (struct mf_for_each_in_map_aux aux__ \
539 = { miniflow_get_values(FLOW), (FLOW)->map, MAP }; \
540 mf_get_next_in_map(&aux__, &(VALUE)); \
543 /* This can be used when it is known that 'u64_idx' is set in 'map'. */
544 static inline uint64_t
545 miniflow_values_get__(const uint64_t *values, uint64_t map, int u64_idx)
547 return values[count_1bits(map & ((UINT64_C(1) << u64_idx) - 1))];
550 /* This can be used when it is known that 'u64_idx' is set in
551 * the map of 'mf'. */
552 static inline uint64_t
553 miniflow_get__(const struct miniflow *mf, int u64_idx)
555 return miniflow_values_get__(miniflow_get_values(mf), mf->map, u64_idx);
558 /* Get the value of 'FIELD' of an up to 8 byte wide integer type 'TYPE' of
560 #define MINIFLOW_GET_TYPE(MF, TYPE, OFS) \
561 (((MF)->map & (UINT64_C(1) << (OFS) / sizeof(uint64_t))) \
562 ? ((OVS_FORCE const TYPE *) \
563 (miniflow_get_values(MF) \
564 + count_1bits((MF)->map & \
565 ((UINT64_C(1) << (OFS) / sizeof(uint64_t)) - 1)))) \
566 [(OFS) % sizeof(uint64_t) / sizeof(TYPE)] \
569 #define MINIFLOW_GET_U8(FLOW, FIELD) \
570 MINIFLOW_GET_TYPE(FLOW, uint8_t, offsetof(struct flow, FIELD))
571 #define MINIFLOW_GET_U16(FLOW, FIELD) \
572 MINIFLOW_GET_TYPE(FLOW, uint16_t, offsetof(struct flow, FIELD))
573 #define MINIFLOW_GET_BE16(FLOW, FIELD) \
574 MINIFLOW_GET_TYPE(FLOW, ovs_be16, offsetof(struct flow, FIELD))
575 #define MINIFLOW_GET_U32(FLOW, FIELD) \
576 MINIFLOW_GET_TYPE(FLOW, uint32_t, offsetof(struct flow, FIELD))
577 #define MINIFLOW_GET_BE32(FLOW, FIELD) \
578 MINIFLOW_GET_TYPE(FLOW, ovs_be32, offsetof(struct flow, FIELD))
579 #define MINIFLOW_GET_U64(FLOW, FIELD) \
580 MINIFLOW_GET_TYPE(FLOW, uint64_t, offsetof(struct flow, FIELD))
581 #define MINIFLOW_GET_BE64(FLOW, FIELD) \
582 MINIFLOW_GET_TYPE(FLOW, ovs_be64, offsetof(struct flow, FIELD))
584 static inline uint64_t miniflow_get(const struct miniflow *,
585 unsigned int u64_ofs);
586 static inline uint32_t miniflow_get_u32(const struct miniflow *,
587 unsigned int u32_ofs);
588 static inline ovs_be32 miniflow_get_be32(const struct miniflow *,
589 unsigned int be32_ofs);
590 static inline uint16_t miniflow_get_vid(const struct miniflow *);
591 static inline uint16_t miniflow_get_tcp_flags(const struct miniflow *);
592 static inline ovs_be64 miniflow_get_metadata(const struct miniflow *);
594 bool miniflow_equal(const struct miniflow *a, const struct miniflow *b);
595 bool miniflow_equal_in_minimask(const struct miniflow *a,
596 const struct miniflow *b,
597 const struct minimask *);
598 bool miniflow_equal_flow_in_minimask(const struct miniflow *a,
599 const struct flow *b,
600 const struct minimask *);
601 uint32_t miniflow_hash_5tuple(const struct miniflow *flow, uint32_t basis);
604 /* Compressed flow wildcards. */
606 /* A sparse representation of a "struct flow_wildcards".
608 * See the large comment on struct miniflow for details.
610 * Note: While miniflow can have zero data for a 1-bit in the map,
611 * a minimask may not! We rely on this in the implementation. */
613 struct miniflow masks;
616 void minimask_init(struct minimask *, const struct flow_wildcards *);
617 void minimask_clone(struct minimask *, const struct minimask *);
618 void minimask_move(struct minimask *dst, struct minimask *src);
619 void minimask_combine(struct minimask *dst,
620 const struct minimask *a, const struct minimask *b,
621 uint64_t storage[FLOW_U64S]);
622 void minimask_destroy(struct minimask *);
624 void minimask_expand(const struct minimask *, struct flow_wildcards *);
626 static inline uint32_t minimask_get_u32(const struct minimask *,
627 unsigned int u32_ofs);
628 static inline ovs_be32 minimask_get_be32(const struct minimask *,
629 unsigned int be32_ofs);
630 static inline uint16_t minimask_get_vid_mask(const struct minimask *);
631 static inline ovs_be64 minimask_get_metadata_mask(const struct minimask *);
633 bool minimask_equal(const struct minimask *a, const struct minimask *b);
634 bool minimask_has_extra(const struct minimask *, const struct minimask *);
637 /* Returns true if 'mask' matches every packet, false if 'mask' fixes any bits
640 minimask_is_catchall(const struct minimask *mask)
642 /* For every 1-bit in mask's map, the corresponding value is non-zero,
643 * so the only way the mask can not fix any bits or fields is for the
644 * map the be zero. */
645 return mask->masks.map == 0;
648 /* Returns the uint64_t that would be at byte offset '8 * u64_ofs' if 'flow'
649 * were expanded into a "struct flow". */
650 static inline uint64_t miniflow_get(const struct miniflow *flow,
651 unsigned int u64_ofs)
653 return flow->map & (UINT64_C(1) << u64_ofs)
654 ? miniflow_get__(flow, u64_ofs) : 0;
657 static inline uint32_t miniflow_get_u32(const struct miniflow *flow,
658 unsigned int u32_ofs)
660 uint64_t value = miniflow_get(flow, u32_ofs / 2);
663 return (u32_ofs & 1) ? value : value >> 32;
665 return (u32_ofs & 1) ? value >> 32 : value;
669 static inline ovs_be32 miniflow_get_be32(const struct miniflow *flow,
670 unsigned int be32_ofs)
672 return (OVS_FORCE ovs_be32)miniflow_get_u32(flow, be32_ofs);
675 /* Returns the VID within the vlan_tci member of the "struct flow" represented
677 static inline uint16_t
678 miniflow_get_vid(const struct miniflow *flow)
680 ovs_be16 tci = MINIFLOW_GET_BE16(flow, vlan_tci);
681 return vlan_tci_to_vid(tci);
684 /* Returns the uint32_t that would be at byte offset '4 * u32_ofs' if 'mask'
685 * were expanded into a "struct flow_wildcards". */
686 static inline uint32_t
687 minimask_get_u32(const struct minimask *mask, unsigned int u32_ofs)
689 return miniflow_get_u32(&mask->masks, u32_ofs);
692 static inline ovs_be32
693 minimask_get_be32(const struct minimask *mask, unsigned int be32_ofs)
695 return (OVS_FORCE ovs_be32)minimask_get_u32(mask, be32_ofs);
698 /* Returns the VID mask within the vlan_tci member of the "struct
699 * flow_wildcards" represented by 'mask'. */
700 static inline uint16_t
701 minimask_get_vid_mask(const struct minimask *mask)
703 return miniflow_get_vid(&mask->masks);
706 /* Returns the value of the "tcp_flags" field in 'flow'. */
707 static inline uint16_t
708 miniflow_get_tcp_flags(const struct miniflow *flow)
710 return ntohs(MINIFLOW_GET_BE16(flow, tcp_flags));
713 /* Returns the value of the OpenFlow 1.1+ "metadata" field in 'flow'. */
714 static inline ovs_be64
715 miniflow_get_metadata(const struct miniflow *flow)
717 return MINIFLOW_GET_BE64(flow, metadata);
720 /* Returns the mask for the OpenFlow 1.1+ "metadata" field in 'mask'.
722 * The return value is all-1-bits if 'mask' matches on the whole value of the
723 * metadata field, all-0-bits if 'mask' entirely wildcards the metadata field,
724 * or some other value if the metadata field is partially matched, partially
726 static inline ovs_be64
727 minimask_get_metadata_mask(const struct minimask *mask)
729 return MINIFLOW_GET_BE64(&mask->masks, metadata);
732 /* Perform a bitwise OR of miniflow 'src' flow data with the equivalent
733 * fields in 'dst', storing the result in 'dst'. */
735 flow_union_with_miniflow(struct flow *dst, const struct miniflow *src)
737 uint64_t *dst_u64 = (uint64_t *) dst;
738 const uint64_t *p = miniflow_get_values(src);
741 MAP_FOR_EACH_INDEX(idx, src->map) {
742 dst_u64[idx] |= *p++;
746 static inline struct pkt_metadata
747 pkt_metadata_from_flow(const struct flow *flow)
749 struct pkt_metadata md;
751 md.recirc_id = flow->recirc_id;
752 md.dp_hash = flow->dp_hash;
753 md.tunnel = flow->tunnel;
754 md.skb_priority = flow->skb_priority;
755 md.pkt_mark = flow->pkt_mark;
756 md.in_port = flow->in_port;
761 static inline bool is_ip_any(const struct flow *flow)
763 return dl_type_is_ip_any(flow->dl_type);
766 static inline bool is_icmpv4(const struct flow *flow)
768 return (flow->dl_type == htons(ETH_TYPE_IP)
769 && flow->nw_proto == IPPROTO_ICMP);
772 static inline bool is_icmpv6(const struct flow *flow)
774 return (flow->dl_type == htons(ETH_TYPE_IPV6)
775 && flow->nw_proto == IPPROTO_ICMPV6);
778 static inline bool is_stp(const struct flow *flow)
780 return (eth_addr_equals(flow->dl_dst, eth_addr_stp)
781 && flow->dl_type == htons(FLOW_DL_TYPE_NONE));