2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 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-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_execute_message(struct dpif *, const struct dpif_execute *,
98 static int status = -1;
104 for (i = 0; i < ARRAY_SIZE(base_dpif_classes); i++) {
105 dp_register_provider(base_dpif_classes[i]);
110 /* Registers a new datapath provider. After successful registration, new
111 * datapaths of that type can be opened using dpif_open(). */
113 dp_register_provider(const struct dpif_class *new_class)
115 struct registered_dpif_class *registered_class;
117 if (sset_contains(&dpif_blacklist, new_class->type)) {
118 VLOG_DBG("attempted to register blacklisted provider: %s",
123 if (shash_find(&dpif_classes, new_class->type)) {
124 VLOG_WARN("attempted to register duplicate datapath provider: %s",
129 registered_class = xmalloc(sizeof *registered_class);
130 registered_class->dpif_class = new_class;
131 registered_class->refcount = 0;
133 shash_add(&dpif_classes, new_class->type, registered_class);
138 /* Unregisters a datapath provider. 'type' must have been previously
139 * registered and not currently be in use by any dpifs. After unregistration
140 * new datapaths of that type cannot be opened using dpif_open(). */
142 dp_unregister_provider(const char *type)
144 struct shash_node *node;
145 struct registered_dpif_class *registered_class;
147 node = shash_find(&dpif_classes, type);
149 VLOG_WARN("attempted to unregister a datapath provider that is not "
150 "registered: %s", type);
154 registered_class = node->data;
155 if (registered_class->refcount) {
156 VLOG_WARN("attempted to unregister in use datapath provider: %s", type);
160 shash_delete(&dpif_classes, node);
161 free(registered_class);
166 /* Blacklists a provider. Causes future calls of dp_register_provider() with
167 * a dpif_class which implements 'type' to fail. */
169 dp_blacklist_provider(const char *type)
171 sset_add(&dpif_blacklist, type);
174 /* Clears 'types' and enumerates the types of all currently registered datapath
175 * providers into it. The caller must first initialize the sset. */
177 dp_enumerate_types(struct sset *types)
179 struct shash_node *node;
184 SHASH_FOR_EACH(node, &dpif_classes) {
185 const struct registered_dpif_class *registered_class = node->data;
186 sset_add(types, registered_class->dpif_class->type);
190 /* Clears 'names' and enumerates the names of all known created datapaths with
191 * the given 'type'. The caller must first initialize the sset. Returns 0 if
192 * successful, otherwise a positive errno value.
194 * Some kinds of datapaths might not be practically enumerable. This is not
195 * considered an error. */
197 dp_enumerate_names(const char *type, struct sset *names)
199 const struct registered_dpif_class *registered_class;
200 const struct dpif_class *dpif_class;
206 registered_class = shash_find_data(&dpif_classes, type);
207 if (!registered_class) {
208 VLOG_WARN("could not enumerate unknown type: %s", type);
212 dpif_class = registered_class->dpif_class;
213 error = dpif_class->enumerate ? dpif_class->enumerate(names) : 0;
216 VLOG_WARN("failed to enumerate %s datapaths: %s", dpif_class->type,
223 /* Parses 'datapath_name_', which is of the form [type@]name into its
224 * component pieces. 'name' and 'type' must be freed by the caller.
226 * The returned 'type' is normalized, as if by dpif_normalize_type(). */
228 dp_parse_name(const char *datapath_name_, char **name, char **type)
230 char *datapath_name = xstrdup(datapath_name_);
233 separator = strchr(datapath_name, '@');
236 *type = datapath_name;
237 *name = xstrdup(dpif_normalize_type(separator + 1));
239 *name = datapath_name;
240 *type = xstrdup(dpif_normalize_type(NULL));
245 do_open(const char *name, const char *type, bool create, struct dpif **dpifp)
247 struct dpif *dpif = NULL;
249 struct registered_dpif_class *registered_class;
253 type = dpif_normalize_type(type);
255 registered_class = shash_find_data(&dpif_classes, type);
256 if (!registered_class) {
257 VLOG_WARN("could not create datapath %s of unknown type %s", name,
259 error = EAFNOSUPPORT;
263 error = registered_class->dpif_class->open(registered_class->dpif_class,
264 name, create, &dpif);
266 assert(dpif->dpif_class == registered_class->dpif_class);
267 registered_class->refcount++;
271 *dpifp = error ? NULL : dpif;
275 /* Tries to open an existing datapath named 'name' and type 'type'. Will fail
276 * if no datapath with 'name' and 'type' exists. 'type' may be either NULL or
277 * the empty string to specify the default system type. Returns 0 if
278 * successful, otherwise a positive errno value. On success stores a pointer
279 * to the datapath in '*dpifp', otherwise a null pointer. */
281 dpif_open(const char *name, const char *type, struct dpif **dpifp)
283 return do_open(name, type, false, dpifp);
286 /* Tries to create and open a new datapath with the given 'name' and 'type'.
287 * 'type' may be either NULL or the empty string to specify the default system
288 * type. Will fail if a datapath with 'name' and 'type' already exists.
289 * Returns 0 if successful, otherwise a positive errno value. On success
290 * stores a pointer to the datapath in '*dpifp', otherwise a null pointer. */
292 dpif_create(const char *name, const char *type, struct dpif **dpifp)
294 return do_open(name, type, true, dpifp);
297 /* Tries to open a datapath with the given 'name' and 'type', creating it if it
298 * does not exist. 'type' may be either NULL or the empty string to specify
299 * the default system type. Returns 0 if successful, otherwise a positive
300 * errno value. On success stores a pointer to the datapath in '*dpifp',
301 * otherwise a null pointer. */
303 dpif_create_and_open(const char *name, const char *type, struct dpif **dpifp)
307 error = dpif_create(name, type, dpifp);
308 if (error == EEXIST || error == EBUSY) {
309 error = dpif_open(name, type, dpifp);
311 VLOG_WARN("datapath %s already exists but cannot be opened: %s",
312 name, strerror(error));
315 VLOG_WARN("failed to create datapath %s: %s", name, strerror(error));
320 /* Closes and frees the connection to 'dpif'. Does not destroy the datapath
321 * itself; call dpif_delete() first, instead, if that is desirable. */
323 dpif_close(struct dpif *dpif)
326 struct registered_dpif_class *registered_class;
328 registered_class = shash_find_data(&dpif_classes,
329 dpif->dpif_class->type);
330 assert(registered_class);
331 assert(registered_class->refcount);
333 registered_class->refcount--;
334 dpif_uninit(dpif, true);
338 /* Performs periodic work needed by 'dpif'. */
340 dpif_run(struct dpif *dpif)
342 if (dpif->dpif_class->run) {
343 dpif->dpif_class->run(dpif);
347 /* Arranges for poll_block() to wake up when dp_run() needs to be called for
350 dpif_wait(struct dpif *dpif)
352 if (dpif->dpif_class->wait) {
353 dpif->dpif_class->wait(dpif);
357 /* Returns the name of datapath 'dpif' prefixed with the type
358 * (for use in log messages). */
360 dpif_name(const struct dpif *dpif)
362 return dpif->full_name;
365 /* Returns the name of datapath 'dpif' without the type
366 * (for use in device names). */
368 dpif_base_name(const struct dpif *dpif)
370 return dpif->base_name;
373 /* Returns the fully spelled out name for the given datapath 'type'.
375 * Normalized type string can be compared with strcmp(). Unnormalized type
376 * string might be the same even if they have different spellings. */
378 dpif_normalize_type(const char *type)
380 return type && type[0] ? type : "system";
383 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
384 * ports. After calling this function, it does not make sense to pass 'dpif'
385 * to any functions other than dpif_name() or dpif_close(). */
387 dpif_delete(struct dpif *dpif)
391 COVERAGE_INC(dpif_destroy);
393 error = dpif->dpif_class->destroy(dpif);
394 log_operation(dpif, "delete", error);
398 /* Retrieves statistics for 'dpif' into 'stats'. Returns 0 if successful,
399 * otherwise a positive errno value. */
401 dpif_get_dp_stats(const struct dpif *dpif, struct dpif_dp_stats *stats)
403 int error = dpif->dpif_class->get_stats(dpif, stats);
405 memset(stats, 0, sizeof *stats);
407 log_operation(dpif, "get_stats", error);
411 /* Attempts to add 'netdev' as a port on 'dpif'. If successful, returns 0 and
412 * sets '*port_nop' to the new port's port number (if 'port_nop' is non-null).
413 * On failure, returns a positive errno value and sets '*port_nop' to
414 * UINT16_MAX (if 'port_nop' is non-null). */
416 dpif_port_add(struct dpif *dpif, struct netdev *netdev, uint16_t *port_nop)
418 const char *netdev_name = netdev_get_name(netdev);
422 COVERAGE_INC(dpif_port_add);
424 error = dpif->dpif_class->port_add(dpif, netdev, &port_no);
426 VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu16,
427 dpif_name(dpif), netdev_name, port_no);
429 VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s",
430 dpif_name(dpif), netdev_name, strerror(error));
431 port_no = UINT16_MAX;
439 /* Attempts to remove 'dpif''s port number 'port_no'. Returns 0 if successful,
440 * otherwise a positive errno value. */
442 dpif_port_del(struct dpif *dpif, uint16_t port_no)
446 COVERAGE_INC(dpif_port_del);
448 error = dpif->dpif_class->port_del(dpif, port_no);
450 VLOG_DBG_RL(&dpmsg_rl, "%s: port_del(%"PRIu16")",
451 dpif_name(dpif), port_no);
453 log_operation(dpif, "port_del", error);
458 /* Makes a deep copy of 'src' into 'dst'. */
460 dpif_port_clone(struct dpif_port *dst, const struct dpif_port *src)
462 dst->name = xstrdup(src->name);
463 dst->type = xstrdup(src->type);
464 dst->port_no = src->port_no;
467 /* Frees memory allocated to members of 'dpif_port'.
469 * Do not call this function on a dpif_port obtained from
470 * dpif_port_dump_next(): that function retains ownership of the data in the
473 dpif_port_destroy(struct dpif_port *dpif_port)
475 free(dpif_port->name);
476 free(dpif_port->type);
479 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and
480 * initializes '*port' appropriately; on failure, returns a positive errno
483 * The caller owns the data in 'port' and must free it with
484 * dpif_port_destroy() when it is no longer needed. */
486 dpif_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
487 struct dpif_port *port)
489 int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port);
491 VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu16" is device %s",
492 dpif_name(dpif), port_no, port->name);
494 memset(port, 0, sizeof *port);
495 VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu16": %s",
496 dpif_name(dpif), port_no, strerror(error));
501 /* Looks up port named 'devname' in 'dpif'. On success, returns 0 and
502 * initializes '*port' appropriately; on failure, returns a positive errno
505 * The caller owns the data in 'port' and must free it with
506 * dpif_port_destroy() when it is no longer needed. */
508 dpif_port_query_by_name(const struct dpif *dpif, const char *devname,
509 struct dpif_port *port)
511 int error = dpif->dpif_class->port_query_by_name(dpif, devname, port);
513 VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu16,
514 dpif_name(dpif), devname, port->port_no);
516 memset(port, 0, sizeof *port);
518 /* For ENOENT or ENODEV we use DBG level because the caller is probably
519 * interested in whether 'dpif' actually has a port 'devname', so that
520 * it's not an issue worth logging if it doesn't. Other errors are
521 * uncommon and more likely to indicate a real problem. */
523 error == ENOENT || error == ENODEV ? VLL_DBG : VLL_WARN,
524 "%s: failed to query port %s: %s",
525 dpif_name(dpif), devname, strerror(error));
530 /* Returns one greater than the maximum port number accepted in flow
533 dpif_get_max_ports(const struct dpif *dpif)
535 return dpif->dpif_class->get_max_ports(dpif);
538 /* Returns the Netlink PID value to supply in OVS_ACTION_ATTR_USERSPACE actions
539 * as the OVS_USERSPACE_ATTR_PID attribute's value, for use in flows whose
540 * packets arrived on port 'port_no'.
542 * The return value is only meaningful when DPIF_UC_ACTION has been enabled in
543 * the 'dpif''s listen mask. It is allowed to change when DPIF_UC_ACTION is
544 * disabled and then re-enabled, so a client that does that must be prepared to
545 * update all of the flows that it installed that contain
546 * OVS_ACTION_ATTR_USERSPACE actions. */
548 dpif_port_get_pid(const struct dpif *dpif, uint16_t port_no)
550 return (dpif->dpif_class->port_get_pid
551 ? (dpif->dpif_class->port_get_pid)(dpif, port_no)
555 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and copies
556 * the port's name into the 'name_size' bytes in 'name', ensuring that the
557 * result is null-terminated. On failure, returns a positive errno value and
558 * makes 'name' the empty string. */
560 dpif_port_get_name(struct dpif *dpif, uint16_t port_no,
561 char *name, size_t name_size)
563 struct dpif_port port;
566 assert(name_size > 0);
568 error = dpif_port_query_by_number(dpif, port_no, &port);
570 ovs_strlcpy(name, port.name, name_size);
571 dpif_port_destroy(&port);
578 /* Initializes 'dump' to begin dumping the ports in a dpif.
580 * This function provides no status indication. An error status for the entire
581 * dump operation is provided when it is completed by calling
582 * dpif_port_dump_done().
585 dpif_port_dump_start(struct dpif_port_dump *dump, const struct dpif *dpif)
588 dump->error = dpif->dpif_class->port_dump_start(dpif, &dump->state);
589 log_operation(dpif, "port_dump_start", dump->error);
592 /* Attempts to retrieve another port from 'dump', which must have been
593 * initialized with dpif_port_dump_start(). On success, stores a new dpif_port
594 * into 'port' and returns true. On failure, returns false.
596 * Failure might indicate an actual error or merely that the last port has been
597 * dumped. An error status for the entire dump operation is provided when it
598 * is completed by calling dpif_port_dump_done().
600 * The dpif owns the data stored in 'port'. It will remain valid until at
601 * least the next time 'dump' is passed to dpif_port_dump_next() or
602 * dpif_port_dump_done(). */
604 dpif_port_dump_next(struct dpif_port_dump *dump, struct dpif_port *port)
606 const struct dpif *dpif = dump->dpif;
612 dump->error = dpif->dpif_class->port_dump_next(dpif, dump->state, port);
613 if (dump->error == EOF) {
614 VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all ports", dpif_name(dpif));
616 log_operation(dpif, "port_dump_next", dump->error);
620 dpif->dpif_class->port_dump_done(dpif, dump->state);
626 /* Completes port table dump operation 'dump', which must have been initialized
627 * with dpif_port_dump_start(). Returns 0 if the dump operation was
628 * error-free, otherwise a positive errno value describing the problem. */
630 dpif_port_dump_done(struct dpif_port_dump *dump)
632 const struct dpif *dpif = dump->dpif;
634 dump->error = dpif->dpif_class->port_dump_done(dpif, dump->state);
635 log_operation(dpif, "port_dump_done", dump->error);
637 return dump->error == EOF ? 0 : dump->error;
640 /* Polls for changes in the set of ports in 'dpif'. If the set of ports in
641 * 'dpif' has changed, this function does one of the following:
643 * - Stores the name of the device that was added to or deleted from 'dpif' in
644 * '*devnamep' and returns 0. The caller is responsible for freeing
645 * '*devnamep' (with free()) when it no longer needs it.
647 * - Returns ENOBUFS and sets '*devnamep' to NULL.
649 * This function may also return 'false positives', where it returns 0 and
650 * '*devnamep' names a device that was not actually added or deleted or it
651 * returns ENOBUFS without any change.
653 * Returns EAGAIN if the set of ports in 'dpif' has not changed. May also
654 * return other positive errno values to indicate that something has gone
657 dpif_port_poll(const struct dpif *dpif, char **devnamep)
659 int error = dpif->dpif_class->port_poll(dpif, devnamep);
666 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
667 * value other than EAGAIN. */
669 dpif_port_poll_wait(const struct dpif *dpif)
671 dpif->dpif_class->port_poll_wait(dpif);
674 /* Extracts the flow stats for a packet. The 'flow' and 'packet'
675 * arguments must have been initialized through a call to flow_extract().
678 dpif_flow_stats_extract(const struct flow *flow, const struct ofpbuf *packet,
679 struct dpif_flow_stats *stats)
681 memset(stats, 0, sizeof(*stats));
682 stats->tcp_flags = packet_get_tcp_flags(packet, flow);
683 stats->n_bytes = packet->size;
684 stats->n_packets = 1;
687 /* Appends a human-readable representation of 'stats' to 's'. */
689 dpif_flow_stats_format(const struct dpif_flow_stats *stats, struct ds *s)
691 ds_put_format(s, "packets:%"PRIu64", bytes:%"PRIu64", used:",
692 stats->n_packets, stats->n_bytes);
694 ds_put_format(s, "%.3fs", (time_msec() - stats->used) / 1000.0);
696 ds_put_format(s, "never");
701 /* Deletes all flows from 'dpif'. Returns 0 if successful, otherwise a
702 * positive errno value. */
704 dpif_flow_flush(struct dpif *dpif)
708 COVERAGE_INC(dpif_flow_flush);
710 error = dpif->dpif_class->flow_flush(dpif);
711 log_operation(dpif, "flow_flush", error);
715 /* Queries 'dpif' for a flow entry. The flow is specified by the Netlink
716 * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
719 * Returns 0 if successful. If no flow matches, returns ENOENT. On other
720 * failure, returns a positive errno value.
722 * If 'actionsp' is nonnull, then on success '*actionsp' will be set to an
723 * ofpbuf owned by the caller that contains the Netlink attributes for the
724 * flow's actions. The caller must free the ofpbuf (with ofpbuf_delete()) when
725 * it is no longer needed.
727 * If 'stats' is nonnull, then on success it will be updated with the flow's
730 dpif_flow_get(const struct dpif *dpif,
731 const struct nlattr *key, size_t key_len,
732 struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
736 COVERAGE_INC(dpif_flow_get);
738 error = dpif->dpif_class->flow_get(dpif, key, key_len, actionsp, stats);
744 memset(stats, 0, sizeof *stats);
747 if (should_log_flow_message(error)) {
748 const struct nlattr *actions;
751 if (!error && actionsp) {
752 actions = (*actionsp)->data;
753 actions_len = (*actionsp)->size;
758 log_flow_message(dpif, error, "flow_get", key, key_len, stats,
759 actions, actions_len);
765 dpif_flow_put__(struct dpif *dpif, const struct dpif_flow_put *put)
769 COVERAGE_INC(dpif_flow_put);
770 assert(!(put->flags & ~(DPIF_FP_CREATE | DPIF_FP_MODIFY
771 | DPIF_FP_ZERO_STATS)));
773 error = dpif->dpif_class->flow_put(dpif, put);
774 if (error && put->stats) {
775 memset(put->stats, 0, sizeof *put->stats);
777 log_flow_put_message(dpif, put, error);
781 /* Adds or modifies a flow in 'dpif'. The flow is specified by the Netlink
782 * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
783 * 'key'. The associated actions are specified by the Netlink attributes with
784 * types OVS_ACTION_ATTR_* in the 'actions_len' bytes starting at 'actions'.
786 * - If the flow's key does not exist in 'dpif', then the flow will be added if
787 * 'flags' includes DPIF_FP_CREATE. Otherwise the operation will fail with
790 * If the operation succeeds, then 'stats', if nonnull, will be zeroed.
792 * - If the flow's key does exist in 'dpif', then the flow's actions will be
793 * updated if 'flags' includes DPIF_FP_MODIFY. Otherwise the operation will
794 * fail with EEXIST. If the flow's actions are updated, then its statistics
795 * will be zeroed if 'flags' includes DPIF_FP_ZERO_STATS, and left as-is
798 * If the operation succeeds, then 'stats', if nonnull, will be set to the
799 * flow's statistics before the update.
802 dpif_flow_put(struct dpif *dpif, enum dpif_flow_put_flags flags,
803 const struct nlattr *key, size_t key_len,
804 const struct nlattr *actions, size_t actions_len,
805 struct dpif_flow_stats *stats)
807 struct dpif_flow_put put;
811 put.key_len = key_len;
812 put.actions = actions;
813 put.actions_len = actions_len;
815 return dpif_flow_put__(dpif, &put);
818 /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif' does
819 * not contain such a flow. The flow is specified by the Netlink attributes
820 * with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at 'key'.
822 * If the operation succeeds, then 'stats', if nonnull, will be set to the
823 * flow's statistics before its deletion. */
825 dpif_flow_del(struct dpif *dpif,
826 const struct nlattr *key, size_t key_len,
827 struct dpif_flow_stats *stats)
831 COVERAGE_INC(dpif_flow_del);
833 error = dpif->dpif_class->flow_del(dpif, key, key_len, stats);
834 if (error && stats) {
835 memset(stats, 0, sizeof *stats);
837 if (should_log_flow_message(error)) {
838 log_flow_message(dpif, error, "flow_del", key, key_len,
839 !error ? stats : NULL, NULL, 0);
844 /* Initializes 'dump' to begin dumping the flows in a dpif.
846 * This function provides no status indication. An error status for the entire
847 * dump operation is provided when it is completed by calling
848 * dpif_flow_dump_done().
851 dpif_flow_dump_start(struct dpif_flow_dump *dump, const struct dpif *dpif)
854 dump->error = dpif->dpif_class->flow_dump_start(dpif, &dump->state);
855 log_operation(dpif, "flow_dump_start", dump->error);
858 /* Attempts to retrieve another flow from 'dump', which must have been
859 * initialized with dpif_flow_dump_start(). On success, updates the output
860 * parameters as described below and returns true. Otherwise, returns false.
861 * Failure might indicate an actual error or merely the end of the flow table.
862 * An error status for the entire dump operation is provided when it is
863 * completed by calling dpif_flow_dump_done().
865 * On success, if 'key' and 'key_len' are nonnull then '*key' and '*key_len'
866 * will be set to Netlink attributes with types OVS_KEY_ATTR_* representing the
867 * dumped flow's key. If 'actions' and 'actions_len' are nonnull then they are
868 * set to Netlink attributes with types OVS_ACTION_ATTR_* representing the
869 * dumped flow's actions. If 'stats' is nonnull then it will be set to the
870 * dumped flow's statistics.
872 * All of the returned data is owned by 'dpif', not by the caller, and the
873 * caller must not modify or free it. 'dpif' guarantees that it remains
874 * accessible and unchanging until at least the next call to 'flow_dump_next'
875 * or 'flow_dump_done' for 'dump'. */
877 dpif_flow_dump_next(struct dpif_flow_dump *dump,
878 const struct nlattr **key, size_t *key_len,
879 const struct nlattr **actions, size_t *actions_len,
880 const struct dpif_flow_stats **stats)
882 const struct dpif *dpif = dump->dpif;
883 int error = dump->error;
886 error = dpif->dpif_class->flow_dump_next(dpif, dump->state,
888 actions, actions_len,
891 dpif->dpif_class->flow_dump_done(dpif, dump->state);
909 VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all flows", dpif_name(dpif));
910 } else if (should_log_flow_message(error)) {
911 log_flow_message(dpif, error, "flow_dump",
912 key ? *key : NULL, key ? *key_len : 0,
913 stats ? *stats : NULL, actions ? *actions : NULL,
914 actions ? *actions_len : 0);
921 /* Completes flow table dump operation 'dump', which must have been initialized
922 * with dpif_flow_dump_start(). Returns 0 if the dump operation was
923 * error-free, otherwise a positive errno value describing the problem. */
925 dpif_flow_dump_done(struct dpif_flow_dump *dump)
927 const struct dpif *dpif = dump->dpif;
929 dump->error = dpif->dpif_class->flow_dump_done(dpif, dump->state);
930 log_operation(dpif, "flow_dump_done", dump->error);
932 return dump->error == EOF ? 0 : dump->error;
936 dpif_execute__(struct dpif *dpif, const struct dpif_execute *execute)
940 COVERAGE_INC(dpif_execute);
941 if (execute->actions_len > 0) {
942 error = dpif->dpif_class->execute(dpif, execute);
947 log_execute_message(dpif, execute, error);
952 /* Causes 'dpif' to perform the 'actions_len' bytes of actions in 'actions' on
953 * the Ethernet frame specified in 'packet' taken from the flow specified in
954 * the 'key_len' bytes of 'key'. ('key' is mostly redundant with 'packet', but
955 * it contains some metadata that cannot be recovered from 'packet', such as
956 * tun_id and in_port.)
958 * Returns 0 if successful, otherwise a positive errno value. */
960 dpif_execute(struct dpif *dpif,
961 const struct nlattr *key, size_t key_len,
962 const struct nlattr *actions, size_t actions_len,
963 const struct ofpbuf *buf)
965 struct dpif_execute execute;
968 execute.key_len = key_len;
969 execute.actions = actions;
970 execute.actions_len = actions_len;
971 execute.packet = buf;
972 return dpif_execute__(dpif, &execute);
975 /* Executes each of the 'n_ops' operations in 'ops' on 'dpif', in the order in
976 * which they are specified, placing each operation's results in the "output"
977 * members documented in comments.
979 * This function exists because some datapaths can perform batched operations
980 * faster than individual operations. */
982 dpif_operate(struct dpif *dpif, struct dpif_op **ops, size_t n_ops)
986 if (dpif->dpif_class->operate) {
987 dpif->dpif_class->operate(dpif, ops, n_ops);
989 for (i = 0; i < n_ops; i++) {
990 struct dpif_op *op = ops[i];
993 case DPIF_OP_FLOW_PUT:
994 log_flow_put_message(dpif, &op->u.flow_put, op->error);
997 case DPIF_OP_EXECUTE:
998 log_execute_message(dpif, &op->u.execute, op->error);
1005 for (i = 0; i < n_ops; i++) {
1006 struct dpif_op *op = ops[i];
1009 case DPIF_OP_FLOW_PUT:
1010 op->error = dpif_flow_put__(dpif, &op->u.flow_put);
1013 case DPIF_OP_EXECUTE:
1014 op->error = dpif_execute__(dpif, &op->u.execute);
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 /* Enables or disables receiving packets with dpif_recv() on 'dpif'. Returns 0
1036 * if successful, otherwise a positive errno value.
1038 * Turning packet receive off and then back on may change the Netlink PID
1039 * assignments returned by dpif_port_get_pid(). If the client does this, it
1040 * must update all of the flows that have OVS_ACTION_ATTR_USERSPACE actions
1041 * using the new PID assignment. */
1043 dpif_recv_set(struct dpif *dpif, bool enable)
1045 int error = dpif->dpif_class->recv_set(dpif, enable);
1046 log_operation(dpif, "recv_set", error);
1050 /* Polls for an upcall from 'dpif'. If successful, stores the upcall into
1051 * '*upcall'. Should only be called if dpif_recv_set() has been used to enable
1052 * receiving packets on 'dpif'.
1054 * The caller takes ownership of the data that 'upcall' points to.
1055 * 'upcall->key' and 'upcall->actions' (if nonnull) point into data owned by
1056 * 'upcall->packet', so their memory cannot be freed separately. (This is
1057 * hardly a great way to do things but it works out OK for the dpif providers
1058 * and clients that exist so far.)
1060 * Returns 0 if successful, otherwise a positive errno value. Returns EAGAIN
1061 * if no upcall is immediately available. */
1063 dpif_recv(struct dpif *dpif, struct dpif_upcall *upcall)
1065 int error = dpif->dpif_class->recv(dpif, upcall);
1066 if (!error && !VLOG_DROP_DBG(&dpmsg_rl)) {
1070 packet = ofp_packet_to_string(upcall->packet->data,
1071 upcall->packet->size);
1074 odp_flow_key_format(upcall->key, upcall->key_len, &flow);
1076 VLOG_DBG("%s: %s upcall:\n%s\n%s",
1077 dpif_name(dpif), dpif_upcall_type_to_string(upcall->type),
1078 ds_cstr(&flow), packet);
1082 } else if (error && error != EAGAIN) {
1083 log_operation(dpif, "recv", error);
1088 /* Discards all messages that would otherwise be received by dpif_recv() on
1091 dpif_recv_purge(struct dpif *dpif)
1093 COVERAGE_INC(dpif_purge);
1094 if (dpif->dpif_class->recv_purge) {
1095 dpif->dpif_class->recv_purge(dpif);
1099 /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be
1100 * received with dpif_recv(). */
1102 dpif_recv_wait(struct dpif *dpif)
1104 dpif->dpif_class->recv_wait(dpif);
1107 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1108 * and '*engine_id', respectively. */
1110 dpif_get_netflow_ids(const struct dpif *dpif,
1111 uint8_t *engine_type, uint8_t *engine_id)
1113 *engine_type = dpif->netflow_engine_type;
1114 *engine_id = dpif->netflow_engine_id;
1117 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1118 * value used for setting packet priority.
1119 * On success, returns 0 and stores the priority into '*priority'.
1120 * On failure, returns a positive errno value and stores 0 into '*priority'. */
1122 dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id,
1125 int error = (dpif->dpif_class->queue_to_priority
1126 ? dpif->dpif_class->queue_to_priority(dpif, queue_id,
1132 log_operation(dpif, "queue_to_priority", error);
1137 dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class,
1139 uint8_t netflow_engine_type, uint8_t netflow_engine_id)
1141 dpif->dpif_class = dpif_class;
1142 dpif->base_name = xstrdup(name);
1143 dpif->full_name = xasprintf("%s@%s", dpif_class->type, name);
1144 dpif->netflow_engine_type = netflow_engine_type;
1145 dpif->netflow_engine_id = netflow_engine_id;
1148 /* Undoes the results of initialization.
1150 * Normally this function only needs to be called from dpif_close().
1151 * However, it may be called by providers due to an error on opening
1152 * that occurs after initialization. It this case dpif_close() would
1153 * never be called. */
1155 dpif_uninit(struct dpif *dpif, bool close)
1157 char *base_name = dpif->base_name;
1158 char *full_name = dpif->full_name;
1161 dpif->dpif_class->close(dpif);
1169 log_operation(const struct dpif *dpif, const char *operation, int error)
1172 VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation);
1173 } else if (ofperr_is_valid(error)) {
1174 VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1175 dpif_name(dpif), operation, ofperr_get_name(error));
1177 VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1178 dpif_name(dpif), operation, strerror(error));
1182 static enum vlog_level
1183 flow_message_log_level(int error)
1185 return error ? VLL_WARN : VLL_DBG;
1189 should_log_flow_message(int error)
1191 return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error),
1192 error ? &error_rl : &dpmsg_rl);
1196 log_flow_message(const struct dpif *dpif, int error, const char *operation,
1197 const struct nlattr *key, size_t key_len,
1198 const struct dpif_flow_stats *stats,
1199 const struct nlattr *actions, size_t actions_len)
1201 struct ds ds = DS_EMPTY_INITIALIZER;
1202 ds_put_format(&ds, "%s: ", dpif_name(dpif));
1204 ds_put_cstr(&ds, "failed to ");
1206 ds_put_format(&ds, "%s ", operation);
1208 ds_put_format(&ds, "(%s) ", strerror(error));
1210 odp_flow_key_format(key, key_len, &ds);
1212 ds_put_cstr(&ds, ", ");
1213 dpif_flow_stats_format(stats, &ds);
1215 if (actions || actions_len) {
1216 ds_put_cstr(&ds, ", actions:");
1217 format_odp_actions(&ds, actions, actions_len);
1219 vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds));
1224 log_flow_put_message(struct dpif *dpif, const struct dpif_flow_put *put,
1227 if (should_log_flow_message(error)) {
1231 ds_put_cstr(&s, "put");
1232 if (put->flags & DPIF_FP_CREATE) {
1233 ds_put_cstr(&s, "[create]");
1235 if (put->flags & DPIF_FP_MODIFY) {
1236 ds_put_cstr(&s, "[modify]");
1238 if (put->flags & DPIF_FP_ZERO_STATS) {
1239 ds_put_cstr(&s, "[zero]");
1241 log_flow_message(dpif, error, ds_cstr(&s),
1242 put->key, put->key_len, put->stats,
1243 put->actions, put->actions_len);
1249 log_execute_message(struct dpif *dpif, const struct dpif_execute *execute,
1252 if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) {
1253 struct ds ds = DS_EMPTY_INITIALIZER;
1256 packet = ofp_packet_to_string(execute->packet->data,
1257 execute->packet->size);
1258 ds_put_format(&ds, "%s: execute ", dpif_name(dpif));
1259 format_odp_actions(&ds, execute->actions, execute->actions_len);
1261 ds_put_format(&ds, " failed (%s)", strerror(error));
1263 ds_put_format(&ds, " on packet %s", packet);
1264 vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));