patch: Remove veth driver.
[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 "ofpbuf.h"
35 #include "openflow/openflow.h"
36 #include "packets.h"
37 #include "poll-loop.h"
38 #include "shash.h"
39 #include "svec.h"
40
41 #define THIS_MODULE VLM_netdev
42 #include "vlog.h"
43
44 static const struct netdev_class *base_netdev_classes[] = {
45     &netdev_linux_class,
46     &netdev_tap_class,
47     &netdev_patch_class,
48     &netdev_gre_class,
49 };
50
51 static struct shash netdev_classes = SHASH_INITIALIZER(&netdev_classes);
52
53 /* All created network devices. */
54 static struct shash netdev_dev_shash = SHASH_INITIALIZER(&netdev_dev_shash);
55
56 /* All open network devices. */
57 static struct list netdev_list = LIST_INITIALIZER(&netdev_list);
58
59 /* This is set pretty low because we probably won't learn anything from the
60  * additional log messages. */
61 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
62
63 static void close_all_netdevs(void *aux OVS_UNUSED);
64 static int restore_flags(struct netdev *netdev);
65 void update_device_args(struct netdev_dev *, const struct shash *args);
66
67 static void
68 netdev_initialize(void)
69 {
70     static int status = -1;
71
72     if (status < 0) {
73         int i;
74
75         fatal_signal_add_hook(close_all_netdevs, NULL, NULL, true);
76
77         status = 0;
78         for (i = 0; i < ARRAY_SIZE(base_netdev_classes); i++) {
79             netdev_register_provider(base_netdev_classes[i]);
80         }
81     }
82 }
83
84 /* Performs periodic work needed by all the various kinds of netdevs.
85  *
86  * If your program opens any netdevs, it must call this function within its
87  * main poll loop. */
88 void
89 netdev_run(void)
90 {
91     struct shash_node *node;
92     SHASH_FOR_EACH(node, &netdev_classes) {
93         const struct netdev_class *netdev_class = node->data;
94         if (netdev_class->run) {
95             netdev_class->run();
96         }
97     }
98 }
99
100 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
101  *
102  * If your program opens any netdevs, it must call this function within its
103  * main poll loop. */
104 void
105 netdev_wait(void)
106 {
107     struct shash_node *node;
108     SHASH_FOR_EACH(node, &netdev_classes) {
109         const struct netdev_class *netdev_class = node->data;
110         if (netdev_class->wait) {
111             netdev_class->wait();
112         }
113     }
114 }
115
116 /* Initializes and registers a new netdev provider.  After successful
117  * registration, new netdevs of that type can be opened using netdev_open(). */
118 int
119 netdev_register_provider(const struct netdev_class *new_class)
120 {
121     struct netdev_class *new_provider;
122
123     if (shash_find(&netdev_classes, new_class->type)) {
124         VLOG_WARN("attempted to register duplicate netdev provider: %s",
125                    new_class->type);
126         return EEXIST;
127     }
128
129     if (new_class->init) {
130         int error = new_class->init();
131         if (error) {
132             VLOG_ERR("failed to initialize %s network device class: %s",
133                      new_class->type, strerror(error));
134             return error;
135         }
136     }
137
138     new_provider = xmalloc(sizeof *new_provider);
139     memcpy(new_provider, new_class, sizeof *new_provider);
140
141     shash_add(&netdev_classes, new_class->type, new_provider);
142
143     return 0;
144 }
145
146 /* Unregisters a netdev provider.  'type' must have been previously
147  * registered and not currently be in use by any netdevs.  After unregistration
148  * new netdevs of that type cannot be opened using netdev_open(). */
149 int
150 netdev_unregister_provider(const char *type)
151 {
152     struct shash_node *del_node, *netdev_dev_node;
153
154     del_node = shash_find(&netdev_classes, type);
155     if (!del_node) {
156         VLOG_WARN("attempted to unregister a netdev provider that is not "
157                   "registered: %s", type);
158         return EAFNOSUPPORT;
159     }
160
161     SHASH_FOR_EACH(netdev_dev_node, &netdev_dev_shash) {
162         struct netdev_dev *netdev_dev = netdev_dev_node->data;
163         if (!strcmp(netdev_dev->netdev_class->type, type)) {
164             VLOG_WARN("attempted to unregister in use netdev provider: %s",
165                       type);
166             return EBUSY;
167         }
168     }
169
170     shash_delete(&netdev_classes, del_node);
171     free(del_node->data);
172
173     return 0;
174 }
175
176 /* Clears 'types' and enumerates the types of all currently registered netdev
177  * providers into it.  The caller must first initialize the svec. */
178 void
179 netdev_enumerate_types(struct svec *types)
180 {
181     struct shash_node *node;
182
183     netdev_initialize();
184     svec_clear(types);
185
186     SHASH_FOR_EACH(node, &netdev_classes) {
187         const struct netdev_class *netdev_class = node->data;
188         svec_add(types, netdev_class->type);
189     }
190 }
191
192 /* Compares 'args' to those used to those used by 'dev'.  Returns true
193  * if the arguments are the same, false otherwise.  Does not update the
194  * values stored in 'dev'. */
195 static bool
196 compare_device_args(const struct netdev_dev *dev, const struct shash *args)
197 {
198     const struct shash_node **new_args;
199     bool result = true;
200     int i;
201
202     if (shash_count(args) != dev->n_args) {
203         return false;
204     }
205
206     new_args = shash_sort(args);
207     for (i = 0; i < dev->n_args; i++) {
208         if (strcmp(dev->args[i].key, new_args[i]->name) || 
209             strcmp(dev->args[i].value, new_args[i]->data)) {
210             result = false;
211             goto finish;
212         }
213     }
214
215 finish:
216     free(new_args);
217     return result;
218 }
219
220 static int
221 compare_args(const void *a_, const void *b_)
222 {
223     const struct arg *a = a_;
224     const struct arg *b = b_;
225     return strcmp(a->key, b->key);
226 }
227
228 void
229 update_device_args(struct netdev_dev *dev, const struct shash *args)
230 {
231     struct shash_node *node;
232     int i;
233
234     if (dev->n_args) {
235         for (i = 0; i < dev->n_args; i++) {
236             free(dev->args[i].key);
237             free(dev->args[i].value);
238         }
239
240         free(dev->args);
241         dev->n_args = 0;
242     }
243
244     if (!args || shash_is_empty(args)) {
245         return;
246     }
247
248     dev->n_args = shash_count(args);
249     dev->args = xmalloc(dev->n_args * sizeof *dev->args);
250
251     i = 0;
252     SHASH_FOR_EACH(node, args) {
253         dev->args[i].key = xstrdup(node->name);
254         dev->args[i].value = xstrdup(node->data);
255         i++;
256     }
257
258     qsort(dev->args, dev->n_args, sizeof *dev->args, compare_args);
259 }
260
261 static int
262 create_device(struct netdev_options *options, struct netdev_dev **netdev_devp)
263 {
264     struct netdev_class *netdev_class;
265
266     if (!options->may_create) {
267         VLOG_WARN("attempted to create a device that may not be created: %s",
268                   options->name);
269         return ENODEV;
270     }
271
272     if (!options->type || strlen(options->type) == 0) {
273         /* Default to system. */
274         options->type = "system";
275     }
276
277     netdev_class = shash_find_data(&netdev_classes, options->type);
278     if (!netdev_class) {
279         VLOG_WARN("could not create netdev %s of unknown type %s",
280                   options->name, options->type);
281         return EAFNOSUPPORT;
282     }
283
284     return netdev_class->create(options->name, options->type, options->args,
285                                 netdev_devp);
286 }
287
288 /* Opens the network device named 'name' (e.g. "eth0") and returns zero if
289  * successful, otherwise a positive errno value.  On success, sets '*netdevp'
290  * to the new network device, otherwise to null.
291  *
292  * If this is the first time the device has been opened, then create is called
293  * before opening.  The device is  created using the given type and arguments.
294  *
295  * 'ethertype' may be a 16-bit Ethernet protocol value in host byte order to
296  * capture frames of that type received on the device.  It may also be one of
297  * the 'enum netdev_pseudo_ethertype' values to receive frames in one of those
298  * categories.
299  *
300  * If the 'may_create' flag is set then this is allowed to be the first time
301  * the device is opened (i.e. the refcount will be 1 after this call).  It
302  * may be set to false if the device should have already been created.
303  *
304  * If the 'may_open' flag is set then the call will succeed even if another
305  * caller has already opened it.  It may be to false if the device should not
306  * currently be open. */
307
308 int
309 netdev_open(struct netdev_options *options, struct netdev **netdevp)
310 {
311     struct shash empty_args = SHASH_INITIALIZER(&empty_args);
312     struct netdev_dev *netdev_dev;
313     int error;
314
315     *netdevp = NULL;
316     netdev_initialize();
317
318     if (!options->args) {
319         options->args = &empty_args;
320     }
321
322     netdev_dev = shash_find_data(&netdev_dev_shash, options->name);
323
324     if (!netdev_dev) {
325         error = create_device(options, &netdev_dev);
326         if (error) {
327             return error;
328         }
329         update_device_args(netdev_dev, options->args);
330
331     } else if (options->may_open) {
332         if (!shash_is_empty(options->args) &&
333             !compare_device_args(netdev_dev, options->args)) {
334
335             VLOG_WARN("%s: attempted to open already created netdev with "
336                       "different arguments", options->name);
337             return EINVAL;
338         }
339     } else {
340         VLOG_WARN("%s: attempted to create a netdev device with bound name",
341                   options->name);
342         return EEXIST;
343     }
344
345     error = netdev_dev->netdev_class->open(netdev_dev, options->ethertype, 
346                 netdevp);
347
348     if (!error) {
349         netdev_dev->ref_cnt++;
350     } else {
351         if (!netdev_dev->ref_cnt) {
352             netdev_dev_uninit(netdev_dev, true);
353         }
354     }
355
356     return error;
357 }
358
359 int
360 netdev_open_default(const char *name, struct netdev **netdevp)
361 {
362     struct netdev_options options;
363
364     memset(&options, 0, sizeof options);
365
366     options.name = name;
367     options.ethertype = NETDEV_ETH_TYPE_NONE;
368     options.may_create = true;
369     options.may_open = true;
370
371     return netdev_open(&options, netdevp);
372 }
373
374 /* Reconfigures the device 'netdev' with 'args'.  'args' may be empty
375  * or NULL if none are needed. */
376 int
377 netdev_reconfigure(struct netdev *netdev, const struct shash *args)
378 {
379     struct shash empty_args = SHASH_INITIALIZER(&empty_args);
380     struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
381
382     if (!args) {
383         args = &empty_args;
384     }
385
386     if (netdev_dev->netdev_class->reconfigure) {
387         if (!compare_device_args(netdev_dev, args)) {
388             update_device_args(netdev_dev, args);
389             return netdev_dev->netdev_class->reconfigure(netdev_dev, args);
390         }
391     } else if (!shash_is_empty(args)) {
392         VLOG_WARN("%s: arguments provided to device that does not have a "
393                   "reconfigure function", netdev_get_name(netdev));
394     }
395
396     return 0;
397 }
398
399 /* Closes and destroys 'netdev'. */
400 void
401 netdev_close(struct netdev *netdev)
402 {
403     if (netdev) {
404         struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
405
406         assert(netdev_dev->ref_cnt);
407         netdev_dev->ref_cnt--;
408         netdev_uninit(netdev, true);
409
410         /* If the reference count for the netdev device is zero, destroy it. */
411         if (!netdev_dev->ref_cnt) {
412             netdev_dev_uninit(netdev_dev, true);
413         }
414     }
415 }
416
417 /* Returns true if a network device named 'name' exists and may be opened,
418  * otherwise false. */
419 bool
420 netdev_exists(const char *name)
421 {
422     struct netdev *netdev;
423     int error;
424
425     error = netdev_open_default(name, &netdev);
426     if (!error) {
427         netdev_close(netdev);
428         return true;
429     } else {
430         if (error != ENODEV) {
431             VLOG_WARN("failed to open network device %s: %s",
432                       name, strerror(error));
433         }
434         return false;
435     }
436 }
437
438 /* Returns true if a network device named 'name' is currently opened,
439  * otherwise false. */
440 bool
441 netdev_is_open(const char *name)
442 {
443     return !!shash_find_data(&netdev_dev_shash, name);
444 }
445
446 /*  Clears 'svec' and enumerates the names of all known network devices. */
447 int
448 netdev_enumerate(struct svec *svec)
449 {
450     struct shash_node *node;
451     int error = 0;
452
453     netdev_initialize();
454     svec_clear(svec);
455
456     SHASH_FOR_EACH(node, &netdev_classes) {
457         const struct netdev_class *netdev_class = node->data;
458         if (netdev_class->enumerate) {
459             int retval = netdev_class->enumerate(svec);
460             if (retval) {
461                 VLOG_WARN("failed to enumerate %s network devices: %s",
462                           netdev_class->type, strerror(retval));
463                 if (!error) {
464                     error = retval;
465                 }
466             }
467         }
468     }
469
470     return error;
471 }
472
473 /* Attempts to receive a packet from 'netdev' into 'buffer', which the caller
474  * must have initialized with sufficient room for the packet.  The space
475  * required to receive any packet is ETH_HEADER_LEN bytes, plus VLAN_HEADER_LEN
476  * bytes, plus the device's MTU (which may be retrieved via netdev_get_mtu()).
477  * (Some devices do not allow for a VLAN header, in which case VLAN_HEADER_LEN
478  * need not be included.)
479  *
480  * If a packet is successfully retrieved, returns 0.  In this case 'buffer' is
481  * guaranteed to contain at least ETH_TOTAL_MIN bytes.  Otherwise, returns a
482  * positive errno value.  Returns EAGAIN immediately if no packet is ready to
483  * be returned.
484  *
485  * Some network devices may not implement support for this function.  In such
486  * cases this function will always return EOPNOTSUPP.
487  */
488 int
489 netdev_recv(struct netdev *netdev, struct ofpbuf *buffer)
490 {
491     int (*recv)(struct netdev *, void *, size_t);
492     int retval;
493
494     assert(buffer->size == 0);
495     assert(ofpbuf_tailroom(buffer) >= ETH_TOTAL_MIN);
496
497     recv = netdev_get_dev(netdev)->netdev_class->recv;
498     retval = (recv
499               ? (recv)(netdev, buffer->data, ofpbuf_tailroom(buffer))
500               : -EOPNOTSUPP);
501     if (retval >= 0) {
502         COVERAGE_INC(netdev_received);
503         buffer->size += retval;
504         if (buffer->size < ETH_TOTAL_MIN) {
505             ofpbuf_put_zeros(buffer, ETH_TOTAL_MIN - buffer->size);
506         }
507         return 0;
508     } else {
509         return -retval;
510     }
511 }
512
513 /* Registers with the poll loop to wake up from the next call to poll_block()
514  * when a packet is ready to be received with netdev_recv() on 'netdev'. */
515 void
516 netdev_recv_wait(struct netdev *netdev)
517 {
518     void (*recv_wait)(struct netdev *);
519
520     recv_wait = netdev_get_dev(netdev)->netdev_class->recv_wait;
521     if (recv_wait) {
522         recv_wait(netdev);
523     }
524 }
525
526 /* Discards all packets waiting to be received from 'netdev'. */
527 int
528 netdev_drain(struct netdev *netdev)
529 {
530     int (*drain)(struct netdev *);
531
532     drain = netdev_get_dev(netdev)->netdev_class->drain;
533     return drain ? drain(netdev) : 0;
534 }
535
536 /* Sends 'buffer' on 'netdev'.  Returns 0 if successful, otherwise a positive
537  * errno value.  Returns EAGAIN without blocking if the packet cannot be queued
538  * immediately.  Returns EMSGSIZE if a partial packet was transmitted or if
539  * the packet is too big or too small to transmit on the device.
540  *
541  * The caller retains ownership of 'buffer' in all cases.
542  *
543  * The kernel maintains a packet transmission queue, so the caller is not
544  * expected to do additional queuing of packets.
545  *
546  * Some network devices may not implement support for this function.  In such
547  * cases this function will always return EOPNOTSUPP. */
548 int
549 netdev_send(struct netdev *netdev, const struct ofpbuf *buffer)
550 {
551     int (*send)(struct netdev *, const void *, size_t);
552     int error;
553
554     send = netdev_get_dev(netdev)->netdev_class->send;
555     error = send ? (send)(netdev, buffer->data, buffer->size) : EOPNOTSUPP;
556     if (!error) {
557         COVERAGE_INC(netdev_sent);
558     }
559     return error;
560 }
561
562 /* Registers with the poll loop to wake up from the next call to poll_block()
563  * when the packet transmission queue has sufficient room to transmit a packet
564  * with netdev_send().
565  *
566  * The kernel maintains a packet transmission queue, so the client is not
567  * expected to do additional queuing of packets.  Thus, this function is
568  * unlikely to ever be used.  It is included for completeness. */
569 void
570 netdev_send_wait(struct netdev *netdev)
571 {
572     void (*send_wait)(struct netdev *);
573
574     send_wait = netdev_get_dev(netdev)->netdev_class->send_wait;
575     if (send_wait) {
576         send_wait(netdev);
577     }
578 }
579
580 /* Attempts to set 'netdev''s MAC address to 'mac'.  Returns 0 if successful,
581  * otherwise a positive errno value. */
582 int
583 netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
584 {
585     return netdev_get_dev(netdev)->netdev_class->set_etheraddr(netdev, mac);
586 }
587
588 /* Retrieves 'netdev''s MAC address.  If successful, returns 0 and copies the
589  * the MAC address into 'mac'.  On failure, returns a positive errno value and
590  * clears 'mac' to all-zeros. */
591 int
592 netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
593 {
594     return netdev_get_dev(netdev)->netdev_class->get_etheraddr(netdev, mac);
595 }
596
597 /* Returns the name of the network device that 'netdev' represents,
598  * e.g. "eth0".  The caller must not modify or free the returned string. */
599 const char *
600 netdev_get_name(const struct netdev *netdev)
601 {
602     return netdev_get_dev(netdev)->name;
603 }
604
605 /* Retrieves the MTU of 'netdev'.  The MTU is the maximum size of transmitted
606  * (and received) packets, in bytes, not including the hardware header; thus,
607  * this is typically 1500 bytes for Ethernet devices.
608  *
609  * If successful, returns 0 and stores the MTU size in '*mtup'.  On failure,
610  * returns a positive errno value and stores ETH_PAYLOAD_MAX (1500) in
611  * '*mtup'. */
612 int
613 netdev_get_mtu(const struct netdev *netdev, int *mtup)
614 {
615     int error = netdev_get_dev(netdev)->netdev_class->get_mtu(netdev, mtup);
616     if (error) {
617         VLOG_WARN_RL(&rl, "failed to retrieve MTU for network device %s: %s",
618                      netdev_get_name(netdev), strerror(error));
619         *mtup = ETH_PAYLOAD_MAX;
620     }
621     return error;
622 }
623
624 /* Returns the ifindex of 'netdev', if successful, as a positive number.  On
625  * failure, returns a negative errno value.
626  *
627  * The desired semantics of the ifindex value are a combination of those
628  * specified by POSIX for if_nametoindex() and by SNMP for ifIndex.  An ifindex
629  * value should be unique within a host and remain stable at least until
630  * reboot.  SNMP says an ifindex "ranges between 1 and the value of ifNumber"
631  * but many systems do not follow this rule anyhow.
632  *
633  * Some network devices may not implement support for this function.  In such
634  * cases this function will always return -EOPNOTSUPP.
635  */
636 int
637 netdev_get_ifindex(const struct netdev *netdev)
638 {
639     int (*get_ifindex)(const struct netdev *);
640
641     get_ifindex = netdev_get_dev(netdev)->netdev_class->get_ifindex;
642
643     return get_ifindex ? get_ifindex(netdev) : -EOPNOTSUPP;
644 }
645
646 /* Stores the features supported by 'netdev' into each of '*current',
647  * '*advertised', '*supported', and '*peer' that are non-null.  Each value is a
648  * bitmap of "enum ofp_port_features" bits, in host byte order.  Returns 0 if
649  * successful, otherwise a positive errno value.  On failure, all of the
650  * passed-in values are set to 0.
651  *
652  * Some network devices may not implement support for this function.  In such
653  * cases this function will always return EOPNOTSUPP.
654  */
655 int
656 netdev_get_features(struct netdev *netdev,
657                     uint32_t *current, uint32_t *advertised,
658                     uint32_t *supported, uint32_t *peer)
659 {
660     int (*get_features)(struct netdev *netdev,
661                         uint32_t *current, uint32_t *advertised,
662                         uint32_t *supported, uint32_t *peer);
663     uint32_t dummy[4];
664     int error;
665
666     if (!current) {
667         current = &dummy[0];
668     }
669     if (!advertised) {
670         advertised = &dummy[1];
671     }
672     if (!supported) {
673         supported = &dummy[2];
674     }
675     if (!peer) {
676         peer = &dummy[3];
677     }
678
679     get_features = netdev_get_dev(netdev)->netdev_class->get_features;
680     error = get_features
681                     ? get_features(netdev, current, advertised, supported, peer)
682                     : EOPNOTSUPP;
683     if (error) {
684         *current = *advertised = *supported = *peer = 0;
685     }
686     return error;
687 }
688
689 /* Returns the maximum speed of a network connection that has the "enum
690  * ofp_port_features" bits in 'features', in bits per second.  If no bits that
691  * indicate a speed are set in 'features', assumes 100Mbps. */
692 uint64_t
693 netdev_features_to_bps(uint32_t features)
694 {
695     enum {
696         F_10000MB = OFPPF_10GB_FD,
697         F_1000MB = OFPPF_1GB_HD | OFPPF_1GB_FD,
698         F_100MB = OFPPF_100MB_HD | OFPPF_100MB_FD,
699         F_10MB = OFPPF_10MB_HD | OFPPF_10MB_FD
700     };
701
702     return (  features & F_10000MB  ? UINT64_C(10000000000)
703             : features & F_1000MB   ? UINT64_C(1000000000)
704             : features & F_100MB    ? UINT64_C(100000000)
705             : features & F_10MB     ? UINT64_C(10000000)
706                                     : UINT64_C(100000000));
707 }
708
709 /* Returns true if any of the "enum ofp_port_features" bits that indicate a
710  * full-duplex link are set in 'features', otherwise false. */
711 bool
712 netdev_features_is_full_duplex(uint32_t features)
713 {
714     return (features & (OFPPF_10MB_FD | OFPPF_100MB_FD | OFPPF_1GB_FD
715                         | OFPPF_10GB_FD)) != 0;
716 }
717
718 /* Set the features advertised by 'netdev' to 'advertise'.  Returns 0 if
719  * successful, otherwise a positive errno value. */
720 int
721 netdev_set_advertisements(struct netdev *netdev, uint32_t advertise)
722 {
723     return (netdev_get_dev(netdev)->netdev_class->set_advertisements
724             ? netdev_get_dev(netdev)->netdev_class->set_advertisements(
725                     netdev, advertise)
726             : EOPNOTSUPP);
727 }
728
729 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
730  * and '*netmask' to its netmask and returns 0.  Otherwise, returns a positive
731  * errno value and sets '*address' to 0 (INADDR_ANY).
732  *
733  * The following error values have well-defined meanings:
734  *
735  *   - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
736  *
737  *   - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
738  *
739  * 'address' or 'netmask' or both may be null, in which case the address or netmask
740  * is not reported. */
741 int
742 netdev_get_in4(const struct netdev *netdev,
743                struct in_addr *address_, struct in_addr *netmask_)
744 {
745     struct in_addr address;
746     struct in_addr netmask;
747     int error;
748
749     error = (netdev_get_dev(netdev)->netdev_class->get_in4
750              ? netdev_get_dev(netdev)->netdev_class->get_in4(netdev, 
751                     &address, &netmask)
752              : EOPNOTSUPP);
753     if (address_) {
754         address_->s_addr = error ? 0 : address.s_addr;
755     }
756     if (netmask_) {
757         netmask_->s_addr = error ? 0 : netmask.s_addr;
758     }
759     return error;
760 }
761
762 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask.  If
763  * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared.  Returns a
764  * positive errno value. */
765 int
766 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
767 {
768     return (netdev_get_dev(netdev)->netdev_class->set_in4
769             ? netdev_get_dev(netdev)->netdev_class->set_in4(netdev, addr, mask)
770             : EOPNOTSUPP);
771 }
772
773 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
774  * to 'netdev'. */
775 int
776 netdev_add_router(struct netdev *netdev, struct in_addr router)
777 {
778     COVERAGE_INC(netdev_add_router);
779     return (netdev_get_dev(netdev)->netdev_class->add_router
780             ? netdev_get_dev(netdev)->netdev_class->add_router(netdev, router)
781             : EOPNOTSUPP);
782 }
783
784 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
785  * 'netdev'.  If a route cannot not be determined, sets '*next_hop' to 0,
786  * '*netdev_name' to null, and returns a positive errno value.  Otherwise, if a
787  * next hop is found, stores the next hop gateway's address (0 if 'host' is on
788  * a directly connected network) in '*next_hop' and a copy of the name of the
789  * device to reach 'host' in '*netdev_name', and returns 0.  The caller is
790  * responsible for freeing '*netdev_name' (by calling free()). */
791 int
792 netdev_get_next_hop(const struct netdev *netdev,
793                     const struct in_addr *host, struct in_addr *next_hop,
794                     char **netdev_name)
795 {
796     int error = (netdev_get_dev(netdev)->netdev_class->get_next_hop
797                  ? netdev_get_dev(netdev)->netdev_class->get_next_hop(
798                         host, next_hop, netdev_name)
799                  : EOPNOTSUPP);
800     if (error) {
801         next_hop->s_addr = 0;
802         *netdev_name = NULL;
803     }
804     return error;
805 }
806
807 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
808  * returns 0.  Otherwise, returns a positive errno value and sets '*in6' to
809  * all-zero-bits (in6addr_any).
810  *
811  * The following error values have well-defined meanings:
812  *
813  *   - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
814  *
815  *   - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
816  *
817  * 'in6' may be null, in which case the address itself is not reported. */
818 int
819 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
820 {
821     struct in6_addr dummy;
822     int error;
823
824     error = (netdev_get_dev(netdev)->netdev_class->get_in6
825              ? netdev_get_dev(netdev)->netdev_class->get_in6(netdev, 
826                     in6 ? in6 : &dummy)
827              : EOPNOTSUPP);
828     if (error && in6) {
829         memset(in6, 0, sizeof *in6);
830     }
831     return error;
832 }
833
834 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
835  * 'on'.  If 'permanent' is true, the changes will persist; otherwise, they
836  * will be reverted when 'netdev' is closed or the program exits.  Returns 0 if
837  * successful, otherwise a positive errno value. */
838 static int
839 do_update_flags(struct netdev *netdev, enum netdev_flags off,
840                 enum netdev_flags on, enum netdev_flags *old_flagsp,
841                 bool permanent)
842 {
843     enum netdev_flags old_flags;
844     int error;
845
846     error = netdev_get_dev(netdev)->netdev_class->update_flags(netdev, 
847                 off & ~on, on, &old_flags);
848     if (error) {
849         VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
850                      off || on ? "set" : "get", netdev_get_name(netdev),
851                      strerror(error));
852         old_flags = 0;
853     } else if ((off || on) && !permanent) {
854         enum netdev_flags new_flags = (old_flags & ~off) | on;
855         enum netdev_flags changed_flags = old_flags ^ new_flags;
856         if (changed_flags) {
857             if (!netdev->changed_flags) {
858                 netdev->save_flags = old_flags;
859             }
860             netdev->changed_flags |= changed_flags;
861         }
862     }
863     if (old_flagsp) {
864         *old_flagsp = old_flags;
865     }
866     return error;
867 }
868
869 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
870  * Returns 0 if successful, otherwise a positive errno value.  On failure,
871  * stores 0 into '*flagsp'. */
872 int
873 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
874 {
875     struct netdev *netdev = (struct netdev *) netdev_;
876     return do_update_flags(netdev, 0, 0, flagsp, false);
877 }
878
879 /* Sets the flags for 'netdev' to 'flags'.
880  * If 'permanent' is true, the changes will persist; otherwise, they
881  * will be reverted when 'netdev' is closed or the program exits.
882  * Returns 0 if successful, otherwise a positive errno value. */
883 int
884 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
885                  bool permanent)
886 {
887     return do_update_flags(netdev, -1, flags, NULL, permanent);
888 }
889
890 /* Turns on the specified 'flags' on 'netdev'.
891  * If 'permanent' is true, the changes will persist; otherwise, they
892  * will be reverted when 'netdev' is closed or the program exits.
893  * Returns 0 if successful, otherwise a positive errno value. */
894 int
895 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
896                      bool permanent)
897 {
898     return do_update_flags(netdev, 0, flags, NULL, permanent);
899 }
900
901 /* Turns off the specified 'flags' on 'netdev'.
902  * If 'permanent' is true, the changes will persist; otherwise, they
903  * will be reverted when 'netdev' is closed or the program exits.
904  * Returns 0 if successful, otherwise a positive errno value. */
905 int
906 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
907                       bool permanent)
908 {
909     return do_update_flags(netdev, flags, 0, NULL, permanent);
910 }
911
912 /* Looks up the ARP table entry for 'ip' on 'netdev'.  If one exists and can be
913  * successfully retrieved, it stores the corresponding MAC address in 'mac' and
914  * returns 0.  Otherwise, it returns a positive errno value; in particular,
915  * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
916 int
917 netdev_arp_lookup(const struct netdev *netdev,
918                   uint32_t ip, uint8_t mac[ETH_ADDR_LEN])
919 {
920     int error = (netdev_get_dev(netdev)->netdev_class->arp_lookup
921                  ? netdev_get_dev(netdev)->netdev_class->arp_lookup(netdev, 
922                         ip, mac)
923                  : EOPNOTSUPP);
924     if (error) {
925         memset(mac, 0, ETH_ADDR_LEN);
926     }
927     return error;
928 }
929
930 /* Sets 'carrier' to true if carrier is active (link light is on) on
931  * 'netdev'. */
932 int
933 netdev_get_carrier(const struct netdev *netdev, bool *carrier)
934 {
935     int error = (netdev_get_dev(netdev)->netdev_class->get_carrier
936                  ? netdev_get_dev(netdev)->netdev_class->get_carrier(netdev, 
937                         carrier)
938                  : EOPNOTSUPP);
939     if (error) {
940         *carrier = false;
941     }
942     return error;
943 }
944
945 /* Retrieves current device stats for 'netdev'. */
946 int
947 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
948 {
949     int error;
950
951     COVERAGE_INC(netdev_get_stats);
952     error = (netdev_get_dev(netdev)->netdev_class->get_stats
953              ? netdev_get_dev(netdev)->netdev_class->get_stats(netdev, stats)
954              : EOPNOTSUPP);
955     if (error) {
956         memset(stats, 0xff, sizeof *stats);
957     }
958     return error;
959 }
960
961 /* Attempts to change the stats for 'netdev' to those provided in 'stats'.
962  * Returns 0 if successful, otherwise a positive errno value.
963  *
964  * This will probably fail for most network devices.  Some devices might only
965  * allow setting their stats to 0. */
966 int
967 netdev_set_stats(struct netdev *netdev, const struct netdev_stats *stats)
968 {
969     return (netdev_get_dev(netdev)->netdev_class->set_stats
970              ? netdev_get_dev(netdev)->netdev_class->set_stats(netdev, stats)
971              : EOPNOTSUPP);
972 }
973
974 /* Attempts to set input rate limiting (policing) policy, such that up to
975  * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
976  * size of 'kbits' kb. */
977 int
978 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
979                     uint32_t kbits_burst)
980 {
981     return (netdev_get_dev(netdev)->netdev_class->set_policing
982             ? netdev_get_dev(netdev)->netdev_class->set_policing(netdev, 
983                     kbits_rate, kbits_burst)
984             : EOPNOTSUPP);
985 }
986
987 /* If 'netdev' is a VLAN network device (e.g. one created with vconfig(8)),
988  * sets '*vlan_vid' to the VLAN VID associated with that device and returns 0.
989  * Otherwise returns a errno value (specifically ENOENT if 'netdev_name' is the
990  * name of a network device that is not a VLAN device) and sets '*vlan_vid' to
991  * -1. */
992 int
993 netdev_get_vlan_vid(const struct netdev *netdev, int *vlan_vid)
994 {
995     int error = (netdev_get_dev(netdev)->netdev_class->get_vlan_vid
996                  ? netdev_get_dev(netdev)->netdev_class->get_vlan_vid(netdev, 
997                         vlan_vid)
998                  : ENOENT);
999     if (error) {
1000         *vlan_vid = 0;
1001     }
1002     return error;
1003 }
1004
1005 /* Returns a network device that has 'in4' as its IP address, if one exists,
1006  * otherwise a null pointer. */
1007 struct netdev *
1008 netdev_find_dev_by_in4(const struct in_addr *in4)
1009 {
1010     struct netdev *netdev;
1011     struct svec dev_list = SVEC_EMPTY_INITIALIZER;
1012     size_t i;
1013
1014     netdev_enumerate(&dev_list);
1015     for (i = 0; i < dev_list.n; i++) {
1016         const char *name = dev_list.names[i];
1017         struct in_addr dev_in4;
1018
1019         if (!netdev_open_default(name, &netdev)
1020             && !netdev_get_in4(netdev, &dev_in4, NULL)
1021             && dev_in4.s_addr == in4->s_addr) {
1022             goto exit;
1023         }
1024         netdev_close(netdev);
1025     }
1026     netdev = NULL;
1027
1028 exit:
1029     svec_destroy(&dev_list);
1030     return netdev;
1031 }
1032 \f
1033 /* Initializes 'netdev_dev' as a netdev device named 'name' of the
1034  * specified 'netdev_class'.
1035  *
1036  * This function adds 'netdev_dev' to a netdev-owned shash, so it is
1037  * very important that 'netdev_dev' only be freed after calling
1038  * the refcount drops to zero.  */
1039 void
1040 netdev_dev_init(struct netdev_dev *netdev_dev, const char *name,
1041                 const struct netdev_class *netdev_class)
1042 {
1043     assert(!shash_find(&netdev_dev_shash, name));
1044
1045     memset(netdev_dev, 0, sizeof *netdev_dev);
1046     netdev_dev->netdev_class = netdev_class;
1047     netdev_dev->name = xstrdup(name);
1048     netdev_dev->node = shash_add(&netdev_dev_shash, name, netdev_dev);
1049 }
1050
1051 /* Undoes the results of initialization.
1052  *
1053  * Normally this function does not need to be called as netdev_close has
1054  * the same effect when the refcount drops to zero.
1055  * However, it may be called by providers due to an error on creation
1056  * that occurs after initialization.  It this case netdev_close() would
1057  * never be called. */
1058 void
1059 netdev_dev_uninit(struct netdev_dev *netdev_dev, bool destroy)
1060 {
1061     char *name = netdev_dev->name;
1062
1063     assert(!netdev_dev->ref_cnt);
1064
1065     shash_delete(&netdev_dev_shash, netdev_dev->node);
1066     update_device_args(netdev_dev, NULL);
1067
1068     if (destroy) {
1069         netdev_dev->netdev_class->destroy(netdev_dev);
1070     }
1071     free(name);
1072 }
1073
1074 /* Returns the class type of 'netdev_dev'.
1075  *
1076  * The caller must not free the returned value. */
1077 const char *
1078 netdev_dev_get_type(const struct netdev_dev *netdev_dev)
1079 {
1080     return netdev_dev->netdev_class->type;
1081 }
1082
1083 /* Returns the class associated with 'netdev_dev'. */
1084 const struct netdev_class *
1085 netdev_dev_get_class(const struct netdev_dev *netdev_dev)
1086 {
1087     return netdev_dev->netdev_class;
1088 }
1089
1090 /* Returns the name of 'netdev_dev'.
1091  *
1092  * The caller must not free the returned value. */
1093 const char *
1094 netdev_dev_get_name(const struct netdev_dev *netdev_dev)
1095 {
1096     return netdev_dev->name;
1097 }
1098
1099 /* Returns the netdev_dev with 'name' or NULL if there is none.
1100  *
1101  * The caller must not free the returned value. */
1102 struct netdev_dev *
1103 netdev_dev_from_name(const char *name)
1104 {
1105     return shash_find_data(&netdev_dev_shash, name);
1106 }
1107
1108 /* Fills 'device_list' with devices that match 'netdev_class'.
1109  *
1110  * The caller is responsible for initializing and destroying 'device_list'
1111  * but the contained netdev_devs must not be freed. */
1112 void
1113 netdev_dev_get_devices(const struct netdev_class *netdev_class,
1114                        struct shash *device_list)
1115 {
1116     struct shash_node *node;
1117     SHASH_FOR_EACH (node, &netdev_dev_shash) {
1118         struct netdev_dev *dev = node->data;
1119
1120         if (dev->netdev_class == netdev_class) {
1121             shash_add(device_list, node->name, node->data);
1122         }
1123     }
1124 }
1125
1126 /* Initializes 'netdev' as a instance of the netdev_dev.
1127  *
1128  * This function adds 'netdev' to a netdev-owned linked list, so it is very
1129  * important that 'netdev' only be freed after calling netdev_close(). */
1130 void
1131 netdev_init(struct netdev *netdev, struct netdev_dev *netdev_dev)
1132 {
1133     memset(netdev, 0, sizeof *netdev);
1134     netdev->netdev_dev = netdev_dev;
1135     list_push_back(&netdev_list, &netdev->node);
1136 }
1137
1138 /* Undoes the results of initialization.
1139  *
1140  * Normally this function only needs to be called from netdev_close().
1141  * However, it may be called by providers due to an error on opening
1142  * that occurs after initialization.  It this case netdev_close() would
1143  * never be called. */
1144 void
1145 netdev_uninit(struct netdev *netdev, bool close)
1146 {
1147     /* Restore flags that we changed, if any. */
1148     int error = restore_flags(netdev);
1149     list_remove(&netdev->node);
1150     if (error) {
1151         VLOG_WARN("failed to restore network device flags on %s: %s",
1152                   netdev_get_name(netdev), strerror(error));
1153     }
1154
1155     if (close) {
1156         netdev_get_dev(netdev)->netdev_class->close(netdev);
1157     }
1158 }
1159
1160
1161 /* Returns the class type of 'netdev'.  
1162  *
1163  * The caller must not free the returned value. */
1164 const char *
1165 netdev_get_type(const struct netdev *netdev)
1166 {
1167     return netdev_get_dev(netdev)->netdev_class->type;
1168 }
1169
1170 struct netdev_dev *
1171 netdev_get_dev(const struct netdev *netdev)
1172 {
1173     return netdev->netdev_dev;
1174 }
1175
1176 /* Initializes 'notifier' as a netdev notifier for 'netdev', for which
1177  * notification will consist of calling 'cb', with auxiliary data 'aux'. */
1178 void
1179 netdev_notifier_init(struct netdev_notifier *notifier, struct netdev *netdev,
1180                      void (*cb)(struct netdev_notifier *), void *aux)
1181 {
1182     notifier->netdev = netdev;
1183     notifier->cb = cb;
1184     notifier->aux = aux;
1185 }
1186 \f
1187 /* Tracks changes in the status of a set of network devices. */
1188 struct netdev_monitor {
1189     struct shash polled_netdevs;
1190     struct shash changed_netdevs;
1191 };
1192
1193 /* Creates and returns a new structure for monitor changes in the status of
1194  * network devices. */
1195 struct netdev_monitor *
1196 netdev_monitor_create(void)
1197 {
1198     struct netdev_monitor *monitor = xmalloc(sizeof *monitor);
1199     shash_init(&monitor->polled_netdevs);
1200     shash_init(&monitor->changed_netdevs);
1201     return monitor;
1202 }
1203
1204 /* Destroys 'monitor'. */
1205 void
1206 netdev_monitor_destroy(struct netdev_monitor *monitor)
1207 {
1208     if (monitor) {
1209         struct shash_node *node;
1210
1211         SHASH_FOR_EACH (node, &monitor->polled_netdevs) {
1212             struct netdev_notifier *notifier = node->data;
1213             netdev_get_dev(notifier->netdev)->netdev_class->poll_remove(
1214                     notifier);
1215         }
1216
1217         shash_destroy(&monitor->polled_netdevs);
1218         shash_destroy(&monitor->changed_netdevs);
1219         free(monitor);
1220     }
1221 }
1222
1223 static void
1224 netdev_monitor_cb(struct netdev_notifier *notifier)
1225 {
1226     struct netdev_monitor *monitor = notifier->aux;
1227     const char *name = netdev_get_name(notifier->netdev);
1228     if (!shash_find(&monitor->changed_netdevs, name)) {
1229         shash_add(&monitor->changed_netdevs, name, NULL);
1230     }
1231 }
1232
1233 /* Attempts to add 'netdev' as a netdev monitored by 'monitor'.  Returns 0 if
1234  * successful, otherwise a positive errno value.
1235  *
1236  * Adding a given 'netdev' to a monitor multiple times is equivalent to adding
1237  * it once. */
1238 int
1239 netdev_monitor_add(struct netdev_monitor *monitor, struct netdev *netdev)
1240 {
1241     const char *netdev_name = netdev_get_name(netdev);
1242     int error = 0;
1243     if (!shash_find(&monitor->polled_netdevs, netdev_name)
1244             && netdev_get_dev(netdev)->netdev_class->poll_add)
1245     {
1246         struct netdev_notifier *notifier;
1247         error = netdev_get_dev(netdev)->netdev_class->poll_add(netdev,
1248                     netdev_monitor_cb, monitor, &notifier);
1249         if (!error) {
1250             assert(notifier->netdev == netdev);
1251             shash_add(&monitor->polled_netdevs, netdev_name, notifier);
1252         }
1253     }
1254     return error;
1255 }
1256
1257 /* Removes 'netdev' from the set of netdevs monitored by 'monitor'.  (This has
1258  * no effect if 'netdev' is not in the set of devices monitored by
1259  * 'monitor'.) */
1260 void
1261 netdev_monitor_remove(struct netdev_monitor *monitor, struct netdev *netdev)
1262 {
1263     const char *netdev_name = netdev_get_name(netdev);
1264     struct shash_node *node;
1265
1266     node = shash_find(&monitor->polled_netdevs, netdev_name);
1267     if (node) {
1268         /* Cancel future notifications. */
1269         struct netdev_notifier *notifier = node->data;
1270         netdev_get_dev(netdev)->netdev_class->poll_remove(notifier);
1271         shash_delete(&monitor->polled_netdevs, node);
1272
1273         /* Drop any pending notification. */
1274         node = shash_find(&monitor->changed_netdevs, netdev_name);
1275         if (node) {
1276             shash_delete(&monitor->changed_netdevs, node);
1277         }
1278     }
1279 }
1280
1281 /* Checks for changes to netdevs in the set monitored by 'monitor'.  If any of
1282  * the attributes (Ethernet address, carrier status, speed or peer-advertised
1283  * speed, flags, etc.) of a network device monitored by 'monitor' has changed,
1284  * sets '*devnamep' to the name of a device that has changed and returns 0.
1285  * The caller is responsible for freeing '*devnamep' (with free()).
1286  *
1287  * If no devices have changed, sets '*devnamep' to NULL and returns EAGAIN.
1288  */
1289 int
1290 netdev_monitor_poll(struct netdev_monitor *monitor, char **devnamep)
1291 {
1292     struct shash_node *node = shash_first(&monitor->changed_netdevs);
1293     if (!node) {
1294         *devnamep = NULL;
1295         return EAGAIN;
1296     } else {
1297         *devnamep = xstrdup(node->name);
1298         shash_delete(&monitor->changed_netdevs, node);
1299         return 0;
1300     }
1301 }
1302
1303 /* Registers with the poll loop to wake up from the next call to poll_block()
1304  * when netdev_monitor_poll(monitor) would indicate that a device has
1305  * changed. */
1306 void
1307 netdev_monitor_poll_wait(const struct netdev_monitor *monitor)
1308 {
1309     if (!shash_is_empty(&monitor->changed_netdevs)) {
1310         poll_immediate_wake();
1311     } else {
1312         /* XXX Nothing needed here for netdev_linux, but maybe other netdev
1313          * classes need help. */
1314     }
1315 }
1316 \f
1317 /* Restore the network device flags on 'netdev' to those that were active
1318  * before we changed them.  Returns 0 if successful, otherwise a positive
1319  * errno value.
1320  *
1321  * To avoid reentry, the caller must ensure that fatal signals are blocked. */
1322 static int
1323 restore_flags(struct netdev *netdev)
1324 {
1325     if (netdev->changed_flags) {
1326         enum netdev_flags restore = netdev->save_flags & netdev->changed_flags;
1327         enum netdev_flags old_flags;
1328         return netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
1329                                            netdev->changed_flags & ~restore,
1330                                            restore, &old_flags);
1331     }
1332     return 0;
1333 }
1334
1335 /* Close all netdevs on shutdown so they can do any needed cleanup such as
1336  * destroying devices, restoring flags, etc. */
1337 static void
1338 close_all_netdevs(void *aux OVS_UNUSED)
1339 {
1340     struct netdev *netdev, *next;
1341     LIST_FOR_EACH_SAFE(netdev, next, struct netdev, node, &netdev_list) {
1342         netdev_close(netdev);
1343     }
1344 }