09c26b56f9fcdd700d33d920a70ec5ff675d37d2
[sliver-openvswitch.git] / include / linux / openvswitch.h
1 /*
2  * Copyright (c) 2007-2013 Nicira, Inc.
3  *
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
9  * license.
10  *
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:
15  *
16  *     http://www.apache.org/licenses/LICENSE-2.0
17  *
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.
27  *
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.
32  *
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
36  * 02110-1301, USA
37  * ----------------------------------------------------------------------
38  */
39
40 #ifndef _LINUX_OPENVSWITCH_H
41 #define _LINUX_OPENVSWITCH_H 1
42
43 #include <linux/types.h>
44 #include <linux/if_ether.h>
45
46 /**
47  * struct ovs_header - header for OVS Generic Netlink messages.
48  * @dp_ifindex: ifindex of local port for datapath (0 to make a request not
49  * specific to a datapath).
50  *
51  * Attributes following the header are specific to a particular OVS Generic
52  * Netlink family, but all of the OVS families use this header.
53  */
54
55 struct ovs_header {
56         int dp_ifindex;
57 };
58
59 /* Datapaths. */
60
61 #define OVS_DATAPATH_FAMILY  "ovs_datapath"
62 #define OVS_DATAPATH_MCGROUP "ovs_datapath"
63 #define OVS_DATAPATH_VERSION 0x1
64
65 enum ovs_datapath_cmd {
66         OVS_DP_CMD_UNSPEC,
67         OVS_DP_CMD_NEW,
68         OVS_DP_CMD_DEL,
69         OVS_DP_CMD_GET,
70         OVS_DP_CMD_SET
71 };
72
73 /**
74  * enum ovs_datapath_attr - attributes for %OVS_DP_* commands.
75  * @OVS_DP_ATTR_NAME: Name of the network device that serves as the "local
76  * port".  This is the name of the network device whose dp_ifindex is given in
77  * the &struct ovs_header.  Always present in notifications.  Required in
78  * %OVS_DP_NEW requests.  May be used as an alternative to specifying
79  * dp_ifindex in other requests (with a dp_ifindex of 0).
80  * @OVS_DP_ATTR_UPCALL_PID: The Netlink socket in userspace that is initially
81  * set on the datapath port (for OVS_ACTION_ATTR_MISS).  Only valid on
82  * %OVS_DP_CMD_NEW requests. A value of zero indicates that upcalls should
83  * not be sent.
84  * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the
85  * datapath.  Always present in notifications.
86  *
87  * These attributes follow the &struct ovs_header within the Generic Netlink
88  * payload for %OVS_DP_* commands.
89  */
90 enum ovs_datapath_attr {
91         OVS_DP_ATTR_UNSPEC,
92         OVS_DP_ATTR_NAME,       /* name of dp_ifindex netdev */
93         OVS_DP_ATTR_UPCALL_PID, /* Netlink PID to receive upcalls */
94         OVS_DP_ATTR_STATS,      /* struct ovs_dp_stats */
95         __OVS_DP_ATTR_MAX
96 };
97
98 #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
99
100 struct ovs_dp_stats {
101         __u64 n_hit;             /* Number of flow table matches. */
102         __u64 n_missed;          /* Number of flow table misses. */
103         __u64 n_lost;            /* Number of misses not sent to userspace. */
104         __u64 n_flows;           /* Number of flows present */
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 /* Fixed logical ports. */
119 #define OVSP_LOCAL      ((__u32)0)
120
121 /* Packet transfer. */
122
123 #define OVS_PACKET_FAMILY "ovs_packet"
124 #define OVS_PACKET_VERSION 0x1
125
126 enum ovs_packet_cmd {
127         OVS_PACKET_CMD_UNSPEC,
128
129         /* Kernel-to-user notifications. */
130         OVS_PACKET_CMD_MISS,    /* Flow table miss. */
131         OVS_PACKET_CMD_ACTION,  /* OVS_ACTION_ATTR_USERSPACE action. */
132
133         /* Userspace commands. */
134         OVS_PACKET_CMD_EXECUTE  /* Apply actions to a packet. */
135 };
136
137 /**
138  * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
139  * @OVS_PACKET_ATTR_PACKET: Present for all notifications.  Contains the entire
140  * packet as received, from the start of the Ethernet header onward.  For
141  * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
142  * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
143  * the flow key extracted from the packet as originally received.
144  * @OVS_PACKET_ATTR_KEY: Present for all notifications.  Contains the flow key
145  * extracted from the packet as nested %OVS_KEY_ATTR_* attributes.  This allows
146  * userspace to adapt its flow setup strategy by comparing its notion of the
147  * flow key against the kernel's.
148  * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet.  Used
149  * for %OVS_PACKET_CMD_EXECUTE.  It has nested %OVS_ACTION_ATTR_* attributes.
150  * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
151  * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
152  * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content
153  * specified there.
154  *
155  * These attributes follow the &struct ovs_header within the Generic Netlink
156  * payload for %OVS_PACKET_* commands.
157  */
158 enum ovs_packet_attr {
159         OVS_PACKET_ATTR_UNSPEC,
160         OVS_PACKET_ATTR_PACKET,      /* Packet data. */
161         OVS_PACKET_ATTR_KEY,         /* Nested OVS_KEY_ATTR_* attributes. */
162         OVS_PACKET_ATTR_ACTIONS,     /* Nested OVS_ACTION_ATTR_* attributes. */
163         OVS_PACKET_ATTR_USERDATA,    /* OVS_ACTION_ATTR_USERSPACE arg. */
164         __OVS_PACKET_ATTR_MAX
165 };
166
167 #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
168
169 /* Virtual ports. */
170
171 #define OVS_VPORT_FAMILY  "ovs_vport"
172 #define OVS_VPORT_MCGROUP "ovs_vport"
173 #define OVS_VPORT_VERSION 0x1
174
175 enum ovs_vport_cmd {
176         OVS_VPORT_CMD_UNSPEC,
177         OVS_VPORT_CMD_NEW,
178         OVS_VPORT_CMD_DEL,
179         OVS_VPORT_CMD_GET,
180         OVS_VPORT_CMD_SET
181 };
182
183 enum ovs_vport_type {
184         OVS_VPORT_TYPE_UNSPEC,
185         OVS_VPORT_TYPE_NETDEV,   /* network device */
186         OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
187         OVS_VPORT_TYPE_GRE,      /* GRE tunnel. */
188         OVS_VPORT_TYPE_VXLAN,    /* VXLAN tunnel */
189         OVS_VPORT_TYPE_GRE64 = 104, /* GRE tunnel with 64-bit keys */
190         OVS_VPORT_TYPE_LISP = 105,  /* LISP tunnel */
191         __OVS_VPORT_TYPE_MAX
192 };
193
194 #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
195
196 /**
197  * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
198  * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
199  * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
200  * of vport.
201  * @OVS_VPORT_ATTR_NAME: Name of vport.  For a vport based on a network device
202  * this is the name of the network device.  Maximum length %IFNAMSIZ-1 bytes
203  * plus a null terminator.
204  * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information.
205  * @OVS_VPORT_ATTR_UPCALL_PID: The Netlink socket in userspace that
206  * OVS_PACKET_CMD_MISS upcalls will be directed to for packets received on
207  * this port.  A value of zero indicates that upcalls should not be sent.
208  * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
209  * packets sent or received through the vport.
210  *
211  * These attributes follow the &struct ovs_header within the Generic Netlink
212  * payload for %OVS_VPORT_* commands.
213  *
214  * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
215  * %OVS_VPORT_ATTR_NAME attributes are required.  %OVS_VPORT_ATTR_PORT_NO is
216  * optional; if not specified a free port number is automatically selected.
217  * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
218  * of vport.  %OVS_VPORT_ATTR_STATS is optional and other attributes are
219  * ignored.
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
287 #ifdef __KERNEL__
288         OVS_KEY_ATTR_IPV4_TUNNEL,  /* struct ovs_key_ipv4_tunnel */
289 #endif
290
291         OVS_KEY_ATTR_MPLS = 62, /* array of struct ovs_key_mpls.
292                                  * The implementation may restrict
293                                  * the accepted length of the array. */
294         __OVS_KEY_ATTR_MAX
295 };
296
297 #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
298
299 enum ovs_tunnel_key_attr {
300         OVS_TUNNEL_KEY_ATTR_ID,                 /* be64 Tunnel ID */
301         OVS_TUNNEL_KEY_ATTR_IPV4_SRC,           /* be32 src IP address. */
302         OVS_TUNNEL_KEY_ATTR_IPV4_DST,           /* be32 dst IP address. */
303         OVS_TUNNEL_KEY_ATTR_TOS,                /* u8 Tunnel IP ToS. */
304         OVS_TUNNEL_KEY_ATTR_TTL,                /* u8 Tunnel IP TTL. */
305         OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT,      /* No argument, set DF. */
306         OVS_TUNNEL_KEY_ATTR_CSUM,               /* No argument. CSUM packet. */
307         __OVS_TUNNEL_KEY_ATTR_MAX
308 };
309
310 #define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1)
311
312 /**
313  * enum ovs_frag_type - IPv4 and IPv6 fragment type
314  * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
315  * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
316  * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
317  *
318  * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
319  * ovs_key_ipv6.
320  */
321 enum ovs_frag_type {
322         OVS_FRAG_TYPE_NONE,
323         OVS_FRAG_TYPE_FIRST,
324         OVS_FRAG_TYPE_LATER,
325         __OVS_FRAG_TYPE_MAX
326 };
327
328 #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
329
330 struct ovs_key_ethernet {
331         __u8     eth_src[ETH_ALEN];
332         __u8     eth_dst[ETH_ALEN];
333 };
334
335 struct ovs_key_mpls {
336         __be32 mpls_lse;
337 };
338
339 struct ovs_key_ipv4 {
340         __be32 ipv4_src;
341         __be32 ipv4_dst;
342         __u8   ipv4_proto;
343         __u8   ipv4_tos;
344         __u8   ipv4_ttl;
345         __u8   ipv4_frag;       /* One of OVS_FRAG_TYPE_*. */
346 };
347
348 struct ovs_key_ipv6 {
349         __be32 ipv6_src[4];
350         __be32 ipv6_dst[4];
351         __be32 ipv6_label;      /* 20-bits in least-significant bits. */
352         __u8   ipv6_proto;
353         __u8   ipv6_tclass;
354         __u8   ipv6_hlimit;
355         __u8   ipv6_frag;       /* One of OVS_FRAG_TYPE_*. */
356 };
357
358 struct ovs_key_tcp {
359         __be16 tcp_src;
360         __be16 tcp_dst;
361 };
362
363 struct ovs_key_udp {
364         __be16 udp_src;
365         __be16 udp_dst;
366 };
367
368 struct ovs_key_sctp {
369         __be16 sctp_src;
370         __be16 sctp_dst;
371 };
372
373 struct ovs_key_icmp {
374         __u8 icmp_type;
375         __u8 icmp_code;
376 };
377
378 struct ovs_key_icmpv6 {
379         __u8 icmpv6_type;
380         __u8 icmpv6_code;
381 };
382
383 struct ovs_key_arp {
384         __be32 arp_sip;
385         __be32 arp_tip;
386         __be16 arp_op;
387         __u8   arp_sha[ETH_ALEN];
388         __u8   arp_tha[ETH_ALEN];
389 };
390
391 struct ovs_key_nd {
392         __u32 nd_target[4];
393         __u8  nd_sll[ETH_ALEN];
394         __u8  nd_tll[ETH_ALEN];
395 };
396
397 /**
398  * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
399  * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
400  * key.  Always present in notifications.  Required for all requests (except
401  * dumps).
402  * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
403  * the actions to take for packets that match the key.  Always present in
404  * notifications.  Required for %OVS_FLOW_CMD_NEW requests, optional for
405  * %OVS_FLOW_CMD_SET requests.
406  * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
407  * flow.  Present in notifications if the stats would be nonzero.  Ignored in
408  * requests.
409  * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
410  * TCP flags seen on packets in this flow.  Only present in notifications for
411  * TCP flows, and only if it would be nonzero.  Ignored in requests.
412  * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
413  * the system monotonic clock, at which a packet was last processed for this
414  * flow.  Only present in notifications if a packet has been processed for this
415  * flow.  Ignored in requests.
416  * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
417  * last-used time, accumulated TCP flags, and statistics for this flow.
418  * Otherwise ignored in requests.  Never present in notifications.
419  * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the
420  * mask bits for wildcarded flow match. Mask bit value '1' specifies exact
421  * match with corresponding flow key bit, while mask bit value '0' specifies
422  * a wildcarded match. Omitting attribute is treated as wildcarding all
423  * corresponding fields. Optional for all requests. If not present,
424  * all flow key bits are exact match bits.
425  *
426  * These attributes follow the &struct ovs_header within the Generic Netlink
427  * payload for %OVS_FLOW_* commands.
428  */
429 enum ovs_flow_attr {
430         OVS_FLOW_ATTR_UNSPEC,
431         OVS_FLOW_ATTR_KEY,       /* Sequence of OVS_KEY_ATTR_* attributes. */
432         OVS_FLOW_ATTR_ACTIONS,   /* Nested OVS_ACTION_ATTR_* attributes. */
433         OVS_FLOW_ATTR_STATS,     /* struct ovs_flow_stats. */
434         OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
435         OVS_FLOW_ATTR_USED,      /* u64 msecs last used in monotonic time. */
436         OVS_FLOW_ATTR_CLEAR,     /* Flag to clear stats, tcp_flags, used. */
437         OVS_FLOW_ATTR_MASK,      /* Sequence of OVS_KEY_ATTR_* attributes. */
438         __OVS_FLOW_ATTR_MAX
439 };
440
441 #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
442
443 /**
444  * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
445  * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
446  * @OVS_ACTION_ATTR_SAMPLE.  A value of 0 samples no packets, a value of
447  * %UINT32_MAX samples all packets and intermediate values sample intermediate
448  * fractions of packets.
449  * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
450  * Actions are passed as nested attributes.
451  *
452  * Executes the specified actions with the given probability on a per-packet
453  * basis.
454  */
455 enum ovs_sample_attr {
456         OVS_SAMPLE_ATTR_UNSPEC,
457         OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
458         OVS_SAMPLE_ATTR_ACTIONS,     /* Nested OVS_ACTION_ATTR_* attributes. */
459         __OVS_SAMPLE_ATTR_MAX,
460 };
461
462 #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
463
464 /**
465  * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
466  * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
467  * message should be sent.  Required.
468  * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is
469  * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA.
470  */
471 enum ovs_userspace_attr {
472         OVS_USERSPACE_ATTR_UNSPEC,
473         OVS_USERSPACE_ATTR_PID,       /* u32 Netlink PID to receive upcalls. */
474         OVS_USERSPACE_ATTR_USERDATA,  /* Optional user-specified cookie. */
475         __OVS_USERSPACE_ATTR_MAX
476 };
477
478 #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
479
480 /**
481  * struct ovs_action_push_mpls - %OVS_ACTION_ATTR_PUSH_MPLS action argument.
482  * @mpls_lse: MPLS label stack entry to push.
483  * @mpls_ethertype: Ethertype to set in the encapsulating ethernet frame.
484  *
485  * The only values @mpls_ethertype should ever be given are %ETH_P_MPLS_UC and
486  * %ETH_P_MPLS_MC, indicating MPLS unicast or multicast. Other are rejected.
487  */
488 struct ovs_action_push_mpls {
489         __be32 mpls_lse;
490         __be16 mpls_ethertype; /* Either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC */
491 };
492
493 /**
494  * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument.
495  * @vlan_tpid: Tag protocol identifier (TPID) to push.
496  * @vlan_tci: Tag control identifier (TCI) to push.  The CFI bit must be set
497  * (but it will not be set in the 802.1Q header that is pushed).
498  *
499  * The @vlan_tpid value is typically %ETH_P_8021Q.  The only acceptable TPID
500  * values are those that the kernel module also parses as 802.1Q headers, to
501  * prevent %OVS_ACTION_ATTR_PUSH_VLAN followed by %OVS_ACTION_ATTR_POP_VLAN
502  * from having surprising results.
503  */
504 struct ovs_action_push_vlan {
505         __be16 vlan_tpid;       /* 802.1Q TPID. */
506         __be16 vlan_tci;        /* 802.1Q TCI (VLAN ID and priority). */
507 };
508
509 /**
510  * enum ovs_action_attr - Action types.
511  *
512  * @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
513  * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
514  * %OVS_USERSPACE_ATTR_* attributes.
515  * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q header onto the
516  * packet.
517  * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q header off the packet.
518  * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
519  * the nested %OVS_SAMPLE_ATTR_* attributes.
520  * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header.  The
521  * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its
522  * value.
523  * @OVS_ACTION_ATTR_PUSH_MPLS: Push a new MPLS label stack entry onto the
524  * top of the packets MPLS label stack. Set the ethertype of the
525  * encapsulating frame to either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC to
526  * indicate the new packet contents.
527  * @OVS_ACTION_ATTR_POP_MPLS: Pop an MPLS label stack entry off of the
528  * packet's MPLS label stack.  Set the encapsulating frame's ethertype to
529  * indicate the new packet contents This could potentially still be
530  * %ETH_P_MPLS_* if the resulting MPLS label stack is not empty.  If there
531  * is no MPLS label stack, as determined by ethertype, no action is taken.
532  *
533  * Only a single header can be set with a single %OVS_ACTION_ATTR_SET.  Not all
534  * fields within a header are modifiable, e.g. the IPv4 protocol and fragment
535  * type may not be changed.
536  */
537
538 enum ovs_action_attr {
539         OVS_ACTION_ATTR_UNSPEC,
540         OVS_ACTION_ATTR_OUTPUT,       /* u32 port number. */
541         OVS_ACTION_ATTR_USERSPACE,    /* Nested OVS_USERSPACE_ATTR_*. */
542         OVS_ACTION_ATTR_SET,          /* One nested OVS_KEY_ATTR_*. */
543         OVS_ACTION_ATTR_PUSH_VLAN,    /* struct ovs_action_push_vlan. */
544         OVS_ACTION_ATTR_POP_VLAN,     /* No argument. */
545         OVS_ACTION_ATTR_SAMPLE,       /* Nested OVS_SAMPLE_ATTR_*. */
546         OVS_ACTION_ATTR_PUSH_MPLS,    /* struct ovs_action_push_mpls. */
547         OVS_ACTION_ATTR_POP_MPLS,     /* __be16 ethertype. */
548         __OVS_ACTION_ATTR_MAX
549 };
550
551 #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
552
553 #endif /* _LINUX_OPENVSWITCH_H */