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"
31 /* Generic interface to network devices ("netdev"s).
33 * Every port on a switch must have a corresponding netdev that must minimally
34 * support a few operations, such as the ability to read the netdev's MTU.
35 * The PORTING file at the top of the source tree has more information in the
36 * "Writing a netdev Provider" section.
41 * Most of the netdev functions are fully thread-safe: they may be called from
42 * any number of threads on the same or different netdev objects. The
49 * These functions are conditionally thread-safe: they may be called from
50 * different threads only on different netdev_rxq objects. (The client may
51 * create multiple netdev_rxq objects for a single netdev and access each
52 * of those from a different thread.)
54 * NETDEV_FOR_EACH_QUEUE
55 * netdev_queue_dump_next()
56 * netdev_queue_dump_done()
58 * These functions are conditionally thread-safe: they may be called from
59 * different threads only on different netdev_queue_dump objects. (The
60 * client may create multiple netdev_queue_dump objects for a single
61 * netdev and access each of those from a different thread.)
68 struct netdev_saved_flags
;
74 struct ovs_action_push_tnl
;
76 /* Network device statistics.
78 * Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
80 uint64_t rx_packets
; /* Total packets received. */
81 uint64_t tx_packets
; /* Total packets transmitted. */
82 uint64_t rx_bytes
; /* Total bytes received. */
83 uint64_t tx_bytes
; /* Total bytes transmitted. */
84 uint64_t rx_errors
; /* Bad packets received. */
85 uint64_t tx_errors
; /* Packet transmit problems. */
86 uint64_t rx_dropped
; /* No buffer space. */
87 uint64_t tx_dropped
; /* No buffer space. */
88 uint64_t multicast
; /* Multicast packets received. */
91 /* Detailed receive errors. */
92 uint64_t rx_length_errors
;
93 uint64_t rx_over_errors
; /* Receiver ring buff overflow. */
94 uint64_t rx_crc_errors
; /* Recved pkt with crc error. */
95 uint64_t rx_frame_errors
; /* Recv'd frame alignment error. */
96 uint64_t rx_fifo_errors
; /* Recv'r fifo overrun . */
97 uint64_t rx_missed_errors
; /* Receiver missed packet. */
99 /* Detailed transmit errors. */
100 uint64_t tx_aborted_errors
;
101 uint64_t tx_carrier_errors
;
102 uint64_t tx_fifo_errors
;
103 uint64_t tx_heartbeat_errors
;
104 uint64_t tx_window_errors
;
107 /* Configuration specific to tunnels. */
108 struct netdev_tunnel_config
{
113 bool out_key_present
;
137 void netdev_run(void);
138 void netdev_wait(void);
140 void netdev_enumerate_types(struct sset
*types
);
141 bool netdev_is_reserved_name(const char *name
);
143 int netdev_n_txq(const struct netdev
*netdev
);
144 int netdev_n_rxq(const struct netdev
*netdev
);
145 bool netdev_is_pmd(const struct netdev
*netdev
);
147 /* Open and close. */
148 int netdev_open(const char *name
, const char *type
, struct netdev
**netdevp
);
150 struct netdev
*netdev_ref(const struct netdev
*);
151 void netdev_remove(struct netdev
*);
152 void netdev_close(struct netdev
*);
154 void netdev_parse_name(const char *netdev_name
, char **name
, char **type
);
157 int netdev_set_config(struct netdev
*, const struct smap
*args
, char **errp
);
158 int netdev_get_config(const struct netdev
*, struct smap
*);
159 const struct netdev_tunnel_config
*
160 netdev_get_tunnel_config(const struct netdev
*);
161 int netdev_get_numa_id(const struct netdev
*);
163 /* Basic properties. */
164 const char *netdev_get_name(const struct netdev
*);
165 const char *netdev_get_type(const struct netdev
*);
166 const char *netdev_get_type_from_name(const char *);
167 int netdev_get_mtu(const struct netdev
*, int *mtup
);
168 int netdev_set_mtu(const struct netdev
*, int mtu
);
169 int netdev_get_ifindex(const struct netdev
*);
170 int netdev_set_multiq(struct netdev
*, unsigned int n_txq
, unsigned int n_rxq
);
172 /* Packet reception. */
173 int netdev_rxq_open(struct netdev
*, struct netdev_rxq
**, int id
);
174 void netdev_rxq_close(struct netdev_rxq
*);
176 const char *netdev_rxq_get_name(const struct netdev_rxq
*);
178 int netdev_rxq_recv(struct netdev_rxq
*rx
, struct dp_packet
**buffers
,
180 void netdev_rxq_wait(struct netdev_rxq
*);
181 int netdev_rxq_drain(struct netdev_rxq
*);
183 /* Packet transmission. */
184 int netdev_send(struct netdev
*, int qid
, struct dp_packet
**, int cnt
,
186 void netdev_send_wait(struct netdev
*, int qid
);
188 int netdev_build_header(const struct netdev
*, struct ovs_action_push_tnl
*data
,
189 const struct flow
*tnl_flow
);
190 int netdev_push_header(const struct netdev
*netdev
,
191 struct dp_packet
**buffers
, int cnt
,
192 const struct ovs_action_push_tnl
*data
);
193 int netdev_pop_header(struct netdev
*netdev
, struct dp_packet
**buffers
,
196 /* Hardware address. */
197 int netdev_set_etheraddr(struct netdev
*, const struct eth_addr mac
);
198 int netdev_get_etheraddr(const struct netdev
*, struct eth_addr
*mac
);
201 bool netdev_get_carrier(const struct netdev
*);
202 long long int netdev_get_carrier_resets(const struct netdev
*);
203 int netdev_set_miimon_interval(struct netdev
*, long long int interval
);
206 enum netdev_features
{
207 NETDEV_F_10MB_HD
= 1 << 0, /* 10 Mb half-duplex rate support. */
208 NETDEV_F_10MB_FD
= 1 << 1, /* 10 Mb full-duplex rate support. */
209 NETDEV_F_100MB_HD
= 1 << 2, /* 100 Mb half-duplex rate support. */
210 NETDEV_F_100MB_FD
= 1 << 3, /* 100 Mb full-duplex rate support. */
211 NETDEV_F_1GB_HD
= 1 << 4, /* 1 Gb half-duplex rate support. */
212 NETDEV_F_1GB_FD
= 1 << 5, /* 1 Gb full-duplex rate support. */
213 NETDEV_F_10GB_FD
= 1 << 6, /* 10 Gb full-duplex rate support. */
214 NETDEV_F_40GB_FD
= 1 << 7, /* 40 Gb full-duplex rate support. */
215 NETDEV_F_100GB_FD
= 1 << 8, /* 100 Gb full-duplex rate support. */
216 NETDEV_F_1TB_FD
= 1 << 9, /* 1 Tb full-duplex rate support. */
217 NETDEV_F_OTHER
= 1 << 10, /* Other rate, not in the list. */
218 NETDEV_F_COPPER
= 1 << 11, /* Copper medium. */
219 NETDEV_F_FIBER
= 1 << 12, /* Fiber medium. */
220 NETDEV_F_AUTONEG
= 1 << 13, /* Auto-negotiation. */
221 NETDEV_F_PAUSE
= 1 << 14, /* Pause. */
222 NETDEV_F_PAUSE_ASYM
= 1 << 15, /* Asymmetric pause. */
225 int netdev_get_features(const struct netdev
*,
226 enum netdev_features
*current
,
227 enum netdev_features
*advertised
,
228 enum netdev_features
*supported
,
229 enum netdev_features
*peer
);
230 uint64_t netdev_features_to_bps(enum netdev_features features
,
231 uint64_t default_bps
);
232 bool netdev_features_is_full_duplex(enum netdev_features features
);
233 int netdev_set_advertisements(struct netdev
*, enum netdev_features advertise
);
237 NETDEV_UP
= 0x0001, /* Device enabled? */
238 NETDEV_PROMISC
= 0x0002, /* Promiscuous mode? */
239 NETDEV_LOOPBACK
= 0x0004 /* This is a loopback device. */
242 int netdev_get_flags(const struct netdev
*, enum netdev_flags
*);
243 int netdev_set_flags(struct netdev
*, enum netdev_flags
,
244 struct netdev_saved_flags
**);
245 int netdev_turn_flags_on(struct netdev
*, enum netdev_flags
,
246 struct netdev_saved_flags
**);
247 int netdev_turn_flags_off(struct netdev
*, enum netdev_flags
,
248 struct netdev_saved_flags
**);
250 void netdev_restore_flags(struct netdev_saved_flags
*);
252 /* TCP/IP stack interface. */
253 int netdev_get_in4(const struct netdev
*, struct in_addr
*address
,
254 struct in_addr
*netmask
);
255 int netdev_set_in4(struct netdev
*, struct in_addr addr
, struct in_addr mask
);
256 int netdev_get_in4_by_name(const char *device_name
, struct in_addr
*in4
);
257 int netdev_get_in6(const struct netdev
*, struct in6_addr
*);
258 int netdev_add_router(struct netdev
*, struct in_addr router
);
259 int netdev_get_next_hop(const struct netdev
*, const struct in_addr
*host
,
260 struct in_addr
*next_hop
, char **);
261 int netdev_get_status(const struct netdev
*, struct smap
*);
262 int netdev_arp_lookup(const struct netdev
*, ovs_be32 ip
,
263 struct eth_addr
*mac
);
265 struct netdev
*netdev_find_dev_by_in4(const struct in_addr
*);
268 int netdev_get_stats(const struct netdev
*, struct netdev_stats
*);
270 /* Quality of service. */
271 struct netdev_qos_capabilities
{
272 unsigned int n_queues
;
275 struct netdev_queue_stats
{
276 /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
281 /* Time at which the queue was created, in msecs, LLONG_MIN if unknown. */
282 long long int created
;
285 int netdev_set_policing(struct netdev
*, uint32_t kbits_rate
,
286 uint32_t kbits_burst
);
288 int netdev_get_qos_types(const struct netdev
*, struct sset
*types
);
289 int netdev_get_qos_capabilities(const struct netdev
*,
291 struct netdev_qos_capabilities
*);
292 int netdev_get_n_queues(const struct netdev
*,
293 const char *type
, unsigned int *n_queuesp
);
295 int netdev_get_qos(const struct netdev
*,
296 const char **typep
, struct smap
*details
);
297 int netdev_set_qos(struct netdev
*,
298 const char *type
, const struct smap
*details
);
300 int netdev_get_queue(const struct netdev
*,
301 unsigned int queue_id
, struct smap
*details
);
302 int netdev_set_queue(struct netdev
*,
303 unsigned int queue_id
, const struct smap
*details
);
304 int netdev_delete_queue(struct netdev
*, unsigned int queue_id
);
305 int netdev_get_queue_stats(const struct netdev
*, unsigned int queue_id
,
306 struct netdev_queue_stats
*);
307 uint64_t netdev_get_change_seq(const struct netdev
*);
309 struct netdev_queue_dump
{
310 struct netdev
*netdev
;
314 void netdev_queue_dump_start(struct netdev_queue_dump
*,
315 const struct netdev
*);
316 bool netdev_queue_dump_next(struct netdev_queue_dump
*,
317 unsigned int *queue_id
, struct smap
*details
);
318 int netdev_queue_dump_done(struct netdev_queue_dump
*);
320 /* Iterates through each queue in NETDEV, using DUMP as state. Fills QUEUE_ID
321 * and DETAILS with information about queues. The client must initialize and
324 * Arguments all have pointer type.
326 * If you break out of the loop, then you need to free the dump structure by
327 * hand using netdev_queue_dump_done(). */
328 #define NETDEV_QUEUE_FOR_EACH(QUEUE_ID, DETAILS, DUMP, NETDEV) \
329 for (netdev_queue_dump_start(DUMP, NETDEV); \
330 (netdev_queue_dump_next(DUMP, QUEUE_ID, DETAILS) \
332 : (netdev_queue_dump_done(DUMP), false)); \
335 typedef void netdev_dump_queue_stats_cb(unsigned int queue_id
,
336 struct netdev_queue_stats
*,
338 int netdev_dump_queue_stats(const struct netdev
*,
339 netdev_dump_queue_stats_cb
*, void *aux
);
341 enum { NETDEV_MAX_BURST
= 32 }; /* Maximum number packets in a batch. */
342 extern struct seq
*tnl_conf_seq
;
348 #endif /* netdev.h */