X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fdpif-provider.h;h=f264e1b85c9a7382a9518eb67021dad453e1c41f;hb=1e3f34c7693bcabae8e443ac1b246680ef9b60e2;hp=c6c39da519d076460b335d60db30cf0dd99dc435;hpb=df2c07f4338faac04f4969f243fe4e8083b309ac;p=sliver-openvswitch.git diff --git a/lib/dpif-provider.h b/lib/dpif-provider.h index c6c39da51..f264e1b85 100644 --- a/lib/dpif-provider.h +++ b/lib/dpif-provider.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009, 2010, 2011 Nicira Networks. + * Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -108,20 +108,14 @@ 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); + int (*get_stats)(const struct dpif *dpif, struct dpif_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); - - /* Adds 'netdev' as a new port in 'dpif'. If successful, sets '*port_no' - * to the new port's port number. */ + /* Adds 'netdev' as a new port in 'dpif'. If '*port_no' is not + * UINT16_MAX, attempts to use that as the port's port number. + * + * If port is successfully added, sets '*port_no' to the new port's + * port number. Returns EBUSY if caller attempted to choose a port + * number, and it was in use. */ int (*port_add)(struct dpif *dpif, struct netdev *netdev, uint16_t *port_no); @@ -142,6 +136,22 @@ 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'. + * + * A 'port_no' of UINT16_MAX should be treated as a special case. The + * implementation should return a reserved PID, not allocated to any port, + * that the client may use for special purposes. + * + * 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,41 +218,37 @@ 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 - * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at - * 'key'. + * attributes with types OVS_KEY_ATTR_* in the 'del->key_len' bytes + * starting at 'del->key'. * - * If the operation succeeds, then 'stats', if nonnull, must be set to the - * flow's statistics before its deletion. */ - int (*flow_del)(struct dpif *dpif, - const struct nlattr *key, size_t key_len, - struct dpif_flow_stats *stats); + * If the operation succeeds, then 'del->stats', if nonnull, must be set to + * the flow's statistics before its deletion. */ + int (*flow_del)(struct dpif *dpif, const struct dpif_flow_del *del); /* Deletes all flows from 'dpif' and clears all of its queues of received * packets. */ @@ -281,69 +287,47 @@ 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); - - /* 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. + /* 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. * - * '*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); + * 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. - * - * The caller takes ownership of the data that 'upcall' points to. - * 'upcall->key' and 'upcall->actions' (if nonnull) point into data owned - * by 'upcall->packet', so their memory cannot be freed separately. (This - * is hardly a great way to do things but it works out OK for the dpif - * providers that exist so far.) + * '*upcall', using 'buf' for storage. Should only be called if 'recv_set' + * has been used to enable receiving packets from 'dpif'. * - * For greatest efficiency, 'upcall->packet' should have at least - * offsetof(struct ofp_packet_in, data) bytes of headroom. + * The implementation should point 'upcall->packet' and 'upcall->key' into + * data in the caller-provided 'buf'. If necessary to make room, the + * implementation may expand the data in 'buf'. (This is hardly a great + * way to do things but it works out OK for the dpif providers that exist + * so far.) * * This function must not block. If no upcall is pending when it is * called, it should return EAGAIN without blocking. */ - int (*recv)(struct dpif *dpif, struct dpif_upcall *upcall); + int (*recv)(struct dpif *dpif, struct dpif_upcall *upcall, + struct ofpbuf *buf); /* Arranges for the poll loop to wake up when 'dpif' has a message queued * to be received with the recv member function. */ @@ -356,6 +340,7 @@ struct dpif_class { extern const struct dpif_class dpif_linux_class; extern const struct dpif_class dpif_netdev_class; +extern const struct dpif_class dpif_planetlab_class; #ifdef __cplusplus }