2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 #include "dpif-provider.h"
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 /* Rate limit for individual messages going to or from the datapath, output at
74 * DBG level. This is very high because, if these are enabled, it is because
75 * we really need to see them. */
76 static struct vlog_rate_limit dpmsg_rl
= VLOG_RATE_LIMIT_INIT(600, 600);
78 /* Not really much point in logging many dpif errors. */
79 static struct vlog_rate_limit error_rl
= VLOG_RATE_LIMIT_INIT(60, 5);
81 static void log_flow_message(const struct dpif
*dpif
, int error
,
82 const char *operation
,
83 const struct nlattr
*key
, size_t key_len
,
84 const struct dpif_flow_stats
*stats
,
85 const struct nlattr
*actions
, size_t actions_len
);
86 static void log_operation(const struct dpif
*, const char *operation
,
88 static bool should_log_flow_message(int error
);
89 static void log_flow_put_message(struct dpif
*, const struct dpif_flow_put
*,
91 static void log_flow_del_message(struct dpif
*, const struct dpif_flow_del
*,
93 static void log_execute_message(struct dpif
*, const struct dpif_execute
*,
99 static int status
= -1;
105 for (i
= 0; i
< ARRAY_SIZE(base_dpif_classes
); i
++) {
106 dp_register_provider(base_dpif_classes
[i
]);
111 /* Registers a new datapath provider. After successful registration, new
112 * datapaths of that type can be opened using dpif_open(). */
114 dp_register_provider(const struct dpif_class
*new_class
)
116 struct registered_dpif_class
*registered_class
;
118 if (sset_contains(&dpif_blacklist
, new_class
->type
)) {
119 VLOG_DBG("attempted to register blacklisted provider: %s",
124 if (shash_find(&dpif_classes
, new_class
->type
)) {
125 VLOG_WARN("attempted to register duplicate datapath provider: %s",
130 registered_class
= xmalloc(sizeof *registered_class
);
131 registered_class
->dpif_class
= new_class
;
132 registered_class
->refcount
= 0;
134 shash_add(&dpif_classes
, new_class
->type
, registered_class
);
139 /* Unregisters a datapath provider. 'type' must have been previously
140 * registered and not currently be in use by any dpifs. After unregistration
141 * new datapaths of that type cannot be opened using dpif_open(). */
143 dp_unregister_provider(const char *type
)
145 struct shash_node
*node
;
146 struct registered_dpif_class
*registered_class
;
148 node
= shash_find(&dpif_classes
, type
);
150 VLOG_WARN("attempted to unregister a datapath provider that is not "
151 "registered: %s", type
);
155 registered_class
= node
->data
;
156 if (registered_class
->refcount
) {
157 VLOG_WARN("attempted to unregister in use datapath provider: %s", type
);
161 shash_delete(&dpif_classes
, node
);
162 free(registered_class
);
167 /* Blacklists a provider. Causes future calls of dp_register_provider() with
168 * a dpif_class which implements 'type' to fail. */
170 dp_blacklist_provider(const char *type
)
172 sset_add(&dpif_blacklist
, type
);
175 /* Clears 'types' and enumerates the types of all currently registered datapath
176 * providers into it. The caller must first initialize the sset. */
178 dp_enumerate_types(struct sset
*types
)
180 struct shash_node
*node
;
185 SHASH_FOR_EACH(node
, &dpif_classes
) {
186 const struct registered_dpif_class
*registered_class
= node
->data
;
187 sset_add(types
, registered_class
->dpif_class
->type
);
191 /* Clears 'names' and enumerates the names of all known created datapaths with
192 * the given 'type'. The caller must first initialize the sset. Returns 0 if
193 * successful, otherwise a positive errno value.
195 * Some kinds of datapaths might not be practically enumerable. This is not
196 * considered an error. */
198 dp_enumerate_names(const char *type
, struct sset
*names
)
200 const struct registered_dpif_class
*registered_class
;
201 const struct dpif_class
*dpif_class
;
207 registered_class
= shash_find_data(&dpif_classes
, type
);
208 if (!registered_class
) {
209 VLOG_WARN("could not enumerate unknown type: %s", type
);
213 dpif_class
= registered_class
->dpif_class
;
214 error
= dpif_class
->enumerate
? dpif_class
->enumerate(names
) : 0;
217 VLOG_WARN("failed to enumerate %s datapaths: %s", dpif_class
->type
,
224 /* Parses 'datapath_name_', which is of the form [type@]name into its
225 * component pieces. 'name' and 'type' must be freed by the caller.
227 * The returned 'type' is normalized, as if by dpif_normalize_type(). */
229 dp_parse_name(const char *datapath_name_
, char **name
, char **type
)
231 char *datapath_name
= xstrdup(datapath_name_
);
234 separator
= strchr(datapath_name
, '@');
237 *type
= datapath_name
;
238 *name
= xstrdup(dpif_normalize_type(separator
+ 1));
240 *name
= datapath_name
;
241 *type
= xstrdup(dpif_normalize_type(NULL
));
246 do_open(const char *name
, const char *type
, bool create
, struct dpif
**dpifp
)
248 struct dpif
*dpif
= NULL
;
250 struct registered_dpif_class
*registered_class
;
254 type
= dpif_normalize_type(type
);
256 registered_class
= shash_find_data(&dpif_classes
, type
);
257 if (!registered_class
) {
258 VLOG_WARN("could not create datapath %s of unknown type %s", name
,
260 error
= EAFNOSUPPORT
;
264 error
= registered_class
->dpif_class
->open(registered_class
->dpif_class
,
265 name
, create
, &dpif
);
267 ovs_assert(dpif
->dpif_class
== registered_class
->dpif_class
);
268 registered_class
->refcount
++;
272 *dpifp
= error
? NULL
: dpif
;
276 /* Tries to open an existing datapath named 'name' and type 'type'. Will fail
277 * if no datapath with 'name' and 'type' exists. 'type' may be either NULL or
278 * the empty string to specify the default system type. Returns 0 if
279 * successful, otherwise a positive errno value. On success stores a pointer
280 * to the datapath in '*dpifp', otherwise a null pointer. */
282 dpif_open(const char *name
, const char *type
, struct dpif
**dpifp
)
284 return do_open(name
, type
, false, dpifp
);
287 /* Tries to create and open a new datapath with the given 'name' and 'type'.
288 * 'type' may be either NULL or the empty string to specify the default system
289 * type. Will fail if a datapath with 'name' and 'type' already exists.
290 * Returns 0 if successful, otherwise a positive errno value. On success
291 * stores a pointer to the datapath in '*dpifp', otherwise a null pointer. */
293 dpif_create(const char *name
, const char *type
, struct dpif
**dpifp
)
295 return do_open(name
, type
, true, dpifp
);
298 /* Tries to open a datapath with the given 'name' and 'type', creating it if it
299 * does not exist. 'type' may be either NULL or the empty string to specify
300 * the default system type. Returns 0 if successful, otherwise a positive
301 * errno value. On success stores a pointer to the datapath in '*dpifp',
302 * otherwise a null pointer. */
304 dpif_create_and_open(const char *name
, const char *type
, struct dpif
**dpifp
)
308 error
= dpif_create(name
, type
, dpifp
);
309 if (error
== EEXIST
|| error
== EBUSY
) {
310 error
= dpif_open(name
, type
, dpifp
);
312 VLOG_WARN("datapath %s already exists but cannot be opened: %s",
313 name
, strerror(error
));
316 VLOG_WARN("failed to create datapath %s: %s", name
, strerror(error
));
321 /* Closes and frees the connection to 'dpif'. Does not destroy the datapath
322 * itself; call dpif_delete() first, instead, if that is desirable. */
324 dpif_close(struct dpif
*dpif
)
327 struct registered_dpif_class
*registered_class
;
329 registered_class
= shash_find_data(&dpif_classes
,
330 dpif
->dpif_class
->type
);
331 ovs_assert(registered_class
);
332 ovs_assert(registered_class
->refcount
);
334 registered_class
->refcount
--;
335 dpif_uninit(dpif
, true);
339 /* Performs periodic work needed by 'dpif'. */
341 dpif_run(struct dpif
*dpif
)
343 if (dpif
->dpif_class
->run
) {
344 dpif
->dpif_class
->run(dpif
);
348 /* Arranges for poll_block() to wake up when dp_run() needs to be called for
351 dpif_wait(struct dpif
*dpif
)
353 if (dpif
->dpif_class
->wait
) {
354 dpif
->dpif_class
->wait(dpif
);
358 /* Returns the name of datapath 'dpif' prefixed with the type
359 * (for use in log messages). */
361 dpif_name(const struct dpif
*dpif
)
363 return dpif
->full_name
;
366 /* Returns the name of datapath 'dpif' without the type
367 * (for use in device names). */
369 dpif_base_name(const struct dpif
*dpif
)
371 return dpif
->base_name
;
374 /* Returns the type of datapath 'dpif'. */
376 dpif_type(const struct dpif
*dpif
)
378 return dpif
->dpif_class
->type
;
381 /* Returns the fully spelled out name for the given datapath 'type'.
383 * Normalized type string can be compared with strcmp(). Unnormalized type
384 * string might be the same even if they have different spellings. */
386 dpif_normalize_type(const char *type
)
388 return type
&& type
[0] ? type
: "system";
391 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
392 * ports. After calling this function, it does not make sense to pass 'dpif'
393 * to any functions other than dpif_name() or dpif_close(). */
395 dpif_delete(struct dpif
*dpif
)
399 COVERAGE_INC(dpif_destroy
);
401 error
= dpif
->dpif_class
->destroy(dpif
);
402 log_operation(dpif
, "delete", error
);
406 /* Retrieves statistics for 'dpif' into 'stats'. Returns 0 if successful,
407 * otherwise a positive errno value. */
409 dpif_get_dp_stats(const struct dpif
*dpif
, struct dpif_dp_stats
*stats
)
411 int error
= dpif
->dpif_class
->get_stats(dpif
, stats
);
413 memset(stats
, 0, sizeof *stats
);
415 log_operation(dpif
, "get_stats", error
);
420 dpif_port_open_type(const char *datapath_type
, const char *port_type
)
422 struct registered_dpif_class
*registered_class
;
424 datapath_type
= dpif_normalize_type(datapath_type
);
426 registered_class
= shash_find_data(&dpif_classes
, datapath_type
);
427 if (!registered_class
428 || !registered_class
->dpif_class
->port_open_type
) {
432 return registered_class
->dpif_class
->port_open_type(
433 registered_class
->dpif_class
, port_type
);
436 /* Attempts to add 'netdev' as a port on 'dpif'. If 'port_nop' is
437 * non-null and its value is not UINT32_MAX, then attempts to use the
438 * value as the port number.
440 * If successful, returns 0 and sets '*port_nop' to the new port's port
441 * number (if 'port_nop' is non-null). On failure, returns a positive
442 * errno value and sets '*port_nop' to UINT32_MAX (if 'port_nop' is
445 dpif_port_add(struct dpif
*dpif
, struct netdev
*netdev
, uint32_t *port_nop
)
447 const char *netdev_name
= netdev_get_name(netdev
);
448 uint32_t port_no
= UINT32_MAX
;
451 COVERAGE_INC(dpif_port_add
);
457 error
= dpif
->dpif_class
->port_add(dpif
, netdev
, &port_no
);
459 VLOG_DBG_RL(&dpmsg_rl
, "%s: added %s as port %"PRIu32
,
460 dpif_name(dpif
), netdev_name
, port_no
);
462 VLOG_WARN_RL(&error_rl
, "%s: failed to add %s as port: %s",
463 dpif_name(dpif
), netdev_name
, strerror(error
));
464 port_no
= UINT32_MAX
;
472 /* Attempts to remove 'dpif''s port number 'port_no'. Returns 0 if successful,
473 * otherwise a positive errno value. */
475 dpif_port_del(struct dpif
*dpif
, uint32_t port_no
)
479 COVERAGE_INC(dpif_port_del
);
481 error
= dpif
->dpif_class
->port_del(dpif
, port_no
);
483 VLOG_DBG_RL(&dpmsg_rl
, "%s: port_del(%"PRIu32
")",
484 dpif_name(dpif
), port_no
);
486 log_operation(dpif
, "port_del", error
);
491 /* Makes a deep copy of 'src' into 'dst'. */
493 dpif_port_clone(struct dpif_port
*dst
, const struct dpif_port
*src
)
495 dst
->name
= xstrdup(src
->name
);
496 dst
->type
= xstrdup(src
->type
);
497 dst
->port_no
= src
->port_no
;
500 /* Frees memory allocated to members of 'dpif_port'.
502 * Do not call this function on a dpif_port obtained from
503 * dpif_port_dump_next(): that function retains ownership of the data in the
506 dpif_port_destroy(struct dpif_port
*dpif_port
)
508 free(dpif_port
->name
);
509 free(dpif_port
->type
);
512 /* Checks if port named 'devname' exists in 'dpif'. If so, returns
513 * true; otherwise, returns false. */
515 dpif_port_exists(const struct dpif
*dpif
, const char *devname
)
517 int error
= dpif
->dpif_class
->port_query_by_name(dpif
, devname
, NULL
);
518 if (error
!= 0 && error
!= ENOENT
&& error
!= ENODEV
) {
519 VLOG_WARN_RL(&error_rl
, "%s: failed to query port %s: %s",
520 dpif_name(dpif
), devname
, strerror(error
));
526 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and
527 * initializes '*port' appropriately; on failure, returns a positive errno
530 * The caller owns the data in 'port' and must free it with
531 * dpif_port_destroy() when it is no longer needed. */
533 dpif_port_query_by_number(const struct dpif
*dpif
, uint32_t port_no
,
534 struct dpif_port
*port
)
536 int error
= dpif
->dpif_class
->port_query_by_number(dpif
, port_no
, port
);
538 VLOG_DBG_RL(&dpmsg_rl
, "%s: port %"PRIu32
" is device %s",
539 dpif_name(dpif
), port_no
, port
->name
);
541 memset(port
, 0, sizeof *port
);
542 VLOG_WARN_RL(&error_rl
, "%s: failed to query port %"PRIu32
": %s",
543 dpif_name(dpif
), port_no
, strerror(error
));
548 /* Looks up port named 'devname' in 'dpif'. On success, returns 0 and
549 * initializes '*port' appropriately; on failure, returns a positive errno
552 * The caller owns the data in 'port' and must free it with
553 * dpif_port_destroy() when it is no longer needed. */
555 dpif_port_query_by_name(const struct dpif
*dpif
, const char *devname
,
556 struct dpif_port
*port
)
558 int error
= dpif
->dpif_class
->port_query_by_name(dpif
, devname
, port
);
560 VLOG_DBG_RL(&dpmsg_rl
, "%s: device %s is on port %"PRIu32
,
561 dpif_name(dpif
), devname
, port
->port_no
);
563 memset(port
, 0, sizeof *port
);
565 /* For ENOENT or ENODEV we use DBG level because the caller is probably
566 * interested in whether 'dpif' actually has a port 'devname', so that
567 * it's not an issue worth logging if it doesn't. Other errors are
568 * uncommon and more likely to indicate a real problem. */
570 error
== ENOENT
|| error
== ENODEV
? VLL_DBG
: VLL_WARN
,
571 "%s: failed to query port %s: %s",
572 dpif_name(dpif
), devname
, strerror(error
));
577 /* Returns one greater than the maximum port number accepted in flow
580 dpif_get_max_ports(const struct dpif
*dpif
)
582 return dpif
->dpif_class
->get_max_ports(dpif
);
585 /* Returns the Netlink PID value to supply in OVS_ACTION_ATTR_USERSPACE actions
586 * as the OVS_USERSPACE_ATTR_PID attribute's value, for use in flows whose
587 * packets arrived on port 'port_no'.
589 * A 'port_no' of UINT32_MAX is a special case: it returns a reserved PID, not
590 * allocated to any port, that the client may use for special purposes.
592 * The return value is only meaningful when DPIF_UC_ACTION has been enabled in
593 * the 'dpif''s listen mask. It is allowed to change when DPIF_UC_ACTION is
594 * disabled and then re-enabled, so a client that does that must be prepared to
595 * update all of the flows that it installed that contain
596 * OVS_ACTION_ATTR_USERSPACE actions. */
598 dpif_port_get_pid(const struct dpif
*dpif
, uint32_t port_no
)
600 return (dpif
->dpif_class
->port_get_pid
601 ? (dpif
->dpif_class
->port_get_pid
)(dpif
, port_no
)
605 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and copies
606 * the port's name into the 'name_size' bytes in 'name', ensuring that the
607 * result is null-terminated. On failure, returns a positive errno value and
608 * makes 'name' the empty string. */
610 dpif_port_get_name(struct dpif
*dpif
, uint32_t port_no
,
611 char *name
, size_t name_size
)
613 struct dpif_port port
;
616 ovs_assert(name_size
> 0);
618 error
= dpif_port_query_by_number(dpif
, port_no
, &port
);
620 ovs_strlcpy(name
, port
.name
, name_size
);
621 dpif_port_destroy(&port
);
628 /* Initializes 'dump' to begin dumping the ports in a dpif.
630 * This function provides no status indication. An error status for the entire
631 * dump operation is provided when it is completed by calling
632 * dpif_port_dump_done().
635 dpif_port_dump_start(struct dpif_port_dump
*dump
, const struct dpif
*dpif
)
638 dump
->error
= dpif
->dpif_class
->port_dump_start(dpif
, &dump
->state
);
639 log_operation(dpif
, "port_dump_start", dump
->error
);
642 /* Attempts to retrieve another port from 'dump', which must have been
643 * initialized with dpif_port_dump_start(). On success, stores a new dpif_port
644 * into 'port' and returns true. On failure, returns false.
646 * Failure might indicate an actual error or merely that the last port has been
647 * dumped. An error status for the entire dump operation is provided when it
648 * is completed by calling dpif_port_dump_done().
650 * The dpif owns the data stored in 'port'. It will remain valid until at
651 * least the next time 'dump' is passed to dpif_port_dump_next() or
652 * dpif_port_dump_done(). */
654 dpif_port_dump_next(struct dpif_port_dump
*dump
, struct dpif_port
*port
)
656 const struct dpif
*dpif
= dump
->dpif
;
662 dump
->error
= dpif
->dpif_class
->port_dump_next(dpif
, dump
->state
, port
);
663 if (dump
->error
== EOF
) {
664 VLOG_DBG_RL(&dpmsg_rl
, "%s: dumped all ports", dpif_name(dpif
));
666 log_operation(dpif
, "port_dump_next", dump
->error
);
670 dpif
->dpif_class
->port_dump_done(dpif
, dump
->state
);
676 /* Completes port table dump operation 'dump', which must have been initialized
677 * with dpif_port_dump_start(). Returns 0 if the dump operation was
678 * error-free, otherwise a positive errno value describing the problem. */
680 dpif_port_dump_done(struct dpif_port_dump
*dump
)
682 const struct dpif
*dpif
= dump
->dpif
;
684 dump
->error
= dpif
->dpif_class
->port_dump_done(dpif
, dump
->state
);
685 log_operation(dpif
, "port_dump_done", dump
->error
);
687 return dump
->error
== EOF
? 0 : dump
->error
;
690 /* Polls for changes in the set of ports in 'dpif'. If the set of ports in
691 * 'dpif' has changed, this function does one of the following:
693 * - Stores the name of the device that was added to or deleted from 'dpif' in
694 * '*devnamep' and returns 0. The caller is responsible for freeing
695 * '*devnamep' (with free()) when it no longer needs it.
697 * - Returns ENOBUFS and sets '*devnamep' to NULL.
699 * This function may also return 'false positives', where it returns 0 and
700 * '*devnamep' names a device that was not actually added or deleted or it
701 * returns ENOBUFS without any change.
703 * Returns EAGAIN if the set of ports in 'dpif' has not changed. May also
704 * return other positive errno values to indicate that something has gone
707 dpif_port_poll(const struct dpif
*dpif
, char **devnamep
)
709 int error
= dpif
->dpif_class
->port_poll(dpif
, devnamep
);
716 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
717 * value other than EAGAIN. */
719 dpif_port_poll_wait(const struct dpif
*dpif
)
721 dpif
->dpif_class
->port_poll_wait(dpif
);
724 /* Extracts the flow stats for a packet. The 'flow' and 'packet'
725 * arguments must have been initialized through a call to flow_extract().
726 * 'used' is stored into stats->used. */
728 dpif_flow_stats_extract(const struct flow
*flow
, const struct ofpbuf
*packet
,
729 long long int used
, struct dpif_flow_stats
*stats
)
731 stats
->tcp_flags
= packet_get_tcp_flags(packet
, flow
);
732 stats
->n_bytes
= packet
->size
;
733 stats
->n_packets
= 1;
737 /* Appends a human-readable representation of 'stats' to 's'. */
739 dpif_flow_stats_format(const struct dpif_flow_stats
*stats
, struct ds
*s
)
741 ds_put_format(s
, "packets:%"PRIu64
", bytes:%"PRIu64
", used:",
742 stats
->n_packets
, stats
->n_bytes
);
744 ds_put_format(s
, "%.3fs", (time_msec() - stats
->used
) / 1000.0);
746 ds_put_format(s
, "never");
748 if (stats
->tcp_flags
) {
749 ds_put_cstr(s
, ", flags:");
750 packet_format_tcp_flags(s
, stats
->tcp_flags
);
754 /* Deletes all flows from 'dpif'. Returns 0 if successful, otherwise a
755 * positive errno value. */
757 dpif_flow_flush(struct dpif
*dpif
)
761 COVERAGE_INC(dpif_flow_flush
);
763 error
= dpif
->dpif_class
->flow_flush(dpif
);
764 log_operation(dpif
, "flow_flush", error
);
768 /* Queries 'dpif' for a flow entry. The flow is specified by the Netlink
769 * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
772 * Returns 0 if successful. If no flow matches, returns ENOENT. On other
773 * failure, returns a positive errno value.
775 * If 'actionsp' is nonnull, then on success '*actionsp' will be set to an
776 * ofpbuf owned by the caller that contains the Netlink attributes for the
777 * flow's actions. The caller must free the ofpbuf (with ofpbuf_delete()) when
778 * it is no longer needed.
780 * If 'stats' is nonnull, then on success it will be updated with the flow's
783 dpif_flow_get(const struct dpif
*dpif
,
784 const struct nlattr
*key
, size_t key_len
,
785 struct ofpbuf
**actionsp
, struct dpif_flow_stats
*stats
)
789 COVERAGE_INC(dpif_flow_get
);
791 error
= dpif
->dpif_class
->flow_get(dpif
, key
, key_len
, actionsp
, stats
);
797 memset(stats
, 0, sizeof *stats
);
800 if (should_log_flow_message(error
)) {
801 const struct nlattr
*actions
;
804 if (!error
&& actionsp
) {
805 actions
= (*actionsp
)->data
;
806 actions_len
= (*actionsp
)->size
;
811 log_flow_message(dpif
, error
, "flow_get", key
, key_len
, stats
,
812 actions
, actions_len
);
818 dpif_flow_put__(struct dpif
*dpif
, const struct dpif_flow_put
*put
)
822 COVERAGE_INC(dpif_flow_put
);
823 ovs_assert(!(put
->flags
& ~(DPIF_FP_CREATE
| DPIF_FP_MODIFY
824 | DPIF_FP_ZERO_STATS
)));
826 error
= dpif
->dpif_class
->flow_put(dpif
, put
);
827 if (error
&& put
->stats
) {
828 memset(put
->stats
, 0, sizeof *put
->stats
);
830 log_flow_put_message(dpif
, put
, error
);
834 /* Adds or modifies a flow in 'dpif'. The flow is specified by the Netlink
835 * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
836 * 'key'. The associated actions are specified by the Netlink attributes with
837 * types OVS_ACTION_ATTR_* in the 'actions_len' bytes starting at 'actions'.
839 * - If the flow's key does not exist in 'dpif', then the flow will be added if
840 * 'flags' includes DPIF_FP_CREATE. Otherwise the operation will fail with
843 * If the operation succeeds, then 'stats', if nonnull, will be zeroed.
845 * - If the flow's key does exist in 'dpif', then the flow's actions will be
846 * updated if 'flags' includes DPIF_FP_MODIFY. Otherwise the operation will
847 * fail with EEXIST. If the flow's actions are updated, then its statistics
848 * will be zeroed if 'flags' includes DPIF_FP_ZERO_STATS, and left as-is
851 * If the operation succeeds, then 'stats', if nonnull, will be set to the
852 * flow's statistics before the update.
855 dpif_flow_put(struct dpif
*dpif
, enum dpif_flow_put_flags flags
,
856 const struct nlattr
*key
, size_t key_len
,
857 const struct nlattr
*actions
, size_t actions_len
,
858 struct dpif_flow_stats
*stats
)
860 struct dpif_flow_put put
;
864 put
.key_len
= key_len
;
865 put
.actions
= actions
;
866 put
.actions_len
= actions_len
;
868 return dpif_flow_put__(dpif
, &put
);
872 dpif_flow_del__(struct dpif
*dpif
, struct dpif_flow_del
*del
)
876 COVERAGE_INC(dpif_flow_del
);
878 error
= dpif
->dpif_class
->flow_del(dpif
, del
);
879 if (error
&& del
->stats
) {
880 memset(del
->stats
, 0, sizeof *del
->stats
);
882 log_flow_del_message(dpif
, del
, error
);
886 /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif' does
887 * not contain such a flow. The flow is specified by the Netlink attributes
888 * with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at 'key'.
890 * If the operation succeeds, then 'stats', if nonnull, will be set to the
891 * flow's statistics before its deletion. */
893 dpif_flow_del(struct dpif
*dpif
,
894 const struct nlattr
*key
, size_t key_len
,
895 struct dpif_flow_stats
*stats
)
897 struct dpif_flow_del del
;
900 del
.key_len
= key_len
;
902 return dpif_flow_del__(dpif
, &del
);
905 /* Initializes 'dump' to begin dumping the flows in a dpif.
907 * This function provides no status indication. An error status for the entire
908 * dump operation is provided when it is completed by calling
909 * dpif_flow_dump_done().
912 dpif_flow_dump_start(struct dpif_flow_dump
*dump
, const struct dpif
*dpif
)
915 dump
->error
= dpif
->dpif_class
->flow_dump_start(dpif
, &dump
->state
);
916 log_operation(dpif
, "flow_dump_start", dump
->error
);
919 /* Attempts to retrieve another flow from 'dump', which must have been
920 * initialized with dpif_flow_dump_start(). On success, updates the output
921 * parameters as described below and returns true. Otherwise, returns false.
922 * Failure might indicate an actual error or merely the end of the flow table.
923 * An error status for the entire dump operation is provided when it is
924 * completed by calling dpif_flow_dump_done().
926 * On success, if 'key' and 'key_len' are nonnull then '*key' and '*key_len'
927 * will be set to Netlink attributes with types OVS_KEY_ATTR_* representing the
928 * dumped flow's key. If 'actions' and 'actions_len' are nonnull then they are
929 * set to Netlink attributes with types OVS_ACTION_ATTR_* representing the
930 * dumped flow's actions. If 'stats' is nonnull then it will be set to the
931 * dumped flow's statistics.
933 * All of the returned data is owned by 'dpif', not by the caller, and the
934 * caller must not modify or free it. 'dpif' guarantees that it remains
935 * accessible and unchanging until at least the next call to 'flow_dump_next'
936 * or 'flow_dump_done' for 'dump'. */
938 dpif_flow_dump_next(struct dpif_flow_dump
*dump
,
939 const struct nlattr
**key
, size_t *key_len
,
940 const struct nlattr
**actions
, size_t *actions_len
,
941 const struct dpif_flow_stats
**stats
)
943 const struct dpif
*dpif
= dump
->dpif
;
944 int error
= dump
->error
;
947 error
= dpif
->dpif_class
->flow_dump_next(dpif
, dump
->state
,
949 actions
, actions_len
,
952 dpif
->dpif_class
->flow_dump_done(dpif
, dump
->state
);
970 VLOG_DBG_RL(&dpmsg_rl
, "%s: dumped all flows", dpif_name(dpif
));
971 } else if (should_log_flow_message(error
)) {
972 log_flow_message(dpif
, error
, "flow_dump",
973 key
? *key
: NULL
, key
? *key_len
: 0,
974 stats
? *stats
: NULL
, actions
? *actions
: NULL
,
975 actions
? *actions_len
: 0);
982 /* Completes flow table dump operation 'dump', which must have been initialized
983 * with dpif_flow_dump_start(). Returns 0 if the dump operation was
984 * error-free, otherwise a positive errno value describing the problem. */
986 dpif_flow_dump_done(struct dpif_flow_dump
*dump
)
988 const struct dpif
*dpif
= dump
->dpif
;
990 dump
->error
= dpif
->dpif_class
->flow_dump_done(dpif
, dump
->state
);
991 log_operation(dpif
, "flow_dump_done", dump
->error
);
993 return dump
->error
== EOF
? 0 : dump
->error
;
997 dpif_execute__(struct dpif
*dpif
, const struct dpif_execute
*execute
)
1001 COVERAGE_INC(dpif_execute
);
1002 if (execute
->actions_len
> 0) {
1003 error
= dpif
->dpif_class
->execute(dpif
, execute
);
1008 log_execute_message(dpif
, execute
, error
);
1013 /* Causes 'dpif' to perform the 'actions_len' bytes of actions in 'actions' on
1014 * the Ethernet frame specified in 'packet' taken from the flow specified in
1015 * the 'key_len' bytes of 'key'. ('key' is mostly redundant with 'packet', but
1016 * it contains some metadata that cannot be recovered from 'packet', such as
1017 * tunnel and in_port.)
1019 * Returns 0 if successful, otherwise a positive errno value. */
1021 dpif_execute(struct dpif
*dpif
,
1022 const struct nlattr
*key
, size_t key_len
,
1023 const struct nlattr
*actions
, size_t actions_len
,
1024 const struct ofpbuf
*buf
)
1026 struct dpif_execute execute
;
1029 execute
.key_len
= key_len
;
1030 execute
.actions
= actions
;
1031 execute
.actions_len
= actions_len
;
1032 execute
.packet
= buf
;
1033 return dpif_execute__(dpif
, &execute
);
1036 /* Executes each of the 'n_ops' operations in 'ops' on 'dpif', in the order in
1037 * which they are specified, placing each operation's results in the "output"
1038 * members documented in comments.
1040 * This function exists because some datapaths can perform batched operations
1041 * faster than individual operations. */
1043 dpif_operate(struct dpif
*dpif
, struct dpif_op
**ops
, size_t n_ops
)
1047 if (dpif
->dpif_class
->operate
) {
1048 dpif
->dpif_class
->operate(dpif
, ops
, n_ops
);
1050 for (i
= 0; i
< n_ops
; i
++) {
1051 struct dpif_op
*op
= ops
[i
];
1054 case DPIF_OP_FLOW_PUT
:
1055 log_flow_put_message(dpif
, &op
->u
.flow_put
, op
->error
);
1058 case DPIF_OP_FLOW_DEL
:
1059 log_flow_del_message(dpif
, &op
->u
.flow_del
, op
->error
);
1062 case DPIF_OP_EXECUTE
:
1063 log_execute_message(dpif
, &op
->u
.execute
, op
->error
);
1070 for (i
= 0; i
< n_ops
; i
++) {
1071 struct dpif_op
*op
= ops
[i
];
1074 case DPIF_OP_FLOW_PUT
:
1075 op
->error
= dpif_flow_put__(dpif
, &op
->u
.flow_put
);
1078 case DPIF_OP_FLOW_DEL
:
1079 op
->error
= dpif_flow_del__(dpif
, &op
->u
.flow_del
);
1082 case DPIF_OP_EXECUTE
:
1083 op
->error
= dpif_execute__(dpif
, &op
->u
.execute
);
1093 /* Returns a string that represents 'type', for use in log messages. */
1095 dpif_upcall_type_to_string(enum dpif_upcall_type type
)
1098 case DPIF_UC_MISS
: return "miss";
1099 case DPIF_UC_ACTION
: return "action";
1100 case DPIF_N_UC_TYPES
: default: return "<unknown>";
1104 /* Enables or disables receiving packets with dpif_recv() on 'dpif'. Returns 0
1105 * if successful, otherwise a positive errno value.
1107 * Turning packet receive off and then back on may change the Netlink PID
1108 * assignments returned by dpif_port_get_pid(). If the client does this, it
1109 * must update all of the flows that have OVS_ACTION_ATTR_USERSPACE actions
1110 * using the new PID assignment. */
1112 dpif_recv_set(struct dpif
*dpif
, bool enable
)
1114 int error
= dpif
->dpif_class
->recv_set(dpif
, enable
);
1115 log_operation(dpif
, "recv_set", error
);
1119 /* Polls for an upcall from 'dpif'. If successful, stores the upcall into
1120 * '*upcall', using 'buf' for storage. Should only be called if
1121 * dpif_recv_set() has been used to enable receiving packets on 'dpif'.
1123 * 'upcall->packet' and 'upcall->key' point into data in the caller-provided
1124 * 'buf', so their memory cannot be freed separately from 'buf'. (This is
1125 * hardly a great way to do things but it works out OK for the dpif providers
1126 * and clients that exist so far.)
1128 * Returns 0 if successful, otherwise a positive errno value. Returns EAGAIN
1129 * if no upcall is immediately available. */
1131 dpif_recv(struct dpif
*dpif
, struct dpif_upcall
*upcall
, struct ofpbuf
*buf
)
1133 int error
= dpif
->dpif_class
->recv(dpif
, upcall
, buf
);
1134 if (!error
&& !VLOG_DROP_DBG(&dpmsg_rl
)) {
1138 packet
= ofp_packet_to_string(upcall
->packet
->data
,
1139 upcall
->packet
->size
);
1142 odp_flow_key_format(upcall
->key
, upcall
->key_len
, &flow
);
1144 VLOG_DBG("%s: %s upcall:\n%s\n%s",
1145 dpif_name(dpif
), dpif_upcall_type_to_string(upcall
->type
),
1146 ds_cstr(&flow
), packet
);
1150 } else if (error
&& error
!= EAGAIN
) {
1151 log_operation(dpif
, "recv", error
);
1156 /* Discards all messages that would otherwise be received by dpif_recv() on
1159 dpif_recv_purge(struct dpif
*dpif
)
1161 COVERAGE_INC(dpif_purge
);
1162 if (dpif
->dpif_class
->recv_purge
) {
1163 dpif
->dpif_class
->recv_purge(dpif
);
1167 /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be
1168 * received with dpif_recv(). */
1170 dpif_recv_wait(struct dpif
*dpif
)
1172 dpif
->dpif_class
->recv_wait(dpif
);
1175 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1176 * and '*engine_id', respectively. */
1178 dpif_get_netflow_ids(const struct dpif
*dpif
,
1179 uint8_t *engine_type
, uint8_t *engine_id
)
1181 *engine_type
= dpif
->netflow_engine_type
;
1182 *engine_id
= dpif
->netflow_engine_id
;
1185 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1186 * value used for setting packet priority.
1187 * On success, returns 0 and stores the priority into '*priority'.
1188 * On failure, returns a positive errno value and stores 0 into '*priority'. */
1190 dpif_queue_to_priority(const struct dpif
*dpif
, uint32_t queue_id
,
1193 int error
= (dpif
->dpif_class
->queue_to_priority
1194 ? dpif
->dpif_class
->queue_to_priority(dpif
, queue_id
,
1200 log_operation(dpif
, "queue_to_priority", error
);
1205 dpif_init(struct dpif
*dpif
, const struct dpif_class
*dpif_class
,
1207 uint8_t netflow_engine_type
, uint8_t netflow_engine_id
)
1209 dpif
->dpif_class
= dpif_class
;
1210 dpif
->base_name
= xstrdup(name
);
1211 dpif
->full_name
= xasprintf("%s@%s", dpif_class
->type
, name
);
1212 dpif
->netflow_engine_type
= netflow_engine_type
;
1213 dpif
->netflow_engine_id
= netflow_engine_id
;
1216 /* Undoes the results of initialization.
1218 * Normally this function only needs to be called from dpif_close().
1219 * However, it may be called by providers due to an error on opening
1220 * that occurs after initialization. It this case dpif_close() would
1221 * never be called. */
1223 dpif_uninit(struct dpif
*dpif
, bool close
)
1225 char *base_name
= dpif
->base_name
;
1226 char *full_name
= dpif
->full_name
;
1229 dpif
->dpif_class
->close(dpif
);
1237 log_operation(const struct dpif
*dpif
, const char *operation
, int error
)
1240 VLOG_DBG_RL(&dpmsg_rl
, "%s: %s success", dpif_name(dpif
), operation
);
1241 } else if (ofperr_is_valid(error
)) {
1242 VLOG_WARN_RL(&error_rl
, "%s: %s failed (%s)",
1243 dpif_name(dpif
), operation
, ofperr_get_name(error
));
1245 VLOG_WARN_RL(&error_rl
, "%s: %s failed (%s)",
1246 dpif_name(dpif
), operation
, strerror(error
));
1250 static enum vlog_level
1251 flow_message_log_level(int error
)
1253 return error
? VLL_WARN
: VLL_DBG
;
1257 should_log_flow_message(int error
)
1259 return !vlog_should_drop(THIS_MODULE
, flow_message_log_level(error
),
1260 error
? &error_rl
: &dpmsg_rl
);
1264 log_flow_message(const struct dpif
*dpif
, int error
, const char *operation
,
1265 const struct nlattr
*key
, size_t key_len
,
1266 const struct dpif_flow_stats
*stats
,
1267 const struct nlattr
*actions
, size_t actions_len
)
1269 struct ds ds
= DS_EMPTY_INITIALIZER
;
1270 ds_put_format(&ds
, "%s: ", dpif_name(dpif
));
1272 ds_put_cstr(&ds
, "failed to ");
1274 ds_put_format(&ds
, "%s ", operation
);
1276 ds_put_format(&ds
, "(%s) ", strerror(error
));
1278 odp_flow_key_format(key
, key_len
, &ds
);
1280 ds_put_cstr(&ds
, ", ");
1281 dpif_flow_stats_format(stats
, &ds
);
1283 if (actions
|| actions_len
) {
1284 ds_put_cstr(&ds
, ", actions:");
1285 format_odp_actions(&ds
, actions
, actions_len
);
1287 vlog(THIS_MODULE
, flow_message_log_level(error
), "%s", ds_cstr(&ds
));
1292 log_flow_put_message(struct dpif
*dpif
, const struct dpif_flow_put
*put
,
1295 if (should_log_flow_message(error
)) {
1299 ds_put_cstr(&s
, "put");
1300 if (put
->flags
& DPIF_FP_CREATE
) {
1301 ds_put_cstr(&s
, "[create]");
1303 if (put
->flags
& DPIF_FP_MODIFY
) {
1304 ds_put_cstr(&s
, "[modify]");
1306 if (put
->flags
& DPIF_FP_ZERO_STATS
) {
1307 ds_put_cstr(&s
, "[zero]");
1309 log_flow_message(dpif
, error
, ds_cstr(&s
),
1310 put
->key
, put
->key_len
, put
->stats
,
1311 put
->actions
, put
->actions_len
);
1317 log_flow_del_message(struct dpif
*dpif
, const struct dpif_flow_del
*del
,
1320 if (should_log_flow_message(error
)) {
1321 log_flow_message(dpif
, error
, "flow_del", del
->key
, del
->key_len
,
1322 !error
? del
->stats
: NULL
, NULL
, 0);
1327 log_execute_message(struct dpif
*dpif
, const struct dpif_execute
*execute
,
1330 if (!(error
? VLOG_DROP_WARN(&error_rl
) : VLOG_DROP_DBG(&dpmsg_rl
))) {
1331 struct ds ds
= DS_EMPTY_INITIALIZER
;
1334 packet
= ofp_packet_to_string(execute
->packet
->data
,
1335 execute
->packet
->size
);
1336 ds_put_format(&ds
, "%s: execute ", dpif_name(dpif
));
1337 format_odp_actions(&ds
, execute
->actions
, execute
->actions_len
);
1339 ds_put_format(&ds
, " failed (%s)", strerror(error
));
1341 ds_put_format(&ds
, " on packet %s", packet
);
1342 vlog(THIS_MODULE
, error
? VLL_WARN
: VLL_DBG
, "%s", ds_cstr(&ds
));