2 * Copyright (c) 2007-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
25 * modify it under the terms of version 2 of the GNU General Public
26 * License as published by the Free Software Foundation.
28 * This program is distributed in the hope that it will be useful, but
29 * WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
31 * General Public License for more details.
33 * You should have received a copy of the GNU General Public License
34 * along with this program; if not, write to the Free Software
35 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
37 * ----------------------------------------------------------------------
40 #ifndef _LINUX_OPENVSWITCH_H
41 #define _LINUX_OPENVSWITCH_H 1
43 #include <linux/types.h>
46 * struct ovs_header - header for OVS Generic Netlink messages.
47 * @dp_ifindex: ifindex of local port for datapath (0 to make a request not
48 * specific to a datapath).
50 * Attributes following the header are specific to a particular OVS Generic
51 * Netlink family, but all of the OVS families use this header.
60 #define OVS_DATAPATH_FAMILY "ovs_datapath"
61 #define OVS_DATAPATH_MCGROUP "ovs_datapath"
62 #define OVS_DATAPATH_VERSION 0x1
64 enum ovs_datapath_cmd {
73 * enum ovs_datapath_attr - attributes for %OVS_DP_* commands.
74 * @OVS_DP_ATTR_NAME: Name of the network device that serves as the "local
75 * port". This is the name of the network device whose dp_ifindex is given in
76 * the &struct ovs_header. Always present in notifications. Required in
77 * %OVS_DP_NEW requests. May be used as an alternative to specifying
78 * dp_ifindex in other requests (with a dp_ifindex of 0).
79 * @OVS_DP_ATTR_UPCALL_PID: The Netlink socket in userspace that is initially
80 * set on the datapath port (for OVS_ACTION_ATTR_MISS). Only valid on
81 * %OVS_DP_CMD_NEW requests. A value of zero indicates that upcalls should
83 * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the
84 * datapath. Always present in notifications.
86 * These attributes follow the &struct ovs_header within the Generic Netlink
87 * payload for %OVS_DP_* commands.
89 enum ovs_datapath_attr {
91 OVS_DP_ATTR_NAME, /* name of dp_ifindex netdev */
92 OVS_DP_ATTR_UPCALL_PID, /* Netlink PID to receive upcalls */
93 OVS_DP_ATTR_STATS, /* struct ovs_dp_stats */
97 #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
100 __u64 n_hit; /* Number of flow table matches. */
101 __u64 n_missed; /* Number of flow table misses. */
102 __u64 n_lost; /* Number of misses not sent to userspace. */
103 __u64 n_flows; /* Number of flows present */
106 struct ovs_vport_stats {
107 __u64 rx_packets; /* total packets received */
108 __u64 tx_packets; /* total packets transmitted */
109 __u64 rx_bytes; /* total bytes received */
110 __u64 tx_bytes; /* total bytes transmitted */
111 __u64 rx_errors; /* bad packets received */
112 __u64 tx_errors; /* packet transmit problems */
113 __u64 rx_dropped; /* no space in linux buffers */
114 __u64 tx_dropped; /* no space available in linux */
117 /* Fixed logical ports. */
118 #define OVSP_LOCAL ((__u16)0)
120 /* Packet transfer. */
122 #define OVS_PACKET_FAMILY "ovs_packet"
123 #define OVS_PACKET_VERSION 0x1
125 enum ovs_packet_cmd {
126 OVS_PACKET_CMD_UNSPEC,
128 /* Kernel-to-user notifications. */
129 OVS_PACKET_CMD_MISS, /* Flow table miss. */
130 OVS_PACKET_CMD_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */
132 /* Userspace commands. */
133 OVS_PACKET_CMD_EXECUTE /* Apply actions to a packet. */
137 * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
138 * @OVS_PACKET_ATTR_PACKET: Present for all notifications. Contains the entire
139 * packet as received, from the start of the Ethernet header onward. For
140 * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
141 * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
142 * the flow key extracted from the packet as originally received.
143 * @OVS_PACKET_ATTR_KEY: Present for all notifications. Contains the flow key
144 * extracted from the packet as nested %OVS_KEY_ATTR_* attributes. This allows
145 * userspace to adapt its flow setup strategy by comparing its notion of the
146 * flow key against the kernel's.
147 * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet. Used
148 * for %OVS_PACKET_CMD_EXECUTE. It has nested %OVS_ACTION_ATTR_* attributes.
149 * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
150 * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
151 * %OVS_USERSPACE_ATTR_USERDATA attribute.
153 * These attributes follow the &struct ovs_header within the Generic Netlink
154 * payload for %OVS_PACKET_* commands.
156 enum ovs_packet_attr {
157 OVS_PACKET_ATTR_UNSPEC,
158 OVS_PACKET_ATTR_PACKET, /* Packet data. */
159 OVS_PACKET_ATTR_KEY, /* Nested OVS_KEY_ATTR_* attributes. */
160 OVS_PACKET_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
161 OVS_PACKET_ATTR_USERDATA, /* u64 OVS_ACTION_ATTR_USERSPACE arg. */
162 __OVS_PACKET_ATTR_MAX
165 #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
169 #define OVS_VPORT_FAMILY "ovs_vport"
170 #define OVS_VPORT_MCGROUP "ovs_vport"
171 #define OVS_VPORT_VERSION 0x1
174 OVS_VPORT_CMD_UNSPEC,
181 enum ovs_vport_type {
182 OVS_VPORT_TYPE_UNSPEC,
183 OVS_VPORT_TYPE_NETDEV, /* network device */
184 OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
185 OVS_VPORT_TYPE_PATCH = 100, /* virtual tunnel connecting two vports */
186 OVS_VPORT_TYPE_GRE, /* GRE tunnel */
187 OVS_VPORT_TYPE_CAPWAP, /* CAPWAP tunnel */
191 #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
194 * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
195 * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
196 * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
198 * @OVS_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device
199 * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes
200 * plus a null terminator.
201 * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information.
202 * @OVS_VPORT_ATTR_UPCALL_PID: The Netlink socket in userspace that
203 * OVS_PACKET_CMD_MISS upcalls will be directed to for packets received on
204 * this port. A value of zero indicates that upcalls should not be sent.
205 * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
206 * packets sent or received through the vport.
207 * @OVS_VPORT_ATTR_ADDRESS: A 6-byte Ethernet address for the vport.
209 * These attributes follow the &struct ovs_header within the Generic Netlink
210 * payload for %OVS_VPORT_* commands.
212 * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
213 * %OVS_VPORT_ATTR_NAME attributes are required. %OVS_VPORT_ATTR_PORT_NO is
214 * optional; if not specified a free port number is automatically selected.
215 * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
216 * of vport. %OVS_VPORT_ATTR_STATS and %OVS_VPORT_ATTR_ADDRESS are optional,
217 * and other attributes are ignored.
219 * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
220 * look up the vport to operate on; otherwise dp_idx from the &struct
221 * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
223 enum ovs_vport_attr {
224 OVS_VPORT_ATTR_UNSPEC,
225 OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */
226 OVS_VPORT_ATTR_TYPE, /* u32 OVS_VPORT_TYPE_* constant. */
227 OVS_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */
228 OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
229 OVS_VPORT_ATTR_UPCALL_PID, /* u32 Netlink PID to receive upcalls */
230 OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */
231 OVS_VPORT_ATTR_ADDRESS = 100, /* hardware address */
235 #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
237 /* OVS_VPORT_ATTR_OPTIONS attributes for patch vports. */
239 OVS_PATCH_ATTR_UNSPEC,
240 OVS_PATCH_ATTR_PEER, /* name of peer vport, as a string */
244 #define OVS_PATCH_ATTR_MAX (__OVS_PATCH_ATTR_MAX - 1)
248 #define OVS_FLOW_FAMILY "ovs_flow"
249 #define OVS_FLOW_MCGROUP "ovs_flow"
250 #define OVS_FLOW_VERSION 0x1
260 struct ovs_flow_stats {
261 __u64 n_packets; /* Number of matched packets. */
262 __u64 n_bytes; /* Number of matched bytes. */
267 OVS_KEY_ATTR_ENCAP, /* Nested set of encapsulated attributes. */
268 OVS_KEY_ATTR_PRIORITY, /* u32 skb->priority */
269 OVS_KEY_ATTR_IN_PORT, /* u32 OVS dp port number */
270 OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */
271 OVS_KEY_ATTR_VLAN, /* be16 VLAN TCI */
272 OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */
273 OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */
274 OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */
275 OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */
276 OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */
277 OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */
278 OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */
279 OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */
280 OVS_KEY_ATTR_ND, /* struct ovs_key_nd */
281 OVS_KEY_ATTR_TUN_ID = 63, /* be64 tunnel ID */
285 #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
288 * enum ovs_frag_type - IPv4 and IPv6 fragment type
289 * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
290 * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
291 * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
293 * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
303 #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
305 struct ovs_key_ethernet {
310 struct ovs_key_ipv4 {
316 __u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */
319 struct ovs_key_ipv6 {
322 __be32 ipv6_label; /* 20-bits in least-significant bits. */
326 __u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */
339 struct ovs_key_icmp {
344 struct ovs_key_icmpv6 {
364 * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
365 * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
366 * key. Always present in notifications. Required for all requests (except
368 * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
369 * the actions to take for packets that match the key. Always present in
370 * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional for
371 * %OVS_FLOW_CMD_SET requests.
372 * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
373 * flow. Present in notifications if the stats would be nonzero. Ignored in
375 * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
376 * TCP flags seen on packets in this flow. Only present in notifications for
377 * TCP flows, and only if it would be nonzero. Ignored in requests.
378 * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
379 * the system monotonic clock, at which a packet was last processed for this
380 * flow. Only present in notifications if a packet has been processed for this
381 * flow. Ignored in requests.
382 * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
383 * last-used time, accumulated TCP flags, and statistics for this flow.
384 * Otherwise ignored in requests. Never present in notifications.
386 * These attributes follow the &struct ovs_header within the Generic Netlink
387 * payload for %OVS_FLOW_* commands.
390 OVS_FLOW_ATTR_UNSPEC,
391 OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */
392 OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
393 OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */
394 OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
395 OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */
396 OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */
400 #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
403 * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
404 * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
405 * @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of
406 * %UINT32_MAX samples all packets and intermediate values sample intermediate
407 * fractions of packets.
408 * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
409 * Actions are passed as nested attributes.
411 * Executes the specified actions with the given probability on a per-packet
414 enum ovs_sample_attr {
415 OVS_SAMPLE_ATTR_UNSPEC,
416 OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
417 OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
418 __OVS_SAMPLE_ATTR_MAX,
421 #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
424 * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
425 * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
426 * message should be sent. Required.
427 * @OVS_USERSPACE_ATTR_USERDATA: If present, its u64 argument is copied to the
428 * %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA,
430 enum ovs_userspace_attr {
431 OVS_USERSPACE_ATTR_UNSPEC,
432 OVS_USERSPACE_ATTR_PID, /* u32 Netlink PID to receive upcalls. */
433 OVS_USERSPACE_ATTR_USERDATA, /* u64 optional user-specified cookie. */
434 __OVS_USERSPACE_ATTR_MAX
437 #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
440 * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument.
441 * @vlan_tpid: Tag protocol identifier (TPID) to push.
442 * @vlan_tci: Tag control identifier (TCI) to push. The CFI bit must be set
443 * (but it will not be set in the 802.1Q header that is pushed).
445 * The @vlan_tpid value is typically %ETH_P_8021Q. The only acceptable TPID
446 * values are those that the kernel module also parses as 802.1Q headers, to
447 * prevent %OVS_ACTION_ATTR_PUSH_VLAN followed by %OVS_ACTION_ATTR_POP_VLAN
448 * from having surprising results.
450 struct ovs_action_push_vlan {
451 __be16 vlan_tpid; /* 802.1Q TPID. */
452 __be16 vlan_tci; /* 802.1Q TCI (VLAN ID and priority). */
456 * enum ovs_action_attr - Action types.
458 * @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
459 * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
460 * %OVS_USERSPACE_ATTR_* attributes.
461 * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header. The
462 * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its
464 * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q header onto the
466 * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q header off the packet.
467 * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
468 * the nested %OVS_SAMPLE_ATTR_* attributes.
470 * Only a single header can be set with a single %OVS_ACTION_ATTR_SET. Not all
471 * fields within a header are modifiable, e.g. the IPv4 protocol and fragment
472 * type may not be changed.
475 enum ovs_action_attr {
476 OVS_ACTION_ATTR_UNSPEC,
477 OVS_ACTION_ATTR_OUTPUT, /* u32 port number. */
478 OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */
479 OVS_ACTION_ATTR_SET, /* One nested OVS_KEY_ATTR_*. */
480 OVS_ACTION_ATTR_PUSH_VLAN, /* struct ovs_action_push_vlan. */
481 OVS_ACTION_ATTR_POP_VLAN, /* No argument. */
482 OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */
483 __OVS_ACTION_ATTR_MAX
486 #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
488 #endif /* _LINUX_OPENVSWITCH_H */