2 * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
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.
31 * Currently, there is a single implementation of this interface that supports
32 * Linux. The interface should be generic enough to be implementable on other
33 * operating systems as well. */
42 NETDEV_UP
= 0x0001, /* Device enabled? */
43 NETDEV_PROMISC
= 0x0002, /* Promiscuous mode? */
44 NETDEV_LOOPBACK
= 0x0004 /* This is a loopback device. */
47 enum netdev_pseudo_ethertype
{
48 NETDEV_ETH_TYPE_NONE
= -128, /* Receive no frames. */
49 NETDEV_ETH_TYPE_ANY
, /* Receive all frames. */
50 NETDEV_ETH_TYPE_802_2
/* Receive all IEEE 802.2 frames. */
53 /* Network device statistics.
55 * Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
57 uint64_t rx_packets
; /* Total packets received. */
58 uint64_t tx_packets
; /* Total packets transmitted. */
59 uint64_t rx_bytes
; /* Total bytes received. */
60 uint64_t tx_bytes
; /* Total bytes transmitted. */
61 uint64_t rx_errors
; /* Bad packets received. */
62 uint64_t tx_errors
; /* Packet transmit problems. */
63 uint64_t rx_dropped
; /* No buffer space. */
64 uint64_t tx_dropped
; /* No buffer space. */
65 uint64_t multicast
; /* Multicast packets received. */
68 /* Detailed receive errors. */
69 uint64_t rx_length_errors
;
70 uint64_t rx_over_errors
; /* Receiver ring buff overflow. */
71 uint64_t rx_crc_errors
; /* Recved pkt with crc error. */
72 uint64_t rx_frame_errors
; /* Recv'd frame alignment error. */
73 uint64_t rx_fifo_errors
; /* Recv'r fifo overrun . */
74 uint64_t rx_missed_errors
; /* Receiver missed packet. */
76 /* Detailed transmit errors. */
77 uint64_t tx_aborted_errors
;
78 uint64_t tx_carrier_errors
;
79 uint64_t tx_fifo_errors
;
80 uint64_t tx_heartbeat_errors
;
81 uint64_t tx_window_errors
;
84 struct netdev_options
{
87 const struct shash
*args
;
94 void netdev_run(void);
95 void netdev_wait(void);
97 void netdev_enumerate_types(struct sset
*types
);
100 int netdev_open(struct netdev_options
*, struct netdev
**);
101 int netdev_open_default(const char *name
, struct netdev
**);
102 void netdev_close(struct netdev
*);
104 bool netdev_exists(const char *name
);
105 bool netdev_is_open(const char *name
);
107 int netdev_enumerate(struct sset
*);
110 int netdev_set_config(struct netdev
*, const struct shash
*args
);
111 const struct shash
*netdev_get_config(const struct netdev
*);
113 /* Basic properties. */
114 const char *netdev_get_name(const struct netdev
*);
115 const char *netdev_get_type(const struct netdev
*);
116 int netdev_get_mtu(const struct netdev
*, int *mtup
);
117 int netdev_get_ifindex(const struct netdev
*);
119 /* Packet send and receive. */
120 int netdev_recv(struct netdev
*, struct ofpbuf
*);
121 void netdev_recv_wait(struct netdev
*);
122 int netdev_drain(struct netdev
*);
124 int netdev_send(struct netdev
*, const struct ofpbuf
*);
125 void netdev_send_wait(struct netdev
*);
127 /* Hardware address. */
128 int netdev_set_etheraddr(struct netdev
*, const uint8_t mac
[6]);
129 int netdev_get_etheraddr(const struct netdev
*, uint8_t mac
[6]);
132 bool netdev_get_carrier(const struct netdev
*);
133 bool netdev_get_miimon(const struct netdev
*);
134 int netdev_get_features(const struct netdev
*,
135 uint32_t *current
, uint32_t *advertised
,
136 uint32_t *supported
, uint32_t *peer
);
137 uint64_t netdev_features_to_bps(uint32_t features
);
138 bool netdev_features_is_full_duplex(uint32_t features
);
139 int netdev_set_advertisements(struct netdev
*, uint32_t advertise
);
141 /* TCP/IP stack interface. */
142 int netdev_get_in4(const struct netdev
*, struct in_addr
*address
,
143 struct in_addr
*netmask
);
144 int netdev_set_in4(struct netdev
*, struct in_addr addr
, struct in_addr mask
);
145 int netdev_get_in6(const struct netdev
*, struct in6_addr
*);
146 int netdev_add_router(struct netdev
*, struct in_addr router
);
147 int netdev_get_next_hop(const struct netdev
*, const struct in_addr
*host
,
148 struct in_addr
*next_hop
, char **);
149 int netdev_get_status(const struct netdev
*, struct shash
*sh
);
150 int netdev_arp_lookup(const struct netdev
*, ovs_be32 ip
, uint8_t mac
[6]);
152 int netdev_get_flags(const struct netdev
*, enum netdev_flags
*);
153 int netdev_set_flags(struct netdev
*, enum netdev_flags
, bool permanent
);
154 int netdev_turn_flags_on(struct netdev
*, enum netdev_flags
, bool permanent
);
155 int netdev_turn_flags_off(struct netdev
*, enum netdev_flags
, bool permanent
);
156 struct netdev
*netdev_find_dev_by_in4(const struct in_addr
*);
159 int netdev_get_stats(const struct netdev
*, struct netdev_stats
*);
160 int netdev_set_stats(struct netdev
*, const struct netdev_stats
*);
162 /* Quality of service. */
163 struct netdev_qos_capabilities
{
164 unsigned int n_queues
;
167 struct netdev_queue_stats
{
168 /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
174 int netdev_set_policing(struct netdev
*, uint32_t kbits_rate
,
175 uint32_t kbits_burst
);
177 int netdev_get_qos_types(const struct netdev
*, struct sset
*types
);
178 int netdev_get_qos_capabilities(const struct netdev
*,
180 struct netdev_qos_capabilities
*);
181 int netdev_get_n_queues(const struct netdev
*,
182 const char *type
, unsigned int *n_queuesp
);
184 int netdev_get_qos(const struct netdev
*,
185 const char **typep
, struct shash
*details
);
186 int netdev_set_qos(struct netdev
*,
187 const char *type
, const struct shash
*details
);
189 int netdev_get_queue(const struct netdev
*,
190 unsigned int queue_id
, struct shash
*details
);
191 int netdev_set_queue(struct netdev
*,
192 unsigned int queue_id
, const struct shash
*details
);
193 int netdev_delete_queue(struct netdev
*, unsigned int queue_id
);
194 int netdev_get_queue_stats(const struct netdev
*, unsigned int queue_id
,
195 struct netdev_queue_stats
*);
197 typedef void netdev_dump_queues_cb(unsigned int queue_id
,
198 const struct shash
*details
, void *aux
);
199 int netdev_dump_queues(const struct netdev
*,
200 netdev_dump_queues_cb
*, void *aux
);
202 typedef void netdev_dump_queue_stats_cb(unsigned int queue_id
,
203 struct netdev_queue_stats
*,
205 int netdev_dump_queue_stats(const struct netdev
*,
206 netdev_dump_queue_stats_cb
*, void *aux
);
209 int netdev_get_vlan_vid(const struct netdev
*, int *vlan_vid
);
211 /* Monitoring for changes in network device status. */
212 struct netdev_monitor
*netdev_monitor_create(void);
213 void netdev_monitor_destroy(struct netdev_monitor
*);
214 int netdev_monitor_add(struct netdev_monitor
*, struct netdev
*);
215 void netdev_monitor_remove(struct netdev_monitor
*, struct netdev
*);
216 int netdev_monitor_poll(struct netdev_monitor
*, char **devnamep
);
217 void netdev_monitor_flush(struct netdev_monitor
*);
218 void netdev_monitor_poll_wait(const struct netdev_monitor
*);
224 #endif /* netdev.h */