2 * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #include "dpif-provider.h"
28 #include "dynamic-string.h"
33 #include "ofp-print.h"
37 #include "poll-loop.h"
45 VLOG_DEFINE_THIS_MODULE(dpif);
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);
59 static const struct dpif_class *base_dpif_classes[] = {
66 struct registered_dpif_class {
67 const struct dpif_class *dpif_class;
70 static struct shash dpif_classes = SHASH_INITIALIZER(&dpif_classes);
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);
77 /* Not really much point in logging many dpif errors. */
78 static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(60, 5);
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,
83 const struct dpif_flow_stats *stats,
84 const struct nlattr *actions, size_t actions_len);
85 static void log_operation(const struct dpif *, const char *operation,
87 static bool should_log_flow_message(int error);
92 static int status = -1;
98 for (i = 0; i < ARRAY_SIZE(base_dpif_classes); i++) {
99 dp_register_provider(base_dpif_classes[i]);
104 /* Performs periodic work needed by all the various kinds of dpifs.
106 * If your program opens any dpifs, it must call both this function and
107 * netdev_run() within its main poll loop. */
111 struct shash_node *node;
112 SHASH_FOR_EACH(node, &dpif_classes) {
113 const struct registered_dpif_class *registered_class = node->data;
114 if (registered_class->dpif_class->run) {
115 registered_class->dpif_class->run();
120 /* Arranges for poll_block() to wake up when dp_run() needs to be called.
122 * If your program opens any dpifs, it must call both this function and
123 * netdev_wait() within its main poll loop. */
127 struct shash_node *node;
128 SHASH_FOR_EACH(node, &dpif_classes) {
129 const struct registered_dpif_class *registered_class = node->data;
130 if (registered_class->dpif_class->wait) {
131 registered_class->dpif_class->wait();
136 /* Registers a new datapath provider. After successful registration, new
137 * datapaths of that type can be opened using dpif_open(). */
139 dp_register_provider(const struct dpif_class *new_class)
141 struct registered_dpif_class *registered_class;
143 if (shash_find(&dpif_classes, new_class->type)) {
144 VLOG_WARN("attempted to register duplicate datapath provider: %s",
149 registered_class = xmalloc(sizeof *registered_class);
150 registered_class->dpif_class = new_class;
151 registered_class->refcount = 0;
153 shash_add(&dpif_classes, new_class->type, registered_class);
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(). */
162 dp_unregister_provider(const char *type)
164 struct shash_node *node;
165 struct registered_dpif_class *registered_class;
167 node = shash_find(&dpif_classes, type);
169 VLOG_WARN("attempted to unregister a datapath provider that is not "
170 "registered: %s", type);
174 registered_class = node->data;
175 if (registered_class->refcount) {
176 VLOG_WARN("attempted to unregister in use datapath provider: %s", type);
180 shash_delete(&dpif_classes, node);
181 free(registered_class);
186 /* Clears 'types' and enumerates the types of all currently registered datapath
187 * providers into it. The caller must first initialize the svec. */
189 dp_enumerate_types(struct svec *types)
191 struct shash_node *node;
196 SHASH_FOR_EACH(node, &dpif_classes) {
197 const struct registered_dpif_class *registered_class = node->data;
198 svec_add(types, registered_class->dpif_class->type);
202 /* Clears 'names' and enumerates the names of all known created datapaths with
203 * the given 'type'. The caller must first initialize the svec. Returns 0 if
204 * successful, otherwise a positive errno value.
206 * Some kinds of datapaths might not be practically enumerable. This is not
207 * considered an error. */
209 dp_enumerate_names(const char *type, struct svec *names)
211 const struct registered_dpif_class *registered_class;
212 const struct dpif_class *dpif_class;
218 registered_class = shash_find_data(&dpif_classes, type);
219 if (!registered_class) {
220 VLOG_WARN("could not enumerate unknown type: %s", type);
224 dpif_class = registered_class->dpif_class;
225 error = dpif_class->enumerate ? dpif_class->enumerate(names) : 0;
228 VLOG_WARN("failed to enumerate %s datapaths: %s", dpif_class->type,
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. */
238 dp_parse_name(const char *datapath_name_, char **name, char **type)
240 char *datapath_name = xstrdup(datapath_name_);
243 separator = strchr(datapath_name, '@');
246 *type = datapath_name;
247 *name = xstrdup(separator + 1);
249 *name = datapath_name;
255 do_open(const char *name, const char *type, bool create, struct dpif **dpifp)
257 struct dpif *dpif = NULL;
259 struct registered_dpif_class *registered_class;
263 if (!type || *type == '\0') {
267 registered_class = shash_find_data(&dpif_classes, type);
268 if (!registered_class) {
269 VLOG_WARN("could not create datapath %s of unknown type %s", name,
271 error = EAFNOSUPPORT;
275 error = registered_class->dpif_class->open(registered_class->dpif_class,
276 name, create, &dpif);
278 assert(dpif->dpif_class == registered_class->dpif_class);
279 registered_class->refcount++;
283 *dpifp = error ? NULL : dpif;
287 /* Tries to open an existing datapath named 'name' and type 'type'. Will fail
288 * if no datapath with 'name' and 'type' exists. 'type' may be either NULL or
289 * the empty string to specify the default system type. Returns 0 if
290 * successful, otherwise a positive errno value. On success stores a pointer
291 * to the datapath in '*dpifp', otherwise a null pointer. */
293 dpif_open(const char *name, const char *type, struct dpif **dpifp)
295 return do_open(name, type, false, dpifp);
298 /* Tries to create and open a new datapath with the given 'name' and 'type'.
299 * 'type' may be either NULL or the empty string to specify the default system
300 * type. Will fail if a datapath with 'name' and 'type' already exists.
301 * Returns 0 if successful, otherwise a positive errno value. On success
302 * stores a pointer to the datapath in '*dpifp', otherwise a null pointer. */
304 dpif_create(const char *name, const char *type, struct dpif **dpifp)
306 return do_open(name, type, true, dpifp);
309 /* Tries to open a datapath with the given 'name' and 'type', creating it if it
310 * does not exist. 'type' may be either NULL or the empty string to specify
311 * the default system type. Returns 0 if successful, otherwise a positive
312 * errno value. On success stores a pointer to the datapath in '*dpifp',
313 * otherwise a null pointer. */
315 dpif_create_and_open(const char *name, const char *type, struct dpif **dpifp)
319 error = dpif_create(name, type, dpifp);
320 if (error == EEXIST || error == EBUSY) {
321 error = dpif_open(name, type, dpifp);
323 VLOG_WARN("datapath %s already exists but cannot be opened: %s",
324 name, strerror(error));
327 VLOG_WARN("failed to create datapath %s: %s", name, strerror(error));
332 /* Closes and frees the connection to 'dpif'. Does not destroy the datapath
333 * itself; call dpif_delete() first, instead, if that is desirable. */
335 dpif_close(struct dpif *dpif)
338 struct registered_dpif_class *registered_class;
340 registered_class = shash_find_data(&dpif_classes,
341 dpif->dpif_class->type);
342 assert(registered_class);
343 assert(registered_class->refcount);
345 registered_class->refcount--;
346 dpif_uninit(dpif, true);
350 /* Returns the name of datapath 'dpif' prefixed with the type
351 * (for use in log messages). */
353 dpif_name(const struct dpif *dpif)
355 return dpif->full_name;
358 /* Returns the name of datapath 'dpif' without the type
359 * (for use in device names). */
361 dpif_base_name(const struct dpif *dpif)
363 return dpif->base_name;
366 /* Enumerates all names that may be used to open 'dpif' into 'all_names'. The
367 * Linux datapath, for example, supports opening a datapath both by number,
368 * e.g. "dp0", and by the name of the datapath's local port. For some
369 * datapaths, this might be an infinite set (e.g. in a file name, slashes may
370 * be duplicated any number of times), in which case only the names most likely
371 * to be used will be enumerated.
373 * The caller must already have initialized 'all_names'. Any existing names in
374 * 'all_names' will not be disturbed. */
376 dpif_get_all_names(const struct dpif *dpif, struct svec *all_names)
378 if (dpif->dpif_class->get_all_names) {
379 int error = dpif->dpif_class->get_all_names(dpif, all_names);
381 VLOG_WARN_RL(&error_rl,
382 "failed to retrieve names for datpath %s: %s",
383 dpif_name(dpif), strerror(error));
387 svec_add(all_names, dpif_base_name(dpif));
393 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
394 * ports. After calling this function, it does not make sense to pass 'dpif'
395 * to any functions other than dpif_name() or dpif_close(). */
397 dpif_delete(struct dpif *dpif)
401 COVERAGE_INC(dpif_destroy);
403 error = dpif->dpif_class->destroy(dpif);
404 log_operation(dpif, "delete", error);
408 /* Retrieves statistics for 'dpif' into 'stats'. Returns 0 if successful,
409 * otherwise a positive errno value. */
411 dpif_get_dp_stats(const struct dpif *dpif, struct odp_stats *stats)
413 int error = dpif->dpif_class->get_stats(dpif, stats);
415 memset(stats, 0, sizeof *stats);
417 log_operation(dpif, "get_stats", error);
421 /* Retrieves the current IP fragment handling policy for 'dpif' into
422 * '*drop_frags': true indicates that fragments are dropped, false indicates
423 * that fragments are treated in the same way as other IP packets (except that
424 * the L4 header cannot be read). Returns 0 if successful, otherwise a
425 * positive errno value. */
427 dpif_get_drop_frags(const struct dpif *dpif, bool *drop_frags)
429 int error = dpif->dpif_class->get_drop_frags(dpif, drop_frags);
433 log_operation(dpif, "get_drop_frags", error);
437 /* Changes 'dpif''s treatment of IP fragments to 'drop_frags', whose meaning is
438 * the same as for the get_drop_frags member function. Returns 0 if
439 * successful, otherwise a positive errno value. */
441 dpif_set_drop_frags(struct dpif *dpif, bool drop_frags)
443 int error = dpif->dpif_class->set_drop_frags(dpif, drop_frags);
444 log_operation(dpif, "set_drop_frags", error);
448 /* Attempts to add 'netdev' as a port on 'dpif'. If successful, returns 0 and
449 * sets '*port_nop' to the new port's port number (if 'port_nop' is non-null).
450 * On failure, returns a positive errno value and sets '*port_nop' to
451 * UINT16_MAX (if 'port_nop' is non-null). */
453 dpif_port_add(struct dpif *dpif, struct netdev *netdev, uint16_t *port_nop)
455 const char *netdev_name = netdev_get_name(netdev);
459 COVERAGE_INC(dpif_port_add);
461 error = dpif->dpif_class->port_add(dpif, netdev, &port_no);
463 VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu16,
464 dpif_name(dpif), netdev_name, port_no);
466 VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s",
467 dpif_name(dpif), netdev_name, strerror(error));
468 port_no = UINT16_MAX;
476 /* Attempts to remove 'dpif''s port number 'port_no'. Returns 0 if successful,
477 * otherwise a positive errno value. */
479 dpif_port_del(struct dpif *dpif, uint16_t port_no)
483 COVERAGE_INC(dpif_port_del);
485 error = dpif->dpif_class->port_del(dpif, port_no);
487 VLOG_DBG_RL(&dpmsg_rl, "%s: port_del(%"PRIu16")",
488 dpif_name(dpif), port_no);
490 log_operation(dpif, "port_del", error);
495 /* Makes a deep copy of 'src' into 'dst'. */
497 dpif_port_clone(struct dpif_port *dst, const struct dpif_port *src)
499 dst->name = xstrdup(src->name);
500 dst->type = xstrdup(src->type);
501 dst->port_no = src->port_no;
504 /* Frees memory allocated to members of 'dpif_port'.
506 * Do not call this function on a dpif_port obtained from
507 * dpif_port_dump_next(): that function retains ownership of the data in the
510 dpif_port_destroy(struct dpif_port *dpif_port)
512 free(dpif_port->name);
513 free(dpif_port->type);
516 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and
517 * initializes '*port' appropriately; on failure, returns a positive errno
520 * The caller owns the data in 'port' and must free it with
521 * dpif_port_destroy() when it is no longer needed. */
523 dpif_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
524 struct dpif_port *port)
526 int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port);
528 VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu16" is device %s",
529 dpif_name(dpif), port_no, port->name);
531 memset(port, 0, sizeof *port);
532 VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu16": %s",
533 dpif_name(dpif), port_no, strerror(error));
538 /* Looks up port named 'devname' in 'dpif'. On success, returns 0 and
539 * initializes '*port' appropriately; on failure, returns a positive errno
542 * The caller owns the data in 'port' and must free it with
543 * dpif_port_destroy() when it is no longer needed. */
545 dpif_port_query_by_name(const struct dpif *dpif, const char *devname,
546 struct dpif_port *port)
548 int error = dpif->dpif_class->port_query_by_name(dpif, devname, port);
550 VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu16,
551 dpif_name(dpif), devname, port->port_no);
553 memset(port, 0, sizeof *port);
555 /* Log level is DBG here because all the current callers are interested
556 * in whether 'dpif' actually has a port 'devname', so that it's not an
557 * issue worth logging if it doesn't. */
558 VLOG_DBG_RL(&error_rl, "%s: failed to query port %s: %s",
559 dpif_name(dpif), devname, strerror(error));
564 /* Returns one greater than the maximum port number accepted in flow
567 dpif_get_max_ports(const struct dpif *dpif)
569 return dpif->dpif_class->get_max_ports(dpif);
572 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and copies
573 * the port's name into the 'name_size' bytes in 'name', ensuring that the
574 * result is null-terminated. On failure, returns a positive errno value and
575 * makes 'name' the empty string. */
577 dpif_port_get_name(struct dpif *dpif, uint16_t port_no,
578 char *name, size_t name_size)
580 struct dpif_port port;
583 assert(name_size > 0);
585 error = dpif_port_query_by_number(dpif, port_no, &port);
587 ovs_strlcpy(name, port.name, name_size);
588 dpif_port_destroy(&port);
595 /* Initializes 'dump' to begin dumping the ports in a dpif.
597 * This function provides no status indication. An error status for the entire
598 * dump operation is provided when it is completed by calling
599 * dpif_port_dump_done().
602 dpif_port_dump_start(struct dpif_port_dump *dump, const struct dpif *dpif)
605 dump->error = dpif->dpif_class->port_dump_start(dpif, &dump->state);
606 log_operation(dpif, "port_dump_start", dump->error);
609 /* Attempts to retrieve another port from 'dump', which must have been
610 * initialized with dpif_port_dump_start(). On success, stores a new dpif_port
611 * into 'port' and returns true. On failure, returns false.
613 * Failure might indicate an actual error or merely that the last port has been
614 * dumped. An error status for the entire dump operation is provided when it
615 * is completed by calling dpif_port_dump_done().
617 * The dpif owns the data stored in 'port'. It will remain valid until at
618 * least the next time 'dump' is passed to dpif_port_dump_next() or
619 * dpif_port_dump_done(). */
621 dpif_port_dump_next(struct dpif_port_dump *dump, struct dpif_port *port)
623 const struct dpif *dpif = dump->dpif;
629 dump->error = dpif->dpif_class->port_dump_next(dpif, dump->state, port);
630 if (dump->error == EOF) {
631 VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all ports", dpif_name(dpif));
633 log_operation(dpif, "port_dump_next", dump->error);
637 dpif->dpif_class->port_dump_done(dpif, dump->state);
643 /* Completes port table dump operation 'dump', which must have been initialized
644 * with dpif_port_dump_start(). Returns 0 if the dump operation was
645 * error-free, otherwise a positive errno value describing the problem. */
647 dpif_port_dump_done(struct dpif_port_dump *dump)
649 const struct dpif *dpif = dump->dpif;
651 dump->error = dpif->dpif_class->port_dump_done(dpif, dump->state);
652 log_operation(dpif, "port_dump_done", dump->error);
654 return dump->error == EOF ? 0 : dump->error;
657 /* Polls for changes in the set of ports in 'dpif'. If the set of ports in
658 * 'dpif' has changed, this function does one of the following:
660 * - Stores the name of the device that was added to or deleted from 'dpif' in
661 * '*devnamep' and returns 0. The caller is responsible for freeing
662 * '*devnamep' (with free()) when it no longer needs it.
664 * - Returns ENOBUFS and sets '*devnamep' to NULL.
666 * This function may also return 'false positives', where it returns 0 and
667 * '*devnamep' names a device that was not actually added or deleted or it
668 * returns ENOBUFS without any change.
670 * Returns EAGAIN if the set of ports in 'dpif' has not changed. May also
671 * return other positive errno values to indicate that something has gone
674 dpif_port_poll(const struct dpif *dpif, char **devnamep)
676 int error = dpif->dpif_class->port_poll(dpif, devnamep);
683 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
684 * value other than EAGAIN. */
686 dpif_port_poll_wait(const struct dpif *dpif)
688 dpif->dpif_class->port_poll_wait(dpif);
691 /* Appends a human-readable representation of 'stats' to 's'. */
693 dpif_flow_stats_format(const struct dpif_flow_stats *stats, struct ds *s)
695 ds_put_format(s, "packets:%"PRIu64", bytes:%"PRIu64", used:",
696 stats->n_packets, stats->n_bytes);
698 ds_put_format(s, "%.3fs", (time_msec() - stats->used) / 1000.0);
700 ds_put_format(s, "never");
705 /* Deletes all flows from 'dpif'. Returns 0 if successful, otherwise a
706 * positive errno value. */
708 dpif_flow_flush(struct dpif *dpif)
712 COVERAGE_INC(dpif_flow_flush);
714 error = dpif->dpif_class->flow_flush(dpif);
715 log_operation(dpif, "flow_flush", error);
719 /* Queries 'dpif' for a flow entry. The flow is specified by the Netlink
720 * attributes with types ODP_KEY_ATTR_* in the 'key_len' bytes starting at
723 * Returns 0 if successful. If no flow matches, returns ENOENT. On other
724 * failure, returns a positive errno value.
726 * If 'actionsp' is nonnull, then on success '*actionsp' will be set to an
727 * ofpbuf owned by the caller that contains the Netlink attributes for the
728 * flow's actions. The caller must free the ofpbuf (with ofpbuf_delete()) when
729 * it is no longer needed.
731 * If 'stats' is nonnull, then on success it will be updated with the flow's
734 dpif_flow_get(const struct dpif *dpif,
735 const struct nlattr *key, size_t key_len,
736 struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
740 COVERAGE_INC(dpif_flow_get);
742 error = dpif->dpif_class->flow_get(dpif, key, key_len, actionsp, stats);
748 memset(stats, 0, sizeof *stats);
751 if (should_log_flow_message(error)) {
752 const struct nlattr *actions;
755 if (!error && actionsp) {
756 actions = (*actionsp)->data;
757 actions_len = (*actionsp)->size;
762 log_flow_message(dpif, error, "flow_get", key, key_len, stats,
763 actions, actions_len);
768 /* Adds or modifies a flow in 'dpif'. The flow is specified by the Netlink
769 * attributes with types ODP_KEY_ATTR_* in the 'key_len' bytes starting at
770 * 'key'. The associated actions are specified by the Netlink attributes with
771 * types ODPAT_* in the 'actions_len' bytes starting at 'actions'.
773 * - If the flow's key does not exist in 'dpif', then the flow will be added if
774 * 'flags' includes DPIF_FP_CREATE. Otherwise the operation will fail with
777 * If the operation succeeds, then 'stats', if nonnull, will be zeroed.
779 * - If the flow's key does exist in 'dpif', then the flow's actions will be
780 * updated if 'flags' includes DPIF_FP_MODIFY. Otherwise the operation will
781 * fail with EEXIST. If the flow's actions are updated, then its statistics
782 * will be zeroed if 'flags' includes DPIF_FP_ZERO_STATS, and left as-is
785 * If the operation succeeds, then 'stats', if nonnull, will be set to the
786 * flow's statistics before the update.
789 dpif_flow_put(struct dpif *dpif, enum dpif_flow_put_flags flags,
790 const struct nlattr *key, size_t key_len,
791 const struct nlattr *actions, size_t actions_len,
792 struct dpif_flow_stats *stats)
796 COVERAGE_INC(dpif_flow_put);
797 assert(!(flags & ~(DPIF_FP_CREATE | DPIF_FP_MODIFY | DPIF_FP_ZERO_STATS)));
799 error = dpif->dpif_class->flow_put(dpif, flags, key, key_len,
800 actions, actions_len, stats);
801 if (error && stats) {
802 memset(stats, 0, sizeof *stats);
804 if (should_log_flow_message(error)) {
808 ds_put_cstr(&s, "put");
809 if (flags & DPIF_FP_CREATE) {
810 ds_put_cstr(&s, "[create]");
812 if (flags & DPIF_FP_MODIFY) {
813 ds_put_cstr(&s, "[modify]");
815 if (flags & DPIF_FP_ZERO_STATS) {
816 ds_put_cstr(&s, "[zero]");
818 log_flow_message(dpif, error, ds_cstr(&s), key, key_len, stats,
819 actions, actions_len);
825 /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif' does
826 * not contain such a flow. The flow is specified by the Netlink attributes
827 * with types ODP_KEY_ATTR_* in the 'key_len' bytes starting at 'key'.
829 * If the operation succeeds, then 'stats', if nonnull, will be set to the
830 * flow's statistics before its deletion. */
832 dpif_flow_del(struct dpif *dpif,
833 const struct nlattr *key, size_t key_len,
834 struct dpif_flow_stats *stats)
838 COVERAGE_INC(dpif_flow_del);
840 error = dpif->dpif_class->flow_del(dpif, key, key_len, stats);
841 if (error && stats) {
842 memset(stats, 0, sizeof *stats);
844 if (should_log_flow_message(error)) {
845 log_flow_message(dpif, error, "flow_del", key, key_len,
846 !error ? stats : NULL, NULL, 0);
851 /* Initializes 'dump' to begin dumping the flows in a dpif.
853 * This function provides no status indication. An error status for the entire
854 * dump operation is provided when it is completed by calling
855 * dpif_flow_dump_done().
858 dpif_flow_dump_start(struct dpif_flow_dump *dump, const struct dpif *dpif)
861 dump->error = dpif->dpif_class->flow_dump_start(dpif, &dump->state);
862 log_operation(dpif, "flow_dump_start", dump->error);
865 /* Attempts to retrieve another flow from 'dump', which must have been
866 * initialized with dpif_flow_dump_start(). On success, updates the output
867 * parameters as described below and returns true. Otherwise, returns false.
868 * Failure might indicate an actual error or merely the end of the flow table.
869 * An error status for the entire dump operation is provided when it is
870 * completed by calling dpif_flow_dump_done().
872 * On success, if 'key' and 'key_len' are nonnull then '*key' and '*key_len'
873 * will be set to Netlink attributes with types ODP_KEY_ATTR_* representing the
874 * dumped flow's key. If 'actions' and 'actions_len' are nonnull then they are
875 * set to Netlink attributes with types ODPAT_* representing the dumped flow's
876 * actions. If 'stats' is nonnull then it will be set to the dumped flow's
879 * All of the returned data is owned by 'dpif', not by the caller, and the
880 * caller must not modify or free it. 'dpif' guarantees that it remains
881 * accessible and unchanging until at least the next call to 'flow_dump_next'
882 * or 'flow_dump_done' for 'dump'. */
884 dpif_flow_dump_next(struct dpif_flow_dump *dump,
885 const struct nlattr **key, size_t *key_len,
886 const struct nlattr **actions, size_t *actions_len,
887 const struct dpif_flow_stats **stats)
889 const struct dpif *dpif = dump->dpif;
890 int error = dump->error;
893 error = dpif->dpif_class->flow_dump_next(dpif, dump->state,
895 actions, actions_len,
898 dpif->dpif_class->flow_dump_done(dpif, dump->state);
916 VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all flows", dpif_name(dpif));
917 } else if (should_log_flow_message(error)) {
918 log_flow_message(dpif, error, "flow_dump",
919 key ? *key : NULL, key ? *key_len : 0,
920 stats ? *stats : NULL, actions ? *actions : NULL,
921 actions ? *actions_len : 0);
928 /* Completes flow table dump operation 'dump', which must have been initialized
929 * with dpif_flow_dump_start(). Returns 0 if the dump operation was
930 * error-free, otherwise a positive errno value describing the problem. */
932 dpif_flow_dump_done(struct dpif_flow_dump *dump)
934 const struct dpif *dpif = dump->dpif;
936 dump->error = dpif->dpif_class->flow_dump_done(dpif, dump->state);
937 log_operation(dpif, "flow_dump_done", dump->error);
939 return dump->error == EOF ? 0 : dump->error;
942 /* Causes 'dpif' to perform the 'actions_len' bytes of actions in 'actions' on
943 * the Ethernet frame specified in 'packet'.
945 * Returns 0 if successful, otherwise a positive errno value. */
947 dpif_execute(struct dpif *dpif,
948 const struct nlattr *actions, size_t actions_len,
949 const struct ofpbuf *buf)
953 COVERAGE_INC(dpif_execute);
954 if (actions_len > 0) {
955 error = dpif->dpif_class->execute(dpif, actions, actions_len, buf);
960 if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) {
961 struct ds ds = DS_EMPTY_INITIALIZER;
962 char *packet = ofp_packet_to_string(buf->data, buf->size, buf->size);
963 ds_put_format(&ds, "%s: execute ", dpif_name(dpif));
964 format_odp_actions(&ds, actions, actions_len);
966 ds_put_format(&ds, " failed (%s)", strerror(error));
968 ds_put_format(&ds, " on packet %s", packet);
969 vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));
976 static bool OVS_UNUSED
977 is_valid_listen_mask(int listen_mask)
979 return !(listen_mask & ~((1u << DPIF_UC_MISS) |
980 (1u << DPIF_UC_ACTION) |
981 (1u << DPIF_UC_SAMPLE)));
984 /* Retrieves 'dpif''s "listen mask" into '*listen_mask'. A 1-bit of value 2**X
985 * set in '*listen_mask' indicates that dpif_recv() will receive messages of
986 * the type (from "enum dpif_upcall_type") with value X. Returns 0 if
987 * successful, otherwise a positive errno value. */
989 dpif_recv_get_mask(const struct dpif *dpif, int *listen_mask)
991 int error = dpif->dpif_class->recv_get_mask(dpif, listen_mask);
995 assert(is_valid_listen_mask(*listen_mask));
996 log_operation(dpif, "recv_get_mask", error);
1000 /* Sets 'dpif''s "listen mask" to 'listen_mask'. A 1-bit of value 2**X set in
1001 * '*listen_mask' requests that dpif_recv() will receive messages of the type
1002 * (from "enum dpif_upcall_type") with value X. Returns 0 if successful,
1003 * otherwise a positive errno value. */
1005 dpif_recv_set_mask(struct dpif *dpif, int listen_mask)
1009 assert(is_valid_listen_mask(listen_mask));
1011 error = dpif->dpif_class->recv_set_mask(dpif, listen_mask);
1012 log_operation(dpif, "recv_set_mask", error);
1016 /* Retrieve the sFlow sampling probability. '*probability' is expressed as the
1017 * number of packets out of UINT_MAX to sample, e.g. probability/UINT_MAX is
1018 * the probability of sampling a given packet.
1020 * Returns 0 if successful, otherwise a positive errno value. EOPNOTSUPP
1021 * indicates that 'dpif' does not support sFlow sampling. */
1023 dpif_get_sflow_probability(const struct dpif *dpif, uint32_t *probability)
1025 int error = (dpif->dpif_class->get_sflow_probability
1026 ? dpif->dpif_class->get_sflow_probability(dpif, probability)
1031 log_operation(dpif, "get_sflow_probability", error);
1035 /* Set the sFlow sampling probability. 'probability' is expressed as the
1036 * number of packets out of UINT_MAX to sample, e.g. probability/UINT_MAX is
1037 * the probability of sampling a given packet.
1039 * Returns 0 if successful, otherwise a positive errno value. EOPNOTSUPP
1040 * indicates that 'dpif' does not support sFlow sampling. */
1042 dpif_set_sflow_probability(struct dpif *dpif, uint32_t probability)
1044 int error = (dpif->dpif_class->set_sflow_probability
1045 ? dpif->dpif_class->set_sflow_probability(dpif, probability)
1047 log_operation(dpif, "set_sflow_probability", error);
1051 /* Polls for an upcall from 'dpif'. If successful, stores the upcall into
1052 * '*upcall'. Only upcalls of the types selected with dpif_recv_set_mask()
1053 * member function will ordinarily be received (but if a message type is
1054 * enabled and then later disabled, some stragglers might pop up).
1056 * The caller takes ownership of the data that 'upcall' points to.
1057 * 'upcall->key' and 'upcall->actions' (if nonnull) point into data owned by
1058 * 'upcall->packet', so their memory cannot be freed separately. (This is
1059 * hardly a great way to do things but it works out OK for the dpif providers
1060 * and clients that exist so far.)
1062 * Returns 0 if successful, otherwise a positive errno value. Returns EAGAIN
1063 * if no upcall is immediately available. */
1065 dpif_recv(struct dpif *dpif, struct dpif_upcall *upcall)
1067 int error = dpif->dpif_class->recv(dpif, upcall);
1068 if (!error && !VLOG_DROP_DBG(&dpmsg_rl)) {
1072 s = ofp_packet_to_string(upcall->packet->data,
1073 upcall->packet->size, upcall->packet->size);
1074 odp_flow_key_to_flow(upcall->key, upcall->key_len, &flow);
1076 VLOG_DBG("%s: %s upcall on port %"PRIu16": %s", dpif_name(dpif),
1077 (upcall->type == DPIF_UC_MISS ? "miss"
1078 : upcall->type == DPIF_UC_ACTION ? "action"
1079 : upcall->type == DPIF_UC_SAMPLE ? "sample"
1087 /* Discards all messages that would otherwise be received by dpif_recv() on
1090 dpif_recv_purge(struct dpif *dpif)
1092 COVERAGE_INC(dpif_purge);
1093 if (dpif->dpif_class->recv_purge) {
1094 dpif->dpif_class->recv_purge(dpif);
1098 /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be
1099 * received with dpif_recv(). */
1101 dpif_recv_wait(struct dpif *dpif)
1103 dpif->dpif_class->recv_wait(dpif);
1106 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1107 * and '*engine_id', respectively. */
1109 dpif_get_netflow_ids(const struct dpif *dpif,
1110 uint8_t *engine_type, uint8_t *engine_id)
1112 *engine_type = dpif->netflow_engine_type;
1113 *engine_id = dpif->netflow_engine_id;
1116 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1117 * value for use in the ODPAT_SET_PRIORITY action. On success, returns 0 and
1118 * stores the priority into '*priority'. On failure, returns a positive errno
1119 * value and stores 0 into '*priority'. */
1121 dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id,
1124 int error = (dpif->dpif_class->queue_to_priority
1125 ? dpif->dpif_class->queue_to_priority(dpif, queue_id,
1131 log_operation(dpif, "queue_to_priority", error);
1136 dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class,
1138 uint8_t netflow_engine_type, uint8_t netflow_engine_id)
1140 dpif->dpif_class = dpif_class;
1141 dpif->base_name = xstrdup(name);
1142 dpif->full_name = xasprintf("%s@%s", dpif_class->type, name);
1143 dpif->netflow_engine_type = netflow_engine_type;
1144 dpif->netflow_engine_id = netflow_engine_id;
1147 /* Undoes the results of initialization.
1149 * Normally this function only needs to be called from dpif_close().
1150 * However, it may be called by providers due to an error on opening
1151 * that occurs after initialization. It this case dpif_close() would
1152 * never be called. */
1154 dpif_uninit(struct dpif *dpif, bool close)
1156 char *base_name = dpif->base_name;
1157 char *full_name = dpif->full_name;
1160 dpif->dpif_class->close(dpif);
1168 log_operation(const struct dpif *dpif, const char *operation, int error)
1171 VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation);
1172 } else if (is_errno(error)) {
1173 VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1174 dpif_name(dpif), operation, strerror(error));
1176 VLOG_WARN_RL(&error_rl, "%s: %s failed (%d/%d)",
1177 dpif_name(dpif), operation,
1178 get_ofp_err_type(error), get_ofp_err_code(error));
1182 static enum vlog_level
1183 flow_message_log_level(int error)
1185 return error ? VLL_WARN : VLL_DBG;
1189 should_log_flow_message(int error)
1191 return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error),
1192 error ? &error_rl : &dpmsg_rl);
1196 log_flow_message(const struct dpif *dpif, int error, const char *operation,
1197 const struct nlattr *key, size_t key_len,
1198 const struct dpif_flow_stats *stats,
1199 const struct nlattr *actions, size_t actions_len)
1201 struct ds ds = DS_EMPTY_INITIALIZER;
1202 ds_put_format(&ds, "%s: ", dpif_name(dpif));
1204 ds_put_cstr(&ds, "failed to ");
1206 ds_put_format(&ds, "%s ", operation);
1208 ds_put_format(&ds, "(%s) ", strerror(error));
1210 odp_flow_key_format(key, key_len, &ds);
1212 ds_put_cstr(&ds, ", ");
1213 dpif_flow_stats_format(stats, &ds);
1215 if (actions || actions_len) {
1216 ds_put_cstr(&ds, ", actions:");
1217 format_odp_actions(&ds, actions, actions_len);
1219 vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds));