org.bytedeco.cuda.global

Class nvToolsExt

java.lang.Object

org.bytedeco.cuda.presets.nvToolsExt

org.bytedeco.cuda.global.nvToolsExt

All Implemented Interfaces:

InfoMapper

public class nvToolsExt
extends nvToolsExt

Field Summary

Fields

Modifier and Type	Field and Description
static int	NVTX_COLOR_ARGB enum nvtxColorType_t
static int	NVTX_COLOR_UNKNOWN enum nvtxColorType_t
static int	NVTX_EVENT_ATTRIB_STRUCT_SIZE
static int	NVTX_MESSAGE_TYPE_ASCII enum nvtxMessageType_t
static int	NVTX_MESSAGE_TYPE_UNICODE enum nvtxMessageType_t
static int	NVTX_MESSAGE_UNKNOWN enum nvtxMessageType_t
static int	NVTX_NO_PUSH_POP_TRACKING
static int	NVTX_PAYLOAD_TYPE_DOUBLE enum nvtxPayloadType_t
static int	NVTX_PAYLOAD_TYPE_INT64 enum nvtxPayloadType_t
static int	NVTX_PAYLOAD_TYPE_UNSIGNED_INT64 enum nvtxPayloadType_t
static int	NVTX_PAYLOAD_UNKNOWN enum nvtxPayloadType_t
static int	NVTX_VERSION Tools Extension API version

Constructor Summary

Constructors

Constructor and Description
nvToolsExt()

Method Summary

Modifier and Type	Method and Description
static int	NVTX_EVENT_ATTRIB_STRUCT_SIZE() Size of the nvtxEventAttributes_t structure.
static void	nvtxMarkA(BytePointer message) \brief Marks an instantaneous event in the application.
static void	nvtxMarkA(String message)
static void	nvtxMarkEx(nvtxEventAttributes_t eventAttrib) \brief Marks an instantaneous event in the application.
static void	nvtxMarkW(CharPointer message)
static void	nvtxMarkW(IntPointer message)
static void	nvtxNameCategoryA(int category, BytePointer name) \{ \brief Annotate an NVTX category.
static void	nvtxNameCategoryA(int category, String name)
static void	nvtxNameCategoryW(int category, CharPointer name)
static void	nvtxNameCategoryW(int category, IntPointer name)
static void	nvtxNameCuContextA(CUctx_st context, BytePointer name) \brief Annotates a CUDA context.
static void	nvtxNameCuContextA(CUctx_st context, String name)
static void	nvtxNameCuContextW(CUctx_st context, CharPointer name)
static void	nvtxNameCuContextW(CUctx_st context, IntPointer name)
static void	nvtxNameCudaDeviceA(int device, BytePointer name) \brief Annotates a CUDA device.
static void	nvtxNameCudaDeviceA(int device, String name)
static void	nvtxNameCudaDeviceW(int device, CharPointer name)
static void	nvtxNameCudaDeviceW(int device, IntPointer name)
static void	nvtxNameCudaEventA(CUevent_st event, BytePointer name) \brief Annotates a CUDA event.
static void	nvtxNameCudaEventA(CUevent_st event, String name)
static void	nvtxNameCudaEventW(CUevent_st event, CharPointer name)
static void	nvtxNameCudaEventW(CUevent_st event, IntPointer name)
static void	nvtxNameCudaStreamA(CUstream_st stream, BytePointer name) \brief Annotates a CUDA stream.
static void	nvtxNameCudaStreamA(CUstream_st stream, String name)
static void	nvtxNameCudaStreamW(CUstream_st stream, CharPointer name)
static void	nvtxNameCudaStreamW(CUstream_st stream, IntPointer name)
static void	nvtxNameCuDeviceA(int device, BytePointer name) \brief Annotates a CUDA device.
static void	nvtxNameCuDeviceA(int device, String name)
static void	nvtxNameCuDeviceW(int device, CharPointer name)
static void	nvtxNameCuDeviceW(int device, IntPointer name)
static void	nvtxNameCuEventA(CUevent_st event, BytePointer name) \brief Annotates a CUDA event.
static void	nvtxNameCuEventA(CUevent_st event, String name)
static void	nvtxNameCuEventW(CUevent_st event, CharPointer name)
static void	nvtxNameCuEventW(CUevent_st event, IntPointer name)
static void	nvtxNameCuStreamA(CUstream_st stream, BytePointer name) \brief Annotates a CUDA stream.
static void	nvtxNameCuStreamA(CUstream_st stream, String name)
static void	nvtxNameCuStreamW(CUstream_st stream, CharPointer name)
static void	nvtxNameCuStreamW(CUstream_st stream, IntPointer name)
static void	nvtxNameOsThreadA(int threadId, BytePointer name) \{ \brief Annotate an OS thread.
static void	nvtxNameOsThreadA(int threadId, String name)
static void	nvtxNameOsThreadW(int threadId, CharPointer name)
static void	nvtxNameOsThreadW(int threadId, IntPointer name)
static void	nvtxRangeEnd(long id) \brief Marks the end of a range.
static int	nvtxRangePop() \brief Marks the end of a nested range
static int	nvtxRangePushA(BytePointer message) \brief Marks the start of a nested range
static int	nvtxRangePushA(String message)
static int	nvtxRangePushEx(nvtxEventAttributes_t eventAttrib) \brief Marks the start of a nested range
static int	nvtxRangePushW(CharPointer message)
static int	nvtxRangePushW(IntPointer message)
static long	nvtxRangeStartA(BytePointer message) \brief Marks the start of a range.
static long	nvtxRangeStartA(String message)
static long	nvtxRangeStartEx(nvtxEventAttributes_t eventAttrib) \brief Marks the start of a range.
static long	nvtxRangeStartW(CharPointer message)
static long	nvtxRangeStartW(IntPointer message)

Methods inherited from class org.bytedeco.cuda.presets.nvToolsExt

map

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NVTX_VERSION

public static final int NVTX_VERSION

Tools Extension API version

See Also:

Constant Field Values

NVTX_EVENT_ATTRIB_STRUCT_SIZE

public static final int NVTX_EVENT_ATTRIB_STRUCT_SIZE

NVTX_NO_PUSH_POP_TRACKING

public static final int NVTX_NO_PUSH_POP_TRACKING

See Also:

Constant Field Values

NVTX_COLOR_UNKNOWN

public static final int NVTX_COLOR_UNKNOWN

enum nvtxColorType_t

See Also:

Constant Field Values

NVTX_COLOR_ARGB

public static final int NVTX_COLOR_ARGB

enum nvtxColorType_t

See Also:

Constant Field Values

NVTX_PAYLOAD_UNKNOWN

public static final int NVTX_PAYLOAD_UNKNOWN

enum nvtxPayloadType_t

See Also:

Constant Field Values

NVTX_PAYLOAD_TYPE_UNSIGNED_INT64

public static final int NVTX_PAYLOAD_TYPE_UNSIGNED_INT64

enum nvtxPayloadType_t

See Also:

Constant Field Values

NVTX_PAYLOAD_TYPE_INT64

public static final int NVTX_PAYLOAD_TYPE_INT64

enum nvtxPayloadType_t

See Also:

Constant Field Values

NVTX_PAYLOAD_TYPE_DOUBLE

public static final int NVTX_PAYLOAD_TYPE_DOUBLE

enum nvtxPayloadType_t

See Also:

Constant Field Values

NVTX_MESSAGE_UNKNOWN

public static final int NVTX_MESSAGE_UNKNOWN

enum nvtxMessageType_t

See Also:

Constant Field Values

NVTX_MESSAGE_TYPE_ASCII

public static final int NVTX_MESSAGE_TYPE_ASCII

enum nvtxMessageType_t

See Also:

Constant Field Values

NVTX_MESSAGE_TYPE_UNICODE

public static final int NVTX_MESSAGE_TYPE_UNICODE

enum nvtxMessageType_t

See Also:

Constant Field Values

Constructor Detail

nvToolsExt

public nvToolsExt()

Method Detail

NVTX_EVENT_ATTRIB_STRUCT_SIZE

@MemberGetter
public static int NVTX_EVENT_ATTRIB_STRUCT_SIZE()

Size of the nvtxEventAttributes_t structure.

nvtxMarkEx

public static void nvtxMarkEx(@Const
                              nvtxEventAttributes_t eventAttrib)

\brief Marks an instantaneous event in the application. A marker can contain a text message or specify additional information using the event attributes structure. These attributes include a text message, color, category, and a payload. Each of the attributes is optional and can only be sent out using the \ref nvtxMarkEx function. If \ref nvtxMarkA or \ref nvtxMarkW are used to specify the the marker or if an attribute is unspecified then a default value will be used.

Parameters:

eventAttrib - - The event attribute structure defining the marker's attribute types and attribute values. \par Example:

 // zero the structure
 nvtxEventAttributes_t eventAttrib = {0};
 // set the version and the size information
 eventAttrib.version = NVTX_VERSION;
 eventAttrib.size = NVTX_EVENT_ATTRIB_STRUCT_SIZE;
 // configure the attributes.  0 is the default for all attributes.
 eventAttrib.colorType = NVTX_COLOR_ARGB;
 eventAttrib.color = 0xFF880000;
 eventAttrib.messageType = NVTX_MESSAGE_TYPE_ASCII;
 eventAttrib.message.ascii = "Example nvtxMarkEx";
 nvtxMarkEx(&eventAttrib);
 

nvtxMarkA

public static void nvtxMarkA(@Cast(value="const char*")
                             BytePointer message)

\brief Marks an instantaneous event in the application. A marker created using \ref nvtxMarkA or \ref nvtxMarkW contains only a text message.

Parameters:

message - - The message associated to this marker event. \par Example:

 nvtxMarkA("Example nvtxMarkA");
 nvtxMarkW(L"Example nvtxMarkW");
 

nvtxMarkA

public static void nvtxMarkA(String message)

nvtxMarkW

public static void nvtxMarkW(@Cast(value="const wchar_t*")
                             CharPointer message)

nvtxMarkW

public static void nvtxMarkW(@Cast(value="const wchar_t*")
                             IntPointer message)

nvtxRangeStartEx

@Cast(value="nvtxRangeId_t")
public static long nvtxRangeStartEx(@Const
                                                                  nvtxEventAttributes_t eventAttrib)

\brief Marks the start of a range.

Parameters:

eventAttrib - - The event attribute structure defining the range's attribute types and attribute values.

Returns:

The unique ID used to correlate a pair of Start and End events. \remarks Ranges defined by Start/End can overlap. \par Example:

 nvtxEventAttributes_t eventAttrib = {0};
 eventAttrib.version = NVTX_VERSION;
 eventAttrib.size = NVTX_EVENT_ATTRIB_STRUCT_SIZE;
 eventAttrib.category = 3;
 eventAttrib.colorType = NVTX_COLOR_ARGB;
 eventAttrib.color = 0xFF0088FF;
 eventAttrib.messageType = NVTX_MESSAGE_TYPE_ASCII;
 eventAttrib.message.ascii = "Example RangeStartEnd";
 nvtxRangeId_t rangeId = nvtxRangeStartEx(&eventAttrib);
 // ...
 nvtxRangeEnd(rangeId);
 

See Also:

::nvtxRangeEnd

nvtxRangeStartA

@Cast(value="nvtxRangeId_t")
public static long nvtxRangeStartA(@Cast(value="const char*")
                                                                 BytePointer message)

\brief Marks the start of a range.

Parameters:

message - - The event message associated to this range event.

Returns:

The unique ID used to correlate a pair of Start and End events. \remarks Ranges defined by Start/End can overlap. \par Example:

 nvtxRangeId_t r1 = nvtxRangeStartA("Range 1");
 nvtxRangeId_t r2 = nvtxRangeStartW(L"Range 2");
 nvtxRangeEnd(r1);
 nvtxRangeEnd(r2);
 

See Also:

::nvtxRangeEnd

nvtxRangeStartA

@Cast(value="nvtxRangeId_t")
public static long nvtxRangeStartA(String message)

nvtxRangeStartW

@Cast(value="nvtxRangeId_t")
public static long nvtxRangeStartW(@Cast(value="const wchar_t*")
                                                                 CharPointer message)

nvtxRangeStartW

@Cast(value="nvtxRangeId_t")
public static long nvtxRangeStartW(@Cast(value="const wchar_t*")
                                                                 IntPointer message)

nvtxRangeEnd

public static void nvtxRangeEnd(@Cast(value="nvtxRangeId_t")
                                long id)

\brief Marks the end of a range.

Parameters:

id - - The correlation ID returned from a nvtxRangeStart call.

See Also:

::nvtxRangeStartA ::nvtxRangeStartW

nvtxRangePushEx

public static int nvtxRangePushEx(@Const
                                  nvtxEventAttributes_t eventAttrib)

\brief Marks the start of a nested range

Parameters:

eventAttrib - - The event attribute structure defining the range's attribute types and attribute values.

Returns:

The 0 based level of range being started. If an error occurs a negative value is returned. \par Example:

 nvtxEventAttributes_t eventAttrib = {0};
 eventAttrib.version = NVTX_VERSION;
 eventAttrib.size = NVTX_EVENT_ATTRIB_STRUCT_SIZE;
 eventAttrib.colorType = NVTX_COLOR_ARGB;
 eventAttrib.color = 0xFFFF0000;
 eventAttrib.messageType = NVTX_MESSAGE_TYPE_ASCII;
 eventAttrib.message.ascii = "Level 0";
 nvtxRangePushEx(&eventAttrib);

 // Re-use eventAttrib
 eventAttrib.messageType = NVTX_MESSAGE_TYPE_UNICODE;
 eventAttrib.message.unicode = L"Level 1";
 nvtxRangePushEx(&eventAttrib);

 nvtxRangePop();
 nvtxRangePop();
 

See Also:

::nvtxRangePop

nvtxRangePushA

public static int nvtxRangePushA(@Cast(value="const char*")
                                 BytePointer message)

\brief Marks the start of a nested range

Parameters:

message - - The event message associated to this range event.

Returns:

The 0 based level of range being started. If an error occurs a negative value is returned. \par Example:

 nvtxRangePushA("Level 0");
 nvtxRangePushW(L"Level 1");
 nvtxRangePop();
 nvtxRangePop();
 

See Also:

::nvtxRangePop

nvtxRangePushA

public static int nvtxRangePushA(String message)

nvtxRangePushW

public static int nvtxRangePushW(@Cast(value="const wchar_t*")
                                 CharPointer message)

nvtxRangePushW

public static int nvtxRangePushW(@Cast(value="const wchar_t*")
                                 IntPointer message)

nvtxRangePop

public static int nvtxRangePop()

\brief Marks the end of a nested range

Returns:

The level of the range being ended. If an error occurs a negative value is returned on the current thread.

See Also:

::nvtxRangePushA ::nvtxRangePushW

nvtxNameCategoryA

public static void nvtxNameCategoryA(@Cast(value="uint32_t")
                                     int category,
                                     @Cast(value="const char*")
                                     BytePointer name)

\{ \brief Annotate an NVTX category. Categories are used to group sets of events. Each category is identified through a unique ID and that ID is passed into any of the marker/range events to assign that event to a specific category. The nvtxNameCategory function calls allow the user to assign a name to a category ID.

Parameters:

category - - The category ID to name.

name - - The name of the category. \remarks The category names are tracked per process. \par Example:

 nvtxNameCategory(1, "Memory Allocation");
 nvtxNameCategory(2, "Memory Transfer");
 nvtxNameCategory(3, "Memory Object Lifetime");
 

nvtxNameCategoryA

public static void nvtxNameCategoryA(@Cast(value="uint32_t")
                                     int category,
                                     String name)

nvtxNameCategoryW

public static void nvtxNameCategoryW(@Cast(value="uint32_t")
                                     int category,
                                     @Cast(value="const wchar_t*")
                                     CharPointer name)

nvtxNameCategoryW

public static void nvtxNameCategoryW(@Cast(value="uint32_t")
                                     int category,
                                     @Cast(value="const wchar_t*")
                                     IntPointer name)

nvtxNameOsThreadA

public static void nvtxNameOsThreadA(@Cast(value="uint32_t")
                                     int threadId,
                                     @Cast(value="const char*")
                                     BytePointer name)

\{ \brief Annotate an OS thread. Allows the user to name an active thread of the current process. If an invalid thread ID is provided or a thread ID from a different process is used the behavior of the tool is implementation dependent.

Parameters:

threadId - - The ID of the thread to name.

name - - The name of the thread. \par Example:

 nvtxNameOsThread(GetCurrentThreadId(), "MAIN_THREAD");
 

nvtxNameOsThreadA

public static void nvtxNameOsThreadA(@Cast(value="uint32_t")
                                     int threadId,
                                     String name)

nvtxNameOsThreadW

public static void nvtxNameOsThreadW(@Cast(value="uint32_t")
                                     int threadId,
                                     @Cast(value="const wchar_t*")
                                     CharPointer name)

nvtxNameOsThreadW

public static void nvtxNameOsThreadW(@Cast(value="uint32_t")
                                     int threadId,
                                     @Cast(value="const wchar_t*")
                                     IntPointer name)

nvtxNameCuDeviceA

public static void nvtxNameCuDeviceA(@Cast(value="CUdevice")
                                     int device,
                                     @Cast(value="const char*")
                                     BytePointer name)

\brief Annotates a CUDA device. Allows the user to associate a CUDA device with a user-provided name.

Parameters:

device - - The handle of the CUDA device to name.

name - - The name of the CUDA device.

nvtxNameCuDeviceA

public static void nvtxNameCuDeviceA(@Cast(value="CUdevice")
                                     int device,
                                     String name)

nvtxNameCuDeviceW

public static void nvtxNameCuDeviceW(@Cast(value="CUdevice")
                                     int device,
                                     @Cast(value="const wchar_t*")
                                     CharPointer name)

nvtxNameCuDeviceW

public static void nvtxNameCuDeviceW(@Cast(value="CUdevice")
                                     int device,
                                     @Cast(value="const wchar_t*")
                                     IntPointer name)

nvtxNameCuContextA

public static void nvtxNameCuContextA(CUctx_st context,
                                      @Cast(value="const char*")
                                      BytePointer name)

\brief Annotates a CUDA context. Allows the user to associate a CUDA context with a user-provided name.

Parameters:

context - - The handle of the CUDA context to name.

name - - The name of the CUDA context. \par Example:

 CUresult status = cuCtxCreate( &cuContext, 0, cuDevice );
 if ( CUDA_SUCCESS != status )
     goto Error;
 nvtxNameCuContext(cuContext, "CTX_NAME");
 

nvtxNameCuContextA

public static void nvtxNameCuContextA(CUctx_st context,
                                      String name)

nvtxNameCuContextW

public static void nvtxNameCuContextW(CUctx_st context,
                                      @Cast(value="const wchar_t*")
                                      CharPointer name)

nvtxNameCuContextW

public static void nvtxNameCuContextW(CUctx_st context,
                                      @Cast(value="const wchar_t*")
                                      IntPointer name)

nvtxNameCuStreamA

public static void nvtxNameCuStreamA(CUstream_st stream,
                                     @Cast(value="const char*")
                                     BytePointer name)

\brief Annotates a CUDA stream. Allows the user to associate a CUDA stream with a user-provided name.

Parameters:

stream - - The handle of the CUDA stream to name.

name - - The name of the CUDA stream.

nvtxNameCuStreamA

public static void nvtxNameCuStreamA(CUstream_st stream,
                                     String name)

nvtxNameCuStreamW

public static void nvtxNameCuStreamW(CUstream_st stream,
                                     @Cast(value="const wchar_t*")
                                     CharPointer name)

nvtxNameCuStreamW

public static void nvtxNameCuStreamW(CUstream_st stream,
                                     @Cast(value="const wchar_t*")
                                     IntPointer name)

nvtxNameCuEventA

public static void nvtxNameCuEventA(CUevent_st event,
                                    @Cast(value="const char*")
                                    BytePointer name)

\brief Annotates a CUDA event. Allows the user to associate a CUDA event with a user-provided name.

Parameters:

event - - The handle of the CUDA event to name.

name - - The name of the CUDA event.

nvtxNameCuEventA

public static void nvtxNameCuEventA(CUevent_st event,
                                    String name)

nvtxNameCuEventW

public static void nvtxNameCuEventW(CUevent_st event,
                                    @Cast(value="const wchar_t*")
                                    CharPointer name)

nvtxNameCuEventW

public static void nvtxNameCuEventW(CUevent_st event,
                                    @Cast(value="const wchar_t*")
                                    IntPointer name)

nvtxNameCudaDeviceA

public static void nvtxNameCudaDeviceA(int device,
                                       @Cast(value="const char*")
                                       BytePointer name)

\brief Annotates a CUDA device. Allows the user to associate a CUDA device with a user-provided name.

Parameters:

device - - The id of the CUDA device to name.

name - - The name of the CUDA device.

nvtxNameCudaDeviceA

public static void nvtxNameCudaDeviceA(int device,
                                       String name)

nvtxNameCudaDeviceW

public static void nvtxNameCudaDeviceW(int device,
                                       @Cast(value="const wchar_t*")
                                       CharPointer name)

nvtxNameCudaDeviceW

public static void nvtxNameCudaDeviceW(int device,
                                       @Cast(value="const wchar_t*")
                                       IntPointer name)

nvtxNameCudaStreamA

public static void nvtxNameCudaStreamA(CUstream_st stream,
                                       @Cast(value="const char*")
                                       BytePointer name)

\brief Annotates a CUDA stream. Allows the user to associate a CUDA stream with a user-provided name.

Parameters:

stream - - The handle of the CUDA stream to name.

name - - The name of the CUDA stream.

nvtxNameCudaStreamA

public static void nvtxNameCudaStreamA(CUstream_st stream,
                                       String name)

nvtxNameCudaStreamW

public static void nvtxNameCudaStreamW(CUstream_st stream,
                                       @Cast(value="const wchar_t*")
                                       CharPointer name)

nvtxNameCudaStreamW

public static void nvtxNameCudaStreamW(CUstream_st stream,
                                       @Cast(value="const wchar_t*")
                                       IntPointer name)

nvtxNameCudaEventA

public static void nvtxNameCudaEventA(CUevent_st event,
                                      @Cast(value="const char*")
                                      BytePointer name)

\brief Annotates a CUDA event. Allows the user to associate a CUDA event with a user-provided name.

Parameters:

event - - The handle of the CUDA event to name.

name - - The name of the CUDA event.

nvtxNameCudaEventA

public static void nvtxNameCudaEventA(CUevent_st event,
                                      String name)

nvtxNameCudaEventW

public static void nvtxNameCudaEventW(CUevent_st event,
                                      @Cast(value="const wchar_t*")
                                      CharPointer name)

nvtxNameCudaEventW

public static void nvtxNameCudaEventW(CUevent_st event,
                                      @Cast(value="const wchar_t*")
                                      IntPointer name)