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