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"
44 VLOG_DEFINE_THIS_MODULE(dpif);
46 COVERAGE_DEFINE(dpif_destroy);
47 COVERAGE_DEFINE(dpif_port_add);
48 COVERAGE_DEFINE(dpif_port_del);
49 COVERAGE_DEFINE(dpif_flow_flush);
50 COVERAGE_DEFINE(dpif_flow_get);
51 COVERAGE_DEFINE(dpif_flow_put);
52 COVERAGE_DEFINE(dpif_flow_del);
53 COVERAGE_DEFINE(dpif_flow_query_list);
54 COVERAGE_DEFINE(dpif_flow_query_list_n);
55 COVERAGE_DEFINE(dpif_execute);
56 COVERAGE_DEFINE(dpif_purge);
58 static const struct dpif_class *base_dpif_classes[] = {
65 struct registered_dpif_class {
66 const struct dpif_class *dpif_class;
69 static struct shash dpif_classes = SHASH_INITIALIZER(&dpif_classes);
71 /* Rate limit for individual messages going to or from the datapath, output at
72 * DBG level. This is very high because, if these are enabled, it is because
73 * we really need to see them. */
74 static struct vlog_rate_limit dpmsg_rl = VLOG_RATE_LIMIT_INIT(600, 600);
76 /* Not really much point in logging many dpif errors. */
77 static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(60, 5);
79 static void log_flow_message(const struct dpif *dpif, int error,
80 const char *operation,
81 const struct nlattr *key, size_t key_len,
82 const struct odp_flow_stats *stats,
83 const struct nlattr *actions, size_t actions_len);
84 static void log_operation(const struct dpif *, const char *operation,
86 static bool should_log_flow_message(int error);
91 static int status = -1;
97 for (i = 0; i < ARRAY_SIZE(base_dpif_classes); i++) {
98 dp_register_provider(base_dpif_classes[i]);
103 /* Performs periodic work needed by all the various kinds of dpifs.
105 * If your program opens any dpifs, it must call both this function and
106 * netdev_run() within its main poll loop. */
110 struct shash_node *node;
111 SHASH_FOR_EACH(node, &dpif_classes) {
112 const struct registered_dpif_class *registered_class = node->data;
113 if (registered_class->dpif_class->run) {
114 registered_class->dpif_class->run();
119 /* Arranges for poll_block() to wake up when dp_run() needs to be called.
121 * If your program opens any dpifs, it must call both this function and
122 * netdev_wait() within its main poll loop. */
126 struct shash_node *node;
127 SHASH_FOR_EACH(node, &dpif_classes) {
128 const struct registered_dpif_class *registered_class = node->data;
129 if (registered_class->dpif_class->wait) {
130 registered_class->dpif_class->wait();
135 /* Registers a new datapath provider. After successful registration, new
136 * datapaths of that type can be opened using dpif_open(). */
138 dp_register_provider(const struct dpif_class *new_class)
140 struct registered_dpif_class *registered_class;
142 if (shash_find(&dpif_classes, new_class->type)) {
143 VLOG_WARN("attempted to register duplicate datapath provider: %s",
148 registered_class = xmalloc(sizeof *registered_class);
149 registered_class->dpif_class = new_class;
150 registered_class->refcount = 0;
152 shash_add(&dpif_classes, new_class->type, registered_class);
157 /* Unregisters a datapath provider. 'type' must have been previously
158 * registered and not currently be in use by any dpifs. After unregistration
159 * new datapaths of that type cannot be opened using dpif_open(). */
161 dp_unregister_provider(const char *type)
163 struct shash_node *node;
164 struct registered_dpif_class *registered_class;
166 node = shash_find(&dpif_classes, type);
168 VLOG_WARN("attempted to unregister a datapath provider that is not "
169 "registered: %s", type);
173 registered_class = node->data;
174 if (registered_class->refcount) {
175 VLOG_WARN("attempted to unregister in use datapath provider: %s", type);
179 shash_delete(&dpif_classes, node);
180 free(registered_class);
185 /* Clears 'types' and enumerates the types of all currently registered datapath
186 * providers into it. The caller must first initialize the svec. */
188 dp_enumerate_types(struct svec *types)
190 struct shash_node *node;
195 SHASH_FOR_EACH(node, &dpif_classes) {
196 const struct registered_dpif_class *registered_class = node->data;
197 svec_add(types, registered_class->dpif_class->type);
201 /* Clears 'names' and enumerates the names of all known created datapaths with
202 * the given 'type'. The caller must first initialize the svec. Returns 0 if
203 * successful, otherwise a positive errno value.
205 * Some kinds of datapaths might not be practically enumerable. This is not
206 * considered an error. */
208 dp_enumerate_names(const char *type, struct svec *names)
210 const struct registered_dpif_class *registered_class;
211 const struct dpif_class *dpif_class;
217 registered_class = shash_find_data(&dpif_classes, type);
218 if (!registered_class) {
219 VLOG_WARN("could not enumerate unknown type: %s", type);
223 dpif_class = registered_class->dpif_class;
224 error = dpif_class->enumerate ? dpif_class->enumerate(names) : 0;
227 VLOG_WARN("failed to enumerate %s datapaths: %s", dpif_class->type,
234 /* Parses 'datapath name', which is of the form type@name into its
235 * component pieces. 'name' and 'type' must be freed by the caller. */
237 dp_parse_name(const char *datapath_name_, char **name, char **type)
239 char *datapath_name = xstrdup(datapath_name_);
242 separator = strchr(datapath_name, '@');
245 *type = datapath_name;
246 *name = xstrdup(separator + 1);
248 *name = datapath_name;
254 do_open(const char *name, const char *type, bool create, struct dpif **dpifp)
256 struct dpif *dpif = NULL;
258 struct registered_dpif_class *registered_class;
262 if (!type || *type == '\0') {
266 registered_class = shash_find_data(&dpif_classes, type);
267 if (!registered_class) {
268 VLOG_WARN("could not create datapath %s of unknown type %s", name,
270 error = EAFNOSUPPORT;
274 error = registered_class->dpif_class->open(registered_class->dpif_class,
275 name, create, &dpif);
277 assert(dpif->dpif_class == registered_class->dpif_class);
278 registered_class->refcount++;
282 *dpifp = error ? NULL : dpif;
286 /* Tries to open an existing datapath named 'name' and type 'type'. Will fail
287 * if no datapath with 'name' and 'type' exists. 'type' may be either NULL or
288 * the empty string to specify the default system type. Returns 0 if
289 * successful, otherwise a positive errno value. On success stores a pointer
290 * to the datapath in '*dpifp', otherwise a null pointer. */
292 dpif_open(const char *name, const char *type, struct dpif **dpifp)
294 return do_open(name, type, false, dpifp);
297 /* Tries to create and open a new datapath with the given 'name' and 'type'.
298 * 'type' may be either NULL or the empty string to specify the default system
299 * type. Will fail if a datapath with 'name' and 'type' already exists.
300 * Returns 0 if successful, otherwise a positive errno value. On success
301 * stores a pointer to the datapath in '*dpifp', otherwise a null pointer. */
303 dpif_create(const char *name, const char *type, struct dpif **dpifp)
305 return do_open(name, type, true, dpifp);
308 /* Tries to open a datapath with the given 'name' and 'type', creating it if it
309 * does not exist. 'type' may be either NULL or the empty string to specify
310 * the default system type. Returns 0 if successful, otherwise a positive
311 * errno value. On success stores a pointer to the datapath in '*dpifp',
312 * otherwise a null pointer. */
314 dpif_create_and_open(const char *name, const char *type, struct dpif **dpifp)
318 error = dpif_create(name, type, dpifp);
319 if (error == EEXIST || error == EBUSY) {
320 error = dpif_open(name, type, dpifp);
322 VLOG_WARN("datapath %s already exists but cannot be opened: %s",
323 name, strerror(error));
326 VLOG_WARN("failed to create datapath %s: %s", name, strerror(error));
331 /* Closes and frees the connection to 'dpif'. Does not destroy the datapath
332 * itself; call dpif_delete() first, instead, if that is desirable. */
334 dpif_close(struct dpif *dpif)
337 struct registered_dpif_class *registered_class;
339 registered_class = shash_find_data(&dpif_classes,
340 dpif->dpif_class->type);
341 assert(registered_class);
342 assert(registered_class->refcount);
344 registered_class->refcount--;
345 dpif_uninit(dpif, true);
349 /* Returns the name of datapath 'dpif' prefixed with the type
350 * (for use in log messages). */
352 dpif_name(const struct dpif *dpif)
354 return dpif->full_name;
357 /* Returns the name of datapath 'dpif' without the type
358 * (for use in device names). */
360 dpif_base_name(const struct dpif *dpif)
362 return dpif->base_name;
365 /* Enumerates all names that may be used to open 'dpif' into 'all_names'. The
366 * Linux datapath, for example, supports opening a datapath both by number,
367 * e.g. "dp0", and by the name of the datapath's local port. For some
368 * datapaths, this might be an infinite set (e.g. in a file name, slashes may
369 * be duplicated any number of times), in which case only the names most likely
370 * to be used will be enumerated.
372 * The caller must already have initialized 'all_names'. Any existing names in
373 * 'all_names' will not be disturbed. */
375 dpif_get_all_names(const struct dpif *dpif, struct svec *all_names)
377 if (dpif->dpif_class->get_all_names) {
378 int error = dpif->dpif_class->get_all_names(dpif, all_names);
380 VLOG_WARN_RL(&error_rl,
381 "failed to retrieve names for datpath %s: %s",
382 dpif_name(dpif), strerror(error));
386 svec_add(all_names, dpif_base_name(dpif));
392 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
393 * ports. After calling this function, it does not make sense to pass 'dpif'
394 * to any functions other than dpif_name() or dpif_close(). */
396 dpif_delete(struct dpif *dpif)
400 COVERAGE_INC(dpif_destroy);
402 error = dpif->dpif_class->destroy(dpif);
403 log_operation(dpif, "delete", error);
407 /* Retrieves statistics for 'dpif' into 'stats'. Returns 0 if successful,
408 * otherwise a positive errno value. */
410 dpif_get_dp_stats(const struct dpif *dpif, struct odp_stats *stats)
412 int error = dpif->dpif_class->get_stats(dpif, stats);
414 memset(stats, 0, sizeof *stats);
416 log_operation(dpif, "get_stats", error);
420 /* Retrieves the current IP fragment handling policy for 'dpif' into
421 * '*drop_frags': true indicates that fragments are dropped, false indicates
422 * that fragments are treated in the same way as other IP packets (except that
423 * the L4 header cannot be read). Returns 0 if successful, otherwise a
424 * positive errno value. */
426 dpif_get_drop_frags(const struct dpif *dpif, bool *drop_frags)
428 int error = dpif->dpif_class->get_drop_frags(dpif, drop_frags);
432 log_operation(dpif, "get_drop_frags", error);
436 /* Changes 'dpif''s treatment of IP fragments to 'drop_frags', whose meaning is
437 * the same as for the get_drop_frags member function. Returns 0 if
438 * successful, otherwise a positive errno value. */
440 dpif_set_drop_frags(struct dpif *dpif, bool drop_frags)
442 int error = dpif->dpif_class->set_drop_frags(dpif, drop_frags);
443 log_operation(dpif, "set_drop_frags", error);
447 /* Attempts to add 'netdev' as a port on 'dpif'. If successful, returns 0 and
448 * sets '*port_nop' to the new port's port number (if 'port_nop' is non-null).
449 * On failure, returns a positive errno value and sets '*port_nop' to
450 * UINT16_MAX (if 'port_nop' is non-null). */
452 dpif_port_add(struct dpif *dpif, struct netdev *netdev, uint16_t *port_nop)
454 const char *netdev_name = netdev_get_name(netdev);
458 COVERAGE_INC(dpif_port_add);
460 error = dpif->dpif_class->port_add(dpif, netdev, &port_no);
462 VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu16,
463 dpif_name(dpif), netdev_name, port_no);
465 VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s",
466 dpif_name(dpif), netdev_name, strerror(error));
467 port_no = UINT16_MAX;
475 /* Attempts to remove 'dpif''s port number 'port_no'. Returns 0 if successful,
476 * otherwise a positive errno value. */
478 dpif_port_del(struct dpif *dpif, uint16_t port_no)
482 COVERAGE_INC(dpif_port_del);
484 error = dpif->dpif_class->port_del(dpif, port_no);
486 VLOG_DBG_RL(&dpmsg_rl, "%s: port_del(%"PRIu16")",
487 dpif_name(dpif), port_no);
489 log_operation(dpif, "port_del", error);
494 /* Makes a deep copy of 'src' into 'dst'. */
496 dpif_port_clone(struct dpif_port *dst, const struct dpif_port *src)
498 dst->name = xstrdup(src->name);
499 dst->type = xstrdup(src->type);
500 dst->port_no = src->port_no;
503 /* Frees memory allocated to members of 'dpif_port'.
505 * Do not call this function on a dpif_port obtained from
506 * dpif_port_dump_next(): that function retains ownership of the data in the
509 dpif_port_destroy(struct dpif_port *dpif_port)
511 free(dpif_port->name);
512 free(dpif_port->type);
515 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and
516 * initializes '*port' appropriately; on failure, returns a positive errno
519 * The caller owns the data in 'port' and must free it with
520 * dpif_port_destroy() when it is no longer needed. */
522 dpif_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
523 struct dpif_port *port)
525 int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port);
527 VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu16" is device %s",
528 dpif_name(dpif), port_no, port->name);
530 memset(port, 0, sizeof *port);
531 VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu16": %s",
532 dpif_name(dpif), port_no, strerror(error));
537 /* Looks up port named 'devname' in 'dpif'. On success, returns 0 and
538 * initializes '*port' appropriately; on failure, returns a positive errno
541 * The caller owns the data in 'port' and must free it with
542 * dpif_port_destroy() when it is no longer needed. */
544 dpif_port_query_by_name(const struct dpif *dpif, const char *devname,
545 struct dpif_port *port)
547 int error = dpif->dpif_class->port_query_by_name(dpif, devname, port);
549 VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu16,
550 dpif_name(dpif), devname, port->port_no);
552 memset(port, 0, sizeof *port);
554 /* Log level is DBG here because all the current callers are interested
555 * in whether 'dpif' actually has a port 'devname', so that it's not an
556 * issue worth logging if it doesn't. */
557 VLOG_DBG_RL(&error_rl, "%s: failed to query port %s: %s",
558 dpif_name(dpif), devname, strerror(error));
563 /* Returns one greater than the maximum port number accepted in flow
566 dpif_get_max_ports(const struct dpif *dpif)
568 return dpif->dpif_class->get_max_ports(dpif);
571 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and copies
572 * the port's name into the 'name_size' bytes in 'name', ensuring that the
573 * result is null-terminated. On failure, returns a positive errno value and
574 * makes 'name' the empty string. */
576 dpif_port_get_name(struct dpif *dpif, uint16_t port_no,
577 char *name, size_t name_size)
579 struct dpif_port port;
582 assert(name_size > 0);
584 error = dpif_port_query_by_number(dpif, port_no, &port);
586 ovs_strlcpy(name, port.name, name_size);
587 dpif_port_destroy(&port);
594 /* Initializes 'dump' to begin dumping the ports in a dpif.
596 * This function provides no status indication. An error status for the entire
597 * dump operation is provided when it is completed by calling
598 * dpif_port_dump_done().
601 dpif_port_dump_start(struct dpif_port_dump *dump, const struct dpif *dpif)
604 dump->error = dpif->dpif_class->port_dump_start(dpif, &dump->state);
605 log_operation(dpif, "port_dump_start", dump->error);
608 /* Attempts to retrieve another port from 'dump', which must have been
609 * initialized with dpif_port_dump_start(). On success, stores a new dpif_port
610 * into 'port' and returns true. On failure, returns false.
612 * Failure might indicate an actual error or merely that the last port has been
613 * dumped. An error status for the entire dump operation is provided when it
614 * is completed by calling dpif_port_dump_done().
616 * The dpif owns the data stored in 'port'. It will remain valid until at
617 * least the next time 'dump' is passed to dpif_port_dump_next() or
618 * dpif_port_dump_done(). */
620 dpif_port_dump_next(struct dpif_port_dump *dump, struct dpif_port *port)
622 const struct dpif *dpif = dump->dpif;
628 dump->error = dpif->dpif_class->port_dump_next(dpif, dump->state, port);
629 if (dump->error == EOF) {
630 VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all ports", dpif_name(dpif));
632 log_operation(dpif, "port_dump_next", dump->error);
636 dpif->dpif_class->port_dump_done(dpif, dump->state);
642 /* Completes port table dump operation 'dump', which must have been initialized
643 * with dpif_port_dump_start(). Returns 0 if the dump operation was
644 * error-free, otherwise a positive errno value describing the problem. */
646 dpif_port_dump_done(struct dpif_port_dump *dump)
648 const struct dpif *dpif = dump->dpif;
650 dump->error = dpif->dpif_class->port_dump_done(dpif, dump->state);
651 log_operation(dpif, "port_dump_done", dump->error);
653 return dump->error == EOF ? 0 : dump->error;
656 /* Polls for changes in the set of ports in 'dpif'. If the set of ports in
657 * 'dpif' has changed, this function does one of the following:
659 * - Stores the name of the device that was added to or deleted from 'dpif' in
660 * '*devnamep' and returns 0. The caller is responsible for freeing
661 * '*devnamep' (with free()) when it no longer needs it.
663 * - Returns ENOBUFS and sets '*devnamep' to NULL.
665 * This function may also return 'false positives', where it returns 0 and
666 * '*devnamep' names a device that was not actually added or deleted or it
667 * returns ENOBUFS without any change.
669 * Returns EAGAIN if the set of ports in 'dpif' has not changed. May also
670 * return other positive errno values to indicate that something has gone
673 dpif_port_poll(const struct dpif *dpif, char **devnamep)
675 int error = dpif->dpif_class->port_poll(dpif, devnamep);
682 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
683 * value other than EAGAIN. */
685 dpif_port_poll_wait(const struct dpif *dpif)
687 dpif->dpif_class->port_poll_wait(dpif);
690 /* Deletes all flows from 'dpif'. Returns 0 if successful, otherwise a
691 * positive errno value. */
693 dpif_flow_flush(struct dpif *dpif)
697 COVERAGE_INC(dpif_flow_flush);
699 error = dpif->dpif_class->flow_flush(dpif);
700 log_operation(dpif, "flow_flush", error);
704 /* Queries 'dpif' for a flow entry. The flow is specified by the Netlink
705 * attributes with types ODP_KEY_ATTR_* in the 'key_len' bytes starting at
708 * Returns 0 if successful. If no flow matches, returns ENOENT. On other
709 * failure, returns a positive errno value.
711 * If 'actionsp' is nonnull, then on success '*actionsp' will be set to an
712 * ofpbuf owned by the caller that contains the Netlink attributes for the
713 * flow's actions. The caller must free the ofpbuf (with ofpbuf_delete()) when
714 * it is no longer needed.
716 * If 'stats' is nonnull, then on success it will be updated with the flow's
719 dpif_flow_get(const struct dpif *dpif, int flags,
720 const struct nlattr *key, size_t key_len,
721 struct ofpbuf **actionsp, struct odp_flow_stats *stats)
725 COVERAGE_INC(dpif_flow_get);
727 error = dpif->dpif_class->flow_get(dpif, flags, key, key_len, actionsp,
734 memset(stats, 0, sizeof *stats);
737 if (should_log_flow_message(error)) {
738 const struct nlattr *actions;
741 if (!error && actionsp) {
742 actions = (*actionsp)->data;
743 actions_len = (*actionsp)->size;
748 log_flow_message(dpif, error, "flow_get", key, key_len, stats,
749 actions, actions_len);
754 /* Adds or modifies a flow in 'dpif'. The flow is specified by the Netlink
755 * attributes with types ODP_KEY_ATTR_* in the 'key_len' bytes starting at
756 * 'key'. The associated actions are specified by the Netlink attributes with
757 * types ODPAT_* in the 'actions_len' bytes starting at 'actions'.
759 * - If the flow's key does not exist in 'dpif', then the flow will be added if
760 * 'flags' includes ODPPF_CREATE. Otherwise the operation will fail with
763 * If the operation succeeds, then 'stats', if nonnull, will be zeroed.
765 * - If the flow's key does exist in 'dpif', then the flow's actions will be
766 * updated if 'flags' includes ODPPF_MODIFY. Otherwise the operation will
767 * fail with EEXIST. If the flow's actions are updated, then its statistics
768 * will be zeroed if 'flags' includes ODPPF_ZERO_STATS, and left as-is
771 * If the operation succeeds, then 'stats', if nonnull, will be set to the
772 * flow's statistics before the update.
775 dpif_flow_put(struct dpif *dpif, int flags,
776 const struct nlattr *key, size_t key_len,
777 const struct nlattr *actions, size_t actions_len,
778 struct odp_flow_stats *stats)
782 COVERAGE_INC(dpif_flow_put);
784 error = dpif->dpif_class->flow_put(dpif, flags, key, key_len,
785 actions, actions_len, stats);
786 if (error && stats) {
787 memset(stats, 0, sizeof *stats);
789 if (should_log_flow_message(error)) {
790 enum { ODPPF_ALL = ODPPF_CREATE | ODPPF_MODIFY | ODPPF_ZERO_STATS };
794 ds_put_cstr(&s, "put");
795 if (flags & ODPPF_CREATE) {
796 ds_put_cstr(&s, "[create]");
798 if (flags & ODPPF_MODIFY) {
799 ds_put_cstr(&s, "[modify]");
801 if (flags & ODPPF_ZERO_STATS) {
802 ds_put_cstr(&s, "[zero]");
804 if (flags & ~ODPPF_ALL) {
805 ds_put_format(&s, "[%x]", flags & ~ODPPF_ALL);
807 log_flow_message(dpif, error, ds_cstr(&s), key, key_len, stats,
808 actions, actions_len);
814 /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif' does
815 * not contain such a flow. The flow is specified by the Netlink attributes
816 * with types ODP_KEY_ATTR_* in the 'key_len' bytes starting at 'key'.
818 * If the operation succeeds, then 'stats', if nonnull, will be set to the
819 * flow's statistics before its deletion. */
821 dpif_flow_del(struct dpif *dpif,
822 const struct nlattr *key, size_t key_len,
823 struct odp_flow_stats *stats)
827 COVERAGE_INC(dpif_flow_del);
829 error = dpif->dpif_class->flow_del(dpif, key, key_len, stats);
830 if (error && stats) {
831 memset(stats, 0, sizeof *stats);
833 if (should_log_flow_message(error)) {
834 log_flow_message(dpif, error, "flow_del", key, key_len,
835 !error ? stats : NULL, NULL, 0);
840 /* Initializes 'dump' to begin dumping the flows in a dpif.
842 * This function provides no status indication. An error status for the entire
843 * dump operation is provided when it is completed by calling
844 * dpif_flow_dump_done().
847 dpif_flow_dump_start(struct dpif_flow_dump *dump, const struct dpif *dpif)
850 dump->error = dpif->dpif_class->flow_dump_start(dpif, &dump->state);
851 log_operation(dpif, "flow_dump_start", dump->error);
854 /* Attempts to retrieve another flow from 'dump', which must have been
855 * initialized with dpif_flow_dump_start(). On success, updates the output
856 * parameters as described below and returns true. Otherwise, returns false.
857 * Failure might indicate an actual error or merely the end of the flow table.
858 * An error status for the entire dump operation is provided when it is
859 * completed by calling dpif_flow_dump_done().
861 * On success, if 'key' and 'key_len' are nonnull then '*key' and '*key_len'
862 * will be set to Netlink attributes with types ODP_KEY_ATTR_* representing the
863 * dumped flow's key. If 'actions' and 'actions_len' are nonnull then they are
864 * set to Netlink attributes with types ODPAT_* representing the dumped flow's
865 * actions. If 'stats' is nonnull then it will be set to the dumped flow's
868 * All of the returned data is owned by 'dpif', not by the caller, and the
869 * caller must not modify or free it. 'dpif' guarantees that it remains
870 * accessible and unchanging until at least the next call to 'flow_dump_next'
871 * or 'flow_dump_done' for 'dump'. */
873 dpif_flow_dump_next(struct dpif_flow_dump *dump,
874 const struct nlattr **key, size_t *key_len,
875 const struct nlattr **actions, size_t *actions_len,
876 const struct odp_flow_stats **stats)
878 const struct dpif *dpif = dump->dpif;
879 int error = dump->error;
882 error = dpif->dpif_class->flow_dump_next(dpif, dump->state,
884 actions, actions_len,
887 dpif->dpif_class->flow_dump_done(dpif, dump->state);
905 VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all flows", dpif_name(dpif));
906 } else if (should_log_flow_message(error)) {
907 log_flow_message(dpif, error, "flow_dump",
908 key ? *key : NULL, key ? *key_len : 0,
909 stats ? *stats : NULL, actions ? *actions : NULL,
910 actions ? *actions_len : 0);
917 /* Completes flow table dump operation 'dump', which must have been initialized
918 * with dpif_flow_dump_start(). Returns 0 if the dump operation was
919 * error-free, otherwise a positive errno value describing the problem. */
921 dpif_flow_dump_done(struct dpif_flow_dump *dump)
923 const struct dpif *dpif = dump->dpif;
925 dump->error = dpif->dpif_class->flow_dump_done(dpif, dump->state);
926 log_operation(dpif, "flow_dump_done", dump->error);
928 return dump->error == EOF ? 0 : dump->error;
931 /* Causes 'dpif' to perform the 'actions_len' bytes of actions in 'actions' on
932 * the Ethernet frame specified in 'packet'.
934 * Returns 0 if successful, otherwise a positive errno value. */
936 dpif_execute(struct dpif *dpif,
937 const struct nlattr *actions, size_t actions_len,
938 const struct ofpbuf *buf)
942 COVERAGE_INC(dpif_execute);
943 if (actions_len > 0) {
944 error = dpif->dpif_class->execute(dpif, actions, actions_len, buf);
949 if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) {
950 struct ds ds = DS_EMPTY_INITIALIZER;
951 char *packet = ofp_packet_to_string(buf->data, buf->size, buf->size);
952 ds_put_format(&ds, "%s: execute ", dpif_name(dpif));
953 format_odp_actions(&ds, actions, actions_len);
955 ds_put_format(&ds, " failed (%s)", strerror(error));
957 ds_put_format(&ds, " on packet %s", packet);
958 vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));
965 /* Retrieves 'dpif''s "listen mask" into '*listen_mask'. Each ODPL_* bit set
966 * in '*listen_mask' indicates that dpif_recv() will receive messages of that
967 * type. Returns 0 if successful, otherwise a positive errno value. */
969 dpif_recv_get_mask(const struct dpif *dpif, int *listen_mask)
971 int error = dpif->dpif_class->recv_get_mask(dpif, listen_mask);
975 log_operation(dpif, "recv_get_mask", error);
979 /* Sets 'dpif''s "listen mask" to 'listen_mask'. Each ODPL_* bit set in
980 * '*listen_mask' requests that dpif_recv() receive messages of that type.
981 * Returns 0 if successful, otherwise a positive errno value. */
983 dpif_recv_set_mask(struct dpif *dpif, int listen_mask)
985 int error = dpif->dpif_class->recv_set_mask(dpif, listen_mask);
986 log_operation(dpif, "recv_set_mask", error);
990 /* Retrieve the sFlow sampling probability. '*probability' is expressed as the
991 * number of packets out of UINT_MAX to sample, e.g. probability/UINT_MAX is
992 * the probability of sampling a given packet.
994 * Returns 0 if successful, otherwise a positive errno value. EOPNOTSUPP
995 * indicates that 'dpif' does not support sFlow sampling. */
997 dpif_get_sflow_probability(const struct dpif *dpif, uint32_t *probability)
999 int error = (dpif->dpif_class->get_sflow_probability
1000 ? dpif->dpif_class->get_sflow_probability(dpif, probability)
1005 log_operation(dpif, "get_sflow_probability", error);
1009 /* Set the sFlow sampling probability. 'probability' is expressed as the
1010 * number of packets out of UINT_MAX to sample, e.g. probability/UINT_MAX is
1011 * the probability of sampling a given packet.
1013 * Returns 0 if successful, otherwise a positive errno value. EOPNOTSUPP
1014 * indicates that 'dpif' does not support sFlow sampling. */
1016 dpif_set_sflow_probability(struct dpif *dpif, uint32_t probability)
1018 int error = (dpif->dpif_class->set_sflow_probability
1019 ? dpif->dpif_class->set_sflow_probability(dpif, probability)
1021 log_operation(dpif, "set_sflow_probability", error);
1025 /* Polls for an upcall from 'dpif'. If successful, stores the upcall into
1026 * '*upcall'. Only upcalls of the types selected with the set_listen_mask
1027 * member function will ordinarily be received (but if a message type is
1028 * enabled and then later disabled, some stragglers might pop up).
1030 * The caller takes ownership of the data that 'upcall' points to.
1031 * 'upcall->key' and 'upcall->actions' (if nonnull) point into data owned by
1032 * 'upcall->packet', so their memory cannot be freed separately. (This is
1033 * hardly a great way to do things but it works out OK for the dpif providers
1034 * and clients that exist so far.)
1036 * Returns 0 if successful, otherwise a positive errno value. Returns EAGAIN
1037 * if no upcall is immediately available. */
1039 dpif_recv(struct dpif *dpif, struct dpif_upcall *upcall)
1041 int error = dpif->dpif_class->recv(dpif, upcall);
1042 if (!error && !VLOG_DROP_DBG(&dpmsg_rl)) {
1046 s = ofp_packet_to_string(upcall->packet->data,
1047 upcall->packet->size, upcall->packet->size);
1048 odp_flow_key_to_flow(upcall->key, upcall->key_len, &flow);
1050 VLOG_DBG("%s: %s upcall on port %"PRIu16": %s", dpif_name(dpif),
1051 (upcall->type == _ODPL_MISS_NR ? "miss"
1052 : upcall->type == _ODPL_ACTION_NR ? "action"
1053 : upcall->type == _ODPL_SFLOW_NR ? "sFlow"
1061 /* Discards all messages that would otherwise be received by dpif_recv() on
1064 dpif_recv_purge(struct dpif *dpif)
1066 COVERAGE_INC(dpif_purge);
1067 if (dpif->dpif_class->recv_purge) {
1068 dpif->dpif_class->recv_purge(dpif);
1072 /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be
1073 * received with dpif_recv(). */
1075 dpif_recv_wait(struct dpif *dpif)
1077 dpif->dpif_class->recv_wait(dpif);
1080 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1081 * and '*engine_id', respectively. */
1083 dpif_get_netflow_ids(const struct dpif *dpif,
1084 uint8_t *engine_type, uint8_t *engine_id)
1086 *engine_type = dpif->netflow_engine_type;
1087 *engine_id = dpif->netflow_engine_id;
1090 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1091 * value for use in the ODPAT_SET_PRIORITY action. On success, returns 0 and
1092 * stores the priority into '*priority'. On failure, returns a positive errno
1093 * value and stores 0 into '*priority'. */
1095 dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id,
1098 int error = (dpif->dpif_class->queue_to_priority
1099 ? dpif->dpif_class->queue_to_priority(dpif, queue_id,
1105 log_operation(dpif, "queue_to_priority", error);
1110 dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class,
1112 uint8_t netflow_engine_type, uint8_t netflow_engine_id)
1114 dpif->dpif_class = dpif_class;
1115 dpif->base_name = xstrdup(name);
1116 dpif->full_name = xasprintf("%s@%s", dpif_class->type, name);
1117 dpif->netflow_engine_type = netflow_engine_type;
1118 dpif->netflow_engine_id = netflow_engine_id;
1121 /* Undoes the results of initialization.
1123 * Normally this function only needs to be called from dpif_close().
1124 * However, it may be called by providers due to an error on opening
1125 * that occurs after initialization. It this case dpif_close() would
1126 * never be called. */
1128 dpif_uninit(struct dpif *dpif, bool close)
1130 char *base_name = dpif->base_name;
1131 char *full_name = dpif->full_name;
1134 dpif->dpif_class->close(dpif);
1142 log_operation(const struct dpif *dpif, const char *operation, int error)
1145 VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation);
1146 } else if (is_errno(error)) {
1147 VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1148 dpif_name(dpif), operation, strerror(error));
1150 VLOG_WARN_RL(&error_rl, "%s: %s failed (%d/%d)",
1151 dpif_name(dpif), operation,
1152 get_ofp_err_type(error), get_ofp_err_code(error));
1156 static enum vlog_level
1157 flow_message_log_level(int error)
1159 return error ? VLL_WARN : VLL_DBG;
1163 should_log_flow_message(int error)
1165 return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error),
1166 error ? &error_rl : &dpmsg_rl);
1170 log_flow_message(const struct dpif *dpif, int error, const char *operation,
1171 const struct nlattr *key, size_t key_len,
1172 const struct odp_flow_stats *stats,
1173 const struct nlattr *actions, size_t actions_len)
1175 struct ds ds = DS_EMPTY_INITIALIZER;
1176 ds_put_format(&ds, "%s: ", dpif_name(dpif));
1178 ds_put_cstr(&ds, "failed to ");
1180 ds_put_format(&ds, "%s ", operation);
1182 ds_put_format(&ds, "(%s) ", strerror(error));
1184 odp_flow_key_format(key, key_len, &ds);
1186 ds_put_cstr(&ds, ", ");
1187 format_odp_flow_stats(&ds, stats);
1189 if (actions || actions_len) {
1190 ds_put_cstr(&ds, ", actions:");
1191 format_odp_actions(&ds, actions, actions_len);
1193 vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds));