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"
30 struct dpif_flow_stats;
32 struct flow_wildcards;
37 /* This sequence number should be incremented whenever anything involving flows
38 * or the wildcarding of flows changes. This will cause build assertion
39 * failures in places which likely need to be updated. */
40 #define FLOW_WC_SEQ 25
43 BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS);
45 /* Used for struct flow's dl_type member for frames that have no Ethernet
46 * type, that is, pure 802.2 frames. */
47 #define FLOW_DL_TYPE_NONE 0x5ff
49 /* Fragment bits, used for IPv4 and IPv6, always zero for non-IP flows. */
50 #define FLOW_NW_FRAG_ANY (1 << 0) /* Set for any IP frag. */
51 #define FLOW_NW_FRAG_LATER (1 << 1) /* Set for IP frag with nonzero offset. */
52 #define FLOW_NW_FRAG_MASK (FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER)
54 BUILD_ASSERT_DECL(FLOW_NW_FRAG_ANY == NX_IP_FRAG_ANY);
55 BUILD_ASSERT_DECL(FLOW_NW_FRAG_LATER == NX_IP_FRAG_LATER);
57 #define FLOW_TNL_F_DONT_FRAGMENT (1 << 0)
58 #define FLOW_TNL_F_CSUM (1 << 1)
59 #define FLOW_TNL_F_KEY (1 << 2)
61 const char *flow_tun_flag_to_string(uint32_t flags);
72 /* Unfortunately, a "struct flow" sometimes has to handle OpenFlow port
73 * numbers and other times datapath (dpif) port numbers. This union allows
80 /* Maximum number of supported MPLS labels. */
81 #define FLOW_MAX_MPLS_LABELS 3
84 * A flow in the network.
86 * Must be initialized to all zeros to make any compiler-induced padding
87 * zeroed. Helps also in keeping unused fields (such as mutually exclusive
88 * IPv4 and IPv6 addresses) zeroed out.
90 * The meaning of 'in_port' is context-dependent. In most cases, it is a
91 * 16-bit OpenFlow 1.0 port number. In the software datapath interface (dpif)
92 * layer and its implementations (e.g. dpif-linux, dpif-netdev), it is instead
93 * a 32-bit datapath port number.
95 * The fields are organized in four segments to facilitate staged lookup, where
96 * lower layer fields are first used to determine if the later fields need to
97 * be looked at. This enables better wildcarding for datapath flows.
101 struct flow_tnl tunnel; /* Encapsulating tunnel parameters. */
102 ovs_be64 metadata; /* OpenFlow Metadata. */
103 uint32_t regs[FLOW_N_REGS]; /* Registers. */
104 uint32_t skb_priority; /* Packet priority for QoS. */
105 uint32_t pkt_mark; /* Packet mark. */
106 uint32_t recirc_id; /* Must be exact match. */
107 union flow_in_port in_port; /* Input port.*/
110 uint8_t dl_src[6]; /* Ethernet source address. */
111 uint8_t dl_dst[6]; /* Ethernet destination address. */
112 ovs_be16 dl_type; /* Ethernet frame type. */
113 ovs_be16 vlan_tci; /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */
114 ovs_be32 mpls_lse[FLOW_MAX_MPLS_LABELS]; /* MPLS label stack entry. */
117 struct in6_addr ipv6_src; /* IPv6 source address. */
118 struct in6_addr ipv6_dst; /* IPv6 destination address. */
119 struct in6_addr nd_target; /* IPv6 neighbor discovery (ND) target. */
120 ovs_be32 ipv6_label; /* IPv6 flow label. */
121 ovs_be32 nw_src; /* IPv4 source address. */
122 ovs_be32 nw_dst; /* IPv4 destination address. */
123 uint8_t nw_frag; /* FLOW_FRAG_* flags. */
124 uint8_t nw_tos; /* IP ToS (including DSCP and ECN). */
125 uint8_t nw_ttl; /* IP TTL/Hop Limit. */
126 uint8_t nw_proto; /* IP protocol or low 8 bits of ARP opcode. */
127 uint8_t arp_sha[6]; /* ARP/ND source hardware address. */
128 uint8_t arp_tha[6]; /* ARP/ND target hardware address. */
129 ovs_be16 tcp_flags; /* TCP flags. With L3 to avoid matching L4. */
130 ovs_be16 pad; /* Padding. */
133 uint32_t dp_hash; /* Datapath computed hash value. The exact
134 computation is opaque to the user space.*/
135 ovs_be16 tp_src; /* TCP/UDP/SCTP source port. */
136 ovs_be16 tp_dst; /* TCP/UDP/SCTP destination port.
137 * Keep last for the BUILD_ASSERT_DECL below */
139 BUILD_ASSERT_DECL(sizeof(struct flow) % 4 == 0);
141 #define FLOW_U32S (sizeof(struct flow) / 4)
143 /* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */
144 BUILD_ASSERT_DECL(offsetof(struct flow, tp_dst) + 2
145 == sizeof(struct flow_tnl) + 172
146 && FLOW_WC_SEQ == 25);
148 /* Incremental points at which flow classification may be performed in
150 * This is located here since this is dependent on the structure of the
151 * struct flow defined above:
152 * Each offset must be on a distint, successive U32 boundary srtictly
153 * within the struct flow. */
155 FLOW_SEGMENT_1_ENDS_AT = offsetof(struct flow, dl_src),
156 FLOW_SEGMENT_2_ENDS_AT = offsetof(struct flow, ipv6_src),
157 FLOW_SEGMENT_3_ENDS_AT = offsetof(struct flow, dp_hash),
159 BUILD_ASSERT_DECL(FLOW_SEGMENT_1_ENDS_AT % 4 == 0);
160 BUILD_ASSERT_DECL(FLOW_SEGMENT_2_ENDS_AT % 4 == 0);
161 BUILD_ASSERT_DECL(FLOW_SEGMENT_3_ENDS_AT % 4 == 0);
162 BUILD_ASSERT_DECL( 0 < FLOW_SEGMENT_1_ENDS_AT);
163 BUILD_ASSERT_DECL(FLOW_SEGMENT_1_ENDS_AT < FLOW_SEGMENT_2_ENDS_AT);
164 BUILD_ASSERT_DECL(FLOW_SEGMENT_2_ENDS_AT < FLOW_SEGMENT_3_ENDS_AT);
165 BUILD_ASSERT_DECL(FLOW_SEGMENT_3_ENDS_AT < sizeof(struct flow));
167 extern const uint8_t flow_segment_u32s[];
169 /* Represents the metadata fields of struct flow. */
170 struct flow_metadata {
171 uint32_t dp_hash; /* Datapath computed hash field. */
172 uint32_t recirc_id; /* Recirculation ID. */
173 ovs_be64 tun_id; /* Encapsulating tunnel ID. */
174 ovs_be32 tun_src; /* Tunnel outer IPv4 src addr */
175 ovs_be32 tun_dst; /* Tunnel outer IPv4 dst addr */
176 ovs_be64 metadata; /* OpenFlow 1.1+ metadata field. */
177 uint32_t regs[FLOW_N_REGS]; /* Registers. */
178 uint32_t pkt_mark; /* Packet mark. */
179 ofp_port_t in_port; /* OpenFlow port or zero. */
182 void flow_extract(struct ofpbuf *, const struct pkt_metadata *md,
185 void flow_zero_wildcards(struct flow *, const struct flow_wildcards *);
186 void flow_unwildcard_tp_ports(const struct flow *, struct flow_wildcards *);
187 void flow_get_metadata(const struct flow *, struct flow_metadata *);
189 char *flow_to_string(const struct flow *);
190 void format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t),
191 uint32_t flags, char del);
192 void format_flags_masked(struct ds *ds, const char *name,
193 const char *(*bit_to_string)(uint32_t),
194 uint32_t flags, uint32_t mask);
196 void flow_format(struct ds *, const struct flow *);
197 void flow_print(FILE *, const struct flow *);
198 static inline int flow_compare_3way(const struct flow *, const struct flow *);
199 static inline bool flow_equal(const struct flow *, const struct flow *);
200 static inline size_t flow_hash(const struct flow *, uint32_t basis);
202 void flow_set_dl_vlan(struct flow *, ovs_be16 vid);
203 void flow_set_vlan_vid(struct flow *, ovs_be16 vid);
204 void flow_set_vlan_pcp(struct flow *, uint8_t pcp);
206 int flow_count_mpls_labels(const struct flow *, struct flow_wildcards *);
207 int flow_count_common_mpls_labels(const struct flow *a, int an,
208 const struct flow *b, int bn,
209 struct flow_wildcards *wc);
210 void flow_push_mpls(struct flow *, int n, ovs_be16 mpls_eth_type,
211 struct flow_wildcards *);
212 bool flow_pop_mpls(struct flow *, int n, ovs_be16 eth_type,
213 struct flow_wildcards *);
214 void flow_set_mpls_label(struct flow *, int idx, ovs_be32 label);
215 void flow_set_mpls_ttl(struct flow *, int idx, uint8_t ttl);
216 void flow_set_mpls_tc(struct flow *, int idx, uint8_t tc);
217 void flow_set_mpls_bos(struct flow *, int idx, uint8_t stack);
218 void flow_set_mpls_lse(struct flow *, int idx, ovs_be32 lse);
220 void flow_compose(struct ofpbuf *, const struct flow *);
223 flow_compare_3way(const struct flow *a, const struct flow *b)
225 return memcmp(a, b, sizeof *a);
229 flow_equal(const struct flow *a, const struct flow *b)
231 return !flow_compare_3way(a, b);
235 flow_hash(const struct flow *flow, uint32_t basis)
237 return hash_words((const uint32_t *) flow, sizeof *flow / 4, basis);
240 static inline uint16_t
241 ofp_to_u16(ofp_port_t ofp_port)
243 return (OVS_FORCE uint16_t) ofp_port;
246 static inline uint32_t
247 odp_to_u32(odp_port_t odp_port)
249 return (OVS_FORCE uint32_t) odp_port;
252 static inline uint32_t
253 ofp11_to_u32(ofp11_port_t ofp11_port)
255 return (OVS_FORCE uint32_t) ofp11_port;
258 static inline ofp_port_t
259 u16_to_ofp(uint16_t port)
261 return OFP_PORT_C(port);
264 static inline odp_port_t
265 u32_to_odp(uint32_t port)
267 return ODP_PORT_C(port);
270 static inline ofp11_port_t
271 u32_to_ofp11(uint32_t port)
273 return OFP11_PORT_C(port);
276 static inline uint32_t
277 hash_ofp_port(ofp_port_t ofp_port)
279 return hash_int(ofp_to_u16(ofp_port), 0);
282 static inline uint32_t
283 hash_odp_port(odp_port_t odp_port)
285 return hash_int(odp_to_u32(odp_port), 0);
288 uint32_t flow_hash_in_minimask(const struct flow *, const struct minimask *,
290 uint32_t flow_hash_in_minimask_range(const struct flow *,
291 const struct minimask *,
292 uint8_t start, uint8_t end,
295 /* Wildcards for a flow.
297 * A 1-bit in each bit in 'masks' indicates that the corresponding bit of
298 * the flow is significant (must match). A 0-bit indicates that the
299 * corresponding bit of the flow is wildcarded (need not match). */
300 struct flow_wildcards {
304 void flow_wildcards_init_catchall(struct flow_wildcards *);
306 void flow_wildcards_clear_non_packet_fields(struct flow_wildcards *);
308 bool flow_wildcards_is_catchall(const struct flow_wildcards *);
310 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
311 int idx, uint32_t mask);
313 void flow_wildcards_and(struct flow_wildcards *dst,
314 const struct flow_wildcards *src1,
315 const struct flow_wildcards *src2);
316 void flow_wildcards_or(struct flow_wildcards *dst,
317 const struct flow_wildcards *src1,
318 const struct flow_wildcards *src2);
319 bool flow_wildcards_has_extra(const struct flow_wildcards *,
320 const struct flow_wildcards *);
322 void flow_wildcards_fold_minimask(struct flow_wildcards *,
323 const struct minimask *);
324 void flow_wildcards_fold_minimask_range(struct flow_wildcards *,
325 const struct minimask *,
326 uint8_t start, uint8_t end);
328 uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis);
329 bool flow_wildcards_equal(const struct flow_wildcards *,
330 const struct flow_wildcards *);
331 uint32_t flow_hash_5tuple(const struct flow *flow, uint32_t basis);
332 uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
334 /* Initialize a flow with random fields that matter for nx_hash_fields. */
335 void flow_random_hash_fields(struct flow *);
336 void flow_mask_hash_fields(const struct flow *, struct flow_wildcards *,
337 enum nx_hash_fields);
338 uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields,
340 const char *flow_hash_fields_to_str(enum nx_hash_fields);
341 bool flow_hash_fields_valid(enum nx_hash_fields);
343 uint32_t flow_hash_in_wildcards(const struct flow *,
344 const struct flow_wildcards *,
347 bool flow_equal_except(const struct flow *a, const struct flow *b,
348 const struct flow_wildcards *);
350 /* Compressed flow. */
352 #define MINI_N_INLINE (sizeof(void *) == 4 ? 7 : 8)
353 BUILD_ASSERT_DECL(FLOW_U32S <= 64);
355 /* A sparse representation of a "struct flow".
357 * A "struct flow" is fairly large and tends to be mostly zeros. Sparse
358 * representation has two advantages. First, it saves memory. Second, it
359 * saves time when the goal is to iterate over only the nonzero parts of the
362 * The 'map' member holds one bit for each uint32_t in a "struct flow". Each
363 * 0-bit indicates that the corresponding uint32_t is zero, each 1-bit that it
366 * 'values' points to the start of an array that has one element for each 1-bit
367 * in 'map'. The least-numbered 1-bit is in values[0], the next 1-bit is in
368 * values[1], and so on.
370 * 'values' may point to a few different locations:
372 * - If 'map' has MINI_N_INLINE or fewer 1-bits, it may point to
373 * 'inline_values'. One hopes that this is the common case.
375 * - If 'map' has more than MINI_N_INLINE 1-bits, it may point to memory
376 * allocated with malloc().
378 * - The caller could provide storage on the stack for situations where
379 * that makes sense. So far that's only proved useful for
380 * minimask_combine(), but the principle works elsewhere.
382 * Elements in 'values' are allowed to be zero. This is useful for "struct
383 * minimatch", for which ensuring that the miniflow and minimask members have
384 * same 'map' allows optimization. This allowance applies only to a miniflow
385 * that is not a mask. That is, a minimask may NOT have zero elements in
391 uint32_t inline_values[MINI_N_INLINE];
394 void miniflow_init(struct miniflow *, const struct flow *);
395 void miniflow_init_with_minimask(struct miniflow *, const struct flow *,
396 const struct minimask *);
397 void miniflow_clone(struct miniflow *, const struct miniflow *);
398 void miniflow_move(struct miniflow *dst, struct miniflow *);
399 void miniflow_destroy(struct miniflow *);
401 void miniflow_expand(const struct miniflow *, struct flow *);
403 uint32_t miniflow_get(const struct miniflow *, unsigned int u32_ofs);
404 uint16_t miniflow_get_vid(const struct miniflow *);
405 static inline ovs_be64 miniflow_get_metadata(const struct miniflow *);
407 bool miniflow_equal(const struct miniflow *a, const struct miniflow *b);
408 bool miniflow_equal_in_minimask(const struct miniflow *a,
409 const struct miniflow *b,
410 const struct minimask *);
411 bool miniflow_equal_flow_in_minimask(const struct miniflow *a,
412 const struct flow *b,
413 const struct minimask *);
414 uint32_t miniflow_hash(const struct miniflow *, uint32_t basis);
415 uint32_t miniflow_hash_in_minimask(const struct miniflow *,
416 const struct minimask *, uint32_t basis);
417 uint64_t miniflow_get_map_in_range(const struct miniflow *miniflow,
418 uint8_t start, uint8_t end,
419 unsigned int *offset);
422 /* Compressed flow wildcards. */
424 /* A sparse representation of a "struct flow_wildcards".
426 * See the large comment on struct miniflow for details.
428 * Note: While miniflow can have zero data for a 1-bit in the map,
429 * a minimask may not! We rely on this in the implementation. */
431 struct miniflow masks;
434 void minimask_init(struct minimask *, const struct flow_wildcards *);
435 void minimask_clone(struct minimask *, const struct minimask *);
436 void minimask_move(struct minimask *dst, struct minimask *src);
437 void minimask_combine(struct minimask *dst,
438 const struct minimask *a, const struct minimask *b,
439 uint32_t storage[FLOW_U32S]);
440 void minimask_destroy(struct minimask *);
442 void minimask_expand(const struct minimask *, struct flow_wildcards *);
444 uint32_t minimask_get(const struct minimask *, unsigned int u32_ofs);
445 uint16_t minimask_get_vid_mask(const struct minimask *);
446 static inline ovs_be64 minimask_get_metadata_mask(const struct minimask *);
448 bool minimask_equal(const struct minimask *a, const struct minimask *b);
449 uint32_t minimask_hash(const struct minimask *, uint32_t basis);
451 bool minimask_has_extra(const struct minimask *, const struct minimask *);
452 bool minimask_is_catchall(const struct minimask *);
454 /* Returns the value of the OpenFlow 1.1+ "metadata" field in 'flow'. */
455 static inline ovs_be64
456 miniflow_get_metadata(const struct miniflow *flow)
458 enum { MD_OFS = offsetof(struct flow, metadata) };
459 BUILD_ASSERT_DECL(MD_OFS % sizeof(uint32_t) == 0);
460 ovs_be32 hi = (OVS_FORCE ovs_be32) miniflow_get(flow, MD_OFS / 4);
461 ovs_be32 lo = (OVS_FORCE ovs_be32) miniflow_get(flow, MD_OFS / 4 + 1);
463 return htonll(((uint64_t) ntohl(hi) << 32) | ntohl(lo));
466 /* Returns the mask for the OpenFlow 1.1+ "metadata" field in 'mask'.
468 * The return value is all-1-bits if 'mask' matches on the whole value of the
469 * metadata field, all-0-bits if 'mask' entirely wildcards the metadata field,
470 * or some other value if the metadata field is partially matched, partially
472 static inline ovs_be64
473 minimask_get_metadata_mask(const struct minimask *mask)
475 return miniflow_get_metadata(&mask->masks);