Add evp_hash perftool

Author: andrewkdinh

source/CMakeLists.txt

@@ -184,3 +184,6 @@ target_link_libraries(evp_setpeer PRIVATE perf)
 
 add_executable(writeread writeread.c)
 target_link_libraries(writeread PRIVATE perf)
+
+add_executable(evp_hash evp_hash.c)
+target_link_libraries(evp_hash PRIVATE perf)

source/evp_hash.c

@@ -0,0 +1,298 @@
+/*
+ * Copyright 2025 The OpenSSL Project Authors. All Rights Reserved.
+ *
+ * Licensed under the Apache License 2.0 (the "License").  You may not use
+ * this file except in compliance with the License.  You can obtain a copy
+ * in the file LICENSE in the source distribution or at
+ * https://www.openssl.org/source/license.html
+ */
+
+/*
+ * This CLI tool computes hashes using the specified algorithm. Uses the EVP API
+ * by default, but this tool can also use the corresponding deprecated API's.
+ * Prints out the average time per hash computation.
+ */
+
+#include <stdlib.h>
+#include <stdio.h>
+#ifndef _WIN32
+# include <unistd.h>
+# include <libgen.h>
+#else
+# include <windows.h>
+# include "perflib/getopt.h"
+#endif	/* _WIN32 */
+
+#include <openssl/evp.h>
+#include <openssl/rand.h>
+#include "perflib/perflib.h"
+
+#define RUN_TIME 5
+#define DATA_SIZE 1500
+
+size_t *counts = NULL;
+OSSL_TIME max_time;
+int err = 0;
+static int threadcount;
+size_t num_calls;
+
+typedef enum {
+    SHA1_ALG = 0,
+    SHA224_ALG,
+    SHA256_ALG,
+    SHA384_ALG,
+    SHA512_ALG,
+} hash_algorithm_type;
+
+static unsigned char data[DATA_SIZE];
+static int deprecated_api = 0;
+static int update_times = 1;
+static int hash_algorithm = -1;
+
+int hash_deprecated()
+{
+    int i;
+    SHA_CTX sha_ctx;
+    SHA256_CTX sha256_ctx;
+    SHA512_CTX sha512_ctx;
+    unsigned char md[EVP_MAX_MD_SIZE];
+
+    switch (hash_algorithm) {
+    case SHA1_ALG:
+        if (!SHA1_Init(&sha_ctx))
+            return 0;
+        for (i = 0; i < update_times; i++)
+            if (!SHA1_Update(&sha_ctx, data, sizeof(data)))
+                return 0;
+        if (!SHA1_Final(md, &sha_ctx))
+            return 0;
+        break;
+    case SHA224_ALG:
+        if (!SHA224_Init(&sha256_ctx))
+            return 0;
+        for (i = 0; i < update_times; i++)
+            if (!SHA224_Update(&sha256_ctx, data, sizeof(data)))
+                return 0;
+        if (!SHA224_Final(md, &sha256_ctx))
+            return 0;
+        break;
+    case SHA256_ALG:
+        if (!SHA256_Init(&sha256_ctx))
+            return 0;
+        for (i = 0; i < update_times; i++)
+            if (!SHA256_Update(&sha256_ctx, data, sizeof(data)))
+                return 0;
+        if (!SHA256_Final(md, &sha256_ctx))
+            return 0;
+        break;
+    case SHA384_ALG:
+        if (!SHA384_Init(&sha512_ctx))
+            return 0;
+        for (i = 0; i < update_times; i++)
+            if (!SHA384_Update(&sha512_ctx, data, sizeof(data)))
+                return 0;
+        if (!SHA384_Final(md, &sha512_ctx))
+            return 0;
+        break;
+    case SHA512_ALG:
+        if (!SHA512_Init(&sha512_ctx))
+            return 0;
+        for (i = 0; i < update_times; i++)
+            if (!SHA512_Update(&sha512_ctx, data, sizeof(data)))
+                return 0;
+        if (!SHA512_Final(md, &sha512_ctx))
+            return 0;
+        break;
+    default:
+        return 0;
+    }
+
+    return 1;
+}
+
+int hash_evp(EVP_MD_CTX *mctx, const EVP_MD *evp_md)
+{
+    int i;
+    unsigned char md[EVP_MAX_MD_SIZE];
+
+    if (!EVP_DigestInit(mctx, evp_md))
+        return 0;
+
+    for (i = 0; i < update_times; i++)
+        if (!EVP_DigestUpdate(mctx, data, sizeof(data)))
+            return 0;
+
+    if (!EVP_DigestFinal(mctx, md, NULL))
+        return 0;
+
+    return 1;
+}
+
+void do_hash(size_t num)
+{
+    OSSL_TIME time;
+    EVP_MD_CTX *mctx = NULL; 
+    const EVP_MD *evp_md = NULL;
+
+    counts[num] = 0;
+
+    if (!deprecated_api) {
+        switch (hash_algorithm) {
+        case SHA1_ALG:
+            evp_md = EVP_sha1();
+            break;
+        case SHA224_ALG:
+            evp_md = EVP_sha224();
+            break;
+        case SHA256_ALG:
+            evp_md = EVP_sha256();
+            break;
+        case SHA384_ALG:
+            evp_md = EVP_sha384();
+            break;
+        case SHA512_ALG:
+            evp_md = EVP_sha512();
+            break;
+        default:
+            err = 1;
+            return;
+        }
+
+        if ((mctx = EVP_MD_CTX_new()) == NULL)
+            return;
+    }
+
+    do {
+        if (deprecated_api) {
+            if (!hash_deprecated())
+                err = 1;
+        } else if (!hash_evp(mctx, evp_md)) {
+            err = 1;
+        }
+
+        if (err)
+            goto err;
+ 
+        counts[num]++;
+        time = ossl_time_now();
+    } while (time.t < max_time.t);
+
+err:
+    EVP_MD_CTX_free(mctx);
+}
+
+void print_help()
+{
+    printf("Usage: evp_hash [-h] [-x] [-t] update-times algorithm thread-count\n");
+    printf("-h - print this help output\n");
+    printf("-x - use deprecated API instead of EVP API\n");
+    printf("-t - terse output\n");
+    printf("update-times - times to update digest. 1 for one-shot\n");
+    printf("algorithm - one of: [SHA1, SHA224, SHA256, SHA384, SHA512]\n");
+    printf("thread-count - number of threads\n");
+}
+
+int main(int argc, char *argv[])
+{
+    OSSL_TIME duration;
+    size_t total_count = 0;
+    double av;
+    int terse = 0;
+    int j, opt, rc = EXIT_FAILURE;
+
+    while ((opt = getopt(argc, argv, "htx")) != -1) {
+        switch (opt) {
+        case 't':
+            terse = 1;
+            break;
+        case 'x':
+            deprecated_api = 1;
+            break;
+        case 'h':
+        default:
+            print_help();
+            goto out;
+        }
+    }
+
+    if (argv[optind] == NULL
+        || argv[optind+1] == NULL
+        || argv[optind+2] == NULL
+        || argv[optind+3] != NULL) {
+        fprintf(stderr, "Incorrect number of arguments\n");
+        print_help();
+        goto out;
+    }
+
+    update_times = atoi(argv[optind]);
+    if (update_times <= 0) {
+        fprintf(stderr, "update-times must be a positive integer\n");
+        goto out;
+    }
+
+    if (strcmp(argv[optind+1], "SHA1") == 0) {
+        hash_algorithm = SHA1_ALG;
+    } else if (strcmp(argv[optind+1], "SHA224") == 0) {
+        hash_algorithm = SHA224_ALG;
+    } else if (strcmp(argv[optind+1], "SHA256") == 0) {
+        hash_algorithm = SHA256_ALG;
+    } else if (strcmp(argv[optind+1], "SHA384") == 0) {
+        hash_algorithm = SHA384_ALG;
+    } else if (strcmp(argv[optind+1], "SHA512") == 0) {
+        hash_algorithm = SHA512_ALG;
+    } else {
+        fprintf(stderr, "algorithm is one of: [SHA1, SHA224, SHA256, SHA384, SHA512]\n");
+        print_help();
+        goto out;
+    }
+
+    threadcount = atoi(argv[optind+2]);
+    if (threadcount < 1) {
+        fprintf(stderr, "thread-count must be a positive integer\n");
+        print_help();
+        goto out;
+    }
+
+    if (!RAND_bytes((unsigned char *)data, sizeof(data)))
+        goto out;
+
+    max_time = ossl_time_add(ossl_time_now(), ossl_seconds2time(RUN_TIME));
+
+    counts = OPENSSL_malloc(sizeof(size_t) * threadcount);
+    if (counts == NULL) {
+        fprintf(stderr, "Failed to create counts array\n");
+        goto out;
+    }
+
+    if (!perflib_run_multi_thread_test(do_hash, threadcount, &duration)) {
+        fprintf(stderr, "Failed to run the test\n");
+        goto out;
+    }
+
+    if (err) {
+        fprintf(stderr, "Error during test\n");
+        goto out;
+    }
+
+    for (j = 0; j < threadcount; j++)
+        total_count += counts[j];
+
+    /*
+     * Hashing is pretty fast, running in only a few us. But ossl_time2us does
+     * integer division and so because the average us computed above is less
+     * than the value of OSSL_TIME_US, we wind up with truncation to zero in the
+     * math. Instead, manually do the division, casting our values as doubles so
+     * that we compute the proper time.
+     */
+    av = (double)RUN_TIME * 1e6 * threadcount / total_count;
+
+    if (terse)
+        printf("%lf\n", av);
+    else
+        printf("Average time per hash: %lfus\n", av);
+
+    rc = EXIT_SUCCESS;
+out:
+    OPENSSL_free(counts);
+    return rc;
+}