__global

Address space qualifier.

__global global

Description

OpenCL implements the following disjoint address spaces: __global, __local, __constant and __private.

The address space qualifier may be used in variable declarations to specify the region of memory that is used to allocate the object. The C syntax for type qualifiers is extended in OpenCL to include an address space name as a valid type qualifier. If the type of an object is qualified by an address space name, the object is allocated in the specified address name; otherwise, the object is allocated in the generic address space.

The address space names without the __ prefix i.e. global, local, constant and private may be substituted for the corresponding address space names with the __ prefix.

The generic address space name for arguments to a function in a program, or local variables of a function is __private. All function arguments shall be in the __private address space.

__kernel function arguments declared to be a pointer of a type can point to one of the following address spaces only: __global, __local or __constant. A pointer to address space A can only be assigned to a pointer to the same address space A. Casting a pointer to address space A to a pointer to address space B is illegal.

The __kernel function arguments declared to be of type image2d_t or image3d_t always point to the __global address space.

There is no generic address space name for program scope variables. All program scope variables must be declared in the __constant address space.

The __constant or constant address space name is used to describe variables allocated in global memory and which are accessed inside a kernel(s) as read-only variables. These read- only variables can be accessed by all (global) work-items of the kernel during its execution. Pointers to the __constant address space are allowed arguments to functions (including __kernel functions) and for variables declared inside functions. Variables allocated in the __constant address space can only be defined as program scope variables and are required to be initialized.

Writes to variables declared with the __constant address space qualifier in the OpenCL program source should be a compile-time error.

All string literal storage shall be in the __constant address space.

NOTE: Any argument to a kernel that is declared with the __constant address space qualifier counts as a separate constant argument. The relevant device capabilities CL_DEVICE_MAX_CONSTANT_ARGS and CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE are described in the table for clGetDeviceInfo.

Variables inside a function or in program scope can also be declared with the __constant address qualifier. Implementations are not required to aggregate these declarations into the fewest number of constant arguments. This behavior is implementation defined.

Thus portable code must conservatively assume that each variable declared inside a function or in program scope with the __constant qualifier counts as a separate constant argument.

Examples

// declares a pointer p in the __private address space that // points to an int object in address space __global __global int *p; // declares an array of 4 floats in the __private address space. float x[4];

__global float4 *color; // An array of float4 elements typedef struct { float a[3]; int b[2]; } foo_t; __global foo_t *my_info; // An array of foo_t elements. __global image2d_t texture; // A 2D texture image

Specification

OpenCL Specification

Also see

__local, __constant, __private

Copyright © 2007-2010 The Khronos Group Inc. 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.