X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=lib%2Fdpif-provider.h;h=26cd6b099cf49c9b5f8de727f64ebe5dce9e4688;hb=8961de6adfd44216f47007ff75fd1cea213d7e31;hp=9a495443bf463b504da5c97f38ad8aa07bc328bd;hpb=1a6f1e2a6d6aea97f97fc378ec29f7d04ad8c047;p=openvswitch diff --git a/lib/dpif-provider.h b/lib/dpif-provider.h index 9a495443..26cd6b09 100644 --- a/lib/dpif-provider.h +++ b/lib/dpif-provider.h @@ -18,16 +18,24 @@ #define DPIF_PROVIDER_H 1 /* Provider interface to dpifs, which provide an interface to an Open vSwitch - * datapath. */ + * datapath. A datapath is a collection of physical or virtual ports that are + * exposed over OpenFlow as a single switch. Datapaths and the collections of + * ports that they contain may be fixed or dynamic. */ #include +#include "openflow/openflow.h" #include "dpif.h" +#include "util.h" + +#ifdef __cplusplus +extern "C" { +#endif /* Open vSwitch datapath interface. * * This structure should be treated as opaque by dpif implementations. */ struct dpif { - const struct dpif_class *class; + const struct dpif_class *dpif_class; char *base_name; char *full_name; uint8_t netflow_engine_type; @@ -36,10 +44,12 @@ struct dpif { void dpif_init(struct dpif *, const struct dpif_class *, const char *name, uint8_t netflow_engine_type, uint8_t netflow_engine_id); +void dpif_uninit(struct dpif *dpif, bool close); + static inline void dpif_assert_class(const struct dpif *dpif, - const struct dpif_class *class) + const struct dpif_class *dpif_class) { - assert(dpif->class == class); + assert(dpif->dpif_class == dpif_class); } /* Datapath interface class structure, to be defined by each implementation of @@ -80,13 +90,14 @@ struct dpif_class { /* Attempts to open an existing dpif called 'name', if 'create' is false, * or to open an existing dpif or create a new one, if 'create' is true. - * 'type' corresponds to the 'type' field used in the dpif_class - * structure. * - * If successful, stores a pointer to the new dpif in '*dpifp'. On failure - * there are no requirements on what is stored in '*dpifp'. */ - int (*open)(const char *name, const char *type, bool create, - struct dpif **dpifp); + * 'dpif_class' is the class of dpif to open. + * + * If successful, stores a pointer to the new dpif in '*dpifp', which must + * have class 'dpif_class'. On failure there are no requirements on what + * is stored in '*dpifp'. */ + int (*open)(const struct dpif_class *dpif_class, + const char *name, bool create, struct dpif **dpifp); /* Closes 'dpif' and frees associated memory. */ void (*close)(struct dpif *dpif); @@ -112,7 +123,7 @@ struct dpif_class { * * If successful, 'dpif' will not be used again except as an argument for * the 'close' member function. */ - int (*delete)(struct dpif *dpif); + int (*destroy)(struct dpif *dpif); /* Retrieves statistics for 'dpif' into 'stats'. */ int (*get_stats)(const struct dpif *dpif, struct odp_stats *stats); @@ -127,10 +138,9 @@ struct dpif_class { * meaning is the same as for the get_drop_frags member function. */ int (*set_drop_frags)(struct dpif *dpif, bool drop_frags); - /* Creates a new port in 'dpif' connected to network device 'devname'. - * 'flags' is a set of ODP_PORT_* flags. If successful, sets '*port_no' + /* Adds 'netdev' as a new port in 'dpif'. If successful, sets '*port_no' * to the new port's port number. */ - int (*port_add)(struct dpif *dpif, const char *devname, uint16_t flags, + int (*port_add)(struct dpif *dpif, struct netdev *netdev, uint16_t *port_no); /* Removes port numbered 'port_no' from 'dpif'. */ @@ -173,20 +183,6 @@ struct dpif_class { * value other than EAGAIN. */ void (*port_poll_wait)(const struct dpif *dpif); - /* Stores in 'ports' the port numbers of up to 'n' ports that belong to - * 'group' in 'dpif'. Returns the number of ports in 'group' (not the - * number stored), if successful, otherwise a negative errno value. */ - int (*port_group_get)(const struct dpif *dpif, int group, - uint16_t ports[], int n); - - /* Changes port group 'group' in 'dpif' to consist of the 'n' ports whose - * numbers are given in 'ports'. - * - * Use the get_stats member function to obtain the number of supported port - * groups. */ - int (*port_group_set)(struct dpif *dpif, int group, - const uint16_t ports[], int n); - /* For each flow 'flow' in the 'n' flows in 'flows': * * - If a flow matching 'flow->key' exists in 'dpif': @@ -252,14 +248,8 @@ struct dpif_class { int (*flow_list)(const struct dpif *dpif, struct odp_flow flows[], int n); /* Performs the 'n_actions' actions in 'actions' on the Ethernet frame - * specified in 'packet'. - * - * Pretends that the frame was originally received on the port numbered - * 'in_port'. This affects only ODPAT_OUTPUT_GROUP actions, which will not - * send a packet out their input port. Specify the number of an unused - * port (e.g. UINT16_MAX is currently always unused) to avoid this - * behavior. */ - int (*execute)(struct dpif *dpif, uint16_t in_port, + * specified in 'packet'. */ + int (*execute)(struct dpif *dpif, const union odp_action actions[], int n_actions, const struct ofpbuf *packet); @@ -273,10 +263,37 @@ struct dpif_class { * corresponding type when it calls the recv member function. */ 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 ODPAT_SET_PRIORITY action in + * '*priority'. */ + int (*queue_to_priority)(const struct dpif *dpif, uint32_t queue_id, + uint32_t *priority); + /* Attempts to receive a message from 'dpif'. If successful, stores the * message into '*packetp'. The message, if one is received, must begin - * with 'struct odp_msg' as a header. Only messages of the types selected - * with the set_listen_mask member function should be received. + * with 'struct odp_msg' as a header, and must have at least + * DPIF_RECV_MSG_PADDING bytes of headroom (allocated using + * e.g. ofpbuf_reserve()). Only messages of the types selected with the + * set_listen_mask member function should be received. * * This function must not block. If no message is ready to be received * when it is called, it should return EAGAIN without blocking. */ @@ -290,4 +307,8 @@ struct dpif_class { extern const struct dpif_class dpif_linux_class; extern const struct dpif_class dpif_netdev_class; +#ifdef __cplusplus +} +#endif + #endif /* dpif-provider.h */