X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=include%2Fopenvswitch%2Fdatapath-protocol.h;h=25499aa1be90e2ebbd1b112cbe925253d6b599ad;hb=36956a7d33c9ee204fcb184484a5aaacbd9ecef8;hp=04423d941aa8e697d2a2e44469741076bea265fd;hpb=4d678233e981fa319a338f6b0949e9dc625941a4;p=sliver-openvswitch.git diff --git a/include/openvswitch/datapath-protocol.h b/include/openvswitch/datapath-protocol.h index 04423d941..25499aa1b 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 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 userspace and kernel 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,115 +82,200 @@ #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_VPORT_ATTACH _IOR('O', 7, struct odp_port) +#define ODP_VPORT_DETACH _IOR('O', 8, int) +#define ODP_VPORT_QUERY _IOWR('O', 9, struct odp_port) +#define ODP_VPORT_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_FLOW_GET _IOWR('O', 13, struct odp_flow) +#define ODP_FLOW_GET _IOWR('O', 13, struct odp_flowvec) #define ODP_FLOW_PUT _IOWR('O', 14, struct odp_flow) -#define ODP_FLOW_LIST _IOWR('O', 15, struct odp_flowvec) +#define ODP_FLOW_DUMP _IOWR('O', 15, struct odp_flow_dump) #define ODP_FLOW_FLUSH _IO('O', 16) #define ODP_FLOW_DEL _IOWR('O', 17, struct odp_flow) #define ODP_EXECUTE _IOR('O', 18, struct odp_execute) +#define ODP_SET_SFLOW_PROBABILITY _IOR('O', 19, int) +#define ODP_GET_SFLOW_PROBABILITY _IOW('O', 20, int) + +#define ODP_VPORT_MOD _IOR('O', 22, struct odp_port) +#define ODP_VPORT_STATS_GET _IOWR('O', 24, struct odp_vport_stats_req) +#define ODP_VPORT_ETHER_GET _IOWR('O', 25, struct odp_vport_ether) +#define ODP_VPORT_ETHER_SET _IOW('O', 26, struct odp_vport_ether) +#define ODP_VPORT_MTU_GET _IOWR('O', 27, struct odp_vport_mtu) +#define ODP_VPORT_MTU_SET _IOW('O', 28, struct odp_vport_mtu) +#define ODP_VPORT_STATS_SET _IOWR('O', 29, struct odp_vport_stats_req) + 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. */ + uint32_t n_flows; /* Number of flows in flow table. */ + uint32_t cur_capacity; /* Current flow table capacity. */ + uint32_t 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; + uint32_t n_ports; /* Current number of ports. */ + uint32_t max_ports; /* Maximum supported number of ports. */ /* 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. */ + 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. */ /* Queues. */ - __u16 max_miss_queue; /* Max length of ODPL_MISS queue. */ - __u16 max_action_queue; /* Max length of ODPL_ACTION queue. */ + uint16_t max_miss_queue; /* Max length of ODPL_MISS queue. */ + uint16_t max_action_queue; /* Max length of ODPL_ACTION queue. */ + uint16_t max_sflow_queue; /* Max length of ODPL_SFLOW queue. */ }; /* 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. */ +#define _ODPL_SFLOW_NR 2 /* sFlow samples. */ +#define ODPL_SFLOW (1 << _ODPL_SFLOW_NR) +#define ODPL_ALL (ODPL_MISS | ODPL_ACTION | ODPL_SFLOW) + +/** + * struct odp_msg - format of messages read from datapath fd. + * @length: Total length of message, including this header. + * @type: One of the %_ODPL_* constants. + * @port: Port that received the packet embedded in this message. + * @arg: Argument value whose meaning depends on @type. + * + * For @type == %_ODPL_MISS_NR, the header is followed by packet data. The + * @arg member is the ID (in network byte order) of the tunnel that + * encapsulated this packet. It is 0 if the packet was not received on a tunnel. + * + * For @type == %_ODPL_ACTION_NR, the header is followed by packet data. The + * @arg member is copied from the %ODPAT_CONTROLLER action that caused the + * &struct odp_msg to be composed. + * + * For @type == %_ODPL_SFLOW_NR, the header is followed by &struct + * odp_sflow_sample_header, then by a series of Netlink attributes (whose + * length is specified in &struct odp_sflow_sample_header), then by packet + * data. + */ 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. */ + uint32_t length; + uint16_t type; + uint16_t port; + __aligned_u64 arg; }; -#define ODP_PORT_INTERNAL (1 << 0) /* This port is simulated. */ +/** + * struct odp_sflow_sample_header - header added to sFlow sampled packet. + * @sample_pool: Number of packets that were candidates for sFlow sampling, + * regardless of whether they were actually chosen and sent down to userspace. + * @actions_len: Number of bytes of actions immediately following this header. + * + * This header follows &struct odp_msg when that structure's @type is + * %_ODPL_SFLOW_NR, and it is itself followed by a series of Netlink attributes + * (the number of bytes of which is specified in @actions_len) and then by + * packet data. + */ +struct odp_sflow_sample_header { + uint32_t sample_pool; + uint32_t actions_len; +}; + +#define VPORT_TYPE_SIZE 16 +#define VPORT_CONFIG_SIZE 32 struct odp_port { char devname[16]; /* IFNAMSIZ */ - __u16 port; - __u16 flags; - __u32 reserved2; + char type[VPORT_TYPE_SIZE]; + uint16_t port; + uint16_t reserved1; + uint32_t reserved2; + __aligned_u64 config[VPORT_CONFIG_SIZE / 8]; /* type-specific */ }; struct odp_portvec { struct odp_port *ports; - int n_ports; + uint32_t n_ports; }; -struct odp_port_group { - __u16 *ports; - __u16 n_ports; /* Number of ports. */ - __u16 group; /* Group number. */ +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; + uint16_t error; /* Used by ODP_FLOW_GET. */ }; -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 error; /* Used by ODP_FLOW_GET. */ +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 +}; + +#define ODP_KEY_ATTR_MAX (__ODP_KEY_ATTR_MAX - 1) + +struct odp_key_ethernet { + uint8_t eth_src[6]; + uint8_t eth_dst[6]; +}; + +struct odp_key_8021q { + ovs_be16 q_tpid; + ovs_be16 q_tci; +}; + +struct odp_key_ipv4 { + ovs_be32 ipv4_src; + ovs_be32 ipv4_dst; + uint8_t ipv4_proto; + uint8_t ipv4_tos; +}; + +struct odp_key_tcp { + ovs_be16 tcp_src; + ovs_be16 tcp_dst; +}; + +struct odp_key_udp { + ovs_be16 udp_src; + ovs_be16 udp_dst; }; -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. */ +struct odp_key_icmp { + uint8_t icmp_type; + uint8_t icmp_code; }; +struct odp_key_arp { + ovs_be32 arp_sip; + ovs_be32 arp_tip; + ovs_be16 arp_op; +}; + +/* Flags for ODP_FLOW. */ +#define ODPFF_ZERO_TCP_FLAGS (1 << 0) /* Zero the TCP flags. */ +#define ODPFF_EOF (1 << 1) /* ODP_FLOW_DUMP: end of flow table. */ + struct odp_flow { struct odp_flow_stats stats; - struct odp_flow_key key; - union odp_action *actions; - __u32 n_actions; + struct nlattr *key; + uint32_t key_len; + struct nlattr *actions; + uint32_t actions_len; + uint32_t flags; }; /* Flags for ODP_FLOW_PUT. */ @@ -180,130 +286,85 @@ struct odp_flow { /* ODP_FLOW_PUT argument. */ struct odp_flow_put { struct odp_flow flow; - __u32 flags; + uint32_t flags; }; struct odp_flowvec { struct odp_flow *flows; - int n_flows; + uint32_t n_flows; }; -/* 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 - -/* 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; +/* 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 + * ODPFF_EOF into flow->flags to indicate that the end of the table has been + * reaches, 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]; }; -struct odp_action_output_group { - __u16 type; /* ODPAT_OUTPUT_GROUP. */ - __u16 group; /* Group number. */ - __u16 reserved1; - __u16 reserved2; +/* 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 }; -struct odp_action_controller { - __u16 type; /* ODPAT_OUTPUT_CONTROLLER. */ - __u16 reserved; - __u32 arg; /* Copied to struct odp_msg 'arg' member. */ -}; +#define ODPAT_MAX (__ODPAT_MAX - 1) -/* 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_execute { + struct nlattr *actions; + uint32_t actions_len; -/* 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; + const void *data; + uint32_t length; }; -/* 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. */ +#define VPORT_TYPE_SIZE 16 +struct odp_vport_add { + char port_type[VPORT_TYPE_SIZE]; + char devname[16]; /* IFNAMSIZ */ + void *config; }; -/* 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_vport_mod { + char devname[16]; /* IFNAMSIZ */ + void *config; }; -/* 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_vport_stats_req { + char devname[16]; /* IFNAMSIZ */ + struct rtnl_link_stats64 stats; }; -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; +struct odp_vport_ether { + char devname[16]; /* IFNAMSIZ */ + unsigned char ether_addr[6]; }; -struct odp_execute { - __u16 in_port; - __u16 reserved1; - __u32 reserved2; - - union odp_action *actions; - __u32 n_actions; - - const void *data; - __u32 length; +struct odp_vport_mtu { + char devname[16]; /* IFNAMSIZ */ + uint16_t mtu; }; -/* 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 - -/* Value of dl_type to indicate that the frame does not include an - * Ethernet type. - */ -#define ODP_DL_TYPE_NOT_ETH_TYPE 0x05ff - -/* 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 - -#endif /* openvswitch/datapath-protocol.h */ +#endif /* openvswitch/datapath-protocol.h */