/*
- * 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
* ----------------------------------------------------------------------
*/
-/* 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<N> types indicate that an object is in big-endian, not
+ * native-endian, byte order. They are otherwise equivalent to uint<N>_t.
+ * The Linux kernel already has __be<N> 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 <linux/types.h>
+#define ovs_be16 __be16
+#define ovs_be32 __be32
+#define ovs_be64 __be64
#else
-#include <sys/types.h>
+#include <stdint.h>
+#define ovs_be16 uint16_t
+#define ovs_be32 uint32_t
+#define ovs_be64 uint64_t
#endif
-#include <linux/if_ether.h>
#define ODP_MAX 256 /* Maximum number of datapaths. */
#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_ATTACH _IOR('O', 7, struct odp_port)
+#define ODP_PORT_DETACH _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_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_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', 19, struct odp_execute)
+#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_ADD _IOR('O', 21, struct odp_vport_add)
+#define ODP_VPORT_MOD _IOR('O', 22, struct odp_vport_mod)
+#define ODP_VPORT_DEL _IO('O', 23)
+#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)
+#define ODPP_NORMAL ((uint16_t)-2)
/* 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.
+ * @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.
+ *
+ * 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 &struct odp_action_controller 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 an array of &union odp_action (the number
+ * of which 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 type;
+ uint32_t length;
+ uint16_t port;
+ uint16_t reserved;
+ uint32_t arg;
+};
+
+/**
+ * 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.
+ * @n_actions: Number of "union odp_action"s 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 an array of &union odp_action
+ * (the number of which is specified in @n_actions) and then by packet data.
+ */
+struct odp_sflow_sample_header {
+ uint32_t sample_pool;
+ uint32_t n_actions;
};
#define ODP_PORT_INTERNAL (1 << 0) /* This port is simulated. */
struct odp_port {
char devname[16]; /* IFNAMSIZ */
- __u16 port;
- __u16 flags;
- __u32 reserved2;
+ uint16_t port;
+ uint16_t flags;
+ uint32_t reserved2;
};
struct odp_portvec {
struct odp_port *ports;
- int n_ports;
-};
-
-struct odp_port_group {
- __u16 *ports;
- __u16 n_ports; /* Number of ports. */
- __u16 group; /* Group number. */
+ uint32_t n_ports;
};
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. */
+ 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 {
- __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. */
- __u8 reserved; /* Pad to 64 bits. */
+ 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). */
};
+/* Flags for ODP_FLOW. */
+#define ODPFF_ZERO_TCP_FLAGS (1 << 0) /* Zero the TCP flags. */
+
struct odp_flow {
struct odp_flow_stats stats;
struct odp_flow_key key;
union odp_action *actions;
- __u32 n_actions;
+ uint32_t n_actions;
+ uint32_t flags;
};
/* Flags for ODP_FLOW_PUT. */
/* 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_SET_DL_TCI 3 /* Set the 802.1q TCI value. */
#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
+#define ODPAT_SET_NW_TOS 10 /* IP ToS/DSCP field (6 bits). */
+#define ODPAT_SET_TP_SRC 11 /* TCP/UDP source port. */
+#define ODPAT_SET_TP_DST 12 /* TCP/UDP destination port. */
+#define ODPAT_SET_TUNNEL 13 /* Set the encapsulating tunnel ID. */
+#define ODPAT_SET_PRIORITY 14 /* Set skb->priority. */
+#define ODPAT_POP_PRIORITY 15 /* Restore original skb->priority. */
+#define ODPAT_DROP_SPOOFED_ARP 16 /* Drop ARPs with spoofed source MAC. */
+#define ODPAT_N_ACTIONS 17
struct odp_action_output {
- __u16 type; /* ODPAT_OUTPUT. */
- __u16 port; /* Output port. */
- __u16 reserved1;
- __u16 reserved2;
-};
-
-struct odp_action_output_group {
- __u16 type; /* ODPAT_OUTPUT_GROUP. */
- __u16 group; /* Group number. */
- __u16 reserved1;
- __u16 reserved2;
+ uint16_t type; /* ODPAT_OUTPUT. */
+ uint16_t port; /* Output port. */
+ uint16_t reserved1;
+ uint16_t reserved2;
};
struct odp_action_controller {
- __u16 type; /* ODPAT_OUTPUT_CONTROLLER. */
- __u16 reserved;
- __u32 arg; /* Copied to struct odp_msg 'arg' member. */
+ uint16_t type; /* ODPAT_OUTPUT_CONTROLLER. */
+ uint16_t reserved;
+ uint32_t arg; /* Copied to struct odp_msg 'arg' member. */
};
-/* 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_action_tunnel {
+ uint16_t type; /* ODPAT_SET_TUNNEL. */
+ uint16_t reserved;
+ ovs_be32 tun_id; /* Tunnel ID. */
};
-/* 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;
+/* Action structure for ODPAT_SET_DL_TCI. */
+struct odp_action_dl_tci {
+ uint16_t type; /* ODPAT_SET_DL_TCI. */
+ ovs_be16 tci; /* New TCI. CFI bit must be zero. */
+ uint32_t reserved;
};
/* 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. */
+ uint16_t type; /* ODPAT_SET_DL_SRC/DST. */
+ uint8_t dl_addr[6]; /* Ethernet address. */
};
/* 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. */
+ uint16_t type; /* ODPAT_SET_TW_SRC/DST. */
+ uint16_t reserved;
+ ovs_be32 nw_addr; /* IP address. */
+};
+
+struct odp_action_nw_tos {
+ uint16_t type; /* ODPAT_SET_NW_TOS. */
+ uint8_t nw_tos; /* IP ToS/DSCP field (6 bits). */
+ uint8_t reserved1;
+ uint16_t reserved2;
+ uint16_t reserved3;
};
/* 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;
+ uint16_t type; /* ODPAT_SET_TP_SRC/DST. */
+ ovs_be16 tp_port; /* TCP/UDP port. */
+ uint16_t reserved1;
+ uint16_t reserved2;
+};
+
+/* Action structure for ODPAT_SET_PRIORITY. */
+struct odp_action_priority {
+ uint16_t type; /* ODPAT_SET_PRIORITY. */
+ uint16_t reserved;
+ uint32_t priority; /* skb->priority value. */
};
union odp_action {
- __u16 type;
+ uint16_t 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_tunnel tunnel;
+ struct odp_action_dl_tci dl_tci;
struct odp_action_dl_addr dl_addr;
struct odp_action_nw_addr nw_addr;
+ struct odp_action_nw_tos nw_tos;
struct odp_action_tp_port tp_port;
+ struct odp_action_priority priority;
};
struct odp_execute {
- __u16 in_port;
- __u16 reserved1;
- __u32 reserved2;
-
union odp_action *actions;
- __u32 n_actions;
+ uint32_t n_actions;
const void *data;
- __u32 length;
+ 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 {
+ uint64_t rx_packets;
+ uint64_t tx_packets;
+ uint64_t rx_bytes;
+ uint64_t tx_bytes;
+ uint64_t rx_dropped;
+ uint64_t tx_dropped;
+ uint64_t rx_errors;
+ uint64_t tx_errors;
+ uint64_t rx_frame_err;
+ uint64_t rx_over_err;
+ uint64_t rx_crc_err;
+ uint64_t collisions;
+};
+
+struct odp_vport_stats_req {
+ char devname[16]; /* IFNAMSIZ */
+ struct odp_vport_stats 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
*/
#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 */