2 * Copyright (c) 2009, 2010 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #ifndef DPIF_PROVIDER_H
18 #define DPIF_PROVIDER_H 1
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. */
26 #include "openflow/openflow.h"
34 /* Open vSwitch datapath interface.
36 * This structure should be treated as opaque by dpif implementations. */
38 const struct dpif_class *dpif_class;
41 uint8_t netflow_engine_type;
42 uint8_t netflow_engine_id;
45 void dpif_init(struct dpif *, const struct dpif_class *, const char *name,
46 uint8_t netflow_engine_type, uint8_t netflow_engine_id);
47 void dpif_uninit(struct dpif *dpif, bool close);
49 static inline void dpif_assert_class(const struct dpif *dpif,
50 const struct dpif_class *dpif_class)
52 assert(dpif->dpif_class == dpif_class);
55 /* Datapath interface class structure, to be defined by each implementation of
56 * a datapath interface.
58 * These functions return 0 if successful or a positive errno value on failure,
59 * except where otherwise noted.
61 * These functions are expected to execute synchronously, that is, to block as
62 * necessary to obtain a result. Thus, they may not return EAGAIN or
63 * EWOULDBLOCK or EINPROGRESS. We may relax this requirement in the future if
64 * and when we encounter performance problems. */
66 /* Type of dpif in this class, e.g. "system", "netdev", etc.
68 * One of the providers should supply a "system" type, since this is
69 * the type assumed if no type is specified when opening a dpif. */
72 /* Performs periodic work needed by dpifs of this class, if any is
76 /* Arranges for poll_block() to wake up if the "run" member function needs
80 /* Enumerates the names of all known created datapaths, if possible, into
81 * 'all_dps'. The caller has already initialized 'all_dps' and other dpif
82 * classes might already have added names to it.
84 * This is used by the vswitch at startup, so that it can delete any
85 * datapaths that are not configured.
87 * Some kinds of datapaths might not be practically enumerable, in which
88 * case this function may be a null pointer. */
89 int (*enumerate)(struct svec *all_dps);
91 /* Attempts to open an existing dpif called 'name', if 'create' is false,
92 * or to open an existing dpif or create a new one, if 'create' is true.
94 * 'dpif_class' is the class of dpif to open.
96 * If successful, stores a pointer to the new dpif in '*dpifp', which must
97 * have class 'dpif_class'. On failure there are no requirements on what
98 * is stored in '*dpifp'. */
99 int (*open)(const struct dpif_class *dpif_class,
100 const char *name, bool create, struct dpif **dpifp);
102 /* Closes 'dpif' and frees associated memory. */
103 void (*close)(struct dpif *dpif);
105 /* Enumerates all names that may be used to open 'dpif' into 'all_names'.
106 * The Linux datapath, for example, supports opening a datapath both by
107 * number, e.g. "dp0", and by the name of the datapath's local port. For
108 * some datapaths, this might be an infinite set (e.g. in a file name,
109 * slashes may be duplicated any number of times), in which case only the
110 * names most likely to be used should be enumerated.
112 * The caller has already initialized 'all_names' and might already have
113 * added some names to it. This function should not disturb any existing
114 * names in 'all_names'.
116 * If a datapath class does not support multiple names for a datapath, this
117 * function may be a null pointer.
119 * This is used by the vswitch at startup, */
120 int (*get_all_names)(const struct dpif *dpif, struct svec *all_names);
122 /* Attempts to destroy the dpif underlying 'dpif'.
124 * If successful, 'dpif' will not be used again except as an argument for
125 * the 'close' member function. */
126 int (*destroy)(struct dpif *dpif);
128 /* Retrieves statistics for 'dpif' into 'stats'. */
129 int (*get_stats)(const struct dpif *dpif, struct odp_stats *stats);
131 /* Retrieves 'dpif''s current treatment of IP fragments into '*drop_frags':
132 * true indicates that fragments are dropped, false indicates that
133 * fragments are treated in the same way as other IP packets (except that
134 * the L4 header cannot be read). */
135 int (*get_drop_frags)(const struct dpif *dpif, bool *drop_frags);
137 /* Changes 'dpif''s treatment of IP fragments to 'drop_frags', whose
138 * meaning is the same as for the get_drop_frags member function. */
139 int (*set_drop_frags)(struct dpif *dpif, bool drop_frags);
141 /* Adds 'netdev' as a new port in 'dpif'. If successful, sets '*port_no'
142 * to the new port's port number. */
143 int (*port_add)(struct dpif *dpif, struct netdev *netdev,
146 /* Removes port numbered 'port_no' from 'dpif'. */
147 int (*port_del)(struct dpif *dpif, uint16_t port_no);
149 /* Queries 'dpif' for a port with the given 'port_no' or 'devname'. Stores
150 * information about the port into '*port' if successful.
152 * The caller takes ownership of data in 'port' and must free it with
153 * dpif_port_destroy() when it is no longer needed. */
154 int (*port_query_by_number)(const struct dpif *dpif, uint16_t port_no,
155 struct dpif_port *port);
156 int (*port_query_by_name)(const struct dpif *dpif, const char *devname,
157 struct dpif_port *port);
159 /* Attempts to begin dumping the ports in a dpif. On success, returns 0
160 * and initializes '*statep' with any data needed for iteration. On
161 * failure, returns a positive errno value. */
162 int (*port_dump_start)(const struct dpif *dpif, void **statep);
164 /* Attempts to retrieve another port from 'dpif' for 'state', which was
165 * initialized by a successful call to the 'port_dump_start' function for
166 * 'dpif'. On success, stores a new dpif_port into 'port' and returns 0.
167 * Returns EOF if the end of the port table has been reached, or a positive
168 * errno value on error. This function will not be called again once it
169 * returns nonzero once for a given iteration (but the 'port_dump_done'
170 * function will be called afterward).
172 * The dpif provider retains ownership of the data stored in 'port'. It
173 * must remain valid until at least the next call to 'port_dump_next' or
174 * 'port_dump_done' for 'state'. */
175 int (*port_dump_next)(const struct dpif *dpif, void *state,
176 struct dpif_port *port);
178 /* Releases resources from 'dpif' for 'state', which was initialized by a
179 * successful call to the 'port_dump_start' function for 'dpif'. */
180 int (*port_dump_done)(const struct dpif *dpif, void *state);
182 /* Polls for changes in the set of ports in 'dpif'. If the set of ports in
183 * 'dpif' has changed, then this function should do one of the
186 * - Preferably: store the name of the device that was added to or deleted
187 * from 'dpif' in '*devnamep' and return 0. The caller is responsible
188 * for freeing '*devnamep' (with free()) when it no longer needs it.
190 * - Alternatively: return ENOBUFS, without indicating the device that was
193 * Occasional 'false positives', in which the function returns 0 while
194 * indicating a device that was not actually added or deleted or returns
195 * ENOBUFS without any change, are acceptable.
197 * If the set of ports in 'dpif' has not changed, returns EAGAIN. May also
198 * return other positive errno values to indicate that something has gone
200 int (*port_poll)(const struct dpif *dpif, char **devnamep);
202 /* Arranges for the poll loop to wake up when 'port_poll' will return a
203 * value other than EAGAIN. */
204 void (*port_poll_wait)(const struct dpif *dpif);
206 /* For each flow 'flow' in the 'n' flows in 'flows':
208 * - If a flow matching 'flow->key' exists in 'dpif':
210 * Stores 0 into 'flow->stats.error' and stores statistics for the flow
211 * into 'flow->stats'.
213 * If 'flow->n_actions' is zero, then 'flow->actions' is ignored. If
214 * 'flow->n_actions' is nonzero, then 'flow->actions' should point to
215 * an array of the specified number of actions. At most that many of
216 * the flow's actions will be copied into that array.
217 * 'flow->n_actions' will be updated to the number of actions actually
218 * present in the flow, which may be greater than the number stored if
219 * the flow has more actions than space available in the array.
221 * - Flow-specific errors are indicated by a positive errno value in
222 * 'flow->stats.error'. In particular, ENOENT indicates that no flow
223 * matching 'flow->key' exists in 'dpif'. When an error value is stored,
224 * the contents of 'flow->key' are preserved but other members of 'flow'
225 * should be treated as indeterminate.
227 * Returns 0 if all 'n' flows in 'flows' were updated (whether they were
228 * individually successful or not is indicated by 'flow->stats.error',
229 * however). Returns a positive errno value if an error that prevented
230 * this update occurred, in which the caller must not depend on any
231 * elements in 'flows' being updated or not updated.
233 int (*flow_get)(const struct dpif *dpif, struct odp_flow flows[], int n);
235 /* Adds or modifies a flow in 'dpif' as specified in 'put':
237 * - If the flow specified in 'put->flow' does not exist in 'dpif', then
238 * behavior depends on whether ODPPF_CREATE is specified in 'put->flags':
239 * if it is, the flow will be added, otherwise the operation will fail
242 * - Otherwise, the flow specified in 'put->flow' does exist in 'dpif'.
243 * Behavior in this case depends on whether ODPPF_MODIFY is specified in
244 * 'put->flags': if it is, the flow's actions will be updated, otherwise
245 * the operation will fail with EEXIST. If the flow's actions are
246 * updated, then its statistics will be zeroed if ODPPF_ZERO_STATS is set
247 * in 'put->flags', left as-is otherwise.
249 int (*flow_put)(struct dpif *dpif, struct odp_flow_put *put);
251 /* Deletes a flow matching 'flow->key' from 'dpif' or returns ENOENT if
252 * 'dpif' does not contain such a flow.
254 * If successful, updates 'flow->stats', 'flow->n_actions', and
255 * 'flow->actions' as described in more detail under the flow_get member
257 int (*flow_del)(struct dpif *dpif, struct odp_flow *flow);
259 /* Deletes all flows from 'dpif' and clears all of its queues of received
261 int (*flow_flush)(struct dpif *dpif);
263 /* Attempts to begin dumping the flows in a dpif. On success, returns 0
264 * and initializes '*statep' with any data needed for iteration. On
265 * failure, returns a positive errno value. */
266 int (*flow_dump_start)(const struct dpif *dpif, void **statep);
268 /* Attempts to retrieve another flow from 'dpif' for 'state', which was
269 * initialized by a successful call to the 'flow_dump_start' function for
270 * 'dpif'. On success, stores a new odp_flow into 'flow' and returns 0.
271 * Returns EOF if the end of the flow table has been reached, or a positive
272 * errno value on error. This function will not be called again once it
273 * returns nonzero once for a given iteration (but the 'flow_dump_done'
274 * function will be called afterward).
276 * Dumping flow actions is optional. If the caller does not want to dump
277 * actions it will initialize 'flow->actions' to NULL and
278 * 'flow->actions_len' to 0. Otherwise, 'flow->actions' points to an array
279 * of struct nlattr and 'flow->actions_len' contains the number of bytes of
280 * Netlink attributes. The implemention should fill in as many actions as
281 * will fit into the provided array and update 'flow->actions_len' with the
282 * number of bytes required (regardless of whether they fit in the provided
284 int (*flow_dump_next)(const struct dpif *dpif, void *state,
285 struct odp_flow *flow);
287 /* Releases resources from 'dpif' for 'state', which was initialized by a
288 * successful call to the 'flow_dump_start' function for 'dpif'. */
289 int (*flow_dump_done)(const struct dpif *dpif, void *state);
291 /* Performs the 'actions_len' bytes of actions in 'actions' on the Ethernet
292 * frame specified in 'packet'. */
293 int (*execute)(struct dpif *dpif, const struct nlattr *actions,
294 size_t actions_len, const struct ofpbuf *packet);
296 /* Retrieves 'dpif''s "listen mask" into '*listen_mask'. Each ODPL_* bit
297 * set in '*listen_mask' indicates the 'dpif' will receive messages of the
298 * corresponding type when it calls the recv member function. */
299 int (*recv_get_mask)(const struct dpif *dpif, int *listen_mask);
301 /* Sets 'dpif''s "listen mask" to 'listen_mask'. Each ODPL_* bit set in
302 * 'listen_mask' indicates the 'dpif' will receive messages of the
303 * corresponding type when it calls the recv member function. */
304 int (*recv_set_mask)(struct dpif *dpif, int listen_mask);
306 /* Retrieves 'dpif''s sFlow sampling probability into '*probability'.
307 * Return value is 0 or a positive errno value. EOPNOTSUPP indicates that
308 * the datapath does not support sFlow, as does a null pointer.
310 * '*probability' is expressed as the number of packets out of UINT_MAX to
311 * sample, e.g. probability/UINT_MAX is the probability of sampling a given
313 int (*get_sflow_probability)(const struct dpif *dpif,
314 uint32_t *probability);
316 /* Sets 'dpif''s sFlow sampling probability to 'probability'. Return value
317 * is 0 or a positive errno value. EOPNOTSUPP indicates that the datapath
318 * does not support sFlow, as does a null pointer.
320 * 'probability' is expressed as the number of packets out of UINT_MAX to
321 * sample, e.g. probability/UINT_MAX is the probability of sampling a given
323 int (*set_sflow_probability)(struct dpif *dpif, uint32_t probability);
325 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a
326 * priority value for use in the ODPAT_SET_PRIORITY action in
328 int (*queue_to_priority)(const struct dpif *dpif, uint32_t queue_id,
331 /* Polls for an upcall from 'dpif'. If successful, stores the upcall into
332 * '*upcall'. Only upcalls of the types selected with the set_listen_mask
333 * member function should be received.
335 * The caller takes ownership of the data that 'upcall' points to.
336 * 'upcall->key' and 'upcall->actions' (if nonnull) point into data owned
337 * by 'upcall->packet', so their memory cannot be freed separately. (This
338 * is hardly a great way to do things but it works out OK for the dpif
339 * providers that exist so far.)
341 * For greatest efficiency, 'upcall->packet' should have at least
342 * offsetof(struct ofp_packet_in, data) bytes of headroom.
344 * This function must not block. If no upcall is pending when it is
345 * called, it should return EAGAIN without blocking. */
346 int (*recv)(struct dpif *dpif, struct dpif_upcall *upcall);
348 /* Arranges for the poll loop to wake up when 'dpif' has a message queued
349 * to be received with the recv member function. */
350 void (*recv_wait)(struct dpif *dpif);
353 extern const struct dpif_class dpif_linux_class;
354 extern const struct dpif_class dpif_netdev_class;
360 #endif /* dpif-provider.h */