xref: /linux/include/uapi/linux/openvswitch.h (revision f5796684069e0c71c65bce6a6d4766114aec1396)
122e3880aSThomas Graf 
222e3880aSThomas Graf /*
303f0d916SAndy Zhou  * Copyright (c) 2007-2013 Nicira, Inc.
422e3880aSThomas Graf  *
522e3880aSThomas Graf  * This program is free software; you can redistribute it and/or
622e3880aSThomas Graf  * modify it under the terms of version 2 of the GNU General Public
722e3880aSThomas Graf  * License as published by the Free Software Foundation.
822e3880aSThomas Graf  *
922e3880aSThomas Graf  * This program is distributed in the hope that it will be useful, but
1022e3880aSThomas Graf  * WITHOUT ANY WARRANTY; without even the implied warranty of
1122e3880aSThomas Graf  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1222e3880aSThomas Graf  * General Public License for more details.
1322e3880aSThomas Graf  *
1422e3880aSThomas Graf  * You should have received a copy of the GNU General Public License
1522e3880aSThomas Graf  * along with this program; if not, write to the Free Software
1622e3880aSThomas Graf  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
1722e3880aSThomas Graf  * 02110-1301, USA
1822e3880aSThomas Graf  */
1922e3880aSThomas Graf 
2022e3880aSThomas Graf #ifndef _UAPI__LINUX_OPENVSWITCH_H
2122e3880aSThomas Graf #define _UAPI__LINUX_OPENVSWITCH_H 1
2222e3880aSThomas Graf 
2322e3880aSThomas Graf #include <linux/types.h>
2422e3880aSThomas Graf #include <linux/if_ether.h>
2522e3880aSThomas Graf 
2622e3880aSThomas Graf /**
2722e3880aSThomas Graf  * struct ovs_header - header for OVS Generic Netlink messages.
2822e3880aSThomas Graf  * @dp_ifindex: ifindex of local port for datapath (0 to make a request not
2922e3880aSThomas Graf  * specific to a datapath).
3022e3880aSThomas Graf  *
3122e3880aSThomas Graf  * Attributes following the header are specific to a particular OVS Generic
3222e3880aSThomas Graf  * Netlink family, but all of the OVS families use this header.
3322e3880aSThomas Graf  */
3422e3880aSThomas Graf 
3522e3880aSThomas Graf struct ovs_header {
3622e3880aSThomas Graf 	int dp_ifindex;
3722e3880aSThomas Graf };
3822e3880aSThomas Graf 
3922e3880aSThomas Graf /* Datapaths. */
4022e3880aSThomas Graf 
4122e3880aSThomas Graf #define OVS_DATAPATH_FAMILY  "ovs_datapath"
4222e3880aSThomas Graf #define OVS_DATAPATH_MCGROUP "ovs_datapath"
4344da5ae5SThomas Graf 
4444da5ae5SThomas Graf /* V2:
4544da5ae5SThomas Graf  *   - API users are expected to provide OVS_DP_ATTR_USER_FEATURES
4644da5ae5SThomas Graf  *     when creating the datapath.
4744da5ae5SThomas Graf  */
4844da5ae5SThomas Graf #define OVS_DATAPATH_VERSION 2
4944da5ae5SThomas Graf 
5044da5ae5SThomas Graf /* First OVS datapath version to support features */
5144da5ae5SThomas Graf #define OVS_DP_VER_FEATURES 2
5222e3880aSThomas Graf 
5322e3880aSThomas Graf enum ovs_datapath_cmd {
5422e3880aSThomas Graf 	OVS_DP_CMD_UNSPEC,
5522e3880aSThomas Graf 	OVS_DP_CMD_NEW,
5622e3880aSThomas Graf 	OVS_DP_CMD_DEL,
5722e3880aSThomas Graf 	OVS_DP_CMD_GET,
5822e3880aSThomas Graf 	OVS_DP_CMD_SET
5922e3880aSThomas Graf };
6022e3880aSThomas Graf 
6122e3880aSThomas Graf /**
6222e3880aSThomas Graf  * enum ovs_datapath_attr - attributes for %OVS_DP_* commands.
6322e3880aSThomas Graf  * @OVS_DP_ATTR_NAME: Name of the network device that serves as the "local
6422e3880aSThomas Graf  * port".  This is the name of the network device whose dp_ifindex is given in
6522e3880aSThomas Graf  * the &struct ovs_header.  Always present in notifications.  Required in
6622e3880aSThomas Graf  * %OVS_DP_NEW requests.  May be used as an alternative to specifying
6722e3880aSThomas Graf  * dp_ifindex in other requests (with a dp_ifindex of 0).
6822e3880aSThomas Graf  * @OVS_DP_ATTR_UPCALL_PID: The Netlink socket in userspace that is initially
6922e3880aSThomas Graf  * set on the datapath port (for OVS_ACTION_ATTR_MISS).  Only valid on
7022e3880aSThomas Graf  * %OVS_DP_CMD_NEW requests. A value of zero indicates that upcalls should
7122e3880aSThomas Graf  * not be sent.
7222e3880aSThomas Graf  * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the
7322e3880aSThomas Graf  * datapath.  Always present in notifications.
741bd7116fSAndy Zhou  * @OVS_DP_ATTR_MEGAFLOW_STATS: Statistics about mega flow masks usage for the
751bd7116fSAndy Zhou  * datapath. Always present in notifications.
7622e3880aSThomas Graf  *
7722e3880aSThomas Graf  * These attributes follow the &struct ovs_header within the Generic Netlink
7822e3880aSThomas Graf  * payload for %OVS_DP_* commands.
7922e3880aSThomas Graf  */
8022e3880aSThomas Graf enum ovs_datapath_attr {
8122e3880aSThomas Graf 	OVS_DP_ATTR_UNSPEC,
8222e3880aSThomas Graf 	OVS_DP_ATTR_NAME,		/* name of dp_ifindex netdev */
8322e3880aSThomas Graf 	OVS_DP_ATTR_UPCALL_PID,		/* Netlink PID to receive upcalls */
8422e3880aSThomas Graf 	OVS_DP_ATTR_STATS,		/* struct ovs_dp_stats */
851bd7116fSAndy Zhou 	OVS_DP_ATTR_MEGAFLOW_STATS,	/* struct ovs_dp_megaflow_stats */
8643d4be9cSThomas Graf 	OVS_DP_ATTR_USER_FEATURES,	/* OVS_DP_F_*  */
8722e3880aSThomas Graf 	__OVS_DP_ATTR_MAX
8822e3880aSThomas Graf };
8922e3880aSThomas Graf 
9022e3880aSThomas Graf #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
9122e3880aSThomas Graf 
9222e3880aSThomas Graf struct ovs_dp_stats {
9322e3880aSThomas Graf 	__u64 n_hit;             /* Number of flow table matches. */
9422e3880aSThomas Graf 	__u64 n_missed;          /* Number of flow table misses. */
9522e3880aSThomas Graf 	__u64 n_lost;            /* Number of misses not sent to userspace. */
9622e3880aSThomas Graf 	__u64 n_flows;           /* Number of flows present */
9722e3880aSThomas Graf };
9822e3880aSThomas Graf 
991bd7116fSAndy Zhou struct ovs_dp_megaflow_stats {
1001bd7116fSAndy Zhou 	__u64 n_mask_hit;	 /* Number of masks used for flow lookups. */
1011bd7116fSAndy Zhou 	__u32 n_masks;		 /* Number of masks for the datapath. */
1021bd7116fSAndy Zhou 	__u32 pad0;		 /* Pad for future expension. */
1031bd7116fSAndy Zhou 	__u64 pad1;		 /* Pad for future expension. */
1041bd7116fSAndy Zhou 	__u64 pad2;		 /* Pad for future expension. */
1051bd7116fSAndy Zhou };
1061bd7116fSAndy Zhou 
10722e3880aSThomas Graf struct ovs_vport_stats {
10822e3880aSThomas Graf 	__u64   rx_packets;		/* total packets received       */
10922e3880aSThomas Graf 	__u64   tx_packets;		/* total packets transmitted    */
11022e3880aSThomas Graf 	__u64   rx_bytes;		/* total bytes received         */
11122e3880aSThomas Graf 	__u64   tx_bytes;		/* total bytes transmitted      */
11222e3880aSThomas Graf 	__u64   rx_errors;		/* bad packets received         */
11322e3880aSThomas Graf 	__u64   tx_errors;		/* packet transmit problems     */
11422e3880aSThomas Graf 	__u64   rx_dropped;		/* no space in linux buffers    */
11522e3880aSThomas Graf 	__u64   tx_dropped;		/* no space available in linux  */
11622e3880aSThomas Graf };
11722e3880aSThomas Graf 
11843d4be9cSThomas Graf /* Allow last Netlink attribute to be unaligned */
11943d4be9cSThomas Graf #define OVS_DP_F_UNALIGNED	(1 << 0)
12043d4be9cSThomas Graf 
1215cd667b0SAlex Wang /* Allow datapath to associate multiple Netlink PIDs to each vport */
1225cd667b0SAlex Wang #define OVS_DP_F_VPORT_PIDS	(1 << 1)
1235cd667b0SAlex Wang 
12422e3880aSThomas Graf /* Fixed logical ports. */
12522e3880aSThomas Graf #define OVSP_LOCAL      ((__u32)0)
12622e3880aSThomas Graf 
12722e3880aSThomas Graf /* Packet transfer. */
12822e3880aSThomas Graf 
12922e3880aSThomas Graf #define OVS_PACKET_FAMILY "ovs_packet"
13022e3880aSThomas Graf #define OVS_PACKET_VERSION 0x1
13122e3880aSThomas Graf 
13222e3880aSThomas Graf enum ovs_packet_cmd {
13322e3880aSThomas Graf 	OVS_PACKET_CMD_UNSPEC,
13422e3880aSThomas Graf 
13522e3880aSThomas Graf 	/* Kernel-to-user notifications. */
13622e3880aSThomas Graf 	OVS_PACKET_CMD_MISS,    /* Flow table miss. */
13722e3880aSThomas Graf 	OVS_PACKET_CMD_ACTION,  /* OVS_ACTION_ATTR_USERSPACE action. */
13822e3880aSThomas Graf 
13922e3880aSThomas Graf 	/* Userspace commands. */
14022e3880aSThomas Graf 	OVS_PACKET_CMD_EXECUTE  /* Apply actions to a packet. */
14122e3880aSThomas Graf };
14222e3880aSThomas Graf 
14322e3880aSThomas Graf /**
14422e3880aSThomas Graf  * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
14522e3880aSThomas Graf  * @OVS_PACKET_ATTR_PACKET: Present for all notifications.  Contains the entire
14622e3880aSThomas Graf  * packet as received, from the start of the Ethernet header onward.  For
14722e3880aSThomas Graf  * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
14822e3880aSThomas Graf  * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
14922e3880aSThomas Graf  * the flow key extracted from the packet as originally received.
15022e3880aSThomas Graf  * @OVS_PACKET_ATTR_KEY: Present for all notifications.  Contains the flow key
15122e3880aSThomas Graf  * extracted from the packet as nested %OVS_KEY_ATTR_* attributes.  This allows
15222e3880aSThomas Graf  * userspace to adapt its flow setup strategy by comparing its notion of the
15322e3880aSThomas Graf  * flow key against the kernel's.
15422e3880aSThomas Graf  * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet.  Used
15522e3880aSThomas Graf  * for %OVS_PACKET_CMD_EXECUTE.  It has nested %OVS_ACTION_ATTR_* attributes.
15622e3880aSThomas Graf  * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
15722e3880aSThomas Graf  * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
15822e3880aSThomas Graf  * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content
15922e3880aSThomas Graf  * specified there.
16022e3880aSThomas Graf  *
16122e3880aSThomas Graf  * These attributes follow the &struct ovs_header within the Generic Netlink
16222e3880aSThomas Graf  * payload for %OVS_PACKET_* commands.
16322e3880aSThomas Graf  */
16422e3880aSThomas Graf enum ovs_packet_attr {
16522e3880aSThomas Graf 	OVS_PACKET_ATTR_UNSPEC,
16622e3880aSThomas Graf 	OVS_PACKET_ATTR_PACKET,      /* Packet data. */
16722e3880aSThomas Graf 	OVS_PACKET_ATTR_KEY,         /* Nested OVS_KEY_ATTR_* attributes. */
16822e3880aSThomas Graf 	OVS_PACKET_ATTR_ACTIONS,     /* Nested OVS_ACTION_ATTR_* attributes. */
16922e3880aSThomas Graf 	OVS_PACKET_ATTR_USERDATA,    /* OVS_ACTION_ATTR_USERSPACE arg. */
17022e3880aSThomas Graf 	__OVS_PACKET_ATTR_MAX
17122e3880aSThomas Graf };
17222e3880aSThomas Graf 
17322e3880aSThomas Graf #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
17422e3880aSThomas Graf 
17522e3880aSThomas Graf /* Virtual ports. */
17622e3880aSThomas Graf 
17722e3880aSThomas Graf #define OVS_VPORT_FAMILY  "ovs_vport"
17822e3880aSThomas Graf #define OVS_VPORT_MCGROUP "ovs_vport"
17922e3880aSThomas Graf #define OVS_VPORT_VERSION 0x1
18022e3880aSThomas Graf 
18122e3880aSThomas Graf enum ovs_vport_cmd {
18222e3880aSThomas Graf 	OVS_VPORT_CMD_UNSPEC,
18322e3880aSThomas Graf 	OVS_VPORT_CMD_NEW,
18422e3880aSThomas Graf 	OVS_VPORT_CMD_DEL,
18522e3880aSThomas Graf 	OVS_VPORT_CMD_GET,
18622e3880aSThomas Graf 	OVS_VPORT_CMD_SET
18722e3880aSThomas Graf };
18822e3880aSThomas Graf 
18922e3880aSThomas Graf enum ovs_vport_type {
19022e3880aSThomas Graf 	OVS_VPORT_TYPE_UNSPEC,
19122e3880aSThomas Graf 	OVS_VPORT_TYPE_NETDEV,   /* network device */
19222e3880aSThomas Graf 	OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
193aa310701SPravin B Shelar 	OVS_VPORT_TYPE_GRE,      /* GRE tunnel. */
19458264848SPravin B Shelar 	OVS_VPORT_TYPE_VXLAN,	 /* VXLAN tunnel. */
195*f5796684SJesse Gross 	OVS_VPORT_TYPE_GENEVE,	 /* Geneve tunnel. */
19622e3880aSThomas Graf 	__OVS_VPORT_TYPE_MAX
19722e3880aSThomas Graf };
19822e3880aSThomas Graf 
19922e3880aSThomas Graf #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
20022e3880aSThomas Graf 
20122e3880aSThomas Graf /**
20222e3880aSThomas Graf  * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
20322e3880aSThomas Graf  * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
20422e3880aSThomas Graf  * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
20522e3880aSThomas Graf  * of vport.
20622e3880aSThomas Graf  * @OVS_VPORT_ATTR_NAME: Name of vport.  For a vport based on a network device
20722e3880aSThomas Graf  * this is the name of the network device.  Maximum length %IFNAMSIZ-1 bytes
20822e3880aSThomas Graf  * plus a null terminator.
20922e3880aSThomas Graf  * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information.
2105cd667b0SAlex Wang  * @OVS_VPORT_ATTR_UPCALL_PID: The array of Netlink socket pids in userspace
2115cd667b0SAlex Wang  * among which OVS_PACKET_CMD_MISS upcalls will be distributed for packets
2125cd667b0SAlex Wang  * received on this port.  If this is a single-element array of value 0,
2135cd667b0SAlex Wang  * upcalls should not be sent.
21422e3880aSThomas Graf  * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
21522e3880aSThomas Graf  * packets sent or received through the vport.
21622e3880aSThomas Graf  *
21722e3880aSThomas Graf  * These attributes follow the &struct ovs_header within the Generic Netlink
21822e3880aSThomas Graf  * payload for %OVS_VPORT_* commands.
21922e3880aSThomas Graf  *
22022e3880aSThomas Graf  * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
22122e3880aSThomas Graf  * %OVS_VPORT_ATTR_NAME attributes are required.  %OVS_VPORT_ATTR_PORT_NO is
22222e3880aSThomas Graf  * optional; if not specified a free port number is automatically selected.
22322e3880aSThomas Graf  * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
22422e3880aSThomas Graf  * of vport.
22522e3880aSThomas Graf  *
22622e3880aSThomas Graf  * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
22722e3880aSThomas Graf  * look up the vport to operate on; otherwise dp_idx from the &struct
22822e3880aSThomas Graf  * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
22922e3880aSThomas Graf  */
23022e3880aSThomas Graf enum ovs_vport_attr {
23122e3880aSThomas Graf 	OVS_VPORT_ATTR_UNSPEC,
23222e3880aSThomas Graf 	OVS_VPORT_ATTR_PORT_NO,	/* u32 port number within datapath */
23322e3880aSThomas Graf 	OVS_VPORT_ATTR_TYPE,	/* u32 OVS_VPORT_TYPE_* constant. */
23422e3880aSThomas Graf 	OVS_VPORT_ATTR_NAME,	/* string name, up to IFNAMSIZ bytes long */
23522e3880aSThomas Graf 	OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
2365cd667b0SAlex Wang 	OVS_VPORT_ATTR_UPCALL_PID, /* array of u32 Netlink socket PIDs for */
2375cd667b0SAlex Wang 				/* receiving upcalls */
23822e3880aSThomas Graf 	OVS_VPORT_ATTR_STATS,	/* struct ovs_vport_stats */
23922e3880aSThomas Graf 	__OVS_VPORT_ATTR_MAX
24022e3880aSThomas Graf };
24122e3880aSThomas Graf 
24222e3880aSThomas Graf #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
24322e3880aSThomas Graf 
24458264848SPravin B Shelar /* OVS_VPORT_ATTR_OPTIONS attributes for tunnels.
24558264848SPravin B Shelar  */
24658264848SPravin B Shelar enum {
24758264848SPravin B Shelar 	OVS_TUNNEL_ATTR_UNSPEC,
24858264848SPravin B Shelar 	OVS_TUNNEL_ATTR_DST_PORT, /* 16-bit UDP port, used by L4 tunnels. */
24958264848SPravin B Shelar 	__OVS_TUNNEL_ATTR_MAX
25058264848SPravin B Shelar };
25158264848SPravin B Shelar 
25258264848SPravin B Shelar #define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1)
25358264848SPravin B Shelar 
25422e3880aSThomas Graf /* Flows. */
25522e3880aSThomas Graf 
25622e3880aSThomas Graf #define OVS_FLOW_FAMILY  "ovs_flow"
25722e3880aSThomas Graf #define OVS_FLOW_MCGROUP "ovs_flow"
25822e3880aSThomas Graf #define OVS_FLOW_VERSION 0x1
25922e3880aSThomas Graf 
26022e3880aSThomas Graf enum ovs_flow_cmd {
26122e3880aSThomas Graf 	OVS_FLOW_CMD_UNSPEC,
26222e3880aSThomas Graf 	OVS_FLOW_CMD_NEW,
26322e3880aSThomas Graf 	OVS_FLOW_CMD_DEL,
26422e3880aSThomas Graf 	OVS_FLOW_CMD_GET,
26522e3880aSThomas Graf 	OVS_FLOW_CMD_SET
26622e3880aSThomas Graf };
26722e3880aSThomas Graf 
26822e3880aSThomas Graf struct ovs_flow_stats {
26922e3880aSThomas Graf 	__u64 n_packets;         /* Number of matched packets. */
27022e3880aSThomas Graf 	__u64 n_bytes;           /* Number of matched bytes. */
27122e3880aSThomas Graf };
27222e3880aSThomas Graf 
27322e3880aSThomas Graf enum ovs_key_attr {
27422e3880aSThomas Graf 	OVS_KEY_ATTR_UNSPEC,
27522e3880aSThomas Graf 	OVS_KEY_ATTR_ENCAP,	/* Nested set of encapsulated attributes. */
27622e3880aSThomas Graf 	OVS_KEY_ATTR_PRIORITY,  /* u32 skb->priority */
27722e3880aSThomas Graf 	OVS_KEY_ATTR_IN_PORT,   /* u32 OVS dp port number */
27822e3880aSThomas Graf 	OVS_KEY_ATTR_ETHERNET,  /* struct ovs_key_ethernet */
27922e3880aSThomas Graf 	OVS_KEY_ATTR_VLAN,	/* be16 VLAN TCI */
28022e3880aSThomas Graf 	OVS_KEY_ATTR_ETHERTYPE,	/* be16 Ethernet type */
28122e3880aSThomas Graf 	OVS_KEY_ATTR_IPV4,      /* struct ovs_key_ipv4 */
28222e3880aSThomas Graf 	OVS_KEY_ATTR_IPV6,      /* struct ovs_key_ipv6 */
28322e3880aSThomas Graf 	OVS_KEY_ATTR_TCP,       /* struct ovs_key_tcp */
28422e3880aSThomas Graf 	OVS_KEY_ATTR_UDP,       /* struct ovs_key_udp */
28522e3880aSThomas Graf 	OVS_KEY_ATTR_ICMP,      /* struct ovs_key_icmp */
28622e3880aSThomas Graf 	OVS_KEY_ATTR_ICMPV6,    /* struct ovs_key_icmpv6 */
28722e3880aSThomas Graf 	OVS_KEY_ATTR_ARP,       /* struct ovs_key_arp */
28822e3880aSThomas Graf 	OVS_KEY_ATTR_ND,        /* struct ovs_key_nd */
28922e3880aSThomas Graf 	OVS_KEY_ATTR_SKB_MARK,  /* u32 skb mark */
2907d5437c7SPravin B Shelar 	OVS_KEY_ATTR_TUNNEL,    /* Nested set of ovs_tunnel attributes */
291a175a723SJoe Stringer 	OVS_KEY_ATTR_SCTP,      /* struct ovs_key_sctp */
2925eb26b15SJarno Rajahalme 	OVS_KEY_ATTR_TCP_FLAGS,	/* be16 TCP flags. */
293971427f3SAndy Zhou 	OVS_KEY_ATTR_DP_HASH,      /* u32 hash value. Value 0 indicates the hash
294971427f3SAndy Zhou 				   is not computed by the datapath. */
295971427f3SAndy Zhou 	OVS_KEY_ATTR_RECIRC_ID, /* u32 recirc id */
2967d5437c7SPravin B Shelar 
2977d5437c7SPravin B Shelar #ifdef __KERNEL__
298f0b128c1SJesse Gross 	OVS_KEY_ATTR_TUNNEL_INFO,  /* struct ovs_tunnel_info */
2997d5437c7SPravin B Shelar #endif
30022e3880aSThomas Graf 	__OVS_KEY_ATTR_MAX
30122e3880aSThomas Graf };
30222e3880aSThomas Graf 
30322e3880aSThomas Graf #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
30422e3880aSThomas Graf 
3057d5437c7SPravin B Shelar enum ovs_tunnel_key_attr {
3067d5437c7SPravin B Shelar 	OVS_TUNNEL_KEY_ATTR_ID,                 /* be64 Tunnel ID */
3077d5437c7SPravin B Shelar 	OVS_TUNNEL_KEY_ATTR_IPV4_SRC,           /* be32 src IP address. */
3087d5437c7SPravin B Shelar 	OVS_TUNNEL_KEY_ATTR_IPV4_DST,           /* be32 dst IP address. */
3097d5437c7SPravin B Shelar 	OVS_TUNNEL_KEY_ATTR_TOS,                /* u8 Tunnel IP ToS. */
3107d5437c7SPravin B Shelar 	OVS_TUNNEL_KEY_ATTR_TTL,                /* u8 Tunnel IP TTL. */
3117d5437c7SPravin B Shelar 	OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT,      /* No argument, set DF. */
3127d5437c7SPravin B Shelar 	OVS_TUNNEL_KEY_ATTR_CSUM,               /* No argument. CSUM packet. */
31367fa0341SJesse Gross 	OVS_TUNNEL_KEY_ATTR_OAM,                /* No argument. OAM frame.  */
314*f5796684SJesse Gross 	OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS,        /* Array of Geneve options. */
3157d5437c7SPravin B Shelar 	__OVS_TUNNEL_KEY_ATTR_MAX
3167d5437c7SPravin B Shelar };
3177d5437c7SPravin B Shelar 
3187d5437c7SPravin B Shelar #define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1)
3197d5437c7SPravin B Shelar 
32022e3880aSThomas Graf /**
32122e3880aSThomas Graf  * enum ovs_frag_type - IPv4 and IPv6 fragment type
32222e3880aSThomas Graf  * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
32322e3880aSThomas Graf  * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
32422e3880aSThomas Graf  * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
32522e3880aSThomas Graf  *
32622e3880aSThomas Graf  * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
32722e3880aSThomas Graf  * ovs_key_ipv6.
32822e3880aSThomas Graf  */
32922e3880aSThomas Graf enum ovs_frag_type {
33022e3880aSThomas Graf 	OVS_FRAG_TYPE_NONE,
33122e3880aSThomas Graf 	OVS_FRAG_TYPE_FIRST,
33222e3880aSThomas Graf 	OVS_FRAG_TYPE_LATER,
33322e3880aSThomas Graf 	__OVS_FRAG_TYPE_MAX
33422e3880aSThomas Graf };
33522e3880aSThomas Graf 
33622e3880aSThomas Graf #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
33722e3880aSThomas Graf 
33822e3880aSThomas Graf struct ovs_key_ethernet {
33922e3880aSThomas Graf 	__u8	 eth_src[ETH_ALEN];
34022e3880aSThomas Graf 	__u8	 eth_dst[ETH_ALEN];
34122e3880aSThomas Graf };
34222e3880aSThomas Graf 
34322e3880aSThomas Graf struct ovs_key_ipv4 {
34422e3880aSThomas Graf 	__be32 ipv4_src;
34522e3880aSThomas Graf 	__be32 ipv4_dst;
34622e3880aSThomas Graf 	__u8   ipv4_proto;
34722e3880aSThomas Graf 	__u8   ipv4_tos;
34822e3880aSThomas Graf 	__u8   ipv4_ttl;
34922e3880aSThomas Graf 	__u8   ipv4_frag;	/* One of OVS_FRAG_TYPE_*. */
35022e3880aSThomas Graf };
35122e3880aSThomas Graf 
35222e3880aSThomas Graf struct ovs_key_ipv6 {
35322e3880aSThomas Graf 	__be32 ipv6_src[4];
35422e3880aSThomas Graf 	__be32 ipv6_dst[4];
35522e3880aSThomas Graf 	__be32 ipv6_label;	/* 20-bits in least-significant bits. */
35622e3880aSThomas Graf 	__u8   ipv6_proto;
35722e3880aSThomas Graf 	__u8   ipv6_tclass;
35822e3880aSThomas Graf 	__u8   ipv6_hlimit;
35922e3880aSThomas Graf 	__u8   ipv6_frag;	/* One of OVS_FRAG_TYPE_*. */
36022e3880aSThomas Graf };
36122e3880aSThomas Graf 
36222e3880aSThomas Graf struct ovs_key_tcp {
36322e3880aSThomas Graf 	__be16 tcp_src;
36422e3880aSThomas Graf 	__be16 tcp_dst;
36522e3880aSThomas Graf };
36622e3880aSThomas Graf 
36722e3880aSThomas Graf struct ovs_key_udp {
36822e3880aSThomas Graf 	__be16 udp_src;
36922e3880aSThomas Graf 	__be16 udp_dst;
37022e3880aSThomas Graf };
37122e3880aSThomas Graf 
372a175a723SJoe Stringer struct ovs_key_sctp {
373a175a723SJoe Stringer 	__be16 sctp_src;
374a175a723SJoe Stringer 	__be16 sctp_dst;
375a175a723SJoe Stringer };
376a175a723SJoe Stringer 
37722e3880aSThomas Graf struct ovs_key_icmp {
37822e3880aSThomas Graf 	__u8 icmp_type;
37922e3880aSThomas Graf 	__u8 icmp_code;
38022e3880aSThomas Graf };
38122e3880aSThomas Graf 
38222e3880aSThomas Graf struct ovs_key_icmpv6 {
38322e3880aSThomas Graf 	__u8 icmpv6_type;
38422e3880aSThomas Graf 	__u8 icmpv6_code;
38522e3880aSThomas Graf };
38622e3880aSThomas Graf 
38722e3880aSThomas Graf struct ovs_key_arp {
38822e3880aSThomas Graf 	__be32 arp_sip;
38922e3880aSThomas Graf 	__be32 arp_tip;
39022e3880aSThomas Graf 	__be16 arp_op;
39122e3880aSThomas Graf 	__u8   arp_sha[ETH_ALEN];
39222e3880aSThomas Graf 	__u8   arp_tha[ETH_ALEN];
39322e3880aSThomas Graf };
39422e3880aSThomas Graf 
39522e3880aSThomas Graf struct ovs_key_nd {
39622e3880aSThomas Graf 	__u32 nd_target[4];
39722e3880aSThomas Graf 	__u8  nd_sll[ETH_ALEN];
39822e3880aSThomas Graf 	__u8  nd_tll[ETH_ALEN];
39922e3880aSThomas Graf };
40022e3880aSThomas Graf 
40122e3880aSThomas Graf /**
40222e3880aSThomas Graf  * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
40322e3880aSThomas Graf  * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
40422e3880aSThomas Graf  * key.  Always present in notifications.  Required for all requests (except
40522e3880aSThomas Graf  * dumps).
40622e3880aSThomas Graf  * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
40722e3880aSThomas Graf  * the actions to take for packets that match the key.  Always present in
40822e3880aSThomas Graf  * notifications.  Required for %OVS_FLOW_CMD_NEW requests, optional for
409be52c9e9SJarno Rajahalme  * %OVS_FLOW_CMD_SET requests.  An %OVS_FLOW_CMD_SET without
410be52c9e9SJarno Rajahalme  * %OVS_FLOW_ATTR_ACTIONS will not modify the actions.  To clear the actions,
411be52c9e9SJarno Rajahalme  * an %OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given.
41222e3880aSThomas Graf  * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
41322e3880aSThomas Graf  * flow.  Present in notifications if the stats would be nonzero.  Ignored in
41422e3880aSThomas Graf  * requests.
41522e3880aSThomas Graf  * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
41622e3880aSThomas Graf  * TCP flags seen on packets in this flow.  Only present in notifications for
41722e3880aSThomas Graf  * TCP flows, and only if it would be nonzero.  Ignored in requests.
41822e3880aSThomas Graf  * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
41922e3880aSThomas Graf  * the system monotonic clock, at which a packet was last processed for this
42022e3880aSThomas Graf  * flow.  Only present in notifications if a packet has been processed for this
42122e3880aSThomas Graf  * flow.  Ignored in requests.
42222e3880aSThomas Graf  * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
42322e3880aSThomas Graf  * last-used time, accumulated TCP flags, and statistics for this flow.
42422e3880aSThomas Graf  * Otherwise ignored in requests.  Never present in notifications.
42503f0d916SAndy Zhou  * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the
42603f0d916SAndy Zhou  * mask bits for wildcarded flow match. Mask bit value '1' specifies exact
42703f0d916SAndy Zhou  * match with corresponding flow key bit, while mask bit value '0' specifies
42803f0d916SAndy Zhou  * a wildcarded match. Omitting attribute is treated as wildcarding all
42903f0d916SAndy Zhou  * corresponding fields. Optional for all requests. If not present,
43003f0d916SAndy Zhou  * all flow key bits are exact match bits.
43122e3880aSThomas Graf  *
43222e3880aSThomas Graf  * These attributes follow the &struct ovs_header within the Generic Netlink
43322e3880aSThomas Graf  * payload for %OVS_FLOW_* commands.
43422e3880aSThomas Graf  */
43522e3880aSThomas Graf enum ovs_flow_attr {
43622e3880aSThomas Graf 	OVS_FLOW_ATTR_UNSPEC,
43722e3880aSThomas Graf 	OVS_FLOW_ATTR_KEY,       /* Sequence of OVS_KEY_ATTR_* attributes. */
43822e3880aSThomas Graf 	OVS_FLOW_ATTR_ACTIONS,   /* Nested OVS_ACTION_ATTR_* attributes. */
43922e3880aSThomas Graf 	OVS_FLOW_ATTR_STATS,     /* struct ovs_flow_stats. */
44022e3880aSThomas Graf 	OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
44122e3880aSThomas Graf 	OVS_FLOW_ATTR_USED,      /* u64 msecs last used in monotonic time. */
44222e3880aSThomas Graf 	OVS_FLOW_ATTR_CLEAR,     /* Flag to clear stats, tcp_flags, used. */
44303f0d916SAndy Zhou 	OVS_FLOW_ATTR_MASK,      /* Sequence of OVS_KEY_ATTR_* attributes. */
44422e3880aSThomas Graf 	__OVS_FLOW_ATTR_MAX
44522e3880aSThomas Graf };
44622e3880aSThomas Graf 
44722e3880aSThomas Graf #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
44822e3880aSThomas Graf 
44922e3880aSThomas Graf /**
45022e3880aSThomas Graf  * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
45122e3880aSThomas Graf  * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
45222e3880aSThomas Graf  * @OVS_ACTION_ATTR_SAMPLE.  A value of 0 samples no packets, a value of
45322e3880aSThomas Graf  * %UINT32_MAX samples all packets and intermediate values sample intermediate
45422e3880aSThomas Graf  * fractions of packets.
45522e3880aSThomas Graf  * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
45622e3880aSThomas Graf  * Actions are passed as nested attributes.
45722e3880aSThomas Graf  *
45822e3880aSThomas Graf  * Executes the specified actions with the given probability on a per-packet
45922e3880aSThomas Graf  * basis.
46022e3880aSThomas Graf  */
46122e3880aSThomas Graf enum ovs_sample_attr {
46222e3880aSThomas Graf 	OVS_SAMPLE_ATTR_UNSPEC,
46322e3880aSThomas Graf 	OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
46422e3880aSThomas Graf 	OVS_SAMPLE_ATTR_ACTIONS,     /* Nested OVS_ACTION_ATTR_* attributes. */
46522e3880aSThomas Graf 	__OVS_SAMPLE_ATTR_MAX,
46622e3880aSThomas Graf };
46722e3880aSThomas Graf 
46822e3880aSThomas Graf #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
46922e3880aSThomas Graf 
47022e3880aSThomas Graf /**
47122e3880aSThomas Graf  * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
47222e3880aSThomas Graf  * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
47322e3880aSThomas Graf  * message should be sent.  Required.
47422e3880aSThomas Graf  * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is
47522e3880aSThomas Graf  * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA.
47622e3880aSThomas Graf  */
47722e3880aSThomas Graf enum ovs_userspace_attr {
47822e3880aSThomas Graf 	OVS_USERSPACE_ATTR_UNSPEC,
47922e3880aSThomas Graf 	OVS_USERSPACE_ATTR_PID,	      /* u32 Netlink PID to receive upcalls. */
48022e3880aSThomas Graf 	OVS_USERSPACE_ATTR_USERDATA,  /* Optional user-specified cookie. */
48122e3880aSThomas Graf 	__OVS_USERSPACE_ATTR_MAX
48222e3880aSThomas Graf };
48322e3880aSThomas Graf 
48422e3880aSThomas Graf #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
48522e3880aSThomas Graf 
48622e3880aSThomas Graf /**
48722e3880aSThomas Graf  * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument.
48822e3880aSThomas Graf  * @vlan_tpid: Tag protocol identifier (TPID) to push.
48922e3880aSThomas Graf  * @vlan_tci: Tag control identifier (TCI) to push.  The CFI bit must be set
49022e3880aSThomas Graf  * (but it will not be set in the 802.1Q header that is pushed).
49122e3880aSThomas Graf  *
49222e3880aSThomas Graf  * The @vlan_tpid value is typically %ETH_P_8021Q.  The only acceptable TPID
49322e3880aSThomas Graf  * values are those that the kernel module also parses as 802.1Q headers, to
49422e3880aSThomas Graf  * prevent %OVS_ACTION_ATTR_PUSH_VLAN followed by %OVS_ACTION_ATTR_POP_VLAN
49522e3880aSThomas Graf  * from having surprising results.
49622e3880aSThomas Graf  */
49722e3880aSThomas Graf struct ovs_action_push_vlan {
49822e3880aSThomas Graf 	__be16 vlan_tpid;	/* 802.1Q TPID. */
49922e3880aSThomas Graf 	__be16 vlan_tci;	/* 802.1Q TCI (VLAN ID and priority). */
50022e3880aSThomas Graf };
50122e3880aSThomas Graf 
502971427f3SAndy Zhou /* Data path hash algorithm for computing Datapath hash.
503971427f3SAndy Zhou  *
504971427f3SAndy Zhou  * The algorithm type only specifies the fields in a flow
505971427f3SAndy Zhou  * will be used as part of the hash. Each datapath is free
506971427f3SAndy Zhou  * to use its own hash algorithm. The hash value will be
507971427f3SAndy Zhou  * opaque to the user space daemon.
508971427f3SAndy Zhou  */
509971427f3SAndy Zhou enum ovs_hash_alg {
510971427f3SAndy Zhou 	OVS_HASH_ALG_L4,
511971427f3SAndy Zhou };
512971427f3SAndy Zhou 
513971427f3SAndy Zhou /*
514971427f3SAndy Zhou  * struct ovs_action_hash - %OVS_ACTION_ATTR_HASH action argument.
515971427f3SAndy Zhou  * @hash_alg: Algorithm used to compute hash prior to recirculation.
516971427f3SAndy Zhou  * @hash_basis: basis used for computing hash.
517971427f3SAndy Zhou  */
518971427f3SAndy Zhou struct ovs_action_hash {
519971427f3SAndy Zhou 	uint32_t  hash_alg;     /* One of ovs_hash_alg. */
520971427f3SAndy Zhou 	uint32_t  hash_basis;
521971427f3SAndy Zhou };
522971427f3SAndy Zhou 
52322e3880aSThomas Graf /**
52422e3880aSThomas Graf  * enum ovs_action_attr - Action types.
52522e3880aSThomas Graf  *
52622e3880aSThomas Graf  * @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
52722e3880aSThomas Graf  * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
52822e3880aSThomas Graf  * %OVS_USERSPACE_ATTR_* attributes.
52922e3880aSThomas Graf  * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header.  The
53022e3880aSThomas Graf  * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its
53122e3880aSThomas Graf  * value.
53222e3880aSThomas Graf  * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q header onto the
53322e3880aSThomas Graf  * packet.
53422e3880aSThomas Graf  * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q header off the packet.
53522e3880aSThomas Graf  * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
53622e3880aSThomas Graf  * the nested %OVS_SAMPLE_ATTR_* attributes.
53722e3880aSThomas Graf  *
53822e3880aSThomas Graf  * Only a single header can be set with a single %OVS_ACTION_ATTR_SET.  Not all
53922e3880aSThomas Graf  * fields within a header are modifiable, e.g. the IPv4 protocol and fragment
54022e3880aSThomas Graf  * type may not be changed.
54122e3880aSThomas Graf  */
54222e3880aSThomas Graf 
54322e3880aSThomas Graf enum ovs_action_attr {
54422e3880aSThomas Graf 	OVS_ACTION_ATTR_UNSPEC,
54522e3880aSThomas Graf 	OVS_ACTION_ATTR_OUTPUT,	      /* u32 port number. */
54622e3880aSThomas Graf 	OVS_ACTION_ATTR_USERSPACE,    /* Nested OVS_USERSPACE_ATTR_*. */
54722e3880aSThomas Graf 	OVS_ACTION_ATTR_SET,          /* One nested OVS_KEY_ATTR_*. */
54822e3880aSThomas Graf 	OVS_ACTION_ATTR_PUSH_VLAN,    /* struct ovs_action_push_vlan. */
54922e3880aSThomas Graf 	OVS_ACTION_ATTR_POP_VLAN,     /* No argument. */
55022e3880aSThomas Graf 	OVS_ACTION_ATTR_SAMPLE,       /* Nested OVS_SAMPLE_ATTR_*. */
551971427f3SAndy Zhou 	OVS_ACTION_ATTR_RECIRC,       /* u32 recirc_id. */
552971427f3SAndy Zhou 	OVS_ACTION_ATTR_HASH,	      /* struct ovs_action_hash. */
55322e3880aSThomas Graf 	__OVS_ACTION_ATTR_MAX
55422e3880aSThomas Graf };
55522e3880aSThomas Graf 
55622e3880aSThomas Graf #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
55722e3880aSThomas Graf 
55822e3880aSThomas Graf #endif /* _LINUX_OPENVSWITCH_H */
559