benchfn.h File Reference

#include <stddef.h>

Go to the source code of this file.

Data Structures
struct	BMK_runTime_t
struct	BMK_runOutcome_t
struct	BMK_benchParams_t
union	BMK_timedFnState_shell

Macros
#define	BENCH_FN_H_23876
#define	BMK_TIMEDFNSTATE_SIZE   64

Typedefs
typedef size_t(*	BMK_benchFn_t) (const void *src, size_t srcSize, void *dst, size_t dstCapacity, void *customPayload)
typedef size_t(*	BMK_initFn_t) (void *initPayload)
typedef unsigned(*	BMK_errorFn_t) (size_t)

Functions
BMK_runOutcome_t	BMK_benchFunction (BMK_benchParams_t params, unsigned nbLoops)
int	BMK_isSuccessful_runOutcome (BMK_runOutcome_t outcome)
BMK_runTime_t	BMK_extract_runTime (BMK_runOutcome_t outcome)
size_t	BMK_extract_errorResult (BMK_runOutcome_t outcome)
BMK_runOutcome_t	BMK_benchTimedFn (BMK_timedFnState_t *timedFnState, BMK_benchParams_t params)
int	BMK_isCompleted_TimedFn (const BMK_timedFnState_t *timedFnState)
BMK_timedFnState_t *	BMK_createTimedFnState (unsigned total_ms, unsigned run_ms)
void	BMK_resetTimedFnState (BMK_timedFnState_t *timedFnState, unsigned total_ms, unsigned run_ms)
void	BMK_freeTimedFnState (BMK_timedFnState_t *state)
BMK_timedFnState_t *	BMK_initStatic_timedFnState (void *buffer, size_t size, unsigned total_ms, unsigned run_ms)

Macro Definition Documentation

BENCH_FN_H_23876

#define BENCH_FN_H_23876

BMK_TIMEDFNSTATE_SIZE

#define BMK_TIMEDFNSTATE_SIZE   64

Typedef Documentation

BMK_benchFn_t

typedef size_t(* BMK_benchFn_t) (const void *src, size_t srcSize, void *dst, size_t dstCapacity, void *customPayload)

BMK_errorFn_t

typedef unsigned(* BMK_errorFn_t) (size_t)

BMK_initFn_t

typedef size_t(* BMK_initFn_t) (void *initPayload)

Function Documentation

BMK_benchFunction()

BMK_runOutcome_t BMK_benchFunction	(	BMK_benchParams_t	params,
		unsigned	nbLoops )

BMK_benchTimedFn()

BMK_runOutcome_t BMK_benchTimedFn	(	BMK_timedFnState_t *	timedFnState,
		BMK_benchParams_t	params )

BMK_createTimedFnState()

BMK_timedFnState_t * BMK_createTimedFnState	(	unsigned	total_ms,
		unsigned	run_ms )

BMK_extract_errorResult()

size_t BMK_extract_errorResult

(

BMK_runOutcome_t

outcome

)

BMK_extract_runTime()

BMK_runTime_t BMK_extract_runTime

(

BMK_runOutcome_t

outcome

)

BMK_freeTimedFnState()

void BMK_freeTimedFnState

(

BMK_timedFnState_t *

state

)

BMK_initStatic_timedFnState()

BMK_timedFnState_t * BMK_initStatic_timedFnState	(	void *	buffer,
		size_t	size,
		unsigned	total_ms,
		unsigned	run_ms )

BMK_isCompleted_TimedFn()

int BMK_isCompleted_TimedFn

(

const BMK_timedFnState_t *

timedFnState

)

BMK_isSuccessful_runOutcome()

int BMK_isSuccessful_runOutcome

(

BMK_runOutcome_t

outcome

)

BMK_resetTimedFnState()

void BMK_resetTimedFnState	(	BMK_timedFnState_t *	timedFnState,
		unsigned	total_ms,
		unsigned	run_ms )