org.bytedeco.cuda.cupti

Class CUpti_CallbackData

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.cuda.cupti.CUpti_CallbackData

All Implemented Interfaces:

AutoCloseable

@Properties(inherit=cupti.class)
public class CUpti_CallbackData
extends Pointer

\brief Data passed into a runtime or driver API callback function. Data passed into a runtime or driver API callback function as the \p cbdata argument to \ref CUpti_CallbackFunc. The \p cbdata will be this type for \p domain equal to CUPTI_CB_DOMAIN_DRIVER_API or CUPTI_CB_DOMAIN_RUNTIME_API. The callback data is valid only within the invocation of the callback function that is passed the data. If you need to retain some data for use outside of the callback, you must make a copy of that data. For example, if you make a shallow copy of CUpti_CallbackData within a callback, you cannot dereference \p functionParams outside of that callback to access the function parameters. \p functionName is an exception: the string pointed to by \p functionName is a global constant and so may be accessed outside of the callback.

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
CUpti_CallbackData() Default native constructor.
CUpti_CallbackData(long size) Native array allocator.
CUpti_CallbackData(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
int	callbackSite() Point in the runtime or driver function from where the callback was issued.
CUpti_CallbackData	callbackSite(int setter)
CUctx_st	context() Driver context current to the thread, or null if no context is current.
CUpti_CallbackData	context(CUctx_st setter)
int	contextUid() Unique ID for the CUDA context associated with the thread.
CUpti_CallbackData	contextUid(int setter)
LongPointer	correlationData() Pointer to data shared between the entry and exit callbacks of a given runtime or drive API function invocation.
CUpti_CallbackData	correlationData(LongPointer setter)
int	correlationId() The activity record correlation ID for this callback.
CUpti_CallbackData	correlationId(int setter)
BytePointer	functionName() Name of the runtime or driver API function which issued the callback.
CUpti_CallbackData	functionName(BytePointer setter)
Pointer	functionParams() Pointer to the arguments passed to the runtime or driver API call.
CUpti_CallbackData	functionParams(Pointer setter)
Pointer	functionReturnValue() Pointer to the return value of the runtime or driver API call.
CUpti_CallbackData	functionReturnValue(Pointer setter)
CUpti_CallbackData	getPointer(long i)
CUpti_CallbackData	position(long position)
BytePointer	symbolName() Name of the symbol operated on by the runtime or driver API function which issued the callback.
CUpti_CallbackData	symbolName(BytePointer 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

CUpti_CallbackData

public CUpti_CallbackData()

Default native constructor.

CUpti_CallbackData

public CUpti_CallbackData(long size)

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

CUpti_CallbackData

public CUpti_CallbackData(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

position

public CUpti_CallbackData position(long position)

Overrides:

position in class Pointer

getPointer

public CUpti_CallbackData getPointer(long i)

Overrides:

getPointer in class Pointer

callbackSite

@Cast(value="CUpti_ApiCallbackSite")
public int callbackSite()

Point in the runtime or driver function from where the callback was issued.

callbackSite

public CUpti_CallbackData callbackSite(int setter)

functionName

@Cast(value="const char*")
public BytePointer functionName()

Name of the runtime or driver API function which issued the callback. This string is a global constant and so may be accessed outside of the callback.

functionName

public CUpti_CallbackData functionName(BytePointer setter)

functionParams

@Const
public Pointer functionParams()

Pointer to the arguments passed to the runtime or driver API call. See generated_cuda_runtime_api_meta.h and generated_cuda_meta.h for structure definitions for the parameters for each runtime and driver API function.

functionParams

public CUpti_CallbackData functionParams(Pointer setter)

functionReturnValue

public Pointer functionReturnValue()

Pointer to the return value of the runtime or driver API call. This field is only valid within the exit::CUPTI_API_EXIT callback. For a runtime API \p functionReturnValue points to a \p cudaError_t. For a driver API \p functionReturnValue points to a \p CUresult.

functionReturnValue

public CUpti_CallbackData functionReturnValue(Pointer setter)

symbolName

@Cast(value="const char*")
public BytePointer symbolName()

Name of the symbol operated on by the runtime or driver API function which issued the callback. This entry is valid only for driver and runtime launch callbacks, where it returns the name of the kernel.

symbolName

public CUpti_CallbackData symbolName(BytePointer setter)

context

public CUctx_st context()

Driver context current to the thread, or null if no context is current. This value can change from the entry to exit callback of a runtime API function if the runtime initializes a context.

context

public CUpti_CallbackData context(CUctx_st setter)

contextUid

@Cast(value="uint32_t")
public int contextUid()

Unique ID for the CUDA context associated with the thread. The UIDs are assigned sequentially as contexts are created and are unique within a process.

contextUid

public CUpti_CallbackData contextUid(int setter)

correlationData

@Cast(value="uint64_t*")
public LongPointer correlationData()

Pointer to data shared between the entry and exit callbacks of a given runtime or drive API function invocation. This field can be used to pass 64-bit values from the entry callback to the corresponding exit callback.

correlationData

public CUpti_CallbackData correlationData(LongPointer setter)

correlationId

@Cast(value="uint32_t")
public int correlationId()

The activity record correlation ID for this callback. For a driver domain callback (i.e. \p domain CUPTI_CB_DOMAIN_DRIVER_API) this ID will equal the correlation ID in the CUpti_ActivityAPI record corresponding to the CUDA driver function call. For a runtime domain callback (i.e. \p domain CUPTI_CB_DOMAIN_RUNTIME_API) this ID will equal the correlation ID in the CUpti_ActivityAPI record corresponding to the CUDA runtime function call. Within the callback, this ID can be recorded to correlate user data with the activity record. This field is new in 4.1.

correlationId

public CUpti_CallbackData correlationId(int setter)