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.
32 /* Generic interface to network devices.
34 * Currently, there is a single implementation of this interface that supports
35 * Linux. The interface should be generic enough to be implementable on other
36 * operating systems as well. */
45 NETDEV_UP = 0x0001, /* Device enabled? */
46 NETDEV_PROMISC = 0x0002, /* Promiscuous mode? */
47 NETDEV_LOOPBACK = 0x0004 /* This is a loopback device. */
50 enum netdev_pseudo_ethertype {
51 NETDEV_ETH_TYPE_NONE = -128, /* Receive no frames. */
52 NETDEV_ETH_TYPE_ANY, /* Receive all frames. */
53 NETDEV_ETH_TYPE_802_2 /* Receive all IEEE 802.2 frames. */
56 /* Network device statistics.
58 * Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
60 uint64_t rx_packets; /* Total packets received. */
61 uint64_t tx_packets; /* Total packets transmitted. */
62 uint64_t rx_bytes; /* Total bytes received. */
63 uint64_t tx_bytes; /* Total bytes transmitted. */
64 uint64_t rx_errors; /* Bad packets received. */
65 uint64_t tx_errors; /* Packet transmit problems. */
66 uint64_t rx_dropped; /* No buffer space. */
67 uint64_t tx_dropped; /* No buffer space. */
68 uint64_t multicast; /* Multicast packets received. */
71 /* Detailed receive errors. */
72 uint64_t rx_length_errors;
73 uint64_t rx_over_errors; /* Receiver ring buff overflow. */
74 uint64_t rx_crc_errors; /* Recved pkt with crc error. */
75 uint64_t rx_frame_errors; /* Recv'd frame alignment error. */
76 uint64_t rx_fifo_errors; /* Recv'r fifo overrun . */
77 uint64_t rx_missed_errors; /* Receiver missed packet. */
79 /* Detailed transmit errors. */
80 uint64_t tx_aborted_errors;
81 uint64_t tx_carrier_errors;
82 uint64_t tx_fifo_errors;
83 uint64_t tx_heartbeat_errors;
84 uint64_t tx_window_errors;
87 struct netdev_options {
90 const struct shash *args;
97 void netdev_run(void);
98 void netdev_wait(void);
100 int netdev_register_provider(const struct netdev_class *);
101 int netdev_unregister_provider(const char *type);
102 void netdev_enumerate_types(struct svec *types);
104 /* Open and close. */
105 int netdev_open(struct netdev_options *, struct netdev **);
106 int netdev_open_default(const char *name, struct netdev **);
107 int netdev_reconfigure(struct netdev *, const struct shash *args);
108 void netdev_close(struct netdev *);
110 bool netdev_exists(const char *name);
111 bool netdev_is_open(const char *name);
113 int netdev_enumerate(struct svec *);
115 /* Basic properties. */
116 const char *netdev_get_name(const struct netdev *);
117 const char *netdev_get_type(const struct netdev *);
118 int netdev_get_mtu(const struct netdev *, int *mtup);
119 int netdev_get_ifindex(const struct netdev *);
121 /* Packet send and receive. */
122 int netdev_recv(struct netdev *, struct ofpbuf *);
123 void netdev_recv_wait(struct netdev *);
125 int netdev_dispatch(struct netdev *, int, pkt_handler, u_char *);
126 int netdev_get_fd(struct netdev *);
128 int netdev_drain(struct netdev *);
130 int netdev_send(struct netdev *, const struct ofpbuf *);
131 void netdev_send_wait(struct netdev *);
133 /* Hardware address. */
134 int netdev_set_etheraddr(struct netdev *, const uint8_t mac[6]);
135 int netdev_get_etheraddr(const struct netdev *, uint8_t mac[6]);
138 int netdev_get_carrier(const struct netdev *, bool *carrier);
139 int netdev_get_features(struct netdev *,
140 uint32_t *current, uint32_t *advertised,
141 uint32_t *supported, uint32_t *peer);
142 uint64_t netdev_features_to_bps(uint32_t features);
143 bool netdev_features_is_full_duplex(uint32_t features);
144 int netdev_set_advertisements(struct netdev *, uint32_t advertise);
146 /* TCP/IP stack interface. */
147 int netdev_get_in4(const struct netdev *, struct in_addr *address,
148 struct in_addr *netmask);
149 int netdev_set_in4(struct netdev *, struct in_addr addr, struct in_addr mask);
150 int netdev_get_in6(const struct netdev *, struct in6_addr *);
151 int netdev_add_router(struct netdev *, struct in_addr router);
152 int netdev_get_next_hop(const struct netdev *, const struct in_addr *host,
153 struct in_addr *next_hop, char **);
154 int netdev_arp_lookup(const struct netdev *, uint32_t ip, uint8_t mac[6]);
156 int netdev_get_flags(const struct netdev *, enum netdev_flags *);
157 int netdev_set_flags(struct netdev *, enum netdev_flags, bool permanent);
158 int netdev_turn_flags_on(struct netdev *, enum netdev_flags, bool permanent);
159 int netdev_turn_flags_off(struct netdev *, enum netdev_flags, bool permanent);
160 struct netdev *netdev_find_dev_by_in4(const struct in_addr *);
163 int netdev_get_stats(const struct netdev *, struct netdev_stats *);
164 int netdev_set_stats(struct netdev *, const struct netdev_stats *);
166 /* Quality of service. */
167 struct netdev_qos_capabilities {
168 unsigned int n_queues;
171 struct netdev_queue_stats {
172 /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
178 int netdev_set_policing(struct netdev *, uint32_t kbits_rate,
179 uint32_t kbits_burst);
181 int netdev_get_qos_types(const struct netdev *, struct svec *types);
182 int netdev_get_qos_capabilities(const struct netdev *,
184 struct netdev_qos_capabilities *);
185 int netdev_get_n_queues(const struct netdev *,
186 const char *type, unsigned int *n_queuesp);
188 int netdev_get_qos(const struct netdev *,
189 const char **typep, struct shash *details);
190 int netdev_set_qos(struct netdev *,
191 const char *type, const struct shash *details);
193 int netdev_get_queue(const struct netdev *,
194 unsigned int queue_id, struct shash *details);
195 int netdev_set_queue(struct netdev *,
196 unsigned int queue_id, const struct shash *details);
197 int netdev_delete_queue(struct netdev *, unsigned int queue_id);
198 int netdev_get_queue_stats(const struct netdev *, unsigned int queue_id,
199 struct netdev_queue_stats *);
201 typedef void netdev_dump_queues_cb(unsigned int queue_id,
202 const struct shash *details, void *aux);
203 int netdev_dump_queues(const struct netdev *,
204 netdev_dump_queues_cb *, void *aux);
206 typedef void netdev_dump_queue_stats_cb(unsigned int queue_id,
207 struct netdev_queue_stats *,
209 int netdev_dump_queue_stats(const struct netdev *,
210 netdev_dump_queue_stats_cb *, void *aux);
213 int netdev_get_vlan_vid(const struct netdev *, int *vlan_vid);
215 /* Monitoring for changes in network device status. */
216 struct netdev_monitor *netdev_monitor_create(void);
217 void netdev_monitor_destroy(struct netdev_monitor *);
218 int netdev_monitor_add(struct netdev_monitor *, struct netdev *);
219 void netdev_monitor_remove(struct netdev_monitor *, struct netdev *);
220 int netdev_monitor_poll(struct netdev_monitor *, char **devnamep);
221 void netdev_monitor_poll_wait(const struct netdev_monitor *);
227 #endif /* netdev.h */