Merge pull request #376 from Tarsnap/libcperciva-import

cperciva · web-flow · commit fbd5b105b75d · 2023-10-11T17:11:41.000-07:00
Libcperciva import and trivial fixes
diff --git a/lib-platform/crypto/crypto_scrypt.c b/lib-platform/crypto/crypto_scrypt.c
@@ -45,7 +45,7 @@
 
 #include "crypto_scrypt.h"
 
-static void (*smix_func)(uint8_t *, size_t, uint64_t, void *, void *) = NULL;
+static void (* smix_func)(uint8_t *, size_t, uint64_t, void *, void *) = NULL;
 
 /**
  * crypto_scrypt_internal(passwd, passwdlen, salt, saltlen, N, r, p, buf,
@@ -56,7 +56,7 @@ static int
 crypto_scrypt_internal(const uint8_t * passwd, size_t passwdlen,
     const uint8_t * salt, size_t saltlen, uint64_t N, uint32_t _r, uint32_t _p,
     uint8_t * buf, size_t buflen,
-    void (*smix)(uint8_t *, size_t, uint64_t, void *, void *))
+    void (* smix)(uint8_t *, size_t, uint64_t, void *, void *))
 {
 	void * B0, * V0, * XY0;
 	uint8_t * B;
@@ -192,7 +192,7 @@ static struct scrypt_test {
 };
 
 static int
-testsmix(void (*smix)(uint8_t *, size_t, uint64_t, void *, void *))
+testsmix(void (* smix)(uint8_t *, size_t, uint64_t, void *, void *))
 {
 	uint8_t hbuf[TESTLEN];
 
diff --git a/lib/scryptenc/scryptenc_cpuperf.c b/lib/scryptenc/scryptenc_cpuperf.c
@@ -46,6 +46,7 @@ getclockdiff(struct timeval * st, double * diffd)
 		return (1);
 	*diffd = timeval_diff((*st), en);
 
+	/* Success! */
 	return (0);
 }
 
diff --git a/libcperciva/POSIX/posix-abstract-declarator.c b/libcperciva/POSIX/posix-abstract-declarator.c
@@ -9,6 +9,8 @@ func(int arr[static restrict 1])
 {
 
 	(void)arr; /* UNUSED */
+
+	/* Success! */
 	return (0);
 }
 
@@ -17,5 +19,7 @@ main(void)
 {
 
 	(void)func; /* UNUSED */
+
+	/* Success! */
 	return (0);
 }
diff --git a/libcperciva/POSIX/posix-stat-st_mtim.c b/libcperciva/POSIX/posix-stat-st_mtim.c
@@ -8,5 +8,6 @@ main(void)
 	/* Can we reference st_mtim? */
 	(void)sb.st_mtim.tv_sec;
 
+	/* Success! */
 	return (0);
 }
diff --git a/libcperciva/POSIX/posix-trivial.c b/libcperciva/POSIX/posix-trivial.c
@@ -2,5 +2,6 @@ int
 main(void)
 {
 
+	/* Success! */
 	return (0);
 }
diff --git a/libcperciva/alg/sha256.c b/libcperciva/alg/sha256.c
@@ -140,7 +140,7 @@ static int
 hwtest(const uint32_t state[static restrict 8],
     const uint8_t block[static restrict 64],
     uint32_t W[static restrict 64], uint32_t S[static restrict 8],
-    void(* func)(uint32_t state[static restrict 8],
+    void (* func)(uint32_t state[static restrict 8],
     const uint8_t block[static restrict 64], uint32_t W[static restrict 64],
     uint32_t S[static restrict 8]))
 {
diff --git a/libcperciva/cpusupport/Build/cpusupport-ARM-AES.c b/libcperciva/cpusupport/Build/cpusupport-ARM-AES.c
@@ -17,5 +17,6 @@ main(void)
 
 	lanes = vdupq_laneq_u32(lanes, 0);
 
+	/* Success! */
 	return (0);
 }
diff --git a/libcperciva/cpusupport/Build/cpusupport-ARM-SHA256.c b/libcperciva/cpusupport/Build/cpusupport-ARM-SHA256.c
@@ -12,5 +12,6 @@ main(void)
 	output = vsha256su0q_u32(w0, w4);
 	(void)output; /* UNUSED */
 
+	/* Success! */
 	return (0);
 }
diff --git a/libcperciva/crypto/crypto_aes.c b/libcperciva/crypto/crypto_aes.c
@@ -67,7 +67,7 @@ static struct aes_test {
 
 /* Test a function against test vectors. */
 static int
-functest(int(* func)(const uint8_t *, size_t, const uint8_t[16], uint8_t[16]))
+functest(int (* func)(const uint8_t *, size_t, const uint8_t[16], uint8_t[16]))
 {
 	struct aes_test * knowngood;
 	uint8_t ctext[16];
diff --git a/libcperciva/crypto/crypto_aesctr_shared.c b/libcperciva/crypto/crypto_aesctr_shared.c
@@ -81,6 +81,7 @@ crypto_aesctr_stream_pre_wholeblock(struct crypto_aesctr * stream,
 		    buflen_p, 16 - bytemod, bytemod);
 	}
 
+	/* Success! */
 	return (0);
 }
 
diff --git a/libcperciva/util/monoclock.c b/libcperciva/util/monoclock.c
@@ -97,8 +97,8 @@ monoclock_get_cputime(struct timeval * tv)
 
 /**
  * monoclock_getres(resd):
- * Store an upper limit on timer granularity in ${resd}. If CLOCK_MONOTONIC is
- * available, use that clock; if CLOCK_MONOTONIC is unavailable, use
+ * Store an upper limit on timer granularity in ${resd}.  If CLOCK_MONOTONIC
+ * is available, use that clock; if CLOCK_MONOTONIC is unavailable, use
  * CLOCK_REALTIME (if available) or gettimeofday(2).  For this value to be
  * meaningful, we assume that clock_getres(x) succeeds iff clock_gettime(x)
  * succeeds.
diff --git a/libcperciva/util/monoclock.h b/libcperciva/util/monoclock.h
@@ -25,8 +25,8 @@ int monoclock_get_cputime(struct timeval *);
 
 /**
  * monoclock_getres(resd):
- * Store an upper limit on timer granularity in ${resd}. If CLOCK_MONOTONIC is
- * available, use that clock; if CLOCK_MONOTONIC is unavailable, use
+ * Store an upper limit on timer granularity in ${resd}.  If CLOCK_MONOTONIC
+ * is available, use that clock; if CLOCK_MONOTONIC is unavailable, use
  * CLOCK_REALTIME (if available) or gettimeofday(2).  For this value to be
  * meaningful, we assume that clock_getres(x) succeeds iff clock_gettime(x)
  * succeeds.
diff --git a/tests/shared_test_functions.sh b/tests/shared_test_functions.sh
@@ -12,12 +12,14 @@
 #
 ### Design
 #
-# The main function is scenario_runner(scenario_filename), which
+# The main function is _scenario_runner(scenario_filename), which
 # takes a scenario file as the argument, and runs a
 #     scenario_cmd()
 # function which was defined in that file.
 #
 # Functions which are available to other scripts as a "public API" are:
+# - find_system(cmd, args):
+#   Look for ${cmd} in the ${PATH}, and ensure that it supports ${args}.
 # - has_pid(cmd):
 #   Look for a ${cmd} in $(ps).
 # - wait_while(func):
@@ -29,6 +31,8 @@
 # - run_scenarios():
 #   Run scenarios in the test directory.
 #
+# We adopt the convention of "private" function names beginning with an _.
+#
 ### Variables
 #
 # Wherever possible, this suite uses local variables and
@@ -73,9 +77,9 @@ bindir=$(CDPATH='' cd -- "$(dirname -- "${1-.}")" && pwd -P)
 NO_EXITFILE=/dev/null
 
 
-## prepare_directory():
+## _prepare_directory():
 # Delete the previous test output directory, and create a new one.
-prepare_directory() {
+_prepare_directory() {
 	if [ -d "${out}" ]; then
 		rm -rf "${out}"
 	fi
@@ -86,7 +90,7 @@ prepare_directory() {
 }
 
 ## find_system (cmd, args):
-# Look for ${cmd} in the $PATH, and ensure that it supports ${args}.
+# Look for ${cmd} in the ${PATH}, and ensure that it supports ${args}.
 find_system() {
 	cmd=$1
 	cmd_with_args="$1 ${2:-}"
@@ -207,14 +211,14 @@ expected_exitcode() {
 	fi
 }
 
-## notify_success_or_fail (log_basename, val_log_basename):
+## _notify_success_or_fail (log_basename, val_log_basename):
 # Examine all "exit code" files beginning with ${log_basename} and
 # print "SUCCESS!", "FAILED!", "SKIP!", or "PARTIAL SUCCESS / SKIP!"
 # as appropriate.  Check any valgrind log files associated with the
 # test and print "FAILED!" if appropriate, along with the valgrind
 # logfile.  If the test failed and ${VERBOSE} is non-zero, print
 # the description to stderr.
-notify_success_or_fail() {
+_notify_success_or_fail() {
 	log_basename=$1
 	val_log_basename=$2
 
@@ -278,9 +282,9 @@ notify_success_or_fail() {
 	fi
 }
 
-## scenario_runner (scenario_filename):
+## _scenario_runner (scenario_filename):
 # Run a test scenario from ${scenario_filename}.
-scenario_runner() {
+_scenario_runner() {
 	scenario_filename=$1
 	basename=$(basename "${scenario_filename}" .sh)
 	printf "  %s... " "${basename}" 1>&2
@@ -307,13 +311,14 @@ scenario_runner() {
 
 	# Print PASS or FAIL, and return result.
 	s_retval=0
-	notify_success_or_fail "${s_basename}" "${s_val_basename}"
+	_notify_success_or_fail "${s_basename}" "${s_val_basename}"
 
 	return "${s_retval}"
 }
 
-## run_scenarios (scenario_filenames):
-# Run all scenarios matching ${scenario_filenames}.
+## run_scenarios ():
+# Run all scenarios in the test directory.  If the environment variable ${N}
+# is specified, only run the scenario corresponding to that number.
 run_scenarios() {
 	# Get the test number(s) to run.
 	if [ "${N:-0}" -gt "0" ]; then
@@ -323,7 +328,7 @@ run_scenarios() {
 	fi
 
 	# Clean up any previous directory, and create a new one.
-	prepare_directory
+	_prepare_directory
 
 	# Clean up any previous valgrind directory, and prepare for new
 	# valgrind tests (if applicable).
@@ -334,7 +339,7 @@ run_scenarios() {
 	for scenario in ${test_scenarios}; do
 		# We can't call this function with $( ... ) because we
 		# want to allow it to echo values to stdout.
-		scenario_runner "${scenario}"
+		_scenario_runner "${scenario}"
 		retval=$?
 		if [ "${retval}" -gt 0 ]; then
 			exit "${retval}"
diff --git a/tests/shared_valgrind_functions.sh b/tests/shared_valgrind_functions.sh

Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,7 @@ getclockdiff(struct timeval * st, double * diffd)`
`46`	`46`	`return (1);`
`47`	`47`	`diffd = timeval_diff((st), en);`
`48`	`48`
	`49`	`+ /* Success! */`
`49`	`50`	`return (0);`
`50`	`51`	`}`
`51`	`52`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,8 @@ func(int arr[static restrict 1])`
`9`	`9`	`{`
`10`	`10`
`11`	`11`	`(void)arr; /* UNUSED */`
	`12`	`+`
	`13`	`+ /* Success! */`
`12`	`14`	`return (0);`
`13`	`15`	`}`
`14`	`16`
`@@ -17,5 +19,7 @@ main(void)`
`17`	`19`	`{`
`18`	`20`
`19`	`21`	`(void)func; /* UNUSED */`
	`22`	`+`
	`23`	`+ /* Success! */`
`20`	`24`	`return (0);`
`21`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,6 @@ main(void)`
`8`	`8`	`/* Can we reference st_mtim? */`
`9`	`9`	`(void)sb.st_mtim.tv_sec;`
`10`	`10`
	`11`	`+ /* Success! */`
`11`	`12`	`return (0);`
`12`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,5 +2,6 @@ int`
`2`	`2`	`main(void)`
`3`	`3`	`{`
`4`	`4`
	`5`	`+ /* Success! */`
`5`	`6`	`return (0);`
`6`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -140,7 +140,7 @@ static int`
`140`	`140`	`hwtest(const uint32_t state[static restrict 8],`
`141`	`141`	`const uint8_t block[static restrict 64],`
`142`	`142`	`uint32_t W[static restrict 64], uint32_t S[static restrict 8],`
`143`		`- void(* func)(uint32_t state[static restrict 8],`
	`143`	`+ void (* func)(uint32_t state[static restrict 8],`
`144`	`144`	`const uint8_t block[static restrict 64], uint32_t W[static restrict 64],`
`145`	`145`	`uint32_t S[static restrict 8]))`
`146`	`146`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,5 +17,6 @@ main(void)`
`17`	`17`
`18`	`18`	`lanes = vdupq_laneq_u32(lanes, 0);`
`19`	`19`
	`20`	`+ /* Success! */`
`20`	`21`	`return (0);`
`21`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,5 +12,6 @@ main(void)`
`12`	`12`	`output = vsha256su0q_u32(w0, w4);`
`13`	`13`	`(void)output; /* UNUSED */`
`14`	`14`
	`15`	`+ /* Success! */`
`15`	`16`	`return (0);`
`16`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ static struct aes_test {`
`67`	`67`
`68`	`68`	`/* Test a function against test vectors. */`
`69`	`69`	`static int`
`70`		`-functest(int(* func)(const uint8_t *, size_t, const uint8_t[16], uint8_t[16]))`
	`70`	`+functest(int (* func)(const uint8_t *, size_t, const uint8_t[16], uint8_t[16]))`
`71`	`71`	`{`
`72`	`72`	`struct aes_test * knowngood;`
`73`	`73`	`uint8_t ctext[16];`
Original file line number	Diff line number	Diff line change
`@@ -81,6 +81,7 @@ crypto_aesctr_stream_pre_wholeblock(struct crypto_aesctr * stream,`
`81`	`81`	`buflen_p, 16 - bytemod, bytemod);`
`82`	`82`	`}`
`83`	`83`
	`84`	`+ /* Success! */`
`84`	`85`	`return (0);`
`85`	`86`	`}`
`86`	`87`