2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 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"
32 #include "ofp-errors.h"
33 #include "ofp-print.h"
37 #include "poll-loop.h"
45 VLOG_DEFINE_THIS_MODULE(dpif
);
47 COVERAGE_DEFINE(dpif_destroy
);
48 COVERAGE_DEFINE(dpif_port_add
);
49 COVERAGE_DEFINE(dpif_port_del
);
50 COVERAGE_DEFINE(dpif_flow_flush
);
51 COVERAGE_DEFINE(dpif_flow_get
);
52 COVERAGE_DEFINE(dpif_flow_put
);
53 COVERAGE_DEFINE(dpif_flow_del
);
54 COVERAGE_DEFINE(dpif_flow_query_list
);
55 COVERAGE_DEFINE(dpif_flow_query_list_n
);
56 COVERAGE_DEFINE(dpif_execute
);
57 COVERAGE_DEFINE(dpif_purge
);
59 static const struct dpif_class
*base_dpif_classes
[] = {
66 struct registered_dpif_class
{
67 const struct dpif_class
*dpif_class
;
70 static struct shash dpif_classes
= SHASH_INITIALIZER(&dpif_classes
);
71 static struct sset dpif_blacklist
= SSET_INITIALIZER(&dpif_blacklist
);
73 /* Protects 'dpif_classes', including the refcount, and 'dpif_blacklist'. */
74 static struct ovs_mutex dpif_mutex
= OVS_MUTEX_INITIALIZER
;
76 /* Rate limit for individual messages going to or from the datapath, output at
77 * DBG level. This is very high because, if these are enabled, it is because
78 * we really need to see them. */
79 static struct vlog_rate_limit dpmsg_rl
= VLOG_RATE_LIMIT_INIT(600, 600);
81 /* Not really much point in logging many dpif errors. */
82 static struct vlog_rate_limit error_rl
= VLOG_RATE_LIMIT_INIT(60, 5);
84 static void log_flow_message(const struct dpif
*dpif
, int error
,
85 const char *operation
,
86 const struct nlattr
*key
, size_t key_len
,
87 const struct nlattr
*mask
, size_t mask_len
,
88 const struct dpif_flow_stats
*stats
,
89 const struct nlattr
*actions
, size_t actions_len
);
90 static void log_operation(const struct dpif
*, const char *operation
,
92 static bool should_log_flow_message(int error
);
93 static void log_flow_put_message(struct dpif
*, const struct dpif_flow_put
*,
95 static void log_flow_del_message(struct dpif
*, const struct dpif_flow_del
*,
97 static void log_execute_message(struct dpif
*, const struct dpif_execute
*,
103 static struct ovsthread_once once
= OVSTHREAD_ONCE_INITIALIZER
;
105 if (ovsthread_once_start(&once
)) {
108 for (i
= 0; i
< ARRAY_SIZE(base_dpif_classes
); i
++) {
109 dp_register_provider(base_dpif_classes
[i
]);
111 ovsthread_once_done(&once
);
116 dp_register_provider__(const struct dpif_class
*new_class
)
118 struct registered_dpif_class
*registered_class
;
120 if (sset_contains(&dpif_blacklist
, new_class
->type
)) {
121 VLOG_DBG("attempted to register blacklisted provider: %s",
126 if (shash_find(&dpif_classes
, new_class
->type
)) {
127 VLOG_WARN("attempted to register duplicate datapath provider: %s",
132 registered_class
= xmalloc(sizeof *registered_class
);
133 registered_class
->dpif_class
= new_class
;
134 registered_class
->refcount
= 0;
136 shash_add(&dpif_classes
, new_class
->type
, registered_class
);
141 /* Registers a new datapath provider. After successful registration, new
142 * datapaths of that type can be opened using dpif_open(). */
144 dp_register_provider(const struct dpif_class
*new_class
)
148 ovs_mutex_lock(&dpif_mutex
);
149 error
= dp_register_provider__(new_class
);
150 ovs_mutex_unlock(&dpif_mutex
);
155 /* Unregisters a datapath provider. 'type' must have been previously
156 * registered and not currently be in use by any dpifs. After unregistration
157 * new datapaths of that type cannot be opened using dpif_open(). */
159 dp_unregister_provider__(const char *type
)
161 struct shash_node
*node
;
162 struct registered_dpif_class
*registered_class
;
164 node
= shash_find(&dpif_classes
, type
);
166 VLOG_WARN("attempted to unregister a datapath provider that is not "
167 "registered: %s", type
);
171 registered_class
= node
->data
;
172 if (registered_class
->refcount
) {
173 VLOG_WARN("attempted to unregister in use datapath provider: %s", type
);
177 shash_delete(&dpif_classes
, node
);
178 free(registered_class
);
183 /* Unregisters a datapath provider. 'type' must have been previously
184 * registered and not currently be in use by any dpifs. After unregistration
185 * new datapaths of that type cannot be opened using dpif_open(). */
187 dp_unregister_provider(const char *type
)
193 ovs_mutex_lock(&dpif_mutex
);
194 error
= dp_unregister_provider__(type
);
195 ovs_mutex_unlock(&dpif_mutex
);
200 /* Blacklists a provider. Causes future calls of dp_register_provider() with
201 * a dpif_class which implements 'type' to fail. */
203 dp_blacklist_provider(const char *type
)
205 ovs_mutex_lock(&dpif_mutex
);
206 sset_add(&dpif_blacklist
, type
);
207 ovs_mutex_unlock(&dpif_mutex
);
210 /* Clears 'types' and enumerates the types of all currently registered datapath
211 * providers into it. The caller must first initialize the sset. */
213 dp_enumerate_types(struct sset
*types
)
215 struct shash_node
*node
;
220 ovs_mutex_lock(&dpif_mutex
);
221 SHASH_FOR_EACH(node
, &dpif_classes
) {
222 const struct registered_dpif_class
*registered_class
= node
->data
;
223 sset_add(types
, registered_class
->dpif_class
->type
);
225 ovs_mutex_unlock(&dpif_mutex
);
229 dp_class_unref(struct registered_dpif_class
*rc
)
231 ovs_mutex_lock(&dpif_mutex
);
232 ovs_assert(rc
->refcount
);
234 ovs_mutex_unlock(&dpif_mutex
);
237 static struct registered_dpif_class
*
238 dp_class_lookup(const char *type
)
240 struct registered_dpif_class
*rc
;
242 ovs_mutex_lock(&dpif_mutex
);
243 rc
= shash_find_data(&dpif_classes
, type
);
247 ovs_mutex_unlock(&dpif_mutex
);
252 /* Clears 'names' and enumerates the names of all known created datapaths with
253 * the given 'type'. The caller must first initialize the sset. Returns 0 if
254 * successful, otherwise a positive errno value.
256 * Some kinds of datapaths might not be practically enumerable. This is not
257 * considered an error. */
259 dp_enumerate_names(const char *type
, struct sset
*names
)
261 struct registered_dpif_class
*registered_class
;
262 const struct dpif_class
*dpif_class
;
268 registered_class
= dp_class_lookup(type
);
269 if (!registered_class
) {
270 VLOG_WARN("could not enumerate unknown type: %s", type
);
274 dpif_class
= registered_class
->dpif_class
;
275 error
= dpif_class
->enumerate
? dpif_class
->enumerate(names
) : 0;
277 VLOG_WARN("failed to enumerate %s datapaths: %s", dpif_class
->type
,
278 ovs_strerror(error
));
280 dp_class_unref(registered_class
);
285 /* Parses 'datapath_name_', which is of the form [type@]name into its
286 * component pieces. 'name' and 'type' must be freed by the caller.
288 * The returned 'type' is normalized, as if by dpif_normalize_type(). */
290 dp_parse_name(const char *datapath_name_
, char **name
, char **type
)
292 char *datapath_name
= xstrdup(datapath_name_
);
295 separator
= strchr(datapath_name
, '@');
298 *type
= datapath_name
;
299 *name
= xstrdup(dpif_normalize_type(separator
+ 1));
301 *name
= datapath_name
;
302 *type
= xstrdup(dpif_normalize_type(NULL
));
307 do_open(const char *name
, const char *type
, bool create
, struct dpif
**dpifp
)
309 struct dpif
*dpif
= NULL
;
311 struct registered_dpif_class
*registered_class
;
315 type
= dpif_normalize_type(type
);
316 registered_class
= dp_class_lookup(type
);
317 if (!registered_class
) {
318 VLOG_WARN("could not create datapath %s of unknown type %s", name
,
320 error
= EAFNOSUPPORT
;
324 error
= registered_class
->dpif_class
->open(registered_class
->dpif_class
,
325 name
, create
, &dpif
);
327 ovs_assert(dpif
->dpif_class
== registered_class
->dpif_class
);
329 dp_class_unref(registered_class
);
333 *dpifp
= error
? NULL
: dpif
;
337 /* Tries to open an existing datapath named 'name' and type 'type'. Will fail
338 * if no datapath with 'name' and 'type' exists. 'type' may be either NULL or
339 * the empty string to specify the default system type. Returns 0 if
340 * successful, otherwise a positive errno value. On success stores a pointer
341 * to the datapath in '*dpifp', otherwise a null pointer. */
343 dpif_open(const char *name
, const char *type
, struct dpif
**dpifp
)
345 return do_open(name
, type
, false, dpifp
);
348 /* Tries to create and open a new datapath with the given 'name' and 'type'.
349 * 'type' may be either NULL or the empty string to specify the default system
350 * type. Will fail if a datapath with 'name' and 'type' already exists.
351 * Returns 0 if successful, otherwise a positive errno value. On success
352 * stores a pointer to the datapath in '*dpifp', otherwise a null pointer. */
354 dpif_create(const char *name
, const char *type
, struct dpif
**dpifp
)
356 return do_open(name
, type
, true, dpifp
);
359 /* Tries to open a datapath with the given 'name' and 'type', creating it if it
360 * does not exist. 'type' may be either NULL or the empty string to specify
361 * the default system type. Returns 0 if successful, otherwise a positive
362 * errno value. On success stores a pointer to the datapath in '*dpifp',
363 * otherwise a null pointer. */
365 dpif_create_and_open(const char *name
, const char *type
, struct dpif
**dpifp
)
369 error
= dpif_create(name
, type
, dpifp
);
370 if (error
== EEXIST
|| error
== EBUSY
) {
371 error
= dpif_open(name
, type
, dpifp
);
373 VLOG_WARN("datapath %s already exists but cannot be opened: %s",
374 name
, ovs_strerror(error
));
377 VLOG_WARN("failed to create datapath %s: %s",
378 name
, ovs_strerror(error
));
383 /* Closes and frees the connection to 'dpif'. Does not destroy the datapath
384 * itself; call dpif_delete() first, instead, if that is desirable. */
386 dpif_close(struct dpif
*dpif
)
389 struct registered_dpif_class
*rc
;
391 rc
= shash_find_data(&dpif_classes
, dpif
->dpif_class
->type
);
392 dpif_uninit(dpif
, true);
397 /* Performs periodic work needed by 'dpif'. */
399 dpif_run(struct dpif
*dpif
)
401 if (dpif
->dpif_class
->run
) {
402 dpif
->dpif_class
->run(dpif
);
406 /* Arranges for poll_block() to wake up when dp_run() needs to be called for
409 dpif_wait(struct dpif
*dpif
)
411 if (dpif
->dpif_class
->wait
) {
412 dpif
->dpif_class
->wait(dpif
);
416 /* Returns the name of datapath 'dpif' prefixed with the type
417 * (for use in log messages). */
419 dpif_name(const struct dpif
*dpif
)
421 return dpif
->full_name
;
424 /* Returns the name of datapath 'dpif' without the type
425 * (for use in device names). */
427 dpif_base_name(const struct dpif
*dpif
)
429 return dpif
->base_name
;
432 /* Returns the type of datapath 'dpif'. */
434 dpif_type(const struct dpif
*dpif
)
436 return dpif
->dpif_class
->type
;
439 /* Returns the fully spelled out name for the given datapath 'type'.
441 * Normalized type string can be compared with strcmp(). Unnormalized type
442 * string might be the same even if they have different spellings. */
444 dpif_normalize_type(const char *type
)
446 return type
&& type
[0] ? type
: "system";
449 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
450 * ports. After calling this function, it does not make sense to pass 'dpif'
451 * to any functions other than dpif_name() or dpif_close(). */
453 dpif_delete(struct dpif
*dpif
)
457 COVERAGE_INC(dpif_destroy
);
459 error
= dpif
->dpif_class
->destroy(dpif
);
460 log_operation(dpif
, "delete", error
);
464 /* Retrieves statistics for 'dpif' into 'stats'. Returns 0 if successful,
465 * otherwise a positive errno value. */
467 dpif_get_dp_stats(const struct dpif
*dpif
, struct dpif_dp_stats
*stats
)
469 int error
= dpif
->dpif_class
->get_stats(dpif
, stats
);
471 memset(stats
, 0, sizeof *stats
);
473 log_operation(dpif
, "get_stats", error
);
478 dpif_port_open_type(const char *datapath_type
, const char *port_type
)
480 struct registered_dpif_class
*rc
;
482 datapath_type
= dpif_normalize_type(datapath_type
);
484 ovs_mutex_lock(&dpif_mutex
);
485 rc
= shash_find_data(&dpif_classes
, datapath_type
);
486 if (rc
&& rc
->dpif_class
->port_open_type
) {
487 port_type
= rc
->dpif_class
->port_open_type(rc
->dpif_class
, port_type
);
489 ovs_mutex_unlock(&dpif_mutex
);
494 /* Attempts to add 'netdev' as a port on 'dpif'. If 'port_nop' is
495 * non-null and its value is not ODPP_NONE, then attempts to use the
496 * value as the port number.
498 * If successful, returns 0 and sets '*port_nop' to the new port's port
499 * number (if 'port_nop' is non-null). On failure, returns a positive
500 * errno value and sets '*port_nop' to ODPP_NONE (if 'port_nop' is
503 dpif_port_add(struct dpif
*dpif
, struct netdev
*netdev
, odp_port_t
*port_nop
)
505 const char *netdev_name
= netdev_get_name(netdev
);
506 odp_port_t port_no
= ODPP_NONE
;
509 COVERAGE_INC(dpif_port_add
);
515 error
= dpif
->dpif_class
->port_add(dpif
, netdev
, &port_no
);
517 VLOG_DBG_RL(&dpmsg_rl
, "%s: added %s as port %"PRIu32
,
518 dpif_name(dpif
), netdev_name
, port_no
);
520 VLOG_WARN_RL(&error_rl
, "%s: failed to add %s as port: %s",
521 dpif_name(dpif
), netdev_name
, ovs_strerror(error
));
530 /* Attempts to remove 'dpif''s port number 'port_no'. Returns 0 if successful,
531 * otherwise a positive errno value. */
533 dpif_port_del(struct dpif
*dpif
, odp_port_t port_no
)
537 COVERAGE_INC(dpif_port_del
);
539 error
= dpif
->dpif_class
->port_del(dpif
, port_no
);
541 VLOG_DBG_RL(&dpmsg_rl
, "%s: port_del(%"PRIu32
")",
542 dpif_name(dpif
), port_no
);
544 log_operation(dpif
, "port_del", error
);
549 /* Makes a deep copy of 'src' into 'dst'. */
551 dpif_port_clone(struct dpif_port
*dst
, const struct dpif_port
*src
)
553 dst
->name
= xstrdup(src
->name
);
554 dst
->type
= xstrdup(src
->type
);
555 dst
->port_no
= src
->port_no
;
558 /* Frees memory allocated to members of 'dpif_port'.
560 * Do not call this function on a dpif_port obtained from
561 * dpif_port_dump_next(): that function retains ownership of the data in the
564 dpif_port_destroy(struct dpif_port
*dpif_port
)
566 free(dpif_port
->name
);
567 free(dpif_port
->type
);
570 /* Checks if port named 'devname' exists in 'dpif'. If so, returns
571 * true; otherwise, returns false. */
573 dpif_port_exists(const struct dpif
*dpif
, const char *devname
)
575 int error
= dpif
->dpif_class
->port_query_by_name(dpif
, devname
, NULL
);
576 if (error
!= 0 && error
!= ENOENT
&& error
!= ENODEV
) {
577 VLOG_WARN_RL(&error_rl
, "%s: failed to query port %s: %s",
578 dpif_name(dpif
), devname
, ovs_strerror(error
));
584 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and
585 * initializes '*port' appropriately; on failure, returns a positive errno
588 * The caller owns the data in 'port' and must free it with
589 * dpif_port_destroy() when it is no longer needed. */
591 dpif_port_query_by_number(const struct dpif
*dpif
, odp_port_t port_no
,
592 struct dpif_port
*port
)
594 int error
= dpif
->dpif_class
->port_query_by_number(dpif
, port_no
, port
);
596 VLOG_DBG_RL(&dpmsg_rl
, "%s: port %"PRIu32
" is device %s",
597 dpif_name(dpif
), port_no
, port
->name
);
599 memset(port
, 0, sizeof *port
);
600 VLOG_WARN_RL(&error_rl
, "%s: failed to query port %"PRIu32
": %s",
601 dpif_name(dpif
), port_no
, ovs_strerror(error
));
606 /* Looks up port named 'devname' in 'dpif'. On success, returns 0 and
607 * initializes '*port' appropriately; on failure, returns a positive errno
610 * The caller owns the data in 'port' and must free it with
611 * dpif_port_destroy() when it is no longer needed. */
613 dpif_port_query_by_name(const struct dpif
*dpif
, const char *devname
,
614 struct dpif_port
*port
)
616 int error
= dpif
->dpif_class
->port_query_by_name(dpif
, devname
, port
);
618 VLOG_DBG_RL(&dpmsg_rl
, "%s: device %s is on port %"PRIu32
,
619 dpif_name(dpif
), devname
, port
->port_no
);
621 memset(port
, 0, sizeof *port
);
623 /* For ENOENT or ENODEV we use DBG level because the caller is probably
624 * interested in whether 'dpif' actually has a port 'devname', so that
625 * it's not an issue worth logging if it doesn't. Other errors are
626 * uncommon and more likely to indicate a real problem. */
628 error
== ENOENT
|| error
== ENODEV
? VLL_DBG
: VLL_WARN
,
629 "%s: failed to query port %s: %s",
630 dpif_name(dpif
), devname
, ovs_strerror(error
));
635 /* Returns one greater than the maximum port number accepted in flow
638 dpif_get_max_ports(const struct dpif
*dpif
)
640 return dpif
->dpif_class
->get_max_ports(dpif
);
643 /* Returns the Netlink PID value to supply in OVS_ACTION_ATTR_USERSPACE actions
644 * as the OVS_USERSPACE_ATTR_PID attribute's value, for use in flows whose
645 * packets arrived on port 'port_no'.
647 * A 'port_no' of ODPP_NONE is a special case: it returns a reserved PID, not
648 * allocated to any port, that the client may use for special purposes.
650 * The return value is only meaningful when DPIF_UC_ACTION has been enabled in
651 * the 'dpif''s listen mask. It is allowed to change when DPIF_UC_ACTION is
652 * disabled and then re-enabled, so a client that does that must be prepared to
653 * update all of the flows that it installed that contain
654 * OVS_ACTION_ATTR_USERSPACE actions. */
656 dpif_port_get_pid(const struct dpif
*dpif
, odp_port_t port_no
)
658 return (dpif
->dpif_class
->port_get_pid
659 ? (dpif
->dpif_class
->port_get_pid
)(dpif
, port_no
)
663 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and copies
664 * the port's name into the 'name_size' bytes in 'name', ensuring that the
665 * result is null-terminated. On failure, returns a positive errno value and
666 * makes 'name' the empty string. */
668 dpif_port_get_name(struct dpif
*dpif
, odp_port_t port_no
,
669 char *name
, size_t name_size
)
671 struct dpif_port port
;
674 ovs_assert(name_size
> 0);
676 error
= dpif_port_query_by_number(dpif
, port_no
, &port
);
678 ovs_strlcpy(name
, port
.name
, name_size
);
679 dpif_port_destroy(&port
);
686 /* Initializes 'dump' to begin dumping the ports in a dpif.
688 * This function provides no status indication. An error status for the entire
689 * dump operation is provided when it is completed by calling
690 * dpif_port_dump_done().
693 dpif_port_dump_start(struct dpif_port_dump
*dump
, const struct dpif
*dpif
)
696 dump
->error
= dpif
->dpif_class
->port_dump_start(dpif
, &dump
->state
);
697 log_operation(dpif
, "port_dump_start", dump
->error
);
700 /* Attempts to retrieve another port from 'dump', which must have been
701 * initialized with dpif_port_dump_start(). On success, stores a new dpif_port
702 * into 'port' and returns true. On failure, returns false.
704 * Failure might indicate an actual error or merely that the last port has been
705 * dumped. An error status for the entire dump operation is provided when it
706 * is completed by calling dpif_port_dump_done().
708 * The dpif owns the data stored in 'port'. It will remain valid until at
709 * least the next time 'dump' is passed to dpif_port_dump_next() or
710 * dpif_port_dump_done(). */
712 dpif_port_dump_next(struct dpif_port_dump
*dump
, struct dpif_port
*port
)
714 const struct dpif
*dpif
= dump
->dpif
;
720 dump
->error
= dpif
->dpif_class
->port_dump_next(dpif
, dump
->state
, port
);
721 if (dump
->error
== EOF
) {
722 VLOG_DBG_RL(&dpmsg_rl
, "%s: dumped all ports", dpif_name(dpif
));
724 log_operation(dpif
, "port_dump_next", dump
->error
);
728 dpif
->dpif_class
->port_dump_done(dpif
, dump
->state
);
734 /* Completes port table dump operation 'dump', which must have been initialized
735 * with dpif_port_dump_start(). Returns 0 if the dump operation was
736 * error-free, otherwise a positive errno value describing the problem. */
738 dpif_port_dump_done(struct dpif_port_dump
*dump
)
740 const struct dpif
*dpif
= dump
->dpif
;
742 dump
->error
= dpif
->dpif_class
->port_dump_done(dpif
, dump
->state
);
743 log_operation(dpif
, "port_dump_done", dump
->error
);
745 return dump
->error
== EOF
? 0 : dump
->error
;
748 /* Polls for changes in the set of ports in 'dpif'. If the set of ports in
749 * 'dpif' has changed, this function does one of the following:
751 * - Stores the name of the device that was added to or deleted from 'dpif' in
752 * '*devnamep' and returns 0. The caller is responsible for freeing
753 * '*devnamep' (with free()) when it no longer needs it.
755 * - Returns ENOBUFS and sets '*devnamep' to NULL.
757 * This function may also return 'false positives', where it returns 0 and
758 * '*devnamep' names a device that was not actually added or deleted or it
759 * returns ENOBUFS without any change.
761 * Returns EAGAIN if the set of ports in 'dpif' has not changed. May also
762 * return other positive errno values to indicate that something has gone
765 dpif_port_poll(const struct dpif
*dpif
, char **devnamep
)
767 int error
= dpif
->dpif_class
->port_poll(dpif
, devnamep
);
774 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
775 * value other than EAGAIN. */
777 dpif_port_poll_wait(const struct dpif
*dpif
)
779 dpif
->dpif_class
->port_poll_wait(dpif
);
782 /* Extracts the flow stats for a packet. The 'flow' and 'packet'
783 * arguments must have been initialized through a call to flow_extract().
784 * 'used' is stored into stats->used. */
786 dpif_flow_stats_extract(const struct flow
*flow
, const struct ofpbuf
*packet
,
787 long long int used
, struct dpif_flow_stats
*stats
)
789 stats
->tcp_flags
= packet_get_tcp_flags(packet
, flow
);
790 stats
->n_bytes
= packet
->size
;
791 stats
->n_packets
= 1;
795 /* Appends a human-readable representation of 'stats' to 's'. */
797 dpif_flow_stats_format(const struct dpif_flow_stats
*stats
, struct ds
*s
)
799 ds_put_format(s
, "packets:%"PRIu64
", bytes:%"PRIu64
", used:",
800 stats
->n_packets
, stats
->n_bytes
);
802 ds_put_format(s
, "%.3fs", (time_msec() - stats
->used
) / 1000.0);
804 ds_put_format(s
, "never");
806 if (stats
->tcp_flags
) {
807 ds_put_cstr(s
, ", flags:");
808 packet_format_tcp_flags(s
, stats
->tcp_flags
);
812 /* Deletes all flows from 'dpif'. Returns 0 if successful, otherwise a
813 * positive errno value. */
815 dpif_flow_flush(struct dpif
*dpif
)
819 COVERAGE_INC(dpif_flow_flush
);
821 error
= dpif
->dpif_class
->flow_flush(dpif
);
822 log_operation(dpif
, "flow_flush", error
);
826 /* Queries 'dpif' for a flow entry. The flow is specified by the Netlink
827 * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
830 * Returns 0 if successful. If no flow matches, returns ENOENT. On other
831 * failure, returns a positive errno value.
833 * If 'actionsp' is nonnull, then on success '*actionsp' will be set to an
834 * ofpbuf owned by the caller that contains the Netlink attributes for the
835 * flow's actions. The caller must free the ofpbuf (with ofpbuf_delete()) when
836 * it is no longer needed.
838 * If 'stats' is nonnull, then on success it will be updated with the flow's
841 dpif_flow_get(const struct dpif
*dpif
,
842 const struct nlattr
*key
, size_t key_len
,
843 struct ofpbuf
**actionsp
, struct dpif_flow_stats
*stats
)
847 COVERAGE_INC(dpif_flow_get
);
849 error
= dpif
->dpif_class
->flow_get(dpif
, key
, key_len
, actionsp
, stats
);
855 memset(stats
, 0, sizeof *stats
);
858 if (should_log_flow_message(error
)) {
859 const struct nlattr
*actions
;
862 if (!error
&& actionsp
) {
863 actions
= (*actionsp
)->data
;
864 actions_len
= (*actionsp
)->size
;
869 log_flow_message(dpif
, error
, "flow_get", key
, key_len
,
870 NULL
, 0, stats
, actions
, actions_len
);
876 dpif_flow_put__(struct dpif
*dpif
, const struct dpif_flow_put
*put
)
880 COVERAGE_INC(dpif_flow_put
);
881 ovs_assert(!(put
->flags
& ~(DPIF_FP_CREATE
| DPIF_FP_MODIFY
882 | DPIF_FP_ZERO_STATS
)));
884 error
= dpif
->dpif_class
->flow_put(dpif
, put
);
885 if (error
&& put
->stats
) {
886 memset(put
->stats
, 0, sizeof *put
->stats
);
888 log_flow_put_message(dpif
, put
, error
);
892 /* Adds or modifies a flow in 'dpif'. The flow is specified by the Netlink
893 * attribute OVS_FLOW_ATTR_KEY with types OVS_KEY_ATTR_* in the 'key_len' bytes
894 * starting at 'key', and OVS_FLOW_ATTR_MASK with types of OVS_KEY_ATTR_* in the
895 * 'mask_len' bytes starting at 'mask'. The associated actions are specified by
896 * the Netlink attributes with types OVS_ACTION_ATTR_* in the 'actions_len'
897 * bytes starting at 'actions'.
899 * - If the flow's key does not exist in 'dpif', then the flow will be added if
900 * 'flags' includes DPIF_FP_CREATE. Otherwise the operation will fail with
903 * If the operation succeeds, then 'stats', if nonnull, will be zeroed.
905 * - If the flow's key does exist in 'dpif', then the flow's actions will be
906 * updated if 'flags' includes DPIF_FP_MODIFY. Otherwise the operation will
907 * fail with EEXIST. If the flow's actions are updated, then its statistics
908 * will be zeroed if 'flags' includes DPIF_FP_ZERO_STATS, and left as-is
911 * If the operation succeeds, then 'stats', if nonnull, will be set to the
912 * flow's statistics before the update.
915 dpif_flow_put(struct dpif
*dpif
, enum dpif_flow_put_flags flags
,
916 const struct nlattr
*key
, size_t key_len
,
917 const struct nlattr
*mask
, size_t mask_len
,
918 const struct nlattr
*actions
, size_t actions_len
,
919 struct dpif_flow_stats
*stats
)
921 struct dpif_flow_put put
;
925 put
.key_len
= key_len
;
927 put
.mask_len
= mask_len
;
928 put
.actions
= actions
;
929 put
.actions_len
= actions_len
;
931 return dpif_flow_put__(dpif
, &put
);
935 dpif_flow_del__(struct dpif
*dpif
, struct dpif_flow_del
*del
)
939 COVERAGE_INC(dpif_flow_del
);
941 error
= dpif
->dpif_class
->flow_del(dpif
, del
);
942 if (error
&& del
->stats
) {
943 memset(del
->stats
, 0, sizeof *del
->stats
);
945 log_flow_del_message(dpif
, del
, error
);
949 /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif' does
950 * not contain such a flow. The flow is specified by the Netlink attributes
951 * with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at 'key'.
953 * If the operation succeeds, then 'stats', if nonnull, will be set to the
954 * flow's statistics before its deletion. */
956 dpif_flow_del(struct dpif
*dpif
,
957 const struct nlattr
*key
, size_t key_len
,
958 struct dpif_flow_stats
*stats
)
960 struct dpif_flow_del del
;
963 del
.key_len
= key_len
;
965 return dpif_flow_del__(dpif
, &del
);
968 /* Initializes 'dump' to begin dumping the flows in a dpif.
970 * This function provides no status indication. An error status for the entire
971 * dump operation is provided when it is completed by calling
972 * dpif_flow_dump_done().
975 dpif_flow_dump_start(struct dpif_flow_dump
*dump
, const struct dpif
*dpif
)
978 dump
->error
= dpif
->dpif_class
->flow_dump_start(dpif
, &dump
->state
);
979 log_operation(dpif
, "flow_dump_start", dump
->error
);
982 /* Attempts to retrieve another flow from 'dump', which must have been
983 * initialized with dpif_flow_dump_start(). On success, updates the output
984 * parameters as described below and returns true. Otherwise, returns false.
985 * Failure might indicate an actual error or merely the end of the flow table.
986 * An error status for the entire dump operation is provided when it is
987 * completed by calling dpif_flow_dump_done().
989 * On success, if 'key' and 'key_len' are nonnull then '*key' and '*key_len'
990 * will be set to Netlink attributes with types OVS_KEY_ATTR_* representing the
991 * dumped flow's key. If 'actions' and 'actions_len' are nonnull then they are
992 * set to Netlink attributes with types OVS_ACTION_ATTR_* representing the
993 * dumped flow's actions. If 'stats' is nonnull then it will be set to the
994 * dumped flow's statistics.
996 * All of the returned data is owned by 'dpif', not by the caller, and the
997 * caller must not modify or free it. 'dpif' guarantees that it remains
998 * accessible and unchanging until at least the next call to 'flow_dump_next'
999 * or 'flow_dump_done' for 'dump'. */
1001 dpif_flow_dump_next(struct dpif_flow_dump
*dump
,
1002 const struct nlattr
**key
, size_t *key_len
,
1003 const struct nlattr
**mask
, size_t *mask_len
,
1004 const struct nlattr
**actions
, size_t *actions_len
,
1005 const struct dpif_flow_stats
**stats
)
1007 const struct dpif
*dpif
= dump
->dpif
;
1008 int error
= dump
->error
;
1011 error
= dpif
->dpif_class
->flow_dump_next(dpif
, dump
->state
,
1014 actions
, actions_len
,
1017 dpif
->dpif_class
->flow_dump_done(dpif
, dump
->state
);
1039 VLOG_DBG_RL(&dpmsg_rl
, "%s: dumped all flows", dpif_name(dpif
));
1040 } else if (should_log_flow_message(error
)) {
1041 log_flow_message(dpif
, error
, "flow_dump",
1042 key
? *key
: NULL
, key
? *key_len
: 0,
1043 mask
? *mask
: NULL
, mask
? *mask_len
: 0,
1044 stats
? *stats
: NULL
, actions
? *actions
: NULL
,
1045 actions
? *actions_len
: 0);
1048 dump
->error
= error
;
1052 /* Completes flow table dump operation 'dump', which must have been initialized
1053 * with dpif_flow_dump_start(). Returns 0 if the dump operation was
1054 * error-free, otherwise a positive errno value describing the problem. */
1056 dpif_flow_dump_done(struct dpif_flow_dump
*dump
)
1058 const struct dpif
*dpif
= dump
->dpif
;
1060 dump
->error
= dpif
->dpif_class
->flow_dump_done(dpif
, dump
->state
);
1061 log_operation(dpif
, "flow_dump_done", dump
->error
);
1063 return dump
->error
== EOF
? 0 : dump
->error
;
1067 dpif_execute__(struct dpif
*dpif
, const struct dpif_execute
*execute
)
1071 COVERAGE_INC(dpif_execute
);
1072 if (execute
->actions_len
> 0) {
1073 error
= dpif
->dpif_class
->execute(dpif
, execute
);
1078 log_execute_message(dpif
, execute
, error
);
1083 /* Causes 'dpif' to perform the 'actions_len' bytes of actions in 'actions' on
1084 * the Ethernet frame specified in 'packet' taken from the flow specified in
1085 * the 'key_len' bytes of 'key'. ('key' is mostly redundant with 'packet', but
1086 * it contains some metadata that cannot be recovered from 'packet', such as
1087 * tunnel and in_port.)
1089 * Returns 0 if successful, otherwise a positive errno value. */
1091 dpif_execute(struct dpif
*dpif
,
1092 const struct nlattr
*key
, size_t key_len
,
1093 const struct nlattr
*actions
, size_t actions_len
,
1094 const struct ofpbuf
*buf
)
1096 struct dpif_execute execute
;
1099 execute
.key_len
= key_len
;
1100 execute
.actions
= actions
;
1101 execute
.actions_len
= actions_len
;
1102 execute
.packet
= buf
;
1103 return dpif_execute__(dpif
, &execute
);
1106 /* Executes each of the 'n_ops' operations in 'ops' on 'dpif', in the order in
1107 * which they are specified, placing each operation's results in the "output"
1108 * members documented in comments.
1110 * This function exists because some datapaths can perform batched operations
1111 * faster than individual operations. */
1113 dpif_operate(struct dpif
*dpif
, struct dpif_op
**ops
, size_t n_ops
)
1117 if (dpif
->dpif_class
->operate
) {
1118 dpif
->dpif_class
->operate(dpif
, ops
, n_ops
);
1120 for (i
= 0; i
< n_ops
; i
++) {
1121 struct dpif_op
*op
= ops
[i
];
1124 case DPIF_OP_FLOW_PUT
:
1125 log_flow_put_message(dpif
, &op
->u
.flow_put
, op
->error
);
1128 case DPIF_OP_FLOW_DEL
:
1129 log_flow_del_message(dpif
, &op
->u
.flow_del
, op
->error
);
1132 case DPIF_OP_EXECUTE
:
1133 log_execute_message(dpif
, &op
->u
.execute
, op
->error
);
1140 for (i
= 0; i
< n_ops
; i
++) {
1141 struct dpif_op
*op
= ops
[i
];
1144 case DPIF_OP_FLOW_PUT
:
1145 op
->error
= dpif_flow_put__(dpif
, &op
->u
.flow_put
);
1148 case DPIF_OP_FLOW_DEL
:
1149 op
->error
= dpif_flow_del__(dpif
, &op
->u
.flow_del
);
1152 case DPIF_OP_EXECUTE
:
1153 op
->error
= dpif_execute__(dpif
, &op
->u
.execute
);
1163 /* Returns a string that represents 'type', for use in log messages. */
1165 dpif_upcall_type_to_string(enum dpif_upcall_type type
)
1168 case DPIF_UC_MISS
: return "miss";
1169 case DPIF_UC_ACTION
: return "action";
1170 case DPIF_N_UC_TYPES
: default: return "<unknown>";
1174 /* Enables or disables receiving packets with dpif_recv() on 'dpif'. Returns 0
1175 * if successful, otherwise a positive errno value.
1177 * Turning packet receive off and then back on may change the Netlink PID
1178 * assignments returned by dpif_port_get_pid(). If the client does this, it
1179 * must update all of the flows that have OVS_ACTION_ATTR_USERSPACE actions
1180 * using the new PID assignment. */
1182 dpif_recv_set(struct dpif
*dpif
, bool enable
)
1184 int error
= dpif
->dpif_class
->recv_set(dpif
, enable
);
1185 log_operation(dpif
, "recv_set", error
);
1189 /* Polls for an upcall from 'dpif'. If successful, stores the upcall into
1190 * '*upcall', using 'buf' for storage. Should only be called if
1191 * dpif_recv_set() has been used to enable receiving packets on 'dpif'.
1193 * 'upcall->packet' and 'upcall->key' point into data in the caller-provided
1194 * 'buf', so their memory cannot be freed separately from 'buf'. (This is
1195 * hardly a great way to do things but it works out OK for the dpif providers
1196 * and clients that exist so far.)
1198 * Returns 0 if successful, otherwise a positive errno value. Returns EAGAIN
1199 * if no upcall is immediately available. */
1201 dpif_recv(struct dpif
*dpif
, struct dpif_upcall
*upcall
, struct ofpbuf
*buf
)
1203 int error
= dpif
->dpif_class
->recv(dpif
, upcall
, buf
);
1204 if (!error
&& !VLOG_DROP_DBG(&dpmsg_rl
)) {
1208 packet
= ofp_packet_to_string(upcall
->packet
->data
,
1209 upcall
->packet
->size
);
1212 odp_flow_key_format(upcall
->key
, upcall
->key_len
, &flow
);
1214 VLOG_DBG("%s: %s upcall:\n%s\n%s",
1215 dpif_name(dpif
), dpif_upcall_type_to_string(upcall
->type
),
1216 ds_cstr(&flow
), packet
);
1220 } else if (error
&& error
!= EAGAIN
) {
1221 log_operation(dpif
, "recv", error
);
1226 /* Discards all messages that would otherwise be received by dpif_recv() on
1229 dpif_recv_purge(struct dpif
*dpif
)
1231 COVERAGE_INC(dpif_purge
);
1232 if (dpif
->dpif_class
->recv_purge
) {
1233 dpif
->dpif_class
->recv_purge(dpif
);
1237 /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be
1238 * received with dpif_recv(). */
1240 dpif_recv_wait(struct dpif
*dpif
)
1242 dpif
->dpif_class
->recv_wait(dpif
);
1245 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1246 * and '*engine_id', respectively. */
1248 dpif_get_netflow_ids(const struct dpif
*dpif
,
1249 uint8_t *engine_type
, uint8_t *engine_id
)
1251 *engine_type
= dpif
->netflow_engine_type
;
1252 *engine_id
= dpif
->netflow_engine_id
;
1255 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1256 * value used for setting packet priority.
1257 * On success, returns 0 and stores the priority into '*priority'.
1258 * On failure, returns a positive errno value and stores 0 into '*priority'. */
1260 dpif_queue_to_priority(const struct dpif
*dpif
, uint32_t queue_id
,
1263 int error
= (dpif
->dpif_class
->queue_to_priority
1264 ? dpif
->dpif_class
->queue_to_priority(dpif
, queue_id
,
1270 log_operation(dpif
, "queue_to_priority", error
);
1275 dpif_init(struct dpif
*dpif
, const struct dpif_class
*dpif_class
,
1277 uint8_t netflow_engine_type
, uint8_t netflow_engine_id
)
1279 dpif
->dpif_class
= dpif_class
;
1280 dpif
->base_name
= xstrdup(name
);
1281 dpif
->full_name
= xasprintf("%s@%s", dpif_class
->type
, name
);
1282 dpif
->netflow_engine_type
= netflow_engine_type
;
1283 dpif
->netflow_engine_id
= netflow_engine_id
;
1286 /* Undoes the results of initialization.
1288 * Normally this function only needs to be called from dpif_close().
1289 * However, it may be called by providers due to an error on opening
1290 * that occurs after initialization. It this case dpif_close() would
1291 * never be called. */
1293 dpif_uninit(struct dpif
*dpif
, bool close
)
1295 char *base_name
= dpif
->base_name
;
1296 char *full_name
= dpif
->full_name
;
1299 dpif
->dpif_class
->close(dpif
);
1307 log_operation(const struct dpif
*dpif
, const char *operation
, int error
)
1310 VLOG_DBG_RL(&dpmsg_rl
, "%s: %s success", dpif_name(dpif
), operation
);
1311 } else if (ofperr_is_valid(error
)) {
1312 VLOG_WARN_RL(&error_rl
, "%s: %s failed (%s)",
1313 dpif_name(dpif
), operation
, ofperr_get_name(error
));
1315 VLOG_WARN_RL(&error_rl
, "%s: %s failed (%s)",
1316 dpif_name(dpif
), operation
, ovs_strerror(error
));
1320 static enum vlog_level
1321 flow_message_log_level(int error
)
1323 /* If flows arrive in a batch, userspace may push down multiple
1324 * unique flow definitions that overlap when wildcards are applied.
1325 * Kernels that support flow wildcarding will reject these flows as
1326 * duplicates (EEXIST), so lower the log level to debug for these
1327 * types of messages. */
1328 return (error
&& error
!= EEXIST
) ? VLL_WARN
: VLL_DBG
;
1332 should_log_flow_message(int error
)
1334 return !vlog_should_drop(THIS_MODULE
, flow_message_log_level(error
),
1335 error
? &error_rl
: &dpmsg_rl
);
1339 log_flow_message(const struct dpif
*dpif
, int error
, const char *operation
,
1340 const struct nlattr
*key
, size_t key_len
,
1341 const struct nlattr
*mask
, size_t mask_len
,
1342 const struct dpif_flow_stats
*stats
,
1343 const struct nlattr
*actions
, size_t actions_len
)
1345 struct ds ds
= DS_EMPTY_INITIALIZER
;
1346 ds_put_format(&ds
, "%s: ", dpif_name(dpif
));
1348 ds_put_cstr(&ds
, "failed to ");
1350 ds_put_format(&ds
, "%s ", operation
);
1352 ds_put_format(&ds
, "(%s) ", ovs_strerror(error
));
1354 odp_flow_format(key
, key_len
, mask
, mask_len
, &ds
, true);
1356 ds_put_cstr(&ds
, ", ");
1357 dpif_flow_stats_format(stats
, &ds
);
1359 if (actions
|| actions_len
) {
1360 ds_put_cstr(&ds
, ", actions:");
1361 format_odp_actions(&ds
, actions
, actions_len
);
1363 vlog(THIS_MODULE
, flow_message_log_level(error
), "%s", ds_cstr(&ds
));
1368 log_flow_put_message(struct dpif
*dpif
, const struct dpif_flow_put
*put
,
1371 if (should_log_flow_message(error
)) {
1375 ds_put_cstr(&s
, "put");
1376 if (put
->flags
& DPIF_FP_CREATE
) {
1377 ds_put_cstr(&s
, "[create]");
1379 if (put
->flags
& DPIF_FP_MODIFY
) {
1380 ds_put_cstr(&s
, "[modify]");
1382 if (put
->flags
& DPIF_FP_ZERO_STATS
) {
1383 ds_put_cstr(&s
, "[zero]");
1385 log_flow_message(dpif
, error
, ds_cstr(&s
),
1386 put
->key
, put
->key_len
, put
->mask
, put
->mask_len
,
1387 put
->stats
, put
->actions
, put
->actions_len
);
1393 log_flow_del_message(struct dpif
*dpif
, const struct dpif_flow_del
*del
,
1396 if (should_log_flow_message(error
)) {
1397 log_flow_message(dpif
, error
, "flow_del", del
->key
, del
->key_len
,
1398 NULL
, 0, !error
? del
->stats
: NULL
, NULL
, 0);
1403 log_execute_message(struct dpif
*dpif
, const struct dpif_execute
*execute
,
1406 if (!(error
? VLOG_DROP_WARN(&error_rl
) : VLOG_DROP_DBG(&dpmsg_rl
))) {
1407 struct ds ds
= DS_EMPTY_INITIALIZER
;
1410 packet
= ofp_packet_to_string(execute
->packet
->data
,
1411 execute
->packet
->size
);
1412 ds_put_format(&ds
, "%s: execute ", dpif_name(dpif
));
1413 format_odp_actions(&ds
, execute
->actions
, execute
->actions_len
);
1415 ds_put_format(&ds
, " failed (%s)", ovs_strerror(error
));
1417 ds_put_format(&ds
, " on packet %s", packet
);
1418 vlog(THIS_MODULE
, error
? VLL_WARN
: VLL_DBG
, "%s", ds_cstr(&ds
));