]> git.proxmox.com Git - mirror_ovs.git/blame - lib/flow.h
ofproto-dpif: Store relevant fields for wildcarding in facet.
[mirror_ovs.git] / lib / flow.h
CommitLineData
064af421 1/*
b02475c5 2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
064af421 3 *
a14bc59f
BP
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:
064af421 7 *
a14bc59f
BP
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
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.
064af421
BP
15 */
16#ifndef FLOW_H
17#define FLOW_H 1
18
7f3adc00 19#include <sys/types.h>
064af421
BP
20#include <netinet/in.h>
21#include <stdbool.h>
22#include <stdint.h>
23#include <string.h>
659586ef 24#include "openflow/nicira-ext.h"
064af421
BP
25#include "openflow/openflow.h"
26#include "hash.h"
064af421
BP
27#include "util.h"
28
c97fb132 29struct dpif_flow_stats;
064af421 30struct ds;
b63f2ea7 31struct flow_wildcards;
5cb7a798
BP
32struct miniflow;
33struct minimask;
064af421
BP
34struct ofpbuf;
35
a877206f
EJ
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. */
cff78c88 39#define FLOW_WC_SEQ 20
a877206f 40
e9358af6 41#define FLOW_N_REGS 8
b6c9e612
BP
42BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS);
43
36956a7d
BP
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
47
7257b535 48/* Fragment bits, used for IPv4 and IPv6, always zero for non-IP flows. */
eadef313
JP
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)
7257b535 52
eadef313
JP
53BUILD_ASSERT_DECL(FLOW_NW_FRAG_ANY == NX_IP_FRAG_ANY);
54BUILD_ASSERT_DECL(FLOW_NW_FRAG_LATER == NX_IP_FRAG_LATER);
7257b535 55
296e07ac
JG
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)
4fe3445a
PS
59
60const char *flow_tun_flag_to_string(uint32_t flags);
61
296e07ac
JG
62struct flow_tnl {
63 ovs_be64 tun_id;
64 ovs_be32 ip_src;
65 ovs_be32 ip_dst;
66 uint16_t flags;
67 uint8_t ip_tos;
68 uint8_t ip_ttl;
69};
70
ddbfda84
JP
71/*
72* A flow in the network.
73*
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.
78*/
14608a15 79struct flow {
296e07ac 80 struct flow_tnl tunnel; /* Encapsulating tunnel parameters. */
969fc56c 81 ovs_be64 metadata; /* OpenFlow Metadata. */
5145475f
JP
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. */
deedf7e7 85 uint32_t skb_priority; /* Packet priority for QoS. */
b6c9e612 86 uint32_t regs[FLOW_N_REGS]; /* Registers. */
d31f1109
JP
87 ovs_be32 nw_src; /* IPv4 source address. */
88 ovs_be32 nw_dst; /* IPv4 destination address. */
fa8223b7 89 ovs_be32 ipv6_label; /* IPv6 flow label. */
ddbfda84
JP
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. */
72e8bf28 93 uint32_t skb_mark; /* Packet mark. */
b02475c5
SH
94 ovs_be32 mpls_lse; /* MPLS label stack entry. */
95 uint16_t mpls_depth; /* Depth of MPLS stack. */
66642cb4 96 ovs_be16 vlan_tci; /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */
0b3e77bb
BP
97 ovs_be16 dl_type; /* Ethernet frame type. */
98 ovs_be16 tp_src; /* TCP/UDP source port. */
99 ovs_be16 tp_dst; /* TCP/UDP destination port. */
14608a15
BP
100 uint8_t dl_src[6]; /* Ethernet source address. */
101 uint8_t dl_dst[6]; /* Ethernet destination address. */
102 uint8_t nw_proto; /* IP protocol or low 8 bits of ARP opcode. */
eadef313 103 uint8_t nw_tos; /* IP ToS (including DSCP and ECN). */
685a51a5
JP
104 uint8_t arp_sha[6]; /* ARP/ND source hardware address. */
105 uint8_t arp_tha[6]; /* ARP/ND target hardware address. */
a61680c6 106 uint8_t nw_ttl; /* IP TTL/Hop Limit. */
eadef313 107 uint8_t nw_frag; /* FLOW_FRAG_* flags. */
cff78c88 108 uint8_t zeros[6];
14608a15 109};
296e07ac 110BUILD_ASSERT_DECL(sizeof(struct flow) % 4 == 0);
16c6d0c3 111
659c2346
BP
112#define FLOW_U32S (sizeof(struct flow) / 4)
113
16c6d0c3 114/* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */
b02475c5 115BUILD_ASSERT_DECL(sizeof(struct flow) == sizeof(struct flow_tnl) + 160 &&
cff78c88 116 FLOW_WC_SEQ == 20);
14608a15 117
42edbe39 118/* Represents the metadata fields of struct flow. */
5d6c3af0
EJ
119struct flow_metadata {
120 ovs_be64 tun_id; /* Encapsulating tunnel ID. */
0ad90c84
JR
121 ovs_be32 tun_src; /* Tunnel outer IPv4 src addr */
122 ovs_be32 tun_dst; /* Tunnel outer IPv4 dst addr */
42edbe39 123 ovs_be64 metadata; /* OpenFlow 1.1+ metadata field. */
5d6c3af0 124 uint32_t regs[FLOW_N_REGS]; /* Registers. */
5d6c3af0
EJ
125 uint16_t in_port; /* OpenFlow port or zero. */
126};
127
72e8bf28
AA
128void flow_extract(struct ofpbuf *, uint32_t priority, uint32_t mark,
129 const struct flow_tnl *, uint16_t in_port, struct flow *);
b02475c5 130
993410fb 131void flow_zero_wildcards(struct flow *, const struct flow_wildcards *);
5d6c3af0 132void flow_get_metadata(const struct flow *, struct flow_metadata *);
993410fb 133
ae412e7d 134char *flow_to_string(const struct flow *);
4fe3445a
PS
135void format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t),
136 uint32_t flags, char del);
137
ae412e7d
BP
138void flow_format(struct ds *, const struct flow *);
139void flow_print(FILE *, const struct flow *);
79049a24 140static inline int flow_compare_3way(const struct flow *, const struct flow *);
ae412e7d
BP
141static inline bool flow_equal(const struct flow *, const struct flow *);
142static inline size_t flow_hash(const struct flow *, uint32_t basis);
064af421 143
fb0451d9 144void flow_set_dl_vlan(struct flow *, ovs_be16 vid);
cc34bc8c 145void flow_set_vlan_vid(struct flow *, ovs_be16 vid);
3719455c
BP
146void flow_set_vlan_pcp(struct flow *, uint8_t pcp);
147
b02475c5
SH
148void flow_set_mpls_label(struct flow *flow, ovs_be32 label);
149void flow_set_mpls_ttl(struct flow *flow, uint8_t ttl);
150void flow_set_mpls_tc(struct flow *flow, uint8_t tc);
151void flow_set_mpls_bos(struct flow *flow, uint8_t stack);
152
8b3b8dd1
BP
153void flow_compose(struct ofpbuf *, const struct flow *);
154
064af421 155static inline int
79049a24 156flow_compare_3way(const struct flow *a, const struct flow *b)
064af421 157{
16c6d0c3 158 return memcmp(a, b, sizeof *a);
064af421
BP
159}
160
161static inline bool
ae412e7d 162flow_equal(const struct flow *a, const struct flow *b)
064af421 163{
79049a24 164 return !flow_compare_3way(a, b);
064af421
BP
165}
166
167static inline size_t
ae412e7d 168flow_hash(const struct flow *flow, uint32_t basis)
064af421 169{
16c6d0c3 170 return hash_words((const uint32_t *) flow, sizeof *flow / 4, basis);
064af421 171}
5cb7a798
BP
172
173uint32_t flow_hash_in_minimask(const struct flow *, const struct minimask *,
174 uint32_t basis);
659c2346 175\f
26720e24
BP
176/* Wildcards for a flow.
177 *
178 * A 1-bit in each bit in 'masks' indicates that the corresponding bit of
179 * the flow is significant (must match). A 0-bit indicates that the
180 * corresponding bit of the flow is wildcarded (need not match). */
064af421 181struct flow_wildcards {
26720e24 182 struct flow masks;
064af421 183};
a877206f 184
d8ae4d67 185void flow_wildcards_init_catchall(struct flow_wildcards *);
494e43a5
BP
186void flow_wildcards_init_exact(struct flow_wildcards *);
187
ecf1e7ac 188bool flow_wildcards_is_catchall(const struct flow_wildcards *);
00561f41 189
b6c9e612
BP
190void flow_wildcards_set_reg_mask(struct flow_wildcards *,
191 int idx, uint32_t mask);
064af421 192
368eefac
EJ
193void flow_wildcards_and(struct flow_wildcards *dst,
194 const struct flow_wildcards *src1,
195 const struct flow_wildcards *src2);
196void flow_wildcards_or(struct flow_wildcards *dst,
197 const struct flow_wildcards *src1,
198 const struct flow_wildcards *src2);
b5d97350
BP
199bool flow_wildcards_has_extra(const struct flow_wildcards *,
200 const struct flow_wildcards *);
201
ad77e3c5
EJ
202void flow_wildcards_fold_minimask(struct flow_wildcards *,
203 const struct minimask *);
204
1006cda6 205uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis);
b5d97350
BP
206bool flow_wildcards_equal(const struct flow_wildcards *,
207 const struct flow_wildcards *);
ff55ea1f 208uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
b5d97350 209
bcd2633a 210void flow_mask_hash_fields(struct flow_wildcards *, enum nx_hash_fields);
520e9a2a
EJ
211uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields,
212 uint16_t basis);
213const char *flow_hash_fields_to_str(enum nx_hash_fields);
214bool flow_hash_fields_valid(enum nx_hash_fields);
db7f8281 215
368eefac
EJ
216uint32_t flow_hash_in_wildcards(const struct flow *,
217 const struct flow_wildcards *,
218 uint32_t basis);
219
659c2346
BP
220bool flow_equal_except(const struct flow *a, const struct flow *b,
221 const struct flow_wildcards *);
5cb7a798
BP
222\f
223/* Compressed flow. */
224
225#define MINI_N_INLINE (sizeof(void *) == 4 ? 7 : 8)
226#define MINI_N_MAPS DIV_ROUND_UP(FLOW_U32S, 32)
227
228/* A sparse representation of a "struct flow".
229 *
230 * A "struct flow" is fairly large and tends to be mostly zeros. Sparse
231 * representation has two advantages. First, it saves memory. Second, it
232 * saves time when the goal is to iterate over only the nonzero parts of the
233 * struct.
234 *
235 * The 'map' member holds one bit for each uint32_t in a "struct flow". Each
236 * 0-bit indicates that the corresponding uint32_t is zero, each 1-bit that it
237 * is nonzero.
238 *
239 * 'values' points to the start of an array that has one element for each 1-bit
240 * in 'map'. The least-numbered 1-bit is in values[0], the next 1-bit is in
241 * values[1], and so on.
242 *
243 * 'values' may point to a few different locations:
244 *
245 * - If 'map' has MINI_N_INLINE or fewer 1-bits, it may point to
246 * 'inline_values'. One hopes that this is the common case.
247 *
248 * - If 'map' has more than MINI_N_INLINE 1-bits, it may point to memory
249 * allocated with malloc().
250 *
251 * - The caller could provide storage on the stack for situations where
252 * that makes sense. So far that's only proved useful for
253 * minimask_combine(), but the principle works elsewhere.
254 *
255 * The implementation maintains and depends on the invariant that every element
256 * in 'values' is nonzero; that is, wherever a 1-bit appears in 'map', the
257 * corresponding element of 'values' must be nonzero.
258 */
259struct miniflow {
260 uint32_t *values;
261 uint32_t inline_values[MINI_N_INLINE];
262 uint32_t map[MINI_N_MAPS];
263};
264
265void miniflow_init(struct miniflow *, const struct flow *);
266void miniflow_clone(struct miniflow *, const struct miniflow *);
267void miniflow_destroy(struct miniflow *);
268
269void miniflow_expand(const struct miniflow *, struct flow *);
270
271uint32_t miniflow_get(const struct miniflow *, unsigned int u32_ofs);
272uint16_t miniflow_get_vid(const struct miniflow *);
273
274bool miniflow_equal(const struct miniflow *a, const struct miniflow *b);
275bool miniflow_equal_in_minimask(const struct miniflow *a,
276 const struct miniflow *b,
277 const struct minimask *);
278bool miniflow_equal_flow_in_minimask(const struct miniflow *a,
279 const struct flow *b,
280 const struct minimask *);
281uint32_t miniflow_hash(const struct miniflow *, uint32_t basis);
282uint32_t miniflow_hash_in_minimask(const struct miniflow *,
283 const struct minimask *, uint32_t basis);
284\f
285/* Compressed flow wildcards. */
286
287/* A sparse representation of a "struct flow_wildcards".
288 *
289 * See the large comment on struct miniflow for details. */
290struct minimask {
291 struct miniflow masks;
292};
293
294void minimask_init(struct minimask *, const struct flow_wildcards *);
295void minimask_clone(struct minimask *, const struct minimask *);
296void minimask_combine(struct minimask *dst,
297 const struct minimask *a, const struct minimask *b,
298 uint32_t storage[FLOW_U32S]);
299void minimask_destroy(struct minimask *);
300
301void minimask_expand(const struct minimask *, struct flow_wildcards *);
302
303uint32_t minimask_get(const struct minimask *, unsigned int u32_ofs);
304uint16_t minimask_get_vid_mask(const struct minimask *);
305
306bool minimask_equal(const struct minimask *a, const struct minimask *b);
307uint32_t minimask_hash(const struct minimask *, uint32_t basis);
308
309bool minimask_has_extra(const struct minimask *, const struct minimask *);
310bool minimask_is_catchall(const struct minimask *);
659c2346 311
064af421 312#endif /* flow.h */