]> Pileus Git - ~andy/linux/blob - include/uapi/linux/openvswitch.h
Merge branch 'master' of git://git.kernel.org/pub/scm/linux/kernel/git/klassert/ipsec...
[~andy/linux] / include / uapi / linux / openvswitch.h
1
2 /*
3  * Copyright (c) 2007-2013 Nicira, Inc.
4  *
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
35 struct 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"
43
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
52
53 enum 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.
74  * @OVS_DP_ATTR_MEGAFLOW_STATS: Statistics about mega flow masks usage for the
75  * datapath. Always present in notifications.
76  *
77  * These attributes follow the &struct ovs_header within the Generic Netlink
78  * payload for %OVS_DP_* commands.
79  */
80 enum ovs_datapath_attr {
81         OVS_DP_ATTR_UNSPEC,
82         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 */
86         OVS_DP_ATTR_USER_FEATURES,      /* OVS_DP_F_*  */
87         __OVS_DP_ATTR_MAX
88 };
89
90 #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
91
92 struct 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
99 struct 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
107 struct 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
118 /* Allow last Netlink attribute to be unaligned */
119 #define OVS_DP_F_UNALIGNED      (1 << 0)
120
121 /* Fixed logical ports. */
122 #define OVSP_LOCAL      ((__u32)0)
123
124 /* Packet transfer. */
125
126 #define OVS_PACKET_FAMILY "ovs_packet"
127 #define OVS_PACKET_VERSION 0x1
128
129 enum ovs_packet_cmd {
130         OVS_PACKET_CMD_UNSPEC,
131
132         /* Kernel-to-user notifications. */
133         OVS_PACKET_CMD_MISS,    /* Flow table miss. */
134         OVS_PACKET_CMD_ACTION,  /* OVS_ACTION_ATTR_USERSPACE action. */
135
136         /* Userspace commands. */
137         OVS_PACKET_CMD_EXECUTE  /* Apply actions to a packet. */
138 };
139
140 /**
141  * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
142  * @OVS_PACKET_ATTR_PACKET: Present for all notifications.  Contains the entire
143  * packet as received, from the start of the Ethernet header onward.  For
144  * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
145  * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
146  * the flow key extracted from the packet as originally received.
147  * @OVS_PACKET_ATTR_KEY: Present for all notifications.  Contains the flow key
148  * extracted from the packet as nested %OVS_KEY_ATTR_* attributes.  This allows
149  * userspace to adapt its flow setup strategy by comparing its notion of the
150  * flow key against the kernel's.
151  * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet.  Used
152  * for %OVS_PACKET_CMD_EXECUTE.  It has nested %OVS_ACTION_ATTR_* attributes.
153  * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
154  * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
155  * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content
156  * specified there.
157  *
158  * These attributes follow the &struct ovs_header within the Generic Netlink
159  * payload for %OVS_PACKET_* commands.
160  */
161 enum ovs_packet_attr {
162         OVS_PACKET_ATTR_UNSPEC,
163         OVS_PACKET_ATTR_PACKET,      /* Packet data. */
164         OVS_PACKET_ATTR_KEY,         /* Nested OVS_KEY_ATTR_* attributes. */
165         OVS_PACKET_ATTR_ACTIONS,     /* Nested OVS_ACTION_ATTR_* attributes. */
166         OVS_PACKET_ATTR_USERDATA,    /* OVS_ACTION_ATTR_USERSPACE arg. */
167         __OVS_PACKET_ATTR_MAX
168 };
169
170 #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
171
172 /* Virtual ports. */
173
174 #define OVS_VPORT_FAMILY  "ovs_vport"
175 #define OVS_VPORT_MCGROUP "ovs_vport"
176 #define OVS_VPORT_VERSION 0x1
177
178 enum ovs_vport_cmd {
179         OVS_VPORT_CMD_UNSPEC,
180         OVS_VPORT_CMD_NEW,
181         OVS_VPORT_CMD_DEL,
182         OVS_VPORT_CMD_GET,
183         OVS_VPORT_CMD_SET
184 };
185
186 enum ovs_vport_type {
187         OVS_VPORT_TYPE_UNSPEC,
188         OVS_VPORT_TYPE_NETDEV,   /* network device */
189         OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
190         OVS_VPORT_TYPE_GRE,      /* GRE tunnel. */
191         OVS_VPORT_TYPE_VXLAN,    /* VXLAN tunnel. */
192         __OVS_VPORT_TYPE_MAX
193 };
194
195 #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
196
197 /**
198  * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
199  * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
200  * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
201  * of vport.
202  * @OVS_VPORT_ATTR_NAME: Name of vport.  For a vport based on a network device
203  * this is the name of the network device.  Maximum length %IFNAMSIZ-1 bytes
204  * plus a null terminator.
205  * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information.
206  * @OVS_VPORT_ATTR_UPCALL_PID: The Netlink socket in userspace that
207  * OVS_PACKET_CMD_MISS upcalls will be directed to for packets received on
208  * this port.  A value of zero indicates that upcalls should not be sent.
209  * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
210  * packets sent or received through the vport.
211  *
212  * These attributes follow the &struct ovs_header within the Generic Netlink
213  * payload for %OVS_VPORT_* commands.
214  *
215  * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
216  * %OVS_VPORT_ATTR_NAME attributes are required.  %OVS_VPORT_ATTR_PORT_NO is
217  * optional; if not specified a free port number is automatically selected.
218  * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
219  * of vport.
220  *
221  * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
222  * look up the vport to operate on; otherwise dp_idx from the &struct
223  * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
224  */
225 enum ovs_vport_attr {
226         OVS_VPORT_ATTR_UNSPEC,
227         OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */
228         OVS_VPORT_ATTR_TYPE,    /* u32 OVS_VPORT_TYPE_* constant. */
229         OVS_VPORT_ATTR_NAME,    /* string name, up to IFNAMSIZ bytes long */
230         OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
231         OVS_VPORT_ATTR_UPCALL_PID, /* u32 Netlink PID to receive upcalls */
232         OVS_VPORT_ATTR_STATS,   /* struct ovs_vport_stats */
233         __OVS_VPORT_ATTR_MAX
234 };
235
236 #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
237
238 /* OVS_VPORT_ATTR_OPTIONS attributes for tunnels.
239  */
240 enum {
241         OVS_TUNNEL_ATTR_UNSPEC,
242         OVS_TUNNEL_ATTR_DST_PORT, /* 16-bit UDP port, used by L4 tunnels. */
243         __OVS_TUNNEL_ATTR_MAX
244 };
245
246 #define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1)
247
248 /* Flows. */
249
250 #define OVS_FLOW_FAMILY  "ovs_flow"
251 #define OVS_FLOW_MCGROUP "ovs_flow"
252 #define OVS_FLOW_VERSION 0x1
253
254 enum ovs_flow_cmd {
255         OVS_FLOW_CMD_UNSPEC,
256         OVS_FLOW_CMD_NEW,
257         OVS_FLOW_CMD_DEL,
258         OVS_FLOW_CMD_GET,
259         OVS_FLOW_CMD_SET
260 };
261
262 struct ovs_flow_stats {
263         __u64 n_packets;         /* Number of matched packets. */
264         __u64 n_bytes;           /* Number of matched bytes. */
265 };
266
267 enum ovs_key_attr {
268         OVS_KEY_ATTR_UNSPEC,
269         OVS_KEY_ATTR_ENCAP,     /* Nested set of encapsulated attributes. */
270         OVS_KEY_ATTR_PRIORITY,  /* u32 skb->priority */
271         OVS_KEY_ATTR_IN_PORT,   /* u32 OVS dp port number */
272         OVS_KEY_ATTR_ETHERNET,  /* struct ovs_key_ethernet */
273         OVS_KEY_ATTR_VLAN,      /* be16 VLAN TCI */
274         OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */
275         OVS_KEY_ATTR_IPV4,      /* struct ovs_key_ipv4 */
276         OVS_KEY_ATTR_IPV6,      /* struct ovs_key_ipv6 */
277         OVS_KEY_ATTR_TCP,       /* struct ovs_key_tcp */
278         OVS_KEY_ATTR_UDP,       /* struct ovs_key_udp */
279         OVS_KEY_ATTR_ICMP,      /* struct ovs_key_icmp */
280         OVS_KEY_ATTR_ICMPV6,    /* struct ovs_key_icmpv6 */
281         OVS_KEY_ATTR_ARP,       /* struct ovs_key_arp */
282         OVS_KEY_ATTR_ND,        /* struct ovs_key_nd */
283         OVS_KEY_ATTR_SKB_MARK,  /* u32 skb mark */
284         OVS_KEY_ATTR_TUNNEL,    /* Nested set of ovs_tunnel attributes */
285         OVS_KEY_ATTR_SCTP,      /* struct ovs_key_sctp */
286         OVS_KEY_ATTR_TCP_FLAGS, /* be16 TCP flags. */
287
288 #ifdef __KERNEL__
289         OVS_KEY_ATTR_IPV4_TUNNEL,  /* struct ovs_key_ipv4_tunnel */
290 #endif
291         __OVS_KEY_ATTR_MAX
292 };
293
294 #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
295
296 enum ovs_tunnel_key_attr {
297         OVS_TUNNEL_KEY_ATTR_ID,                 /* be64 Tunnel ID */
298         OVS_TUNNEL_KEY_ATTR_IPV4_SRC,           /* be32 src IP address. */
299         OVS_TUNNEL_KEY_ATTR_IPV4_DST,           /* be32 dst IP address. */
300         OVS_TUNNEL_KEY_ATTR_TOS,                /* u8 Tunnel IP ToS. */
301         OVS_TUNNEL_KEY_ATTR_TTL,                /* u8 Tunnel IP TTL. */
302         OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT,      /* No argument, set DF. */
303         OVS_TUNNEL_KEY_ATTR_CSUM,               /* No argument. CSUM packet. */
304         __OVS_TUNNEL_KEY_ATTR_MAX
305 };
306
307 #define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1)
308
309 /**
310  * enum ovs_frag_type - IPv4 and IPv6 fragment type
311  * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
312  * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
313  * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
314  *
315  * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
316  * ovs_key_ipv6.
317  */
318 enum ovs_frag_type {
319         OVS_FRAG_TYPE_NONE,
320         OVS_FRAG_TYPE_FIRST,
321         OVS_FRAG_TYPE_LATER,
322         __OVS_FRAG_TYPE_MAX
323 };
324
325 #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
326
327 struct ovs_key_ethernet {
328         __u8     eth_src[ETH_ALEN];
329         __u8     eth_dst[ETH_ALEN];
330 };
331
332 struct ovs_key_ipv4 {
333         __be32 ipv4_src;
334         __be32 ipv4_dst;
335         __u8   ipv4_proto;
336         __u8   ipv4_tos;
337         __u8   ipv4_ttl;
338         __u8   ipv4_frag;       /* One of OVS_FRAG_TYPE_*. */
339 };
340
341 struct ovs_key_ipv6 {
342         __be32 ipv6_src[4];
343         __be32 ipv6_dst[4];
344         __be32 ipv6_label;      /* 20-bits in least-significant bits. */
345         __u8   ipv6_proto;
346         __u8   ipv6_tclass;
347         __u8   ipv6_hlimit;
348         __u8   ipv6_frag;       /* One of OVS_FRAG_TYPE_*. */
349 };
350
351 struct ovs_key_tcp {
352         __be16 tcp_src;
353         __be16 tcp_dst;
354 };
355
356 struct ovs_key_udp {
357         __be16 udp_src;
358         __be16 udp_dst;
359 };
360
361 struct ovs_key_sctp {
362         __be16 sctp_src;
363         __be16 sctp_dst;
364 };
365
366 struct ovs_key_icmp {
367         __u8 icmp_type;
368         __u8 icmp_code;
369 };
370
371 struct ovs_key_icmpv6 {
372         __u8 icmpv6_type;
373         __u8 icmpv6_code;
374 };
375
376 struct ovs_key_arp {
377         __be32 arp_sip;
378         __be32 arp_tip;
379         __be16 arp_op;
380         __u8   arp_sha[ETH_ALEN];
381         __u8   arp_tha[ETH_ALEN];
382 };
383
384 struct ovs_key_nd {
385         __u32 nd_target[4];
386         __u8  nd_sll[ETH_ALEN];
387         __u8  nd_tll[ETH_ALEN];
388 };
389
390 /**
391  * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
392  * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
393  * key.  Always present in notifications.  Required for all requests (except
394  * dumps).
395  * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
396  * the actions to take for packets that match the key.  Always present in
397  * notifications.  Required for %OVS_FLOW_CMD_NEW requests, optional for
398  * %OVS_FLOW_CMD_SET requests.
399  * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
400  * flow.  Present in notifications if the stats would be nonzero.  Ignored in
401  * requests.
402  * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
403  * TCP flags seen on packets in this flow.  Only present in notifications for
404  * TCP flows, and only if it would be nonzero.  Ignored in requests.
405  * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
406  * the system monotonic clock, at which a packet was last processed for this
407  * flow.  Only present in notifications if a packet has been processed for this
408  * flow.  Ignored in requests.
409  * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
410  * last-used time, accumulated TCP flags, and statistics for this flow.
411  * Otherwise ignored in requests.  Never present in notifications.
412  * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the
413  * mask bits for wildcarded flow match. Mask bit value '1' specifies exact
414  * match with corresponding flow key bit, while mask bit value '0' specifies
415  * a wildcarded match. Omitting attribute is treated as wildcarding all
416  * corresponding fields. Optional for all requests. If not present,
417  * all flow key bits are exact match bits.
418  *
419  * These attributes follow the &struct ovs_header within the Generic Netlink
420  * payload for %OVS_FLOW_* commands.
421  */
422 enum ovs_flow_attr {
423         OVS_FLOW_ATTR_UNSPEC,
424         OVS_FLOW_ATTR_KEY,       /* Sequence of OVS_KEY_ATTR_* attributes. */
425         OVS_FLOW_ATTR_ACTIONS,   /* Nested OVS_ACTION_ATTR_* attributes. */
426         OVS_FLOW_ATTR_STATS,     /* struct ovs_flow_stats. */
427         OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
428         OVS_FLOW_ATTR_USED,      /* u64 msecs last used in monotonic time. */
429         OVS_FLOW_ATTR_CLEAR,     /* Flag to clear stats, tcp_flags, used. */
430         OVS_FLOW_ATTR_MASK,      /* Sequence of OVS_KEY_ATTR_* attributes. */
431         __OVS_FLOW_ATTR_MAX
432 };
433
434 #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
435
436 /**
437  * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
438  * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
439  * @OVS_ACTION_ATTR_SAMPLE.  A value of 0 samples no packets, a value of
440  * %UINT32_MAX samples all packets and intermediate values sample intermediate
441  * fractions of packets.
442  * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
443  * Actions are passed as nested attributes.
444  *
445  * Executes the specified actions with the given probability on a per-packet
446  * basis.
447  */
448 enum ovs_sample_attr {
449         OVS_SAMPLE_ATTR_UNSPEC,
450         OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
451         OVS_SAMPLE_ATTR_ACTIONS,     /* Nested OVS_ACTION_ATTR_* attributes. */
452         __OVS_SAMPLE_ATTR_MAX,
453 };
454
455 #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
456
457 /**
458  * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
459  * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
460  * message should be sent.  Required.
461  * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is
462  * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA.
463  */
464 enum ovs_userspace_attr {
465         OVS_USERSPACE_ATTR_UNSPEC,
466         OVS_USERSPACE_ATTR_PID,       /* u32 Netlink PID to receive upcalls. */
467         OVS_USERSPACE_ATTR_USERDATA,  /* Optional user-specified cookie. */
468         __OVS_USERSPACE_ATTR_MAX
469 };
470
471 #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
472
473 /**
474  * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument.
475  * @vlan_tpid: Tag protocol identifier (TPID) to push.
476  * @vlan_tci: Tag control identifier (TCI) to push.  The CFI bit must be set
477  * (but it will not be set in the 802.1Q header that is pushed).
478  *
479  * The @vlan_tpid value is typically %ETH_P_8021Q.  The only acceptable TPID
480  * values are those that the kernel module also parses as 802.1Q headers, to
481  * prevent %OVS_ACTION_ATTR_PUSH_VLAN followed by %OVS_ACTION_ATTR_POP_VLAN
482  * from having surprising results.
483  */
484 struct ovs_action_push_vlan {
485         __be16 vlan_tpid;       /* 802.1Q TPID. */
486         __be16 vlan_tci;        /* 802.1Q TCI (VLAN ID and priority). */
487 };
488
489 /**
490  * enum ovs_action_attr - Action types.
491  *
492  * @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
493  * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
494  * %OVS_USERSPACE_ATTR_* attributes.
495  * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header.  The
496  * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its
497  * value.
498  * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q header onto the
499  * packet.
500  * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q header off the packet.
501  * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
502  * the nested %OVS_SAMPLE_ATTR_* attributes.
503  *
504  * Only a single header can be set with a single %OVS_ACTION_ATTR_SET.  Not all
505  * fields within a header are modifiable, e.g. the IPv4 protocol and fragment
506  * type may not be changed.
507  */
508
509 enum ovs_action_attr {
510         OVS_ACTION_ATTR_UNSPEC,
511         OVS_ACTION_ATTR_OUTPUT,       /* u32 port number. */
512         OVS_ACTION_ATTR_USERSPACE,    /* Nested OVS_USERSPACE_ATTR_*. */
513         OVS_ACTION_ATTR_SET,          /* One nested OVS_KEY_ATTR_*. */
514         OVS_ACTION_ATTR_PUSH_VLAN,    /* struct ovs_action_push_vlan. */
515         OVS_ACTION_ATTR_POP_VLAN,     /* No argument. */
516         OVS_ACTION_ATTR_SAMPLE,       /* Nested OVS_SAMPLE_ATTR_*. */
517         __OVS_ACTION_ATTR_MAX
518 };
519
520 #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
521
522 #endif /* _LINUX_OPENVSWITCH_H */