]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
f915f1a8 | 2 | * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks. |
064af421 | 3 | * |
a14bc59f BP |
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: | |
064af421 | 7 | * |
a14bc59f BP |
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. | |
064af421 BP |
15 | */ |
16 | ||
17 | #include <config.h> | |
18 | #include "netdev.h" | |
19 | ||
20 | #include <assert.h> | |
21 | #include <errno.h> | |
064af421 | 22 | #include <inttypes.h> |
064af421 BP |
23 | #include <netinet/in.h> |
24 | #include <stdlib.h> | |
25 | #include <string.h> | |
26 | #include <unistd.h> | |
27 | ||
28 | #include "coverage.h" | |
29 | #include "dynamic-string.h" | |
30 | #include "fatal-signal.h" | |
149f577a | 31 | #include "hash.h" |
064af421 | 32 | #include "list.h" |
8b61709d | 33 | #include "netdev-provider.h" |
2b9d6589 | 34 | #include "netdev-vport.h" |
064af421 | 35 | #include "ofpbuf.h" |
622ee2cf | 36 | #include "openflow/openflow.h" |
064af421 BP |
37 | #include "packets.h" |
38 | #include "poll-loop.h" | |
e9e28be3 | 39 | #include "shash.h" |
b3c01ed3 | 40 | #include "sset.h" |
064af421 | 41 | #include "svec.h" |
064af421 BP |
42 | #include "vlog.h" |
43 | ||
d98e6007 | 44 | VLOG_DEFINE_THIS_MODULE(netdev); |
5136ce49 | 45 | |
d76f09ea BP |
46 | COVERAGE_DEFINE(netdev_received); |
47 | COVERAGE_DEFINE(netdev_sent); | |
48 | COVERAGE_DEFINE(netdev_add_router); | |
49 | COVERAGE_DEFINE(netdev_get_stats); | |
50 | ||
77909859 | 51 | static struct shash netdev_classes = SHASH_INITIALIZER(&netdev_classes); |
064af421 | 52 | |
6c88d577 | 53 | /* All created network devices. */ |
149f577a | 54 | static struct shash netdev_dev_shash = SHASH_INITIALIZER(&netdev_dev_shash); |
6c88d577 | 55 | |
064af421 BP |
56 | /* All open network devices. */ |
57 | static struct list netdev_list = LIST_INITIALIZER(&netdev_list); | |
58 | ||
064af421 BP |
59 | /* This is set pretty low because we probably won't learn anything from the |
60 | * additional log messages. */ | |
61 | static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20); | |
62 | ||
c69ee87c | 63 | static void close_all_netdevs(void *aux OVS_UNUSED); |
064af421 | 64 | static int restore_flags(struct netdev *netdev); |
0f4f4a61 | 65 | void update_device_args(struct netdev_dev *, const struct shash *args); |
8b61709d | 66 | |
77909859 | 67 | static void |
8b61709d | 68 | netdev_initialize(void) |
064af421 | 69 | { |
2b9d6589 | 70 | static bool inited; |
e3830e90 | 71 | |
2b9d6589 BP |
72 | if (!inited) { |
73 | inited = true; | |
8b61709d | 74 | |
e3830e90 | 75 | fatal_signal_add_hook(close_all_netdevs, NULL, NULL, true); |
064af421 | 76 | |
2b9d6589 BP |
77 | #ifdef HAVE_NETLINK |
78 | netdev_register_provider(&netdev_linux_class); | |
c3827f61 | 79 | netdev_register_provider(&netdev_internal_class); |
2b9d6589 BP |
80 | netdev_register_provider(&netdev_tap_class); |
81 | netdev_vport_register(); | |
82 | #endif | |
064af421 | 83 | } |
064af421 BP |
84 | } |
85 | ||
8b61709d BP |
86 | /* Performs periodic work needed by all the various kinds of netdevs. |
87 | * | |
88 | * If your program opens any netdevs, it must call this function within its | |
89 | * main poll loop. */ | |
90 | void | |
91 | netdev_run(void) | |
064af421 | 92 | { |
77909859 JG |
93 | struct shash_node *node; |
94 | SHASH_FOR_EACH(node, &netdev_classes) { | |
7dab847a JG |
95 | const struct netdev_class *netdev_class = node->data; |
96 | if (netdev_class->run) { | |
97 | netdev_class->run(); | |
064af421 | 98 | } |
064af421 BP |
99 | } |
100 | } | |
101 | ||
8b61709d BP |
102 | /* Arranges for poll_block() to wake up when netdev_run() needs to be called. |
103 | * | |
104 | * If your program opens any netdevs, it must call this function within its | |
105 | * main poll loop. */ | |
106 | void | |
107 | netdev_wait(void) | |
064af421 | 108 | { |
77909859 JG |
109 | struct shash_node *node; |
110 | SHASH_FOR_EACH(node, &netdev_classes) { | |
7dab847a JG |
111 | const struct netdev_class *netdev_class = node->data; |
112 | if (netdev_class->wait) { | |
113 | netdev_class->wait(); | |
8b61709d | 114 | } |
064af421 | 115 | } |
064af421 BP |
116 | } |
117 | ||
77909859 JG |
118 | /* Initializes and registers a new netdev provider. After successful |
119 | * registration, new netdevs of that type can be opened using netdev_open(). */ | |
120 | int | |
121 | netdev_register_provider(const struct netdev_class *new_class) | |
122 | { | |
77909859 JG |
123 | if (shash_find(&netdev_classes, new_class->type)) { |
124 | VLOG_WARN("attempted to register duplicate netdev provider: %s", | |
125 | new_class->type); | |
126 | return EEXIST; | |
127 | } | |
128 | ||
129 | if (new_class->init) { | |
130 | int error = new_class->init(); | |
131 | if (error) { | |
132 | VLOG_ERR("failed to initialize %s network device class: %s", | |
133 | new_class->type, strerror(error)); | |
134 | return error; | |
135 | } | |
136 | } | |
137 | ||
2b9d6589 | 138 | shash_add(&netdev_classes, new_class->type, new_class); |
77909859 JG |
139 | |
140 | return 0; | |
141 | } | |
142 | ||
143 | /* Unregisters a netdev provider. 'type' must have been previously | |
144 | * registered and not currently be in use by any netdevs. After unregistration | |
145 | * new netdevs of that type cannot be opened using netdev_open(). */ | |
146 | int | |
147 | netdev_unregister_provider(const char *type) | |
148 | { | |
149 | struct shash_node *del_node, *netdev_dev_node; | |
150 | ||
151 | del_node = shash_find(&netdev_classes, type); | |
152 | if (!del_node) { | |
153 | VLOG_WARN("attempted to unregister a netdev provider that is not " | |
154 | "registered: %s", type); | |
155 | return EAFNOSUPPORT; | |
156 | } | |
157 | ||
158 | SHASH_FOR_EACH(netdev_dev_node, &netdev_dev_shash) { | |
159 | struct netdev_dev *netdev_dev = netdev_dev_node->data; | |
a4af0040 | 160 | if (!strcmp(netdev_dev->netdev_class->type, type)) { |
77909859 JG |
161 | VLOG_WARN("attempted to unregister in use netdev provider: %s", |
162 | type); | |
163 | return EBUSY; | |
164 | } | |
165 | } | |
166 | ||
167 | shash_delete(&netdev_classes, del_node); | |
77909859 JG |
168 | |
169 | return 0; | |
170 | } | |
171 | ||
c3827f61 BP |
172 | const struct netdev_class * |
173 | netdev_lookup_provider(const char *type) | |
174 | { | |
175 | netdev_initialize(); | |
176 | return shash_find_data(&netdev_classes, type && type[0] ? type : "system"); | |
177 | } | |
178 | ||
77909859 | 179 | /* Clears 'types' and enumerates the types of all currently registered netdev |
19993ef3 | 180 | * providers into it. The caller must first initialize the sset. */ |
77909859 | 181 | void |
19993ef3 | 182 | netdev_enumerate_types(struct sset *types) |
77909859 JG |
183 | { |
184 | struct shash_node *node; | |
185 | ||
186 | netdev_initialize(); | |
19993ef3 | 187 | sset_clear(types); |
77909859 JG |
188 | |
189 | SHASH_FOR_EACH(node, &netdev_classes) { | |
190 | const struct netdev_class *netdev_class = node->data; | |
19993ef3 | 191 | sset_add(types, netdev_class->type); |
77909859 JG |
192 | } |
193 | } | |
194 | ||
18812dff BP |
195 | /* Opens the network device named 'name' (e.g. "eth0") of the specified 'type' |
196 | * (e.g. "system") and returns zero if successful, otherwise a positive errno | |
197 | * value. On success, sets '*netdevp' to the new network device, otherwise to | |
198 | * null. | |
064af421 | 199 | * |
de5cdb90 BP |
200 | * Some network devices may need to be configured (with netdev_set_config()) |
201 | * before they can be used. */ | |
064af421 | 202 | int |
18812dff | 203 | netdev_open(const char *name, const char *type, struct netdev **netdevp) |
064af421 | 204 | { |
149f577a | 205 | struct netdev_dev *netdev_dev; |
064af421 | 206 | int error; |
064af421 | 207 | |
149f577a | 208 | *netdevp = NULL; |
559843ed | 209 | netdev_initialize(); |
6c88d577 | 210 | |
18812dff | 211 | netdev_dev = shash_find_data(&netdev_dev_shash, name); |
149f577a JG |
212 | |
213 | if (!netdev_dev) { | |
c3827f61 BP |
214 | const struct netdev_class *class; |
215 | ||
18812dff | 216 | class = netdev_lookup_provider(type); |
c3827f61 BP |
217 | if (!class) { |
218 | VLOG_WARN("could not create netdev %s of unknown type %s", | |
18812dff | 219 | name, type); |
c3827f61 BP |
220 | return EAFNOSUPPORT; |
221 | } | |
18812dff | 222 | error = class->create(class, name, &netdev_dev); |
149f577a JG |
223 | if (error) { |
224 | return error; | |
225 | } | |
c3827f61 | 226 | assert(netdev_dev->netdev_class == class); |
149f577a | 227 | |
064af421 | 228 | } |
149f577a | 229 | |
7b6b0ef4 | 230 | error = netdev_dev->netdev_class->open(netdev_dev, netdevp); |
149f577a | 231 | |
6c88d577 | 232 | if (!error) { |
149f577a JG |
233 | netdev_dev->ref_cnt++; |
234 | } else { | |
235 | if (!netdev_dev->ref_cnt) { | |
236 | netdev_dev_uninit(netdev_dev, true); | |
237 | } | |
6c88d577 | 238 | } |
064af421 | 239 | |
064af421 BP |
240 | return error; |
241 | } | |
242 | ||
149f577a JG |
243 | /* Reconfigures the device 'netdev' with 'args'. 'args' may be empty |
244 | * or NULL if none are needed. */ | |
245 | int | |
6d9e6eb4 | 246 | netdev_set_config(struct netdev *netdev, const struct shash *args) |
149f577a | 247 | { |
149f577a JG |
248 | struct netdev_dev *netdev_dev = netdev_get_dev(netdev); |
249 | ||
6d9e6eb4 | 250 | if (netdev_dev->netdev_class->set_config) { |
de5cdb90 BP |
251 | struct shash no_args = SHASH_INITIALIZER(&no_args); |
252 | return netdev_dev->netdev_class->set_config(netdev_dev, | |
253 | args ? args : &no_args); | |
254 | } else if (args && !shash_is_empty(args)) { | |
255 | VLOG_WARN("%s: arguments provided to device that is not configurable", | |
256 | netdev_get_name(netdev)); | |
149f577a JG |
257 | } |
258 | ||
259 | return 0; | |
260 | } | |
261 | ||
de5cdb90 BP |
262 | /* Returns the current configuration for 'netdev' in 'args'. The caller must |
263 | * have already initialized 'args' with shash_init(). Returns 0 on success, in | |
264 | * which case 'args' will be filled with 'netdev''s configuration. On failure | |
265 | * returns a positive errno value, in which case 'args' will be empty. | |
6d9e6eb4 | 266 | * |
de5cdb90 BP |
267 | * The caller owns 'args' and its contents and must eventually free them with |
268 | * shash_destroy_free_data(). */ | |
269 | int | |
270 | netdev_get_config(const struct netdev *netdev, struct shash *args) | |
6d9e6eb4 | 271 | { |
de5cdb90 BP |
272 | struct netdev_dev *netdev_dev = netdev_get_dev(netdev); |
273 | int error; | |
274 | ||
275 | shash_clear_free_data(args); | |
276 | if (netdev_dev->netdev_class->get_config) { | |
277 | error = netdev_dev->netdev_class->get_config(netdev_dev, args); | |
278 | if (error) { | |
279 | shash_clear_free_data(args); | |
280 | } | |
281 | } else { | |
282 | error = 0; | |
283 | } | |
284 | ||
285 | return error; | |
6d9e6eb4 BP |
286 | } |
287 | ||
064af421 BP |
288 | /* Closes and destroys 'netdev'. */ |
289 | void | |
290 | netdev_close(struct netdev *netdev) | |
291 | { | |
292 | if (netdev) { | |
149f577a | 293 | struct netdev_dev *netdev_dev = netdev_get_dev(netdev); |
6c88d577 | 294 | |
149f577a JG |
295 | assert(netdev_dev->ref_cnt); |
296 | netdev_dev->ref_cnt--; | |
297 | netdev_uninit(netdev, true); | |
6c88d577 | 298 | |
149f577a JG |
299 | /* If the reference count for the netdev device is zero, destroy it. */ |
300 | if (!netdev_dev->ref_cnt) { | |
301 | netdev_dev_uninit(netdev_dev, true); | |
064af421 | 302 | } |
064af421 BP |
303 | } |
304 | } | |
305 | ||
8b61709d BP |
306 | /* Returns true if a network device named 'name' exists and may be opened, |
307 | * otherwise false. */ | |
5bfc0cd3 BP |
308 | bool |
309 | netdev_exists(const char *name) | |
310 | { | |
8b61709d | 311 | struct netdev *netdev; |
5bfc0cd3 BP |
312 | int error; |
313 | ||
18812dff | 314 | error = netdev_open(name, "system", &netdev); |
8b61709d BP |
315 | if (!error) { |
316 | netdev_close(netdev); | |
317 | return true; | |
318 | } else { | |
319 | if (error != ENODEV) { | |
320 | VLOG_WARN("failed to open network device %s: %s", | |
321 | name, strerror(error)); | |
322 | } | |
323 | return false; | |
324 | } | |
5bfc0cd3 BP |
325 | } |
326 | ||
fdd82248 JG |
327 | /* Returns true if a network device named 'name' is currently opened, |
328 | * otherwise false. */ | |
329 | bool | |
330 | netdev_is_open(const char *name) | |
331 | { | |
332 | return !!shash_find_data(&netdev_dev_shash, name); | |
333 | } | |
334 | ||
19993ef3 | 335 | /* Clears 'sset' and enumerates the names of all known network devices. */ |
8b61709d | 336 | int |
19993ef3 | 337 | netdev_enumerate(struct sset *sset) |
064af421 | 338 | { |
77909859 JG |
339 | struct shash_node *node; |
340 | int error = 0; | |
8b61709d | 341 | |
559843ed | 342 | netdev_initialize(); |
19993ef3 | 343 | sset_clear(sset); |
8b61709d | 344 | |
77909859 JG |
345 | SHASH_FOR_EACH(node, &netdev_classes) { |
346 | const struct netdev_class *netdev_class = node->data; | |
347 | if (netdev_class->enumerate) { | |
19993ef3 | 348 | int retval = netdev_class->enumerate(sset); |
8b61709d BP |
349 | if (retval) { |
350 | VLOG_WARN("failed to enumerate %s network devices: %s", | |
77909859 | 351 | netdev_class->type, strerror(retval)); |
8b61709d BP |
352 | if (!error) { |
353 | error = retval; | |
354 | } | |
355 | } | |
356 | } | |
357 | } | |
77909859 | 358 | |
8b61709d | 359 | return error; |
064af421 BP |
360 | } |
361 | ||
7b6b0ef4 BP |
362 | /* Attempts to set up 'netdev' for receiving packets with netdev_recv(). |
363 | * Returns 0 if successful, otherwise a positive errno value. EOPNOTSUPP | |
364 | * indicates that the network device does not implement packet reception | |
365 | * through this interface. */ | |
366 | int | |
367 | netdev_listen(struct netdev *netdev) | |
368 | { | |
369 | int (*listen)(struct netdev *); | |
370 | ||
371 | listen = netdev_get_dev(netdev)->netdev_class->listen; | |
372 | return listen ? (listen)(netdev) : EOPNOTSUPP; | |
373 | } | |
374 | ||
064af421 BP |
375 | /* Attempts to receive a packet from 'netdev' into 'buffer', which the caller |
376 | * must have initialized with sufficient room for the packet. The space | |
377 | * required to receive any packet is ETH_HEADER_LEN bytes, plus VLAN_HEADER_LEN | |
378 | * bytes, plus the device's MTU (which may be retrieved via netdev_get_mtu()). | |
379 | * (Some devices do not allow for a VLAN header, in which case VLAN_HEADER_LEN | |
380 | * need not be included.) | |
381 | * | |
7b6b0ef4 BP |
382 | * This function can only be expected to return a packet if ->listen() has |
383 | * been called successfully. | |
384 | * | |
064af421 BP |
385 | * If a packet is successfully retrieved, returns 0. In this case 'buffer' is |
386 | * guaranteed to contain at least ETH_TOTAL_MIN bytes. Otherwise, returns a | |
387 | * positive errno value. Returns EAGAIN immediately if no packet is ready to | |
388 | * be returned. | |
1ac98180 BP |
389 | * |
390 | * Some network devices may not implement support for this function. In such | |
c1fdab01 | 391 | * cases this function will always return EOPNOTSUPP. */ |
064af421 BP |
392 | int |
393 | netdev_recv(struct netdev *netdev, struct ofpbuf *buffer) | |
394 | { | |
1ac98180 | 395 | int (*recv)(struct netdev *, void *, size_t); |
8b61709d | 396 | int retval; |
064af421 BP |
397 | |
398 | assert(buffer->size == 0); | |
399 | assert(ofpbuf_tailroom(buffer) >= ETH_TOTAL_MIN); | |
8b61709d | 400 | |
1ac98180 BP |
401 | recv = netdev_get_dev(netdev)->netdev_class->recv; |
402 | retval = (recv | |
403 | ? (recv)(netdev, buffer->data, ofpbuf_tailroom(buffer)) | |
404 | : -EOPNOTSUPP); | |
8b61709d | 405 | if (retval >= 0) { |
064af421 | 406 | COVERAGE_INC(netdev_received); |
8b61709d BP |
407 | buffer->size += retval; |
408 | if (buffer->size < ETH_TOTAL_MIN) { | |
409 | ofpbuf_put_zeros(buffer, ETH_TOTAL_MIN - buffer->size); | |
410 | } | |
064af421 | 411 | return 0; |
8b61709d BP |
412 | } else { |
413 | return -retval; | |
064af421 BP |
414 | } |
415 | } | |
416 | ||
417 | /* Registers with the poll loop to wake up from the next call to poll_block() | |
418 | * when a packet is ready to be received with netdev_recv() on 'netdev'. */ | |
419 | void | |
420 | netdev_recv_wait(struct netdev *netdev) | |
421 | { | |
1ac98180 BP |
422 | void (*recv_wait)(struct netdev *); |
423 | ||
424 | recv_wait = netdev_get_dev(netdev)->netdev_class->recv_wait; | |
425 | if (recv_wait) { | |
426 | recv_wait(netdev); | |
427 | } | |
064af421 BP |
428 | } |
429 | ||
430 | /* Discards all packets waiting to be received from 'netdev'. */ | |
431 | int | |
432 | netdev_drain(struct netdev *netdev) | |
433 | { | |
1ac98180 BP |
434 | int (*drain)(struct netdev *); |
435 | ||
436 | drain = netdev_get_dev(netdev)->netdev_class->drain; | |
437 | return drain ? drain(netdev) : 0; | |
064af421 BP |
438 | } |
439 | ||
440 | /* Sends 'buffer' on 'netdev'. Returns 0 if successful, otherwise a positive | |
441 | * errno value. Returns EAGAIN without blocking if the packet cannot be queued | |
442 | * immediately. Returns EMSGSIZE if a partial packet was transmitted or if | |
443 | * the packet is too big or too small to transmit on the device. | |
444 | * | |
445 | * The caller retains ownership of 'buffer' in all cases. | |
446 | * | |
447 | * The kernel maintains a packet transmission queue, so the caller is not | |
1ac98180 BP |
448 | * expected to do additional queuing of packets. |
449 | * | |
450 | * Some network devices may not implement support for this function. In such | |
451 | * cases this function will always return EOPNOTSUPP. */ | |
064af421 BP |
452 | int |
453 | netdev_send(struct netdev *netdev, const struct ofpbuf *buffer) | |
454 | { | |
1ac98180 BP |
455 | int (*send)(struct netdev *, const void *, size_t); |
456 | int error; | |
457 | ||
458 | send = netdev_get_dev(netdev)->netdev_class->send; | |
459 | error = send ? (send)(netdev, buffer->data, buffer->size) : EOPNOTSUPP; | |
8b61709d | 460 | if (!error) { |
064af421 | 461 | COVERAGE_INC(netdev_sent); |
064af421 | 462 | } |
8b61709d | 463 | return error; |
064af421 BP |
464 | } |
465 | ||
466 | /* Registers with the poll loop to wake up from the next call to poll_block() | |
467 | * when the packet transmission queue has sufficient room to transmit a packet | |
468 | * with netdev_send(). | |
469 | * | |
470 | * The kernel maintains a packet transmission queue, so the client is not | |
471 | * expected to do additional queuing of packets. Thus, this function is | |
472 | * unlikely to ever be used. It is included for completeness. */ | |
473 | void | |
474 | netdev_send_wait(struct netdev *netdev) | |
475 | { | |
1ac98180 BP |
476 | void (*send_wait)(struct netdev *); |
477 | ||
478 | send_wait = netdev_get_dev(netdev)->netdev_class->send_wait; | |
479 | if (send_wait) { | |
480 | send_wait(netdev); | |
481 | } | |
064af421 BP |
482 | } |
483 | ||
484 | /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful, | |
485 | * otherwise a positive errno value. */ | |
486 | int | |
487 | netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN]) | |
488 | { | |
a4af0040 | 489 | return netdev_get_dev(netdev)->netdev_class->set_etheraddr(netdev, mac); |
064af421 BP |
490 | } |
491 | ||
80992a35 BP |
492 | /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the |
493 | * the MAC address into 'mac'. On failure, returns a positive errno value and | |
494 | * clears 'mac' to all-zeros. */ | |
495 | int | |
496 | netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN]) | |
064af421 | 497 | { |
a4af0040 | 498 | return netdev_get_dev(netdev)->netdev_class->get_etheraddr(netdev, mac); |
064af421 BP |
499 | } |
500 | ||
501 | /* Returns the name of the network device that 'netdev' represents, | |
502 | * e.g. "eth0". The caller must not modify or free the returned string. */ | |
503 | const char * | |
504 | netdev_get_name(const struct netdev *netdev) | |
505 | { | |
149f577a | 506 | return netdev_get_dev(netdev)->name; |
064af421 BP |
507 | } |
508 | ||
3d222126 BP |
509 | /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted |
510 | * (and received) packets, in bytes, not including the hardware header; thus, | |
511 | * this is typically 1500 bytes for Ethernet devices. | |
512 | * | |
9b020780 PS |
513 | * If successful, returns 0 and stores the MTU size in '*mtup'. Returns |
514 | * EOPNOTSUPP if 'netdev' does not have an MTU (as e.g. some tunnels do not). | |
515 | * On other failure, returns a positive errno value. */ | |
064af421 | 516 | int |
3d222126 | 517 | netdev_get_mtu(const struct netdev *netdev, int *mtup) |
064af421 | 518 | { |
a4af0040 | 519 | int error = netdev_get_dev(netdev)->netdev_class->get_mtu(netdev, mtup); |
9b020780 | 520 | if (error && error != EOPNOTSUPP) { |
8b61709d BP |
521 | VLOG_WARN_RL(&rl, "failed to retrieve MTU for network device %s: %s", |
522 | netdev_get_name(netdev), strerror(error)); | |
8b61709d BP |
523 | } |
524 | return error; | |
064af421 BP |
525 | } |
526 | ||
9b020780 PS |
527 | /* Sets the MTU of 'netdev'. The MTU is the maximum size of transmitted |
528 | * (and received) packets, in bytes. | |
529 | * | |
530 | * If successful, returns 0. Returns EOPNOTSUPP if 'netdev' does not have an | |
531 | * MTU (as e.g. some tunnels do not). On other failure, returns a positive | |
532 | * errno value. */ | |
533 | int | |
534 | netdev_set_mtu(const struct netdev *netdev, int mtu) | |
535 | { | |
536 | int error = netdev_get_dev(netdev)->netdev_class->set_mtu(netdev, mtu); | |
537 | ||
538 | if (error && error != EOPNOTSUPP) { | |
539 | VLOG_WARN_RL(&rl, "failed to retrieve MTU for network device %s: %s", | |
540 | netdev_get_name(netdev), strerror(error)); | |
541 | } | |
542 | ||
543 | return error; | |
544 | } | |
545 | ||
9ab3d9a3 BP |
546 | /* Returns the ifindex of 'netdev', if successful, as a positive number. On |
547 | * failure, returns a negative errno value. | |
548 | * | |
549 | * The desired semantics of the ifindex value are a combination of those | |
550 | * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex | |
551 | * value should be unique within a host and remain stable at least until | |
552 | * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber" | |
553 | * but many systems do not follow this rule anyhow. | |
4c0f1780 JG |
554 | * |
555 | * Some network devices may not implement support for this function. In such | |
556 | * cases this function will always return -EOPNOTSUPP. | |
9ab3d9a3 BP |
557 | */ |
558 | int | |
559 | netdev_get_ifindex(const struct netdev *netdev) | |
560 | { | |
4c0f1780 JG |
561 | int (*get_ifindex)(const struct netdev *); |
562 | ||
563 | get_ifindex = netdev_get_dev(netdev)->netdev_class->get_ifindex; | |
564 | ||
565 | return get_ifindex ? get_ifindex(netdev) : -EOPNOTSUPP; | |
9ab3d9a3 BP |
566 | } |
567 | ||
064af421 BP |
568 | /* Stores the features supported by 'netdev' into each of '*current', |
569 | * '*advertised', '*supported', and '*peer' that are non-null. Each value is a | |
570 | * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if | |
571 | * successful, otherwise a positive errno value. On failure, all of the | |
4c0f1780 JG |
572 | * passed-in values are set to 0. |
573 | * | |
574 | * Some network devices may not implement support for this function. In such | |
c1fdab01 | 575 | * cases this function will always return EOPNOTSUPP. */ |
064af421 | 576 | int |
6f2f5cce | 577 | netdev_get_features(const struct netdev *netdev, |
064af421 BP |
578 | uint32_t *current, uint32_t *advertised, |
579 | uint32_t *supported, uint32_t *peer) | |
580 | { | |
6f2f5cce | 581 | int (*get_features)(const struct netdev *netdev, |
4c0f1780 JG |
582 | uint32_t *current, uint32_t *advertised, |
583 | uint32_t *supported, uint32_t *peer); | |
064af421 | 584 | uint32_t dummy[4]; |
7671589a BP |
585 | int error; |
586 | ||
587 | if (!current) { | |
588 | current = &dummy[0]; | |
589 | } | |
590 | if (!advertised) { | |
591 | advertised = &dummy[1]; | |
592 | } | |
593 | if (!supported) { | |
594 | supported = &dummy[2]; | |
595 | } | |
596 | if (!peer) { | |
597 | peer = &dummy[3]; | |
598 | } | |
599 | ||
4c0f1780 JG |
600 | get_features = netdev_get_dev(netdev)->netdev_class->get_features; |
601 | error = get_features | |
602 | ? get_features(netdev, current, advertised, supported, peer) | |
603 | : EOPNOTSUPP; | |
7671589a BP |
604 | if (error) { |
605 | *current = *advertised = *supported = *peer = 0; | |
606 | } | |
607 | return error; | |
064af421 BP |
608 | } |
609 | ||
622ee2cf BP |
610 | /* Returns the maximum speed of a network connection that has the "enum |
611 | * ofp_port_features" bits in 'features', in bits per second. If no bits that | |
612 | * indicate a speed are set in 'features', assumes 100Mbps. */ | |
613 | uint64_t | |
614 | netdev_features_to_bps(uint32_t features) | |
615 | { | |
616 | enum { | |
617 | F_10000MB = OFPPF_10GB_FD, | |
618 | F_1000MB = OFPPF_1GB_HD | OFPPF_1GB_FD, | |
619 | F_100MB = OFPPF_100MB_HD | OFPPF_100MB_FD, | |
620 | F_10MB = OFPPF_10MB_HD | OFPPF_10MB_FD | |
621 | }; | |
622 | ||
623 | return ( features & F_10000MB ? UINT64_C(10000000000) | |
624 | : features & F_1000MB ? UINT64_C(1000000000) | |
625 | : features & F_100MB ? UINT64_C(100000000) | |
626 | : features & F_10MB ? UINT64_C(10000000) | |
627 | : UINT64_C(100000000)); | |
628 | } | |
629 | ||
630 | /* Returns true if any of the "enum ofp_port_features" bits that indicate a | |
631 | * full-duplex link are set in 'features', otherwise false. */ | |
632 | bool | |
633 | netdev_features_is_full_duplex(uint32_t features) | |
634 | { | |
635 | return (features & (OFPPF_10MB_FD | OFPPF_100MB_FD | OFPPF_1GB_FD | |
636 | | OFPPF_10GB_FD)) != 0; | |
637 | } | |
638 | ||
8b61709d BP |
639 | /* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if |
640 | * successful, otherwise a positive errno value. */ | |
064af421 BP |
641 | int |
642 | netdev_set_advertisements(struct netdev *netdev, uint32_t advertise) | |
643 | { | |
a4af0040 JP |
644 | return (netdev_get_dev(netdev)->netdev_class->set_advertisements |
645 | ? netdev_get_dev(netdev)->netdev_class->set_advertisements( | |
646 | netdev, advertise) | |
8b61709d | 647 | : EOPNOTSUPP); |
064af421 BP |
648 | } |
649 | ||
f1acd62b BP |
650 | /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address |
651 | * and '*netmask' to its netmask and returns 0. Otherwise, returns a positive | |
652 | * errno value and sets '*address' to 0 (INADDR_ANY). | |
8b61709d BP |
653 | * |
654 | * The following error values have well-defined meanings: | |
655 | * | |
656 | * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address. | |
657 | * | |
658 | * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'. | |
659 | * | |
b53055f4 | 660 | * 'address' or 'netmask' or both may be null, in which case the address or |
c1fdab01 | 661 | * netmask is not reported. */ |
6b9bd979 | 662 | int |
f1acd62b BP |
663 | netdev_get_in4(const struct netdev *netdev, |
664 | struct in_addr *address_, struct in_addr *netmask_) | |
064af421 | 665 | { |
f1acd62b BP |
666 | struct in_addr address; |
667 | struct in_addr netmask; | |
064af421 BP |
668 | int error; |
669 | ||
a4af0040 | 670 | error = (netdev_get_dev(netdev)->netdev_class->get_in4 |
d295e8e9 | 671 | ? netdev_get_dev(netdev)->netdev_class->get_in4(netdev, |
a4af0040 | 672 | &address, &netmask) |
8b61709d | 673 | : EOPNOTSUPP); |
f1acd62b BP |
674 | if (address_) { |
675 | address_->s_addr = error ? 0 : address.s_addr; | |
676 | } | |
677 | if (netmask_) { | |
678 | netmask_->s_addr = error ? 0 : netmask.s_addr; | |
064af421 BP |
679 | } |
680 | return error; | |
681 | } | |
682 | ||
683 | /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If | |
684 | * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a | |
685 | * positive errno value. */ | |
686 | int | |
687 | netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask) | |
688 | { | |
a4af0040 JP |
689 | return (netdev_get_dev(netdev)->netdev_class->set_in4 |
690 | ? netdev_get_dev(netdev)->netdev_class->set_in4(netdev, addr, mask) | |
8b61709d | 691 | : EOPNOTSUPP); |
064af421 BP |
692 | } |
693 | ||
0efaf4b5 BP |
694 | /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds |
695 | * to 'netdev'. */ | |
064af421 | 696 | int |
8b61709d | 697 | netdev_add_router(struct netdev *netdev, struct in_addr router) |
064af421 | 698 | { |
064af421 | 699 | COVERAGE_INC(netdev_add_router); |
a4af0040 JP |
700 | return (netdev_get_dev(netdev)->netdev_class->add_router |
701 | ? netdev_get_dev(netdev)->netdev_class->add_router(netdev, router) | |
8b61709d | 702 | : EOPNOTSUPP); |
064af421 BP |
703 | } |
704 | ||
f1acd62b BP |
705 | /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to |
706 | * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0, | |
707 | * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a | |
708 | * next hop is found, stores the next hop gateway's address (0 if 'host' is on | |
709 | * a directly connected network) in '*next_hop' and a copy of the name of the | |
710 | * device to reach 'host' in '*netdev_name', and returns 0. The caller is | |
711 | * responsible for freeing '*netdev_name' (by calling free()). */ | |
712 | int | |
713 | netdev_get_next_hop(const struct netdev *netdev, | |
714 | const struct in_addr *host, struct in_addr *next_hop, | |
715 | char **netdev_name) | |
716 | { | |
a4af0040 JP |
717 | int error = (netdev_get_dev(netdev)->netdev_class->get_next_hop |
718 | ? netdev_get_dev(netdev)->netdev_class->get_next_hop( | |
719 | host, next_hop, netdev_name) | |
f1acd62b | 720 | : EOPNOTSUPP); |
064af421 | 721 | if (error) { |
f1acd62b BP |
722 | next_hop->s_addr = 0; |
723 | *netdev_name = NULL; | |
064af421 BP |
724 | } |
725 | return error; | |
726 | } | |
727 | ||
ea763e0e EJ |
728 | /* Populates 'sh' with status information. |
729 | * | |
730 | * Populates 'sh' with 'netdev' specific status information. This information | |
731 | * may be used to populate the status column of the Interface table as defined | |
732 | * in ovs-vswitchd.conf.db(5). */ | |
733 | int | |
734 | netdev_get_status(const struct netdev *netdev, struct shash *sh) | |
ea83a2fc EJ |
735 | { |
736 | struct netdev_dev *dev = netdev_get_dev(netdev); | |
737 | ||
ea763e0e EJ |
738 | return (dev->netdev_class->get_status |
739 | ? dev->netdev_class->get_status(netdev, sh) | |
740 | : EOPNOTSUPP); | |
ea83a2fc EJ |
741 | } |
742 | ||
8b61709d BP |
743 | /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and |
744 | * returns 0. Otherwise, returns a positive errno value and sets '*in6' to | |
745 | * all-zero-bits (in6addr_any). | |
746 | * | |
747 | * The following error values have well-defined meanings: | |
748 | * | |
749 | * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address. | |
750 | * | |
751 | * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'. | |
752 | * | |
753 | * 'in6' may be null, in which case the address itself is not reported. */ | |
064af421 | 754 | int |
8b61709d | 755 | netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6) |
064af421 | 756 | { |
8b61709d BP |
757 | struct in6_addr dummy; |
758 | int error; | |
b1bf7d43 | 759 | |
a4af0040 | 760 | error = (netdev_get_dev(netdev)->netdev_class->get_in6 |
d295e8e9 | 761 | ? netdev_get_dev(netdev)->netdev_class->get_in6(netdev, |
a4af0040 | 762 | in6 ? in6 : &dummy) |
8b61709d BP |
763 | : EOPNOTSUPP); |
764 | if (error && in6) { | |
765 | memset(in6, 0, sizeof *in6); | |
b1bf7d43 | 766 | } |
8b61709d | 767 | return error; |
064af421 BP |
768 | } |
769 | ||
770 | /* On 'netdev', turns off the flags in 'off' and then turns on the flags in | |
771 | * 'on'. If 'permanent' is true, the changes will persist; otherwise, they | |
772 | * will be reverted when 'netdev' is closed or the program exits. Returns 0 if | |
773 | * successful, otherwise a positive errno value. */ | |
774 | static int | |
775 | do_update_flags(struct netdev *netdev, enum netdev_flags off, | |
8b61709d BP |
776 | enum netdev_flags on, enum netdev_flags *old_flagsp, |
777 | bool permanent) | |
064af421 | 778 | { |
8b61709d | 779 | enum netdev_flags old_flags; |
064af421 BP |
780 | int error; |
781 | ||
d295e8e9 | 782 | error = netdev_get_dev(netdev)->netdev_class->update_flags(netdev, |
a4af0040 | 783 | off & ~on, on, &old_flags); |
064af421 | 784 | if (error) { |
8b61709d BP |
785 | VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s", |
786 | off || on ? "set" : "get", netdev_get_name(netdev), | |
787 | strerror(error)); | |
788 | old_flags = 0; | |
789 | } else if ((off || on) && !permanent) { | |
790 | enum netdev_flags new_flags = (old_flags & ~off) | on; | |
791 | enum netdev_flags changed_flags = old_flags ^ new_flags; | |
792 | if (changed_flags) { | |
793 | if (!netdev->changed_flags) { | |
794 | netdev->save_flags = old_flags; | |
795 | } | |
796 | netdev->changed_flags |= changed_flags; | |
797 | } | |
064af421 | 798 | } |
8b61709d BP |
799 | if (old_flagsp) { |
800 | *old_flagsp = old_flags; | |
064af421 BP |
801 | } |
802 | return error; | |
803 | } | |
804 | ||
8b61709d BP |
805 | /* Obtains the current flags for 'netdev' and stores them into '*flagsp'. |
806 | * Returns 0 if successful, otherwise a positive errno value. On failure, | |
807 | * stores 0 into '*flagsp'. */ | |
808 | int | |
809 | netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp) | |
810 | { | |
811 | struct netdev *netdev = (struct netdev *) netdev_; | |
812 | return do_update_flags(netdev, 0, 0, flagsp, false); | |
813 | } | |
814 | ||
064af421 BP |
815 | /* Sets the flags for 'netdev' to 'flags'. |
816 | * If 'permanent' is true, the changes will persist; otherwise, they | |
817 | * will be reverted when 'netdev' is closed or the program exits. | |
818 | * Returns 0 if successful, otherwise a positive errno value. */ | |
819 | int | |
820 | netdev_set_flags(struct netdev *netdev, enum netdev_flags flags, | |
821 | bool permanent) | |
822 | { | |
8b61709d | 823 | return do_update_flags(netdev, -1, flags, NULL, permanent); |
064af421 BP |
824 | } |
825 | ||
826 | /* Turns on the specified 'flags' on 'netdev'. | |
827 | * If 'permanent' is true, the changes will persist; otherwise, they | |
828 | * will be reverted when 'netdev' is closed or the program exits. | |
829 | * Returns 0 if successful, otherwise a positive errno value. */ | |
830 | int | |
831 | netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags, | |
832 | bool permanent) | |
833 | { | |
8b61709d | 834 | return do_update_flags(netdev, 0, flags, NULL, permanent); |
064af421 BP |
835 | } |
836 | ||
837 | /* Turns off the specified 'flags' on 'netdev'. | |
838 | * If 'permanent' is true, the changes will persist; otherwise, they | |
839 | * will be reverted when 'netdev' is closed or the program exits. | |
840 | * Returns 0 if successful, otherwise a positive errno value. */ | |
841 | int | |
842 | netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags, | |
843 | bool permanent) | |
844 | { | |
8b61709d | 845 | return do_update_flags(netdev, flags, 0, NULL, permanent); |
064af421 BP |
846 | } |
847 | ||
848 | /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be | |
849 | * successfully retrieved, it stores the corresponding MAC address in 'mac' and | |
850 | * returns 0. Otherwise, it returns a positive errno value; in particular, | |
8b61709d | 851 | * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */ |
064af421 | 852 | int |
8b61709d | 853 | netdev_arp_lookup(const struct netdev *netdev, |
dbba996b | 854 | ovs_be32 ip, uint8_t mac[ETH_ADDR_LEN]) |
064af421 | 855 | { |
a4af0040 | 856 | int error = (netdev_get_dev(netdev)->netdev_class->arp_lookup |
d295e8e9 | 857 | ? netdev_get_dev(netdev)->netdev_class->arp_lookup(netdev, |
a4af0040 | 858 | ip, mac) |
8b61709d | 859 | : EOPNOTSUPP); |
064af421 | 860 | if (error) { |
8b61709d | 861 | memset(mac, 0, ETH_ADDR_LEN); |
064af421 | 862 | } |
8b61709d | 863 | return error; |
064af421 BP |
864 | } |
865 | ||
85da620e JG |
866 | /* Returns true if carrier is active (link light is on) on 'netdev'. */ |
867 | bool | |
868 | netdev_get_carrier(const struct netdev *netdev) | |
064af421 | 869 | { |
85da620e JG |
870 | int error; |
871 | enum netdev_flags flags; | |
872 | bool carrier; | |
873 | ||
874 | netdev_get_flags(netdev, &flags); | |
875 | if (!(flags & NETDEV_UP)) { | |
876 | return false; | |
877 | } | |
878 | ||
879 | if (!netdev_get_dev(netdev)->netdev_class->get_carrier) { | |
880 | return true; | |
881 | } | |
882 | ||
883 | error = netdev_get_dev(netdev)->netdev_class->get_carrier(netdev, | |
884 | &carrier); | |
8b61709d | 885 | if (error) { |
85da620e JG |
886 | VLOG_DBG("%s: failed to get network device carrier status, assuming " |
887 | "down: %s", netdev_get_name(netdev), strerror(error)); | |
888 | carrier = false; | |
064af421 | 889 | } |
85da620e JG |
890 | |
891 | return carrier; | |
064af421 BP |
892 | } |
893 | ||
1670c579 EJ |
894 | /* Attempts to force netdev_get_carrier() to poll 'netdev''s MII registers for |
895 | * link status instead of checking 'netdev''s carrier. 'netdev''s MII | |
896 | * registers will be polled once ever 'interval' milliseconds. If 'netdev' | |
897 | * does not support MII, another method may be used as a fallback. If | |
898 | * 'interval' is less than or equal to zero, reverts netdev_get_carrier() to | |
899 | * its normal behavior. | |
900 | * | |
901 | * Returns 0 if successful, otherwise a positive errno value. */ | |
902 | int | |
903 | netdev_set_miimon_interval(struct netdev *netdev, long long int interval) | |
63331829 | 904 | { |
1670c579 EJ |
905 | struct netdev_dev *netdev_dev = netdev_get_dev(netdev); |
906 | return (netdev_dev->netdev_class->set_miimon_interval | |
907 | ? netdev_dev->netdev_class->set_miimon_interval(netdev, interval) | |
908 | : EOPNOTSUPP); | |
63331829 EJ |
909 | } |
910 | ||
887fd0ba | 911 | /* Retrieves current device stats for 'netdev'. */ |
064af421 BP |
912 | int |
913 | netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats) | |
914 | { | |
915 | int error; | |
916 | ||
917 | COVERAGE_INC(netdev_get_stats); | |
a4af0040 JP |
918 | error = (netdev_get_dev(netdev)->netdev_class->get_stats |
919 | ? netdev_get_dev(netdev)->netdev_class->get_stats(netdev, stats) | |
8b61709d | 920 | : EOPNOTSUPP); |
064af421 BP |
921 | if (error) { |
922 | memset(stats, 0xff, sizeof *stats); | |
923 | } | |
924 | return error; | |
925 | } | |
926 | ||
8722022c BP |
927 | /* Attempts to change the stats for 'netdev' to those provided in 'stats'. |
928 | * Returns 0 if successful, otherwise a positive errno value. | |
929 | * | |
930 | * This will probably fail for most network devices. Some devices might only | |
931 | * allow setting their stats to 0. */ | |
932 | int | |
933 | netdev_set_stats(struct netdev *netdev, const struct netdev_stats *stats) | |
934 | { | |
935 | return (netdev_get_dev(netdev)->netdev_class->set_stats | |
936 | ? netdev_get_dev(netdev)->netdev_class->set_stats(netdev, stats) | |
937 | : EOPNOTSUPP); | |
938 | } | |
939 | ||
8b61709d BP |
940 | /* Attempts to set input rate limiting (policing) policy, such that up to |
941 | * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst | |
942 | * size of 'kbits' kb. */ | |
064af421 | 943 | int |
b1bf7d43 BP |
944 | netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate, |
945 | uint32_t kbits_burst) | |
064af421 | 946 | { |
a4af0040 | 947 | return (netdev_get_dev(netdev)->netdev_class->set_policing |
d295e8e9 | 948 | ? netdev_get_dev(netdev)->netdev_class->set_policing(netdev, |
a4af0040 | 949 | kbits_rate, kbits_burst) |
8b61709d | 950 | : EOPNOTSUPP); |
064af421 BP |
951 | } |
952 | ||
c1c9c9c4 BP |
953 | /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it |
954 | * empty if 'netdev' does not support QoS. Any names added to 'types' should | |
955 | * be documented as valid for the "type" column in the "QoS" table in | |
956 | * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). | |
957 | * | |
958 | * Every network device supports disabling QoS with a type of "", but this type | |
959 | * will not be added to 'types'. | |
960 | * | |
19993ef3 | 961 | * The caller must initialize 'types' (e.g. with sset_init()) before calling |
c1c9c9c4 | 962 | * this function. The caller is responsible for destroying 'types' (e.g. with |
19993ef3 | 963 | * sset_destroy()) when it is no longer needed. |
c1c9c9c4 BP |
964 | * |
965 | * Returns 0 if successful, otherwise a positive errno value. */ | |
966 | int | |
19993ef3 | 967 | netdev_get_qos_types(const struct netdev *netdev, struct sset *types) |
c1c9c9c4 BP |
968 | { |
969 | const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class; | |
970 | return (class->get_qos_types | |
971 | ? class->get_qos_types(netdev, types) | |
972 | : 0); | |
973 | } | |
974 | ||
975 | /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS, | |
976 | * which should be "" or one of the types returned by netdev_get_qos_types() | |
977 | * for 'netdev'. Returns 0 if successful, otherwise a positive errno value. | |
978 | * On success, initializes 'caps' with the QoS capabilities; on failure, clears | |
979 | * 'caps' to all zeros. */ | |
980 | int | |
981 | netdev_get_qos_capabilities(const struct netdev *netdev, const char *type, | |
982 | struct netdev_qos_capabilities *caps) | |
983 | { | |
984 | const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class; | |
985 | ||
986 | if (*type) { | |
987 | int retval = (class->get_qos_capabilities | |
988 | ? class->get_qos_capabilities(netdev, type, caps) | |
989 | : EOPNOTSUPP); | |
990 | if (retval) { | |
991 | memset(caps, 0, sizeof *caps); | |
992 | } | |
993 | return retval; | |
994 | } else { | |
995 | /* Every netdev supports turning off QoS. */ | |
996 | memset(caps, 0, sizeof *caps); | |
997 | return 0; | |
998 | } | |
999 | } | |
1000 | ||
1001 | /* Obtains the number of queues supported by 'netdev' for the specified 'type' | |
1002 | * of QoS. Returns 0 if successful, otherwise a positive errno value. Stores | |
1003 | * the number of queues (zero on failure) in '*n_queuesp'. | |
1004 | * | |
1005 | * This is just a simple wrapper around netdev_get_qos_capabilities(). */ | |
1006 | int | |
1007 | netdev_get_n_queues(const struct netdev *netdev, | |
1008 | const char *type, unsigned int *n_queuesp) | |
1009 | { | |
1010 | struct netdev_qos_capabilities caps; | |
1011 | int retval; | |
1012 | ||
1013 | retval = netdev_get_qos_capabilities(netdev, type, &caps); | |
1014 | *n_queuesp = caps.n_queues; | |
1015 | return retval; | |
1016 | } | |
1017 | ||
1018 | /* Queries 'netdev' about its currently configured form of QoS. If successful, | |
1019 | * stores the name of the current form of QoS into '*typep', stores any details | |
1020 | * of configuration as string key-value pairs in 'details', and returns 0. On | |
1021 | * failure, sets '*typep' to NULL and returns a positive errno value. | |
1022 | * | |
1023 | * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'. | |
1024 | * | |
1025 | * The caller must initialize 'details' as an empty shash (e.g. with | |
1026 | * shash_init()) before calling this function. The caller must free 'details', | |
1027 | * including 'data' members, when it is no longer needed (e.g. with | |
1028 | * shash_destroy_free_data()). | |
1029 | * | |
1030 | * The caller must not modify or free '*typep'. | |
1031 | * | |
1032 | * '*typep' will be one of the types returned by netdev_get_qos_types() for | |
1033 | * 'netdev'. The contents of 'details' should be documented as valid for | |
1034 | * '*typep' in the "other_config" column in the "QoS" table in | |
1035 | * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */ | |
1036 | int | |
1037 | netdev_get_qos(const struct netdev *netdev, | |
1038 | const char **typep, struct shash *details) | |
1039 | { | |
1040 | const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class; | |
1041 | int retval; | |
1042 | ||
1043 | if (class->get_qos) { | |
1044 | retval = class->get_qos(netdev, typep, details); | |
1045 | if (retval) { | |
1046 | *typep = NULL; | |
1047 | shash_clear_free_data(details); | |
1048 | } | |
1049 | return retval; | |
1050 | } else { | |
1051 | /* 'netdev' doesn't support QoS, so report that QoS is disabled. */ | |
1052 | *typep = ""; | |
1053 | return 0; | |
1054 | } | |
1055 | } | |
1056 | ||
1057 | /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type' | |
1058 | * with details of configuration from 'details'. Returns 0 if successful, | |
1059 | * otherwise a positive errno value. On error, the previous QoS configuration | |
1060 | * is retained. | |
1061 | * | |
1062 | * When this function changes the type of QoS (not just 'details'), this also | |
1063 | * resets all queue configuration for 'netdev' to their defaults (which depend | |
1064 | * on the specific type of QoS). Otherwise, the queue configuration for | |
1065 | * 'netdev' is unchanged. | |
1066 | * | |
1067 | * 'type' should be "" (to disable QoS) or one of the types returned by | |
1068 | * netdev_get_qos_types() for 'netdev'. The contents of 'details' should be | |
1069 | * documented as valid for the given 'type' in the "other_config" column in the | |
1070 | * "QoS" table in vswitchd/vswitch.xml (which is built as | |
1071 | * ovs-vswitchd.conf.db(8)). | |
1072 | * | |
1073 | * NULL may be specified for 'details' if there are no configuration | |
1074 | * details. */ | |
1075 | int | |
1076 | netdev_set_qos(struct netdev *netdev, | |
1077 | const char *type, const struct shash *details) | |
1078 | { | |
1079 | const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class; | |
1080 | ||
1081 | if (!type) { | |
1082 | type = ""; | |
1083 | } | |
1084 | ||
1085 | if (class->set_qos) { | |
1086 | if (!details) { | |
1087 | static struct shash empty = SHASH_INITIALIZER(&empty); | |
1088 | details = ∅ | |
1089 | } | |
1090 | return class->set_qos(netdev, type, details); | |
1091 | } else { | |
1092 | return *type ? EOPNOTSUPP : 0; | |
1093 | } | |
1094 | } | |
1095 | ||
1096 | /* Queries 'netdev' for information about the queue numbered 'queue_id'. If | |
1097 | * successful, adds that information as string key-value pairs to 'details'. | |
1098 | * Returns 0 if successful, otherwise a positive errno value. | |
1099 | * | |
1100 | * 'queue_id' must be less than the number of queues supported by 'netdev' for | |
1101 | * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)). | |
1102 | * | |
1103 | * The returned contents of 'details' should be documented as valid for the | |
1104 | * given 'type' in the "other_config" column in the "Queue" table in | |
1105 | * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). | |
1106 | * | |
1107 | * The caller must initialize 'details' (e.g. with shash_init()) before calling | |
1108 | * this function. The caller must free 'details', including 'data' members, | |
1109 | * when it is no longer needed (e.g. with shash_destroy_free_data()). */ | |
1110 | int | |
1111 | netdev_get_queue(const struct netdev *netdev, | |
1112 | unsigned int queue_id, struct shash *details) | |
1113 | { | |
1114 | const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class; | |
1115 | int retval; | |
1116 | ||
1117 | retval = (class->get_queue | |
1118 | ? class->get_queue(netdev, queue_id, details) | |
1119 | : EOPNOTSUPP); | |
1120 | if (retval) { | |
1121 | shash_clear_free_data(details); | |
1122 | } | |
1123 | return retval; | |
1124 | } | |
1125 | ||
1126 | /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value | |
1127 | * string pairs in 'details'. The contents of 'details' should be documented | |
1128 | * as valid for the given 'type' in the "other_config" column in the "Queue" | |
1129 | * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). | |
1130 | * Returns 0 if successful, otherwise a positive errno value. On failure, the | |
1131 | * given queue's configuration should be unmodified. | |
1132 | * | |
1133 | * 'queue_id' must be less than the number of queues supported by 'netdev' for | |
1134 | * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)). | |
1135 | * | |
1136 | * This function does not modify 'details', and the caller retains ownership of | |
c1fdab01 | 1137 | * it. */ |
c1c9c9c4 BP |
1138 | int |
1139 | netdev_set_queue(struct netdev *netdev, | |
1140 | unsigned int queue_id, const struct shash *details) | |
1141 | { | |
1142 | const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class; | |
1143 | return (class->set_queue | |
1144 | ? class->set_queue(netdev, queue_id, details) | |
1145 | : EOPNOTSUPP); | |
1146 | } | |
1147 | ||
1148 | /* Attempts to delete the queue numbered 'queue_id' from 'netdev'. Some kinds | |
1149 | * of QoS may have a fixed set of queues, in which case attempts to delete them | |
1150 | * will fail with EOPNOTSUPP. | |
1151 | * | |
1152 | * Returns 0 if successful, otherwise a positive errno value. On failure, the | |
1153 | * given queue will be unmodified. | |
1154 | * | |
1155 | * 'queue_id' must be less than the number of queues supported by 'netdev' for | |
1156 | * the current form of QoS (e.g. as returned by | |
1157 | * netdev_get_n_queues(netdev)). */ | |
1158 | int | |
1159 | netdev_delete_queue(struct netdev *netdev, unsigned int queue_id) | |
1160 | { | |
1161 | const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class; | |
1162 | return (class->delete_queue | |
1163 | ? class->delete_queue(netdev, queue_id) | |
1164 | : EOPNOTSUPP); | |
1165 | } | |
1166 | ||
1167 | /* Obtains statistics about 'queue_id' on 'netdev'. On success, returns 0 and | |
1168 | * fills 'stats' with the queue's statistics; individual members of 'stats' may | |
1169 | * be set to all-1-bits if the statistic is unavailable. On failure, returns a | |
1170 | * positive errno value and fills 'stats' with all-1-bits. */ | |
1171 | int | |
1172 | netdev_get_queue_stats(const struct netdev *netdev, unsigned int queue_id, | |
1173 | struct netdev_queue_stats *stats) | |
1174 | { | |
1175 | const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class; | |
1176 | int retval; | |
1177 | ||
1178 | retval = (class->get_queue_stats | |
1179 | ? class->get_queue_stats(netdev, queue_id, stats) | |
1180 | : EOPNOTSUPP); | |
1181 | if (retval) { | |
1182 | memset(stats, 0xff, sizeof *stats); | |
1183 | } | |
1184 | return retval; | |
1185 | } | |
1186 | ||
1187 | /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID, | |
1188 | * its configuration, and the 'aux' specified by the caller. The order of | |
1189 | * iteration is unspecified, but (when successful) each queue is visited | |
1190 | * exactly once. | |
1191 | * | |
1192 | * Calling this function may be more efficient than calling netdev_get_queue() | |
1193 | * for every queue. | |
1194 | * | |
1195 | * 'cb' must not modify or free the 'details' argument passed in. | |
1196 | * | |
1197 | * Returns 0 if successful, otherwise a positive errno value. On error, some | |
1198 | * configured queues may not have been included in the iteration. */ | |
1199 | int | |
1200 | netdev_dump_queues(const struct netdev *netdev, | |
1201 | netdev_dump_queues_cb *cb, void *aux) | |
1202 | { | |
1203 | const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class; | |
1204 | return (class->dump_queues | |
1205 | ? class->dump_queues(netdev, cb, aux) | |
1206 | : EOPNOTSUPP); | |
1207 | } | |
1208 | ||
1209 | /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID, | |
1210 | * its statistics, and the 'aux' specified by the caller. The order of | |
1211 | * iteration is unspecified, but (when successful) each queue is visited | |
1212 | * exactly once. | |
1213 | * | |
1214 | * Calling this function may be more efficient than calling | |
1215 | * netdev_get_queue_stats() for every queue. | |
1216 | * | |
1217 | * 'cb' must not modify or free the statistics passed in. | |
1218 | * | |
1219 | * Returns 0 if successful, otherwise a positive errno value. On error, some | |
1220 | * configured queues may not have been included in the iteration. */ | |
1221 | int | |
1222 | netdev_dump_queue_stats(const struct netdev *netdev, | |
1223 | netdev_dump_queue_stats_cb *cb, void *aux) | |
1224 | { | |
1225 | const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class; | |
1226 | return (class->dump_queue_stats | |
1227 | ? class->dump_queue_stats(netdev, cb, aux) | |
1228 | : EOPNOTSUPP); | |
1229 | } | |
1230 | ||
ac4d3bcb EJ |
1231 | /* Returns a sequence number which indicates changes in one of 'netdev''s |
1232 | * properties. The returned sequence will be nonzero so that callers have a | |
1233 | * value which they may use as a reset when tracking 'netdev'. | |
1234 | * | |
1235 | * The returned sequence number will change whenever 'netdev''s flags, | |
1236 | * features, ethernet address, or carrier changes. It may change for other | |
1237 | * reasons as well, or no reason at all. */ | |
1238 | unsigned int | |
1239 | netdev_change_seq(const struct netdev *netdev) | |
1240 | { | |
1241 | return netdev_get_dev(netdev)->netdev_class->change_seq(netdev); | |
1242 | } | |
1243 | ||
8b61709d BP |
1244 | /* If 'netdev' is a VLAN network device (e.g. one created with vconfig(8)), |
1245 | * sets '*vlan_vid' to the VLAN VID associated with that device and returns 0. | |
1246 | * Otherwise returns a errno value (specifically ENOENT if 'netdev_name' is the | |
1247 | * name of a network device that is not a VLAN device) and sets '*vlan_vid' to | |
1248 | * -1. */ | |
1249 | int | |
1250 | netdev_get_vlan_vid(const struct netdev *netdev, int *vlan_vid) | |
064af421 | 1251 | { |
a4af0040 | 1252 | int error = (netdev_get_dev(netdev)->netdev_class->get_vlan_vid |
d295e8e9 | 1253 | ? netdev_get_dev(netdev)->netdev_class->get_vlan_vid(netdev, |
a4af0040 | 1254 | vlan_vid) |
8b61709d BP |
1255 | : ENOENT); |
1256 | if (error) { | |
1257 | *vlan_vid = 0; | |
064af421 | 1258 | } |
8b61709d | 1259 | return error; |
064af421 BP |
1260 | } |
1261 | ||
c752217a BP |
1262 | /* Returns a network device that has 'in4' as its IP address, if one exists, |
1263 | * otherwise a null pointer. */ | |
1264 | struct netdev * | |
1265 | netdev_find_dev_by_in4(const struct in_addr *in4) | |
79c720a8 | 1266 | { |
c752217a | 1267 | struct netdev *netdev; |
19993ef3 BP |
1268 | struct sset dev_list = SSET_INITIALIZER(&dev_list); |
1269 | const char *name; | |
79c720a8 | 1270 | |
79c720a8 | 1271 | netdev_enumerate(&dev_list); |
19993ef3 | 1272 | SSET_FOR_EACH (name, &dev_list) { |
c752217a BP |
1273 | struct in_addr dev_in4; |
1274 | ||
18812dff | 1275 | if (!netdev_open(name, "system", &netdev) |
f1acd62b | 1276 | && !netdev_get_in4(netdev, &dev_in4, NULL) |
c752217a BP |
1277 | && dev_in4.s_addr == in4->s_addr) { |
1278 | goto exit; | |
79c720a8 | 1279 | } |
c752217a | 1280 | netdev_close(netdev); |
79c720a8 | 1281 | } |
c752217a | 1282 | netdev = NULL; |
79c720a8 | 1283 | |
c752217a | 1284 | exit: |
19993ef3 | 1285 | sset_destroy(&dev_list); |
c752217a | 1286 | return netdev; |
79c720a8 | 1287 | } |
8b61709d | 1288 | \f |
6d9e6eb4 BP |
1289 | /* Initializes 'netdev_dev' as a netdev device named 'name' of the specified |
1290 | * 'netdev_class'. This function is ordinarily called from a netdev provider's | |
1291 | * 'create' function. | |
1292 | * | |
149f577a JG |
1293 | * This function adds 'netdev_dev' to a netdev-owned shash, so it is |
1294 | * very important that 'netdev_dev' only be freed after calling | |
1295 | * the refcount drops to zero. */ | |
1296 | void | |
1297 | netdev_dev_init(struct netdev_dev *netdev_dev, const char *name, | |
7dab847a | 1298 | const struct netdev_class *netdev_class) |
149f577a JG |
1299 | { |
1300 | assert(!shash_find(&netdev_dev_shash, name)); | |
1301 | ||
0f4f4a61 | 1302 | memset(netdev_dev, 0, sizeof *netdev_dev); |
7dab847a | 1303 | netdev_dev->netdev_class = netdev_class; |
149f577a JG |
1304 | netdev_dev->name = xstrdup(name); |
1305 | netdev_dev->node = shash_add(&netdev_dev_shash, name, netdev_dev); | |
1306 | } | |
1307 | ||
1308 | /* Undoes the results of initialization. | |
1309 | * | |
1310 | * Normally this function does not need to be called as netdev_close has | |
1311 | * the same effect when the refcount drops to zero. | |
1312 | * However, it may be called by providers due to an error on creation | |
1313 | * that occurs after initialization. It this case netdev_close() would | |
1314 | * never be called. */ | |
6c88d577 | 1315 | void |
149f577a | 1316 | netdev_dev_uninit(struct netdev_dev *netdev_dev, bool destroy) |
6c88d577 | 1317 | { |
149f577a JG |
1318 | char *name = netdev_dev->name; |
1319 | ||
1320 | assert(!netdev_dev->ref_cnt); | |
1321 | ||
1322 | shash_delete(&netdev_dev_shash, netdev_dev->node); | |
6c88d577 | 1323 | |
149f577a | 1324 | if (destroy) { |
a4af0040 | 1325 | netdev_dev->netdev_class->destroy(netdev_dev); |
149f577a JG |
1326 | } |
1327 | free(name); | |
6c88d577 JP |
1328 | } |
1329 | ||
149f577a | 1330 | /* Returns the class type of 'netdev_dev'. |
a740f0de JG |
1331 | * |
1332 | * The caller must not free the returned value. */ | |
149f577a JG |
1333 | const char * |
1334 | netdev_dev_get_type(const struct netdev_dev *netdev_dev) | |
a740f0de | 1335 | { |
a4af0040 | 1336 | return netdev_dev->netdev_class->type; |
a740f0de JG |
1337 | } |
1338 | ||
15b3596a JG |
1339 | /* Returns the class associated with 'netdev_dev'. */ |
1340 | const struct netdev_class * | |
1341 | netdev_dev_get_class(const struct netdev_dev *netdev_dev) | |
1342 | { | |
1343 | return netdev_dev->netdev_class; | |
1344 | } | |
1345 | ||
149f577a | 1346 | /* Returns the name of 'netdev_dev'. |
a740f0de JG |
1347 | * |
1348 | * The caller must not free the returned value. */ | |
149f577a JG |
1349 | const char * |
1350 | netdev_dev_get_name(const struct netdev_dev *netdev_dev) | |
a740f0de | 1351 | { |
149f577a | 1352 | return netdev_dev->name; |
a740f0de JG |
1353 | } |
1354 | ||
46415c90 JG |
1355 | /* Returns the netdev_dev with 'name' or NULL if there is none. |
1356 | * | |
1357 | * The caller must not free the returned value. */ | |
1358 | struct netdev_dev * | |
1359 | netdev_dev_from_name(const char *name) | |
1360 | { | |
1361 | return shash_find_data(&netdev_dev_shash, name); | |
1362 | } | |
1363 | ||
7dab847a | 1364 | /* Fills 'device_list' with devices that match 'netdev_class'. |
46415c90 JG |
1365 | * |
1366 | * The caller is responsible for initializing and destroying 'device_list' | |
1367 | * but the contained netdev_devs must not be freed. */ | |
1368 | void | |
7dab847a | 1369 | netdev_dev_get_devices(const struct netdev_class *netdev_class, |
46415c90 JG |
1370 | struct shash *device_list) |
1371 | { | |
1372 | struct shash_node *node; | |
1373 | SHASH_FOR_EACH (node, &netdev_dev_shash) { | |
1374 | struct netdev_dev *dev = node->data; | |
1375 | ||
7dab847a | 1376 | if (dev->netdev_class == netdev_class) { |
46415c90 JG |
1377 | shash_add(device_list, node->name, node->data); |
1378 | } | |
1379 | } | |
1380 | } | |
1381 | ||
149f577a | 1382 | /* Initializes 'netdev' as a instance of the netdev_dev. |
8b61709d BP |
1383 | * |
1384 | * This function adds 'netdev' to a netdev-owned linked list, so it is very | |
1385 | * important that 'netdev' only be freed after calling netdev_close(). */ | |
1386 | void | |
149f577a | 1387 | netdev_init(struct netdev *netdev, struct netdev_dev *netdev_dev) |
064af421 | 1388 | { |
0f4f4a61 | 1389 | memset(netdev, 0, sizeof *netdev); |
149f577a | 1390 | netdev->netdev_dev = netdev_dev; |
8b61709d BP |
1391 | list_push_back(&netdev_list, &netdev->node); |
1392 | } | |
064af421 | 1393 | |
149f577a JG |
1394 | /* Undoes the results of initialization. |
1395 | * | |
1396 | * Normally this function only needs to be called from netdev_close(). | |
1397 | * However, it may be called by providers due to an error on opening | |
1398 | * that occurs after initialization. It this case netdev_close() would | |
1399 | * never be called. */ | |
1400 | void | |
1401 | netdev_uninit(struct netdev *netdev, bool close) | |
1402 | { | |
1403 | /* Restore flags that we changed, if any. */ | |
1404 | int error = restore_flags(netdev); | |
1405 | list_remove(&netdev->node); | |
1406 | if (error) { | |
1407 | VLOG_WARN("failed to restore network device flags on %s: %s", | |
1408 | netdev_get_name(netdev), strerror(error)); | |
1409 | } | |
1410 | ||
1411 | if (close) { | |
a4af0040 | 1412 | netdev_get_dev(netdev)->netdev_class->close(netdev); |
149f577a JG |
1413 | } |
1414 | } | |
1415 | ||
1416 | ||
d295e8e9 | 1417 | /* Returns the class type of 'netdev'. |
6c88d577 JP |
1418 | * |
1419 | * The caller must not free the returned value. */ | |
149f577a JG |
1420 | const char * |
1421 | netdev_get_type(const struct netdev *netdev) | |
1422 | { | |
a4af0040 | 1423 | return netdev_get_dev(netdev)->netdev_class->type; |
149f577a JG |
1424 | } |
1425 | ||
1426 | struct netdev_dev * | |
1427 | netdev_get_dev(const struct netdev *netdev) | |
6c88d577 | 1428 | { |
149f577a | 1429 | return netdev->netdev_dev; |
6c88d577 | 1430 | } |
e9e28be3 | 1431 | \f |
064af421 BP |
1432 | /* Restore the network device flags on 'netdev' to those that were active |
1433 | * before we changed them. Returns 0 if successful, otherwise a positive | |
1434 | * errno value. | |
1435 | * | |
1436 | * To avoid reentry, the caller must ensure that fatal signals are blocked. */ | |
1437 | static int | |
1438 | restore_flags(struct netdev *netdev) | |
1439 | { | |
8b61709d BP |
1440 | if (netdev->changed_flags) { |
1441 | enum netdev_flags restore = netdev->save_flags & netdev->changed_flags; | |
1442 | enum netdev_flags old_flags; | |
a4af0040 | 1443 | return netdev_get_dev(netdev)->netdev_class->update_flags(netdev, |
8b61709d BP |
1444 | netdev->changed_flags & ~restore, |
1445 | restore, &old_flags); | |
064af421 | 1446 | } |
064af421 BP |
1447 | return 0; |
1448 | } | |
1449 | ||
0b0544d7 JG |
1450 | /* Close all netdevs on shutdown so they can do any needed cleanup such as |
1451 | * destroying devices, restoring flags, etc. */ | |
064af421 | 1452 | static void |
c69ee87c | 1453 | close_all_netdevs(void *aux OVS_UNUSED) |
064af421 | 1454 | { |
0b0544d7 | 1455 | struct netdev *netdev, *next; |
4e8e4213 | 1456 | LIST_FOR_EACH_SAFE(netdev, next, node, &netdev_list) { |
0b0544d7 | 1457 | netdev_close(netdev); |
064af421 BP |
1458 | } |
1459 | } |