lib/dpif-provider.h

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef DPIF_PROVIDER_H
  18 #define DPIF_PROVIDER_H 1
  19
  20 /* Provider interface to dpifs, which provide an interface to an Open vSwitch
  21  * datapath.  A datapath is a collection of physical or virtual ports that are
  22  * exposed over OpenFlow as a single switch.  Datapaths and the collections of
  23  * ports that they contain may be fixed or dynamic. */
  24
  25 #include <assert.h>
  26 #include "openflow/openflow.h"
  27 #include "dpif.h"
  28 #include "util.h"
  29
  30 #ifdef  __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 /* Open vSwitch datapath interface.
  35  *
  36  * This structure should be treated as opaque by dpif implementations. */
  37 struct dpif {
  38     const struct dpif_class *dpif_class;
  39     char *base_name;
  40     char *full_name;
  41     uint8_t netflow_engine_type;
  42     uint8_t netflow_engine_id;
  43 };
  44
  45 void dpif_init(struct dpif *, const struct dpif_class *, const char *name,
  46                uint8_t netflow_engine_type, uint8_t netflow_engine_id);
  47 void dpif_uninit(struct dpif *dpif, bool close);
  48
  49 static inline void dpif_assert_class(const struct dpif *dpif,
  50                                      const struct dpif_class *dpif_class)
  51 {
  52     assert(dpif->dpif_class == dpif_class);
  53 }
  54
  55 /* Datapath interface class structure, to be defined by each implementation of
  56  * a datapath interface.
  57  *
  58  * These functions return 0 if successful or a positive errno value on failure,
  59  * except where otherwise noted.
  60  *
  61  * These functions are expected to execute synchronously, that is, to block as
  62  * necessary to obtain a result.  Thus, they may not return EAGAIN or
  63  * EWOULDBLOCK or EINPROGRESS.  We may relax this requirement in the future if
  64  * and when we encounter performance problems. */
  65 struct dpif_class {
  66     /* Type of dpif in this class, e.g. "system", "netdev", etc.
  67      *
  68      * One of the providers should supply a "system" type, since this is
  69      * the type assumed if no type is specified when opening a dpif. */
  70     const char *type;
  71
  72     /* Enumerates the names of all known created datapaths, if possible, into
  73      * 'all_dps'.  The caller has already initialized 'all_dps' and other dpif
  74      * classes might already have added names to it.
  75      *
  76      * This is used by the vswitch at startup, so that it can delete any
  77      * datapaths that are not configured.
  78      *
  79      * Some kinds of datapaths might not be practically enumerable, in which
  80      * case this function may be a null pointer. */
  81     int (*enumerate)(struct sset *all_dps);
  82
  83     /* Attempts to open an existing dpif called 'name', if 'create' is false,
  84      * or to open an existing dpif or create a new one, if 'create' is true.
  85      *
  86      * 'dpif_class' is the class of dpif to open.
  87      *
  88      * If successful, stores a pointer to the new dpif in '*dpifp', which must
  89      * have class 'dpif_class'.  On failure there are no requirements on what
  90      * is stored in '*dpifp'. */
  91     int (*open)(const struct dpif_class *dpif_class,
  92                 const char *name, bool create, struct dpif **dpifp);
  93
  94     /* Closes 'dpif' and frees associated memory. */
  95     void (*close)(struct dpif *dpif);
  96
  97     /* Attempts to destroy the dpif underlying 'dpif'.
  98      *
  99      * If successful, 'dpif' will not be used again except as an argument for
 100      * the 'close' member function. */
 101     int (*destroy)(struct dpif *dpif);
 102
 103     /* Performs periodic work needed by 'dpif', if any is necessary. */
 104     void (*run)(struct dpif *dpif);
 105
 106     /* Arranges for poll_block() to wake up if the "run" member function needs
 107      * to be called for 'dpif'. */
 108     void (*wait)(struct dpif *dpif);
 109
 110     /* Retrieves statistics for 'dpif' into 'stats'. */
 111     int (*get_stats)(const struct dpif *dpif, struct dpif_dp_stats *stats);
 112
 113     /* Adds 'netdev' as a new port in 'dpif'.  If successful, sets '*port_no'
 114      * to the new port's port number. */
 115     int (*port_add)(struct dpif *dpif, struct netdev *netdev,
 116                     uint16_t *port_no);
 117
 118     /* Removes port numbered 'port_no' from 'dpif'. */
 119     int (*port_del)(struct dpif *dpif, uint16_t port_no);
 120
 121     /* Queries 'dpif' for a port with the given 'port_no' or 'devname'.  Stores
 122      * information about the port into '*port' if successful.
 123      *
 124      * The caller takes ownership of data in 'port' and must free it with
 125      * dpif_port_destroy() when it is no longer needed. */
 126     int (*port_query_by_number)(const struct dpif *dpif, uint16_t port_no,
 127                                 struct dpif_port *port);
 128     int (*port_query_by_name)(const struct dpif *dpif, const char *devname,
 129                               struct dpif_port *port);
 130
 131     /* Returns one greater than the largest port number accepted in flow
 132      * actions. */
 133     int (*get_max_ports)(const struct dpif *dpif);
 134
 135     /* Returns the Netlink PID value to supply in OVS_ACTION_ATTR_USERSPACE
 136      * actions as the OVS_USERSPACE_ATTR_PID attribute's value, for use in
 137      * flows whose packets arrived on port 'port_no'.
 138      *
 139      * The return value only needs to be meaningful when DPIF_UC_ACTION has
 140      * been enabled in the 'dpif''s listen mask, and it is allowed to change
 141      * when DPIF_UC_ACTION is disabled and then re-enabled.
 142      *
 143      * A dpif provider that doesn't have meaningful Netlink PIDs can use NULL
 144      * for this function.  This is equivalent to always returning 0. */
 145     uint32_t (*port_get_pid)(const struct dpif *dpif, uint16_t port_no);
 146
 147     /* Attempts to begin dumping the ports in a dpif.  On success, returns 0
 148      * and initializes '*statep' with any data needed for iteration.  On
 149      * failure, returns a positive errno value. */
 150     int (*port_dump_start)(const struct dpif *dpif, void **statep);
 151
 152     /* Attempts to retrieve another port from 'dpif' for 'state', which was
 153      * initialized by a successful call to the 'port_dump_start' function for
 154      * 'dpif'.  On success, stores a new dpif_port into 'port' and returns 0.
 155      * Returns EOF if the end of the port table has been reached, or a positive
 156      * errno value on error.  This function will not be called again once it
 157      * returns nonzero once for a given iteration (but the 'port_dump_done'
 158      * function will be called afterward).
 159      *
 160      * The dpif provider retains ownership of the data stored in 'port'.  It
 161      * must remain valid until at least the next call to 'port_dump_next' or
 162      * 'port_dump_done' for 'state'. */
 163     int (*port_dump_next)(const struct dpif *dpif, void *state,
 164                           struct dpif_port *port);
 165
 166     /* Releases resources from 'dpif' for 'state', which was initialized by a
 167      * successful call to the 'port_dump_start' function for 'dpif'.  */
 168     int (*port_dump_done)(const struct dpif *dpif, void *state);
 169
 170     /* Polls for changes in the set of ports in 'dpif'.  If the set of ports in
 171      * 'dpif' has changed, then this function should do one of the
 172      * following:
 173      *
 174      * - Preferably: store the name of the device that was added to or deleted
 175      *   from 'dpif' in '*devnamep' and return 0.  The caller is responsible
 176      *   for freeing '*devnamep' (with free()) when it no longer needs it.
 177      *
 178      * - Alternatively: return ENOBUFS, without indicating the device that was
 179      *   added or deleted.
 180      *
 181      * Occasional 'false positives', in which the function returns 0 while
 182      * indicating a device that was not actually added or deleted or returns
 183      * ENOBUFS without any change, are acceptable.
 184      *
 185      * If the set of ports in 'dpif' has not changed, returns EAGAIN.  May also
 186      * return other positive errno values to indicate that something has gone
 187      * wrong. */
 188     int (*port_poll)(const struct dpif *dpif, char **devnamep);
 189
 190     /* Arranges for the poll loop to wake up when 'port_poll' will return a
 191      * value other than EAGAIN. */
 192     void (*port_poll_wait)(const struct dpif *dpif);
 193
 194     /* Queries 'dpif' for a flow entry.  The flow is specified by the Netlink
 195      * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
 196      * 'key'.
 197      *
 198      * Returns 0 if successful.  If no flow matches, returns ENOENT.  On other
 199      * failure, returns a positive errno value.
 200      *
 201      * If 'actionsp' is nonnull, then on success '*actionsp' must be set to an
 202      * ofpbuf owned by the caller that contains the Netlink attributes for the
 203      * flow's actions.  The caller must free the ofpbuf (with ofpbuf_delete())
 204      * when it is no longer needed.
 205      *
 206      * If 'stats' is nonnull, then on success it must be updated with the
 207      * flow's statistics. */
 208     int (*flow_get)(const struct dpif *dpif,
 209                     const struct nlattr *key, size_t key_len,
 210                     struct ofpbuf **actionsp, struct dpif_flow_stats *stats);
 211
 212     /* Adds or modifies a flow in 'dpif'.  The flow is specified by the Netlink
 213      * attributes with types OVS_KEY_ATTR_* in the 'put->key_len' bytes
 214      * starting at 'put->key'.  The associated actions are specified by the
 215      * Netlink attributes with types OVS_ACTION_ATTR_* in the
 216      * 'put->actions_len' bytes starting at 'put->actions'.
 217      *
 218      * - If the flow's key does not exist in 'dpif', then the flow will be
 219      *   added if 'put->flags' includes DPIF_FP_CREATE.  Otherwise the
 220      *   operation will fail with ENOENT.
 221      *
 222      *   If the operation succeeds, then 'put->stats', if nonnull, must be
 223      *   zeroed.
 224      *
 225      * - If the flow's key does exist in 'dpif', then the flow's actions will
 226      *   be updated if 'put->flags' includes DPIF_FP_MODIFY.  Otherwise the
 227      *   operation will fail with EEXIST.  If the flow's actions are updated,
 228      *   then its statistics will be zeroed if 'put->flags' includes
 229      *   DPIF_FP_ZERO_STATS, and left as-is otherwise.
 230      *
 231      *   If the operation succeeds, then 'put->stats', if nonnull, must be set
 232      *   to the flow's statistics before the update.
 233      */
 234     int (*flow_put)(struct dpif *dpif, const struct dpif_flow_put *put);
 235
 236     /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif'
 237      * does not contain such a flow.  The flow is specified by the Netlink
 238      * attributes with types OVS_KEY_ATTR_* in the 'del->key_len' bytes
 239      * starting at 'del->key'.
 240      *
 241      * If the operation succeeds, then 'del->stats', if nonnull, must be set to
 242      * the flow's statistics before its deletion. */
 243     int (*flow_del)(struct dpif *dpif, const struct dpif_flow_del *del);
 244
 245     /* Deletes all flows from 'dpif' and clears all of its queues of received
 246      * packets. */
 247     int (*flow_flush)(struct dpif *dpif);
 248
 249     /* Attempts to begin dumping the flows in a dpif.  On success, returns 0
 250      * and initializes '*statep' with any data needed for iteration.  On
 251      * failure, returns a positive errno value. */
 252     int (*flow_dump_start)(const struct dpif *dpif, void **statep);
 253
 254     /* Attempts to retrieve another flow from 'dpif' for 'state', which was
 255      * initialized by a successful call to the 'flow_dump_start' function for
 256      * 'dpif'.  On success, updates the output parameters as described below
 257      * and returns 0.  Returns EOF if the end of the flow table has been
 258      * reached, or a positive errno value on error.  This function will not be
 259      * called again once it returns nonzero within a given iteration (but the
 260      * 'flow_dump_done' function will be called afterward).
 261      *
 262      * On success, if 'key' and 'key_len' are nonnull then '*key' and
 263      * '*key_len' must be set to Netlink attributes with types OVS_KEY_ATTR_*
 264      * representing the dumped flow's key.  If 'actions' and 'actions_len' are
 265      * nonnull then they should be set to Netlink attributes with types
 266      * OVS_ACTION_ATTR_* representing the dumped flow's actions.  If 'stats'
 267      * is nonnull then it should be set to the dumped flow's statistics.
 268      *
 269      * All of the returned data is owned by 'dpif', not by the caller, and the
 270      * caller must not modify or free it.  'dpif' must guarantee that it
 271      * remains accessible and unchanging until at least the next call to
 272      * 'flow_dump_next' or 'flow_dump_done' for 'state'. */
 273     int (*flow_dump_next)(const struct dpif *dpif, void *state,
 274                           const struct nlattr **key, size_t *key_len,
 275                           const struct nlattr **actions, size_t *actions_len,
 276                           const struct dpif_flow_stats **stats);
 277
 278     /* Releases resources from 'dpif' for 'state', which was initialized by a
 279      * successful call to the 'flow_dump_start' function for 'dpif'.  */
 280     int (*flow_dump_done)(const struct dpif *dpif, void *state);
 281
 282     /* Performs the 'execute->actions_len' bytes of actions in
 283      * 'execute->actions' on the Ethernet frame specified in 'execute->packet'
 284      * taken from the flow specified in the 'execute->key_len' bytes of
 285      * 'execute->key'.  ('execute->key' is mostly redundant with
 286      * 'execute->packet', but it contains some metadata that cannot be
 287      * recovered from 'execute->packet', such as tun_id and in_port.) */
 288     int (*execute)(struct dpif *dpif, const struct dpif_execute *execute);
 289
 290     /* Executes each of the 'n_ops' operations in 'ops' on 'dpif', in the order
 291      * in which they are specified, placing each operation's results in the
 292      * "output" members documented in comments.
 293      *
 294      * This function is optional.  It is only worthwhile to implement it if
 295      * 'dpif' can perform operations in batch faster than individually. */
 296     void (*operate)(struct dpif *dpif, struct dpif_op **ops, size_t n_ops);
 297
 298     /* Enables or disables receiving packets with dpif_recv() for 'dpif'.
 299      * Turning packet receive off and then back on is allowed to change Netlink
 300      * PID assignments (see ->port_get_pid()).  The client is responsible for
 301      * updating flows as necessary if it does this. */
 302     int (*recv_set)(struct dpif *dpif, bool enable);
 303
 304     /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a
 305      * priority value used for setting packet priority. */
 306     int (*queue_to_priority)(const struct dpif *dpif, uint32_t queue_id,
 307                              uint32_t *priority);
 308
 309     /* Polls for an upcall from 'dpif'.  If successful, stores the upcall into
 310      * '*upcall', using 'buf' for storage.  Should only be called if 'recv_set'
 311      * has been used to enable receiving packets from 'dpif'.
 312      *
 313      * The implementation should point 'upcall->packet' and 'upcall->key' into
 314      * data in the caller-provided 'buf'.  If necessary to make room, the
 315      * implementation may expand the data in 'buf'.  (This is hardly a great
 316      * way to do things but it works out OK for the dpif providers that exist
 317      * so far.)
 318      *
 319      * This function must not block.  If no upcall is pending when it is
 320      * called, it should return EAGAIN without blocking. */
 321     int (*recv)(struct dpif *dpif, struct dpif_upcall *upcall,
 322                 struct ofpbuf *buf);
 323
 324     /* Arranges for the poll loop to wake up when 'dpif' has a message queued
 325      * to be received with the recv member function. */
 326     void (*recv_wait)(struct dpif *dpif);
 327
 328     /* Throws away any queued upcalls that 'dpif' currently has ready to
 329      * return. */
 330     void (*recv_purge)(struct dpif *dpif);
 331 };
 332
 333 extern const struct dpif_class dpif_linux_class;
 334 extern const struct dpif_class dpif_netdev_class;
 335
 336 #ifdef  __cplusplus
 337 }
 338 #endif
 339
 340 #endif /* dpif-provider.h */