2 * Copyright (c) 2008, 2009, 2010 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
23 #include <netinet/in.h>
29 #include "dynamic-string.h"
30 #include "fatal-signal.h"
33 #include "netdev-provider.h"
35 #include "openflow/openflow.h"
37 #include "poll-loop.h"
41 #define THIS_MODULE VLM_netdev
44 static const struct netdev_class *base_netdev_classes[] = {
52 static struct shash netdev_classes = SHASH_INITIALIZER(&netdev_classes);
54 /* All created network devices. */
55 static struct shash netdev_dev_shash = SHASH_INITIALIZER(&netdev_dev_shash);
57 /* All open network devices. */
58 static struct list netdev_list = LIST_INITIALIZER(&netdev_list);
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);
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);
69 netdev_initialize(void)
71 static int status = -1;
76 fatal_signal_add_hook(close_all_netdevs, NULL, NULL, true);
79 for (i = 0; i < ARRAY_SIZE(base_netdev_classes); i++) {
80 netdev_register_provider(base_netdev_classes[i]);
85 /* Performs periodic work needed by all the various kinds of netdevs.
87 * If your program opens any netdevs, it must call this function within its
92 struct shash_node *node;
93 SHASH_FOR_EACH(node, &netdev_classes) {
94 const struct netdev_class *netdev_class = node->data;
95 if (netdev_class->run) {
101 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
103 * If your program opens any netdevs, it must call this function within its
108 struct shash_node *node;
109 SHASH_FOR_EACH(node, &netdev_classes) {
110 const struct netdev_class *netdev_class = node->data;
111 if (netdev_class->wait) {
112 netdev_class->wait();
117 /* Initializes and registers a new netdev provider. After successful
118 * registration, new netdevs of that type can be opened using netdev_open(). */
120 netdev_register_provider(const struct netdev_class *new_class)
122 struct netdev_class *new_provider;
124 if (shash_find(&netdev_classes, new_class->type)) {
125 VLOG_WARN("attempted to register duplicate netdev provider: %s",
130 if (new_class->init) {
131 int error = new_class->init();
133 VLOG_ERR("failed to initialize %s network device class: %s",
134 new_class->type, strerror(error));
139 new_provider = xmalloc(sizeof *new_provider);
140 memcpy(new_provider, new_class, sizeof *new_provider);
142 shash_add(&netdev_classes, new_class->type, new_provider);
147 /* Unregisters a netdev provider. 'type' must have been previously
148 * registered and not currently be in use by any netdevs. After unregistration
149 * new netdevs of that type cannot be opened using netdev_open(). */
151 netdev_unregister_provider(const char *type)
153 struct shash_node *del_node, *netdev_dev_node;
155 del_node = shash_find(&netdev_classes, type);
157 VLOG_WARN("attempted to unregister a netdev provider that is not "
158 "registered: %s", type);
162 SHASH_FOR_EACH(netdev_dev_node, &netdev_dev_shash) {
163 struct netdev_dev *netdev_dev = netdev_dev_node->data;
164 if (!strcmp(netdev_dev->netdev_class->type, type)) {
165 VLOG_WARN("attempted to unregister in use netdev provider: %s",
171 shash_delete(&netdev_classes, del_node);
172 free(del_node->data);
177 /* Clears 'types' and enumerates the types of all currently registered netdev
178 * providers into it. The caller must first initialize the svec. */
180 netdev_enumerate_types(struct svec *types)
182 struct shash_node *node;
187 SHASH_FOR_EACH(node, &netdev_classes) {
188 const struct netdev_class *netdev_class = node->data;
189 svec_add(types, netdev_class->type);
193 /* Compares 'args' to those used to those used by 'dev'. Returns true
194 * if the arguments are the same, false otherwise. Does not update the
195 * values stored in 'dev'. */
197 compare_device_args(const struct netdev_dev *dev, const struct shash *args)
199 const struct shash_node **new_args;
203 if (shash_count(args) != dev->n_args) {
207 new_args = shash_sort(args);
208 for (i = 0; i < dev->n_args; i++) {
209 if (strcmp(dev->args[i].key, new_args[i]->name) ||
210 strcmp(dev->args[i].value, new_args[i]->data)) {
222 compare_args(const void *a_, const void *b_)
224 const struct arg *a = a_;
225 const struct arg *b = b_;
226 return strcmp(a->key, b->key);
230 update_device_args(struct netdev_dev *dev, const struct shash *args)
232 struct shash_node *node;
236 for (i = 0; i < dev->n_args; i++) {
237 free(dev->args[i].key);
238 free(dev->args[i].value);
245 if (!args || shash_is_empty(args)) {
249 dev->n_args = shash_count(args);
250 dev->args = xmalloc(dev->n_args * sizeof *dev->args);
253 SHASH_FOR_EACH(node, args) {
254 dev->args[i].key = xstrdup(node->name);
255 dev->args[i].value = xstrdup(node->data);
259 qsort(dev->args, dev->n_args, sizeof *dev->args, compare_args);
263 create_device(struct netdev_options *options, struct netdev_dev **netdev_devp)
265 struct netdev_class *netdev_class;
267 if (!options->may_create) {
268 VLOG_WARN("attempted to create a device that may not be created: %s",
273 if (!options->type || strlen(options->type) == 0) {
274 /* Default to system. */
275 options->type = "system";
278 netdev_class = shash_find_data(&netdev_classes, options->type);
280 VLOG_WARN("could not create netdev %s of unknown type %s",
281 options->name, options->type);
285 return netdev_class->create(options->name, options->type, options->args,
289 /* Opens the network device named 'name' (e.g. "eth0") and returns zero if
290 * successful, otherwise a positive errno value. On success, sets '*netdevp'
291 * to the new network device, otherwise to null.
293 * If this is the first time the device has been opened, then create is called
294 * before opening. The device is created using the given type and arguments.
296 * 'ethertype' may be a 16-bit Ethernet protocol value in host byte order to
297 * capture frames of that type received on the device. It may also be one of
298 * the 'enum netdev_pseudo_ethertype' values to receive frames in one of those
301 * If the 'may_create' flag is set then this is allowed to be the first time
302 * the device is opened (i.e. the refcount will be 1 after this call). It
303 * may be set to false if the device should have already been created.
305 * If the 'may_open' flag is set then the call will succeed even if another
306 * caller has already opened it. It may be to false if the device should not
307 * currently be open. */
310 netdev_open(struct netdev_options *options, struct netdev **netdevp)
312 struct shash empty_args = SHASH_INITIALIZER(&empty_args);
313 struct netdev_dev *netdev_dev;
319 if (!options->args) {
320 options->args = &empty_args;
323 netdev_dev = shash_find_data(&netdev_dev_shash, options->name);
326 error = create_device(options, &netdev_dev);
330 update_device_args(netdev_dev, options->args);
332 } else if (options->may_open) {
333 if (!shash_is_empty(options->args) &&
334 !compare_device_args(netdev_dev, options->args)) {
336 VLOG_WARN("%s: attempted to open already created netdev with "
337 "different arguments", options->name);
341 VLOG_WARN("%s: attempted to create a netdev device with bound name",
346 error = netdev_dev->netdev_class->open(netdev_dev, options->ethertype,
350 netdev_dev->ref_cnt++;
352 if (!netdev_dev->ref_cnt) {
353 netdev_dev_uninit(netdev_dev, true);
361 netdev_open_default(const char *name, struct netdev **netdevp)
363 struct netdev_options options;
365 memset(&options, 0, sizeof options);
368 options.ethertype = NETDEV_ETH_TYPE_NONE;
369 options.may_create = true;
370 options.may_open = true;
372 return netdev_open(&options, netdevp);
375 /* Reconfigures the device 'netdev' with 'args'. 'args' may be empty
376 * or NULL if none are needed. */
378 netdev_reconfigure(struct netdev *netdev, const struct shash *args)
380 struct shash empty_args = SHASH_INITIALIZER(&empty_args);
381 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
387 if (netdev_dev->netdev_class->reconfigure) {
388 if (!compare_device_args(netdev_dev, args)) {
389 update_device_args(netdev_dev, args);
390 return netdev_dev->netdev_class->reconfigure(netdev_dev, args);
392 } else if (!shash_is_empty(args)) {
393 VLOG_WARN("%s: arguments provided to device that does not have a "
394 "reconfigure function", netdev_get_name(netdev));
400 /* Closes and destroys 'netdev'. */
402 netdev_close(struct netdev *netdev)
405 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
407 assert(netdev_dev->ref_cnt);
408 netdev_dev->ref_cnt--;
409 netdev_uninit(netdev, true);
411 /* If the reference count for the netdev device is zero, destroy it. */
412 if (!netdev_dev->ref_cnt) {
413 netdev_dev_uninit(netdev_dev, true);
418 /* Returns true if a network device named 'name' exists and may be opened,
419 * otherwise false. */
421 netdev_exists(const char *name)
423 struct netdev *netdev;
426 error = netdev_open_default(name, &netdev);
428 netdev_close(netdev);
431 if (error != ENODEV) {
432 VLOG_WARN("failed to open network device %s: %s",
433 name, strerror(error));
439 /* Returns true if a network device named 'name' is currently opened,
440 * otherwise false. */
442 netdev_is_open(const char *name)
444 return !!shash_find_data(&netdev_dev_shash, name);
447 /* Clears 'svec' and enumerates the names of all known network devices. */
449 netdev_enumerate(struct svec *svec)
451 struct shash_node *node;
457 SHASH_FOR_EACH(node, &netdev_classes) {
458 const struct netdev_class *netdev_class = node->data;
459 if (netdev_class->enumerate) {
460 int retval = netdev_class->enumerate(svec);
462 VLOG_WARN("failed to enumerate %s network devices: %s",
463 netdev_class->type, strerror(retval));
474 /* Attempts to receive a packet from 'netdev' into 'buffer', which the caller
475 * must have initialized with sufficient room for the packet. The space
476 * required to receive any packet is ETH_HEADER_LEN bytes, plus VLAN_HEADER_LEN
477 * bytes, plus the device's MTU (which may be retrieved via netdev_get_mtu()).
478 * (Some devices do not allow for a VLAN header, in which case VLAN_HEADER_LEN
479 * need not be included.)
481 * If a packet is successfully retrieved, returns 0. In this case 'buffer' is
482 * guaranteed to contain at least ETH_TOTAL_MIN bytes. Otherwise, returns a
483 * positive errno value. Returns EAGAIN immediately if no packet is ready to
486 * Some network devices may not implement support for this function. In such
487 * cases this function will always return EOPNOTSUPP.
490 netdev_recv(struct netdev *netdev, struct ofpbuf *buffer)
492 int (*recv)(struct netdev *, void *, size_t);
495 assert(buffer->size == 0);
496 assert(ofpbuf_tailroom(buffer) >= ETH_TOTAL_MIN);
498 recv = netdev_get_dev(netdev)->netdev_class->recv;
500 ? (recv)(netdev, buffer->data, ofpbuf_tailroom(buffer))
503 COVERAGE_INC(netdev_received);
504 buffer->size += retval;
505 if (buffer->size < ETH_TOTAL_MIN) {
506 ofpbuf_put_zeros(buffer, ETH_TOTAL_MIN - buffer->size);
514 /* Registers with the poll loop to wake up from the next call to poll_block()
515 * when a packet is ready to be received with netdev_recv() on 'netdev'. */
517 netdev_recv_wait(struct netdev *netdev)
519 void (*recv_wait)(struct netdev *);
521 recv_wait = netdev_get_dev(netdev)->netdev_class->recv_wait;
527 /* Discards all packets waiting to be received from 'netdev'. */
529 netdev_drain(struct netdev *netdev)
531 int (*drain)(struct netdev *);
533 drain = netdev_get_dev(netdev)->netdev_class->drain;
534 return drain ? drain(netdev) : 0;
537 /* Sends 'buffer' on 'netdev'. Returns 0 if successful, otherwise a positive
538 * errno value. Returns EAGAIN without blocking if the packet cannot be queued
539 * immediately. Returns EMSGSIZE if a partial packet was transmitted or if
540 * the packet is too big or too small to transmit on the device.
542 * The caller retains ownership of 'buffer' in all cases.
544 * The kernel maintains a packet transmission queue, so the caller is not
545 * expected to do additional queuing of packets.
547 * Some network devices may not implement support for this function. In such
548 * cases this function will always return EOPNOTSUPP. */
550 netdev_send(struct netdev *netdev, const struct ofpbuf *buffer)
552 int (*send)(struct netdev *, const void *, size_t);
555 send = netdev_get_dev(netdev)->netdev_class->send;
556 error = send ? (send)(netdev, buffer->data, buffer->size) : EOPNOTSUPP;
558 COVERAGE_INC(netdev_sent);
563 /* Registers with the poll loop to wake up from the next call to poll_block()
564 * when the packet transmission queue has sufficient room to transmit a packet
565 * with netdev_send().
567 * The kernel maintains a packet transmission queue, so the client is not
568 * expected to do additional queuing of packets. Thus, this function is
569 * unlikely to ever be used. It is included for completeness. */
571 netdev_send_wait(struct netdev *netdev)
573 void (*send_wait)(struct netdev *);
575 send_wait = netdev_get_dev(netdev)->netdev_class->send_wait;
581 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
582 * otherwise a positive errno value. */
584 netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
586 return netdev_get_dev(netdev)->netdev_class->set_etheraddr(netdev, mac);
589 /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
590 * the MAC address into 'mac'. On failure, returns a positive errno value and
591 * clears 'mac' to all-zeros. */
593 netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
595 return netdev_get_dev(netdev)->netdev_class->get_etheraddr(netdev, mac);
598 /* Returns the name of the network device that 'netdev' represents,
599 * e.g. "eth0". The caller must not modify or free the returned string. */
601 netdev_get_name(const struct netdev *netdev)
603 return netdev_get_dev(netdev)->name;
606 /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
607 * (and received) packets, in bytes, not including the hardware header; thus,
608 * this is typically 1500 bytes for Ethernet devices.
610 * If successful, returns 0 and stores the MTU size in '*mtup'. On failure,
611 * returns a positive errno value and stores ETH_PAYLOAD_MAX (1500) in
614 netdev_get_mtu(const struct netdev *netdev, int *mtup)
616 int error = netdev_get_dev(netdev)->netdev_class->get_mtu(netdev, mtup);
618 VLOG_WARN_RL(&rl, "failed to retrieve MTU for network device %s: %s",
619 netdev_get_name(netdev), strerror(error));
620 *mtup = ETH_PAYLOAD_MAX;
625 /* Returns the ifindex of 'netdev', if successful, as a positive number. On
626 * failure, returns a negative errno value.
628 * The desired semantics of the ifindex value are a combination of those
629 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex
630 * value should be unique within a host and remain stable at least until
631 * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber"
632 * but many systems do not follow this rule anyhow.
634 * Some network devices may not implement support for this function. In such
635 * cases this function will always return -EOPNOTSUPP.
638 netdev_get_ifindex(const struct netdev *netdev)
640 int (*get_ifindex)(const struct netdev *);
642 get_ifindex = netdev_get_dev(netdev)->netdev_class->get_ifindex;
644 return get_ifindex ? get_ifindex(netdev) : -EOPNOTSUPP;
647 /* Stores the features supported by 'netdev' into each of '*current',
648 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
649 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
650 * successful, otherwise a positive errno value. On failure, all of the
651 * passed-in values are set to 0.
653 * Some network devices may not implement support for this function. In such
654 * cases this function will always return EOPNOTSUPP.
657 netdev_get_features(struct netdev *netdev,
658 uint32_t *current, uint32_t *advertised,
659 uint32_t *supported, uint32_t *peer)
661 int (*get_features)(struct netdev *netdev,
662 uint32_t *current, uint32_t *advertised,
663 uint32_t *supported, uint32_t *peer);
671 advertised = &dummy[1];
674 supported = &dummy[2];
680 get_features = netdev_get_dev(netdev)->netdev_class->get_features;
682 ? get_features(netdev, current, advertised, supported, peer)
685 *current = *advertised = *supported = *peer = 0;
690 /* Returns the maximum speed of a network connection that has the "enum
691 * ofp_port_features" bits in 'features', in bits per second. If no bits that
692 * indicate a speed are set in 'features', assumes 100Mbps. */
694 netdev_features_to_bps(uint32_t features)
697 F_10000MB = OFPPF_10GB_FD,
698 F_1000MB = OFPPF_1GB_HD | OFPPF_1GB_FD,
699 F_100MB = OFPPF_100MB_HD | OFPPF_100MB_FD,
700 F_10MB = OFPPF_10MB_HD | OFPPF_10MB_FD
703 return ( features & F_10000MB ? UINT64_C(10000000000)
704 : features & F_1000MB ? UINT64_C(1000000000)
705 : features & F_100MB ? UINT64_C(100000000)
706 : features & F_10MB ? UINT64_C(10000000)
707 : UINT64_C(100000000));
710 /* Returns true if any of the "enum ofp_port_features" bits that indicate a
711 * full-duplex link are set in 'features', otherwise false. */
713 netdev_features_is_full_duplex(uint32_t features)
715 return (features & (OFPPF_10MB_FD | OFPPF_100MB_FD | OFPPF_1GB_FD
716 | OFPPF_10GB_FD)) != 0;
719 /* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if
720 * successful, otherwise a positive errno value. */
722 netdev_set_advertisements(struct netdev *netdev, uint32_t advertise)
724 return (netdev_get_dev(netdev)->netdev_class->set_advertisements
725 ? netdev_get_dev(netdev)->netdev_class->set_advertisements(
730 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
731 * and '*netmask' to its netmask and returns 0. Otherwise, returns a positive
732 * errno value and sets '*address' to 0 (INADDR_ANY).
734 * The following error values have well-defined meanings:
736 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
738 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
740 * 'address' or 'netmask' or both may be null, in which case the address or netmask
741 * is not reported. */
743 netdev_get_in4(const struct netdev *netdev,
744 struct in_addr *address_, struct in_addr *netmask_)
746 struct in_addr address;
747 struct in_addr netmask;
750 error = (netdev_get_dev(netdev)->netdev_class->get_in4
751 ? netdev_get_dev(netdev)->netdev_class->get_in4(netdev,
755 address_->s_addr = error ? 0 : address.s_addr;
758 netmask_->s_addr = error ? 0 : netmask.s_addr;
763 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
764 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a
765 * positive errno value. */
767 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
769 return (netdev_get_dev(netdev)->netdev_class->set_in4
770 ? netdev_get_dev(netdev)->netdev_class->set_in4(netdev, addr, mask)
774 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
777 netdev_add_router(struct netdev *netdev, struct in_addr router)
779 COVERAGE_INC(netdev_add_router);
780 return (netdev_get_dev(netdev)->netdev_class->add_router
781 ? netdev_get_dev(netdev)->netdev_class->add_router(netdev, router)
785 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
786 * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0,
787 * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a
788 * next hop is found, stores the next hop gateway's address (0 if 'host' is on
789 * a directly connected network) in '*next_hop' and a copy of the name of the
790 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
791 * responsible for freeing '*netdev_name' (by calling free()). */
793 netdev_get_next_hop(const struct netdev *netdev,
794 const struct in_addr *host, struct in_addr *next_hop,
797 int error = (netdev_get_dev(netdev)->netdev_class->get_next_hop
798 ? netdev_get_dev(netdev)->netdev_class->get_next_hop(
799 host, next_hop, netdev_name)
802 next_hop->s_addr = 0;
808 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
809 * returns 0. Otherwise, returns a positive errno value and sets '*in6' to
810 * all-zero-bits (in6addr_any).
812 * The following error values have well-defined meanings:
814 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
816 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
818 * 'in6' may be null, in which case the address itself is not reported. */
820 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
822 struct in6_addr dummy;
825 error = (netdev_get_dev(netdev)->netdev_class->get_in6
826 ? netdev_get_dev(netdev)->netdev_class->get_in6(netdev,
830 memset(in6, 0, sizeof *in6);
835 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
836 * 'on'. If 'permanent' is true, the changes will persist; otherwise, they
837 * will be reverted when 'netdev' is closed or the program exits. Returns 0 if
838 * successful, otherwise a positive errno value. */
840 do_update_flags(struct netdev *netdev, enum netdev_flags off,
841 enum netdev_flags on, enum netdev_flags *old_flagsp,
844 enum netdev_flags old_flags;
847 error = netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
848 off & ~on, on, &old_flags);
850 VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
851 off || on ? "set" : "get", netdev_get_name(netdev),
854 } else if ((off || on) && !permanent) {
855 enum netdev_flags new_flags = (old_flags & ~off) | on;
856 enum netdev_flags changed_flags = old_flags ^ new_flags;
858 if (!netdev->changed_flags) {
859 netdev->save_flags = old_flags;
861 netdev->changed_flags |= changed_flags;
865 *old_flagsp = old_flags;
870 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
871 * Returns 0 if successful, otherwise a positive errno value. On failure,
872 * stores 0 into '*flagsp'. */
874 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
876 struct netdev *netdev = (struct netdev *) netdev_;
877 return do_update_flags(netdev, 0, 0, flagsp, false);
880 /* Sets the flags for 'netdev' to 'flags'.
881 * If 'permanent' is true, the changes will persist; otherwise, they
882 * will be reverted when 'netdev' is closed or the program exits.
883 * Returns 0 if successful, otherwise a positive errno value. */
885 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
888 return do_update_flags(netdev, -1, flags, NULL, permanent);
891 /* Turns on the specified 'flags' on 'netdev'.
892 * If 'permanent' is true, the changes will persist; otherwise, they
893 * will be reverted when 'netdev' is closed or the program exits.
894 * Returns 0 if successful, otherwise a positive errno value. */
896 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
899 return do_update_flags(netdev, 0, flags, NULL, permanent);
902 /* Turns off the specified 'flags' on 'netdev'.
903 * If 'permanent' is true, the changes will persist; otherwise, they
904 * will be reverted when 'netdev' is closed or the program exits.
905 * Returns 0 if successful, otherwise a positive errno value. */
907 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
910 return do_update_flags(netdev, flags, 0, NULL, permanent);
913 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
914 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
915 * returns 0. Otherwise, it returns a positive errno value; in particular,
916 * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
918 netdev_arp_lookup(const struct netdev *netdev,
919 uint32_t ip, uint8_t mac[ETH_ADDR_LEN])
921 int error = (netdev_get_dev(netdev)->netdev_class->arp_lookup
922 ? netdev_get_dev(netdev)->netdev_class->arp_lookup(netdev,
926 memset(mac, 0, ETH_ADDR_LEN);
931 /* Sets 'carrier' to true if carrier is active (link light is on) on
934 netdev_get_carrier(const struct netdev *netdev, bool *carrier)
936 int error = (netdev_get_dev(netdev)->netdev_class->get_carrier
937 ? netdev_get_dev(netdev)->netdev_class->get_carrier(netdev,
946 /* Retrieves current device stats for 'netdev'. */
948 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
952 COVERAGE_INC(netdev_get_stats);
953 error = (netdev_get_dev(netdev)->netdev_class->get_stats
954 ? netdev_get_dev(netdev)->netdev_class->get_stats(netdev, stats)
957 memset(stats, 0xff, sizeof *stats);
962 /* Attempts to set input rate limiting (policing) policy, such that up to
963 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
964 * size of 'kbits' kb. */
966 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
967 uint32_t kbits_burst)
969 return (netdev_get_dev(netdev)->netdev_class->set_policing
970 ? netdev_get_dev(netdev)->netdev_class->set_policing(netdev,
971 kbits_rate, kbits_burst)
975 /* If 'netdev' is a VLAN network device (e.g. one created with vconfig(8)),
976 * sets '*vlan_vid' to the VLAN VID associated with that device and returns 0.
977 * Otherwise returns a errno value (specifically ENOENT if 'netdev_name' is the
978 * name of a network device that is not a VLAN device) and sets '*vlan_vid' to
981 netdev_get_vlan_vid(const struct netdev *netdev, int *vlan_vid)
983 int error = (netdev_get_dev(netdev)->netdev_class->get_vlan_vid
984 ? netdev_get_dev(netdev)->netdev_class->get_vlan_vid(netdev,
993 /* Returns a network device that has 'in4' as its IP address, if one exists,
994 * otherwise a null pointer. */
996 netdev_find_dev_by_in4(const struct in_addr *in4)
998 struct netdev *netdev;
999 struct svec dev_list = SVEC_EMPTY_INITIALIZER;
1002 netdev_enumerate(&dev_list);
1003 for (i = 0; i < dev_list.n; i++) {
1004 const char *name = dev_list.names[i];
1005 struct in_addr dev_in4;
1007 if (!netdev_open_default(name, &netdev)
1008 && !netdev_get_in4(netdev, &dev_in4, NULL)
1009 && dev_in4.s_addr == in4->s_addr) {
1012 netdev_close(netdev);
1017 svec_destroy(&dev_list);
1021 /* Initializes 'netdev_dev' as a netdev device named 'name' of the
1022 * specified 'netdev_class'.
1024 * This function adds 'netdev_dev' to a netdev-owned shash, so it is
1025 * very important that 'netdev_dev' only be freed after calling
1026 * the refcount drops to zero. */
1028 netdev_dev_init(struct netdev_dev *netdev_dev, const char *name,
1029 const struct netdev_class *netdev_class)
1031 assert(!shash_find(&netdev_dev_shash, name));
1033 memset(netdev_dev, 0, sizeof *netdev_dev);
1034 netdev_dev->netdev_class = netdev_class;
1035 netdev_dev->name = xstrdup(name);
1036 netdev_dev->node = shash_add(&netdev_dev_shash, name, netdev_dev);
1039 /* Undoes the results of initialization.
1041 * Normally this function does not need to be called as netdev_close has
1042 * the same effect when the refcount drops to zero.
1043 * However, it may be called by providers due to an error on creation
1044 * that occurs after initialization. It this case netdev_close() would
1045 * never be called. */
1047 netdev_dev_uninit(struct netdev_dev *netdev_dev, bool destroy)
1049 char *name = netdev_dev->name;
1051 assert(!netdev_dev->ref_cnt);
1053 shash_delete(&netdev_dev_shash, netdev_dev->node);
1054 update_device_args(netdev_dev, NULL);
1057 netdev_dev->netdev_class->destroy(netdev_dev);
1062 /* Returns the class type of 'netdev_dev'.
1064 * The caller must not free the returned value. */
1066 netdev_dev_get_type(const struct netdev_dev *netdev_dev)
1068 return netdev_dev->netdev_class->type;
1071 /* Returns the class associated with 'netdev_dev'. */
1072 const struct netdev_class *
1073 netdev_dev_get_class(const struct netdev_dev *netdev_dev)
1075 return netdev_dev->netdev_class;
1078 /* Returns the name of 'netdev_dev'.
1080 * The caller must not free the returned value. */
1082 netdev_dev_get_name(const struct netdev_dev *netdev_dev)
1084 return netdev_dev->name;
1087 /* Returns the netdev_dev with 'name' or NULL if there is none.
1089 * The caller must not free the returned value. */
1091 netdev_dev_from_name(const char *name)
1093 return shash_find_data(&netdev_dev_shash, name);
1096 /* Fills 'device_list' with devices that match 'netdev_class'.
1098 * The caller is responsible for initializing and destroying 'device_list'
1099 * but the contained netdev_devs must not be freed. */
1101 netdev_dev_get_devices(const struct netdev_class *netdev_class,
1102 struct shash *device_list)
1104 struct shash_node *node;
1105 SHASH_FOR_EACH (node, &netdev_dev_shash) {
1106 struct netdev_dev *dev = node->data;
1108 if (dev->netdev_class == netdev_class) {
1109 shash_add(device_list, node->name, node->data);
1114 /* Initializes 'netdev' as a instance of the netdev_dev.
1116 * This function adds 'netdev' to a netdev-owned linked list, so it is very
1117 * important that 'netdev' only be freed after calling netdev_close(). */
1119 netdev_init(struct netdev *netdev, struct netdev_dev *netdev_dev)
1121 memset(netdev, 0, sizeof *netdev);
1122 netdev->netdev_dev = netdev_dev;
1123 list_push_back(&netdev_list, &netdev->node);
1126 /* Undoes the results of initialization.
1128 * Normally this function only needs to be called from netdev_close().
1129 * However, it may be called by providers due to an error on opening
1130 * that occurs after initialization. It this case netdev_close() would
1131 * never be called. */
1133 netdev_uninit(struct netdev *netdev, bool close)
1135 /* Restore flags that we changed, if any. */
1136 int error = restore_flags(netdev);
1137 list_remove(&netdev->node);
1139 VLOG_WARN("failed to restore network device flags on %s: %s",
1140 netdev_get_name(netdev), strerror(error));
1144 netdev_get_dev(netdev)->netdev_class->close(netdev);
1149 /* Returns the class type of 'netdev'.
1151 * The caller must not free the returned value. */
1153 netdev_get_type(const struct netdev *netdev)
1155 return netdev_get_dev(netdev)->netdev_class->type;
1159 netdev_get_dev(const struct netdev *netdev)
1161 return netdev->netdev_dev;
1164 /* Initializes 'notifier' as a netdev notifier for 'netdev', for which
1165 * notification will consist of calling 'cb', with auxiliary data 'aux'. */
1167 netdev_notifier_init(struct netdev_notifier *notifier, struct netdev *netdev,
1168 void (*cb)(struct netdev_notifier *), void *aux)
1170 notifier->netdev = netdev;
1172 notifier->aux = aux;
1175 /* Tracks changes in the status of a set of network devices. */
1176 struct netdev_monitor {
1177 struct shash polled_netdevs;
1178 struct shash changed_netdevs;
1181 /* Creates and returns a new structure for monitor changes in the status of
1182 * network devices. */
1183 struct netdev_monitor *
1184 netdev_monitor_create(void)
1186 struct netdev_monitor *monitor = xmalloc(sizeof *monitor);
1187 shash_init(&monitor->polled_netdevs);
1188 shash_init(&monitor->changed_netdevs);
1192 /* Destroys 'monitor'. */
1194 netdev_monitor_destroy(struct netdev_monitor *monitor)
1197 struct shash_node *node;
1199 SHASH_FOR_EACH (node, &monitor->polled_netdevs) {
1200 struct netdev_notifier *notifier = node->data;
1201 netdev_get_dev(notifier->netdev)->netdev_class->poll_remove(
1205 shash_destroy(&monitor->polled_netdevs);
1206 shash_destroy(&monitor->changed_netdevs);
1212 netdev_monitor_cb(struct netdev_notifier *notifier)
1214 struct netdev_monitor *monitor = notifier->aux;
1215 const char *name = netdev_get_name(notifier->netdev);
1216 if (!shash_find(&monitor->changed_netdevs, name)) {
1217 shash_add(&monitor->changed_netdevs, name, NULL);
1221 /* Attempts to add 'netdev' as a netdev monitored by 'monitor'. Returns 0 if
1222 * successful, otherwise a positive errno value.
1224 * Adding a given 'netdev' to a monitor multiple times is equivalent to adding
1227 netdev_monitor_add(struct netdev_monitor *monitor, struct netdev *netdev)
1229 const char *netdev_name = netdev_get_name(netdev);
1231 if (!shash_find(&monitor->polled_netdevs, netdev_name)
1232 && netdev_get_dev(netdev)->netdev_class->poll_add)
1234 struct netdev_notifier *notifier;
1235 error = netdev_get_dev(netdev)->netdev_class->poll_add(netdev,
1236 netdev_monitor_cb, monitor, ¬ifier);
1238 assert(notifier->netdev == netdev);
1239 shash_add(&monitor->polled_netdevs, netdev_name, notifier);
1245 /* Removes 'netdev' from the set of netdevs monitored by 'monitor'. (This has
1246 * no effect if 'netdev' is not in the set of devices monitored by
1249 netdev_monitor_remove(struct netdev_monitor *monitor, struct netdev *netdev)
1251 const char *netdev_name = netdev_get_name(netdev);
1252 struct shash_node *node;
1254 node = shash_find(&monitor->polled_netdevs, netdev_name);
1256 /* Cancel future notifications. */
1257 struct netdev_notifier *notifier = node->data;
1258 netdev_get_dev(netdev)->netdev_class->poll_remove(notifier);
1259 shash_delete(&monitor->polled_netdevs, node);
1261 /* Drop any pending notification. */
1262 node = shash_find(&monitor->changed_netdevs, netdev_name);
1264 shash_delete(&monitor->changed_netdevs, node);
1269 /* Checks for changes to netdevs in the set monitored by 'monitor'. If any of
1270 * the attributes (Ethernet address, carrier status, speed or peer-advertised
1271 * speed, flags, etc.) of a network device monitored by 'monitor' has changed,
1272 * sets '*devnamep' to the name of a device that has changed and returns 0.
1273 * The caller is responsible for freeing '*devnamep' (with free()).
1275 * If no devices have changed, sets '*devnamep' to NULL and returns EAGAIN.
1278 netdev_monitor_poll(struct netdev_monitor *monitor, char **devnamep)
1280 struct shash_node *node = shash_first(&monitor->changed_netdevs);
1285 *devnamep = xstrdup(node->name);
1286 shash_delete(&monitor->changed_netdevs, node);
1291 /* Registers with the poll loop to wake up from the next call to poll_block()
1292 * when netdev_monitor_poll(monitor) would indicate that a device has
1295 netdev_monitor_poll_wait(const struct netdev_monitor *monitor)
1297 if (!shash_is_empty(&monitor->changed_netdevs)) {
1298 poll_immediate_wake();
1300 /* XXX Nothing needed here for netdev_linux, but maybe other netdev
1301 * classes need help. */
1305 /* Restore the network device flags on 'netdev' to those that were active
1306 * before we changed them. Returns 0 if successful, otherwise a positive
1309 * To avoid reentry, the caller must ensure that fatal signals are blocked. */
1311 restore_flags(struct netdev *netdev)
1313 if (netdev->changed_flags) {
1314 enum netdev_flags restore = netdev->save_flags & netdev->changed_flags;
1315 enum netdev_flags old_flags;
1316 return netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
1317 netdev->changed_flags & ~restore,
1318 restore, &old_flags);
1323 /* Close all netdevs on shutdown so they can do any needed cleanup such as
1324 * destroying devices, restoring flags, etc. */
1326 close_all_netdevs(void *aux OVS_UNUSED)
1328 struct netdev *netdev, *next;
1329 LIST_FOR_EACH_SAFE(netdev, next, struct netdev, node, &netdev_list) {
1330 netdev_close(netdev);