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