2 * Copyright (c) 2007-2011 Nicira Networks.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of version 2 of the GNU General Public
6 * License as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19 #ifndef _LINUX_OPENVSWITCH_H
20 #define _LINUX_OPENVSWITCH_H 1
22 #include <linux/types.h>
25 * struct ovs_header - header for OVS Generic Netlink messages.
26 * @dp_ifindex: ifindex of local port for datapath (0 to make a request not
27 * specific to a datapath).
29 * Attributes following the header are specific to a particular OVS Generic
30 * Netlink family, but all of the OVS families use this header.
39 #define OVS_DATAPATH_FAMILY "ovs_datapath"
40 #define OVS_DATAPATH_MCGROUP "ovs_datapath"
41 #define OVS_DATAPATH_VERSION 0x1
43 enum ovs_datapath_cmd {
52 * enum ovs_datapath_attr - attributes for %OVS_DP_* commands.
53 * @OVS_DP_ATTR_NAME: Name of the network device that serves as the "local
54 * port". This is the name of the network device whose dp_ifindex is given in
55 * the &struct ovs_header. Always present in notifications. Required in
56 * %OVS_DP_NEW requests. May be used as an alternative to specifying
57 * dp_ifindex in other requests (with a dp_ifindex of 0).
58 * @OVS_DP_ATTR_UPCALL_PID: The Netlink socket in userspace that is initially
59 * set on the datapath port (for OVS_ACTION_ATTR_MISS). Only valid on
60 * %OVS_DP_CMD_NEW requests. A value of zero indicates that upcalls should
62 * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the
63 * datapath. Always present in notifications.
65 * These attributes follow the &struct ovs_header within the Generic Netlink
66 * payload for %OVS_DP_* commands.
68 enum ovs_datapath_attr {
70 OVS_DP_ATTR_NAME, /* name of dp_ifindex netdev */
71 OVS_DP_ATTR_UPCALL_PID, /* Netlink PID to receive upcalls */
72 OVS_DP_ATTR_STATS, /* struct ovs_dp_stats */
76 #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
79 __u64 n_hit; /* Number of flow table matches. */
80 __u64 n_missed; /* Number of flow table misses. */
81 __u64 n_lost; /* Number of misses not sent to userspace. */
82 __u64 n_flows; /* Number of flows present */
85 struct ovs_vport_stats {
86 __u64 rx_packets; /* total packets received */
87 __u64 tx_packets; /* total packets transmitted */
88 __u64 rx_bytes; /* total bytes received */
89 __u64 tx_bytes; /* total bytes transmitted */
90 __u64 rx_errors; /* bad packets received */
91 __u64 tx_errors; /* packet transmit problems */
92 __u64 rx_dropped; /* no space in linux buffers */
93 __u64 tx_dropped; /* no space available in linux */
96 /* Fixed logical ports. */
97 #define OVSP_LOCAL ((__u32)0)
99 /* Packet transfer. */
101 #define OVS_PACKET_FAMILY "ovs_packet"
102 #define OVS_PACKET_VERSION 0x1
104 enum ovs_packet_cmd {
105 OVS_PACKET_CMD_UNSPEC,
107 /* Kernel-to-user notifications. */
108 OVS_PACKET_CMD_MISS, /* Flow table miss. */
109 OVS_PACKET_CMD_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */
111 /* Userspace commands. */
112 OVS_PACKET_CMD_EXECUTE /* Apply actions to a packet. */
116 * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
117 * @OVS_PACKET_ATTR_PACKET: Present for all notifications. Contains the entire
118 * packet as received, from the start of the Ethernet header onward. For
119 * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
120 * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
121 * the flow key extracted from the packet as originally received.
122 * @OVS_PACKET_ATTR_KEY: Present for all notifications. Contains the flow key
123 * extracted from the packet as nested %OVS_KEY_ATTR_* attributes. This allows
124 * userspace to adapt its flow setup strategy by comparing its notion of the
125 * flow key against the kernel's.
126 * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet. Used
127 * for %OVS_PACKET_CMD_EXECUTE. It has nested %OVS_ACTION_ATTR_* attributes.
128 * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
129 * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
130 * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content
133 * These attributes follow the &struct ovs_header within the Generic Netlink
134 * payload for %OVS_PACKET_* commands.
136 enum ovs_packet_attr {
137 OVS_PACKET_ATTR_UNSPEC,
138 OVS_PACKET_ATTR_PACKET, /* Packet data. */
139 OVS_PACKET_ATTR_KEY, /* Nested OVS_KEY_ATTR_* attributes. */
140 OVS_PACKET_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
141 OVS_PACKET_ATTR_USERDATA, /* OVS_ACTION_ATTR_USERSPACE arg. */
142 __OVS_PACKET_ATTR_MAX
145 #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
149 #define OVS_VPORT_FAMILY "ovs_vport"
150 #define OVS_VPORT_MCGROUP "ovs_vport"
151 #define OVS_VPORT_VERSION 0x1
154 OVS_VPORT_CMD_UNSPEC,
161 enum ovs_vport_type {
162 OVS_VPORT_TYPE_UNSPEC,
163 OVS_VPORT_TYPE_NETDEV, /* network device */
164 OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
168 #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
171 * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
172 * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
173 * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
175 * @OVS_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device
176 * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes
177 * plus a null terminator.
178 * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information.
179 * @OVS_VPORT_ATTR_UPCALL_PID: The Netlink socket in userspace that
180 * OVS_PACKET_CMD_MISS upcalls will be directed to for packets received on
181 * this port. A value of zero indicates that upcalls should not be sent.
182 * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
183 * packets sent or received through the vport.
185 * These attributes follow the &struct ovs_header within the Generic Netlink
186 * payload for %OVS_VPORT_* commands.
188 * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
189 * %OVS_VPORT_ATTR_NAME attributes are required. %OVS_VPORT_ATTR_PORT_NO is
190 * optional; if not specified a free port number is automatically selected.
191 * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
193 * and other attributes are ignored.
195 * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
196 * look up the vport to operate on; otherwise dp_idx from the &struct
197 * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
199 enum ovs_vport_attr {
200 OVS_VPORT_ATTR_UNSPEC,
201 OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */
202 OVS_VPORT_ATTR_TYPE, /* u32 OVS_VPORT_TYPE_* constant. */
203 OVS_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */
204 OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
205 OVS_VPORT_ATTR_UPCALL_PID, /* u32 Netlink PID to receive upcalls */
206 OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */
210 #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
214 #define OVS_FLOW_FAMILY "ovs_flow"
215 #define OVS_FLOW_MCGROUP "ovs_flow"
216 #define OVS_FLOW_VERSION 0x1
226 struct ovs_flow_stats {
227 __u64 n_packets; /* Number of matched packets. */
228 __u64 n_bytes; /* Number of matched bytes. */
233 OVS_KEY_ATTR_ENCAP, /* Nested set of encapsulated attributes. */
234 OVS_KEY_ATTR_PRIORITY, /* u32 skb->priority */
235 OVS_KEY_ATTR_IN_PORT, /* u32 OVS dp port number */
236 OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */
237 OVS_KEY_ATTR_VLAN, /* be16 VLAN TCI */
238 OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */
239 OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */
240 OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */
241 OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */
242 OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */
243 OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */
244 OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */
245 OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */
246 OVS_KEY_ATTR_ND, /* struct ovs_key_nd */
247 OVS_KEY_ATTR_SKB_MARK, /* u32 skb mark */
251 #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
254 * enum ovs_frag_type - IPv4 and IPv6 fragment type
255 * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
256 * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
257 * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
259 * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
269 #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
271 struct ovs_key_ethernet {
276 struct ovs_key_ipv4 {
282 __u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */
285 struct ovs_key_ipv6 {
288 __be32 ipv6_label; /* 20-bits in least-significant bits. */
292 __u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */
305 struct ovs_key_icmp {
310 struct ovs_key_icmpv6 {
330 * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
331 * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
332 * key. Always present in notifications. Required for all requests (except
334 * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
335 * the actions to take for packets that match the key. Always present in
336 * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional for
337 * %OVS_FLOW_CMD_SET requests.
338 * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
339 * flow. Present in notifications if the stats would be nonzero. Ignored in
341 * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
342 * TCP flags seen on packets in this flow. Only present in notifications for
343 * TCP flows, and only if it would be nonzero. Ignored in requests.
344 * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
345 * the system monotonic clock, at which a packet was last processed for this
346 * flow. Only present in notifications if a packet has been processed for this
347 * flow. Ignored in requests.
348 * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
349 * last-used time, accumulated TCP flags, and statistics for this flow.
350 * Otherwise ignored in requests. Never present in notifications.
352 * These attributes follow the &struct ovs_header within the Generic Netlink
353 * payload for %OVS_FLOW_* commands.
356 OVS_FLOW_ATTR_UNSPEC,
357 OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */
358 OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
359 OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */
360 OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
361 OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */
362 OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */
366 #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
369 * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
370 * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
371 * @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of
372 * %UINT32_MAX samples all packets and intermediate values sample intermediate
373 * fractions of packets.
374 * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
375 * Actions are passed as nested attributes.
377 * Executes the specified actions with the given probability on a per-packet
380 enum ovs_sample_attr {
381 OVS_SAMPLE_ATTR_UNSPEC,
382 OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
383 OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
384 __OVS_SAMPLE_ATTR_MAX,
387 #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
390 * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
391 * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
392 * message should be sent. Required.
393 * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is
394 * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA.
396 enum ovs_userspace_attr {
397 OVS_USERSPACE_ATTR_UNSPEC,
398 OVS_USERSPACE_ATTR_PID, /* u32 Netlink PID to receive upcalls. */
399 OVS_USERSPACE_ATTR_USERDATA, /* Optional user-specified cookie. */
400 __OVS_USERSPACE_ATTR_MAX
403 #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
406 * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument.
407 * @vlan_tpid: Tag protocol identifier (TPID) to push.
408 * @vlan_tci: Tag control identifier (TCI) to push. The CFI bit must be set
409 * (but it will not be set in the 802.1Q header that is pushed).
411 * The @vlan_tpid value is typically %ETH_P_8021Q. The only acceptable TPID
412 * values are those that the kernel module also parses as 802.1Q headers, to
413 * prevent %OVS_ACTION_ATTR_PUSH_VLAN followed by %OVS_ACTION_ATTR_POP_VLAN
414 * from having surprising results.
416 struct ovs_action_push_vlan {
417 __be16 vlan_tpid; /* 802.1Q TPID. */
418 __be16 vlan_tci; /* 802.1Q TCI (VLAN ID and priority). */
422 * enum ovs_action_attr - Action types.
424 * @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
425 * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
426 * %OVS_USERSPACE_ATTR_* attributes.
427 * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header. The
428 * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its
430 * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q header onto the
432 * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q header off the packet.
433 * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
434 * the nested %OVS_SAMPLE_ATTR_* attributes.
436 * Only a single header can be set with a single %OVS_ACTION_ATTR_SET. Not all
437 * fields within a header are modifiable, e.g. the IPv4 protocol and fragment
438 * type may not be changed.
441 enum ovs_action_attr {
442 OVS_ACTION_ATTR_UNSPEC,
443 OVS_ACTION_ATTR_OUTPUT, /* u32 port number. */
444 OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */
445 OVS_ACTION_ATTR_SET, /* One nested OVS_KEY_ATTR_*. */
446 OVS_ACTION_ATTR_PUSH_VLAN, /* struct ovs_action_push_vlan. */
447 OVS_ACTION_ATTR_POP_VLAN, /* No argument. */
448 OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */
449 __OVS_ACTION_ATTR_MAX
452 #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
454 #endif /* _LINUX_OPENVSWITCH_H */