]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
e0edde6f | 2 | * Copyright (c) 2008, 2009, 2010, 2011, 2012 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 | #include <config.h> | |
96fba48f | 18 | #include "dpif-provider.h" |
064af421 | 19 | |
064af421 BP |
20 | #include <ctype.h> |
21 | #include <errno.h> | |
064af421 | 22 | #include <inttypes.h> |
064af421 BP |
23 | #include <stdlib.h> |
24 | #include <string.h> | |
064af421 BP |
25 | |
26 | #include "coverage.h" | |
27 | #include "dynamic-string.h" | |
28 | #include "flow.h" | |
c3827f61 | 29 | #include "netdev.h" |
064af421 BP |
30 | #include "netlink.h" |
31 | #include "odp-util.h" | |
90bf1e07 | 32 | #include "ofp-errors.h" |
064af421 | 33 | #include "ofp-print.h" |
71ce9235 | 34 | #include "ofp-util.h" |
064af421 BP |
35 | #include "ofpbuf.h" |
36 | #include "packets.h" | |
37 | #include "poll-loop.h" | |
999401aa | 38 | #include "shash.h" |
d0c23a1a | 39 | #include "sset.h" |
c97fb132 | 40 | #include "timeval.h" |
064af421 BP |
41 | #include "util.h" |
42 | #include "valgrind.h" | |
064af421 | 43 | #include "vlog.h" |
5136ce49 | 44 | |
d98e6007 | 45 | VLOG_DEFINE_THIS_MODULE(dpif); |
064af421 | 46 | |
d76f09ea BP |
47 | COVERAGE_DEFINE(dpif_destroy); |
48 | COVERAGE_DEFINE(dpif_port_add); | |
49 | COVERAGE_DEFINE(dpif_port_del); | |
50 | COVERAGE_DEFINE(dpif_flow_flush); | |
51 | COVERAGE_DEFINE(dpif_flow_get); | |
52 | COVERAGE_DEFINE(dpif_flow_put); | |
53 | COVERAGE_DEFINE(dpif_flow_del); | |
54 | COVERAGE_DEFINE(dpif_flow_query_list); | |
55 | COVERAGE_DEFINE(dpif_flow_query_list_n); | |
56 | COVERAGE_DEFINE(dpif_execute); | |
57 | COVERAGE_DEFINE(dpif_purge); | |
58 | ||
999401aa | 59 | static const struct dpif_class *base_dpif_classes[] = { |
361906b1 | 60 | #ifdef LINUX_DATAPATH |
96fba48f | 61 | &dpif_linux_class, |
c83cdd30 | 62 | #endif |
72865317 | 63 | &dpif_netdev_class, |
c228a364 | 64 | }; |
999401aa JG |
65 | |
66 | struct registered_dpif_class { | |
d2d8fbeb | 67 | const struct dpif_class *dpif_class; |
999401aa JG |
68 | int refcount; |
69 | }; | |
70 | static struct shash dpif_classes = SHASH_INITIALIZER(&dpif_classes); | |
579a77e0 | 71 | static struct sset dpif_blacklist = SSET_INITIALIZER(&dpif_blacklist); |
c228a364 | 72 | |
064af421 BP |
73 | /* Rate limit for individual messages going to or from the datapath, output at |
74 | * DBG level. This is very high because, if these are enabled, it is because | |
75 | * we really need to see them. */ | |
76 | static struct vlog_rate_limit dpmsg_rl = VLOG_RATE_LIMIT_INIT(600, 600); | |
77 | ||
78 | /* Not really much point in logging many dpif errors. */ | |
e2781405 | 79 | static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(60, 5); |
064af421 | 80 | |
feebdea2 BP |
81 | static void log_flow_message(const struct dpif *dpif, int error, |
82 | const char *operation, | |
83 | const struct nlattr *key, size_t key_len, | |
61fb711d | 84 | const struct nlattr *mask, size_t mask_len, |
c97fb132 | 85 | const struct dpif_flow_stats *stats, |
feebdea2 | 86 | const struct nlattr *actions, size_t actions_len); |
96fba48f BP |
87 | static void log_operation(const struct dpif *, const char *operation, |
88 | int error); | |
96fba48f | 89 | static bool should_log_flow_message(int error); |
89625d1e BP |
90 | static void log_flow_put_message(struct dpif *, const struct dpif_flow_put *, |
91 | int error); | |
b99d3cee BP |
92 | static void log_flow_del_message(struct dpif *, const struct dpif_flow_del *, |
93 | int error); | |
89625d1e BP |
94 | static void log_execute_message(struct dpif *, const struct dpif_execute *, |
95 | int error); | |
064af421 | 96 | |
999401aa JG |
97 | static void |
98 | dp_initialize(void) | |
99 | { | |
100 | static int status = -1; | |
101 | ||
102 | if (status < 0) { | |
103 | int i; | |
104 | ||
105 | status = 0; | |
106 | for (i = 0; i < ARRAY_SIZE(base_dpif_classes); i++) { | |
107 | dp_register_provider(base_dpif_classes[i]); | |
108 | } | |
109 | } | |
110 | } | |
111 | ||
999401aa JG |
112 | /* Registers a new datapath provider. After successful registration, new |
113 | * datapaths of that type can be opened using dpif_open(). */ | |
114 | int | |
115 | dp_register_provider(const struct dpif_class *new_class) | |
116 | { | |
117 | struct registered_dpif_class *registered_class; | |
118 | ||
579a77e0 EJ |
119 | if (sset_contains(&dpif_blacklist, new_class->type)) { |
120 | VLOG_DBG("attempted to register blacklisted provider: %s", | |
121 | new_class->type); | |
122 | return EINVAL; | |
123 | } | |
124 | ||
999401aa JG |
125 | if (shash_find(&dpif_classes, new_class->type)) { |
126 | VLOG_WARN("attempted to register duplicate datapath provider: %s", | |
127 | new_class->type); | |
128 | return EEXIST; | |
129 | } | |
1a6f1e2a | 130 | |
999401aa | 131 | registered_class = xmalloc(sizeof *registered_class); |
d2d8fbeb | 132 | registered_class->dpif_class = new_class; |
999401aa JG |
133 | registered_class->refcount = 0; |
134 | ||
135 | shash_add(&dpif_classes, new_class->type, registered_class); | |
136 | ||
137 | return 0; | |
138 | } | |
139 | ||
140 | /* Unregisters a datapath provider. 'type' must have been previously | |
141 | * registered and not currently be in use by any dpifs. After unregistration | |
142 | * new datapaths of that type cannot be opened using dpif_open(). */ | |
143 | int | |
144 | dp_unregister_provider(const char *type) | |
145 | { | |
146 | struct shash_node *node; | |
147 | struct registered_dpif_class *registered_class; | |
148 | ||
149 | node = shash_find(&dpif_classes, type); | |
150 | if (!node) { | |
151 | VLOG_WARN("attempted to unregister a datapath provider that is not " | |
152 | "registered: %s", type); | |
153 | return EAFNOSUPPORT; | |
154 | } | |
155 | ||
156 | registered_class = node->data; | |
157 | if (registered_class->refcount) { | |
158 | VLOG_WARN("attempted to unregister in use datapath provider: %s", type); | |
159 | return EBUSY; | |
160 | } | |
161 | ||
162 | shash_delete(&dpif_classes, node); | |
163 | free(registered_class); | |
164 | ||
165 | return 0; | |
166 | } | |
167 | ||
579a77e0 EJ |
168 | /* Blacklists a provider. Causes future calls of dp_register_provider() with |
169 | * a dpif_class which implements 'type' to fail. */ | |
170 | void | |
171 | dp_blacklist_provider(const char *type) | |
172 | { | |
173 | sset_add(&dpif_blacklist, type); | |
174 | } | |
175 | ||
999401aa | 176 | /* Clears 'types' and enumerates the types of all currently registered datapath |
d0c23a1a | 177 | * providers into it. The caller must first initialize the sset. */ |
1a6f1e2a | 178 | void |
d0c23a1a | 179 | dp_enumerate_types(struct sset *types) |
1a6f1e2a | 180 | { |
999401aa | 181 | struct shash_node *node; |
1a6f1e2a | 182 | |
999401aa | 183 | dp_initialize(); |
d0c23a1a | 184 | sset_clear(types); |
1a6f1e2a | 185 | |
999401aa JG |
186 | SHASH_FOR_EACH(node, &dpif_classes) { |
187 | const struct registered_dpif_class *registered_class = node->data; | |
d0c23a1a | 188 | sset_add(types, registered_class->dpif_class->type); |
1a6f1e2a JG |
189 | } |
190 | } | |
191 | ||
192 | /* Clears 'names' and enumerates the names of all known created datapaths with | |
d0c23a1a | 193 | * the given 'type'. The caller must first initialize the sset. Returns 0 if |
1a6f1e2a | 194 | * successful, otherwise a positive errno value. |
d3d22744 BP |
195 | * |
196 | * Some kinds of datapaths might not be practically enumerable. This is not | |
197 | * considered an error. */ | |
198 | int | |
d0c23a1a | 199 | dp_enumerate_names(const char *type, struct sset *names) |
d3d22744 | 200 | { |
999401aa JG |
201 | const struct registered_dpif_class *registered_class; |
202 | const struct dpif_class *dpif_class; | |
203 | int error; | |
d3d22744 | 204 | |
999401aa | 205 | dp_initialize(); |
d0c23a1a | 206 | sset_clear(names); |
1a6f1e2a | 207 | |
999401aa JG |
208 | registered_class = shash_find_data(&dpif_classes, type); |
209 | if (!registered_class) { | |
210 | VLOG_WARN("could not enumerate unknown type: %s", type); | |
211 | return EAFNOSUPPORT; | |
212 | } | |
1a6f1e2a | 213 | |
d2d8fbeb | 214 | dpif_class = registered_class->dpif_class; |
999401aa | 215 | error = dpif_class->enumerate ? dpif_class->enumerate(names) : 0; |
1a6f1e2a | 216 | |
999401aa JG |
217 | if (error) { |
218 | VLOG_WARN("failed to enumerate %s datapaths: %s", dpif_class->type, | |
219 | strerror(error)); | |
d3d22744 | 220 | } |
1a6f1e2a | 221 | |
999401aa | 222 | return error; |
1a6f1e2a JG |
223 | } |
224 | ||
54ed8a5d BP |
225 | /* Parses 'datapath_name_', which is of the form [type@]name into its |
226 | * component pieces. 'name' and 'type' must be freed by the caller. | |
227 | * | |
228 | * The returned 'type' is normalized, as if by dpif_normalize_type(). */ | |
1a6f1e2a JG |
229 | void |
230 | dp_parse_name(const char *datapath_name_, char **name, char **type) | |
231 | { | |
232 | char *datapath_name = xstrdup(datapath_name_); | |
233 | char *separator; | |
234 | ||
235 | separator = strchr(datapath_name, '@'); | |
236 | if (separator) { | |
237 | *separator = '\0'; | |
238 | *type = datapath_name; | |
54ed8a5d | 239 | *name = xstrdup(dpif_normalize_type(separator + 1)); |
1a6f1e2a JG |
240 | } else { |
241 | *name = datapath_name; | |
54ed8a5d | 242 | *type = xstrdup(dpif_normalize_type(NULL)); |
1a6f1e2a | 243 | } |
d3d22744 BP |
244 | } |
245 | ||
96fba48f | 246 | static int |
1a6f1e2a | 247 | do_open(const char *name, const char *type, bool create, struct dpif **dpifp) |
064af421 | 248 | { |
96fba48f | 249 | struct dpif *dpif = NULL; |
064af421 | 250 | int error; |
999401aa JG |
251 | struct registered_dpif_class *registered_class; |
252 | ||
253 | dp_initialize(); | |
064af421 | 254 | |
3a225db7 | 255 | type = dpif_normalize_type(type); |
064af421 | 256 | |
999401aa JG |
257 | registered_class = shash_find_data(&dpif_classes, type); |
258 | if (!registered_class) { | |
259 | VLOG_WARN("could not create datapath %s of unknown type %s", name, | |
260 | type); | |
261 | error = EAFNOSUPPORT; | |
262 | goto exit; | |
263 | } | |
264 | ||
4a387741 BP |
265 | error = registered_class->dpif_class->open(registered_class->dpif_class, |
266 | name, create, &dpif); | |
999401aa | 267 | if (!error) { |
cb22974d | 268 | ovs_assert(dpif->dpif_class == registered_class->dpif_class); |
999401aa | 269 | registered_class->refcount++; |
064af421 | 270 | } |
064af421 | 271 | |
96fba48f BP |
272 | exit: |
273 | *dpifp = error ? NULL : dpif; | |
274 | return error; | |
064af421 BP |
275 | } |
276 | ||
1a6f1e2a JG |
277 | /* Tries to open an existing datapath named 'name' and type 'type'. Will fail |
278 | * if no datapath with 'name' and 'type' exists. 'type' may be either NULL or | |
279 | * the empty string to specify the default system type. Returns 0 if | |
280 | * successful, otherwise a positive errno value. On success stores a pointer | |
281 | * to the datapath in '*dpifp', otherwise a null pointer. */ | |
96fba48f | 282 | int |
1a6f1e2a | 283 | dpif_open(const char *name, const char *type, struct dpif **dpifp) |
064af421 | 284 | { |
1a6f1e2a | 285 | return do_open(name, type, false, dpifp); |
064af421 BP |
286 | } |
287 | ||
1a6f1e2a JG |
288 | /* Tries to create and open a new datapath with the given 'name' and 'type'. |
289 | * 'type' may be either NULL or the empty string to specify the default system | |
290 | * type. Will fail if a datapath with 'name' and 'type' already exists. | |
291 | * Returns 0 if successful, otherwise a positive errno value. On success | |
292 | * stores a pointer to the datapath in '*dpifp', otherwise a null pointer. */ | |
064af421 | 293 | int |
1a6f1e2a | 294 | dpif_create(const char *name, const char *type, struct dpif **dpifp) |
064af421 | 295 | { |
1a6f1e2a | 296 | return do_open(name, type, true, dpifp); |
96fba48f | 297 | } |
064af421 | 298 | |
1a6f1e2a JG |
299 | /* Tries to open a datapath with the given 'name' and 'type', creating it if it |
300 | * does not exist. 'type' may be either NULL or the empty string to specify | |
301 | * the default system type. Returns 0 if successful, otherwise a positive | |
302 | * errno value. On success stores a pointer to the datapath in '*dpifp', | |
303 | * otherwise a null pointer. */ | |
efacbce6 | 304 | int |
1a6f1e2a | 305 | dpif_create_and_open(const char *name, const char *type, struct dpif **dpifp) |
efacbce6 BP |
306 | { |
307 | int error; | |
308 | ||
1a6f1e2a | 309 | error = dpif_create(name, type, dpifp); |
efacbce6 | 310 | if (error == EEXIST || error == EBUSY) { |
1a6f1e2a | 311 | error = dpif_open(name, type, dpifp); |
efacbce6 BP |
312 | if (error) { |
313 | VLOG_WARN("datapath %s already exists but cannot be opened: %s", | |
314 | name, strerror(error)); | |
315 | } | |
316 | } else if (error) { | |
317 | VLOG_WARN("failed to create datapath %s: %s", name, strerror(error)); | |
318 | } | |
319 | return error; | |
320 | } | |
321 | ||
96fba48f BP |
322 | /* Closes and frees the connection to 'dpif'. Does not destroy the datapath |
323 | * itself; call dpif_delete() first, instead, if that is desirable. */ | |
324 | void | |
325 | dpif_close(struct dpif *dpif) | |
326 | { | |
327 | if (dpif) { | |
999401aa JG |
328 | struct registered_dpif_class *registered_class; |
329 | ||
d295e8e9 | 330 | registered_class = shash_find_data(&dpif_classes, |
a4af0040 | 331 | dpif->dpif_class->type); |
cb22974d BP |
332 | ovs_assert(registered_class); |
333 | ovs_assert(registered_class->refcount); | |
999401aa JG |
334 | |
335 | registered_class->refcount--; | |
336 | dpif_uninit(dpif, true); | |
064af421 BP |
337 | } |
338 | } | |
339 | ||
640e1b20 BP |
340 | /* Performs periodic work needed by 'dpif'. */ |
341 | void | |
342 | dpif_run(struct dpif *dpif) | |
343 | { | |
344 | if (dpif->dpif_class->run) { | |
345 | dpif->dpif_class->run(dpif); | |
346 | } | |
347 | } | |
348 | ||
349 | /* Arranges for poll_block() to wake up when dp_run() needs to be called for | |
350 | * 'dpif'. */ | |
351 | void | |
352 | dpif_wait(struct dpif *dpif) | |
353 | { | |
354 | if (dpif->dpif_class->wait) { | |
355 | dpif->dpif_class->wait(dpif); | |
356 | } | |
357 | } | |
358 | ||
1a6f1e2a JG |
359 | /* Returns the name of datapath 'dpif' prefixed with the type |
360 | * (for use in log messages). */ | |
b29ba128 BP |
361 | const char * |
362 | dpif_name(const struct dpif *dpif) | |
363 | { | |
1a6f1e2a JG |
364 | return dpif->full_name; |
365 | } | |
366 | ||
367 | /* Returns the name of datapath 'dpif' without the type | |
368 | * (for use in device names). */ | |
369 | const char * | |
370 | dpif_base_name(const struct dpif *dpif) | |
371 | { | |
372 | return dpif->base_name; | |
b29ba128 BP |
373 | } |
374 | ||
c7a26215 JP |
375 | /* Returns the type of datapath 'dpif'. */ |
376 | const char * | |
377 | dpif_type(const struct dpif *dpif) | |
378 | { | |
379 | return dpif->dpif_class->type; | |
380 | } | |
381 | ||
3a225db7 BP |
382 | /* Returns the fully spelled out name for the given datapath 'type'. |
383 | * | |
384 | * Normalized type string can be compared with strcmp(). Unnormalized type | |
385 | * string might be the same even if they have different spellings. */ | |
386 | const char * | |
387 | dpif_normalize_type(const char *type) | |
388 | { | |
389 | return type && type[0] ? type : "system"; | |
390 | } | |
391 | ||
96fba48f BP |
392 | /* Destroys the datapath that 'dpif' is connected to, first removing all of its |
393 | * ports. After calling this function, it does not make sense to pass 'dpif' | |
394 | * to any functions other than dpif_name() or dpif_close(). */ | |
064af421 BP |
395 | int |
396 | dpif_delete(struct dpif *dpif) | |
397 | { | |
96fba48f BP |
398 | int error; |
399 | ||
064af421 | 400 | COVERAGE_INC(dpif_destroy); |
96fba48f | 401 | |
1acb6baa | 402 | error = dpif->dpif_class->destroy(dpif); |
96fba48f BP |
403 | log_operation(dpif, "delete", error); |
404 | return error; | |
064af421 BP |
405 | } |
406 | ||
96fba48f BP |
407 | /* Retrieves statistics for 'dpif' into 'stats'. Returns 0 if successful, |
408 | * otherwise a positive errno value. */ | |
064af421 | 409 | int |
a8d9304d | 410 | dpif_get_dp_stats(const struct dpif *dpif, struct dpif_dp_stats *stats) |
064af421 | 411 | { |
1acb6baa | 412 | int error = dpif->dpif_class->get_stats(dpif, stats); |
96fba48f BP |
413 | if (error) { |
414 | memset(stats, 0, sizeof *stats); | |
415 | } | |
416 | log_operation(dpif, "get_stats", error); | |
417 | return error; | |
064af421 BP |
418 | } |
419 | ||
0aeaabc8 JP |
420 | const char * |
421 | dpif_port_open_type(const char *datapath_type, const char *port_type) | |
422 | { | |
423 | struct registered_dpif_class *registered_class; | |
424 | ||
425 | datapath_type = dpif_normalize_type(datapath_type); | |
426 | ||
427 | registered_class = shash_find_data(&dpif_classes, datapath_type); | |
428 | if (!registered_class | |
429 | || !registered_class->dpif_class->port_open_type) { | |
430 | return port_type; | |
431 | } | |
432 | ||
433 | return registered_class->dpif_class->port_open_type( | |
434 | registered_class->dpif_class, port_type); | |
435 | } | |
436 | ||
232dfa4a | 437 | /* Attempts to add 'netdev' as a port on 'dpif'. If 'port_nop' is |
4e022ec0 | 438 | * non-null and its value is not ODPP_NONE, then attempts to use the |
232dfa4a JP |
439 | * value as the port number. |
440 | * | |
441 | * If successful, returns 0 and sets '*port_nop' to the new port's port | |
442 | * number (if 'port_nop' is non-null). On failure, returns a positive | |
4e022ec0 | 443 | * errno value and sets '*port_nop' to ODPP_NONE (if 'port_nop' is |
232dfa4a | 444 | * non-null). */ |
064af421 | 445 | int |
4e022ec0 | 446 | dpif_port_add(struct dpif *dpif, struct netdev *netdev, odp_port_t *port_nop) |
064af421 | 447 | { |
c3827f61 | 448 | const char *netdev_name = netdev_get_name(netdev); |
4e022ec0 | 449 | odp_port_t port_no = ODPP_NONE; |
9ee3ae3e | 450 | int error; |
064af421 BP |
451 | |
452 | COVERAGE_INC(dpif_port_add); | |
9ee3ae3e | 453 | |
232dfa4a JP |
454 | if (port_nop) { |
455 | port_no = *port_nop; | |
456 | } | |
457 | ||
c3827f61 | 458 | error = dpif->dpif_class->port_add(dpif, netdev, &port_no); |
9ee3ae3e | 459 | if (!error) { |
9b56fe13 | 460 | VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu32, |
c3827f61 | 461 | dpif_name(dpif), netdev_name, port_no); |
064af421 | 462 | } else { |
9ee3ae3e | 463 | VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s", |
c3827f61 | 464 | dpif_name(dpif), netdev_name, strerror(error)); |
4e022ec0 | 465 | port_no = ODPP_NONE; |
9ee3ae3e BP |
466 | } |
467 | if (port_nop) { | |
468 | *port_nop = port_no; | |
064af421 | 469 | } |
9ee3ae3e | 470 | return error; |
064af421 BP |
471 | } |
472 | ||
96fba48f BP |
473 | /* Attempts to remove 'dpif''s port number 'port_no'. Returns 0 if successful, |
474 | * otherwise a positive errno value. */ | |
064af421 | 475 | int |
4e022ec0 | 476 | dpif_port_del(struct dpif *dpif, odp_port_t port_no) |
064af421 | 477 | { |
96fba48f BP |
478 | int error; |
479 | ||
064af421 | 480 | COVERAGE_INC(dpif_port_del); |
96fba48f | 481 | |
1acb6baa | 482 | error = dpif->dpif_class->port_del(dpif, port_no); |
a1811296 | 483 | if (!error) { |
9b56fe13 | 484 | VLOG_DBG_RL(&dpmsg_rl, "%s: port_del(%"PRIu32")", |
a1811296 BP |
485 | dpif_name(dpif), port_no); |
486 | } else { | |
487 | log_operation(dpif, "port_del", error); | |
488 | } | |
96fba48f | 489 | return error; |
064af421 BP |
490 | } |
491 | ||
4c738a8d BP |
492 | /* Makes a deep copy of 'src' into 'dst'. */ |
493 | void | |
494 | dpif_port_clone(struct dpif_port *dst, const struct dpif_port *src) | |
495 | { | |
496 | dst->name = xstrdup(src->name); | |
497 | dst->type = xstrdup(src->type); | |
498 | dst->port_no = src->port_no; | |
499 | } | |
500 | ||
501 | /* Frees memory allocated to members of 'dpif_port'. | |
502 | * | |
503 | * Do not call this function on a dpif_port obtained from | |
504 | * dpif_port_dump_next(): that function retains ownership of the data in the | |
505 | * dpif_port. */ | |
506 | void | |
507 | dpif_port_destroy(struct dpif_port *dpif_port) | |
508 | { | |
509 | free(dpif_port->name); | |
510 | free(dpif_port->type); | |
511 | } | |
512 | ||
4afba28d JP |
513 | /* Checks if port named 'devname' exists in 'dpif'. If so, returns |
514 | * true; otherwise, returns false. */ | |
515 | bool | |
516 | dpif_port_exists(const struct dpif *dpif, const char *devname) | |
517 | { | |
518 | int error = dpif->dpif_class->port_query_by_name(dpif, devname, NULL); | |
bee6b8bc | 519 | if (error != 0 && error != ENOENT && error != ENODEV) { |
4afba28d JP |
520 | VLOG_WARN_RL(&error_rl, "%s: failed to query port %s: %s", |
521 | dpif_name(dpif), devname, strerror(error)); | |
522 | } | |
523 | ||
524 | return !error; | |
525 | } | |
526 | ||
96fba48f BP |
527 | /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and |
528 | * initializes '*port' appropriately; on failure, returns a positive errno | |
4c738a8d BP |
529 | * value. |
530 | * | |
531 | * The caller owns the data in 'port' and must free it with | |
532 | * dpif_port_destroy() when it is no longer needed. */ | |
064af421 | 533 | int |
4e022ec0 | 534 | dpif_port_query_by_number(const struct dpif *dpif, odp_port_t port_no, |
4c738a8d | 535 | struct dpif_port *port) |
064af421 | 536 | { |
1acb6baa | 537 | int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port); |
96fba48f | 538 | if (!error) { |
9b56fe13 | 539 | VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu32" is device %s", |
4c738a8d | 540 | dpif_name(dpif), port_no, port->name); |
064af421 | 541 | } else { |
96fba48f | 542 | memset(port, 0, sizeof *port); |
9b56fe13 | 543 | VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu32": %s", |
96fba48f | 544 | dpif_name(dpif), port_no, strerror(error)); |
064af421 | 545 | } |
96fba48f | 546 | return error; |
064af421 BP |
547 | } |
548 | ||
96fba48f BP |
549 | /* Looks up port named 'devname' in 'dpif'. On success, returns 0 and |
550 | * initializes '*port' appropriately; on failure, returns a positive errno | |
4c738a8d BP |
551 | * value. |
552 | * | |
553 | * The caller owns the data in 'port' and must free it with | |
554 | * dpif_port_destroy() when it is no longer needed. */ | |
064af421 BP |
555 | int |
556 | dpif_port_query_by_name(const struct dpif *dpif, const char *devname, | |
4c738a8d | 557 | struct dpif_port *port) |
064af421 | 558 | { |
1acb6baa | 559 | int error = dpif->dpif_class->port_query_by_name(dpif, devname, port); |
96fba48f | 560 | if (!error) { |
9b56fe13 | 561 | VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu32, |
4c738a8d | 562 | dpif_name(dpif), devname, port->port_no); |
064af421 | 563 | } else { |
96fba48f BP |
564 | memset(port, 0, sizeof *port); |
565 | ||
d647f0a7 BP |
566 | /* For ENOENT or ENODEV we use DBG level because the caller is probably |
567 | * interested in whether 'dpif' actually has a port 'devname', so that | |
568 | * it's not an issue worth logging if it doesn't. Other errors are | |
569 | * uncommon and more likely to indicate a real problem. */ | |
570 | VLOG_RL(&error_rl, | |
571 | error == ENOENT || error == ENODEV ? VLL_DBG : VLL_WARN, | |
572 | "%s: failed to query port %s: %s", | |
573 | dpif_name(dpif), devname, strerror(error)); | |
064af421 | 574 | } |
96fba48f | 575 | return error; |
064af421 BP |
576 | } |
577 | ||
996c1b3d BP |
578 | /* Returns one greater than the maximum port number accepted in flow |
579 | * actions. */ | |
4e022ec0 | 580 | odp_port_t |
996c1b3d BP |
581 | dpif_get_max_ports(const struct dpif *dpif) |
582 | { | |
583 | return dpif->dpif_class->get_max_ports(dpif); | |
584 | } | |
585 | ||
98403001 BP |
586 | /* Returns the Netlink PID value to supply in OVS_ACTION_ATTR_USERSPACE actions |
587 | * as the OVS_USERSPACE_ATTR_PID attribute's value, for use in flows whose | |
588 | * packets arrived on port 'port_no'. | |
589 | * | |
4e022ec0 | 590 | * A 'port_no' of ODPP_NONE is a special case: it returns a reserved PID, not |
625b0720 BP |
591 | * allocated to any port, that the client may use for special purposes. |
592 | * | |
98403001 BP |
593 | * The return value is only meaningful when DPIF_UC_ACTION has been enabled in |
594 | * the 'dpif''s listen mask. It is allowed to change when DPIF_UC_ACTION is | |
595 | * disabled and then re-enabled, so a client that does that must be prepared to | |
596 | * update all of the flows that it installed that contain | |
597 | * OVS_ACTION_ATTR_USERSPACE actions. */ | |
598 | uint32_t | |
4e022ec0 | 599 | dpif_port_get_pid(const struct dpif *dpif, odp_port_t port_no) |
98403001 BP |
600 | { |
601 | return (dpif->dpif_class->port_get_pid | |
602 | ? (dpif->dpif_class->port_get_pid)(dpif, port_no) | |
603 | : 0); | |
604 | } | |
605 | ||
96fba48f BP |
606 | /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and copies |
607 | * the port's name into the 'name_size' bytes in 'name', ensuring that the | |
608 | * result is null-terminated. On failure, returns a positive errno value and | |
609 | * makes 'name' the empty string. */ | |
335562c0 | 610 | int |
4e022ec0 | 611 | dpif_port_get_name(struct dpif *dpif, odp_port_t port_no, |
335562c0 BP |
612 | char *name, size_t name_size) |
613 | { | |
4c738a8d | 614 | struct dpif_port port; |
335562c0 BP |
615 | int error; |
616 | ||
cb22974d | 617 | ovs_assert(name_size > 0); |
335562c0 BP |
618 | |
619 | error = dpif_port_query_by_number(dpif, port_no, &port); | |
620 | if (!error) { | |
4c738a8d BP |
621 | ovs_strlcpy(name, port.name, name_size); |
622 | dpif_port_destroy(&port); | |
335562c0 BP |
623 | } else { |
624 | *name = '\0'; | |
625 | } | |
626 | return error; | |
627 | } | |
628 | ||
b0ec0f27 | 629 | /* Initializes 'dump' to begin dumping the ports in a dpif. |
96fba48f | 630 | * |
b0ec0f27 BP |
631 | * This function provides no status indication. An error status for the entire |
632 | * dump operation is provided when it is completed by calling | |
633 | * dpif_port_dump_done(). | |
634 | */ | |
635 | void | |
636 | dpif_port_dump_start(struct dpif_port_dump *dump, const struct dpif *dpif) | |
637 | { | |
638 | dump->dpif = dpif; | |
639 | dump->error = dpif->dpif_class->port_dump_start(dpif, &dump->state); | |
640 | log_operation(dpif, "port_dump_start", dump->error); | |
641 | } | |
642 | ||
643 | /* Attempts to retrieve another port from 'dump', which must have been | |
4c738a8d | 644 | * initialized with dpif_port_dump_start(). On success, stores a new dpif_port |
b0ec0f27 | 645 | * into 'port' and returns true. On failure, returns false. |
96fba48f | 646 | * |
b0ec0f27 BP |
647 | * Failure might indicate an actual error or merely that the last port has been |
648 | * dumped. An error status for the entire dump operation is provided when it | |
4c738a8d BP |
649 | * is completed by calling dpif_port_dump_done(). |
650 | * | |
651 | * The dpif owns the data stored in 'port'. It will remain valid until at | |
652 | * least the next time 'dump' is passed to dpif_port_dump_next() or | |
653 | * dpif_port_dump_done(). */ | |
b0ec0f27 | 654 | bool |
4c738a8d | 655 | dpif_port_dump_next(struct dpif_port_dump *dump, struct dpif_port *port) |
064af421 | 656 | { |
b0ec0f27 | 657 | const struct dpif *dpif = dump->dpif; |
064af421 | 658 | |
b0ec0f27 BP |
659 | if (dump->error) { |
660 | return false; | |
661 | } | |
f4ba4c4f | 662 | |
b0ec0f27 BP |
663 | dump->error = dpif->dpif_class->port_dump_next(dpif, dump->state, port); |
664 | if (dump->error == EOF) { | |
665 | VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all ports", dpif_name(dpif)); | |
666 | } else { | |
667 | log_operation(dpif, "port_dump_next", dump->error); | |
668 | } | |
064af421 | 669 | |
b0ec0f27 BP |
670 | if (dump->error) { |
671 | dpif->dpif_class->port_dump_done(dpif, dump->state); | |
672 | return false; | |
f4ba4c4f | 673 | } |
b0ec0f27 BP |
674 | return true; |
675 | } | |
064af421 | 676 | |
b0ec0f27 BP |
677 | /* Completes port table dump operation 'dump', which must have been initialized |
678 | * with dpif_port_dump_start(). Returns 0 if the dump operation was | |
679 | * error-free, otherwise a positive errno value describing the problem. */ | |
680 | int | |
681 | dpif_port_dump_done(struct dpif_port_dump *dump) | |
682 | { | |
683 | const struct dpif *dpif = dump->dpif; | |
684 | if (!dump->error) { | |
685 | dump->error = dpif->dpif_class->port_dump_done(dpif, dump->state); | |
686 | log_operation(dpif, "port_dump_done", dump->error); | |
f4ba4c4f | 687 | } |
b0ec0f27 | 688 | return dump->error == EOF ? 0 : dump->error; |
064af421 BP |
689 | } |
690 | ||
e9e28be3 BP |
691 | /* Polls for changes in the set of ports in 'dpif'. If the set of ports in |
692 | * 'dpif' has changed, this function does one of the following: | |
693 | * | |
694 | * - Stores the name of the device that was added to or deleted from 'dpif' in | |
695 | * '*devnamep' and returns 0. The caller is responsible for freeing | |
696 | * '*devnamep' (with free()) when it no longer needs it. | |
697 | * | |
698 | * - Returns ENOBUFS and sets '*devnamep' to NULL. | |
699 | * | |
700 | * This function may also return 'false positives', where it returns 0 and | |
701 | * '*devnamep' names a device that was not actually added or deleted or it | |
702 | * returns ENOBUFS without any change. | |
703 | * | |
704 | * Returns EAGAIN if the set of ports in 'dpif' has not changed. May also | |
705 | * return other positive errno values to indicate that something has gone | |
706 | * wrong. */ | |
707 | int | |
708 | dpif_port_poll(const struct dpif *dpif, char **devnamep) | |
709 | { | |
1acb6baa | 710 | int error = dpif->dpif_class->port_poll(dpif, devnamep); |
e9e28be3 BP |
711 | if (error) { |
712 | *devnamep = NULL; | |
713 | } | |
714 | return error; | |
715 | } | |
716 | ||
717 | /* Arranges for the poll loop to wake up when port_poll(dpif) will return a | |
718 | * value other than EAGAIN. */ | |
719 | void | |
720 | dpif_port_poll_wait(const struct dpif *dpif) | |
721 | { | |
1acb6baa | 722 | dpif->dpif_class->port_poll_wait(dpif); |
e9e28be3 BP |
723 | } |
724 | ||
572b7068 | 725 | /* Extracts the flow stats for a packet. The 'flow' and 'packet' |
a7752d4a BP |
726 | * arguments must have been initialized through a call to flow_extract(). |
727 | * 'used' is stored into stats->used. */ | |
572b7068 | 728 | void |
a39edbd4 | 729 | dpif_flow_stats_extract(const struct flow *flow, const struct ofpbuf *packet, |
a7752d4a | 730 | long long int used, struct dpif_flow_stats *stats) |
572b7068 | 731 | { |
12113c39 | 732 | stats->tcp_flags = packet_get_tcp_flags(packet, flow); |
572b7068 BP |
733 | stats->n_bytes = packet->size; |
734 | stats->n_packets = 1; | |
a7752d4a | 735 | stats->used = used; |
572b7068 BP |
736 | } |
737 | ||
c97fb132 BP |
738 | /* Appends a human-readable representation of 'stats' to 's'. */ |
739 | void | |
740 | dpif_flow_stats_format(const struct dpif_flow_stats *stats, struct ds *s) | |
741 | { | |
742 | ds_put_format(s, "packets:%"PRIu64", bytes:%"PRIu64", used:", | |
743 | stats->n_packets, stats->n_bytes); | |
744 | if (stats->used) { | |
745 | ds_put_format(s, "%.3fs", (time_msec() - stats->used) / 1000.0); | |
746 | } else { | |
747 | ds_put_format(s, "never"); | |
748 | } | |
7393104d BP |
749 | if (stats->tcp_flags) { |
750 | ds_put_cstr(s, ", flags:"); | |
751 | packet_format_tcp_flags(s, stats->tcp_flags); | |
752 | } | |
c97fb132 BP |
753 | } |
754 | ||
96fba48f BP |
755 | /* Deletes all flows from 'dpif'. Returns 0 if successful, otherwise a |
756 | * positive errno value. */ | |
757 | int | |
758 | dpif_flow_flush(struct dpif *dpif) | |
064af421 | 759 | { |
96fba48f BP |
760 | int error; |
761 | ||
762 | COVERAGE_INC(dpif_flow_flush); | |
763 | ||
1acb6baa | 764 | error = dpif->dpif_class->flow_flush(dpif); |
96fba48f BP |
765 | log_operation(dpif, "flow_flush", error); |
766 | return error; | |
064af421 BP |
767 | } |
768 | ||
feebdea2 | 769 | /* Queries 'dpif' for a flow entry. The flow is specified by the Netlink |
df2c07f4 | 770 | * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at |
feebdea2 | 771 | * 'key'. |
96fba48f | 772 | * |
feebdea2 BP |
773 | * Returns 0 if successful. If no flow matches, returns ENOENT. On other |
774 | * failure, returns a positive errno value. | |
96fba48f | 775 | * |
feebdea2 BP |
776 | * If 'actionsp' is nonnull, then on success '*actionsp' will be set to an |
777 | * ofpbuf owned by the caller that contains the Netlink attributes for the | |
778 | * flow's actions. The caller must free the ofpbuf (with ofpbuf_delete()) when | |
779 | * it is no longer needed. | |
780 | * | |
781 | * If 'stats' is nonnull, then on success it will be updated with the flow's | |
782 | * statistics. */ | |
96fba48f | 783 | int |
693c4a01 | 784 | dpif_flow_get(const struct dpif *dpif, |
feebdea2 | 785 | const struct nlattr *key, size_t key_len, |
c97fb132 | 786 | struct ofpbuf **actionsp, struct dpif_flow_stats *stats) |
064af421 | 787 | { |
96fba48f BP |
788 | int error; |
789 | ||
790 | COVERAGE_INC(dpif_flow_get); | |
791 | ||
693c4a01 | 792 | error = dpif->dpif_class->flow_get(dpif, key, key_len, actionsp, stats); |
b843fa1b | 793 | if (error) { |
feebdea2 BP |
794 | if (actionsp) { |
795 | *actionsp = NULL; | |
796 | } | |
797 | if (stats) { | |
798 | memset(stats, 0, sizeof *stats); | |
799 | } | |
b843fa1b | 800 | } |
96fba48f | 801 | if (should_log_flow_message(error)) { |
feebdea2 BP |
802 | const struct nlattr *actions; |
803 | size_t actions_len; | |
804 | ||
805 | if (!error && actionsp) { | |
806 | actions = (*actionsp)->data; | |
807 | actions_len = (*actionsp)->size; | |
808 | } else { | |
809 | actions = NULL; | |
810 | actions_len = 0; | |
811 | } | |
61fb711d JP |
812 | log_flow_message(dpif, error, "flow_get", key, key_len, |
813 | NULL, 0, stats, actions, actions_len); | |
064af421 | 814 | } |
96fba48f | 815 | return error; |
064af421 BP |
816 | } |
817 | ||
89625d1e BP |
818 | static int |
819 | dpif_flow_put__(struct dpif *dpif, const struct dpif_flow_put *put) | |
820 | { | |
821 | int error; | |
822 | ||
823 | COVERAGE_INC(dpif_flow_put); | |
cb22974d BP |
824 | ovs_assert(!(put->flags & ~(DPIF_FP_CREATE | DPIF_FP_MODIFY |
825 | | DPIF_FP_ZERO_STATS))); | |
89625d1e BP |
826 | |
827 | error = dpif->dpif_class->flow_put(dpif, put); | |
828 | if (error && put->stats) { | |
829 | memset(put->stats, 0, sizeof *put->stats); | |
830 | } | |
831 | log_flow_put_message(dpif, put, error); | |
832 | return error; | |
833 | } | |
834 | ||
feebdea2 | 835 | /* Adds or modifies a flow in 'dpif'. The flow is specified by the Netlink |
e6cc0bab AZ |
836 | * attribute OVS_FLOW_ATTR_KEY with types OVS_KEY_ATTR_* in the 'key_len' bytes |
837 | * starting at 'key', and OVS_FLOW_ATTR_MASK with types of OVS_KEY_ATTR_* in the | |
838 | * 'mask_len' bytes starting at 'mask'. The associated actions are specified by | |
839 | * the Netlink attributes with types OVS_ACTION_ATTR_* in the 'actions_len' | |
840 | * bytes starting at 'actions'. | |
96fba48f | 841 | * |
feebdea2 | 842 | * - If the flow's key does not exist in 'dpif', then the flow will be added if |
ba25b8f4 | 843 | * 'flags' includes DPIF_FP_CREATE. Otherwise the operation will fail with |
96fba48f BP |
844 | * ENOENT. |
845 | * | |
feebdea2 | 846 | * If the operation succeeds, then 'stats', if nonnull, will be zeroed. |
96fba48f | 847 | * |
feebdea2 | 848 | * - If the flow's key does exist in 'dpif', then the flow's actions will be |
ba25b8f4 | 849 | * updated if 'flags' includes DPIF_FP_MODIFY. Otherwise the operation will |
feebdea2 | 850 | * fail with EEXIST. If the flow's actions are updated, then its statistics |
ba25b8f4 | 851 | * will be zeroed if 'flags' includes DPIF_FP_ZERO_STATS, and left as-is |
feebdea2 BP |
852 | * otherwise. |
853 | * | |
854 | * If the operation succeeds, then 'stats', if nonnull, will be set to the | |
855 | * flow's statistics before the update. | |
96fba48f | 856 | */ |
064af421 | 857 | int |
ba25b8f4 | 858 | dpif_flow_put(struct dpif *dpif, enum dpif_flow_put_flags flags, |
feebdea2 | 859 | const struct nlattr *key, size_t key_len, |
e6cc0bab | 860 | const struct nlattr *mask, size_t mask_len, |
feebdea2 | 861 | const struct nlattr *actions, size_t actions_len, |
c97fb132 | 862 | struct dpif_flow_stats *stats) |
064af421 | 863 | { |
89625d1e BP |
864 | struct dpif_flow_put put; |
865 | ||
866 | put.flags = flags; | |
867 | put.key = key; | |
868 | put.key_len = key_len; | |
e6cc0bab AZ |
869 | put.mask = mask; |
870 | put.mask_len = mask_len; | |
89625d1e BP |
871 | put.actions = actions; |
872 | put.actions_len = actions_len; | |
873 | put.stats = stats; | |
874 | return dpif_flow_put__(dpif, &put); | |
064af421 BP |
875 | } |
876 | ||
b99d3cee BP |
877 | static int |
878 | dpif_flow_del__(struct dpif *dpif, struct dpif_flow_del *del) | |
879 | { | |
880 | int error; | |
881 | ||
882 | COVERAGE_INC(dpif_flow_del); | |
883 | ||
884 | error = dpif->dpif_class->flow_del(dpif, del); | |
885 | if (error && del->stats) { | |
886 | memset(del->stats, 0, sizeof *del->stats); | |
887 | } | |
888 | log_flow_del_message(dpif, del, error); | |
889 | return error; | |
890 | } | |
891 | ||
feebdea2 BP |
892 | /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif' does |
893 | * not contain such a flow. The flow is specified by the Netlink attributes | |
df2c07f4 | 894 | * with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at 'key'. |
96fba48f | 895 | * |
feebdea2 BP |
896 | * If the operation succeeds, then 'stats', if nonnull, will be set to the |
897 | * flow's statistics before its deletion. */ | |
064af421 | 898 | int |
feebdea2 BP |
899 | dpif_flow_del(struct dpif *dpif, |
900 | const struct nlattr *key, size_t key_len, | |
c97fb132 | 901 | struct dpif_flow_stats *stats) |
064af421 | 902 | { |
b99d3cee | 903 | struct dpif_flow_del del; |
f1aa2072 | 904 | |
b99d3cee BP |
905 | del.key = key; |
906 | del.key_len = key_len; | |
907 | del.stats = stats; | |
908 | return dpif_flow_del__(dpif, &del); | |
064af421 BP |
909 | } |
910 | ||
704a1e09 BP |
911 | /* Initializes 'dump' to begin dumping the flows in a dpif. |
912 | * | |
913 | * This function provides no status indication. An error status for the entire | |
914 | * dump operation is provided when it is completed by calling | |
915 | * dpif_flow_dump_done(). | |
916 | */ | |
917 | void | |
918 | dpif_flow_dump_start(struct dpif_flow_dump *dump, const struct dpif *dpif) | |
064af421 | 919 | { |
704a1e09 BP |
920 | dump->dpif = dpif; |
921 | dump->error = dpif->dpif_class->flow_dump_start(dpif, &dump->state); | |
922 | log_operation(dpif, "flow_dump_start", dump->error); | |
064af421 BP |
923 | } |
924 | ||
704a1e09 | 925 | /* Attempts to retrieve another flow from 'dump', which must have been |
feebdea2 BP |
926 | * initialized with dpif_flow_dump_start(). On success, updates the output |
927 | * parameters as described below and returns true. Otherwise, returns false. | |
928 | * Failure might indicate an actual error or merely the end of the flow table. | |
929 | * An error status for the entire dump operation is provided when it is | |
930 | * completed by calling dpif_flow_dump_done(). | |
931 | * | |
932 | * On success, if 'key' and 'key_len' are nonnull then '*key' and '*key_len' | |
df2c07f4 | 933 | * will be set to Netlink attributes with types OVS_KEY_ATTR_* representing the |
feebdea2 | 934 | * dumped flow's key. If 'actions' and 'actions_len' are nonnull then they are |
df2c07f4 | 935 | * set to Netlink attributes with types OVS_ACTION_ATTR_* representing the |
7aec165d BP |
936 | * dumped flow's actions. If 'stats' is nonnull then it will be set to the |
937 | * dumped flow's statistics. | |
96fba48f | 938 | * |
feebdea2 BP |
939 | * All of the returned data is owned by 'dpif', not by the caller, and the |
940 | * caller must not modify or free it. 'dpif' guarantees that it remains | |
941 | * accessible and unchanging until at least the next call to 'flow_dump_next' | |
942 | * or 'flow_dump_done' for 'dump'. */ | |
704a1e09 | 943 | bool |
feebdea2 BP |
944 | dpif_flow_dump_next(struct dpif_flow_dump *dump, |
945 | const struct nlattr **key, size_t *key_len, | |
e6cc0bab | 946 | const struct nlattr **mask, size_t *mask_len, |
feebdea2 | 947 | const struct nlattr **actions, size_t *actions_len, |
c97fb132 | 948 | const struct dpif_flow_stats **stats) |
704a1e09 BP |
949 | { |
950 | const struct dpif *dpif = dump->dpif; | |
feebdea2 | 951 | int error = dump->error; |
064af421 | 952 | |
feebdea2 BP |
953 | if (!error) { |
954 | error = dpif->dpif_class->flow_dump_next(dpif, dump->state, | |
955 | key, key_len, | |
e6cc0bab | 956 | mask, mask_len, |
feebdea2 BP |
957 | actions, actions_len, |
958 | stats); | |
959 | if (error) { | |
960 | dpif->dpif_class->flow_dump_done(dpif, dump->state); | |
961 | } | |
064af421 | 962 | } |
feebdea2 BP |
963 | if (error) { |
964 | if (key) { | |
965 | *key = NULL; | |
966 | *key_len = 0; | |
36956a7d | 967 | } |
e6cc0bab AZ |
968 | if (mask) { |
969 | *mask = NULL; | |
970 | *mask_len = 0; | |
971 | } | |
feebdea2 BP |
972 | if (actions) { |
973 | *actions = NULL; | |
974 | *actions_len = 0; | |
975 | } | |
976 | if (stats) { | |
977 | *stats = NULL; | |
704a1e09 | 978 | } |
064af421 | 979 | } |
feebdea2 BP |
980 | if (!dump->error) { |
981 | if (error == EOF) { | |
982 | VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all flows", dpif_name(dpif)); | |
983 | } else if (should_log_flow_message(error)) { | |
984 | log_flow_message(dpif, error, "flow_dump", | |
985 | key ? *key : NULL, key ? *key_len : 0, | |
61fb711d | 986 | mask ? *mask : NULL, mask ? *mask_len : 0, |
feebdea2 BP |
987 | stats ? *stats : NULL, actions ? *actions : NULL, |
988 | actions ? *actions_len : 0); | |
989 | } | |
064af421 | 990 | } |
feebdea2 BP |
991 | dump->error = error; |
992 | return !error; | |
704a1e09 BP |
993 | } |
994 | ||
995 | /* Completes flow table dump operation 'dump', which must have been initialized | |
996 | * with dpif_flow_dump_start(). Returns 0 if the dump operation was | |
997 | * error-free, otherwise a positive errno value describing the problem. */ | |
998 | int | |
999 | dpif_flow_dump_done(struct dpif_flow_dump *dump) | |
1000 | { | |
1001 | const struct dpif *dpif = dump->dpif; | |
1002 | if (!dump->error) { | |
1003 | dump->error = dpif->dpif_class->flow_dump_done(dpif, dump->state); | |
1004 | log_operation(dpif, "flow_dump_done", dump->error); | |
1005 | } | |
1006 | return dump->error == EOF ? 0 : dump->error; | |
064af421 BP |
1007 | } |
1008 | ||
89625d1e BP |
1009 | static int |
1010 | dpif_execute__(struct dpif *dpif, const struct dpif_execute *execute) | |
1011 | { | |
1012 | int error; | |
1013 | ||
1014 | COVERAGE_INC(dpif_execute); | |
1015 | if (execute->actions_len > 0) { | |
1016 | error = dpif->dpif_class->execute(dpif, execute); | |
1017 | } else { | |
1018 | error = 0; | |
1019 | } | |
1020 | ||
1021 | log_execute_message(dpif, execute, error); | |
1022 | ||
1023 | return error; | |
1024 | } | |
1025 | ||
cdee00fd | 1026 | /* Causes 'dpif' to perform the 'actions_len' bytes of actions in 'actions' on |
80e5eed9 BP |
1027 | * the Ethernet frame specified in 'packet' taken from the flow specified in |
1028 | * the 'key_len' bytes of 'key'. ('key' is mostly redundant with 'packet', but | |
1029 | * it contains some metadata that cannot be recovered from 'packet', such as | |
296e07ac | 1030 | * tunnel and in_port.) |
96fba48f | 1031 | * |
96fba48f | 1032 | * Returns 0 if successful, otherwise a positive errno value. */ |
064af421 | 1033 | int |
f1588b1f | 1034 | dpif_execute(struct dpif *dpif, |
80e5eed9 | 1035 | const struct nlattr *key, size_t key_len, |
cdee00fd | 1036 | const struct nlattr *actions, size_t actions_len, |
064af421 BP |
1037 | const struct ofpbuf *buf) |
1038 | { | |
89625d1e BP |
1039 | struct dpif_execute execute; |
1040 | ||
1041 | execute.key = key; | |
1042 | execute.key_len = key_len; | |
1043 | execute.actions = actions; | |
1044 | execute.actions_len = actions_len; | |
1045 | execute.packet = buf; | |
1046 | return dpif_execute__(dpif, &execute); | |
064af421 BP |
1047 | } |
1048 | ||
6bc60024 BP |
1049 | /* Executes each of the 'n_ops' operations in 'ops' on 'dpif', in the order in |
1050 | * which they are specified, placing each operation's results in the "output" | |
1051 | * members documented in comments. | |
1052 | * | |
1053 | * This function exists because some datapaths can perform batched operations | |
1054 | * faster than individual operations. */ | |
1055 | void | |
c2b565b5 | 1056 | dpif_operate(struct dpif *dpif, struct dpif_op **ops, size_t n_ops) |
6bc60024 BP |
1057 | { |
1058 | size_t i; | |
1059 | ||
1060 | if (dpif->dpif_class->operate) { | |
1061 | dpif->dpif_class->operate(dpif, ops, n_ops); | |
f23d2845 BP |
1062 | |
1063 | for (i = 0; i < n_ops; i++) { | |
1064 | struct dpif_op *op = ops[i]; | |
1065 | ||
1066 | switch (op->type) { | |
1067 | case DPIF_OP_FLOW_PUT: | |
1068 | log_flow_put_message(dpif, &op->u.flow_put, op->error); | |
1069 | break; | |
1070 | ||
b99d3cee BP |
1071 | case DPIF_OP_FLOW_DEL: |
1072 | log_flow_del_message(dpif, &op->u.flow_del, op->error); | |
1073 | break; | |
1074 | ||
f23d2845 BP |
1075 | case DPIF_OP_EXECUTE: |
1076 | log_execute_message(dpif, &op->u.execute, op->error); | |
1077 | break; | |
1078 | } | |
1079 | } | |
6bc60024 BP |
1080 | return; |
1081 | } | |
1082 | ||
1083 | for (i = 0; i < n_ops; i++) { | |
c2b565b5 | 1084 | struct dpif_op *op = ops[i]; |
6bc60024 BP |
1085 | |
1086 | switch (op->type) { | |
1087 | case DPIF_OP_FLOW_PUT: | |
89625d1e | 1088 | op->error = dpif_flow_put__(dpif, &op->u.flow_put); |
6bc60024 BP |
1089 | break; |
1090 | ||
b99d3cee BP |
1091 | case DPIF_OP_FLOW_DEL: |
1092 | op->error = dpif_flow_del__(dpif, &op->u.flow_del); | |
1093 | break; | |
1094 | ||
6bc60024 | 1095 | case DPIF_OP_EXECUTE: |
89625d1e | 1096 | op->error = dpif_execute__(dpif, &op->u.execute); |
6bc60024 BP |
1097 | break; |
1098 | ||
1099 | default: | |
1100 | NOT_REACHED(); | |
1101 | } | |
1102 | } | |
1103 | } | |
1104 | ||
1105 | ||
01545c1a BP |
1106 | /* Returns a string that represents 'type', for use in log messages. */ |
1107 | const char * | |
1108 | dpif_upcall_type_to_string(enum dpif_upcall_type type) | |
1109 | { | |
1110 | switch (type) { | |
1111 | case DPIF_UC_MISS: return "miss"; | |
1112 | case DPIF_UC_ACTION: return "action"; | |
01545c1a BP |
1113 | case DPIF_N_UC_TYPES: default: return "<unknown>"; |
1114 | } | |
1115 | } | |
1116 | ||
a12b3ead BP |
1117 | /* Enables or disables receiving packets with dpif_recv() on 'dpif'. Returns 0 |
1118 | * if successful, otherwise a positive errno value. | |
98403001 | 1119 | * |
a12b3ead | 1120 | * Turning packet receive off and then back on may change the Netlink PID |
98403001 BP |
1121 | * assignments returned by dpif_port_get_pid(). If the client does this, it |
1122 | * must update all of the flows that have OVS_ACTION_ATTR_USERSPACE actions | |
1123 | * using the new PID assignment. */ | |
8f24562a | 1124 | int |
a12b3ead | 1125 | dpif_recv_set(struct dpif *dpif, bool enable) |
8f24562a | 1126 | { |
a12b3ead BP |
1127 | int error = dpif->dpif_class->recv_set(dpif, enable); |
1128 | log_operation(dpif, "recv_set", error); | |
96fba48f | 1129 | return error; |
8f24562a BP |
1130 | } |
1131 | ||
856081f6 | 1132 | /* Polls for an upcall from 'dpif'. If successful, stores the upcall into |
90a7c55e BP |
1133 | * '*upcall', using 'buf' for storage. Should only be called if |
1134 | * dpif_recv_set() has been used to enable receiving packets on 'dpif'. | |
96fba48f | 1135 | * |
90a7c55e BP |
1136 | * 'upcall->packet' and 'upcall->key' point into data in the caller-provided |
1137 | * 'buf', so their memory cannot be freed separately from 'buf'. (This is | |
856081f6 BP |
1138 | * hardly a great way to do things but it works out OK for the dpif providers |
1139 | * and clients that exist so far.) | |
1140 | * | |
96fba48f | 1141 | * Returns 0 if successful, otherwise a positive errno value. Returns EAGAIN |
856081f6 | 1142 | * if no upcall is immediately available. */ |
064af421 | 1143 | int |
90a7c55e | 1144 | dpif_recv(struct dpif *dpif, struct dpif_upcall *upcall, struct ofpbuf *buf) |
064af421 | 1145 | { |
90a7c55e | 1146 | int error = dpif->dpif_class->recv(dpif, upcall, buf); |
856081f6 | 1147 | if (!error && !VLOG_DROP_DBG(&dpmsg_rl)) { |
01545c1a BP |
1148 | struct ds flow; |
1149 | char *packet; | |
1150 | ||
1151 | packet = ofp_packet_to_string(upcall->packet->data, | |
01545c1a BP |
1152 | upcall->packet->size); |
1153 | ||
1154 | ds_init(&flow); | |
1155 | odp_flow_key_format(upcall->key, upcall->key_len, &flow); | |
1156 | ||
1157 | VLOG_DBG("%s: %s upcall:\n%s\n%s", | |
1158 | dpif_name(dpif), dpif_upcall_type_to_string(upcall->type), | |
1159 | ds_cstr(&flow), packet); | |
1160 | ||
1161 | ds_destroy(&flow); | |
1162 | free(packet); | |
5fcc0d00 BP |
1163 | } else if (error && error != EAGAIN) { |
1164 | log_operation(dpif, "recv", error); | |
064af421 | 1165 | } |
064af421 BP |
1166 | return error; |
1167 | } | |
1168 | ||
96fba48f | 1169 | /* Discards all messages that would otherwise be received by dpif_recv() on |
1ba530f4 BP |
1170 | * 'dpif'. */ |
1171 | void | |
96fba48f BP |
1172 | dpif_recv_purge(struct dpif *dpif) |
1173 | { | |
96fba48f | 1174 | COVERAGE_INC(dpif_purge); |
1ba530f4 BP |
1175 | if (dpif->dpif_class->recv_purge) { |
1176 | dpif->dpif_class->recv_purge(dpif); | |
96fba48f | 1177 | } |
96fba48f BP |
1178 | } |
1179 | ||
1180 | /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be | |
1181 | * received with dpif_recv(). */ | |
064af421 BP |
1182 | void |
1183 | dpif_recv_wait(struct dpif *dpif) | |
1184 | { | |
1acb6baa | 1185 | dpif->dpif_class->recv_wait(dpif); |
064af421 | 1186 | } |
53a4218d | 1187 | |
96fba48f BP |
1188 | /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type' |
1189 | * and '*engine_id', respectively. */ | |
53a4218d BP |
1190 | void |
1191 | dpif_get_netflow_ids(const struct dpif *dpif, | |
1192 | uint8_t *engine_type, uint8_t *engine_id) | |
1193 | { | |
96fba48f BP |
1194 | *engine_type = dpif->netflow_engine_type; |
1195 | *engine_id = dpif->netflow_engine_id; | |
1196 | } | |
aae51f53 BP |
1197 | |
1198 | /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority | |
abff858b PS |
1199 | * value used for setting packet priority. |
1200 | * On success, returns 0 and stores the priority into '*priority'. | |
1201 | * On failure, returns a positive errno value and stores 0 into '*priority'. */ | |
aae51f53 BP |
1202 | int |
1203 | dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id, | |
1204 | uint32_t *priority) | |
1205 | { | |
1206 | int error = (dpif->dpif_class->queue_to_priority | |
1207 | ? dpif->dpif_class->queue_to_priority(dpif, queue_id, | |
1208 | priority) | |
1209 | : EOPNOTSUPP); | |
1210 | if (error) { | |
1211 | *priority = 0; | |
1212 | } | |
1213 | log_operation(dpif, "queue_to_priority", error); | |
1214 | return error; | |
1215 | } | |
96fba48f BP |
1216 | \f |
1217 | void | |
1acb6baa BP |
1218 | dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class, |
1219 | const char *name, | |
96fba48f BP |
1220 | uint8_t netflow_engine_type, uint8_t netflow_engine_id) |
1221 | { | |
1acb6baa | 1222 | dpif->dpif_class = dpif_class; |
1a6f1e2a | 1223 | dpif->base_name = xstrdup(name); |
a4af0040 | 1224 | dpif->full_name = xasprintf("%s@%s", dpif_class->type, name); |
96fba48f BP |
1225 | dpif->netflow_engine_type = netflow_engine_type; |
1226 | dpif->netflow_engine_id = netflow_engine_id; | |
1227 | } | |
999401aa JG |
1228 | |
1229 | /* Undoes the results of initialization. | |
1230 | * | |
1231 | * Normally this function only needs to be called from dpif_close(). | |
1232 | * However, it may be called by providers due to an error on opening | |
1233 | * that occurs after initialization. It this case dpif_close() would | |
1234 | * never be called. */ | |
1235 | void | |
1236 | dpif_uninit(struct dpif *dpif, bool close) | |
1237 | { | |
1238 | char *base_name = dpif->base_name; | |
1239 | char *full_name = dpif->full_name; | |
1240 | ||
1241 | if (close) { | |
a4af0040 | 1242 | dpif->dpif_class->close(dpif); |
999401aa JG |
1243 | } |
1244 | ||
1245 | free(base_name); | |
1246 | free(full_name); | |
1247 | } | |
96fba48f BP |
1248 | \f |
1249 | static void | |
1250 | log_operation(const struct dpif *dpif, const char *operation, int error) | |
1251 | { | |
1252 | if (!error) { | |
1253 | VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation); | |
90bf1e07 | 1254 | } else if (ofperr_is_valid(error)) { |
96fba48f | 1255 | VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)", |
90bf1e07 | 1256 | dpif_name(dpif), operation, ofperr_get_name(error)); |
71ce9235 | 1257 | } else { |
90bf1e07 BP |
1258 | VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)", |
1259 | dpif_name(dpif), operation, strerror(error)); | |
96fba48f BP |
1260 | } |
1261 | } | |
1262 | ||
1263 | static enum vlog_level | |
1264 | flow_message_log_level(int error) | |
1265 | { | |
9b1a48c2 JP |
1266 | /* If flows arrive in a batch, userspace may push down multiple |
1267 | * unique flow definitions that overlap when wildcards are applied. | |
1268 | * Kernels that support flow wildcarding will reject these flows as | |
1269 | * duplicates (EEXIST), so lower the log level to debug for these | |
1270 | * types of messages. */ | |
1271 | return (error && error != EEXIST) ? VLL_WARN : VLL_DBG; | |
96fba48f BP |
1272 | } |
1273 | ||
1274 | static bool | |
1275 | should_log_flow_message(int error) | |
1276 | { | |
1277 | return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error), | |
1278 | error ? &error_rl : &dpmsg_rl); | |
1279 | } | |
1280 | ||
1281 | static void | |
1282 | log_flow_message(const struct dpif *dpif, int error, const char *operation, | |
36956a7d | 1283 | const struct nlattr *key, size_t key_len, |
61fb711d | 1284 | const struct nlattr *mask, size_t mask_len, |
c97fb132 | 1285 | const struct dpif_flow_stats *stats, |
cf22f8cb | 1286 | const struct nlattr *actions, size_t actions_len) |
96fba48f BP |
1287 | { |
1288 | struct ds ds = DS_EMPTY_INITIALIZER; | |
1289 | ds_put_format(&ds, "%s: ", dpif_name(dpif)); | |
1290 | if (error) { | |
1291 | ds_put_cstr(&ds, "failed to "); | |
1292 | } | |
1293 | ds_put_format(&ds, "%s ", operation); | |
1294 | if (error) { | |
1295 | ds_put_format(&ds, "(%s) ", strerror(error)); | |
1296 | } | |
61fb711d | 1297 | odp_flow_format(key, key_len, mask, mask_len, &ds); |
96fba48f BP |
1298 | if (stats) { |
1299 | ds_put_cstr(&ds, ", "); | |
c97fb132 | 1300 | dpif_flow_stats_format(stats, &ds); |
96fba48f | 1301 | } |
cdee00fd | 1302 | if (actions || actions_len) { |
96fba48f | 1303 | ds_put_cstr(&ds, ", actions:"); |
cdee00fd | 1304 | format_odp_actions(&ds, actions, actions_len); |
96fba48f BP |
1305 | } |
1306 | vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds)); | |
1307 | ds_destroy(&ds); | |
1308 | } | |
89625d1e BP |
1309 | |
1310 | static void | |
1311 | log_flow_put_message(struct dpif *dpif, const struct dpif_flow_put *put, | |
1312 | int error) | |
1313 | { | |
1314 | if (should_log_flow_message(error)) { | |
1315 | struct ds s; | |
1316 | ||
1317 | ds_init(&s); | |
1318 | ds_put_cstr(&s, "put"); | |
1319 | if (put->flags & DPIF_FP_CREATE) { | |
1320 | ds_put_cstr(&s, "[create]"); | |
1321 | } | |
1322 | if (put->flags & DPIF_FP_MODIFY) { | |
1323 | ds_put_cstr(&s, "[modify]"); | |
1324 | } | |
1325 | if (put->flags & DPIF_FP_ZERO_STATS) { | |
1326 | ds_put_cstr(&s, "[zero]"); | |
1327 | } | |
1328 | log_flow_message(dpif, error, ds_cstr(&s), | |
61fb711d JP |
1329 | put->key, put->key_len, put->mask, put->mask_len, |
1330 | put->stats, put->actions, put->actions_len); | |
89625d1e BP |
1331 | ds_destroy(&s); |
1332 | } | |
1333 | } | |
1334 | ||
b99d3cee BP |
1335 | static void |
1336 | log_flow_del_message(struct dpif *dpif, const struct dpif_flow_del *del, | |
1337 | int error) | |
1338 | { | |
1339 | if (should_log_flow_message(error)) { | |
1340 | log_flow_message(dpif, error, "flow_del", del->key, del->key_len, | |
61fb711d | 1341 | NULL, 0, !error ? del->stats : NULL, NULL, 0); |
b99d3cee BP |
1342 | } |
1343 | } | |
1344 | ||
89625d1e BP |
1345 | static void |
1346 | log_execute_message(struct dpif *dpif, const struct dpif_execute *execute, | |
1347 | int error) | |
1348 | { | |
1349 | if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) { | |
1350 | struct ds ds = DS_EMPTY_INITIALIZER; | |
1351 | char *packet; | |
1352 | ||
1353 | packet = ofp_packet_to_string(execute->packet->data, | |
1354 | execute->packet->size); | |
1355 | ds_put_format(&ds, "%s: execute ", dpif_name(dpif)); | |
1356 | format_odp_actions(&ds, execute->actions, execute->actions_len); | |
1357 | if (error) { | |
1358 | ds_put_format(&ds, " failed (%s)", strerror(error)); | |
1359 | } | |
1360 | ds_put_format(&ds, " on packet %s", packet); | |
1361 | vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds)); | |
1362 | ds_destroy(&ds); | |
1363 | free(packet); | |
1364 | } | |
1365 | } |