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"
35 #include "poll-loop.h"
41 #define THIS_MODULE VLM_dpif
43 static const struct dpif_class *dpif_classes[] = {
47 enum { N_DPIF_CLASSES = ARRAY_SIZE(dpif_classes) };
49 /* Rate limit for individual messages going to or from the datapath, output at
50 * DBG level. This is very high because, if these are enabled, it is because
51 * we really need to see them. */
52 static struct vlog_rate_limit dpmsg_rl = VLOG_RATE_LIMIT_INIT(600, 600);
54 /* Not really much point in logging many dpif errors. */
55 static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(9999, 5);
57 static void log_operation(const struct dpif *, const char *operation,
59 static void log_flow_operation(const struct dpif *, const char *operation,
60 int error, struct odp_flow *flow);
61 static void log_flow_put(struct dpif *, int error,
62 const struct odp_flow_put *);
63 static bool should_log_flow_message(int error);
64 static void check_rw_odp_flow(struct odp_flow *);
66 /* Performs periodic work needed by all the various kinds of dpifs.
68 * If your program opens any dpifs, it must call both this function and
69 * netdev_run() within its main poll loop. */
74 for (i = 0; i < N_DPIF_CLASSES; i++) {
75 const struct dpif_class *class = dpif_classes[i];
82 /* Arranges for poll_block() to wake up when dp_run() needs to be called.
84 * If your program opens any dpifs, it must call both this function and
85 * netdev_wait() within its main poll loop. */
90 for (i = 0; i < N_DPIF_CLASSES; i++) {
91 const struct dpif_class *class = dpif_classes[i];
99 /* Clears 'types' and enumerates the types of all known datapath providers,
100 * into it. The caller must first initialize the svec. */
102 dp_enumerate_types(struct svec *types)
108 for (i = 0; i < N_DPIF_CLASSES; i++) {
109 svec_add(types, dpif_classes[i]->type);
113 /* Clears 'names' and enumerates the names of all known created datapaths with
114 * the given 'type'. The caller must first initialize the svec. Returns 0 if
115 * successful, otherwise a positive errno value.
117 * Some kinds of datapaths might not be practically enumerable. This is not
118 * considered an error. */
120 dp_enumerate_names(const char *type, struct svec *names)
126 for (i = 0; i < N_DPIF_CLASSES; i++) {
127 const struct dpif_class *class = dpif_classes[i];
129 if (!strcmp(type, class->type)) {
130 int error = class->enumerate ? class->enumerate(names) : 0;
133 VLOG_WARN("failed to enumerate %s datapaths: %s",
134 class->type, strerror(error));
144 /* Parses 'datapath name', which is of the form type@name into its
145 * component pieces. 'name' and 'type' must be freed by the caller. */
147 dp_parse_name(const char *datapath_name_, char **name, char **type)
149 char *datapath_name = xstrdup(datapath_name_);
152 separator = strchr(datapath_name, '@');
155 *type = datapath_name;
156 *name = xstrdup(separator + 1);
158 *name = datapath_name;
164 do_open(const char *name, const char *type, bool create, struct dpif **dpifp)
166 struct dpif *dpif = NULL;
170 if (!type || *type == '\0') {
174 for (i = 0; i < N_DPIF_CLASSES; i++) {
175 const struct dpif_class *class = dpif_classes[i];
176 if (!strcmp(type, class->type)) {
177 error = class->open(name, type, create, &dpif);
181 error = EAFNOSUPPORT;
184 *dpifp = error ? NULL : dpif;
188 /* Tries to open an existing datapath named 'name' and type 'type'. Will fail
189 * if no datapath with 'name' and 'type' exists. 'type' may be either NULL or
190 * the empty string to specify the default system type. Returns 0 if
191 * successful, otherwise a positive errno value. On success stores a pointer
192 * to the datapath in '*dpifp', otherwise a null pointer. */
194 dpif_open(const char *name, const char *type, struct dpif **dpifp)
196 return do_open(name, type, false, dpifp);
199 /* Tries to create and open a new datapath with the given 'name' and 'type'.
200 * 'type' may be either NULL or the empty string to specify the default system
201 * type. Will fail if a datapath with 'name' and 'type' already exists.
202 * Returns 0 if successful, otherwise a positive errno value. On success
203 * stores a pointer to the datapath in '*dpifp', otherwise a null pointer. */
205 dpif_create(const char *name, const char *type, struct dpif **dpifp)
207 return do_open(name, type, true, dpifp);
210 /* Tries to open a datapath with the given 'name' and 'type', creating it if it
211 * does not exist. 'type' may be either NULL or the empty string to specify
212 * the default system type. Returns 0 if successful, otherwise a positive
213 * errno value. On success stores a pointer to the datapath in '*dpifp',
214 * otherwise a null pointer. */
216 dpif_create_and_open(const char *name, const char *type, struct dpif **dpifp)
220 error = dpif_create(name, type, dpifp);
221 if (error == EEXIST || error == EBUSY) {
222 error = dpif_open(name, type, dpifp);
224 VLOG_WARN("datapath %s already exists but cannot be opened: %s",
225 name, strerror(error));
228 VLOG_WARN("failed to create datapath %s: %s", name, strerror(error));
233 /* Closes and frees the connection to 'dpif'. Does not destroy the datapath
234 * itself; call dpif_delete() first, instead, if that is desirable. */
236 dpif_close(struct dpif *dpif)
239 char *base_name = dpif->base_name;
240 char *full_name = dpif->full_name;
241 dpif->class->close(dpif);
247 /* Returns the name of datapath 'dpif' prefixed with the type
248 * (for use in log messages). */
250 dpif_name(const struct dpif *dpif)
252 return dpif->full_name;
255 /* Returns the name of datapath 'dpif' without the type
256 * (for use in device names). */
258 dpif_base_name(const struct dpif *dpif)
260 return dpif->base_name;
263 /* Enumerates all names that may be used to open 'dpif' into 'all_names'. The
264 * Linux datapath, for example, supports opening a datapath both by number,
265 * e.g. "dp0", and by the name of the datapath's local port. For some
266 * datapaths, this might be an infinite set (e.g. in a file name, slashes may
267 * be duplicated any number of times), in which case only the names most likely
268 * to be used will be enumerated.
270 * The caller must already have initialized 'all_names'. Any existing names in
271 * 'all_names' will not be disturbed. */
273 dpif_get_all_names(const struct dpif *dpif, struct svec *all_names)
275 if (dpif->class->get_all_names) {
276 int error = dpif->class->get_all_names(dpif, all_names);
278 VLOG_WARN_RL(&error_rl,
279 "failed to retrieve names for datpath %s: %s",
280 dpif_name(dpif), strerror(error));
284 svec_add(all_names, dpif_base_name(dpif));
289 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
290 * ports. After calling this function, it does not make sense to pass 'dpif'
291 * to any functions other than dpif_name() or dpif_close(). */
293 dpif_delete(struct dpif *dpif)
297 COVERAGE_INC(dpif_destroy);
299 error = dpif->class->delete(dpif);
300 log_operation(dpif, "delete", error);
304 /* Retrieves statistics for 'dpif' into 'stats'. Returns 0 if successful,
305 * otherwise a positive errno value. */
307 dpif_get_dp_stats(const struct dpif *dpif, struct odp_stats *stats)
309 int error = dpif->class->get_stats(dpif, stats);
311 memset(stats, 0, sizeof *stats);
313 log_operation(dpif, "get_stats", error);
317 /* Retrieves the current IP fragment handling policy for 'dpif' into
318 * '*drop_frags': true indicates that fragments are dropped, false indicates
319 * that fragments are treated in the same way as other IP packets (except that
320 * the L4 header cannot be read). Returns 0 if successful, otherwise a
321 * positive errno value. */
323 dpif_get_drop_frags(const struct dpif *dpif, bool *drop_frags)
325 int error = dpif->class->get_drop_frags(dpif, drop_frags);
329 log_operation(dpif, "get_drop_frags", error);
333 /* Changes 'dpif''s treatment of IP fragments to 'drop_frags', whose meaning is
334 * the same as for the get_drop_frags member function. Returns 0 if
335 * successful, otherwise a positive errno value. */
337 dpif_set_drop_frags(struct dpif *dpif, bool drop_frags)
339 int error = dpif->class->set_drop_frags(dpif, drop_frags);
340 log_operation(dpif, "set_drop_frags", error);
344 /* Attempts to add 'devname' as a port on 'dpif', given the combination of
345 * ODP_PORT_* flags in 'flags'. If successful, returns 0 and sets '*port_nop'
346 * to the new port's port number (if 'port_nop' is non-null). On failure,
347 * returns a positive errno value and sets '*port_nop' to UINT16_MAX (if
348 * 'port_nop' is non-null). */
350 dpif_port_add(struct dpif *dpif, const char *devname, uint16_t flags,
356 COVERAGE_INC(dpif_port_add);
358 error = dpif->class->port_add(dpif, devname, flags, &port_no);
360 VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu16,
361 dpif_name(dpif), devname, port_no);
363 VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s",
364 dpif_name(dpif), devname, strerror(error));
365 port_no = UINT16_MAX;
373 /* Attempts to remove 'dpif''s port number 'port_no'. Returns 0 if successful,
374 * otherwise a positive errno value. */
376 dpif_port_del(struct dpif *dpif, uint16_t port_no)
380 COVERAGE_INC(dpif_port_del);
382 error = dpif->class->port_del(dpif, port_no);
383 log_operation(dpif, "port_del", error);
387 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and
388 * initializes '*port' appropriately; on failure, returns a positive errno
391 dpif_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
392 struct odp_port *port)
394 int error = dpif->class->port_query_by_number(dpif, port_no, port);
396 VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu16" is device %s",
397 dpif_name(dpif), port_no, port->devname);
399 memset(port, 0, sizeof *port);
400 VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu16": %s",
401 dpif_name(dpif), port_no, strerror(error));
406 /* Looks up port named 'devname' in 'dpif'. On success, returns 0 and
407 * initializes '*port' appropriately; on failure, returns a positive errno
410 dpif_port_query_by_name(const struct dpif *dpif, const char *devname,
411 struct odp_port *port)
413 int error = dpif->class->port_query_by_name(dpif, devname, port);
415 VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu16,
416 dpif_name(dpif), devname, port->port);
418 memset(port, 0, sizeof *port);
420 /* Log level is DBG here because all the current callers are interested
421 * in whether 'dpif' actually has a port 'devname', so that it's not an
422 * issue worth logging if it doesn't. */
423 VLOG_DBG_RL(&error_rl, "%s: failed to query port %s: %s",
424 dpif_name(dpif), devname, strerror(error));
429 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and copies
430 * the port's name into the 'name_size' bytes in 'name', ensuring that the
431 * result is null-terminated. On failure, returns a positive errno value and
432 * makes 'name' the empty string. */
434 dpif_port_get_name(struct dpif *dpif, uint16_t port_no,
435 char *name, size_t name_size)
437 struct odp_port port;
440 assert(name_size > 0);
442 error = dpif_port_query_by_number(dpif, port_no, &port);
444 ovs_strlcpy(name, port.devname, name_size);
451 /* Obtains a list of all the ports in 'dpif'.
453 * If successful, returns 0 and sets '*portsp' to point to an array of
454 * appropriately initialized port structures and '*n_portsp' to the number of
455 * ports in the array. The caller is responsible for freeing '*portp' by
458 * On failure, returns a positive errno value and sets '*portsp' to NULL and
459 * '*n_portsp' to 0. */
461 dpif_port_list(const struct dpif *dpif,
462 struct odp_port **portsp, size_t *n_portsp)
464 struct odp_port *ports;
469 struct odp_stats stats;
472 error = dpif_get_dp_stats(dpif, &stats);
477 ports = xcalloc(stats.n_ports, sizeof *ports);
478 retval = dpif->class->port_list(dpif, ports, stats.n_ports);
484 } else if (retval <= stats.n_ports) {
490 /* Soft error: port count increased behind our back. Try again. */
503 log_operation(dpif, "port_list", error);
507 /* Polls for changes in the set of ports in 'dpif'. If the set of ports in
508 * 'dpif' has changed, this function does one of the following:
510 * - Stores the name of the device that was added to or deleted from 'dpif' in
511 * '*devnamep' and returns 0. The caller is responsible for freeing
512 * '*devnamep' (with free()) when it no longer needs it.
514 * - Returns ENOBUFS and sets '*devnamep' to NULL.
516 * This function may also return 'false positives', where it returns 0 and
517 * '*devnamep' names a device that was not actually added or deleted or it
518 * returns ENOBUFS without any change.
520 * Returns EAGAIN if the set of ports in 'dpif' has not changed. May also
521 * return other positive errno values to indicate that something has gone
524 dpif_port_poll(const struct dpif *dpif, char **devnamep)
526 int error = dpif->class->port_poll(dpif, devnamep);
533 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
534 * value other than EAGAIN. */
536 dpif_port_poll_wait(const struct dpif *dpif)
538 dpif->class->port_poll_wait(dpif);
541 /* Retrieves a list of the port numbers in port group 'group' in 'dpif'.
543 * On success, returns 0 and points '*ports' to a newly allocated array of
544 * integers, each of which is a 'dpif' port number for a port in
545 * 'group'. Stores the number of elements in the array in '*n_ports'. The
546 * caller is responsible for freeing '*ports' by calling free().
548 * On failure, returns a positive errno value and sets '*ports' to NULL and
549 * '*n_ports' to 0. */
551 dpif_port_group_get(const struct dpif *dpif, uint16_t group,
552 uint16_t **ports, size_t *n_ports)
559 int retval = dpif->class->port_group_get(dpif, group,
568 } else if (retval <= *n_ports) {
574 /* Soft error: there were more ports than we expected in the
575 * group. Try again. */
577 *ports = xcalloc(retval, sizeof **ports);
581 log_operation(dpif, "port_group_get", error);
585 /* Updates port group 'group' in 'dpif', making it contain the 'n_ports' ports
586 * whose 'dpif' port numbers are given in 'n_ports'. Returns 0 if
587 * successful, otherwise a positive errno value.
589 * Behavior is undefined if the values in ports[] are not unique. */
591 dpif_port_group_set(struct dpif *dpif, uint16_t group,
592 const uint16_t ports[], size_t n_ports)
596 COVERAGE_INC(dpif_port_group_set);
598 error = dpif->class->port_group_set(dpif, group, ports, n_ports);
599 log_operation(dpif, "port_group_set", error);
603 /* Deletes all flows from 'dpif'. Returns 0 if successful, otherwise a
604 * positive errno value. */
606 dpif_flow_flush(struct dpif *dpif)
610 COVERAGE_INC(dpif_flow_flush);
612 error = dpif->class->flow_flush(dpif);
613 log_operation(dpif, "flow_flush", error);
617 /* Queries 'dpif' for a flow entry matching 'flow->key'.
619 * If a flow matching 'flow->key' exists in 'dpif', stores statistics for the
620 * flow into 'flow->stats'. If 'flow->n_actions' is zero, then 'flow->actions'
621 * is ignored. If 'flow->n_actions' is nonzero, then 'flow->actions' should
622 * point to an array of the specified number of actions. At most that many of
623 * the flow's actions will be copied into that array. 'flow->n_actions' will
624 * be updated to the number of actions actually present in the flow, which may
625 * be greater than the number stored if the flow has more actions than space
626 * available in the array.
628 * If no flow matching 'flow->key' exists in 'dpif', returns ENOENT. On other
629 * failure, returns a positive errno value. */
631 dpif_flow_get(const struct dpif *dpif, struct odp_flow *flow)
635 COVERAGE_INC(dpif_flow_get);
637 check_rw_odp_flow(flow);
638 error = dpif->class->flow_get(dpif, flow, 1);
640 error = flow->stats.error;
642 if (should_log_flow_message(error)) {
643 log_flow_operation(dpif, "flow_get", error, flow);
648 /* For each flow 'flow' in the 'n' flows in 'flows':
650 * - If a flow matching 'flow->key' exists in 'dpif':
652 * Stores 0 into 'flow->stats.error' and stores statistics for the flow
653 * into 'flow->stats'.
655 * If 'flow->n_actions' is zero, then 'flow->actions' is ignored. If
656 * 'flow->n_actions' is nonzero, then 'flow->actions' should point to an
657 * array of the specified number of actions. At most that many of the
658 * flow's actions will be copied into that array. 'flow->n_actions' will
659 * be updated to the number of actions actually present in the flow, which
660 * may be greater than the number stored if the flow has more actions than
661 * space available in the array.
663 * - Flow-specific errors are indicated by a positive errno value in
664 * 'flow->stats.error'. In particular, ENOENT indicates that no flow
665 * matching 'flow->key' exists in 'dpif'. When an error value is stored, the
666 * contents of 'flow->key' are preserved but other members of 'flow' should
667 * be treated as indeterminate.
669 * Returns 0 if all 'n' flows in 'flows' were updated (whether they were
670 * individually successful or not is indicated by 'flow->stats.error',
671 * however). Returns a positive errno value if an error that prevented this
672 * update occurred, in which the caller must not depend on any elements in
673 * 'flows' being updated or not updated.
676 dpif_flow_get_multiple(const struct dpif *dpif,
677 struct odp_flow flows[], size_t n)
682 COVERAGE_ADD(dpif_flow_get, n);
684 for (i = 0; i < n; i++) {
685 check_rw_odp_flow(&flows[i]);
688 error = dpif->class->flow_get(dpif, flows, n);
689 log_operation(dpif, "flow_get_multiple", error);
693 /* Adds or modifies a flow in 'dpif' as specified in 'put':
695 * - If the flow specified in 'put->flow' does not exist in 'dpif', then
696 * behavior depends on whether ODPPF_CREATE is specified in 'put->flags': if
697 * it is, the flow will be added, otherwise the operation will fail with
700 * - Otherwise, the flow specified in 'put->flow' does exist in 'dpif'.
701 * Behavior in this case depends on whether ODPPF_MODIFY is specified in
702 * 'put->flags': if it is, the flow's actions will be updated, otherwise the
703 * operation will fail with EEXIST. If the flow's actions are updated, then
704 * its statistics will be zeroed if ODPPF_ZERO_STATS is set in 'put->flags',
705 * left as-is otherwise.
707 * Returns 0 if successful, otherwise a positive errno value.
710 dpif_flow_put(struct dpif *dpif, struct odp_flow_put *put)
714 COVERAGE_INC(dpif_flow_put);
716 error = dpif->class->flow_put(dpif, put);
717 if (should_log_flow_message(error)) {
718 log_flow_put(dpif, error, put);
723 /* Deletes a flow matching 'flow->key' from 'dpif' or returns ENOENT if 'dpif'
724 * does not contain such a flow.
726 * If successful, updates 'flow->stats', 'flow->n_actions', and 'flow->actions'
727 * as described for dpif_flow_get(). */
729 dpif_flow_del(struct dpif *dpif, struct odp_flow *flow)
733 COVERAGE_INC(dpif_flow_del);
735 check_rw_odp_flow(flow);
736 memset(&flow->stats, 0, sizeof flow->stats);
738 error = dpif->class->flow_del(dpif, flow);
739 if (should_log_flow_message(error)) {
740 log_flow_operation(dpif, "delete flow", error, flow);
745 /* Stores up to 'n' flows in 'dpif' into 'flows', including their statistics
746 * but not including any information about their actions. If successful,
747 * returns 0 and sets '*n_out' to the number of flows actually present in
748 * 'dpif', which might be greater than the number stored (if 'dpif' has more
749 * than 'n' flows). On failure, returns a negative errno value and sets
752 dpif_flow_list(const struct dpif *dpif, struct odp_flow flows[], size_t n,
758 COVERAGE_INC(dpif_flow_query_list);
759 if (RUNNING_ON_VALGRIND) {
760 memset(flows, 0, n * sizeof *flows);
762 for (i = 0; i < n; i++) {
763 flows[i].actions = NULL;
764 flows[i].n_actions = 0;
767 retval = dpif->class->flow_list(dpif, flows, n);
770 VLOG_WARN_RL(&error_rl, "%s: flow list failed (%s)",
771 dpif_name(dpif), strerror(-retval));
774 COVERAGE_ADD(dpif_flow_query_list_n, retval);
775 *n_out = MIN(n, retval);
776 VLOG_DBG_RL(&dpmsg_rl, "%s: listed %zu flows (of %d)",
777 dpif_name(dpif), *n_out, retval);
782 /* Retrieves all of the flows in 'dpif'.
784 * If successful, returns 0 and stores in '*flowsp' a pointer to a newly
785 * allocated array of flows, including their statistics but not including any
786 * information about their actions, and sets '*np' to the number of flows in
787 * '*flowsp'. The caller is responsible for freeing '*flowsp' by calling
790 * On failure, returns a positive errno value and sets '*flowsp' to NULL and
793 dpif_flow_list_all(const struct dpif *dpif,
794 struct odp_flow **flowsp, size_t *np)
796 struct odp_stats stats;
797 struct odp_flow *flows;
804 error = dpif_get_dp_stats(dpif, &stats);
809 flows = xmalloc(sizeof *flows * stats.n_flows);
810 error = dpif_flow_list(dpif, flows, stats.n_flows, &n_flows);
816 if (stats.n_flows != n_flows) {
817 VLOG_WARN_RL(&error_rl, "%s: datapath stats reported %"PRIu32" "
818 "flows but flow listing reported %zu",
819 dpif_name(dpif), stats.n_flows, n_flows);
826 /* Causes 'dpif' to perform the 'n_actions' actions in 'actions' on the
827 * Ethernet frame specified in 'packet'.
829 * Pretends that the frame was originally received on the port numbered
830 * 'in_port'. This affects only ODPAT_OUTPUT_GROUP actions, which will not
831 * send a packet out their input port. Specify the number of an unused port
832 * (e.g. UINT16_MAX is currently always unused) to avoid this behavior.
834 * Returns 0 if successful, otherwise a positive errno value. */
836 dpif_execute(struct dpif *dpif, uint16_t in_port,
837 const union odp_action actions[], size_t n_actions,
838 const struct ofpbuf *buf)
842 COVERAGE_INC(dpif_execute);
844 error = dpif->class->execute(dpif, in_port, actions, n_actions, buf);
849 if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) {
850 struct ds ds = DS_EMPTY_INITIALIZER;
851 char *packet = ofp_packet_to_string(buf->data, buf->size, buf->size);
852 ds_put_format(&ds, "%s: execute ", dpif_name(dpif));
853 format_odp_actions(&ds, actions, n_actions);
855 ds_put_format(&ds, " failed (%s)", strerror(error));
857 ds_put_format(&ds, " on packet %s", packet);
858 vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));
865 /* Retrieves 'dpif''s "listen mask" into '*listen_mask'. Each ODPL_* bit set
866 * in '*listen_mask' indicates that dpif_recv() will receive messages of that
867 * type. Returns 0 if successful, otherwise a positive errno value. */
869 dpif_recv_get_mask(const struct dpif *dpif, int *listen_mask)
871 int error = dpif->class->recv_get_mask(dpif, listen_mask);
875 log_operation(dpif, "recv_get_mask", error);
879 /* Sets 'dpif''s "listen mask" to 'listen_mask'. Each ODPL_* bit set in
880 * '*listen_mask' requests that dpif_recv() receive messages of that type.
881 * Returns 0 if successful, otherwise a positive errno value. */
883 dpif_recv_set_mask(struct dpif *dpif, int listen_mask)
885 int error = dpif->class->recv_set_mask(dpif, listen_mask);
886 log_operation(dpif, "recv_set_mask", error);
890 /* Attempts to receive a message from 'dpif'. If successful, stores the
891 * message into '*packetp'. The message, if one is received, will begin with
892 * 'struct odp_msg' as a header. Only messages of the types selected with
893 * dpif_set_listen_mask() will ordinarily be received (but if a message type is
894 * enabled and then later disabled, some stragglers might pop up).
896 * Returns 0 if successful, otherwise a positive errno value. Returns EAGAIN
897 * if no message is immediately available. */
899 dpif_recv(struct dpif *dpif, struct ofpbuf **packetp)
901 int error = dpif->class->recv(dpif, packetp);
903 if (VLOG_IS_DBG_ENABLED()) {
904 struct ofpbuf *buf = *packetp;
905 struct odp_msg *msg = buf->data;
906 void *payload = msg + 1;
907 size_t payload_len = buf->size - sizeof *msg;
908 char *s = ofp_packet_to_string(payload, payload_len, payload_len);
909 VLOG_DBG_RL(&dpmsg_rl, "%s: received %s message of length "
910 "%zu on port %"PRIu16": %s", dpif_name(dpif),
911 (msg->type == _ODPL_MISS_NR ? "miss"
912 : msg->type == _ODPL_ACTION_NR ? "action"
914 payload_len, msg->port, s);
923 /* Discards all messages that would otherwise be received by dpif_recv() on
924 * 'dpif'. Returns 0 if successful, otherwise a positive errno value. */
926 dpif_recv_purge(struct dpif *dpif)
928 struct odp_stats stats;
932 COVERAGE_INC(dpif_purge);
934 error = dpif_get_dp_stats(dpif, &stats);
939 for (i = 0; i < stats.max_miss_queue + stats.max_action_queue; i++) {
941 error = dpif_recv(dpif, &buf);
943 return error == EAGAIN ? 0 : error;
950 /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be
951 * received with dpif_recv(). */
953 dpif_recv_wait(struct dpif *dpif)
955 dpif->class->recv_wait(dpif);
958 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
959 * and '*engine_id', respectively. */
961 dpif_get_netflow_ids(const struct dpif *dpif,
962 uint8_t *engine_type, uint8_t *engine_id)
964 *engine_type = dpif->netflow_engine_type;
965 *engine_id = dpif->netflow_engine_id;
969 dpif_init(struct dpif *dpif, const struct dpif_class *class, const char *name,
970 uint8_t netflow_engine_type, uint8_t netflow_engine_id)
973 dpif->base_name = xstrdup(name);
974 dpif->full_name = xasprintf("%s@%s", class->type, name);
975 dpif->netflow_engine_type = netflow_engine_type;
976 dpif->netflow_engine_id = netflow_engine_id;
980 log_operation(const struct dpif *dpif, const char *operation, int error)
983 VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation);
985 VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
986 dpif_name(dpif), operation, strerror(error));
990 static enum vlog_level
991 flow_message_log_level(int error)
993 return error ? VLL_WARN : VLL_DBG;
997 should_log_flow_message(int error)
999 return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error),
1000 error ? &error_rl : &dpmsg_rl);
1004 log_flow_message(const struct dpif *dpif, int error, const char *operation,
1005 const flow_t *flow, const struct odp_flow_stats *stats,
1006 const union odp_action *actions, size_t n_actions)
1008 struct ds ds = DS_EMPTY_INITIALIZER;
1009 ds_put_format(&ds, "%s: ", dpif_name(dpif));
1011 ds_put_cstr(&ds, "failed to ");
1013 ds_put_format(&ds, "%s ", operation);
1015 ds_put_format(&ds, "(%s) ", strerror(error));
1017 flow_format(&ds, flow);
1019 ds_put_cstr(&ds, ", ");
1020 format_odp_flow_stats(&ds, stats);
1022 if (actions || n_actions) {
1023 ds_put_cstr(&ds, ", actions:");
1024 format_odp_actions(&ds, actions, n_actions);
1026 vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds));
1031 log_flow_operation(const struct dpif *dpif, const char *operation, int error,
1032 struct odp_flow *flow)
1035 flow->n_actions = 0;
1037 log_flow_message(dpif, error, operation, &flow->key,
1038 !error ? &flow->stats : NULL,
1039 flow->actions, flow->n_actions);
1043 log_flow_put(struct dpif *dpif, int error, const struct odp_flow_put *put)
1045 enum { ODPPF_ALL = ODPPF_CREATE | ODPPF_MODIFY | ODPPF_ZERO_STATS };
1049 ds_put_cstr(&s, "put");
1050 if (put->flags & ODPPF_CREATE) {
1051 ds_put_cstr(&s, "[create]");
1053 if (put->flags & ODPPF_MODIFY) {
1054 ds_put_cstr(&s, "[modify]");
1056 if (put->flags & ODPPF_ZERO_STATS) {
1057 ds_put_cstr(&s, "[zero]");
1059 if (put->flags & ~ODPPF_ALL) {
1060 ds_put_format(&s, "[%x]", put->flags & ~ODPPF_ALL);
1062 log_flow_message(dpif, error, ds_cstr(&s), &put->flow.key,
1063 !error ? &put->flow.stats : NULL,
1064 put->flow.actions, put->flow.n_actions);
1068 /* There is a tendency to construct odp_flow objects on the stack and to
1069 * forget to properly initialize their "actions" and "n_actions" members.
1070 * When this happens, we get memory corruption because the kernel
1071 * writes through the random pointer that is in the "actions" member.
1073 * This function attempts to combat the problem by:
1075 * - Forcing a segfault if "actions" points to an invalid region (instead
1076 * of just getting back EFAULT, which can be easily missed in the log).
1078 * - Storing a distinctive value that is likely to cause an
1079 * easy-to-identify error later if it is dereferenced, etc.
1081 * - Triggering a warning on uninitialized memory from Valgrind if
1082 * "actions" or "n_actions" was not initialized.
1085 check_rw_odp_flow(struct odp_flow *flow)
1087 if (flow->n_actions) {
1088 memset(&flow->actions[0], 0xcc, sizeof flow->actions[0]);