/*
- * Copyright (c) 2008, 2009 Nicira Networks.
+ * Copyright (c) 2008, 2009, 2010 Nicira Networks.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include "coverage.h"
#include "dynamic-string.h"
#include "fatal-signal.h"
+#include "hash.h"
#include "list.h"
#include "netdev-provider.h"
#include "ofpbuf.h"
#define THIS_MODULE VLM_netdev
#include "vlog.h"
-static const struct netdev_class *netdev_classes[] = {
+static const struct netdev_class *base_netdev_classes[] = {
&netdev_linux_class,
&netdev_tap_class,
+ &netdev_gre_class,
};
-static int n_netdev_classes = ARRAY_SIZE(netdev_classes);
+
+static struct shash netdev_classes = SHASH_INITIALIZER(&netdev_classes);
+
+/* All created network devices. */
+static struct shash netdev_dev_shash = SHASH_INITIALIZER(&netdev_dev_shash);
/* All open network devices. */
static struct list netdev_list = LIST_INITIALIZER(&netdev_list);
* additional log messages. */
static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
-static void restore_all_flags(void *aux);
+static void close_all_netdevs(void *aux UNUSED);
static int restore_flags(struct netdev *netdev);
+void update_device_args(struct netdev_dev *, const struct shash *args);
-/* Attempts to initialize the netdev module. Returns 0 if successful,
- * otherwise a positive errno value.
- *
- * Calling this function is optional. If not called explicitly, it will
- * automatically be called upon the first attempt to open a network device. */
-int
+static void
netdev_initialize(void)
{
static int status = -1;
+
if (status < 0) {
- int i, j;
+ int i;
- fatal_signal_add_hook(restore_all_flags, NULL, true);
+ fatal_signal_add_hook(close_all_netdevs, NULL, NULL, true);
status = 0;
- for (i = j = 0; i < n_netdev_classes; i++) {
- const struct netdev_class *class = netdev_classes[i];
- if (class->init) {
- int retval = class->init();
- if (!retval) {
- netdev_classes[j++] = class;
- } else {
- VLOG_ERR("failed to initialize %s network device "
- "class: %s", class->name, strerror(retval));
- if (!status) {
- status = retval;
- }
- }
- } else {
- netdev_classes[j++] = class;
- }
+ for (i = 0; i < ARRAY_SIZE(base_netdev_classes); i++) {
+ netdev_register_provider(base_netdev_classes[i]);
}
- n_netdev_classes = j;
}
- return status;
}
/* Performs periodic work needed by all the various kinds of netdevs.
void
netdev_run(void)
{
- int i;
- for (i = 0; i < n_netdev_classes; i++) {
- const struct netdev_class *class = netdev_classes[i];
+ struct shash_node *node;
+ SHASH_FOR_EACH(node, &netdev_classes) {
+ const struct netdev_class *class = node->data;
if (class->run) {
class->run();
}
void
netdev_wait(void)
{
- int i;
- for (i = 0; i < n_netdev_classes; i++) {
- const struct netdev_class *class = netdev_classes[i];
+ struct shash_node *node;
+ SHASH_FOR_EACH(node, &netdev_classes) {
+ const struct netdev_class *class = node->data;
if (class->wait) {
class->wait();
}
}
}
+/* Initializes and registers a new netdev provider. After successful
+ * registration, new netdevs of that type can be opened using netdev_open(). */
+int
+netdev_register_provider(const struct netdev_class *new_class)
+{
+ struct netdev_class *new_provider;
+
+ if (shash_find(&netdev_classes, new_class->type)) {
+ VLOG_WARN("attempted to register duplicate netdev provider: %s",
+ new_class->type);
+ return EEXIST;
+ }
+
+ if (new_class->init) {
+ int error = new_class->init();
+ if (error) {
+ VLOG_ERR("failed to initialize %s network device class: %s",
+ new_class->type, strerror(error));
+ return error;
+ }
+ }
+
+ new_provider = xmalloc(sizeof *new_provider);
+ memcpy(new_provider, new_class, sizeof *new_provider);
+
+ shash_add(&netdev_classes, new_class->type, new_provider);
+
+ return 0;
+}
+
+/* Unregisters a netdev provider. 'type' must have been previously
+ * registered and not currently be in use by any netdevs. After unregistration
+ * new netdevs of that type cannot be opened using netdev_open(). */
+int
+netdev_unregister_provider(const char *type)
+{
+ struct shash_node *del_node, *netdev_dev_node;
+
+ del_node = shash_find(&netdev_classes, type);
+ if (!del_node) {
+ VLOG_WARN("attempted to unregister a netdev provider that is not "
+ "registered: %s", type);
+ return EAFNOSUPPORT;
+ }
+
+ SHASH_FOR_EACH(netdev_dev_node, &netdev_dev_shash) {
+ struct netdev_dev *netdev_dev = netdev_dev_node->data;
+ if (!strcmp(netdev_dev->class->type, type)) {
+ VLOG_WARN("attempted to unregister in use netdev provider: %s",
+ type);
+ return EBUSY;
+ }
+ }
+
+ shash_delete(&netdev_classes, del_node);
+ free(del_node->data);
+
+ return 0;
+}
+
+/* Clears 'types' and enumerates the types of all currently registered netdev
+ * providers into it. The caller must first initialize the svec. */
+void
+netdev_enumerate_types(struct svec *types)
+{
+ struct shash_node *node;
+
+ netdev_initialize();
+ svec_clear(types);
+
+ SHASH_FOR_EACH(node, &netdev_classes) {
+ const struct netdev_class *netdev_class = node->data;
+ svec_add(types, netdev_class->type);
+ }
+}
+
+/* Compares 'args' to those used to those used by 'dev'. Returns true
+ * if the arguments are the same, false otherwise. Does not update the
+ * values stored in 'dev'. */
+static bool
+compare_device_args(const struct netdev_dev *dev, const struct shash *args)
+{
+ const struct shash_node **new_args;
+ bool result = true;
+ int i;
+
+ if (shash_count(args) != dev->n_args) {
+ return false;
+ }
+
+ new_args = shash_sort(args);
+ for (i = 0; i < dev->n_args; i++) {
+ if (strcmp(dev->args[i].key, new_args[i]->name) ||
+ strcmp(dev->args[i].value, new_args[i]->data)) {
+ result = false;
+ goto finish;
+ }
+ }
+
+finish:
+ free(new_args);
+ return result;
+}
+
+static int
+compare_args(const void *a_, const void *b_)
+{
+ const struct arg *a = a_;
+ const struct arg *b = b_;
+ return strcmp(a->key, b->key);
+}
+
+void
+update_device_args(struct netdev_dev *dev, const struct shash *args)
+{
+ struct shash_node *node;
+ int i;
+
+ if (dev->n_args) {
+ for (i = 0; i < dev->n_args; i++) {
+ free(dev->args[i].key);
+ free(dev->args[i].value);
+ }
+
+ free(dev->args);
+ dev->n_args = 0;
+ }
+
+ if (!args || shash_is_empty(args)) {
+ return;
+ }
+
+ dev->n_args = shash_count(args);
+ dev->args = xmalloc(dev->n_args * sizeof *dev->args);
+
+ i = 0;
+ SHASH_FOR_EACH(node, args) {
+ dev->args[i].key = xstrdup(node->name);
+ dev->args[i].value = xstrdup(node->data);
+ i++;
+ }
+
+ qsort(dev->args, dev->n_args, sizeof *dev->args, compare_args);
+}
+
+static int
+create_device(struct netdev_options *options, struct netdev_dev **netdev_devp)
+{
+ struct netdev_class *netdev_class;
+
+ if (!options->may_create) {
+ VLOG_WARN("attempted to create a device that may not be created: %s",
+ options->name);
+ return ENODEV;
+ }
+
+ if (!options->type || strlen(options->type) == 0) {
+ /* Default to system. */
+ options->type = "system";
+ }
+
+ netdev_class = shash_find_data(&netdev_classes, options->type);
+ if (!netdev_class) {
+ VLOG_WARN("could not create netdev %s of unknown type %s",
+ options->name, options->type);
+ return EAFNOSUPPORT;
+ }
+
+ return netdev_class->create(options->name, options->type, options->args,
+ netdev_devp);
+}
+
/* Opens the network device named 'name' (e.g. "eth0") and returns zero if
* successful, otherwise a positive errno value. On success, sets '*netdevp'
* to the new network device, otherwise to null.
*
+ * If this is the first time the device has been opened, then create is called
+ * before opening. The device is created using the given type and arguments.
+ *
* 'ethertype' may be a 16-bit Ethernet protocol value in host byte order to
* capture frames of that type received on the device. It may also be one of
* the 'enum netdev_pseudo_ethertype' values to receive frames in one of those
- * categories. */
+ * categories.
+ *
+ * If the 'may_create' flag is set then this is allowed to be the first time
+ * the device is opened (i.e. the refcount will be 1 after this call). It
+ * may be set to false if the device should have already been created.
+ *
+ * If the 'may_open' flag is set then the call will succeed even if another
+ * caller has already opened it. It may be to false if the device should not
+ * currently be open. */
+
int
-netdev_open(const char *name_, int ethertype, struct netdev **netdevp)
+netdev_open(struct netdev_options *options, struct netdev **netdevp)
{
- char *name = xstrdup(name_);
- char *prefix, *suffix, *colon;
- struct netdev *netdev = NULL;
+ struct shash empty_args = SHASH_INITIALIZER(&empty_args);
+ struct netdev_dev *netdev_dev;
int error;
- int i;
+ *netdevp = NULL;
netdev_initialize();
- colon = strchr(name, ':');
- if (colon) {
- *colon = '\0';
- prefix = name;
- suffix = colon + 1;
+
+ if (!options->args) {
+ options->args = &empty_args;
+ }
+
+ netdev_dev = shash_find_data(&netdev_dev_shash, options->name);
+
+ if (!netdev_dev) {
+ error = create_device(options, &netdev_dev);
+ if (error) {
+ return error;
+ }
+ update_device_args(netdev_dev, options->args);
+
+ } else if (options->may_open) {
+ if (!shash_is_empty(options->args) &&
+ !compare_device_args(netdev_dev, options->args)) {
+
+ VLOG_WARN("%s: attempted to open already created netdev with "
+ "different arguments", options->name);
+ return EINVAL;
+ }
} else {
- prefix = "";
- suffix = name;
+ VLOG_WARN("%s: attempted to create a netdev device with bound name",
+ options->name);
+ return EEXIST;
}
- for (i = 0; i < n_netdev_classes; i++) {
- const struct netdev_class *class = netdev_classes[i];
- if (!strcmp(prefix, class->prefix)) {
- error = class->open(name_, suffix, ethertype, &netdev);
- goto exit;
+ error = netdev_dev->class->open(netdev_dev, options->ethertype, netdevp);
+
+ if (!error) {
+ netdev_dev->ref_cnt++;
+ } else {
+ if (!netdev_dev->ref_cnt) {
+ netdev_dev_uninit(netdev_dev, true);
}
}
- error = EAFNOSUPPORT;
-exit:
- *netdevp = error ? NULL : netdev;
- free(name);
return error;
}
+int
+netdev_open_default(const char *name, struct netdev **netdevp)
+{
+ struct netdev_options options;
+
+ memset(&options, 0, sizeof options);
+
+ options.name = name;
+ options.ethertype = NETDEV_ETH_TYPE_NONE;
+ options.may_create = true;
+ options.may_open = true;
+
+ return netdev_open(&options, netdevp);
+}
+
+/* Reconfigures the device 'netdev' with 'args'. 'args' may be empty
+ * or NULL if none are needed. */
+int
+netdev_reconfigure(struct netdev *netdev, const struct shash *args)
+{
+ struct shash empty_args = SHASH_INITIALIZER(&empty_args);
+ struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
+
+ if (!args) {
+ args = &empty_args;
+ }
+
+ if (netdev_dev->class->reconfigure) {
+ if (!compare_device_args(netdev_dev, args)) {
+ update_device_args(netdev_dev, args);
+ return netdev_dev->class->reconfigure(netdev_dev, args);
+ }
+ } else if (!shash_is_empty(args)) {
+ VLOG_WARN("%s: arguments provided to device that does not have a "
+ "reconfigure function", netdev_get_name(netdev));
+ }
+
+ return 0;
+}
+
/* Closes and destroys 'netdev'. */
void
netdev_close(struct netdev *netdev)
{
if (netdev) {
- char *name;
- int error;
-
- /* Restore flags that we changed, if any. */
- fatal_signal_block();
- error = restore_flags(netdev);
- list_remove(&netdev->node);
- fatal_signal_unblock();
- if (error) {
- VLOG_WARN("failed to restore network device flags on %s: %s",
- netdev->name, strerror(error));
- }
+ struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
- /* Free. */
- name = netdev->name;
- netdev->class->close(netdev);
- free(name);
+ assert(netdev_dev->ref_cnt);
+ netdev_dev->ref_cnt--;
+ netdev_uninit(netdev, true);
+
+ /* If the reference count for the netdev device is zero, destroy it. */
+ if (!netdev_dev->ref_cnt) {
+ netdev_dev_uninit(netdev_dev, true);
+ }
}
}
struct netdev *netdev;
int error;
- error = netdev_open(name, NETDEV_ETH_TYPE_NONE, &netdev);
+ error = netdev_open_default(name, &netdev);
if (!error) {
netdev_close(netdev);
return true;
}
}
-/* Initializes 'svec' with a list of the names of all known network devices. */
+/* Clears 'svec' and enumerates the names of all known network devices. */
int
netdev_enumerate(struct svec *svec)
{
- int error;
- int i;
-
- svec_init(svec);
+ struct shash_node *node;
+ int error = 0;
netdev_initialize();
+ svec_clear(svec);
- error = 0;
- for (i = 0; i < n_netdev_classes; i++) {
- const struct netdev_class *class = netdev_classes[i];
- if (class->enumerate) {
- int retval = class->enumerate(svec);
+ SHASH_FOR_EACH(node, &netdev_classes) {
+ const struct netdev_class *netdev_class = node->data;
+ if (netdev_class->enumerate) {
+ int retval = netdev_class->enumerate(svec);
if (retval) {
VLOG_WARN("failed to enumerate %s network devices: %s",
- class->name, strerror(retval));
+ netdev_class->type, strerror(retval));
if (!error) {
error = retval;
}
}
}
}
+
return error;
}
assert(buffer->size == 0);
assert(ofpbuf_tailroom(buffer) >= ETH_TOTAL_MIN);
- retval = netdev->class->recv(netdev,
- buffer->data, ofpbuf_tailroom(buffer));
+ retval = netdev_get_dev(netdev)->class->recv(netdev, buffer->data,
+ ofpbuf_tailroom(buffer));
if (retval >= 0) {
COVERAGE_INC(netdev_received);
buffer->size += retval;
void
netdev_recv_wait(struct netdev *netdev)
{
- netdev->class->recv_wait(netdev);
+ netdev_get_dev(netdev)->class->recv_wait(netdev);
}
/* Discards all packets waiting to be received from 'netdev'. */
int
netdev_drain(struct netdev *netdev)
{
- return netdev->class->drain(netdev);
+ return netdev_get_dev(netdev)->class->drain(netdev);
}
/* Sends 'buffer' on 'netdev'. Returns 0 if successful, otherwise a positive
int
netdev_send(struct netdev *netdev, const struct ofpbuf *buffer)
{
- int error = netdev->class->send(netdev, buffer->data, buffer->size);
+ int error = netdev_get_dev(netdev)->class->send(netdev, buffer->data,
+ buffer->size);
if (!error) {
COVERAGE_INC(netdev_sent);
}
void
netdev_send_wait(struct netdev *netdev)
{
- return netdev->class->send_wait(netdev);
+ return netdev_get_dev(netdev)->class->send_wait(netdev);
}
/* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
int
netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
{
- return netdev->class->set_etheraddr(netdev, mac);
+ return netdev_get_dev(netdev)->class->set_etheraddr(netdev, mac);
}
/* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
int
netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
{
- return netdev->class->get_etheraddr(netdev, mac);
+ return netdev_get_dev(netdev)->class->get_etheraddr(netdev, mac);
}
/* Returns the name of the network device that 'netdev' represents,
const char *
netdev_get_name(const struct netdev *netdev)
{
- return netdev->name;
+ return netdev_get_dev(netdev)->name;
}
/* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
int
netdev_get_mtu(const struct netdev *netdev, int *mtup)
{
- int error = netdev->class->get_mtu(netdev, mtup);
+ int error = netdev_get_dev(netdev)->class->get_mtu(netdev, mtup);
if (error) {
VLOG_WARN_RL(&rl, "failed to retrieve MTU for network device %s: %s",
netdev_get_name(netdev), strerror(error));
return error;
}
+/* Returns the ifindex of 'netdev', if successful, as a positive number. On
+ * failure, returns a negative errno value.
+ *
+ * The desired semantics of the ifindex value are a combination of those
+ * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex
+ * value should be unique within a host and remain stable at least until
+ * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber"
+ * but many systems do not follow this rule anyhow.
+ */
+int
+netdev_get_ifindex(const struct netdev *netdev)
+{
+ return netdev_get_dev(netdev)->class->get_ifindex(netdev);
+}
+
/* Stores the features supported by 'netdev' into each of '*current',
* '*advertised', '*supported', and '*peer' that are non-null. Each value is a
* bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
peer = &dummy[3];
}
- error = netdev->class->get_features(netdev, current, advertised, supported,
- peer);
+ error = netdev_get_dev(netdev)->class->get_features(netdev, current,
+ advertised, supported,
+ peer);
if (error) {
*current = *advertised = *supported = *peer = 0;
}
int
netdev_set_advertisements(struct netdev *netdev, uint32_t advertise)
{
- return (netdev->class->set_advertisements
- ? netdev->class->set_advertisements(netdev, advertise)
+ return (netdev_get_dev(netdev)->class->set_advertisements
+ ? netdev_get_dev(netdev)->class->set_advertisements(netdev,
+ advertise)
: EOPNOTSUPP);
}
struct in_addr netmask;
int error;
- error = (netdev->class->get_in4
- ? netdev->class->get_in4(netdev, &address, &netmask)
+ error = (netdev_get_dev(netdev)->class->get_in4
+ ? netdev_get_dev(netdev)->class->get_in4(netdev, &address,
+ &netmask)
: EOPNOTSUPP);
if (address_) {
address_->s_addr = error ? 0 : address.s_addr;
int
netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
{
- return (netdev->class->set_in4
- ? netdev->class->set_in4(netdev, addr, mask)
+ return (netdev_get_dev(netdev)->class->set_in4
+ ? netdev_get_dev(netdev)->class->set_in4(netdev, addr, mask)
: EOPNOTSUPP);
}
netdev_add_router(struct netdev *netdev, struct in_addr router)
{
COVERAGE_INC(netdev_add_router);
- return (netdev->class->add_router
- ? netdev->class->add_router(netdev, router)
+ return (netdev_get_dev(netdev)->class->add_router
+ ? netdev_get_dev(netdev)->class->add_router(netdev, router)
: EOPNOTSUPP);
}
const struct in_addr *host, struct in_addr *next_hop,
char **netdev_name)
{
- int error = (netdev->class->get_next_hop
- ? netdev->class->get_next_hop(host, next_hop, netdev_name)
+ int error = (netdev_get_dev(netdev)->class->get_next_hop
+ ? netdev_get_dev(netdev)->class->get_next_hop(host, next_hop,
+ netdev_name)
: EOPNOTSUPP);
if (error) {
next_hop->s_addr = 0;
struct in6_addr dummy;
int error;
- error = (netdev->class->get_in6
- ? netdev->class->get_in6(netdev, in6 ? in6 : &dummy)
+ error = (netdev_get_dev(netdev)->class->get_in6
+ ? netdev_get_dev(netdev)->class->get_in6(netdev, in6 ? in6
+ : &dummy)
: EOPNOTSUPP);
if (error && in6) {
memset(in6, 0, sizeof *in6);
enum netdev_flags old_flags;
int error;
- error = netdev->class->update_flags(netdev, off & ~on, on, &old_flags);
+ error = netdev_get_dev(netdev)->class->update_flags(netdev, off & ~on, on,
+ &old_flags);
if (error) {
VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
off || on ? "set" : "get", netdev_get_name(netdev),
netdev_arp_lookup(const struct netdev *netdev,
uint32_t ip, uint8_t mac[ETH_ADDR_LEN])
{
- int error = (netdev->class->arp_lookup
- ? netdev->class->arp_lookup(netdev, ip, mac)
+ int error = (netdev_get_dev(netdev)->class->arp_lookup
+ ? netdev_get_dev(netdev)->class->arp_lookup(netdev, ip, mac)
: EOPNOTSUPP);
if (error) {
memset(mac, 0, ETH_ADDR_LEN);
int
netdev_get_carrier(const struct netdev *netdev, bool *carrier)
{
- int error = (netdev->class->get_carrier
- ? netdev->class->get_carrier(netdev, carrier)
+ int error = (netdev_get_dev(netdev)->class->get_carrier
+ ? netdev_get_dev(netdev)->class->get_carrier(netdev, carrier)
: EOPNOTSUPP);
if (error) {
*carrier = false;
int error;
COVERAGE_INC(netdev_get_stats);
- error = (netdev->class->get_stats
- ? netdev->class->get_stats(netdev, stats)
+ error = (netdev_get_dev(netdev)->class->get_stats
+ ? netdev_get_dev(netdev)->class->get_stats(netdev, stats)
: EOPNOTSUPP);
if (error) {
memset(stats, 0xff, sizeof *stats);
netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
uint32_t kbits_burst)
{
- return (netdev->class->set_policing
- ? netdev->class->set_policing(netdev, kbits_rate, kbits_burst)
+ return (netdev_get_dev(netdev)->class->set_policing
+ ? netdev_get_dev(netdev)->class->set_policing(netdev, kbits_rate,
+ kbits_burst)
: EOPNOTSUPP);
}
int
netdev_get_vlan_vid(const struct netdev *netdev, int *vlan_vid)
{
- int error = (netdev->class->get_vlan_vid
- ? netdev->class->get_vlan_vid(netdev, vlan_vid)
+ int error = (netdev_get_dev(netdev)->class->get_vlan_vid
+ ? netdev_get_dev(netdev)->class->get_vlan_vid(netdev, vlan_vid)
: ENOENT);
if (error) {
*vlan_vid = 0;
netdev_find_dev_by_in4(const struct in_addr *in4)
{
struct netdev *netdev;
- struct svec dev_list;
+ struct svec dev_list = SVEC_EMPTY_INITIALIZER;
size_t i;
netdev_enumerate(&dev_list);
const char *name = dev_list.names[i];
struct in_addr dev_in4;
- if (!netdev_open(name, NETDEV_ETH_TYPE_NONE, &netdev)
+ if (!netdev_open_default(name, &netdev)
&& !netdev_get_in4(netdev, &dev_in4, NULL)
&& dev_in4.s_addr == in4->s_addr) {
goto exit;
return netdev;
}
\f
-/* Initializes 'netdev' as a netdev named 'name' of the specified 'class'.
+/* Initializes 'netdev_dev' as a netdev device named 'name' of the
+ * specified 'class'.
+ *
+ * This function adds 'netdev_dev' to a netdev-owned shash, so it is
+ * very important that 'netdev_dev' only be freed after calling
+ * the refcount drops to zero. */
+void
+netdev_dev_init(struct netdev_dev *netdev_dev, const char *name,
+ const struct netdev_class *class)
+{
+ assert(!shash_find(&netdev_dev_shash, name));
+
+ memset(netdev_dev, 0, sizeof *netdev_dev);
+ netdev_dev->class = class;
+ netdev_dev->name = xstrdup(name);
+ netdev_dev->node = shash_add(&netdev_dev_shash, name, netdev_dev);
+}
+
+/* Undoes the results of initialization.
+ *
+ * Normally this function does not need to be called as netdev_close has
+ * the same effect when the refcount drops to zero.
+ * However, it may be called by providers due to an error on creation
+ * that occurs after initialization. It this case netdev_close() would
+ * never be called. */
+void
+netdev_dev_uninit(struct netdev_dev *netdev_dev, bool destroy)
+{
+ char *name = netdev_dev->name;
+
+ assert(!netdev_dev->ref_cnt);
+
+ shash_delete(&netdev_dev_shash, netdev_dev->node);
+ update_device_args(netdev_dev, NULL);
+
+ if (destroy) {
+ netdev_dev->class->destroy(netdev_dev);
+ }
+ free(name);
+}
+
+/* Returns the class type of 'netdev_dev'.
+ *
+ * The caller must not free the returned value. */
+const char *
+netdev_dev_get_type(const struct netdev_dev *netdev_dev)
+{
+ return netdev_dev->class->type;
+}
+
+/* Returns the name of 'netdev_dev'.
+ *
+ * The caller must not free the returned value. */
+const char *
+netdev_dev_get_name(const struct netdev_dev *netdev_dev)
+{
+ return netdev_dev->name;
+}
+
+/* Returns the netdev_dev with 'name' or NULL if there is none.
+ *
+ * The caller must not free the returned value. */
+struct netdev_dev *
+netdev_dev_from_name(const char *name)
+{
+ return shash_find_data(&netdev_dev_shash, name);
+}
+
+/* Fills 'device_list' with devices that match 'class'.
+ *
+ * The caller is responsible for initializing and destroying 'device_list'
+ * but the contained netdev_devs must not be freed. */
+void
+netdev_dev_get_devices(const struct netdev_class *class,
+ struct shash *device_list)
+{
+ struct shash_node *node;
+ SHASH_FOR_EACH (node, &netdev_dev_shash) {
+ struct netdev_dev *dev = node->data;
+
+ if (dev->class == class) {
+ shash_add(device_list, node->name, node->data);
+ }
+ }
+}
+
+/* Initializes 'netdev' as a instance of the netdev_dev.
*
* This function adds 'netdev' to a netdev-owned linked list, so it is very
* important that 'netdev' only be freed after calling netdev_close(). */
void
-netdev_init(struct netdev *netdev, const char *name,
- const struct netdev_class *class)
+netdev_init(struct netdev *netdev, struct netdev_dev *netdev_dev)
{
- netdev->class = class;
- netdev->name = xstrdup(name);
- netdev->save_flags = 0;
- netdev->changed_flags = 0;
+ memset(netdev, 0, sizeof *netdev);
+ netdev->netdev_dev = netdev_dev;
list_push_back(&netdev_list, &netdev->node);
}
+/* Undoes the results of initialization.
+ *
+ * Normally this function only needs to be called from netdev_close().
+ * However, it may be called by providers due to an error on opening
+ * that occurs after initialization. It this case netdev_close() would
+ * never be called. */
+void
+netdev_uninit(struct netdev *netdev, bool close)
+{
+ /* Restore flags that we changed, if any. */
+ int error = restore_flags(netdev);
+ list_remove(&netdev->node);
+ if (error) {
+ VLOG_WARN("failed to restore network device flags on %s: %s",
+ netdev_get_name(netdev), strerror(error));
+ }
+
+ if (close) {
+ netdev_get_dev(netdev)->class->close(netdev);
+ }
+}
+
+
+/* Returns the class type of 'netdev'.
+ *
+ * The caller must not free the returned value. */
+const char *
+netdev_get_type(const struct netdev *netdev)
+{
+ return netdev_get_dev(netdev)->class->type;
+}
+
+struct netdev_dev *
+netdev_get_dev(const struct netdev *netdev)
+{
+ return netdev->netdev_dev;
+}
+
/* Initializes 'notifier' as a netdev notifier for 'netdev', for which
* notification will consist of calling 'cb', with auxiliary data 'aux'. */
void
SHASH_FOR_EACH (node, &monitor->polled_netdevs) {
struct netdev_notifier *notifier = node->data;
- notifier->netdev->class->poll_remove(notifier);
+ netdev_get_dev(notifier->netdev)->class->poll_remove(notifier);
}
shash_destroy(&monitor->polled_netdevs);
const char *netdev_name = netdev_get_name(netdev);
int error = 0;
if (!shash_find(&monitor->polled_netdevs, netdev_name)
- && netdev->class->poll_add)
+ && netdev_get_dev(netdev)->class->poll_add)
{
struct netdev_notifier *notifier;
- error = netdev->class->poll_add(netdev, netdev_monitor_cb, monitor,
- ¬ifier);
+ error = netdev_get_dev(netdev)->class->poll_add(netdev,
+ netdev_monitor_cb,
+ monitor, ¬ifier);
if (!error) {
assert(notifier->netdev == netdev);
shash_add(&monitor->polled_netdevs, netdev_name, notifier);
if (node) {
/* Cancel future notifications. */
struct netdev_notifier *notifier = node->data;
- netdev->class->poll_remove(notifier);
+ netdev_get_dev(netdev)->class->poll_remove(notifier);
shash_delete(&monitor->polled_netdevs, node);
/* Drop any pending notification. */
if (netdev->changed_flags) {
enum netdev_flags restore = netdev->save_flags & netdev->changed_flags;
enum netdev_flags old_flags;
- return netdev->class->update_flags(netdev,
+ return netdev_get_dev(netdev)->class->update_flags(netdev,
netdev->changed_flags & ~restore,
restore, &old_flags);
}
return 0;
}
-/* Retores all the flags on all network devices that we modified. Called from
- * a signal handler, so it does not attempt to report error conditions. */
+/* Close all netdevs on shutdown so they can do any needed cleanup such as
+ * destroying devices, restoring flags, etc. */
static void
-restore_all_flags(void *aux UNUSED)
+close_all_netdevs(void *aux UNUSED)
{
- struct netdev *netdev;
- LIST_FOR_EACH (netdev, struct netdev, node, &netdev_list) {
- restore_flags(netdev);
+ struct netdev *netdev, *next;
+ LIST_FOR_EACH_SAFE(netdev, next, struct netdev, node, &netdev_list) {
+ netdev_close(netdev);
}
}