]>
Commit | Line | Data |
---|---|---|
e2be04c7 | 1 | /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ |
22e3880a TG |
2 | |
3 | /* | |
9dd7f890 | 4 | * Copyright (c) 2007-2017 Nicira, Inc. |
22e3880a TG |
5 | * |
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 | ||
36 | struct 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" | |
44da5ae5 TG |
44 | |
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 | |
22e3880a TG |
53 | |
54 | enum 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. | |
1bd7116f AZ |
75 | * @OVS_DP_ATTR_MEGAFLOW_STATS: Statistics about mega flow masks usage for the |
76 | * datapath. Always present in notifications. | |
22e3880a TG |
77 | * |
78 | * These attributes follow the &struct ovs_header within the Generic Netlink | |
79 | * payload for %OVS_DP_* commands. | |
80 | */ | |
81 | enum ovs_datapath_attr { | |
82 | OVS_DP_ATTR_UNSPEC, | |
1bd7116f AZ |
83 | 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 */ | |
43d4be9c | 87 | OVS_DP_ATTR_USER_FEATURES, /* OVS_DP_F_* */ |
66c7a5ee | 88 | OVS_DP_ATTR_PAD, |
22e3880a TG |
89 | __OVS_DP_ATTR_MAX |
90 | }; | |
91 | ||
92 | #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1) | |
93 | ||
94 | struct 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 | ||
1bd7116f AZ |
101 | struct 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 | ||
22e3880a TG |
109 | struct 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 | ||
43d4be9c TG |
120 | /* Allow last Netlink attribute to be unaligned */ |
121 | #define OVS_DP_F_UNALIGNED (1 << 0) | |
122 | ||
5cd667b0 AW |
123 | /* Allow datapath to associate multiple Netlink PIDs to each vport */ |
124 | #define OVS_DP_F_VPORT_PIDS (1 << 1) | |
125 | ||
22e3880a TG |
126 | /* 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 | ||
134 | enum 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. | |
ccea7445 NM |
158 | * Also used in upcall when %OVS_ACTION_ATTR_USERSPACE has optional |
159 | * %OVS_USERSPACE_ATTR_ACTIONS attribute. | |
22e3880a TG |
160 | * @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. | |
8f0aad6f WZ |
164 | * @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. | |
7f8a436e | 169 | * @OVS_PACKET_ATTR_MRU: Present for an %OVS_PACKET_CMD_ACTION and |
b95e5928 | 170 | * @OVS_PACKET_ATTR_LEN: Packet size before truncation. |
7f8a436e JS |
171 | * %OVS_PACKET_ATTR_USERSPACE action specify the Maximum received fragment |
172 | * size. | |
22e3880a TG |
173 | * |
174 | * These attributes follow the &struct ovs_header within the Generic Netlink | |
175 | * payload for %OVS_PACKET_* commands. | |
176 | */ | |
177 | enum 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. */ | |
8f0aad6f WZ |
183 | OVS_PACKET_ATTR_EGRESS_TUN_KEY, /* Nested OVS_TUNNEL_KEY_ATTR_* |
184 | attributes. */ | |
1ba39804 TG |
185 | 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. */ | |
7f8a436e | 189 | OVS_PACKET_ATTR_MRU, /* Maximum received IP fragment size. */ |
b95e5928 | 190 | OVS_PACKET_ATTR_LEN, /* Packet size before truncation. */ |
22e3880a TG |
191 | __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 | ||
202 | enum 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 | ||
210 | enum 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 */ | |
aa310701 | 214 | OVS_VPORT_TYPE_GRE, /* GRE tunnel. */ |
58264848 | 215 | OVS_VPORT_TYPE_VXLAN, /* VXLAN tunnel. */ |
f5796684 | 216 | OVS_VPORT_TYPE_GENEVE, /* Geneve tunnel. */ |
22e3880a TG |
217 | __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. | |
5cd667b0 AW |
231 | * @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. | |
22e3880a TG |
235 | * @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. | |
22e3880a TG |
246 | * |
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 | */ | |
251 | enum 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 */ | |
5cd667b0 AW |
257 | OVS_VPORT_ATTR_UPCALL_PID, /* array of u32 Netlink socket PIDs for */ |
258 | /* receiving upcalls */ | |
22e3880a | 259 | OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */ |
66c7a5ee | 260 | OVS_VPORT_ATTR_PAD, |
9354d452 JB |
261 | OVS_VPORT_ATTR_IFINDEX, |
262 | OVS_VPORT_ATTR_NETNSID, | |
22e3880a TG |
263 | __OVS_VPORT_ATTR_MAX |
264 | }; | |
265 | ||
266 | #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1) | |
267 | ||
1dd144cf TG |
268 | enum { |
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 | ||
58264848 PS |
277 | /* OVS_VPORT_ATTR_OPTIONS attributes for tunnels. |
278 | */ | |
279 | enum { | |
280 | OVS_TUNNEL_ATTR_UNSPEC, | |
281 | OVS_TUNNEL_ATTR_DST_PORT, /* 16-bit UDP port, used by L4 tunnels. */ | |
1dd144cf | 282 | OVS_TUNNEL_ATTR_EXTENSION, |
58264848 PS |
283 | __OVS_TUNNEL_ATTR_MAX |
284 | }; | |
285 | ||
286 | #define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1) | |
287 | ||
22e3880a TG |
288 | /* Flows. */ |
289 | ||
290 | #define OVS_FLOW_FAMILY "ovs_flow" | |
291 | #define OVS_FLOW_MCGROUP "ovs_flow" | |
292 | #define OVS_FLOW_VERSION 0x1 | |
293 | ||
294 | enum 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 | ||
302 | struct ovs_flow_stats { | |
303 | __u64 n_packets; /* Number of matched packets. */ | |
304 | __u64 n_bytes; /* Number of matched bytes. */ | |
305 | }; | |
306 | ||
307 | enum 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 */ | |
7d5437c7 | 324 | OVS_KEY_ATTR_TUNNEL, /* Nested set of ovs_tunnel attributes */ |
a175a723 | 325 | OVS_KEY_ATTR_SCTP, /* struct ovs_key_sctp */ |
5eb26b15 | 326 | OVS_KEY_ATTR_TCP_FLAGS, /* be16 TCP flags. */ |
971427f3 AZ |
327 | 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 */ | |
25cd9ba0 SH |
330 | OVS_KEY_ATTR_MPLS, /* array of struct ovs_key_mpls. |
331 | * The implementation may restrict | |
332 | * the accepted length of the array. */ | |
fbccce59 | 333 | OVS_KEY_ATTR_CT_STATE, /* u32 bitmask of OVS_CS_F_* */ |
7f8a436e | 334 | OVS_KEY_ATTR_CT_ZONE, /* u16 connection tracking zone. */ |
182e3042 | 335 | OVS_KEY_ATTR_CT_MARK, /* u32 connection tracking mark */ |
33db4125 | 336 | OVS_KEY_ATTR_CT_LABELS, /* 16-octet connection tracking label */ |
9dd7f890 JR |
337 | 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 */ | |
b2d0f5d5 | 339 | OVS_KEY_ATTR_NSH, /* Nested set of ovs_nsh_key_* */ |
7d5437c7 PS |
340 | |
341 | #ifdef __KERNEL__ | |
1d8fff90 | 342 | OVS_KEY_ATTR_TUNNEL_INFO, /* struct ip_tunnel_info */ |
7d5437c7 | 343 | #endif |
22e3880a TG |
344 | __OVS_KEY_ATTR_MAX |
345 | }; | |
346 | ||
347 | #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1) | |
348 | ||
7d5437c7 | 349 | enum ovs_tunnel_key_attr { |
daa6630a | 350 | /* OVS_TUNNEL_KEY_ATTR_NONE, standard nl API requires this attribute! */ |
7d5437c7 PS |
351 | 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. */ | |
67fa0341 | 358 | OVS_TUNNEL_KEY_ATTR_OAM, /* No argument. OAM frame. */ |
f5796684 | 359 | OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS, /* Array of Geneve options. */ |
8f0aad6f WZ |
360 | OVS_TUNNEL_KEY_ATTR_TP_SRC, /* be16 src Transport Port. */ |
361 | OVS_TUNNEL_KEY_ATTR_TP_DST, /* be16 dst Transport Port. */ | |
1dd144cf | 362 | OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS, /* Nested OVS_VXLAN_EXT_* */ |
6b26ba3a JB |
363 | 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. */ | |
b46f6ded | 365 | OVS_TUNNEL_KEY_ATTR_PAD, |
ceaa001a | 366 | OVS_TUNNEL_KEY_ATTR_ERSPAN_OPTS, /* be32 ERSPAN index. */ |
7d5437c7 PS |
367 | __OVS_TUNNEL_KEY_ATTR_MAX |
368 | }; | |
369 | ||
370 | #define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1) | |
371 | ||
22e3880a TG |
372 | /** |
373 | * enum ovs_frag_type - IPv4 and IPv6 fragment type | |
374 | * @OVS_FRAG_TYPE_NONE: Packet is not a fragment. | |
375 | * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0. | |
376 | * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset. | |
377 | * | |
378 | * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct | |
379 | * ovs_key_ipv6. | |
380 | */ | |
381 | enum ovs_frag_type { | |
382 | OVS_FRAG_TYPE_NONE, | |
383 | OVS_FRAG_TYPE_FIRST, | |
384 | OVS_FRAG_TYPE_LATER, | |
385 | __OVS_FRAG_TYPE_MAX | |
386 | }; | |
387 | ||
388 | #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1) | |
389 | ||
390 | struct ovs_key_ethernet { | |
391 | __u8 eth_src[ETH_ALEN]; | |
392 | __u8 eth_dst[ETH_ALEN]; | |
393 | }; | |
394 | ||
25cd9ba0 SH |
395 | struct ovs_key_mpls { |
396 | __be32 mpls_lse; | |
397 | }; | |
398 | ||
22e3880a TG |
399 | struct ovs_key_ipv4 { |
400 | __be32 ipv4_src; | |
401 | __be32 ipv4_dst; | |
402 | __u8 ipv4_proto; | |
403 | __u8 ipv4_tos; | |
404 | __u8 ipv4_ttl; | |
405 | __u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */ | |
406 | }; | |
407 | ||
408 | struct ovs_key_ipv6 { | |
409 | __be32 ipv6_src[4]; | |
410 | __be32 ipv6_dst[4]; | |
411 | __be32 ipv6_label; /* 20-bits in least-significant bits. */ | |
412 | __u8 ipv6_proto; | |
413 | __u8 ipv6_tclass; | |
414 | __u8 ipv6_hlimit; | |
415 | __u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */ | |
416 | }; | |
417 | ||
418 | struct ovs_key_tcp { | |
419 | __be16 tcp_src; | |
420 | __be16 tcp_dst; | |
421 | }; | |
422 | ||
423 | struct ovs_key_udp { | |
424 | __be16 udp_src; | |
425 | __be16 udp_dst; | |
426 | }; | |
427 | ||
a175a723 JS |
428 | struct ovs_key_sctp { |
429 | __be16 sctp_src; | |
430 | __be16 sctp_dst; | |
431 | }; | |
432 | ||
22e3880a TG |
433 | struct ovs_key_icmp { |
434 | __u8 icmp_type; | |
435 | __u8 icmp_code; | |
436 | }; | |
437 | ||
438 | struct ovs_key_icmpv6 { | |
439 | __u8 icmpv6_type; | |
440 | __u8 icmpv6_code; | |
441 | }; | |
442 | ||
443 | struct ovs_key_arp { | |
444 | __be32 arp_sip; | |
445 | __be32 arp_tip; | |
446 | __be16 arp_op; | |
447 | __u8 arp_sha[ETH_ALEN]; | |
448 | __u8 arp_tha[ETH_ALEN]; | |
449 | }; | |
450 | ||
451 | struct ovs_key_nd { | |
1a4e96a0 JR |
452 | __be32 nd_target[4]; |
453 | __u8 nd_sll[ETH_ALEN]; | |
454 | __u8 nd_tll[ETH_ALEN]; | |
22e3880a TG |
455 | }; |
456 | ||
cb80d58f JR |
457 | #define OVS_CT_LABELS_LEN_32 4 |
458 | #define OVS_CT_LABELS_LEN (OVS_CT_LABELS_LEN_32 * sizeof(__u32)) | |
33db4125 | 459 | struct ovs_key_ct_labels { |
cb80d58f JR |
460 | union { |
461 | __u8 ct_labels[OVS_CT_LABELS_LEN]; | |
462 | __u32 ct_labels_32[OVS_CT_LABELS_LEN_32]; | |
463 | }; | |
c2ac6673 JS |
464 | }; |
465 | ||
7f8a436e JS |
466 | /* OVS_KEY_ATTR_CT_STATE flags */ |
467 | #define OVS_CS_F_NEW 0x01 /* Beginning of a new connection. */ | |
468 | #define OVS_CS_F_ESTABLISHED 0x02 /* Part of an existing connection. */ | |
469 | #define OVS_CS_F_RELATED 0x04 /* Related to an established | |
470 | * connection. */ | |
fbccce59 JS |
471 | #define OVS_CS_F_REPLY_DIR 0x08 /* Flow is in the reply direction. */ |
472 | #define OVS_CS_F_INVALID 0x10 /* Could not track connection. */ | |
473 | #define OVS_CS_F_TRACKED 0x20 /* Conntrack has occurred. */ | |
05752523 JR |
474 | #define OVS_CS_F_SRC_NAT 0x40 /* Packet's source address/port was |
475 | * mangled by NAT. | |
476 | */ | |
477 | #define OVS_CS_F_DST_NAT 0x80 /* Packet's destination address/port | |
478 | * was mangled by NAT. | |
479 | */ | |
480 | ||
481 | #define OVS_CS_F_NAT_MASK (OVS_CS_F_SRC_NAT | OVS_CS_F_DST_NAT) | |
7f8a436e | 482 | |
9dd7f890 JR |
483 | struct ovs_key_ct_tuple_ipv4 { |
484 | __be32 ipv4_src; | |
485 | __be32 ipv4_dst; | |
486 | __be16 src_port; | |
487 | __be16 dst_port; | |
488 | __u8 ipv4_proto; | |
489 | }; | |
490 | ||
491 | struct ovs_key_ct_tuple_ipv6 { | |
492 | __be32 ipv6_src[4]; | |
493 | __be32 ipv6_dst[4]; | |
494 | __be16 src_port; | |
495 | __be16 dst_port; | |
496 | __u8 ipv6_proto; | |
497 | }; | |
498 | ||
b2d0f5d5 YY |
499 | enum ovs_nsh_key_attr { |
500 | OVS_NSH_KEY_ATTR_UNSPEC, | |
501 | OVS_NSH_KEY_ATTR_BASE, /* struct ovs_nsh_key_base. */ | |
502 | OVS_NSH_KEY_ATTR_MD1, /* struct ovs_nsh_key_md1. */ | |
503 | OVS_NSH_KEY_ATTR_MD2, /* variable-length octets for MD type 2. */ | |
504 | __OVS_NSH_KEY_ATTR_MAX | |
505 | }; | |
506 | ||
507 | #define OVS_NSH_KEY_ATTR_MAX (__OVS_NSH_KEY_ATTR_MAX - 1) | |
508 | ||
509 | struct ovs_nsh_key_base { | |
510 | __u8 flags; | |
511 | __u8 ttl; | |
512 | __u8 mdtype; | |
513 | __u8 np; | |
514 | __be32 path_hdr; | |
515 | }; | |
516 | ||
517 | #define NSH_MD1_CONTEXT_SIZE 4 | |
518 | ||
519 | struct ovs_nsh_key_md1 { | |
520 | __be32 context[NSH_MD1_CONTEXT_SIZE]; | |
521 | }; | |
522 | ||
22e3880a TG |
523 | /** |
524 | * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands. | |
525 | * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow | |
526 | * key. Always present in notifications. Required for all requests (except | |
527 | * dumps). | |
528 | * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying | |
529 | * the actions to take for packets that match the key. Always present in | |
530 | * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional for | |
be52c9e9 JR |
531 | * %OVS_FLOW_CMD_SET requests. An %OVS_FLOW_CMD_SET without |
532 | * %OVS_FLOW_ATTR_ACTIONS will not modify the actions. To clear the actions, | |
533 | * an %OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given. | |
22e3880a TG |
534 | * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this |
535 | * flow. Present in notifications if the stats would be nonzero. Ignored in | |
536 | * requests. | |
537 | * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the | |
538 | * TCP flags seen on packets in this flow. Only present in notifications for | |
539 | * TCP flows, and only if it would be nonzero. Ignored in requests. | |
540 | * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on | |
541 | * the system monotonic clock, at which a packet was last processed for this | |
542 | * flow. Only present in notifications if a packet has been processed for this | |
543 | * flow. Ignored in requests. | |
544 | * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the | |
545 | * last-used time, accumulated TCP flags, and statistics for this flow. | |
546 | * Otherwise ignored in requests. Never present in notifications. | |
03f0d916 AZ |
547 | * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the |
548 | * mask bits for wildcarded flow match. Mask bit value '1' specifies exact | |
549 | * match with corresponding flow key bit, while mask bit value '0' specifies | |
550 | * a wildcarded match. Omitting attribute is treated as wildcarding all | |
551 | * corresponding fields. Optional for all requests. If not present, | |
552 | * all flow key bits are exact match bits. | |
74ed7ab9 JS |
553 | * @OVS_FLOW_ATTR_UFID: A value between 1-16 octets specifying a unique |
554 | * identifier for the flow. Causes the flow to be indexed by this value rather | |
555 | * than the value of the %OVS_FLOW_ATTR_KEY attribute. Optional for all | |
556 | * requests. Present in notifications if the flow was created with this | |
557 | * attribute. | |
558 | * @OVS_FLOW_ATTR_UFID_FLAGS: A 32-bit value of OR'd %OVS_UFID_F_* | |
559 | * flags that provide alternative semantics for flow installation and | |
560 | * retrieval. Optional for all requests. | |
22e3880a TG |
561 | * |
562 | * These attributes follow the &struct ovs_header within the Generic Netlink | |
563 | * payload for %OVS_FLOW_* commands. | |
564 | */ | |
565 | enum ovs_flow_attr { | |
566 | OVS_FLOW_ATTR_UNSPEC, | |
567 | OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */ | |
568 | OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */ | |
569 | OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */ | |
570 | OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */ | |
571 | OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */ | |
572 | OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */ | |
03f0d916 | 573 | OVS_FLOW_ATTR_MASK, /* Sequence of OVS_KEY_ATTR_* attributes. */ |
05da5898 JR |
574 | OVS_FLOW_ATTR_PROBE, /* Flow operation is a feature probe, error |
575 | * logging should be suppressed. */ | |
74ed7ab9 JS |
576 | OVS_FLOW_ATTR_UFID, /* Variable length unique flow identifier. */ |
577 | OVS_FLOW_ATTR_UFID_FLAGS,/* u32 of OVS_UFID_F_*. */ | |
0238b720 | 578 | OVS_FLOW_ATTR_PAD, |
22e3880a TG |
579 | __OVS_FLOW_ATTR_MAX |
580 | }; | |
581 | ||
582 | #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1) | |
583 | ||
74ed7ab9 JS |
584 | /** |
585 | * Omit attributes for notifications. | |
586 | * | |
587 | * If a datapath request contains an %OVS_UFID_F_OMIT_* flag, then the datapath | |
588 | * may omit the corresponding %OVS_FLOW_ATTR_* from the response. | |
589 | */ | |
590 | #define OVS_UFID_F_OMIT_KEY (1 << 0) | |
591 | #define OVS_UFID_F_OMIT_MASK (1 << 1) | |
592 | #define OVS_UFID_F_OMIT_ACTIONS (1 << 2) | |
593 | ||
22e3880a TG |
594 | /** |
595 | * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action. | |
596 | * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with | |
597 | * @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of | |
598 | * %UINT32_MAX samples all packets and intermediate values sample intermediate | |
599 | * fractions of packets. | |
600 | * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event. | |
601 | * Actions are passed as nested attributes. | |
602 | * | |
603 | * Executes the specified actions with the given probability on a per-packet | |
604 | * basis. | |
605 | */ | |
606 | enum ovs_sample_attr { | |
607 | OVS_SAMPLE_ATTR_UNSPEC, | |
608 | OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */ | |
609 | OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */ | |
610 | __OVS_SAMPLE_ATTR_MAX, | |
798c1661 | 611 | |
612 | #ifdef __KERNEL__ | |
613 | OVS_SAMPLE_ATTR_ARG /* struct sample_arg */ | |
614 | #endif | |
22e3880a TG |
615 | }; |
616 | ||
617 | #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1) | |
618 | ||
798c1661 | 619 | #ifdef __KERNEL__ |
620 | struct sample_arg { | |
621 | bool exec; /* When true, actions in sample will not | |
622 | * change flow keys. False otherwise. | |
623 | */ | |
624 | u32 probability; /* Same value as | |
625 | * 'OVS_SAMPLE_ATTR_PROBABILITY'. | |
626 | */ | |
627 | }; | |
628 | #endif | |
629 | ||
22e3880a TG |
630 | /** |
631 | * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action. | |
632 | * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION | |
633 | * message should be sent. Required. | |
634 | * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is | |
635 | * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA. | |
8f0aad6f WZ |
636 | * @OVS_USERSPACE_ATTR_EGRESS_TUN_PORT: If present, u32 output port to get |
637 | * tunnel info. | |
ccea7445 | 638 | * @OVS_USERSPACE_ATTR_ACTIONS: If present, send actions with upcall. |
22e3880a TG |
639 | */ |
640 | enum ovs_userspace_attr { | |
641 | OVS_USERSPACE_ATTR_UNSPEC, | |
642 | OVS_USERSPACE_ATTR_PID, /* u32 Netlink PID to receive upcalls. */ | |
643 | OVS_USERSPACE_ATTR_USERDATA, /* Optional user-specified cookie. */ | |
8f0aad6f WZ |
644 | OVS_USERSPACE_ATTR_EGRESS_TUN_PORT, /* Optional, u32 output port |
645 | * to get tunnel info. */ | |
ccea7445 | 646 | OVS_USERSPACE_ATTR_ACTIONS, /* Optional flag to get actions. */ |
22e3880a TG |
647 | __OVS_USERSPACE_ATTR_MAX |
648 | }; | |
649 | ||
650 | #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1) | |
651 | ||
f2a4d086 | 652 | struct ovs_action_trunc { |
a1d1f65f | 653 | __u32 max_len; /* Max packet size in bytes. */ |
f2a4d086 WT |
654 | }; |
655 | ||
25cd9ba0 SH |
656 | /** |
657 | * struct ovs_action_push_mpls - %OVS_ACTION_ATTR_PUSH_MPLS action argument. | |
658 | * @mpls_lse: MPLS label stack entry to push. | |
659 | * @mpls_ethertype: Ethertype to set in the encapsulating ethernet frame. | |
660 | * | |
661 | * The only values @mpls_ethertype should ever be given are %ETH_P_MPLS_UC and | |
662 | * %ETH_P_MPLS_MC, indicating MPLS unicast or multicast. Other are rejected. | |
663 | */ | |
664 | struct ovs_action_push_mpls { | |
665 | __be32 mpls_lse; | |
666 | __be16 mpls_ethertype; /* Either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC */ | |
667 | }; | |
668 | ||
22e3880a TG |
669 | /** |
670 | * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument. | |
671 | * @vlan_tpid: Tag protocol identifier (TPID) to push. | |
672 | * @vlan_tci: Tag control identifier (TCI) to push. The CFI bit must be set | |
673 | * (but it will not be set in the 802.1Q header that is pushed). | |
674 | * | |
8c146bb9 TH |
675 | * The @vlan_tpid value is typically %ETH_P_8021Q or %ETH_P_8021AD. |
676 | * The only acceptable TPID values are those that the kernel module also parses | |
677 | * as 802.1Q or 802.1AD headers, to prevent %OVS_ACTION_ATTR_PUSH_VLAN followed | |
678 | * by %OVS_ACTION_ATTR_POP_VLAN from having surprising results. | |
22e3880a TG |
679 | */ |
680 | struct ovs_action_push_vlan { | |
8c146bb9 | 681 | __be16 vlan_tpid; /* 802.1Q or 802.1ad TPID. */ |
22e3880a TG |
682 | __be16 vlan_tci; /* 802.1Q TCI (VLAN ID and priority). */ |
683 | }; | |
684 | ||
971427f3 AZ |
685 | /* Data path hash algorithm for computing Datapath hash. |
686 | * | |
687 | * The algorithm type only specifies the fields in a flow | |
688 | * will be used as part of the hash. Each datapath is free | |
689 | * to use its own hash algorithm. The hash value will be | |
690 | * opaque to the user space daemon. | |
691 | */ | |
692 | enum ovs_hash_alg { | |
693 | OVS_HASH_ALG_L4, | |
694 | }; | |
695 | ||
696 | /* | |
697 | * struct ovs_action_hash - %OVS_ACTION_ATTR_HASH action argument. | |
698 | * @hash_alg: Algorithm used to compute hash prior to recirculation. | |
699 | * @hash_basis: basis used for computing hash. | |
700 | */ | |
701 | struct ovs_action_hash { | |
e6571aa5 MR |
702 | __u32 hash_alg; /* One of ovs_hash_alg. */ |
703 | __u32 hash_basis; | |
971427f3 AZ |
704 | }; |
705 | ||
7f8a436e JS |
706 | /** |
707 | * enum ovs_ct_attr - Attributes for %OVS_ACTION_ATTR_CT action. | |
ab38a7b5 JS |
708 | * @OVS_CT_ATTR_COMMIT: If present, commits the connection to the conntrack |
709 | * table. This allows future packets for the same connection to be identified | |
1d008a1d JS |
710 | * as 'established' or 'related'. The flow key for the current packet will |
711 | * retain the pre-commit connection state. | |
7f8a436e | 712 | * @OVS_CT_ATTR_ZONE: u16 connection tracking zone. |
182e3042 JS |
713 | * @OVS_CT_ATTR_MARK: u32 value followed by u32 mask. For each bit set in the |
714 | * mask, the corresponding bit in the value is copied to the connection | |
715 | * tracking mark field in the connection. | |
e5f5d747 | 716 | * @OVS_CT_ATTR_LABELS: %OVS_CT_LABELS_LEN value followed by %OVS_CT_LABELS_LEN |
c2ac6673 JS |
717 | * mask. For each bit set in the mask, the corresponding bit in the value is |
718 | * copied to the connection tracking label field in the connection. | |
cae3a262 | 719 | * @OVS_CT_ATTR_HELPER: variable length string defining conntrack ALG. |
05752523 JR |
720 | * @OVS_CT_ATTR_NAT: Nested OVS_NAT_ATTR_* for performing L3 network address |
721 | * translation (NAT) on the packet. | |
dd41d33f JR |
722 | * @OVS_CT_ATTR_FORCE_COMMIT: Like %OVS_CT_ATTR_COMMIT, but instead of doing |
723 | * nothing if the connection is already committed will check that the current | |
724 | * packet is in conntrack entry's original direction. If directionality does | |
725 | * not match, will delete the existing conntrack entry and commit a new one. | |
12064551 JR |
726 | * @OVS_CT_ATTR_EVENTMASK: Mask of bits indicating which conntrack event types |
727 | * (enum ip_conntrack_events IPCT_*) should be reported. For any bit set to | |
728 | * zero, the corresponding event type is not generated. Default behavior | |
729 | * depends on system configuration, but typically all event types are | |
730 | * generated, hence listening on NFNLGRP_CONNTRACK_UPDATE events may get a lot | |
731 | * of events. Explicitly passing this attribute allows limiting the updates | |
732 | * received to the events of interest. The bit 1 << IPCT_NEW, 1 << | |
733 | * IPCT_RELATED, and 1 << IPCT_DESTROY must be set to ones for those events to | |
734 | * be received on NFNLGRP_CONNTRACK_NEW and NFNLGRP_CONNTRACK_DESTROY groups, | |
735 | * respectively. Remaining bits control the changes for which an event is | |
736 | * delivered on the NFNLGRP_CONNTRACK_UPDATE group. | |
7f8a436e JS |
737 | */ |
738 | enum ovs_ct_attr { | |
739 | OVS_CT_ATTR_UNSPEC, | |
ab38a7b5 | 740 | OVS_CT_ATTR_COMMIT, /* No argument, commits connection. */ |
7f8a436e | 741 | OVS_CT_ATTR_ZONE, /* u16 zone id. */ |
182e3042 | 742 | OVS_CT_ATTR_MARK, /* mark to associate with this connection. */ |
33db4125 | 743 | OVS_CT_ATTR_LABELS, /* labels to associate with this connection. */ |
cae3a262 JS |
744 | OVS_CT_ATTR_HELPER, /* netlink helper to assist detection of |
745 | related connections. */ | |
05752523 | 746 | OVS_CT_ATTR_NAT, /* Nested OVS_NAT_ATTR_* */ |
dd41d33f | 747 | OVS_CT_ATTR_FORCE_COMMIT, /* No argument */ |
12064551 | 748 | OVS_CT_ATTR_EVENTMASK, /* u32 mask of IPCT_* events. */ |
7f8a436e JS |
749 | __OVS_CT_ATTR_MAX |
750 | }; | |
751 | ||
752 | #define OVS_CT_ATTR_MAX (__OVS_CT_ATTR_MAX - 1) | |
753 | ||
05752523 JR |
754 | /** |
755 | * enum ovs_nat_attr - Attributes for %OVS_CT_ATTR_NAT. | |
756 | * | |
757 | * @OVS_NAT_ATTR_SRC: Flag for Source NAT (mangle source address/port). | |
758 | * @OVS_NAT_ATTR_DST: Flag for Destination NAT (mangle destination | |
759 | * address/port). Only one of (@OVS_NAT_ATTR_SRC, @OVS_NAT_ATTR_DST) may be | |
760 | * specified. Effective only for packets for ct_state NEW connections. | |
761 | * Packets of committed connections are mangled by the NAT action according to | |
762 | * the committed NAT type regardless of the flags specified. As a corollary, a | |
763 | * NAT action without a NAT type flag will only mangle packets of committed | |
764 | * connections. The following NAT attributes only apply for NEW | |
765 | * (non-committed) connections, and they may be included only when the CT | |
766 | * action has the @OVS_CT_ATTR_COMMIT flag and either @OVS_NAT_ATTR_SRC or | |
767 | * @OVS_NAT_ATTR_DST is also included. | |
768 | * @OVS_NAT_ATTR_IP_MIN: struct in_addr or struct in6_addr | |
769 | * @OVS_NAT_ATTR_IP_MAX: struct in_addr or struct in6_addr | |
770 | * @OVS_NAT_ATTR_PROTO_MIN: u16 L4 protocol specific lower boundary (port) | |
771 | * @OVS_NAT_ATTR_PROTO_MAX: u16 L4 protocol specific upper boundary (port) | |
772 | * @OVS_NAT_ATTR_PERSISTENT: Flag for persistent IP mapping across reboots | |
773 | * @OVS_NAT_ATTR_PROTO_HASH: Flag for pseudo random L4 port mapping (MD5) | |
774 | * @OVS_NAT_ATTR_PROTO_RANDOM: Flag for fully randomized L4 port mapping | |
775 | */ | |
776 | enum ovs_nat_attr { | |
777 | OVS_NAT_ATTR_UNSPEC, | |
778 | OVS_NAT_ATTR_SRC, | |
779 | OVS_NAT_ATTR_DST, | |
780 | OVS_NAT_ATTR_IP_MIN, | |
781 | OVS_NAT_ATTR_IP_MAX, | |
782 | OVS_NAT_ATTR_PROTO_MIN, | |
783 | OVS_NAT_ATTR_PROTO_MAX, | |
784 | OVS_NAT_ATTR_PERSISTENT, | |
785 | OVS_NAT_ATTR_PROTO_HASH, | |
786 | OVS_NAT_ATTR_PROTO_RANDOM, | |
787 | __OVS_NAT_ATTR_MAX, | |
788 | }; | |
789 | ||
790 | #define OVS_NAT_ATTR_MAX (__OVS_NAT_ATTR_MAX - 1) | |
791 | ||
91820da6 JB |
792 | /* |
793 | * struct ovs_action_push_eth - %OVS_ACTION_ATTR_PUSH_ETH action argument. | |
794 | * @addresses: Source and destination MAC addresses. | |
795 | * @eth_type: Ethernet type | |
796 | */ | |
797 | struct ovs_action_push_eth { | |
798 | struct ovs_key_ethernet addresses; | |
799 | }; | |
800 | ||
22e3880a TG |
801 | /** |
802 | * enum ovs_action_attr - Action types. | |
803 | * | |
804 | * @OVS_ACTION_ATTR_OUTPUT: Output packet to port. | |
f2a4d086 | 805 | * @OVS_ACTION_ATTR_TRUNC: Output packet to port with truncated packet size. |
22e3880a TG |
806 | * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested |
807 | * %OVS_USERSPACE_ATTR_* attributes. | |
808 | * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header. The | |
809 | * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its | |
810 | * value. | |
83d2b9ba JR |
811 | * @OVS_ACTION_ATTR_SET_MASKED: Replaces the contents of an existing header. A |
812 | * nested %OVS_KEY_ATTR_* attribute specifies a header to modify, its value, | |
813 | * and a mask. For every bit set in the mask, the corresponding bit value | |
814 | * is copied from the value to the packet header field, rest of the bits are | |
815 | * left unchanged. The non-masked value bits must be passed in as zeroes. | |
816 | * Masking is not supported for the %OVS_KEY_ATTR_TUNNEL attribute. | |
8c146bb9 TH |
817 | * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q or 802.1ad header |
818 | * onto the packet. | |
819 | * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q or 802.1ad header | |
820 | * from the packet. | |
22e3880a TG |
821 | * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in |
822 | * the nested %OVS_SAMPLE_ATTR_* attributes. | |
25cd9ba0 SH |
823 | * @OVS_ACTION_ATTR_PUSH_MPLS: Push a new MPLS label stack entry onto the |
824 | * top of the packets MPLS label stack. Set the ethertype of the | |
825 | * encapsulating frame to either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC to | |
826 | * indicate the new packet contents. | |
827 | * @OVS_ACTION_ATTR_POP_MPLS: Pop an MPLS label stack entry off of the | |
828 | * packet's MPLS label stack. Set the encapsulating frame's ethertype to | |
829 | * indicate the new packet contents. This could potentially still be | |
830 | * %ETH_P_MPLS if the resulting MPLS label stack is not empty. If there | |
831 | * is no MPLS label stack, as determined by ethertype, no action is taken. | |
7f8a436e JS |
832 | * @OVS_ACTION_ATTR_CT: Track the connection. Populate the conntrack-related |
833 | * entries in the flow key. | |
91820da6 JB |
834 | * @OVS_ACTION_ATTR_PUSH_ETH: Push a new outermost Ethernet header onto the |
835 | * packet. | |
836 | * @OVS_ACTION_ATTR_POP_ETH: Pop the outermost Ethernet header off the | |
837 | * packet. | |
b8226962 | 838 | * @OVS_ACTION_ATTR_CT_CLEAR: Clear conntrack state from the packet. |
b2d0f5d5 YY |
839 | * @OVS_ACTION_ATTR_PUSH_NSH: push NSH header to the packet. |
840 | * @OVS_ACTION_ATTR_POP_NSH: pop the outermost NSH header off the packet. | |
cd8a6c33 AZ |
841 | * @OVS_ACTION_ATTR_METER: Run packet through a meter, which may drop the |
842 | * packet, or modify the packet (e.g., change the DSCP field). | |
22e3880a TG |
843 | * |
844 | * Only a single header can be set with a single %OVS_ACTION_ATTR_SET. Not all | |
845 | * fields within a header are modifiable, e.g. the IPv4 protocol and fragment | |
846 | * type may not be changed. | |
83d2b9ba JR |
847 | * |
848 | * @OVS_ACTION_ATTR_SET_TO_MASKED: Kernel internal masked set action translated | |
849 | * from the @OVS_ACTION_ATTR_SET. | |
22e3880a TG |
850 | */ |
851 | ||
852 | enum ovs_action_attr { | |
853 | OVS_ACTION_ATTR_UNSPEC, | |
854 | OVS_ACTION_ATTR_OUTPUT, /* u32 port number. */ | |
855 | OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */ | |
856 | OVS_ACTION_ATTR_SET, /* One nested OVS_KEY_ATTR_*. */ | |
857 | OVS_ACTION_ATTR_PUSH_VLAN, /* struct ovs_action_push_vlan. */ | |
858 | OVS_ACTION_ATTR_POP_VLAN, /* No argument. */ | |
859 | OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */ | |
971427f3 AZ |
860 | OVS_ACTION_ATTR_RECIRC, /* u32 recirc_id. */ |
861 | OVS_ACTION_ATTR_HASH, /* struct ovs_action_hash. */ | |
25cd9ba0 SH |
862 | OVS_ACTION_ATTR_PUSH_MPLS, /* struct ovs_action_push_mpls. */ |
863 | OVS_ACTION_ATTR_POP_MPLS, /* __be16 ethertype. */ | |
83d2b9ba JR |
864 | OVS_ACTION_ATTR_SET_MASKED, /* One nested OVS_KEY_ATTR_* including |
865 | * data immediately followed by a mask. | |
866 | * The data must be zero for the unmasked | |
867 | * bits. */ | |
0a7cc172 | 868 | OVS_ACTION_ATTR_CT, /* Nested OVS_CT_ATTR_* . */ |
f2a4d086 | 869 | OVS_ACTION_ATTR_TRUNC, /* u32 struct ovs_action_trunc. */ |
91820da6 JB |
870 | OVS_ACTION_ATTR_PUSH_ETH, /* struct ovs_action_push_eth. */ |
871 | OVS_ACTION_ATTR_POP_ETH, /* No argument. */ | |
b8226962 | 872 | OVS_ACTION_ATTR_CT_CLEAR, /* No argument. */ |
b2d0f5d5 YY |
873 | OVS_ACTION_ATTR_PUSH_NSH, /* Nested OVS_NSH_KEY_ATTR_*. */ |
874 | OVS_ACTION_ATTR_POP_NSH, /* No argument. */ | |
cd8a6c33 | 875 | OVS_ACTION_ATTR_METER, /* u32 meter ID. */ |
83d2b9ba JR |
876 | |
877 | __OVS_ACTION_ATTR_MAX, /* Nothing past this will be accepted | |
878 | * from userspace. */ | |
25cd9ba0 | 879 | |
83d2b9ba JR |
880 | #ifdef __KERNEL__ |
881 | OVS_ACTION_ATTR_SET_TO_MASKED, /* Kernel module internal masked | |
882 | * set action converted from | |
883 | * OVS_ACTION_ATTR_SET. */ | |
884 | #endif | |
22e3880a TG |
885 | }; |
886 | ||
887 | #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1) | |
888 | ||
57940406 AZ |
889 | /* Meters. */ |
890 | #define OVS_METER_FAMILY "ovs_meter" | |
891 | #define OVS_METER_MCGROUP "ovs_meter" | |
892 | #define OVS_METER_VERSION 0x1 | |
893 | ||
894 | enum ovs_meter_cmd { | |
895 | OVS_METER_CMD_UNSPEC, | |
896 | OVS_METER_CMD_FEATURES, /* Get features supported by the datapath. */ | |
897 | OVS_METER_CMD_SET, /* Add or modify a meter. */ | |
898 | OVS_METER_CMD_DEL, /* Delete a meter. */ | |
899 | OVS_METER_CMD_GET /* Get meter stats. */ | |
900 | }; | |
901 | ||
902 | enum ovs_meter_attr { | |
903 | OVS_METER_ATTR_UNSPEC, | |
904 | OVS_METER_ATTR_ID, /* u32 meter ID within datapath. */ | |
905 | OVS_METER_ATTR_KBPS, /* No argument. If set, units in kilobits | |
906 | * per second. Otherwise, units in | |
907 | * packets per second. | |
908 | */ | |
909 | OVS_METER_ATTR_STATS, /* struct ovs_flow_stats for the meter. */ | |
910 | OVS_METER_ATTR_BANDS, /* Nested attributes for meter bands. */ | |
911 | OVS_METER_ATTR_USED, /* u64 msecs last used in monotonic time. */ | |
912 | OVS_METER_ATTR_CLEAR, /* Flag to clear stats, used. */ | |
913 | OVS_METER_ATTR_MAX_METERS, /* u32 number of meters supported. */ | |
914 | OVS_METER_ATTR_MAX_BANDS, /* u32 max number of bands per meter. */ | |
915 | OVS_METER_ATTR_PAD, | |
916 | __OVS_METER_ATTR_MAX | |
917 | }; | |
918 | ||
919 | #define OVS_METER_ATTR_MAX (__OVS_METER_ATTR_MAX - 1) | |
920 | ||
921 | enum ovs_band_attr { | |
922 | OVS_BAND_ATTR_UNSPEC, | |
923 | OVS_BAND_ATTR_TYPE, /* u32 OVS_METER_BAND_TYPE_* constant. */ | |
924 | OVS_BAND_ATTR_RATE, /* u32 band rate in meter units (see above). */ | |
925 | OVS_BAND_ATTR_BURST, /* u32 burst size in meter units. */ | |
926 | OVS_BAND_ATTR_STATS, /* struct ovs_flow_stats for the band. */ | |
927 | __OVS_BAND_ATTR_MAX | |
928 | }; | |
929 | ||
930 | #define OVS_BAND_ATTR_MAX (__OVS_BAND_ATTR_MAX - 1) | |
931 | ||
932 | enum ovs_meter_band_type { | |
933 | OVS_METER_BAND_TYPE_UNSPEC, | |
934 | OVS_METER_BAND_TYPE_DROP, /* Drop exceeding packets. */ | |
935 | __OVS_METER_BAND_TYPE_MAX | |
936 | }; | |
937 | ||
938 | #define OVS_METER_BAND_TYPE_MAX (__OVS_METER_BAND_TYPE_MAX - 1) | |
939 | ||
22e3880a | 940 | #endif /* _LINUX_OPENVSWITCH_H */ |