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 sset. */
189 dp_enumerate_types(struct sset *types)
191 struct shash_node *node;
196 SHASH_FOR_EACH(node, &dpif_classes) {
197 const struct registered_dpif_class *registered_class = node->data;
198 sset_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 sset. 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 sset *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 type = dpif_normalize_type(type);
265 registered_class = shash_find_data(&dpif_classes, type);
266 if (!registered_class) {
267 VLOG_WARN("could not create datapath %s of unknown type %s", name,
269 error = EAFNOSUPPORT;
273 error = registered_class->dpif_class->open(registered_class->dpif_class,
274 name, create, &dpif);
276 assert(dpif->dpif_class == registered_class->dpif_class);
277 registered_class->refcount++;
281 *dpifp = error ? NULL : dpif;
285 /* Tries to open an existing datapath named 'name' and type 'type'. Will fail
286 * if no datapath with 'name' and 'type' exists. 'type' may be either NULL or
287 * the empty string to specify the default system type. Returns 0 if
288 * successful, otherwise a positive errno value. On success stores a pointer
289 * to the datapath in '*dpifp', otherwise a null pointer. */
291 dpif_open(const char *name, const char *type, struct dpif **dpifp)
293 return do_open(name, type, false, dpifp);
296 /* Tries to create and open a new datapath with the given 'name' and 'type'.
297 * 'type' may be either NULL or the empty string to specify the default system
298 * type. Will fail if a datapath with 'name' and 'type' already exists.
299 * Returns 0 if successful, otherwise a positive errno value. On success
300 * stores a pointer to the datapath in '*dpifp', otherwise a null pointer. */
302 dpif_create(const char *name, const char *type, struct dpif **dpifp)
304 return do_open(name, type, true, dpifp);
307 /* Tries to open a datapath with the given 'name' and 'type', creating it if it
308 * does not exist. 'type' may be either NULL or the empty string to specify
309 * the default system type. Returns 0 if successful, otherwise a positive
310 * errno value. On success stores a pointer to the datapath in '*dpifp',
311 * otherwise a null pointer. */
313 dpif_create_and_open(const char *name, const char *type, struct dpif **dpifp)
317 error = dpif_create(name, type, dpifp);
318 if (error == EEXIST || error == EBUSY) {
319 error = dpif_open(name, type, dpifp);
321 VLOG_WARN("datapath %s already exists but cannot be opened: %s",
322 name, strerror(error));
325 VLOG_WARN("failed to create datapath %s: %s", name, strerror(error));
330 /* Closes and frees the connection to 'dpif'. Does not destroy the datapath
331 * itself; call dpif_delete() first, instead, if that is desirable. */
333 dpif_close(struct dpif *dpif)
336 struct registered_dpif_class *registered_class;
338 registered_class = shash_find_data(&dpif_classes,
339 dpif->dpif_class->type);
340 assert(registered_class);
341 assert(registered_class->refcount);
343 registered_class->refcount--;
344 dpif_uninit(dpif, true);
348 /* Returns the name of datapath 'dpif' prefixed with the type
349 * (for use in log messages). */
351 dpif_name(const struct dpif *dpif)
353 return dpif->full_name;
356 /* Returns the name of datapath 'dpif' without the type
357 * (for use in device names). */
359 dpif_base_name(const struct dpif *dpif)
361 return dpif->base_name;
364 /* Returns the fully spelled out name for the given datapath 'type'.
366 * Normalized type string can be compared with strcmp(). Unnormalized type
367 * string might be the same even if they have different spellings. */
369 dpif_normalize_type(const char *type)
371 return type && type[0] ? type : "system";
374 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
375 * ports. After calling this function, it does not make sense to pass 'dpif'
376 * to any functions other than dpif_name() or dpif_close(). */
378 dpif_delete(struct dpif *dpif)
382 COVERAGE_INC(dpif_destroy);
384 error = dpif->dpif_class->destroy(dpif);
385 log_operation(dpif, "delete", error);
389 /* Retrieves statistics for 'dpif' into 'stats'. Returns 0 if successful,
390 * otherwise a positive errno value. */
392 dpif_get_dp_stats(const struct dpif *dpif, struct odp_stats *stats)
394 int error = dpif->dpif_class->get_stats(dpif, stats);
396 memset(stats, 0, sizeof *stats);
398 log_operation(dpif, "get_stats", error);
402 /* Retrieves the current IP fragment handling policy for 'dpif' into
403 * '*drop_frags': true indicates that fragments are dropped, false indicates
404 * that fragments are treated in the same way as other IP packets (except that
405 * the L4 header cannot be read). Returns 0 if successful, otherwise a
406 * positive errno value. */
408 dpif_get_drop_frags(const struct dpif *dpif, bool *drop_frags)
410 int error = dpif->dpif_class->get_drop_frags(dpif, drop_frags);
414 log_operation(dpif, "get_drop_frags", error);
418 /* Changes 'dpif''s treatment of IP fragments to 'drop_frags', whose meaning is
419 * the same as for the get_drop_frags member function. Returns 0 if
420 * successful, otherwise a positive errno value. */
422 dpif_set_drop_frags(struct dpif *dpif, bool drop_frags)
424 int error = dpif->dpif_class->set_drop_frags(dpif, drop_frags);
425 log_operation(dpif, "set_drop_frags", error);
429 /* Attempts to add 'netdev' as a port on 'dpif'. If successful, returns 0 and
430 * sets '*port_nop' to the new port's port number (if 'port_nop' is non-null).
431 * On failure, returns a positive errno value and sets '*port_nop' to
432 * UINT16_MAX (if 'port_nop' is non-null). */
434 dpif_port_add(struct dpif *dpif, struct netdev *netdev, uint16_t *port_nop)
436 const char *netdev_name = netdev_get_name(netdev);
440 COVERAGE_INC(dpif_port_add);
442 error = dpif->dpif_class->port_add(dpif, netdev, &port_no);
444 VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu16,
445 dpif_name(dpif), netdev_name, port_no);
447 VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s",
448 dpif_name(dpif), netdev_name, strerror(error));
449 port_no = UINT16_MAX;
457 /* Attempts to remove 'dpif''s port number 'port_no'. Returns 0 if successful,
458 * otherwise a positive errno value. */
460 dpif_port_del(struct dpif *dpif, uint16_t port_no)
464 COVERAGE_INC(dpif_port_del);
466 error = dpif->dpif_class->port_del(dpif, port_no);
468 VLOG_DBG_RL(&dpmsg_rl, "%s: port_del(%"PRIu16")",
469 dpif_name(dpif), port_no);
471 log_operation(dpif, "port_del", error);
476 /* Makes a deep copy of 'src' into 'dst'. */
478 dpif_port_clone(struct dpif_port *dst, const struct dpif_port *src)
480 dst->name = xstrdup(src->name);
481 dst->type = xstrdup(src->type);
482 dst->port_no = src->port_no;
485 /* Frees memory allocated to members of 'dpif_port'.
487 * Do not call this function on a dpif_port obtained from
488 * dpif_port_dump_next(): that function retains ownership of the data in the
491 dpif_port_destroy(struct dpif_port *dpif_port)
493 free(dpif_port->name);
494 free(dpif_port->type);
497 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and
498 * initializes '*port' appropriately; on failure, returns a positive errno
501 * The caller owns the data in 'port' and must free it with
502 * dpif_port_destroy() when it is no longer needed. */
504 dpif_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
505 struct dpif_port *port)
507 int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port);
509 VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu16" is device %s",
510 dpif_name(dpif), port_no, port->name);
512 memset(port, 0, sizeof *port);
513 VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu16": %s",
514 dpif_name(dpif), port_no, strerror(error));
519 /* Looks up port named 'devname' in 'dpif'. On success, returns 0 and
520 * initializes '*port' appropriately; on failure, returns a positive errno
523 * The caller owns the data in 'port' and must free it with
524 * dpif_port_destroy() when it is no longer needed. */
526 dpif_port_query_by_name(const struct dpif *dpif, const char *devname,
527 struct dpif_port *port)
529 int error = dpif->dpif_class->port_query_by_name(dpif, devname, port);
531 VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu16,
532 dpif_name(dpif), devname, port->port_no);
534 memset(port, 0, sizeof *port);
536 /* Log level is DBG here because all the current callers are interested
537 * in whether 'dpif' actually has a port 'devname', so that it's not an
538 * issue worth logging if it doesn't. */
539 VLOG_DBG_RL(&error_rl, "%s: failed to query port %s: %s",
540 dpif_name(dpif), devname, strerror(error));
545 /* Returns one greater than the maximum port number accepted in flow
548 dpif_get_max_ports(const struct dpif *dpif)
550 return dpif->dpif_class->get_max_ports(dpif);
553 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and copies
554 * the port's name into the 'name_size' bytes in 'name', ensuring that the
555 * result is null-terminated. On failure, returns a positive errno value and
556 * makes 'name' the empty string. */
558 dpif_port_get_name(struct dpif *dpif, uint16_t port_no,
559 char *name, size_t name_size)
561 struct dpif_port port;
564 assert(name_size > 0);
566 error = dpif_port_query_by_number(dpif, port_no, &port);
568 ovs_strlcpy(name, port.name, name_size);
569 dpif_port_destroy(&port);
576 /* Initializes 'dump' to begin dumping the ports in a dpif.
578 * This function provides no status indication. An error status for the entire
579 * dump operation is provided when it is completed by calling
580 * dpif_port_dump_done().
583 dpif_port_dump_start(struct dpif_port_dump *dump, const struct dpif *dpif)
586 dump->error = dpif->dpif_class->port_dump_start(dpif, &dump->state);
587 log_operation(dpif, "port_dump_start", dump->error);
590 /* Attempts to retrieve another port from 'dump', which must have been
591 * initialized with dpif_port_dump_start(). On success, stores a new dpif_port
592 * into 'port' and returns true. On failure, returns false.
594 * Failure might indicate an actual error or merely that the last port has been
595 * dumped. An error status for the entire dump operation is provided when it
596 * is completed by calling dpif_port_dump_done().
598 * The dpif owns the data stored in 'port'. It will remain valid until at
599 * least the next time 'dump' is passed to dpif_port_dump_next() or
600 * dpif_port_dump_done(). */
602 dpif_port_dump_next(struct dpif_port_dump *dump, struct dpif_port *port)
604 const struct dpif *dpif = dump->dpif;
610 dump->error = dpif->dpif_class->port_dump_next(dpif, dump->state, port);
611 if (dump->error == EOF) {
612 VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all ports", dpif_name(dpif));
614 log_operation(dpif, "port_dump_next", dump->error);
618 dpif->dpif_class->port_dump_done(dpif, dump->state);
624 /* Completes port table dump operation 'dump', which must have been initialized
625 * with dpif_port_dump_start(). Returns 0 if the dump operation was
626 * error-free, otherwise a positive errno value describing the problem. */
628 dpif_port_dump_done(struct dpif_port_dump *dump)
630 const struct dpif *dpif = dump->dpif;
632 dump->error = dpif->dpif_class->port_dump_done(dpif, dump->state);
633 log_operation(dpif, "port_dump_done", dump->error);
635 return dump->error == EOF ? 0 : dump->error;
638 /* Polls for changes in the set of ports in 'dpif'. If the set of ports in
639 * 'dpif' has changed, this function does one of the following:
641 * - Stores the name of the device that was added to or deleted from 'dpif' in
642 * '*devnamep' and returns 0. The caller is responsible for freeing
643 * '*devnamep' (with free()) when it no longer needs it.
645 * - Returns ENOBUFS and sets '*devnamep' to NULL.
647 * This function may also return 'false positives', where it returns 0 and
648 * '*devnamep' names a device that was not actually added or deleted or it
649 * returns ENOBUFS without any change.
651 * Returns EAGAIN if the set of ports in 'dpif' has not changed. May also
652 * return other positive errno values to indicate that something has gone
655 dpif_port_poll(const struct dpif *dpif, char **devnamep)
657 int error = dpif->dpif_class->port_poll(dpif, devnamep);
664 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
665 * value other than EAGAIN. */
667 dpif_port_poll_wait(const struct dpif *dpif)
669 dpif->dpif_class->port_poll_wait(dpif);
672 /* Appends a human-readable representation of 'stats' to 's'. */
674 dpif_flow_stats_format(const struct dpif_flow_stats *stats, struct ds *s)
676 ds_put_format(s, "packets:%"PRIu64", bytes:%"PRIu64", used:",
677 stats->n_packets, stats->n_bytes);
679 ds_put_format(s, "%.3fs", (time_msec() - stats->used) / 1000.0);
681 ds_put_format(s, "never");
686 /* Deletes all flows from 'dpif'. Returns 0 if successful, otherwise a
687 * positive errno value. */
689 dpif_flow_flush(struct dpif *dpif)
693 COVERAGE_INC(dpif_flow_flush);
695 error = dpif->dpif_class->flow_flush(dpif);
696 log_operation(dpif, "flow_flush", error);
700 /* Queries 'dpif' for a flow entry. The flow is specified by the Netlink
701 * attributes with types ODP_KEY_ATTR_* in the 'key_len' bytes starting at
704 * Returns 0 if successful. If no flow matches, returns ENOENT. On other
705 * failure, returns a positive errno value.
707 * If 'actionsp' is nonnull, then on success '*actionsp' will be set to an
708 * ofpbuf owned by the caller that contains the Netlink attributes for the
709 * flow's actions. The caller must free the ofpbuf (with ofpbuf_delete()) when
710 * it is no longer needed.
712 * If 'stats' is nonnull, then on success it will be updated with the flow's
715 dpif_flow_get(const struct dpif *dpif,
716 const struct nlattr *key, size_t key_len,
717 struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
721 COVERAGE_INC(dpif_flow_get);
723 error = dpif->dpif_class->flow_get(dpif, key, key_len, actionsp, stats);
729 memset(stats, 0, sizeof *stats);
732 if (should_log_flow_message(error)) {
733 const struct nlattr *actions;
736 if (!error && actionsp) {
737 actions = (*actionsp)->data;
738 actions_len = (*actionsp)->size;
743 log_flow_message(dpif, error, "flow_get", key, key_len, stats,
744 actions, actions_len);
749 /* Adds or modifies a flow in 'dpif'. The flow is specified by the Netlink
750 * attributes with types ODP_KEY_ATTR_* in the 'key_len' bytes starting at
751 * 'key'. The associated actions are specified by the Netlink attributes with
752 * types ODP_ACTION_ATTR_* in the 'actions_len' bytes starting at 'actions'.
754 * - If the flow's key does not exist in 'dpif', then the flow will be added if
755 * 'flags' includes DPIF_FP_CREATE. Otherwise the operation will fail with
758 * If the operation succeeds, then 'stats', if nonnull, will be zeroed.
760 * - If the flow's key does exist in 'dpif', then the flow's actions will be
761 * updated if 'flags' includes DPIF_FP_MODIFY. Otherwise the operation will
762 * fail with EEXIST. If the flow's actions are updated, then its statistics
763 * will be zeroed if 'flags' includes DPIF_FP_ZERO_STATS, and left as-is
766 * If the operation succeeds, then 'stats', if nonnull, will be set to the
767 * flow's statistics before the update.
770 dpif_flow_put(struct dpif *dpif, enum dpif_flow_put_flags flags,
771 const struct nlattr *key, size_t key_len,
772 const struct nlattr *actions, size_t actions_len,
773 struct dpif_flow_stats *stats)
777 COVERAGE_INC(dpif_flow_put);
778 assert(!(flags & ~(DPIF_FP_CREATE | DPIF_FP_MODIFY | DPIF_FP_ZERO_STATS)));
780 error = dpif->dpif_class->flow_put(dpif, flags, key, key_len,
781 actions, actions_len, stats);
782 if (error && stats) {
783 memset(stats, 0, sizeof *stats);
785 if (should_log_flow_message(error)) {
789 ds_put_cstr(&s, "put");
790 if (flags & DPIF_FP_CREATE) {
791 ds_put_cstr(&s, "[create]");
793 if (flags & DPIF_FP_MODIFY) {
794 ds_put_cstr(&s, "[modify]");
796 if (flags & DPIF_FP_ZERO_STATS) {
797 ds_put_cstr(&s, "[zero]");
799 log_flow_message(dpif, error, ds_cstr(&s), key, key_len, stats,
800 actions, actions_len);
806 /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif' does
807 * not contain such a flow. The flow is specified by the Netlink attributes
808 * with types ODP_KEY_ATTR_* in the 'key_len' bytes starting at 'key'.
810 * If the operation succeeds, then 'stats', if nonnull, will be set to the
811 * flow's statistics before its deletion. */
813 dpif_flow_del(struct dpif *dpif,
814 const struct nlattr *key, size_t key_len,
815 struct dpif_flow_stats *stats)
819 COVERAGE_INC(dpif_flow_del);
821 error = dpif->dpif_class->flow_del(dpif, key, key_len, stats);
822 if (error && stats) {
823 memset(stats, 0, sizeof *stats);
825 if (should_log_flow_message(error)) {
826 log_flow_message(dpif, error, "flow_del", key, key_len,
827 !error ? stats : NULL, NULL, 0);
832 /* Initializes 'dump' to begin dumping the flows in a dpif.
834 * This function provides no status indication. An error status for the entire
835 * dump operation is provided when it is completed by calling
836 * dpif_flow_dump_done().
839 dpif_flow_dump_start(struct dpif_flow_dump *dump, const struct dpif *dpif)
842 dump->error = dpif->dpif_class->flow_dump_start(dpif, &dump->state);
843 log_operation(dpif, "flow_dump_start", dump->error);
846 /* Attempts to retrieve another flow from 'dump', which must have been
847 * initialized with dpif_flow_dump_start(). On success, updates the output
848 * parameters as described below and returns true. Otherwise, returns false.
849 * Failure might indicate an actual error or merely the end of the flow table.
850 * An error status for the entire dump operation is provided when it is
851 * completed by calling dpif_flow_dump_done().
853 * On success, if 'key' and 'key_len' are nonnull then '*key' and '*key_len'
854 * will be set to Netlink attributes with types ODP_KEY_ATTR_* representing the
855 * dumped flow's key. If 'actions' and 'actions_len' are nonnull then they are
856 * set to Netlink attributes with types ODP_ACTION_ATTR_* representing the
857 * dumped flow's actions. If 'stats' is nonnull then it will be set to the
858 * dumped flow's statistics.
860 * All of the returned data is owned by 'dpif', not by the caller, and the
861 * caller must not modify or free it. 'dpif' guarantees that it remains
862 * accessible and unchanging until at least the next call to 'flow_dump_next'
863 * or 'flow_dump_done' for 'dump'. */
865 dpif_flow_dump_next(struct dpif_flow_dump *dump,
866 const struct nlattr **key, size_t *key_len,
867 const struct nlattr **actions, size_t *actions_len,
868 const struct dpif_flow_stats **stats)
870 const struct dpif *dpif = dump->dpif;
871 int error = dump->error;
874 error = dpif->dpif_class->flow_dump_next(dpif, dump->state,
876 actions, actions_len,
879 dpif->dpif_class->flow_dump_done(dpif, dump->state);
897 VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all flows", dpif_name(dpif));
898 } else if (should_log_flow_message(error)) {
899 log_flow_message(dpif, error, "flow_dump",
900 key ? *key : NULL, key ? *key_len : 0,
901 stats ? *stats : NULL, actions ? *actions : NULL,
902 actions ? *actions_len : 0);
909 /* Completes flow table dump operation 'dump', which must have been initialized
910 * with dpif_flow_dump_start(). Returns 0 if the dump operation was
911 * error-free, otherwise a positive errno value describing the problem. */
913 dpif_flow_dump_done(struct dpif_flow_dump *dump)
915 const struct dpif *dpif = dump->dpif;
917 dump->error = dpif->dpif_class->flow_dump_done(dpif, dump->state);
918 log_operation(dpif, "flow_dump_done", dump->error);
920 return dump->error == EOF ? 0 : dump->error;
923 /* Causes 'dpif' to perform the 'actions_len' bytes of actions in 'actions' on
924 * the Ethernet frame specified in 'packet'.
926 * Returns 0 if successful, otherwise a positive errno value. */
928 dpif_execute(struct dpif *dpif,
929 const struct nlattr *actions, size_t actions_len,
930 const struct ofpbuf *buf)
934 COVERAGE_INC(dpif_execute);
935 if (actions_len > 0) {
936 error = dpif->dpif_class->execute(dpif, actions, actions_len, buf);
941 if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) {
942 struct ds ds = DS_EMPTY_INITIALIZER;
943 char *packet = ofp_packet_to_string(buf->data, buf->size, buf->size);
944 ds_put_format(&ds, "%s: execute ", dpif_name(dpif));
945 format_odp_actions(&ds, actions, actions_len);
947 ds_put_format(&ds, " failed (%s)", strerror(error));
949 ds_put_format(&ds, " on packet %s", packet);
950 vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));
957 static bool OVS_UNUSED
958 is_valid_listen_mask(int listen_mask)
960 return !(listen_mask & ~((1u << DPIF_UC_MISS) |
961 (1u << DPIF_UC_ACTION) |
962 (1u << DPIF_UC_SAMPLE)));
965 /* Retrieves 'dpif''s "listen mask" into '*listen_mask'. A 1-bit of value 2**X
966 * set in '*listen_mask' indicates that dpif_recv() will receive messages of
967 * the type (from "enum dpif_upcall_type") with value X. Returns 0 if
968 * successful, otherwise a positive errno value. */
970 dpif_recv_get_mask(const struct dpif *dpif, int *listen_mask)
972 int error = dpif->dpif_class->recv_get_mask(dpif, listen_mask);
976 assert(is_valid_listen_mask(*listen_mask));
977 log_operation(dpif, "recv_get_mask", error);
981 /* Sets 'dpif''s "listen mask" to 'listen_mask'. A 1-bit of value 2**X set in
982 * '*listen_mask' requests that dpif_recv() will receive messages of the type
983 * (from "enum dpif_upcall_type") with value X. Returns 0 if successful,
984 * otherwise a positive errno value. */
986 dpif_recv_set_mask(struct dpif *dpif, int listen_mask)
990 assert(is_valid_listen_mask(listen_mask));
992 error = dpif->dpif_class->recv_set_mask(dpif, listen_mask);
993 log_operation(dpif, "recv_set_mask", error);
997 /* Retrieve the sFlow sampling probability. '*probability' is expressed as the
998 * number of packets out of UINT_MAX to sample, e.g. probability/UINT_MAX is
999 * the probability of sampling a given packet.
1001 * Returns 0 if successful, otherwise a positive errno value. EOPNOTSUPP
1002 * indicates that 'dpif' does not support sFlow sampling. */
1004 dpif_get_sflow_probability(const struct dpif *dpif, uint32_t *probability)
1006 int error = (dpif->dpif_class->get_sflow_probability
1007 ? dpif->dpif_class->get_sflow_probability(dpif, probability)
1012 log_operation(dpif, "get_sflow_probability", error);
1016 /* Set the sFlow sampling probability. 'probability' is expressed as the
1017 * number of packets out of UINT_MAX to sample, e.g. probability/UINT_MAX is
1018 * the probability of sampling a given packet.
1020 * Returns 0 if successful, otherwise a positive errno value. EOPNOTSUPP
1021 * indicates that 'dpif' does not support sFlow sampling. */
1023 dpif_set_sflow_probability(struct dpif *dpif, uint32_t probability)
1025 int error = (dpif->dpif_class->set_sflow_probability
1026 ? dpif->dpif_class->set_sflow_probability(dpif, probability)
1028 log_operation(dpif, "set_sflow_probability", error);
1032 /* Polls for an upcall from 'dpif'. If successful, stores the upcall into
1033 * '*upcall'. Only upcalls of the types selected with dpif_recv_set_mask()
1034 * member function will ordinarily be received (but if a message type is
1035 * enabled and then later disabled, some stragglers might pop up).
1037 * The caller takes ownership of the data that 'upcall' points to.
1038 * 'upcall->key' and 'upcall->actions' (if nonnull) point into data owned by
1039 * 'upcall->packet', so their memory cannot be freed separately. (This is
1040 * hardly a great way to do things but it works out OK for the dpif providers
1041 * and clients that exist so far.)
1043 * Returns 0 if successful, otherwise a positive errno value. Returns EAGAIN
1044 * if no upcall is immediately available. */
1046 dpif_recv(struct dpif *dpif, struct dpif_upcall *upcall)
1048 int error = dpif->dpif_class->recv(dpif, upcall);
1049 if (!error && !VLOG_DROP_DBG(&dpmsg_rl)) {
1053 s = ofp_packet_to_string(upcall->packet->data,
1054 upcall->packet->size, upcall->packet->size);
1055 odp_flow_key_to_flow(upcall->key, upcall->key_len, &flow);
1057 VLOG_DBG("%s: %s upcall on port %"PRIu16": %s", dpif_name(dpif),
1058 (upcall->type == DPIF_UC_MISS ? "miss"
1059 : upcall->type == DPIF_UC_ACTION ? "action"
1060 : upcall->type == DPIF_UC_SAMPLE ? "sample"
1068 /* Discards all messages that would otherwise be received by dpif_recv() on
1071 dpif_recv_purge(struct dpif *dpif)
1073 COVERAGE_INC(dpif_purge);
1074 if (dpif->dpif_class->recv_purge) {
1075 dpif->dpif_class->recv_purge(dpif);
1079 /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be
1080 * received with dpif_recv(). */
1082 dpif_recv_wait(struct dpif *dpif)
1084 dpif->dpif_class->recv_wait(dpif);
1087 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1088 * and '*engine_id', respectively. */
1090 dpif_get_netflow_ids(const struct dpif *dpif,
1091 uint8_t *engine_type, uint8_t *engine_id)
1093 *engine_type = dpif->netflow_engine_type;
1094 *engine_id = dpif->netflow_engine_id;
1097 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1098 * value for use in the ODP_ACTION_ATTR_SET_PRIORITY action. On success,
1099 * returns 0 and stores the priority into '*priority'. On failure, returns a
1100 * positive errno value and stores 0 into '*priority'. */
1102 dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id,
1105 int error = (dpif->dpif_class->queue_to_priority
1106 ? dpif->dpif_class->queue_to_priority(dpif, queue_id,
1112 log_operation(dpif, "queue_to_priority", error);
1117 dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class,
1119 uint8_t netflow_engine_type, uint8_t netflow_engine_id)
1121 dpif->dpif_class = dpif_class;
1122 dpif->base_name = xstrdup(name);
1123 dpif->full_name = xasprintf("%s@%s", dpif_class->type, name);
1124 dpif->netflow_engine_type = netflow_engine_type;
1125 dpif->netflow_engine_id = netflow_engine_id;
1128 /* Undoes the results of initialization.
1130 * Normally this function only needs to be called from dpif_close().
1131 * However, it may be called by providers due to an error on opening
1132 * that occurs after initialization. It this case dpif_close() would
1133 * never be called. */
1135 dpif_uninit(struct dpif *dpif, bool close)
1137 char *base_name = dpif->base_name;
1138 char *full_name = dpif->full_name;
1141 dpif->dpif_class->close(dpif);
1149 log_operation(const struct dpif *dpif, const char *operation, int error)
1152 VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation);
1153 } else if (is_errno(error)) {
1154 VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1155 dpif_name(dpif), operation, strerror(error));
1157 VLOG_WARN_RL(&error_rl, "%s: %s failed (%d/%d)",
1158 dpif_name(dpif), operation,
1159 get_ofp_err_type(error), get_ofp_err_code(error));
1163 static enum vlog_level
1164 flow_message_log_level(int error)
1166 return error ? VLL_WARN : VLL_DBG;
1170 should_log_flow_message(int error)
1172 return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error),
1173 error ? &error_rl : &dpmsg_rl);
1177 log_flow_message(const struct dpif *dpif, int error, const char *operation,
1178 const struct nlattr *key, size_t key_len,
1179 const struct dpif_flow_stats *stats,
1180 const struct nlattr *actions, size_t actions_len)
1182 struct ds ds = DS_EMPTY_INITIALIZER;
1183 ds_put_format(&ds, "%s: ", dpif_name(dpif));
1185 ds_put_cstr(&ds, "failed to ");
1187 ds_put_format(&ds, "%s ", operation);
1189 ds_put_format(&ds, "(%s) ", strerror(error));
1191 odp_flow_key_format(key, key_len, &ds);
1193 ds_put_cstr(&ds, ", ");
1194 dpif_flow_stats_format(stats, &ds);
1196 if (actions || actions_len) {
1197 ds_put_cstr(&ds, ", actions:");
1198 format_odp_actions(&ds, actions, actions_len);
1200 vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds));