lib/dpif.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011 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
  18 #ifndef DPIF_H
  19 #define DPIF_H 1
  20
  21 #include <stdbool.h>
  22 #include <stddef.h>
  23 #include <stdint.h>
  24 #include <linux/openvswitch.h>
  25 #include "openflow/openflow.h"
  26 #include "netdev.h"
  27 #include "util.h"
  28
  29 #ifdef  __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 struct dpif;
  34 struct ds;
  35 struct flow;
  36 struct nlattr;
  37 struct ofpbuf;
  38 struct sset;
  39 struct dpif_class;
  40
  41 int dp_register_provider(const struct dpif_class *);
  42 int dp_unregister_provider(const char *type);
  43 void dp_enumerate_types(struct sset *types);
  44 const char *dpif_normalize_type(const char *);
  45
  46 int dp_enumerate_names(const char *type, struct sset *names);
  47 void dp_parse_name(const char *datapath_name, char **name, char **type);
  48
  49 int dpif_open(const char *name, const char *type, struct dpif **);
  50 int dpif_create(const char *name, const char *type, struct dpif **);
  51 int dpif_create_and_open(const char *name, const char *type, struct dpif **);
  52 void dpif_close(struct dpif *);
  53
  54 void dpif_run(struct dpif *);
  55 void dpif_wait(struct dpif *);
  56
  57 const char *dpif_name(const struct dpif *);
  58 const char *dpif_base_name(const struct dpif *);
  59
  60 int dpif_delete(struct dpif *);
  61
  62 /* Statisticss for a dpif as a whole. */
  63 struct dpif_dp_stats {
  64     uint64_t n_hit;             /* Number of flow table matches. */
  65     uint64_t n_missed;          /* Number of flow table misses. */
  66     uint64_t n_lost;            /* Number of misses not sent to userspace. */
  67     uint64_t n_flows;           /* Number of flows present. */
  68 };
  69 int dpif_get_dp_stats(const struct dpif *, struct dpif_dp_stats *);
  70
  71 \f
  72 /* Port operations. */
  73
  74 int dpif_port_add(struct dpif *, struct netdev *, uint16_t *port_nop);
  75 int dpif_port_del(struct dpif *, uint16_t port_no);
  76
  77 /* A port within a datapath.
  78  *
  79  * 'name' and 'type' are suitable for passing to netdev_open(). */
  80 struct dpif_port {
  81     char *name;                 /* Network device name, e.g. "eth0". */
  82     char *type;                 /* Network device type, e.g. "system". */
  83     uint32_t port_no;           /* Port number within datapath. */
  84 };
  85 void dpif_port_clone(struct dpif_port *, const struct dpif_port *);
  86 void dpif_port_destroy(struct dpif_port *);
  87 int dpif_port_query_by_number(const struct dpif *, uint16_t port_no,
  88                               struct dpif_port *);
  89 int dpif_port_query_by_name(const struct dpif *, const char *devname,
  90                             struct dpif_port *);
  91 int dpif_port_get_name(struct dpif *, uint16_t port_no,
  92                        char *name, size_t name_size);
  93 int dpif_get_max_ports(const struct dpif *);
  94 uint32_t dpif_port_get_pid(const struct dpif *, uint16_t port_no);
  95
  96 struct dpif_port_dump {
  97     const struct dpif *dpif;
  98     int error;
  99     void *state;
 100 };
 101 void dpif_port_dump_start(struct dpif_port_dump *, const struct dpif *);
 102 bool dpif_port_dump_next(struct dpif_port_dump *, struct dpif_port *);
 103 int dpif_port_dump_done(struct dpif_port_dump *);
 104
 105 /* Iterates through each DPIF_PORT in DPIF, using DUMP as state.
 106  *
 107  * Arguments all have pointer type.
 108  *
 109  * If you break out of the loop, then you need to free the dump structure by
 110  * hand using dpif_port_dump_done(). */
 111 #define DPIF_PORT_FOR_EACH(DPIF_PORT, DUMP, DPIF)   \
 112     for (dpif_port_dump_start(DUMP, DPIF);          \
 113          (dpif_port_dump_next(DUMP, DPIF_PORT)      \
 114           ? true                                    \
 115           : (dpif_port_dump_done(DUMP), false));    \
 116         )
 117
 118 int dpif_port_poll(const struct dpif *, char **devnamep);
 119 void dpif_port_poll_wait(const struct dpif *);
 120 \f
 121 /* Flow table operations. */
 122
 123 struct dpif_flow_stats {
 124     uint64_t n_packets;
 125     uint64_t n_bytes;
 126     long long int used;
 127     uint8_t tcp_flags;
 128 };
 129
 130 void dpif_flow_stats_extract(const struct flow *, struct ofpbuf *packet,
 131                              struct dpif_flow_stats *);
 132 void dpif_flow_stats_format(const struct dpif_flow_stats *, struct ds *);
 133
 134 enum dpif_flow_put_flags {
 135     DPIF_FP_CREATE = 1 << 0,    /* Allow creating a new flow. */
 136     DPIF_FP_MODIFY = 1 << 1,    /* Allow modifying an existing flow. */
 137     DPIF_FP_ZERO_STATS = 1 << 2 /* Zero the stats of an existing flow. */
 138 };
 139
 140 int dpif_flow_flush(struct dpif *);
 141 int dpif_flow_put(struct dpif *, enum dpif_flow_put_flags,
 142                   const struct nlattr *key, size_t key_len,
 143                   const struct nlattr *actions, size_t actions_len,
 144                   struct dpif_flow_stats *);
 145 int dpif_flow_del(struct dpif *,
 146                   const struct nlattr *key, size_t key_len,
 147                   struct dpif_flow_stats *);
 148 int dpif_flow_get(const struct dpif *,
 149                   const struct nlattr *key, size_t key_len,
 150                   struct ofpbuf **actionsp, struct dpif_flow_stats *);
 151
 152 struct dpif_flow_dump {
 153     const struct dpif *dpif;
 154     int error;
 155     void *state;
 156 };
 157 void dpif_flow_dump_start(struct dpif_flow_dump *, const struct dpif *);
 158 bool dpif_flow_dump_next(struct dpif_flow_dump *,
 159                          const struct nlattr **key, size_t *key_len,
 160                          const struct nlattr **actions, size_t *actions_len,
 161                          const struct dpif_flow_stats **);
 162 int dpif_flow_dump_done(struct dpif_flow_dump *);
 163 \f
 164 /* Packet operations. */
 165
 166 int dpif_execute(struct dpif *,
 167                  const struct nlattr *key, size_t key_len,
 168                  const struct nlattr *actions, size_t actions_len,
 169                  const struct ofpbuf *);
 170 \f
 171 /* Operation batching interface.
 172  *
 173  * Some datapaths are faster at performing N operations together than the same
 174  * N operations individually, hence an interface for batching.
 175  */
 176
 177 enum dpif_op_type {
 178     DPIF_OP_FLOW_PUT = 1,
 179     DPIF_OP_EXECUTE
 180 };
 181
 182 struct dpif_flow_put {
 183     enum dpif_op_type type;         /* Always DPIF_OP_FLOW_PUT. */
 184
 185     /* Input. */
 186     enum dpif_flow_put_flags flags; /* DPIF_FP_*. */
 187     const struct nlattr *key;       /* Flow to put. */
 188     size_t key_len;                 /* Length of 'key' in bytes. */
 189     const struct nlattr *actions;   /* Actions to perform on flow. */
 190     size_t actions_len;             /* Length of 'actions' in bytes. */
 191
 192     /* Output. */
 193     struct dpif_flow_stats *stats;  /* Optional flow statistics. */
 194     int error;                      /* 0 or positive errno value. */
 195 };
 196
 197 struct dpif_execute {
 198     enum dpif_op_type type;         /* Always DPIF_OP_EXECUTE. */
 199
 200     /* Input. */
 201     const struct nlattr *key;       /* Partial flow key (only for metadata). */
 202     size_t key_len;                 /* Length of 'key' in bytes. */
 203     const struct nlattr *actions;   /* Actions to execute on packet. */
 204     size_t actions_len;             /* Length of 'actions' in bytes. */
 205     const struct ofpbuf *packet;    /* Packet to execute. */
 206
 207     /* Output. */
 208     int error;                      /* 0 or positive errno value. */
 209 };
 210
 211 union dpif_op {
 212     enum dpif_op_type type;
 213     struct dpif_flow_put flow_put;
 214     struct dpif_execute execute;
 215 };
 216
 217 void dpif_operate(struct dpif *, union dpif_op **ops, size_t n_ops);
 218 \f
 219 /* Upcalls. */
 220
 221 enum dpif_upcall_type {
 222     DPIF_UC_MISS,               /* Miss in flow table. */
 223     DPIF_UC_ACTION,             /* OVS_ACTION_ATTR_USERSPACE action. */
 224     DPIF_N_UC_TYPES
 225 };
 226
 227 const char *dpif_upcall_type_to_string(enum dpif_upcall_type);
 228
 229 /* A packet passed up from the datapath to userspace.
 230  *
 231  * If 'key' or 'actions' is nonnull, then it points into data owned by
 232  * 'packet', so their memory cannot be freed separately.  (This is hardly a
 233  * great way to do things but it works out OK for the dpif providers and
 234  * clients that exist so far.)
 235  */
 236 struct dpif_upcall {
 237     /* All types. */
 238     enum dpif_upcall_type type;
 239     struct ofpbuf *packet;      /* Packet data. */
 240     struct nlattr *key;         /* Flow key. */
 241     size_t key_len;             /* Length of 'key' in bytes. */
 242
 243     /* DPIF_UC_ACTION only. */
 244     uint64_t userdata;          /* Argument to OVS_ACTION_ATTR_USERSPACE. */
 245 };
 246
 247 int dpif_recv_get_mask(const struct dpif *, int *listen_mask);
 248 int dpif_recv_set_mask(struct dpif *, int listen_mask);
 249 int dpif_recv(struct dpif *, struct dpif_upcall *);
 250 void dpif_recv_purge(struct dpif *);
 251 void dpif_recv_wait(struct dpif *);
 252 \f
 253 /* Miscellaneous. */
 254
 255 void dpif_get_netflow_ids(const struct dpif *,
 256                           uint8_t *engine_type, uint8_t *engine_id);
 257
 258 int dpif_queue_to_priority(const struct dpif *, uint32_t queue_id,
 259                            uint32_t *priority);
 260
 261 #ifdef  __cplusplus
 262 }
 263 #endif
 264
 265 #endif /* dpif.h */