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