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 struct netdev_saved_flags
;
46 /* Network device statistics.
48 * Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
50 uint64_t rx_packets
; /* Total packets received. */
51 uint64_t tx_packets
; /* Total packets transmitted. */
52 uint64_t rx_bytes
; /* Total bytes received. */
53 uint64_t tx_bytes
; /* Total bytes transmitted. */
54 uint64_t rx_errors
; /* Bad packets received. */
55 uint64_t tx_errors
; /* Packet transmit problems. */
56 uint64_t rx_dropped
; /* No buffer space. */
57 uint64_t tx_dropped
; /* No buffer space. */
58 uint64_t multicast
; /* Multicast packets received. */
61 /* Detailed receive errors. */
62 uint64_t rx_length_errors
;
63 uint64_t rx_over_errors
; /* Receiver ring buff overflow. */
64 uint64_t rx_crc_errors
; /* Recved pkt with crc error. */
65 uint64_t rx_frame_errors
; /* Recv'd frame alignment error. */
66 uint64_t rx_fifo_errors
; /* Recv'r fifo overrun . */
67 uint64_t rx_missed_errors
; /* Receiver missed packet. */
69 /* Detailed transmit errors. */
70 uint64_t tx_aborted_errors
;
71 uint64_t tx_carrier_errors
;
72 uint64_t tx_fifo_errors
;
73 uint64_t tx_heartbeat_errors
;
74 uint64_t tx_window_errors
;
77 /* Configuration specific to tunnels. */
78 struct netdev_tunnel_config
{
105 void netdev_run(void);
106 void netdev_wait(void);
108 void netdev_enumerate_types(struct sset
*types
);
109 bool netdev_is_reserved_name(const char *name
);
111 /* Open and close. */
112 int netdev_open(const char *name
, const char *type
, struct netdev
**);
113 void netdev_close(struct netdev
*);
115 void netdev_parse_name(const char *netdev_name
, char **name
, char **type
);
118 int netdev_set_config(struct netdev
*, const struct smap
*args
);
119 int netdev_get_config(const struct netdev
*, struct smap
*);
120 const struct netdev_tunnel_config
*
121 netdev_get_tunnel_config(const struct netdev
*);
123 /* Basic properties. */
124 const char *netdev_get_name(const struct netdev
*);
125 const char *netdev_get_type(const struct netdev
*);
126 const char *netdev_get_type_from_name(const char *);
127 int netdev_get_mtu(const struct netdev
*, int *mtup
);
128 int netdev_set_mtu(const struct netdev
*, int mtu
);
129 int netdev_get_ifindex(const struct netdev
*);
131 /* Packet reception. */
132 int netdev_rx_open(struct netdev
*, struct netdev_rx
**);
133 void netdev_rx_close(struct netdev_rx
*);
135 const char *netdev_rx_get_name(const struct netdev_rx
*);
137 int netdev_rx_recv(struct netdev_rx
*, struct ofpbuf
*);
138 void netdev_rx_wait(struct netdev_rx
*);
139 int netdev_rx_drain(struct netdev_rx
*);
141 /* Packet transmission. */
142 int netdev_send(struct netdev
*, const struct ofpbuf
*);
143 void netdev_send_wait(struct netdev
*);
145 /* Hardware address. */
146 int netdev_set_etheraddr(struct netdev
*, const uint8_t mac
[6]);
147 int netdev_get_etheraddr(const struct netdev
*, uint8_t mac
[6]);
150 bool netdev_get_carrier(const struct netdev
*);
151 long long int netdev_get_carrier_resets(const struct netdev
*);
152 int netdev_set_miimon_interval(struct netdev
*, long long int interval
);
155 enum netdev_features
{
156 NETDEV_F_10MB_HD
= 1 << 0, /* 10 Mb half-duplex rate support. */
157 NETDEV_F_10MB_FD
= 1 << 1, /* 10 Mb full-duplex rate support. */
158 NETDEV_F_100MB_HD
= 1 << 2, /* 100 Mb half-duplex rate support. */
159 NETDEV_F_100MB_FD
= 1 << 3, /* 100 Mb full-duplex rate support. */
160 NETDEV_F_1GB_HD
= 1 << 4, /* 1 Gb half-duplex rate support. */
161 NETDEV_F_1GB_FD
= 1 << 5, /* 1 Gb full-duplex rate support. */
162 NETDEV_F_10GB_FD
= 1 << 6, /* 10 Gb full-duplex rate support. */
163 NETDEV_F_40GB_FD
= 1 << 7, /* 40 Gb full-duplex rate support. */
164 NETDEV_F_100GB_FD
= 1 << 8, /* 100 Gb full-duplex rate support. */
165 NETDEV_F_1TB_FD
= 1 << 9, /* 1 Tb full-duplex rate support. */
166 NETDEV_F_OTHER
= 1 << 10, /* Other rate, not in the list. */
167 NETDEV_F_COPPER
= 1 << 11, /* Copper medium. */
168 NETDEV_F_FIBER
= 1 << 12, /* Fiber medium. */
169 NETDEV_F_AUTONEG
= 1 << 13, /* Auto-negotiation. */
170 NETDEV_F_PAUSE
= 1 << 14, /* Pause. */
171 NETDEV_F_PAUSE_ASYM
= 1 << 15, /* Asymmetric pause. */
174 int netdev_get_features(const struct netdev
*,
175 enum netdev_features
*current
,
176 enum netdev_features
*advertised
,
177 enum netdev_features
*supported
,
178 enum netdev_features
*peer
);
179 uint64_t netdev_features_to_bps(enum netdev_features features
,
180 uint64_t default_bps
);
181 bool netdev_features_is_full_duplex(enum netdev_features features
);
182 int netdev_set_advertisements(struct netdev
*, enum netdev_features advertise
);
186 NETDEV_UP
= 0x0001, /* Device enabled? */
187 NETDEV_PROMISC
= 0x0002, /* Promiscuous mode? */
188 NETDEV_LOOPBACK
= 0x0004 /* This is a loopback device. */
191 int netdev_get_flags(const struct netdev
*, enum netdev_flags
*);
192 int netdev_set_flags(struct netdev
*, enum netdev_flags
,
193 struct netdev_saved_flags
**);
194 int netdev_turn_flags_on(struct netdev
*, enum netdev_flags
,
195 struct netdev_saved_flags
**);
196 int netdev_turn_flags_off(struct netdev
*, enum netdev_flags
,
197 struct netdev_saved_flags
**);
199 void netdev_restore_flags(struct netdev_saved_flags
*);
201 /* TCP/IP stack interface. */
202 int netdev_get_in4(const struct netdev
*, struct in_addr
*address
,
203 struct in_addr
*netmask
);
204 int netdev_set_in4(struct netdev
*, struct in_addr addr
, struct in_addr mask
);
205 int netdev_get_in4_by_name(const char *device_name
, struct in_addr
*in4
);
206 int netdev_get_in6(const struct netdev
*, struct in6_addr
*);
207 int netdev_add_router(struct netdev
*, struct in_addr router
);
208 int netdev_get_next_hop(const struct netdev
*, const struct in_addr
*host
,
209 struct in_addr
*next_hop
, char **);
210 int netdev_get_status(const struct netdev
*, struct smap
*);
211 int netdev_arp_lookup(const struct netdev
*, ovs_be32 ip
, uint8_t mac
[6]);
213 struct netdev
*netdev_find_dev_by_in4(const struct in_addr
*);
216 int netdev_get_stats(const struct netdev
*, struct netdev_stats
*);
217 int netdev_set_stats(struct netdev
*, const struct netdev_stats
*);
219 /* Quality of service. */
220 struct netdev_qos_capabilities
{
221 unsigned int n_queues
;
224 struct netdev_queue_stats
{
225 /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
231 int netdev_set_policing(struct netdev
*, uint32_t kbits_rate
,
232 uint32_t kbits_burst
);
234 int netdev_get_qos_types(const struct netdev
*, struct sset
*types
);
235 int netdev_get_qos_capabilities(const struct netdev
*,
237 struct netdev_qos_capabilities
*);
238 int netdev_get_n_queues(const struct netdev
*,
239 const char *type
, unsigned int *n_queuesp
);
241 int netdev_get_qos(const struct netdev
*,
242 const char **typep
, struct smap
*details
);
243 int netdev_set_qos(struct netdev
*,
244 const char *type
, const struct smap
*details
);
246 int netdev_get_queue(const struct netdev
*,
247 unsigned int queue_id
, struct smap
*details
);
248 int netdev_set_queue(struct netdev
*,
249 unsigned int queue_id
, const struct smap
*details
);
250 int netdev_delete_queue(struct netdev
*, unsigned int queue_id
);
251 int netdev_get_queue_stats(const struct netdev
*, unsigned int queue_id
,
252 struct netdev_queue_stats
*);
254 typedef void netdev_dump_queues_cb(unsigned int queue_id
,
255 const struct smap
*details
, void *aux
);
256 int netdev_dump_queues(const struct netdev
*,
257 netdev_dump_queues_cb
*, void *aux
);
259 typedef void netdev_dump_queue_stats_cb(unsigned int queue_id
,
260 struct netdev_queue_stats
*,
262 int netdev_dump_queue_stats(const struct netdev
*,
263 netdev_dump_queue_stats_cb
*, void *aux
);
265 unsigned int netdev_change_seq(const struct netdev
*netdev
);
271 #endif /* netdev.h */