xref: /xnu-12377.1.9/tests/benchmark/helpers.h (revision f6217f891ac0bb64f3d375211650a4c1ff8ca1ea)
1*f6217f89SApple OSS Distributions #ifndef BENCHMARK_PERF_HELPERS_H
2*f6217f89SApple OSS Distributions #define BENCHMARK_PERF_HELPERS_H
3*f6217f89SApple OSS Distributions 
4*f6217f89SApple OSS Distributions /*
5*f6217f89SApple OSS Distributions  * Utility functions and constants used by perf tests.
6*f6217f89SApple OSS Distributions  */
7*f6217f89SApple OSS Distributions #include <inttypes.h>
8*f6217f89SApple OSS Distributions #include <time.h>
9*f6217f89SApple OSS Distributions #include <stdbool.h>
10*f6217f89SApple OSS Distributions 
11*f6217f89SApple OSS Distributions /*
12*f6217f89SApple OSS Distributions  * mmap an anonymous chunk of memory.
13*f6217f89SApple OSS Distributions  */
14*f6217f89SApple OSS Distributions unsigned char *map_buffer(size_t size, int flags);
15*f6217f89SApple OSS Distributions /*
16*f6217f89SApple OSS Distributions  * Returns a - b in microseconds.
17*f6217f89SApple OSS Distributions  * NB: a must be >= b
18*f6217f89SApple OSS Distributions  */
19*f6217f89SApple OSS Distributions uint64_t timespec_difference_us(const struct timespec* a, const struct timespec* b);
20*f6217f89SApple OSS Distributions /*
21*f6217f89SApple OSS Distributions  * Print the message to stdout along with the current time.
22*f6217f89SApple OSS Distributions  * Also flushes stdout so that the log can help detect hangs. Don't call
23*f6217f89SApple OSS Distributions  * this function from within the measured portion of the benchmark as it will
24*f6217f89SApple OSS Distributions  * pollute your measurement.
25*f6217f89SApple OSS Distributions  *
26*f6217f89SApple OSS Distributions  * NB: Will only log if verbose == true.
27*f6217f89SApple OSS Distributions  */
28*f6217f89SApple OSS Distributions void benchmark_log(bool verbose, const char *restrict fmt, ...) __attribute__((format(printf, 2, 3)));
29*f6217f89SApple OSS Distributions 
30*f6217f89SApple OSS Distributions static const uint64_t kNumMicrosecondsInSecond = 1000UL * 1000;
31*f6217f89SApple OSS Distributions static const uint64_t kNumNanosecondsInMicrosecond = 1000UL;
32*f6217f89SApple OSS Distributions static const uint64_t kNumNanosecondsInSecond = kNumNanosecondsInMicrosecond * kNumMicrosecondsInSecond;
33*f6217f89SApple OSS Distributions /* Get a (wall-time) timestamp in nanoseconds */
34*f6217f89SApple OSS Distributions #define current_timestamp_ns() (clock_gettime_nsec_np(CLOCK_MONOTONIC_RAW));
35*f6217f89SApple OSS Distributions 
36*f6217f89SApple OSS Distributions unsigned int get_ncpu(void);
37*f6217f89SApple OSS Distributions 
38*f6217f89SApple OSS Distributions #endif /* !defined(BENCHMARK_PERF_HELPERS_H) */
39