]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
2f51a7eb | 2 | * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 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 | 30 | #include "netlink.h" |
7fd91025 | 31 | #include "odp-execute.h" |
064af421 | 32 | #include "odp-util.h" |
90bf1e07 | 33 | #include "ofp-errors.h" |
064af421 | 34 | #include "ofp-print.h" |
71ce9235 | 35 | #include "ofp-util.h" |
064af421 | 36 | #include "ofpbuf.h" |
91088554 | 37 | #include "packet-dpif.h" |
064af421 BP |
38 | #include "packets.h" |
39 | #include "poll-loop.h" | |
999401aa | 40 | #include "shash.h" |
d0c23a1a | 41 | #include "sset.h" |
c97fb132 | 42 | #include "timeval.h" |
064af421 BP |
43 | #include "util.h" |
44 | #include "valgrind.h" | |
064af421 | 45 | #include "vlog.h" |
5136ce49 | 46 | |
d98e6007 | 47 | VLOG_DEFINE_THIS_MODULE(dpif); |
064af421 | 48 | |
d76f09ea BP |
49 | COVERAGE_DEFINE(dpif_destroy); |
50 | COVERAGE_DEFINE(dpif_port_add); | |
51 | COVERAGE_DEFINE(dpif_port_del); | |
52 | COVERAGE_DEFINE(dpif_flow_flush); | |
53 | COVERAGE_DEFINE(dpif_flow_get); | |
54 | COVERAGE_DEFINE(dpif_flow_put); | |
55 | COVERAGE_DEFINE(dpif_flow_del); | |
d76f09ea BP |
56 | COVERAGE_DEFINE(dpif_execute); |
57 | COVERAGE_DEFINE(dpif_purge); | |
7fd91025 | 58 | COVERAGE_DEFINE(dpif_execute_with_help); |
d76f09ea | 59 | |
999401aa | 60 | static const struct dpif_class *base_dpif_classes[] = { |
2f51a7eb | 61 | #ifdef __linux__ |
96fba48f | 62 | &dpif_linux_class, |
c83cdd30 | 63 | #endif |
72865317 | 64 | &dpif_netdev_class, |
c228a364 | 65 | }; |
999401aa JG |
66 | |
67 | struct registered_dpif_class { | |
d2d8fbeb | 68 | const struct dpif_class *dpif_class; |
999401aa JG |
69 | int refcount; |
70 | }; | |
71 | static struct shash dpif_classes = SHASH_INITIALIZER(&dpif_classes); | |
579a77e0 | 72 | static struct sset dpif_blacklist = SSET_INITIALIZER(&dpif_blacklist); |
c228a364 | 73 | |
5703b15f | 74 | /* Protects 'dpif_classes', including the refcount, and 'dpif_blacklist'. */ |
97be1538 | 75 | static struct ovs_mutex dpif_mutex = OVS_MUTEX_INITIALIZER; |
5703b15f | 76 | |
064af421 BP |
77 | /* Rate limit for individual messages going to or from the datapath, output at |
78 | * DBG level. This is very high because, if these are enabled, it is because | |
79 | * we really need to see them. */ | |
80 | static struct vlog_rate_limit dpmsg_rl = VLOG_RATE_LIMIT_INIT(600, 600); | |
81 | ||
82 | /* Not really much point in logging many dpif errors. */ | |
e2781405 | 83 | static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(60, 5); |
064af421 | 84 | |
feebdea2 BP |
85 | static void log_flow_message(const struct dpif *dpif, int error, |
86 | const char *operation, | |
87 | const struct nlattr *key, size_t key_len, | |
61fb711d | 88 | const struct nlattr *mask, size_t mask_len, |
c97fb132 | 89 | const struct dpif_flow_stats *stats, |
feebdea2 | 90 | const struct nlattr *actions, size_t actions_len); |
96fba48f BP |
91 | static void log_operation(const struct dpif *, const char *operation, |
92 | int error); | |
96fba48f | 93 | static bool should_log_flow_message(int error); |
89625d1e BP |
94 | static void log_flow_put_message(struct dpif *, const struct dpif_flow_put *, |
95 | int error); | |
b99d3cee BP |
96 | static void log_flow_del_message(struct dpif *, const struct dpif_flow_del *, |
97 | int error); | |
89625d1e | 98 | static void log_execute_message(struct dpif *, const struct dpif_execute *, |
fc65bafc | 99 | bool subexecute, int error); |
064af421 | 100 | |
999401aa JG |
101 | static void |
102 | dp_initialize(void) | |
103 | { | |
eb8ed438 | 104 | static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER; |
999401aa | 105 | |
eb8ed438 | 106 | if (ovsthread_once_start(&once)) { |
999401aa JG |
107 | int i; |
108 | ||
999401aa JG |
109 | for (i = 0; i < ARRAY_SIZE(base_dpif_classes); i++) { |
110 | dp_register_provider(base_dpif_classes[i]); | |
111 | } | |
eb8ed438 | 112 | ovsthread_once_done(&once); |
999401aa JG |
113 | } |
114 | } | |
115 | ||
5703b15f BP |
116 | static int |
117 | dp_register_provider__(const struct dpif_class *new_class) | |
999401aa JG |
118 | { |
119 | struct registered_dpif_class *registered_class; | |
120 | ||
579a77e0 EJ |
121 | if (sset_contains(&dpif_blacklist, new_class->type)) { |
122 | VLOG_DBG("attempted to register blacklisted provider: %s", | |
123 | new_class->type); | |
124 | return EINVAL; | |
125 | } | |
126 | ||
999401aa JG |
127 | if (shash_find(&dpif_classes, new_class->type)) { |
128 | VLOG_WARN("attempted to register duplicate datapath provider: %s", | |
129 | new_class->type); | |
130 | return EEXIST; | |
131 | } | |
1a6f1e2a | 132 | |
999401aa | 133 | registered_class = xmalloc(sizeof *registered_class); |
d2d8fbeb | 134 | registered_class->dpif_class = new_class; |
999401aa JG |
135 | registered_class->refcount = 0; |
136 | ||
137 | shash_add(&dpif_classes, new_class->type, registered_class); | |
138 | ||
139 | return 0; | |
140 | } | |
141 | ||
5703b15f BP |
142 | /* Registers a new datapath provider. After successful registration, new |
143 | * datapaths of that type can be opened using dpif_open(). */ | |
144 | int | |
145 | dp_register_provider(const struct dpif_class *new_class) | |
146 | { | |
147 | int error; | |
148 | ||
97be1538 | 149 | ovs_mutex_lock(&dpif_mutex); |
5703b15f | 150 | error = dp_register_provider__(new_class); |
97be1538 | 151 | ovs_mutex_unlock(&dpif_mutex); |
5703b15f BP |
152 | |
153 | return error; | |
154 | } | |
155 | ||
999401aa JG |
156 | /* Unregisters a datapath provider. 'type' must have been previously |
157 | * registered and not currently be in use by any dpifs. After unregistration | |
158 | * new datapaths of that type cannot be opened using dpif_open(). */ | |
5703b15f BP |
159 | static int |
160 | dp_unregister_provider__(const char *type) | |
999401aa JG |
161 | { |
162 | struct shash_node *node; | |
163 | struct registered_dpif_class *registered_class; | |
164 | ||
165 | node = shash_find(&dpif_classes, type); | |
166 | if (!node) { | |
167 | VLOG_WARN("attempted to unregister a datapath provider that is not " | |
168 | "registered: %s", type); | |
169 | return EAFNOSUPPORT; | |
170 | } | |
171 | ||
172 | registered_class = node->data; | |
173 | if (registered_class->refcount) { | |
174 | VLOG_WARN("attempted to unregister in use datapath provider: %s", type); | |
175 | return EBUSY; | |
176 | } | |
177 | ||
178 | shash_delete(&dpif_classes, node); | |
179 | free(registered_class); | |
180 | ||
181 | return 0; | |
182 | } | |
183 | ||
5703b15f BP |
184 | /* Unregisters a datapath provider. 'type' must have been previously |
185 | * registered and not currently be in use by any dpifs. After unregistration | |
186 | * new datapaths of that type cannot be opened using dpif_open(). */ | |
187 | int | |
188 | dp_unregister_provider(const char *type) | |
189 | { | |
190 | int error; | |
191 | ||
192 | dp_initialize(); | |
193 | ||
97be1538 | 194 | ovs_mutex_lock(&dpif_mutex); |
5703b15f | 195 | error = dp_unregister_provider__(type); |
97be1538 | 196 | ovs_mutex_unlock(&dpif_mutex); |
5703b15f BP |
197 | |
198 | return error; | |
199 | } | |
200 | ||
579a77e0 EJ |
201 | /* Blacklists a provider. Causes future calls of dp_register_provider() with |
202 | * a dpif_class which implements 'type' to fail. */ | |
203 | void | |
204 | dp_blacklist_provider(const char *type) | |
205 | { | |
97be1538 | 206 | ovs_mutex_lock(&dpif_mutex); |
579a77e0 | 207 | sset_add(&dpif_blacklist, type); |
97be1538 | 208 | ovs_mutex_unlock(&dpif_mutex); |
579a77e0 EJ |
209 | } |
210 | ||
999401aa | 211 | /* Clears 'types' and enumerates the types of all currently registered datapath |
d0c23a1a | 212 | * providers into it. The caller must first initialize the sset. */ |
1a6f1e2a | 213 | void |
d0c23a1a | 214 | dp_enumerate_types(struct sset *types) |
1a6f1e2a | 215 | { |
999401aa | 216 | struct shash_node *node; |
1a6f1e2a | 217 | |
999401aa | 218 | dp_initialize(); |
d0c23a1a | 219 | sset_clear(types); |
1a6f1e2a | 220 | |
97be1538 | 221 | ovs_mutex_lock(&dpif_mutex); |
999401aa JG |
222 | SHASH_FOR_EACH(node, &dpif_classes) { |
223 | const struct registered_dpif_class *registered_class = node->data; | |
d0c23a1a | 224 | sset_add(types, registered_class->dpif_class->type); |
1a6f1e2a | 225 | } |
97be1538 | 226 | ovs_mutex_unlock(&dpif_mutex); |
5703b15f BP |
227 | } |
228 | ||
229 | static void | |
230 | dp_class_unref(struct registered_dpif_class *rc) | |
231 | { | |
97be1538 | 232 | ovs_mutex_lock(&dpif_mutex); |
5703b15f BP |
233 | ovs_assert(rc->refcount); |
234 | rc->refcount--; | |
97be1538 | 235 | ovs_mutex_unlock(&dpif_mutex); |
5703b15f BP |
236 | } |
237 | ||
238 | static struct registered_dpif_class * | |
239 | dp_class_lookup(const char *type) | |
240 | { | |
241 | struct registered_dpif_class *rc; | |
242 | ||
97be1538 | 243 | ovs_mutex_lock(&dpif_mutex); |
5703b15f BP |
244 | rc = shash_find_data(&dpif_classes, type); |
245 | if (rc) { | |
246 | rc->refcount++; | |
247 | } | |
97be1538 | 248 | ovs_mutex_unlock(&dpif_mutex); |
5703b15f BP |
249 | |
250 | return rc; | |
1a6f1e2a JG |
251 | } |
252 | ||
253 | /* Clears 'names' and enumerates the names of all known created datapaths with | |
d0c23a1a | 254 | * the given 'type'. The caller must first initialize the sset. Returns 0 if |
1a6f1e2a | 255 | * successful, otherwise a positive errno value. |
d3d22744 BP |
256 | * |
257 | * Some kinds of datapaths might not be practically enumerable. This is not | |
258 | * considered an error. */ | |
259 | int | |
d0c23a1a | 260 | dp_enumerate_names(const char *type, struct sset *names) |
d3d22744 | 261 | { |
5703b15f | 262 | struct registered_dpif_class *registered_class; |
999401aa JG |
263 | const struct dpif_class *dpif_class; |
264 | int error; | |
d3d22744 | 265 | |
999401aa | 266 | dp_initialize(); |
d0c23a1a | 267 | sset_clear(names); |
1a6f1e2a | 268 | |
5703b15f | 269 | registered_class = dp_class_lookup(type); |
999401aa JG |
270 | if (!registered_class) { |
271 | VLOG_WARN("could not enumerate unknown type: %s", type); | |
272 | return EAFNOSUPPORT; | |
273 | } | |
1a6f1e2a | 274 | |
d2d8fbeb | 275 | dpif_class = registered_class->dpif_class; |
2240af25 DDP |
276 | error = (dpif_class->enumerate |
277 | ? dpif_class->enumerate(names, dpif_class) | |
278 | : 0); | |
999401aa JG |
279 | if (error) { |
280 | VLOG_WARN("failed to enumerate %s datapaths: %s", dpif_class->type, | |
10a89ef0 | 281 | ovs_strerror(error)); |
d3d22744 | 282 | } |
5703b15f | 283 | dp_class_unref(registered_class); |
1a6f1e2a | 284 | |
999401aa | 285 | return error; |
1a6f1e2a JG |
286 | } |
287 | ||
54ed8a5d BP |
288 | /* Parses 'datapath_name_', which is of the form [type@]name into its |
289 | * component pieces. 'name' and 'type' must be freed by the caller. | |
290 | * | |
291 | * The returned 'type' is normalized, as if by dpif_normalize_type(). */ | |
1a6f1e2a JG |
292 | void |
293 | dp_parse_name(const char *datapath_name_, char **name, char **type) | |
294 | { | |
295 | char *datapath_name = xstrdup(datapath_name_); | |
296 | char *separator; | |
297 | ||
298 | separator = strchr(datapath_name, '@'); | |
299 | if (separator) { | |
300 | *separator = '\0'; | |
301 | *type = datapath_name; | |
54ed8a5d | 302 | *name = xstrdup(dpif_normalize_type(separator + 1)); |
1a6f1e2a JG |
303 | } else { |
304 | *name = datapath_name; | |
54ed8a5d | 305 | *type = xstrdup(dpif_normalize_type(NULL)); |
1a6f1e2a | 306 | } |
d3d22744 BP |
307 | } |
308 | ||
96fba48f | 309 | static int |
1a6f1e2a | 310 | do_open(const char *name, const char *type, bool create, struct dpif **dpifp) |
064af421 | 311 | { |
96fba48f | 312 | struct dpif *dpif = NULL; |
064af421 | 313 | int error; |
999401aa JG |
314 | struct registered_dpif_class *registered_class; |
315 | ||
316 | dp_initialize(); | |
064af421 | 317 | |
3a225db7 | 318 | type = dpif_normalize_type(type); |
5703b15f | 319 | registered_class = dp_class_lookup(type); |
999401aa JG |
320 | if (!registered_class) { |
321 | VLOG_WARN("could not create datapath %s of unknown type %s", name, | |
322 | type); | |
323 | error = EAFNOSUPPORT; | |
324 | goto exit; | |
325 | } | |
326 | ||
4a387741 BP |
327 | error = registered_class->dpif_class->open(registered_class->dpif_class, |
328 | name, create, &dpif); | |
999401aa | 329 | if (!error) { |
cb22974d | 330 | ovs_assert(dpif->dpif_class == registered_class->dpif_class); |
5703b15f BP |
331 | } else { |
332 | dp_class_unref(registered_class); | |
064af421 | 333 | } |
064af421 | 334 | |
96fba48f BP |
335 | exit: |
336 | *dpifp = error ? NULL : dpif; | |
337 | return error; | |
064af421 BP |
338 | } |
339 | ||
1a6f1e2a JG |
340 | /* Tries to open an existing datapath named 'name' and type 'type'. Will fail |
341 | * if no datapath with 'name' and 'type' exists. 'type' may be either NULL or | |
342 | * the empty string to specify the default system type. Returns 0 if | |
343 | * successful, otherwise a positive errno value. On success stores a pointer | |
344 | * to the datapath in '*dpifp', otherwise a null pointer. */ | |
96fba48f | 345 | int |
1a6f1e2a | 346 | dpif_open(const char *name, const char *type, struct dpif **dpifp) |
064af421 | 347 | { |
1a6f1e2a | 348 | return do_open(name, type, false, dpifp); |
064af421 BP |
349 | } |
350 | ||
1a6f1e2a JG |
351 | /* Tries to create and open a new datapath with the given 'name' and 'type'. |
352 | * 'type' may be either NULL or the empty string to specify the default system | |
353 | * type. Will fail if a datapath with 'name' and 'type' already exists. | |
354 | * Returns 0 if successful, otherwise a positive errno value. On success | |
355 | * stores a pointer to the datapath in '*dpifp', otherwise a null pointer. */ | |
064af421 | 356 | int |
1a6f1e2a | 357 | dpif_create(const char *name, const char *type, struct dpif **dpifp) |
064af421 | 358 | { |
1a6f1e2a | 359 | return do_open(name, type, true, dpifp); |
96fba48f | 360 | } |
064af421 | 361 | |
1a6f1e2a JG |
362 | /* Tries to open a datapath with the given 'name' and 'type', creating it if it |
363 | * does not exist. 'type' may be either NULL or the empty string to specify | |
364 | * the default system type. Returns 0 if successful, otherwise a positive | |
365 | * errno value. On success stores a pointer to the datapath in '*dpifp', | |
366 | * otherwise a null pointer. */ | |
efacbce6 | 367 | int |
1a6f1e2a | 368 | dpif_create_and_open(const char *name, const char *type, struct dpif **dpifp) |
efacbce6 BP |
369 | { |
370 | int error; | |
371 | ||
1a6f1e2a | 372 | error = dpif_create(name, type, dpifp); |
efacbce6 | 373 | if (error == EEXIST || error == EBUSY) { |
1a6f1e2a | 374 | error = dpif_open(name, type, dpifp); |
efacbce6 BP |
375 | if (error) { |
376 | VLOG_WARN("datapath %s already exists but cannot be opened: %s", | |
10a89ef0 | 377 | name, ovs_strerror(error)); |
efacbce6 BP |
378 | } |
379 | } else if (error) { | |
10a89ef0 BP |
380 | VLOG_WARN("failed to create datapath %s: %s", |
381 | name, ovs_strerror(error)); | |
efacbce6 BP |
382 | } |
383 | return error; | |
384 | } | |
385 | ||
96fba48f BP |
386 | /* Closes and frees the connection to 'dpif'. Does not destroy the datapath |
387 | * itself; call dpif_delete() first, instead, if that is desirable. */ | |
388 | void | |
389 | dpif_close(struct dpif *dpif) | |
390 | { | |
391 | if (dpif) { | |
5703b15f | 392 | struct registered_dpif_class *rc; |
999401aa | 393 | |
5703b15f | 394 | rc = shash_find_data(&dpif_classes, dpif->dpif_class->type); |
999401aa | 395 | dpif_uninit(dpif, true); |
5703b15f | 396 | dp_class_unref(rc); |
064af421 BP |
397 | } |
398 | } | |
399 | ||
640e1b20 BP |
400 | /* Performs periodic work needed by 'dpif'. */ |
401 | void | |
402 | dpif_run(struct dpif *dpif) | |
403 | { | |
404 | if (dpif->dpif_class->run) { | |
405 | dpif->dpif_class->run(dpif); | |
406 | } | |
407 | } | |
408 | ||
409 | /* Arranges for poll_block() to wake up when dp_run() needs to be called for | |
410 | * 'dpif'. */ | |
411 | void | |
412 | dpif_wait(struct dpif *dpif) | |
413 | { | |
414 | if (dpif->dpif_class->wait) { | |
415 | dpif->dpif_class->wait(dpif); | |
416 | } | |
417 | } | |
418 | ||
1a6f1e2a JG |
419 | /* Returns the name of datapath 'dpif' prefixed with the type |
420 | * (for use in log messages). */ | |
b29ba128 BP |
421 | const char * |
422 | dpif_name(const struct dpif *dpif) | |
423 | { | |
1a6f1e2a JG |
424 | return dpif->full_name; |
425 | } | |
426 | ||
427 | /* Returns the name of datapath 'dpif' without the type | |
428 | * (for use in device names). */ | |
429 | const char * | |
430 | dpif_base_name(const struct dpif *dpif) | |
431 | { | |
432 | return dpif->base_name; | |
b29ba128 BP |
433 | } |
434 | ||
c7a26215 JP |
435 | /* Returns the type of datapath 'dpif'. */ |
436 | const char * | |
437 | dpif_type(const struct dpif *dpif) | |
438 | { | |
439 | return dpif->dpif_class->type; | |
440 | } | |
441 | ||
3a225db7 BP |
442 | /* Returns the fully spelled out name for the given datapath 'type'. |
443 | * | |
444 | * Normalized type string can be compared with strcmp(). Unnormalized type | |
445 | * string might be the same even if they have different spellings. */ | |
446 | const char * | |
447 | dpif_normalize_type(const char *type) | |
448 | { | |
449 | return type && type[0] ? type : "system"; | |
450 | } | |
451 | ||
96fba48f BP |
452 | /* Destroys the datapath that 'dpif' is connected to, first removing all of its |
453 | * ports. After calling this function, it does not make sense to pass 'dpif' | |
454 | * to any functions other than dpif_name() or dpif_close(). */ | |
064af421 BP |
455 | int |
456 | dpif_delete(struct dpif *dpif) | |
457 | { | |
96fba48f BP |
458 | int error; |
459 | ||
064af421 | 460 | COVERAGE_INC(dpif_destroy); |
96fba48f | 461 | |
1acb6baa | 462 | error = dpif->dpif_class->destroy(dpif); |
96fba48f BP |
463 | log_operation(dpif, "delete", error); |
464 | return error; | |
064af421 BP |
465 | } |
466 | ||
96fba48f BP |
467 | /* Retrieves statistics for 'dpif' into 'stats'. Returns 0 if successful, |
468 | * otherwise a positive errno value. */ | |
064af421 | 469 | int |
a8d9304d | 470 | dpif_get_dp_stats(const struct dpif *dpif, struct dpif_dp_stats *stats) |
064af421 | 471 | { |
1acb6baa | 472 | int error = dpif->dpif_class->get_stats(dpif, stats); |
96fba48f BP |
473 | if (error) { |
474 | memset(stats, 0, sizeof *stats); | |
475 | } | |
476 | log_operation(dpif, "get_stats", error); | |
477 | return error; | |
064af421 BP |
478 | } |
479 | ||
0aeaabc8 JP |
480 | const char * |
481 | dpif_port_open_type(const char *datapath_type, const char *port_type) | |
482 | { | |
5703b15f | 483 | struct registered_dpif_class *rc; |
0aeaabc8 JP |
484 | |
485 | datapath_type = dpif_normalize_type(datapath_type); | |
486 | ||
97be1538 | 487 | ovs_mutex_lock(&dpif_mutex); |
5703b15f BP |
488 | rc = shash_find_data(&dpif_classes, datapath_type); |
489 | if (rc && rc->dpif_class->port_open_type) { | |
490 | port_type = rc->dpif_class->port_open_type(rc->dpif_class, port_type); | |
0aeaabc8 | 491 | } |
97be1538 | 492 | ovs_mutex_unlock(&dpif_mutex); |
0aeaabc8 | 493 | |
5703b15f | 494 | return port_type; |
0aeaabc8 JP |
495 | } |
496 | ||
232dfa4a | 497 | /* Attempts to add 'netdev' as a port on 'dpif'. If 'port_nop' is |
4e022ec0 | 498 | * non-null and its value is not ODPP_NONE, then attempts to use the |
232dfa4a JP |
499 | * value as the port number. |
500 | * | |
501 | * If successful, returns 0 and sets '*port_nop' to the new port's port | |
502 | * number (if 'port_nop' is non-null). On failure, returns a positive | |
4e022ec0 | 503 | * errno value and sets '*port_nop' to ODPP_NONE (if 'port_nop' is |
232dfa4a | 504 | * non-null). */ |
064af421 | 505 | int |
4e022ec0 | 506 | dpif_port_add(struct dpif *dpif, struct netdev *netdev, odp_port_t *port_nop) |
064af421 | 507 | { |
c3827f61 | 508 | const char *netdev_name = netdev_get_name(netdev); |
4e022ec0 | 509 | odp_port_t port_no = ODPP_NONE; |
9ee3ae3e | 510 | int error; |
064af421 BP |
511 | |
512 | COVERAGE_INC(dpif_port_add); | |
9ee3ae3e | 513 | |
232dfa4a JP |
514 | if (port_nop) { |
515 | port_no = *port_nop; | |
516 | } | |
517 | ||
c3827f61 | 518 | error = dpif->dpif_class->port_add(dpif, netdev, &port_no); |
9ee3ae3e | 519 | if (!error) { |
9b56fe13 | 520 | VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu32, |
c3827f61 | 521 | dpif_name(dpif), netdev_name, port_no); |
064af421 | 522 | } else { |
9ee3ae3e | 523 | VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s", |
10a89ef0 | 524 | dpif_name(dpif), netdev_name, ovs_strerror(error)); |
4e022ec0 | 525 | port_no = ODPP_NONE; |
9ee3ae3e BP |
526 | } |
527 | if (port_nop) { | |
528 | *port_nop = port_no; | |
064af421 | 529 | } |
9ee3ae3e | 530 | return error; |
064af421 BP |
531 | } |
532 | ||
96fba48f BP |
533 | /* Attempts to remove 'dpif''s port number 'port_no'. Returns 0 if successful, |
534 | * otherwise a positive errno value. */ | |
064af421 | 535 | int |
4e022ec0 | 536 | dpif_port_del(struct dpif *dpif, odp_port_t port_no) |
064af421 | 537 | { |
96fba48f BP |
538 | int error; |
539 | ||
064af421 | 540 | COVERAGE_INC(dpif_port_del); |
96fba48f | 541 | |
1acb6baa | 542 | error = dpif->dpif_class->port_del(dpif, port_no); |
a1811296 | 543 | if (!error) { |
9b56fe13 | 544 | VLOG_DBG_RL(&dpmsg_rl, "%s: port_del(%"PRIu32")", |
a1811296 BP |
545 | dpif_name(dpif), port_no); |
546 | } else { | |
547 | log_operation(dpif, "port_del", error); | |
548 | } | |
96fba48f | 549 | return error; |
064af421 BP |
550 | } |
551 | ||
4c738a8d BP |
552 | /* Makes a deep copy of 'src' into 'dst'. */ |
553 | void | |
554 | dpif_port_clone(struct dpif_port *dst, const struct dpif_port *src) | |
555 | { | |
556 | dst->name = xstrdup(src->name); | |
557 | dst->type = xstrdup(src->type); | |
558 | dst->port_no = src->port_no; | |
559 | } | |
560 | ||
561 | /* Frees memory allocated to members of 'dpif_port'. | |
562 | * | |
563 | * Do not call this function on a dpif_port obtained from | |
564 | * dpif_port_dump_next(): that function retains ownership of the data in the | |
565 | * dpif_port. */ | |
566 | void | |
567 | dpif_port_destroy(struct dpif_port *dpif_port) | |
568 | { | |
569 | free(dpif_port->name); | |
570 | free(dpif_port->type); | |
571 | } | |
572 | ||
4afba28d JP |
573 | /* Checks if port named 'devname' exists in 'dpif'. If so, returns |
574 | * true; otherwise, returns false. */ | |
575 | bool | |
576 | dpif_port_exists(const struct dpif *dpif, const char *devname) | |
577 | { | |
578 | int error = dpif->dpif_class->port_query_by_name(dpif, devname, NULL); | |
bee6b8bc | 579 | if (error != 0 && error != ENOENT && error != ENODEV) { |
4afba28d | 580 | VLOG_WARN_RL(&error_rl, "%s: failed to query port %s: %s", |
10a89ef0 | 581 | dpif_name(dpif), devname, ovs_strerror(error)); |
4afba28d JP |
582 | } |
583 | ||
584 | return !error; | |
585 | } | |
586 | ||
96fba48f BP |
587 | /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and |
588 | * initializes '*port' appropriately; on failure, returns a positive errno | |
4c738a8d BP |
589 | * value. |
590 | * | |
591 | * The caller owns the data in 'port' and must free it with | |
592 | * dpif_port_destroy() when it is no longer needed. */ | |
064af421 | 593 | int |
4e022ec0 | 594 | dpif_port_query_by_number(const struct dpif *dpif, odp_port_t port_no, |
4c738a8d | 595 | struct dpif_port *port) |
064af421 | 596 | { |
1acb6baa | 597 | int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port); |
96fba48f | 598 | if (!error) { |
9b56fe13 | 599 | VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu32" is device %s", |
4c738a8d | 600 | dpif_name(dpif), port_no, port->name); |
064af421 | 601 | } else { |
96fba48f | 602 | memset(port, 0, sizeof *port); |
9b56fe13 | 603 | VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu32": %s", |
10a89ef0 | 604 | dpif_name(dpif), port_no, ovs_strerror(error)); |
064af421 | 605 | } |
96fba48f | 606 | return error; |
064af421 BP |
607 | } |
608 | ||
96fba48f BP |
609 | /* Looks up port named 'devname' in 'dpif'. On success, returns 0 and |
610 | * initializes '*port' appropriately; on failure, returns a positive errno | |
4c738a8d BP |
611 | * value. |
612 | * | |
613 | * The caller owns the data in 'port' and must free it with | |
614 | * dpif_port_destroy() when it is no longer needed. */ | |
064af421 BP |
615 | int |
616 | dpif_port_query_by_name(const struct dpif *dpif, const char *devname, | |
4c738a8d | 617 | struct dpif_port *port) |
064af421 | 618 | { |
1acb6baa | 619 | int error = dpif->dpif_class->port_query_by_name(dpif, devname, port); |
96fba48f | 620 | if (!error) { |
9b56fe13 | 621 | VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu32, |
4c738a8d | 622 | dpif_name(dpif), devname, port->port_no); |
064af421 | 623 | } else { |
96fba48f BP |
624 | memset(port, 0, sizeof *port); |
625 | ||
d647f0a7 BP |
626 | /* For ENOENT or ENODEV we use DBG level because the caller is probably |
627 | * interested in whether 'dpif' actually has a port 'devname', so that | |
628 | * it's not an issue worth logging if it doesn't. Other errors are | |
629 | * uncommon and more likely to indicate a real problem. */ | |
630 | VLOG_RL(&error_rl, | |
631 | error == ENOENT || error == ENODEV ? VLL_DBG : VLL_WARN, | |
632 | "%s: failed to query port %s: %s", | |
10a89ef0 | 633 | dpif_name(dpif), devname, ovs_strerror(error)); |
064af421 | 634 | } |
96fba48f | 635 | return error; |
064af421 BP |
636 | } |
637 | ||
1954e6bb AW |
638 | /* Returns the Netlink PID value to supply in OVS_ACTION_ATTR_USERSPACE |
639 | * actions as the OVS_USERSPACE_ATTR_PID attribute's value, for use in | |
640 | * flows whose packets arrived on port 'port_no'. In the case where the | |
641 | * provider allocates multiple Netlink PIDs to a single port, it may use | |
642 | * 'hash' to spread load among them. The caller need not use a particular | |
643 | * hash function; a 5-tuple hash is suitable. | |
644 | * | |
645 | * (The datapath implementation might use some different hash function for | |
646 | * distributing packets received via flow misses among PIDs. This means | |
647 | * that packets received via flow misses might be reordered relative to | |
648 | * packets received via userspace actions. This is not ordinarily a | |
649 | * problem.) | |
98403001 | 650 | * |
4e022ec0 | 651 | * A 'port_no' of ODPP_NONE is a special case: it returns a reserved PID, not |
625b0720 BP |
652 | * allocated to any port, that the client may use for special purposes. |
653 | * | |
98403001 BP |
654 | * The return value is only meaningful when DPIF_UC_ACTION has been enabled in |
655 | * the 'dpif''s listen mask. It is allowed to change when DPIF_UC_ACTION is | |
656 | * disabled and then re-enabled, so a client that does that must be prepared to | |
657 | * update all of the flows that it installed that contain | |
658 | * OVS_ACTION_ATTR_USERSPACE actions. */ | |
659 | uint32_t | |
1954e6bb | 660 | dpif_port_get_pid(const struct dpif *dpif, odp_port_t port_no, uint32_t hash) |
98403001 BP |
661 | { |
662 | return (dpif->dpif_class->port_get_pid | |
1954e6bb | 663 | ? (dpif->dpif_class->port_get_pid)(dpif, port_no, hash) |
98403001 BP |
664 | : 0); |
665 | } | |
666 | ||
96fba48f BP |
667 | /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and copies |
668 | * the port's name into the 'name_size' bytes in 'name', ensuring that the | |
669 | * result is null-terminated. On failure, returns a positive errno value and | |
670 | * makes 'name' the empty string. */ | |
335562c0 | 671 | int |
4e022ec0 | 672 | dpif_port_get_name(struct dpif *dpif, odp_port_t port_no, |
335562c0 BP |
673 | char *name, size_t name_size) |
674 | { | |
4c738a8d | 675 | struct dpif_port port; |
335562c0 BP |
676 | int error; |
677 | ||
cb22974d | 678 | ovs_assert(name_size > 0); |
335562c0 BP |
679 | |
680 | error = dpif_port_query_by_number(dpif, port_no, &port); | |
681 | if (!error) { | |
4c738a8d BP |
682 | ovs_strlcpy(name, port.name, name_size); |
683 | dpif_port_destroy(&port); | |
335562c0 BP |
684 | } else { |
685 | *name = '\0'; | |
686 | } | |
687 | return error; | |
688 | } | |
689 | ||
b0ec0f27 | 690 | /* Initializes 'dump' to begin dumping the ports in a dpif. |
96fba48f | 691 | * |
b0ec0f27 BP |
692 | * This function provides no status indication. An error status for the entire |
693 | * dump operation is provided when it is completed by calling | |
694 | * dpif_port_dump_done(). | |
695 | */ | |
696 | void | |
697 | dpif_port_dump_start(struct dpif_port_dump *dump, const struct dpif *dpif) | |
698 | { | |
699 | dump->dpif = dpif; | |
700 | dump->error = dpif->dpif_class->port_dump_start(dpif, &dump->state); | |
701 | log_operation(dpif, "port_dump_start", dump->error); | |
702 | } | |
703 | ||
704 | /* Attempts to retrieve another port from 'dump', which must have been | |
4c738a8d | 705 | * initialized with dpif_port_dump_start(). On success, stores a new dpif_port |
b0ec0f27 | 706 | * into 'port' and returns true. On failure, returns false. |
96fba48f | 707 | * |
b0ec0f27 BP |
708 | * Failure might indicate an actual error or merely that the last port has been |
709 | * dumped. An error status for the entire dump operation is provided when it | |
4c738a8d BP |
710 | * is completed by calling dpif_port_dump_done(). |
711 | * | |
712 | * The dpif owns the data stored in 'port'. It will remain valid until at | |
713 | * least the next time 'dump' is passed to dpif_port_dump_next() or | |
714 | * dpif_port_dump_done(). */ | |
b0ec0f27 | 715 | bool |
4c738a8d | 716 | dpif_port_dump_next(struct dpif_port_dump *dump, struct dpif_port *port) |
064af421 | 717 | { |
b0ec0f27 | 718 | const struct dpif *dpif = dump->dpif; |
064af421 | 719 | |
b0ec0f27 BP |
720 | if (dump->error) { |
721 | return false; | |
722 | } | |
f4ba4c4f | 723 | |
b0ec0f27 BP |
724 | dump->error = dpif->dpif_class->port_dump_next(dpif, dump->state, port); |
725 | if (dump->error == EOF) { | |
726 | VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all ports", dpif_name(dpif)); | |
727 | } else { | |
728 | log_operation(dpif, "port_dump_next", dump->error); | |
729 | } | |
064af421 | 730 | |
b0ec0f27 BP |
731 | if (dump->error) { |
732 | dpif->dpif_class->port_dump_done(dpif, dump->state); | |
733 | return false; | |
f4ba4c4f | 734 | } |
b0ec0f27 BP |
735 | return true; |
736 | } | |
064af421 | 737 | |
b0ec0f27 BP |
738 | /* Completes port table dump operation 'dump', which must have been initialized |
739 | * with dpif_port_dump_start(). Returns 0 if the dump operation was | |
740 | * error-free, otherwise a positive errno value describing the problem. */ | |
741 | int | |
742 | dpif_port_dump_done(struct dpif_port_dump *dump) | |
743 | { | |
744 | const struct dpif *dpif = dump->dpif; | |
745 | if (!dump->error) { | |
746 | dump->error = dpif->dpif_class->port_dump_done(dpif, dump->state); | |
747 | log_operation(dpif, "port_dump_done", dump->error); | |
f4ba4c4f | 748 | } |
b0ec0f27 | 749 | return dump->error == EOF ? 0 : dump->error; |
064af421 BP |
750 | } |
751 | ||
e9e28be3 BP |
752 | /* Polls for changes in the set of ports in 'dpif'. If the set of ports in |
753 | * 'dpif' has changed, this function does one of the following: | |
754 | * | |
755 | * - Stores the name of the device that was added to or deleted from 'dpif' in | |
756 | * '*devnamep' and returns 0. The caller is responsible for freeing | |
757 | * '*devnamep' (with free()) when it no longer needs it. | |
758 | * | |
759 | * - Returns ENOBUFS and sets '*devnamep' to NULL. | |
760 | * | |
761 | * This function may also return 'false positives', where it returns 0 and | |
762 | * '*devnamep' names a device that was not actually added or deleted or it | |
763 | * returns ENOBUFS without any change. | |
764 | * | |
765 | * Returns EAGAIN if the set of ports in 'dpif' has not changed. May also | |
766 | * return other positive errno values to indicate that something has gone | |
767 | * wrong. */ | |
768 | int | |
769 | dpif_port_poll(const struct dpif *dpif, char **devnamep) | |
770 | { | |
1acb6baa | 771 | int error = dpif->dpif_class->port_poll(dpif, devnamep); |
e9e28be3 BP |
772 | if (error) { |
773 | *devnamep = NULL; | |
774 | } | |
775 | return error; | |
776 | } | |
777 | ||
778 | /* Arranges for the poll loop to wake up when port_poll(dpif) will return a | |
779 | * value other than EAGAIN. */ | |
780 | void | |
781 | dpif_port_poll_wait(const struct dpif *dpif) | |
782 | { | |
1acb6baa | 783 | dpif->dpif_class->port_poll_wait(dpif); |
e9e28be3 BP |
784 | } |
785 | ||
572b7068 | 786 | /* Extracts the flow stats for a packet. The 'flow' and 'packet' |
a7752d4a BP |
787 | * arguments must have been initialized through a call to flow_extract(). |
788 | * 'used' is stored into stats->used. */ | |
572b7068 | 789 | void |
a39edbd4 | 790 | dpif_flow_stats_extract(const struct flow *flow, const struct ofpbuf *packet, |
a7752d4a | 791 | long long int used, struct dpif_flow_stats *stats) |
572b7068 | 792 | { |
e0eecb1c | 793 | stats->tcp_flags = ntohs(flow->tcp_flags); |
1f317cb5 | 794 | stats->n_bytes = ofpbuf_size(packet); |
572b7068 | 795 | stats->n_packets = 1; |
a7752d4a | 796 | stats->used = used; |
572b7068 BP |
797 | } |
798 | ||
c97fb132 BP |
799 | /* Appends a human-readable representation of 'stats' to 's'. */ |
800 | void | |
801 | dpif_flow_stats_format(const struct dpif_flow_stats *stats, struct ds *s) | |
802 | { | |
803 | ds_put_format(s, "packets:%"PRIu64", bytes:%"PRIu64", used:", | |
804 | stats->n_packets, stats->n_bytes); | |
805 | if (stats->used) { | |
806 | ds_put_format(s, "%.3fs", (time_msec() - stats->used) / 1000.0); | |
807 | } else { | |
808 | ds_put_format(s, "never"); | |
809 | } | |
7393104d BP |
810 | if (stats->tcp_flags) { |
811 | ds_put_cstr(s, ", flags:"); | |
812 | packet_format_tcp_flags(s, stats->tcp_flags); | |
813 | } | |
c97fb132 BP |
814 | } |
815 | ||
96fba48f BP |
816 | /* Deletes all flows from 'dpif'. Returns 0 if successful, otherwise a |
817 | * positive errno value. */ | |
818 | int | |
819 | dpif_flow_flush(struct dpif *dpif) | |
064af421 | 820 | { |
96fba48f BP |
821 | int error; |
822 | ||
823 | COVERAGE_INC(dpif_flow_flush); | |
824 | ||
1acb6baa | 825 | error = dpif->dpif_class->flow_flush(dpif); |
96fba48f BP |
826 | log_operation(dpif, "flow_flush", error); |
827 | return error; | |
064af421 BP |
828 | } |
829 | ||
feebdea2 | 830 | /* Queries 'dpif' for a flow entry. The flow is specified by the Netlink |
df2c07f4 | 831 | * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at |
feebdea2 | 832 | * 'key'. |
96fba48f | 833 | * |
feebdea2 BP |
834 | * Returns 0 if successful. If no flow matches, returns ENOENT. On other |
835 | * failure, returns a positive errno value. | |
96fba48f | 836 | * |
feebdea2 BP |
837 | * If 'actionsp' is nonnull, then on success '*actionsp' will be set to an |
838 | * ofpbuf owned by the caller that contains the Netlink attributes for the | |
839 | * flow's actions. The caller must free the ofpbuf (with ofpbuf_delete()) when | |
840 | * it is no longer needed. | |
841 | * | |
842 | * If 'stats' is nonnull, then on success it will be updated with the flow's | |
843 | * statistics. */ | |
96fba48f | 844 | int |
693c4a01 | 845 | dpif_flow_get(const struct dpif *dpif, |
feebdea2 | 846 | const struct nlattr *key, size_t key_len, |
c97fb132 | 847 | struct ofpbuf **actionsp, struct dpif_flow_stats *stats) |
064af421 | 848 | { |
96fba48f BP |
849 | int error; |
850 | ||
851 | COVERAGE_INC(dpif_flow_get); | |
852 | ||
693c4a01 | 853 | error = dpif->dpif_class->flow_get(dpif, key, key_len, actionsp, stats); |
b843fa1b | 854 | if (error) { |
feebdea2 BP |
855 | if (actionsp) { |
856 | *actionsp = NULL; | |
857 | } | |
858 | if (stats) { | |
859 | memset(stats, 0, sizeof *stats); | |
860 | } | |
b843fa1b | 861 | } |
96fba48f | 862 | if (should_log_flow_message(error)) { |
feebdea2 BP |
863 | const struct nlattr *actions; |
864 | size_t actions_len; | |
865 | ||
866 | if (!error && actionsp) { | |
1f317cb5 PS |
867 | actions = ofpbuf_data(*actionsp); |
868 | actions_len = ofpbuf_size(*actionsp); | |
feebdea2 BP |
869 | } else { |
870 | actions = NULL; | |
871 | actions_len = 0; | |
872 | } | |
61fb711d JP |
873 | log_flow_message(dpif, error, "flow_get", key, key_len, |
874 | NULL, 0, stats, actions, actions_len); | |
064af421 | 875 | } |
96fba48f | 876 | return error; |
064af421 BP |
877 | } |
878 | ||
89625d1e BP |
879 | static int |
880 | dpif_flow_put__(struct dpif *dpif, const struct dpif_flow_put *put) | |
881 | { | |
882 | int error; | |
883 | ||
884 | COVERAGE_INC(dpif_flow_put); | |
cb22974d BP |
885 | ovs_assert(!(put->flags & ~(DPIF_FP_CREATE | DPIF_FP_MODIFY |
886 | | DPIF_FP_ZERO_STATS))); | |
89625d1e BP |
887 | |
888 | error = dpif->dpif_class->flow_put(dpif, put); | |
889 | if (error && put->stats) { | |
890 | memset(put->stats, 0, sizeof *put->stats); | |
891 | } | |
892 | log_flow_put_message(dpif, put, error); | |
893 | return error; | |
894 | } | |
895 | ||
feebdea2 | 896 | /* Adds or modifies a flow in 'dpif'. The flow is specified by the Netlink |
e6cc0bab | 897 | * attribute OVS_FLOW_ATTR_KEY with types OVS_KEY_ATTR_* in the 'key_len' bytes |
ee75c546 BP |
898 | * starting at 'key', and OVS_FLOW_ATTR_MASK with types of OVS_KEY_ATTR_* in |
899 | * the 'mask_len' bytes starting at 'mask'. The associated actions are | |
900 | * specified by the Netlink attributes with types OVS_ACTION_ATTR_* in the | |
901 | * 'actions_len' bytes starting at 'actions'. | |
96fba48f | 902 | * |
feebdea2 | 903 | * - If the flow's key does not exist in 'dpif', then the flow will be added if |
ba25b8f4 | 904 | * 'flags' includes DPIF_FP_CREATE. Otherwise the operation will fail with |
96fba48f BP |
905 | * ENOENT. |
906 | * | |
ee75c546 BP |
907 | * The datapath may reject attempts to insert overlapping flows with EINVAL |
908 | * or EEXIST, but clients should not rely on this: avoiding overlapping flows | |
909 | * is primarily the client's responsibility. | |
910 | * | |
feebdea2 | 911 | * If the operation succeeds, then 'stats', if nonnull, will be zeroed. |
96fba48f | 912 | * |
feebdea2 | 913 | * - If the flow's key does exist in 'dpif', then the flow's actions will be |
ba25b8f4 | 914 | * updated if 'flags' includes DPIF_FP_MODIFY. Otherwise the operation will |
feebdea2 | 915 | * fail with EEXIST. If the flow's actions are updated, then its statistics |
ba25b8f4 | 916 | * will be zeroed if 'flags' includes DPIF_FP_ZERO_STATS, and left as-is |
feebdea2 BP |
917 | * otherwise. |
918 | * | |
919 | * If the operation succeeds, then 'stats', if nonnull, will be set to the | |
920 | * flow's statistics before the update. | |
96fba48f | 921 | */ |
064af421 | 922 | int |
ba25b8f4 | 923 | dpif_flow_put(struct dpif *dpif, enum dpif_flow_put_flags flags, |
feebdea2 | 924 | const struct nlattr *key, size_t key_len, |
e6cc0bab | 925 | const struct nlattr *mask, size_t mask_len, |
feebdea2 | 926 | const struct nlattr *actions, size_t actions_len, |
c97fb132 | 927 | struct dpif_flow_stats *stats) |
064af421 | 928 | { |
89625d1e BP |
929 | struct dpif_flow_put put; |
930 | ||
931 | put.flags = flags; | |
932 | put.key = key; | |
933 | put.key_len = key_len; | |
e6cc0bab AZ |
934 | put.mask = mask; |
935 | put.mask_len = mask_len; | |
89625d1e BP |
936 | put.actions = actions; |
937 | put.actions_len = actions_len; | |
938 | put.stats = stats; | |
939 | return dpif_flow_put__(dpif, &put); | |
064af421 BP |
940 | } |
941 | ||
b99d3cee BP |
942 | static int |
943 | dpif_flow_del__(struct dpif *dpif, struct dpif_flow_del *del) | |
944 | { | |
945 | int error; | |
946 | ||
947 | COVERAGE_INC(dpif_flow_del); | |
948 | ||
949 | error = dpif->dpif_class->flow_del(dpif, del); | |
950 | if (error && del->stats) { | |
951 | memset(del->stats, 0, sizeof *del->stats); | |
952 | } | |
953 | log_flow_del_message(dpif, del, error); | |
954 | return error; | |
955 | } | |
956 | ||
feebdea2 BP |
957 | /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif' does |
958 | * not contain such a flow. The flow is specified by the Netlink attributes | |
df2c07f4 | 959 | * with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at 'key'. |
96fba48f | 960 | * |
feebdea2 BP |
961 | * If the operation succeeds, then 'stats', if nonnull, will be set to the |
962 | * flow's statistics before its deletion. */ | |
064af421 | 963 | int |
feebdea2 BP |
964 | dpif_flow_del(struct dpif *dpif, |
965 | const struct nlattr *key, size_t key_len, | |
c97fb132 | 966 | struct dpif_flow_stats *stats) |
064af421 | 967 | { |
b99d3cee | 968 | struct dpif_flow_del del; |
f1aa2072 | 969 | |
b99d3cee BP |
970 | del.key = key; |
971 | del.key_len = key_len; | |
972 | del.stats = stats; | |
973 | return dpif_flow_del__(dpif, &del); | |
064af421 BP |
974 | } |
975 | ||
ac64794a BP |
976 | /* Creates and returns a new 'struct dpif_flow_dump' for iterating through the |
977 | * flows in 'dpif'. | |
978 | * | |
979 | * This function always successfully returns a dpif_flow_dump. Error | |
980 | * reporting is deferred to dpif_flow_dump_destroy(). */ | |
981 | struct dpif_flow_dump * | |
982 | dpif_flow_dump_create(const struct dpif *dpif) | |
e723fd32 | 983 | { |
ac64794a | 984 | return dpif->dpif_class->flow_dump_create(dpif); |
e723fd32 JS |
985 | } |
986 | ||
ac64794a BP |
987 | /* Destroys 'dump', which must have been created with dpif_flow_dump_create(). |
988 | * All dpif_flow_dump_thread structures previously created for 'dump' must | |
989 | * previously have been destroyed. | |
990 | * | |
991 | * Returns 0 if the dump operation was error-free, otherwise a positive errno | |
992 | * value describing the problem. */ | |
993 | int | |
994 | dpif_flow_dump_destroy(struct dpif_flow_dump *dump) | |
e723fd32 | 995 | { |
ac64794a BP |
996 | const struct dpif *dpif = dump->dpif; |
997 | int error = dpif->dpif_class->flow_dump_destroy(dump); | |
998 | log_operation(dpif, "flow_dump_destroy", error); | |
999 | return error == EOF ? 0 : error; | |
e723fd32 JS |
1000 | } |
1001 | ||
ac64794a BP |
1002 | /* Returns new thread-local state for use with dpif_flow_dump_next(). */ |
1003 | struct dpif_flow_dump_thread * | |
1004 | dpif_flow_dump_thread_create(struct dpif_flow_dump *dump) | |
064af421 | 1005 | { |
ac64794a | 1006 | return dump->dpif->dpif_class->flow_dump_thread_create(dump); |
064af421 BP |
1007 | } |
1008 | ||
ac64794a BP |
1009 | /* Releases 'thread'. */ |
1010 | void | |
1011 | dpif_flow_dump_thread_destroy(struct dpif_flow_dump_thread *thread) | |
704a1e09 | 1012 | { |
ac64794a | 1013 | thread->dpif->dpif_class->flow_dump_thread_destroy(thread); |
704a1e09 BP |
1014 | } |
1015 | ||
ac64794a BP |
1016 | /* Attempts to retrieve up to 'max_flows' more flows from 'thread'. Returns 0 |
1017 | * if and only if no flows remained to be retrieved, otherwise a positive | |
1018 | * number reflecting the number of elements in 'flows[]' that were updated. | |
1019 | * The number of flows returned might be less than 'max_flows' because | |
1020 | * fewer than 'max_flows' remained, because this particular datapath does not | |
1021 | * benefit from batching, or because an error occurred partway through | |
1022 | * retrieval. Thus, the caller should continue calling until a 0 return value, | |
1023 | * even if intermediate return values are less than 'max_flows'. | |
bdeadfdd | 1024 | * |
ac64794a BP |
1025 | * No error status is immediately provided. An error status for the entire |
1026 | * dump operation is provided when it is completed by calling | |
1027 | * dpif_flow_dump_destroy(). | |
bdeadfdd | 1028 | * |
ac64794a BP |
1029 | * All of the data stored into 'flows' is owned by the datapath, not by the |
1030 | * caller, and the caller must not modify or free it. The datapath guarantees | |
1031 | * that it remains accessible and unchanged until at least the next call to | |
1032 | * dpif_flow_dump_next() for 'thread'. */ | |
704a1e09 | 1033 | int |
ac64794a BP |
1034 | dpif_flow_dump_next(struct dpif_flow_dump_thread *thread, |
1035 | struct dpif_flow *flows, int max_flows) | |
704a1e09 | 1036 | { |
ac64794a BP |
1037 | struct dpif *dpif = thread->dpif; |
1038 | int n; | |
1039 | ||
1040 | ovs_assert(max_flows > 0); | |
1041 | n = dpif->dpif_class->flow_dump_next(thread, flows, max_flows); | |
1042 | if (n > 0) { | |
1043 | struct dpif_flow *f; | |
1044 | ||
1045 | for (f = flows; f < &flows[n] && should_log_flow_message(0); f++) { | |
1046 | log_flow_message(dpif, 0, "flow_dump", | |
1047 | f->key, f->key_len, f->mask, f->mask_len, | |
1048 | &f->stats, f->actions, f->actions_len); | |
1049 | } | |
1050 | } else { | |
1051 | VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all flows", dpif_name(dpif)); | |
1052 | } | |
1053 | return n; | |
064af421 BP |
1054 | } |
1055 | ||
7fd91025 BP |
1056 | struct dpif_execute_helper_aux { |
1057 | struct dpif *dpif; | |
1058 | int error; | |
1059 | }; | |
1060 | ||
09f9da0b JR |
1061 | /* This is called for actions that need the context of the datapath to be |
1062 | * meaningful. */ | |
7fd91025 | 1063 | static void |
8cbf4f47 | 1064 | dpif_execute_helper_cb(void *aux_, struct dpif_packet **packets, int cnt, |
572f732a | 1065 | struct pkt_metadata *md, |
09f9da0b | 1066 | const struct nlattr *action, bool may_steal OVS_UNUSED) |
7fd91025 | 1067 | { |
758c456d | 1068 | struct dpif_execute_helper_aux *aux = aux_; |
09f9da0b | 1069 | int type = nl_attr_type(action); |
8cbf4f47 DDP |
1070 | struct ofpbuf * packet = &packets[0]->ofpbuf; |
1071 | ||
1072 | ovs_assert(cnt == 1); | |
758c456d | 1073 | |
09f9da0b JR |
1074 | switch ((enum ovs_action_attr)type) { |
1075 | case OVS_ACTION_ATTR_OUTPUT: | |
1076 | case OVS_ACTION_ATTR_USERSPACE: | |
2b651e44 BP |
1077 | case OVS_ACTION_ATTR_RECIRC: { |
1078 | struct dpif_execute execute; | |
1079 | struct ofpbuf execute_actions; | |
1080 | uint64_t stub[256 / 8]; | |
1081 | ||
1082 | if (md->tunnel.ip_dst) { | |
1083 | /* The Linux kernel datapath throws away the tunnel information | |
1084 | * that we supply as metadata. We have to use a "set" action to | |
1085 | * supply it. */ | |
1086 | ofpbuf_use_stub(&execute_actions, stub, sizeof stub); | |
1087 | odp_put_tunnel_action(&md->tunnel, &execute_actions); | |
1088 | ofpbuf_put(&execute_actions, action, NLA_ALIGN(action->nla_len)); | |
1089 | ||
1090 | execute.actions = ofpbuf_data(&execute_actions); | |
1091 | execute.actions_len = ofpbuf_size(&execute_actions); | |
1092 | } else { | |
1093 | execute.actions = action; | |
1094 | execute.actions_len = NLA_ALIGN(action->nla_len); | |
1095 | } | |
1096 | ||
8cbf4f47 | 1097 | execute.packet = packet; |
758c456d JR |
1098 | execute.md = *md; |
1099 | execute.needs_help = false; | |
1100 | aux->error = aux->dpif->dpif_class->execute(aux->dpif, &execute); | |
2b651e44 | 1101 | |
fc65bafc BP |
1102 | log_execute_message(aux->dpif, &execute, true, aux->error); |
1103 | ||
2b651e44 BP |
1104 | if (md->tunnel.ip_dst) { |
1105 | ofpbuf_uninit(&execute_actions); | |
1106 | } | |
09f9da0b | 1107 | break; |
2b651e44 | 1108 | } |
758c456d | 1109 | |
c6bf49f3 | 1110 | case OVS_ACTION_ATTR_HASH: |
09f9da0b JR |
1111 | case OVS_ACTION_ATTR_PUSH_VLAN: |
1112 | case OVS_ACTION_ATTR_POP_VLAN: | |
1113 | case OVS_ACTION_ATTR_PUSH_MPLS: | |
1114 | case OVS_ACTION_ATTR_POP_MPLS: | |
1115 | case OVS_ACTION_ATTR_SET: | |
1116 | case OVS_ACTION_ATTR_SAMPLE: | |
1117 | case OVS_ACTION_ATTR_UNSPEC: | |
1118 | case __OVS_ACTION_ATTR_MAX: | |
1119 | OVS_NOT_REACHED(); | |
1120 | } | |
7fd91025 BP |
1121 | } |
1122 | ||
1123 | /* Executes 'execute' by performing most of the actions in userspace and | |
1124 | * passing the fully constructed packets to 'dpif' for output and userspace | |
1125 | * actions. | |
1126 | * | |
1127 | * This helps with actions that a given 'dpif' doesn't implement directly. */ | |
1128 | static int | |
758c456d | 1129 | dpif_execute_with_help(struct dpif *dpif, struct dpif_execute *execute) |
7fd91025 | 1130 | { |
758c456d | 1131 | struct dpif_execute_helper_aux aux = {dpif, 0}; |
8cbf4f47 | 1132 | struct dpif_packet packet, *pp; |
7fd91025 BP |
1133 | |
1134 | COVERAGE_INC(dpif_execute_with_help); | |
1135 | ||
91088554 | 1136 | packet.ofpbuf = *execute->packet; |
8cbf4f47 | 1137 | pp = &packet; |
91088554 | 1138 | |
8cbf4f47 | 1139 | odp_execute_actions(&aux, &pp, 1, false, &execute->md, execute->actions, |
91088554 DDP |
1140 | execute->actions_len, dpif_execute_helper_cb); |
1141 | ||
1142 | /* Even though may_steal is set to false, some actions could modify or | |
1143 | * reallocate the ofpbuf memory. We need to pass those changes to the | |
1144 | * caller */ | |
1145 | *execute->packet = packet.ofpbuf; | |
1146 | ||
7fd91025 BP |
1147 | return aux.error; |
1148 | } | |
1149 | ||
87e5119b BP |
1150 | /* Returns true if the datapath needs help executing 'execute'. */ |
1151 | static bool | |
1152 | dpif_execute_needs_help(const struct dpif_execute *execute) | |
1153 | { | |
1154 | return execute->needs_help || nl_attr_oversized(execute->actions_len); | |
1155 | } | |
1156 | ||
758c456d JR |
1157 | /* Causes 'dpif' to perform the 'execute->actions_len' bytes of actions in |
1158 | * 'execute->actions' on the Ethernet frame in 'execute->packet' and on packet | |
1159 | * metadata in 'execute->md'. The implementation is allowed to modify both the | |
1160 | * '*execute->packet' and 'execute->md'. | |
1161 | * | |
1162 | * Some dpif providers do not implement every action. The Linux kernel | |
1163 | * datapath, in particular, does not implement ARP field modification. If | |
1164 | * 'needs_help' is true, the dpif layer executes in userspace all of the | |
1165 | * actions that it can, and for OVS_ACTION_ATTR_OUTPUT and | |
1166 | * OVS_ACTION_ATTR_USERSPACE actions it passes the packet through to the dpif | |
1167 | * implementation. | |
1168 | * | |
1169 | * This works even if 'execute->actions_len' is too long for a Netlink | |
1170 | * attribute. | |
1171 | * | |
1172 | * Returns 0 if successful, otherwise a positive errno value. */ | |
1173 | int | |
1174 | dpif_execute(struct dpif *dpif, struct dpif_execute *execute) | |
89625d1e BP |
1175 | { |
1176 | int error; | |
1177 | ||
1178 | COVERAGE_INC(dpif_execute); | |
1179 | if (execute->actions_len > 0) { | |
87e5119b | 1180 | error = (dpif_execute_needs_help(execute) |
7fd91025 BP |
1181 | ? dpif_execute_with_help(dpif, execute) |
1182 | : dpif->dpif_class->execute(dpif, execute)); | |
89625d1e BP |
1183 | } else { |
1184 | error = 0; | |
1185 | } | |
1186 | ||
fc65bafc | 1187 | log_execute_message(dpif, execute, false, error); |
89625d1e BP |
1188 | |
1189 | return error; | |
1190 | } | |
1191 | ||
6bc60024 BP |
1192 | /* Executes each of the 'n_ops' operations in 'ops' on 'dpif', in the order in |
1193 | * which they are specified, placing each operation's results in the "output" | |
1194 | * members documented in comments. | |
1195 | * | |
1196 | * This function exists because some datapaths can perform batched operations | |
1197 | * faster than individual operations. */ | |
1198 | void | |
c2b565b5 | 1199 | dpif_operate(struct dpif *dpif, struct dpif_op **ops, size_t n_ops) |
6bc60024 | 1200 | { |
6bc60024 | 1201 | if (dpif->dpif_class->operate) { |
7fd91025 BP |
1202 | while (n_ops > 0) { |
1203 | size_t chunk; | |
1204 | ||
1205 | /* Count 'chunk', the number of ops that can be executed without | |
1206 | * needing any help. Ops that need help should be rare, so we | |
1207 | * expect this to ordinarily be 'n_ops', that is, all the ops. */ | |
1208 | for (chunk = 0; chunk < n_ops; chunk++) { | |
1209 | struct dpif_op *op = ops[chunk]; | |
1210 | ||
87e5119b BP |
1211 | if (op->type == DPIF_OP_EXECUTE |
1212 | && dpif_execute_needs_help(&op->u.execute)) { | |
7fd91025 BP |
1213 | break; |
1214 | } | |
1215 | } | |
1216 | ||
1217 | if (chunk) { | |
1218 | /* Execute a chunk full of ops that the dpif provider can | |
1219 | * handle itself, without help. */ | |
1220 | size_t i; | |
1221 | ||
1222 | dpif->dpif_class->operate(dpif, ops, chunk); | |
1223 | ||
1224 | for (i = 0; i < chunk; i++) { | |
1225 | struct dpif_op *op = ops[i]; | |
1226 | ||
1227 | switch (op->type) { | |
1228 | case DPIF_OP_FLOW_PUT: | |
1229 | log_flow_put_message(dpif, &op->u.flow_put, op->error); | |
1230 | break; | |
1231 | ||
1232 | case DPIF_OP_FLOW_DEL: | |
1233 | log_flow_del_message(dpif, &op->u.flow_del, op->error); | |
1234 | break; | |
1235 | ||
1236 | case DPIF_OP_EXECUTE: | |
fc65bafc BP |
1237 | log_execute_message(dpif, &op->u.execute, false, |
1238 | op->error); | |
7fd91025 BP |
1239 | break; |
1240 | } | |
1241 | } | |
1242 | ||
1243 | ops += chunk; | |
1244 | n_ops -= chunk; | |
1245 | } else { | |
1246 | /* Help the dpif provider to execute one op. */ | |
1247 | struct dpif_op *op = ops[0]; | |
1248 | ||
758c456d | 1249 | op->error = dpif_execute(dpif, &op->u.execute); |
7fd91025 BP |
1250 | ops++; |
1251 | n_ops--; | |
1252 | } | |
1253 | } | |
1254 | } else { | |
1255 | size_t i; | |
f23d2845 BP |
1256 | |
1257 | for (i = 0; i < n_ops; i++) { | |
1258 | struct dpif_op *op = ops[i]; | |
1259 | ||
1260 | switch (op->type) { | |
1261 | case DPIF_OP_FLOW_PUT: | |
7fd91025 | 1262 | op->error = dpif_flow_put__(dpif, &op->u.flow_put); |
f23d2845 BP |
1263 | break; |
1264 | ||
b99d3cee | 1265 | case DPIF_OP_FLOW_DEL: |
7fd91025 | 1266 | op->error = dpif_flow_del__(dpif, &op->u.flow_del); |
b99d3cee BP |
1267 | break; |
1268 | ||
f23d2845 | 1269 | case DPIF_OP_EXECUTE: |
758c456d | 1270 | op->error = dpif_execute(dpif, &op->u.execute); |
f23d2845 | 1271 | break; |
b99d3cee | 1272 | |
7fd91025 | 1273 | default: |
428b2edd | 1274 | OVS_NOT_REACHED(); |
7fd91025 | 1275 | } |
6bc60024 BP |
1276 | } |
1277 | } | |
1278 | } | |
1279 | ||
01545c1a BP |
1280 | /* Returns a string that represents 'type', for use in log messages. */ |
1281 | const char * | |
1282 | dpif_upcall_type_to_string(enum dpif_upcall_type type) | |
1283 | { | |
1284 | switch (type) { | |
1285 | case DPIF_UC_MISS: return "miss"; | |
1286 | case DPIF_UC_ACTION: return "action"; | |
01545c1a BP |
1287 | case DPIF_N_UC_TYPES: default: return "<unknown>"; |
1288 | } | |
1289 | } | |
1290 | ||
a12b3ead BP |
1291 | /* Enables or disables receiving packets with dpif_recv() on 'dpif'. Returns 0 |
1292 | * if successful, otherwise a positive errno value. | |
98403001 | 1293 | * |
a12b3ead | 1294 | * Turning packet receive off and then back on may change the Netlink PID |
98403001 BP |
1295 | * assignments returned by dpif_port_get_pid(). If the client does this, it |
1296 | * must update all of the flows that have OVS_ACTION_ATTR_USERSPACE actions | |
1297 | * using the new PID assignment. */ | |
8f24562a | 1298 | int |
a12b3ead | 1299 | dpif_recv_set(struct dpif *dpif, bool enable) |
8f24562a | 1300 | { |
a12b3ead BP |
1301 | int error = dpif->dpif_class->recv_set(dpif, enable); |
1302 | log_operation(dpif, "recv_set", error); | |
96fba48f | 1303 | return error; |
8f24562a BP |
1304 | } |
1305 | ||
1954e6bb AW |
1306 | /* Refreshes the poll loops and Netlink sockets associated to each port, |
1307 | * when the number of upcall handlers (upcall receiving thread) is changed | |
1308 | * to 'n_handlers' and receiving packets for 'dpif' is enabled by | |
1309 | * recv_set(). | |
1310 | * | |
1311 | * Since multiple upcall handlers can read upcalls simultaneously from | |
1312 | * 'dpif', each port can have multiple Netlink sockets, one per upcall | |
1313 | * handler. So, handlers_set() is responsible for the following tasks: | |
1314 | * | |
1315 | * When receiving upcall is enabled, extends or creates the | |
1316 | * configuration to support: | |
1317 | * | |
1318 | * - 'n_handlers' Netlink sockets for each port. | |
1319 | * | |
1320 | * - 'n_handlers' poll loops, one for each upcall handler. | |
1321 | * | |
1322 | * - registering the Netlink sockets for the same upcall handler to | |
1323 | * the corresponding poll loop. | |
1324 | * | |
1325 | * Returns 0 if successful, otherwise a positive errno value. */ | |
1326 | int | |
1327 | dpif_handlers_set(struct dpif *dpif, uint32_t n_handlers) | |
1328 | { | |
1329 | int error = dpif->dpif_class->handlers_set(dpif, n_handlers); | |
1330 | log_operation(dpif, "handlers_set", error); | |
1331 | return error; | |
1332 | } | |
1333 | ||
1334 | /* Polls for an upcall from 'dpif' for an upcall handler. Since there | |
1335 | * there can be multiple poll loops, 'handler_id' is needed as index to | |
1336 | * identify the corresponding poll loop. If successful, stores the upcall | |
1337 | * into '*upcall', using 'buf' for storage. Should only be called if | |
1338 | * 'recv_set' has been used to enable receiving packets from 'dpif'. | |
96fba48f | 1339 | * |
da546e07 JR |
1340 | * 'upcall->key' and 'upcall->userdata' point into data in the caller-provided |
1341 | * 'buf', so their memory cannot be freed separately from 'buf'. | |
856081f6 | 1342 | * |
837a88dc JR |
1343 | * The caller owns the data of 'upcall->packet' and may modify it. If |
1344 | * packet's headroom is exhausted as it is manipulated, 'upcall->packet' | |
1345 | * will be reallocated. This requires the data of 'upcall->packet' to be | |
1346 | * released with ofpbuf_uninit() before 'upcall' is destroyed. However, | |
1347 | * when an error is returned, the 'upcall->packet' may be uninitialized | |
1348 | * and should not be released. | |
1349 | * | |
96fba48f | 1350 | * Returns 0 if successful, otherwise a positive errno value. Returns EAGAIN |
856081f6 | 1351 | * if no upcall is immediately available. */ |
064af421 | 1352 | int |
1954e6bb AW |
1353 | dpif_recv(struct dpif *dpif, uint32_t handler_id, struct dpif_upcall *upcall, |
1354 | struct ofpbuf *buf) | |
064af421 | 1355 | { |
1954e6bb | 1356 | int error = dpif->dpif_class->recv(dpif, handler_id, upcall, buf); |
856081f6 | 1357 | if (!error && !VLOG_DROP_DBG(&dpmsg_rl)) { |
01545c1a BP |
1358 | struct ds flow; |
1359 | char *packet; | |
1360 | ||
1f317cb5 PS |
1361 | packet = ofp_packet_to_string(ofpbuf_data(&upcall->packet), |
1362 | ofpbuf_size(&upcall->packet)); | |
01545c1a BP |
1363 | |
1364 | ds_init(&flow); | |
1365 | odp_flow_key_format(upcall->key, upcall->key_len, &flow); | |
1366 | ||
1367 | VLOG_DBG("%s: %s upcall:\n%s\n%s", | |
1368 | dpif_name(dpif), dpif_upcall_type_to_string(upcall->type), | |
1369 | ds_cstr(&flow), packet); | |
1370 | ||
1371 | ds_destroy(&flow); | |
1372 | free(packet); | |
5fcc0d00 BP |
1373 | } else if (error && error != EAGAIN) { |
1374 | log_operation(dpif, "recv", error); | |
064af421 | 1375 | } |
064af421 BP |
1376 | return error; |
1377 | } | |
1378 | ||
96fba48f | 1379 | /* Discards all messages that would otherwise be received by dpif_recv() on |
1ba530f4 BP |
1380 | * 'dpif'. */ |
1381 | void | |
96fba48f BP |
1382 | dpif_recv_purge(struct dpif *dpif) |
1383 | { | |
96fba48f | 1384 | COVERAGE_INC(dpif_purge); |
1ba530f4 BP |
1385 | if (dpif->dpif_class->recv_purge) { |
1386 | dpif->dpif_class->recv_purge(dpif); | |
96fba48f | 1387 | } |
96fba48f BP |
1388 | } |
1389 | ||
1954e6bb AW |
1390 | /* Arranges for the poll loop for an upcall handler to wake up when 'dpif' |
1391 | * 'dpif' has a message queued to be received with the recv member | |
1392 | * function. Since there can be multiple poll loops, 'handler_id' is | |
1393 | * needed as index to identify the corresponding poll loop. */ | |
064af421 | 1394 | void |
1954e6bb | 1395 | dpif_recv_wait(struct dpif *dpif, uint32_t handler_id) |
064af421 | 1396 | { |
1954e6bb | 1397 | dpif->dpif_class->recv_wait(dpif, handler_id); |
064af421 | 1398 | } |
53a4218d | 1399 | |
96fba48f BP |
1400 | /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type' |
1401 | * and '*engine_id', respectively. */ | |
53a4218d BP |
1402 | void |
1403 | dpif_get_netflow_ids(const struct dpif *dpif, | |
1404 | uint8_t *engine_type, uint8_t *engine_id) | |
1405 | { | |
96fba48f BP |
1406 | *engine_type = dpif->netflow_engine_type; |
1407 | *engine_id = dpif->netflow_engine_id; | |
1408 | } | |
aae51f53 BP |
1409 | |
1410 | /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority | |
abff858b PS |
1411 | * value used for setting packet priority. |
1412 | * On success, returns 0 and stores the priority into '*priority'. | |
1413 | * On failure, returns a positive errno value and stores 0 into '*priority'. */ | |
aae51f53 BP |
1414 | int |
1415 | dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id, | |
1416 | uint32_t *priority) | |
1417 | { | |
1418 | int error = (dpif->dpif_class->queue_to_priority | |
1419 | ? dpif->dpif_class->queue_to_priority(dpif, queue_id, | |
1420 | priority) | |
1421 | : EOPNOTSUPP); | |
1422 | if (error) { | |
1423 | *priority = 0; | |
1424 | } | |
1425 | log_operation(dpif, "queue_to_priority", error); | |
1426 | return error; | |
1427 | } | |
96fba48f BP |
1428 | \f |
1429 | void | |
1acb6baa BP |
1430 | dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class, |
1431 | const char *name, | |
96fba48f BP |
1432 | uint8_t netflow_engine_type, uint8_t netflow_engine_id) |
1433 | { | |
1acb6baa | 1434 | dpif->dpif_class = dpif_class; |
1a6f1e2a | 1435 | dpif->base_name = xstrdup(name); |
a4af0040 | 1436 | dpif->full_name = xasprintf("%s@%s", dpif_class->type, name); |
96fba48f BP |
1437 | dpif->netflow_engine_type = netflow_engine_type; |
1438 | dpif->netflow_engine_id = netflow_engine_id; | |
1439 | } | |
999401aa JG |
1440 | |
1441 | /* Undoes the results of initialization. | |
1442 | * | |
1443 | * Normally this function only needs to be called from dpif_close(). | |
1444 | * However, it may be called by providers due to an error on opening | |
1445 | * that occurs after initialization. It this case dpif_close() would | |
1446 | * never be called. */ | |
1447 | void | |
1448 | dpif_uninit(struct dpif *dpif, bool close) | |
1449 | { | |
1450 | char *base_name = dpif->base_name; | |
1451 | char *full_name = dpif->full_name; | |
1452 | ||
1453 | if (close) { | |
a4af0040 | 1454 | dpif->dpif_class->close(dpif); |
999401aa JG |
1455 | } |
1456 | ||
1457 | free(base_name); | |
1458 | free(full_name); | |
1459 | } | |
96fba48f BP |
1460 | \f |
1461 | static void | |
1462 | log_operation(const struct dpif *dpif, const char *operation, int error) | |
1463 | { | |
1464 | if (!error) { | |
1465 | VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation); | |
90bf1e07 | 1466 | } else if (ofperr_is_valid(error)) { |
96fba48f | 1467 | VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)", |
90bf1e07 | 1468 | dpif_name(dpif), operation, ofperr_get_name(error)); |
71ce9235 | 1469 | } else { |
90bf1e07 | 1470 | VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)", |
10a89ef0 | 1471 | dpif_name(dpif), operation, ovs_strerror(error)); |
96fba48f BP |
1472 | } |
1473 | } | |
1474 | ||
1475 | static enum vlog_level | |
1476 | flow_message_log_level(int error) | |
1477 | { | |
9b1a48c2 JP |
1478 | /* If flows arrive in a batch, userspace may push down multiple |
1479 | * unique flow definitions that overlap when wildcards are applied. | |
1480 | * Kernels that support flow wildcarding will reject these flows as | |
1481 | * duplicates (EEXIST), so lower the log level to debug for these | |
1482 | * types of messages. */ | |
1483 | return (error && error != EEXIST) ? VLL_WARN : VLL_DBG; | |
96fba48f BP |
1484 | } |
1485 | ||
1486 | static bool | |
1487 | should_log_flow_message(int error) | |
1488 | { | |
1489 | return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error), | |
1490 | error ? &error_rl : &dpmsg_rl); | |
1491 | } | |
1492 | ||
1493 | static void | |
1494 | log_flow_message(const struct dpif *dpif, int error, const char *operation, | |
36956a7d | 1495 | const struct nlattr *key, size_t key_len, |
61fb711d | 1496 | const struct nlattr *mask, size_t mask_len, |
c97fb132 | 1497 | const struct dpif_flow_stats *stats, |
cf22f8cb | 1498 | const struct nlattr *actions, size_t actions_len) |
96fba48f BP |
1499 | { |
1500 | struct ds ds = DS_EMPTY_INITIALIZER; | |
1501 | ds_put_format(&ds, "%s: ", dpif_name(dpif)); | |
1502 | if (error) { | |
1503 | ds_put_cstr(&ds, "failed to "); | |
1504 | } | |
1505 | ds_put_format(&ds, "%s ", operation); | |
1506 | if (error) { | |
10a89ef0 | 1507 | ds_put_format(&ds, "(%s) ", ovs_strerror(error)); |
96fba48f | 1508 | } |
0a37839c | 1509 | odp_flow_format(key, key_len, mask, mask_len, NULL, &ds, true); |
96fba48f BP |
1510 | if (stats) { |
1511 | ds_put_cstr(&ds, ", "); | |
c97fb132 | 1512 | dpif_flow_stats_format(stats, &ds); |
96fba48f | 1513 | } |
cdee00fd | 1514 | if (actions || actions_len) { |
96fba48f | 1515 | ds_put_cstr(&ds, ", actions:"); |
cdee00fd | 1516 | format_odp_actions(&ds, actions, actions_len); |
96fba48f BP |
1517 | } |
1518 | vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds)); | |
1519 | ds_destroy(&ds); | |
1520 | } | |
89625d1e BP |
1521 | |
1522 | static void | |
1523 | log_flow_put_message(struct dpif *dpif, const struct dpif_flow_put *put, | |
1524 | int error) | |
1525 | { | |
1526 | if (should_log_flow_message(error)) { | |
1527 | struct ds s; | |
1528 | ||
1529 | ds_init(&s); | |
1530 | ds_put_cstr(&s, "put"); | |
1531 | if (put->flags & DPIF_FP_CREATE) { | |
1532 | ds_put_cstr(&s, "[create]"); | |
1533 | } | |
1534 | if (put->flags & DPIF_FP_MODIFY) { | |
1535 | ds_put_cstr(&s, "[modify]"); | |
1536 | } | |
1537 | if (put->flags & DPIF_FP_ZERO_STATS) { | |
1538 | ds_put_cstr(&s, "[zero]"); | |
1539 | } | |
1540 | log_flow_message(dpif, error, ds_cstr(&s), | |
61fb711d JP |
1541 | put->key, put->key_len, put->mask, put->mask_len, |
1542 | put->stats, put->actions, put->actions_len); | |
89625d1e BP |
1543 | ds_destroy(&s); |
1544 | } | |
1545 | } | |
1546 | ||
b99d3cee BP |
1547 | static void |
1548 | log_flow_del_message(struct dpif *dpif, const struct dpif_flow_del *del, | |
1549 | int error) | |
1550 | { | |
1551 | if (should_log_flow_message(error)) { | |
1552 | log_flow_message(dpif, error, "flow_del", del->key, del->key_len, | |
61fb711d | 1553 | NULL, 0, !error ? del->stats : NULL, NULL, 0); |
b99d3cee BP |
1554 | } |
1555 | } | |
1556 | ||
f0fe12fc BP |
1557 | /* Logs that 'execute' was executed on 'dpif' and completed with errno 'error' |
1558 | * (0 for success). 'subexecute' should be true if the execution is a result | |
1559 | * of breaking down a larger execution that needed help, false otherwise. | |
1560 | * | |
1561 | * | |
1562 | * XXX In theory, the log message could be deceptive because this function is | |
1563 | * called after the dpif_provider's '->execute' function, which is allowed to | |
1564 | * modify execute->packet and execute->md. In practice, though: | |
1565 | * | |
1566 | * - dpif-linux doesn't modify execute->packet or execute->md. | |
1567 | * | |
1568 | * - dpif-netdev does modify them but it is less likely to have problems | |
1569 | * because it is built into ovs-vswitchd and cannot have version skew, | |
1570 | * etc. | |
1571 | * | |
1572 | * It would still be better to avoid the potential problem. I don't know of a | |
1573 | * good way to do that, though, that isn't expensive. */ | |
89625d1e BP |
1574 | static void |
1575 | log_execute_message(struct dpif *dpif, const struct dpif_execute *execute, | |
fc65bafc | 1576 | bool subexecute, int error) |
89625d1e BP |
1577 | { |
1578 | if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) { | |
1579 | struct ds ds = DS_EMPTY_INITIALIZER; | |
1580 | char *packet; | |
1581 | ||
1f317cb5 PS |
1582 | packet = ofp_packet_to_string(ofpbuf_data(execute->packet), |
1583 | ofpbuf_size(execute->packet)); | |
fc65bafc BP |
1584 | ds_put_format(&ds, "%s: %sexecute ", |
1585 | dpif_name(dpif), | |
1586 | (subexecute ? "sub-" | |
1587 | : dpif_execute_needs_help(execute) ? "super-" | |
1588 | : "")); | |
89625d1e BP |
1589 | format_odp_actions(&ds, execute->actions, execute->actions_len); |
1590 | if (error) { | |
10a89ef0 | 1591 | ds_put_format(&ds, " failed (%s)", ovs_strerror(error)); |
89625d1e BP |
1592 | } |
1593 | ds_put_format(&ds, " on packet %s", packet); | |
1594 | vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds)); | |
1595 | ds_destroy(&ds); | |
1596 | free(packet); | |
1597 | } | |
1598 | } |