]>
Commit | Line | Data |
---|---|---|
8b61709d | 1 | /* |
275707c3 | 2 | * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc. |
8b61709d BP |
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 NETDEV_PROVIDER_H | |
18 | #define NETDEV_PROVIDER_H 1 | |
19 | ||
20 | /* Generic interface to network devices. */ | |
21 | ||
8b61709d BP |
22 | #include "netdev.h" |
23 | #include "list.h" | |
6c88d577 | 24 | #include "shash.h" |
79f1cbe9 | 25 | #include "smap.h" |
6c88d577 | 26 | |
6dfd0304 BP |
27 | #ifdef __cplusplus |
28 | extern "C" { | |
29 | #endif | |
30 | ||
149f577a | 31 | /* A network device (e.g. an Ethernet device). |
6c88d577 | 32 | * |
b5d57fc8 BP |
33 | * Network device implementations should treat this structure as opaque. */ |
34 | struct netdev { | |
149f577a | 35 | char *name; /* Name of network device. */ |
d295e8e9 | 36 | const struct netdev_class *netdev_class; /* Functions to control |
a4af0040 | 37 | this device. */ |
149f577a JG |
38 | int ref_cnt; /* Times this devices was opened. */ |
39 | struct shash_node *node; /* Pointer to element in global map. */ | |
4b609110 | 40 | struct list saved_flags_list; /* Contains "struct netdev_saved_flags". */ |
6c88d577 JP |
41 | }; |
42 | ||
b5d57fc8 BP |
43 | void netdev_init(struct netdev *, const char *name, |
44 | const struct netdev_class *); | |
45 | void netdev_uninit(struct netdev *, bool destroy); | |
46 | const char *netdev_get_type(const struct netdev *); | |
47 | const struct netdev_class *netdev_get_class(const struct netdev *); | |
48 | const char *netdev_get_name(const struct netdev *); | |
49 | struct netdev *netdev_from_name(const char *name); | |
50 | void netdev_get_devices(const struct netdev_class *, | |
51 | struct shash *device_list); | |
149f577a | 52 | |
8b61709d BP |
53 | /* Network device class structure, to be defined by each implementation of a |
54 | * network device. | |
55 | * | |
56 | * These functions return 0 if successful or a positive errno value on failure, | |
57 | * except where otherwise noted. */ | |
58 | struct netdev_class { | |
6c88d577 | 59 | /* Type of netdevs in this class, e.g. "system", "tap", "gre", etc. |
8b61709d | 60 | * |
6c88d577 | 61 | * One of the providers should supply a "system" type, since this is |
149f577a JG |
62 | * the type assumed if no type is specified when opening a netdev. |
63 | * The "system" type corresponds to an existing network device on | |
64 | * the system. */ | |
6c88d577 | 65 | const char *type; |
8b61709d | 66 | |
77909859 JG |
67 | /* Called when the netdev provider is registered, typically at program |
68 | * startup. Returning an error from this function will prevent any network | |
69 | * device in this class from being opened. | |
8b61709d BP |
70 | * |
71 | * This function may be set to null if a network device class needs no | |
77909859 | 72 | * initialization at registration time. */ |
8b61709d BP |
73 | int (*init)(void); |
74 | ||
75 | /* Performs periodic work needed by netdevs of this class. May be null if | |
76 | * no periodic work is necessary. */ | |
77 | void (*run)(void); | |
78 | ||
79 | /* Arranges for poll_block() to wake up if the "run" member function needs | |
ac4d3bcb EJ |
80 | * to be called. Implementations are additionally required to wake |
81 | * whenever something changes in any of its netdevs which would cause their | |
82 | * ->change_seq() function to change its result. May be null if nothing is | |
83 | * needed here. */ | |
8b61709d BP |
84 | void (*wait)(void); |
85 | ||
de5cdb90 | 86 | /* Attempts to create a network device named 'name' in 'netdev_class'. On |
b5d57fc8 | 87 | * success sets 'netdevp' to the newly created device. */ |
b8dcf5e9 | 88 | int (*create)(const struct netdev_class *netdev_class, const char *name, |
b5d57fc8 | 89 | struct netdev **netdevp); |
149f577a | 90 | |
b5d57fc8 | 91 | /* Destroys 'netdev'. |
6c88d577 | 92 | * |
149f577a | 93 | * Netdev devices maintain a reference count that is incremented on |
b5d57fc8 | 94 | * netdev_open() and decremented on netdev_close(). If 'netdev' |
149f577a | 95 | * has a non-zero reference count, then this function will not be |
6c88d577 | 96 | * called. */ |
b5d57fc8 | 97 | void (*destroy)(struct netdev *netdev); |
6c88d577 | 98 | |
b5d57fc8 | 99 | /* Fetches the device 'netdev''s configuration, storing it in 'args'. |
79f1cbe9 | 100 | * The caller owns 'args' and pre-initializes it to an empty smap. |
6c88d577 | 101 | * |
de5cdb90 BP |
102 | * If this netdev class does not have any configuration options, this may |
103 | * be a null pointer. */ | |
b5d57fc8 | 104 | int (*get_config)(const struct netdev *netdev, struct smap *args); |
6c88d577 | 105 | |
b5d57fc8 | 106 | /* Changes the device 'netdev''s configuration to 'args'. |
aebf4235 | 107 | * |
de5cdb90 BP |
108 | * If this netdev class does not support configuration, this may be a null |
109 | * pointer. */ | |
b5d57fc8 | 110 | int (*set_config)(struct netdev *netdev, const struct smap *args); |
aebf4235 | 111 | |
b5d57fc8 | 112 | /* Returns the tunnel configuration of 'netdev'. If 'netdev' is |
f431bf7d EJ |
113 | * not a tunnel, returns null. |
114 | * | |
115 | * If this function would always return null, it may be null instead. */ | |
116 | const struct netdev_tunnel_config * | |
b5d57fc8 | 117 | (*get_tunnel_config)(const struct netdev *netdev); |
7b6b0ef4 | 118 | |
796223f5 BP |
119 | /* Attempts to open a netdev_rx for receiving packets from 'netdev'. |
120 | * Returns 0 if successful, otherwise a positive errno value. Returns | |
7b6b0ef4 BP |
121 | * EOPNOTSUPP to indicate that the network device does not implement packet |
122 | * reception through this interface. This function may be set to null if | |
123 | * it would always return EOPNOTSUPP anyhow. (This will prevent the | |
124 | * network device from being usefully used by the netdev-based "userspace | |
796223f5 | 125 | * datapath".) |
1ac98180 | 126 | * |
796223f5 BP |
127 | * On success, the implementation must set '*rxp' to a 'netdev_rx' for |
128 | * 'netdev' that it has already initialized (with netdev_rx_init()). */ | |
129 | int (*rx_open)(struct netdev *netdev, struct netdev_rx **rxp); | |
8b61709d | 130 | |
8b61709d BP |
131 | /* Sends the 'size'-byte packet in 'buffer' on 'netdev'. Returns 0 if |
132 | * successful, otherwise a positive errno value. Returns EAGAIN without | |
133 | * blocking if the packet cannot be queued immediately. Returns EMSGSIZE | |
134 | * if a partial packet was transmitted or if the packet is too big or too | |
135 | * small to transmit on the device. | |
136 | * | |
137 | * The caller retains ownership of 'buffer' in all cases. | |
138 | * | |
139 | * The network device is expected to maintain a packet transmission queue, | |
140 | * so that the caller does not ordinarily have to do additional queuing of | |
1ac98180 BP |
141 | * packets. |
142 | * | |
143 | * May return EOPNOTSUPP if a network device does not implement packet | |
144 | * transmission through this interface. This function may be set to null | |
195c8086 BP |
145 | * if it would always return EOPNOTSUPP anyhow. (This will prevent the |
146 | * network device from being usefully used by the netdev-based "userspace | |
76c308b5 BP |
147 | * datapath". It will also prevent the OVS implementation of bonding from |
148 | * working properly over 'netdev'.) */ | |
8b61709d BP |
149 | int (*send)(struct netdev *netdev, const void *buffer, size_t size); |
150 | ||
151 | /* Registers with the poll loop to wake up from the next call to | |
152 | * poll_block() when the packet transmission queue for 'netdev' has | |
153 | * sufficient room to transmit a packet with netdev_send(). | |
154 | * | |
155 | * The network device is expected to maintain a packet transmission queue, | |
156 | * so that the caller does not ordinarily have to do additional queuing of | |
1ac98180 BP |
157 | * packets. Thus, this function is unlikely to ever be useful. |
158 | * | |
159 | * May be null if not needed, such as for a network device that does not | |
160 | * implement packet transmission through the 'send' member function. */ | |
8b61709d BP |
161 | void (*send_wait)(struct netdev *netdev); |
162 | ||
163 | /* Sets 'netdev''s Ethernet address to 'mac' */ | |
164 | int (*set_etheraddr)(struct netdev *netdev, const uint8_t mac[6]); | |
165 | ||
33f1ff84 BP |
166 | /* Retrieves 'netdev''s Ethernet address into 'mac'. |
167 | * | |
168 | * This address will be advertised as 'netdev''s MAC address through the | |
169 | * OpenFlow protocol, among other uses. */ | |
8b61709d BP |
170 | int (*get_etheraddr)(const struct netdev *netdev, uint8_t mac[6]); |
171 | ||
172 | /* Retrieves 'netdev''s MTU into '*mtup'. | |
173 | * | |
174 | * The MTU is the maximum size of transmitted (and received) packets, in | |
175 | * bytes, not including the hardware header; thus, this is typically 1500 | |
f915f1a8 BP |
176 | * bytes for Ethernet devices. |
177 | * | |
178 | * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then | |
14622f22 BP |
179 | * this function should return EOPNOTSUPP. This function may be set to |
180 | * null if it would always return EOPNOTSUPP. */ | |
149f577a | 181 | int (*get_mtu)(const struct netdev *netdev, int *mtup); |
8b61709d | 182 | |
9b020780 PS |
183 | /* Sets 'netdev''s MTU to 'mtu'. |
184 | * | |
185 | * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then | |
14622f22 BP |
186 | * this function should return EOPNOTSUPP. This function may be set to |
187 | * null if it would always return EOPNOTSUPP. */ | |
9b020780 PS |
188 | int (*set_mtu)(const struct netdev *netdev, int mtu); |
189 | ||
9ab3d9a3 BP |
190 | /* Returns the ifindex of 'netdev', if successful, as a positive number. |
191 | * On failure, returns a negative errno value. | |
192 | * | |
193 | * The desired semantics of the ifindex value are a combination of those | |
194 | * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An | |
195 | * ifindex value should be unique within a host and remain stable at least | |
196 | * until reboot. SNMP says an ifindex "ranges between 1 and the value of | |
4c0f1780 JG |
197 | * ifNumber" but many systems do not follow this rule anyhow. |
198 | * | |
199 | * This function may be set to null if it would always return -EOPNOTSUPP. | |
200 | */ | |
149f577a | 201 | int (*get_ifindex)(const struct netdev *netdev); |
9ab3d9a3 | 202 | |
8b61709d | 203 | /* Sets 'carrier' to true if carrier is active (link light is on) on |
85da620e JG |
204 | * 'netdev'. |
205 | * | |
206 | * May be null if device does not provide carrier status (will be always | |
207 | * up as long as device is up). | |
208 | */ | |
8b61709d BP |
209 | int (*get_carrier)(const struct netdev *netdev, bool *carrier); |
210 | ||
65c3058c EJ |
211 | /* Returns the number of times 'netdev''s carrier has changed since being |
212 | * initialized. | |
213 | * | |
214 | * If null, callers will assume the number of carrier resets is zero. */ | |
215 | long long int (*get_carrier_resets)(const struct netdev *netdev); | |
216 | ||
1670c579 EJ |
217 | /* Forces ->get_carrier() to poll 'netdev''s MII registers for link status |
218 | * instead of checking 'netdev''s carrier. 'netdev''s MII registers will | |
219 | * be polled once ever 'interval' milliseconds. If 'netdev' does not | |
220 | * support MII, another method may be used as a fallback. If 'interval' is | |
221 | * less than or equal to zero, reverts ->get_carrier() to its normal | |
222 | * behavior. | |
63331829 | 223 | * |
1670c579 EJ |
224 | * Most network devices won't support this feature and will set this |
225 | * function pointer to NULL, which is equivalent to returning EOPNOTSUPP. | |
63331829 | 226 | */ |
1670c579 | 227 | int (*set_miimon_interval)(struct netdev *netdev, long long int interval); |
63331829 | 228 | |
8b61709d BP |
229 | /* Retrieves current device stats for 'netdev' into 'stats'. |
230 | * | |
231 | * A network device that supports some statistics but not others, it should | |
232 | * set the values of the unsupported statistics to all-1-bits | |
233 | * (UINT64_MAX). */ | |
149f577a | 234 | int (*get_stats)(const struct netdev *netdev, struct netdev_stats *); |
8b61709d | 235 | |
8722022c BP |
236 | /* Sets the device stats for 'netdev' to 'stats'. |
237 | * | |
238 | * Most network devices won't support this feature and will set this | |
239 | * function pointer to NULL, which is equivalent to returning EOPNOTSUPP. | |
240 | * | |
241 | * Some network devices might only allow setting their stats to 0. */ | |
242 | int (*set_stats)(struct netdev *netdev, const struct netdev_stats *); | |
243 | ||
8b61709d BP |
244 | /* Stores the features supported by 'netdev' into each of '*current', |
245 | * '*advertised', '*supported', and '*peer'. Each value is a bitmap of | |
6c038611 | 246 | * NETDEV_F_* bits. |
4c0f1780 JG |
247 | * |
248 | * This function may be set to null if it would always return EOPNOTSUPP. | |
249 | */ | |
6f2f5cce | 250 | int (*get_features)(const struct netdev *netdev, |
6c038611 BP |
251 | enum netdev_features *current, |
252 | enum netdev_features *advertised, | |
253 | enum netdev_features *supported, | |
254 | enum netdev_features *peer); | |
8b61709d BP |
255 | |
256 | /* Set the features advertised by 'netdev' to 'advertise', which is a | |
6c038611 | 257 | * set of NETDEV_F_* bits. |
8b61709d BP |
258 | * |
259 | * This function may be set to null for a network device that does not | |
260 | * support configuring advertisements. */ | |
6c038611 BP |
261 | int (*set_advertisements)(struct netdev *netdev, |
262 | enum netdev_features advertise); | |
8b61709d | 263 | |
8b61709d BP |
264 | /* Attempts to set input rate limiting (policing) policy, such that up to |
265 | * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative | |
266 | * burst size of 'kbits' kb. | |
267 | * | |
268 | * This function may be set to null if policing is not supported. */ | |
269 | int (*set_policing)(struct netdev *netdev, unsigned int kbits_rate, | |
270 | unsigned int kbits_burst); | |
271 | ||
c1c9c9c4 BP |
272 | /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves |
273 | * it empty if 'netdev' does not support QoS. Any names added to 'types' | |
274 | * should be documented as valid for the "type" column in the "QoS" table | |
275 | * in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). | |
276 | * | |
277 | * Every network device must support disabling QoS with a type of "", but | |
278 | * this function must not add "" to 'types'. | |
279 | * | |
280 | * The caller is responsible for initializing 'types' (e.g. with | |
19993ef3 BP |
281 | * sset_init()) before calling this function. The caller retains ownership |
282 | * of 'types'. | |
c1c9c9c4 BP |
283 | * |
284 | * May be NULL if 'netdev' does not support QoS at all. */ | |
19993ef3 | 285 | int (*get_qos_types)(const struct netdev *netdev, struct sset *types); |
c1c9c9c4 BP |
286 | |
287 | /* Queries 'netdev' for its capabilities regarding the specified 'type' of | |
288 | * QoS. On success, initializes 'caps' with the QoS capabilities. | |
289 | * | |
290 | * Should return EOPNOTSUPP if 'netdev' does not support 'type'. May be | |
291 | * NULL if 'netdev' does not support QoS at all. */ | |
292 | int (*get_qos_capabilities)(const struct netdev *netdev, | |
293 | const char *type, | |
294 | struct netdev_qos_capabilities *caps); | |
295 | ||
296 | /* Queries 'netdev' about its currently configured form of QoS. If | |
297 | * successful, stores the name of the current form of QoS into '*typep' | |
298 | * and any details of configuration as string key-value pairs in | |
299 | * 'details'. | |
300 | * | |
301 | * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'. | |
302 | * | |
303 | * The caller initializes 'details' before calling this function. The | |
304 | * caller takes ownership of the string key-values pairs added to | |
305 | * 'details'. | |
306 | * | |
307 | * The netdev retains ownership of '*typep'. | |
308 | * | |
309 | * '*typep' will be one of the types returned by netdev_get_qos_types() for | |
310 | * 'netdev'. The contents of 'details' should be documented as valid for | |
311 | * '*typep' in the "other_config" column in the "QoS" table in | |
312 | * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). | |
313 | * | |
314 | * May be NULL if 'netdev' does not support QoS at all. */ | |
315 | int (*get_qos)(const struct netdev *netdev, | |
79f1cbe9 | 316 | const char **typep, struct smap *details); |
c1c9c9c4 BP |
317 | |
318 | /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to | |
319 | * 'type' with details of configuration from 'details'. | |
320 | * | |
321 | * On error, the previous QoS configuration is retained. | |
322 | * | |
323 | * When this function changes the type of QoS (not just 'details'), this | |
324 | * also resets all queue configuration for 'netdev' to their defaults | |
325 | * (which depend on the specific type of QoS). Otherwise, the queue | |
326 | * configuration for 'netdev' is unchanged. | |
327 | * | |
328 | * 'type' should be "" (to disable QoS) or one of the types returned by | |
329 | * netdev_get_qos_types() for 'netdev'. The contents of 'details' should | |
330 | * be documented as valid for the given 'type' in the "other_config" column | |
331 | * in the "QoS" table in vswitchd/vswitch.xml (which is built as | |
332 | * ovs-vswitchd.conf.db(8)). | |
333 | * | |
334 | * May be NULL if 'netdev' does not support QoS at all. */ | |
335 | int (*set_qos)(struct netdev *netdev, | |
79f1cbe9 | 336 | const char *type, const struct smap *details); |
c1c9c9c4 BP |
337 | |
338 | /* Queries 'netdev' for information about the queue numbered 'queue_id'. | |
339 | * If successful, adds that information as string key-value pairs to | |
340 | * 'details'. Returns 0 if successful, otherwise a positive errno value. | |
341 | * | |
342 | * Should return EINVAL if 'queue_id' is greater than or equal to the | |
343 | * number of supported queues (as reported in the 'n_queues' member of | |
344 | * struct netdev_qos_capabilities by 'get_qos_capabilities'). | |
345 | * | |
346 | * The caller initializes 'details' before calling this function. The | |
347 | * caller takes ownership of the string key-values pairs added to | |
348 | * 'details'. | |
349 | * | |
350 | * The returned contents of 'details' should be documented as valid for the | |
351 | * given 'type' in the "other_config" column in the "Queue" table in | |
352 | * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). | |
353 | */ | |
354 | int (*get_queue)(const struct netdev *netdev, | |
79f1cbe9 | 355 | unsigned int queue_id, struct smap *details); |
c1c9c9c4 BP |
356 | |
357 | /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value | |
358 | * string pairs in 'details'. The contents of 'details' should be | |
359 | * documented as valid for the given 'type' in the "other_config" column in | |
360 | * the "Queue" table in vswitchd/vswitch.xml (which is built as | |
361 | * ovs-vswitchd.conf.db(8)). Returns 0 if successful, otherwise a positive | |
362 | * errno value. On failure, the given queue's configuration should be | |
363 | * unmodified. | |
364 | * | |
365 | * Should return EINVAL if 'queue_id' is greater than or equal to the | |
366 | * number of supported queues (as reported in the 'n_queues' member of | |
367 | * struct netdev_qos_capabilities by 'get_qos_capabilities'), or if | |
368 | * 'details' is invalid for the type of queue. | |
369 | * | |
370 | * This function does not modify 'details', and the caller retains | |
371 | * ownership of it. | |
372 | * | |
373 | * May be NULL if 'netdev' does not support QoS at all. */ | |
374 | int (*set_queue)(struct netdev *netdev, | |
79f1cbe9 | 375 | unsigned int queue_id, const struct smap *details); |
c1c9c9c4 BP |
376 | |
377 | /* Attempts to delete the queue numbered 'queue_id' from 'netdev'. | |
378 | * | |
379 | * Should return EINVAL if 'queue_id' is greater than or equal to the | |
380 | * number of supported queues (as reported in the 'n_queues' member of | |
381 | * struct netdev_qos_capabilities by 'get_qos_capabilities'). Should | |
382 | * return EOPNOTSUPP if 'queue_id' is valid but may not be deleted (e.g. if | |
383 | * 'netdev' has a fixed set of queues with the current QoS mode). | |
384 | * | |
385 | * May be NULL if 'netdev' does not support QoS at all, or if all of its | |
386 | * QoS modes have fixed sets of queues. */ | |
387 | int (*delete_queue)(struct netdev *netdev, unsigned int queue_id); | |
388 | ||
389 | /* Obtains statistics about 'queue_id' on 'netdev'. Fills 'stats' with the | |
390 | * queue's statistics. May set individual members of 'stats' to all-1-bits | |
391 | * if the statistic is unavailable. | |
392 | * | |
393 | * May be NULL if 'netdev' does not support QoS at all. */ | |
394 | int (*get_queue_stats)(const struct netdev *netdev, unsigned int queue_id, | |
395 | struct netdev_queue_stats *stats); | |
396 | ||
397 | /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's | |
398 | * ID, its configuration, and the 'aux' specified by the caller. The order | |
399 | * of iteration is unspecified, but (when successful) each queue is visited | |
400 | * exactly once. | |
401 | * | |
f486e840 BP |
402 | * 'cb' will not modify or free the 'details' argument passed in. It may |
403 | * delete or modify the queue passed in as its 'queue_id' argument. It may | |
404 | * modify but will not delete any other queue within 'netdev'. If 'cb' | |
405 | * adds new queues, then ->dump_queues is allowed to visit some queues | |
406 | * twice or not at all. | |
407 | */ | |
c1c9c9c4 BP |
408 | int (*dump_queues)(const struct netdev *netdev, |
409 | void (*cb)(unsigned int queue_id, | |
79f1cbe9 | 410 | const struct smap *details, |
c1c9c9c4 BP |
411 | void *aux), |
412 | void *aux); | |
413 | ||
414 | /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's | |
415 | * ID, its statistics, and the 'aux' specified by the caller. The order of | |
416 | * iteration is unspecified, but (when successful) each queue must be | |
417 | * visited exactly once. | |
418 | * | |
419 | * 'cb' will not modify or free the statistics passed in. */ | |
420 | int (*dump_queue_stats)(const struct netdev *netdev, | |
421 | void (*cb)(unsigned int queue_id, | |
422 | struct netdev_queue_stats *, | |
423 | void *aux), | |
424 | void *aux); | |
425 | ||
f1acd62b BP |
426 | /* If 'netdev' has an assigned IPv4 address, sets '*address' to that |
427 | * address and '*netmask' to the associated netmask. | |
8b61709d BP |
428 | * |
429 | * The following error values have well-defined meanings: | |
430 | * | |
431 | * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address. | |
432 | * | |
433 | * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'. | |
434 | * | |
435 | * This function may be set to null if it would always return EOPNOTSUPP | |
436 | * anyhow. */ | |
f1acd62b BP |
437 | int (*get_in4)(const struct netdev *netdev, struct in_addr *address, |
438 | struct in_addr *netmask); | |
8b61709d BP |
439 | |
440 | /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If | |
441 | * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. | |
442 | * | |
443 | * This function may be set to null if it would always return EOPNOTSUPP | |
444 | * anyhow. */ | |
149f577a JG |
445 | int (*set_in4)(struct netdev *netdev, struct in_addr addr, |
446 | struct in_addr mask); | |
8b61709d BP |
447 | |
448 | /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address. | |
449 | * | |
450 | * The following error values have well-defined meanings: | |
451 | * | |
452 | * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address. | |
453 | * | |
454 | * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'. | |
455 | * | |
456 | * This function may be set to null if it would always return EOPNOTSUPP | |
457 | * anyhow. */ | |
458 | int (*get_in6)(const struct netdev *netdev, struct in6_addr *in6); | |
459 | ||
460 | /* Adds 'router' as a default IP gateway for the TCP/IP stack that | |
461 | * corresponds to 'netdev'. | |
462 | * | |
463 | * This function may be set to null if it would always return EOPNOTSUPP | |
464 | * anyhow. */ | |
465 | int (*add_router)(struct netdev *netdev, struct in_addr router); | |
466 | ||
ec9f40dc | 467 | /* Looks up the next hop for 'host'. If successful, stores the next hop |
f1acd62b BP |
468 | * gateway's address (0 if 'host' is on a directly connected network) in |
469 | * '*next_hop' and a copy of the name of the device to reach 'host' in | |
470 | * '*netdev_name', and returns 0. The caller is responsible for freeing | |
471 | * '*netdev_name' (by calling free()). | |
472 | * | |
473 | * This function may be set to null if it would always return EOPNOTSUPP | |
474 | * anyhow. */ | |
475 | int (*get_next_hop)(const struct in_addr *host, struct in_addr *next_hop, | |
476 | char **netdev_name); | |
477 | ||
2c2ea5a8 | 478 | /* Retrieves driver information of the device. |
ea763e0e | 479 | * |
275707c3 EJ |
480 | * Populates 'smap' with key-value pairs representing the status of the |
481 | * device. 'smap' is a set of key-value string pairs representing netdev | |
482 | * type specific information. For more information see | |
ea763e0e EJ |
483 | * ovs-vswitchd.conf.db(5). |
484 | * | |
79f1cbe9 | 485 | * The caller is responsible for destroying 'smap' and its data. |
ea763e0e EJ |
486 | * |
487 | * This function may be set to null if it would always return EOPNOTSUPP | |
488 | * anyhow. */ | |
275707c3 | 489 | int (*get_status)(const struct netdev *netdev, struct smap *smap); |
ea83a2fc | 490 | |
8b61709d BP |
491 | /* Looks up the ARP table entry for 'ip' on 'netdev' and stores the |
492 | * corresponding MAC address in 'mac'. A return value of ENXIO, in | |
493 | * particular, indicates that there is no ARP table entry for 'ip' on | |
494 | * 'netdev'. | |
495 | * | |
496 | * This function may be set to null if it would always return EOPNOTSUPP | |
497 | * anyhow. */ | |
dbba996b BP |
498 | int (*arp_lookup)(const struct netdev *netdev, ovs_be32 ip, |
499 | uint8_t mac[6]); | |
8b61709d | 500 | |
b5d57fc8 | 501 | /* Retrieves the current set of flags on 'netdev' into '*old_flags'. Then, |
4b609110 BP |
502 | * turns off the flags that are set to 1 in 'off' and turns on the flags |
503 | * that are set to 1 in 'on'. (No bit will be set to 1 in both 'off' and | |
504 | * 'on'; that is, off & on == 0.) | |
8b61709d BP |
505 | * |
506 | * This function may be invoked from a signal handler. Therefore, it | |
507 | * should not do anything that is not signal-safe (such as logging). */ | |
b5d57fc8 | 508 | int (*update_flags)(struct netdev *netdev, enum netdev_flags off, |
8b61709d BP |
509 | enum netdev_flags on, enum netdev_flags *old_flags); |
510 | ||
ac4d3bcb EJ |
511 | /* Returns a sequence number which indicates changes in one of 'netdev''s |
512 | * properties. The returned sequence number must be nonzero so that | |
513 | * callers have a value which they may use as a reset when tracking | |
514 | * 'netdev'. | |
515 | * | |
516 | * Minimally, the returned sequence number is required to change whenever | |
517 | * 'netdev''s flags, features, ethernet address, or carrier changes. The | |
518 | * returned sequence number is allowed to change even when 'netdev' doesn't | |
519 | * change, although implementations should try to avoid this. */ | |
520 | unsigned int (*change_seq)(const struct netdev *netdev); | |
8b61709d | 521 | }; |
796223f5 BP |
522 | \f |
523 | /* A data structure for capturing packets received by a network device. | |
524 | * | |
525 | * This structure should be treated as opaque by network device | |
526 | * implementations. */ | |
527 | struct netdev_rx { | |
528 | const struct netdev_rx_class *rx_class; | |
b5d57fc8 | 529 | struct netdev *netdev; |
796223f5 BP |
530 | }; |
531 | ||
b5d57fc8 | 532 | void netdev_rx_init(struct netdev_rx *, struct netdev *, |
796223f5 BP |
533 | const struct netdev_rx_class *); |
534 | void netdev_rx_uninit(struct netdev_rx *); | |
b5d57fc8 | 535 | struct netdev *netdev_rx_get_netdev(const struct netdev_rx *); |
796223f5 BP |
536 | |
537 | struct netdev_rx_class { | |
538 | /* Destroys 'rx'. */ | |
539 | void (*destroy)(struct netdev_rx *rx); | |
540 | ||
541 | /* Attempts to receive a packet from 'rx' into the 'size' bytes in | |
542 | * 'buffer'. If successful, returns the number of bytes in the received | |
543 | * packet, otherwise a negative errno value. Returns -EAGAIN immediately | |
544 | * if no packet is ready to be received. | |
545 | * | |
546 | * Must return -EMSGSIZE, and discard the packet, if the received packet | |
547 | * is longer than 'size' bytes. */ | |
548 | int (*recv)(struct netdev_rx *rx, void *buffer, size_t size); | |
549 | ||
550 | /* Registers with the poll loop to wake up from the next call to | |
551 | * poll_block() when a packet is ready to be received with netdev_rx_recv() | |
552 | * on 'rx'. */ | |
553 | void (*wait)(struct netdev_rx *rx); | |
554 | ||
555 | /* Discards all packets waiting to be received from 'rx'. */ | |
556 | int (*drain)(struct netdev_rx *rx); | |
557 | }; | |
558 | ||
559 | static inline void netdev_rx_assert_class(const struct netdev_rx *rx, | |
560 | const struct netdev_rx_class *class_) | |
561 | { | |
562 | ovs_assert(rx->rx_class == class_); | |
563 | } | |
8b61709d | 564 | |
2b9d6589 BP |
565 | int netdev_register_provider(const struct netdev_class *); |
566 | int netdev_unregister_provider(const char *type); | |
c3827f61 | 567 | const struct netdev_class *netdev_lookup_provider(const char *type); |
2b9d6589 | 568 | |
8b61709d | 569 | extern const struct netdev_class netdev_linux_class; |
c3827f61 | 570 | extern const struct netdev_class netdev_internal_class; |
8b61709d | 571 | extern const struct netdev_class netdev_tap_class; |
666afb55 | 572 | #if defined(__FreeBSD__) || defined(__NetBSD__) |
f6eb6b20 GL |
573 | extern const struct netdev_class netdev_bsd_class; |
574 | #endif | |
8b61709d | 575 | |
6dfd0304 BP |
576 | #ifdef __cplusplus |
577 | } | |
578 | #endif | |
579 | ||
8b61709d | 580 | #endif /* netdev.h */ |