2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 #include "dpif-provider.h"
27 #include "dynamic-string.h"
32 #include "ofp-errors.h"
33 #include "ofp-print.h"
37 #include "poll-loop.h"
45 VLOG_DEFINE_THIS_MODULE(dpif);
47 COVERAGE_DEFINE(dpif_destroy);
48 COVERAGE_DEFINE(dpif_port_add);
49 COVERAGE_DEFINE(dpif_port_del);
50 COVERAGE_DEFINE(dpif_flow_flush);
51 COVERAGE_DEFINE(dpif_flow_get);
52 COVERAGE_DEFINE(dpif_flow_put);
53 COVERAGE_DEFINE(dpif_flow_del);
54 COVERAGE_DEFINE(dpif_flow_query_list);
55 COVERAGE_DEFINE(dpif_flow_query_list_n);
56 COVERAGE_DEFINE(dpif_execute);
57 COVERAGE_DEFINE(dpif_purge);
59 static const struct dpif_class *base_dpif_classes[] = {
66 struct registered_dpif_class {
67 const struct dpif_class *dpif_class;
70 static struct shash dpif_classes = SHASH_INITIALIZER(&dpif_classes);
71 static struct sset dpif_blacklist = SSET_INITIALIZER(&dpif_blacklist);
73 /* 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 nlattr *mask, size_t mask_len,
85 const struct dpif_flow_stats *stats,
86 const struct nlattr *actions, size_t actions_len);
87 static void log_operation(const struct dpif *, const char *operation,
89 static bool should_log_flow_message(int error);
90 static void log_flow_put_message(struct dpif *, const struct dpif_flow_put *,
92 static void log_flow_del_message(struct dpif *, const struct dpif_flow_del *,
94 static void log_execute_message(struct dpif *, const struct dpif_execute *,
100 static int status = -1;
106 for (i = 0; i < ARRAY_SIZE(base_dpif_classes); i++) {
107 dp_register_provider(base_dpif_classes[i]);
112 /* Registers a new datapath provider. After successful registration, new
113 * datapaths of that type can be opened using dpif_open(). */
115 dp_register_provider(const struct dpif_class *new_class)
117 struct registered_dpif_class *registered_class;
119 if (sset_contains(&dpif_blacklist, new_class->type)) {
120 VLOG_DBG("attempted to register blacklisted provider: %s",
125 if (shash_find(&dpif_classes, new_class->type)) {
126 VLOG_WARN("attempted to register duplicate datapath provider: %s",
131 registered_class = xmalloc(sizeof *registered_class);
132 registered_class->dpif_class = new_class;
133 registered_class->refcount = 0;
135 shash_add(&dpif_classes, new_class->type, registered_class);
140 /* Unregisters a datapath provider. 'type' must have been previously
141 * registered and not currently be in use by any dpifs. After unregistration
142 * new datapaths of that type cannot be opened using dpif_open(). */
144 dp_unregister_provider(const char *type)
146 struct shash_node *node;
147 struct registered_dpif_class *registered_class;
149 node = shash_find(&dpif_classes, type);
151 VLOG_WARN("attempted to unregister a datapath provider that is not "
152 "registered: %s", type);
156 registered_class = node->data;
157 if (registered_class->refcount) {
158 VLOG_WARN("attempted to unregister in use datapath provider: %s", type);
162 shash_delete(&dpif_classes, node);
163 free(registered_class);
168 /* Blacklists a provider. Causes future calls of dp_register_provider() with
169 * a dpif_class which implements 'type' to fail. */
171 dp_blacklist_provider(const char *type)
173 sset_add(&dpif_blacklist, type);
176 /* Clears 'types' and enumerates the types of all currently registered datapath
177 * providers into it. The caller must first initialize the sset. */
179 dp_enumerate_types(struct sset *types)
181 struct shash_node *node;
186 SHASH_FOR_EACH(node, &dpif_classes) {
187 const struct registered_dpif_class *registered_class = node->data;
188 sset_add(types, registered_class->dpif_class->type);
192 /* Clears 'names' and enumerates the names of all known created datapaths with
193 * the given 'type'. The caller must first initialize the sset. Returns 0 if
194 * successful, otherwise a positive errno value.
196 * Some kinds of datapaths might not be practically enumerable. This is not
197 * considered an error. */
199 dp_enumerate_names(const char *type, struct sset *names)
201 const struct registered_dpif_class *registered_class;
202 const struct dpif_class *dpif_class;
208 registered_class = shash_find_data(&dpif_classes, type);
209 if (!registered_class) {
210 VLOG_WARN("could not enumerate unknown type: %s", type);
214 dpif_class = registered_class->dpif_class;
215 error = dpif_class->enumerate ? dpif_class->enumerate(names) : 0;
218 VLOG_WARN("failed to enumerate %s datapaths: %s", dpif_class->type,
219 ovs_strerror(error));
225 /* Parses 'datapath_name_', which is of the form [type@]name into its
226 * component pieces. 'name' and 'type' must be freed by the caller.
228 * The returned 'type' is normalized, as if by dpif_normalize_type(). */
230 dp_parse_name(const char *datapath_name_, char **name, char **type)
232 char *datapath_name = xstrdup(datapath_name_);
235 separator = strchr(datapath_name, '@');
238 *type = datapath_name;
239 *name = xstrdup(dpif_normalize_type(separator + 1));
241 *name = datapath_name;
242 *type = xstrdup(dpif_normalize_type(NULL));
247 do_open(const char *name, const char *type, bool create, struct dpif **dpifp)
249 struct dpif *dpif = NULL;
251 struct registered_dpif_class *registered_class;
255 type = dpif_normalize_type(type);
257 registered_class = shash_find_data(&dpif_classes, type);
258 if (!registered_class) {
259 VLOG_WARN("could not create datapath %s of unknown type %s", name,
261 error = EAFNOSUPPORT;
265 error = registered_class->dpif_class->open(registered_class->dpif_class,
266 name, create, &dpif);
268 ovs_assert(dpif->dpif_class == registered_class->dpif_class);
269 registered_class->refcount++;
273 *dpifp = error ? NULL : dpif;
277 /* Tries to open an existing datapath named 'name' and type 'type'. Will fail
278 * if no datapath with 'name' and 'type' exists. 'type' may be either NULL or
279 * the empty string to specify the default system type. Returns 0 if
280 * successful, otherwise a positive errno value. On success stores a pointer
281 * to the datapath in '*dpifp', otherwise a null pointer. */
283 dpif_open(const char *name, const char *type, struct dpif **dpifp)
285 return do_open(name, type, false, dpifp);
288 /* Tries to create and open a new datapath with the given 'name' and 'type'.
289 * 'type' may be either NULL or the empty string to specify the default system
290 * type. Will fail if a datapath with 'name' and 'type' already exists.
291 * Returns 0 if successful, otherwise a positive errno value. On success
292 * stores a pointer to the datapath in '*dpifp', otherwise a null pointer. */
294 dpif_create(const char *name, const char *type, struct dpif **dpifp)
296 return do_open(name, type, true, dpifp);
299 /* Tries to open a datapath with the given 'name' and 'type', creating it if it
300 * does not exist. 'type' may be either NULL or the empty string to specify
301 * the default system type. Returns 0 if successful, otherwise a positive
302 * errno value. On success stores a pointer to the datapath in '*dpifp',
303 * otherwise a null pointer. */
305 dpif_create_and_open(const char *name, const char *type, struct dpif **dpifp)
309 error = dpif_create(name, type, dpifp);
310 if (error == EEXIST || error == EBUSY) {
311 error = dpif_open(name, type, dpifp);
313 VLOG_WARN("datapath %s already exists but cannot be opened: %s",
314 name, ovs_strerror(error));
317 VLOG_WARN("failed to create datapath %s: %s",
318 name, ovs_strerror(error));
323 /* Closes and frees the connection to 'dpif'. Does not destroy the datapath
324 * itself; call dpif_delete() first, instead, if that is desirable. */
326 dpif_close(struct dpif *dpif)
329 struct registered_dpif_class *registered_class;
331 registered_class = shash_find_data(&dpif_classes,
332 dpif->dpif_class->type);
333 ovs_assert(registered_class);
334 ovs_assert(registered_class->refcount);
336 registered_class->refcount--;
337 dpif_uninit(dpif, true);
341 /* Performs periodic work needed by 'dpif'. */
343 dpif_run(struct dpif *dpif)
345 if (dpif->dpif_class->run) {
346 dpif->dpif_class->run(dpif);
350 /* Arranges for poll_block() to wake up when dp_run() needs to be called for
353 dpif_wait(struct dpif *dpif)
355 if (dpif->dpif_class->wait) {
356 dpif->dpif_class->wait(dpif);
360 /* Returns the name of datapath 'dpif' prefixed with the type
361 * (for use in log messages). */
363 dpif_name(const struct dpif *dpif)
365 return dpif->full_name;
368 /* Returns the name of datapath 'dpif' without the type
369 * (for use in device names). */
371 dpif_base_name(const struct dpif *dpif)
373 return dpif->base_name;
376 /* Returns the type of datapath 'dpif'. */
378 dpif_type(const struct dpif *dpif)
380 return dpif->dpif_class->type;
383 /* Returns the fully spelled out name for the given datapath 'type'.
385 * Normalized type string can be compared with strcmp(). Unnormalized type
386 * string might be the same even if they have different spellings. */
388 dpif_normalize_type(const char *type)
390 return type && type[0] ? type : "system";
393 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
394 * ports. After calling this function, it does not make sense to pass 'dpif'
395 * to any functions other than dpif_name() or dpif_close(). */
397 dpif_delete(struct dpif *dpif)
401 COVERAGE_INC(dpif_destroy);
403 error = dpif->dpif_class->destroy(dpif);
404 log_operation(dpif, "delete", error);
408 /* Retrieves statistics for 'dpif' into 'stats'. Returns 0 if successful,
409 * otherwise a positive errno value. */
411 dpif_get_dp_stats(const struct dpif *dpif, struct dpif_dp_stats *stats)
413 int error = dpif->dpif_class->get_stats(dpif, stats);
415 memset(stats, 0, sizeof *stats);
417 log_operation(dpif, "get_stats", error);
422 dpif_port_open_type(const char *datapath_type, const char *port_type)
424 struct registered_dpif_class *registered_class;
426 datapath_type = dpif_normalize_type(datapath_type);
428 registered_class = shash_find_data(&dpif_classes, datapath_type);
429 if (!registered_class
430 || !registered_class->dpif_class->port_open_type) {
434 return registered_class->dpif_class->port_open_type(
435 registered_class->dpif_class, port_type);
438 /* Attempts to add 'netdev' as a port on 'dpif'. If 'port_nop' is
439 * non-null and its value is not ODPP_NONE, then attempts to use the
440 * value as the port number.
442 * If successful, returns 0 and sets '*port_nop' to the new port's port
443 * number (if 'port_nop' is non-null). On failure, returns a positive
444 * errno value and sets '*port_nop' to ODPP_NONE (if 'port_nop' is
447 dpif_port_add(struct dpif *dpif, struct netdev *netdev, odp_port_t *port_nop)
449 const char *netdev_name = netdev_get_name(netdev);
450 odp_port_t port_no = ODPP_NONE;
453 COVERAGE_INC(dpif_port_add);
459 error = dpif->dpif_class->port_add(dpif, netdev, &port_no);
461 VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu32,
462 dpif_name(dpif), netdev_name, port_no);
464 VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s",
465 dpif_name(dpif), netdev_name, ovs_strerror(error));
474 /* Attempts to remove 'dpif''s port number 'port_no'. Returns 0 if successful,
475 * otherwise a positive errno value. */
477 dpif_port_del(struct dpif *dpif, odp_port_t port_no)
481 COVERAGE_INC(dpif_port_del);
483 error = dpif->dpif_class->port_del(dpif, port_no);
485 VLOG_DBG_RL(&dpmsg_rl, "%s: port_del(%"PRIu32")",
486 dpif_name(dpif), port_no);
488 log_operation(dpif, "port_del", error);
493 /* Makes a deep copy of 'src' into 'dst'. */
495 dpif_port_clone(struct dpif_port *dst, const struct dpif_port *src)
497 dst->name = xstrdup(src->name);
498 dst->type = xstrdup(src->type);
499 dst->port_no = src->port_no;
502 /* Frees memory allocated to members of 'dpif_port'.
504 * Do not call this function on a dpif_port obtained from
505 * dpif_port_dump_next(): that function retains ownership of the data in the
508 dpif_port_destroy(struct dpif_port *dpif_port)
510 free(dpif_port->name);
511 free(dpif_port->type);
514 /* Checks if port named 'devname' exists in 'dpif'. If so, returns
515 * true; otherwise, returns false. */
517 dpif_port_exists(const struct dpif *dpif, const char *devname)
519 int error = dpif->dpif_class->port_query_by_name(dpif, devname, NULL);
520 if (error != 0 && error != ENOENT && error != ENODEV) {
521 VLOG_WARN_RL(&error_rl, "%s: failed to query port %s: %s",
522 dpif_name(dpif), devname, ovs_strerror(error));
528 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and
529 * initializes '*port' appropriately; on failure, returns a positive errno
532 * The caller owns the data in 'port' and must free it with
533 * dpif_port_destroy() when it is no longer needed. */
535 dpif_port_query_by_number(const struct dpif *dpif, odp_port_t port_no,
536 struct dpif_port *port)
538 int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port);
540 VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu32" is device %s",
541 dpif_name(dpif), port_no, port->name);
543 memset(port, 0, sizeof *port);
544 VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu32": %s",
545 dpif_name(dpif), port_no, ovs_strerror(error));
550 /* Looks up port named 'devname' in 'dpif'. On success, returns 0 and
551 * initializes '*port' appropriately; on failure, returns a positive errno
554 * The caller owns the data in 'port' and must free it with
555 * dpif_port_destroy() when it is no longer needed. */
557 dpif_port_query_by_name(const struct dpif *dpif, const char *devname,
558 struct dpif_port *port)
560 int error = dpif->dpif_class->port_query_by_name(dpif, devname, port);
562 VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu32,
563 dpif_name(dpif), devname, port->port_no);
565 memset(port, 0, sizeof *port);
567 /* For ENOENT or ENODEV we use DBG level because the caller is probably
568 * interested in whether 'dpif' actually has a port 'devname', so that
569 * it's not an issue worth logging if it doesn't. Other errors are
570 * uncommon and more likely to indicate a real problem. */
572 error == ENOENT || error == ENODEV ? VLL_DBG : VLL_WARN,
573 "%s: failed to query port %s: %s",
574 dpif_name(dpif), devname, ovs_strerror(error));
579 /* Returns one greater than the maximum port number accepted in flow
582 dpif_get_max_ports(const struct dpif *dpif)
584 return dpif->dpif_class->get_max_ports(dpif);
587 /* Returns the Netlink PID value to supply in OVS_ACTION_ATTR_USERSPACE actions
588 * as the OVS_USERSPACE_ATTR_PID attribute's value, for use in flows whose
589 * packets arrived on port 'port_no'.
591 * A 'port_no' of ODPP_NONE is a special case: it returns a reserved PID, not
592 * allocated to any port, that the client may use for special purposes.
594 * The return value is only meaningful when DPIF_UC_ACTION has been enabled in
595 * the 'dpif''s listen mask. It is allowed to change when DPIF_UC_ACTION is
596 * disabled and then re-enabled, so a client that does that must be prepared to
597 * update all of the flows that it installed that contain
598 * OVS_ACTION_ATTR_USERSPACE actions. */
600 dpif_port_get_pid(const struct dpif *dpif, odp_port_t port_no)
602 return (dpif->dpif_class->port_get_pid
603 ? (dpif->dpif_class->port_get_pid)(dpif, port_no)
607 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and copies
608 * the port's name into the 'name_size' bytes in 'name', ensuring that the
609 * result is null-terminated. On failure, returns a positive errno value and
610 * makes 'name' the empty string. */
612 dpif_port_get_name(struct dpif *dpif, odp_port_t port_no,
613 char *name, size_t name_size)
615 struct dpif_port port;
618 ovs_assert(name_size > 0);
620 error = dpif_port_query_by_number(dpif, port_no, &port);
622 ovs_strlcpy(name, port.name, name_size);
623 dpif_port_destroy(&port);
630 /* Initializes 'dump' to begin dumping the ports in a dpif.
632 * This function provides no status indication. An error status for the entire
633 * dump operation is provided when it is completed by calling
634 * dpif_port_dump_done().
637 dpif_port_dump_start(struct dpif_port_dump *dump, const struct dpif *dpif)
640 dump->error = dpif->dpif_class->port_dump_start(dpif, &dump->state);
641 log_operation(dpif, "port_dump_start", dump->error);
644 /* Attempts to retrieve another port from 'dump', which must have been
645 * initialized with dpif_port_dump_start(). On success, stores a new dpif_port
646 * into 'port' and returns true. On failure, returns false.
648 * Failure might indicate an actual error or merely that the last port has been
649 * dumped. An error status for the entire dump operation is provided when it
650 * is completed by calling dpif_port_dump_done().
652 * The dpif owns the data stored in 'port'. It will remain valid until at
653 * least the next time 'dump' is passed to dpif_port_dump_next() or
654 * dpif_port_dump_done(). */
656 dpif_port_dump_next(struct dpif_port_dump *dump, struct dpif_port *port)
658 const struct dpif *dpif = dump->dpif;
664 dump->error = dpif->dpif_class->port_dump_next(dpif, dump->state, port);
665 if (dump->error == EOF) {
666 VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all ports", dpif_name(dpif));
668 log_operation(dpif, "port_dump_next", dump->error);
672 dpif->dpif_class->port_dump_done(dpif, dump->state);
678 /* Completes port table dump operation 'dump', which must have been initialized
679 * with dpif_port_dump_start(). Returns 0 if the dump operation was
680 * error-free, otherwise a positive errno value describing the problem. */
682 dpif_port_dump_done(struct dpif_port_dump *dump)
684 const struct dpif *dpif = dump->dpif;
686 dump->error = dpif->dpif_class->port_dump_done(dpif, dump->state);
687 log_operation(dpif, "port_dump_done", dump->error);
689 return dump->error == EOF ? 0 : dump->error;
692 /* Polls for changes in the set of ports in 'dpif'. If the set of ports in
693 * 'dpif' has changed, this function does one of the following:
695 * - Stores the name of the device that was added to or deleted from 'dpif' in
696 * '*devnamep' and returns 0. The caller is responsible for freeing
697 * '*devnamep' (with free()) when it no longer needs it.
699 * - Returns ENOBUFS and sets '*devnamep' to NULL.
701 * This function may also return 'false positives', where it returns 0 and
702 * '*devnamep' names a device that was not actually added or deleted or it
703 * returns ENOBUFS without any change.
705 * Returns EAGAIN if the set of ports in 'dpif' has not changed. May also
706 * return other positive errno values to indicate that something has gone
709 dpif_port_poll(const struct dpif *dpif, char **devnamep)
711 int error = dpif->dpif_class->port_poll(dpif, devnamep);
718 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
719 * value other than EAGAIN. */
721 dpif_port_poll_wait(const struct dpif *dpif)
723 dpif->dpif_class->port_poll_wait(dpif);
726 /* Extracts the flow stats for a packet. The 'flow' and 'packet'
727 * arguments must have been initialized through a call to flow_extract().
728 * 'used' is stored into stats->used. */
730 dpif_flow_stats_extract(const struct flow *flow, const struct ofpbuf *packet,
731 long long int used, struct dpif_flow_stats *stats)
733 stats->tcp_flags = packet_get_tcp_flags(packet, flow);
734 stats->n_bytes = packet->size;
735 stats->n_packets = 1;
739 /* Appends a human-readable representation of 'stats' to 's'. */
741 dpif_flow_stats_format(const struct dpif_flow_stats *stats, struct ds *s)
743 ds_put_format(s, "packets:%"PRIu64", bytes:%"PRIu64", used:",
744 stats->n_packets, stats->n_bytes);
746 ds_put_format(s, "%.3fs", (time_msec() - stats->used) / 1000.0);
748 ds_put_format(s, "never");
750 if (stats->tcp_flags) {
751 ds_put_cstr(s, ", flags:");
752 packet_format_tcp_flags(s, stats->tcp_flags);
756 /* Deletes all flows from 'dpif'. Returns 0 if successful, otherwise a
757 * positive errno value. */
759 dpif_flow_flush(struct dpif *dpif)
763 COVERAGE_INC(dpif_flow_flush);
765 error = dpif->dpif_class->flow_flush(dpif);
766 log_operation(dpif, "flow_flush", error);
770 /* Queries 'dpif' for a flow entry. The flow is specified by the Netlink
771 * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
774 * Returns 0 if successful. If no flow matches, returns ENOENT. On other
775 * failure, returns a positive errno value.
777 * If 'actionsp' is nonnull, then on success '*actionsp' will be set to an
778 * ofpbuf owned by the caller that contains the Netlink attributes for the
779 * flow's actions. The caller must free the ofpbuf (with ofpbuf_delete()) when
780 * it is no longer needed.
782 * If 'stats' is nonnull, then on success it will be updated with the flow's
785 dpif_flow_get(const struct dpif *dpif,
786 const struct nlattr *key, size_t key_len,
787 struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
791 COVERAGE_INC(dpif_flow_get);
793 error = dpif->dpif_class->flow_get(dpif, key, key_len, actionsp, stats);
799 memset(stats, 0, sizeof *stats);
802 if (should_log_flow_message(error)) {
803 const struct nlattr *actions;
806 if (!error && actionsp) {
807 actions = (*actionsp)->data;
808 actions_len = (*actionsp)->size;
813 log_flow_message(dpif, error, "flow_get", key, key_len,
814 NULL, 0, stats, actions, actions_len);
820 dpif_flow_put__(struct dpif *dpif, const struct dpif_flow_put *put)
824 COVERAGE_INC(dpif_flow_put);
825 ovs_assert(!(put->flags & ~(DPIF_FP_CREATE | DPIF_FP_MODIFY
826 | DPIF_FP_ZERO_STATS)));
828 error = dpif->dpif_class->flow_put(dpif, put);
829 if (error && put->stats) {
830 memset(put->stats, 0, sizeof *put->stats);
832 log_flow_put_message(dpif, put, error);
836 /* Adds or modifies a flow in 'dpif'. The flow is specified by the Netlink
837 * attribute OVS_FLOW_ATTR_KEY with types OVS_KEY_ATTR_* in the 'key_len' bytes
838 * starting at 'key', and OVS_FLOW_ATTR_MASK with types of OVS_KEY_ATTR_* in the
839 * 'mask_len' bytes starting at 'mask'. The associated actions are specified by
840 * the Netlink attributes with types OVS_ACTION_ATTR_* in the 'actions_len'
841 * bytes starting at 'actions'.
843 * - If the flow's key does not exist in 'dpif', then the flow will be added if
844 * 'flags' includes DPIF_FP_CREATE. Otherwise the operation will fail with
847 * If the operation succeeds, then 'stats', if nonnull, will be zeroed.
849 * - If the flow's key does exist in 'dpif', then the flow's actions will be
850 * updated if 'flags' includes DPIF_FP_MODIFY. Otherwise the operation will
851 * fail with EEXIST. If the flow's actions are updated, then its statistics
852 * will be zeroed if 'flags' includes DPIF_FP_ZERO_STATS, and left as-is
855 * If the operation succeeds, then 'stats', if nonnull, will be set to the
856 * flow's statistics before the update.
859 dpif_flow_put(struct dpif *dpif, enum dpif_flow_put_flags flags,
860 const struct nlattr *key, size_t key_len,
861 const struct nlattr *mask, size_t mask_len,
862 const struct nlattr *actions, size_t actions_len,
863 struct dpif_flow_stats *stats)
865 struct dpif_flow_put put;
869 put.key_len = key_len;
871 put.mask_len = mask_len;
872 put.actions = actions;
873 put.actions_len = actions_len;
875 return dpif_flow_put__(dpif, &put);
879 dpif_flow_del__(struct dpif *dpif, struct dpif_flow_del *del)
883 COVERAGE_INC(dpif_flow_del);
885 error = dpif->dpif_class->flow_del(dpif, del);
886 if (error && del->stats) {
887 memset(del->stats, 0, sizeof *del->stats);
889 log_flow_del_message(dpif, del, error);
893 /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif' does
894 * not contain such a flow. The flow is specified by the Netlink attributes
895 * with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at 'key'.
897 * If the operation succeeds, then 'stats', if nonnull, will be set to the
898 * flow's statistics before its deletion. */
900 dpif_flow_del(struct dpif *dpif,
901 const struct nlattr *key, size_t key_len,
902 struct dpif_flow_stats *stats)
904 struct dpif_flow_del del;
907 del.key_len = key_len;
909 return dpif_flow_del__(dpif, &del);
912 /* Initializes 'dump' to begin dumping the flows in a dpif.
914 * This function provides no status indication. An error status for the entire
915 * dump operation is provided when it is completed by calling
916 * dpif_flow_dump_done().
919 dpif_flow_dump_start(struct dpif_flow_dump *dump, const struct dpif *dpif)
922 dump->error = dpif->dpif_class->flow_dump_start(dpif, &dump->state);
923 log_operation(dpif, "flow_dump_start", dump->error);
926 /* Attempts to retrieve another flow from 'dump', which must have been
927 * initialized with dpif_flow_dump_start(). On success, updates the output
928 * parameters as described below and returns true. Otherwise, returns false.
929 * Failure might indicate an actual error or merely the end of the flow table.
930 * An error status for the entire dump operation is provided when it is
931 * completed by calling dpif_flow_dump_done().
933 * On success, if 'key' and 'key_len' are nonnull then '*key' and '*key_len'
934 * will be set to Netlink attributes with types OVS_KEY_ATTR_* representing the
935 * dumped flow's key. If 'actions' and 'actions_len' are nonnull then they are
936 * set to Netlink attributes with types OVS_ACTION_ATTR_* representing the
937 * dumped flow's actions. If 'stats' is nonnull then it will be set to the
938 * dumped flow's statistics.
940 * All of the returned data is owned by 'dpif', not by the caller, and the
941 * caller must not modify or free it. 'dpif' guarantees that it remains
942 * accessible and unchanging until at least the next call to 'flow_dump_next'
943 * or 'flow_dump_done' for 'dump'. */
945 dpif_flow_dump_next(struct dpif_flow_dump *dump,
946 const struct nlattr **key, size_t *key_len,
947 const struct nlattr **mask, size_t *mask_len,
948 const struct nlattr **actions, size_t *actions_len,
949 const struct dpif_flow_stats **stats)
951 const struct dpif *dpif = dump->dpif;
952 int error = dump->error;
955 error = dpif->dpif_class->flow_dump_next(dpif, dump->state,
958 actions, actions_len,
961 dpif->dpif_class->flow_dump_done(dpif, dump->state);
983 VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all flows", dpif_name(dpif));
984 } else if (should_log_flow_message(error)) {
985 log_flow_message(dpif, error, "flow_dump",
986 key ? *key : NULL, key ? *key_len : 0,
987 mask ? *mask : NULL, mask ? *mask_len : 0,
988 stats ? *stats : NULL, actions ? *actions : NULL,
989 actions ? *actions_len : 0);
996 /* Completes flow table dump operation 'dump', which must have been initialized
997 * with dpif_flow_dump_start(). Returns 0 if the dump operation was
998 * error-free, otherwise a positive errno value describing the problem. */
1000 dpif_flow_dump_done(struct dpif_flow_dump *dump)
1002 const struct dpif *dpif = dump->dpif;
1004 dump->error = dpif->dpif_class->flow_dump_done(dpif, dump->state);
1005 log_operation(dpif, "flow_dump_done", dump->error);
1007 return dump->error == EOF ? 0 : dump->error;
1011 dpif_execute__(struct dpif *dpif, const struct dpif_execute *execute)
1015 COVERAGE_INC(dpif_execute);
1016 if (execute->actions_len > 0) {
1017 error = dpif->dpif_class->execute(dpif, execute);
1022 log_execute_message(dpif, execute, error);
1027 /* Causes 'dpif' to perform the 'actions_len' bytes of actions in 'actions' on
1028 * the Ethernet frame specified in 'packet' taken from the flow specified in
1029 * the 'key_len' bytes of 'key'. ('key' is mostly redundant with 'packet', but
1030 * it contains some metadata that cannot be recovered from 'packet', such as
1031 * tunnel and in_port.)
1033 * Returns 0 if successful, otherwise a positive errno value. */
1035 dpif_execute(struct dpif *dpif,
1036 const struct nlattr *key, size_t key_len,
1037 const struct nlattr *actions, size_t actions_len,
1038 const struct ofpbuf *buf)
1040 struct dpif_execute execute;
1043 execute.key_len = key_len;
1044 execute.actions = actions;
1045 execute.actions_len = actions_len;
1046 execute.packet = buf;
1047 return dpif_execute__(dpif, &execute);
1050 /* Executes each of the 'n_ops' operations in 'ops' on 'dpif', in the order in
1051 * which they are specified, placing each operation's results in the "output"
1052 * members documented in comments.
1054 * This function exists because some datapaths can perform batched operations
1055 * faster than individual operations. */
1057 dpif_operate(struct dpif *dpif, struct dpif_op **ops, size_t n_ops)
1061 if (dpif->dpif_class->operate) {
1062 dpif->dpif_class->operate(dpif, ops, n_ops);
1064 for (i = 0; i < n_ops; i++) {
1065 struct dpif_op *op = ops[i];
1068 case DPIF_OP_FLOW_PUT:
1069 log_flow_put_message(dpif, &op->u.flow_put, op->error);
1072 case DPIF_OP_FLOW_DEL:
1073 log_flow_del_message(dpif, &op->u.flow_del, op->error);
1076 case DPIF_OP_EXECUTE:
1077 log_execute_message(dpif, &op->u.execute, op->error);
1084 for (i = 0; i < n_ops; i++) {
1085 struct dpif_op *op = ops[i];
1088 case DPIF_OP_FLOW_PUT:
1089 op->error = dpif_flow_put__(dpif, &op->u.flow_put);
1092 case DPIF_OP_FLOW_DEL:
1093 op->error = dpif_flow_del__(dpif, &op->u.flow_del);
1096 case DPIF_OP_EXECUTE:
1097 op->error = dpif_execute__(dpif, &op->u.execute);
1107 /* Returns a string that represents 'type', for use in log messages. */
1109 dpif_upcall_type_to_string(enum dpif_upcall_type type)
1112 case DPIF_UC_MISS: return "miss";
1113 case DPIF_UC_ACTION: return "action";
1114 case DPIF_N_UC_TYPES: default: return "<unknown>";
1118 /* Enables or disables receiving packets with dpif_recv() on 'dpif'. Returns 0
1119 * if successful, otherwise a positive errno value.
1121 * Turning packet receive off and then back on may change the Netlink PID
1122 * assignments returned by dpif_port_get_pid(). If the client does this, it
1123 * must update all of the flows that have OVS_ACTION_ATTR_USERSPACE actions
1124 * using the new PID assignment. */
1126 dpif_recv_set(struct dpif *dpif, bool enable)
1128 int error = dpif->dpif_class->recv_set(dpif, enable);
1129 log_operation(dpif, "recv_set", error);
1133 /* Polls for an upcall from 'dpif'. If successful, stores the upcall into
1134 * '*upcall', using 'buf' for storage. Should only be called if
1135 * dpif_recv_set() has been used to enable receiving packets on 'dpif'.
1137 * 'upcall->packet' and 'upcall->key' point into data in the caller-provided
1138 * 'buf', so their memory cannot be freed separately from 'buf'. (This is
1139 * hardly a great way to do things but it works out OK for the dpif providers
1140 * and clients that exist so far.)
1142 * Returns 0 if successful, otherwise a positive errno value. Returns EAGAIN
1143 * if no upcall is immediately available. */
1145 dpif_recv(struct dpif *dpif, struct dpif_upcall *upcall, struct ofpbuf *buf)
1147 int error = dpif->dpif_class->recv(dpif, upcall, buf);
1148 if (!error && !VLOG_DROP_DBG(&dpmsg_rl)) {
1152 packet = ofp_packet_to_string(upcall->packet->data,
1153 upcall->packet->size);
1156 odp_flow_key_format(upcall->key, upcall->key_len, &flow);
1158 VLOG_DBG("%s: %s upcall:\n%s\n%s",
1159 dpif_name(dpif), dpif_upcall_type_to_string(upcall->type),
1160 ds_cstr(&flow), packet);
1164 } else if (error && error != EAGAIN) {
1165 log_operation(dpif, "recv", error);
1170 /* Discards all messages that would otherwise be received by dpif_recv() on
1173 dpif_recv_purge(struct dpif *dpif)
1175 COVERAGE_INC(dpif_purge);
1176 if (dpif->dpif_class->recv_purge) {
1177 dpif->dpif_class->recv_purge(dpif);
1181 /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be
1182 * received with dpif_recv(). */
1184 dpif_recv_wait(struct dpif *dpif)
1186 dpif->dpif_class->recv_wait(dpif);
1189 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1190 * and '*engine_id', respectively. */
1192 dpif_get_netflow_ids(const struct dpif *dpif,
1193 uint8_t *engine_type, uint8_t *engine_id)
1195 *engine_type = dpif->netflow_engine_type;
1196 *engine_id = dpif->netflow_engine_id;
1199 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1200 * value used for setting packet priority.
1201 * On success, returns 0 and stores the priority into '*priority'.
1202 * On failure, returns a positive errno value and stores 0 into '*priority'. */
1204 dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id,
1207 int error = (dpif->dpif_class->queue_to_priority
1208 ? dpif->dpif_class->queue_to_priority(dpif, queue_id,
1214 log_operation(dpif, "queue_to_priority", error);
1219 dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class,
1221 uint8_t netflow_engine_type, uint8_t netflow_engine_id)
1223 dpif->dpif_class = dpif_class;
1224 dpif->base_name = xstrdup(name);
1225 dpif->full_name = xasprintf("%s@%s", dpif_class->type, name);
1226 dpif->netflow_engine_type = netflow_engine_type;
1227 dpif->netflow_engine_id = netflow_engine_id;
1230 /* Undoes the results of initialization.
1232 * Normally this function only needs to be called from dpif_close().
1233 * However, it may be called by providers due to an error on opening
1234 * that occurs after initialization. It this case dpif_close() would
1235 * never be called. */
1237 dpif_uninit(struct dpif *dpif, bool close)
1239 char *base_name = dpif->base_name;
1240 char *full_name = dpif->full_name;
1243 dpif->dpif_class->close(dpif);
1251 log_operation(const struct dpif *dpif, const char *operation, int error)
1254 VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation);
1255 } else if (ofperr_is_valid(error)) {
1256 VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1257 dpif_name(dpif), operation, ofperr_get_name(error));
1259 VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1260 dpif_name(dpif), operation, ovs_strerror(error));
1264 static enum vlog_level
1265 flow_message_log_level(int error)
1267 /* If flows arrive in a batch, userspace may push down multiple
1268 * unique flow definitions that overlap when wildcards are applied.
1269 * Kernels that support flow wildcarding will reject these flows as
1270 * duplicates (EEXIST), so lower the log level to debug for these
1271 * types of messages. */
1272 return (error && error != EEXIST) ? VLL_WARN : VLL_DBG;
1276 should_log_flow_message(int error)
1278 return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error),
1279 error ? &error_rl : &dpmsg_rl);
1283 log_flow_message(const struct dpif *dpif, int error, const char *operation,
1284 const struct nlattr *key, size_t key_len,
1285 const struct nlattr *mask, size_t mask_len,
1286 const struct dpif_flow_stats *stats,
1287 const struct nlattr *actions, size_t actions_len)
1289 struct ds ds = DS_EMPTY_INITIALIZER;
1290 ds_put_format(&ds, "%s: ", dpif_name(dpif));
1292 ds_put_cstr(&ds, "failed to ");
1294 ds_put_format(&ds, "%s ", operation);
1296 ds_put_format(&ds, "(%s) ", ovs_strerror(error));
1298 odp_flow_format(key, key_len, mask, mask_len, &ds);
1300 ds_put_cstr(&ds, ", ");
1301 dpif_flow_stats_format(stats, &ds);
1303 if (actions || actions_len) {
1304 ds_put_cstr(&ds, ", actions:");
1305 format_odp_actions(&ds, actions, actions_len);
1307 vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds));
1312 log_flow_put_message(struct dpif *dpif, const struct dpif_flow_put *put,
1315 if (should_log_flow_message(error)) {
1319 ds_put_cstr(&s, "put");
1320 if (put->flags & DPIF_FP_CREATE) {
1321 ds_put_cstr(&s, "[create]");
1323 if (put->flags & DPIF_FP_MODIFY) {
1324 ds_put_cstr(&s, "[modify]");
1326 if (put->flags & DPIF_FP_ZERO_STATS) {
1327 ds_put_cstr(&s, "[zero]");
1329 log_flow_message(dpif, error, ds_cstr(&s),
1330 put->key, put->key_len, put->mask, put->mask_len,
1331 put->stats, put->actions, put->actions_len);
1337 log_flow_del_message(struct dpif *dpif, const struct dpif_flow_del *del,
1340 if (should_log_flow_message(error)) {
1341 log_flow_message(dpif, error, "flow_del", del->key, del->key_len,
1342 NULL, 0, !error ? del->stats : NULL, NULL, 0);
1347 log_execute_message(struct dpif *dpif, const struct dpif_execute *execute,
1350 if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) {
1351 struct ds ds = DS_EMPTY_INITIALIZER;
1354 packet = ofp_packet_to_string(execute->packet->data,
1355 execute->packet->size);
1356 ds_put_format(&ds, "%s: execute ", dpif_name(dpif));
1357 format_odp_actions(&ds, execute->actions, execute->actions_len);
1359 ds_put_format(&ds, " failed (%s)", ovs_strerror(error));
1361 ds_put_format(&ds, " on packet %s", packet);
1362 vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));