aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorThomas Graf <tgraf@suug.ch>2013-03-29 09:46:52 -0400
committerJesse Gross <jesse@nicira.com>2013-03-29 20:54:33 -0400
commit22e3880a76bb9a0c4fa5c8fefdc8697a36a4dae1 (patch)
tree7bd56dd948101a82bb6a797092aaaf85ffb8db98 /include
parent14b57a10553b5b768f77b247e6dd285c65816064 (diff)
openvswitch: Expose <linux/openvswitch.h> to userspace
It contains the public netlink interface bits required by userspace to make use of the interface. Signed-off-by: Thomas Graf <tgraf@suug.ch> Signed-off-by: Jesse Gross <jesse@nicira.com>
Diffstat (limited to 'include')
-rw-r--r--include/linux/openvswitch.h433
-rw-r--r--include/uapi/linux/Kbuild1
-rw-r--r--include/uapi/linux/openvswitch.h456
3 files changed, 458 insertions, 432 deletions
diff --git a/include/linux/openvswitch.h b/include/linux/openvswitch.h
index 8b9d7217eddc..e6b240b6196c 100644
--- a/include/linux/openvswitch.h
+++ b/include/linux/openvswitch.h
@@ -19,437 +19,6 @@
19#ifndef _LINUX_OPENVSWITCH_H 19#ifndef _LINUX_OPENVSWITCH_H
20#define _LINUX_OPENVSWITCH_H 1 20#define _LINUX_OPENVSWITCH_H 1
21 21
22#include <linux/types.h> 22#include <uapi/linux/openvswitch.h>
23#include <linux/if_ether.h>
24
25/**
26 * struct ovs_header - header for OVS Generic Netlink messages.
27 * @dp_ifindex: ifindex of local port for datapath (0 to make a request not
28 * specific to a datapath).
29 *
30 * Attributes following the header are specific to a particular OVS Generic
31 * Netlink family, but all of the OVS families use this header.
32 */
33
34struct ovs_header {
35 int dp_ifindex;
36};
37
38/* Datapaths. */
39
40#define OVS_DATAPATH_FAMILY "ovs_datapath"
41#define OVS_DATAPATH_MCGROUP "ovs_datapath"
42#define OVS_DATAPATH_VERSION 0x1
43
44enum ovs_datapath_cmd {
45 OVS_DP_CMD_UNSPEC,
46 OVS_DP_CMD_NEW,
47 OVS_DP_CMD_DEL,
48 OVS_DP_CMD_GET,
49 OVS_DP_CMD_SET
50};
51
52/**
53 * enum ovs_datapath_attr - attributes for %OVS_DP_* commands.
54 * @OVS_DP_ATTR_NAME: Name of the network device that serves as the "local
55 * port". This is the name of the network device whose dp_ifindex is given in
56 * the &struct ovs_header. Always present in notifications. Required in
57 * %OVS_DP_NEW requests. May be used as an alternative to specifying
58 * dp_ifindex in other requests (with a dp_ifindex of 0).
59 * @OVS_DP_ATTR_UPCALL_PID: The Netlink socket in userspace that is initially
60 * set on the datapath port (for OVS_ACTION_ATTR_MISS). Only valid on
61 * %OVS_DP_CMD_NEW requests. A value of zero indicates that upcalls should
62 * not be sent.
63 * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the
64 * datapath. Always present in notifications.
65 *
66 * These attributes follow the &struct ovs_header within the Generic Netlink
67 * payload for %OVS_DP_* commands.
68 */
69enum ovs_datapath_attr {
70 OVS_DP_ATTR_UNSPEC,
71 OVS_DP_ATTR_NAME, /* name of dp_ifindex netdev */
72 OVS_DP_ATTR_UPCALL_PID, /* Netlink PID to receive upcalls */
73 OVS_DP_ATTR_STATS, /* struct ovs_dp_stats */
74 __OVS_DP_ATTR_MAX
75};
76
77#define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
78
79struct ovs_dp_stats {
80 __u64 n_hit; /* Number of flow table matches. */
81 __u64 n_missed; /* Number of flow table misses. */
82 __u64 n_lost; /* Number of misses not sent to userspace. */
83 __u64 n_flows; /* Number of flows present */
84};
85
86struct ovs_vport_stats {
87 __u64 rx_packets; /* total packets received */
88 __u64 tx_packets; /* total packets transmitted */
89 __u64 rx_bytes; /* total bytes received */
90 __u64 tx_bytes; /* total bytes transmitted */
91 __u64 rx_errors; /* bad packets received */
92 __u64 tx_errors; /* packet transmit problems */
93 __u64 rx_dropped; /* no space in linux buffers */
94 __u64 tx_dropped; /* no space available in linux */
95};
96
97/* Fixed logical ports. */
98#define OVSP_LOCAL ((__u32)0)
99
100/* Packet transfer. */
101
102#define OVS_PACKET_FAMILY "ovs_packet"
103#define OVS_PACKET_VERSION 0x1
104
105enum ovs_packet_cmd {
106 OVS_PACKET_CMD_UNSPEC,
107
108 /* Kernel-to-user notifications. */
109 OVS_PACKET_CMD_MISS, /* Flow table miss. */
110 OVS_PACKET_CMD_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */
111
112 /* Userspace commands. */
113 OVS_PACKET_CMD_EXECUTE /* Apply actions to a packet. */
114};
115
116/**
117 * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
118 * @OVS_PACKET_ATTR_PACKET: Present for all notifications. Contains the entire
119 * packet as received, from the start of the Ethernet header onward. For
120 * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
121 * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
122 * the flow key extracted from the packet as originally received.
123 * @OVS_PACKET_ATTR_KEY: Present for all notifications. Contains the flow key
124 * extracted from the packet as nested %OVS_KEY_ATTR_* attributes. This allows
125 * userspace to adapt its flow setup strategy by comparing its notion of the
126 * flow key against the kernel's.
127 * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet. Used
128 * for %OVS_PACKET_CMD_EXECUTE. It has nested %OVS_ACTION_ATTR_* attributes.
129 * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
130 * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
131 * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content
132 * specified there.
133 *
134 * These attributes follow the &struct ovs_header within the Generic Netlink
135 * payload for %OVS_PACKET_* commands.
136 */
137enum ovs_packet_attr {
138 OVS_PACKET_ATTR_UNSPEC,
139 OVS_PACKET_ATTR_PACKET, /* Packet data. */
140 OVS_PACKET_ATTR_KEY, /* Nested OVS_KEY_ATTR_* attributes. */
141 OVS_PACKET_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
142 OVS_PACKET_ATTR_USERDATA, /* OVS_ACTION_ATTR_USERSPACE arg. */
143 __OVS_PACKET_ATTR_MAX
144};
145
146#define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
147
148/* Virtual ports. */
149
150#define OVS_VPORT_FAMILY "ovs_vport"
151#define OVS_VPORT_MCGROUP "ovs_vport"
152#define OVS_VPORT_VERSION 0x1
153
154enum ovs_vport_cmd {
155 OVS_VPORT_CMD_UNSPEC,
156 OVS_VPORT_CMD_NEW,
157 OVS_VPORT_CMD_DEL,
158 OVS_VPORT_CMD_GET,
159 OVS_VPORT_CMD_SET
160};
161
162enum ovs_vport_type {
163 OVS_VPORT_TYPE_UNSPEC,
164 OVS_VPORT_TYPE_NETDEV, /* network device */
165 OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
166 __OVS_VPORT_TYPE_MAX
167};
168
169#define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
170
171/**
172 * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
173 * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
174 * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
175 * of vport.
176 * @OVS_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device
177 * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes
178 * plus a null terminator.
179 * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information.
180 * @OVS_VPORT_ATTR_UPCALL_PID: The Netlink socket in userspace that
181 * OVS_PACKET_CMD_MISS upcalls will be directed to for packets received on
182 * this port. A value of zero indicates that upcalls should not be sent.
183 * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
184 * packets sent or received through the vport.
185 *
186 * These attributes follow the &struct ovs_header within the Generic Netlink
187 * payload for %OVS_VPORT_* commands.
188 *
189 * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
190 * %OVS_VPORT_ATTR_NAME attributes are required. %OVS_VPORT_ATTR_PORT_NO is
191 * optional; if not specified a free port number is automatically selected.
192 * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
193 * of vport.
194 * and other attributes are ignored.
195 *
196 * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
197 * look up the vport to operate on; otherwise dp_idx from the &struct
198 * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
199 */
200enum ovs_vport_attr {
201 OVS_VPORT_ATTR_UNSPEC,
202 OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */
203 OVS_VPORT_ATTR_TYPE, /* u32 OVS_VPORT_TYPE_* constant. */
204 OVS_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */
205 OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
206 OVS_VPORT_ATTR_UPCALL_PID, /* u32 Netlink PID to receive upcalls */
207 OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */
208 __OVS_VPORT_ATTR_MAX
209};
210
211#define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
212