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