[ceph.git] / ceph / src / spdk / isa-l / include / test.h

/**********************************************************************
  Copyright(c) 2011-2015 Intel Corporation All rights reserved.

  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions
  are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in
      the documentation and/or other materials provided with the
      distribution.
    * Neither the name of Intel Corporation nor the names of its
      contributors may be used to endorse or promote products derived
      from this software without specific prior written permission.

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
**********************************************************************/

#ifndef _TEST_H
#define _TEST_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stdio.h>
#include <stdint.h>

#ifdef _MSC_VER
# define inline __inline
#endif

/* Decide wether to use benchmark time as an approximation or a minimum. Fewer
 * calls to the timer are required for the approximation case.*/
#define BENCHMARK_MIN_TIME 0
#define BENCHMARK_APPROX_TIME 1
#ifndef BENCHMARK_TYPE
#define BENCHMARK_TYPE BENCHMARK_MIN_TIME
#endif

#ifdef USE_RDTSC
/* The use of rtdsc is nuanced. On many processors it corresponds to a
 * standardized clock source. To obtain a meaningful result it may be
 * necessary to fix the CPU clock to match the rtdsc tick rate.
 */
# include <inttypes.h>
# include <x86intrin.h>
# define USE_CYCLES
#else
# include <time.h>
#define USE_SECONDS
#endif

#ifdef USE_RDTSC
#ifndef BENCHMARK_TIME
# define BENCHMARK_TIME 6
#endif
# define GHZ 1000000000
# define UNIT_SCALE (GHZ)
# define CALLIBRATE_TIME (UNIT_SCALE / 2)
static inline long long get_time(void) {
	unsigned int dummy;
	return __rdtscp(&dummy);
}

static inline long long get_res(void) {
	return 1;
}
#else
#ifndef BENCHMARK_TIME
# define BENCHMARK_TIME 3
#endif
#ifdef _MSC_VER
#define UNIT_SCALE get_res()
#define CALLIBRATE_TIME (UNIT_SCALE / 4)
static inline long long get_time(void) {
	long long ret = 0;
	QueryPerformanceCounter(&ret);
	return ret;
}

static inline long long get_res(void) {
	long long ret = 0;
	QueryPerformanceFrequency(&ret);
	return ret;
}
#else
# define NANO_SCALE 1000000000
# define UNIT_SCALE NANO_SCALE
# define CALLIBRATE_TIME (UNIT_SCALE / 4)
#ifdef __FreeBSD__
# define CLOCK_ID CLOCK_MONOTONIC_PRECISE
#else
# define CLOCK_ID CLOCK_MONOTONIC
#endif

static inline long long get_time(void) {
	struct timespec time;
	long long nano_total;
	 clock_gettime(CLOCK_ID, &time);
	 nano_total = time.tv_sec;
	 nano_total *= NANO_SCALE;
	 nano_total += time.tv_nsec;
	 return nano_total;
}

static inline long long get_res(void) {
	struct timespec time;
	long long nano_total;
	clock_getres(CLOCK_ID, &time);
	nano_total = time.tv_sec;
	nano_total *= NANO_SCALE;
	nano_total += time.tv_nsec;
	return nano_total;
}
#endif
#endif
struct perf {
	long long start;
	long long stop;
	long long run_total;
	long long iterations;
};

static inline void perf_init(struct perf *p) {
	p->start = 0;
	p->stop = 0;
	p->run_total = 0;
}

static inline void perf_continue(struct perf *p) {
	p->start = get_time();
}

static inline void perf_pause(struct perf *p) {
	p->stop = get_time();
	p->run_total = p->run_total + p->stop - p->start;
	p->start = p->stop;
}

static inline void perf_start(struct perf *p) {
	perf_init(p);
	perf_continue(p);
}

static inline void perf_stop(struct perf *p) {
	perf_pause(p);
}

static inline double get_time_elapsed(struct perf *p) {
	return 1.0 * p->run_total / UNIT_SCALE;
}

static inline long long get_base_elapsed(struct perf *p) {
	return p->run_total;
}

static inline unsigned long long estimate_perf_iterations(struct perf *p,
						   unsigned long long runs,
						   unsigned long long total) {
	total = total * runs;
	if (get_base_elapsed(p) > 0)
		return (total + get_base_elapsed(p) - 1) / get_base_elapsed(p);
	else
		return (total + get_res() - 1) / get_res();
}

#define CALLIBRATE(PERF, FUNC_CALL) {				\
	unsigned long long _i, _iter = 1;			\
	perf_start(PERF);					\
	FUNC_CALL;						\
	perf_pause(PERF);					\
								\
	while (get_base_elapsed(PERF) < CALLIBRATE_TIME) {	\
		_iter = estimate_perf_iterations(PERF, _iter,	\
						2 * CALLIBRATE_TIME);	\
		perf_start(PERF);				\
		for (_i = 0; _i < _iter; _i++) {		\
			FUNC_CALL;				\
		}						\
		perf_stop(PERF);				\
	}							\
	(PERF)->iterations=_iter;				\
}

#define PERFORMANCE_TEST(PERF, RUN_TIME, FUNC_CALL) {		\
	unsigned long long _i, _iter = (PERF)->iterations;	\
	unsigned long long _run_total = RUN_TIME;		\
	_run_total *= UNIT_SCALE;				\
	_iter = estimate_perf_iterations(PERF, _iter, _run_total);\
	(PERF)->iterations = 0;					\
	perf_start(PERF);					\
	for (_i = 0; _i < _iter; _i++) {			\
		FUNC_CALL;					\
	}							\
	perf_pause(PERF);					\
	(PERF)->iterations += _iter;				\
								\
	if(get_base_elapsed(PERF) < _run_total &&		\
		BENCHMARK_TYPE == BENCHMARK_MIN_TIME) {		\
		_iter = estimate_perf_iterations(PERF, _iter,	\
			_run_total - get_base_elapsed(PERF) +	\
			(UNIT_SCALE / 16));			\
		perf_continue(PERF);				\
		for (_i = 0; _i < _iter; _i++) {		\
			FUNC_CALL;				\
		}						\
		perf_pause(PERF);				\
		(PERF)->iterations += _iter;			\
	}							\
}

#define BENCHMARK(PERF, RUN_TIME, FUNC_CALL) {			\
	if((RUN_TIME) > 0) {					\
		CALLIBRATE(PERF, FUNC_CALL);			\
		PERFORMANCE_TEST(PERF, RUN_TIME, FUNC_CALL);	\
								\
	} else {						\
		(PERF)->iterations = 1;				\
		perf_start(PERF);				\
		FUNC_CALL;					\
		perf_stop(PERF);				\
	}							\
}

#ifdef USE_CYCLES
static inline void perf_print(struct perf p, long long unit_count) {
	long long total_units = p.iterations * unit_count;

	printf("runtime = %10lld ticks", get_base_elapsed(&p));
	if (total_units != 0) {
		printf(", bandwidth %lld MB in %.4f GC = %.2f ticks/byte",
		       total_units / (1000000), get_time_elapsed(&p),
		       get_base_elapsed(&p) / (double)total_units);
	}
	printf("\n");
}
#else
static inline void perf_print(struct perf p, double unit_count) {
	long long total_units = p.iterations * unit_count;
	long long usecs = (long long)(get_time_elapsed(&p) * 1000000);

	printf("runtime = %10lld usecs", usecs);
	if (total_units != 0) {
		printf(", bandwidth %lld MB in %.4f sec = %.2f MB/s",
		       total_units / (1000000), get_time_elapsed(&p),
		       ((double)total_units) / (1000000 * get_time_elapsed(&p)));
	}
	printf("\n");
}
#endif

static inline uint64_t get_filesize(FILE * fp) {
	uint64_t file_size;
	fpos_t pos, pos_curr;

	fgetpos(fp, &pos_curr);	/* Save current position */
#if defined(_WIN32) || defined(_WIN64)
	_fseeki64(fp, 0, SEEK_END);
#else
	fseeko(fp, 0, SEEK_END);
#endif
	fgetpos(fp, &pos);
	file_size = *(uint64_t *) & pos;
	fsetpos(fp, &pos_curr);	/* Restore position */

	return file_size;
}

#ifdef __cplusplus
}
#endif

#endif // _TEST_H
Commit	Line	Data
9f95a23c TL	1	/**********************************************************************
	2	Copyright(c) 2011-2015 Intel Corporation All rights reserved.
	3
	4	Redistribution and use in source and binary forms, with or without
	5	modification, are permitted provided that the following conditions
	6	are met:
	7	* Redistributions of source code must retain the above copyright
	8	notice, this list of conditions and the following disclaimer.
	9	* Redistributions in binary form must reproduce the above copyright
	10	notice, this list of conditions and the following disclaimer in
	11	the documentation and/or other materials provided with the
	12	distribution.
	13	* Neither the name of Intel Corporation nor the names of its
	14	contributors may be used to endorse or promote products derived
	15	from this software without specific prior written permission.
	16
	17	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	18	"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	19	LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	20	A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	21	OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	22	SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	23	LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	24	DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	25	THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	26	(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	27	OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	28	**********************************************************************/
	29
	30	#ifndef _TEST_H
	31	#define _TEST_H
	32
	33	#ifdef __cplusplus
	34	extern "C" {
	35	#endif
	36
f67539c2 TL	37	#include <stdio.h>
f67539c2 TL	38	#include <stdint.h>
9f95a23c TL	39
	40	#ifdef _MSC_VER
	41	# define inline __inline
f67539c2 TL	42	#endif
	43
	44	/* Decide wether to use benchmark time as an approximation or a minimum. Fewer
	45	* calls to the timer are required for the approximation case.*/
	46	#define BENCHMARK_MIN_TIME 0
	47	#define BENCHMARK_APPROX_TIME 1
	48	#ifndef BENCHMARK_TYPE
	49	#define BENCHMARK_TYPE BENCHMARK_MIN_TIME
	50	#endif
	51
	52	#ifdef USE_RDTSC
	53	/* The use of rtdsc is nuanced. On many processors it corresponds to a
	54	* standardized clock source. To obtain a meaningful result it may be
	55	* necessary to fix the CPU clock to match the rtdsc tick rate.
	56	*/
	57	# include <inttypes.h>
	58	# include <x86intrin.h>
	59	# define USE_CYCLES
	60	#else
9f95a23c	61	# include <time.h>
f67539c2	62	#define USE_SECONDS
9f95a23c TL	63	#endif
9f95a23c TL	64
f67539c2 TL	65	#ifdef USE_RDTSC
	66	#ifndef BENCHMARK_TIME
	67	# define BENCHMARK_TIME 6
	68	#endif
	69	# define GHZ 1000000000
	70	# define UNIT_SCALE (GHZ)
	71	# define CALLIBRATE_TIME (UNIT_SCALE / 2)
	72	static inline long long get_time(void) {
	73	unsigned int dummy;
	74	return __rdtscp(&dummy);
	75	}
9f95a23c	76
f67539c2 TL	77	static inline long long get_res(void) {
	78	return 1;
	79	}
	80	#else
	81	#ifndef BENCHMARK_TIME
	82	# define BENCHMARK_TIME 3
	83	#endif
	84	#ifdef _MSC_VER
	85	#define UNIT_SCALE get_res()
	86	#define CALLIBRATE_TIME (UNIT_SCALE / 4)
	87	static inline long long get_time(void) {
	88	long long ret = 0;
	89	QueryPerformanceCounter(&ret);
	90	return ret;
	91	}
	92
	93	static inline long long get_res(void) {
	94	long long ret = 0;
	95	QueryPerformanceFrequency(&ret);
	96	return ret;
	97	}
	98	#else
	99	# define NANO_SCALE 1000000000
	100	# define UNIT_SCALE NANO_SCALE
	101	# define CALLIBRATE_TIME (UNIT_SCALE / 4)
	102	#ifdef __FreeBSD__
	103	# define CLOCK_ID CLOCK_MONOTONIC_PRECISE
	104	#else
	105	# define CLOCK_ID CLOCK_MONOTONIC
	106	#endif
	107
	108	static inline long long get_time(void) {
	109	struct timespec time;
	110	long long nano_total;
	111	clock_gettime(CLOCK_ID, &time);
	112	nano_total = time.tv_sec;
	113	nano_total *= NANO_SCALE;
	114	nano_total += time.tv_nsec;
	115	return nano_total;
	116	}
	117
	118	static inline long long get_res(void) {
	119	struct timespec time;
	120	long long nano_total;
	121	clock_getres(CLOCK_ID, &time);
	122	nano_total = time.tv_sec;
	123	nano_total *= NANO_SCALE;
	124	nano_total += time.tv_nsec;
	125	return nano_total;
	126	}
	127	#endif
	128	#endif
	129	struct perf {
	130	long long start;
	131	long long stop;
	132	long long run_total;
	133	long long iterations;
9f95a23c TL	134	};
9f95a23c TL	135
f67539c2 TL	136	static inline void perf_init(struct perf *p) {
	137	p->start = 0;
	138	p->stop = 0;
	139	p->run_total = 0;
	140	}
9f95a23c	141
f67539c2 TL	142	static inline void perf_continue(struct perf *p) {
f67539c2 TL	143	p->start = get_time();
9f95a23c	144	}
f67539c2 TL	145
	146	static inline void perf_pause(struct perf *p) {
	147	p->stop = get_time();
	148	p->run_total = p->run_total + p->stop - p->start;
	149	p->start = p->stop;
9f95a23c TL	150	}
9f95a23c TL	151
f67539c2 TL	152	static inline void perf_start(struct perf *p) {
	153	perf_init(p);
	154	perf_continue(p);
	155	}
9f95a23c	156
f67539c2 TL	157	static inline void perf_stop(struct perf *p) {
	158	perf_pause(p);
	159	}
	160
	161	static inline double get_time_elapsed(struct perf *p) {
	162	return 1.0 * p->run_total / UNIT_SCALE;
	163	}
	164
	165	static inline long long get_base_elapsed(struct perf *p) {
	166	return p->run_total;
	167	}
	168
	169	static inline unsigned long long estimate_perf_iterations(struct perf *p,
	170	unsigned long long runs,
	171	unsigned long long total) {
	172	total = total * runs;
	173	if (get_base_elapsed(p) > 0)
	174	return (total + get_base_elapsed(p) - 1) / get_base_elapsed(p);
	175	else
	176	return (total + get_res() - 1) / get_res();
	177	}
	178
	179	#define CALLIBRATE(PERF, FUNC_CALL) { \
	180	unsigned long long _i, _iter = 1; \
	181	perf_start(PERF); \
	182	FUNC_CALL; \
	183	perf_pause(PERF); \
	184	\
	185	while (get_base_elapsed(PERF) < CALLIBRATE_TIME) { \
	186	_iter = estimate_perf_iterations(PERF, _iter, \
	187	2 * CALLIBRATE_TIME); \
	188	perf_start(PERF); \
	189	for (_i = 0; _i < _iter; _i++) { \
	190	FUNC_CALL; \
	191	} \
	192	perf_stop(PERF); \
	193	} \
	194	(PERF)->iterations=_iter; \
	195	}
	196
	197	#define PERFORMANCE_TEST(PERF, RUN_TIME, FUNC_CALL) { \
	198	unsigned long long _i, _iter = (PERF)->iterations; \
	199	unsigned long long _run_total = RUN_TIME; \
	200	_run_total *= UNIT_SCALE; \
	201	_iter = estimate_perf_iterations(PERF, _iter, _run_total);\
	202	(PERF)->iterations = 0; \
	203	perf_start(PERF); \
	204	for (_i = 0; _i < _iter; _i++) { \
	205	FUNC_CALL; \
	206	} \
	207	perf_pause(PERF); \
	208	(PERF)->iterations += _iter; \
	209	\
	210	if(get_base_elapsed(PERF) < _run_total && \
	211	BENCHMARK_TYPE == BENCHMARK_MIN_TIME) { \
	212	_iter = estimate_perf_iterations(PERF, _iter, \
	213	_run_total - get_base_elapsed(PERF) + \
	214	(UNIT_SCALE / 16)); \
	215	perf_continue(PERF); \
	216	for (_i = 0; _i < _iter; _i++) { \
	217	FUNC_CALL; \
	218	} \
	219	perf_pause(PERF); \
	220	(PERF)->iterations += _iter; \
221	} \
222	}
223
224	#define BENCHMARK(PERF, RUN_TIME, FUNC_CALL) { \
225	if((RUN_TIME) > 0) { \
226	CALLIBRATE(PERF, FUNC_CALL); \
227	PERFORMANCE_TEST(PERF, RUN_TIME, FUNC_CALL); \
228	\
229	} else { \
230	(PERF)->iterations = 1; \
231	perf_start(PERF); \
232	FUNC_CALL; \
233	perf_stop(PERF); \
234	} \
235	}
236
237	#ifdef USE_CYCLES
238	static inline void perf_print(struct perf p, long long unit_count) {
239	long long total_units = p.iterations * unit_count;
240
241	printf("runtime = %10lld ticks", get_base_elapsed(&p));
242	if (total_units != 0) {
243	printf(", bandwidth %lld MB in %.4f GC = %.2f ticks/byte",
244	total_units / (1000000), get_time_elapsed(&p),
245	get_base_elapsed(&p) / (double)total_units);
246	}
247	printf("\n");
248	}
9f95a23c	249	#else
f67539c2 TL	250	static inline void perf_print(struct perf p, double unit_count) {
	251	long long total_units = p.iterations * unit_count;
	252	long long usecs = (long long)(get_time_elapsed(&p) * 1000000);
	253
	254	printf("runtime = %10lld usecs", usecs);
	255	if (total_units != 0) {
	256	printf(", bandwidth %lld MB in %.4f sec = %.2f MB/s",
	257	total_units / (1000000), get_time_elapsed(&p),
	258	((double)total_units) / (1000000 * get_time_elapsed(&p)));
9f95a23c	259	}
f67539c2	260	printf("\n");
9f95a23c TL	261	}
	262	#endif
	263
f67539c2	264	static inline uint64_t get_filesize(FILE * fp) {
9f95a23c TL	265	uint64_t file_size;
	266	fpos_t pos, pos_curr;
	267
f67539c2	268	fgetpos(fp, &pos_curr); /* Save current position */
9f95a23c TL	269	#if defined(_WIN32) \|\| defined(_WIN64)
	270	_fseeki64(fp, 0, SEEK_END);
	271	#else
	272	fseeko(fp, 0, SEEK_END);
	273	#endif
	274	fgetpos(fp, &pos);
f67539c2 TL	275	file_size = (uint64_t ) & pos;
f67539c2 TL	276	fsetpos(fp, &pos_curr); /* Restore position */
9f95a23c TL	277
	278	return file_size;
	279	}
	280
	281	#ifdef __cplusplus
	282	}
	283	#endif
	284
	285	#endif // _TEST_H