]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
4930ea56 | 2 | * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 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 | ||
17 | #ifndef ODP_UTIL_H | |
18 | #define ODP_UTIL_H 1 | |
19 | ||
20 | #include <stdbool.h> | |
3762274e | 21 | #include <stddef.h> |
064af421 | 22 | #include <stdint.h> |
14608a15 | 23 | #include <string.h> |
94f4d447 | 24 | #include "flow.h" |
14608a15 | 25 | #include "hash.h" |
ee89ea7b | 26 | #include "openvswitch/hmap.h" |
4930ea56 | 27 | #include "openvswitch/ofp-actions.h" |
837eefc7 | 28 | #include "odp-netlink.h" |
064af421 | 29 | #include "openflow/openflow.h" |
9026bf34 | 30 | #include "util.h" |
064af421 BP |
31 | |
32 | struct ds; | |
5fa27009 | 33 | struct nlattr; |
36956a7d | 34 | struct ofpbuf; |
44bac24b | 35 | struct simap; |
758c456d | 36 | struct pkt_metadata; |
064af421 | 37 | |
7fd91025 BP |
38 | #define SLOW_PATH_REASONS \ |
39 | /* These reasons are mutually exclusive. */ \ | |
40 | SPR(SLOW_CFM, "cfm", "Consists of CFM packets") \ | |
41 | SPR(SLOW_BFD, "bfd", "Consists of BFD packets") \ | |
42 | SPR(SLOW_LACP, "lacp", "Consists of LACP packets") \ | |
43 | SPR(SLOW_STP, "stp", "Consists of STP packets") \ | |
0477baa9 | 44 | SPR(SLOW_LLDP, "lldp", "Consists of LLDP packets") \ |
7fd91025 BP |
45 | SPR(SLOW_CONTROLLER, "controller", \ |
46 | "Sends \"packet-in\" messages to the OpenFlow controller") \ | |
47 | SPR(SLOW_ACTION, "action", \ | |
48 | "Uses action(s) not supported by datapath") | |
49 | ||
50 | /* Indexes for slow-path reasons. Client code uses "enum slow_path_reason" | |
51 | * values instead of these, these are just a way to construct those. */ | |
52 | enum { | |
53 | #define SPR(ENUM, STRING, EXPLANATION) ENUM##_INDEX, | |
54 | SLOW_PATH_REASONS | |
55 | #undef SPR | |
56 | }; | |
57 | ||
58 | /* Reasons why a subfacet might not be fast-pathable. | |
59 | * | |
60 | * Each reason is a separate bit to allow reasons to be combined. */ | |
61 | enum slow_path_reason { | |
62 | #define SPR(ENUM, STRING, EXPLANATION) ENUM = 1 << ENUM##_INDEX, | |
63 | SLOW_PATH_REASONS | |
64 | #undef SPR | |
65 | }; | |
66 | ||
ea2735d3 JR |
67 | /* Mask of all slow_path_reasons. */ |
68 | enum { | |
69 | SLOW_PATH_REASON_MASK = 0 | |
70 | #define SPR(ENUM, STRING, EXPLANATION) | 1 << ENUM##_INDEX | |
71 | SLOW_PATH_REASONS | |
72 | #undef SPR | |
73 | }; | |
74 | ||
7fd91025 BP |
75 | const char *slow_path_reason_to_explanation(enum slow_path_reason); |
76 | ||
4e022ec0 AW |
77 | #define ODPP_LOCAL ODP_PORT_C(OVSP_LOCAL) |
78 | #define ODPP_NONE ODP_PORT_C(UINT32_MAX) | |
c75d4dcf | 79 | |
cdee00fd BP |
80 | void format_odp_actions(struct ds *, const struct nlattr *odp_actions, |
81 | size_t actions_len); | |
44bac24b | 82 | int odp_actions_from_string(const char *, const struct simap *port_names, |
7202cbe5 | 83 | struct ofpbuf *odp_actions); |
064af421 | 84 | |
0a37839c GS |
85 | /* A map from odp port number to its name. */ |
86 | struct odp_portno_names { | |
87 | struct hmap_node hmap_node; /* A node in a port number to name hmap. */ | |
88 | odp_port_t port_no; /* Port number in the datapath. */ | |
89 | char *name; /* Name associated with the above 'port_no'. */ | |
90 | }; | |
91 | ||
92 | void odp_portno_names_set(struct hmap *portno_names, odp_port_t port_no, | |
93 | char *port_name); | |
94 | void odp_portno_names_destroy(struct hmap *portno_names); | |
2508ac16 BP |
95 | /* The maximum number of bytes that odp_flow_key_from_flow() appends to a |
96 | * buffer. This is the upper bound on the length of a nlattr-formatted flow | |
97 | * key that ovs-vswitchd fully understands. | |
98 | * | |
99 | * OVS doesn't insist that ovs-vswitchd and the datapath have exactly the same | |
100 | * idea of a flow, so therefore this value isn't necessarily an upper bound on | |
101 | * the length of a flow key that the datapath can pass to ovs-vswitchd. | |
102 | * | |
103 | * The longest nlattr-formatted flow key appended by odp_flow_key_from_flow() | |
104 | * would be: | |
36956a7d | 105 | * |
354d4c98 PS |
106 | * struct pad nl hdr total |
107 | * ------ --- ------ ----- | |
108 | * OVS_KEY_ATTR_PRIORITY 4 -- 4 8 | |
354d4c98 PS |
109 | * OVS_KEY_ATTR_TUNNEL 0 -- 4 4 |
110 | * - OVS_TUNNEL_KEY_ATTR_ID 8 -- 4 12 | |
111 | * - OVS_TUNNEL_KEY_ATTR_IPV4_SRC 4 -- 4 8 | |
112 | * - OVS_TUNNEL_KEY_ATTR_IPV4_DST 4 -- 4 8 | |
ffe4c74f JB |
113 | * - OVS_TUNNEL_KEY_ATTR_IPV6_SRC 16 -- 4 20 |
114 | * - OVS_TUNNEL_KEY_ATTR_IPV6_DST 16 -- 4 20 | |
354d4c98 PS |
115 | * - OVS_TUNNEL_KEY_ATTR_TOS 1 3 4 8 |
116 | * - OVS_TUNNEL_KEY_ATTR_TTL 1 3 4 8 | |
117 | * - OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT 0 -- 4 4 | |
118 | * - OVS_TUNNEL_KEY_ATTR_CSUM 0 -- 4 4 | |
94872594 | 119 | * - OVS_TUNNEL_KEY_ATTR_OAM 0 -- 4 4 |
c1fc1411 | 120 | * - OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS 256 -- 4 260 |
ac6073e3 | 121 | * - OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS - -- - - (shared with _GENEVE_OPTS) |
354d4c98 PS |
122 | * OVS_KEY_ATTR_IN_PORT 4 -- 4 8 |
123 | * OVS_KEY_ATTR_SKB_MARK 4 -- 4 8 | |
b96986ed AZ |
124 | * OVS_KEY_ATTR_DP_HASH 4 -- 4 8 |
125 | * OVS_KEY_ATTR_RECIRC_ID 4 -- 4 8 | |
07659514 JS |
126 | * OVS_KEY_ATTR_CT_STATE 4 -- 4 8 |
127 | * OVS_KEY_ATTR_CT_ZONE 2 2 4 8 | |
8e53fe8c | 128 | * OVS_KEY_ATTR_CT_MARK 4 -- 4 8 |
9daf2348 | 129 | * OVS_KEY_ATTR_CT_LABEL 16 -- 4 20 |
daf4d3c1 | 130 | * OVS_KEY_ATTR_CT_ORIG_TUPLE_IPV6 40 -- 4 44 |
354d4c98 PS |
131 | * OVS_KEY_ATTR_ETHERNET 12 -- 4 16 |
132 | * OVS_KEY_ATTR_ETHERTYPE 2 2 4 8 (outer VLAN ethertype) | |
a445095f | 133 | * OVS_KEY_ATTR_VLAN 2 2 4 8 |
354d4c98 PS |
134 | * OVS_KEY_ATTR_ENCAP 0 -- 4 4 (VLAN encapsulation) |
135 | * OVS_KEY_ATTR_ETHERTYPE 2 2 4 8 (inner VLAN ethertype) | |
136 | * OVS_KEY_ATTR_IPV6 40 -- 4 44 | |
137 | * OVS_KEY_ATTR_ICMPV6 2 2 4 8 | |
138 | * OVS_KEY_ATTR_ND 28 -- 4 32 | |
139 | * ---------------------------------------------------------- | |
daf4d3c1 | 140 | * total 616 |
2508ac16 BP |
141 | * |
142 | * We include some slack space in case the calculation isn't quite right or we | |
143 | * add another field and forget to adjust this value. | |
18c43631 | 144 | */ |
ffe4c74f | 145 | #define ODPUTIL_FLOW_KEY_BYTES 640 |
daf4d3c1 | 146 | BUILD_ASSERT_DECL(FLOW_WC_SEQ == 37); |
18c43631 | 147 | |
19cf4069 BP |
148 | /* A buffer with sufficient size and alignment to hold an nlattr-formatted flow |
149 | * key. An array of "struct nlattr" might not, in theory, be sufficiently | |
150 | * aligned because it only contains 16-bit types. */ | |
151 | struct odputil_keybuf { | |
152 | uint32_t keybuf[DIV_ROUND_UP(ODPUTIL_FLOW_KEY_BYTES, 4)]; | |
153 | }; | |
14608a15 | 154 | |
8d8ab6c2 | 155 | enum odp_key_fitness odp_tun_key_from_attr(const struct nlattr *, |
617e10e7 SH |
156 | struct flow_tnl *); |
157 | ||
534a19b9 | 158 | int odp_ufid_from_string(const char *s_, ovs_u128 *ufid); |
70e5ed6f | 159 | void odp_format_ufid(const ovs_u128 *ufid, struct ds *); |
8d8ab6c2 | 160 | |
e6cc0bab AZ |
161 | void odp_flow_format(const struct nlattr *key, size_t key_len, |
162 | const struct nlattr *mask, size_t mask_len, | |
0a37839c GS |
163 | const struct hmap *portno_names, struct ds *, |
164 | bool verbose); | |
36956a7d | 165 | void odp_flow_key_format(const struct nlattr *, size_t, struct ds *); |
e6cc0bab AZ |
166 | int odp_flow_from_string(const char *s, |
167 | const struct simap *port_names, | |
168 | struct ofpbuf *, struct ofpbuf *); | |
14608a15 | 169 | |
2494ccd7 JS |
170 | /* Indicates support for various fields. This defines how flows will be |
171 | * serialised. */ | |
172 | struct odp_support { | |
173 | /* Maximum number of MPLS label stack entries to serialise in a mask. */ | |
174 | size_t max_mpls_depth; | |
175 | ||
176 | /* If this is true, then recirculation fields will always be serialised. */ | |
177 | bool recirc; | |
07659514 JS |
178 | |
179 | /* If true, serialise the corresponding OVS_KEY_ATTR_CONN_* field. */ | |
180 | bool ct_state; | |
181 | bool ct_zone; | |
8e53fe8c | 182 | bool ct_mark; |
9daf2348 | 183 | bool ct_label; |
7b27258c DDP |
184 | |
185 | /* If true, it means that the datapath supports the NAT bits in | |
186 | * 'ct_state'. The above 'ct_state' member must be true for this | |
187 | * to make sense */ | |
188 | bool ct_state_nat; | |
daf4d3c1 JR |
189 | |
190 | bool ct_orig_tuple; /* Conntrack original direction tuple matching | |
191 | * supported. */ | |
2494ccd7 JS |
192 | }; |
193 | ||
5262eea1 JG |
194 | struct odp_flow_key_parms { |
195 | /* The flow and mask to be serialized. In the case of masks, 'flow' | |
196 | * is used as a template to determine how to interpret 'mask'. For | |
197 | * example, the 'dl_type' of 'mask' describes the mask, but it doesn't | |
198 | * indicate whether the other fields should be interpreted as ARP, IPv4, | |
199 | * IPv6, etc. */ | |
200 | const struct flow *flow; | |
201 | const struct flow *mask; | |
202 | ||
2494ccd7 JS |
203 | /* Indicates support for various fields. If the datapath supports a field, |
204 | * then it will always be serialised. */ | |
205 | struct odp_support support; | |
ec1f6f32 JG |
206 | |
207 | /* The netlink formatted version of the flow. It is used in cases where | |
208 | * the mask cannot be constructed from the OVS internal representation | |
209 | * and needs to see the original form. */ | |
210 | const struct ofpbuf *key_buf; | |
5262eea1 JG |
211 | }; |
212 | ||
213 | void odp_flow_key_from_flow(const struct odp_flow_key_parms *, struct ofpbuf *); | |
214 | void odp_flow_key_from_mask(const struct odp_flow_key_parms *, struct ofpbuf *); | |
b0f7b9b5 BP |
215 | |
216 | uint32_t odp_flow_key_hash(const struct nlattr *, size_t); | |
217 | ||
758c456d JR |
218 | /* Estimated space needed for metadata. */ |
219 | enum { ODP_KEY_METADATA_SIZE = 9 * 8 }; | |
220 | void odp_key_from_pkt_metadata(struct ofpbuf *, const struct pkt_metadata *); | |
221 | void odp_key_to_pkt_metadata(const struct nlattr *key, size_t key_len, | |
222 | struct pkt_metadata *md); | |
223 | ||
b0f7b9b5 BP |
224 | /* How well a kernel-provided flow key (a sequence of OVS_KEY_ATTR_* |
225 | * attributes) matches OVS userspace expectations. | |
226 | * | |
227 | * These values are arranged so that greater values are "more important" than | |
228 | * lesser ones. In particular, a single flow key can fit the descriptions for | |
229 | * both ODP_FIT_TOO_LITTLE and ODP_FIT_TOO_MUCH. Such a key is treated as | |
230 | * ODP_FIT_TOO_LITTLE. */ | |
231 | enum odp_key_fitness { | |
232 | ODP_FIT_PERFECT, /* The key had exactly the fields we expect. */ | |
233 | ODP_FIT_TOO_MUCH, /* The key had fields we don't understand. */ | |
234 | ODP_FIT_TOO_LITTLE, /* The key lacked fields we expected to see. */ | |
235 | ODP_FIT_ERROR, /* The key was invalid. */ | |
236 | }; | |
237 | enum odp_key_fitness odp_flow_key_to_flow(const struct nlattr *, size_t, | |
238 | struct flow *); | |
ec1f6f32 JG |
239 | enum odp_key_fitness odp_flow_key_to_mask(const struct nlattr *mask_key, |
240 | size_t mask_key_len, | |
ca8d3442 | 241 | struct flow_wildcards *mask, |
4a221615 | 242 | const struct flow *flow); |
6728d578 | 243 | |
6814e51f | 244 | const char *odp_key_fitness_to_string(enum odp_key_fitness); |
14608a15 | 245 | |
b9ad7294 EJ |
246 | void commit_odp_tunnel_action(const struct flow *, struct flow *base, |
247 | struct ofpbuf *odp_actions); | |
6d670e7f JR |
248 | void commit_masked_set_action(struct ofpbuf *odp_actions, |
249 | enum ovs_key_attr key_type, const void *key, | |
250 | const void *mask, size_t key_size); | |
7fd91025 BP |
251 | enum slow_path_reason commit_odp_actions(const struct flow *, |
252 | struct flow *base, | |
253 | struct ofpbuf *odp_actions, | |
d23df9a8 JR |
254 | struct flow_wildcards *wc, |
255 | bool use_masked); | |
6a7e895f BP |
256 | \f |
257 | /* ofproto-dpif interface. | |
258 | * | |
259 | * The following types and functions are logically part of ofproto-dpif. | |
260 | * ofproto-dpif puts values of these types into the flows that it installs in | |
261 | * the kernel datapath, though, so ovs-dpctl needs to interpret them so that | |
262 | * it can print flows in a more human-readable manner. */ | |
263 | ||
6ff686f2 PS |
264 | enum user_action_cookie_type { |
265 | USER_ACTION_COOKIE_UNSPEC, | |
29089a54 RL |
266 | USER_ACTION_COOKIE_SFLOW, /* Packet for per-bridge sFlow sampling. */ |
267 | USER_ACTION_COOKIE_SLOW_PATH, /* Userspace must process this flow. */ | |
268 | USER_ACTION_COOKIE_FLOW_SAMPLE, /* Packet for per-flow sampling. */ | |
269 | USER_ACTION_COOKIE_IPFIX, /* Packet for per-bridge IPFIX sampling. */ | |
6ff686f2 PS |
270 | }; |
271 | ||
d8ec8318 | 272 | /* user_action_cookie is passed as argument to OVS_ACTION_ATTR_USERSPACE. */ |
1673e0e4 | 273 | union user_action_cookie { |
36fc5f18 BP |
274 | uint16_t type; /* enum user_action_cookie_type. */ |
275 | ||
1673e0e4 BP |
276 | struct { |
277 | uint16_t type; /* USER_ACTION_COOKIE_SFLOW. */ | |
278 | ovs_be16 vlan_tci; /* Destination VLAN TCI. */ | |
279 | uint32_t output; /* SFL_FLOW_SAMPLE_TYPE 'output' value. */ | |
280 | } sflow; | |
6ff686f2 | 281 | |
6a7e895f BP |
282 | struct { |
283 | uint16_t type; /* USER_ACTION_COOKIE_SLOW_PATH. */ | |
284 | uint16_t unused; | |
285 | uint32_t reason; /* enum slow_path_reason. */ | |
286 | } slow_path; | |
29089a54 RL |
287 | |
288 | struct { | |
289 | uint16_t type; /* USER_ACTION_COOKIE_FLOW_SAMPLE. */ | |
290 | uint16_t probability; /* Sampling probability. */ | |
291 | uint32_t collector_set_id; /* ID of IPFIX collector set. */ | |
292 | uint32_t obs_domain_id; /* Observation Domain ID. */ | |
293 | uint32_t obs_point_id; /* Observation Point ID. */ | |
f69f713b | 294 | odp_port_t output_odp_port; /* The output odp port. */ |
4930ea56 | 295 | enum nx_action_sample_direction direction; |
29089a54 RL |
296 | } flow_sample; |
297 | ||
298 | struct { | |
8b7ea2d4 WZ |
299 | uint16_t type; /* USER_ACTION_COOKIE_IPFIX. */ |
300 | odp_port_t output_odp_port; /* The output odp port. */ | |
29089a54 | 301 | } ipfix; |
6a7e895f | 302 | }; |
4930ea56 | 303 | BUILD_ASSERT_DECL(sizeof(union user_action_cookie) == 24); |
6ff686f2 | 304 | |
39db78a0 | 305 | size_t odp_put_userspace_action(uint32_t pid, |
e995e3df | 306 | const void *userdata, size_t userdata_size, |
8b7ea2d4 | 307 | odp_port_t tunnel_out_port, |
7321bda3 | 308 | bool include_actions, |
39db78a0 | 309 | struct ofpbuf *odp_actions); |
b9ad7294 EJ |
310 | void odp_put_tunnel_action(const struct flow_tnl *tunnel, |
311 | struct ofpbuf *odp_actions); | |
5bbda0aa | 312 | |
a36de779 PS |
313 | void odp_put_tnl_push_action(struct ofpbuf *odp_actions, |
314 | struct ovs_action_push_tnl *data); | |
064af421 | 315 | #endif /* odp-util.h */ |