#include <linux/if_link.h>
#include <linux/netlink.h>
+\f
+/* Datapaths. */
+
+#define ODP_DATAPATH_FAMILY "odp_datapath"
+#define ODP_DATAPATH_MCGROUP "odp_datapath"
-#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_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_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)
+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_header - header for ODP Generic Netlink messages.
};
\f
/**
- * 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.
+ * 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.
*
- * 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.
+ * These attributes follow the &struct odp_header within the Generic Netlink
+ * payload for %ODP_DP_* commands.
*/
-struct odp_datapath {
- int32_t dp_idx;
- uint32_t len;
- uint32_t total_len;
-};
-
-enum odp_datapath_type {
+enum odp_datapath_attr {
ODP_DP_ATTR_UNSPEC,
ODP_DP_ATTR_NAME, /* name of dp_ifidx netdev */
ODP_DP_ATTR_STATS, /* struct odp_stats */
#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. */
*
* These attributes follow the &struct odp_header within the Generic Netlink
* payload for %ODP_PACKET_* commands.
- *
- * The %ODP_PACKET_ATTR_TYPE, %ODP_PACKET_ATTR_PACKET and %ODP_PACKET_ATTR_KEY
- * attributes are present for all notifications. For %ODP_PACKET_CMD_ACTION,
- * the %ODP_PACKET_ATTR_USERDATA attribute is included if it would be nonzero.
- * For %ODP_PACKET_CMD_SAMPLE, the %ODP_PACKET_ATTR_SAMPLE_POOL and
- * %ODP_PACKET_ATTR_ACTIONS attributes are included.
*/
enum odp_packet_attr {
ODP_PACKET_ATTR_UNSPEC,
};
#define ODP_VPORT_TYPE_MAX (__ODP_VPORT_TYPE_MAX - 1)
+\f
+#define ODP_VPORT_FAMILY "odp_vport"
+#define ODP_VPORT_MCGROUP "odp_vport"
+
+enum odp_vport_cmd {
+ ODP_VPORT_CMD_UNSPEC,
+ ODP_VPORT_CMD_NEW,
+ ODP_VPORT_CMD_DEL,
+ ODP_VPORT_CMD_GET,
+ ODP_VPORT_CMD_SET
+};
/**
- * 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.
+ * enum odp_vport_attr - attributes for %ODP_VPORT_* commands.
+ * @ODP_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
+ * @ODP_VPORT_ATTR_TYPE: 32-bit %ODP_VPORT_TYPE_* constant describing the type
+ * of vport.
+ * @ODP_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device
+ * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes
+ * plus a null terminator.
+ * @ODP_VPORT_ATTR_STATS: A &struct rtnl_link_stats64 giving statistics for
+ * packets sent or received through the vport.
+ * @ODP_VPORT_ATTR_ADDRESS: A 6-byte Ethernet address for the vport.
+ * @ODP_VPORT_ATTR_MTU: MTU for the vport.
+ * @ODP_VPORT_ATTR_IFINDEX: ifindex of the underlying network device, if any.
+ * @ODP_VPORT_ATTR_IFLINK: ifindex of the device on which packets are sent (for
+ * tunnels), if any.
+ *
+ * These attributes follow the &struct odp_header within the Generic Netlink
+ * payload for %ODP_VPORT_* commands.
+ *
+ * All attributes applicable to a given port are present in notifications.
+ * This means that, for example, a vport that has no corresponding network
+ * device would omit %ODP_VPORT_ATTR_IFINDEX.
*
- * 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.
+ * For %ODP_VPORT_CMD_NEW requests, the %ODP_VPORT_ATTR_TYPE and
+ * %ODP_VPORT_ATTR_NAME attributes are required. %ODP_VPORT_ATTR_PORT_NO is
+ * optional; if not specified a free port number is automatically selected.
+ * Whether %ODP_VPORT_ATTR_OPTIONS is required or optional depends on the type
+ * of vport. %ODP_VPORT_ATTR_STATS, %ODP_VPORT_ATTR_ADDRESS, and
+ * %ODP_VPORT_ATTR_MTU are optional, and other attributes are ignored.
+ *
+ * For other requests, if %ODP_VPORT_ATTR_NAME is specified then it is used to
+ * look up the vport to operate on; otherwise dp_idx from the &struct
+ * odp_header plus %ODP_VPORT_ATTR_PORT_NO determine the vport.
*/
-struct odp_vport {
- uint32_t dp_idx;
- uint32_t len;
- uint32_t total_len;
-};
-
-enum {
+enum odp_vport_attr {
ODP_VPORT_ATTR_UNSPEC,
ODP_VPORT_ATTR_PORT_NO, /* port number within datapath */
ODP_VPORT_ATTR_TYPE, /* 32-bit ODP_VPORT_TYPE_* constant. */
};
#define ODP_PATCH_ATTR_MAX (__ODP_PATCH_ATTR_MAX - 1)
+\f
+/* Flows. */
+
+#define ODP_FLOW_FAMILY "odp_flow"
+#define ODP_FLOW_MCGROUP "odp_flow"
+
+enum odp_flow_cmd {
+ ODP_FLOW_CMD_UNSPEC,
+ ODP_FLOW_CMD_NEW,
+ ODP_FLOW_CMD_DEL,
+ ODP_FLOW_CMD_GET,
+ ODP_FLOW_CMD_SET
+};
struct odp_flow_stats {
uint64_t n_packets; /* Number of matched packets. */
};
/**
- * 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.
+ * enum odp_flow_attr - attributes for %ODP_FLOW_* commands.
+ * @ODP_FLOW_ATTR_KEY: Nested %ODP_KEY_ATTR_* attributes specifying the flow
+ * key. Always present in notifications. Required for all requests (except
+ * dumps).
+ * @ODP_FLOW_ATTR_ACTIONS: Nested %ODPAT_* attributes specifying the actions to
+ * take for packets that match the key. Always present in notifications.
+ * Required for %ODP_FLOW_CMD_NEW requests, optional on %ODP_FLOW_CMD_SET
+ * request to change the existing actions, ignored for other requests.
+ * @ODP_FLOW_ATTR_STATS: &struct odp_flow_stats giving statistics for this
+ * flow. Present in notifications if the stats would be nonzero. Ignored in
+ * requests.
+ * @ODP_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
+ * TCP flags seen on packets in this flow. Only present in notifications for
+ * TCP flows, and only if it would be nonzero. Ignored in requests.
+ * @ODP_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
+ * the system monotonic clock, at which a packet was last processed for this
+ * flow. Only present in notifications if a packet has been processed for this
+ * flow. Ignored in requests.
+ * @ODP_FLOW_ATTR_CLEAR: If present in a %ODP_FLOW_CMD_SET request, clears the
+ * last-used time, accumulated TCP flags, and statistics for this flow.
+ * Otherwise ignored in requests. Never present in notifications.
*
- * 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.
+ * These attributes follow the &struct odp_header within the Generic Netlink
+ * payload for %ODP_FLOW_* commands.
*/
-struct odp_flow {
- uint32_t nlmsg_flags;
- uint32_t dp_idx;
- uint32_t len;
- uint32_t total_len;
-};
-
-enum odp_flow_type {
+enum odp_flow_attr {
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_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
};
projects / openvswitch / blobdiff