X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fdpif-provider.h;h=4f04c95f059532b0d949b65f72c5211af670a850;hb=d1673b006d53fdea72c0744e835362ed1917f879;hp=75c65bba15c94df0eb25bb3eac4fb958547eedd8;hpb=b99d3ceeedd2c5533c13f9794616fc6d9c49c0de;p=sliver-openvswitch.git diff --git a/lib/dpif-provider.h b/lib/dpif-provider.h index 75c65bba1..4f04c95f0 100644 --- a/lib/dpif-provider.h +++ b/lib/dpif-provider.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009, 2010, 2011, 2012 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. @@ -22,7 +22,6 @@ * 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" @@ -49,7 +48,7 @@ void dpif_uninit(struct dpif *dpif, bool close); static inline void dpif_assert_class(const struct dpif *dpif, const struct dpif_class *dpif_class) { - assert(dpif->dpif_class == dpif_class); + ovs_assert(dpif->dpif_class == dpif_class); } /* Datapath interface class structure, to be defined by each implementation of @@ -80,6 +79,17 @@ struct dpif_class { * case this function may be a null pointer. */ int (*enumerate)(struct sset *all_dps); + /* Returns the type to pass to netdev_open() when a dpif of class + * 'dpif_class' has a port of type 'type', for a few special cases + * when a netdev type differs from a port type. For example, when + * using the userspace datapath, a port of type "internal" needs to + * be opened as "tap". + * + * Returns either 'type' itself or a string literal, which must not + * be freed. */ + const char *(*port_open_type)(const struct dpif_class *dpif_class, + const char *type); + /* 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. * @@ -110,20 +120,26 @@ struct dpif_class { /* Retrieves statistics for 'dpif' into 'stats'. */ 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. */ + /* Adds 'netdev' as a new port in 'dpif'. If '*port_no' is not + * UINT32_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); + uint32_t *port_no); /* Removes port numbered 'port_no' from 'dpif'. */ - int (*port_del)(struct dpif *dpif, uint16_t port_no); + int (*port_del)(struct dpif *dpif, uint32_t port_no); - /* Queries 'dpif' for a port with the given 'port_no' or 'devname'. Stores - * information about the port into '*port' if successful. + /* Queries 'dpif' for a port with the given 'port_no' or 'devname'. + * If 'port' is not null, stores information about the port into + * '*port' if successful. * - * The caller takes ownership of data in 'port' and must free it with - * dpif_port_destroy() when it is no longer needed. */ - int (*port_query_by_number)(const struct dpif *dpif, uint16_t port_no, + * If 'port' is not null, the caller takes ownership of data in + * 'port' and must free it with dpif_port_destroy() when it is no + * longer needed. */ + int (*port_query_by_number)(const struct dpif *dpif, uint32_t port_no, struct dpif_port *port); int (*port_query_by_name)(const struct dpif *dpif, const char *devname, struct dpif_port *port); @@ -136,13 +152,17 @@ struct dpif_class { * 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 UINT32_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); + uint32_t (*port_get_pid)(const struct dpif *dpif, uint32_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 @@ -284,7 +304,7 @@ struct dpif_class { * 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.) */ + * recovered from 'execute->packet', such as tunnel 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 @@ -307,21 +327,19 @@ struct dpif_class { uint32_t *priority); /* Polls for an upcall from 'dpif'. If successful, stores the upcall into - * '*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 - * 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. */ @@ -334,6 +352,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 }