cuda.bindings._v2.driver.FunctionAttribute

class cuda.bindings._v2.driver.FunctionAttribute(value: int)

Function properties

See CUfunction_attribute.

MAX_THREADS_PER_BLOCK: 0

The maximum number of threads per block, beyond which a launch of the function would fail. This number depends on both the function and the device on which the function is currently loaded.

SHARED_SIZE_BYTES: 1

The size in bytes of statically-allocated shared memory required by this function. This does not include dynamically-allocated shared memory requested by the user at runtime.

CONST_SIZE_BYTES: 2

The size in bytes of user-allocated constant memory required by this function.

LOCAL_SIZE_BYTES: 3

The size in bytes of local memory used by each thread of this function.

NUM_REGS: 4

The number of registers used by each thread of this function.

PTX_VERSION: 5

The PTX virtual architecture version for which the function was compiled. This value is the major PTX version * 10 + the minor PTX version, so a PTX version 1.3 function would return the value 13. Note that this may return the undefined value of 0 for cubins compiled prior to CUDA 3.0.

BINARY_VERSION: 6

The binary architecture version for which the function was compiled. This value is the major binary version * 10 + the minor binary version, so a binary version 1.3 function would return the value 13. Note that this will return a value of 10 for legacy cubins that do not have a properly-encoded binary architecture version.

CACHE_MODE_CA: 7

The attribute to indicate whether the function has been compiled with user specified option “-Xptxas –dlcm=ca” set .

MAX_DYNAMIC_SHARED_SIZE_BYTES: 8

The maximum size in bytes of dynamically-allocated shared memory that can be used by this function. If the user-specified dynamic shared memory size is larger than this value, the launch will fail. The default value of this attribute is CU_DEVICE_ATTRIBUTE_MAX_SHARED_MEMORY_PER_BLOCK - CU_FUNC_ATTRIBUTE_SHARED_SIZE_BYTES, except when CU_FUNC_ATTRIBUTE_SHARED_SIZE_BYTES is greater than CU_DEVICE_ATTRIBUTE_MAX_SHARED_MEMORY_PER_BLOCK, then the default value of this attribute is 0. The value can be increased to CU_DEVICE_ATTRIBUTE_MAX_SHARED_MEMORY_PER_BLOCK_OPTIN - CU_FUNC_ATTRIBUTE_SHARED_SIZE_BYTES. This attribute is ignored if CU_FUNC_ATTRIBUTE_SHARED_MEMORY_MODE or CU_LAUNCH_ATTRIBUTE_SHARED_MEMORY_MODE is set. This attribute cannot be used to access oversized shared memory. Oversized shared memory can only be accessed by setting CU_FUNC_ATTRIBUTE_SHARED_MEMORY_MODE or CU_LAUNCH_ATTRIBUTE_SHARED_MEMORY_MODE. See cuFuncSetAttribute, cuKernelSetAttribute

PREFERRED_SHARED_MEMORY_CARVEOUT: 9

On devices where the L1 cache and shared memory use the same hardware resources, this sets the shared memory carveout preference, in percent of the total shared memory. Refer to CU_DEVICE_ATTRIBUTE_MAX_SHARED_MEMORY_PER_MULTIPROCESSOR. This is only a hint, and the driver can choose a different ratio if required to execute the function. See cuFuncSetAttribute, cuKernelSetAttribute

CLUSTER_SIZE_MUST_BE_SET: 10

If this attribute is set, the kernel must launch with a valid cluster size specified. See cuFuncSetAttribute, cuKernelSetAttribute

REQUIRED_CLUSTER_WIDTH: 11

The required cluster width in blocks. The values must either all be 0 or all be positive. The validity of the cluster dimensions is otherwise checked at launch time. If the value is set during compile time, it cannot be set at runtime. Setting it at runtime will return CUDA_ERROR_NOT_PERMITTED. See cuFuncSetAttribute, cuKernelSetAttribute

REQUIRED_CLUSTER_HEIGHT: 12

The required cluster height in blocks. The values must either all be 0 or all be positive. The validity of the cluster dimensions is otherwise checked at launch time. If the value is set during compile time, it cannot be set at runtime. Setting it at runtime should return CUDA_ERROR_NOT_PERMITTED. See cuFuncSetAttribute, cuKernelSetAttribute

REQUIRED_CLUSTER_DEPTH: 13

The required cluster depth in blocks. The values must either all be 0 or all be positive. The validity of the cluster dimensions is otherwise checked at launch time. If the value is set during compile time, it cannot be set at runtime. Setting it at runtime should return CUDA_ERROR_NOT_PERMITTED. See cuFuncSetAttribute, cuKernelSetAttribute

NON_PORTABLE_CLUSTER_SIZE_ALLOWED: 14

Whether the function can be launched with non-portable cluster size. 1 is allowed, 0 is disallowed. A non-portable cluster size may only function on the specific SKUs the program is tested on. The launch might fail if the program is run on a different hardware platform. CUDA API provides cudaOccupancyMaxActiveClusters to assist with checking whether the desired size can be launched on the current device. Portable Cluster Size A portable cluster size is guaranteed to be functional on all compute capabilities higher than the target compute capability. The portable cluster size for sm_90 is 8 blocks per cluster. This value may increase for future compute capabilities. The specific hardware unit may support higher cluster sizes that’s not guaranteed to be portable. See cuFuncSetAttribute, cuKernelSetAttribute

CLUSTER_SCHEDULING_POLICY_PREFERENCE: 15

The block scheduling policy of a function. The value type is CUclusterSchedulingPolicy / cudaClusterSchedulingPolicy. See cuFuncSetAttribute, cuKernelSetAttribute

DEVICE_NODE_UPDATE_SUPPORTED: 16

Whether the function can be updated on device. 1 means device node update is supported, 0 is unsupported. See cuFuncGetAttribute.

SHARED_MEMORY_MODE: 17

The shared memory mode of a function. The value type is CUsharedMemoryMode / cudaSharedMemoryMode. See cuFuncSetAttribute, cuKernelSetAttribute

MAX: 18