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>
23 #include <linux/if_ether.h>
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).
30 * Attributes following the header are specific to a particular OVS Generic
31 * Netlink family, but all of the OVS families use this header.
40 #define OVS_DATAPATH_FAMILY "ovs_datapath"
41 #define OVS_DATAPATH_MCGROUP "ovs_datapath"
42 #define OVS_DATAPATH_VERSION 0x1
44 enum ovs_datapath_cmd {
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
63 * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the
64 * datapath. Always present in notifications.
66 * These attributes follow the &struct ovs_header within the Generic Netlink
67 * payload for %OVS_DP_* commands.
69 enum ovs_datapath_attr {
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 */
77 #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
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 */
86 struct 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 */
97 /* Fixed logical ports. */
98 #define OVSP_LOCAL ((__u32)0)
100 /* Packet transfer. */
102 #define OVS_PACKET_FAMILY "ovs_packet"
103 #define OVS_PACKET_VERSION 0x1
105 enum ovs_packet_cmd {
106 OVS_PACKET_CMD_UNSPEC,
108 /* Kernel-to-user notifications. */
109 OVS_PACKET_CMD_MISS, /* Flow table miss. */
110 OVS_PACKET_CMD_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */
112 /* Userspace commands. */
113 OVS_PACKET_CMD_EXECUTE /* Apply actions to a packet. */
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
134 * These attributes follow the &struct ovs_header within the Generic Netlink
135 * payload for %OVS_PACKET_* commands.
137 enum 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
146 #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
150 #define OVS_VPORT_FAMILY "ovs_vport"
151 #define OVS_VPORT_MCGROUP "ovs_vport"
152 #define OVS_VPORT_VERSION 0x1
155 OVS_VPORT_CMD_UNSPEC,
162 enum 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 */
169 #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
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
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.
186 * These attributes follow the &struct ovs_header within the Generic Netlink
187 * payload for %OVS_VPORT_* commands.
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
194 * and other attributes are ignored.
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.
200 enum 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 */
211 #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
215 #define OVS_FLOW_FAMILY "ovs_flow"
216 #define OVS_FLOW_MCGROUP "ovs_flow"
217 #define OVS_FLOW_VERSION 0x1
227 struct ovs_flow_stats {
228 __u64 n_packets; /* Number of matched packets. */
229 __u64 n_bytes; /* Number of matched bytes. */
234 OVS_KEY_ATTR_ENCAP, /* Nested set of encapsulated attributes. */
235 OVS_KEY_ATTR_PRIORITY, /* u32 skb->priority */
236 OVS_KEY_ATTR_IN_PORT, /* u32 OVS dp port number */
237 OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */
238 OVS_KEY_ATTR_VLAN, /* be16 VLAN TCI */
239 OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */
240 OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */
241 OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */
242 OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */
243 OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */
244 OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */
245 OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */
246 OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */
247 OVS_KEY_ATTR_ND, /* struct ovs_key_nd */
248 OVS_KEY_ATTR_SKB_MARK, /* u32 skb mark */
252 #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
255 * enum ovs_frag_type - IPv4 and IPv6 fragment type
256 * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
257 * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
258 * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
260 * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
270 #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
272 struct ovs_key_ethernet {
273 __u8 eth_src[ETH_ALEN];
274 __u8 eth_dst[ETH_ALEN];
277 struct ovs_key_ipv4 {
283 __u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */
286 struct ovs_key_ipv6 {
289 __be32 ipv6_label; /* 20-bits in least-significant bits. */
293 __u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */
306 struct ovs_key_icmp {
311 struct ovs_key_icmpv6 {
320 __u8 arp_sha[ETH_ALEN];
321 __u8 arp_tha[ETH_ALEN];
326 __u8 nd_sll[ETH_ALEN];
327 __u8 nd_tll[ETH_ALEN];
331 * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
332 * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
333 * key. Always present in notifications. Required for all requests (except
335 * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
336 * the actions to take for packets that match the key. Always present in
337 * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional for
338 * %OVS_FLOW_CMD_SET requests.
339 * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
340 * flow. Present in notifications if the stats would be nonzero. Ignored in
342 * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
343 * TCP flags seen on packets in this flow. Only present in notifications for
344 * TCP flows, and only if it would be nonzero. Ignored in requests.
345 * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
346 * the system monotonic clock, at which a packet was last processed for this
347 * flow. Only present in notifications if a packet has been processed for this
348 * flow. Ignored in requests.
349 * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
350 * last-used time, accumulated TCP flags, and statistics for this flow.
351 * Otherwise ignored in requests. Never present in notifications.
353 * These attributes follow the &struct ovs_header within the Generic Netlink
354 * payload for %OVS_FLOW_* commands.
357 OVS_FLOW_ATTR_UNSPEC,
358 OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */
359 OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
360 OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */
361 OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
362 OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */
363 OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */
367 #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
370 * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
371 * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
372 * @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of
373 * %UINT32_MAX samples all packets and intermediate values sample intermediate
374 * fractions of packets.
375 * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
376 * Actions are passed as nested attributes.
378 * Executes the specified actions with the given probability on a per-packet
381 enum ovs_sample_attr {
382 OVS_SAMPLE_ATTR_UNSPEC,
383 OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
384 OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
385 __OVS_SAMPLE_ATTR_MAX,
388 #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
391 * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
392 * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
393 * message should be sent. Required.
394 * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is
395 * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA.
397 enum ovs_userspace_attr {
398 OVS_USERSPACE_ATTR_UNSPEC,
399 OVS_USERSPACE_ATTR_PID, /* u32 Netlink PID to receive upcalls. */
400 OVS_USERSPACE_ATTR_USERDATA, /* Optional user-specified cookie. */
401 __OVS_USERSPACE_ATTR_MAX
404 #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
407 * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument.
408 * @vlan_tpid: Tag protocol identifier (TPID) to push.
409 * @vlan_tci: Tag control identifier (TCI) to push. The CFI bit must be set
410 * (but it will not be set in the 802.1Q header that is pushed).
412 * The @vlan_tpid value is typically %ETH_P_8021Q. The only acceptable TPID
413 * values are those that the kernel module also parses as 802.1Q headers, to
414 * prevent %OVS_ACTION_ATTR_PUSH_VLAN followed by %OVS_ACTION_ATTR_POP_VLAN
415 * from having surprising results.
417 struct ovs_action_push_vlan {
418 __be16 vlan_tpid; /* 802.1Q TPID. */
419 __be16 vlan_tci; /* 802.1Q TCI (VLAN ID and priority). */
423 * enum ovs_action_attr - Action types.
425 * @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
426 * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
427 * %OVS_USERSPACE_ATTR_* attributes.
428 * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header. The
429 * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its
431 * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q header onto the
433 * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q header off the packet.
434 * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
435 * the nested %OVS_SAMPLE_ATTR_* attributes.
437 * Only a single header can be set with a single %OVS_ACTION_ATTR_SET. Not all
438 * fields within a header are modifiable, e.g. the IPv4 protocol and fragment
439 * type may not be changed.
442 enum ovs_action_attr {
443 OVS_ACTION_ATTR_UNSPEC,
444 OVS_ACTION_ATTR_OUTPUT, /* u32 port number. */
445 OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */
446 OVS_ACTION_ATTR_SET, /* One nested OVS_KEY_ATTR_*. */
447 OVS_ACTION_ATTR_PUSH_VLAN, /* struct ovs_action_push_vlan. */
448 OVS_ACTION_ATTR_POP_VLAN, /* No argument. */
449 OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */
450 __OVS_ACTION_ATTR_MAX
453 #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
455 #endif /* _LINUX_OPENVSWITCH_H */