datapath: Convert ODP_DP_* commands to use AF_NETLINK socket layer.
[sliver-openvswitch.git] / include / openvswitch / datapath-protocol.h
index 0aa6cd6..39a3365 100644 (file)
 #include <linux/if_link.h>
 #include <linux/netlink.h>
 
-#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_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_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_upcall)
+\f
+/* Datapaths. */
+
+#define ODP_DATAPATH_FAMILY  "odp_datapath"
+#define ODP_DATAPATH_MCGROUP "odp_datapath"
+
+enum odp_datapath_cmd {
+       ODP_DP_CMD_UNSPEC,
+       ODP_DP_CMD_NEW,
+       ODP_DP_CMD_DEL,
+       ODP_DP_CMD_GET,
+       ODP_DP_CMD_SET
+};
 
 /**
- * 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.
+ * struct odp_header - header for ODP Generic Netlink messages.
+ * @dp_idx: Number of datapath to which the packet belongs.
  *
- * 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.
+ * Attributes following the header are specific to a particular ODP Generic
+ * Netlink family, but all of the ODP families use this header.
  */
-struct odp_datapath {
-       int32_t dp_idx;
-       uint32_t len;
-       uint32_t total_len;
+struct odp_header {
+       uint32_t dp_idx;
 };
-
-enum odp_datapath_type {
+\f
+/**
+ * enum odp_datapath_attr - attributes for %ODP_DP_* commands.
+ * @ODP_DP_ATTR_NAME: Name of the network device that serves as the "local
+ * port".  This is the name of the network device whose dp_idx is given in the
+ * &struct odp_header.  Always present in notifications.  Required in
+ * %ODP_DP_NEW requests.  May be used as an alternative to specifying dp_idx on
+ * other requests (with a dp_idx of %UINT32_MAX).
+ * @ODP_DP_ATTR_STATS: Statistics about packets that have passed through the
+ * datapath.  Always present in notifications.
+ * @ODP_DP_ATTR_IPV4_FRAGS: One of %ODP_DP_FRAG_*.  Always present in
+ * notifications.  May be included in %ODP_DP_NEW or %ODP_DP_SET requests to
+ * change the fragment handling policy.
+ * @ODP_DP_ATTR_SAMPLING: 32-bit fraction of packets to sample with
+ * @ODP_PACKET_CMD_SAMPLE.  A value of 0 samples no packets, a value of
+ * %UINT32_MAX samples all packets, and intermediate values sample intermediate
+ * fractions of packets.
+ * @ODP_DP_ATTR_MCGROUPS: Nested attributes with multicast groups.  Each nested
+ * attribute has a %ODP_PACKET_CMD_* type with a 32-bit value giving the
+ * Generic Netlink multicast group number used for sending this datapath's
+ * messages with that command type up to userspace.
+ *
+ * These attributes follow the &struct odp_header within the Generic Netlink
+ * payload for %ODP_DP_* commands.
+ */
+enum odp_datapath_attr {
        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_MCGROUPS,   /* Nested attributes with multicast groups. */
        __ODP_DP_ATTR_MAX
 };
 
 #define ODP_DP_ATTR_MAX (__ODP_DP_ATTR_MAX - 1)
 
-/* Values for ODP_DP_ATTR_IPV4_FRAGS. */
+/**
+ * enum odp_frag_handling - policy for handling received IPv4 fragments.
+ * @ODP_DP_FRAG_ZERO: Treat IP fragments as IP protocol 0 and transport ports
+ * zero.
+ * @ODP_DP_FRAG_DROP: Drop IP fragments.  Do not pass them through the flow
+ * table or up to userspace.
+ */
 enum odp_frag_handling {
        ODP_DP_FRAG_UNSPEC,
        ODP_DP_FRAG_ZERO,       /* Treat IP fragments as transport port 0. */
@@ -137,20 +165,44 @@ struct odp_stats {
 
 /* Logical ports. */
 #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_SFLOW_NR  2       /* sFlow samples. */
-#define ODPL_SFLOW      (1 << _ODPL_SFLOW_NR)
-#define ODPL_ALL        (ODPL_MISS | ODPL_ACTION | ODPL_SFLOW)
-
-enum odp_packet_type {
+\f
+#define ODP_PACKET_FAMILY "odp_packet"
+
+enum odp_packet_cmd {
+        ODP_PACKET_CMD_UNSPEC,
+
+        /* Kernel-to-user notifications. */
+        ODP_PACKET_CMD_MISS,    /* Flow table miss. */
+        ODP_PACKET_CMD_ACTION,  /* ODPAT_CONTROLLER action. */
+        ODP_PACKET_CMD_SAMPLE,  /* Sampled packet. */
+
+        /* User commands. */
+        ODP_PACKET_CMD_EXECUTE  /* Apply actions to a packet. */
+};
+
+/**
+ * enum odp_packet_attr - attributes for %ODP_PACKET_* commands.
+ * @ODP_PACKET_ATTR_PACKET: Present for all notifications.  Contains the entire
+ * packet as received, from the start of the Ethernet header onward.  For
+ * %ODP_PACKET_CMD_ACTION, %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.
+ * @ODP_PACKET_ATTR_KEY: Present for all notifications.  Contains the flow key
+ * extracted from the packet as nested %ODP_KEY_ATTR_* attributes.  This allows
+ * userspace to adapt its flow setup strategy by comparing its notion of the
+ * flow key against the kernel's.
+ * @ODP_PACKET_ATTR_USERDATA: Present for an %ODP_PACKET_CMD_ACTION
+ * notification if the %ODPAT_CONTROLLER action's argument was nonzero.
+ * @ODP_PACKET_ATTR_SAMPLE_POOL: Present for %ODP_PACKET_CMD_SAMPLE.  Contains
+ * the number of packets processed so far that were candidates for sampling.
+ * @ODP_PACKET_ATTR_ACTIONS: Present for %ODP_PACKET_CMD_SAMPLE.  Contains a
+ * copy of the actions applied to the packet, as nested %ODPAT_* attributes.
+ *
+ * These attributes follow the &struct odp_header within the Generic Netlink
+ * payload for %ODP_PACKET_* commands.
+ */
+enum odp_packet_attr {
        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. */
@@ -160,29 +212,7 @@ enum odp_packet_type {
 };
 
 #define ODP_PACKET_ATTR_MAX (__ODP_PACKET_ATTR_MAX - 1)
-
-/**
- * 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.
- *
- * 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_packet {
-       uint32_t dp_idx;
-       uint32_t len;
-};
-
+\f
 enum odp_vport_type {
        ODP_VPORT_TYPE_UNSPEC,
        ODP_VPORT_TYPE_NETDEV,   /* network device */