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.
33 #include <rte_common.h>
34 #include <rte_config.h>
35 #include <rte_cryptodev_pmd.h>
37 #include <rte_malloc.h>
39 #include "null_crypto_pmd_private.h"
41 /** verify and set session parameters */
43 null_crypto_set_session_parameters(
44 struct null_crypto_session *sess __rte_unused,
45 const struct rte_crypto_sym_xform *xform)
49 } else if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH &&
50 xform->next == NULL) {
51 /* Authentication Only */
52 if (xform->auth.algo == RTE_CRYPTO_AUTH_NULL)
54 } else if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH &&
55 xform->next->type == RTE_CRYPTO_SYM_XFORM_CIPHER) {
56 /* Authentication then Cipher */
57 if (xform->auth.algo == RTE_CRYPTO_AUTH_NULL &&
58 xform->next->cipher.algo == RTE_CRYPTO_CIPHER_NULL)
60 } else if (xform->type == RTE_CRYPTO_SYM_XFORM_CIPHER &&
61 xform->next == NULL) {
63 if (xform->cipher.algo == RTE_CRYPTO_CIPHER_NULL)
65 } else if (xform->type == RTE_CRYPTO_SYM_XFORM_CIPHER &&
66 xform->next->type == RTE_CRYPTO_SYM_XFORM_AUTH) {
67 /* Cipher then Authentication */
68 if (xform->cipher.algo == RTE_CRYPTO_CIPHER_NULL &&
69 xform->next->auth.algo == RTE_CRYPTO_AUTH_NULL)
76 /** Process crypto operation for mbuf */
78 process_op(const struct null_crypto_qp *qp, struct rte_crypto_op *op,
79 struct null_crypto_session *sess __rte_unused)
81 /* set status as successful by default */
82 op->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
85 * if crypto session and operation are valid just enqueue the packet
86 * in the processed ring
88 return rte_ring_enqueue(qp->processed_pkts, (void *)op);
91 static struct null_crypto_session *
92 get_session(struct null_crypto_qp *qp, struct rte_crypto_sym_op *op)
94 struct null_crypto_session *sess;
96 if (op->sess_type == RTE_CRYPTO_SYM_OP_WITH_SESSION) {
97 if (unlikely(op->session == NULL ||
98 op->session->dev_type != RTE_CRYPTODEV_NULL_PMD))
101 sess = (struct null_crypto_session *)op->session->_private;
103 struct rte_cryptodev_session *c_sess = NULL;
105 if (rte_mempool_get(qp->sess_mp, (void **)&c_sess))
108 sess = (struct null_crypto_session *)c_sess->_private;
110 if (null_crypto_set_session_parameters(sess, op->xform) != 0)
119 null_crypto_pmd_enqueue_burst(void *queue_pair, struct rte_crypto_op **ops,
122 struct null_crypto_session *sess;
123 struct null_crypto_qp *qp = queue_pair;
127 for (i = 0; i < nb_ops; i++) {
128 sess = get_session(qp, ops[i]->sym);
129 if (unlikely(sess == NULL))
132 retval = process_op(qp, ops[i], sess);
133 if (unlikely(retval < 0))
137 qp->qp_stats.enqueued_count += i;
142 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
144 qp->qp_stats.enqueue_err_count++;
150 null_crypto_pmd_dequeue_burst(void *queue_pair, struct rte_crypto_op **ops,
153 struct null_crypto_qp *qp = queue_pair;
155 unsigned nb_dequeued;
157 nb_dequeued = rte_ring_dequeue_burst(qp->processed_pkts,
158 (void **)ops, nb_ops, NULL);
159 qp->qp_stats.dequeued_count += nb_dequeued;
164 static int cryptodev_null_remove(const char *name);
166 /** Create crypto device */
168 cryptodev_null_create(const char *name,
169 struct rte_crypto_vdev_init_params *init_params)
171 struct rte_cryptodev *dev;
172 struct null_crypto_private *internals;
174 if (init_params->name[0] == '\0')
175 snprintf(init_params->name, sizeof(init_params->name),
178 dev = rte_cryptodev_pmd_virtual_dev_init(init_params->name,
179 sizeof(struct null_crypto_private),
180 init_params->socket_id);
182 NULL_CRYPTO_LOG_ERR("failed to create cryptodev vdev");
186 dev->dev_type = RTE_CRYPTODEV_NULL_PMD;
187 dev->dev_ops = null_crypto_pmd_ops;
189 /* register rx/tx burst functions for data path */
190 dev->dequeue_burst = null_crypto_pmd_dequeue_burst;
191 dev->enqueue_burst = null_crypto_pmd_enqueue_burst;
193 dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
194 RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
195 RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER;
197 internals = dev->data->dev_private;
199 internals->max_nb_qpairs = init_params->max_nb_queue_pairs;
200 internals->max_nb_sessions = init_params->max_nb_sessions;
205 NULL_CRYPTO_LOG_ERR("driver %s: cryptodev_null_create failed",
207 cryptodev_null_remove(init_params->name);
212 /** Initialise null crypto device */
214 cryptodev_null_probe(struct rte_vdev_device *dev)
216 struct rte_crypto_vdev_init_params init_params = {
217 RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_QUEUE_PAIRS,
218 RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_SESSIONS,
224 name = rte_vdev_device_name(dev);
228 RTE_LOG(INFO, PMD, "Initialising %s on NUMA node %d\n",
229 name, init_params.socket_id);
230 if (init_params.name[0] != '\0')
231 RTE_LOG(INFO, PMD, " User defined name = %s\n",
233 RTE_LOG(INFO, PMD, " Max number of queue pairs = %d\n",
234 init_params.max_nb_queue_pairs);
235 RTE_LOG(INFO, PMD, " Max number of sessions = %d\n",
236 init_params.max_nb_sessions);
238 return cryptodev_null_create(name, &init_params);
241 /** Uninitialise null crypto device */
243 cryptodev_null_remove(const char *name)
248 RTE_LOG(INFO, PMD, "Closing null crypto device %s on numa socket %u\n",
249 name, rte_socket_id());
255 cryptodev_null_remove_dev(struct rte_vdev_device *dev)
257 return cryptodev_null_remove(rte_vdev_device_name(dev));
260 static struct rte_vdev_driver cryptodev_null_pmd_drv = {
261 .probe = cryptodev_null_probe,
262 .remove = cryptodev_null_remove_dev,
265 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_NULL_PMD, cryptodev_null_pmd_drv);
266 RTE_PMD_REGISTER_ALIAS(CRYPTODEV_NAME_NULL_PMD, cryptodev_null_pmd);
267 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_NULL_PMD,
268 "max_nb_queue_pairs=<int> "
269 "max_nb_sessions=<int> "