]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
4c738a8d | 2 | * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks. |
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 BP |
19 | |
20 | #include <assert.h> | |
21 | #include <ctype.h> | |
22 | #include <errno.h> | |
064af421 | 23 | #include <inttypes.h> |
064af421 BP |
24 | #include <stdlib.h> |
25 | #include <string.h> | |
064af421 BP |
26 | |
27 | #include "coverage.h" | |
28 | #include "dynamic-string.h" | |
29 | #include "flow.h" | |
c3827f61 | 30 | #include "netdev.h" |
064af421 BP |
31 | #include "netlink.h" |
32 | #include "odp-util.h" | |
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[] = { |
c83cdd30 | 60 | #ifdef HAVE_NETLINK |
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); | |
c228a364 | 71 | |
064af421 BP |
72 | /* Rate limit for individual messages going to or from the datapath, output at |
73 | * DBG level. This is very high because, if these are enabled, it is because | |
74 | * we really need to see them. */ | |
75 | static struct vlog_rate_limit dpmsg_rl = VLOG_RATE_LIMIT_INIT(600, 600); | |
76 | ||
77 | /* Not really much point in logging many dpif errors. */ | |
e2781405 | 78 | static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(60, 5); |
064af421 | 79 | |
feebdea2 BP |
80 | static void log_flow_message(const struct dpif *dpif, int error, |
81 | const char *operation, | |
82 | const struct nlattr *key, size_t key_len, | |
c97fb132 | 83 | const struct dpif_flow_stats *stats, |
feebdea2 | 84 | const struct nlattr *actions, size_t actions_len); |
96fba48f BP |
85 | static void log_operation(const struct dpif *, const char *operation, |
86 | int error); | |
96fba48f | 87 | static bool should_log_flow_message(int error); |
064af421 | 88 | |
999401aa JG |
89 | static void |
90 | dp_initialize(void) | |
91 | { | |
92 | static int status = -1; | |
93 | ||
94 | if (status < 0) { | |
95 | int i; | |
96 | ||
97 | status = 0; | |
98 | for (i = 0; i < ARRAY_SIZE(base_dpif_classes); i++) { | |
99 | dp_register_provider(base_dpif_classes[i]); | |
100 | } | |
101 | } | |
102 | } | |
103 | ||
5792c5c6 BP |
104 | /* Performs periodic work needed by all the various kinds of dpifs. |
105 | * | |
8b61709d BP |
106 | * If your program opens any dpifs, it must call both this function and |
107 | * netdev_run() within its main poll loop. */ | |
5792c5c6 BP |
108 | void |
109 | dp_run(void) | |
110 | { | |
999401aa JG |
111 | struct shash_node *node; |
112 | SHASH_FOR_EACH(node, &dpif_classes) { | |
113 | const struct registered_dpif_class *registered_class = node->data; | |
d2d8fbeb BP |
114 | if (registered_class->dpif_class->run) { |
115 | registered_class->dpif_class->run(); | |
5792c5c6 BP |
116 | } |
117 | } | |
118 | } | |
119 | ||
120 | /* Arranges for poll_block() to wake up when dp_run() needs to be called. | |
121 | * | |
8b61709d BP |
122 | * If your program opens any dpifs, it must call both this function and |
123 | * netdev_wait() within its main poll loop. */ | |
5792c5c6 BP |
124 | void |
125 | dp_wait(void) | |
126 | { | |
999401aa JG |
127 | struct shash_node *node; |
128 | SHASH_FOR_EACH(node, &dpif_classes) { | |
129 | const struct registered_dpif_class *registered_class = node->data; | |
d2d8fbeb BP |
130 | if (registered_class->dpif_class->wait) { |
131 | registered_class->dpif_class->wait(); | |
5792c5c6 BP |
132 | } |
133 | } | |
134 | } | |
135 | ||
999401aa JG |
136 | /* Registers a new datapath provider. After successful registration, new |
137 | * datapaths of that type can be opened using dpif_open(). */ | |
138 | int | |
139 | dp_register_provider(const struct dpif_class *new_class) | |
140 | { | |
141 | struct registered_dpif_class *registered_class; | |
142 | ||
143 | if (shash_find(&dpif_classes, new_class->type)) { | |
144 | VLOG_WARN("attempted to register duplicate datapath provider: %s", | |
145 | new_class->type); | |
146 | return EEXIST; | |
147 | } | |
1a6f1e2a | 148 | |
999401aa | 149 | registered_class = xmalloc(sizeof *registered_class); |
d2d8fbeb | 150 | registered_class->dpif_class = new_class; |
999401aa JG |
151 | registered_class->refcount = 0; |
152 | ||
153 | shash_add(&dpif_classes, new_class->type, registered_class); | |
154 | ||
155 | return 0; | |
156 | } | |
157 | ||
158 | /* Unregisters a datapath provider. 'type' must have been previously | |
159 | * registered and not currently be in use by any dpifs. After unregistration | |
160 | * new datapaths of that type cannot be opened using dpif_open(). */ | |
161 | int | |
162 | dp_unregister_provider(const char *type) | |
163 | { | |
164 | struct shash_node *node; | |
165 | struct registered_dpif_class *registered_class; | |
166 | ||
167 | node = shash_find(&dpif_classes, type); | |
168 | if (!node) { | |
169 | VLOG_WARN("attempted to unregister a datapath provider that is not " | |
170 | "registered: %s", type); | |
171 | return EAFNOSUPPORT; | |
172 | } | |
173 | ||
174 | registered_class = node->data; | |
175 | if (registered_class->refcount) { | |
176 | VLOG_WARN("attempted to unregister in use datapath provider: %s", type); | |
177 | return EBUSY; | |
178 | } | |
179 | ||
180 | shash_delete(&dpif_classes, node); | |
181 | free(registered_class); | |
182 | ||
183 | return 0; | |
184 | } | |
185 | ||
186 | /* Clears 'types' and enumerates the types of all currently registered datapath | |
d0c23a1a | 187 | * providers into it. The caller must first initialize the sset. */ |
1a6f1e2a | 188 | void |
d0c23a1a | 189 | dp_enumerate_types(struct sset *types) |
1a6f1e2a | 190 | { |
999401aa | 191 | struct shash_node *node; |
1a6f1e2a | 192 | |
999401aa | 193 | dp_initialize(); |
d0c23a1a | 194 | sset_clear(types); |
1a6f1e2a | 195 | |
999401aa JG |
196 | SHASH_FOR_EACH(node, &dpif_classes) { |
197 | const struct registered_dpif_class *registered_class = node->data; | |
d0c23a1a | 198 | sset_add(types, registered_class->dpif_class->type); |
1a6f1e2a JG |
199 | } |
200 | } | |
201 | ||
202 | /* Clears 'names' and enumerates the names of all known created datapaths with | |
d0c23a1a | 203 | * the given 'type'. The caller must first initialize the sset. Returns 0 if |
1a6f1e2a | 204 | * successful, otherwise a positive errno value. |
d3d22744 BP |
205 | * |
206 | * Some kinds of datapaths might not be practically enumerable. This is not | |
207 | * considered an error. */ | |
208 | int | |
d0c23a1a | 209 | dp_enumerate_names(const char *type, struct sset *names) |
d3d22744 | 210 | { |
999401aa JG |
211 | const struct registered_dpif_class *registered_class; |
212 | const struct dpif_class *dpif_class; | |
213 | int error; | |
d3d22744 | 214 | |
999401aa | 215 | dp_initialize(); |
d0c23a1a | 216 | sset_clear(names); |
1a6f1e2a | 217 | |
999401aa JG |
218 | registered_class = shash_find_data(&dpif_classes, type); |
219 | if (!registered_class) { | |
220 | VLOG_WARN("could not enumerate unknown type: %s", type); | |
221 | return EAFNOSUPPORT; | |
222 | } | |
1a6f1e2a | 223 | |
d2d8fbeb | 224 | dpif_class = registered_class->dpif_class; |
999401aa | 225 | error = dpif_class->enumerate ? dpif_class->enumerate(names) : 0; |
1a6f1e2a | 226 | |
999401aa JG |
227 | if (error) { |
228 | VLOG_WARN("failed to enumerate %s datapaths: %s", dpif_class->type, | |
229 | strerror(error)); | |
d3d22744 | 230 | } |
1a6f1e2a | 231 | |
999401aa | 232 | return error; |
1a6f1e2a JG |
233 | } |
234 | ||
235 | /* Parses 'datapath name', which is of the form type@name into its | |
236 | * component pieces. 'name' and 'type' must be freed by the caller. */ | |
237 | void | |
238 | dp_parse_name(const char *datapath_name_, char **name, char **type) | |
239 | { | |
240 | char *datapath_name = xstrdup(datapath_name_); | |
241 | char *separator; | |
242 | ||
243 | separator = strchr(datapath_name, '@'); | |
244 | if (separator) { | |
245 | *separator = '\0'; | |
246 | *type = datapath_name; | |
247 | *name = xstrdup(separator + 1); | |
248 | } else { | |
249 | *name = datapath_name; | |
250 | *type = NULL; | |
251 | } | |
d3d22744 BP |
252 | } |
253 | ||
96fba48f | 254 | static int |
1a6f1e2a | 255 | do_open(const char *name, const char *type, bool create, struct dpif **dpifp) |
064af421 | 256 | { |
96fba48f | 257 | struct dpif *dpif = NULL; |
064af421 | 258 | int error; |
999401aa JG |
259 | struct registered_dpif_class *registered_class; |
260 | ||
261 | dp_initialize(); | |
064af421 | 262 | |
3a225db7 | 263 | type = dpif_normalize_type(type); |
064af421 | 264 | |
999401aa JG |
265 | registered_class = shash_find_data(&dpif_classes, type); |
266 | if (!registered_class) { | |
267 | VLOG_WARN("could not create datapath %s of unknown type %s", name, | |
268 | type); | |
269 | error = EAFNOSUPPORT; | |
270 | goto exit; | |
271 | } | |
272 | ||
4a387741 BP |
273 | error = registered_class->dpif_class->open(registered_class->dpif_class, |
274 | name, create, &dpif); | |
999401aa | 275 | if (!error) { |
4a387741 | 276 | assert(dpif->dpif_class == registered_class->dpif_class); |
999401aa | 277 | registered_class->refcount++; |
064af421 | 278 | } |
064af421 | 279 | |
96fba48f BP |
280 | exit: |
281 | *dpifp = error ? NULL : dpif; | |
282 | return error; | |
064af421 BP |
283 | } |
284 | ||
1a6f1e2a JG |
285 | /* Tries to open an existing datapath named 'name' and type 'type'. Will fail |
286 | * if no datapath with 'name' and 'type' exists. 'type' may be either NULL or | |
287 | * the empty string to specify the default system type. Returns 0 if | |
288 | * successful, otherwise a positive errno value. On success stores a pointer | |
289 | * to the datapath in '*dpifp', otherwise a null pointer. */ | |
96fba48f | 290 | int |
1a6f1e2a | 291 | dpif_open(const char *name, const char *type, struct dpif **dpifp) |
064af421 | 292 | { |
1a6f1e2a | 293 | return do_open(name, type, false, dpifp); |
064af421 BP |
294 | } |
295 | ||
1a6f1e2a JG |
296 | /* Tries to create and open a new datapath with the given 'name' and 'type'. |
297 | * 'type' may be either NULL or the empty string to specify the default system | |
298 | * type. Will fail if a datapath with 'name' and 'type' already exists. | |
299 | * Returns 0 if successful, otherwise a positive errno value. On success | |
300 | * stores a pointer to the datapath in '*dpifp', otherwise a null pointer. */ | |
064af421 | 301 | int |
1a6f1e2a | 302 | dpif_create(const char *name, const char *type, struct dpif **dpifp) |
064af421 | 303 | { |
1a6f1e2a | 304 | return do_open(name, type, true, dpifp); |
96fba48f | 305 | } |
064af421 | 306 | |
1a6f1e2a JG |
307 | /* Tries to open a datapath with the given 'name' and 'type', creating it if it |
308 | * does not exist. 'type' may be either NULL or the empty string to specify | |
309 | * the default system type. Returns 0 if successful, otherwise a positive | |
310 | * errno value. On success stores a pointer to the datapath in '*dpifp', | |
311 | * otherwise a null pointer. */ | |
efacbce6 | 312 | int |
1a6f1e2a | 313 | dpif_create_and_open(const char *name, const char *type, struct dpif **dpifp) |
efacbce6 BP |
314 | { |
315 | int error; | |
316 | ||
1a6f1e2a | 317 | error = dpif_create(name, type, dpifp); |
efacbce6 | 318 | if (error == EEXIST || error == EBUSY) { |
1a6f1e2a | 319 | error = dpif_open(name, type, dpifp); |
efacbce6 BP |
320 | if (error) { |
321 | VLOG_WARN("datapath %s already exists but cannot be opened: %s", | |
322 | name, strerror(error)); | |
323 | } | |
324 | } else if (error) { | |
325 | VLOG_WARN("failed to create datapath %s: %s", name, strerror(error)); | |
326 | } | |
327 | return error; | |
328 | } | |
329 | ||
96fba48f BP |
330 | /* Closes and frees the connection to 'dpif'. Does not destroy the datapath |
331 | * itself; call dpif_delete() first, instead, if that is desirable. */ | |
332 | void | |
333 | dpif_close(struct dpif *dpif) | |
334 | { | |
335 | if (dpif) { | |
999401aa JG |
336 | struct registered_dpif_class *registered_class; |
337 | ||
d295e8e9 | 338 | registered_class = shash_find_data(&dpif_classes, |
a4af0040 | 339 | dpif->dpif_class->type); |
999401aa JG |
340 | assert(registered_class); |
341 | assert(registered_class->refcount); | |
342 | ||
343 | registered_class->refcount--; | |
344 | dpif_uninit(dpif, true); | |
064af421 BP |
345 | } |
346 | } | |
347 | ||
1a6f1e2a JG |
348 | /* Returns the name of datapath 'dpif' prefixed with the type |
349 | * (for use in log messages). */ | |
b29ba128 BP |
350 | const char * |
351 | dpif_name(const struct dpif *dpif) | |
352 | { | |
1a6f1e2a JG |
353 | return dpif->full_name; |
354 | } | |
355 | ||
356 | /* Returns the name of datapath 'dpif' without the type | |
357 | * (for use in device names). */ | |
358 | const char * | |
359 | dpif_base_name(const struct dpif *dpif) | |
360 | { | |
361 | return dpif->base_name; | |
b29ba128 BP |
362 | } |
363 | ||
3a225db7 BP |
364 | /* Returns the fully spelled out name for the given datapath 'type'. |
365 | * | |
366 | * Normalized type string can be compared with strcmp(). Unnormalized type | |
367 | * string might be the same even if they have different spellings. */ | |
368 | const char * | |
369 | dpif_normalize_type(const char *type) | |
370 | { | |
371 | return type && type[0] ? type : "system"; | |
372 | } | |
373 | ||
96fba48f BP |
374 | /* Destroys the datapath that 'dpif' is connected to, first removing all of its |
375 | * ports. After calling this function, it does not make sense to pass 'dpif' | |
376 | * to any functions other than dpif_name() or dpif_close(). */ | |
064af421 BP |
377 | int |
378 | dpif_delete(struct dpif *dpif) | |
379 | { | |
96fba48f BP |
380 | int error; |
381 | ||
064af421 | 382 | COVERAGE_INC(dpif_destroy); |
96fba48f | 383 | |
1acb6baa | 384 | error = dpif->dpif_class->destroy(dpif); |
96fba48f BP |
385 | log_operation(dpif, "delete", error); |
386 | return error; | |
064af421 BP |
387 | } |
388 | ||
96fba48f BP |
389 | /* Retrieves statistics for 'dpif' into 'stats'. Returns 0 if successful, |
390 | * otherwise a positive errno value. */ | |
064af421 BP |
391 | int |
392 | dpif_get_dp_stats(const struct dpif *dpif, struct odp_stats *stats) | |
393 | { | |
1acb6baa | 394 | int error = dpif->dpif_class->get_stats(dpif, stats); |
96fba48f BP |
395 | if (error) { |
396 | memset(stats, 0, sizeof *stats); | |
397 | } | |
398 | log_operation(dpif, "get_stats", error); | |
399 | return error; | |
064af421 BP |
400 | } |
401 | ||
96fba48f BP |
402 | /* Retrieves the current IP fragment handling policy for 'dpif' into |
403 | * '*drop_frags': true indicates that fragments are dropped, false indicates | |
404 | * that fragments are treated in the same way as other IP packets (except that | |
405 | * the L4 header cannot be read). Returns 0 if successful, otherwise a | |
406 | * positive errno value. */ | |
064af421 BP |
407 | int |
408 | dpif_get_drop_frags(const struct dpif *dpif, bool *drop_frags) | |
409 | { | |
1acb6baa | 410 | int error = dpif->dpif_class->get_drop_frags(dpif, drop_frags); |
96fba48f BP |
411 | if (error) { |
412 | *drop_frags = false; | |
413 | } | |
414 | log_operation(dpif, "get_drop_frags", error); | |
064af421 BP |
415 | return error; |
416 | } | |
417 | ||
96fba48f BP |
418 | /* Changes 'dpif''s treatment of IP fragments to 'drop_frags', whose meaning is |
419 | * the same as for the get_drop_frags member function. Returns 0 if | |
420 | * successful, otherwise a positive errno value. */ | |
064af421 BP |
421 | int |
422 | dpif_set_drop_frags(struct dpif *dpif, bool drop_frags) | |
423 | { | |
1acb6baa | 424 | int error = dpif->dpif_class->set_drop_frags(dpif, drop_frags); |
96fba48f BP |
425 | log_operation(dpif, "set_drop_frags", error); |
426 | return error; | |
064af421 BP |
427 | } |
428 | ||
c3827f61 BP |
429 | /* Attempts to add 'netdev' as a port on 'dpif'. If successful, returns 0 and |
430 | * sets '*port_nop' to the new port's port number (if 'port_nop' is non-null). | |
431 | * On failure, returns a positive errno value and sets '*port_nop' to | |
432 | * UINT16_MAX (if 'port_nop' is non-null). */ | |
064af421 | 433 | int |
c3827f61 | 434 | dpif_port_add(struct dpif *dpif, struct netdev *netdev, uint16_t *port_nop) |
064af421 | 435 | { |
c3827f61 | 436 | const char *netdev_name = netdev_get_name(netdev); |
9ee3ae3e BP |
437 | uint16_t port_no; |
438 | int error; | |
064af421 BP |
439 | |
440 | COVERAGE_INC(dpif_port_add); | |
9ee3ae3e | 441 | |
c3827f61 | 442 | error = dpif->dpif_class->port_add(dpif, netdev, &port_no); |
9ee3ae3e | 443 | if (!error) { |
b29ba128 | 444 | VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu16, |
c3827f61 | 445 | dpif_name(dpif), netdev_name, port_no); |
064af421 | 446 | } else { |
9ee3ae3e | 447 | VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s", |
c3827f61 | 448 | dpif_name(dpif), netdev_name, strerror(error)); |
96fba48f | 449 | port_no = UINT16_MAX; |
9ee3ae3e BP |
450 | } |
451 | if (port_nop) { | |
452 | *port_nop = port_no; | |
064af421 | 453 | } |
9ee3ae3e | 454 | return error; |
064af421 BP |
455 | } |
456 | ||
96fba48f BP |
457 | /* Attempts to remove 'dpif''s port number 'port_no'. Returns 0 if successful, |
458 | * otherwise a positive errno value. */ | |
064af421 BP |
459 | int |
460 | dpif_port_del(struct dpif *dpif, uint16_t port_no) | |
461 | { | |
96fba48f BP |
462 | int error; |
463 | ||
064af421 | 464 | COVERAGE_INC(dpif_port_del); |
96fba48f | 465 | |
1acb6baa | 466 | error = dpif->dpif_class->port_del(dpif, port_no); |
a1811296 BP |
467 | if (!error) { |
468 | VLOG_DBG_RL(&dpmsg_rl, "%s: port_del(%"PRIu16")", | |
469 | dpif_name(dpif), port_no); | |
470 | } else { | |
471 | log_operation(dpif, "port_del", error); | |
472 | } | |
96fba48f | 473 | return error; |
064af421 BP |
474 | } |
475 | ||
4c738a8d BP |
476 | /* Makes a deep copy of 'src' into 'dst'. */ |
477 | void | |
478 | dpif_port_clone(struct dpif_port *dst, const struct dpif_port *src) | |
479 | { | |
480 | dst->name = xstrdup(src->name); | |
481 | dst->type = xstrdup(src->type); | |
482 | dst->port_no = src->port_no; | |
483 | } | |
484 | ||
485 | /* Frees memory allocated to members of 'dpif_port'. | |
486 | * | |
487 | * Do not call this function on a dpif_port obtained from | |
488 | * dpif_port_dump_next(): that function retains ownership of the data in the | |
489 | * dpif_port. */ | |
490 | void | |
491 | dpif_port_destroy(struct dpif_port *dpif_port) | |
492 | { | |
493 | free(dpif_port->name); | |
494 | free(dpif_port->type); | |
495 | } | |
496 | ||
96fba48f BP |
497 | /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and |
498 | * initializes '*port' appropriately; on failure, returns a positive errno | |
4c738a8d BP |
499 | * value. |
500 | * | |
501 | * The caller owns the data in 'port' and must free it with | |
502 | * dpif_port_destroy() when it is no longer needed. */ | |
064af421 BP |
503 | int |
504 | dpif_port_query_by_number(const struct dpif *dpif, uint16_t port_no, | |
4c738a8d | 505 | struct dpif_port *port) |
064af421 | 506 | { |
1acb6baa | 507 | int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port); |
96fba48f | 508 | if (!error) { |
b29ba128 | 509 | VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu16" is device %s", |
4c738a8d | 510 | dpif_name(dpif), port_no, port->name); |
064af421 | 511 | } else { |
96fba48f | 512 | memset(port, 0, sizeof *port); |
b29ba128 | 513 | VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu16": %s", |
96fba48f | 514 | dpif_name(dpif), port_no, strerror(error)); |
064af421 | 515 | } |
96fba48f | 516 | return error; |
064af421 BP |
517 | } |
518 | ||
96fba48f BP |
519 | /* Looks up port named 'devname' in 'dpif'. On success, returns 0 and |
520 | * initializes '*port' appropriately; on failure, returns a positive errno | |
4c738a8d BP |
521 | * value. |
522 | * | |
523 | * The caller owns the data in 'port' and must free it with | |
524 | * dpif_port_destroy() when it is no longer needed. */ | |
064af421 BP |
525 | int |
526 | dpif_port_query_by_name(const struct dpif *dpif, const char *devname, | |
4c738a8d | 527 | struct dpif_port *port) |
064af421 | 528 | { |
1acb6baa | 529 | int error = dpif->dpif_class->port_query_by_name(dpif, devname, port); |
96fba48f | 530 | if (!error) { |
b29ba128 | 531 | VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu16, |
4c738a8d | 532 | dpif_name(dpif), devname, port->port_no); |
064af421 | 533 | } else { |
96fba48f BP |
534 | memset(port, 0, sizeof *port); |
535 | ||
d647f0a7 BP |
536 | /* For ENOENT or ENODEV we use DBG level because the caller is probably |
537 | * interested in whether 'dpif' actually has a port 'devname', so that | |
538 | * it's not an issue worth logging if it doesn't. Other errors are | |
539 | * uncommon and more likely to indicate a real problem. */ | |
540 | VLOG_RL(&error_rl, | |
541 | error == ENOENT || error == ENODEV ? VLL_DBG : VLL_WARN, | |
542 | "%s: failed to query port %s: %s", | |
543 | dpif_name(dpif), devname, strerror(error)); | |
064af421 | 544 | } |
96fba48f | 545 | return error; |
064af421 BP |
546 | } |
547 | ||
996c1b3d BP |
548 | /* Returns one greater than the maximum port number accepted in flow |
549 | * actions. */ | |
550 | int | |
551 | dpif_get_max_ports(const struct dpif *dpif) | |
552 | { | |
553 | return dpif->dpif_class->get_max_ports(dpif); | |
554 | } | |
555 | ||
96fba48f BP |
556 | /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and copies |
557 | * the port's name into the 'name_size' bytes in 'name', ensuring that the | |
558 | * result is null-terminated. On failure, returns a positive errno value and | |
559 | * makes 'name' the empty string. */ | |
335562c0 BP |
560 | int |
561 | dpif_port_get_name(struct dpif *dpif, uint16_t port_no, | |
562 | char *name, size_t name_size) | |
563 | { | |
4c738a8d | 564 | struct dpif_port port; |
335562c0 BP |
565 | int error; |
566 | ||
567 | assert(name_size > 0); | |
568 | ||
569 | error = dpif_port_query_by_number(dpif, port_no, &port); | |
570 | if (!error) { | |
4c738a8d BP |
571 | ovs_strlcpy(name, port.name, name_size); |
572 | dpif_port_destroy(&port); | |
335562c0 BP |
573 | } else { |
574 | *name = '\0'; | |
575 | } | |
576 | return error; | |
577 | } | |
578 | ||
b0ec0f27 | 579 | /* Initializes 'dump' to begin dumping the ports in a dpif. |
96fba48f | 580 | * |
b0ec0f27 BP |
581 | * This function provides no status indication. An error status for the entire |
582 | * dump operation is provided when it is completed by calling | |
583 | * dpif_port_dump_done(). | |
584 | */ | |
585 | void | |
586 | dpif_port_dump_start(struct dpif_port_dump *dump, const struct dpif *dpif) | |
587 | { | |
588 | dump->dpif = dpif; | |
589 | dump->error = dpif->dpif_class->port_dump_start(dpif, &dump->state); | |
590 | log_operation(dpif, "port_dump_start", dump->error); | |
591 | } | |
592 | ||
593 | /* Attempts to retrieve another port from 'dump', which must have been | |
4c738a8d | 594 | * initialized with dpif_port_dump_start(). On success, stores a new dpif_port |
b0ec0f27 | 595 | * into 'port' and returns true. On failure, returns false. |
96fba48f | 596 | * |
b0ec0f27 BP |
597 | * Failure might indicate an actual error or merely that the last port has been |
598 | * dumped. An error status for the entire dump operation is provided when it | |
4c738a8d BP |
599 | * is completed by calling dpif_port_dump_done(). |
600 | * | |
601 | * The dpif owns the data stored in 'port'. It will remain valid until at | |
602 | * least the next time 'dump' is passed to dpif_port_dump_next() or | |
603 | * dpif_port_dump_done(). */ | |
b0ec0f27 | 604 | bool |
4c738a8d | 605 | dpif_port_dump_next(struct dpif_port_dump *dump, struct dpif_port *port) |
064af421 | 606 | { |
b0ec0f27 | 607 | const struct dpif *dpif = dump->dpif; |
064af421 | 608 | |
b0ec0f27 BP |
609 | if (dump->error) { |
610 | return false; | |
611 | } | |
f4ba4c4f | 612 | |
b0ec0f27 BP |
613 | dump->error = dpif->dpif_class->port_dump_next(dpif, dump->state, port); |
614 | if (dump->error == EOF) { | |
615 | VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all ports", dpif_name(dpif)); | |
616 | } else { | |
617 | log_operation(dpif, "port_dump_next", dump->error); | |
618 | } | |
064af421 | 619 | |
b0ec0f27 BP |
620 | if (dump->error) { |
621 | dpif->dpif_class->port_dump_done(dpif, dump->state); | |
622 | return false; | |
f4ba4c4f | 623 | } |
b0ec0f27 BP |
624 | return true; |
625 | } | |
064af421 | 626 | |
b0ec0f27 BP |
627 | /* Completes port table dump operation 'dump', which must have been initialized |
628 | * with dpif_port_dump_start(). Returns 0 if the dump operation was | |
629 | * error-free, otherwise a positive errno value describing the problem. */ | |
630 | int | |
631 | dpif_port_dump_done(struct dpif_port_dump *dump) | |
632 | { | |
633 | const struct dpif *dpif = dump->dpif; | |
634 | if (!dump->error) { | |
635 | dump->error = dpif->dpif_class->port_dump_done(dpif, dump->state); | |
636 | log_operation(dpif, "port_dump_done", dump->error); | |
f4ba4c4f | 637 | } |
b0ec0f27 | 638 | return dump->error == EOF ? 0 : dump->error; |
064af421 BP |
639 | } |
640 | ||
e9e28be3 BP |
641 | /* Polls for changes in the set of ports in 'dpif'. If the set of ports in |
642 | * 'dpif' has changed, this function does one of the following: | |
643 | * | |
644 | * - Stores the name of the device that was added to or deleted from 'dpif' in | |
645 | * '*devnamep' and returns 0. The caller is responsible for freeing | |
646 | * '*devnamep' (with free()) when it no longer needs it. | |
647 | * | |
648 | * - Returns ENOBUFS and sets '*devnamep' to NULL. | |
649 | * | |
650 | * This function may also return 'false positives', where it returns 0 and | |
651 | * '*devnamep' names a device that was not actually added or deleted or it | |
652 | * returns ENOBUFS without any change. | |
653 | * | |
654 | * Returns EAGAIN if the set of ports in 'dpif' has not changed. May also | |
655 | * return other positive errno values to indicate that something has gone | |
656 | * wrong. */ | |
657 | int | |
658 | dpif_port_poll(const struct dpif *dpif, char **devnamep) | |
659 | { | |
1acb6baa | 660 | int error = dpif->dpif_class->port_poll(dpif, devnamep); |
e9e28be3 BP |
661 | if (error) { |
662 | *devnamep = NULL; | |
663 | } | |
664 | return error; | |
665 | } | |
666 | ||
667 | /* Arranges for the poll loop to wake up when port_poll(dpif) will return a | |
668 | * value other than EAGAIN. */ | |
669 | void | |
670 | dpif_port_poll_wait(const struct dpif *dpif) | |
671 | { | |
1acb6baa | 672 | dpif->dpif_class->port_poll_wait(dpif); |
e9e28be3 BP |
673 | } |
674 | ||
c97fb132 BP |
675 | /* Appends a human-readable representation of 'stats' to 's'. */ |
676 | void | |
677 | dpif_flow_stats_format(const struct dpif_flow_stats *stats, struct ds *s) | |
678 | { | |
679 | ds_put_format(s, "packets:%"PRIu64", bytes:%"PRIu64", used:", | |
680 | stats->n_packets, stats->n_bytes); | |
681 | if (stats->used) { | |
682 | ds_put_format(s, "%.3fs", (time_msec() - stats->used) / 1000.0); | |
683 | } else { | |
684 | ds_put_format(s, "never"); | |
685 | } | |
686 | /* XXX tcp_flags? */ | |
687 | } | |
688 | ||
96fba48f BP |
689 | /* Deletes all flows from 'dpif'. Returns 0 if successful, otherwise a |
690 | * positive errno value. */ | |
691 | int | |
692 | dpif_flow_flush(struct dpif *dpif) | |
064af421 | 693 | { |
96fba48f BP |
694 | int error; |
695 | ||
696 | COVERAGE_INC(dpif_flow_flush); | |
697 | ||
1acb6baa | 698 | error = dpif->dpif_class->flow_flush(dpif); |
96fba48f BP |
699 | log_operation(dpif, "flow_flush", error); |
700 | return error; | |
064af421 BP |
701 | } |
702 | ||
feebdea2 BP |
703 | /* Queries 'dpif' for a flow entry. The flow is specified by the Netlink |
704 | * attributes with types ODP_KEY_ATTR_* in the 'key_len' bytes starting at | |
705 | * 'key'. | |
96fba48f | 706 | * |
feebdea2 BP |
707 | * Returns 0 if successful. If no flow matches, returns ENOENT. On other |
708 | * failure, returns a positive errno value. | |
96fba48f | 709 | * |
feebdea2 BP |
710 | * If 'actionsp' is nonnull, then on success '*actionsp' will be set to an |
711 | * ofpbuf owned by the caller that contains the Netlink attributes for the | |
712 | * flow's actions. The caller must free the ofpbuf (with ofpbuf_delete()) when | |
713 | * it is no longer needed. | |
714 | * | |
715 | * If 'stats' is nonnull, then on success it will be updated with the flow's | |
716 | * statistics. */ | |
96fba48f | 717 | int |
693c4a01 | 718 | dpif_flow_get(const struct dpif *dpif, |
feebdea2 | 719 | const struct nlattr *key, size_t key_len, |
c97fb132 | 720 | struct ofpbuf **actionsp, struct dpif_flow_stats *stats) |
064af421 | 721 | { |
96fba48f BP |
722 | int error; |
723 | ||
724 | COVERAGE_INC(dpif_flow_get); | |
725 | ||
693c4a01 | 726 | error = dpif->dpif_class->flow_get(dpif, key, key_len, actionsp, stats); |
b843fa1b | 727 | if (error) { |
feebdea2 BP |
728 | if (actionsp) { |
729 | *actionsp = NULL; | |
730 | } | |
731 | if (stats) { | |
732 | memset(stats, 0, sizeof *stats); | |
733 | } | |
b843fa1b | 734 | } |
96fba48f | 735 | if (should_log_flow_message(error)) { |
feebdea2 BP |
736 | const struct nlattr *actions; |
737 | size_t actions_len; | |
738 | ||
739 | if (!error && actionsp) { | |
740 | actions = (*actionsp)->data; | |
741 | actions_len = (*actionsp)->size; | |
742 | } else { | |
743 | actions = NULL; | |
744 | actions_len = 0; | |
745 | } | |
746 | log_flow_message(dpif, error, "flow_get", key, key_len, stats, | |
747 | actions, actions_len); | |
064af421 | 748 | } |
96fba48f | 749 | return error; |
064af421 BP |
750 | } |
751 | ||
feebdea2 BP |
752 | /* Adds or modifies a flow in 'dpif'. The flow is specified by the Netlink |
753 | * attributes with types ODP_KEY_ATTR_* in the 'key_len' bytes starting at | |
754 | * 'key'. The associated actions are specified by the Netlink attributes with | |
7aec165d | 755 | * types ODP_ACTION_ATTR_* in the 'actions_len' bytes starting at 'actions'. |
96fba48f | 756 | * |
feebdea2 | 757 | * - If the flow's key does not exist in 'dpif', then the flow will be added if |
ba25b8f4 | 758 | * 'flags' includes DPIF_FP_CREATE. Otherwise the operation will fail with |
96fba48f BP |
759 | * ENOENT. |
760 | * | |
feebdea2 | 761 | * If the operation succeeds, then 'stats', if nonnull, will be zeroed. |
96fba48f | 762 | * |
feebdea2 | 763 | * - If the flow's key does exist in 'dpif', then the flow's actions will be |
ba25b8f4 | 764 | * updated if 'flags' includes DPIF_FP_MODIFY. Otherwise the operation will |
feebdea2 | 765 | * fail with EEXIST. If the flow's actions are updated, then its statistics |
ba25b8f4 | 766 | * will be zeroed if 'flags' includes DPIF_FP_ZERO_STATS, and left as-is |
feebdea2 BP |
767 | * otherwise. |
768 | * | |
769 | * If the operation succeeds, then 'stats', if nonnull, will be set to the | |
770 | * flow's statistics before the update. | |
96fba48f | 771 | */ |
064af421 | 772 | int |
ba25b8f4 | 773 | dpif_flow_put(struct dpif *dpif, enum dpif_flow_put_flags flags, |
feebdea2 BP |
774 | const struct nlattr *key, size_t key_len, |
775 | const struct nlattr *actions, size_t actions_len, | |
c97fb132 | 776 | struct dpif_flow_stats *stats) |
064af421 | 777 | { |
96fba48f BP |
778 | int error; |
779 | ||
064af421 | 780 | COVERAGE_INC(dpif_flow_put); |
ba25b8f4 | 781 | assert(!(flags & ~(DPIF_FP_CREATE | DPIF_FP_MODIFY | DPIF_FP_ZERO_STATS))); |
96fba48f | 782 | |
feebdea2 BP |
783 | error = dpif->dpif_class->flow_put(dpif, flags, key, key_len, |
784 | actions, actions_len, stats); | |
785 | if (error && stats) { | |
786 | memset(stats, 0, sizeof *stats); | |
787 | } | |
064af421 | 788 | if (should_log_flow_message(error)) { |
feebdea2 BP |
789 | struct ds s; |
790 | ||
791 | ds_init(&s); | |
792 | ds_put_cstr(&s, "put"); | |
ba25b8f4 | 793 | if (flags & DPIF_FP_CREATE) { |
feebdea2 BP |
794 | ds_put_cstr(&s, "[create]"); |
795 | } | |
ba25b8f4 | 796 | if (flags & DPIF_FP_MODIFY) { |
feebdea2 BP |
797 | ds_put_cstr(&s, "[modify]"); |
798 | } | |
ba25b8f4 | 799 | if (flags & DPIF_FP_ZERO_STATS) { |
feebdea2 BP |
800 | ds_put_cstr(&s, "[zero]"); |
801 | } | |
feebdea2 BP |
802 | log_flow_message(dpif, error, ds_cstr(&s), key, key_len, stats, |
803 | actions, actions_len); | |
804 | ds_destroy(&s); | |
064af421 BP |
805 | } |
806 | return error; | |
807 | } | |
808 | ||
feebdea2 BP |
809 | /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif' does |
810 | * not contain such a flow. The flow is specified by the Netlink attributes | |
811 | * with types ODP_KEY_ATTR_* in the 'key_len' bytes starting at 'key'. | |
96fba48f | 812 | * |
feebdea2 BP |
813 | * If the operation succeeds, then 'stats', if nonnull, will be set to the |
814 | * flow's statistics before its deletion. */ | |
064af421 | 815 | int |
feebdea2 BP |
816 | dpif_flow_del(struct dpif *dpif, |
817 | const struct nlattr *key, size_t key_len, | |
c97fb132 | 818 | struct dpif_flow_stats *stats) |
064af421 | 819 | { |
f1aa2072 BP |
820 | int error; |
821 | ||
96fba48f | 822 | COVERAGE_INC(dpif_flow_del); |
f1aa2072 | 823 | |
feebdea2 BP |
824 | error = dpif->dpif_class->flow_del(dpif, key, key_len, stats); |
825 | if (error && stats) { | |
826 | memset(stats, 0, sizeof *stats); | |
827 | } | |
96fba48f | 828 | if (should_log_flow_message(error)) { |
feebdea2 BP |
829 | log_flow_message(dpif, error, "flow_del", key, key_len, |
830 | !error ? stats : NULL, NULL, 0); | |
064af421 | 831 | } |
96fba48f | 832 | return error; |
064af421 BP |
833 | } |
834 | ||
704a1e09 BP |
835 | /* Initializes 'dump' to begin dumping the flows in a dpif. |
836 | * | |
837 | * This function provides no status indication. An error status for the entire | |
838 | * dump operation is provided when it is completed by calling | |
839 | * dpif_flow_dump_done(). | |
840 | */ | |
841 | void | |
842 | dpif_flow_dump_start(struct dpif_flow_dump *dump, const struct dpif *dpif) | |
064af421 | 843 | { |
704a1e09 BP |
844 | dump->dpif = dpif; |
845 | dump->error = dpif->dpif_class->flow_dump_start(dpif, &dump->state); | |
846 | log_operation(dpif, "flow_dump_start", dump->error); | |
064af421 BP |
847 | } |
848 | ||
704a1e09 | 849 | /* Attempts to retrieve another flow from 'dump', which must have been |
feebdea2 BP |
850 | * initialized with dpif_flow_dump_start(). On success, updates the output |
851 | * parameters as described below and returns true. Otherwise, returns false. | |
852 | * Failure might indicate an actual error or merely the end of the flow table. | |
853 | * An error status for the entire dump operation is provided when it is | |
854 | * completed by calling dpif_flow_dump_done(). | |
855 | * | |
856 | * On success, if 'key' and 'key_len' are nonnull then '*key' and '*key_len' | |
857 | * will be set to Netlink attributes with types ODP_KEY_ATTR_* representing the | |
858 | * dumped flow's key. If 'actions' and 'actions_len' are nonnull then they are | |
7aec165d BP |
859 | * set to Netlink attributes with types ODP_ACTION_ATTR_* representing the |
860 | * dumped flow's actions. If 'stats' is nonnull then it will be set to the | |
861 | * dumped flow's statistics. | |
96fba48f | 862 | * |
feebdea2 BP |
863 | * All of the returned data is owned by 'dpif', not by the caller, and the |
864 | * caller must not modify or free it. 'dpif' guarantees that it remains | |
865 | * accessible and unchanging until at least the next call to 'flow_dump_next' | |
866 | * or 'flow_dump_done' for 'dump'. */ | |
704a1e09 | 867 | bool |
feebdea2 BP |
868 | dpif_flow_dump_next(struct dpif_flow_dump *dump, |
869 | const struct nlattr **key, size_t *key_len, | |
870 | const struct nlattr **actions, size_t *actions_len, | |
c97fb132 | 871 | const struct dpif_flow_stats **stats) |
704a1e09 BP |
872 | { |
873 | const struct dpif *dpif = dump->dpif; | |
feebdea2 | 874 | int error = dump->error; |
064af421 | 875 | |
feebdea2 BP |
876 | if (!error) { |
877 | error = dpif->dpif_class->flow_dump_next(dpif, dump->state, | |
878 | key, key_len, | |
879 | actions, actions_len, | |
880 | stats); | |
881 | if (error) { | |
882 | dpif->dpif_class->flow_dump_done(dpif, dump->state); | |
883 | } | |
064af421 | 884 | } |
feebdea2 BP |
885 | if (error) { |
886 | if (key) { | |
887 | *key = NULL; | |
888 | *key_len = 0; | |
36956a7d | 889 | } |
feebdea2 BP |
890 | if (actions) { |
891 | *actions = NULL; | |
892 | *actions_len = 0; | |
893 | } | |
894 | if (stats) { | |
895 | *stats = NULL; | |
704a1e09 | 896 | } |
064af421 | 897 | } |
feebdea2 BP |
898 | if (!dump->error) { |
899 | if (error == EOF) { | |
900 | VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all flows", dpif_name(dpif)); | |
901 | } else if (should_log_flow_message(error)) { | |
902 | log_flow_message(dpif, error, "flow_dump", | |
903 | key ? *key : NULL, key ? *key_len : 0, | |
904 | stats ? *stats : NULL, actions ? *actions : NULL, | |
905 | actions ? *actions_len : 0); | |
906 | } | |
064af421 | 907 | } |
feebdea2 BP |
908 | dump->error = error; |
909 | return !error; | |
704a1e09 BP |
910 | } |
911 | ||
912 | /* Completes flow table dump operation 'dump', which must have been initialized | |
913 | * with dpif_flow_dump_start(). Returns 0 if the dump operation was | |
914 | * error-free, otherwise a positive errno value describing the problem. */ | |
915 | int | |
916 | dpif_flow_dump_done(struct dpif_flow_dump *dump) | |
917 | { | |
918 | const struct dpif *dpif = dump->dpif; | |
919 | if (!dump->error) { | |
920 | dump->error = dpif->dpif_class->flow_dump_done(dpif, dump->state); | |
921 | log_operation(dpif, "flow_dump_done", dump->error); | |
922 | } | |
923 | return dump->error == EOF ? 0 : dump->error; | |
064af421 BP |
924 | } |
925 | ||
cdee00fd BP |
926 | /* Causes 'dpif' to perform the 'actions_len' bytes of actions in 'actions' on |
927 | * the Ethernet frame specified in 'packet'. | |
96fba48f | 928 | * |
96fba48f | 929 | * Returns 0 if successful, otherwise a positive errno value. */ |
064af421 | 930 | int |
f1588b1f | 931 | dpif_execute(struct dpif *dpif, |
cdee00fd | 932 | const struct nlattr *actions, size_t actions_len, |
064af421 BP |
933 | const struct ofpbuf *buf) |
934 | { | |
935 | int error; | |
936 | ||
937 | COVERAGE_INC(dpif_execute); | |
cdee00fd BP |
938 | if (actions_len > 0) { |
939 | error = dpif->dpif_class->execute(dpif, actions, actions_len, buf); | |
064af421 BP |
940 | } else { |
941 | error = 0; | |
942 | } | |
943 | ||
944 | if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) { | |
945 | struct ds ds = DS_EMPTY_INITIALIZER; | |
946 | char *packet = ofp_packet_to_string(buf->data, buf->size, buf->size); | |
b29ba128 | 947 | ds_put_format(&ds, "%s: execute ", dpif_name(dpif)); |
cdee00fd | 948 | format_odp_actions(&ds, actions, actions_len); |
064af421 BP |
949 | if (error) { |
950 | ds_put_format(&ds, " failed (%s)", strerror(error)); | |
951 | } | |
952 | ds_put_format(&ds, " on packet %s", packet); | |
953 | vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds)); | |
954 | ds_destroy(&ds); | |
955 | free(packet); | |
956 | } | |
957 | return error; | |
958 | } | |
959 | ||
82272ede BP |
960 | static bool OVS_UNUSED |
961 | is_valid_listen_mask(int listen_mask) | |
962 | { | |
963 | return !(listen_mask & ~((1u << DPIF_UC_MISS) | | |
964 | (1u << DPIF_UC_ACTION) | | |
965 | (1u << DPIF_UC_SAMPLE))); | |
966 | } | |
967 | ||
968 | /* Retrieves 'dpif''s "listen mask" into '*listen_mask'. A 1-bit of value 2**X | |
969 | * set in '*listen_mask' indicates that dpif_recv() will receive messages of | |
970 | * the type (from "enum dpif_upcall_type") with value X. Returns 0 if | |
971 | * successful, otherwise a positive errno value. */ | |
8f24562a BP |
972 | int |
973 | dpif_recv_get_mask(const struct dpif *dpif, int *listen_mask) | |
974 | { | |
1acb6baa | 975 | int error = dpif->dpif_class->recv_get_mask(dpif, listen_mask); |
8f24562a BP |
976 | if (error) { |
977 | *listen_mask = 0; | |
978 | } | |
82272ede | 979 | assert(is_valid_listen_mask(*listen_mask)); |
96fba48f | 980 | log_operation(dpif, "recv_get_mask", error); |
8f24562a BP |
981 | return error; |
982 | } | |
983 | ||
82272ede BP |
984 | /* Sets 'dpif''s "listen mask" to 'listen_mask'. A 1-bit of value 2**X set in |
985 | * '*listen_mask' requests that dpif_recv() will receive messages of the type | |
986 | * (from "enum dpif_upcall_type") with value X. Returns 0 if successful, | |
987 | * otherwise a positive errno value. */ | |
8f24562a BP |
988 | int |
989 | dpif_recv_set_mask(struct dpif *dpif, int listen_mask) | |
990 | { | |
82272ede BP |
991 | int error; |
992 | ||
993 | assert(is_valid_listen_mask(listen_mask)); | |
994 | ||
995 | error = dpif->dpif_class->recv_set_mask(dpif, listen_mask); | |
96fba48f BP |
996 | log_operation(dpif, "recv_set_mask", error); |
997 | return error; | |
8f24562a BP |
998 | } |
999 | ||
b4a7a3f3 BP |
1000 | /* Retrieve the sFlow sampling probability. '*probability' is expressed as the |
1001 | * number of packets out of UINT_MAX to sample, e.g. probability/UINT_MAX is | |
1002 | * the probability of sampling a given packet. | |
72b06300 BP |
1003 | * |
1004 | * Returns 0 if successful, otherwise a positive errno value. EOPNOTSUPP | |
1005 | * indicates that 'dpif' does not support sFlow sampling. */ | |
1006 | int | |
1007 | dpif_get_sflow_probability(const struct dpif *dpif, uint32_t *probability) | |
1008 | { | |
49c36903 BP |
1009 | int error = (dpif->dpif_class->get_sflow_probability |
1010 | ? dpif->dpif_class->get_sflow_probability(dpif, probability) | |
72b06300 BP |
1011 | : EOPNOTSUPP); |
1012 | if (error) { | |
1013 | *probability = 0; | |
1014 | } | |
1015 | log_operation(dpif, "get_sflow_probability", error); | |
1016 | return error; | |
1017 | } | |
1018 | ||
b4a7a3f3 BP |
1019 | /* Set the sFlow sampling probability. 'probability' is expressed as the |
1020 | * number of packets out of UINT_MAX to sample, e.g. probability/UINT_MAX is | |
1021 | * the probability of sampling a given packet. | |
72b06300 BP |
1022 | * |
1023 | * Returns 0 if successful, otherwise a positive errno value. EOPNOTSUPP | |
1024 | * indicates that 'dpif' does not support sFlow sampling. */ | |
1025 | int | |
1026 | dpif_set_sflow_probability(struct dpif *dpif, uint32_t probability) | |
1027 | { | |
49c36903 BP |
1028 | int error = (dpif->dpif_class->set_sflow_probability |
1029 | ? dpif->dpif_class->set_sflow_probability(dpif, probability) | |
72b06300 BP |
1030 | : EOPNOTSUPP); |
1031 | log_operation(dpif, "set_sflow_probability", error); | |
1032 | return error; | |
1033 | } | |
1034 | ||
856081f6 | 1035 | /* Polls for an upcall from 'dpif'. If successful, stores the upcall into |
82272ede | 1036 | * '*upcall'. Only upcalls of the types selected with dpif_recv_set_mask() |
856081f6 | 1037 | * member function will ordinarily be received (but if a message type is |
96fba48f BP |
1038 | * enabled and then later disabled, some stragglers might pop up). |
1039 | * | |
856081f6 BP |
1040 | * The caller takes ownership of the data that 'upcall' points to. |
1041 | * 'upcall->key' and 'upcall->actions' (if nonnull) point into data owned by | |
1042 | * 'upcall->packet', so their memory cannot be freed separately. (This is | |
1043 | * hardly a great way to do things but it works out OK for the dpif providers | |
1044 | * and clients that exist so far.) | |
1045 | * | |
96fba48f | 1046 | * Returns 0 if successful, otherwise a positive errno value. Returns EAGAIN |
856081f6 | 1047 | * if no upcall is immediately available. */ |
064af421 | 1048 | int |
856081f6 | 1049 | dpif_recv(struct dpif *dpif, struct dpif_upcall *upcall) |
064af421 | 1050 | { |
856081f6 BP |
1051 | int error = dpif->dpif_class->recv(dpif, upcall); |
1052 | if (!error && !VLOG_DROP_DBG(&dpmsg_rl)) { | |
1053 | struct flow flow; | |
1054 | char *s; | |
1055 | ||
1056 | s = ofp_packet_to_string(upcall->packet->data, | |
1057 | upcall->packet->size, upcall->packet->size); | |
1058 | odp_flow_key_to_flow(upcall->key, upcall->key_len, &flow); | |
1059 | ||
1060 | VLOG_DBG("%s: %s upcall on port %"PRIu16": %s", dpif_name(dpif), | |
82272ede BP |
1061 | (upcall->type == DPIF_UC_MISS ? "miss" |
1062 | : upcall->type == DPIF_UC_ACTION ? "action" | |
1063 | : upcall->type == DPIF_UC_SAMPLE ? "sample" | |
856081f6 BP |
1064 | : "<unknown>"), |
1065 | flow.in_port, s); | |
1066 | free(s); | |
064af421 | 1067 | } |
064af421 BP |
1068 | return error; |
1069 | } | |
1070 | ||
96fba48f | 1071 | /* Discards all messages that would otherwise be received by dpif_recv() on |
1ba530f4 BP |
1072 | * 'dpif'. */ |
1073 | void | |
96fba48f BP |
1074 | dpif_recv_purge(struct dpif *dpif) |
1075 | { | |
96fba48f | 1076 | COVERAGE_INC(dpif_purge); |
1ba530f4 BP |
1077 | if (dpif->dpif_class->recv_purge) { |
1078 | dpif->dpif_class->recv_purge(dpif); | |
96fba48f | 1079 | } |
96fba48f BP |
1080 | } |
1081 | ||
1082 | /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be | |
1083 | * received with dpif_recv(). */ | |
064af421 BP |
1084 | void |
1085 | dpif_recv_wait(struct dpif *dpif) | |
1086 | { | |
1acb6baa | 1087 | dpif->dpif_class->recv_wait(dpif); |
064af421 | 1088 | } |
53a4218d | 1089 | |
96fba48f BP |
1090 | /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type' |
1091 | * and '*engine_id', respectively. */ | |
53a4218d BP |
1092 | void |
1093 | dpif_get_netflow_ids(const struct dpif *dpif, | |
1094 | uint8_t *engine_type, uint8_t *engine_id) | |
1095 | { | |
96fba48f BP |
1096 | *engine_type = dpif->netflow_engine_type; |
1097 | *engine_id = dpif->netflow_engine_id; | |
1098 | } | |
aae51f53 BP |
1099 | |
1100 | /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority | |
7aec165d BP |
1101 | * value for use in the ODP_ACTION_ATTR_SET_PRIORITY action. On success, |
1102 | * returns 0 and stores the priority into '*priority'. On failure, returns a | |
1103 | * positive errno value and stores 0 into '*priority'. */ | |
aae51f53 BP |
1104 | int |
1105 | dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id, | |
1106 | uint32_t *priority) | |
1107 | { | |
1108 | int error = (dpif->dpif_class->queue_to_priority | |
1109 | ? dpif->dpif_class->queue_to_priority(dpif, queue_id, | |
1110 | priority) | |
1111 | : EOPNOTSUPP); | |
1112 | if (error) { | |
1113 | *priority = 0; | |
1114 | } | |
1115 | log_operation(dpif, "queue_to_priority", error); | |
1116 | return error; | |
1117 | } | |
96fba48f BP |
1118 | \f |
1119 | void | |
1acb6baa BP |
1120 | dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class, |
1121 | const char *name, | |
96fba48f BP |
1122 | uint8_t netflow_engine_type, uint8_t netflow_engine_id) |
1123 | { | |
1acb6baa | 1124 | dpif->dpif_class = dpif_class; |
1a6f1e2a | 1125 | dpif->base_name = xstrdup(name); |
a4af0040 | 1126 | dpif->full_name = xasprintf("%s@%s", dpif_class->type, name); |
96fba48f BP |
1127 | dpif->netflow_engine_type = netflow_engine_type; |
1128 | dpif->netflow_engine_id = netflow_engine_id; | |
1129 | } | |
999401aa JG |
1130 | |
1131 | /* Undoes the results of initialization. | |
1132 | * | |
1133 | * Normally this function only needs to be called from dpif_close(). | |
1134 | * However, it may be called by providers due to an error on opening | |
1135 | * that occurs after initialization. It this case dpif_close() would | |
1136 | * never be called. */ | |
1137 | void | |
1138 | dpif_uninit(struct dpif *dpif, bool close) | |
1139 | { | |
1140 | char *base_name = dpif->base_name; | |
1141 | char *full_name = dpif->full_name; | |
1142 | ||
1143 | if (close) { | |
a4af0040 | 1144 | dpif->dpif_class->close(dpif); |
999401aa JG |
1145 | } |
1146 | ||
1147 | free(base_name); | |
1148 | free(full_name); | |
1149 | } | |
96fba48f BP |
1150 | \f |
1151 | static void | |
1152 | log_operation(const struct dpif *dpif, const char *operation, int error) | |
1153 | { | |
1154 | if (!error) { | |
1155 | VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation); | |
71ce9235 | 1156 | } else if (is_errno(error)) { |
96fba48f BP |
1157 | VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)", |
1158 | dpif_name(dpif), operation, strerror(error)); | |
71ce9235 BP |
1159 | } else { |
1160 | VLOG_WARN_RL(&error_rl, "%s: %s failed (%d/%d)", | |
1161 | dpif_name(dpif), operation, | |
1162 | get_ofp_err_type(error), get_ofp_err_code(error)); | |
96fba48f BP |
1163 | } |
1164 | } | |
1165 | ||
1166 | static enum vlog_level | |
1167 | flow_message_log_level(int error) | |
1168 | { | |
1169 | return error ? VLL_WARN : VLL_DBG; | |
1170 | } | |
1171 | ||
1172 | static bool | |
1173 | should_log_flow_message(int error) | |
1174 | { | |
1175 | return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error), | |
1176 | error ? &error_rl : &dpmsg_rl); | |
1177 | } | |
1178 | ||
1179 | static void | |
1180 | log_flow_message(const struct dpif *dpif, int error, const char *operation, | |
36956a7d | 1181 | const struct nlattr *key, size_t key_len, |
c97fb132 | 1182 | const struct dpif_flow_stats *stats, |
cf22f8cb | 1183 | const struct nlattr *actions, size_t actions_len) |
96fba48f BP |
1184 | { |
1185 | struct ds ds = DS_EMPTY_INITIALIZER; | |
1186 | ds_put_format(&ds, "%s: ", dpif_name(dpif)); | |
1187 | if (error) { | |
1188 | ds_put_cstr(&ds, "failed to "); | |
1189 | } | |
1190 | ds_put_format(&ds, "%s ", operation); | |
1191 | if (error) { | |
1192 | ds_put_format(&ds, "(%s) ", strerror(error)); | |
1193 | } | |
36956a7d | 1194 | odp_flow_key_format(key, key_len, &ds); |
96fba48f BP |
1195 | if (stats) { |
1196 | ds_put_cstr(&ds, ", "); | |
c97fb132 | 1197 | dpif_flow_stats_format(stats, &ds); |
96fba48f | 1198 | } |
cdee00fd | 1199 | if (actions || actions_len) { |
96fba48f | 1200 | ds_put_cstr(&ds, ", actions:"); |
cdee00fd | 1201 | format_odp_actions(&ds, actions, actions_len); |
96fba48f BP |
1202 | } |
1203 | vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds)); | |
1204 | ds_destroy(&ds); | |
1205 | } |