datapath: Change ODP_FLOW_GET to retrieve only a single flow at a time.
[sliver-openvswitch.git] / include / openvswitch / datapath-protocol.h
index 25499aa..54c39d1 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
 #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_flowvec)
+#define ODP_FLOW_GET            _IOWR('O', 13, struct odp_flow)
 #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_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. */
-    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. */
-    uint32_t n_ports;           /* Current number of ports. */
-    uint32_t max_ports;         /* Maximum supported number of ports. */
-
-    /* Lookups. */
     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. */
@@ -141,65 +119,94 @@ 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.
- * @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.
+ * 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 length;
-    uint16_t type;
-    uint16_t port;
-    __aligned_u64 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. */
@@ -207,7 +214,6 @@ struct odp_flow_stats {
     uint32_t used_nsec;
     uint8_t  tcp_flags;
     uint8_t  reserved;
-    uint16_t error;             /* Used by ODP_FLOW_GET. */
 };
 
 enum odp_key_type {
@@ -289,11 +295,6 @@ struct odp_flow_put {
     uint32_t flags;
 };
 
-struct odp_flowvec {
-    struct odp_flow *flows;
-    uint32_t n_flows;
-};
-
 /* ODP_FLOW_DUMP argument.
  *
  * This is used to iterate through the flow table flow-by-flow.  Each
@@ -340,31 +341,4 @@ struct odp_execute {
     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;
-};
-
 #endif  /* openvswitch/datapath-protocol.h */