4 * Copyright(c) 2016 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 "aesni_gcm_pmd_private.h"
41 static const struct rte_cryptodev_capabilities aesni_gcm_pmd_capabilities[] = {
42 { /* AES GMAC (AUTH) */
43 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
45 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
47 .algo = RTE_CRYPTO_AUTH_AES_GMAC,
68 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
70 .xform_type = RTE_CRYPTO_SYM_XFORM_AEAD,
72 .algo = RTE_CRYPTO_AEAD_AES_GCM,
97 RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
100 /** Configure device */
102 aesni_gcm_pmd_config(__rte_unused struct rte_cryptodev *dev,
103 __rte_unused struct rte_cryptodev_config *config)
110 aesni_gcm_pmd_start(__rte_unused struct rte_cryptodev *dev)
117 aesni_gcm_pmd_stop(__rte_unused struct rte_cryptodev *dev)
123 aesni_gcm_pmd_close(__rte_unused struct rte_cryptodev *dev)
129 /** Get device statistics */
131 aesni_gcm_pmd_stats_get(struct rte_cryptodev *dev,
132 struct rte_cryptodev_stats *stats)
136 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
137 struct aesni_gcm_qp *qp = dev->data->queue_pairs[qp_id];
139 stats->enqueued_count += qp->qp_stats.enqueued_count;
140 stats->dequeued_count += qp->qp_stats.dequeued_count;
142 stats->enqueue_err_count += qp->qp_stats.enqueue_err_count;
143 stats->dequeue_err_count += qp->qp_stats.dequeue_err_count;
147 /** Reset device statistics */
149 aesni_gcm_pmd_stats_reset(struct rte_cryptodev *dev)
153 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
154 struct aesni_gcm_qp *qp = dev->data->queue_pairs[qp_id];
156 memset(&qp->qp_stats, 0, sizeof(qp->qp_stats));
161 /** Get device info */
163 aesni_gcm_pmd_info_get(struct rte_cryptodev *dev,
164 struct rte_cryptodev_info *dev_info)
166 struct aesni_gcm_private *internals = dev->data->dev_private;
168 if (dev_info != NULL) {
169 dev_info->driver_id = dev->driver_id;
170 dev_info->feature_flags = dev->feature_flags;
171 dev_info->capabilities = aesni_gcm_pmd_capabilities;
173 dev_info->max_nb_queue_pairs = internals->max_nb_queue_pairs;
174 dev_info->sym.max_nb_sessions = internals->max_nb_sessions;
178 /** Release queue pair */
180 aesni_gcm_pmd_qp_release(struct rte_cryptodev *dev, uint16_t qp_id)
182 if (dev->data->queue_pairs[qp_id] != NULL) {
183 rte_free(dev->data->queue_pairs[qp_id]);
184 dev->data->queue_pairs[qp_id] = NULL;
189 /** set a unique name for the queue pair based on it's name, dev_id and qp_id */
191 aesni_gcm_pmd_qp_set_unique_name(struct rte_cryptodev *dev,
192 struct aesni_gcm_qp *qp)
194 unsigned n = snprintf(qp->name, sizeof(qp->name),
195 "aesni_gcm_pmd_%u_qp_%u",
196 dev->data->dev_id, qp->id);
198 if (n >= sizeof(qp->name))
204 /** Create a ring to place process packets on */
205 static struct rte_ring *
206 aesni_gcm_pmd_qp_create_processed_pkts_ring(struct aesni_gcm_qp *qp,
207 unsigned ring_size, int socket_id)
211 r = rte_ring_lookup(qp->name);
213 if (rte_ring_get_size(r) >= ring_size) {
214 GCM_LOG_INFO("Reusing existing ring %s for processed"
215 " packets", qp->name);
219 GCM_LOG_ERR("Unable to reuse existing ring %s for processed"
220 " packets", qp->name);
224 return rte_ring_create(qp->name, ring_size, socket_id,
225 RING_F_SP_ENQ | RING_F_SC_DEQ);
228 /** Setup a queue pair */
230 aesni_gcm_pmd_qp_setup(struct rte_cryptodev *dev, uint16_t qp_id,
231 const struct rte_cryptodev_qp_conf *qp_conf,
232 int socket_id, struct rte_mempool *session_pool)
234 struct aesni_gcm_qp *qp = NULL;
235 struct aesni_gcm_private *internals = dev->data->dev_private;
237 /* Free memory prior to re-allocation if needed. */
238 if (dev->data->queue_pairs[qp_id] != NULL)
239 aesni_gcm_pmd_qp_release(dev, qp_id);
241 /* Allocate the queue pair data structure. */
242 qp = rte_zmalloc_socket("AES-NI PMD Queue Pair", sizeof(*qp),
243 RTE_CACHE_LINE_SIZE, socket_id);
248 dev->data->queue_pairs[qp_id] = qp;
250 if (aesni_gcm_pmd_qp_set_unique_name(dev, qp))
251 goto qp_setup_cleanup;
253 qp->ops = (const struct aesni_gcm_ops *)gcm_ops[internals->vector_mode];
255 qp->processed_pkts = aesni_gcm_pmd_qp_create_processed_pkts_ring(qp,
256 qp_conf->nb_descriptors, socket_id);
257 if (qp->processed_pkts == NULL)
258 goto qp_setup_cleanup;
260 qp->sess_mp = session_pool;
262 memset(&qp->qp_stats, 0, sizeof(qp->qp_stats));
273 /** Start queue pair */
275 aesni_gcm_pmd_qp_start(__rte_unused struct rte_cryptodev *dev,
276 __rte_unused uint16_t queue_pair_id)
281 /** Stop queue pair */
283 aesni_gcm_pmd_qp_stop(__rte_unused struct rte_cryptodev *dev,
284 __rte_unused uint16_t queue_pair_id)
289 /** Return the number of allocated queue pairs */
291 aesni_gcm_pmd_qp_count(struct rte_cryptodev *dev)
293 return dev->data->nb_queue_pairs;
296 /** Returns the size of the aesni gcm session structure */
298 aesni_gcm_pmd_session_get_size(struct rte_cryptodev *dev __rte_unused)
300 return sizeof(struct aesni_gcm_session);
303 /** Configure a aesni gcm session from a crypto xform chain */
305 aesni_gcm_pmd_session_configure(struct rte_cryptodev *dev __rte_unused,
306 struct rte_crypto_sym_xform *xform,
307 struct rte_cryptodev_sym_session *sess,
308 struct rte_mempool *mempool)
310 void *sess_private_data;
312 struct aesni_gcm_private *internals = dev->data->dev_private;
314 if (unlikely(sess == NULL)) {
315 GCM_LOG_ERR("invalid session struct");
319 if (rte_mempool_get(mempool, &sess_private_data)) {
321 "Couldn't get object from session mempool");
324 ret = aesni_gcm_set_session_parameters(gcm_ops[internals->vector_mode],
325 sess_private_data, xform);
327 GCM_LOG_ERR("failed configure session parameters");
329 /* Return session to mempool */
330 rte_mempool_put(mempool, sess_private_data);
334 set_session_private_data(sess, dev->driver_id,
340 /** Clear the memory of session so it doesn't leave key material behind */
342 aesni_gcm_pmd_session_clear(struct rte_cryptodev *dev,
343 struct rte_cryptodev_sym_session *sess)
345 uint8_t index = dev->driver_id;
346 void *sess_priv = get_session_private_data(sess, index);
348 /* Zero out the whole structure */
350 memset(sess_priv, 0, sizeof(struct aesni_gcm_session));
351 struct rte_mempool *sess_mp = rte_mempool_from_obj(sess_priv);
352 set_session_private_data(sess, index, NULL);
353 rte_mempool_put(sess_mp, sess_priv);
357 struct rte_cryptodev_ops aesni_gcm_pmd_ops = {
358 .dev_configure = aesni_gcm_pmd_config,
359 .dev_start = aesni_gcm_pmd_start,
360 .dev_stop = aesni_gcm_pmd_stop,
361 .dev_close = aesni_gcm_pmd_close,
363 .stats_get = aesni_gcm_pmd_stats_get,
364 .stats_reset = aesni_gcm_pmd_stats_reset,
366 .dev_infos_get = aesni_gcm_pmd_info_get,
368 .queue_pair_setup = aesni_gcm_pmd_qp_setup,
369 .queue_pair_release = aesni_gcm_pmd_qp_release,
370 .queue_pair_start = aesni_gcm_pmd_qp_start,
371 .queue_pair_stop = aesni_gcm_pmd_qp_stop,
372 .queue_pair_count = aesni_gcm_pmd_qp_count,
374 .session_get_size = aesni_gcm_pmd_session_get_size,
375 .session_configure = aesni_gcm_pmd_session_configure,
376 .session_clear = aesni_gcm_pmd_session_clear
379 struct rte_cryptodev_ops *rte_aesni_gcm_pmd_ops = &aesni_gcm_pmd_ops;