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