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