2 * Copyright (c) 2009, 2010 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. */
37 /* A network device (e.g. an Ethernet device).
39 * This structure should be treated as opaque by network device
42 char *name; /* Name of network device. */
43 const struct netdev_class *netdev_class; /* Functions to control
45 int ref_cnt; /* Times this devices was opened. */
46 struct shash_node *node; /* Pointer to element in global map. */
47 struct arg *args; /* Argument list from last config. */
48 int n_args; /* Number of arguments in 'args'. */
51 void netdev_dev_init(struct netdev_dev *, const char *name,
52 const struct netdev_class *);
53 void netdev_dev_uninit(struct netdev_dev *, bool destroy);
54 const char *netdev_dev_get_type(const struct netdev_dev *);
55 const struct netdev_class *netdev_dev_get_class(const struct netdev_dev *);
56 const char *netdev_dev_get_name(const struct netdev_dev *);
57 struct netdev_dev *netdev_dev_from_name(const char *name);
58 void netdev_dev_get_devices(const struct netdev_class *,
59 struct shash *device_list);
61 static inline void netdev_dev_assert_class(const struct netdev_dev *netdev_dev,
62 const struct netdev_class *class_)
64 assert(netdev_dev->netdev_class == class_);
67 /* A instance of an open network device.
69 * This structure should be treated as opaque by network device
72 struct netdev_dev *netdev_dev; /* Parent netdev_dev. */
73 struct list node; /* Element in global list. */
75 enum netdev_flags save_flags; /* Initial device flags. */
76 enum netdev_flags changed_flags; /* Flags that we changed. */
79 void netdev_init(struct netdev *, struct netdev_dev *);
80 void netdev_uninit(struct netdev *, bool close);
81 struct netdev_dev *netdev_get_dev(const struct netdev *);
83 static inline void netdev_assert_class(const struct netdev *netdev,
84 const struct netdev_class *netdev_class)
86 netdev_dev_assert_class(netdev_get_dev(netdev), netdev_class);
89 /* A network device notifier.
91 * Network device implementations should use netdev_notifier_init() to
92 * initialize this structure, but they may freely read its members after
94 struct netdev_notifier {
95 struct netdev *netdev;
96 void (*cb)(struct netdev_notifier *);
99 void netdev_notifier_init(struct netdev_notifier *, struct netdev *,
100 void (*cb)(struct netdev_notifier *), void *aux);
102 /* Network device class structure, to be defined by each implementation of a
105 * These functions return 0 if successful or a positive errno value on failure,
106 * except where otherwise noted. */
107 struct netdev_class {
108 /* Type of netdevs in this class, e.g. "system", "tap", "gre", etc.
110 * One of the providers should supply a "system" type, since this is
111 * the type assumed if no type is specified when opening a netdev.
112 * The "system" type corresponds to an existing network device on
116 /* Called when the netdev provider is registered, typically at program
117 * startup. Returning an error from this function will prevent any network
118 * device in this class from being opened.
120 * This function may be set to null if a network device class needs no
121 * initialization at registration time. */
124 /* Performs periodic work needed by netdevs of this class. May be null if
125 * no periodic work is necessary. */
128 /* Arranges for poll_block() to wake up if the "run" member function needs
129 * to be called. May be null if nothing is needed here. */
132 /* Attempts to create a network device of 'type' with 'name'.
133 * 'type' corresponds to the 'type' field used in the netdev_class
134 * structure. On success sets 'netdev_devp' to the newly created device. */
135 int (*create)(const char *name, const char *type, const struct shash *args,
136 struct netdev_dev **netdev_devp);
138 /* Destroys 'netdev_dev'.
140 * Netdev devices maintain a reference count that is incremented on
141 * netdev_open() and decremented on netdev_close(). If 'netdev_dev'
142 * has a non-zero reference count, then this function will not be
144 void (*destroy)(struct netdev_dev *netdev_dev);
146 /* Reconfigures the device 'netdev_dev' with 'args'.
148 * If this netdev class does not support reconfiguring a netdev
149 * device, this may be a null pointer.
151 int (*reconfigure)(struct netdev_dev *netdev_dev, const struct shash *args);
153 /* Attempts to open a network device. On success, sets 'netdevp'
154 * to the new network device.
156 * 'ethertype' may be a 16-bit Ethernet protocol value in host byte order
157 * to capture frames of that type received on the device. It may also be
158 * one of the 'enum netdev_pseudo_ethertype' values to receive frames in
159 * one of those categories. */
160 int (*open)(struct netdev_dev *netdev_dev, int ethertype,
161 struct netdev **netdevp);
163 /* Closes 'netdev'. */
164 void (*close)(struct netdev *netdev);
166 /* Enumerates the names of all network devices of this class.
168 * The caller has already initialized 'all_names' and might already have
169 * added some names to it. This function should not disturb any existing
170 * names in 'all_names'.
172 * If this netdev class does not support enumeration, this may be a null
174 int (*enumerate)(struct svec *all_names);
176 /* Attempts to receive a packet from 'netdev' into the 'size' bytes in
177 * 'buffer'. If successful, returns the number of bytes in the received
178 * packet, otherwise a negative errno value. Returns -EAGAIN immediately
179 * if no packet is ready to be received.
181 * May return -EOPNOTSUPP if a 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 disable the OVS
184 * integrated DHCP client and OpenFlow controller discovery, and prevent
185 * the network device from being usefully used by the netdev-based
186 * "userspace datapath".) */
187 int (*recv)(struct netdev *netdev, void *buffer, size_t size);
189 /* Registers with the poll loop to wake up from the next call to
190 * poll_block() when a packet is ready to be received with netdev_recv() on
193 * May be null if not needed, such as for a network device that does not
194 * implement packet reception through the 'recv' member function. */
195 void (*recv_wait)(struct netdev *netdev);
197 /* Discards all packets waiting to be received from 'netdev'.
199 * May be null if not needed, such as for a network device that does not
200 * implement packet reception through the 'recv' member function. */
201 int (*drain)(struct netdev *netdev);
203 /* Sends the 'size'-byte packet in 'buffer' on 'netdev'. Returns 0 if
204 * successful, otherwise a positive errno value. Returns EAGAIN without
205 * blocking if the packet cannot be queued immediately. Returns EMSGSIZE
206 * if a partial packet was transmitted or if the packet is too big or too
207 * small to transmit on the device.
209 * The caller retains ownership of 'buffer' in all cases.
211 * The network device is expected to maintain a packet transmission queue,
212 * so that the caller does not ordinarily have to do additional queuing of
215 * May return EOPNOTSUPP if a network device does not implement packet
216 * transmission through this interface. This function may be set to null
217 * if it would always return EOPNOTSUPP anyhow. (This will disable the OVS
218 * integrated DHCP client and OpenFlow controller discovery, and prevent
219 * the network device from being usefully used by the netdev-based
220 * "userspace datapath".) */
221 int (*send)(struct netdev *netdev, const void *buffer, size_t size);
223 /* Registers with the poll loop to wake up from the next call to
224 * poll_block() when the packet transmission queue for 'netdev' has
225 * sufficient room to transmit a packet with netdev_send().
227 * The network device is expected to maintain a packet transmission queue,
228 * so that the caller does not ordinarily have to do additional queuing of
229 * packets. Thus, this function is unlikely to ever be useful.
231 * May be null if not needed, such as for a network device that does not
232 * implement packet transmission through the 'send' member function. */
233 void (*send_wait)(struct netdev *netdev);
235 /* Sets 'netdev''s Ethernet address to 'mac' */
236 int (*set_etheraddr)(struct netdev *netdev, const uint8_t mac[6]);
238 /* Retrieves 'netdev''s Ethernet address into 'mac'. */
239 int (*get_etheraddr)(const struct netdev *netdev, uint8_t mac[6]);
241 /* Retrieves 'netdev''s MTU into '*mtup'.
243 * The MTU is the maximum size of transmitted (and received) packets, in
244 * bytes, not including the hardware header; thus, this is typically 1500
245 * bytes for Ethernet devices.*/
246 int (*get_mtu)(const struct netdev *netdev, int *mtup);
248 /* Returns the ifindex of 'netdev', if successful, as a positive number.
249 * On failure, returns a negative errno value.
251 * The desired semantics of the ifindex value are a combination of those
252 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An
253 * ifindex value should be unique within a host and remain stable at least
254 * until reboot. SNMP says an ifindex "ranges between 1 and the value of
255 * ifNumber" but many systems do not follow this rule anyhow.
257 * This function may be set to null if it would always return -EOPNOTSUPP.
259 int (*get_ifindex)(const struct netdev *netdev);
261 /* Sets 'carrier' to true if carrier is active (link light is on) on
263 int (*get_carrier)(const struct netdev *netdev, bool *carrier);
265 /* Retrieves current device stats for 'netdev' into 'stats'.
267 * A network device that supports some statistics but not others, it should
268 * set the values of the unsupported statistics to all-1-bits
270 int (*get_stats)(const struct netdev *netdev, struct netdev_stats *);
272 /* Sets the device stats for 'netdev' to 'stats'.
274 * Most network devices won't support this feature and will set this
275 * function pointer to NULL, which is equivalent to returning EOPNOTSUPP.
277 * Some network devices might only allow setting their stats to 0. */
278 int (*set_stats)(struct netdev *netdev, const struct netdev_stats *);
280 /* Stores the features supported by 'netdev' into each of '*current',
281 * '*advertised', '*supported', and '*peer'. Each value is a bitmap of
282 * "enum ofp_port_features" bits, in host byte order.
284 * This function may be set to null if it would always return EOPNOTSUPP.
286 int (*get_features)(struct netdev *netdev,
287 uint32_t *current, uint32_t *advertised,
288 uint32_t *supported, uint32_t *peer);
290 /* Set the features advertised by 'netdev' to 'advertise', which is a
291 * bitmap of "enum ofp_port_features" bits, in host byte order.
293 * This function may be set to null for a network device that does not
294 * support configuring advertisements. */
295 int (*set_advertisements)(struct netdev *netdev, uint32_t advertise);
297 /* If 'netdev' is a VLAN network device (e.g. one created with vconfig(8)),
298 * sets '*vlan_vid' to the VLAN VID associated with that device and returns
301 * Returns ENOENT if 'netdev' is a network device that is not a
304 * This function should be set to null if it doesn't make any sense for
305 * your network device (it probably doesn't). */
306 int (*get_vlan_vid)(const struct netdev *netdev, int *vlan_vid);
308 /* Attempts to set input rate limiting (policing) policy, such that up to
309 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative
310 * burst size of 'kbits' kb.
312 * This function may be set to null if policing is not supported. */
313 int (*set_policing)(struct netdev *netdev, unsigned int kbits_rate,
314 unsigned int kbits_burst);
316 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves
317 * it empty if 'netdev' does not support QoS. Any names added to 'types'
318 * should be documented as valid for the "type" column in the "QoS" table
319 * in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
321 * Every network device must support disabling QoS with a type of "", but
322 * this function must not add "" to 'types'.
324 * The caller is responsible for initializing 'types' (e.g. with
325 * svec_init()) before calling this function. The caller takes ownership
326 * of the strings added to 'types'.
328 * May be NULL if 'netdev' does not support QoS at all. */
329 int (*get_qos_types)(const struct netdev *netdev, struct svec *types);
331 /* Queries 'netdev' for its capabilities regarding the specified 'type' of
332 * QoS. On success, initializes 'caps' with the QoS capabilities.
334 * Should return EOPNOTSUPP if 'netdev' does not support 'type'. May be
335 * NULL if 'netdev' does not support QoS at all. */
336 int (*get_qos_capabilities)(const struct netdev *netdev,
338 struct netdev_qos_capabilities *caps);
340 /* Queries 'netdev' about its currently configured form of QoS. If
341 * successful, stores the name of the current form of QoS into '*typep'
342 * and any details of configuration as string key-value pairs in
345 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
347 * The caller initializes 'details' before calling this function. The
348 * caller takes ownership of the string key-values pairs added to
351 * The netdev retains ownership of '*typep'.
353 * '*typep' will be one of the types returned by netdev_get_qos_types() for
354 * 'netdev'. The contents of 'details' should be documented as valid for
355 * '*typep' in the "other_config" column in the "QoS" table in
356 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
358 * May be NULL if 'netdev' does not support QoS at all. */
359 int (*get_qos)(const struct netdev *netdev,
360 const char **typep, struct shash *details);
362 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to
363 * 'type' with details of configuration from 'details'.
365 * On error, the previous QoS configuration is retained.
367 * When this function changes the type of QoS (not just 'details'), this
368 * also resets all queue configuration for 'netdev' to their defaults
369 * (which depend on the specific type of QoS). Otherwise, the queue
370 * configuration for 'netdev' is unchanged.
372 * 'type' should be "" (to disable QoS) or one of the types returned by
373 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should
374 * be documented as valid for the given 'type' in the "other_config" column
375 * in the "QoS" table in vswitchd/vswitch.xml (which is built as
376 * ovs-vswitchd.conf.db(8)).
378 * May be NULL if 'netdev' does not support QoS at all. */
379 int (*set_qos)(struct netdev *netdev,
380 const char *type, const struct shash *details);
382 /* Queries 'netdev' for information about the queue numbered 'queue_id'.
383 * If successful, adds that information as string key-value pairs to
384 * 'details'. Returns 0 if successful, otherwise a positive errno value.
386 * Should return EINVAL if 'queue_id' is greater than or equal to the
387 * number of supported queues (as reported in the 'n_queues' member of
388 * struct netdev_qos_capabilities by 'get_qos_capabilities').
390 * The caller initializes 'details' before calling this function. The
391 * caller takes ownership of the string key-values pairs added to
394 * The returned contents of 'details' should be documented as valid for the
395 * given 'type' in the "other_config" column in the "Queue" table in
396 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
398 int (*get_queue)(const struct netdev *netdev,
399 unsigned int queue_id, struct shash *details);
401 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
402 * string pairs in 'details'. The contents of 'details' should be
403 * documented as valid for the given 'type' in the "other_config" column in
404 * the "Queue" table in vswitchd/vswitch.xml (which is built as
405 * ovs-vswitchd.conf.db(8)). Returns 0 if successful, otherwise a positive
406 * errno value. On failure, the given queue's configuration should be
409 * Should return EINVAL if 'queue_id' is greater than or equal to the
410 * number of supported queues (as reported in the 'n_queues' member of
411 * struct netdev_qos_capabilities by 'get_qos_capabilities'), or if
412 * 'details' is invalid for the type of queue.
414 * This function does not modify 'details', and the caller retains
417 * May be NULL if 'netdev' does not support QoS at all. */
418 int (*set_queue)(struct netdev *netdev,
419 unsigned int queue_id, const struct shash *details);
421 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'.
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'). Should
426 * return EOPNOTSUPP if 'queue_id' is valid but may not be deleted (e.g. if
427 * 'netdev' has a fixed set of queues with the current QoS mode).
429 * May be NULL if 'netdev' does not support QoS at all, or if all of its
430 * QoS modes have fixed sets of queues. */
431 int (*delete_queue)(struct netdev *netdev, unsigned int queue_id);
433 /* Obtains statistics about 'queue_id' on 'netdev'. Fills 'stats' with the
434 * queue's statistics. May set individual members of 'stats' to all-1-bits
435 * if the statistic is unavailable.
437 * May be NULL if 'netdev' does not support QoS at all. */
438 int (*get_queue_stats)(const struct netdev *netdev, unsigned int queue_id,
439 struct netdev_queue_stats *stats);
441 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's
442 * ID, its configuration, and the 'aux' specified by the caller. The order
443 * of iteration is unspecified, but (when successful) each queue is visited
446 * 'cb' will not modify or free the 'details' argument passed in. */
447 int (*dump_queues)(const struct netdev *netdev,
448 void (*cb)(unsigned int queue_id,
449 const struct shash *details,
453 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's
454 * ID, its statistics, and the 'aux' specified by the caller. The order of
455 * iteration is unspecified, but (when successful) each queue must be
456 * visited exactly once.
458 * 'cb' will not modify or free the statistics passed in. */
459 int (*dump_queue_stats)(const struct netdev *netdev,
460 void (*cb)(unsigned int queue_id,
461 struct netdev_queue_stats *,
465 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that
466 * address and '*netmask' to the associated netmask.
468 * The following error values have well-defined meanings:
470 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
472 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
474 * This function may be set to null if it would always return EOPNOTSUPP
476 int (*get_in4)(const struct netdev *netdev, struct in_addr *address,
477 struct in_addr *netmask);
479 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
480 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared.
482 * This function may be set to null if it would always return EOPNOTSUPP
484 int (*set_in4)(struct netdev *netdev, struct in_addr addr,
485 struct in_addr mask);
487 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address.
489 * The following error values have well-defined meanings:
491 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
493 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
495 * This function may be set to null if it would always return EOPNOTSUPP
497 int (*get_in6)(const struct netdev *netdev, struct in6_addr *in6);
499 /* Adds 'router' as a default IP gateway for the TCP/IP stack that
500 * corresponds to 'netdev'.
502 * This function may be set to null if it would always return EOPNOTSUPP
504 int (*add_router)(struct netdev *netdev, struct in_addr router);
506 /* Looks up the next hop for 'host'. If succesful, stores the next hop
507 * gateway's address (0 if 'host' is on a directly connected network) in
508 * '*next_hop' and a copy of the name of the device to reach 'host' in
509 * '*netdev_name', and returns 0. The caller is responsible for freeing
510 * '*netdev_name' (by calling free()).
512 * This function may be set to null if it would always return EOPNOTSUPP
514 int (*get_next_hop)(const struct in_addr *host, struct in_addr *next_hop,
517 /* Looks up the ARP table entry for 'ip' on 'netdev' and stores the
518 * corresponding MAC address in 'mac'. A return value of ENXIO, in
519 * particular, indicates that there is no ARP table entry for 'ip' on
522 * This function may be set to null if it would always return EOPNOTSUPP
524 int (*arp_lookup)(const struct netdev *netdev, uint32_t ip, uint8_t mac[6]);
526 /* Retrieves the current set of flags on 'netdev' into '*old_flags'.
527 * Then, turns off the flags that are set to 1 in 'off' and turns on the
528 * flags that are set to 1 in 'on'. (No bit will be set to 1 in both 'off'
529 * and 'on'; that is, off & on == 0.)
531 * This function may be invoked from a signal handler. Therefore, it
532 * should not do anything that is not signal-safe (such as logging). */
533 int (*update_flags)(struct netdev *netdev, enum netdev_flags off,
534 enum netdev_flags on, enum netdev_flags *old_flags);
536 /* Arranges for 'cb' to be called whenever one of the attributes of
537 * 'netdev' changes and sets '*notifierp' to a newly created
538 * netdev_notifier that represents this arrangement. The created notifier
539 * will have its 'netdev', 'cb', and 'aux' members set to the values of the
540 * corresponding parameters. */
541 int (*poll_add)(struct netdev *netdev,
542 void (*cb)(struct netdev_notifier *notifier), void *aux,
543 struct netdev_notifier **notifierp);
545 /* Cancels poll notification for 'notifier'. */
546 void (*poll_remove)(struct netdev_notifier *notifier);
549 extern const struct netdev_class netdev_linux_class;
550 extern const struct netdev_class netdev_tap_class;
551 extern const struct netdev_class netdev_patch_class;
552 extern const struct netdev_class netdev_gre_class;
553 extern const struct netdev_class netdev_capwap_class;
559 #endif /* netdev.h */