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 /* Registers a new datapath provider. After successful registration, new
105 * datapaths of that type can be opened using dpif_open(). */
107 dp_register_provider(const struct dpif_class *new_class)
109 struct registered_dpif_class *registered_class;
111 if (shash_find(&dpif_classes, new_class->type)) {
112 VLOG_WARN("attempted to register duplicate datapath provider: %s",
117 registered_class = xmalloc(sizeof *registered_class);
118 registered_class->dpif_class = new_class;
119 registered_class->refcount = 0;
121 shash_add(&dpif_classes, new_class->type, registered_class);
126 /* Unregisters a datapath provider. 'type' must have been previously
127 * registered and not currently be in use by any dpifs. After unregistration
128 * new datapaths of that type cannot be opened using dpif_open(). */
130 dp_unregister_provider(const char *type)
132 struct shash_node *node;
133 struct registered_dpif_class *registered_class;
135 node = shash_find(&dpif_classes, type);
137 VLOG_WARN("attempted to unregister a datapath provider that is not "
138 "registered: %s", type);
142 registered_class = node->data;
143 if (registered_class->refcount) {
144 VLOG_WARN("attempted to unregister in use datapath provider: %s", type);
148 shash_delete(&dpif_classes, node);
149 free(registered_class);
154 /* Clears 'types' and enumerates the types of all currently registered datapath
155 * providers into it. The caller must first initialize the sset. */
157 dp_enumerate_types(struct sset *types)
159 struct shash_node *node;
164 SHASH_FOR_EACH(node, &dpif_classes) {
165 const struct registered_dpif_class *registered_class = node->data;
166 sset_add(types, registered_class->dpif_class->type);
170 /* Clears 'names' and enumerates the names of all known created datapaths with
171 * the given 'type'. The caller must first initialize the sset. Returns 0 if
172 * successful, otherwise a positive errno value.
174 * Some kinds of datapaths might not be practically enumerable. This is not
175 * considered an error. */
177 dp_enumerate_names(const char *type, struct sset *names)
179 const struct registered_dpif_class *registered_class;
180 const struct dpif_class *dpif_class;
186 registered_class = shash_find_data(&dpif_classes, type);
187 if (!registered_class) {
188 VLOG_WARN("could not enumerate unknown type: %s", type);
192 dpif_class = registered_class->dpif_class;
193 error = dpif_class->enumerate ? dpif_class->enumerate(names) : 0;
196 VLOG_WARN("failed to enumerate %s datapaths: %s", dpif_class->type,
203 /* Parses 'datapath_name_', which is of the form [type@]name into its
204 * component pieces. 'name' and 'type' must be freed by the caller.
206 * The returned 'type' is normalized, as if by dpif_normalize_type(). */
208 dp_parse_name(const char *datapath_name_, char **name, char **type)
210 char *datapath_name = xstrdup(datapath_name_);
213 separator = strchr(datapath_name, '@');
216 *type = datapath_name;
217 *name = xstrdup(dpif_normalize_type(separator + 1));
219 *name = datapath_name;
220 *type = xstrdup(dpif_normalize_type(NULL));
225 do_open(const char *name, const char *type, bool create, struct dpif **dpifp)
227 struct dpif *dpif = NULL;
229 struct registered_dpif_class *registered_class;
233 type = dpif_normalize_type(type);
235 registered_class = shash_find_data(&dpif_classes, type);
236 if (!registered_class) {
237 VLOG_WARN("could not create datapath %s of unknown type %s", name,
239 error = EAFNOSUPPORT;
243 error = registered_class->dpif_class->open(registered_class->dpif_class,
244 name, create, &dpif);
246 assert(dpif->dpif_class == registered_class->dpif_class);
247 registered_class->refcount++;
251 *dpifp = error ? NULL : dpif;
255 /* Tries to open an existing datapath named 'name' and type 'type'. Will fail
256 * if no datapath with 'name' and 'type' exists. 'type' may be either NULL or
257 * the empty string to specify the default system type. Returns 0 if
258 * successful, otherwise a positive errno value. On success stores a pointer
259 * to the datapath in '*dpifp', otherwise a null pointer. */
261 dpif_open(const char *name, const char *type, struct dpif **dpifp)
263 return do_open(name, type, false, dpifp);
266 /* Tries to create and open a new datapath with the given 'name' and 'type'.
267 * 'type' may be either NULL or the empty string to specify the default system
268 * type. Will fail if a datapath with 'name' and 'type' already exists.
269 * Returns 0 if successful, otherwise a positive errno value. On success
270 * stores a pointer to the datapath in '*dpifp', otherwise a null pointer. */
272 dpif_create(const char *name, const char *type, struct dpif **dpifp)
274 return do_open(name, type, true, dpifp);
277 /* Tries to open a datapath with the given 'name' and 'type', creating it if it
278 * does not exist. 'type' may be either NULL or the empty string to specify
279 * the default system type. Returns 0 if successful, otherwise a positive
280 * errno value. On success stores a pointer to the datapath in '*dpifp',
281 * otherwise a null pointer. */
283 dpif_create_and_open(const char *name, const char *type, struct dpif **dpifp)
287 error = dpif_create(name, type, dpifp);
288 if (error == EEXIST || error == EBUSY) {
289 error = dpif_open(name, type, dpifp);
291 VLOG_WARN("datapath %s already exists but cannot be opened: %s",
292 name, strerror(error));
295 VLOG_WARN("failed to create datapath %s: %s", name, strerror(error));
300 /* Closes and frees the connection to 'dpif'. Does not destroy the datapath
301 * itself; call dpif_delete() first, instead, if that is desirable. */
303 dpif_close(struct dpif *dpif)
306 struct registered_dpif_class *registered_class;
308 registered_class = shash_find_data(&dpif_classes,
309 dpif->dpif_class->type);
310 assert(registered_class);
311 assert(registered_class->refcount);
313 registered_class->refcount--;
314 dpif_uninit(dpif, true);
318 /* Performs periodic work needed by 'dpif'. */
320 dpif_run(struct dpif *dpif)
322 if (dpif->dpif_class->run) {
323 dpif->dpif_class->run(dpif);
327 /* Arranges for poll_block() to wake up when dp_run() needs to be called for
330 dpif_wait(struct dpif *dpif)
332 if (dpif->dpif_class->wait) {
333 dpif->dpif_class->wait(dpif);
337 /* Returns the name of datapath 'dpif' prefixed with the type
338 * (for use in log messages). */
340 dpif_name(const struct dpif *dpif)
342 return dpif->full_name;
345 /* Returns the name of datapath 'dpif' without the type
346 * (for use in device names). */
348 dpif_base_name(const struct dpif *dpif)
350 return dpif->base_name;
353 /* Returns the fully spelled out name for the given datapath 'type'.
355 * Normalized type string can be compared with strcmp(). Unnormalized type
356 * string might be the same even if they have different spellings. */
358 dpif_normalize_type(const char *type)
360 return type && type[0] ? type : "system";
363 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
364 * ports. After calling this function, it does not make sense to pass 'dpif'
365 * to any functions other than dpif_name() or dpif_close(). */
367 dpif_delete(struct dpif *dpif)
371 COVERAGE_INC(dpif_destroy);
373 error = dpif->dpif_class->destroy(dpif);
374 log_operation(dpif, "delete", error);
378 /* Retrieves statistics for 'dpif' into 'stats'. Returns 0 if successful,
379 * otherwise a positive errno value. */
381 dpif_get_dp_stats(const struct dpif *dpif, struct ovs_dp_stats *stats)
383 int error = dpif->dpif_class->get_stats(dpif, stats);
385 memset(stats, 0, sizeof *stats);
387 log_operation(dpif, "get_stats", error);
391 /* Retrieves the current IP fragment handling policy for 'dpif' into
392 * '*drop_frags': true indicates that fragments are dropped, false indicates
393 * that fragments are treated in the same way as other IP packets (except that
394 * the L4 header cannot be read). Returns 0 if successful, otherwise a
395 * positive errno value. */
397 dpif_get_drop_frags(const struct dpif *dpif, bool *drop_frags)
399 int error = dpif->dpif_class->get_drop_frags(dpif, drop_frags);
403 log_operation(dpif, "get_drop_frags", error);
407 /* Changes 'dpif''s treatment of IP fragments to 'drop_frags', whose meaning is
408 * the same as for the get_drop_frags member function. Returns 0 if
409 * successful, otherwise a positive errno value. */
411 dpif_set_drop_frags(struct dpif *dpif, bool drop_frags)
413 int error = dpif->dpif_class->set_drop_frags(dpif, drop_frags);
414 log_operation(dpif, "set_drop_frags", error);
418 /* Attempts to add 'netdev' as a port on 'dpif'. If successful, returns 0 and
419 * sets '*port_nop' to the new port's port number (if 'port_nop' is non-null).
420 * On failure, returns a positive errno value and sets '*port_nop' to
421 * UINT16_MAX (if 'port_nop' is non-null). */
423 dpif_port_add(struct dpif *dpif, struct netdev *netdev, uint16_t *port_nop)
425 const char *netdev_name = netdev_get_name(netdev);
429 COVERAGE_INC(dpif_port_add);
431 error = dpif->dpif_class->port_add(dpif, netdev, &port_no);
433 VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu16,
434 dpif_name(dpif), netdev_name, port_no);
436 VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s",
437 dpif_name(dpif), netdev_name, strerror(error));
438 port_no = UINT16_MAX;
446 /* Attempts to remove 'dpif''s port number 'port_no'. Returns 0 if successful,
447 * otherwise a positive errno value. */
449 dpif_port_del(struct dpif *dpif, uint16_t port_no)
453 COVERAGE_INC(dpif_port_del);
455 error = dpif->dpif_class->port_del(dpif, port_no);
457 VLOG_DBG_RL(&dpmsg_rl, "%s: port_del(%"PRIu16")",
458 dpif_name(dpif), port_no);
460 log_operation(dpif, "port_del", error);
465 /* Makes a deep copy of 'src' into 'dst'. */
467 dpif_port_clone(struct dpif_port *dst, const struct dpif_port *src)
469 dst->name = xstrdup(src->name);
470 dst->type = xstrdup(src->type);
471 dst->port_no = src->port_no;
474 /* Frees memory allocated to members of 'dpif_port'.
476 * Do not call this function on a dpif_port obtained from
477 * dpif_port_dump_next(): that function retains ownership of the data in the
480 dpif_port_destroy(struct dpif_port *dpif_port)
482 free(dpif_port->name);
483 free(dpif_port->type);
486 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and
487 * initializes '*port' appropriately; on failure, returns a positive errno
490 * The caller owns the data in 'port' and must free it with
491 * dpif_port_destroy() when it is no longer needed. */
493 dpif_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
494 struct dpif_port *port)
496 int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port);
498 VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu16" is device %s",
499 dpif_name(dpif), port_no, port->name);
501 memset(port, 0, sizeof *port);
502 VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu16": %s",
503 dpif_name(dpif), port_no, strerror(error));
508 /* Looks up port named 'devname' in 'dpif'. On success, returns 0 and
509 * initializes '*port' appropriately; on failure, returns a positive errno
512 * The caller owns the data in 'port' and must free it with
513 * dpif_port_destroy() when it is no longer needed. */
515 dpif_port_query_by_name(const struct dpif *dpif, const char *devname,
516 struct dpif_port *port)
518 int error = dpif->dpif_class->port_query_by_name(dpif, devname, port);
520 VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu16,
521 dpif_name(dpif), devname, port->port_no);
523 memset(port, 0, sizeof *port);
525 /* For ENOENT or ENODEV we use DBG level because the caller is probably
526 * interested in whether 'dpif' actually has a port 'devname', so that
527 * it's not an issue worth logging if it doesn't. Other errors are
528 * uncommon and more likely to indicate a real problem. */
530 error == ENOENT || error == ENODEV ? VLL_DBG : VLL_WARN,
531 "%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 OVS_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 OVS_KEY_ATTR_* in the 'key_len' bytes starting at
743 * 'key'. The associated actions are specified by the Netlink attributes with
744 * types OVS_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 OVS_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 OVS_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 OVS_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' taken from the flow specified in
917 * the 'key_len' bytes of 'key'. ('key' is mostly redundant with 'packet', but
918 * it contains some metadata that cannot be recovered from 'packet', such as
919 * tun_id and in_port.)
921 * Returns 0 if successful, otherwise a positive errno value. */
923 dpif_execute(struct dpif *dpif,
924 const struct nlattr *key, size_t key_len,
925 const struct nlattr *actions, size_t actions_len,
926 const struct ofpbuf *buf)
930 COVERAGE_INC(dpif_execute);
931 if (actions_len > 0) {
932 error = dpif->dpif_class->execute(dpif, key, key_len,
933 actions, actions_len, buf);
938 if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) {
939 struct ds ds = DS_EMPTY_INITIALIZER;
940 char *packet = ofp_packet_to_string(buf->data, buf->size, buf->size);
941 ds_put_format(&ds, "%s: execute ", dpif_name(dpif));
942 format_odp_actions(&ds, actions, actions_len);
944 ds_put_format(&ds, " failed (%s)", strerror(error));
946 ds_put_format(&ds, " on packet %s", packet);
947 vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));
954 /* Returns a string that represents 'type', for use in log messages. */
956 dpif_upcall_type_to_string(enum dpif_upcall_type type)
959 case DPIF_UC_MISS: return "miss";
960 case DPIF_UC_ACTION: return "action";
961 case DPIF_N_UC_TYPES: default: return "<unknown>";
965 static bool OVS_UNUSED
966 is_valid_listen_mask(int listen_mask)
968 return !(listen_mask & ~((1u << DPIF_UC_MISS) |
969 (1u << DPIF_UC_ACTION)));
972 /* Retrieves 'dpif''s "listen mask" into '*listen_mask'. A 1-bit of value 2**X
973 * set in '*listen_mask' indicates that dpif_recv() will receive messages of
974 * the type (from "enum dpif_upcall_type") with value X. Returns 0 if
975 * successful, otherwise a positive errno value. */
977 dpif_recv_get_mask(const struct dpif *dpif, int *listen_mask)
979 int error = dpif->dpif_class->recv_get_mask(dpif, listen_mask);
983 assert(is_valid_listen_mask(*listen_mask));
984 log_operation(dpif, "recv_get_mask", error);
988 /* Sets 'dpif''s "listen mask" to 'listen_mask'. A 1-bit of value 2**X set in
989 * '*listen_mask' requests that dpif_recv() will receive messages of the type
990 * (from "enum dpif_upcall_type") with value X. Returns 0 if successful,
991 * otherwise a positive errno value. */
993 dpif_recv_set_mask(struct dpif *dpif, int listen_mask)
997 assert(is_valid_listen_mask(listen_mask));
999 error = dpif->dpif_class->recv_set_mask(dpif, listen_mask);
1000 log_operation(dpif, "recv_set_mask", error);
1004 /* Polls for an upcall from 'dpif'. If successful, stores the upcall into
1005 * '*upcall'. Only upcalls of the types selected with dpif_recv_set_mask()
1006 * member function will ordinarily be received (but if a message type is
1007 * enabled and then later disabled, some stragglers might pop up).
1009 * The caller takes ownership of the data that 'upcall' points to.
1010 * 'upcall->key' and 'upcall->actions' (if nonnull) point into data owned by
1011 * 'upcall->packet', so their memory cannot be freed separately. (This is
1012 * hardly a great way to do things but it works out OK for the dpif providers
1013 * and clients that exist so far.)
1015 * Returns 0 if successful, otherwise a positive errno value. Returns EAGAIN
1016 * if no upcall is immediately available. */
1018 dpif_recv(struct dpif *dpif, struct dpif_upcall *upcall)
1020 int error = dpif->dpif_class->recv(dpif, upcall);
1021 if (!error && !VLOG_DROP_DBG(&dpmsg_rl)) {
1025 packet = ofp_packet_to_string(upcall->packet->data,
1026 upcall->packet->size,
1027 upcall->packet->size);
1030 odp_flow_key_format(upcall->key, upcall->key_len, &flow);
1032 VLOG_DBG("%s: %s upcall:\n%s\n%s",
1033 dpif_name(dpif), dpif_upcall_type_to_string(upcall->type),
1034 ds_cstr(&flow), packet);
1042 /* Discards all messages that would otherwise be received by dpif_recv() on
1045 dpif_recv_purge(struct dpif *dpif)
1047 COVERAGE_INC(dpif_purge);
1048 if (dpif->dpif_class->recv_purge) {
1049 dpif->dpif_class->recv_purge(dpif);
1053 /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be
1054 * received with dpif_recv(). */
1056 dpif_recv_wait(struct dpif *dpif)
1058 dpif->dpif_class->recv_wait(dpif);
1061 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1062 * and '*engine_id', respectively. */
1064 dpif_get_netflow_ids(const struct dpif *dpif,
1065 uint8_t *engine_type, uint8_t *engine_id)
1067 *engine_type = dpif->netflow_engine_type;
1068 *engine_id = dpif->netflow_engine_id;
1071 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1072 * value for use in the OVS_ACTION_ATTR_SET_PRIORITY action. On success,
1073 * returns 0 and stores the priority into '*priority'. On failure, returns a
1074 * positive errno value and stores 0 into '*priority'. */
1076 dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id,
1079 int error = (dpif->dpif_class->queue_to_priority
1080 ? dpif->dpif_class->queue_to_priority(dpif, queue_id,
1086 log_operation(dpif, "queue_to_priority", error);
1091 dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class,
1093 uint8_t netflow_engine_type, uint8_t netflow_engine_id)
1095 dpif->dpif_class = dpif_class;
1096 dpif->base_name = xstrdup(name);
1097 dpif->full_name = xasprintf("%s@%s", dpif_class->type, name);
1098 dpif->netflow_engine_type = netflow_engine_type;
1099 dpif->netflow_engine_id = netflow_engine_id;
1102 /* Undoes the results of initialization.
1104 * Normally this function only needs to be called from dpif_close().
1105 * However, it may be called by providers due to an error on opening
1106 * that occurs after initialization. It this case dpif_close() would
1107 * never be called. */
1109 dpif_uninit(struct dpif *dpif, bool close)
1111 char *base_name = dpif->base_name;
1112 char *full_name = dpif->full_name;
1115 dpif->dpif_class->close(dpif);
1123 log_operation(const struct dpif *dpif, const char *operation, int error)
1126 VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation);
1127 } else if (is_errno(error)) {
1128 VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1129 dpif_name(dpif), operation, strerror(error));
1131 VLOG_WARN_RL(&error_rl, "%s: %s failed (%d/%d)",
1132 dpif_name(dpif), operation,
1133 get_ofp_err_type(error), get_ofp_err_code(error));
1137 static enum vlog_level
1138 flow_message_log_level(int error)
1140 return error ? VLL_WARN : VLL_DBG;
1144 should_log_flow_message(int error)
1146 return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error),
1147 error ? &error_rl : &dpmsg_rl);
1151 log_flow_message(const struct dpif *dpif, int error, const char *operation,
1152 const struct nlattr *key, size_t key_len,
1153 const struct dpif_flow_stats *stats,
1154 const struct nlattr *actions, size_t actions_len)
1156 struct ds ds = DS_EMPTY_INITIALIZER;
1157 ds_put_format(&ds, "%s: ", dpif_name(dpif));
1159 ds_put_cstr(&ds, "failed to ");
1161 ds_put_format(&ds, "%s ", operation);
1163 ds_put_format(&ds, "(%s) ", strerror(error));
1165 odp_flow_key_format(key, key_len, &ds);
1167 ds_put_cstr(&ds, ", ");
1168 dpif_flow_stats_format(stats, &ds);
1170 if (actions || actions_len) {
1171 ds_put_cstr(&ds, ", actions:");
1172 format_odp_actions(&ds, actions, actions_len);
1174 vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds));