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 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
367 * ports. After calling this function, it does not make sense to pass 'dpif'
368 * to any functions other than dpif_name() or dpif_close(). */
370 dpif_delete(struct dpif *dpif)
374 COVERAGE_INC(dpif_destroy);
376 error = dpif->dpif_class->destroy(dpif);
377 log_operation(dpif, "delete", error);
381 /* Retrieves statistics for 'dpif' into 'stats'. Returns 0 if successful,
382 * otherwise a positive errno value. */
384 dpif_get_dp_stats(const struct dpif *dpif, struct odp_stats *stats)
386 int error = dpif->dpif_class->get_stats(dpif, stats);
388 memset(stats, 0, sizeof *stats);
390 log_operation(dpif, "get_stats", error);
394 /* Retrieves the current IP fragment handling policy for 'dpif' into
395 * '*drop_frags': true indicates that fragments are dropped, false indicates
396 * that fragments are treated in the same way as other IP packets (except that
397 * the L4 header cannot be read). Returns 0 if successful, otherwise a
398 * positive errno value. */
400 dpif_get_drop_frags(const struct dpif *dpif, bool *drop_frags)
402 int error = dpif->dpif_class->get_drop_frags(dpif, drop_frags);
406 log_operation(dpif, "get_drop_frags", error);
410 /* Changes 'dpif''s treatment of IP fragments to 'drop_frags', whose meaning is
411 * the same as for the get_drop_frags member function. Returns 0 if
412 * successful, otherwise a positive errno value. */
414 dpif_set_drop_frags(struct dpif *dpif, bool drop_frags)
416 int error = dpif->dpif_class->set_drop_frags(dpif, drop_frags);
417 log_operation(dpif, "set_drop_frags", error);
421 /* Attempts to add 'netdev' as a port on 'dpif'. If successful, returns 0 and
422 * sets '*port_nop' to the new port's port number (if 'port_nop' is non-null).
423 * On failure, returns a positive errno value and sets '*port_nop' to
424 * UINT16_MAX (if 'port_nop' is non-null). */
426 dpif_port_add(struct dpif *dpif, struct netdev *netdev, uint16_t *port_nop)
428 const char *netdev_name = netdev_get_name(netdev);
432 COVERAGE_INC(dpif_port_add);
434 error = dpif->dpif_class->port_add(dpif, netdev, &port_no);
436 VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu16,
437 dpif_name(dpif), netdev_name, port_no);
439 VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s",
440 dpif_name(dpif), netdev_name, strerror(error));
441 port_no = UINT16_MAX;
449 /* Attempts to remove 'dpif''s port number 'port_no'. Returns 0 if successful,
450 * otherwise a positive errno value. */
452 dpif_port_del(struct dpif *dpif, uint16_t port_no)
456 COVERAGE_INC(dpif_port_del);
458 error = dpif->dpif_class->port_del(dpif, port_no);
460 VLOG_DBG_RL(&dpmsg_rl, "%s: port_del(%"PRIu16")",
461 dpif_name(dpif), port_no);
463 log_operation(dpif, "port_del", error);
468 /* Makes a deep copy of 'src' into 'dst'. */
470 dpif_port_clone(struct dpif_port *dst, const struct dpif_port *src)
472 dst->name = xstrdup(src->name);
473 dst->type = xstrdup(src->type);
474 dst->port_no = src->port_no;
477 /* Frees memory allocated to members of 'dpif_port'.
479 * Do not call this function on a dpif_port obtained from
480 * dpif_port_dump_next(): that function retains ownership of the data in the
483 dpif_port_destroy(struct dpif_port *dpif_port)
485 free(dpif_port->name);
486 free(dpif_port->type);
489 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and
490 * initializes '*port' appropriately; on failure, returns a positive errno
493 * The caller owns the data in 'port' and must free it with
494 * dpif_port_destroy() when it is no longer needed. */
496 dpif_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
497 struct dpif_port *port)
499 int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port);
501 VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu16" is device %s",
502 dpif_name(dpif), port_no, port->name);
504 memset(port, 0, sizeof *port);
505 VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu16": %s",
506 dpif_name(dpif), port_no, strerror(error));
511 /* Looks up port named 'devname' in 'dpif'. On success, returns 0 and
512 * initializes '*port' appropriately; on failure, returns a positive errno
515 * The caller owns the data in 'port' and must free it with
516 * dpif_port_destroy() when it is no longer needed. */
518 dpif_port_query_by_name(const struct dpif *dpif, const char *devname,
519 struct dpif_port *port)
521 int error = dpif->dpif_class->port_query_by_name(dpif, devname, port);
523 VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu16,
524 dpif_name(dpif), devname, port->port_no);
526 memset(port, 0, sizeof *port);
528 /* Log level is DBG here because all the current callers are interested
529 * in whether 'dpif' actually has a port 'devname', so that it's not an
530 * issue worth logging if it doesn't. */
531 VLOG_DBG_RL(&error_rl, "%s: failed to query port %s: %s",
532 dpif_name(dpif), devname, strerror(error));
537 /* Returns one greater than the maximum port number accepted in flow
540 dpif_get_max_ports(const struct dpif *dpif)
542 return dpif->dpif_class->get_max_ports(dpif);
545 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and copies
546 * the port's name into the 'name_size' bytes in 'name', ensuring that the
547 * result is null-terminated. On failure, returns a positive errno value and
548 * makes 'name' the empty string. */
550 dpif_port_get_name(struct dpif *dpif, uint16_t port_no,
551 char *name, size_t name_size)
553 struct dpif_port port;
556 assert(name_size > 0);
558 error = dpif_port_query_by_number(dpif, port_no, &port);
560 ovs_strlcpy(name, port.name, name_size);
561 dpif_port_destroy(&port);
568 /* Initializes 'dump' to begin dumping the ports in a dpif.
570 * This function provides no status indication. An error status for the entire
571 * dump operation is provided when it is completed by calling
572 * dpif_port_dump_done().
575 dpif_port_dump_start(struct dpif_port_dump *dump, const struct dpif *dpif)
578 dump->error = dpif->dpif_class->port_dump_start(dpif, &dump->state);
579 log_operation(dpif, "port_dump_start", dump->error);
582 /* Attempts to retrieve another port from 'dump', which must have been
583 * initialized with dpif_port_dump_start(). On success, stores a new dpif_port
584 * into 'port' and returns true. On failure, returns false.
586 * Failure might indicate an actual error or merely that the last port has been
587 * dumped. An error status for the entire dump operation is provided when it
588 * is completed by calling dpif_port_dump_done().
590 * The dpif owns the data stored in 'port'. It will remain valid until at
591 * least the next time 'dump' is passed to dpif_port_dump_next() or
592 * dpif_port_dump_done(). */
594 dpif_port_dump_next(struct dpif_port_dump *dump, struct dpif_port *port)
596 const struct dpif *dpif = dump->dpif;
602 dump->error = dpif->dpif_class->port_dump_next(dpif, dump->state, port);
603 if (dump->error == EOF) {
604 VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all ports", dpif_name(dpif));
606 log_operation(dpif, "port_dump_next", dump->error);
610 dpif->dpif_class->port_dump_done(dpif, dump->state);
616 /* Completes port table dump operation 'dump', which must have been initialized
617 * with dpif_port_dump_start(). Returns 0 if the dump operation was
618 * error-free, otherwise a positive errno value describing the problem. */
620 dpif_port_dump_done(struct dpif_port_dump *dump)
622 const struct dpif *dpif = dump->dpif;
624 dump->error = dpif->dpif_class->port_dump_done(dpif, dump->state);
625 log_operation(dpif, "port_dump_done", dump->error);
627 return dump->error == EOF ? 0 : dump->error;
630 /* Polls for changes in the set of ports in 'dpif'. If the set of ports in
631 * 'dpif' has changed, this function does one of the following:
633 * - Stores the name of the device that was added to or deleted from 'dpif' in
634 * '*devnamep' and returns 0. The caller is responsible for freeing
635 * '*devnamep' (with free()) when it no longer needs it.
637 * - Returns ENOBUFS and sets '*devnamep' to NULL.
639 * This function may also return 'false positives', where it returns 0 and
640 * '*devnamep' names a device that was not actually added or deleted or it
641 * returns ENOBUFS without any change.
643 * Returns EAGAIN if the set of ports in 'dpif' has not changed. May also
644 * return other positive errno values to indicate that something has gone
647 dpif_port_poll(const struct dpif *dpif, char **devnamep)
649 int error = dpif->dpif_class->port_poll(dpif, devnamep);
656 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
657 * value other than EAGAIN. */
659 dpif_port_poll_wait(const struct dpif *dpif)
661 dpif->dpif_class->port_poll_wait(dpif);
664 /* Appends a human-readable representation of 'stats' to 's'. */
666 dpif_flow_stats_format(const struct dpif_flow_stats *stats, struct ds *s)
668 ds_put_format(s, "packets:%"PRIu64", bytes:%"PRIu64", used:",
669 stats->n_packets, stats->n_bytes);
671 ds_put_format(s, "%.3fs", (time_msec() - stats->used) / 1000.0);
673 ds_put_format(s, "never");
678 /* Deletes all flows from 'dpif'. Returns 0 if successful, otherwise a
679 * positive errno value. */
681 dpif_flow_flush(struct dpif *dpif)
685 COVERAGE_INC(dpif_flow_flush);
687 error = dpif->dpif_class->flow_flush(dpif);
688 log_operation(dpif, "flow_flush", error);
692 /* Queries 'dpif' for a flow entry. The flow is specified by the Netlink
693 * attributes with types ODP_KEY_ATTR_* in the 'key_len' bytes starting at
696 * Returns 0 if successful. If no flow matches, returns ENOENT. On other
697 * failure, returns a positive errno value.
699 * If 'actionsp' is nonnull, then on success '*actionsp' will be set to an
700 * ofpbuf owned by the caller that contains the Netlink attributes for the
701 * flow's actions. The caller must free the ofpbuf (with ofpbuf_delete()) when
702 * it is no longer needed.
704 * If 'stats' is nonnull, then on success it will be updated with the flow's
707 dpif_flow_get(const struct dpif *dpif,
708 const struct nlattr *key, size_t key_len,
709 struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
713 COVERAGE_INC(dpif_flow_get);
715 error = dpif->dpif_class->flow_get(dpif, key, key_len, actionsp, stats);
721 memset(stats, 0, sizeof *stats);
724 if (should_log_flow_message(error)) {
725 const struct nlattr *actions;
728 if (!error && actionsp) {
729 actions = (*actionsp)->data;
730 actions_len = (*actionsp)->size;
735 log_flow_message(dpif, error, "flow_get", key, key_len, stats,
736 actions, actions_len);
741 /* Adds or modifies a flow in 'dpif'. The flow is specified by the Netlink
742 * attributes with types ODP_KEY_ATTR_* in the 'key_len' bytes starting at
743 * 'key'. The associated actions are specified by the Netlink attributes with
744 * types ODP_ACTION_ATTR_* in the 'actions_len' bytes starting at 'actions'.
746 * - If the flow's key does not exist in 'dpif', then the flow will be added if
747 * 'flags' includes DPIF_FP_CREATE. Otherwise the operation will fail with
750 * If the operation succeeds, then 'stats', if nonnull, will be zeroed.
752 * - If the flow's key does exist in 'dpif', then the flow's actions will be
753 * updated if 'flags' includes DPIF_FP_MODIFY. Otherwise the operation will
754 * fail with EEXIST. If the flow's actions are updated, then its statistics
755 * will be zeroed if 'flags' includes DPIF_FP_ZERO_STATS, and left as-is
758 * If the operation succeeds, then 'stats', if nonnull, will be set to the
759 * flow's statistics before the update.
762 dpif_flow_put(struct dpif *dpif, enum dpif_flow_put_flags flags,
763 const struct nlattr *key, size_t key_len,
764 const struct nlattr *actions, size_t actions_len,
765 struct dpif_flow_stats *stats)
769 COVERAGE_INC(dpif_flow_put);
770 assert(!(flags & ~(DPIF_FP_CREATE | DPIF_FP_MODIFY | DPIF_FP_ZERO_STATS)));
772 error = dpif->dpif_class->flow_put(dpif, flags, key, key_len,
773 actions, actions_len, stats);
774 if (error && stats) {
775 memset(stats, 0, sizeof *stats);
777 if (should_log_flow_message(error)) {
781 ds_put_cstr(&s, "put");
782 if (flags & DPIF_FP_CREATE) {
783 ds_put_cstr(&s, "[create]");
785 if (flags & DPIF_FP_MODIFY) {
786 ds_put_cstr(&s, "[modify]");
788 if (flags & DPIF_FP_ZERO_STATS) {
789 ds_put_cstr(&s, "[zero]");
791 log_flow_message(dpif, error, ds_cstr(&s), key, key_len, stats,
792 actions, actions_len);
798 /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif' does
799 * not contain such a flow. The flow is specified by the Netlink attributes
800 * with types ODP_KEY_ATTR_* in the 'key_len' bytes starting at 'key'.
802 * If the operation succeeds, then 'stats', if nonnull, will be set to the
803 * flow's statistics before its deletion. */
805 dpif_flow_del(struct dpif *dpif,
806 const struct nlattr *key, size_t key_len,
807 struct dpif_flow_stats *stats)
811 COVERAGE_INC(dpif_flow_del);
813 error = dpif->dpif_class->flow_del(dpif, key, key_len, stats);
814 if (error && stats) {
815 memset(stats, 0, sizeof *stats);
817 if (should_log_flow_message(error)) {
818 log_flow_message(dpif, error, "flow_del", key, key_len,
819 !error ? stats : NULL, NULL, 0);
824 /* Initializes 'dump' to begin dumping the flows in a dpif.
826 * This function provides no status indication. An error status for the entire
827 * dump operation is provided when it is completed by calling
828 * dpif_flow_dump_done().
831 dpif_flow_dump_start(struct dpif_flow_dump *dump, const struct dpif *dpif)
834 dump->error = dpif->dpif_class->flow_dump_start(dpif, &dump->state);
835 log_operation(dpif, "flow_dump_start", dump->error);
838 /* Attempts to retrieve another flow from 'dump', which must have been
839 * initialized with dpif_flow_dump_start(). On success, updates the output
840 * parameters as described below and returns true. Otherwise, returns false.
841 * Failure might indicate an actual error or merely the end of the flow table.
842 * An error status for the entire dump operation is provided when it is
843 * completed by calling dpif_flow_dump_done().
845 * On success, if 'key' and 'key_len' are nonnull then '*key' and '*key_len'
846 * will be set to Netlink attributes with types ODP_KEY_ATTR_* representing the
847 * dumped flow's key. If 'actions' and 'actions_len' are nonnull then they are
848 * set to Netlink attributes with types ODP_ACTION_ATTR_* representing the
849 * dumped flow's actions. If 'stats' is nonnull then it will be set to the
850 * dumped flow's statistics.
852 * All of the returned data is owned by 'dpif', not by the caller, and the
853 * caller must not modify or free it. 'dpif' guarantees that it remains
854 * accessible and unchanging until at least the next call to 'flow_dump_next'
855 * or 'flow_dump_done' for 'dump'. */
857 dpif_flow_dump_next(struct dpif_flow_dump *dump,
858 const struct nlattr **key, size_t *key_len,
859 const struct nlattr **actions, size_t *actions_len,
860 const struct dpif_flow_stats **stats)
862 const struct dpif *dpif = dump->dpif;
863 int error = dump->error;
866 error = dpif->dpif_class->flow_dump_next(dpif, dump->state,
868 actions, actions_len,
871 dpif->dpif_class->flow_dump_done(dpif, dump->state);
889 VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all flows", dpif_name(dpif));
890 } else if (should_log_flow_message(error)) {
891 log_flow_message(dpif, error, "flow_dump",
892 key ? *key : NULL, key ? *key_len : 0,
893 stats ? *stats : NULL, actions ? *actions : NULL,
894 actions ? *actions_len : 0);
901 /* Completes flow table dump operation 'dump', which must have been initialized
902 * with dpif_flow_dump_start(). Returns 0 if the dump operation was
903 * error-free, otherwise a positive errno value describing the problem. */
905 dpif_flow_dump_done(struct dpif_flow_dump *dump)
907 const struct dpif *dpif = dump->dpif;
909 dump->error = dpif->dpif_class->flow_dump_done(dpif, dump->state);
910 log_operation(dpif, "flow_dump_done", dump->error);
912 return dump->error == EOF ? 0 : dump->error;
915 /* Causes 'dpif' to perform the 'actions_len' bytes of actions in 'actions' on
916 * the Ethernet frame specified in 'packet'.
918 * Returns 0 if successful, otherwise a positive errno value. */
920 dpif_execute(struct dpif *dpif,
921 const struct nlattr *actions, size_t actions_len,
922 const struct ofpbuf *buf)
926 COVERAGE_INC(dpif_execute);
927 if (actions_len > 0) {
928 error = dpif->dpif_class->execute(dpif, actions, actions_len, buf);
933 if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) {
934 struct ds ds = DS_EMPTY_INITIALIZER;
935 char *packet = ofp_packet_to_string(buf->data, buf->size, buf->size);
936 ds_put_format(&ds, "%s: execute ", dpif_name(dpif));
937 format_odp_actions(&ds, actions, actions_len);
939 ds_put_format(&ds, " failed (%s)", strerror(error));
941 ds_put_format(&ds, " on packet %s", packet);
942 vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));
949 static bool OVS_UNUSED
950 is_valid_listen_mask(int listen_mask)
952 return !(listen_mask & ~((1u << DPIF_UC_MISS) |
953 (1u << DPIF_UC_ACTION) |
954 (1u << DPIF_UC_SAMPLE)));
957 /* Retrieves 'dpif''s "listen mask" into '*listen_mask'. A 1-bit of value 2**X
958 * set in '*listen_mask' indicates that dpif_recv() will receive messages of
959 * the type (from "enum dpif_upcall_type") with value X. Returns 0 if
960 * successful, otherwise a positive errno value. */
962 dpif_recv_get_mask(const struct dpif *dpif, int *listen_mask)
964 int error = dpif->dpif_class->recv_get_mask(dpif, listen_mask);
968 assert(is_valid_listen_mask(*listen_mask));
969 log_operation(dpif, "recv_get_mask", error);
973 /* Sets 'dpif''s "listen mask" to 'listen_mask'. A 1-bit of value 2**X set in
974 * '*listen_mask' requests that dpif_recv() will receive messages of the type
975 * (from "enum dpif_upcall_type") with value X. Returns 0 if successful,
976 * otherwise a positive errno value. */
978 dpif_recv_set_mask(struct dpif *dpif, int listen_mask)
982 assert(is_valid_listen_mask(listen_mask));
984 error = dpif->dpif_class->recv_set_mask(dpif, listen_mask);
985 log_operation(dpif, "recv_set_mask", error);
989 /* Retrieve the sFlow sampling probability. '*probability' is expressed as the
990 * number of packets out of UINT_MAX to sample, e.g. probability/UINT_MAX is
991 * the probability of sampling a given packet.
993 * Returns 0 if successful, otherwise a positive errno value. EOPNOTSUPP
994 * indicates that 'dpif' does not support sFlow sampling. */
996 dpif_get_sflow_probability(const struct dpif *dpif, uint32_t *probability)
998 int error = (dpif->dpif_class->get_sflow_probability
999 ? dpif->dpif_class->get_sflow_probability(dpif, probability)
1004 log_operation(dpif, "get_sflow_probability", error);
1008 /* Set the sFlow sampling probability. 'probability' is expressed as the
1009 * number of packets out of UINT_MAX to sample, e.g. probability/UINT_MAX is
1010 * the probability of sampling a given packet.
1012 * Returns 0 if successful, otherwise a positive errno value. EOPNOTSUPP
1013 * indicates that 'dpif' does not support sFlow sampling. */
1015 dpif_set_sflow_probability(struct dpif *dpif, uint32_t probability)
1017 int error = (dpif->dpif_class->set_sflow_probability
1018 ? dpif->dpif_class->set_sflow_probability(dpif, probability)
1020 log_operation(dpif, "set_sflow_probability", error);
1024 /* Polls for an upcall from 'dpif'. If successful, stores the upcall into
1025 * '*upcall'. Only upcalls of the types selected with dpif_recv_set_mask()
1026 * member function will ordinarily be received (but if a message type is
1027 * enabled and then later disabled, some stragglers might pop up).
1029 * The caller takes ownership of the data that 'upcall' points to.
1030 * 'upcall->key' and 'upcall->actions' (if nonnull) point into data owned by
1031 * 'upcall->packet', so their memory cannot be freed separately. (This is
1032 * hardly a great way to do things but it works out OK for the dpif providers
1033 * and clients that exist so far.)
1035 * Returns 0 if successful, otherwise a positive errno value. Returns EAGAIN
1036 * if no upcall is immediately available. */
1038 dpif_recv(struct dpif *dpif, struct dpif_upcall *upcall)
1040 int error = dpif->dpif_class->recv(dpif, upcall);
1041 if (!error && !VLOG_DROP_DBG(&dpmsg_rl)) {
1045 s = ofp_packet_to_string(upcall->packet->data,
1046 upcall->packet->size, upcall->packet->size);
1047 odp_flow_key_to_flow(upcall->key, upcall->key_len, &flow);
1049 VLOG_DBG("%s: %s upcall on port %"PRIu16": %s", dpif_name(dpif),
1050 (upcall->type == DPIF_UC_MISS ? "miss"
1051 : upcall->type == DPIF_UC_ACTION ? "action"
1052 : upcall->type == DPIF_UC_SAMPLE ? "sample"
1060 /* Discards all messages that would otherwise be received by dpif_recv() on
1063 dpif_recv_purge(struct dpif *dpif)
1065 COVERAGE_INC(dpif_purge);
1066 if (dpif->dpif_class->recv_purge) {
1067 dpif->dpif_class->recv_purge(dpif);
1071 /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be
1072 * received with dpif_recv(). */
1074 dpif_recv_wait(struct dpif *dpif)
1076 dpif->dpif_class->recv_wait(dpif);
1079 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1080 * and '*engine_id', respectively. */
1082 dpif_get_netflow_ids(const struct dpif *dpif,
1083 uint8_t *engine_type, uint8_t *engine_id)
1085 *engine_type = dpif->netflow_engine_type;
1086 *engine_id = dpif->netflow_engine_id;
1089 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1090 * value for use in the ODP_ACTION_ATTR_SET_PRIORITY action. On success,
1091 * returns 0 and stores the priority into '*priority'. On failure, returns a
1092 * positive errno value and stores 0 into '*priority'. */
1094 dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id,
1097 int error = (dpif->dpif_class->queue_to_priority
1098 ? dpif->dpif_class->queue_to_priority(dpif, queue_id,
1104 log_operation(dpif, "queue_to_priority", error);
1109 dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class,
1111 uint8_t netflow_engine_type, uint8_t netflow_engine_id)
1113 dpif->dpif_class = dpif_class;
1114 dpif->base_name = xstrdup(name);
1115 dpif->full_name = xasprintf("%s@%s", dpif_class->type, name);
1116 dpif->netflow_engine_type = netflow_engine_type;
1117 dpif->netflow_engine_id = netflow_engine_id;
1120 /* Undoes the results of initialization.
1122 * Normally this function only needs to be called from dpif_close().
1123 * However, it may be called by providers due to an error on opening
1124 * that occurs after initialization. It this case dpif_close() would
1125 * never be called. */
1127 dpif_uninit(struct dpif *dpif, bool close)
1129 char *base_name = dpif->base_name;
1130 char *full_name = dpif->full_name;
1133 dpif->dpif_class->close(dpif);
1141 log_operation(const struct dpif *dpif, const char *operation, int error)
1144 VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation);
1145 } else if (is_errno(error)) {
1146 VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1147 dpif_name(dpif), operation, strerror(error));
1149 VLOG_WARN_RL(&error_rl, "%s: %s failed (%d/%d)",
1150 dpif_name(dpif), operation,
1151 get_ofp_err_type(error), get_ofp_err_code(error));
1155 static enum vlog_level
1156 flow_message_log_level(int error)
1158 return error ? VLL_WARN : VLL_DBG;
1162 should_log_flow_message(int error)
1164 return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error),
1165 error ? &error_rl : &dpmsg_rl);
1169 log_flow_message(const struct dpif *dpif, int error, const char *operation,
1170 const struct nlattr *key, size_t key_len,
1171 const struct dpif_flow_stats *stats,
1172 const struct nlattr *actions, size_t actions_len)
1174 struct ds ds = DS_EMPTY_INITIALIZER;
1175 ds_put_format(&ds, "%s: ", dpif_name(dpif));
1177 ds_put_cstr(&ds, "failed to ");
1179 ds_put_format(&ds, "%s ", operation);
1181 ds_put_format(&ds, "(%s) ", strerror(error));
1183 odp_flow_key_format(key, key_len, &ds);
1185 ds_put_cstr(&ds, ", ");
1186 dpif_flow_stats_format(stats, &ds);
1188 if (actions || actions_len) {
1189 ds_put_cstr(&ds, ", actions:");
1190 format_odp_actions(&ds, actions, actions_len);
1192 vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds));