]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
269dc90a | 2 | * Copyright (c) 2007-2014 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_* */ |
df2c07f4 | 107 | __OVS_DP_ATTR_MAX |
d6569377 BP |
108 | }; |
109 | ||
df2c07f4 | 110 | #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1) |
d6569377 | 111 | |
01414567 | 112 | /* All 64-bit integers within Netlink messages are 4-byte aligned only. */ |
df2c07f4 | 113 | struct ovs_dp_stats { |
def95ecd JG |
114 | __u64 n_hit; /* Number of flow table matches. */ |
115 | __u64 n_missed; /* Number of flow table misses. */ | |
116 | __u64 n_lost; /* Number of misses not sent to userspace. */ | |
117 | __u64 n_flows; /* Number of flows present */ | |
064af421 BP |
118 | }; |
119 | ||
4fa72a95 AZ |
120 | struct ovs_dp_megaflow_stats { |
121 | __u64 n_mask_hit; /* Number of masks used for flow lookups. */ | |
122 | __u32 n_masks; /* Number of masks for the datapath. */ | |
123 | __u32 pad0; /* Pad for future expension. */ | |
124 | __u64 pad1; /* Pad for future expension. */ | |
125 | __u64 pad2; /* Pad for future expension. */ | |
126 | }; | |
127 | ||
f613a0d7 | 128 | struct ovs_vport_stats { |
9ea0bccc BP |
129 | __u64 rx_packets; /* total packets received */ |
130 | __u64 tx_packets; /* total packets transmitted */ | |
131 | __u64 rx_bytes; /* total bytes received */ | |
132 | __u64 tx_bytes; /* total bytes transmitted */ | |
133 | __u64 rx_errors; /* bad packets received */ | |
134 | __u64 tx_errors; /* packet transmit problems */ | |
135 | __u64 rx_dropped; /* no space in linux buffers */ | |
136 | __u64 tx_dropped; /* no space available in linux */ | |
f613a0d7 PS |
137 | }; |
138 | ||
c58cc9a4 TG |
139 | /* Allow last Netlink attribute to be unaligned */ |
140 | #define OVS_DP_F_UNALIGNED (1 << 0) | |
141 | ||
beb1c69a AW |
142 | /* Allow datapath to associate multiple Netlink PIDs to each vport */ |
143 | #define OVS_DP_F_VPORT_PIDS (1 << 1) | |
144 | ||
def95ecd | 145 | /* Fixed logical ports. */ |
70fe217e | 146 | #define OVSP_LOCAL ((__u32)0) |
def95ecd JG |
147 | |
148 | /* Packet transfer. */ | |
149 | ||
df2c07f4 | 150 | #define OVS_PACKET_FAMILY "ovs_packet" |
69685a88 | 151 | #define OVS_PACKET_VERSION 0x1 |
064af421 | 152 | |
df2c07f4 | 153 | enum ovs_packet_cmd { |
def95ecd | 154 | OVS_PACKET_CMD_UNSPEC, |
064af421 | 155 | |
def95ecd JG |
156 | /* Kernel-to-user notifications. */ |
157 | OVS_PACKET_CMD_MISS, /* Flow table miss. */ | |
158 | OVS_PACKET_CMD_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */ | |
982b8810 | 159 | |
def95ecd JG |
160 | /* Userspace commands. */ |
161 | OVS_PACKET_CMD_EXECUTE /* Apply actions to a packet. */ | |
982b8810 BP |
162 | }; |
163 | ||
164 | /** | |
df2c07f4 JP |
165 | * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands. |
166 | * @OVS_PACKET_ATTR_PACKET: Present for all notifications. Contains the entire | |
982b8810 | 167 | * packet as received, from the start of the Ethernet header onward. For |
df2c07f4 JP |
168 | * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by |
169 | * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is | |
7aec165d | 170 | * the flow key extracted from the packet as originally received. |
df2c07f4 JP |
171 | * @OVS_PACKET_ATTR_KEY: Present for all notifications. Contains the flow key |
172 | * extracted from the packet as nested %OVS_KEY_ATTR_* attributes. This allows | |
982b8810 | 173 | * userspace to adapt its flow setup strategy by comparing its notion of the |
f053752f JR |
174 | * flow key against the kernel's. When used with %OVS_PACKET_CMD_EXECUTE, only |
175 | * metadata key fields (e.g. priority, skb mark) are honored. All the packet | |
176 | * header fields are parsed from the packet instead. | |
6ff686f2 PS |
177 | * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet. Used |
178 | * for %OVS_PACKET_CMD_EXECUTE. It has nested %OVS_ACTION_ATTR_* attributes. | |
df2c07f4 | 179 | * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION |
98403001 | 180 | * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an |
e995e3df BP |
181 | * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content |
182 | * specified there. | |
8b7ea2d4 WZ |
183 | * @OVS_PACKET_ATTR_EGRESS_TUN_KEY: Present for an %OVS_PACKET_CMD_ACTION |
184 | * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an | |
185 | * %OVS_USERSPACE_ATTR_EGRESS_TUN_PORT attribute, which is sent only if the | |
186 | * output port is actually a tunnel port. Contains the output tunnel key | |
187 | * extracted from the packet as nested %OVS_TUNNEL_KEY_ATTR_* attributes. | |
982b8810 | 188 | * |
df2c07f4 JP |
189 | * These attributes follow the &struct ovs_header within the Generic Netlink |
190 | * payload for %OVS_PACKET_* commands. | |
982b8810 | 191 | */ |
df2c07f4 JP |
192 | enum ovs_packet_attr { |
193 | OVS_PACKET_ATTR_UNSPEC, | |
194 | OVS_PACKET_ATTR_PACKET, /* Packet data. */ | |
195 | OVS_PACKET_ATTR_KEY, /* Nested OVS_KEY_ATTR_* attributes. */ | |
6ff686f2 | 196 | OVS_PACKET_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */ |
e995e3df | 197 | OVS_PACKET_ATTR_USERDATA, /* OVS_ACTION_ATTR_USERSPACE arg. */ |
8b7ea2d4 WZ |
198 | OVS_PACKET_ATTR_EGRESS_TUN_KEY, /* Nested OVS_TUNNEL_KEY_ATTR_* |
199 | attributes. */ | |
df2c07f4 | 200 | __OVS_PACKET_ATTR_MAX |
72b06300 BP |
201 | }; |
202 | ||
df2c07f4 | 203 | #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1) |
c283069c | 204 | |
def95ecd JG |
205 | /* Virtual ports. */ |
206 | ||
df2c07f4 JP |
207 | #define OVS_VPORT_FAMILY "ovs_vport" |
208 | #define OVS_VPORT_MCGROUP "ovs_vport" | |
69685a88 | 209 | #define OVS_VPORT_VERSION 0x1 |
df2c07f4 JP |
210 | |
211 | enum ovs_vport_cmd { | |
212 | OVS_VPORT_CMD_UNSPEC, | |
213 | OVS_VPORT_CMD_NEW, | |
214 | OVS_VPORT_CMD_DEL, | |
215 | OVS_VPORT_CMD_GET, | |
216 | OVS_VPORT_CMD_SET | |
f0fef760 | 217 | }; |
c283069c | 218 | |
def95ecd JG |
219 | enum ovs_vport_type { |
220 | OVS_VPORT_TYPE_UNSPEC, | |
221 | OVS_VPORT_TYPE_NETDEV, /* network device */ | |
222 | OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */ | |
953753fa | 223 | OVS_VPORT_TYPE_GRE, /* GRE tunnel. */ |
79f827fa | 224 | OVS_VPORT_TYPE_VXLAN, /* VXLAN tunnel */ |
c1fc1411 | 225 | OVS_VPORT_TYPE_GENEVE = 6, /* Geneve tunnel */ |
2de795ad | 226 | OVS_VPORT_TYPE_GRE64 = 104, /* GRE tunnel with 64-bit keys */ |
a6ae068b | 227 | OVS_VPORT_TYPE_LISP = 105, /* LISP tunnel */ |
def95ecd JG |
228 | __OVS_VPORT_TYPE_MAX |
229 | }; | |
230 | ||
231 | #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1) | |
232 | ||
b0ec0f27 | 233 | /** |
df2c07f4 JP |
234 | * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands. |
235 | * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath. | |
236 | * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type | |
f0fef760 | 237 | * of vport. |
df2c07f4 | 238 | * @OVS_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device |
f0fef760 BP |
239 | * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes |
240 | * plus a null terminator. | |
cdb1a85b | 241 | * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information. |
beb1c69a AW |
242 | * @OVS_VPORT_ATTR_UPCALL_PID: The array of Netlink socket pids in userspace |
243 | * among which OVS_PACKET_CMD_MISS upcalls will be distributed for packets | |
244 | * received on this port. If this is a single-element array of value 0, | |
245 | * upcalls should not be sent. | |
f613a0d7 | 246 | * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for |
f0fef760 | 247 | * packets sent or received through the vport. |
f0fef760 | 248 | * |
df2c07f4 JP |
249 | * These attributes follow the &struct ovs_header within the Generic Netlink |
250 | * payload for %OVS_VPORT_* commands. | |
b0ec0f27 | 251 | * |
df2c07f4 JP |
252 | * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and |
253 | * %OVS_VPORT_ATTR_NAME attributes are required. %OVS_VPORT_ATTR_PORT_NO is | |
f0fef760 | 254 | * optional; if not specified a free port number is automatically selected. |
df2c07f4 | 255 | * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type |
1fc7083d JG |
256 | * of vport. %OVS_VPORT_ATTR_STATS is optional and other attributes are |
257 | * ignored. | |
f0fef760 | 258 | * |
df2c07f4 | 259 | * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to |
f0fef760 | 260 | * look up the vport to operate on; otherwise dp_idx from the &struct |
df2c07f4 | 261 | * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport. |
b0ec0f27 | 262 | */ |
df2c07f4 JP |
263 | enum ovs_vport_attr { |
264 | OVS_VPORT_ATTR_UNSPEC, | |
a5408827 BP |
265 | OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */ |
266 | OVS_VPORT_ATTR_TYPE, /* u32 OVS_VPORT_TYPE_* constant. */ | |
df2c07f4 | 267 | OVS_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */ |
cdb1a85b | 268 | OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */ |
beb1c69a AW |
269 | OVS_VPORT_ATTR_UPCALL_PID, /* array of u32 Netlink socket PIDs for */ |
270 | /* receiving upcalls */ | |
f613a0d7 | 271 | OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */ |
df2c07f4 | 272 | __OVS_VPORT_ATTR_MAX |
064af421 BP |
273 | }; |
274 | ||
df2c07f4 | 275 | #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1) |
c19e6535 | 276 | |
85c9de19 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. */ | |
282 | __OVS_TUNNEL_ATTR_MAX | |
283 | }; | |
284 | ||
285 | #define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1) | |
286 | ||
37a1300c BP |
287 | /* Flows. */ |
288 | ||
df2c07f4 JP |
289 | #define OVS_FLOW_FAMILY "ovs_flow" |
290 | #define OVS_FLOW_MCGROUP "ovs_flow" | |
69685a88 | 291 | #define OVS_FLOW_VERSION 0x1 |
37a1300c | 292 | |
df2c07f4 JP |
293 | enum ovs_flow_cmd { |
294 | OVS_FLOW_CMD_UNSPEC, | |
295 | OVS_FLOW_CMD_NEW, | |
296 | OVS_FLOW_CMD_DEL, | |
297 | OVS_FLOW_CMD_GET, | |
298 | OVS_FLOW_CMD_SET | |
37a1300c | 299 | }; |
c19e6535 | 300 | |
df2c07f4 | 301 | struct ovs_flow_stats { |
def95ecd JG |
302 | __u64 n_packets; /* Number of matched packets. */ |
303 | __u64 n_bytes; /* Number of matched bytes. */ | |
064af421 BP |
304 | }; |
305 | ||
09ded0ad | 306 | enum ovs_key_attr { |
df2c07f4 | 307 | OVS_KEY_ATTR_UNSPEC, |
fea393b1 | 308 | OVS_KEY_ATTR_ENCAP, /* Nested set of encapsulated attributes. */ |
eb4e6bb4 BP |
309 | OVS_KEY_ATTR_PRIORITY, /* u32 skb->priority */ |
310 | OVS_KEY_ATTR_IN_PORT, /* u32 OVS dp port number */ | |
df2c07f4 | 311 | OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */ |
fea393b1 | 312 | OVS_KEY_ATTR_VLAN, /* be16 VLAN TCI */ |
eb4e6bb4 | 313 | OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */ |
df2c07f4 JP |
314 | OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */ |
315 | OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */ | |
316 | OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */ | |
317 | OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */ | |
318 | OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */ | |
319 | OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */ | |
320 | OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */ | |
321 | OVS_KEY_ATTR_ND, /* struct ovs_key_nd */ | |
72e8bf28 | 322 | OVS_KEY_ATTR_SKB_MARK, /* u32 skb mark */ |
9b405f1a | 323 | OVS_KEY_ATTR_TUNNEL, /* Nested set of ovs_tunnel attributes */ |
10f72e3d | 324 | OVS_KEY_ATTR_SCTP, /* struct ovs_key_sctp */ |
dc235f7f | 325 | OVS_KEY_ATTR_TCP_FLAGS, /* be16 TCP flags. */ |
7804df20 AZ |
326 | OVS_KEY_ATTR_DP_HASH, /* u32 hash value. Value 0 indicates the hash |
327 | is not computed by the datapath. */ | |
0962036c | 328 | OVS_KEY_ATTR_RECIRC_ID, /* u32 recirc id */ |
ccf43786 SH |
329 | OVS_KEY_ATTR_MPLS, /* array of struct ovs_key_mpls. |
330 | * The implementation may restrict | |
331 | * the accepted length of the array. */ | |
332 | ||
9b405f1a | 333 | #ifdef __KERNEL__ |
0962036c | 334 | /* Only used within kernel data path. */ |
f0cd669f | 335 | OVS_KEY_ATTR_TUNNEL_INFO, /* struct ovs_tunnel_info */ |
9b405f1a | 336 | #endif |
df2c07f4 | 337 | __OVS_KEY_ATTR_MAX |
36956a7d BP |
338 | }; |
339 | ||
df2c07f4 | 340 | #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1) |
36956a7d | 341 | |
9b405f1a PS |
342 | enum ovs_tunnel_key_attr { |
343 | OVS_TUNNEL_KEY_ATTR_ID, /* be64 Tunnel ID */ | |
344 | OVS_TUNNEL_KEY_ATTR_IPV4_SRC, /* be32 src IP address. */ | |
345 | OVS_TUNNEL_KEY_ATTR_IPV4_DST, /* be32 dst IP address. */ | |
346 | OVS_TUNNEL_KEY_ATTR_TOS, /* u8 Tunnel IP ToS. */ | |
347 | OVS_TUNNEL_KEY_ATTR_TTL, /* u8 Tunnel IP TTL. */ | |
348 | OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT, /* No argument, set DF. */ | |
349 | OVS_TUNNEL_KEY_ATTR_CSUM, /* No argument. CSUM packet. */ | |
94872594 | 350 | OVS_TUNNEL_KEY_ATTR_OAM, /* No argument, OAM frame. */ |
c1fc1411 | 351 | OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS, /* Array of Geneve options */ |
8b7ea2d4 WZ |
352 | OVS_TUNNEL_KEY_ATTR_TP_SRC, /* be16 src Transport Port. */ |
353 | OVS_TUNNEL_KEY_ATTR_TP_DST, /* be16 dst Transport Port. */ | |
9b405f1a PS |
354 | __OVS_TUNNEL_KEY_ATTR_MAX |
355 | }; | |
9b405f1a PS |
356 | #define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1) |
357 | ||
7257b535 BP |
358 | /** |
359 | * enum ovs_frag_type - IPv4 and IPv6 fragment type | |
360 | * @OVS_FRAG_TYPE_NONE: Packet is not a fragment. | |
361 | * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0. | |
362 | * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset. | |
363 | * | |
364 | * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct | |
365 | * ovs_key_ipv6. | |
366 | */ | |
367 | enum ovs_frag_type { | |
368 | OVS_FRAG_TYPE_NONE, | |
369 | OVS_FRAG_TYPE_FIRST, | |
370 | OVS_FRAG_TYPE_LATER, | |
371 | __OVS_FRAG_TYPE_MAX | |
372 | }; | |
373 | ||
374 | #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1) | |
375 | ||
df2c07f4 | 376 | struct ovs_key_ethernet { |
d11dbe61 TG |
377 | __u8 eth_src[ETH_ALEN]; |
378 | __u8 eth_dst[ETH_ALEN]; | |
36956a7d BP |
379 | }; |
380 | ||
b02475c5 | 381 | struct ovs_key_mpls { |
20131cef | 382 | __be32 mpls_lse; |
b02475c5 SH |
383 | }; |
384 | ||
df2c07f4 | 385 | struct ovs_key_ipv4 { |
9ea0bccc BP |
386 | __be32 ipv4_src; |
387 | __be32 ipv4_dst; | |
388 | __u8 ipv4_proto; | |
389 | __u8 ipv4_tos; | |
a61680c6 | 390 | __u8 ipv4_ttl; |
7257b535 | 391 | __u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */ |
36956a7d BP |
392 | }; |
393 | ||
df2c07f4 | 394 | struct ovs_key_ipv6 { |
9ea0bccc BP |
395 | __be32 ipv6_src[4]; |
396 | __be32 ipv6_dst[4]; | |
fa8223b7 | 397 | __be32 ipv6_label; /* 20-bits in least-significant bits. */ |
9ea0bccc | 398 | __u8 ipv6_proto; |
60258dcb | 399 | __u8 ipv6_tclass; |
a61680c6 | 400 | __u8 ipv6_hlimit; |
7257b535 | 401 | __u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */ |
d31f1109 JP |
402 | }; |
403 | ||
df2c07f4 | 404 | struct ovs_key_tcp { |
9ea0bccc BP |
405 | __be16 tcp_src; |
406 | __be16 tcp_dst; | |
36956a7d BP |
407 | }; |
408 | ||
df2c07f4 | 409 | struct ovs_key_udp { |
9ea0bccc BP |
410 | __be16 udp_src; |
411 | __be16 udp_dst; | |
36956a7d BP |
412 | }; |
413 | ||
10f72e3d JS |
414 | struct ovs_key_sctp { |
415 | __be16 sctp_src; | |
416 | __be16 sctp_dst; | |
417 | }; | |
418 | ||
df2c07f4 | 419 | struct ovs_key_icmp { |
9ea0bccc BP |
420 | __u8 icmp_type; |
421 | __u8 icmp_code; | |
36956a7d BP |
422 | }; |
423 | ||
df2c07f4 | 424 | struct ovs_key_icmpv6 { |
9ea0bccc BP |
425 | __u8 icmpv6_type; |
426 | __u8 icmpv6_code; | |
d31f1109 JP |
427 | }; |
428 | ||
df2c07f4 | 429 | struct ovs_key_arp { |
9ea0bccc BP |
430 | __be32 arp_sip; |
431 | __be32 arp_tip; | |
432 | __be16 arp_op; | |
d11dbe61 TG |
433 | __u8 arp_sha[ETH_ALEN]; |
434 | __u8 arp_tha[ETH_ALEN]; | |
064af421 BP |
435 | }; |
436 | ||
df2c07f4 | 437 | struct ovs_key_nd { |
9ea0bccc | 438 | __u32 nd_target[4]; |
d11dbe61 TG |
439 | __u8 nd_sll[ETH_ALEN]; |
440 | __u8 nd_tll[ETH_ALEN]; | |
685a51a5 JP |
441 | }; |
442 | ||
d6569377 | 443 | /** |
df2c07f4 JP |
444 | * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands. |
445 | * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow | |
37a1300c BP |
446 | * key. Always present in notifications. Required for all requests (except |
447 | * dumps). | |
df2c07f4 | 448 | * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying |
67145b4d | 449 | * the actions to take for packets that match the key. Always present in |
e002c96f | 450 | * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional for |
90b8c2f7 JR |
451 | * %OVS_FLOW_CMD_SET requests. An %OVS_FLOW_CMD_SET without |
452 | * %OVS_FLOW_ATTR_ACTIONS will not modify the actions. To clear the actions, | |
453 | * an %OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given. | |
df2c07f4 | 454 | * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this |
37a1300c BP |
455 | * flow. Present in notifications if the stats would be nonzero. Ignored in |
456 | * requests. | |
df2c07f4 | 457 | * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the |
37a1300c BP |
458 | * TCP flags seen on packets in this flow. Only present in notifications for |
459 | * TCP flows, and only if it would be nonzero. Ignored in requests. | |
df2c07f4 | 460 | * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on |
37a1300c BP |
461 | * the system monotonic clock, at which a packet was last processed for this |
462 | * flow. Only present in notifications if a packet has been processed for this | |
463 | * flow. Ignored in requests. | |
df2c07f4 | 464 | * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the |
37a1300c BP |
465 | * last-used time, accumulated TCP flags, and statistics for this flow. |
466 | * Otherwise ignored in requests. Never present in notifications. | |
a1c564be AZ |
467 | * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the |
468 | * mask bits for wildcarded flow match. Mask bit value '1' specifies exact | |
469 | * match with corresponding flow key bit, while mask bit value '0' specifies | |
470 | * a wildcarded match. Omitting attribute is treated as wildcarding all | |
471 | * corresponding fields. Optional for all requests. If not present, | |
472 | * all flow key bits are exact match bits. | |
d6569377 | 473 | * |
df2c07f4 JP |
474 | * These attributes follow the &struct ovs_header within the Generic Netlink |
475 | * payload for %OVS_FLOW_* commands. | |
d6569377 | 476 | */ |
df2c07f4 JP |
477 | enum ovs_flow_attr { |
478 | OVS_FLOW_ATTR_UNSPEC, | |
479 | OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */ | |
480 | OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */ | |
481 | OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */ | |
482 | OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */ | |
483 | OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */ | |
484 | OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */ | |
a1c564be | 485 | OVS_FLOW_ATTR_MASK, /* Sequence of OVS_KEY_ATTR_* attributes. */ |
df2c07f4 | 486 | __OVS_FLOW_ATTR_MAX |
064af421 BP |
487 | }; |
488 | ||
df2c07f4 | 489 | #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1) |
064af421 | 490 | |
6ff686f2 | 491 | /** |
98403001 | 492 | * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action. |
6ff686f2 PS |
493 | * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with |
494 | * @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of | |
495 | * %UINT32_MAX samples all packets and intermediate values sample intermediate | |
496 | * fractions of packets. | |
497 | * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event. | |
498 | * Actions are passed as nested attributes. | |
98403001 BP |
499 | * |
500 | * Executes the specified actions with the given probability on a per-packet | |
501 | * basis. | |
6ff686f2 PS |
502 | */ |
503 | enum ovs_sample_attr { | |
504 | OVS_SAMPLE_ATTR_UNSPEC, | |
505 | OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */ | |
506 | OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */ | |
507 | __OVS_SAMPLE_ATTR_MAX, | |
508 | }; | |
509 | ||
510 | #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1) | |
511 | ||
98403001 BP |
512 | /** |
513 | * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action. | |
514 | * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION | |
515 | * message should be sent. Required. | |
e995e3df BP |
516 | * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is |
517 | * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA. | |
8b7ea2d4 WZ |
518 | * @OVS_USERSPACE_ATTR_EGRESS_TUN_PORT: If present, u32 output port to get |
519 | * tunnel info. | |
98403001 BP |
520 | */ |
521 | enum ovs_userspace_attr { | |
522 | OVS_USERSPACE_ATTR_UNSPEC, | |
523 | OVS_USERSPACE_ATTR_PID, /* u32 Netlink PID to receive upcalls. */ | |
e995e3df | 524 | OVS_USERSPACE_ATTR_USERDATA, /* Optional user-specified cookie. */ |
8b7ea2d4 WZ |
525 | OVS_USERSPACE_ATTR_EGRESS_TUN_PORT, /* Optional, u32 output port |
526 | * to get tunnel info. */ | |
98403001 BP |
527 | __OVS_USERSPACE_ATTR_MAX |
528 | }; | |
529 | ||
530 | #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1) | |
531 | ||
b02475c5 SH |
532 | /** |
533 | * struct ovs_action_push_mpls - %OVS_ACTION_ATTR_PUSH_MPLS action argument. | |
534 | * @mpls_lse: MPLS label stack entry to push. | |
535 | * @mpls_ethertype: Ethertype to set in the encapsulating ethernet frame. | |
536 | * | |
537 | * The only values @mpls_ethertype should ever be given are %ETH_P_MPLS_UC and | |
538 | * %ETH_P_MPLS_MC, indicating MPLS unicast or multicast. Other are rejected. | |
539 | */ | |
540 | struct ovs_action_push_mpls { | |
541 | __be32 mpls_lse; | |
542 | __be16 mpls_ethertype; /* Either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC */ | |
543 | }; | |
544 | ||
fea393b1 BP |
545 | /** |
546 | * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument. | |
547 | * @vlan_tpid: Tag protocol identifier (TPID) to push. | |
8ddc056d BP |
548 | * @vlan_tci: Tag control identifier (TCI) to push. The CFI bit must be set |
549 | * (but it will not be set in the 802.1Q header that is pushed). | |
fea393b1 BP |
550 | * |
551 | * The @vlan_tpid value is typically %ETH_P_8021Q. The only acceptable TPID | |
552 | * values are those that the kernel module also parses as 802.1Q headers, to | |
553 | * prevent %OVS_ACTION_ATTR_PUSH_VLAN followed by %OVS_ACTION_ATTR_POP_VLAN | |
554 | * from having surprising results. | |
555 | */ | |
556 | struct ovs_action_push_vlan { | |
557 | __be16 vlan_tpid; /* 802.1Q TPID. */ | |
558 | __be16 vlan_tci; /* 802.1Q TCI (VLAN ID and priority). */ | |
559 | }; | |
560 | ||
572f732a AZ |
561 | /* Data path hash algorithm for computing Datapath hash. |
562 | * | |
347bf289 | 563 | * The algorithm type only specifies the fields in a flow |
572f732a AZ |
564 | * will be used as part of the hash. Each datapath is free |
565 | * to use its own hash algorithm. The hash value will be | |
566 | * opaque to the user space daemon. | |
567 | */ | |
347bf289 AZ |
568 | enum ovs_hash_alg { |
569 | OVS_HASH_ALG_L4, | |
572f732a AZ |
570 | }; |
571 | /* | |
347bf289 | 572 | * struct ovs_action_hash - %OVS_ACTION_ATTR_HASH action argument. |
572f732a | 573 | * @hash_alg: Algorithm used to compute hash prior to recirculation. |
62ac1f20 | 574 | * @hash_basis: basis used for computing hash. |
572f732a | 575 | */ |
347bf289 AZ |
576 | struct ovs_action_hash { |
577 | uint32_t hash_alg; /* One of ovs_hash_alg. */ | |
62ac1f20 | 578 | uint32_t hash_basis; |
572f732a AZ |
579 | }; |
580 | ||
4edb9ae9 | 581 | /** |
a5408827 | 582 | * enum ovs_action_attr - Action types. |
4edb9ae9 | 583 | * |
a5408827 BP |
584 | * @OVS_ACTION_ATTR_OUTPUT: Output packet to port. |
585 | * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested | |
586 | * %OVS_USERSPACE_ATTR_* attributes. | |
fea393b1 BP |
587 | * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q header onto the |
588 | * packet. | |
589 | * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q header off the packet. | |
a5408827 BP |
590 | * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in |
591 | * the nested %OVS_SAMPLE_ATTR_* attributes. | |
b02475c5 SH |
592 | * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header. The |
593 | * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its | |
594 | * value. | |
965662a9 AZ |
595 | * @OVS_ACTION_RECIRC: Recirculate within the data path. |
596 | * @OVS_ACTION_HASH: Compute and set flow hash value. | |
b02475c5 | 597 | * @OVS_ACTION_ATTR_PUSH_MPLS: Push a new MPLS label stack entry onto the |
269dc90a | 598 | * top of the packets MPLS label stack. Set the ethertype of the |
b02475c5 SH |
599 | * encapsulating frame to either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC to |
600 | * indicate the new packet contents. | |
601 | * @OVS_ACTION_ATTR_POP_MPLS: Pop an MPLS label stack entry off of the | |
602 | * packet's MPLS label stack. Set the encapsulating frame's ethertype to | |
269dc90a BP |
603 | * indicate the new packet contents. This could potentially still be |
604 | * %ETH_P_MPLS if the resulting MPLS label stack is not empty. If there | |
b02475c5 | 605 | * is no MPLS label stack, as determined by ethertype, no action is taken. |
4edb9ae9 | 606 | * |
fea393b1 BP |
607 | * Only a single header can be set with a single %OVS_ACTION_ATTR_SET. Not all |
608 | * fields within a header are modifiable, e.g. the IPv4 protocol and fragment | |
609 | * type may not be changed. | |
4edb9ae9 PS |
610 | */ |
611 | ||
09ded0ad | 612 | enum ovs_action_attr { |
df2c07f4 | 613 | OVS_ACTION_ATTR_UNSPEC, |
a5408827 | 614 | OVS_ACTION_ATTR_OUTPUT, /* u32 port number. */ |
98403001 | 615 | OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */ |
a5408827 | 616 | OVS_ACTION_ATTR_SET, /* One nested OVS_KEY_ATTR_*. */ |
fea393b1 BP |
617 | OVS_ACTION_ATTR_PUSH_VLAN, /* struct ovs_action_push_vlan. */ |
618 | OVS_ACTION_ATTR_POP_VLAN, /* No argument. */ | |
98403001 | 619 | OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */ |
347bf289 AZ |
620 | OVS_ACTION_ATTR_RECIRC, /* u32 recirc_id. */ |
621 | OVS_ACTION_ATTR_HASH, /* struct ovs_action_hash. */ | |
965662a9 AZ |
622 | OVS_ACTION_ATTR_PUSH_MPLS, /* struct ovs_action_push_mpls. */ |
623 | OVS_ACTION_ATTR_POP_MPLS, /* __be16 ethertype. */ | |
df2c07f4 | 624 | __OVS_ACTION_ATTR_MAX |
064af421 BP |
625 | }; |
626 | ||
df2c07f4 | 627 | #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1) |
064af421 | 628 | |
077257b8 | 629 | #endif /* _LINUX_OPENVSWITCH_H */ |