kzc_profiling.h File Reference

Core level components of performance profiler. More...

#include <system/debug/kzs_error.h>
#include <system/kzs_types.h>
#include <system/kzs_header.h>
#include <system/debug/kzs_profiling.h>

Classes
struct	KzcProfilingSummaryData
	Struct containing output data from profiling. More...

Macros
#define	KZC_PROFILING_VALUE_NONE
	Bit mask for none. More...
#define	KZC_PROFILING_VALUE_TOTAL_TIME
	Bit mask for total/cumulative time spent in a function. More...
#define	KZC_PROFILING_VALUE_SELF_TIME
	Bit mask for time spent in the function itself (not in children). More...
#define	KZC_PROFILING_VALUE_HIT_COUNT
	Bit mask for function hit count. More...
#define	KZC_PROFILING_VALUE_MINIMUM_TIME
	Bit mask for minimum time spent in a function. More...
#define	KZC_PROFILING_VALUE_AVERAGE_TIME
	Bit mask for average time spent in a function. More...
#define	KZC_PROFILING_VALUE_MAXIMUM_TIME
	Bit mask for maximum time spent in a function. More...
#define	KZC_PROFILING_VALUE_ALL
	Bit mask for all information. More...

Functions
KANZI_API kzsError	kzcProfilingOutputList (const struct KzcMemoryManager *memoryManager, kzUint outputMask, kzUint sortMethod)
	Outputs per-function profiling data to Kanzi log with DETAILS log level. More...
KANZI_API kzsError	kzcProfilingOutputTreeToArray (const struct KzcMemoryManager *memoryManager, kzUint outputMask, kzUint sortMethod, struct KzcDynamicArray **out_results)
	Outputs profiling data in tree form to dynamic array. More...
KANZI_API kzsError	kzcProfilingOutputTree (const struct KzcMemoryManager *memoryManager, kzUint outputMask, kzUint sortMethod)
	Outputs profiling data in tree form to Kanzi log with DETAILS log level. More...
KANZI_API kzUint	kzcProfilingGetSummaryForName (kzString name, kzUint outputMask, struct KzcProfilingSummaryData *summary)
	Returns the profiling summary for all measurements with the specified name. More...

Detailed Description

Core level components of performance profiler.

Copyright 2008-2020 by Rightware. All rights reserved.

Macro Definition Documentation

#define KZC_PROFILING_VALUE_NONE

Bit mask for none.

Usable as a sorting parameter.

#define KZC_PROFILING_VALUE_TOTAL_TIME

Bit mask for total/cumulative time spent in a function.

#define KZC_PROFILING_VALUE_SELF_TIME

Bit mask for time spent in the function itself (not in children).

#define KZC_PROFILING_VALUE_HIT_COUNT

Bit mask for function hit count.

#define KZC_PROFILING_VALUE_MINIMUM_TIME

Bit mask for minimum time spent in a function.

#define KZC_PROFILING_VALUE_AVERAGE_TIME

Bit mask for average time spent in a function.

#define KZC_PROFILING_VALUE_MAXIMUM_TIME

Bit mask for maximum time spent in a function.

#define KZC_PROFILING_VALUE_ALL

Bit mask for all information.

Function Documentation

KANZI_API kzsError kzcProfilingOutputList	(	const struct KzcMemoryManager *	memoryManager,
		kzUint	outputMask,
		kzUint	sortMethod
	)

Outputs per-function profiling data to Kanzi log with DETAILS log level.

Parameters

memoryManager	Memory manager to use for formatting output.
outputMask	Bit mask of enabled output values. See KZC_PROFILING_VALUE_*.
sortMethod	Sorting method of values. One of KZC_PROFILING_VALUE_*.

KANZI_API kzsError kzcProfilingOutputTreeToArray	(	const struct KzcMemoryManager *	memoryManager,
		kzUint	outputMask,
		kzUint	sortMethod,
		struct KzcDynamicArray **	out_results
	)

Outputs profiling data in tree form to dynamic array.

Parameters

memoryManager	Memory manager to use for formatting output.
outputMask	Bit mask of enabled output values. See KZC_PROFILING_VALUE_*.
sortMethod	Sorting method of values. One of KZC_PROFILING_VALUE_*.

KANZI_API kzsError kzcProfilingOutputTree	(	const struct KzcMemoryManager *	memoryManager,
		kzUint	outputMask,
		kzUint	sortMethod
	)

Outputs profiling data in tree form to Kanzi log with DETAILS log level.

Parameters

memoryManager	Memory manager to use for formatting output.
outputMask	Bit mask of enabled output values. See KZC_PROFILING_VALUE_*.
sortMethod	Sorting method of values. One of KZC_PROFILING_VALUE_*.

KANZI_API kzUint kzcProfilingGetSummaryForName	(	kzString	name,
		kzUint	outputMask,
		struct KzcProfilingSummaryData *	summary
	)

Returns the profiling summary for all measurements with the specified name.

Parameters

name	Name of profiling measurements.
outputMask	Bit mask of enabled output values. See KZC_PROFILING_VALUE_*.
summary	Pointer to KzcProfilingSummaryData struct where the results will be written.

Returns

The number of found measurements matching specified name.