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