X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fnetdev-provider.h;h=9af0398cff66d9c414e2c648139bcb9bd7ea7b1d;hb=85606e05b691be7c2f2d4bcf0e91170b71ec8fbb;hp=b095779cdac33b1f5e60b11d81f604b12b2d0038;hpb=76c308b50d316a2186283467e12564c0234c7501;p=sliver-openvswitch.git diff --git a/lib/netdev-provider.h b/lib/netdev-provider.h index b095779cd..9af0398cf 100644 --- a/lib/netdev-provider.h +++ b/lib/netdev-provider.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009, 2010, 2011 Nicira Networks. + * Copyright (c) 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. @@ -19,11 +19,10 @@ /* Generic interface to network devices. */ -#include - #include "netdev.h" #include "list.h" #include "shash.h" +#include "smap.h" #ifdef __cplusplus extern "C" { @@ -31,69 +30,32 @@ extern "C" { /* A network device (e.g. an Ethernet device). * - * This structure should be treated as opaque by network device - * implementations. */ -struct netdev_dev { + * Network device implementations should treat this structure as opaque. */ +struct netdev { char *name; /* Name of network device. */ 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 shash args; /* Argument list from last config. */ -}; - -void netdev_dev_init(struct netdev_dev *, const char *name, - const struct shash *args, - const struct netdev_class *); -void netdev_dev_uninit(struct netdev_dev *, bool destroy); -const char *netdev_dev_get_type(const struct netdev_dev *); -const struct netdev_class *netdev_dev_get_class(const struct netdev_dev *); -const char *netdev_dev_get_name(const struct netdev_dev *); -struct netdev_dev *netdev_dev_from_name(const char *name); -void netdev_dev_get_devices(const struct netdev_class *, - struct shash *device_list); - -static inline void netdev_dev_assert_class(const struct netdev_dev *netdev_dev, - const struct netdev_class *class_) -{ - assert(netdev_dev->netdev_class == class_); -} - -/* A instance of an open network device. - * - * This structure should be treated as opaque by network device - * implementations. */ -struct netdev { - struct netdev_dev *netdev_dev; /* Parent netdev_dev. */ - struct list node; /* Element in global list. */ - - enum netdev_flags save_flags; /* Initial device flags. */ - enum netdev_flags changed_flags; /* Flags that we changed. */ + struct list saved_flags_list; /* Contains "struct netdev_saved_flags". */ }; -void netdev_init(struct netdev *, struct netdev_dev *); -void netdev_uninit(struct netdev *, bool close); -struct netdev_dev *netdev_get_dev(const struct netdev *); +void netdev_init(struct netdev *, const char *name, + const struct netdev_class *); +void netdev_uninit(struct netdev *, bool destroy); +const char *netdev_get_type(const struct netdev *); +const struct netdev_class *netdev_get_class(const struct netdev *); +const char *netdev_get_name(const struct netdev *); +struct netdev *netdev_from_name(const char *name); +void netdev_get_devices(const struct netdev_class *, + struct shash *device_list); static inline void netdev_assert_class(const struct netdev *netdev, - const struct netdev_class *netdev_class) + const struct netdev_class *class_) { - netdev_dev_assert_class(netdev_get_dev(netdev), netdev_class); + ovs_assert(netdev->netdev_class == 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. * @@ -121,78 +83,56 @@ struct netdev_class { 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 - * 'netdev_class'. On success sets 'netdev_devp' to the newly created - * device. */ + /* Attempts to create a network device named 'name' in 'netdev_class'. On + * success sets 'netdevp' to the newly created device. */ int (*create)(const struct netdev_class *netdev_class, const char *name, - const struct shash *args, struct netdev_dev **netdev_devp); + struct netdev **netdevp); - /* Destroys 'netdev_dev'. + /* Destroys 'netdev'. * * Netdev devices maintain a reference count that is incremented on - * netdev_open() and decremented on netdev_close(). If 'netdev_dev' + * netdev_open() and decremented on netdev_close(). If 'netdev' * has a non-zero reference count, then this function will not be * called. */ - void (*destroy)(struct netdev_dev *netdev_dev); + void (*destroy)(struct netdev *netdev); - /* Changes the device 'netdev_dev''s configuration to 'args'. + /* Fetches the device 'netdev''s configuration, storing it in 'args'. + * The caller owns 'args' and pre-initializes it to an empty smap. * - * If this netdev class does not support reconfiguring a netdev - * device, this may be a null pointer. - */ - int (*set_config)(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)(const struct netdev *netdev, struct smap *args); - /* Attempts to open a network device. On success, sets 'netdevp' - * to the new network device. + /* Changes the device 'netdev''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); - - /* Closes 'netdev'. */ - void (*close)(struct netdev *netdev); - - /* 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 + * If this netdev class does not support configuration, this may be a null * pointer. */ - int (*enumerate)(struct sset *all_names); + int (*set_config)(struct netdev *netdev, const struct smap *args); - /* 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. + /* Returns the tunnel configuration of 'netdev'. If 'netdev' is + * not a tunnel, returns null. * - * May return -EOPNOTSUPP if a network device does not implement packet + * If this function would always return null, it may be null instead. */ + const struct netdev_tunnel_config * + (*get_tunnel_config)(const struct netdev *netdev); + + /* Attempts to open a netdev_rx for receiving packets from 'netdev'. + * Returns 0 if successful, otherwise a positive errno value. Returns + * 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 + * 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 - * poll_block() when a packet is ready to be received with netdev_recv() on - * 'netdev'. + * datapath".) * - * May be null if not needed, such as for a network device that does not - * implement packet reception through the 'recv' member function. */ - void (*recv_wait)(struct netdev *netdev); - - /* Discards all packets waiting to be received from 'netdev'. - * - * 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); + * On success, the implementation must set '*rxp' to a 'netdev_rx' for + * 'netdev' that it has already initialized (with netdev_rx_init()). */ + int (*rx_open)(struct netdev *netdev, struct netdev_rx **rxp); /* Sends the 'size'-byte packet in 'buffer' on 'netdev'. Returns 0 if * successful, otherwise a positive errno value. Returns EAGAIN without @@ -229,7 +169,10 @@ struct netdev_class { /* Sets 'netdev''s Ethernet address to 'mac' */ int (*set_etheraddr)(struct netdev *netdev, const uint8_t mac[6]); - /* Retrieves 'netdev''s Ethernet address into 'mac'. */ + /* Retrieves 'netdev''s Ethernet address into 'mac'. + * + * This address will be advertised as 'netdev''s MAC address through the + * OpenFlow protocol, among other uses. */ int (*get_etheraddr)(const struct netdev *netdev, uint8_t mac[6]); /* Retrieves 'netdev''s MTU into '*mtup'. @@ -239,9 +182,17 @@ struct netdev_class { * 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. */ + * 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. * @@ -263,13 +214,23 @@ struct netdev_class { */ 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. + /* Returns the number of times 'netdev''s carrier has changed since being + * initialized. * - * This function may be set to null if it would always return EOPNOTSUPP. + * If null, callers will assume the number of carrier resets is zero. */ + long long int (*get_carrier_resets)(const struct netdev *netdev); + + /* 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 (*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'. * @@ -288,31 +249,23 @@ struct netdev_class { /* Stores the features supported by 'netdev' into each of '*current', * '*advertised', '*supported', and '*peer'. Each value is a bitmap of - * "enum ofp_port_features" bits, in host byte order. + * NETDEV_F_* bits. * * This function may be set to null if it would always return EOPNOTSUPP. */ int (*get_features)(const struct netdev *netdev, - uint32_t *current, uint32_t *advertised, - uint32_t *supported, uint32_t *peer); + enum netdev_features *current, + enum netdev_features *advertised, + enum netdev_features *supported, + enum netdev_features *peer); /* Set the features advertised by 'netdev' to 'advertise', which is a - * bitmap of "enum ofp_port_features" bits, in host byte order. + * set of NETDEV_F_* bits. * * This function may be set to null for a network device that does not * support configuring advertisements. */ - int (*set_advertisements)(struct netdev *netdev, uint32_t advertise); - - /* 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. - * - * Returns ENOENT if 'netdev' is a network device that is not a - * VLAN device. - * - * This function should be set to null if it doesn't make any sense for - * your network device (it probably doesn't). */ - int (*get_vlan_vid)(const struct netdev *netdev, int *vlan_vid); + int (*set_advertisements)(struct netdev *netdev, + enum netdev_features advertise); /* Attempts to set input rate limiting (policing) policy, such that up to * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative @@ -366,7 +319,7 @@ struct netdev_class { * * May be NULL if 'netdev' does not support QoS at all. */ int (*get_qos)(const struct netdev *netdev, - const char **typep, struct shash *details); + const char **typep, struct smap *details); /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to * 'type' with details of configuration from 'details'. @@ -386,7 +339,7 @@ struct netdev_class { * * May be NULL if 'netdev' does not support QoS at all. */ int (*set_qos)(struct netdev *netdev, - const char *type, const struct shash *details); + const char *type, const struct smap *details); /* Queries 'netdev' for information about the queue numbered 'queue_id'. * If successful, adds that information as string key-value pairs to @@ -405,7 +358,7 @@ struct netdev_class { * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */ int (*get_queue)(const struct netdev *netdev, - unsigned int queue_id, struct shash *details); + unsigned int queue_id, struct smap *details); /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value * string pairs in 'details'. The contents of 'details' should be @@ -425,7 +378,7 @@ struct netdev_class { * * May be NULL if 'netdev' does not support QoS at all. */ int (*set_queue)(struct netdev *netdev, - unsigned int queue_id, const struct shash *details); + unsigned int queue_id, const struct smap *details); /* Attempts to delete the queue numbered 'queue_id' from 'netdev'. * @@ -452,10 +405,15 @@ struct netdev_class { * of iteration is unspecified, but (when successful) each queue is visited * exactly once. * - * 'cb' will not modify or free the 'details' argument passed in. */ + * 'cb' will 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 will not delete any other queue within 'netdev'. If 'cb' + * adds new queues, then ->dump_queues is allowed to visit some queues + * twice or not at all. + */ int (*dump_queues)(const struct netdev *netdev, void (*cb)(unsigned int queue_id, - const struct shash *details, + const struct smap *details, void *aux), void *aux); @@ -512,7 +470,7 @@ struct netdev_class { * anyhow. */ int (*add_router)(struct netdev *netdev, struct in_addr router); - /* Looks up the next hop for 'host'. If succesful, stores the next hop + /* Looks up the next hop for 'host'. If successful, stores the next hop * gateway's address (0 if 'host' is on a directly connected network) in * '*next_hop' and a copy of the name of the device to reach 'host' in * '*netdev_name', and returns 0. The caller is responsible for freeing @@ -523,19 +481,18 @@ struct netdev_class { int (*get_next_hop)(const struct in_addr *host, struct in_addr *next_hop, char **netdev_name); - /* Retrieves the status of the device. + /* Retrieves driver information 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 + * Populates 'smap' with key-value pairs representing the status of the + * device. 'smap' 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. + * The caller is responsible for destroying 'smap' and its data. * * This function may be set to null if it would always return EOPNOTSUPP * anyhow. */ - int (*get_status)(const struct netdev *netdev, struct shash *sh); + int (*get_status)(const struct netdev *netdev, struct smap *smap); /* Looks up the ARP table entry for 'ip' on 'netdev' and stores the * corresponding MAC address in 'mac'. A return value of ENXIO, in @@ -544,31 +501,73 @@ struct netdev_class { * * 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 - * flags that are set to 1 in 'on'. (No bit will be set to 1 in both 'off' - * and 'on'; that is, off & on == 0.) + /* 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 flags + * that are set to 1 in 'on'. (No bit will be set to 1 in both 'off' and + * 'on'; that is, off & on == 0.) * * This function may be invoked from a signal handler. Therefore, it * should not do anything that is not signal-safe (such as logging). */ 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); +}; + +/* A data structure for capturing packets received by a network device. + * + * This structure should be treated as opaque by network device + * implementations. */ +struct netdev_rx { + const struct netdev_rx_class *rx_class; + struct netdev *netdev; +}; + +void netdev_rx_init(struct netdev_rx *, struct netdev *, + const struct netdev_rx_class *); +void netdev_rx_uninit(struct netdev_rx *); +struct netdev *netdev_rx_get_netdev(const struct netdev_rx *); + +struct netdev_rx_class { + /* Destroys 'rx'. */ + void (*destroy)(struct netdev_rx *rx); + + /* Attempts to receive a packet from 'rx' 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. + * + * Must return -EMSGSIZE, and discard the packet, if the received packet + * is longer than 'size' bytes. */ + int (*recv)(struct netdev_rx *rx, void *buffer, size_t size); + + /* 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_rx_recv() + * on 'rx'. */ + void (*wait)(struct netdev_rx *rx); + + /* Discards all packets waiting to be received from 'rx'. */ + int (*drain)(struct netdev_rx *rx); }; +static inline void netdev_rx_assert_class(const struct netdev_rx *rx, + const struct netdev_rx_class *class_) +{ + ovs_assert(rx->rx_class == class_); +} + 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); @@ -576,6 +575,12 @@ 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; +#if defined(__FreeBSD__) || defined(__NetBSD__) +extern const struct netdev_class netdev_bsd_class; +#endif + +extern const struct netdev_class netdev_tunnel_class; +extern const struct netdev_class netdev_pltap_class; #ifdef __cplusplus }