X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fnetdev-provider.h;h=22b00f72866cf00a6198271bf0b295d376a95b51;hb=14622f22abd93ca464c9be1b6b58d6f0fb2bb186;hp=038f277f4fc79a8ee3c3df2f878c12568d3cdee3;hpb=ea83a2fcd0d31246ece7bdea4c54e162f432e81c;p=sliver-openvswitch.git diff --git a/lib/netdev-provider.h b/lib/netdev-provider.h index 038f277f4..22b00f728 100644 --- a/lib/netdev-provider.h +++ b/lib/netdev-provider.h @@ -1,5 +1,5 @@ /* - * 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. @@ -29,11 +29,6 @@ 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 @@ -44,8 +39,6 @@ struct netdev_dev { 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, @@ -86,19 +79,6 @@ static inline void netdev_assert_class(const struct netdev *netdev, 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. * @@ -126,14 +106,16 @@ 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 'netdev_devp' 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_dev **netdev_devp); /* Destroys 'netdev_dev'. * @@ -143,22 +125,22 @@ struct netdev_class { * 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); @@ -171,19 +153,40 @@ struct netdev_class { * * 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); + +/* ## ----------------- ## */ +/* ## 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.) */ + + /* 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 @@ -199,7 +202,7 @@ struct netdev_class { * 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 @@ -214,10 +217,10 @@ struct netdev_class { * * 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 @@ -242,9 +245,20 @@ struct netdev_class { * * 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. * @@ -266,6 +280,18 @@ struct netdev_class { */ 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 @@ -287,7 +313,7 @@ struct netdev_class { * * 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); @@ -326,11 +352,11 @@ struct netdev_class { * 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. @@ -518,16 +544,19 @@ struct netdev_class { int (*get_next_hop)(const struct in_addr *host, struct in_addr *next_hop, char **netdev_name); - /* Looks up the name of the interface out of which traffic will egress if - * 'netdev' is a tunnel. If unsuccessful, or 'netdev' is not a tunnel, - * will return null. This function does not necessarily return the - * physical interface out which traffic will egress. Instead it returns - * the interface which is assigned 'netdev's remote_ip. This may be an - * internal interface such as a bridge port. + /* 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 'netdev' is not a tunnel or it is - * not supported. */ - const char *(*get_tnl_iface)(const struct netdev *netdev); + * 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 @@ -536,7 +565,8 @@ 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 @@ -548,17 +578,16 @@ struct netdev_class { 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 *);