Commit | Line | Data |
---|---|---|
22e3880a TG |
1 | |
2 | /* | |
03f0d916 | 3 | * Copyright (c) 2007-2013 Nicira, Inc. |
22e3880a TG |
4 | * |
5 | * This program is free software; you can redistribute it and/or | |
6 | * modify it under the terms of version 2 of the GNU General Public | |
7 | * License as published by the Free Software Foundation. | |
8 | * | |
9 | * This program is distributed in the hope that it will be useful, but | |
10 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
12 | * General Public License for more details. | |
13 | * | |
14 | * You should have received a copy of the GNU General Public License | |
15 | * along with this program; if not, write to the Free Software | |
16 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA | |
17 | * 02110-1301, USA | |
18 | */ | |
19 | ||
20 | #ifndef _UAPI__LINUX_OPENVSWITCH_H | |
21 | #define _UAPI__LINUX_OPENVSWITCH_H 1 | |
22 | ||
23 | #include <linux/types.h> | |
24 | #include <linux/if_ether.h> | |
25 | ||
26 | /** | |
27 | * struct ovs_header - header for OVS Generic Netlink messages. | |
28 | * @dp_ifindex: ifindex of local port for datapath (0 to make a request not | |
29 | * specific to a datapath). | |
30 | * | |
31 | * Attributes following the header are specific to a particular OVS Generic | |
32 | * Netlink family, but all of the OVS families use this header. | |
33 | */ | |
34 | ||
35 | struct ovs_header { | |
36 | int dp_ifindex; | |
37 | }; | |
38 | ||
39 | /* Datapaths. */ | |
40 | ||
41 | #define OVS_DATAPATH_FAMILY "ovs_datapath" | |
42 | #define OVS_DATAPATH_MCGROUP "ovs_datapath" | |
44da5ae5 TG |
43 | |
44 | /* V2: | |
45 | * - API users are expected to provide OVS_DP_ATTR_USER_FEATURES | |
46 | * when creating the datapath. | |
47 | */ | |
48 | #define OVS_DATAPATH_VERSION 2 | |
49 | ||
50 | /* First OVS datapath version to support features */ | |
51 | #define OVS_DP_VER_FEATURES 2 | |
22e3880a TG |
52 | |
53 | enum ovs_datapath_cmd { | |
54 | OVS_DP_CMD_UNSPEC, | |
55 | OVS_DP_CMD_NEW, | |
56 | OVS_DP_CMD_DEL, | |
57 | OVS_DP_CMD_GET, | |
58 | OVS_DP_CMD_SET | |
59 | }; | |
60 | ||
61 | /** | |
62 | * enum ovs_datapath_attr - attributes for %OVS_DP_* commands. | |
63 | * @OVS_DP_ATTR_NAME: Name of the network device that serves as the "local | |
64 | * port". This is the name of the network device whose dp_ifindex is given in | |
65 | * the &struct ovs_header. Always present in notifications. Required in | |
66 | * %OVS_DP_NEW requests. May be used as an alternative to specifying | |
67 | * dp_ifindex in other requests (with a dp_ifindex of 0). | |
68 | * @OVS_DP_ATTR_UPCALL_PID: The Netlink socket in userspace that is initially | |
69 | * set on the datapath port (for OVS_ACTION_ATTR_MISS). Only valid on | |
70 | * %OVS_DP_CMD_NEW requests. A value of zero indicates that upcalls should | |
71 | * not be sent. | |
72 | * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the | |
73 | * datapath. Always present in notifications. | |
1bd7116f AZ |
74 | * @OVS_DP_ATTR_MEGAFLOW_STATS: Statistics about mega flow masks usage for the |
75 | * datapath. Always present in notifications. | |
22e3880a TG |
76 | * |
77 | * These attributes follow the &struct ovs_header within the Generic Netlink | |
78 | * payload for %OVS_DP_* commands. | |
79 | */ | |
80 | enum ovs_datapath_attr { | |
81 | OVS_DP_ATTR_UNSPEC, | |
1bd7116f AZ |
82 | OVS_DP_ATTR_NAME, /* name of dp_ifindex netdev */ |
83 | OVS_DP_ATTR_UPCALL_PID, /* Netlink PID to receive upcalls */ | |
84 | OVS_DP_ATTR_STATS, /* struct ovs_dp_stats */ | |
85 | OVS_DP_ATTR_MEGAFLOW_STATS, /* struct ovs_dp_megaflow_stats */ | |
43d4be9c | 86 | OVS_DP_ATTR_USER_FEATURES, /* OVS_DP_F_* */ |
22e3880a TG |
87 | __OVS_DP_ATTR_MAX |
88 | }; | |
89 | ||
90 | #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1) | |
91 | ||
92 | struct ovs_dp_stats { | |
93 | __u64 n_hit; /* Number of flow table matches. */ | |
94 | __u64 n_missed; /* Number of flow table misses. */ | |
95 | __u64 n_lost; /* Number of misses not sent to userspace. */ | |
96 | __u64 n_flows; /* Number of flows present */ | |
97 | }; | |
98 | ||
1bd7116f AZ |
99 | struct ovs_dp_megaflow_stats { |
100 | __u64 n_mask_hit; /* Number of masks used for flow lookups. */ | |
101 | __u32 n_masks; /* Number of masks for the datapath. */ | |
102 | __u32 pad0; /* Pad for future expension. */ | |
103 | __u64 pad1; /* Pad for future expension. */ | |
104 | __u64 pad2; /* Pad for future expension. */ | |
105 | }; | |
106 | ||
22e3880a TG |
107 | struct ovs_vport_stats { |
108 | __u64 rx_packets; /* total packets received */ | |
109 | __u64 tx_packets; /* total packets transmitted */ | |
110 | __u64 rx_bytes; /* total bytes received */ | |
111 | __u64 tx_bytes; /* total bytes transmitted */ | |
112 | __u64 rx_errors; /* bad packets received */ | |
113 | __u64 tx_errors; /* packet transmit problems */ | |
114 | __u64 rx_dropped; /* no space in linux buffers */ | |
115 | __u64 tx_dropped; /* no space available in linux */ | |
116 | }; | |
117 | ||
43d4be9c TG |
118 | /* Allow last Netlink attribute to be unaligned */ |
119 | #define OVS_DP_F_UNALIGNED (1 << 0) | |
120 | ||
5cd667b0 AW |
121 | /* Allow datapath to associate multiple Netlink PIDs to each vport */ |
122 | #define OVS_DP_F_VPORT_PIDS (1 << 1) | |
123 | ||
22e3880a TG |
124 | /* Fixed logical ports. */ |
125 | #define OVSP_LOCAL ((__u32)0) | |
126 | ||
127 | /* Packet transfer. */ | |
128 | ||
129 | #define OVS_PACKET_FAMILY "ovs_packet" | |
130 | #define OVS_PACKET_VERSION 0x1 | |
131 | ||
132 | enum ovs_packet_cmd { | |
133 | OVS_PACKET_CMD_UNSPEC, | |
134 | ||
135 | /* Kernel-to-user notifications. */ | |
136 | OVS_PACKET_CMD_MISS, /* Flow table miss. */ | |
137 | OVS_PACKET_CMD_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */ | |
138 | ||
139 | /* Userspace commands. */ | |
140 | OVS_PACKET_CMD_EXECUTE /* Apply actions to a packet. */ | |
141 | }; | |
142 | ||
143 | /** | |
144 | * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands. | |
145 | * @OVS_PACKET_ATTR_PACKET: Present for all notifications. Contains the entire | |
146 | * packet as received, from the start of the Ethernet header onward. For | |
147 | * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by | |
148 | * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is | |
149 | * the flow key extracted from the packet as originally received. | |
150 | * @OVS_PACKET_ATTR_KEY: Present for all notifications. Contains the flow key | |
151 | * extracted from the packet as nested %OVS_KEY_ATTR_* attributes. This allows | |
152 | * userspace to adapt its flow setup strategy by comparing its notion of the | |
153 | * flow key against the kernel's. | |
154 | * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet. Used | |
155 | * for %OVS_PACKET_CMD_EXECUTE. It has nested %OVS_ACTION_ATTR_* attributes. | |
156 | * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION | |
157 | * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an | |
158 | * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content | |
159 | * specified there. | |
160 | * | |
161 | * These attributes follow the &struct ovs_header within the Generic Netlink | |
162 | * payload for %OVS_PACKET_* commands. | |
163 | */ | |
164 | enum ovs_packet_attr { | |
165 | OVS_PACKET_ATTR_UNSPEC, | |
166 | OVS_PACKET_ATTR_PACKET, /* Packet data. */ | |
167 | OVS_PACKET_ATTR_KEY, /* Nested OVS_KEY_ATTR_* attributes. */ | |
168 | OVS_PACKET_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */ | |
169 | OVS_PACKET_ATTR_USERDATA, /* OVS_ACTION_ATTR_USERSPACE arg. */ | |
170 | __OVS_PACKET_ATTR_MAX | |
171 | }; | |
172 | ||
173 | #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1) | |
174 | ||
175 | /* Virtual ports. */ | |
176 | ||
177 | #define OVS_VPORT_FAMILY "ovs_vport" | |
178 | #define OVS_VPORT_MCGROUP "ovs_vport" | |
179 | #define OVS_VPORT_VERSION 0x1 | |
180 | ||
181 | enum ovs_vport_cmd { | |
182 | OVS_VPORT_CMD_UNSPEC, | |
183 | OVS_VPORT_CMD_NEW, | |
184 | OVS_VPORT_CMD_DEL, | |
185 | OVS_VPORT_CMD_GET, | |
186 | OVS_VPORT_CMD_SET | |
187 | }; | |
188 | ||
189 | enum ovs_vport_type { | |
190 | OVS_VPORT_TYPE_UNSPEC, | |
191 | OVS_VPORT_TYPE_NETDEV, /* network device */ | |
192 | OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */ | |
aa310701 | 193 | OVS_VPORT_TYPE_GRE, /* GRE tunnel. */ |
58264848 | 194 | OVS_VPORT_TYPE_VXLAN, /* VXLAN tunnel. */ |
f5796684 | 195 | OVS_VPORT_TYPE_GENEVE, /* Geneve tunnel. */ |
22e3880a TG |
196 | __OVS_VPORT_TYPE_MAX |
197 | }; | |
198 | ||
199 | #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1) | |
200 | ||
201 | /** | |
202 | * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands. | |
203 | * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath. | |
204 | * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type | |
205 | * of vport. | |
206 | * @OVS_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device | |
207 | * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes | |
208 | * plus a null terminator. | |
209 | * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information. | |
5cd667b0 AW |
210 | * @OVS_VPORT_ATTR_UPCALL_PID: The array of Netlink socket pids in userspace |
211 | * among which OVS_PACKET_CMD_MISS upcalls will be distributed for packets | |
212 | * received on this port. If this is a single-element array of value 0, | |
213 | * upcalls should not be sent. | |
22e3880a TG |
214 | * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for |
215 | * packets sent or received through the vport. | |
216 | * | |
217 | * These attributes follow the &struct ovs_header within the Generic Netlink | |
218 | * payload for %OVS_VPORT_* commands. | |
219 | * | |
220 | * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and | |
221 | * %OVS_VPORT_ATTR_NAME attributes are required. %OVS_VPORT_ATTR_PORT_NO is | |
222 | * optional; if not specified a free port number is automatically selected. | |
223 | * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type | |
224 | * of vport. | |
22e3880a TG |
225 | * |
226 | * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to | |
227 | * look up the vport to operate on; otherwise dp_idx from the &struct | |
228 | * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport. | |
229 | */ | |
230 | enum ovs_vport_attr { | |
231 | OVS_VPORT_ATTR_UNSPEC, | |
232 | OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */ | |
233 | OVS_VPORT_ATTR_TYPE, /* u32 OVS_VPORT_TYPE_* constant. */ | |
234 | OVS_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */ | |
235 | OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */ | |
5cd667b0 AW |
236 | OVS_VPORT_ATTR_UPCALL_PID, /* array of u32 Netlink socket PIDs for */ |
237 | /* receiving upcalls */ | |
22e3880a TG |
238 | OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */ |
239 | __OVS_VPORT_ATTR_MAX | |
240 | }; | |
241 | ||
242 | #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1) | |
243 | ||
58264848 PS |
244 | /* OVS_VPORT_ATTR_OPTIONS attributes for tunnels. |
245 | */ | |
246 | enum { | |
247 | OVS_TUNNEL_ATTR_UNSPEC, | |
248 | OVS_TUNNEL_ATTR_DST_PORT, /* 16-bit UDP port, used by L4 tunnels. */ | |
249 | __OVS_TUNNEL_ATTR_MAX | |
250 | }; | |
251 | ||
252 | #define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1) | |
253 | ||
22e3880a TG |
254 | /* Flows. */ |
255 | ||
256 | #define OVS_FLOW_FAMILY "ovs_flow" | |
257 | #define OVS_FLOW_MCGROUP "ovs_flow" | |
258 | #define OVS_FLOW_VERSION 0x1 | |
259 | ||
260 | enum ovs_flow_cmd { | |
261 | OVS_FLOW_CMD_UNSPEC, | |
262 | OVS_FLOW_CMD_NEW, | |
263 | OVS_FLOW_CMD_DEL, | |
264 | OVS_FLOW_CMD_GET, | |
265 | OVS_FLOW_CMD_SET | |
266 | }; | |
267 | ||
268 | struct ovs_flow_stats { | |
269 | __u64 n_packets; /* Number of matched packets. */ | |
270 | __u64 n_bytes; /* Number of matched bytes. */ | |
271 | }; | |
272 | ||
273 | enum ovs_key_attr { | |
274 | OVS_KEY_ATTR_UNSPEC, | |
275 | OVS_KEY_ATTR_ENCAP, /* Nested set of encapsulated attributes. */ | |
276 | OVS_KEY_ATTR_PRIORITY, /* u32 skb->priority */ | |
277 | OVS_KEY_ATTR_IN_PORT, /* u32 OVS dp port number */ | |
278 | OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */ | |
279 | OVS_KEY_ATTR_VLAN, /* be16 VLAN TCI */ | |
280 | OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */ | |
281 | OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */ | |
282 | OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */ | |
283 | OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */ | |
284 | OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */ | |
285 | OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */ | |
286 | OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */ | |
287 | OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */ | |
288 | OVS_KEY_ATTR_ND, /* struct ovs_key_nd */ | |
289 | OVS_KEY_ATTR_SKB_MARK, /* u32 skb mark */ | |
7d5437c7 | 290 | OVS_KEY_ATTR_TUNNEL, /* Nested set of ovs_tunnel attributes */ |
a175a723 | 291 | OVS_KEY_ATTR_SCTP, /* struct ovs_key_sctp */ |
5eb26b15 | 292 | OVS_KEY_ATTR_TCP_FLAGS, /* be16 TCP flags. */ |
971427f3 AZ |
293 | OVS_KEY_ATTR_DP_HASH, /* u32 hash value. Value 0 indicates the hash |
294 | is not computed by the datapath. */ | |
295 | OVS_KEY_ATTR_RECIRC_ID, /* u32 recirc id */ | |
25cd9ba0 SH |
296 | OVS_KEY_ATTR_MPLS, /* array of struct ovs_key_mpls. |
297 | * The implementation may restrict | |
298 | * the accepted length of the array. */ | |
7d5437c7 PS |
299 | |
300 | #ifdef __KERNEL__ | |
f0b128c1 | 301 | OVS_KEY_ATTR_TUNNEL_INFO, /* struct ovs_tunnel_info */ |
7d5437c7 | 302 | #endif |
22e3880a TG |
303 | __OVS_KEY_ATTR_MAX |
304 | }; | |
305 | ||
306 | #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1) | |
307 | ||
7d5437c7 PS |
308 | enum ovs_tunnel_key_attr { |
309 | OVS_TUNNEL_KEY_ATTR_ID, /* be64 Tunnel ID */ | |
310 | OVS_TUNNEL_KEY_ATTR_IPV4_SRC, /* be32 src IP address. */ | |
311 | OVS_TUNNEL_KEY_ATTR_IPV4_DST, /* be32 dst IP address. */ | |
312 | OVS_TUNNEL_KEY_ATTR_TOS, /* u8 Tunnel IP ToS. */ | |
313 | OVS_TUNNEL_KEY_ATTR_TTL, /* u8 Tunnel IP TTL. */ | |
314 | OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT, /* No argument, set DF. */ | |
315 | OVS_TUNNEL_KEY_ATTR_CSUM, /* No argument. CSUM packet. */ | |
67fa0341 | 316 | OVS_TUNNEL_KEY_ATTR_OAM, /* No argument. OAM frame. */ |
f5796684 | 317 | OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS, /* Array of Geneve options. */ |
7d5437c7 PS |
318 | __OVS_TUNNEL_KEY_ATTR_MAX |
319 | }; | |
320 | ||
321 | #define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1) | |
322 | ||
22e3880a TG |
323 | /** |
324 | * enum ovs_frag_type - IPv4 and IPv6 fragment type | |
325 | * @OVS_FRAG_TYPE_NONE: Packet is not a fragment. | |
326 | * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0. | |
327 | * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset. | |
328 | * | |
329 | * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct | |
330 | * ovs_key_ipv6. | |
331 | */ | |
332 | enum ovs_frag_type { | |
333 | OVS_FRAG_TYPE_NONE, | |
334 | OVS_FRAG_TYPE_FIRST, | |
335 | OVS_FRAG_TYPE_LATER, | |
336 | __OVS_FRAG_TYPE_MAX | |
337 | }; | |
338 | ||
339 | #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1) | |
340 | ||
341 | struct ovs_key_ethernet { | |
342 | __u8 eth_src[ETH_ALEN]; | |
343 | __u8 eth_dst[ETH_ALEN]; | |
344 | }; | |
345 | ||
25cd9ba0 SH |
346 | struct ovs_key_mpls { |
347 | __be32 mpls_lse; | |
348 | }; | |
349 | ||
22e3880a TG |
350 | struct ovs_key_ipv4 { |
351 | __be32 ipv4_src; | |
352 | __be32 ipv4_dst; | |
353 | __u8 ipv4_proto; | |
354 | __u8 ipv4_tos; | |
355 | __u8 ipv4_ttl; | |
356 | __u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */ | |
357 | }; | |
358 | ||
359 | struct ovs_key_ipv6 { | |
360 | __be32 ipv6_src[4]; | |
361 | __be32 ipv6_dst[4]; | |
362 | __be32 ipv6_label; /* 20-bits in least-significant bits. */ | |
363 | __u8 ipv6_proto; | |
364 | __u8 ipv6_tclass; | |
365 | __u8 ipv6_hlimit; | |
366 | __u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */ | |
367 | }; | |
368 | ||
369 | struct ovs_key_tcp { | |
370 | __be16 tcp_src; | |
371 | __be16 tcp_dst; | |
372 | }; | |
373 | ||
374 | struct ovs_key_udp { | |
375 | __be16 udp_src; | |
376 | __be16 udp_dst; | |
377 | }; | |
378 | ||
a175a723 JS |
379 | struct ovs_key_sctp { |
380 | __be16 sctp_src; | |
381 | __be16 sctp_dst; | |
382 | }; | |
383 | ||
22e3880a TG |
384 | struct ovs_key_icmp { |
385 | __u8 icmp_type; | |
386 | __u8 icmp_code; | |
387 | }; | |
388 | ||
389 | struct ovs_key_icmpv6 { | |
390 | __u8 icmpv6_type; | |
391 | __u8 icmpv6_code; | |
392 | }; | |
393 | ||
394 | struct ovs_key_arp { | |
395 | __be32 arp_sip; | |
396 | __be32 arp_tip; | |
397 | __be16 arp_op; | |
398 | __u8 arp_sha[ETH_ALEN]; | |
399 | __u8 arp_tha[ETH_ALEN]; | |
400 | }; | |
401 | ||
402 | struct ovs_key_nd { | |
1a4e96a0 JR |
403 | __be32 nd_target[4]; |
404 | __u8 nd_sll[ETH_ALEN]; | |
405 | __u8 nd_tll[ETH_ALEN]; | |
22e3880a TG |
406 | }; |
407 | ||
408 | /** | |
409 | * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands. | |
410 | * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow | |
411 | * key. Always present in notifications. Required for all requests (except | |
412 | * dumps). | |
413 | * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying | |
414 | * the actions to take for packets that match the key. Always present in | |
415 | * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional for | |
be52c9e9 JR |
416 | * %OVS_FLOW_CMD_SET requests. An %OVS_FLOW_CMD_SET without |
417 | * %OVS_FLOW_ATTR_ACTIONS will not modify the actions. To clear the actions, | |
418 | * an %OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given. | |
22e3880a TG |
419 | * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this |
420 | * flow. Present in notifications if the stats would be nonzero. Ignored in | |
421 | * requests. | |
422 | * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the | |
423 | * TCP flags seen on packets in this flow. Only present in notifications for | |
424 | * TCP flows, and only if it would be nonzero. Ignored in requests. | |
425 | * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on | |
426 | * the system monotonic clock, at which a packet was last processed for this | |
427 | * flow. Only present in notifications if a packet has been processed for this | |
428 | * flow. Ignored in requests. | |
429 | * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the | |
430 | * last-used time, accumulated TCP flags, and statistics for this flow. | |
431 | * Otherwise ignored in requests. Never present in notifications. | |
03f0d916 AZ |
432 | * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the |
433 | * mask bits for wildcarded flow match. Mask bit value '1' specifies exact | |
434 | * match with corresponding flow key bit, while mask bit value '0' specifies | |
435 | * a wildcarded match. Omitting attribute is treated as wildcarding all | |
436 | * corresponding fields. Optional for all requests. If not present, | |
437 | * all flow key bits are exact match bits. | |
22e3880a TG |
438 | * |
439 | * These attributes follow the &struct ovs_header within the Generic Netlink | |
440 | * payload for %OVS_FLOW_* commands. | |
441 | */ | |
442 | enum ovs_flow_attr { | |
443 | OVS_FLOW_ATTR_UNSPEC, | |
444 | OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */ | |
445 | OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */ | |
446 | OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */ | |
447 | OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */ | |
448 | OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */ | |
449 | OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */ | |
03f0d916 | 450 | OVS_FLOW_ATTR_MASK, /* Sequence of OVS_KEY_ATTR_* attributes. */ |
22e3880a TG |
451 | __OVS_FLOW_ATTR_MAX |
452 | }; | |
453 | ||
454 | #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1) | |
455 | ||
456 | /** | |
457 | * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action. | |
458 | * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with | |
459 | * @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of | |
460 | * %UINT32_MAX samples all packets and intermediate values sample intermediate | |
461 | * fractions of packets. | |
462 | * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event. | |
463 | * Actions are passed as nested attributes. | |
464 | * | |
465 | * Executes the specified actions with the given probability on a per-packet | |
466 | * basis. | |
467 | */ | |
468 | enum ovs_sample_attr { | |
469 | OVS_SAMPLE_ATTR_UNSPEC, | |
470 | OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */ | |
471 | OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */ | |
472 | __OVS_SAMPLE_ATTR_MAX, | |
473 | }; | |
474 | ||
475 | #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1) | |
476 | ||
477 | /** | |
478 | * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action. | |
479 | * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION | |
480 | * message should be sent. Required. | |
481 | * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is | |
482 | * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA. | |
483 | */ | |
484 | enum ovs_userspace_attr { | |
485 | OVS_USERSPACE_ATTR_UNSPEC, | |
486 | OVS_USERSPACE_ATTR_PID, /* u32 Netlink PID to receive upcalls. */ | |
487 | OVS_USERSPACE_ATTR_USERDATA, /* Optional user-specified cookie. */ | |
488 | __OVS_USERSPACE_ATTR_MAX | |
489 | }; | |
490 | ||
491 | #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1) | |
492 | ||
25cd9ba0 SH |
493 | /** |
494 | * struct ovs_action_push_mpls - %OVS_ACTION_ATTR_PUSH_MPLS action argument. | |
495 | * @mpls_lse: MPLS label stack entry to push. | |
496 | * @mpls_ethertype: Ethertype to set in the encapsulating ethernet frame. | |
497 | * | |
498 | * The only values @mpls_ethertype should ever be given are %ETH_P_MPLS_UC and | |
499 | * %ETH_P_MPLS_MC, indicating MPLS unicast or multicast. Other are rejected. | |
500 | */ | |
501 | struct ovs_action_push_mpls { | |
502 | __be32 mpls_lse; | |
503 | __be16 mpls_ethertype; /* Either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC */ | |
504 | }; | |
505 | ||
22e3880a TG |
506 | /** |
507 | * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument. | |
508 | * @vlan_tpid: Tag protocol identifier (TPID) to push. | |
509 | * @vlan_tci: Tag control identifier (TCI) to push. The CFI bit must be set | |
510 | * (but it will not be set in the 802.1Q header that is pushed). | |
511 | * | |
512 | * The @vlan_tpid value is typically %ETH_P_8021Q. The only acceptable TPID | |
513 | * values are those that the kernel module also parses as 802.1Q headers, to | |
514 | * prevent %OVS_ACTION_ATTR_PUSH_VLAN followed by %OVS_ACTION_ATTR_POP_VLAN | |
515 | * from having surprising results. | |
516 | */ | |
517 | struct ovs_action_push_vlan { | |
518 | __be16 vlan_tpid; /* 802.1Q TPID. */ | |
519 | __be16 vlan_tci; /* 802.1Q TCI (VLAN ID and priority). */ | |
520 | }; | |
521 | ||
971427f3 AZ |
522 | /* Data path hash algorithm for computing Datapath hash. |
523 | * | |
524 | * The algorithm type only specifies the fields in a flow | |
525 | * will be used as part of the hash. Each datapath is free | |
526 | * to use its own hash algorithm. The hash value will be | |
527 | * opaque to the user space daemon. | |
528 | */ | |
529 | enum ovs_hash_alg { | |
530 | OVS_HASH_ALG_L4, | |
531 | }; | |
532 | ||
533 | /* | |
534 | * struct ovs_action_hash - %OVS_ACTION_ATTR_HASH action argument. | |
535 | * @hash_alg: Algorithm used to compute hash prior to recirculation. | |
536 | * @hash_basis: basis used for computing hash. | |
537 | */ | |
538 | struct ovs_action_hash { | |
539 | uint32_t hash_alg; /* One of ovs_hash_alg. */ | |
540 | uint32_t hash_basis; | |
541 | }; | |
542 | ||
22e3880a TG |
543 | /** |
544 | * enum ovs_action_attr - Action types. | |
545 | * | |
546 | * @OVS_ACTION_ATTR_OUTPUT: Output packet to port. | |
547 | * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested | |
548 | * %OVS_USERSPACE_ATTR_* attributes. | |
549 | * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header. The | |
550 | * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its | |
551 | * value. | |
552 | * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q header onto the | |
553 | * packet. | |
554 | * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q header off the packet. | |
555 | * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in | |
556 | * the nested %OVS_SAMPLE_ATTR_* attributes. | |
25cd9ba0 SH |
557 | * @OVS_ACTION_ATTR_PUSH_MPLS: Push a new MPLS label stack entry onto the |
558 | * top of the packets MPLS label stack. Set the ethertype of the | |
559 | * encapsulating frame to either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC to | |
560 | * indicate the new packet contents. | |
561 | * @OVS_ACTION_ATTR_POP_MPLS: Pop an MPLS label stack entry off of the | |
562 | * packet's MPLS label stack. Set the encapsulating frame's ethertype to | |
563 | * indicate the new packet contents. This could potentially still be | |
564 | * %ETH_P_MPLS if the resulting MPLS label stack is not empty. If there | |
565 | * is no MPLS label stack, as determined by ethertype, no action is taken. | |
22e3880a TG |
566 | * |
567 | * Only a single header can be set with a single %OVS_ACTION_ATTR_SET. Not all | |
568 | * fields within a header are modifiable, e.g. the IPv4 protocol and fragment | |
569 | * type may not be changed. | |
570 | */ | |
571 | ||
572 | enum ovs_action_attr { | |
573 | OVS_ACTION_ATTR_UNSPEC, | |
574 | OVS_ACTION_ATTR_OUTPUT, /* u32 port number. */ | |
575 | OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */ | |
576 | OVS_ACTION_ATTR_SET, /* One nested OVS_KEY_ATTR_*. */ | |
577 | OVS_ACTION_ATTR_PUSH_VLAN, /* struct ovs_action_push_vlan. */ | |
578 | OVS_ACTION_ATTR_POP_VLAN, /* No argument. */ | |
579 | OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */ | |
971427f3 AZ |
580 | OVS_ACTION_ATTR_RECIRC, /* u32 recirc_id. */ |
581 | OVS_ACTION_ATTR_HASH, /* struct ovs_action_hash. */ | |
25cd9ba0 SH |
582 | OVS_ACTION_ATTR_PUSH_MPLS, /* struct ovs_action_push_mpls. */ |
583 | OVS_ACTION_ATTR_POP_MPLS, /* __be16 ethertype. */ | |
584 | ||
22e3880a TG |
585 | __OVS_ACTION_ATTR_MAX |
586 | }; | |
587 | ||
588 | #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1) | |
589 | ||
590 | #endif /* _LINUX_OPENVSWITCH_H */ |