Skip to content

Commit

Permalink
update XSUM_benchMem() doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Cyan4973 committed May 8, 2024
1 parent 92d2839 commit 8e483e4
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions cli/xsum_bench.c
Original file line number Diff line number Diff line change
Expand Up @@ -340,9 +340,13 @@ static char* XSUM_strcatDup(const char* s1, const char* s2)

/*!
* XSUM_benchMem():
* buffer: Must be 16-byte aligned.
* The real allocated size of buffer is supposed to be >= (bufferSize+3).
* returns: 0 on success, 1 if error (invalid mode selected)
* Benchmark provided content up to twice per function:
* - once at provided aligned memory address (%16)
* - second time at unaligned memory address (+3)
* Enabled functions and modes are provided via @g_hashesToBench global variable.
* @buffer: Must be 16-byte aligned.
* The allocated size of underlying @buffer must be >= (@bufferSize+3).
* This function also fills @g_benchSecretBuf, to bench XXH3's _withSecret() variants.
*/
static void XSUM_benchMem(const void* buffer, size_t bufferSize)
{
Expand Down

0 comments on commit 8e483e4

Please sign in to comment.