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