2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
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-errors.h"
34 #include "ofp-print.h"
38 #include "poll-loop.h"
46 VLOG_DEFINE_THIS_MODULE(dpif);
48 COVERAGE_DEFINE(dpif_destroy);
49 COVERAGE_DEFINE(dpif_port_add);
50 COVERAGE_DEFINE(dpif_port_del);
51 COVERAGE_DEFINE(dpif_flow_flush);
52 COVERAGE_DEFINE(dpif_flow_get);
53 COVERAGE_DEFINE(dpif_flow_put);
54 COVERAGE_DEFINE(dpif_flow_del);
55 COVERAGE_DEFINE(dpif_flow_query_list);
56 COVERAGE_DEFINE(dpif_flow_query_list_n);
57 COVERAGE_DEFINE(dpif_execute);
58 COVERAGE_DEFINE(dpif_purge);
60 static const struct dpif_class *base_dpif_classes[] = {
67 struct registered_dpif_class {
68 const struct dpif_class *dpif_class;
71 static struct shash dpif_classes = SHASH_INITIALIZER(&dpif_classes);
72 static struct sset dpif_blacklist = SSET_INITIALIZER(&dpif_blacklist);
74 /* Rate limit for individual messages going to or from the datapath, output at
75 * DBG level. This is very high because, if these are enabled, it is because
76 * we really need to see them. */
77 static struct vlog_rate_limit dpmsg_rl = VLOG_RATE_LIMIT_INIT(600, 600);
79 /* Not really much point in logging many dpif errors. */
80 static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(60, 5);
82 static void log_flow_message(const struct dpif *dpif, int error,
83 const char *operation,
84 const struct nlattr *key, size_t key_len,
85 const struct dpif_flow_stats *stats,
86 const struct nlattr *actions, size_t actions_len);
87 static void log_operation(const struct dpif *, const char *operation,
89 static bool should_log_flow_message(int error);
90 static void log_flow_put_message(struct dpif *, const struct dpif_flow_put *,
92 static void log_flow_del_message(struct dpif *, const struct dpif_flow_del *,
94 static void log_execute_message(struct dpif *, const struct dpif_execute *,
100 static int status = -1;
106 for (i = 0; i < ARRAY_SIZE(base_dpif_classes); i++) {
107 dp_register_provider(base_dpif_classes[i]);
112 /* Registers a new datapath provider. After successful registration, new
113 * datapaths of that type can be opened using dpif_open(). */
115 dp_register_provider(const struct dpif_class *new_class)
117 struct registered_dpif_class *registered_class;
119 if (sset_contains(&dpif_blacklist, new_class->type)) {
120 VLOG_DBG("attempted to register blacklisted provider: %s",
125 if (shash_find(&dpif_classes, new_class->type)) {
126 VLOG_WARN("attempted to register duplicate datapath provider: %s",
131 registered_class = xmalloc(sizeof *registered_class);
132 registered_class->dpif_class = new_class;
133 registered_class->refcount = 0;
135 shash_add(&dpif_classes, new_class->type, registered_class);
140 /* Unregisters a datapath provider. 'type' must have been previously
141 * registered and not currently be in use by any dpifs. After unregistration
142 * new datapaths of that type cannot be opened using dpif_open(). */
144 dp_unregister_provider(const char *type)
146 struct shash_node *node;
147 struct registered_dpif_class *registered_class;
149 node = shash_find(&dpif_classes, type);
151 VLOG_WARN("attempted to unregister a datapath provider that is not "
152 "registered: %s", type);
156 registered_class = node->data;
157 if (registered_class->refcount) {
158 VLOG_WARN("attempted to unregister in use datapath provider: %s", type);
162 shash_delete(&dpif_classes, node);
163 free(registered_class);
168 /* Blacklists a provider. Causes future calls of dp_register_provider() with
169 * a dpif_class which implements 'type' to fail. */
171 dp_blacklist_provider(const char *type)
173 sset_add(&dpif_blacklist, type);
176 /* Clears 'types' and enumerates the types of all currently registered datapath
177 * providers into it. The caller must first initialize the sset. */
179 dp_enumerate_types(struct sset *types)
181 struct shash_node *node;
186 SHASH_FOR_EACH(node, &dpif_classes) {
187 const struct registered_dpif_class *registered_class = node->data;
188 sset_add(types, registered_class->dpif_class->type);
192 /* Clears 'names' and enumerates the names of all known created datapaths with
193 * the given 'type'. The caller must first initialize the sset. Returns 0 if
194 * successful, otherwise a positive errno value.
196 * Some kinds of datapaths might not be practically enumerable. This is not
197 * considered an error. */
199 dp_enumerate_names(const char *type, struct sset *names)
201 const struct registered_dpif_class *registered_class;
202 const struct dpif_class *dpif_class;
208 registered_class = shash_find_data(&dpif_classes, type);
209 if (!registered_class) {
210 VLOG_WARN("could not enumerate unknown type: %s", type);
214 dpif_class = registered_class->dpif_class;
215 error = dpif_class->enumerate ? dpif_class->enumerate(names) : 0;
218 VLOG_WARN("failed to enumerate %s datapaths: %s", dpif_class->type,
225 /* Parses 'datapath_name_', which is of the form [type@]name into its
226 * component pieces. 'name' and 'type' must be freed by the caller.
228 * The returned 'type' is normalized, as if by dpif_normalize_type(). */
230 dp_parse_name(const char *datapath_name_, char **name, char **type)
232 char *datapath_name = xstrdup(datapath_name_);
235 separator = strchr(datapath_name, '@');
238 *type = datapath_name;
239 *name = xstrdup(dpif_normalize_type(separator + 1));
241 *name = datapath_name;
242 *type = xstrdup(dpif_normalize_type(NULL));
247 do_open(const char *name, const char *type, bool create, struct dpif **dpifp)
249 struct dpif *dpif = NULL;
251 struct registered_dpif_class *registered_class;
255 type = dpif_normalize_type(type);
257 registered_class = shash_find_data(&dpif_classes, type);
258 if (!registered_class) {
259 VLOG_WARN("could not create datapath %s of unknown type %s", name,
261 error = EAFNOSUPPORT;
265 error = registered_class->dpif_class->open(registered_class->dpif_class,
266 name, create, &dpif);
268 assert(dpif->dpif_class == registered_class->dpif_class);
269 registered_class->refcount++;
273 *dpifp = error ? NULL : dpif;
277 /* Tries to open an existing datapath named 'name' and type 'type'. Will fail
278 * if no datapath with 'name' and 'type' exists. 'type' may be either NULL or
279 * the empty string to specify the default system type. Returns 0 if
280 * successful, otherwise a positive errno value. On success stores a pointer
281 * to the datapath in '*dpifp', otherwise a null pointer. */
283 dpif_open(const char *name, const char *type, struct dpif **dpifp)
285 return do_open(name, type, false, dpifp);
288 /* Tries to create and open a new datapath with the given 'name' and 'type'.
289 * 'type' may be either NULL or the empty string to specify the default system
290 * type. Will fail if a datapath with 'name' and 'type' already exists.
291 * Returns 0 if successful, otherwise a positive errno value. On success
292 * stores a pointer to the datapath in '*dpifp', otherwise a null pointer. */
294 dpif_create(const char *name, const char *type, struct dpif **dpifp)
296 return do_open(name, type, true, dpifp);
299 /* Tries to open a datapath with the given 'name' and 'type', creating it if it
300 * does not exist. 'type' may be either NULL or the empty string to specify
301 * the default system type. Returns 0 if successful, otherwise a positive
302 * errno value. On success stores a pointer to the datapath in '*dpifp',
303 * otherwise a null pointer. */
305 dpif_create_and_open(const char *name, const char *type, struct dpif **dpifp)
309 error = dpif_create(name, type, dpifp);
310 if (error == EEXIST || error == EBUSY) {
311 error = dpif_open(name, type, dpifp);
313 VLOG_WARN("datapath %s already exists but cannot be opened: %s",
314 name, strerror(error));
317 VLOG_WARN("failed to create datapath %s: %s", name, strerror(error));
322 /* Closes and frees the connection to 'dpif'. Does not destroy the datapath
323 * itself; call dpif_delete() first, instead, if that is desirable. */
325 dpif_close(struct dpif *dpif)
328 struct registered_dpif_class *registered_class;
330 registered_class = shash_find_data(&dpif_classes,
331 dpif->dpif_class->type);
332 assert(registered_class);
333 assert(registered_class->refcount);
335 registered_class->refcount--;
336 dpif_uninit(dpif, true);
340 /* Performs periodic work needed by 'dpif'. */
342 dpif_run(struct dpif *dpif)
344 if (dpif->dpif_class->run) {
345 dpif->dpif_class->run(dpif);
349 /* Arranges for poll_block() to wake up when dp_run() needs to be called for
352 dpif_wait(struct dpif *dpif)
354 if (dpif->dpif_class->wait) {
355 dpif->dpif_class->wait(dpif);
359 /* Returns the name of datapath 'dpif' prefixed with the type
360 * (for use in log messages). */
362 dpif_name(const struct dpif *dpif)
364 return dpif->full_name;
367 /* Returns the name of datapath 'dpif' without the type
368 * (for use in device names). */
370 dpif_base_name(const struct dpif *dpif)
372 return dpif->base_name;
375 /* Returns the fully spelled out name for the given datapath 'type'.
377 * Normalized type string can be compared with strcmp(). Unnormalized type
378 * string might be the same even if they have different spellings. */
380 dpif_normalize_type(const char *type)
382 return type && type[0] ? type : "system";
385 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
386 * ports. After calling this function, it does not make sense to pass 'dpif'
387 * to any functions other than dpif_name() or dpif_close(). */
389 dpif_delete(struct dpif *dpif)
393 COVERAGE_INC(dpif_destroy);
395 error = dpif->dpif_class->destroy(dpif);
396 log_operation(dpif, "delete", error);
400 /* Retrieves statistics for 'dpif' into 'stats'. Returns 0 if successful,
401 * otherwise a positive errno value. */
403 dpif_get_dp_stats(const struct dpif *dpif, struct dpif_dp_stats *stats)
405 int error = dpif->dpif_class->get_stats(dpif, stats);
407 memset(stats, 0, sizeof *stats);
409 log_operation(dpif, "get_stats", error);
413 /* Attempts to add 'netdev' as a port on 'dpif'. If successful, returns 0 and
414 * sets '*port_nop' to the new port's port number (if 'port_nop' is non-null).
415 * On failure, returns a positive errno value and sets '*port_nop' to
416 * UINT16_MAX (if 'port_nop' is non-null). */
418 dpif_port_add(struct dpif *dpif, struct netdev *netdev, uint16_t *port_nop)
420 const char *netdev_name = netdev_get_name(netdev);
424 COVERAGE_INC(dpif_port_add);
426 error = dpif->dpif_class->port_add(dpif, netdev, &port_no);
428 VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu16,
429 dpif_name(dpif), netdev_name, port_no);
431 VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s",
432 dpif_name(dpif), netdev_name, strerror(error));
433 port_no = UINT16_MAX;
441 /* Attempts to remove 'dpif''s port number 'port_no'. Returns 0 if successful,
442 * otherwise a positive errno value. */
444 dpif_port_del(struct dpif *dpif, uint16_t port_no)
448 COVERAGE_INC(dpif_port_del);
450 error = dpif->dpif_class->port_del(dpif, port_no);
452 VLOG_DBG_RL(&dpmsg_rl, "%s: port_del(%"PRIu16")",
453 dpif_name(dpif), port_no);
455 log_operation(dpif, "port_del", error);
460 /* Makes a deep copy of 'src' into 'dst'. */
462 dpif_port_clone(struct dpif_port *dst, const struct dpif_port *src)
464 dst->name = xstrdup(src->name);
465 dst->type = xstrdup(src->type);
466 dst->port_no = src->port_no;
469 /* Frees memory allocated to members of 'dpif_port'.
471 * Do not call this function on a dpif_port obtained from
472 * dpif_port_dump_next(): that function retains ownership of the data in the
475 dpif_port_destroy(struct dpif_port *dpif_port)
477 free(dpif_port->name);
478 free(dpif_port->type);
481 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and
482 * initializes '*port' appropriately; on failure, returns a positive errno
485 * The caller owns the data in 'port' and must free it with
486 * dpif_port_destroy() when it is no longer needed. */
488 dpif_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
489 struct dpif_port *port)
491 int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port);
493 VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu16" is device %s",
494 dpif_name(dpif), port_no, port->name);
496 memset(port, 0, sizeof *port);
497 VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu16": %s",
498 dpif_name(dpif), port_no, strerror(error));
503 /* Looks up port named 'devname' in 'dpif'. On success, returns 0 and
504 * initializes '*port' appropriately; on failure, returns a positive errno
507 * The caller owns the data in 'port' and must free it with
508 * dpif_port_destroy() when it is no longer needed. */
510 dpif_port_query_by_name(const struct dpif *dpif, const char *devname,
511 struct dpif_port *port)
513 int error = dpif->dpif_class->port_query_by_name(dpif, devname, port);
515 VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu16,
516 dpif_name(dpif), devname, port->port_no);
518 memset(port, 0, sizeof *port);
520 /* For ENOENT or ENODEV we use DBG level because the caller is probably
521 * interested in whether 'dpif' actually has a port 'devname', so that
522 * it's not an issue worth logging if it doesn't. Other errors are
523 * uncommon and more likely to indicate a real problem. */
525 error == ENOENT || error == ENODEV ? VLL_DBG : VLL_WARN,
526 "%s: failed to query port %s: %s",
527 dpif_name(dpif), devname, strerror(error));
532 /* Returns one greater than the maximum port number accepted in flow
535 dpif_get_max_ports(const struct dpif *dpif)
537 return dpif->dpif_class->get_max_ports(dpif);
540 /* Returns the Netlink PID value to supply in OVS_ACTION_ATTR_USERSPACE actions
541 * as the OVS_USERSPACE_ATTR_PID attribute's value, for use in flows whose
542 * packets arrived on port 'port_no'.
544 * A 'port_no' of UINT16_MAX is a special case: it returns a reserved PID, not
545 * allocated to any port, that the client may use for special purposes.
547 * The return value is only meaningful when DPIF_UC_ACTION has been enabled in
548 * the 'dpif''s listen mask. It is allowed to change when DPIF_UC_ACTION is
549 * disabled and then re-enabled, so a client that does that must be prepared to
550 * update all of the flows that it installed that contain
551 * OVS_ACTION_ATTR_USERSPACE actions. */
553 dpif_port_get_pid(const struct dpif *dpif, uint16_t port_no)
555 return (dpif->dpif_class->port_get_pid
556 ? (dpif->dpif_class->port_get_pid)(dpif, port_no)
560 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and copies
561 * the port's name into the 'name_size' bytes in 'name', ensuring that the
562 * result is null-terminated. On failure, returns a positive errno value and
563 * makes 'name' the empty string. */
565 dpif_port_get_name(struct dpif *dpif, uint16_t port_no,
566 char *name, size_t name_size)
568 struct dpif_port port;
571 assert(name_size > 0);
573 error = dpif_port_query_by_number(dpif, port_no, &port);
575 ovs_strlcpy(name, port.name, name_size);
576 dpif_port_destroy(&port);
583 /* Initializes 'dump' to begin dumping the ports in a dpif.
585 * This function provides no status indication. An error status for the entire
586 * dump operation is provided when it is completed by calling
587 * dpif_port_dump_done().
590 dpif_port_dump_start(struct dpif_port_dump *dump, const struct dpif *dpif)
593 dump->error = dpif->dpif_class->port_dump_start(dpif, &dump->state);
594 log_operation(dpif, "port_dump_start", dump->error);
597 /* Attempts to retrieve another port from 'dump', which must have been
598 * initialized with dpif_port_dump_start(). On success, stores a new dpif_port
599 * into 'port' and returns true. On failure, returns false.
601 * Failure might indicate an actual error or merely that the last port has been
602 * dumped. An error status for the entire dump operation is provided when it
603 * is completed by calling dpif_port_dump_done().
605 * The dpif owns the data stored in 'port'. It will remain valid until at
606 * least the next time 'dump' is passed to dpif_port_dump_next() or
607 * dpif_port_dump_done(). */
609 dpif_port_dump_next(struct dpif_port_dump *dump, struct dpif_port *port)
611 const struct dpif *dpif = dump->dpif;
617 dump->error = dpif->dpif_class->port_dump_next(dpif, dump->state, port);
618 if (dump->error == EOF) {
619 VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all ports", dpif_name(dpif));
621 log_operation(dpif, "port_dump_next", dump->error);
625 dpif->dpif_class->port_dump_done(dpif, dump->state);
631 /* Completes port table dump operation 'dump', which must have been initialized
632 * with dpif_port_dump_start(). Returns 0 if the dump operation was
633 * error-free, otherwise a positive errno value describing the problem. */
635 dpif_port_dump_done(struct dpif_port_dump *dump)
637 const struct dpif *dpif = dump->dpif;
639 dump->error = dpif->dpif_class->port_dump_done(dpif, dump->state);
640 log_operation(dpif, "port_dump_done", dump->error);
642 return dump->error == EOF ? 0 : dump->error;
645 /* Polls for changes in the set of ports in 'dpif'. If the set of ports in
646 * 'dpif' has changed, this function does one of the following:
648 * - Stores the name of the device that was added to or deleted from 'dpif' in
649 * '*devnamep' and returns 0. The caller is responsible for freeing
650 * '*devnamep' (with free()) when it no longer needs it.
652 * - Returns ENOBUFS and sets '*devnamep' to NULL.
654 * This function may also return 'false positives', where it returns 0 and
655 * '*devnamep' names a device that was not actually added or deleted or it
656 * returns ENOBUFS without any change.
658 * Returns EAGAIN if the set of ports in 'dpif' has not changed. May also
659 * return other positive errno values to indicate that something has gone
662 dpif_port_poll(const struct dpif *dpif, char **devnamep)
664 int error = dpif->dpif_class->port_poll(dpif, devnamep);
671 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
672 * value other than EAGAIN. */
674 dpif_port_poll_wait(const struct dpif *dpif)
676 dpif->dpif_class->port_poll_wait(dpif);
679 /* Extracts the flow stats for a packet. The 'flow' and 'packet'
680 * arguments must have been initialized through a call to flow_extract(). */
682 dpif_flow_stats_extract(const struct flow *flow, const struct ofpbuf *packet,
683 struct dpif_flow_stats *stats)
685 stats->tcp_flags = packet_get_tcp_flags(packet, flow);
686 stats->n_bytes = packet->size;
687 stats->n_packets = 1;
688 stats->used = time_msec();
691 /* Appends a human-readable representation of 'stats' to 's'. */
693 dpif_flow_stats_format(const struct dpif_flow_stats *stats, struct ds *s)
695 ds_put_format(s, "packets:%"PRIu64", bytes:%"PRIu64", used:",
696 stats->n_packets, stats->n_bytes);
698 ds_put_format(s, "%.3fs", (time_msec() - stats->used) / 1000.0);
700 ds_put_format(s, "never");
702 if (stats->tcp_flags) {
703 ds_put_cstr(s, ", flags:");
704 packet_format_tcp_flags(s, stats->tcp_flags);
708 /* Deletes all flows from 'dpif'. Returns 0 if successful, otherwise a
709 * positive errno value. */
711 dpif_flow_flush(struct dpif *dpif)
715 COVERAGE_INC(dpif_flow_flush);
717 error = dpif->dpif_class->flow_flush(dpif);
718 log_operation(dpif, "flow_flush", error);
722 /* Queries 'dpif' for a flow entry. The flow is specified by the Netlink
723 * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
726 * Returns 0 if successful. If no flow matches, returns ENOENT. On other
727 * failure, returns a positive errno value.
729 * If 'actionsp' is nonnull, then on success '*actionsp' will be set to an
730 * ofpbuf owned by the caller that contains the Netlink attributes for the
731 * flow's actions. The caller must free the ofpbuf (with ofpbuf_delete()) when
732 * it is no longer needed.
734 * If 'stats' is nonnull, then on success it will be updated with the flow's
737 dpif_flow_get(const struct dpif *dpif,
738 const struct nlattr *key, size_t key_len,
739 struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
743 COVERAGE_INC(dpif_flow_get);
745 error = dpif->dpif_class->flow_get(dpif, key, key_len, actionsp, stats);
751 memset(stats, 0, sizeof *stats);
754 if (should_log_flow_message(error)) {
755 const struct nlattr *actions;
758 if (!error && actionsp) {
759 actions = (*actionsp)->data;
760 actions_len = (*actionsp)->size;
765 log_flow_message(dpif, error, "flow_get", key, key_len, stats,
766 actions, actions_len);
772 dpif_flow_put__(struct dpif *dpif, const struct dpif_flow_put *put)
776 COVERAGE_INC(dpif_flow_put);
777 assert(!(put->flags & ~(DPIF_FP_CREATE | DPIF_FP_MODIFY
778 | DPIF_FP_ZERO_STATS)));
780 error = dpif->dpif_class->flow_put(dpif, put);
781 if (error && put->stats) {
782 memset(put->stats, 0, sizeof *put->stats);
784 log_flow_put_message(dpif, put, error);
788 /* Adds or modifies a flow in 'dpif'. The flow is specified by the Netlink
789 * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
790 * 'key'. The associated actions are specified by the Netlink attributes with
791 * types OVS_ACTION_ATTR_* in the 'actions_len' bytes starting at 'actions'.
793 * - If the flow's key does not exist in 'dpif', then the flow will be added if
794 * 'flags' includes DPIF_FP_CREATE. Otherwise the operation will fail with
797 * If the operation succeeds, then 'stats', if nonnull, will be zeroed.
799 * - If the flow's key does exist in 'dpif', then the flow's actions will be
800 * updated if 'flags' includes DPIF_FP_MODIFY. Otherwise the operation will
801 * fail with EEXIST. If the flow's actions are updated, then its statistics
802 * will be zeroed if 'flags' includes DPIF_FP_ZERO_STATS, and left as-is
805 * If the operation succeeds, then 'stats', if nonnull, will be set to the
806 * flow's statistics before the update.
809 dpif_flow_put(struct dpif *dpif, enum dpif_flow_put_flags flags,
810 const struct nlattr *key, size_t key_len,
811 const struct nlattr *actions, size_t actions_len,
812 struct dpif_flow_stats *stats)
814 struct dpif_flow_put put;
818 put.key_len = key_len;
819 put.actions = actions;
820 put.actions_len = actions_len;
822 return dpif_flow_put__(dpif, &put);
826 dpif_flow_del__(struct dpif *dpif, struct dpif_flow_del *del)
830 COVERAGE_INC(dpif_flow_del);
832 error = dpif->dpif_class->flow_del(dpif, del);
833 if (error && del->stats) {
834 memset(del->stats, 0, sizeof *del->stats);
836 log_flow_del_message(dpif, del, error);
840 /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif' does
841 * not contain such a flow. The flow is specified by the Netlink attributes
842 * with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at 'key'.
844 * If the operation succeeds, then 'stats', if nonnull, will be set to the
845 * flow's statistics before its deletion. */
847 dpif_flow_del(struct dpif *dpif,
848 const struct nlattr *key, size_t key_len,
849 struct dpif_flow_stats *stats)
851 struct dpif_flow_del del;
854 del.key_len = key_len;
856 return dpif_flow_del__(dpif, &del);
859 /* Initializes 'dump' to begin dumping the flows in a dpif.
861 * This function provides no status indication. An error status for the entire
862 * dump operation is provided when it is completed by calling
863 * dpif_flow_dump_done().
866 dpif_flow_dump_start(struct dpif_flow_dump *dump, const struct dpif *dpif)
869 dump->error = dpif->dpif_class->flow_dump_start(dpif, &dump->state);
870 log_operation(dpif, "flow_dump_start", dump->error);
873 /* Attempts to retrieve another flow from 'dump', which must have been
874 * initialized with dpif_flow_dump_start(). On success, updates the output
875 * parameters as described below and returns true. Otherwise, returns false.
876 * Failure might indicate an actual error or merely the end of the flow table.
877 * An error status for the entire dump operation is provided when it is
878 * completed by calling dpif_flow_dump_done().
880 * On success, if 'key' and 'key_len' are nonnull then '*key' and '*key_len'
881 * will be set to Netlink attributes with types OVS_KEY_ATTR_* representing the
882 * dumped flow's key. If 'actions' and 'actions_len' are nonnull then they are
883 * set to Netlink attributes with types OVS_ACTION_ATTR_* representing the
884 * dumped flow's actions. If 'stats' is nonnull then it will be set to the
885 * dumped flow's statistics.
887 * All of the returned data is owned by 'dpif', not by the caller, and the
888 * caller must not modify or free it. 'dpif' guarantees that it remains
889 * accessible and unchanging until at least the next call to 'flow_dump_next'
890 * or 'flow_dump_done' for 'dump'. */
892 dpif_flow_dump_next(struct dpif_flow_dump *dump,
893 const struct nlattr **key, size_t *key_len,
894 const struct nlattr **actions, size_t *actions_len,
895 const struct dpif_flow_stats **stats)
897 const struct dpif *dpif = dump->dpif;
898 int error = dump->error;
901 error = dpif->dpif_class->flow_dump_next(dpif, dump->state,
903 actions, actions_len,
906 dpif->dpif_class->flow_dump_done(dpif, dump->state);
924 VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all flows", dpif_name(dpif));
925 } else if (should_log_flow_message(error)) {
926 log_flow_message(dpif, error, "flow_dump",
927 key ? *key : NULL, key ? *key_len : 0,
928 stats ? *stats : NULL, actions ? *actions : NULL,
929 actions ? *actions_len : 0);
936 /* Completes flow table dump operation 'dump', which must have been initialized
937 * with dpif_flow_dump_start(). Returns 0 if the dump operation was
938 * error-free, otherwise a positive errno value describing the problem. */
940 dpif_flow_dump_done(struct dpif_flow_dump *dump)
942 const struct dpif *dpif = dump->dpif;
944 dump->error = dpif->dpif_class->flow_dump_done(dpif, dump->state);
945 log_operation(dpif, "flow_dump_done", dump->error);
947 return dump->error == EOF ? 0 : dump->error;
951 dpif_execute__(struct dpif *dpif, const struct dpif_execute *execute)
955 COVERAGE_INC(dpif_execute);
956 if (execute->actions_len > 0) {
957 error = dpif->dpif_class->execute(dpif, execute);
962 log_execute_message(dpif, execute, error);
967 /* Causes 'dpif' to perform the 'actions_len' bytes of actions in 'actions' on
968 * the Ethernet frame specified in 'packet' taken from the flow specified in
969 * the 'key_len' bytes of 'key'. ('key' is mostly redundant with 'packet', but
970 * it contains some metadata that cannot be recovered from 'packet', such as
971 * tun_id and in_port.)
973 * Returns 0 if successful, otherwise a positive errno value. */
975 dpif_execute(struct dpif *dpif,
976 const struct nlattr *key, size_t key_len,
977 const struct nlattr *actions, size_t actions_len,
978 const struct ofpbuf *buf)
980 struct dpif_execute execute;
983 execute.key_len = key_len;
984 execute.actions = actions;
985 execute.actions_len = actions_len;
986 execute.packet = buf;
987 return dpif_execute__(dpif, &execute);
990 /* Executes each of the 'n_ops' operations in 'ops' on 'dpif', in the order in
991 * which they are specified, placing each operation's results in the "output"
992 * members documented in comments.
994 * This function exists because some datapaths can perform batched operations
995 * faster than individual operations. */
997 dpif_operate(struct dpif *dpif, struct dpif_op **ops, size_t n_ops)
1001 if (dpif->dpif_class->operate) {
1002 dpif->dpif_class->operate(dpif, ops, n_ops);
1004 for (i = 0; i < n_ops; i++) {
1005 struct dpif_op *op = ops[i];
1008 case DPIF_OP_FLOW_PUT:
1009 log_flow_put_message(dpif, &op->u.flow_put, op->error);
1012 case DPIF_OP_FLOW_DEL:
1013 log_flow_del_message(dpif, &op->u.flow_del, op->error);
1016 case DPIF_OP_EXECUTE:
1017 log_execute_message(dpif, &op->u.execute, op->error);
1024 for (i = 0; i < n_ops; i++) {
1025 struct dpif_op *op = ops[i];
1028 case DPIF_OP_FLOW_PUT:
1029 op->error = dpif_flow_put__(dpif, &op->u.flow_put);
1032 case DPIF_OP_FLOW_DEL:
1033 op->error = dpif_flow_del__(dpif, &op->u.flow_del);
1036 case DPIF_OP_EXECUTE:
1037 op->error = dpif_execute__(dpif, &op->u.execute);
1047 /* Returns a string that represents 'type', for use in log messages. */
1049 dpif_upcall_type_to_string(enum dpif_upcall_type type)
1052 case DPIF_UC_MISS: return "miss";
1053 case DPIF_UC_ACTION: return "action";
1054 case DPIF_N_UC_TYPES: default: return "<unknown>";
1058 /* Enables or disables receiving packets with dpif_recv() on 'dpif'. Returns 0
1059 * if successful, otherwise a positive errno value.
1061 * Turning packet receive off and then back on may change the Netlink PID
1062 * assignments returned by dpif_port_get_pid(). If the client does this, it
1063 * must update all of the flows that have OVS_ACTION_ATTR_USERSPACE actions
1064 * using the new PID assignment. */
1066 dpif_recv_set(struct dpif *dpif, bool enable)
1068 int error = dpif->dpif_class->recv_set(dpif, enable);
1069 log_operation(dpif, "recv_set", error);
1073 /* Polls for an upcall from 'dpif'. If successful, stores the upcall into
1074 * '*upcall', using 'buf' for storage. Should only be called if
1075 * dpif_recv_set() has been used to enable receiving packets on 'dpif'.
1077 * 'upcall->packet' and 'upcall->key' point into data in the caller-provided
1078 * 'buf', so their memory cannot be freed separately from 'buf'. (This is
1079 * hardly a great way to do things but it works out OK for the dpif providers
1080 * and clients that exist so far.)
1082 * Returns 0 if successful, otherwise a positive errno value. Returns EAGAIN
1083 * if no upcall is immediately available. */
1085 dpif_recv(struct dpif *dpif, struct dpif_upcall *upcall, struct ofpbuf *buf)
1087 int error = dpif->dpif_class->recv(dpif, upcall, buf);
1088 if (!error && !VLOG_DROP_DBG(&dpmsg_rl)) {
1092 packet = ofp_packet_to_string(upcall->packet->data,
1093 upcall->packet->size);
1096 odp_flow_key_format(upcall->key, upcall->key_len, &flow);
1098 VLOG_DBG("%s: %s upcall:\n%s\n%s",
1099 dpif_name(dpif), dpif_upcall_type_to_string(upcall->type),
1100 ds_cstr(&flow), packet);
1104 } else if (error && error != EAGAIN) {
1105 log_operation(dpif, "recv", error);
1110 /* Discards all messages that would otherwise be received by dpif_recv() on
1113 dpif_recv_purge(struct dpif *dpif)
1115 COVERAGE_INC(dpif_purge);
1116 if (dpif->dpif_class->recv_purge) {
1117 dpif->dpif_class->recv_purge(dpif);
1121 /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be
1122 * received with dpif_recv(). */
1124 dpif_recv_wait(struct dpif *dpif)
1126 dpif->dpif_class->recv_wait(dpif);
1129 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1130 * and '*engine_id', respectively. */
1132 dpif_get_netflow_ids(const struct dpif *dpif,
1133 uint8_t *engine_type, uint8_t *engine_id)
1135 *engine_type = dpif->netflow_engine_type;
1136 *engine_id = dpif->netflow_engine_id;
1139 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1140 * value used for setting packet priority.
1141 * On success, returns 0 and stores the priority into '*priority'.
1142 * On failure, returns a positive errno value and stores 0 into '*priority'. */
1144 dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id,
1147 int error = (dpif->dpif_class->queue_to_priority
1148 ? dpif->dpif_class->queue_to_priority(dpif, queue_id,
1154 log_operation(dpif, "queue_to_priority", error);
1159 dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class,
1161 uint8_t netflow_engine_type, uint8_t netflow_engine_id)
1163 dpif->dpif_class = dpif_class;
1164 dpif->base_name = xstrdup(name);
1165 dpif->full_name = xasprintf("%s@%s", dpif_class->type, name);
1166 dpif->netflow_engine_type = netflow_engine_type;
1167 dpif->netflow_engine_id = netflow_engine_id;
1170 /* Undoes the results of initialization.
1172 * Normally this function only needs to be called from dpif_close().
1173 * However, it may be called by providers due to an error on opening
1174 * that occurs after initialization. It this case dpif_close() would
1175 * never be called. */
1177 dpif_uninit(struct dpif *dpif, bool close)
1179 char *base_name = dpif->base_name;
1180 char *full_name = dpif->full_name;
1183 dpif->dpif_class->close(dpif);
1191 log_operation(const struct dpif *dpif, const char *operation, int error)
1194 VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation);
1195 } else if (ofperr_is_valid(error)) {
1196 VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1197 dpif_name(dpif), operation, ofperr_get_name(error));
1199 VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1200 dpif_name(dpif), operation, strerror(error));
1204 static enum vlog_level
1205 flow_message_log_level(int error)
1207 return error ? VLL_WARN : VLL_DBG;
1211 should_log_flow_message(int error)
1213 return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error),
1214 error ? &error_rl : &dpmsg_rl);
1218 log_flow_message(const struct dpif *dpif, int error, const char *operation,
1219 const struct nlattr *key, size_t key_len,
1220 const struct dpif_flow_stats *stats,
1221 const struct nlattr *actions, size_t actions_len)
1223 struct ds ds = DS_EMPTY_INITIALIZER;
1224 ds_put_format(&ds, "%s: ", dpif_name(dpif));
1226 ds_put_cstr(&ds, "failed to ");
1228 ds_put_format(&ds, "%s ", operation);
1230 ds_put_format(&ds, "(%s) ", strerror(error));
1232 odp_flow_key_format(key, key_len, &ds);
1234 ds_put_cstr(&ds, ", ");
1235 dpif_flow_stats_format(stats, &ds);
1237 if (actions || actions_len) {
1238 ds_put_cstr(&ds, ", actions:");
1239 format_odp_actions(&ds, actions, actions_len);
1241 vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds));
1246 log_flow_put_message(struct dpif *dpif, const struct dpif_flow_put *put,
1249 if (should_log_flow_message(error)) {
1253 ds_put_cstr(&s, "put");
1254 if (put->flags & DPIF_FP_CREATE) {
1255 ds_put_cstr(&s, "[create]");
1257 if (put->flags & DPIF_FP_MODIFY) {
1258 ds_put_cstr(&s, "[modify]");
1260 if (put->flags & DPIF_FP_ZERO_STATS) {
1261 ds_put_cstr(&s, "[zero]");
1263 log_flow_message(dpif, error, ds_cstr(&s),
1264 put->key, put->key_len, put->stats,
1265 put->actions, put->actions_len);
1271 log_flow_del_message(struct dpif *dpif, const struct dpif_flow_del *del,
1274 if (should_log_flow_message(error)) {
1275 log_flow_message(dpif, error, "flow_del", del->key, del->key_len,
1276 !error ? del->stats : NULL, NULL, 0);
1281 log_execute_message(struct dpif *dpif, const struct dpif_execute *execute,
1284 if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) {
1285 struct ds ds = DS_EMPTY_INITIALIZER;
1288 packet = ofp_packet_to_string(execute->packet->data,
1289 execute->packet->size);
1290 ds_put_format(&ds, "%s: execute ", dpif_name(dpif));
1291 format_odp_actions(&ds, execute->actions, execute->actions_len);
1293 ds_put_format(&ds, " failed (%s)", strerror(error));
1295 ds_put_format(&ds, " on packet %s", packet);
1296 vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));