X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=lib%2Fdpif-provider.h;h=5ef4c991e4dfc736e8fd101964157d8d867aef14;hb=04f68eb209dadedf204e8b7f378e43c76fd02f36;hp=558b8913deb0ebb713fa496b0d3517e66246c3ad;hpb=6ff686f2bc2afcfb0a9ad9793d834979dc9870d6;p=openvswitch diff --git a/lib/dpif-provider.h b/lib/dpif-provider.h index 558b8913..5ef4c991 100644 --- a/lib/dpif-provider.h +++ b/lib/dpif-provider.h @@ -108,17 +108,7 @@ struct dpif_class { void (*wait)(struct dpif *dpif); /* Retrieves statistics for 'dpif' into '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 - * fragments are treated in the same way as other IP packets (except that - * the L4 header cannot be read). */ - int (*get_drop_frags)(const struct dpif *dpif, bool *drop_frags); - - /* Changes 'dpif''s treatment of IP fragments to 'drop_frags', whose - * meaning is the same as for the get_drop_frags member function. */ - int (*set_drop_frags)(struct dpif *dpif, bool drop_frags); + int (*get_stats)(const struct dpif *dpif, struct dpif_dp_stats *stats); /* Adds 'netdev' as a new port in 'dpif'. If successful, sets '*port_no' * to the new port's port number. */ @@ -142,6 +132,18 @@ struct dpif_class { * actions. */ int (*get_max_ports)(const struct dpif *dpif); + /* Returns the Netlink PID value to supply in OVS_ACTION_ATTR_USERSPACE + * actions as the OVS_USERSPACE_ATTR_PID attribute's value, for use in + * flows whose packets arrived on port 'port_no'. + * + * The return value only needs to be meaningful when DPIF_UC_ACTION has + * been enabled in the 'dpif''s listen mask, and it is allowed to change + * when DPIF_UC_ACTION is disabled and then re-enabled. + * + * A dpif provider that doesn't have meaningful Netlink PIDs can use NULL + * for this function. This is equivalent to always returning 0. */ + uint32_t (*port_get_pid)(const struct dpif *dpif, uint16_t port_no); + /* 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. */ @@ -208,30 +210,28 @@ 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 OVS_KEY_ATTR_* in the 'key_len' bytes starting at - * 'key'. The associated actions are specified by the Netlink attributes - * with types OVS_ACTION_ATTR_* in the 'actions_len' bytes starting at - * 'actions'. + * attributes with types OVS_KEY_ATTR_* in the 'put->key_len' bytes + * starting at 'put->key'. The associated actions are specified by the + * Netlink attributes with types OVS_ACTION_ATTR_* in the + * 'put->actions_len' bytes starting at 'put->actions'. * * - If the flow's key does not exist in 'dpif', then the flow will be - * added if 'flags' includes DPIF_FP_CREATE. Otherwise the operation - * will fail with ENOENT. + * added if 'put->flags' includes DPIF_FP_CREATE. Otherwise the + * operation will fail with ENOENT. * - * If the operation succeeds, then 'stats', if nonnull, must be zeroed. + * If the operation succeeds, then 'put->stats', if nonnull, must be + * zeroed. * * - If the flow's key does exist in 'dpif', then the flow's actions will - * be updated if 'flags' includes DPIF_FP_MODIFY. Otherwise the + * be updated if 'put->flags' includes DPIF_FP_MODIFY. Otherwise the * operation will fail with EEXIST. If the flow's actions are updated, - * then its statistics will be zeroed if 'flags' includes + * then its statistics will be zeroed if 'put->flags' includes * DPIF_FP_ZERO_STATS, and left as-is otherwise. * - * If the operation succeeds, then 'stats', if nonnull, must be set to - * the flow's statistics before the update. + * If the operation succeeds, then 'put->stats', if nonnull, must be set + * to the flow's statistics before the update. */ - int (*flow_put)(struct dpif *dpif, enum dpif_flow_put_flags flags, - const struct nlattr *key, size_t key_len, - const struct nlattr *actions, size_t actions_len, - struct dpif_flow_stats *stats); + int (*flow_put)(struct dpif *dpif, const struct dpif_flow_put *put); /* 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 @@ -281,37 +281,36 @@ struct dpif_class { * successful call to the 'flow_dump_start' function for 'dpif'. */ 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' 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 - * of the type (from "enum dpif_upcall_type") with value X when its 'recv' - * function is called. */ - int (*recv_get_mask)(const struct dpif *dpif, int *listen_mask); - - /* Sets 'dpif''s "listen mask" to 'listen_mask'. A 1-bit of value 2**X set - * in '*listen_mask' requests that 'dpif' will receive messages of the type - * (from "enum dpif_upcall_type") with value X when its 'recv' function is - * called. */ - int (*recv_set_mask)(struct dpif *dpif, int listen_mask); + /* Performs the 'execute->actions_len' bytes of actions in + * 'execute->actions' on the Ethernet frame specified in 'execute->packet' + * taken from the flow specified in the 'execute->key_len' bytes of + * 'execute->key'. ('execute->key' is mostly redundant with + * 'execute->packet', but it contains some metadata that cannot be + * recovered from 'execute->packet', such as tun_id and in_port.) */ + int (*execute)(struct dpif *dpif, const struct dpif_execute *execute); + + /* Executes each of the 'n_ops' operations in 'ops' on 'dpif', in the order + * in which they are specified, placing each operation's results in the + * "output" members documented in comments. + * + * This function is optional. It is only worthwhile to implement it if + * 'dpif' can perform operations in batch faster than individually. */ + void (*operate)(struct dpif *dpif, struct dpif_op **ops, size_t n_ops); + + /* Enables or disables receiving packets with dpif_recv() for 'dpif'. + * Turning packet receive off and then back on is allowed to change Netlink + * PID assignments (see ->port_get_pid()). The client is responsible for + * updating flows as necessary if it does this. */ + int (*recv_set)(struct dpif *dpif, bool enable); /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a - * priority value for use in the OVS_ACTION_ATTR_SET_PRIORITY action in - * '*priority'. */ + * priority value used for setting packet priority. */ int (*queue_to_priority)(const struct dpif *dpif, uint32_t queue_id, uint32_t *priority); /* Polls for an upcall from 'dpif'. If successful, stores the upcall into - * '*upcall'. Only upcalls of the types selected with the set_listen_mask - * member function should be received. + * '*upcall'. Should only be called if 'recv_set' has been used to enable + * receiving packets from 'dpif'. * * The caller takes ownership of the data that 'upcall' points to. * 'upcall->key' and 'upcall->actions' (if nonnull) point into data owned