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     int (*open)(struct netdev_dev *netdev_dev, struct netdev **netdevp);
 152
 153     /* Closes 'netdev'. */
 154     void (*close)(struct netdev *netdev);
 155
 156     /* Enumerates the names of all network devices of this class.
 157      *
 158      * The caller has already initialized 'all_names' and might already have
 159      * added some names to it.  This function should not disturb any existing
 160      * names in 'all_names'.
 161      *
 162      * If this netdev class does not support enumeration, this may be a null
 163      * pointer. */
 164     int (*enumerate)(struct sset *all_names);
 165 \f
 166 /* ## ----------------- ## */
 167 /* ## Receiving Packets ## */
 168 /* ## ----------------- ## */
 169
 170 /* The network provider interface is mostly used for inspecting and configuring
 171  * device "metadata", not for sending and receiving packets directly.  It may
 172  * be impractical to implement these functions on some operating systems and
 173  * hardware.  These functions may all be NULL in such cases.
 174  *
 175  * (However, the "dpif-netdev" implementation, which is the easiest way to
 176  * integrate Open vSwitch with a new operating system or hardware, does require
 177  * the ability to receive packets.) */
 178
 179     /* Attempts to set up 'netdev' for receiving packets with ->recv().
 180      * Returns 0 if successful, otherwise a positive errno value.  Return
 181      * EOPNOTSUPP to indicate that the network device does not implement packet
 182      * reception through this interface.  This function may be set to null if
 183      * it would always return EOPNOTSUPP anyhow.  (This will prevent the
 184      * network device from being usefully used by the netdev-based "userspace
 185      * datapath".)*/
 186     int (*listen)(struct netdev *netdev);
 187
 188     /* Attempts to receive a packet from 'netdev' into the 'size' bytes in
 189      * 'buffer'.  If successful, returns the number of bytes in the received
 190      * packet, otherwise a negative errno value.  Returns -EAGAIN immediately
 191      * if no packet is ready to be received.
 192      *
 193      * This function can only be expected to return a packet if ->listen() has
 194      * been called successfully.
 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 (*recv)(struct netdev *netdev, void *buffer, size_t size);
 199
 200     /* Registers with the poll loop to wake up from the next call to
 201      * poll_block() when a packet is ready to be received with netdev_recv() on
 202      * 'netdev'.
 203      *
 204      * May be null if not needed, such as for a network device that does not
 205      * implement packet reception through the 'recv' member function. */
 206     void (*recv_wait)(struct netdev *netdev);
 207
 208     /* Discards all packets waiting to be received from 'netdev'.
 209      *
 210      * May be null if not needed, such as for a network device that does not
 211      * implement packet reception through the 'recv' member function. */
 212     int (*drain)(struct netdev *netdev);
 213 \f
 214     /* Sends the 'size'-byte packet in 'buffer' on 'netdev'.  Returns 0 if
 215      * successful, otherwise a positive errno value.  Returns EAGAIN without
 216      * blocking if the packet cannot be queued immediately.  Returns EMSGSIZE
 217      * if a partial packet was transmitted or if the packet is too big or too
 218      * small to transmit on the device.
 219      *
 220      * The caller retains ownership of 'buffer' in all cases.
 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.
 225      *
 226      * May return EOPNOTSUPP if a network device does not implement packet
 227      * transmission through this interface.  This function may be set to null
 228      * if it would always return EOPNOTSUPP anyhow.  (This will prevent the
 229      * network device from being usefully used by the netdev-based "userspace
 230      * datapath".  It will also prevent the OVS implementation of bonding from
 231      * working properly over 'netdev'.) */
 232     int (*send)(struct netdev *netdev, const void *buffer, size_t size);
 233
 234     /* Registers with the poll loop to wake up from the next call to
 235      * poll_block() when the packet transmission queue for 'netdev' has
 236      * sufficient room to transmit a packet with netdev_send().
 237      *
 238      * The network device is expected to maintain a packet transmission queue,
 239      * so that the caller does not ordinarily have to do additional queuing of
 240      * packets.  Thus, this function is unlikely to ever be useful.
 241      *
 242      * May be null if not needed, such as for a network device that does not
 243      * implement packet transmission through the 'send' member function. */
 244     void (*send_wait)(struct netdev *netdev);
 245
 246     /* Sets 'netdev''s Ethernet address to 'mac' */
 247     int (*set_etheraddr)(struct netdev *netdev, const uint8_t mac[6]);
 248
 249     /* Retrieves 'netdev''s Ethernet address into 'mac'. */
 250     int (*get_etheraddr)(const struct netdev *netdev, uint8_t mac[6]);
 251
 252     /* Retrieves 'netdev''s MTU into '*mtup'.
 253      *
 254      * The MTU is the maximum size of transmitted (and received) packets, in
 255      * bytes, not including the hardware header; thus, this is typically 1500
 256      * bytes for Ethernet devices.
 257      *
 258      * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then
 259      * this function should set '*mtup' to INT_MAX. */
 260     int (*get_mtu)(const struct netdev *netdev, int *mtup);
 261
 262     /* Returns the ifindex of 'netdev', if successful, as a positive number.
 263      * On failure, returns a negative errno value.
 264      *
 265      * The desired semantics of the ifindex value are a combination of those
 266      * specified by POSIX for if_nametoindex() and by SNMP for ifIndex.  An
 267      * ifindex value should be unique within a host and remain stable at least
 268      * until reboot.  SNMP says an ifindex "ranges between 1 and the value of
 269      * ifNumber" but many systems do not follow this rule anyhow.
 270      *
 271      * This function may be set to null if it would always return -EOPNOTSUPP.
 272      */
 273     int (*get_ifindex)(const struct netdev *netdev);
 274
 275     /* Sets 'carrier' to true if carrier is active (link light is on) on
 276      * 'netdev'.
 277      *
 278      * May be null if device does not provide carrier status (will be always
 279      * up as long as device is up).
 280      */
 281     int (*get_carrier)(const struct netdev *netdev, bool *carrier);
 282
 283     /* Forces ->get_carrier() to poll 'netdev''s MII registers for link status
 284      * instead of checking 'netdev''s carrier.  'netdev''s MII registers will
 285      * be polled once ever 'interval' milliseconds.  If 'netdev' does not
 286      * support MII, another method may be used as a fallback.  If 'interval' is
 287      * less than or equal to zero, reverts ->get_carrier() to its normal
 288      * behavior.
 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     int (*set_miimon_interval)(struct netdev *netdev, long long int interval);
 294
 295     /* Retrieves current device stats for 'netdev' into 'stats'.
 296      *
 297      * A network device that supports some statistics but not others, it should
 298      * set the values of the unsupported statistics to all-1-bits
 299      * (UINT64_MAX). */
 300     int (*get_stats)(const struct netdev *netdev, struct netdev_stats *);
 301
 302     /* Sets the device stats for 'netdev' to 'stats'.
 303      *
 304      * Most network devices won't support this feature and will set this
 305      * function pointer to NULL, which is equivalent to returning EOPNOTSUPP.
 306      *
 307      * Some network devices might only allow setting their stats to 0. */
 308     int (*set_stats)(struct netdev *netdev, const struct netdev_stats *);
 309
 310     /* Stores the features supported by 'netdev' into each of '*current',
 311      * '*advertised', '*supported', and '*peer'.  Each value is a bitmap of
 312      * "enum ofp_port_features" bits, in host byte order.
 313      *
 314      * This function may be set to null if it would always return EOPNOTSUPP.
 315      */
 316     int (*get_features)(const struct netdev *netdev,
 317                         uint32_t *current, uint32_t *advertised,
 318                         uint32_t *supported, uint32_t *peer);
 319
 320     /* Set the features advertised by 'netdev' to 'advertise', which is a
 321      * bitmap of "enum ofp_port_features" bits, in host byte order.
 322      *
 323      * This function may be set to null for a network device that does not
 324      * support configuring advertisements. */
 325     int (*set_advertisements)(struct netdev *netdev, uint32_t advertise);
 326
 327     /* If 'netdev' is a VLAN network device (e.g. one created with vconfig(8)),
 328      * sets '*vlan_vid' to the VLAN VID associated with that device and returns
 329      * 0.
 330      *
 331      * Returns ENOENT if 'netdev' is a network device that is not a
 332      * VLAN device.
 333      *
 334      * This function should be set to null if it doesn't make any sense for
 335      * your network device (it probably doesn't). */
 336     int (*get_vlan_vid)(const struct netdev *netdev, int *vlan_vid);
 337
 338     /* Attempts to set input rate limiting (policing) policy, such that up to
 339      * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative
 340      * burst size of 'kbits' kb.
 341      *
 342      * This function may be set to null if policing is not supported. */
 343     int (*set_policing)(struct netdev *netdev, unsigned int kbits_rate,
 344                         unsigned int kbits_burst);
 345
 346     /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves
 347      * it empty if 'netdev' does not support QoS.  Any names added to 'types'
 348      * should be documented as valid for the "type" column in the "QoS" table
 349      * in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
 350      *
 351      * Every network device must support disabling QoS with a type of "", but
 352      * this function must not add "" to 'types'.
 353      *
 354      * The caller is responsible for initializing 'types' (e.g. with
 355      * sset_init()) before calling this function.  The caller retains ownership
 356      * of 'types'.
 357      *
 358      * May be NULL if 'netdev' does not support QoS at all. */
 359     int (*get_qos_types)(const struct netdev *netdev, struct sset *types);
 360
 361     /* Queries 'netdev' for its capabilities regarding the specified 'type' of
 362      * QoS.  On success, initializes 'caps' with the QoS capabilities.
 363      *
 364      * Should return EOPNOTSUPP if 'netdev' does not support 'type'.  May be
 365      * NULL if 'netdev' does not support QoS at all. */
 366     int (*get_qos_capabilities)(const struct netdev *netdev,
 367                                 const char *type,
 368                                 struct netdev_qos_capabilities *caps);
 369
 370     /* Queries 'netdev' about its currently configured form of QoS.  If
 371      * successful, stores the name of the current form of QoS into '*typep'
 372      * and any details of configuration as string key-value pairs in
 373      * 'details'.
 374      *
 375      * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
 376      *
 377      * The caller initializes 'details' before calling this function.  The
 378      * caller takes ownership of the string key-values pairs added to
 379      * 'details'.
 380      *
 381      * The netdev retains ownership of '*typep'.
 382      *
 383      * '*typep' will be one of the types returned by netdev_get_qos_types() for
 384      * 'netdev'.  The contents of 'details' should be documented as valid for
 385      * '*typep' in the "other_config" column in the "QoS" table in
 386      * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
 387      *
 388      * May be NULL if 'netdev' does not support QoS at all. */
 389     int (*get_qos)(const struct netdev *netdev,
 390                    const char **typep, struct shash *details);
 391
 392     /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to
 393      * 'type' with details of configuration from 'details'.
 394      *
 395      * On error, the previous QoS configuration is retained.
 396      *
 397      * When this function changes the type of QoS (not just 'details'), this
 398      * also resets all queue configuration for 'netdev' to their defaults
 399      * (which depend on the specific type of QoS).  Otherwise, the queue
 400      * configuration for 'netdev' is unchanged.
 401      *
 402      * 'type' should be "" (to disable QoS) or one of the types returned by
 403      * netdev_get_qos_types() for 'netdev'.  The contents of 'details' should
 404      * be documented as valid for the given 'type' in the "other_config" column
 405      * in the "QoS" table in vswitchd/vswitch.xml (which is built as
 406      * ovs-vswitchd.conf.db(8)).
 407      *
 408      * May be NULL if 'netdev' does not support QoS at all. */
 409     int (*set_qos)(struct netdev *netdev,
 410                    const char *type, const struct shash *details);
 411
 412     /* Queries 'netdev' for information about the queue numbered 'queue_id'.
 413      * If successful, adds that information as string key-value pairs to
 414      * 'details'.  Returns 0 if successful, otherwise a positive errno value.
 415      *
 416      * Should return EINVAL if 'queue_id' is greater than or equal to the
 417      * number of supported queues (as reported in the 'n_queues' member of
 418      * struct netdev_qos_capabilities by 'get_qos_capabilities').
 419      *
 420      * The caller initializes 'details' before calling this function.  The
 421      * caller takes ownership of the string key-values pairs added to
 422      * 'details'.
 423      *
 424      * The returned contents of 'details' should be documented as valid for the
 425      * given 'type' in the "other_config" column in the "Queue" table in
 426      * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
 427      */
 428     int (*get_queue)(const struct netdev *netdev,
 429                      unsigned int queue_id, struct shash *details);
 430
 431     /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
 432      * string pairs in 'details'.  The contents of 'details' should be
 433      * documented as valid for the given 'type' in the "other_config" column in
 434      * the "Queue" table in vswitchd/vswitch.xml (which is built as
 435      * ovs-vswitchd.conf.db(8)).  Returns 0 if successful, otherwise a positive
 436      * errno value.  On failure, the given queue's configuration should be
 437      * unmodified.
 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'), or if
 442      * 'details' is invalid for the type of queue.
 443      *
 444      * This function does not modify 'details', and the caller retains
 445      * ownership of it.
 446      *
 447      * May be NULL if 'netdev' does not support QoS at all. */
 448     int (*set_queue)(struct netdev *netdev,
 449                      unsigned int queue_id, const struct shash *details);
 450
 451     /* Attempts to delete the queue numbered 'queue_id' from 'netdev'.
 452      *
 453      * Should return EINVAL if 'queue_id' is greater than or equal to the
 454      * number of supported queues (as reported in the 'n_queues' member of
 455      * struct netdev_qos_capabilities by 'get_qos_capabilities').  Should
 456      * return EOPNOTSUPP if 'queue_id' is valid but may not be deleted (e.g. if
 457      * 'netdev' has a fixed set of queues with the current QoS mode).
 458      *
 459      * May be NULL if 'netdev' does not support QoS at all, or if all of its
 460      * QoS modes have fixed sets of queues. */
 461     int (*delete_queue)(struct netdev *netdev, unsigned int queue_id);
 462
 463     /* Obtains statistics about 'queue_id' on 'netdev'.  Fills 'stats' with the
 464      * queue's statistics.  May set individual members of 'stats' to all-1-bits
 465      * if the statistic is unavailable.
 466      *
 467      * May be NULL if 'netdev' does not support QoS at all. */
 468     int (*get_queue_stats)(const struct netdev *netdev, unsigned int queue_id,
 469                            struct netdev_queue_stats *stats);
 470
 471     /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's
 472      * ID, its configuration, and the 'aux' specified by the caller.  The order
 473      * of iteration is unspecified, but (when successful) each queue is visited
 474      * exactly once.
 475      *
 476      * 'cb' will not modify or free the 'details' argument passed in. */
 477     int (*dump_queues)(const struct netdev *netdev,
 478                        void (*cb)(unsigned int queue_id,
 479                                   const struct shash *details,
 480                                   void *aux),
 481                        void *aux);
 482
 483     /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's
 484      * ID, its statistics, and the 'aux' specified by the caller.  The order of
 485      * iteration is unspecified, but (when successful) each queue must be
 486      * visited exactly once.
 487      *
 488      * 'cb' will not modify or free the statistics passed in. */
 489     int (*dump_queue_stats)(const struct netdev *netdev,
 490                             void (*cb)(unsigned int queue_id,
 491                                        struct netdev_queue_stats *,
 492                                        void *aux),
 493                             void *aux);
 494
 495     /* If 'netdev' has an assigned IPv4 address, sets '*address' to that
 496      * address and '*netmask' to the associated netmask.
 497      *
 498      * The following error values have well-defined meanings:
 499      *
 500      *   - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
 501      *
 502      *   - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
 503      *
 504      * This function may be set to null if it would always return EOPNOTSUPP
 505      * anyhow. */
 506     int (*get_in4)(const struct netdev *netdev, struct in_addr *address,
 507                    struct in_addr *netmask);
 508
 509     /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask.  If
 510      * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared.
 511      *
 512      * This function may be set to null if it would always return EOPNOTSUPP
 513      * anyhow. */
 514     int (*set_in4)(struct netdev *netdev, struct in_addr addr,
 515                    struct in_addr mask);
 516
 517     /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address.
 518      *
 519      * The following error values have well-defined meanings:
 520      *
 521      *   - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
 522      *
 523      *   - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
 524      *
 525      * This function may be set to null if it would always return EOPNOTSUPP
 526      * anyhow. */
 527     int (*get_in6)(const struct netdev *netdev, struct in6_addr *in6);
 528
 529     /* Adds 'router' as a default IP gateway for the TCP/IP stack that
 530      * corresponds to 'netdev'.
 531      *
 532      * This function may be set to null if it would always return EOPNOTSUPP
 533      * anyhow. */
 534     int (*add_router)(struct netdev *netdev, struct in_addr router);
 535
 536     /* Looks up the next hop for 'host'.  If succesful, stores the next hop
 537      * gateway's address (0 if 'host' is on a directly connected network) in
 538      * '*next_hop' and a copy of the name of the device to reach 'host' in
 539      * '*netdev_name', and returns 0.  The caller is responsible for freeing
 540      * '*netdev_name' (by calling free()).
 541      *
 542      * This function may be set to null if it would always return EOPNOTSUPP
 543      * anyhow. */
 544     int (*get_next_hop)(const struct in_addr *host, struct in_addr *next_hop,
 545                         char **netdev_name);
 546
 547     /* Retrieves the status of the device.
 548      *
 549      * Populates 'sh' with key-value pairs representing the status of the
 550      * device.  A device's status is a set of key-value string pairs
 551      * representing netdev type specific information.  For more information see
 552      * ovs-vswitchd.conf.db(5).
 553      *
 554      * The data of 'sh' are heap allocated strings which the caller is
 555      * responsible for deallocating.
 556      *
 557      * This function may be set to null if it would always return EOPNOTSUPP
 558      * anyhow. */
 559     int (*get_status)(const struct netdev *netdev, struct shash *sh);
 560
 561     /* Looks up the ARP table entry for 'ip' on 'netdev' and stores the
 562      * corresponding MAC address in 'mac'.  A return value of ENXIO, in
 563      * particular, indicates that there is no ARP table entry for 'ip' on
 564      * 'netdev'.
 565      *
 566      * This function may be set to null if it would always return EOPNOTSUPP
 567      * anyhow. */
 568     int (*arp_lookup)(const struct netdev *netdev, ovs_be32 ip,
 569                       uint8_t mac[6]);
 570
 571     /* Retrieves the current set of flags on 'netdev' into '*old_flags'.
 572      * Then, turns off the flags that are set to 1 in 'off' and turns on the
 573      * flags that are set to 1 in 'on'.  (No bit will be set to 1 in both 'off'
 574      * and 'on'; that is, off & on == 0.)
 575      *
 576      * This function may be invoked from a signal handler.  Therefore, it
 577      * should not do anything that is not signal-safe (such as logging). */
 578     int (*update_flags)(struct netdev *netdev, enum netdev_flags off,
 579                         enum netdev_flags on, enum netdev_flags *old_flags);
 580
 581     /* Returns a sequence number which indicates changes in one of 'netdev''s
 582      * properties.  The returned sequence number must be nonzero so that
 583      * callers have a value which they may use as a reset when tracking
 584      * 'netdev'.
 585      *
 586      * Minimally, the returned sequence number is required to change whenever
 587      * 'netdev''s flags, features, ethernet address, or carrier changes.  The
 588      * returned sequence number is allowed to change even when 'netdev' doesn't
 589      * change, although implementations should try to avoid this. */
 590     unsigned int (*change_seq)(const struct netdev *netdev);
 591 };
 592
 593 int netdev_register_provider(const struct netdev_class *);
 594 int netdev_unregister_provider(const char *type);
 595 const struct netdev_class *netdev_lookup_provider(const char *type);
 596
 597 extern const struct netdev_class netdev_linux_class;
 598 extern const struct netdev_class netdev_internal_class;
 599 extern const struct netdev_class netdev_tap_class;
 600
 601 #ifdef  __cplusplus
 602 }
 603 #endif
 604
 605 #endif /* netdev.h */