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>
29 #include "dynamic-string.h"
30 #include "fatal-signal.h"
33 #include "netdev-provider.h"
34 #include "netdev-vport.h"
36 #include "openflow/openflow.h"
38 #include "poll-loop.h"
45 VLOG_DEFINE_THIS_MODULE(netdev
);
47 COVERAGE_DEFINE(netdev_received
);
48 COVERAGE_DEFINE(netdev_sent
);
49 COVERAGE_DEFINE(netdev_add_router
);
50 COVERAGE_DEFINE(netdev_get_stats
);
52 struct netdev_saved_flags
{
53 struct netdev
*netdev
;
54 struct list node
; /* In struct netdev's saved_flags_list. */
55 enum netdev_flags saved_flags
;
56 enum netdev_flags saved_values
;
59 static struct shash netdev_classes
= SHASH_INITIALIZER(&netdev_classes
);
61 /* All created network devices. */
62 static struct shash netdev_shash
= SHASH_INITIALIZER(&netdev_shash
);
64 /* This is set pretty low because we probably won't learn anything from the
65 * additional log messages. */
66 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(5, 20);
68 static void restore_all_flags(void *aux OVS_UNUSED
);
69 void update_device_args(struct netdev
*, const struct shash
*args
);
72 netdev_initialize(void)
79 fatal_signal_add_hook(restore_all_flags
, NULL
, NULL
, true);
80 netdev_vport_patch_register();
83 netdev_register_provider(&netdev_linux_class
);
84 netdev_register_provider(&netdev_internal_class
);
85 netdev_register_provider(&netdev_tap_class
);
86 netdev_vport_tunnel_register();
88 #if defined(__FreeBSD__) || defined(__NetBSD__)
89 netdev_register_provider(&netdev_tap_class
);
90 netdev_register_provider(&netdev_bsd_class
);
95 /* Performs periodic work needed by all the various kinds of netdevs.
97 * If your program opens any netdevs, it must call this function within its
102 struct shash_node
*node
;
103 SHASH_FOR_EACH(node
, &netdev_classes
) {
104 const struct netdev_class
*netdev_class
= node
->data
;
105 if (netdev_class
->run
) {
111 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
113 * If your program opens any netdevs, it must call this function within its
118 struct shash_node
*node
;
119 SHASH_FOR_EACH(node
, &netdev_classes
) {
120 const struct netdev_class
*netdev_class
= node
->data
;
121 if (netdev_class
->wait
) {
122 netdev_class
->wait();
127 /* Initializes and registers a new netdev provider. After successful
128 * registration, new netdevs of that type can be opened using netdev_open(). */
130 netdev_register_provider(const struct netdev_class
*new_class
)
132 if (shash_find(&netdev_classes
, new_class
->type
)) {
133 VLOG_WARN("attempted to register duplicate netdev provider: %s",
138 if (new_class
->init
) {
139 int error
= new_class
->init();
141 VLOG_ERR("failed to initialize %s network device class: %s",
142 new_class
->type
, ovs_strerror(error
));
147 shash_add(&netdev_classes
, new_class
->type
, new_class
);
152 /* Unregisters a netdev provider. 'type' must have been previously
153 * registered and not currently be in use by any netdevs. After unregistration
154 * new netdevs of that type cannot be opened using netdev_open(). */
156 netdev_unregister_provider(const char *type
)
158 struct shash_node
*del_node
, *netdev_node
;
160 del_node
= shash_find(&netdev_classes
, type
);
162 VLOG_WARN("attempted to unregister a netdev provider that is not "
163 "registered: %s", type
);
167 SHASH_FOR_EACH (netdev_node
, &netdev_shash
) {
168 struct netdev
*netdev
= netdev_node
->data
;
169 if (!strcmp(netdev
->netdev_class
->type
, type
)) {
170 VLOG_WARN("attempted to unregister in use netdev provider: %s",
176 shash_delete(&netdev_classes
, del_node
);
181 const struct netdev_class
*
182 netdev_lookup_provider(const char *type
)
185 return shash_find_data(&netdev_classes
, type
&& type
[0] ? type
: "system");
188 /* Clears 'types' and enumerates the types of all currently registered netdev
189 * providers into it. The caller must first initialize the sset. */
191 netdev_enumerate_types(struct sset
*types
)
193 struct shash_node
*node
;
198 SHASH_FOR_EACH(node
, &netdev_classes
) {
199 const struct netdev_class
*netdev_class
= node
->data
;
200 sset_add(types
, netdev_class
->type
);
204 /* Check that the network device name is not the same as any of the registered
205 * vport providers' dpif_port name (dpif_port is NULL if the vport provider
206 * does not define it) or the datapath internal port name (e.g. ovs-system).
208 * Returns true if there is a name conflict, false otherwise. */
210 netdev_is_reserved_name(const char *name
)
212 struct shash_node
*node
;
215 SHASH_FOR_EACH (node
, &netdev_classes
) {
216 const char *dpif_port
;
217 dpif_port
= netdev_vport_class_get_dpif_port(node
->data
);
218 if (dpif_port
&& !strcmp(dpif_port
, name
)) {
223 if (!strncmp(name
, "ovs-", 4)) {
228 dp_enumerate_types(&types
);
229 SSET_FOR_EACH (type
, &types
) {
230 if (!strcmp(name
+4, type
)) {
231 sset_destroy(&types
);
235 sset_destroy(&types
);
241 /* Opens the network device named 'name' (e.g. "eth0") of the specified 'type'
242 * (e.g. "system") and returns zero if successful, otherwise a positive errno
243 * value. On success, sets '*netdevp' to the new network device, otherwise to
246 * Some network devices may need to be configured (with netdev_set_config())
247 * before they can be used. */
249 netdev_open(const char *name
, const char *type
, struct netdev
**netdevp
)
251 struct netdev
*netdev
;
257 netdev
= shash_find_data(&netdev_shash
, name
);
259 const struct netdev_class
*class;
261 class = netdev_lookup_provider(type
);
263 VLOG_WARN("could not create netdev %s of unknown type %s",
267 error
= class->create(class, name
, &netdev
);
271 ovs_assert(netdev
->netdev_class
== class);
280 /* Returns a reference to 'netdev_' for the caller to own. Returns null if
281 * 'netdev_' is null. */
283 netdev_ref(const struct netdev
*netdev_
)
285 struct netdev
*netdev
= CONST_CAST(struct netdev
*, netdev_
);
288 ovs_assert(netdev
->ref_cnt
> 0);
294 /* Reconfigures the device 'netdev' with 'args'. 'args' may be empty
295 * or NULL if none are needed. */
297 netdev_set_config(struct netdev
*netdev
, const struct smap
*args
)
299 if (netdev
->netdev_class
->set_config
) {
300 struct smap no_args
= SMAP_INITIALIZER(&no_args
);
301 return netdev
->netdev_class
->set_config(netdev
,
302 args
? args
: &no_args
);
303 } else if (args
&& !smap_is_empty(args
)) {
304 VLOG_WARN("%s: arguments provided to device that is not configurable",
305 netdev_get_name(netdev
));
311 /* Returns the current configuration for 'netdev' in 'args'. The caller must
312 * have already initialized 'args' with smap_init(). Returns 0 on success, in
313 * which case 'args' will be filled with 'netdev''s configuration. On failure
314 * returns a positive errno value, in which case 'args' will be empty.
316 * The caller owns 'args' and its contents and must eventually free them with
319 netdev_get_config(const struct netdev
*netdev
, struct smap
*args
)
324 if (netdev
->netdev_class
->get_config
) {
325 error
= netdev
->netdev_class
->get_config(netdev
, args
);
336 const struct netdev_tunnel_config
*
337 netdev_get_tunnel_config(const struct netdev
*netdev
)
339 if (netdev
->netdev_class
->get_tunnel_config
) {
340 return netdev
->netdev_class
->get_tunnel_config(netdev
);
347 netdev_unref(struct netdev
*dev
)
349 ovs_assert(dev
->ref_cnt
);
350 if (!--dev
->ref_cnt
) {
351 netdev_uninit(dev
, true);
355 /* Closes and destroys 'netdev'. */
357 netdev_close(struct netdev
*netdev
)
360 netdev_unref(netdev
);
364 /* Parses 'netdev_name_', which is of the form [type@]name into its component
365 * pieces. 'name' and 'type' must be freed by the caller. */
367 netdev_parse_name(const char *netdev_name_
, char **name
, char **type
)
369 char *netdev_name
= xstrdup(netdev_name_
);
372 separator
= strchr(netdev_name
, '@');
376 *name
= xstrdup(separator
+ 1);
379 *type
= xstrdup("system");
384 netdev_rx_open(struct netdev
*netdev
, struct netdev_rx
**rxp
)
388 error
= (netdev
->netdev_class
->rx_open
389 ? netdev
->netdev_class
->rx_open(netdev
, rxp
)
392 ovs_assert((*rxp
)->netdev
== netdev
);
401 netdev_rx_close(struct netdev_rx
*rx
)
404 struct netdev
*dev
= rx
->netdev
;
406 rx
->rx_class
->destroy(rx
);
412 netdev_rx_recv(struct netdev_rx
*rx
, struct ofpbuf
*buffer
)
416 ovs_assert(buffer
->size
== 0);
417 ovs_assert(ofpbuf_tailroom(buffer
) >= ETH_TOTAL_MIN
);
419 retval
= rx
->rx_class
->recv(rx
, buffer
->data
, ofpbuf_tailroom(buffer
));
421 COVERAGE_INC(netdev_received
);
422 buffer
->size
+= retval
;
423 if (buffer
->size
< ETH_TOTAL_MIN
) {
424 ofpbuf_put_zeros(buffer
, ETH_TOTAL_MIN
- buffer
->size
);
433 netdev_rx_wait(struct netdev_rx
*rx
)
435 rx
->rx_class
->wait(rx
);
439 netdev_rx_drain(struct netdev_rx
*rx
)
441 return rx
->rx_class
->drain
? rx
->rx_class
->drain(rx
) : 0;
444 /* Sends 'buffer' on 'netdev'. Returns 0 if successful, otherwise a positive
445 * errno value. Returns EAGAIN without blocking if the packet cannot be queued
446 * immediately. Returns EMSGSIZE if a partial packet was transmitted or if
447 * the packet is too big or too small to transmit on the device.
449 * The caller retains ownership of 'buffer' in all cases.
451 * The kernel maintains a packet transmission queue, so the caller is not
452 * expected to do additional queuing of packets.
454 * Some network devices may not implement support for this function. In such
455 * cases this function will always return EOPNOTSUPP. */
457 netdev_send(struct netdev
*netdev
, const struct ofpbuf
*buffer
)
461 error
= (netdev
->netdev_class
->send
462 ? netdev
->netdev_class
->send(netdev
, buffer
->data
, buffer
->size
)
465 COVERAGE_INC(netdev_sent
);
470 /* Registers with the poll loop to wake up from the next call to poll_block()
471 * when the packet transmission queue has sufficient room to transmit a packet
472 * with netdev_send().
474 * The kernel maintains a packet transmission queue, so the client is not
475 * expected to do additional queuing of packets. Thus, this function is
476 * unlikely to ever be used. It is included for completeness. */
478 netdev_send_wait(struct netdev
*netdev
)
480 if (netdev
->netdev_class
->send_wait
) {
481 netdev
->netdev_class
->send_wait(netdev
);
485 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
486 * otherwise a positive errno value. */
488 netdev_set_etheraddr(struct netdev
*netdev
, const uint8_t mac
[ETH_ADDR_LEN
])
490 return netdev
->netdev_class
->set_etheraddr(netdev
, mac
);
493 /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
494 * the MAC address into 'mac'. On failure, returns a positive errno value and
495 * clears 'mac' to all-zeros. */
497 netdev_get_etheraddr(const struct netdev
*netdev
, uint8_t mac
[ETH_ADDR_LEN
])
499 return netdev
->netdev_class
->get_etheraddr(netdev
, mac
);
502 /* Returns the name of the network device that 'netdev' represents,
503 * e.g. "eth0". The caller must not modify or free the returned string. */
505 netdev_get_name(const struct netdev
*netdev
)
510 /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
511 * (and received) packets, in bytes, not including the hardware header; thus,
512 * this is typically 1500 bytes for Ethernet devices.
514 * If successful, returns 0 and stores the MTU size in '*mtup'. Returns
515 * EOPNOTSUPP if 'netdev' does not have an MTU (as e.g. some tunnels do not).
516 * On other failure, returns a positive errno value. On failure, sets '*mtup'
519 netdev_get_mtu(const struct netdev
*netdev
, int *mtup
)
521 const struct netdev_class
*class = netdev
->netdev_class
;
524 error
= class->get_mtu
? class->get_mtu(netdev
, mtup
) : EOPNOTSUPP
;
527 if (error
!= EOPNOTSUPP
) {
528 VLOG_DBG_RL(&rl
, "failed to retrieve MTU for network device %s: "
529 "%s", netdev_get_name(netdev
), ovs_strerror(error
));
535 /* Sets the MTU of 'netdev'. The MTU is the maximum size of transmitted
536 * (and received) packets, in bytes.
538 * If successful, returns 0. Returns EOPNOTSUPP if 'netdev' does not have an
539 * MTU (as e.g. some tunnels do not). On other failure, returns a positive
542 netdev_set_mtu(const struct netdev
*netdev
, int mtu
)
544 const struct netdev_class
*class = netdev
->netdev_class
;
547 error
= class->set_mtu
? class->set_mtu(netdev
, mtu
) : EOPNOTSUPP
;
548 if (error
&& error
!= EOPNOTSUPP
) {
549 VLOG_DBG_RL(&rl
, "failed to set MTU for network device %s: %s",
550 netdev_get_name(netdev
), ovs_strerror(error
));
556 /* Returns the ifindex of 'netdev', if successful, as a positive number. On
557 * failure, returns a negative errno value.
559 * The desired semantics of the ifindex value are a combination of those
560 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex
561 * value should be unique within a host and remain stable at least until
562 * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber"
563 * but many systems do not follow this rule anyhow.
565 * Some network devices may not implement support for this function. In such
566 * cases this function will always return -EOPNOTSUPP.
569 netdev_get_ifindex(const struct netdev
*netdev
)
571 int (*get_ifindex
)(const struct netdev
*);
573 get_ifindex
= netdev
->netdev_class
->get_ifindex
;
575 return get_ifindex
? get_ifindex(netdev
) : -EOPNOTSUPP
;
578 /* Stores the features supported by 'netdev' into each of '*current',
579 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
580 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
581 * successful, otherwise a positive errno value. On failure, all of the
582 * passed-in values are set to 0.
584 * Some network devices may not implement support for this function. In such
585 * cases this function will always return EOPNOTSUPP. */
587 netdev_get_features(const struct netdev
*netdev
,
588 enum netdev_features
*current
,
589 enum netdev_features
*advertised
,
590 enum netdev_features
*supported
,
591 enum netdev_features
*peer
)
593 int (*get_features
)(const struct netdev
*netdev
,
594 enum netdev_features
*current
,
595 enum netdev_features
*advertised
,
596 enum netdev_features
*supported
,
597 enum netdev_features
*peer
);
598 enum netdev_features dummy
[4];
605 advertised
= &dummy
[1];
608 supported
= &dummy
[2];
614 get_features
= netdev
->netdev_class
->get_features
;
616 ? get_features(netdev
, current
, advertised
, supported
,
620 *current
= *advertised
= *supported
= *peer
= 0;
625 /* Returns the maximum speed of a network connection that has the NETDEV_F_*
626 * bits in 'features', in bits per second. If no bits that indicate a speed
627 * are set in 'features', returns 'default_bps'. */
629 netdev_features_to_bps(enum netdev_features features
,
630 uint64_t default_bps
)
633 F_1000000MB
= NETDEV_F_1TB_FD
,
634 F_100000MB
= NETDEV_F_100GB_FD
,
635 F_40000MB
= NETDEV_F_40GB_FD
,
636 F_10000MB
= NETDEV_F_10GB_FD
,
637 F_1000MB
= NETDEV_F_1GB_HD
| NETDEV_F_1GB_FD
,
638 F_100MB
= NETDEV_F_100MB_HD
| NETDEV_F_100MB_FD
,
639 F_10MB
= NETDEV_F_10MB_HD
| NETDEV_F_10MB_FD
642 return ( features
& F_1000000MB
? UINT64_C(1000000000000)
643 : features
& F_100000MB
? UINT64_C(100000000000)
644 : features
& F_40000MB
? UINT64_C(40000000000)
645 : features
& F_10000MB
? UINT64_C(10000000000)
646 : features
& F_1000MB
? UINT64_C(1000000000)
647 : features
& F_100MB
? UINT64_C(100000000)
648 : features
& F_10MB
? UINT64_C(10000000)
652 /* Returns true if any of the NETDEV_F_* bits that indicate a full-duplex link
653 * are set in 'features', otherwise false. */
655 netdev_features_is_full_duplex(enum netdev_features features
)
657 return (features
& (NETDEV_F_10MB_FD
| NETDEV_F_100MB_FD
| NETDEV_F_1GB_FD
658 | NETDEV_F_10GB_FD
| NETDEV_F_40GB_FD
659 | NETDEV_F_100GB_FD
| NETDEV_F_1TB_FD
)) != 0;
662 /* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if
663 * successful, otherwise a positive errno value. */
665 netdev_set_advertisements(struct netdev
*netdev
,
666 enum netdev_features advertise
)
668 return (netdev
->netdev_class
->set_advertisements
669 ? netdev
->netdev_class
->set_advertisements(
674 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
675 * and '*netmask' to its netmask and returns 0. Otherwise, returns a positive
676 * errno value and sets '*address' to 0 (INADDR_ANY).
678 * The following error values have well-defined meanings:
680 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
682 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
684 * 'address' or 'netmask' or both may be null, in which case the address or
685 * netmask is not reported. */
687 netdev_get_in4(const struct netdev
*netdev
,
688 struct in_addr
*address_
, struct in_addr
*netmask_
)
690 struct in_addr address
;
691 struct in_addr netmask
;
694 error
= (netdev
->netdev_class
->get_in4
695 ? netdev
->netdev_class
->get_in4(netdev
,
699 address_
->s_addr
= error
? 0 : address
.s_addr
;
702 netmask_
->s_addr
= error
? 0 : netmask
.s_addr
;
707 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
708 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a
709 * positive errno value. */
711 netdev_set_in4(struct netdev
*netdev
, struct in_addr addr
, struct in_addr mask
)
713 return (netdev
->netdev_class
->set_in4
714 ? netdev
->netdev_class
->set_in4(netdev
, addr
, mask
)
718 /* Obtains ad IPv4 address from device name and save the address in
719 * in4. Returns 0 if successful, otherwise a positive errno value.
722 netdev_get_in4_by_name(const char *device_name
, struct in_addr
*in4
)
724 struct netdev
*netdev
;
727 error
= netdev_open(device_name
, "system", &netdev
);
729 in4
->s_addr
= htonl(0);
733 error
= netdev_get_in4(netdev
, in4
, NULL
);
734 netdev_close(netdev
);
738 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
741 netdev_add_router(struct netdev
*netdev
, struct in_addr router
)
743 COVERAGE_INC(netdev_add_router
);
744 return (netdev
->netdev_class
->add_router
745 ? netdev
->netdev_class
->add_router(netdev
, router
)
749 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
750 * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0,
751 * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a
752 * next hop is found, stores the next hop gateway's address (0 if 'host' is on
753 * a directly connected network) in '*next_hop' and a copy of the name of the
754 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
755 * responsible for freeing '*netdev_name' (by calling free()). */
757 netdev_get_next_hop(const struct netdev
*netdev
,
758 const struct in_addr
*host
, struct in_addr
*next_hop
,
761 int error
= (netdev
->netdev_class
->get_next_hop
762 ? netdev
->netdev_class
->get_next_hop(
763 host
, next_hop
, netdev_name
)
766 next_hop
->s_addr
= 0;
772 /* Populates 'smap' with status information.
774 * Populates 'smap' with 'netdev' specific status information. This
775 * information may be used to populate the status column of the Interface table
776 * as defined in ovs-vswitchd.conf.db(5). */
778 netdev_get_status(const struct netdev
*netdev
, struct smap
*smap
)
780 return (netdev
->netdev_class
->get_status
781 ? netdev
->netdev_class
->get_status(netdev
, smap
)
785 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
786 * returns 0. Otherwise, returns a positive errno value and sets '*in6' to
787 * all-zero-bits (in6addr_any).
789 * The following error values have well-defined meanings:
791 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
793 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
795 * 'in6' may be null, in which case the address itself is not reported. */
797 netdev_get_in6(const struct netdev
*netdev
, struct in6_addr
*in6
)
799 struct in6_addr dummy
;
802 error
= (netdev
->netdev_class
->get_in6
803 ? netdev
->netdev_class
->get_in6(netdev
,
807 memset(in6
, 0, sizeof *in6
);
812 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
813 * 'on'. Returns 0 if successful, otherwise a positive errno value. */
815 do_update_flags(struct netdev
*netdev
, enum netdev_flags off
,
816 enum netdev_flags on
, enum netdev_flags
*old_flagsp
,
817 struct netdev_saved_flags
**sfp
)
819 struct netdev_saved_flags
*sf
= NULL
;
820 enum netdev_flags old_flags
;
823 error
= netdev
->netdev_class
->update_flags(netdev
, off
& ~on
, on
,
826 VLOG_WARN_RL(&rl
, "failed to %s flags for network device %s: %s",
827 off
|| on
? "set" : "get", netdev_get_name(netdev
),
828 ovs_strerror(error
));
830 } else if ((off
|| on
) && sfp
) {
831 enum netdev_flags new_flags
= (old_flags
& ~off
) | on
;
832 enum netdev_flags changed_flags
= old_flags
^ new_flags
;
834 *sfp
= sf
= xmalloc(sizeof *sf
);
836 list_push_front(&netdev
->saved_flags_list
, &sf
->node
);
837 sf
->saved_flags
= changed_flags
;
838 sf
->saved_values
= changed_flags
& new_flags
;
845 *old_flagsp
= old_flags
;
854 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
855 * Returns 0 if successful, otherwise a positive errno value. On failure,
856 * stores 0 into '*flagsp'. */
858 netdev_get_flags(const struct netdev
*netdev_
, enum netdev_flags
*flagsp
)
860 struct netdev
*netdev
= CONST_CAST(struct netdev
*, netdev_
);
861 return do_update_flags(netdev
, 0, 0, flagsp
, NULL
);
864 /* Sets the flags for 'netdev' to 'flags'.
865 * Returns 0 if successful, otherwise a positive errno value. */
867 netdev_set_flags(struct netdev
*netdev
, enum netdev_flags flags
,
868 struct netdev_saved_flags
**sfp
)
870 return do_update_flags(netdev
, -1, flags
, NULL
, sfp
);
873 /* Turns on the specified 'flags' on 'netdev':
875 * - On success, returns 0. If 'sfp' is nonnull, sets '*sfp' to a newly
876 * allocated 'struct netdev_saved_flags *' that may be passed to
877 * netdev_restore_flags() to restore the original values of 'flags' on
878 * 'netdev' (this will happen automatically at program termination if
879 * netdev_restore_flags() is never called) , or to NULL if no flags were
882 * - On failure, returns a positive errno value. If 'sfp' is nonnull, sets
885 netdev_turn_flags_on(struct netdev
*netdev
, enum netdev_flags flags
,
886 struct netdev_saved_flags
**sfp
)
888 return do_update_flags(netdev
, 0, flags
, NULL
, sfp
);
891 /* Turns off the specified 'flags' on 'netdev'. See netdev_turn_flags_on() for
892 * details of the interface. */
894 netdev_turn_flags_off(struct netdev
*netdev
, enum netdev_flags flags
,
895 struct netdev_saved_flags
**sfp
)
897 return do_update_flags(netdev
, flags
, 0, NULL
, sfp
);
900 /* Restores the flags that were saved in 'sf', and destroys 'sf'.
901 * Does nothing if 'sf' is NULL. */
903 netdev_restore_flags(struct netdev_saved_flags
*sf
)
906 struct netdev
*netdev
= sf
->netdev
;
907 enum netdev_flags old_flags
;
909 netdev
->netdev_class
->update_flags(netdev
,
910 sf
->saved_flags
& sf
->saved_values
,
911 sf
->saved_flags
& ~sf
->saved_values
,
913 list_remove(&sf
->node
);
916 netdev_unref(netdev
);
920 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
921 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
922 * returns 0. Otherwise, it returns a positive errno value; in particular,
923 * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
925 netdev_arp_lookup(const struct netdev
*netdev
,
926 ovs_be32 ip
, uint8_t mac
[ETH_ADDR_LEN
])
928 int error
= (netdev
->netdev_class
->arp_lookup
929 ? netdev
->netdev_class
->arp_lookup(netdev
, ip
, mac
)
932 memset(mac
, 0, ETH_ADDR_LEN
);
937 /* Returns true if carrier is active (link light is on) on 'netdev'. */
939 netdev_get_carrier(const struct netdev
*netdev
)
942 enum netdev_flags flags
;
945 netdev_get_flags(netdev
, &flags
);
946 if (!(flags
& NETDEV_UP
)) {
950 if (!netdev
->netdev_class
->get_carrier
) {
954 error
= netdev
->netdev_class
->get_carrier(netdev
, &carrier
);
956 VLOG_DBG("%s: failed to get network device carrier status, assuming "
957 "down: %s", netdev_get_name(netdev
), ovs_strerror(error
));
964 /* Returns the number of times 'netdev''s carrier has changed. */
966 netdev_get_carrier_resets(const struct netdev
*netdev
)
968 return (netdev
->netdev_class
->get_carrier_resets
969 ? netdev
->netdev_class
->get_carrier_resets(netdev
)
973 /* Attempts to force netdev_get_carrier() to poll 'netdev''s MII registers for
974 * link status instead of checking 'netdev''s carrier. 'netdev''s MII
975 * registers will be polled once ever 'interval' milliseconds. If 'netdev'
976 * does not support MII, another method may be used as a fallback. If
977 * 'interval' is less than or equal to zero, reverts netdev_get_carrier() to
978 * its normal behavior.
980 * Returns 0 if successful, otherwise a positive errno value. */
982 netdev_set_miimon_interval(struct netdev
*netdev
, long long int interval
)
984 return (netdev
->netdev_class
->set_miimon_interval
985 ? netdev
->netdev_class
->set_miimon_interval(netdev
, interval
)
989 /* Retrieves current device stats for 'netdev'. */
991 netdev_get_stats(const struct netdev
*netdev
, struct netdev_stats
*stats
)
995 COVERAGE_INC(netdev_get_stats
);
996 error
= (netdev
->netdev_class
->get_stats
997 ? netdev
->netdev_class
->get_stats(netdev
, stats
)
1000 memset(stats
, 0xff, sizeof *stats
);
1005 /* Attempts to change the stats for 'netdev' to those provided in 'stats'.
1006 * Returns 0 if successful, otherwise a positive errno value.
1008 * This will probably fail for most network devices. Some devices might only
1009 * allow setting their stats to 0. */
1011 netdev_set_stats(struct netdev
*netdev
, const struct netdev_stats
*stats
)
1013 return (netdev
->netdev_class
->set_stats
1014 ? netdev
->netdev_class
->set_stats(netdev
, stats
)
1018 /* Attempts to set input rate limiting (policing) policy, such that up to
1019 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
1020 * size of 'kbits' kb. */
1022 netdev_set_policing(struct netdev
*netdev
, uint32_t kbits_rate
,
1023 uint32_t kbits_burst
)
1025 return (netdev
->netdev_class
->set_policing
1026 ? netdev
->netdev_class
->set_policing(netdev
,
1027 kbits_rate
, kbits_burst
)
1031 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
1032 * empty if 'netdev' does not support QoS. Any names added to 'types' should
1033 * be documented as valid for the "type" column in the "QoS" table in
1034 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1036 * Every network device supports disabling QoS with a type of "", but this type
1037 * will not be added to 'types'.
1039 * The caller must initialize 'types' (e.g. with sset_init()) before calling
1040 * this function. The caller is responsible for destroying 'types' (e.g. with
1041 * sset_destroy()) when it is no longer needed.
1043 * Returns 0 if successful, otherwise a positive errno value. */
1045 netdev_get_qos_types(const struct netdev
*netdev
, struct sset
*types
)
1047 const struct netdev_class
*class = netdev
->netdev_class
;
1048 return (class->get_qos_types
1049 ? class->get_qos_types(netdev
, types
)
1053 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
1054 * which should be "" or one of the types returned by netdev_get_qos_types()
1055 * for 'netdev'. Returns 0 if successful, otherwise a positive errno value.
1056 * On success, initializes 'caps' with the QoS capabilities; on failure, clears
1057 * 'caps' to all zeros. */
1059 netdev_get_qos_capabilities(const struct netdev
*netdev
, const char *type
,
1060 struct netdev_qos_capabilities
*caps
)
1062 const struct netdev_class
*class = netdev
->netdev_class
;
1065 int retval
= (class->get_qos_capabilities
1066 ? class->get_qos_capabilities(netdev
, type
, caps
)
1069 memset(caps
, 0, sizeof *caps
);
1073 /* Every netdev supports turning off QoS. */
1074 memset(caps
, 0, sizeof *caps
);
1079 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
1080 * of QoS. Returns 0 if successful, otherwise a positive errno value. Stores
1081 * the number of queues (zero on failure) in '*n_queuesp'.
1083 * This is just a simple wrapper around netdev_get_qos_capabilities(). */
1085 netdev_get_n_queues(const struct netdev
*netdev
,
1086 const char *type
, unsigned int *n_queuesp
)
1088 struct netdev_qos_capabilities caps
;
1091 retval
= netdev_get_qos_capabilities(netdev
, type
, &caps
);
1092 *n_queuesp
= caps
.n_queues
;
1096 /* Queries 'netdev' about its currently configured form of QoS. If successful,
1097 * stores the name of the current form of QoS into '*typep', stores any details
1098 * of configuration as string key-value pairs in 'details', and returns 0. On
1099 * failure, sets '*typep' to NULL and returns a positive errno value.
1101 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1103 * The caller must initialize 'details' as an empty smap (e.g. with
1104 * smap_init()) before calling this function. The caller must free 'details'
1105 * when it is no longer needed (e.g. with smap_destroy()).
1107 * The caller must not modify or free '*typep'.
1109 * '*typep' will be one of the types returned by netdev_get_qos_types() for
1110 * 'netdev'. The contents of 'details' should be documented as valid for
1111 * '*typep' in the "other_config" column in the "QoS" table in
1112 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1114 netdev_get_qos(const struct netdev
*netdev
,
1115 const char **typep
, struct smap
*details
)
1117 const struct netdev_class
*class = netdev
->netdev_class
;
1120 if (class->get_qos
) {
1121 retval
= class->get_qos(netdev
, typep
, details
);
1124 smap_clear(details
);
1128 /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1134 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1135 * with details of configuration from 'details'. Returns 0 if successful,
1136 * otherwise a positive errno value. On error, the previous QoS configuration
1139 * When this function changes the type of QoS (not just 'details'), this also
1140 * resets all queue configuration for 'netdev' to their defaults (which depend
1141 * on the specific type of QoS). Otherwise, the queue configuration for
1142 * 'netdev' is unchanged.
1144 * 'type' should be "" (to disable QoS) or one of the types returned by
1145 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should be
1146 * documented as valid for the given 'type' in the "other_config" column in the
1147 * "QoS" table in vswitchd/vswitch.xml (which is built as
1148 * ovs-vswitchd.conf.db(8)).
1150 * NULL may be specified for 'details' if there are no configuration
1153 netdev_set_qos(struct netdev
*netdev
,
1154 const char *type
, const struct smap
*details
)
1156 const struct netdev_class
*class = netdev
->netdev_class
;
1162 if (class->set_qos
) {
1164 static const struct smap empty
= SMAP_INITIALIZER(&empty
);
1167 return class->set_qos(netdev
, type
, details
);
1169 return *type
? EOPNOTSUPP
: 0;
1173 /* Queries 'netdev' for information about the queue numbered 'queue_id'. If
1174 * successful, adds that information as string key-value pairs to 'details'.
1175 * Returns 0 if successful, otherwise a positive errno value.
1177 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1178 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1180 * The returned contents of 'details' should be documented as valid for the
1181 * given 'type' in the "other_config" column in the "Queue" table in
1182 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1184 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1185 * this function. The caller must free 'details' when it is no longer needed
1186 * (e.g. with smap_destroy()). */
1188 netdev_get_queue(const struct netdev
*netdev
,
1189 unsigned int queue_id
, struct smap
*details
)
1191 const struct netdev_class
*class = netdev
->netdev_class
;
1194 retval
= (class->get_queue
1195 ? class->get_queue(netdev
, queue_id
, details
)
1198 smap_clear(details
);
1203 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1204 * string pairs in 'details'. The contents of 'details' should be documented
1205 * as valid for the given 'type' in the "other_config" column in the "Queue"
1206 * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1207 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1208 * given queue's configuration should be unmodified.
1210 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1211 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1213 * This function does not modify 'details', and the caller retains ownership of
1216 netdev_set_queue(struct netdev
*netdev
,
1217 unsigned int queue_id
, const struct smap
*details
)
1219 const struct netdev_class
*class = netdev
->netdev_class
;
1220 return (class->set_queue
1221 ? class->set_queue(netdev
, queue_id
, details
)
1225 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'. Some kinds
1226 * of QoS may have a fixed set of queues, in which case attempts to delete them
1227 * will fail with EOPNOTSUPP.
1229 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1230 * given queue will be unmodified.
1232 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1233 * the current form of QoS (e.g. as returned by
1234 * netdev_get_n_queues(netdev)). */
1236 netdev_delete_queue(struct netdev
*netdev
, unsigned int queue_id
)
1238 const struct netdev_class
*class = netdev
->netdev_class
;
1239 return (class->delete_queue
1240 ? class->delete_queue(netdev
, queue_id
)
1244 /* Obtains statistics about 'queue_id' on 'netdev'. On success, returns 0 and
1245 * fills 'stats' with the queue's statistics; individual members of 'stats' may
1246 * be set to all-1-bits if the statistic is unavailable. On failure, returns a
1247 * positive errno value and fills 'stats' with values indicating unsupported
1250 netdev_get_queue_stats(const struct netdev
*netdev
, unsigned int queue_id
,
1251 struct netdev_queue_stats
*stats
)
1253 const struct netdev_class
*class = netdev
->netdev_class
;
1256 retval
= (class->get_queue_stats
1257 ? class->get_queue_stats(netdev
, queue_id
, stats
)
1260 stats
->tx_bytes
= UINT64_MAX
;
1261 stats
->tx_packets
= UINT64_MAX
;
1262 stats
->tx_errors
= UINT64_MAX
;
1263 stats
->created
= LLONG_MIN
;
1268 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1269 * its configuration, and the 'aux' specified by the caller. The order of
1270 * iteration is unspecified, but (when successful) each queue is visited
1273 * Calling this function may be more efficient than calling netdev_get_queue()
1276 * 'cb' must not modify or free the 'details' argument passed in. It may
1277 * delete or modify the queue passed in as its 'queue_id' argument. It may
1278 * modify but must not delete any other queue within 'netdev'. 'cb' should not
1279 * add new queues because this may cause some queues to be visited twice or not
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_queues(const struct netdev
*netdev
,
1286 netdev_dump_queues_cb
*cb
, void *aux
)
1288 const struct netdev_class
*class = netdev
->netdev_class
;
1289 return (class->dump_queues
1290 ? class->dump_queues(netdev
, cb
, aux
)
1294 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1295 * its statistics, and the 'aux' specified by the caller. The order of
1296 * iteration is unspecified, but (when successful) each queue is visited
1299 * Calling this function may be more efficient than calling
1300 * netdev_get_queue_stats() for every queue.
1302 * 'cb' must not modify or free the statistics passed in.
1304 * Returns 0 if successful, otherwise a positive errno value. On error, some
1305 * configured queues may not have been included in the iteration. */
1307 netdev_dump_queue_stats(const struct netdev
*netdev
,
1308 netdev_dump_queue_stats_cb
*cb
, void *aux
)
1310 const struct netdev_class
*class = netdev
->netdev_class
;
1311 return (class->dump_queue_stats
1312 ? class->dump_queue_stats(netdev
, cb
, aux
)
1316 /* Returns a sequence number which indicates changes in one of 'netdev''s
1317 * properties. The returned sequence will be nonzero so that callers have a
1318 * value which they may use as a reset when tracking 'netdev'.
1320 * The returned sequence number will change whenever 'netdev''s flags,
1321 * features, ethernet address, or carrier changes. It may change for other
1322 * reasons as well, or no reason at all. */
1324 netdev_change_seq(const struct netdev
*netdev
)
1326 return netdev
->netdev_class
->change_seq(netdev
);
1329 /* Initializes 'netdev' as a netdev device named 'name' of the specified
1330 * 'netdev_class'. This function is ordinarily called from a netdev provider's
1331 * 'create' function.
1333 * This function adds 'netdev' to a netdev-owned shash, so it is very important
1334 * that 'netdev' only be freed after calling netdev_uninit(). */
1336 netdev_init(struct netdev
*netdev
, const char *name
,
1337 const struct netdev_class
*netdev_class
)
1339 ovs_assert(!shash_find(&netdev_shash
, name
));
1341 memset(netdev
, 0, sizeof *netdev
);
1342 netdev
->netdev_class
= netdev_class
;
1343 netdev
->name
= xstrdup(name
);
1344 netdev
->node
= shash_add(&netdev_shash
, name
, netdev
);
1345 list_init(&netdev
->saved_flags_list
);
1348 /* Undoes the results of initialization.
1350 * Normally this function does not need to be called as netdev_close has
1351 * the same effect when the refcount drops to zero.
1352 * However, it may be called by providers due to an error on creation
1353 * that occurs after initialization. It this case netdev_close() would
1354 * never be called. */
1356 netdev_uninit(struct netdev
*netdev
, bool destroy
)
1358 char *name
= netdev
->name
;
1360 ovs_assert(!netdev
->ref_cnt
);
1361 ovs_assert(list_is_empty(&netdev
->saved_flags_list
));
1363 shash_delete(&netdev_shash
, netdev
->node
);
1366 netdev
->netdev_class
->destroy(netdev
);
1371 /* Returns the class type of 'netdev'.
1373 * The caller must not free the returned value. */
1375 netdev_get_type(const struct netdev
*netdev
)
1377 return netdev
->netdev_class
->type
;
1380 /* Returns the class associated with 'netdev'. */
1381 const struct netdev_class
*
1382 netdev_get_class(const struct netdev
*netdev
)
1384 return netdev
->netdev_class
;
1387 /* Returns the netdev with 'name' or NULL if there is none.
1389 * The caller must not free the returned value. */
1391 netdev_from_name(const char *name
)
1393 return shash_find_data(&netdev_shash
, name
);
1396 /* Fills 'device_list' with devices that match 'netdev_class'.
1398 * The caller is responsible for initializing and destroying 'device_list' and
1399 * must close each device on the list. */
1401 netdev_get_devices(const struct netdev_class
*netdev_class
,
1402 struct shash
*device_list
)
1404 struct shash_node
*node
;
1405 SHASH_FOR_EACH (node
, &netdev_shash
) {
1406 struct netdev
*dev
= node
->data
;
1408 if (dev
->netdev_class
== netdev_class
) {
1410 shash_add(device_list
, node
->name
, node
->data
);
1416 netdev_get_type_from_name(const char *name
)
1418 const struct netdev
*dev
= netdev_from_name(name
);
1419 return dev
? netdev_get_type(dev
) : NULL
;
1423 netdev_rx_init(struct netdev_rx
*rx
, struct netdev
*netdev
,
1424 const struct netdev_rx_class
*class)
1426 ovs_assert(netdev
->ref_cnt
> 0);
1427 rx
->rx_class
= class;
1428 rx
->netdev
= netdev
;
1432 netdev_rx_uninit(struct netdev_rx
*rx OVS_UNUSED
)
1434 /* Nothing to do. */
1438 netdev_rx_get_netdev(const struct netdev_rx
*rx
)
1440 ovs_assert(rx
->netdev
->ref_cnt
> 0);
1445 netdev_rx_get_name(const struct netdev_rx
*rx
)
1447 return netdev_get_name(netdev_rx_get_netdev(rx
));
1451 restore_all_flags(void *aux OVS_UNUSED
)
1453 struct shash_node
*node
;
1455 SHASH_FOR_EACH (node
, &netdev_shash
) {
1456 struct netdev
*netdev
= node
->data
;
1457 const struct netdev_saved_flags
*sf
;
1458 enum netdev_flags saved_values
;
1459 enum netdev_flags saved_flags
;
1461 saved_values
= saved_flags
= 0;
1462 LIST_FOR_EACH (sf
, node
, &netdev
->saved_flags_list
) {
1463 saved_flags
|= sf
->saved_flags
;
1464 saved_values
&= ~sf
->saved_flags
;
1465 saved_values
|= sf
->saved_flags
& sf
->saved_values
;
1468 enum netdev_flags old_flags
;
1470 netdev
->netdev_class
->update_flags(netdev
,
1471 saved_flags
& saved_values
,
1472 saved_flags
& ~saved_values
,