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