rocprofiler-sdk/rccl/api_args.h File Reference

rocprofiler-sdk/rccl/api_args.h File Reference#

Rocprofiler SDK Developer API: rocprofiler-sdk/rccl/api_args.h File Reference
Rocprofiler SDK Developer API 0.5.0
ROCm Profiling API and tools
api_args.h File Reference
+ Include dependency graph for api_args.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  rocprofiler_rccl_api_no_args
 
union  rocprofiler_rccl_api_retval_t
 
union  rocprofiler_rccl_api_args_t
 
struct  rocprofiler_rccl_api_args_t.ncclAllGather
 
struct  rocprofiler_rccl_api_args_t.ncclAllReduce
 
struct  rocprofiler_rccl_api_args_t.ncclAllToAll
 
struct  rocprofiler_rccl_api_args_t.ncclAllToAllv
 
struct  rocprofiler_rccl_api_args_t.ncclBroadcast
 
struct  rocprofiler_rccl_api_args_t.ncclGather
 
struct  rocprofiler_rccl_api_args_t.ncclReduce
 
struct  rocprofiler_rccl_api_args_t.ncclReduceScatter
 
struct  rocprofiler_rccl_api_args_t.ncclScatter
 
struct  rocprofiler_rccl_api_args_t.ncclSend
 
struct  rocprofiler_rccl_api_args_t.ncclRecv
 
struct  rocprofiler_rccl_api_args_t.ncclRedOpCreatePreMulSum
 
struct  rocprofiler_rccl_api_args_t.ncclRedOpDestroy
 
struct  rocprofiler_rccl_api_args_t.ncclGroupStart
 
struct  rocprofiler_rccl_api_args_t.ncclGroupEnd
 
struct  rocprofiler_rccl_api_args_t.ncclGetVersion
 
struct  rocprofiler_rccl_api_args_t.ncclGetUniqueId
 
struct  rocprofiler_rccl_api_args_t.ncclCommInitRank
 
struct  rocprofiler_rccl_api_args_t.ncclCommInitAll
 
struct  rocprofiler_rccl_api_args_t.ncclCommInitRankConfig
 
struct  rocprofiler_rccl_api_args_t.ncclCommFinalize
 
struct  rocprofiler_rccl_api_args_t.ncclCommDestroy
 
struct  rocprofiler_rccl_api_args_t.ncclCommAbort
 
struct  rocprofiler_rccl_api_args_t.ncclCommSplit
 
struct  rocprofiler_rccl_api_args_t.ncclGetErrorString
 
struct  rocprofiler_rccl_api_args_t.ncclGetLastError
 
struct  rocprofiler_rccl_api_args_t.ncclCommGetAsyncError
 
struct  rocprofiler_rccl_api_args_t.ncclCommCount
 
struct  rocprofiler_rccl_api_args_t.ncclCommCuDevice
 
struct  rocprofiler_rccl_api_args_t.ncclCommUserRank
 
struct  rocprofiler_rccl_api_args_t.ncclMemAlloc
 
struct  rocprofiler_rccl_api_args_t.ncclMemFree
 
struct  rocprofiler_rccl_api_args_t.mscclLoadAlgo
 
struct  rocprofiler_rccl_api_args_t.mscclRunAlgo
 
struct  rocprofiler_rccl_api_args_t.mscclUnloadAlgo
 
struct  rocprofiler_rccl_api_args_t.ncclCommRegister
 
struct  rocprofiler_rccl_api_args_t.ncclCommDeregister
 

Macros

#define ROCPROFILER_SDK_USE_SYSTEM_RCCL   0
 

Data Structure Documentation

◆ rocprofiler_rccl_api_no_args

struct rocprofiler_rccl_api_no_args

Definition at line 53 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_no_args:
Data Fields
char empty

◆ rocprofiler_rccl_api_retval_t

union rocprofiler_rccl_api_retval_t

Definition at line 58 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_retval_t:
Data Fields
const char * const_charp_retval
int32_t ncclResult_t_retval

◆ rocprofiler_rccl_api_args_t

union rocprofiler_rccl_api_args_t

Definition at line 64 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t:
Data Fields
struct rocprofiler_rccl_api_args_t.mscclLoadAlgo mscclLoadAlgo
struct rocprofiler_rccl_api_args_t.mscclRunAlgo mscclRunAlgo
struct rocprofiler_rccl_api_args_t.mscclUnloadAlgo mscclUnloadAlgo
struct rocprofiler_rccl_api_args_t.ncclAllGather ncclAllGather
struct rocprofiler_rccl_api_args_t.ncclAllReduce ncclAllReduce
struct rocprofiler_rccl_api_args_t.ncclAllToAll ncclAllToAll
struct rocprofiler_rccl_api_args_t.ncclAllToAllv ncclAllToAllv
struct rocprofiler_rccl_api_args_t.ncclBroadcast ncclBroadcast
struct rocprofiler_rccl_api_args_t.ncclCommAbort ncclCommAbort
struct rocprofiler_rccl_api_args_t.ncclCommCount ncclCommCount
struct rocprofiler_rccl_api_args_t.ncclCommCuDevice ncclCommCuDevice
struct rocprofiler_rccl_api_args_t.ncclCommDeregister ncclCommDeregister
struct rocprofiler_rccl_api_args_t.ncclCommDestroy ncclCommDestroy
struct rocprofiler_rccl_api_args_t.ncclCommFinalize ncclCommFinalize
struct rocprofiler_rccl_api_args_t.ncclCommGetAsyncError ncclCommGetAsyncError
struct rocprofiler_rccl_api_args_t.ncclCommInitAll ncclCommInitAll
struct rocprofiler_rccl_api_args_t.ncclCommInitRank ncclCommInitRank
struct rocprofiler_rccl_api_args_t.ncclCommInitRankConfig ncclCommInitRankConfig
struct rocprofiler_rccl_api_args_t.ncclCommRegister ncclCommRegister
struct rocprofiler_rccl_api_args_t.ncclCommSplit ncclCommSplit
struct rocprofiler_rccl_api_args_t.ncclCommUserRank ncclCommUserRank
struct rocprofiler_rccl_api_args_t.ncclGather ncclGather
struct rocprofiler_rccl_api_args_t.ncclGetErrorString ncclGetErrorString
struct rocprofiler_rccl_api_args_t.ncclGetLastError ncclGetLastError
struct rocprofiler_rccl_api_args_t.ncclGetUniqueId ncclGetUniqueId
struct rocprofiler_rccl_api_args_t.ncclGetVersion ncclGetVersion
struct rocprofiler_rccl_api_args_t.ncclGroupEnd ncclGroupEnd
struct rocprofiler_rccl_api_args_t.ncclGroupStart ncclGroupStart
struct rocprofiler_rccl_api_args_t.ncclMemAlloc ncclMemAlloc
struct rocprofiler_rccl_api_args_t.ncclMemFree ncclMemFree
struct rocprofiler_rccl_api_args_t.ncclRecv ncclRecv
struct rocprofiler_rccl_api_args_t.ncclRedOpCreatePreMulSum ncclRedOpCreatePreMulSum
struct rocprofiler_rccl_api_args_t.ncclRedOpDestroy ncclRedOpDestroy
struct rocprofiler_rccl_api_args_t.ncclReduce ncclReduce
struct rocprofiler_rccl_api_args_t.ncclReduceScatter ncclReduceScatter
struct rocprofiler_rccl_api_args_t.ncclScatter ncclScatter
struct rocprofiler_rccl_api_args_t.ncclSend ncclSend

◆ rocprofiler_rccl_api_args_t.ncclAllGather

struct rocprofiler_rccl_api_args_t.ncclAllGather

Definition at line 66 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclAllGather:
Data Fields
ncclComm_t comm
ncclDataType_t datatype
void * recvbuff
const void * sendbuff
unsigned long sendcount
hipStream_t stream

◆ rocprofiler_rccl_api_args_t.ncclAllReduce

struct rocprofiler_rccl_api_args_t.ncclAllReduce

Definition at line 75 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclAllReduce:
Data Fields
struct ncclComm * comm
unsigned long count
ncclDataType_t datatype
ncclRedOp_t op
void * recvbuff
const void * sendbuff
hipStream_t stream

◆ rocprofiler_rccl_api_args_t.ncclAllToAll

struct rocprofiler_rccl_api_args_t.ncclAllToAll

Definition at line 85 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclAllToAll:
Data Fields
ncclComm_t comm
unsigned long count
ncclDataType_t datatype
void * recvbuff
const void * sendbuff
hipStream_t stream

◆ rocprofiler_rccl_api_args_t.ncclAllToAllv

struct rocprofiler_rccl_api_args_t.ncclAllToAllv

Definition at line 94 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclAllToAllv:
Data Fields
ncclComm_t comm
ncclDataType_t datatype
const unsigned long * rdispls
void * recvbuff
const unsigned long * recvcounts
const unsigned long * sdispls
const void * sendbuff
const unsigned long * sendcounts
hipStream_t stream

◆ rocprofiler_rccl_api_args_t.ncclBroadcast

struct rocprofiler_rccl_api_args_t.ncclBroadcast

Definition at line 106 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclBroadcast:
Data Fields
ncclComm_t comm
unsigned long count
ncclDataType_t datatype
void * recvbuff
int root
const void * sendbuff
hipStream_t stream

◆ rocprofiler_rccl_api_args_t.ncclGather

struct rocprofiler_rccl_api_args_t.ncclGather

Definition at line 116 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclGather:
Data Fields
ncclComm_t comm
ncclDataType_t datatype
void * recvbuff
int root
const void * sendbuff
unsigned long sendcount
hipStream_t stream

◆ rocprofiler_rccl_api_args_t.ncclReduce

struct rocprofiler_rccl_api_args_t.ncclReduce

Definition at line 126 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclReduce:
Data Fields
ncclComm_t comm
unsigned long count
ncclDataType_t datatype
ncclRedOp_t op
void * recvbuff
int root
const void * sendbuff
hipStream_t stream

◆ rocprofiler_rccl_api_args_t.ncclReduceScatter

struct rocprofiler_rccl_api_args_t.ncclReduceScatter

Definition at line 137 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclReduceScatter:
Data Fields
struct ncclComm * comm
ncclDataType_t datatype
ncclRedOp_t op
void * recvbuff
unsigned long recvcount
const void * sendbuff
hipStream_t stream

◆ rocprofiler_rccl_api_args_t.ncclScatter

struct rocprofiler_rccl_api_args_t.ncclScatter

Definition at line 147 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclScatter:
Data Fields
ncclComm_t comm
ncclDataType_t datatype
void * recvbuff
unsigned long recvcount
int root
const void * sendbuff
hipStream_t stream

◆ rocprofiler_rccl_api_args_t.ncclSend

struct rocprofiler_rccl_api_args_t.ncclSend

Definition at line 157 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclSend:
Data Fields
ncclComm_t comm
unsigned long count
ncclDataType_t datatype
int peer
const void * sendbuff
hipStream_t stream

◆ rocprofiler_rccl_api_args_t.ncclRecv

struct rocprofiler_rccl_api_args_t.ncclRecv

Definition at line 166 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclRecv:
Data Fields
ncclComm_t comm
unsigned long count
ncclDataType_t datatype
int peer
void * recvbuff
hipStream_t stream

◆ rocprofiler_rccl_api_args_t.ncclRedOpCreatePreMulSum

struct rocprofiler_rccl_api_args_t.ncclRedOpCreatePreMulSum

Definition at line 175 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclRedOpCreatePreMulSum:
Data Fields
ncclComm_t comm
ncclDataType_t datatype
ncclRedOp_t * op
ncclScalarResidence_t residence
void * scalar

◆ rocprofiler_rccl_api_args_t.ncclRedOpDestroy

struct rocprofiler_rccl_api_args_t.ncclRedOpDestroy

Definition at line 183 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclRedOpDestroy:
Data Fields
ncclComm_t comm
ncclRedOp_t op

◆ rocprofiler_rccl_api_args_t.ncclGroupStart

struct rocprofiler_rccl_api_args_t.ncclGroupStart

Definition at line 188 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclGroupStart:
Data Fields
rocprofiler_rccl_api_no_args no_args

◆ rocprofiler_rccl_api_args_t.ncclGroupEnd

struct rocprofiler_rccl_api_args_t.ncclGroupEnd

Definition at line 192 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclGroupEnd:
Data Fields
rocprofiler_rccl_api_no_args no_args

◆ rocprofiler_rccl_api_args_t.ncclGetVersion

struct rocprofiler_rccl_api_args_t.ncclGetVersion

Definition at line 196 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclGetVersion:
Data Fields
int * version

◆ rocprofiler_rccl_api_args_t.ncclGetUniqueId

struct rocprofiler_rccl_api_args_t.ncclGetUniqueId

Definition at line 200 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclGetUniqueId:
Data Fields
ncclUniqueId * out

◆ rocprofiler_rccl_api_args_t.ncclCommInitRank

struct rocprofiler_rccl_api_args_t.ncclCommInitRank

Definition at line 204 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclCommInitRank:
Data Fields
ncclUniqueId commId
int myrank
ncclComm_t * newcomm
int nranks

◆ rocprofiler_rccl_api_args_t.ncclCommInitAll

struct rocprofiler_rccl_api_args_t.ncclCommInitAll

Definition at line 211 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclCommInitAll:
Data Fields
ncclComm_t * comms
const int * devlist
int ndev

◆ rocprofiler_rccl_api_args_t.ncclCommInitRankConfig

struct rocprofiler_rccl_api_args_t.ncclCommInitRankConfig

Definition at line 217 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclCommInitRankConfig:
Data Fields
ncclComm_t * comm
ncclUniqueId commId
ncclConfig_t * config
int myrank
int nranks

◆ rocprofiler_rccl_api_args_t.ncclCommFinalize

struct rocprofiler_rccl_api_args_t.ncclCommFinalize

Definition at line 225 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclCommFinalize:
Data Fields
ncclComm_t comm

◆ rocprofiler_rccl_api_args_t.ncclCommDestroy

struct rocprofiler_rccl_api_args_t.ncclCommDestroy

Definition at line 229 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclCommDestroy:
Data Fields
ncclComm_t comm

◆ rocprofiler_rccl_api_args_t.ncclCommAbort

struct rocprofiler_rccl_api_args_t.ncclCommAbort

Definition at line 233 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclCommAbort:
Data Fields
ncclComm_t comm

◆ rocprofiler_rccl_api_args_t.ncclCommSplit

struct rocprofiler_rccl_api_args_t.ncclCommSplit

Definition at line 237 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclCommSplit:
Data Fields
int color
ncclComm_t comm
ncclConfig_t * config
int key
ncclComm_t * newcomm

◆ rocprofiler_rccl_api_args_t.ncclGetErrorString

struct rocprofiler_rccl_api_args_t.ncclGetErrorString

Definition at line 245 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclGetErrorString:
Data Fields
ncclResult_t code

◆ rocprofiler_rccl_api_args_t.ncclGetLastError

struct rocprofiler_rccl_api_args_t.ncclGetLastError

Definition at line 249 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclGetLastError:
Data Fields
ncclComm_t comm

◆ rocprofiler_rccl_api_args_t.ncclCommGetAsyncError

struct rocprofiler_rccl_api_args_t.ncclCommGetAsyncError

Definition at line 253 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclCommGetAsyncError:
Data Fields
ncclResult_t * asyncError
ncclComm_t comm

◆ rocprofiler_rccl_api_args_t.ncclCommCount

struct rocprofiler_rccl_api_args_t.ncclCommCount

Definition at line 258 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclCommCount:
Data Fields
ncclComm_t comm
int * count

◆ rocprofiler_rccl_api_args_t.ncclCommCuDevice

struct rocprofiler_rccl_api_args_t.ncclCommCuDevice

Definition at line 263 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclCommCuDevice:
Data Fields
ncclComm_t comm
int * devid

◆ rocprofiler_rccl_api_args_t.ncclCommUserRank

struct rocprofiler_rccl_api_args_t.ncclCommUserRank

Definition at line 268 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclCommUserRank:
Data Fields
ncclComm_t comm
int * rank

◆ rocprofiler_rccl_api_args_t.ncclMemAlloc

struct rocprofiler_rccl_api_args_t.ncclMemAlloc

Definition at line 273 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclMemAlloc:
Data Fields
void ** ptr
unsigned long size

◆ rocprofiler_rccl_api_args_t.ncclMemFree

struct rocprofiler_rccl_api_args_t.ncclMemFree

Definition at line 278 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclMemFree:
Data Fields
void * ptr

◆ rocprofiler_rccl_api_args_t.mscclLoadAlgo

struct rocprofiler_rccl_api_args_t.mscclLoadAlgo

Definition at line 282 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.mscclLoadAlgo:
Data Fields
const char * mscclAlgoFilePath
mscclAlgoHandle_t * mscclAlgoHandle
int rank

◆ rocprofiler_rccl_api_args_t.mscclRunAlgo

struct rocprofiler_rccl_api_args_t.mscclRunAlgo

Definition at line 288 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.mscclRunAlgo:
Data Fields
ncclComm_t comm
unsigned long count
ncclDataType_t dataType
mscclAlgoHandle_t mscclAlgoHandle
ncclRedOp_t op
int peer
const unsigned long * rDisPls
void * recvBuff
const unsigned long * recvCounts
int root
const unsigned long * sDisPls
const void * sendBuff
const unsigned long * sendCounts
hipStream_t stream

◆ rocprofiler_rccl_api_args_t.mscclUnloadAlgo

struct rocprofiler_rccl_api_args_t.mscclUnloadAlgo

Definition at line 305 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.mscclUnloadAlgo:
Data Fields
mscclAlgoHandle_t mscclAlgoHandle

◆ rocprofiler_rccl_api_args_t.ncclCommRegister

struct rocprofiler_rccl_api_args_t.ncclCommRegister

Definition at line 309 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclCommRegister:
Data Fields
void * buff
ncclComm_t comm
void ** handle
unsigned long size

◆ rocprofiler_rccl_api_args_t.ncclCommDeregister

struct rocprofiler_rccl_api_args_t.ncclCommDeregister

Definition at line 316 of file api_args.h.

+ Collaboration diagram for rocprofiler_rccl_api_args_t.ncclCommDeregister:
Data Fields
ncclComm_t comm
void * handle

Macro Definition Documentation

◆ ROCPROFILER_SDK_USE_SYSTEM_RCCL

#define ROCPROFILER_SDK_USE_SYSTEM_RCCL   0

Definition at line 36 of file api_args.h.