]> git.proxmox.com Git - mirror_ovs.git/blob - datapath/linux/compat/include/linux/openvswitch.h
cc41bbea439d3715ab4fd03fe564d940211862c3
[mirror_ovs.git] / datapath / linux / compat / include / linux / openvswitch.h
1 /*
2 * Copyright (c) 2007-2017 Nicira, Inc.
3 *
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.
10 *
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 * ----------------------------------------------------------------------
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.
27 *
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.
32 *
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
37 * ----------------------------------------------------------------------
38 */
39
40 #ifndef _LINUX_OPENVSWITCH_H
41 #define _LINUX_OPENVSWITCH_H 1
42
43 #include <linux/types.h>
44 #include <linux/if_ether.h>
45
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. */
60
61 #define OVS_DATAPATH_FAMILY "ovs_datapath"
62 #define OVS_DATAPATH_MCGROUP "ovs_datapath"
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
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
79 };
80
81 /**
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
84 * port". This is the name of the network device whose dp_ifindex is given in
85 * the &struct ovs_header. Always present in notifications. Required in
86 * %OVS_DP_NEW requests. May be used as an alternative to specifying
87 * dp_ifindex in other requests (with a dp_ifindex of 0).
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.
92 * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the
93 * datapath. Always present in notifications.
94 * @OVS_DP_ATTR_MEGAFLOW_STATS: Statistics about mega flow masks usage for the
95 * datapath. Always present in notifications.
96 *
97 * These attributes follow the &struct ovs_header within the Generic Netlink
98 * payload for %OVS_DP_* commands.
99 */
100 enum ovs_datapath_attr {
101 OVS_DP_ATTR_UNSPEC,
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 */
106 OVS_DP_ATTR_USER_FEATURES, /* OVS_DP_F_* */
107 OVS_DP_ATTR_PAD,
108 __OVS_DP_ATTR_MAX
109 };
110
111 #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
112
113 /* All 64-bit integers within Netlink messages are 4-byte aligned only. */
114 struct ovs_dp_stats {
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 */
119 };
120
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
129 struct ovs_vport_stats {
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 */
138 };
139
140 /* Allow last Netlink attribute to be unaligned */
141 #define OVS_DP_F_UNALIGNED (1 << 0)
142
143 /* Allow datapath to associate multiple Netlink PIDs to each vport */
144 #define OVS_DP_F_VPORT_PIDS (1 << 1)
145
146 /* Allow tc offload recirc sharing */
147 #define OVS_DP_F_TC_RECIRC_SHARING (1 << 2)
148
149 /* Fixed logical ports. */
150 #define OVSP_LOCAL ((__u32)0)
151
152 /* Packet transfer. */
153
154 #define OVS_PACKET_FAMILY "ovs_packet"
155 #define OVS_PACKET_VERSION 0x1
156
157 enum ovs_packet_cmd {
158 OVS_PACKET_CMD_UNSPEC,
159
160 /* Kernel-to-user notifications. */
161 OVS_PACKET_CMD_MISS, /* Flow table miss. */
162 OVS_PACKET_CMD_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */
163
164 /* Userspace commands. */
165 OVS_PACKET_CMD_EXECUTE /* Apply actions to a packet. */
166 };
167
168 /**
169 * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
170 * @OVS_PACKET_ATTR_PACKET: Present for all notifications. Contains the entire
171 * packet as received, from the start of the Ethernet header onward. For
172 * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
173 * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
174 * the flow key extracted from the packet as originally received.
175 * @OVS_PACKET_ATTR_KEY: Present for all notifications. Contains the flow key
176 * extracted from the packet as nested %OVS_KEY_ATTR_* attributes. This allows
177 * userspace to adapt its flow setup strategy by comparing its notion of the
178 * flow key against the kernel's. When used with %OVS_PACKET_CMD_EXECUTE, only
179 * metadata key fields (e.g. priority, skb mark) are honored. All the packet
180 * header fields are parsed from the packet instead.
181 * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet. Used
182 * for %OVS_PACKET_CMD_EXECUTE. It has nested %OVS_ACTION_ATTR_* attributes.
183 * Also used in upcall when %OVS_ACTION_ATTR_USERSPACE has optional
184 * %OVS_USERSPACE_ATTR_ACTIONS attribute.
185 * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
186 * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
187 * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content
188 * specified there.
189 * @OVS_PACKET_ATTR_EGRESS_TUN_KEY: Present for an %OVS_PACKET_CMD_ACTION
190 * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
191 * %OVS_USERSPACE_ATTR_EGRESS_TUN_PORT attribute, which is sent only if the
192 * output port is actually a tunnel port. Contains the output tunnel key
193 * extracted from the packet as nested %OVS_TUNNEL_KEY_ATTR_* attributes.
194 * @OVS_PACKET_ATTR_MRU: Present for an %OVS_PACKET_CMD_ACTION and
195 * @OVS_PACKET_ATTR_LEN: Packet size before truncation.
196 * %OVS_PACKET_ATTR_USERSPACE action specify the Maximum received fragment
197 * size.
198 *
199 * These attributes follow the &struct ovs_header within the Generic Netlink
200 * payload for %OVS_PACKET_* commands.
201 */
202 enum ovs_packet_attr {
203 OVS_PACKET_ATTR_UNSPEC,
204 OVS_PACKET_ATTR_PACKET, /* Packet data. */
205 OVS_PACKET_ATTR_KEY, /* Nested OVS_KEY_ATTR_* attributes. */
206 OVS_PACKET_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
207 OVS_PACKET_ATTR_USERDATA, /* OVS_ACTION_ATTR_USERSPACE arg. */
208 OVS_PACKET_ATTR_EGRESS_TUN_KEY, /* Nested OVS_TUNNEL_KEY_ATTR_*
209 attributes. */
210 OVS_PACKET_ATTR_UNUSED1,
211 OVS_PACKET_ATTR_UNUSED2,
212 OVS_PACKET_ATTR_PROBE, /* Packet operation is a feature probe,
213 error logging should be suppressed. */
214 OVS_PACKET_ATTR_MRU, /* Maximum received IP fragment size. */
215 OVS_PACKET_ATTR_LEN, /* Packet size before truncation. */
216 OVS_PACKET_ATTR_HASH, /* Packet hash. */
217 __OVS_PACKET_ATTR_MAX
218 };
219
220 #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
221
222 /* Virtual ports. */
223
224 #define OVS_VPORT_FAMILY "ovs_vport"
225 #define OVS_VPORT_MCGROUP "ovs_vport"
226 #define OVS_VPORT_VERSION 0x1
227
228 enum ovs_vport_cmd {
229 OVS_VPORT_CMD_UNSPEC,
230 OVS_VPORT_CMD_NEW,
231 OVS_VPORT_CMD_DEL,
232 OVS_VPORT_CMD_GET,
233 OVS_VPORT_CMD_SET
234 };
235
236 enum ovs_vport_type {
237 OVS_VPORT_TYPE_UNSPEC,
238 OVS_VPORT_TYPE_NETDEV, /* network device */
239 OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
240 OVS_VPORT_TYPE_GRE, /* GRE tunnel. */
241 OVS_VPORT_TYPE_VXLAN, /* VXLAN tunnel. */
242 OVS_VPORT_TYPE_GENEVE, /* Geneve tunnel. */
243 OVS_VPORT_TYPE_LISP = 105, /* LISP tunnel */
244 OVS_VPORT_TYPE_STT = 106, /* STT tunnel */
245 OVS_VPORT_TYPE_ERSPAN = 107, /* ERSPAN tunnel. */
246 OVS_VPORT_TYPE_IP6ERSPAN = 108, /* ERSPAN tunnel. */
247 OVS_VPORT_TYPE_IP6GRE = 109,
248 OVS_VPORT_TYPE_GTPU = 110,
249 __OVS_VPORT_TYPE_MAX
250 };
251
252 #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
253
254 /**
255 * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
256 * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
257 * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
258 * of vport.
259 * @OVS_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device
260 * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes
261 * plus a null terminator.
262 * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information.
263 * @OVS_VPORT_ATTR_UPCALL_PID: The array of Netlink socket pids in userspace
264 * among which OVS_PACKET_CMD_MISS upcalls will be distributed for packets
265 * received on this port. If this is a single-element array of value 0,
266 * upcalls should not be sent.
267 * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
268 * packets sent or received through the vport.
269 *
270 * These attributes follow the &struct ovs_header within the Generic Netlink
271 * payload for %OVS_VPORT_* commands.
272 *
273 * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
274 * %OVS_VPORT_ATTR_NAME attributes are required. %OVS_VPORT_ATTR_PORT_NO is
275 * optional; if not specified a free port number is automatically selected.
276 * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
277 * of vport. %OVS_VPORT_ATTR_STATS is optional and other attributes are
278 * ignored.
279 *
280 * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
281 * look up the vport to operate on; otherwise dp_idx from the &struct
282 * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
283 */
284 enum ovs_vport_attr {
285 OVS_VPORT_ATTR_UNSPEC,
286 OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */
287 OVS_VPORT_ATTR_TYPE, /* u32 OVS_VPORT_TYPE_* constant. */
288 OVS_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */
289 OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
290 OVS_VPORT_ATTR_UPCALL_PID, /* array of u32 Netlink socket PIDs for */
291 /* receiving upcalls */
292 OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */
293 OVS_VPORT_ATTR_PAD,
294 OVS_VPORT_ATTR_IFINDEX,
295 OVS_VPORT_ATTR_NETNSID,
296 __OVS_VPORT_ATTR_MAX
297 };
298
299 #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
300
301 enum {
302 OVS_VXLAN_EXT_UNSPEC,
303 OVS_VXLAN_EXT_GBP,
304 /* place new values here to fill gap. */
305 OVS_VXLAN_EXT_GPE = 8,
306 __OVS_VXLAN_EXT_MAX,
307 };
308
309 #define OVS_VXLAN_EXT_MAX (__OVS_VXLAN_EXT_MAX - 1)
310
311 /* OVS_VPORT_ATTR_OPTIONS attributes for tunnels.
312 */
313 enum {
314 OVS_TUNNEL_ATTR_UNSPEC,
315 OVS_TUNNEL_ATTR_DST_PORT, /* 16-bit UDP port, used by L4 tunnels. */
316 OVS_TUNNEL_ATTR_EXTENSION,
317 __OVS_TUNNEL_ATTR_MAX
318 };
319
320 #define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1)
321
322 /* Flows. */
323
324 #define OVS_FLOW_FAMILY "ovs_flow"
325 #define OVS_FLOW_MCGROUP "ovs_flow"
326 #define OVS_FLOW_VERSION 0x1
327
328 enum ovs_flow_cmd {
329 OVS_FLOW_CMD_UNSPEC,
330 OVS_FLOW_CMD_NEW,
331 OVS_FLOW_CMD_DEL,
332 OVS_FLOW_CMD_GET,
333 OVS_FLOW_CMD_SET
334 };
335
336 struct ovs_flow_stats {
337 __u64 n_packets; /* Number of matched packets. */
338 __u64 n_bytes; /* Number of matched bytes. */
339 };
340
341 enum ovs_key_attr {
342 OVS_KEY_ATTR_UNSPEC,
343 OVS_KEY_ATTR_ENCAP, /* Nested set of encapsulated attributes. */
344 OVS_KEY_ATTR_PRIORITY, /* u32 skb->priority */
345 OVS_KEY_ATTR_IN_PORT, /* u32 OVS dp port number */
346 OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */
347 OVS_KEY_ATTR_VLAN, /* be16 VLAN TCI */
348 OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */
349 OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */
350 OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */
351 OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */
352 OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */
353 OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */
354 OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */
355 OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */
356 OVS_KEY_ATTR_ND, /* struct ovs_key_nd */
357 OVS_KEY_ATTR_SKB_MARK, /* u32 skb mark */
358 OVS_KEY_ATTR_TUNNEL, /* Nested set of ovs_tunnel attributes */
359 OVS_KEY_ATTR_SCTP, /* struct ovs_key_sctp */
360 OVS_KEY_ATTR_TCP_FLAGS, /* be16 TCP flags. */
361 OVS_KEY_ATTR_DP_HASH, /* u32 hash value. Value 0 indicates the hash
362 is not computed by the datapath. */
363 OVS_KEY_ATTR_RECIRC_ID, /* u32 recirc id */
364 OVS_KEY_ATTR_MPLS, /* array of struct ovs_key_mpls.
365 * The implementation may restrict
366 * the accepted length of the array. */
367 OVS_KEY_ATTR_CT_STATE, /* u32 bitmask of OVS_CS_F_* */
368 OVS_KEY_ATTR_CT_ZONE, /* u16 connection tracking zone. */
369 OVS_KEY_ATTR_CT_MARK, /* u32 connection tracking mark */
370 OVS_KEY_ATTR_CT_LABELS, /* 16-octet connection tracking labels */
371 OVS_KEY_ATTR_CT_ORIG_TUPLE_IPV4, /* struct ovs_key_ct_tuple_ipv4 */
372 OVS_KEY_ATTR_CT_ORIG_TUPLE_IPV6, /* struct ovs_key_ct_tuple_ipv6 */
373 OVS_KEY_ATTR_NSH, /* Nested set of ovs_nsh_key_* */
374
375 #ifdef __KERNEL__
376 /* Only used within kernel data path. */
377 OVS_KEY_ATTR_TUNNEL_INFO, /* struct ovs_tunnel_info */
378 #endif
379
380 #ifndef __KERNEL__
381 /* Only used within userspace data path. */
382 OVS_KEY_ATTR_PACKET_TYPE, /* be32 packet type */
383 OVS_KEY_ATTR_ND_EXTENSIONS, /* struct ovs_key_nd_extensions */
384 #endif
385
386 __OVS_KEY_ATTR_MAX
387 };
388
389 #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
390
391 enum ovs_tunnel_key_attr {
392 OVS_TUNNEL_KEY_ATTR_ID, /* be64 Tunnel ID */
393 OVS_TUNNEL_KEY_ATTR_IPV4_SRC, /* be32 src IP address. */
394 OVS_TUNNEL_KEY_ATTR_IPV4_DST, /* be32 dst IP address. */
395 OVS_TUNNEL_KEY_ATTR_TOS, /* u8 Tunnel IP ToS. */
396 OVS_TUNNEL_KEY_ATTR_TTL, /* u8 Tunnel IP TTL. */
397 OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT, /* No argument, set DF. */
398 OVS_TUNNEL_KEY_ATTR_CSUM, /* No argument. CSUM packet. */
399 OVS_TUNNEL_KEY_ATTR_OAM, /* No argument. OAM frame. */
400 OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS, /* Array of Geneve options. */
401 OVS_TUNNEL_KEY_ATTR_TP_SRC, /* be16 src Transport Port. */
402 OVS_TUNNEL_KEY_ATTR_TP_DST, /* be16 dst Transport Port. */
403 OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS, /* Nested OVS_VXLAN_EXT_* */
404 OVS_TUNNEL_KEY_ATTR_IPV6_SRC, /* struct in6_addr src IPv6 address. */
405 OVS_TUNNEL_KEY_ATTR_IPV6_DST, /* struct in6_addr dst IPv6 address. */
406 OVS_TUNNEL_KEY_ATTR_PAD,
407 OVS_TUNNEL_KEY_ATTR_ERSPAN_OPTS, /* struct erspan_metadata */
408 OVS_TUNNEL_KEY_ATTR_GTPU_OPTS, /* struct gtpu_metadata */
409 __OVS_TUNNEL_KEY_ATTR_MAX
410 };
411
412 #define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1)
413
414 /**
415 * enum xlate_error - Different types of error during translation
416 */
417
418 #ifndef __KERNEL__
419 enum xlate_error {
420 XLATE_OK = 0,
421 XLATE_BRIDGE_NOT_FOUND,
422 XLATE_RECURSION_TOO_DEEP,
423 XLATE_TOO_MANY_RESUBMITS,
424 XLATE_STACK_TOO_DEEP,
425 XLATE_NO_RECIRCULATION_CONTEXT,
426 XLATE_RECIRCULATION_CONFLICT,
427 XLATE_TOO_MANY_MPLS_LABELS,
428 XLATE_INVALID_TUNNEL_METADATA,
429 XLATE_UNSUPPORTED_PACKET_TYPE,
430 XLATE_CONGESTION_DROP,
431 XLATE_FORWARDING_DISABLED,
432 XLATE_MAX,
433 };
434 #endif
435
436 /**
437 * enum ovs_frag_type - IPv4 and IPv6 fragment type
438 * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
439 * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
440 * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
441 *
442 * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
443 * ovs_key_ipv6.
444 */
445 enum ovs_frag_type {
446 OVS_FRAG_TYPE_NONE,
447 OVS_FRAG_TYPE_FIRST,
448 OVS_FRAG_TYPE_LATER,
449 __OVS_FRAG_TYPE_MAX
450 };
451
452 #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
453
454 struct ovs_key_ethernet {
455 __u8 eth_src[ETH_ALEN];
456 __u8 eth_dst[ETH_ALEN];
457 };
458
459 struct ovs_key_mpls {
460 __be32 mpls_lse;
461 };
462
463 struct ovs_key_ipv4 {
464 __be32 ipv4_src;
465 __be32 ipv4_dst;
466 __u8 ipv4_proto;
467 __u8 ipv4_tos;
468 __u8 ipv4_ttl;
469 __u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */
470 };
471
472 struct ovs_key_ipv6 {
473 __be32 ipv6_src[4];
474 __be32 ipv6_dst[4];
475 __be32 ipv6_label; /* 20-bits in least-significant bits. */
476 __u8 ipv6_proto;
477 __u8 ipv6_tclass;
478 __u8 ipv6_hlimit;
479 __u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */
480 };
481
482 struct ovs_key_tcp {
483 __be16 tcp_src;
484 __be16 tcp_dst;
485 };
486
487 struct ovs_key_udp {
488 __be16 udp_src;
489 __be16 udp_dst;
490 };
491
492 struct ovs_key_sctp {
493 __be16 sctp_src;
494 __be16 sctp_dst;
495 };
496
497 struct ovs_key_icmp {
498 __u8 icmp_type;
499 __u8 icmp_code;
500 };
501
502 struct ovs_key_icmpv6 {
503 __u8 icmpv6_type;
504 __u8 icmpv6_code;
505 };
506
507 struct ovs_key_arp {
508 __be32 arp_sip;
509 __be32 arp_tip;
510 __be16 arp_op;
511 __u8 arp_sha[ETH_ALEN];
512 __u8 arp_tha[ETH_ALEN];
513 };
514
515 struct ovs_key_nd {
516 __be32 nd_target[4];
517 __u8 nd_sll[ETH_ALEN];
518 __u8 nd_tll[ETH_ALEN];
519 };
520
521 #ifndef __KERNEL__
522 struct ovs_key_nd_extensions {
523 __be32 nd_reserved;
524 __u8 nd_options_type;
525 };
526 #endif
527
528 #define OVS_CT_LABELS_LEN_32 4
529 #define OVS_CT_LABELS_LEN (OVS_CT_LABELS_LEN_32 * sizeof(__u32))
530 struct ovs_key_ct_labels {
531 union {
532 __u8 ct_labels[OVS_CT_LABELS_LEN];
533 __u32 ct_labels_32[OVS_CT_LABELS_LEN_32];
534 };
535 };
536
537 enum ovs_nsh_key_attr {
538 OVS_NSH_KEY_ATTR_UNSPEC,
539 OVS_NSH_KEY_ATTR_BASE, /* struct ovs_nsh_key_base. */
540 OVS_NSH_KEY_ATTR_MD1, /* struct ovs_nsh_key_md1. */
541 OVS_NSH_KEY_ATTR_MD2, /* variable-length octets. */
542 __OVS_NSH_KEY_ATTR_MAX
543 };
544
545 #define OVS_NSH_KEY_ATTR_MAX (__OVS_NSH_KEY_ATTR_MAX - 1)
546
547 struct ovs_nsh_key_base {
548 __u8 flags;
549 __u8 ttl;
550 __u8 mdtype;
551 __u8 np;
552 __be32 path_hdr;
553 };
554
555 #define NSH_MD1_CONTEXT_SIZE 4
556
557 struct ovs_nsh_key_md1 {
558 __be32 context[NSH_MD1_CONTEXT_SIZE];
559 };
560
561 /* OVS_KEY_ATTR_CT_STATE flags */
562 #define OVS_CS_F_NEW 0x01 /* Beginning of a new connection. */
563 #define OVS_CS_F_ESTABLISHED 0x02 /* Part of an existing connection. */
564 #define OVS_CS_F_RELATED 0x04 /* Related to an established
565 * connection. */
566 #define OVS_CS_F_REPLY_DIR 0x08 /* Flow is in the reply direction. */
567 #define OVS_CS_F_INVALID 0x10 /* Could not track connection. */
568 #define OVS_CS_F_TRACKED 0x20 /* Conntrack has occurred. */
569 #define OVS_CS_F_SRC_NAT 0x40 /* Packet's source address/port was
570 mangled by NAT. */
571 #define OVS_CS_F_DST_NAT 0x80 /* Packet's destination address/port
572 was mangled by NAT. */
573
574 #define OVS_CS_F_NAT_MASK (OVS_CS_F_SRC_NAT | OVS_CS_F_DST_NAT)
575
576 struct ovs_key_ct_tuple_ipv4 {
577 __be32 ipv4_src;
578 __be32 ipv4_dst;
579 __be16 src_port;
580 __be16 dst_port;
581 __u8 ipv4_proto;
582 };
583
584 struct ovs_key_ct_tuple_ipv6 {
585 __be32 ipv6_src[4];
586 __be32 ipv6_dst[4];
587 __be16 src_port;
588 __be16 dst_port;
589 __u8 ipv6_proto;
590 };
591
592 /**
593 * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
594 * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
595 * key. Always present in notifications. Required for all requests (except
596 * dumps).
597 * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
598 * the actions to take for packets that match the key. Always present in
599 * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional for
600 * %OVS_FLOW_CMD_SET requests. An %OVS_FLOW_CMD_SET without
601 * %OVS_FLOW_ATTR_ACTIONS will not modify the actions. To clear the actions,
602 * an %OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given.
603 * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
604 * flow. Present in notifications if the stats would be nonzero. Ignored in
605 * requests.
606 * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
607 * TCP flags seen on packets in this flow. Only present in notifications for
608 * TCP flows, and only if it would be nonzero. Ignored in requests.
609 * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
610 * the system monotonic clock, at which a packet was last processed for this
611 * flow. Only present in notifications if a packet has been processed for this
612 * flow. Ignored in requests.
613 * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
614 * last-used time, accumulated TCP flags, and statistics for this flow.
615 * Otherwise ignored in requests. Never present in notifications.
616 * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the
617 * mask bits for wildcarded flow match. Mask bit value '1' specifies exact
618 * match with corresponding flow key bit, while mask bit value '0' specifies
619 * a wildcarded match. Omitting attribute is treated as wildcarding all
620 * corresponding fields. Optional for all requests. If not present,
621 * all flow key bits are exact match bits.
622 * @OVS_FLOW_ATTR_UFID: A value between 1-16 octets specifying a unique
623 * identifier for the flow. Causes the flow to be indexed by this value rather
624 * than the value of the %OVS_FLOW_ATTR_KEY attribute. Optional for all
625 * requests. Present in notifications if the flow was created with this
626 * attribute.
627 * @OVS_FLOW_ATTR_UFID_FLAGS: A 32-bit value of OR'd %OVS_UFID_F_*
628 * flags that provide alternative semantics for flow installation and
629 * retrieval. Optional for all requests.
630 *
631 * These attributes follow the &struct ovs_header within the Generic Netlink
632 * payload for %OVS_FLOW_* commands.
633 */
634 enum ovs_flow_attr {
635 OVS_FLOW_ATTR_UNSPEC,
636 OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */
637 OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
638 OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */
639 OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
640 OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */
641 OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */
642 OVS_FLOW_ATTR_MASK, /* Sequence of OVS_KEY_ATTR_* attributes. */
643 OVS_FLOW_ATTR_PROBE, /* Flow operation is a feature probe, error
644 * logging should be suppressed. */
645 OVS_FLOW_ATTR_UFID, /* Variable length unique flow identifier. */
646 OVS_FLOW_ATTR_UFID_FLAGS,/* u32 of OVS_UFID_F_*. */
647 OVS_FLOW_ATTR_PAD,
648 __OVS_FLOW_ATTR_MAX
649 };
650
651 #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
652
653 /**
654 * Omit attributes for notifications.
655 *
656 * If a datapath request contains an OVS_UFID_F_OMIT_* flag, then the datapath
657 * may omit the corresponding 'ovs_flow_attr' from the response.
658 */
659 #define OVS_UFID_F_OMIT_KEY (1 << 0)
660 #define OVS_UFID_F_OMIT_MASK (1 << 1)
661 #define OVS_UFID_F_OMIT_ACTIONS (1 << 2)
662
663 /**
664 * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
665 * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
666 * @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of
667 * %UINT32_MAX samples all packets and intermediate values sample intermediate
668 * fractions of packets.
669 * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
670 * Actions are passed as nested attributes.
671 *
672 * Executes the specified actions with the given probability on a per-packet
673 * basis.
674 */
675 enum ovs_sample_attr {
676 OVS_SAMPLE_ATTR_UNSPEC,
677 OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
678 OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
679 __OVS_SAMPLE_ATTR_MAX,
680
681 #ifdef __KERNEL__
682 OVS_SAMPLE_ATTR_ARG /* struct sample_arg */
683 #endif
684 };
685
686 #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
687
688 #ifdef __KERNEL__
689 struct sample_arg {
690 bool exec; /* When true, actions in sample will not
691 * change flow keys. False otherwise.
692 */
693 u32 probability; /* Same value as
694 * 'OVS_SAMPLE_ATTR_PROBABILITY'.
695 */
696 };
697 #endif
698
699 /**
700 * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
701 * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
702 * message should be sent. Required.
703 * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is
704 * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA.
705 * @OVS_USERSPACE_ATTR_EGRESS_TUN_PORT: If present, u32 output port to get
706 * tunnel info.
707 * @OVS_USERSPACE_ATTR_ACTIONS: If present, send actions with upcall.
708 */
709 enum ovs_userspace_attr {
710 OVS_USERSPACE_ATTR_UNSPEC,
711 OVS_USERSPACE_ATTR_PID, /* u32 Netlink PID to receive upcalls. */
712 OVS_USERSPACE_ATTR_USERDATA, /* Optional user-specified cookie. */
713 OVS_USERSPACE_ATTR_EGRESS_TUN_PORT, /* Optional, u32 output port
714 * to get tunnel info. */
715 OVS_USERSPACE_ATTR_ACTIONS, /* Optional flag to get actions. */
716 __OVS_USERSPACE_ATTR_MAX
717 };
718
719 #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
720
721 struct ovs_action_trunc {
722 uint32_t max_len; /* Max packet size in bytes. */
723 };
724
725 /**
726 * struct ovs_action_push_mpls - %OVS_ACTION_ATTR_PUSH_MPLS action argument.
727 * @mpls_lse: MPLS label stack entry to push.
728 * @mpls_ethertype: Ethertype to set in the encapsulating ethernet frame.
729 *
730 * The only values @mpls_ethertype should ever be given are %ETH_P_MPLS_UC and
731 * %ETH_P_MPLS_MC, indicating MPLS unicast or multicast. Other are rejected.
732 */
733 struct ovs_action_push_mpls {
734 __be32 mpls_lse;
735 __be16 mpls_ethertype; /* Either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC */
736 };
737
738 /**
739 * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument.
740 * @vlan_tpid: Tag protocol identifier (TPID) to push.
741 * @vlan_tci: Tag control identifier (TCI) to push. The CFI bit must be set
742 * (but it will not be set in the 802.1Q header that is pushed).
743 *
744 * The @vlan_tpid value is typically %ETH_P_8021Q or %ETH_P_8021AD.
745 * The only acceptable TPID values are those that the kernel module also parses
746 * as 802.1Q or 802.1AD headers, to prevent %OVS_ACTION_ATTR_PUSH_VLAN followed
747 * by %OVS_ACTION_ATTR_POP_VLAN from having surprising results.
748 */
749 struct ovs_action_push_vlan {
750 __be16 vlan_tpid; /* 802.1Q or 802.1ad TPID. */
751 __be16 vlan_tci; /* 802.1Q TCI (VLAN ID and priority). */
752 };
753
754 /* Data path hash algorithm for computing Datapath hash.
755 *
756 * The algorithm type only specifies the fields in a flow
757 * will be used as part of the hash. Each datapath is free
758 * to use its own hash algorithm. The hash value will be
759 * opaque to the user space daemon.
760 */
761 enum ovs_hash_alg {
762 OVS_HASH_ALG_L4,
763 #ifndef __KERNEL__
764 OVS_HASH_ALG_SYM_L4,
765 #endif
766 __OVS_HASH_MAX
767 };
768
769 /*
770 * struct ovs_action_hash - %OVS_ACTION_ATTR_HASH action argument.
771 * @hash_alg: Algorithm used to compute hash prior to recirculation.
772 * @hash_basis: basis used for computing hash.
773 */
774 struct ovs_action_hash {
775 uint32_t hash_alg; /* One of ovs_hash_alg. */
776 uint32_t hash_basis;
777 };
778
779 #ifndef __KERNEL__
780 #define TNL_PUSH_HEADER_SIZE 512
781
782 /*
783 * struct ovs_action_push_tnl - %OVS_ACTION_ATTR_TUNNEL_PUSH
784 * @tnl_port: To identify tunnel port to pass header info.
785 * @out_port: Physical port to send encapsulated packet.
786 * @header_len: Length of the header to be pushed.
787 * @tnl_type: This is only required to format this header. Otherwise
788 * ODP layer can not parse %header.
789 * @header: Partial header for the tunnel. Tunnel push action can use
790 * this header to build final header according to actual packet parameters.
791 */
792 struct ovs_action_push_tnl {
793 odp_port_t tnl_port;
794 odp_port_t out_port;
795 uint32_t header_len;
796 uint32_t tnl_type; /* For logging. */
797 uint32_t header[TNL_PUSH_HEADER_SIZE / 4];
798 };
799 #endif
800
801 /**
802 * enum ovs_ct_attr - Attributes for %OVS_ACTION_ATTR_CT action.
803 * @OVS_CT_ATTR_COMMIT: If present, commits the connection to the conntrack
804 * table. This allows future packets for the same connection to be identified
805 * as 'established' or 'related'. The flow key for the current packet will
806 * retain the pre-commit connection state.
807 * @OVS_CT_ATTR_ZONE: u16 connection tracking zone.
808 * @OVS_CT_ATTR_MARK: u32 value followed by u32 mask. For each bit set in the
809 * mask, the corresponding bit in the value is copied to the connection
810 * tracking mark field in the connection.
811 * @OVS_CT_ATTR_LABELS: %OVS_CT_LABELS_LEN value followed by %OVS_CT_LABELS_LEN
812 * mask. For each bit set in the mask, the corresponding bit in the value is
813 * copied to the connection tracking label field in the connection.
814 * @OVS_CT_ATTR_HELPER: variable length string defining conntrack ALG.
815 * @OVS_CT_ATTR_NAT: Nested OVS_NAT_ATTR_* for performing L3 network address
816 * translation (NAT) on the packet.
817 * @OVS_CT_ATTR_FORCE_COMMIT: Like %OVS_CT_ATTR_COMMIT, but instead of doing
818 * nothing if the connection is already committed will check that the current
819 * packet is in conntrack entry's original direction. If directionality does
820 * not match, will delete the existing conntrack entry and create a new one.
821 * @OVS_CT_ATTR_EVENTMASK: Mask of bits indicating which conntrack event types
822 * (enum ip_conntrack_events IPCT_*) should be reported. For any bit set to
823 * zero, the corresponding event type is not generated. Default behavior
824 * depends on system configuration, but typically all event types are
825 * generated, hence listening on NFNLGRP_CONNTRACK_UPDATE events may get a lot
826 * of events. Explicitly passing this attribute allows limiting the updates
827 * received to the events of interest. The bit 1 << IPCT_NEW, 1 <<
828 * IPCT_RELATED, and 1 << IPCT_DESTROY must be set to ones for those events to
829 * be received on NFNLGRP_CONNTRACK_NEW and NFNLGRP_CONNTRACK_DESTROY groups,
830 * respectively. Remaining bits control the changes for which an event is
831 * delivered on the NFNLGRP_CONNTRACK_UPDATE group.
832 * @OVS_CT_ATTR_TIMEOUT: Variable length string defining conntrack timeout.
833 */
834 enum ovs_ct_attr {
835 OVS_CT_ATTR_UNSPEC,
836 OVS_CT_ATTR_COMMIT, /* No argument, commits connection. */
837 OVS_CT_ATTR_ZONE, /* u16 zone id. */
838 OVS_CT_ATTR_MARK, /* mark to associate with this connection. */
839 OVS_CT_ATTR_LABELS, /* label to associate with this connection. */
840 OVS_CT_ATTR_HELPER, /* netlink helper to assist detection of
841 related connections. */
842 OVS_CT_ATTR_NAT, /* Nested OVS_NAT_ATTR_* */
843 OVS_CT_ATTR_FORCE_COMMIT, /* No argument */
844 OVS_CT_ATTR_EVENTMASK, /* u32 mask of IPCT_* events. */
845 OVS_CT_ATTR_TIMEOUT, /* Associate timeout with this connection for
846 * fine-grain timeout tuning. */
847
848 __OVS_CT_ATTR_MAX
849 };
850
851 #define OVS_CT_ATTR_MAX (__OVS_CT_ATTR_MAX - 1)
852
853 /*
854 * struct ovs_action_push_eth - %OVS_ACTION_ATTR_PUSH_ETH action argument.
855 * @addresses: Source and destination MAC addresses.
856 */
857 struct ovs_action_push_eth {
858 struct ovs_key_ethernet addresses;
859 };
860
861 /**
862 * enum ovs_nat_attr - Attributes for %OVS_CT_ATTR_NAT.
863 *
864 * @OVS_NAT_ATTR_SRC: Flag for Source NAT (mangle source address/port).
865 * @OVS_NAT_ATTR_DST: Flag for Destination NAT (mangle destination
866 * address/port). Only one of (@OVS_NAT_ATTR_SRC, @OVS_NAT_ATTR_DST) may be
867 * specified. Effective only for packets for ct_state NEW connections.
868 * Committed connections are mangled by the NAT action according to the
869 * committed NAT type regardless of the flags specified. As a corollary, a NAT
870 * action without a NAT type flag will only mangle packets of committed
871 * connections. The following NAT attributes only apply for NEW connections,
872 * and they may be included only when the CT action has the @OVS_CT_ATTR_COMMIT
873 * flag and either @OVS_NAT_ATTR_SRC, @OVS_NAT_ATTR_DST is also included.
874 * @OVS_NAT_ATTR_IP_MIN: struct in_addr or struct in6_addr
875 * @OVS_NAT_ATTR_IP_MAX: struct in_addr or struct in6_addr
876 * @OVS_NAT_ATTR_PROTO_MIN: u16 L4 protocol specific lower boundary (port)
877 * @OVS_NAT_ATTR_PROTO_MAX: u16 L4 protocol specific upper boundary (port)
878 * @OVS_NAT_ATTR_PERSISTENT: Flag for persistent IP mapping across reboots
879 * @OVS_NAT_ATTR_PROTO_HASH: Flag for pseudo random L4 port mapping (MD5)
880 * @OVS_NAT_ATTR_PROTO_RANDOM: Flag for fully randomized L4 port mapping
881 */
882 enum ovs_nat_attr {
883 OVS_NAT_ATTR_UNSPEC,
884 OVS_NAT_ATTR_SRC,
885 OVS_NAT_ATTR_DST,
886 OVS_NAT_ATTR_IP_MIN,
887 OVS_NAT_ATTR_IP_MAX,
888 OVS_NAT_ATTR_PROTO_MIN,
889 OVS_NAT_ATTR_PROTO_MAX,
890 OVS_NAT_ATTR_PERSISTENT,
891 OVS_NAT_ATTR_PROTO_HASH,
892 OVS_NAT_ATTR_PROTO_RANDOM,
893 __OVS_NAT_ATTR_MAX,
894 };
895
896 #define OVS_NAT_ATTR_MAX (__OVS_NAT_ATTR_MAX - 1)
897
898 /*
899 * enum ovs_check_pkt_len_attr - Attributes for %OVS_ACTION_ATTR_CHECK_PKT_LEN.
900 *
901 * @OVS_CHECK_PKT_LEN_ATTR_PKT_LEN: u16 Packet length to check for.
902 * @OVS_CHECK_PKT_LEN_ATTR_USERSPACE_COND: u8 comparison condition to send
903 * the packet to userspace. One of OVS_CHECK_PKT_LEN_COND_*.
904 * @OVS_CHECK_PKT_LEN_ATTR_USERPACE - Nested OVS_USERSPACE_ATTR_* actions.
905 */
906 enum ovs_check_pkt_len_attr {
907 OVS_CHECK_PKT_LEN_ATTR_UNSPEC,
908 OVS_CHECK_PKT_LEN_ATTR_PKT_LEN,
909 OVS_CHECK_PKT_LEN_ATTR_ACTIONS_IF_GREATER,
910 OVS_CHECK_PKT_LEN_ATTR_ACTIONS_IF_LESS_EQUAL,
911 __OVS_CHECK_PKT_LEN_ATTR_MAX,
912
913 #ifdef __KERNEL__
914 OVS_CHECK_PKT_LEN_ATTR_ARG /* struct check_pkt_len_arg */
915 #endif
916 };
917
918 #define OVS_CHECK_PKT_LEN_ATTR_MAX (__OVS_CHECK_PKT_LEN_ATTR_MAX - 1)
919
920 #ifdef __KERNEL__
921 struct check_pkt_len_arg {
922 u16 pkt_len; /* Same value as OVS_CHECK_PKT_LEN_ATTR_PKT_LEN'. */
923 bool exec_for_greater; /* When true, actions in IF_GREATE will
924 * not change flow keys. False otherwise.
925 */
926 bool exec_for_lesser_equal; /* When true, actions in IF_LESS_EQUAL
927 * will not change flow keys. False
928 * otherwise.
929 */
930 };
931 #endif
932
933 /**
934 * enum ovs_action_attr - Action types.
935 *
936 * @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
937 * @OVS_ACTION_ATTR_TRUNC: Output packet to port with truncated packet size.
938 * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
939 * %OVS_USERSPACE_ATTR_* attributes.
940 * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q or 802.1ad header
941 * onto the packet.
942 * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q or 802.1ad header
943 * from the packet.
944 * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
945 * the nested %OVS_SAMPLE_ATTR_* attributes.
946 * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header. The
947 * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its
948 * value.
949 * @OVS_ACTION_ATTR_SET_MASKED: Replaces the contents of an existing header. A
950 * nested %OVS_KEY_ATTR_* attribute specifies a header to modify, its value,
951 * and a mask. For every bit set in the mask, the corresponding bit value
952 * is copied from the value to the packet header field, rest of the bits are
953 * left unchanged. The non-masked value bits must be passed in as zeroes.
954 * Masking is not supported for the %OVS_KEY_ATTR_TUNNEL attribute.
955 * @OVS_ACTION_ATTR_RECIRC: Recirculate within the data path.
956 * @OVS_ACTION_ATTR_HASH: Compute and set flow hash value.
957 * @OVS_ACTION_ATTR_PUSH_MPLS: Push a new MPLS label stack entry onto the
958 * top of the packets MPLS label stack. Set the ethertype of the
959 * encapsulating frame to either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC to
960 * indicate the new packet contents.
961 * @OVS_ACTION_ATTR_POP_MPLS: Pop an MPLS label stack entry off of the
962 * packet's MPLS label stack. Set the encapsulating frame's ethertype to
963 * indicate the new packet contents. This could potentially still be
964 * %ETH_P_MPLS if the resulting MPLS label stack is not empty. If there
965 * is no MPLS label stack, as determined by ethertype, no action is taken.
966 * @OVS_ACTION_ATTR_CT: Track the connection. Populate the conntrack-related
967 * entries in the flow key.
968 * @OVS_ACTION_ATTR_PUSH_ETH: Push a new outermost Ethernet header onto the
969 * packet.
970 * @OVS_ACTION_ATTR_POP_ETH: Pop the outermost Ethernet header off the packet.
971 * @OVS_ACTION_ATTR_CT_CLEAR: Clear conntrack state from the packet.
972 * @OVS_ACTION_ATTR_PUSH_NSH: push NSH header to the packet.
973 * @OVS_ACTION_ATTR_POP_NSH: pop the outermost NSH header off the packet.
974 *
975 * Only a single header can be set with a single %OVS_ACTION_ATTR_SET. Not all
976 * fields within a header are modifiable, e.g. the IPv4 protocol and fragment
977 * type may not be changed.
978 *
979 * @OVS_ACTION_ATTR_SET_TO_MASKED: Kernel internal masked set action translated
980 * from the @OVS_ACTION_ATTR_SET.
981 * @OVS_ACTION_ATTR_TUNNEL_PUSH: Push tunnel header described by struct
982 * ovs_action_push_tnl.
983 * @OVS_ACTION_ATTR_TUNNEL_POP: Lookup tunnel port by port-no passed and pop
984 * tunnel header.
985 * @OVS_ACTION_ATTR_METER: Run packet through a meter, which may drop the
986 * packet, or modify the packet (e.g., change the DSCP field).
987 * @OVS_ACTION_ATTR_CLONE: make a copy of the packet and execute a list of
988 * actions without affecting the original packet and key.
989 * @OVS_ACTION_ATTR_CHECK_PKT_LEN: Check the packet length and execute a set
990 * of actions if greater than the specified packet length, else execute
991 * another set of actions.
992 * @OVS_ACTION_ATTR_DROP: Explicit drop action.
993 */
994
995 enum ovs_action_attr {
996 OVS_ACTION_ATTR_UNSPEC,
997 OVS_ACTION_ATTR_OUTPUT, /* u32 port number. */
998 OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */
999 OVS_ACTION_ATTR_SET, /* One nested OVS_KEY_ATTR_*. */
1000 OVS_ACTION_ATTR_PUSH_VLAN, /* struct ovs_action_push_vlan. */
1001 OVS_ACTION_ATTR_POP_VLAN, /* No argument. */
1002 OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */
1003 OVS_ACTION_ATTR_RECIRC, /* u32 recirc_id. */
1004 OVS_ACTION_ATTR_HASH, /* struct ovs_action_hash. */
1005 OVS_ACTION_ATTR_PUSH_MPLS, /* struct ovs_action_push_mpls. */
1006 OVS_ACTION_ATTR_POP_MPLS, /* __be16 ethertype. */
1007 OVS_ACTION_ATTR_SET_MASKED, /* One nested OVS_KEY_ATTR_* including
1008 * data immediately followed by a mask.
1009 * The data must be zero for the unmasked
1010 * bits. */
1011 OVS_ACTION_ATTR_CT, /* Nested OVS_CT_ATTR_* . */
1012 OVS_ACTION_ATTR_TRUNC, /* u32 struct ovs_action_trunc. */
1013 OVS_ACTION_ATTR_PUSH_ETH, /* struct ovs_action_push_eth. */
1014 OVS_ACTION_ATTR_POP_ETH, /* No argument. */
1015 OVS_ACTION_ATTR_CT_CLEAR, /* No argument. */
1016 OVS_ACTION_ATTR_PUSH_NSH, /* Nested OVS_NSH_KEY_ATTR_*. */
1017 OVS_ACTION_ATTR_POP_NSH, /* No argument. */
1018 OVS_ACTION_ATTR_METER, /* u32 meter number. */
1019 OVS_ACTION_ATTR_CLONE, /* Nested OVS_CLONE_ATTR_*. */
1020 OVS_ACTION_ATTR_CHECK_PKT_LEN, /* Nested OVS_CHECK_PKT_LEN_ATTR_*. */
1021
1022 #ifndef __KERNEL__
1023 OVS_ACTION_ATTR_TUNNEL_PUSH, /* struct ovs_action_push_tnl*/
1024 OVS_ACTION_ATTR_TUNNEL_POP, /* u32 port number. */
1025 OVS_ACTION_ATTR_DROP, /* u32 xlate_error. */
1026 OVS_ACTION_ATTR_LB_OUTPUT, /* u32 bond-id. */
1027 #endif
1028 __OVS_ACTION_ATTR_MAX, /* Nothing past this will be accepted
1029 * from userspace. */
1030
1031 #ifdef __KERNEL__
1032 OVS_ACTION_ATTR_SET_TO_MASKED, /* Kernel module internal masked
1033 * set action converted from
1034 * OVS_ACTION_ATTR_SET. */
1035 #endif
1036 };
1037
1038 #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
1039
1040 /* Meters. */
1041 #define OVS_METER_FAMILY "ovs_meter"
1042 #define OVS_METER_MCGROUP "ovs_meter"
1043 #define OVS_METER_VERSION 0x1
1044
1045 enum ovs_meter_cmd {
1046 OVS_METER_CMD_UNSPEC,
1047 OVS_METER_CMD_FEATURES, /* Get features supported by the datapath. */
1048 OVS_METER_CMD_SET, /* Add or modify a meter. */
1049 OVS_METER_CMD_DEL, /* Delete a meter. */
1050 OVS_METER_CMD_GET /* Get meter stats. */
1051 };
1052
1053 enum ovs_meter_attr {
1054 OVS_METER_ATTR_UNSPEC,
1055 OVS_METER_ATTR_ID, /* u32 meter ID within datapath. */
1056 OVS_METER_ATTR_KBPS, /* No argument. If set, units in kilobits
1057 * per second. Otherwise, units in
1058 * packets per second.
1059 */
1060 OVS_METER_ATTR_STATS, /* struct ovs_flow_stats for the meter. */
1061 OVS_METER_ATTR_BANDS, /* Nested attributes for meter bands. */
1062 OVS_METER_ATTR_USED, /* u64 msecs last used in monotonic time. */
1063 OVS_METER_ATTR_CLEAR, /* Flag to clear stats, used. */
1064 OVS_METER_ATTR_MAX_METERS, /* u32 number of meters supported. */
1065 OVS_METER_ATTR_MAX_BANDS, /* u32 max number of bands per meter. */
1066 OVS_METER_ATTR_PAD,
1067 __OVS_METER_ATTR_MAX
1068 };
1069
1070 #define OVS_METER_ATTR_MAX (__OVS_METER_ATTR_MAX - 1)
1071
1072 enum ovs_band_attr {
1073 OVS_BAND_ATTR_UNSPEC,
1074 OVS_BAND_ATTR_TYPE, /* u32 OVS_METER_BAND_TYPE_* constant. */
1075 OVS_BAND_ATTR_RATE, /* u32 band rate in meter units (see above). */
1076 OVS_BAND_ATTR_BURST, /* u32 burst size in meter units. */
1077 OVS_BAND_ATTR_STATS, /* struct ovs_flow_stats for the band. */
1078 __OVS_BAND_ATTR_MAX
1079 };
1080
1081 #define OVS_BAND_ATTR_MAX (__OVS_BAND_ATTR_MAX - 1)
1082
1083 enum ovs_meter_band_type {
1084 OVS_METER_BAND_TYPE_UNSPEC,
1085 OVS_METER_BAND_TYPE_DROP, /* Drop exceeding packets. */
1086 __OVS_METER_BAND_TYPE_MAX
1087 };
1088
1089 #define OVS_METER_BAND_TYPE_MAX (__OVS_METER_BAND_TYPE_MAX - 1)
1090
1091 /* Conntrack limit */
1092 #define OVS_CT_LIMIT_FAMILY "ovs_ct_limit"
1093 #define OVS_CT_LIMIT_MCGROUP "ovs_ct_limit"
1094 #define OVS_CT_LIMIT_VERSION 0x1
1095
1096 enum ovs_ct_limit_cmd {
1097 OVS_CT_LIMIT_CMD_UNSPEC,
1098 OVS_CT_LIMIT_CMD_SET, /* Add or modify ct limit. */
1099 OVS_CT_LIMIT_CMD_DEL, /* Delete ct limit. */
1100 OVS_CT_LIMIT_CMD_GET /* Get ct limit. */
1101 };
1102
1103 enum ovs_ct_limit_attr {
1104 OVS_CT_LIMIT_ATTR_UNSPEC,
1105 OVS_CT_LIMIT_ATTR_ZONE_LIMIT, /* Nested struct ovs_zone_limit. */
1106 __OVS_CT_LIMIT_ATTR_MAX
1107 };
1108
1109 #define OVS_CT_LIMIT_ATTR_MAX (__OVS_CT_LIMIT_ATTR_MAX - 1)
1110
1111 #define OVS_ZONE_LIMIT_DEFAULT_ZONE -1
1112
1113 struct ovs_zone_limit {
1114 int zone_id;
1115 __u32 limit;
1116 __u32 count;
1117 };
1118
1119 #define OVS_CLONE_ATTR_EXEC 0 /* Specify an u32 value. When nonzero,
1120 * actions in clone will not change flow
1121 * keys. False otherwise.
1122 */
1123
1124 #endif /* _LINUX_OPENVSWITCH_H */