1.2.2 Querying Devices

1.2.2 Querying Devices🔗ℹ

package: opencl

procedure
(clGetDeviceIDs:count platform device_type) → _cl_uint/c
platform : _cl_platform_id/null/c
device_type : _cl_device_type/c

Returns how many results clGetDeviceIDs may return for these arguments.

procedure
(clGetDeviceIDs platform
device_type
how-many)
→
_cl_device_id_vector/c _cl_uint/c
  platform : _cl_platform_id/null/c
  device_type : _cl_device_type/c
  how-many : _cl_uint/c

Returns the minimum of how-many and how-many-possible values in rets.

procedure
(clGetDeviceIDs:vector platform
device_type) → _cl_device_id_vector/c
platform : _cl_platform_id/null/c
device_type : _cl_device_type/c

Returns all possible results from clGetDeviceIDs using clGetDeviceIDs:count to extract the number available.

value
clGetDeviceInfo : procedure?

A dummy Racket function that refers callers to the other clGetDeviceInfo-based functions which access the true C function.

procedure
(clGetDeviceInfo:length device param_name) → _size_t/c
device : _cl_device_id/c
param_name : _cl_device_info/c

Returns the size of param_name field of the argument(s). Calls clGetDeviceInfo with values for param_value_size and param_value such that param_value_size_ret is queried.

procedure
(clGetDeviceInfo:_cl_device_type device
param_name)
→ _cl_device_type/c
device : _cl_device_id/c
param_name : _cl_device_info/c

Returns the value associated with param_name for the argument(s). Implemented by clGetDeviceInfo with param_value_size set to (ctype-sizeof _cl_device_type) so that the value is queried. Valid param_names are '(CL_DEVICE_TYPE).

procedure
(clGetDeviceInfo:_cl_uint device
param_name) → _cl_uint/c
device : _cl_device_id/c
param_name : _cl_device_info/c

Returns the value associated with param_name for the argument(s). Implemented by clGetDeviceInfo with param_value_size set to (ctype-sizeof _cl_uint) so that the value is queried. Valid param_names are '(CL_DEVICE_VENDOR_ID CL_DEVICE_MAX_COMPUTE_UNITS CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE CL_DEVICE_MAX_CLOCK_FREQUENCY CL_DEVICE_ADDRESS_BITS CL_DEVICE_MAX_READ_IMAGE_ARGS CL_DEVICE_MAX_WRITE_IMAGE_ARGS CL_DEVICE_MAX_SAMPLERS CL_DEVICE_MEM_BASE_ADDR_ALIGN CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE).

procedure
(clGetDeviceInfo:_size_t device param_name) → _size_t/c
device : _cl_device_id/c
param_name : _cl_device_info/c

Returns the value associated with param_name for the argument(s). Implemented by clGetDeviceInfo with param_value_size set to (ctype-sizeof _size_t) so that the value is queried. Valid param_names are '(CL_DEVICE_MAX_WORK_GROUP_SIZE CL_DEVICE_IMAGE2D_MAX_WIDTH CL_DEVICE_IMAGE2D_MAX_HEIGHT CL_DEVICE_IMAGE3D_MAX_WIDTH CL_DEVICE_IMAGE3D_MAX_HEIGHT CL_DEVICE_IMAGE3D_MAX_DEPTH CL_DEVICE_MAX_PARAMETER_SIZE CL_DEVICE_MAX_CONSTANT_ARGS CL_DEVICE_PROFILING_TIMER_RESOLUTION).

procedure
(clGetDeviceInfo:_cl_ulong device
param_name) → _cl_ulong/c
device : _cl_device_id/c
param_name : _cl_device_info/c

Returns the value associated with param_name for the argument(s). Implemented by clGetDeviceInfo with param_value_size set to (ctype-sizeof _cl_ulong) so that the value is queried. Valid param_names are '(CL_DEVICE_MAX_MEM_ALLOC_SIZE CL_DEVICE_GLOBAL_MEM_CACHE_SIZE CL_DEVICE_GLOBAL_MEM_SIZE CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE CL_DEVICE_LOCAL_MEM_SIZE).

procedure
(clGetDeviceInfo:_cl_bool device
param_name) → _cl_bool/c
device : _cl_device_id/c
param_name : _cl_device_info/c

Returns the value associated with param_name for the argument(s). Implemented by clGetDeviceInfo with param_value_size set to (ctype-sizeof _cl_bool) so that the value is queried. Valid param_names are '(CL_DEVICE_IMAGE_SUPPORT CL_DEVICE_ERROR_CORRECTION_SUPPORT CL_DEVICE_ENDIAN_LITTLE CL_DEVICE_AVAILABLE CL_DEVICE_COMPILER_AVAILABLE).

procedure
(clGetDeviceInfo:_cl_device_fp_config device
param_name)
→ _cl_device_fp_config/c
device : _cl_device_id/c
param_name : _cl_device_info/c

Returns the value associated with param_name for the argument(s). Implemented by clGetDeviceInfo with param_value_size set to (ctype-sizeof _cl_device_fp_config) so that the value is queried. Valid param_names are '(CL_DEVICE_SINGLE_FP_CONFIG).

procedure
(clGetDeviceInfo:_cl_device_mem_cache_type device
param_name)
→ _cl_device_mem_cache_type/c
device : _cl_device_id/c
param_name : _cl_device_info/c

Returns the value associated with param_name for the argument(s). Implemented by clGetDeviceInfo with param_value_size set to (ctype-sizeof _cl_device_mem_cache_type) so that the value is queried. Valid param_names are '(CL_DEVICE_GLOBAL_MEM_CACHE_TYPE).

procedure
(clGetDeviceInfo:_cl_device_local_mem_type device
param_name)
→ _cl_device_local_mem_type/c
device : _cl_device_id/c
param_name : _cl_device_info/c

Returns the value associated with param_name for the argument(s). Implemented by clGetDeviceInfo with param_value_size set to (ctype-sizeof _cl_device_local_mem_type) so that the value is queried. Valid param_names are '(CL_DEVICE_LOCAL_MEM_TYPE).

procedure
(clGetDeviceInfo:_cl_device_exec_capabilities device
param_name)
→ _cl_device_exec_capabilities/c
device : _cl_device_id/c
param_name : _cl_device_info/c

Returns the value associated with param_name for the argument(s). Implemented by clGetDeviceInfo with param_value_size set to (ctype-sizeof _cl_device_exec_capabilities) so that the value is queried. Valid param_names are '(CL_DEVICE_EXECUTION_CAPABILITIES).

procedure
(clGetDeviceInfo:_cl_command_queue_properties device
param_name)
→ _cl_command_queue_properties/c
device : _cl_device_id/c
param_name : _cl_device_info/c

Returns the value associated with param_name for the argument(s). Implemented by clGetDeviceInfo with param_value_size set to (ctype-sizeof _cl_command_queue_properties) so that the value is queried. Valid param_names are '(CL_DEVICE_QUEUE_PROPERTIES).

procedure
(clGetDeviceInfo:_cl_platform_id device
param_name)
→ _cl_platform_id/c
device : _cl_device_id/c
param_name : _cl_device_info/c

Returns the value associated with param_name for the argument(s). Implemented by clGetDeviceInfo with param_value_size set to (ctype-sizeof _cl_platform_id) so that the value is queried. Valid param_names are '(CL_DEVICE_PLATFORM).

procedure
(clGetDeviceInfo:_size_t* device
param_name
param_value_size) → _size_t_vector/c
  device : _cl_device_id/c
  param_name : _cl_device_info/c
  param_value_size : _size_t/c

Returns the value associated with param_name for the argument(s). Implemented by clGetDeviceInfo with param_value_size passed explicitly. Valid param_names are '(CL_DEVICE_MAX_WORK_ITEM_SIZES).

procedure
(clGetDeviceInfo:_char* device
param_name
param_value_size) → bytes?
  device : _cl_device_id/c
  param_name : _cl_device_info/c
  param_value_size : _size_t/c

Returns the value associated with param_name for the argument(s). Implemented by clGetDeviceInfo with param_value_size passed explicitly. Valid param_names are '(CL_DEVICE_NAME CL_DEVICE_VENDOR CL_DRIVER_VERSION CL_DEVICE_PROFILE CL_DEVICE_VERSION CL_DEVICE_EXTENSIONS).

value
clGetDeviceInfo/c : contract?

A contract for the return values of clGetDeviceInfo:generic. Its definition is: (or/c _cl_device_type/c _cl_uint/c _size_t/c _cl_ulong/c _cl_bool/c _cl_device_fp_config/c _cl_device_mem_cache_type/c _cl_device_local_mem_type/c _cl_device_exec_capabilities/c _cl_command_queue_properties/c _cl_platform_id/c _size_t_vector/c bytes?).

procedure
(clGetDeviceInfo:generic device param_name) → clGetDeviceInfo/c
device : _cl_device_id/c
param_name : _cl_device_info/c

Returns the value associated with param_name for the argument(s). Selects the appropriate clGetDeviceInfo-based function to extract the appropriate value, automatically providing the right length for variable length functions.

1.1	Types
1.2	The Open CL Platform Layer
1.3	The Open CL Runtime

1.2.1	Querying Platform Info
1.2.2	Querying Devices
1.2.3	Contexts