/*
- * Copyright (c) 2009, 2010 Nicira Networks.
+ * Copyright (c) 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.
extern "C" {
#endif
-struct arg {
- char *key;
- char *value;
-};
-
/* A network device (e.g. an Ethernet device).
*
* This structure should be treated as opaque by network device
* implementations. */
struct netdev_dev {
char *name; /* Name of network device. */
- const struct netdev_class *netdev_class; /* Functions to control
+ const struct netdev_class *netdev_class; /* Functions to control
this device. */
int ref_cnt; /* Times this devices was opened. */
struct shash_node *node; /* Pointer to element in global map. */
- struct arg *args; /* Argument list from last config. */
- int n_args; /* Number of arguments in 'args'. */
};
void netdev_dev_init(struct netdev_dev *, const char *name,
netdev_dev_assert_class(netdev_get_dev(netdev), netdev_class);
}
-/* A network device notifier.
- *
- * Network device implementations should use netdev_notifier_init() to
- * initialize this structure, but they may freely read its members after
- * initialization. */
-struct netdev_notifier {
- struct netdev *netdev;
- void (*cb)(struct netdev_notifier *);
- void *aux;
-};
-void netdev_notifier_init(struct netdev_notifier *, struct netdev *,
- void (*cb)(struct netdev_notifier *), void *aux);
-
/* Network device class structure, to be defined by each implementation of a
* network device.
*
void (*run)(void);
/* Arranges for poll_block() to wake up if the "run" member function needs
- * to be called. May be null if nothing is needed here. */
+ * to be called. Implementations are additionally required to wake
+ * whenever something changes in any of its netdevs which would cause their
+ * ->change_seq() function to change its result. May be null if nothing is
+ * needed here. */
void (*wait)(void);
- /* Attempts to create a network device of 'type' with 'name'.
- * 'type' corresponds to the 'type' field used in the netdev_class
- * structure. On success sets 'netdev_devp' to the newly created device. */
- int (*create)(const char *name, const char *type, const struct shash *args,
+ /* Attempts to create a network device named 'name' in 'netdev_class'. On
+ * success sets 'netdev_devp' to the newly created device. */
+ int (*create)(const struct netdev_class *netdev_class, const char *name,
struct netdev_dev **netdev_devp);
/* Destroys 'netdev_dev'.
* called. */
void (*destroy)(struct netdev_dev *netdev_dev);
- /* Reconfigures the device 'netdev_dev' with 'args'.
+ /* Fetches the device 'netdev_dev''s configuration, storing it in 'args'.
+ * The caller owns 'args' and pre-initializes it to an empty shash.
*
- * If this netdev class does not support reconfiguring a netdev
- * device, this may be a null pointer.
- */
- int (*reconfigure)(struct netdev_dev *netdev_dev, const struct shash *args);
+ * If this netdev class does not have any configuration options, this may
+ * be a null pointer. */
+ int (*get_config)(struct netdev_dev *netdev_dev, struct shash *args);
- /* Attempts to open a network device. On success, sets 'netdevp'
- * to the new network device.
+ /* Changes the device 'netdev_dev''s configuration to 'args'.
*
- * '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 (*open)(struct netdev_dev *netdev_dev, int ethertype,
- struct netdev **netdevp);
+ * If this netdev class does not support configuration, this may be a null
+ * pointer. */
+ int (*set_config)(struct netdev_dev *netdev_dev, const struct shash *args);
+
+ /* Attempts to open a network device. On success, sets 'netdevp'
+ * to the new network device. */
+ int (*open)(struct netdev_dev *netdev_dev, struct netdev **netdevp);
/* Closes 'netdev'. */
void (*close)(struct netdev *netdev);
+\f
+/* ## ----------------- ## */
+/* ## Receiving Packets ## */
+/* ## ----------------- ## */
+
+/* The network provider interface is mostly used for inspecting and configuring
+ * device "metadata", not for sending and receiving packets directly. It may
+ * be impractical to implement these functions on some operating systems and
+ * hardware. These functions may all be NULL in such cases.
+ *
+ * (However, the "dpif-netdev" implementation, which is the easiest way to
+ * integrate Open vSwitch with a new operating system or hardware, does require
+ * the ability to receive packets.) */
- /* Enumerates the names of all network devices of this class.
- *
- * The caller has already initialized 'all_names' and might already have
- * added some names to it. This function should not disturb any existing
- * names in 'all_names'.
- *
- * If this netdev class does not support enumeration, this may be a null
- * pointer. */
- int (*enumerate)(struct svec *all_names);
+ /* Attempts to set up 'netdev' for receiving packets with ->recv().
+ * Returns 0 if successful, otherwise a positive errno value. Return
+ * EOPNOTSUPP to indicate that the network device does not implement packet
+ * reception through this interface. This function may be set to null if
+ * it would always return EOPNOTSUPP anyhow. (This will prevent the
+ * network device from being usefully used by the netdev-based "userspace
+ * datapath".)*/
+ int (*listen)(struct netdev *netdev);
/* Attempts to receive a packet from 'netdev' into the 'size' bytes in
* 'buffer'. If successful, returns the number of bytes in the received
* packet, otherwise a negative errno value. Returns -EAGAIN immediately
* if no packet is ready to be received.
*
- * May return -EOPNOTSUPP if a network device does not implement packet
- * reception through this interface. This function may be set to null if
- * it would always return -EOPNOTSUPP anyhow. (This will disable the OVS
- * integrated DHCP client and OpenFlow controller discovery, and prevent
- * the network device from being usefully used by the netdev-based
- * "userspace datapath".) */
+ * This function can only be expected to return a packet if ->listen() has
+ * been called successfully.
+ *
+ * May be null if not needed, such as for a network device that does not
+ * implement packet reception through the 'recv' member function. */
int (*recv)(struct netdev *netdev, void *buffer, size_t size);
/* Registers with the poll loop to wake up from the next call to
* May be null if not needed, such as for a network device that does not
* implement packet reception through the 'recv' member function. */
int (*drain)(struct netdev *netdev);
-
+\f
/* Sends the 'size'-byte packet in 'buffer' on 'netdev'. Returns 0 if
* successful, otherwise a positive errno value. Returns EAGAIN without
* blocking if the packet cannot be queued immediately. Returns EMSGSIZE
*
* May return EOPNOTSUPP if a network device does not implement packet
* transmission through this interface. This function may be set to null
- * if it would always return EOPNOTSUPP anyhow. (This will disable the OVS
- * integrated DHCP client and OpenFlow controller discovery, and prevent
- * the network device from being usefully used by the netdev-based
- * "userspace datapath".) */
+ * if it would always return EOPNOTSUPP anyhow. (This will prevent the
+ * network device from being usefully used by the netdev-based "userspace
+ * datapath". It will also prevent the OVS implementation of bonding from
+ * working properly over 'netdev'.) */
int (*send)(struct netdev *netdev, const void *buffer, size_t size);
/* Registers with the poll loop to wake up from the next call to
*
* 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.*/
+ * bytes for Ethernet devices.
+ *
+ * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then
+ * this function should return EOPNOTSUPP. This function may be set to
+ * null if it would always return EOPNOTSUPP. */
int (*get_mtu)(const struct netdev *netdev, int *mtup);
+ /* Sets 'netdev''s MTU to 'mtu'.
+ *
+ * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then
+ * this function should return EOPNOTSUPP. This function may be set to
+ * null if it would always return EOPNOTSUPP. */
+ int (*set_mtu)(const struct netdev *netdev, int mtu);
+
/* Returns the ifindex of 'netdev', if successful, as a positive number.
* On failure, returns a negative errno value.
*
int (*get_ifindex)(const struct netdev *netdev);
/* Sets 'carrier' to true if carrier is active (link light is on) on
- * 'netdev'. */
+ * 'netdev'.
+ *
+ * May be null if device does not provide carrier status (will be always
+ * up as long as device is up).
+ */
int (*get_carrier)(const struct netdev *netdev, bool *carrier);
+ /* Forces ->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 ->get_carrier() to its normal
+ * behavior.
+ *
+ * Most network devices won't support this feature and will set this
+ * function pointer to NULL, which is equivalent to returning EOPNOTSUPP.
+ */
+ int (*set_miimon_interval)(struct netdev *netdev, long long int interval);
+
/* Retrieves current device stats for 'netdev' into 'stats'.
*
* A network device that supports some statistics but not others, it should
*
* This function may be set to null if it would always return EOPNOTSUPP.
*/
- 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);
* this function must not add "" to 'types'.
*
* The caller is responsible for initializing 'types' (e.g. with
- * svec_init()) before calling this function. The caller takes ownership
- * of the strings added to 'types'.
+ * sset_init()) before calling this function. The caller retains ownership
+ * of 'types'.
*
* May be NULL if 'netdev' does not support QoS at all. */
- int (*get_qos_types)(const struct netdev *netdev, struct svec *types);
+ int (*get_qos_types)(const struct netdev *netdev, struct sset *types);
/* Queries 'netdev' for its capabilities regarding the specified 'type' of
* QoS. On success, initializes 'caps' with the QoS capabilities.
int (*get_next_hop)(const struct in_addr *host, struct in_addr *next_hop,
char **netdev_name);
+ /* Retrieves the status of the device.
+ *
+ * Populates 'sh' with key-value pairs representing the status of the
+ * device. A device's status is a set of key-value string pairs
+ * representing netdev type specific information. For more information see
+ * ovs-vswitchd.conf.db(5).
+ *
+ * The data of 'sh' are heap allocated strings which the caller is
+ * responsible for deallocating.
+ *
+ * This function may be set to null if it would always return EOPNOTSUPP
+ * anyhow. */
+ int (*get_status)(const struct netdev *netdev, struct shash *sh);
+
/* Looks up the ARP table entry for 'ip' on 'netdev' and stores the
* corresponding MAC address in 'mac'. A return value of ENXIO, in
* particular, indicates that there is no ARP table entry for 'ip' on
*
* This function may be set to null if it would always return EOPNOTSUPP
* anyhow. */
- int (*arp_lookup)(const struct netdev *netdev, uint32_t ip, uint8_t mac[6]);
+ int (*arp_lookup)(const struct netdev *netdev, ovs_be32 ip,
+ uint8_t mac[6]);
/* Retrieves the current set of flags on 'netdev' into '*old_flags'.
* Then, turns off the flags that are set to 1 in 'off' and turns on the
int (*update_flags)(struct netdev *netdev, enum netdev_flags off,
enum netdev_flags on, enum netdev_flags *old_flags);
- /* Arranges for 'cb' to be called whenever one of the attributes of
- * 'netdev' changes and sets '*notifierp' to a newly created
- * netdev_notifier that represents this arrangement. The created notifier
- * will have its 'netdev', 'cb', and 'aux' members set to the values of the
- * corresponding parameters. */
- int (*poll_add)(struct netdev *netdev,
- void (*cb)(struct netdev_notifier *notifier), void *aux,
- struct netdev_notifier **notifierp);
-
- /* Cancels poll notification for 'notifier'. */
- void (*poll_remove)(struct netdev_notifier *notifier);
+ /* Returns a sequence number which indicates changes in one of 'netdev''s
+ * properties. The returned sequence number must be nonzero so that
+ * callers have a value which they may use as a reset when tracking
+ * 'netdev'.
+ *
+ * Minimally, the returned sequence number is required to change whenever
+ * 'netdev''s flags, features, ethernet address, or carrier changes. The
+ * returned sequence number is allowed to change even when 'netdev' doesn't
+ * change, although implementations should try to avoid this. */
+ unsigned int (*change_seq)(const struct netdev *netdev);
};
+int netdev_register_provider(const struct netdev_class *);
+int netdev_unregister_provider(const char *type);
+const struct netdev_class *netdev_lookup_provider(const char *type);
+
extern const struct netdev_class netdev_linux_class;
+extern const struct netdev_class netdev_internal_class;
extern const struct netdev_class netdev_tap_class;
-extern const struct netdev_class netdev_patch_class;
-extern const struct netdev_class netdev_gre_class;
-extern const struct netdev_class netdev_capwap_class;
#ifdef __cplusplus
}