2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 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 "openflow/nicira-ext.h"
25 #include "openflow/openflow.h"
29 struct dpif_flow_stats;
31 struct flow_wildcards;
36 /* This sequence number should be incremented whenever anything involving flows
37 * or the wildcarding of flows changes. This will cause build assertion
38 * failures in places which likely need to be updated. */
39 #define FLOW_WC_SEQ 19
42 BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS);
44 /* Used for struct flow's dl_type member for frames that have no Ethernet
45 * type, that is, pure 802.2 frames. */
46 #define FLOW_DL_TYPE_NONE 0x5ff
48 /* Fragment bits, used for IPv4 and IPv6, always zero for non-IP flows. */
49 #define FLOW_NW_FRAG_ANY (1 << 0) /* Set for any IP frag. */
50 #define FLOW_NW_FRAG_LATER (1 << 1) /* Set for IP frag with nonzero offset. */
51 #define FLOW_NW_FRAG_MASK (FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER)
53 BUILD_ASSERT_DECL(FLOW_NW_FRAG_ANY == NX_IP_FRAG_ANY);
54 BUILD_ASSERT_DECL(FLOW_NW_FRAG_LATER == NX_IP_FRAG_LATER);
56 #define FLOW_TNL_F_DONT_FRAGMENT (1 << 0)
57 #define FLOW_TNL_F_CSUM (1 << 1)
58 #define FLOW_TNL_F_KEY (1 << 2)
60 const char *flow_tun_flag_to_string(uint32_t flags);
72 * A flow in the network.
74 * The meaning of 'in_port' is context-dependent. In most cases, it is a
75 * 16-bit OpenFlow 1.0 port number. In the software datapath interface (dpif)
76 * layer and its implementations (e.g. dpif-linux, dpif-netdev), it is instead
77 * a 32-bit datapath port number.
80 struct flow_tnl tunnel; /* Encapsulating tunnel parameters. */
81 ovs_be64 metadata; /* OpenFlow Metadata. */
82 struct in6_addr ipv6_src; /* IPv6 source address. */
83 struct in6_addr ipv6_dst; /* IPv6 destination address. */
84 struct in6_addr nd_target; /* IPv6 neighbor discovery (ND) target. */
85 uint32_t skb_priority; /* Packet priority for QoS. */
86 uint32_t regs[FLOW_N_REGS]; /* Registers. */
87 ovs_be32 nw_src; /* IPv4 source address. */
88 ovs_be32 nw_dst; /* IPv4 destination address. */
89 ovs_be32 ipv6_label; /* IPv6 flow label. */
90 uint32_t in_port; /* Input port. OpenFlow port number
91 unless in DPIF code, in which case it
92 is the datapath port number. */
93 uint32_t skb_mark; /* Packet mark. */
94 ovs_be32 mpls_lse; /* MPLS label stack entry. */
95 uint16_t mpls_depth; /* Depth of MPLS stack. */
96 ovs_be16 vlan_tci; /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */
97 ovs_be16 dl_type; /* Ethernet frame type. */
98 ovs_be16 encap_dl_type; /* MPLS encapsulated Ethernet frame type */
99 ovs_be16 tp_src; /* TCP/UDP source port. */
100 ovs_be16 tp_dst; /* TCP/UDP destination port. */
101 uint8_t dl_src[6]; /* Ethernet source address. */
102 uint8_t dl_dst[6]; /* Ethernet destination address. */
103 uint8_t nw_proto; /* IP protocol or low 8 bits of ARP opcode. */
104 uint8_t nw_tos; /* IP ToS (including DSCP and ECN). */
105 uint8_t arp_sha[6]; /* ARP/ND source hardware address. */
106 uint8_t arp_tha[6]; /* ARP/ND target hardware address. */
107 uint8_t nw_ttl; /* IP TTL/Hop Limit. */
108 uint8_t nw_frag; /* FLOW_FRAG_* flags. */
111 BUILD_ASSERT_DECL(sizeof(struct flow) % 4 == 0);
113 #define FLOW_U32S (sizeof(struct flow) / 4)
115 /* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */
116 BUILD_ASSERT_DECL(sizeof(struct flow) == sizeof(struct flow_tnl) + 160 &&
119 /* Represents the metadata fields of struct flow. */
120 struct flow_metadata {
121 ovs_be64 tun_id; /* Encapsulating tunnel ID. */
122 ovs_be64 metadata; /* OpenFlow 1.1+ metadata field. */
123 uint32_t regs[FLOW_N_REGS]; /* Registers. */
124 uint16_t in_port; /* OpenFlow port or zero. */
127 void flow_extract(struct ofpbuf *, uint32_t priority, uint32_t mark,
128 const struct flow_tnl *, uint16_t in_port, struct flow *);
129 void flow_extract_l3_onwards(struct ofpbuf *, struct flow *,
132 /* Returns the innermost dl_type.
133 * If there's an outer and an inner type then the inner type is returned.
134 * Otherwise, if there is only one type then it is returned. */
135 static inline ovs_be16
136 flow_innermost_dl_type(const struct flow *flow)
138 return (flow->encap_dl_type == htons(0)
140 : flow->encap_dl_type);
143 void flow_zero_wildcards(struct flow *, const struct flow_wildcards *);
144 void flow_get_metadata(const struct flow *, struct flow_metadata *);
146 char *flow_to_string(const struct flow *);
147 void format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t),
148 uint32_t flags, char del);
150 void flow_format(struct ds *, const struct flow *);
151 void flow_print(FILE *, const struct flow *);
152 static inline int flow_compare_3way(const struct flow *, const struct flow *);
153 static inline bool flow_equal(const struct flow *, const struct flow *);
154 static inline size_t flow_hash(const struct flow *, uint32_t basis);
156 void flow_set_dl_vlan(struct flow *, ovs_be16 vid);
157 void flow_set_vlan_vid(struct flow *, ovs_be16 vid);
158 void flow_set_vlan_pcp(struct flow *, uint8_t pcp);
160 void flow_set_mpls_label(struct flow *flow, ovs_be32 label);
161 void flow_set_mpls_ttl(struct flow *flow, uint8_t ttl);
162 void flow_set_mpls_tc(struct flow *flow, uint8_t tc);
163 void flow_set_mpls_bos(struct flow *flow, uint8_t stack);
165 void flow_compose(struct ofpbuf *, const struct flow *);
168 flow_compare_3way(const struct flow *a, const struct flow *b)
170 return memcmp(a, b, sizeof *a);
174 flow_equal(const struct flow *a, const struct flow *b)
176 return !flow_compare_3way(a, b);
180 flow_hash(const struct flow *flow, uint32_t basis)
182 return hash_words((const uint32_t *) flow, sizeof *flow / 4, basis);
185 uint32_t flow_hash_in_minimask(const struct flow *, const struct minimask *,
188 /* Wildcards for a flow.
190 * A 1-bit in each bit in 'masks' indicates that the corresponding bit of
191 * the flow is significant (must match). A 0-bit indicates that the
192 * corresponding bit of the flow is wildcarded (need not match). */
193 struct flow_wildcards {
197 void flow_wildcards_init_catchall(struct flow_wildcards *);
198 void flow_wildcards_init_exact(struct flow_wildcards *);
200 bool flow_wildcards_is_catchall(const struct flow_wildcards *);
202 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
203 int idx, uint32_t mask);
205 void flow_wildcards_combine(struct flow_wildcards *dst,
206 const struct flow_wildcards *src1,
207 const struct flow_wildcards *src2);
208 bool flow_wildcards_has_extra(const struct flow_wildcards *,
209 const struct flow_wildcards *);
211 uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis);
212 bool flow_wildcards_equal(const struct flow_wildcards *,
213 const struct flow_wildcards *);
214 uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
216 uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields,
218 const char *flow_hash_fields_to_str(enum nx_hash_fields);
219 bool flow_hash_fields_valid(enum nx_hash_fields);
221 bool flow_equal_except(const struct flow *a, const struct flow *b,
222 const struct flow_wildcards *);
224 /* Compressed flow. */
226 #define MINI_N_INLINE (sizeof(void *) == 4 ? 7 : 8)
227 #define MINI_N_MAPS DIV_ROUND_UP(FLOW_U32S, 32)
229 /* A sparse representation of a "struct flow".
231 * A "struct flow" is fairly large and tends to be mostly zeros. Sparse
232 * representation has two advantages. First, it saves memory. Second, it
233 * saves time when the goal is to iterate over only the nonzero parts of the
236 * The 'map' member holds one bit for each uint32_t in a "struct flow". Each
237 * 0-bit indicates that the corresponding uint32_t is zero, each 1-bit that it
240 * 'values' points to the start of an array that has one element for each 1-bit
241 * in 'map'. The least-numbered 1-bit is in values[0], the next 1-bit is in
242 * values[1], and so on.
244 * 'values' may point to a few different locations:
246 * - If 'map' has MINI_N_INLINE or fewer 1-bits, it may point to
247 * 'inline_values'. One hopes that this is the common case.
249 * - If 'map' has more than MINI_N_INLINE 1-bits, it may point to memory
250 * allocated with malloc().
252 * - The caller could provide storage on the stack for situations where
253 * that makes sense. So far that's only proved useful for
254 * minimask_combine(), but the principle works elsewhere.
256 * The implementation maintains and depends on the invariant that every element
257 * in 'values' is nonzero; that is, wherever a 1-bit appears in 'map', the
258 * corresponding element of 'values' must be nonzero.
262 uint32_t inline_values[MINI_N_INLINE];
263 uint32_t map[MINI_N_MAPS];
266 void miniflow_init(struct miniflow *, const struct flow *);
267 void miniflow_clone(struct miniflow *, const struct miniflow *);
268 void miniflow_destroy(struct miniflow *);
270 void miniflow_expand(const struct miniflow *, struct flow *);
272 uint32_t miniflow_get(const struct miniflow *, unsigned int u32_ofs);
273 uint16_t miniflow_get_vid(const struct miniflow *);
275 bool miniflow_equal(const struct miniflow *a, const struct miniflow *b);
276 bool miniflow_equal_in_minimask(const struct miniflow *a,
277 const struct miniflow *b,
278 const struct minimask *);
279 bool miniflow_equal_flow_in_minimask(const struct miniflow *a,
280 const struct flow *b,
281 const struct minimask *);
282 uint32_t miniflow_hash(const struct miniflow *, uint32_t basis);
283 uint32_t miniflow_hash_in_minimask(const struct miniflow *,
284 const struct minimask *, uint32_t basis);
286 /* Compressed flow wildcards. */
288 /* A sparse representation of a "struct flow_wildcards".
290 * See the large comment on struct miniflow for details. */
292 struct miniflow masks;
295 void minimask_init(struct minimask *, const struct flow_wildcards *);
296 void minimask_clone(struct minimask *, const struct minimask *);
297 void minimask_combine(struct minimask *dst,
298 const struct minimask *a, const struct minimask *b,
299 uint32_t storage[FLOW_U32S]);
300 void minimask_destroy(struct minimask *);
302 void minimask_expand(const struct minimask *, struct flow_wildcards *);
304 uint32_t minimask_get(const struct minimask *, unsigned int u32_ofs);
305 uint16_t minimask_get_vid_mask(const struct minimask *);
307 bool minimask_equal(const struct minimask *a, const struct minimask *b);
308 uint32_t minimask_hash(const struct minimask *, uint32_t basis);
310 bool minimask_has_extra(const struct minimask *, const struct minimask *);
311 bool minimask_is_catchall(const struct minimask *);