C Specification

To return information about a kernel object, call the function

cl_int clGetKernelInfo(
    cl_kernel kernel,
    cl_kernel_info param_name,
    size_t param_value_size,
    void* param_value,
    size_t* param_value_size_ret);

Parameters

  • kernel specifies the kernel object being queried.

  • param_name specifies the information to query. The list of supported param_name types and the information returned in param_value by clGetKernelInfo is described in the Kernel Object Queries table.

  • param_value is a pointer to memory where the appropriate result being queried is returned. If param_value is NULL, it is ignored.

  • param_value_size is used to specify the size in bytes of memory pointed to by param_value. This size must be ≥ size of return type as described in the Kernel Object Queries table.

  • param_value_size_ret returns the actual size in bytes of data being queried by param_name. If param_value_size_ret is NULL, it is ignored.

Description

Table 1. List of supported param_names by https://www.khronos.org/registry/OpenCL/specs/2.2/html/OpenCL_API.html#clGetKernelInfo
cl_kernel_info Return Type Info. returned in param_value

CL_​KERNEL_​FUNCTION_​NAME

char[]

Return the kernel function name.

CL_​KERNEL_​NUM_​ARGS

cl_uint

Return the number of arguments to kernel.

CL_​KERNEL_​REFERENCE_​COUNT16

cl_uint

Return the kernel reference count.

CL_​KERNEL_​CONTEXT

cl_context

Return the context associated with kernel.

CL_​KERNEL_​PROGRAM

cl_program

Return the program object associated with kernel.

CL_​KERNEL_​ATTRIBUTES

Missing before version 1.2.

char[]

Returns any attributes specified using the __attribute__ OpenCL C qualifier (or using an OpenCL C++ qualifier syntax [[]] ) with the kernel function declaration in the program source. These attributes include attributes described in the earlier OpenCL C kernel language specifications and other attributes supported by an implementation.

Attributes are returned as they were declared inside __attribute__((...)), with any surrounding whitespace and embedded newlines removed. When multiple attributes are present, they are returned as a single, space delimited string.

For kernels not created from OpenCL C source and the clCreateProgramWithSource API call the string returned from this query will be empty.

16

The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.

clGetKernelInfo returns CL_​SUCCESS if the function is executed successfully. Otherwise, it returns one of the following errors:

  • CL_​INVALID_​VALUE if param_name is not valid, or if size in bytes specified by param_value_size is < size of return type as described in the Kernel Object Queries table and param_value is not NULL.

  • CL_​INVALID_​KERNEL if kernel is a not a valid kernel object.

  • CL_​OUT_​OF_​RESOURCES if there is a failure to allocate resources required by the OpenCL implementation on the device.

  • CL_​OUT_​OF_​HOST_​MEMORY if there is a failure to allocate resources required by the OpenCL implementation on the host.

See Also

Document Notes

For more information, see the OpenCL Specification

This page is extracted from the OpenCL Specification. Fixes and changes should be made to the Specification, not directly.

Copyright (c) 2014-2020 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.