2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
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.
22 #include <netinet/in.h>
28 #include "dynamic-string.h"
29 #include "fatal-signal.h"
32 #include "netdev-provider.h"
33 #include "netdev-vport.h"
35 #include "openflow/openflow.h"
37 #include "poll-loop.h"
44 VLOG_DEFINE_THIS_MODULE(netdev
);
46 COVERAGE_DEFINE(netdev_received
);
47 COVERAGE_DEFINE(netdev_sent
);
48 COVERAGE_DEFINE(netdev_add_router
);
49 COVERAGE_DEFINE(netdev_get_stats
);
51 static struct shash netdev_classes
= SHASH_INITIALIZER(&netdev_classes
);
53 /* All created network devices. */
54 static struct shash netdev_dev_shash
= SHASH_INITIALIZER(&netdev_dev_shash
);
56 /* All open network devices. */
57 static struct list netdev_list
= LIST_INITIALIZER(&netdev_list
);
59 /* This is set pretty low because we probably won't learn anything from the
60 * additional log messages. */
61 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(5, 20);
63 static void close_all_netdevs(void *aux OVS_UNUSED
);
64 static int restore_flags(struct netdev
*netdev
);
65 void update_device_args(struct netdev_dev
*, const struct shash
*args
);
68 netdev_initialize(void)
75 fatal_signal_add_hook(close_all_netdevs
, NULL
, NULL
, true);
78 netdev_register_provider(&netdev_linux_class
);
79 netdev_register_provider(&netdev_internal_class
);
80 netdev_register_provider(&netdev_tap_class
);
81 netdev_vport_register();
84 netdev_register_provider(&netdev_tap_class
);
85 netdev_register_provider(&netdev_bsd_class
);
90 /* Performs periodic work needed by all the various kinds of netdevs.
92 * If your program opens any netdevs, it must call this function within its
97 struct shash_node
*node
;
98 SHASH_FOR_EACH(node
, &netdev_classes
) {
99 const struct netdev_class
*netdev_class
= node
->data
;
100 if (netdev_class
->run
) {
106 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
108 * If your program opens any netdevs, it must call this function within its
113 struct shash_node
*node
;
114 SHASH_FOR_EACH(node
, &netdev_classes
) {
115 const struct netdev_class
*netdev_class
= node
->data
;
116 if (netdev_class
->wait
) {
117 netdev_class
->wait();
122 /* Initializes and registers a new netdev provider. After successful
123 * registration, new netdevs of that type can be opened using netdev_open(). */
125 netdev_register_provider(const struct netdev_class
*new_class
)
127 if (shash_find(&netdev_classes
, new_class
->type
)) {
128 VLOG_WARN("attempted to register duplicate netdev provider: %s",
133 if (new_class
->init
) {
134 int error
= new_class
->init();
136 VLOG_ERR("failed to initialize %s network device class: %s",
137 new_class
->type
, strerror(error
));
142 shash_add(&netdev_classes
, new_class
->type
, new_class
);
147 /* Unregisters a netdev provider. 'type' must have been previously
148 * registered and not currently be in use by any netdevs. After unregistration
149 * new netdevs of that type cannot be opened using netdev_open(). */
151 netdev_unregister_provider(const char *type
)
153 struct shash_node
*del_node
, *netdev_dev_node
;
155 del_node
= shash_find(&netdev_classes
, type
);
157 VLOG_WARN("attempted to unregister a netdev provider that is not "
158 "registered: %s", type
);
162 SHASH_FOR_EACH(netdev_dev_node
, &netdev_dev_shash
) {
163 struct netdev_dev
*netdev_dev
= netdev_dev_node
->data
;
164 if (!strcmp(netdev_dev
->netdev_class
->type
, type
)) {
165 VLOG_WARN("attempted to unregister in use netdev provider: %s",
171 shash_delete(&netdev_classes
, del_node
);
176 const struct netdev_class
*
177 netdev_lookup_provider(const char *type
)
180 return shash_find_data(&netdev_classes
, type
&& type
[0] ? type
: "system");
183 /* Clears 'types' and enumerates the types of all currently registered netdev
184 * providers into it. The caller must first initialize the sset. */
186 netdev_enumerate_types(struct sset
*types
)
188 struct shash_node
*node
;
193 SHASH_FOR_EACH(node
, &netdev_classes
) {
194 const struct netdev_class
*netdev_class
= node
->data
;
195 sset_add(types
, netdev_class
->type
);
199 /* Opens the network device named 'name' (e.g. "eth0") of the specified 'type'
200 * (e.g. "system") and returns zero if successful, otherwise a positive errno
201 * value. On success, sets '*netdevp' to the new network device, otherwise to
204 * Some network devices may need to be configured (with netdev_set_config())
205 * before they can be used. */
207 netdev_open(const char *name
, const char *type
, struct netdev
**netdevp
)
209 struct netdev_dev
*netdev_dev
;
215 netdev_dev
= shash_find_data(&netdev_dev_shash
, name
);
218 const struct netdev_class
*class;
220 class = netdev_lookup_provider(type
);
222 VLOG_WARN("could not create netdev %s of unknown type %s",
226 error
= class->create(class, name
, &netdev_dev
);
230 ovs_assert(netdev_dev
->netdev_class
== class);
234 error
= netdev_dev
->netdev_class
->open(netdev_dev
, netdevp
);
237 netdev_dev
->ref_cnt
++;
239 if (!netdev_dev
->ref_cnt
) {
240 netdev_dev_uninit(netdev_dev
, true);
247 /* Reconfigures the device 'netdev' with 'args'. 'args' may be empty
248 * or NULL if none are needed. */
250 netdev_set_config(struct netdev
*netdev
, const struct smap
*args
)
252 struct netdev_dev
*netdev_dev
= netdev_get_dev(netdev
);
254 if (netdev_dev
->netdev_class
->set_config
) {
255 struct smap no_args
= SMAP_INITIALIZER(&no_args
);
256 return netdev_dev
->netdev_class
->set_config(netdev_dev
,
257 args
? args
: &no_args
);
258 } else if (args
&& !smap_is_empty(args
)) {
259 VLOG_WARN("%s: arguments provided to device that is not configurable",
260 netdev_get_name(netdev
));
266 /* Returns the current configuration for 'netdev' in 'args'. The caller must
267 * have already initialized 'args' with smap_init(). Returns 0 on success, in
268 * which case 'args' will be filled with 'netdev''s configuration. On failure
269 * returns a positive errno value, in which case 'args' will be empty.
271 * The caller owns 'args' and its contents and must eventually free them with
274 netdev_get_config(const struct netdev
*netdev
, struct smap
*args
)
276 struct netdev_dev
*netdev_dev
= netdev_get_dev(netdev
);
280 if (netdev_dev
->netdev_class
->get_config
) {
281 error
= netdev_dev
->netdev_class
->get_config(netdev_dev
, args
);
292 const struct netdev_tunnel_config
*
293 netdev_get_tunnel_config(const struct netdev
*netdev
)
295 struct netdev_dev
*netdev_dev
= netdev_get_dev(netdev
);
297 if (netdev_dev
->netdev_class
->get_tunnel_config
) {
298 return netdev_dev
->netdev_class
->get_tunnel_config(netdev_dev
);
304 /* Closes and destroys 'netdev'. */
306 netdev_close(struct netdev
*netdev
)
309 struct netdev_dev
*netdev_dev
= netdev_get_dev(netdev
);
311 ovs_assert(netdev_dev
->ref_cnt
);
312 netdev_dev
->ref_cnt
--;
313 netdev_uninit(netdev
, true);
315 /* If the reference count for the netdev device is zero, destroy it. */
316 if (!netdev_dev
->ref_cnt
) {
317 netdev_dev_uninit(netdev_dev
, true);
322 /* Returns true if a network device named 'name' exists and may be opened,
323 * otherwise false. */
325 netdev_exists(const char *name
)
327 struct netdev
*netdev
;
330 error
= netdev_open(name
, "system", &netdev
);
332 netdev_close(netdev
);
335 if (error
!= ENODEV
) {
336 VLOG_WARN("failed to open network device %s: %s",
337 name
, strerror(error
));
343 /* Returns true if a network device named 'name' is currently opened,
344 * otherwise false. */
346 netdev_is_open(const char *name
)
348 return !!shash_find_data(&netdev_dev_shash
, name
);
351 /* Parses 'netdev_name_', which is of the form [type@]name into its component
352 * pieces. 'name' and 'type' must be freed by the caller. */
354 netdev_parse_name(const char *netdev_name_
, char **name
, char **type
)
356 char *netdev_name
= xstrdup(netdev_name_
);
359 separator
= strchr(netdev_name
, '@');
363 *name
= xstrdup(separator
+ 1);
366 *type
= xstrdup("system");
370 /* Attempts to set up 'netdev' for receiving packets with netdev_recv().
371 * Returns 0 if successful, otherwise a positive errno value. EOPNOTSUPP
372 * indicates that the network device does not implement packet reception
373 * through this interface. */
375 netdev_listen(struct netdev
*netdev
)
377 int (*listen
)(struct netdev
*);
379 listen
= netdev_get_dev(netdev
)->netdev_class
->listen
;
380 return listen
? (listen
)(netdev
) : EOPNOTSUPP
;
383 /* Attempts to receive a packet from 'netdev' into 'buffer', which the caller
384 * must have initialized with sufficient room for the packet. The space
385 * required to receive any packet is ETH_HEADER_LEN bytes, plus VLAN_HEADER_LEN
386 * bytes, plus the device's MTU (which may be retrieved via netdev_get_mtu()).
387 * (Some devices do not allow for a VLAN header, in which case VLAN_HEADER_LEN
388 * need not be included.)
390 * This function can only be expected to return a packet if ->listen() has
391 * been called successfully.
393 * If a packet is successfully retrieved, returns 0. In this case 'buffer' is
394 * guaranteed to contain at least ETH_TOTAL_MIN bytes. Otherwise, returns a
395 * positive errno value. Returns EAGAIN immediately if no packet is ready to
398 * Some network devices may not implement support for this function. In such
399 * cases this function will always return EOPNOTSUPP. */
401 netdev_recv(struct netdev
*netdev
, struct ofpbuf
*buffer
)
403 int (*recv
)(struct netdev
*, void *, size_t);
406 ovs_assert(buffer
->size
== 0);
407 ovs_assert(ofpbuf_tailroom(buffer
) >= ETH_TOTAL_MIN
);
409 recv
= netdev_get_dev(netdev
)->netdev_class
->recv
;
411 ? (recv
)(netdev
, buffer
->data
, ofpbuf_tailroom(buffer
))
414 COVERAGE_INC(netdev_received
);
415 buffer
->size
+= retval
;
416 if (buffer
->size
< ETH_TOTAL_MIN
) {
417 ofpbuf_put_zeros(buffer
, ETH_TOTAL_MIN
- buffer
->size
);
425 /* Registers with the poll loop to wake up from the next call to poll_block()
426 * when a packet is ready to be received with netdev_recv() on 'netdev'. */
428 netdev_recv_wait(struct netdev
*netdev
)
430 void (*recv_wait
)(struct netdev
*);
432 recv_wait
= netdev_get_dev(netdev
)->netdev_class
->recv_wait
;
438 /* Discards all packets waiting to be received from 'netdev'. */
440 netdev_drain(struct netdev
*netdev
)
442 int (*drain
)(struct netdev
*);
444 drain
= netdev_get_dev(netdev
)->netdev_class
->drain
;
445 return drain
? drain(netdev
) : 0;
448 /* Sends 'buffer' on 'netdev'. Returns 0 if successful, otherwise a positive
449 * errno value. Returns EAGAIN without blocking if the packet cannot be queued
450 * immediately. Returns EMSGSIZE if a partial packet was transmitted or if
451 * the packet is too big or too small to transmit on the device.
453 * The caller retains ownership of 'buffer' in all cases.
455 * The kernel maintains a packet transmission queue, so the caller is not
456 * expected to do additional queuing of packets.
458 * Some network devices may not implement support for this function. In such
459 * cases this function will always return EOPNOTSUPP. */
461 netdev_send(struct netdev
*netdev
, const struct ofpbuf
*buffer
)
463 int (*send
)(struct netdev
*, const void *, size_t);
466 send
= netdev_get_dev(netdev
)->netdev_class
->send
;
467 error
= send
? (send
)(netdev
, buffer
->data
, buffer
->size
) : EOPNOTSUPP
;
469 COVERAGE_INC(netdev_sent
);
474 /* Registers with the poll loop to wake up from the next call to poll_block()
475 * when the packet transmission queue has sufficient room to transmit a packet
476 * with netdev_send().
478 * The kernel maintains a packet transmission queue, so the client is not
479 * expected to do additional queuing of packets. Thus, this function is
480 * unlikely to ever be used. It is included for completeness. */
482 netdev_send_wait(struct netdev
*netdev
)
484 void (*send_wait
)(struct netdev
*);
486 send_wait
= netdev_get_dev(netdev
)->netdev_class
->send_wait
;
492 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
493 * otherwise a positive errno value. */
495 netdev_set_etheraddr(struct netdev
*netdev
, const uint8_t mac
[ETH_ADDR_LEN
])
497 return netdev_get_dev(netdev
)->netdev_class
->set_etheraddr(netdev
, mac
);
500 /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
501 * the MAC address into 'mac'. On failure, returns a positive errno value and
502 * clears 'mac' to all-zeros. */
504 netdev_get_etheraddr(const struct netdev
*netdev
, uint8_t mac
[ETH_ADDR_LEN
])
506 return netdev_get_dev(netdev
)->netdev_class
->get_etheraddr(netdev
, mac
);
509 /* Returns the name of the network device that 'netdev' represents,
510 * e.g. "eth0". The caller must not modify or free the returned string. */
512 netdev_get_name(const struct netdev
*netdev
)
514 return netdev_get_dev(netdev
)->name
;
517 /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
518 * (and received) packets, in bytes, not including the hardware header; thus,
519 * this is typically 1500 bytes for Ethernet devices.
521 * If successful, returns 0 and stores the MTU size in '*mtup'. Returns
522 * EOPNOTSUPP if 'netdev' does not have an MTU (as e.g. some tunnels do not).
523 * On other failure, returns a positive errno value. On failure, sets '*mtup'
526 netdev_get_mtu(const struct netdev
*netdev
, int *mtup
)
528 const struct netdev_class
*class = netdev_get_dev(netdev
)->netdev_class
;
531 error
= class->get_mtu
? class->get_mtu(netdev
, mtup
) : EOPNOTSUPP
;
534 if (error
!= EOPNOTSUPP
) {
535 VLOG_DBG_RL(&rl
, "failed to retrieve MTU for network device %s: "
536 "%s", netdev_get_name(netdev
), strerror(error
));
542 /* Sets the MTU of 'netdev'. The MTU is the maximum size of transmitted
543 * (and received) packets, in bytes.
545 * If successful, returns 0. Returns EOPNOTSUPP if 'netdev' does not have an
546 * MTU (as e.g. some tunnels do not). On other failure, returns a positive
549 netdev_set_mtu(const struct netdev
*netdev
, int mtu
)
551 const struct netdev_class
*class = netdev_get_dev(netdev
)->netdev_class
;
554 error
= class->set_mtu
? class->set_mtu(netdev
, mtu
) : EOPNOTSUPP
;
555 if (error
&& error
!= EOPNOTSUPP
) {
556 VLOG_DBG_RL(&rl
, "failed to set MTU for network device %s: %s",
557 netdev_get_name(netdev
), strerror(error
));
563 /* Returns the ifindex of 'netdev', if successful, as a positive number. On
564 * failure, returns a negative errno value.
566 * The desired semantics of the ifindex value are a combination of those
567 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex
568 * value should be unique within a host and remain stable at least until
569 * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber"
570 * but many systems do not follow this rule anyhow.
572 * Some network devices may not implement support for this function. In such
573 * cases this function will always return -EOPNOTSUPP.
576 netdev_get_ifindex(const struct netdev
*netdev
)
578 int (*get_ifindex
)(const struct netdev
*);
580 get_ifindex
= netdev_get_dev(netdev
)->netdev_class
->get_ifindex
;
582 return get_ifindex
? get_ifindex(netdev
) : -EOPNOTSUPP
;
585 /* Stores the features supported by 'netdev' into each of '*current',
586 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
587 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
588 * successful, otherwise a positive errno value. On failure, all of the
589 * passed-in values are set to 0.
591 * Some network devices may not implement support for this function. In such
592 * cases this function will always return EOPNOTSUPP. */
594 netdev_get_features(const struct netdev
*netdev
,
595 enum netdev_features
*current
,
596 enum netdev_features
*advertised
,
597 enum netdev_features
*supported
,
598 enum netdev_features
*peer
)
600 int (*get_features
)(const struct netdev
*netdev
,
601 enum netdev_features
*current
,
602 enum netdev_features
*advertised
,
603 enum netdev_features
*supported
,
604 enum netdev_features
*peer
);
605 enum netdev_features dummy
[4];
612 advertised
= &dummy
[1];
615 supported
= &dummy
[2];
621 get_features
= netdev_get_dev(netdev
)->netdev_class
->get_features
;
623 ? get_features(netdev
, current
, advertised
, supported
,
627 *current
= *advertised
= *supported
= *peer
= 0;
632 /* Returns the maximum speed of a network connection that has the NETDEV_F_*
633 * bits in 'features', in bits per second. If no bits that indicate a speed
634 * are set in 'features', returns 'default_bps'. */
636 netdev_features_to_bps(enum netdev_features features
,
637 uint64_t default_bps
)
640 F_1000000MB
= NETDEV_F_1TB_FD
,
641 F_100000MB
= NETDEV_F_100GB_FD
,
642 F_40000MB
= NETDEV_F_40GB_FD
,
643 F_10000MB
= NETDEV_F_10GB_FD
,
644 F_1000MB
= NETDEV_F_1GB_HD
| NETDEV_F_1GB_FD
,
645 F_100MB
= NETDEV_F_100MB_HD
| NETDEV_F_100MB_FD
,
646 F_10MB
= NETDEV_F_10MB_HD
| NETDEV_F_10MB_FD
649 return ( features
& F_1000000MB
? UINT64_C(1000000000000)
650 : features
& F_100000MB
? UINT64_C(100000000000)
651 : features
& F_40000MB
? UINT64_C(40000000000)
652 : features
& F_10000MB
? UINT64_C(10000000000)
653 : features
& F_1000MB
? UINT64_C(1000000000)
654 : features
& F_100MB
? UINT64_C(100000000)
655 : features
& F_10MB
? UINT64_C(10000000)
659 /* Returns true if any of the NETDEV_F_* bits that indicate a full-duplex link
660 * are set in 'features', otherwise false. */
662 netdev_features_is_full_duplex(enum netdev_features features
)
664 return (features
& (NETDEV_F_10MB_FD
| NETDEV_F_100MB_FD
| NETDEV_F_1GB_FD
665 | NETDEV_F_10GB_FD
| NETDEV_F_40GB_FD
666 | NETDEV_F_100GB_FD
| NETDEV_F_1TB_FD
)) != 0;
669 /* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if
670 * successful, otherwise a positive errno value. */
672 netdev_set_advertisements(struct netdev
*netdev
,
673 enum netdev_features advertise
)
675 return (netdev_get_dev(netdev
)->netdev_class
->set_advertisements
676 ? netdev_get_dev(netdev
)->netdev_class
->set_advertisements(
681 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
682 * and '*netmask' to its netmask and returns 0. Otherwise, returns a positive
683 * errno value and sets '*address' to 0 (INADDR_ANY).
685 * The following error values have well-defined meanings:
687 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
689 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
691 * 'address' or 'netmask' or both may be null, in which case the address or
692 * netmask is not reported. */
694 netdev_get_in4(const struct netdev
*netdev
,
695 struct in_addr
*address_
, struct in_addr
*netmask_
)
697 struct in_addr address
;
698 struct in_addr netmask
;
701 error
= (netdev_get_dev(netdev
)->netdev_class
->get_in4
702 ? netdev_get_dev(netdev
)->netdev_class
->get_in4(netdev
,
706 address_
->s_addr
= error
? 0 : address
.s_addr
;
709 netmask_
->s_addr
= error
? 0 : netmask
.s_addr
;
714 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
715 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a
716 * positive errno value. */
718 netdev_set_in4(struct netdev
*netdev
, struct in_addr addr
, struct in_addr mask
)
720 return (netdev_get_dev(netdev
)->netdev_class
->set_in4
721 ? netdev_get_dev(netdev
)->netdev_class
->set_in4(netdev
, addr
, mask
)
725 /* Obtains ad IPv4 address from device name and save the address in
726 * in4. Returns 0 if successful, otherwise a positive errno value.
729 netdev_get_in4_by_name(const char *device_name
, struct in_addr
*in4
)
731 struct netdev
*netdev
;
734 error
= netdev_open(device_name
, "system", &netdev
);
736 in4
->s_addr
= htonl(0);
740 error
= netdev_get_in4(netdev
, in4
, NULL
);
741 netdev_close(netdev
);
745 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
748 netdev_add_router(struct netdev
*netdev
, struct in_addr router
)
750 COVERAGE_INC(netdev_add_router
);
751 return (netdev_get_dev(netdev
)->netdev_class
->add_router
752 ? netdev_get_dev(netdev
)->netdev_class
->add_router(netdev
, router
)
756 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
757 * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0,
758 * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a
759 * next hop is found, stores the next hop gateway's address (0 if 'host' is on
760 * a directly connected network) in '*next_hop' and a copy of the name of the
761 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
762 * responsible for freeing '*netdev_name' (by calling free()). */
764 netdev_get_next_hop(const struct netdev
*netdev
,
765 const struct in_addr
*host
, struct in_addr
*next_hop
,
768 int error
= (netdev_get_dev(netdev
)->netdev_class
->get_next_hop
769 ? netdev_get_dev(netdev
)->netdev_class
->get_next_hop(
770 host
, next_hop
, netdev_name
)
773 next_hop
->s_addr
= 0;
779 /* Populates 'smap' with status information.
781 * Populates 'smap' with 'netdev' specific status information. This
782 * information may be used to populate the status column of the Interface table
783 * as defined in ovs-vswitchd.conf.db(5). */
785 netdev_get_status(const struct netdev
*netdev
, struct smap
*smap
)
787 struct netdev_dev
*dev
= netdev_get_dev(netdev
);
789 return (dev
->netdev_class
->get_status
790 ? dev
->netdev_class
->get_status(netdev
, smap
)
794 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
795 * returns 0. Otherwise, returns a positive errno value and sets '*in6' to
796 * all-zero-bits (in6addr_any).
798 * The following error values have well-defined meanings:
800 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
802 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
804 * 'in6' may be null, in which case the address itself is not reported. */
806 netdev_get_in6(const struct netdev
*netdev
, struct in6_addr
*in6
)
808 struct in6_addr dummy
;
811 error
= (netdev_get_dev(netdev
)->netdev_class
->get_in6
812 ? netdev_get_dev(netdev
)->netdev_class
->get_in6(netdev
,
816 memset(in6
, 0, sizeof *in6
);
821 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
822 * 'on'. If 'permanent' is true, the changes will persist; otherwise, they
823 * will be reverted when 'netdev' is closed or the program exits. Returns 0 if
824 * successful, otherwise a positive errno value. */
826 do_update_flags(struct netdev
*netdev
, enum netdev_flags off
,
827 enum netdev_flags on
, enum netdev_flags
*old_flagsp
,
830 enum netdev_flags old_flags
;
833 error
= netdev_get_dev(netdev
)->netdev_class
->update_flags(netdev
,
834 off
& ~on
, on
, &old_flags
);
836 VLOG_WARN_RL(&rl
, "failed to %s flags for network device %s: %s",
837 off
|| on
? "set" : "get", netdev_get_name(netdev
),
840 } else if ((off
|| on
) && !permanent
) {
841 enum netdev_flags new_flags
= (old_flags
& ~off
) | on
;
842 enum netdev_flags changed_flags
= old_flags
^ new_flags
;
844 if (!netdev
->changed_flags
) {
845 netdev
->save_flags
= old_flags
;
847 netdev
->changed_flags
|= changed_flags
;
851 *old_flagsp
= old_flags
;
856 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
857 * Returns 0 if successful, otherwise a positive errno value. On failure,
858 * stores 0 into '*flagsp'. */
860 netdev_get_flags(const struct netdev
*netdev_
, enum netdev_flags
*flagsp
)
862 struct netdev
*netdev
= CONST_CAST(struct netdev
*, netdev_
);
863 return do_update_flags(netdev
, 0, 0, flagsp
, false);
866 /* Sets the flags for 'netdev' to 'flags'.
867 * If 'permanent' is true, the changes will persist; otherwise, they
868 * will be reverted when 'netdev' is closed or the program exits.
869 * Returns 0 if successful, otherwise a positive errno value. */
871 netdev_set_flags(struct netdev
*netdev
, enum netdev_flags flags
,
874 return do_update_flags(netdev
, -1, flags
, NULL
, permanent
);
877 /* Turns on the specified 'flags' on 'netdev'.
878 * If 'permanent' is true, the changes will persist; otherwise, they
879 * will be reverted when 'netdev' is closed or the program exits.
880 * Returns 0 if successful, otherwise a positive errno value. */
882 netdev_turn_flags_on(struct netdev
*netdev
, enum netdev_flags flags
,
885 return do_update_flags(netdev
, 0, flags
, NULL
, permanent
);
888 /* Turns off the specified 'flags' on 'netdev'.
889 * If 'permanent' is true, the changes will persist; otherwise, they
890 * will be reverted when 'netdev' is closed or the program exits.
891 * Returns 0 if successful, otherwise a positive errno value. */
893 netdev_turn_flags_off(struct netdev
*netdev
, enum netdev_flags flags
,
896 return do_update_flags(netdev
, flags
, 0, NULL
, permanent
);
899 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
900 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
901 * returns 0. Otherwise, it returns a positive errno value; in particular,
902 * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
904 netdev_arp_lookup(const struct netdev
*netdev
,
905 ovs_be32 ip
, uint8_t mac
[ETH_ADDR_LEN
])
907 int error
= (netdev_get_dev(netdev
)->netdev_class
->arp_lookup
908 ? netdev_get_dev(netdev
)->netdev_class
->arp_lookup(netdev
,
912 memset(mac
, 0, ETH_ADDR_LEN
);
917 /* Returns true if carrier is active (link light is on) on 'netdev'. */
919 netdev_get_carrier(const struct netdev
*netdev
)
922 enum netdev_flags flags
;
925 netdev_get_flags(netdev
, &flags
);
926 if (!(flags
& NETDEV_UP
)) {
930 if (!netdev_get_dev(netdev
)->netdev_class
->get_carrier
) {
934 error
= netdev_get_dev(netdev
)->netdev_class
->get_carrier(netdev
,
937 VLOG_DBG("%s: failed to get network device carrier status, assuming "
938 "down: %s", netdev_get_name(netdev
), strerror(error
));
945 /* Returns the number of times 'netdev''s carrier has changed. */
947 netdev_get_carrier_resets(const struct netdev
*netdev
)
949 return (netdev_get_dev(netdev
)->netdev_class
->get_carrier_resets
950 ? netdev_get_dev(netdev
)->netdev_class
->get_carrier_resets(netdev
)
954 /* Attempts to force netdev_get_carrier() to poll 'netdev''s MII registers for
955 * link status instead of checking 'netdev''s carrier. 'netdev''s MII
956 * registers will be polled once ever 'interval' milliseconds. If 'netdev'
957 * does not support MII, another method may be used as a fallback. If
958 * 'interval' is less than or equal to zero, reverts netdev_get_carrier() to
959 * its normal behavior.
961 * Returns 0 if successful, otherwise a positive errno value. */
963 netdev_set_miimon_interval(struct netdev
*netdev
, long long int interval
)
965 struct netdev_dev
*netdev_dev
= netdev_get_dev(netdev
);
966 return (netdev_dev
->netdev_class
->set_miimon_interval
967 ? netdev_dev
->netdev_class
->set_miimon_interval(netdev
, interval
)
971 /* Retrieves current device stats for 'netdev'. */
973 netdev_get_stats(const struct netdev
*netdev
, struct netdev_stats
*stats
)
977 COVERAGE_INC(netdev_get_stats
);
978 error
= (netdev_get_dev(netdev
)->netdev_class
->get_stats
979 ? netdev_get_dev(netdev
)->netdev_class
->get_stats(netdev
, stats
)
982 memset(stats
, 0xff, sizeof *stats
);
987 /* Attempts to change the stats for 'netdev' to those provided in 'stats'.
988 * Returns 0 if successful, otherwise a positive errno value.
990 * This will probably fail for most network devices. Some devices might only
991 * allow setting their stats to 0. */
993 netdev_set_stats(struct netdev
*netdev
, const struct netdev_stats
*stats
)
995 return (netdev_get_dev(netdev
)->netdev_class
->set_stats
996 ? netdev_get_dev(netdev
)->netdev_class
->set_stats(netdev
, stats
)
1000 /* Attempts to set input rate limiting (policing) policy, such that up to
1001 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
1002 * size of 'kbits' kb. */
1004 netdev_set_policing(struct netdev
*netdev
, uint32_t kbits_rate
,
1005 uint32_t kbits_burst
)
1007 return (netdev_get_dev(netdev
)->netdev_class
->set_policing
1008 ? netdev_get_dev(netdev
)->netdev_class
->set_policing(netdev
,
1009 kbits_rate
, kbits_burst
)
1013 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
1014 * empty if 'netdev' does not support QoS. Any names added to 'types' should
1015 * be documented as valid for the "type" column in the "QoS" table in
1016 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1018 * Every network device supports disabling QoS with a type of "", but this type
1019 * will not be added to 'types'.
1021 * The caller must initialize 'types' (e.g. with sset_init()) before calling
1022 * this function. The caller is responsible for destroying 'types' (e.g. with
1023 * sset_destroy()) when it is no longer needed.
1025 * Returns 0 if successful, otherwise a positive errno value. */
1027 netdev_get_qos_types(const struct netdev
*netdev
, struct sset
*types
)
1029 const struct netdev_class
*class = netdev_get_dev(netdev
)->netdev_class
;
1030 return (class->get_qos_types
1031 ? class->get_qos_types(netdev
, types
)
1035 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
1036 * which should be "" or one of the types returned by netdev_get_qos_types()
1037 * for 'netdev'. Returns 0 if successful, otherwise a positive errno value.
1038 * On success, initializes 'caps' with the QoS capabilities; on failure, clears
1039 * 'caps' to all zeros. */
1041 netdev_get_qos_capabilities(const struct netdev
*netdev
, const char *type
,
1042 struct netdev_qos_capabilities
*caps
)
1044 const struct netdev_class
*class = netdev_get_dev(netdev
)->netdev_class
;
1047 int retval
= (class->get_qos_capabilities
1048 ? class->get_qos_capabilities(netdev
, type
, caps
)
1051 memset(caps
, 0, sizeof *caps
);
1055 /* Every netdev supports turning off QoS. */
1056 memset(caps
, 0, sizeof *caps
);
1061 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
1062 * of QoS. Returns 0 if successful, otherwise a positive errno value. Stores
1063 * the number of queues (zero on failure) in '*n_queuesp'.
1065 * This is just a simple wrapper around netdev_get_qos_capabilities(). */
1067 netdev_get_n_queues(const struct netdev
*netdev
,
1068 const char *type
, unsigned int *n_queuesp
)
1070 struct netdev_qos_capabilities caps
;
1073 retval
= netdev_get_qos_capabilities(netdev
, type
, &caps
);
1074 *n_queuesp
= caps
.n_queues
;
1078 /* Queries 'netdev' about its currently configured form of QoS. If successful,
1079 * stores the name of the current form of QoS into '*typep', stores any details
1080 * of configuration as string key-value pairs in 'details', and returns 0. On
1081 * failure, sets '*typep' to NULL and returns a positive errno value.
1083 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1085 * The caller must initialize 'details' as an empty smap (e.g. with
1086 * smap_init()) before calling this function. The caller must free 'details'
1087 * when it is no longer needed (e.g. with smap_destroy()).
1089 * The caller must not modify or free '*typep'.
1091 * '*typep' will be one of the types returned by netdev_get_qos_types() for
1092 * 'netdev'. The contents of 'details' should be documented as valid for
1093 * '*typep' in the "other_config" column in the "QoS" table in
1094 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1096 netdev_get_qos(const struct netdev
*netdev
,
1097 const char **typep
, struct smap
*details
)
1099 const struct netdev_class
*class = netdev_get_dev(netdev
)->netdev_class
;
1102 if (class->get_qos
) {
1103 retval
= class->get_qos(netdev
, typep
, details
);
1106 smap_clear(details
);
1110 /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1116 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1117 * with details of configuration from 'details'. Returns 0 if successful,
1118 * otherwise a positive errno value. On error, the previous QoS configuration
1121 * When this function changes the type of QoS (not just 'details'), this also
1122 * resets all queue configuration for 'netdev' to their defaults (which depend
1123 * on the specific type of QoS). Otherwise, the queue configuration for
1124 * 'netdev' is unchanged.
1126 * 'type' should be "" (to disable QoS) or one of the types returned by
1127 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should be
1128 * documented as valid for the given 'type' in the "other_config" column in the
1129 * "QoS" table in vswitchd/vswitch.xml (which is built as
1130 * ovs-vswitchd.conf.db(8)).
1132 * NULL may be specified for 'details' if there are no configuration
1135 netdev_set_qos(struct netdev
*netdev
,
1136 const char *type
, const struct smap
*details
)
1138 const struct netdev_class
*class = netdev_get_dev(netdev
)->netdev_class
;
1144 if (class->set_qos
) {
1146 static struct smap empty
= SMAP_INITIALIZER(&empty
);
1149 return class->set_qos(netdev
, type
, details
);
1151 return *type
? EOPNOTSUPP
: 0;
1155 /* Queries 'netdev' for information about the queue numbered 'queue_id'. If
1156 * successful, adds that information as string key-value pairs to 'details'.
1157 * Returns 0 if successful, otherwise a positive errno value.
1159 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1160 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1162 * The returned contents of 'details' should be documented as valid for the
1163 * given 'type' in the "other_config" column in the "Queue" table in
1164 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1166 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1167 * this function. The caller must free 'details' when it is no longer needed
1168 * (e.g. with smap_destroy()). */
1170 netdev_get_queue(const struct netdev
*netdev
,
1171 unsigned int queue_id
, struct smap
*details
)
1173 const struct netdev_class
*class = netdev_get_dev(netdev
)->netdev_class
;
1176 retval
= (class->get_queue
1177 ? class->get_queue(netdev
, queue_id
, details
)
1180 smap_clear(details
);
1185 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1186 * string pairs in 'details'. The contents of 'details' should be documented
1187 * as valid for the given 'type' in the "other_config" column in the "Queue"
1188 * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1189 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1190 * given queue's configuration should be unmodified.
1192 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1193 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1195 * This function does not modify 'details', and the caller retains ownership of
1198 netdev_set_queue(struct netdev
*netdev
,
1199 unsigned int queue_id
, const struct smap
*details
)
1201 const struct netdev_class
*class = netdev_get_dev(netdev
)->netdev_class
;
1202 return (class->set_queue
1203 ? class->set_queue(netdev
, queue_id
, details
)
1207 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'. Some kinds
1208 * of QoS may have a fixed set of queues, in which case attempts to delete them
1209 * will fail with EOPNOTSUPP.
1211 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1212 * given queue will be unmodified.
1214 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1215 * the current form of QoS (e.g. as returned by
1216 * netdev_get_n_queues(netdev)). */
1218 netdev_delete_queue(struct netdev
*netdev
, unsigned int queue_id
)
1220 const struct netdev_class
*class = netdev_get_dev(netdev
)->netdev_class
;
1221 return (class->delete_queue
1222 ? class->delete_queue(netdev
, queue_id
)
1226 /* Obtains statistics about 'queue_id' on 'netdev'. On success, returns 0 and
1227 * fills 'stats' with the queue's statistics; individual members of 'stats' may
1228 * be set to all-1-bits if the statistic is unavailable. On failure, returns a
1229 * positive errno value and fills 'stats' with all-1-bits. */
1231 netdev_get_queue_stats(const struct netdev
*netdev
, unsigned int queue_id
,
1232 struct netdev_queue_stats
*stats
)
1234 const struct netdev_class
*class = netdev_get_dev(netdev
)->netdev_class
;
1237 retval
= (class->get_queue_stats
1238 ? class->get_queue_stats(netdev
, queue_id
, stats
)
1241 memset(stats
, 0xff, sizeof *stats
);
1246 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1247 * its configuration, and the 'aux' specified by the caller. The order of
1248 * iteration is unspecified, but (when successful) each queue is visited
1251 * Calling this function may be more efficient than calling netdev_get_queue()
1254 * 'cb' must not modify or free the 'details' argument passed in. It may
1255 * delete or modify the queue passed in as its 'queue_id' argument. It may
1256 * modify but must not delete any other queue within 'netdev'. 'cb' should not
1257 * add new queues because this may cause some queues to be visited twice or not
1260 * Returns 0 if successful, otherwise a positive errno value. On error, some
1261 * configured queues may not have been included in the iteration. */
1263 netdev_dump_queues(const struct netdev
*netdev
,
1264 netdev_dump_queues_cb
*cb
, void *aux
)
1266 const struct netdev_class
*class = netdev_get_dev(netdev
)->netdev_class
;
1267 return (class->dump_queues
1268 ? class->dump_queues(netdev
, cb
, aux
)
1272 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1273 * its statistics, and the 'aux' specified by the caller. The order of
1274 * iteration is unspecified, but (when successful) each queue is visited
1277 * Calling this function may be more efficient than calling
1278 * netdev_get_queue_stats() for every queue.
1280 * 'cb' must not modify or free the statistics passed in.
1282 * Returns 0 if successful, otherwise a positive errno value. On error, some
1283 * configured queues may not have been included in the iteration. */
1285 netdev_dump_queue_stats(const struct netdev
*netdev
,
1286 netdev_dump_queue_stats_cb
*cb
, void *aux
)
1288 const struct netdev_class
*class = netdev_get_dev(netdev
)->netdev_class
;
1289 return (class->dump_queue_stats
1290 ? class->dump_queue_stats(netdev
, cb
, aux
)
1294 /* Returns a sequence number which indicates changes in one of 'netdev''s
1295 * properties. The returned sequence will be nonzero so that callers have a
1296 * value which they may use as a reset when tracking 'netdev'.
1298 * The returned sequence number will change whenever 'netdev''s flags,
1299 * features, ethernet address, or carrier changes. It may change for other
1300 * reasons as well, or no reason at all. */
1302 netdev_change_seq(const struct netdev
*netdev
)
1304 return netdev_get_dev(netdev
)->netdev_class
->change_seq(netdev
);
1307 /* Initializes 'netdev_dev' as a netdev device named 'name' of the specified
1308 * 'netdev_class'. This function is ordinarily called from a netdev provider's
1309 * 'create' function.
1311 * This function adds 'netdev_dev' to a netdev-owned shash, so it is
1312 * very important that 'netdev_dev' only be freed after calling
1313 * the refcount drops to zero. */
1315 netdev_dev_init(struct netdev_dev
*netdev_dev
, const char *name
,
1316 const struct netdev_class
*netdev_class
)
1318 ovs_assert(!shash_find(&netdev_dev_shash
, name
));
1320 memset(netdev_dev
, 0, sizeof *netdev_dev
);
1321 netdev_dev
->netdev_class
= netdev_class
;
1322 netdev_dev
->name
= xstrdup(name
);
1323 netdev_dev
->node
= shash_add(&netdev_dev_shash
, name
, netdev_dev
);
1326 /* Undoes the results of initialization.
1328 * Normally this function does not need to be called as netdev_close has
1329 * the same effect when the refcount drops to zero.
1330 * However, it may be called by providers due to an error on creation
1331 * that occurs after initialization. It this case netdev_close() would
1332 * never be called. */
1334 netdev_dev_uninit(struct netdev_dev
*netdev_dev
, bool destroy
)
1336 char *name
= netdev_dev
->name
;
1338 ovs_assert(!netdev_dev
->ref_cnt
);
1340 shash_delete(&netdev_dev_shash
, netdev_dev
->node
);
1343 netdev_dev
->netdev_class
->destroy(netdev_dev
);
1348 /* Returns the class type of 'netdev_dev'.
1350 * The caller must not free the returned value. */
1352 netdev_dev_get_type(const struct netdev_dev
*netdev_dev
)
1354 return netdev_dev
->netdev_class
->type
;
1357 /* Returns the class associated with 'netdev_dev'. */
1358 const struct netdev_class
*
1359 netdev_dev_get_class(const struct netdev_dev
*netdev_dev
)
1361 return netdev_dev
->netdev_class
;
1364 /* Returns the name of 'netdev_dev'.
1366 * The caller must not free the returned value. */
1368 netdev_dev_get_name(const struct netdev_dev
*netdev_dev
)
1370 return netdev_dev
->name
;
1373 /* Returns the netdev_dev with 'name' or NULL if there is none.
1375 * The caller must not free the returned value. */
1377 netdev_dev_from_name(const char *name
)
1379 return shash_find_data(&netdev_dev_shash
, name
);
1382 /* Fills 'device_list' with devices that match 'netdev_class'.
1384 * The caller is responsible for initializing and destroying 'device_list'
1385 * but the contained netdev_devs must not be freed. */
1387 netdev_dev_get_devices(const struct netdev_class
*netdev_class
,
1388 struct shash
*device_list
)
1390 struct shash_node
*node
;
1391 SHASH_FOR_EACH (node
, &netdev_dev_shash
) {
1392 struct netdev_dev
*dev
= node
->data
;
1394 if (dev
->netdev_class
== netdev_class
) {
1395 shash_add(device_list
, node
->name
, node
->data
);
1400 /* Initializes 'netdev' as a instance of the netdev_dev.
1402 * This function adds 'netdev' to a netdev-owned linked list, so it is very
1403 * important that 'netdev' only be freed after calling netdev_close(). */
1405 netdev_init(struct netdev
*netdev
, struct netdev_dev
*netdev_dev
)
1407 memset(netdev
, 0, sizeof *netdev
);
1408 netdev
->netdev_dev
= netdev_dev
;
1409 list_push_back(&netdev_list
, &netdev
->node
);
1412 /* Undoes the results of initialization.
1414 * Normally this function only needs to be called from netdev_close().
1415 * However, it may be called by providers due to an error on opening
1416 * that occurs after initialization. It this case netdev_close() would
1417 * never be called. */
1419 netdev_uninit(struct netdev
*netdev
, bool close
)
1421 /* Restore flags that we changed, if any. */
1422 int error
= restore_flags(netdev
);
1423 list_remove(&netdev
->node
);
1425 VLOG_WARN("failed to restore network device flags on %s: %s",
1426 netdev_get_name(netdev
), strerror(error
));
1430 netdev_get_dev(netdev
)->netdev_class
->close(netdev
);
1435 /* Returns the class type of 'netdev'.
1437 * The caller must not free the returned value. */
1439 netdev_get_type(const struct netdev
*netdev
)
1441 return netdev_get_dev(netdev
)->netdev_class
->type
;
1445 netdev_get_dev(const struct netdev
*netdev
)
1447 return netdev
->netdev_dev
;
1450 /* Restore the network device flags on 'netdev' to those that were active
1451 * before we changed them. Returns 0 if successful, otherwise a positive
1454 * To avoid reentry, the caller must ensure that fatal signals are blocked. */
1456 restore_flags(struct netdev
*netdev
)
1458 if (netdev
->changed_flags
) {
1459 enum netdev_flags restore
= netdev
->save_flags
& netdev
->changed_flags
;
1460 enum netdev_flags old_flags
;
1461 return netdev_get_dev(netdev
)->netdev_class
->update_flags(netdev
,
1462 netdev
->changed_flags
& ~restore
,
1463 restore
, &old_flags
);
1468 /* Close all netdevs on shutdown so they can do any needed cleanup such as
1469 * destroying devices, restoring flags, etc. */
1471 close_all_netdevs(void *aux OVS_UNUSED
)
1473 struct netdev
*netdev
, *next
;
1474 LIST_FOR_EACH_SAFE(netdev
, next
, node
, &netdev_list
) {
1475 netdev_close(netdev
);