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