lib/netdev-provider.h

   1 /*
   2  * Copyright (c) 2009, 2010 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef NETDEV_PROVIDER_H
  18 #define NETDEV_PROVIDER_H 1
  19
  20 /* Generic interface to network devices. */
  21
  22 #include <assert.h>
  23
  24 #include "netdev.h"
  25 #include "list.h"
  26 #include "shash.h"
  27
  28 #ifdef  __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 struct arg {
  33     char *key;
  34     char *value;
  35 };
  36
  37 /* A network device (e.g. an Ethernet device).
  38  *
  39  * This structure should be treated as opaque by network device
  40  * implementations. */
  41 struct netdev_dev {
  42     char *name;                         /* Name of network device. */
  43     const struct netdev_class *netdev_class; /* Functions to control
  44                                                 this device. */
  45     int ref_cnt;                        /* Times this devices was opened. */
  46     struct shash_node *node;            /* Pointer to element in global map. */
  47     struct arg *args;                   /* Argument list from last config. */
  48     int n_args;                         /* Number of arguments in 'args'. */
  49 };
  50
  51 void netdev_dev_init(struct netdev_dev *, const char *name,
  52                      const struct netdev_class *);
  53 void netdev_dev_uninit(struct netdev_dev *, bool destroy);
  54 const char *netdev_dev_get_type(const struct netdev_dev *);
  55 const char *netdev_dev_get_name(const struct netdev_dev *);
  56 struct netdev_dev *netdev_dev_from_name(const char *name);
  57 void netdev_dev_get_devices(const struct netdev_class *,
  58                             struct shash *device_list);
  59
  60 static inline void netdev_dev_assert_class(const struct netdev_dev *netdev_dev,
  61                                            const struct netdev_class *class_)
  62 {
  63     assert(netdev_dev->netdev_class == class_);
  64 }
  65
  66 /* A instance of an open network device.
  67  *
  68  * This structure should be treated as opaque by network device
  69  * implementations. */
  70 struct netdev {
  71     struct netdev_dev *netdev_dev;   /* Parent netdev_dev. */
  72     struct list node;                /* Element in global list. */
  73
  74     enum netdev_flags save_flags;    /* Initial device flags. */
  75     enum netdev_flags changed_flags; /* Flags that we changed. */
  76 };
  77
  78 void netdev_init(struct netdev *, struct netdev_dev *);
  79 void netdev_uninit(struct netdev *, bool close);
  80 struct netdev_dev *netdev_get_dev(const struct netdev *);
  81
  82 static inline void netdev_assert_class(const struct netdev *netdev,
  83                                        const struct netdev_class *netdev_class)
  84 {
  85     netdev_dev_assert_class(netdev_get_dev(netdev), netdev_class);
  86 }
  87
  88 /* A network device notifier.
  89  *
  90  * Network device implementations should use netdev_notifier_init() to
  91  * initialize this structure, but they may freely read its members after
  92  * initialization. */
  93 struct netdev_notifier {
  94     struct netdev *netdev;
  95     void (*cb)(struct netdev_notifier *);
  96     void *aux;
  97 };
  98 void netdev_notifier_init(struct netdev_notifier *, struct netdev *,
  99                           void (*cb)(struct netdev_notifier *), void *aux);
 100
 101 /* Network device class structure, to be defined by each implementation of a
 102  * network device.
 103  *
 104  * These functions return 0 if successful or a positive errno value on failure,
 105  * except where otherwise noted. */
 106 struct netdev_class {
 107     /* Type of netdevs in this class, e.g. "system", "tap", "gre", etc.
 108      *
 109      * One of the providers should supply a "system" type, since this is
 110      * the type assumed if no type is specified when opening a netdev.
 111      * The "system" type corresponds to an existing network device on
 112      * the system. */
 113     const char *type;
 114
 115     /* Called when the netdev provider is registered, typically at program
 116      * startup.  Returning an error from this function will prevent any network
 117      * device in this class from being opened.
 118      *
 119      * This function may be set to null if a network device class needs no
 120      * initialization at registration time. */
 121     int (*init)(void);
 122
 123     /* Performs periodic work needed by netdevs of this class.  May be null if
 124      * no periodic work is necessary. */
 125     void (*run)(void);
 126
 127     /* Arranges for poll_block() to wake up if the "run" member function needs
 128      * to be called.  May be null if nothing is needed here. */
 129     void (*wait)(void);
 130
 131     /* Attempts to create a network device of 'type' with 'name'.
 132      * 'type' corresponds to the 'type' field used in the netdev_class
 133      * structure. On success sets 'netdev_devp' to the newly created device. */
 134     int (*create)(const char *name, const char *type, const struct shash *args,
 135                   struct netdev_dev **netdev_devp);
 136
 137     /* Destroys 'netdev_dev'.
 138      *
 139      * Netdev devices maintain a reference count that is incremented on
 140      * netdev_open() and decremented on netdev_close().  If 'netdev_dev'
 141      * has a non-zero reference count, then this function will not be
 142      * called. */
 143     void (*destroy)(struct netdev_dev *netdev_dev);
 144
 145     /* Reconfigures the device 'netdev_dev' with 'args'.
 146      *
 147      * If this netdev class does not support reconfiguring a netdev
 148      * device, this may be a null pointer.
 149      */
 150     int (*reconfigure)(struct netdev_dev *netdev_dev, const struct shash *args);
 151
 152     /* Attempts to open a network device.  On success, sets 'netdevp'
 153      * to the new network device.
 154      *
 155      * 'ethertype' may be a 16-bit Ethernet protocol value in host byte order
 156      * to capture frames of that type received on the device.  It may also be
 157      * one of the 'enum netdev_pseudo_ethertype' values to receive frames in
 158      * one of those categories. */
 159     int (*open)(struct netdev_dev *netdev_dev, int ethertype,
 160                 struct netdev **netdevp);
 161
 162     /* Closes 'netdev'. */
 163     void (*close)(struct netdev *netdev);
 164
 165     /* Enumerates the names of all network devices of this class.
 166      *
 167      * The caller has already initialized 'all_names' and might already have
 168      * added some names to it.  This function should not disturb any existing
 169      * names in 'all_names'.
 170      *
 171      * If this netdev class does not support enumeration, this may be a null
 172      * pointer. */
 173     int (*enumerate)(struct svec *all_names);
 174
 175     /* Attempts to receive a packet from 'netdev' into the 'size' bytes in
 176      * 'buffer'.  If successful, returns the number of bytes in the received
 177      * packet, otherwise a negative errno value.  Returns -EAGAIN immediately
 178      * if no packet is ready to be received. */
 179     int (*recv)(struct netdev *netdev, void *buffer, size_t size);
 180
 181     /* Registers with the poll loop to wake up from the next call to
 182      * poll_block() when a packet is ready to be received with netdev_recv() on
 183      * 'netdev'. */
 184     void (*recv_wait)(struct netdev *netdev);
 185
 186     /* Discards all packets waiting to be received from 'netdev'. */
 187     int (*drain)(struct netdev *netdev);
 188
 189     /* Sends the 'size'-byte packet in 'buffer' on 'netdev'.  Returns 0 if
 190      * successful, otherwise a positive errno value.  Returns EAGAIN without
 191      * blocking if the packet cannot be queued immediately.  Returns EMSGSIZE
 192      * if a partial packet was transmitted or if the packet is too big or too
 193      * small to transmit on the device.
 194      *
 195      * The caller retains ownership of 'buffer' in all cases.
 196      *
 197      * The network device is expected to maintain a packet transmission queue,
 198      * so that the caller does not ordinarily have to do additional queuing of
 199      * packets. */
 200     int (*send)(struct netdev *netdev, const void *buffer, size_t size);
 201
 202     /* Registers with the poll loop to wake up from the next call to
 203      * poll_block() when the packet transmission queue for 'netdev' has
 204      * sufficient room to transmit a packet with netdev_send().
 205      *
 206      * The network device is expected to maintain a packet transmission queue,
 207      * so that the caller does not ordinarily have to do additional queuing of
 208      * packets.  Thus, this function is unlikely to ever be useful. */
 209     void (*send_wait)(struct netdev *netdev);
 210
 211     /* Sets 'netdev''s Ethernet address to 'mac' */
 212     int (*set_etheraddr)(struct netdev *netdev, const uint8_t mac[6]);
 213
 214     /* Retrieves 'netdev''s Ethernet address into 'mac'. */
 215     int (*get_etheraddr)(const struct netdev *netdev, uint8_t mac[6]);
 216
 217     /* Retrieves 'netdev''s MTU into '*mtup'.
 218      *
 219      * The MTU is the maximum size of transmitted (and received) packets, in
 220      * bytes, not including the hardware header; thus, this is typically 1500
 221      * bytes for Ethernet devices.*/
 222     int (*get_mtu)(const struct netdev *netdev, int *mtup);
 223
 224     /* Returns the ifindex of 'netdev', if successful, as a positive number.
 225      * On failure, returns a negative errno value.
 226      *
 227      * The desired semantics of the ifindex value are a combination of those
 228      * specified by POSIX for if_nametoindex() and by SNMP for ifIndex.  An
 229      * ifindex value should be unique within a host and remain stable at least
 230      * until reboot.  SNMP says an ifindex "ranges between 1 and the value of
 231      * ifNumber" but many systems do not follow this rule anyhow. */
 232     int (*get_ifindex)(const struct netdev *netdev);
 233
 234     /* Sets 'carrier' to true if carrier is active (link light is on) on
 235      * 'netdev'. */
 236     int (*get_carrier)(const struct netdev *netdev, bool *carrier);
 237
 238     /* Retrieves current device stats for 'netdev' into 'stats'.
 239      *
 240      * A network device that supports some statistics but not others, it should
 241      * set the values of the unsupported statistics to all-1-bits
 242      * (UINT64_MAX). */
 243     int (*get_stats)(const struct netdev *netdev, struct netdev_stats *);
 244
 245     /* Stores the features supported by 'netdev' into each of '*current',
 246      * '*advertised', '*supported', and '*peer'.  Each value is a bitmap of
 247      * "enum ofp_port_features" bits, in host byte order. */
 248     int (*get_features)(struct netdev *netdev,
 249                         uint32_t *current, uint32_t *advertised,
 250                         uint32_t *supported, uint32_t *peer);
 251
 252     /* Set the features advertised by 'netdev' to 'advertise', which is a
 253      * bitmap of "enum ofp_port_features" bits, in host byte order.
 254      *
 255      * This function may be set to null for a network device that does not
 256      * support configuring advertisements. */
 257     int (*set_advertisements)(struct netdev *netdev, uint32_t advertise);
 258
 259     /* If 'netdev' is a VLAN network device (e.g. one created with vconfig(8)),
 260      * sets '*vlan_vid' to the VLAN VID associated with that device and returns
 261      * 0.
 262      *
 263      * Returns ENOENT if 'netdev' is a network device that is not a
 264      * VLAN device.
 265      *
 266      * This function should be set to null if it doesn't make any sense for
 267      * your network device (it probably doesn't). */
 268     int (*get_vlan_vid)(const struct netdev *netdev, int *vlan_vid);
 269
 270     /* Attempts to set input rate limiting (policing) policy, such that up to
 271      * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative
 272      * burst size of 'kbits' kb.
 273      *
 274      * This function may be set to null if policing is not supported. */
 275     int (*set_policing)(struct netdev *netdev, unsigned int kbits_rate,
 276                         unsigned int kbits_burst);
 277
 278     /* If 'netdev' has an assigned IPv4 address, sets '*address' to that
 279      * address and '*netmask' to the associated netmask.
 280      *
 281      * The following error values have well-defined meanings:
 282      *
 283      *   - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
 284      *
 285      *   - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
 286      *
 287      * This function may be set to null if it would always return EOPNOTSUPP
 288      * anyhow. */
 289     int (*get_in4)(const struct netdev *netdev, struct in_addr *address,
 290                    struct in_addr *netmask);
 291
 292     /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask.  If
 293      * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared.
 294      *
 295      * This function may be set to null if it would always return EOPNOTSUPP
 296      * anyhow. */
 297     int (*set_in4)(struct netdev *netdev, struct in_addr addr,
 298                    struct in_addr mask);
 299
 300     /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address.
 301      *
 302      * The following error values have well-defined meanings:
 303      *
 304      *   - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
 305      *
 306      *   - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
 307      *
 308      * This function may be set to null if it would always return EOPNOTSUPP
 309      * anyhow. */
 310     int (*get_in6)(const struct netdev *netdev, struct in6_addr *in6);
 311
 312     /* Adds 'router' as a default IP gateway for the TCP/IP stack that
 313      * corresponds to 'netdev'.
 314      *
 315      * This function may be set to null if it would always return EOPNOTSUPP
 316      * anyhow. */
 317     int (*add_router)(struct netdev *netdev, struct in_addr router);
 318
 319     /* Looks up the next hop for 'host'.  If succesful, stores the next hop
 320      * gateway's address (0 if 'host' is on a directly connected network) in
 321      * '*next_hop' and a copy of the name of the device to reach 'host' in
 322      * '*netdev_name', and returns 0.  The caller is responsible for freeing
 323      * '*netdev_name' (by calling free()).
 324      *
 325      * This function may be set to null if it would always return EOPNOTSUPP
 326      * anyhow. */
 327     int (*get_next_hop)(const struct in_addr *host, struct in_addr *next_hop,
 328                         char **netdev_name);
 329
 330     /* Looks up the ARP table entry for 'ip' on 'netdev' and stores the
 331      * corresponding MAC address in 'mac'.  A return value of ENXIO, in
 332      * particular, indicates that there is no ARP table entry for 'ip' on
 333      * 'netdev'.
 334      *
 335      * This function may be set to null if it would always return EOPNOTSUPP
 336      * anyhow. */
 337     int (*arp_lookup)(const struct netdev *netdev, uint32_t ip, uint8_t mac[6]);
 338
 339     /* Retrieves the current set of flags on 'netdev' into '*old_flags'.
 340      * Then, turns off the flags that are set to 1 in 'off' and turns on the
 341      * flags that are set to 1 in 'on'.  (No bit will be set to 1 in both 'off'
 342      * and 'on'; that is, off & on == 0.)
 343      *
 344      * This function may be invoked from a signal handler.  Therefore, it
 345      * should not do anything that is not signal-safe (such as logging). */
 346     int (*update_flags)(struct netdev *netdev, enum netdev_flags off,
 347                         enum netdev_flags on, enum netdev_flags *old_flags);
 348
 349     /* Arranges for 'cb' to be called whenever one of the attributes of
 350      * 'netdev' changes and sets '*notifierp' to a newly created
 351      * netdev_notifier that represents this arrangement.  The created notifier
 352      * will have its 'netdev', 'cb', and 'aux' members set to the values of the
 353      * corresponding parameters. */
 354     int (*poll_add)(struct netdev *netdev,
 355                     void (*cb)(struct netdev_notifier *notifier), void *aux,
 356                     struct netdev_notifier **notifierp);
 357
 358     /* Cancels poll notification for 'notifier'. */
 359     void (*poll_remove)(struct netdev_notifier *notifier);
 360 };
 361
 362 extern const struct netdev_class netdev_linux_class;
 363 extern const struct netdev_class netdev_tap_class;
 364 extern const struct netdev_class netdev_gre_class;
 365
 366 #ifdef  __cplusplus
 367 }
 368 #endif
 369
 370 #endif /* netdev.h */