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