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