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