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-linux, dpif-netdev), it is instead
87 * 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 /* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */
142 BUILD_ASSERT_DECL(offsetof(struct flow, dp_hash) + sizeof(uint32_t)
143 == sizeof(struct flow_tnl) + 176
144 && FLOW_WC_SEQ == 27);
146 /* Incremental points at which flow classification may be performed in
148 * This is located here since this is dependent on the structure of the
149 * struct flow defined above:
150 * Each offset must be on a distinct, successive U32 boundary strictly
151 * within the struct flow. */
153 FLOW_SEGMENT_1_ENDS_AT = offsetof(struct flow, dl_dst),
154 FLOW_SEGMENT_2_ENDS_AT = offsetof(struct flow, ipv6_src),
155 FLOW_SEGMENT_3_ENDS_AT = offsetof(struct flow, tp_src),
157 BUILD_ASSERT_DECL(FLOW_SEGMENT_1_ENDS_AT % 4 == 0);
158 BUILD_ASSERT_DECL(FLOW_SEGMENT_2_ENDS_AT % 4 == 0);
159 BUILD_ASSERT_DECL(FLOW_SEGMENT_3_ENDS_AT % 4 == 0);
160 BUILD_ASSERT_DECL( 0 < FLOW_SEGMENT_1_ENDS_AT);
161 BUILD_ASSERT_DECL(FLOW_SEGMENT_1_ENDS_AT < FLOW_SEGMENT_2_ENDS_AT);
162 BUILD_ASSERT_DECL(FLOW_SEGMENT_2_ENDS_AT < FLOW_SEGMENT_3_ENDS_AT);
163 BUILD_ASSERT_DECL(FLOW_SEGMENT_3_ENDS_AT < sizeof(struct flow));
165 extern const uint8_t flow_segment_u32s[];
167 /* Represents the metadata fields of struct flow. */
168 struct flow_metadata {
169 uint32_t dp_hash; /* Datapath computed hash field. */
170 uint32_t recirc_id; /* Recirculation ID. */
171 ovs_be64 tun_id; /* Encapsulating tunnel ID. */
172 ovs_be32 tun_src; /* Tunnel outer IPv4 src addr */
173 ovs_be32 tun_dst; /* Tunnel outer IPv4 dst addr */
174 ovs_be64 metadata; /* OpenFlow 1.1+ metadata field. */
175 uint32_t regs[FLOW_N_REGS]; /* Registers. */
176 uint32_t pkt_mark; /* Packet mark. */
177 ofp_port_t in_port; /* OpenFlow port or zero. */
180 void flow_extract(struct ofpbuf *, const struct pkt_metadata *md,
183 void flow_zero_wildcards(struct flow *, const struct flow_wildcards *);
184 void flow_unwildcard_tp_ports(const struct flow *, struct flow_wildcards *);
185 void flow_get_metadata(const struct flow *, struct flow_metadata *);
187 char *flow_to_string(const struct flow *);
188 void format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t),
189 uint32_t flags, char del);
190 void format_flags_masked(struct ds *ds, const char *name,
191 const char *(*bit_to_string)(uint32_t),
192 uint32_t flags, uint32_t mask);
194 void flow_format(struct ds *, const struct flow *);
195 void flow_print(FILE *, const struct flow *);
196 static inline int flow_compare_3way(const struct flow *, const struct flow *);
197 static inline bool flow_equal(const struct flow *, const struct flow *);
198 static inline size_t flow_hash(const struct flow *, uint32_t basis);
200 void flow_set_dl_vlan(struct flow *, ovs_be16 vid);
201 void flow_set_vlan_vid(struct flow *, ovs_be16 vid);
202 void flow_set_vlan_pcp(struct flow *, uint8_t pcp);
204 int flow_count_mpls_labels(const struct flow *, struct flow_wildcards *);
205 int flow_count_common_mpls_labels(const struct flow *a, int an,
206 const struct flow *b, int bn,
207 struct flow_wildcards *wc);
208 void flow_push_mpls(struct flow *, int n, ovs_be16 mpls_eth_type,
209 struct flow_wildcards *);
210 bool flow_pop_mpls(struct flow *, int n, ovs_be16 eth_type,
211 struct flow_wildcards *);
212 void flow_set_mpls_label(struct flow *, int idx, ovs_be32 label);
213 void flow_set_mpls_ttl(struct flow *, int idx, uint8_t ttl);
214 void flow_set_mpls_tc(struct flow *, int idx, uint8_t tc);
215 void flow_set_mpls_bos(struct flow *, int idx, uint8_t stack);
216 void flow_set_mpls_lse(struct flow *, int idx, ovs_be32 lse);
218 void flow_compose(struct ofpbuf *, const struct flow *);
220 static inline uint64_t
221 flow_get_xreg(const struct flow *flow, int idx)
223 return ((uint64_t) flow->regs[idx * 2] << 32) | flow->regs[idx * 2 + 1];
227 flow_set_xreg(struct flow *flow, int idx, uint64_t value)
229 flow->regs[idx * 2] = value >> 32;
230 flow->regs[idx * 2 + 1] = value;
234 flow_compare_3way(const struct flow *a, const struct flow *b)
236 return memcmp(a, b, sizeof *a);
240 flow_equal(const struct flow *a, const struct flow *b)
242 return !flow_compare_3way(a, b);
246 flow_hash(const struct flow *flow, uint32_t basis)
248 return hash_words((const uint32_t *) flow, sizeof *flow / 4, basis);
251 static inline uint16_t
252 ofp_to_u16(ofp_port_t ofp_port)
254 return (OVS_FORCE uint16_t) ofp_port;
257 static inline uint32_t
258 odp_to_u32(odp_port_t odp_port)
260 return (OVS_FORCE uint32_t) odp_port;
263 static inline uint32_t
264 ofp11_to_u32(ofp11_port_t ofp11_port)
266 return (OVS_FORCE uint32_t) ofp11_port;
269 static inline ofp_port_t
270 u16_to_ofp(uint16_t port)
272 return OFP_PORT_C(port);
275 static inline odp_port_t
276 u32_to_odp(uint32_t port)
278 return ODP_PORT_C(port);
281 static inline ofp11_port_t
282 u32_to_ofp11(uint32_t port)
284 return OFP11_PORT_C(port);
287 static inline uint32_t
288 hash_ofp_port(ofp_port_t ofp_port)
290 return hash_int(ofp_to_u16(ofp_port), 0);
293 static inline uint32_t
294 hash_odp_port(odp_port_t odp_port)
296 return hash_int(odp_to_u32(odp_port), 0);
299 /* Wildcards for a flow.
301 * A 1-bit in each bit in 'masks' indicates that the corresponding bit of
302 * the flow is significant (must match). A 0-bit indicates that the
303 * corresponding bit of the flow is wildcarded (need not match). */
304 struct flow_wildcards {
308 void flow_wildcards_init_catchall(struct flow_wildcards *);
310 void flow_wildcards_clear_non_packet_fields(struct flow_wildcards *);
312 bool flow_wildcards_is_catchall(const struct flow_wildcards *);
314 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
315 int idx, uint32_t mask);
316 void flow_wildcards_set_xreg_mask(struct flow_wildcards *,
317 int idx, uint64_t mask);
319 void flow_wildcards_and(struct flow_wildcards *dst,
320 const struct flow_wildcards *src1,
321 const struct flow_wildcards *src2);
322 void flow_wildcards_or(struct flow_wildcards *dst,
323 const struct flow_wildcards *src1,
324 const struct flow_wildcards *src2);
325 bool flow_wildcards_has_extra(const struct flow_wildcards *,
326 const struct flow_wildcards *);
327 uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis);
328 bool flow_wildcards_equal(const struct flow_wildcards *,
329 const struct flow_wildcards *);
330 uint32_t flow_hash_5tuple(const struct flow *flow, uint32_t basis);
331 uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
333 /* Initialize a flow with random fields that matter for nx_hash_fields. */
334 void flow_random_hash_fields(struct flow *);
335 void flow_mask_hash_fields(const struct flow *, struct flow_wildcards *,
336 enum nx_hash_fields);
337 uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields,
339 const char *flow_hash_fields_to_str(enum nx_hash_fields);
340 bool flow_hash_fields_valid(enum nx_hash_fields);
342 uint32_t flow_hash_in_wildcards(const struct flow *,
343 const struct flow_wildcards *,
346 bool flow_equal_except(const struct flow *a, const struct flow *b,
347 const struct flow_wildcards *);
349 /* Compressed flow. */
351 /* Number of 32-bit words present in struct miniflow. */
352 #define MINI_N_INLINE 8
354 /* Maximum number of 32-bit words supported. */
355 BUILD_ASSERT_DECL(FLOW_U32S <= 63);
357 /* A sparse representation of a "struct flow".
359 * A "struct flow" is fairly large and tends to be mostly zeros. Sparse
360 * representation has two advantages. First, it saves memory. Second, it
361 * saves time when the goal is to iterate over only the nonzero parts of the
364 * The 'map' member holds one bit for each uint32_t in a "struct flow". Each
365 * 0-bit indicates that the corresponding uint32_t is zero, each 1-bit that it
366 * *may* be nonzero (see below how this applies to minimasks).
368 * The 'values_inline' boolean member indicates that the values are at
369 * 'inline_values'. If 'values_inline' is zero, then the values are
370 * offline at 'offline_values'. In either case, values is an array that has
371 * one element for each 1-bit in 'map'. The least-numbered 1-bit is in
372 * the first element of the values array, the next 1-bit is in the next array
373 * element, and so on.
375 * MINI_N_INLINE is the default number of inline words. When a miniflow is
376 * dynamically allocated the actual amount of inline storage may be different.
377 * In that case 'inline_values' contains storage at least for the number
378 * of words indicated by 'map' (one uint32_t for each 1-bit in the map).
380 * Elements in values array are allowed to be zero. This is useful for "struct
381 * minimatch", for which ensuring that the miniflow and minimask members have
382 * same 'map' allows optimization. This allowance applies only to a miniflow
383 * that is not a mask. That is, a minimask may NOT have zero elements in
388 uint64_t values_inline:1;
390 uint32_t *offline_values;
391 uint32_t inline_values[MINI_N_INLINE]; /* Minimum inline size. */
394 BUILD_ASSERT_DECL(sizeof(struct miniflow)
395 == sizeof(uint64_t) + MINI_N_INLINE * sizeof(uint32_t));
397 #define MINIFLOW_VALUES_SIZE(COUNT) ((COUNT) * sizeof(uint32_t))
399 static inline uint32_t *miniflow_values(struct miniflow *mf)
401 return OVS_LIKELY(mf->values_inline)
402 ? mf->inline_values : mf->offline_values;
405 static inline const uint32_t *miniflow_get_values(const struct miniflow *mf)
407 return OVS_LIKELY(mf->values_inline)
408 ? mf->inline_values : mf->offline_values;
411 static inline const uint32_t *miniflow_get_u32_values(const struct miniflow *mf)
413 return miniflow_get_values(mf);
416 static inline const ovs_be32 *miniflow_get_be32_values(const struct miniflow *mf)
418 return (OVS_FORCE const ovs_be32 *)miniflow_get_values(mf);
421 /* This is useful for initializing a miniflow for a miniflow_extract() call. */
422 static inline void miniflow_initialize(struct miniflow *mf,
423 uint32_t buf[FLOW_U32S])
426 mf->values_inline = (buf == (uint32_t *)(mf + 1));
427 if (!mf->values_inline) {
428 mf->offline_values = buf;
434 /* The 'dst->values' must be initialized with a buffer with space for
435 * FLOW_U32S. 'dst->map' is ignored on input and set on output to
436 * indicate which fields were extracted. */
437 void miniflow_extract(struct ofpbuf *packet, const struct pkt_metadata *,
438 struct miniflow *dst);
439 void miniflow_init(struct miniflow *, const struct flow *);
440 void miniflow_init_with_minimask(struct miniflow *, const struct flow *,
441 const struct minimask *);
442 void miniflow_clone(struct miniflow *, const struct miniflow *);
443 void miniflow_clone_inline(struct miniflow *, const struct miniflow *,
445 void miniflow_move(struct miniflow *dst, struct miniflow *);
446 void miniflow_destroy(struct miniflow *);
448 void miniflow_expand(const struct miniflow *, struct flow *);
450 static inline uint32_t flow_u32_value(const struct flow *flow, size_t index)
452 return ((uint32_t *)(flow))[index];
455 static inline uint32_t *flow_u32_lvalue(struct flow *flow, size_t index)
457 return &((uint32_t *)(flow))[index];
461 flow_get_next_in_map(const struct flow *flow, uint64_t map, uint32_t *value)
464 *value = flow_u32_value(flow, raw_ctz(map));
470 /* Iterate through all flow u32 values specified by 'MAP'. */
471 #define FLOW_FOR_EACH_IN_MAP(VALUE, FLOW, MAP) \
472 for (uint64_t map__ = (MAP); \
473 flow_get_next_in_map(FLOW, map__, &(VALUE)); \
474 map__ = zero_rightmost_1bit(map__))
476 /* Iterate through all struct flow u32 indices specified by 'MAP'. */
477 #define MAP_FOR_EACH_INDEX(U32IDX, MAP) \
478 for (uint64_t map__ = (MAP); \
479 ((U32IDX) = ctz64(map__)) < FLOW_U32S; \
480 map__ = zero_rightmost_1bit(map__))
482 #define FLOW_U32_SIZE(FIELD) \
483 DIV_ROUND_UP(sizeof(((struct flow *)0)->FIELD), sizeof(uint32_t))
485 #define MINIFLOW_MAP(FIELD) \
486 (((UINT64_C(1) << FLOW_U32_SIZE(FIELD)) - 1) \
487 << (offsetof(struct flow, FIELD) / 4))
489 static inline uint32_t
490 mf_get_next_in_map(uint64_t *fmap, uint64_t rm1bit, const uint32_t **fp,
494 if (*fmap & rm1bit) {
495 uint64_t trash = *fmap & (rm1bit - 1);
499 *fp += count_1bits(trash);
506 /* Iterate through all miniflow u32 values specified by 'MAP'.
507 * This works as the first statement in a block.*/
508 #define MINIFLOW_FOR_EACH_IN_MAP(VALUE, FLOW, MAP) \
509 const uint32_t *fp_ = miniflow_get_u32_values(FLOW); \
510 uint64_t rm1bit_, fmap_, map_; \
511 for (fmap_ = (FLOW)->map, map_ = (MAP), rm1bit_ = rightmost_1bit(map_); \
512 mf_get_next_in_map(&fmap_, rm1bit_, &fp_, &(VALUE)); \
513 map_ -= rm1bit_, rm1bit_ = rightmost_1bit(map_))
515 /* Get the value of 'FIELD' of an up to 4 byte wide integer type 'TYPE' of
517 #define MINIFLOW_GET_TYPE(MF, TYPE, OFS) \
518 (((MF)->map & (UINT64_C(1) << (OFS) / 4)) \
519 ? ((OVS_FORCE const TYPE *) \
520 (miniflow_get_u32_values(MF) \
521 + count_1bits((MF)->map & ((UINT64_C(1) << (OFS) / 4) - 1)))) \
522 [(OFS) % 4 / sizeof(TYPE)] \
525 #define MINIFLOW_GET_U8(FLOW, FIELD) \
526 MINIFLOW_GET_TYPE(FLOW, uint8_t, offsetof(struct flow, FIELD))
527 #define MINIFLOW_GET_U16(FLOW, FIELD) \
528 MINIFLOW_GET_TYPE(FLOW, uint16_t, offsetof(struct flow, FIELD))
529 #define MINIFLOW_GET_BE16(FLOW, FIELD) \
530 MINIFLOW_GET_TYPE(FLOW, ovs_be16, offsetof(struct flow, FIELD))
531 #define MINIFLOW_GET_U32(FLOW, FIELD) \
532 MINIFLOW_GET_TYPE(FLOW, uint32_t, offsetof(struct flow, FIELD))
533 #define MINIFLOW_GET_BE32(FLOW, FIELD) \
534 MINIFLOW_GET_TYPE(FLOW, ovs_be32, offsetof(struct flow, FIELD))
536 static inline uint16_t miniflow_get_vid(const struct miniflow *);
537 static inline uint16_t miniflow_get_tcp_flags(const struct miniflow *);
538 static inline ovs_be64 miniflow_get_metadata(const struct miniflow *);
540 bool miniflow_equal(const struct miniflow *a, const struct miniflow *b);
541 bool miniflow_equal_in_minimask(const struct miniflow *a,
542 const struct miniflow *b,
543 const struct minimask *);
544 bool miniflow_equal_flow_in_minimask(const struct miniflow *a,
545 const struct flow *b,
546 const struct minimask *);
547 uint32_t miniflow_hash_5tuple(const struct miniflow *flow, uint32_t basis);
550 /* Compressed flow wildcards. */
552 /* A sparse representation of a "struct flow_wildcards".
554 * See the large comment on struct miniflow for details.
556 * Note: While miniflow can have zero data for a 1-bit in the map,
557 * a minimask may not! We rely on this in the implementation. */
559 struct miniflow masks;
562 void minimask_init(struct minimask *, const struct flow_wildcards *);
563 void minimask_clone(struct minimask *, const struct minimask *);
564 void minimask_move(struct minimask *dst, struct minimask *src);
565 void minimask_combine(struct minimask *dst,
566 const struct minimask *a, const struct minimask *b,
567 uint32_t storage[FLOW_U32S]);
568 void minimask_destroy(struct minimask *);
570 void minimask_expand(const struct minimask *, struct flow_wildcards *);
572 uint32_t minimask_get(const struct minimask *, unsigned int u32_ofs);
573 static inline uint16_t minimask_get_vid_mask(const struct minimask *);
574 static inline ovs_be64 minimask_get_metadata_mask(const struct minimask *);
576 bool minimask_equal(const struct minimask *a, const struct minimask *b);
577 bool minimask_has_extra(const struct minimask *, const struct minimask *);
580 /* Returns true if 'mask' matches every packet, false if 'mask' fixes any bits
583 minimask_is_catchall(const struct minimask *mask)
585 /* For every 1-bit in mask's map, the corresponding value is non-zero,
586 * so the only way the mask can not fix any bits or fields is for the
587 * map the be zero. */
588 return mask->masks.map == 0;
591 /* Returns the VID within the vlan_tci member of the "struct flow" represented
593 static inline uint16_t
594 miniflow_get_vid(const struct miniflow *flow)
596 ovs_be16 tci = MINIFLOW_GET_BE16(flow, vlan_tci);
597 return vlan_tci_to_vid(tci);
600 /* Returns the VID mask within the vlan_tci member of the "struct
601 * flow_wildcards" represented by 'mask'. */
602 static inline uint16_t
603 minimask_get_vid_mask(const struct minimask *mask)
605 return miniflow_get_vid(&mask->masks);
608 /* Returns the value of the "tcp_flags" field in 'flow'. */
609 static inline uint16_t
610 miniflow_get_tcp_flags(const struct miniflow *flow)
612 return ntohs(MINIFLOW_GET_BE16(flow, tcp_flags));
615 /* Returns the value of the OpenFlow 1.1+ "metadata" field in 'flow'. */
616 static inline ovs_be64
617 miniflow_get_metadata(const struct miniflow *flow)
627 enum { MD_OFS = offsetof(struct flow, metadata) };
628 BUILD_ASSERT_DECL(MD_OFS % sizeof(uint32_t) == 0);
629 value.hi = MINIFLOW_GET_TYPE(flow, ovs_be32, MD_OFS);
630 value.lo = MINIFLOW_GET_TYPE(flow, ovs_be32, MD_OFS + 4);
635 /* Returns the mask for the OpenFlow 1.1+ "metadata" field in 'mask'.
637 * The return value is all-1-bits if 'mask' matches on the whole value of the
638 * metadata field, all-0-bits if 'mask' entirely wildcards the metadata field,
639 * or some other value if the metadata field is partially matched, partially
641 static inline ovs_be64
642 minimask_get_metadata_mask(const struct minimask *mask)
644 return miniflow_get_metadata(&mask->masks);
647 /* Perform a bitwise OR of miniflow 'src' flow data with the equivalent
648 * fields in 'dst', storing the result in 'dst'. */
650 flow_union_with_miniflow(struct flow *dst, const struct miniflow *src)
652 uint32_t *dst_u32 = (uint32_t *) dst;
653 const uint32_t *p = miniflow_get_u32_values(src);
656 for (map = src->map; map; map = zero_rightmost_1bit(map)) {
657 dst_u32[raw_ctz(map)] |= *p++;
661 static inline struct pkt_metadata
662 pkt_metadata_from_flow(const struct flow *flow)
664 struct pkt_metadata md;
666 md.recirc_id = flow->recirc_id;
667 md.dp_hash = flow->dp_hash;
668 md.tunnel = flow->tunnel;
669 md.skb_priority = flow->skb_priority;
670 md.pkt_mark = flow->pkt_mark;
671 md.in_port = flow->in_port;
676 static inline bool is_ip_any(const struct flow *flow)
678 return dl_type_is_ip_any(flow->dl_type);
681 static inline bool is_icmpv4(const struct flow *flow)
683 return (flow->dl_type == htons(ETH_TYPE_IP)
684 && flow->nw_proto == IPPROTO_ICMP);
687 static inline bool is_icmpv6(const struct flow *flow)
689 return (flow->dl_type == htons(ETH_TYPE_IPV6)
690 && flow->nw_proto == IPPROTO_ICMPV6);
693 static inline bool is_stp(const struct flow *flow)
695 return (eth_addr_equals(flow->dl_dst, eth_addr_stp)
696 && flow->dl_type == htons(FLOW_DL_TYPE_NONE));