2 * Copyright (c) 2009, 2010, 2011 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #ifndef NETDEV_PROVIDER_H
18 #define NETDEV_PROVIDER_H 1
20 /* Generic interface to network devices. */
32 /* A network device (e.g. an Ethernet device).
34 * This structure should be treated as opaque by network device
37 char *name; /* Name of network device. */
38 const struct netdev_class *netdev_class; /* Functions to control
40 int ref_cnt; /* Times this devices was opened. */
41 struct shash_node *node; /* Pointer to element in global map. */
44 void netdev_dev_init(struct netdev_dev *, const char *name,
45 const struct netdev_class *);
46 void netdev_dev_uninit(struct netdev_dev *, bool destroy);
47 const char *netdev_dev_get_type(const struct netdev_dev *);
48 const struct netdev_class *netdev_dev_get_class(const struct netdev_dev *);
49 const char *netdev_dev_get_name(const struct netdev_dev *);
50 struct netdev_dev *netdev_dev_from_name(const char *name);
51 void netdev_dev_get_devices(const struct netdev_class *,
52 struct shash *device_list);
54 static inline void netdev_dev_assert_class(const struct netdev_dev *netdev_dev,
55 const struct netdev_class *class_)
57 assert(netdev_dev->netdev_class == class_);
60 /* A instance of an open network device.
62 * This structure should be treated as opaque by network device
65 struct netdev_dev *netdev_dev; /* Parent netdev_dev. */
66 struct list node; /* Element in global list. */
68 enum netdev_flags save_flags; /* Initial device flags. */
69 enum netdev_flags changed_flags; /* Flags that we changed. */
72 void netdev_init(struct netdev *, struct netdev_dev *);
73 void netdev_uninit(struct netdev *, bool close);
74 struct netdev_dev *netdev_get_dev(const struct netdev *);
76 static inline void netdev_assert_class(const struct netdev *netdev,
77 const struct netdev_class *netdev_class)
79 netdev_dev_assert_class(netdev_get_dev(netdev), netdev_class);
82 /* Network device class structure, to be defined by each implementation of a
85 * These functions return 0 if successful or a positive errno value on failure,
86 * except where otherwise noted. */
88 /* Type of netdevs in this class, e.g. "system", "tap", "gre", etc.
90 * One of the providers should supply a "system" type, since this is
91 * the type assumed if no type is specified when opening a netdev.
92 * The "system" type corresponds to an existing network device on
96 /* Called when the netdev provider is registered, typically at program
97 * startup. Returning an error from this function will prevent any network
98 * device in this class from being opened.
100 * This function may be set to null if a network device class needs no
101 * initialization at registration time. */
104 /* Performs periodic work needed by netdevs of this class. May be null if
105 * no periodic work is necessary. */
108 /* Arranges for poll_block() to wake up if the "run" member function needs
109 * to be called. Implementations are additionally required to wake
110 * whenever something changes in any of its netdevs which would cause their
111 * ->change_seq() function to change its result. May be null if nothing is
115 /* Attempts to create a network device named 'name' in 'netdev_class'. On
116 * success sets 'netdev_devp' to the newly created device. */
117 int (*create)(const struct netdev_class *netdev_class, const char *name,
118 struct netdev_dev **netdev_devp);
120 /* Destroys 'netdev_dev'.
122 * Netdev devices maintain a reference count that is incremented on
123 * netdev_open() and decremented on netdev_close(). If 'netdev_dev'
124 * has a non-zero reference count, then this function will not be
126 void (*destroy)(struct netdev_dev *netdev_dev);
128 /* Fetches the device 'netdev_dev''s configuration, storing it in 'args'.
129 * The caller owns 'args' and pre-initializes it to an empty shash.
131 * If this netdev class does not have any configuration options, this may
132 * be a null pointer. */
133 int (*get_config)(struct netdev_dev *netdev_dev, struct shash *args);
135 /* Changes the device 'netdev_dev''s configuration to 'args'.
137 * If this netdev class does not support configuration, this may be a null
139 int (*set_config)(struct netdev_dev *netdev_dev, const struct shash *args);
141 /* Attempts to open a network device. On success, sets 'netdevp'
142 * to the new network device. */
143 int (*open)(struct netdev_dev *netdev_dev, struct netdev **netdevp);
145 /* Closes 'netdev'. */
146 void (*close)(struct netdev *netdev);
148 /* Enumerates the names of all network devices of this class.
150 * The caller has already initialized 'all_names' and might already have
151 * added some names to it. This function should not disturb any existing
152 * names in 'all_names'.
154 * If this netdev class does not support enumeration, this may be a null
156 int (*enumerate)(struct sset *all_names);
158 /* ## ----------------- ## */
159 /* ## Receiving Packets ## */
160 /* ## ----------------- ## */
162 /* The network provider interface is mostly used for inspecting and configuring
163 * device "metadata", not for sending and receiving packets directly. It may
164 * be impractical to implement these functions on some operating systems and
165 * hardware. These functions may all be NULL in such cases.
167 * (However, the "dpif-netdev" implementation, which is the easiest way to
168 * integrate Open vSwitch with a new operating system or hardware, does require
169 * the ability to receive packets.) */
171 /* Attempts to set up 'netdev' for receiving packets with ->recv().
172 * Returns 0 if successful, otherwise a positive errno value. Return
173 * EOPNOTSUPP to indicate that the network device does not implement packet
174 * reception through this interface. This function may be set to null if
175 * it would always return EOPNOTSUPP anyhow. (This will prevent the
176 * network device from being usefully used by the netdev-based "userspace
178 int (*listen)(struct netdev *netdev);
180 /* Attempts to receive a packet from 'netdev' into the 'size' bytes in
181 * 'buffer'. If successful, returns the number of bytes in the received
182 * packet, otherwise a negative errno value. Returns -EAGAIN immediately
183 * if no packet is ready to be received.
185 * This function can only be expected to return a packet if ->listen() has
186 * been called successfully.
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 int (*recv)(struct netdev *netdev, void *buffer, size_t size);
192 /* Registers with the poll loop to wake up from the next call to
193 * poll_block() when a packet is ready to be received with netdev_recv() on
196 * May be null if not needed, such as for a network device that does not
197 * implement packet reception through the 'recv' member function. */
198 void (*recv_wait)(struct netdev *netdev);
200 /* Discards all packets waiting to be received from 'netdev'.
202 * May be null if not needed, such as for a network device that does not
203 * implement packet reception through the 'recv' member function. */
204 int (*drain)(struct netdev *netdev);
206 /* Sends the 'size'-byte packet in 'buffer' on 'netdev'. Returns 0 if
207 * successful, otherwise a positive errno value. Returns EAGAIN without
208 * blocking if the packet cannot be queued immediately. Returns EMSGSIZE
209 * if a partial packet was transmitted or if the packet is too big or too
210 * small to transmit on the device.
212 * The caller retains ownership of 'buffer' in all cases.
214 * The network device is expected to maintain a packet transmission queue,
215 * so that the caller does not ordinarily have to do additional queuing of
218 * May return EOPNOTSUPP if a network device does not implement packet
219 * transmission through this interface. This function may be set to null
220 * if it would always return EOPNOTSUPP anyhow. (This will prevent the
221 * network device from being usefully used by the netdev-based "userspace
222 * datapath". It will also prevent the OVS implementation of bonding from
223 * working properly over 'netdev'.) */
224 int (*send)(struct netdev *netdev, const void *buffer, size_t size);
226 /* Registers with the poll loop to wake up from the next call to
227 * poll_block() when the packet transmission queue for 'netdev' has
228 * sufficient room to transmit a packet with netdev_send().
230 * The network device is expected to maintain a packet transmission queue,
231 * so that the caller does not ordinarily have to do additional queuing of
232 * packets. Thus, this function is unlikely to ever be useful.
234 * May be null if not needed, such as for a network device that does not
235 * implement packet transmission through the 'send' member function. */
236 void (*send_wait)(struct netdev *netdev);
238 /* Sets 'netdev''s Ethernet address to 'mac' */
239 int (*set_etheraddr)(struct netdev *netdev, const uint8_t mac[6]);
241 /* Retrieves 'netdev''s Ethernet address into 'mac'. */
242 int (*get_etheraddr)(const struct netdev *netdev, uint8_t mac[6]);
244 /* Retrieves 'netdev''s MTU into '*mtup'.
246 * The MTU is the maximum size of transmitted (and received) packets, in
247 * bytes, not including the hardware header; thus, this is typically 1500
248 * bytes for Ethernet devices.
250 * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then
251 * this function should return EOPNOTSUPP. */
252 int (*get_mtu)(const struct netdev *netdev, int *mtup);
254 /* Sets 'netdev''s MTU to 'mtu'.
256 * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then
257 * this function should return EOPNOTSUPP. */
258 int (*set_mtu)(const struct netdev *netdev, int mtu);
260 /* Returns the ifindex of 'netdev', if successful, as a positive number.
261 * On failure, returns a negative errno value.
263 * The desired semantics of the ifindex value are a combination of those
264 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An
265 * ifindex value should be unique within a host and remain stable at least
266 * until reboot. SNMP says an ifindex "ranges between 1 and the value of
267 * ifNumber" but many systems do not follow this rule anyhow.
269 * This function may be set to null if it would always return -EOPNOTSUPP.
271 int (*get_ifindex)(const struct netdev *netdev);
273 /* Sets 'carrier' to true if carrier is active (link light is on) on
276 * May be null if device does not provide carrier status (will be always
277 * up as long as device is up).
279 int (*get_carrier)(const struct netdev *netdev, bool *carrier);
281 /* Forces ->get_carrier() to poll 'netdev''s MII registers for link status
282 * instead of checking 'netdev''s carrier. 'netdev''s MII registers will
283 * be polled once ever 'interval' milliseconds. If 'netdev' does not
284 * support MII, another method may be used as a fallback. If 'interval' is
285 * less than or equal to zero, reverts ->get_carrier() to its normal
288 * Most network devices won't support this feature and will set this
289 * function pointer to NULL, which is equivalent to returning EOPNOTSUPP.
291 int (*set_miimon_interval)(struct netdev *netdev, long long int interval);
293 /* Retrieves current device stats for 'netdev' into 'stats'.
295 * A network device that supports some statistics but not others, it should
296 * set the values of the unsupported statistics to all-1-bits
298 int (*get_stats)(const struct netdev *netdev, struct netdev_stats *);
300 /* Sets the device stats for 'netdev' to 'stats'.
302 * Most network devices won't support this feature and will set this
303 * function pointer to NULL, which is equivalent to returning EOPNOTSUPP.
305 * Some network devices might only allow setting their stats to 0. */
306 int (*set_stats)(struct netdev *netdev, const struct netdev_stats *);
308 /* Stores the features supported by 'netdev' into each of '*current',
309 * '*advertised', '*supported', and '*peer'. Each value is a bitmap of
310 * "enum ofp_port_features" bits, in host byte order.
312 * This function may be set to null if it would always return EOPNOTSUPP.
314 int (*get_features)(const struct netdev *netdev,
315 uint32_t *current, uint32_t *advertised,
316 uint32_t *supported, uint32_t *peer);
318 /* Set the features advertised by 'netdev' to 'advertise', which is a
319 * bitmap of "enum ofp_port_features" bits, in host byte order.
321 * This function may be set to null for a network device that does not
322 * support configuring advertisements. */
323 int (*set_advertisements)(struct netdev *netdev, uint32_t advertise);
325 /* If 'netdev' is a VLAN network device (e.g. one created with vconfig(8)),
326 * sets '*vlan_vid' to the VLAN VID associated with that device and returns
329 * Returns ENOENT if 'netdev' is a network device that is not a
332 * This function should be set to null if it doesn't make any sense for
333 * your network device (it probably doesn't). */
334 int (*get_vlan_vid)(const struct netdev *netdev, int *vlan_vid);
336 /* Attempts to set input rate limiting (policing) policy, such that up to
337 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative
338 * burst size of 'kbits' kb.
340 * This function may be set to null if policing is not supported. */
341 int (*set_policing)(struct netdev *netdev, unsigned int kbits_rate,
342 unsigned int kbits_burst);
344 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves
345 * it empty if 'netdev' does not support QoS. Any names added to 'types'
346 * should be documented as valid for the "type" column in the "QoS" table
347 * in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
349 * Every network device must support disabling QoS with a type of "", but
350 * this function must not add "" to 'types'.
352 * The caller is responsible for initializing 'types' (e.g. with
353 * sset_init()) before calling this function. The caller retains ownership
356 * May be NULL if 'netdev' does not support QoS at all. */
357 int (*get_qos_types)(const struct netdev *netdev, struct sset *types);
359 /* Queries 'netdev' for its capabilities regarding the specified 'type' of
360 * QoS. On success, initializes 'caps' with the QoS capabilities.
362 * Should return EOPNOTSUPP if 'netdev' does not support 'type'. May be
363 * NULL if 'netdev' does not support QoS at all. */
364 int (*get_qos_capabilities)(const struct netdev *netdev,
366 struct netdev_qos_capabilities *caps);
368 /* Queries 'netdev' about its currently configured form of QoS. If
369 * successful, stores the name of the current form of QoS into '*typep'
370 * and any details of configuration as string key-value pairs in
373 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
375 * The caller initializes 'details' before calling this function. The
376 * caller takes ownership of the string key-values pairs added to
379 * The netdev retains ownership of '*typep'.
381 * '*typep' will be one of the types returned by netdev_get_qos_types() for
382 * 'netdev'. The contents of 'details' should be documented as valid for
383 * '*typep' in the "other_config" column in the "QoS" table in
384 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
386 * May be NULL if 'netdev' does not support QoS at all. */
387 int (*get_qos)(const struct netdev *netdev,
388 const char **typep, struct shash *details);
390 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to
391 * 'type' with details of configuration from 'details'.
393 * On error, the previous QoS configuration is retained.
395 * When this function changes the type of QoS (not just 'details'), this
396 * also resets all queue configuration for 'netdev' to their defaults
397 * (which depend on the specific type of QoS). Otherwise, the queue
398 * configuration for 'netdev' is unchanged.
400 * 'type' should be "" (to disable QoS) or one of the types returned by
401 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should
402 * be documented as valid for the given 'type' in the "other_config" column
403 * in the "QoS" table in vswitchd/vswitch.xml (which is built as
404 * ovs-vswitchd.conf.db(8)).
406 * May be NULL if 'netdev' does not support QoS at all. */
407 int (*set_qos)(struct netdev *netdev,
408 const char *type, const struct shash *details);
410 /* Queries 'netdev' for information about the queue numbered 'queue_id'.
411 * If successful, adds that information as string key-value pairs to
412 * 'details'. Returns 0 if successful, otherwise a positive errno value.
414 * Should return EINVAL if 'queue_id' is greater than or equal to the
415 * number of supported queues (as reported in the 'n_queues' member of
416 * struct netdev_qos_capabilities by 'get_qos_capabilities').
418 * The caller initializes 'details' before calling this function. The
419 * caller takes ownership of the string key-values pairs added to
422 * The returned contents of 'details' should be documented as valid for the
423 * given 'type' in the "other_config" column in the "Queue" table in
424 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
426 int (*get_queue)(const struct netdev *netdev,
427 unsigned int queue_id, struct shash *details);
429 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
430 * string pairs in 'details'. The contents of 'details' should be
431 * documented as valid for the given 'type' in the "other_config" column in
432 * the "Queue" table in vswitchd/vswitch.xml (which is built as
433 * ovs-vswitchd.conf.db(8)). Returns 0 if successful, otherwise a positive
434 * errno value. On failure, the given queue's configuration should be
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'), or if
440 * 'details' is invalid for the type of queue.
442 * This function does not modify 'details', and the caller retains
445 * May be NULL if 'netdev' does not support QoS at all. */
446 int (*set_queue)(struct netdev *netdev,
447 unsigned int queue_id, const struct shash *details);
449 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'.
451 * Should return EINVAL if 'queue_id' is greater than or equal to the
452 * number of supported queues (as reported in the 'n_queues' member of
453 * struct netdev_qos_capabilities by 'get_qos_capabilities'). Should
454 * return EOPNOTSUPP if 'queue_id' is valid but may not be deleted (e.g. if
455 * 'netdev' has a fixed set of queues with the current QoS mode).
457 * May be NULL if 'netdev' does not support QoS at all, or if all of its
458 * QoS modes have fixed sets of queues. */
459 int (*delete_queue)(struct netdev *netdev, unsigned int queue_id);
461 /* Obtains statistics about 'queue_id' on 'netdev'. Fills 'stats' with the
462 * queue's statistics. May set individual members of 'stats' to all-1-bits
463 * if the statistic is unavailable.
465 * May be NULL if 'netdev' does not support QoS at all. */
466 int (*get_queue_stats)(const struct netdev *netdev, unsigned int queue_id,
467 struct netdev_queue_stats *stats);
469 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's
470 * ID, its configuration, and the 'aux' specified by the caller. The order
471 * of iteration is unspecified, but (when successful) each queue is visited
474 * 'cb' will not modify or free the 'details' argument passed in. */
475 int (*dump_queues)(const struct netdev *netdev,
476 void (*cb)(unsigned int queue_id,
477 const struct shash *details,
481 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's
482 * ID, its statistics, and the 'aux' specified by the caller. The order of
483 * iteration is unspecified, but (when successful) each queue must be
484 * visited exactly once.
486 * 'cb' will not modify or free the statistics passed in. */
487 int (*dump_queue_stats)(const struct netdev *netdev,
488 void (*cb)(unsigned int queue_id,
489 struct netdev_queue_stats *,
493 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that
494 * address and '*netmask' to the associated netmask.
496 * The following error values have well-defined meanings:
498 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
500 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
502 * This function may be set to null if it would always return EOPNOTSUPP
504 int (*get_in4)(const struct netdev *netdev, struct in_addr *address,
505 struct in_addr *netmask);
507 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
508 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared.
510 * This function may be set to null if it would always return EOPNOTSUPP
512 int (*set_in4)(struct netdev *netdev, struct in_addr addr,
513 struct in_addr mask);
515 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address.
517 * The following error values have well-defined meanings:
519 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
521 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
523 * This function may be set to null if it would always return EOPNOTSUPP
525 int (*get_in6)(const struct netdev *netdev, struct in6_addr *in6);
527 /* Adds 'router' as a default IP gateway for the TCP/IP stack that
528 * corresponds to 'netdev'.
530 * This function may be set to null if it would always return EOPNOTSUPP
532 int (*add_router)(struct netdev *netdev, struct in_addr router);
534 /* Looks up the next hop for 'host'. If succesful, stores the next hop
535 * gateway's address (0 if 'host' is on a directly connected network) in
536 * '*next_hop' and a copy of the name of the device to reach 'host' in
537 * '*netdev_name', and returns 0. The caller is responsible for freeing
538 * '*netdev_name' (by calling free()).
540 * This function may be set to null if it would always return EOPNOTSUPP
542 int (*get_next_hop)(const struct in_addr *host, struct in_addr *next_hop,
545 /* Retrieves the status of the device.
547 * Populates 'sh' with key-value pairs representing the status of the
548 * device. A device's status is a set of key-value string pairs
549 * representing netdev type specific information. For more information see
550 * ovs-vswitchd.conf.db(5).
552 * The data of 'sh' are heap allocated strings which the caller is
553 * responsible for deallocating.
555 * This function may be set to null if it would always return EOPNOTSUPP
557 int (*get_status)(const struct netdev *netdev, struct shash *sh);
559 /* Looks up the ARP table entry for 'ip' on 'netdev' and stores the
560 * corresponding MAC address in 'mac'. A return value of ENXIO, in
561 * particular, indicates that there is no ARP table entry for 'ip' on
564 * This function may be set to null if it would always return EOPNOTSUPP
566 int (*arp_lookup)(const struct netdev *netdev, ovs_be32 ip,
569 /* Retrieves the current set of flags on 'netdev' into '*old_flags'.
570 * Then, turns off the flags that are set to 1 in 'off' and turns on the
571 * flags that are set to 1 in 'on'. (No bit will be set to 1 in both 'off'
572 * and 'on'; that is, off & on == 0.)
574 * This function may be invoked from a signal handler. Therefore, it
575 * should not do anything that is not signal-safe (such as logging). */
576 int (*update_flags)(struct netdev *netdev, enum netdev_flags off,
577 enum netdev_flags on, enum netdev_flags *old_flags);
579 /* Returns a sequence number which indicates changes in one of 'netdev''s
580 * properties. The returned sequence number must be nonzero so that
581 * callers have a value which they may use as a reset when tracking
584 * Minimally, the returned sequence number is required to change whenever
585 * 'netdev''s flags, features, ethernet address, or carrier changes. The
586 * returned sequence number is allowed to change even when 'netdev' doesn't
587 * change, although implementations should try to avoid this. */
588 unsigned int (*change_seq)(const struct netdev *netdev);
591 int netdev_register_provider(const struct netdev_class *);
592 int netdev_unregister_provider(const char *type);
593 const struct netdev_class *netdev_lookup_provider(const char *type);
595 extern const struct netdev_class netdev_linux_class;
596 extern const struct netdev_class netdev_internal_class;
597 extern const struct netdev_class netdev_tap_class;
603 #endif /* netdev.h */