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 "openflow/openflow.h"
  25 #include "openvswitch/datapath-protocol.h"
  26 #include "util.h"
  27
  28 #ifdef  __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 struct dpif;
  33 struct ds;
  34 struct netdev;
  35 struct nlattr;
  36 struct ofpbuf;
  37 struct sset;
  38 struct dpif_class;
  39
  40 int dp_register_provider(const struct dpif_class *);
  41 int dp_unregister_provider(const char *type);
  42 void dp_enumerate_types(struct sset *types);
  43
  44 int dp_enumerate_names(const char *type, struct sset *names);
  45 void dp_parse_name(const char *datapath_name, char **name, char **type);
  46
  47 int dpif_open(const char *name, const char *type, struct dpif **);
  48 int dpif_create(const char *name, const char *type, struct dpif **);
  49 int dpif_create_and_open(const char *name, const char *type, struct dpif **);
  50 void dpif_close(struct dpif *);
  51
  52 void dpif_run(struct dpif *);
  53 void dpif_wait(struct dpif *);
  54
  55 const char *dpif_name(const struct dpif *);
  56 const char *dpif_base_name(const struct dpif *);
  57
  58 const char *dpif_normalize_type(const char *);
  59
  60 int dpif_delete(struct dpif *);
  61
  62 int dpif_get_dp_stats(const struct dpif *, struct odp_stats *);
  63 int dpif_get_drop_frags(const struct dpif *, bool *drop_frags);
  64 int dpif_set_drop_frags(struct dpif *, bool drop_frags);
  65
  66 int dpif_port_add(struct dpif *, struct netdev *, uint16_t *port_nop);
  67 int dpif_port_del(struct dpif *, uint16_t port_no);
  68
  69 /* A port within a datapath.
  70  *
  71  * 'name' and 'type' are suitable for passing to netdev_open(). */
  72 struct dpif_port {
  73     char *name;                 /* Network device name, e.g. "eth0". */
  74     char *type;                 /* Network device type, e.g. "system". */
  75     uint32_t port_no;           /* Port number within datapath. */
  76 };
  77 void dpif_port_clone(struct dpif_port *, const struct dpif_port *);
  78 void dpif_port_destroy(struct dpif_port *);
  79 int dpif_port_query_by_number(const struct dpif *, uint16_t port_no,
  80                               struct dpif_port *);
  81 int dpif_port_query_by_name(const struct dpif *, const char *devname,
  82                             struct dpif_port *);
  83 int dpif_port_get_name(struct dpif *, uint16_t port_no,
  84                        char *name, size_t name_size);
  85 int dpif_get_max_ports(const struct dpif *);
  86
  87 struct dpif_port_dump {
  88     const struct dpif *dpif;
  89     int error;
  90     void *state;
  91 };
  92 void dpif_port_dump_start(struct dpif_port_dump *, const struct dpif *);
  93 bool dpif_port_dump_next(struct dpif_port_dump *, struct dpif_port *);
  94 int dpif_port_dump_done(struct dpif_port_dump *);
  95
  96 /* Iterates through each DPIF_PORT in DPIF, using DUMP as state.
  97  *
  98  * Arguments all have pointer type.
  99  *
 100  * If you break out of the loop, then you need to free the dump structure by
 101  * hand using dpif_port_dump_done(). */
 102 #define DPIF_PORT_FOR_EACH(DPIF_PORT, DUMP, DPIF)   \
 103     for (dpif_port_dump_start(DUMP, DPIF);          \
 104          (dpif_port_dump_next(DUMP, DPIF_PORT)      \
 105           ? true                                    \
 106           : (dpif_port_dump_done(DUMP), false));    \
 107         )
 108
 109 int dpif_port_poll(const struct dpif *, char **devnamep);
 110 void dpif_port_poll_wait(const struct dpif *);
 111
 112 struct dpif_flow_stats {
 113     uint64_t n_packets;
 114     uint64_t n_bytes;
 115     long long int used;
 116     uint8_t tcp_flags;
 117 };
 118
 119 void dpif_flow_stats_format(const struct dpif_flow_stats *, struct ds *);
 120
 121 enum dpif_flow_put_flags {
 122     DPIF_FP_CREATE = 1 << 0,    /* Allow creating a new flow. */
 123     DPIF_FP_MODIFY = 1 << 1,    /* Allow modifying an existing flow. */
 124     DPIF_FP_ZERO_STATS = 1 << 2 /* Zero the stats of an existing flow. */
 125 };
 126
 127 int dpif_flow_flush(struct dpif *);
 128 int dpif_flow_put(struct dpif *, enum dpif_flow_put_flags,
 129                   const struct nlattr *key, size_t key_len,
 130                   const struct nlattr *actions, size_t actions_len,
 131                   struct dpif_flow_stats *);
 132 int dpif_flow_del(struct dpif *,
 133                   const struct nlattr *key, size_t key_len,
 134                   struct dpif_flow_stats *);
 135 int dpif_flow_get(const struct dpif *,
 136                   const struct nlattr *key, size_t key_len,
 137                   struct ofpbuf **actionsp, struct dpif_flow_stats *);
 138
 139 struct dpif_flow_dump {
 140     const struct dpif *dpif;
 141     int error;
 142     void *state;
 143 };
 144 void dpif_flow_dump_start(struct dpif_flow_dump *, const struct dpif *);
 145 bool dpif_flow_dump_next(struct dpif_flow_dump *,
 146                          const struct nlattr **key, size_t *key_len,
 147                          const struct nlattr **actions, size_t *actions_len,
 148                          const struct dpif_flow_stats **);
 149 int dpif_flow_dump_done(struct dpif_flow_dump *);
 150
 151 int dpif_execute(struct dpif *, const struct nlattr *actions,
 152                  size_t actions_len, const struct ofpbuf *);
 153
 154 enum dpif_upcall_type {
 155     DPIF_UC_MISS,               /* Miss in flow table. */
 156     DPIF_UC_ACTION,             /* ODP_ACTION_ATTR_CONTROLLER action. */
 157     DPIF_UC_SAMPLE,             /* Packet sampling. */
 158     DPIF_N_UC_TYPES
 159 };
 160
 161 /* A packet passed up from the datapath to userspace.
 162  *
 163  * If 'key' or 'actions' is nonnull, then it points into data owned by
 164  * 'packet', so their memory cannot be freed separately.  (This is hardly a
 165  * great way to do things but it works out OK for the dpif providers and
 166  * clients that exist so far.)
 167  */
 168 struct dpif_upcall {
 169     /* All types. */
 170     enum dpif_upcall_type type;
 171     struct ofpbuf *packet;      /* Packet data. */
 172     struct nlattr *key;         /* Flow key. */
 173     size_t key_len;             /* Length of 'key' in bytes. */
 174
 175     /* DPIF_UC_ACTION only. */
 176     uint64_t userdata;          /* Argument to ODP_ACTION_ATTR_CONTROLLER. */
 177
 178     /* DPIF_UC_SAMPLE only. */
 179     uint32_t sample_pool;       /* # of sampling candidate packets so far. */
 180     struct nlattr *actions;     /* Associated flow actions. */
 181     size_t actions_len;
 182 };
 183
 184 int dpif_recv_get_mask(const struct dpif *, int *listen_mask);
 185 int dpif_recv_set_mask(struct dpif *, int listen_mask);
 186 int dpif_get_sflow_probability(const struct dpif *, uint32_t *probability);
 187 int dpif_set_sflow_probability(struct dpif *, uint32_t probability);
 188 int dpif_recv(struct dpif *, struct dpif_upcall *);
 189 void dpif_recv_purge(struct dpif *);
 190 void dpif_recv_wait(struct dpif *);
 191
 192 void dpif_get_netflow_ids(const struct dpif *,
 193                           uint8_t *engine_type, uint8_t *engine_id);
 194
 195 int dpif_queue_to_priority(const struct dpif *, uint32_t queue_id,
 196                            uint32_t *priority);
 197
 198 #ifdef  __cplusplus
 199 }
 200 #endif
 201
 202 #endif /* dpif.h */