lib/netdev-provider.h

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