X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=include%2Fopenvswitch%2Fdatapath-protocol.h;h=d76b54789912e9057a843c1ed7760bf2c536a6e0;hb=c75d4dcf957f617b40ca89546545f075e2631226;hp=731a84935b68e4ca680798276b7101f0e934b58c;hpb=cdee00fd635d1e0f1eeb5d9c009daeb59abd4777;p=sliver-openvswitch.git diff --git a/include/openvswitch/datapath-protocol.h b/include/openvswitch/datapath-protocol.h index 731a84935..d76b54789 100644 --- a/include/openvswitch/datapath-protocol.h +++ b/include/openvswitch/datapath-protocol.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009, 2010 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 @@ -63,72 +63,80 @@ #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 -#define ODP_MAX 256 /* Maximum number of datapaths. */ - -#define ODP_DP_CREATE _IO('O', 0) -#define ODP_DP_DESTROY _IO('O', 1) -#define ODP_DP_STATS _IOW('O', 2, struct odp_stats) - -#define ODP_GET_DROP_FRAGS _IOW('O', 3, int) -#define ODP_SET_DROP_FRAGS _IOR('O', 4, int) +#define ODP_DP_NEW _IOWR('O', 0, struct odp_datapath) +#define ODP_DP_DEL _IOR('O', 1, struct odp_datapath) +#define ODP_DP_GET _IOWR('O', 2, struct odp_datapath) +#define ODP_DP_SET _IOWR('O', 3, struct odp_datapath) +#define ODP_DP_DUMP _IOWR('O', 4, struct odp_datapath) #define ODP_GET_LISTEN_MASK _IOW('O', 5, int) #define ODP_SET_LISTEN_MASK _IOR('O', 6, int) -#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_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_PUT _IOWR('O', 14, struct odp_flow) -#define ODP_FLOW_LIST _IOWR('O', 15, struct odp_flowvec) -#define ODP_FLOW_FLUSH _IO('O', 16) -#define ODP_FLOW_DEL _IOWR('O', 17, struct odp_flow) +#define ODP_FLOW_NEW _IOWR('O', 13, struct odp_flow) +#define ODP_FLOW_DEL _IOWR('O', 14, struct odp_flow) +#define ODP_FLOW_GET _IOWR('O', 15, struct odp_flow) +#define ODP_FLOW_SET _IOWR('O', 16, struct odp_flow) +#define ODP_FLOW_DUMP _IOWR('O', 17, struct odp_flow) +#define ODP_FLOW_FLUSH _IO('O', 19) -#define ODP_EXECUTE _IOR('O', 18, struct odp_execute) +#define ODP_EXECUTE _IOR('O', 18, struct odp_upcall) -#define ODP_SET_SFLOW_PROBABILITY _IOR('O', 19, int) -#define ODP_GET_SFLOW_PROBABILITY _IOW('O', 20, int) +/** + * struct odp_datapath - header with basic information about a datapath. + * @dp_idx: Datapath index (-1 to make a request not specific to a datapath). + * @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_DP_ATTR_*, up to a length of @len bytes including the &struct + * odp_datapath header. + */ +struct odp_datapath { + int32_t dp_idx; + uint32_t len; + uint32_t total_len; +}; -#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) +enum odp_datapath_type { + ODP_DP_ATTR_UNSPEC, + ODP_DP_ATTR_NAME, /* name of dp_ifidx netdev */ + ODP_DP_ATTR_STATS, /* struct odp_stats */ + ODP_DP_ATTR_IPV4_FRAGS, /* 32-bit enum odp_frag_handling */ + ODP_DP_ATTR_SAMPLING, /* 32-bit fraction of packets to sample. */ + __ODP_DP_ATTR_MAX +}; -struct odp_stats { - /* Flows. */ - 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. */ +#define ODP_DP_ATTR_MAX (__ODP_DP_ATTR_MAX - 1) - /* Ports. */ - uint32_t n_ports; /* Current number of ports. */ - uint32_t max_ports; /* Maximum supported number of ports. */ +/* Values for ODP_DP_ATTR_IPV4_FRAGS. */ +enum odp_frag_handling { + ODP_DP_FRAG_UNSPEC, + ODP_DP_FRAG_ZERO, /* Treat IP fragments as transport port 0. */ + ODP_DP_FRAG_DROP /* Drop IP fragments. */ +}; - /* Lookups. */ +struct odp_stats { 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. */ - 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 ((uint16_t)0) -#define ODPP_NONE ((uint16_t)-1) -#define ODPP_NORMAL ((uint16_t)-2) /* Listening channels. */ #define _ODPL_MISS_NR 0 /* Packet missed in flow table. */ @@ -139,129 +147,185 @@ struct odp_stats { #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_PACKET_ATTR_MAX (__ODP_PACKET_ATTR_MAX - 1) + /** - * struct odp_msg - format of messages read from datapath fd. - * @type: One of the %_ODPL_* constants. - * @length: Total length of message, including this header. - * @port: Port that received the packet embedded in this message. - * @reserved: Not currently used. Should be set to 0. - * @arg: Argument value whose meaning depends on @type. + * 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. * - * 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. + * 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 == %_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. + * 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_msg { - uint32_t type; - uint32_t length; - uint16_t port; - uint16_t reserved; - uint32_t arg; +struct odp_packet { + uint32_t dp_idx; + uint32_t len; +}; + +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 }; +#define ODP_VPORT_TYPE_MAX (__ODP_VPORT_TYPE_MAX - 1) + /** - * 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. + * 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. * - * 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. + * 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_sflow_sample_header { - uint32_t sample_pool; - uint32_t actions_len; +struct odp_vport { + uint32_t dp_idx; + uint32_t len; + uint32_t total_len; }; -#define VPORT_TYPE_SIZE 16 -#define VPORT_CONFIG_SIZE 32 -struct odp_port { - char devname[16]; /* IFNAMSIZ */ - char type[VPORT_TYPE_SIZE]; - uint16_t port; - uint16_t reserved1; - uint32_t reserved2; - __aligned_u64 config[VPORT_CONFIG_SIZE / 8]; /* type-specific */ +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 }; -struct odp_portvec { - struct odp_port *ports; - uint32_t n_ports; +#define ODP_VPORT_ATTR_MAX (__ODP_VPORT_ATTR_MAX - 1) + +/* 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 }; +#define ODP_PATCH_ATTR_MAX (__ODP_PATCH_ATTR_MAX - 1) + 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. */ }; -/* - * The datapath protocol adopts the Linux convention for TCI fields: if an - * 802.1Q header is present then its TCI value is used verbatim except that the - * CFI bit (0x1000) is always set to 1, and all-bits-zero indicates no 802.1Q - * header. - */ -#define ODP_TCI_PRESENT 0x1000 /* CFI bit */ - -struct odp_flow_key { - ovs_be32 tun_id; /* Encapsulating tunnel ID. */ - ovs_be32 nw_src; /* IP source address. */ - ovs_be32 nw_dst; /* IP destination address. */ - uint16_t in_port; /* Input switch port. */ - ovs_be16 dl_tci; /* All zeros if 802.1Q header absent, - * ODP_TCI_PRESENT set if present. */ - ovs_be16 dl_type; /* Ethernet frame type. */ - ovs_be16 tp_src; /* TCP/UDP source port. */ - ovs_be16 tp_dst; /* TCP/UDP destination port. */ - uint8_t dl_src[6]; /* Ethernet source address. */ - uint8_t dl_dst[6]; /* Ethernet destination address. */ - uint8_t nw_proto; /* IP protocol or lower 8 bits of - ARP opcode. */ - uint8_t nw_tos; /* IP ToS (DSCP field, 6 bits). */ +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 }; -/* Flags for ODP_FLOW. */ -#define ODPFF_ZERO_TCP_FLAGS (1 << 0) /* Zero the TCP flags. */ +#define ODP_KEY_ATTR_MAX (__ODP_KEY_ATTR_MAX - 1) -struct odp_flow { - struct odp_flow_stats stats; - struct odp_flow_key key; - struct nlattr *actions; - uint32_t actions_len; - uint32_t flags; +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; }; -/* 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_key_icmp { + uint8_t icmp_type; + uint8_t icmp_code; +}; -/* ODP_FLOW_PUT argument. */ -struct odp_flow_put { - struct odp_flow flow; - uint32_t flags; +struct odp_key_arp { + ovs_be32 arp_sip; + ovs_be32 arp_tip; + ovs_be16 arp_op; +}; + +/** + * struct odp_flow - header with basic information about a flow. + * @dp_idx: Datapath index. + * @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_FLOW_ATTR_*, up to a length of @len bytes including the &struct + * odp_flow header. + */ +struct odp_flow { + uint32_t nlmsg_flags; + uint32_t dp_idx; + uint32_t len; + uint32_t total_len; }; -struct odp_flowvec { - struct odp_flow *flows; - uint32_t n_flows; +enum odp_flow_type { + ODP_FLOW_ATTR_UNSPEC, + ODP_FLOW_ATTR_KEY, /* Sequence of ODP_KEY_ATTR_* attributes. */ + ODP_FLOW_ATTR_ACTIONS, /* Sequence of nested ODPAT_* attributes. */ + ODP_FLOW_ATTR_STATS, /* struct odp_flow_stats. */ + ODP_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */ + ODP_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */ + ODP_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */ + ODP_FLOW_ATTR_STATE, /* u64 state for ODP_FLOW_DUMP. */ + __ODP_FLOW_ATTR_MAX }; +#define ODP_FLOW_ATTR_MAX (__ODP_FLOW_ATTR_MAX - 1) + /* Action types. */ enum odp_action_type { ODPAT_UNSPEC, @@ -271,8 +335,8 @@ enum odp_action_type { 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, /* IP source address. */ - ODPAT_SET_NW_DST, /* IP 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. */ @@ -285,50 +349,4 @@ enum odp_action_type { #define ODPAT_MAX (__ODPAT_MAX - 1) -struct odp_execute { - struct nlattr *actions; - uint32_t actions_len; - - const void *data; - uint32_t length; -}; - -#define VPORT_TYPE_SIZE 16 -struct odp_vport_add { - char port_type[VPORT_TYPE_SIZE]; - char devname[16]; /* IFNAMSIZ */ - void *config; -}; - -struct odp_vport_mod { - char devname[16]; /* IFNAMSIZ */ - void *config; -}; - -struct odp_vport_stats_req { - char devname[16]; /* IFNAMSIZ */ - struct rtnl_link_stats64 stats; -}; - -struct odp_vport_ether { - char devname[16]; /* IFNAMSIZ */ - unsigned char ether_addr[6]; -}; - -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 - #endif /* openvswitch/datapath-protocol.h */