]>
git.proxmox.com Git - ovs.git/blob - lib/dpif.c
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
];
98 /* Clears 'all_dps' and enumerates the names of all known created datapaths,
99 * where possible, into it. The caller must first initialize 'all_dps'.
100 * Returns 0 if successful, otherwise a positive errno value.
102 * Some kinds of datapaths might not be practically enumerable. This is not
103 * considered an error. */
105 dp_enumerate(struct svec
*all_dps
)
112 for (i
= 0; i
< N_DPIF_CLASSES
; i
++) {
113 const struct dpif_class
*class = dpif_classes
[i
];
114 int retval
= class->enumerate
? class->enumerate(all_dps
) : 0;
116 VLOG_WARN("failed to enumerate %s datapaths: %s",
117 class->name
, strerror(retval
));
127 do_open(const char *name_
, bool create
, struct dpif
**dpifp
)
129 char *name
= xstrdup(name_
);
130 char *prefix
, *suffix
, *colon
;
131 struct dpif
*dpif
= NULL
;
135 colon
= strchr(name
, ':');
145 for (i
= 0; i
< N_DPIF_CLASSES
; i
++) {
146 const struct dpif_class
*class = dpif_classes
[i
];
147 if (!strcmp(prefix
, class->prefix
)) {
148 error
= class->open(name_
, suffix
, create
, &dpif
);
152 error
= EAFNOSUPPORT
;
155 *dpifp
= error
? NULL
: dpif
;
159 /* Tries to open an existing datapath named 'name'. Will fail if no datapath
160 * named 'name' exists. Returns 0 if successful, otherwise a positive errno
161 * value. On success stores a pointer to the datapath in '*dpifp', otherwise a
164 dpif_open(const char *name
, struct dpif
**dpifp
)
166 return do_open(name
, false, dpifp
);
169 /* Tries to create and open a new datapath with the given 'name'. Will fail if
170 * a datapath named 'name' already exists. Returns 0 if successful, otherwise
171 * a positive errno value. On success stores a pointer to the datapath in
172 * '*dpifp', otherwise a null pointer. */
174 dpif_create(const char *name
, struct dpif
**dpifp
)
176 return do_open(name
, true, dpifp
);
179 /* Tries to open a datapath with the given 'name', creating it if it does not
180 * exist. Returns 0 if successful, otherwise a positive errno value. On
181 * success stores a pointer to the datapath in '*dpifp', otherwise a null
184 dpif_create_and_open(const char *name
, struct dpif
**dpifp
)
188 error
= dpif_create(name
, dpifp
);
189 if (error
== EEXIST
|| error
== EBUSY
) {
190 error
= dpif_open(name
, dpifp
);
192 VLOG_WARN("datapath %s already exists but cannot be opened: %s",
193 name
, strerror(error
));
196 VLOG_WARN("failed to create datapath %s: %s", name
, strerror(error
));
201 /* Closes and frees the connection to 'dpif'. Does not destroy the datapath
202 * itself; call dpif_delete() first, instead, if that is desirable. */
204 dpif_close(struct dpif
*dpif
)
207 char *name
= dpif
->name
;
208 dpif
->dpif_class
->close(dpif
);
213 /* Returns the name of datapath 'dpif' (for use in log messages). */
215 dpif_name(const struct dpif
*dpif
)
220 /* Enumerates all names that may be used to open 'dpif' into 'all_names'. The
221 * Linux datapath, for example, supports opening a datapath both by number,
222 * e.g. "dp0", and by the name of the datapath's local port. For some
223 * datapaths, this might be an infinite set (e.g. in a file name, slashes may
224 * be duplicated any number of times), in which case only the names most likely
225 * to be used will be enumerated.
227 * The caller must already have initialized 'all_names'. Any existing names in
228 * 'all_names' will not be disturbed. */
230 dpif_get_all_names(const struct dpif
*dpif
, struct svec
*all_names
)
232 if (dpif
->dpif_class
->get_all_names
) {
233 int error
= dpif
->dpif_class
->get_all_names(dpif
, all_names
);
235 VLOG_WARN_RL(&error_rl
,
236 "failed to retrieve names for datpath %s: %s",
237 dpif_name(dpif
), strerror(error
));
241 svec_add(all_names
, dpif_name(dpif
));
246 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
247 * ports. After calling this function, it does not make sense to pass 'dpif'
248 * to any functions other than dpif_name() or dpif_close(). */
250 dpif_delete(struct dpif
*dpif
)
254 COVERAGE_INC(dpif_destroy
);
256 error
= dpif
->dpif_class
->destroy(dpif
);
257 log_operation(dpif
, "delete", error
);
261 /* Retrieves statistics for 'dpif' into 'stats'. Returns 0 if successful,
262 * otherwise a positive errno value. */
264 dpif_get_dp_stats(const struct dpif
*dpif
, struct odp_stats
*stats
)
266 int error
= dpif
->dpif_class
->get_stats(dpif
, stats
);
268 memset(stats
, 0, sizeof *stats
);
270 log_operation(dpif
, "get_stats", error
);
274 /* Retrieves the current IP fragment handling policy for 'dpif' into
275 * '*drop_frags': true indicates that fragments are dropped, false indicates
276 * that fragments are treated in the same way as other IP packets (except that
277 * the L4 header cannot be read). Returns 0 if successful, otherwise a
278 * positive errno value. */
280 dpif_get_drop_frags(const struct dpif
*dpif
, bool *drop_frags
)
282 int error
= dpif
->dpif_class
->get_drop_frags(dpif
, drop_frags
);
286 log_operation(dpif
, "get_drop_frags", error
);
290 /* Changes 'dpif''s treatment of IP fragments to 'drop_frags', whose meaning is
291 * the same as for the get_drop_frags member function. Returns 0 if
292 * successful, otherwise a positive errno value. */
294 dpif_set_drop_frags(struct dpif
*dpif
, bool drop_frags
)
296 int error
= dpif
->dpif_class
->set_drop_frags(dpif
, drop_frags
);
297 log_operation(dpif
, "set_drop_frags", error
);
301 /* Attempts to add 'devname' as a port on 'dpif', given the combination of
302 * ODP_PORT_* flags in 'flags'. If successful, returns 0 and sets '*port_nop'
303 * to the new port's port number (if 'port_nop' is non-null). On failure,
304 * returns a positive errno value and sets '*port_nop' to UINT16_MAX (if
305 * 'port_nop' is non-null). */
307 dpif_port_add(struct dpif
*dpif
, const char *devname
, uint16_t flags
,
313 COVERAGE_INC(dpif_port_add
);
315 error
= dpif
->dpif_class
->port_add(dpif
, devname
, flags
, &port_no
);
317 VLOG_DBG_RL(&dpmsg_rl
, "%s: added %s as port %"PRIu16
,
318 dpif_name(dpif
), devname
, port_no
);
320 VLOG_WARN_RL(&error_rl
, "%s: failed to add %s as port: %s",
321 dpif_name(dpif
), devname
, strerror(error
));
322 port_no
= UINT16_MAX
;
330 /* Attempts to remove 'dpif''s port number 'port_no'. Returns 0 if successful,
331 * otherwise a positive errno value. */
333 dpif_port_del(struct dpif
*dpif
, uint16_t port_no
)
337 COVERAGE_INC(dpif_port_del
);
339 error
= dpif
->dpif_class
->port_del(dpif
, port_no
);
340 log_operation(dpif
, "port_del", error
);
344 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and
345 * initializes '*port' appropriately; on failure, returns a positive errno
348 dpif_port_query_by_number(const struct dpif
*dpif
, uint16_t port_no
,
349 struct odp_port
*port
)
351 int error
= dpif
->dpif_class
->port_query_by_number(dpif
, port_no
, port
);
353 VLOG_DBG_RL(&dpmsg_rl
, "%s: port %"PRIu16
" is device %s",
354 dpif_name(dpif
), port_no
, port
->devname
);
356 memset(port
, 0, sizeof *port
);
357 VLOG_WARN_RL(&error_rl
, "%s: failed to query port %"PRIu16
": %s",
358 dpif_name(dpif
), port_no
, strerror(error
));
363 /* Looks up port named 'devname' in 'dpif'. On success, returns 0 and
364 * initializes '*port' appropriately; on failure, returns a positive errno
367 dpif_port_query_by_name(const struct dpif
*dpif
, const char *devname
,
368 struct odp_port
*port
)
370 int error
= dpif
->dpif_class
->port_query_by_name(dpif
, devname
, port
);
372 VLOG_DBG_RL(&dpmsg_rl
, "%s: device %s is on port %"PRIu16
,
373 dpif_name(dpif
), devname
, port
->port
);
375 memset(port
, 0, sizeof *port
);
377 /* Log level is DBG here because all the current callers are interested
378 * in whether 'dpif' actually has a port 'devname', so that it's not an
379 * issue worth logging if it doesn't. */
380 VLOG_DBG_RL(&error_rl
, "%s: failed to query port %s: %s",
381 dpif_name(dpif
), devname
, strerror(error
));
386 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and copies
387 * the port's name into the 'name_size' bytes in 'name', ensuring that the
388 * result is null-terminated. On failure, returns a positive errno value and
389 * makes 'name' the empty string. */
391 dpif_port_get_name(struct dpif
*dpif
, uint16_t port_no
,
392 char *name
, size_t name_size
)
394 struct odp_port port
;
397 assert(name_size
> 0);
399 error
= dpif_port_query_by_number(dpif
, port_no
, &port
);
401 ovs_strlcpy(name
, port
.devname
, name_size
);
408 /* Obtains a list of all the ports in 'dpif'.
410 * If successful, returns 0 and sets '*portsp' to point to an array of
411 * appropriately initialized port structures and '*n_portsp' to the number of
412 * ports in the array. The caller is responsible for freeing '*portp' by
415 * On failure, returns a positive errno value and sets '*portsp' to NULL and
416 * '*n_portsp' to 0. */
418 dpif_port_list(const struct dpif
*dpif
,
419 struct odp_port
**portsp
, size_t *n_portsp
)
421 struct odp_port
*ports
;
426 struct odp_stats stats
;
429 error
= dpif_get_dp_stats(dpif
, &stats
);
434 ports
= xcalloc(stats
.n_ports
, sizeof *ports
);
435 retval
= dpif
->dpif_class
->port_list(dpif
, ports
, stats
.n_ports
);
441 } else if (retval
<= stats
.n_ports
) {
447 /* Soft error: port count increased behind our back. Try again. */
460 log_operation(dpif
, "port_list", error
);
464 /* Polls for changes in the set of ports in 'dpif'. If the set of ports in
465 * 'dpif' has changed, this function does one of the following:
467 * - Stores the name of the device that was added to or deleted from 'dpif' in
468 * '*devnamep' and returns 0. The caller is responsible for freeing
469 * '*devnamep' (with free()) when it no longer needs it.
471 * - Returns ENOBUFS and sets '*devnamep' to NULL.
473 * This function may also return 'false positives', where it returns 0 and
474 * '*devnamep' names a device that was not actually added or deleted or it
475 * returns ENOBUFS without any change.
477 * Returns EAGAIN if the set of ports in 'dpif' has not changed. May also
478 * return other positive errno values to indicate that something has gone
481 dpif_port_poll(const struct dpif
*dpif
, char **devnamep
)
483 int error
= dpif
->dpif_class
->port_poll(dpif
, devnamep
);
490 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
491 * value other than EAGAIN. */
493 dpif_port_poll_wait(const struct dpif
*dpif
)
495 dpif
->dpif_class
->port_poll_wait(dpif
);
498 /* Retrieves a list of the port numbers in port group 'group' in 'dpif'.
500 * On success, returns 0 and points '*ports' to a newly allocated array of
501 * integers, each of which is a 'dpif' port number for a port in
502 * 'group'. Stores the number of elements in the array in '*n_ports'. The
503 * caller is responsible for freeing '*ports' by calling free().
505 * On failure, returns a positive errno value and sets '*ports' to NULL and
506 * '*n_ports' to 0. */
508 dpif_port_group_get(const struct dpif
*dpif
, uint16_t group
,
509 uint16_t **ports
, size_t *n_ports
)
516 int retval
= dpif
->dpif_class
->port_group_get(dpif
, group
,
525 } else if (retval
<= *n_ports
) {
531 /* Soft error: there were more ports than we expected in the
532 * group. Try again. */
534 *ports
= xcalloc(retval
, sizeof **ports
);
538 log_operation(dpif
, "port_group_get", error
);
542 /* Updates port group 'group' in 'dpif', making it contain the 'n_ports' ports
543 * whose 'dpif' port numbers are given in 'n_ports'. Returns 0 if
544 * successful, otherwise a positive errno value.
546 * Behavior is undefined if the values in ports[] are not unique. */
548 dpif_port_group_set(struct dpif
*dpif
, uint16_t group
,
549 const uint16_t ports
[], size_t n_ports
)
553 COVERAGE_INC(dpif_port_group_set
);
555 error
= dpif
->dpif_class
->port_group_set(dpif
, group
, ports
, n_ports
);
556 log_operation(dpif
, "port_group_set", error
);
560 /* Deletes all flows from 'dpif'. Returns 0 if successful, otherwise a
561 * positive errno value. */
563 dpif_flow_flush(struct dpif
*dpif
)
567 COVERAGE_INC(dpif_flow_flush
);
569 error
= dpif
->dpif_class
->flow_flush(dpif
);
570 log_operation(dpif
, "flow_flush", error
);
574 /* Queries 'dpif' for a flow entry matching 'flow->key'.
576 * If a flow matching 'flow->key' exists in 'dpif', stores statistics for the
577 * flow into 'flow->stats'. If 'flow->n_actions' is zero, then 'flow->actions'
578 * is ignored. If 'flow->n_actions' is nonzero, then 'flow->actions' should
579 * point to an array of the specified number of actions. At most that many of
580 * the flow's actions will be copied into that array. 'flow->n_actions' will
581 * be updated to the number of actions actually present in the flow, which may
582 * be greater than the number stored if the flow has more actions than space
583 * available in the array.
585 * If no flow matching 'flow->key' exists in 'dpif', returns ENOENT. On other
586 * failure, returns a positive errno value. */
588 dpif_flow_get(const struct dpif
*dpif
, struct odp_flow
*flow
)
592 COVERAGE_INC(dpif_flow_get
);
594 check_rw_odp_flow(flow
);
595 error
= dpif
->dpif_class
->flow_get(dpif
, flow
, 1);
597 error
= flow
->stats
.error
;
599 if (should_log_flow_message(error
)) {
600 log_flow_operation(dpif
, "flow_get", error
, flow
);
605 /* For each flow 'flow' in the 'n' flows in 'flows':
607 * - If a flow matching 'flow->key' exists in 'dpif':
609 * Stores 0 into 'flow->stats.error' and stores statistics for the flow
610 * into 'flow->stats'.
612 * If 'flow->n_actions' is zero, then 'flow->actions' is ignored. If
613 * 'flow->n_actions' is nonzero, then 'flow->actions' should point to an
614 * array of the specified number of actions. At most that many of the
615 * flow's actions will be copied into that array. 'flow->n_actions' will
616 * be updated to the number of actions actually present in the flow, which
617 * may be greater than the number stored if the flow has more actions than
618 * space available in the array.
620 * - Flow-specific errors are indicated by a positive errno value in
621 * 'flow->stats.error'. In particular, ENOENT indicates that no flow
622 * matching 'flow->key' exists in 'dpif'. When an error value is stored, the
623 * contents of 'flow->key' are preserved but other members of 'flow' should
624 * be treated as indeterminate.
626 * Returns 0 if all 'n' flows in 'flows' were updated (whether they were
627 * individually successful or not is indicated by 'flow->stats.error',
628 * however). Returns a positive errno value if an error that prevented this
629 * update occurred, in which the caller must not depend on any elements in
630 * 'flows' being updated or not updated.
633 dpif_flow_get_multiple(const struct dpif
*dpif
,
634 struct odp_flow flows
[], size_t n
)
639 COVERAGE_ADD(dpif_flow_get
, n
);
641 for (i
= 0; i
< n
; i
++) {
642 check_rw_odp_flow(&flows
[i
]);
645 error
= dpif
->dpif_class
->flow_get(dpif
, flows
, n
);
646 log_operation(dpif
, "flow_get_multiple", error
);
650 /* Adds or modifies a flow in 'dpif' as specified in 'put':
652 * - If the flow specified in 'put->flow' does not exist in 'dpif', then
653 * behavior depends on whether ODPPF_CREATE is specified in 'put->flags': if
654 * it is, the flow will be added, otherwise the operation will fail with
657 * - Otherwise, the flow specified in 'put->flow' does exist in 'dpif'.
658 * Behavior in this case depends on whether ODPPF_MODIFY is specified in
659 * 'put->flags': if it is, the flow's actions will be updated, otherwise the
660 * operation will fail with EEXIST. If the flow's actions are updated, then
661 * its statistics will be zeroed if ODPPF_ZERO_STATS is set in 'put->flags',
662 * left as-is otherwise.
664 * Returns 0 if successful, otherwise a positive errno value.
667 dpif_flow_put(struct dpif
*dpif
, struct odp_flow_put
*put
)
671 COVERAGE_INC(dpif_flow_put
);
673 error
= dpif
->dpif_class
->flow_put(dpif
, put
);
674 if (should_log_flow_message(error
)) {
675 log_flow_put(dpif
, error
, put
);
680 /* Deletes a flow matching 'flow->key' from 'dpif' or returns ENOENT if 'dpif'
681 * does not contain such a flow.
683 * If successful, updates 'flow->stats', 'flow->n_actions', and 'flow->actions'
684 * as described for dpif_flow_get(). */
686 dpif_flow_del(struct dpif
*dpif
, struct odp_flow
*flow
)
690 COVERAGE_INC(dpif_flow_del
);
692 check_rw_odp_flow(flow
);
693 memset(&flow
->stats
, 0, sizeof flow
->stats
);
695 error
= dpif
->dpif_class
->flow_del(dpif
, flow
);
696 if (should_log_flow_message(error
)) {
697 log_flow_operation(dpif
, "delete flow", error
, flow
);
702 /* Stores up to 'n' flows in 'dpif' into 'flows', including their statistics
703 * but not including any information about their actions. If successful,
704 * returns 0 and sets '*n_out' to the number of flows actually present in
705 * 'dpif', which might be greater than the number stored (if 'dpif' has more
706 * than 'n' flows). On failure, returns a negative errno value and sets
709 dpif_flow_list(const struct dpif
*dpif
, struct odp_flow flows
[], size_t n
,
715 COVERAGE_INC(dpif_flow_query_list
);
716 if (RUNNING_ON_VALGRIND
) {
717 memset(flows
, 0, n
* sizeof *flows
);
719 for (i
= 0; i
< n
; i
++) {
720 flows
[i
].actions
= NULL
;
721 flows
[i
].n_actions
= 0;
724 retval
= dpif
->dpif_class
->flow_list(dpif
, flows
, n
);
727 VLOG_WARN_RL(&error_rl
, "%s: flow list failed (%s)",
728 dpif_name(dpif
), strerror(-retval
));
731 COVERAGE_ADD(dpif_flow_query_list_n
, retval
);
732 *n_out
= MIN(n
, retval
);
733 VLOG_DBG_RL(&dpmsg_rl
, "%s: listed %zu flows (of %d)",
734 dpif_name(dpif
), *n_out
, retval
);
739 /* Retrieves all of the flows in 'dpif'.
741 * If successful, returns 0 and stores in '*flowsp' a pointer to a newly
742 * allocated array of flows, including their statistics but not including any
743 * information about their actions, and sets '*np' to the number of flows in
744 * '*flowsp'. The caller is responsible for freeing '*flowsp' by calling
747 * On failure, returns a positive errno value and sets '*flowsp' to NULL and
750 dpif_flow_list_all(const struct dpif
*dpif
,
751 struct odp_flow
**flowsp
, size_t *np
)
753 struct odp_stats stats
;
754 struct odp_flow
*flows
;
761 error
= dpif_get_dp_stats(dpif
, &stats
);
766 flows
= xmalloc(sizeof *flows
* stats
.n_flows
);
767 error
= dpif_flow_list(dpif
, flows
, stats
.n_flows
, &n_flows
);
773 if (stats
.n_flows
!= n_flows
) {
774 VLOG_WARN_RL(&error_rl
, "%s: datapath stats reported %"PRIu32
" "
775 "flows but flow listing reported %zu",
776 dpif_name(dpif
), stats
.n_flows
, n_flows
);
783 /* Causes 'dpif' to perform the 'n_actions' actions in 'actions' on the
784 * Ethernet frame specified in 'packet'.
786 * Pretends that the frame was originally received on the port numbered
787 * 'in_port'. This affects only ODPAT_OUTPUT_GROUP actions, which will not
788 * send a packet out their input port. Specify the number of an unused port
789 * (e.g. UINT16_MAX is currently always unused) to avoid this behavior.
791 * Returns 0 if successful, otherwise a positive errno value. */
793 dpif_execute(struct dpif
*dpif
, uint16_t in_port
,
794 const union odp_action actions
[], size_t n_actions
,
795 const struct ofpbuf
*buf
)
799 COVERAGE_INC(dpif_execute
);
801 error
= dpif
->dpif_class
->execute(dpif
, in_port
, actions
,
807 if (!(error
? VLOG_DROP_WARN(&error_rl
) : VLOG_DROP_DBG(&dpmsg_rl
))) {
808 struct ds ds
= DS_EMPTY_INITIALIZER
;
809 char *packet
= ofp_packet_to_string(buf
->data
, buf
->size
, buf
->size
);
810 ds_put_format(&ds
, "%s: execute ", dpif_name(dpif
));
811 format_odp_actions(&ds
, actions
, n_actions
);
813 ds_put_format(&ds
, " failed (%s)", strerror(error
));
815 ds_put_format(&ds
, " on packet %s", packet
);
816 vlog(THIS_MODULE
, error
? VLL_WARN
: VLL_DBG
, "%s", ds_cstr(&ds
));
823 /* Retrieves 'dpif''s "listen mask" into '*listen_mask'. Each ODPL_* bit set
824 * in '*listen_mask' indicates that dpif_recv() will receive messages of that
825 * type. Returns 0 if successful, otherwise a positive errno value. */
827 dpif_recv_get_mask(const struct dpif
*dpif
, int *listen_mask
)
829 int error
= dpif
->dpif_class
->recv_get_mask(dpif
, listen_mask
);
833 log_operation(dpif
, "recv_get_mask", error
);
837 /* Sets 'dpif''s "listen mask" to 'listen_mask'. Each ODPL_* bit set in
838 * '*listen_mask' requests that dpif_recv() receive messages of that type.
839 * Returns 0 if successful, otherwise a positive errno value. */
841 dpif_recv_set_mask(struct dpif
*dpif
, int listen_mask
)
843 int error
= dpif
->dpif_class
->recv_set_mask(dpif
, listen_mask
);
844 log_operation(dpif
, "recv_set_mask", error
);
848 /* Retrieve the sFlow sampling probability. '*probability' is expressed as the
849 * number of packets out of UINT_MAX to sample, e.g. probability/UINT_MAX is
850 * the probability of sampling a given packet.
852 * Returns 0 if successful, otherwise a positive errno value. EOPNOTSUPP
853 * indicates that 'dpif' does not support sFlow sampling. */
855 dpif_get_sflow_probability(const struct dpif
*dpif
, uint32_t *probability
)
857 int error
= (dpif
->dpif_class
->get_sflow_probability
858 ? dpif
->dpif_class
->get_sflow_probability(dpif
, probability
)
863 log_operation(dpif
, "get_sflow_probability", error
);
867 /* Set the sFlow sampling probability. 'probability' is expressed as the
868 * number of packets out of UINT_MAX to sample, e.g. probability/UINT_MAX is
869 * the probability of sampling a given packet.
871 * Returns 0 if successful, otherwise a positive errno value. EOPNOTSUPP
872 * indicates that 'dpif' does not support sFlow sampling. */
874 dpif_set_sflow_probability(struct dpif
*dpif
, uint32_t probability
)
876 int error
= (dpif
->dpif_class
->set_sflow_probability
877 ? dpif
->dpif_class
->set_sflow_probability(dpif
, probability
)
879 log_operation(dpif
, "set_sflow_probability", error
);
883 /* Attempts to receive a message from 'dpif'. If successful, stores the
884 * message into '*packetp'. The message, if one is received, will begin with
885 * 'struct odp_msg' as a header. Only messages of the types selected with
886 * dpif_set_listen_mask() will ordinarily be received (but if a message type is
887 * enabled and then later disabled, some stragglers might pop up).
889 * Returns 0 if successful, otherwise a positive errno value. Returns EAGAIN
890 * if no message is immediately available. */
892 dpif_recv(struct dpif
*dpif
, struct ofpbuf
**packetp
)
894 int error
= dpif
->dpif_class
->recv(dpif
, packetp
);
896 if (VLOG_IS_DBG_ENABLED()) {
897 struct ofpbuf
*buf
= *packetp
;
898 struct odp_msg
*msg
= buf
->data
;
899 void *payload
= msg
+ 1;
900 size_t payload_len
= buf
->size
- sizeof *msg
;
901 char *s
= ofp_packet_to_string(payload
, payload_len
, payload_len
);
902 VLOG_DBG_RL(&dpmsg_rl
, "%s: received %s message of length "
903 "%zu on port %"PRIu16
": %s", dpif_name(dpif
),
904 (msg
->type
== _ODPL_MISS_NR
? "miss"
905 : msg
->type
== _ODPL_ACTION_NR
? "action"
906 : msg
->type
== _ODPL_SFLOW_NR
? "sFlow"
908 payload_len
, msg
->port
, s
);
917 /* Discards all messages that would otherwise be received by dpif_recv() on
918 * 'dpif'. Returns 0 if successful, otherwise a positive errno value. */
920 dpif_recv_purge(struct dpif
*dpif
)
922 struct odp_stats stats
;
926 COVERAGE_INC(dpif_purge
);
928 error
= dpif_get_dp_stats(dpif
, &stats
);
933 for (i
= 0; i
< stats
.max_miss_queue
+ stats
.max_action_queue
+ stats
.max_sflow_queue
; i
++) {
935 error
= dpif_recv(dpif
, &buf
);
937 return error
== EAGAIN
? 0 : error
;
944 /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be
945 * received with dpif_recv(). */
947 dpif_recv_wait(struct dpif
*dpif
)
949 dpif
->dpif_class
->recv_wait(dpif
);
952 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
953 * and '*engine_id', respectively. */
955 dpif_get_netflow_ids(const struct dpif
*dpif
,
956 uint8_t *engine_type
, uint8_t *engine_id
)
958 *engine_type
= dpif
->netflow_engine_type
;
959 *engine_id
= dpif
->netflow_engine_id
;
963 dpif_init(struct dpif
*dpif
, const struct dpif_class
*dpif_class
,
965 uint8_t netflow_engine_type
, uint8_t netflow_engine_id
)
967 dpif
->dpif_class
= dpif_class
;
968 dpif
->name
= xstrdup(name
);
969 dpif
->netflow_engine_type
= netflow_engine_type
;
970 dpif
->netflow_engine_id
= netflow_engine_id
;
974 log_operation(const struct dpif
*dpif
, const char *operation
, int error
)
977 VLOG_DBG_RL(&dpmsg_rl
, "%s: %s success", dpif_name(dpif
), operation
);
979 VLOG_WARN_RL(&error_rl
, "%s: %s failed (%s)",
980 dpif_name(dpif
), operation
, strerror(error
));
984 static enum vlog_level
985 flow_message_log_level(int error
)
987 return error
? VLL_WARN
: VLL_DBG
;
991 should_log_flow_message(int error
)
993 return !vlog_should_drop(THIS_MODULE
, flow_message_log_level(error
),
994 error
? &error_rl
: &dpmsg_rl
);
998 log_flow_message(const struct dpif
*dpif
, int error
, const char *operation
,
999 const flow_t
*flow
, const struct odp_flow_stats
*stats
,
1000 const union odp_action
*actions
, size_t n_actions
)
1002 struct ds ds
= DS_EMPTY_INITIALIZER
;
1003 ds_put_format(&ds
, "%s: ", dpif_name(dpif
));
1005 ds_put_cstr(&ds
, "failed to ");
1007 ds_put_format(&ds
, "%s ", operation
);
1009 ds_put_format(&ds
, "(%s) ", strerror(error
));
1011 flow_format(&ds
, flow
);
1013 ds_put_cstr(&ds
, ", ");
1014 format_odp_flow_stats(&ds
, stats
);
1016 if (actions
|| n_actions
) {
1017 ds_put_cstr(&ds
, ", actions:");
1018 format_odp_actions(&ds
, actions
, n_actions
);
1020 vlog(THIS_MODULE
, flow_message_log_level(error
), "%s", ds_cstr(&ds
));
1025 log_flow_operation(const struct dpif
*dpif
, const char *operation
, int error
,
1026 struct odp_flow
*flow
)
1029 flow
->n_actions
= 0;
1031 log_flow_message(dpif
, error
, operation
, &flow
->key
,
1032 !error
? &flow
->stats
: NULL
,
1033 flow
->actions
, flow
->n_actions
);
1037 log_flow_put(struct dpif
*dpif
, int error
, const struct odp_flow_put
*put
)
1039 enum { ODPPF_ALL
= ODPPF_CREATE
| ODPPF_MODIFY
| ODPPF_ZERO_STATS
};
1043 ds_put_cstr(&s
, "put");
1044 if (put
->flags
& ODPPF_CREATE
) {
1045 ds_put_cstr(&s
, "[create]");
1047 if (put
->flags
& ODPPF_MODIFY
) {
1048 ds_put_cstr(&s
, "[modify]");
1050 if (put
->flags
& ODPPF_ZERO_STATS
) {
1051 ds_put_cstr(&s
, "[zero]");
1053 if (put
->flags
& ~ODPPF_ALL
) {
1054 ds_put_format(&s
, "[%x]", put
->flags
& ~ODPPF_ALL
);
1056 log_flow_message(dpif
, error
, ds_cstr(&s
), &put
->flow
.key
,
1057 !error
? &put
->flow
.stats
: NULL
,
1058 put
->flow
.actions
, put
->flow
.n_actions
);
1062 /* There is a tendency to construct odp_flow objects on the stack and to
1063 * forget to properly initialize their "actions" and "n_actions" members.
1064 * When this happens, we get memory corruption because the kernel
1065 * writes through the random pointer that is in the "actions" member.
1067 * This function attempts to combat the problem by:
1069 * - Forcing a segfault if "actions" points to an invalid region (instead
1070 * of just getting back EFAULT, which can be easily missed in the log).
1072 * - Storing a distinctive value that is likely to cause an
1073 * easy-to-identify error later if it is dereferenced, etc.
1075 * - Triggering a warning on uninitialized memory from Valgrind if
1076 * "actions" or "n_actions" was not initialized.
1079 check_rw_odp_flow(struct odp_flow
*flow
)
1081 if (flow
->n_actions
) {
1082 memset(&flow
->actions
[0], 0xcc, sizeof flow
->actions
[0]);