New action NXAST_RESUBMIT_TABLE.
[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 /* 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 /*  Clears 'sset' and enumerates the names of all known network devices. */
336 int
337 netdev_enumerate(struct sset *sset)
338 {
339     struct shash_node *node;
340     int error = 0;
341
342     netdev_initialize();
343     sset_clear(sset);
344
345     SHASH_FOR_EACH(node, &netdev_classes) {
346         const struct netdev_class *netdev_class = node->data;
347         if (netdev_class->enumerate) {
348             int retval = netdev_class->enumerate(sset);
349             if (retval) {
350                 VLOG_WARN("failed to enumerate %s network devices: %s",
351                           netdev_class->type, strerror(retval));
352                 if (!error) {
353                     error = retval;
354                 }
355             }
356         }
357     }
358
359     return error;
360 }
361
362 /* Attempts to set up 'netdev' for receiving packets with netdev_recv().
363  * Returns 0 if successful, otherwise a positive errno value.  EOPNOTSUPP
364  * indicates that the network device does not implement packet reception
365  * through this interface. */
366 int
367 netdev_listen(struct netdev *netdev)
368 {
369     int (*listen)(struct netdev *);
370
371     listen = netdev_get_dev(netdev)->netdev_class->listen;
372     return listen ? (listen)(netdev) : EOPNOTSUPP;
373 }
374
375 /* Attempts to receive a packet from 'netdev' into 'buffer', which the caller
376  * must have initialized with sufficient room for the packet.  The space
377  * required to receive any packet is ETH_HEADER_LEN bytes, plus VLAN_HEADER_LEN
378  * bytes, plus the device's MTU (which may be retrieved via netdev_get_mtu()).
379  * (Some devices do not allow for a VLAN header, in which case VLAN_HEADER_LEN
380  * need not be included.)
381  *
382  * This function can only be expected to return a packet if ->listen() has
383  * been called successfully.
384  *
385  * If a packet is successfully retrieved, returns 0.  In this case 'buffer' is
386  * guaranteed to contain at least ETH_TOTAL_MIN bytes.  Otherwise, returns a
387  * positive errno value.  Returns EAGAIN immediately if no packet is ready to
388  * be returned.
389  *
390  * Some network devices may not implement support for this function.  In such
391  * cases this function will always return EOPNOTSUPP. */
392 int
393 netdev_recv(struct netdev *netdev, struct ofpbuf *buffer)
394 {
395     int (*recv)(struct netdev *, void *, size_t);
396     int retval;
397
398     assert(buffer->size == 0);
399     assert(ofpbuf_tailroom(buffer) >= ETH_TOTAL_MIN);
400
401     recv = netdev_get_dev(netdev)->netdev_class->recv;
402     retval = (recv
403               ? (recv)(netdev, buffer->data, ofpbuf_tailroom(buffer))
404               : -EOPNOTSUPP);
405     if (retval >= 0) {
406         COVERAGE_INC(netdev_received);
407         buffer->size += retval;
408         if (buffer->size < ETH_TOTAL_MIN) {
409             ofpbuf_put_zeros(buffer, ETH_TOTAL_MIN - buffer->size);
410         }
411         return 0;
412     } else {
413         return -retval;
414     }
415 }
416
417 /* Registers with the poll loop to wake up from the next call to poll_block()
418  * when a packet is ready to be received with netdev_recv() on 'netdev'. */
419 void
420 netdev_recv_wait(struct netdev *netdev)
421 {
422     void (*recv_wait)(struct netdev *);
423
424     recv_wait = netdev_get_dev(netdev)->netdev_class->recv_wait;
425     if (recv_wait) {
426         recv_wait(netdev);
427     }
428 }
429
430 /* Discards all packets waiting to be received from 'netdev'. */
431 int
432 netdev_drain(struct netdev *netdev)
433 {
434     int (*drain)(struct netdev *);
435
436     drain = netdev_get_dev(netdev)->netdev_class->drain;
437     return drain ? drain(netdev) : 0;
438 }
439
440 /* Sends 'buffer' on 'netdev'.  Returns 0 if successful, otherwise a positive
441  * errno value.  Returns EAGAIN without blocking if the packet cannot be queued
442  * immediately.  Returns EMSGSIZE if a partial packet was transmitted or if
443  * the packet is too big or too small to transmit on the device.
444  *
445  * The caller retains ownership of 'buffer' in all cases.
446  *
447  * The kernel maintains a packet transmission queue, so the caller is not
448  * expected to do additional queuing of packets.
449  *
450  * Some network devices may not implement support for this function.  In such
451  * cases this function will always return EOPNOTSUPP. */
452 int
453 netdev_send(struct netdev *netdev, const struct ofpbuf *buffer)
454 {
455     int (*send)(struct netdev *, const void *, size_t);
456     int error;
457
458     send = netdev_get_dev(netdev)->netdev_class->send;
459     error = send ? (send)(netdev, buffer->data, buffer->size) : EOPNOTSUPP;
460     if (!error) {
461         COVERAGE_INC(netdev_sent);
462     }
463     return error;
464 }
465
466 /* Registers with the poll loop to wake up from the next call to poll_block()
467  * when the packet transmission queue has sufficient room to transmit a packet
468  * with netdev_send().
469  *
470  * The kernel maintains a packet transmission queue, so the client is not
471  * expected to do additional queuing of packets.  Thus, this function is
472  * unlikely to ever be used.  It is included for completeness. */
473 void
474 netdev_send_wait(struct netdev *netdev)
475 {
476     void (*send_wait)(struct netdev *);
477
478     send_wait = netdev_get_dev(netdev)->netdev_class->send_wait;
479     if (send_wait) {
480         send_wait(netdev);
481     }
482 }
483
484 /* Attempts to set 'netdev''s MAC address to 'mac'.  Returns 0 if successful,
485  * otherwise a positive errno value. */
486 int
487 netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
488 {
489     return netdev_get_dev(netdev)->netdev_class->set_etheraddr(netdev, mac);
490 }
491
492 /* Retrieves 'netdev''s MAC address.  If successful, returns 0 and copies the
493  * the MAC address into 'mac'.  On failure, returns a positive errno value and
494  * clears 'mac' to all-zeros. */
495 int
496 netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
497 {
498     return netdev_get_dev(netdev)->netdev_class->get_etheraddr(netdev, mac);
499 }
500
501 /* Returns the name of the network device that 'netdev' represents,
502  * e.g. "eth0".  The caller must not modify or free the returned string. */
503 const char *
504 netdev_get_name(const struct netdev *netdev)
505 {
506     return netdev_get_dev(netdev)->name;
507 }
508
509 /* Retrieves the MTU of 'netdev'.  The MTU is the maximum size of transmitted
510  * (and received) packets, in bytes, not including the hardware header; thus,
511  * this is typically 1500 bytes for Ethernet devices.
512  *
513  * If successful, returns 0 and stores the MTU size in '*mtup'.  Stores INT_MAX
514  * in '*mtup' if 'netdev' does not have an MTU (as e.g. some tunnels do not).On
515  * failure, returns a positive errno value and stores ETH_PAYLOAD_MAX (1500) in
516  * '*mtup'. */
517 int
518 netdev_get_mtu(const struct netdev *netdev, int *mtup)
519 {
520     int error = netdev_get_dev(netdev)->netdev_class->get_mtu(netdev, mtup);
521     if (error) {
522         VLOG_WARN_RL(&rl, "failed to retrieve MTU for network device %s: %s",
523                      netdev_get_name(netdev), strerror(error));
524         *mtup = ETH_PAYLOAD_MAX;
525     }
526     return error;
527 }
528
529 /* Returns the ifindex of 'netdev', if successful, as a positive number.  On
530  * failure, returns a negative errno value.
531  *
532  * The desired semantics of the ifindex value are a combination of those
533  * specified by POSIX for if_nametoindex() and by SNMP for ifIndex.  An ifindex
534  * value should be unique within a host and remain stable at least until
535  * reboot.  SNMP says an ifindex "ranges between 1 and the value of ifNumber"
536  * but many systems do not follow this rule anyhow.
537  *
538  * Some network devices may not implement support for this function.  In such
539  * cases this function will always return -EOPNOTSUPP.
540  */
541 int
542 netdev_get_ifindex(const struct netdev *netdev)
543 {
544     int (*get_ifindex)(const struct netdev *);
545
546     get_ifindex = netdev_get_dev(netdev)->netdev_class->get_ifindex;
547
548     return get_ifindex ? get_ifindex(netdev) : -EOPNOTSUPP;
549 }
550
551 /* Stores the features supported by 'netdev' into each of '*current',
552  * '*advertised', '*supported', and '*peer' that are non-null.  Each value is a
553  * bitmap of "enum ofp_port_features" bits, in host byte order.  Returns 0 if
554  * successful, otherwise a positive errno value.  On failure, all of the
555  * passed-in values are set to 0.
556  *
557  * Some network devices may not implement support for this function.  In such
558  * cases this function will always return EOPNOTSUPP. */
559 int
560 netdev_get_features(const struct netdev *netdev,
561                     uint32_t *current, uint32_t *advertised,
562                     uint32_t *supported, uint32_t *peer)
563 {
564     int (*get_features)(const struct netdev *netdev,
565                         uint32_t *current, uint32_t *advertised,
566                         uint32_t *supported, uint32_t *peer);
567     uint32_t dummy[4];
568     int error;
569
570     if (!current) {
571         current = &dummy[0];
572     }
573     if (!advertised) {
574         advertised = &dummy[1];
575     }
576     if (!supported) {
577         supported = &dummy[2];
578     }
579     if (!peer) {
580         peer = &dummy[3];
581     }
582
583     get_features = netdev_get_dev(netdev)->netdev_class->get_features;
584     error = get_features
585                     ? get_features(netdev, current, advertised, supported, peer)
586                     : EOPNOTSUPP;
587     if (error) {
588         *current = *advertised = *supported = *peer = 0;
589     }
590     return error;
591 }
592
593 /* Returns the maximum speed of a network connection that has the "enum
594  * ofp_port_features" bits in 'features', in bits per second.  If no bits that
595  * indicate a speed are set in 'features', assumes 100Mbps. */
596 uint64_t
597 netdev_features_to_bps(uint32_t features)
598 {
599     enum {
600         F_10000MB = OFPPF_10GB_FD,
601         F_1000MB = OFPPF_1GB_HD | OFPPF_1GB_FD,
602         F_100MB = OFPPF_100MB_HD | OFPPF_100MB_FD,
603         F_10MB = OFPPF_10MB_HD | OFPPF_10MB_FD
604     };
605
606     return (  features & F_10000MB  ? UINT64_C(10000000000)
607             : features & F_1000MB   ? UINT64_C(1000000000)
608             : features & F_100MB    ? UINT64_C(100000000)
609             : features & F_10MB     ? UINT64_C(10000000)
610                                     : UINT64_C(100000000));
611 }
612
613 /* Returns true if any of the "enum ofp_port_features" bits that indicate a
614  * full-duplex link are set in 'features', otherwise false. */
615 bool
616 netdev_features_is_full_duplex(uint32_t features)
617 {
618     return (features & (OFPPF_10MB_FD | OFPPF_100MB_FD | OFPPF_1GB_FD
619                         | OFPPF_10GB_FD)) != 0;
620 }
621
622 /* Set the features advertised by 'netdev' to 'advertise'.  Returns 0 if
623  * successful, otherwise a positive errno value. */
624 int
625 netdev_set_advertisements(struct netdev *netdev, uint32_t advertise)
626 {
627     return (netdev_get_dev(netdev)->netdev_class->set_advertisements
628             ? netdev_get_dev(netdev)->netdev_class->set_advertisements(
629                     netdev, advertise)
630             : EOPNOTSUPP);
631 }
632
633 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
634  * and '*netmask' to its netmask and returns 0.  Otherwise, returns a positive
635  * errno value and sets '*address' to 0 (INADDR_ANY).
636  *
637  * The following error values have well-defined meanings:
638  *
639  *   - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
640  *
641  *   - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
642  *
643  * 'address' or 'netmask' or both may be null, in which case the address or 
644  * netmask is not reported. */
645 int
646 netdev_get_in4(const struct netdev *netdev,
647                struct in_addr *address_, struct in_addr *netmask_)
648 {
649     struct in_addr address;
650     struct in_addr netmask;
651     int error;
652
653     error = (netdev_get_dev(netdev)->netdev_class->get_in4
654              ? netdev_get_dev(netdev)->netdev_class->get_in4(netdev,
655                     &address, &netmask)
656              : EOPNOTSUPP);
657     if (address_) {
658         address_->s_addr = error ? 0 : address.s_addr;
659     }
660     if (netmask_) {
661         netmask_->s_addr = error ? 0 : netmask.s_addr;
662     }
663     return error;
664 }
665
666 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask.  If
667  * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared.  Returns a
668  * positive errno value. */
669 int
670 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
671 {
672     return (netdev_get_dev(netdev)->netdev_class->set_in4
673             ? netdev_get_dev(netdev)->netdev_class->set_in4(netdev, addr, mask)
674             : EOPNOTSUPP);
675 }
676
677 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
678  * to 'netdev'. */
679 int
680 netdev_add_router(struct netdev *netdev, struct in_addr router)
681 {
682     COVERAGE_INC(netdev_add_router);
683     return (netdev_get_dev(netdev)->netdev_class->add_router
684             ? netdev_get_dev(netdev)->netdev_class->add_router(netdev, router)
685             : EOPNOTSUPP);
686 }
687
688 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
689  * 'netdev'.  If a route cannot not be determined, sets '*next_hop' to 0,
690  * '*netdev_name' to null, and returns a positive errno value.  Otherwise, if a
691  * next hop is found, stores the next hop gateway's address (0 if 'host' is on
692  * a directly connected network) in '*next_hop' and a copy of the name of the
693  * device to reach 'host' in '*netdev_name', and returns 0.  The caller is
694  * responsible for freeing '*netdev_name' (by calling free()). */
695 int
696 netdev_get_next_hop(const struct netdev *netdev,
697                     const struct in_addr *host, struct in_addr *next_hop,
698                     char **netdev_name)
699 {
700     int error = (netdev_get_dev(netdev)->netdev_class->get_next_hop
701                  ? netdev_get_dev(netdev)->netdev_class->get_next_hop(
702                         host, next_hop, netdev_name)
703                  : EOPNOTSUPP);
704     if (error) {
705         next_hop->s_addr = 0;
706         *netdev_name = NULL;
707     }
708     return error;
709 }
710
711 /* Populates 'sh' with status information.
712  *
713  * Populates 'sh' with 'netdev' specific status information.  This information
714  * may be used to populate the status column of the Interface table as defined
715  * in ovs-vswitchd.conf.db(5). */
716 int
717 netdev_get_status(const struct netdev *netdev, struct shash *sh)
718 {
719     struct netdev_dev *dev = netdev_get_dev(netdev);
720
721     return (dev->netdev_class->get_status
722             ? dev->netdev_class->get_status(netdev, sh)
723             : EOPNOTSUPP);
724 }
725
726 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
727  * returns 0.  Otherwise, returns a positive errno value and sets '*in6' to
728  * all-zero-bits (in6addr_any).
729  *
730  * The following error values have well-defined meanings:
731  *
732  *   - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
733  *
734  *   - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
735  *
736  * 'in6' may be null, in which case the address itself is not reported. */
737 int
738 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
739 {
740     struct in6_addr dummy;
741     int error;
742
743     error = (netdev_get_dev(netdev)->netdev_class->get_in6
744              ? netdev_get_dev(netdev)->netdev_class->get_in6(netdev,
745                     in6 ? in6 : &dummy)
746              : EOPNOTSUPP);
747     if (error && in6) {
748         memset(in6, 0, sizeof *in6);
749     }
750     return error;
751 }
752
753 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
754  * 'on'.  If 'permanent' is true, the changes will persist; otherwise, they
755  * will be reverted when 'netdev' is closed or the program exits.  Returns 0 if
756  * successful, otherwise a positive errno value. */
757 static int
758 do_update_flags(struct netdev *netdev, enum netdev_flags off,
759                 enum netdev_flags on, enum netdev_flags *old_flagsp,
760                 bool permanent)
761 {
762     enum netdev_flags old_flags;
763     int error;
764
765     error = netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
766                 off & ~on, on, &old_flags);
767     if (error) {
768         VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
769                      off || on ? "set" : "get", netdev_get_name(netdev),
770                      strerror(error));
771         old_flags = 0;
772     } else if ((off || on) && !permanent) {
773         enum netdev_flags new_flags = (old_flags & ~off) | on;
774         enum netdev_flags changed_flags = old_flags ^ new_flags;
775         if (changed_flags) {
776             if (!netdev->changed_flags) {
777                 netdev->save_flags = old_flags;
778             }
779             netdev->changed_flags |= changed_flags;
780         }
781     }
782     if (old_flagsp) {
783         *old_flagsp = old_flags;
784     }
785     return error;
786 }
787
788 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
789  * Returns 0 if successful, otherwise a positive errno value.  On failure,
790  * stores 0 into '*flagsp'. */
791 int
792 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
793 {
794     struct netdev *netdev = (struct netdev *) netdev_;
795     return do_update_flags(netdev, 0, 0, flagsp, false);
796 }
797
798 /* Sets the flags for 'netdev' to 'flags'.
799  * If 'permanent' is true, the changes will persist; otherwise, they
800  * will be reverted when 'netdev' is closed or the program exits.
801  * Returns 0 if successful, otherwise a positive errno value. */
802 int
803 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
804                  bool permanent)
805 {
806     return do_update_flags(netdev, -1, flags, NULL, permanent);
807 }
808
809 /* Turns on the specified 'flags' on 'netdev'.
810  * If 'permanent' is true, the changes will persist; otherwise, they
811  * will be reverted when 'netdev' is closed or the program exits.
812  * Returns 0 if successful, otherwise a positive errno value. */
813 int
814 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
815                      bool permanent)
816 {
817     return do_update_flags(netdev, 0, flags, NULL, permanent);
818 }
819
820 /* Turns off the specified 'flags' on 'netdev'.
821  * If 'permanent' is true, the changes will persist; otherwise, they
822  * will be reverted when 'netdev' is closed or the program exits.
823  * Returns 0 if successful, otherwise a positive errno value. */
824 int
825 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
826                       bool permanent)
827 {
828     return do_update_flags(netdev, flags, 0, NULL, permanent);
829 }
830
831 /* Looks up the ARP table entry for 'ip' on 'netdev'.  If one exists and can be
832  * successfully retrieved, it stores the corresponding MAC address in 'mac' and
833  * returns 0.  Otherwise, it returns a positive errno value; in particular,
834  * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
835 int
836 netdev_arp_lookup(const struct netdev *netdev,
837                   ovs_be32 ip, uint8_t mac[ETH_ADDR_LEN])
838 {
839     int error = (netdev_get_dev(netdev)->netdev_class->arp_lookup
840                  ? netdev_get_dev(netdev)->netdev_class->arp_lookup(netdev,
841                         ip, mac)
842                  : EOPNOTSUPP);
843     if (error) {
844         memset(mac, 0, ETH_ADDR_LEN);
845     }
846     return error;
847 }
848
849 /* Returns true if carrier is active (link light is on) on 'netdev'. */
850 bool
851 netdev_get_carrier(const struct netdev *netdev)
852 {
853     int error;
854     enum netdev_flags flags;
855     bool carrier;
856
857     netdev_get_flags(netdev, &flags);
858     if (!(flags & NETDEV_UP)) {
859         return false;
860     }
861
862     if (!netdev_get_dev(netdev)->netdev_class->get_carrier) {
863         return true;
864     }
865
866     error = netdev_get_dev(netdev)->netdev_class->get_carrier(netdev,
867                                                               &carrier);
868     if (error) {
869         VLOG_DBG("%s: failed to get network device carrier status, assuming "
870                  "down: %s", netdev_get_name(netdev), strerror(error));
871         carrier = false;
872     }
873
874     return carrier;
875 }
876
877 /* Attempts to force netdev_get_carrier() to poll 'netdev''s MII registers for
878  * link status instead of checking 'netdev''s carrier.  'netdev''s MII
879  * registers will be polled once ever 'interval' milliseconds.  If 'netdev'
880  * does not support MII, another method may be used as a fallback.  If
881  * 'interval' is less than or equal to zero, reverts netdev_get_carrier() to
882  * its normal behavior.
883  *
884  * Returns 0 if successful, otherwise a positive errno value. */
885 int
886 netdev_set_miimon_interval(struct netdev *netdev, long long int interval)
887 {
888     struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
889     return (netdev_dev->netdev_class->set_miimon_interval
890             ? netdev_dev->netdev_class->set_miimon_interval(netdev, interval)
891             : EOPNOTSUPP);
892 }
893
894 /* Retrieves current device stats for 'netdev'. */
895 int
896 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
897 {
898     int error;
899
900     COVERAGE_INC(netdev_get_stats);
901     error = (netdev_get_dev(netdev)->netdev_class->get_stats
902              ? netdev_get_dev(netdev)->netdev_class->get_stats(netdev, stats)
903              : EOPNOTSUPP);
904     if (error) {
905         memset(stats, 0xff, sizeof *stats);
906     }
907     return error;
908 }
909
910 /* Attempts to change the stats for 'netdev' to those provided in 'stats'.
911  * Returns 0 if successful, otherwise a positive errno value.
912  *
913  * This will probably fail for most network devices.  Some devices might only
914  * allow setting their stats to 0. */
915 int
916 netdev_set_stats(struct netdev *netdev, const struct netdev_stats *stats)
917 {
918     return (netdev_get_dev(netdev)->netdev_class->set_stats
919              ? netdev_get_dev(netdev)->netdev_class->set_stats(netdev, stats)
920              : EOPNOTSUPP);
921 }
922
923 /* Attempts to set input rate limiting (policing) policy, such that up to
924  * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
925  * size of 'kbits' kb. */
926 int
927 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
928                     uint32_t kbits_burst)
929 {
930     return (netdev_get_dev(netdev)->netdev_class->set_policing
931             ? netdev_get_dev(netdev)->netdev_class->set_policing(netdev,
932                     kbits_rate, kbits_burst)
933             : EOPNOTSUPP);
934 }
935
936 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
937  * empty if 'netdev' does not support QoS.  Any names added to 'types' should
938  * be documented as valid for the "type" column in the "QoS" table in
939  * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
940  *
941  * Every network device supports disabling QoS with a type of "", but this type
942  * will not be added to 'types'.
943  *
944  * The caller must initialize 'types' (e.g. with sset_init()) before calling
945  * this function.  The caller is responsible for destroying 'types' (e.g. with
946  * sset_destroy()) when it is no longer needed.
947  *
948  * Returns 0 if successful, otherwise a positive errno value. */
949 int
950 netdev_get_qos_types(const struct netdev *netdev, struct sset *types)
951 {
952     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
953     return (class->get_qos_types
954             ? class->get_qos_types(netdev, types)
955             : 0);
956 }
957
958 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
959  * which should be "" or one of the types returned by netdev_get_qos_types()
960  * for 'netdev'.  Returns 0 if successful, otherwise a positive errno value.
961  * On success, initializes 'caps' with the QoS capabilities; on failure, clears
962  * 'caps' to all zeros. */
963 int
964 netdev_get_qos_capabilities(const struct netdev *netdev, const char *type,
965                             struct netdev_qos_capabilities *caps)
966 {
967     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
968
969     if (*type) {
970         int retval = (class->get_qos_capabilities
971                       ? class->get_qos_capabilities(netdev, type, caps)
972                       : EOPNOTSUPP);
973         if (retval) {
974             memset(caps, 0, sizeof *caps);
975         }
976         return retval;
977     } else {
978         /* Every netdev supports turning off QoS. */
979         memset(caps, 0, sizeof *caps);
980         return 0;
981     }
982 }
983
984 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
985  * of QoS.  Returns 0 if successful, otherwise a positive errno value.  Stores
986  * the number of queues (zero on failure) in '*n_queuesp'.
987  *
988  * This is just a simple wrapper around netdev_get_qos_capabilities(). */
989 int
990 netdev_get_n_queues(const struct netdev *netdev,
991                     const char *type, unsigned int *n_queuesp)
992 {
993     struct netdev_qos_capabilities caps;
994     int retval;
995
996     retval = netdev_get_qos_capabilities(netdev, type, &caps);
997     *n_queuesp = caps.n_queues;
998     return retval;
999 }
1000
1001 /* Queries 'netdev' about its currently configured form of QoS.  If successful,
1002  * stores the name of the current form of QoS into '*typep', stores any details
1003  * of configuration as string key-value pairs in 'details', and returns 0.  On
1004  * failure, sets '*typep' to NULL and returns a positive errno value.
1005  *
1006  * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1007  *
1008  * The caller must initialize 'details' as an empty shash (e.g. with
1009  * shash_init()) before calling this function.  The caller must free 'details',
1010  * including 'data' members, when it is no longer needed (e.g. with
1011  * shash_destroy_free_data()).
1012  *
1013  * The caller must not modify or free '*typep'.
1014  *
1015  * '*typep' will be one of the types returned by netdev_get_qos_types() for
1016  * 'netdev'.  The contents of 'details' should be documented as valid for
1017  * '*typep' in the "other_config" column in the "QoS" table in
1018  * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1019 int
1020 netdev_get_qos(const struct netdev *netdev,
1021                const char **typep, struct shash *details)
1022 {
1023     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1024     int retval;
1025
1026     if (class->get_qos) {
1027         retval = class->get_qos(netdev, typep, details);
1028         if (retval) {
1029             *typep = NULL;
1030             shash_clear_free_data(details);
1031         }
1032         return retval;
1033     } else {
1034         /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1035         *typep = "";
1036         return 0;
1037     }
1038 }
1039
1040 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1041  * with details of configuration from 'details'.  Returns 0 if successful,
1042  * otherwise a positive errno value.  On error, the previous QoS configuration
1043  * is retained.
1044  *
1045  * When this function changes the type of QoS (not just 'details'), this also
1046  * resets all queue configuration for 'netdev' to their defaults (which depend
1047  * on the specific type of QoS).  Otherwise, the queue configuration for
1048  * 'netdev' is unchanged.
1049  *
1050  * 'type' should be "" (to disable QoS) or one of the types returned by
1051  * netdev_get_qos_types() for 'netdev'.  The contents of 'details' should be
1052  * documented as valid for the given 'type' in the "other_config" column in the
1053  * "QoS" table in vswitchd/vswitch.xml (which is built as
1054  * ovs-vswitchd.conf.db(8)).
1055  *
1056  * NULL may be specified for 'details' if there are no configuration
1057  * details. */
1058 int
1059 netdev_set_qos(struct netdev *netdev,
1060                const char *type, const struct shash *details)
1061 {
1062     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1063
1064     if (!type) {
1065         type = "";
1066     }
1067
1068     if (class->set_qos) {
1069         if (!details) {
1070             static struct shash empty = SHASH_INITIALIZER(&empty);
1071             details = &empty;
1072         }
1073         return class->set_qos(netdev, type, details);
1074     } else {
1075         return *type ? EOPNOTSUPP : 0;
1076     }
1077 }
1078
1079 /* Queries 'netdev' for information about the queue numbered 'queue_id'.  If
1080  * successful, adds that information as string key-value pairs to 'details'.
1081  * Returns 0 if successful, otherwise a positive errno value.
1082  *
1083  * 'queue_id' must be less than the number of queues supported by 'netdev' for
1084  * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1085  *
1086  * The returned contents of 'details' should be documented as valid for the
1087  * given 'type' in the "other_config" column in the "Queue" table in
1088  * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1089  *
1090  * The caller must initialize 'details' (e.g. with shash_init()) before calling
1091  * this function.  The caller must free 'details', including 'data' members,
1092  * when it is no longer needed (e.g. with shash_destroy_free_data()). */
1093 int
1094 netdev_get_queue(const struct netdev *netdev,
1095                  unsigned int queue_id, struct shash *details)
1096 {
1097     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1098     int retval;
1099
1100     retval = (class->get_queue
1101               ? class->get_queue(netdev, queue_id, details)
1102               : EOPNOTSUPP);
1103     if (retval) {
1104         shash_clear_free_data(details);
1105     }
1106     return retval;
1107 }
1108
1109 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1110  * string pairs in 'details'.  The contents of 'details' should be documented
1111  * as valid for the given 'type' in the "other_config" column in the "Queue"
1112  * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1113  * Returns 0 if successful, otherwise a positive errno value.  On failure, the
1114  * given queue's configuration should be unmodified.
1115  *
1116  * 'queue_id' must be less than the number of queues supported by 'netdev' for
1117  * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1118  *
1119  * This function does not modify 'details', and the caller retains ownership of
1120  * it. */
1121 int
1122 netdev_set_queue(struct netdev *netdev,
1123                  unsigned int queue_id, const struct shash *details)
1124 {
1125     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1126     return (class->set_queue
1127             ? class->set_queue(netdev, queue_id, details)
1128             : EOPNOTSUPP);
1129 }
1130
1131 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'.  Some kinds
1132  * of QoS may have a fixed set of queues, in which case attempts to delete them
1133  * will fail with EOPNOTSUPP.
1134  *
1135  * Returns 0 if successful, otherwise a positive errno value.  On failure, the
1136  * given queue will be unmodified.
1137  *
1138  * 'queue_id' must be less than the number of queues supported by 'netdev' for
1139  * the current form of QoS (e.g. as returned by
1140  * netdev_get_n_queues(netdev)). */
1141 int
1142 netdev_delete_queue(struct netdev *netdev, unsigned int queue_id)
1143 {
1144     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1145     return (class->delete_queue
1146             ? class->delete_queue(netdev, queue_id)
1147             : EOPNOTSUPP);
1148 }
1149
1150 /* Obtains statistics about 'queue_id' on 'netdev'.  On success, returns 0 and
1151  * fills 'stats' with the queue's statistics; individual members of 'stats' may
1152  * be set to all-1-bits if the statistic is unavailable.  On failure, returns a
1153  * positive errno value and fills 'stats' with all-1-bits. */
1154 int
1155 netdev_get_queue_stats(const struct netdev *netdev, unsigned int queue_id,
1156                        struct netdev_queue_stats *stats)
1157 {
1158     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1159     int retval;
1160
1161     retval = (class->get_queue_stats
1162               ? class->get_queue_stats(netdev, queue_id, stats)
1163               : EOPNOTSUPP);
1164     if (retval) {
1165         memset(stats, 0xff, sizeof *stats);
1166     }
1167     return retval;
1168 }
1169
1170 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1171  * its configuration, and the 'aux' specified by the caller.  The order of
1172  * iteration is unspecified, but (when successful) each queue is visited
1173  * exactly once.
1174  *
1175  * Calling this function may be more efficient than calling netdev_get_queue()
1176  * for every queue.
1177  *
1178  * 'cb' must not modify or free the 'details' argument passed in.
1179  *
1180  * Returns 0 if successful, otherwise a positive errno value.  On error, some
1181  * configured queues may not have been included in the iteration. */
1182 int
1183 netdev_dump_queues(const struct netdev *netdev,
1184                    netdev_dump_queues_cb *cb, void *aux)
1185 {
1186     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1187     return (class->dump_queues
1188             ? class->dump_queues(netdev, cb, aux)
1189             : EOPNOTSUPP);
1190 }
1191
1192 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1193  * its statistics, and the 'aux' specified by the caller.  The order of
1194  * iteration is unspecified, but (when successful) each queue is visited
1195  * exactly once.
1196  *
1197  * Calling this function may be more efficient than calling
1198  * netdev_get_queue_stats() for every queue.
1199  *
1200  * 'cb' must not modify or free the statistics passed in.
1201  *
1202  * Returns 0 if successful, otherwise a positive errno value.  On error, some
1203  * configured queues may not have been included in the iteration. */
1204 int
1205 netdev_dump_queue_stats(const struct netdev *netdev,
1206                         netdev_dump_queue_stats_cb *cb, void *aux)
1207 {
1208     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1209     return (class->dump_queue_stats
1210             ? class->dump_queue_stats(netdev, cb, aux)
1211             : EOPNOTSUPP);
1212 }
1213
1214 /* Returns a sequence number which indicates changes in one of 'netdev''s
1215  * properties.  The returned sequence will be nonzero so that callers have a
1216  * value which they may use as a reset when tracking 'netdev'.
1217  *
1218  * The returned sequence number will change whenever 'netdev''s flags,
1219  * features, ethernet address, or carrier changes.  It may change for other
1220  * reasons as well, or no reason at all. */
1221 unsigned int
1222 netdev_change_seq(const struct netdev *netdev)
1223 {
1224     return netdev_get_dev(netdev)->netdev_class->change_seq(netdev);
1225 }
1226
1227 /* If 'netdev' is a VLAN network device (e.g. one created with vconfig(8)),
1228  * sets '*vlan_vid' to the VLAN VID associated with that device and returns 0.
1229  * Otherwise returns a errno value (specifically ENOENT if 'netdev_name' is the
1230  * name of a network device that is not a VLAN device) and sets '*vlan_vid' to
1231  * -1. */
1232 int
1233 netdev_get_vlan_vid(const struct netdev *netdev, int *vlan_vid)
1234 {
1235     int error = (netdev_get_dev(netdev)->netdev_class->get_vlan_vid
1236                  ? netdev_get_dev(netdev)->netdev_class->get_vlan_vid(netdev,
1237                         vlan_vid)
1238                  : ENOENT);
1239     if (error) {
1240         *vlan_vid = 0;
1241     }
1242     return error;
1243 }
1244
1245 /* Returns a network device that has 'in4' as its IP address, if one exists,
1246  * otherwise a null pointer. */
1247 struct netdev *
1248 netdev_find_dev_by_in4(const struct in_addr *in4)
1249 {
1250     struct netdev *netdev;
1251     struct sset dev_list = SSET_INITIALIZER(&dev_list);
1252     const char *name;
1253
1254     netdev_enumerate(&dev_list);
1255     SSET_FOR_EACH (name, &dev_list) {
1256         struct in_addr dev_in4;
1257
1258         if (!netdev_open(name, "system", &netdev)
1259             && !netdev_get_in4(netdev, &dev_in4, NULL)
1260             && dev_in4.s_addr == in4->s_addr) {
1261             goto exit;
1262         }
1263         netdev_close(netdev);
1264     }
1265     netdev = NULL;
1266
1267 exit:
1268     sset_destroy(&dev_list);
1269     return netdev;
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 }