datapath: Drop port information from odp_stats.

[sliver-openvswitch.git] / lib / dpif-provider.h

diff --git a/lib/dpif-provider.h b/lib/dpif-provider.h
index bb7b2a8..f6548b3 100644 (file)
--- a/lib/dpif-provider.h
+++ b/lib/dpif-provider.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009, 2010 Nicira Networks.
+ * Copyright (c) 2009, 2010, 2011 Nicira Networks.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -147,17 +147,41 @@ struct dpif_class {
     int (*port_del)(struct dpif *dpif, uint16_t port_no);
 
     /* Queries 'dpif' for a port with the given 'port_no' or 'devname'.  Stores
-     * information about the port into '*port' if successful. */
+     * information about the port into '*port' if successful.
+     *
+     * The caller takes ownership of data in 'port' and must free it with
+     * dpif_port_destroy() when it is no longer needed. */
     int (*port_query_by_number)(const struct dpif *dpif, uint16_t port_no,
-                                struct odp_port *port);
+                                struct dpif_port *port);
     int (*port_query_by_name)(const struct dpif *dpif, const char *devname,
-                              struct odp_port *port);
+                              struct dpif_port *port);
+
+    /* Returns one greater than the largest port number accepted in flow
+     * actions. */
+    int (*get_max_ports)(const struct dpif *dpif);
 
-    /* Stores in 'ports' information about up to 'n' ports attached to 'dpif',
-     * in no particular order.  Returns the number of ports attached to 'dpif'
-     * (not the number stored), if successful, otherwise a negative errno
-     * value. */
-    int (*port_list)(const struct dpif *dpif, struct odp_port *ports, int n);
+    /* Attempts to begin dumping the ports in a dpif.  On success, returns 0
+     * and initializes '*statep' with any data needed for iteration.  On
+     * failure, returns a positive errno value. */
+    int (*port_dump_start)(const struct dpif *dpif, void **statep);
+
+    /* Attempts to retrieve another port from 'dpif' for 'state', which was
+     * initialized by a successful call to the 'port_dump_start' function for
+     * 'dpif'.  On success, stores a new dpif_port into 'port' and returns 0.
+     * Returns EOF if the end of the port table has been reached, or a positive
+     * errno value on error.  This function will not be called again once it
+     * returns nonzero once for a given iteration (but the 'port_dump_done'
+     * function will be called afterward).
+     *
+     * The dpif provider retains ownership of the data stored in 'port'.  It
+     * must remain valid until at least the next call to 'port_dump_next' or
+     * 'port_dump_done' for 'state'. */
+    int (*port_dump_next)(const struct dpif *dpif, void *state,
+                          struct dpif_port *port);
+
+    /* Releases resources from 'dpif' for 'state', which was initialized by a
+     * successful call to the 'port_dump_start' function for 'dpif'.  */
+    int (*port_dump_done)(const struct dpif *dpif, void *state);
 
     /* Polls for changes in the set of ports in 'dpif'.  If the set of ports in
      * 'dpif' has changed, then this function should do one of the
@@ -328,6 +352,10 @@ struct dpif_class {
     /* Arranges for the poll loop to wake up when 'dpif' has a message queued
      * to be received with the recv member function. */
     void (*recv_wait)(struct dpif *dpif);
+
+    /* Throws away any queued upcalls that 'dpif' currently has ready to
+     * return. */
+    void (*recv_purge)(struct dpif *dpif);
 };
 
 extern const struct dpif_class dpif_linux_class;