/*
- * Copyright (c) 2008, 2009, 2010 Nicira Networks.
+ * Copyright (c) 2008, 2009, 2010, 2011 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 "hash.h"
#include "list.h"
#include "netdev-provider.h"
+#include "netdev-vport.h"
#include "ofpbuf.h"
#include "openflow/openflow.h"
#include "packets.h"
#include "poll-loop.h"
#include "shash.h"
+#include "sset.h"
#include "svec.h"
-
-#define THIS_MODULE VLM_netdev
#include "vlog.h"
-static const struct netdev_class *base_netdev_classes[] = {
-#ifdef HAVE_NETLINK
- &netdev_linux_class,
- &netdev_tap_class,
- &netdev_patch_class,
- &netdev_gre_class,
-#endif
-};
+VLOG_DEFINE_THIS_MODULE(netdev);
+
+COVERAGE_DEFINE(netdev_received);
+COVERAGE_DEFINE(netdev_sent);
+COVERAGE_DEFINE(netdev_add_router);
+COVERAGE_DEFINE(netdev_get_stats);
static struct shash netdev_classes = SHASH_INITIALIZER(&netdev_classes);
static void
netdev_initialize(void)
{
- static int status = -1;
+ static bool inited;
- if (status < 0) {
- int i;
+ if (!inited) {
+ inited = true;
fatal_signal_add_hook(close_all_netdevs, NULL, NULL, true);
- status = 0;
- for (i = 0; i < ARRAY_SIZE(base_netdev_classes); i++) {
- netdev_register_provider(base_netdev_classes[i]);
- }
+#ifdef HAVE_NETLINK
+ netdev_register_provider(&netdev_linux_class);
+ netdev_register_provider(&netdev_internal_class);
+ netdev_register_provider(&netdev_tap_class);
+ netdev_vport_register();
+#endif
}
}
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);
}
}
- new_provider = xmalloc(sizeof *new_provider);
- memcpy(new_provider, new_class, sizeof *new_provider);
-
- shash_add(&netdev_classes, new_class->type, new_provider);
+ shash_add(&netdev_classes, new_class->type, new_class);
return 0;
}
}
shash_delete(&netdev_classes, del_node);
- free(del_node->data);
return 0;
}
+const struct netdev_class *
+netdev_lookup_provider(const char *type)
+{
+ netdev_initialize();
+ return shash_find_data(&netdev_classes, type && type[0] ? type : "system");
+}
+
/* Clears 'types' and enumerates the types of all currently registered netdev
- * providers into it. The caller must first initialize the svec. */
+ * providers into it. The caller must first initialize the sset. */
void
-netdev_enumerate_types(struct svec *types)
+netdev_enumerate_types(struct sset *types)
{
struct shash_node *node;
netdev_initialize();
- svec_clear(types);
+ sset_clear(types);
SHASH_FOR_EACH(node, &netdev_classes) {
const struct netdev_class *netdev_class = node->data;
- svec_add(types, netdev_class->type);
+ sset_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->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);
+ smap_destroy(&dev->args);
+ smap_clone(&dev->args, args);
}
/* Opens the network device named 'name' (e.g. "eth0") and returns zero if
* 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.
+ * 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. */
-
int
netdev_open(struct netdev_options *options, struct netdev **netdevp)
{
netdev_dev = shash_find_data(&netdev_dev_shash, options->name);
if (!netdev_dev) {
- error = create_device(options, &netdev_dev);
+ const struct netdev_class *class;
+
+ class = netdev_lookup_provider(options->type);
+ if (!class) {
+ VLOG_WARN("could not create netdev %s of unknown type %s",
+ options->name, options->type);
+ return EAFNOSUPPORT;
+ }
+ error = class->create(class, options->name, options->args,
+ &netdev_dev);
if (error) {
return error;
}
- update_device_args(netdev_dev, options->args);
+ assert(netdev_dev->netdev_class == class);
} else if (!shash_is_empty(options->args) &&
- !compare_device_args(netdev_dev, options->args)) {
+ !smap_equal(&netdev_dev->args, options->args)) {
VLOG_WARN("%s: attempted to open already open netdev with "
"different arguments", options->name);
return EINVAL;
}
- error = netdev_dev->netdev_class->open(netdev_dev, options->ethertype,
+ error = netdev_dev->netdev_class->open(netdev_dev, options->ethertype,
netdevp);
if (!error) {
/* 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)
+netdev_set_config(struct netdev *netdev, const struct shash *args)
{
struct shash empty_args = SHASH_INITIALIZER(&empty_args);
struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
args = &empty_args;
}
- if (netdev_dev->netdev_class->reconfigure) {
- if (!compare_device_args(netdev_dev, args)) {
+ if (netdev_dev->netdev_class->set_config) {
+ if (!smap_equal(&netdev_dev->args, args)) {
update_device_args(netdev_dev, args);
- return netdev_dev->netdev_class->reconfigure(netdev_dev, args);
+ return netdev_dev->netdev_class->set_config(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));
+ VLOG_WARN("%s: arguments provided to device whose configuration "
+ "cannot be changed", netdev_get_name(netdev));
}
return 0;
}
+/* Returns the current configuration for 'netdev'. This is either the
+ * configuration passed to netdev_open() or netdev_set_config(), or it is a
+ * configuration retrieved from the device itself if no configuration was
+ * passed to those functions.
+ *
+ * 'netdev' retains ownership of the returned configuration. */
+const struct shash *
+netdev_get_config(const struct netdev *netdev)
+{
+ return &netdev_get_dev(netdev)->args;
+}
+
/* Closes and destroys 'netdev'. */
void
netdev_close(struct netdev *netdev)
return !!shash_find_data(&netdev_dev_shash, name);
}
-/* Clears 'svec' and enumerates the names of all known network devices. */
+/* Clears 'sset' and enumerates the names of all known network devices. */
int
-netdev_enumerate(struct svec *svec)
+netdev_enumerate(struct sset *sset)
{
struct shash_node *node;
int error = 0;
netdev_initialize();
- svec_clear(svec);
+ sset_clear(sset);
SHASH_FOR_EACH(node, &netdev_classes) {
const struct netdev_class *netdev_class = node->data;
if (netdev_class->enumerate) {
- int retval = netdev_class->enumerate(svec);
+ int retval = netdev_class->enumerate(sset);
if (retval) {
VLOG_WARN("failed to enumerate %s network devices: %s",
netdev_class->type, strerror(retval));
* be returned.
*
* Some network devices may not implement support for this function. In such
- * cases this function will always return EOPNOTSUPP.
- */
+ * cases this function will always return EOPNOTSUPP. */
int
netdev_recv(struct netdev *netdev, struct ofpbuf *buffer)
{
* (and received) packets, in bytes, not including the hardware header; thus,
* this is typically 1500 bytes for Ethernet devices.
*
- * If successful, returns 0 and stores the MTU size in '*mtup'. On failure,
- * returns a positive errno value and stores ETH_PAYLOAD_MAX (1500) in
+ * If successful, returns 0 and stores the MTU size in '*mtup'. Stores INT_MAX
+ * in '*mtup' if 'netdev' does not have an MTU (as e.g. some tunnels do not).On
+ * failure, returns a positive errno value and stores ETH_PAYLOAD_MAX (1500) in
* '*mtup'. */
int
netdev_get_mtu(const struct netdev *netdev, int *mtup)
* passed-in values are set to 0.
*
* Some network devices may not implement support for this function. In such
- * cases this function will always return EOPNOTSUPP.
- */
+ * cases this function will always return EOPNOTSUPP. */
int
-netdev_get_features(struct netdev *netdev,
+netdev_get_features(const struct netdev *netdev,
uint32_t *current, uint32_t *advertised,
uint32_t *supported, uint32_t *peer)
{
- int (*get_features)(struct netdev *netdev,
+ int (*get_features)(const struct netdev *netdev,
uint32_t *current, uint32_t *advertised,
uint32_t *supported, uint32_t *peer);
uint32_t dummy[4];
*
* - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
*
- * 'address' or 'netmask' or both may be null, in which case the address or netmask
- * is not reported. */
+ * 'address' or 'netmask' or both may be null, in which case the address or
+ * netmask is not reported. */
int
netdev_get_in4(const struct netdev *netdev,
struct in_addr *address_, struct in_addr *netmask_)
int error;
error = (netdev_get_dev(netdev)->netdev_class->get_in4
- ? netdev_get_dev(netdev)->netdev_class->get_in4(netdev,
+ ? netdev_get_dev(netdev)->netdev_class->get_in4(netdev,
&address, &netmask)
: EOPNOTSUPP);
if (address_) {
return error;
}
+/* Populates 'sh' with status information.
+ *
+ * Populates 'sh' with 'netdev' specific status information. This information
+ * may be used to populate the status column of the Interface table as defined
+ * in ovs-vswitchd.conf.db(5). */
+int
+netdev_get_status(const struct netdev *netdev, struct shash *sh)
+{
+ struct netdev_dev *dev = netdev_get_dev(netdev);
+
+ return (dev->netdev_class->get_status
+ ? dev->netdev_class->get_status(netdev, sh)
+ : EOPNOTSUPP);
+}
+
/* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
* returns 0. Otherwise, returns a positive errno value and sets '*in6' to
* all-zero-bits (in6addr_any).
int error;
error = (netdev_get_dev(netdev)->netdev_class->get_in6
- ? netdev_get_dev(netdev)->netdev_class->get_in6(netdev,
+ ? netdev_get_dev(netdev)->netdev_class->get_in6(netdev,
in6 ? in6 : &dummy)
: EOPNOTSUPP);
if (error && in6) {
enum netdev_flags old_flags;
int error;
- error = netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
+ error = netdev_get_dev(netdev)->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",
* ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
int
netdev_arp_lookup(const struct netdev *netdev,
- uint32_t ip, uint8_t mac[ETH_ADDR_LEN])
+ ovs_be32 ip, uint8_t mac[ETH_ADDR_LEN])
{
int error = (netdev_get_dev(netdev)->netdev_class->arp_lookup
- ? netdev_get_dev(netdev)->netdev_class->arp_lookup(netdev,
+ ? netdev_get_dev(netdev)->netdev_class->arp_lookup(netdev,
ip, mac)
: EOPNOTSUPP);
if (error) {
return error;
}
-/* Sets 'carrier' to true if carrier is active (link light is on) on
- * 'netdev'. */
-int
-netdev_get_carrier(const struct netdev *netdev, bool *carrier)
+/* Returns true if carrier is active (link light is on) on 'netdev'. */
+bool
+netdev_get_carrier(const struct netdev *netdev)
{
- int error = (netdev_get_dev(netdev)->netdev_class->get_carrier
- ? netdev_get_dev(netdev)->netdev_class->get_carrier(netdev,
- carrier)
- : EOPNOTSUPP);
+ int error;
+ enum netdev_flags flags;
+ bool carrier;
+
+ netdev_get_flags(netdev, &flags);
+ if (!(flags & NETDEV_UP)) {
+ return false;
+ }
+
+ if (!netdev_get_dev(netdev)->netdev_class->get_carrier) {
+ return true;
+ }
+
+ error = netdev_get_dev(netdev)->netdev_class->get_carrier(netdev,
+ &carrier);
if (error) {
- *carrier = false;
+ VLOG_DBG("%s: failed to get network device carrier status, assuming "
+ "down: %s", netdev_get_name(netdev), strerror(error));
+ carrier = false;
}
- return error;
+
+ return carrier;
+}
+
+/* Attempts to force netdev_get_carrier() to poll 'netdev''s MII registers for
+ * link status instead of checking 'netdev''s carrier. 'netdev''s MII
+ * registers will be polled once ever 'interval' milliseconds. If 'netdev'
+ * does not support MII, another method may be used as a fallback. If
+ * 'interval' is less than or equal to zero, reverts netdev_get_carrier() to
+ * its normal behavior.
+ *
+ * Returns 0 if successful, otherwise a positive errno value. */
+int
+netdev_set_miimon_interval(struct netdev *netdev, long long int interval)
+{
+ struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
+ return (netdev_dev->netdev_class->set_miimon_interval
+ ? netdev_dev->netdev_class->set_miimon_interval(netdev, interval)
+ : EOPNOTSUPP);
}
/* Retrieves current device stats for 'netdev'. */
uint32_t kbits_burst)
{
return (netdev_get_dev(netdev)->netdev_class->set_policing
- ? netdev_get_dev(netdev)->netdev_class->set_policing(netdev,
+ ? netdev_get_dev(netdev)->netdev_class->set_policing(netdev,
kbits_rate, kbits_burst)
: EOPNOTSUPP);
}
* Every network device supports disabling QoS with a type of "", but this type
* will not be added to 'types'.
*
- * The caller must initialize 'types' (e.g. with svec_init()) before calling
+ * The caller must initialize 'types' (e.g. with sset_init()) before calling
* this function. The caller is responsible for destroying 'types' (e.g. with
- * svec_destroy()) when it is no longer needed.
+ * sset_destroy()) when it is no longer needed.
*
* Returns 0 if successful, otherwise a positive errno value. */
int
-netdev_get_qos_types(const struct netdev *netdev, struct svec *types)
+netdev_get_qos_types(const struct netdev *netdev, struct sset *types)
{
const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
return (class->get_qos_types
* the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
*
* This function does not modify 'details', and the caller retains ownership of
- * it.
- */
+ * it. */
int
netdev_set_queue(struct netdev *netdev,
unsigned int queue_id, const struct shash *details)
: EOPNOTSUPP);
}
+/* Returns a sequence number which indicates changes in one of 'netdev''s
+ * properties. The returned sequence will be nonzero so that callers have a
+ * value which they may use as a reset when tracking 'netdev'.
+ *
+ * The returned sequence number will change whenever 'netdev''s flags,
+ * features, ethernet address, or carrier changes. It may change for other
+ * reasons as well, or no reason at all. */
+unsigned int
+netdev_change_seq(const struct netdev *netdev)
+{
+ return netdev_get_dev(netdev)->netdev_class->change_seq(netdev);
+}
+
/* If 'netdev' is a VLAN network device (e.g. one created with vconfig(8)),
* sets '*vlan_vid' to the VLAN VID associated with that device and returns 0.
* Otherwise returns a errno value (specifically ENOENT if 'netdev_name' is the
netdev_get_vlan_vid(const struct netdev *netdev, int *vlan_vid)
{
int error = (netdev_get_dev(netdev)->netdev_class->get_vlan_vid
- ? netdev_get_dev(netdev)->netdev_class->get_vlan_vid(netdev,
+ ? netdev_get_dev(netdev)->netdev_class->get_vlan_vid(netdev,
vlan_vid)
: ENOENT);
if (error) {
netdev_find_dev_by_in4(const struct in_addr *in4)
{
struct netdev *netdev;
- struct svec dev_list = SVEC_EMPTY_INITIALIZER;
- size_t i;
+ struct sset dev_list = SSET_INITIALIZER(&dev_list);
+ const char *name;
netdev_enumerate(&dev_list);
- for (i = 0; i < dev_list.n; i++) {
- const char *name = dev_list.names[i];
+ SSET_FOR_EACH (name, &dev_list) {
struct in_addr dev_in4;
if (!netdev_open_default(name, &netdev)
netdev = NULL;
exit:
- svec_destroy(&dev_list);
+ sset_destroy(&dev_list);
return netdev;
}
\f
-/* Initializes 'netdev_dev' as a netdev device named 'name' of the
- * specified 'netdev_class'.
+/* Initializes 'netdev_dev' as a netdev device named 'name' of the specified
+ * 'netdev_class'. This function is ordinarily called from a netdev provider's
+ * 'create' function.
+ *
+ * 'args' should be the arguments that were passed to the netdev provider's
+ * 'create'. If an empty set of arguments was passed, and 'name' is the name
+ * of a network device that existed before the 'create' call, then 'args' may
+ * instead be the configuration for that existing device.
*
* 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 shash *args,
const struct netdev_class *netdev_class)
{
assert(!shash_find(&netdev_dev_shash, name));
netdev_dev->netdev_class = netdev_class;
netdev_dev->name = xstrdup(name);
netdev_dev->node = shash_add(&netdev_dev_shash, name, netdev_dev);
+ smap_clone(&netdev_dev->args, args);
}
/* Undoes the results of initialization.
assert(!netdev_dev->ref_cnt);
shash_delete(&netdev_dev_shash, netdev_dev->node);
- update_device_args(netdev_dev, NULL);
+ smap_destroy(&netdev_dev->args);
if (destroy) {
netdev_dev->netdev_class->destroy(netdev_dev);
}
-/* Returns the class type of 'netdev'.
+/* Returns the class type of 'netdev'.
*
* The caller must not free the returned value. */
const char *
/* Tracks changes in the status of a set of network devices. */
struct netdev_monitor {
struct shash polled_netdevs;
- struct shash changed_netdevs;
+ struct sset changed_netdevs;
};
/* Creates and returns a new structure for monitor changes in the status of
{
struct netdev_monitor *monitor = xmalloc(sizeof *monitor);
shash_init(&monitor->polled_netdevs);
- shash_init(&monitor->changed_netdevs);
+ sset_init(&monitor->changed_netdevs);
return monitor;
}
}
shash_destroy(&monitor->polled_netdevs);
- shash_destroy(&monitor->changed_netdevs);
+ sset_destroy(&monitor->changed_netdevs);
free(monitor);
}
}
{
struct netdev_monitor *monitor = notifier->aux;
const char *name = netdev_get_name(notifier->netdev);
- if (!shash_find(&monitor->changed_netdevs, name)) {
- shash_add(&monitor->changed_netdevs, name, NULL);
- }
+ sset_add(&monitor->changed_netdevs, name);
}
/* Attempts to add 'netdev' as a netdev monitored by 'monitor'. Returns 0 if
shash_delete(&monitor->polled_netdevs, node);
/* Drop any pending notification. */
- node = shash_find(&monitor->changed_netdevs, netdev_name);
- if (node) {
- shash_delete(&monitor->changed_netdevs, node);
- }
+ sset_find_and_delete(&monitor->changed_netdevs, netdev_name);
}
}
* sets '*devnamep' to the name of a device that has changed and returns 0.
* The caller is responsible for freeing '*devnamep' (with free()).
*
- * If no devices have changed, sets '*devnamep' to NULL and returns EAGAIN.
- */
+ * If no devices have changed, sets '*devnamep' to NULL and returns EAGAIN. */
int
netdev_monitor_poll(struct netdev_monitor *monitor, char **devnamep)
{
- struct shash_node *node = shash_first(&monitor->changed_netdevs);
- if (!node) {
+ if (sset_is_empty(&monitor->changed_netdevs)) {
*devnamep = NULL;
return EAGAIN;
} else {
- *devnamep = xstrdup(node->name);
- shash_delete(&monitor->changed_netdevs, node);
+ *devnamep = sset_pop(&monitor->changed_netdevs);
return 0;
}
}
+/* Clears all notifications from 'monitor'. May be called instead of
+ * netdev_monitor_poll() by clients which don't care specifically which netdevs
+ * have changed. */
+void
+netdev_monitor_flush(struct netdev_monitor *monitor)
+{
+ sset_clear(&monitor->changed_netdevs);
+}
+
/* Registers with the poll loop to wake up from the next call to poll_block()
* when netdev_monitor_poll(monitor) would indicate that a device has
* changed. */
void
netdev_monitor_poll_wait(const struct netdev_monitor *monitor)
{
- if (!shash_is_empty(&monitor->changed_netdevs)) {
+ if (!sset_is_empty(&monitor->changed_netdevs)) {
poll_immediate_wake();
} else {
/* XXX Nothing needed here for netdev_linux, but maybe other netdev
close_all_netdevs(void *aux OVS_UNUSED)
{
struct netdev *netdev, *next;
- LIST_FOR_EACH_SAFE(netdev, next, struct netdev, node, &netdev_list) {
+ LIST_FOR_EACH_SAFE(netdev, next, node, &netdev_list) {
netdev_close(netdev);
}
}