Internal Debugging API

The Internal Debugging API. More...

Macros
#define	VX_PRINT(zone, message, ...)
	The OpenVX Debugging Facility.
#define	VX_KERNEL_ENTRY(params, num)
	A debugging macro for entering kernels.
#define	VX_KERNEL_RETURN(status)
	A debugging macro for leaving kernels.

Enumerations
enum	vx_debug_zone_e {   VX_ZONE_ERROR = 0 ,   VX_ZONE_WARNING = 1 ,   VX_ZONE_API = 2 ,   VX_ZONE_INFO = 3 ,   VX_ZONE_DEBUG = 4 ,   VX_ZONE_PERF = 5 ,   VX_ZONE_CONTEXT = 6 ,   VX_ZONE_OSAL = 7 ,   VX_ZONE_REFERENCE = 8 ,   VX_ZONE_ARRAY = 9 ,   VX_ZONE_IMAGE = 10 ,   VX_ZONE_SCALAR = 11 ,   VX_ZONE_KERNEL = 12 ,   VX_ZONE_GRAPH = 13 ,   VX_ZONE_NODE = 14 ,   VX_ZONE_PARAMETER = 15 ,   VX_ZONE_DELAY = 16 ,   VX_ZONE_TARGET = 17 ,   VX_ZONE_TENSOR = 18 ,   VX_ZONE_LOG = 19 ,   VX_ZONE_MAX = 32 }
	These are the bit flags for debugging. More...

Functions
void	vx_print (vx_enum zone, const char *format,...)
	Internal Printing Function.
void	vx_set_debug_zone (vx_enum zone)
	Sets a zone bit in the debug mask.
void	vx_clr_debug_zone (vx_enum zone)
	Clears the zone bit in the mask.
vx_bool	vx_get_debug_zone (vx_enum zone)
	Returns true or false if the zone bit is set or cleared.
void	vx_set_debug_zone_from_env (void)
	Pulls the debug zone mask from the environment variables.

Detailed Description

The Internal Debugging API.

Macro Definition Documentation

VX_KERNEL_ENTRY

#define VX_KERNEL_ENTRY	(		params,
			num )

#include <vx_debug.h>

Value:

    { \
    vx_uint32 p; \
    VX_PRINT(VX_ZONE_API, "Entered Kernel! Parameters:\n"); \
    for (p = 0; p < num; p++) { \
        VX_PRINT(VX_ZONE_API, "\tparameter[%u]="VX_FMT_REF"\n", p, params[p]); \
    }\
}

A debugging macro for entering kernels.

VX_KERNEL_RETURN

#define VX_KERNEL_RETURN

(

status

)

#include <vx_debug.h>

Value:

VX_PRINT(VX_ZONE_API, "returning %d\n", status);

A debugging macro for leaving kernels.

VX_PRINT

#define VX_PRINT	(		zone,
			message,
			... )

#include <vx_debug.h>

Value:

    do { \
        vx_print(zone, "[%s:%u] " message, __FUNCTION__, __LINE__, ## __VA_ARGS__); \
    } while (0)

The OpenVX Debugging Facility.

Enumeration Type Documentation

vx_debug_zone_e

enum vx_debug_zone_e

#include <vx_debug.h>

These are the bit flags for debugging.

Enumerator
VX_ZONE_ERROR	Used for most errors
VX_ZONE_WARNING	Used to warning developers of possible issues
VX_ZONE_API	Used to trace API calls and return values
VX_ZONE_INFO	Used to show run-time processing debug
VX_ZONE_DEBUG	Used to show detailed debug information
VX_ZONE_PERF	Used to show performance information
VX_ZONE_CONTEXT	Used to show only context logs
VX_ZONE_OSAL	Used to show only OSAL logs
VX_ZONE_REFERENCE	Used to show only reference logs
VX_ZONE_ARRAY	Used to show only array logs
VX_ZONE_IMAGE	Used to show only image logs
VX_ZONE_SCALAR	Used to show only scalar logs
VX_ZONE_KERNEL	Used to show only kernel logs
VX_ZONE_GRAPH	Used to show only graph logs
VX_ZONE_NODE	Used to show only node logs
VX_ZONE_PARAMETER	Used to show only parameter logs
VX_ZONE_DELAY	Used to show only delay logs
VX_ZONE_TARGET	Used to show only target logs
VX_ZONE_TENSOR	Used to show only tensor logs
VX_ZONE_LOG	Used to show only logs
VX_ZONE_MAX	The maximum number of zones

Function Documentation

vx_clr_debug_zone()

void vx_clr_debug_zone

(

vx_enum

zone

)

#include <vx_debug.h>

Clears the zone bit in the mask.

Parameters

[in]

zone

The debug zone from vx_debug_zone_e.

vx_get_debug_zone()

vx_bool vx_get_debug_zone

(

vx_enum

zone

)

#include <vx_debug.h>

Returns true or false if the zone bit is set or cleared.

Parameters

[in]

zone

The debug zone from vx_debug_zone_e.

vx_print()

void vx_print	(	vx_enum	zone,
		const char *	format,
			... )

#include <vx_debug.h>

Internal Printing Function.

Parameters

[in]	zone	The debug zone from vx_debug_zone_e.
[in]	format	The format string to print.
[in]	...	The variable list of arguments.

vx_set_debug_zone()

void vx_set_debug_zone

(

vx_enum

zone

)

#include <vx_debug.h>

Sets a zone bit in the debug mask.

Parameters

[in]

zone

The debug zone from vx_debug_zone_e.

vx_set_debug_zone_from_env()

void vx_set_debug_zone_from_env

(

void

)

#include <vx_debug.h>

Pulls the debug zone mask from the environment variables.