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;
121 struct in6_addr ipv6_src;
122 struct in6_addr ipv6_dst;
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 int netdev_requested_n_rxq(const struct netdev *netdev);
146 bool netdev_is_pmd(const struct netdev *netdev);
148 /* Open and close. */
149 int netdev_open(const char *name, const char *type, struct netdev **netdevp);
151 struct netdev *netdev_ref(const struct netdev *);
152 void netdev_remove(struct netdev *);
153 void netdev_close(struct netdev *);
155 void netdev_parse_name(const char *netdev_name, char **name, char **type);
158 int netdev_set_config(struct netdev *, const struct smap *args, char **errp);
159 int netdev_get_config(const struct netdev *, struct smap *);
160 const struct netdev_tunnel_config *
161 netdev_get_tunnel_config(const struct netdev *);
162 int netdev_get_numa_id(const struct netdev *);
164 /* Basic properties. */
165 const char *netdev_get_name(const struct netdev *);
166 const char *netdev_get_type(const struct netdev *);
167 const char *netdev_get_type_from_name(const char *);
168 int netdev_get_mtu(const struct netdev *, int *mtup);
169 int netdev_set_mtu(const struct netdev *, int mtu);
170 int netdev_get_ifindex(const struct netdev *);
171 int netdev_set_multiq(struct netdev *, unsigned int n_txq, unsigned int n_rxq);
173 /* Packet reception. */
174 int netdev_rxq_open(struct netdev *, struct netdev_rxq **, int id);
175 void netdev_rxq_close(struct netdev_rxq *);
177 const char *netdev_rxq_get_name(const struct netdev_rxq *);
178 int netdev_rxq_get_queue_id(const struct netdev_rxq *);
180 int netdev_rxq_recv(struct netdev_rxq *rx, struct dp_packet **buffers,
182 void netdev_rxq_wait(struct netdev_rxq *);
183 int netdev_rxq_drain(struct netdev_rxq *);
185 /* Packet transmission. */
186 int netdev_send(struct netdev *, int qid, struct dp_packet **, int cnt,
188 void netdev_send_wait(struct netdev *, int qid);
190 int netdev_build_header(const struct netdev *, struct ovs_action_push_tnl *data,
191 const struct flow *tnl_flow);
192 int netdev_push_header(const struct netdev *netdev,
193 struct dp_packet **buffers, int cnt,
194 const struct ovs_action_push_tnl *data);
195 int netdev_pop_header(struct netdev *netdev, struct dp_packet **buffers,
198 /* Hardware address. */
199 int netdev_set_etheraddr(struct netdev *, const struct eth_addr mac);
200 int netdev_get_etheraddr(const struct netdev *, struct eth_addr *mac);
203 bool netdev_get_carrier(const struct netdev *);
204 long long int netdev_get_carrier_resets(const struct netdev *);
205 int netdev_set_miimon_interval(struct netdev *, long long int interval);
208 enum netdev_features {
209 NETDEV_F_10MB_HD = 1 << 0, /* 10 Mb half-duplex rate support. */
210 NETDEV_F_10MB_FD = 1 << 1, /* 10 Mb full-duplex rate support. */
211 NETDEV_F_100MB_HD = 1 << 2, /* 100 Mb half-duplex rate support. */
212 NETDEV_F_100MB_FD = 1 << 3, /* 100 Mb full-duplex rate support. */
213 NETDEV_F_1GB_HD = 1 << 4, /* 1 Gb half-duplex rate support. */
214 NETDEV_F_1GB_FD = 1 << 5, /* 1 Gb full-duplex rate support. */
215 NETDEV_F_10GB_FD = 1 << 6, /* 10 Gb full-duplex rate support. */
216 NETDEV_F_40GB_FD = 1 << 7, /* 40 Gb full-duplex rate support. */
217 NETDEV_F_100GB_FD = 1 << 8, /* 100 Gb full-duplex rate support. */
218 NETDEV_F_1TB_FD = 1 << 9, /* 1 Tb full-duplex rate support. */
219 NETDEV_F_OTHER = 1 << 10, /* Other rate, not in the list. */
220 NETDEV_F_COPPER = 1 << 11, /* Copper medium. */
221 NETDEV_F_FIBER = 1 << 12, /* Fiber medium. */
222 NETDEV_F_AUTONEG = 1 << 13, /* Auto-negotiation. */
223 NETDEV_F_PAUSE = 1 << 14, /* Pause. */
224 NETDEV_F_PAUSE_ASYM = 1 << 15, /* Asymmetric pause. */
227 int netdev_get_features(const struct netdev *,
228 enum netdev_features *current,
229 enum netdev_features *advertised,
230 enum netdev_features *supported,
231 enum netdev_features *peer);
232 uint64_t netdev_features_to_bps(enum netdev_features features,
233 uint64_t default_bps);
234 bool netdev_features_is_full_duplex(enum netdev_features features);
235 int netdev_set_advertisements(struct netdev *, enum netdev_features advertise);
239 NETDEV_UP = 0x0001, /* Device enabled? */
240 NETDEV_PROMISC = 0x0002, /* Promiscuous mode? */
241 NETDEV_LOOPBACK = 0x0004 /* This is a loopback device. */
244 int netdev_get_flags(const struct netdev *, enum netdev_flags *);
245 int netdev_set_flags(struct netdev *, enum netdev_flags,
246 struct netdev_saved_flags **);
247 int netdev_turn_flags_on(struct netdev *, enum netdev_flags,
248 struct netdev_saved_flags **);
249 int netdev_turn_flags_off(struct netdev *, enum netdev_flags,
250 struct netdev_saved_flags **);
252 void netdev_restore_flags(struct netdev_saved_flags *);
254 /* TCP/IP stack interface. */
255 int netdev_get_in4(const struct netdev *, struct in_addr *address,
256 struct in_addr *netmask);
257 int netdev_set_in4(struct netdev *, struct in_addr addr, struct in_addr mask);
258 int netdev_get_in4_by_name(const char *device_name, struct in_addr *in4);
259 int netdev_get_in6(const struct netdev *, struct in6_addr *);
260 int netdev_add_router(struct netdev *, struct in_addr router);
261 int netdev_get_next_hop(const struct netdev *, const struct in_addr *host,
262 struct in_addr *next_hop, char **);
263 int netdev_get_status(const struct netdev *, struct smap *);
264 int netdev_arp_lookup(const struct netdev *, ovs_be32 ip,
265 struct eth_addr *mac);
267 struct netdev *netdev_find_dev_by_in4(const struct in_addr *);
270 int netdev_get_stats(const struct netdev *, struct netdev_stats *);
272 /* Quality of service. */
273 struct netdev_qos_capabilities {
274 unsigned int n_queues;
277 struct netdev_queue_stats {
278 /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
283 /* Time at which the queue was created, in msecs, LLONG_MIN if unknown. */
284 long long int created;
287 int netdev_set_policing(struct netdev *, uint32_t kbits_rate,
288 uint32_t kbits_burst);
290 int netdev_get_qos_types(const struct netdev *, struct sset *types);
291 int netdev_get_qos_capabilities(const struct netdev *,
293 struct netdev_qos_capabilities *);
294 int netdev_get_n_queues(const struct netdev *,
295 const char *type, unsigned int *n_queuesp);
297 int netdev_get_qos(const struct netdev *,
298 const char **typep, struct smap *details);
299 int netdev_set_qos(struct netdev *,
300 const char *type, const struct smap *details);
302 int netdev_get_queue(const struct netdev *,
303 unsigned int queue_id, struct smap *details);
304 int netdev_set_queue(struct netdev *,
305 unsigned int queue_id, const struct smap *details);
306 int netdev_delete_queue(struct netdev *, unsigned int queue_id);
307 int netdev_get_queue_stats(const struct netdev *, unsigned int queue_id,
308 struct netdev_queue_stats *);
309 uint64_t netdev_get_change_seq(const struct netdev *);
311 struct netdev_queue_dump {
312 struct netdev *netdev;
316 void netdev_queue_dump_start(struct netdev_queue_dump *,
317 const struct netdev *);
318 bool netdev_queue_dump_next(struct netdev_queue_dump *,
319 unsigned int *queue_id, struct smap *details);
320 int netdev_queue_dump_done(struct netdev_queue_dump *);
322 /* Iterates through each queue in NETDEV, using DUMP as state. Fills QUEUE_ID
323 * and DETAILS with information about queues. The client must initialize and
326 * Arguments all have pointer type.
328 * If you break out of the loop, then you need to free the dump structure by
329 * hand using netdev_queue_dump_done(). */
330 #define NETDEV_QUEUE_FOR_EACH(QUEUE_ID, DETAILS, DUMP, NETDEV) \
331 for (netdev_queue_dump_start(DUMP, NETDEV); \
332 (netdev_queue_dump_next(DUMP, QUEUE_ID, DETAILS) \
334 : (netdev_queue_dump_done(DUMP), false)); \
337 typedef void netdev_dump_queue_stats_cb(unsigned int queue_id,
338 struct netdev_queue_stats *,
340 int netdev_dump_queue_stats(const struct netdev *,
341 netdev_dump_queue_stats_cb *, void *aux);
343 enum { NETDEV_MAX_BURST = 32 }; /* Maximum number packets in a batch. */
344 extern struct seq *tnl_conf_seq;
350 #endif /* netdev.h */