lib/netdev-provider.h

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
   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 "connectivity.h"
  23 #include "netdev.h"
  24 #include "list.h"
  25 #include "ovs-numa.h"
  26 #include "seq.h"
  27 #include "shash.h"
  28 #include "smap.h"
  29
  30 #ifdef  __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 #define NETDEV_NUMA_UNSPEC OVS_NUMA_UNSPEC
  35
  36 /* A network device (e.g. an Ethernet device).
  37  *
  38  * Network device implementations may read these members but should not modify
  39  * them. */
  40 struct netdev {
  41     /* The following do not change during the lifetime of a struct netdev. */
  42     char *name;                         /* Name of network device. */
  43     const struct netdev_class *netdev_class; /* Functions to control
  44                                                 this device. */
  45
  46     /* A sequence number which indicates changes in one of 'netdev''s
  47      * properties.   It must be nonzero so that users have a value which
  48      * they may use as a reset when tracking 'netdev'.
  49      *
  50      * Minimally, the sequence number is required to change whenever
  51      * 'netdev''s flags, features, ethernet address, or carrier changes. */
  52     uint64_t change_seq;
  53
  54     /* The following are protected by 'netdev_mutex' (internal to netdev.c). */
  55     int n_txq;
  56     int n_rxq;
  57     int ref_cnt;                        /* Times this devices was opened. */
  58     struct shash_node *node;            /* Pointer to element in global map. */
  59     struct list saved_flags_list; /* Contains "struct netdev_saved_flags". */
  60 };
  61
  62 static void
  63 netdev_change_seq_changed(const struct netdev *netdev_)
  64 {
  65     struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
  66     seq_change(connectivity_seq_get());
  67     netdev->change_seq++;
  68     if (!netdev->change_seq) {
  69         netdev->change_seq++;
  70     }
  71 }
  72
  73 const char *netdev_get_type(const struct netdev *);
  74 const struct netdev_class *netdev_get_class(const struct netdev *);
  75 const char *netdev_get_name(const struct netdev *);
  76 struct netdev *netdev_from_name(const char *name);
  77 void netdev_get_devices(const struct netdev_class *,
  78                         struct shash *device_list);
  79 struct netdev **netdev_get_vports(size_t *size);
  80
  81 /* A data structure for capturing packets received by a network device.
  82  *
  83  * Network device implementations may read these members but should not modify
  84  * them.
  85  *
  86  * None of these members change during the lifetime of a struct netdev_rxq. */
  87 struct netdev_rxq {
  88     struct netdev *netdev;      /* Owns a reference to the netdev. */
  89     int queue_id;
  90 };
  91
  92 struct netdev *netdev_rxq_get_netdev(const struct netdev_rxq *);
  93
  94 /* Network device class structure, to be defined by each implementation of a
  95  * network device.
  96  *
  97  * These functions return 0 if successful or a positive errno value on failure,
  98  * except where otherwise noted.
  99  *
 100  *
 101  * Data Structures
 102  * ===============
 103  *
 104  * These functions work primarily with two different kinds of data structures:
 105  *
 106  *   - "struct netdev", which represents a network device.
 107  *
 108  *   - "struct netdev_rxq", which represents a handle for capturing packets
 109  *     received on a network device
 110  *
 111  * Each of these data structures contains all of the implementation-independent
 112  * generic state for the respective concept, called the "base" state.  None of
 113  * them contains any extra space for implementations to use.  Instead, each
 114  * implementation is expected to declare its own data structure that contains
 115  * an instance of the generic data structure plus additional
 116  * implementation-specific members, called the "derived" state.  The
 117  * implementation can use casts or (preferably) the CONTAINER_OF macro to
 118  * obtain access to derived state given only a pointer to the embedded generic
 119  * data structure.
 120  *
 121  *
 122  * Life Cycle
 123  * ==========
 124  *
 125  * Four stylized functions accompany each of these data structures:
 126  *
 127  *            "alloc"          "construct"        "destruct"       "dealloc"
 128  *            ------------   ----------------  ---------------  --------------
 129  * netdev      ->alloc        ->construct        ->destruct        ->dealloc
 130  * netdev_rxq  ->rxq_alloc    ->rxq_construct    ->rxq_destruct    ->rxq_dealloc
 131  *
 132  * Any instance of a given data structure goes through the following life
 133  * cycle:
 134  *
 135  *   1. The client calls the "alloc" function to obtain raw memory.  If "alloc"
 136  *      fails, skip all the other steps.
 137  *
 138  *   2. The client initializes all of the data structure's base state.  If this
 139  *      fails, skip to step 7.
 140  *
 141  *   3. The client calls the "construct" function.  The implementation
 142  *      initializes derived state.  It may refer to the already-initialized
 143  *      base state.  If "construct" fails, skip to step 6.
 144  *
 145  *   4. The data structure is now initialized and in use.
 146  *
 147  *   5. When the data structure is no longer needed, the client calls the
 148  *      "destruct" function.  The implementation uninitializes derived state.
 149  *      The base state has not been uninitialized yet, so the implementation
 150  *      may still refer to it.
 151  *
 152  *   6. The client uninitializes all of the data structure's base state.
 153  *
 154  *   7. The client calls the "dealloc" to free the raw memory.  The
 155  *      implementation must not refer to base or derived state in the data
 156  *      structure, because it has already been uninitialized.
 157  *
 158  * If netdev support multi-queue IO then netdev->construct should set initialize
 159  * netdev->n_rxq to number of queues.
 160  *
 161  * Each "alloc" function allocates and returns a new instance of the respective
 162  * data structure.  The "alloc" function is not given any information about the
 163  * use of the new data structure, so it cannot perform much initialization.
 164  * Its purpose is just to ensure that the new data structure has enough room
 165  * for base and derived state.  It may return a null pointer if memory is not
 166  * available, in which case none of the other functions is called.
 167  *
 168  * Each "construct" function initializes derived state in its respective data
 169  * structure.  When "construct" is called, all of the base state has already
 170  * been initialized, so the "construct" function may refer to it.  The
 171  * "construct" function is allowed to fail, in which case the client calls the
 172  * "dealloc" function (but not the "destruct" function).
 173  *
 174  * Each "destruct" function uninitializes and frees derived state in its
 175  * respective data structure.  When "destruct" is called, the base state has
 176  * not yet been uninitialized, so the "destruct" function may refer to it.  The
 177  * "destruct" function is not allowed to fail.
 178  *
 179  * Each "dealloc" function frees raw memory that was allocated by the the
 180  * "alloc" function.  The memory's base and derived members might not have ever
 181  * been initialized (but if "construct" returned successfully, then it has been
 182  * "destruct"ed already).  The "dealloc" function is not allowed to fail.
 183  *
 184  *
 185  * Device Change Notification
 186  * ==========================
 187  *
 188  * Minimally, implementations are required to report changes to netdev flags,
 189  * features, ethernet address or carrier through connectivity_seq. Changes to
 190  * other properties are allowed to cause notification through this interface,
 191  * although implementations should try to avoid this. connectivity_seq_get()
 192  * can be used to acquire a reference to the struct seq. The interface is
 193  * described in detail in seq.h. */
 194 struct netdev_class {
 195     /* Type of netdevs in this class, e.g. "system", "tap", "gre", etc.
 196      *
 197      * One of the providers should supply a "system" type, since this is
 198      * the type assumed if no type is specified when opening a netdev.
 199      * The "system" type corresponds to an existing network device on
 200      * the system. */
 201     const char *type;
 202
 203 /* ## ------------------- ## */
 204 /* ## Top-Level Functions ## */
 205 /* ## ------------------- ## */
 206
 207     /* Called when the netdev provider is registered, typically at program
 208      * startup.  Returning an error from this function will prevent any network
 209      * device in this class from being opened.
 210      *
 211      * This function may be set to null if a network device class needs no
 212      * initialization at registration time. */
 213     int (*init)(void);
 214
 215     /* Performs periodic work needed by netdevs of this class.  May be null if
 216      * no periodic work is necessary. */
 217     void (*run)(void);
 218
 219     /* Arranges for poll_block() to wake up if the "run" member function needs
 220      * to be called.  Implementations are additionally required to wake
 221      * whenever something changes in any of its netdevs which would cause their
 222      * ->change_seq() function to change its result.  May be null if nothing is
 223      * needed here. */
 224     void (*wait)(void);
 225
 226 /* ## ---------------- ## */
 227 /* ## netdev Functions ## */
 228 /* ## ---------------- ## */
 229
 230     /* Life-cycle functions for a netdev.  See the large comment above on
 231      * struct netdev_class. */
 232     struct netdev *(*alloc)(void);
 233     int (*construct)(struct netdev *);
 234     void (*destruct)(struct netdev *);
 235     void (*dealloc)(struct netdev *);
 236
 237     /* Fetches the device 'netdev''s configuration, storing it in 'args'.
 238      * The caller owns 'args' and pre-initializes it to an empty smap.
 239      *
 240      * If this netdev class does not have any configuration options, this may
 241      * be a null pointer. */
 242     int (*get_config)(const struct netdev *netdev, struct smap *args);
 243
 244     /* Changes the device 'netdev''s configuration to 'args'.
 245      *
 246      * If this netdev class does not support configuration, this may be a null
 247      * pointer. */
 248     int (*set_config)(struct netdev *netdev, const struct smap *args);
 249
 250     /* Returns the tunnel configuration of 'netdev'.  If 'netdev' is
 251      * not a tunnel, returns null.
 252      *
 253      * If this function would always return null, it may be null instead. */
 254     const struct netdev_tunnel_config *
 255         (*get_tunnel_config)(const struct netdev *netdev);
 256
 257     /* Returns the id of the numa node the 'netdev' is on.  If there is no
 258      * such info, returns NETDEV_NUMA_UNSPEC. */
 259     int (*get_numa_id)(const struct netdev *netdev);
 260
 261     /* Sends buffers on 'netdev'.
 262      * Returns 0 if successful (for every buffer), otherwise a positive errno
 263      * value.  Returns EAGAIN without blocking if one or more packets cannot be
 264      * queued immediately. Returns EMSGSIZE if a partial packet was transmitted
 265      * or if a packet is too big or too small to transmit on the device.
 266      *
 267      * If the function returns a non-zero value, some of the packets might have
 268      * been sent anyway.
 269      *
 270      * To retain ownership of 'buffers' caller can set may_steal to false.
 271      *
 272      * The network device is expected to maintain one or more packet
 273      * transmission queues, so that the caller does not ordinarily have to
 274      * do additional queuing of packets.  'qid' specifies the queue to use
 275      * and can be ignored if the implementation does not support multiple
 276      * queues.
 277      *
 278      * May return EOPNOTSUPP if a network device does not implement packet
 279      * transmission through this interface.  This function may be set to null
 280      * if it would always return EOPNOTSUPP anyhow.  (This will prevent the
 281      * network device from being usefully used by the netdev-based "userspace
 282      * datapath".  It will also prevent the OVS implementation of bonding from
 283      * working properly over 'netdev'.) */
 284     int (*send)(struct netdev *netdev, int qid, struct dpif_packet **buffers,
 285                 int cnt, bool may_steal);
 286
 287     /* Registers with the poll loop to wake up from the next call to
 288      * poll_block() when the packet transmission queue for 'netdev' has
 289      * sufficient room to transmit a packet with netdev_send().
 290      *
 291      * The network device is expected to maintain one or more packet
 292      * transmission queues, so that the caller does not ordinarily have to
 293      * do additional queuing of packets.  'qid' specifies the queue to use
 294      * and can be ignored if the implementation does not support multiple
 295      * queues.
 296      *
 297      * May be null if not needed, such as for a network device that does not
 298      * implement packet transmission through the 'send' member function. */
 299     void (*send_wait)(struct netdev *netdev, int qid);
 300
 301     /* Sets 'netdev''s Ethernet address to 'mac' */
 302     int (*set_etheraddr)(struct netdev *netdev, const uint8_t mac[6]);
 303
 304     /* Retrieves 'netdev''s Ethernet address into 'mac'.
 305      *
 306      * This address will be advertised as 'netdev''s MAC address through the
 307      * OpenFlow protocol, among other uses. */
 308     int (*get_etheraddr)(const struct netdev *netdev, uint8_t mac[6]);
 309
 310     /* Retrieves 'netdev''s MTU into '*mtup'.
 311      *
 312      * The MTU is the maximum size of transmitted (and received) packets, in
 313      * bytes, not including the hardware header; thus, this is typically 1500
 314      * bytes for Ethernet devices.
 315      *
 316      * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then
 317      * this function should return EOPNOTSUPP.  This function may be set to
 318      * null if it would always return EOPNOTSUPP. */
 319     int (*get_mtu)(const struct netdev *netdev, int *mtup);
 320
 321     /* Sets 'netdev''s MTU to 'mtu'.
 322      *
 323      * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then
 324      * this function should return EOPNOTSUPP.  This function may be set to
 325      * null if it would always return EOPNOTSUPP. */
 326     int (*set_mtu)(const struct netdev *netdev, int mtu);
 327
 328     /* Returns the ifindex of 'netdev', if successful, as a positive number.
 329      * On failure, returns a negative errno value.
 330      *
 331      * The desired semantics of the ifindex value are a combination of those
 332      * specified by POSIX for if_nametoindex() and by SNMP for ifIndex.  An
 333      * ifindex value should be unique within a host and remain stable at least
 334      * until reboot.  SNMP says an ifindex "ranges between 1 and the value of
 335      * ifNumber" but many systems do not follow this rule anyhow.
 336      *
 337      * This function may be set to null if it would always return -EOPNOTSUPP.
 338      */
 339     int (*get_ifindex)(const struct netdev *netdev);
 340
 341     /* Sets 'carrier' to true if carrier is active (link light is on) on
 342      * 'netdev'.
 343      *
 344      * May be null if device does not provide carrier status (will be always
 345      * up as long as device is up).
 346      */
 347     int (*get_carrier)(const struct netdev *netdev, bool *carrier);
 348
 349     /* Returns the number of times 'netdev''s carrier has changed since being
 350      * initialized.
 351      *
 352      * If null, callers will assume the number of carrier resets is zero. */
 353     long long int (*get_carrier_resets)(const struct netdev *netdev);
 354
 355     /* Forces ->get_carrier() to poll 'netdev''s MII registers for link status
 356      * instead of checking 'netdev''s carrier.  'netdev''s MII registers will
 357      * be polled once ever 'interval' milliseconds.  If 'netdev' does not
 358      * support MII, another method may be used as a fallback.  If 'interval' is
 359      * less than or equal to zero, reverts ->get_carrier() to its normal
 360      * behavior.
 361      *
 362      * Most network devices won't support this feature and will set this
 363      * function pointer to NULL, which is equivalent to returning EOPNOTSUPP.
 364      */
 365     int (*set_miimon_interval)(struct netdev *netdev, long long int interval);
 366
 367     /* Retrieves current device stats for 'netdev' into 'stats'.
 368      *
 369      * A network device that supports some statistics but not others, it should
 370      * set the values of the unsupported statistics to all-1-bits
 371      * (UINT64_MAX). */
 372     int (*get_stats)(const struct netdev *netdev, struct netdev_stats *);
 373
 374     /* Sets the device stats for 'netdev' to 'stats'.
 375      *
 376      * Most network devices won't support this feature and will set this
 377      * function pointer to NULL, which is equivalent to returning EOPNOTSUPP.
 378      *
 379      * Some network devices might only allow setting their stats to 0. */
 380     int (*set_stats)(struct netdev *netdev, const struct netdev_stats *);
 381
 382     /* Stores the features supported by 'netdev' into each of '*current',
 383      * '*advertised', '*supported', and '*peer'.  Each value is a bitmap of
 384      * NETDEV_F_* bits.
 385      *
 386      * This function may be set to null if it would always return EOPNOTSUPP.
 387      */
 388     int (*get_features)(const struct netdev *netdev,
 389                         enum netdev_features *current,
 390                         enum netdev_features *advertised,
 391                         enum netdev_features *supported,
 392                         enum netdev_features *peer);
 393
 394     /* Set the features advertised by 'netdev' to 'advertise', which is a
 395      * set of NETDEV_F_* bits.
 396      *
 397      * This function may be set to null for a network device that does not
 398      * support configuring advertisements. */
 399     int (*set_advertisements)(struct netdev *netdev,
 400                               enum netdev_features advertise);
 401
 402     /* Attempts to set input rate limiting (policing) policy, such that up to
 403      * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative
 404      * burst size of 'kbits' kb.
 405      *
 406      * This function may be set to null if policing is not supported. */
 407     int (*set_policing)(struct netdev *netdev, unsigned int kbits_rate,
 408                         unsigned int kbits_burst);
 409
 410     /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves
 411      * it empty if 'netdev' does not support QoS.  Any names added to 'types'
 412      * should be documented as valid for the "type" column in the "QoS" table
 413      * in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
 414      *
 415      * Every network device must support disabling QoS with a type of "", but
 416      * this function must not add "" to 'types'.
 417      *
 418      * The caller is responsible for initializing 'types' (e.g. with
 419      * sset_init()) before calling this function.  The caller retains ownership
 420      * of 'types'.
 421      *
 422      * May be NULL if 'netdev' does not support QoS at all. */
 423     int (*get_qos_types)(const struct netdev *netdev, struct sset *types);
 424
 425     /* Queries 'netdev' for its capabilities regarding the specified 'type' of
 426      * QoS.  On success, initializes 'caps' with the QoS capabilities.
 427      *
 428      * Should return EOPNOTSUPP if 'netdev' does not support 'type'.  May be
 429      * NULL if 'netdev' does not support QoS at all. */
 430     int (*get_qos_capabilities)(const struct netdev *netdev,
 431                                 const char *type,
 432                                 struct netdev_qos_capabilities *caps);
 433
 434     /* Queries 'netdev' about its currently configured form of QoS.  If
 435      * successful, stores the name of the current form of QoS into '*typep'
 436      * and any details of configuration as string key-value pairs in
 437      * 'details'.
 438      *
 439      * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
 440      *
 441      * The caller initializes 'details' before calling this function.  The
 442      * caller takes ownership of the string key-values pairs added to
 443      * 'details'.
 444      *
 445      * The netdev retains ownership of '*typep'.
 446      *
 447      * '*typep' will be one of the types returned by netdev_get_qos_types() for
 448      * 'netdev'.  The contents of 'details' should be documented as valid for
 449      * '*typep' in the "other_config" column in the "QoS" table in
 450      * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
 451      *
 452      * May be NULL if 'netdev' does not support QoS at all. */
 453     int (*get_qos)(const struct netdev *netdev,
 454                    const char **typep, struct smap *details);
 455
 456     /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to
 457      * 'type' with details of configuration from 'details'.
 458      *
 459      * On error, the previous QoS configuration is retained.
 460      *
 461      * When this function changes the type of QoS (not just 'details'), this
 462      * also resets all queue configuration for 'netdev' to their defaults
 463      * (which depend on the specific type of QoS).  Otherwise, the queue
 464      * configuration for 'netdev' is unchanged.
 465      *
 466      * 'type' should be "" (to disable QoS) or one of the types returned by
 467      * netdev_get_qos_types() for 'netdev'.  The contents of 'details' should
 468      * be documented as valid for the given 'type' in the "other_config" column
 469      * in the "QoS" table in vswitchd/vswitch.xml (which is built as
 470      * ovs-vswitchd.conf.db(8)).
 471      *
 472      * May be NULL if 'netdev' does not support QoS at all. */
 473     int (*set_qos)(struct netdev *netdev,
 474                    const char *type, const struct smap *details);
 475
 476     /* Queries 'netdev' for information about the queue numbered 'queue_id'.
 477      * If successful, adds that information as string key-value pairs to
 478      * 'details'.  Returns 0 if successful, otherwise a positive errno value.
 479      *
 480      * Should return EINVAL if 'queue_id' is greater than or equal to the
 481      * number of supported queues (as reported in the 'n_queues' member of
 482      * struct netdev_qos_capabilities by 'get_qos_capabilities').
 483      *
 484      * The caller initializes 'details' before calling this function.  The
 485      * caller takes ownership of the string key-values pairs added to
 486      * 'details'.
 487      *
 488      * The returned contents of 'details' should be documented as valid for the
 489      * given 'type' in the "other_config" column in the "Queue" table in
 490      * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
 491      */
 492     int (*get_queue)(const struct netdev *netdev,
 493                      unsigned int queue_id, struct smap *details);
 494
 495     /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
 496      * string pairs in 'details'.  The contents of 'details' should be
 497      * documented as valid for the given 'type' in the "other_config" column in
 498      * the "Queue" table in vswitchd/vswitch.xml (which is built as
 499      * ovs-vswitchd.conf.db(8)).  Returns 0 if successful, otherwise a positive
 500      * errno value.  On failure, the given queue's configuration should be
 501      * unmodified.
 502      *
 503      * Should return EINVAL if 'queue_id' is greater than or equal to the
 504      * number of supported queues (as reported in the 'n_queues' member of
 505      * struct netdev_qos_capabilities by 'get_qos_capabilities'), or if
 506      * 'details' is invalid for the type of queue.
 507      *
 508      * This function does not modify 'details', and the caller retains
 509      * ownership of it.
 510      *
 511      * May be NULL if 'netdev' does not support QoS at all. */
 512     int (*set_queue)(struct netdev *netdev,
 513                      unsigned int queue_id, const struct smap *details);
 514
 515     /* Attempts to delete the queue numbered 'queue_id' from 'netdev'.
 516      *
 517      * Should return EINVAL if 'queue_id' is greater than or equal to the
 518      * number of supported queues (as reported in the 'n_queues' member of
 519      * struct netdev_qos_capabilities by 'get_qos_capabilities').  Should
 520      * return EOPNOTSUPP if 'queue_id' is valid but may not be deleted (e.g. if
 521      * 'netdev' has a fixed set of queues with the current QoS mode).
 522      *
 523      * May be NULL if 'netdev' does not support QoS at all, or if all of its
 524      * QoS modes have fixed sets of queues. */
 525     int (*delete_queue)(struct netdev *netdev, unsigned int queue_id);
 526
 527     /* Obtains statistics about 'queue_id' on 'netdev'.  Fills 'stats' with the
 528      * queue's statistics.  May set individual members of 'stats' to all-1-bits
 529      * if the statistic is unavailable.
 530      *
 531      * May be NULL if 'netdev' does not support QoS at all. */
 532     int (*get_queue_stats)(const struct netdev *netdev, unsigned int queue_id,
 533                            struct netdev_queue_stats *stats);
 534
 535     /* Attempts to begin dumping the queues in 'netdev'.  On success, returns 0
 536      * and initializes '*statep' with any data needed for iteration.  On
 537      * failure, returns a positive errno value.
 538      *
 539      * May be NULL if 'netdev' does not support QoS at all. */
 540     int (*queue_dump_start)(const struct netdev *netdev, void **statep);
 541
 542     /* Attempts to retrieve another queue from 'netdev' for 'state', which was
 543      * initialized by a successful call to the 'queue_dump_start' function for
 544      * 'netdev'.  On success, stores a queue ID into '*queue_id' and fills
 545      * 'details' with the configuration of the queue with that ID.  Returns EOF
 546      * if the last queue has been dumped, or a positive errno value on error.
 547      * This function will not be called again once it returns nonzero once for
 548      * a given iteration (but the 'queue_dump_done' function will be called
 549      * afterward).
 550      *
 551      * The caller initializes and clears 'details' before calling this
 552      * function.  The caller takes ownership of the string key-values pairs
 553      * added to 'details'.
 554      *
 555      * The returned contents of 'details' should be documented as valid for the
 556      * given 'type' in the "other_config" column in the "Queue" table in
 557      * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
 558      *
 559      * May be NULL if 'netdev' does not support QoS at all. */
 560     int (*queue_dump_next)(const struct netdev *netdev, void *state,
 561                            unsigned int *queue_id, struct smap *details);
 562
 563     /* Releases resources from 'netdev' for 'state', which was initialized by a
 564      * successful call to the 'queue_dump_start' function for 'netdev'.
 565      *
 566      * May be NULL if 'netdev' does not support QoS at all. */
 567     int (*queue_dump_done)(const struct netdev *netdev, void *state);
 568
 569     /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's
 570      * ID, its statistics, and the 'aux' specified by the caller.  The order of
 571      * iteration is unspecified, but (when successful) each queue must be
 572      * visited exactly once.
 573      *
 574      * 'cb' will not modify or free the statistics passed in. */
 575     int (*dump_queue_stats)(const struct netdev *netdev,
 576                             void (*cb)(unsigned int queue_id,
 577                                        struct netdev_queue_stats *,
 578                                        void *aux),
 579                             void *aux);
 580
 581     /* If 'netdev' has an assigned IPv4 address, sets '*address' to that
 582      * address and '*netmask' to the associated netmask.
 583      *
 584      * The following error values have well-defined meanings:
 585      *
 586      *   - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
 587      *
 588      *   - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
 589      *
 590      * This function may be set to null if it would always return EOPNOTSUPP
 591      * anyhow. */
 592     int (*get_in4)(const struct netdev *netdev, struct in_addr *address,
 593                    struct in_addr *netmask);
 594
 595     /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask.  If
 596      * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared.
 597      *
 598      * This function may be set to null if it would always return EOPNOTSUPP
 599      * anyhow. */
 600     int (*set_in4)(struct netdev *netdev, struct in_addr addr,
 601                    struct in_addr mask);
 602
 603     /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address.
 604      *
 605      * The following error values have well-defined meanings:
 606      *
 607      *   - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
 608      *
 609      *   - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
 610      *
 611      * This function may be set to null if it would always return EOPNOTSUPP
 612      * anyhow. */
 613     int (*get_in6)(const struct netdev *netdev, struct in6_addr *in6);
 614
 615     /* Adds 'router' as a default IP gateway for the TCP/IP stack that
 616      * corresponds to 'netdev'.
 617      *
 618      * This function may be set to null if it would always return EOPNOTSUPP
 619      * anyhow. */
 620     int (*add_router)(struct netdev *netdev, struct in_addr router);
 621
 622     /* Looks up the next hop for 'host' in the host's routing table.  If
 623      * successful, stores the next hop gateway's address (0 if 'host' is on a
 624      * directly connected network) in '*next_hop' and a copy of the name of the
 625      * device to reach 'host' in '*netdev_name', and returns 0.  The caller is
 626      * responsible for freeing '*netdev_name' (by calling free()).
 627      *
 628      * This function may be set to null if it would always return EOPNOTSUPP
 629      * anyhow. */
 630     int (*get_next_hop)(const struct in_addr *host, struct in_addr *next_hop,
 631                         char **netdev_name);
 632
 633     /* Retrieves driver information of the device.
 634      *
 635      * Populates 'smap' with key-value pairs representing the status of the
 636      * device.  'smap' is a set of key-value string pairs representing netdev
 637      * type specific information.  For more information see
 638      * ovs-vswitchd.conf.db(5).
 639      *
 640      * The caller is responsible for destroying 'smap' and its data.
 641      *
 642      * This function may be set to null if it would always return EOPNOTSUPP
 643      * anyhow. */
 644     int (*get_status)(const struct netdev *netdev, struct smap *smap);
 645
 646     /* Looks up the ARP table entry for 'ip' on 'netdev' and stores the
 647      * corresponding MAC address in 'mac'.  A return value of ENXIO, in
 648      * particular, indicates that there is no ARP table entry for 'ip' on
 649      * 'netdev'.
 650      *
 651      * This function may be set to null if it would always return EOPNOTSUPP
 652      * anyhow. */
 653     int (*arp_lookup)(const struct netdev *netdev, ovs_be32 ip,
 654                       uint8_t mac[6]);
 655
 656     /* Retrieves the current set of flags on 'netdev' into '*old_flags'.  Then,
 657      * turns off the flags that are set to 1 in 'off' and turns on the flags
 658      * that are set to 1 in 'on'.  (No bit will be set to 1 in both 'off' and
 659      * 'on'; that is, off & on == 0.)
 660      *
 661      * This function may be invoked from a signal handler.  Therefore, it
 662      * should not do anything that is not signal-safe (such as logging). */
 663     int (*update_flags)(struct netdev *netdev, enum netdev_flags off,
 664                         enum netdev_flags on, enum netdev_flags *old_flags);
 665
 666 /* ## -------------------- ## */
 667 /* ## netdev_rxq Functions ## */
 668 /* ## -------------------- ## */
 669
 670 /* If a particular netdev class does not support receiving packets, all these
 671  * function pointers must be NULL. */
 672
 673     /* Life-cycle functions for a netdev_rxq.  See the large comment above on
 674      * struct netdev_class. */
 675     struct netdev_rxq *(*rxq_alloc)(void);
 676     int (*rxq_construct)(struct netdev_rxq *);
 677     void (*rxq_destruct)(struct netdev_rxq *);
 678     void (*rxq_dealloc)(struct netdev_rxq *);
 679
 680     /* Attempts to receive batch of packets from 'rx' and place array of
 681      * pointers into '*pkts'. netdev is responsible for allocating buffers.
 682      * '*cnt' points to packet count for given batch. Once packets are returned
 683      * to caller, netdev should give up ownership of ofpbuf data.
 684      *
 685      * Implementations should allocate buffer with DP_NETDEV_HEADROOM headroom
 686      * and add a VLAN header which is obtained out-of-band to the packet.
 687      *
 688      * Caller is expected to pass array of size MAX_RX_BATCH.
 689      * This function may be set to null if it would always return EOPNOTSUPP
 690      * anyhow. */
 691     int (*rxq_recv)(struct netdev_rxq *rx, struct dpif_packet **pkts,
 692                     int *cnt);
 693
 694     /* Registers with the poll loop to wake up from the next call to
 695      * poll_block() when a packet is ready to be received with netdev_rxq_recv()
 696      * on 'rx'. */
 697     void (*rxq_wait)(struct netdev_rxq *rx);
 698
 699     /* Discards all packets waiting to be received from 'rx'. */
 700     int (*rxq_drain)(struct netdev_rxq *rx);
 701 };
 702
 703 int netdev_register_provider(const struct netdev_class *);
 704 int netdev_unregister_provider(const char *type);
 705
 706 extern const struct netdev_class netdev_linux_class;
 707 extern const struct netdev_class netdev_internal_class;
 708 extern const struct netdev_class netdev_tap_class;
 709 #if defined(__FreeBSD__) || defined(__NetBSD__)
 710 extern const struct netdev_class netdev_bsd_class;
 711 #endif
 712
 713 #ifdef  __cplusplus
 714 }
 715 #endif
 716
 717 #endif /* netdev.h */