xref: /linux/include/uapi/linux/openvswitch.h (revision f66b53fdbb22ced1a323b22b9de84a61aacd8d18)
1e2be04c7SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
222e3880aSThomas Graf 
322e3880aSThomas Graf /*
49dd7f890SJarno Rajahalme  * Copyright (c) 2007-2017 Nicira, Inc.
522e3880aSThomas Graf  *
622e3880aSThomas Graf  * This program is free software; you can redistribute it and/or
722e3880aSThomas Graf  * modify it under the terms of version 2 of the GNU General Public
822e3880aSThomas Graf  * License as published by the Free Software Foundation.
922e3880aSThomas Graf  *
1022e3880aSThomas Graf  * This program is distributed in the hope that it will be useful, but
1122e3880aSThomas Graf  * WITHOUT ANY WARRANTY; without even the implied warranty of
1222e3880aSThomas Graf  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1322e3880aSThomas Graf  * General Public License for more details.
1422e3880aSThomas Graf  *
1522e3880aSThomas Graf  * You should have received a copy of the GNU General Public License
1622e3880aSThomas Graf  * along with this program; if not, write to the Free Software
1722e3880aSThomas Graf  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
1822e3880aSThomas Graf  * 02110-1301, USA
1922e3880aSThomas Graf  */
2022e3880aSThomas Graf 
2122e3880aSThomas Graf #ifndef _UAPI__LINUX_OPENVSWITCH_H
2222e3880aSThomas Graf #define _UAPI__LINUX_OPENVSWITCH_H 1
2322e3880aSThomas Graf 
2422e3880aSThomas Graf #include <linux/types.h>
2522e3880aSThomas Graf #include <linux/if_ether.h>
2622e3880aSThomas Graf 
2722e3880aSThomas Graf /**
2822e3880aSThomas Graf  * struct ovs_header - header for OVS Generic Netlink messages.
2922e3880aSThomas Graf  * @dp_ifindex: ifindex of local port for datapath (0 to make a request not
3022e3880aSThomas Graf  * specific to a datapath).
3122e3880aSThomas Graf  *
3222e3880aSThomas Graf  * Attributes following the header are specific to a particular OVS Generic
3322e3880aSThomas Graf  * Netlink family, but all of the OVS families use this header.
3422e3880aSThomas Graf  */
3522e3880aSThomas Graf 
3622e3880aSThomas Graf struct ovs_header {
3722e3880aSThomas Graf 	int dp_ifindex;
3822e3880aSThomas Graf };
3922e3880aSThomas Graf 
4022e3880aSThomas Graf /* Datapaths. */
4122e3880aSThomas Graf 
4222e3880aSThomas Graf #define OVS_DATAPATH_FAMILY  "ovs_datapath"
4322e3880aSThomas Graf #define OVS_DATAPATH_MCGROUP "ovs_datapath"
4444da5ae5SThomas Graf 
4544da5ae5SThomas Graf /* V2:
4644da5ae5SThomas Graf  *   - API users are expected to provide OVS_DP_ATTR_USER_FEATURES
4744da5ae5SThomas Graf  *     when creating the datapath.
4844da5ae5SThomas Graf  */
4944da5ae5SThomas Graf #define OVS_DATAPATH_VERSION 2
5044da5ae5SThomas Graf 
5144da5ae5SThomas Graf /* First OVS datapath version to support features */
5244da5ae5SThomas Graf #define OVS_DP_VER_FEATURES 2
5322e3880aSThomas Graf 
5422e3880aSThomas Graf enum ovs_datapath_cmd {
5522e3880aSThomas Graf 	OVS_DP_CMD_UNSPEC,
5622e3880aSThomas Graf 	OVS_DP_CMD_NEW,
5722e3880aSThomas Graf 	OVS_DP_CMD_DEL,
5822e3880aSThomas Graf 	OVS_DP_CMD_GET,
5922e3880aSThomas Graf 	OVS_DP_CMD_SET
6022e3880aSThomas Graf };
6122e3880aSThomas Graf 
6222e3880aSThomas Graf /**
6322e3880aSThomas Graf  * enum ovs_datapath_attr - attributes for %OVS_DP_* commands.
6422e3880aSThomas Graf  * @OVS_DP_ATTR_NAME: Name of the network device that serves as the "local
6522e3880aSThomas Graf  * port".  This is the name of the network device whose dp_ifindex is given in
6622e3880aSThomas Graf  * the &struct ovs_header.  Always present in notifications.  Required in
6722e3880aSThomas Graf  * %OVS_DP_NEW requests.  May be used as an alternative to specifying
6822e3880aSThomas Graf  * dp_ifindex in other requests (with a dp_ifindex of 0).
6922e3880aSThomas Graf  * @OVS_DP_ATTR_UPCALL_PID: The Netlink socket in userspace that is initially
7022e3880aSThomas Graf  * set on the datapath port (for OVS_ACTION_ATTR_MISS).  Only valid on
7122e3880aSThomas Graf  * %OVS_DP_CMD_NEW requests. A value of zero indicates that upcalls should
7222e3880aSThomas Graf  * not be sent.
7322e3880aSThomas Graf  * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the
7422e3880aSThomas Graf  * datapath.  Always present in notifications.
751bd7116fSAndy Zhou  * @OVS_DP_ATTR_MEGAFLOW_STATS: Statistics about mega flow masks usage for the
761bd7116fSAndy Zhou  * datapath. Always present in notifications.
7722e3880aSThomas Graf  *
7822e3880aSThomas Graf  * These attributes follow the &struct ovs_header within the Generic Netlink
7922e3880aSThomas Graf  * payload for %OVS_DP_* commands.
8022e3880aSThomas Graf  */
8122e3880aSThomas Graf enum ovs_datapath_attr {
8222e3880aSThomas Graf 	OVS_DP_ATTR_UNSPEC,
8322e3880aSThomas Graf 	OVS_DP_ATTR_NAME,		/* name of dp_ifindex netdev */
8422e3880aSThomas Graf 	OVS_DP_ATTR_UPCALL_PID,		/* Netlink PID to receive upcalls */
8522e3880aSThomas Graf 	OVS_DP_ATTR_STATS,		/* struct ovs_dp_stats */
861bd7116fSAndy Zhou 	OVS_DP_ATTR_MEGAFLOW_STATS,	/* struct ovs_dp_megaflow_stats */
8743d4be9cSThomas Graf 	OVS_DP_ATTR_USER_FEATURES,	/* OVS_DP_F_*  */
8866c7a5eeSNicolas Dichtel 	OVS_DP_ATTR_PAD,
8922e3880aSThomas Graf 	__OVS_DP_ATTR_MAX
9022e3880aSThomas Graf };
9122e3880aSThomas Graf 
9222e3880aSThomas Graf #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
9322e3880aSThomas Graf 
9422e3880aSThomas Graf struct ovs_dp_stats {
9522e3880aSThomas Graf 	__u64 n_hit;             /* Number of flow table matches. */
9622e3880aSThomas Graf 	__u64 n_missed;          /* Number of flow table misses. */
9722e3880aSThomas Graf 	__u64 n_lost;            /* Number of misses not sent to userspace. */
9822e3880aSThomas Graf 	__u64 n_flows;           /* Number of flows present */
9922e3880aSThomas Graf };
10022e3880aSThomas Graf 
1011bd7116fSAndy Zhou struct ovs_dp_megaflow_stats {
1021bd7116fSAndy Zhou 	__u64 n_mask_hit;	 /* Number of masks used for flow lookups. */
1031bd7116fSAndy Zhou 	__u32 n_masks;		 /* Number of masks for the datapath. */
1041bd7116fSAndy Zhou 	__u32 pad0;		 /* Pad for future expension. */
1051bd7116fSAndy Zhou 	__u64 pad1;		 /* Pad for future expension. */
1061bd7116fSAndy Zhou 	__u64 pad2;		 /* Pad for future expension. */
1071bd7116fSAndy Zhou };
1081bd7116fSAndy Zhou 
10922e3880aSThomas Graf struct ovs_vport_stats {
11022e3880aSThomas Graf 	__u64   rx_packets;		/* total packets received       */
11122e3880aSThomas Graf 	__u64   tx_packets;		/* total packets transmitted    */
11222e3880aSThomas Graf 	__u64   rx_bytes;		/* total bytes received         */
11322e3880aSThomas Graf 	__u64   tx_bytes;		/* total bytes transmitted      */
11422e3880aSThomas Graf 	__u64   rx_errors;		/* bad packets received         */
11522e3880aSThomas Graf 	__u64   tx_errors;		/* packet transmit problems     */
11622e3880aSThomas Graf 	__u64   rx_dropped;		/* no space in linux buffers    */
11722e3880aSThomas Graf 	__u64   tx_dropped;		/* no space available in linux  */
11822e3880aSThomas Graf };
11922e3880aSThomas Graf 
12043d4be9cSThomas Graf /* Allow last Netlink attribute to be unaligned */
12143d4be9cSThomas Graf #define OVS_DP_F_UNALIGNED	(1 << 0)
12243d4be9cSThomas Graf 
1235cd667b0SAlex Wang /* Allow datapath to associate multiple Netlink PIDs to each vport */
1245cd667b0SAlex Wang #define OVS_DP_F_VPORT_PIDS	(1 << 1)
1255cd667b0SAlex Wang 
12695a7233cSPaul Blakey /* Allow tc offload recirc sharing */
12795a7233cSPaul Blakey #define OVS_DP_F_TC_RECIRC_SHARING	(1 << 2)
12895a7233cSPaul Blakey 
12922e3880aSThomas Graf /* Fixed logical ports. */
13022e3880aSThomas Graf #define OVSP_LOCAL      ((__u32)0)
13122e3880aSThomas Graf 
13222e3880aSThomas Graf /* Packet transfer. */
13322e3880aSThomas Graf 
13422e3880aSThomas Graf #define OVS_PACKET_FAMILY "ovs_packet"
13522e3880aSThomas Graf #define OVS_PACKET_VERSION 0x1
13622e3880aSThomas Graf 
13722e3880aSThomas Graf enum ovs_packet_cmd {
13822e3880aSThomas Graf 	OVS_PACKET_CMD_UNSPEC,
13922e3880aSThomas Graf 
14022e3880aSThomas Graf 	/* Kernel-to-user notifications. */
14122e3880aSThomas Graf 	OVS_PACKET_CMD_MISS,    /* Flow table miss. */
14222e3880aSThomas Graf 	OVS_PACKET_CMD_ACTION,  /* OVS_ACTION_ATTR_USERSPACE action. */
14322e3880aSThomas Graf 
14422e3880aSThomas Graf 	/* Userspace commands. */
14522e3880aSThomas Graf 	OVS_PACKET_CMD_EXECUTE  /* Apply actions to a packet. */
14622e3880aSThomas Graf };
14722e3880aSThomas Graf 
14822e3880aSThomas Graf /**
14922e3880aSThomas Graf  * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
15022e3880aSThomas Graf  * @OVS_PACKET_ATTR_PACKET: Present for all notifications.  Contains the entire
15122e3880aSThomas Graf  * packet as received, from the start of the Ethernet header onward.  For
15222e3880aSThomas Graf  * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
15322e3880aSThomas Graf  * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
15422e3880aSThomas Graf  * the flow key extracted from the packet as originally received.
15522e3880aSThomas Graf  * @OVS_PACKET_ATTR_KEY: Present for all notifications.  Contains the flow key
15622e3880aSThomas Graf  * extracted from the packet as nested %OVS_KEY_ATTR_* attributes.  This allows
15722e3880aSThomas Graf  * userspace to adapt its flow setup strategy by comparing its notion of the
15822e3880aSThomas Graf  * flow key against the kernel's.
15922e3880aSThomas Graf  * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet.  Used
16022e3880aSThomas Graf  * for %OVS_PACKET_CMD_EXECUTE.  It has nested %OVS_ACTION_ATTR_* attributes.
161ccea7445SNeil McKee  * Also used in upcall when %OVS_ACTION_ATTR_USERSPACE has optional
162ccea7445SNeil McKee  * %OVS_USERSPACE_ATTR_ACTIONS attribute.
16322e3880aSThomas Graf  * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
16422e3880aSThomas Graf  * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
16522e3880aSThomas Graf  * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content
16622e3880aSThomas Graf  * specified there.
1678f0aad6fSWenyu Zhang  * @OVS_PACKET_ATTR_EGRESS_TUN_KEY: Present for an %OVS_PACKET_CMD_ACTION
1688f0aad6fSWenyu Zhang  * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
1698f0aad6fSWenyu Zhang  * %OVS_USERSPACE_ATTR_EGRESS_TUN_PORT attribute, which is sent only if the
1708f0aad6fSWenyu Zhang  * output port is actually a tunnel port. Contains the output tunnel key
1718f0aad6fSWenyu Zhang  * extracted from the packet as nested %OVS_TUNNEL_KEY_ATTR_* attributes.
1727f8a436eSJoe Stringer  * @OVS_PACKET_ATTR_MRU: Present for an %OVS_PACKET_CMD_ACTION and
173b95e5928SWilliam Tu  * @OVS_PACKET_ATTR_LEN: Packet size before truncation.
1747f8a436eSJoe Stringer  * %OVS_PACKET_ATTR_USERSPACE action specify the Maximum received fragment
1757f8a436eSJoe Stringer  * size.
176bd1903b7STonghao Zhang  * @OVS_PACKET_ATTR_HASH: Packet hash info (e.g. hash, sw_hash and l4_hash in skb).
17722e3880aSThomas Graf  *
17822e3880aSThomas Graf  * These attributes follow the &struct ovs_header within the Generic Netlink
17922e3880aSThomas Graf  * payload for %OVS_PACKET_* commands.
18022e3880aSThomas Graf  */
18122e3880aSThomas Graf enum ovs_packet_attr {
18222e3880aSThomas Graf 	OVS_PACKET_ATTR_UNSPEC,
18322e3880aSThomas Graf 	OVS_PACKET_ATTR_PACKET,      /* Packet data. */
18422e3880aSThomas Graf 	OVS_PACKET_ATTR_KEY,         /* Nested OVS_KEY_ATTR_* attributes. */
18522e3880aSThomas Graf 	OVS_PACKET_ATTR_ACTIONS,     /* Nested OVS_ACTION_ATTR_* attributes. */
18622e3880aSThomas Graf 	OVS_PACKET_ATTR_USERDATA,    /* OVS_ACTION_ATTR_USERSPACE arg. */
1878f0aad6fSWenyu Zhang 	OVS_PACKET_ATTR_EGRESS_TUN_KEY,  /* Nested OVS_TUNNEL_KEY_ATTR_*
1888f0aad6fSWenyu Zhang 					    attributes. */
1891ba39804SThomas Graf 	OVS_PACKET_ATTR_UNUSED1,
1901ba39804SThomas Graf 	OVS_PACKET_ATTR_UNUSED2,
1911ba39804SThomas Graf 	OVS_PACKET_ATTR_PROBE,      /* Packet operation is a feature probe,
1921ba39804SThomas Graf 				       error logging should be suppressed. */
1937f8a436eSJoe Stringer 	OVS_PACKET_ATTR_MRU,	    /* Maximum received IP fragment size. */
194b95e5928SWilliam Tu 	OVS_PACKET_ATTR_LEN,	    /* Packet size before truncation. */
195bd1903b7STonghao Zhang 	OVS_PACKET_ATTR_HASH,	    /* Packet hash. */
19622e3880aSThomas Graf 	__OVS_PACKET_ATTR_MAX
19722e3880aSThomas Graf };
19822e3880aSThomas Graf 
19922e3880aSThomas Graf #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
20022e3880aSThomas Graf 
20122e3880aSThomas Graf /* Virtual ports. */
20222e3880aSThomas Graf 
20322e3880aSThomas Graf #define OVS_VPORT_FAMILY  "ovs_vport"
20422e3880aSThomas Graf #define OVS_VPORT_MCGROUP "ovs_vport"
20522e3880aSThomas Graf #define OVS_VPORT_VERSION 0x1
20622e3880aSThomas Graf 
20722e3880aSThomas Graf enum ovs_vport_cmd {
20822e3880aSThomas Graf 	OVS_VPORT_CMD_UNSPEC,
20922e3880aSThomas Graf 	OVS_VPORT_CMD_NEW,
21022e3880aSThomas Graf 	OVS_VPORT_CMD_DEL,
21122e3880aSThomas Graf 	OVS_VPORT_CMD_GET,
21222e3880aSThomas Graf 	OVS_VPORT_CMD_SET
21322e3880aSThomas Graf };
21422e3880aSThomas Graf 
21522e3880aSThomas Graf enum ovs_vport_type {
21622e3880aSThomas Graf 	OVS_VPORT_TYPE_UNSPEC,
21722e3880aSThomas Graf 	OVS_VPORT_TYPE_NETDEV,   /* network device */
21822e3880aSThomas Graf 	OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
219aa310701SPravin B Shelar 	OVS_VPORT_TYPE_GRE,      /* GRE tunnel. */
22058264848SPravin B Shelar 	OVS_VPORT_TYPE_VXLAN,	 /* VXLAN tunnel. */
221f5796684SJesse Gross 	OVS_VPORT_TYPE_GENEVE,	 /* Geneve tunnel. */
22222e3880aSThomas Graf 	__OVS_VPORT_TYPE_MAX
22322e3880aSThomas Graf };
22422e3880aSThomas Graf 
22522e3880aSThomas Graf #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
22622e3880aSThomas Graf 
22722e3880aSThomas Graf /**
22822e3880aSThomas Graf  * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
22922e3880aSThomas Graf  * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
23022e3880aSThomas Graf  * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
23122e3880aSThomas Graf  * of vport.
23222e3880aSThomas Graf  * @OVS_VPORT_ATTR_NAME: Name of vport.  For a vport based on a network device
23322e3880aSThomas Graf  * this is the name of the network device.  Maximum length %IFNAMSIZ-1 bytes
23422e3880aSThomas Graf  * plus a null terminator.
23522e3880aSThomas Graf  * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information.
2365cd667b0SAlex Wang  * @OVS_VPORT_ATTR_UPCALL_PID: The array of Netlink socket pids in userspace
2375cd667b0SAlex Wang  * among which OVS_PACKET_CMD_MISS upcalls will be distributed for packets
2385cd667b0SAlex Wang  * received on this port.  If this is a single-element array of value 0,
2395cd667b0SAlex Wang  * upcalls should not be sent.
24022e3880aSThomas Graf  * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
24122e3880aSThomas Graf  * packets sent or received through the vport.
24222e3880aSThomas Graf  *
24322e3880aSThomas Graf  * These attributes follow the &struct ovs_header within the Generic Netlink
24422e3880aSThomas Graf  * payload for %OVS_VPORT_* commands.
24522e3880aSThomas Graf  *
24622e3880aSThomas Graf  * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
24722e3880aSThomas Graf  * %OVS_VPORT_ATTR_NAME attributes are required.  %OVS_VPORT_ATTR_PORT_NO is
24822e3880aSThomas Graf  * optional; if not specified a free port number is automatically selected.
24922e3880aSThomas Graf  * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
25022e3880aSThomas Graf  * of vport.
25122e3880aSThomas Graf  *
25222e3880aSThomas Graf  * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
25322e3880aSThomas Graf  * look up the vport to operate on; otherwise dp_idx from the &struct
25422e3880aSThomas Graf  * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
25522e3880aSThomas Graf  */
25622e3880aSThomas Graf enum ovs_vport_attr {
25722e3880aSThomas Graf 	OVS_VPORT_ATTR_UNSPEC,
25822e3880aSThomas Graf 	OVS_VPORT_ATTR_PORT_NO,	/* u32 port number within datapath */
25922e3880aSThomas Graf 	OVS_VPORT_ATTR_TYPE,	/* u32 OVS_VPORT_TYPE_* constant. */
26022e3880aSThomas Graf 	OVS_VPORT_ATTR_NAME,	/* string name, up to IFNAMSIZ bytes long */
26122e3880aSThomas Graf 	OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
2625cd667b0SAlex Wang 	OVS_VPORT_ATTR_UPCALL_PID, /* array of u32 Netlink socket PIDs for */
2635cd667b0SAlex Wang 				/* receiving upcalls */
26422e3880aSThomas Graf 	OVS_VPORT_ATTR_STATS,	/* struct ovs_vport_stats */
26566c7a5eeSNicolas Dichtel 	OVS_VPORT_ATTR_PAD,
2669354d452SJiri Benc 	OVS_VPORT_ATTR_IFINDEX,
2679354d452SJiri Benc 	OVS_VPORT_ATTR_NETNSID,
26822e3880aSThomas Graf 	__OVS_VPORT_ATTR_MAX
26922e3880aSThomas Graf };
27022e3880aSThomas Graf 
27122e3880aSThomas Graf #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
27222e3880aSThomas Graf 
2731dd144cfSThomas Graf enum {
2741dd144cfSThomas Graf 	OVS_VXLAN_EXT_UNSPEC,
2751dd144cfSThomas Graf 	OVS_VXLAN_EXT_GBP,	/* Flag or __u32 */
2761dd144cfSThomas Graf 	__OVS_VXLAN_EXT_MAX,
2771dd144cfSThomas Graf };
2781dd144cfSThomas Graf 
2791dd144cfSThomas Graf #define OVS_VXLAN_EXT_MAX (__OVS_VXLAN_EXT_MAX - 1)
2801dd144cfSThomas Graf 
2811dd144cfSThomas Graf 
28258264848SPravin B Shelar /* OVS_VPORT_ATTR_OPTIONS attributes for tunnels.
28358264848SPravin B Shelar  */
28458264848SPravin B Shelar enum {
28558264848SPravin B Shelar 	OVS_TUNNEL_ATTR_UNSPEC,
28658264848SPravin B Shelar 	OVS_TUNNEL_ATTR_DST_PORT, /* 16-bit UDP port, used by L4 tunnels. */
2871dd144cfSThomas Graf 	OVS_TUNNEL_ATTR_EXTENSION,
28858264848SPravin B Shelar 	__OVS_TUNNEL_ATTR_MAX
28958264848SPravin B Shelar };
29058264848SPravin B Shelar 
29158264848SPravin B Shelar #define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1)
29258264848SPravin B Shelar 
29322e3880aSThomas Graf /* Flows. */
29422e3880aSThomas Graf 
29522e3880aSThomas Graf #define OVS_FLOW_FAMILY  "ovs_flow"
29622e3880aSThomas Graf #define OVS_FLOW_MCGROUP "ovs_flow"
29722e3880aSThomas Graf #define OVS_FLOW_VERSION 0x1
29822e3880aSThomas Graf 
29922e3880aSThomas Graf enum ovs_flow_cmd {
30022e3880aSThomas Graf 	OVS_FLOW_CMD_UNSPEC,
30122e3880aSThomas Graf 	OVS_FLOW_CMD_NEW,
30222e3880aSThomas Graf 	OVS_FLOW_CMD_DEL,
30322e3880aSThomas Graf 	OVS_FLOW_CMD_GET,
30422e3880aSThomas Graf 	OVS_FLOW_CMD_SET
30522e3880aSThomas Graf };
30622e3880aSThomas Graf 
30722e3880aSThomas Graf struct ovs_flow_stats {
30822e3880aSThomas Graf 	__u64 n_packets;         /* Number of matched packets. */
30922e3880aSThomas Graf 	__u64 n_bytes;           /* Number of matched bytes. */
31022e3880aSThomas Graf };
31122e3880aSThomas Graf 
31222e3880aSThomas Graf enum ovs_key_attr {
31322e3880aSThomas Graf 	OVS_KEY_ATTR_UNSPEC,
31422e3880aSThomas Graf 	OVS_KEY_ATTR_ENCAP,	/* Nested set of encapsulated attributes. */
31522e3880aSThomas Graf 	OVS_KEY_ATTR_PRIORITY,  /* u32 skb->priority */
31622e3880aSThomas Graf 	OVS_KEY_ATTR_IN_PORT,   /* u32 OVS dp port number */
31722e3880aSThomas Graf 	OVS_KEY_ATTR_ETHERNET,  /* struct ovs_key_ethernet */
31822e3880aSThomas Graf 	OVS_KEY_ATTR_VLAN,	/* be16 VLAN TCI */
31922e3880aSThomas Graf 	OVS_KEY_ATTR_ETHERTYPE,	/* be16 Ethernet type */
32022e3880aSThomas Graf 	OVS_KEY_ATTR_IPV4,      /* struct ovs_key_ipv4 */
32122e3880aSThomas Graf 	OVS_KEY_ATTR_IPV6,      /* struct ovs_key_ipv6 */
32222e3880aSThomas Graf 	OVS_KEY_ATTR_TCP,       /* struct ovs_key_tcp */
32322e3880aSThomas Graf 	OVS_KEY_ATTR_UDP,       /* struct ovs_key_udp */
32422e3880aSThomas Graf 	OVS_KEY_ATTR_ICMP,      /* struct ovs_key_icmp */
32522e3880aSThomas Graf 	OVS_KEY_ATTR_ICMPV6,    /* struct ovs_key_icmpv6 */
32622e3880aSThomas Graf 	OVS_KEY_ATTR_ARP,       /* struct ovs_key_arp */
32722e3880aSThomas Graf 	OVS_KEY_ATTR_ND,        /* struct ovs_key_nd */
32822e3880aSThomas Graf 	OVS_KEY_ATTR_SKB_MARK,  /* u32 skb mark */
3297d5437c7SPravin B Shelar 	OVS_KEY_ATTR_TUNNEL,    /* Nested set of ovs_tunnel attributes */
330a175a723SJoe Stringer 	OVS_KEY_ATTR_SCTP,      /* struct ovs_key_sctp */
3315eb26b15SJarno Rajahalme 	OVS_KEY_ATTR_TCP_FLAGS,	/* be16 TCP flags. */
332971427f3SAndy Zhou 	OVS_KEY_ATTR_DP_HASH,      /* u32 hash value. Value 0 indicates the hash
333971427f3SAndy Zhou 				   is not computed by the datapath. */
334971427f3SAndy Zhou 	OVS_KEY_ATTR_RECIRC_ID, /* u32 recirc id */
33525cd9ba0SSimon Horman 	OVS_KEY_ATTR_MPLS,      /* array of struct ovs_key_mpls.
33625cd9ba0SSimon Horman 				 * The implementation may restrict
33725cd9ba0SSimon Horman 				 * the accepted length of the array. */
338fbccce59SJoe Stringer 	OVS_KEY_ATTR_CT_STATE,	/* u32 bitmask of OVS_CS_F_* */
3397f8a436eSJoe Stringer 	OVS_KEY_ATTR_CT_ZONE,	/* u16 connection tracking zone. */
340182e3042SJoe Stringer 	OVS_KEY_ATTR_CT_MARK,	/* u32 connection tracking mark */
34133db4125SJoe Stringer 	OVS_KEY_ATTR_CT_LABELS,	/* 16-octet connection tracking label */
3429dd7f890SJarno Rajahalme 	OVS_KEY_ATTR_CT_ORIG_TUPLE_IPV4,   /* struct ovs_key_ct_tuple_ipv4 */
3439dd7f890SJarno Rajahalme 	OVS_KEY_ATTR_CT_ORIG_TUPLE_IPV6,   /* struct ovs_key_ct_tuple_ipv6 */
344b2d0f5d5SYi Yang 	OVS_KEY_ATTR_NSH,       /* Nested set of ovs_nsh_key_* */
3457d5437c7SPravin B Shelar 
3467d5437c7SPravin B Shelar #ifdef __KERNEL__
3471d8fff90SThomas Graf 	OVS_KEY_ATTR_TUNNEL_INFO,  /* struct ip_tunnel_info */
3487d5437c7SPravin B Shelar #endif
34922e3880aSThomas Graf 	__OVS_KEY_ATTR_MAX
35022e3880aSThomas Graf };
35122e3880aSThomas Graf 
35222e3880aSThomas Graf #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
35322e3880aSThomas Graf 
3547d5437c7SPravin B Shelar enum ovs_tunnel_key_attr {
355daa6630aSNicolas Dichtel 	/* OVS_TUNNEL_KEY_ATTR_NONE, standard nl API requires this attribute! */
3567d5437c7SPravin B Shelar 	OVS_TUNNEL_KEY_ATTR_ID,                 /* be64 Tunnel ID */
3577d5437c7SPravin B Shelar 	OVS_TUNNEL_KEY_ATTR_IPV4_SRC,           /* be32 src IP address. */
3587d5437c7SPravin B Shelar 	OVS_TUNNEL_KEY_ATTR_IPV4_DST,           /* be32 dst IP address. */
3597d5437c7SPravin B Shelar 	OVS_TUNNEL_KEY_ATTR_TOS,                /* u8 Tunnel IP ToS. */
3607d5437c7SPravin B Shelar 	OVS_TUNNEL_KEY_ATTR_TTL,                /* u8 Tunnel IP TTL. */
3617d5437c7SPravin B Shelar 	OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT,      /* No argument, set DF. */
3627d5437c7SPravin B Shelar 	OVS_TUNNEL_KEY_ATTR_CSUM,               /* No argument. CSUM packet. */
36367fa0341SJesse Gross 	OVS_TUNNEL_KEY_ATTR_OAM,                /* No argument. OAM frame.  */
364f5796684SJesse Gross 	OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS,        /* Array of Geneve options. */
3658f0aad6fSWenyu Zhang 	OVS_TUNNEL_KEY_ATTR_TP_SRC,		/* be16 src Transport Port. */
3668f0aad6fSWenyu Zhang 	OVS_TUNNEL_KEY_ATTR_TP_DST,		/* be16 dst Transport Port. */
3671dd144cfSThomas Graf 	OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS,		/* Nested OVS_VXLAN_EXT_* */
3686b26ba3aSJiri Benc 	OVS_TUNNEL_KEY_ATTR_IPV6_SRC,		/* struct in6_addr src IPv6 address. */
3696b26ba3aSJiri Benc 	OVS_TUNNEL_KEY_ATTR_IPV6_DST,		/* struct in6_addr dst IPv6 address. */
370b46f6dedSNicolas Dichtel 	OVS_TUNNEL_KEY_ATTR_PAD,
371fc1372f8SWilliam Tu 	OVS_TUNNEL_KEY_ATTR_ERSPAN_OPTS,	/* struct erspan_metadata */
37218b6f717Swenxu 	OVS_TUNNEL_KEY_ATTR_IPV4_INFO_BRIDGE,	/* No argument. IPV4_INFO_BRIDGE mode.*/
3737d5437c7SPravin B Shelar 	__OVS_TUNNEL_KEY_ATTR_MAX
3747d5437c7SPravin B Shelar };
3757d5437c7SPravin B Shelar 
3767d5437c7SPravin B Shelar #define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1)
3777d5437c7SPravin B Shelar 
37822e3880aSThomas Graf /**
37922e3880aSThomas Graf  * enum ovs_frag_type - IPv4 and IPv6 fragment type
38022e3880aSThomas Graf  * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
38122e3880aSThomas Graf  * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
38222e3880aSThomas Graf  * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
38322e3880aSThomas Graf  *
38422e3880aSThomas Graf  * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
38522e3880aSThomas Graf  * ovs_key_ipv6.
38622e3880aSThomas Graf  */
38722e3880aSThomas Graf enum ovs_frag_type {
38822e3880aSThomas Graf 	OVS_FRAG_TYPE_NONE,
38922e3880aSThomas Graf 	OVS_FRAG_TYPE_FIRST,
39022e3880aSThomas Graf 	OVS_FRAG_TYPE_LATER,
39122e3880aSThomas Graf 	__OVS_FRAG_TYPE_MAX
39222e3880aSThomas Graf };
39322e3880aSThomas Graf 
39422e3880aSThomas Graf #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
39522e3880aSThomas Graf 
39622e3880aSThomas Graf struct ovs_key_ethernet {
39722e3880aSThomas Graf 	__u8	 eth_src[ETH_ALEN];
39822e3880aSThomas Graf 	__u8	 eth_dst[ETH_ALEN];
39922e3880aSThomas Graf };
40022e3880aSThomas Graf 
40125cd9ba0SSimon Horman struct ovs_key_mpls {
40225cd9ba0SSimon Horman 	__be32 mpls_lse;
40325cd9ba0SSimon Horman };
40425cd9ba0SSimon Horman 
40522e3880aSThomas Graf struct ovs_key_ipv4 {
40622e3880aSThomas Graf 	__be32 ipv4_src;
40722e3880aSThomas Graf 	__be32 ipv4_dst;
40822e3880aSThomas Graf 	__u8   ipv4_proto;
40922e3880aSThomas Graf 	__u8   ipv4_tos;
41022e3880aSThomas Graf 	__u8   ipv4_ttl;
41122e3880aSThomas Graf 	__u8   ipv4_frag;	/* One of OVS_FRAG_TYPE_*. */
41222e3880aSThomas Graf };
41322e3880aSThomas Graf 
41422e3880aSThomas Graf struct ovs_key_ipv6 {
41522e3880aSThomas Graf 	__be32 ipv6_src[4];
41622e3880aSThomas Graf 	__be32 ipv6_dst[4];
41722e3880aSThomas Graf 	__be32 ipv6_label;	/* 20-bits in least-significant bits. */
41822e3880aSThomas Graf 	__u8   ipv6_proto;
41922e3880aSThomas Graf 	__u8   ipv6_tclass;
42022e3880aSThomas Graf 	__u8   ipv6_hlimit;
42122e3880aSThomas Graf 	__u8   ipv6_frag;	/* One of OVS_FRAG_TYPE_*. */
42222e3880aSThomas Graf };
42322e3880aSThomas Graf 
42422e3880aSThomas Graf struct ovs_key_tcp {
42522e3880aSThomas Graf 	__be16 tcp_src;
42622e3880aSThomas Graf 	__be16 tcp_dst;
42722e3880aSThomas Graf };
42822e3880aSThomas Graf 
42922e3880aSThomas Graf struct ovs_key_udp {
43022e3880aSThomas Graf 	__be16 udp_src;
43122e3880aSThomas Graf 	__be16 udp_dst;
43222e3880aSThomas Graf };
43322e3880aSThomas Graf 
434a175a723SJoe Stringer struct ovs_key_sctp {
435a175a723SJoe Stringer 	__be16 sctp_src;
436a175a723SJoe Stringer 	__be16 sctp_dst;
437a175a723SJoe Stringer };
438a175a723SJoe Stringer 
43922e3880aSThomas Graf struct ovs_key_icmp {
44022e3880aSThomas Graf 	__u8 icmp_type;
44122e3880aSThomas Graf 	__u8 icmp_code;
44222e3880aSThomas Graf };
44322e3880aSThomas Graf 
44422e3880aSThomas Graf struct ovs_key_icmpv6 {
44522e3880aSThomas Graf 	__u8 icmpv6_type;
44622e3880aSThomas Graf 	__u8 icmpv6_code;
44722e3880aSThomas Graf };
44822e3880aSThomas Graf 
44922e3880aSThomas Graf struct ovs_key_arp {
45022e3880aSThomas Graf 	__be32 arp_sip;
45122e3880aSThomas Graf 	__be32 arp_tip;
45222e3880aSThomas Graf 	__be16 arp_op;
45322e3880aSThomas Graf 	__u8   arp_sha[ETH_ALEN];
45422e3880aSThomas Graf 	__u8   arp_tha[ETH_ALEN];
45522e3880aSThomas Graf };
45622e3880aSThomas Graf 
45722e3880aSThomas Graf struct ovs_key_nd {
4581a4e96a0SJarno Rajahalme 	__be32	nd_target[4];
45922e3880aSThomas Graf 	__u8	nd_sll[ETH_ALEN];
46022e3880aSThomas Graf 	__u8	nd_tll[ETH_ALEN];
46122e3880aSThomas Graf };
46222e3880aSThomas Graf 
463cb80d58fSJarno Rajahalme #define OVS_CT_LABELS_LEN_32	4
464cb80d58fSJarno Rajahalme #define OVS_CT_LABELS_LEN	(OVS_CT_LABELS_LEN_32 * sizeof(__u32))
46533db4125SJoe Stringer struct ovs_key_ct_labels {
466cb80d58fSJarno Rajahalme 	union {
46733db4125SJoe Stringer 		__u8	ct_labels[OVS_CT_LABELS_LEN];
468cb80d58fSJarno Rajahalme 		__u32	ct_labels_32[OVS_CT_LABELS_LEN_32];
469cb80d58fSJarno Rajahalme 	};
470c2ac6673SJoe Stringer };
471c2ac6673SJoe Stringer 
4727f8a436eSJoe Stringer /* OVS_KEY_ATTR_CT_STATE flags */
4737f8a436eSJoe Stringer #define OVS_CS_F_NEW               0x01 /* Beginning of a new connection. */
4747f8a436eSJoe Stringer #define OVS_CS_F_ESTABLISHED       0x02 /* Part of an existing connection. */
4757f8a436eSJoe Stringer #define OVS_CS_F_RELATED           0x04 /* Related to an established
4767f8a436eSJoe Stringer 					 * connection. */
477fbccce59SJoe Stringer #define OVS_CS_F_REPLY_DIR         0x08 /* Flow is in the reply direction. */
478fbccce59SJoe Stringer #define OVS_CS_F_INVALID           0x10 /* Could not track connection. */
479fbccce59SJoe Stringer #define OVS_CS_F_TRACKED           0x20 /* Conntrack has occurred. */
48005752523SJarno Rajahalme #define OVS_CS_F_SRC_NAT           0x40 /* Packet's source address/port was
48105752523SJarno Rajahalme 					 * mangled by NAT.
48205752523SJarno Rajahalme 					 */
48305752523SJarno Rajahalme #define OVS_CS_F_DST_NAT           0x80 /* Packet's destination address/port
48405752523SJarno Rajahalme 					 * was mangled by NAT.
48505752523SJarno Rajahalme 					 */
48605752523SJarno Rajahalme 
48705752523SJarno Rajahalme #define OVS_CS_F_NAT_MASK (OVS_CS_F_SRC_NAT | OVS_CS_F_DST_NAT)
4887f8a436eSJoe Stringer 
4899dd7f890SJarno Rajahalme struct ovs_key_ct_tuple_ipv4 {
4909dd7f890SJarno Rajahalme 	__be32 ipv4_src;
4919dd7f890SJarno Rajahalme 	__be32 ipv4_dst;
4929dd7f890SJarno Rajahalme 	__be16 src_port;
4939dd7f890SJarno Rajahalme 	__be16 dst_port;
4949dd7f890SJarno Rajahalme 	__u8   ipv4_proto;
4959dd7f890SJarno Rajahalme };
4969dd7f890SJarno Rajahalme 
4979dd7f890SJarno Rajahalme struct ovs_key_ct_tuple_ipv6 {
4989dd7f890SJarno Rajahalme 	__be32 ipv6_src[4];
4999dd7f890SJarno Rajahalme 	__be32 ipv6_dst[4];
5009dd7f890SJarno Rajahalme 	__be16 src_port;
5019dd7f890SJarno Rajahalme 	__be16 dst_port;
5029dd7f890SJarno Rajahalme 	__u8   ipv6_proto;
5039dd7f890SJarno Rajahalme };
5049dd7f890SJarno Rajahalme 
505b2d0f5d5SYi Yang enum ovs_nsh_key_attr {
506b2d0f5d5SYi Yang 	OVS_NSH_KEY_ATTR_UNSPEC,
507b2d0f5d5SYi Yang 	OVS_NSH_KEY_ATTR_BASE,  /* struct ovs_nsh_key_base. */
508b2d0f5d5SYi Yang 	OVS_NSH_KEY_ATTR_MD1,   /* struct ovs_nsh_key_md1. */
509b2d0f5d5SYi Yang 	OVS_NSH_KEY_ATTR_MD2,   /* variable-length octets for MD type 2. */
510b2d0f5d5SYi Yang 	__OVS_NSH_KEY_ATTR_MAX
511b2d0f5d5SYi Yang };
512b2d0f5d5SYi Yang 
513b2d0f5d5SYi Yang #define OVS_NSH_KEY_ATTR_MAX (__OVS_NSH_KEY_ATTR_MAX - 1)
514b2d0f5d5SYi Yang 
515b2d0f5d5SYi Yang struct ovs_nsh_key_base {
516b2d0f5d5SYi Yang 	__u8 flags;
517b2d0f5d5SYi Yang 	__u8 ttl;
518b2d0f5d5SYi Yang 	__u8 mdtype;
519b2d0f5d5SYi Yang 	__u8 np;
520b2d0f5d5SYi Yang 	__be32 path_hdr;
521b2d0f5d5SYi Yang };
522b2d0f5d5SYi Yang 
523b2d0f5d5SYi Yang #define NSH_MD1_CONTEXT_SIZE 4
524b2d0f5d5SYi Yang 
525b2d0f5d5SYi Yang struct ovs_nsh_key_md1 {
526b2d0f5d5SYi Yang 	__be32 context[NSH_MD1_CONTEXT_SIZE];
527b2d0f5d5SYi Yang };
528b2d0f5d5SYi Yang 
52922e3880aSThomas Graf /**
53022e3880aSThomas Graf  * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
53122e3880aSThomas Graf  * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
53222e3880aSThomas Graf  * key.  Always present in notifications.  Required for all requests (except
53322e3880aSThomas Graf  * dumps).
53422e3880aSThomas Graf  * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
53522e3880aSThomas Graf  * the actions to take for packets that match the key.  Always present in
53622e3880aSThomas Graf  * notifications.  Required for %OVS_FLOW_CMD_NEW requests, optional for
537be52c9e9SJarno Rajahalme  * %OVS_FLOW_CMD_SET requests.  An %OVS_FLOW_CMD_SET without
538be52c9e9SJarno Rajahalme  * %OVS_FLOW_ATTR_ACTIONS will not modify the actions.  To clear the actions,
539be52c9e9SJarno Rajahalme  * an %OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given.
54022e3880aSThomas Graf  * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
54122e3880aSThomas Graf  * flow.  Present in notifications if the stats would be nonzero.  Ignored in
54222e3880aSThomas Graf  * requests.
54322e3880aSThomas Graf  * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
54422e3880aSThomas Graf  * TCP flags seen on packets in this flow.  Only present in notifications for
54522e3880aSThomas Graf  * TCP flows, and only if it would be nonzero.  Ignored in requests.
54622e3880aSThomas Graf  * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
54722e3880aSThomas Graf  * the system monotonic clock, at which a packet was last processed for this
54822e3880aSThomas Graf  * flow.  Only present in notifications if a packet has been processed for this
54922e3880aSThomas Graf  * flow.  Ignored in requests.
55022e3880aSThomas Graf  * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
55122e3880aSThomas Graf  * last-used time, accumulated TCP flags, and statistics for this flow.
55222e3880aSThomas Graf  * Otherwise ignored in requests.  Never present in notifications.
55303f0d916SAndy Zhou  * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the
55403f0d916SAndy Zhou  * mask bits for wildcarded flow match. Mask bit value '1' specifies exact
55503f0d916SAndy Zhou  * match with corresponding flow key bit, while mask bit value '0' specifies
55603f0d916SAndy Zhou  * a wildcarded match. Omitting attribute is treated as wildcarding all
55703f0d916SAndy Zhou  * corresponding fields. Optional for all requests. If not present,
55803f0d916SAndy Zhou  * all flow key bits are exact match bits.
55974ed7ab9SJoe Stringer  * @OVS_FLOW_ATTR_UFID: A value between 1-16 octets specifying a unique
56074ed7ab9SJoe Stringer  * identifier for the flow. Causes the flow to be indexed by this value rather
56174ed7ab9SJoe Stringer  * than the value of the %OVS_FLOW_ATTR_KEY attribute. Optional for all
56274ed7ab9SJoe Stringer  * requests. Present in notifications if the flow was created with this
56374ed7ab9SJoe Stringer  * attribute.
56474ed7ab9SJoe Stringer  * @OVS_FLOW_ATTR_UFID_FLAGS: A 32-bit value of OR'd %OVS_UFID_F_*
56574ed7ab9SJoe Stringer  * flags that provide alternative semantics for flow installation and
56674ed7ab9SJoe Stringer  * retrieval. Optional for all requests.
56722e3880aSThomas Graf  *
56822e3880aSThomas Graf  * These attributes follow the &struct ovs_header within the Generic Netlink
56922e3880aSThomas Graf  * payload for %OVS_FLOW_* commands.
57022e3880aSThomas Graf  */
57122e3880aSThomas Graf enum ovs_flow_attr {
57222e3880aSThomas Graf 	OVS_FLOW_ATTR_UNSPEC,
57322e3880aSThomas Graf 	OVS_FLOW_ATTR_KEY,       /* Sequence of OVS_KEY_ATTR_* attributes. */
57422e3880aSThomas Graf 	OVS_FLOW_ATTR_ACTIONS,   /* Nested OVS_ACTION_ATTR_* attributes. */
57522e3880aSThomas Graf 	OVS_FLOW_ATTR_STATS,     /* struct ovs_flow_stats. */
57622e3880aSThomas Graf 	OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
57722e3880aSThomas Graf 	OVS_FLOW_ATTR_USED,      /* u64 msecs last used in monotonic time. */
57822e3880aSThomas Graf 	OVS_FLOW_ATTR_CLEAR,     /* Flag to clear stats, tcp_flags, used. */
57903f0d916SAndy Zhou 	OVS_FLOW_ATTR_MASK,      /* Sequence of OVS_KEY_ATTR_* attributes. */
58005da5898SJarno Rajahalme 	OVS_FLOW_ATTR_PROBE,     /* Flow operation is a feature probe, error
58105da5898SJarno Rajahalme 				  * logging should be suppressed. */
58274ed7ab9SJoe Stringer 	OVS_FLOW_ATTR_UFID,      /* Variable length unique flow identifier. */
58374ed7ab9SJoe Stringer 	OVS_FLOW_ATTR_UFID_FLAGS,/* u32 of OVS_UFID_F_*. */
5840238b720SNicolas Dichtel 	OVS_FLOW_ATTR_PAD,
58522e3880aSThomas Graf 	__OVS_FLOW_ATTR_MAX
58622e3880aSThomas Graf };
58722e3880aSThomas Graf 
58822e3880aSThomas Graf #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
58922e3880aSThomas Graf 
59022e3880aSThomas Graf /**
59174ed7ab9SJoe Stringer  * Omit attributes for notifications.
59274ed7ab9SJoe Stringer  *
59374ed7ab9SJoe Stringer  * If a datapath request contains an %OVS_UFID_F_OMIT_* flag, then the datapath
59474ed7ab9SJoe Stringer  * may omit the corresponding %OVS_FLOW_ATTR_* from the response.
59574ed7ab9SJoe Stringer  */
59674ed7ab9SJoe Stringer #define OVS_UFID_F_OMIT_KEY      (1 << 0)
59774ed7ab9SJoe Stringer #define OVS_UFID_F_OMIT_MASK     (1 << 1)
59874ed7ab9SJoe Stringer #define OVS_UFID_F_OMIT_ACTIONS  (1 << 2)
59974ed7ab9SJoe Stringer 
60074ed7ab9SJoe Stringer /**
60122e3880aSThomas Graf  * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
60222e3880aSThomas Graf  * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
60322e3880aSThomas Graf  * @OVS_ACTION_ATTR_SAMPLE.  A value of 0 samples no packets, a value of
60422e3880aSThomas Graf  * %UINT32_MAX samples all packets and intermediate values sample intermediate
60522e3880aSThomas Graf  * fractions of packets.
60622e3880aSThomas Graf  * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
60722e3880aSThomas Graf  * Actions are passed as nested attributes.
60822e3880aSThomas Graf  *
60922e3880aSThomas Graf  * Executes the specified actions with the given probability on a per-packet
61022e3880aSThomas Graf  * basis.
61122e3880aSThomas Graf  */
61222e3880aSThomas Graf enum ovs_sample_attr {
61322e3880aSThomas Graf 	OVS_SAMPLE_ATTR_UNSPEC,
61422e3880aSThomas Graf 	OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
61522e3880aSThomas Graf 	OVS_SAMPLE_ATTR_ACTIONS,     /* Nested OVS_ACTION_ATTR_* attributes. */
61622e3880aSThomas Graf 	__OVS_SAMPLE_ATTR_MAX,
617798c1661Sandy zhou 
618798c1661Sandy zhou #ifdef __KERNEL__
619798c1661Sandy zhou 	OVS_SAMPLE_ATTR_ARG          /* struct sample_arg  */
620798c1661Sandy zhou #endif
62122e3880aSThomas Graf };
62222e3880aSThomas Graf 
62322e3880aSThomas Graf #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
62422e3880aSThomas Graf 
625798c1661Sandy zhou #ifdef __KERNEL__
626798c1661Sandy zhou struct sample_arg {
627798c1661Sandy zhou 	bool exec;                   /* When true, actions in sample will not
628798c1661Sandy zhou 				      * change flow keys. False otherwise.
629798c1661Sandy zhou 				      */
630798c1661Sandy zhou 	u32  probability;            /* Same value as
631798c1661Sandy zhou 				      * 'OVS_SAMPLE_ATTR_PROBABILITY'.
632798c1661Sandy zhou 				      */
633798c1661Sandy zhou };
634798c1661Sandy zhou #endif
635798c1661Sandy zhou 
63622e3880aSThomas Graf /**
63722e3880aSThomas Graf  * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
63822e3880aSThomas Graf  * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
63922e3880aSThomas Graf  * message should be sent.  Required.
64022e3880aSThomas Graf  * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is
64122e3880aSThomas Graf  * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA.
6428f0aad6fSWenyu Zhang  * @OVS_USERSPACE_ATTR_EGRESS_TUN_PORT: If present, u32 output port to get
6438f0aad6fSWenyu Zhang  * tunnel info.
644ccea7445SNeil McKee  * @OVS_USERSPACE_ATTR_ACTIONS: If present, send actions with upcall.
64522e3880aSThomas Graf  */
64622e3880aSThomas Graf enum ovs_userspace_attr {
64722e3880aSThomas Graf 	OVS_USERSPACE_ATTR_UNSPEC,
64822e3880aSThomas Graf 	OVS_USERSPACE_ATTR_PID,	      /* u32 Netlink PID to receive upcalls. */
64922e3880aSThomas Graf 	OVS_USERSPACE_ATTR_USERDATA,  /* Optional user-specified cookie. */
6508f0aad6fSWenyu Zhang 	OVS_USERSPACE_ATTR_EGRESS_TUN_PORT,  /* Optional, u32 output port
6518f0aad6fSWenyu Zhang 					      * to get tunnel info. */
652ccea7445SNeil McKee 	OVS_USERSPACE_ATTR_ACTIONS,   /* Optional flag to get actions. */
65322e3880aSThomas Graf 	__OVS_USERSPACE_ATTR_MAX
65422e3880aSThomas Graf };
65522e3880aSThomas Graf 
65622e3880aSThomas Graf #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
65722e3880aSThomas Graf 
658f2a4d086SWilliam Tu struct ovs_action_trunc {
659a1d1f65fSMikko Rapeli 	__u32 max_len; /* Max packet size in bytes. */
660f2a4d086SWilliam Tu };
661f2a4d086SWilliam Tu 
66222e3880aSThomas Graf /**
66325cd9ba0SSimon Horman  * struct ovs_action_push_mpls - %OVS_ACTION_ATTR_PUSH_MPLS action argument.
66425cd9ba0SSimon Horman  * @mpls_lse: MPLS label stack entry to push.
66525cd9ba0SSimon Horman  * @mpls_ethertype: Ethertype to set in the encapsulating ethernet frame.
66625cd9ba0SSimon Horman  *
66725cd9ba0SSimon Horman  * The only values @mpls_ethertype should ever be given are %ETH_P_MPLS_UC and
66825cd9ba0SSimon Horman  * %ETH_P_MPLS_MC, indicating MPLS unicast or multicast. Other are rejected.
66925cd9ba0SSimon Horman  */
67025cd9ba0SSimon Horman struct ovs_action_push_mpls {
67125cd9ba0SSimon Horman 	__be32 mpls_lse;
67225cd9ba0SSimon Horman 	__be16 mpls_ethertype; /* Either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC */
67325cd9ba0SSimon Horman };
67425cd9ba0SSimon Horman 
67525cd9ba0SSimon Horman /**
676*f66b53fdSMartin Varghese  * struct ovs_action_add_mpls - %OVS_ACTION_ATTR_ADD_MPLS action
677*f66b53fdSMartin Varghese  * argument.
678*f66b53fdSMartin Varghese  * @mpls_lse: MPLS label stack entry to push.
679*f66b53fdSMartin Varghese  * @mpls_ethertype: Ethertype to set in the encapsulating ethernet frame.
680*f66b53fdSMartin Varghese  * @tun_flags: MPLS tunnel attributes.
681*f66b53fdSMartin Varghese  *
682*f66b53fdSMartin Varghese  * The only values @mpls_ethertype should ever be given are %ETH_P_MPLS_UC and
683*f66b53fdSMartin Varghese  * %ETH_P_MPLS_MC, indicating MPLS unicast or multicast. Other are rejected.
684*f66b53fdSMartin Varghese  */
685*f66b53fdSMartin Varghese struct ovs_action_add_mpls {
686*f66b53fdSMartin Varghese 	__be32 mpls_lse;
687*f66b53fdSMartin Varghese 	__be16 mpls_ethertype; /* Either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC */
688*f66b53fdSMartin Varghese 	__u16 tun_flags;
689*f66b53fdSMartin Varghese };
690*f66b53fdSMartin Varghese 
691*f66b53fdSMartin Varghese #define OVS_MPLS_L3_TUNNEL_FLAG_MASK  (1 << 0) /* Flag to specify the place of
692*f66b53fdSMartin Varghese 						* insertion of MPLS header.
693*f66b53fdSMartin Varghese 						* When false, the MPLS header
694*f66b53fdSMartin Varghese 						* will be inserted at the start
695*f66b53fdSMartin Varghese 						* of the packet.
696*f66b53fdSMartin Varghese 						* When true, the MPLS header
697*f66b53fdSMartin Varghese 						* will be inserted at the start
698*f66b53fdSMartin Varghese 						* of the l3 header.
699*f66b53fdSMartin Varghese 						*/
700*f66b53fdSMartin Varghese 
701*f66b53fdSMartin Varghese /**
70222e3880aSThomas Graf  * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument.
70322e3880aSThomas Graf  * @vlan_tpid: Tag protocol identifier (TPID) to push.
70422e3880aSThomas Graf  * @vlan_tci: Tag control identifier (TCI) to push.  The CFI bit must be set
70522e3880aSThomas Graf  * (but it will not be set in the 802.1Q header that is pushed).
70622e3880aSThomas Graf  *
7078c146bb9SThomas F Herbert  * The @vlan_tpid value is typically %ETH_P_8021Q or %ETH_P_8021AD.
7088c146bb9SThomas F Herbert  * The only acceptable TPID values are those that the kernel module also parses
7098c146bb9SThomas F Herbert  * as 802.1Q or 802.1AD headers, to prevent %OVS_ACTION_ATTR_PUSH_VLAN followed
7108c146bb9SThomas F Herbert  * by %OVS_ACTION_ATTR_POP_VLAN from having surprising results.
71122e3880aSThomas Graf  */
71222e3880aSThomas Graf struct ovs_action_push_vlan {
7138c146bb9SThomas F Herbert 	__be16 vlan_tpid;	/* 802.1Q or 802.1ad TPID. */
71422e3880aSThomas Graf 	__be16 vlan_tci;	/* 802.1Q TCI (VLAN ID and priority). */
71522e3880aSThomas Graf };
71622e3880aSThomas Graf 
717971427f3SAndy Zhou /* Data path hash algorithm for computing Datapath hash.
718971427f3SAndy Zhou  *
719971427f3SAndy Zhou  * The algorithm type only specifies the fields in a flow
720971427f3SAndy Zhou  * will be used as part of the hash. Each datapath is free
721971427f3SAndy Zhou  * to use its own hash algorithm. The hash value will be
722971427f3SAndy Zhou  * opaque to the user space daemon.
723971427f3SAndy Zhou  */
724971427f3SAndy Zhou enum ovs_hash_alg {
725971427f3SAndy Zhou 	OVS_HASH_ALG_L4,
726971427f3SAndy Zhou };
727971427f3SAndy Zhou 
728971427f3SAndy Zhou /*
729971427f3SAndy Zhou  * struct ovs_action_hash - %OVS_ACTION_ATTR_HASH action argument.
730971427f3SAndy Zhou  * @hash_alg: Algorithm used to compute hash prior to recirculation.
731971427f3SAndy Zhou  * @hash_basis: basis used for computing hash.
732971427f3SAndy Zhou  */
733971427f3SAndy Zhou struct ovs_action_hash {
734e6571aa5SMikko Rapeli 	__u32  hash_alg;     /* One of ovs_hash_alg. */
735e6571aa5SMikko Rapeli 	__u32  hash_basis;
736971427f3SAndy Zhou };
737971427f3SAndy Zhou 
73822e3880aSThomas Graf /**
7397f8a436eSJoe Stringer  * enum ovs_ct_attr - Attributes for %OVS_ACTION_ATTR_CT action.
740ab38a7b5SJoe Stringer  * @OVS_CT_ATTR_COMMIT: If present, commits the connection to the conntrack
741ab38a7b5SJoe Stringer  * table. This allows future packets for the same connection to be identified
7421d008a1dSJoe Stringer  * as 'established' or 'related'. The flow key for the current packet will
7431d008a1dSJoe Stringer  * retain the pre-commit connection state.
7447f8a436eSJoe Stringer  * @OVS_CT_ATTR_ZONE: u16 connection tracking zone.
745182e3042SJoe Stringer  * @OVS_CT_ATTR_MARK: u32 value followed by u32 mask. For each bit set in the
746182e3042SJoe Stringer  * mask, the corresponding bit in the value is copied to the connection
747182e3042SJoe Stringer  * tracking mark field in the connection.
748e5f5d747SPaolo Abeni  * @OVS_CT_ATTR_LABELS: %OVS_CT_LABELS_LEN value followed by %OVS_CT_LABELS_LEN
749c2ac6673SJoe Stringer  * mask. For each bit set in the mask, the corresponding bit in the value is
750c2ac6673SJoe Stringer  * copied to the connection tracking label field in the connection.
751cae3a262SJoe Stringer  * @OVS_CT_ATTR_HELPER: variable length string defining conntrack ALG.
75205752523SJarno Rajahalme  * @OVS_CT_ATTR_NAT: Nested OVS_NAT_ATTR_* for performing L3 network address
75305752523SJarno Rajahalme  * translation (NAT) on the packet.
754dd41d33fSJarno Rajahalme  * @OVS_CT_ATTR_FORCE_COMMIT: Like %OVS_CT_ATTR_COMMIT, but instead of doing
755dd41d33fSJarno Rajahalme  * nothing if the connection is already committed will check that the current
756dd41d33fSJarno Rajahalme  * packet is in conntrack entry's original direction.  If directionality does
757dd41d33fSJarno Rajahalme  * not match, will delete the existing conntrack entry and commit a new one.
75812064551SJarno Rajahalme  * @OVS_CT_ATTR_EVENTMASK: Mask of bits indicating which conntrack event types
75912064551SJarno Rajahalme  * (enum ip_conntrack_events IPCT_*) should be reported.  For any bit set to
76012064551SJarno Rajahalme  * zero, the corresponding event type is not generated.  Default behavior
76112064551SJarno Rajahalme  * depends on system configuration, but typically all event types are
76212064551SJarno Rajahalme  * generated, hence listening on NFNLGRP_CONNTRACK_UPDATE events may get a lot
76312064551SJarno Rajahalme  * of events.  Explicitly passing this attribute allows limiting the updates
76412064551SJarno Rajahalme  * received to the events of interest.  The bit 1 << IPCT_NEW, 1 <<
76512064551SJarno Rajahalme  * IPCT_RELATED, and 1 << IPCT_DESTROY must be set to ones for those events to
76612064551SJarno Rajahalme  * be received on NFNLGRP_CONNTRACK_NEW and NFNLGRP_CONNTRACK_DESTROY groups,
76712064551SJarno Rajahalme  * respectively.  Remaining bits control the changes for which an event is
76812064551SJarno Rajahalme  * delivered on the NFNLGRP_CONNTRACK_UPDATE group.
76906bd2bdfSYi-Hung Wei  * @OVS_CT_ATTR_TIMEOUT: Variable length string defining conntrack timeout.
7707f8a436eSJoe Stringer  */
7717f8a436eSJoe Stringer enum ovs_ct_attr {
7727f8a436eSJoe Stringer 	OVS_CT_ATTR_UNSPEC,
773ab38a7b5SJoe Stringer 	OVS_CT_ATTR_COMMIT,     /* No argument, commits connection. */
7747f8a436eSJoe Stringer 	OVS_CT_ATTR_ZONE,       /* u16 zone id. */
775182e3042SJoe Stringer 	OVS_CT_ATTR_MARK,       /* mark to associate with this connection. */
77633db4125SJoe Stringer 	OVS_CT_ATTR_LABELS,     /* labels to associate with this connection. */
777cae3a262SJoe Stringer 	OVS_CT_ATTR_HELPER,     /* netlink helper to assist detection of
778cae3a262SJoe Stringer 				   related connections. */
77905752523SJarno Rajahalme 	OVS_CT_ATTR_NAT,        /* Nested OVS_NAT_ATTR_* */
780dd41d33fSJarno Rajahalme 	OVS_CT_ATTR_FORCE_COMMIT,  /* No argument */
78112064551SJarno Rajahalme 	OVS_CT_ATTR_EVENTMASK,  /* u32 mask of IPCT_* events. */
78206bd2bdfSYi-Hung Wei 	OVS_CT_ATTR_TIMEOUT,	/* Associate timeout with this connection for
78306bd2bdfSYi-Hung Wei 				 * fine-grain timeout tuning. */
7847f8a436eSJoe Stringer 	__OVS_CT_ATTR_MAX
7857f8a436eSJoe Stringer };
7867f8a436eSJoe Stringer 
7877f8a436eSJoe Stringer #define OVS_CT_ATTR_MAX (__OVS_CT_ATTR_MAX - 1)
7887f8a436eSJoe Stringer 
7897f8a436eSJoe Stringer /**
79005752523SJarno Rajahalme  * enum ovs_nat_attr - Attributes for %OVS_CT_ATTR_NAT.
79105752523SJarno Rajahalme  *
79205752523SJarno Rajahalme  * @OVS_NAT_ATTR_SRC: Flag for Source NAT (mangle source address/port).
79305752523SJarno Rajahalme  * @OVS_NAT_ATTR_DST: Flag for Destination NAT (mangle destination
79405752523SJarno Rajahalme  * address/port).  Only one of (@OVS_NAT_ATTR_SRC, @OVS_NAT_ATTR_DST) may be
79505752523SJarno Rajahalme  * specified.  Effective only for packets for ct_state NEW connections.
79605752523SJarno Rajahalme  * Packets of committed connections are mangled by the NAT action according to
79705752523SJarno Rajahalme  * the committed NAT type regardless of the flags specified.  As a corollary, a
79805752523SJarno Rajahalme  * NAT action without a NAT type flag will only mangle packets of committed
79905752523SJarno Rajahalme  * connections.  The following NAT attributes only apply for NEW
80005752523SJarno Rajahalme  * (non-committed) connections, and they may be included only when the CT
80105752523SJarno Rajahalme  * action has the @OVS_CT_ATTR_COMMIT flag and either @OVS_NAT_ATTR_SRC or
80205752523SJarno Rajahalme  * @OVS_NAT_ATTR_DST is also included.
80305752523SJarno Rajahalme  * @OVS_NAT_ATTR_IP_MIN: struct in_addr or struct in6_addr
80405752523SJarno Rajahalme  * @OVS_NAT_ATTR_IP_MAX: struct in_addr or struct in6_addr
80505752523SJarno Rajahalme  * @OVS_NAT_ATTR_PROTO_MIN: u16 L4 protocol specific lower boundary (port)
80605752523SJarno Rajahalme  * @OVS_NAT_ATTR_PROTO_MAX: u16 L4 protocol specific upper boundary (port)
80705752523SJarno Rajahalme  * @OVS_NAT_ATTR_PERSISTENT: Flag for persistent IP mapping across reboots
80805752523SJarno Rajahalme  * @OVS_NAT_ATTR_PROTO_HASH: Flag for pseudo random L4 port mapping (MD5)
80905752523SJarno Rajahalme  * @OVS_NAT_ATTR_PROTO_RANDOM: Flag for fully randomized L4 port mapping
81005752523SJarno Rajahalme  */
81105752523SJarno Rajahalme enum ovs_nat_attr {
81205752523SJarno Rajahalme 	OVS_NAT_ATTR_UNSPEC,
81305752523SJarno Rajahalme 	OVS_NAT_ATTR_SRC,
81405752523SJarno Rajahalme 	OVS_NAT_ATTR_DST,
81505752523SJarno Rajahalme 	OVS_NAT_ATTR_IP_MIN,
81605752523SJarno Rajahalme 	OVS_NAT_ATTR_IP_MAX,
81705752523SJarno Rajahalme 	OVS_NAT_ATTR_PROTO_MIN,
81805752523SJarno Rajahalme 	OVS_NAT_ATTR_PROTO_MAX,
81905752523SJarno Rajahalme 	OVS_NAT_ATTR_PERSISTENT,
82005752523SJarno Rajahalme 	OVS_NAT_ATTR_PROTO_HASH,
82105752523SJarno Rajahalme 	OVS_NAT_ATTR_PROTO_RANDOM,
82205752523SJarno Rajahalme 	__OVS_NAT_ATTR_MAX,
82305752523SJarno Rajahalme };
82405752523SJarno Rajahalme 
82505752523SJarno Rajahalme #define OVS_NAT_ATTR_MAX (__OVS_NAT_ATTR_MAX - 1)
82605752523SJarno Rajahalme 
82791820da6SJiri Benc /*
82891820da6SJiri Benc  * struct ovs_action_push_eth - %OVS_ACTION_ATTR_PUSH_ETH action argument.
82991820da6SJiri Benc  * @addresses: Source and destination MAC addresses.
83091820da6SJiri Benc  * @eth_type: Ethernet type
83191820da6SJiri Benc  */
83291820da6SJiri Benc struct ovs_action_push_eth {
83391820da6SJiri Benc 	struct ovs_key_ethernet addresses;
83491820da6SJiri Benc };
83591820da6SJiri Benc 
8364d5ec89fSNuman Siddique /*
8374d5ec89fSNuman Siddique  * enum ovs_check_pkt_len_attr - Attributes for %OVS_ACTION_ATTR_CHECK_PKT_LEN.
8384d5ec89fSNuman Siddique  *
8394d5ec89fSNuman Siddique  * @OVS_CHECK_PKT_LEN_ATTR_PKT_LEN: u16 Packet length to check for.
8404d5ec89fSNuman Siddique  * @OVS_CHECK_PKT_LEN_ATTR_ACTIONS_IF_GREATER: Nested OVS_ACTION_ATTR_*
8414d5ec89fSNuman Siddique  * actions to apply if the packer length is greater than the specified
8424d5ec89fSNuman Siddique  * length in the attr - OVS_CHECK_PKT_LEN_ATTR_PKT_LEN.
8434d5ec89fSNuman Siddique  * @OVS_CHECK_PKT_LEN_ATTR_ACTIONS_IF_LESS_EQUAL - Nested OVS_ACTION_ATTR_*
8444d5ec89fSNuman Siddique  * actions to apply if the packer length is lesser or equal to the specified
8454d5ec89fSNuman Siddique  * length in the attr - OVS_CHECK_PKT_LEN_ATTR_PKT_LEN.
8464d5ec89fSNuman Siddique  */
8474d5ec89fSNuman Siddique enum ovs_check_pkt_len_attr {
8484d5ec89fSNuman Siddique 	OVS_CHECK_PKT_LEN_ATTR_UNSPEC,
8494d5ec89fSNuman Siddique 	OVS_CHECK_PKT_LEN_ATTR_PKT_LEN,
8504d5ec89fSNuman Siddique 	OVS_CHECK_PKT_LEN_ATTR_ACTIONS_IF_GREATER,
8514d5ec89fSNuman Siddique 	OVS_CHECK_PKT_LEN_ATTR_ACTIONS_IF_LESS_EQUAL,
8524d5ec89fSNuman Siddique 	__OVS_CHECK_PKT_LEN_ATTR_MAX,
8534d5ec89fSNuman Siddique 
8544d5ec89fSNuman Siddique #ifdef __KERNEL__
8554d5ec89fSNuman Siddique 	OVS_CHECK_PKT_LEN_ATTR_ARG          /* struct check_pkt_len_arg  */
8564d5ec89fSNuman Siddique #endif
8574d5ec89fSNuman Siddique };
8584d5ec89fSNuman Siddique 
8594d5ec89fSNuman Siddique #define OVS_CHECK_PKT_LEN_ATTR_MAX (__OVS_CHECK_PKT_LEN_ATTR_MAX - 1)
8604d5ec89fSNuman Siddique 
8614d5ec89fSNuman Siddique #ifdef __KERNEL__
8624d5ec89fSNuman Siddique struct check_pkt_len_arg {
8634d5ec89fSNuman Siddique 	u16 pkt_len;	/* Same value as OVS_CHECK_PKT_LEN_ATTR_PKT_LEN'. */
8644d5ec89fSNuman Siddique 	bool exec_for_greater;	/* When true, actions in IF_GREATER will
8654d5ec89fSNuman Siddique 				 * not change flow keys. False otherwise.
8664d5ec89fSNuman Siddique 				 */
8674d5ec89fSNuman Siddique 	bool exec_for_lesser_equal; /* When true, actions in IF_LESS_EQUAL
8684d5ec89fSNuman Siddique 				     * will not change flow keys. False
8694d5ec89fSNuman Siddique 				     * otherwise.
8704d5ec89fSNuman Siddique 				     */
8714d5ec89fSNuman Siddique };
8724d5ec89fSNuman Siddique #endif
8734d5ec89fSNuman Siddique 
87405752523SJarno Rajahalme /**
87522e3880aSThomas Graf  * enum ovs_action_attr - Action types.
87622e3880aSThomas Graf  *
87722e3880aSThomas Graf  * @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
878f2a4d086SWilliam Tu  * @OVS_ACTION_ATTR_TRUNC: Output packet to port with truncated packet size.
87922e3880aSThomas Graf  * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
88022e3880aSThomas Graf  * %OVS_USERSPACE_ATTR_* attributes.
88122e3880aSThomas Graf  * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header.  The
88222e3880aSThomas Graf  * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its
88322e3880aSThomas Graf  * value.
88483d2b9baSJarno Rajahalme  * @OVS_ACTION_ATTR_SET_MASKED: Replaces the contents of an existing header.  A
88583d2b9baSJarno Rajahalme  * nested %OVS_KEY_ATTR_* attribute specifies a header to modify, its value,
88683d2b9baSJarno Rajahalme  * and a mask.  For every bit set in the mask, the corresponding bit value
88783d2b9baSJarno Rajahalme  * is copied from the value to the packet header field, rest of the bits are
88883d2b9baSJarno Rajahalme  * left unchanged.  The non-masked value bits must be passed in as zeroes.
88983d2b9baSJarno Rajahalme  * Masking is not supported for the %OVS_KEY_ATTR_TUNNEL attribute.
8908c146bb9SThomas F Herbert  * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q or 802.1ad header
8918c146bb9SThomas F Herbert  * onto the packet.
8928c146bb9SThomas F Herbert  * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q or 802.1ad header
8938c146bb9SThomas F Herbert  * from the packet.
89422e3880aSThomas Graf  * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
89522e3880aSThomas Graf  * the nested %OVS_SAMPLE_ATTR_* attributes.
89625cd9ba0SSimon Horman  * @OVS_ACTION_ATTR_PUSH_MPLS: Push a new MPLS label stack entry onto the
89725cd9ba0SSimon Horman  * top of the packets MPLS label stack.  Set the ethertype of the
89825cd9ba0SSimon Horman  * encapsulating frame to either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC to
89925cd9ba0SSimon Horman  * indicate the new packet contents.
90025cd9ba0SSimon Horman  * @OVS_ACTION_ATTR_POP_MPLS: Pop an MPLS label stack entry off of the
90125cd9ba0SSimon Horman  * packet's MPLS label stack.  Set the encapsulating frame's ethertype to
90225cd9ba0SSimon Horman  * indicate the new packet contents. This could potentially still be
90325cd9ba0SSimon Horman  * %ETH_P_MPLS if the resulting MPLS label stack is not empty.  If there
90425cd9ba0SSimon Horman  * is no MPLS label stack, as determined by ethertype, no action is taken.
9057f8a436eSJoe Stringer  * @OVS_ACTION_ATTR_CT: Track the connection. Populate the conntrack-related
9067f8a436eSJoe Stringer  * entries in the flow key.
90791820da6SJiri Benc  * @OVS_ACTION_ATTR_PUSH_ETH: Push a new outermost Ethernet header onto the
90891820da6SJiri Benc  * packet.
90991820da6SJiri Benc  * @OVS_ACTION_ATTR_POP_ETH: Pop the outermost Ethernet header off the
91091820da6SJiri Benc  * packet.
911b8226962SEric Garver  * @OVS_ACTION_ATTR_CT_CLEAR: Clear conntrack state from the packet.
912b2d0f5d5SYi Yang  * @OVS_ACTION_ATTR_PUSH_NSH: push NSH header to the packet.
913b2d0f5d5SYi Yang  * @OVS_ACTION_ATTR_POP_NSH: pop the outermost NSH header off the packet.
914cd8a6c33SAndy Zhou  * @OVS_ACTION_ATTR_METER: Run packet through a meter, which may drop the
915cd8a6c33SAndy Zhou  * packet, or modify the packet (e.g., change the DSCP field).
916b2335040SYifeng Sun  * @OVS_ACTION_ATTR_CLONE: make a copy of the packet and execute a list of
917b2335040SYifeng Sun  * actions without affecting the original packet and key.
9184d5ec89fSNuman Siddique  * @OVS_ACTION_ATTR_CHECK_PKT_LEN: Check the packet length and execute a set
9194d5ec89fSNuman Siddique  * of actions if greater than the specified packet length, else execute
9204d5ec89fSNuman Siddique  * another set of actions.
921*f66b53fdSMartin Varghese  * @OVS_ACTION_ATTR_ADD_MPLS: Push a new MPLS label stack entry at the
922*f66b53fdSMartin Varghese  * start of the packet or at the start of the l3 header depending on the value
923*f66b53fdSMartin Varghese  * of l3 tunnel flag in the tun_flags field of OVS_ACTION_ATTR_ADD_MPLS
924*f66b53fdSMartin Varghese  * argument.
92522e3880aSThomas Graf  *
92622e3880aSThomas Graf  * Only a single header can be set with a single %OVS_ACTION_ATTR_SET.  Not all
92722e3880aSThomas Graf  * fields within a header are modifiable, e.g. the IPv4 protocol and fragment
92822e3880aSThomas Graf  * type may not be changed.
92983d2b9baSJarno Rajahalme  *
93083d2b9baSJarno Rajahalme  * @OVS_ACTION_ATTR_SET_TO_MASKED: Kernel internal masked set action translated
93183d2b9baSJarno Rajahalme  * from the @OVS_ACTION_ATTR_SET.
93222e3880aSThomas Graf  */
93322e3880aSThomas Graf 
93422e3880aSThomas Graf enum ovs_action_attr {
93522e3880aSThomas Graf 	OVS_ACTION_ATTR_UNSPEC,
93622e3880aSThomas Graf 	OVS_ACTION_ATTR_OUTPUT,	      /* u32 port number. */
93722e3880aSThomas Graf 	OVS_ACTION_ATTR_USERSPACE,    /* Nested OVS_USERSPACE_ATTR_*. */
93822e3880aSThomas Graf 	OVS_ACTION_ATTR_SET,          /* One nested OVS_KEY_ATTR_*. */
93922e3880aSThomas Graf 	OVS_ACTION_ATTR_PUSH_VLAN,    /* struct ovs_action_push_vlan. */
94022e3880aSThomas Graf 	OVS_ACTION_ATTR_POP_VLAN,     /* No argument. */
94122e3880aSThomas Graf 	OVS_ACTION_ATTR_SAMPLE,       /* Nested OVS_SAMPLE_ATTR_*. */
942971427f3SAndy Zhou 	OVS_ACTION_ATTR_RECIRC,       /* u32 recirc_id. */
943971427f3SAndy Zhou 	OVS_ACTION_ATTR_HASH,	      /* struct ovs_action_hash. */
94425cd9ba0SSimon Horman 	OVS_ACTION_ATTR_PUSH_MPLS,    /* struct ovs_action_push_mpls. */
94525cd9ba0SSimon Horman 	OVS_ACTION_ATTR_POP_MPLS,     /* __be16 ethertype. */
94683d2b9baSJarno Rajahalme 	OVS_ACTION_ATTR_SET_MASKED,   /* One nested OVS_KEY_ATTR_* including
94783d2b9baSJarno Rajahalme 				       * data immediately followed by a mask.
94883d2b9baSJarno Rajahalme 				       * The data must be zero for the unmasked
94983d2b9baSJarno Rajahalme 				       * bits. */
9500a7cc172SJoe Stringer 	OVS_ACTION_ATTR_CT,           /* Nested OVS_CT_ATTR_* . */
951f2a4d086SWilliam Tu 	OVS_ACTION_ATTR_TRUNC,        /* u32 struct ovs_action_trunc. */
95291820da6SJiri Benc 	OVS_ACTION_ATTR_PUSH_ETH,     /* struct ovs_action_push_eth. */
95391820da6SJiri Benc 	OVS_ACTION_ATTR_POP_ETH,      /* No argument. */
954b8226962SEric Garver 	OVS_ACTION_ATTR_CT_CLEAR,     /* No argument. */
955b2d0f5d5SYi Yang 	OVS_ACTION_ATTR_PUSH_NSH,     /* Nested OVS_NSH_KEY_ATTR_*. */
956b2d0f5d5SYi Yang 	OVS_ACTION_ATTR_POP_NSH,      /* No argument. */
957cd8a6c33SAndy Zhou 	OVS_ACTION_ATTR_METER,        /* u32 meter ID. */
958b2335040SYifeng Sun 	OVS_ACTION_ATTR_CLONE,        /* Nested OVS_CLONE_ATTR_*.  */
9594d5ec89fSNuman Siddique 	OVS_ACTION_ATTR_CHECK_PKT_LEN, /* Nested OVS_CHECK_PKT_LEN_ATTR_*. */
960*f66b53fdSMartin Varghese 	OVS_ACTION_ATTR_ADD_MPLS,     /* struct ovs_action_add_mpls. */
96125cd9ba0SSimon Horman 
96283d2b9baSJarno Rajahalme 	__OVS_ACTION_ATTR_MAX,	      /* Nothing past this will be accepted
96383d2b9baSJarno Rajahalme 				       * from userspace. */
96483d2b9baSJarno Rajahalme 
96583d2b9baSJarno Rajahalme #ifdef __KERNEL__
96683d2b9baSJarno Rajahalme 	OVS_ACTION_ATTR_SET_TO_MASKED, /* Kernel module internal masked
96783d2b9baSJarno Rajahalme 					* set action converted from
96883d2b9baSJarno Rajahalme 					* OVS_ACTION_ATTR_SET. */
96983d2b9baSJarno Rajahalme #endif
97022e3880aSThomas Graf };
97122e3880aSThomas Graf 
97222e3880aSThomas Graf #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
97322e3880aSThomas Graf 
97457940406SAndy Zhou /* Meters. */
97557940406SAndy Zhou #define OVS_METER_FAMILY  "ovs_meter"
97657940406SAndy Zhou #define OVS_METER_MCGROUP "ovs_meter"
97757940406SAndy Zhou #define OVS_METER_VERSION 0x1
97857940406SAndy Zhou 
97957940406SAndy Zhou enum ovs_meter_cmd {
98057940406SAndy Zhou 	OVS_METER_CMD_UNSPEC,
98157940406SAndy Zhou 	OVS_METER_CMD_FEATURES,	/* Get features supported by the datapath. */
98257940406SAndy Zhou 	OVS_METER_CMD_SET,	/* Add or modify a meter. */
98357940406SAndy Zhou 	OVS_METER_CMD_DEL,	/* Delete a meter. */
98457940406SAndy Zhou 	OVS_METER_CMD_GET	/* Get meter stats. */
98557940406SAndy Zhou };
98657940406SAndy Zhou 
98757940406SAndy Zhou enum ovs_meter_attr {
98857940406SAndy Zhou 	OVS_METER_ATTR_UNSPEC,
98957940406SAndy Zhou 	OVS_METER_ATTR_ID,	/* u32 meter ID within datapath. */
99057940406SAndy Zhou 	OVS_METER_ATTR_KBPS,	/* No argument. If set, units in kilobits
99157940406SAndy Zhou 				 * per second. Otherwise, units in
99257940406SAndy Zhou 				 * packets per second.
99357940406SAndy Zhou 				 */
99457940406SAndy Zhou 	OVS_METER_ATTR_STATS,	/* struct ovs_flow_stats for the meter. */
99557940406SAndy Zhou 	OVS_METER_ATTR_BANDS,	/* Nested attributes for meter bands. */
99657940406SAndy Zhou 	OVS_METER_ATTR_USED,	/* u64 msecs last used in monotonic time. */
99757940406SAndy Zhou 	OVS_METER_ATTR_CLEAR,	/* Flag to clear stats, used. */
99857940406SAndy Zhou 	OVS_METER_ATTR_MAX_METERS, /* u32 number of meters supported. */
99957940406SAndy Zhou 	OVS_METER_ATTR_MAX_BANDS,  /* u32 max number of bands per meter. */
100057940406SAndy Zhou 	OVS_METER_ATTR_PAD,
100157940406SAndy Zhou 	__OVS_METER_ATTR_MAX
100257940406SAndy Zhou };
100357940406SAndy Zhou 
100457940406SAndy Zhou #define OVS_METER_ATTR_MAX (__OVS_METER_ATTR_MAX - 1)
100557940406SAndy Zhou 
100657940406SAndy Zhou enum ovs_band_attr {
100757940406SAndy Zhou 	OVS_BAND_ATTR_UNSPEC,
100857940406SAndy Zhou 	OVS_BAND_ATTR_TYPE,	/* u32 OVS_METER_BAND_TYPE_* constant. */
100957940406SAndy Zhou 	OVS_BAND_ATTR_RATE,	/* u32 band rate in meter units (see above). */
101057940406SAndy Zhou 	OVS_BAND_ATTR_BURST,	/* u32 burst size in meter units. */
101157940406SAndy Zhou 	OVS_BAND_ATTR_STATS,	/* struct ovs_flow_stats for the band. */
101257940406SAndy Zhou 	__OVS_BAND_ATTR_MAX
101357940406SAndy Zhou };
101457940406SAndy Zhou 
101557940406SAndy Zhou #define OVS_BAND_ATTR_MAX (__OVS_BAND_ATTR_MAX - 1)
101657940406SAndy Zhou 
101757940406SAndy Zhou enum ovs_meter_band_type {
101857940406SAndy Zhou 	OVS_METER_BAND_TYPE_UNSPEC,
101957940406SAndy Zhou 	OVS_METER_BAND_TYPE_DROP,   /* Drop exceeding packets. */
102057940406SAndy Zhou 	__OVS_METER_BAND_TYPE_MAX
102157940406SAndy Zhou };
102257940406SAndy Zhou 
102357940406SAndy Zhou #define OVS_METER_BAND_TYPE_MAX (__OVS_METER_BAND_TYPE_MAX - 1)
102457940406SAndy Zhou 
10255972be6bSYi-Hung Wei /* Conntrack limit */
10265972be6bSYi-Hung Wei #define OVS_CT_LIMIT_FAMILY  "ovs_ct_limit"
10275972be6bSYi-Hung Wei #define OVS_CT_LIMIT_MCGROUP "ovs_ct_limit"
10285972be6bSYi-Hung Wei #define OVS_CT_LIMIT_VERSION 0x1
10295972be6bSYi-Hung Wei 
10305972be6bSYi-Hung Wei enum ovs_ct_limit_cmd {
10315972be6bSYi-Hung Wei 	OVS_CT_LIMIT_CMD_UNSPEC,
10325972be6bSYi-Hung Wei 	OVS_CT_LIMIT_CMD_SET,		/* Add or modify ct limit. */
10335972be6bSYi-Hung Wei 	OVS_CT_LIMIT_CMD_DEL,		/* Delete ct limit. */
10345972be6bSYi-Hung Wei 	OVS_CT_LIMIT_CMD_GET		/* Get ct limit. */
10355972be6bSYi-Hung Wei };
10365972be6bSYi-Hung Wei 
10375972be6bSYi-Hung Wei enum ovs_ct_limit_attr {
10385972be6bSYi-Hung Wei 	OVS_CT_LIMIT_ATTR_UNSPEC,
10395972be6bSYi-Hung Wei 	OVS_CT_LIMIT_ATTR_ZONE_LIMIT,	/* Nested struct ovs_zone_limit. */
10405972be6bSYi-Hung Wei 	__OVS_CT_LIMIT_ATTR_MAX
10415972be6bSYi-Hung Wei };
10425972be6bSYi-Hung Wei 
10435972be6bSYi-Hung Wei #define OVS_CT_LIMIT_ATTR_MAX (__OVS_CT_LIMIT_ATTR_MAX - 1)
10445972be6bSYi-Hung Wei 
10455972be6bSYi-Hung Wei #define OVS_ZONE_LIMIT_DEFAULT_ZONE -1
10465972be6bSYi-Hung Wei 
10475972be6bSYi-Hung Wei struct ovs_zone_limit {
10485972be6bSYi-Hung Wei 	int zone_id;
10495972be6bSYi-Hung Wei 	__u32 limit;
10505972be6bSYi-Hung Wei 	__u32 count;
10515972be6bSYi-Hung Wei };
10525972be6bSYi-Hung Wei 
105322e3880aSThomas Graf #endif /* _LINUX_OPENVSWITCH_H */
1054