in-band: Implement L3-based in-band control
[openvswitch] / lib / netdev.h
1 /*
2  * Copyright (c) 2008, 2009 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 /* Generic interface to network devices.
25  *
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. */
29
30 struct ofpbuf;
31 struct in_addr;
32 struct in6_addr;
33 struct svec;
34
35 enum netdev_flags {
36     NETDEV_UP = 0x0001,         /* Device enabled? */
37     NETDEV_PROMISC = 0x0002     /* Promiscuous mode? */
38 };
39
40 enum netdev_pseudo_ethertype {
41     NETDEV_ETH_TYPE_NONE = -128, /* Receive no frames. */
42     NETDEV_ETH_TYPE_ANY,         /* Receive all frames. */
43     NETDEV_ETH_TYPE_802_2        /* Receive all IEEE 802.2 frames. */
44 };
45
46 struct netdev_stats {
47     uint64_t rx_packets;        /* Total packets received. */
48     uint64_t tx_packets;        /* Total packets transmitted. */
49     uint64_t rx_bytes;          /* Total bytes received. */
50     uint64_t tx_bytes;          /* Total bytes transmitted. */
51     uint64_t rx_errors;         /* Bad packets received. */
52     uint64_t tx_errors;         /* Packet transmit problems. */
53     uint64_t rx_dropped;        /* No buffer space. */
54     uint64_t tx_dropped;        /* No buffer space. */
55     uint64_t multicast;         /* Multicast packets received. */
56     uint64_t collisions;
57
58     /* Detailed receive errors. */
59     uint64_t rx_length_errors;
60     uint64_t rx_over_errors;    /* Receiver ring buff overflow. */
61     uint64_t rx_crc_errors;     /* Recved pkt with crc error. */
62     uint64_t rx_frame_errors;   /* Recv'd frame alignment error. */
63     uint64_t rx_fifo_errors;    /* Recv'r fifo overrun . */
64     uint64_t rx_missed_errors;  /* Receiver missed packet. */
65
66     /* Detailed transmit errors. */
67     uint64_t tx_aborted_errors;
68     uint64_t tx_carrier_errors;
69     uint64_t tx_fifo_errors;
70     uint64_t tx_heartbeat_errors;
71     uint64_t tx_window_errors;
72 };
73
74 struct netdev;
75
76 int netdev_open(const char *name, int ethertype, struct netdev **);
77 int netdev_open_tap(const char *name, struct netdev **);
78 void netdev_close(struct netdev *);
79
80 int netdev_recv(struct netdev *, struct ofpbuf *);
81 void netdev_recv_wait(struct netdev *);
82 int netdev_drain(struct netdev *);
83 int netdev_send(struct netdev *, const struct ofpbuf *);
84 void netdev_send_wait(struct netdev *);
85 int netdev_set_etheraddr(struct netdev *, const uint8_t mac[6]);
86 const uint8_t *netdev_get_etheraddr(const struct netdev *);
87 const char *netdev_get_name(const struct netdev *);
88 int netdev_get_mtu(const struct netdev *);
89 int netdev_get_features(struct netdev *,
90                         uint32_t *current, uint32_t *advertised,
91                         uint32_t *supported, uint32_t *peer);
92 int netdev_set_advertisements(struct netdev *, uint32_t advertise);
93 bool netdev_get_in4(const struct netdev *, struct in_addr *addr,
94                     struct in_addr *mask);
95 int netdev_set_in4(struct netdev *, struct in_addr in4, struct in_addr mask);
96 int netdev_add_router(struct in_addr router);
97 bool netdev_get_in6(const struct netdev *, struct in6_addr *);
98 int netdev_get_flags(const struct netdev *, enum netdev_flags *);
99 int netdev_set_flags(struct netdev *, enum netdev_flags, bool permanent);
100 int netdev_turn_flags_on(struct netdev *, enum netdev_flags, bool permanent);
101 int netdev_turn_flags_off(struct netdev *, enum netdev_flags, bool permanent);
102 int netdev_arp_lookup(const struct netdev *, uint32_t ip, uint8_t mac[6]);
103 int netdev_get_carrier(const struct netdev *, bool *carrier);
104 int netdev_get_stats(const struct netdev *, struct netdev_stats *);
105 int netdev_set_policing(struct netdev *, uint32_t kbits_rate, 
106                         uint32_t kbits_burst);
107
108 void netdev_enumerate(struct svec *);
109 bool netdev_find_dev_by_in4(const struct in_addr *in4, char **netdev_name);
110 int netdev_get_next_hop(const struct in_addr *host, struct in_addr *next_hop,
111                         char **netdev_name);
112 int netdev_nodev_get_flags(const char *netdev_name, enum netdev_flags *);
113 bool netdev_nodev_get_in4(const char *netdev_name, struct in_addr *in4,
114                           struct in_addr *mask);
115 int netdev_nodev_set_etheraddr(const char *name, const uint8_t mac[6]);
116 int netdev_nodev_get_etheraddr(const char *netdev_name, uint8_t mac[6]);
117 int netdev_nodev_set_policing(const char *netdev_name, uint32_t kbits_rate, 
118                               uint32_t kbits_burst);
119 int netdev_nodev_arp_lookup(const char *netdev_name, uint32_t ip, 
120                             uint8_t mac[6]);
121 int netdev_nodev_get_carrier(const char *netdev_name, bool *carrier);
122
123 int netdev_get_vlan_vid(const char *netdev_name, int *vlan_vid);
124
125 #endif /* netdev.h */