218 lines
7.8 KiB
C
218 lines
7.8 KiB
C
/*
|
|
* Main program to benchmark hash functions
|
|
* Part of xxHash project
|
|
* Copyright (C) 2019-present, Yann Collet
|
|
*
|
|
* BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are
|
|
* met:
|
|
*
|
|
* * Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* * Redistributions in binary form must reproduce the above
|
|
* copyright notice, this list of conditions and the following disclaimer
|
|
* in the documentation and/or other materials provided with the
|
|
* distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* You can contact the author at :
|
|
* - xxHash homepage: http://www.xxhash.com
|
|
* - xxHash source repository : https://github.com/Cyan4973/xxHash
|
|
*/
|
|
|
|
|
|
/* === dependencies === */
|
|
|
|
#include <stdio.h> /* printf */
|
|
#include <limits.h> /* INT_MAX */
|
|
#include "bhDisplay.h" /* bench_x */
|
|
|
|
|
|
/* === defines list of hashes `hashCandidates` and NB_HASHES *** */
|
|
|
|
#include "hashes.h"
|
|
|
|
|
|
/* === parse command line === */
|
|
|
|
#undef NDEBUG
|
|
#include <assert.h>
|
|
|
|
|
|
/*! readIntFromChar() :
|
|
* allows and interprets K, KB, KiB, M, MB and MiB suffix.
|
|
* Will also modify `*stringPtr`, advancing it to position where it stopped reading.
|
|
*/
|
|
static int readIntFromChar(const char** stringPtr)
|
|
{
|
|
static int const max = (INT_MAX / 10) - 1;
|
|
int result = 0;
|
|
while ((**stringPtr >='0') && (**stringPtr <='9')) {
|
|
assert(result < max);
|
|
result *= 10;
|
|
result += (unsigned)(**stringPtr - '0');
|
|
(*stringPtr)++ ;
|
|
}
|
|
if ((**stringPtr=='K') || (**stringPtr=='M')) {
|
|
int const maxK = INT_MAX >> 10;
|
|
assert(result < maxK);
|
|
result <<= 10;
|
|
if (**stringPtr=='M') {
|
|
assert(result < maxK);
|
|
result <<= 10;
|
|
}
|
|
(*stringPtr)++; /* skip `K` or `M` */
|
|
if (**stringPtr=='i') (*stringPtr)++;
|
|
if (**stringPtr=='B') (*stringPtr)++;
|
|
}
|
|
return result;
|
|
}
|
|
|
|
|
|
/** longCommand() :
|
|
* check if string is the same as longCommand.
|
|
* If yes, @return 1 and advances *stringPtr to the position which immediately follows longCommand.
|
|
* @return 0 and doesn't modify *stringPtr otherwise.
|
|
*/
|
|
static int isCommand(const char* stringPtr, const char* longCommand)
|
|
{
|
|
size_t const comSize = strlen(longCommand);
|
|
assert(stringPtr); assert(longCommand);
|
|
return !strncmp(stringPtr, longCommand, comSize);
|
|
}
|
|
|
|
/** longCommandWArg() :
|
|
* check if *stringPtr is the same as longCommand.
|
|
* If yes, @return 1 and advances *stringPtr to the position which immediately follows longCommand.
|
|
* @return 0 and doesn't modify *stringPtr otherwise.
|
|
*/
|
|
static int longCommandWArg(const char** stringPtr, const char* longCommand)
|
|
{
|
|
size_t const comSize = strlen(longCommand);
|
|
int const result = isCommand(*stringPtr, longCommand);
|
|
if (result) *stringPtr += comSize;
|
|
return result;
|
|
}
|
|
|
|
|
|
/* === default values - can be redefined at compilation time === */
|
|
|
|
#ifndef SMALL_SIZE_MIN_DEFAULT
|
|
# define SMALL_SIZE_MIN_DEFAULT 1
|
|
#endif
|
|
#ifndef SMALL_SIZE_MAX_DEFAULT
|
|
# define SMALL_SIZE_MAX_DEFAULT 127
|
|
#endif
|
|
#ifndef LARGE_SIZELOG_MIN_DEFAULT
|
|
# define LARGE_SIZELOG_MIN_DEFAULT 9
|
|
#endif
|
|
#ifndef LARGE_SIZELOG_MAX_DEFAULT
|
|
# define LARGE_SIZELOG_MAX_DEFAULT 27
|
|
#endif
|
|
|
|
|
|
static int display_hash_names(void)
|
|
{
|
|
int i;
|
|
printf("available hashes : \n");
|
|
for (i=0; i<NB_HASHES; i++) {
|
|
printf("%s, ", hashCandidates[i].name);
|
|
}
|
|
printf("\b\b \n");
|
|
return 0;
|
|
}
|
|
|
|
/* @return : hashID (necessarily between 0 and NB_HASHES) if present
|
|
* -1 on error (hname not present)
|
|
*/
|
|
static int hashID(const char* hname)
|
|
{
|
|
int id;
|
|
assert(hname);
|
|
for (id=0; id < NB_HASHES; id++) {
|
|
assert(hashCandidates[id].name);
|
|
if (strlen(hname) != strlen(hashCandidates[id].name)) continue;
|
|
if (isCommand(hname, hashCandidates[id].name)) return id;
|
|
}
|
|
return -1;
|
|
}
|
|
|
|
static int help(const char* exename)
|
|
{
|
|
printf("usage : %s [options] [hash] \n\n", exename);
|
|
printf("Options: \n");
|
|
printf("--list : name available hash algorithms and exit \n");
|
|
printf("--mins=# : starting length for small size bench (default:%i) \n", SMALL_SIZE_MIN_DEFAULT);
|
|
printf("--maxs=# : end length for small size bench (default:%i) \n", SMALL_SIZE_MAX_DEFAULT);
|
|
printf("--minl=# : starting log2(length) for large size bench (default:%i) \n", LARGE_SIZELOG_MIN_DEFAULT);
|
|
printf("--maxl=# : end log2(length) for large size bench (default:%i) \n", LARGE_SIZELOG_MAX_DEFAULT);
|
|
printf("[hash] : is optional, bench all available hashes if not provided \n");
|
|
return 0;
|
|
}
|
|
|
|
static int badusage(const char* exename)
|
|
{
|
|
printf("Bad command ... \n");
|
|
help(exename);
|
|
return 1;
|
|
}
|
|
|
|
int main(int argc, const char** argv)
|
|
{
|
|
const char* const exename = argv[0];
|
|
int hashNb = 0;
|
|
int nb_h_test = NB_HASHES;
|
|
int largeTest_log_min = LARGE_SIZELOG_MIN_DEFAULT;
|
|
int largeTest_log_max = LARGE_SIZELOG_MAX_DEFAULT;
|
|
size_t smallTest_size_min = SMALL_SIZE_MIN_DEFAULT;
|
|
size_t smallTest_size_max = SMALL_SIZE_MAX_DEFAULT;
|
|
|
|
int arg_nb;
|
|
for (arg_nb = 1; arg_nb < argc; arg_nb++) {
|
|
const char** arg = argv + arg_nb;
|
|
if (isCommand(*arg, "-h")) { assert(argc >= 1); return help(exename); }
|
|
if (isCommand(*arg, "--list")) { return display_hash_names(); }
|
|
if (longCommandWArg(arg, "--n=")) { nb_h_test = readIntFromChar(arg); continue; } /* hidden command */
|
|
if (longCommandWArg(arg, "--minl=")) { largeTest_log_min = readIntFromChar(arg); continue; }
|
|
if (longCommandWArg(arg, "--maxl=")) { largeTest_log_max = readIntFromChar(arg); continue; }
|
|
if (longCommandWArg(arg, "--mins=")) { smallTest_size_min = (size_t)readIntFromChar(arg); continue; }
|
|
if (longCommandWArg(arg, "--maxs=")) { smallTest_size_max = (size_t)readIntFromChar(arg); continue; }
|
|
/* not a command : must be a hash name */
|
|
hashNb = hashID(*arg);
|
|
if (hashNb >= 0) {
|
|
nb_h_test = 1;
|
|
} else {
|
|
/* not a hash name : error */
|
|
return badusage(exename);
|
|
}
|
|
}
|
|
|
|
if (hashNb + nb_h_test > NB_HASHES) { printf("wrong hash selection \n"); return 1; } /* border case (requires (mis)using hidden command `--n=#`) */
|
|
|
|
printf(" === benchmarking %i hash functions === \n", nb_h_test);
|
|
if (largeTest_log_max >= largeTest_log_min) {
|
|
bench_largeInput(hashCandidates+hashNb, nb_h_test, largeTest_log_min, largeTest_log_max);
|
|
}
|
|
if (smallTest_size_max >= smallTest_size_min) {
|
|
bench_throughput_smallInputs(hashCandidates+hashNb, nb_h_test, smallTest_size_min, smallTest_size_max);
|
|
bench_throughput_randomInputLength(hashCandidates+hashNb, nb_h_test, smallTest_size_min, smallTest_size_max);
|
|
bench_latency_smallInputs(hashCandidates+hashNb, nb_h_test, smallTest_size_min, smallTest_size_max);
|
|
bench_latency_randomInputLength(hashCandidates+hashNb, nb_h_test, smallTest_size_min, smallTest_size_max);
|
|
}
|
|
|
|
return 0;
|
|
}
|