X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fnetdev-provider.h;h=3382a3913c8786dde518f439f5fbb023b9193fc9;hb=8d71683b7632b5b621dd21418bf33ff90865b4e0;hp=921c3974e67e324cba0f13a23df14c7424fb7bed;hpb=65c3058c22803c7e8d8fd0bfbb84fe27456fb137;p=sliver-openvswitch.git diff --git a/lib/netdev-provider.h b/lib/netdev-provider.h index 921c3974e..3382a3913 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,52 +30,30 @@ 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 list saved_flags_list; /* Contains "struct netdev_saved_flags". */ }; -void netdev_dev_init(struct netdev_dev *, const char *name, - 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. */ -}; - -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_); } /* Network device class structure, to be defined by each implementation of a @@ -113,86 +90,50 @@ struct netdev_class { void (*wait)(void); /* Attempts to create a network device named 'name' in 'netdev_class'. On - * success sets 'netdev_devp' to the newly created device. */ + * success sets 'netdevp' to the newly created device. */ int (*create)(const struct netdev_class *netdev_class, const char *name, - 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); - /* Fetches the device 'netdev_dev''s configuration, storing it in 'args'. - * The caller owns 'args' and pre-initializes it to an empty shash. + /* 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 have any configuration options, this may * be a null pointer. */ - int (*get_config)(struct netdev_dev *netdev_dev, struct shash *args); + int (*get_config)(const struct netdev *netdev, struct smap *args); - /* Changes the device 'netdev_dev''s configuration to 'args'. + /* Changes the device 'netdev''s configuration to 'args'. * * 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); + int (*set_config)(struct netdev *netdev, const struct smap *args); - /* Closes 'netdev'. */ - void (*close)(struct netdev *netdev); - -/* ## ----------------- ## */ -/* ## 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.) */ + /* Returns the tunnel configuration of 'netdev'. If 'netdev' is + * not a tunnel, returns null. + * + * 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 set up 'netdev' for receiving packets with ->recv(). - * Returns 0 if successful, otherwise a positive errno value. Return + /* 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 * 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. - * - * 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 - * 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); + * 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); - /* 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); - /* 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 @@ -228,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'. @@ -305,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 @@ -383,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'. @@ -403,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 @@ -422,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 @@ -442,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'. * @@ -469,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); @@ -540,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 @@ -564,10 +504,10 @@ struct netdev_class { 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). */ @@ -585,6 +525,48 @@ struct netdev_class { * 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); @@ -593,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; +#ifdef __FreeBSD__ +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 }