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);
71 static struct sset dpif_blacklist = SSET_INITIALIZER(&dpif_blacklist);
73 /* Rate limit for individual messages going to or from the datapath, output at
74 * DBG level. This is very high because, if these are enabled, it is because
75 * we really need to see them. */
76 static struct vlog_rate_limit dpmsg_rl = VLOG_RATE_LIMIT_INIT(600, 600);
78 /* Not really much point in logging many dpif errors. */
79 static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(60, 5);
81 static void log_flow_message(const struct dpif *dpif, int error,
82 const char *operation,
83 const struct nlattr *key, size_t key_len,
84 const struct dpif_flow_stats *stats,
85 const struct nlattr *actions, size_t actions_len);
86 static void log_operation(const struct dpif *, const char *operation,
88 static bool should_log_flow_message(int error);
93 static int status = -1;
99 for (i = 0; i < ARRAY_SIZE(base_dpif_classes); i++) {
100 dp_register_provider(base_dpif_classes[i]);
105 /* Registers a new datapath provider. After successful registration, new
106 * datapaths of that type can be opened using dpif_open(). */
108 dp_register_provider(const struct dpif_class *new_class)
110 struct registered_dpif_class *registered_class;
112 if (sset_contains(&dpif_blacklist, new_class->type)) {
113 VLOG_DBG("attempted to register blacklisted provider: %s",
118 if (shash_find(&dpif_classes, new_class->type)) {
119 VLOG_WARN("attempted to register duplicate datapath provider: %s",
124 registered_class = xmalloc(sizeof *registered_class);
125 registered_class->dpif_class = new_class;
126 registered_class->refcount = 0;
128 shash_add(&dpif_classes, new_class->type, registered_class);
133 /* Unregisters a datapath provider. 'type' must have been previously
134 * registered and not currently be in use by any dpifs. After unregistration
135 * new datapaths of that type cannot be opened using dpif_open(). */
137 dp_unregister_provider(const char *type)
139 struct shash_node *node;
140 struct registered_dpif_class *registered_class;
142 node = shash_find(&dpif_classes, type);
144 VLOG_WARN("attempted to unregister a datapath provider that is not "
145 "registered: %s", type);
149 registered_class = node->data;
150 if (registered_class->refcount) {
151 VLOG_WARN("attempted to unregister in use datapath provider: %s", type);
155 shash_delete(&dpif_classes, node);
156 free(registered_class);
161 /* Blacklists a provider. Causes future calls of dp_register_provider() with
162 * a dpif_class which implements 'type' to fail. */
164 dp_blacklist_provider(const char *type)
166 sset_add(&dpif_blacklist, type);
169 /* Clears 'types' and enumerates the types of all currently registered datapath
170 * providers into it. The caller must first initialize the sset. */
172 dp_enumerate_types(struct sset *types)
174 struct shash_node *node;
179 SHASH_FOR_EACH(node, &dpif_classes) {
180 const struct registered_dpif_class *registered_class = node->data;
181 sset_add(types, registered_class->dpif_class->type);
185 /* Clears 'names' and enumerates the names of all known created datapaths with
186 * the given 'type'. The caller must first initialize the sset. Returns 0 if
187 * successful, otherwise a positive errno value.
189 * Some kinds of datapaths might not be practically enumerable. This is not
190 * considered an error. */
192 dp_enumerate_names(const char *type, struct sset *names)
194 const struct registered_dpif_class *registered_class;
195 const struct dpif_class *dpif_class;
201 registered_class = shash_find_data(&dpif_classes, type);
202 if (!registered_class) {
203 VLOG_WARN("could not enumerate unknown type: %s", type);
207 dpif_class = registered_class->dpif_class;
208 error = dpif_class->enumerate ? dpif_class->enumerate(names) : 0;
211 VLOG_WARN("failed to enumerate %s datapaths: %s", dpif_class->type,
218 /* Parses 'datapath_name_', which is of the form [type@]name into its
219 * component pieces. 'name' and 'type' must be freed by the caller.
221 * The returned 'type' is normalized, as if by dpif_normalize_type(). */
223 dp_parse_name(const char *datapath_name_, char **name, char **type)
225 char *datapath_name = xstrdup(datapath_name_);
228 separator = strchr(datapath_name, '@');
231 *type = datapath_name;
232 *name = xstrdup(dpif_normalize_type(separator + 1));
234 *name = datapath_name;
235 *type = xstrdup(dpif_normalize_type(NULL));
240 do_open(const char *name, const char *type, bool create, struct dpif **dpifp)
242 struct dpif *dpif = NULL;
244 struct registered_dpif_class *registered_class;
248 type = dpif_normalize_type(type);
250 registered_class = shash_find_data(&dpif_classes, type);
251 if (!registered_class) {
252 VLOG_WARN("could not create datapath %s of unknown type %s", name,
254 error = EAFNOSUPPORT;
258 error = registered_class->dpif_class->open(registered_class->dpif_class,
259 name, create, &dpif);
261 assert(dpif->dpif_class == registered_class->dpif_class);
262 registered_class->refcount++;
266 *dpifp = error ? NULL : dpif;
270 /* Tries to open an existing datapath named 'name' and type 'type'. Will fail
271 * if no datapath with 'name' and 'type' exists. 'type' may be either NULL or
272 * the empty string to specify the default system type. Returns 0 if
273 * successful, otherwise a positive errno value. On success stores a pointer
274 * to the datapath in '*dpifp', otherwise a null pointer. */
276 dpif_open(const char *name, const char *type, struct dpif **dpifp)
278 return do_open(name, type, false, dpifp);
281 /* Tries to create and open a new datapath with the given 'name' and 'type'.
282 * 'type' may be either NULL or the empty string to specify the default system
283 * type. Will fail if a datapath with 'name' and 'type' already exists.
284 * Returns 0 if successful, otherwise a positive errno value. On success
285 * stores a pointer to the datapath in '*dpifp', otherwise a null pointer. */
287 dpif_create(const char *name, const char *type, struct dpif **dpifp)
289 return do_open(name, type, true, dpifp);
292 /* Tries to open a datapath with the given 'name' and 'type', creating it if it
293 * does not exist. 'type' may be either NULL or the empty string to specify
294 * the default system type. Returns 0 if successful, otherwise a positive
295 * errno value. On success stores a pointer to the datapath in '*dpifp',
296 * otherwise a null pointer. */
298 dpif_create_and_open(const char *name, const char *type, struct dpif **dpifp)
302 error = dpif_create(name, type, dpifp);
303 if (error == EEXIST || error == EBUSY) {
304 error = dpif_open(name, type, dpifp);
306 VLOG_WARN("datapath %s already exists but cannot be opened: %s",
307 name, strerror(error));
310 VLOG_WARN("failed to create datapath %s: %s", name, strerror(error));
315 /* Closes and frees the connection to 'dpif'. Does not destroy the datapath
316 * itself; call dpif_delete() first, instead, if that is desirable. */
318 dpif_close(struct dpif *dpif)
321 struct registered_dpif_class *registered_class;
323 registered_class = shash_find_data(&dpif_classes,
324 dpif->dpif_class->type);
325 assert(registered_class);
326 assert(registered_class->refcount);
328 registered_class->refcount--;
329 dpif_uninit(dpif, true);
333 /* Performs periodic work needed by 'dpif'. */
335 dpif_run(struct dpif *dpif)
337 if (dpif->dpif_class->run) {
338 dpif->dpif_class->run(dpif);
342 /* Arranges for poll_block() to wake up when dp_run() needs to be called for
345 dpif_wait(struct dpif *dpif)
347 if (dpif->dpif_class->wait) {
348 dpif->dpif_class->wait(dpif);
352 /* Returns the name of datapath 'dpif' prefixed with the type
353 * (for use in log messages). */
355 dpif_name(const struct dpif *dpif)
357 return dpif->full_name;
360 /* Returns the name of datapath 'dpif' without the type
361 * (for use in device names). */
363 dpif_base_name(const struct dpif *dpif)
365 return dpif->base_name;
368 /* Returns the fully spelled out name for the given datapath 'type'.
370 * Normalized type string can be compared with strcmp(). Unnormalized type
371 * string might be the same even if they have different spellings. */
373 dpif_normalize_type(const char *type)
375 return type && type[0] ? type : "system";
378 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
379 * ports. After calling this function, it does not make sense to pass 'dpif'
380 * to any functions other than dpif_name() or dpif_close(). */
382 dpif_delete(struct dpif *dpif)
386 COVERAGE_INC(dpif_destroy);
388 error = dpif->dpif_class->destroy(dpif);
389 log_operation(dpif, "delete", error);
393 /* Retrieves statistics for 'dpif' into 'stats'. Returns 0 if successful,
394 * otherwise a positive errno value. */
396 dpif_get_dp_stats(const struct dpif *dpif, struct dpif_dp_stats *stats)
398 int error = dpif->dpif_class->get_stats(dpif, stats);
400 memset(stats, 0, sizeof *stats);
402 log_operation(dpif, "get_stats", error);
406 /* Attempts to add 'netdev' as a port on 'dpif'. If successful, returns 0 and
407 * sets '*port_nop' to the new port's port number (if 'port_nop' is non-null).
408 * On failure, returns a positive errno value and sets '*port_nop' to
409 * UINT16_MAX (if 'port_nop' is non-null). */
411 dpif_port_add(struct dpif *dpif, struct netdev *netdev, uint16_t *port_nop)
413 const char *netdev_name = netdev_get_name(netdev);
417 COVERAGE_INC(dpif_port_add);
419 error = dpif->dpif_class->port_add(dpif, netdev, &port_no);
421 VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu16,
422 dpif_name(dpif), netdev_name, port_no);
424 VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s",
425 dpif_name(dpif), netdev_name, strerror(error));
426 port_no = UINT16_MAX;
434 /* Attempts to remove 'dpif''s port number 'port_no'. Returns 0 if successful,
435 * otherwise a positive errno value. */
437 dpif_port_del(struct dpif *dpif, uint16_t port_no)
441 COVERAGE_INC(dpif_port_del);
443 error = dpif->dpif_class->port_del(dpif, port_no);
445 VLOG_DBG_RL(&dpmsg_rl, "%s: port_del(%"PRIu16")",
446 dpif_name(dpif), port_no);
448 log_operation(dpif, "port_del", error);
453 /* Makes a deep copy of 'src' into 'dst'. */
455 dpif_port_clone(struct dpif_port *dst, const struct dpif_port *src)
457 dst->name = xstrdup(src->name);
458 dst->type = xstrdup(src->type);
459 dst->port_no = src->port_no;
462 /* Frees memory allocated to members of 'dpif_port'.
464 * Do not call this function on a dpif_port obtained from
465 * dpif_port_dump_next(): that function retains ownership of the data in the
468 dpif_port_destroy(struct dpif_port *dpif_port)
470 free(dpif_port->name);
471 free(dpif_port->type);
474 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and
475 * initializes '*port' appropriately; on failure, returns a positive errno
478 * The caller owns the data in 'port' and must free it with
479 * dpif_port_destroy() when it is no longer needed. */
481 dpif_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
482 struct dpif_port *port)
484 int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port);
486 VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu16" is device %s",
487 dpif_name(dpif), port_no, port->name);
489 memset(port, 0, sizeof *port);
490 VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu16": %s",
491 dpif_name(dpif), port_no, strerror(error));
496 /* Looks up port named 'devname' in 'dpif'. On success, returns 0 and
497 * initializes '*port' appropriately; on failure, returns a positive errno
500 * The caller owns the data in 'port' and must free it with
501 * dpif_port_destroy() when it is no longer needed. */
503 dpif_port_query_by_name(const struct dpif *dpif, const char *devname,
504 struct dpif_port *port)
506 int error = dpif->dpif_class->port_query_by_name(dpif, devname, port);
508 VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu16,
509 dpif_name(dpif), devname, port->port_no);
511 memset(port, 0, sizeof *port);
513 /* For ENOENT or ENODEV we use DBG level because the caller is probably
514 * interested in whether 'dpif' actually has a port 'devname', so that
515 * it's not an issue worth logging if it doesn't. Other errors are
516 * uncommon and more likely to indicate a real problem. */
518 error == ENOENT || error == ENODEV ? VLL_DBG : VLL_WARN,
519 "%s: failed to query port %s: %s",
520 dpif_name(dpif), devname, strerror(error));
525 /* Returns one greater than the maximum port number accepted in flow
528 dpif_get_max_ports(const struct dpif *dpif)
530 return dpif->dpif_class->get_max_ports(dpif);
533 /* Returns the Netlink PID value to supply in OVS_ACTION_ATTR_USERSPACE actions
534 * as the OVS_USERSPACE_ATTR_PID attribute's value, for use in flows whose
535 * packets arrived on port 'port_no'.
537 * The return value is only meaningful when DPIF_UC_ACTION has been enabled in
538 * the 'dpif''s listen mask. It is allowed to change when DPIF_UC_ACTION is
539 * disabled and then re-enabled, so a client that does that must be prepared to
540 * update all of the flows that it installed that contain
541 * OVS_ACTION_ATTR_USERSPACE actions. */
543 dpif_port_get_pid(const struct dpif *dpif, uint16_t port_no)
545 return (dpif->dpif_class->port_get_pid
546 ? (dpif->dpif_class->port_get_pid)(dpif, port_no)
550 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and copies
551 * the port's name into the 'name_size' bytes in 'name', ensuring that the
552 * result is null-terminated. On failure, returns a positive errno value and
553 * makes 'name' the empty string. */
555 dpif_port_get_name(struct dpif *dpif, uint16_t port_no,
556 char *name, size_t name_size)
558 struct dpif_port port;
561 assert(name_size > 0);
563 error = dpif_port_query_by_number(dpif, port_no, &port);
565 ovs_strlcpy(name, port.name, name_size);
566 dpif_port_destroy(&port);
573 /* Initializes 'dump' to begin dumping the ports in a dpif.
575 * This function provides no status indication. An error status for the entire
576 * dump operation is provided when it is completed by calling
577 * dpif_port_dump_done().
580 dpif_port_dump_start(struct dpif_port_dump *dump, const struct dpif *dpif)
583 dump->error = dpif->dpif_class->port_dump_start(dpif, &dump->state);
584 log_operation(dpif, "port_dump_start", dump->error);
587 /* Attempts to retrieve another port from 'dump', which must have been
588 * initialized with dpif_port_dump_start(). On success, stores a new dpif_port
589 * into 'port' and returns true. On failure, returns false.
591 * Failure might indicate an actual error or merely that the last port has been
592 * dumped. An error status for the entire dump operation is provided when it
593 * is completed by calling dpif_port_dump_done().
595 * The dpif owns the data stored in 'port'. It will remain valid until at
596 * least the next time 'dump' is passed to dpif_port_dump_next() or
597 * dpif_port_dump_done(). */
599 dpif_port_dump_next(struct dpif_port_dump *dump, struct dpif_port *port)
601 const struct dpif *dpif = dump->dpif;
607 dump->error = dpif->dpif_class->port_dump_next(dpif, dump->state, port);
608 if (dump->error == EOF) {
609 VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all ports", dpif_name(dpif));
611 log_operation(dpif, "port_dump_next", dump->error);
615 dpif->dpif_class->port_dump_done(dpif, dump->state);
621 /* Completes port table dump operation 'dump', which must have been initialized
622 * with dpif_port_dump_start(). Returns 0 if the dump operation was
623 * error-free, otherwise a positive errno value describing the problem. */
625 dpif_port_dump_done(struct dpif_port_dump *dump)
627 const struct dpif *dpif = dump->dpif;
629 dump->error = dpif->dpif_class->port_dump_done(dpif, dump->state);
630 log_operation(dpif, "port_dump_done", dump->error);
632 return dump->error == EOF ? 0 : dump->error;
635 /* Polls for changes in the set of ports in 'dpif'. If the set of ports in
636 * 'dpif' has changed, this function does one of the following:
638 * - Stores the name of the device that was added to or deleted from 'dpif' in
639 * '*devnamep' and returns 0. The caller is responsible for freeing
640 * '*devnamep' (with free()) when it no longer needs it.
642 * - Returns ENOBUFS and sets '*devnamep' to NULL.
644 * This function may also return 'false positives', where it returns 0 and
645 * '*devnamep' names a device that was not actually added or deleted or it
646 * returns ENOBUFS without any change.
648 * Returns EAGAIN if the set of ports in 'dpif' has not changed. May also
649 * return other positive errno values to indicate that something has gone
652 dpif_port_poll(const struct dpif *dpif, char **devnamep)
654 int error = dpif->dpif_class->port_poll(dpif, devnamep);
661 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
662 * value other than EAGAIN. */
664 dpif_port_poll_wait(const struct dpif *dpif)
666 dpif->dpif_class->port_poll_wait(dpif);
669 /* Extracts the flow stats for a packet. The 'flow' and 'packet'
670 * arguments must have been initialized through a call to flow_extract().
673 dpif_flow_stats_extract(const struct flow *flow, struct ofpbuf *packet,
674 struct dpif_flow_stats *stats)
676 memset(stats, 0, sizeof(*stats));
678 if ((flow->dl_type == htons(ETH_TYPE_IP)) && packet->l4) {
679 if ((flow->nw_proto == IPPROTO_TCP) && packet->l7) {
680 struct tcp_header *tcp = packet->l4;
681 stats->tcp_flags = TCP_FLAGS(tcp->tcp_ctl);
685 stats->n_bytes = packet->size;
686 stats->n_packets = 1;
689 /* Appends a human-readable representation of 'stats' to 's'. */
691 dpif_flow_stats_format(const struct dpif_flow_stats *stats, struct ds *s)
693 ds_put_format(s, "packets:%"PRIu64", bytes:%"PRIu64", used:",
694 stats->n_packets, stats->n_bytes);
696 ds_put_format(s, "%.3fs", (time_msec() - stats->used) / 1000.0);
698 ds_put_format(s, "never");
703 /* Deletes all flows from 'dpif'. Returns 0 if successful, otherwise a
704 * positive errno value. */
706 dpif_flow_flush(struct dpif *dpif)
710 COVERAGE_INC(dpif_flow_flush);
712 error = dpif->dpif_class->flow_flush(dpif);
713 log_operation(dpif, "flow_flush", error);
717 /* Queries 'dpif' for a flow entry. The flow is specified by the Netlink
718 * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
721 * Returns 0 if successful. If no flow matches, returns ENOENT. On other
722 * failure, returns a positive errno value.
724 * If 'actionsp' is nonnull, then on success '*actionsp' will be set to an
725 * ofpbuf owned by the caller that contains the Netlink attributes for the
726 * flow's actions. The caller must free the ofpbuf (with ofpbuf_delete()) when
727 * it is no longer needed.
729 * If 'stats' is nonnull, then on success it will be updated with the flow's
732 dpif_flow_get(const struct dpif *dpif,
733 const struct nlattr *key, size_t key_len,
734 struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
738 COVERAGE_INC(dpif_flow_get);
740 error = dpif->dpif_class->flow_get(dpif, key, key_len, actionsp, stats);
746 memset(stats, 0, sizeof *stats);
749 if (should_log_flow_message(error)) {
750 const struct nlattr *actions;
753 if (!error && actionsp) {
754 actions = (*actionsp)->data;
755 actions_len = (*actionsp)->size;
760 log_flow_message(dpif, error, "flow_get", key, key_len, stats,
761 actions, actions_len);
766 /* Adds or modifies a flow in 'dpif'. The flow is specified by the Netlink
767 * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
768 * 'key'. The associated actions are specified by the Netlink attributes with
769 * types OVS_ACTION_ATTR_* in the 'actions_len' bytes starting at 'actions'.
771 * - If the flow's key does not exist in 'dpif', then the flow will be added if
772 * 'flags' includes DPIF_FP_CREATE. Otherwise the operation will fail with
775 * If the operation succeeds, then 'stats', if nonnull, will be zeroed.
777 * - If the flow's key does exist in 'dpif', then the flow's actions will be
778 * updated if 'flags' includes DPIF_FP_MODIFY. Otherwise the operation will
779 * fail with EEXIST. If the flow's actions are updated, then its statistics
780 * will be zeroed if 'flags' includes DPIF_FP_ZERO_STATS, and left as-is
783 * If the operation succeeds, then 'stats', if nonnull, will be set to the
784 * flow's statistics before the update.
787 dpif_flow_put(struct dpif *dpif, enum dpif_flow_put_flags flags,
788 const struct nlattr *key, size_t key_len,
789 const struct nlattr *actions, size_t actions_len,
790 struct dpif_flow_stats *stats)
794 COVERAGE_INC(dpif_flow_put);
795 assert(!(flags & ~(DPIF_FP_CREATE | DPIF_FP_MODIFY | DPIF_FP_ZERO_STATS)));
797 error = dpif->dpif_class->flow_put(dpif, flags, key, key_len,
798 actions, actions_len, stats);
799 if (error && stats) {
800 memset(stats, 0, sizeof *stats);
802 if (should_log_flow_message(error)) {
806 ds_put_cstr(&s, "put");
807 if (flags & DPIF_FP_CREATE) {
808 ds_put_cstr(&s, "[create]");
810 if (flags & DPIF_FP_MODIFY) {
811 ds_put_cstr(&s, "[modify]");
813 if (flags & DPIF_FP_ZERO_STATS) {
814 ds_put_cstr(&s, "[zero]");
816 log_flow_message(dpif, error, ds_cstr(&s), key, key_len, stats,
817 actions, actions_len);
823 /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif' does
824 * not contain such a flow. The flow is specified by the Netlink attributes
825 * with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at 'key'.
827 * If the operation succeeds, then 'stats', if nonnull, will be set to the
828 * flow's statistics before its deletion. */
830 dpif_flow_del(struct dpif *dpif,
831 const struct nlattr *key, size_t key_len,
832 struct dpif_flow_stats *stats)
836 COVERAGE_INC(dpif_flow_del);
838 error = dpif->dpif_class->flow_del(dpif, key, key_len, stats);
839 if (error && stats) {
840 memset(stats, 0, sizeof *stats);
842 if (should_log_flow_message(error)) {
843 log_flow_message(dpif, error, "flow_del", key, key_len,
844 !error ? stats : NULL, NULL, 0);
849 /* Initializes 'dump' to begin dumping the flows in a dpif.
851 * This function provides no status indication. An error status for the entire
852 * dump operation is provided when it is completed by calling
853 * dpif_flow_dump_done().
856 dpif_flow_dump_start(struct dpif_flow_dump *dump, const struct dpif *dpif)
859 dump->error = dpif->dpif_class->flow_dump_start(dpif, &dump->state);
860 log_operation(dpif, "flow_dump_start", dump->error);
863 /* Attempts to retrieve another flow from 'dump', which must have been
864 * initialized with dpif_flow_dump_start(). On success, updates the output
865 * parameters as described below and returns true. Otherwise, returns false.
866 * Failure might indicate an actual error or merely the end of the flow table.
867 * An error status for the entire dump operation is provided when it is
868 * completed by calling dpif_flow_dump_done().
870 * On success, if 'key' and 'key_len' are nonnull then '*key' and '*key_len'
871 * will be set to Netlink attributes with types OVS_KEY_ATTR_* representing the
872 * dumped flow's key. If 'actions' and 'actions_len' are nonnull then they are
873 * set to Netlink attributes with types OVS_ACTION_ATTR_* representing the
874 * dumped flow's actions. If 'stats' is nonnull then it will be set to the
875 * dumped flow's statistics.
877 * All of the returned data is owned by 'dpif', not by the caller, and the
878 * caller must not modify or free it. 'dpif' guarantees that it remains
879 * accessible and unchanging until at least the next call to 'flow_dump_next'
880 * or 'flow_dump_done' for 'dump'. */
882 dpif_flow_dump_next(struct dpif_flow_dump *dump,
883 const struct nlattr **key, size_t *key_len,
884 const struct nlattr **actions, size_t *actions_len,
885 const struct dpif_flow_stats **stats)
887 const struct dpif *dpif = dump->dpif;
888 int error = dump->error;
891 error = dpif->dpif_class->flow_dump_next(dpif, dump->state,
893 actions, actions_len,
896 dpif->dpif_class->flow_dump_done(dpif, dump->state);
914 VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all flows", dpif_name(dpif));
915 } else if (should_log_flow_message(error)) {
916 log_flow_message(dpif, error, "flow_dump",
917 key ? *key : NULL, key ? *key_len : 0,
918 stats ? *stats : NULL, actions ? *actions : NULL,
919 actions ? *actions_len : 0);
926 /* Completes flow table dump operation 'dump', which must have been initialized
927 * with dpif_flow_dump_start(). Returns 0 if the dump operation was
928 * error-free, otherwise a positive errno value describing the problem. */
930 dpif_flow_dump_done(struct dpif_flow_dump *dump)
932 const struct dpif *dpif = dump->dpif;
934 dump->error = dpif->dpif_class->flow_dump_done(dpif, dump->state);
935 log_operation(dpif, "flow_dump_done", dump->error);
937 return dump->error == EOF ? 0 : dump->error;
940 /* Causes 'dpif' to perform the 'actions_len' bytes of actions in 'actions' on
941 * the Ethernet frame specified in 'packet' taken from the flow specified in
942 * the 'key_len' bytes of 'key'. ('key' is mostly redundant with 'packet', but
943 * it contains some metadata that cannot be recovered from 'packet', such as
944 * tun_id and in_port.)
946 * Returns 0 if successful, otherwise a positive errno value. */
948 dpif_execute(struct dpif *dpif,
949 const struct nlattr *key, size_t key_len,
950 const struct nlattr *actions, size_t actions_len,
951 const struct ofpbuf *buf)
955 COVERAGE_INC(dpif_execute);
956 if (actions_len > 0) {
957 error = dpif->dpif_class->execute(dpif, key, key_len,
958 actions, actions_len, buf);
963 if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) {
964 struct ds ds = DS_EMPTY_INITIALIZER;
965 char *packet = ofp_packet_to_string(buf->data, buf->size);
966 ds_put_format(&ds, "%s: execute ", dpif_name(dpif));
967 format_odp_actions(&ds, actions, actions_len);
969 ds_put_format(&ds, " failed (%s)", strerror(error));
971 ds_put_format(&ds, " on packet %s", packet);
972 vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));
979 /* Executes each of the 'n_ops' operations in 'ops' on 'dpif', in the order in
980 * which they are specified, placing each operation's results in the "output"
981 * members documented in comments.
983 * This function exists because some datapaths can perform batched operations
984 * faster than individual operations. */
986 dpif_operate(struct dpif *dpif, union dpif_op **ops, size_t n_ops)
990 if (dpif->dpif_class->operate) {
991 dpif->dpif_class->operate(dpif, ops, n_ops);
995 for (i = 0; i < n_ops; i++) {
996 union dpif_op *op = ops[i];
997 struct dpif_flow_put *put;
998 struct dpif_execute *execute;
1001 case DPIF_OP_FLOW_PUT:
1002 put = &op->flow_put;
1003 put->error = dpif_flow_put(dpif, put->flags,
1004 put->key, put->key_len,
1005 put->actions, put->actions_len,
1009 case DPIF_OP_EXECUTE:
1010 execute = &op->execute;
1011 execute->error = dpif_execute(dpif, execute->key, execute->key_len,
1013 execute->actions_len,
1024 /* Returns a string that represents 'type', for use in log messages. */
1026 dpif_upcall_type_to_string(enum dpif_upcall_type type)
1029 case DPIF_UC_MISS: return "miss";
1030 case DPIF_UC_ACTION: return "action";
1031 case DPIF_N_UC_TYPES: default: return "<unknown>";
1035 static bool OVS_UNUSED
1036 is_valid_listen_mask(int listen_mask)
1038 return !(listen_mask & ~((1u << DPIF_UC_MISS) |
1039 (1u << DPIF_UC_ACTION)));
1042 /* Retrieves 'dpif''s "listen mask" into '*listen_mask'. A 1-bit of value 2**X
1043 * set in '*listen_mask' indicates that dpif_recv() will receive messages of
1044 * the type (from "enum dpif_upcall_type") with value X. Returns 0 if
1045 * successful, otherwise a positive errno value. */
1047 dpif_recv_get_mask(const struct dpif *dpif, int *listen_mask)
1049 int error = dpif->dpif_class->recv_get_mask(dpif, listen_mask);
1053 assert(is_valid_listen_mask(*listen_mask));
1054 log_operation(dpif, "recv_get_mask", error);
1058 /* Sets 'dpif''s "listen mask" to 'listen_mask'. A 1-bit of value 2**X set in
1059 * '*listen_mask' requests that dpif_recv() will receive messages of the type
1060 * (from "enum dpif_upcall_type") with value X. Returns 0 if successful,
1061 * otherwise a positive errno value.
1063 * Turning DPIF_UC_ACTION off and then back on may change the Netlink PID
1064 * assignments returned by dpif_port_get_pid(). If the client does this, it
1065 * must update all of the flows that have OVS_ACTION_ATTR_USERSPACE actions
1066 * using the new PID assignment. */
1068 dpif_recv_set_mask(struct dpif *dpif, int listen_mask)
1072 assert(is_valid_listen_mask(listen_mask));
1074 error = dpif->dpif_class->recv_set_mask(dpif, listen_mask);
1075 log_operation(dpif, "recv_set_mask", error);
1079 /* Polls for an upcall from 'dpif'. If successful, stores the upcall into
1080 * '*upcall'. Only upcalls of the types selected with dpif_recv_set_mask()
1081 * member function will ordinarily be received (but if a message type is
1082 * enabled and then later disabled, some stragglers might pop up).
1084 * The caller takes ownership of the data that 'upcall' points to.
1085 * 'upcall->key' and 'upcall->actions' (if nonnull) point into data owned by
1086 * 'upcall->packet', so their memory cannot be freed separately. (This is
1087 * hardly a great way to do things but it works out OK for the dpif providers
1088 * and clients that exist so far.)
1090 * Returns 0 if successful, otherwise a positive errno value. Returns EAGAIN
1091 * if no upcall is immediately available. */
1093 dpif_recv(struct dpif *dpif, struct dpif_upcall *upcall)
1095 int error = dpif->dpif_class->recv(dpif, upcall);
1096 if (!error && !VLOG_DROP_DBG(&dpmsg_rl)) {
1100 packet = ofp_packet_to_string(upcall->packet->data,
1101 upcall->packet->size);
1104 odp_flow_key_format(upcall->key, upcall->key_len, &flow);
1106 VLOG_DBG("%s: %s upcall:\n%s\n%s",
1107 dpif_name(dpif), dpif_upcall_type_to_string(upcall->type),
1108 ds_cstr(&flow), packet);
1112 } else if (error && error != EAGAIN) {
1113 log_operation(dpif, "recv", error);
1118 /* Discards all messages that would otherwise be received by dpif_recv() on
1121 dpif_recv_purge(struct dpif *dpif)
1123 COVERAGE_INC(dpif_purge);
1124 if (dpif->dpif_class->recv_purge) {
1125 dpif->dpif_class->recv_purge(dpif);
1129 /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be
1130 * received with dpif_recv(). */
1132 dpif_recv_wait(struct dpif *dpif)
1134 dpif->dpif_class->recv_wait(dpif);
1137 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1138 * and '*engine_id', respectively. */
1140 dpif_get_netflow_ids(const struct dpif *dpif,
1141 uint8_t *engine_type, uint8_t *engine_id)
1143 *engine_type = dpif->netflow_engine_type;
1144 *engine_id = dpif->netflow_engine_id;
1147 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1148 * value used for setting packet priority.
1149 * On success, returns 0 and stores the priority into '*priority'.
1150 * On failure, returns a positive errno value and stores 0 into '*priority'. */
1152 dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id,
1155 int error = (dpif->dpif_class->queue_to_priority
1156 ? dpif->dpif_class->queue_to_priority(dpif, queue_id,
1162 log_operation(dpif, "queue_to_priority", error);
1167 dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class,
1169 uint8_t netflow_engine_type, uint8_t netflow_engine_id)
1171 dpif->dpif_class = dpif_class;
1172 dpif->base_name = xstrdup(name);
1173 dpif->full_name = xasprintf("%s@%s", dpif_class->type, name);
1174 dpif->netflow_engine_type = netflow_engine_type;
1175 dpif->netflow_engine_id = netflow_engine_id;
1178 /* Undoes the results of initialization.
1180 * Normally this function only needs to be called from dpif_close().
1181 * However, it may be called by providers due to an error on opening
1182 * that occurs after initialization. It this case dpif_close() would
1183 * never be called. */
1185 dpif_uninit(struct dpif *dpif, bool close)
1187 char *base_name = dpif->base_name;
1188 char *full_name = dpif->full_name;
1191 dpif->dpif_class->close(dpif);
1199 log_operation(const struct dpif *dpif, const char *operation, int error)
1202 VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation);
1203 } else if (is_errno(error)) {
1204 VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1205 dpif_name(dpif), operation, strerror(error));
1207 VLOG_WARN_RL(&error_rl, "%s: %s failed (%d/%d)",
1208 dpif_name(dpif), operation,
1209 get_ofp_err_type(error), get_ofp_err_code(error));
1213 static enum vlog_level
1214 flow_message_log_level(int error)
1216 return error ? VLL_WARN : VLL_DBG;
1220 should_log_flow_message(int error)
1222 return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error),
1223 error ? &error_rl : &dpmsg_rl);
1227 log_flow_message(const struct dpif *dpif, int error, const char *operation,
1228 const struct nlattr *key, size_t key_len,
1229 const struct dpif_flow_stats *stats,
1230 const struct nlattr *actions, size_t actions_len)
1232 struct ds ds = DS_EMPTY_INITIALIZER;
1233 ds_put_format(&ds, "%s: ", dpif_name(dpif));
1235 ds_put_cstr(&ds, "failed to ");
1237 ds_put_format(&ds, "%s ", operation);
1239 ds_put_format(&ds, "(%s) ", strerror(error));
1241 odp_flow_key_format(key, key_len, &ds);
1243 ds_put_cstr(&ds, ", ");
1244 dpif_flow_stats_format(stats, &ds);
1246 if (actions || actions_len) {
1247 ds_put_cstr(&ds, ", actions:");
1248 format_odp_actions(&ds, actions, actions_len);
1250 vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds));