[v2,1/3] cryptodev: add API to get used queue pair depth
Checks
Commit Message
Added a new fast path API to get used queue pair
descriptors of a specific queue pair of a device.
Applications may monitor the depth used and enqueue
crypto ops accordingly.
Signed-off-by: Akhil Goyal <gakhil@marvell.com>
---
devtools/libabigail.abignore | 3 ++
lib/cryptodev/cryptodev_pmd.c | 1 +
lib/cryptodev/cryptodev_pmd.h | 2 ++
lib/cryptodev/cryptodev_trace_points.c | 3 ++
lib/cryptodev/rte_cryptodev.h | 45 ++++++++++++++++++++++++++
lib/cryptodev/rte_cryptodev_core.h | 7 +++-
lib/cryptodev/rte_cryptodev_trace_fp.h | 7 ++++
lib/cryptodev/version.map | 3 ++
8 files changed, 70 insertions(+), 1 deletion(-)
@@ -37,3 +37,6 @@
[suppress_type]
name = rte_eth_fp_ops
has_data_member_inserted_between = {offset_of(reserved2), end}
+[suppress_type]
+ name = rte_crypto_fp_ops
+ has_data_member_inserted_between = {offset_of(reserved), end}
@@ -236,6 +236,7 @@ cryptodev_fp_ops_set(struct rte_crypto_fp_ops *fp_ops,
fp_ops->qp.data = dev->data->queue_pairs;
fp_ops->qp.enq_cb = dev->enq_cbs;
fp_ops->qp.deq_cb = dev->deq_cbs;
+ fp_ops->qp_depth_used = dev->qp_depth_used;
}
void *
@@ -117,6 +117,8 @@ struct __rte_cache_aligned rte_cryptodev {
struct rte_cryptodev_cb_rcu *enq_cbs;
/** User application callback for post dequeue processing */
struct rte_cryptodev_cb_rcu *deq_cbs;
+ /** Pointer to PMD function to get used queue pair depth */
+ crypto_qp_depth_used_t qp_depth_used;
};
/** Global structure used for maintaining state of allocated crypto devices */
@@ -194,3 +194,6 @@ RTE_TRACE_POINT_REGISTER(rte_cryptodev_trace_op_pool_create,
RTE_TRACE_POINT_REGISTER(rte_cryptodev_trace_count,
lib.cryptodev.count)
+
+RTE_TRACE_POINT_REGISTER(rte_cryptodev_trace_qp_depth_used,
+ lib.cryptodev.qp_depth_used)
@@ -2005,6 +2005,51 @@ rte_cryptodev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
return fp_ops->enqueue_burst(qp, ops, nb_ops);
}
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
+ *
+ * Get the number of used descriptors or depth of a cryptodev queue pair.
+ *
+ * This function retrieves the number of used descriptors in a crypto queue.
+ * Applications can use this API in the fast path to inspect QP occupancy and
+ * take appropriate action.
+ *
+ * Since it is a fast-path function, no check is performed on dev_id and qp_id.
+ * Caller must therefore ensure that the device is enabled and queue pair is setup.
+ *
+ * @param dev_id The identifier of the device.
+ * @param qp_id The index of the queue pair for which used descriptor
+ * count is to be retrieved. The value
+ * must be in the range [0, nb_queue_pairs - 1]
+ * previously supplied to *rte_cryptodev_configure*.
+ *
+ * @return
+ * The number of used descriptors on the specified queue pair, or:
+ * - (-ENOTSUP) if the device does not support this function.
+ */
+
+__rte_experimental
+static inline int
+rte_cryptodev_qp_depth_used(uint8_t dev_id, uint16_t qp_id)
+{
+ const struct rte_crypto_fp_ops *fp_ops;
+ void *qp;
+ int rc;
+
+ fp_ops = &rte_crypto_fp_ops[dev_id];
+ qp = fp_ops->qp.data[qp_id];
+
+ if (fp_ops->qp_depth_used == NULL) {
+ rc = -ENOTSUP;
+ goto out;
+ }
+
+ rc = fp_ops->qp_depth_used(qp);
+out:
+ rte_cryptodev_trace_qp_depth_used(dev_id, qp_id);
+ return rc;
+}
#ifdef __cplusplus
@@ -24,6 +24,9 @@ typedef uint16_t (*enqueue_pkt_burst_t)(void *qp,
struct rte_crypto_op **ops, uint16_t nb_ops);
/**< Enqueue packets for processing on queue pair of a device. */
+typedef uint32_t (*crypto_qp_depth_used_t)(void *qp);
+/**< Get used descriptor depth in a queue pair of a device. */
+
/**
* @internal
* Structure used to hold opaque pointers to internal ethdev Rx/Tx
@@ -47,8 +50,10 @@ struct __rte_cache_aligned rte_crypto_fp_ops {
dequeue_pkt_burst_t dequeue_burst;
/** Internal queue pair data pointers. */
struct rte_cryptodev_qpdata qp;
+ /** Get the number of used queue pair descriptors. */
+ crypto_qp_depth_used_t qp_depth_used;
/** Reserved for future ops. */
- uintptr_t reserved[3];
+ uintptr_t reserved[2];
};
extern struct rte_crypto_fp_ops rte_crypto_fp_ops[RTE_CRYPTO_MAX_DEVS];
@@ -31,6 +31,13 @@ RTE_TRACE_POINT_FP(
rte_trace_point_emit_u16(nb_ops);
)
+RTE_TRACE_POINT_FP(
+ rte_cryptodev_trace_qp_depth_used,
+ RTE_TRACE_POINT_ARGS(uint8_t dev_id, uint16_t qp_id),
+ rte_trace_point_emit_u8(dev_id);
+ rte_trace_point_emit_u16(qp_id);
+)
+
#ifdef __cplusplus
}
#endif
@@ -84,6 +84,9 @@ EXPERIMENTAL {
rte_cryptodev_get_auth_algo_string;
rte_cryptodev_get_cipher_algo_string;
rte_cryptodev_queue_pair_event_error_query;
+
+ # added in 24.03
+ __rte_cryptodev_trace_qp_depth_used;
};
INTERNAL {