profiling.hpp File Reference

#include <kanzi/core/log/log_category.hpp>
#include <kanzi/core/profiling/default_profiler.hpp>
#include <kanzi/core/profiling/profiling_macro.hpp>

Macros
#define	KZ_PROFILING_CURRENT_FUNCTION
	KZ_PROFILING_CURRENT_FUNCTION expands to a string literal containing the (fully qualified, if possible) name of the enclosing function. More...
#define	KZ_PROFILING_DEFAULT_SAMPLE_BUFFER_SIZE
	Default ring-buffer size in function profiling that is used to store per-invocation sample data. More...
#define	KZ_DEFAULT_PROFILER
	Default profiler singleton instance. More...
#define	KZ_PROFILING_WRAP_FUNCTION(profiler, functionName, category, function, bufferSize)
	Makes it possible to compile out all profiling. If not defined, replaces profiling macros with empty ones. More...
#define	KZ_PROFILE_FUNCTION_DEFAULT()
#define	KZ_PROFILE_FUNCTION(profiler, name, category, sampleBufferSize)
#define	KZ_PROFILE_FUNCTION_WITH_DESCRIPTION(profiler, name, category, sampleBufferSize, description)
#define	KZ_PROFILE_SCOPE(category, source, description)
#define	KZ_LOG_CATEGORY_PROFILING_ENABLED
	Determines the state of the KZ_LOG_CATEGORY_PROFILING. More...
#define	KZ_LOG_CATEGORY_PROFILING
	The profiling log category. More...

Macro Definition Documentation

#define KZ_PROFILING_CURRENT_FUNCTION

KZ_PROFILING_CURRENT_FUNCTION expands to a string literal containing the (fully qualified, if possible) name of the enclosing function.

If there is no enclosing function, the behavior is undefined. Some compilers do not provide a way to obtain the name of the current enclosing function.On such compilers, the string literal has an 'unspecified' value.

#define KZ_PROFILING_DEFAULT_SAMPLE_BUFFER_SIZE

Default ring-buffer size in function profiling that is used to store per-invocation sample data.

#define KZ_DEFAULT_PROFILER

Default profiler singleton instance.

#define KZ_PROFILING_WRAP_FUNCTION	(		profiler,
			functionName,
			category,
			function,
			bufferSize
	)

Makes it possible to compile out all profiling. If not defined, replaces profiling macros with empty ones.

#define KZ_PROFILE_FUNCTION_DEFAULT

(

)

#define KZ_PROFILE_FUNCTION	(		profiler,
			name,
			category,
			sampleBufferSize
	)

#define KZ_PROFILE_FUNCTION_WITH_DESCRIPTION	(		profiler,
			name,
			category,
			sampleBufferSize,
			description
	)

#define KZ_PROFILE_SCOPE	(		category,
			source,
			description
	)

#define KZ_LOG_CATEGORY_PROFILING_ENABLED

Determines the state of the KZ_LOG_CATEGORY_PROFILING.

#define KZ_LOG_CATEGORY_PROFILING

The profiling log category.

Use this log category for profiling logs only. The KZ_LOG_CATEGORY_PROFILING_ENABLED defines the state of this log category.