blob: f7fc507d82ab31a71ed0e0932ac513f3639fc09f [file] [log] [blame]
Thomas Graf22e38802013-03-29 14:46:52 +01001
2/*
Andy Zhou03f0d912013-08-07 20:01:00 -07003 * Copyright (c) 2007-2013 Nicira, Inc.
Thomas Graf22e38802013-03-29 14:46:52 +01004 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of version 2 of the GNU General Public
7 * License as published by the Free Software Foundation.
8 *
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17 * 02110-1301, USA
18 */
19
20#ifndef _UAPI__LINUX_OPENVSWITCH_H
21#define _UAPI__LINUX_OPENVSWITCH_H 1
22
23#include <linux/types.h>
24#include <linux/if_ether.h>
25
26/**
27 * struct ovs_header - header for OVS Generic Netlink messages.
28 * @dp_ifindex: ifindex of local port for datapath (0 to make a request not
29 * specific to a datapath).
30 *
31 * Attributes following the header are specific to a particular OVS Generic
32 * Netlink family, but all of the OVS families use this header.
33 */
34
35struct ovs_header {
36 int dp_ifindex;
37};
38
39/* Datapaths. */
40
41#define OVS_DATAPATH_FAMILY "ovs_datapath"
42#define OVS_DATAPATH_MCGROUP "ovs_datapath"
Thomas Graf44da5ae2013-12-13 15:22:19 +010043
44/* V2:
45 * - API users are expected to provide OVS_DP_ATTR_USER_FEATURES
46 * when creating the datapath.
47 */
48#define OVS_DATAPATH_VERSION 2
49
50/* First OVS datapath version to support features */
51#define OVS_DP_VER_FEATURES 2
Thomas Graf22e38802013-03-29 14:46:52 +010052
53enum ovs_datapath_cmd {
54 OVS_DP_CMD_UNSPEC,
55 OVS_DP_CMD_NEW,
56 OVS_DP_CMD_DEL,
57 OVS_DP_CMD_GET,
58 OVS_DP_CMD_SET
59};
60
61/**
62 * enum ovs_datapath_attr - attributes for %OVS_DP_* commands.
63 * @OVS_DP_ATTR_NAME: Name of the network device that serves as the "local
64 * port". This is the name of the network device whose dp_ifindex is given in
65 * the &struct ovs_header. Always present in notifications. Required in
66 * %OVS_DP_NEW requests. May be used as an alternative to specifying
67 * dp_ifindex in other requests (with a dp_ifindex of 0).
68 * @OVS_DP_ATTR_UPCALL_PID: The Netlink socket in userspace that is initially
69 * set on the datapath port (for OVS_ACTION_ATTR_MISS). Only valid on
70 * %OVS_DP_CMD_NEW requests. A value of zero indicates that upcalls should
71 * not be sent.
72 * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the
73 * datapath. Always present in notifications.
Andy Zhou1bd71162013-10-22 10:42:46 -070074 * @OVS_DP_ATTR_MEGAFLOW_STATS: Statistics about mega flow masks usage for the
75 * datapath. Always present in notifications.
Thomas Graf22e38802013-03-29 14:46:52 +010076 *
77 * These attributes follow the &struct ovs_header within the Generic Netlink
78 * payload for %OVS_DP_* commands.
79 */
80enum ovs_datapath_attr {
81 OVS_DP_ATTR_UNSPEC,
Andy Zhou1bd71162013-10-22 10:42:46 -070082 OVS_DP_ATTR_NAME, /* name of dp_ifindex netdev */
83 OVS_DP_ATTR_UPCALL_PID, /* Netlink PID to receive upcalls */
84 OVS_DP_ATTR_STATS, /* struct ovs_dp_stats */
85 OVS_DP_ATTR_MEGAFLOW_STATS, /* struct ovs_dp_megaflow_stats */
Thomas Graf43d4be92013-12-13 15:22:18 +010086 OVS_DP_ATTR_USER_FEATURES, /* OVS_DP_F_* */
Thomas Graf22e38802013-03-29 14:46:52 +010087 __OVS_DP_ATTR_MAX
88};
89
90#define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
91
92struct ovs_dp_stats {
93 __u64 n_hit; /* Number of flow table matches. */
94 __u64 n_missed; /* Number of flow table misses. */
95 __u64 n_lost; /* Number of misses not sent to userspace. */
96 __u64 n_flows; /* Number of flows present */
97};
98
Andy Zhou1bd71162013-10-22 10:42:46 -070099struct ovs_dp_megaflow_stats {
100 __u64 n_mask_hit; /* Number of masks used for flow lookups. */
101 __u32 n_masks; /* Number of masks for the datapath. */
102 __u32 pad0; /* Pad for future expension. */
103 __u64 pad1; /* Pad for future expension. */
104 __u64 pad2; /* Pad for future expension. */
105};
106
Thomas Graf22e38802013-03-29 14:46:52 +0100107struct ovs_vport_stats {
108 __u64 rx_packets; /* total packets received */
109 __u64 tx_packets; /* total packets transmitted */
110 __u64 rx_bytes; /* total bytes received */
111 __u64 tx_bytes; /* total bytes transmitted */
112 __u64 rx_errors; /* bad packets received */
113 __u64 tx_errors; /* packet transmit problems */
114 __u64 rx_dropped; /* no space in linux buffers */
115 __u64 tx_dropped; /* no space available in linux */
116};
117
Thomas Graf43d4be92013-12-13 15:22:18 +0100118/* Allow last Netlink attribute to be unaligned */
119#define OVS_DP_F_UNALIGNED (1 << 0)
120
Alex Wang5cd667b2014-07-17 15:14:13 -0700121/* Allow datapath to associate multiple Netlink PIDs to each vport */
122#define OVS_DP_F_VPORT_PIDS (1 << 1)
123
Thomas Graf22e38802013-03-29 14:46:52 +0100124/* Fixed logical ports. */
125#define OVSP_LOCAL ((__u32)0)
126
127/* Packet transfer. */
128
129#define OVS_PACKET_FAMILY "ovs_packet"
130#define OVS_PACKET_VERSION 0x1
131
132enum ovs_packet_cmd {
133 OVS_PACKET_CMD_UNSPEC,
134
135 /* Kernel-to-user notifications. */
136 OVS_PACKET_CMD_MISS, /* Flow table miss. */
137 OVS_PACKET_CMD_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */
138
139 /* Userspace commands. */
140 OVS_PACKET_CMD_EXECUTE /* Apply actions to a packet. */
141};
142
143/**
144 * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
145 * @OVS_PACKET_ATTR_PACKET: Present for all notifications. Contains the entire
146 * packet as received, from the start of the Ethernet header onward. For
147 * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
148 * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
149 * the flow key extracted from the packet as originally received.
150 * @OVS_PACKET_ATTR_KEY: Present for all notifications. Contains the flow key
151 * extracted from the packet as nested %OVS_KEY_ATTR_* attributes. This allows
152 * userspace to adapt its flow setup strategy by comparing its notion of the
153 * flow key against the kernel's.
154 * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet. Used
155 * for %OVS_PACKET_CMD_EXECUTE. It has nested %OVS_ACTION_ATTR_* attributes.
156 * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
157 * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
158 * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content
159 * specified there.
160 *
161 * These attributes follow the &struct ovs_header within the Generic Netlink
162 * payload for %OVS_PACKET_* commands.
163 */
164enum ovs_packet_attr {
165 OVS_PACKET_ATTR_UNSPEC,
166 OVS_PACKET_ATTR_PACKET, /* Packet data. */
167 OVS_PACKET_ATTR_KEY, /* Nested OVS_KEY_ATTR_* attributes. */
168 OVS_PACKET_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
169 OVS_PACKET_ATTR_USERDATA, /* OVS_ACTION_ATTR_USERSPACE arg. */
170 __OVS_PACKET_ATTR_MAX
171};
172
173#define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
174
175/* Virtual ports. */
176
177#define OVS_VPORT_FAMILY "ovs_vport"
178#define OVS_VPORT_MCGROUP "ovs_vport"
179#define OVS_VPORT_VERSION 0x1
180
181enum ovs_vport_cmd {
182 OVS_VPORT_CMD_UNSPEC,
183 OVS_VPORT_CMD_NEW,
184 OVS_VPORT_CMD_DEL,
185 OVS_VPORT_CMD_GET,
186 OVS_VPORT_CMD_SET
187};
188
189enum ovs_vport_type {
190 OVS_VPORT_TYPE_UNSPEC,
191 OVS_VPORT_TYPE_NETDEV, /* network device */
192 OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
Pravin B Shelaraa310702013-06-17 17:50:33 -0700193 OVS_VPORT_TYPE_GRE, /* GRE tunnel. */
Pravin B Shelar58264842013-08-19 11:23:34 -0700194 OVS_VPORT_TYPE_VXLAN, /* VXLAN tunnel. */
Thomas Graf22e38802013-03-29 14:46:52 +0100195 __OVS_VPORT_TYPE_MAX
196};
197
198#define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
199
200/**
201 * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
202 * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
203 * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
204 * of vport.
205 * @OVS_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device
206 * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes
207 * plus a null terminator.
208 * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information.
Alex Wang5cd667b2014-07-17 15:14:13 -0700209 * @OVS_VPORT_ATTR_UPCALL_PID: The array of Netlink socket pids in userspace
210 * among which OVS_PACKET_CMD_MISS upcalls will be distributed for packets
211 * received on this port. If this is a single-element array of value 0,
212 * upcalls should not be sent.
Thomas Graf22e38802013-03-29 14:46:52 +0100213 * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
214 * packets sent or received through the vport.
215 *
216 * These attributes follow the &struct ovs_header within the Generic Netlink
217 * payload for %OVS_VPORT_* commands.
218 *
219 * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
220 * %OVS_VPORT_ATTR_NAME attributes are required. %OVS_VPORT_ATTR_PORT_NO is
221 * optional; if not specified a free port number is automatically selected.
222 * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
223 * of vport.
Thomas Graf22e38802013-03-29 14:46:52 +0100224 *
225 * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
226 * look up the vport to operate on; otherwise dp_idx from the &struct
227 * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
228 */
229enum ovs_vport_attr {
230 OVS_VPORT_ATTR_UNSPEC,
231 OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */
232 OVS_VPORT_ATTR_TYPE, /* u32 OVS_VPORT_TYPE_* constant. */
233 OVS_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */
234 OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
Alex Wang5cd667b2014-07-17 15:14:13 -0700235 OVS_VPORT_ATTR_UPCALL_PID, /* array of u32 Netlink socket PIDs for */
236 /* receiving upcalls */
Thomas Graf22e38802013-03-29 14:46:52 +0100237 OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */
238 __OVS_VPORT_ATTR_MAX
239};
240
241#define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
242
Pravin B Shelar58264842013-08-19 11:23:34 -0700243/* OVS_VPORT_ATTR_OPTIONS attributes for tunnels.
244 */
245enum {
246 OVS_TUNNEL_ATTR_UNSPEC,
247 OVS_TUNNEL_ATTR_DST_PORT, /* 16-bit UDP port, used by L4 tunnels. */
248 __OVS_TUNNEL_ATTR_MAX
249};
250
251#define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1)
252
Thomas Graf22e38802013-03-29 14:46:52 +0100253/* Flows. */
254
255#define OVS_FLOW_FAMILY "ovs_flow"
256#define OVS_FLOW_MCGROUP "ovs_flow"
257#define OVS_FLOW_VERSION 0x1
258
259enum ovs_flow_cmd {
260 OVS_FLOW_CMD_UNSPEC,
261 OVS_FLOW_CMD_NEW,
262 OVS_FLOW_CMD_DEL,
263 OVS_FLOW_CMD_GET,
264 OVS_FLOW_CMD_SET
265};
266
267struct ovs_flow_stats {
268 __u64 n_packets; /* Number of matched packets. */
269 __u64 n_bytes; /* Number of matched bytes. */
270};
271
272enum ovs_key_attr {
273 OVS_KEY_ATTR_UNSPEC,
274 OVS_KEY_ATTR_ENCAP, /* Nested set of encapsulated attributes. */
275 OVS_KEY_ATTR_PRIORITY, /* u32 skb->priority */
276 OVS_KEY_ATTR_IN_PORT, /* u32 OVS dp port number */
277 OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */
278 OVS_KEY_ATTR_VLAN, /* be16 VLAN TCI */
279 OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */
280 OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */
281 OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */
282 OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */
283 OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */
284 OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */
285 OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */
286 OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */
287 OVS_KEY_ATTR_ND, /* struct ovs_key_nd */
288 OVS_KEY_ATTR_SKB_MARK, /* u32 skb mark */
Pravin B Shelar7d5437c2013-06-17 17:50:18 -0700289 OVS_KEY_ATTR_TUNNEL, /* Nested set of ovs_tunnel attributes */
Joe Stringera175a722013-08-22 12:30:48 -0700290 OVS_KEY_ATTR_SCTP, /* struct ovs_key_sctp */
Jarno Rajahalme5eb26b12013-10-23 01:44:59 -0700291 OVS_KEY_ATTR_TCP_FLAGS, /* be16 TCP flags. */
Andy Zhou971427f32014-09-15 19:37:25 -0700292 OVS_KEY_ATTR_DP_HASH, /* u32 hash value. Value 0 indicates the hash
293 is not computed by the datapath. */
294 OVS_KEY_ATTR_RECIRC_ID, /* u32 recirc id */
Pravin B Shelar7d5437c2013-06-17 17:50:18 -0700295
296#ifdef __KERNEL__
297 OVS_KEY_ATTR_IPV4_TUNNEL, /* struct ovs_key_ipv4_tunnel */
298#endif
Thomas Graf22e38802013-03-29 14:46:52 +0100299 __OVS_KEY_ATTR_MAX
300};
301
302#define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
303
Pravin B Shelar7d5437c2013-06-17 17:50:18 -0700304enum ovs_tunnel_key_attr {
305 OVS_TUNNEL_KEY_ATTR_ID, /* be64 Tunnel ID */
306 OVS_TUNNEL_KEY_ATTR_IPV4_SRC, /* be32 src IP address. */
307 OVS_TUNNEL_KEY_ATTR_IPV4_DST, /* be32 dst IP address. */
308 OVS_TUNNEL_KEY_ATTR_TOS, /* u8 Tunnel IP ToS. */
309 OVS_TUNNEL_KEY_ATTR_TTL, /* u8 Tunnel IP TTL. */
310 OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT, /* No argument, set DF. */
311 OVS_TUNNEL_KEY_ATTR_CSUM, /* No argument. CSUM packet. */
312 __OVS_TUNNEL_KEY_ATTR_MAX
313};
314
315#define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1)
316
Thomas Graf22e38802013-03-29 14:46:52 +0100317/**
318 * enum ovs_frag_type - IPv4 and IPv6 fragment type
319 * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
320 * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
321 * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
322 *
323 * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
324 * ovs_key_ipv6.
325 */
326enum ovs_frag_type {
327 OVS_FRAG_TYPE_NONE,
328 OVS_FRAG_TYPE_FIRST,
329 OVS_FRAG_TYPE_LATER,
330 __OVS_FRAG_TYPE_MAX
331};
332
333#define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
334
335struct ovs_key_ethernet {
336 __u8 eth_src[ETH_ALEN];
337 __u8 eth_dst[ETH_ALEN];
338};
339
340struct ovs_key_ipv4 {
341 __be32 ipv4_src;
342 __be32 ipv4_dst;
343 __u8 ipv4_proto;
344 __u8 ipv4_tos;
345 __u8 ipv4_ttl;
346 __u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */
347};
348
349struct ovs_key_ipv6 {
350 __be32 ipv6_src[4];
351 __be32 ipv6_dst[4];
352 __be32 ipv6_label; /* 20-bits in least-significant bits. */
353 __u8 ipv6_proto;
354 __u8 ipv6_tclass;
355 __u8 ipv6_hlimit;
356 __u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */
357};
358
359struct ovs_key_tcp {
360 __be16 tcp_src;
361 __be16 tcp_dst;
362};
363
364struct ovs_key_udp {
365 __be16 udp_src;
366 __be16 udp_dst;
367};
368
Joe Stringera175a722013-08-22 12:30:48 -0700369struct ovs_key_sctp {
370 __be16 sctp_src;
371 __be16 sctp_dst;
372};
373
Thomas Graf22e38802013-03-29 14:46:52 +0100374struct ovs_key_icmp {
375 __u8 icmp_type;
376 __u8 icmp_code;
377};
378
379struct ovs_key_icmpv6 {
380 __u8 icmpv6_type;
381 __u8 icmpv6_code;
382};
383
384struct ovs_key_arp {
385 __be32 arp_sip;
386 __be32 arp_tip;
387 __be16 arp_op;
388 __u8 arp_sha[ETH_ALEN];
389 __u8 arp_tha[ETH_ALEN];
390};
391
392struct ovs_key_nd {
393 __u32 nd_target[4];
394 __u8 nd_sll[ETH_ALEN];
395 __u8 nd_tll[ETH_ALEN];
396};
397
398/**
399 * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
400 * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
401 * key. Always present in notifications. Required for all requests (except
402 * dumps).
403 * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
404 * the actions to take for packets that match the key. Always present in
405 * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional for
Jarno Rajahalmebe52c9e2014-05-05 09:59:40 -0700406 * %OVS_FLOW_CMD_SET requests. An %OVS_FLOW_CMD_SET without
407 * %OVS_FLOW_ATTR_ACTIONS will not modify the actions. To clear the actions,
408 * an %OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given.
Thomas Graf22e38802013-03-29 14:46:52 +0100409 * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
410 * flow. Present in notifications if the stats would be nonzero. Ignored in
411 * requests.
412 * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
413 * TCP flags seen on packets in this flow. Only present in notifications for
414 * TCP flows, and only if it would be nonzero. Ignored in requests.
415 * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
416 * the system monotonic clock, at which a packet was last processed for this
417 * flow. Only present in notifications if a packet has been processed for this
418 * flow. Ignored in requests.
419 * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
420 * last-used time, accumulated TCP flags, and statistics for this flow.
421 * Otherwise ignored in requests. Never present in notifications.
Andy Zhou03f0d912013-08-07 20:01:00 -0700422 * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the
423 * mask bits for wildcarded flow match. Mask bit value '1' specifies exact
424 * match with corresponding flow key bit, while mask bit value '0' specifies
425 * a wildcarded match. Omitting attribute is treated as wildcarding all
426 * corresponding fields. Optional for all requests. If not present,
427 * all flow key bits are exact match bits.
Thomas Graf22e38802013-03-29 14:46:52 +0100428 *
429 * These attributes follow the &struct ovs_header within the Generic Netlink
430 * payload for %OVS_FLOW_* commands.
431 */
432enum ovs_flow_attr {
433 OVS_FLOW_ATTR_UNSPEC,
434 OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */
435 OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
436 OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */
437 OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
438 OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */
439 OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */
Andy Zhou03f0d912013-08-07 20:01:00 -0700440 OVS_FLOW_ATTR_MASK, /* Sequence of OVS_KEY_ATTR_* attributes. */
Thomas Graf22e38802013-03-29 14:46:52 +0100441 __OVS_FLOW_ATTR_MAX
442};
443
444#define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
445
446/**
447 * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
448 * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
449 * @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of
450 * %UINT32_MAX samples all packets and intermediate values sample intermediate
451 * fractions of packets.
452 * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
453 * Actions are passed as nested attributes.
454 *
455 * Executes the specified actions with the given probability on a per-packet
456 * basis.
457 */
458enum ovs_sample_attr {
459 OVS_SAMPLE_ATTR_UNSPEC,
460 OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
461 OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
462 __OVS_SAMPLE_ATTR_MAX,
463};
464
465#define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
466
467/**
468 * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
469 * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
470 * message should be sent. Required.
471 * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is
472 * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA.
473 */
474enum ovs_userspace_attr {
475 OVS_USERSPACE_ATTR_UNSPEC,
476 OVS_USERSPACE_ATTR_PID, /* u32 Netlink PID to receive upcalls. */
477 OVS_USERSPACE_ATTR_USERDATA, /* Optional user-specified cookie. */
478 __OVS_USERSPACE_ATTR_MAX
479};
480
481#define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
482
483/**
484 * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument.
485 * @vlan_tpid: Tag protocol identifier (TPID) to push.
486 * @vlan_tci: Tag control identifier (TCI) to push. The CFI bit must be set
487 * (but it will not be set in the 802.1Q header that is pushed).
488 *
489 * The @vlan_tpid value is typically %ETH_P_8021Q. The only acceptable TPID
490 * values are those that the kernel module also parses as 802.1Q headers, to
491 * prevent %OVS_ACTION_ATTR_PUSH_VLAN followed by %OVS_ACTION_ATTR_POP_VLAN
492 * from having surprising results.
493 */
494struct ovs_action_push_vlan {
495 __be16 vlan_tpid; /* 802.1Q TPID. */
496 __be16 vlan_tci; /* 802.1Q TCI (VLAN ID and priority). */
497};
498
Andy Zhou971427f32014-09-15 19:37:25 -0700499/* Data path hash algorithm for computing Datapath hash.
500 *
501 * The algorithm type only specifies the fields in a flow
502 * will be used as part of the hash. Each datapath is free
503 * to use its own hash algorithm. The hash value will be
504 * opaque to the user space daemon.
505 */
506enum ovs_hash_alg {
507 OVS_HASH_ALG_L4,
508};
509
510/*
511 * struct ovs_action_hash - %OVS_ACTION_ATTR_HASH action argument.
512 * @hash_alg: Algorithm used to compute hash prior to recirculation.
513 * @hash_basis: basis used for computing hash.
514 */
515struct ovs_action_hash {
516 uint32_t hash_alg; /* One of ovs_hash_alg. */
517 uint32_t hash_basis;
518};
519
Thomas Graf22e38802013-03-29 14:46:52 +0100520/**
521 * enum ovs_action_attr - Action types.
522 *
523 * @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
524 * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
525 * %OVS_USERSPACE_ATTR_* attributes.
526 * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header. The
527 * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its
528 * value.
529 * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q header onto the
530 * packet.
531 * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q header off the packet.
532 * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
533 * the nested %OVS_SAMPLE_ATTR_* attributes.
534 *
535 * Only a single header can be set with a single %OVS_ACTION_ATTR_SET. Not all
536 * fields within a header are modifiable, e.g. the IPv4 protocol and fragment
537 * type may not be changed.
538 */
539
540enum ovs_action_attr {
541 OVS_ACTION_ATTR_UNSPEC,
542 OVS_ACTION_ATTR_OUTPUT, /* u32 port number. */
543 OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */
544 OVS_ACTION_ATTR_SET, /* One nested OVS_KEY_ATTR_*. */
545 OVS_ACTION_ATTR_PUSH_VLAN, /* struct ovs_action_push_vlan. */
546 OVS_ACTION_ATTR_POP_VLAN, /* No argument. */
547 OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */
Andy Zhou971427f32014-09-15 19:37:25 -0700548 OVS_ACTION_ATTR_RECIRC, /* u32 recirc_id. */
549 OVS_ACTION_ATTR_HASH, /* struct ovs_action_hash. */
Thomas Graf22e38802013-03-29 14:46:52 +0100550 __OVS_ACTION_ATTR_MAX
551};
552
553#define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
554
555#endif /* _LINUX_OPENVSWITCH_H */