2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
23 #include "openvswitch/types.h"
29 /* Generic interface to network devices ("netdev"s).
31 * Every port on a switch must have a corresponding netdev that must minimally
32 * support a few operations, such as the ability to read the netdev's MTU.
33 * The PORTING file at the top of the source tree has more information in the
34 * "Writing a netdev Provider" section.
39 * Most of the netdev functions are fully thread-safe: they may be called from
40 * any number of threads on the same or different netdev objects. The
47 * These functions are conditionally thread-safe: they may be called from
48 * different threads only on different netdev_rxq objects. (The client may
49 * create multiple netdev_rxq objects for a single netdev and access each
50 * of those from a different thread.)
52 * NETDEV_FOR_EACH_QUEUE
53 * netdev_queue_dump_next()
54 * netdev_queue_dump_done()
56 * These functions are conditionally thread-safe: they may be called from
57 * different threads only on different netdev_queue_dump objects. (The
58 * client may create multiple netdev_queue_dump objects for a single
59 * netdev and access each of those from a different thread.)
65 struct netdev_saved_flags
;
72 /* Network device statistics.
74 * Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
76 uint64_t rx_packets
; /* Total packets received. */
77 uint64_t tx_packets
; /* Total packets transmitted. */
78 uint64_t rx_bytes
; /* Total bytes received. */
79 uint64_t tx_bytes
; /* Total bytes transmitted. */
80 uint64_t rx_errors
; /* Bad packets received. */
81 uint64_t tx_errors
; /* Packet transmit problems. */
82 uint64_t rx_dropped
; /* No buffer space. */
83 uint64_t tx_dropped
; /* No buffer space. */
84 uint64_t multicast
; /* Multicast packets received. */
87 /* Detailed receive errors. */
88 uint64_t rx_length_errors
;
89 uint64_t rx_over_errors
; /* Receiver ring buff overflow. */
90 uint64_t rx_crc_errors
; /* Recved pkt with crc error. */
91 uint64_t rx_frame_errors
; /* Recv'd frame alignment error. */
92 uint64_t rx_fifo_errors
; /* Recv'r fifo overrun . */
93 uint64_t rx_missed_errors
; /* Receiver missed packet. */
95 /* Detailed transmit errors. */
96 uint64_t tx_aborted_errors
;
97 uint64_t tx_carrier_errors
;
98 uint64_t tx_fifo_errors
;
99 uint64_t tx_heartbeat_errors
;
100 uint64_t tx_window_errors
;
103 /* Configuration specific to tunnels. */
104 struct netdev_tunnel_config
{
109 bool out_key_present
;
131 void netdev_run(void);
132 void netdev_wait(void);
134 void netdev_enumerate_types(struct sset
*types
);
135 bool netdev_is_reserved_name(const char *name
);
137 bool netdev_is_pmd(const struct netdev
*netdev
);
139 /* Open and close. */
140 int netdev_open(const char *name
, const char *type
, struct netdev
**netdevp
);
142 struct netdev
*netdev_ref(const struct netdev
*);
143 void netdev_close(struct netdev
*);
145 void netdev_parse_name(const char *netdev_name
, char **name
, char **type
);
148 int netdev_set_config(struct netdev
*, const struct smap
*args
);
149 int netdev_get_config(const struct netdev
*, struct smap
*);
150 const struct netdev_tunnel_config
*
151 netdev_get_tunnel_config(const struct netdev
*);
153 /* Basic properties. */
154 const char *netdev_get_name(const struct netdev
*);
155 const char *netdev_get_type(const struct netdev
*);
156 const char *netdev_get_type_from_name(const char *);
157 int netdev_get_mtu(const struct netdev
*, int *mtup
);
158 int netdev_set_mtu(const struct netdev
*, int mtu
);
159 int netdev_get_ifindex(const struct netdev
*);
161 /* Packet reception. */
162 int netdev_rxq_open(struct netdev
*, struct netdev_rxq
**);
163 void netdev_rxq_close(struct netdev_rxq
*);
165 const char *netdev_rxq_get_name(const struct netdev_rxq
*);
167 int netdev_rxq_recv(struct netdev_rxq
*rx
, struct ofpbuf
**buffers
, int *cnt
);
168 void netdev_rxq_wait(struct netdev_rxq
*);
169 int netdev_rxq_drain(struct netdev_rxq
*);
171 /* Packet transmission. */
172 int netdev_send(struct netdev
*, struct ofpbuf
*, bool may_steal
);
173 void netdev_send_wait(struct netdev
*);
175 /* Hardware address. */
176 int netdev_set_etheraddr(struct netdev
*, const uint8_t mac
[6]);
177 int netdev_get_etheraddr(const struct netdev
*, uint8_t mac
[6]);
180 bool netdev_get_carrier(const struct netdev
*);
181 long long int netdev_get_carrier_resets(const struct netdev
*);
182 int netdev_set_miimon_interval(struct netdev
*, long long int interval
);
185 enum netdev_features
{
186 NETDEV_F_10MB_HD
= 1 << 0, /* 10 Mb half-duplex rate support. */
187 NETDEV_F_10MB_FD
= 1 << 1, /* 10 Mb full-duplex rate support. */
188 NETDEV_F_100MB_HD
= 1 << 2, /* 100 Mb half-duplex rate support. */
189 NETDEV_F_100MB_FD
= 1 << 3, /* 100 Mb full-duplex rate support. */
190 NETDEV_F_1GB_HD
= 1 << 4, /* 1 Gb half-duplex rate support. */
191 NETDEV_F_1GB_FD
= 1 << 5, /* 1 Gb full-duplex rate support. */
192 NETDEV_F_10GB_FD
= 1 << 6, /* 10 Gb full-duplex rate support. */
193 NETDEV_F_40GB_FD
= 1 << 7, /* 40 Gb full-duplex rate support. */
194 NETDEV_F_100GB_FD
= 1 << 8, /* 100 Gb full-duplex rate support. */
195 NETDEV_F_1TB_FD
= 1 << 9, /* 1 Tb full-duplex rate support. */
196 NETDEV_F_OTHER
= 1 << 10, /* Other rate, not in the list. */
197 NETDEV_F_COPPER
= 1 << 11, /* Copper medium. */
198 NETDEV_F_FIBER
= 1 << 12, /* Fiber medium. */
199 NETDEV_F_AUTONEG
= 1 << 13, /* Auto-negotiation. */
200 NETDEV_F_PAUSE
= 1 << 14, /* Pause. */
201 NETDEV_F_PAUSE_ASYM
= 1 << 15, /* Asymmetric pause. */
204 int netdev_get_features(const struct netdev
*,
205 enum netdev_features
*current
,
206 enum netdev_features
*advertised
,
207 enum netdev_features
*supported
,
208 enum netdev_features
*peer
);
209 uint64_t netdev_features_to_bps(enum netdev_features features
,
210 uint64_t default_bps
);
211 bool netdev_features_is_full_duplex(enum netdev_features features
);
212 int netdev_set_advertisements(struct netdev
*, enum netdev_features advertise
);
216 NETDEV_UP
= 0x0001, /* Device enabled? */
217 NETDEV_PROMISC
= 0x0002, /* Promiscuous mode? */
218 NETDEV_LOOPBACK
= 0x0004 /* This is a loopback device. */
221 int netdev_get_flags(const struct netdev
*, enum netdev_flags
*);
222 int netdev_set_flags(struct netdev
*, enum netdev_flags
,
223 struct netdev_saved_flags
**);
224 int netdev_turn_flags_on(struct netdev
*, enum netdev_flags
,
225 struct netdev_saved_flags
**);
226 int netdev_turn_flags_off(struct netdev
*, enum netdev_flags
,
227 struct netdev_saved_flags
**);
229 void netdev_restore_flags(struct netdev_saved_flags
*);
231 /* TCP/IP stack interface. */
232 int netdev_get_in4(const struct netdev
*, struct in_addr
*address
,
233 struct in_addr
*netmask
);
234 int netdev_set_in4(struct netdev
*, struct in_addr addr
, struct in_addr mask
);
235 int netdev_get_in4_by_name(const char *device_name
, struct in_addr
*in4
);
236 int netdev_get_in6(const struct netdev
*, struct in6_addr
*);
237 int netdev_add_router(struct netdev
*, struct in_addr router
);
238 int netdev_get_next_hop(const struct netdev
*, const struct in_addr
*host
,
239 struct in_addr
*next_hop
, char **);
240 int netdev_get_status(const struct netdev
*, struct smap
*);
241 int netdev_arp_lookup(const struct netdev
*, ovs_be32 ip
, uint8_t mac
[6]);
243 struct netdev
*netdev_find_dev_by_in4(const struct in_addr
*);
246 int netdev_get_stats(const struct netdev
*, struct netdev_stats
*);
247 int netdev_set_stats(struct netdev
*, const struct netdev_stats
*);
249 /* Quality of service. */
250 struct netdev_qos_capabilities
{
251 unsigned int n_queues
;
254 struct netdev_queue_stats
{
255 /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
260 /* Time at which the queue was created, in msecs, LLONG_MIN if unknown. */
261 long long int created
;
264 int netdev_set_policing(struct netdev
*, uint32_t kbits_rate
,
265 uint32_t kbits_burst
);
267 int netdev_get_qos_types(const struct netdev
*, struct sset
*types
);
268 int netdev_get_qos_capabilities(const struct netdev
*,
270 struct netdev_qos_capabilities
*);
271 int netdev_get_n_queues(const struct netdev
*,
272 const char *type
, unsigned int *n_queuesp
);
274 int netdev_get_qos(const struct netdev
*,
275 const char **typep
, struct smap
*details
);
276 int netdev_set_qos(struct netdev
*,
277 const char *type
, const struct smap
*details
);
279 int netdev_get_queue(const struct netdev
*,
280 unsigned int queue_id
, struct smap
*details
);
281 int netdev_set_queue(struct netdev
*,
282 unsigned int queue_id
, const struct smap
*details
);
283 int netdev_delete_queue(struct netdev
*, unsigned int queue_id
);
284 int netdev_get_queue_stats(const struct netdev
*, unsigned int queue_id
,
285 struct netdev_queue_stats
*);
287 struct netdev_queue_dump
{
288 struct netdev
*netdev
;
292 void netdev_queue_dump_start(struct netdev_queue_dump
*,
293 const struct netdev
*);
294 bool netdev_queue_dump_next(struct netdev_queue_dump
*,
295 unsigned int *queue_id
, struct smap
*details
);
296 int netdev_queue_dump_done(struct netdev_queue_dump
*);
298 /* Iterates through each queue in NETDEV, using DUMP as state. Fills QUEUE_ID
299 * and DETAILS with information about queues. The client must initialize and
302 * Arguments all have pointer type.
304 * If you break out of the loop, then you need to free the dump structure by
305 * hand using netdev_queue_dump_done(). */
306 #define NETDEV_QUEUE_FOR_EACH(QUEUE_ID, DETAILS, DUMP, NETDEV) \
307 for (netdev_queue_dump_start(DUMP, NETDEV); \
308 (netdev_queue_dump_next(DUMP, QUEUE_ID, DETAILS) \
310 : (netdev_queue_dump_done(DUMP), false)); \
313 typedef void netdev_dump_queue_stats_cb(unsigned int queue_id
,
314 struct netdev_queue_stats
*,
316 int netdev_dump_queue_stats(const struct netdev
*,
317 netdev_dump_queue_stats_cb
*, void *aux
);
319 enum { NETDEV_MAX_RX_BATCH
= 256 }; /* Maximum number packets in rx_recv() batch. */
325 #endif /* netdev.h */