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