Branch data Line data Source code
1 : : /*
2 : : * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 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 : : #ifndef DPIF_PROVIDER_H
18 : : #define DPIF_PROVIDER_H 1
19 : :
20 : : /* Provider interface to dpifs, which provide an interface to an Open vSwitch
21 : : * datapath. A datapath is a collection of physical or virtual ports that are
22 : : * exposed over OpenFlow as a single switch. Datapaths and the collections of
23 : : * ports that they contain may be fixed or dynamic. */
24 : :
25 : : #include "openflow/openflow.h"
26 : : #include "dpif.h"
27 : : #include "util.h"
28 : :
29 : : #ifdef __cplusplus
30 : : extern "C" {
31 : : #endif
32 : :
33 : : /* Open vSwitch datapath interface.
34 : : *
35 : : * This structure should be treated as opaque by dpif implementations. */
36 : : struct dpif {
37 : : const struct dpif_class *dpif_class;
38 : : char *base_name;
39 : : char *full_name;
40 : : uint8_t netflow_engine_type;
41 : : uint8_t netflow_engine_id;
42 : : };
43 : :
44 : : void dpif_init(struct dpif *, const struct dpif_class *, const char *name,
45 : : uint8_t netflow_engine_type, uint8_t netflow_engine_id);
46 : : void dpif_uninit(struct dpif *dpif, bool close);
47 : :
48 : 39865 : static inline void dpif_assert_class(const struct dpif *dpif,
49 : : const struct dpif_class *dpif_class)
50 : : {
51 [ - + ]: 39865 : ovs_assert(dpif->dpif_class == dpif_class);
52 : 39865 : }
53 : :
54 : : struct dpif_flow_dump {
55 : : struct dpif *dpif;
56 : : bool terse; /* If true, key/mask/actions may be omitted. */
57 : : };
58 : :
59 : : static inline void
60 : 28196 : dpif_flow_dump_init(struct dpif_flow_dump *dump, const struct dpif *dpif)
61 : : {
62 : 28196 : dump->dpif = CONST_CAST(struct dpif *, dpif);
63 : 28196 : }
64 : :
65 : : struct dpif_flow_dump_thread {
66 : : struct dpif *dpif;
67 : : };
68 : :
69 : : static inline void
70 : 28199 : dpif_flow_dump_thread_init(struct dpif_flow_dump_thread *thread,
71 : : struct dpif_flow_dump *dump)
72 : : {
73 : 28199 : thread->dpif = dump->dpif;
74 : 28199 : }
75 : :
76 : : struct ct_dpif_dump_state;
77 : : struct ct_dpif_entry;
78 : :
79 : : /* Datapath interface class structure, to be defined by each implementation of
80 : : * a datapath interface.
81 : : *
82 : : * These functions return 0 if successful or a positive errno value on failure,
83 : : * except where otherwise noted.
84 : : *
85 : : * These functions are expected to execute synchronously, that is, to block as
86 : : * necessary to obtain a result. Thus, they may not return EAGAIN or
87 : : * EWOULDBLOCK or EINPROGRESS. We may relax this requirement in the future if
88 : : * and when we encounter performance problems. */
89 : : struct dpif_class {
90 : : /* Type of dpif in this class, e.g. "system", "netdev", etc.
91 : : *
92 : : * One of the providers should supply a "system" type, since this is
93 : : * the type assumed if no type is specified when opening a dpif. */
94 : : const char *type;
95 : :
96 : : /* Called when the dpif provider is registered, typically at program
97 : : * startup. Returning an error from this function will prevent any
98 : : * datapath with this class from being created.
99 : : *
100 : : * This function may be set to null if a datapath class needs no
101 : : * initialization at registration time. */
102 : : int (*init)(void);
103 : :
104 : : /* Enumerates the names of all known created datapaths (of class
105 : : * 'dpif_class'), if possible, into 'all_dps'. The caller has already
106 : : * initialized 'all_dps' and other dpif classes might already have added
107 : : * names to it.
108 : : *
109 : : * This is used by the vswitch at startup, so that it can delete any
110 : : * datapaths that are not configured.
111 : : *
112 : : * Some kinds of datapaths might not be practically enumerable, in which
113 : : * case this function may be a null pointer. */
114 : : int (*enumerate)(struct sset *all_dps, const struct dpif_class *dpif_class);
115 : :
116 : : /* Returns the type to pass to netdev_open() when a dpif of class
117 : : * 'dpif_class' has a port of type 'type', for a few special cases
118 : : * when a netdev type differs from a port type. For example, when
119 : : * using the userspace datapath, a port of type "internal" needs to
120 : : * be opened as "tap".
121 : : *
122 : : * Returns either 'type' itself or a string literal, which must not
123 : : * be freed. */
124 : : const char *(*port_open_type)(const struct dpif_class *dpif_class,
125 : : const char *type);
126 : :
127 : : /* Attempts to open an existing dpif called 'name', if 'create' is false,
128 : : * or to open an existing dpif or create a new one, if 'create' is true.
129 : : *
130 : : * 'dpif_class' is the class of dpif to open.
131 : : *
132 : : * If successful, stores a pointer to the new dpif in '*dpifp', which must
133 : : * have class 'dpif_class'. On failure there are no requirements on what
134 : : * is stored in '*dpifp'. */
135 : : int (*open)(const struct dpif_class *dpif_class,
136 : : const char *name, bool create, struct dpif **dpifp);
137 : :
138 : : /* Closes 'dpif' and frees associated memory. */
139 : : void (*close)(struct dpif *dpif);
140 : :
141 : : /* Attempts to destroy the dpif underlying 'dpif'.
142 : : *
143 : : * If successful, 'dpif' will not be used again except as an argument for
144 : : * the 'close' member function. */
145 : : int (*destroy)(struct dpif *dpif);
146 : :
147 : : /* Performs periodic work needed by 'dpif', if any is necessary.
148 : : * Returns true if need to revalidate. */
149 : : bool (*run)(struct dpif *dpif);
150 : :
151 : : /* Arranges for poll_block() to wake up if the "run" member function needs
152 : : * to be called for 'dpif'. */
153 : : void (*wait)(struct dpif *dpif);
154 : :
155 : : /* Retrieves statistics for 'dpif' into 'stats'. */
156 : : int (*get_stats)(const struct dpif *dpif, struct dpif_dp_stats *stats);
157 : :
158 : : /* Adds 'netdev' as a new port in 'dpif'. If '*port_no' is not
159 : : * UINT32_MAX, attempts to use that as the port's port number.
160 : : *
161 : : * If port is successfully added, sets '*port_no' to the new port's
162 : : * port number. Returns EBUSY if caller attempted to choose a port
163 : : * number, and it was in use. */
164 : : int (*port_add)(struct dpif *dpif, struct netdev *netdev,
165 : : odp_port_t *port_no);
166 : :
167 : : /* Removes port numbered 'port_no' from 'dpif'. */
168 : : int (*port_del)(struct dpif *dpif, odp_port_t port_no);
169 : :
170 : : /* Refreshes configuration of 'dpif's port. The implementation might
171 : : * postpone applying the changes until run() is called. */
172 : : int (*port_set_config)(struct dpif *dpif, odp_port_t port_no,
173 : : const struct smap *cfg);
174 : :
175 : : /* Queries 'dpif' for a port with the given 'port_no' or 'devname'.
176 : : * If 'port' is not null, stores information about the port into
177 : : * '*port' if successful.
178 : : *
179 : : * If 'port' is not null, the caller takes ownership of data in
180 : : * 'port' and must free it with dpif_port_destroy() when it is no
181 : : * longer needed. */
182 : : int (*port_query_by_number)(const struct dpif *dpif, odp_port_t port_no,
183 : : struct dpif_port *port);
184 : : int (*port_query_by_name)(const struct dpif *dpif, const char *devname,
185 : : struct dpif_port *port);
186 : :
187 : : /* Returns the Netlink PID value to supply in OVS_ACTION_ATTR_USERSPACE
188 : : * actions as the OVS_USERSPACE_ATTR_PID attribute's value, for use in
189 : : * flows whose packets arrived on port 'port_no'. In the case where the
190 : : * provider allocates multiple Netlink PIDs to a single port, it may use
191 : : * 'hash' to spread load among them. The caller need not use a particular
192 : : * hash function; a 5-tuple hash is suitable.
193 : : *
194 : : * (The datapath implementation might use some different hash function for
195 : : * distributing packets received via flow misses among PIDs. This means
196 : : * that packets received via flow misses might be reordered relative to
197 : : * packets received via userspace actions. This is not ordinarily a
198 : : * problem.)
199 : : *
200 : : * A 'port_no' of UINT32_MAX should be treated as a special case. The
201 : : * implementation should return a reserved PID, not allocated to any port,
202 : : * that the client may use for special purposes.
203 : : *
204 : : * The return value only needs to be meaningful when DPIF_UC_ACTION has
205 : : * been enabled in the 'dpif''s listen mask, and it is allowed to change
206 : : * when DPIF_UC_ACTION is disabled and then re-enabled.
207 : : *
208 : : * A dpif provider that doesn't have meaningful Netlink PIDs can use NULL
209 : : * for this function. This is equivalent to always returning 0. */
210 : : uint32_t (*port_get_pid)(const struct dpif *dpif, odp_port_t port_no,
211 : : uint32_t hash);
212 : :
213 : : /* Attempts to begin dumping the ports in a dpif. On success, returns 0
214 : : * and initializes '*statep' with any data needed for iteration. On
215 : : * failure, returns a positive errno value. */
216 : : int (*port_dump_start)(const struct dpif *dpif, void **statep);
217 : :
218 : : /* Attempts to retrieve another port from 'dpif' for 'state', which was
219 : : * initialized by a successful call to the 'port_dump_start' function for
220 : : * 'dpif'. On success, stores a new dpif_port into 'port' and returns 0.
221 : : * Returns EOF if the end of the port table has been reached, or a positive
222 : : * errno value on error. This function will not be called again once it
223 : : * returns nonzero once for a given iteration (but the 'port_dump_done'
224 : : * function will be called afterward).
225 : : *
226 : : * The dpif provider retains ownership of the data stored in 'port'. It
227 : : * must remain valid until at least the next call to 'port_dump_next' or
228 : : * 'port_dump_done' for 'state'. */
229 : : int (*port_dump_next)(const struct dpif *dpif, void *state,
230 : : struct dpif_port *port);
231 : :
232 : : /* Releases resources from 'dpif' for 'state', which was initialized by a
233 : : * successful call to the 'port_dump_start' function for 'dpif'. */
234 : : int (*port_dump_done)(const struct dpif *dpif, void *state);
235 : :
236 : : /* Polls for changes in the set of ports in 'dpif'. If the set of ports in
237 : : * 'dpif' has changed, then this function should do one of the
238 : : * following:
239 : : *
240 : : * - Preferably: store the name of the device that was added to or deleted
241 : : * from 'dpif' in '*devnamep' and return 0. The caller is responsible
242 : : * for freeing '*devnamep' (with free()) when it no longer needs it.
243 : : *
244 : : * - Alternatively: return ENOBUFS, without indicating the device that was
245 : : * added or deleted.
246 : : *
247 : : * Occasional 'false positives', in which the function returns 0 while
248 : : * indicating a device that was not actually added or deleted or returns
249 : : * ENOBUFS without any change, are acceptable.
250 : : *
251 : : * If the set of ports in 'dpif' has not changed, returns EAGAIN. May also
252 : : * return other positive errno values to indicate that something has gone
253 : : * wrong. */
254 : : int (*port_poll)(const struct dpif *dpif, char **devnamep);
255 : :
256 : : /* Arranges for the poll loop to wake up when 'port_poll' will return a
257 : : * value other than EAGAIN. */
258 : : void (*port_poll_wait)(const struct dpif *dpif);
259 : :
260 : : /* Deletes all flows from 'dpif' and clears all of its queues of received
261 : : * packets. */
262 : : int (*flow_flush)(struct dpif *dpif);
263 : :
264 : : /* Flow dumping interface.
265 : : *
266 : : * This is the back-end for the flow dumping interface described in
267 : : * dpif.h. Please read the comments there first, because this code
268 : : * closely follows it.
269 : : *
270 : : * 'flow_dump_create' and 'flow_dump_thread_create' must always return an
271 : : * initialized and usable data structure and defer error return until
272 : : * flow_dump_destroy(). This hasn't been a problem for the dpifs that
273 : : * exist so far.
274 : : *
275 : : * 'flow_dump_create' and 'flow_dump_thread_create' must initialize the
276 : : * structures that they return with dpif_flow_dump_init() and
277 : : * dpif_flow_dump_thread_init(), respectively.
278 : : *
279 : : * If 'terse' is true, then only UID and statistics will
280 : : * be returned in the dump. Otherwise, all fields will be returned. */
281 : : struct dpif_flow_dump *(*flow_dump_create)(const struct dpif *dpif,
282 : : bool terse);
283 : : int (*flow_dump_destroy)(struct dpif_flow_dump *dump);
284 : :
285 : : struct dpif_flow_dump_thread *(*flow_dump_thread_create)(
286 : : struct dpif_flow_dump *dump);
287 : : void (*flow_dump_thread_destroy)(struct dpif_flow_dump_thread *thread);
288 : :
289 : : int (*flow_dump_next)(struct dpif_flow_dump_thread *thread,
290 : : struct dpif_flow *flows, int max_flows);
291 : :
292 : : /* Executes each of the 'n_ops' operations in 'ops' on 'dpif', in the order
293 : : * in which they are specified, placing each operation's results in the
294 : : * "output" members documented in comments and the 'error' member of each
295 : : * dpif_op. */
296 : : void (*operate)(struct dpif *dpif, struct dpif_op **ops, size_t n_ops);
297 : :
298 : : /* Enables or disables receiving packets with dpif_recv() for 'dpif'.
299 : : * Turning packet receive off and then back on is allowed to change Netlink
300 : : * PID assignments (see ->port_get_pid()). The client is responsible for
301 : : * updating flows as necessary if it does this. */
302 : : int (*recv_set)(struct dpif *dpif, bool enable);
303 : :
304 : : /* Refreshes the poll loops and Netlink sockets associated to each port,
305 : : * when the number of upcall handlers (upcall receiving thread) is changed
306 : : * to 'n_handlers' and receiving packets for 'dpif' is enabled by
307 : : * recv_set().
308 : : *
309 : : * Since multiple upcall handlers can read upcalls simultaneously from
310 : : * 'dpif', each port can have multiple Netlink sockets, one per upcall
311 : : * handler. So, handlers_set() is responsible for the following tasks:
312 : : *
313 : : * When receiving upcall is enabled, extends or creates the
314 : : * configuration to support:
315 : : *
316 : : * - 'n_handlers' Netlink sockets for each port.
317 : : *
318 : : * - 'n_handlers' poll loops, one for each upcall handler.
319 : : *
320 : : * - registering the Netlink sockets for the same upcall handler to
321 : : * the corresponding poll loop.
322 : : * */
323 : : int (*handlers_set)(struct dpif *dpif, uint32_t n_handlers);
324 : :
325 : : /* If 'dpif' creates its own I/O polling threads, refreshes poll threads
326 : : * configuration. 'cmask' configures the cpu mask for setting the polling
327 : : * threads' cpu affinity. The implementation might postpone applying the
328 : : * changes until run() is called. */
329 : : int (*poll_threads_set)(struct dpif *dpif, const char *cmask);
330 : :
331 : : /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a
332 : : * priority value used for setting packet priority. */
333 : : int (*queue_to_priority)(const struct dpif *dpif, uint32_t queue_id,
334 : : uint32_t *priority);
335 : :
336 : : /* Polls for an upcall from 'dpif' for an upcall handler. Since there
337 : : * can be multiple poll loops (see ->handlers_set()), 'handler_id' is
338 : : * needed as index to identify the corresponding poll loop. If
339 : : * successful, stores the upcall into '*upcall', using 'buf' for
340 : : * storage. Should only be called if 'recv_set' has been used to enable
341 : : * receiving packets from 'dpif'.
342 : : *
343 : : * The implementation should point 'upcall->key' and 'upcall->userdata'
344 : : * (if any) into data in the caller-provided 'buf'. The implementation may
345 : : * also use 'buf' for storing the data of 'upcall->packet'. If necessary
346 : : * to make room, the implementation may reallocate the data in 'buf'.
347 : : *
348 : : * The caller owns the data of 'upcall->packet' and may modify it. If
349 : : * packet's headroom is exhausted as it is manipulated, 'upcall->packet'
350 : : * will be reallocated. This requires the data of 'upcall->packet' to be
351 : : * released with ofpbuf_uninit() before 'upcall' is destroyed. However,
352 : : * when an error is returned, the 'upcall->packet' may be uninitialized
353 : : * and should not be released.
354 : : *
355 : : * This function must not block. If no upcall is pending when it is
356 : : * called, it should return EAGAIN without blocking. */
357 : : int (*recv)(struct dpif *dpif, uint32_t handler_id,
358 : : struct dpif_upcall *upcall, struct ofpbuf *buf);
359 : :
360 : : /* Arranges for the poll loop for an upcall handler to wake up when 'dpif'
361 : : * has a message queued to be received with the recv member functions.
362 : : * Since there can be multiple poll loops (see ->handlers_set()),
363 : : * 'handler_id' is needed as index to identify the corresponding poll loop.
364 : : * */
365 : : void (*recv_wait)(struct dpif *dpif, uint32_t handler_id);
366 : :
367 : : /* Throws away any queued upcalls that 'dpif' currently has ready to
368 : : * return. */
369 : : void (*recv_purge)(struct dpif *dpif);
370 : :
371 : : /* When 'dpif' is about to purge the datapath, the higher layer may want
372 : : * to be notified so that it could try reacting accordingly (e.g. grabbing
373 : : * all flow stats before they are gone).
374 : : *
375 : : * Registers an upcall callback function with 'dpif'. This is only used
376 : : * if 'dpif' needs to notify the purging of datapath. 'aux' is passed to
377 : : * the callback on invocation. */
378 : : void (*register_dp_purge_cb)(struct dpif *, dp_purge_callback *, void *aux);
379 : :
380 : : /* For datapaths that run in userspace (i.e. dpif-netdev), threads polling
381 : : * for incoming packets can directly call upcall functions instead of
382 : : * offloading packet processing to separate handler threads. Datapaths
383 : : * that directly call upcall functions should use the functions below to
384 : : * to register an upcall function and enable / disable upcalls.
385 : : *
386 : : * Registers an upcall callback function with 'dpif'. This is only used
387 : : * if 'dpif' directly executes upcall functions. 'aux' is passed to the
388 : : * callback on invocation. */
389 : : void (*register_upcall_cb)(struct dpif *, upcall_callback *, void *aux);
390 : :
391 : : /* Enables upcalls if 'dpif' directly executes upcall functions. */
392 : : void (*enable_upcall)(struct dpif *);
393 : :
394 : : /* Disables upcalls if 'dpif' directly executes upcall functions. */
395 : : void (*disable_upcall)(struct dpif *);
396 : :
397 : : /* Get datapath version. Caller is responsible for freeing the string
398 : : * returned. */
399 : : char *(*get_datapath_version)(void);
400 : :
401 : : /* Conntrack entry dumping interface.
402 : : *
403 : : * These functions are used by ct-dpif.c to provide a datapath-agnostic
404 : : * dumping interface to the connection trackes provided by the
405 : : * datapaths.
406 : : *
407 : : * ct_dump_start() should put in '*state' a pointer to a newly allocated
408 : : * stucture that will be passed by the caller to ct_dump_next() and
409 : : * ct_dump_done(). If 'zone' is not NULL, only the entries in '*zone'
410 : : * should be dumped.
411 : : *
412 : : * ct_dump_next() should fill 'entry' with information from a connection
413 : : * and prepare to dump the next one on a subsequest invocation.
414 : : *
415 : : * ct_dump_done should perform any cleanup necessary (including
416 : : * deallocating the 'state' structure, if applicable). */
417 : : int (*ct_dump_start)(struct dpif *, struct ct_dpif_dump_state **state,
418 : : const uint16_t *zone);
419 : : int (*ct_dump_next)(struct dpif *, struct ct_dpif_dump_state *,
420 : : struct ct_dpif_entry *entry);
421 : : int (*ct_dump_done)(struct dpif *, struct ct_dpif_dump_state *state);
422 : :
423 : : /* Flushes the connection tracking tables. If 'zone' is not NULL,
424 : : * only deletes connections in '*zone'. */
425 : : int (*ct_flush)(struct dpif *, const uint16_t *zone);
426 : : };
427 : :
428 : : extern const struct dpif_class dpif_netlink_class;
429 : : extern const struct dpif_class dpif_netdev_class;
430 : :
431 : : #ifdef __cplusplus
432 : : }
433 : : #endif
434 : :
435 : : #endif /* dpif-provider.h */
|
