blob: f271f1ec50aed08cb8f0e52fdd9ae8752b8c3b83 [file] [log] [blame]
Greg Kroah-Hartmane2be04c2017-11-01 15:09:13 +01001/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
Thomas Graf22e38802013-03-29 14:46:52 +01002
3/*
Jarno Rajahalme9dd7f892017-02-09 11:21:59 -08004 * Copyright (c) 2007-2017 Nicira, Inc.
Thomas Graf22e38802013-03-29 14:46:52 +01005 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of version 2 of the GNU General Public
8 * License as published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
18 * 02110-1301, USA
19 */
20
21#ifndef _UAPI__LINUX_OPENVSWITCH_H
22#define _UAPI__LINUX_OPENVSWITCH_H 1
23
24#include <linux/types.h>
25#include <linux/if_ether.h>
26
27/**
28 * struct ovs_header - header for OVS Generic Netlink messages.
29 * @dp_ifindex: ifindex of local port for datapath (0 to make a request not
30 * specific to a datapath).
31 *
32 * Attributes following the header are specific to a particular OVS Generic
33 * Netlink family, but all of the OVS families use this header.
34 */
35
36struct ovs_header {
37 int dp_ifindex;
38};
39
40/* Datapaths. */
41
42#define OVS_DATAPATH_FAMILY "ovs_datapath"
43#define OVS_DATAPATH_MCGROUP "ovs_datapath"
Thomas Graf44da5ae2013-12-13 15:22:19 +010044
45/* V2:
46 * - API users are expected to provide OVS_DP_ATTR_USER_FEATURES
47 * when creating the datapath.
48 */
49#define OVS_DATAPATH_VERSION 2
50
51/* First OVS datapath version to support features */
52#define OVS_DP_VER_FEATURES 2
Thomas Graf22e38802013-03-29 14:46:52 +010053
54enum ovs_datapath_cmd {
55 OVS_DP_CMD_UNSPEC,
56 OVS_DP_CMD_NEW,
57 OVS_DP_CMD_DEL,
58 OVS_DP_CMD_GET,
59 OVS_DP_CMD_SET
60};
61
62/**
63 * enum ovs_datapath_attr - attributes for %OVS_DP_* commands.
64 * @OVS_DP_ATTR_NAME: Name of the network device that serves as the "local
65 * port". This is the name of the network device whose dp_ifindex is given in
66 * the &struct ovs_header. Always present in notifications. Required in
67 * %OVS_DP_NEW requests. May be used as an alternative to specifying
68 * dp_ifindex in other requests (with a dp_ifindex of 0).
69 * @OVS_DP_ATTR_UPCALL_PID: The Netlink socket in userspace that is initially
70 * set on the datapath port (for OVS_ACTION_ATTR_MISS). Only valid on
71 * %OVS_DP_CMD_NEW requests. A value of zero indicates that upcalls should
72 * not be sent.
73 * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the
74 * datapath. Always present in notifications.
Andy Zhou1bd71162013-10-22 10:42:46 -070075 * @OVS_DP_ATTR_MEGAFLOW_STATS: Statistics about mega flow masks usage for the
76 * datapath. Always present in notifications.
Thomas Graf22e38802013-03-29 14:46:52 +010077 *
78 * These attributes follow the &struct ovs_header within the Generic Netlink
79 * payload for %OVS_DP_* commands.
80 */
81enum ovs_datapath_attr {
82 OVS_DP_ATTR_UNSPEC,
Andy Zhou1bd71162013-10-22 10:42:46 -070083 OVS_DP_ATTR_NAME, /* name of dp_ifindex netdev */
84 OVS_DP_ATTR_UPCALL_PID, /* Netlink PID to receive upcalls */
85 OVS_DP_ATTR_STATS, /* struct ovs_dp_stats */
86 OVS_DP_ATTR_MEGAFLOW_STATS, /* struct ovs_dp_megaflow_stats */
Thomas Graf43d4be92013-12-13 15:22:18 +010087 OVS_DP_ATTR_USER_FEATURES, /* OVS_DP_F_* */
Nicolas Dichtel66c7a5e2016-04-26 10:06:15 +020088 OVS_DP_ATTR_PAD,
Thomas Graf22e38802013-03-29 14:46:52 +010089 __OVS_DP_ATTR_MAX
90};
91
92#define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
93
94struct ovs_dp_stats {
95 __u64 n_hit; /* Number of flow table matches. */
96 __u64 n_missed; /* Number of flow table misses. */
97 __u64 n_lost; /* Number of misses not sent to userspace. */
98 __u64 n_flows; /* Number of flows present */
99};
100
Andy Zhou1bd71162013-10-22 10:42:46 -0700101struct ovs_dp_megaflow_stats {
102 __u64 n_mask_hit; /* Number of masks used for flow lookups. */
103 __u32 n_masks; /* Number of masks for the datapath. */
104 __u32 pad0; /* Pad for future expension. */
105 __u64 pad1; /* Pad for future expension. */
106 __u64 pad2; /* Pad for future expension. */
107};
108
Thomas Graf22e38802013-03-29 14:46:52 +0100109struct ovs_vport_stats {
110 __u64 rx_packets; /* total packets received */
111 __u64 tx_packets; /* total packets transmitted */
112 __u64 rx_bytes; /* total bytes received */
113 __u64 tx_bytes; /* total bytes transmitted */
114 __u64 rx_errors; /* bad packets received */
115 __u64 tx_errors; /* packet transmit problems */
116 __u64 rx_dropped; /* no space in linux buffers */
117 __u64 tx_dropped; /* no space available in linux */
118};
119
Thomas Graf43d4be92013-12-13 15:22:18 +0100120/* Allow last Netlink attribute to be unaligned */
121#define OVS_DP_F_UNALIGNED (1 << 0)
122
Alex Wang5cd667b2014-07-17 15:14:13 -0700123/* Allow datapath to associate multiple Netlink PIDs to each vport */
124#define OVS_DP_F_VPORT_PIDS (1 << 1)
125
Thomas Graf22e38802013-03-29 14:46:52 +0100126/* Fixed logical ports. */
127#define OVSP_LOCAL ((__u32)0)
128
129/* Packet transfer. */
130
131#define OVS_PACKET_FAMILY "ovs_packet"
132#define OVS_PACKET_VERSION 0x1
133
134enum ovs_packet_cmd {
135 OVS_PACKET_CMD_UNSPEC,
136
137 /* Kernel-to-user notifications. */
138 OVS_PACKET_CMD_MISS, /* Flow table miss. */
139 OVS_PACKET_CMD_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */
140
141 /* Userspace commands. */
142 OVS_PACKET_CMD_EXECUTE /* Apply actions to a packet. */
143};
144
145/**
146 * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
147 * @OVS_PACKET_ATTR_PACKET: Present for all notifications. Contains the entire
148 * packet as received, from the start of the Ethernet header onward. For
149 * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
150 * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
151 * the flow key extracted from the packet as originally received.
152 * @OVS_PACKET_ATTR_KEY: Present for all notifications. Contains the flow key
153 * extracted from the packet as nested %OVS_KEY_ATTR_* attributes. This allows
154 * userspace to adapt its flow setup strategy by comparing its notion of the
155 * flow key against the kernel's.
156 * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet. Used
157 * for %OVS_PACKET_CMD_EXECUTE. It has nested %OVS_ACTION_ATTR_* attributes.
Neil McKeeccea7442015-05-26 20:59:43 -0700158 * Also used in upcall when %OVS_ACTION_ATTR_USERSPACE has optional
159 * %OVS_USERSPACE_ATTR_ACTIONS attribute.
Thomas Graf22e38802013-03-29 14:46:52 +0100160 * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
161 * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
162 * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content
163 * specified there.
Wenyu Zhang8f0aad62014-11-06 06:51:24 -0800164 * @OVS_PACKET_ATTR_EGRESS_TUN_KEY: Present for an %OVS_PACKET_CMD_ACTION
165 * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
166 * %OVS_USERSPACE_ATTR_EGRESS_TUN_PORT attribute, which is sent only if the
167 * output port is actually a tunnel port. Contains the output tunnel key
168 * extracted from the packet as nested %OVS_TUNNEL_KEY_ATTR_* attributes.
Joe Stringer7f8a4362015-08-26 11:31:48 -0700169 * @OVS_PACKET_ATTR_MRU: Present for an %OVS_PACKET_CMD_ACTION and
William Tub95e5922016-06-20 07:26:17 -0700170 * @OVS_PACKET_ATTR_LEN: Packet size before truncation.
Joe Stringer7f8a4362015-08-26 11:31:48 -0700171 * %OVS_PACKET_ATTR_USERSPACE action specify the Maximum received fragment
172 * size.
Thomas Graf22e38802013-03-29 14:46:52 +0100173 *
174 * These attributes follow the &struct ovs_header within the Generic Netlink
175 * payload for %OVS_PACKET_* commands.
176 */
177enum ovs_packet_attr {
178 OVS_PACKET_ATTR_UNSPEC,
179 OVS_PACKET_ATTR_PACKET, /* Packet data. */
180 OVS_PACKET_ATTR_KEY, /* Nested OVS_KEY_ATTR_* attributes. */
181 OVS_PACKET_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
182 OVS_PACKET_ATTR_USERDATA, /* OVS_ACTION_ATTR_USERSPACE arg. */
Wenyu Zhang8f0aad62014-11-06 06:51:24 -0800183 OVS_PACKET_ATTR_EGRESS_TUN_KEY, /* Nested OVS_TUNNEL_KEY_ATTR_*
184 attributes. */
Thomas Graf1ba39802015-01-14 13:56:19 +0000185 OVS_PACKET_ATTR_UNUSED1,
186 OVS_PACKET_ATTR_UNUSED2,
187 OVS_PACKET_ATTR_PROBE, /* Packet operation is a feature probe,
188 error logging should be suppressed. */
Joe Stringer7f8a4362015-08-26 11:31:48 -0700189 OVS_PACKET_ATTR_MRU, /* Maximum received IP fragment size. */
William Tub95e5922016-06-20 07:26:17 -0700190 OVS_PACKET_ATTR_LEN, /* Packet size before truncation. */
Thomas Graf22e38802013-03-29 14:46:52 +0100191 __OVS_PACKET_ATTR_MAX
192};
193
194#define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
195
196/* Virtual ports. */
197
198#define OVS_VPORT_FAMILY "ovs_vport"
199#define OVS_VPORT_MCGROUP "ovs_vport"
200#define OVS_VPORT_VERSION 0x1
201
202enum ovs_vport_cmd {
203 OVS_VPORT_CMD_UNSPEC,
204 OVS_VPORT_CMD_NEW,
205 OVS_VPORT_CMD_DEL,
206 OVS_VPORT_CMD_GET,
207 OVS_VPORT_CMD_SET
208};
209
210enum ovs_vport_type {
211 OVS_VPORT_TYPE_UNSPEC,
212 OVS_VPORT_TYPE_NETDEV, /* network device */
213 OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
Pravin B Shelaraa310702013-06-17 17:50:33 -0700214 OVS_VPORT_TYPE_GRE, /* GRE tunnel. */
Pravin B Shelar58264842013-08-19 11:23:34 -0700215 OVS_VPORT_TYPE_VXLAN, /* VXLAN tunnel. */
Jesse Grossf5796682014-10-03 15:35:33 -0700216 OVS_VPORT_TYPE_GENEVE, /* Geneve tunnel. */
Thomas Graf22e38802013-03-29 14:46:52 +0100217 __OVS_VPORT_TYPE_MAX
218};
219
220#define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
221
222/**
223 * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
224 * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
225 * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
226 * of vport.
227 * @OVS_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device
228 * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes
229 * plus a null terminator.
230 * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information.
Alex Wang5cd667b2014-07-17 15:14:13 -0700231 * @OVS_VPORT_ATTR_UPCALL_PID: The array of Netlink socket pids in userspace
232 * among which OVS_PACKET_CMD_MISS upcalls will be distributed for packets
233 * received on this port. If this is a single-element array of value 0,
234 * upcalls should not be sent.
Thomas Graf22e38802013-03-29 14:46:52 +0100235 * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
236 * packets sent or received through the vport.
237 *
238 * These attributes follow the &struct ovs_header within the Generic Netlink
239 * payload for %OVS_VPORT_* commands.
240 *
241 * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
242 * %OVS_VPORT_ATTR_NAME attributes are required. %OVS_VPORT_ATTR_PORT_NO is
243 * optional; if not specified a free port number is automatically selected.
244 * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
245 * of vport.
Thomas Graf22e38802013-03-29 14:46:52 +0100246 *
247 * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
248 * look up the vport to operate on; otherwise dp_idx from the &struct
249 * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
250 */
251enum ovs_vport_attr {
252 OVS_VPORT_ATTR_UNSPEC,
253 OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */
254 OVS_VPORT_ATTR_TYPE, /* u32 OVS_VPORT_TYPE_* constant. */
255 OVS_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */
256 OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
Alex Wang5cd667b2014-07-17 15:14:13 -0700257 OVS_VPORT_ATTR_UPCALL_PID, /* array of u32 Netlink socket PIDs for */
258 /* receiving upcalls */
Thomas Graf22e38802013-03-29 14:46:52 +0100259 OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */
Nicolas Dichtel66c7a5e2016-04-26 10:06:15 +0200260 OVS_VPORT_ATTR_PAD,
Jiri Benc9354d452017-11-02 17:04:37 -0200261 OVS_VPORT_ATTR_IFINDEX,
262 OVS_VPORT_ATTR_NETNSID,
Thomas Graf22e38802013-03-29 14:46:52 +0100263 __OVS_VPORT_ATTR_MAX
264};
265
266#define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
267
Thomas Graf1dd144c2015-01-15 03:53:59 +0100268enum {
269 OVS_VXLAN_EXT_UNSPEC,
270 OVS_VXLAN_EXT_GBP, /* Flag or __u32 */
271 __OVS_VXLAN_EXT_MAX,
272};
273
274#define OVS_VXLAN_EXT_MAX (__OVS_VXLAN_EXT_MAX - 1)
275
276
Pravin B Shelar58264842013-08-19 11:23:34 -0700277/* OVS_VPORT_ATTR_OPTIONS attributes for tunnels.
278 */
279enum {
280 OVS_TUNNEL_ATTR_UNSPEC,
281 OVS_TUNNEL_ATTR_DST_PORT, /* 16-bit UDP port, used by L4 tunnels. */
Thomas Graf1dd144c2015-01-15 03:53:59 +0100282 OVS_TUNNEL_ATTR_EXTENSION,
Pravin B Shelar58264842013-08-19 11:23:34 -0700283 __OVS_TUNNEL_ATTR_MAX
284};
285
286#define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1)
287
Thomas Graf22e38802013-03-29 14:46:52 +0100288/* Flows. */
289
290#define OVS_FLOW_FAMILY "ovs_flow"
291#define OVS_FLOW_MCGROUP "ovs_flow"
292#define OVS_FLOW_VERSION 0x1
293
294enum ovs_flow_cmd {
295 OVS_FLOW_CMD_UNSPEC,
296 OVS_FLOW_CMD_NEW,
297 OVS_FLOW_CMD_DEL,
298 OVS_FLOW_CMD_GET,
299 OVS_FLOW_CMD_SET
300};
301
302struct ovs_flow_stats {
303 __u64 n_packets; /* Number of matched packets. */
304 __u64 n_bytes; /* Number of matched bytes. */
305};
306
307enum ovs_key_attr {
308 OVS_KEY_ATTR_UNSPEC,
309 OVS_KEY_ATTR_ENCAP, /* Nested set of encapsulated attributes. */
310 OVS_KEY_ATTR_PRIORITY, /* u32 skb->priority */
311 OVS_KEY_ATTR_IN_PORT, /* u32 OVS dp port number */
312 OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */
313 OVS_KEY_ATTR_VLAN, /* be16 VLAN TCI */
314 OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */
315 OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */
316 OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */
317 OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */
318 OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */
319 OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */
320 OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */
321 OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */
322 OVS_KEY_ATTR_ND, /* struct ovs_key_nd */
323 OVS_KEY_ATTR_SKB_MARK, /* u32 skb mark */
Pravin B Shelar7d5437c2013-06-17 17:50:18 -0700324 OVS_KEY_ATTR_TUNNEL, /* Nested set of ovs_tunnel attributes */
Joe Stringera175a722013-08-22 12:30:48 -0700325 OVS_KEY_ATTR_SCTP, /* struct ovs_key_sctp */
Jarno Rajahalme5eb26b12013-10-23 01:44:59 -0700326 OVS_KEY_ATTR_TCP_FLAGS, /* be16 TCP flags. */
Andy Zhou971427f32014-09-15 19:37:25 -0700327 OVS_KEY_ATTR_DP_HASH, /* u32 hash value. Value 0 indicates the hash
328 is not computed by the datapath. */
329 OVS_KEY_ATTR_RECIRC_ID, /* u32 recirc id */
Simon Horman25cd9ba2014-10-06 05:05:13 -0700330 OVS_KEY_ATTR_MPLS, /* array of struct ovs_key_mpls.
331 * The implementation may restrict
332 * the accepted length of the array. */
Joe Stringerfbccce52015-10-06 11:00:00 -0700333 OVS_KEY_ATTR_CT_STATE, /* u32 bitmask of OVS_CS_F_* */
Joe Stringer7f8a4362015-08-26 11:31:48 -0700334 OVS_KEY_ATTR_CT_ZONE, /* u16 connection tracking zone. */
Joe Stringer182e3042015-08-26 11:31:49 -0700335 OVS_KEY_ATTR_CT_MARK, /* u32 connection tracking mark */
Joe Stringer33db4122015-10-01 15:00:37 -0700336 OVS_KEY_ATTR_CT_LABELS, /* 16-octet connection tracking label */
Jarno Rajahalme9dd7f892017-02-09 11:21:59 -0800337 OVS_KEY_ATTR_CT_ORIG_TUPLE_IPV4, /* struct ovs_key_ct_tuple_ipv4 */
338 OVS_KEY_ATTR_CT_ORIG_TUPLE_IPV6, /* struct ovs_key_ct_tuple_ipv6 */
Yi Yangb2d0f5d2017-11-07 21:07:02 +0800339 OVS_KEY_ATTR_NSH, /* Nested set of ovs_nsh_key_* */
Pravin B Shelar7d5437c2013-06-17 17:50:18 -0700340
341#ifdef __KERNEL__
Thomas Graf1d8fff92015-07-21 10:43:54 +0200342 OVS_KEY_ATTR_TUNNEL_INFO, /* struct ip_tunnel_info */
Pravin B Shelar7d5437c2013-06-17 17:50:18 -0700343#endif
Thomas Graf22e38802013-03-29 14:46:52 +0100344 __OVS_KEY_ATTR_MAX
345};
346
347#define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
348
Pravin B Shelar7d5437c2013-06-17 17:50:18 -0700349enum ovs_tunnel_key_attr {
Nicolas Dichteldaa66302017-06-08 10:37:45 +0200350 /* OVS_TUNNEL_KEY_ATTR_NONE, standard nl API requires this attribute! */
Pravin B Shelar7d5437c2013-06-17 17:50:18 -0700351 OVS_TUNNEL_KEY_ATTR_ID, /* be64 Tunnel ID */
352 OVS_TUNNEL_KEY_ATTR_IPV4_SRC, /* be32 src IP address. */
353 OVS_TUNNEL_KEY_ATTR_IPV4_DST, /* be32 dst IP address. */
354 OVS_TUNNEL_KEY_ATTR_TOS, /* u8 Tunnel IP ToS. */
355 OVS_TUNNEL_KEY_ATTR_TTL, /* u8 Tunnel IP TTL. */
356 OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT, /* No argument, set DF. */
357 OVS_TUNNEL_KEY_ATTR_CSUM, /* No argument. CSUM packet. */
Jesse Gross67fa0342014-10-03 15:35:30 -0700358 OVS_TUNNEL_KEY_ATTR_OAM, /* No argument. OAM frame. */
Jesse Grossf5796682014-10-03 15:35:33 -0700359 OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS, /* Array of Geneve options. */
Wenyu Zhang8f0aad62014-11-06 06:51:24 -0800360 OVS_TUNNEL_KEY_ATTR_TP_SRC, /* be16 src Transport Port. */
361 OVS_TUNNEL_KEY_ATTR_TP_DST, /* be16 dst Transport Port. */
Thomas Graf1dd144c2015-01-15 03:53:59 +0100362 OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS, /* Nested OVS_VXLAN_EXT_* */
Jiri Benc6b26ba32015-10-05 13:09:47 +0200363 OVS_TUNNEL_KEY_ATTR_IPV6_SRC, /* struct in6_addr src IPv6 address. */
364 OVS_TUNNEL_KEY_ATTR_IPV6_DST, /* struct in6_addr dst IPv6 address. */
Nicolas Dichtelb46f6de2016-04-22 17:31:18 +0200365 OVS_TUNNEL_KEY_ATTR_PAD,
William Tufc1372f2018-01-25 13:20:11 -0800366 OVS_TUNNEL_KEY_ATTR_ERSPAN_OPTS, /* struct erspan_metadata */
wenxu18b6f712019-03-28 12:43:23 +0800367 OVS_TUNNEL_KEY_ATTR_IPV4_INFO_BRIDGE, /* No argument. IPV4_INFO_BRIDGE mode.*/
Pravin B Shelar7d5437c2013-06-17 17:50:18 -0700368 __OVS_TUNNEL_KEY_ATTR_MAX
369};
370
371#define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1)
372
Thomas Graf22e38802013-03-29 14:46:52 +0100373/**
374 * enum ovs_frag_type - IPv4 and IPv6 fragment type
375 * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
376 * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
377 * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
378 *
379 * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
380 * ovs_key_ipv6.
381 */
382enum ovs_frag_type {
383 OVS_FRAG_TYPE_NONE,
384 OVS_FRAG_TYPE_FIRST,
385 OVS_FRAG_TYPE_LATER,
386 __OVS_FRAG_TYPE_MAX
387};
388
389#define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
390
391struct ovs_key_ethernet {
392 __u8 eth_src[ETH_ALEN];
393 __u8 eth_dst[ETH_ALEN];
394};
395
Simon Horman25cd9ba2014-10-06 05:05:13 -0700396struct ovs_key_mpls {
397 __be32 mpls_lse;
398};
399
Thomas Graf22e38802013-03-29 14:46:52 +0100400struct ovs_key_ipv4 {
401 __be32 ipv4_src;
402 __be32 ipv4_dst;
403 __u8 ipv4_proto;
404 __u8 ipv4_tos;
405 __u8 ipv4_ttl;
406 __u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */
407};
408
409struct ovs_key_ipv6 {
410 __be32 ipv6_src[4];
411 __be32 ipv6_dst[4];
412 __be32 ipv6_label; /* 20-bits in least-significant bits. */
413 __u8 ipv6_proto;
414 __u8 ipv6_tclass;
415 __u8 ipv6_hlimit;
416 __u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */
417};
418
419struct ovs_key_tcp {
420 __be16 tcp_src;
421 __be16 tcp_dst;
422};
423
424struct ovs_key_udp {
425 __be16 udp_src;
426 __be16 udp_dst;
427};
428
Joe Stringera175a722013-08-22 12:30:48 -0700429struct ovs_key_sctp {
430 __be16 sctp_src;
431 __be16 sctp_dst;
432};
433
Thomas Graf22e38802013-03-29 14:46:52 +0100434struct ovs_key_icmp {
435 __u8 icmp_type;
436 __u8 icmp_code;
437};
438
439struct ovs_key_icmpv6 {
440 __u8 icmpv6_type;
441 __u8 icmpv6_code;
442};
443
444struct ovs_key_arp {
445 __be32 arp_sip;
446 __be32 arp_tip;
447 __be16 arp_op;
448 __u8 arp_sha[ETH_ALEN];
449 __u8 arp_tha[ETH_ALEN];
450};
451
452struct ovs_key_nd {
Jarno Rajahalme1a4e96a2014-09-30 10:52:32 -0700453 __be32 nd_target[4];
454 __u8 nd_sll[ETH_ALEN];
455 __u8 nd_tll[ETH_ALEN];
Thomas Graf22e38802013-03-29 14:46:52 +0100456};
457
Jarno Rajahalmecb80d582017-02-09 11:21:55 -0800458#define OVS_CT_LABELS_LEN_32 4
459#define OVS_CT_LABELS_LEN (OVS_CT_LABELS_LEN_32 * sizeof(__u32))
Joe Stringer33db4122015-10-01 15:00:37 -0700460struct ovs_key_ct_labels {
Jarno Rajahalmecb80d582017-02-09 11:21:55 -0800461 union {
462 __u8 ct_labels[OVS_CT_LABELS_LEN];
463 __u32 ct_labels_32[OVS_CT_LABELS_LEN_32];
464 };
Joe Stringerc2ac6672015-08-26 11:31:52 -0700465};
466
Joe Stringer7f8a4362015-08-26 11:31:48 -0700467/* OVS_KEY_ATTR_CT_STATE flags */
468#define OVS_CS_F_NEW 0x01 /* Beginning of a new connection. */
469#define OVS_CS_F_ESTABLISHED 0x02 /* Part of an existing connection. */
470#define OVS_CS_F_RELATED 0x04 /* Related to an established
471 * connection. */
Joe Stringerfbccce52015-10-06 11:00:00 -0700472#define OVS_CS_F_REPLY_DIR 0x08 /* Flow is in the reply direction. */
473#define OVS_CS_F_INVALID 0x10 /* Could not track connection. */
474#define OVS_CS_F_TRACKED 0x20 /* Conntrack has occurred. */
Jarno Rajahalme05752522016-03-10 10:54:23 -0800475#define OVS_CS_F_SRC_NAT 0x40 /* Packet's source address/port was
476 * mangled by NAT.
477 */
478#define OVS_CS_F_DST_NAT 0x80 /* Packet's destination address/port
479 * was mangled by NAT.
480 */
481
482#define OVS_CS_F_NAT_MASK (OVS_CS_F_SRC_NAT | OVS_CS_F_DST_NAT)
Joe Stringer7f8a4362015-08-26 11:31:48 -0700483
Jarno Rajahalme9dd7f892017-02-09 11:21:59 -0800484struct ovs_key_ct_tuple_ipv4 {
485 __be32 ipv4_src;
486 __be32 ipv4_dst;
487 __be16 src_port;
488 __be16 dst_port;
489 __u8 ipv4_proto;
490};
491
492struct ovs_key_ct_tuple_ipv6 {
493 __be32 ipv6_src[4];
494 __be32 ipv6_dst[4];
495 __be16 src_port;
496 __be16 dst_port;
497 __u8 ipv6_proto;
498};
499
Yi Yangb2d0f5d2017-11-07 21:07:02 +0800500enum ovs_nsh_key_attr {
501 OVS_NSH_KEY_ATTR_UNSPEC,
502 OVS_NSH_KEY_ATTR_BASE, /* struct ovs_nsh_key_base. */
503 OVS_NSH_KEY_ATTR_MD1, /* struct ovs_nsh_key_md1. */
504 OVS_NSH_KEY_ATTR_MD2, /* variable-length octets for MD type 2. */
505 __OVS_NSH_KEY_ATTR_MAX
506};
507
508#define OVS_NSH_KEY_ATTR_MAX (__OVS_NSH_KEY_ATTR_MAX - 1)
509
510struct ovs_nsh_key_base {
511 __u8 flags;
512 __u8 ttl;
513 __u8 mdtype;
514 __u8 np;
515 __be32 path_hdr;
516};
517
518#define NSH_MD1_CONTEXT_SIZE 4
519
520struct ovs_nsh_key_md1 {
521 __be32 context[NSH_MD1_CONTEXT_SIZE];
522};
523
Thomas Graf22e38802013-03-29 14:46:52 +0100524/**
525 * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
526 * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
527 * key. Always present in notifications. Required for all requests (except
528 * dumps).
529 * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
530 * the actions to take for packets that match the key. Always present in
531 * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional for
Jarno Rajahalmebe52c9e2014-05-05 09:59:40 -0700532 * %OVS_FLOW_CMD_SET requests. An %OVS_FLOW_CMD_SET without
533 * %OVS_FLOW_ATTR_ACTIONS will not modify the actions. To clear the actions,
534 * an %OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given.
Thomas Graf22e38802013-03-29 14:46:52 +0100535 * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
536 * flow. Present in notifications if the stats would be nonzero. Ignored in
537 * requests.
538 * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
539 * TCP flags seen on packets in this flow. Only present in notifications for
540 * TCP flows, and only if it would be nonzero. Ignored in requests.
541 * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
542 * the system monotonic clock, at which a packet was last processed for this
543 * flow. Only present in notifications if a packet has been processed for this
544 * flow. Ignored in requests.
545 * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
546 * last-used time, accumulated TCP flags, and statistics for this flow.
547 * Otherwise ignored in requests. Never present in notifications.
Andy Zhou03f0d912013-08-07 20:01:00 -0700548 * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the
549 * mask bits for wildcarded flow match. Mask bit value '1' specifies exact
550 * match with corresponding flow key bit, while mask bit value '0' specifies
551 * a wildcarded match. Omitting attribute is treated as wildcarding all
552 * corresponding fields. Optional for all requests. If not present,
553 * all flow key bits are exact match bits.
Joe Stringer74ed7ab2015-01-21 16:42:52 -0800554 * @OVS_FLOW_ATTR_UFID: A value between 1-16 octets specifying a unique
555 * identifier for the flow. Causes the flow to be indexed by this value rather
556 * than the value of the %OVS_FLOW_ATTR_KEY attribute. Optional for all
557 * requests. Present in notifications if the flow was created with this
558 * attribute.
559 * @OVS_FLOW_ATTR_UFID_FLAGS: A 32-bit value of OR'd %OVS_UFID_F_*
560 * flags that provide alternative semantics for flow installation and
561 * retrieval. Optional for all requests.
Thomas Graf22e38802013-03-29 14:46:52 +0100562 *
563 * These attributes follow the &struct ovs_header within the Generic Netlink
564 * payload for %OVS_FLOW_* commands.
565 */
566enum ovs_flow_attr {
567 OVS_FLOW_ATTR_UNSPEC,
568 OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */
569 OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
570 OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */
571 OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
572 OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */
573 OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */
Andy Zhou03f0d912013-08-07 20:01:00 -0700574 OVS_FLOW_ATTR_MASK, /* Sequence of OVS_KEY_ATTR_* attributes. */
Jarno Rajahalme05da5892014-11-06 07:03:05 -0800575 OVS_FLOW_ATTR_PROBE, /* Flow operation is a feature probe, error
576 * logging should be suppressed. */
Joe Stringer74ed7ab2015-01-21 16:42:52 -0800577 OVS_FLOW_ATTR_UFID, /* Variable length unique flow identifier. */
578 OVS_FLOW_ATTR_UFID_FLAGS,/* u32 of OVS_UFID_F_*. */
Nicolas Dichtel0238b722016-04-25 10:25:17 +0200579 OVS_FLOW_ATTR_PAD,
Thomas Graf22e38802013-03-29 14:46:52 +0100580 __OVS_FLOW_ATTR_MAX
581};
582
583#define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
584
585/**
Joe Stringer74ed7ab2015-01-21 16:42:52 -0800586 * Omit attributes for notifications.
587 *
588 * If a datapath request contains an %OVS_UFID_F_OMIT_* flag, then the datapath
589 * may omit the corresponding %OVS_FLOW_ATTR_* from the response.
590 */
591#define OVS_UFID_F_OMIT_KEY (1 << 0)
592#define OVS_UFID_F_OMIT_MASK (1 << 1)
593#define OVS_UFID_F_OMIT_ACTIONS (1 << 2)
594
595/**
Thomas Graf22e38802013-03-29 14:46:52 +0100596 * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
597 * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
598 * @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of
599 * %UINT32_MAX samples all packets and intermediate values sample intermediate
600 * fractions of packets.
601 * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
602 * Actions are passed as nested attributes.
603 *
604 * Executes the specified actions with the given probability on a per-packet
605 * basis.
606 */
607enum ovs_sample_attr {
608 OVS_SAMPLE_ATTR_UNSPEC,
609 OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
610 OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
611 __OVS_SAMPLE_ATTR_MAX,
andy zhou798c1662017-03-20 16:32:29 -0700612
613#ifdef __KERNEL__
614 OVS_SAMPLE_ATTR_ARG /* struct sample_arg */
615#endif
Thomas Graf22e38802013-03-29 14:46:52 +0100616};
617
618#define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
619
andy zhou798c1662017-03-20 16:32:29 -0700620#ifdef __KERNEL__
621struct sample_arg {
622 bool exec; /* When true, actions in sample will not
623 * change flow keys. False otherwise.
624 */
625 u32 probability; /* Same value as
626 * 'OVS_SAMPLE_ATTR_PROBABILITY'.
627 */
628};
629#endif
630
Thomas Graf22e38802013-03-29 14:46:52 +0100631/**
632 * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
633 * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
634 * message should be sent. Required.
635 * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is
636 * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA.
Wenyu Zhang8f0aad62014-11-06 06:51:24 -0800637 * @OVS_USERSPACE_ATTR_EGRESS_TUN_PORT: If present, u32 output port to get
638 * tunnel info.
Neil McKeeccea7442015-05-26 20:59:43 -0700639 * @OVS_USERSPACE_ATTR_ACTIONS: If present, send actions with upcall.
Thomas Graf22e38802013-03-29 14:46:52 +0100640 */
641enum ovs_userspace_attr {
642 OVS_USERSPACE_ATTR_UNSPEC,
643 OVS_USERSPACE_ATTR_PID, /* u32 Netlink PID to receive upcalls. */
644 OVS_USERSPACE_ATTR_USERDATA, /* Optional user-specified cookie. */
Wenyu Zhang8f0aad62014-11-06 06:51:24 -0800645 OVS_USERSPACE_ATTR_EGRESS_TUN_PORT, /* Optional, u32 output port
646 * to get tunnel info. */
Neil McKeeccea7442015-05-26 20:59:43 -0700647 OVS_USERSPACE_ATTR_ACTIONS, /* Optional flag to get actions. */
Thomas Graf22e38802013-03-29 14:46:52 +0100648 __OVS_USERSPACE_ATTR_MAX
649};
650
651#define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
652
William Tuf2a4d082016-06-10 11:49:33 -0700653struct ovs_action_trunc {
Mikko Rapelia1d1f652016-08-22 20:33:19 +0200654 __u32 max_len; /* Max packet size in bytes. */
William Tuf2a4d082016-06-10 11:49:33 -0700655};
656
Thomas Graf22e38802013-03-29 14:46:52 +0100657/**
Simon Horman25cd9ba2014-10-06 05:05:13 -0700658 * struct ovs_action_push_mpls - %OVS_ACTION_ATTR_PUSH_MPLS action argument.
659 * @mpls_lse: MPLS label stack entry to push.
660 * @mpls_ethertype: Ethertype to set in the encapsulating ethernet frame.
661 *
662 * The only values @mpls_ethertype should ever be given are %ETH_P_MPLS_UC and
663 * %ETH_P_MPLS_MC, indicating MPLS unicast or multicast. Other are rejected.
664 */
665struct ovs_action_push_mpls {
666 __be32 mpls_lse;
667 __be16 mpls_ethertype; /* Either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC */
668};
669
670/**
Thomas Graf22e38802013-03-29 14:46:52 +0100671 * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument.
672 * @vlan_tpid: Tag protocol identifier (TPID) to push.
673 * @vlan_tci: Tag control identifier (TCI) to push. The CFI bit must be set
674 * (but it will not be set in the 802.1Q header that is pushed).
675 *
Thomas F Herbert8c146bb2016-09-07 12:56:57 -0400676 * The @vlan_tpid value is typically %ETH_P_8021Q or %ETH_P_8021AD.
677 * The only acceptable TPID values are those that the kernel module also parses
678 * as 802.1Q or 802.1AD headers, to prevent %OVS_ACTION_ATTR_PUSH_VLAN followed
679 * by %OVS_ACTION_ATTR_POP_VLAN from having surprising results.
Thomas Graf22e38802013-03-29 14:46:52 +0100680 */
681struct ovs_action_push_vlan {
Thomas F Herbert8c146bb2016-09-07 12:56:57 -0400682 __be16 vlan_tpid; /* 802.1Q or 802.1ad TPID. */
Thomas Graf22e38802013-03-29 14:46:52 +0100683 __be16 vlan_tci; /* 802.1Q TCI (VLAN ID and priority). */
684};
685
Andy Zhou971427f32014-09-15 19:37:25 -0700686/* Data path hash algorithm for computing Datapath hash.
687 *
688 * The algorithm type only specifies the fields in a flow
689 * will be used as part of the hash. Each datapath is free
690 * to use its own hash algorithm. The hash value will be
691 * opaque to the user space daemon.
692 */
693enum ovs_hash_alg {
694 OVS_HASH_ALG_L4,
695};
696
697/*
698 * struct ovs_action_hash - %OVS_ACTION_ATTR_HASH action argument.
699 * @hash_alg: Algorithm used to compute hash prior to recirculation.
700 * @hash_basis: basis used for computing hash.
701 */
702struct ovs_action_hash {
Mikko Rapelie6571aa2016-08-22 20:32:55 +0200703 __u32 hash_alg; /* One of ovs_hash_alg. */
704 __u32 hash_basis;
Andy Zhou971427f32014-09-15 19:37:25 -0700705};
706
Thomas Graf22e38802013-03-29 14:46:52 +0100707/**
Joe Stringer7f8a4362015-08-26 11:31:48 -0700708 * enum ovs_ct_attr - Attributes for %OVS_ACTION_ATTR_CT action.
Joe Stringerab38a7b2015-10-06 11:00:01 -0700709 * @OVS_CT_ATTR_COMMIT: If present, commits the connection to the conntrack
710 * table. This allows future packets for the same connection to be identified
Joe Stringer1d008a12015-10-19 19:18:58 -0700711 * as 'established' or 'related'. The flow key for the current packet will
712 * retain the pre-commit connection state.
Joe Stringer7f8a4362015-08-26 11:31:48 -0700713 * @OVS_CT_ATTR_ZONE: u16 connection tracking zone.
Joe Stringer182e3042015-08-26 11:31:49 -0700714 * @OVS_CT_ATTR_MARK: u32 value followed by u32 mask. For each bit set in the
715 * mask, the corresponding bit in the value is copied to the connection
716 * tracking mark field in the connection.
Paolo Abenie5f5d742015-12-14 14:29:58 +0100717 * @OVS_CT_ATTR_LABELS: %OVS_CT_LABELS_LEN value followed by %OVS_CT_LABELS_LEN
Joe Stringerc2ac6672015-08-26 11:31:52 -0700718 * mask. For each bit set in the mask, the corresponding bit in the value is
719 * copied to the connection tracking label field in the connection.
Joe Stringercae3a262015-08-26 11:31:53 -0700720 * @OVS_CT_ATTR_HELPER: variable length string defining conntrack ALG.
Jarno Rajahalme05752522016-03-10 10:54:23 -0800721 * @OVS_CT_ATTR_NAT: Nested OVS_NAT_ATTR_* for performing L3 network address
722 * translation (NAT) on the packet.
Jarno Rajahalmedd41d332017-02-09 11:22:00 -0800723 * @OVS_CT_ATTR_FORCE_COMMIT: Like %OVS_CT_ATTR_COMMIT, but instead of doing
724 * nothing if the connection is already committed will check that the current
725 * packet is in conntrack entry's original direction. If directionality does
726 * not match, will delete the existing conntrack entry and commit a new one.
Jarno Rajahalme12064552017-04-21 16:48:06 -0700727 * @OVS_CT_ATTR_EVENTMASK: Mask of bits indicating which conntrack event types
728 * (enum ip_conntrack_events IPCT_*) should be reported. For any bit set to
729 * zero, the corresponding event type is not generated. Default behavior
730 * depends on system configuration, but typically all event types are
731 * generated, hence listening on NFNLGRP_CONNTRACK_UPDATE events may get a lot
732 * of events. Explicitly passing this attribute allows limiting the updates
733 * received to the events of interest. The bit 1 << IPCT_NEW, 1 <<
734 * IPCT_RELATED, and 1 << IPCT_DESTROY must be set to ones for those events to
735 * be received on NFNLGRP_CONNTRACK_NEW and NFNLGRP_CONNTRACK_DESTROY groups,
736 * respectively. Remaining bits control the changes for which an event is
737 * delivered on the NFNLGRP_CONNTRACK_UPDATE group.
Yi-Hung Wei06bd2bd2019-03-26 11:31:14 -0700738 * @OVS_CT_ATTR_TIMEOUT: Variable length string defining conntrack timeout.
Joe Stringer7f8a4362015-08-26 11:31:48 -0700739 */
740enum ovs_ct_attr {
741 OVS_CT_ATTR_UNSPEC,
Joe Stringerab38a7b2015-10-06 11:00:01 -0700742 OVS_CT_ATTR_COMMIT, /* No argument, commits connection. */
Joe Stringer7f8a4362015-08-26 11:31:48 -0700743 OVS_CT_ATTR_ZONE, /* u16 zone id. */
Joe Stringer182e3042015-08-26 11:31:49 -0700744 OVS_CT_ATTR_MARK, /* mark to associate with this connection. */
Joe Stringer33db4122015-10-01 15:00:37 -0700745 OVS_CT_ATTR_LABELS, /* labels to associate with this connection. */
Joe Stringercae3a262015-08-26 11:31:53 -0700746 OVS_CT_ATTR_HELPER, /* netlink helper to assist detection of
747 related connections. */
Jarno Rajahalme05752522016-03-10 10:54:23 -0800748 OVS_CT_ATTR_NAT, /* Nested OVS_NAT_ATTR_* */
Jarno Rajahalmedd41d332017-02-09 11:22:00 -0800749 OVS_CT_ATTR_FORCE_COMMIT, /* No argument */
Jarno Rajahalme12064552017-04-21 16:48:06 -0700750 OVS_CT_ATTR_EVENTMASK, /* u32 mask of IPCT_* events. */
Yi-Hung Wei06bd2bd2019-03-26 11:31:14 -0700751 OVS_CT_ATTR_TIMEOUT, /* Associate timeout with this connection for
752 * fine-grain timeout tuning. */
Joe Stringer7f8a4362015-08-26 11:31:48 -0700753 __OVS_CT_ATTR_MAX
754};
755
756#define OVS_CT_ATTR_MAX (__OVS_CT_ATTR_MAX - 1)
757
Joe Stringer7f8a4362015-08-26 11:31:48 -0700758/**
Jarno Rajahalme05752522016-03-10 10:54:23 -0800759 * enum ovs_nat_attr - Attributes for %OVS_CT_ATTR_NAT.
760 *
761 * @OVS_NAT_ATTR_SRC: Flag for Source NAT (mangle source address/port).
762 * @OVS_NAT_ATTR_DST: Flag for Destination NAT (mangle destination
763 * address/port). Only one of (@OVS_NAT_ATTR_SRC, @OVS_NAT_ATTR_DST) may be
764 * specified. Effective only for packets for ct_state NEW connections.
765 * Packets of committed connections are mangled by the NAT action according to
766 * the committed NAT type regardless of the flags specified. As a corollary, a
767 * NAT action without a NAT type flag will only mangle packets of committed
768 * connections. The following NAT attributes only apply for NEW
769 * (non-committed) connections, and they may be included only when the CT
770 * action has the @OVS_CT_ATTR_COMMIT flag and either @OVS_NAT_ATTR_SRC or
771 * @OVS_NAT_ATTR_DST is also included.
772 * @OVS_NAT_ATTR_IP_MIN: struct in_addr or struct in6_addr
773 * @OVS_NAT_ATTR_IP_MAX: struct in_addr or struct in6_addr
774 * @OVS_NAT_ATTR_PROTO_MIN: u16 L4 protocol specific lower boundary (port)
775 * @OVS_NAT_ATTR_PROTO_MAX: u16 L4 protocol specific upper boundary (port)
776 * @OVS_NAT_ATTR_PERSISTENT: Flag for persistent IP mapping across reboots
777 * @OVS_NAT_ATTR_PROTO_HASH: Flag for pseudo random L4 port mapping (MD5)
778 * @OVS_NAT_ATTR_PROTO_RANDOM: Flag for fully randomized L4 port mapping
779 */
780enum ovs_nat_attr {
781 OVS_NAT_ATTR_UNSPEC,
782 OVS_NAT_ATTR_SRC,
783 OVS_NAT_ATTR_DST,
784 OVS_NAT_ATTR_IP_MIN,
785 OVS_NAT_ATTR_IP_MAX,
786 OVS_NAT_ATTR_PROTO_MIN,
787 OVS_NAT_ATTR_PROTO_MAX,
788 OVS_NAT_ATTR_PERSISTENT,
789 OVS_NAT_ATTR_PROTO_HASH,
790 OVS_NAT_ATTR_PROTO_RANDOM,
791 __OVS_NAT_ATTR_MAX,
792};
793
794#define OVS_NAT_ATTR_MAX (__OVS_NAT_ATTR_MAX - 1)
795
Jiri Benc91820da2016-11-10 16:28:23 +0100796/*
797 * struct ovs_action_push_eth - %OVS_ACTION_ATTR_PUSH_ETH action argument.
798 * @addresses: Source and destination MAC addresses.
799 * @eth_type: Ethernet type
800 */
801struct ovs_action_push_eth {
802 struct ovs_key_ethernet addresses;
803};
804
Numan Siddique4d5ec892019-03-26 06:13:46 +0530805/*
806 * enum ovs_check_pkt_len_attr - Attributes for %OVS_ACTION_ATTR_CHECK_PKT_LEN.
807 *
808 * @OVS_CHECK_PKT_LEN_ATTR_PKT_LEN: u16 Packet length to check for.
809 * @OVS_CHECK_PKT_LEN_ATTR_ACTIONS_IF_GREATER: Nested OVS_ACTION_ATTR_*
810 * actions to apply if the packer length is greater than the specified
811 * length in the attr - OVS_CHECK_PKT_LEN_ATTR_PKT_LEN.
812 * @OVS_CHECK_PKT_LEN_ATTR_ACTIONS_IF_LESS_EQUAL - Nested OVS_ACTION_ATTR_*
813 * actions to apply if the packer length is lesser or equal to the specified
814 * length in the attr - OVS_CHECK_PKT_LEN_ATTR_PKT_LEN.
815 */
816enum ovs_check_pkt_len_attr {
817 OVS_CHECK_PKT_LEN_ATTR_UNSPEC,
818 OVS_CHECK_PKT_LEN_ATTR_PKT_LEN,
819 OVS_CHECK_PKT_LEN_ATTR_ACTIONS_IF_GREATER,
820 OVS_CHECK_PKT_LEN_ATTR_ACTIONS_IF_LESS_EQUAL,
821 __OVS_CHECK_PKT_LEN_ATTR_MAX,
822
823#ifdef __KERNEL__
824 OVS_CHECK_PKT_LEN_ATTR_ARG /* struct check_pkt_len_arg */
825#endif
826};
827
828#define OVS_CHECK_PKT_LEN_ATTR_MAX (__OVS_CHECK_PKT_LEN_ATTR_MAX - 1)
829
830#ifdef __KERNEL__
831struct check_pkt_len_arg {
832 u16 pkt_len; /* Same value as OVS_CHECK_PKT_LEN_ATTR_PKT_LEN'. */
833 bool exec_for_greater; /* When true, actions in IF_GREATER will
834 * not change flow keys. False otherwise.
835 */
836 bool exec_for_lesser_equal; /* When true, actions in IF_LESS_EQUAL
837 * will not change flow keys. False
838 * otherwise.
839 */
840};
841#endif
842
Jarno Rajahalme05752522016-03-10 10:54:23 -0800843/**
Thomas Graf22e38802013-03-29 14:46:52 +0100844 * enum ovs_action_attr - Action types.
845 *
846 * @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
William Tuf2a4d082016-06-10 11:49:33 -0700847 * @OVS_ACTION_ATTR_TRUNC: Output packet to port with truncated packet size.
Thomas Graf22e38802013-03-29 14:46:52 +0100848 * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
849 * %OVS_USERSPACE_ATTR_* attributes.
850 * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header. The
851 * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its
852 * value.
Jarno Rajahalme83d2b9b2015-02-05 13:40:49 -0800853 * @OVS_ACTION_ATTR_SET_MASKED: Replaces the contents of an existing header. A
854 * nested %OVS_KEY_ATTR_* attribute specifies a header to modify, its value,
855 * and a mask. For every bit set in the mask, the corresponding bit value
856 * is copied from the value to the packet header field, rest of the bits are
857 * left unchanged. The non-masked value bits must be passed in as zeroes.
858 * Masking is not supported for the %OVS_KEY_ATTR_TUNNEL attribute.
Thomas F Herbert8c146bb2016-09-07 12:56:57 -0400859 * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q or 802.1ad header
860 * onto the packet.
861 * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q or 802.1ad header
862 * from the packet.
Thomas Graf22e38802013-03-29 14:46:52 +0100863 * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
864 * the nested %OVS_SAMPLE_ATTR_* attributes.
Simon Horman25cd9ba2014-10-06 05:05:13 -0700865 * @OVS_ACTION_ATTR_PUSH_MPLS: Push a new MPLS label stack entry onto the
866 * top of the packets MPLS label stack. Set the ethertype of the
867 * encapsulating frame to either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC to
868 * indicate the new packet contents.
869 * @OVS_ACTION_ATTR_POP_MPLS: Pop an MPLS label stack entry off of the
870 * packet's MPLS label stack. Set the encapsulating frame's ethertype to
871 * indicate the new packet contents. This could potentially still be
872 * %ETH_P_MPLS if the resulting MPLS label stack is not empty. If there
873 * is no MPLS label stack, as determined by ethertype, no action is taken.
Joe Stringer7f8a4362015-08-26 11:31:48 -0700874 * @OVS_ACTION_ATTR_CT: Track the connection. Populate the conntrack-related
875 * entries in the flow key.
Jiri Benc91820da2016-11-10 16:28:23 +0100876 * @OVS_ACTION_ATTR_PUSH_ETH: Push a new outermost Ethernet header onto the
877 * packet.
878 * @OVS_ACTION_ATTR_POP_ETH: Pop the outermost Ethernet header off the
879 * packet.
Eric Garverb8226962017-10-10 16:54:44 -0400880 * @OVS_ACTION_ATTR_CT_CLEAR: Clear conntrack state from the packet.
Yi Yangb2d0f5d2017-11-07 21:07:02 +0800881 * @OVS_ACTION_ATTR_PUSH_NSH: push NSH header to the packet.
882 * @OVS_ACTION_ATTR_POP_NSH: pop the outermost NSH header off the packet.
Andy Zhoucd8a6c32017-11-10 12:09:43 -0800883 * @OVS_ACTION_ATTR_METER: Run packet through a meter, which may drop the
884 * packet, or modify the packet (e.g., change the DSCP field).
Yifeng Sunb2335042018-07-02 08:18:03 -0700885 * @OVS_ACTION_ATTR_CLONE: make a copy of the packet and execute a list of
886 * actions without affecting the original packet and key.
Numan Siddique4d5ec892019-03-26 06:13:46 +0530887 * @OVS_ACTION_ATTR_CHECK_PKT_LEN: Check the packet length and execute a set
888 * of actions if greater than the specified packet length, else execute
889 * another set of actions.
Thomas Graf22e38802013-03-29 14:46:52 +0100890 *
891 * Only a single header can be set with a single %OVS_ACTION_ATTR_SET. Not all
892 * fields within a header are modifiable, e.g. the IPv4 protocol and fragment
893 * type may not be changed.
Jarno Rajahalme83d2b9b2015-02-05 13:40:49 -0800894 *
895 * @OVS_ACTION_ATTR_SET_TO_MASKED: Kernel internal masked set action translated
896 * from the @OVS_ACTION_ATTR_SET.
Thomas Graf22e38802013-03-29 14:46:52 +0100897 */
898
899enum ovs_action_attr {
900 OVS_ACTION_ATTR_UNSPEC,
901 OVS_ACTION_ATTR_OUTPUT, /* u32 port number. */
902 OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */
903 OVS_ACTION_ATTR_SET, /* One nested OVS_KEY_ATTR_*. */
904 OVS_ACTION_ATTR_PUSH_VLAN, /* struct ovs_action_push_vlan. */
905 OVS_ACTION_ATTR_POP_VLAN, /* No argument. */
906 OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */
Andy Zhou971427f32014-09-15 19:37:25 -0700907 OVS_ACTION_ATTR_RECIRC, /* u32 recirc_id. */
908 OVS_ACTION_ATTR_HASH, /* struct ovs_action_hash. */
Simon Horman25cd9ba2014-10-06 05:05:13 -0700909 OVS_ACTION_ATTR_PUSH_MPLS, /* struct ovs_action_push_mpls. */
910 OVS_ACTION_ATTR_POP_MPLS, /* __be16 ethertype. */
Jarno Rajahalme83d2b9b2015-02-05 13:40:49 -0800911 OVS_ACTION_ATTR_SET_MASKED, /* One nested OVS_KEY_ATTR_* including
912 * data immediately followed by a mask.
913 * The data must be zero for the unmasked
914 * bits. */
Joe Stringer0a7cc172015-10-06 10:59:56 -0700915 OVS_ACTION_ATTR_CT, /* Nested OVS_CT_ATTR_* . */
William Tuf2a4d082016-06-10 11:49:33 -0700916 OVS_ACTION_ATTR_TRUNC, /* u32 struct ovs_action_trunc. */
Jiri Benc91820da2016-11-10 16:28:23 +0100917 OVS_ACTION_ATTR_PUSH_ETH, /* struct ovs_action_push_eth. */
918 OVS_ACTION_ATTR_POP_ETH, /* No argument. */
Eric Garverb8226962017-10-10 16:54:44 -0400919 OVS_ACTION_ATTR_CT_CLEAR, /* No argument. */
Yi Yangb2d0f5d2017-11-07 21:07:02 +0800920 OVS_ACTION_ATTR_PUSH_NSH, /* Nested OVS_NSH_KEY_ATTR_*. */
921 OVS_ACTION_ATTR_POP_NSH, /* No argument. */
Andy Zhoucd8a6c32017-11-10 12:09:43 -0800922 OVS_ACTION_ATTR_METER, /* u32 meter ID. */
Yifeng Sunb2335042018-07-02 08:18:03 -0700923 OVS_ACTION_ATTR_CLONE, /* Nested OVS_CLONE_ATTR_*. */
Numan Siddique4d5ec892019-03-26 06:13:46 +0530924 OVS_ACTION_ATTR_CHECK_PKT_LEN, /* Nested OVS_CHECK_PKT_LEN_ATTR_*. */
Simon Horman25cd9ba2014-10-06 05:05:13 -0700925
Jarno Rajahalme83d2b9b2015-02-05 13:40:49 -0800926 __OVS_ACTION_ATTR_MAX, /* Nothing past this will be accepted
927 * from userspace. */
928
929#ifdef __KERNEL__
930 OVS_ACTION_ATTR_SET_TO_MASKED, /* Kernel module internal masked
931 * set action converted from
932 * OVS_ACTION_ATTR_SET. */
933#endif
Thomas Graf22e38802013-03-29 14:46:52 +0100934};
935
936#define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
937
Andy Zhou579404062017-11-10 12:09:40 -0800938/* Meters. */
939#define OVS_METER_FAMILY "ovs_meter"
940#define OVS_METER_MCGROUP "ovs_meter"
941#define OVS_METER_VERSION 0x1
942
943enum ovs_meter_cmd {
944 OVS_METER_CMD_UNSPEC,
945 OVS_METER_CMD_FEATURES, /* Get features supported by the datapath. */
946 OVS_METER_CMD_SET, /* Add or modify a meter. */
947 OVS_METER_CMD_DEL, /* Delete a meter. */
948 OVS_METER_CMD_GET /* Get meter stats. */
949};
950
951enum ovs_meter_attr {
952 OVS_METER_ATTR_UNSPEC,
953 OVS_METER_ATTR_ID, /* u32 meter ID within datapath. */
954 OVS_METER_ATTR_KBPS, /* No argument. If set, units in kilobits
955 * per second. Otherwise, units in
956 * packets per second.
957 */
958 OVS_METER_ATTR_STATS, /* struct ovs_flow_stats for the meter. */
959 OVS_METER_ATTR_BANDS, /* Nested attributes for meter bands. */
960 OVS_METER_ATTR_USED, /* u64 msecs last used in monotonic time. */
961 OVS_METER_ATTR_CLEAR, /* Flag to clear stats, used. */
962 OVS_METER_ATTR_MAX_METERS, /* u32 number of meters supported. */
963 OVS_METER_ATTR_MAX_BANDS, /* u32 max number of bands per meter. */
964 OVS_METER_ATTR_PAD,
965 __OVS_METER_ATTR_MAX
966};
967
968#define OVS_METER_ATTR_MAX (__OVS_METER_ATTR_MAX - 1)
969
970enum ovs_band_attr {
971 OVS_BAND_ATTR_UNSPEC,
972 OVS_BAND_ATTR_TYPE, /* u32 OVS_METER_BAND_TYPE_* constant. */
973 OVS_BAND_ATTR_RATE, /* u32 band rate in meter units (see above). */
974 OVS_BAND_ATTR_BURST, /* u32 burst size in meter units. */
975 OVS_BAND_ATTR_STATS, /* struct ovs_flow_stats for the band. */
976 __OVS_BAND_ATTR_MAX
977};
978
979#define OVS_BAND_ATTR_MAX (__OVS_BAND_ATTR_MAX - 1)
980
981enum ovs_meter_band_type {
982 OVS_METER_BAND_TYPE_UNSPEC,
983 OVS_METER_BAND_TYPE_DROP, /* Drop exceeding packets. */
984 __OVS_METER_BAND_TYPE_MAX
985};
986
987#define OVS_METER_BAND_TYPE_MAX (__OVS_METER_BAND_TYPE_MAX - 1)
988
Yi-Hung Wei5972be62018-05-24 17:56:42 -0700989/* Conntrack limit */
990#define OVS_CT_LIMIT_FAMILY "ovs_ct_limit"
991#define OVS_CT_LIMIT_MCGROUP "ovs_ct_limit"
992#define OVS_CT_LIMIT_VERSION 0x1
993
994enum ovs_ct_limit_cmd {
995 OVS_CT_LIMIT_CMD_UNSPEC,
996 OVS_CT_LIMIT_CMD_SET, /* Add or modify ct limit. */
997 OVS_CT_LIMIT_CMD_DEL, /* Delete ct limit. */
998 OVS_CT_LIMIT_CMD_GET /* Get ct limit. */
999};
1000
1001enum ovs_ct_limit_attr {
1002 OVS_CT_LIMIT_ATTR_UNSPEC,
1003 OVS_CT_LIMIT_ATTR_ZONE_LIMIT, /* Nested struct ovs_zone_limit. */
1004 __OVS_CT_LIMIT_ATTR_MAX
1005};
1006
1007#define OVS_CT_LIMIT_ATTR_MAX (__OVS_CT_LIMIT_ATTR_MAX - 1)
1008
1009#define OVS_ZONE_LIMIT_DEFAULT_ZONE -1
1010
1011struct ovs_zone_limit {
1012 int zone_id;
1013 __u32 limit;
1014 __u32 count;
1015};
1016
Thomas Graf22e38802013-03-29 14:46:52 +01001017#endif /* _LINUX_OPENVSWITCH_H */