2 * Copyright (c) 2008, 2009, 2010, 2011 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"
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);
72 /* Rate limit for individual messages going to or from the datapath, output at
73 * DBG level. This is very high because, if these are enabled, it is because
74 * we really need to see them. */
75 static struct vlog_rate_limit dpmsg_rl = VLOG_RATE_LIMIT_INIT(600, 600);
77 /* Not really much point in logging many dpif errors. */
78 static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(60, 5);
80 static void log_flow_message(const struct dpif *dpif, int error,
81 const char *operation,
82 const struct nlattr *key, size_t key_len,
83 const struct dpif_flow_stats *stats,
84 const struct nlattr *actions, size_t actions_len);
85 static void log_operation(const struct dpif *, const char *operation,
87 static bool should_log_flow_message(int error);
92 static int status = -1;
98 for (i = 0; i < ARRAY_SIZE(base_dpif_classes); i++) {
99 dp_register_provider(base_dpif_classes[i]);
104 /* Registers a new datapath provider. After successful registration, new
105 * datapaths of that type can be opened using dpif_open(). */
107 dp_register_provider(const struct dpif_class *new_class)
109 struct registered_dpif_class *registered_class;
111 if (shash_find(&dpif_classes, new_class->type)) {
112 VLOG_WARN("attempted to register duplicate datapath provider: %s",
117 registered_class = xmalloc(sizeof *registered_class);
118 registered_class->dpif_class = new_class;
119 registered_class->refcount = 0;
121 shash_add(&dpif_classes, new_class->type, registered_class);
126 /* Unregisters a datapath provider. 'type' must have been previously
127 * registered and not currently be in use by any dpifs. After unregistration
128 * new datapaths of that type cannot be opened using dpif_open(). */
130 dp_unregister_provider(const char *type)
132 struct shash_node *node;
133 struct registered_dpif_class *registered_class;
135 node = shash_find(&dpif_classes, type);
137 VLOG_WARN("attempted to unregister a datapath provider that is not "
138 "registered: %s", type);
142 registered_class = node->data;
143 if (registered_class->refcount) {
144 VLOG_WARN("attempted to unregister in use datapath provider: %s", type);
148 shash_delete(&dpif_classes, node);
149 free(registered_class);
154 /* Clears 'types' and enumerates the types of all currently registered datapath
155 * providers into it. The caller must first initialize the sset. */
157 dp_enumerate_types(struct sset *types)
159 struct shash_node *node;
164 SHASH_FOR_EACH(node, &dpif_classes) {
165 const struct registered_dpif_class *registered_class = node->data;
166 sset_add(types, registered_class->dpif_class->type);
170 /* Clears 'names' and enumerates the names of all known created datapaths with
171 * the given 'type'. The caller must first initialize the sset. Returns 0 if
172 * successful, otherwise a positive errno value.
174 * Some kinds of datapaths might not be practically enumerable. This is not
175 * considered an error. */
177 dp_enumerate_names(const char *type, struct sset *names)
179 const struct registered_dpif_class *registered_class;
180 const struct dpif_class *dpif_class;
186 registered_class = shash_find_data(&dpif_classes, type);
187 if (!registered_class) {
188 VLOG_WARN("could not enumerate unknown type: %s", type);
192 dpif_class = registered_class->dpif_class;
193 error = dpif_class->enumerate ? dpif_class->enumerate(names) : 0;
196 VLOG_WARN("failed to enumerate %s datapaths: %s", dpif_class->type,
203 /* Parses 'datapath_name_', which is of the form [type@]name into its
204 * component pieces. 'name' and 'type' must be freed by the caller.
206 * The returned 'type' is normalized, as if by dpif_normalize_type(). */
208 dp_parse_name(const char *datapath_name_, char **name, char **type)
210 char *datapath_name = xstrdup(datapath_name_);
213 separator = strchr(datapath_name, '@');
216 *type = datapath_name;
217 *name = xstrdup(dpif_normalize_type(separator + 1));
219 *name = datapath_name;
220 *type = xstrdup(dpif_normalize_type(NULL));
225 do_open(const char *name, const char *type, bool create, struct dpif **dpifp)
227 struct dpif *dpif = NULL;
229 struct registered_dpif_class *registered_class;
233 type = dpif_normalize_type(type);
235 registered_class = shash_find_data(&dpif_classes, type);
236 if (!registered_class) {
237 VLOG_WARN("could not create datapath %s of unknown type %s", name,
239 error = EAFNOSUPPORT;
243 error = registered_class->dpif_class->open(registered_class->dpif_class,
244 name, create, &dpif);
246 assert(dpif->dpif_class == registered_class->dpif_class);
247 registered_class->refcount++;
251 *dpifp = error ? NULL : dpif;
255 /* Tries to open an existing datapath named 'name' and type 'type'. Will fail
256 * if no datapath with 'name' and 'type' exists. 'type' may be either NULL or
257 * the empty string to specify the default system type. Returns 0 if
258 * successful, otherwise a positive errno value. On success stores a pointer
259 * to the datapath in '*dpifp', otherwise a null pointer. */
261 dpif_open(const char *name, const char *type, struct dpif **dpifp)
263 return do_open(name, type, false, dpifp);
266 /* Tries to create and open a new datapath with the given 'name' and 'type'.
267 * 'type' may be either NULL or the empty string to specify the default system
268 * type. Will fail if a datapath with 'name' and 'type' already exists.
269 * Returns 0 if successful, otherwise a positive errno value. On success
270 * stores a pointer to the datapath in '*dpifp', otherwise a null pointer. */
272 dpif_create(const char *name, const char *type, struct dpif **dpifp)
274 return do_open(name, type, true, dpifp);
277 /* Tries to open a datapath with the given 'name' and 'type', creating it if it
278 * does not exist. 'type' may be either NULL or the empty string to specify
279 * the default system type. Returns 0 if successful, otherwise a positive
280 * errno value. On success stores a pointer to the datapath in '*dpifp',
281 * otherwise a null pointer. */
283 dpif_create_and_open(const char *name, const char *type, struct dpif **dpifp)
287 error = dpif_create(name, type, dpifp);
288 if (error == EEXIST || error == EBUSY) {
289 error = dpif_open(name, type, dpifp);
291 VLOG_WARN("datapath %s already exists but cannot be opened: %s",
292 name, strerror(error));
295 VLOG_WARN("failed to create datapath %s: %s", name, strerror(error));
300 /* Closes and frees the connection to 'dpif'. Does not destroy the datapath
301 * itself; call dpif_delete() first, instead, if that is desirable. */
303 dpif_close(struct dpif *dpif)
306 struct registered_dpif_class *registered_class;
308 registered_class = shash_find_data(&dpif_classes,
309 dpif->dpif_class->type);
310 assert(registered_class);
311 assert(registered_class->refcount);
313 registered_class->refcount--;
314 dpif_uninit(dpif, true);
318 /* Performs periodic work needed by 'dpif'. */
320 dpif_run(struct dpif *dpif)
322 if (dpif->dpif_class->run) {
323 dpif->dpif_class->run(dpif);
327 /* Arranges for poll_block() to wake up when dp_run() needs to be called for
330 dpif_wait(struct dpif *dpif)
332 if (dpif->dpif_class->wait) {
333 dpif->dpif_class->wait(dpif);
337 /* Returns the name of datapath 'dpif' prefixed with the type
338 * (for use in log messages). */
340 dpif_name(const struct dpif *dpif)
342 return dpif->full_name;
345 /* Returns the name of datapath 'dpif' without the type
346 * (for use in device names). */
348 dpif_base_name(const struct dpif *dpif)
350 return dpif->base_name;
353 /* Returns the fully spelled out name for the given datapath 'type'.
355 * Normalized type string can be compared with strcmp(). Unnormalized type
356 * string might be the same even if they have different spellings. */
358 dpif_normalize_type(const char *type)
360 return type && type[0] ? type : "system";
363 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
364 * ports. After calling this function, it does not make sense to pass 'dpif'
365 * to any functions other than dpif_name() or dpif_close(). */
367 dpif_delete(struct dpif *dpif)
371 COVERAGE_INC(dpif_destroy);
373 error = dpif->dpif_class->destroy(dpif);
374 log_operation(dpif, "delete", error);
378 /* Retrieves statistics for 'dpif' into 'stats'. Returns 0 if successful,
379 * otherwise a positive errno value. */
381 dpif_get_dp_stats(const struct dpif *dpif, struct dpif_dp_stats *stats)
383 int error = dpif->dpif_class->get_stats(dpif, stats);
385 memset(stats, 0, sizeof *stats);
387 log_operation(dpif, "get_stats", error);
391 /* Retrieves the current IP fragment handling policy for 'dpif' into
392 * '*drop_frags': true indicates that fragments are dropped, false indicates
393 * that fragments are treated in the same way as other IP packets (except that
394 * the L4 header cannot be read). Returns 0 if successful, otherwise a
395 * positive errno value. */
397 dpif_get_drop_frags(const struct dpif *dpif, bool *drop_frags)
399 int error = dpif->dpif_class->get_drop_frags(dpif, drop_frags);
403 log_operation(dpif, "get_drop_frags", error);
407 /* Changes 'dpif''s treatment of IP fragments to 'drop_frags', whose meaning is
408 * the same as for the get_drop_frags member function. Returns 0 if
409 * successful, otherwise a positive errno value. */
411 dpif_set_drop_frags(struct dpif *dpif, bool drop_frags)
413 int error = dpif->dpif_class->set_drop_frags(dpif, drop_frags);
414 log_operation(dpif, "set_drop_frags", error);
418 /* Attempts to add 'netdev' as a port on 'dpif'. If successful, returns 0 and
419 * sets '*port_nop' to the new port's port number (if 'port_nop' is non-null).
420 * On failure, returns a positive errno value and sets '*port_nop' to
421 * UINT16_MAX (if 'port_nop' is non-null). */
423 dpif_port_add(struct dpif *dpif, struct netdev *netdev, uint16_t *port_nop)
425 const char *netdev_name = netdev_get_name(netdev);
429 COVERAGE_INC(dpif_port_add);
431 error = dpif->dpif_class->port_add(dpif, netdev, &port_no);
433 VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu16,
434 dpif_name(dpif), netdev_name, port_no);
436 VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s",
437 dpif_name(dpif), netdev_name, strerror(error));
438 port_no = UINT16_MAX;
446 /* Attempts to remove 'dpif''s port number 'port_no'. Returns 0 if successful,
447 * otherwise a positive errno value. */
449 dpif_port_del(struct dpif *dpif, uint16_t port_no)
453 COVERAGE_INC(dpif_port_del);
455 error = dpif->dpif_class->port_del(dpif, port_no);
457 VLOG_DBG_RL(&dpmsg_rl, "%s: port_del(%"PRIu16")",
458 dpif_name(dpif), port_no);
460 log_operation(dpif, "port_del", error);
465 /* Makes a deep copy of 'src' into 'dst'. */
467 dpif_port_clone(struct dpif_port *dst, const struct dpif_port *src)
469 dst->name = xstrdup(src->name);
470 dst->type = xstrdup(src->type);
471 dst->port_no = src->port_no;
474 /* Frees memory allocated to members of 'dpif_port'.
476 * Do not call this function on a dpif_port obtained from
477 * dpif_port_dump_next(): that function retains ownership of the data in the
480 dpif_port_destroy(struct dpif_port *dpif_port)
482 free(dpif_port->name);
483 free(dpif_port->type);
486 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and
487 * initializes '*port' appropriately; on failure, returns a positive errno
490 * The caller owns the data in 'port' and must free it with
491 * dpif_port_destroy() when it is no longer needed. */
493 dpif_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
494 struct dpif_port *port)
496 int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port);
498 VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu16" is device %s",
499 dpif_name(dpif), port_no, port->name);
501 memset(port, 0, sizeof *port);
502 VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu16": %s",
503 dpif_name(dpif), port_no, strerror(error));
508 /* Looks up port named 'devname' in 'dpif'. On success, returns 0 and
509 * initializes '*port' appropriately; on failure, returns a positive errno
512 * The caller owns the data in 'port' and must free it with
513 * dpif_port_destroy() when it is no longer needed. */
515 dpif_port_query_by_name(const struct dpif *dpif, const char *devname,
516 struct dpif_port *port)
518 int error = dpif->dpif_class->port_query_by_name(dpif, devname, port);
520 VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu16,
521 dpif_name(dpif), devname, port->port_no);
523 memset(port, 0, sizeof *port);
525 /* For ENOENT or ENODEV we use DBG level because the caller is probably
526 * interested in whether 'dpif' actually has a port 'devname', so that
527 * it's not an issue worth logging if it doesn't. Other errors are
528 * uncommon and more likely to indicate a real problem. */
530 error == ENOENT || error == ENODEV ? VLL_DBG : VLL_WARN,
531 "%s: failed to query port %s: %s",
532 dpif_name(dpif), devname, strerror(error));
537 /* Returns one greater than the maximum port number accepted in flow
540 dpif_get_max_ports(const struct dpif *dpif)
542 return dpif->dpif_class->get_max_ports(dpif);
545 /* Returns the Netlink PID value to supply in OVS_ACTION_ATTR_USERSPACE actions
546 * as the OVS_USERSPACE_ATTR_PID attribute's value, for use in flows whose
547 * packets arrived on port 'port_no'.
549 * The return value is only meaningful when DPIF_UC_ACTION has been enabled in
550 * the 'dpif''s listen mask. It is allowed to change when DPIF_UC_ACTION is
551 * disabled and then re-enabled, so a client that does that must be prepared to
552 * update all of the flows that it installed that contain
553 * OVS_ACTION_ATTR_USERSPACE actions. */
555 dpif_port_get_pid(const struct dpif *dpif, uint16_t port_no)
557 return (dpif->dpif_class->port_get_pid
558 ? (dpif->dpif_class->port_get_pid)(dpif, port_no)
562 /* Looks up port number 'port_no' in 'dpif'. On success, returns 0 and copies
563 * the port's name into the 'name_size' bytes in 'name', ensuring that the
564 * result is null-terminated. On failure, returns a positive errno value and
565 * makes 'name' the empty string. */
567 dpif_port_get_name(struct dpif *dpif, uint16_t port_no,
568 char *name, size_t name_size)
570 struct dpif_port port;
573 assert(name_size > 0);
575 error = dpif_port_query_by_number(dpif, port_no, &port);
577 ovs_strlcpy(name, port.name, name_size);
578 dpif_port_destroy(&port);
585 /* Initializes 'dump' to begin dumping the ports in a dpif.
587 * This function provides no status indication. An error status for the entire
588 * dump operation is provided when it is completed by calling
589 * dpif_port_dump_done().
592 dpif_port_dump_start(struct dpif_port_dump *dump, const struct dpif *dpif)
595 dump->error = dpif->dpif_class->port_dump_start(dpif, &dump->state);
596 log_operation(dpif, "port_dump_start", dump->error);
599 /* Attempts to retrieve another port from 'dump', which must have been
600 * initialized with dpif_port_dump_start(). On success, stores a new dpif_port
601 * into 'port' and returns true. On failure, returns false.
603 * Failure might indicate an actual error or merely that the last port has been
604 * dumped. An error status for the entire dump operation is provided when it
605 * is completed by calling dpif_port_dump_done().
607 * The dpif owns the data stored in 'port'. It will remain valid until at
608 * least the next time 'dump' is passed to dpif_port_dump_next() or
609 * dpif_port_dump_done(). */
611 dpif_port_dump_next(struct dpif_port_dump *dump, struct dpif_port *port)
613 const struct dpif *dpif = dump->dpif;
619 dump->error = dpif->dpif_class->port_dump_next(dpif, dump->state, port);
620 if (dump->error == EOF) {
621 VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all ports", dpif_name(dpif));
623 log_operation(dpif, "port_dump_next", dump->error);
627 dpif->dpif_class->port_dump_done(dpif, dump->state);
633 /* Completes port table dump operation 'dump', which must have been initialized
634 * with dpif_port_dump_start(). Returns 0 if the dump operation was
635 * error-free, otherwise a positive errno value describing the problem. */
637 dpif_port_dump_done(struct dpif_port_dump *dump)
639 const struct dpif *dpif = dump->dpif;
641 dump->error = dpif->dpif_class->port_dump_done(dpif, dump->state);
642 log_operation(dpif, "port_dump_done", dump->error);
644 return dump->error == EOF ? 0 : dump->error;
647 /* Polls for changes in the set of ports in 'dpif'. If the set of ports in
648 * 'dpif' has changed, this function does one of the following:
650 * - Stores the name of the device that was added to or deleted from 'dpif' in
651 * '*devnamep' and returns 0. The caller is responsible for freeing
652 * '*devnamep' (with free()) when it no longer needs it.
654 * - Returns ENOBUFS and sets '*devnamep' to NULL.
656 * This function may also return 'false positives', where it returns 0 and
657 * '*devnamep' names a device that was not actually added or deleted or it
658 * returns ENOBUFS without any change.
660 * Returns EAGAIN if the set of ports in 'dpif' has not changed. May also
661 * return other positive errno values to indicate that something has gone
664 dpif_port_poll(const struct dpif *dpif, char **devnamep)
666 int error = dpif->dpif_class->port_poll(dpif, devnamep);
673 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
674 * value other than EAGAIN. */
676 dpif_port_poll_wait(const struct dpif *dpif)
678 dpif->dpif_class->port_poll_wait(dpif);
681 /* Extracts the flow stats for a packet. The 'flow' and 'packet'
682 * arguments must have been initialized through a call to flow_extract().
685 dpif_flow_stats_extract(const struct flow *flow, struct ofpbuf *packet,
686 struct dpif_flow_stats *stats)
688 memset(stats, 0, sizeof(*stats));
690 if ((flow->dl_type == htons(ETH_TYPE_IP)) && packet->l4) {
691 if ((flow->nw_proto == IPPROTO_TCP) && packet->l7) {
692 struct tcp_header *tcp = packet->l4;
693 stats->tcp_flags = TCP_FLAGS(tcp->tcp_ctl);
697 stats->n_bytes = packet->size;
698 stats->n_packets = 1;
701 /* Appends a human-readable representation of 'stats' to 's'. */
703 dpif_flow_stats_format(const struct dpif_flow_stats *stats, struct ds *s)
705 ds_put_format(s, "packets:%"PRIu64", bytes:%"PRIu64", used:",
706 stats->n_packets, stats->n_bytes);
708 ds_put_format(s, "%.3fs", (time_msec() - stats->used) / 1000.0);
710 ds_put_format(s, "never");
715 /* Deletes all flows from 'dpif'. Returns 0 if successful, otherwise a
716 * positive errno value. */
718 dpif_flow_flush(struct dpif *dpif)
722 COVERAGE_INC(dpif_flow_flush);
724 error = dpif->dpif_class->flow_flush(dpif);
725 log_operation(dpif, "flow_flush", error);
729 /* Queries 'dpif' for a flow entry. The flow is specified by the Netlink
730 * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
733 * Returns 0 if successful. If no flow matches, returns ENOENT. On other
734 * failure, returns a positive errno value.
736 * If 'actionsp' is nonnull, then on success '*actionsp' will be set to an
737 * ofpbuf owned by the caller that contains the Netlink attributes for the
738 * flow's actions. The caller must free the ofpbuf (with ofpbuf_delete()) when
739 * it is no longer needed.
741 * If 'stats' is nonnull, then on success it will be updated with the flow's
744 dpif_flow_get(const struct dpif *dpif,
745 const struct nlattr *key, size_t key_len,
746 struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
750 COVERAGE_INC(dpif_flow_get);
752 error = dpif->dpif_class->flow_get(dpif, key, key_len, actionsp, stats);
758 memset(stats, 0, sizeof *stats);
761 if (should_log_flow_message(error)) {
762 const struct nlattr *actions;
765 if (!error && actionsp) {
766 actions = (*actionsp)->data;
767 actions_len = (*actionsp)->size;
772 log_flow_message(dpif, error, "flow_get", key, key_len, stats,
773 actions, actions_len);
778 /* Adds or modifies a flow in 'dpif'. The flow is specified by the Netlink
779 * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
780 * 'key'. The associated actions are specified by the Netlink attributes with
781 * types OVS_ACTION_ATTR_* in the 'actions_len' bytes starting at 'actions'.
783 * - If the flow's key does not exist in 'dpif', then the flow will be added if
784 * 'flags' includes DPIF_FP_CREATE. Otherwise the operation will fail with
787 * If the operation succeeds, then 'stats', if nonnull, will be zeroed.
789 * - If the flow's key does exist in 'dpif', then the flow's actions will be
790 * updated if 'flags' includes DPIF_FP_MODIFY. Otherwise the operation will
791 * fail with EEXIST. If the flow's actions are updated, then its statistics
792 * will be zeroed if 'flags' includes DPIF_FP_ZERO_STATS, and left as-is
795 * If the operation succeeds, then 'stats', if nonnull, will be set to the
796 * flow's statistics before the update.
799 dpif_flow_put(struct dpif *dpif, enum dpif_flow_put_flags flags,
800 const struct nlattr *key, size_t key_len,
801 const struct nlattr *actions, size_t actions_len,
802 struct dpif_flow_stats *stats)
806 COVERAGE_INC(dpif_flow_put);
807 assert(!(flags & ~(DPIF_FP_CREATE | DPIF_FP_MODIFY | DPIF_FP_ZERO_STATS)));
809 error = dpif->dpif_class->flow_put(dpif, flags, key, key_len,
810 actions, actions_len, stats);
811 if (error && stats) {
812 memset(stats, 0, sizeof *stats);
814 if (should_log_flow_message(error)) {
818 ds_put_cstr(&s, "put");
819 if (flags & DPIF_FP_CREATE) {
820 ds_put_cstr(&s, "[create]");
822 if (flags & DPIF_FP_MODIFY) {
823 ds_put_cstr(&s, "[modify]");
825 if (flags & DPIF_FP_ZERO_STATS) {
826 ds_put_cstr(&s, "[zero]");
828 log_flow_message(dpif, error, ds_cstr(&s), key, key_len, stats,
829 actions, actions_len);
835 /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif' does
836 * not contain such a flow. The flow is specified by the Netlink attributes
837 * with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at 'key'.
839 * If the operation succeeds, then 'stats', if nonnull, will be set to the
840 * flow's statistics before its deletion. */
842 dpif_flow_del(struct dpif *dpif,
843 const struct nlattr *key, size_t key_len,
844 struct dpif_flow_stats *stats)
848 COVERAGE_INC(dpif_flow_del);
850 error = dpif->dpif_class->flow_del(dpif, key, key_len, stats);
851 if (error && stats) {
852 memset(stats, 0, sizeof *stats);
854 if (should_log_flow_message(error)) {
855 log_flow_message(dpif, error, "flow_del", key, key_len,
856 !error ? stats : NULL, NULL, 0);
861 /* Initializes 'dump' to begin dumping the flows in a dpif.
863 * This function provides no status indication. An error status for the entire
864 * dump operation is provided when it is completed by calling
865 * dpif_flow_dump_done().
868 dpif_flow_dump_start(struct dpif_flow_dump *dump, const struct dpif *dpif)
871 dump->error = dpif->dpif_class->flow_dump_start(dpif, &dump->state);
872 log_operation(dpif, "flow_dump_start", dump->error);
875 /* Attempts to retrieve another flow from 'dump', which must have been
876 * initialized with dpif_flow_dump_start(). On success, updates the output
877 * parameters as described below and returns true. Otherwise, returns false.
878 * Failure might indicate an actual error or merely the end of the flow table.
879 * An error status for the entire dump operation is provided when it is
880 * completed by calling dpif_flow_dump_done().
882 * On success, if 'key' and 'key_len' are nonnull then '*key' and '*key_len'
883 * will be set to Netlink attributes with types OVS_KEY_ATTR_* representing the
884 * dumped flow's key. If 'actions' and 'actions_len' are nonnull then they are
885 * set to Netlink attributes with types OVS_ACTION_ATTR_* representing the
886 * dumped flow's actions. If 'stats' is nonnull then it will be set to the
887 * dumped flow's statistics.
889 * All of the returned data is owned by 'dpif', not by the caller, and the
890 * caller must not modify or free it. 'dpif' guarantees that it remains
891 * accessible and unchanging until at least the next call to 'flow_dump_next'
892 * or 'flow_dump_done' for 'dump'. */
894 dpif_flow_dump_next(struct dpif_flow_dump *dump,
895 const struct nlattr **key, size_t *key_len,
896 const struct nlattr **actions, size_t *actions_len,
897 const struct dpif_flow_stats **stats)
899 const struct dpif *dpif = dump->dpif;
900 int error = dump->error;
903 error = dpif->dpif_class->flow_dump_next(dpif, dump->state,
905 actions, actions_len,
908 dpif->dpif_class->flow_dump_done(dpif, dump->state);
926 VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all flows", dpif_name(dpif));
927 } else if (should_log_flow_message(error)) {
928 log_flow_message(dpif, error, "flow_dump",
929 key ? *key : NULL, key ? *key_len : 0,
930 stats ? *stats : NULL, actions ? *actions : NULL,
931 actions ? *actions_len : 0);
938 /* Completes flow table dump operation 'dump', which must have been initialized
939 * with dpif_flow_dump_start(). Returns 0 if the dump operation was
940 * error-free, otherwise a positive errno value describing the problem. */
942 dpif_flow_dump_done(struct dpif_flow_dump *dump)
944 const struct dpif *dpif = dump->dpif;
946 dump->error = dpif->dpif_class->flow_dump_done(dpif, dump->state);
947 log_operation(dpif, "flow_dump_done", dump->error);
949 return dump->error == EOF ? 0 : dump->error;
952 /* Causes 'dpif' to perform the 'actions_len' bytes of actions in 'actions' on
953 * the Ethernet frame specified in 'packet' taken from the flow specified in
954 * the 'key_len' bytes of 'key'. ('key' is mostly redundant with 'packet', but
955 * it contains some metadata that cannot be recovered from 'packet', such as
956 * tun_id and in_port.)
958 * Returns 0 if successful, otherwise a positive errno value. */
960 dpif_execute(struct dpif *dpif,
961 const struct nlattr *key, size_t key_len,
962 const struct nlattr *actions, size_t actions_len,
963 const struct ofpbuf *buf)
967 COVERAGE_INC(dpif_execute);
968 if (actions_len > 0) {
969 error = dpif->dpif_class->execute(dpif, key, key_len,
970 actions, actions_len, buf);
975 if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) {
976 struct ds ds = DS_EMPTY_INITIALIZER;
977 char *packet = ofp_packet_to_string(buf->data, buf->size, buf->size);
978 ds_put_format(&ds, "%s: execute ", dpif_name(dpif));
979 format_odp_actions(&ds, actions, actions_len);
981 ds_put_format(&ds, " failed (%s)", strerror(error));
983 ds_put_format(&ds, " on packet %s", packet);
984 vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));
991 /* Executes each of the 'n_ops' operations in 'ops' on 'dpif', in the order in
992 * which they are specified, placing each operation's results in the "output"
993 * members documented in comments.
995 * This function exists because some datapaths can perform batched operations
996 * faster than individual operations. */
998 dpif_operate(struct dpif *dpif, union dpif_op **ops, size_t n_ops)
1002 if (dpif->dpif_class->operate) {
1003 dpif->dpif_class->operate(dpif, ops, n_ops);
1007 for (i = 0; i < n_ops; i++) {
1008 union dpif_op *op = ops[i];
1009 struct dpif_flow_put *put;
1010 struct dpif_execute *execute;
1013 case DPIF_OP_FLOW_PUT:
1014 put = &op->flow_put;
1015 put->error = dpif_flow_put(dpif, put->flags,
1016 put->key, put->key_len,
1017 put->actions, put->actions_len,
1021 case DPIF_OP_EXECUTE:
1022 execute = &op->execute;
1023 execute->error = dpif_execute(dpif, execute->key, execute->key_len,
1025 execute->actions_len,
1036 /* Returns a string that represents 'type', for use in log messages. */
1038 dpif_upcall_type_to_string(enum dpif_upcall_type type)
1041 case DPIF_UC_MISS: return "miss";
1042 case DPIF_UC_ACTION: return "action";
1043 case DPIF_N_UC_TYPES: default: return "<unknown>";
1047 static bool OVS_UNUSED
1048 is_valid_listen_mask(int listen_mask)
1050 return !(listen_mask & ~((1u << DPIF_UC_MISS) |
1051 (1u << DPIF_UC_ACTION)));
1054 /* Retrieves 'dpif''s "listen mask" into '*listen_mask'. A 1-bit of value 2**X
1055 * set in '*listen_mask' indicates that dpif_recv() will receive messages of
1056 * the type (from "enum dpif_upcall_type") with value X. Returns 0 if
1057 * successful, otherwise a positive errno value. */
1059 dpif_recv_get_mask(const struct dpif *dpif, int *listen_mask)
1061 int error = dpif->dpif_class->recv_get_mask(dpif, listen_mask);
1065 assert(is_valid_listen_mask(*listen_mask));
1066 log_operation(dpif, "recv_get_mask", error);
1070 /* Sets 'dpif''s "listen mask" to 'listen_mask'. A 1-bit of value 2**X set in
1071 * '*listen_mask' requests that dpif_recv() will receive messages of the type
1072 * (from "enum dpif_upcall_type") with value X. Returns 0 if successful,
1073 * otherwise a positive errno value.
1075 * Turning DPIF_UC_ACTION off and then back on may change the Netlink PID
1076 * assignments returned by dpif_port_get_pid(). If the client does this, it
1077 * must update all of the flows that have OVS_ACTION_ATTR_USERSPACE actions
1078 * using the new PID assignment. */
1080 dpif_recv_set_mask(struct dpif *dpif, int listen_mask)
1084 assert(is_valid_listen_mask(listen_mask));
1086 error = dpif->dpif_class->recv_set_mask(dpif, listen_mask);
1087 log_operation(dpif, "recv_set_mask", error);
1091 /* Polls for an upcall from 'dpif'. If successful, stores the upcall into
1092 * '*upcall'. Only upcalls of the types selected with dpif_recv_set_mask()
1093 * member function will ordinarily be received (but if a message type is
1094 * enabled and then later disabled, some stragglers might pop up).
1096 * The caller takes ownership of the data that 'upcall' points to.
1097 * 'upcall->key' and 'upcall->actions' (if nonnull) point into data owned by
1098 * 'upcall->packet', so their memory cannot be freed separately. (This is
1099 * hardly a great way to do things but it works out OK for the dpif providers
1100 * and clients that exist so far.)
1102 * Returns 0 if successful, otherwise a positive errno value. Returns EAGAIN
1103 * if no upcall is immediately available. */
1105 dpif_recv(struct dpif *dpif, struct dpif_upcall *upcall)
1107 int error = dpif->dpif_class->recv(dpif, upcall);
1108 if (!error && !VLOG_DROP_DBG(&dpmsg_rl)) {
1112 packet = ofp_packet_to_string(upcall->packet->data,
1113 upcall->packet->size,
1114 upcall->packet->size);
1117 odp_flow_key_format(upcall->key, upcall->key_len, &flow);
1119 VLOG_DBG("%s: %s upcall:\n%s\n%s",
1120 dpif_name(dpif), dpif_upcall_type_to_string(upcall->type),
1121 ds_cstr(&flow), packet);
1129 /* Discards all messages that would otherwise be received by dpif_recv() on
1132 dpif_recv_purge(struct dpif *dpif)
1134 COVERAGE_INC(dpif_purge);
1135 if (dpif->dpif_class->recv_purge) {
1136 dpif->dpif_class->recv_purge(dpif);
1140 /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be
1141 * received with dpif_recv(). */
1143 dpif_recv_wait(struct dpif *dpif)
1145 dpif->dpif_class->recv_wait(dpif);
1148 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1149 * and '*engine_id', respectively. */
1151 dpif_get_netflow_ids(const struct dpif *dpif,
1152 uint8_t *engine_type, uint8_t *engine_id)
1154 *engine_type = dpif->netflow_engine_type;
1155 *engine_id = dpif->netflow_engine_id;
1158 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1159 * value for use in the OVS_ACTION_ATTR_SET_PRIORITY action. On success,
1160 * returns 0 and stores the priority into '*priority'. On failure, returns a
1161 * positive errno value and stores 0 into '*priority'. */
1163 dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id,
1166 int error = (dpif->dpif_class->queue_to_priority
1167 ? dpif->dpif_class->queue_to_priority(dpif, queue_id,
1173 log_operation(dpif, "queue_to_priority", error);
1178 dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class,
1180 uint8_t netflow_engine_type, uint8_t netflow_engine_id)
1182 dpif->dpif_class = dpif_class;
1183 dpif->base_name = xstrdup(name);
1184 dpif->full_name = xasprintf("%s@%s", dpif_class->type, name);
1185 dpif->netflow_engine_type = netflow_engine_type;
1186 dpif->netflow_engine_id = netflow_engine_id;
1189 /* Undoes the results of initialization.
1191 * Normally this function only needs to be called from dpif_close().
1192 * However, it may be called by providers due to an error on opening
1193 * that occurs after initialization. It this case dpif_close() would
1194 * never be called. */
1196 dpif_uninit(struct dpif *dpif, bool close)
1198 char *base_name = dpif->base_name;
1199 char *full_name = dpif->full_name;
1202 dpif->dpif_class->close(dpif);
1210 log_operation(const struct dpif *dpif, const char *operation, int error)
1213 VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation);
1214 } else if (is_errno(error)) {
1215 VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1216 dpif_name(dpif), operation, strerror(error));
1218 VLOG_WARN_RL(&error_rl, "%s: %s failed (%d/%d)",
1219 dpif_name(dpif), operation,
1220 get_ofp_err_type(error), get_ofp_err_code(error));
1224 static enum vlog_level
1225 flow_message_log_level(int error)
1227 return error ? VLL_WARN : VLL_DBG;
1231 should_log_flow_message(int error)
1233 return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error),
1234 error ? &error_rl : &dpmsg_rl);
1238 log_flow_message(const struct dpif *dpif, int error, const char *operation,
1239 const struct nlattr *key, size_t key_len,
1240 const struct dpif_flow_stats *stats,
1241 const struct nlattr *actions, size_t actions_len)
1243 struct ds ds = DS_EMPTY_INITIALIZER;
1244 ds_put_format(&ds, "%s: ", dpif_name(dpif));
1246 ds_put_cstr(&ds, "failed to ");
1248 ds_put_format(&ds, "%s ", operation);
1250 ds_put_format(&ds, "(%s) ", strerror(error));
1252 odp_flow_key_format(key, key_len, &ds);
1254 ds_put_cstr(&ds, ", ");
1255 dpif_flow_stats_format(stats, &ds);
1257 if (actions || actions_len) {
1258 ds_put_cstr(&ds, ", actions:");
1259 format_odp_actions(&ds, actions, actions_len);
1261 vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds));