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_rx objects. (The client may
49 * create multiple netdev_rx objects for a single netdev and access each
50 * of those from a different thread.) */
55 struct netdev_saved_flags;
62 /* Network device statistics.
64 * Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
66 uint64_t rx_packets; /* Total packets received. */
67 uint64_t tx_packets; /* Total packets transmitted. */
68 uint64_t rx_bytes; /* Total bytes received. */
69 uint64_t tx_bytes; /* Total bytes transmitted. */
70 uint64_t rx_errors; /* Bad packets received. */
71 uint64_t tx_errors; /* Packet transmit problems. */
72 uint64_t rx_dropped; /* No buffer space. */
73 uint64_t tx_dropped; /* No buffer space. */
74 uint64_t multicast; /* Multicast packets received. */
77 /* Detailed receive errors. */
78 uint64_t rx_length_errors;
79 uint64_t rx_over_errors; /* Receiver ring buff overflow. */
80 uint64_t rx_crc_errors; /* Recved pkt with crc error. */
81 uint64_t rx_frame_errors; /* Recv'd frame alignment error. */
82 uint64_t rx_fifo_errors; /* Recv'r fifo overrun . */
83 uint64_t rx_missed_errors; /* Receiver missed packet. */
85 /* Detailed transmit errors. */
86 uint64_t tx_aborted_errors;
87 uint64_t tx_carrier_errors;
88 uint64_t tx_fifo_errors;
89 uint64_t tx_heartbeat_errors;
90 uint64_t tx_window_errors;
93 /* Configuration specific to tunnels. */
94 struct netdev_tunnel_config {
121 void netdev_run(void);
122 void netdev_wait(void);
124 void netdev_enumerate_types(struct sset *types);
125 bool netdev_is_reserved_name(const char *name);
127 /* Open and close. */
128 int netdev_open(const char *name, const char *type, struct netdev **);
129 struct netdev *netdev_ref(const struct netdev *);
130 void netdev_close(struct netdev *);
132 void netdev_parse_name(const char *netdev_name, char **name, char **type);
135 int netdev_set_config(struct netdev *, const struct smap *args);
136 int netdev_get_config(const struct netdev *, struct smap *);
137 const struct netdev_tunnel_config *
138 netdev_get_tunnel_config(const struct netdev *);
140 /* Basic properties. */
141 const char *netdev_get_name(const struct netdev *);
142 const char *netdev_get_type(const struct netdev *);
143 const char *netdev_get_type_from_name(const char *);
144 int netdev_get_mtu(const struct netdev *, int *mtup);
145 int netdev_set_mtu(const struct netdev *, int mtu);
146 int netdev_get_ifindex(const struct netdev *);
148 /* Packet reception. */
149 int netdev_rx_open(struct netdev *, struct netdev_rx **);
150 void netdev_rx_close(struct netdev_rx *);
152 const char *netdev_rx_get_name(const struct netdev_rx *);
154 int netdev_rx_recv(struct netdev_rx *, struct ofpbuf *);
155 void netdev_rx_wait(struct netdev_rx *);
156 int netdev_rx_drain(struct netdev_rx *);
158 /* Packet transmission. */
159 int netdev_send(struct netdev *, const struct ofpbuf *);
160 void netdev_send_wait(struct netdev *);
162 /* Hardware address. */
163 int netdev_set_etheraddr(struct netdev *, const uint8_t mac[6]);
164 int netdev_get_etheraddr(const struct netdev *, uint8_t mac[6]);
167 bool netdev_get_carrier(const struct netdev *);
168 long long int netdev_get_carrier_resets(const struct netdev *);
169 int netdev_set_miimon_interval(struct netdev *, long long int interval);
172 enum netdev_features {
173 NETDEV_F_10MB_HD = 1 << 0, /* 10 Mb half-duplex rate support. */
174 NETDEV_F_10MB_FD = 1 << 1, /* 10 Mb full-duplex rate support. */
175 NETDEV_F_100MB_HD = 1 << 2, /* 100 Mb half-duplex rate support. */
176 NETDEV_F_100MB_FD = 1 << 3, /* 100 Mb full-duplex rate support. */
177 NETDEV_F_1GB_HD = 1 << 4, /* 1 Gb half-duplex rate support. */
178 NETDEV_F_1GB_FD = 1 << 5, /* 1 Gb full-duplex rate support. */
179 NETDEV_F_10GB_FD = 1 << 6, /* 10 Gb full-duplex rate support. */
180 NETDEV_F_40GB_FD = 1 << 7, /* 40 Gb full-duplex rate support. */
181 NETDEV_F_100GB_FD = 1 << 8, /* 100 Gb full-duplex rate support. */
182 NETDEV_F_1TB_FD = 1 << 9, /* 1 Tb full-duplex rate support. */
183 NETDEV_F_OTHER = 1 << 10, /* Other rate, not in the list. */
184 NETDEV_F_COPPER = 1 << 11, /* Copper medium. */
185 NETDEV_F_FIBER = 1 << 12, /* Fiber medium. */
186 NETDEV_F_AUTONEG = 1 << 13, /* Auto-negotiation. */
187 NETDEV_F_PAUSE = 1 << 14, /* Pause. */
188 NETDEV_F_PAUSE_ASYM = 1 << 15, /* Asymmetric pause. */
191 int netdev_get_features(const struct netdev *,
192 enum netdev_features *current,
193 enum netdev_features *advertised,
194 enum netdev_features *supported,
195 enum netdev_features *peer);
196 uint64_t netdev_features_to_bps(enum netdev_features features,
197 uint64_t default_bps);
198 bool netdev_features_is_full_duplex(enum netdev_features features);
199 int netdev_set_advertisements(struct netdev *, enum netdev_features advertise);
203 NETDEV_UP = 0x0001, /* Device enabled? */
204 NETDEV_PROMISC = 0x0002, /* Promiscuous mode? */
205 NETDEV_LOOPBACK = 0x0004 /* This is a loopback device. */
208 int netdev_get_flags(const struct netdev *, enum netdev_flags *);
209 int netdev_set_flags(struct netdev *, enum netdev_flags,
210 struct netdev_saved_flags **);
211 int netdev_turn_flags_on(struct netdev *, enum netdev_flags,
212 struct netdev_saved_flags **);
213 int netdev_turn_flags_off(struct netdev *, enum netdev_flags,
214 struct netdev_saved_flags **);
216 void netdev_restore_flags(struct netdev_saved_flags *);
218 /* TCP/IP stack interface. */
219 int netdev_get_in4(const struct netdev *, struct in_addr *address,
220 struct in_addr *netmask);
221 int netdev_set_in4(struct netdev *, struct in_addr addr, struct in_addr mask);
222 int netdev_get_in4_by_name(const char *device_name, struct in_addr *in4);
223 int netdev_get_in6(const struct netdev *, struct in6_addr *);
224 int netdev_add_router(struct netdev *, struct in_addr router);
225 int netdev_get_next_hop(const struct netdev *, const struct in_addr *host,
226 struct in_addr *next_hop, char **);
227 int netdev_get_status(const struct netdev *, struct smap *);
228 int netdev_arp_lookup(const struct netdev *, ovs_be32 ip, uint8_t mac[6]);
230 struct netdev *netdev_find_dev_by_in4(const struct in_addr *);
233 int netdev_get_stats(const struct netdev *, struct netdev_stats *);
234 int netdev_set_stats(struct netdev *, const struct netdev_stats *);
236 /* Quality of service. */
237 struct netdev_qos_capabilities {
238 unsigned int n_queues;
241 struct netdev_queue_stats {
242 /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
247 /* Time at which the queue was created, in msecs, LLONG_MIN if unknown. */
248 long long int created;
251 int netdev_set_policing(struct netdev *, uint32_t kbits_rate,
252 uint32_t kbits_burst);
254 int netdev_get_qos_types(const struct netdev *, struct sset *types);
255 int netdev_get_qos_capabilities(const struct netdev *,
257 struct netdev_qos_capabilities *);
258 int netdev_get_n_queues(const struct netdev *,
259 const char *type, unsigned int *n_queuesp);
261 int netdev_get_qos(const struct netdev *,
262 const char **typep, struct smap *details);
263 int netdev_set_qos(struct netdev *,
264 const char *type, const struct smap *details);
266 int netdev_get_queue(const struct netdev *,
267 unsigned int queue_id, struct smap *details);
268 int netdev_set_queue(struct netdev *,
269 unsigned int queue_id, const struct smap *details);
270 int netdev_delete_queue(struct netdev *, unsigned int queue_id);
271 int netdev_get_queue_stats(const struct netdev *, unsigned int queue_id,
272 struct netdev_queue_stats *);
274 typedef void netdev_dump_queues_cb(unsigned int queue_id,
275 const struct smap *details, void *aux);
276 int netdev_dump_queues(const struct netdev *,
277 netdev_dump_queues_cb *, void *aux);
279 typedef void netdev_dump_queue_stats_cb(unsigned int queue_id,
280 struct netdev_queue_stats *,
282 int netdev_dump_queue_stats(const struct netdev *,
283 netdev_dump_queue_stats_cb *, void *aux);
285 unsigned int netdev_change_seq(const struct netdev *netdev);
291 #endif /* netdev.h */