X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fdpif-provider.h;h=1106db888dc7248eee012112912d6189848a9ca7;hb=refs%2Fheads%2Flts-1.0a;hp=020d0670864408bf738d2ebb14dfde82d7658373;hpb=5792c5c64a194304b554e2c6b9a9a4c0216c08a4;p=sliver-openvswitch.git diff --git a/lib/dpif-provider.h b/lib/dpif-provider.h index 020d06708..1106db888 100644 --- a/lib/dpif-provider.h +++ b/lib/dpif-provider.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009 Nicira Networks. + * Copyright (c) 2009, 2010 Nicira Networks. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -18,31 +18,42 @@ #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; - char *name; + const struct dpif_class *dpif_class; + char *base_name; + char *full_name; uint8_t netflow_engine_type; uint8_t netflow_engine_id; }; 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 - * a datapath interface + * a datapath interface. * * These functions return 0 if successful or a positive errno value on failure, * except where otherwise noted. @@ -52,15 +63,11 @@ static inline void dpif_assert_class(const struct dpif *dpif, * EWOULDBLOCK or EINPROGRESS. We may relax this requirement in the future if * and when we encounter performance problems. */ struct dpif_class { - /* Prefix for names of dpifs in this class, e.g. "udatapath:". + /* Type of dpif in this class, e.g. "system", "netdev", etc. * - * One dpif class may have the empty string "" as its prefix, in which case - * that dpif class is associated with dpif names that don't match any other - * class name. */ - const char *prefix; - - /* Class name, for use in error messages. */ - const char *name; + * One of the providers should supply a "system" type, since this is + * 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. */ @@ -70,26 +77,52 @@ struct dpif_class { * to be called. */ void (*wait)(void); - /* Attempts to open an existing dpif, if 'create' is false, or to open an - * existing dpif or create a new one, if 'create' is true. 'name' is the - * full dpif name provided by the user, e.g. "udatapath:/var/run/mypath". - * This name is useful for error messages but must not be modified. + /* 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. * - * 'suffix' is a copy of 'name' following the dpif's 'prefix'. + * This is used by the vswitch at startup, so that it can delete any + * datapaths that are not configured. + * + * Some kinds of datapaths might not be practically enumerable, in which + * case this function may be a null pointer. */ + int (*enumerate)(struct svec *all_dps); + + /* 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, char *suffix, bool create, + int (*open)(const char *name, const char *type, bool create, struct dpif **dpifp); /* Closes 'dpif' and frees associated memory. */ void (*close)(struct dpif *dpif); + /* Enumerates all names that may be used to open 'dpif' into 'all_names'. + * The Linux datapath, for example, supports opening a datapath both by + * number, e.g. "dp0", and by the name of the datapath's local port. For + * some datapaths, this might be an infinite set (e.g. in a file name, + * slashes may be duplicated any number of times), in which case only the + * names most likely to be used should be enumerated. + * + * The caller has already initialized 'all_names' and might already have + * added some names to it. This function should not disturb any existing + * names in 'all_names'. + * + * If a datapath class does not support multiple names for a datapath, this + * function may be a null pointer. + * + * This is used by the vswitch at startup, */ + int (*get_all_names)(const struct dpif *dpif, struct svec *all_names); + /* Attempts to destroy the dpif underlying 'dpif'. * * 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); @@ -126,6 +159,30 @@ struct dpif_class { * value. */ int (*port_list)(const struct dpif *dpif, struct odp_port *ports, int n); + /* 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 + * following: + * + * - Preferably: store the name of the device that was added to or deleted + * from 'dpif' in '*devnamep' and return 0. The caller is responsible + * for freeing '*devnamep' (with free()) when it no longer needs it. + * + * - Alternatively: return ENOBUFS, without indicating the device that was + * added or deleted. + * + * Occasional 'false positives', in which the function returns 0 while + * indicating a device that was not actually added or deleted or returns + * ENOBUFS without any change, are acceptable. + * + * If the set of ports in 'dpif' has not changed, returns EAGAIN. May also + * return other positive errno values to indicate that something has gone + * wrong. */ + int (*port_poll)(const struct dpif *dpif, char **devnamep); + + /* Arranges for the poll loop to wake up when 'port_poll' will return a + * 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. */ @@ -226,10 +283,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. */ @@ -241,5 +325,10 @@ 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 */