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