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"
28 #include "dynamic-string.h"
32 #include "odp-execute.h"
34 #include "ofp-errors.h"
35 #include "ofp-print.h"
38 #include "packet-dpif.h"
40 #include "poll-loop.h"
41 #include "route-table.h"
45 #include "tnl-arp-cache.h"
46 #include "tnl-ports.h"
51 VLOG_DEFINE_THIS_MODULE(dpif
);
53 COVERAGE_DEFINE(dpif_destroy
);
54 COVERAGE_DEFINE(dpif_port_add
);
55 COVERAGE_DEFINE(dpif_port_del
);
56 COVERAGE_DEFINE(dpif_flow_flush
);
57 COVERAGE_DEFINE(dpif_flow_get
);
58 COVERAGE_DEFINE(dpif_flow_put
);
59 COVERAGE_DEFINE(dpif_flow_del
);
60 COVERAGE_DEFINE(dpif_execute
);
61 COVERAGE_DEFINE(dpif_purge
);
62 COVERAGE_DEFINE(dpif_execute_with_help
);
64 static const struct dpif_class
*base_dpif_classes
[] = {
65 #if defined(__linux__) || defined(_WIN32)
71 struct registered_dpif_class
{
72 const struct dpif_class
*dpif_class
;
75 static struct shash dpif_classes
= SHASH_INITIALIZER(&dpif_classes
);
76 static struct sset dpif_blacklist
= SSET_INITIALIZER(&dpif_blacklist
);
78 /* Protects 'dpif_classes', including the refcount, and 'dpif_blacklist'. */
79 static struct ovs_mutex dpif_mutex
= OVS_MUTEX_INITIALIZER
;
81 /* Rate limit for individual messages going to or from the datapath, output at
82 * DBG level. This is very high because, if these are enabled, it is because
83 * we really need to see them. */
84 static struct vlog_rate_limit dpmsg_rl
= VLOG_RATE_LIMIT_INIT(600, 600);
86 /* Not really much point in logging many dpif errors. */
87 static struct vlog_rate_limit error_rl
= VLOG_RATE_LIMIT_INIT(60, 5);
89 static void log_flow_message(const struct dpif
*dpif
, int error
,
90 const char *operation
,
91 const struct nlattr
*key
, size_t key_len
,
92 const struct nlattr
*mask
, size_t mask_len
,
93 const struct dpif_flow_stats
*stats
,
94 const struct nlattr
*actions
, size_t actions_len
);
95 static void log_operation(const struct dpif
*, const char *operation
,
97 static bool should_log_flow_message(int error
);
98 static void log_flow_put_message(struct dpif
*, const struct dpif_flow_put
*,
100 static void log_flow_del_message(struct dpif
*, const struct dpif_flow_del
*,
102 static void log_execute_message(struct dpif
*, const struct dpif_execute
*,
103 bool subexecute
, int error
);
104 static void log_flow_get_message(const struct dpif
*,
105 const struct dpif_flow_get
*, int error
);
110 static struct ovsthread_once once
= OVSTHREAD_ONCE_INITIALIZER
;
112 if (ovsthread_once_start(&once
)) {
115 for (i
= 0; i
< ARRAY_SIZE(base_dpif_classes
); i
++) {
116 dp_register_provider(base_dpif_classes
[i
]);
118 dpctl_unixctl_register();
120 tnl_arp_cache_init();
121 route_table_register();
123 ovsthread_once_done(&once
);
128 dp_register_provider__(const struct dpif_class
*new_class
)
130 struct registered_dpif_class
*registered_class
;
132 if (sset_contains(&dpif_blacklist
, new_class
->type
)) {
133 VLOG_DBG("attempted to register blacklisted provider: %s",
138 if (shash_find(&dpif_classes
, new_class
->type
)) {
139 VLOG_WARN("attempted to register duplicate datapath provider: %s",
144 registered_class
= xmalloc(sizeof *registered_class
);
145 registered_class
->dpif_class
= new_class
;
146 registered_class
->refcount
= 0;
148 shash_add(&dpif_classes
, new_class
->type
, registered_class
);
153 /* Registers a new datapath provider. After successful registration, new
154 * datapaths of that type can be opened using dpif_open(). */
156 dp_register_provider(const struct dpif_class
*new_class
)
160 ovs_mutex_lock(&dpif_mutex
);
161 error
= dp_register_provider__(new_class
);
162 ovs_mutex_unlock(&dpif_mutex
);
167 /* Unregisters a datapath provider. 'type' must have been previously
168 * registered and not currently be in use by any dpifs. After unregistration
169 * new datapaths of that type cannot be opened using dpif_open(). */
171 dp_unregister_provider__(const char *type
)
173 struct shash_node
*node
;
174 struct registered_dpif_class
*registered_class
;
176 node
= shash_find(&dpif_classes
, type
);
178 VLOG_WARN("attempted to unregister a datapath provider that is not "
179 "registered: %s", type
);
183 registered_class
= node
->data
;
184 if (registered_class
->refcount
) {
185 VLOG_WARN("attempted to unregister in use datapath provider: %s", type
);
189 shash_delete(&dpif_classes
, node
);
190 free(registered_class
);
195 /* Unregisters a datapath provider. 'type' must have been previously
196 * registered and not currently be in use by any dpifs. After unregistration
197 * new datapaths of that type cannot be opened using dpif_open(). */
199 dp_unregister_provider(const char *type
)
205 ovs_mutex_lock(&dpif_mutex
);
206 error
= dp_unregister_provider__(type
);
207 ovs_mutex_unlock(&dpif_mutex
);
212 /* Blacklists a provider. Causes future calls of dp_register_provider() with
213 * a dpif_class which implements 'type' to fail. */
215 dp_blacklist_provider(const char *type
)
217 ovs_mutex_lock(&dpif_mutex
);
218 sset_add(&dpif_blacklist
, type
);
219 ovs_mutex_unlock(&dpif_mutex
);
222 /* Clears 'types' and enumerates the types of all currently registered datapath
223 * providers into it. The caller must first initialize the sset. */
225 dp_enumerate_types(struct sset
*types
)
227 struct shash_node
*node
;
232 ovs_mutex_lock(&dpif_mutex
);
233 SHASH_FOR_EACH(node
, &dpif_classes
) {
234 const struct registered_dpif_class
*registered_class
= node
->data
;
235 sset_add(types
, registered_class
->dpif_class
->type
);
237 ovs_mutex_unlock(&dpif_mutex
);
241 dp_class_unref(struct registered_dpif_class
*rc
)
243 ovs_mutex_lock(&dpif_mutex
);
244 ovs_assert(rc
->refcount
);
246 ovs_mutex_unlock(&dpif_mutex
);
249 static struct registered_dpif_class
*
250 dp_class_lookup(const char *type
)
252 struct registered_dpif_class
*rc
;
254 ovs_mutex_lock(&dpif_mutex
);
255 rc
= shash_find_data(&dpif_classes
, type
);
259 ovs_mutex_unlock(&dpif_mutex
);
264 /* Clears 'names' and enumerates the names of all known created datapaths with
265 * the given 'type'. The caller must first initialize the sset. Returns 0 if
266 * successful, otherwise a positive errno value.
268 * Some kinds of datapaths might not be practically enumerable. This is not
269 * considered an error. */
271 dp_enumerate_names(const char *type
, struct sset
*names
)
273 struct registered_dpif_class
*registered_class
;
274 const struct dpif_class
*dpif_class
;
280 registered_class
= dp_class_lookup(type
);
281 if (!registered_class
) {
282 VLOG_WARN("could not enumerate unknown type: %s", type
);
286 dpif_class
= registered_class
->dpif_class
;
287 error
= (dpif_class
->enumerate
288 ? dpif_class
->enumerate(names
, dpif_class
)
291 VLOG_WARN("failed to enumerate %s datapaths: %s", dpif_class
->type
,
292 ovs_strerror(error
));
294 dp_class_unref(registered_class
);
299 /* Parses 'datapath_name_', which is of the form [type@]name into its
300 * component pieces. 'name' and 'type' must be freed by the caller.
302 * The returned 'type' is normalized, as if by dpif_normalize_type(). */
304 dp_parse_name(const char *datapath_name_
, char **name
, char **type
)
306 char *datapath_name
= xstrdup(datapath_name_
);
309 separator
= strchr(datapath_name
, '@');
312 *type
= datapath_name
;
313 *name
= xstrdup(dpif_normalize_type(separator
+ 1));
315 *name
= datapath_name
;
316 *type
= xstrdup(dpif_normalize_type(NULL
));
321 do_open(const char *name
, const char *type
, bool create
, struct dpif
**dpifp
)
323 struct dpif
*dpif
= NULL
;
325 struct registered_dpif_class
*registered_class
;
329 type
= dpif_normalize_type(type
);
330 registered_class
= dp_class_lookup(type
);
331 if (!registered_class
) {
332 VLOG_WARN("could not create datapath %s of unknown type %s", name
,
334 error
= EAFNOSUPPORT
;
338 error
= registered_class
->dpif_class
->open(registered_class
->dpif_class
,
339 name
, create
, &dpif
);
341 ovs_assert(dpif
->dpif_class
== registered_class
->dpif_class
);
343 dp_class_unref(registered_class
);
347 *dpifp
= error
? NULL
: dpif
;
351 /* Tries to open an existing datapath named 'name' and type 'type'. Will fail
352 * if no datapath with 'name' and 'type' exists. 'type' may be either NULL or
353 * the empty string to specify the default system type. Returns 0 if
354 * successful, otherwise a positive errno value. On success stores a pointer
355 * to the datapath in '*dpifp', otherwise a null pointer. */
357 dpif_open(const char *name
, const char *type
, struct dpif
**dpifp
)
359 return do_open(name
, type
, false, dpifp
);
362 /* Tries to create and open a new datapath with the given 'name' and 'type'.
363 * 'type' may be either NULL or the empty string to specify the default system
364 * type. Will fail if a datapath with 'name' and 'type' already exists.
365 * Returns 0 if successful, otherwise a positive errno value. On success
366 * stores a pointer to the datapath in '*dpifp', otherwise a null pointer. */
368 dpif_create(const char *name
, const char *type
, struct dpif
**dpifp
)
370 return do_open(name
, type
, true, dpifp
);
373 /* Tries to open a datapath with the given 'name' and 'type', creating it if it
374 * does not exist. 'type' may be either NULL or the empty string to specify
375 * the default system type. Returns 0 if successful, otherwise a positive
376 * errno value. On success stores a pointer to the datapath in '*dpifp',
377 * otherwise a null pointer. */
379 dpif_create_and_open(const char *name
, const char *type
, struct dpif
**dpifp
)
383 error
= dpif_create(name
, type
, dpifp
);
384 if (error
== EEXIST
|| error
== EBUSY
) {
385 error
= dpif_open(name
, type
, dpifp
);
387 VLOG_WARN("datapath %s already exists but cannot be opened: %s",
388 name
, ovs_strerror(error
));
391 VLOG_WARN("failed to create datapath %s: %s",
392 name
, ovs_strerror(error
));
397 /* Closes and frees the connection to 'dpif'. Does not destroy the datapath
398 * itself; call dpif_delete() first, instead, if that is desirable. */
400 dpif_close(struct dpif
*dpif
)
403 struct registered_dpif_class
*rc
;
405 rc
= shash_find_data(&dpif_classes
, dpif
->dpif_class
->type
);
406 dpif_uninit(dpif
, true);
411 /* Performs periodic work needed by 'dpif'. */
413 dpif_run(struct dpif
*dpif
)
415 if (dpif
->dpif_class
->run
) {
416 return dpif
->dpif_class
->run(dpif
);
421 /* Arranges for poll_block() to wake up when dp_run() needs to be called for
424 dpif_wait(struct dpif
*dpif
)
426 if (dpif
->dpif_class
->wait
) {
427 dpif
->dpif_class
->wait(dpif
);
431 /* Returns the name of datapath 'dpif' prefixed with the type
432 * (for use in log messages). */
434 dpif_name(const struct dpif
*dpif
)
436 return dpif
->full_name
;
439 /* Returns the name of datapath 'dpif' without the type
440 * (for use in device names). */
442 dpif_base_name(const struct dpif
*dpif
)
444 return dpif
->base_name
;
447 /* Returns the type of datapath 'dpif'. */
449 dpif_type(const struct dpif
*dpif
)
451 return dpif
->dpif_class
->type
;
454 /* Returns the fully spelled out name for the given datapath 'type'.
456 * Normalized type string can be compared with strcmp(). Unnormalized type
457 * string might be the same even if they have different spellings. */
459 dpif_normalize_type(const char *type
)
461 return type
&& type
[0] ? type
: "system";
464 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
465 * ports. After calling this function, it does not make sense to pass 'dpif'
466 * to any functions other than dpif_name() or dpif_close(). */
468 dpif_delete(struct dpif
*dpif
)
472 COVERAGE_INC(dpif_destroy
);
474 error
= dpif
->dpif_class
->destroy(dpif
);
475 log_operation(dpif
, "delete", error
);
479 /* Retrieves statistics for 'dpif' into 'stats'. Returns 0 if successful,
480 * otherwise a positive errno value. */
482 dpif_get_dp_stats(const struct dpif
*dpif
, struct dpif_dp_stats
*stats
)
484 int error
= dpif
->dpif_class
->get_stats(dpif
, stats
);
486 memset(stats
, 0, sizeof *stats
);
488 log_operation(dpif
, "get_stats", error
);
493 dpif_port_open_type(const char *datapath_type
, const char *port_type
)
495 struct registered_dpif_class
*rc
;
497 datapath_type
= dpif_normalize_type(datapath_type
);
499 ovs_mutex_lock(&dpif_mutex
);
500 rc
= shash_find_data(&dpif_classes
, datapath_type
);
501 if (rc
&& rc
->dpif_class
->port_open_type
) {
502 port_type
= rc
->dpif_class
->port_open_type(rc
->dpif_class
, port_type
);
504 ovs_mutex_unlock(&dpif_mutex
);
509 /* Attempts to add 'netdev' as a port on 'dpif'. If 'port_nop' is
510 * non-null and its value is not ODPP_NONE, then attempts to use the
511 * value as the port number.
513 * If successful, returns 0 and sets '*port_nop' to the new port's port
514 * number (if 'port_nop' is non-null). On failure, returns a positive
515 * errno value and sets '*port_nop' to ODPP_NONE (if 'port_nop' is
518 dpif_port_add(struct dpif
*dpif
, struct netdev
*netdev
, odp_port_t
*port_nop
)
520 const char *netdev_name
= netdev_get_name(netdev
);
521 odp_port_t port_no
= ODPP_NONE
;
524 COVERAGE_INC(dpif_port_add
);
530 error
= dpif
->dpif_class
->port_add(dpif
, netdev
, &port_no
);
532 VLOG_DBG_RL(&dpmsg_rl
, "%s: added %s as port %"PRIu32
,
533 dpif_name(dpif
), netdev_name
, port_no
);
535 VLOG_WARN_RL(&error_rl
, "%s: failed to add %s as port: %s",
536 dpif_name(dpif
), netdev_name
, ovs_strerror(error
));
545 /* Attempts to remove 'dpif''s port number 'port_no'. Returns 0 if successful,
546 * otherwise a positive errno value. */
548 dpif_port_del(struct dpif
*dpif
, odp_port_t port_no
)
552 COVERAGE_INC(dpif_port_del
);
554 error
= dpif
->dpif_class
->port_del(dpif
, port_no
);
556 VLOG_DBG_RL(&dpmsg_rl
, "%s: port_del(%"PRIu32
")",
557 dpif_name(dpif
), port_no
);
559 log_operation(dpif
, "port_del", error
);
564 /* Makes a deep copy of 'src' into 'dst'. */
566 dpif_port_clone(struct dpif_port
*dst
, const struct dpif_port
*src
)
568 dst
->name
= xstrdup(src
->name
);
569 dst
->type
= xstrdup(src
->type
);
570 dst
->port_no
= src
->port_no
;
573 /* Frees memory allocated to members of 'dpif_port'.
575 * Do not call this function on a dpif_port obtained from
576 * dpif_port_dump_next(): that function retains ownership of the data in the
579 dpif_port_destroy(struct dpif_port
*dpif_port
)
581 free(dpif_port
->name
);
582 free(dpif_port
->type
);
585 /* Checks if port named 'devname' exists in 'dpif'. If so, returns
586 * true; otherwise, returns false. */
588 dpif_port_exists(const struct dpif
*dpif
, const char *devname
)
590 int error
= dpif
->dpif_class
->port_query_by_name(dpif
, devname
, NULL
);
591 if (error
!= 0 && error
!= ENOENT
&& error
!= ENODEV
) {
592 VLOG_WARN_RL(&error_rl
, "%s: failed to query port %s: %s",
593 dpif_name(dpif
), devname
, ovs_strerror(error
));
599 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and
600 * initializes '*port' appropriately; on failure, returns a positive errno
603 * The caller owns the data in 'port' and must free it with
604 * dpif_port_destroy() when it is no longer needed. */
606 dpif_port_query_by_number(const struct dpif
*dpif
, odp_port_t port_no
,
607 struct dpif_port
*port
)
609 int error
= dpif
->dpif_class
->port_query_by_number(dpif
, port_no
, port
);
611 VLOG_DBG_RL(&dpmsg_rl
, "%s: port %"PRIu32
" is device %s",
612 dpif_name(dpif
), port_no
, port
->name
);
614 memset(port
, 0, sizeof *port
);
615 VLOG_WARN_RL(&error_rl
, "%s: failed to query port %"PRIu32
": %s",
616 dpif_name(dpif
), port_no
, ovs_strerror(error
));
621 /* Looks up port named 'devname' in 'dpif'. On success, returns 0 and
622 * initializes '*port' appropriately; on failure, returns a positive errno
625 * The caller owns the data in 'port' and must free it with
626 * dpif_port_destroy() when it is no longer needed. */
628 dpif_port_query_by_name(const struct dpif
*dpif
, const char *devname
,
629 struct dpif_port
*port
)
631 int error
= dpif
->dpif_class
->port_query_by_name(dpif
, devname
, port
);
633 VLOG_DBG_RL(&dpmsg_rl
, "%s: device %s is on port %"PRIu32
,
634 dpif_name(dpif
), devname
, port
->port_no
);
636 memset(port
, 0, sizeof *port
);
638 /* For ENOENT or ENODEV we use DBG level because the caller is probably
639 * interested in whether 'dpif' actually has a port 'devname', so that
640 * it's not an issue worth logging if it doesn't. Other errors are
641 * uncommon and more likely to indicate a real problem. */
643 error
== ENOENT
|| error
== ENODEV
? VLL_DBG
: VLL_WARN
,
644 "%s: failed to query port %s: %s",
645 dpif_name(dpif
), devname
, ovs_strerror(error
));
650 /* Returns the Netlink PID value to supply in OVS_ACTION_ATTR_USERSPACE
651 * actions as the OVS_USERSPACE_ATTR_PID attribute's value, for use in
652 * flows whose packets arrived on port 'port_no'. In the case where the
653 * provider allocates multiple Netlink PIDs to a single port, it may use
654 * 'hash' to spread load among them. The caller need not use a particular
655 * hash function; a 5-tuple hash is suitable.
657 * (The datapath implementation might use some different hash function for
658 * distributing packets received via flow misses among PIDs. This means
659 * that packets received via flow misses might be reordered relative to
660 * packets received via userspace actions. This is not ordinarily a
663 * A 'port_no' of ODPP_NONE is a special case: it returns a reserved PID, not
664 * allocated to any port, that the client may use for special purposes.
666 * The return value is only meaningful when DPIF_UC_ACTION has been enabled in
667 * the 'dpif''s listen mask. It is allowed to change when DPIF_UC_ACTION is
668 * disabled and then re-enabled, so a client that does that must be prepared to
669 * update all of the flows that it installed that contain
670 * OVS_ACTION_ATTR_USERSPACE actions. */
672 dpif_port_get_pid(const struct dpif
*dpif
, odp_port_t port_no
, uint32_t hash
)
674 return (dpif
->dpif_class
->port_get_pid
675 ? (dpif
->dpif_class
->port_get_pid
)(dpif
, port_no
, hash
)
679 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and copies
680 * the port's name into the 'name_size' bytes in 'name', ensuring that the
681 * result is null-terminated. On failure, returns a positive errno value and
682 * makes 'name' the empty string. */
684 dpif_port_get_name(struct dpif
*dpif
, odp_port_t port_no
,
685 char *name
, size_t name_size
)
687 struct dpif_port port
;
690 ovs_assert(name_size
> 0);
692 error
= dpif_port_query_by_number(dpif
, port_no
, &port
);
694 ovs_strlcpy(name
, port
.name
, name_size
);
695 dpif_port_destroy(&port
);
702 /* Initializes 'dump' to begin dumping the ports in a dpif.
704 * This function provides no status indication. An error status for the entire
705 * dump operation is provided when it is completed by calling
706 * dpif_port_dump_done().
709 dpif_port_dump_start(struct dpif_port_dump
*dump
, const struct dpif
*dpif
)
712 dump
->error
= dpif
->dpif_class
->port_dump_start(dpif
, &dump
->state
);
713 log_operation(dpif
, "port_dump_start", dump
->error
);
716 /* Attempts to retrieve another port from 'dump', which must have been
717 * initialized with dpif_port_dump_start(). On success, stores a new dpif_port
718 * into 'port' and returns true. On failure, returns false.
720 * Failure might indicate an actual error or merely that the last port has been
721 * dumped. An error status for the entire dump operation is provided when it
722 * is completed by calling dpif_port_dump_done().
724 * The dpif owns the data stored in 'port'. It will remain valid until at
725 * least the next time 'dump' is passed to dpif_port_dump_next() or
726 * dpif_port_dump_done(). */
728 dpif_port_dump_next(struct dpif_port_dump
*dump
, struct dpif_port
*port
)
730 const struct dpif
*dpif
= dump
->dpif
;
736 dump
->error
= dpif
->dpif_class
->port_dump_next(dpif
, dump
->state
, port
);
737 if (dump
->error
== EOF
) {
738 VLOG_DBG_RL(&dpmsg_rl
, "%s: dumped all ports", dpif_name(dpif
));
740 log_operation(dpif
, "port_dump_next", dump
->error
);
744 dpif
->dpif_class
->port_dump_done(dpif
, dump
->state
);
750 /* Completes port table dump operation 'dump', which must have been initialized
751 * with dpif_port_dump_start(). Returns 0 if the dump operation was
752 * error-free, otherwise a positive errno value describing the problem. */
754 dpif_port_dump_done(struct dpif_port_dump
*dump
)
756 const struct dpif
*dpif
= dump
->dpif
;
758 dump
->error
= dpif
->dpif_class
->port_dump_done(dpif
, dump
->state
);
759 log_operation(dpif
, "port_dump_done", dump
->error
);
761 return dump
->error
== EOF
? 0 : dump
->error
;
764 /* Polls for changes in the set of ports in 'dpif'. If the set of ports in
765 * 'dpif' has changed, this function does one of the following:
767 * - Stores the name of the device that was added to or deleted from 'dpif' in
768 * '*devnamep' and returns 0. The caller is responsible for freeing
769 * '*devnamep' (with free()) when it no longer needs it.
771 * - Returns ENOBUFS and sets '*devnamep' to NULL.
773 * This function may also return 'false positives', where it returns 0 and
774 * '*devnamep' names a device that was not actually added or deleted or it
775 * returns ENOBUFS without any change.
777 * Returns EAGAIN if the set of ports in 'dpif' has not changed. May also
778 * return other positive errno values to indicate that something has gone
781 dpif_port_poll(const struct dpif
*dpif
, char **devnamep
)
783 int error
= dpif
->dpif_class
->port_poll(dpif
, devnamep
);
790 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
791 * value other than EAGAIN. */
793 dpif_port_poll_wait(const struct dpif
*dpif
)
795 dpif
->dpif_class
->port_poll_wait(dpif
);
798 /* Extracts the flow stats for a packet. The 'flow' and 'packet'
799 * arguments must have been initialized through a call to flow_extract().
800 * 'used' is stored into stats->used. */
802 dpif_flow_stats_extract(const struct flow
*flow
, const struct ofpbuf
*packet
,
803 long long int used
, struct dpif_flow_stats
*stats
)
805 stats
->tcp_flags
= ntohs(flow
->tcp_flags
);
806 stats
->n_bytes
= ofpbuf_size(packet
);
807 stats
->n_packets
= 1;
811 /* Appends a human-readable representation of 'stats' to 's'. */
813 dpif_flow_stats_format(const struct dpif_flow_stats
*stats
, struct ds
*s
)
815 ds_put_format(s
, "packets:%"PRIu64
", bytes:%"PRIu64
", used:",
816 stats
->n_packets
, stats
->n_bytes
);
818 ds_put_format(s
, "%.3fs", (time_msec() - stats
->used
) / 1000.0);
820 ds_put_format(s
, "never");
822 if (stats
->tcp_flags
) {
823 ds_put_cstr(s
, ", flags:");
824 packet_format_tcp_flags(s
, stats
->tcp_flags
);
828 /* Deletes all flows from 'dpif'. Returns 0 if successful, otherwise a
829 * positive errno value. */
831 dpif_flow_flush(struct dpif
*dpif
)
835 COVERAGE_INC(dpif_flow_flush
);
837 error
= dpif
->dpif_class
->flow_flush(dpif
);
838 log_operation(dpif
, "flow_flush", error
);
842 /* A dpif_operate() wrapper for performing a single DPIF_OP_FLOW_GET. */
844 dpif_flow_get(struct dpif
*dpif
,
845 const struct nlattr
*key
, size_t key_len
,
846 struct ofpbuf
*buf
, struct dpif_flow
*flow
)
851 op
.type
= DPIF_OP_FLOW_GET
;
852 op
.u
.flow_get
.key
= key
;
853 op
.u
.flow_get
.key_len
= key_len
;
854 op
.u
.flow_get
.buffer
= buf
;
855 op
.u
.flow_get
.flow
= flow
;
856 op
.u
.flow_get
.flow
->key
= key
;
857 op
.u
.flow_get
.flow
->key_len
= key_len
;
860 dpif_operate(dpif
, &opp
, 1);
865 /* A dpif_operate() wrapper for performing a single DPIF_OP_FLOW_PUT. */
867 dpif_flow_put(struct dpif
*dpif
, enum dpif_flow_put_flags flags
,
868 const struct nlattr
*key
, size_t key_len
,
869 const struct nlattr
*mask
, size_t mask_len
,
870 const struct nlattr
*actions
, size_t actions_len
,
871 struct dpif_flow_stats
*stats
)
876 op
.type
= DPIF_OP_FLOW_PUT
;
877 op
.u
.flow_put
.flags
= flags
;
878 op
.u
.flow_put
.key
= key
;
879 op
.u
.flow_put
.key_len
= key_len
;
880 op
.u
.flow_put
.mask
= mask
;
881 op
.u
.flow_put
.mask_len
= mask_len
;
882 op
.u
.flow_put
.actions
= actions
;
883 op
.u
.flow_put
.actions_len
= actions_len
;
884 op
.u
.flow_put
.stats
= stats
;
887 dpif_operate(dpif
, &opp
, 1);
892 /* A dpif_operate() wrapper for performing a single DPIF_OP_FLOW_DEL. */
894 dpif_flow_del(struct dpif
*dpif
,
895 const struct nlattr
*key
, size_t key_len
,
896 struct dpif_flow_stats
*stats
)
901 op
.type
= DPIF_OP_FLOW_DEL
;
902 op
.u
.flow_del
.key
= key
;
903 op
.u
.flow_del
.key_len
= key_len
;
904 op
.u
.flow_del
.stats
= stats
;
907 dpif_operate(dpif
, &opp
, 1);
912 /* Creates and returns a new 'struct dpif_flow_dump' for iterating through the
915 * This function always successfully returns a dpif_flow_dump. Error
916 * reporting is deferred to dpif_flow_dump_destroy(). */
917 struct dpif_flow_dump
*
918 dpif_flow_dump_create(const struct dpif
*dpif
)
920 return dpif
->dpif_class
->flow_dump_create(dpif
);
923 /* Destroys 'dump', which must have been created with dpif_flow_dump_create().
924 * All dpif_flow_dump_thread structures previously created for 'dump' must
925 * previously have been destroyed.
927 * Returns 0 if the dump operation was error-free, otherwise a positive errno
928 * value describing the problem. */
930 dpif_flow_dump_destroy(struct dpif_flow_dump
*dump
)
932 const struct dpif
*dpif
= dump
->dpif
;
933 int error
= dpif
->dpif_class
->flow_dump_destroy(dump
);
934 log_operation(dpif
, "flow_dump_destroy", error
);
935 return error
== EOF
? 0 : error
;
938 /* Returns new thread-local state for use with dpif_flow_dump_next(). */
939 struct dpif_flow_dump_thread
*
940 dpif_flow_dump_thread_create(struct dpif_flow_dump
*dump
)
942 return dump
->dpif
->dpif_class
->flow_dump_thread_create(dump
);
945 /* Releases 'thread'. */
947 dpif_flow_dump_thread_destroy(struct dpif_flow_dump_thread
*thread
)
949 thread
->dpif
->dpif_class
->flow_dump_thread_destroy(thread
);
952 /* Attempts to retrieve up to 'max_flows' more flows from 'thread'. Returns 0
953 * if and only if no flows remained to be retrieved, otherwise a positive
954 * number reflecting the number of elements in 'flows[]' that were updated.
955 * The number of flows returned might be less than 'max_flows' because
956 * fewer than 'max_flows' remained, because this particular datapath does not
957 * benefit from batching, or because an error occurred partway through
958 * retrieval. Thus, the caller should continue calling until a 0 return value,
959 * even if intermediate return values are less than 'max_flows'.
961 * No error status is immediately provided. An error status for the entire
962 * dump operation is provided when it is completed by calling
963 * dpif_flow_dump_destroy().
965 * All of the data stored into 'flows' is owned by the datapath, not by the
966 * caller, and the caller must not modify or free it. The datapath guarantees
967 * that it remains accessible and unchanged until the first of:
968 * - The next call to dpif_flow_dump_next() for 'thread', or
969 * - The next rcu quiescent period. */
971 dpif_flow_dump_next(struct dpif_flow_dump_thread
*thread
,
972 struct dpif_flow
*flows
, int max_flows
)
974 struct dpif
*dpif
= thread
->dpif
;
977 ovs_assert(max_flows
> 0);
978 n
= dpif
->dpif_class
->flow_dump_next(thread
, flows
, max_flows
);
982 for (f
= flows
; f
< &flows
[n
] && should_log_flow_message(0); f
++) {
983 log_flow_message(dpif
, 0, "flow_dump",
984 f
->key
, f
->key_len
, f
->mask
, f
->mask_len
,
985 &f
->stats
, f
->actions
, f
->actions_len
);
988 VLOG_DBG_RL(&dpmsg_rl
, "%s: dumped all flows", dpif_name(dpif
));
993 struct dpif_execute_helper_aux
{
998 /* This is called for actions that need the context of the datapath to be
1001 dpif_execute_helper_cb(void *aux_
, struct dpif_packet
**packets
, int cnt
,
1002 const struct nlattr
*action
, bool may_steal OVS_UNUSED
)
1004 struct dpif_execute_helper_aux
*aux
= aux_
;
1005 int type
= nl_attr_type(action
);
1006 struct ofpbuf
*packet
= &packets
[0]->ofpbuf
;
1007 struct pkt_metadata
*md
= &packets
[0]->md
;
1009 ovs_assert(cnt
== 1);
1011 switch ((enum ovs_action_attr
)type
) {
1012 case OVS_ACTION_ATTR_OUTPUT
:
1013 case OVS_ACTION_ATTR_TUNNEL_PUSH
:
1014 case OVS_ACTION_ATTR_TUNNEL_POP
:
1015 case OVS_ACTION_ATTR_USERSPACE
:
1016 case OVS_ACTION_ATTR_RECIRC
: {
1017 struct dpif_execute execute
;
1018 struct ofpbuf execute_actions
;
1019 uint64_t stub
[256 / 8];
1021 if (md
->tunnel
.ip_dst
) {
1022 /* The Linux kernel datapath throws away the tunnel information
1023 * that we supply as metadata. We have to use a "set" action to
1025 ofpbuf_use_stub(&execute_actions
, stub
, sizeof stub
);
1026 odp_put_tunnel_action(&md
->tunnel
, &execute_actions
);
1027 ofpbuf_put(&execute_actions
, action
, NLA_ALIGN(action
->nla_len
));
1029 execute
.actions
= ofpbuf_data(&execute_actions
);
1030 execute
.actions_len
= ofpbuf_size(&execute_actions
);
1032 execute
.actions
= action
;
1033 execute
.actions_len
= NLA_ALIGN(action
->nla_len
);
1036 execute
.packet
= packet
;
1038 execute
.needs_help
= false;
1039 execute
.probe
= false;
1040 aux
->error
= dpif_execute(aux
->dpif
, &execute
);
1041 log_execute_message(aux
->dpif
, &execute
, true, aux
->error
);
1043 if (md
->tunnel
.ip_dst
) {
1044 ofpbuf_uninit(&execute_actions
);
1049 case OVS_ACTION_ATTR_HASH
:
1050 case OVS_ACTION_ATTR_PUSH_VLAN
:
1051 case OVS_ACTION_ATTR_POP_VLAN
:
1052 case OVS_ACTION_ATTR_PUSH_MPLS
:
1053 case OVS_ACTION_ATTR_POP_MPLS
:
1054 case OVS_ACTION_ATTR_SET
:
1055 case OVS_ACTION_ATTR_SET_MASKED
:
1056 case OVS_ACTION_ATTR_SAMPLE
:
1057 case OVS_ACTION_ATTR_UNSPEC
:
1058 case __OVS_ACTION_ATTR_MAX
:
1063 /* Executes 'execute' by performing most of the actions in userspace and
1064 * passing the fully constructed packets to 'dpif' for output and userspace
1067 * This helps with actions that a given 'dpif' doesn't implement directly. */
1069 dpif_execute_with_help(struct dpif
*dpif
, struct dpif_execute
*execute
)
1071 struct dpif_execute_helper_aux aux
= {dpif
, 0};
1072 struct dpif_packet packet
, *pp
;
1074 COVERAGE_INC(dpif_execute_with_help
);
1076 packet
.ofpbuf
= *execute
->packet
;
1077 packet
.md
= execute
->md
;
1080 odp_execute_actions(&aux
, &pp
, 1, false, execute
->actions
,
1081 execute
->actions_len
, dpif_execute_helper_cb
);
1083 /* Even though may_steal is set to false, some actions could modify or
1084 * reallocate the ofpbuf memory. We need to pass those changes to the
1086 *execute
->packet
= packet
.ofpbuf
;
1087 execute
->md
= packet
.md
;
1092 /* Returns true if the datapath needs help executing 'execute'. */
1094 dpif_execute_needs_help(const struct dpif_execute
*execute
)
1096 return execute
->needs_help
|| nl_attr_oversized(execute
->actions_len
);
1099 /* A dpif_operate() wrapper for performing a single DPIF_OP_EXECUTE. */
1101 dpif_execute(struct dpif
*dpif
, struct dpif_execute
*execute
)
1103 if (execute
->actions_len
) {
1104 struct dpif_op
*opp
;
1107 op
.type
= DPIF_OP_EXECUTE
;
1108 op
.u
.execute
= *execute
;
1111 dpif_operate(dpif
, &opp
, 1);
1119 /* Executes each of the 'n_ops' operations in 'ops' on 'dpif', in the order in
1120 * which they are specified. Places each operation's results in the "output"
1121 * members documented in comments, and 0 in the 'error' member on success or a
1122 * positive errno on failure. */
1124 dpif_operate(struct dpif
*dpif
, struct dpif_op
**ops
, size_t n_ops
)
1129 /* Count 'chunk', the number of ops that can be executed without
1130 * needing any help. Ops that need help should be rare, so we
1131 * expect this to ordinarily be 'n_ops', that is, all the ops. */
1132 for (chunk
= 0; chunk
< n_ops
; chunk
++) {
1133 struct dpif_op
*op
= ops
[chunk
];
1135 if (op
->type
== DPIF_OP_EXECUTE
1136 && dpif_execute_needs_help(&op
->u
.execute
)) {
1142 /* Execute a chunk full of ops that the dpif provider can
1143 * handle itself, without help. */
1146 dpif
->dpif_class
->operate(dpif
, ops
, chunk
);
1148 for (i
= 0; i
< chunk
; i
++) {
1149 struct dpif_op
*op
= ops
[i
];
1150 int error
= op
->error
;
1153 case DPIF_OP_FLOW_PUT
: {
1154 struct dpif_flow_put
*put
= &op
->u
.flow_put
;
1156 COVERAGE_INC(dpif_flow_put
);
1157 log_flow_put_message(dpif
, put
, error
);
1158 if (error
&& put
->stats
) {
1159 memset(put
->stats
, 0, sizeof *put
->stats
);
1164 case DPIF_OP_FLOW_GET
: {
1165 struct dpif_flow_get
*get
= &op
->u
.flow_get
;
1167 COVERAGE_INC(dpif_flow_get
);
1169 memset(get
->flow
, 0, sizeof *get
->flow
);
1171 log_flow_get_message(dpif
, get
, error
);
1176 case DPIF_OP_FLOW_DEL
: {
1177 struct dpif_flow_del
*del
= &op
->u
.flow_del
;
1179 COVERAGE_INC(dpif_flow_del
);
1180 log_flow_del_message(dpif
, del
, error
);
1181 if (error
&& del
->stats
) {
1182 memset(del
->stats
, 0, sizeof *del
->stats
);
1187 case DPIF_OP_EXECUTE
:
1188 COVERAGE_INC(dpif_execute
);
1189 log_execute_message(dpif
, &op
->u
.execute
, false, error
);
1197 /* Help the dpif provider to execute one op. */
1198 struct dpif_op
*op
= ops
[0];
1200 COVERAGE_INC(dpif_execute
);
1201 op
->error
= dpif_execute_with_help(dpif
, &op
->u
.execute
);
1208 /* Returns a string that represents 'type', for use in log messages. */
1210 dpif_upcall_type_to_string(enum dpif_upcall_type type
)
1213 case DPIF_UC_MISS
: return "miss";
1214 case DPIF_UC_ACTION
: return "action";
1215 case DPIF_N_UC_TYPES
: default: return "<unknown>";
1219 /* Enables or disables receiving packets with dpif_recv() on 'dpif'. Returns 0
1220 * if successful, otherwise a positive errno value.
1222 * Turning packet receive off and then back on may change the Netlink PID
1223 * assignments returned by dpif_port_get_pid(). If the client does this, it
1224 * must update all of the flows that have OVS_ACTION_ATTR_USERSPACE actions
1225 * using the new PID assignment. */
1227 dpif_recv_set(struct dpif
*dpif
, bool enable
)
1231 if (dpif
->dpif_class
->recv_set
) {
1232 error
= dpif
->dpif_class
->recv_set(dpif
, enable
);
1233 log_operation(dpif
, "recv_set", error
);
1238 /* Refreshes the poll loops and Netlink sockets associated to each port,
1239 * when the number of upcall handlers (upcall receiving thread) is changed
1240 * to 'n_handlers' and receiving packets for 'dpif' is enabled by
1243 * Since multiple upcall handlers can read upcalls simultaneously from
1244 * 'dpif', each port can have multiple Netlink sockets, one per upcall
1245 * handler. So, handlers_set() is responsible for the following tasks:
1247 * When receiving upcall is enabled, extends or creates the
1248 * configuration to support:
1250 * - 'n_handlers' Netlink sockets for each port.
1252 * - 'n_handlers' poll loops, one for each upcall handler.
1254 * - registering the Netlink sockets for the same upcall handler to
1255 * the corresponding poll loop.
1257 * Returns 0 if successful, otherwise a positive errno value. */
1259 dpif_handlers_set(struct dpif
*dpif
, uint32_t n_handlers
)
1263 if (dpif
->dpif_class
->handlers_set
) {
1264 error
= dpif
->dpif_class
->handlers_set(dpif
, n_handlers
);
1265 log_operation(dpif
, "handlers_set", error
);
1271 dpif_register_upcall_cb(struct dpif
*dpif
, upcall_callback
*cb
, void *aux
)
1273 if (dpif
->dpif_class
->register_upcall_cb
) {
1274 dpif
->dpif_class
->register_upcall_cb(dpif
, cb
, aux
);
1279 dpif_enable_upcall(struct dpif
*dpif
)
1281 if (dpif
->dpif_class
->enable_upcall
) {
1282 dpif
->dpif_class
->enable_upcall(dpif
);
1287 dpif_disable_upcall(struct dpif
*dpif
)
1289 if (dpif
->dpif_class
->disable_upcall
) {
1290 dpif
->dpif_class
->disable_upcall(dpif
);
1295 dpif_print_packet(struct dpif
*dpif
, struct dpif_upcall
*upcall
)
1297 if (!VLOG_DROP_DBG(&dpmsg_rl
)) {
1301 packet
= ofp_packet_to_string(ofpbuf_data(&upcall
->packet
),
1302 ofpbuf_size(&upcall
->packet
));
1305 odp_flow_key_format(upcall
->key
, upcall
->key_len
, &flow
);
1307 VLOG_DBG("%s: %s upcall:\n%s\n%s",
1308 dpif_name(dpif
), dpif_upcall_type_to_string(upcall
->type
),
1309 ds_cstr(&flow
), packet
);
1316 /* If 'dpif' creates its own I/O polling threads, refreshes poll threads
1319 dpif_poll_threads_set(struct dpif
*dpif
, unsigned int n_rxqs
,
1324 if (dpif
->dpif_class
->poll_threads_set
) {
1325 error
= dpif
->dpif_class
->poll_threads_set(dpif
, n_rxqs
, cmask
);
1327 log_operation(dpif
, "poll_threads_set", error
);
1334 /* Polls for an upcall from 'dpif' for an upcall handler. Since there
1335 * there can be multiple poll loops, 'handler_id' is needed as index to
1336 * identify the corresponding poll loop. If successful, stores the upcall
1337 * into '*upcall', using 'buf' for storage. Should only be called if
1338 * 'recv_set' has been used to enable receiving packets from 'dpif'.
1340 * 'upcall->key' and 'upcall->userdata' point into data in the caller-provided
1341 * 'buf', so their memory cannot be freed separately from 'buf'.
1343 * The caller owns the data of 'upcall->packet' and may modify it. If
1344 * packet's headroom is exhausted as it is manipulated, 'upcall->packet'
1345 * will be reallocated. This requires the data of 'upcall->packet' to be
1346 * released with ofpbuf_uninit() before 'upcall' is destroyed. However,
1347 * when an error is returned, the 'upcall->packet' may be uninitialized
1348 * and should not be released.
1350 * Returns 0 if successful, otherwise a positive errno value. Returns EAGAIN
1351 * if no upcall is immediately available. */
1353 dpif_recv(struct dpif
*dpif
, uint32_t handler_id
, struct dpif_upcall
*upcall
,
1358 if (dpif
->dpif_class
->recv
) {
1359 error
= dpif
->dpif_class
->recv(dpif
, handler_id
, upcall
, buf
);
1361 dpif_print_packet(dpif
, upcall
);
1362 } else if (error
!= EAGAIN
) {
1363 log_operation(dpif
, "recv", error
);
1369 /* Discards all messages that would otherwise be received by dpif_recv() on
1372 dpif_recv_purge(struct dpif
*dpif
)
1374 COVERAGE_INC(dpif_purge
);
1375 if (dpif
->dpif_class
->recv_purge
) {
1376 dpif
->dpif_class
->recv_purge(dpif
);
1380 /* Arranges for the poll loop for an upcall handler to wake up when 'dpif'
1381 * 'dpif' has a message queued to be received with the recv member
1382 * function. Since there can be multiple poll loops, 'handler_id' is
1383 * needed as index to identify the corresponding poll loop. */
1385 dpif_recv_wait(struct dpif
*dpif
, uint32_t handler_id
)
1387 if (dpif
->dpif_class
->recv_wait
) {
1388 dpif
->dpif_class
->recv_wait(dpif
, handler_id
);
1393 * Return the datapath version. Caller is responsible for freeing
1397 dpif_get_dp_version(const struct dpif
*dpif
)
1399 char *version
= NULL
;
1401 if (dpif
->dpif_class
->get_datapath_version
) {
1402 version
= dpif
->dpif_class
->get_datapath_version();
1408 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1409 * and '*engine_id', respectively. */
1411 dpif_get_netflow_ids(const struct dpif
*dpif
,
1412 uint8_t *engine_type
, uint8_t *engine_id
)
1414 *engine_type
= dpif
->netflow_engine_type
;
1415 *engine_id
= dpif
->netflow_engine_id
;
1418 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1419 * value used for setting packet priority.
1420 * On success, returns 0 and stores the priority into '*priority'.
1421 * On failure, returns a positive errno value and stores 0 into '*priority'. */
1423 dpif_queue_to_priority(const struct dpif
*dpif
, uint32_t queue_id
,
1426 int error
= (dpif
->dpif_class
->queue_to_priority
1427 ? dpif
->dpif_class
->queue_to_priority(dpif
, queue_id
,
1433 log_operation(dpif
, "queue_to_priority", error
);
1438 dpif_init(struct dpif
*dpif
, const struct dpif_class
*dpif_class
,
1440 uint8_t netflow_engine_type
, uint8_t netflow_engine_id
)
1442 dpif
->dpif_class
= dpif_class
;
1443 dpif
->base_name
= xstrdup(name
);
1444 dpif
->full_name
= xasprintf("%s@%s", dpif_class
->type
, name
);
1445 dpif
->netflow_engine_type
= netflow_engine_type
;
1446 dpif
->netflow_engine_id
= netflow_engine_id
;
1449 /* Undoes the results of initialization.
1451 * Normally this function only needs to be called from dpif_close().
1452 * However, it may be called by providers due to an error on opening
1453 * that occurs after initialization. It this case dpif_close() would
1454 * never be called. */
1456 dpif_uninit(struct dpif
*dpif
, bool close
)
1458 char *base_name
= dpif
->base_name
;
1459 char *full_name
= dpif
->full_name
;
1462 dpif
->dpif_class
->close(dpif
);
1470 log_operation(const struct dpif
*dpif
, const char *operation
, int error
)
1473 VLOG_DBG_RL(&dpmsg_rl
, "%s: %s success", dpif_name(dpif
), operation
);
1474 } else if (ofperr_is_valid(error
)) {
1475 VLOG_WARN_RL(&error_rl
, "%s: %s failed (%s)",
1476 dpif_name(dpif
), operation
, ofperr_get_name(error
));
1478 VLOG_WARN_RL(&error_rl
, "%s: %s failed (%s)",
1479 dpif_name(dpif
), operation
, ovs_strerror(error
));
1483 static enum vlog_level
1484 flow_message_log_level(int error
)
1486 /* If flows arrive in a batch, userspace may push down multiple
1487 * unique flow definitions that overlap when wildcards are applied.
1488 * Kernels that support flow wildcarding will reject these flows as
1489 * duplicates (EEXIST), so lower the log level to debug for these
1490 * types of messages. */
1491 return (error
&& error
!= EEXIST
) ? VLL_WARN
: VLL_DBG
;
1495 should_log_flow_message(int error
)
1497 return !vlog_should_drop(THIS_MODULE
, flow_message_log_level(error
),
1498 error
? &error_rl
: &dpmsg_rl
);
1502 log_flow_message(const struct dpif
*dpif
, int error
, const char *operation
,
1503 const struct nlattr
*key
, size_t key_len
,
1504 const struct nlattr
*mask
, size_t mask_len
,
1505 const struct dpif_flow_stats
*stats
,
1506 const struct nlattr
*actions
, size_t actions_len
)
1508 struct ds ds
= DS_EMPTY_INITIALIZER
;
1509 ds_put_format(&ds
, "%s: ", dpif_name(dpif
));
1511 ds_put_cstr(&ds
, "failed to ");
1513 ds_put_format(&ds
, "%s ", operation
);
1515 ds_put_format(&ds
, "(%s) ", ovs_strerror(error
));
1517 odp_flow_format(key
, key_len
, mask
, mask_len
, NULL
, &ds
, true);
1519 ds_put_cstr(&ds
, ", ");
1520 dpif_flow_stats_format(stats
, &ds
);
1522 if (actions
|| actions_len
) {
1523 ds_put_cstr(&ds
, ", actions:");
1524 format_odp_actions(&ds
, actions
, actions_len
);
1526 vlog(THIS_MODULE
, flow_message_log_level(error
), "%s", ds_cstr(&ds
));
1531 log_flow_put_message(struct dpif
*dpif
, const struct dpif_flow_put
*put
,
1534 if (should_log_flow_message(error
) && !(put
->flags
& DPIF_FP_PROBE
)) {
1538 ds_put_cstr(&s
, "put");
1539 if (put
->flags
& DPIF_FP_CREATE
) {
1540 ds_put_cstr(&s
, "[create]");
1542 if (put
->flags
& DPIF_FP_MODIFY
) {
1543 ds_put_cstr(&s
, "[modify]");
1545 if (put
->flags
& DPIF_FP_ZERO_STATS
) {
1546 ds_put_cstr(&s
, "[zero]");
1548 log_flow_message(dpif
, error
, ds_cstr(&s
),
1549 put
->key
, put
->key_len
, put
->mask
, put
->mask_len
,
1550 put
->stats
, put
->actions
, put
->actions_len
);
1556 log_flow_del_message(struct dpif
*dpif
, const struct dpif_flow_del
*del
,
1559 if (should_log_flow_message(error
)) {
1560 log_flow_message(dpif
, error
, "flow_del", del
->key
, del
->key_len
,
1561 NULL
, 0, !error
? del
->stats
: NULL
, NULL
, 0);
1565 /* Logs that 'execute' was executed on 'dpif' and completed with errno 'error'
1566 * (0 for success). 'subexecute' should be true if the execution is a result
1567 * of breaking down a larger execution that needed help, false otherwise.
1570 * XXX In theory, the log message could be deceptive because this function is
1571 * called after the dpif_provider's '->execute' function, which is allowed to
1572 * modify execute->packet and execute->md. In practice, though:
1574 * - dpif-netlink doesn't modify execute->packet or execute->md.
1576 * - dpif-netdev does modify them but it is less likely to have problems
1577 * because it is built into ovs-vswitchd and cannot have version skew,
1580 * It would still be better to avoid the potential problem. I don't know of a
1581 * good way to do that, though, that isn't expensive. */
1583 log_execute_message(struct dpif
*dpif
, const struct dpif_execute
*execute
,
1584 bool subexecute
, int error
)
1586 if (!(error
? VLOG_DROP_WARN(&error_rl
) : VLOG_DROP_DBG(&dpmsg_rl
))
1587 && !execute
->probe
) {
1588 struct ds ds
= DS_EMPTY_INITIALIZER
;
1591 packet
= ofp_packet_to_string(ofpbuf_data(execute
->packet
),
1592 ofpbuf_size(execute
->packet
));
1593 ds_put_format(&ds
, "%s: %sexecute ",
1595 (subexecute
? "sub-"
1596 : dpif_execute_needs_help(execute
) ? "super-"
1598 format_odp_actions(&ds
, execute
->actions
, execute
->actions_len
);
1600 ds_put_format(&ds
, " failed (%s)", ovs_strerror(error
));
1602 ds_put_format(&ds
, " on packet %s", packet
);
1603 vlog(THIS_MODULE
, error
? VLL_WARN
: VLL_DBG
, "%s", ds_cstr(&ds
));
1610 log_flow_get_message(const struct dpif
*dpif
, const struct dpif_flow_get
*get
,
1613 if (should_log_flow_message(error
)) {
1614 log_flow_message(dpif
, error
, "flow_get",
1615 get
->key
, get
->key_len
,
1616 get
->flow
->mask
, get
->flow
->mask_len
,
1618 get
->flow
->actions
, get
->flow
->actions_len
);
1623 dpif_supports_tnl_push_pop(const struct dpif
*dpif
)
1625 return !strcmp(dpif
->dpif_class
->type
, "netdev") ||
1626 !strcmp(dpif
->dpif_class
->type
, "dummy");