2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 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-dpdk.h"
34 #include "netdev-provider.h"
35 #include "netdev-vport.h"
37 #include "openflow/openflow.h"
39 #include "poll-loop.h"
46 VLOG_DEFINE_THIS_MODULE(netdev
);
48 COVERAGE_DEFINE(netdev_received
);
49 COVERAGE_DEFINE(netdev_sent
);
50 COVERAGE_DEFINE(netdev_add_router
);
51 COVERAGE_DEFINE(netdev_get_stats
);
53 struct netdev_saved_flags
{
54 struct netdev
*netdev
;
55 struct list node
; /* In struct netdev's saved_flags_list. */
56 enum netdev_flags saved_flags
;
57 enum netdev_flags saved_values
;
60 /* Protects 'netdev_shash' and the mutable members of struct netdev. */
61 static struct ovs_mutex netdev_mutex
= OVS_MUTEX_INITIALIZER
;
63 /* All created network devices. */
64 static struct shash netdev_shash
OVS_GUARDED_BY(netdev_mutex
)
65 = SHASH_INITIALIZER(&netdev_shash
);
67 /* Protects 'netdev_classes' against insertions or deletions.
69 * This is a recursive mutex to allow recursive acquisition when calling into
70 * providers. For example, netdev_run() calls into provider 'run' functions,
71 * which might reasonably want to call one of the netdev functions that takes
72 * netdev_class_mutex. */
73 static struct ovs_mutex netdev_class_mutex
OVS_ACQ_BEFORE(netdev_mutex
);
75 /* Contains 'struct netdev_registered_class'es. */
76 static struct hmap netdev_classes
OVS_GUARDED_BY(netdev_class_mutex
)
77 = HMAP_INITIALIZER(&netdev_classes
);
79 struct netdev_registered_class
{
80 /* In 'netdev_classes', by class->type. */
81 struct hmap_node hmap_node
OVS_GUARDED_BY(netdev_class_mutex
);
82 const struct netdev_class
*class OVS_GUARDED_BY(netdev_class_mutex
);
83 /* Number of 'struct netdev's of this class. */
84 int ref_cnt
OVS_GUARDED_BY(netdev_class_mutex
);
87 /* This is set pretty low because we probably won't learn anything from the
88 * additional log messages. */
89 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(5, 20);
91 static void restore_all_flags(void *aux OVS_UNUSED
);
92 void update_device_args(struct netdev
*, const struct shash
*args
);
95 netdev_n_rxq(const struct netdev
*netdev
)
101 netdev_is_pmd(const struct netdev
*netdev
)
103 return (!strcmp(netdev
->netdev_class
->type
, "dpdk") ||
104 !strcmp(netdev
->netdev_class
->type
, "dpdkr"));
108 netdev_class_mutex_initialize(void)
109 OVS_EXCLUDED(netdev_class_mutex
, netdev_mutex
)
111 static struct ovsthread_once once
= OVSTHREAD_ONCE_INITIALIZER
;
113 if (ovsthread_once_start(&once
)) {
114 ovs_mutex_init_recursive(&netdev_class_mutex
);
115 ovsthread_once_done(&once
);
120 netdev_initialize(void)
121 OVS_EXCLUDED(netdev_class_mutex
, netdev_mutex
)
123 static struct ovsthread_once once
= OVSTHREAD_ONCE_INITIALIZER
;
125 if (ovsthread_once_start(&once
)) {
126 netdev_class_mutex_initialize();
128 fatal_signal_add_hook(restore_all_flags
, NULL
, NULL
, true);
129 netdev_vport_patch_register();
132 netdev_register_provider(&netdev_linux_class
);
133 netdev_register_provider(&netdev_internal_class
);
134 netdev_register_provider(&netdev_tap_class
);
135 netdev_vport_tunnel_register();
137 #if defined(__FreeBSD__) || defined(__NetBSD__)
138 netdev_register_provider(&netdev_tap_class
);
139 netdev_register_provider(&netdev_bsd_class
);
141 netdev_dpdk_register();
143 ovsthread_once_done(&once
);
147 /* Performs periodic work needed by all the various kinds of netdevs.
149 * If your program opens any netdevs, it must call this function within its
153 OVS_EXCLUDED(netdev_class_mutex
, netdev_mutex
)
155 struct netdev_registered_class
*rc
;
158 ovs_mutex_lock(&netdev_class_mutex
);
159 HMAP_FOR_EACH (rc
, hmap_node
, &netdev_classes
) {
160 if (rc
->class->run
) {
164 ovs_mutex_unlock(&netdev_class_mutex
);
167 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
169 * If your program opens any netdevs, it must call this function within its
173 OVS_EXCLUDED(netdev_class_mutex
, netdev_mutex
)
175 struct netdev_registered_class
*rc
;
177 ovs_mutex_lock(&netdev_class_mutex
);
178 HMAP_FOR_EACH (rc
, hmap_node
, &netdev_classes
) {
179 if (rc
->class->wait
) {
183 ovs_mutex_unlock(&netdev_class_mutex
);
186 static struct netdev_registered_class
*
187 netdev_lookup_class(const char *type
)
188 OVS_REQ_RDLOCK(netdev_class_mutex
)
190 struct netdev_registered_class
*rc
;
192 HMAP_FOR_EACH_WITH_HASH (rc
, hmap_node
, hash_string(type
, 0),
194 if (!strcmp(type
, rc
->class->type
)) {
201 /* Initializes and registers a new netdev provider. After successful
202 * registration, new netdevs of that type can be opened using netdev_open(). */
204 netdev_register_provider(const struct netdev_class
*new_class
)
205 OVS_EXCLUDED(netdev_class_mutex
, netdev_mutex
)
209 netdev_class_mutex_initialize();
210 ovs_mutex_lock(&netdev_class_mutex
);
211 if (netdev_lookup_class(new_class
->type
)) {
212 VLOG_WARN("attempted to register duplicate netdev provider: %s",
216 error
= new_class
->init
? new_class
->init() : 0;
218 struct netdev_registered_class
*rc
;
220 rc
= xmalloc(sizeof *rc
);
221 hmap_insert(&netdev_classes
, &rc
->hmap_node
,
222 hash_string(new_class
->type
, 0));
223 rc
->class = new_class
;
226 VLOG_ERR("failed to initialize %s network device class: %s",
227 new_class
->type
, ovs_strerror(error
));
230 ovs_mutex_unlock(&netdev_class_mutex
);
235 /* Unregisters a netdev provider. 'type' must have been previously
236 * registered and not currently be in use by any netdevs. After unregistration
237 * new netdevs of that type cannot be opened using netdev_open(). */
239 netdev_unregister_provider(const char *type
)
240 OVS_EXCLUDED(netdev_class_mutex
, netdev_mutex
)
242 struct netdev_registered_class
*rc
;
245 ovs_mutex_lock(&netdev_class_mutex
);
246 rc
= netdev_lookup_class(type
);
248 VLOG_WARN("attempted to unregister a netdev provider that is not "
249 "registered: %s", type
);
250 error
= EAFNOSUPPORT
;
253 hmap_remove(&netdev_classes
, &rc
->hmap_node
);
257 VLOG_WARN("attempted to unregister in use netdev provider: %s",
262 ovs_mutex_unlock(&netdev_class_mutex
);
267 /* Clears 'types' and enumerates the types of all currently registered netdev
268 * providers into it. The caller must first initialize the sset. */
270 netdev_enumerate_types(struct sset
*types
)
271 OVS_EXCLUDED(netdev_mutex
)
273 struct netdev_registered_class
*rc
;
278 ovs_mutex_lock(&netdev_class_mutex
);
279 HMAP_FOR_EACH (rc
, hmap_node
, &netdev_classes
) {
280 sset_add(types
, rc
->class->type
);
282 ovs_mutex_unlock(&netdev_class_mutex
);
285 /* Check that the network device name is not the same as any of the registered
286 * vport providers' dpif_port name (dpif_port is NULL if the vport provider
287 * does not define it) or the datapath internal port name (e.g. ovs-system).
289 * Returns true if there is a name conflict, false otherwise. */
291 netdev_is_reserved_name(const char *name
)
292 OVS_EXCLUDED(netdev_mutex
)
294 struct netdev_registered_class
*rc
;
298 ovs_mutex_lock(&netdev_class_mutex
);
299 HMAP_FOR_EACH (rc
, hmap_node
, &netdev_classes
) {
300 const char *dpif_port
= netdev_vport_class_get_dpif_port(rc
->class);
301 if (dpif_port
&& !strncmp(name
, dpif_port
, strlen(dpif_port
))) {
302 ovs_mutex_unlock(&netdev_class_mutex
);
306 ovs_mutex_unlock(&netdev_class_mutex
);
308 if (!strncmp(name
, "ovs-", 4)) {
313 dp_enumerate_types(&types
);
314 SSET_FOR_EACH (type
, &types
) {
315 if (!strcmp(name
+4, type
)) {
316 sset_destroy(&types
);
320 sset_destroy(&types
);
326 /* Opens the network device named 'name' (e.g. "eth0") of the specified 'type'
327 * (e.g. "system") and returns zero if successful, otherwise a positive errno
328 * value. On success, sets '*netdevp' to the new network device, otherwise to
331 * Some network devices may need to be configured (with netdev_set_config())
332 * before they can be used. */
334 netdev_open(const char *name
, const char *type
, struct netdev
**netdevp
)
335 OVS_EXCLUDED(netdev_mutex
)
337 struct netdev
*netdev
;
342 ovs_mutex_lock(&netdev_class_mutex
);
343 ovs_mutex_lock(&netdev_mutex
);
344 netdev
= shash_find_data(&netdev_shash
, name
);
346 struct netdev_registered_class
*rc
;
348 rc
= netdev_lookup_class(type
&& type
[0] ? type
: "system");
350 netdev
= rc
->class->alloc();
352 memset(netdev
, 0, sizeof *netdev
);
353 netdev
->netdev_class
= rc
->class;
354 netdev
->name
= xstrdup(name
);
355 netdev
->change_seq
= 1;
356 netdev
->node
= shash_add(&netdev_shash
, name
, netdev
);
358 /* By default enable one rx queue per netdev. */
359 if (netdev
->netdev_class
->rxq_alloc
) {
364 list_init(&netdev
->saved_flags_list
);
366 error
= rc
->class->construct(netdev
);
369 netdev_change_seq_changed(netdev
);
372 ovs_assert(list_is_empty(&netdev
->saved_flags_list
));
373 shash_delete(&netdev_shash
, netdev
->node
);
374 rc
->class->dealloc(netdev
);
380 VLOG_WARN("could not create netdev %s of unknown type %s",
382 error
= EAFNOSUPPORT
;
394 ovs_mutex_unlock(&netdev_mutex
);
395 ovs_mutex_unlock(&netdev_class_mutex
);
400 /* Returns a reference to 'netdev_' for the caller to own. Returns null if
401 * 'netdev_' is null. */
403 netdev_ref(const struct netdev
*netdev_
)
404 OVS_EXCLUDED(netdev_mutex
)
406 struct netdev
*netdev
= CONST_CAST(struct netdev
*, netdev_
);
409 ovs_mutex_lock(&netdev_mutex
);
410 ovs_assert(netdev
->ref_cnt
> 0);
412 ovs_mutex_unlock(&netdev_mutex
);
417 /* Reconfigures the device 'netdev' with 'args'. 'args' may be empty
418 * or NULL if none are needed. */
420 netdev_set_config(struct netdev
*netdev
, const struct smap
*args
, char **errp
)
421 OVS_EXCLUDED(netdev_mutex
)
423 if (netdev
->netdev_class
->set_config
) {
424 const struct smap no_args
= SMAP_INITIALIZER(&no_args
);
427 error
= netdev
->netdev_class
->set_config(netdev
,
428 args
? args
: &no_args
);
430 VLOG_WARN_BUF(errp
, "%s: could not set configuration (%s)",
431 netdev_get_name(netdev
), ovs_strerror(error
));
434 } else if (args
&& !smap_is_empty(args
)) {
435 VLOG_WARN_BUF(errp
, "%s: arguments provided to device that is not configurable",
436 netdev_get_name(netdev
));
441 /* Returns the current configuration for 'netdev' in 'args'. The caller must
442 * have already initialized 'args' with smap_init(). Returns 0 on success, in
443 * which case 'args' will be filled with 'netdev''s configuration. On failure
444 * returns a positive errno value, in which case 'args' will be empty.
446 * The caller owns 'args' and its contents and must eventually free them with
449 netdev_get_config(const struct netdev
*netdev
, struct smap
*args
)
450 OVS_EXCLUDED(netdev_mutex
)
455 if (netdev
->netdev_class
->get_config
) {
456 error
= netdev
->netdev_class
->get_config(netdev
, args
);
467 const struct netdev_tunnel_config
*
468 netdev_get_tunnel_config(const struct netdev
*netdev
)
469 OVS_EXCLUDED(netdev_mutex
)
471 if (netdev
->netdev_class
->get_tunnel_config
) {
472 return netdev
->netdev_class
->get_tunnel_config(netdev
);
478 /* Returns the id of the numa node the 'netdev' is on. If the function
479 * is not implemented, returns NETDEV_NUMA_UNSPEC. */
481 netdev_get_numa_id(const struct netdev
*netdev
)
483 if (netdev
->netdev_class
->get_numa_id
) {
484 return netdev
->netdev_class
->get_numa_id(netdev
);
486 return NETDEV_NUMA_UNSPEC
;
491 netdev_unref(struct netdev
*dev
)
492 OVS_RELEASES(netdev_mutex
)
494 ovs_assert(dev
->ref_cnt
);
495 if (!--dev
->ref_cnt
) {
496 const struct netdev_class
*class = dev
->netdev_class
;
497 struct netdev_registered_class
*rc
;
499 dev
->netdev_class
->destruct(dev
);
502 shash_delete(&netdev_shash
, dev
->node
);
505 dev
->netdev_class
->dealloc(dev
);
506 ovs_mutex_unlock(&netdev_mutex
);
508 ovs_mutex_lock(&netdev_class_mutex
);
509 rc
= netdev_lookup_class(class->type
);
510 ovs_assert(rc
->ref_cnt
> 0);
512 ovs_mutex_unlock(&netdev_class_mutex
);
514 ovs_mutex_unlock(&netdev_mutex
);
518 /* Closes and destroys 'netdev'. */
520 netdev_close(struct netdev
*netdev
)
521 OVS_EXCLUDED(netdev_mutex
)
524 ovs_mutex_lock(&netdev_mutex
);
525 netdev_unref(netdev
);
529 /* Removes 'netdev' from the global shash and unrefs 'netdev'.
531 * This allows handler and revalidator threads to still retain references
532 * to this netdev while the main thread changes interface configuration.
534 * This function should only be called by the main thread when closing
535 * netdevs during user configuration changes. Otherwise, netdev_close should be
536 * used to close netdevs. */
538 netdev_remove(struct netdev
*netdev
)
541 ovs_mutex_lock(&netdev_mutex
);
543 shash_delete(&netdev_shash
, netdev
->node
);
545 netdev_change_seq_changed(netdev
);
547 netdev_unref(netdev
);
551 /* Parses 'netdev_name_', which is of the form [type@]name into its component
552 * pieces. 'name' and 'type' must be freed by the caller. */
554 netdev_parse_name(const char *netdev_name_
, char **name
, char **type
)
556 char *netdev_name
= xstrdup(netdev_name_
);
559 separator
= strchr(netdev_name
, '@');
563 *name
= xstrdup(separator
+ 1);
566 *type
= xstrdup("system");
570 /* Attempts to open a netdev_rxq handle for obtaining packets received on
571 * 'netdev'. On success, returns 0 and stores a nonnull 'netdev_rxq *' into
572 * '*rxp'. On failure, returns a positive errno value and stores NULL into
575 * Some kinds of network devices might not support receiving packets. This
576 * function returns EOPNOTSUPP in that case.*/
578 netdev_rxq_open(struct netdev
*netdev
, struct netdev_rxq
**rxp
, int id
)
579 OVS_EXCLUDED(netdev_mutex
)
583 if (netdev
->netdev_class
->rxq_alloc
&& id
< netdev
->n_rxq
) {
584 struct netdev_rxq
*rx
= netdev
->netdev_class
->rxq_alloc();
588 error
= netdev
->netdev_class
->rxq_construct(rx
);
594 netdev
->netdev_class
->rxq_dealloc(rx
);
608 netdev_rxq_close(struct netdev_rxq
*rx
)
609 OVS_EXCLUDED(netdev_mutex
)
612 struct netdev
*netdev
= rx
->netdev
;
613 netdev
->netdev_class
->rxq_destruct(rx
);
614 netdev
->netdev_class
->rxq_dealloc(rx
);
615 netdev_close(netdev
);
619 /* Attempts to receive batch of packets from 'rx'.
621 * Returns EAGAIN immediately if no packet is ready to be received.
623 * Returns EMSGSIZE, and discards the packet, if the received packet is longer
624 * than 'ofpbuf_tailroom(buffer)'.
626 * It is advised that the tailroom of 'buffer' should be
627 * VLAN_HEADER_LEN bytes longer than the MTU to allow space for an
628 * out-of-band VLAN header to be added to the packet. At the very least,
629 * 'buffer' must have at least ETH_TOTAL_MIN bytes of tailroom.
631 * This function may be set to null if it would always return EOPNOTSUPP
634 netdev_rxq_recv(struct netdev_rxq
*rx
, struct dpif_packet
**buffers
, int *cnt
)
638 retval
= rx
->netdev
->netdev_class
->rxq_recv(rx
, buffers
, cnt
);
640 COVERAGE_INC(netdev_received
);
645 /* Arranges for poll_block() to wake up when a packet is ready to be received
648 netdev_rxq_wait(struct netdev_rxq
*rx
)
650 rx
->netdev
->netdev_class
->rxq_wait(rx
);
653 /* Discards any packets ready to be received on 'rx'. */
655 netdev_rxq_drain(struct netdev_rxq
*rx
)
657 return (rx
->netdev
->netdev_class
->rxq_drain
658 ? rx
->netdev
->netdev_class
->rxq_drain(rx
)
662 /* Sends 'buffers' on 'netdev'. Returns 0 if successful (for every packet),
663 * otherwise a positive errno value. Returns EAGAIN without blocking if
664 * at least one the packets cannot be queued immediately. Returns EMSGSIZE
665 * if a partial packet was transmitted or if a packet is too big or too small
666 * to transmit on the device.
668 * If the function returns a non-zero value, some of the packets might have
671 * To retain ownership of 'buffer' caller can set may_steal to false.
673 * The kernel maintains a packet transmission queue, so the caller is not
674 * expected to do additional queuing of packets.
676 * Some network devices may not implement support for this function. In such
677 * cases this function will always return EOPNOTSUPP. */
679 netdev_send(struct netdev
*netdev
, struct dpif_packet
**buffers
, int cnt
,
684 error
= (netdev
->netdev_class
->send
685 ? netdev
->netdev_class
->send(netdev
, buffers
, cnt
, may_steal
)
688 COVERAGE_INC(netdev_sent
);
693 /* Registers with the poll loop to wake up from the next call to poll_block()
694 * when the packet transmission queue has sufficient room to transmit a packet
695 * with netdev_send().
697 * The kernel maintains a packet transmission queue, so the client is not
698 * expected to do additional queuing of packets. Thus, this function is
699 * unlikely to ever be used. It is included for completeness. */
701 netdev_send_wait(struct netdev
*netdev
)
703 if (netdev
->netdev_class
->send_wait
) {
704 netdev
->netdev_class
->send_wait(netdev
);
708 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
709 * otherwise a positive errno value. */
711 netdev_set_etheraddr(struct netdev
*netdev
, const uint8_t mac
[ETH_ADDR_LEN
])
713 return netdev
->netdev_class
->set_etheraddr(netdev
, mac
);
716 /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
717 * the MAC address into 'mac'. On failure, returns a positive errno value and
718 * clears 'mac' to all-zeros. */
720 netdev_get_etheraddr(const struct netdev
*netdev
, uint8_t mac
[ETH_ADDR_LEN
])
722 return netdev
->netdev_class
->get_etheraddr(netdev
, mac
);
725 /* Returns the name of the network device that 'netdev' represents,
726 * e.g. "eth0". The caller must not modify or free the returned string. */
728 netdev_get_name(const struct netdev
*netdev
)
733 /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
734 * (and received) packets, in bytes, not including the hardware header; thus,
735 * this is typically 1500 bytes for Ethernet devices.
737 * If successful, returns 0 and stores the MTU size in '*mtup'. Returns
738 * EOPNOTSUPP if 'netdev' does not have an MTU (as e.g. some tunnels do not).
739 * On other failure, returns a positive errno value. On failure, sets '*mtup'
742 netdev_get_mtu(const struct netdev
*netdev
, int *mtup
)
744 const struct netdev_class
*class = netdev
->netdev_class
;
747 error
= class->get_mtu
? class->get_mtu(netdev
, mtup
) : EOPNOTSUPP
;
750 if (error
!= EOPNOTSUPP
) {
751 VLOG_DBG_RL(&rl
, "failed to retrieve MTU for network device %s: "
752 "%s", netdev_get_name(netdev
), ovs_strerror(error
));
758 /* Sets the MTU of 'netdev'. The MTU is the maximum size of transmitted
759 * (and received) packets, in bytes.
761 * If successful, returns 0. Returns EOPNOTSUPP if 'netdev' does not have an
762 * MTU (as e.g. some tunnels do not). On other failure, returns a positive
765 netdev_set_mtu(const struct netdev
*netdev
, int mtu
)
767 const struct netdev_class
*class = netdev
->netdev_class
;
770 error
= class->set_mtu
? class->set_mtu(netdev
, mtu
) : EOPNOTSUPP
;
771 if (error
&& error
!= EOPNOTSUPP
) {
772 VLOG_DBG_RL(&rl
, "failed to set MTU for network device %s: %s",
773 netdev_get_name(netdev
), ovs_strerror(error
));
779 /* Returns the ifindex of 'netdev', if successful, as a positive number. On
780 * failure, returns a negative errno value.
782 * The desired semantics of the ifindex value are a combination of those
783 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex
784 * value should be unique within a host and remain stable at least until
785 * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber"
786 * but many systems do not follow this rule anyhow.
788 * Some network devices may not implement support for this function. In such
789 * cases this function will always return -EOPNOTSUPP.
792 netdev_get_ifindex(const struct netdev
*netdev
)
794 int (*get_ifindex
)(const struct netdev
*);
796 get_ifindex
= netdev
->netdev_class
->get_ifindex
;
798 return get_ifindex
? get_ifindex(netdev
) : -EOPNOTSUPP
;
801 /* Stores the features supported by 'netdev' into each of '*current',
802 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
803 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
804 * successful, otherwise a positive errno value. On failure, all of the
805 * passed-in values are set to 0.
807 * Some network devices may not implement support for this function. In such
808 * cases this function will always return EOPNOTSUPP. */
810 netdev_get_features(const struct netdev
*netdev
,
811 enum netdev_features
*current
,
812 enum netdev_features
*advertised
,
813 enum netdev_features
*supported
,
814 enum netdev_features
*peer
)
816 int (*get_features
)(const struct netdev
*netdev
,
817 enum netdev_features
*current
,
818 enum netdev_features
*advertised
,
819 enum netdev_features
*supported
,
820 enum netdev_features
*peer
);
821 enum netdev_features dummy
[4];
828 advertised
= &dummy
[1];
831 supported
= &dummy
[2];
837 get_features
= netdev
->netdev_class
->get_features
;
839 ? get_features(netdev
, current
, advertised
, supported
,
843 *current
= *advertised
= *supported
= *peer
= 0;
848 /* Returns the maximum speed of a network connection that has the NETDEV_F_*
849 * bits in 'features', in bits per second. If no bits that indicate a speed
850 * are set in 'features', returns 'default_bps'. */
852 netdev_features_to_bps(enum netdev_features features
,
853 uint64_t default_bps
)
856 F_1000000MB
= NETDEV_F_1TB_FD
,
857 F_100000MB
= NETDEV_F_100GB_FD
,
858 F_40000MB
= NETDEV_F_40GB_FD
,
859 F_10000MB
= NETDEV_F_10GB_FD
,
860 F_1000MB
= NETDEV_F_1GB_HD
| NETDEV_F_1GB_FD
,
861 F_100MB
= NETDEV_F_100MB_HD
| NETDEV_F_100MB_FD
,
862 F_10MB
= NETDEV_F_10MB_HD
| NETDEV_F_10MB_FD
865 return ( features
& F_1000000MB
? UINT64_C(1000000000000)
866 : features
& F_100000MB
? UINT64_C(100000000000)
867 : features
& F_40000MB
? UINT64_C(40000000000)
868 : features
& F_10000MB
? UINT64_C(10000000000)
869 : features
& F_1000MB
? UINT64_C(1000000000)
870 : features
& F_100MB
? UINT64_C(100000000)
871 : features
& F_10MB
? UINT64_C(10000000)
875 /* Returns true if any of the NETDEV_F_* bits that indicate a full-duplex link
876 * are set in 'features', otherwise false. */
878 netdev_features_is_full_duplex(enum netdev_features features
)
880 return (features
& (NETDEV_F_10MB_FD
| NETDEV_F_100MB_FD
| NETDEV_F_1GB_FD
881 | NETDEV_F_10GB_FD
| NETDEV_F_40GB_FD
882 | NETDEV_F_100GB_FD
| NETDEV_F_1TB_FD
)) != 0;
885 /* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if
886 * successful, otherwise a positive errno value. */
888 netdev_set_advertisements(struct netdev
*netdev
,
889 enum netdev_features advertise
)
891 return (netdev
->netdev_class
->set_advertisements
892 ? netdev
->netdev_class
->set_advertisements(
897 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
898 * and '*netmask' to its netmask and returns 0. Otherwise, returns a positive
899 * errno value and sets '*address' to 0 (INADDR_ANY).
901 * The following error values have well-defined meanings:
903 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
905 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
907 * 'address' or 'netmask' or both may be null, in which case the address or
908 * netmask is not reported. */
910 netdev_get_in4(const struct netdev
*netdev
,
911 struct in_addr
*address_
, struct in_addr
*netmask_
)
913 struct in_addr address
;
914 struct in_addr netmask
;
917 error
= (netdev
->netdev_class
->get_in4
918 ? netdev
->netdev_class
->get_in4(netdev
,
922 address_
->s_addr
= error
? 0 : address
.s_addr
;
925 netmask_
->s_addr
= error
? 0 : netmask
.s_addr
;
930 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
931 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a
932 * positive errno value. */
934 netdev_set_in4(struct netdev
*netdev
, struct in_addr addr
, struct in_addr mask
)
936 return (netdev
->netdev_class
->set_in4
937 ? netdev
->netdev_class
->set_in4(netdev
, addr
, mask
)
941 /* Obtains ad IPv4 address from device name and save the address in
942 * in4. Returns 0 if successful, otherwise a positive errno value.
945 netdev_get_in4_by_name(const char *device_name
, struct in_addr
*in4
)
947 struct netdev
*netdev
;
950 error
= netdev_open(device_name
, "system", &netdev
);
952 in4
->s_addr
= htonl(0);
956 error
= netdev_get_in4(netdev
, in4
, NULL
);
957 netdev_close(netdev
);
961 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
964 netdev_add_router(struct netdev
*netdev
, struct in_addr router
)
966 COVERAGE_INC(netdev_add_router
);
967 return (netdev
->netdev_class
->add_router
968 ? netdev
->netdev_class
->add_router(netdev
, router
)
972 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
973 * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0,
974 * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a
975 * next hop is found, stores the next hop gateway's address (0 if 'host' is on
976 * a directly connected network) in '*next_hop' and a copy of the name of the
977 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
978 * responsible for freeing '*netdev_name' (by calling free()). */
980 netdev_get_next_hop(const struct netdev
*netdev
,
981 const struct in_addr
*host
, struct in_addr
*next_hop
,
984 int error
= (netdev
->netdev_class
->get_next_hop
985 ? netdev
->netdev_class
->get_next_hop(
986 host
, next_hop
, netdev_name
)
989 next_hop
->s_addr
= 0;
995 /* Populates 'smap' with status information.
997 * Populates 'smap' with 'netdev' specific status information. This
998 * information may be used to populate the status column of the Interface table
999 * as defined in ovs-vswitchd.conf.db(5). */
1001 netdev_get_status(const struct netdev
*netdev
, struct smap
*smap
)
1003 return (netdev
->netdev_class
->get_status
1004 ? netdev
->netdev_class
->get_status(netdev
, smap
)
1008 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
1009 * returns 0. Otherwise, returns a positive errno value and sets '*in6' to
1010 * all-zero-bits (in6addr_any).
1012 * The following error values have well-defined meanings:
1014 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
1016 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
1018 * 'in6' may be null, in which case the address itself is not reported. */
1020 netdev_get_in6(const struct netdev
*netdev
, struct in6_addr
*in6
)
1022 struct in6_addr dummy
;
1025 error
= (netdev
->netdev_class
->get_in6
1026 ? netdev
->netdev_class
->get_in6(netdev
,
1030 memset(in6
, 0, sizeof *in6
);
1035 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
1036 * 'on'. Returns 0 if successful, otherwise a positive errno value. */
1038 do_update_flags(struct netdev
*netdev
, enum netdev_flags off
,
1039 enum netdev_flags on
, enum netdev_flags
*old_flagsp
,
1040 struct netdev_saved_flags
**sfp
)
1041 OVS_EXCLUDED(netdev_mutex
)
1043 struct netdev_saved_flags
*sf
= NULL
;
1044 enum netdev_flags old_flags
;
1047 error
= netdev
->netdev_class
->update_flags(netdev
, off
& ~on
, on
,
1050 VLOG_WARN_RL(&rl
, "failed to %s flags for network device %s: %s",
1051 off
|| on
? "set" : "get", netdev_get_name(netdev
),
1052 ovs_strerror(error
));
1054 } else if ((off
|| on
) && sfp
) {
1055 enum netdev_flags new_flags
= (old_flags
& ~off
) | on
;
1056 enum netdev_flags changed_flags
= old_flags
^ new_flags
;
1057 if (changed_flags
) {
1058 ovs_mutex_lock(&netdev_mutex
);
1059 *sfp
= sf
= xmalloc(sizeof *sf
);
1060 sf
->netdev
= netdev
;
1061 list_push_front(&netdev
->saved_flags_list
, &sf
->node
);
1062 sf
->saved_flags
= changed_flags
;
1063 sf
->saved_values
= changed_flags
& new_flags
;
1066 ovs_mutex_unlock(&netdev_mutex
);
1071 *old_flagsp
= old_flags
;
1080 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
1081 * Returns 0 if successful, otherwise a positive errno value. On failure,
1082 * stores 0 into '*flagsp'. */
1084 netdev_get_flags(const struct netdev
*netdev_
, enum netdev_flags
*flagsp
)
1086 struct netdev
*netdev
= CONST_CAST(struct netdev
*, netdev_
);
1087 return do_update_flags(netdev
, 0, 0, flagsp
, NULL
);
1090 /* Sets the flags for 'netdev' to 'flags'.
1091 * Returns 0 if successful, otherwise a positive errno value. */
1093 netdev_set_flags(struct netdev
*netdev
, enum netdev_flags flags
,
1094 struct netdev_saved_flags
**sfp
)
1096 return do_update_flags(netdev
, -1, flags
, NULL
, sfp
);
1099 /* Turns on the specified 'flags' on 'netdev':
1101 * - On success, returns 0. If 'sfp' is nonnull, sets '*sfp' to a newly
1102 * allocated 'struct netdev_saved_flags *' that may be passed to
1103 * netdev_restore_flags() to restore the original values of 'flags' on
1104 * 'netdev' (this will happen automatically at program termination if
1105 * netdev_restore_flags() is never called) , or to NULL if no flags were
1108 * - On failure, returns a positive errno value. If 'sfp' is nonnull, sets
1109 * '*sfp' to NULL. */
1111 netdev_turn_flags_on(struct netdev
*netdev
, enum netdev_flags flags
,
1112 struct netdev_saved_flags
**sfp
)
1114 return do_update_flags(netdev
, 0, flags
, NULL
, sfp
);
1117 /* Turns off the specified 'flags' on 'netdev'. See netdev_turn_flags_on() for
1118 * details of the interface. */
1120 netdev_turn_flags_off(struct netdev
*netdev
, enum netdev_flags flags
,
1121 struct netdev_saved_flags
**sfp
)
1123 return do_update_flags(netdev
, flags
, 0, NULL
, sfp
);
1126 /* Restores the flags that were saved in 'sf', and destroys 'sf'.
1127 * Does nothing if 'sf' is NULL. */
1129 netdev_restore_flags(struct netdev_saved_flags
*sf
)
1130 OVS_EXCLUDED(netdev_mutex
)
1133 struct netdev
*netdev
= sf
->netdev
;
1134 enum netdev_flags old_flags
;
1136 netdev
->netdev_class
->update_flags(netdev
,
1137 sf
->saved_flags
& sf
->saved_values
,
1138 sf
->saved_flags
& ~sf
->saved_values
,
1141 ovs_mutex_lock(&netdev_mutex
);
1142 list_remove(&sf
->node
);
1144 netdev_unref(netdev
);
1148 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
1149 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
1150 * returns 0. Otherwise, it returns a positive errno value; in particular,
1151 * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
1153 netdev_arp_lookup(const struct netdev
*netdev
,
1154 ovs_be32 ip
, uint8_t mac
[ETH_ADDR_LEN
])
1156 int error
= (netdev
->netdev_class
->arp_lookup
1157 ? netdev
->netdev_class
->arp_lookup(netdev
, ip
, mac
)
1160 memset(mac
, 0, ETH_ADDR_LEN
);
1165 /* Returns true if carrier is active (link light is on) on 'netdev'. */
1167 netdev_get_carrier(const struct netdev
*netdev
)
1170 enum netdev_flags flags
;
1173 netdev_get_flags(netdev
, &flags
);
1174 if (!(flags
& NETDEV_UP
)) {
1178 if (!netdev
->netdev_class
->get_carrier
) {
1182 error
= netdev
->netdev_class
->get_carrier(netdev
, &carrier
);
1184 VLOG_DBG("%s: failed to get network device carrier status, assuming "
1185 "down: %s", netdev_get_name(netdev
), ovs_strerror(error
));
1192 /* Returns the number of times 'netdev''s carrier has changed. */
1194 netdev_get_carrier_resets(const struct netdev
*netdev
)
1196 return (netdev
->netdev_class
->get_carrier_resets
1197 ? netdev
->netdev_class
->get_carrier_resets(netdev
)
1201 /* Attempts to force netdev_get_carrier() to poll 'netdev''s MII registers for
1202 * link status instead of checking 'netdev''s carrier. 'netdev''s MII
1203 * registers will be polled once ever 'interval' milliseconds. If 'netdev'
1204 * does not support MII, another method may be used as a fallback. If
1205 * 'interval' is less than or equal to zero, reverts netdev_get_carrier() to
1206 * its normal behavior.
1208 * Returns 0 if successful, otherwise a positive errno value. */
1210 netdev_set_miimon_interval(struct netdev
*netdev
, long long int interval
)
1212 return (netdev
->netdev_class
->set_miimon_interval
1213 ? netdev
->netdev_class
->set_miimon_interval(netdev
, interval
)
1217 /* Retrieves current device stats for 'netdev'. */
1219 netdev_get_stats(const struct netdev
*netdev
, struct netdev_stats
*stats
)
1223 COVERAGE_INC(netdev_get_stats
);
1224 error
= (netdev
->netdev_class
->get_stats
1225 ? netdev
->netdev_class
->get_stats(netdev
, stats
)
1228 memset(stats
, 0xff, sizeof *stats
);
1233 /* Attempts to change the stats for 'netdev' to those provided in 'stats'.
1234 * Returns 0 if successful, otherwise a positive errno value.
1236 * This will probably fail for most network devices. Some devices might only
1237 * allow setting their stats to 0. */
1239 netdev_set_stats(struct netdev
*netdev
, const struct netdev_stats
*stats
)
1241 return (netdev
->netdev_class
->set_stats
1242 ? netdev
->netdev_class
->set_stats(netdev
, stats
)
1246 /* Attempts to set input rate limiting (policing) policy, such that up to
1247 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
1248 * size of 'kbits' kb. */
1250 netdev_set_policing(struct netdev
*netdev
, uint32_t kbits_rate
,
1251 uint32_t kbits_burst
)
1253 return (netdev
->netdev_class
->set_policing
1254 ? netdev
->netdev_class
->set_policing(netdev
,
1255 kbits_rate
, kbits_burst
)
1259 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
1260 * empty if 'netdev' does not support QoS. Any names added to 'types' should
1261 * be documented as valid for the "type" column in the "QoS" table in
1262 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1264 * Every network device supports disabling QoS with a type of "", but this type
1265 * will not be added to 'types'.
1267 * The caller must initialize 'types' (e.g. with sset_init()) before calling
1268 * this function. The caller is responsible for destroying 'types' (e.g. with
1269 * sset_destroy()) when it is no longer needed.
1271 * Returns 0 if successful, otherwise a positive errno value. */
1273 netdev_get_qos_types(const struct netdev
*netdev
, struct sset
*types
)
1275 const struct netdev_class
*class = netdev
->netdev_class
;
1276 return (class->get_qos_types
1277 ? class->get_qos_types(netdev
, types
)
1281 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
1282 * which should be "" or one of the types returned by netdev_get_qos_types()
1283 * for 'netdev'. Returns 0 if successful, otherwise a positive errno value.
1284 * On success, initializes 'caps' with the QoS capabilities; on failure, clears
1285 * 'caps' to all zeros. */
1287 netdev_get_qos_capabilities(const struct netdev
*netdev
, const char *type
,
1288 struct netdev_qos_capabilities
*caps
)
1290 const struct netdev_class
*class = netdev
->netdev_class
;
1293 int retval
= (class->get_qos_capabilities
1294 ? class->get_qos_capabilities(netdev
, type
, caps
)
1297 memset(caps
, 0, sizeof *caps
);
1301 /* Every netdev supports turning off QoS. */
1302 memset(caps
, 0, sizeof *caps
);
1307 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
1308 * of QoS. Returns 0 if successful, otherwise a positive errno value. Stores
1309 * the number of queues (zero on failure) in '*n_queuesp'.
1311 * This is just a simple wrapper around netdev_get_qos_capabilities(). */
1313 netdev_get_n_queues(const struct netdev
*netdev
,
1314 const char *type
, unsigned int *n_queuesp
)
1316 struct netdev_qos_capabilities caps
;
1319 retval
= netdev_get_qos_capabilities(netdev
, type
, &caps
);
1320 *n_queuesp
= caps
.n_queues
;
1324 /* Queries 'netdev' about its currently configured form of QoS. If successful,
1325 * stores the name of the current form of QoS into '*typep', stores any details
1326 * of configuration as string key-value pairs in 'details', and returns 0. On
1327 * failure, sets '*typep' to NULL and returns a positive errno value.
1329 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1331 * The caller must initialize 'details' as an empty smap (e.g. with
1332 * smap_init()) before calling this function. The caller must free 'details'
1333 * when it is no longer needed (e.g. with smap_destroy()).
1335 * The caller must not modify or free '*typep'.
1337 * '*typep' will be one of the types returned by netdev_get_qos_types() for
1338 * 'netdev'. The contents of 'details' should be documented as valid for
1339 * '*typep' in the "other_config" column in the "QoS" table in
1340 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1342 netdev_get_qos(const struct netdev
*netdev
,
1343 const char **typep
, struct smap
*details
)
1345 const struct netdev_class
*class = netdev
->netdev_class
;
1348 if (class->get_qos
) {
1349 retval
= class->get_qos(netdev
, typep
, details
);
1352 smap_clear(details
);
1356 /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1362 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1363 * with details of configuration from 'details'. Returns 0 if successful,
1364 * otherwise a positive errno value. On error, the previous QoS configuration
1367 * When this function changes the type of QoS (not just 'details'), this also
1368 * resets all queue configuration for 'netdev' to their defaults (which depend
1369 * on the specific type of QoS). Otherwise, the queue configuration for
1370 * 'netdev' is unchanged.
1372 * 'type' should be "" (to disable QoS) or one of the types returned by
1373 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should be
1374 * documented as valid for the given 'type' in the "other_config" column in the
1375 * "QoS" table in vswitchd/vswitch.xml (which is built as
1376 * ovs-vswitchd.conf.db(8)).
1378 * NULL may be specified for 'details' if there are no configuration
1381 netdev_set_qos(struct netdev
*netdev
,
1382 const char *type
, const struct smap
*details
)
1384 const struct netdev_class
*class = netdev
->netdev_class
;
1390 if (class->set_qos
) {
1392 static const struct smap empty
= SMAP_INITIALIZER(&empty
);
1395 return class->set_qos(netdev
, type
, details
);
1397 return *type
? EOPNOTSUPP
: 0;
1401 /* Queries 'netdev' for information about the queue numbered 'queue_id'. If
1402 * successful, adds that information as string key-value pairs to 'details'.
1403 * Returns 0 if successful, otherwise a positive errno value.
1405 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1406 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1408 * The returned contents of 'details' should be documented as valid for the
1409 * given 'type' in the "other_config" column in the "Queue" table in
1410 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1412 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1413 * this function. The caller must free 'details' when it is no longer needed
1414 * (e.g. with smap_destroy()). */
1416 netdev_get_queue(const struct netdev
*netdev
,
1417 unsigned int queue_id
, struct smap
*details
)
1419 const struct netdev_class
*class = netdev
->netdev_class
;
1422 retval
= (class->get_queue
1423 ? class->get_queue(netdev
, queue_id
, details
)
1426 smap_clear(details
);
1431 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1432 * string pairs in 'details'. The contents of 'details' should be documented
1433 * as valid for the given 'type' in the "other_config" column in the "Queue"
1434 * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1435 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1436 * given queue's configuration should be unmodified.
1438 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1439 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1441 * This function does not modify 'details', and the caller retains ownership of
1444 netdev_set_queue(struct netdev
*netdev
,
1445 unsigned int queue_id
, const struct smap
*details
)
1447 const struct netdev_class
*class = netdev
->netdev_class
;
1448 return (class->set_queue
1449 ? class->set_queue(netdev
, queue_id
, details
)
1453 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'. Some kinds
1454 * of QoS may have a fixed set of queues, in which case attempts to delete them
1455 * will fail with EOPNOTSUPP.
1457 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1458 * given queue will be unmodified.
1460 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1461 * the current form of QoS (e.g. as returned by
1462 * netdev_get_n_queues(netdev)). */
1464 netdev_delete_queue(struct netdev
*netdev
, unsigned int queue_id
)
1466 const struct netdev_class
*class = netdev
->netdev_class
;
1467 return (class->delete_queue
1468 ? class->delete_queue(netdev
, queue_id
)
1472 /* Obtains statistics about 'queue_id' on 'netdev'. On success, returns 0 and
1473 * fills 'stats' with the queue's statistics; individual members of 'stats' may
1474 * be set to all-1-bits if the statistic is unavailable. On failure, returns a
1475 * positive errno value and fills 'stats' with values indicating unsupported
1478 netdev_get_queue_stats(const struct netdev
*netdev
, unsigned int queue_id
,
1479 struct netdev_queue_stats
*stats
)
1481 const struct netdev_class
*class = netdev
->netdev_class
;
1484 retval
= (class->get_queue_stats
1485 ? class->get_queue_stats(netdev
, queue_id
, stats
)
1488 stats
->tx_bytes
= UINT64_MAX
;
1489 stats
->tx_packets
= UINT64_MAX
;
1490 stats
->tx_errors
= UINT64_MAX
;
1491 stats
->created
= LLONG_MIN
;
1496 /* Initializes 'dump' to begin dumping the queues in a netdev.
1498 * This function provides no status indication. An error status for the entire
1499 * dump operation is provided when it is completed by calling
1500 * netdev_queue_dump_done().
1503 netdev_queue_dump_start(struct netdev_queue_dump
*dump
,
1504 const struct netdev
*netdev
)
1506 dump
->netdev
= netdev_ref(netdev
);
1507 if (netdev
->netdev_class
->queue_dump_start
) {
1508 dump
->error
= netdev
->netdev_class
->queue_dump_start(netdev
,
1511 dump
->error
= EOPNOTSUPP
;
1515 /* Attempts to retrieve another queue from 'dump', which must have been
1516 * initialized with netdev_queue_dump_start(). On success, stores a new queue
1517 * ID into '*queue_id', fills 'details' with configuration details for the
1518 * queue, and returns true. On failure, returns false.
1520 * Queues are not necessarily dumped in increasing order of queue ID (or any
1521 * other predictable order).
1523 * Failure might indicate an actual error or merely that the last queue has
1524 * been dumped. An error status for the entire dump operation is provided when
1525 * it is completed by calling netdev_queue_dump_done().
1527 * The returned contents of 'details' should be documented as valid for the
1528 * given 'type' in the "other_config" column in the "Queue" table in
1529 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1531 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1532 * this function. This function will clear and replace its contents. The
1533 * caller must free 'details' when it is no longer needed (e.g. with
1534 * smap_destroy()). */
1536 netdev_queue_dump_next(struct netdev_queue_dump
*dump
,
1537 unsigned int *queue_id
, struct smap
*details
)
1539 const struct netdev
*netdev
= dump
->netdev
;
1545 dump
->error
= netdev
->netdev_class
->queue_dump_next(netdev
, dump
->state
,
1549 netdev
->netdev_class
->queue_dump_done(netdev
, dump
->state
);
1555 /* Completes queue table dump operation 'dump', which must have been
1556 * initialized with netdev_queue_dump_start(). Returns 0 if the dump operation
1557 * was error-free, otherwise a positive errno value describing the problem. */
1559 netdev_queue_dump_done(struct netdev_queue_dump
*dump
)
1561 const struct netdev
*netdev
= dump
->netdev
;
1562 if (!dump
->error
&& netdev
->netdev_class
->queue_dump_done
) {
1563 dump
->error
= netdev
->netdev_class
->queue_dump_done(netdev
,
1566 netdev_close(dump
->netdev
);
1567 return dump
->error
== EOF
? 0 : dump
->error
;
1570 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1571 * its statistics, and the 'aux' specified by the caller. The order of
1572 * iteration is unspecified, but (when successful) each queue is visited
1575 * Calling this function may be more efficient than calling
1576 * netdev_get_queue_stats() for every queue.
1578 * 'cb' must not modify or free the statistics passed in.
1580 * Returns 0 if successful, otherwise a positive errno value. On error, some
1581 * configured queues may not have been included in the iteration. */
1583 netdev_dump_queue_stats(const struct netdev
*netdev
,
1584 netdev_dump_queue_stats_cb
*cb
, void *aux
)
1586 const struct netdev_class
*class = netdev
->netdev_class
;
1587 return (class->dump_queue_stats
1588 ? class->dump_queue_stats(netdev
, cb
, aux
)
1593 /* Returns the class type of 'netdev'.
1595 * The caller must not free the returned value. */
1597 netdev_get_type(const struct netdev
*netdev
)
1599 return netdev
->netdev_class
->type
;
1602 /* Returns the class associated with 'netdev'. */
1603 const struct netdev_class
*
1604 netdev_get_class(const struct netdev
*netdev
)
1606 return netdev
->netdev_class
;
1609 /* Returns the netdev with 'name' or NULL if there is none.
1611 * The caller must free the returned netdev with netdev_close(). */
1613 netdev_from_name(const char *name
)
1614 OVS_EXCLUDED(netdev_mutex
)
1616 struct netdev
*netdev
;
1618 ovs_mutex_lock(&netdev_mutex
);
1619 netdev
= shash_find_data(&netdev_shash
, name
);
1623 ovs_mutex_unlock(&netdev_mutex
);
1628 /* Fills 'device_list' with devices that match 'netdev_class'.
1630 * The caller is responsible for initializing and destroying 'device_list' and
1631 * must close each device on the list. */
1633 netdev_get_devices(const struct netdev_class
*netdev_class
,
1634 struct shash
*device_list
)
1635 OVS_EXCLUDED(netdev_mutex
)
1637 struct shash_node
*node
;
1639 ovs_mutex_lock(&netdev_mutex
);
1640 SHASH_FOR_EACH (node
, &netdev_shash
) {
1641 struct netdev
*dev
= node
->data
;
1643 if (dev
->netdev_class
== netdev_class
) {
1645 shash_add(device_list
, node
->name
, node
->data
);
1648 ovs_mutex_unlock(&netdev_mutex
);
1651 /* Extracts pointers to all 'netdev-vports' into an array 'vports'
1652 * and returns it. Stores the size of the array into '*size'.
1654 * The caller is responsible for freeing 'vports' and must close
1655 * each 'netdev-vport' in the list. */
1657 netdev_get_vports(size_t *size
)
1658 OVS_EXCLUDED(netdev_mutex
)
1660 struct netdev
**vports
;
1661 struct shash_node
*node
;
1668 /* Explicitly allocates big enough chunk of memory. */
1669 vports
= xmalloc(shash_count(&netdev_shash
) * sizeof *vports
);
1670 ovs_mutex_lock(&netdev_mutex
);
1671 SHASH_FOR_EACH (node
, &netdev_shash
) {
1672 struct netdev
*dev
= node
->data
;
1674 if (netdev_vport_is_vport_class(dev
->netdev_class
)) {
1680 ovs_mutex_unlock(&netdev_mutex
);
1687 netdev_get_type_from_name(const char *name
)
1689 struct netdev
*dev
= netdev_from_name(name
);
1690 const char *type
= dev
? netdev_get_type(dev
) : NULL
;
1696 netdev_rxq_get_netdev(const struct netdev_rxq
*rx
)
1698 ovs_assert(rx
->netdev
->ref_cnt
> 0);
1703 netdev_rxq_get_name(const struct netdev_rxq
*rx
)
1705 return netdev_get_name(netdev_rxq_get_netdev(rx
));
1709 restore_all_flags(void *aux OVS_UNUSED
)
1711 struct shash_node
*node
;
1713 SHASH_FOR_EACH (node
, &netdev_shash
) {
1714 struct netdev
*netdev
= node
->data
;
1715 const struct netdev_saved_flags
*sf
;
1716 enum netdev_flags saved_values
;
1717 enum netdev_flags saved_flags
;
1719 saved_values
= saved_flags
= 0;
1720 LIST_FOR_EACH (sf
, node
, &netdev
->saved_flags_list
) {
1721 saved_flags
|= sf
->saved_flags
;
1722 saved_values
&= ~sf
->saved_flags
;
1723 saved_values
|= sf
->saved_flags
& sf
->saved_values
;
1726 enum netdev_flags old_flags
;
1728 netdev
->netdev_class
->update_flags(netdev
,
1729 saved_flags
& saved_values
,
1730 saved_flags
& ~saved_values
,
1737 netdev_get_change_seq(const struct netdev
*netdev
)
1739 return netdev
->change_seq
;