daemon: Throttle max respawning rate.
[openvswitch] / lib / netdev.h
1 /*
2  * Copyright (c) 2008, 2009, 2010 Nicira Networks.
3  *
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:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 #ifndef NETDEV_H
18 #define NETDEV_H 1
19
20 #include <stdbool.h>
21 #include <stddef.h>
22 #include <stdint.h>
23
24 #ifdef  __cplusplus
25 extern "C" {
26 #endif
27
28 /* Generic interface to network devices.
29  *
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. */
33
34 struct ofpbuf;
35 struct in_addr;
36 struct in6_addr;
37 struct shash;
38 struct svec;
39
40 enum netdev_flags {
41     NETDEV_UP = 0x0001,         /* Device enabled? */
42     NETDEV_PROMISC = 0x0002,    /* Promiscuous mode? */
43     NETDEV_LOOPBACK = 0x0004    /* This is a loopback device. */
44 };
45
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. */
50 };
51
52 /* Network device statistics.
53  *
54  * Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
55 struct netdev_stats {
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. */
65     uint64_t collisions;
66
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. */
74
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;
81 };
82
83 struct netdev_options {
84     const char *name;
85     const char *type;
86     const struct shash *args;
87     int ethertype;
88     bool may_create;
89     bool may_open;
90 };
91
92 struct netdev;
93 struct netdev_class;
94
95 void netdev_run(void);
96 void netdev_wait(void);
97
98 int netdev_register_provider(const struct netdev_class *);
99 int netdev_unregister_provider(const char *type);
100 void netdev_enumerate_types(struct svec *types);
101
102 int netdev_open(struct netdev_options *, struct netdev **);
103 int netdev_open_default(const char *name, struct netdev **);
104 int netdev_reconfigure(struct netdev *, const struct shash *args);
105 void netdev_close(struct netdev *);
106
107 bool netdev_exists(const char *name);
108 bool netdev_is_open(const char *name);
109
110 int netdev_enumerate(struct svec *);
111
112 const char *netdev_get_name(const struct netdev *);
113 const char *netdev_get_type(const struct netdev *);
114 int netdev_get_mtu(const struct netdev *, int *mtup);
115 int netdev_get_ifindex(const struct netdev *);
116
117 int netdev_recv(struct netdev *, struct ofpbuf *);
118 void netdev_recv_wait(struct netdev *);
119 int netdev_drain(struct netdev *);
120
121 int netdev_send(struct netdev *, const struct ofpbuf *);
122 void netdev_send_wait(struct netdev *);
123
124 int netdev_set_etheraddr(struct netdev *, const uint8_t mac[6]);
125 int netdev_get_etheraddr(const struct netdev *, uint8_t mac[6]);
126
127 int netdev_get_carrier(const struct netdev *, bool *carrier);
128 int netdev_get_features(struct netdev *,
129                         uint32_t *current, uint32_t *advertised,
130                         uint32_t *supported, uint32_t *peer);
131 uint64_t netdev_features_to_bps(uint32_t features);
132 bool netdev_features_is_full_duplex(uint32_t features);
133 int netdev_set_advertisements(struct netdev *, uint32_t advertise);
134
135 int netdev_get_in4(const struct netdev *, struct in_addr *address,
136                    struct in_addr *netmask);
137 int netdev_set_in4(struct netdev *, struct in_addr addr, struct in_addr mask);
138 int netdev_get_in6(const struct netdev *, struct in6_addr *);
139 int netdev_add_router(struct netdev *, struct in_addr router);
140 int netdev_get_next_hop(const struct netdev *, const struct in_addr *host,
141                         struct in_addr *next_hop, char **);
142 int netdev_arp_lookup(const struct netdev *, uint32_t ip, uint8_t mac[6]);
143
144 int netdev_get_flags(const struct netdev *, enum netdev_flags *);
145 int netdev_set_flags(struct netdev *, enum netdev_flags, bool permanent);
146 int netdev_turn_flags_on(struct netdev *, enum netdev_flags, bool permanent);
147 int netdev_turn_flags_off(struct netdev *, enum netdev_flags, bool permanent);
148
149 int netdev_get_stats(const struct netdev *, struct netdev_stats *);
150 int netdev_set_stats(struct netdev *, const struct netdev_stats *);
151 int netdev_set_policing(struct netdev *, uint32_t kbits_rate, 
152                         uint32_t kbits_burst);
153
154 int netdev_get_vlan_vid(const struct netdev *, int *vlan_vid);
155 struct netdev *netdev_find_dev_by_in4(const struct in_addr *);
156
157 struct netdev_monitor *netdev_monitor_create(void);
158 void netdev_monitor_destroy(struct netdev_monitor *);
159 int netdev_monitor_add(struct netdev_monitor *, struct netdev *);
160 void netdev_monitor_remove(struct netdev_monitor *, struct netdev *);
161 int netdev_monitor_poll(struct netdev_monitor *, char **devnamep);
162 void netdev_monitor_poll_wait(const struct netdev_monitor *);
163
164 #ifdef  __cplusplus
165 }
166 #endif
167
168 #endif /* netdev.h */