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