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