/*
- * Copyright (c) 2008, 2009, 2010 Nicira Networks.
+ * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include <config.h>
#include "netdev.h"
-#include <assert.h>
#include <errno.h>
#include <inttypes.h>
#include <netinet/in.h>
#include <unistd.h>
#include "coverage.h"
+#include "dpif.h"
#include "dynamic-string.h"
#include "fatal-signal.h"
#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 "smap.h"
+#include "sset.h"
#include "svec.h"
-
-#define THIS_MODULE VLM_netdev
#include "vlog.h"
-static const struct netdev_class *base_netdev_classes[] = {
- &netdev_linux_class,
- &netdev_tap_class,
- &netdev_gre_class,
+VLOG_DEFINE_THIS_MODULE(netdev);
+
+COVERAGE_DEFINE(netdev_received);
+COVERAGE_DEFINE(netdev_sent);
+COVERAGE_DEFINE(netdev_add_router);
+COVERAGE_DEFINE(netdev_get_stats);
+
+struct netdev_saved_flags {
+ struct netdev *netdev;
+ struct list node; /* In struct netdev's saved_flags_list. */
+ enum netdev_flags saved_flags;
+ enum netdev_flags saved_values;
};
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);
+static struct shash netdev_shash = SHASH_INITIALIZER(&netdev_shash);
/* This is set pretty low because we probably won't learn anything from the
* additional log messages. */
static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
-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);
+static void restore_all_flags(void *aux OVS_UNUSED);
+void update_device_args(struct netdev *, const struct shash *args);
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);
+ fatal_signal_add_hook(restore_all_flags, NULL, NULL, true);
+ netdev_vport_patch_register();
- status = 0;
- for (i = 0; i < ARRAY_SIZE(base_netdev_classes); i++) {
- netdev_register_provider(base_netdev_classes[i]);
- }
+#ifdef LINUX_DATAPATH
+ netdev_register_provider(&netdev_linux_class);
+ netdev_register_provider(&netdev_internal_class);
+ netdev_register_provider(&netdev_tap_class);
+ netdev_vport_tunnel_register();
+#endif
+#if defined(__FreeBSD__) || defined(__NetBSD__)
+ netdev_register_provider(&netdev_tap_class);
+ netdev_register_provider(&netdev_bsd_class);
+#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);
int error = new_class->init();
if (error) {
VLOG_ERR("failed to initialize %s network device class: %s",
- new_class->type, strerror(error));
+ new_class->type, ovs_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);
+ shash_add(&netdev_classes, new_class->type, new_class);
return 0;
}
int
netdev_unregister_provider(const char *type)
{
- struct shash_node *del_node, *netdev_dev_node;
+ struct shash_node *del_node, *netdev_node;
del_node = shash_find(&netdev_classes, type);
if (!del_node) {
return EAFNOSUPPORT;
}
- SHASH_FOR_EACH(netdev_dev_node, &netdev_dev_shash) {
- struct netdev_dev *netdev_dev = netdev_dev_node->data;
- if (!strcmp(netdev_dev->netdev_class->type, type)) {
+ SHASH_FOR_EACH (netdev_node, &netdev_shash) {
+ struct netdev *netdev = netdev_node->data;
+ if (!strcmp(netdev->netdev_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;
}
+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)
+/* Check that the network device name is not the same as any of the registered
+ * vport providers' dpif_port name (dpif_port is NULL if the vport provider
+ * does not define it) or the datapath internal port name (e.g. ovs-system).
+ *
+ * Returns true if there is a name conflict, false otherwise. */
+bool
+netdev_is_reserved_name(const char *name)
{
- const struct shash_node **new_args;
- bool result = true;
- int i;
+ struct shash_node *node;
- if (shash_count(args) != dev->n_args) {
- return false;
+ netdev_initialize();
+ SHASH_FOR_EACH (node, &netdev_classes) {
+ const char *dpif_port;
+ dpif_port = netdev_vport_class_get_dpif_port(node->data);
+ if (dpif_port && !strcmp(dpif_port, name)) {
+ return true;
+ }
}
- 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;
+ if (!strncmp(name, "ovs-", 4)) {
+ struct sset types;
+ const char *type;
+
+ sset_init(&types);
+ dp_enumerate_types(&types);
+ SSET_FOR_EACH (type, &types) {
+ if (!strcmp(name+4, type)) {
+ sset_destroy(&types);
+ return true;
+ }
}
+ sset_destroy(&types);
}
-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);
+ return false;
}
-void
-update_device_args(struct netdev_dev *dev, const struct shash *args)
+/* Opens the network device named 'name' (e.g. "eth0") of the specified 'type'
+ * (e.g. "system") and returns zero if successful, otherwise a positive errno
+ * value. On success, sets '*netdevp' to the new network device, otherwise to
+ * null.
+ *
+ * Some network devices may need to be configured (with netdev_set_config())
+ * before they can be used. */
+int
+netdev_open(const char *name, const char *type, struct netdev **netdevp)
{
- 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);
- }
+ struct netdev *netdev;
+ int error;
- free(dev->args);
- dev->n_args = 0;
- }
+ *netdevp = NULL;
+ netdev_initialize();
- if (!args || shash_is_empty(args)) {
- return;
- }
+ netdev = shash_find_data(&netdev_shash, name);
+ if (!netdev) {
+ const struct netdev_class *class;
- dev->n_args = shash_count(args);
- dev->args = xmalloc(dev->n_args * sizeof *dev->args);
+ class = netdev_lookup_provider(type);
+ if (!class) {
+ VLOG_WARN("could not create netdev %s of unknown type %s",
+ name, type);
+ return EAFNOSUPPORT;
+ }
+ error = class->create(class, name, &netdev);
+ if (error) {
+ return error;
+ }
+ ovs_assert(netdev->netdev_class == class);
- i = 0;
- SHASH_FOR_EACH(node, args) {
- dev->args[i].key = xstrdup(node->name);
- dev->args[i].value = xstrdup(node->data);
- i++;
}
+ netdev->ref_cnt++;
- qsort(dev->args, dev->n_args, sizeof *dev->args, compare_args);
+ *netdevp = netdev;
+ return 0;
}
-static int
-create_device(struct netdev_options *options, struct netdev_dev **netdev_devp)
+/* Returns a reference to 'netdev_' for the caller to own. Returns null if
+ * 'netdev_' is null. */
+struct netdev *
+netdev_ref(const struct netdev *netdev_)
{
- 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;
- }
+ struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
- if (!options->type || strlen(options->type) == 0) {
- /* Default to system. */
- options->type = "system";
+ if (netdev) {
+ ovs_assert(netdev->ref_cnt > 0);
+ netdev->ref_cnt++;
}
+ return netdev;
+}
- 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;
+/* Reconfigures the device 'netdev' with 'args'. 'args' may be empty
+ * or NULL if none are needed. */
+int
+netdev_set_config(struct netdev *netdev, const struct smap *args)
+{
+ if (netdev->netdev_class->set_config) {
+ struct smap no_args = SMAP_INITIALIZER(&no_args);
+ return netdev->netdev_class->set_config(netdev,
+ args ? args : &no_args);
+ } else if (args && !smap_is_empty(args)) {
+ VLOG_WARN("%s: arguments provided to device that is not configurable",
+ netdev_get_name(netdev));
}
- return netdev_class->create(options->name, options->type, options->args,
- netdev_devp);
+ return 0;
}
-/* 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.
+/* Returns the current configuration for 'netdev' in 'args'. The caller must
+ * have already initialized 'args' with smap_init(). Returns 0 on success, in
+ * which case 'args' will be filled with 'netdev''s configuration. On failure
+ * returns a positive errno value, in which case 'args' will be empty.
*
- * 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.
- *
- * 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. */
-
+ * The caller owns 'args' and its contents and must eventually free them with
+ * smap_destroy(). */
int
-netdev_open(struct netdev_options *options, struct netdev **netdevp)
+netdev_get_config(const struct netdev *netdev, struct smap *args)
{
- struct shash empty_args = SHASH_INITIALIZER(&empty_args);
- struct netdev_dev *netdev_dev;
int error;
- *netdevp = NULL;
- netdev_initialize();
-
- 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);
+ smap_clear(args);
+ if (netdev->netdev_class->get_config) {
+ error = netdev->netdev_class->get_config(netdev, args);
if (error) {
- return error;
+ smap_clear(args);
}
- 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 {
- VLOG_WARN("%s: attempted to create a netdev device with bound name",
- options->name);
- return EEXIST;
- }
-
- error = netdev_dev->netdev_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 = 0;
}
return error;
}
-int
-netdev_open_default(const char *name, struct netdev **netdevp)
+const struct netdev_tunnel_config *
+netdev_get_tunnel_config(const struct netdev *netdev)
{
- 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);
+ if (netdev->netdev_class->get_tunnel_config) {
+ return netdev->netdev_class->get_tunnel_config(netdev);
+ } else {
+ return NULL;
+ }
}
-/* 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)
+static void
+netdev_unref(struct netdev *dev)
{
- 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->netdev_class->reconfigure) {
- if (!compare_device_args(netdev_dev, args)) {
- update_device_args(netdev_dev, args);
- return netdev_dev->netdev_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));
+ ovs_assert(dev->ref_cnt);
+ if (!--dev->ref_cnt) {
+ netdev_uninit(dev, true);
}
-
- return 0;
}
/* Closes and destroys 'netdev'. */
netdev_close(struct netdev *netdev)
{
if (netdev) {
- struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
+ netdev_unref(netdev);
+ }
+}
- assert(netdev_dev->ref_cnt);
- netdev_dev->ref_cnt--;
- netdev_uninit(netdev, true);
+/* Parses 'netdev_name_', which is of the form [type@]name into its component
+ * pieces. 'name' and 'type' must be freed by the caller. */
+void
+netdev_parse_name(const char *netdev_name_, char **name, char **type)
+{
+ char *netdev_name = xstrdup(netdev_name_);
+ char *separator;
- /* If the reference count for the netdev device is zero, destroy it. */
- if (!netdev_dev->ref_cnt) {
- netdev_dev_uninit(netdev_dev, true);
- }
+ separator = strchr(netdev_name, '@');
+ if (separator) {
+ *separator = '\0';
+ *type = netdev_name;
+ *name = xstrdup(separator + 1);
+ } else {
+ *name = netdev_name;
+ *type = xstrdup("system");
}
}
-/* Returns true if a network device named 'name' exists and may be opened,
- * otherwise false. */
-bool
-netdev_exists(const char *name)
+int
+netdev_rx_open(struct netdev *netdev, struct netdev_rx **rxp)
{
- struct netdev *netdev;
int error;
- error = netdev_open_default(name, &netdev);
+ error = (netdev->netdev_class->rx_open
+ ? netdev->netdev_class->rx_open(netdev, rxp)
+ : EOPNOTSUPP);
if (!error) {
- netdev_close(netdev);
- return true;
+ ovs_assert((*rxp)->netdev == netdev);
+ netdev->ref_cnt++;
} else {
- if (error != ENODEV) {
- VLOG_WARN("failed to open network device %s: %s",
- name, strerror(error));
- }
- return false;
+ *rxp = NULL;
}
+ return error;
}
-/* Clears 'svec' and enumerates the names of all known network devices. */
-int
-netdev_enumerate(struct svec *svec)
+void
+netdev_rx_close(struct netdev_rx *rx)
{
- struct shash_node *node;
- int error = 0;
-
- netdev_initialize();
- svec_clear(svec);
+ if (rx) {
+ struct netdev *dev = rx->netdev;
- 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",
- netdev_class->type, strerror(retval));
- if (!error) {
- error = retval;
- }
- }
- }
+ rx->rx_class->destroy(rx);
+ netdev_unref(dev);
}
-
- return error;
}
-/* Attempts to receive a packet from 'netdev' into 'buffer', which the caller
- * must have initialized with sufficient room for the packet. The space
- * required to receive any packet is ETH_HEADER_LEN bytes, plus VLAN_HEADER_LEN
- * bytes, plus the device's MTU (which may be retrieved via netdev_get_mtu()).
- * (Some devices do not allow for a VLAN header, in which case VLAN_HEADER_LEN
- * need not be included.)
- *
- * If a packet is successfully retrieved, returns 0. In this case 'buffer' is
- * guaranteed to contain at least ETH_TOTAL_MIN bytes. Otherwise, returns a
- * positive errno value. Returns EAGAIN immediately if no packet is ready to
- * be returned.
- */
int
-netdev_recv(struct netdev *netdev, struct ofpbuf *buffer)
+netdev_rx_recv(struct netdev_rx *rx, struct ofpbuf *buffer)
{
int retval;
- assert(buffer->size == 0);
- assert(ofpbuf_tailroom(buffer) >= ETH_TOTAL_MIN);
+ ovs_assert(buffer->size == 0);
+ ovs_assert(ofpbuf_tailroom(buffer) >= ETH_TOTAL_MIN);
- retval = netdev_get_dev(netdev)->netdev_class->recv(netdev, buffer->data,
- ofpbuf_tailroom(buffer));
+ retval = rx->rx_class->recv(rx, buffer->data, ofpbuf_tailroom(buffer));
if (retval >= 0) {
COVERAGE_INC(netdev_received);
buffer->size += retval;
}
}
-/* Registers with the poll loop to wake up from the next call to poll_block()
- * when a packet is ready to be received with netdev_recv() on 'netdev'. */
void
-netdev_recv_wait(struct netdev *netdev)
+netdev_rx_wait(struct netdev_rx *rx)
{
- netdev_get_dev(netdev)->netdev_class->recv_wait(netdev);
+ rx->rx_class->wait(rx);
}
-/* Discards all packets waiting to be received from 'netdev'. */
int
-netdev_drain(struct netdev *netdev)
+netdev_rx_drain(struct netdev_rx *rx)
{
- return netdev_get_dev(netdev)->netdev_class->drain(netdev);
+ return rx->rx_class->drain ? rx->rx_class->drain(rx) : 0;
}
/* Sends 'buffer' on 'netdev'. Returns 0 if successful, otherwise a positive
* The caller retains ownership of 'buffer' in all cases.
*
* The kernel maintains a packet transmission queue, so the caller is not
- * expected to do additional queuing of packets. */
+ * expected to do additional queuing of packets.
+ *
+ * Some network devices may not implement support for this function. In such
+ * cases this function will always return EOPNOTSUPP. */
int
netdev_send(struct netdev *netdev, const struct ofpbuf *buffer)
{
- int error = netdev_get_dev(netdev)->netdev_class->send(netdev,
- buffer->data, buffer->size);
+ int error;
+
+ error = (netdev->netdev_class->send
+ ? netdev->netdev_class->send(netdev, buffer->data, buffer->size)
+ : EOPNOTSUPP);
if (!error) {
COVERAGE_INC(netdev_sent);
}
void
netdev_send_wait(struct netdev *netdev)
{
- return netdev_get_dev(netdev)->netdev_class->send_wait(netdev);
+ if (netdev->netdev_class->send_wait) {
+ netdev->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_get_dev(netdev)->netdev_class->set_etheraddr(netdev, mac);
+ return netdev->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_get_dev(netdev)->netdev_class->get_etheraddr(netdev, mac);
+ return netdev->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_get_dev(netdev)->name;
+ return netdev->name;
}
/* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
* (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
- * '*mtup'. */
+ * If successful, returns 0 and stores the MTU size in '*mtup'. Returns
+ * EOPNOTSUPP if 'netdev' does not have an MTU (as e.g. some tunnels do not).
+ * On other failure, returns a positive errno value. On failure, sets '*mtup'
+ * to 0. */
int
netdev_get_mtu(const struct netdev *netdev, int *mtup)
{
- int error = netdev_get_dev(netdev)->netdev_class->get_mtu(netdev, mtup);
+ const struct netdev_class *class = netdev->netdev_class;
+ int error;
+
+ error = class->get_mtu ? class->get_mtu(netdev, mtup) : EOPNOTSUPP;
if (error) {
- VLOG_WARN_RL(&rl, "failed to retrieve MTU for network device %s: %s",
- netdev_get_name(netdev), strerror(error));
- *mtup = ETH_PAYLOAD_MAX;
+ *mtup = 0;
+ if (error != EOPNOTSUPP) {
+ VLOG_DBG_RL(&rl, "failed to retrieve MTU for network device %s: "
+ "%s", netdev_get_name(netdev), ovs_strerror(error));
+ }
}
return error;
}
+/* Sets the MTU of 'netdev'. The MTU is the maximum size of transmitted
+ * (and received) packets, in bytes.
+ *
+ * If successful, returns 0. Returns EOPNOTSUPP if 'netdev' does not have an
+ * MTU (as e.g. some tunnels do not). On other failure, returns a positive
+ * errno value. */
+int
+netdev_set_mtu(const struct netdev *netdev, int mtu)
+{
+ const struct netdev_class *class = netdev->netdev_class;
+ int error;
+
+ error = class->set_mtu ? class->set_mtu(netdev, mtu) : EOPNOTSUPP;
+ if (error && error != EOPNOTSUPP) {
+ VLOG_DBG_RL(&rl, "failed to set MTU for network device %s: %s",
+ netdev_get_name(netdev), ovs_strerror(error));
+ }
+
+ return error;
+}
+
/* Returns the ifindex of 'netdev', if successful, as a positive number. On
* failure, returns a negative errno value.
*
* 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.
+ *
+ * Some network devices may not implement support for this function. In such
+ * cases this function will always return -EOPNOTSUPP.
*/
int
netdev_get_ifindex(const struct netdev *netdev)
{
- return netdev_get_dev(netdev)->netdev_class->get_ifindex(netdev);
+ int (*get_ifindex)(const struct netdev *);
+
+ get_ifindex = netdev->netdev_class->get_ifindex;
+
+ return get_ifindex ? get_ifindex(netdev) : -EOPNOTSUPP;
}
/* 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
* successful, otherwise a positive errno value. On failure, all of the
- * passed-in values are set to 0. */
+ * 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. */
int
-netdev_get_features(struct netdev *netdev,
- uint32_t *current, uint32_t *advertised,
- uint32_t *supported, uint32_t *peer)
-{
- uint32_t dummy[4];
+netdev_get_features(const struct netdev *netdev,
+ enum netdev_features *current,
+ enum netdev_features *advertised,
+ enum netdev_features *supported,
+ enum netdev_features *peer)
+{
+ int (*get_features)(const struct netdev *netdev,
+ enum netdev_features *current,
+ enum netdev_features *advertised,
+ enum netdev_features *supported,
+ enum netdev_features *peer);
+ enum netdev_features dummy[4];
int error;
if (!current) {
peer = &dummy[3];
}
- error = netdev_get_dev(netdev)->netdev_class->get_features(netdev, current,
- advertised, supported, peer);
+ get_features = netdev->netdev_class->get_features;
+ error = get_features
+ ? get_features(netdev, current, advertised, supported,
+ peer)
+ : EOPNOTSUPP;
if (error) {
*current = *advertised = *supported = *peer = 0;
}
return error;
}
-/* Returns the maximum speed of a network connection that has the "enum
- * ofp_port_features" bits in 'features', in bits per second. If no bits that
- * indicate a speed are set in 'features', assumes 100Mbps. */
+/* Returns the maximum speed of a network connection that has the NETDEV_F_*
+ * bits in 'features', in bits per second. If no bits that indicate a speed
+ * are set in 'features', returns 'default_bps'. */
uint64_t
-netdev_features_to_bps(uint32_t features)
+netdev_features_to_bps(enum netdev_features features,
+ uint64_t default_bps)
{
enum {
- F_10000MB = OFPPF_10GB_FD,
- F_1000MB = OFPPF_1GB_HD | OFPPF_1GB_FD,
- F_100MB = OFPPF_100MB_HD | OFPPF_100MB_FD,
- F_10MB = OFPPF_10MB_HD | OFPPF_10MB_FD
+ F_1000000MB = NETDEV_F_1TB_FD,
+ F_100000MB = NETDEV_F_100GB_FD,
+ F_40000MB = NETDEV_F_40GB_FD,
+ F_10000MB = NETDEV_F_10GB_FD,
+ F_1000MB = NETDEV_F_1GB_HD | NETDEV_F_1GB_FD,
+ F_100MB = NETDEV_F_100MB_HD | NETDEV_F_100MB_FD,
+ F_10MB = NETDEV_F_10MB_HD | NETDEV_F_10MB_FD
};
- return ( features & F_10000MB ? UINT64_C(10000000000)
- : features & F_1000MB ? UINT64_C(1000000000)
- : features & F_100MB ? UINT64_C(100000000)
- : features & F_10MB ? UINT64_C(10000000)
- : UINT64_C(100000000));
+ return ( features & F_1000000MB ? UINT64_C(1000000000000)
+ : features & F_100000MB ? UINT64_C(100000000000)
+ : features & F_40000MB ? UINT64_C(40000000000)
+ : features & F_10000MB ? UINT64_C(10000000000)
+ : features & F_1000MB ? UINT64_C(1000000000)
+ : features & F_100MB ? UINT64_C(100000000)
+ : features & F_10MB ? UINT64_C(10000000)
+ : default_bps);
}
-/* Returns true if any of the "enum ofp_port_features" bits that indicate a
- * full-duplex link are set in 'features', otherwise false. */
+/* Returns true if any of the NETDEV_F_* bits that indicate a full-duplex link
+ * are set in 'features', otherwise false. */
bool
-netdev_features_is_full_duplex(uint32_t features)
+netdev_features_is_full_duplex(enum netdev_features features)
{
- return (features & (OFPPF_10MB_FD | OFPPF_100MB_FD | OFPPF_1GB_FD
- | OFPPF_10GB_FD)) != 0;
+ return (features & (NETDEV_F_10MB_FD | NETDEV_F_100MB_FD | NETDEV_F_1GB_FD
+ | NETDEV_F_10GB_FD | NETDEV_F_40GB_FD
+ | NETDEV_F_100GB_FD | NETDEV_F_1TB_FD)) != 0;
}
/* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if
* successful, otherwise a positive errno value. */
int
-netdev_set_advertisements(struct netdev *netdev, uint32_t advertise)
+netdev_set_advertisements(struct netdev *netdev,
+ enum netdev_features advertise)
{
- return (netdev_get_dev(netdev)->netdev_class->set_advertisements
- ? netdev_get_dev(netdev)->netdev_class->set_advertisements(
+ return (netdev->netdev_class->set_advertisements
+ ? netdev->netdev_class->set_advertisements(
netdev, advertise)
: EOPNOTSUPP);
}
*
* - 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_)
struct in_addr netmask;
int error;
- error = (netdev_get_dev(netdev)->netdev_class->get_in4
- ? netdev_get_dev(netdev)->netdev_class->get_in4(netdev,
+ error = (netdev->netdev_class->get_in4
+ ? netdev->netdev_class->get_in4(netdev,
&address, &netmask)
: EOPNOTSUPP);
if (address_) {
int
netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
{
- return (netdev_get_dev(netdev)->netdev_class->set_in4
- ? netdev_get_dev(netdev)->netdev_class->set_in4(netdev, addr, mask)
+ return (netdev->netdev_class->set_in4
+ ? netdev->netdev_class->set_in4(netdev, addr, mask)
: EOPNOTSUPP);
}
+/* Obtains ad IPv4 address from device name and save the address in
+ * in4. Returns 0 if successful, otherwise a positive errno value.
+ */
+int
+netdev_get_in4_by_name(const char *device_name, struct in_addr *in4)
+{
+ struct netdev *netdev;
+ int error;
+
+ error = netdev_open(device_name, "system", &netdev);
+ if (error) {
+ in4->s_addr = htonl(0);
+ return error;
+ }
+
+ error = netdev_get_in4(netdev, in4, NULL);
+ netdev_close(netdev);
+ return error;
+}
+
/* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
* to 'netdev'. */
int
netdev_add_router(struct netdev *netdev, struct in_addr router)
{
COVERAGE_INC(netdev_add_router);
- return (netdev_get_dev(netdev)->netdev_class->add_router
- ? netdev_get_dev(netdev)->netdev_class->add_router(netdev, router)
+ return (netdev->netdev_class->add_router
+ ? netdev->netdev_class->add_router(netdev, router)
: EOPNOTSUPP);
}
const struct in_addr *host, struct in_addr *next_hop,
char **netdev_name)
{
- int error = (netdev_get_dev(netdev)->netdev_class->get_next_hop
- ? netdev_get_dev(netdev)->netdev_class->get_next_hop(
+ int error = (netdev->netdev_class->get_next_hop
+ ? netdev->netdev_class->get_next_hop(
host, next_hop, netdev_name)
: EOPNOTSUPP);
if (error) {
return error;
}
+/* Populates 'smap' with status information.
+ *
+ * Populates 'smap' 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 smap *smap)
+{
+ return (netdev->netdev_class->get_status
+ ? netdev->netdev_class->get_status(netdev, smap)
+ : 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).
struct in6_addr dummy;
int error;
- error = (netdev_get_dev(netdev)->netdev_class->get_in6
- ? netdev_get_dev(netdev)->netdev_class->get_in6(netdev,
+ error = (netdev->netdev_class->get_in6
+ ? netdev->netdev_class->get_in6(netdev,
in6 ? in6 : &dummy)
: EOPNOTSUPP);
if (error && in6) {
}
/* On 'netdev', turns off the flags in 'off' and then turns on the flags in
- * 'on'. If 'permanent' is true, the changes will persist; otherwise, they
- * will be reverted when 'netdev' is closed or the program exits. Returns 0 if
- * successful, otherwise a positive errno value. */
+ * 'on'. Returns 0 if successful, otherwise a positive errno value. */
static int
do_update_flags(struct netdev *netdev, enum netdev_flags off,
enum netdev_flags on, enum netdev_flags *old_flagsp,
- bool permanent)
+ struct netdev_saved_flags **sfp)
{
+ struct netdev_saved_flags *sf = NULL;
enum netdev_flags old_flags;
int error;
- error = netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
- off & ~on, on, &old_flags);
+ error = 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",
off || on ? "set" : "get", netdev_get_name(netdev),
- strerror(error));
+ ovs_strerror(error));
old_flags = 0;
- } else if ((off || on) && !permanent) {
+ } else if ((off || on) && sfp) {
enum netdev_flags new_flags = (old_flags & ~off) | on;
enum netdev_flags changed_flags = old_flags ^ new_flags;
if (changed_flags) {
- if (!netdev->changed_flags) {
- netdev->save_flags = old_flags;
- }
- netdev->changed_flags |= changed_flags;
+ *sfp = sf = xmalloc(sizeof *sf);
+ sf->netdev = netdev;
+ list_push_front(&netdev->saved_flags_list, &sf->node);
+ sf->saved_flags = changed_flags;
+ sf->saved_values = changed_flags & new_flags;
+
+ netdev->ref_cnt++;
}
}
+
if (old_flagsp) {
*old_flagsp = old_flags;
}
+ if (sfp) {
+ *sfp = sf;
+ }
+
return error;
}
int
netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
{
- struct netdev *netdev = (struct netdev *) netdev_;
- return do_update_flags(netdev, 0, 0, flagsp, false);
+ struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
+ return do_update_flags(netdev, 0, 0, flagsp, NULL);
}
/* Sets the flags for 'netdev' to 'flags'.
- * If 'permanent' is true, the changes will persist; otherwise, they
- * will be reverted when 'netdev' is closed or the program exits.
* Returns 0 if successful, otherwise a positive errno value. */
int
netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
- bool permanent)
+ struct netdev_saved_flags **sfp)
{
- return do_update_flags(netdev, -1, flags, NULL, permanent);
+ return do_update_flags(netdev, -1, flags, NULL, sfp);
}
-/* Turns on the specified 'flags' on 'netdev'.
- * If 'permanent' is true, the changes will persist; otherwise, they
- * will be reverted when 'netdev' is closed or the program exits.
- * Returns 0 if successful, otherwise a positive errno value. */
+/* Turns on the specified 'flags' on 'netdev':
+ *
+ * - On success, returns 0. If 'sfp' is nonnull, sets '*sfp' to a newly
+ * allocated 'struct netdev_saved_flags *' that may be passed to
+ * netdev_restore_flags() to restore the original values of 'flags' on
+ * 'netdev' (this will happen automatically at program termination if
+ * netdev_restore_flags() is never called) , or to NULL if no flags were
+ * actually changed.
+ *
+ * - On failure, returns a positive errno value. If 'sfp' is nonnull, sets
+ * '*sfp' to NULL. */
int
netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
- bool permanent)
+ struct netdev_saved_flags **sfp)
{
- return do_update_flags(netdev, 0, flags, NULL, permanent);
+ return do_update_flags(netdev, 0, flags, NULL, sfp);
}
-/* Turns off the specified 'flags' on 'netdev'.
- * If 'permanent' is true, the changes will persist; otherwise, they
- * will be reverted when 'netdev' is closed or the program exits.
- * Returns 0 if successful, otherwise a positive errno value. */
+/* Turns off the specified 'flags' on 'netdev'. See netdev_turn_flags_on() for
+ * details of the interface. */
int
netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
- bool permanent)
+ struct netdev_saved_flags **sfp)
{
- return do_update_flags(netdev, flags, 0, NULL, permanent);
+ return do_update_flags(netdev, flags, 0, NULL, sfp);
+}
+
+/* Restores the flags that were saved in 'sf', and destroys 'sf'.
+ * Does nothing if 'sf' is NULL. */
+void
+netdev_restore_flags(struct netdev_saved_flags *sf)
+{
+ if (sf) {
+ struct netdev *netdev = sf->netdev;
+ enum netdev_flags old_flags;
+
+ netdev->netdev_class->update_flags(netdev,
+ sf->saved_flags & sf->saved_values,
+ sf->saved_flags & ~sf->saved_values,
+ &old_flags);
+ list_remove(&sf->node);
+ free(sf);
+
+ netdev_unref(netdev);
+ }
}
/* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
* 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,
+ int error = (netdev->netdev_class->arp_lookup
+ ? 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->netdev_class->get_carrier) {
+ return true;
+ }
+
+ error = 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), ovs_strerror(error));
+ carrier = false;
}
- return error;
+
+ return carrier;
+}
+
+/* Returns the number of times 'netdev''s carrier has changed. */
+long long int
+netdev_get_carrier_resets(const struct netdev *netdev)
+{
+ return (netdev->netdev_class->get_carrier_resets
+ ? netdev->netdev_class->get_carrier_resets(netdev)
+ : 0);
+}
+
+/* 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)
+{
+ return (netdev->netdev_class->set_miimon_interval
+ ? netdev->netdev_class->set_miimon_interval(netdev, interval)
+ : EOPNOTSUPP);
}
/* Retrieves current device stats for 'netdev'. */
int error;
COVERAGE_INC(netdev_get_stats);
- error = (netdev_get_dev(netdev)->netdev_class->get_stats
- ? netdev_get_dev(netdev)->netdev_class->get_stats(netdev, stats)
+ error = (netdev->netdev_class->get_stats
+ ? netdev->netdev_class->get_stats(netdev, stats)
: EOPNOTSUPP);
if (error) {
memset(stats, 0xff, sizeof *stats);
return error;
}
+/* Attempts to change the stats for 'netdev' to those provided in 'stats'.
+ * Returns 0 if successful, otherwise a positive errno value.
+ *
+ * This will probably fail for most network devices. Some devices might only
+ * allow setting their stats to 0. */
+int
+netdev_set_stats(struct netdev *netdev, const struct netdev_stats *stats)
+{
+ return (netdev->netdev_class->set_stats
+ ? netdev->netdev_class->set_stats(netdev, stats)
+ : EOPNOTSUPP);
+}
+
/* Attempts to set input rate limiting (policing) policy, such that up to
* 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
* size of 'kbits' kb. */
netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
uint32_t kbits_burst)
{
- return (netdev_get_dev(netdev)->netdev_class->set_policing
- ? netdev_get_dev(netdev)->netdev_class->set_policing(netdev,
+ return (netdev->netdev_class->set_policing
+ ? netdev->netdev_class->set_policing(netdev,
kbits_rate, kbits_burst)
: EOPNOTSUPP);
}
-/* 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
- * name of a network device that is not a VLAN device) and sets '*vlan_vid' to
- * -1. */
+/* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
+ * empty if 'netdev' does not support QoS. Any names added to 'types' should
+ * be documented as valid for the "type" column in the "QoS" table in
+ * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
+ *
+ * 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 sset_init()) before calling
+ * this function. The caller is responsible for destroying 'types' (e.g. with
+ * sset_destroy()) when it is no longer needed.
+ *
+ * Returns 0 if successful, otherwise a positive errno value. */
int
-netdev_get_vlan_vid(const struct netdev *netdev, int *vlan_vid)
+netdev_get_qos_types(const struct netdev *netdev, struct sset *types)
{
- int error = (netdev_get_dev(netdev)->netdev_class->get_vlan_vid
- ? netdev_get_dev(netdev)->netdev_class->get_vlan_vid(netdev,
- vlan_vid)
- : ENOENT);
- if (error) {
- *vlan_vid = 0;
- }
- return error;
+ const struct netdev_class *class = netdev->netdev_class;
+ return (class->get_qos_types
+ ? class->get_qos_types(netdev, types)
+ : 0);
}
-/* Returns a network device that has 'in4' as its IP address, if one exists,
- * otherwise a null pointer. */
-struct netdev *
-netdev_find_dev_by_in4(const struct in_addr *in4)
+/* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
+ * which should be "" or one of the types returned by netdev_get_qos_types()
+ * for 'netdev'. Returns 0 if successful, otherwise a positive errno value.
+ * On success, initializes 'caps' with the QoS capabilities; on failure, clears
+ * 'caps' to all zeros. */
+int
+netdev_get_qos_capabilities(const struct netdev *netdev, const char *type,
+ struct netdev_qos_capabilities *caps)
{
- struct netdev *netdev;
- struct svec dev_list = SVEC_EMPTY_INITIALIZER;
- size_t i;
-
- netdev_enumerate(&dev_list);
- for (i = 0; i < dev_list.n; i++) {
- const char *name = dev_list.names[i];
- struct in_addr dev_in4;
-
- if (!netdev_open_default(name, &netdev)
- && !netdev_get_in4(netdev, &dev_in4, NULL)
- && dev_in4.s_addr == in4->s_addr) {
- goto exit;
+ const struct netdev_class *class = netdev->netdev_class;
+
+ if (*type) {
+ int retval = (class->get_qos_capabilities
+ ? class->get_qos_capabilities(netdev, type, caps)
+ : EOPNOTSUPP);
+ if (retval) {
+ memset(caps, 0, sizeof *caps);
}
- netdev_close(netdev);
+ return retval;
+ } else {
+ /* Every netdev supports turning off QoS. */
+ memset(caps, 0, sizeof *caps);
+ return 0;
}
- netdev = NULL;
-
-exit:
- svec_destroy(&dev_list);
- return netdev;
}
-\f
-/* Initializes 'netdev_dev' as a netdev device named 'name' of the
- * specified 'netdev_class'.
+
+/* Obtains the number of queues supported by 'netdev' for the specified 'type'
+ * of QoS. Returns 0 if successful, otherwise a positive errno value. Stores
+ * the number of queues (zero on failure) in '*n_queuesp'.
*
- * 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 *netdev_class)
+ * This is just a simple wrapper around netdev_get_qos_capabilities(). */
+int
+netdev_get_n_queues(const struct netdev *netdev,
+ const char *type, unsigned int *n_queuesp)
{
- assert(!shash_find(&netdev_dev_shash, name));
+ struct netdev_qos_capabilities caps;
+ int retval;
- memset(netdev_dev, 0, sizeof *netdev_dev);
- netdev_dev->netdev_class = netdev_class;
- netdev_dev->name = xstrdup(name);
- netdev_dev->node = shash_add(&netdev_dev_shash, name, netdev_dev);
+ retval = netdev_get_qos_capabilities(netdev, type, &caps);
+ *n_queuesp = caps.n_queues;
+ return retval;
}
-/* Undoes the results of initialization.
+/* Queries 'netdev' about its currently configured form of QoS. If successful,
+ * stores the name of the current form of QoS into '*typep', stores any details
+ * of configuration as string key-value pairs in 'details', and returns 0. On
+ * failure, sets '*typep' to NULL and returns a positive errno value.
*
- * 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)
+ * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
+ *
+ * The caller must initialize 'details' as an empty smap (e.g. with
+ * smap_init()) before calling this function. The caller must free 'details'
+ * when it is no longer needed (e.g. with smap_destroy()).
+ *
+ * The caller must not modify or free '*typep'.
+ *
+ * '*typep' will be one of the types returned by netdev_get_qos_types() for
+ * 'netdev'. The contents of 'details' should be documented as valid for
+ * '*typep' in the "other_config" column in the "QoS" table in
+ * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
+int
+netdev_get_qos(const struct netdev *netdev,
+ const char **typep, struct smap *details)
{
- char *name = netdev_dev->name;
+ const struct netdev_class *class = netdev->netdev_class;
+ int retval;
- assert(!netdev_dev->ref_cnt);
+ if (class->get_qos) {
+ retval = class->get_qos(netdev, typep, details);
+ if (retval) {
+ *typep = NULL;
+ smap_clear(details);
+ }
+ return retval;
+ } else {
+ /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
+ *typep = "";
+ return 0;
+ }
+}
- shash_delete(&netdev_dev_shash, netdev_dev->node);
- update_device_args(netdev_dev, NULL);
+/* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
+ * with details of configuration from 'details'. Returns 0 if successful,
+ * otherwise a positive errno value. On error, the previous QoS configuration
+ * is retained.
+ *
+ * When this function changes the type of QoS (not just 'details'), this also
+ * resets all queue configuration for 'netdev' to their defaults (which depend
+ * on the specific type of QoS). Otherwise, the queue configuration for
+ * 'netdev' is unchanged.
+ *
+ * 'type' should be "" (to disable QoS) or one of the types returned by
+ * netdev_get_qos_types() for 'netdev'. The contents of 'details' should be
+ * documented as valid for the given 'type' in the "other_config" column in the
+ * "QoS" table in vswitchd/vswitch.xml (which is built as
+ * ovs-vswitchd.conf.db(8)).
+ *
+ * NULL may be specified for 'details' if there are no configuration
+ * details. */
+int
+netdev_set_qos(struct netdev *netdev,
+ const char *type, const struct smap *details)
+{
+ const struct netdev_class *class = netdev->netdev_class;
- if (destroy) {
- netdev_dev->netdev_class->destroy(netdev_dev);
+ if (!type) {
+ type = "";
+ }
+
+ if (class->set_qos) {
+ if (!details) {
+ static const struct smap empty = SMAP_INITIALIZER(&empty);
+ details = ∅
+ }
+ return class->set_qos(netdev, type, details);
+ } else {
+ return *type ? EOPNOTSUPP : 0;
}
- free(name);
}
-/* Returns the class type of 'netdev_dev'.
+/* Queries 'netdev' for information about the queue numbered 'queue_id'. If
+ * successful, adds that information as string key-value pairs to 'details'.
+ * Returns 0 if successful, otherwise a positive errno value.
*
- * The caller must not free the returned value. */
-const char *
-netdev_dev_get_type(const struct netdev_dev *netdev_dev)
+ * 'queue_id' must be less than the number of queues supported by 'netdev' for
+ * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
+ *
+ * The returned contents of 'details' should be documented as valid for the
+ * given 'type' in the "other_config" column in the "Queue" table in
+ * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
+ *
+ * The caller must initialize 'details' (e.g. with smap_init()) before calling
+ * this function. The caller must free 'details' when it is no longer needed
+ * (e.g. with smap_destroy()). */
+int
+netdev_get_queue(const struct netdev *netdev,
+ unsigned int queue_id, struct smap *details)
{
- return netdev_dev->netdev_class->type;
+ const struct netdev_class *class = netdev->netdev_class;
+ int retval;
+
+ retval = (class->get_queue
+ ? class->get_queue(netdev, queue_id, details)
+ : EOPNOTSUPP);
+ if (retval) {
+ smap_clear(details);
+ }
+ return retval;
}
-/* Returns the name of 'netdev_dev'.
+/* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
+ * string pairs in 'details'. The contents of 'details' should be documented
+ * as valid for the given 'type' in the "other_config" column in the "Queue"
+ * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
+ * Returns 0 if successful, otherwise a positive errno value. On failure, the
+ * given queue's configuration should be unmodified.
*
- * The caller must not free the returned value. */
-const char *
-netdev_dev_get_name(const struct netdev_dev *netdev_dev)
+ * 'queue_id' must be less than the number of queues supported by 'netdev' for
+ * 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. */
+int
+netdev_set_queue(struct netdev *netdev,
+ unsigned int queue_id, const struct smap *details)
{
- return netdev_dev->name;
+ const struct netdev_class *class = netdev->netdev_class;
+ return (class->set_queue
+ ? class->set_queue(netdev, queue_id, details)
+ : EOPNOTSUPP);
}
-/* Returns the netdev_dev with 'name' or NULL if there is none.
+/* Attempts to delete the queue numbered 'queue_id' from 'netdev'. Some kinds
+ * of QoS may have a fixed set of queues, in which case attempts to delete them
+ * will fail with EOPNOTSUPP.
*
- * The caller must not free the returned value. */
-struct netdev_dev *
-netdev_dev_from_name(const char *name)
+ * Returns 0 if successful, otherwise a positive errno value. On failure, the
+ * given queue will be unmodified.
+ *
+ * 'queue_id' must be less than the number of queues supported by 'netdev' for
+ * the current form of QoS (e.g. as returned by
+ * netdev_get_n_queues(netdev)). */
+int
+netdev_delete_queue(struct netdev *netdev, unsigned int queue_id)
{
- return shash_find_data(&netdev_dev_shash, name);
+ const struct netdev_class *class = netdev->netdev_class;
+ return (class->delete_queue
+ ? class->delete_queue(netdev, queue_id)
+ : EOPNOTSUPP);
}
-/* Fills 'device_list' with devices that match 'netdev_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 *netdev_class,
- struct shash *device_list)
+/* Obtains statistics about 'queue_id' on 'netdev'. On success, returns 0 and
+ * fills 'stats' with the queue's statistics; individual members of 'stats' may
+ * be set to all-1-bits if the statistic is unavailable. On failure, returns a
+ * positive errno value and fills 'stats' with values indicating unsupported
+ * statistics. */
+int
+netdev_get_queue_stats(const struct netdev *netdev, unsigned int queue_id,
+ struct netdev_queue_stats *stats)
{
- struct shash_node *node;
- SHASH_FOR_EACH (node, &netdev_dev_shash) {
- struct netdev_dev *dev = node->data;
+ const struct netdev_class *class = netdev->netdev_class;
+ int retval;
- if (dev->netdev_class == netdev_class) {
- shash_add(device_list, node->name, node->data);
- }
+ retval = (class->get_queue_stats
+ ? class->get_queue_stats(netdev, queue_id, stats)
+ : EOPNOTSUPP);
+ if (retval) {
+ stats->tx_bytes = UINT64_MAX;
+ stats->tx_packets = UINT64_MAX;
+ stats->tx_errors = UINT64_MAX;
+ stats->created = LLONG_MIN;
}
+ return retval;
+}
+
+/* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
+ * its configuration, and the 'aux' specified by the caller. The order of
+ * iteration is unspecified, but (when successful) each queue is visited
+ * exactly once.
+ *
+ * Calling this function may be more efficient than calling netdev_get_queue()
+ * for every queue.
+ *
+ * 'cb' must not modify or free the 'details' argument passed in. It may
+ * delete or modify the queue passed in as its 'queue_id' argument. It may
+ * modify but must not delete any other queue within 'netdev'. 'cb' should not
+ * add new queues because this may cause some queues to be visited twice or not
+ * at all.
+ *
+ * Returns 0 if successful, otherwise a positive errno value. On error, some
+ * configured queues may not have been included in the iteration. */
+int
+netdev_dump_queues(const struct netdev *netdev,
+ netdev_dump_queues_cb *cb, void *aux)
+{
+ const struct netdev_class *class = netdev->netdev_class;
+ return (class->dump_queues
+ ? class->dump_queues(netdev, cb, aux)
+ : EOPNOTSUPP);
}
-/* Initializes 'netdev' as a instance of the netdev_dev.
+/* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
+ * its statistics, and the 'aux' specified by the caller. The order of
+ * iteration is unspecified, but (when successful) each queue is visited
+ * exactly once.
+ *
+ * Calling this function may be more efficient than calling
+ * netdev_get_queue_stats() for every queue.
+ *
+ * 'cb' must not modify or free the statistics passed in.
+ *
+ * Returns 0 if successful, otherwise a positive errno value. On error, some
+ * configured queues may not have been included in the iteration. */
+int
+netdev_dump_queue_stats(const struct netdev *netdev,
+ netdev_dump_queue_stats_cb *cb, void *aux)
+{
+ const struct netdev_class *class = netdev->netdev_class;
+ return (class->dump_queue_stats
+ ? class->dump_queue_stats(netdev, cb, aux)
+ : 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->netdev_class->change_seq(netdev);
+}
+\f
+/* Initializes 'netdev' as a netdev device named 'name' of the specified
+ * 'netdev_class'. This function is ordinarily called from a netdev provider's
+ * 'create' function.
*
- * This function adds 'netdev' to a netdev-owned linked list, so it is very
- * important that 'netdev' only be freed after calling netdev_close(). */
+ * This function adds 'netdev' to a netdev-owned shash, so it is very important
+ * that 'netdev' only be freed after calling netdev_uninit(). */
void
-netdev_init(struct netdev *netdev, struct netdev_dev *netdev_dev)
+netdev_init(struct netdev *netdev, const char *name,
+ const struct netdev_class *netdev_class)
{
+ ovs_assert(!shash_find(&netdev_shash, name));
+
memset(netdev, 0, sizeof *netdev);
- netdev->netdev_dev = netdev_dev;
- list_push_back(&netdev_list, &netdev->node);
+ netdev->netdev_class = netdev_class;
+ netdev->name = xstrdup(name);
+ netdev->node = shash_add(&netdev_shash, name, netdev);
+ list_init(&netdev->saved_flags_list);
}
/* 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
+ * 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_uninit(struct netdev *netdev, bool close)
+netdev_uninit(struct netdev *netdev, bool destroy)
{
- /* 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));
- }
+ char *name = netdev->name;
+
+ ovs_assert(!netdev->ref_cnt);
+ ovs_assert(list_is_empty(&netdev->saved_flags_list));
+
+ shash_delete(&netdev_shash, netdev->node);
- if (close) {
- netdev_get_dev(netdev)->netdev_class->close(netdev);
+ if (destroy) {
+ netdev->netdev_class->destroy(netdev);
}
+ free(name);
}
-
-/* Returns the class type of '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)->netdev_class->type;
+ return netdev->netdev_class->type;
}
-struct netdev_dev *
-netdev_get_dev(const struct netdev *netdev)
+/* Returns the class associated with 'netdev'. */
+const struct netdev_class *
+netdev_get_class(const struct netdev *netdev)
{
- return netdev->netdev_dev;
+ return netdev->netdev_class;
}
-/* Initializes 'notifier' as a netdev notifier for 'netdev', for which
- * notification will consist of calling 'cb', with auxiliary data 'aux'. */
-void
-netdev_notifier_init(struct netdev_notifier *notifier, struct netdev *netdev,
- void (*cb)(struct netdev_notifier *), void *aux)
-{
- notifier->netdev = netdev;
- notifier->cb = cb;
- notifier->aux = aux;
-}
-\f
-/* Tracks changes in the status of a set of network devices. */
-struct netdev_monitor {
- struct shash polled_netdevs;
- struct shash changed_netdevs;
-};
-
-/* Creates and returns a new structure for monitor changes in the status of
- * network devices. */
-struct netdev_monitor *
-netdev_monitor_create(void)
+/* Returns the netdev with 'name' or NULL if there is none.
+ *
+ * The caller must not free the returned value. */
+struct netdev *
+netdev_from_name(const char *name)
{
- struct netdev_monitor *monitor = xmalloc(sizeof *monitor);
- shash_init(&monitor->polled_netdevs);
- shash_init(&monitor->changed_netdevs);
- return monitor;
+ return shash_find_data(&netdev_shash, name);
}
-/* Destroys 'monitor'. */
+/* Fills 'device_list' with devices that match 'netdev_class'.
+ *
+ * The caller is responsible for initializing and destroying 'device_list'
+ * but the contained netdevs must not be freed. */
void
-netdev_monitor_destroy(struct netdev_monitor *monitor)
+netdev_get_devices(const struct netdev_class *netdev_class,
+ struct shash *device_list)
{
- if (monitor) {
- struct shash_node *node;
+ struct shash_node *node;
+ SHASH_FOR_EACH (node, &netdev_shash) {
+ struct netdev *dev = node->data;
- SHASH_FOR_EACH (node, &monitor->polled_netdevs) {
- struct netdev_notifier *notifier = node->data;
- netdev_get_dev(notifier->netdev)->netdev_class->poll_remove(
- notifier);
+ if (dev->netdev_class == netdev_class) {
+ shash_add(device_list, node->name, node->data);
}
-
- shash_destroy(&monitor->polled_netdevs);
- shash_destroy(&monitor->changed_netdevs);
- free(monitor);
}
}
-static void
-netdev_monitor_cb(struct netdev_notifier *notifier)
+const char *
+netdev_get_type_from_name(const char *name)
{
- 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);
- }
+ const struct netdev *dev = netdev_from_name(name);
+ return dev ? netdev_get_type(dev) : NULL;
}
-
-/* Attempts to add 'netdev' as a netdev monitored by 'monitor'. Returns 0 if
- * successful, otherwise a positive errno value.
- *
- * Adding a given 'netdev' to a monitor multiple times is equivalent to adding
- * it once. */
-int
-netdev_monitor_add(struct netdev_monitor *monitor, struct netdev *netdev)
-{
- const char *netdev_name = netdev_get_name(netdev);
- int error = 0;
- if (!shash_find(&monitor->polled_netdevs, netdev_name)
- && netdev_get_dev(netdev)->netdev_class->poll_add)
- {
- struct netdev_notifier *notifier;
- error = netdev_get_dev(netdev)->netdev_class->poll_add(netdev,
- netdev_monitor_cb, monitor, ¬ifier);
- if (!error) {
- assert(notifier->netdev == netdev);
- shash_add(&monitor->polled_netdevs, netdev_name, notifier);
- }
- }
- return error;
-}
-
-/* Removes 'netdev' from the set of netdevs monitored by 'monitor'. (This has
- * no effect if 'netdev' is not in the set of devices monitored by
- * 'monitor'.) */
+\f
void
-netdev_monitor_remove(struct netdev_monitor *monitor, struct netdev *netdev)
+netdev_rx_init(struct netdev_rx *rx, struct netdev *netdev,
+ const struct netdev_rx_class *class)
{
- const char *netdev_name = netdev_get_name(netdev);
- struct shash_node *node;
-
- node = shash_find(&monitor->polled_netdevs, netdev_name);
- if (node) {
- /* Cancel future notifications. */
- struct netdev_notifier *notifier = node->data;
- netdev_get_dev(netdev)->netdev_class->poll_remove(notifier);
- 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);
- }
- }
+ ovs_assert(netdev->ref_cnt > 0);
+ rx->rx_class = class;
+ rx->netdev = netdev;
}
-/* Checks for changes to netdevs in the set monitored by 'monitor'. If any of
- * the attributes (Ethernet address, carrier status, speed or peer-advertised
- * speed, flags, etc.) of a network device monitored by 'monitor' has changed,
- * 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.
- */
-int
-netdev_monitor_poll(struct netdev_monitor *monitor, char **devnamep)
+void
+netdev_rx_uninit(struct netdev_rx *rx OVS_UNUSED)
{
- struct shash_node *node = shash_first(&monitor->changed_netdevs);
- if (!node) {
- *devnamep = NULL;
- return EAGAIN;
- } else {
- *devnamep = xstrdup(node->name);
- shash_delete(&monitor->changed_netdevs, node);
- return 0;
- }
+ /* Nothing to do. */
}
-/* 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)
+struct netdev *
+netdev_rx_get_netdev(const struct netdev_rx *rx)
{
- if (!shash_is_empty(&monitor->changed_netdevs)) {
- poll_immediate_wake();
- } else {
- /* XXX Nothing needed here for netdev_linux, but maybe other netdev
- * classes need help. */
- }
+ ovs_assert(rx->netdev->ref_cnt > 0);
+ return rx->netdev;
}
-\f
-/* Restore the network device flags on 'netdev' to those that were active
- * before we changed them. Returns 0 if successful, otherwise a positive
- * errno value.
- *
- * To avoid reentry, the caller must ensure that fatal signals are blocked. */
-static int
-restore_flags(struct netdev *netdev)
+
+const char *
+netdev_rx_get_name(const struct netdev_rx *rx)
{
- if (netdev->changed_flags) {
- enum netdev_flags restore = netdev->save_flags & netdev->changed_flags;
- enum netdev_flags old_flags;
- return netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
- netdev->changed_flags & ~restore,
- restore, &old_flags);
- }
- return 0;
+ return netdev_get_name(netdev_rx_get_netdev(rx));
}
-/* Close all netdevs on shutdown so they can do any needed cleanup such as
- * destroying devices, restoring flags, etc. */
static void
-close_all_netdevs(void *aux UNUSED)
+restore_all_flags(void *aux OVS_UNUSED)
{
- struct netdev *netdev, *next;
- LIST_FOR_EACH_SAFE(netdev, next, struct netdev, node, &netdev_list) {
- netdev_close(netdev);
+ struct shash_node *node;
+
+ SHASH_FOR_EACH (node, &netdev_shash) {
+ struct netdev *netdev = node->data;
+ const struct netdev_saved_flags *sf;
+ enum netdev_flags saved_values;
+ enum netdev_flags saved_flags;
+
+ saved_values = saved_flags = 0;
+ LIST_FOR_EACH (sf, node, &netdev->saved_flags_list) {
+ saved_flags |= sf->saved_flags;
+ saved_values &= ~sf->saved_flags;
+ saved_values |= sf->saved_flags & sf->saved_values;
+ }
+ if (saved_flags) {
+ enum netdev_flags old_flags;
+
+ netdev->netdev_class->update_flags(netdev,
+ saved_flags & saved_values,
+ saved_flags & ~saved_values,
+ &old_flags);
+ }
}
}