4 * Copyright(c) 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.
34 #include <rte_config.h>
35 #include <rte_common.h>
36 #include <rte_malloc.h>
38 #include <rte_cryptodev.h>
39 #include <rte_cryptodev_pmd.h>
40 #include <rte_reorder.h>
42 #include "scheduler_pmd_private.h"
44 /** Configure device */
46 scheduler_pmd_config(struct rte_cryptodev *dev,
47 struct rte_cryptodev_config *config)
49 struct scheduler_ctx *sched_ctx = dev->data->dev_private;
53 for (i = 0; i < sched_ctx->nb_slaves; i++) {
54 uint8_t slave_dev_id = sched_ctx->slaves[i].dev_id;
56 ret = rte_cryptodev_configure(slave_dev_id, config);
65 update_order_ring(struct rte_cryptodev *dev, uint16_t qp_id)
67 struct scheduler_ctx *sched_ctx = dev->data->dev_private;
68 struct scheduler_qp_ctx *qp_ctx = dev->data->queue_pairs[qp_id];
70 if (sched_ctx->reordering_enabled) {
71 char order_ring_name[RTE_CRYPTODEV_NAME_MAX_LEN];
72 uint32_t buff_size = rte_align32pow2(
73 sched_ctx->nb_slaves * PER_SLAVE_BUFF_SIZE);
75 if (qp_ctx->order_ring) {
76 rte_ring_free(qp_ctx->order_ring);
77 qp_ctx->order_ring = NULL;
83 if (snprintf(order_ring_name, RTE_CRYPTODEV_NAME_MAX_LEN,
84 "%s_rb_%u_%u", RTE_STR(CRYPTODEV_NAME_SCHEDULER_PMD),
85 dev->data->dev_id, qp_id) < 0) {
86 CS_LOG_ERR("failed to create unique reorder buffer "
91 qp_ctx->order_ring = rte_ring_create(order_ring_name,
92 buff_size, rte_socket_id(),
93 RING_F_SP_ENQ | RING_F_SC_DEQ);
94 if (!qp_ctx->order_ring) {
95 CS_LOG_ERR("failed to create order ring");
99 if (qp_ctx->order_ring) {
100 rte_ring_free(qp_ctx->order_ring);
101 qp_ctx->order_ring = NULL;
110 scheduler_pmd_start(struct rte_cryptodev *dev)
112 struct scheduler_ctx *sched_ctx = dev->data->dev_private;
116 if (dev->data->dev_started)
119 for (i = 0; i < dev->data->nb_queue_pairs; i++) {
120 ret = update_order_ring(dev, i);
122 CS_LOG_ERR("Failed to update reorder buffer");
127 if (sched_ctx->mode == CDEV_SCHED_MODE_NOT_SET) {
128 CS_LOG_ERR("Scheduler mode is not set");
132 if (!sched_ctx->nb_slaves) {
133 CS_LOG_ERR("No slave in the scheduler");
137 RTE_FUNC_PTR_OR_ERR_RET(*sched_ctx->ops.slave_attach, -ENOTSUP);
139 for (i = 0; i < sched_ctx->nb_slaves; i++) {
140 uint8_t slave_dev_id = sched_ctx->slaves[i].dev_id;
142 if ((*sched_ctx->ops.slave_attach)(dev, slave_dev_id) < 0) {
143 CS_LOG_ERR("Failed to attach slave");
148 RTE_FUNC_PTR_OR_ERR_RET(*sched_ctx->ops.scheduler_start, -ENOTSUP);
150 if ((*sched_ctx->ops.scheduler_start)(dev) < 0) {
151 CS_LOG_ERR("Scheduler start failed");
155 /* start all slaves */
156 for (i = 0; i < sched_ctx->nb_slaves; i++) {
157 uint8_t slave_dev_id = sched_ctx->slaves[i].dev_id;
158 struct rte_cryptodev *slave_dev =
159 rte_cryptodev_pmd_get_dev(slave_dev_id);
161 ret = (*slave_dev->dev_ops->dev_start)(slave_dev);
163 CS_LOG_ERR("Failed to start slave dev %u",
174 scheduler_pmd_stop(struct rte_cryptodev *dev)
176 struct scheduler_ctx *sched_ctx = dev->data->dev_private;
179 if (!dev->data->dev_started)
182 /* stop all slaves first */
183 for (i = 0; i < sched_ctx->nb_slaves; i++) {
184 uint8_t slave_dev_id = sched_ctx->slaves[i].dev_id;
185 struct rte_cryptodev *slave_dev =
186 rte_cryptodev_pmd_get_dev(slave_dev_id);
188 (*slave_dev->dev_ops->dev_stop)(slave_dev);
191 if (*sched_ctx->ops.scheduler_stop)
192 (*sched_ctx->ops.scheduler_stop)(dev);
194 for (i = 0; i < sched_ctx->nb_slaves; i++) {
195 uint8_t slave_dev_id = sched_ctx->slaves[i].dev_id;
197 if (*sched_ctx->ops.slave_detach)
198 (*sched_ctx->ops.slave_detach)(dev, slave_dev_id);
204 scheduler_pmd_close(struct rte_cryptodev *dev)
206 struct scheduler_ctx *sched_ctx = dev->data->dev_private;
210 /* the dev should be stopped before being closed */
211 if (dev->data->dev_started)
214 /* close all slaves first */
215 for (i = 0; i < sched_ctx->nb_slaves; i++) {
216 uint8_t slave_dev_id = sched_ctx->slaves[i].dev_id;
217 struct rte_cryptodev *slave_dev =
218 rte_cryptodev_pmd_get_dev(slave_dev_id);
220 ret = (*slave_dev->dev_ops->dev_close)(slave_dev);
225 for (i = 0; i < dev->data->nb_queue_pairs; i++) {
226 struct scheduler_qp_ctx *qp_ctx = dev->data->queue_pairs[i];
228 if (qp_ctx->order_ring) {
229 rte_ring_free(qp_ctx->order_ring);
230 qp_ctx->order_ring = NULL;
233 if (qp_ctx->private_qp_ctx) {
234 rte_free(qp_ctx->private_qp_ctx);
235 qp_ctx->private_qp_ctx = NULL;
239 if (sched_ctx->private_ctx)
240 rte_free(sched_ctx->private_ctx);
242 if (sched_ctx->capabilities)
243 rte_free(sched_ctx->capabilities);
248 /** Get device statistics */
250 scheduler_pmd_stats_get(struct rte_cryptodev *dev,
251 struct rte_cryptodev_stats *stats)
253 struct scheduler_ctx *sched_ctx = dev->data->dev_private;
256 for (i = 0; i < sched_ctx->nb_slaves; i++) {
257 uint8_t slave_dev_id = sched_ctx->slaves[i].dev_id;
258 struct rte_cryptodev *slave_dev =
259 rte_cryptodev_pmd_get_dev(slave_dev_id);
260 struct rte_cryptodev_stats slave_stats = {0};
262 (*slave_dev->dev_ops->stats_get)(slave_dev, &slave_stats);
264 stats->enqueued_count += slave_stats.enqueued_count;
265 stats->dequeued_count += slave_stats.dequeued_count;
267 stats->enqueue_err_count += slave_stats.enqueue_err_count;
268 stats->dequeue_err_count += slave_stats.dequeue_err_count;
272 /** Reset device statistics */
274 scheduler_pmd_stats_reset(struct rte_cryptodev *dev)
276 struct scheduler_ctx *sched_ctx = dev->data->dev_private;
279 for (i = 0; i < sched_ctx->nb_slaves; i++) {
280 uint8_t slave_dev_id = sched_ctx->slaves[i].dev_id;
281 struct rte_cryptodev *slave_dev =
282 rte_cryptodev_pmd_get_dev(slave_dev_id);
284 (*slave_dev->dev_ops->stats_reset)(slave_dev);
288 /** Get device info */
290 scheduler_pmd_info_get(struct rte_cryptodev *dev,
291 struct rte_cryptodev_info *dev_info)
293 struct scheduler_ctx *sched_ctx = dev->data->dev_private;
294 uint32_t max_nb_sessions = sched_ctx->nb_slaves ?
295 UINT32_MAX : RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_SESSIONS;
301 for (i = 0; i < sched_ctx->nb_slaves; i++) {
302 uint8_t slave_dev_id = sched_ctx->slaves[i].dev_id;
303 struct rte_cryptodev_info slave_info;
305 rte_cryptodev_info_get(slave_dev_id, &slave_info);
306 max_nb_sessions = slave_info.sym.max_nb_sessions <
308 slave_info.sym.max_nb_sessions :
312 dev_info->dev_type = dev->dev_type;
313 dev_info->feature_flags = dev->feature_flags;
314 dev_info->capabilities = sched_ctx->capabilities;
315 dev_info->max_nb_queue_pairs = sched_ctx->max_nb_queue_pairs;
316 dev_info->sym.max_nb_sessions = max_nb_sessions;
319 /** Release queue pair */
321 scheduler_pmd_qp_release(struct rte_cryptodev *dev, uint16_t qp_id)
323 struct scheduler_qp_ctx *qp_ctx = dev->data->queue_pairs[qp_id];
328 if (qp_ctx->order_ring)
329 rte_ring_free(qp_ctx->order_ring);
330 if (qp_ctx->private_qp_ctx)
331 rte_free(qp_ctx->private_qp_ctx);
334 dev->data->queue_pairs[qp_id] = NULL;
339 /** Setup a queue pair */
341 scheduler_pmd_qp_setup(struct rte_cryptodev *dev, uint16_t qp_id,
342 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id)
344 struct scheduler_ctx *sched_ctx = dev->data->dev_private;
345 struct scheduler_qp_ctx *qp_ctx;
346 char name[RTE_CRYPTODEV_NAME_MAX_LEN];
350 if (snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN,
351 "CRYTO_SCHE PMD %u QP %u",
352 dev->data->dev_id, qp_id) < 0) {
353 CS_LOG_ERR("Failed to create unique queue pair name");
357 /* Free memory prior to re-allocation if needed. */
358 if (dev->data->queue_pairs[qp_id] != NULL)
359 scheduler_pmd_qp_release(dev, qp_id);
361 for (i = 0; i < sched_ctx->nb_slaves; i++) {
362 uint8_t slave_id = sched_ctx->slaves[i].dev_id;
364 ret = rte_cryptodev_queue_pair_setup(slave_id, qp_id,
370 sched_ctx->qp_conf.nb_descriptors = qp_conf->nb_descriptors;
372 /* Allocate the queue pair data structure. */
373 qp_ctx = rte_zmalloc_socket(name, sizeof(*qp_ctx), RTE_CACHE_LINE_SIZE,
378 dev->data->queue_pairs[qp_id] = qp_ctx;
380 if (*sched_ctx->ops.config_queue_pair) {
381 if ((*sched_ctx->ops.config_queue_pair)(dev, qp_id) < 0) {
382 CS_LOG_ERR("Unable to configure queue pair");
390 /** Start queue pair */
392 scheduler_pmd_qp_start(__rte_unused struct rte_cryptodev *dev,
393 __rte_unused uint16_t queue_pair_id)
398 /** Stop queue pair */
400 scheduler_pmd_qp_stop(__rte_unused struct rte_cryptodev *dev,
401 __rte_unused uint16_t queue_pair_id)
406 /** Return the number of allocated queue pairs */
408 scheduler_pmd_qp_count(struct rte_cryptodev *dev)
410 return dev->data->nb_queue_pairs;
414 scheduler_pmd_session_get_size(struct rte_cryptodev *dev __rte_unused)
416 return sizeof(struct scheduler_session);
420 config_slave_sess(struct scheduler_ctx *sched_ctx,
421 struct rte_crypto_sym_xform *xform,
422 struct scheduler_session *sess,
427 for (i = 0; i < sched_ctx->nb_slaves; i++) {
428 struct scheduler_slave *slave = &sched_ctx->slaves[i];
429 struct rte_cryptodev *dev =
430 rte_cryptodev_pmd_get_dev(slave->dev_id);
432 if (sess->sessions[i]) {
436 (*dev->dev_ops->session_clear)(dev,
437 (void *)sess->sessions[i]);
438 sess->sessions[i] = NULL;
444 rte_cryptodev_sym_session_create(
445 slave->dev_id, xform);
446 if (!sess->sessions[i]) {
447 config_slave_sess(sched_ctx, NULL, sess, 0);
456 /** Clear the memory of session so it doesn't leave key material behind */
458 scheduler_pmd_session_clear(struct rte_cryptodev *dev,
461 struct scheduler_ctx *sched_ctx = dev->data->dev_private;
463 config_slave_sess(sched_ctx, NULL, sess, 0);
465 memset(sess, 0, sizeof(struct scheduler_session));
469 scheduler_pmd_session_configure(struct rte_cryptodev *dev,
470 struct rte_crypto_sym_xform *xform, void *sess)
472 struct scheduler_ctx *sched_ctx = dev->data->dev_private;
474 if (config_slave_sess(sched_ctx, xform, sess, 1) < 0) {
475 CS_LOG_ERR("unabled to config sym session");
482 struct rte_cryptodev_ops scheduler_pmd_ops = {
483 .dev_configure = scheduler_pmd_config,
484 .dev_start = scheduler_pmd_start,
485 .dev_stop = scheduler_pmd_stop,
486 .dev_close = scheduler_pmd_close,
488 .stats_get = scheduler_pmd_stats_get,
489 .stats_reset = scheduler_pmd_stats_reset,
491 .dev_infos_get = scheduler_pmd_info_get,
493 .queue_pair_setup = scheduler_pmd_qp_setup,
494 .queue_pair_release = scheduler_pmd_qp_release,
495 .queue_pair_start = scheduler_pmd_qp_start,
496 .queue_pair_stop = scheduler_pmd_qp_stop,
497 .queue_pair_count = scheduler_pmd_qp_count,
499 .session_get_size = scheduler_pmd_session_get_size,
500 .session_configure = scheduler_pmd_session_configure,
501 .session_clear = scheduler_pmd_session_clear,
504 struct rte_cryptodev_ops *rte_crypto_scheduler_pmd_ops = &scheduler_pmd_ops;