route-table: Clear route_notifier after free.
[sliver-openvswitch.git] / lib / dpif-provider.h
index 4d36753..558b891 100644 (file)
@@ -69,14 +69,6 @@ struct dpif_class {
      * the type assumed if no type is specified when opening a dpif. */
     const char *type;
 
-    /* Performs periodic work needed by dpifs of this class, if any is
-     * necessary. */
-    void (*run)(void);
-
-    /* Arranges for poll_block() to wake up if the "run" member function needs
-     * to be called. */
-    void (*wait)(void);
-
     /* Enumerates the names of all known created datapaths, if possible, into
      * 'all_dps'.  The caller has already initialized 'all_dps' and other dpif
      * classes might already have added names to it.
@@ -108,8 +100,15 @@ struct dpif_class {
      * the 'close' member function. */
     int (*destroy)(struct dpif *dpif);
 
+    /* Performs periodic work needed by 'dpif', if any is necessary. */
+    void (*run)(struct dpif *dpif);
+
+    /* Arranges for poll_block() to wake up if the "run" member function needs
+     * to be called for 'dpif'. */
+    void (*wait)(struct dpif *dpif);
+
     /* Retrieves statistics for 'dpif' into 'stats'. */
-    int (*get_stats)(const struct dpif *dpif, struct odp_stats *stats);
+    int (*get_stats)(const struct dpif *dpif, struct ovs_dp_stats *stats);
 
     /* Retrieves 'dpif''s current treatment of IP fragments into '*drop_frags':
      * true indicates that fragments are dropped, false indicates that
@@ -191,7 +190,7 @@ struct dpif_class {
     void (*port_poll_wait)(const struct dpif *dpif);
 
     /* Queries 'dpif' for a flow entry.  The flow is specified by the Netlink
-     * attributes with types ODP_KEY_ATTR_* in the 'key_len' bytes starting at
+     * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
      * 'key'.
      *
      * Returns 0 if successful.  If no flow matches, returns ENOENT.  On other
@@ -209,9 +208,9 @@ struct dpif_class {
                     struct ofpbuf **actionsp, struct dpif_flow_stats *stats);
 
     /* Adds or modifies a flow in 'dpif'.  The flow is specified by the Netlink
-     * attributes with types ODP_KEY_ATTR_* in the 'key_len' bytes starting at
+     * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
      * 'key'.  The associated actions are specified by the Netlink attributes
-     * with types ODP_ACTION_ATTR_* in the 'actions_len' bytes starting at
+     * with types OVS_ACTION_ATTR_* in the 'actions_len' bytes starting at
      * 'actions'.
      *
      * - If the flow's key does not exist in 'dpif', then the flow will be
@@ -236,7 +235,7 @@ struct dpif_class {
 
     /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif'
      * does not contain such a flow.  The flow is specified by the Netlink
-     * attributes with types ODP_KEY_ATTR_* in the 'key_len' bytes starting at
+     * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
      * 'key'.
      *
      * If the operation succeeds, then 'stats', if nonnull, must be set to the
@@ -263,10 +262,10 @@ struct dpif_class {
      * 'flow_dump_done' function will be called afterward).
      *
      * On success, if 'key' and 'key_len' are nonnull then '*key' and
-     * '*key_len' must be set to Netlink attributes with types ODP_KEY_ATTR_*
+     * '*key_len' must be set to Netlink attributes with types OVS_KEY_ATTR_*
      * representing the dumped flow's key.  If 'actions' and 'actions_len' are
      * nonnull then they should be set to Netlink attributes with types
-     * ODP_ACTION_ATTR_* representing the dumped flow's actions.  If 'stats'
+     * OVS_ACTION_ATTR_* representing the dumped flow's actions.  If 'stats'
      * is nonnull then it should be set to the dumped flow's statistics.
      *
      * All of the returned data is owned by 'dpif', not by the caller, and the
@@ -283,9 +282,14 @@ struct dpif_class {
     int (*flow_dump_done)(const struct dpif *dpif, void *state);
 
     /* Performs the 'actions_len' bytes of actions in 'actions' on the Ethernet
-     * frame specified in 'packet'. */
-    int (*execute)(struct dpif *dpif, const struct nlattr *actions,
-                   size_t actions_len, const struct ofpbuf *packet);
+     * frame specified in 'packet' taken from the flow specified in the
+     * 'key_len' bytes of 'key'.  ('key' is mostly redundant with 'packet', but
+     * it contains some metadata that cannot be recovered from 'packet', such
+     * as tun_id and in_port.) */
+    int (*execute)(struct dpif *dpif,
+                   const struct nlattr *key, size_t key_len,
+                   const struct nlattr *actions, size_t actions_len,
+                   const struct ofpbuf *packet);
 
     /* Retrieves 'dpif''s "listen mask" into '*listen_mask'.  A 1-bit of value
      * 2**X set in '*listen_mask' indicates that 'dpif' will receive messages
@@ -299,27 +303,8 @@ struct dpif_class {
      * called. */
     int (*recv_set_mask)(struct dpif *dpif, int listen_mask);
 
-    /* Retrieves 'dpif''s sFlow sampling probability into '*probability'.
-     * Return value is 0 or a positive errno value.  EOPNOTSUPP indicates that
-     * the datapath does not support sFlow, as does a null pointer.
-     *
-     * '*probability' is expressed as the number of packets out of UINT_MAX to
-     * sample, e.g. probability/UINT_MAX is the probability of sampling a given
-     * packet. */
-    int (*get_sflow_probability)(const struct dpif *dpif,
-                                 uint32_t *probability);
-
-    /* Sets 'dpif''s sFlow sampling probability to 'probability'.  Return value
-     * is 0 or a positive errno value.  EOPNOTSUPP indicates that the datapath
-     * does not support sFlow, as does a null pointer.
-     *
-     * 'probability' is expressed as the number of packets out of UINT_MAX to
-     * sample, e.g. probability/UINT_MAX is the probability of sampling a given
-     * packet. */
-    int (*set_sflow_probability)(struct dpif *dpif, uint32_t probability);
-
     /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a
-     * priority value for use in the ODP_ACTION_ATTR_SET_PRIORITY action in
+     * priority value for use in the OVS_ACTION_ATTR_SET_PRIORITY action in
      * '*priority'. */
     int (*queue_to_priority)(const struct dpif *dpif, uint32_t queue_id,
                              uint32_t *priority);