lib/xfif-provider.h

   1 /*
   2  * Copyright (c) 2009, 2010 Nicira Networks.
   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 xfifs, which provide an interface to an Open vSwitch
  21  * datapath. */
  22
  23 #include <assert.h>
  24 #include "xfif.h"
  25
  26 #ifdef  __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 /* Open vSwitch datapath interface.
  31  *
  32  * This structure should be treated as opaque by xfif implementations. */
  33 struct xfif {
  34     const struct xfif_class *xfif_class;
  35     char *base_name;
  36     char *full_name;
  37     uint8_t netflow_engine_type;
  38     uint8_t netflow_engine_id;
  39 };
  40
  41 void xfif_init(struct xfif *, const struct xfif_class *, const char *name,
  42                uint8_t netflow_engine_type, uint8_t netflow_engine_id);
  43 void xfif_uninit(struct xfif *xfif, bool close);
  44
  45 static inline void xfif_assert_class(const struct xfif *xfif,
  46                                      const struct xfif_class *xfif_class)
  47 {
  48     assert(xfif->xfif_class == xfif_class);
  49 }
  50
  51 /* Datapath interface class structure, to be defined by each implementation of
  52  * a datapath interface.
  53  *
  54  * These functions return 0 if successful or a positive errno value on failure,
  55  * except where otherwise noted.
  56  *
  57  * These functions are expected to execute synchronously, that is, to block as
  58  * necessary to obtain a result.  Thus, they may not return EAGAIN or
  59  * EWOULDBLOCK or EINPROGRESS.  We may relax this requirement in the future if
  60  * and when we encounter performance problems. */
  61 struct xfif_class {
  62     /* Type of xfif in this class, e.g. "system", "netdev", etc.
  63      *
  64      * One of the providers should supply a "system" type, since this is
  65      * the type assumed if no type is specified when opening a xfif. */
  66     const char *type;
  67
  68     /* Performs periodic work needed by xfifs of this class, if any is
  69      * necessary. */
  70     void (*run)(void);
  71
  72     /* Arranges for poll_block() to wake up if the "run" member function needs
  73      * to be called. */
  74     void (*wait)(void);
  75
  76     /* Enumerates the names of all known created datapaths, if possible, into
  77      * 'all_dps'.  The caller has already initialized 'all_dps' and other xfif
  78      * classes might already have added names to it.
  79      *
  80      * This is used by the vswitch at startup, so that it can delete any
  81      * datapaths that are not configured.
  82      *
  83      * Some kinds of datapaths might not be practically enumerable, in which
  84      * case this function may be a null pointer. */
  85     int (*enumerate)(struct svec *all_dps);
  86
  87     /* Attempts to open an existing xfif called 'name', if 'create' is false,
  88      * or to open an existing xfif or create a new one, if 'create' is true.
  89      * 'type' corresponds to the 'type' field used in the xfif_class
  90      * structure.
  91      *
  92      * If successful, stores a pointer to the new xfif in '*xfifp'.  On failure
  93      * there are no requirements on what is stored in '*xfifp'. */
  94     int (*open)(const char *name, const char *type, bool create,
  95                 struct xfif **xfifp);
  96
  97     /* Closes 'xfif' and frees associated memory. */
  98     void (*close)(struct xfif *xfif);
  99
 100     /* Enumerates all names that may be used to open 'xfif' into 'all_names'.
 101      * The Linux datapath, for example, supports opening a datapath both by
 102      * number, e.g. "dp0", and by the name of the datapath's local port.  For
 103      * some datapaths, this might be an infinite set (e.g. in a file name,
 104      * slashes may be duplicated any number of times), in which case only the
 105      * names most likely to be used should be enumerated.
 106      *
 107      * The caller has already initialized 'all_names' and might already have
 108      * added some names to it.  This function should not disturb any existing
 109      * names in 'all_names'.
 110      *
 111      * If a datapath class does not support multiple names for a datapath, this
 112      * function may be a null pointer.
 113      *
 114      * This is used by the vswitch at startup, */
 115     int (*get_all_names)(const struct xfif *xfif, struct svec *all_names);
 116
 117     /* Attempts to destroy the xfif underlying 'xfif'.
 118      *
 119      * If successful, 'xfif' will not be used again except as an argument for
 120      * the 'close' member function. */
 121     int (*destroy)(struct xfif *xfif);
 122
 123     /* Retrieves statistics for 'xfif' into 'stats'. */
 124     int (*get_stats)(const struct xfif *xfif, struct xflow_stats *stats);
 125
 126     /* Retrieves 'xfif''s current treatment of IP fragments into '*drop_frags':
 127      * true indicates that fragments are dropped, false indicates that
 128      * fragments are treated in the same way as other IP packets (except that
 129      * the L4 header cannot be read). */
 130     int (*get_drop_frags)(const struct xfif *xfif, bool *drop_frags);
 131
 132     /* Changes 'xfif''s treatment of IP fragments to 'drop_frags', whose
 133      * meaning is the same as for the get_drop_frags member function. */
 134     int (*set_drop_frags)(struct xfif *xfif, bool drop_frags);
 135
 136     /* Creates a new port in 'xfif' connected to network device 'devname'.
 137      * 'flags' is a set of XFLOW_PORT_* flags.  If successful, sets '*port_no'
 138      * to the new port's port number. */
 139     int (*port_add)(struct xfif *xfif, const char *devname, uint16_t flags,
 140                     uint16_t *port_no);
 141
 142     /* Removes port numbered 'port_no' from 'xfif'. */
 143     int (*port_del)(struct xfif *xfif, uint16_t port_no);
 144
 145     /* Queries 'xfif' for a port with the given 'port_no' or 'devname'.  Stores
 146      * information about the port into '*port' if successful. */
 147     int (*port_query_by_number)(const struct xfif *xfif, uint16_t port_no,
 148                                 struct xflow_port *port);
 149     int (*port_query_by_name)(const struct xfif *xfif, const char *devname,
 150                               struct xflow_port *port);
 151
 152     /* Stores in 'ports' information about up to 'n' ports attached to 'xfif',
 153      * in no particular order.  Returns the number of ports attached to 'xfif'
 154      * (not the number stored), if successful, otherwise a negative errno
 155      * value. */
 156     int (*port_list)(const struct xfif *xfif, struct xflow_port *ports, int n);
 157
 158     /* Polls for changes in the set of ports in 'xfif'.  If the set of ports in
 159      * 'xfif' has changed, then this function should do one of the
 160      * following:
 161      *
 162      * - Preferably: store the name of the device that was added to or deleted
 163      *   from 'xfif' in '*devnamep' and return 0.  The caller is responsible
 164      *   for freeing '*devnamep' (with free()) when it no longer needs it.
 165      *
 166      * - Alternatively: return ENOBUFS, without indicating the device that was
 167      *   added or deleted.
 168      *
 169      * Occasional 'false positives', in which the function returns 0 while
 170      * indicating a device that was not actually added or deleted or returns
 171      * ENOBUFS without any change, are acceptable.
 172      *
 173      * If the set of ports in 'xfif' has not changed, returns EAGAIN.  May also
 174      * return other positive errno values to indicate that something has gone
 175      * wrong. */
 176     int (*port_poll)(const struct xfif *xfif, char **devnamep);
 177
 178     /* Arranges for the poll loop to wake up when 'port_poll' will return a
 179      * value other than EAGAIN. */
 180     void (*port_poll_wait)(const struct xfif *xfif);
 181
 182     /* Stores in 'ports' the port numbers of up to 'n' ports that belong to
 183      * 'group' in 'xfif'.  Returns the number of ports in 'group' (not the
 184      * number stored), if successful, otherwise a negative errno value. */
 185     int (*port_group_get)(const struct xfif *xfif, int group,
 186                           uint16_t ports[], int n);
 187
 188     /* Changes port group 'group' in 'xfif' to consist of the 'n' ports whose
 189      * numbers are given in 'ports'.
 190      *
 191      * Use the get_stats member function to obtain the number of supported port
 192      * groups. */
 193     int (*port_group_set)(struct xfif *xfif, int group,
 194                           const uint16_t ports[], int n);
 195
 196     /* For each flow 'flow' in the 'n' flows in 'flows':
 197      *
 198      * - If a flow matching 'flow->key' exists in 'xfif':
 199      *
 200      *     Stores 0 into 'flow->stats.error' and stores statistics for the flow
 201      *     into 'flow->stats'.
 202      *
 203      *     If 'flow->n_actions' is zero, then 'flow->actions' is ignored.  If
 204      *     'flow->n_actions' is nonzero, then 'flow->actions' should point to
 205      *     an array of the specified number of actions.  At most that many of
 206      *     the flow's actions will be copied into that array.
 207      *     'flow->n_actions' will be updated to the number of actions actually
 208      *     present in the flow, which may be greater than the number stored if
 209      *     the flow has more actions than space available in the array.
 210      *
 211      * - Flow-specific errors are indicated by a positive errno value in
 212      *   'flow->stats.error'.  In particular, ENOENT indicates that no flow
 213      *   matching 'flow->key' exists in 'xfif'.  When an error value is stored,
 214      *   the contents of 'flow->key' are preserved but other members of 'flow'
 215      *   should be treated as indeterminate.
 216      *
 217      * Returns 0 if all 'n' flows in 'flows' were updated (whether they were
 218      * individually successful or not is indicated by 'flow->stats.error',
 219      * however).  Returns a positive errno value if an error that prevented
 220      * this update occurred, in which the caller must not depend on any
 221      * elements in 'flows' being updated or not updated.
 222      */
 223     int (*flow_get)(const struct xfif *xfif, struct xflow_flow flows[], int n);
 224
 225     /* Adds or modifies a flow in 'xfif' as specified in 'put':
 226      *
 227      * - If the flow specified in 'put->flow' does not exist in 'xfif', then
 228      *   behavior depends on whether XFLOWPF_CREATE is specified in 'put->flags':
 229      *   if it is, the flow will be added, otherwise the operation will fail
 230      *   with ENOENT.
 231      *
 232      * - Otherwise, the flow specified in 'put->flow' does exist in 'xfif'.
 233      *   Behavior in this case depends on whether XFLOWPF_MODIFY is specified in
 234      *   'put->flags': if it is, the flow's actions will be updated, otherwise
 235      *   the operation will fail with EEXIST.  If the flow's actions are
 236      *   updated, then its statistics will be zeroed if XFLOWPF_ZERO_STATS is set
 237      *   in 'put->flags', left as-is otherwise.
 238      */
 239     int (*flow_put)(struct xfif *xfif, struct xflow_flow_put *put);
 240
 241     /* Deletes a flow matching 'flow->key' from 'xfif' or returns ENOENT if
 242      * 'xfif' does not contain such a flow.
 243      *
 244      * If successful, updates 'flow->stats', 'flow->n_actions', and
 245      * 'flow->actions' as described in more detail under the flow_get member
 246      * function below. */
 247     int (*flow_del)(struct xfif *xfif, struct xflow_flow *flow);
 248
 249     /* Deletes all flows from 'xfif' and clears all of its queues of received
 250      * packets. */
 251     int (*flow_flush)(struct xfif *xfif);
 252
 253     /* Stores up to 'n' flows in 'xfif' into 'flows', updating their statistics
 254      * and actions as described under the flow_get member function.  If
 255      * successful, returns the number of flows actually present in 'xfif',
 256      * which might be greater than the number stored (if 'xfif' has more than
 257      * 'n' flows).  On failure, returns a negative errno value. */
 258     int (*flow_list)(const struct xfif *xfif,
 259                      struct xflow_flow flows[], int n);
 260
 261     /* Performs the 'n_actions' actions in 'actions' on the Ethernet frame
 262      * specified in 'packet'.
 263      *
 264      * Pretends that the frame was originally received on the port numbered
 265      * 'in_port'.  This affects only XFLOWAT_OUTPUT_GROUP actions, which will
 266      * not send a packet out their input port.  Specify the number of an unused
 267      * port (e.g. UINT16_MAX is currently always unused) to avoid this
 268      * behavior. */
 269     int (*execute)(struct xfif *xfif, uint16_t in_port,
 270                    const union xflow_action actions[], int n_actions,
 271                    const struct ofpbuf *packet);
 272
 273     /* Retrieves 'xfif''s "listen mask" into '*listen_mask'.  Each XFLOWL_* bit
 274      * set in '*listen_mask' indicates the 'xfif' will receive messages of the
 275      * corresponding type when it calls the recv member function. */
 276     int (*recv_get_mask)(const struct xfif *xfif, int *listen_mask);
 277
 278     /* Sets 'xfif''s "listen mask" to 'listen_mask'.  Each XFLOWL_* bit set in
 279      * 'listen_mask' indicates the 'xfif' will receive messages of the
 280      * corresponding type when it calls the recv member function. */
 281     int (*recv_set_mask)(struct xfif *xfif, int listen_mask);
 282
 283     /* Retrieves 'xfif''s sFlow sampling probability into '*probability'.
 284      * Return value is 0 or a positive errno value.  EOPNOTSUPP indicates that
 285      * the datapath does not support sFlow, as does a null pointer.
 286      *
 287      * '*probability' is expressed as the number of packets out of UINT_MAX to
 288      * sample, e.g. probability/UINT_MAX is the probability of sampling a given
 289      * packet. */
 290     int (*get_sflow_probability)(const struct xfif *xfif,
 291                                  uint32_t *probability);
 292
 293     /* Sets 'xfif''s sFlow sampling probability to 'probability'.  Return value
 294      * is 0 or a positive errno value.  EOPNOTSUPP indicates that the datapath
 295      * does not support sFlow, as does a null pointer.
 296      *
 297      * 'probability' is expressed as the number of packets out of UINT_MAX to
 298      * sample, e.g. probability/UINT_MAX is the probability of sampling a given
 299      * packet. */
 300     int (*set_sflow_probability)(struct xfif *xfif, uint32_t probability);
 301
 302     /* Attempts to receive a message from 'xfif'.  If successful, stores the
 303      * message into '*packetp'.  The message, if one is received, must begin
 304      * with 'struct xflow_msg' as a header.  Only messages of the types
 305      * selected with the recv_set_mask member function should be received.
 306      *
 307      * This function must not block.  If no message is ready to be received
 308      * when it is called, it should return EAGAIN without blocking. */
 309     int (*recv)(struct xfif *xfif, struct ofpbuf **packetp);
 310
 311     /* Arranges for the poll loop to wake up when 'xfif' has a message queued
 312      * to be received with the recv member function. */
 313     void (*recv_wait)(struct xfif *xfif);
 314 };
 315
 316 extern const struct xfif_class xfif_linux_class;
 317 extern const struct xfif_class xfif_netdev_class;
 318
 319 #ifdef  __cplusplus
 320 }
 321 #endif
 322
 323 #endif /* xfif-provider.h */