X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=include%2Fopenvswitch%2Fdatapath-protocol.h;h=0078874ff891a93cf075fede0399d7ee4ab0f935;hb=693c4a01124ec5ad9253f8cfcfd99075a9d637f6;hp=a532d71192e103c2e6b4f9f8e3a94667121ebbc9;hpb=6d91c2fb6c169ac84ace876a4c34929cb84e26ae;p=sliver-openvswitch.git diff --git a/include/openvswitch/datapath-protocol.h b/include/openvswitch/datapath-protocol.h index a532d7119..0078874ff 100644 --- a/include/openvswitch/datapath-protocol.h +++ b/include/openvswitch/datapath-protocol.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009 Nicira Networks. + * Copyright (c) 2009, 2010, 2011 Nicira Networks. * * This file is offered under your choice of two licenses: Apache 2.0 or GNU * GPL 2.0 or later. The permission statements for each of these licenses is @@ -37,17 +37,38 @@ * ---------------------------------------------------------------------- */ -/* Protocol between secchan and datapath. */ +/* Protocol between userspace and kernel datapath. + * + * Be sure to update datapath/odp-compat.h if you change any of the structures + * in here. */ #ifndef OPENVSWITCH_DATAPATH_PROTOCOL_H #define OPENVSWITCH_DATAPATH_PROTOCOL_H 1 +/* The ovs_be types indicate that an object is in big-endian, not + * native-endian, byte order. They are otherwise equivalent to uint_t. + * The Linux kernel already has __be types for this, which take on + * additional semantics when the "sparse" static checker is used, so we use + * those types when compiling the kernel. */ #ifdef __KERNEL__ #include +#include +#define ovs_be16 __be16 +#define ovs_be32 __be32 +#define ovs_be64 __be64 #else -#include +#include "openvswitch/types.h" +#include +#endif + +#ifndef __aligned_u64 +#define __aligned_u64 __u64 __attribute__((aligned(8))) +#define __aligned_be64 __be64 __attribute__((aligned(8))) +#define __aligned_le64 __le64 __attribute__((aligned(8))) #endif -#include + +#include +#include #define ODP_MAX 256 /* Maximum number of datapaths. */ @@ -61,255 +82,258 @@ #define ODP_GET_LISTEN_MASK _IOW('O', 5, int) #define ODP_SET_LISTEN_MASK _IOR('O', 6, int) -#define ODP_PORT_ADD _IOR('O', 7, struct odp_port) -#define ODP_PORT_DEL _IOR('O', 8, int) -#define ODP_PORT_QUERY _IOWR('O', 9, struct odp_port) -#define ODP_PORT_LIST _IOWR('O', 10, struct odp_portvec) - -#define ODP_PORT_GROUP_SET _IOR('O', 11, struct odp_port_group) -#define ODP_PORT_GROUP_GET _IOWR('O', 12, struct odp_port_group) +#define ODP_VPORT_NEW _IOR('O', 7, struct odp_vport) +#define ODP_VPORT_DEL _IOR('O', 8, struct odp_vport) +#define ODP_VPORT_GET _IOWR('O', 9, struct odp_vport) +#define ODP_VPORT_SET _IOR('O', 22, struct odp_vport) +#define ODP_VPORT_DUMP _IOWR('O', 10, struct odp_vport) #define ODP_FLOW_GET _IOWR('O', 13, struct odp_flow) -#define ODP_FLOW_GET_MULTIPLE _IOWR('O', 14, struct odp_flowvec) -#define ODP_FLOW_LIST _IOWR('O', 15, struct odp_flowvec) - +#define ODP_FLOW_PUT _IOWR('O', 14, struct odp_flow) +#define ODP_FLOW_DUMP _IOWR('O', 15, struct odp_flow_dump) #define ODP_FLOW_FLUSH _IO('O', 16) -#define ODP_FLOW_PUT _IOWR('O', 17, struct odp_flow) -#define ODP_FLOW_DEL _IOWR('O', 18, struct odp_flow) +#define ODP_FLOW_DEL _IOWR('O', 17, struct odp_flow) + +#define ODP_EXECUTE _IOR('O', 18, struct odp_execute) -#define ODP_EXECUTE _IOR('O', 19, struct odp_execute) +#define ODP_SET_SFLOW_PROBABILITY _IOR('O', 19, int) +#define ODP_GET_SFLOW_PROBABILITY _IOW('O', 20, int) struct odp_stats { - /* Flows. */ - __u32 n_flows; /* Number of flows in flow table. */ - __u32 cur_capacity; /* Current flow table capacity. */ - __u32 max_capacity; /* Maximum expansion of flow table capacity. */ - - /* Ports. */ - __u32 n_ports; /* Current number of ports. */ - __u32 max_ports; /* Maximum supported number of ports. */ - __u16 max_groups; /* Maximum number of port groups. */ - __u16 reserved; - - /* Lookups. */ - __u64 n_frags; /* Number of dropped IP fragments. */ - __u64 n_hit; /* Number of flow table matches. */ - __u64 n_missed; /* Number of flow table misses. */ - __u64 n_lost; /* Number of misses not sent to userspace. */ - - /* Queues. */ - __u16 max_miss_queue; /* Max length of ODPL_MISS queue. */ - __u16 max_action_queue; /* Max length of ODPL_ACTION queue. */ + uint64_t n_frags; /* Number of dropped IP fragments. */ + uint64_t n_hit; /* Number of flow table matches. */ + uint64_t n_missed; /* Number of flow table misses. */ + uint64_t n_lost; /* Number of misses not sent to userspace. */ }; /* Logical ports. */ -#define ODPP_LOCAL ((__u16)0) -#define ODPP_NONE ((__u16)-1) +#define ODPP_LOCAL ((uint16_t)0) +#define ODPP_NONE ((uint16_t)-1) /* Listening channels. */ #define _ODPL_MISS_NR 0 /* Packet missed in flow table. */ #define ODPL_MISS (1 << _ODPL_MISS_NR) #define _ODPL_ACTION_NR 1 /* Packet output to ODPP_CONTROLLER. */ #define ODPL_ACTION (1 << _ODPL_ACTION_NR) -#define ODPL_ALL (ODPL_MISS | ODPL_ACTION) - -/* Format of messages read from datapath fd. */ -struct odp_msg { - __u32 type; /* _ODPL_MISS_NR or _ODPL_ACTION_NR. */ - __u32 length; /* Message length, including header. */ - __u16 port; /* Port on which frame was received. */ - __u16 reserved; - __u32 arg; /* Argument value specified in action. */ - /* Followed by packet data. */ +#define _ODPL_SFLOW_NR 2 /* sFlow samples. */ +#define ODPL_SFLOW (1 << _ODPL_SFLOW_NR) +#define ODPL_ALL (ODPL_MISS | ODPL_ACTION | ODPL_SFLOW) + +enum odp_packet_type { + ODP_PACKET_ATTR_UNSPEC, + ODP_PACKET_ATTR_TYPE, /* 32-bit enum, one of _ODP_*_NR. */ + ODP_PACKET_ATTR_PACKET, /* Packet data. */ + ODP_PACKET_ATTR_KEY, /* Nested ODP_KEY_ATTR_* attributes. */ + ODP_PACKET_ATTR_USERDATA, /* 64-bit data from ODPAT_CONTROLLER. */ + ODP_PACKET_ATTR_SAMPLE_POOL, /* # sampling candidate packets so far. */ + ODP_PACKET_ATTR_ACTIONS, /* Nested ODPAT_* attributes. */ + __ODP_PACKET_ATTR_MAX }; -#define ODP_PORT_INTERNAL (1 << 0) /* This port is simulated. */ -struct odp_port { - char devname[16]; /* IFNAMSIZ */ - __u16 port; - __u16 flags; - __u32 reserved2; -}; +#define ODP_PACKET_ATTR_MAX (__ODP_PACKET_ATTR_MAX - 1) -struct odp_portvec { - struct odp_port *ports; - int n_ports; +/** + * struct odp_packet - header for packets passed up between kernel and + * userspace. + * @dp_idx: Number of datapath to which the packet belongs. + * @len: Length of complete message, including this header. + * + * The header is followed by a sequence of Netlink attributes. The + * %ODP_PACKET_ATTR_TYPE, %ODP_PACKET_ATTR_PACKET, and %ODP_PACKET_ATTR_KEY + * attributes are always present. When @type == %_ODPL_ACTION_NR, the + * %ODP_PACKET_ATTR_USERDATA attribute is included if it would be nonzero. + * When @type == %_ODPL_SFLOW_NR, the %ODP_PACKET_ATTR_SAMPLE_POOL and + * %ODP_PACKET_ATTR_ACTIONS attributes are included. + * + * For @type of %_ODPL_ACTION_NR, %ODP_PACKET_ATTR_PACKET reflects changes made + * by actions preceding %ODPAT_CONTROLLER, but %ODP_PACKET_ATTR_KEY is the flow + * key extracted from the packet as originally received. + */ +struct odp_packet { + uint32_t dp_idx; + uint32_t len; }; -struct odp_port_group { - __u16 *ports; - __u16 n_ports; /* Number of ports. */ - __u16 group; /* Group number. */ +enum odp_vport_type { + ODP_VPORT_TYPE_UNSPEC, + ODP_VPORT_TYPE_NETDEV, /* network device */ + ODP_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */ + ODP_VPORT_TYPE_PATCH, /* virtual tunnel connecting two vports */ + ODP_VPORT_TYPE_GRE, /* GRE tunnel */ + ODP_VPORT_TYPE_CAPWAP, /* CAPWAP tunnel */ + __ODP_VPORT_TYPE_MAX }; -struct odp_flow_stats { - __u64 n_packets; /* Number of matched packets. */ - __u64 n_bytes; /* Number of matched bytes. */ - __u64 used_sec; /* Time last used. */ - __u32 used_nsec; - __u8 tcp_flags; - __u8 ip_tos; - __u16 reserved; +#define ODP_VPORT_TYPE_MAX (__ODP_VPORT_TYPE_MAX - 1) + +/** + * struct odp_vport - header with basic information about a virtual port. + * @dp_idx: Number of datapath to which the vport belongs. + * @len: Length of this structure plus the Netlink attributes following it. + * @total_len: Total space available for kernel reply to request. + * + * Followed by &struct nlattr attributes, whose types are drawn from + * %ODP_VPORT_ATTR_*, up to a length of @len bytes including the &struct + * odp_vport header. + */ +struct odp_vport { + uint32_t dp_idx; + uint32_t len; + uint32_t total_len; }; -struct odp_flow_key { - __be32 nw_src; /* IP source address. */ - __be32 nw_dst; /* IP destination address. */ - __u16 in_port; /* Input switch port. */ - __be16 dl_vlan; /* Input VLAN. */ - __be16 dl_type; /* Ethernet frame type. */ - __be16 tp_src; /* TCP/UDP source port. */ - __be16 tp_dst; /* TCP/UDP destination port. */ - __u8 dl_src[ETH_ALEN]; /* Ethernet source address. */ - __u8 dl_dst[ETH_ALEN]; /* Ethernet destination address. */ - __u8 nw_proto; /* IP protocol or lower 8 bits of - ARP opcode. */ - __u8 reserved; /* Pad to 64 bits. */ +enum { + ODP_VPORT_ATTR_UNSPEC, + ODP_VPORT_ATTR_PORT_NO, /* port number within datapath */ + ODP_VPORT_ATTR_TYPE, /* 32-bit ODP_VPORT_TYPE_* constant. */ + ODP_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */ + ODP_VPORT_ATTR_STATS, /* struct rtnl_link_stats64 */ + ODP_VPORT_ATTR_ADDRESS, /* hardware address */ + ODP_VPORT_ATTR_MTU, /* 32-bit maximum transmission unit */ + ODP_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */ + ODP_VPORT_ATTR_IFINDEX, /* 32-bit ifindex of backing netdev */ + ODP_VPORT_ATTR_IFLINK, /* 32-bit ifindex on which packets are sent */ + __ODP_VPORT_ATTR_MAX }; -/* Flags for ODP_FLOW. */ -#define ODPFF_ZERO_TCP_FLAGS (1 << 0) /* Zero the TCP flags. */ +#define ODP_VPORT_ATTR_MAX (__ODP_VPORT_ATTR_MAX - 1) -struct odp_flow { - struct odp_flow_stats stats; - struct odp_flow_key key; - union odp_action *actions; - __u32 n_actions; - __u32 flags; +/* ODP_VPORT_ATTR_OPTIONS attributes for patch vports. */ +enum { + ODP_PATCH_ATTR_UNSPEC, + ODP_PATCH_ATTR_PEER, /* name of peer vport, as a string */ + __ODP_PATCH_ATTR_MAX }; -/* Flags for ODP_FLOW_PUT. */ -#define ODPPF_CREATE (1 << 0) /* Allow creating a new flow. */ -#define ODPPF_MODIFY (1 << 1) /* Allow modifying an existing flow. */ -#define ODPPF_ZERO_STATS (1 << 2) /* Zero the stats of an existing flow. */ +#define ODP_PATCH_ATTR_MAX (__ODP_PATCH_ATTR_MAX - 1) -/* ODP_FLOW_PUT argument. */ -struct odp_flow_put { - struct odp_flow flow; - __u32 flags; +struct odp_flow_stats { + uint64_t n_packets; /* Number of matched packets. */ + uint64_t n_bytes; /* Number of matched bytes. */ + uint64_t used_sec; /* Time last used, in system monotonic time. */ + uint32_t used_nsec; + uint8_t tcp_flags; + uint8_t reserved; }; -struct odp_flowvec { - struct odp_flow *flows; - int n_flows; +enum odp_key_type { + ODP_KEY_ATTR_UNSPEC, + ODP_KEY_ATTR_TUN_ID, /* 64-bit tunnel ID */ + ODP_KEY_ATTR_IN_PORT, /* 32-bit ODP port number */ + ODP_KEY_ATTR_ETHERNET, /* struct odp_key_ethernet */ + ODP_KEY_ATTR_8021Q, /* struct odp_key_8021q */ + ODP_KEY_ATTR_ETHERTYPE, /* 16-bit Ethernet type */ + ODP_KEY_ATTR_IPV4, /* struct odp_key_ipv4 */ + ODP_KEY_ATTR_TCP, /* struct odp_key_tcp */ + ODP_KEY_ATTR_UDP, /* struct odp_key_udp */ + ODP_KEY_ATTR_ICMP, /* struct odp_key_icmp */ + ODP_KEY_ATTR_ARP, /* struct odp_key_arp */ + __ODP_KEY_ATTR_MAX }; -/* The VLAN id is 12 bits, so we can use the entire 16 bits to indicate - * special conditions. All ones is used to match that no VLAN id was - * set. */ -#define ODP_VLAN_NONE 0xffff +#define ODP_KEY_ATTR_MAX (__ODP_KEY_ATTR_MAX - 1) -/* Action types. */ -#define ODPAT_OUTPUT 0 /* Output to switch port. */ -#define ODPAT_OUTPUT_GROUP 1 /* Output to all ports in group. */ -#define ODPAT_CONTROLLER 2 /* Send copy to controller. */ -#define ODPAT_SET_VLAN_VID 3 /* Set the 802.1q VLAN id. */ -#define ODPAT_SET_VLAN_PCP 4 /* Set the 802.1q priority. */ -#define ODPAT_STRIP_VLAN 5 /* Strip the 802.1q header. */ -#define ODPAT_SET_DL_SRC 6 /* Ethernet source address. */ -#define ODPAT_SET_DL_DST 7 /* Ethernet destination address. */ -#define ODPAT_SET_NW_SRC 8 /* IP source address. */ -#define ODPAT_SET_NW_DST 9 /* IP destination address. */ -#define ODPAT_SET_TP_SRC 10 /* TCP/UDP source port. */ -#define ODPAT_SET_TP_DST 11 /* TCP/UDP destination port. */ -#define ODPAT_N_ACTIONS 12 - -struct odp_action_output { - __u16 type; /* ODPAT_OUTPUT. */ - __u16 port; /* Output port. */ - __u16 reserved1; - __u16 reserved2; +struct odp_key_ethernet { + uint8_t eth_src[6]; + uint8_t eth_dst[6]; }; -struct odp_action_output_group { - __u16 type; /* ODPAT_OUTPUT_GROUP. */ - __u16 group; /* Group number. */ - __u16 reserved1; - __u16 reserved2; +struct odp_key_8021q { + ovs_be16 q_tpid; + ovs_be16 q_tci; }; -struct odp_action_controller { - __u16 type; /* ODPAT_OUTPUT_CONTROLLER. */ - __u16 reserved; - __u32 arg; /* Copied to struct odp_msg 'arg' member. */ +struct odp_key_ipv4 { + ovs_be32 ipv4_src; + ovs_be32 ipv4_dst; + uint8_t ipv4_proto; + uint8_t ipv4_tos; }; -/* Action structure for ODPAT_SET_VLAN_VID. */ -struct odp_action_vlan_vid { - __u16 type; /* ODPAT_SET_VLAN_VID. */ - __be16 vlan_vid; /* VLAN id. */ - __u16 reserved1; - __u16 reserved2; +struct odp_key_tcp { + ovs_be16 tcp_src; + ovs_be16 tcp_dst; }; -/* Action structure for ODPAT_SET_VLAN_PCP. */ -struct odp_action_vlan_pcp { - __u16 type; /* ODPAT_SET_VLAN_PCP. */ - __u8 vlan_pcp; /* VLAN priority. */ - __u8 reserved1; - __u16 reserved2; - __u16 reserved3; +struct odp_key_udp { + ovs_be16 udp_src; + ovs_be16 udp_dst; }; -/* Action structure for ODPAT_SET_DL_SRC/DST. */ -struct odp_action_dl_addr { - __u16 type; /* ODPAT_SET_DL_SRC/DST. */ - __u8 dl_addr[ETH_ALEN]; /* Ethernet address. */ +struct odp_key_icmp { + uint8_t icmp_type; + uint8_t icmp_code; }; -/* Action structure for ODPAT_SET_NW_SRC/DST. */ -struct odp_action_nw_addr { - __u16 type; /* ODPAT_SET_TW_SRC/DST. */ - __u16 reserved; - __be32 nw_addr; /* IP address. */ +struct odp_key_arp { + ovs_be32 arp_sip; + ovs_be32 arp_tip; + ovs_be16 arp_op; }; -/* Action structure for ODPAT_SET_TP_SRC/DST. */ -struct odp_action_tp_port { - __u16 type; /* ODPAT_SET_TP_SRC/DST. */ - __be16 tp_port; /* TCP/UDP port. */ - __u16 reserved1; - __u16 reserved2; +struct odp_flow { + struct odp_flow_stats stats; + struct nlattr *key; + uint32_t key_len; + struct nlattr *actions; + uint32_t actions_len; }; -union odp_action { - __u16 type; - struct odp_action_output output; - struct odp_action_output_group output_group; - struct odp_action_controller controller; - struct odp_action_vlan_vid vlan_vid; - struct odp_action_vlan_pcp vlan_pcp; - struct odp_action_dl_addr dl_addr; - struct odp_action_nw_addr nw_addr; - struct odp_action_tp_port tp_port; -}; +/* Flags for ODP_FLOW_PUT. */ +#define ODPPF_CREATE (1 << 0) /* Allow creating a new flow. */ +#define ODPPF_MODIFY (1 << 1) /* Allow modifying an existing flow. */ +#define ODPPF_ZERO_STATS (1 << 2) /* Zero the stats of an existing flow. */ -struct odp_execute { - __u16 in_port; - __u16 reserved1; - __u32 reserved2; +/* ODP_FLOW_PUT argument. */ +struct odp_flow_put { + struct odp_flow flow; + uint32_t flags; +}; - union odp_action *actions; - __u32 n_actions; +/* ODP_FLOW_DUMP argument. + * + * This is used to iterate through the flow table flow-by-flow. Each + * ODP_FLOW_DUMP call either stores a new odp_flow into 'flow' or stores 0 into + * flow->key_len to indicate that the end of the table has been reached, and + * updates 'state' in-place. + * + * Before the first call, zero 'state'. The format of 'state' is otherwise + * unspecified. + */ +struct odp_flow_dump { + struct odp_flow *flow; + uint32_t state[2]; +}; - const void *data; - __u32 length; +/* Action types. */ +enum odp_action_type { + ODPAT_UNSPEC, + ODPAT_OUTPUT, /* Output to switch port. */ + ODPAT_CONTROLLER, /* Send copy to controller. */ + ODPAT_SET_DL_TCI, /* Set the 802.1q TCI value. */ + ODPAT_STRIP_VLAN, /* Strip the 802.1q header. */ + ODPAT_SET_DL_SRC, /* Ethernet source address. */ + ODPAT_SET_DL_DST, /* Ethernet destination address. */ + ODPAT_SET_NW_SRC, /* IPv4 source address. */ + ODPAT_SET_NW_DST, /* IPv4 destination address. */ + ODPAT_SET_NW_TOS, /* IP ToS/DSCP field (6 bits). */ + ODPAT_SET_TP_SRC, /* TCP/UDP source port. */ + ODPAT_SET_TP_DST, /* TCP/UDP destination port. */ + ODPAT_SET_TUNNEL, /* Set the encapsulating tunnel ID. */ + ODPAT_SET_PRIORITY, /* Set skb->priority. */ + ODPAT_POP_PRIORITY, /* Restore original skb->priority. */ + ODPAT_DROP_SPOOFED_ARP, /* Drop ARPs with spoofed source MAC. */ + __ODPAT_MAX }; -/* Values below this cutoff are 802.3 packets and the two bytes - * following MAC addresses are used as a frame length. Otherwise, the - * two bytes are used as the Ethernet type. - */ -#define ODP_DL_TYPE_ETH2_CUTOFF 0x0600 +#define ODPAT_MAX (__ODPAT_MAX - 1) -/* Value of dl_type to indicate that the frame does not include an - * Ethernet type. - */ -#define ODP_DL_TYPE_NOT_ETH_TYPE 0x05ff +struct odp_execute { + struct nlattr *actions; + uint32_t actions_len; -/* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate - * special conditions. All ones indicates that no VLAN id was set. - */ -#define ODP_VLAN_NONE 0xffff + const void *data; + uint32_t length; +}; -#endif /* openvswitch/datapath-protocol.h */ +#endif /* openvswitch/datapath-protocol.h */