datapath: Change vport type from string to integer enumeration.
[sliver-openvswitch.git] / include / openvswitch / datapath-protocol.h
index 731a849..1d68445 100644 (file)
@@ -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
 
 #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 <linux/if_link.h>
+#include <linux/netlink.h>
 
 #define ODP_MAX 256             /* Maximum number of datapaths. */
 
 #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_DUMP          _IOWR('O', 10, struct odp_vport_dump)
 
-#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)
 
@@ -128,7 +131,6 @@ struct odp_stats {
 /* 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,65 +141,76 @@ struct odp_stats {
 #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 %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 {
-    uint32_t type;
-    uint32_t length;
-    uint16_t port;
-    uint16_t reserved;
-    uint32_t arg;
+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_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_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.
  *
- * 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.
+ * 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_sflow_sample_header {
-    uint32_t sample_pool;
-    uint32_t actions_len;
+struct odp_packet {
+       uint32_t dp_idx;
+       uint32_t len;
 };
 
-#define VPORT_TYPE_SIZE     16
 #define VPORT_CONFIG_SIZE     32
 struct odp_port {
     char devname[16];           /* IFNAMSIZ */
-    char type[VPORT_TYPE_SIZE];
+    uint32_t type;              /* One of ODP_VPORT_TYPE_*. */
     uint16_t port;
-    uint16_t reserved1;
+    uint16_t dp_idx;
     uint32_t reserved2;
     __aligned_u64 config[VPORT_CONFIG_SIZE / 8]; /* type-specific */
 };
 
-struct odp_portvec {
-    struct odp_port *ports;
-    uint32_t n_ports;
+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_vport_dump - ODP_VPORT_DUMP argument.
+ * @port: Points to port structure to fill in.
+ * @port_no: Minimum port number of interest.
+ *
+ * Used to iterate through vports one at a time.  The kernel fills in @port
+ * with the information for the configured port with the smallest port number
+ * greater than or equal to @port_no.  If there is no such port, it sets
+ * @port->devname to the empty string.
+ */
+struct odp_vport_dump {
+    struct odp_port *port;
+    uint32_t port_no;
 };
 
 struct odp_flow_stats {
@@ -210,37 +223,69 @@ struct odp_flow_stats {
     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
+};
+
+#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_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;
+    struct nlattr *key;
+    uint32_t key_len;
     struct nlattr *actions;
     uint32_t actions_len;
     uint32_t flags;
@@ -262,6 +307,21 @@ struct odp_flowvec {
     uint32_t n_flows;
 };
 
+/* 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];
+};
+
 /* Action types. */
 enum odp_action_type {
     ODPAT_UNSPEC,
@@ -271,8 +331,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. */
@@ -320,15 +380,4 @@ struct odp_vport_mtu {
     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 */