2 * Copyright (c) 2009, 2010, 2011 Nicira Networks.
4 * This file is offered under your choice of two licenses: Apache 2.0 or GNU
5 * GPL 2.0 or later. The permission statements for each of these licenses is
6 * given below. You may license your modifications to this file under either
7 * of these licenses or both. If you wish to license your modifications under
8 * only one of these licenses, delete the permission text for the other
11 * ----------------------------------------------------------------------
12 * Licensed under the Apache License, Version 2.0 (the "License");
13 * you may not use this file except in compliance with the License.
14 * You may obtain a copy of the License at:
16 * http://www.apache.org/licenses/LICENSE-2.0
18 * Unless required by applicable law or agreed to in writing, software
19 * distributed under the License is distributed on an "AS IS" BASIS,
20 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21 * See the License for the specific language governing permissions and
22 * limitations under the License.
23 * ----------------------------------------------------------------------
24 * This program is free software; you can redistribute it and/or modify
25 * it under the terms of the GNU General Public License as published by
26 * the Free Software Foundation; either version 2 of the License, or
27 * (at your option) any later version.
29 * This program is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU General Public License for more details.
34 * You should have received a copy of the GNU General Public License along
35 * with this program; if not, write to the Free Software Foundation, Inc.,
36 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
37 * ----------------------------------------------------------------------
40 #ifndef _LINUX_OPENVSWITCH_H
41 #define _LINUX_OPENVSWITCH_H 1
43 #include <linux/types.h>
47 #define OVS_DATAPATH_FAMILY "ovs_datapath"
48 #define OVS_DATAPATH_MCGROUP "ovs_datapath"
49 #define OVS_DATAPATH_VERSION 0x1
51 enum ovs_datapath_cmd {
60 * struct ovs_header - header for OVS Generic Netlink messages.
61 * @dp_ifindex: ifindex of local port for datapath (0 to make a request not
62 * specific to a datapath).
64 * Attributes following the header are specific to a particular OVS Generic
65 * Netlink family, but all of the OVS families use this header.
72 * enum ovs_datapath_attr - attributes for %OVS_DP_* commands.
73 * @OVS_DP_ATTR_NAME: Name of the network device that serves as the "local
74 * port". This is the name of the network device whose dp_ifindex is given in
75 * the &struct ovs_header. Always present in notifications. Required in
76 * %OVS_DP_NEW requests. May be used as an alternative to specifying
77 * dp_ifindex in other requests (with a dp_ifindex of 0).
78 * @OVS_DP_ATTR_UPCALL_PID: The Netlink socket in userspace that is initially
79 * set on the datapath port (for OVS_ACTION_ATTR_MISS). Only valid on
80 * %OVS_DP_CMD_NEW requests. A value of zero indicates that upcalls should
82 * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the
83 * datapath. Always present in notifications.
85 * These attributes follow the &struct ovs_header within the Generic Netlink
86 * payload for %OVS_DP_* commands.
88 enum ovs_datapath_attr {
90 OVS_DP_ATTR_NAME, /* name of dp_ifindex netdev */
91 OVS_DP_ATTR_UPCALL_PID, /* Netlink PID to receive upcalls */
92 OVS_DP_ATTR_STATS, /* struct ovs_dp_stats */
96 #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
99 __u64 n_hit; /* Number of flow table matches. */
100 __u64 n_missed; /* Number of flow table misses. */
101 __u64 n_lost; /* Number of misses not sent to userspace. */
102 __u64 n_flows; /* Number of flows present */
105 struct ovs_vport_stats {
106 __u64 rx_packets; /* total packets received */
107 __u64 tx_packets; /* total packets transmitted */
108 __u64 rx_bytes; /* total bytes received */
109 __u64 tx_bytes; /* total bytes transmitted */
110 __u64 rx_errors; /* bad packets received */
111 __u64 tx_errors; /* packet transmit problems */
112 __u64 rx_dropped; /* no space in linux buffers */
113 __u64 tx_dropped; /* no space available in linux */
117 #define OVSP_LOCAL ((__u16)0)
119 #define OVS_PACKET_FAMILY "ovs_packet"
120 #define OVS_PACKET_VERSION 0x1
122 enum ovs_packet_cmd {
123 OVS_PACKET_CMD_UNSPEC,
125 /* Kernel-to-user notifications. */
126 OVS_PACKET_CMD_MISS, /* Flow table miss. */
127 OVS_PACKET_CMD_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */
130 OVS_PACKET_CMD_EXECUTE /* Apply actions to a packet. */
134 * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
135 * @OVS_PACKET_ATTR_PACKET: Present for all notifications. Contains the entire
136 * packet as received, from the start of the Ethernet header onward. For
137 * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
138 * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
139 * the flow key extracted from the packet as originally received.
140 * @OVS_PACKET_ATTR_KEY: Present for all notifications. Contains the flow key
141 * extracted from the packet as nested %OVS_KEY_ATTR_* attributes. This allows
142 * userspace to adapt its flow setup strategy by comparing its notion of the
143 * flow key against the kernel's.
144 * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet. Used
145 * for %OVS_PACKET_CMD_EXECUTE. It has nested %OVS_ACTION_ATTR_* attributes.
146 * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
147 * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
148 * %OVS_USERSPACE_ATTR_USERDATA attribute.
150 * These attributes follow the &struct ovs_header within the Generic Netlink
151 * payload for %OVS_PACKET_* commands.
153 enum ovs_packet_attr {
154 OVS_PACKET_ATTR_UNSPEC,
155 OVS_PACKET_ATTR_PACKET, /* Packet data. */
156 OVS_PACKET_ATTR_KEY, /* Nested OVS_KEY_ATTR_* attributes. */
157 OVS_PACKET_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
158 OVS_PACKET_ATTR_USERDATA, /* u64 OVS_ACTION_ATTR_USERSPACE arg. */
159 __OVS_PACKET_ATTR_MAX
162 #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
164 enum ovs_vport_type {
165 OVS_VPORT_TYPE_UNSPEC,
166 OVS_VPORT_TYPE_NETDEV, /* network device */
167 OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
168 OVS_VPORT_TYPE_PATCH, /* virtual tunnel connecting two vports */
169 OVS_VPORT_TYPE_GRE, /* GRE tunnel */
170 OVS_VPORT_TYPE_CAPWAP, /* CAPWAP tunnel */
174 #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
176 #define OVS_VPORT_FAMILY "ovs_vport"
177 #define OVS_VPORT_MCGROUP "ovs_vport"
178 #define OVS_VPORT_VERSION 0x1
181 OVS_VPORT_CMD_UNSPEC,
189 * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
190 * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
191 * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
193 * @OVS_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device
194 * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes
195 * plus a null terminator.
196 * @OVS_VPORT_ATTR_UPCALL_PID: The Netlink socket in userspace that
197 * OVS_PACKET_CMD_MISS upcalls will be directed to for packets received on
198 * this port. A value of zero indicates that upcalls should not be sent.
199 * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
200 * packets sent or received through the vport.
201 * @OVS_VPORT_ATTR_ADDRESS: A 6-byte Ethernet address for the vport.
203 * These attributes follow the &struct ovs_header within the Generic Netlink
204 * payload for %OVS_VPORT_* commands.
206 * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
207 * %OVS_VPORT_ATTR_NAME attributes are required. %OVS_VPORT_ATTR_PORT_NO is
208 * optional; if not specified a free port number is automatically selected.
209 * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
210 * of vport. %OVS_VPORT_ATTR_STATS and %OVS_VPORT_ATTR_ADDRESS are optional,
211 * and other attributes are ignored.
213 * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
214 * look up the vport to operate on; otherwise dp_idx from the &struct
215 * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
217 enum ovs_vport_attr {
218 OVS_VPORT_ATTR_UNSPEC,
219 OVS_VPORT_ATTR_PORT_NO, /* port number within datapath */
220 OVS_VPORT_ATTR_TYPE, /* 32-bit OVS_VPORT_TYPE_* constant. */
221 OVS_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */
222 OVS_VPORT_ATTR_UPCALL_PID, /* Netlink PID to receive upcalls */
223 OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */
224 OVS_VPORT_ATTR_ADDRESS, /* hardware address */
225 OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
229 #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
231 /* OVS_VPORT_ATTR_OPTIONS attributes for patch vports. */
233 OVS_PATCH_ATTR_UNSPEC,
234 OVS_PATCH_ATTR_PEER, /* name of peer vport, as a string */
238 #define OVS_PATCH_ATTR_MAX (__OVS_PATCH_ATTR_MAX - 1)
242 #define OVS_FLOW_FAMILY "ovs_flow"
243 #define OVS_FLOW_MCGROUP "ovs_flow"
244 #define OVS_FLOW_VERSION 0x1
254 struct ovs_flow_stats {
255 __u64 n_packets; /* Number of matched packets. */
256 __u64 n_bytes; /* Number of matched bytes. */
261 OVS_KEY_ATTR_TUN_ID, /* 64-bit tunnel ID */
262 OVS_KEY_ATTR_IN_PORT, /* 32-bit OVS dp port number */
263 OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */
264 OVS_KEY_ATTR_8021Q, /* struct ovs_key_8021q */
265 OVS_KEY_ATTR_ETHERTYPE, /* 16-bit Ethernet type */
266 OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */
267 OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */
268 OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */
269 OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */
270 OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */
271 OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */
272 OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */
273 OVS_KEY_ATTR_ND, /* struct ovs_key_nd */
277 #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
280 * enum ovs_frag_type - IPv4 and IPv6 fragment type
281 * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
282 * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
283 * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
285 * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
295 #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
297 struct ovs_key_ethernet {
302 struct ovs_key_8021q {
307 struct ovs_key_ipv4 {
312 __u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */
315 struct ovs_key_ipv6 {
320 __u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */
333 struct ovs_key_icmp {
338 struct ovs_key_icmpv6 {
358 * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
359 * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
360 * key. Always present in notifications. Required for all requests (except
362 * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
363 * the actions to take for packets that match the key. Always present in
364 * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional
365 * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
366 * flow. Present in notifications if the stats would be nonzero. Ignored in
368 * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
369 * TCP flags seen on packets in this flow. Only present in notifications for
370 * TCP flows, and only if it would be nonzero. Ignored in requests.
371 * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
372 * the system monotonic clock, at which a packet was last processed for this
373 * flow. Only present in notifications if a packet has been processed for this
374 * flow. Ignored in requests.
375 * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
376 * last-used time, accumulated TCP flags, and statistics for this flow.
377 * Otherwise ignored in requests. Never present in notifications.
379 * These attributes follow the &struct ovs_header within the Generic Netlink
380 * payload for %OVS_FLOW_* commands.
383 OVS_FLOW_ATTR_UNSPEC,
384 OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */
385 OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
386 OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */
387 OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
388 OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */
389 OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */
393 #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
396 * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
397 * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
398 * @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of
399 * %UINT32_MAX samples all packets and intermediate values sample intermediate
400 * fractions of packets.
401 * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
402 * Actions are passed as nested attributes.
404 * Executes the specified actions with the given probability on a per-packet
407 enum ovs_sample_attr {
408 OVS_SAMPLE_ATTR_UNSPEC,
409 OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
410 OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
411 __OVS_SAMPLE_ATTR_MAX,
414 #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
417 * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
418 * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
419 * message should be sent. Required.
420 * @OVS_USERSPACE_ATTR_USERDATA: If present, its u64 argument is copied to the
421 * %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA,
423 enum ovs_userspace_attr {
424 OVS_USERSPACE_ATTR_UNSPEC,
425 OVS_USERSPACE_ATTR_PID, /* u32 Netlink PID to receive upcalls. */
426 OVS_USERSPACE_ATTR_USERDATA, /* u64 optional user-specified cookie. */
427 __OVS_USERSPACE_ATTR_MAX
430 #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
433 * enum ovs_action_attr - Action types.
435 * @OVS_ACTION_ATTR_OUTPUT: Output packet to port passed as NLA data.
436 * @OVS_ACTION_ATTR_USERSPACE: Nested %OVS_USERSPACE_ATTR_ attributes specifying
438 * @OVS_ACTION_ATTR_PUSH: Nested %OVS_KEY_ATTR_* attribute specifying header to
439 * push to given packet.
440 * E.g. Push vlan tag action would be NLA of %OVS_ACTION_ATTR_PUSH type with
441 * nested attribute of type %OVS_KEY_ATTR_8021Q with struct ovs_key_8021q
443 * @OVS_ACTION_ATTR_POP: Pop header according to %OVS_KEY_ATTR_ sent as
445 * @OVS_ACTION_ATTR_SET: Nested %OVS_KEY_ATTR_* attribute specifying the
446 * field to set to given packet.
447 * @OVS_ACTION_ATTR_SET_PRIORITY: A set skb->priority to 32-bit number passed
449 * @OVS_ACTION_ATTR_POP_PRIORITY: Restore skb->priority to original value.
450 * @OVS_ACTION_ATTR_SAMPLE: Execute set of actions according to probability
451 * %OVS_SAMPLE_ATTR_PROBABILITY.
453 * Only a single field can be set with a single %OVS_ACTION_ATTR_{SET,PUSH}.
456 enum ovs_action_attr {
457 OVS_ACTION_ATTR_UNSPEC,
458 OVS_ACTION_ATTR_OUTPUT, /* Output to switch port. */
459 OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */
460 OVS_ACTION_ATTR_PUSH, /* Push packet header. */
461 OVS_ACTION_ATTR_POP, /* Pop packet header. */
462 OVS_ACTION_ATTR_SET, /* Set packet field(s). */
463 OVS_ACTION_ATTR_SET_PRIORITY, /* Set skb->priority. */
464 OVS_ACTION_ATTR_POP_PRIORITY, /* Restore original skb->priority. */
465 OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */
466 __OVS_ACTION_ATTR_MAX
469 #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
471 #endif /* _LINUX_OPENVSWITCH_H */