Communicator Configuration

Communicator Configuration#

Rocprofiler SDK Developer API: Communicator Configuration

Rocprofiler SDK Developer API 0.5.0

ROCm Profiling API and tools

Data Structures
struct	ncclConfig_t
	Communicator configuration. More...

Macros
#define	NCCL_CONFIG_INITIALIZER

Detailed Description

Structure that allows for customizing Communicator behavior via ncclCommInitRankConfig

Data Structure Documentation

◆ ncclConfig_t

struct ncclConfig_t

Communicator configuration.

Users can assign value to attributes to specify the behavior of a communicator

Definition at line 80 of file rccl.h.

Collaboration diagram for ncclConfig_t:

Data Fields
int	blocking	Whether or not calls should block or not
int	cgaClusterSize	Cooperative group array cluster size
unsigned int	magic	Should not be touched
int	maxCTAs	Maximum number of cooperative thread arrays (blocks)
int	minCTAs	Minimum number of cooperative thread arrays (blocks)
const char *	netName	Force NCCL to use a specfic network
unsigned long	size	Should not be touched
int	splitShare	Allow communicators to share resources
unsigned int	version	Should not be touched

Macro Definition Documentation

◆ NCCL_CONFIG_INITIALIZER

#define NCCL_CONFIG_INITIALIZER

Value:

    {                                                                                              \
        sizeof(ncclConfig_t),                                 /* size */                           \
            0xcafebeef,                                       /* magic */                          \
            NCCL_VERSION(NCCL_MAJOR, NCCL_MINOR, NCCL_PATCH), /* version */                        \
            NCCL_CONFIG_UNDEF_INT,                            /* blocking */                       \
            NCCL_CONFIG_UNDEF_INT,                            /* cgaClusterSize */                 \
            NCCL_CONFIG_UNDEF_INT,                            /* minCTAs */                        \
            NCCL_CONFIG_UNDEF_INT,                            /* maxCTAs */                        \
            NCCL_CONFIG_UNDEF_PTR,                            /* netName */                        \
            NCCL_CONFIG_UNDEF_INT                             /* splitShare */                     \
    }

Definition at line 97 of file rccl.h.

    {                                                                                              \
        sizeof(ncclConfig_t),                                 /* size */                           \
            0xcafebeef,                                       /* magic */                          \
            NCCL_VERSION(NCCL_MAJOR, NCCL_MINOR, NCCL_PATCH), /* version */                        \
            NCCL_CONFIG_UNDEF_INT,                            /* blocking */                       \
            NCCL_CONFIG_UNDEF_INT,                            /* cgaClusterSize */                 \
            NCCL_CONFIG_UNDEF_INT,                            /* minCTAs */                        \
            NCCL_CONFIG_UNDEF_INT,                            /* maxCTAs */                        \
            NCCL_CONFIG_UNDEF_PTR,                            /* netName */                        \
            NCCL_CONFIG_UNDEF_INT                             /* splitShare */                     \
    }