/*
- * 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.
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 named 'name' with initial 'args' in
*
* If this netdev class does not support enumeration, this may be a null
* pointer. */
- int (*enumerate)(struct svec *all_names);
+ int (*enumerate)(struct sset *all_names);
/* Attempts to receive a packet from 'netdev' into the 'size' bytes in
* 'buffer'. If successful, returns the number of bytes in the 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".) */
+ * it would always return -EOPNOTSUPP anyhow. (This will prevent the
+ * network device from being usefully used by the netdev-based "userspace
+ * datapath".) */
int (*recv)(struct netdev *netdev, void *buffer, size_t size);
/* Registers with the poll loop to wake up from the next call to
*
* 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 set '*mtup' to INT_MAX. */
int (*get_mtu)(const struct netdev *netdev, int *mtup);
/* Returns the ifindex of 'netdev', if successful, as a positive number.
*/
int (*get_carrier)(const struct netdev *netdev, bool *carrier);
- /* Sets 'miimon' to true if 'netdev' is up according to its MII. If
- * 'netdev' does not support MII, may fall back to another method or return
- * EOPNOTSUPP.
+ /* 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.
*
- * This function may be set to null if it would always return EOPNOTSUPP.
+ * Most network devices won't support this feature and will set this
+ * function pointer to NULL, which is equivalent to returning EOPNOTSUPP.
*/
- int (*get_miimon)(const struct netdev *netdev, bool *miimon);
+ int (*set_miimon_interval)(struct netdev *netdev, long long int interval);
/* Retrieves current device stats for 'netdev' into 'stats'.
*
* 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.
*
* 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 *);
git://git.onelab.eu / sliver-openvswitch.git / blobdiff