]> git.proxmox.com Git - mirror_ovs.git/blame - datapath/linux/compat/include/linux/openvswitch.h
Support for match & set ICMPv6 reserved and options type fields
[mirror_ovs.git] / datapath / linux / compat / include / linux / openvswitch.h
CommitLineData
064af421 1/*
535e3acf 2 * Copyright (c) 2007-2017 Nicira, Inc.
064af421 3 *
a14bc59f
BP
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.
064af421 10 *
a14bc59f
BP
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 * ----------------------------------------------------------------------
a9a29d22
JG
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.
a14bc59f 27 *
a9a29d22
JG
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.
a14bc59f 32 *
a9a29d22
JG
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
a14bc59f 37 * ----------------------------------------------------------------------
064af421
BP
38 */
39
077257b8
BP
40#ifndef _LINUX_OPENVSWITCH_H
41#define _LINUX_OPENVSWITCH_H 1
064af421 42
064af421 43#include <linux/types.h>
d11dbe61 44#include <linux/if_ether.h>
9ea0bccc 45
def95ecd
JG
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
55struct ovs_header {
56 int dp_ifindex;
57};
58
59/* Datapaths. */
aaff4b55 60
df2c07f4
JP
61#define OVS_DATAPATH_FAMILY "ovs_datapath"
62#define OVS_DATAPATH_MCGROUP "ovs_datapath"
94358dcf
TG
63
64/* V2:
65 * - API users are expected to provide OVS_DP_ATTR_USER_FEATURES
66 * when creating the datapath.
67 */
68#define OVS_DATAPATH_VERSION 2
69
70/* First OVS datapath version to support features */
71#define OVS_DP_VER_FEATURES 2
df2c07f4
JP
72
73enum ovs_datapath_cmd {
74 OVS_DP_CMD_UNSPEC,
75 OVS_DP_CMD_NEW,
76 OVS_DP_CMD_DEL,
77 OVS_DP_CMD_GET,
78 OVS_DP_CMD_SET
aaff4b55 79};
064af421 80
d6569377 81/**
df2c07f4
JP
82 * enum ovs_datapath_attr - attributes for %OVS_DP_* commands.
83 * @OVS_DP_ATTR_NAME: Name of the network device that serves as the "local
254f2dc8 84 * port". This is the name of the network device whose dp_ifindex is given in
df2c07f4
JP
85 * the &struct ovs_header. Always present in notifications. Required in
86 * %OVS_DP_NEW requests. May be used as an alternative to specifying
254f2dc8 87 * dp_ifindex in other requests (with a dp_ifindex of 0).
b063d9f0
JG
88 * @OVS_DP_ATTR_UPCALL_PID: The Netlink socket in userspace that is initially
89 * set on the datapath port (for OVS_ACTION_ATTR_MISS). Only valid on
90 * %OVS_DP_CMD_NEW requests. A value of zero indicates that upcalls should
91 * not be sent.
df2c07f4 92 * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the
aaff4b55 93 * datapath. Always present in notifications.
4fa72a95
AZ
94 * @OVS_DP_ATTR_MEGAFLOW_STATS: Statistics about mega flow masks usage for the
95 * datapath. Always present in notifications.
d6569377 96 *
df2c07f4
JP
97 * These attributes follow the &struct ovs_header within the Generic Netlink
98 * payload for %OVS_DP_* commands.
d6569377 99 */
df2c07f4
JP
100enum ovs_datapath_attr {
101 OVS_DP_ATTR_UNSPEC,
4fa72a95
AZ
102 OVS_DP_ATTR_NAME, /* name of dp_ifindex netdev */
103 OVS_DP_ATTR_UPCALL_PID, /* Netlink PID to receive upcalls */
104 OVS_DP_ATTR_STATS, /* struct ovs_dp_stats */
105 OVS_DP_ATTR_MEGAFLOW_STATS, /* struct ovs_dp_megaflow_stats */
c58cc9a4 106 OVS_DP_ATTR_USER_FEATURES, /* OVS_DP_F_* */
91b37647 107 OVS_DP_ATTR_PAD,
df2c07f4 108 __OVS_DP_ATTR_MAX
d6569377
BP
109};
110
df2c07f4 111#define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
d6569377 112
01414567 113/* All 64-bit integers within Netlink messages are 4-byte aligned only. */
df2c07f4 114struct ovs_dp_stats {
def95ecd
JG
115 __u64 n_hit; /* Number of flow table matches. */
116 __u64 n_missed; /* Number of flow table misses. */
117 __u64 n_lost; /* Number of misses not sent to userspace. */
118 __u64 n_flows; /* Number of flows present */
064af421
BP
119};
120
4fa72a95
AZ
121struct ovs_dp_megaflow_stats {
122 __u64 n_mask_hit; /* Number of masks used for flow lookups. */
123 __u32 n_masks; /* Number of masks for the datapath. */
124 __u32 pad0; /* Pad for future expension. */
125 __u64 pad1; /* Pad for future expension. */
126 __u64 pad2; /* Pad for future expension. */
127};
128
f613a0d7 129struct ovs_vport_stats {
9ea0bccc
BP
130 __u64 rx_packets; /* total packets received */
131 __u64 tx_packets; /* total packets transmitted */
132 __u64 rx_bytes; /* total bytes received */
133 __u64 tx_bytes; /* total bytes transmitted */
134 __u64 rx_errors; /* bad packets received */
135 __u64 tx_errors; /* packet transmit problems */
136 __u64 rx_dropped; /* no space in linux buffers */
137 __u64 tx_dropped; /* no space available in linux */
f613a0d7
PS
138};
139
c58cc9a4
TG
140/* Allow last Netlink attribute to be unaligned */
141#define OVS_DP_F_UNALIGNED (1 << 0)
142
beb1c69a
AW
143/* Allow datapath to associate multiple Netlink PIDs to each vport */
144#define OVS_DP_F_VPORT_PIDS (1 << 1)
145
def95ecd 146/* Fixed logical ports. */
70fe217e 147#define OVSP_LOCAL ((__u32)0)
def95ecd
JG
148
149/* Packet transfer. */
150
df2c07f4 151#define OVS_PACKET_FAMILY "ovs_packet"
69685a88 152#define OVS_PACKET_VERSION 0x1
064af421 153
df2c07f4 154enum ovs_packet_cmd {
def95ecd 155 OVS_PACKET_CMD_UNSPEC,
064af421 156
def95ecd
JG
157 /* Kernel-to-user notifications. */
158 OVS_PACKET_CMD_MISS, /* Flow table miss. */
159 OVS_PACKET_CMD_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */
982b8810 160
def95ecd
JG
161 /* Userspace commands. */
162 OVS_PACKET_CMD_EXECUTE /* Apply actions to a packet. */
982b8810
BP
163};
164
165/**
df2c07f4
JP
166 * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
167 * @OVS_PACKET_ATTR_PACKET: Present for all notifications. Contains the entire
982b8810 168 * packet as received, from the start of the Ethernet header onward. For
df2c07f4
JP
169 * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
170 * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
7aec165d 171 * the flow key extracted from the packet as originally received.
df2c07f4
JP
172 * @OVS_PACKET_ATTR_KEY: Present for all notifications. Contains the flow key
173 * extracted from the packet as nested %OVS_KEY_ATTR_* attributes. This allows
982b8810 174 * userspace to adapt its flow setup strategy by comparing its notion of the
f053752f
JR
175 * flow key against the kernel's. When used with %OVS_PACKET_CMD_EXECUTE, only
176 * metadata key fields (e.g. priority, skb mark) are honored. All the packet
177 * header fields are parsed from the packet instead.
6ff686f2
PS
178 * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet. Used
179 * for %OVS_PACKET_CMD_EXECUTE. It has nested %OVS_ACTION_ATTR_* attributes.
0e469d3b
NM
180 * Also used in upcall when %OVS_ACTION_ATTR_USERSPACE has optional
181 * %OVS_USERSPACE_ATTR_ACTIONS attribute.
df2c07f4 182 * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
98403001 183 * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
e995e3df
BP
184 * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content
185 * specified there.
8b7ea2d4
WZ
186 * @OVS_PACKET_ATTR_EGRESS_TUN_KEY: Present for an %OVS_PACKET_CMD_ACTION
187 * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
188 * %OVS_USERSPACE_ATTR_EGRESS_TUN_PORT attribute, which is sent only if the
189 * output port is actually a tunnel port. Contains the output tunnel key
190 * extracted from the packet as nested %OVS_TUNNEL_KEY_ATTR_* attributes.
27130224 191 * @OVS_PACKET_ATTR_MRU: Present for an %OVS_PACKET_CMD_ACTION and
039fb36c 192 * @OVS_PACKET_ATTR_LEN: Packet size before truncation.
27130224
AZ
193 * %OVS_PACKET_ATTR_USERSPACE action specify the Maximum received fragment
194 * size.
195 *
df2c07f4
JP
196 * These attributes follow the &struct ovs_header within the Generic Netlink
197 * payload for %OVS_PACKET_* commands.
982b8810 198 */
df2c07f4
JP
199enum ovs_packet_attr {
200 OVS_PACKET_ATTR_UNSPEC,
201 OVS_PACKET_ATTR_PACKET, /* Packet data. */
202 OVS_PACKET_ATTR_KEY, /* Nested OVS_KEY_ATTR_* attributes. */
6ff686f2 203 OVS_PACKET_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
e995e3df 204 OVS_PACKET_ATTR_USERDATA, /* OVS_ACTION_ATTR_USERSPACE arg. */
8b7ea2d4
WZ
205 OVS_PACKET_ATTR_EGRESS_TUN_KEY, /* Nested OVS_TUNNEL_KEY_ATTR_*
206 attributes. */
2e460098
TG
207 OVS_PACKET_ATTR_UNUSED1,
208 OVS_PACKET_ATTR_UNUSED2,
209 OVS_PACKET_ATTR_PROBE, /* Packet operation is a feature probe,
210 error logging should be suppressed. */
27130224 211 OVS_PACKET_ATTR_MRU, /* Maximum received IP fragment size. */
039fb36c 212 OVS_PACKET_ATTR_LEN, /* Packet size before truncation. */
df2c07f4 213 __OVS_PACKET_ATTR_MAX
72b06300
BP
214};
215
df2c07f4 216#define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
c283069c 217
def95ecd
JG
218/* Virtual ports. */
219
df2c07f4
JP
220#define OVS_VPORT_FAMILY "ovs_vport"
221#define OVS_VPORT_MCGROUP "ovs_vport"
69685a88 222#define OVS_VPORT_VERSION 0x1
df2c07f4
JP
223
224enum ovs_vport_cmd {
225 OVS_VPORT_CMD_UNSPEC,
226 OVS_VPORT_CMD_NEW,
227 OVS_VPORT_CMD_DEL,
228 OVS_VPORT_CMD_GET,
229 OVS_VPORT_CMD_SET
f0fef760 230};
c283069c 231
def95ecd
JG
232enum ovs_vport_type {
233 OVS_VPORT_TYPE_UNSPEC,
234 OVS_VPORT_TYPE_NETDEV, /* network device */
235 OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
7d16c847
PS
236 OVS_VPORT_TYPE_GRE, /* GRE tunnel. */
237 OVS_VPORT_TYPE_VXLAN, /* VXLAN tunnel. */
238 OVS_VPORT_TYPE_GENEVE, /* Geneve tunnel. */
a6ae068b 239 OVS_VPORT_TYPE_LISP = 105, /* LISP tunnel */
4237026e 240 OVS_VPORT_TYPE_STT = 106, /* STT tunnel */
c387d817
GR
241 OVS_VPORT_TYPE_ERSPAN = 107, /* ERSPAN tunnel. */
242 OVS_VPORT_TYPE_IP6ERSPAN = 108, /* ERSPAN tunnel. */
243 OVS_VPORT_TYPE_IP6GRE = 109,
def95ecd
JG
244 __OVS_VPORT_TYPE_MAX
245};
246
247#define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
248
b0ec0f27 249/**
df2c07f4
JP
250 * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
251 * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
252 * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
f0fef760 253 * of vport.
df2c07f4 254 * @OVS_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device
f0fef760
BP
255 * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes
256 * plus a null terminator.
cdb1a85b 257 * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information.
beb1c69a
AW
258 * @OVS_VPORT_ATTR_UPCALL_PID: The array of Netlink socket pids in userspace
259 * among which OVS_PACKET_CMD_MISS upcalls will be distributed for packets
260 * received on this port. If this is a single-element array of value 0,
261 * upcalls should not be sent.
f613a0d7 262 * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
f0fef760 263 * packets sent or received through the vport.
f0fef760 264 *
df2c07f4
JP
265 * These attributes follow the &struct ovs_header within the Generic Netlink
266 * payload for %OVS_VPORT_* commands.
b0ec0f27 267 *
df2c07f4
JP
268 * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
269 * %OVS_VPORT_ATTR_NAME attributes are required. %OVS_VPORT_ATTR_PORT_NO is
f0fef760 270 * optional; if not specified a free port number is automatically selected.
df2c07f4 271 * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
1fc7083d
JG
272 * of vport. %OVS_VPORT_ATTR_STATS is optional and other attributes are
273 * ignored.
f0fef760 274 *
df2c07f4 275 * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
f0fef760 276 * look up the vport to operate on; otherwise dp_idx from the &struct
df2c07f4 277 * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
b0ec0f27 278 */
df2c07f4
JP
279enum ovs_vport_attr {
280 OVS_VPORT_ATTR_UNSPEC,
a5408827
BP
281 OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */
282 OVS_VPORT_ATTR_TYPE, /* u32 OVS_VPORT_TYPE_* constant. */
df2c07f4 283 OVS_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */
cdb1a85b 284 OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
beb1c69a
AW
285 OVS_VPORT_ATTR_UPCALL_PID, /* array of u32 Netlink socket PIDs for */
286 /* receiving upcalls */
f613a0d7 287 OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */
91b37647 288 OVS_VPORT_ATTR_PAD,
b147f2e9
JB
289 OVS_VPORT_ATTR_IFINDEX,
290 OVS_VPORT_ATTR_NETNSID,
df2c07f4 291 __OVS_VPORT_ATTR_MAX
064af421
BP
292};
293
df2c07f4 294#define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
c19e6535 295
0c7930a3
TG
296enum {
297 OVS_VXLAN_EXT_UNSPEC,
ea4cb65c
EG
298 OVS_VXLAN_EXT_GBP,
299 /* place new values here to fill gap. */
300 OVS_VXLAN_EXT_GPE = 8,
0c7930a3
TG
301 __OVS_VXLAN_EXT_MAX,
302};
303
304#define OVS_VXLAN_EXT_MAX (__OVS_VXLAN_EXT_MAX - 1)
305
85c9de19
PS
306/* OVS_VPORT_ATTR_OPTIONS attributes for tunnels.
307 */
308enum {
309 OVS_TUNNEL_ATTR_UNSPEC,
310 OVS_TUNNEL_ATTR_DST_PORT, /* 16-bit UDP port, used by L4 tunnels. */
0c7930a3 311 OVS_TUNNEL_ATTR_EXTENSION,
85c9de19
PS
312 __OVS_TUNNEL_ATTR_MAX
313};
314
315#define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1)
316
37a1300c
BP
317/* Flows. */
318
df2c07f4
JP
319#define OVS_FLOW_FAMILY "ovs_flow"
320#define OVS_FLOW_MCGROUP "ovs_flow"
69685a88 321#define OVS_FLOW_VERSION 0x1
37a1300c 322
df2c07f4
JP
323enum ovs_flow_cmd {
324 OVS_FLOW_CMD_UNSPEC,
325 OVS_FLOW_CMD_NEW,
326 OVS_FLOW_CMD_DEL,
327 OVS_FLOW_CMD_GET,
328 OVS_FLOW_CMD_SET
37a1300c 329};
c19e6535 330
df2c07f4 331struct ovs_flow_stats {
def95ecd
JG
332 __u64 n_packets; /* Number of matched packets. */
333 __u64 n_bytes; /* Number of matched bytes. */
064af421
BP
334};
335
09ded0ad 336enum ovs_key_attr {
df2c07f4 337 OVS_KEY_ATTR_UNSPEC,
fea393b1 338 OVS_KEY_ATTR_ENCAP, /* Nested set of encapsulated attributes. */
eb4e6bb4
BP
339 OVS_KEY_ATTR_PRIORITY, /* u32 skb->priority */
340 OVS_KEY_ATTR_IN_PORT, /* u32 OVS dp port number */
df2c07f4 341 OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */
fea393b1 342 OVS_KEY_ATTR_VLAN, /* be16 VLAN TCI */
eb4e6bb4 343 OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */
df2c07f4
JP
344 OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */
345 OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */
346 OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */
347 OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */
348 OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */
349 OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */
350 OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */
351 OVS_KEY_ATTR_ND, /* struct ovs_key_nd */
72e8bf28 352 OVS_KEY_ATTR_SKB_MARK, /* u32 skb mark */
7d16c847 353 OVS_KEY_ATTR_TUNNEL, /* Nested set of ovs_tunnel attributes */
10f72e3d 354 OVS_KEY_ATTR_SCTP, /* struct ovs_key_sctp */
dc235f7f 355 OVS_KEY_ATTR_TCP_FLAGS, /* be16 TCP flags. */
7d16c847 356 OVS_KEY_ATTR_DP_HASH, /* u32 hash value. Value 0 indicates the hash
7804df20 357 is not computed by the datapath. */
0962036c 358 OVS_KEY_ATTR_RECIRC_ID, /* u32 recirc id */
ccf43786
SH
359 OVS_KEY_ATTR_MPLS, /* array of struct ovs_key_mpls.
360 * The implementation may restrict
361 * the accepted length of the array. */
07659514
JS
362 OVS_KEY_ATTR_CT_STATE, /* u32 bitmask of OVS_CS_F_* */
363 OVS_KEY_ATTR_CT_ZONE, /* u16 connection tracking zone. */
8e53fe8c 364 OVS_KEY_ATTR_CT_MARK, /* u32 connection tracking mark */
9daf2348 365 OVS_KEY_ATTR_CT_LABELS, /* 16-octet connection tracking labels */
c30b4cea
JR
366 OVS_KEY_ATTR_CT_ORIG_TUPLE_IPV4, /* struct ovs_key_ct_tuple_ipv4 */
367 OVS_KEY_ATTR_CT_ORIG_TUPLE_IPV6, /* struct ovs_key_ct_tuple_ipv6 */
96b82f6d 368 OVS_KEY_ATTR_NSH, /* Nested set of ovs_nsh_key_* */
ccf43786 369
9b405f1a 370#ifdef __KERNEL__
0962036c 371 /* Only used within kernel data path. */
f0cd669f 372 OVS_KEY_ATTR_TUNNEL_INFO, /* struct ovs_tunnel_info */
9b405f1a 373#endif
beb75a40 374
7c95e85e
BP
375#ifndef __KERNEL__
376 /* Only used within userspace data path. */
beb75a40 377 OVS_KEY_ATTR_PACKET_TYPE, /* be32 packet type */
9b2b8497 378 OVS_KEY_ATTR_ND_EXTENSIONS, /* struct ovs_key_nd_extensions */
7c95e85e
BP
379#endif
380
df2c07f4 381 __OVS_KEY_ATTR_MAX
36956a7d
BP
382};
383
df2c07f4 384#define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
36956a7d 385
9b405f1a 386enum ovs_tunnel_key_attr {
7d16c847
PS
387 OVS_TUNNEL_KEY_ATTR_ID, /* be64 Tunnel ID */
388 OVS_TUNNEL_KEY_ATTR_IPV4_SRC, /* be32 src IP address. */
389 OVS_TUNNEL_KEY_ATTR_IPV4_DST, /* be32 dst IP address. */
390 OVS_TUNNEL_KEY_ATTR_TOS, /* u8 Tunnel IP ToS. */
391 OVS_TUNNEL_KEY_ATTR_TTL, /* u8 Tunnel IP TTL. */
392 OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT, /* No argument, set DF. */
393 OVS_TUNNEL_KEY_ATTR_CSUM, /* No argument. CSUM packet. */
394 OVS_TUNNEL_KEY_ATTR_OAM, /* No argument. OAM frame. */
395 OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS, /* Array of Geneve options. */
8b7ea2d4
WZ
396 OVS_TUNNEL_KEY_ATTR_TP_SRC, /* be16 src Transport Port. */
397 OVS_TUNNEL_KEY_ATTR_TP_DST, /* be16 dst Transport Port. */
0c7930a3 398 OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS, /* Nested OVS_VXLAN_EXT_* */
ffe4c74f
JB
399 OVS_TUNNEL_KEY_ATTR_IPV6_SRC, /* struct in6_addr src IPv6 address. */
400 OVS_TUNNEL_KEY_ATTR_IPV6_DST, /* struct in6_addr dst IPv6 address. */
f3464818 401 OVS_TUNNEL_KEY_ATTR_PAD,
320326e9 402 OVS_TUNNEL_KEY_ATTR_ERSPAN_OPTS, /* struct erspan_metadata */
9b405f1a
PS
403 __OVS_TUNNEL_KEY_ATTR_MAX
404};
7d16c847 405
9b405f1a
PS
406#define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1)
407
7257b535
BP
408/**
409 * enum ovs_frag_type - IPv4 and IPv6 fragment type
410 * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
411 * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
412 * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
413 *
414 * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
415 * ovs_key_ipv6.
416 */
417enum ovs_frag_type {
418 OVS_FRAG_TYPE_NONE,
419 OVS_FRAG_TYPE_FIRST,
420 OVS_FRAG_TYPE_LATER,
421 __OVS_FRAG_TYPE_MAX
422};
423
424#define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
425
df2c07f4 426struct ovs_key_ethernet {
d11dbe61
TG
427 __u8 eth_src[ETH_ALEN];
428 __u8 eth_dst[ETH_ALEN];
36956a7d
BP
429};
430
b02475c5 431struct ovs_key_mpls {
20131cef 432 __be32 mpls_lse;
b02475c5
SH
433};
434
df2c07f4 435struct ovs_key_ipv4 {
9ea0bccc
BP
436 __be32 ipv4_src;
437 __be32 ipv4_dst;
438 __u8 ipv4_proto;
439 __u8 ipv4_tos;
a61680c6 440 __u8 ipv4_ttl;
7257b535 441 __u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */
36956a7d
BP
442};
443
df2c07f4 444struct ovs_key_ipv6 {
9ea0bccc
BP
445 __be32 ipv6_src[4];
446 __be32 ipv6_dst[4];
fa8223b7 447 __be32 ipv6_label; /* 20-bits in least-significant bits. */
9ea0bccc 448 __u8 ipv6_proto;
60258dcb 449 __u8 ipv6_tclass;
a61680c6 450 __u8 ipv6_hlimit;
7257b535 451 __u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */
d31f1109
JP
452};
453
df2c07f4 454struct ovs_key_tcp {
9ea0bccc
BP
455 __be16 tcp_src;
456 __be16 tcp_dst;
36956a7d
BP
457};
458
df2c07f4 459struct ovs_key_udp {
9ea0bccc
BP
460 __be16 udp_src;
461 __be16 udp_dst;
36956a7d
BP
462};
463
10f72e3d
JS
464struct ovs_key_sctp {
465 __be16 sctp_src;
466 __be16 sctp_dst;
467};
468
df2c07f4 469struct ovs_key_icmp {
9ea0bccc
BP
470 __u8 icmp_type;
471 __u8 icmp_code;
36956a7d
BP
472};
473
df2c07f4 474struct ovs_key_icmpv6 {
9ea0bccc
BP
475 __u8 icmpv6_type;
476 __u8 icmpv6_code;
d31f1109
JP
477};
478
df2c07f4 479struct ovs_key_arp {
9ea0bccc
BP
480 __be32 arp_sip;
481 __be32 arp_tip;
482 __be16 arp_op;
d11dbe61
TG
483 __u8 arp_sha[ETH_ALEN];
484 __u8 arp_tha[ETH_ALEN];
064af421
BP
485};
486
df2c07f4 487struct ovs_key_nd {
7d16c847
PS
488 __be32 nd_target[4];
489 __u8 nd_sll[ETH_ALEN];
490 __u8 nd_tll[ETH_ALEN];
685a51a5
JP
491};
492
9b2b8497
VDA
493#ifndef __KERNEL__
494struct ovs_key_nd_extensions {
495 __be32 nd_reserved;
496 __u8 nd_options_type;
497};
498#endif
499
83495bd9
JR
500#define OVS_CT_LABELS_LEN_32 4
501#define OVS_CT_LABELS_LEN (OVS_CT_LABELS_LEN_32 * sizeof(__u32))
9daf2348 502struct ovs_key_ct_labels {
83495bd9
JR
503 union {
504 __u8 ct_labels[OVS_CT_LABELS_LEN];
505 __u32 ct_labels_32[OVS_CT_LABELS_LEN_32];
506 };
9daf2348
JS
507};
508
f59cb331
YY
509enum ovs_nsh_key_attr {
510 OVS_NSH_KEY_ATTR_UNSPEC,
511 OVS_NSH_KEY_ATTR_BASE, /* struct ovs_nsh_key_base. */
512 OVS_NSH_KEY_ATTR_MD1, /* struct ovs_nsh_key_md1. */
513 OVS_NSH_KEY_ATTR_MD2, /* variable-length octets. */
514 __OVS_NSH_KEY_ATTR_MAX
515};
516
517#define OVS_NSH_KEY_ATTR_MAX (__OVS_NSH_KEY_ATTR_MAX - 1)
518
519struct ovs_nsh_key_base {
520 __u8 flags;
17553f27 521 __u8 ttl;
f59cb331
YY
522 __u8 mdtype;
523 __u8 np;
f59cb331
YY
524 __be32 path_hdr;
525};
526
527#define NSH_MD1_CONTEXT_SIZE 4
528
529struct ovs_nsh_key_md1 {
530 __be32 context[NSH_MD1_CONTEXT_SIZE];
3d2fbd70
JS
531};
532
07659514
JS
533/* OVS_KEY_ATTR_CT_STATE flags */
534#define OVS_CS_F_NEW 0x01 /* Beginning of a new connection. */
535#define OVS_CS_F_ESTABLISHED 0x02 /* Part of an existing connection. */
536#define OVS_CS_F_RELATED 0x04 /* Related to an established
537 * connection. */
538#define OVS_CS_F_REPLY_DIR 0x08 /* Flow is in the reply direction. */
539#define OVS_CS_F_INVALID 0x10 /* Could not track connection. */
540#define OVS_CS_F_TRACKED 0x20 /* Conntrack has occurred. */
9ac0aada
JR
541#define OVS_CS_F_SRC_NAT 0x40 /* Packet's source address/port was
542 mangled by NAT. */
543#define OVS_CS_F_DST_NAT 0x80 /* Packet's destination address/port
544 was mangled by NAT. */
545
546#define OVS_CS_F_NAT_MASK (OVS_CS_F_SRC_NAT | OVS_CS_F_DST_NAT)
07659514 547
c30b4cea
JR
548struct ovs_key_ct_tuple_ipv4 {
549 __be32 ipv4_src;
550 __be32 ipv4_dst;
551 __be16 src_port;
552 __be16 dst_port;
553 __u8 ipv4_proto;
554};
555
556struct ovs_key_ct_tuple_ipv6 {
557 __be32 ipv6_src[4];
558 __be32 ipv6_dst[4];
559 __be16 src_port;
560 __be16 dst_port;
561 __u8 ipv6_proto;
562};
563
d6569377 564/**
df2c07f4
JP
565 * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
566 * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
37a1300c
BP
567 * key. Always present in notifications. Required for all requests (except
568 * dumps).
df2c07f4 569 * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
67145b4d 570 * the actions to take for packets that match the key. Always present in
e002c96f 571 * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional for
90b8c2f7
JR
572 * %OVS_FLOW_CMD_SET requests. An %OVS_FLOW_CMD_SET without
573 * %OVS_FLOW_ATTR_ACTIONS will not modify the actions. To clear the actions,
574 * an %OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given.
df2c07f4 575 * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
37a1300c
BP
576 * flow. Present in notifications if the stats would be nonzero. Ignored in
577 * requests.
df2c07f4 578 * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
37a1300c
BP
579 * TCP flags seen on packets in this flow. Only present in notifications for
580 * TCP flows, and only if it would be nonzero. Ignored in requests.
df2c07f4 581 * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
37a1300c
BP
582 * the system monotonic clock, at which a packet was last processed for this
583 * flow. Only present in notifications if a packet has been processed for this
584 * flow. Ignored in requests.
df2c07f4 585 * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
37a1300c
BP
586 * last-used time, accumulated TCP flags, and statistics for this flow.
587 * Otherwise ignored in requests. Never present in notifications.
a1c564be
AZ
588 * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the
589 * mask bits for wildcarded flow match. Mask bit value '1' specifies exact
590 * match with corresponding flow key bit, while mask bit value '0' specifies
591 * a wildcarded match. Omitting attribute is treated as wildcarding all
592 * corresponding fields. Optional for all requests. If not present,
593 * all flow key bits are exact match bits.
bc619e29
JS
594 * @OVS_FLOW_ATTR_UFID: A value between 1-16 octets specifying a unique
595 * identifier for the flow. Causes the flow to be indexed by this value rather
596 * than the value of the %OVS_FLOW_ATTR_KEY attribute. Optional for all
597 * requests. Present in notifications if the flow was created with this
598 * attribute.
599 * @OVS_FLOW_ATTR_UFID_FLAGS: A 32-bit value of OR'd %OVS_UFID_F_*
600 * flags that provide alternative semantics for flow installation and
601 * retrieval. Optional for all requests.
d6569377 602 *
df2c07f4
JP
603 * These attributes follow the &struct ovs_header within the Generic Netlink
604 * payload for %OVS_FLOW_* commands.
d6569377 605 */
df2c07f4
JP
606enum ovs_flow_attr {
607 OVS_FLOW_ATTR_UNSPEC,
608 OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */
609 OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
610 OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */
611 OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
612 OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */
613 OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */
a1c564be 614 OVS_FLOW_ATTR_MASK, /* Sequence of OVS_KEY_ATTR_* attributes. */
9233cef7
JR
615 OVS_FLOW_ATTR_PROBE, /* Flow operation is a feature probe, error
616 * logging should be suppressed. */
d9aa7218
JS
617 OVS_FLOW_ATTR_UFID, /* Variable length unique flow identifier. */
618 OVS_FLOW_ATTR_UFID_FLAGS,/* u32 of OVS_UFID_F_*. */
91b37647 619 OVS_FLOW_ATTR_PAD,
df2c07f4 620 __OVS_FLOW_ATTR_MAX
064af421
BP
621};
622
df2c07f4 623#define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
064af421 624
d9aa7218
JS
625/**
626 * Omit attributes for notifications.
627 *
628 * If a datapath request contains an OVS_UFID_F_OMIT_* flag, then the datapath
629 * may omit the corresponding 'ovs_flow_attr' from the response.
630 */
631#define OVS_UFID_F_OMIT_KEY (1 << 0)
632#define OVS_UFID_F_OMIT_MASK (1 << 1)
633#define OVS_UFID_F_OMIT_ACTIONS (1 << 2)
634
6ff686f2 635/**
98403001 636 * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
6ff686f2
PS
637 * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
638 * @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of
639 * %UINT32_MAX samples all packets and intermediate values sample intermediate
640 * fractions of packets.
641 * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
642 * Actions are passed as nested attributes.
98403001
BP
643 *
644 * Executes the specified actions with the given probability on a per-packet
645 * basis.
6ff686f2
PS
646 */
647enum ovs_sample_attr {
648 OVS_SAMPLE_ATTR_UNSPEC,
649 OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
650 OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
651 __OVS_SAMPLE_ATTR_MAX,
7d9595e3
AZ
652
653#ifdef __KERNEL__
654 OVS_SAMPLE_ATTR_ARG /* struct sample_arg */
655#endif
6ff686f2
PS
656};
657
658#define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
659
7d9595e3
AZ
660#ifdef __KERNEL__
661struct sample_arg {
662 bool exec; /* When true, actions in sample will not
663 * change flow keys. False otherwise.
664 */
665 u32 probability; /* Same value as
666 * 'OVS_SAMPLE_ATTR_PROBABILITY'.
667 */
668};
669#endif
670
98403001
BP
671/**
672 * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
673 * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
674 * message should be sent. Required.
e995e3df
BP
675 * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is
676 * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA.
8b7ea2d4
WZ
677 * @OVS_USERSPACE_ATTR_EGRESS_TUN_PORT: If present, u32 output port to get
678 * tunnel info.
0e469d3b 679 * @OVS_USERSPACE_ATTR_ACTIONS: If present, send actions with upcall.
98403001
BP
680 */
681enum ovs_userspace_attr {
682 OVS_USERSPACE_ATTR_UNSPEC,
683 OVS_USERSPACE_ATTR_PID, /* u32 Netlink PID to receive upcalls. */
e995e3df 684 OVS_USERSPACE_ATTR_USERDATA, /* Optional user-specified cookie. */
8b7ea2d4
WZ
685 OVS_USERSPACE_ATTR_EGRESS_TUN_PORT, /* Optional, u32 output port
686 * to get tunnel info. */
0e469d3b 687 OVS_USERSPACE_ATTR_ACTIONS, /* Optional flag to get actions. */
98403001
BP
688 __OVS_USERSPACE_ATTR_MAX
689};
690
691#define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
692
4c7804f1
WT
693struct ovs_action_trunc {
694 uint32_t max_len; /* Max packet size in bytes. */
695};
696
b02475c5
SH
697/**
698 * struct ovs_action_push_mpls - %OVS_ACTION_ATTR_PUSH_MPLS action argument.
699 * @mpls_lse: MPLS label stack entry to push.
700 * @mpls_ethertype: Ethertype to set in the encapsulating ethernet frame.
701 *
702 * The only values @mpls_ethertype should ever be given are %ETH_P_MPLS_UC and
703 * %ETH_P_MPLS_MC, indicating MPLS unicast or multicast. Other are rejected.
704 */
705struct ovs_action_push_mpls {
706 __be32 mpls_lse;
707 __be16 mpls_ethertype; /* Either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC */
708};
709
fea393b1
BP
710/**
711 * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument.
712 * @vlan_tpid: Tag protocol identifier (TPID) to push.
8ddc056d
BP
713 * @vlan_tci: Tag control identifier (TCI) to push. The CFI bit must be set
714 * (but it will not be set in the 802.1Q header that is pushed).
fea393b1 715 *
051f4b49
YY
716 * The @vlan_tpid value is typically %ETH_P_8021Q or %ETH_P_8021AD.
717 * The only acceptable TPID values are those that the kernel module also parses
718 * as 802.1Q or 802.1AD headers, to prevent %OVS_ACTION_ATTR_PUSH_VLAN followed
719 * by %OVS_ACTION_ATTR_POP_VLAN from having surprising results.
fea393b1
BP
720 */
721struct ovs_action_push_vlan {
051f4b49 722 __be16 vlan_tpid; /* 802.1Q or 802.1ad TPID. */
fea393b1
BP
723 __be16 vlan_tci; /* 802.1Q TCI (VLAN ID and priority). */
724};
725
572f732a
AZ
726/* Data path hash algorithm for computing Datapath hash.
727 *
347bf289 728 * The algorithm type only specifies the fields in a flow
572f732a
AZ
729 * will be used as part of the hash. Each datapath is free
730 * to use its own hash algorithm. The hash value will be
731 * opaque to the user space daemon.
732 */
347bf289
AZ
733enum ovs_hash_alg {
734 OVS_HASH_ALG_L4,
6a0b0d3b
JS
735#ifndef __KERNEL__
736 OVS_HASH_ALG_SYM_L4,
737#endif
738 __OVS_HASH_MAX
572f732a 739};
7d16c847 740
572f732a 741/*
347bf289 742 * struct ovs_action_hash - %OVS_ACTION_ATTR_HASH action argument.
572f732a 743 * @hash_alg: Algorithm used to compute hash prior to recirculation.
62ac1f20 744 * @hash_basis: basis used for computing hash.
572f732a 745 */
347bf289 746struct ovs_action_hash {
7d16c847 747 uint32_t hash_alg; /* One of ovs_hash_alg. */
62ac1f20 748 uint32_t hash_basis;
572f732a
AZ
749};
750
a36de779 751#ifndef __KERNEL__
5bb08b0e 752#define TNL_PUSH_HEADER_SIZE 512
a36de779
PS
753
754/*
755 * struct ovs_action_push_tnl - %OVS_ACTION_ATTR_TUNNEL_PUSH
756 * @tnl_port: To identify tunnel port to pass header info.
757 * @out_port: Physical port to send encapsulated packet.
758 * @header_len: Length of the header to be pushed.
759 * @tnl_type: This is only required to format this header. Otherwise
760 * ODP layer can not parse %header.
761 * @header: Partial header for the tunnel. Tunnel push action can use
762 * this header to build final header according to actual packet parameters.
763 */
764struct ovs_action_push_tnl {
81765c00
BP
765 odp_port_t tnl_port;
766 odp_port_t out_port;
a36de779
PS
767 uint32_t header_len;
768 uint32_t tnl_type; /* For logging. */
1620b7ea 769 uint32_t header[TNL_PUSH_HEADER_SIZE / 4];
a36de779
PS
770};
771#endif
772
07659514
JS
773/**
774 * enum ovs_ct_attr - Attributes for %OVS_ACTION_ATTR_CT action.
775 * @OVS_CT_ATTR_COMMIT: If present, commits the connection to the conntrack
776 * table. This allows future packets for the same connection to be identified
c05e2094
JS
777 * as 'established' or 'related'. The flow key for the current packet will
778 * retain the pre-commit connection state.
07659514 779 * @OVS_CT_ATTR_ZONE: u16 connection tracking zone.
8e53fe8c
JS
780 * @OVS_CT_ATTR_MARK: u32 value followed by u32 mask. For each bit set in the
781 * mask, the corresponding bit in the value is copied to the connection
782 * tracking mark field in the connection.
9daf2348
JS
783 * @OVS_CT_ATTR_LABELS: %OVS_CT_LABELS_LEN value followed by %OVS_CT_LABELS_LEN
784 * mask. For each bit set in the mask, the corresponding bit in the value is
785 * copied to the connection tracking label field in the connection.
d787ad39 786 * @OVS_CT_ATTR_HELPER: variable length string defining conntrack ALG.
3d6d8b4d
JR
787 * @OVS_CT_ATTR_NAT: Nested OVS_NAT_ATTR_* for performing L3 network address
788 * translation (NAT) on the packet.
b80e259f
JR
789 * @OVS_CT_ATTR_FORCE_COMMIT: Like %OVS_CT_ATTR_COMMIT, but instead of doing
790 * nothing if the connection is already committed will check that the current
791 * packet is in conntrack entry's original direction. If directionality does
792 * not match, will delete the existing conntrack entry and create a new one.
8e83854c
JR
793 * @OVS_CT_ATTR_EVENTMASK: Mask of bits indicating which conntrack event types
794 * (enum ip_conntrack_events IPCT_*) should be reported. For any bit set to
795 * zero, the corresponding event type is not generated. Default behavior
796 * depends on system configuration, but typically all event types are
797 * generated, hence listening on NFNLGRP_CONNTRACK_UPDATE events may get a lot
798 * of events. Explicitly passing this attribute allows limiting the updates
799 * received to the events of interest. The bit 1 << IPCT_NEW, 1 <<
800 * IPCT_RELATED, and 1 << IPCT_DESTROY must be set to ones for those events to
801 * be received on NFNLGRP_CONNTRACK_NEW and NFNLGRP_CONNTRACK_DESTROY groups,
802 * respectively. Remaining bits control the changes for which an event is
803 * delivered on the NFNLGRP_CONNTRACK_UPDATE group.
07659514
JS
804 */
805enum ovs_ct_attr {
806 OVS_CT_ATTR_UNSPEC,
807 OVS_CT_ATTR_COMMIT, /* No argument, commits connection. */
808 OVS_CT_ATTR_ZONE, /* u16 zone id. */
8e53fe8c 809 OVS_CT_ATTR_MARK, /* mark to associate with this connection. */
9daf2348 810 OVS_CT_ATTR_LABELS, /* label to associate with this connection. */
d787ad39
JS
811 OVS_CT_ATTR_HELPER, /* netlink helper to assist detection of
812 related connections. */
9ac0aada 813 OVS_CT_ATTR_NAT, /* Nested OVS_NAT_ATTR_* */
b80e259f 814 OVS_CT_ATTR_FORCE_COMMIT, /* No argument */
8e83854c 815 OVS_CT_ATTR_EVENTMASK, /* u32 mask of IPCT_* events. */
07659514
JS
816 __OVS_CT_ATTR_MAX
817};
818
819#define OVS_CT_ATTR_MAX (__OVS_CT_ATTR_MAX - 1)
820
6fcecb85
YY
821/*
822 * struct ovs_action_push_eth - %OVS_ACTION_ATTR_PUSH_ETH action argument.
823 * @addresses: Source and destination MAC addresses.
6fcecb85
YY
824 */
825struct ovs_action_push_eth {
826 struct ovs_key_ethernet addresses;
827};
828
9ac0aada
JR
829/**
830 * enum ovs_nat_attr - Attributes for %OVS_CT_ATTR_NAT.
831 *
832 * @OVS_NAT_ATTR_SRC: Flag for Source NAT (mangle source address/port).
833 * @OVS_NAT_ATTR_DST: Flag for Destination NAT (mangle destination
834 * address/port). Only one of (@OVS_NAT_ATTR_SRC, @OVS_NAT_ATTR_DST) may be
835 * specified. Effective only for packets for ct_state NEW connections.
836 * Committed connections are mangled by the NAT action according to the
837 * committed NAT type regardless of the flags specified. As a corollary, a NAT
838 * action without a NAT type flag will only mangle packets of committed
839 * connections. The following NAT attributes only apply for NEW connections,
840 * and they may be included only when the CT action has the @OVS_CT_ATTR_COMMIT
841 * flag and either @OVS_NAT_ATTR_SRC, @OVS_NAT_ATTR_DST is also included.
842 * @OVS_NAT_ATTR_IP_MIN: struct in_addr or struct in6_addr
843 * @OVS_NAT_ATTR_IP_MAX: struct in_addr or struct in6_addr
844 * @OVS_NAT_ATTR_PROTO_MIN: u16 L4 protocol specific lower boundary (port)
845 * @OVS_NAT_ATTR_PROTO_MAX: u16 L4 protocol specific upper boundary (port)
846 * @OVS_NAT_ATTR_PERSISTENT: Flag for persistent IP mapping across reboots
847 * @OVS_NAT_ATTR_PROTO_HASH: Flag for pseudo random L4 port mapping (MD5)
848 * @OVS_NAT_ATTR_PROTO_RANDOM: Flag for fully randomized L4 port mapping
849 */
850enum ovs_nat_attr {
851 OVS_NAT_ATTR_UNSPEC,
852 OVS_NAT_ATTR_SRC,
853 OVS_NAT_ATTR_DST,
854 OVS_NAT_ATTR_IP_MIN,
855 OVS_NAT_ATTR_IP_MAX,
856 OVS_NAT_ATTR_PROTO_MIN,
857 OVS_NAT_ATTR_PROTO_MAX,
858 OVS_NAT_ATTR_PERSISTENT,
859 OVS_NAT_ATTR_PROTO_HASH,
860 OVS_NAT_ATTR_PROTO_RANDOM,
861 __OVS_NAT_ATTR_MAX,
862};
863
864#define OVS_NAT_ATTR_MAX (__OVS_NAT_ATTR_MAX - 1)
865
4edb9ae9 866/**
a5408827 867 * enum ovs_action_attr - Action types.
4edb9ae9 868 *
a5408827 869 * @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
4c7804f1 870 * @OVS_ACTION_ATTR_TRUNC: Output packet to port with truncated packet size.
a5408827
BP
871 * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
872 * %OVS_USERSPACE_ATTR_* attributes.
051f4b49
YY
873 * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q or 802.1ad header
874 * onto the packet.
875 * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q or 802.1ad header
876 * from the packet.
a5408827
BP
877 * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
878 * the nested %OVS_SAMPLE_ATTR_* attributes.
b02475c5
SH
879 * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header. The
880 * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its
881 * value.
6d670e7f
JR
882 * @OVS_ACTION_ATTR_SET_MASKED: Replaces the contents of an existing header. A
883 * nested %OVS_KEY_ATTR_* attribute specifies a header to modify, its value,
884 * and a mask. For every bit set in the mask, the corresponding bit value
885 * is copied from the value to the packet header field, rest of the bits are
886 * left unchanged. The non-masked value bits must be passed in as zeroes.
887 * Masking is not supported for the %OVS_KEY_ATTR_TUNNEL attribute.
94eb8690
JP
888 * @OVS_ACTION_ATTR_RECIRC: Recirculate within the data path.
889 * @OVS_ACTION_ATTR_HASH: Compute and set flow hash value.
b02475c5 890 * @OVS_ACTION_ATTR_PUSH_MPLS: Push a new MPLS label stack entry onto the
269dc90a 891 * top of the packets MPLS label stack. Set the ethertype of the
b02475c5
SH
892 * encapsulating frame to either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC to
893 * indicate the new packet contents.
894 * @OVS_ACTION_ATTR_POP_MPLS: Pop an MPLS label stack entry off of the
895 * packet's MPLS label stack. Set the encapsulating frame's ethertype to
269dc90a
BP
896 * indicate the new packet contents. This could potentially still be
897 * %ETH_P_MPLS if the resulting MPLS label stack is not empty. If there
b02475c5 898 * is no MPLS label stack, as determined by ethertype, no action is taken.
07659514
JS
899 * @OVS_ACTION_ATTR_CT: Track the connection. Populate the conntrack-related
900 * entries in the flow key.
6fcecb85
YY
901 * @OVS_ACTION_ATTR_PUSH_ETH: Push a new outermost Ethernet header onto the
902 * packet.
88fc5281 903 * @OVS_ACTION_ATTR_POP_ETH: Pop the outermost Ethernet header off the packet.
1fe178d2 904 * @OVS_ACTION_ATTR_CT_CLEAR: Clear conntrack state from the packet.
f59cb331
YY
905 * @OVS_ACTION_ATTR_PUSH_NSH: push NSH header to the packet.
906 * @OVS_ACTION_ATTR_POP_NSH: pop the outermost NSH header off the packet.
4edb9ae9 907 *
fea393b1
BP
908 * Only a single header can be set with a single %OVS_ACTION_ATTR_SET. Not all
909 * fields within a header are modifiable, e.g. the IPv4 protocol and fragment
910 * type may not be changed.
a36de779 911 *
b940b3d7
JR
912 * @OVS_ACTION_ATTR_SET_TO_MASKED: Kernel internal masked set action translated
913 * from the @OVS_ACTION_ATTR_SET.
a36de779
PS
914 * @OVS_ACTION_ATTR_TUNNEL_PUSH: Push tunnel header described by struct
915 * ovs_action_push_tnl.
916 * @OVS_ACTION_ATTR_TUNNEL_POP: Lookup tunnel port by port-no passed and pop
917 * tunnel header.
5dddf960
JR
918 * @OVS_ACTION_ATTR_METER: Run packet through a meter, which may drop the
919 * packet, or modify the packet (e.g., change the DSCP field).
5a77cf96
YS
920 * @OVS_ACTION_ATTR_CLONE: make a copy of the packet and execute a list of
921 * actions without affecting the original packet and key.
4edb9ae9
PS
922 */
923
09ded0ad 924enum ovs_action_attr {
df2c07f4 925 OVS_ACTION_ATTR_UNSPEC,
a5408827 926 OVS_ACTION_ATTR_OUTPUT, /* u32 port number. */
98403001 927 OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */
a5408827 928 OVS_ACTION_ATTR_SET, /* One nested OVS_KEY_ATTR_*. */
fea393b1
BP
929 OVS_ACTION_ATTR_PUSH_VLAN, /* struct ovs_action_push_vlan. */
930 OVS_ACTION_ATTR_POP_VLAN, /* No argument. */
98403001 931 OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */
7d16c847 932 OVS_ACTION_ATTR_RECIRC, /* u32 recirc_id. */
347bf289 933 OVS_ACTION_ATTR_HASH, /* struct ovs_action_hash. */
965662a9
AZ
934 OVS_ACTION_ATTR_PUSH_MPLS, /* struct ovs_action_push_mpls. */
935 OVS_ACTION_ATTR_POP_MPLS, /* __be16 ethertype. */
6d670e7f
JR
936 OVS_ACTION_ATTR_SET_MASKED, /* One nested OVS_KEY_ATTR_* including
937 * data immediately followed by a mask.
938 * The data must be zero for the unmasked
939 * bits. */
07659514 940 OVS_ACTION_ATTR_CT, /* Nested OVS_CT_ATTR_* . */
4c7804f1 941 OVS_ACTION_ATTR_TRUNC, /* u32 struct ovs_action_trunc. */
6fcecb85
YY
942 OVS_ACTION_ATTR_PUSH_ETH, /* struct ovs_action_push_eth. */
943 OVS_ACTION_ATTR_POP_ETH, /* No argument. */
1fe178d2 944 OVS_ACTION_ATTR_CT_CLEAR, /* No argument. */
96b82f6d
YY
945 OVS_ACTION_ATTR_PUSH_NSH, /* Nested OVS_NSH_KEY_ATTR_*. */
946 OVS_ACTION_ATTR_POP_NSH, /* No argument. */
5a77cf96
YS
947 OVS_ACTION_ATTR_METER, /* u32 meter number. */
948 OVS_ACTION_ATTR_CLONE, /* Nested OVS_CLONE_ATTR_*. */
7d16c847 949
a36de779
PS
950#ifndef __KERNEL__
951 OVS_ACTION_ATTR_TUNNEL_PUSH, /* struct ovs_action_push_tnl*/
952 OVS_ACTION_ATTR_TUNNEL_POP, /* u32 port number. */
953#endif
b940b3d7
JR
954 __OVS_ACTION_ATTR_MAX, /* Nothing past this will be accepted
955 * from userspace. */
956
957#ifdef __KERNEL__
958 OVS_ACTION_ATTR_SET_TO_MASKED, /* Kernel module internal masked
959 * set action converted from
960 * OVS_ACTION_ATTR_SET. */
961#endif
064af421
BP
962};
963
df2c07f4 964#define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
064af421 965
8011eea7
AZ
966/* Meters. */
967#define OVS_METER_FAMILY "ovs_meter"
968#define OVS_METER_MCGROUP "ovs_meter"
969#define OVS_METER_VERSION 0x1
970
971enum ovs_meter_cmd {
972 OVS_METER_CMD_UNSPEC,
973 OVS_METER_CMD_FEATURES, /* Get features supported by the datapath. */
974 OVS_METER_CMD_SET, /* Add or modify a meter. */
975 OVS_METER_CMD_DEL, /* Delete a meter. */
976 OVS_METER_CMD_GET /* Get meter stats. */
977};
978
979enum ovs_meter_attr {
980 OVS_METER_ATTR_UNSPEC,
981 OVS_METER_ATTR_ID, /* u32 meter ID within datapath. */
982 OVS_METER_ATTR_KBPS, /* No argument. If set, units in kilobits
983 * per second. Otherwise, units in
984 * packets per second.
985 */
986 OVS_METER_ATTR_STATS, /* struct ovs_flow_stats for the meter. */
987 OVS_METER_ATTR_BANDS, /* Nested attributes for meter bands. */
988 OVS_METER_ATTR_USED, /* u64 msecs last used in monotonic time. */
989 OVS_METER_ATTR_CLEAR, /* Flag to clear stats, used. */
990 OVS_METER_ATTR_MAX_METERS, /* u32 number of meters supported. */
991 OVS_METER_ATTR_MAX_BANDS, /* u32 max number of bands per meter. */
992 OVS_METER_ATTR_PAD,
993 __OVS_METER_ATTR_MAX
994};
995
996#define OVS_METER_ATTR_MAX (__OVS_METER_ATTR_MAX - 1)
997
998enum ovs_band_attr {
999 OVS_BAND_ATTR_UNSPEC,
1000 OVS_BAND_ATTR_TYPE, /* u32 OVS_METER_BAND_TYPE_* constant. */
1001 OVS_BAND_ATTR_RATE, /* u32 band rate in meter units (see above). */
1002 OVS_BAND_ATTR_BURST, /* u32 burst size in meter units. */
1003 OVS_BAND_ATTR_STATS, /* struct ovs_flow_stats for the band. */
1004 __OVS_BAND_ATTR_MAX
1005};
1006
1007#define OVS_BAND_ATTR_MAX (__OVS_BAND_ATTR_MAX - 1)
1008
1009enum ovs_meter_band_type {
1010 OVS_METER_BAND_TYPE_UNSPEC,
1011 OVS_METER_BAND_TYPE_DROP, /* Drop exceeding packets. */
1012 __OVS_METER_BAND_TYPE_MAX
1013};
1014
1015#define OVS_METER_BAND_TYPE_MAX (__OVS_METER_BAND_TYPE_MAX - 1)
1016
a52da944
YHW
1017/* Conntrack limit */
1018#define OVS_CT_LIMIT_FAMILY "ovs_ct_limit"
1019#define OVS_CT_LIMIT_MCGROUP "ovs_ct_limit"
1020#define OVS_CT_LIMIT_VERSION 0x1
1021
1022enum ovs_ct_limit_cmd {
1023 OVS_CT_LIMIT_CMD_UNSPEC,
1024 OVS_CT_LIMIT_CMD_SET, /* Add or modify ct limit. */
1025 OVS_CT_LIMIT_CMD_DEL, /* Delete ct limit. */
1026 OVS_CT_LIMIT_CMD_GET /* Get ct limit. */
1027};
1028
1029enum ovs_ct_limit_attr {
1030 OVS_CT_LIMIT_ATTR_UNSPEC,
1031 OVS_CT_LIMIT_ATTR_ZONE_LIMIT, /* Nested struct ovs_zone_limit. */
1032 __OVS_CT_LIMIT_ATTR_MAX
1033};
1034
1035#define OVS_CT_LIMIT_ATTR_MAX (__OVS_CT_LIMIT_ATTR_MAX - 1)
1036
1037#define OVS_ZONE_LIMIT_DEFAULT_ZONE -1
1038
1039struct ovs_zone_limit {
1040 int zone_id;
1041 __u32 limit;
1042 __u32 count;
1043};
1044
5a77cf96
YS
1045#define OVS_CLONE_ATTR_EXEC 0 /* Specify an u32 value. When nonzero,
1046 * actions in clone will not change flow
1047 * keys. False otherwise.
1048 */
1049
077257b8 1050#endif /* _LINUX_OPENVSWITCH_H */