vswitchd: Log all tunnel parameters of given flow.
[sliver-openvswitch.git] / lib / flow.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
3  *
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:
7  *
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.
15  */
16 #ifndef FLOW_H
17 #define FLOW_H 1
18
19 #include <sys/types.h>
20 #include <netinet/in.h>
21 #include <stdbool.h>
22 #include <stdint.h>
23 #include <string.h>
24 #include "openflow/nicira-ext.h"
25 #include "openflow/openflow.h"
26 #include "hash.h"
27 #include "util.h"
28
29 struct dpif_flow_stats;
30 struct ds;
31 struct flow_wildcards;
32 struct miniflow;
33 struct minimask;
34 struct ofpbuf;
35
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 18
40
41 #define FLOW_N_REGS 8
42 BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS);
43
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
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)
52
53 BUILD_ASSERT_DECL(FLOW_NW_FRAG_ANY == NX_IP_FRAG_ANY);
54 BUILD_ASSERT_DECL(FLOW_NW_FRAG_LATER == NX_IP_FRAG_LATER);
55
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)
59
60 const char *flow_tun_flag_to_string(uint32_t flags);
61
62 struct 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
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 */
79 struct flow {
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_be16 vlan_tci;          /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */
95     ovs_be16 dl_type;           /* Ethernet frame type. */
96     ovs_be16 tp_src;            /* TCP/UDP source port. */
97     ovs_be16 tp_dst;            /* TCP/UDP destination port. */
98     uint8_t dl_src[6];          /* Ethernet source address. */
99     uint8_t dl_dst[6];          /* Ethernet destination address. */
100     uint8_t nw_proto;           /* IP protocol or low 8 bits of ARP opcode. */
101     uint8_t nw_tos;             /* IP ToS (including DSCP and ECN). */
102     uint8_t arp_sha[6];         /* ARP/ND source hardware address. */
103     uint8_t arp_tha[6];         /* ARP/ND target hardware address. */
104     uint8_t nw_ttl;             /* IP TTL/Hop Limit. */
105     uint8_t nw_frag;            /* FLOW_FRAG_* flags. */
106 };
107 BUILD_ASSERT_DECL(sizeof(struct flow) % 4 == 0);
108
109 #define FLOW_U32S (sizeof(struct flow) / 4)
110
111 /* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */
112 BUILD_ASSERT_DECL(sizeof(struct flow) == sizeof(struct flow_tnl) + 152 &&
113                   FLOW_WC_SEQ == 18);
114
115 /* Represents the metadata fields of struct flow. */
116 struct flow_metadata {
117     ovs_be64 tun_id;                 /* Encapsulating tunnel ID. */
118     ovs_be64 metadata;               /* OpenFlow 1.1+ metadata field. */
119     uint32_t regs[FLOW_N_REGS];      /* Registers. */
120     uint16_t in_port;                /* OpenFlow port or zero. */
121 };
122
123 void flow_extract(struct ofpbuf *, uint32_t priority, uint32_t mark,
124                   const struct flow_tnl *, uint16_t in_port, struct flow *);
125 void flow_zero_wildcards(struct flow *, const struct flow_wildcards *);
126 void flow_get_metadata(const struct flow *, struct flow_metadata *);
127
128 char *flow_to_string(const struct flow *);
129 void format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t),
130                   uint32_t flags, char del);
131
132 void flow_format(struct ds *, const struct flow *);
133 void flow_print(FILE *, const struct flow *);
134 static inline int flow_compare_3way(const struct flow *, const struct flow *);
135 static inline bool flow_equal(const struct flow *, const struct flow *);
136 static inline size_t flow_hash(const struct flow *, uint32_t basis);
137
138 void flow_set_dl_vlan(struct flow *, ovs_be16 vid);
139 void flow_set_vlan_vid(struct flow *, ovs_be16 vid);
140 void flow_set_vlan_pcp(struct flow *, uint8_t pcp);
141
142 void flow_compose(struct ofpbuf *, const struct flow *);
143
144 static inline int
145 flow_compare_3way(const struct flow *a, const struct flow *b)
146 {
147     return memcmp(a, b, sizeof *a);
148 }
149
150 static inline bool
151 flow_equal(const struct flow *a, const struct flow *b)
152 {
153     return !flow_compare_3way(a, b);
154 }
155
156 static inline size_t
157 flow_hash(const struct flow *flow, uint32_t basis)
158 {
159     return hash_words((const uint32_t *) flow, sizeof *flow / 4, basis);
160 }
161
162 uint32_t flow_hash_in_minimask(const struct flow *, const struct minimask *,
163                                uint32_t basis);
164 \f
165 /* Wildcards for a flow.
166  *
167  * A 1-bit in each bit in 'masks' indicates that the corresponding bit of
168  * the flow is significant (must match).  A 0-bit indicates that the
169  * corresponding bit of the flow is wildcarded (need not match). */
170 struct flow_wildcards {
171     struct flow masks;
172 };
173
174 void flow_wildcards_init_catchall(struct flow_wildcards *);
175 void flow_wildcards_init_exact(struct flow_wildcards *);
176
177 bool flow_wildcards_is_catchall(const struct flow_wildcards *);
178
179 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
180                                  int idx, uint32_t mask);
181
182 void flow_wildcards_combine(struct flow_wildcards *dst,
183                             const struct flow_wildcards *src1,
184                             const struct flow_wildcards *src2);
185 bool flow_wildcards_has_extra(const struct flow_wildcards *,
186                               const struct flow_wildcards *);
187
188 uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis);
189 bool flow_wildcards_equal(const struct flow_wildcards *,
190                           const struct flow_wildcards *);
191 uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
192
193 uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields,
194                           uint16_t basis);
195 const char *flow_hash_fields_to_str(enum nx_hash_fields);
196 bool flow_hash_fields_valid(enum nx_hash_fields);
197
198 bool flow_equal_except(const struct flow *a, const struct flow *b,
199                        const struct flow_wildcards *);
200 \f
201 /* Compressed flow. */
202
203 #define MINI_N_INLINE (sizeof(void *) == 4 ? 7 : 8)
204 #define MINI_N_MAPS DIV_ROUND_UP(FLOW_U32S, 32)
205
206 /* A sparse representation of a "struct flow".
207  *
208  * A "struct flow" is fairly large and tends to be mostly zeros.  Sparse
209  * representation has two advantages.  First, it saves memory.  Second, it
210  * saves time when the goal is to iterate over only the nonzero parts of the
211  * struct.
212  *
213  * The 'map' member holds one bit for each uint32_t in a "struct flow".  Each
214  * 0-bit indicates that the corresponding uint32_t is zero, each 1-bit that it
215  * is nonzero.
216  *
217  * 'values' points to the start of an array that has one element for each 1-bit
218  * in 'map'.  The least-numbered 1-bit is in values[0], the next 1-bit is in
219  * values[1], and so on.
220  *
221  * 'values' may point to a few different locations:
222  *
223  *     - If 'map' has MINI_N_INLINE or fewer 1-bits, it may point to
224  *       'inline_values'.  One hopes that this is the common case.
225  *
226  *     - If 'map' has more than MINI_N_INLINE 1-bits, it may point to memory
227  *       allocated with malloc().
228  *
229  *     - The caller could provide storage on the stack for situations where
230  *       that makes sense.  So far that's only proved useful for
231  *       minimask_combine(), but the principle works elsewhere.
232  *
233  * The implementation maintains and depends on the invariant that every element
234  * in 'values' is nonzero; that is, wherever a 1-bit appears in 'map', the
235  * corresponding element of 'values' must be nonzero.
236  */
237 struct miniflow {
238     uint32_t *values;
239     uint32_t inline_values[MINI_N_INLINE];
240     uint32_t map[MINI_N_MAPS];
241 };
242
243 void miniflow_init(struct miniflow *, const struct flow *);
244 void miniflow_clone(struct miniflow *, const struct miniflow *);
245 void miniflow_destroy(struct miniflow *);
246
247 void miniflow_expand(const struct miniflow *, struct flow *);
248
249 uint32_t miniflow_get(const struct miniflow *, unsigned int u32_ofs);
250 uint16_t miniflow_get_vid(const struct miniflow *);
251
252 bool miniflow_equal(const struct miniflow *a, const struct miniflow *b);
253 bool miniflow_equal_in_minimask(const struct miniflow *a,
254                                 const struct miniflow *b,
255                                 const struct minimask *);
256 bool miniflow_equal_flow_in_minimask(const struct miniflow *a,
257                                      const struct flow *b,
258                                      const struct minimask *);
259 uint32_t miniflow_hash(const struct miniflow *, uint32_t basis);
260 uint32_t miniflow_hash_in_minimask(const struct miniflow *,
261                                    const struct minimask *, uint32_t basis);
262 \f
263 /* Compressed flow wildcards. */
264
265 /* A sparse representation of a "struct flow_wildcards".
266  *
267  * See the large comment on struct miniflow for details. */
268 struct minimask {
269     struct miniflow masks;
270 };
271
272 void minimask_init(struct minimask *, const struct flow_wildcards *);
273 void minimask_clone(struct minimask *, const struct minimask *);
274 void minimask_combine(struct minimask *dst,
275                       const struct minimask *a, const struct minimask *b,
276                       uint32_t storage[FLOW_U32S]);
277 void minimask_destroy(struct minimask *);
278
279 void minimask_expand(const struct minimask *, struct flow_wildcards *);
280
281 uint32_t minimask_get(const struct minimask *, unsigned int u32_ofs);
282 uint16_t minimask_get_vid_mask(const struct minimask *);
283
284 bool minimask_equal(const struct minimask *a, const struct minimask *b);
285 uint32_t minimask_hash(const struct minimask *, uint32_t basis);
286
287 bool minimask_has_extra(const struct minimask *, const struct minimask *);
288 bool minimask_is_catchall(const struct minimask *);
289
290 #endif /* flow.h */