odla_profiler.h File Reference

Go to the source code of this file.

Typedefs
typedef struct _odla_device_trace *	odla_device_trace
	Device trace object. More...
typedef struct _odla_device_trace_item *	odla_device_trace_item
	Device trace item object. More...

Functions
ODLA_API_EXPORT odla_status ODLA_API_CALL	odla_CreateDeviceTrace (odla_device_trace *device_trace)
	Create a device_trace object. More...
ODLA_API_EXPORT odla_status ODLA_API_CALL	odla_SetDeviceTraceItem (odla_device_trace device_trace, odla_device_trace_item device_trace_item,...)
	Set the device trace with a property item. More...
ODLA_API_EXPORT odla_status ODLA_API_CALL	odla_ReleaseDeviceTrace (odla_device_trace device_trace)
	Release a created device_trace. More...
ODLA_API_EXPORT odla_status ODLA_API_CALL	odla_StartDeviceProfiler (odla_device device)
	Start the profiler tracing on a device. More...
ODLA_API_EXPORT odla_status ODLA_API_CALL	odla_AsyncStartDeviceProfiler (odla_device device)
	Asynchronously start the profiler tracing on a device. More...
ODLA_API_EXPORT odla_status ODLA_API_CALL	odla_StopDeviceProfiler (odla_device device)
	Stop the profiler tracing on a device. More...
ODLA_API_EXPORT odla_status ODLA_API_CALL	odla_AsyncStopDeviceProfiler (odla_device device)
	Asynchronously stop the profiler tracing on a device. More...
ODLA_API_EXPORT odla_status ODLA_API_CALL	odla_RetrieveDeviceTrace (odla_device device, odla_device_trace *device_trace)
	Retrieve the profiling trace from a device. More...

Detailed Description

This file defines the ODLA profiler related APIs.

Definition in file odla_profiler.h.

Typedef Documentation

odla_device_trace

typedef struct _odla_device_trace* odla_device_trace

Device trace object.

Definition at line 33 of file odla_profiler.h.

odla_device_trace_item

typedef struct _odla_device_trace_item* odla_device_trace_item

Device trace item object.

Definition at line 36 of file odla_profiler.h.

Function Documentation

odla_AsyncStartDeviceProfiler()

ODLA_API_EXPORT odla_status ODLA_API_CALL odla_AsyncStartDeviceProfiler

(

odla_device

device

)

Asynchronously start the profiler tracing on a device.

Parameters

device

the device object

Returns

odla_status

odla_AsyncStopDeviceProfiler()

ODLA_API_EXPORT odla_status ODLA_API_CALL odla_AsyncStopDeviceProfiler

(

odla_device

device

)

Asynchronously stop the profiler tracing on a device.

Parameters

device

the device object

Returns

odla_status

odla_CreateDeviceTrace()

ODLA_API_EXPORT odla_status ODLA_API_CALL odla_CreateDeviceTrace

(

odla_device_trace *

device_trace

)

Create a device_trace object.

Parameters

device_trace

the pointer to the created device_trace object

Returns

odla_status

odla_ReleaseDeviceTrace()

ODLA_API_EXPORT odla_status ODLA_API_CALL odla_ReleaseDeviceTrace

(

odla_device_trace

device_trace

)

Release a created device_trace.

Parameters

context

the device_trace object

Returns

odla_status

odla_RetrieveDeviceTrace()

ODLA_API_EXPORT odla_status ODLA_API_CALL odla_RetrieveDeviceTrace	(	odla_device	device,
		odla_device_trace *	device_trace
	)

Retrieve the profiling trace from a device.

Parameters

device	the device object
device_trace	the pointer to the retrieved trace object

Returns

odla_status

odla_SetDeviceTraceItem()

ODLA_API_EXPORT odla_status ODLA_API_CALL odla_SetDeviceTraceItem	(	odla_device_trace	device_trace,
		odla_device_trace_item	device_trace_item,
			...
	)

Set the device trace with a property item.

Parameters

device_trace	the device trace object
device_trace_item	the item
variadic

Returns

odla_status

odla_StartDeviceProfiler()

ODLA_API_EXPORT odla_status ODLA_API_CALL odla_StartDeviceProfiler

(

odla_device

device

)

Start the profiler tracing on a device.

Parameters

device

the device object

Returns

odla_status

odla_StopDeviceProfiler()

ODLA_API_EXPORT odla_status ODLA_API_CALL odla_StopDeviceProfiler

(

odla_device

device

)

Stop the profiler tracing on a device.

Parameters

device

the device object

Returns

odla_status