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 /* A network device (e.g. an Ethernet device).
  33  *
  34  * This structure should be treated as opaque by network device
  35  * implementations. */
  36 struct netdev_dev {
  37     char *name;                         /* Name of network device. */
  38     const struct netdev_class *netdev_class; /* Functions to control
  39                                                 this device. */
  40     int ref_cnt;                        /* Times this devices was opened. */
  41     struct shash_node *node;            /* Pointer to element in global map. */
  42     struct shash args;                  /* Argument list from last config. */
  43 };
  44
  45 void netdev_dev_init(struct netdev_dev *, const char *name,
  46                      const struct netdev_class *);
  47 void netdev_dev_uninit(struct netdev_dev *, bool destroy);
  48 const char *netdev_dev_get_type(const struct netdev_dev *);
  49 const struct netdev_class *netdev_dev_get_class(const struct netdev_dev *);
  50 const char *netdev_dev_get_name(const struct netdev_dev *);
  51 struct netdev_dev *netdev_dev_from_name(const char *name);
  52 void netdev_dev_get_devices(const struct netdev_class *,
  53                             struct shash *device_list);
  54
  55 static inline void netdev_dev_assert_class(const struct netdev_dev *netdev_dev,
  56                                            const struct netdev_class *class_)
  57 {
  58     assert(netdev_dev->netdev_class == class_);
  59 }
  60
  61 /* A instance of an open network device.
  62  *
  63  * This structure should be treated as opaque by network device
  64  * implementations. */
  65 struct netdev {
  66     struct netdev_dev *netdev_dev;   /* Parent netdev_dev. */
  67     struct list node;                /* Element in global list. */
  68
  69     enum netdev_flags save_flags;    /* Initial device flags. */
  70     enum netdev_flags changed_flags; /* Flags that we changed. */
  71 };
  72
  73 void netdev_init(struct netdev *, struct netdev_dev *);
  74 void netdev_uninit(struct netdev *, bool close);
  75 struct netdev_dev *netdev_get_dev(const struct netdev *);
  76
  77 static inline void netdev_assert_class(const struct netdev *netdev,
  78                                        const struct netdev_class *netdev_class)
  79 {
  80     netdev_dev_assert_class(netdev_get_dev(netdev), netdev_class);
  81 }
  82
  83 /* A network device notifier.
  84  *
  85  * Network device implementations should use netdev_notifier_init() to
  86  * initialize this structure, but they may freely read its members after
  87  * initialization. */
  88 struct netdev_notifier {
  89     struct netdev *netdev;
  90     void (*cb)(struct netdev_notifier *);
  91     void *aux;
  92 };
  93 void netdev_notifier_init(struct netdev_notifier *, struct netdev *,
  94                           void (*cb)(struct netdev_notifier *), void *aux);
  95
  96 /* Network device class structure, to be defined by each implementation of a
  97  * network device.
  98  *
  99  * These functions return 0 if successful or a positive errno value on failure,
 100  * except where otherwise noted. */
 101 struct netdev_class {
 102     /* Type of netdevs in this class, e.g. "system", "tap", "gre", etc.
 103      *
 104      * One of the providers should supply a "system" type, since this is
 105      * the type assumed if no type is specified when opening a netdev.
 106      * The "system" type corresponds to an existing network device on
 107      * the system. */
 108     const char *type;
 109
 110     /* Called when the netdev provider is registered, typically at program
 111      * startup.  Returning an error from this function will prevent any network
 112      * device in this class from being opened.
 113      *
 114      * This function may be set to null if a network device class needs no
 115      * initialization at registration time. */
 116     int (*init)(void);
 117
 118     /* Performs periodic work needed by netdevs of this class.  May be null if
 119      * no periodic work is necessary. */
 120     void (*run)(void);
 121
 122     /* Arranges for poll_block() to wake up if the "run" member function needs
 123      * to be called.  May be null if nothing is needed here. */
 124     void (*wait)(void);
 125
 126     /* Attempts to create a network device named 'name' with initial 'args' in
 127      * 'netdev_class'.  On success sets 'netdev_devp' to the newly created
 128      * device. */
 129     int (*create)(const struct netdev_class *netdev_class, const char *name,
 130                   const struct shash *args, struct netdev_dev **netdev_devp);
 131
 132     /* Destroys 'netdev_dev'.
 133      *
 134      * Netdev devices maintain a reference count that is incremented on
 135      * netdev_open() and decremented on netdev_close().  If 'netdev_dev'
 136      * has a non-zero reference count, then this function will not be
 137      * called. */
 138     void (*destroy)(struct netdev_dev *netdev_dev);
 139
 140     /* Reconfigures the device 'netdev_dev' with 'args'.
 141      *
 142      * If this netdev class does not support reconfiguring a netdev
 143      * device, this may be a null pointer.
 144      */
 145     int (*reconfigure)(struct netdev_dev *netdev_dev, const struct shash *args);
 146
 147     /* Attempts to open a network device.  On success, sets 'netdevp'
 148      * to the new network device.
 149      *
 150      * 'ethertype' may be a 16-bit Ethernet protocol value in host byte order
 151      * to capture frames of that type received on the device.  It may also be
 152      * one of the 'enum netdev_pseudo_ethertype' values to receive frames in
 153      * one of those categories. */
 154     int (*open)(struct netdev_dev *netdev_dev, int ethertype,
 155                 struct netdev **netdevp);
 156
 157     /* Closes 'netdev'. */
 158     void (*close)(struct netdev *netdev);
 159
 160     /* Enumerates the names of all network devices of this class.
 161      *
 162      * The caller has already initialized 'all_names' and might already have
 163      * added some names to it.  This function should not disturb any existing
 164      * names in 'all_names'.
 165      *
 166      * If this netdev class does not support enumeration, this may be a null
 167      * pointer. */
 168     int (*enumerate)(struct svec *all_names);
 169
 170     /* Attempts to receive a packet from 'netdev' into the 'size' bytes in
 171      * 'buffer'.  If successful, returns the number of bytes in the received
 172      * packet, otherwise a negative errno value.  Returns -EAGAIN immediately
 173      * if no packet is ready to be received.
 174      *
 175      * May return -EOPNOTSUPP if a network device does not implement packet
 176      * reception through this interface.  This function may be set to null if
 177      * it would always return -EOPNOTSUPP anyhow.  (This will disable the OVS
 178      * integrated DHCP client and OpenFlow controller discovery, and prevent
 179      * the network device from being usefully used by the netdev-based
 180      * "userspace datapath".) */
 181     int (*recv)(struct netdev *netdev, void *buffer, size_t size);
 182
 183     /* Registers with the poll loop to wake up from the next call to
 184      * poll_block() when a packet is ready to be received with netdev_recv() on
 185      * 'netdev'.
 186      *
 187      * May be null if not needed, such as for a network device that does not
 188      * implement packet reception through the 'recv' member function. */
 189     void (*recv_wait)(struct netdev *netdev);
 190
 191     /* Discards all packets waiting to be received from 'netdev'.
 192      *
 193      * May be null if not needed, such as for a network device that does not
 194      * implement packet reception through the 'recv' member function. */
 195     int (*drain)(struct netdev *netdev);
 196
 197     /* Sends the 'size'-byte packet in 'buffer' on 'netdev'.  Returns 0 if
 198      * successful, otherwise a positive errno value.  Returns EAGAIN without
 199      * blocking if the packet cannot be queued immediately.  Returns EMSGSIZE
 200      * if a partial packet was transmitted or if the packet is too big or too
 201      * small to transmit on the device.
 202      *
 203      * The caller retains ownership of 'buffer' in all cases.
 204      *
 205      * The network device is expected to maintain a packet transmission queue,
 206      * so that the caller does not ordinarily have to do additional queuing of
 207      * packets.
 208      *
 209      * May return EOPNOTSUPP if a network device does not implement packet
 210      * transmission through this interface.  This function may be set to null
 211      * if it would always return EOPNOTSUPP anyhow.  (This will disable the OVS
 212      * integrated DHCP client and OpenFlow controller discovery, and prevent
 213      * the network device from being usefully used by the netdev-based
 214      * "userspace datapath".) */
 215     int (*send)(struct netdev *netdev, const void *buffer, size_t size);
 216
 217     /* Registers with the poll loop to wake up from the next call to
 218      * poll_block() when the packet transmission queue for 'netdev' has
 219      * sufficient room to transmit a packet with netdev_send().
 220      *
 221      * The network device is expected to maintain a packet transmission queue,
 222      * so that the caller does not ordinarily have to do additional queuing of
 223      * packets.  Thus, this function is unlikely to ever be useful.
 224      *
 225      * May be null if not needed, such as for a network device that does not
 226      * implement packet transmission through the 'send' member function. */
 227     void (*send_wait)(struct netdev *netdev);
 228
 229     /* Sets 'netdev''s Ethernet address to 'mac' */
 230     int (*set_etheraddr)(struct netdev *netdev, const uint8_t mac[6]);
 231
 232     /* Retrieves 'netdev''s Ethernet address into 'mac'. */
 233     int (*get_etheraddr)(const struct netdev *netdev, uint8_t mac[6]);
 234
 235     /* Retrieves 'netdev''s MTU into '*mtup'.
 236      *
 237      * The MTU is the maximum size of transmitted (and received) packets, in
 238      * bytes, not including the hardware header; thus, this is typically 1500
 239      * bytes for Ethernet devices.*/
 240     int (*get_mtu)(const struct netdev *netdev, int *mtup);
 241
 242     /* Returns the ifindex of 'netdev', if successful, as a positive number.
 243      * On failure, returns a negative errno value.
 244      *
 245      * The desired semantics of the ifindex value are a combination of those
 246      * specified by POSIX for if_nametoindex() and by SNMP for ifIndex.  An
 247      * ifindex value should be unique within a host and remain stable at least
 248      * until reboot.  SNMP says an ifindex "ranges between 1 and the value of
 249      * ifNumber" but many systems do not follow this rule anyhow.
 250      *
 251      * This function may be set to null if it would always return -EOPNOTSUPP.
 252      */
 253     int (*get_ifindex)(const struct netdev *netdev);
 254
 255     /* Sets 'carrier' to true if carrier is active (link light is on) on
 256      * 'netdev'.
 257      *
 258      * May be null if device does not provide carrier status (will be always
 259      * up as long as device is up).
 260      */
 261     int (*get_carrier)(const struct netdev *netdev, bool *carrier);
 262
 263     /* Sets 'miimon' to true if 'netdev' is up according to its MII.  If
 264      * 'netdev' does not support MII, may fall back to another method or return
 265      * EOPNOTSUPP.
 266      *
 267      * This function may be set to null if it would always return EOPNOTSUPP.
 268      */
 269     int (*get_miimon)(const struct netdev *netdev, bool *miimon);
 270
 271     /* Retrieves current device stats for 'netdev' into 'stats'.
 272      *
 273      * A network device that supports some statistics but not others, it should
 274      * set the values of the unsupported statistics to all-1-bits
 275      * (UINT64_MAX). */
 276     int (*get_stats)(const struct netdev *netdev, struct netdev_stats *);
 277
 278     /* Sets the device stats for 'netdev' to 'stats'.
 279      *
 280      * Most network devices won't support this feature and will set this
 281      * function pointer to NULL, which is equivalent to returning EOPNOTSUPP.
 282      *
 283      * Some network devices might only allow setting their stats to 0. */
 284     int (*set_stats)(struct netdev *netdev, const struct netdev_stats *);
 285
 286     /* Stores the features supported by 'netdev' into each of '*current',
 287      * '*advertised', '*supported', and '*peer'.  Each value is a bitmap of
 288      * "enum ofp_port_features" bits, in host byte order.
 289      *
 290      * This function may be set to null if it would always return EOPNOTSUPP.
 291      */
 292     int (*get_features)(const struct netdev *netdev,
 293                         uint32_t *current, uint32_t *advertised,
 294                         uint32_t *supported, uint32_t *peer);
 295
 296     /* Set the features advertised by 'netdev' to 'advertise', which is a
 297      * bitmap of "enum ofp_port_features" bits, in host byte order.
 298      *
 299      * This function may be set to null for a network device that does not
 300      * support configuring advertisements. */
 301     int (*set_advertisements)(struct netdev *netdev, uint32_t advertise);
 302
 303     /* If 'netdev' is a VLAN network device (e.g. one created with vconfig(8)),
 304      * sets '*vlan_vid' to the VLAN VID associated with that device and returns
 305      * 0.
 306      *
 307      * Returns ENOENT if 'netdev' is a network device that is not a
 308      * VLAN device.
 309      *
 310      * This function should be set to null if it doesn't make any sense for
 311      * your network device (it probably doesn't). */
 312     int (*get_vlan_vid)(const struct netdev *netdev, int *vlan_vid);
 313
 314     /* Attempts to set input rate limiting (policing) policy, such that up to
 315      * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative
 316      * burst size of 'kbits' kb.
 317      *
 318      * This function may be set to null if policing is not supported. */
 319     int (*set_policing)(struct netdev *netdev, unsigned int kbits_rate,
 320                         unsigned int kbits_burst);
 321
 322     /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves
 323      * it empty if 'netdev' does not support QoS.  Any names added to 'types'
 324      * should be documented as valid for the "type" column in the "QoS" table
 325      * in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
 326      *
 327      * Every network device must support disabling QoS with a type of "", but
 328      * this function must not add "" to 'types'.
 329      *
 330      * The caller is responsible for initializing 'types' (e.g. with
 331      * svec_init()) before calling this function.  The caller takes ownership
 332      * of the strings added to 'types'.
 333      *
 334      * May be NULL if 'netdev' does not support QoS at all. */
 335     int (*get_qos_types)(const struct netdev *netdev, struct svec *types);
 336
 337     /* Queries 'netdev' for its capabilities regarding the specified 'type' of
 338      * QoS.  On success, initializes 'caps' with the QoS capabilities.
 339      *
 340      * Should return EOPNOTSUPP if 'netdev' does not support 'type'.  May be
 341      * NULL if 'netdev' does not support QoS at all. */
 342     int (*get_qos_capabilities)(const struct netdev *netdev,
 343                                 const char *type,
 344                                 struct netdev_qos_capabilities *caps);
 345
 346     /* Queries 'netdev' about its currently configured form of QoS.  If
 347      * successful, stores the name of the current form of QoS into '*typep'
 348      * and any details of configuration as string key-value pairs in
 349      * 'details'.
 350      *
 351      * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
 352      *
 353      * The caller initializes 'details' before calling this function.  The
 354      * caller takes ownership of the string key-values pairs added to
 355      * 'details'.
 356      *
 357      * The netdev retains ownership of '*typep'.
 358      *
 359      * '*typep' will be one of the types returned by netdev_get_qos_types() for
 360      * 'netdev'.  The contents of 'details' should be documented as valid for
 361      * '*typep' in the "other_config" column in the "QoS" table in
 362      * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
 363      *
 364      * May be NULL if 'netdev' does not support QoS at all. */
 365     int (*get_qos)(const struct netdev *netdev,
 366                    const char **typep, struct shash *details);
 367
 368     /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to
 369      * 'type' with details of configuration from 'details'.
 370      *
 371      * On error, the previous QoS configuration is retained.
 372      *
 373      * When this function changes the type of QoS (not just 'details'), this
 374      * also resets all queue configuration for 'netdev' to their defaults
 375      * (which depend on the specific type of QoS).  Otherwise, the queue
 376      * configuration for 'netdev' is unchanged.
 377      *
 378      * 'type' should be "" (to disable QoS) or one of the types returned by
 379      * netdev_get_qos_types() for 'netdev'.  The contents of 'details' should
 380      * be documented as valid for the given 'type' in the "other_config" column
 381      * in the "QoS" table in vswitchd/vswitch.xml (which is built as
 382      * ovs-vswitchd.conf.db(8)).
 383      *
 384      * May be NULL if 'netdev' does not support QoS at all. */
 385     int (*set_qos)(struct netdev *netdev,
 386                    const char *type, const struct shash *details);
 387
 388     /* Queries 'netdev' for information about the queue numbered 'queue_id'.
 389      * If successful, adds that information as string key-value pairs to
 390      * 'details'.  Returns 0 if successful, otherwise a positive errno value.
 391      *
 392      * Should return EINVAL if 'queue_id' is greater than or equal to the
 393      * number of supported queues (as reported in the 'n_queues' member of
 394      * struct netdev_qos_capabilities by 'get_qos_capabilities').
 395      *
 396      * The caller initializes 'details' before calling this function.  The
 397      * caller takes ownership of the string key-values pairs added to
 398      * 'details'.
 399      *
 400      * The returned contents of 'details' should be documented as valid for the
 401      * given 'type' in the "other_config" column in the "Queue" table in
 402      * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
 403      */
 404     int (*get_queue)(const struct netdev *netdev,
 405                      unsigned int queue_id, struct shash *details);
 406
 407     /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
 408      * string pairs in 'details'.  The contents of 'details' should be
 409      * documented as valid for the given 'type' in the "other_config" column in
 410      * the "Queue" table in vswitchd/vswitch.xml (which is built as
 411      * ovs-vswitchd.conf.db(8)).  Returns 0 if successful, otherwise a positive
 412      * errno value.  On failure, the given queue's configuration should be
 413      * unmodified.
 414      *
 415      * Should return EINVAL if 'queue_id' is greater than or equal to the
 416      * number of supported queues (as reported in the 'n_queues' member of
 417      * struct netdev_qos_capabilities by 'get_qos_capabilities'), or if
 418      * 'details' is invalid for the type of queue.
 419      *
 420      * This function does not modify 'details', and the caller retains
 421      * ownership of it.
 422      *
 423      * May be NULL if 'netdev' does not support QoS at all. */
 424     int (*set_queue)(struct netdev *netdev,
 425                      unsigned int queue_id, const struct shash *details);
 426
 427     /* Attempts to delete the queue numbered 'queue_id' from 'netdev'.
 428      *
 429      * Should return EINVAL if 'queue_id' is greater than or equal to the
 430      * number of supported queues (as reported in the 'n_queues' member of
 431      * struct netdev_qos_capabilities by 'get_qos_capabilities').  Should
 432      * return EOPNOTSUPP if 'queue_id' is valid but may not be deleted (e.g. if
 433      * 'netdev' has a fixed set of queues with the current QoS mode).
 434      *
 435      * May be NULL if 'netdev' does not support QoS at all, or if all of its
 436      * QoS modes have fixed sets of queues. */
 437     int (*delete_queue)(struct netdev *netdev, unsigned int queue_id);
 438
 439     /* Obtains statistics about 'queue_id' on 'netdev'.  Fills 'stats' with the
 440      * queue's statistics.  May set individual members of 'stats' to all-1-bits
 441      * if the statistic is unavailable.
 442      *
 443      * May be NULL if 'netdev' does not support QoS at all. */
 444     int (*get_queue_stats)(const struct netdev *netdev, unsigned int queue_id,
 445                            struct netdev_queue_stats *stats);
 446
 447     /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's
 448      * ID, its configuration, and the 'aux' specified by the caller.  The order
 449      * of iteration is unspecified, but (when successful) each queue is visited
 450      * exactly once.
 451      *
 452      * 'cb' will not modify or free the 'details' argument passed in. */
 453     int (*dump_queues)(const struct netdev *netdev,
 454                        void (*cb)(unsigned int queue_id,
 455                                   const struct shash *details,
 456                                   void *aux),
 457                        void *aux);
 458
 459     /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's
 460      * ID, its statistics, and the 'aux' specified by the caller.  The order of
 461      * iteration is unspecified, but (when successful) each queue must be
 462      * visited exactly once.
 463      *
 464      * 'cb' will not modify or free the statistics passed in. */
 465     int (*dump_queue_stats)(const struct netdev *netdev,
 466                             void (*cb)(unsigned int queue_id,
 467                                        struct netdev_queue_stats *,
 468                                        void *aux),
 469                             void *aux);
 470
 471     /* If 'netdev' has an assigned IPv4 address, sets '*address' to that
 472      * address and '*netmask' to the associated netmask.
 473      *
 474      * The following error values have well-defined meanings:
 475      *
 476      *   - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
 477      *
 478      *   - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
 479      *
 480      * This function may be set to null if it would always return EOPNOTSUPP
 481      * anyhow. */
 482     int (*get_in4)(const struct netdev *netdev, struct in_addr *address,
 483                    struct in_addr *netmask);
 484
 485     /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask.  If
 486      * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared.
 487      *
 488      * This function may be set to null if it would always return EOPNOTSUPP
 489      * anyhow. */
 490     int (*set_in4)(struct netdev *netdev, struct in_addr addr,
 491                    struct in_addr mask);
 492
 493     /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address.
 494      *
 495      * The following error values have well-defined meanings:
 496      *
 497      *   - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
 498      *
 499      *   - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
 500      *
 501      * This function may be set to null if it would always return EOPNOTSUPP
 502      * anyhow. */
 503     int (*get_in6)(const struct netdev *netdev, struct in6_addr *in6);
 504
 505     /* Adds 'router' as a default IP gateway for the TCP/IP stack that
 506      * corresponds to 'netdev'.
 507      *
 508      * This function may be set to null if it would always return EOPNOTSUPP
 509      * anyhow. */
 510     int (*add_router)(struct netdev *netdev, struct in_addr router);
 511
 512     /* Looks up the next hop for 'host'.  If succesful, stores the next hop
 513      * gateway's address (0 if 'host' is on a directly connected network) in
 514      * '*next_hop' and a copy of the name of the device to reach 'host' in
 515      * '*netdev_name', and returns 0.  The caller is responsible for freeing
 516      * '*netdev_name' (by calling free()).
 517      *
 518      * This function may be set to null if it would always return EOPNOTSUPP
 519      * anyhow. */
 520     int (*get_next_hop)(const struct in_addr *host, struct in_addr *next_hop,
 521                         char **netdev_name);
 522
 523     /* Retrieves the status of the device.
 524      *
 525      * Populates 'sh' with key-value pairs representing the status of the
 526      * device.  A device's status is a set of key-value string pairs
 527      * representing netdev type specific information.  For more information see
 528      * ovs-vswitchd.conf.db(5).
 529      *
 530      * The data of 'sh' are heap allocated strings which the caller is
 531      * responsible for deallocating.
 532      *
 533      * This function may be set to null if it would always return EOPNOTSUPP
 534      * anyhow. */
 535     int (*get_status)(const struct netdev *netdev, struct shash *sh);
 536
 537     /* Looks up the ARP table entry for 'ip' on 'netdev' and stores the
 538      * corresponding MAC address in 'mac'.  A return value of ENXIO, in
 539      * particular, indicates that there is no ARP table entry for 'ip' on
 540      * 'netdev'.
 541      *
 542      * This function may be set to null if it would always return EOPNOTSUPP
 543      * anyhow. */
 544     int (*arp_lookup)(const struct netdev *netdev, uint32_t ip, uint8_t mac[6]);
 545
 546     /* Retrieves the current set of flags on 'netdev' into '*old_flags'.
 547      * Then, turns off the flags that are set to 1 in 'off' and turns on the
 548      * flags that are set to 1 in 'on'.  (No bit will be set to 1 in both 'off'
 549      * and 'on'; that is, off & on == 0.)
 550      *
 551      * This function may be invoked from a signal handler.  Therefore, it
 552      * should not do anything that is not signal-safe (such as logging). */
 553     int (*update_flags)(struct netdev *netdev, enum netdev_flags off,
 554                         enum netdev_flags on, enum netdev_flags *old_flags);
 555
 556     /* Arranges for 'cb' to be called whenever one of the attributes of
 557      * 'netdev' changes and sets '*notifierp' to a newly created
 558      * netdev_notifier that represents this arrangement.  The created notifier
 559      * will have its 'netdev', 'cb', and 'aux' members set to the values of the
 560      * corresponding parameters. */
 561     int (*poll_add)(struct netdev *netdev,
 562                     void (*cb)(struct netdev_notifier *notifier), void *aux,
 563                     struct netdev_notifier **notifierp);
 564
 565     /* Cancels poll notification for 'notifier'. */
 566     void (*poll_remove)(struct netdev_notifier *notifier);
 567 };
 568
 569 int netdev_register_provider(const struct netdev_class *);
 570 int netdev_unregister_provider(const char *type);
 571 const struct netdev_class *netdev_lookup_provider(const char *type);
 572
 573 extern const struct netdev_class netdev_linux_class;
 574 extern const struct netdev_class netdev_internal_class;
 575 extern const struct netdev_class netdev_tap_class;
 576
 577 #ifdef  __cplusplus
 578 }
 579 #endif
 580
 581 #endif /* netdev.h */