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"
47 VLOG_DEFINE_THIS_MODULE(netdev
);
49 COVERAGE_DEFINE(netdev_received
);
50 COVERAGE_DEFINE(netdev_sent
);
51 COVERAGE_DEFINE(netdev_add_router
);
52 COVERAGE_DEFINE(netdev_get_stats
);
54 struct netdev_saved_flags
{
55 struct netdev
*netdev
;
56 struct ovs_list node
; /* In struct netdev's saved_flags_list. */
57 enum netdev_flags saved_flags
;
58 enum netdev_flags saved_values
;
61 /* Protects 'netdev_shash' and the mutable members of struct netdev. */
62 static struct ovs_mutex netdev_mutex
= OVS_MUTEX_INITIALIZER
;
64 /* All created network devices. */
65 static struct shash netdev_shash
OVS_GUARDED_BY(netdev_mutex
)
66 = SHASH_INITIALIZER(&netdev_shash
);
68 /* Protects 'netdev_classes' against insertions or deletions.
70 * This is a recursive mutex to allow recursive acquisition when calling into
71 * providers. For example, netdev_run() calls into provider 'run' functions,
72 * which might reasonably want to call one of the netdev functions that takes
73 * netdev_class_mutex. */
74 static struct ovs_mutex netdev_class_mutex
OVS_ACQ_BEFORE(netdev_mutex
);
76 /* Contains 'struct netdev_registered_class'es. */
77 static struct hmap netdev_classes
OVS_GUARDED_BY(netdev_class_mutex
)
78 = HMAP_INITIALIZER(&netdev_classes
);
80 struct netdev_registered_class
{
81 /* In 'netdev_classes', by class->type. */
82 struct hmap_node hmap_node
OVS_GUARDED_BY(netdev_class_mutex
);
83 const struct netdev_class
*class OVS_GUARDED_BY(netdev_class_mutex
);
84 /* Number of 'struct netdev's of this class. */
85 int ref_cnt
OVS_GUARDED_BY(netdev_class_mutex
);
88 /* This is set pretty low because we probably won't learn anything from the
89 * additional log messages. */
90 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(5, 20);
92 static void restore_all_flags(void *aux OVS_UNUSED
);
93 void update_device_args(struct netdev
*, const struct shash
*args
);
96 netdev_n_txq(const struct netdev
*netdev
)
102 netdev_n_rxq(const struct netdev
*netdev
)
104 return netdev
->n_rxq
;
108 netdev_is_pmd(const struct netdev
*netdev
)
110 return (!strcmp(netdev
->netdev_class
->type
, "dpdk") ||
111 !strcmp(netdev
->netdev_class
->type
, "dpdkr"));
115 netdev_class_mutex_initialize(void)
116 OVS_EXCLUDED(netdev_class_mutex
, netdev_mutex
)
118 static struct ovsthread_once once
= OVSTHREAD_ONCE_INITIALIZER
;
120 if (ovsthread_once_start(&once
)) {
121 ovs_mutex_init_recursive(&netdev_class_mutex
);
122 ovsthread_once_done(&once
);
127 netdev_initialize(void)
128 OVS_EXCLUDED(netdev_class_mutex
, netdev_mutex
)
130 static struct ovsthread_once once
= OVSTHREAD_ONCE_INITIALIZER
;
132 if (ovsthread_once_start(&once
)) {
133 netdev_class_mutex_initialize();
135 fatal_signal_add_hook(restore_all_flags
, NULL
, NULL
, true);
136 netdev_vport_patch_register();
139 netdev_register_provider(&netdev_linux_class
);
140 netdev_register_provider(&netdev_internal_class
);
141 netdev_register_provider(&netdev_tap_class
);
142 netdev_vport_tunnel_register();
144 #if defined(__FreeBSD__) || defined(__NetBSD__)
145 netdev_register_provider(&netdev_tap_class
);
146 netdev_register_provider(&netdev_bsd_class
);
149 netdev_register_provider(&netdev_windows_class
);
150 netdev_register_provider(&netdev_internal_class
);
151 netdev_vport_tunnel_register();
153 netdev_dpdk_register();
155 ovsthread_once_done(&once
);
159 /* Performs periodic work needed by all the various kinds of netdevs.
161 * If your program opens any netdevs, it must call this function within its
165 OVS_EXCLUDED(netdev_class_mutex
, netdev_mutex
)
167 struct netdev_registered_class
*rc
;
170 ovs_mutex_lock(&netdev_class_mutex
);
171 HMAP_FOR_EACH (rc
, hmap_node
, &netdev_classes
) {
172 if (rc
->class->run
) {
176 ovs_mutex_unlock(&netdev_class_mutex
);
179 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
181 * If your program opens any netdevs, it must call this function within its
185 OVS_EXCLUDED(netdev_class_mutex
, netdev_mutex
)
187 struct netdev_registered_class
*rc
;
189 ovs_mutex_lock(&netdev_class_mutex
);
190 HMAP_FOR_EACH (rc
, hmap_node
, &netdev_classes
) {
191 if (rc
->class->wait
) {
195 ovs_mutex_unlock(&netdev_class_mutex
);
198 static struct netdev_registered_class
*
199 netdev_lookup_class(const char *type
)
200 OVS_REQ_RDLOCK(netdev_class_mutex
)
202 struct netdev_registered_class
*rc
;
204 HMAP_FOR_EACH_WITH_HASH (rc
, hmap_node
, hash_string(type
, 0),
206 if (!strcmp(type
, rc
->class->type
)) {
213 /* Initializes and registers a new netdev provider. After successful
214 * registration, new netdevs of that type can be opened using netdev_open(). */
216 netdev_register_provider(const struct netdev_class
*new_class
)
217 OVS_EXCLUDED(netdev_class_mutex
, netdev_mutex
)
221 netdev_class_mutex_initialize();
222 ovs_mutex_lock(&netdev_class_mutex
);
223 if (netdev_lookup_class(new_class
->type
)) {
224 VLOG_WARN("attempted to register duplicate netdev provider: %s",
228 error
= new_class
->init
? new_class
->init() : 0;
230 struct netdev_registered_class
*rc
;
232 rc
= xmalloc(sizeof *rc
);
233 hmap_insert(&netdev_classes
, &rc
->hmap_node
,
234 hash_string(new_class
->type
, 0));
235 rc
->class = new_class
;
238 VLOG_ERR("failed to initialize %s network device class: %s",
239 new_class
->type
, ovs_strerror(error
));
242 ovs_mutex_unlock(&netdev_class_mutex
);
247 /* Unregisters a netdev provider. 'type' must have been previously
248 * registered and not currently be in use by any netdevs. After unregistration
249 * new netdevs of that type cannot be opened using netdev_open(). */
251 netdev_unregister_provider(const char *type
)
252 OVS_EXCLUDED(netdev_class_mutex
, netdev_mutex
)
254 struct netdev_registered_class
*rc
;
257 ovs_mutex_lock(&netdev_class_mutex
);
258 rc
= netdev_lookup_class(type
);
260 VLOG_WARN("attempted to unregister a netdev provider that is not "
261 "registered: %s", type
);
262 error
= EAFNOSUPPORT
;
265 hmap_remove(&netdev_classes
, &rc
->hmap_node
);
269 VLOG_WARN("attempted to unregister in use netdev provider: %s",
274 ovs_mutex_unlock(&netdev_class_mutex
);
279 /* Clears 'types' and enumerates the types of all currently registered netdev
280 * providers into it. The caller must first initialize the sset. */
282 netdev_enumerate_types(struct sset
*types
)
283 OVS_EXCLUDED(netdev_mutex
)
285 struct netdev_registered_class
*rc
;
290 ovs_mutex_lock(&netdev_class_mutex
);
291 HMAP_FOR_EACH (rc
, hmap_node
, &netdev_classes
) {
292 sset_add(types
, rc
->class->type
);
294 ovs_mutex_unlock(&netdev_class_mutex
);
297 /* Check that the network device name is not the same as any of the registered
298 * vport providers' dpif_port name (dpif_port is NULL if the vport provider
299 * does not define it) or the datapath internal port name (e.g. ovs-system).
301 * Returns true if there is a name conflict, false otherwise. */
303 netdev_is_reserved_name(const char *name
)
304 OVS_EXCLUDED(netdev_mutex
)
306 struct netdev_registered_class
*rc
;
310 ovs_mutex_lock(&netdev_class_mutex
);
311 HMAP_FOR_EACH (rc
, hmap_node
, &netdev_classes
) {
312 const char *dpif_port
= netdev_vport_class_get_dpif_port(rc
->class);
313 if (dpif_port
&& !strncmp(name
, dpif_port
, strlen(dpif_port
))) {
314 ovs_mutex_unlock(&netdev_class_mutex
);
318 ovs_mutex_unlock(&netdev_class_mutex
);
320 if (!strncmp(name
, "ovs-", 4)) {
325 dp_enumerate_types(&types
);
326 SSET_FOR_EACH (type
, &types
) {
327 if (!strcmp(name
+4, type
)) {
328 sset_destroy(&types
);
332 sset_destroy(&types
);
338 /* Opens the network device named 'name' (e.g. "eth0") of the specified 'type'
339 * (e.g. "system") and returns zero if successful, otherwise a positive errno
340 * value. On success, sets '*netdevp' to the new network device, otherwise to
343 * Some network devices may need to be configured (with netdev_set_config())
344 * before they can be used. */
346 netdev_open(const char *name
, const char *type
, struct netdev
**netdevp
)
347 OVS_EXCLUDED(netdev_mutex
)
349 struct netdev
*netdev
;
354 ovs_mutex_lock(&netdev_class_mutex
);
355 ovs_mutex_lock(&netdev_mutex
);
356 netdev
= shash_find_data(&netdev_shash
, name
);
358 struct netdev_registered_class
*rc
;
360 rc
= netdev_lookup_class(type
&& type
[0] ? type
: "system");
362 netdev
= rc
->class->alloc();
364 memset(netdev
, 0, sizeof *netdev
);
365 netdev
->netdev_class
= rc
->class;
366 netdev
->name
= xstrdup(name
);
367 netdev
->change_seq
= 1;
368 netdev
->node
= shash_add(&netdev_shash
, name
, netdev
);
370 /* By default enable one tx and rx queue per netdev. */
371 netdev
->n_txq
= netdev
->netdev_class
->send
? 1 : 0;
372 netdev
->n_rxq
= netdev
->netdev_class
->rxq_alloc
? 1 : 0;
374 list_init(&netdev
->saved_flags_list
);
376 error
= rc
->class->construct(netdev
);
379 netdev_change_seq_changed(netdev
);
382 ovs_assert(list_is_empty(&netdev
->saved_flags_list
));
383 shash_delete(&netdev_shash
, netdev
->node
);
384 rc
->class->dealloc(netdev
);
390 VLOG_WARN("could not create netdev %s of unknown type %s",
392 error
= EAFNOSUPPORT
;
404 ovs_mutex_unlock(&netdev_mutex
);
405 ovs_mutex_unlock(&netdev_class_mutex
);
410 /* Returns a reference to 'netdev_' for the caller to own. Returns null if
411 * 'netdev_' is null. */
413 netdev_ref(const struct netdev
*netdev_
)
414 OVS_EXCLUDED(netdev_mutex
)
416 struct netdev
*netdev
= CONST_CAST(struct netdev
*, netdev_
);
419 ovs_mutex_lock(&netdev_mutex
);
420 ovs_assert(netdev
->ref_cnt
> 0);
422 ovs_mutex_unlock(&netdev_mutex
);
427 /* Reconfigures the device 'netdev' with 'args'. 'args' may be empty
428 * or NULL if none are needed. */
430 netdev_set_config(struct netdev
*netdev
, const struct smap
*args
, char **errp
)
431 OVS_EXCLUDED(netdev_mutex
)
433 if (netdev
->netdev_class
->set_config
) {
434 const struct smap no_args
= SMAP_INITIALIZER(&no_args
);
437 error
= netdev
->netdev_class
->set_config(netdev
,
438 args
? args
: &no_args
);
440 VLOG_WARN_BUF(errp
, "%s: could not set configuration (%s)",
441 netdev_get_name(netdev
), ovs_strerror(error
));
444 } else if (args
&& !smap_is_empty(args
)) {
445 VLOG_WARN_BUF(errp
, "%s: arguments provided to device that is not configurable",
446 netdev_get_name(netdev
));
451 /* Returns the current configuration for 'netdev' in 'args'. The caller must
452 * have already initialized 'args' with smap_init(). Returns 0 on success, in
453 * which case 'args' will be filled with 'netdev''s configuration. On failure
454 * returns a positive errno value, in which case 'args' will be empty.
456 * The caller owns 'args' and its contents and must eventually free them with
459 netdev_get_config(const struct netdev
*netdev
, struct smap
*args
)
460 OVS_EXCLUDED(netdev_mutex
)
465 if (netdev
->netdev_class
->get_config
) {
466 error
= netdev
->netdev_class
->get_config(netdev
, args
);
477 const struct netdev_tunnel_config
*
478 netdev_get_tunnel_config(const struct netdev
*netdev
)
479 OVS_EXCLUDED(netdev_mutex
)
481 if (netdev
->netdev_class
->get_tunnel_config
) {
482 return netdev
->netdev_class
->get_tunnel_config(netdev
);
488 /* Returns the id of the numa node the 'netdev' is on. If the function
489 * is not implemented, returns NETDEV_NUMA_UNSPEC. */
491 netdev_get_numa_id(const struct netdev
*netdev
)
493 if (netdev
->netdev_class
->get_numa_id
) {
494 return netdev
->netdev_class
->get_numa_id(netdev
);
496 return NETDEV_NUMA_UNSPEC
;
501 netdev_unref(struct netdev
*dev
)
502 OVS_RELEASES(netdev_mutex
)
504 ovs_assert(dev
->ref_cnt
);
505 if (!--dev
->ref_cnt
) {
506 const struct netdev_class
*class = dev
->netdev_class
;
507 struct netdev_registered_class
*rc
;
509 dev
->netdev_class
->destruct(dev
);
512 shash_delete(&netdev_shash
, dev
->node
);
515 dev
->netdev_class
->dealloc(dev
);
516 ovs_mutex_unlock(&netdev_mutex
);
518 ovs_mutex_lock(&netdev_class_mutex
);
519 rc
= netdev_lookup_class(class->type
);
520 ovs_assert(rc
->ref_cnt
> 0);
522 ovs_mutex_unlock(&netdev_class_mutex
);
524 ovs_mutex_unlock(&netdev_mutex
);
528 /* Closes and destroys 'netdev'. */
530 netdev_close(struct netdev
*netdev
)
531 OVS_EXCLUDED(netdev_mutex
)
534 ovs_mutex_lock(&netdev_mutex
);
535 netdev_unref(netdev
);
539 /* Removes 'netdev' from the global shash and unrefs 'netdev'.
541 * This allows handler and revalidator threads to still retain references
542 * to this netdev while the main thread changes interface configuration.
544 * This function should only be called by the main thread when closing
545 * netdevs during user configuration changes. Otherwise, netdev_close should be
546 * used to close netdevs. */
548 netdev_remove(struct netdev
*netdev
)
551 ovs_mutex_lock(&netdev_mutex
);
553 shash_delete(&netdev_shash
, netdev
->node
);
555 netdev_change_seq_changed(netdev
);
557 netdev_unref(netdev
);
561 /* Parses 'netdev_name_', which is of the form [type@]name into its component
562 * pieces. 'name' and 'type' must be freed by the caller. */
564 netdev_parse_name(const char *netdev_name_
, char **name
, char **type
)
566 char *netdev_name
= xstrdup(netdev_name_
);
569 separator
= strchr(netdev_name
, '@');
573 *name
= xstrdup(separator
+ 1);
576 *type
= xstrdup("system");
580 /* Attempts to open a netdev_rxq handle for obtaining packets received on
581 * 'netdev'. On success, returns 0 and stores a nonnull 'netdev_rxq *' into
582 * '*rxp'. On failure, returns a positive errno value and stores NULL into
585 * Some kinds of network devices might not support receiving packets. This
586 * function returns EOPNOTSUPP in that case.*/
588 netdev_rxq_open(struct netdev
*netdev
, struct netdev_rxq
**rxp
, int id
)
589 OVS_EXCLUDED(netdev_mutex
)
593 if (netdev
->netdev_class
->rxq_alloc
&& id
< netdev
->n_rxq
) {
594 struct netdev_rxq
*rx
= netdev
->netdev_class
->rxq_alloc();
598 error
= netdev
->netdev_class
->rxq_construct(rx
);
604 netdev
->netdev_class
->rxq_dealloc(rx
);
618 netdev_rxq_close(struct netdev_rxq
*rx
)
619 OVS_EXCLUDED(netdev_mutex
)
622 struct netdev
*netdev
= rx
->netdev
;
623 netdev
->netdev_class
->rxq_destruct(rx
);
624 netdev
->netdev_class
->rxq_dealloc(rx
);
625 netdev_close(netdev
);
629 /* Attempts to receive batch of packets from 'rx'.
631 * Returns EAGAIN immediately if no packet is ready to be received.
633 * Returns EMSGSIZE, and discards the packet, if the received packet is longer
634 * than 'ofpbuf_tailroom(buffer)'.
636 * It is advised that the tailroom of 'buffer' should be
637 * VLAN_HEADER_LEN bytes longer than the MTU to allow space for an
638 * out-of-band VLAN header to be added to the packet. At the very least,
639 * 'buffer' must have at least ETH_TOTAL_MIN bytes of tailroom.
641 * This function may be set to null if it would always return EOPNOTSUPP
644 netdev_rxq_recv(struct netdev_rxq
*rx
, struct dpif_packet
**buffers
, int *cnt
)
648 retval
= rx
->netdev
->netdev_class
->rxq_recv(rx
, buffers
, cnt
);
650 COVERAGE_INC(netdev_received
);
655 /* Arranges for poll_block() to wake up when a packet is ready to be received
658 netdev_rxq_wait(struct netdev_rxq
*rx
)
660 rx
->netdev
->netdev_class
->rxq_wait(rx
);
663 /* Discards any packets ready to be received on 'rx'. */
665 netdev_rxq_drain(struct netdev_rxq
*rx
)
667 return (rx
->netdev
->netdev_class
->rxq_drain
668 ? rx
->netdev
->netdev_class
->rxq_drain(rx
)
672 /* Configures the number of tx queues and rx queues of 'netdev'.
673 * Return 0 if successful, otherwise a positive errno value.
675 * On error, the tx queue and rx queue configuration is indeterminant.
676 * Caller should make decision on whether to restore the previous or
677 * the default configuration. Also, caller must make sure there is no
678 * other thread accessing the queues at the same time. */
680 netdev_set_multiq(struct netdev
*netdev
, unsigned int n_txq
,
685 error
= (netdev
->netdev_class
->set_multiq
686 ? netdev
->netdev_class
->set_multiq(netdev
,
691 if (error
&& error
!= EOPNOTSUPP
) {
692 VLOG_DBG_RL(&rl
, "failed to set tx/rx queue for network device %s:"
693 "%s", netdev_get_name(netdev
), ovs_strerror(error
));
699 /* Sends 'buffers' on 'netdev'. Returns 0 if successful (for every packet),
700 * otherwise a positive errno value. Returns EAGAIN without blocking if
701 * at least one the packets cannot be queued immediately. Returns EMSGSIZE
702 * if a partial packet was transmitted or if a packet is too big or too small
703 * to transmit on the device.
705 * If the function returns a non-zero value, some of the packets might have
708 * To retain ownership of 'buffer' caller can set may_steal to false.
710 * The network device is expected to maintain one or more packet
711 * transmission queues, so that the caller does not ordinarily have to
712 * do additional queuing of packets. 'qid' specifies the queue to use
713 * and can be ignored if the implementation does not support multiple
716 * Some network devices may not implement support for this function. In such
717 * cases this function will always return EOPNOTSUPP. */
719 netdev_send(struct netdev
*netdev
, int qid
, struct dpif_packet
**buffers
,
720 int cnt
, bool may_steal
)
724 error
= (netdev
->netdev_class
->send
725 ? netdev
->netdev_class
->send(netdev
, qid
, buffers
, cnt
, may_steal
)
728 COVERAGE_INC(netdev_sent
);
734 netdev_pop_header(struct netdev
*netdev
, struct dpif_packet
**buffers
, int cnt
)
736 return (netdev
->netdev_class
->pop_header
737 ? netdev
->netdev_class
->pop_header(netdev
, buffers
, cnt
)
742 netdev_build_header(const struct netdev
*netdev
, struct ovs_action_push_tnl
*data
)
744 if (netdev
->netdev_class
->build_header
) {
745 return netdev
->netdev_class
->build_header(netdev
, data
);
751 netdev_push_header(const struct netdev
*netdev
,
752 struct dpif_packet
**buffers
, int cnt
,
753 const struct ovs_action_push_tnl
*data
)
755 if (netdev
->netdev_class
->push_header
) {
756 return netdev
->netdev_class
->push_header(netdev
, buffers
, cnt
, data
);
762 /* Registers with the poll loop to wake up from the next call to poll_block()
763 * when the packet transmission queue has sufficient room to transmit a packet
764 * with netdev_send().
766 * The network device is expected to maintain one or more packet
767 * transmission queues, so that the caller does not ordinarily have to
768 * do additional queuing of packets. 'qid' specifies the queue to use
769 * and can be ignored if the implementation does not support multiple
772 netdev_send_wait(struct netdev
*netdev
, int qid
)
774 if (netdev
->netdev_class
->send_wait
) {
775 netdev
->netdev_class
->send_wait(netdev
, qid
);
779 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
780 * otherwise a positive errno value. */
782 netdev_set_etheraddr(struct netdev
*netdev
, const uint8_t mac
[ETH_ADDR_LEN
])
784 return netdev
->netdev_class
->set_etheraddr(netdev
, mac
);
787 /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
788 * the MAC address into 'mac'. On failure, returns a positive errno value and
789 * clears 'mac' to all-zeros. */
791 netdev_get_etheraddr(const struct netdev
*netdev
, uint8_t mac
[ETH_ADDR_LEN
])
793 return netdev
->netdev_class
->get_etheraddr(netdev
, mac
);
796 /* Returns the name of the network device that 'netdev' represents,
797 * e.g. "eth0". The caller must not modify or free the returned string. */
799 netdev_get_name(const struct netdev
*netdev
)
804 /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
805 * (and received) packets, in bytes, not including the hardware header; thus,
806 * this is typically 1500 bytes for Ethernet devices.
808 * If successful, returns 0 and stores the MTU size in '*mtup'. Returns
809 * EOPNOTSUPP if 'netdev' does not have an MTU (as e.g. some tunnels do not).
810 * On other failure, returns a positive errno value. On failure, sets '*mtup'
813 netdev_get_mtu(const struct netdev
*netdev
, int *mtup
)
815 const struct netdev_class
*class = netdev
->netdev_class
;
818 error
= class->get_mtu
? class->get_mtu(netdev
, mtup
) : EOPNOTSUPP
;
821 if (error
!= EOPNOTSUPP
) {
822 VLOG_DBG_RL(&rl
, "failed to retrieve MTU for network device %s: "
823 "%s", netdev_get_name(netdev
), ovs_strerror(error
));
829 /* Sets the MTU of 'netdev'. The MTU is the maximum size of transmitted
830 * (and received) packets, in bytes.
832 * If successful, returns 0. Returns EOPNOTSUPP if 'netdev' does not have an
833 * MTU (as e.g. some tunnels do not). On other failure, returns a positive
836 netdev_set_mtu(const struct netdev
*netdev
, int mtu
)
838 const struct netdev_class
*class = netdev
->netdev_class
;
841 error
= class->set_mtu
? class->set_mtu(netdev
, mtu
) : EOPNOTSUPP
;
842 if (error
&& error
!= EOPNOTSUPP
) {
843 VLOG_DBG_RL(&rl
, "failed to set MTU for network device %s: %s",
844 netdev_get_name(netdev
), ovs_strerror(error
));
850 /* Returns the ifindex of 'netdev', if successful, as a positive number. On
851 * failure, returns a negative errno value.
853 * The desired semantics of the ifindex value are a combination of those
854 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex
855 * value should be unique within a host and remain stable at least until
856 * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber"
857 * but many systems do not follow this rule anyhow.
859 * Some network devices may not implement support for this function. In such
860 * cases this function will always return -EOPNOTSUPP.
863 netdev_get_ifindex(const struct netdev
*netdev
)
865 int (*get_ifindex
)(const struct netdev
*);
867 get_ifindex
= netdev
->netdev_class
->get_ifindex
;
869 return get_ifindex
? get_ifindex(netdev
) : -EOPNOTSUPP
;
872 /* Stores the features supported by 'netdev' into each of '*current',
873 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
874 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
875 * successful, otherwise a positive errno value. On failure, all of the
876 * passed-in values are set to 0.
878 * Some network devices may not implement support for this function. In such
879 * cases this function will always return EOPNOTSUPP. */
881 netdev_get_features(const struct netdev
*netdev
,
882 enum netdev_features
*current
,
883 enum netdev_features
*advertised
,
884 enum netdev_features
*supported
,
885 enum netdev_features
*peer
)
887 int (*get_features
)(const struct netdev
*netdev
,
888 enum netdev_features
*current
,
889 enum netdev_features
*advertised
,
890 enum netdev_features
*supported
,
891 enum netdev_features
*peer
);
892 enum netdev_features dummy
[4];
899 advertised
= &dummy
[1];
902 supported
= &dummy
[2];
908 get_features
= netdev
->netdev_class
->get_features
;
910 ? get_features(netdev
, current
, advertised
, supported
,
914 *current
= *advertised
= *supported
= *peer
= 0;
919 /* Returns the maximum speed of a network connection that has the NETDEV_F_*
920 * bits in 'features', in bits per second. If no bits that indicate a speed
921 * are set in 'features', returns 'default_bps'. */
923 netdev_features_to_bps(enum netdev_features features
,
924 uint64_t default_bps
)
927 F_1000000MB
= NETDEV_F_1TB_FD
,
928 F_100000MB
= NETDEV_F_100GB_FD
,
929 F_40000MB
= NETDEV_F_40GB_FD
,
930 F_10000MB
= NETDEV_F_10GB_FD
,
931 F_1000MB
= NETDEV_F_1GB_HD
| NETDEV_F_1GB_FD
,
932 F_100MB
= NETDEV_F_100MB_HD
| NETDEV_F_100MB_FD
,
933 F_10MB
= NETDEV_F_10MB_HD
| NETDEV_F_10MB_FD
936 return ( features
& F_1000000MB
? UINT64_C(1000000000000)
937 : features
& F_100000MB
? UINT64_C(100000000000)
938 : features
& F_40000MB
? UINT64_C(40000000000)
939 : features
& F_10000MB
? UINT64_C(10000000000)
940 : features
& F_1000MB
? UINT64_C(1000000000)
941 : features
& F_100MB
? UINT64_C(100000000)
942 : features
& F_10MB
? UINT64_C(10000000)
946 /* Returns true if any of the NETDEV_F_* bits that indicate a full-duplex link
947 * are set in 'features', otherwise false. */
949 netdev_features_is_full_duplex(enum netdev_features features
)
951 return (features
& (NETDEV_F_10MB_FD
| NETDEV_F_100MB_FD
| NETDEV_F_1GB_FD
952 | NETDEV_F_10GB_FD
| NETDEV_F_40GB_FD
953 | NETDEV_F_100GB_FD
| NETDEV_F_1TB_FD
)) != 0;
956 /* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if
957 * successful, otherwise a positive errno value. */
959 netdev_set_advertisements(struct netdev
*netdev
,
960 enum netdev_features advertise
)
962 return (netdev
->netdev_class
->set_advertisements
963 ? netdev
->netdev_class
->set_advertisements(
968 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
969 * and '*netmask' to its netmask and returns 0. Otherwise, returns a positive
970 * errno value and sets '*address' to 0 (INADDR_ANY).
972 * The following error values have well-defined meanings:
974 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
976 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
978 * 'address' or 'netmask' or both may be null, in which case the address or
979 * netmask is not reported. */
981 netdev_get_in4(const struct netdev
*netdev
,
982 struct in_addr
*address_
, struct in_addr
*netmask_
)
984 struct in_addr address
;
985 struct in_addr netmask
;
988 error
= (netdev
->netdev_class
->get_in4
989 ? netdev
->netdev_class
->get_in4(netdev
,
993 address_
->s_addr
= error
? 0 : address
.s_addr
;
996 netmask_
->s_addr
= error
? 0 : netmask
.s_addr
;
1001 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
1002 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a
1003 * positive errno value. */
1005 netdev_set_in4(struct netdev
*netdev
, struct in_addr addr
, struct in_addr mask
)
1007 return (netdev
->netdev_class
->set_in4
1008 ? netdev
->netdev_class
->set_in4(netdev
, addr
, mask
)
1012 /* Obtains ad IPv4 address from device name and save the address in
1013 * in4. Returns 0 if successful, otherwise a positive errno value.
1016 netdev_get_in4_by_name(const char *device_name
, struct in_addr
*in4
)
1018 struct netdev
*netdev
;
1021 error
= netdev_open(device_name
, "system", &netdev
);
1023 in4
->s_addr
= htonl(0);
1027 error
= netdev_get_in4(netdev
, in4
, NULL
);
1028 netdev_close(netdev
);
1032 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
1035 netdev_add_router(struct netdev
*netdev
, struct in_addr router
)
1037 COVERAGE_INC(netdev_add_router
);
1038 return (netdev
->netdev_class
->add_router
1039 ? netdev
->netdev_class
->add_router(netdev
, router
)
1043 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
1044 * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0,
1045 * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a
1046 * next hop is found, stores the next hop gateway's address (0 if 'host' is on
1047 * a directly connected network) in '*next_hop' and a copy of the name of the
1048 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
1049 * responsible for freeing '*netdev_name' (by calling free()). */
1051 netdev_get_next_hop(const struct netdev
*netdev
,
1052 const struct in_addr
*host
, struct in_addr
*next_hop
,
1055 int error
= (netdev
->netdev_class
->get_next_hop
1056 ? netdev
->netdev_class
->get_next_hop(
1057 host
, next_hop
, netdev_name
)
1060 next_hop
->s_addr
= 0;
1061 *netdev_name
= NULL
;
1066 /* Populates 'smap' with status information.
1068 * Populates 'smap' with 'netdev' specific status information. This
1069 * information may be used to populate the status column of the Interface table
1070 * as defined in ovs-vswitchd.conf.db(5). */
1072 netdev_get_status(const struct netdev
*netdev
, struct smap
*smap
)
1074 return (netdev
->netdev_class
->get_status
1075 ? netdev
->netdev_class
->get_status(netdev
, smap
)
1079 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
1080 * returns 0. Otherwise, returns a positive errno value and sets '*in6' to
1081 * all-zero-bits (in6addr_any).
1083 * The following error values have well-defined meanings:
1085 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
1087 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
1089 * 'in6' may be null, in which case the address itself is not reported. */
1091 netdev_get_in6(const struct netdev
*netdev
, struct in6_addr
*in6
)
1093 struct in6_addr dummy
;
1096 error
= (netdev
->netdev_class
->get_in6
1097 ? netdev
->netdev_class
->get_in6(netdev
,
1101 memset(in6
, 0, sizeof *in6
);
1106 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
1107 * 'on'. Returns 0 if successful, otherwise a positive errno value. */
1109 do_update_flags(struct netdev
*netdev
, enum netdev_flags off
,
1110 enum netdev_flags on
, enum netdev_flags
*old_flagsp
,
1111 struct netdev_saved_flags
**sfp
)
1112 OVS_EXCLUDED(netdev_mutex
)
1114 struct netdev_saved_flags
*sf
= NULL
;
1115 enum netdev_flags old_flags
;
1118 error
= netdev
->netdev_class
->update_flags(netdev
, off
& ~on
, on
,
1121 VLOG_WARN_RL(&rl
, "failed to %s flags for network device %s: %s",
1122 off
|| on
? "set" : "get", netdev_get_name(netdev
),
1123 ovs_strerror(error
));
1125 } else if ((off
|| on
) && sfp
) {
1126 enum netdev_flags new_flags
= (old_flags
& ~off
) | on
;
1127 enum netdev_flags changed_flags
= old_flags
^ new_flags
;
1128 if (changed_flags
) {
1129 ovs_mutex_lock(&netdev_mutex
);
1130 *sfp
= sf
= xmalloc(sizeof *sf
);
1131 sf
->netdev
= netdev
;
1132 list_push_front(&netdev
->saved_flags_list
, &sf
->node
);
1133 sf
->saved_flags
= changed_flags
;
1134 sf
->saved_values
= changed_flags
& new_flags
;
1137 ovs_mutex_unlock(&netdev_mutex
);
1142 *old_flagsp
= old_flags
;
1151 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
1152 * Returns 0 if successful, otherwise a positive errno value. On failure,
1153 * stores 0 into '*flagsp'. */
1155 netdev_get_flags(const struct netdev
*netdev_
, enum netdev_flags
*flagsp
)
1157 struct netdev
*netdev
= CONST_CAST(struct netdev
*, netdev_
);
1158 return do_update_flags(netdev
, 0, 0, flagsp
, NULL
);
1161 /* Sets the flags for 'netdev' to 'flags'.
1162 * Returns 0 if successful, otherwise a positive errno value. */
1164 netdev_set_flags(struct netdev
*netdev
, enum netdev_flags flags
,
1165 struct netdev_saved_flags
**sfp
)
1167 return do_update_flags(netdev
, -1, flags
, NULL
, sfp
);
1170 /* Turns on the specified 'flags' on 'netdev':
1172 * - On success, returns 0. If 'sfp' is nonnull, sets '*sfp' to a newly
1173 * allocated 'struct netdev_saved_flags *' that may be passed to
1174 * netdev_restore_flags() to restore the original values of 'flags' on
1175 * 'netdev' (this will happen automatically at program termination if
1176 * netdev_restore_flags() is never called) , or to NULL if no flags were
1179 * - On failure, returns a positive errno value. If 'sfp' is nonnull, sets
1180 * '*sfp' to NULL. */
1182 netdev_turn_flags_on(struct netdev
*netdev
, enum netdev_flags flags
,
1183 struct netdev_saved_flags
**sfp
)
1185 return do_update_flags(netdev
, 0, flags
, NULL
, sfp
);
1188 /* Turns off the specified 'flags' on 'netdev'. See netdev_turn_flags_on() for
1189 * details of the interface. */
1191 netdev_turn_flags_off(struct netdev
*netdev
, enum netdev_flags flags
,
1192 struct netdev_saved_flags
**sfp
)
1194 return do_update_flags(netdev
, flags
, 0, NULL
, sfp
);
1197 /* Restores the flags that were saved in 'sf', and destroys 'sf'.
1198 * Does nothing if 'sf' is NULL. */
1200 netdev_restore_flags(struct netdev_saved_flags
*sf
)
1201 OVS_EXCLUDED(netdev_mutex
)
1204 struct netdev
*netdev
= sf
->netdev
;
1205 enum netdev_flags old_flags
;
1207 netdev
->netdev_class
->update_flags(netdev
,
1208 sf
->saved_flags
& sf
->saved_values
,
1209 sf
->saved_flags
& ~sf
->saved_values
,
1212 ovs_mutex_lock(&netdev_mutex
);
1213 list_remove(&sf
->node
);
1215 netdev_unref(netdev
);
1219 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
1220 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
1221 * returns 0. Otherwise, it returns a positive errno value; in particular,
1222 * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
1224 netdev_arp_lookup(const struct netdev
*netdev
,
1225 ovs_be32 ip
, uint8_t mac
[ETH_ADDR_LEN
])
1227 int error
= (netdev
->netdev_class
->arp_lookup
1228 ? netdev
->netdev_class
->arp_lookup(netdev
, ip
, mac
)
1231 memset(mac
, 0, ETH_ADDR_LEN
);
1236 /* Returns true if carrier is active (link light is on) on 'netdev'. */
1238 netdev_get_carrier(const struct netdev
*netdev
)
1241 enum netdev_flags flags
;
1244 netdev_get_flags(netdev
, &flags
);
1245 if (!(flags
& NETDEV_UP
)) {
1249 if (!netdev
->netdev_class
->get_carrier
) {
1253 error
= netdev
->netdev_class
->get_carrier(netdev
, &carrier
);
1255 VLOG_DBG("%s: failed to get network device carrier status, assuming "
1256 "down: %s", netdev_get_name(netdev
), ovs_strerror(error
));
1263 /* Returns the number of times 'netdev''s carrier has changed. */
1265 netdev_get_carrier_resets(const struct netdev
*netdev
)
1267 return (netdev
->netdev_class
->get_carrier_resets
1268 ? netdev
->netdev_class
->get_carrier_resets(netdev
)
1272 /* Attempts to force netdev_get_carrier() to poll 'netdev''s MII registers for
1273 * link status instead of checking 'netdev''s carrier. 'netdev''s MII
1274 * registers will be polled once ever 'interval' milliseconds. If 'netdev'
1275 * does not support MII, another method may be used as a fallback. If
1276 * 'interval' is less than or equal to zero, reverts netdev_get_carrier() to
1277 * its normal behavior.
1279 * Returns 0 if successful, otherwise a positive errno value. */
1281 netdev_set_miimon_interval(struct netdev
*netdev
, long long int interval
)
1283 return (netdev
->netdev_class
->set_miimon_interval
1284 ? netdev
->netdev_class
->set_miimon_interval(netdev
, interval
)
1288 /* Retrieves current device stats for 'netdev'. */
1290 netdev_get_stats(const struct netdev
*netdev
, struct netdev_stats
*stats
)
1294 COVERAGE_INC(netdev_get_stats
);
1295 error
= (netdev
->netdev_class
->get_stats
1296 ? netdev
->netdev_class
->get_stats(netdev
, stats
)
1299 memset(stats
, 0xff, sizeof *stats
);
1304 /* Attempts to set input rate limiting (policing) policy, such that up to
1305 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
1306 * size of 'kbits' kb. */
1308 netdev_set_policing(struct netdev
*netdev
, uint32_t kbits_rate
,
1309 uint32_t kbits_burst
)
1311 return (netdev
->netdev_class
->set_policing
1312 ? netdev
->netdev_class
->set_policing(netdev
,
1313 kbits_rate
, kbits_burst
)
1317 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
1318 * empty if 'netdev' does not support QoS. Any names added to 'types' should
1319 * be documented as valid for the "type" column in the "QoS" table in
1320 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1322 * Every network device supports disabling QoS with a type of "", but this type
1323 * will not be added to 'types'.
1325 * The caller must initialize 'types' (e.g. with sset_init()) before calling
1326 * this function. The caller is responsible for destroying 'types' (e.g. with
1327 * sset_destroy()) when it is no longer needed.
1329 * Returns 0 if successful, otherwise a positive errno value. */
1331 netdev_get_qos_types(const struct netdev
*netdev
, struct sset
*types
)
1333 const struct netdev_class
*class = netdev
->netdev_class
;
1334 return (class->get_qos_types
1335 ? class->get_qos_types(netdev
, types
)
1339 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
1340 * which should be "" or one of the types returned by netdev_get_qos_types()
1341 * for 'netdev'. Returns 0 if successful, otherwise a positive errno value.
1342 * On success, initializes 'caps' with the QoS capabilities; on failure, clears
1343 * 'caps' to all zeros. */
1345 netdev_get_qos_capabilities(const struct netdev
*netdev
, const char *type
,
1346 struct netdev_qos_capabilities
*caps
)
1348 const struct netdev_class
*class = netdev
->netdev_class
;
1351 int retval
= (class->get_qos_capabilities
1352 ? class->get_qos_capabilities(netdev
, type
, caps
)
1355 memset(caps
, 0, sizeof *caps
);
1359 /* Every netdev supports turning off QoS. */
1360 memset(caps
, 0, sizeof *caps
);
1365 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
1366 * of QoS. Returns 0 if successful, otherwise a positive errno value. Stores
1367 * the number of queues (zero on failure) in '*n_queuesp'.
1369 * This is just a simple wrapper around netdev_get_qos_capabilities(). */
1371 netdev_get_n_queues(const struct netdev
*netdev
,
1372 const char *type
, unsigned int *n_queuesp
)
1374 struct netdev_qos_capabilities caps
;
1377 retval
= netdev_get_qos_capabilities(netdev
, type
, &caps
);
1378 *n_queuesp
= caps
.n_queues
;
1382 /* Queries 'netdev' about its currently configured form of QoS. If successful,
1383 * stores the name of the current form of QoS into '*typep', stores any details
1384 * of configuration as string key-value pairs in 'details', and returns 0. On
1385 * failure, sets '*typep' to NULL and returns a positive errno value.
1387 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1389 * The caller must initialize 'details' as an empty smap (e.g. with
1390 * smap_init()) before calling this function. The caller must free 'details'
1391 * when it is no longer needed (e.g. with smap_destroy()).
1393 * The caller must not modify or free '*typep'.
1395 * '*typep' will be one of the types returned by netdev_get_qos_types() for
1396 * 'netdev'. The contents of 'details' should be documented as valid for
1397 * '*typep' in the "other_config" column in the "QoS" table in
1398 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1400 netdev_get_qos(const struct netdev
*netdev
,
1401 const char **typep
, struct smap
*details
)
1403 const struct netdev_class
*class = netdev
->netdev_class
;
1406 if (class->get_qos
) {
1407 retval
= class->get_qos(netdev
, typep
, details
);
1410 smap_clear(details
);
1414 /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1420 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1421 * with details of configuration from 'details'. Returns 0 if successful,
1422 * otherwise a positive errno value. On error, the previous QoS configuration
1425 * When this function changes the type of QoS (not just 'details'), this also
1426 * resets all queue configuration for 'netdev' to their defaults (which depend
1427 * on the specific type of QoS). Otherwise, the queue configuration for
1428 * 'netdev' is unchanged.
1430 * 'type' should be "" (to disable QoS) or one of the types returned by
1431 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should be
1432 * documented as valid for the given 'type' in the "other_config" column in the
1433 * "QoS" table in vswitchd/vswitch.xml (which is built as
1434 * ovs-vswitchd.conf.db(8)).
1436 * NULL may be specified for 'details' if there are no configuration
1439 netdev_set_qos(struct netdev
*netdev
,
1440 const char *type
, const struct smap
*details
)
1442 const struct netdev_class
*class = netdev
->netdev_class
;
1448 if (class->set_qos
) {
1450 static const struct smap empty
= SMAP_INITIALIZER(&empty
);
1453 return class->set_qos(netdev
, type
, details
);
1455 return *type
? EOPNOTSUPP
: 0;
1459 /* Queries 'netdev' for information about the queue numbered 'queue_id'. If
1460 * successful, adds that information as string key-value pairs to 'details'.
1461 * Returns 0 if successful, otherwise a positive errno value.
1463 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1464 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1466 * The returned contents of 'details' should be documented as valid for the
1467 * given 'type' in the "other_config" column in the "Queue" table in
1468 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1470 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1471 * this function. The caller must free 'details' when it is no longer needed
1472 * (e.g. with smap_destroy()). */
1474 netdev_get_queue(const struct netdev
*netdev
,
1475 unsigned int queue_id
, struct smap
*details
)
1477 const struct netdev_class
*class = netdev
->netdev_class
;
1480 retval
= (class->get_queue
1481 ? class->get_queue(netdev
, queue_id
, details
)
1484 smap_clear(details
);
1489 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1490 * string pairs in 'details'. The contents of 'details' should be documented
1491 * as valid for the given 'type' in the "other_config" column in the "Queue"
1492 * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1493 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1494 * given queue's configuration should be unmodified.
1496 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1497 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1499 * This function does not modify 'details', and the caller retains ownership of
1502 netdev_set_queue(struct netdev
*netdev
,
1503 unsigned int queue_id
, const struct smap
*details
)
1505 const struct netdev_class
*class = netdev
->netdev_class
;
1506 return (class->set_queue
1507 ? class->set_queue(netdev
, queue_id
, details
)
1511 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'. Some kinds
1512 * of QoS may have a fixed set of queues, in which case attempts to delete them
1513 * will fail with EOPNOTSUPP.
1515 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1516 * given queue will be unmodified.
1518 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1519 * the current form of QoS (e.g. as returned by
1520 * netdev_get_n_queues(netdev)). */
1522 netdev_delete_queue(struct netdev
*netdev
, unsigned int queue_id
)
1524 const struct netdev_class
*class = netdev
->netdev_class
;
1525 return (class->delete_queue
1526 ? class->delete_queue(netdev
, queue_id
)
1530 /* Obtains statistics about 'queue_id' on 'netdev'. On success, returns 0 and
1531 * fills 'stats' with the queue's statistics; individual members of 'stats' may
1532 * be set to all-1-bits if the statistic is unavailable. On failure, returns a
1533 * positive errno value and fills 'stats' with values indicating unsupported
1536 netdev_get_queue_stats(const struct netdev
*netdev
, unsigned int queue_id
,
1537 struct netdev_queue_stats
*stats
)
1539 const struct netdev_class
*class = netdev
->netdev_class
;
1542 retval
= (class->get_queue_stats
1543 ? class->get_queue_stats(netdev
, queue_id
, stats
)
1546 stats
->tx_bytes
= UINT64_MAX
;
1547 stats
->tx_packets
= UINT64_MAX
;
1548 stats
->tx_errors
= UINT64_MAX
;
1549 stats
->created
= LLONG_MIN
;
1554 /* Initializes 'dump' to begin dumping the queues in a netdev.
1556 * This function provides no status indication. An error status for the entire
1557 * dump operation is provided when it is completed by calling
1558 * netdev_queue_dump_done().
1561 netdev_queue_dump_start(struct netdev_queue_dump
*dump
,
1562 const struct netdev
*netdev
)
1564 dump
->netdev
= netdev_ref(netdev
);
1565 if (netdev
->netdev_class
->queue_dump_start
) {
1566 dump
->error
= netdev
->netdev_class
->queue_dump_start(netdev
,
1569 dump
->error
= EOPNOTSUPP
;
1573 /* Attempts to retrieve another queue from 'dump', which must have been
1574 * initialized with netdev_queue_dump_start(). On success, stores a new queue
1575 * ID into '*queue_id', fills 'details' with configuration details for the
1576 * queue, and returns true. On failure, returns false.
1578 * Queues are not necessarily dumped in increasing order of queue ID (or any
1579 * other predictable order).
1581 * Failure might indicate an actual error or merely that the last queue has
1582 * been dumped. An error status for the entire dump operation is provided when
1583 * it is completed by calling netdev_queue_dump_done().
1585 * The returned contents of 'details' should be documented as valid for the
1586 * given 'type' in the "other_config" column in the "Queue" table in
1587 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1589 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1590 * this function. This function will clear and replace its contents. The
1591 * caller must free 'details' when it is no longer needed (e.g. with
1592 * smap_destroy()). */
1594 netdev_queue_dump_next(struct netdev_queue_dump
*dump
,
1595 unsigned int *queue_id
, struct smap
*details
)
1597 const struct netdev
*netdev
= dump
->netdev
;
1603 dump
->error
= netdev
->netdev_class
->queue_dump_next(netdev
, dump
->state
,
1607 netdev
->netdev_class
->queue_dump_done(netdev
, dump
->state
);
1613 /* Completes queue table dump operation 'dump', which must have been
1614 * initialized with netdev_queue_dump_start(). Returns 0 if the dump operation
1615 * was error-free, otherwise a positive errno value describing the problem. */
1617 netdev_queue_dump_done(struct netdev_queue_dump
*dump
)
1619 const struct netdev
*netdev
= dump
->netdev
;
1620 if (!dump
->error
&& netdev
->netdev_class
->queue_dump_done
) {
1621 dump
->error
= netdev
->netdev_class
->queue_dump_done(netdev
,
1624 netdev_close(dump
->netdev
);
1625 return dump
->error
== EOF
? 0 : dump
->error
;
1628 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1629 * its statistics, and the 'aux' specified by the caller. The order of
1630 * iteration is unspecified, but (when successful) each queue is visited
1633 * Calling this function may be more efficient than calling
1634 * netdev_get_queue_stats() for every queue.
1636 * 'cb' must not modify or free the statistics passed in.
1638 * Returns 0 if successful, otherwise a positive errno value. On error, some
1639 * configured queues may not have been included in the iteration. */
1641 netdev_dump_queue_stats(const struct netdev
*netdev
,
1642 netdev_dump_queue_stats_cb
*cb
, void *aux
)
1644 const struct netdev_class
*class = netdev
->netdev_class
;
1645 return (class->dump_queue_stats
1646 ? class->dump_queue_stats(netdev
, cb
, aux
)
1651 /* Returns the class type of 'netdev'.
1653 * The caller must not free the returned value. */
1655 netdev_get_type(const struct netdev
*netdev
)
1657 return netdev
->netdev_class
->type
;
1660 /* Returns the class associated with 'netdev'. */
1661 const struct netdev_class
*
1662 netdev_get_class(const struct netdev
*netdev
)
1664 return netdev
->netdev_class
;
1667 /* Returns the netdev with 'name' or NULL if there is none.
1669 * The caller must free the returned netdev with netdev_close(). */
1671 netdev_from_name(const char *name
)
1672 OVS_EXCLUDED(netdev_mutex
)
1674 struct netdev
*netdev
;
1676 ovs_mutex_lock(&netdev_mutex
);
1677 netdev
= shash_find_data(&netdev_shash
, name
);
1681 ovs_mutex_unlock(&netdev_mutex
);
1686 /* Fills 'device_list' with devices that match 'netdev_class'.
1688 * The caller is responsible for initializing and destroying 'device_list' and
1689 * must close each device on the list. */
1691 netdev_get_devices(const struct netdev_class
*netdev_class
,
1692 struct shash
*device_list
)
1693 OVS_EXCLUDED(netdev_mutex
)
1695 struct shash_node
*node
;
1697 ovs_mutex_lock(&netdev_mutex
);
1698 SHASH_FOR_EACH (node
, &netdev_shash
) {
1699 struct netdev
*dev
= node
->data
;
1701 if (dev
->netdev_class
== netdev_class
) {
1703 shash_add(device_list
, node
->name
, node
->data
);
1706 ovs_mutex_unlock(&netdev_mutex
);
1709 /* Extracts pointers to all 'netdev-vports' into an array 'vports'
1710 * and returns it. Stores the size of the array into '*size'.
1712 * The caller is responsible for freeing 'vports' and must close
1713 * each 'netdev-vport' in the list. */
1715 netdev_get_vports(size_t *size
)
1716 OVS_EXCLUDED(netdev_mutex
)
1718 struct netdev
**vports
;
1719 struct shash_node
*node
;
1726 /* Explicitly allocates big enough chunk of memory. */
1727 vports
= xmalloc(shash_count(&netdev_shash
) * sizeof *vports
);
1728 ovs_mutex_lock(&netdev_mutex
);
1729 SHASH_FOR_EACH (node
, &netdev_shash
) {
1730 struct netdev
*dev
= node
->data
;
1732 if (netdev_vport_is_vport_class(dev
->netdev_class
)) {
1738 ovs_mutex_unlock(&netdev_mutex
);
1745 netdev_get_type_from_name(const char *name
)
1747 struct netdev
*dev
= netdev_from_name(name
);
1748 const char *type
= dev
? netdev_get_type(dev
) : NULL
;
1754 netdev_rxq_get_netdev(const struct netdev_rxq
*rx
)
1756 ovs_assert(rx
->netdev
->ref_cnt
> 0);
1761 netdev_rxq_get_name(const struct netdev_rxq
*rx
)
1763 return netdev_get_name(netdev_rxq_get_netdev(rx
));
1767 restore_all_flags(void *aux OVS_UNUSED
)
1769 struct shash_node
*node
;
1771 SHASH_FOR_EACH (node
, &netdev_shash
) {
1772 struct netdev
*netdev
= node
->data
;
1773 const struct netdev_saved_flags
*sf
;
1774 enum netdev_flags saved_values
;
1775 enum netdev_flags saved_flags
;
1777 saved_values
= saved_flags
= 0;
1778 LIST_FOR_EACH (sf
, node
, &netdev
->saved_flags_list
) {
1779 saved_flags
|= sf
->saved_flags
;
1780 saved_values
&= ~sf
->saved_flags
;
1781 saved_values
|= sf
->saved_flags
& sf
->saved_values
;
1784 enum netdev_flags old_flags
;
1786 netdev
->netdev_class
->update_flags(netdev
,
1787 saved_flags
& saved_values
,
1788 saved_flags
& ~saved_values
,
1795 netdev_get_change_seq(const struct netdev
*netdev
)
1797 return netdev
->change_seq
;