org.bytedeco.cuda.cudart

Class cudaFuncAttributes

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.cuda.cudart.cudaFuncAttributes

All Implemented Interfaces:

AutoCloseable

@Properties(inherit=cudart.class)
public class cudaFuncAttributes
extends Pointer

CUDA function attributes

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
cudaFuncAttributes() Default native constructor.
cudaFuncAttributes(long size) Native array allocator.
cudaFuncAttributes(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
int	binaryVersion() The binary architecture version for which the function was compiled.
cudaFuncAttributes	binaryVersion(int setter)
int	cacheModeCA() The attribute to indicate whether the function has been compiled with user specified option "-Xptxas --dlcm=ca" set.
cudaFuncAttributes	cacheModeCA(int setter)
int	clusterDimMustBeSet() If this attribute is set, the kernel must launch with a valid cluster dimension specified.
cudaFuncAttributes	clusterDimMustBeSet(int setter)
int	clusterSchedulingPolicyPreference() The block scheduling policy of a function.
cudaFuncAttributes	clusterSchedulingPolicyPreference(int setter)
long	constSizeBytes() The size in bytes of user-allocated constant memory required by this function.
cudaFuncAttributes	constSizeBytes(long setter)
cudaFuncAttributes	getPointer(long i)
long	localSizeBytes() The size in bytes of local memory used by each thread of this function.
cudaFuncAttributes	localSizeBytes(long setter)
int	maxDynamicSharedSizeBytes() The maximum size in bytes of dynamic shared memory per block for this function.
cudaFuncAttributes	maxDynamicSharedSizeBytes(int setter)
int	maxThreadsPerBlock() The maximum number of threads per block, beyond which a launch of the function would fail.
cudaFuncAttributes	maxThreadsPerBlock(int setter)
int	nonPortableClusterSizeAllowed() Whether the function can be launched with non-portable cluster size.
cudaFuncAttributes	nonPortableClusterSizeAllowed(int setter)
int	numRegs() The number of registers used by each thread of this function.
cudaFuncAttributes	numRegs(int setter)
cudaFuncAttributes	position(long position)
int	preferredShmemCarveout() 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 maximum shared memory.
cudaFuncAttributes	preferredShmemCarveout(int setter)
int	ptxVersion() The PTX virtual architecture version for which the function was compiled.
cudaFuncAttributes	ptxVersion(int setter)
int	requiredClusterDepth()
cudaFuncAttributes	requiredClusterDepth(int setter)
int	requiredClusterHeight()
cudaFuncAttributes	requiredClusterHeight(int setter)
int	requiredClusterWidth() The required cluster width/height/depth in blocks.
cudaFuncAttributes	requiredClusterWidth(int setter)
IntPointer	reserved()
int	reserved(int i) Reserved for future use.
cudaFuncAttributes	reserved(int i, int setter)
long	sharedSizeBytes() The size in bytes of statically-allocated shared memory per block required by this function.
cudaFuncAttributes	sharedSizeBytes(long setter)

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

cudaFuncAttributes

public cudaFuncAttributes()

Default native constructor.

cudaFuncAttributes

public cudaFuncAttributes(long size)

Native array allocator. Access with Pointer.position(long).

cudaFuncAttributes

public cudaFuncAttributes(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

position

public cudaFuncAttributes position(long position)

Overrides:

position in class Pointer

getPointer

public cudaFuncAttributes getPointer(long i)

Overrides:

getPointer in class Pointer

sharedSizeBytes

@Cast(value="size_t")
public long sharedSizeBytes()

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

sharedSizeBytes

public cudaFuncAttributes sharedSizeBytes(long setter)

constSizeBytes

@Cast(value="size_t")
public long constSizeBytes()

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

constSizeBytes

public cudaFuncAttributes constSizeBytes(long setter)

localSizeBytes

@Cast(value="size_t")
public long localSizeBytes()

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

localSizeBytes

public cudaFuncAttributes localSizeBytes(long setter)

maxThreadsPerBlock

public int maxThreadsPerBlock()

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.

maxThreadsPerBlock

public cudaFuncAttributes maxThreadsPerBlock(int setter)

numRegs

public int numRegs()

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

numRegs

public cudaFuncAttributes numRegs(int setter)

ptxVersion

public int ptxVersion()

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.

ptxVersion

public cudaFuncAttributes ptxVersion(int setter)

binaryVersion

public int binaryVersion()

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.

binaryVersion

public cudaFuncAttributes binaryVersion(int setter)

cacheModeCA

public int cacheModeCA()

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

cacheModeCA

public cudaFuncAttributes cacheModeCA(int setter)

maxDynamicSharedSizeBytes

public int maxDynamicSharedSizeBytes()

The maximum size in bytes of dynamic shared memory per block for this function. Any launch must have a dynamic shared memory size smaller than this value.

maxDynamicSharedSizeBytes

public cudaFuncAttributes maxDynamicSharedSizeBytes(int setter)

preferredShmemCarveout

public int preferredShmemCarveout()

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 maximum shared memory. Refer to ::cudaDevAttrMaxSharedMemoryPerMultiprocessor. This is only a hint, and the driver can choose a different ratio if required to execute the function. See ::cudaFuncSetAttribute

preferredShmemCarveout

public cudaFuncAttributes preferredShmemCarveout(int setter)

clusterDimMustBeSet

public int clusterDimMustBeSet()

If this attribute is set, the kernel must launch with a valid cluster dimension specified.

clusterDimMustBeSet

public cudaFuncAttributes clusterDimMustBeSet(int setter)

requiredClusterWidth

public int requiredClusterWidth()

The required cluster width/height/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 cudaErrorNotPermitted. See ::cudaFuncSetAttribute

requiredClusterWidth

public cudaFuncAttributes requiredClusterWidth(int setter)

requiredClusterHeight

public int requiredClusterHeight()

requiredClusterHeight

public cudaFuncAttributes requiredClusterHeight(int setter)

requiredClusterDepth

public int requiredClusterDepth()

requiredClusterDepth

public cudaFuncAttributes requiredClusterDepth(int setter)

clusterSchedulingPolicyPreference

public int clusterSchedulingPolicyPreference()

The block scheduling policy of a function. See ::cudaFuncSetAttribute

clusterSchedulingPolicyPreference

public cudaFuncAttributes clusterSchedulingPolicyPreference(int setter)

nonPortableClusterSizeAllowed

public int nonPortableClusterSizeAllowed()

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 ::cudaFuncSetAttribute

nonPortableClusterSizeAllowed

public cudaFuncAttributes nonPortableClusterSizeAllowed(int setter)

reserved

public int reserved(int i)

Reserved for future use.

reserved

public cudaFuncAttributes reserved(int i,
                                   int setter)

reserved

@MemberGetter
public IntPointer reserved()