odp_crypto.c

Performance test application for crypto APIs

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2015-2018 Linaro Limited
 * Copyright (c) 2023 Nokia
 */
 
#ifndef _GNU_SOURCE
#define _GNU_SOURCE
#endif /* _GNU_SOURCE */
 
#include <stdlib.h>
#include <string.h>
#include <getopt.h>
#include <unistd.h>
#include <stdio.h>
#include <sys/time.h>
#include <sys/resource.h>
 
#include <odp_api.h>
#include <odp/helper/odph_api.h>
 
#define POOL_NUM_PKT  64
 
#define AAD_LEN 8 /* typical AAD length used in IPsec when ESN is not in use */
#define MAX_AUTH_DIGEST_LEN 32 /* maximum MAC length in bytes */
 
static uint8_t test_aad[AAD_LEN] = "01234567";
static uint8_t test_iv[16] = "0123456789abcdef";
 
static uint8_t test_key16[16] = { 0x01, 0x02, 0x03, 0x04, 0x05,
                  0x06, 0x07, 0x08, 0x09, 0x0a,
                  0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
                  0x10,
};
 
static uint8_t test_key20[20] = { 0x01, 0x02, 0x03, 0x04, 0x05,
                  0x06, 0x07, 0x08, 0x09, 0x0a,
                  0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
                  0x10, 0x11, 0x12, 0x13, 0x14,
};
 
static uint8_t test_key24[24] = { 0x01, 0x02, 0x03, 0x04, 0x05,
                  0x06, 0x07, 0x08, 0x09, 0x0a,
                  0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
                  0x10, 0x11, 0x12, 0x13, 0x14,
                  0x15, 0x16, 0x17, 0x18
};
 
static uint8_t test_key32[32] = { 0x01, 0x02, 0x03, 0x04, 0x05,
                  0x06, 0x07, 0x08, 0x09, 0x0a,
                  0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
                  0x10, 0x11, 0x12, 0x13, 0x14,
                  0x15, 0x16, 0x17, 0x18, 0x19,
                  0x1a, 0x1b, 0x1c, 0x1d, 0x1e,
                  0x1f, 0x20,
};
 
static uint8_t test_key64[64] = { 0x01, 0x02, 0x03, 0x04, 0x05,
                  0x06, 0x07, 0x08, 0x09, 0x0a,
                  0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
                  0x10, 0x11, 0x12, 0x13, 0x14,
                  0x15, 0x16, 0x17, 0x18, 0x19,
                  0x1a, 0x1b, 0x1c, 0x1d, 0x1e,
                  0x1f, 0x20, 0x21, 0x22, 0x23,
                  0x24, 0x25, 0x26, 0x27, 0x28,
                  0x29, 0x2a, 0x4b, 0x2c, 0x2d,
                  0x2e, 0x2f, 0x30, 0x31, 0x32,
                  0x33, 0x34, 0x55, 0x36, 0x37,
                  0x38, 0x39, 0x5a, 0x3b, 0x3c,
                  0x3d, 0x3e, 0x5f, 0x40,
};
 
typedef struct {
    const char *name;             
    odp_crypto_session_param_t session;   
    int cipher_in_bit_mode;               
    int auth_in_bit_mode;                 
} crypto_alg_config_t;
 
typedef struct {
    int debug_packets;
 
    int in_place;
 
    int reuse_packet;
 
    int in_flight;
 
    int iteration_count;
 
    int max_sessions;
 
    int payload_length;
 
    crypto_alg_config_t *alg_config;
 
    int schedule;
 
    /*
     * Poll completion queue for crypto completion events.
     * Specified through -p argument.
     */
    int poll;
} crypto_args_t;
 
/*
 * Helper structure that holds averages for test of one algorithm
 * for given payload size.
 */
typedef struct {
    double elapsed;
 
    double rusage_self;
 
    double rusage_thread;
} crypto_run_result_t;
 
typedef struct {
    struct timeval tv;   
    struct rusage ru_self;   
    struct rusage ru_thread; 
} time_record_t;
 
/* Arguments for one test run */
typedef struct test_run_arg_t {
    crypto_args_t crypto_args;
    crypto_alg_config_t *crypto_alg_config;
    odp_crypto_capability_t crypto_capa;
 
} test_run_arg_t;
 
static void parse_args(int argc, char *argv[], crypto_args_t *cargs);
static void usage(char *progname);
 
static unsigned int payloads[] = {
    16,
    64,
    256,
    1024,
    8192,
    16384
};
 
static unsigned num_payloads;
 
static crypto_alg_config_t algs_config[] = {
    {
        .name = "3des-cbc-null",
        .session = {
            .cipher_alg = ODP_CIPHER_ALG_3DES_CBC,
            .cipher_key = {
                .data = test_key24,
                .length = sizeof(test_key24)
            },
            .cipher_iv_len = 8,
            .auth_alg = ODP_AUTH_ALG_NULL
        },
    },
    {
        .name = "3des-cbc-hmac-md5-96",
        .session = {
            .cipher_alg = ODP_CIPHER_ALG_3DES_CBC,
            .cipher_key = {
                .data = test_key24,
                .length = sizeof(test_key24)
            },
            .cipher_iv_len = 8,
            .auth_alg = ODP_AUTH_ALG_MD5_HMAC,
            .auth_key = {
                .data = test_key16,
                .length = sizeof(test_key16)
            },
            .auth_digest_len = 12,
        },
    },
    {
        .name = "null-hmac-md5-96",
        .session = {
            .cipher_alg = ODP_CIPHER_ALG_NULL,
            .auth_alg = ODP_AUTH_ALG_MD5_HMAC,
            .auth_key = {
                .data = test_key16,
                .length = sizeof(test_key16)
            },
            .auth_digest_len = 12,
        },
    },
    {
        .name = "aes-cbc-null",
        .session = {
            .cipher_alg = ODP_CIPHER_ALG_AES_CBC,
            .cipher_key = {
                .data = test_key16,
                .length = sizeof(test_key16)
            },
            .cipher_iv_len = 16,
            .auth_alg = ODP_AUTH_ALG_NULL
        },
    },
    {
        .name = "aes-cbc-hmac-sha1-96",
        .session = {
            .cipher_alg = ODP_CIPHER_ALG_AES_CBC,
            .cipher_key = {
                .data = test_key16,
                .length = sizeof(test_key16)
            },
            .cipher_iv_len = 16,
            .auth_alg = ODP_AUTH_ALG_SHA1_HMAC,
            .auth_key = {
                .data = test_key20,
                .length = sizeof(test_key20)
            },
            .auth_digest_len = 12,
        },
    },
    {
        .name = "null-hmac-sha1-96",
        .session = {
            .cipher_alg = ODP_CIPHER_ALG_NULL,
            .auth_alg = ODP_AUTH_ALG_SHA1_HMAC,
            .auth_key = {
                .data = test_key20,
                .length = sizeof(test_key20)
            },
            .auth_digest_len = 12,
        },
    },
    {
        .name = "aes-ctr-null",
        .session = {
            .cipher_alg = ODP_CIPHER_ALG_AES_CTR,
            .cipher_key = {
                .data = test_key16,
                .length = sizeof(test_key16)
            },
            .cipher_iv_len = 16,
            .auth_alg = ODP_AUTH_ALG_NULL
        },
    },
    {
        .name = "aes-ctr-hmac-sha1-96",
        .session = {
            .cipher_alg = ODP_CIPHER_ALG_AES_CTR,
            .cipher_key = {
                .data = test_key16,
                .length = sizeof(test_key16)
            },
            .cipher_iv_len = 16,
            .auth_alg = ODP_AUTH_ALG_SHA1_HMAC,
            .auth_key = {
                .data = test_key20,
                .length = sizeof(test_key20)
            },
            .auth_digest_len = 12,
        },
    },
    {
        .name = "null-hmac-sha256-128",
        .session = {
            .cipher_alg = ODP_CIPHER_ALG_NULL,
            .auth_alg = ODP_AUTH_ALG_SHA256_HMAC,
            .auth_key = {
                .data = test_key32,
                .length = sizeof(test_key32)
            },
            .auth_digest_len = 16,
        },
    },
    {
        .name = "null-hmac-sha512-256",
        .session = {
            .cipher_alg = ODP_CIPHER_ALG_NULL,
            .auth_alg = ODP_AUTH_ALG_SHA512_HMAC,
            .auth_key = {
                .data = test_key64,
                .length = sizeof(test_key64)
            },
            .auth_digest_len = 32,
        },
    },
    {
        .name = "null-aes-gmac",
        .session = {
            .cipher_alg = ODP_CIPHER_ALG_NULL,
            .auth_alg = ODP_AUTH_ALG_AES_GMAC,
            .auth_key = {
                .data = test_key16,
                .length = sizeof(test_key16)
            },
            .auth_iv_len = 12,
            .auth_digest_len = 16,
        },
    },
    {
        .name = "aes-gcm",
        .session = {
            .cipher_alg = ODP_CIPHER_ALG_AES_GCM,
            .cipher_key = {
                .data = test_key16,
                .length = sizeof(test_key16)
            },
            .cipher_iv_len = 12,
            .auth_alg = ODP_AUTH_ALG_AES_GCM,
            .auth_digest_len = 16,
            .auth_aad_len = AAD_LEN,
        },
    },
    {
        .name = "aes-ccm",
        .session = {
            .cipher_alg = ODP_CIPHER_ALG_AES_CCM,
            .cipher_key = {
                .data = test_key16,
                .length = sizeof(test_key16)
            },
            .cipher_iv_len = 11,
            .auth_alg = ODP_AUTH_ALG_AES_CCM,
            .auth_digest_len = 16,
            .auth_aad_len = AAD_LEN,
        },
    },
    {
        .name = "chacha20-poly1305",
        .session = {
            .cipher_alg = ODP_CIPHER_ALG_CHACHA20_POLY1305,
            .cipher_key = {
                .data = test_key32,
                .length = sizeof(test_key32)
            },
            .cipher_iv_len = 12,
            .auth_alg = ODP_AUTH_ALG_CHACHA20_POLY1305,
            .auth_digest_len = 16,
            .auth_aad_len = AAD_LEN,
        },
    },
    {
        .name = "zuc-eea3",
        .session = {
            .cipher_alg = ODP_CIPHER_ALG_ZUC_EEA3,
            .cipher_key = {
                .data = test_key16,
                .length = sizeof(test_key16)
            },
            .cipher_iv_len = 16,
            .auth_alg = ODP_AUTH_ALG_NULL,
        },
    },
    {
        .name = "zuc-eia3",
        .session = {
            .cipher_alg = ODP_CIPHER_ALG_NULL,
            .auth_alg = ODP_AUTH_ALG_ZUC_EIA3,
            .auth_key = {
                .data = test_key16,
                .length = sizeof(test_key16)
            },
            .auth_iv_len = 16,
            .auth_digest_len = 4,
        },
    },
    {
        .name = "zuc-eea3-zuc-eia3",
        .session = {
            .cipher_alg = ODP_CIPHER_ALG_ZUC_EEA3,
            .cipher_key = {
                .data = test_key16,
                .length = sizeof(test_key16)
            },
            .cipher_iv_len = 16,
            .auth_alg = ODP_AUTH_ALG_ZUC_EIA3,
            .auth_key = {
                .data = test_key16,
                .length = sizeof(test_key16)
            },
            .auth_iv_len = 16,
            .auth_digest_len = 4,
        },
    },
    {
        .name = "snow3g-uea2",
        .session = {
            .cipher_alg = ODP_CIPHER_ALG_SNOW3G_UEA2,
            .cipher_key = {
                .data = test_key16,
                .length = sizeof(test_key16)
            },
            .cipher_iv_len = 16,
            .auth_alg = ODP_AUTH_ALG_NULL,
        },
    },
    {
        .name = "snow3g-uia2",
        .session = {
            .cipher_alg = ODP_CIPHER_ALG_NULL,
            .auth_alg = ODP_AUTH_ALG_SNOW3G_UIA2,
            .auth_key = {
                .data = test_key16,
                .length = sizeof(test_key16)
            },
            .auth_iv_len = 16,
            .auth_digest_len = 4,
        },
    },
    {
        .name = "snow3g-uea2-snow3g-uia2",
        .session = {
            .cipher_alg = ODP_CIPHER_ALG_SNOW3G_UEA2,
            .cipher_key = {
                .data = test_key16,
                .length = sizeof(test_key16)
            },
            .cipher_iv_len = 16,
            .auth_alg = ODP_AUTH_ALG_SNOW3G_UIA2,
            .auth_key = {
                .data = test_key16,
                .length = sizeof(test_key16)
            },
            .auth_iv_len = 16,
            .auth_digest_len = 4,
        },
    },
};
 
static crypto_alg_config_t *
find_config_by_name(const char *name) {
    unsigned int i;
    crypto_alg_config_t *ret = NULL;
 
    for (i = 0; i < ODPH_ARRAY_SIZE(algs_config); i++) {
        if (strcmp(algs_config[i].name, name) == 0) {
            ret = algs_config + i;
            break;
        }
    }
    return ret;
}
 
static void
print_config_names(const char *prefix) {
    unsigned int i;
 
    for (i = 0; i < ODPH_ARRAY_SIZE(algs_config); i++)
        printf("%s %s\n", prefix, algs_config[i].name);
}
 
static void
fill_time_record(time_record_t *rec)
{
    gettimeofday(&rec->tv, NULL);
    getrusage(RUSAGE_SELF, &rec->ru_self);
    getrusage(RUSAGE_THREAD, &rec->ru_thread);
}
 
static unsigned long long
get_rusage_diff(struct rusage *start, struct rusage *end)
{
    unsigned long long rusage_diff;
    unsigned long long rusage_start;
    unsigned long long rusage_end;
 
    rusage_start = (start->ru_utime.tv_sec * 1000000) +
               (start->ru_utime.tv_usec);
    rusage_start += (start->ru_stime.tv_sec * 1000000) +
            (start->ru_stime.tv_usec);
 
    rusage_end = (end->ru_utime.tv_sec * 1000000) +
             (end->ru_utime.tv_usec);
    rusage_end += (end->ru_stime.tv_sec * 1000000) +
              (end->ru_stime.tv_usec);
 
    rusage_diff = rusage_end - rusage_start;
 
    return rusage_diff;
}
 
static unsigned long long
get_rusage_self_diff(time_record_t *start, time_record_t *end)
{
    return get_rusage_diff(&start->ru_self, &end->ru_self);
}
 
static unsigned long long
get_rusage_thread_diff(time_record_t *start, time_record_t *end)
{
    return get_rusage_diff(&start->ru_thread, &end->ru_thread);
}
 
static unsigned long long
get_elapsed_usec(time_record_t *start, time_record_t *end)
{
    unsigned long long s;
    unsigned long long e;
 
    s = (start->tv.tv_sec * 1000000) +
        (start->tv.tv_usec);
    e = (end->tv.tv_sec * 1000000) +
        (end->tv.tv_usec);
 
    return e - s;
}
 
#define REPORT_HEADER       "%30.30s %15s %15s %15s %15s %15s %15s\n"
#define REPORT_LINE     "%30.30s %15d %15d %15.3f %15.3f %15.3f %15d\n"
 
static void
print_result_header(void)
{
    printf(REPORT_HEADER,
           "algorithm", "avg over #", "payload (bytes)", "elapsed (us)",
           "rusg self (us)", "rusg thrd (us)", "throughput (Kb)");
}
 
static void
print_result(crypto_args_t *cargs,
         unsigned int payload_length,
         crypto_alg_config_t *config,
         crypto_run_result_t *result)
{
    unsigned int throughput;
 
    throughput = (1000000.0 / result->elapsed) * payload_length / 1024;
    printf(REPORT_LINE,
           config->name, cargs->iteration_count, payload_length,
           result->elapsed, result->rusage_self, result->rusage_thread,
           throughput);
}
 
static void
print_mem(const char *msg,
      const unsigned char *ptr,
      unsigned int len)
{
    unsigned i, j;
    char c;
    char line[81];
    char *p;
 
    if (msg)
        printf("\n%s (bytes size = %d)", msg, len);
 
    for (i = 0; i < len; i += 16) {
        p = line;
        sprintf(p, "\n%04x   ", i); p += 8;
 
        for (j = 0; j < 16; j++) {
            if (i + j == len)
                break;
 
            sprintf(p, " %02x", (ptr)[i + j]); p += 3;
        }
 
        for (; j < 16; j++) {
            sprintf(p, "   "); p += 3;
        }
 
        sprintf(p, "   "); p += 3;
 
        for (j = 0; j < 16; j++) {
            if (i + j == len)
                break;
            c = (ptr)[i + j];
            *p++ = (' ' <= c && c <= '~') ? c : '.';
        }
 
        *p = '\0';
        printf("%s", line);
    }
    printf("\n");
}
 
static int
create_session_from_config(odp_crypto_session_t *session,
               crypto_alg_config_t *config,
               crypto_args_t *cargs)
{
    odp_crypto_session_param_t params;
    odp_crypto_ses_create_err_t ses_create_rc;
    odp_pool_t pkt_pool;
    odp_queue_t out_queue;
 
    odp_crypto_session_param_init(&params);
    memcpy(&params, &config->session, sizeof(odp_crypto_session_param_t));
    params.op = ODP_CRYPTO_OP_ENCODE;
    params.auth_cipher_text = true;
 
    /* Lookup the packet pool */
    pkt_pool = odp_pool_lookup("packet_pool");
    if (pkt_pool == ODP_POOL_INVALID) {
        ODPH_ERR("packet_pool pool not found\n");
        return -1;
    }
    params.output_pool = pkt_pool;
 
    if (cargs->schedule || cargs->poll) {
        out_queue = odp_queue_lookup("crypto-out");
        if (out_queue == ODP_QUEUE_INVALID) {
            ODPH_ERR("crypto-out queue not found\n");
            return -1;
        }
        params.compl_queue = out_queue;
        params.op_mode = ODP_CRYPTO_ASYNC;
    } else {
        params.compl_queue = ODP_QUEUE_INVALID;
        params.op_mode = ODP_CRYPTO_SYNC;
    }
    if (odp_crypto_session_create(&params, session,
                      &ses_create_rc)) {
        switch (ses_create_rc) {
        case ODP_CRYPTO_SES_ERR_ALG_COMBO:
            printf("    requested algorithm combination not supported\n");
            return 1;
        case ODP_CRYPTO_SES_ERR_ALG_ORDER:
            printf("    requested algorithm order not supported\n");
            return 1;
        case ODP_CRYPTO_SES_ERR_PARAMS:
            printf("    requested session parameters not supported\n");
            return 1;
        default:
            break;
        }
        ODPH_ERR("crypto session create failed.\n");
        return -1;
    }
 
    return 0;
}
 
static odp_packet_t
make_packet(odp_pool_t pkt_pool, unsigned int payload_length)
{
    odp_packet_t pkt;
 
    pkt = odp_packet_alloc(pkt_pool, payload_length);
    if (pkt == ODP_PACKET_INVALID) {
        ODPH_ERR("failed to allocate buffer\n");
        return pkt;
    }
 
    void *mem = odp_packet_data(pkt);
 
    memset(mem, 1, payload_length);
 
    return pkt;
}
 
static int
run_measure_one(crypto_args_t *cargs,
        crypto_alg_config_t *config,
        odp_crypto_session_t *session,
        unsigned int payload_length,
        crypto_run_result_t *result)
{
    odp_crypto_packet_op_param_t params;
 
    odp_pool_t pkt_pool;
    odp_queue_t out_queue;
    odp_packet_t pkt = ODP_PACKET_INVALID;
    int rc = 0;
    uint32_t packet_len = payload_length + MAX_AUTH_DIGEST_LEN;
 
    pkt_pool = odp_pool_lookup("packet_pool");
    if (pkt_pool == ODP_POOL_INVALID) {
        ODPH_ERR("pkt_pool not found\n");
        return -1;
    }
 
    out_queue = odp_queue_lookup("crypto-out");
    if (cargs->schedule || cargs->poll) {
        if (out_queue == ODP_QUEUE_INVALID) {
            ODPH_ERR("crypto-out queue not found\n");
            return -1;
        }
    }
 
    if (cargs->reuse_packet) {
        pkt = make_packet(pkt_pool, packet_len);
        if (ODP_PACKET_INVALID == pkt)
            return -1;
    }
 
    time_record_t start, end;
    int packets_sent = 0;
    int packets_received = 0;
 
    /* Initialize parameters block */
    memset(&params, 0, sizeof(params));
    params.session = *session;
    params.cipher_iv_ptr = test_iv;
    params.auth_iv_ptr = test_iv;
    params.aad_ptr = test_aad;
 
    params.cipher_range.offset = 0;
    params.cipher_range.length = config->cipher_in_bit_mode ? payload_length * 8
                                : payload_length;
    params.auth_range.offset = 0;
    params.auth_range.length = config->auth_in_bit_mode ? payload_length * 8
                                : payload_length;
    params.hash_result_offset = payload_length;
 
    fill_time_record(&start);
 
    while ((packets_sent < cargs->iteration_count) ||
           (packets_received <  cargs->iteration_count)) {
        void *mem;
 
        if ((packets_sent < cargs->iteration_count) &&
            (packets_sent - packets_received <
             cargs->in_flight)) {
            odp_packet_t out_pkt;
 
            if (!cargs->reuse_packet) {
                pkt = make_packet(pkt_pool, packet_len);
                if (ODP_PACKET_INVALID == pkt)
                    return -1;
            }
 
            out_pkt = cargs->in_place ? pkt : ODP_PACKET_INVALID;
 
            if (cargs->debug_packets) {
                mem = odp_packet_data(pkt);
                print_mem("Packet before encryption:",
                      mem, payload_length);
            }
 
            if (cargs->schedule || cargs->poll) {
                rc = odp_crypto_op_enq(&pkt, &out_pkt,
                               &params, 1);
                if (rc <= 0) {
                    ODPH_ERR("failed odp_crypto_packet_op_enq: rc = %d\n", rc);
                    if (!cargs->reuse_packet)
                        odp_packet_free(pkt);
                    break;
                }
                packets_sent += rc;
            } else {
                rc = odp_crypto_op(&pkt, &out_pkt,
                           &params, 1);
                if (rc <= 0) {
                    ODPH_ERR("failed odp_crypto_packet_op: rc = %d\n", rc);
                    if (!cargs->reuse_packet)
                        odp_packet_free(pkt);
                    break;
                }
                packets_sent += rc;
                packets_received++;
                if (odp_unlikely(odp_crypto_result(NULL, out_pkt) != 0)) {
                    ODPH_ERR("Crypto operation failed\n");
                    odp_packet_free(out_pkt);
                    return -1;
                }
                if (cargs->debug_packets) {
                    mem = odp_packet_data(out_pkt);
                    print_mem("Immediately encrypted "
                           "packet",
                          mem,
                          payload_length +
                          config->session.
                           auth_digest_len);
                }
                if (cargs->reuse_packet)
                    pkt = out_pkt;
                else
                    odp_packet_free(out_pkt);
            }
        }
 
        if (cargs->schedule || cargs->poll) {
            odp_event_t ev;
            odp_packet_t out_pkt;
 
            if (cargs->schedule)
                ev = odp_schedule(NULL,
                          ODP_SCHED_NO_WAIT);
            else
                ev = odp_queue_deq(out_queue);
 
            while (ev != ODP_EVENT_INVALID) {
                out_pkt = odp_crypto_packet_from_event(ev);
                if (odp_unlikely(odp_crypto_result(NULL, out_pkt) != 0)) {
                    ODPH_ERR("Crypto operation failed\n");
                    odp_packet_free(out_pkt);
                    return -1;
                }
                if (cargs->debug_packets) {
                    mem = odp_packet_data(out_pkt);
                    print_mem("Received encrypted packet",
                          mem,
                          payload_length +
                          config->
                          session.auth_digest_len);
                }
                if (cargs->reuse_packet)
                    pkt = out_pkt;
                else
                    odp_packet_free(out_pkt);
                packets_received++;
                if (cargs->schedule)
                    ev = odp_schedule(NULL,
                              ODP_SCHED_NO_WAIT);
                else
                    ev = odp_queue_deq(out_queue);
            };
        }
    }
 
    fill_time_record(&end);
 
    {
        double count;
 
        count = get_elapsed_usec(&start, &end);
        result->elapsed = count /
                  cargs->iteration_count;
 
        count = get_rusage_self_diff(&start, &end);
        result->rusage_self = count /
                      cargs->iteration_count;
 
        count = get_rusage_thread_diff(&start, &end);
        result->rusage_thread = count /
                    cargs->iteration_count;
    }
 
    if (cargs->reuse_packet)
        odp_packet_free(pkt);
 
    return rc < 0 ? rc : 0;
}
 
static int check_cipher_alg(const odp_crypto_capability_t *capa,
                odp_cipher_alg_t alg)
{
    switch (alg) {
    case ODP_CIPHER_ALG_NULL:
        if (capa->ciphers.bit.null)
            return 0;
        break;
    case ODP_CIPHER_ALG_DES:
        if (capa->ciphers.bit.des)
            return 0;
        break;
    case ODP_CIPHER_ALG_3DES_CBC:
        if (capa->ciphers.bit.trides_cbc)
            return 0;
        break;
    case ODP_CIPHER_ALG_AES_CBC:
        if (capa->ciphers.bit.aes_cbc)
            return 0;
        break;
    case ODP_CIPHER_ALG_AES_CTR:
        if (capa->ciphers.bit.aes_ctr)
            return 0;
        break;
    case ODP_CIPHER_ALG_AES_GCM:
        if (capa->ciphers.bit.aes_gcm)
            return 0;
        break;
    case ODP_CIPHER_ALG_AES_CCM:
        if (capa->ciphers.bit.aes_ccm)
            return 0;
        break;
    case ODP_CIPHER_ALG_CHACHA20_POLY1305:
        if (capa->ciphers.bit.chacha20_poly1305)
            return 0;
        break;
    case ODP_CIPHER_ALG_ZUC_EEA3:
        if (capa->ciphers.bit.zuc_eea3)
            return 0;
        break;
    case ODP_CIPHER_ALG_SNOW3G_UEA2:
        if (capa->ciphers.bit.snow3g_uea2)
            return 0;
        break;
    default:
        break;
    }
 
    return -1;
}
 
static int check_auth_alg(const odp_crypto_capability_t *capa,
              odp_auth_alg_t alg)
{
    switch (alg) {
    case ODP_AUTH_ALG_NULL:
        if (capa->auths.bit.null)
            return 0;
        break;
    case ODP_AUTH_ALG_MD5_HMAC:
        if (capa->auths.bit.md5_hmac)
            return 0;
        break;
    case ODP_AUTH_ALG_SHA1_HMAC:
        if (capa->auths.bit.sha1_hmac)
            return 0;
        break;
    case ODP_AUTH_ALG_SHA256_HMAC:
        if (capa->auths.bit.sha256_hmac)
            return 0;
        break;
    case ODP_AUTH_ALG_SHA384_HMAC:
        if (capa->auths.bit.sha384_hmac)
            return 0;
        break;
    case ODP_AUTH_ALG_SHA512_HMAC:
        if (capa->auths.bit.sha512_hmac)
            return 0;
        break;
    case ODP_AUTH_ALG_AES_GCM:
        if (capa->auths.bit.aes_gcm)
            return 0;
        break;
    case ODP_AUTH_ALG_AES_GMAC:
        if (capa->auths.bit.aes_gmac)
            return 0;
        break;
    case ODP_AUTH_ALG_AES_CCM:
        if (capa->auths.bit.aes_ccm)
            return 0;
        break;
    case ODP_AUTH_ALG_CHACHA20_POLY1305:
        if (capa->auths.bit.chacha20_poly1305)
            return 0;
        break;
    case ODP_AUTH_ALG_ZUC_EIA3:
        if (capa->auths.bit.zuc_eia3)
            return 0;
        break;
    case ODP_AUTH_ALG_SNOW3G_UIA2:
        if (capa->auths.bit.snow3g_uia2)
            return 0;
        break;
    default:
        break;
    }
 
    return -1;
}
 
static int check_cipher_params(const odp_crypto_capability_t *crypto_capa,
                   const odp_crypto_session_param_t *param,
                   int *bit_mode)
{
    int num, rc;
 
    if (check_cipher_alg(crypto_capa, param->cipher_alg))
        return 1;
 
    num = odp_crypto_cipher_capability(param->cipher_alg, NULL, 0);
    if (num <= 0)
        return 1;
 
    odp_crypto_cipher_capability_t cipher_capa[num];
 
    rc = odp_crypto_cipher_capability(param->cipher_alg, cipher_capa, num);
    if (rc < num)
        num = rc;
 
    for (int n = 0; n < num; n++) {
        odp_crypto_cipher_capability_t *capa = &cipher_capa[n];
 
        if (capa->key_len != param->cipher_key.length ||
            capa->iv_len != param->cipher_iv_len)
            continue;
 
        *bit_mode = capa->bit_mode;
        return 0;
    }
    return 1;
}
 
static int aad_len_ok(const odp_crypto_auth_capability_t *capa, uint32_t len)
{
    if (len < capa->aad_len.min || len > capa->aad_len.max)
        return 0;
 
    if (len == capa->aad_len.min)
        return 1;
    if (capa->aad_len.inc == 0)
        return 0;
 
    return ((len - capa->aad_len.min) % capa->aad_len.inc) == 0;
}
 
static int check_auth_params(const odp_crypto_capability_t *crypto_capa,
                 const odp_crypto_session_param_t *param,
                 int *bit_mode)
{
    int num, rc;
 
    if (param->auth_digest_len > MAX_AUTH_DIGEST_LEN) {
        ODPH_ERR("MAX_AUTH_DIGEST_LEN too low\n");
        return 1;
    }
 
    if (check_auth_alg(crypto_capa, param->auth_alg))
        return 1;
 
    num = odp_crypto_auth_capability(param->auth_alg, NULL, 0);
    if (num <= 0)
        return 1;
 
    odp_crypto_auth_capability_t auth_capa[num];
 
    rc = odp_crypto_auth_capability(param->auth_alg, auth_capa, num);
    if (rc < num)
        num = rc;
 
    for (int n = 0; n < num; n++) {
        odp_crypto_auth_capability_t *capa = &auth_capa[n];
 
        if (capa->digest_len != param->auth_digest_len ||
            capa->key_len != param->auth_key.length ||
            capa->iv_len != param->auth_iv_len)
            continue;
 
        if (!aad_len_ok(capa, param->auth_aad_len))
            continue;
 
        *bit_mode = capa->bit_mode;
        return 0;
    }
    return 1;
}
 
static int run_measure_one_config(test_run_arg_t *arg)
{
    crypto_run_result_t result;
    odp_crypto_session_t session;
    crypto_args_t *cargs = &arg->crypto_args;
    crypto_alg_config_t *config = arg->crypto_alg_config;
    odp_crypto_capability_t crypto_capa = arg->crypto_capa;
    int rc = 0;
 
    printf("\n");
 
    if (check_cipher_params(&crypto_capa, &config->session,
                &config->cipher_in_bit_mode)) {
        printf("    Cipher algorithm not supported\n");
        rc = 1;
    }
 
    if (check_auth_params(&crypto_capa, &config->session,
                  &config->auth_in_bit_mode)) {
        printf("    Auth algorithm not supported\n");
        rc = 1;
    }
 
#if ODP_VERSION_API >= ODP_VERSION_API_NUM(1, 42, 0)
    /* Bit mode ciphers can now be used in byte mode. */
    config->cipher_in_bit_mode = 0;
    config->auth_in_bit_mode = 0;
#endif
 
    if (rc == 0)
        rc = create_session_from_config(&session, config, cargs);
    if (rc) {
        printf("    => %s skipped\n", config->name);
        return rc > 0 ? 0 : -1;
    }
 
    if (cargs->payload_length) {
        rc = run_measure_one(cargs, config, &session,
                     cargs->payload_length, &result);
        if (!rc) {
            print_result_header();
            print_result(cargs, cargs->payload_length,
                     config, &result);
        }
    } else {
        unsigned i;
 
        print_result_header();
        for (i = 0; i < num_payloads; i++) {
            rc = run_measure_one(cargs, config, &session,
                         payloads[i], &result);
            if (rc)
                break;
            print_result(cargs, payloads[i],
                     config, &result);
        }
    }
 
    odp_crypto_session_destroy(session);
 
    return rc;
}
 
static int run_thr_func(void *arg)
{
    run_measure_one_config((test_run_arg_t *)arg);
    return 0;
}
 
int main(int argc, char *argv[])
{
    crypto_args_t cargs;
    odp_pool_t pool;
    odp_queue_param_t qparam;
    odp_pool_param_t params;
    odp_queue_t out_queue = ODP_QUEUE_INVALID;
    test_run_arg_t test_run_arg;
    odp_cpumask_t cpumask;
    char cpumaskstr[ODP_CPUMASK_STR_SIZE];
    int num_workers = 1;
    odph_helper_options_t helper_options;
    odph_thread_t thread_tbl[num_workers];
    odph_thread_common_param_t thr_common;
    odph_thread_param_t thr_param;
    odp_instance_t instance;
    odp_init_t init_param;
    odp_pool_capability_t pool_capa;
    odp_crypto_capability_t crypto_capa;
    uint32_t max_seg_len;
    uint32_t i;
 
    /* Let helper collect its own arguments (e.g. --odph_proc) */
    argc = odph_parse_options(argc, argv);
    if (odph_options(&helper_options)) {
        ODPH_ERR("Reading ODP helper options failed.\n");
        exit(EXIT_FAILURE);
    }
 
    odp_init_param_init(&init_param);
    init_param.mem_model = helper_options.mem_model;
 
    memset(&cargs, 0, sizeof(cargs));
 
    /* Parse and store the application arguments */
    parse_args(argc, argv, &cargs);
 
    /* Init ODP before calling anything else */
    if (odp_init_global(&instance, &init_param, NULL)) {
        ODPH_ERR("ODP global init failed.\n");
        exit(EXIT_FAILURE);
    }
 
    /* Init this thread */
    odp_init_local(instance, ODP_THREAD_WORKER);
 
    odp_sys_info_print();
    memset(&crypto_capa, 0, sizeof(crypto_capa));
 
    if (odp_crypto_capability(&crypto_capa)) {
        ODPH_ERR("Crypto capability request failed.\n");
        exit(EXIT_FAILURE);
    }
 
    if (cargs.schedule && crypto_capa.queue_type_sched == 0) {
        ODPH_ERR("scheduled type completion queue not supported.\n");
        exit(EXIT_FAILURE);
    }
 
    if (cargs.poll && crypto_capa.queue_type_plain == 0) {
        ODPH_ERR("plain type completion queue not supported.\n");
        exit(EXIT_FAILURE);
    }
 
    if (odp_pool_capability(&pool_capa)) {
        ODPH_ERR("Pool capability request failed.\n");
        exit(EXIT_FAILURE);
    }
 
    max_seg_len = pool_capa.pkt.max_seg_len;
 
    for (i = 0; i < ODPH_ARRAY_SIZE(payloads); i++) {
        if (payloads[i] + MAX_AUTH_DIGEST_LEN > max_seg_len)
            break;
    }
 
    num_payloads = i;
 
    /* Create packet pool */
    odp_pool_param_init(&params);
    params.pkt.seg_len = max_seg_len;
    params.pkt.len     = max_seg_len;
    params.pkt.num     = POOL_NUM_PKT;
    params.type    = ODP_POOL_PACKET;
    pool = odp_pool_create("packet_pool", &params);
 
    if (pool == ODP_POOL_INVALID) {
        ODPH_ERR("packet pool create failed.\n");
        exit(EXIT_FAILURE);
    }
    odp_pool_print(pool);
 
    odp_queue_param_init(&qparam);
    if (cargs.schedule) {
        odp_schedule_config(NULL);
        qparam.type = ODP_QUEUE_TYPE_SCHED;
        qparam.sched.prio  = odp_schedule_default_prio();
        qparam.sched.sync  = ODP_SCHED_SYNC_PARALLEL;
        qparam.sched.group = ODP_SCHED_GROUP_ALL;
        out_queue = odp_queue_create("crypto-out", &qparam);
    } else if (cargs.poll) {
        qparam.type = ODP_QUEUE_TYPE_PLAIN;
        out_queue = odp_queue_create("crypto-out", &qparam);
    }
    if (cargs.schedule || cargs.poll) {
        if (out_queue == ODP_QUEUE_INVALID) {
            ODPH_ERR("crypto-out queue create failed.\n");
            exit(EXIT_FAILURE);
        }
    }
 
    if (cargs.schedule) {
        printf("Run in async scheduled mode\n");
        num_workers = odp_cpumask_default_worker(&cpumask,
                             num_workers);
        (void)odp_cpumask_to_str(&cpumask, cpumaskstr,
                     sizeof(cpumaskstr));
        printf("num worker threads:  %i\n",
               num_workers);
        printf("first CPU:       %i\n",
               odp_cpumask_first(&cpumask));
        printf("cpu mask:        %s\n",
               cpumaskstr);
    } else if (cargs.poll) {
        printf("Run in async poll mode\n");
    } else {
        printf("Run in sync mode\n");
    }
 
    test_run_arg.crypto_args       = cargs;
    test_run_arg.crypto_alg_config = cargs.alg_config;
    test_run_arg.crypto_capa       = crypto_capa;
 
    if (cargs.alg_config) {
        odph_thread_common_param_init(&thr_common);
        thr_common.instance = instance;
        thr_common.cpumask = &cpumask;
        thr_common.share_param = 1;
 
        if (cargs.schedule) {
            odph_thread_param_init(&thr_param);
            thr_param.start = run_thr_func;
            thr_param.arg = &test_run_arg;
            thr_param.thr_type = ODP_THREAD_WORKER;
 
            memset(thread_tbl, 0, sizeof(thread_tbl));
            odph_thread_create(thread_tbl, &thr_common, &thr_param, num_workers);
 
            odph_thread_join(thread_tbl, num_workers);
        } else {
            run_measure_one_config(&test_run_arg);
        }
    } else {
        for (i = 0; i < ODPH_ARRAY_SIZE(algs_config); i++) {
            test_run_arg.crypto_alg_config = algs_config + i;
            run_measure_one_config(&test_run_arg);
        }
    }
 
    if (cargs.schedule || cargs.poll)
        odp_queue_destroy(out_queue);
    if (odp_pool_destroy(pool)) {
        ODPH_ERR("Error: pool destroy\n");
        exit(EXIT_FAILURE);
    }
 
    if (odp_term_local()) {
        ODPH_ERR("Error: term local\n");
        exit(EXIT_FAILURE);
    }
 
    if (odp_term_global(instance)) {
        ODPH_ERR("Error: term global\n");
        exit(EXIT_FAILURE);
    }
 
    return 0;
}
 
static void parse_args(int argc, char *argv[], crypto_args_t *cargs)
{
    int opt;
    int long_index;
    static const struct option longopts[] = {
        {"algorithm", optional_argument, NULL, 'a'},
        {"debug",  no_argument, NULL, 'd'},
        {"flight", optional_argument, NULL, 'f'},
        {"help", no_argument, NULL, 'h'},
        {"iterations", optional_argument, NULL, 'i'},
        {"inplace", no_argument, NULL, 'n'},
        {"payload", optional_argument, NULL, 'l'},
        {"sessions", optional_argument, NULL, 'm'},
        {"reuse", no_argument, NULL, 'r'},
        {"poll", no_argument, NULL, 'p'},
        {"schedule", no_argument, NULL, 's'},
        {NULL, 0, NULL, 0}
    };
 
    static const char *shortopts = "+a:c:df:hi:m:nl:spr";
 
    cargs->in_place = 0;
    cargs->in_flight = 1;
    cargs->debug_packets = 0;
    cargs->iteration_count = 10000;
    cargs->payload_length = 0;
    cargs->alg_config = NULL;
    cargs->reuse_packet = 0;
    cargs->schedule = 0;
 
    while (1) {
        opt = getopt_long(argc, argv, shortopts, longopts, &long_index);
 
        if (opt == -1)
            break;  /* No more options */
 
        switch (opt) {
        case 'a':
            cargs->alg_config = find_config_by_name(optarg);
            if (!cargs->alg_config) {
                printf("cannot test crypto '%s' configuration\n",
                       optarg);
                usage(argv[0]);
                exit(-1);
            }
            break;
        case 'd':
            cargs->debug_packets = 1;
            break;
        case 'i':
            cargs->iteration_count = atoi(optarg);
            break;
        case 'f':
            cargs->in_flight = atoi(optarg);
            break;
        case 'h':
            usage(argv[0]);
            exit(EXIT_SUCCESS);
            break;
        case 'm':
            cargs->max_sessions = atoi(optarg);
            break;
        case 'n':
            cargs->in_place = 1;
            break;
        case 'l':
            cargs->payload_length = atoi(optarg);
            break;
        case 'r':
            cargs->reuse_packet = 1;
            break;
        case 's':
            cargs->schedule = 1;
            break;
        case 'p':
            cargs->poll = 1;
            break;
        default:
            break;
        }
    }
 
    optind = 1;     /* reset 'extern optind' from the getopt lib */
 
    if ((cargs->in_flight > 1) && cargs->reuse_packet) {
        printf("-f (in flight > 1) and -r (reuse packet) options are not compatible\n");
        usage(argv[0]);
        exit(-1);
    }
    if (cargs->schedule && cargs->poll) {
        printf("-s (schedule) and -p (poll) options are not compatible\n");
        usage(argv[0]);
        exit(-1);
    }
}
 
static void usage(char *progname)
{
    printf("\n"
           "Usage: %s OPTIONS\n"
           "  E.g. %s -i 100000\n"
           "\n"
           "OpenDataPlane crypto speed measure.\n"
           "Optional OPTIONS\n"
           "  -a, --algorithm <name> Specify algorithm name (default all)\n"
           "             Supported values are:\n",
           progname, progname);
 
    print_config_names("                      ");
    printf("  -d, --debug          Enable dump of processed packets.\n"
           "  -f, --flight <number> Max number of packet processed in parallel (default 1)\n"
           "  -i, --iterations <number> Number of iterations.\n"
           "  -n, --inplace        Encrypt on place.\n"
           "  -l, --payload        Payload length.\n"
           "  -r, --reuse          Output encrypted packet is passed as input\n"
           "               to next encrypt iteration.\n"
           "  -s, --schedule       Use scheduler for completion events.\n"
           "  -p, --poll           Poll completion queue for completion events.\n"
           "  -h, --help           Display help and exit.\n"
           "\n");
}