app/crypto-perf: support lookaside IPsec
[dpdk.git] / lib / ethdev / rte_flow.h
index 25e20f5..a899450 100644 (file)
 #include <rte_esp.h>
 #include <rte_higig.h>
 #include <rte_ecpri.h>
+#include <rte_bitops.h>
 #include <rte_mbuf.h>
 #include <rte_mbuf_dyn.h>
+#include <rte_meter.h>
+#include <rte_gtp.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -562,6 +565,15 @@ enum rte_flow_item_type {
         * @see struct rte_flow_item_integrity.
         */
        RTE_FLOW_ITEM_TYPE_INTEGRITY,
+
+       /**
+        * [META]
+        *
+        * Matches conntrack state.
+        *
+        * @see struct rte_flow_item_conntrack.
+        */
+       RTE_FLOW_ITEM_TYPE_CONNTRACK,
 };
 
 /**
@@ -773,8 +785,8 @@ struct rte_flow_item_eth {
 /** Default mask for RTE_FLOW_ITEM_TYPE_ETH. */
 #ifndef __cplusplus
 static const struct rte_flow_item_eth rte_flow_item_eth_mask = {
-       .hdr.d_addr.addr_bytes = "\xff\xff\xff\xff\xff\xff",
-       .hdr.s_addr.addr_bytes = "\xff\xff\xff\xff\xff\xff",
+       .hdr.dst_addr.addr_bytes = "\xff\xff\xff\xff\xff\xff",
+       .hdr.src_addr.addr_bytes = "\xff\xff\xff\xff\xff\xff",
        .hdr.ether_type = RTE_BE16(0x0000),
 };
 #endif
@@ -1433,15 +1445,14 @@ static const struct rte_flow_item_meta rte_flow_item_meta_mask = {
  * Matches a GTP PDU extension header with type 0x85.
  */
 struct rte_flow_item_gtp_psc {
-       uint8_t pdu_type; /**< PDU type. */
-       uint8_t qfi; /**< PPP, RQI, QoS flow identifier. */
+       struct rte_gtp_psc_generic_hdr hdr; /**< gtp psc generic hdr. */
 };
 
 /** Default mask for RTE_FLOW_ITEM_TYPE_GTP_PSC. */
 #ifndef __cplusplus
 static const struct rte_flow_item_gtp_psc
 rte_flow_item_gtp_psc_mask = {
-       .qfi = 0xff,
+       .hdr.qfi = 0x3f,
 };
 #endif
 
@@ -1696,8 +1707,16 @@ rte_flow_item_geneve_opt_mask = {
 };
 #endif
 
+/**
+ * @warning
+ * @b EXPERIMENTAL: this structure may change without prior notice
+ *
+ * RTE_FLOW_ITEM_TYPE_INTEGRITY
+ *
+ * Match on packet integrity check result.
+ */
 struct rte_flow_item_integrity {
-       /**< Tunnel encapsulation level the item should apply to.
+       /** Tunnel encapsulation level the item should apply to.
         * @see rte_flow_action_rss
         */
        uint32_t level;
@@ -1705,21 +1724,21 @@ struct rte_flow_item_integrity {
        union {
                __extension__
                struct {
-                       /**< The packet is valid after passing all HW checks. */
+                       /** The packet is valid after passing all HW checks. */
                        uint64_t packet_ok:1;
-                       /**< L2 layer is valid after passing all HW checks. */
+                       /** L2 layer is valid after passing all HW checks. */
                        uint64_t l2_ok:1;
-                       /**< L3 layer is valid after passing all HW checks. */
+                       /** L3 layer is valid after passing all HW checks. */
                        uint64_t l3_ok:1;
-                       /**< L4 layer is valid after passing all HW checks. */
+                       /** L4 layer is valid after passing all HW checks. */
                        uint64_t l4_ok:1;
-                       /**< L2 layer CRC is valid. */
+                       /** L2 layer CRC is valid. */
                        uint64_t l2_crc_ok:1;
-                       /**< IPv4 layer checksum is valid. */
+                       /** IPv4 layer checksum is valid. */
                        uint64_t ipv4_csum_ok:1;
-                       /**< L4 layer checksum is valid. */
+                       /** L4 layer checksum is valid. */
                        uint64_t l4_csum_ok:1;
-                       /**< The l3 length is smaller than the frame length. */
+                       /** L3 length is smaller than frame length. */
                        uint64_t l3_len_ok:1;
                        uint64_t reserved:56;
                };
@@ -1735,6 +1754,51 @@ rte_flow_item_integrity_mask = {
 };
 #endif
 
+/**
+ * The packet is valid after conntrack checking.
+ */
+#define RTE_FLOW_CONNTRACK_PKT_STATE_VALID RTE_BIT32(0)
+/**
+ * The state of the connection is changed.
+ */
+#define RTE_FLOW_CONNTRACK_PKT_STATE_CHANGED RTE_BIT32(1)
+/**
+ * Error is detected on this packet for this connection and
+ * an invalid state is set.
+ */
+#define RTE_FLOW_CONNTRACK_PKT_STATE_INVALID RTE_BIT32(2)
+/**
+ * The HW connection tracking module is disabled.
+ * It can be due to application command or an invalid state.
+ */
+#define RTE_FLOW_CONNTRACK_PKT_STATE_DISABLED RTE_BIT32(3)
+/**
+ * The packet contains some bad field(s) and cannot continue
+ * with the conntrack module checking.
+ */
+#define RTE_FLOW_CONNTRACK_PKT_STATE_BAD RTE_BIT32(4)
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this structure may change without prior notice
+ *
+ * RTE_FLOW_ITEM_TYPE_CONNTRACK
+ *
+ * Matches the state of a packet after it passed the connection tracking
+ * examination. The state is a bitmap of one RTE_FLOW_CONNTRACK_PKT_STATE*
+ * or a reasonable combination of these bits.
+ */
+struct rte_flow_item_conntrack {
+       uint32_t flags;
+};
+
+/** Default mask for RTE_FLOW_ITEM_TYPE_CONNTRACK. */
+#ifndef __cplusplus
+static const struct rte_flow_item_conntrack rte_flow_item_conntrack_mask = {
+       .flags = 0xffffffff,
+};
+#endif
+
 /**
  * Matching pattern item definition.
  *
@@ -2328,6 +2392,23 @@ enum rte_flow_action_type {
         * or different ethdev ports.
         */
        RTE_FLOW_ACTION_TYPE_INDIRECT,
+
+       /**
+        * [META]
+        *
+        * Enable tracking a TCP connection state.
+        *
+        * @see struct rte_flow_action_conntrack.
+        */
+       RTE_FLOW_ACTION_TYPE_CONNTRACK,
+
+       /**
+        * Color the packet to reflect the meter color result.
+        * Set the meter color in the mbuf to the selected color.
+        *
+        * See struct rte_flow_action_meter_color.
+        */
+       RTE_FLOW_ACTION_TYPE_METER_COLOR,
 };
 
 /**
@@ -2926,6 +3007,167 @@ struct rte_flow_action_set_dscp {
  */
 struct rte_flow_action_handle;
 
+/**
+ * The state of a TCP connection.
+ */
+enum rte_flow_conntrack_state {
+       /** SYN-ACK packet was seen. */
+       RTE_FLOW_CONNTRACK_STATE_SYN_RECV,
+       /** 3-way handshake was done. */
+       RTE_FLOW_CONNTRACK_STATE_ESTABLISHED,
+       /** First FIN packet was received to close the connection. */
+       RTE_FLOW_CONNTRACK_STATE_FIN_WAIT,
+       /** First FIN was ACKed. */
+       RTE_FLOW_CONNTRACK_STATE_CLOSE_WAIT,
+       /** Second FIN was received, waiting for the last ACK. */
+       RTE_FLOW_CONNTRACK_STATE_LAST_ACK,
+       /** Second FIN was ACKed, connection was closed. */
+       RTE_FLOW_CONNTRACK_STATE_TIME_WAIT,
+};
+
+/**
+ * The last passed TCP packet flags of a connection.
+ */
+enum rte_flow_conntrack_tcp_last_index {
+       RTE_FLOW_CONNTRACK_FLAG_NONE = 0, /**< No Flag. */
+       RTE_FLOW_CONNTRACK_FLAG_SYN = RTE_BIT32(0), /**< With SYN flag. */
+       RTE_FLOW_CONNTRACK_FLAG_SYNACK = RTE_BIT32(1), /**< With SYNACK flag. */
+       RTE_FLOW_CONNTRACK_FLAG_FIN = RTE_BIT32(2), /**< With FIN flag. */
+       RTE_FLOW_CONNTRACK_FLAG_ACK = RTE_BIT32(3), /**< With ACK flag. */
+       RTE_FLOW_CONNTRACK_FLAG_RST = RTE_BIT32(4), /**< With RST flag. */
+};
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this structure may change without prior notice
+ *
+ * Configuration parameters for each direction of a TCP connection.
+ * All fields should be in host byte order.
+ * If needed, driver should convert all fields to network byte order
+ * if HW needs them in that way.
+ */
+struct rte_flow_tcp_dir_param {
+       /** TCP window scaling factor, 0xF to disable. */
+       uint32_t scale:4;
+       /** The FIN was sent by this direction. */
+       uint32_t close_initiated:1;
+       /** An ACK packet has been received by this side. */
+       uint32_t last_ack_seen:1;
+       /**
+        * If set, it indicates that there is unacknowledged data for the
+        * packets sent from this direction.
+        */
+       uint32_t data_unacked:1;
+       /**
+        * Maximal value of sequence + payload length in sent
+        * packets (next ACK from the opposite direction).
+        */
+       uint32_t sent_end;
+       /**
+        * Maximal value of (ACK + window size) in received packet + length
+        * over sent packet (maximal sequence could be sent).
+        */
+       uint32_t reply_end;
+       /** Maximal value of actual window size in sent packets. */
+       uint32_t max_win;
+       /** Maximal value of ACK in sent packets. */
+       uint32_t max_ack;
+};
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this structure may change without prior notice
+ *
+ * RTE_FLOW_ACTION_TYPE_CONNTRACK
+ *
+ * Configuration and initial state for the connection tracking module.
+ * This structure could be used for both setting and query.
+ * All fields should be in host byte order.
+ */
+struct rte_flow_action_conntrack {
+       /** The peer port number, can be the same port. */
+       uint16_t peer_port;
+       /**
+        * Direction of this connection when creating a flow rule, the
+        * value only affects the creation of subsequent flow rules.
+        */
+       uint32_t is_original_dir:1;
+       /**
+        * Enable / disable the conntrack HW module. When disabled, the
+        * result will always be RTE_FLOW_CONNTRACK_FLAG_DISABLED.
+        * In this state the HW will act as passthrough.
+        * It only affects this conntrack object in the HW without any effect
+        * to the other objects.
+        */
+       uint32_t enable:1;
+       /** At least one ack was seen after the connection was established. */
+       uint32_t live_connection:1;
+       /** Enable selective ACK on this connection. */
+       uint32_t selective_ack:1;
+       /** A challenge ack has passed. */
+       uint32_t challenge_ack_passed:1;
+       /**
+        * 1: The last packet is seen from the original direction.
+        * 0: The last packet is seen from the reply direction.
+        */
+       uint32_t last_direction:1;
+       /** No TCP check will be done except the state change. */
+       uint32_t liberal_mode:1;
+       /**<The current state of this connection. */
+       enum rte_flow_conntrack_state state;
+       /** Scaling factor for maximal allowed ACK window. */
+       uint8_t max_ack_window;
+       /** Maximal allowed number of retransmission times. */
+       uint8_t retransmission_limit;
+       /** TCP parameters of the original direction. */
+       struct rte_flow_tcp_dir_param original_dir;
+       /** TCP parameters of the reply direction. */
+       struct rte_flow_tcp_dir_param reply_dir;
+       /** The window value of the last packet passed this conntrack. */
+       uint16_t last_window;
+       enum rte_flow_conntrack_tcp_last_index last_index;
+       /** The sequence of the last packet passed this conntrack. */
+       uint32_t last_seq;
+       /** The acknowledgment of the last packet passed this conntrack. */
+       uint32_t last_ack;
+       /**
+        * The total value ACK + payload length of the last packet
+        * passed this conntrack.
+        */
+       uint32_t last_end;
+};
+
+/**
+ * RTE_FLOW_ACTION_TYPE_CONNTRACK
+ *
+ * Wrapper structure for the context update interface.
+ * Ports cannot support updating, and the only valid solution is to
+ * destroy the old context and create a new one instead.
+ */
+struct rte_flow_modify_conntrack {
+       /** New connection tracking parameters to be updated. */
+       struct rte_flow_action_conntrack new_ct;
+       /** The direction field will be updated. */
+       uint32_t direction:1;
+       /** All the other fields except direction will be updated. */
+       uint32_t state:1;
+       /** Reserved bits for the future usage. */
+       uint32_t reserved:30;
+};
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this structure may change without prior notice
+ *
+ * RTE_FLOW_ACTION_TYPE_METER_COLOR
+ *
+ * The meter color should be set in the packet meta-data
+ * (i.e. struct rte_mbuf::sched::color).
+ */
+struct rte_flow_action_meter_color {
+       enum rte_color color; /**< Packet color. */
+};
+
 /**
  * Field IDs for MODIFY_FIELD action.
  */
@@ -3036,7 +3278,7 @@ rte_flow_dynf_metadata_set(struct rte_mbuf *m, uint32_t v)
        *RTE_FLOW_DYNF_METADATA(m) = v;
 }
 
-/*
+/**
  * Definition of a single action.
  *
  * A list of actions is terminated by a END action.