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