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