poll-loop: Make poll_fd_wait_event() cross-platform.
[sliver-openvswitch.git] / lib / netdev.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
3  *
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:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 #ifndef NETDEV_H
18 #define NETDEV_H 1
19
20 #include <stdbool.h>
21 #include <stddef.h>
22 #include <stdint.h>
23 #include "openvswitch/types.h"
24
25 #ifdef  __cplusplus
26 extern "C" {
27 #endif
28
29 /* Generic interface to network devices ("netdev"s).
30  *
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.
35  *
36  * Thread-safety
37  * =============
38  *
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
41  * exceptions are:
42  *
43  *    netdev_rx_recv()
44  *    netdev_rx_wait()
45  *    netdev_rx_drain()
46  *
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.)
51  *
52  *    NETDEV_FOR_EACH_QUEUE
53  *    netdev_queue_dump_next()
54  *    netdev_queue_dump_done()
55  *
56  *      These functions are conditionally thread-safe: they may be called from
57  *      different threads only on different netdev_queue_dump objects.  (The
58  *      client may create multiple netdev_queue_dump objects for a single
59  *      netdev and access each of those from a different thread.)
60  */
61
62 struct netdev;
63 struct netdev_class;
64 struct netdev_rx;
65 struct netdev_saved_flags;
66 struct ofpbuf;
67 struct in_addr;
68 struct in6_addr;
69 struct smap;
70 struct sset;
71
72 /* Network device statistics.
73  *
74  * Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
75 struct netdev_stats {
76     uint64_t rx_packets;        /* Total packets received. */
77     uint64_t tx_packets;        /* Total packets transmitted. */
78     uint64_t rx_bytes;          /* Total bytes received. */
79     uint64_t tx_bytes;          /* Total bytes transmitted. */
80     uint64_t rx_errors;         /* Bad packets received. */
81     uint64_t tx_errors;         /* Packet transmit problems. */
82     uint64_t rx_dropped;        /* No buffer space. */
83     uint64_t tx_dropped;        /* No buffer space. */
84     uint64_t multicast;         /* Multicast packets received. */
85     uint64_t collisions;
86
87     /* Detailed receive errors. */
88     uint64_t rx_length_errors;
89     uint64_t rx_over_errors;    /* Receiver ring buff overflow. */
90     uint64_t rx_crc_errors;     /* Recved pkt with crc error. */
91     uint64_t rx_frame_errors;   /* Recv'd frame alignment error. */
92     uint64_t rx_fifo_errors;    /* Recv'r fifo overrun . */
93     uint64_t rx_missed_errors;  /* Receiver missed packet. */
94
95     /* Detailed transmit errors. */
96     uint64_t tx_aborted_errors;
97     uint64_t tx_carrier_errors;
98     uint64_t tx_fifo_errors;
99     uint64_t tx_heartbeat_errors;
100     uint64_t tx_window_errors;
101 };
102
103 /* Configuration specific to tunnels. */
104 struct netdev_tunnel_config {
105     bool in_key_present;
106     bool in_key_flow;
107     ovs_be64 in_key;
108
109     bool out_key_present;
110     bool out_key_flow;
111     ovs_be64 out_key;
112
113     ovs_be16 dst_port;
114
115     bool ip_src_flow;
116     bool ip_dst_flow;
117     ovs_be32 ip_src;
118     ovs_be32 ip_dst;
119
120     uint8_t ttl;
121     bool ttl_inherit;
122
123     uint8_t tos;
124     bool tos_inherit;
125
126     bool csum;
127     bool ipsec;
128     bool dont_fragment;
129 };
130
131 void netdev_run(void);
132 void netdev_wait(void);
133
134 void netdev_enumerate_types(struct sset *types);
135 bool netdev_is_reserved_name(const char *name);
136
137 /* Open and close. */
138 int netdev_open(const char *name, const char *type, struct netdev **);
139 struct netdev *netdev_ref(const struct netdev *);
140 void netdev_close(struct netdev *);
141
142 void netdev_parse_name(const char *netdev_name, char **name, char **type);
143
144 /* Options. */
145 int netdev_set_config(struct netdev *, const struct smap *args);
146 int netdev_get_config(const struct netdev *, struct smap *);
147 const struct netdev_tunnel_config *
148     netdev_get_tunnel_config(const struct netdev *);
149
150 /* Basic properties. */
151 const char *netdev_get_name(const struct netdev *);
152 const char *netdev_get_type(const struct netdev *);
153 const char *netdev_get_type_from_name(const char *);
154 int netdev_get_mtu(const struct netdev *, int *mtup);
155 int netdev_set_mtu(const struct netdev *, int mtu);
156 int netdev_get_ifindex(const struct netdev *);
157
158 /* Packet reception. */
159 int netdev_rx_open(struct netdev *, struct netdev_rx **);
160 void netdev_rx_close(struct netdev_rx *);
161
162 const char *netdev_rx_get_name(const struct netdev_rx *);
163
164 int netdev_rx_recv(struct netdev_rx *, struct ofpbuf *);
165 void netdev_rx_wait(struct netdev_rx *);
166 int netdev_rx_drain(struct netdev_rx *);
167
168 /* Packet transmission. */
169 int netdev_send(struct netdev *, const struct ofpbuf *);
170 void netdev_send_wait(struct netdev *);
171
172 /* Hardware address. */
173 int netdev_set_etheraddr(struct netdev *, const uint8_t mac[6]);
174 int netdev_get_etheraddr(const struct netdev *, uint8_t mac[6]);
175
176 /* PHY interface. */
177 bool netdev_get_carrier(const struct netdev *);
178 long long int netdev_get_carrier_resets(const struct netdev *);
179 int netdev_set_miimon_interval(struct netdev *, long long int interval);
180
181 /* Features. */
182 enum netdev_features {
183     NETDEV_F_10MB_HD =    1 << 0,  /* 10 Mb half-duplex rate support. */
184     NETDEV_F_10MB_FD =    1 << 1,  /* 10 Mb full-duplex rate support. */
185     NETDEV_F_100MB_HD =   1 << 2,  /* 100 Mb half-duplex rate support. */
186     NETDEV_F_100MB_FD =   1 << 3,  /* 100 Mb full-duplex rate support. */
187     NETDEV_F_1GB_HD =     1 << 4,  /* 1 Gb half-duplex rate support. */
188     NETDEV_F_1GB_FD =     1 << 5,  /* 1 Gb full-duplex rate support. */
189     NETDEV_F_10GB_FD =    1 << 6,  /* 10 Gb full-duplex rate support. */
190     NETDEV_F_40GB_FD =    1 << 7,  /* 40 Gb full-duplex rate support. */
191     NETDEV_F_100GB_FD =   1 << 8,  /* 100 Gb full-duplex rate support. */
192     NETDEV_F_1TB_FD =     1 << 9,  /* 1 Tb full-duplex rate support. */
193     NETDEV_F_OTHER =      1 << 10, /* Other rate, not in the list. */
194     NETDEV_F_COPPER =     1 << 11, /* Copper medium. */
195     NETDEV_F_FIBER =      1 << 12, /* Fiber medium. */
196     NETDEV_F_AUTONEG =    1 << 13, /* Auto-negotiation. */
197     NETDEV_F_PAUSE =      1 << 14, /* Pause. */
198     NETDEV_F_PAUSE_ASYM = 1 << 15, /* Asymmetric pause. */
199 };
200
201 int netdev_get_features(const struct netdev *,
202                         enum netdev_features *current,
203                         enum netdev_features *advertised,
204                         enum netdev_features *supported,
205                         enum netdev_features *peer);
206 uint64_t netdev_features_to_bps(enum netdev_features features,
207                                 uint64_t default_bps);
208 bool netdev_features_is_full_duplex(enum netdev_features features);
209 int netdev_set_advertisements(struct netdev *, enum netdev_features advertise);
210
211 /* Flags. */
212 enum netdev_flags {
213     NETDEV_UP = 0x0001,         /* Device enabled? */
214     NETDEV_PROMISC = 0x0002,    /* Promiscuous mode? */
215     NETDEV_LOOPBACK = 0x0004    /* This is a loopback device. */
216 };
217
218 int netdev_get_flags(const struct netdev *, enum netdev_flags *);
219 int netdev_set_flags(struct netdev *, enum netdev_flags,
220                      struct netdev_saved_flags **);
221 int netdev_turn_flags_on(struct netdev *, enum netdev_flags,
222                          struct netdev_saved_flags **);
223 int netdev_turn_flags_off(struct netdev *, enum netdev_flags,
224                           struct netdev_saved_flags **);
225
226 void netdev_restore_flags(struct netdev_saved_flags *);
227
228 /* TCP/IP stack interface. */
229 int netdev_get_in4(const struct netdev *, struct in_addr *address,
230                    struct in_addr *netmask);
231 int netdev_set_in4(struct netdev *, struct in_addr addr, struct in_addr mask);
232 int netdev_get_in4_by_name(const char *device_name, struct in_addr *in4);
233 int netdev_get_in6(const struct netdev *, struct in6_addr *);
234 int netdev_add_router(struct netdev *, struct in_addr router);
235 int netdev_get_next_hop(const struct netdev *, const struct in_addr *host,
236                         struct in_addr *next_hop, char **);
237 int netdev_get_status(const struct netdev *, struct smap *);
238 int netdev_arp_lookup(const struct netdev *, ovs_be32 ip, uint8_t mac[6]);
239
240 struct netdev *netdev_find_dev_by_in4(const struct in_addr *);
241
242 /* Statistics. */
243 int netdev_get_stats(const struct netdev *, struct netdev_stats *);
244 int netdev_set_stats(struct netdev *, const struct netdev_stats *);
245
246 /* Quality of service. */
247 struct netdev_qos_capabilities {
248     unsigned int n_queues;
249 };
250
251 struct netdev_queue_stats {
252     /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
253     uint64_t tx_bytes;
254     uint64_t tx_packets;
255     uint64_t tx_errors;
256
257     /* Time at which the queue was created, in msecs, LLONG_MIN if unknown. */
258     long long int created;
259 };
260
261 int netdev_set_policing(struct netdev *, uint32_t kbits_rate,
262                         uint32_t kbits_burst);
263
264 int netdev_get_qos_types(const struct netdev *, struct sset *types);
265 int netdev_get_qos_capabilities(const struct netdev *,
266                                 const char *type,
267                                 struct netdev_qos_capabilities *);
268 int netdev_get_n_queues(const struct netdev *,
269                         const char *type, unsigned int *n_queuesp);
270
271 int netdev_get_qos(const struct netdev *,
272                    const char **typep, struct smap *details);
273 int netdev_set_qos(struct netdev *,
274                    const char *type, const struct smap *details);
275
276 int netdev_get_queue(const struct netdev *,
277                      unsigned int queue_id, struct smap *details);
278 int netdev_set_queue(struct netdev *,
279                      unsigned int queue_id, const struct smap *details);
280 int netdev_delete_queue(struct netdev *, unsigned int queue_id);
281 int netdev_get_queue_stats(const struct netdev *, unsigned int queue_id,
282                            struct netdev_queue_stats *);
283
284 struct netdev_queue_dump {
285     struct netdev *netdev;
286     int error;
287     void *state;
288 };
289 void netdev_queue_dump_start(struct netdev_queue_dump *,
290                              const struct netdev *);
291 bool netdev_queue_dump_next(struct netdev_queue_dump *,
292                             unsigned int *queue_id, struct smap *details);
293 int netdev_queue_dump_done(struct netdev_queue_dump *);
294
295 /* Iterates through each queue in NETDEV, using DUMP as state.  Fills QUEUE_ID
296  * and DETAILS with information about queues.  The client must initialize and
297  * destroy DETAILS.
298  *
299  * Arguments all have pointer type.
300  *
301  * If you break out of the loop, then you need to free the dump structure by
302  * hand using netdev_queue_dump_done(). */
303 #define NETDEV_QUEUE_FOR_EACH(QUEUE_ID, DETAILS, DUMP, NETDEV)  \
304     for (netdev_queue_dump_start(DUMP, NETDEV);                 \
305          (netdev_queue_dump_next(DUMP, QUEUE_ID, DETAILS)       \
306           ? true                                                \
307           : (netdev_queue_dump_done(DUMP), false));             \
308         )
309
310 typedef void netdev_dump_queue_stats_cb(unsigned int queue_id,
311                                         struct netdev_queue_stats *,
312                                         void *aux);
313 int netdev_dump_queue_stats(const struct netdev *,
314                             netdev_dump_queue_stats_cb *, void *aux);
315
316 #ifdef  __cplusplus
317 }
318 #endif
319
320 #endif /* netdev.h */