2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 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"
27 #include "dynamic-string.h"
31 #include "odp-execute.h"
33 #include "ofp-errors.h"
34 #include "ofp-print.h"
37 #include "packet-dpif.h"
39 #include "poll-loop.h"
47 VLOG_DEFINE_THIS_MODULE(dpif);
49 COVERAGE_DEFINE(dpif_destroy);
50 COVERAGE_DEFINE(dpif_port_add);
51 COVERAGE_DEFINE(dpif_port_del);
52 COVERAGE_DEFINE(dpif_flow_flush);
53 COVERAGE_DEFINE(dpif_flow_get);
54 COVERAGE_DEFINE(dpif_flow_put);
55 COVERAGE_DEFINE(dpif_flow_del);
56 COVERAGE_DEFINE(dpif_execute);
57 COVERAGE_DEFINE(dpif_purge);
58 COVERAGE_DEFINE(dpif_execute_with_help);
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 /* Protects 'dpif_classes', including the refcount, and 'dpif_blacklist'. */
75 static struct ovs_mutex dpif_mutex = OVS_MUTEX_INITIALIZER;
77 /* Rate limit for individual messages going to or from the datapath, output at
78 * DBG level. This is very high because, if these are enabled, it is because
79 * we really need to see them. */
80 static struct vlog_rate_limit dpmsg_rl = VLOG_RATE_LIMIT_INIT(600, 600);
82 /* Not really much point in logging many dpif errors. */
83 static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(60, 5);
85 static void log_flow_message(const struct dpif *dpif, int error,
86 const char *operation,
87 const struct nlattr *key, size_t key_len,
88 const struct nlattr *mask, size_t mask_len,
89 const struct dpif_flow_stats *stats,
90 const struct nlattr *actions, size_t actions_len);
91 static void log_operation(const struct dpif *, const char *operation,
93 static bool should_log_flow_message(int error);
94 static void log_flow_put_message(struct dpif *, const struct dpif_flow_put *,
96 static void log_flow_del_message(struct dpif *, const struct dpif_flow_del *,
98 static void log_execute_message(struct dpif *, const struct dpif_execute *,
99 bool subexecute, int error);
104 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
106 if (ovsthread_once_start(&once)) {
109 for (i = 0; i < ARRAY_SIZE(base_dpif_classes); i++) {
110 dp_register_provider(base_dpif_classes[i]);
112 ovsthread_once_done(&once);
117 dp_register_provider__(const struct dpif_class *new_class)
119 struct registered_dpif_class *registered_class;
121 if (sset_contains(&dpif_blacklist, new_class->type)) {
122 VLOG_DBG("attempted to register blacklisted provider: %s",
127 if (shash_find(&dpif_classes, new_class->type)) {
128 VLOG_WARN("attempted to register duplicate datapath provider: %s",
133 registered_class = xmalloc(sizeof *registered_class);
134 registered_class->dpif_class = new_class;
135 registered_class->refcount = 0;
137 shash_add(&dpif_classes, new_class->type, registered_class);
142 /* Registers a new datapath provider. After successful registration, new
143 * datapaths of that type can be opened using dpif_open(). */
145 dp_register_provider(const struct dpif_class *new_class)
149 ovs_mutex_lock(&dpif_mutex);
150 error = dp_register_provider__(new_class);
151 ovs_mutex_unlock(&dpif_mutex);
156 /* Unregisters a datapath provider. 'type' must have been previously
157 * registered and not currently be in use by any dpifs. After unregistration
158 * new datapaths of that type cannot be opened using dpif_open(). */
160 dp_unregister_provider__(const char *type)
162 struct shash_node *node;
163 struct registered_dpif_class *registered_class;
165 node = shash_find(&dpif_classes, type);
167 VLOG_WARN("attempted to unregister a datapath provider that is not "
168 "registered: %s", type);
172 registered_class = node->data;
173 if (registered_class->refcount) {
174 VLOG_WARN("attempted to unregister in use datapath provider: %s", type);
178 shash_delete(&dpif_classes, node);
179 free(registered_class);
184 /* Unregisters a datapath provider. 'type' must have been previously
185 * registered and not currently be in use by any dpifs. After unregistration
186 * new datapaths of that type cannot be opened using dpif_open(). */
188 dp_unregister_provider(const char *type)
194 ovs_mutex_lock(&dpif_mutex);
195 error = dp_unregister_provider__(type);
196 ovs_mutex_unlock(&dpif_mutex);
201 /* Blacklists a provider. Causes future calls of dp_register_provider() with
202 * a dpif_class which implements 'type' to fail. */
204 dp_blacklist_provider(const char *type)
206 ovs_mutex_lock(&dpif_mutex);
207 sset_add(&dpif_blacklist, type);
208 ovs_mutex_unlock(&dpif_mutex);
211 /* Clears 'types' and enumerates the types of all currently registered datapath
212 * providers into it. The caller must first initialize the sset. */
214 dp_enumerate_types(struct sset *types)
216 struct shash_node *node;
221 ovs_mutex_lock(&dpif_mutex);
222 SHASH_FOR_EACH(node, &dpif_classes) {
223 const struct registered_dpif_class *registered_class = node->data;
224 sset_add(types, registered_class->dpif_class->type);
226 ovs_mutex_unlock(&dpif_mutex);
230 dp_class_unref(struct registered_dpif_class *rc)
232 ovs_mutex_lock(&dpif_mutex);
233 ovs_assert(rc->refcount);
235 ovs_mutex_unlock(&dpif_mutex);
238 static struct registered_dpif_class *
239 dp_class_lookup(const char *type)
241 struct registered_dpif_class *rc;
243 ovs_mutex_lock(&dpif_mutex);
244 rc = shash_find_data(&dpif_classes, type);
248 ovs_mutex_unlock(&dpif_mutex);
253 /* Clears 'names' and enumerates the names of all known created datapaths with
254 * the given 'type'. The caller must first initialize the sset. Returns 0 if
255 * successful, otherwise a positive errno value.
257 * Some kinds of datapaths might not be practically enumerable. This is not
258 * considered an error. */
260 dp_enumerate_names(const char *type, struct sset *names)
262 struct registered_dpif_class *registered_class;
263 const struct dpif_class *dpif_class;
269 registered_class = dp_class_lookup(type);
270 if (!registered_class) {
271 VLOG_WARN("could not enumerate unknown type: %s", type);
275 dpif_class = registered_class->dpif_class;
276 error = (dpif_class->enumerate
277 ? dpif_class->enumerate(names, dpif_class)
280 VLOG_WARN("failed to enumerate %s datapaths: %s", dpif_class->type,
281 ovs_strerror(error));
283 dp_class_unref(registered_class);
288 /* Parses 'datapath_name_', which is of the form [type@]name into its
289 * component pieces. 'name' and 'type' must be freed by the caller.
291 * The returned 'type' is normalized, as if by dpif_normalize_type(). */
293 dp_parse_name(const char *datapath_name_, char **name, char **type)
295 char *datapath_name = xstrdup(datapath_name_);
298 separator = strchr(datapath_name, '@');
301 *type = datapath_name;
302 *name = xstrdup(dpif_normalize_type(separator + 1));
304 *name = datapath_name;
305 *type = xstrdup(dpif_normalize_type(NULL));
310 do_open(const char *name, const char *type, bool create, struct dpif **dpifp)
312 struct dpif *dpif = NULL;
314 struct registered_dpif_class *registered_class;
318 type = dpif_normalize_type(type);
319 registered_class = dp_class_lookup(type);
320 if (!registered_class) {
321 VLOG_WARN("could not create datapath %s of unknown type %s", name,
323 error = EAFNOSUPPORT;
327 error = registered_class->dpif_class->open(registered_class->dpif_class,
328 name, create, &dpif);
330 ovs_assert(dpif->dpif_class == registered_class->dpif_class);
332 dp_class_unref(registered_class);
336 *dpifp = error ? NULL : dpif;
340 /* Tries to open an existing datapath named 'name' and type 'type'. Will fail
341 * if no datapath with 'name' and 'type' exists. 'type' may be either NULL or
342 * the empty string to specify the default system type. Returns 0 if
343 * successful, otherwise a positive errno value. On success stores a pointer
344 * to the datapath in '*dpifp', otherwise a null pointer. */
346 dpif_open(const char *name, const char *type, struct dpif **dpifp)
348 return do_open(name, type, false, dpifp);
351 /* Tries to create and open a new datapath with the given 'name' and 'type'.
352 * 'type' may be either NULL or the empty string to specify the default system
353 * type. Will fail if a datapath with 'name' and 'type' already exists.
354 * Returns 0 if successful, otherwise a positive errno value. On success
355 * stores a pointer to the datapath in '*dpifp', otherwise a null pointer. */
357 dpif_create(const char *name, const char *type, struct dpif **dpifp)
359 return do_open(name, type, true, dpifp);
362 /* Tries to open a datapath with the given 'name' and 'type', creating it if it
363 * does not exist. 'type' may be either NULL or the empty string to specify
364 * the default system type. Returns 0 if successful, otherwise a positive
365 * errno value. On success stores a pointer to the datapath in '*dpifp',
366 * otherwise a null pointer. */
368 dpif_create_and_open(const char *name, const char *type, struct dpif **dpifp)
372 error = dpif_create(name, type, dpifp);
373 if (error == EEXIST || error == EBUSY) {
374 error = dpif_open(name, type, dpifp);
376 VLOG_WARN("datapath %s already exists but cannot be opened: %s",
377 name, ovs_strerror(error));
380 VLOG_WARN("failed to create datapath %s: %s",
381 name, ovs_strerror(error));
386 /* Closes and frees the connection to 'dpif'. Does not destroy the datapath
387 * itself; call dpif_delete() first, instead, if that is desirable. */
389 dpif_close(struct dpif *dpif)
392 struct registered_dpif_class *rc;
394 rc = shash_find_data(&dpif_classes, dpif->dpif_class->type);
395 dpif_uninit(dpif, true);
400 /* Performs periodic work needed by 'dpif'. */
402 dpif_run(struct dpif *dpif)
404 if (dpif->dpif_class->run) {
405 dpif->dpif_class->run(dpif);
409 /* Arranges for poll_block() to wake up when dp_run() needs to be called for
412 dpif_wait(struct dpif *dpif)
414 if (dpif->dpif_class->wait) {
415 dpif->dpif_class->wait(dpif);
419 /* Returns the name of datapath 'dpif' prefixed with the type
420 * (for use in log messages). */
422 dpif_name(const struct dpif *dpif)
424 return dpif->full_name;
427 /* Returns the name of datapath 'dpif' without the type
428 * (for use in device names). */
430 dpif_base_name(const struct dpif *dpif)
432 return dpif->base_name;
435 /* Returns the type of datapath 'dpif'. */
437 dpif_type(const struct dpif *dpif)
439 return dpif->dpif_class->type;
442 /* Returns the fully spelled out name for the given datapath 'type'.
444 * Normalized type string can be compared with strcmp(). Unnormalized type
445 * string might be the same even if they have different spellings. */
447 dpif_normalize_type(const char *type)
449 return type && type[0] ? type : "system";
452 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
453 * ports. After calling this function, it does not make sense to pass 'dpif'
454 * to any functions other than dpif_name() or dpif_close(). */
456 dpif_delete(struct dpif *dpif)
460 COVERAGE_INC(dpif_destroy);
462 error = dpif->dpif_class->destroy(dpif);
463 log_operation(dpif, "delete", error);
467 /* Retrieves statistics for 'dpif' into 'stats'. Returns 0 if successful,
468 * otherwise a positive errno value. */
470 dpif_get_dp_stats(const struct dpif *dpif, struct dpif_dp_stats *stats)
472 int error = dpif->dpif_class->get_stats(dpif, stats);
474 memset(stats, 0, sizeof *stats);
476 log_operation(dpif, "get_stats", error);
481 dpif_port_open_type(const char *datapath_type, const char *port_type)
483 struct registered_dpif_class *rc;
485 datapath_type = dpif_normalize_type(datapath_type);
487 ovs_mutex_lock(&dpif_mutex);
488 rc = shash_find_data(&dpif_classes, datapath_type);
489 if (rc && rc->dpif_class->port_open_type) {
490 port_type = rc->dpif_class->port_open_type(rc->dpif_class, port_type);
492 ovs_mutex_unlock(&dpif_mutex);
497 /* Attempts to add 'netdev' as a port on 'dpif'. If 'port_nop' is
498 * non-null and its value is not ODPP_NONE, then attempts to use the
499 * value as the port number.
501 * If successful, returns 0 and sets '*port_nop' to the new port's port
502 * number (if 'port_nop' is non-null). On failure, returns a positive
503 * errno value and sets '*port_nop' to ODPP_NONE (if 'port_nop' is
506 dpif_port_add(struct dpif *dpif, struct netdev *netdev, odp_port_t *port_nop)
508 const char *netdev_name = netdev_get_name(netdev);
509 odp_port_t port_no = ODPP_NONE;
512 COVERAGE_INC(dpif_port_add);
518 error = dpif->dpif_class->port_add(dpif, netdev, &port_no);
520 VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu32,
521 dpif_name(dpif), netdev_name, port_no);
523 VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s",
524 dpif_name(dpif), netdev_name, ovs_strerror(error));
533 /* Attempts to remove 'dpif''s port number 'port_no'. Returns 0 if successful,
534 * otherwise a positive errno value. */
536 dpif_port_del(struct dpif *dpif, odp_port_t port_no)
540 COVERAGE_INC(dpif_port_del);
542 error = dpif->dpif_class->port_del(dpif, port_no);
544 VLOG_DBG_RL(&dpmsg_rl, "%s: port_del(%"PRIu32")",
545 dpif_name(dpif), port_no);
547 log_operation(dpif, "port_del", error);
552 /* Makes a deep copy of 'src' into 'dst'. */
554 dpif_port_clone(struct dpif_port *dst, const struct dpif_port *src)
556 dst->name = xstrdup(src->name);
557 dst->type = xstrdup(src->type);
558 dst->port_no = src->port_no;
561 /* Frees memory allocated to members of 'dpif_port'.
563 * Do not call this function on a dpif_port obtained from
564 * dpif_port_dump_next(): that function retains ownership of the data in the
567 dpif_port_destroy(struct dpif_port *dpif_port)
569 free(dpif_port->name);
570 free(dpif_port->type);
573 /* Checks if port named 'devname' exists in 'dpif'. If so, returns
574 * true; otherwise, returns false. */
576 dpif_port_exists(const struct dpif *dpif, const char *devname)
578 int error = dpif->dpif_class->port_query_by_name(dpif, devname, NULL);
579 if (error != 0 && error != ENOENT && error != ENODEV) {
580 VLOG_WARN_RL(&error_rl, "%s: failed to query port %s: %s",
581 dpif_name(dpif), devname, ovs_strerror(error));
587 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and
588 * initializes '*port' appropriately; on failure, returns a positive errno
591 * The caller owns the data in 'port' and must free it with
592 * dpif_port_destroy() when it is no longer needed. */
594 dpif_port_query_by_number(const struct dpif *dpif, odp_port_t port_no,
595 struct dpif_port *port)
597 int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port);
599 VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu32" is device %s",
600 dpif_name(dpif), port_no, port->name);
602 memset(port, 0, sizeof *port);
603 VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu32": %s",
604 dpif_name(dpif), port_no, ovs_strerror(error));
609 /* Looks up port named 'devname' in 'dpif'. On success, returns 0 and
610 * initializes '*port' appropriately; on failure, returns a positive errno
613 * The caller owns the data in 'port' and must free it with
614 * dpif_port_destroy() when it is no longer needed. */
616 dpif_port_query_by_name(const struct dpif *dpif, const char *devname,
617 struct dpif_port *port)
619 int error = dpif->dpif_class->port_query_by_name(dpif, devname, port);
621 VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu32,
622 dpif_name(dpif), devname, port->port_no);
624 memset(port, 0, sizeof *port);
626 /* For ENOENT or ENODEV we use DBG level because the caller is probably
627 * interested in whether 'dpif' actually has a port 'devname', so that
628 * it's not an issue worth logging if it doesn't. Other errors are
629 * uncommon and more likely to indicate a real problem. */
631 error == ENOENT || error == ENODEV ? VLL_DBG : VLL_WARN,
632 "%s: failed to query port %s: %s",
633 dpif_name(dpif), devname, ovs_strerror(error));
638 /* Returns the Netlink PID value to supply in OVS_ACTION_ATTR_USERSPACE
639 * actions as the OVS_USERSPACE_ATTR_PID attribute's value, for use in
640 * flows whose packets arrived on port 'port_no'. In the case where the
641 * provider allocates multiple Netlink PIDs to a single port, it may use
642 * 'hash' to spread load among them. The caller need not use a particular
643 * hash function; a 5-tuple hash is suitable.
645 * (The datapath implementation might use some different hash function for
646 * distributing packets received via flow misses among PIDs. This means
647 * that packets received via flow misses might be reordered relative to
648 * packets received via userspace actions. This is not ordinarily a
651 * A 'port_no' of ODPP_NONE is a special case: it returns a reserved PID, not
652 * allocated to any port, that the client may use for special purposes.
654 * The return value is only meaningful when DPIF_UC_ACTION has been enabled in
655 * the 'dpif''s listen mask. It is allowed to change when DPIF_UC_ACTION is
656 * disabled and then re-enabled, so a client that does that must be prepared to
657 * update all of the flows that it installed that contain
658 * OVS_ACTION_ATTR_USERSPACE actions. */
660 dpif_port_get_pid(const struct dpif *dpif, odp_port_t port_no, uint32_t hash)
662 return (dpif->dpif_class->port_get_pid
663 ? (dpif->dpif_class->port_get_pid)(dpif, port_no, hash)
667 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and copies
668 * the port's name into the 'name_size' bytes in 'name', ensuring that the
669 * result is null-terminated. On failure, returns a positive errno value and
670 * makes 'name' the empty string. */
672 dpif_port_get_name(struct dpif *dpif, odp_port_t port_no,
673 char *name, size_t name_size)
675 struct dpif_port port;
678 ovs_assert(name_size > 0);
680 error = dpif_port_query_by_number(dpif, port_no, &port);
682 ovs_strlcpy(name, port.name, name_size);
683 dpif_port_destroy(&port);
690 /* Initializes 'dump' to begin dumping the ports in a dpif.
692 * This function provides no status indication. An error status for the entire
693 * dump operation is provided when it is completed by calling
694 * dpif_port_dump_done().
697 dpif_port_dump_start(struct dpif_port_dump *dump, const struct dpif *dpif)
700 dump->error = dpif->dpif_class->port_dump_start(dpif, &dump->state);
701 log_operation(dpif, "port_dump_start", dump->error);
704 /* Attempts to retrieve another port from 'dump', which must have been
705 * initialized with dpif_port_dump_start(). On success, stores a new dpif_port
706 * into 'port' and returns true. On failure, returns false.
708 * Failure might indicate an actual error or merely that the last port has been
709 * dumped. An error status for the entire dump operation is provided when it
710 * is completed by calling dpif_port_dump_done().
712 * The dpif owns the data stored in 'port'. It will remain valid until at
713 * least the next time 'dump' is passed to dpif_port_dump_next() or
714 * dpif_port_dump_done(). */
716 dpif_port_dump_next(struct dpif_port_dump *dump, struct dpif_port *port)
718 const struct dpif *dpif = dump->dpif;
724 dump->error = dpif->dpif_class->port_dump_next(dpif, dump->state, port);
725 if (dump->error == EOF) {
726 VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all ports", dpif_name(dpif));
728 log_operation(dpif, "port_dump_next", dump->error);
732 dpif->dpif_class->port_dump_done(dpif, dump->state);
738 /* Completes port table dump operation 'dump', which must have been initialized
739 * with dpif_port_dump_start(). Returns 0 if the dump operation was
740 * error-free, otherwise a positive errno value describing the problem. */
742 dpif_port_dump_done(struct dpif_port_dump *dump)
744 const struct dpif *dpif = dump->dpif;
746 dump->error = dpif->dpif_class->port_dump_done(dpif, dump->state);
747 log_operation(dpif, "port_dump_done", dump->error);
749 return dump->error == EOF ? 0 : dump->error;
752 /* Polls for changes in the set of ports in 'dpif'. If the set of ports in
753 * 'dpif' has changed, this function does one of the following:
755 * - Stores the name of the device that was added to or deleted from 'dpif' in
756 * '*devnamep' and returns 0. The caller is responsible for freeing
757 * '*devnamep' (with free()) when it no longer needs it.
759 * - Returns ENOBUFS and sets '*devnamep' to NULL.
761 * This function may also return 'false positives', where it returns 0 and
762 * '*devnamep' names a device that was not actually added or deleted or it
763 * returns ENOBUFS without any change.
765 * Returns EAGAIN if the set of ports in 'dpif' has not changed. May also
766 * return other positive errno values to indicate that something has gone
769 dpif_port_poll(const struct dpif *dpif, char **devnamep)
771 int error = dpif->dpif_class->port_poll(dpif, devnamep);
778 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
779 * value other than EAGAIN. */
781 dpif_port_poll_wait(const struct dpif *dpif)
783 dpif->dpif_class->port_poll_wait(dpif);
786 /* Extracts the flow stats for a packet. The 'flow' and 'packet'
787 * arguments must have been initialized through a call to flow_extract().
788 * 'used' is stored into stats->used. */
790 dpif_flow_stats_extract(const struct flow *flow, const struct ofpbuf *packet,
791 long long int used, struct dpif_flow_stats *stats)
793 stats->tcp_flags = ntohs(flow->tcp_flags);
794 stats->n_bytes = ofpbuf_size(packet);
795 stats->n_packets = 1;
799 /* Appends a human-readable representation of 'stats' to 's'. */
801 dpif_flow_stats_format(const struct dpif_flow_stats *stats, struct ds *s)
803 ds_put_format(s, "packets:%"PRIu64", bytes:%"PRIu64", used:",
804 stats->n_packets, stats->n_bytes);
806 ds_put_format(s, "%.3fs", (time_msec() - stats->used) / 1000.0);
808 ds_put_format(s, "never");
810 if (stats->tcp_flags) {
811 ds_put_cstr(s, ", flags:");
812 packet_format_tcp_flags(s, stats->tcp_flags);
816 /* Deletes all flows from 'dpif'. Returns 0 if successful, otherwise a
817 * positive errno value. */
819 dpif_flow_flush(struct dpif *dpif)
823 COVERAGE_INC(dpif_flow_flush);
825 error = dpif->dpif_class->flow_flush(dpif);
826 log_operation(dpif, "flow_flush", error);
830 /* Queries 'dpif' for a flow entry. The flow is specified by the Netlink
831 * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
834 * Returns 0 if successful. If no flow matches, returns ENOENT. On other
835 * failure, returns a positive errno value.
837 * On success, '*bufp' will be set to an ofpbuf owned by the caller that
838 * contains the response for 'flow->mask' and 'flow->actions'. The caller must
839 * supply a valid pointer, and must free the ofpbuf (with ofpbuf_delete()) when
840 * it is no longer needed.
842 * On success, 'flow' will be populated with the mask, actions and stats for
843 * the datapath flow corresponding to 'key'. The mask and actions will point
846 * Implementations may opt to point 'flow->mask' and/or 'flow->actions' at
847 * RCU-protected data rather than making a copy of them. Therefore, callers
848 * that wish to hold these over quiescent periods must make a copy of these
849 * fields before quiescing. */
851 dpif_flow_get(const struct dpif *dpif,
852 const struct nlattr *key, size_t key_len,
853 struct ofpbuf **bufp, struct dpif_flow *flow)
856 struct nlattr *mask, *actions;
857 size_t mask_len, actions_len;
858 struct dpif_flow_stats stats;
860 COVERAGE_INC(dpif_flow_get);
863 error = dpif->dpif_class->flow_get(dpif, key, key_len, bufp,
865 &actions, &actions_len, &stats);
867 memset(flow, 0, sizeof *flow);
868 ofpbuf_delete(*bufp);
872 flow->mask_len = mask_len;
873 flow->actions = actions;
874 flow->actions_len = actions_len;
877 if (should_log_flow_message(error)) {
878 log_flow_message(dpif, error, "flow_get", key, key_len,
879 NULL, 0, &flow->stats,
880 flow->actions, flow->actions_len);
886 dpif_flow_put__(struct dpif *dpif, const struct dpif_flow_put *put)
890 COVERAGE_INC(dpif_flow_put);
891 ovs_assert(!(put->flags & ~(DPIF_FP_CREATE | DPIF_FP_MODIFY
892 | DPIF_FP_ZERO_STATS)));
894 error = dpif->dpif_class->flow_put(dpif, put);
895 if (error && put->stats) {
896 memset(put->stats, 0, sizeof *put->stats);
898 log_flow_put_message(dpif, put, error);
902 /* Adds or modifies a flow in 'dpif'. The flow is specified by the Netlink
903 * attribute OVS_FLOW_ATTR_KEY with types OVS_KEY_ATTR_* in the 'key_len' bytes
904 * starting at 'key', and OVS_FLOW_ATTR_MASK with types of OVS_KEY_ATTR_* in
905 * the 'mask_len' bytes starting at 'mask'. The associated actions are
906 * specified by the Netlink attributes with types OVS_ACTION_ATTR_* in the
907 * 'actions_len' bytes starting at 'actions'.
909 * - If the flow's key does not exist in 'dpif', then the flow will be added if
910 * 'flags' includes DPIF_FP_CREATE. Otherwise the operation will fail with
913 * The datapath may reject attempts to insert overlapping flows with EINVAL
914 * or EEXIST, but clients should not rely on this: avoiding overlapping flows
915 * is primarily the client's responsibility.
917 * If the operation succeeds, then 'stats', if nonnull, will be zeroed.
919 * - If the flow's key does exist in 'dpif', then the flow's actions will be
920 * updated if 'flags' includes DPIF_FP_MODIFY. Otherwise the operation will
921 * fail with EEXIST. If the flow's actions are updated, then its statistics
922 * will be zeroed if 'flags' includes DPIF_FP_ZERO_STATS, and left as-is
925 * If the operation succeeds, then 'stats', if nonnull, will be set to the
926 * flow's statistics before the update.
929 dpif_flow_put(struct dpif *dpif, enum dpif_flow_put_flags flags,
930 const struct nlattr *key, size_t key_len,
931 const struct nlattr *mask, size_t mask_len,
932 const struct nlattr *actions, size_t actions_len,
933 struct dpif_flow_stats *stats)
935 struct dpif_flow_put put;
939 put.key_len = key_len;
941 put.mask_len = mask_len;
942 put.actions = actions;
943 put.actions_len = actions_len;
945 return dpif_flow_put__(dpif, &put);
949 dpif_flow_del__(struct dpif *dpif, struct dpif_flow_del *del)
953 COVERAGE_INC(dpif_flow_del);
955 error = dpif->dpif_class->flow_del(dpif, del);
956 if (error && del->stats) {
957 memset(del->stats, 0, sizeof *del->stats);
959 log_flow_del_message(dpif, del, error);
963 /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif' does
964 * not contain such a flow. The flow is specified by the Netlink attributes
965 * with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at 'key'.
967 * If the operation succeeds, then 'stats', if nonnull, will be set to the
968 * flow's statistics before its deletion. */
970 dpif_flow_del(struct dpif *dpif,
971 const struct nlattr *key, size_t key_len,
972 struct dpif_flow_stats *stats)
974 struct dpif_flow_del del;
977 del.key_len = key_len;
979 return dpif_flow_del__(dpif, &del);
982 /* Creates and returns a new 'struct dpif_flow_dump' for iterating through the
985 * This function always successfully returns a dpif_flow_dump. Error
986 * reporting is deferred to dpif_flow_dump_destroy(). */
987 struct dpif_flow_dump *
988 dpif_flow_dump_create(const struct dpif *dpif)
990 return dpif->dpif_class->flow_dump_create(dpif);
993 /* Destroys 'dump', which must have been created with dpif_flow_dump_create().
994 * All dpif_flow_dump_thread structures previously created for 'dump' must
995 * previously have been destroyed.
997 * Returns 0 if the dump operation was error-free, otherwise a positive errno
998 * value describing the problem. */
1000 dpif_flow_dump_destroy(struct dpif_flow_dump *dump)
1002 const struct dpif *dpif = dump->dpif;
1003 int error = dpif->dpif_class->flow_dump_destroy(dump);
1004 log_operation(dpif, "flow_dump_destroy", error);
1005 return error == EOF ? 0 : error;
1008 /* Returns new thread-local state for use with dpif_flow_dump_next(). */
1009 struct dpif_flow_dump_thread *
1010 dpif_flow_dump_thread_create(struct dpif_flow_dump *dump)
1012 return dump->dpif->dpif_class->flow_dump_thread_create(dump);
1015 /* Releases 'thread'. */
1017 dpif_flow_dump_thread_destroy(struct dpif_flow_dump_thread *thread)
1019 thread->dpif->dpif_class->flow_dump_thread_destroy(thread);
1022 /* Attempts to retrieve up to 'max_flows' more flows from 'thread'. Returns 0
1023 * if and only if no flows remained to be retrieved, otherwise a positive
1024 * number reflecting the number of elements in 'flows[]' that were updated.
1025 * The number of flows returned might be less than 'max_flows' because
1026 * fewer than 'max_flows' remained, because this particular datapath does not
1027 * benefit from batching, or because an error occurred partway through
1028 * retrieval. Thus, the caller should continue calling until a 0 return value,
1029 * even if intermediate return values are less than 'max_flows'.
1031 * No error status is immediately provided. An error status for the entire
1032 * dump operation is provided when it is completed by calling
1033 * dpif_flow_dump_destroy().
1035 * All of the data stored into 'flows' is owned by the datapath, not by the
1036 * caller, and the caller must not modify or free it. The datapath guarantees
1037 * that it remains accessible and unchanged until the first of:
1038 * - The next call to dpif_flow_dump_next() for 'thread', or
1039 * - The next rcu quiescent period. */
1041 dpif_flow_dump_next(struct dpif_flow_dump_thread *thread,
1042 struct dpif_flow *flows, int max_flows)
1044 struct dpif *dpif = thread->dpif;
1047 ovs_assert(max_flows > 0);
1048 n = dpif->dpif_class->flow_dump_next(thread, flows, max_flows);
1050 struct dpif_flow *f;
1052 for (f = flows; f < &flows[n] && should_log_flow_message(0); f++) {
1053 log_flow_message(dpif, 0, "flow_dump",
1054 f->key, f->key_len, f->mask, f->mask_len,
1055 &f->stats, f->actions, f->actions_len);
1058 VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all flows", dpif_name(dpif));
1063 struct dpif_execute_helper_aux {
1068 /* This is called for actions that need the context of the datapath to be
1071 dpif_execute_helper_cb(void *aux_, struct dpif_packet **packets, int cnt,
1072 struct pkt_metadata *md,
1073 const struct nlattr *action, bool may_steal OVS_UNUSED)
1075 struct dpif_execute_helper_aux *aux = aux_;
1076 int type = nl_attr_type(action);
1077 struct ofpbuf * packet = &packets[0]->ofpbuf;
1079 ovs_assert(cnt == 1);
1081 switch ((enum ovs_action_attr)type) {
1082 case OVS_ACTION_ATTR_OUTPUT:
1083 case OVS_ACTION_ATTR_USERSPACE:
1084 case OVS_ACTION_ATTR_RECIRC: {
1085 struct dpif_execute execute;
1086 struct ofpbuf execute_actions;
1087 uint64_t stub[256 / 8];
1089 if (md->tunnel.ip_dst) {
1090 /* The Linux kernel datapath throws away the tunnel information
1091 * that we supply as metadata. We have to use a "set" action to
1093 ofpbuf_use_stub(&execute_actions, stub, sizeof stub);
1094 odp_put_tunnel_action(&md->tunnel, &execute_actions);
1095 ofpbuf_put(&execute_actions, action, NLA_ALIGN(action->nla_len));
1097 execute.actions = ofpbuf_data(&execute_actions);
1098 execute.actions_len = ofpbuf_size(&execute_actions);
1100 execute.actions = action;
1101 execute.actions_len = NLA_ALIGN(action->nla_len);
1104 execute.packet = packet;
1106 execute.needs_help = false;
1107 aux->error = aux->dpif->dpif_class->execute(aux->dpif, &execute);
1109 log_execute_message(aux->dpif, &execute, true, aux->error);
1111 if (md->tunnel.ip_dst) {
1112 ofpbuf_uninit(&execute_actions);
1117 case OVS_ACTION_ATTR_HASH:
1118 case OVS_ACTION_ATTR_PUSH_VLAN:
1119 case OVS_ACTION_ATTR_POP_VLAN:
1120 case OVS_ACTION_ATTR_PUSH_MPLS:
1121 case OVS_ACTION_ATTR_POP_MPLS:
1122 case OVS_ACTION_ATTR_SET:
1123 case OVS_ACTION_ATTR_SAMPLE:
1124 case OVS_ACTION_ATTR_UNSPEC:
1125 case __OVS_ACTION_ATTR_MAX:
1130 /* Executes 'execute' by performing most of the actions in userspace and
1131 * passing the fully constructed packets to 'dpif' for output and userspace
1134 * This helps with actions that a given 'dpif' doesn't implement directly. */
1136 dpif_execute_with_help(struct dpif *dpif, struct dpif_execute *execute)
1138 struct dpif_execute_helper_aux aux = {dpif, 0};
1139 struct dpif_packet packet, *pp;
1141 COVERAGE_INC(dpif_execute_with_help);
1143 packet.ofpbuf = *execute->packet;
1146 odp_execute_actions(&aux, &pp, 1, false, &execute->md, execute->actions,
1147 execute->actions_len, dpif_execute_helper_cb);
1149 /* Even though may_steal is set to false, some actions could modify or
1150 * reallocate the ofpbuf memory. We need to pass those changes to the
1152 *execute->packet = packet.ofpbuf;
1157 /* Returns true if the datapath needs help executing 'execute'. */
1159 dpif_execute_needs_help(const struct dpif_execute *execute)
1161 return execute->needs_help || nl_attr_oversized(execute->actions_len);
1164 /* Causes 'dpif' to perform the 'execute->actions_len' bytes of actions in
1165 * 'execute->actions' on the Ethernet frame in 'execute->packet' and on packet
1166 * metadata in 'execute->md'. The implementation is allowed to modify both the
1167 * '*execute->packet' and 'execute->md'.
1169 * Some dpif providers do not implement every action. The Linux kernel
1170 * datapath, in particular, does not implement ARP field modification. If
1171 * 'needs_help' is true, the dpif layer executes in userspace all of the
1172 * actions that it can, and for OVS_ACTION_ATTR_OUTPUT and
1173 * OVS_ACTION_ATTR_USERSPACE actions it passes the packet through to the dpif
1176 * This works even if 'execute->actions_len' is too long for a Netlink
1179 * Returns 0 if successful, otherwise a positive errno value. */
1181 dpif_execute(struct dpif *dpif, struct dpif_execute *execute)
1185 COVERAGE_INC(dpif_execute);
1186 if (execute->actions_len > 0) {
1187 error = (dpif_execute_needs_help(execute)
1188 ? dpif_execute_with_help(dpif, execute)
1189 : dpif->dpif_class->execute(dpif, execute));
1194 log_execute_message(dpif, execute, false, error);
1199 /* Executes each of the 'n_ops' operations in 'ops' on 'dpif', in the order in
1200 * which they are specified, placing each operation's results in the "output"
1201 * members documented in comments.
1203 * This function exists because some datapaths can perform batched operations
1204 * faster than individual operations. */
1206 dpif_operate(struct dpif *dpif, struct dpif_op **ops, size_t n_ops)
1208 if (dpif->dpif_class->operate) {
1212 /* Count 'chunk', the number of ops that can be executed without
1213 * needing any help. Ops that need help should be rare, so we
1214 * expect this to ordinarily be 'n_ops', that is, all the ops. */
1215 for (chunk = 0; chunk < n_ops; chunk++) {
1216 struct dpif_op *op = ops[chunk];
1218 if (op->type == DPIF_OP_EXECUTE
1219 && dpif_execute_needs_help(&op->u.execute)) {
1225 /* Execute a chunk full of ops that the dpif provider can
1226 * handle itself, without help. */
1229 dpif->dpif_class->operate(dpif, ops, chunk);
1231 for (i = 0; i < chunk; i++) {
1232 struct dpif_op *op = ops[i];
1235 case DPIF_OP_FLOW_PUT:
1236 log_flow_put_message(dpif, &op->u.flow_put, op->error);
1239 case DPIF_OP_FLOW_DEL:
1240 log_flow_del_message(dpif, &op->u.flow_del, op->error);
1243 case DPIF_OP_EXECUTE:
1244 log_execute_message(dpif, &op->u.execute, false,
1253 /* Help the dpif provider to execute one op. */
1254 struct dpif_op *op = ops[0];
1256 op->error = dpif_execute(dpif, &op->u.execute);
1264 for (i = 0; i < n_ops; i++) {
1265 struct dpif_op *op = ops[i];
1268 case DPIF_OP_FLOW_PUT:
1269 op->error = dpif_flow_put__(dpif, &op->u.flow_put);
1272 case DPIF_OP_FLOW_DEL:
1273 op->error = dpif_flow_del__(dpif, &op->u.flow_del);
1276 case DPIF_OP_EXECUTE:
1277 op->error = dpif_execute(dpif, &op->u.execute);
1287 /* Returns a string that represents 'type', for use in log messages. */
1289 dpif_upcall_type_to_string(enum dpif_upcall_type type)
1292 case DPIF_UC_MISS: return "miss";
1293 case DPIF_UC_ACTION: return "action";
1294 case DPIF_N_UC_TYPES: default: return "<unknown>";
1298 /* Enables or disables receiving packets with dpif_recv() on 'dpif'. Returns 0
1299 * if successful, otherwise a positive errno value.
1301 * Turning packet receive off and then back on may change the Netlink PID
1302 * assignments returned by dpif_port_get_pid(). If the client does this, it
1303 * must update all of the flows that have OVS_ACTION_ATTR_USERSPACE actions
1304 * using the new PID assignment. */
1306 dpif_recv_set(struct dpif *dpif, bool enable)
1308 int error = dpif->dpif_class->recv_set(dpif, enable);
1309 log_operation(dpif, "recv_set", error);
1313 /* Refreshes the poll loops and Netlink sockets associated to each port,
1314 * when the number of upcall handlers (upcall receiving thread) is changed
1315 * to 'n_handlers' and receiving packets for 'dpif' is enabled by
1318 * Since multiple upcall handlers can read upcalls simultaneously from
1319 * 'dpif', each port can have multiple Netlink sockets, one per upcall
1320 * handler. So, handlers_set() is responsible for the following tasks:
1322 * When receiving upcall is enabled, extends or creates the
1323 * configuration to support:
1325 * - 'n_handlers' Netlink sockets for each port.
1327 * - 'n_handlers' poll loops, one for each upcall handler.
1329 * - registering the Netlink sockets for the same upcall handler to
1330 * the corresponding poll loop.
1332 * Returns 0 if successful, otherwise a positive errno value. */
1334 dpif_handlers_set(struct dpif *dpif, uint32_t n_handlers)
1336 int error = dpif->dpif_class->handlers_set(dpif, n_handlers);
1337 log_operation(dpif, "handlers_set", error);
1341 /* Polls for an upcall from 'dpif' for an upcall handler. Since there
1342 * there can be multiple poll loops, 'handler_id' is needed as index to
1343 * identify the corresponding poll loop. If successful, stores the upcall
1344 * into '*upcall', using 'buf' for storage. Should only be called if
1345 * 'recv_set' has been used to enable receiving packets from 'dpif'.
1347 * 'upcall->key' and 'upcall->userdata' point into data in the caller-provided
1348 * 'buf', so their memory cannot be freed separately from 'buf'.
1350 * The caller owns the data of 'upcall->packet' and may modify it. If
1351 * packet's headroom is exhausted as it is manipulated, 'upcall->packet'
1352 * will be reallocated. This requires the data of 'upcall->packet' to be
1353 * released with ofpbuf_uninit() before 'upcall' is destroyed. However,
1354 * when an error is returned, the 'upcall->packet' may be uninitialized
1355 * and should not be released.
1357 * Returns 0 if successful, otherwise a positive errno value. Returns EAGAIN
1358 * if no upcall is immediately available. */
1360 dpif_recv(struct dpif *dpif, uint32_t handler_id, struct dpif_upcall *upcall,
1363 int error = dpif->dpif_class->recv(dpif, handler_id, upcall, buf);
1364 if (!error && !VLOG_DROP_DBG(&dpmsg_rl)) {
1368 packet = ofp_packet_to_string(ofpbuf_data(&upcall->packet),
1369 ofpbuf_size(&upcall->packet));
1372 odp_flow_key_format(upcall->key, upcall->key_len, &flow);
1374 VLOG_DBG("%s: %s upcall:\n%s\n%s",
1375 dpif_name(dpif), dpif_upcall_type_to_string(upcall->type),
1376 ds_cstr(&flow), packet);
1380 } else if (error && error != EAGAIN) {
1381 log_operation(dpif, "recv", error);
1386 /* Discards all messages that would otherwise be received by dpif_recv() on
1389 dpif_recv_purge(struct dpif *dpif)
1391 COVERAGE_INC(dpif_purge);
1392 if (dpif->dpif_class->recv_purge) {
1393 dpif->dpif_class->recv_purge(dpif);
1397 /* Arranges for the poll loop for an upcall handler to wake up when 'dpif'
1398 * 'dpif' has a message queued to be received with the recv member
1399 * function. Since there can be multiple poll loops, 'handler_id' is
1400 * needed as index to identify the corresponding poll loop. */
1402 dpif_recv_wait(struct dpif *dpif, uint32_t handler_id)
1404 dpif->dpif_class->recv_wait(dpif, handler_id);
1407 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1408 * and '*engine_id', respectively. */
1410 dpif_get_netflow_ids(const struct dpif *dpif,
1411 uint8_t *engine_type, uint8_t *engine_id)
1413 *engine_type = dpif->netflow_engine_type;
1414 *engine_id = dpif->netflow_engine_id;
1417 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1418 * value used for setting packet priority.
1419 * On success, returns 0 and stores the priority into '*priority'.
1420 * On failure, returns a positive errno value and stores 0 into '*priority'. */
1422 dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id,
1425 int error = (dpif->dpif_class->queue_to_priority
1426 ? dpif->dpif_class->queue_to_priority(dpif, queue_id,
1432 log_operation(dpif, "queue_to_priority", error);
1437 dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class,
1439 uint8_t netflow_engine_type, uint8_t netflow_engine_id)
1441 dpif->dpif_class = dpif_class;
1442 dpif->base_name = xstrdup(name);
1443 dpif->full_name = xasprintf("%s@%s", dpif_class->type, name);
1444 dpif->netflow_engine_type = netflow_engine_type;
1445 dpif->netflow_engine_id = netflow_engine_id;
1448 /* Undoes the results of initialization.
1450 * Normally this function only needs to be called from dpif_close().
1451 * However, it may be called by providers due to an error on opening
1452 * that occurs after initialization. It this case dpif_close() would
1453 * never be called. */
1455 dpif_uninit(struct dpif *dpif, bool close)
1457 char *base_name = dpif->base_name;
1458 char *full_name = dpif->full_name;
1461 dpif->dpif_class->close(dpif);
1469 log_operation(const struct dpif *dpif, const char *operation, int error)
1472 VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation);
1473 } else if (ofperr_is_valid(error)) {
1474 VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1475 dpif_name(dpif), operation, ofperr_get_name(error));
1477 VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1478 dpif_name(dpif), operation, ovs_strerror(error));
1482 static enum vlog_level
1483 flow_message_log_level(int error)
1485 /* If flows arrive in a batch, userspace may push down multiple
1486 * unique flow definitions that overlap when wildcards are applied.
1487 * Kernels that support flow wildcarding will reject these flows as
1488 * duplicates (EEXIST), so lower the log level to debug for these
1489 * types of messages. */
1490 return (error && error != EEXIST) ? VLL_WARN : VLL_DBG;
1494 should_log_flow_message(int error)
1496 return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error),
1497 error ? &error_rl : &dpmsg_rl);
1501 log_flow_message(const struct dpif *dpif, int error, const char *operation,
1502 const struct nlattr *key, size_t key_len,
1503 const struct nlattr *mask, size_t mask_len,
1504 const struct dpif_flow_stats *stats,
1505 const struct nlattr *actions, size_t actions_len)
1507 struct ds ds = DS_EMPTY_INITIALIZER;
1508 ds_put_format(&ds, "%s: ", dpif_name(dpif));
1510 ds_put_cstr(&ds, "failed to ");
1512 ds_put_format(&ds, "%s ", operation);
1514 ds_put_format(&ds, "(%s) ", ovs_strerror(error));
1516 odp_flow_format(key, key_len, mask, mask_len, NULL, &ds, true);
1518 ds_put_cstr(&ds, ", ");
1519 dpif_flow_stats_format(stats, &ds);
1521 if (actions || actions_len) {
1522 ds_put_cstr(&ds, ", actions:");
1523 format_odp_actions(&ds, actions, actions_len);
1525 vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds));
1530 log_flow_put_message(struct dpif *dpif, const struct dpif_flow_put *put,
1533 if (should_log_flow_message(error)) {
1537 ds_put_cstr(&s, "put");
1538 if (put->flags & DPIF_FP_CREATE) {
1539 ds_put_cstr(&s, "[create]");
1541 if (put->flags & DPIF_FP_MODIFY) {
1542 ds_put_cstr(&s, "[modify]");
1544 if (put->flags & DPIF_FP_ZERO_STATS) {
1545 ds_put_cstr(&s, "[zero]");
1547 log_flow_message(dpif, error, ds_cstr(&s),
1548 put->key, put->key_len, put->mask, put->mask_len,
1549 put->stats, put->actions, put->actions_len);
1555 log_flow_del_message(struct dpif *dpif, const struct dpif_flow_del *del,
1558 if (should_log_flow_message(error)) {
1559 log_flow_message(dpif, error, "flow_del", del->key, del->key_len,
1560 NULL, 0, !error ? del->stats : NULL, NULL, 0);
1564 /* Logs that 'execute' was executed on 'dpif' and completed with errno 'error'
1565 * (0 for success). 'subexecute' should be true if the execution is a result
1566 * of breaking down a larger execution that needed help, false otherwise.
1569 * XXX In theory, the log message could be deceptive because this function is
1570 * called after the dpif_provider's '->execute' function, which is allowed to
1571 * modify execute->packet and execute->md. In practice, though:
1573 * - dpif-linux doesn't modify execute->packet or execute->md.
1575 * - dpif-netdev does modify them but it is less likely to have problems
1576 * because it is built into ovs-vswitchd and cannot have version skew,
1579 * It would still be better to avoid the potential problem. I don't know of a
1580 * good way to do that, though, that isn't expensive. */
1582 log_execute_message(struct dpif *dpif, const struct dpif_execute *execute,
1583 bool subexecute, int error)
1585 if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) {
1586 struct ds ds = DS_EMPTY_INITIALIZER;
1589 packet = ofp_packet_to_string(ofpbuf_data(execute->packet),
1590 ofpbuf_size(execute->packet));
1591 ds_put_format(&ds, "%s: %sexecute ",
1593 (subexecute ? "sub-"
1594 : dpif_execute_needs_help(execute) ? "super-"
1596 format_odp_actions(&ds, execute->actions, execute->actions_len);
1598 ds_put_format(&ds, " failed (%s)", ovs_strerror(error));
1600 ds_put_format(&ds, " on packet %s", packet);
1601 vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));