'\" t
.\"     Title: clGetEventProfilingInfo
.\"    Author: The Khronos Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 01/14/2021
.\"    Manual: OpenCL Manual
.\"    Source: The Khronos Group
.\"  Language: English
.\"
.TH "CLGETEVENTPROFILINGI" "3clc" "01/14/2021" "The Khronos Group" "OpenCL Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
clGetEventProfilingInfo \- Returns profiling information for the command associated with event if profiling is enabled\&.
.SH ""
.HP \w'cl_int\ clGetEventProfilingInfo('u
.BI "cl_int clGetEventProfilingInfo(cl_event\ " "event" ", cl_profiling_info\ " "param_name" ", size_t\ " "param_value_size" ", void\ *" "param_value" ", size_t\ *" "param_value_size_ret" ");"
.SH "PARAMETERS"
.PP
\fIevent\fR
.RS 4
Specifies the event object\&.
.RE
.PP
\fIparam_name\fR
.RS 4
Specifies the profiling data to query\&. The list of supported
\fIparam_name\fR
types and the information returned in
\fIparam_value\fR
by
\fBclGetEventProfilingInfo\fR
is described in the table of parameter queries below\&.
.RE
.PP
\fIparam_value_size\fR
.RS 4
Specifies the size in bytes of memory pointed to by
\fIparam_value\fR\&. This size must be ≥ size of return type as described in the table below\&.
.RE
.PP
\fIparam_value\fR
.RS 4
A pointer to memory where the appropriate result being queried is returned\&. if
\fIparam_value\fR
is NULL, it is ignored\&.
.RE
.PP
\fIparam_value_size_ret\fR
.RS 4
Returns the actual size in bytes of data copied to
\fIparam_value\fR\&. If
\fIparam_value_size_ret\fR
is NULL, it is ignored\&.
.RE
.PP
.RS 4
The following is a table of
\fBclGetEventProfilingInfo\fR
parameter queries
.TS
allbox tab(:);
lB lB lB.
T{
cl_profiling_info
T}:T{
Return Type
T}:T{
Info\&. returned in \fIparam_value\fR
T}
.T&
l l l
l l l
l l l
l l l.
T{
\fBCL_PROFILING_COMMAND_QUEUED\fR
T}:T{
cl_ulong
T}:T{
A 64\-bit value that describes the current device time counter in
nanoseconds when the command identified by \fIevent\fR
is enqueued in a command\-queue by the host\&.
T}
T{
\fBCL_PROFILING_COMMAND_SUBMIT\fR
T}:T{
cl_ulong
T}:T{
A 64\-bit value that describes the current device time counter in
nanoseconds when the command identified by \fIevent\fR
that has been enqueued is submitted by the host to the device associated
with the command\-queue\&.
T}
T{
\fBCL_PROFILING_COMMAND_START\fR
T}:T{
cl_ulong
T}:T{
A 64\-bit value that describes the current device time counter in
nanoseconds when the command identified by \fIevent\fR
starts execution on the device\&.
T}
T{
\fBCL_PROFILING_COMMAND_END\fR
T}:T{
cl_ulong
T}:T{
A 64\-bit value that describes the current device time counter in
nanoseconds when the command identified by \fIevent\fR
has finished execution on the device\&.
T}
.TE
.sp 1
.RE
.SH "NOTES"
.PP
The unsigned 64\-bit values returned can be used to measure the time in nano\-seconds consumed by OpenCL commands\&.
.PP
OpenCL devices are required to correctly track time across changes in device frequency and power states\&. The
\fBCL_DEVICE_PROFILING_TIMER_RESOLUTION\fR
specifies the resolution of the timer i\&.e\&. the number of nanoseconds elapsed before the timer is incremented\&.
.PP
Event objects can be used to capture profiling information that measure execution time of a command\&. Profiling of OpenCL commands can be enabled either by using a command\-queue created with
\fBCL_QUEUE_PROFILING_ENABLE\fR
flag set in
\fIproperties\fR
argument to
\fBclCreateCommandQueue\fR(3clc)\&.
.SH "ERRORS"
.PP
Returns
CL_SUCCESS
if the function is executed successfully and the profiling information has been recorded\&. Otherwise, it returns one of the following errors:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_PROFILING_INFO_NOT_AVAILABLE if the
\fBCL_QUEUE_PROFILING_ENABLE\fR flag is not set for the command\-queue,
if the execution status of the command identified by \fIevent\fR
is not \fBCL_COMPLETE\fR or if \fIevent\fR is a user
event object\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_VALUE if \fIparam_name\fR is not
valid, or if size in bytes specified by \fIparam_value_size\fR
is < size of return type as described in the above table and
\fIparam_value\fR is not NULL\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_EVENT if \fIevent\fR is a not a
valid event object\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_OUT_OF_RESOURCES if there is a failure to allocate
resources required by the OpenCL implementation on the device\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_OUT_OF_HOST_MEMORY if there is a failure to allocate
resources required by the OpenCL implementation on the host\&.
.RE
.SH "SPECIFICATION"
.PP
\m[blue]\fBOpenCL Specification\fR\m[]\&\s-2\u[1]\d\s+2
.SH "SEE ALSO"
.PP
\fBclCreateCommandQueue\fR(3clc)
.SH "AUTHORS"
.PP
\fBThe Khronos Group\fR
.SH "COPYRIGHT"
.br
Copyright \(co 2007-2011 The Khronos Group Inc.
.br
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and/or associated documentation files (the "Materials"), to deal in the Materials without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Materials, and to permit persons to whom the Materials are furnished to do so, subject to the condition that this copyright notice and permission notice shall be included in all copies or substantial portions of the Materials.
.sp
.SH "NOTES"
.IP " 1." 4
OpenCL Specification
.RS 4
\%page 190, section 5.12 - Profiling Operations on Memory Objects and Kernels
.RE