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