4 * Copyright(c) 2016-2017 Intel Corporation. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
16 * * Neither the name of Intel Corporation nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 #include <rte_common.h>
36 #include <rte_malloc.h>
37 #include <rte_cryptodev_pmd.h>
39 #include "null_crypto_pmd_private.h"
41 static const struct rte_cryptodev_capabilities null_crypto_pmd_capabilities[] = {
43 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
45 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
47 .algo = RTE_CRYPTO_AUTH_NULL,
65 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
67 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
69 .algo = RTE_CRYPTO_CIPHER_NULL,
80 RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
83 /** Configure device */
85 null_crypto_pmd_config(__rte_unused struct rte_cryptodev *dev,
86 __rte_unused struct rte_cryptodev_config *config)
93 null_crypto_pmd_start(__rte_unused struct rte_cryptodev *dev)
100 null_crypto_pmd_stop(__rte_unused struct rte_cryptodev *dev)
106 null_crypto_pmd_close(__rte_unused struct rte_cryptodev *dev)
111 /** Get device statistics */
113 null_crypto_pmd_stats_get(struct rte_cryptodev *dev,
114 struct rte_cryptodev_stats *stats)
118 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
119 struct null_crypto_qp *qp = dev->data->queue_pairs[qp_id];
121 stats->enqueued_count += qp->qp_stats.enqueued_count;
122 stats->dequeued_count += qp->qp_stats.dequeued_count;
124 stats->enqueue_err_count += qp->qp_stats.enqueue_err_count;
125 stats->dequeue_err_count += qp->qp_stats.dequeue_err_count;
129 /** Reset device statistics */
131 null_crypto_pmd_stats_reset(struct rte_cryptodev *dev)
135 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
136 struct null_crypto_qp *qp = dev->data->queue_pairs[qp_id];
138 memset(&qp->qp_stats, 0, sizeof(qp->qp_stats));
143 /** Get device info */
145 null_crypto_pmd_info_get(struct rte_cryptodev *dev,
146 struct rte_cryptodev_info *dev_info)
148 struct null_crypto_private *internals = dev->data->dev_private;
150 if (dev_info != NULL) {
151 dev_info->driver_id = dev->driver_id;
152 dev_info->max_nb_queue_pairs = internals->max_nb_qpairs;
153 dev_info->sym.max_nb_sessions = internals->max_nb_sessions;
154 dev_info->feature_flags = dev->feature_flags;
155 dev_info->capabilities = null_crypto_pmd_capabilities;
159 /** Release queue pair */
161 null_crypto_pmd_qp_release(struct rte_cryptodev *dev, uint16_t qp_id)
163 if (dev->data->queue_pairs[qp_id] != NULL) {
164 rte_free(dev->data->queue_pairs[qp_id]);
165 dev->data->queue_pairs[qp_id] = NULL;
170 /** set a unique name for the queue pair based on it's name, dev_id and qp_id */
172 null_crypto_pmd_qp_set_unique_name(struct rte_cryptodev *dev,
173 struct null_crypto_qp *qp)
175 unsigned n = snprintf(qp->name, sizeof(qp->name),
176 "null_crypto_pmd_%u_qp_%u",
177 dev->data->dev_id, qp->id);
179 if (n > sizeof(qp->name))
185 /** Create a ring to place process packets on */
186 static struct rte_ring *
187 null_crypto_pmd_qp_create_processed_pkts_ring(struct null_crypto_qp *qp,
188 unsigned ring_size, int socket_id)
192 r = rte_ring_lookup(qp->name);
194 if (rte_ring_get_size(r) >= ring_size) {
195 NULL_CRYPTO_LOG_INFO(
196 "Reusing existing ring %s for processed packets",
201 NULL_CRYPTO_LOG_INFO(
202 "Unable to reuse existing ring %s for processed packets",
207 return rte_ring_create(qp->name, ring_size, socket_id,
208 RING_F_SP_ENQ | RING_F_SC_DEQ);
211 /** Setup a queue pair */
213 null_crypto_pmd_qp_setup(struct rte_cryptodev *dev, uint16_t qp_id,
214 const struct rte_cryptodev_qp_conf *qp_conf,
215 int socket_id, struct rte_mempool *session_pool)
217 struct null_crypto_private *internals = dev->data->dev_private;
218 struct null_crypto_qp *qp;
221 if (qp_id >= internals->max_nb_qpairs) {
222 NULL_CRYPTO_LOG_ERR("Invalid qp_id %u, greater than maximum "
223 "number of queue pairs supported (%u).",
224 qp_id, internals->max_nb_qpairs);
228 /* Free memory prior to re-allocation if needed. */
229 if (dev->data->queue_pairs[qp_id] != NULL)
230 null_crypto_pmd_qp_release(dev, qp_id);
232 /* Allocate the queue pair data structure. */
233 qp = rte_zmalloc_socket("Null Crypto PMD Queue Pair", sizeof(*qp),
234 RTE_CACHE_LINE_SIZE, socket_id);
236 NULL_CRYPTO_LOG_ERR("Failed to allocate queue pair memory");
241 dev->data->queue_pairs[qp_id] = qp;
243 retval = null_crypto_pmd_qp_set_unique_name(dev, qp);
245 NULL_CRYPTO_LOG_ERR("Failed to create unique name for null "
247 goto qp_setup_cleanup;
250 qp->processed_pkts = null_crypto_pmd_qp_create_processed_pkts_ring(qp,
251 qp_conf->nb_descriptors, socket_id);
252 if (qp->processed_pkts == NULL) {
253 NULL_CRYPTO_LOG_ERR("Failed to create unique name for null "
255 goto qp_setup_cleanup;
258 qp->sess_mp = session_pool;
260 memset(&qp->qp_stats, 0, sizeof(qp->qp_stats));
271 /** Start queue pair */
273 null_crypto_pmd_qp_start(__rte_unused struct rte_cryptodev *dev,
274 __rte_unused uint16_t queue_pair_id)
279 /** Stop queue pair */
281 null_crypto_pmd_qp_stop(__rte_unused struct rte_cryptodev *dev,
282 __rte_unused uint16_t queue_pair_id)
287 /** Return the number of allocated queue pairs */
289 null_crypto_pmd_qp_count(struct rte_cryptodev *dev)
291 return dev->data->nb_queue_pairs;
294 /** Returns the size of the NULL crypto session structure */
296 null_crypto_pmd_session_get_size(struct rte_cryptodev *dev __rte_unused)
298 return sizeof(struct null_crypto_session);
301 /** Configure a null crypto session from a crypto xform chain */
303 null_crypto_pmd_session_configure(struct rte_cryptodev *dev __rte_unused,
304 struct rte_crypto_sym_xform *xform,
305 struct rte_cryptodev_sym_session *sess,
306 struct rte_mempool *mp)
308 void *sess_private_data;
310 if (unlikely(sess == NULL)) {
311 NULL_CRYPTO_LOG_ERR("invalid session struct");
315 if (rte_mempool_get(mp, &sess_private_data)) {
317 "Couldn't get object from session mempool");
321 if (null_crypto_set_session_parameters(sess_private_data, xform) != 0) {
322 NULL_CRYPTO_LOG_ERR("failed configure session parameters");
324 /* Return session to mempool */
325 rte_mempool_put(mp, sess_private_data);
329 set_session_private_data(sess, dev->driver_id,
335 /** Clear the memory of session so it doesn't leave key material behind */
337 null_crypto_pmd_session_clear(struct rte_cryptodev *dev,
338 struct rte_cryptodev_sym_session *sess)
340 uint8_t index = dev->driver_id;
341 void *sess_priv = get_session_private_data(sess, index);
343 /* Zero out the whole structure */
345 memset(sess_priv, 0, sizeof(struct null_crypto_session));
346 struct rte_mempool *sess_mp = rte_mempool_from_obj(sess_priv);
347 set_session_private_data(sess, index, NULL);
348 rte_mempool_put(sess_mp, sess_priv);
352 struct rte_cryptodev_ops pmd_ops = {
353 .dev_configure = null_crypto_pmd_config,
354 .dev_start = null_crypto_pmd_start,
355 .dev_stop = null_crypto_pmd_stop,
356 .dev_close = null_crypto_pmd_close,
358 .stats_get = null_crypto_pmd_stats_get,
359 .stats_reset = null_crypto_pmd_stats_reset,
361 .dev_infos_get = null_crypto_pmd_info_get,
363 .queue_pair_setup = null_crypto_pmd_qp_setup,
364 .queue_pair_release = null_crypto_pmd_qp_release,
365 .queue_pair_start = null_crypto_pmd_qp_start,
366 .queue_pair_stop = null_crypto_pmd_qp_stop,
367 .queue_pair_count = null_crypto_pmd_qp_count,
369 .session_get_size = null_crypto_pmd_session_get_size,
370 .session_configure = null_crypto_pmd_session_configure,
371 .session_clear = null_crypto_pmd_session_clear
374 struct rte_cryptodev_ops *null_crypto_pmd_ops = &pmd_ops;