examples/fips_validation: support scatter gather list

This patch adds SGL support to FIPS sample application.
Originally the application allocates single mbuf of 64KB - 1
bytes data room. With the change the user may reduce the
mbuf dataroom size by using the add cmdline option. If the
input test data is longer than the user provided data room
size the application will automatically build chained mbufs
for the target cryptodev PMD to test.

Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
Acked-by: John Griffin <john.griffin@intel.com>
This commit is contained in:
Fan Zhang 2020-10-09 21:08:21 +01:00 committed by Akhil Goyal
parent 8bd98b8d85
commit 952e10cdad
4 changed files with 280 additions and 125 deletions

View File

@ -238,6 +238,10 @@ New Features
* Added support to update subport rate dynamically.
* **Updated FIPS validation sample application.**
* Added scatter gather support.
Removed Items
-------------

View File

@ -96,6 +96,7 @@ The application requires a number of command line options:
-- --req-file FILE_PATH/FOLDER_PATH
--rsp-file FILE_PATH/FOLDER_PATH
[--cryptodev DEVICE_NAME] [--cryptodev-id ID] [--path-is-folder]
--mbuf-dataroom DATAROOM_SIZE
where,
* req-file: The path of the request file or folder, separated by
@ -111,6 +112,11 @@ where,
* path-is-folder: If presented the application expects req-file and rsp-file
are folder paths.
* mbuf-dataroom: By default the application creates mbuf pool with maximum
possible data room (65535 bytes). If the user wants to test scatter-gather
list feature of the PMD he or she may set this value to reduce the dataroom
size so that the input data may be dividied into multiple chained mbufs.
To run the application in linux environment to test one AES FIPS test data
file for crypto_aesni_mb PMD, issue the command:

View File

@ -12,7 +12,8 @@
#define MAX_CASE_LINE 15
#define MAX_LINE_CHAR 204800 /*< max number of characters per line */
#define MAX_NB_TESTS 10240
#define MAX_BUF_SIZE 2048
#define DEF_MBUF_SEG_SIZE (UINT16_MAX - sizeof(struct rte_mbuf) - \
RTE_PKTMBUF_HEADROOM)
#define MAX_STRING_SIZE 64
#define MAX_FILE_NAME_SIZE 256
#define MAX_DIGEST_SIZE 64

View File

@ -17,6 +17,7 @@
#define REQ_FILE_PATH_KEYWORD "req-file"
#define RSP_FILE_PATH_KEYWORD "rsp-file"
#define MBUF_DATAROOM_KEYWORD "mbuf-dataroom"
#define FOLDER_KEYWORD "path-is-folder"
#define CRYPTODEV_KEYWORD "cryptodev"
#define CRYPTODEV_ID_KEYWORD "cryptodev-id"
@ -33,15 +34,19 @@ struct cryptodev_fips_validate_env {
const char *req_path;
const char *rsp_path;
uint32_t is_path_folder;
uint32_t dev_id;
uint8_t dev_id;
uint8_t dev_support_sgl;
uint16_t mbuf_data_room;
struct rte_mempool *mpool;
struct rte_mempool *sess_mpool;
struct rte_mempool *sess_priv_mpool;
struct rte_mempool *op_pool;
struct rte_mbuf *mbuf;
uint8_t *digest;
uint16_t digest_len;
struct rte_crypto_op *op;
struct rte_cryptodev_sym_session *sess;
uint32_t self_test;
uint16_t self_test;
struct fips_dev_broken_test_config *broken_test_config;
} env;
@ -50,8 +55,10 @@ cryptodev_fips_validate_app_int(void)
{
struct rte_cryptodev_config conf = {rte_socket_id(), 1, 0};
struct rte_cryptodev_qp_conf qp_conf = {128, NULL, NULL};
struct rte_cryptodev_info dev_info;
uint32_t sess_sz = rte_cryptodev_sym_get_private_session_size(
env.dev_id);
uint32_t nb_mbufs = UINT16_MAX / env.mbuf_data_room + 1;
int ret;
if (env.self_test) {
@ -70,8 +77,15 @@ cryptodev_fips_validate_app_int(void)
if (ret < 0)
return ret;
env.mpool = rte_pktmbuf_pool_create("FIPS_MEMPOOL", 128, 0, 0,
UINT16_MAX, rte_socket_id());
rte_cryptodev_info_get(env.dev_id, &dev_info);
if (dev_info.feature_flags & RTE_CRYPTODEV_FF_IN_PLACE_SGL)
env.dev_support_sgl = 1;
else
env.dev_support_sgl = 0;
env.mpool = rte_pktmbuf_pool_create("FIPS_MEMPOOL", nb_mbufs,
0, 0, sizeof(struct rte_mbuf) + RTE_PKTMBUF_HEADROOM +
env.mbuf_data_room, rte_socket_id());
if (!env.mpool)
return ret;
@ -102,10 +116,6 @@ cryptodev_fips_validate_app_int(void)
if (!env.op_pool)
goto error_exit;
env.mbuf = rte_pktmbuf_alloc(env.mpool);
if (!env.mbuf)
goto error_exit;
env.op = rte_crypto_op_alloc(env.op_pool, RTE_CRYPTO_OP_TYPE_SYMMETRIC);
if (!env.op)
goto error_exit;
@ -160,7 +170,7 @@ parse_cryptodev_arg(char *arg)
return id;
}
env.dev_id = (uint32_t)id;
env.dev_id = (uint8_t)id;
return 0;
}
@ -183,7 +193,7 @@ parse_cryptodev_id_arg(char *arg)
return -1;
}
env.dev_id = (uint32_t)cryptodev_id;
env.dev_id = (uint8_t)cryptodev_id;
return 0;
}
@ -191,19 +201,21 @@ parse_cryptodev_id_arg(char *arg)
static void
cryptodev_fips_validate_usage(const char *prgname)
{
uint32_t def_mbuf_seg_size = DEF_MBUF_SEG_SIZE;
printf("%s [EAL options] --\n"
" --%s: REQUEST-FILE-PATH\n"
" --%s: RESPONSE-FILE-PATH\n"
" --%s: indicating both paths are folders\n"
" --%s: mbuf dataroom size (default %u bytes)\n"
" --%s: CRYPTODEV-NAME\n"
" --%s: CRYPTODEV-ID-NAME\n"
" --%s: self test indicator\n"
" --%s: self broken test ID\n"
" --%s: self broken test direction\n",
prgname, REQ_FILE_PATH_KEYWORD, RSP_FILE_PATH_KEYWORD,
FOLDER_KEYWORD, CRYPTODEV_KEYWORD, CRYPTODEV_ID_KEYWORD,
CRYPTODEV_ST_KEYWORD, CRYPTODEV_BK_ID_KEYWORD,
CRYPTODEV_BK_DIR_KEY);
FOLDER_KEYWORD, MBUF_DATAROOM_KEYWORD, def_mbuf_seg_size,
CRYPTODEV_KEYWORD, CRYPTODEV_ID_KEYWORD, CRYPTODEV_ST_KEYWORD,
CRYPTODEV_BK_ID_KEYWORD, CRYPTODEV_BK_DIR_KEY);
}
static int
@ -217,6 +229,7 @@ cryptodev_fips_validate_parse_args(int argc, char **argv)
{REQ_FILE_PATH_KEYWORD, required_argument, 0, 0},
{RSP_FILE_PATH_KEYWORD, required_argument, 0, 0},
{FOLDER_KEYWORD, no_argument, 0, 0},
{MBUF_DATAROOM_KEYWORD, required_argument, 0, 0},
{CRYPTODEV_KEYWORD, required_argument, 0, 0},
{CRYPTODEV_ID_KEYWORD, required_argument, 0, 0},
{CRYPTODEV_ST_KEYWORD, no_argument, 0, 0},
@ -227,6 +240,14 @@ cryptodev_fips_validate_parse_args(int argc, char **argv)
argvopt = argv;
env.mbuf_data_room = DEF_MBUF_SEG_SIZE;
if (rte_cryptodev_count())
env.dev_id = 0;
else {
cryptodev_fips_validate_usage(prgname);
return -EINVAL;
}
while ((opt = getopt_long(argc, argvopt, "s:",
lgopts, &option_index)) != EOF) {
@ -305,6 +326,23 @@ cryptodev_fips_validate_parse_args(int argc, char **argv)
cryptodev_fips_validate_usage(prgname);
return -EINVAL;
}
} else if (strcmp(lgopts[option_index].name,
MBUF_DATAROOM_KEYWORD) == 0) {
uint32_t data_room_size;
if (parser_read_uint32(&data_room_size,
optarg) < 0) {
cryptodev_fips_validate_usage(prgname);
return -EINVAL;
}
if (data_room_size == 0 ||
data_room_size > UINT16_MAX) {
cryptodev_fips_validate_usage(prgname);
return -EINVAL;
}
env.mbuf_data_room = data_room_size;
} else {
cryptodev_fips_validate_usage(prgname);
return -EINVAL;
@ -315,12 +353,6 @@ cryptodev_fips_validate_parse_args(int argc, char **argv)
}
}
if (env.dev_id == UINT32_MAX) {
RTE_LOG(ERR, USER1, "No device specified\n");
cryptodev_fips_validate_usage(prgname);
return -EINVAL;
}
if ((env.req_path == NULL && env.rsp_path != NULL) ||
(env.req_path != NULL && env.rsp_path == NULL)) {
RTE_LOG(ERR, USER1, "Missing req path or rsp path\n");
@ -468,61 +500,125 @@ struct fips_test_ops {
fips_test_one_case_t test;
} test_ops;
static int
prepare_data_mbufs(struct fips_val *val)
{
struct rte_mbuf *m, *head = 0;
uint8_t *src = val->val;
uint32_t total_len = val->len;
uint16_t nb_seg;
int ret = 0;
if (env.mbuf)
rte_pktmbuf_free(env.mbuf);
if (total_len > RTE_MBUF_MAX_NB_SEGS) {
RTE_LOG(ERR, USER1, "Data len %u too big\n", total_len);
return -EPERM;
}
nb_seg = total_len / env.mbuf_data_room;
if (total_len % env.mbuf_data_room)
nb_seg++;
m = rte_pktmbuf_alloc(env.mpool);
if (!m) {
RTE_LOG(ERR, USER1, "Error %i: Not enough mbuf\n",
-ENOMEM);
return -ENOMEM;
}
head = m;
while (nb_seg) {
uint16_t len = RTE_MIN(total_len, env.mbuf_data_room);
uint8_t *dst = (uint8_t *)rte_pktmbuf_append(m, len);
if (!dst) {
RTE_LOG(ERR, USER1, "Error %i: MBUF too small\n",
-ENOMEM);
ret = -ENOMEM;
goto error_exit;
}
memcpy(dst, src, len);
if (head != m) {
ret = rte_pktmbuf_chain(head, m);
if (ret) {
rte_pktmbuf_free(m);
RTE_LOG(ERR, USER1, "Error %i: SGL build\n",
ret);
goto error_exit;
}
}
total_len -= len;
if (total_len) {
if (!env.dev_support_sgl) {
RTE_LOG(ERR, USER1, "SGL not supported\n");
ret = -EPERM;
goto error_exit;
}
m = rte_pktmbuf_alloc(env.mpool);
if (!m) {
RTE_LOG(ERR, USER1, "Error %i: No memory\n",
-ENOMEM);
goto error_exit;
}
} else
break;
src += len;
nb_seg--;
}
if (total_len) {
RTE_LOG(ERR, USER1, "Error %i: Failed to store all data\n",
-ENOMEM);
goto error_exit;
}
env.mbuf = head;
return 0;
error_exit:
if (head)
rte_pktmbuf_free(head);
return ret;
}
static int
prepare_cipher_op(void)
{
struct rte_crypto_sym_op *sym = env.op->sym;
uint8_t *iv = rte_crypto_op_ctod_offset(env.op, uint8_t *, IV_OFF);
int ret;
__rte_crypto_op_reset(env.op, RTE_CRYPTO_OP_TYPE_SYMMETRIC);
rte_pktmbuf_reset(env.mbuf);
sym->m_src = env.mbuf;
sym->cipher.data.offset = 0;
memcpy(iv, vec.iv.val, vec.iv.len);
if (info.op == FIPS_TEST_ENC_AUTH_GEN) {
uint8_t *pt;
ret = prepare_data_mbufs(&vec.pt);
if (ret < 0)
return ret;
if (vec.pt.len > RTE_MBUF_MAX_NB_SEGS) {
RTE_LOG(ERR, USER1, "PT len %u\n", vec.pt.len);
return -EPERM;
}
pt = (uint8_t *)rte_pktmbuf_append(env.mbuf, vec.pt.len);
if (!pt) {
RTE_LOG(ERR, USER1, "Error %i: MBUF too small\n",
-ENOMEM);
return -ENOMEM;
}
memcpy(pt, vec.pt.val, vec.pt.len);
sym->cipher.data.length = vec.pt.len;
} else {
uint8_t *ct;
ret = prepare_data_mbufs(&vec.ct);
if (ret < 0)
return ret;
if (vec.ct.len > RTE_MBUF_MAX_NB_SEGS) {
RTE_LOG(ERR, USER1, "CT len %u\n", vec.ct.len);
return -EPERM;
}
ct = (uint8_t *)rte_pktmbuf_append(env.mbuf, vec.ct.len);
if (!ct) {
RTE_LOG(ERR, USER1, "Error %i: MBUF too small\n",
-ENOMEM);
return -ENOMEM;
}
memcpy(ct, vec.ct.val, vec.ct.len);
sym->cipher.data.length = vec.ct.len;
}
rte_crypto_op_attach_sym_session(env.op, env.sess);
sym->m_src = env.mbuf;
sym->cipher.data.offset = 0;
return 0;
}
@ -530,32 +626,33 @@ static int
prepare_auth_op(void)
{
struct rte_crypto_sym_op *sym = env.op->sym;
uint8_t *pt;
int ret;
__rte_crypto_op_reset(env.op, RTE_CRYPTO_OP_TYPE_SYMMETRIC);
rte_pktmbuf_reset(env.mbuf);
ret = prepare_data_mbufs(&vec.pt);
if (ret < 0)
return ret;
if (env.digest)
rte_free(env.digest);
env.digest = rte_zmalloc(NULL, vec.cipher_auth.digest.len,
RTE_CACHE_LINE_SIZE);
if (!env.digest) {
RTE_LOG(ERR, USER1, "Not enough memory\n");
return -ENOMEM;
}
env.digest_len = vec.cipher_auth.digest.len;
sym->m_src = env.mbuf;
sym->auth.data.offset = 0;
pt = (uint8_t *)rte_pktmbuf_append(env.mbuf, vec.pt.len +
vec.cipher_auth.digest.len);
if (!pt) {
RTE_LOG(ERR, USER1, "Error %i: MBUF too small\n",
-ENOMEM);
return -ENOMEM;
}
sym->auth.data.length = vec.pt.len;
sym->auth.digest.data = pt + vec.pt.len;
sym->auth.digest.phys_addr = rte_pktmbuf_iova_offset(
env.mbuf, vec.pt.len);
memcpy(pt, vec.pt.val, vec.pt.len);
sym->auth.digest.data = env.digest;
sym->auth.digest.phys_addr = rte_malloc_virt2iova(env.digest);
if (info.op == FIPS_TEST_DEC_AUTH_VERIF)
memcpy(pt + vec.pt.len, vec.cipher_auth.digest.val,
memcpy(env.digest, vec.cipher_auth.digest.val,
vec.cipher_auth.digest.len);
rte_crypto_op_attach_sym_session(env.op, env.sess);
@ -568,65 +665,53 @@ prepare_aead_op(void)
{
struct rte_crypto_sym_op *sym = env.op->sym;
uint8_t *iv = rte_crypto_op_ctod_offset(env.op, uint8_t *, IV_OFF);
int ret;
__rte_crypto_op_reset(env.op, RTE_CRYPTO_OP_TYPE_SYMMETRIC);
rte_pktmbuf_reset(env.mbuf);
if (info.algo == FIPS_TEST_ALGO_AES_CCM)
memcpy(iv + 1, vec.iv.val, vec.iv.len);
else
memcpy(iv, vec.iv.val, vec.iv.len);
iv++;
sym->m_src = env.mbuf;
sym->aead.data.offset = 0;
sym->aead.aad.data = vec.aead.aad.val;
sym->aead.aad.phys_addr = rte_malloc_virt2iova(sym->aead.aad.data);
if (vec.iv.val)
memcpy(iv, vec.iv.val, vec.iv.len);
else
/* if REQ file has iv length but not data, default as all 0 */
memset(iv, 0, vec.iv.len);
if (info.op == FIPS_TEST_ENC_AUTH_GEN) {
uint8_t *pt;
ret = prepare_data_mbufs(&vec.pt);
if (ret < 0)
return ret;
if (vec.pt.len > RTE_MBUF_MAX_NB_SEGS) {
RTE_LOG(ERR, USER1, "PT len %u\n", vec.pt.len);
return -EPERM;
}
pt = (uint8_t *)rte_pktmbuf_append(env.mbuf,
vec.pt.len + vec.aead.digest.len);
if (!pt) {
RTE_LOG(ERR, USER1, "Error %i: MBUF too small\n",
-ENOMEM);
if (env.digest)
rte_free(env.digest);
env.digest = rte_zmalloc(NULL, vec.aead.digest.len,
RTE_CACHE_LINE_SIZE);
if (!env.digest) {
RTE_LOG(ERR, USER1, "Not enough memory\n");
return -ENOMEM;
}
env.digest_len = vec.cipher_auth.digest.len;
memcpy(pt, vec.pt.val, vec.pt.len);
sym->aead.data.length = vec.pt.len;
sym->aead.digest.data = pt + vec.pt.len;
sym->aead.digest.phys_addr = rte_pktmbuf_iova_offset(
env.mbuf, vec.pt.len);
sym->aead.digest.data = env.digest;
sym->aead.digest.phys_addr = rte_malloc_virt2iova(env.digest);
} else {
uint8_t *ct;
ret = prepare_data_mbufs(&vec.ct);
if (ret < 0)
return ret;
if (vec.ct.len > RTE_MBUF_MAX_NB_SEGS) {
RTE_LOG(ERR, USER1, "CT len %u\n", vec.ct.len);
return -EPERM;
}
ct = (uint8_t *)rte_pktmbuf_append(env.mbuf, vec.ct.len);
if (!ct) {
RTE_LOG(ERR, USER1, "Error %i: MBUF too small\n",
-ENOMEM);
return -ENOMEM;
}
memcpy(ct, vec.ct.val, vec.ct.len);
sym->aead.data.length = vec.ct.len;
sym->aead.digest.data = vec.aead.digest.val;
sym->aead.digest.phys_addr = rte_malloc_virt2iova(
sym->aead.digest.data);
}
sym->m_src = env.mbuf;
sym->aead.data.offset = 0;
sym->aead.aad.data = vec.aead.aad.val;
sym->aead.aad.phys_addr = rte_malloc_virt2iova(sym->aead.aad.data);
rte_crypto_op_attach_sym_session(env.op, env.sess);
return 0;
@ -970,11 +1055,48 @@ prepare_xts_xform(struct rte_crypto_sym_xform *xform)
return 0;
}
static void
static int
get_writeback_data(struct fips_val *val)
{
val->val = rte_pktmbuf_mtod(env.mbuf, uint8_t *);
val->len = rte_pktmbuf_pkt_len(env.mbuf);
struct rte_mbuf *m = env.mbuf;
uint16_t data_len = rte_pktmbuf_pkt_len(m);
uint16_t total_len = data_len + env.digest_len;
uint8_t *src, *dst, *wb_data;
/* in case val is reused for MCT test, try to free the buffer first */
if (val->val) {
free(val->val);
val->val = NULL;
}
wb_data = dst = calloc(1, total_len);
if (!dst) {
RTE_LOG(ERR, USER1, "Error %i: Not enough memory\n", -ENOMEM);
return -ENOMEM;
}
while (m && data_len) {
uint16_t seg_len = RTE_MIN(rte_pktmbuf_data_len(m), data_len);
src = rte_pktmbuf_mtod(m, uint8_t *);
memcpy(dst, src, seg_len);
m = m->next;
data_len -= seg_len;
dst += seg_len;
}
if (data_len) {
RTE_LOG(ERR, USER1, "Error -1: write back data\n");
return -1;
}
if (env.digest)
memcpy(dst, env.digest, env.digest_len);
val->val = wb_data;
val->len = total_len;
return 0;
}
static int
@ -1033,7 +1155,7 @@ fips_run_test(void)
static int
fips_generic_test(void)
{
struct fips_val val;
struct fips_val val = {NULL, 0};
int ret;
fips_test_write_one_case();
@ -1048,7 +1170,9 @@ fips_generic_test(void)
return ret;
}
get_writeback_data(&val);
ret = get_writeback_data(&val);
if (ret < 0)
return ret;
switch (info.file_type) {
case FIPS_TYPE_REQ:
@ -1069,6 +1193,7 @@ fips_generic_test(void)
}
fprintf(info.fp_wr, "\n");
free(val.val);
return 0;
}
@ -1079,7 +1204,7 @@ fips_mct_tdes_test(void)
#define TDES_BLOCK_SIZE 8
#define TDES_EXTERN_ITER 400
#define TDES_INTERN_ITER 10000
struct fips_val val, val_key;
struct fips_val val = {NULL, 0}, val_key;
uint8_t prev_out[TDES_BLOCK_SIZE] = {0};
uint8_t prev_prev_out[TDES_BLOCK_SIZE] = {0};
uint8_t prev_in[TDES_BLOCK_SIZE] = {0};
@ -1108,7 +1233,9 @@ fips_mct_tdes_test(void)
return ret;
}
get_writeback_data(&val);
ret = get_writeback_data(&val);
if (ret < 0)
return ret;
if (info.op == FIPS_TEST_DEC_AUTH_VERIF)
memcpy(prev_in, vec.ct.val, TDES_BLOCK_SIZE);
@ -1235,6 +1362,9 @@ fips_mct_tdes_test(void)
}
}
if (val.val)
free(val.val);
return 0;
}
@ -1244,7 +1374,7 @@ fips_mct_aes_ecb_test(void)
#define AES_BLOCK_SIZE 16
#define AES_EXTERN_ITER 100
#define AES_INTERN_ITER 1000
struct fips_val val, val_key;
struct fips_val val = {NULL, 0}, val_key;
uint8_t prev_out[AES_BLOCK_SIZE] = {0};
uint32_t i, j, k;
int ret;
@ -1266,7 +1396,9 @@ fips_mct_aes_ecb_test(void)
return ret;
}
get_writeback_data(&val);
ret = get_writeback_data(&val);
if (ret < 0)
return ret;
if (info.op == FIPS_TEST_ENC_AUTH_GEN)
memcpy(vec.pt.val, val.val, AES_BLOCK_SIZE);
@ -1310,6 +1442,9 @@ fips_mct_aes_ecb_test(void)
}
}
if (val.val)
free(val.val);
return 0;
}
static int
@ -1318,7 +1453,7 @@ fips_mct_aes_test(void)
#define AES_BLOCK_SIZE 16
#define AES_EXTERN_ITER 100
#define AES_INTERN_ITER 1000
struct fips_val val, val_key;
struct fips_val val = {NULL, 0}, val_key;
uint8_t prev_out[AES_BLOCK_SIZE] = {0};
uint8_t prev_in[AES_BLOCK_SIZE] = {0};
uint32_t i, j, k;
@ -1414,6 +1549,9 @@ fips_mct_aes_test(void)
memcpy(vec.iv.val, val.val, AES_BLOCK_SIZE);
}
if (val.val)
free(val.val);
return 0;
}
@ -1423,7 +1561,7 @@ fips_mct_sha_test(void)
#define SHA_EXTERN_ITER 100
#define SHA_INTERN_ITER 1000
#define SHA_MD_BLOCK 3
struct fips_val val, md[SHA_MD_BLOCK];
struct fips_val val = {NULL, 0}, md[SHA_MD_BLOCK];
char temp[MAX_DIGEST_SIZE*2];
int ret;
uint32_t i, j;
@ -1497,6 +1635,9 @@ fips_mct_sha_test(void)
rte_free(vec.pt.val);
if (val.val)
free(val.val);
return 0;
}
@ -1588,7 +1729,6 @@ fips_test_one_file(void)
{
int fetch_ret = 0, ret;
ret = init_test_ops();
if (ret < 0) {
RTE_LOG(ERR, USER1, "Error %i: Init test op\n", ret);
@ -1636,6 +1776,10 @@ fips_test_one_file(void)
fips_test_clear();
return ret;
if (env.digest)
rte_free(env.digest);
if (env.mbuf)
rte_pktmbuf_free(env.mbuf);
return ret;
}