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