lib/netdev-provider.h

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