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.
20 #include "openvswitch/netdev.h"
21 #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_rxq objects. (The client may
49 * create multiple netdev_rxq objects for a single netdev and access each
50 * of those from a different thread.)
52 * NETDEV_FOR_EACH_QUEUE
53 * netdev_queue_dump_next()
54 * netdev_queue_dump_done()
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.)
62 struct dp_packet_batch;
66 struct netdev_saved_flags;
72 struct ovs_action_push_tnl;
74 /* Configuration specific to tunnels. */
75 struct netdev_tunnel_config {
88 struct in6_addr ipv6_src;
89 struct in6_addr ipv6_dst;
104 void netdev_run(void);
105 void netdev_wait(void);
107 void netdev_enumerate_types(struct sset *types);
108 bool netdev_is_reserved_name(const char *name);
110 int netdev_n_txq(const struct netdev *netdev);
111 int netdev_n_rxq(const struct netdev *netdev);
112 int netdev_requested_n_rxq(const struct netdev *netdev);
113 bool netdev_is_pmd(const struct netdev *netdev);
115 /* Open and close. */
116 int netdev_open(const char *name, const char *type, struct netdev **netdevp);
118 struct netdev *netdev_ref(const struct netdev *);
119 void netdev_remove(struct netdev *);
120 void netdev_close(struct netdev *);
122 void netdev_parse_name(const char *netdev_name, char **name, char **type);
125 int netdev_set_config(struct netdev *, const struct smap *args, char **errp);
126 int netdev_get_config(const struct netdev *, struct smap *);
127 const struct netdev_tunnel_config *
128 netdev_get_tunnel_config(const struct netdev *);
129 int netdev_get_numa_id(const struct netdev *);
131 /* Basic properties. */
132 const char *netdev_get_name(const struct netdev *);
133 const char *netdev_get_type(const struct netdev *);
134 const char *netdev_get_type_from_name(const char *);
135 int netdev_get_mtu(const struct netdev *, int *mtup);
136 int netdev_set_mtu(const struct netdev *, int mtu);
137 int netdev_get_ifindex(const struct netdev *);
138 int netdev_set_multiq(struct netdev *, unsigned int n_txq, unsigned int n_rxq);
140 /* Packet reception. */
141 int netdev_rxq_open(struct netdev *, struct netdev_rxq **, int id);
142 void netdev_rxq_close(struct netdev_rxq *);
144 const char *netdev_rxq_get_name(const struct netdev_rxq *);
145 int netdev_rxq_get_queue_id(const struct netdev_rxq *);
147 int netdev_rxq_recv(struct netdev_rxq *rx, struct dp_packet_batch *);
148 void netdev_rxq_wait(struct netdev_rxq *);
149 int netdev_rxq_drain(struct netdev_rxq *);
151 /* Packet transmission. */
152 int netdev_send(struct netdev *, int qid, struct dp_packet_batch *,
154 void netdev_send_wait(struct netdev *, int qid);
156 int netdev_build_header(const struct netdev *, struct ovs_action_push_tnl *data,
157 const struct flow *tnl_flow);
158 int netdev_push_header(const struct netdev *netdev,
159 struct dp_packet_batch *,
160 const struct ovs_action_push_tnl *data);
161 void netdev_pop_header(struct netdev *netdev, struct dp_packet_batch *);
163 /* Hardware address. */
164 int netdev_set_etheraddr(struct netdev *, const struct eth_addr mac);
165 int netdev_get_etheraddr(const struct netdev *, struct eth_addr *mac);
168 bool netdev_get_carrier(const struct netdev *);
169 long long int netdev_get_carrier_resets(const struct netdev *);
170 int netdev_set_miimon_interval(struct netdev *, long long int interval);
174 NETDEV_UP = 0x0001, /* Device enabled? */
175 NETDEV_PROMISC = 0x0002, /* Promiscuous mode? */
176 NETDEV_LOOPBACK = 0x0004 /* This is a loopback device. */
179 int netdev_get_flags(const struct netdev *, enum netdev_flags *);
180 int netdev_set_flags(struct netdev *, enum netdev_flags,
181 struct netdev_saved_flags **);
182 int netdev_turn_flags_on(struct netdev *, enum netdev_flags,
183 struct netdev_saved_flags **);
184 int netdev_turn_flags_off(struct netdev *, enum netdev_flags,
185 struct netdev_saved_flags **);
187 void netdev_restore_flags(struct netdev_saved_flags *);
189 /* TCP/IP stack interface. */
190 int netdev_set_in4(struct netdev *, struct in_addr addr, struct in_addr mask);
191 int netdev_get_in4_by_name(const char *device_name, struct in_addr *in4);
192 int netdev_get_addr_list(const struct netdev *netdev, struct in6_addr **addr,
193 struct in6_addr **mask, int *n_in6);
195 int netdev_add_router(struct netdev *, struct in_addr router);
196 int netdev_get_next_hop(const struct netdev *, const struct in_addr *host,
197 struct in_addr *next_hop, char **);
198 int netdev_get_status(const struct netdev *, struct smap *);
199 int netdev_arp_lookup(const struct netdev *, ovs_be32 ip,
200 struct eth_addr *mac);
202 struct netdev *netdev_find_dev_by_in4(const struct in_addr *);
205 int netdev_get_stats(const struct netdev *, struct netdev_stats *);
207 /* Quality of service. */
208 struct netdev_qos_capabilities {
209 unsigned int n_queues;
212 struct netdev_queue_stats {
213 /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
218 /* Time at which the queue was created, in msecs, LLONG_MIN if unknown. */
219 long long int created;
222 int netdev_set_policing(struct netdev *, uint32_t kbits_rate,
223 uint32_t kbits_burst);
225 int netdev_get_qos_types(const struct netdev *, struct sset *types);
226 int netdev_get_qos_capabilities(const struct netdev *,
228 struct netdev_qos_capabilities *);
229 int netdev_get_n_queues(const struct netdev *,
230 const char *type, unsigned int *n_queuesp);
232 int netdev_get_qos(const struct netdev *,
233 const char **typep, struct smap *details);
234 int netdev_set_qos(struct netdev *,
235 const char *type, const struct smap *details);
237 int netdev_get_queue(const struct netdev *,
238 unsigned int queue_id, struct smap *details);
239 int netdev_set_queue(struct netdev *,
240 unsigned int queue_id, const struct smap *details);
241 int netdev_delete_queue(struct netdev *, unsigned int queue_id);
242 int netdev_get_queue_stats(const struct netdev *, unsigned int queue_id,
243 struct netdev_queue_stats *);
244 uint64_t netdev_get_change_seq(const struct netdev *);
246 struct netdev_queue_dump {
247 struct netdev *netdev;
251 void netdev_queue_dump_start(struct netdev_queue_dump *,
252 const struct netdev *);
253 bool netdev_queue_dump_next(struct netdev_queue_dump *,
254 unsigned int *queue_id, struct smap *details);
255 int netdev_queue_dump_done(struct netdev_queue_dump *);
257 /* Iterates through each queue in NETDEV, using DUMP as state. Fills QUEUE_ID
258 * and DETAILS with information about queues. The client must initialize and
261 * Arguments all have pointer type.
263 * If you break out of the loop, then you need to free the dump structure by
264 * hand using netdev_queue_dump_done(). */
265 #define NETDEV_QUEUE_FOR_EACH(QUEUE_ID, DETAILS, DUMP, NETDEV) \
266 for (netdev_queue_dump_start(DUMP, NETDEV); \
267 (netdev_queue_dump_next(DUMP, QUEUE_ID, DETAILS) \
269 : (netdev_queue_dump_done(DUMP), false)); \
272 typedef void netdev_dump_queue_stats_cb(unsigned int queue_id,
273 struct netdev_queue_stats *,
275 int netdev_dump_queue_stats(const struct netdev *,
276 netdev_dump_queue_stats_cb *, void *aux);
278 extern struct seq *tnl_conf_seq;
281 void netdev_get_addrs_list_flush(void);
282 int netdev_get_addrs(const char dev[], struct in6_addr **paddr,
283 struct in6_addr **pmask, int *n_in6);
290 #endif /* netdev.h */