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 'port_nop' is
414 * non-null and its value is not UINT16_MAX, then attempts to use the
415 * value as the port number.
417 * If successful, returns 0 and sets '*port_nop' to the new port's port
418 * number (if 'port_nop' is non-null). On failure, returns a positive
419 * errno value and sets '*port_nop' to UINT16_MAX (if 'port_nop' is
422 dpif_port_add(struct dpif *dpif, struct netdev *netdev, uint16_t *port_nop)
424 const char *netdev_name = netdev_get_name(netdev);
425 uint16_t port_no = UINT16_MAX;
428 COVERAGE_INC(dpif_port_add);
434 error = dpif->dpif_class->port_add(dpif, netdev, &port_no);
436 VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu16,
437 dpif_name(dpif), netdev_name, port_no);
439 VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s",
440 dpif_name(dpif), netdev_name, strerror(error));
441 port_no = UINT16_MAX;
449 /* Attempts to remove 'dpif''s port number 'port_no'. Returns 0 if successful,
450 * otherwise a positive errno value. */
452 dpif_port_del(struct dpif *dpif, uint16_t port_no)
456 COVERAGE_INC(dpif_port_del);
458 error = dpif->dpif_class->port_del(dpif, port_no);
460 VLOG_DBG_RL(&dpmsg_rl, "%s: port_del(%"PRIu16")",
461 dpif_name(dpif), port_no);
463 log_operation(dpif, "port_del", error);
468 /* Makes a deep copy of 'src' into 'dst'. */
470 dpif_port_clone(struct dpif_port *dst, const struct dpif_port *src)
472 dst->name = xstrdup(src->name);
473 dst->type = xstrdup(src->type);
474 dst->port_no = src->port_no;
477 /* Frees memory allocated to members of 'dpif_port'.
479 * Do not call this function on a dpif_port obtained from
480 * dpif_port_dump_next(): that function retains ownership of the data in the
483 dpif_port_destroy(struct dpif_port *dpif_port)
485 free(dpif_port->name);
486 free(dpif_port->type);
489 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and
490 * initializes '*port' appropriately; on failure, returns a positive errno
493 * The caller owns the data in 'port' and must free it with
494 * dpif_port_destroy() when it is no longer needed. */
496 dpif_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
497 struct dpif_port *port)
499 int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port);
501 VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu16" is device %s",
502 dpif_name(dpif), port_no, port->name);
504 memset(port, 0, sizeof *port);
505 VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu16": %s",
506 dpif_name(dpif), port_no, strerror(error));
511 /* Looks up port named 'devname' in 'dpif'. On success, returns 0 and
512 * initializes '*port' appropriately; on failure, returns a positive errno
515 * The caller owns the data in 'port' and must free it with
516 * dpif_port_destroy() when it is no longer needed. */
518 dpif_port_query_by_name(const struct dpif *dpif, const char *devname,
519 struct dpif_port *port)
521 int error = dpif->dpif_class->port_query_by_name(dpif, devname, port);
523 VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu16,
524 dpif_name(dpif), devname, port->port_no);
526 memset(port, 0, sizeof *port);
528 /* For ENOENT or ENODEV we use DBG level because the caller is probably
529 * interested in whether 'dpif' actually has a port 'devname', so that
530 * it's not an issue worth logging if it doesn't. Other errors are
531 * uncommon and more likely to indicate a real problem. */
533 error == ENOENT || error == ENODEV ? VLL_DBG : VLL_WARN,
534 "%s: failed to query port %s: %s",
535 dpif_name(dpif), devname, strerror(error));
540 /* Returns one greater than the maximum port number accepted in flow
543 dpif_get_max_ports(const struct dpif *dpif)
545 return dpif->dpif_class->get_max_ports(dpif);
548 /* Returns the Netlink PID value to supply in OVS_ACTION_ATTR_USERSPACE actions
549 * as the OVS_USERSPACE_ATTR_PID attribute's value, for use in flows whose
550 * packets arrived on port 'port_no'.
552 * A 'port_no' of UINT16_MAX is a special case: it returns a reserved PID, not
553 * allocated to any port, that the client may use for special purposes.
555 * The return value is only meaningful when DPIF_UC_ACTION has been enabled in
556 * the 'dpif''s listen mask. It is allowed to change when DPIF_UC_ACTION is
557 * disabled and then re-enabled, so a client that does that must be prepared to
558 * update all of the flows that it installed that contain
559 * OVS_ACTION_ATTR_USERSPACE actions. */
561 dpif_port_get_pid(const struct dpif *dpif, uint16_t port_no)
563 return (dpif->dpif_class->port_get_pid
564 ? (dpif->dpif_class->port_get_pid)(dpif, port_no)
568 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and copies
569 * the port's name into the 'name_size' bytes in 'name', ensuring that the
570 * result is null-terminated. On failure, returns a positive errno value and
571 * makes 'name' the empty string. */
573 dpif_port_get_name(struct dpif *dpif, uint16_t port_no,
574 char *name, size_t name_size)
576 struct dpif_port port;
579 assert(name_size > 0);
581 error = dpif_port_query_by_number(dpif, port_no, &port);
583 ovs_strlcpy(name, port.name, name_size);
584 dpif_port_destroy(&port);
591 /* Initializes 'dump' to begin dumping the ports in a dpif.
593 * This function provides no status indication. An error status for the entire
594 * dump operation is provided when it is completed by calling
595 * dpif_port_dump_done().
598 dpif_port_dump_start(struct dpif_port_dump *dump, const struct dpif *dpif)
601 dump->error = dpif->dpif_class->port_dump_start(dpif, &dump->state);
602 log_operation(dpif, "port_dump_start", dump->error);
605 /* Attempts to retrieve another port from 'dump', which must have been
606 * initialized with dpif_port_dump_start(). On success, stores a new dpif_port
607 * into 'port' and returns true. On failure, returns false.
609 * Failure might indicate an actual error or merely that the last port has been
610 * dumped. An error status for the entire dump operation is provided when it
611 * is completed by calling dpif_port_dump_done().
613 * The dpif owns the data stored in 'port'. It will remain valid until at
614 * least the next time 'dump' is passed to dpif_port_dump_next() or
615 * dpif_port_dump_done(). */
617 dpif_port_dump_next(struct dpif_port_dump *dump, struct dpif_port *port)
619 const struct dpif *dpif = dump->dpif;
625 dump->error = dpif->dpif_class->port_dump_next(dpif, dump->state, port);
626 if (dump->error == EOF) {
627 VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all ports", dpif_name(dpif));
629 log_operation(dpif, "port_dump_next", dump->error);
633 dpif->dpif_class->port_dump_done(dpif, dump->state);
639 /* Completes port table dump operation 'dump', which must have been initialized
640 * with dpif_port_dump_start(). Returns 0 if the dump operation was
641 * error-free, otherwise a positive errno value describing the problem. */
643 dpif_port_dump_done(struct dpif_port_dump *dump)
645 const struct dpif *dpif = dump->dpif;
647 dump->error = dpif->dpif_class->port_dump_done(dpif, dump->state);
648 log_operation(dpif, "port_dump_done", dump->error);
650 return dump->error == EOF ? 0 : dump->error;
653 /* Polls for changes in the set of ports in 'dpif'. If the set of ports in
654 * 'dpif' has changed, this function does one of the following:
656 * - Stores the name of the device that was added to or deleted from 'dpif' in
657 * '*devnamep' and returns 0. The caller is responsible for freeing
658 * '*devnamep' (with free()) when it no longer needs it.
660 * - Returns ENOBUFS and sets '*devnamep' to NULL.
662 * This function may also return 'false positives', where it returns 0 and
663 * '*devnamep' names a device that was not actually added or deleted or it
664 * returns ENOBUFS without any change.
666 * Returns EAGAIN if the set of ports in 'dpif' has not changed. May also
667 * return other positive errno values to indicate that something has gone
670 dpif_port_poll(const struct dpif *dpif, char **devnamep)
672 int error = dpif->dpif_class->port_poll(dpif, devnamep);
679 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
680 * value other than EAGAIN. */
682 dpif_port_poll_wait(const struct dpif *dpif)
684 dpif->dpif_class->port_poll_wait(dpif);
687 /* Extracts the flow stats for a packet. The 'flow' and 'packet'
688 * arguments must have been initialized through a call to flow_extract(). */
690 dpif_flow_stats_extract(const struct flow *flow, const struct ofpbuf *packet,
691 struct dpif_flow_stats *stats)
693 stats->tcp_flags = packet_get_tcp_flags(packet, flow);
694 stats->n_bytes = packet->size;
695 stats->n_packets = 1;
696 stats->used = time_msec();
699 /* Appends a human-readable representation of 'stats' to 's'. */
701 dpif_flow_stats_format(const struct dpif_flow_stats *stats, struct ds *s)
703 ds_put_format(s, "packets:%"PRIu64", bytes:%"PRIu64", used:",
704 stats->n_packets, stats->n_bytes);
706 ds_put_format(s, "%.3fs", (time_msec() - stats->used) / 1000.0);
708 ds_put_format(s, "never");
710 if (stats->tcp_flags) {
711 ds_put_cstr(s, ", flags:");
712 packet_format_tcp_flags(s, stats->tcp_flags);
716 /* Deletes all flows from 'dpif'. Returns 0 if successful, otherwise a
717 * positive errno value. */
719 dpif_flow_flush(struct dpif *dpif)
723 COVERAGE_INC(dpif_flow_flush);
725 error = dpif->dpif_class->flow_flush(dpif);
726 log_operation(dpif, "flow_flush", error);
730 /* Queries 'dpif' for a flow entry. The flow is specified by the Netlink
731 * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
734 * Returns 0 if successful. If no flow matches, returns ENOENT. On other
735 * failure, returns a positive errno value.
737 * If 'actionsp' is nonnull, then on success '*actionsp' will be set to an
738 * ofpbuf owned by the caller that contains the Netlink attributes for the
739 * flow's actions. The caller must free the ofpbuf (with ofpbuf_delete()) when
740 * it is no longer needed.
742 * If 'stats' is nonnull, then on success it will be updated with the flow's
745 dpif_flow_get(const struct dpif *dpif,
746 const struct nlattr *key, size_t key_len,
747 struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
751 COVERAGE_INC(dpif_flow_get);
753 error = dpif->dpif_class->flow_get(dpif, key, key_len, actionsp, stats);
759 memset(stats, 0, sizeof *stats);
762 if (should_log_flow_message(error)) {
763 const struct nlattr *actions;
766 if (!error && actionsp) {
767 actions = (*actionsp)->data;
768 actions_len = (*actionsp)->size;
773 log_flow_message(dpif, error, "flow_get", key, key_len, stats,
774 actions, actions_len);
780 dpif_flow_put__(struct dpif *dpif, const struct dpif_flow_put *put)
784 COVERAGE_INC(dpif_flow_put);
785 assert(!(put->flags & ~(DPIF_FP_CREATE | DPIF_FP_MODIFY
786 | DPIF_FP_ZERO_STATS)));
788 error = dpif->dpif_class->flow_put(dpif, put);
789 if (error && put->stats) {
790 memset(put->stats, 0, sizeof *put->stats);
792 log_flow_put_message(dpif, put, error);
796 /* Adds or modifies a flow in 'dpif'. The flow is specified by the Netlink
797 * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
798 * 'key'. The associated actions are specified by the Netlink attributes with
799 * types OVS_ACTION_ATTR_* in the 'actions_len' bytes starting at 'actions'.
801 * - If the flow's key does not exist in 'dpif', then the flow will be added if
802 * 'flags' includes DPIF_FP_CREATE. Otherwise the operation will fail with
805 * If the operation succeeds, then 'stats', if nonnull, will be zeroed.
807 * - If the flow's key does exist in 'dpif', then the flow's actions will be
808 * updated if 'flags' includes DPIF_FP_MODIFY. Otherwise the operation will
809 * fail with EEXIST. If the flow's actions are updated, then its statistics
810 * will be zeroed if 'flags' includes DPIF_FP_ZERO_STATS, and left as-is
813 * If the operation succeeds, then 'stats', if nonnull, will be set to the
814 * flow's statistics before the update.
817 dpif_flow_put(struct dpif *dpif, enum dpif_flow_put_flags flags,
818 const struct nlattr *key, size_t key_len,
819 const struct nlattr *actions, size_t actions_len,
820 struct dpif_flow_stats *stats)
822 struct dpif_flow_put put;
826 put.key_len = key_len;
827 put.actions = actions;
828 put.actions_len = actions_len;
830 return dpif_flow_put__(dpif, &put);
834 dpif_flow_del__(struct dpif *dpif, struct dpif_flow_del *del)
838 COVERAGE_INC(dpif_flow_del);
840 error = dpif->dpif_class->flow_del(dpif, del);
841 if (error && del->stats) {
842 memset(del->stats, 0, sizeof *del->stats);
844 log_flow_del_message(dpif, del, error);
848 /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif' does
849 * not contain such a flow. The flow is specified by the Netlink attributes
850 * with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at 'key'.
852 * If the operation succeeds, then 'stats', if nonnull, will be set to the
853 * flow's statistics before its deletion. */
855 dpif_flow_del(struct dpif *dpif,
856 const struct nlattr *key, size_t key_len,
857 struct dpif_flow_stats *stats)
859 struct dpif_flow_del del;
862 del.key_len = key_len;
864 return dpif_flow_del__(dpif, &del);
867 /* Initializes 'dump' to begin dumping the flows in a dpif.
869 * This function provides no status indication. An error status for the entire
870 * dump operation is provided when it is completed by calling
871 * dpif_flow_dump_done().
874 dpif_flow_dump_start(struct dpif_flow_dump *dump, const struct dpif *dpif)
877 dump->error = dpif->dpif_class->flow_dump_start(dpif, &dump->state);
878 log_operation(dpif, "flow_dump_start", dump->error);
881 /* Attempts to retrieve another flow from 'dump', which must have been
882 * initialized with dpif_flow_dump_start(). On success, updates the output
883 * parameters as described below and returns true. Otherwise, returns false.
884 * Failure might indicate an actual error or merely the end of the flow table.
885 * An error status for the entire dump operation is provided when it is
886 * completed by calling dpif_flow_dump_done().
888 * On success, if 'key' and 'key_len' are nonnull then '*key' and '*key_len'
889 * will be set to Netlink attributes with types OVS_KEY_ATTR_* representing the
890 * dumped flow's key. If 'actions' and 'actions_len' are nonnull then they are
891 * set to Netlink attributes with types OVS_ACTION_ATTR_* representing the
892 * dumped flow's actions. If 'stats' is nonnull then it will be set to the
893 * dumped flow's statistics.
895 * All of the returned data is owned by 'dpif', not by the caller, and the
896 * caller must not modify or free it. 'dpif' guarantees that it remains
897 * accessible and unchanging until at least the next call to 'flow_dump_next'
898 * or 'flow_dump_done' for 'dump'. */
900 dpif_flow_dump_next(struct dpif_flow_dump *dump,
901 const struct nlattr **key, size_t *key_len,
902 const struct nlattr **actions, size_t *actions_len,
903 const struct dpif_flow_stats **stats)
905 const struct dpif *dpif = dump->dpif;
906 int error = dump->error;
909 error = dpif->dpif_class->flow_dump_next(dpif, dump->state,
911 actions, actions_len,
914 dpif->dpif_class->flow_dump_done(dpif, dump->state);
932 VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all flows", dpif_name(dpif));
933 } else if (should_log_flow_message(error)) {
934 log_flow_message(dpif, error, "flow_dump",
935 key ? *key : NULL, key ? *key_len : 0,
936 stats ? *stats : NULL, actions ? *actions : NULL,
937 actions ? *actions_len : 0);
944 /* Completes flow table dump operation 'dump', which must have been initialized
945 * with dpif_flow_dump_start(). Returns 0 if the dump operation was
946 * error-free, otherwise a positive errno value describing the problem. */
948 dpif_flow_dump_done(struct dpif_flow_dump *dump)
950 const struct dpif *dpif = dump->dpif;
952 dump->error = dpif->dpif_class->flow_dump_done(dpif, dump->state);
953 log_operation(dpif, "flow_dump_done", dump->error);
955 return dump->error == EOF ? 0 : dump->error;
959 dpif_execute__(struct dpif *dpif, const struct dpif_execute *execute)
963 COVERAGE_INC(dpif_execute);
964 if (execute->actions_len > 0) {
965 error = dpif->dpif_class->execute(dpif, execute);
970 log_execute_message(dpif, execute, error);
975 /* Causes 'dpif' to perform the 'actions_len' bytes of actions in 'actions' on
976 * the Ethernet frame specified in 'packet' taken from the flow specified in
977 * the 'key_len' bytes of 'key'. ('key' is mostly redundant with 'packet', but
978 * it contains some metadata that cannot be recovered from 'packet', such as
979 * tun_id and in_port.)
981 * Returns 0 if successful, otherwise a positive errno value. */
983 dpif_execute(struct dpif *dpif,
984 const struct nlattr *key, size_t key_len,
985 const struct nlattr *actions, size_t actions_len,
986 const struct ofpbuf *buf)
988 struct dpif_execute execute;
991 execute.key_len = key_len;
992 execute.actions = actions;
993 execute.actions_len = actions_len;
994 execute.packet = buf;
995 return dpif_execute__(dpif, &execute);
998 /* Executes each of the 'n_ops' operations in 'ops' on 'dpif', in the order in
999 * which they are specified, placing each operation's results in the "output"
1000 * members documented in comments.
1002 * This function exists because some datapaths can perform batched operations
1003 * faster than individual operations. */
1005 dpif_operate(struct dpif *dpif, struct dpif_op **ops, size_t n_ops)
1009 if (dpif->dpif_class->operate) {
1010 dpif->dpif_class->operate(dpif, ops, n_ops);
1012 for (i = 0; i < n_ops; i++) {
1013 struct dpif_op *op = ops[i];
1016 case DPIF_OP_FLOW_PUT:
1017 log_flow_put_message(dpif, &op->u.flow_put, op->error);
1020 case DPIF_OP_FLOW_DEL:
1021 log_flow_del_message(dpif, &op->u.flow_del, op->error);
1024 case DPIF_OP_EXECUTE:
1025 log_execute_message(dpif, &op->u.execute, op->error);
1032 for (i = 0; i < n_ops; i++) {
1033 struct dpif_op *op = ops[i];
1036 case DPIF_OP_FLOW_PUT:
1037 op->error = dpif_flow_put__(dpif, &op->u.flow_put);
1040 case DPIF_OP_FLOW_DEL:
1041 op->error = dpif_flow_del__(dpif, &op->u.flow_del);
1044 case DPIF_OP_EXECUTE:
1045 op->error = dpif_execute__(dpif, &op->u.execute);
1055 /* Returns a string that represents 'type', for use in log messages. */
1057 dpif_upcall_type_to_string(enum dpif_upcall_type type)
1060 case DPIF_UC_MISS: return "miss";
1061 case DPIF_UC_ACTION: return "action";
1062 case DPIF_N_UC_TYPES: default: return "<unknown>";
1066 /* Enables or disables receiving packets with dpif_recv() on 'dpif'. Returns 0
1067 * if successful, otherwise a positive errno value.
1069 * Turning packet receive off and then back on may change the Netlink PID
1070 * assignments returned by dpif_port_get_pid(). If the client does this, it
1071 * must update all of the flows that have OVS_ACTION_ATTR_USERSPACE actions
1072 * using the new PID assignment. */
1074 dpif_recv_set(struct dpif *dpif, bool enable)
1076 int error = dpif->dpif_class->recv_set(dpif, enable);
1077 log_operation(dpif, "recv_set", error);
1081 /* Polls for an upcall from 'dpif'. If successful, stores the upcall into
1082 * '*upcall', using 'buf' for storage. Should only be called if
1083 * dpif_recv_set() has been used to enable receiving packets on 'dpif'.
1085 * 'upcall->packet' and 'upcall->key' point into data in the caller-provided
1086 * 'buf', so their memory cannot be freed separately from 'buf'. (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, struct ofpbuf *buf)
1095 int error = dpif->dpif_class->recv(dpif, upcall, buf);
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 (ofperr_is_valid(error)) {
1204 VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1205 dpif_name(dpif), operation, ofperr_get_name(error));
1207 VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1208 dpif_name(dpif), operation, strerror(error));
1212 static enum vlog_level
1213 flow_message_log_level(int error)
1215 return error ? VLL_WARN : VLL_DBG;
1219 should_log_flow_message(int error)
1221 return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error),
1222 error ? &error_rl : &dpmsg_rl);
1226 log_flow_message(const struct dpif *dpif, int error, const char *operation,
1227 const struct nlattr *key, size_t key_len,
1228 const struct dpif_flow_stats *stats,
1229 const struct nlattr *actions, size_t actions_len)
1231 struct ds ds = DS_EMPTY_INITIALIZER;
1232 ds_put_format(&ds, "%s: ", dpif_name(dpif));
1234 ds_put_cstr(&ds, "failed to ");
1236 ds_put_format(&ds, "%s ", operation);
1238 ds_put_format(&ds, "(%s) ", strerror(error));
1240 odp_flow_key_format(key, key_len, &ds);
1242 ds_put_cstr(&ds, ", ");
1243 dpif_flow_stats_format(stats, &ds);
1245 if (actions || actions_len) {
1246 ds_put_cstr(&ds, ", actions:");
1247 format_odp_actions(&ds, actions, actions_len);
1249 vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds));
1254 log_flow_put_message(struct dpif *dpif, const struct dpif_flow_put *put,
1257 if (should_log_flow_message(error)) {
1261 ds_put_cstr(&s, "put");
1262 if (put->flags & DPIF_FP_CREATE) {
1263 ds_put_cstr(&s, "[create]");
1265 if (put->flags & DPIF_FP_MODIFY) {
1266 ds_put_cstr(&s, "[modify]");
1268 if (put->flags & DPIF_FP_ZERO_STATS) {
1269 ds_put_cstr(&s, "[zero]");
1271 log_flow_message(dpif, error, ds_cstr(&s),
1272 put->key, put->key_len, put->stats,
1273 put->actions, put->actions_len);
1279 log_flow_del_message(struct dpif *dpif, const struct dpif_flow_del *del,
1282 if (should_log_flow_message(error)) {
1283 log_flow_message(dpif, error, "flow_del", del->key, del->key_len,
1284 !error ? del->stats : NULL, NULL, 0);
1289 log_execute_message(struct dpif *dpif, const struct dpif_execute *execute,
1292 if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) {
1293 struct ds ds = DS_EMPTY_INITIALIZER;
1296 packet = ofp_packet_to_string(execute->packet->data,
1297 execute->packet->size);
1298 ds_put_format(&ds, "%s: execute ", dpif_name(dpif));
1299 format_odp_actions(&ds, execute->actions, execute->actions_len);
1301 ds_put_format(&ds, " failed (%s)", strerror(error));
1303 ds_put_format(&ds, " on packet %s", packet);
1304 vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));