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 section of the documentation 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_QUEUE_FOR_EACH
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
;
75 /* The netdev is packet type aware. It can potentially carry any kind of
76 * packet. This "modern" mode is appropriate for both netdevs that handle
77 * only a single kind of packet (such as a virtual or physical Ethernet
78 * interface) and for those that can handle multiple (such as VXLAN-GPE or
82 /* The netdev sends and receives only Ethernet frames. The netdev cannot
83 * carry packets other than Ethernet frames. This is a legacy mode for
84 * backward compability with controllers that are not prepared to handle
85 * OpenFlow 1.5+ "packet_type". */
88 /* The netdev sends and receives only IPv4 and IPv6 packets. The netdev
89 * cannot carry Ethernet frames or other kinds of packets.
91 * IPv4 and IPv6 packets carried over the netdev are treated as Ethernet:
92 * when they are received, they are converted to Ethernet by adding a dummy
93 * header with the proper Ethertype; on tranmission, the Ethernet header is
94 * stripped. This is a legacy mode for backward compability with
95 * controllers that are not prepared to handle OpenFlow 1.5+
100 /* Configuration specific to tunnels. */
101 struct netdev_tunnel_config
{
106 bool out_key_present
;
110 ovs_be16 payload_ethertype
;
115 struct in6_addr ipv6_src
;
116 struct in6_addr ipv6_dst
;
119 uint32_t egress_pkt_mark
;
120 bool set_egress_pkt_mark
;
130 enum netdev_pt_mode pt_mode
;
139 bool erspan_ver_flow
;
140 bool erspan_idx_flow
;
141 bool erspan_dir_flow
;
142 bool erspan_hwid_flow
;
145 void netdev_run(void);
146 void netdev_wait(void);
148 void netdev_enumerate_types(struct sset
*types
);
149 bool netdev_is_reserved_name(const char *name
);
151 int netdev_n_txq(const struct netdev
*netdev
);
152 int netdev_n_rxq(const struct netdev
*netdev
);
153 bool netdev_is_pmd(const struct netdev
*netdev
);
154 bool netdev_has_tunnel_push_pop(const struct netdev
*netdev
);
156 /* Open and close. */
157 int netdev_open(const char *name
, const char *type
, struct netdev
**netdevp
);
159 struct netdev
*netdev_ref(const struct netdev
*);
160 void netdev_remove(struct netdev
*);
161 void netdev_close(struct netdev
*);
163 void netdev_parse_name(const char *netdev_name
, char **name
, char **type
);
166 int netdev_set_config(struct netdev
*, const struct smap
*args
, char **errp
);
167 int netdev_get_config(const struct netdev
*, struct smap
*);
168 const struct netdev_tunnel_config
*
169 netdev_get_tunnel_config(const struct netdev
*);
170 int netdev_get_numa_id(const struct netdev
*);
172 /* Basic properties. */
173 const char *netdev_get_name(const struct netdev
*);
174 const char *netdev_get_type(const struct netdev
*);
175 const char *netdev_get_type_from_name(const char *);
176 int netdev_get_mtu(const struct netdev
*, int *mtup
);
177 int netdev_set_mtu(struct netdev
*, int mtu
);
178 void netdev_mtu_user_config(struct netdev
*, bool);
179 bool netdev_mtu_is_user_config(struct netdev
*);
180 int netdev_get_ifindex(const struct netdev
*);
181 int netdev_set_tx_multiq(struct netdev
*, unsigned int n_txq
);
182 enum netdev_pt_mode
netdev_get_pt_mode(const struct netdev
*);
183 void netdev_set_dpif_type(struct netdev
*, const char *);
184 const char *netdev_get_dpif_type(const struct netdev
*);
186 /* Packet reception. */
187 int netdev_rxq_open(struct netdev
*, struct netdev_rxq
**, int id
);
188 void netdev_rxq_close(struct netdev_rxq
*);
189 bool netdev_rxq_enabled(struct netdev_rxq
*);
191 const char *netdev_rxq_get_name(const struct netdev_rxq
*);
192 int netdev_rxq_get_queue_id(const struct netdev_rxq
*);
194 int netdev_rxq_recv(struct netdev_rxq
*rx
, struct dp_packet_batch
*,
196 void netdev_rxq_wait(struct netdev_rxq
*);
197 int netdev_rxq_drain(struct netdev_rxq
*);
199 /* Packet transmission. */
200 int netdev_send(struct netdev
*, int qid
, struct dp_packet_batch
*,
201 bool concurrent_txq
);
202 void netdev_send_wait(struct netdev
*, int qid
);
204 /* native tunnel APIs */
205 /* Structure to pass parameters required to build a tunnel header. */
206 struct netdev_tnl_build_header_params
{
207 const struct flow
*flow
;
208 const struct in6_addr
*s_ip
;
209 struct eth_addr dmac
;
210 struct eth_addr smac
;
215 netdev_init_tnl_build_header_params(struct netdev_tnl_build_header_params
*params
,
216 const struct flow
*tnl_flow
,
217 const struct in6_addr
*src
,
218 struct eth_addr dmac
,
219 struct eth_addr smac
);
221 int netdev_build_header(const struct netdev
*, struct ovs_action_push_tnl
*data
,
222 const struct netdev_tnl_build_header_params
*params
);
224 int netdev_push_header(const struct netdev
*netdev
,
225 struct dp_packet_batch
*,
226 const struct ovs_action_push_tnl
*data
);
227 void netdev_pop_header(struct netdev
*netdev
, struct dp_packet_batch
*);
229 /* Hardware address. */
230 int netdev_set_etheraddr(struct netdev
*, const struct eth_addr mac
);
231 int netdev_get_etheraddr(const struct netdev
*, struct eth_addr
*mac
);
234 bool netdev_get_carrier(const struct netdev
*);
235 long long int netdev_get_carrier_resets(const struct netdev
*);
236 int netdev_set_miimon_interval(struct netdev
*, long long int interval
);
240 NETDEV_UP
= 0x0001, /* Device enabled? */
241 NETDEV_PROMISC
= 0x0002, /* Promiscuous mode? */
242 NETDEV_LOOPBACK
= 0x0004 /* This is a loopback device. */
245 int netdev_get_flags(const struct netdev
*, enum netdev_flags
*);
246 int netdev_set_flags(struct netdev
*, enum netdev_flags
,
247 struct netdev_saved_flags
**);
248 int netdev_turn_flags_on(struct netdev
*, enum netdev_flags
,
249 struct netdev_saved_flags
**);
250 int netdev_turn_flags_off(struct netdev
*, enum netdev_flags
,
251 struct netdev_saved_flags
**);
253 void netdev_restore_flags(struct netdev_saved_flags
*);
255 /* TCP/IP stack interface. */
256 int netdev_set_in4(struct netdev
*, struct in_addr addr
, struct in_addr mask
);
257 int netdev_get_in4_by_name(const char *device_name
, struct in_addr
*in4
);
258 int netdev_get_ip_by_name(const char *device_name
, struct in6_addr
*);
259 int netdev_get_addr_list(const struct netdev
*netdev
, struct in6_addr
**addr
,
260 struct in6_addr
**mask
, int *n_in6
);
262 int netdev_add_router(struct netdev
*, struct in_addr router
);
263 int netdev_get_next_hop(const struct netdev
*, const struct in_addr
*host
,
264 struct in_addr
*next_hop
, char **);
265 int netdev_get_status(const struct netdev
*, struct smap
*);
266 int netdev_arp_lookup(const struct netdev
*, ovs_be32 ip
,
267 struct eth_addr
*mac
);
269 struct netdev
*netdev_find_dev_by_in4(const struct in_addr
*);
272 int netdev_get_stats(const struct netdev
*, struct netdev_stats
*);
273 int netdev_get_custom_stats(const struct netdev
*,
274 struct netdev_custom_stats
*);
276 /* Quality of service. */
277 struct netdev_qos_capabilities
{
278 unsigned int n_queues
;
281 struct netdev_queue_stats
{
282 /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
287 /* Time at which the queue was created, in msecs, LLONG_MIN if unknown. */
288 long long int created
;
291 int netdev_set_policing(struct netdev
*, uint32_t kbits_rate
,
292 uint32_t kbits_burst
);
294 int netdev_get_qos_types(const struct netdev
*, struct sset
*types
);
295 int netdev_get_qos_capabilities(const struct netdev
*,
297 struct netdev_qos_capabilities
*);
298 int netdev_get_n_queues(const struct netdev
*,
299 const char *type
, unsigned int *n_queuesp
);
301 int netdev_get_qos(const struct netdev
*,
302 const char **typep
, struct smap
*details
);
303 int netdev_set_qos(struct netdev
*,
304 const char *type
, const struct smap
*details
);
306 int netdev_get_queue(const struct netdev
*,
307 unsigned int queue_id
, struct smap
*details
);
308 int netdev_set_queue(struct netdev
*,
309 unsigned int queue_id
, const struct smap
*details
);
310 int netdev_delete_queue(struct netdev
*, unsigned int queue_id
);
311 int netdev_get_queue_stats(const struct netdev
*, unsigned int queue_id
,
312 struct netdev_queue_stats
*);
313 uint64_t netdev_get_change_seq(const struct netdev
*);
315 int netdev_reconfigure(struct netdev
*netdev
);
316 void netdev_wait_reconf_required(struct netdev
*netdev
);
317 bool netdev_is_reconf_required(struct netdev
*netdev
);
319 struct netdev_queue_dump
{
320 struct netdev
*netdev
;
324 void netdev_queue_dump_start(struct netdev_queue_dump
*,
325 const struct netdev
*);
326 bool netdev_queue_dump_next(struct netdev_queue_dump
*,
327 unsigned int *queue_id
, struct smap
*details
);
328 int netdev_queue_dump_done(struct netdev_queue_dump
*);
330 /* Iterates through each queue in NETDEV, using DUMP as state. Fills QUEUE_ID
331 * and DETAILS with information about queues. The client must initialize and
334 * Arguments all have pointer type.
336 * If you break out of the loop, then you need to free the dump structure by
337 * hand using netdev_queue_dump_done(). */
338 #define NETDEV_QUEUE_FOR_EACH(QUEUE_ID, DETAILS, DUMP, NETDEV) \
339 for (netdev_queue_dump_start(DUMP, NETDEV); \
340 (netdev_queue_dump_next(DUMP, QUEUE_ID, DETAILS) \
342 : (netdev_queue_dump_done(DUMP), false)); \
345 typedef void netdev_dump_queue_stats_cb(unsigned int queue_id
,
346 struct netdev_queue_stats
*,
348 int netdev_dump_queue_stats(const struct netdev
*,
349 netdev_dump_queue_stats_cb
*, void *aux
);
351 extern struct seq
*tnl_conf_seq
;
354 void netdev_get_addrs_list_flush(void);
355 int netdev_get_addrs(const char dev
[], struct in6_addr
**paddr
,
356 struct in6_addr
**pmask
, int *n_in6
);
363 #endif /* netdev.h */