2 * Copyright (c) 2008, 2009, 2010 Nicira Networks.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 #include "dpif-provider.h"
28 #include "dynamic-string.h"
32 #include "ofp-print.h"
36 #include "poll-loop.h"
43 VLOG_DEFINE_THIS_MODULE(dpif);
45 static const struct dpif_class *base_dpif_classes[] = {
52 struct registered_dpif_class {
53 const struct dpif_class *dpif_class;
56 static struct shash dpif_classes = SHASH_INITIALIZER(&dpif_classes);
58 /* Rate limit for individual messages going to or from the datapath, output at
59 * DBG level. This is very high because, if these are enabled, it is because
60 * we really need to see them. */
61 static struct vlog_rate_limit dpmsg_rl = VLOG_RATE_LIMIT_INIT(600, 600);
63 /* Not really much point in logging many dpif errors. */
64 static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(60, 5);
66 static void log_operation(const struct dpif *, const char *operation,
68 static void log_flow_operation(const struct dpif *, const char *operation,
69 int error, struct odp_flow *flow);
70 static void log_flow_put(struct dpif *, int error,
71 const struct odp_flow_put *);
72 static bool should_log_flow_message(int error);
73 static void check_rw_odp_flow(struct odp_flow *);
78 static int status = -1;
84 for (i = 0; i < ARRAY_SIZE(base_dpif_classes); i++) {
85 dp_register_provider(base_dpif_classes[i]);
90 /* Performs periodic work needed by all the various kinds of dpifs.
92 * If your program opens any dpifs, it must call both this function and
93 * netdev_run() within its main poll loop. */
97 struct shash_node *node;
98 SHASH_FOR_EACH(node, &dpif_classes) {
99 const struct registered_dpif_class *registered_class = node->data;
100 if (registered_class->dpif_class->run) {
101 registered_class->dpif_class->run();
106 /* Arranges for poll_block() to wake up when dp_run() needs to be called.
108 * If your program opens any dpifs, it must call both this function and
109 * netdev_wait() within its main poll loop. */
113 struct shash_node *node;
114 SHASH_FOR_EACH(node, &dpif_classes) {
115 const struct registered_dpif_class *registered_class = node->data;
116 if (registered_class->dpif_class->wait) {
117 registered_class->dpif_class->wait();
122 /* Registers a new datapath provider. After successful registration, new
123 * datapaths of that type can be opened using dpif_open(). */
125 dp_register_provider(const struct dpif_class *new_class)
127 struct registered_dpif_class *registered_class;
129 if (shash_find(&dpif_classes, new_class->type)) {
130 VLOG_WARN("attempted to register duplicate datapath provider: %s",
135 registered_class = xmalloc(sizeof *registered_class);
136 registered_class->dpif_class = new_class;
137 registered_class->refcount = 0;
139 shash_add(&dpif_classes, new_class->type, registered_class);
144 /* Unregisters a datapath provider. 'type' must have been previously
145 * registered and not currently be in use by any dpifs. After unregistration
146 * new datapaths of that type cannot be opened using dpif_open(). */
148 dp_unregister_provider(const char *type)
150 struct shash_node *node;
151 struct registered_dpif_class *registered_class;
153 node = shash_find(&dpif_classes, type);
155 VLOG_WARN("attempted to unregister a datapath provider that is not "
156 "registered: %s", type);
160 registered_class = node->data;
161 if (registered_class->refcount) {
162 VLOG_WARN("attempted to unregister in use datapath provider: %s", type);
166 shash_delete(&dpif_classes, node);
167 free(registered_class);
172 /* Clears 'types' and enumerates the types of all currently registered datapath
173 * providers into it. The caller must first initialize the svec. */
175 dp_enumerate_types(struct svec *types)
177 struct shash_node *node;
182 SHASH_FOR_EACH(node, &dpif_classes) {
183 const struct registered_dpif_class *registered_class = node->data;
184 svec_add(types, registered_class->dpif_class->type);
188 /* Clears 'names' and enumerates the names of all known created datapaths with
189 * the given 'type'. The caller must first initialize the svec. Returns 0 if
190 * successful, otherwise a positive errno value.
192 * Some kinds of datapaths might not be practically enumerable. This is not
193 * considered an error. */
195 dp_enumerate_names(const char *type, struct svec *names)
197 const struct registered_dpif_class *registered_class;
198 const struct dpif_class *dpif_class;
204 registered_class = shash_find_data(&dpif_classes, type);
205 if (!registered_class) {
206 VLOG_WARN("could not enumerate unknown type: %s", type);
210 dpif_class = registered_class->dpif_class;
211 error = dpif_class->enumerate ? dpif_class->enumerate(names) : 0;
214 VLOG_WARN("failed to enumerate %s datapaths: %s", dpif_class->type,
221 /* Parses 'datapath name', which is of the form type@name into its
222 * component pieces. 'name' and 'type' must be freed by the caller. */
224 dp_parse_name(const char *datapath_name_, char **name, char **type)
226 char *datapath_name = xstrdup(datapath_name_);
229 separator = strchr(datapath_name, '@');
232 *type = datapath_name;
233 *name = xstrdup(separator + 1);
235 *name = datapath_name;
241 do_open(const char *name, const char *type, bool create, struct dpif **dpifp)
243 struct dpif *dpif = NULL;
245 struct registered_dpif_class *registered_class;
249 if (!type || *type == '\0') {
253 registered_class = shash_find_data(&dpif_classes, type);
254 if (!registered_class) {
255 VLOG_WARN("could not create datapath %s of unknown type %s", name,
257 error = EAFNOSUPPORT;
261 error = registered_class->dpif_class->open(registered_class->dpif_class,
262 name, create, &dpif);
264 assert(dpif->dpif_class == registered_class->dpif_class);
265 registered_class->refcount++;
269 *dpifp = error ? NULL : dpif;
273 /* Tries to open an existing datapath named 'name' and type 'type'. Will fail
274 * if no datapath with 'name' and 'type' exists. 'type' may be either NULL or
275 * the empty string to specify the default system type. Returns 0 if
276 * successful, otherwise a positive errno value. On success stores a pointer
277 * to the datapath in '*dpifp', otherwise a null pointer. */
279 dpif_open(const char *name, const char *type, struct dpif **dpifp)
281 return do_open(name, type, false, dpifp);
284 /* Tries to create and open a new datapath with the given 'name' and 'type'.
285 * 'type' may be either NULL or the empty string to specify the default system
286 * type. Will fail if a datapath with 'name' and 'type' already exists.
287 * Returns 0 if successful, otherwise a positive errno value. On success
288 * stores a pointer to the datapath in '*dpifp', otherwise a null pointer. */
290 dpif_create(const char *name, const char *type, struct dpif **dpifp)
292 return do_open(name, type, true, dpifp);
295 /* Tries to open a datapath with the given 'name' and 'type', creating it if it
296 * does not exist. 'type' may be either NULL or the empty string to specify
297 * the default system type. Returns 0 if successful, otherwise a positive
298 * errno value. On success stores a pointer to the datapath in '*dpifp',
299 * otherwise a null pointer. */
301 dpif_create_and_open(const char *name, const char *type, struct dpif **dpifp)
305 error = dpif_create(name, type, dpifp);
306 if (error == EEXIST || error == EBUSY) {
307 error = dpif_open(name, type, dpifp);
309 VLOG_WARN("datapath %s already exists but cannot be opened: %s",
310 name, strerror(error));
313 VLOG_WARN("failed to create datapath %s: %s", name, strerror(error));
318 /* Closes and frees the connection to 'dpif'. Does not destroy the datapath
319 * itself; call dpif_delete() first, instead, if that is desirable. */
321 dpif_close(struct dpif *dpif)
324 struct registered_dpif_class *registered_class;
326 registered_class = shash_find_data(&dpif_classes,
327 dpif->dpif_class->type);
328 assert(registered_class);
329 assert(registered_class->refcount);
331 registered_class->refcount--;
332 dpif_uninit(dpif, true);
336 /* Returns the name of datapath 'dpif' prefixed with the type
337 * (for use in log messages). */
339 dpif_name(const struct dpif *dpif)
341 return dpif->full_name;
344 /* Returns the name of datapath 'dpif' without the type
345 * (for use in device names). */
347 dpif_base_name(const struct dpif *dpif)
349 return dpif->base_name;
352 /* Enumerates all names that may be used to open 'dpif' into 'all_names'. The
353 * Linux datapath, for example, supports opening a datapath both by number,
354 * e.g. "dp0", and by the name of the datapath's local port. For some
355 * datapaths, this might be an infinite set (e.g. in a file name, slashes may
356 * be duplicated any number of times), in which case only the names most likely
357 * to be used will be enumerated.
359 * The caller must already have initialized 'all_names'. Any existing names in
360 * 'all_names' will not be disturbed. */
362 dpif_get_all_names(const struct dpif *dpif, struct svec *all_names)
364 if (dpif->dpif_class->get_all_names) {
365 int error = dpif->dpif_class->get_all_names(dpif, all_names);
367 VLOG_WARN_RL(&error_rl,
368 "failed to retrieve names for datpath %s: %s",
369 dpif_name(dpif), strerror(error));
373 svec_add(all_names, dpif_base_name(dpif));
378 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
379 * ports. After calling this function, it does not make sense to pass 'dpif'
380 * to any functions other than dpif_name() or dpif_close(). */
382 dpif_delete(struct dpif *dpif)
386 COVERAGE_INC(dpif_destroy);
388 error = dpif->dpif_class->destroy(dpif);
389 log_operation(dpif, "delete", error);
393 /* Retrieves statistics for 'dpif' into 'stats'. Returns 0 if successful,
394 * otherwise a positive errno value. */
396 dpif_get_dp_stats(const struct dpif *dpif, struct odp_stats *stats)
398 int error = dpif->dpif_class->get_stats(dpif, stats);
400 memset(stats, 0, sizeof *stats);
402 log_operation(dpif, "get_stats", error);
406 /* Retrieves the current IP fragment handling policy for 'dpif' into
407 * '*drop_frags': true indicates that fragments are dropped, false indicates
408 * that fragments are treated in the same way as other IP packets (except that
409 * the L4 header cannot be read). Returns 0 if successful, otherwise a
410 * positive errno value. */
412 dpif_get_drop_frags(const struct dpif *dpif, bool *drop_frags)
414 int error = dpif->dpif_class->get_drop_frags(dpif, drop_frags);
418 log_operation(dpif, "get_drop_frags", error);
422 /* Changes 'dpif''s treatment of IP fragments to 'drop_frags', whose meaning is
423 * the same as for the get_drop_frags member function. Returns 0 if
424 * successful, otherwise a positive errno value. */
426 dpif_set_drop_frags(struct dpif *dpif, bool drop_frags)
428 int error = dpif->dpif_class->set_drop_frags(dpif, drop_frags);
429 log_operation(dpif, "set_drop_frags", error);
433 /* Attempts to add 'devname' as a port on 'dpif', given the combination of
434 * ODP_PORT_* flags in 'flags'. If successful, returns 0 and sets '*port_nop'
435 * to the new port's port number (if 'port_nop' is non-null). On failure,
436 * returns a positive errno value and sets '*port_nop' to UINT16_MAX (if
437 * 'port_nop' is non-null). */
439 dpif_port_add(struct dpif *dpif, const char *devname, uint16_t flags,
445 COVERAGE_INC(dpif_port_add);
447 error = dpif->dpif_class->port_add(dpif, devname, flags, &port_no);
449 VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu16,
450 dpif_name(dpif), devname, port_no);
452 VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s",
453 dpif_name(dpif), devname, strerror(error));
454 port_no = UINT16_MAX;
462 /* Attempts to remove 'dpif''s port number 'port_no'. Returns 0 if successful,
463 * otherwise a positive errno value. */
465 dpif_port_del(struct dpif *dpif, uint16_t port_no)
469 COVERAGE_INC(dpif_port_del);
471 error = dpif->dpif_class->port_del(dpif, port_no);
472 log_operation(dpif, "port_del", error);
476 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and
477 * initializes '*port' appropriately; on failure, returns a positive errno
480 dpif_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
481 struct odp_port *port)
483 int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port);
485 VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu16" is device %s",
486 dpif_name(dpif), port_no, port->devname);
488 memset(port, 0, sizeof *port);
489 VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu16": %s",
490 dpif_name(dpif), port_no, strerror(error));
495 /* Looks up port named 'devname' in 'dpif'. On success, returns 0 and
496 * initializes '*port' appropriately; on failure, returns a positive errno
499 dpif_port_query_by_name(const struct dpif *dpif, const char *devname,
500 struct odp_port *port)
502 int error = dpif->dpif_class->port_query_by_name(dpif, devname, port);
504 VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu16,
505 dpif_name(dpif), devname, port->port);
507 memset(port, 0, sizeof *port);
509 /* Log level is DBG here because all the current callers are interested
510 * in whether 'dpif' actually has a port 'devname', so that it's not an
511 * issue worth logging if it doesn't. */
512 VLOG_DBG_RL(&error_rl, "%s: failed to query port %s: %s",
513 dpif_name(dpif), devname, strerror(error));
518 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and copies
519 * the port's name into the 'name_size' bytes in 'name', ensuring that the
520 * result is null-terminated. On failure, returns a positive errno value and
521 * makes 'name' the empty string. */
523 dpif_port_get_name(struct dpif *dpif, uint16_t port_no,
524 char *name, size_t name_size)
526 struct odp_port port;
529 assert(name_size > 0);
531 error = dpif_port_query_by_number(dpif, port_no, &port);
533 ovs_strlcpy(name, port.devname, name_size);
540 /* Obtains a list of all the ports in 'dpif'.
542 * If successful, returns 0 and sets '*portsp' to point to an array of
543 * appropriately initialized port structures and '*n_portsp' to the number of
544 * ports in the array. The caller is responsible for freeing '*portp' by
547 * On failure, returns a positive errno value and sets '*portsp' to NULL and
548 * '*n_portsp' to 0. */
550 dpif_port_list(const struct dpif *dpif,
551 struct odp_port **portsp, size_t *n_portsp)
553 struct odp_port *ports;
558 struct odp_stats stats;
561 error = dpif_get_dp_stats(dpif, &stats);
566 ports = xcalloc(stats.n_ports, sizeof *ports);
567 retval = dpif->dpif_class->port_list(dpif, ports, stats.n_ports);
573 } else if (retval <= stats.n_ports) {
579 /* Soft error: port count increased behind our back. Try again. */
592 log_operation(dpif, "port_list", error);
596 /* Polls for changes in the set of ports in 'dpif'. If the set of ports in
597 * 'dpif' has changed, this function does one of the following:
599 * - Stores the name of the device that was added to or deleted from 'dpif' in
600 * '*devnamep' and returns 0. The caller is responsible for freeing
601 * '*devnamep' (with free()) when it no longer needs it.
603 * - Returns ENOBUFS and sets '*devnamep' to NULL.
605 * This function may also return 'false positives', where it returns 0 and
606 * '*devnamep' names a device that was not actually added or deleted or it
607 * returns ENOBUFS without any change.
609 * Returns EAGAIN if the set of ports in 'dpif' has not changed. May also
610 * return other positive errno values to indicate that something has gone
613 dpif_port_poll(const struct dpif *dpif, char **devnamep)
615 int error = dpif->dpif_class->port_poll(dpif, devnamep);
622 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
623 * value other than EAGAIN. */
625 dpif_port_poll_wait(const struct dpif *dpif)
627 dpif->dpif_class->port_poll_wait(dpif);
630 /* Deletes all flows from 'dpif'. Returns 0 if successful, otherwise a
631 * positive errno value. */
633 dpif_flow_flush(struct dpif *dpif)
637 COVERAGE_INC(dpif_flow_flush);
639 error = dpif->dpif_class->flow_flush(dpif);
640 log_operation(dpif, "flow_flush", error);
644 /* Queries 'dpif' for a flow entry matching 'flow->key'.
646 * If a flow matching 'flow->key' exists in 'dpif', stores statistics for the
647 * flow into 'flow->stats'. If 'flow->n_actions' is zero, then 'flow->actions'
648 * is ignored. If 'flow->n_actions' is nonzero, then 'flow->actions' should
649 * point to an array of the specified number of actions. At most that many of
650 * the flow's actions will be copied into that array. 'flow->n_actions' will
651 * be updated to the number of actions actually present in the flow, which may
652 * be greater than the number stored if the flow has more actions than space
653 * available in the array.
655 * If no flow matching 'flow->key' exists in 'dpif', returns ENOENT. On other
656 * failure, returns a positive errno value. */
658 dpif_flow_get(const struct dpif *dpif, struct odp_flow *flow)
662 COVERAGE_INC(dpif_flow_get);
664 check_rw_odp_flow(flow);
665 error = dpif->dpif_class->flow_get(dpif, flow, 1);
667 error = flow->stats.error;
670 /* Make the results predictable on error. */
671 memset(&flow->stats, 0, sizeof flow->stats);
674 if (should_log_flow_message(error)) {
675 log_flow_operation(dpif, "flow_get", error, flow);
680 /* For each flow 'flow' in the 'n' flows in 'flows':
682 * - If a flow matching 'flow->key' exists in 'dpif':
684 * Stores 0 into 'flow->stats.error' and stores statistics for the flow
685 * into 'flow->stats'.
687 * If 'flow->n_actions' is zero, then 'flow->actions' is ignored. If
688 * 'flow->n_actions' is nonzero, then 'flow->actions' should point to an
689 * array of the specified number of actions. At most that many of the
690 * flow's actions will be copied into that array. 'flow->n_actions' will
691 * be updated to the number of actions actually present in the flow, which
692 * may be greater than the number stored if the flow has more actions than
693 * space available in the array.
695 * - Flow-specific errors are indicated by a positive errno value in
696 * 'flow->stats.error'. In particular, ENOENT indicates that no flow
697 * matching 'flow->key' exists in 'dpif'. When an error value is stored, the
698 * contents of 'flow->key' are preserved but other members of 'flow' should
699 * be treated as indeterminate.
701 * Returns 0 if all 'n' flows in 'flows' were updated (whether they were
702 * individually successful or not is indicated by 'flow->stats.error',
703 * however). Returns a positive errno value if an error that prevented this
704 * update occurred, in which the caller must not depend on any elements in
705 * 'flows' being updated or not updated.
708 dpif_flow_get_multiple(const struct dpif *dpif,
709 struct odp_flow flows[], size_t n)
714 COVERAGE_ADD(dpif_flow_get, n);
716 for (i = 0; i < n; i++) {
717 check_rw_odp_flow(&flows[i]);
720 error = dpif->dpif_class->flow_get(dpif, flows, n);
721 log_operation(dpif, "flow_get_multiple", error);
725 /* Adds or modifies a flow in 'dpif' as specified in 'put':
727 * - If the flow specified in 'put->flow' does not exist in 'dpif', then
728 * behavior depends on whether ODPPF_CREATE is specified in 'put->flags': if
729 * it is, the flow will be added, otherwise the operation will fail with
732 * - Otherwise, the flow specified in 'put->flow' does exist in 'dpif'.
733 * Behavior in this case depends on whether ODPPF_MODIFY is specified in
734 * 'put->flags': if it is, the flow's actions will be updated, otherwise the
735 * operation will fail with EEXIST. If the flow's actions are updated, then
736 * its statistics will be zeroed if ODPPF_ZERO_STATS is set in 'put->flags',
737 * left as-is otherwise.
739 * Returns 0 if successful, otherwise a positive errno value.
742 dpif_flow_put(struct dpif *dpif, struct odp_flow_put *put)
746 COVERAGE_INC(dpif_flow_put);
748 error = dpif->dpif_class->flow_put(dpif, put);
749 if (should_log_flow_message(error)) {
750 log_flow_put(dpif, error, put);
755 /* Deletes a flow matching 'flow->key' from 'dpif' or returns ENOENT if 'dpif'
756 * does not contain such a flow.
758 * If successful, updates 'flow->stats', 'flow->n_actions', and 'flow->actions'
759 * as described for dpif_flow_get(). */
761 dpif_flow_del(struct dpif *dpif, struct odp_flow *flow)
765 COVERAGE_INC(dpif_flow_del);
767 check_rw_odp_flow(flow);
768 memset(&flow->stats, 0, sizeof flow->stats);
770 error = dpif->dpif_class->flow_del(dpif, flow);
771 if (should_log_flow_message(error)) {
772 log_flow_operation(dpif, "delete flow", error, flow);
777 /* Stores up to 'n' flows in 'dpif' into 'flows', including their statistics
778 * but not including any information about their actions. If successful,
779 * returns 0 and sets '*n_out' to the number of flows actually present in
780 * 'dpif', which might be greater than the number stored (if 'dpif' has more
781 * than 'n' flows). On failure, returns a negative errno value and sets
784 dpif_flow_list(const struct dpif *dpif, struct odp_flow flows[], size_t n,
790 COVERAGE_INC(dpif_flow_query_list);
791 if (RUNNING_ON_VALGRIND) {
792 memset(flows, 0, n * sizeof *flows);
794 for (i = 0; i < n; i++) {
795 flows[i].actions = NULL;
796 flows[i].n_actions = 0;
799 retval = dpif->dpif_class->flow_list(dpif, flows, n);
802 VLOG_WARN_RL(&error_rl, "%s: flow list failed (%s)",
803 dpif_name(dpif), strerror(-retval));
806 COVERAGE_ADD(dpif_flow_query_list_n, retval);
807 *n_out = MIN(n, retval);
808 VLOG_DBG_RL(&dpmsg_rl, "%s: listed %zu flows (of %d)",
809 dpif_name(dpif), *n_out, retval);
814 /* Retrieves all of the flows in 'dpif'.
816 * If successful, returns 0 and stores in '*flowsp' a pointer to a newly
817 * allocated array of flows, including their statistics but not including any
818 * information about their actions, and sets '*np' to the number of flows in
819 * '*flowsp'. The caller is responsible for freeing '*flowsp' by calling
822 * On failure, returns a positive errno value and sets '*flowsp' to NULL and
825 dpif_flow_list_all(const struct dpif *dpif,
826 struct odp_flow **flowsp, size_t *np)
828 struct odp_stats stats;
829 struct odp_flow *flows;
836 error = dpif_get_dp_stats(dpif, &stats);
841 flows = xmalloc(sizeof *flows * stats.n_flows);
842 error = dpif_flow_list(dpif, flows, stats.n_flows, &n_flows);
848 if (stats.n_flows != n_flows) {
849 VLOG_WARN_RL(&error_rl, "%s: datapath stats reported %"PRIu32" "
850 "flows but flow listing reported %zu",
851 dpif_name(dpif), stats.n_flows, n_flows);
858 /* Causes 'dpif' to perform the 'n_actions' actions in 'actions' on the
859 * Ethernet frame specified in 'packet'.
861 * Returns 0 if successful, otherwise a positive errno value. */
863 dpif_execute(struct dpif *dpif,
864 const union odp_action actions[], size_t n_actions,
865 const struct ofpbuf *buf)
869 COVERAGE_INC(dpif_execute);
871 error = dpif->dpif_class->execute(dpif, actions, n_actions, buf);
876 if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) {
877 struct ds ds = DS_EMPTY_INITIALIZER;
878 char *packet = ofp_packet_to_string(buf->data, buf->size, buf->size);
879 ds_put_format(&ds, "%s: execute ", dpif_name(dpif));
880 format_odp_actions(&ds, actions, n_actions);
882 ds_put_format(&ds, " failed (%s)", strerror(error));
884 ds_put_format(&ds, " on packet %s", packet);
885 vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));
892 /* Retrieves 'dpif''s "listen mask" into '*listen_mask'. Each ODPL_* bit set
893 * in '*listen_mask' indicates that dpif_recv() will receive messages of that
894 * type. Returns 0 if successful, otherwise a positive errno value. */
896 dpif_recv_get_mask(const struct dpif *dpif, int *listen_mask)
898 int error = dpif->dpif_class->recv_get_mask(dpif, listen_mask);
902 log_operation(dpif, "recv_get_mask", error);
906 /* Sets 'dpif''s "listen mask" to 'listen_mask'. Each ODPL_* bit set in
907 * '*listen_mask' requests that dpif_recv() receive messages of that type.
908 * Returns 0 if successful, otherwise a positive errno value. */
910 dpif_recv_set_mask(struct dpif *dpif, int listen_mask)
912 int error = dpif->dpif_class->recv_set_mask(dpif, listen_mask);
913 log_operation(dpif, "recv_set_mask", error);
917 /* Retrieve the sFlow sampling probability. '*probability' is expressed as the
918 * number of packets out of UINT_MAX to sample, e.g. probability/UINT_MAX is
919 * the probability of sampling a given packet.
921 * Returns 0 if successful, otherwise a positive errno value. EOPNOTSUPP
922 * indicates that 'dpif' does not support sFlow sampling. */
924 dpif_get_sflow_probability(const struct dpif *dpif, uint32_t *probability)
926 int error = (dpif->dpif_class->get_sflow_probability
927 ? dpif->dpif_class->get_sflow_probability(dpif, probability)
932 log_operation(dpif, "get_sflow_probability", error);
936 /* Set the sFlow sampling probability. 'probability' is expressed as the
937 * number of packets out of UINT_MAX to sample, e.g. probability/UINT_MAX is
938 * the probability of sampling a given packet.
940 * Returns 0 if successful, otherwise a positive errno value. EOPNOTSUPP
941 * indicates that 'dpif' does not support sFlow sampling. */
943 dpif_set_sflow_probability(struct dpif *dpif, uint32_t probability)
945 int error = (dpif->dpif_class->set_sflow_probability
946 ? dpif->dpif_class->set_sflow_probability(dpif, probability)
948 log_operation(dpif, "set_sflow_probability", error);
952 /* Attempts to receive a message from 'dpif'. If successful, stores the
953 * message into '*packetp'. The message, if one is received, will begin with
954 * 'struct odp_msg' as a header, and will have at least DPIF_RECV_MSG_PADDING
955 * bytes of headroom. Only messages of the types selected with
956 * dpif_set_listen_mask() will ordinarily be received (but if a message type is
957 * enabled and then later disabled, some stragglers might pop up).
959 * Returns 0 if successful, otherwise a positive errno value. Returns EAGAIN
960 * if no message is immediately available. */
962 dpif_recv(struct dpif *dpif, struct ofpbuf **packetp)
964 int error = dpif->dpif_class->recv(dpif, packetp);
966 struct ofpbuf *buf = *packetp;
968 assert(ofpbuf_headroom(buf) >= DPIF_RECV_MSG_PADDING);
969 if (VLOG_IS_DBG_ENABLED()) {
970 struct odp_msg *msg = buf->data;
971 void *payload = msg + 1;
972 size_t payload_len = buf->size - sizeof *msg;
973 char *s = ofp_packet_to_string(payload, payload_len, payload_len);
974 VLOG_DBG_RL(&dpmsg_rl, "%s: received %s message of length "
975 "%zu on port %"PRIu16": %s", dpif_name(dpif),
976 (msg->type == _ODPL_MISS_NR ? "miss"
977 : msg->type == _ODPL_ACTION_NR ? "action"
978 : msg->type == _ODPL_SFLOW_NR ? "sFlow"
980 payload_len, msg->port, s);
989 /* Discards all messages that would otherwise be received by dpif_recv() on
990 * 'dpif'. Returns 0 if successful, otherwise a positive errno value. */
992 dpif_recv_purge(struct dpif *dpif)
994 struct odp_stats stats;
998 COVERAGE_INC(dpif_purge);
1000 error = dpif_get_dp_stats(dpif, &stats);
1005 for (i = 0; i < stats.max_miss_queue + stats.max_action_queue + stats.max_sflow_queue; i++) {
1007 error = dpif_recv(dpif, &buf);
1009 return error == EAGAIN ? 0 : error;
1016 /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be
1017 * received with dpif_recv(). */
1019 dpif_recv_wait(struct dpif *dpif)
1021 dpif->dpif_class->recv_wait(dpif);
1024 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1025 * and '*engine_id', respectively. */
1027 dpif_get_netflow_ids(const struct dpif *dpif,
1028 uint8_t *engine_type, uint8_t *engine_id)
1030 *engine_type = dpif->netflow_engine_type;
1031 *engine_id = dpif->netflow_engine_id;
1034 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1035 * value for use in the ODPAT_SET_PRIORITY action. On success, returns 0 and
1036 * stores the priority into '*priority'. On failure, returns a positive errno
1037 * value and stores 0 into '*priority'. */
1039 dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id,
1042 int error = (dpif->dpif_class->queue_to_priority
1043 ? dpif->dpif_class->queue_to_priority(dpif, queue_id,
1049 log_operation(dpif, "queue_to_priority", error);
1054 dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class,
1056 uint8_t netflow_engine_type, uint8_t netflow_engine_id)
1058 dpif->dpif_class = dpif_class;
1059 dpif->base_name = xstrdup(name);
1060 dpif->full_name = xasprintf("%s@%s", dpif_class->type, name);
1061 dpif->netflow_engine_type = netflow_engine_type;
1062 dpif->netflow_engine_id = netflow_engine_id;
1065 /* Undoes the results of initialization.
1067 * Normally this function only needs to be called from dpif_close().
1068 * However, it may be called by providers due to an error on opening
1069 * that occurs after initialization. It this case dpif_close() would
1070 * never be called. */
1072 dpif_uninit(struct dpif *dpif, bool close)
1074 char *base_name = dpif->base_name;
1075 char *full_name = dpif->full_name;
1078 dpif->dpif_class->close(dpif);
1086 log_operation(const struct dpif *dpif, const char *operation, int error)
1089 VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation);
1090 } else if (is_errno(error)) {
1091 VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1092 dpif_name(dpif), operation, strerror(error));
1094 VLOG_WARN_RL(&error_rl, "%s: %s failed (%d/%d)",
1095 dpif_name(dpif), operation,
1096 get_ofp_err_type(error), get_ofp_err_code(error));
1100 static enum vlog_level
1101 flow_message_log_level(int error)
1103 return error ? VLL_WARN : VLL_DBG;
1107 should_log_flow_message(int error)
1109 return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error),
1110 error ? &error_rl : &dpmsg_rl);
1114 log_flow_message(const struct dpif *dpif, int error, const char *operation,
1115 const struct odp_flow_key *flow,
1116 const struct odp_flow_stats *stats,
1117 const union odp_action *actions, size_t n_actions)
1119 struct ds ds = DS_EMPTY_INITIALIZER;
1120 ds_put_format(&ds, "%s: ", dpif_name(dpif));
1122 ds_put_cstr(&ds, "failed to ");
1124 ds_put_format(&ds, "%s ", operation);
1126 ds_put_format(&ds, "(%s) ", strerror(error));
1128 format_odp_flow_key(&ds, flow);
1130 ds_put_cstr(&ds, ", ");
1131 format_odp_flow_stats(&ds, stats);
1133 if (actions || n_actions) {
1134 ds_put_cstr(&ds, ", actions:");
1135 format_odp_actions(&ds, actions, n_actions);
1137 vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds));
1142 log_flow_operation(const struct dpif *dpif, const char *operation, int error,
1143 struct odp_flow *flow)
1146 flow->n_actions = 0;
1148 log_flow_message(dpif, error, operation, &flow->key,
1149 !error ? &flow->stats : NULL,
1150 flow->actions, flow->n_actions);
1154 log_flow_put(struct dpif *dpif, int error, const struct odp_flow_put *put)
1156 enum { ODPPF_ALL = ODPPF_CREATE | ODPPF_MODIFY | ODPPF_ZERO_STATS };
1160 ds_put_cstr(&s, "put");
1161 if (put->flags & ODPPF_CREATE) {
1162 ds_put_cstr(&s, "[create]");
1164 if (put->flags & ODPPF_MODIFY) {
1165 ds_put_cstr(&s, "[modify]");
1167 if (put->flags & ODPPF_ZERO_STATS) {
1168 ds_put_cstr(&s, "[zero]");
1170 if (put->flags & ~ODPPF_ALL) {
1171 ds_put_format(&s, "[%x]", put->flags & ~ODPPF_ALL);
1173 log_flow_message(dpif, error, ds_cstr(&s), &put->flow.key,
1174 !error ? &put->flow.stats : NULL,
1175 put->flow.actions, put->flow.n_actions);
1179 /* There is a tendency to construct odp_flow objects on the stack and to
1180 * forget to properly initialize their "actions" and "n_actions" members.
1181 * When this happens, we get memory corruption because the kernel
1182 * writes through the random pointer that is in the "actions" member.
1184 * This function attempts to combat the problem by:
1186 * - Forcing a segfault if "actions" points to an invalid region (instead
1187 * of just getting back EFAULT, which can be easily missed in the log).
1189 * - Storing a distinctive value that is likely to cause an
1190 * easy-to-identify error later if it is dereferenced, etc.
1192 * - Triggering a warning on uninitialized memory from Valgrind if
1193 * "actions" or "n_actions" was not initialized.
1196 check_rw_odp_flow(struct odp_flow *flow)
1198 if (flow->n_actions) {
1199 memset(&flow->actions[0], 0xcc, sizeof flow->actions[0]);