2 * Copyright (c) 2008, 2009 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.
24 /* Generic interface to network devices.
26 * Currently, there is a single implementation of this interface that supports
27 * Linux. The interface should be generic enough to be implementable on other
28 * operating systems as well. */
37 NETDEV_UP = 0x0001, /* Device enabled? */
38 NETDEV_PROMISC = 0x0002, /* Promiscuous mode? */
39 NETDEV_LOOPBACK = 0x0004 /* This is a loopback device. */
42 enum netdev_pseudo_ethertype {
43 NETDEV_ETH_TYPE_NONE = -128, /* Receive no frames. */
44 NETDEV_ETH_TYPE_ANY, /* Receive all frames. */
45 NETDEV_ETH_TYPE_802_2 /* Receive all IEEE 802.2 frames. */
48 /* Network device statistics.
50 * Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
52 uint64_t rx_packets; /* Total packets received. */
53 uint64_t tx_packets; /* Total packets transmitted. */
54 uint64_t rx_bytes; /* Total bytes received. */
55 uint64_t tx_bytes; /* Total bytes transmitted. */
56 uint64_t rx_errors; /* Bad packets received. */
57 uint64_t tx_errors; /* Packet transmit problems. */
58 uint64_t rx_dropped; /* No buffer space. */
59 uint64_t tx_dropped; /* No buffer space. */
60 uint64_t multicast; /* Multicast packets received. */
63 /* Detailed receive errors. */
64 uint64_t rx_length_errors;
65 uint64_t rx_over_errors; /* Receiver ring buff overflow. */
66 uint64_t rx_crc_errors; /* Recved pkt with crc error. */
67 uint64_t rx_frame_errors; /* Recv'd frame alignment error. */
68 uint64_t rx_fifo_errors; /* Recv'r fifo overrun . */
69 uint64_t rx_missed_errors; /* Receiver missed packet. */
71 /* Detailed transmit errors. */
72 uint64_t tx_aborted_errors;
73 uint64_t tx_carrier_errors;
74 uint64_t tx_fifo_errors;
75 uint64_t tx_heartbeat_errors;
76 uint64_t tx_window_errors;
81 int netdev_initialize(void);
82 void netdev_run(void);
83 void netdev_wait(void);
85 int netdev_create(const char *name, const char *type,
86 const struct shash *args);
87 int netdev_destroy(const char *name);
88 int netdev_reconfigure(const char *name, const struct shash *args);
90 int netdev_open(const char *name, int ethertype, struct netdev **);
91 void netdev_close(struct netdev *);
93 bool netdev_exists(const char *name);
95 int netdev_enumerate(struct svec *);
97 const char *netdev_get_name(const struct netdev *);
98 int netdev_get_mtu(const struct netdev *, int *mtup);
99 int netdev_get_ifindex(const struct netdev *);
101 int netdev_recv(struct netdev *, struct ofpbuf *);
102 void netdev_recv_wait(struct netdev *);
103 int netdev_drain(struct netdev *);
105 int netdev_send(struct netdev *, const struct ofpbuf *);
106 void netdev_send_wait(struct netdev *);
108 int netdev_set_etheraddr(struct netdev *, const uint8_t mac[6]);
109 int netdev_get_etheraddr(const struct netdev *, uint8_t mac[6]);
111 int netdev_get_carrier(const struct netdev *, bool *carrier);
112 int netdev_get_features(struct netdev *,
113 uint32_t *current, uint32_t *advertised,
114 uint32_t *supported, uint32_t *peer);
115 int netdev_set_advertisements(struct netdev *, uint32_t advertise);
117 int netdev_get_in4(const struct netdev *, struct in_addr *address,
118 struct in_addr *netmask);
119 int netdev_set_in4(struct netdev *, struct in_addr addr, struct in_addr mask);
120 int netdev_get_in6(const struct netdev *, struct in6_addr *);
121 int netdev_add_router(struct netdev *, struct in_addr router);
122 int netdev_get_next_hop(const struct netdev *, const struct in_addr *host,
123 struct in_addr *next_hop, char **);
124 int netdev_arp_lookup(const struct netdev *, uint32_t ip, uint8_t mac[6]);
126 int netdev_get_flags(const struct netdev *, enum netdev_flags *);
127 int netdev_set_flags(struct netdev *, enum netdev_flags, bool permanent);
128 int netdev_turn_flags_on(struct netdev *, enum netdev_flags, bool permanent);
129 int netdev_turn_flags_off(struct netdev *, enum netdev_flags, bool permanent);
131 int netdev_get_stats(const struct netdev *, struct netdev_stats *);
132 int netdev_set_policing(struct netdev *, uint32_t kbits_rate,
133 uint32_t kbits_burst);
135 int netdev_get_vlan_vid(const struct netdev *, int *vlan_vid);
136 struct netdev *netdev_find_dev_by_in4(const struct in_addr *);
138 struct netdev_monitor *netdev_monitor_create(void);
139 void netdev_monitor_destroy(struct netdev_monitor *);
140 int netdev_monitor_add(struct netdev_monitor *, struct netdev *);
141 void netdev_monitor_remove(struct netdev_monitor *, struct netdev *);
142 int netdev_monitor_poll(struct netdev_monitor *, char **devnamep);
143 void netdev_monitor_poll_wait(const struct netdev_monitor *);
145 #endif /* netdev.h */