drivers/crypto/null/null_crypto_pmd.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2016-2017 Intel Corporation
   3  */
   4
   5 #include <rte_common.h>
   6 #include <rte_cryptodev_pmd.h>
   7 #include <rte_bus_vdev.h>
   8 #include <rte_malloc.h>
   9
  10 #include "null_crypto_pmd_private.h"
  11
  12 static uint8_t cryptodev_driver_id;
  13
  14 /** verify and set session parameters */
  15 int
  16 null_crypto_set_session_parameters(
  17                 struct null_crypto_session *sess __rte_unused,
  18                 const struct rte_crypto_sym_xform *xform)
  19 {
  20         if (xform == NULL) {
  21                 return -EINVAL;
  22         } else if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH &&
  23                         xform->next == NULL) {
  24                 /* Authentication Only */
  25                 if (xform->auth.algo == RTE_CRYPTO_AUTH_NULL)
  26                         return 0;
  27         } else if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH &&
  28                         xform->next->type == RTE_CRYPTO_SYM_XFORM_CIPHER) {
  29                 /* Authentication then Cipher */
  30                 if (xform->auth.algo == RTE_CRYPTO_AUTH_NULL &&
  31                         xform->next->cipher.algo == RTE_CRYPTO_CIPHER_NULL)
  32                         return 0;
  33         } else if (xform->type == RTE_CRYPTO_SYM_XFORM_CIPHER &&
  34                         xform->next == NULL) {
  35                 /* Cipher Only */
  36                 if (xform->cipher.algo == RTE_CRYPTO_CIPHER_NULL)
  37                         return 0;
  38         } else if (xform->type == RTE_CRYPTO_SYM_XFORM_CIPHER &&
  39                         xform->next->type == RTE_CRYPTO_SYM_XFORM_AUTH) {
  40                 /* Cipher then Authentication */
  41                 if (xform->cipher.algo == RTE_CRYPTO_CIPHER_NULL &&
  42                         xform->next->auth.algo == RTE_CRYPTO_AUTH_NULL)
  43                         return 0;
  44         }
  45
  46         return -ENOTSUP;
  47 }
  48
  49 /** Process crypto operation for mbuf */
  50 static int
  51 process_op(const struct null_crypto_qp *qp, struct rte_crypto_op *op,
  52                 struct null_crypto_session *sess __rte_unused)
  53 {
  54         /* set status as successful by default */
  55         op->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
  56
  57         /* Free session if a session-less crypto op. */
  58         if (op->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
  59                 memset(op->sym->session, 0,
  60                                 sizeof(struct null_crypto_session));
  61                 rte_cryptodev_sym_session_free(op->sym->session);
  62                 op->sym->session = NULL;
  63         }
  64
  65         /*
  66          * if crypto session and operation are valid just enqueue the packet
  67          * in the processed ring
  68          */
  69         return rte_ring_enqueue(qp->processed_pkts, (void *)op);
  70 }
  71
  72 static struct null_crypto_session *
  73 get_session(struct null_crypto_qp *qp, struct rte_crypto_op *op)
  74 {
  75         struct null_crypto_session *sess = NULL;
  76         struct rte_crypto_sym_op *sym_op = op->sym;
  77
  78         if (op->sess_type == RTE_CRYPTO_OP_WITH_SESSION) {
  79                 if (likely(sym_op->session != NULL))
  80                         sess = (struct null_crypto_session *)
  81                                         get_session_private_data(
  82                                         sym_op->session, cryptodev_driver_id);
  83         } else {
  84                 void *_sess = NULL;
  85                 void *_sess_private_data = NULL;
  86
  87                 if (rte_mempool_get(qp->sess_mp, (void **)&_sess))
  88                         return NULL;
  89
  90                 if (rte_mempool_get(qp->sess_mp, (void **)&_sess_private_data))
  91                         return NULL;
  92
  93                 sess = (struct null_crypto_session *)_sess_private_data;
  94
  95                 if (unlikely(null_crypto_set_session_parameters(sess,
  96                                 sym_op->xform) != 0)) {
  97                         rte_mempool_put(qp->sess_mp, _sess);
  98                         rte_mempool_put(qp->sess_mp, _sess_private_data);
  99                         sess = NULL;
 100                 }
 101                 sym_op->session = (struct rte_cryptodev_sym_session *)_sess;
 102                 set_session_private_data(sym_op->session, cryptodev_driver_id,
 103                         _sess_private_data);
 104         }
 105
 106         return sess;
 107 }
 108
 109 /** Enqueue burst */
 110 static uint16_t
 111 null_crypto_pmd_enqueue_burst(void *queue_pair, struct rte_crypto_op **ops,
 112                 uint16_t nb_ops)
 113 {
 114         struct null_crypto_session *sess;
 115         struct null_crypto_qp *qp = queue_pair;
 116
 117         int i, retval;
 118
 119         for (i = 0; i < nb_ops; i++) {
 120                 sess = get_session(qp, ops[i]);
 121                 if (unlikely(sess == NULL))
 122                         goto enqueue_err;
 123
 124                 retval = process_op(qp, ops[i], sess);
 125                 if (unlikely(retval < 0))
 126                         goto enqueue_err;
 127         }
 128
 129         qp->qp_stats.enqueued_count += i;
 130         return i;
 131
 132 enqueue_err:
 133         if (ops[i])
 134                 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
 135
 136         qp->qp_stats.enqueue_err_count++;
 137         return i;
 138 }
 139
 140 /** Dequeue burst */
 141 static uint16_t
 142 null_crypto_pmd_dequeue_burst(void *queue_pair, struct rte_crypto_op **ops,
 143                 uint16_t nb_ops)
 144 {
 145         struct null_crypto_qp *qp = queue_pair;
 146
 147         unsigned nb_dequeued;
 148
 149         nb_dequeued = rte_ring_dequeue_burst(qp->processed_pkts,
 150                         (void **)ops, nb_ops, NULL);
 151         qp->qp_stats.dequeued_count += nb_dequeued;
 152
 153         return nb_dequeued;
 154 }
 155
 156 /** Create crypto device */
 157 static int
 158 cryptodev_null_create(const char *name,
 159                 struct rte_vdev_device *vdev,
 160                 struct rte_cryptodev_pmd_init_params *init_params)
 161 {
 162         struct rte_cryptodev *dev;
 163         struct null_crypto_private *internals;
 164
 165         dev = rte_cryptodev_pmd_create(name, &vdev->device, init_params);
 166         if (dev == NULL) {
 167                 NULL_CRYPTO_LOG_ERR("failed to create cryptodev vdev");
 168                 return -EFAULT;
 169         }
 170
 171         dev->driver_id = cryptodev_driver_id;
 172         dev->dev_ops = null_crypto_pmd_ops;
 173
 174         /* register rx/tx burst functions for data path */
 175         dev->dequeue_burst = null_crypto_pmd_dequeue_burst;
 176         dev->enqueue_burst = null_crypto_pmd_enqueue_burst;
 177
 178         dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
 179                         RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
 180                         RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER;
 181
 182         internals = dev->data->dev_private;
 183
 184         internals->max_nb_qpairs = init_params->max_nb_queue_pairs;
 185         internals->max_nb_sessions = init_params->max_nb_sessions;
 186
 187         return 0;
 188 }
 189
 190 /** Initialise null crypto device */
 191 static int
 192 cryptodev_null_probe(struct rte_vdev_device *dev)
 193 {
 194         struct rte_cryptodev_pmd_init_params init_params = {
 195                 "",
 196                 sizeof(struct null_crypto_private),
 197                 rte_socket_id(),
 198                 RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_QUEUE_PAIRS,
 199                 RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_SESSIONS
 200         };
 201         const char *name, *args;
 202         int retval;
 203
 204         name = rte_vdev_device_name(dev);
 205         if (name == NULL)
 206                 return -EINVAL;
 207
 208         args = rte_vdev_device_args(dev);
 209
 210         retval = rte_cryptodev_pmd_parse_input_args(&init_params, args);
 211         if (retval) {
 212                 RTE_LOG(ERR, PMD,
 213                         "Failed to parse initialisation arguments[%s]\n", args);
 214                 return -EINVAL;
 215         }
 216
 217         return cryptodev_null_create(name, dev, &init_params);
 218 }
 219
 220 static int
 221 cryptodev_null_remove_dev(struct rte_vdev_device *vdev)
 222 {
 223         struct rte_cryptodev *cryptodev;
 224         const char *name;
 225
 226         name = rte_vdev_device_name(vdev);
 227         if (name == NULL)
 228                 return -EINVAL;
 229
 230         cryptodev = rte_cryptodev_pmd_get_named_dev(name);
 231         if (cryptodev == NULL)
 232                 return -ENODEV;
 233
 234         return rte_cryptodev_pmd_destroy(cryptodev);
 235 }
 236
 237 static struct rte_vdev_driver cryptodev_null_pmd_drv = {
 238         .probe = cryptodev_null_probe,
 239         .remove = cryptodev_null_remove_dev,
 240 };
 241
 242 static struct cryptodev_driver null_crypto_drv;
 243
 244 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_NULL_PMD, cryptodev_null_pmd_drv);
 245 RTE_PMD_REGISTER_ALIAS(CRYPTODEV_NAME_NULL_PMD, cryptodev_null_pmd);
 246 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_NULL_PMD,
 247         "max_nb_queue_pairs=<int> "
 248         "max_nb_sessions=<int> "
 249         "socket_id=<int>");
 250 RTE_PMD_REGISTER_CRYPTO_DRIVER(null_crypto_drv, cryptodev_null_pmd_drv,
 251                 cryptodev_driver_id);