sudo apt-get install doxygen
+ sudo apt-get install doxygen graphviz
` doc for those who want to understand the internals of MSCCL++.
+- :doc:`NCCL over MSCCL++ ` doc for those who want to understand how to use NCCL over MSCCL++.
.. toctree::
:maxdepth: 1
@@ -31,6 +32,7 @@ Design
:hidden:
design/design
+ design/nccl-over-mscclpp
Performance
---------------
diff --git a/api/index.html b/api/index.html
index 73a2a847..295411c5 100644
--- a/api/index.html
+++ b/api/index.html
@@ -51,6 +51,7 @@
Design
Performance
diff --git a/design/design.html b/design/design.html
index 7a550c7e..505708d3 100644
--- a/design/design.html
+++ b/design/design.html
@@ -21,7 +21,7 @@
+NCCL Over MSCCL++ Performance
@@ -279,7 +280,7 @@ Implementing customized collective communication algorithmsNext
+ Next
diff --git a/design/nccl-over-mscclpp.html b/design/nccl-over-mscclpp.html
new file mode 100644
index 00000000..904f2045
--- /dev/null
+++ b/design/nccl-over-mscclpp.html
@@ -0,0 +1,264 @@
+
+
+
+
+
+
+
NCCL Over MSCCL++ — mscclpp v0.5.2 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ mscclpp
+
+
+
+
+
+
+
+
+
+NCCL Over MSCCL++
+
+Limitations
+Current NCCL over MSCCL++ has a few limitations.
+
+We do not cover all APIs yet. See the API Support Table for details.
Multi-node communication is not supported yet.
Currently, collective communication functions may not work correctly if the buffer address is differed from that of previous function calls while sharing the same base address (returned by cuMemGetAddressRange ) with the previous address. This is because the current implementation performs zero-copy communication over user buffers, and it is difficult to efficiently inform all ranks if the buffer address dynamically changes.
+
+
+API Support Table
+The table below lists all NCCL APIs (v2.21). We may cover more APIs in the future.
+
+
+API Name
Supported
+
+ncclGetLastError
X
ncclGetErrorString
O
ncclGetVersion
O
ncclGetUniqueId
O
ncclCommInitRank
O
ncclCommInitAll
X
ncclCommInitRankConfig
X
ncclCommSplit
X
ncclCommFinalize
O
ncclCommDestroy
O
ncclCommAbort
X
ncclCommGetAsyncError
O
ncclCommCount
O
ncclCommCuDevice
O
ncclCommUserRank
O
ncclCommRegister
X
ncclCommDeregister
X
ncclMemAlloc
X
ncclMemFree
X
ncclAllReduce
O
ncclBroadcast
X
ncclReduce
X
ncclAllGather
O
ncclReduceScatter
X
ncclGroupStart
O
ncclGroupEnd
O
ncclSend
X
ncclRecv
X
ncclRedOpCreatePreMulSum
X
ncclRedOpDestroy
X
+
+
+
+Executor Support
+The executor is a versatile tool designed to specify how mscclpp executes algorithms. Currently, only the allReduce operation allows for algorithm customization. The following environment variables can be managed:
+
+ALLREDUCEPKT_IP_JSON_FILE: Specifies the path to the JSON file that defines the algorithm for small-sized, in-place operations.
ALLREDUCEPKT_OP_JSON_FILE: Specifies the path to the JSON file that defines the algorithm for small-sized, out-of-place operations.
ALLREDUCE_IP_JSON_FILE: Specifies the path to the JSON file that defines the algorithm for larger-sized, in-place operations.
ALLREDUCE_OP_JSON_FILE: Specifies the path to the JSON file that defines the algorithm for larger-sized, out-of-place operations.
ALLREDUCE_SMALL_MSG_BOUNDARY: Defines the size threshold at which the algorithm will switch between fallback code and the customized algorithm for small messages.
ALLREDUCE_LARGE_MSG_BOUNDARY: Defines the size threshold at which the algorithm will switch between the customized algorithm for small messages and that for larger messages.
+
+
+Decision Flowchart for Message Size-Based Algorithm Execution
+
+
+This is an example of executing the interface with the executor:
+ -np 8 -x ALLREDUCEPKT_IP_JSON_FILE = /root/azure-mscclpp/nccl/test/execution-files/allreducepacket.json -x ALLREDUCE_IP_JSON_FILE = /root/azure-mscclpp/nccl/test/execution-files/allreducesm.json -x ALLREDUCE_SMALL_MSG_BOUNDARY = 16K -x ALLREDUCE_LARGE_MSG_BOUNDARY = 1M ./apps/nccl/test/nccl_api_test
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/_build/doctrees/README.doctree b/docs/_build/doctrees/README.doctree
new file mode 100644
index 00000000..2d205aaf
Binary files /dev/null and b/docs/_build/doctrees/README.doctree differ
diff --git a/docs/_build/doctrees/api/index.doctree b/docs/_build/doctrees/api/index.doctree
new file mode 100644
index 00000000..e202d303
Binary files /dev/null and b/docs/_build/doctrees/api/index.doctree differ
diff --git a/docs/_build/doctrees/design/design.doctree b/docs/_build/doctrees/design/design.doctree
new file mode 100644
index 00000000..a19e2c80
Binary files /dev/null and b/docs/_build/doctrees/design/design.doctree differ
diff --git a/docs/_build/doctrees/design/nccl-over-mscclpp.doctree b/docs/_build/doctrees/design/nccl-over-mscclpp.doctree
new file mode 100644
index 00000000..57511a1f
Binary files /dev/null and b/docs/_build/doctrees/design/nccl-over-mscclpp.doctree differ
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
new file mode 100644
index 00000000..bf048231
Binary files /dev/null and b/docs/_build/doctrees/environment.pickle differ
diff --git a/docs/_build/doctrees/getting-started/quickstart.doctree b/docs/_build/doctrees/getting-started/quickstart.doctree
new file mode 100644
index 00000000..c386a8b7
Binary files /dev/null and b/docs/_build/doctrees/getting-started/quickstart.doctree differ
diff --git a/docs/_build/doctrees/getting-started/tutorials/customized-proxy-service.doctree b/docs/_build/doctrees/getting-started/tutorials/customized-proxy-service.doctree
new file mode 100644
index 00000000..7f8dbf70
Binary files /dev/null and b/docs/_build/doctrees/getting-started/tutorials/customized-proxy-service.doctree differ
diff --git a/docs/_build/doctrees/getting-started/tutorials/index.doctree b/docs/_build/doctrees/getting-started/tutorials/index.doctree
new file mode 100644
index 00000000..a718b692
Binary files /dev/null and b/docs/_build/doctrees/getting-started/tutorials/index.doctree differ
diff --git a/docs/_build/doctrees/getting-started/tutorials/initialization.doctree b/docs/_build/doctrees/getting-started/tutorials/initialization.doctree
new file mode 100644
index 00000000..42612f9d
Binary files /dev/null and b/docs/_build/doctrees/getting-started/tutorials/initialization.doctree differ
diff --git a/docs/_build/doctrees/getting-started/tutorials/packet-api.doctree b/docs/_build/doctrees/getting-started/tutorials/packet-api.doctree
new file mode 100644
index 00000000..b7bc0748
Binary files /dev/null and b/docs/_build/doctrees/getting-started/tutorials/packet-api.doctree differ
diff --git a/docs/_build/doctrees/getting-started/tutorials/proxy-channel.doctree b/docs/_build/doctrees/getting-started/tutorials/proxy-channel.doctree
new file mode 100644
index 00000000..56fe1720
Binary files /dev/null and b/docs/_build/doctrees/getting-started/tutorials/proxy-channel.doctree differ
diff --git a/docs/_build/doctrees/getting-started/tutorials/python-api.doctree b/docs/_build/doctrees/getting-started/tutorials/python-api.doctree
new file mode 100644
index 00000000..c60b4be4
Binary files /dev/null and b/docs/_build/doctrees/getting-started/tutorials/python-api.doctree differ
diff --git a/docs/_build/doctrees/getting-started/tutorials/sm-channel.doctree b/docs/_build/doctrees/getting-started/tutorials/sm-channel.doctree
new file mode 100644
index 00000000..10de1aa3
Binary files /dev/null and b/docs/_build/doctrees/getting-started/tutorials/sm-channel.doctree differ
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
new file mode 100644
index 00000000..dd580074
Binary files /dev/null and b/docs/_build/doctrees/index.doctree differ
diff --git a/docs/_build/doctrees/performance/performance-ndmv4.doctree b/docs/_build/doctrees/performance/performance-ndmv4.doctree
new file mode 100644
index 00000000..8d7c85d9
Binary files /dev/null and b/docs/_build/doctrees/performance/performance-ndmv4.doctree differ
diff --git a/docs/doxygen/html/README_8md.html b/docs/doxygen/html/README_8md.html
new file mode 100644
index 00000000..ccc927fa
--- /dev/null
+++ b/docs/doxygen/html/README_8md.html
@@ -0,0 +1,77 @@
+
+
+
+
+
+
+
+
MSCCL++: README.md File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/annotated.html b/docs/doxygen/html/annotated.html
new file mode 100644
index 00000000..27ae1ce9
--- /dev/null
+++ b/docs/doxygen/html/annotated.html
@@ -0,0 +1,137 @@
+
+
+
+
+
+
+
+
MSCCL++: Class List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here are the classes, structs, unions and interfaces with brief descriptions:
+
+
+
+
+
diff --git a/docs/doxygen/html/atomic__device_8hpp.html b/docs/doxygen/html/atomic__device_8hpp.html
new file mode 100644
index 00000000..1e743c06
--- /dev/null
+++ b/docs/doxygen/html/atomic__device_8hpp.html
@@ -0,0 +1,110 @@
+
+
+
+
+
+
+
+
MSCCL++: atomic_device.hpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/atomic__device_8hpp__dep__incl.map b/docs/doxygen/html/atomic__device_8hpp__dep__incl.map
new file mode 100644
index 00000000..3ee5d5a6
--- /dev/null
+++ b/docs/doxygen/html/atomic__device_8hpp__dep__incl.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/atomic__device_8hpp__dep__incl.md5 b/docs/doxygen/html/atomic__device_8hpp__dep__incl.md5
new file mode 100644
index 00000000..8f13a597
--- /dev/null
+++ b/docs/doxygen/html/atomic__device_8hpp__dep__incl.md5
@@ -0,0 +1 @@
+6cfc2034d7b43ddaa4bb852bb6b33299
\ No newline at end of file
diff --git a/docs/doxygen/html/atomic__device_8hpp__dep__incl.png b/docs/doxygen/html/atomic__device_8hpp__dep__incl.png
new file mode 100644
index 00000000..32ee12f8
Binary files /dev/null and b/docs/doxygen/html/atomic__device_8hpp__dep__incl.png differ
diff --git a/docs/doxygen/html/atomic__device_8hpp__incl.map b/docs/doxygen/html/atomic__device_8hpp__incl.map
new file mode 100644
index 00000000..32a3f468
--- /dev/null
+++ b/docs/doxygen/html/atomic__device_8hpp__incl.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/atomic__device_8hpp__incl.md5 b/docs/doxygen/html/atomic__device_8hpp__incl.md5
new file mode 100644
index 00000000..c1e08536
--- /dev/null
+++ b/docs/doxygen/html/atomic__device_8hpp__incl.md5
@@ -0,0 +1 @@
+ebea3bfe618a1a6ac8224ac50285f5e4
\ No newline at end of file
diff --git a/docs/doxygen/html/atomic__device_8hpp__incl.png b/docs/doxygen/html/atomic__device_8hpp__incl.png
new file mode 100644
index 00000000..1b7306f9
Binary files /dev/null and b/docs/doxygen/html/atomic__device_8hpp__incl.png differ
diff --git a/docs/doxygen/html/atomic__device_8hpp_source.html b/docs/doxygen/html/atomic__device_8hpp_source.html
new file mode 100644
index 00000000..ddeeb38c
--- /dev/null
+++ b/docs/doxygen/html/atomic__device_8hpp_source.html
@@ -0,0 +1,149 @@
+
+
+
+
+
+
+
+
MSCCL++: atomic_device.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_ATOMIC_DEVICE_HPP_
+
5 #define MSCCLPP_ATOMIC_DEVICE_HPP_
+
+
+
+
9 #if defined(MSCCLPP_DEVICE_CUDA)
+
10 #include <cuda/atomic>
+
11 #endif // defined(MSCCLPP_DEVICE_CUDA)
+
+
+
+
15 #if defined(MSCCLPP_DEVICE_CUDA)
+
+
17 constexpr cuda::memory_order memoryOrderRelaxed = cuda::memory_order_relaxed;
+
18 constexpr cuda::memory_order memoryOrderAcquire = cuda::memory_order_acquire;
+
19 constexpr cuda::memory_order memoryOrderRelease = cuda::memory_order_release;
+
20 constexpr cuda::memory_order memoryOrderAcqRel = cuda::memory_order_acq_rel;
+
21 constexpr cuda::memory_order memoryOrderSeqCst = cuda::memory_order_seq_cst;
+
+
+
+
25 return cuda::atomic_ref<T, cuda::thread_scope_system>{*ptr}.load(memoryOrder);
+
+
+
+
+
30 cuda::atomic_ref<T, cuda::thread_scope_system>{*ptr}.store(val, memoryOrder);
+
+
+
+
+
35 return cuda::atomic_ref<T, cuda::thread_scope_system>{*ptr}.fetch_add(val, memoryOrder);
+
+
+
38 #elif defined(MSCCLPP_DEVICE_HIP)
+
+
40 constexpr
auto memoryOrderRelaxed = __ATOMIC_RELAXED;
+
41 constexpr
auto memoryOrderAcquire = __ATOMIC_ACQUIRE;
+
42 constexpr
auto memoryOrderRelease = __ATOMIC_RELEASE;
+
43 constexpr
auto memoryOrderAcqRel = __ATOMIC_ACQ_REL;
+
44 constexpr
auto memoryOrderSeqCst = __ATOMIC_SEQ_CST;
+
+
+
+
48 return __atomic_load_n(ptr, memoryOrder);
+
+
+
+
+
53 __atomic_store_n(ptr, val, memoryOrder);
+
+
+
+
+
58 return __atomic_fetch_add(ptr, val, memoryOrder);
+
+
+
61 #endif // defined(MSCCLPP_DEVICE_HIP)
+
+
+
+
65 #endif // MSCCLPP_ATOMIC_DEVICE_HPP_
+
+
+
#define MSCCLPP_HOST_DEVICE_INLINE
Definition: device.hpp:25
+
Definition: atomic_device.hpp:13
+
+
+
+
diff --git a/docs/doxygen/html/bc_s.png b/docs/doxygen/html/bc_s.png
new file mode 100644
index 00000000..224b29aa
Binary files /dev/null and b/docs/doxygen/html/bc_s.png differ
diff --git a/docs/doxygen/html/bdwn.png b/docs/doxygen/html/bdwn.png
new file mode 100644
index 00000000..940a0b95
Binary files /dev/null and b/docs/doxygen/html/bdwn.png differ
diff --git a/docs/doxygen/html/classNpKit-members.html b/docs/doxygen/html/classNpKit-members.html
new file mode 100644
index 00000000..58bc6333
--- /dev/null
+++ b/docs/doxygen/html/classNpKit-members.html
@@ -0,0 +1,88 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for NpKit , including all inherited members.
+
+
+
+
+
diff --git a/docs/doxygen/html/classNpKit.html b/docs/doxygen/html/classNpKit.html
new file mode 100644
index 00000000..37d192c8
--- /dev/null
+++ b/docs/doxygen/html/classNpKit.html
@@ -0,0 +1,336 @@
+
+
+
+
+
+
+
+
MSCCL++: NpKit Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <npkit.hpp >
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static void NpKit::CollectCpuEvent
+ (
+ uint8_t
+ type ,
+
+ uint32_t
+ size ,
+
+ uint32_t
+ rsvd ,
+
+ uint64_t
+ timestamp ,
+
+ int
+ channel_id
+
+ )
+
+
+
+
+static
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static void NpKit::Dump
+ (
+ const std::string &
+ dump_dir )
+
+
+
+
+static
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static uint64_t* NpKit::GetCpuTimestamp
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static void NpKit::Init
+ (
+ int
+ rank )
+
+
+
+
+static
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static void NpKit::Shutdown
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const uint64_t NpKit::kNumCpuEventBuffers = 64
+
+
+
+
+static
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const uint64_t NpKit::kNumGpuEventBuffers = 1024
+
+
+
+
+static
+
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classes.html b/docs/doxygen/html/classes.html
new file mode 100644
index 00000000..e7736d61
--- /dev/null
+++ b/docs/doxygen/html/classes.html
@@ -0,0 +1,184 @@
+
+
+
+
+
+
+
+
MSCCL++: Class Index
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1BaseError-members.html b/docs/doxygen/html/classmscclpp_1_1BaseError-members.html
new file mode 100644
index 00000000..819dcceb
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1BaseError-members.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::BaseError , including all inherited members.
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1BaseError.html b/docs/doxygen/html/classmscclpp_1_1BaseError.html
new file mode 100644
index 00000000..86419e38
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1BaseError.html
@@ -0,0 +1,329 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::BaseError Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Base class for all errors thrown by MSCCL++.
+ More...
+
+
#include <errors.hpp >
+
+
+
+
+
+
[legend ]
+
+
+
+
+
Base class for all errors thrown by MSCCL++.
+
+
+
◆ [1/2]
+
+
+
+
+
+ mscclpp::BaseError::BaseError
+ (
+ const std::string &
+ message ,
+
+ int
+ errorCode
+
+ )
+
+
+
+
Constructor for BaseError .
+
Parameters
+
+ message The error message. errorCode The error code.
+
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ mscclpp::BaseError::BaseError
+ (
+ int
+ errorCode )
+
+
+
+
+explicit
+
+
+
+
Constructor for BaseError .
+
Parameters
+
+ errorCode The error code.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual mscclpp::BaseError::~BaseError
+ (
+ )
+
+
+
+
+virtual default
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ int mscclpp::BaseError::getErrorCode
+ (
+ )
+ const
+
+
+
+
Get the error code.
+
Returns The error code.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const char* mscclpp::BaseError::what
+ (
+ )
+ const
+
+
+
+
+override noexcept
+
+
+
+
Get the error message.
+
Returns The error message.
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ int mscclpp::BaseError::errorCode_
+
+
+
+
+protected
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ std::string mscclpp::BaseError::message_
+
+
+
+
+protected
+
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1BaseError__coll__graph.map b/docs/doxygen/html/classmscclpp_1_1BaseError__coll__graph.map
new file mode 100644
index 00000000..738cb161
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1BaseError__coll__graph.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1BaseError__coll__graph.md5 b/docs/doxygen/html/classmscclpp_1_1BaseError__coll__graph.md5
new file mode 100644
index 00000000..316ef9e3
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1BaseError__coll__graph.md5
@@ -0,0 +1 @@
+8ecf4b92dddff5fc7f9bb48db73fe193
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1BaseError__coll__graph.png b/docs/doxygen/html/classmscclpp_1_1BaseError__coll__graph.png
new file mode 100644
index 00000000..8601a7fd
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1BaseError__coll__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1BaseError__inherit__graph.map b/docs/doxygen/html/classmscclpp_1_1BaseError__inherit__graph.map
new file mode 100644
index 00000000..d9c524c0
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1BaseError__inherit__graph.map
@@ -0,0 +1,9 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1BaseError__inherit__graph.md5 b/docs/doxygen/html/classmscclpp_1_1BaseError__inherit__graph.md5
new file mode 100644
index 00000000..b7336ac6
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1BaseError__inherit__graph.md5
@@ -0,0 +1 @@
+adbbef22463d3bf2af55cde518780d0f
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1BaseError__inherit__graph.png b/docs/doxygen/html/classmscclpp_1_1BaseError__inherit__graph.png
new file mode 100644
index 00000000..daf09129
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1BaseError__inherit__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1BaseProxyService-members.html b/docs/doxygen/html/classmscclpp_1_1BaseProxyService-members.html
new file mode 100644
index 00000000..0c157fbd
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1BaseProxyService-members.html
@@ -0,0 +1,88 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::BaseProxyService , including all inherited members.
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1BaseProxyService.html b/docs/doxygen/html/classmscclpp_1_1BaseProxyService.html
new file mode 100644
index 00000000..b3e96ba3
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1BaseProxyService.html
@@ -0,0 +1,221 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::BaseProxyService Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Base class for proxy services. Proxy services are used to proxy data between devices.
+ More...
+
+
#include <proxy_channel.hpp >
+
+
+
+
+
Base class for proxy services. Proxy services are used to proxy data between devices.
+
+
+
◆
+
+
+
+
+
+
+
+
+ mscclpp::BaseProxyService::BaseProxyService
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual mscclpp::BaseProxyService::~BaseProxyService
+ (
+ )
+
+
+
+
+virtual default
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void mscclpp::BaseProxyService::startProxy
+ (
+ )
+
+
+
+
+pure virtual
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void mscclpp::BaseProxyService::stopProxy
+ (
+ )
+
+
+
+
+pure virtual
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1BaseProxyService__inherit__graph.map b/docs/doxygen/html/classmscclpp_1_1BaseProxyService__inherit__graph.map
new file mode 100644
index 00000000..ffde9c4c
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1BaseProxyService__inherit__graph.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1BaseProxyService__inherit__graph.md5 b/docs/doxygen/html/classmscclpp_1_1BaseProxyService__inherit__graph.md5
new file mode 100644
index 00000000..a43bdfc6
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1BaseProxyService__inherit__graph.md5
@@ -0,0 +1 @@
+4ef4c65f33a475359490a5ded5af499c
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1BaseProxyService__inherit__graph.png b/docs/doxygen/html/classmscclpp_1_1BaseProxyService__inherit__graph.png
new file mode 100644
index 00000000..003d1535
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1BaseProxyService__inherit__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1BaseSemaphore-members.html b/docs/doxygen/html/classmscclpp_1_1BaseSemaphore-members.html
new file mode 100644
index 00000000..29d04aa0
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1BaseSemaphore-members.html
@@ -0,0 +1,89 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::BaseSemaphore< InboundDeleter, OutboundDeleter > , including all inherited members.
+
+ BaseSemaphore (std::unique_ptr< uint64_t, InboundDeleter< uint64_t >> localInboundSemaphoreId, std::unique_ptr< uint64_t, InboundDeleter< uint64_t >> expectedInboundSemaphoreId, std::unique_ptr< uint64_t, OutboundDeleter< uint64_t >> outboundSemaphoreId)mscclpp::BaseSemaphore< InboundDeleter, OutboundDeleter > inline expectedInboundSemaphore_ mscclpp::BaseSemaphore< InboundDeleter, OutboundDeleter > protected localInboundSemaphore_ mscclpp::BaseSemaphore< InboundDeleter, OutboundDeleter > protected outboundSemaphore_ mscclpp::BaseSemaphore< InboundDeleter, OutboundDeleter > protected remoteInboundSemaphoreIdsRegMem_ mscclpp::BaseSemaphore< InboundDeleter, OutboundDeleter > protected
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1BaseSemaphore.html b/docs/doxygen/html/classmscclpp_1_1BaseSemaphore.html
new file mode 100644
index 00000000..a8ff8aa6
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1BaseSemaphore.html
@@ -0,0 +1,289 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::BaseSemaphore< InboundDeleter, OutboundDeleter > Class Template Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <semaphore.hpp >
+
+
+
+ BaseSemaphore (std::unique_ptr< uint64_t, InboundDeleter< uint64_t >> localInboundSemaphoreId, std::unique_ptr< uint64_t, InboundDeleter< uint64_t >> expectedInboundSemaphoreId, std::unique_ptr< uint64_t, OutboundDeleter< uint64_t >> outboundSemaphoreId)
+
+
template<template< typename > typename InboundDeleter, template< typename > typename OutboundDeleter>
+
+
A base class for semaphores.
+
An semaphore is a synchronization mechanism that allows the local peer to wait for the remote peer to complete a data transfer. The local peer signals the remote peer that it has completed a data transfer by incrementing the outbound semaphore ID. The incremented outbound semaphore ID is copied to the remote peer's inbound semaphore ID so that the remote peer can wait for the local peer to complete a data transfer. Vice versa, the remote peer signals the local peer that it has completed a data transfer by incrementing the remote peer's outbound semaphore ID and copying the incremented value to the local peer's inbound semaphore ID.
+
Template Parameters
+
+ InboundDeleter The deleter for inbound semaphore IDs. This is either std::default_delete for host memory or CudaDeleter for device memory. OutboundDeleter The deleter for outbound semaphore IDs. This is either std::default_delete for host memory or CudaDeleter for device memory.
+
+
+
+
+
◆
+
+
+
+
+template<template< typename > typename InboundDeleter, template< typename > typename OutboundDeleter>
+
+
+
+
+
+ mscclpp::BaseSemaphore < InboundDeleter, OutboundDeleter >::BaseSemaphore (
+ std::unique_ptr< uint64_t, InboundDeleter< uint64_t >>
+ localInboundSemaphoreId ,
+
+ std::unique_ptr< uint64_t, InboundDeleter< uint64_t >>
+ expectedInboundSemaphoreId ,
+
+ std::unique_ptr< uint64_t, OutboundDeleter< uint64_t >>
+ outboundSemaphoreId
+
+ )
+
+
+
+
+inline
+
+
+
+
Constructs a BaseSemaphore .
+
Parameters
+
+ localInboundSemaphoreId The inbound semaphore ID expectedInboundSemaphoreId The expected inbound semaphore ID outboundSemaphoreId The outbound semaphore ID
+
+
+
+
+
+
+
+
◆
+
+
+
+
+template<template< typename > typename InboundDeleter, template< typename > typename OutboundDeleter>
+
+
+
+
+
+ std::unique_ptr<uint64_t, InboundDeleter<uint64_t> > mscclpp::BaseSemaphore < InboundDeleter, OutboundDeleter >::expectedInboundSemaphore_
+
+
+
+
+protected
+
+
+
+
+
+
◆
+
+
+
+
+template<template< typename > typename InboundDeleter, template< typename > typename OutboundDeleter>
+
+
+
+
+
+ std::unique_ptr<uint64_t, InboundDeleter<uint64_t> > mscclpp::BaseSemaphore < InboundDeleter, OutboundDeleter >::localInboundSemaphore_
+
+
+
+
+protected
+
+
+
+
The inbound semaphore ID that is incremented by the remote peer and waited on by the local peer.
+
The location of localInboundSemaphore_ can be either on the host or on the device.
+
+
+
+
+
◆
+
+
+
+
+template<template< typename > typename InboundDeleter, template< typename > typename OutboundDeleter>
+
+
+
+
+
+ std::unique_ptr<uint64_t, OutboundDeleter<uint64_t> > mscclpp::BaseSemaphore < InboundDeleter, OutboundDeleter >::outboundSemaphore_
+
+
+
+
+protected
+
+
+
+
The outbound semaphore ID that is incremented by the local peer and copied to the remote peer's localInboundSemaphore_ .
+
The location of outboundSemaphore_ can be either on the host or on the device.
+
+
+
+
+
◆
+
+
+
+
+template<template< typename > typename InboundDeleter, template< typename > typename OutboundDeleter>
+
+
+
+
The registered memory for the remote peer's inbound semaphore ID.
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1BaseSemaphore__coll__graph.map b/docs/doxygen/html/classmscclpp_1_1BaseSemaphore__coll__graph.map
new file mode 100644
index 00000000..531d1487
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1BaseSemaphore__coll__graph.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1BaseSemaphore__coll__graph.md5 b/docs/doxygen/html/classmscclpp_1_1BaseSemaphore__coll__graph.md5
new file mode 100644
index 00000000..205a0eca
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1BaseSemaphore__coll__graph.md5
@@ -0,0 +1 @@
+0f1e80aeb312966913206d9f0591a6e9
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1BaseSemaphore__coll__graph.png b/docs/doxygen/html/classmscclpp_1_1BaseSemaphore__coll__graph.png
new file mode 100644
index 00000000..988cf5eb
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1BaseSemaphore__coll__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1Bootstrap-members.html b/docs/doxygen/html/classmscclpp_1_1Bootstrap-members.html
new file mode 100644
index 00000000..5ba8682c
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Bootstrap-members.html
@@ -0,0 +1,96 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::Bootstrap , including all inherited members.
+
+ allGather (void *allData, int size)=0mscclpp::Bootstrap pure virtual barrier ()=0mscclpp::Bootstrap pure virtual Bootstrap ()mscclpp::Bootstrap inline getNranks ()=0mscclpp::Bootstrap pure virtual getNranksPerNode ()=0mscclpp::Bootstrap pure virtual getRank ()=0mscclpp::Bootstrap pure virtual groupBarrier (const std::vector< int > &ranks)mscclpp::Bootstrap recv (void *data, int size, int peer, int tag)=0mscclpp::Bootstrap pure virtual recv (std::vector< char > &data, int peer, int tag)mscclpp::Bootstrap send (void *data, int size, int peer, int tag)=0mscclpp::Bootstrap pure virtual send (const std::vector< char > &data, int peer, int tag)mscclpp::Bootstrap ~Bootstrap ()=defaultmscclpp::Bootstrap virtual
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Bootstrap.html b/docs/doxygen/html/classmscclpp_1_1Bootstrap.html
new file mode 100644
index 00000000..79736362
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Bootstrap.html
@@ -0,0 +1,515 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::Bootstrap Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Base class for bootstraps.
+ More...
+
+
#include <core.hpp >
+
+
+
+ Bootstrap () virtual ~Bootstrap ()=default virtual int getRank ()=0 virtual int getNranks ()=0 virtual int getNranksPerNode ()=0 virtual void send (void *data, int size, int peer, int tag)=0 virtual void recv (void *data, int size, int peer, int tag)=0 virtual void allGather (void *allData, int size)=0 virtual void barrier ()=0 void groupBarrier (const std::vector< int > &ranks) void send (const std::vector< char > &data, int peer, int tag) void recv (std::vector< char > &data, int peer, int tag)
+
+
Base class for bootstraps.
+
+
+
◆
+
+
+
+
+
+
+
+
+ mscclpp::Bootstrap::Bootstrap
+ (
+ )
+
+
+
+
+inline
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual mscclpp::Bootstrap::~Bootstrap
+ (
+ )
+
+
+
+
+virtual default
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void mscclpp::Bootstrap::allGather
+ (
+ void *
+ allData ,
+
+ int
+ size
+
+ )
+
+
+
+
+pure virtual
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void mscclpp::Bootstrap::barrier
+ (
+ )
+
+
+
+
+pure virtual
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual int mscclpp::Bootstrap::getNranks
+ (
+ )
+
+
+
+
+pure virtual
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual int mscclpp::Bootstrap::getNranksPerNode
+ (
+ )
+
+
+
+
+pure virtual
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual int mscclpp::Bootstrap::getRank
+ (
+ )
+
+
+
+
+pure virtual
+
+
+
+
+
+
◆
+
+
+
+
+
+ void mscclpp::Bootstrap::groupBarrier
+ (
+ const std::vector< int > &
+ ranks )
+
+
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void mscclpp::Bootstrap::recv
+ (
+ std::vector< char > &
+ data ,
+
+ int
+ peer ,
+
+ int
+ tag
+
+ )
+
+
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ virtual void mscclpp::Bootstrap::recv
+ (
+ void *
+ data ,
+
+ int
+ size ,
+
+ int
+ peer ,
+
+ int
+ tag
+
+ )
+
+
+
+
+pure virtual
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void mscclpp::Bootstrap::send
+ (
+ const std::vector< char > &
+ data ,
+
+ int
+ peer ,
+
+ int
+ tag
+
+ )
+
+
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ virtual void mscclpp::Bootstrap::send
+ (
+ void *
+ data ,
+
+ int
+ size ,
+
+ int
+ peer ,
+
+ int
+ tag
+
+ )
+
+
+
+
+pure virtual
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Bootstrap__inherit__graph.map b/docs/doxygen/html/classmscclpp_1_1Bootstrap__inherit__graph.map
new file mode 100644
index 00000000..f218219d
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Bootstrap__inherit__graph.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Bootstrap__inherit__graph.md5 b/docs/doxygen/html/classmscclpp_1_1Bootstrap__inherit__graph.md5
new file mode 100644
index 00000000..0d45bc0a
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Bootstrap__inherit__graph.md5
@@ -0,0 +1 @@
+c22cb9841f735fba797a5e780e35ea55
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1Bootstrap__inherit__graph.png b/docs/doxygen/html/classmscclpp_1_1Bootstrap__inherit__graph.png
new file mode 100644
index 00000000..c37d1091
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1Bootstrap__inherit__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1Communicator-members.html b/docs/doxygen/html/classmscclpp_1_1Communicator-members.html
new file mode 100644
index 00000000..0d757b12
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Communicator-members.html
@@ -0,0 +1,96 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::Communicator , including all inherited members.
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Communicator.html b/docs/doxygen/html/classmscclpp_1_1Communicator.html
new file mode 100644
index 00000000..ef73ac60
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Communicator.html
@@ -0,0 +1,490 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::Communicator Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <core.hpp >
+
+
+
A class that sets up all registered memories and connections between processes.
+
A typical way to use this class:
+Call connectOnSetup() to declare connections between the calling process with other processes.
+Call registerMemory() to register memory regions that will be used for communication.
+Call sendMemoryOnSetup() or recvMemoryOnSetup() to send/receive registered memory regions to/from other processes.
+Call setup() to set up all registered memories and connections declared in the previous steps.
+Call NonblockingFuture<RegisteredMemory>::get() to get the registered memory regions received from other processes.
+All done; use connections and registered memories to build channels.
+
+
+
+
◆
+
+
+
+
+
+ mscclpp::Communicator::Communicator
+ (
+ std::shared_ptr< Bootstrap >
+ bootstrap ,
+
+ std::shared_ptr< Context >
+ context = nullptr
+
+ )
+
+
+
+
Initializes the communicator with a given bootstrap implementation.
+
Parameters
+
+ bootstrap An implementation of the Bootstrap that the communicator will use. context An optional context to use for the communicator. If not provided, a new context will be created.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ mscclpp::Communicator::~Communicator
+ (
+ )
+
+
+
+
+
Destroy the communicator.
+
+
+
+
+
+
◆
+
+
+
+
+
+ std::shared_ptr<Bootstrap > mscclpp::Communicator::bootstrap
+ (
+ )
+
+
+
+
Returns the bootstrap held by this communicator.
+
Returns std::shared_ptr<Bootstrap> The bootstrap held by this communicator.
+
+
+
+
+
◆
+
+
+
+
Connect to a remote rank on setup.
+
This function only prepares metadata for connection. The actual connection is made by a following call of setup() . Note that this function is two-way and a connection from rank i to remote rank j needs to have a counterpart from rank j to rank i. Note that with IB, buffers are registered at a page level and if a buffer is spread through multiple pages and do not fully utilize all of them, IB's QP has to register for all involved pages. This potentially has security risks if the connection's accesses are given to a malicious process.
+
Parameters
+
+ remoteRank The rank of the remote process. tag The tag of the connection for identifying it. config The configuration for the local endpoint.
+
+
+
Returns NonblockingFuture <NonblockingFuture <std::shared_ptr<Connection>>> A non-blocking future of shared pointer to the connection.
+
+
+
+
+
◆
+
+
+
+
+
+ std::shared_ptr<Context > mscclpp::Communicator::context
+ (
+ )
+
+
+
+
Returns the context held by this communicator.
+
Returns std::shared_ptr<Context> The context held by this communicator.
+
+
+
+
+
◆
+
+
+
+
+
+ void mscclpp::Communicator::onSetup
+ (
+ std::shared_ptr< Setuppable >
+ setuppable )
+
+
+
+
Add a custom Setuppable object to a list of objects to be setup later, when setup() is called.
+
Parameters
+
+ setuppable A shared pointer to the Setuppable object.
+
+
+
+
+
+
+
◆
+
+
+
+
Receive memory on setup.
+
This function registers a receive from a remote process that will happen by a following call of setup() . The receive will carry information about a registered memory on the remote process.
+
Parameters
+
+ remoteRank The rank of the remote process. tag The tag to use for identifying the receive.
+
+
+
Returns NonblockingFuture<RegisteredMemory> A non-blocking future of registered memory.
+
+
+
+
+
◆
+
+
+
+
+
+ RegisteredMemory mscclpp::Communicator::registerMemory (
+ void *
+ ptr ,
+
+ size_t
+ size ,
+
+ TransportFlags transports
+
+ )
+
+
+
+
Register a region of GPU memory for use in this communicator's context.
+
Parameters
+
+ ptr Base pointer to the memory. size Size of the memory region in bytes. transports Transport flags.
+
+
+
Returns RegisteredMemory A handle to the buffer.
+
+
+
+
+
◆
+
+
+
+
+
+ int mscclpp::Communicator::remoteRankOf
+ (
+ const Connection &
+ connection )
+
+
+
+
Get the remote rank a connection is connected to.
+
Parameters
+
+ connection The connection to get the remote rank for.
+
+
+
Returns The remote rank the connection is connected to.
+
+
+
+
+
◆
+
+
+
+
+
+ void mscclpp::Communicator::sendMemoryOnSetup
+ (
+ RegisteredMemory memory ,
+
+ int
+ remoteRank ,
+
+ int
+ tag
+
+ )
+
+
+
+
Send information of a registered memory to the remote side on setup.
+
This function registers a send to a remote process that will happen by a following call of setup() . The send will carry information about a registered memory on the local process.
+
Parameters
+
+ memory The registered memory buffer to send information about. remoteRank The rank of the remote process. tag The tag to use for identifying the send.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void mscclpp::Communicator::setup
+ (
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ int mscclpp::Communicator::tagOf
+ (
+ const Connection &
+ connection )
+
+
+
+
Get the tag a connection was made with.
+
Parameters
+
+ connection The connection to get the tag for.
+
+
+
Returns The tag the connection was made with.
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Connection-members.html b/docs/doxygen/html/classmscclpp_1_1Connection-members.html
new file mode 100644
index 00000000..6e6796c0
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Connection-members.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::Connection , including all inherited members.
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Connection.html b/docs/doxygen/html/classmscclpp_1_1Connection.html
new file mode 100644
index 00000000..88da4e88
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Connection.html
@@ -0,0 +1,424 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::Connection Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Represents a connection between two processes.
+ More...
+
+
#include <core.hpp >
+
+
+
Represents a connection between two processes.
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual mscclpp::Connection::~Connection
+ (
+ )
+
+
+
+
+virtual default
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void mscclpp::Connection::flush
+ (
+ int64_t
+ timeoutUsec = 3e7)
+
+
+
+
+pure virtual
+
+
+
+
+
Flush any pending writes to the remote process.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ static std::shared_ptr<Endpoint::Impl> mscclpp::Connection::getImpl
+ (
+ Endpoint & memory )
+
+
+
+
+static protected
+
+
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ static std::shared_ptr<RegisteredMemory::Impl> mscclpp::Connection::getImpl
+ (
+ RegisteredMemory & memory )
+
+
+
+
+static protected
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ std::string mscclpp::Connection::getTransportName
+ (
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Transport mscclpp::Connection::remoteTransport
+ (
+ )
+
+
+
+
+pure virtual
+
+
+
+
Get the transport used by the remote process.
+
Returns The transport used by the remote process.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Transport mscclpp::Connection::transport
+ (
+ )
+
+
+
+
+pure virtual
+
+
+
+
Get the transport used by the local process.
+
Returns The transport used by the local process.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void mscclpp::Connection::updateAndSync
+ (
+ RegisteredMemory dst ,
+
+ uint64_t
+ dstOffset ,
+
+ uint64_t *
+ src ,
+
+ uint64_t
+ newValue
+
+ )
+
+
+
+
+pure virtual
+
+
+
+
Update a 8-byte value in a destination RegisteredMemory and synchronize the change with the remote process.
+
Parameters
+
+ dst The destination RegisteredMemory . dstOffset The offset in bytes from the start of the destination RegisteredMemory . src A pointer to the value to update. newValue The new value to write.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void mscclpp::Connection::write
+ (
+ RegisteredMemory dst ,
+
+ uint64_t
+ dstOffset ,
+
+ RegisteredMemory src ,
+
+ uint64_t
+ srcOffset ,
+
+ uint64_t
+ size
+
+ )
+
+
+
+
+pure virtual
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Context-members.html b/docs/doxygen/html/classmscclpp_1_1Context-members.html
new file mode 100644
index 00000000..ad0fe8e3
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Context-members.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::Context , including all inherited members.
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Context.html b/docs/doxygen/html/classmscclpp_1_1Context.html
new file mode 100644
index 00000000..2361cd2e
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Context.html
@@ -0,0 +1,314 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::Context Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <core.hpp >
+
+
+
Represents a context for communication. This provides a low-level interface for forming connections in use-cases where the process group abstraction offered by Communicator is not suitable, e.g., ephemeral client-server connections. Correct use of this class requires external synchronization when finalizing connections with the connect() method.
+
As an example, a client-server scenario where the server will write to the client might proceed as follows:
+The client creates an endpoint with createEndpoint() and sends it to the server.
+The server receives the client endpoint, creates its own endpoint with createEndpoint() , sends it to the client, and creates a connection with connect() .
+The client receives the server endpoint, creates a connection with connect() and sends a RegisteredMemory to the server.
+The server receives the RegisteredMemory and writes to it using the previously created connection. The client waiting to create a connection before sending the RegisteredMemory ensures that the server can not write to the RegisteredMemory before the connection is established.
+
+
While some transports may have more relaxed implementation behavior, this should not be relied upon.
+
+
+
◆
+
+
+
+
+
+ mscclpp::Context::Context
+ (
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ mscclpp::Context::~Context
+ (
+ )
+
+
+
+
+
Destroy the context.
+
+
+
+
+
+
◆
+
+
+
+
+
+ std::shared_ptr<Connection > mscclpp::Context::connect
+ (
+ Endpoint localEndpoint ,
+
+ Endpoint remoteEndpoint
+
+ )
+
+
+
+
Establish a connection between two endpoints. While this method immediately returns a connection object, the connection is only safe to use after the corresponding connection on the remote endpoint has been established. This method must be called on both endpoints to establish a connection.
+
Parameters
+
+ localEndpoint The local endpoint. remoteEndpoint The remote endpoint.
+
+
+
Returns std::shared_ptr<Connection> A shared pointer to the connection.
+
+
+
+
+
◆
+
+
+
+
Create an endpoint for establishing connections.
+
Parameters
+
+ config The configuration for the endpoint.
+
+
+
Returns The newly created endpoint.
+
+
+
+
+
◆
+
+
+
+
+
+ RegisteredMemory mscclpp::Context::registerMemory (
+ void *
+ ptr ,
+
+ size_t
+ size ,
+
+ TransportFlags transports
+
+ )
+
+
+
+
Register a region of GPU memory for use in this context.
+
Parameters
+
+ ptr Base pointer to the memory. size Size of the memory region in bytes. transports Transport flags.
+
+
+
Returns RegisteredMemory A handle to the buffer.
+
+
+
+
+
+
◆
+
+
+
+
◆
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1CuError-members.html b/docs/doxygen/html/classmscclpp_1_1CuError-members.html
new file mode 100644
index 00000000..3f74c13a
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1CuError-members.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::CuError , including all inherited members.
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1CuError.html b/docs/doxygen/html/classmscclpp_1_1CuError.html
new file mode 100644
index 00000000..fd252ffe
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1CuError.html
@@ -0,0 +1,196 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::CuError Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
An error from a CUDA driver library call.
+ More...
+
+
#include <errors.hpp >
+
+
+
+
+
+
+
An error from a CUDA driver library call.
+
+
+
◆
+
+
+
+
+
+ mscclpp::CuError::CuError
+ (
+ const std::string &
+ message ,
+
+ int
+ errorCode
+
+ )
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual mscclpp::CuError::~CuError
+ (
+ )
+
+
+
+
+virtual default
+
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1CuError__coll__graph.map b/docs/doxygen/html/classmscclpp_1_1CuError__coll__graph.map
new file mode 100644
index 00000000..963d02a0
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1CuError__coll__graph.map
@@ -0,0 +1,5 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1CuError__coll__graph.md5 b/docs/doxygen/html/classmscclpp_1_1CuError__coll__graph.md5
new file mode 100644
index 00000000..bc93c80e
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1CuError__coll__graph.md5
@@ -0,0 +1 @@
+7f90c89a3d13ba7f754f1dbda3007e54
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1CuError__coll__graph.png b/docs/doxygen/html/classmscclpp_1_1CuError__coll__graph.png
new file mode 100644
index 00000000..5a077d8e
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1CuError__coll__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1CuError__inherit__graph.map b/docs/doxygen/html/classmscclpp_1_1CuError__inherit__graph.map
new file mode 100644
index 00000000..963d02a0
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1CuError__inherit__graph.map
@@ -0,0 +1,5 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1CuError__inherit__graph.md5 b/docs/doxygen/html/classmscclpp_1_1CuError__inherit__graph.md5
new file mode 100644
index 00000000..bc93c80e
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1CuError__inherit__graph.md5
@@ -0,0 +1 @@
+7f90c89a3d13ba7f754f1dbda3007e54
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1CuError__inherit__graph.png b/docs/doxygen/html/classmscclpp_1_1CuError__inherit__graph.png
new file mode 100644
index 00000000..5a077d8e
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1CuError__inherit__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1CudaError-members.html b/docs/doxygen/html/classmscclpp_1_1CudaError-members.html
new file mode 100644
index 00000000..fb5363cd
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1CudaError-members.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::CudaError , including all inherited members.
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1CudaError.html b/docs/doxygen/html/classmscclpp_1_1CudaError.html
new file mode 100644
index 00000000..470b0bfd
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1CudaError.html
@@ -0,0 +1,196 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::CudaError Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
An error from a CUDA runtime library call.
+ More...
+
+
#include <errors.hpp >
+
+
+
+
+
+
+
An error from a CUDA runtime library call.
+
+
+
◆
+
+
+
+
+
+ mscclpp::CudaError::CudaError
+ (
+ const std::string &
+ message ,
+
+ int
+ errorCode
+
+ )
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual mscclpp::CudaError::~CudaError
+ (
+ )
+
+
+
+
+virtual default
+
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1CudaError__coll__graph.map b/docs/doxygen/html/classmscclpp_1_1CudaError__coll__graph.map
new file mode 100644
index 00000000..f331f63a
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1CudaError__coll__graph.map
@@ -0,0 +1,5 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1CudaError__coll__graph.md5 b/docs/doxygen/html/classmscclpp_1_1CudaError__coll__graph.md5
new file mode 100644
index 00000000..66028ec0
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1CudaError__coll__graph.md5
@@ -0,0 +1 @@
+a2887598bede3b7c877d0247d1e10afb
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1CudaError__coll__graph.png b/docs/doxygen/html/classmscclpp_1_1CudaError__coll__graph.png
new file mode 100644
index 00000000..41981d69
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1CudaError__coll__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1CudaError__inherit__graph.map b/docs/doxygen/html/classmscclpp_1_1CudaError__inherit__graph.map
new file mode 100644
index 00000000..f331f63a
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1CudaError__inherit__graph.map
@@ -0,0 +1,5 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1CudaError__inherit__graph.md5 b/docs/doxygen/html/classmscclpp_1_1CudaError__inherit__graph.md5
new file mode 100644
index 00000000..66028ec0
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1CudaError__inherit__graph.md5
@@ -0,0 +1 @@
+a2887598bede3b7c877d0247d1e10afb
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1CudaError__inherit__graph.png b/docs/doxygen/html/classmscclpp_1_1CudaError__inherit__graph.png
new file mode 100644
index 00000000..41981d69
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1CudaError__inherit__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1Endpoint-members.html b/docs/doxygen/html/classmscclpp_1_1Endpoint-members.html
new file mode 100644
index 00000000..d982bea7
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Endpoint-members.html
@@ -0,0 +1,90 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::Endpoint , including all inherited members.
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Endpoint.html b/docs/doxygen/html/classmscclpp_1_1Endpoint.html
new file mode 100644
index 00000000..ca4d15ca
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Endpoint.html
@@ -0,0 +1,265 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::Endpoint Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Represents one end of a connection.
+ More...
+
+
#include <core.hpp >
+
+
+
Represents one end of a connection.
+
+
+
◆
+
+
+
+
+
+
+
+
+ mscclpp::Endpoint::Endpoint
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
Default constructor.
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static Endpoint mscclpp::Endpoint::deserialize
+ (
+ const std::vector< char > &
+ data )
+
+
+
+
+static
+
+
+
+
Deserialize a Endpoint object from a vector of characters.
+
Parameters
+
+ data A vector of characters representing a serialized Endpoint object.
+
+
+
Returns A deserialized Endpoint object.
+
+
+
+
+
◆
+
+
+
+
+
+ std::vector<char> mscclpp::Endpoint::serialize
+ (
+ )
+
+
+
+
Serialize the Endpoint object to a vector of characters.
+
Returns A vector of characters representing the serialized Endpoint object.
+
+
+
+
+
◆
+
+
+
+
+
+ Transport mscclpp::Endpoint::transport (
+ )
+
+
+
+
Get the transport used.
+
Returns The transport used.
+
+
+
+
+
+
◆
+
+
+
+
◆
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Error-members.html b/docs/doxygen/html/classmscclpp_1_1Error-members.html
new file mode 100644
index 00000000..6aaadd76
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Error-members.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::Error , including all inherited members.
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Error.html b/docs/doxygen/html/classmscclpp_1_1Error.html
new file mode 100644
index 00000000..4037ce53
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Error.html
@@ -0,0 +1,216 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::Error Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A generic error.
+ More...
+
+
#include <errors.hpp >
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ mscclpp::Error::Error
+ (
+ const std::string &
+ message ,
+
+ ErrorCode errorCode
+
+ )
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual mscclpp::Error::~Error
+ (
+ )
+
+
+
+
+virtual default
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ ErrorCode mscclpp::Error::getErrorCode (
+ )
+ const
+
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Error__coll__graph.map b/docs/doxygen/html/classmscclpp_1_1Error__coll__graph.map
new file mode 100644
index 00000000..3c5d3b9b
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Error__coll__graph.map
@@ -0,0 +1,5 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Error__coll__graph.md5 b/docs/doxygen/html/classmscclpp_1_1Error__coll__graph.md5
new file mode 100644
index 00000000..a3465d2c
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Error__coll__graph.md5
@@ -0,0 +1 @@
+d16e15307ec20d29f81ead4089fab598
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1Error__coll__graph.png b/docs/doxygen/html/classmscclpp_1_1Error__coll__graph.png
new file mode 100644
index 00000000..2946b3f1
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1Error__coll__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1Error__inherit__graph.map b/docs/doxygen/html/classmscclpp_1_1Error__inherit__graph.map
new file mode 100644
index 00000000..3c5d3b9b
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Error__inherit__graph.map
@@ -0,0 +1,5 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Error__inherit__graph.md5 b/docs/doxygen/html/classmscclpp_1_1Error__inherit__graph.md5
new file mode 100644
index 00000000..a3465d2c
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Error__inherit__graph.md5
@@ -0,0 +1 @@
+d16e15307ec20d29f81ead4089fab598
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1Error__inherit__graph.png b/docs/doxygen/html/classmscclpp_1_1Error__inherit__graph.png
new file mode 100644
index 00000000..2946b3f1
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1Error__inherit__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1ExecutionPlan-members.html b/docs/doxygen/html/classmscclpp_1_1ExecutionPlan-members.html
new file mode 100644
index 00000000..af8554cf
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1ExecutionPlan-members.html
@@ -0,0 +1,87 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::ExecutionPlan , including all inherited members.
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1ExecutionPlan.html b/docs/doxygen/html/classmscclpp_1_1ExecutionPlan.html
new file mode 100644
index 00000000..6b49cd7e
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1ExecutionPlan.html
@@ -0,0 +1,180 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::ExecutionPlan Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <executor.hpp >
+
+
+
+
◆
+
+
+
+
+
+ mscclpp::ExecutionPlan::ExecutionPlan
+ (
+ const std::string &
+ name ,
+
+ const std::string &
+ planPath
+
+ )
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ mscclpp::ExecutionPlan::~ExecutionPlan
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
+
+
+
+
◆
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Executor-members.html b/docs/doxygen/html/classmscclpp_1_1Executor-members.html
new file mode 100644
index 00000000..53e4ed57
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Executor-members.html
@@ -0,0 +1,89 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::Executor , including all inherited members.
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Executor.html b/docs/doxygen/html/classmscclpp_1_1Executor.html
new file mode 100644
index 00000000..9a98dde1
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Executor.html
@@ -0,0 +1,262 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::Executor Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <executor.hpp >
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ mscclpp::Executor::Executor
+ (
+ std::shared_ptr< Communicator >
+ comm )
+
+
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ mscclpp::Executor::Executor
+ (
+ const Executor &
+ )
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ mscclpp::Executor::~Executor
+ (
+ )
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void mscclpp::Executor::execute
+ (
+ int
+ rank ,
+
+ void *
+ sendbuff ,
+
+ void *
+ recvBuff ,
+
+ size_t
+ sendBuffSize ,
+
+ size_t
+ recvBuffSize ,
+
+ DataType dataType ,
+
+ const ExecutionPlan &
+ plan ,
+
+ cudaStream_t
+ stream ,
+
+ PacketType packetType = PacketType::LL16
+
+ )
+
+
+
+
+
+
+
+
◆
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Fifo-members.html b/docs/doxygen/html/classmscclpp_1_1Fifo-members.html
new file mode 100644
index 00000000..aa05bcdc
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Fifo-members.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::Fifo , including all inherited members.
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Fifo.html b/docs/doxygen/html/classmscclpp_1_1Fifo.html
new file mode 100644
index 00000000..fa737ff3
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Fifo.html
@@ -0,0 +1,259 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::Fifo Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A class representing a host proxy FIFO that can consume work elements pushed by device threads.
+ More...
+
+
#include <fifo.hpp >
+
+
+
A class representing a host proxy FIFO that can consume work elements pushed by device threads.
+
+
+
◆
+
+
+
+
Constructs a new Fifo object.
Parameters
+
+ size The number of entires in the FIFO.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ mscclpp::Fifo::~Fifo
+ (
+ )
+
+
+
+
+
Destroys the Fifo object.
+
+
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
+
+ void mscclpp::Fifo::flushTail
+ (
+ bool
+ sync = false)
+
+
+
+
Flushes the tail of the FIFO.
+
Parameters
+
+ sync If true, waits for the flush to complete before returning.
+
+
+
+
+
+
+
◆
+
+
+
+
Polls the FIFO for a trigger.
+
Returns ProxyTrigger which is the trigger at the head of fifo.
+
+
+
+
+
◆
+
+
+
+
+
+ void mscclpp::Fifo::pop
+ (
+ )
+
+
+
+
+
Pops a trigger from the FIFO.
+
+
+
+
+
◆
+
+
+
+
+
+ int mscclpp::Fifo::size
+ (
+ )
+ const
+
+
+
+
Return the FIFO size.
Returns The FIFO size.
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore-members.html b/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore-members.html
new file mode 100644
index 00000000..a5bd0997
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore-members.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::Host2DeviceSemaphore , including all inherited members.
+
+ BaseSemaphore (std::unique_ptr< uint64_t, CudaDeleter< uint64_t >> localInboundSemaphoreId, std::unique_ptr< uint64_t, CudaDeleter< uint64_t >> expectedInboundSemaphoreId, std::unique_ptr< uint64_t, std::default_delete< uint64_t >> outboundSemaphoreId)mscclpp::BaseSemaphore< CudaDeleter, std::default_delete > inline connection ()mscclpp::Host2DeviceSemaphore DeviceHandle typedefmscclpp::Host2DeviceSemaphore deviceHandle ()mscclpp::Host2DeviceSemaphore expectedInboundSemaphore_ mscclpp::BaseSemaphore< CudaDeleter, std::default_delete > protected Host2DeviceSemaphore (Communicator &communicator, std::shared_ptr< Connection > connection)mscclpp::Host2DeviceSemaphore localInboundSemaphore_ mscclpp::BaseSemaphore< CudaDeleter, std::default_delete > protected outboundSemaphore_ mscclpp::BaseSemaphore< CudaDeleter, std::default_delete > protected remoteInboundSemaphoreIdsRegMem_ mscclpp::BaseSemaphore< CudaDeleter, std::default_delete > protected signal ()mscclpp::Host2DeviceSemaphore
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore.html b/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore.html
new file mode 100644
index 00000000..82fc7323
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore.html
@@ -0,0 +1,260 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::Host2DeviceSemaphore Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A semaphore for sending signals from the host to the device.
+ More...
+
+
#include <semaphore.hpp >
+
+
+
+
+
+
+
A semaphore for sending signals from the host to the device.
+
+
+
◆
+
+
+
+
+
◆
+
+
+
+
+
+ mscclpp::Host2DeviceSemaphore::Host2DeviceSemaphore
+ (
+ Communicator & communicator ,
+
+ std::shared_ptr< Connection >
+ connection
+
+ )
+
+
+
+
Constructor.
Parameters
+
+ communicator The communicator. connection The connection associated with this semaphore.
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ std::shared_ptr<Connection > mscclpp::Host2DeviceSemaphore::connection
+ (
+ )
+
+
+
+
Returns the connection.
Returns The connection associated with this semaphore.
+
+
+
+
+
◆
+
+
+
+
+
+ DeviceHandle mscclpp::Host2DeviceSemaphore::deviceHandle (
+ )
+
+
+
+
+
Returns the device-side handle.
+
+
+
+
+
◆
+
+
+
+
+
+ void mscclpp::Host2DeviceSemaphore::signal
+ (
+ )
+
+
+
+
+
Signal the device.
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore__coll__graph.map b/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore__coll__graph.map
new file mode 100644
index 00000000..1b441d65
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore__coll__graph.map
@@ -0,0 +1,5 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore__coll__graph.md5 b/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore__coll__graph.md5
new file mode 100644
index 00000000..e202b325
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore__coll__graph.md5
@@ -0,0 +1 @@
+3749bc1ec7779fa6b203f481ffb874fd
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore__coll__graph.png b/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore__coll__graph.png
new file mode 100644
index 00000000..560b48cf
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore__coll__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore__inherit__graph.map b/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore__inherit__graph.map
new file mode 100644
index 00000000..09bcfa54
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore__inherit__graph.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore__inherit__graph.md5 b/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore__inherit__graph.md5
new file mode 100644
index 00000000..b69dade4
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore__inherit__graph.md5
@@ -0,0 +1 @@
+f3802681eda9ac947742ea3137dacefa
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore__inherit__graph.png b/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore__inherit__graph.png
new file mode 100644
index 00000000..63e77552
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1Host2DeviceSemaphore__inherit__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore-members.html b/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore-members.html
new file mode 100644
index 00000000..21e57dac
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore-members.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::Host2HostSemaphore , including all inherited members.
+
+ BaseSemaphore (std::unique_ptr< uint64_t, std::default_delete< uint64_t >> localInboundSemaphoreId, std::unique_ptr< uint64_t, std::default_delete< uint64_t >> expectedInboundSemaphoreId, std::unique_ptr< uint64_t, std::default_delete< uint64_t >> outboundSemaphoreId)mscclpp::BaseSemaphore< std::default_delete, std::default_delete > inline connection ()mscclpp::Host2HostSemaphore expectedInboundSemaphore_ mscclpp::BaseSemaphore< std::default_delete, std::default_delete > protected Host2HostSemaphore (Communicator &communicator, std::shared_ptr< Connection > connection)mscclpp::Host2HostSemaphore localInboundSemaphore_ mscclpp::BaseSemaphore< std::default_delete, std::default_delete > protected outboundSemaphore_ mscclpp::BaseSemaphore< std::default_delete, std::default_delete > protected poll ()mscclpp::Host2HostSemaphore remoteInboundSemaphoreIdsRegMem_ mscclpp::BaseSemaphore< std::default_delete, std::default_delete > protected signal ()mscclpp::Host2HostSemaphore wait (int64_t maxSpinCount=10000000)mscclpp::Host2HostSemaphore
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore.html b/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore.html
new file mode 100644
index 00000000..8d95cf78
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore.html
@@ -0,0 +1,260 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::Host2HostSemaphore Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A semaphore for sending signals from the local host to a remote host.
+ More...
+
+
#include <semaphore.hpp >
+
+
+
+
+
+ Host2HostSemaphore (Communicator &communicator, std::shared_ptr< Connection > connection ) std::shared_ptr< Connection > connection () void signal () Signal the remote host. More... bool poll () void wait (int64_t maxSpinCount=10000000) BaseSemaphore (std::unique_ptr< uint64_t, std::default_delete< uint64_t >> localInboundSemaphoreId, std::unique_ptr< uint64_t, std::default_delete< uint64_t >> expectedInboundSemaphoreId, std::unique_ptr< uint64_t, std::default_delete< uint64_t >> outboundSemaphoreId)
+
+
A semaphore for sending signals from the local host to a remote host.
+
+
+
◆
+
+
+
+
+
+ mscclpp::Host2HostSemaphore::Host2HostSemaphore
+ (
+ Communicator & communicator ,
+
+ std::shared_ptr< Connection >
+ connection
+
+ )
+
+
+
+
Constructor
Parameters
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ std::shared_ptr<Connection > mscclpp::Host2HostSemaphore::connection
+ (
+ )
+
+
+
+
Returns the connection.
Returns The connection associated with this semaphore.
+
+
+
+
+
◆
+
+
+
+
+
+ bool mscclpp::Host2HostSemaphore::poll
+ (
+ )
+
+
+
+
Check if the remote host has signaled.
Returns true if the remote host has signaled.
+
+
+
+
+
◆
+
+
+
+
+
+ void mscclpp::Host2HostSemaphore::signal
+ (
+ )
+
+
+
+
+
Signal the remote host.
+
+
+
+
+
◆
+
+
+
+
+
+ void mscclpp::Host2HostSemaphore::wait
+ (
+ int64_t
+ maxSpinCount = 10000000)
+
+
+
+
Wait for the remote host to signal.
Parameters
+
+ maxSpinCount The maximum number of spin counts before throwing an exception. Never throws if negative.
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore__coll__graph.map b/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore__coll__graph.map
new file mode 100644
index 00000000..102d324e
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore__coll__graph.map
@@ -0,0 +1,5 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore__coll__graph.md5 b/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore__coll__graph.md5
new file mode 100644
index 00000000..5dfa2e97
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore__coll__graph.md5
@@ -0,0 +1 @@
+937efcb48e2ac67ce2a12c0c49ce9d4f
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore__coll__graph.png b/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore__coll__graph.png
new file mode 100644
index 00000000..59b2a2d1
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore__coll__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore__inherit__graph.map b/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore__inherit__graph.map
new file mode 100644
index 00000000..a21db4e7
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore__inherit__graph.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore__inherit__graph.md5 b/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore__inherit__graph.md5
new file mode 100644
index 00000000..c4742ce1
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore__inherit__graph.md5
@@ -0,0 +1 @@
+1b82a49716e14e697c3552c93ce4ef15
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore__inherit__graph.png b/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore__inherit__graph.png
new file mode 100644
index 00000000..b32672f8
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1Host2HostSemaphore__inherit__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1IbError-members.html b/docs/doxygen/html/classmscclpp_1_1IbError-members.html
new file mode 100644
index 00000000..e6b75caa
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1IbError-members.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::IbError , including all inherited members.
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1IbError.html b/docs/doxygen/html/classmscclpp_1_1IbError.html
new file mode 100644
index 00000000..dba62d61
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1IbError.html
@@ -0,0 +1,196 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::IbError Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
An error from an ibverbs library call.
+ More...
+
+
#include <errors.hpp >
+
+
+
+
+
+
+
An error from an ibverbs library call.
+
+
+
◆
+
+
+
+
+
+ mscclpp::IbError::IbError
+ (
+ const std::string &
+ message ,
+
+ int
+ errorCode
+
+ )
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual mscclpp::IbError::~IbError
+ (
+ )
+
+
+
+
+virtual default
+
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1IbError__coll__graph.map b/docs/doxygen/html/classmscclpp_1_1IbError__coll__graph.map
new file mode 100644
index 00000000..30d288ce
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1IbError__coll__graph.map
@@ -0,0 +1,5 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1IbError__coll__graph.md5 b/docs/doxygen/html/classmscclpp_1_1IbError__coll__graph.md5
new file mode 100644
index 00000000..476efadc
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1IbError__coll__graph.md5
@@ -0,0 +1 @@
+16987c0e670335d7ead4e9220d42932f
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1IbError__coll__graph.png b/docs/doxygen/html/classmscclpp_1_1IbError__coll__graph.png
new file mode 100644
index 00000000..bec7cbe2
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1IbError__coll__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1IbError__inherit__graph.map b/docs/doxygen/html/classmscclpp_1_1IbError__inherit__graph.map
new file mode 100644
index 00000000..30d288ce
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1IbError__inherit__graph.map
@@ -0,0 +1,5 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1IbError__inherit__graph.md5 b/docs/doxygen/html/classmscclpp_1_1IbError__inherit__graph.md5
new file mode 100644
index 00000000..476efadc
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1IbError__inherit__graph.md5
@@ -0,0 +1 @@
+16987c0e670335d7ead4e9220d42932f
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1IbError__inherit__graph.png b/docs/doxygen/html/classmscclpp_1_1IbError__inherit__graph.png
new file mode 100644
index 00000000..bec7cbe2
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1IbError__inherit__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1NonblockingFuture-members.html b/docs/doxygen/html/classmscclpp_1_1NonblockingFuture-members.html
new file mode 100644
index 00000000..241ae92a
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1NonblockingFuture-members.html
@@ -0,0 +1,88 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::NonblockingFuture< T > , including all inherited members.
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1NonblockingFuture.html b/docs/doxygen/html/classmscclpp_1_1NonblockingFuture.html
new file mode 100644
index 00000000..86eb2b8d
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1NonblockingFuture.html
@@ -0,0 +1,240 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::NonblockingFuture< T > Class Template Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A non-blocking future that can be used to check if a value is ready and retrieve it.
+ More...
+
+
#include <core.hpp >
+
+
+
template<typename T>
+
+
A non-blocking future that can be used to check if a value is ready and retrieve it.
+
+
+
◆ [1/2]
+
+
+
+
+template<typename T >
+
+
+
+
Default constructor.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+template<typename T >
+
+
+
Constructor that takes a shared future and moves it into the NonblockingFuture .
+
Parameters
+
+ future The shared future to move.
+
+
+
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
Get the value.
+
Returns The value.
+
Exceptions
+
+ Error if the value is not ready.
+
+
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
Check if the value is ready to be retrieved.
+
Returns True if the value is ready, false otherwise.
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1NvlsConnection-members.html b/docs/doxygen/html/classmscclpp_1_1NvlsConnection-members.html
new file mode 100644
index 00000000..7937d0c2
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1NvlsConnection-members.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::NvlsConnection , including all inherited members.
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1NvlsConnection.html b/docs/doxygen/html/classmscclpp_1_1NvlsConnection.html
new file mode 100644
index 00000000..d35a2ada
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1NvlsConnection.html
@@ -0,0 +1,335 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::NvlsConnection Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <nvls.hpp >
+
+
+
+
◆ [1/3]
+
+
+
+
+
+ mscclpp::NvlsConnection::NvlsConnection
+ (
+ size_t
+ bufferSize ,
+
+ int
+ numDevices
+
+ )
+
+
+
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+ mscclpp::NvlsConnection::NvlsConnection
+ (
+ const std::vector< char > &
+ data )
+
+
+
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+
+
+
+ mscclpp::NvlsConnection::NvlsConnection
+ (
+ )
+
+
+
+
+delete
+
+
+
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void mscclpp::NvlsConnection::addDevice
+ (
+ )
+
+
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void mscclpp::NvlsConnection::addDevice
+ (
+ int
+ cudaDeviceId )
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ std::shared_ptr<DeviceMulticastPointer > mscclpp::NvlsConnection::allocateAndBindCuda
+ (
+ size_t
+ size )
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ std::shared_ptr<char> mscclpp::NvlsConnection::bindAllocatedCuda
+ (
+ CUmemGenericAllocationHandle
+ memHandle ,
+
+ size_t
+ size
+
+ )
+
+
+
+
The handle to the allocation (its lifetime is managed by the caller) and the size of the allocation.
+
+
+
+
+
◆
+
+
+
+
+
+ size_t mscclpp::NvlsConnection::getMultiCastMinGranularity
+ (
+ )
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ std::vector<char> mscclpp::NvlsConnection::serialize
+ (
+ )
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const int mscclpp::NvlsConnection::DefaultNvlsBufferSize
+
+
+
+
+static
+
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Proxy-members.html b/docs/doxygen/html/classmscclpp_1_1Proxy-members.html
new file mode 100644
index 00000000..5ad1c84b
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Proxy-members.html
@@ -0,0 +1,90 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::Proxy , including all inherited members.
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1Proxy.html b/docs/doxygen/html/classmscclpp_1_1Proxy.html
new file mode 100644
index 00000000..d60f9a18
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1Proxy.html
@@ -0,0 +1,238 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::Proxy Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <proxy.hpp >
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ mscclpp::Proxy::Proxy
+ (
+ ProxyHandler handler ,
+
+ std::function< void()>
+ threadInit ,
+
+ size_t
+ fifoSize = DEFAULT_FIFO_SIZE
+
+ )
+
+
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
◆
+
+
+
+
+
+ mscclpp::Proxy::~Proxy
+ (
+ )
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ Fifo & mscclpp::Proxy::fifo (
+ )
+
+
+
+
This is a concurrent fifo which is multiple threads from the device can produce for and the sole proxy thread consumes it.
Returns the fifo
+
+
+
+
+
◆
+
+
+
+
+
+ void mscclpp::Proxy::start
+ (
+ )
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void mscclpp::Proxy::stop
+ (
+ )
+
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1ProxyService-members.html b/docs/doxygen/html/classmscclpp_1_1ProxyService-members.html
new file mode 100644
index 00000000..dbb8d317
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1ProxyService-members.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::ProxyService , including all inherited members.
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1ProxyService.html b/docs/doxygen/html/classmscclpp_1_1ProxyService.html
new file mode 100644
index 00000000..0e5e1586
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1ProxyService.html
@@ -0,0 +1,355 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::ProxyService Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Proxy service implementation.
+ More...
+
+
#include <proxy_channel.hpp >
+
+
+
+
+
+
+
Proxy service implementation.
+
+
+
◆
+
+
+
+
+
+ mscclpp::ProxyService::ProxyService
+ (
+ size_t
+ fifoSize = DEFAULT_FIFO_SIZE )
+
+
+
+
+
+
+
◆
+
+
+
+
Register a memory region with the proxy service.
Parameters
+
+ memory The memory region to register.
+
+
+
Returns The ID of the memory region.
+
+
+
+
+
◆
+
+
+
+
Add a semaphore to the proxy service.
Parameters
+
+ semaphore The semaphore to be added
+
+
+
Returns The ID of the semaphore.
+
+
+
+
+
◆
+
+
+
+
+
+ SemaphoreId mscclpp::ProxyService::buildAndAddSemaphore (
+ Communicator & communicator ,
+
+ std::shared_ptr< Connection >
+ connection
+
+ )
+
+
+
+
Build and add a semaphore to the proxy service.
Parameters
+
+ connection The connection associated with the semaphore.
+
+
+
Returns The ID of the semaphore.
+
+
+
+
+
◆
+
+
+
+
Get a proxy channel by semaphore ID.
Parameters
+
+ id The ID of the semaphore.
+
+
+
Returns The proxy channel.
+
+
+
+
+
◆
+
+
+
+
Get a semaphore by ID.
Parameters
+
+ id The ID of the semaphore.
+
+
+
Returns The semaphore.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void mscclpp::ProxyService::startProxy
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void mscclpp::ProxyService::stopProxy
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1ProxyService__coll__graph.map b/docs/doxygen/html/classmscclpp_1_1ProxyService__coll__graph.map
new file mode 100644
index 00000000..4e496584
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1ProxyService__coll__graph.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1ProxyService__coll__graph.md5 b/docs/doxygen/html/classmscclpp_1_1ProxyService__coll__graph.md5
new file mode 100644
index 00000000..d2f81860
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1ProxyService__coll__graph.md5
@@ -0,0 +1 @@
+7bba2a4a19cfadf2c0b9d8ebece22c8c
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1ProxyService__coll__graph.png b/docs/doxygen/html/classmscclpp_1_1ProxyService__coll__graph.png
new file mode 100644
index 00000000..91d5446e
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1ProxyService__coll__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1ProxyService__inherit__graph.map b/docs/doxygen/html/classmscclpp_1_1ProxyService__inherit__graph.map
new file mode 100644
index 00000000..4e496584
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1ProxyService__inherit__graph.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1ProxyService__inherit__graph.md5 b/docs/doxygen/html/classmscclpp_1_1ProxyService__inherit__graph.md5
new file mode 100644
index 00000000..d2f81860
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1ProxyService__inherit__graph.md5
@@ -0,0 +1 @@
+7bba2a4a19cfadf2c0b9d8ebece22c8c
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1ProxyService__inherit__graph.png b/docs/doxygen/html/classmscclpp_1_1ProxyService__inherit__graph.png
new file mode 100644
index 00000000..91d5446e
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1ProxyService__inherit__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1RegisteredMemory-members.html b/docs/doxygen/html/classmscclpp_1_1RegisteredMemory-members.html
new file mode 100644
index 00000000..1d5ae49a
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1RegisteredMemory-members.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::RegisteredMemory , including all inherited members.
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1RegisteredMemory.html b/docs/doxygen/html/classmscclpp_1_1RegisteredMemory.html
new file mode 100644
index 00000000..197f0262
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1RegisteredMemory.html
@@ -0,0 +1,350 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::RegisteredMemory Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Represents a block of memory that has been registered to a Context .
+ More...
+
+
#include <core.hpp >
+
+
+
Represents a block of memory that has been registered to a Context .
+
+
+
◆
+
+
+
+
+
+
+
+
+ mscclpp::RegisteredMemory::RegisteredMemory
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆
+
+
+
+
+
+ mscclpp::RegisteredMemory::~RegisteredMemory
+ (
+ )
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void* mscclpp::RegisteredMemory::data
+ (
+ )
+ const
+
+
+
+
Get a pointer to the memory block.
+
Returns A pointer to the memory block.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static RegisteredMemory mscclpp::RegisteredMemory::deserialize
+ (
+ const std::vector< char > &
+ data )
+
+
+
+
+static
+
+
+
+
+
+
◆
+
+
+
+
+
+ void* mscclpp::RegisteredMemory::originalDataPtr
+ (
+ )
+ const
+
+
+
+
Get a pointer to the original memory block.
+
Returns A pointer to the original memory block.
+
+
+
+
+
◆
+
+
+
+
+
+ std::vector<char> mscclpp::RegisteredMemory::serialize
+ (
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ size_t mscclpp::RegisteredMemory::size
+ (
+ )
+
+
+
+
Get the size of the memory block.
+
Returns The size of the memory block.
+
+
+
+
+
◆
+
+
+
+
+
+ TransportFlags mscclpp::RegisteredMemory::transports (
+ )
+
+
+
+
Get the transport flags associated with the memory block.
+
Returns The transport flags associated with the memory block.
+
+
+
+
+
+
◆
+
+
+
+
◆
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore-members.html b/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore-members.html
new file mode 100644
index 00000000..985f9026
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore-members.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::SmDevice2DeviceSemaphore , including all inherited members.
+
+ BaseSemaphore (std::unique_ptr< uint64_t, CudaDeleter< uint64_t >> localInboundSemaphoreId, std::unique_ptr< uint64_t, CudaDeleter< uint64_t >> expectedInboundSemaphoreId, std::unique_ptr< uint64_t, CudaDeleter< uint64_t >> outboundSemaphoreId)mscclpp::BaseSemaphore< CudaDeleter, CudaDeleter > inline DeviceHandle typedefmscclpp::SmDevice2DeviceSemaphore deviceHandle () constmscclpp::SmDevice2DeviceSemaphore expectedInboundSemaphore_ mscclpp::BaseSemaphore< CudaDeleter, CudaDeleter > protected isRemoteInboundSemaphoreIdSet_ mscclpp::SmDevice2DeviceSemaphore localInboundSemaphore_ mscclpp::BaseSemaphore< CudaDeleter, CudaDeleter > protected outboundSemaphore_ mscclpp::BaseSemaphore< CudaDeleter, CudaDeleter > protected remoteInboundSemaphoreIdsRegMem_ mscclpp::BaseSemaphore< CudaDeleter, CudaDeleter > protected SmDevice2DeviceSemaphore (Communicator &communicator, std::shared_ptr< Connection > connection)mscclpp::SmDevice2DeviceSemaphore SmDevice2DeviceSemaphore ()=deletemscclpp::SmDevice2DeviceSemaphore
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore.html b/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore.html
new file mode 100644
index 00000000..85544aa0
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore.html
@@ -0,0 +1,269 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::SmDevice2DeviceSemaphore Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A semaphore for sending signals from the local device to a peer device via SM.
+ More...
+
+
#include <semaphore.hpp >
+
+
+
+
+
+
+
A semaphore for sending signals from the local device to a peer device via SM.
+
+
+
◆
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ mscclpp::SmDevice2DeviceSemaphore::SmDevice2DeviceSemaphore
+ (
+ Communicator & communicator ,
+
+ std::shared_ptr< Connection >
+ connection
+
+ )
+
+
+
+
Constructor.
Parameters
+
+ communicator The communicator. connection The connection associated with this semaphore.
+
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ mscclpp::SmDevice2DeviceSemaphore::SmDevice2DeviceSemaphore
+ (
+ )
+
+
+
+
+delete
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ DeviceHandle mscclpp::SmDevice2DeviceSemaphore::deviceHandle (
+ )
+ const
+
+
+
+
+
Returns the device-side handle.
+
+
+
+
+
+
◆
+
+
+
+
+
+ bool mscclpp::SmDevice2DeviceSemaphore::isRemoteInboundSemaphoreIdSet_
+
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore__coll__graph.map b/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore__coll__graph.map
new file mode 100644
index 00000000..7b1a5792
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore__coll__graph.map
@@ -0,0 +1,5 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore__coll__graph.md5 b/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore__coll__graph.md5
new file mode 100644
index 00000000..b33b4005
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore__coll__graph.md5
@@ -0,0 +1 @@
+cd416c4af929fa8d3004be253f201f8a
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore__coll__graph.png b/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore__coll__graph.png
new file mode 100644
index 00000000..494ca2da
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore__coll__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore__inherit__graph.map b/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore__inherit__graph.map
new file mode 100644
index 00000000..de448588
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore__inherit__graph.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore__inherit__graph.md5 b/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore__inherit__graph.md5
new file mode 100644
index 00000000..a7c4919b
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore__inherit__graph.md5
@@ -0,0 +1 @@
+04c547ba372127b300e0ba089babb9aa
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore__inherit__graph.png b/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore__inherit__graph.png
new file mode 100644
index 00000000..37aa6a4f
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1SmDevice2DeviceSemaphore__inherit__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1SysError-members.html b/docs/doxygen/html/classmscclpp_1_1SysError-members.html
new file mode 100644
index 00000000..885e19a8
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1SysError-members.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::SysError , including all inherited members.
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1SysError.html b/docs/doxygen/html/classmscclpp_1_1SysError.html
new file mode 100644
index 00000000..7970f6b8
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1SysError.html
@@ -0,0 +1,196 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::SysError Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
An error from a system call that sets errno.
+ More...
+
+
#include <errors.hpp >
+
+
+
+
+
+
+
An error from a system call that sets errno.
+
+
+
◆
+
+
+
+
+
+ mscclpp::SysError::SysError
+ (
+ const std::string &
+ message ,
+
+ int
+ errorCode
+
+ )
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual mscclpp::SysError::~SysError
+ (
+ )
+
+
+
+
+virtual default
+
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1SysError__coll__graph.map b/docs/doxygen/html/classmscclpp_1_1SysError__coll__graph.map
new file mode 100644
index 00000000..eaf00a2b
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1SysError__coll__graph.map
@@ -0,0 +1,5 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1SysError__coll__graph.md5 b/docs/doxygen/html/classmscclpp_1_1SysError__coll__graph.md5
new file mode 100644
index 00000000..736e4e90
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1SysError__coll__graph.md5
@@ -0,0 +1 @@
+bdd6ecd933aafa7e368eea2427e4d8aa
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1SysError__coll__graph.png b/docs/doxygen/html/classmscclpp_1_1SysError__coll__graph.png
new file mode 100644
index 00000000..53bc8d7c
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1SysError__coll__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1SysError__inherit__graph.map b/docs/doxygen/html/classmscclpp_1_1SysError__inherit__graph.map
new file mode 100644
index 00000000..eaf00a2b
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1SysError__inherit__graph.map
@@ -0,0 +1,5 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1SysError__inherit__graph.md5 b/docs/doxygen/html/classmscclpp_1_1SysError__inherit__graph.md5
new file mode 100644
index 00000000..736e4e90
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1SysError__inherit__graph.md5
@@ -0,0 +1 @@
+bdd6ecd933aafa7e368eea2427e4d8aa
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1SysError__inherit__graph.png b/docs/doxygen/html/classmscclpp_1_1SysError__inherit__graph.png
new file mode 100644
index 00000000..53bc8d7c
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1SysError__inherit__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1TcpBootstrap-members.html b/docs/doxygen/html/classmscclpp_1_1TcpBootstrap-members.html
new file mode 100644
index 00000000..2db61af9
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1TcpBootstrap-members.html
@@ -0,0 +1,102 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::TcpBootstrap , including all inherited members.
+
+ allGather (void *allData, int size) overridemscclpp::TcpBootstrap virtual barrier () overridemscclpp::TcpBootstrap virtual Bootstrap ()mscclpp::Bootstrap inline createUniqueId ()mscclpp::TcpBootstrap static getNranks () overridemscclpp::TcpBootstrap virtual getNranksPerNode () overridemscclpp::TcpBootstrap virtual getRank () overridemscclpp::TcpBootstrap virtual getUniqueId () constmscclpp::TcpBootstrap groupBarrier (const std::vector< int > &ranks)mscclpp::Bootstrap initialize (UniqueId uniqueId, int64_t timeoutSec=30)mscclpp::TcpBootstrap initialize (const std::string &ifIpPortTrio, int64_t timeoutSec=30)mscclpp::TcpBootstrap recv (void *data, int size, int peer, int tag) overridemscclpp::TcpBootstrap virtual mscclpp::Bootstrap::recv (std::vector< char > &data, int peer, int tag)mscclpp::Bootstrap send (void *data, int size, int peer, int tag) overridemscclpp::TcpBootstrap virtual mscclpp::Bootstrap::send (const std::vector< char > &data, int peer, int tag)mscclpp::Bootstrap TcpBootstrap (int rank, int nRanks)mscclpp::TcpBootstrap ~Bootstrap ()=defaultmscclpp::Bootstrap virtual ~TcpBootstrap ()mscclpp::TcpBootstrap
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1TcpBootstrap.html b/docs/doxygen/html/classmscclpp_1_1TcpBootstrap.html
new file mode 100644
index 00000000..61257725
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1TcpBootstrap.html
@@ -0,0 +1,617 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::TcpBootstrap Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A native implementation of the bootstrap using TCP sockets.
+ More...
+
+
#include <core.hpp >
+
+
+
+
+
+ TcpBootstrap (int rank, int nRanks) ~TcpBootstrap () Destructor. More... UniqueId getUniqueId () const void initialize (UniqueId uniqueId, int64_t timeoutSec=30) void initialize (const std::string &ifIpPortTrio, int64_t timeoutSec=30) int getRank () override Return the rank of the process. More... int getNranks () override Return the total number of ranks. More... int getNranksPerNode () override Return the total number of ranks per node. More... void send (void *data, int size, int peer, int tag) override void recv (void *data, int size, int peer, int tag) override void allGather (void *allData, int size) override void barrier () override Synchronize all processes. More... Bootstrap () virtual ~Bootstrap ()=default void groupBarrier (const std::vector< int > &ranks) void send (const std::vector< char > &data, int peer, int tag) void recv (std::vector< char > &data, int peer, int tag)
+
+
A native implementation of the bootstrap using TCP sockets.
+
+
+
◆
+
+
+
+
+
+ mscclpp::TcpBootstrap::TcpBootstrap
+ (
+ int
+ rank ,
+
+ int
+ nRanks
+
+ )
+
+
+
+
Constructor.
Parameters
+
+ rank The rank of the process. nRanks The total number of ranks.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ mscclpp::TcpBootstrap::~TcpBootstrap
+ (
+ )
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void mscclpp::TcpBootstrap::allGather
+ (
+ void *
+ allData ,
+
+ int
+ size
+
+ )
+
+
+
+
+override virtual
+
+
+
+
Gather data from all processes.
+
When called by rank r, this sends data from allData[r * size] to allData[(r + 1) * size - 1] to all other ranks. The data sent by rank r is received into allData[r * size] of other ranks.
+
Parameters
+
+ allData The buffer to write the received data to. size The size of the data each rank sends.
+
+
+
+
Implements mscclpp::Bootstrap .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void mscclpp::TcpBootstrap::barrier
+ (
+ )
+
+
+
+
+override virtual
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static UniqueId mscclpp::TcpBootstrap::createUniqueId
+ (
+ )
+
+
+
+
+static
+
+
+
+
Create a random unique ID.
Returns The created unique ID.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ int mscclpp::TcpBootstrap::getNranks
+ (
+ )
+
+
+
+
+override virtual
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ int mscclpp::TcpBootstrap::getNranksPerNode
+ (
+ )
+
+
+
+
+override virtual
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ int mscclpp::TcpBootstrap::getRank
+ (
+ )
+
+
+
+
+override virtual
+
+
+
+
+
+
◆
+
+
+
+
+
+ UniqueId mscclpp::TcpBootstrap::getUniqueId (
+ )
+ const
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void mscclpp::TcpBootstrap::initialize
+ (
+ const std::string &
+ ifIpPortTrio ,
+
+ int64_t
+ timeoutSec = 30
+
+ )
+
+
+
+
Initialize the TcpBootstrap with a string formatted as "ip:port" or "interface:ip:port".
Parameters
+
+ ifIpPortTrio The string formatted as "ip:port" or "interface:ip:port". timeoutSec The connection timeout in seconds.
+
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void mscclpp::TcpBootstrap::initialize
+ (
+ UniqueId uniqueId ,
+
+ int64_t
+ timeoutSec = 30
+
+ )
+
+
+
+
Initialize the TcpBootstrap with a given unique ID.
Parameters
+
+ uniqueId The unique ID to initialize the TcpBootstrap with. timeoutSec The connection timeout in seconds.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void mscclpp::TcpBootstrap::recv
+ (
+ void *
+ data ,
+
+ int
+ size ,
+
+ int
+ peer ,
+
+ int
+ tag
+
+ )
+
+
+
+
+override virtual
+
+
+
+
Receive data from another process.
+
Data sent via send(senderBuff, size, receiverRank, tag) can be received via recv(receiverBuff, size, senderRank, tag).
+
Parameters
+
+ data The buffer to write the received data to. size The size of the data to receive. peer The rank of the process to receive the data from. tag The tag to receive the data with.
+
+
+
+
Implements mscclpp::Bootstrap .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void mscclpp::TcpBootstrap::send
+ (
+ void *
+ data ,
+
+ int
+ size ,
+
+ int
+ peer ,
+
+ int
+ tag
+
+ )
+
+
+
+
+override virtual
+
+
+
+
Send data to another process.
+
Data sent via send(senderBuff, size, receiverRank, tag) can be received via recv(receiverBuff, size, senderRank, tag).
+
Parameters
+
+ data The data to send. size The size of the data to send. peer The rank of the process to send the data to. tag The tag to send the data with.
+
+
+
+
Implements mscclpp::Bootstrap .
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1TcpBootstrap__coll__graph.map b/docs/doxygen/html/classmscclpp_1_1TcpBootstrap__coll__graph.map
new file mode 100644
index 00000000..3deb4ed0
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1TcpBootstrap__coll__graph.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1TcpBootstrap__coll__graph.md5 b/docs/doxygen/html/classmscclpp_1_1TcpBootstrap__coll__graph.md5
new file mode 100644
index 00000000..e91a1f6d
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1TcpBootstrap__coll__graph.md5
@@ -0,0 +1 @@
+424cda039cbfa44eac60350994a6cda6
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1TcpBootstrap__coll__graph.png b/docs/doxygen/html/classmscclpp_1_1TcpBootstrap__coll__graph.png
new file mode 100644
index 00000000..f239eff1
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1TcpBootstrap__coll__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1TcpBootstrap__inherit__graph.map b/docs/doxygen/html/classmscclpp_1_1TcpBootstrap__inherit__graph.map
new file mode 100644
index 00000000..3deb4ed0
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1TcpBootstrap__inherit__graph.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1TcpBootstrap__inherit__graph.md5 b/docs/doxygen/html/classmscclpp_1_1TcpBootstrap__inherit__graph.md5
new file mode 100644
index 00000000..e91a1f6d
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1TcpBootstrap__inherit__graph.md5
@@ -0,0 +1 @@
+424cda039cbfa44eac60350994a6cda6
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1TcpBootstrap__inherit__graph.png b/docs/doxygen/html/classmscclpp_1_1TcpBootstrap__inherit__graph.png
new file mode 100644
index 00000000..f239eff1
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1TcpBootstrap__inherit__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1TransportFlags-members.html b/docs/doxygen/html/classmscclpp_1_1TransportFlags-members.html
new file mode 100644
index 00000000..09524640
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1TransportFlags-members.html
@@ -0,0 +1,104 @@
+
+
+
+
+
+
+
+
MSCCL++: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::TransportFlags , including all inherited members.
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1TransportFlags.html b/docs/doxygen/html/classmscclpp_1_1TransportFlags.html
new file mode 100644
index 00000000..c5c69093
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1TransportFlags.html
@@ -0,0 +1,637 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp::TransportFlags Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Stores transport flags.
+ More...
+
+
#include <core.hpp >
+
+
+
+
+
+
+
Stores transport flags.
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ mscclpp::TransportFlags::TransportFlags
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ mscclpp::TransportFlags::TransportFlags
+ (
+ Transport transport )
+
+
+
+
Constructor for TransportFlags that takes a Transport enum value.
+
Parameters
+
+ transport The transport to set the flag for.
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ bool mscclpp::TransportFlags::all
+ (
+ )
+ const
+
+
+
+
Check if all transport flags are set.
+
Returns True if all flags are set, false otherwise.
+
+
+
+
+
◆
+
+
+
+
+
+ bool mscclpp::TransportFlags::any
+ (
+ )
+ const
+
+
+
+
Check if any transport flags are set.
+
Returns True if any flags are set, false otherwise.
+
+
+
+
+
◆
+
+
+
+
+
+ size_t mscclpp::TransportFlags::count
+ (
+ )
+ const
+
+
+
+
Get the number of transport flags that are set.
+
Returns The number of flags that are set.
+
+
+
+
+
◆
+
+
+
+
+
+ bool mscclpp::TransportFlags::has
+ (
+ Transport transport )
+ const
+
+
+
+
Check if a specific transport flag is set.
+
Parameters
+
+ transport The transport to check the flag for.
+
+
+
Returns True if the flag is set, false otherwise.
+
+
+
+
+
◆
+
+
+
+
+
+ bool mscclpp::TransportFlags::none
+ (
+ )
+ const
+
+
+
+
Check if no transport flags are set.
+
Returns True if no flags are set, false otherwise.
+
+
+
+
+
◆
+
+
+
+
+
+ bool mscclpp::TransportFlags::operator!=
+ (
+ TransportFlags other )
+ const
+
+
+
+
Inequality comparison operator for TransportFlags .
+
Parameters
+
+
+
+
Returns True if the two TransportFlags objects are not equal, false otherwise.
+
+
+
+
+
◆ [1/2]
+
+
+
+
Bitwise AND operator for TransportFlags and Transport.
+
Parameters
+
+ transport The Transport to perform the AND operation with.
+
+
+
Returns A new TransportFlags object with the result of the AND operation.
+
+
+
+
+
◆ [2/2]
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
+
+ bool mscclpp::TransportFlags::operator==
+ (
+ TransportFlags other )
+ const
+
+
+
+
Equality comparison operator for TransportFlags .
+
Parameters
+
+
+
+
Returns True if the two TransportFlags objects are equal, false otherwise.
+
+
+
+
+
◆ [1/2]
+
+
+
+
Bitwise XOR operator for TransportFlags and Transport.
+
Parameters
+
+ transport The Transport to perform the XOR operation with.
+
+
+
Returns A new TransportFlags object with the result of the XOR operation.
+
+
+
+
+
◆ [2/2]
+
+
+
+
◆
+
+
+
+
◆ [1/2]
+
+
+
+
Bitwise OR operator for TransportFlags and Transport.
+
Parameters
+
+ transport The Transport to perform the OR operation with.
+
+
+
Returns A new TransportFlags object with the result of the OR operation.
+
+
+
+
+
◆ [2/2]
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
+
+ TransportFlags mscclpp::TransportFlags::operator~ (
+ )
+ const
+
+
+
+
+
+
◆
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1TransportFlags__coll__graph.map b/docs/doxygen/html/classmscclpp_1_1TransportFlags__coll__graph.map
new file mode 100644
index 00000000..170b527d
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1TransportFlags__coll__graph.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1TransportFlags__coll__graph.md5 b/docs/doxygen/html/classmscclpp_1_1TransportFlags__coll__graph.md5
new file mode 100644
index 00000000..f755423f
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1TransportFlags__coll__graph.md5
@@ -0,0 +1 @@
+6646afcf5b59cad6b5a0766cc4e2cb5a
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1TransportFlags__coll__graph.png b/docs/doxygen/html/classmscclpp_1_1TransportFlags__coll__graph.png
new file mode 100644
index 00000000..09a9eeba
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1TransportFlags__coll__graph.png differ
diff --git a/docs/doxygen/html/classmscclpp_1_1TransportFlags__inherit__graph.map b/docs/doxygen/html/classmscclpp_1_1TransportFlags__inherit__graph.map
new file mode 100644
index 00000000..170b527d
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1TransportFlags__inherit__graph.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/classmscclpp_1_1TransportFlags__inherit__graph.md5 b/docs/doxygen/html/classmscclpp_1_1TransportFlags__inherit__graph.md5
new file mode 100644
index 00000000..f755423f
--- /dev/null
+++ b/docs/doxygen/html/classmscclpp_1_1TransportFlags__inherit__graph.md5
@@ -0,0 +1 @@
+6646afcf5b59cad6b5a0766cc4e2cb5a
\ No newline at end of file
diff --git a/docs/doxygen/html/classmscclpp_1_1TransportFlags__inherit__graph.png b/docs/doxygen/html/classmscclpp_1_1TransportFlags__inherit__graph.png
new file mode 100644
index 00000000..09a9eeba
Binary files /dev/null and b/docs/doxygen/html/classmscclpp_1_1TransportFlags__inherit__graph.png differ
diff --git a/docs/doxygen/html/closed.png b/docs/doxygen/html/closed.png
new file mode 100644
index 00000000..98cc2c90
Binary files /dev/null and b/docs/doxygen/html/closed.png differ
diff --git a/docs/doxygen/html/concurrency__device_8hpp.html b/docs/doxygen/html/concurrency__device_8hpp.html
new file mode 100644
index 00000000..1e7fa2c2
--- /dev/null
+++ b/docs/doxygen/html/concurrency__device_8hpp.html
@@ -0,0 +1,111 @@
+
+
+
+
+
+
+
+
MSCCL++: concurrency_device.hpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/concurrency__device_8hpp__incl.map b/docs/doxygen/html/concurrency__device_8hpp__incl.map
new file mode 100644
index 00000000..397ce777
--- /dev/null
+++ b/docs/doxygen/html/concurrency__device_8hpp__incl.map
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/doxygen/html/concurrency__device_8hpp__incl.md5 b/docs/doxygen/html/concurrency__device_8hpp__incl.md5
new file mode 100644
index 00000000..8853d8a1
--- /dev/null
+++ b/docs/doxygen/html/concurrency__device_8hpp__incl.md5
@@ -0,0 +1 @@
+998d7ffbcd91ca088f3aafcf203b2de9
\ No newline at end of file
diff --git a/docs/doxygen/html/concurrency__device_8hpp__incl.png b/docs/doxygen/html/concurrency__device_8hpp__incl.png
new file mode 100644
index 00000000..25fc0be9
Binary files /dev/null and b/docs/doxygen/html/concurrency__device_8hpp__incl.png differ
diff --git a/docs/doxygen/html/concurrency__device_8hpp_source.html b/docs/doxygen/html/concurrency__device_8hpp_source.html
new file mode 100644
index 00000000..36777f95
--- /dev/null
+++ b/docs/doxygen/html/concurrency__device_8hpp_source.html
@@ -0,0 +1,135 @@
+
+
+
+
+
+
+
+
MSCCL++: concurrency_device.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_CONCURRENCY_DEVICE_HPP_
+
5 #define MSCCLPP_CONCURRENCY_DEVICE_HPP_
+
+
+
+
+
+
+
+
+
+
+
+
+
21 #if defined(MSCCLPP_DEVICE_COMPILE)
+
22 MSCCLPP_DEVICE_INLINE
void sync(
int blockNum, int64_t maxSpinCount = 100000000) {
+
27 unsigned int maxOldCnt = blockNum - 1;
+
+
29 if (blockNum == 1)
return ;
+
30 if (threadIdx.x == 0) {
+
+
+
33 unsigned int tmp = preFlag_ ^ 1;
+
34 if (atomicInc(&count_, maxOldCnt) == maxOldCnt) {
+
35 atomicStore(&flag_, tmp, memoryOrderRelaxed);
+
+
37 POLL_MAYBE_JAILBREAK((atomicLoad(&flag_, memoryOrderRelaxed) != tmp), maxSpinCount);
+
+
+
+
+
+
+
+
45 #endif // !defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
+
+
53 unsigned int preFlag_;
+
+
+
+
+
58 #endif // MSCCLPP_CONCURRENCY_DEVICE_HPP_
+
+
DeviceSyncer()=default
Construct a new DeviceSyncer object.
+
~DeviceSyncer()=default
Destroy the DeviceSyncer object.
+
+
+
A device-wide barrier.
Definition: concurrency_device.hpp:13
+
Definition: atomic_device.hpp:13
+
+
+
+
diff --git a/docs/doxygen/html/core_8hpp.html b/docs/doxygen/html/core_8hpp.html
new file mode 100644
index 00000000..d70967b2
--- /dev/null
+++ b/docs/doxygen/html/core_8hpp.html
@@ -0,0 +1,341 @@
+
+
+
+
+
+
+
+
MSCCL++: core.hpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <array>
+
#include <bitset>
+
#include <future>
+
#include <memory>
+
#include <mscclpp/gpu.hpp >
+
#include <mscclpp/gpu_utils.hpp >
+
#include <string>
+
#include <vector>
+
#include "errors.hpp "
+
+
+
+
+
+
+
+
Go to the source code of this file.
+
+enum mscclpp::Transport { mscclpp::Transport::Unknown ,
+mscclpp::Transport::CudaIpc ,
+mscclpp::Transport::Nvls ,
+mscclpp::Transport::IB0 ,
+mscclpp::Transport::IB1 ,
+mscclpp::Transport::IB2 ,
+mscclpp::Transport::IB3 ,
+mscclpp::Transport::IB4 ,
+mscclpp::Transport::IB5 ,
+mscclpp::Transport::IB6 ,
+mscclpp::Transport::IB7 ,
+mscclpp::Transport::Ethernet ,
+mscclpp::Transport::NumTransports
+ Enumerates the available transport types. More...
+
+
+
◆
+
+
+
+
+
+ #define MSCCLPP_MAJOR 0
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define MSCCLPP_MINOR 5
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define MSCCLPP_PATCH 2
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define MSCCLPP_UNIQUE_ID_BYTES 128
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/core_8hpp__dep__incl.map b/docs/doxygen/html/core_8hpp__dep__incl.map
new file mode 100644
index 00000000..b3ef6984
--- /dev/null
+++ b/docs/doxygen/html/core_8hpp__dep__incl.map
@@ -0,0 +1,7 @@
+
+
diff --git a/docs/doxygen/html/core_8hpp__dep__incl.md5 b/docs/doxygen/html/core_8hpp__dep__incl.md5
new file mode 100644
index 00000000..826e594e
--- /dev/null
+++ b/docs/doxygen/html/core_8hpp__dep__incl.md5
@@ -0,0 +1 @@
+0a219f4cd2c4237ecc7d63332d1c87fd
\ No newline at end of file
diff --git a/docs/doxygen/html/core_8hpp__dep__incl.png b/docs/doxygen/html/core_8hpp__dep__incl.png
new file mode 100644
index 00000000..33d01227
Binary files /dev/null and b/docs/doxygen/html/core_8hpp__dep__incl.png differ
diff --git a/docs/doxygen/html/core_8hpp__incl.map b/docs/doxygen/html/core_8hpp__incl.map
new file mode 100644
index 00000000..11005e6a
--- /dev/null
+++ b/docs/doxygen/html/core_8hpp__incl.map
@@ -0,0 +1,17 @@
+
+
diff --git a/docs/doxygen/html/core_8hpp__incl.md5 b/docs/doxygen/html/core_8hpp__incl.md5
new file mode 100644
index 00000000..e02f37f6
--- /dev/null
+++ b/docs/doxygen/html/core_8hpp__incl.md5
@@ -0,0 +1 @@
+eb616f6d5fcb90a04efc0a75128e151d
\ No newline at end of file
diff --git a/docs/doxygen/html/core_8hpp__incl.png b/docs/doxygen/html/core_8hpp__incl.png
new file mode 100644
index 00000000..22813226
Binary files /dev/null and b/docs/doxygen/html/core_8hpp__incl.png differ
diff --git a/docs/doxygen/html/core_8hpp_source.html b/docs/doxygen/html/core_8hpp_source.html
new file mode 100644
index 00000000..1a5ad1ee
--- /dev/null
+++ b/docs/doxygen/html/core_8hpp_source.html
@@ -0,0 +1,604 @@
+
+
+
+
+
+
+
+
MSCCL++: core.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_CORE_HPP_
+
5 #define MSCCLPP_CORE_HPP_
+
+
7 #define MSCCLPP_MAJOR 0
+
8 #define MSCCLPP_MINOR 5
+
9 #define MSCCLPP_PATCH 2
+
10 #define MSCCLPP_VERSION (MSCCLPP_MAJOR * 10000 + MSCCLPP_MINOR * 100 + MSCCLPP_PATCH)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
25 #define MSCCLPP_UNIQUE_ID_BYTES 128
+
+
28 using UniqueId = std::array<uint8_t, MSCCLPP_UNIQUE_ID_BYTES>;
+
+
+
+
+
+
+
+
+
+
+
41 virtual void send (
void * data,
int size,
int peer,
int tag) = 0;
+
42 virtual void recv (
void * data,
int size,
int peer,
int tag) = 0;
+
43 virtual void allGather (
void * allData,
int size) = 0;
+
+
+
+
47 void send (
const std::vector<char>& data,
int peer,
int tag);
+
48 void recv (std::vector<char>& data,
int peer,
int tag);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
78 void initialize (
const std::string& ifIpPortTrio, int64_t timeoutSec = 30);
+
+
+
+
+
+
+
+
98 void send (
void * data,
int size,
int peer,
int tag)
override ;
+
+
109 void recv (
void * data,
int size,
int peer,
int tag)
override ;
+
+
118 void allGather (
void * allData,
int size)
override ;
+
+
+
+
+
+
+
+
+
128 std::unique_ptr<Impl> pimpl_;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
148 const std::string
TransportNames [] = {
"UNK" ,
"IPC" ,
"NVLS" ,
"IB0" ,
"IB1" ,
"IB2" ,
"IB3" ,
+
149 "IB4" ,
"IB5" ,
"IB6" ,
"IB7" ,
"ETH" ,
"NUM" };
+
+
+
+
+
154 "TransportFlagsSize must match the number of transports" );
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
194 size_t count ()
const ;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
374 std::shared_ptr<Impl> pimpl_;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
407 Endpoint (std::shared_ptr<Impl> pimpl);
+
+
+
410 std::shared_ptr<Impl> pimpl_;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
440 virtual void flush (int64_t timeoutUsec = 3e7) = 0;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
537 std::unique_ptr<Impl> pimpl_;
+
+
+
+
+
+
+
+
+
551 virtual void beginSetup (std::shared_ptr<Bootstrap> bootstrap);
+
+
557 virtual void endSetup (std::shared_ptr<Bootstrap> bootstrap);
+
+
+
561 template <
typename T>
+
+
563 std::shared_future<T> future;
+
+
+
+
+
+
+
577 bool ready ()
const {
return future.wait_for(std::chrono::seconds(0)) == std::future_status::ready; }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
621 std::shared_ptr<Context>
context ();
+
+
+
+
+
+
+
+
+
+
+
+
+
+
681 void onSetup (std::shared_ptr<Setuppable> setuppable);
+
+
+
+
+
+
+
+
+
695 std::unique_ptr<Impl> pimpl_;
+
+
+
+
+
+
+
+
+
+
+
+
712 template <
typename T>
+
+
714 return t.deviceHandle();
+
+
+
+
+
+
+
+
+
+
+
727 struct hash<
mscclpp ::TransportFlags>;
+
+
+
+
731 #endif // MSCCLPP_CORE_HPP_
+
+
typename T::DeviceHandle DeviceHandle
A type which could be safely used in device side.
Definition: core.hpp:709
+
TransportFlags operator^(Transport transport1, Transport transport2)
Definition: core.hpp:302
+
+
+
TransportFlags operator^(TransportFlags other) const
+
virtual ~Connection()=default
+
~TcpBootstrap()
Destructor.
+
+
std::string getIBDeviceName(Transport ibTransport)
+
RegisteredMemory registerMemory(void *ptr, size_t size, TransportFlags transports)
+
RegisteredMemory()=default
Default constructor.
+
+
void sendMemoryOnSetup(RegisteredMemory memory, int remoteRank, int tag)
+
const TransportFlags AllTransports
A constant TransportFlags object representing all transports.
+
+
T get() const
Definition: core.hpp:584
+
TransportFlags transports()
+
DeviceHandle< std::remove_reference_t< T > > deviceHandle(T &&t)
Retrieve the deviceHandle instance from host object.
Definition: core.hpp:713
+
Represents one end of a connection.
Definition: core.hpp:381
+
virtual void updateAndSync(RegisteredMemory dst, uint64_t dstOffset, uint64_t *src, uint64_t newValue)=0
+
+
Used to configure an endpoint.
Definition: core.hpp:464
+
void send(void *data, int size, int peer, int tag) override
+
void onSetup(std::shared_ptr< Setuppable > setuppable)
+
void allGather(void *allData, int size) override
+
+
std::shared_ptr< Connection > connect(Endpoint localEndpoint, Endpoint remoteEndpoint)
+
typename T::Payload PacketPayload
Packet value type.
Definition: core.hpp:719
+
Endpoint()=default
Default constructor.
+
A base class for objects that can be set up during Communicator::setup().
Definition: core.hpp:544
+
+
static const int DefaultMaxWrPerSend
Definition: core.hpp:468
+
int ibMaxSendWr
Definition: core.hpp:473
+
UniqueId getUniqueId() const
+
+
TransportFlags operator|(Transport transport1, Transport transport2)
Definition: core.hpp:284
+
void barrier() override
Synchronize all processes.
+
static Endpoint deserialize(const std::vector< char > &data)
+
virtual void send(void *data, int size, int peer, int tag)=0
+
virtual void allGather(void *allData, int size)=0
+
virtual void recv(void *data, int size, int peer, int tag)=0
+
int getRank() override
Return the rank of the process.
+
void recv(void *data, int size, int peer, int tag) override
+
+
bool ready() const
Definition: core.hpp:577
+
const TransportFlags AllIBTransports
A constant TransportFlags object representing all InfiniBand transports.
+
+
+
+
+
NonblockingFuture< std::shared_ptr< Connection > > connectOnSetup(int remoteRank, int tag, EndpointConfig localConfig)
+
TcpBootstrap(int rank, int nRanks)
+
+
virtual Transport remoteTransport()=0
+
TransportFlags operator&(TransportFlags other) const
+
std::string getTransportName()
+
EndpointConfig()
Default constructor. Sets transport to Transport::Unknown.
Definition: core.hpp:477
+
virtual Transport transport()=0
+
NonblockingFuture()=default
Default constructor.
+
~RegisteredMemory()
Destructor.
+
TransportFlags & operator&=(TransportFlags other)
+
+
void * originalDataPtr() const
+
Stores transport flags.
Definition: core.hpp:160
+
int tagOf(const Connection &connection)
+
Represents a connection between two processes.
Definition: core.hpp:417
+
+
+
TransportFlags & operator^=(TransportFlags other)
+
virtual void beginSetup(std::shared_ptr< Bootstrap > bootstrap)
+
TransportFlags operator&(Transport transport1, Transport transport2)
Definition: core.hpp:293
+
NonblockingFuture< RegisteredMemory > recvMemoryOnSetup(int remoteRank, int tag)
+
static std::shared_ptr< RegisteredMemory::Impl > getImpl(RegisteredMemory &memory)
+
TransportFlags & operator|=(TransportFlags other)
+
A non-blocking future that can be used to check if a value is ready and retrieve it.
Definition: core.hpp:562
+
std::vector< char > serialize()
+
std::array< uint8_t, MSCCLPP_UNIQUE_ID_BYTES > UniqueId
Unique ID for a process. This is a MSCCLPP_UNIQUE_ID_BYTES byte array that uniquely identifies a proc...
Definition: core.hpp:28
+
+
+
Transport getIBTransportByDeviceName(const std::string &ibDeviceName)
+
static const int DefaultMaxSendWr
Definition: core.hpp:467
+
+
virtual void endSetup(std::shared_ptr< Bootstrap > bootstrap)
+
virtual int getNranks()=0
+
~Communicator()
Destroy the communicator.
+
static const int DefaultMaxCqSize
Definition: core.hpp:465
+
void initialize(UniqueId uniqueId, int64_t timeoutSec=30)
+
+
+
EndpointConfig(Transport transport)
Definition: core.hpp:482
+
TransportFlags()=default
Default constructor for TransportFlags.
+
+
TransportFlags operator~() const
+
std::vector< char > serialize()
+
int remoteRankOf(const Connection &connection)
+
+
~Context()
Destroy the context.
+
Context()
Create a context.
+
virtual ~Bootstrap()=default
+
std::shared_ptr< Context > context()
+
static RegisteredMemory deserialize(const std::vector< char > &data)
+
std::string version()
Return a version string.
+
int ibMaxCqPollNum
Definition: core.hpp:472
+
const TransportFlags NoTransports
A constant TransportFlags object representing no transports.
+
const size_t TransportFlagsSize
Definition: core.hpp:152
+
virtual void write(RegisteredMemory dst, uint64_t dstOffset, RegisteredMemory src, uint64_t srcOffset, uint64_t size)=0
+
Transport transport
Definition: core.hpp:470
+
std::bitset< TransportFlagsSize > TransportFlagsBase
Bitset for storing transport flags.
Definition: core.hpp:156
+
const std::string TransportNames[]
Definition: core.hpp:148
+
A native implementation of the bootstrap using TCP sockets.
Definition: core.hpp:52
+
NonblockingFuture(std::shared_future< T > &&future)
Definition: core.hpp:572
+
Represents a block of memory that has been registered to a Context.
Definition: core.hpp:327
+
+
bool has(Transport transport) const
+
Bootstrap()
Definition: core.hpp:36
+
int ibMaxWrPerSend
Definition: core.hpp:474
+
void groupBarrier(const std::vector< int > &ranks)
+
+
int ibMaxCqSize
Definition: core.hpp:471
+
+
detail::TransportFlagsBase toBitset() const
+
bool operator==(TransportFlags other) const
+
Transport
Enumerates the available transport types.
Definition: core.hpp:132
+
int getNranks() override
Return the total number of ranks.
+
Communicator(std::shared_ptr< Bootstrap > bootstrap, std::shared_ptr< Context > context=nullptr)
+
A generic error.
Definition: errors.hpp:61
+
+
Base class for bootstraps.
Definition: core.hpp:34
+
bool operator!=(TransportFlags other) const
+
static const int DefaultMaxCqPollNum
Definition: core.hpp:466
+
+
int getNranksPerNode() override
Return the total number of ranks per node.
+
Endpoint createEndpoint(EndpointConfig config)
+
static UniqueId createUniqueId()
+
virtual ~Setuppable()=default
+
std::shared_ptr< Bootstrap > bootstrap()
+
TransportFlags operator|(TransportFlags other) const
+
RegisteredMemory registerMemory(void *ptr, size_t size, TransportFlags transports)
+
virtual void flush(int64_t timeoutUsec=3e7)=0
Flush any pending writes to the remote process.
+
virtual int getNranksPerNode()=0
+
Definition: atomic_device.hpp:13
+
+
+
+
+
diff --git a/docs/doxygen/html/device_8hpp.html b/docs/doxygen/html/device_8hpp.html
new file mode 100644
index 00000000..59e3e409
--- /dev/null
+++ b/docs/doxygen/html/device_8hpp.html
@@ -0,0 +1,146 @@
+
+
+
+
+
+
+
+
MSCCL++: device.hpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the source code of this file.
+
+
+
+
◆
+
+
+
+
+
+ #define MSCCLPP_HOST_COMPILE
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define MSCCLPP_HOST_DEVICE_INLINE inline
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/device_8hpp__dep__incl.map b/docs/doxygen/html/device_8hpp__dep__incl.map
new file mode 100644
index 00000000..e1032b27
--- /dev/null
+++ b/docs/doxygen/html/device_8hpp__dep__incl.map
@@ -0,0 +1,19 @@
+
+
diff --git a/docs/doxygen/html/device_8hpp__dep__incl.md5 b/docs/doxygen/html/device_8hpp__dep__incl.md5
new file mode 100644
index 00000000..2a4c0728
--- /dev/null
+++ b/docs/doxygen/html/device_8hpp__dep__incl.md5
@@ -0,0 +1 @@
+66105dd0cb6644faf7f7b279d25adda8
\ No newline at end of file
diff --git a/docs/doxygen/html/device_8hpp__dep__incl.png b/docs/doxygen/html/device_8hpp__dep__incl.png
new file mode 100644
index 00000000..232ac53e
Binary files /dev/null and b/docs/doxygen/html/device_8hpp__dep__incl.png differ
diff --git a/docs/doxygen/html/device_8hpp_source.html b/docs/doxygen/html/device_8hpp_source.html
new file mode 100644
index 00000000..f6219b42
--- /dev/null
+++ b/docs/doxygen/html/device_8hpp_source.html
@@ -0,0 +1,110 @@
+
+
+
+
+
+
+
+
MSCCL++: device.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_DEVICE_HPP_
+
5 #define MSCCLPP_DEVICE_HPP_
+
+
7 #if defined(__HIP_PLATFORM_AMD__)
+
8 #include <hip/hip_runtime.h>
+
9 #endif // defined(__HIP_PLATFORM_AMD__)
+
+
11 #if (defined(__NVCC__) || defined(__HIP_PLATFORM_AMD__))
+
+
13 #define MSCCLPP_DEVICE_COMPILE
+
14 #define MSCCLPP_DEVICE_INLINE __forceinline__ __device__
+
15 #define MSCCLPP_HOST_DEVICE_INLINE __forceinline__ __host__ __device__
+
16 #if defined(__HIP_PLATFORM_AMD__)
+
17 #define MSCCLPP_DEVICE_HIP
+
18 #else // !(defined(__HIP_PLATFORM_AMD__)
+
19 #define MSCCLPP_DEVICE_CUDA
+
20 #endif // !(defined(__HIP_PLATFORM_AMD__))
+
+
22 #else // !(defined(__NVCC__) || defined(__HIP_PLATFORM_AMD__))
+
+
24 #define MSCCLPP_HOST_COMPILE
+
25 #define MSCCLPP_HOST_DEVICE_INLINE inline
+
+
27 #endif // !(defined(__NVCC__) || defined(__HIP_PLATFORM_AMD__))
+
+
29 #endif // MSCCLPP_DEVICE_HPP_
+
+
+
+
+
diff --git a/docs/doxygen/html/dir_5b58d9d970ef29bd3b9d7292e7628c41.html b/docs/doxygen/html/dir_5b58d9d970ef29bd3b9d7292e7628c41.html
new file mode 100644
index 00000000..4f7e0e9c
--- /dev/null
+++ b/docs/doxygen/html/dir_5b58d9d970ef29bd3b9d7292e7628c41.html
@@ -0,0 +1,146 @@
+
+
+
+
+
+
+
+
MSCCL++: mscclpp Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/dir_5b58d9d970ef29bd3b9d7292e7628c41_dep.map b/docs/doxygen/html/dir_5b58d9d970ef29bd3b9d7292e7628c41_dep.map
new file mode 100644
index 00000000..5e49fc7e
--- /dev/null
+++ b/docs/doxygen/html/dir_5b58d9d970ef29bd3b9d7292e7628c41_dep.map
@@ -0,0 +1,5 @@
+
+
diff --git a/docs/doxygen/html/dir_5b58d9d970ef29bd3b9d7292e7628c41_dep.md5 b/docs/doxygen/html/dir_5b58d9d970ef29bd3b9d7292e7628c41_dep.md5
new file mode 100644
index 00000000..45660a39
--- /dev/null
+++ b/docs/doxygen/html/dir_5b58d9d970ef29bd3b9d7292e7628c41_dep.md5
@@ -0,0 +1 @@
+236e113fab0d19e1f3c6128a859f1c84
\ No newline at end of file
diff --git a/docs/doxygen/html/dir_5b58d9d970ef29bd3b9d7292e7628c41_dep.png b/docs/doxygen/html/dir_5b58d9d970ef29bd3b9d7292e7628c41_dep.png
new file mode 100644
index 00000000..4822c5e7
Binary files /dev/null and b/docs/doxygen/html/dir_5b58d9d970ef29bd3b9d7292e7628c41_dep.png differ
diff --git a/docs/doxygen/html/dir_79cdab046adb8bd4bd5d2d3af1d20704.html b/docs/doxygen/html/dir_79cdab046adb8bd4bd5d2d3af1d20704.html
new file mode 100644
index 00000000..780d9cc6
--- /dev/null
+++ b/docs/doxygen/html/dir_79cdab046adb8bd4bd5d2d3af1d20704.html
@@ -0,0 +1,100 @@
+
+
+
+
+
+
+
+
MSCCL++: npkit Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/dir_79cdab046adb8bd4bd5d2d3af1d20704_dep.map b/docs/doxygen/html/dir_79cdab046adb8bd4bd5d2d3af1d20704_dep.map
new file mode 100644
index 00000000..bbbd89a5
--- /dev/null
+++ b/docs/doxygen/html/dir_79cdab046adb8bd4bd5d2d3af1d20704_dep.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/dir_79cdab046adb8bd4bd5d2d3af1d20704_dep.md5 b/docs/doxygen/html/dir_79cdab046adb8bd4bd5d2d3af1d20704_dep.md5
new file mode 100644
index 00000000..668734cc
--- /dev/null
+++ b/docs/doxygen/html/dir_79cdab046adb8bd4bd5d2d3af1d20704_dep.md5
@@ -0,0 +1 @@
+2d78061c7e17ef3de586c587d7de2ee9
\ No newline at end of file
diff --git a/docs/doxygen/html/dir_79cdab046adb8bd4bd5d2d3af1d20704_dep.png b/docs/doxygen/html/dir_79cdab046adb8bd4bd5d2d3af1d20704_dep.png
new file mode 100644
index 00000000..7671985f
Binary files /dev/null and b/docs/doxygen/html/dir_79cdab046adb8bd4bd5d2d3af1d20704_dep.png differ
diff --git a/docs/doxygen/html/dir_d44c64559bbebec7f509842c48db8b23.html b/docs/doxygen/html/dir_d44c64559bbebec7f509842c48db8b23.html
new file mode 100644
index 00000000..b08d5d01
--- /dev/null
+++ b/docs/doxygen/html/dir_d44c64559bbebec7f509842c48db8b23.html
@@ -0,0 +1,87 @@
+
+
+
+
+
+
+
+
MSCCL++: include Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/doc.png b/docs/doxygen/html/doc.png
new file mode 100644
index 00000000..17edabff
Binary files /dev/null and b/docs/doxygen/html/doc.png differ
diff --git a/docs/doxygen/html/doxygen.css b/docs/doxygen/html/doxygen.css
new file mode 100644
index 00000000..73ecbb2c
--- /dev/null
+++ b/docs/doxygen/html/doxygen.css
@@ -0,0 +1,1771 @@
+/* The standard CSS for doxygen 1.8.17 */
+
+body, table, div, p, dl {
+ font: 400 14px/22px Roboto,sans-serif;
+}
+
+p.reference, p.definition {
+ font: 400 14px/22px Roboto,sans-serif;
+}
+
+/* @group Heading Levels */
+
+h1.groupheader {
+ font-size: 150%;
+}
+
+.title {
+ font: 400 14px/28px Roboto,sans-serif;
+ font-size: 150%;
+ font-weight: bold;
+ margin: 10px 2px;
+}
+
+h2.groupheader {
+ border-bottom: 1px solid #879ECB;
+ color: #354C7B;
+ font-size: 150%;
+ font-weight: normal;
+ margin-top: 1.75em;
+ padding-top: 8px;
+ padding-bottom: 4px;
+ width: 100%;
+}
+
+h3.groupheader {
+ font-size: 100%;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ -webkit-transition: text-shadow 0.5s linear;
+ -moz-transition: text-shadow 0.5s linear;
+ -ms-transition: text-shadow 0.5s linear;
+ -o-transition: text-shadow 0.5s linear;
+ transition: text-shadow 0.5s linear;
+ margin-right: 15px;
+}
+
+h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow {
+ text-shadow: 0 0 15px cyan;
+}
+
+dt {
+ font-weight: bold;
+}
+
+ul.multicol {
+ -moz-column-gap: 1em;
+ -webkit-column-gap: 1em;
+ column-gap: 1em;
+ -moz-column-count: 3;
+ -webkit-column-count: 3;
+ column-count: 3;
+}
+
+p.startli, p.startdd {
+ margin-top: 2px;
+}
+
+th p.starttd, p.intertd, p.endtd {
+ font-size: 100%;
+ font-weight: 700;
+}
+
+p.starttd {
+ margin-top: 0px;
+}
+
+p.endli {
+ margin-bottom: 0px;
+}
+
+p.enddd {
+ margin-bottom: 4px;
+}
+
+p.endtd {
+ margin-bottom: 2px;
+}
+
+p.interli {
+}
+
+p.interdd {
+}
+
+p.intertd {
+}
+
+/* @end */
+
+caption {
+ font-weight: bold;
+}
+
+span.legend {
+ font-size: 70%;
+ text-align: center;
+}
+
+h3.version {
+ font-size: 90%;
+ text-align: center;
+}
+
+div.qindex, div.navtab{
+ background-color: #EBEFF6;
+ border: 1px solid #A3B4D7;
+ text-align: center;
+}
+
+div.qindex, div.navpath {
+ width: 100%;
+ line-height: 140%;
+}
+
+div.navtab {
+ margin-right: 15px;
+}
+
+/* @group Link Styling */
+
+a {
+ color: #3D578C;
+ font-weight: normal;
+ text-decoration: none;
+}
+
+.contents a:visited {
+ color: #4665A2;
+}
+
+a:hover {
+ text-decoration: underline;
+}
+
+a.qindex {
+ font-weight: bold;
+}
+
+a.qindexHL {
+ font-weight: bold;
+ background-color: #9CAFD4;
+ color: #FFFFFF;
+ border: 1px double #869DCA;
+}
+
+.contents a.qindexHL:visited {
+ color: #FFFFFF;
+}
+
+a.el {
+ font-weight: bold;
+}
+
+a.elRef {
+}
+
+a.code, a.code:visited, a.line, a.line:visited {
+ color: #4665A2;
+}
+
+a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited {
+ color: #4665A2;
+}
+
+/* @end */
+
+dl.el {
+ margin-left: -1cm;
+}
+
+ul {
+ overflow: hidden; /*Fixed: list item bullets overlap floating elements*/
+}
+
+#side-nav ul {
+ overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */
+}
+
+#main-nav ul {
+ overflow: visible; /* reset ul rule for the navigation bar drop down lists */
+}
+
+.fragment {
+ text-align: left;
+ direction: ltr;
+ overflow-x: auto; /*Fixed: fragment lines overlap floating elements*/
+ overflow-y: hidden;
+}
+
+pre.fragment {
+ border: 1px solid #C4CFE5;
+ background-color: #FBFCFD;
+ padding: 4px 6px;
+ margin: 4px 8px 4px 2px;
+ overflow: auto;
+ word-wrap: break-word;
+ font-size: 9pt;
+ line-height: 125%;
+ font-family: monospace, fixed;
+ font-size: 105%;
+}
+
+div.fragment {
+ padding: 0 0 1px 0; /*Fixed: last line underline overlap border*/
+ margin: 4px 8px 4px 2px;
+ background-color: #FBFCFD;
+ border: 1px solid #C4CFE5;
+}
+
+div.line {
+ font-family: monospace, fixed;
+ font-size: 13px;
+ min-height: 13px;
+ line-height: 1.0;
+ text-wrap: unrestricted;
+ white-space: -moz-pre-wrap; /* Moz */
+ white-space: -pre-wrap; /* Opera 4-6 */
+ white-space: -o-pre-wrap; /* Opera 7 */
+ white-space: pre-wrap; /* CSS3 */
+ word-wrap: break-word; /* IE 5.5+ */
+ text-indent: -53px;
+ padding-left: 53px;
+ padding-bottom: 0px;
+ margin: 0px;
+ -webkit-transition-property: background-color, box-shadow;
+ -webkit-transition-duration: 0.5s;
+ -moz-transition-property: background-color, box-shadow;
+ -moz-transition-duration: 0.5s;
+ -ms-transition-property: background-color, box-shadow;
+ -ms-transition-duration: 0.5s;
+ -o-transition-property: background-color, box-shadow;
+ -o-transition-duration: 0.5s;
+ transition-property: background-color, box-shadow;
+ transition-duration: 0.5s;
+}
+
+div.line:after {
+ content:"\000A";
+ white-space: pre;
+}
+
+div.line.glow {
+ background-color: cyan;
+ box-shadow: 0 0 10px cyan;
+}
+
+
+span.lineno {
+ padding-right: 4px;
+ text-align: right;
+ border-right: 2px solid #0F0;
+ background-color: #E8E8E8;
+ white-space: pre;
+}
+span.lineno a {
+ background-color: #D8D8D8;
+}
+
+span.lineno a:hover {
+ background-color: #C8C8C8;
+}
+
+.lineno {
+ -webkit-touch-callout: none;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+
+div.ah, span.ah {
+ background-color: black;
+ font-weight: bold;
+ color: #FFFFFF;
+ margin-bottom: 3px;
+ margin-top: 3px;
+ padding: 0.2em;
+ border: solid thin #333;
+ border-radius: 0.5em;
+ -webkit-border-radius: .5em;
+ -moz-border-radius: .5em;
+ box-shadow: 2px 2px 3px #999;
+ -webkit-box-shadow: 2px 2px 3px #999;
+ -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
+ background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444));
+ background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000 110%);
+}
+
+div.classindex ul {
+ list-style: none;
+ padding-left: 0;
+}
+
+div.classindex span.ai {
+ display: inline-block;
+}
+
+div.groupHeader {
+ margin-left: 16px;
+ margin-top: 12px;
+ font-weight: bold;
+}
+
+div.groupText {
+ margin-left: 16px;
+ font-style: italic;
+}
+
+body {
+ background-color: white;
+ color: black;
+ margin: 0;
+}
+
+div.contents {
+ margin-top: 10px;
+ margin-left: 12px;
+ margin-right: 8px;
+}
+
+td.indexkey {
+ background-color: #EBEFF6;
+ font-weight: bold;
+ border: 1px solid #C4CFE5;
+ margin: 2px 0px 2px 0;
+ padding: 2px 10px;
+ white-space: nowrap;
+ vertical-align: top;
+}
+
+td.indexvalue {
+ background-color: #EBEFF6;
+ border: 1px solid #C4CFE5;
+ padding: 2px 10px;
+ margin: 2px 0px;
+}
+
+tr.memlist {
+ background-color: #EEF1F7;
+}
+
+p.formulaDsp {
+ text-align: center;
+}
+
+img.formulaDsp {
+
+}
+
+img.formulaInl, img.inline {
+ vertical-align: middle;
+}
+
+div.center {
+ text-align: center;
+ margin-top: 0px;
+ margin-bottom: 0px;
+ padding: 0px;
+}
+
+div.center img {
+ border: 0px;
+}
+
+address.footer {
+ text-align: right;
+ padding-right: 12px;
+}
+
+img.footer {
+ border: 0px;
+ vertical-align: middle;
+}
+
+/* @group Code Colorization */
+
+span.keyword {
+ color: #008000
+}
+
+span.keywordtype {
+ color: #604020
+}
+
+span.keywordflow {
+ color: #e08000
+}
+
+span.comment {
+ color: #800000
+}
+
+span.preprocessor {
+ color: #806020
+}
+
+span.stringliteral {
+ color: #002080
+}
+
+span.charliteral {
+ color: #008080
+}
+
+span.vhdldigit {
+ color: #ff00ff
+}
+
+span.vhdlchar {
+ color: #000000
+}
+
+span.vhdlkeyword {
+ color: #700070
+}
+
+span.vhdllogic {
+ color: #ff0000
+}
+
+blockquote {
+ background-color: #F7F8FB;
+ border-left: 2px solid #9CAFD4;
+ margin: 0 24px 0 4px;
+ padding: 0 12px 0 16px;
+}
+
+blockquote.DocNodeRTL {
+ border-left: 0;
+ border-right: 2px solid #9CAFD4;
+ margin: 0 4px 0 24px;
+ padding: 0 16px 0 12px;
+}
+
+/* @end */
+
+/*
+.search {
+ color: #003399;
+ font-weight: bold;
+}
+
+form.search {
+ margin-bottom: 0px;
+ margin-top: 0px;
+}
+
+input.search {
+ font-size: 75%;
+ color: #000080;
+ font-weight: normal;
+ background-color: #e8eef2;
+}
+*/
+
+td.tiny {
+ font-size: 75%;
+}
+
+.dirtab {
+ padding: 4px;
+ border-collapse: collapse;
+ border: 1px solid #A3B4D7;
+}
+
+th.dirtab {
+ background: #EBEFF6;
+ font-weight: bold;
+}
+
+hr {
+ height: 0px;
+ border: none;
+ border-top: 1px solid #4A6AAA;
+}
+
+hr.footer {
+ height: 1px;
+}
+
+/* @group Member Descriptions */
+
+table.memberdecls {
+ border-spacing: 0px;
+ padding: 0px;
+}
+
+.memberdecls td, .fieldtable tr {
+ -webkit-transition-property: background-color, box-shadow;
+ -webkit-transition-duration: 0.5s;
+ -moz-transition-property: background-color, box-shadow;
+ -moz-transition-duration: 0.5s;
+ -ms-transition-property: background-color, box-shadow;
+ -ms-transition-duration: 0.5s;
+ -o-transition-property: background-color, box-shadow;
+ -o-transition-duration: 0.5s;
+ transition-property: background-color, box-shadow;
+ transition-duration: 0.5s;
+}
+
+.memberdecls td.glow, .fieldtable tr.glow {
+ background-color: cyan;
+ box-shadow: 0 0 15px cyan;
+}
+
+.mdescLeft, .mdescRight,
+.memItemLeft, .memItemRight,
+.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
+ background-color: #F9FAFC;
+ border: none;
+ margin: 4px;
+ padding: 1px 0 0 8px;
+}
+
+.mdescLeft, .mdescRight {
+ padding: 0px 8px 4px 8px;
+ color: #555;
+}
+
+.memSeparator {
+ border-bottom: 1px solid #DEE4F0;
+ line-height: 1px;
+ margin: 0px;
+ padding: 0px;
+}
+
+.memItemLeft, .memTemplItemLeft {
+ white-space: nowrap;
+}
+
+.memItemRight, .memTemplItemRight {
+ width: 100%;
+}
+
+.memTemplParams {
+ color: #4665A2;
+ white-space: nowrap;
+ font-size: 80%;
+}
+
+/* @end */
+
+/* @group Member Details */
+
+/* Styles for detailed member documentation */
+
+.memtitle {
+ padding: 8px;
+ border-top: 1px solid #A8B8D9;
+ border-left: 1px solid #A8B8D9;
+ border-right: 1px solid #A8B8D9;
+ border-top-right-radius: 4px;
+ border-top-left-radius: 4px;
+ margin-bottom: -1px;
+ background-image: url('nav_f.png');
+ background-repeat: repeat-x;
+ background-color: #E2E8F2;
+ line-height: 1.25;
+ font-weight: 300;
+ float:left;
+}
+
+.permalink
+{
+ font-size: 65%;
+ display: inline-block;
+ vertical-align: middle;
+}
+
+.memtemplate {
+ font-size: 80%;
+ color: #4665A2;
+ font-weight: normal;
+ margin-left: 9px;
+}
+
+.memnav {
+ background-color: #EBEFF6;
+ border: 1px solid #A3B4D7;
+ text-align: center;
+ margin: 2px;
+ margin-right: 15px;
+ padding: 2px;
+}
+
+.mempage {
+ width: 100%;
+}
+
+.memitem {
+ padding: 0;
+ margin-bottom: 10px;
+ margin-right: 5px;
+ -webkit-transition: box-shadow 0.5s linear;
+ -moz-transition: box-shadow 0.5s linear;
+ -ms-transition: box-shadow 0.5s linear;
+ -o-transition: box-shadow 0.5s linear;
+ transition: box-shadow 0.5s linear;
+ display: table !important;
+ width: 100%;
+}
+
+.memitem.glow {
+ box-shadow: 0 0 15px cyan;
+}
+
+.memname {
+ font-weight: 400;
+ margin-left: 6px;
+}
+
+.memname td {
+ vertical-align: bottom;
+}
+
+.memproto, dl.reflist dt {
+ border-top: 1px solid #A8B8D9;
+ border-left: 1px solid #A8B8D9;
+ border-right: 1px solid #A8B8D9;
+ padding: 6px 0px 6px 0px;
+ color: #253555;
+ font-weight: bold;
+ text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
+ background-color: #DFE5F1;
+ /* opera specific markup */
+ box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ border-top-right-radius: 4px;
+ /* firefox specific markup */
+ -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
+ -moz-border-radius-topright: 4px;
+ /* webkit specific markup */
+ -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ -webkit-border-top-right-radius: 4px;
+
+}
+
+.overload {
+ font-family: "courier new",courier,monospace;
+ font-size: 65%;
+}
+
+.memdoc, dl.reflist dd {
+ border-bottom: 1px solid #A8B8D9;
+ border-left: 1px solid #A8B8D9;
+ border-right: 1px solid #A8B8D9;
+ padding: 6px 10px 2px 10px;
+ background-color: #FBFCFD;
+ border-top-width: 0;
+ background-image:url('nav_g.png');
+ background-repeat:repeat-x;
+ background-color: #FFFFFF;
+ /* opera specific markup */
+ border-bottom-left-radius: 4px;
+ border-bottom-right-radius: 4px;
+ box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ /* firefox specific markup */
+ -moz-border-radius-bottomleft: 4px;
+ -moz-border-radius-bottomright: 4px;
+ -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
+ /* webkit specific markup */
+ -webkit-border-bottom-left-radius: 4px;
+ -webkit-border-bottom-right-radius: 4px;
+ -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+}
+
+dl.reflist dt {
+ padding: 5px;
+}
+
+dl.reflist dd {
+ margin: 0px 0px 10px 0px;
+ padding: 5px;
+}
+
+.paramkey {
+ text-align: right;
+}
+
+.paramtype {
+ white-space: nowrap;
+}
+
+.paramname {
+ color: #602020;
+ white-space: nowrap;
+}
+.paramname em {
+ font-style: normal;
+}
+.paramname code {
+ line-height: 14px;
+}
+
+.params, .retval, .exception, .tparams {
+ margin-left: 0px;
+ padding-left: 0px;
+}
+
+.params .paramname, .retval .paramname, .tparams .paramname, .exception .paramname {
+ font-weight: bold;
+ vertical-align: top;
+}
+
+.params .paramtype, .tparams .paramtype {
+ font-style: italic;
+ vertical-align: top;
+}
+
+.params .paramdir, .tparams .paramdir {
+ font-family: "courier new",courier,monospace;
+ vertical-align: top;
+}
+
+table.mlabels {
+ border-spacing: 0px;
+}
+
+td.mlabels-left {
+ width: 100%;
+ padding: 0px;
+}
+
+td.mlabels-right {
+ vertical-align: bottom;
+ padding: 0px;
+ white-space: nowrap;
+}
+
+span.mlabels {
+ margin-left: 8px;
+}
+
+span.mlabel {
+ background-color: #728DC1;
+ border-top:1px solid #5373B4;
+ border-left:1px solid #5373B4;
+ border-right:1px solid #C4CFE5;
+ border-bottom:1px solid #C4CFE5;
+ text-shadow: none;
+ color: white;
+ margin-right: 4px;
+ padding: 2px 3px;
+ border-radius: 3px;
+ font-size: 7pt;
+ white-space: nowrap;
+ vertical-align: middle;
+}
+
+
+
+/* @end */
+
+/* these are for tree view inside a (index) page */
+
+div.directory {
+ margin: 10px 0px;
+ border-top: 1px solid #9CAFD4;
+ border-bottom: 1px solid #9CAFD4;
+ width: 100%;
+}
+
+.directory table {
+ border-collapse:collapse;
+}
+
+.directory td {
+ margin: 0px;
+ padding: 0px;
+ vertical-align: top;
+}
+
+.directory td.entry {
+ white-space: nowrap;
+ padding-right: 6px;
+ padding-top: 3px;
+}
+
+.directory td.entry a {
+ outline:none;
+}
+
+.directory td.entry a img {
+ border: none;
+}
+
+.directory td.desc {
+ width: 100%;
+ padding-left: 6px;
+ padding-right: 6px;
+ padding-top: 3px;
+ border-left: 1px solid rgba(0,0,0,0.05);
+}
+
+.directory tr.even {
+ padding-left: 6px;
+ background-color: #F7F8FB;
+}
+
+.directory img {
+ vertical-align: -30%;
+}
+
+.directory .levels {
+ white-space: nowrap;
+ width: 100%;
+ text-align: right;
+ font-size: 9pt;
+}
+
+.directory .levels span {
+ cursor: pointer;
+ padding-left: 2px;
+ padding-right: 2px;
+ color: #3D578C;
+}
+
+.arrow {
+ color: #9CAFD4;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ cursor: pointer;
+ font-size: 80%;
+ display: inline-block;
+ width: 16px;
+ height: 22px;
+}
+
+.icon {
+ font-family: Arial, Helvetica;
+ font-weight: bold;
+ font-size: 12px;
+ height: 14px;
+ width: 16px;
+ display: inline-block;
+ background-color: #728DC1;
+ color: white;
+ text-align: center;
+ border-radius: 4px;
+ margin-left: 2px;
+ margin-right: 2px;
+}
+
+.icona {
+ width: 24px;
+ height: 22px;
+ display: inline-block;
+}
+
+.iconfopen {
+ width: 24px;
+ height: 18px;
+ margin-bottom: 4px;
+ background-image:url('folderopen.png');
+ background-position: 0px -4px;
+ background-repeat: repeat-y;
+ vertical-align:top;
+ display: inline-block;
+}
+
+.iconfclosed {
+ width: 24px;
+ height: 18px;
+ margin-bottom: 4px;
+ background-image:url('folderclosed.png');
+ background-position: 0px -4px;
+ background-repeat: repeat-y;
+ vertical-align:top;
+ display: inline-block;
+}
+
+.icondoc {
+ width: 24px;
+ height: 18px;
+ margin-bottom: 4px;
+ background-image:url('doc.png');
+ background-position: 0px -4px;
+ background-repeat: repeat-y;
+ vertical-align:top;
+ display: inline-block;
+}
+
+table.directory {
+ font: 400 14px Roboto,sans-serif;
+}
+
+/* @end */
+
+div.dynheader {
+ margin-top: 8px;
+ -webkit-touch-callout: none;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+
+address {
+ font-style: normal;
+ color: #2A3D61;
+}
+
+table.doxtable caption {
+ caption-side: top;
+}
+
+table.doxtable {
+ border-collapse:collapse;
+ margin-top: 4px;
+ margin-bottom: 4px;
+}
+
+table.doxtable td, table.doxtable th {
+ border: 1px solid #2D4068;
+ padding: 3px 7px 2px;
+}
+
+table.doxtable th {
+ background-color: #374F7F;
+ color: #FFFFFF;
+ font-size: 110%;
+ padding-bottom: 4px;
+ padding-top: 5px;
+}
+
+table.fieldtable {
+ /*width: 100%;*/
+ margin-bottom: 10px;
+ border: 1px solid #A8B8D9;
+ border-spacing: 0px;
+ -moz-border-radius: 4px;
+ -webkit-border-radius: 4px;
+ border-radius: 4px;
+ -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
+ -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
+ box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
+}
+
+.fieldtable td, .fieldtable th {
+ padding: 3px 7px 2px;
+}
+
+.fieldtable td.fieldtype, .fieldtable td.fieldname {
+ white-space: nowrap;
+ border-right: 1px solid #A8B8D9;
+ border-bottom: 1px solid #A8B8D9;
+ vertical-align: top;
+}
+
+.fieldtable td.fieldname {
+ padding-top: 3px;
+}
+
+.fieldtable td.fielddoc {
+ border-bottom: 1px solid #A8B8D9;
+ /*width: 100%;*/
+}
+
+.fieldtable td.fielddoc p:first-child {
+ margin-top: 0px;
+}
+
+.fieldtable td.fielddoc p:last-child {
+ margin-bottom: 2px;
+}
+
+.fieldtable tr:last-child td {
+ border-bottom: none;
+}
+
+.fieldtable th {
+ background-image:url('nav_f.png');
+ background-repeat:repeat-x;
+ background-color: #E2E8F2;
+ font-size: 90%;
+ color: #253555;
+ padding-bottom: 4px;
+ padding-top: 5px;
+ text-align:left;
+ font-weight: 400;
+ -moz-border-radius-topleft: 4px;
+ -moz-border-radius-topright: 4px;
+ -webkit-border-top-left-radius: 4px;
+ -webkit-border-top-right-radius: 4px;
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+ border-bottom: 1px solid #A8B8D9;
+}
+
+
+.tabsearch {
+ top: 0px;
+ left: 10px;
+ height: 36px;
+ background-image: url('tab_b.png');
+ z-index: 101;
+ overflow: hidden;
+ font-size: 13px;
+}
+
+.navpath ul
+{
+ font-size: 11px;
+ background-image:url('tab_b.png');
+ background-repeat:repeat-x;
+ background-position: 0 -5px;
+ height:30px;
+ line-height:30px;
+ color:#8AA0CC;
+ border:solid 1px #C2CDE4;
+ overflow:hidden;
+ margin:0px;
+ padding:0px;
+}
+
+.navpath li
+{
+ list-style-type:none;
+ float:left;
+ padding-left:10px;
+ padding-right:15px;
+ background-image:url('bc_s.png');
+ background-repeat:no-repeat;
+ background-position:right;
+ color:#364D7C;
+}
+
+.navpath li.navelem a
+{
+ height:32px;
+ display:block;
+ text-decoration: none;
+ outline: none;
+ color: #283A5D;
+ font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
+ text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
+ text-decoration: none;
+}
+
+.navpath li.navelem a:hover
+{
+ color:#6884BD;
+}
+
+.navpath li.footer
+{
+ list-style-type:none;
+ float:right;
+ padding-left:10px;
+ padding-right:15px;
+ background-image:none;
+ background-repeat:no-repeat;
+ background-position:right;
+ color:#364D7C;
+ font-size: 8pt;
+}
+
+
+div.summary
+{
+ float: right;
+ font-size: 8pt;
+ padding-right: 5px;
+ width: 50%;
+ text-align: right;
+}
+
+div.summary a
+{
+ white-space: nowrap;
+}
+
+table.classindex
+{
+ margin: 10px;
+ white-space: nowrap;
+ margin-left: 3%;
+ margin-right: 3%;
+ width: 94%;
+ border: 0;
+ border-spacing: 0;
+ padding: 0;
+}
+
+div.ingroups
+{
+ font-size: 8pt;
+ width: 50%;
+ text-align: left;
+}
+
+div.ingroups a
+{
+ white-space: nowrap;
+}
+
+div.header
+{
+ background-image:url('nav_h.png');
+ background-repeat:repeat-x;
+ background-color: #F9FAFC;
+ margin: 0px;
+ border-bottom: 1px solid #C4CFE5;
+}
+
+div.headertitle
+{
+ padding: 5px 5px 5px 10px;
+}
+
+.PageDocRTL-title div.headertitle {
+ text-align: right;
+ direction: rtl;
+}
+
+dl {
+ padding: 0 0 0 0;
+}
+
+/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug, dl.examples */
+dl.section {
+ margin-left: 0px;
+ padding-left: 0px;
+}
+
+dl.section.DocNodeRTL {
+ margin-right: 0px;
+ padding-right: 0px;
+}
+
+dl.note {
+ margin-left: -7px;
+ padding-left: 3px;
+ border-left: 4px solid;
+ border-color: #D0C000;
+}
+
+dl.note.DocNodeRTL {
+ margin-left: 0;
+ padding-left: 0;
+ border-left: 0;
+ margin-right: -7px;
+ padding-right: 3px;
+ border-right: 4px solid;
+ border-color: #D0C000;
+}
+
+dl.warning, dl.attention {
+ margin-left: -7px;
+ padding-left: 3px;
+ border-left: 4px solid;
+ border-color: #FF0000;
+}
+
+dl.warning.DocNodeRTL, dl.attention.DocNodeRTL {
+ margin-left: 0;
+ padding-left: 0;
+ border-left: 0;
+ margin-right: -7px;
+ padding-right: 3px;
+ border-right: 4px solid;
+ border-color: #FF0000;
+}
+
+dl.pre, dl.post, dl.invariant {
+ margin-left: -7px;
+ padding-left: 3px;
+ border-left: 4px solid;
+ border-color: #00D000;
+}
+
+dl.pre.DocNodeRTL, dl.post.DocNodeRTL, dl.invariant.DocNodeRTL {
+ margin-left: 0;
+ padding-left: 0;
+ border-left: 0;
+ margin-right: -7px;
+ padding-right: 3px;
+ border-right: 4px solid;
+ border-color: #00D000;
+}
+
+dl.deprecated {
+ margin-left: -7px;
+ padding-left: 3px;
+ border-left: 4px solid;
+ border-color: #505050;
+}
+
+dl.deprecated.DocNodeRTL {
+ margin-left: 0;
+ padding-left: 0;
+ border-left: 0;
+ margin-right: -7px;
+ padding-right: 3px;
+ border-right: 4px solid;
+ border-color: #505050;
+}
+
+dl.todo {
+ margin-left: -7px;
+ padding-left: 3px;
+ border-left: 4px solid;
+ border-color: #00C0E0;
+}
+
+dl.todo.DocNodeRTL {
+ margin-left: 0;
+ padding-left: 0;
+ border-left: 0;
+ margin-right: -7px;
+ padding-right: 3px;
+ border-right: 4px solid;
+ border-color: #00C0E0;
+}
+
+dl.test {
+ margin-left: -7px;
+ padding-left: 3px;
+ border-left: 4px solid;
+ border-color: #3030E0;
+}
+
+dl.test.DocNodeRTL {
+ margin-left: 0;
+ padding-left: 0;
+ border-left: 0;
+ margin-right: -7px;
+ padding-right: 3px;
+ border-right: 4px solid;
+ border-color: #3030E0;
+}
+
+dl.bug {
+ margin-left: -7px;
+ padding-left: 3px;
+ border-left: 4px solid;
+ border-color: #C08050;
+}
+
+dl.bug.DocNodeRTL {
+ margin-left: 0;
+ padding-left: 0;
+ border-left: 0;
+ margin-right: -7px;
+ padding-right: 3px;
+ border-right: 4px solid;
+ border-color: #C08050;
+}
+
+dl.section dd {
+ margin-bottom: 6px;
+}
+
+
+#projectlogo
+{
+ text-align: center;
+ vertical-align: bottom;
+ border-collapse: separate;
+}
+
+#projectlogo img
+{
+ border: 0px none;
+}
+
+#projectalign
+{
+ vertical-align: middle;
+}
+
+#projectname
+{
+ font: 300% Tahoma, Arial,sans-serif;
+ margin: 0px;
+ padding: 2px 0px;
+}
+
+#projectbrief
+{
+ font: 120% Tahoma, Arial,sans-serif;
+ margin: 0px;
+ padding: 0px;
+}
+
+#projectnumber
+{
+ font: 50% Tahoma, Arial,sans-serif;
+ margin: 0px;
+ padding: 0px;
+}
+
+#titlearea
+{
+ padding: 0px;
+ margin: 0px;
+ width: 100%;
+ border-bottom: 1px solid #5373B4;
+}
+
+.image
+{
+ text-align: center;
+}
+
+.dotgraph
+{
+ text-align: center;
+}
+
+.mscgraph
+{
+ text-align: center;
+}
+
+.plantumlgraph
+{
+ text-align: center;
+}
+
+.diagraph
+{
+ text-align: center;
+}
+
+.caption
+{
+ font-weight: bold;
+}
+
+div.zoom
+{
+ border: 1px solid #90A5CE;
+}
+
+dl.citelist {
+ margin-bottom:50px;
+}
+
+dl.citelist dt {
+ color:#334975;
+ float:left;
+ font-weight:bold;
+ margin-right:10px;
+ padding:5px;
+}
+
+dl.citelist dd {
+ margin:2px 0;
+ padding:5px 0;
+}
+
+div.toc {
+ padding: 14px 25px;
+ background-color: #F4F6FA;
+ border: 1px solid #D8DFEE;
+ border-radius: 7px 7px 7px 7px;
+ float: right;
+ height: auto;
+ margin: 0 8px 10px 10px;
+ width: 200px;
+}
+
+.PageDocRTL-title div.toc {
+ float: left !important;
+ text-align: right;
+}
+
+div.toc li {
+ background: url("bdwn.png") no-repeat scroll 0 5px transparent;
+ font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif;
+ margin-top: 5px;
+ padding-left: 10px;
+ padding-top: 2px;
+}
+
+.PageDocRTL-title div.toc li {
+ background-position-x: right !important;
+ padding-left: 0 !important;
+ padding-right: 10px;
+}
+
+div.toc h3 {
+ font: bold 12px/1.2 Arial,FreeSans,sans-serif;
+ color: #4665A2;
+ border-bottom: 0 none;
+ margin: 0;
+}
+
+div.toc ul {
+ list-style: none outside none;
+ border: medium none;
+ padding: 0px;
+}
+
+div.toc li.level1 {
+ margin-left: 0px;
+}
+
+div.toc li.level2 {
+ margin-left: 15px;
+}
+
+div.toc li.level3 {
+ margin-left: 30px;
+}
+
+div.toc li.level4 {
+ margin-left: 45px;
+}
+
+.PageDocRTL-title div.toc li.level1 {
+ margin-left: 0 !important;
+ margin-right: 0;
+}
+
+.PageDocRTL-title div.toc li.level2 {
+ margin-left: 0 !important;
+ margin-right: 15px;
+}
+
+.PageDocRTL-title div.toc li.level3 {
+ margin-left: 0 !important;
+ margin-right: 30px;
+}
+
+.PageDocRTL-title div.toc li.level4 {
+ margin-left: 0 !important;
+ margin-right: 45px;
+}
+
+.inherit_header {
+ font-weight: bold;
+ color: gray;
+ cursor: pointer;
+ -webkit-touch-callout: none;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+
+.inherit_header td {
+ padding: 6px 0px 2px 5px;
+}
+
+.inherit {
+ display: none;
+}
+
+tr.heading h2 {
+ margin-top: 12px;
+ margin-bottom: 4px;
+}
+
+/* tooltip related style info */
+
+.ttc {
+ position: absolute;
+ display: none;
+}
+
+#powerTip {
+ cursor: default;
+ white-space: nowrap;
+ background-color: white;
+ border: 1px solid gray;
+ border-radius: 4px 4px 4px 4px;
+ box-shadow: 1px 1px 7px gray;
+ display: none;
+ font-size: smaller;
+ max-width: 80%;
+ opacity: 0.9;
+ padding: 1ex 1em 1em;
+ position: absolute;
+ z-index: 2147483647;
+}
+
+#powerTip div.ttdoc {
+ color: grey;
+ font-style: italic;
+}
+
+#powerTip div.ttname a {
+ font-weight: bold;
+}
+
+#powerTip div.ttname {
+ font-weight: bold;
+}
+
+#powerTip div.ttdeci {
+ color: #006318;
+}
+
+#powerTip div {
+ margin: 0px;
+ padding: 0px;
+ font: 12px/16px Roboto,sans-serif;
+}
+
+#powerTip:before, #powerTip:after {
+ content: "";
+ position: absolute;
+ margin: 0px;
+}
+
+#powerTip.n:after, #powerTip.n:before,
+#powerTip.s:after, #powerTip.s:before,
+#powerTip.w:after, #powerTip.w:before,
+#powerTip.e:after, #powerTip.e:before,
+#powerTip.ne:after, #powerTip.ne:before,
+#powerTip.se:after, #powerTip.se:before,
+#powerTip.nw:after, #powerTip.nw:before,
+#powerTip.sw:after, #powerTip.sw:before {
+ border: solid transparent;
+ content: " ";
+ height: 0;
+ width: 0;
+ position: absolute;
+}
+
+#powerTip.n:after, #powerTip.s:after,
+#powerTip.w:after, #powerTip.e:after,
+#powerTip.nw:after, #powerTip.ne:after,
+#powerTip.sw:after, #powerTip.se:after {
+ border-color: rgba(255, 255, 255, 0);
+}
+
+#powerTip.n:before, #powerTip.s:before,
+#powerTip.w:before, #powerTip.e:before,
+#powerTip.nw:before, #powerTip.ne:before,
+#powerTip.sw:before, #powerTip.se:before {
+ border-color: rgba(128, 128, 128, 0);
+}
+
+#powerTip.n:after, #powerTip.n:before,
+#powerTip.ne:after, #powerTip.ne:before,
+#powerTip.nw:after, #powerTip.nw:before {
+ top: 100%;
+}
+
+#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after {
+ border-top-color: #FFFFFF;
+ border-width: 10px;
+ margin: 0px -10px;
+}
+#powerTip.n:before {
+ border-top-color: #808080;
+ border-width: 11px;
+ margin: 0px -11px;
+}
+#powerTip.n:after, #powerTip.n:before {
+ left: 50%;
+}
+
+#powerTip.nw:after, #powerTip.nw:before {
+ right: 14px;
+}
+
+#powerTip.ne:after, #powerTip.ne:before {
+ left: 14px;
+}
+
+#powerTip.s:after, #powerTip.s:before,
+#powerTip.se:after, #powerTip.se:before,
+#powerTip.sw:after, #powerTip.sw:before {
+ bottom: 100%;
+}
+
+#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after {
+ border-bottom-color: #FFFFFF;
+ border-width: 10px;
+ margin: 0px -10px;
+}
+
+#powerTip.s:before, #powerTip.se:before, #powerTip.sw:before {
+ border-bottom-color: #808080;
+ border-width: 11px;
+ margin: 0px -11px;
+}
+
+#powerTip.s:after, #powerTip.s:before {
+ left: 50%;
+}
+
+#powerTip.sw:after, #powerTip.sw:before {
+ right: 14px;
+}
+
+#powerTip.se:after, #powerTip.se:before {
+ left: 14px;
+}
+
+#powerTip.e:after, #powerTip.e:before {
+ left: 100%;
+}
+#powerTip.e:after {
+ border-left-color: #FFFFFF;
+ border-width: 10px;
+ top: 50%;
+ margin-top: -10px;
+}
+#powerTip.e:before {
+ border-left-color: #808080;
+ border-width: 11px;
+ top: 50%;
+ margin-top: -11px;
+}
+
+#powerTip.w:after, #powerTip.w:before {
+ right: 100%;
+}
+#powerTip.w:after {
+ border-right-color: #FFFFFF;
+ border-width: 10px;
+ top: 50%;
+ margin-top: -10px;
+}
+#powerTip.w:before {
+ border-right-color: #808080;
+ border-width: 11px;
+ top: 50%;
+ margin-top: -11px;
+}
+
+@media print
+{
+ #top { display: none; }
+ #side-nav { display: none; }
+ #nav-path { display: none; }
+ body { overflow:visible; }
+ h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
+ .summary { display: none; }
+ .memitem { page-break-inside: avoid; }
+ #doc-content
+ {
+ margin-left:0 !important;
+ height:auto !important;
+ width:auto !important;
+ overflow:inherit;
+ display:inline;
+ }
+}
+
+/* @group Markdown */
+
+/*
+table.markdownTable {
+ border-collapse:collapse;
+ margin-top: 4px;
+ margin-bottom: 4px;
+}
+
+table.markdownTable td, table.markdownTable th {
+ border: 1px solid #2D4068;
+ padding: 3px 7px 2px;
+}
+
+table.markdownTableHead tr {
+}
+
+table.markdownTableBodyLeft td, table.markdownTable th {
+ border: 1px solid #2D4068;
+ padding: 3px 7px 2px;
+}
+
+th.markdownTableHeadLeft th.markdownTableHeadRight th.markdownTableHeadCenter th.markdownTableHeadNone {
+ background-color: #374F7F;
+ color: #FFFFFF;
+ font-size: 110%;
+ padding-bottom: 4px;
+ padding-top: 5px;
+}
+
+th.markdownTableHeadLeft {
+ text-align: left
+}
+
+th.markdownTableHeadRight {
+ text-align: right
+}
+
+th.markdownTableHeadCenter {
+ text-align: center
+}
+*/
+
+table.markdownTable {
+ border-collapse:collapse;
+ margin-top: 4px;
+ margin-bottom: 4px;
+}
+
+table.markdownTable td, table.markdownTable th {
+ border: 1px solid #2D4068;
+ padding: 3px 7px 2px;
+}
+
+table.markdownTable tr {
+}
+
+th.markdownTableHeadLeft, th.markdownTableHeadRight, th.markdownTableHeadCenter, th.markdownTableHeadNone {
+ background-color: #374F7F;
+ color: #FFFFFF;
+ font-size: 110%;
+ padding-bottom: 4px;
+ padding-top: 5px;
+}
+
+th.markdownTableHeadLeft, td.markdownTableBodyLeft {
+ text-align: left
+}
+
+th.markdownTableHeadRight, td.markdownTableBodyRight {
+ text-align: right
+}
+
+th.markdownTableHeadCenter, td.markdownTableBodyCenter {
+ text-align: center
+}
+
+.DocNodeRTL {
+ text-align: right;
+ direction: rtl;
+}
+
+.DocNodeLTR {
+ text-align: left;
+ direction: ltr;
+}
+
+table.DocNodeRTL {
+ width: auto;
+ margin-right: 0;
+ margin-left: auto;
+}
+
+table.DocNodeLTR {
+ width: auto;
+ margin-right: auto;
+ margin-left: 0;
+}
+
+tt, code, kbd, samp
+{
+ display: inline-block;
+ direction:ltr;
+}
+/* @end */
+
+u {
+ text-decoration: underline;
+}
+
diff --git a/docs/doxygen/html/doxygen.png b/docs/doxygen/html/doxygen.png
new file mode 100644
index 00000000..3ff17d80
Binary files /dev/null and b/docs/doxygen/html/doxygen.png differ
diff --git a/docs/doxygen/html/dynsections.js b/docs/doxygen/html/dynsections.js
new file mode 100644
index 00000000..ea0a7b39
--- /dev/null
+++ b/docs/doxygen/html/dynsections.js
@@ -0,0 +1,120 @@
+/*
+ @licstart The following is the entire license notice for the
+ JavaScript code in this file.
+
+ Copyright (C) 1997-2017 by Dimitri van Heesch
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+ @licend The above is the entire license notice
+ for the JavaScript code in this file
+ */
+function toggleVisibility(linkObj)
+{
+ var base = $(linkObj).attr('id');
+ var summary = $('#'+base+'-summary');
+ var content = $('#'+base+'-content');
+ var trigger = $('#'+base+'-trigger');
+ var src=$(trigger).attr('src');
+ if (content.is(':visible')===true) {
+ content.hide();
+ summary.show();
+ $(linkObj).addClass('closed').removeClass('opened');
+ $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png');
+ } else {
+ content.show();
+ summary.hide();
+ $(linkObj).removeClass('closed').addClass('opened');
+ $(trigger).attr('src',src.substring(0,src.length-10)+'open.png');
+ }
+ return false;
+}
+
+function updateStripes()
+{
+ $('table.directory tr').
+ removeClass('even').filter(':visible:even').addClass('even');
+}
+
+function toggleLevel(level)
+{
+ $('table.directory tr').each(function() {
+ var l = this.id.split('_').length-1;
+ var i = $('#img'+this.id.substring(3));
+ var a = $('#arr'+this.id.substring(3));
+ if (l
+
+
+MSCCL++: errors.hpp File Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <stdexcept>
+
+
+
+
+
+
+
Go to the source code of this file.
+
+
+
diff --git a/docs/doxygen/html/errors_8hpp__dep__incl.md5 b/docs/doxygen/html/errors_8hpp__dep__incl.md5
new file mode 100644
index 00000000..97fe716a
--- /dev/null
+++ b/docs/doxygen/html/errors_8hpp__dep__incl.md5
@@ -0,0 +1 @@
+870b14d1e2ea0ff5b94ae3017d9d8398
\ No newline at end of file
diff --git a/docs/doxygen/html/errors_8hpp__dep__incl.png b/docs/doxygen/html/errors_8hpp__dep__incl.png
new file mode 100644
index 00000000..f7434bd0
Binary files /dev/null and b/docs/doxygen/html/errors_8hpp__dep__incl.png differ
diff --git a/docs/doxygen/html/errors_8hpp__incl.map b/docs/doxygen/html/errors_8hpp__incl.map
new file mode 100644
index 00000000..8edb2e49
--- /dev/null
+++ b/docs/doxygen/html/errors_8hpp__incl.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/errors_8hpp__incl.md5 b/docs/doxygen/html/errors_8hpp__incl.md5
new file mode 100644
index 00000000..fc799315
--- /dev/null
+++ b/docs/doxygen/html/errors_8hpp__incl.md5
@@ -0,0 +1 @@
+54396d1f6c5c3c0bf270278838748069
\ No newline at end of file
diff --git a/docs/doxygen/html/errors_8hpp__incl.png b/docs/doxygen/html/errors_8hpp__incl.png
new file mode 100644
index 00000000..6715dd3e
Binary files /dev/null and b/docs/doxygen/html/errors_8hpp__incl.png differ
diff --git a/docs/doxygen/html/errors_8hpp_source.html b/docs/doxygen/html/errors_8hpp_source.html
new file mode 100644
index 00000000..ff56c26b
--- /dev/null
+++ b/docs/doxygen/html/errors_8hpp_source.html
@@ -0,0 +1,187 @@
+
+
+
+MSCCL++: errors.hpp Source File
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_ERRORS_HPP_
+
5 #define MSCCLPP_ERRORS_HPP_
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
35 BaseError (
const std::string& message,
int errorCode);
+
+
+
+
+
+
+
+
53 const char *
what ()
const noexcept
override ;
+
+
+
+
+
+
+
+
+
+
64 virtual ~Error () =
default ;
+
+
+
+
+
+
71 SysError (
const std::string& message,
int errorCode);
+
+
+
+
+
+
78 CudaError (
const std::string& message,
int errorCode);
+
+
+
+
+
+
85 CuError (
const std::string& message,
int errorCode);
+
+
+
+
+
+
92 IbError (
const std::string& message,
int errorCode);
+
+
+
+
+
+
98 #endif // MSCCLPP_ERRORS_HPP_
+
IbError(const std::string &message, int errorCode)
ErrorCode
Enumeration of error codes used by MSCCL++.
Definition: errors.hpp:12
virtual ~SysError()=default
int errorCode_
Definition: errors.hpp:57
std::string errorToString(enum ErrorCode error)
std::string message_
Definition: errors.hpp:56
Base class for all errors thrown by MSCCL++.
Definition: errors.hpp:29
An error from a system call that sets errno.
Definition: errors.hpp:69
virtual ~IbError()=default
CuError(const std::string &message, int errorCode)
ErrorCode getErrorCode() const
virtual ~CuError()=default
CudaError(const std::string &message, int errorCode)
const char * what() const noexcept override
Error(const std::string &message, ErrorCode errorCode)
virtual ~BaseError()=default
Virtual destructor for BaseError.
BaseError(const std::string &message, int errorCode)
A generic error.
Definition: errors.hpp:61
SysError(const std::string &message, int errorCode)
An error from a CUDA driver library call.
Definition: errors.hpp:83
virtual ~CudaError()=default
An error from an ibverbs library call.
Definition: errors.hpp:90
Definition: atomic_device.hpp:13
An error from a CUDA runtime library call.
Definition: errors.hpp:76
MSCCL++: executor.hpp File Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <memory>
+
#include <mscclpp/core.hpp >
+
#include <unordered_map>
+
+
+
+
+
+
+
+
Go to the source code of this file.
+
+
+
diff --git a/docs/doxygen/html/executor_8hpp__incl.md5 b/docs/doxygen/html/executor_8hpp__incl.md5
new file mode 100644
index 00000000..2d12a615
--- /dev/null
+++ b/docs/doxygen/html/executor_8hpp__incl.md5
@@ -0,0 +1 @@
+3fa4887ddd158439d7b71ea5f9e538b3
\ No newline at end of file
diff --git a/docs/doxygen/html/executor_8hpp__incl.png b/docs/doxygen/html/executor_8hpp__incl.png
new file mode 100644
index 00000000..60869b90
Binary files /dev/null and b/docs/doxygen/html/executor_8hpp__incl.png differ
diff --git a/docs/doxygen/html/executor_8hpp_source.html b/docs/doxygen/html/executor_8hpp_source.html
new file mode 100644
index 00000000..1c4e4a86
--- /dev/null
+++ b/docs/doxygen/html/executor_8hpp_source.html
@@ -0,0 +1,154 @@
+
+
+
+MSCCL++: executor.hpp Source File
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_EXECUTOR_HPP_
+
5 #define MSCCLPP_EXECUTOR_HPP_
+
+
+
+
9 #include <unordered_map>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
28 ExecutionPlan (
const std::string& name,
const std::string& planPath);
+
+
+
+
+
33 std::shared_ptr<Impl> impl_;
+
+
+
+
+
+
+
40 Executor (std::shared_ptr<Communicator> comm);
+
+
+
+
+
45 void execute (
int rank,
void * sendbuff,
void * recvBuff,
size_t sendBuffSize,
size_t recvBuffSize,
DataType dataType,
+
+
+
+
+
50 std::unique_ptr<Impl> impl_;
+
+
+
+
54 #endif // MSCCLPP_EXECUTOR_HPP_
+
ExecutionPlan(const std::string &name, const std::string &planPath)
Definition: executor.hpp:26
void execute(int rank, void *sendbuff, void *recvBuff, size_t sendBuffSize, size_t recvBuffSize, DataType dataType, const ExecutionPlan &plan, cudaStream_t stream, PacketType packetType=PacketType::LL16)
Executor(std::shared_ptr< Communicator > comm)
Executor & operator=(const Executor &)=delete
DataType
Definition: executor.hpp:13
Definition: executor.hpp:38
PacketType
Definition: executor.hpp:21
Definition: atomic_device.hpp:13
MSCCL++: fifo.hpp File Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <cstdint>
+
#include <functional>
+
#include <memory>
+
#include "fifo_device.hpp "
+
+
Go to the source code of this file.
+
+class mscclpp::Fifo A class representing a host proxy FIFO that can consume work elements pushed by device threads. More...
+
+
diff --git a/docs/doxygen/html/fifo_8hpp__dep__incl.md5 b/docs/doxygen/html/fifo_8hpp__dep__incl.md5
new file mode 100644
index 00000000..a21837b3
--- /dev/null
+++ b/docs/doxygen/html/fifo_8hpp__dep__incl.md5
@@ -0,0 +1 @@
+5602c364ece32a8ce0f40d7f9f46b060
\ No newline at end of file
diff --git a/docs/doxygen/html/fifo_8hpp__dep__incl.png b/docs/doxygen/html/fifo_8hpp__dep__incl.png
new file mode 100644
index 00000000..afd2641c
Binary files /dev/null and b/docs/doxygen/html/fifo_8hpp__dep__incl.png differ
diff --git a/docs/doxygen/html/fifo_8hpp__incl.map b/docs/doxygen/html/fifo_8hpp__incl.map
new file mode 100644
index 00000000..46f14d13
--- /dev/null
+++ b/docs/doxygen/html/fifo_8hpp__incl.map
@@ -0,0 +1,8 @@
+
+
diff --git a/docs/doxygen/html/fifo_8hpp__incl.md5 b/docs/doxygen/html/fifo_8hpp__incl.md5
new file mode 100644
index 00000000..831cc274
--- /dev/null
+++ b/docs/doxygen/html/fifo_8hpp__incl.md5
@@ -0,0 +1 @@
+445931b175fef7df75a209927e42af2c
\ No newline at end of file
diff --git a/docs/doxygen/html/fifo_8hpp__incl.png b/docs/doxygen/html/fifo_8hpp__incl.png
new file mode 100644
index 00000000..e765d649
Binary files /dev/null and b/docs/doxygen/html/fifo_8hpp__incl.png differ
diff --git a/docs/doxygen/html/fifo_8hpp_source.html b/docs/doxygen/html/fifo_8hpp_source.html
new file mode 100644
index 00000000..74ec1fcb
--- /dev/null
+++ b/docs/doxygen/html/fifo_8hpp_source.html
@@ -0,0 +1,134 @@
+
+
+
+MSCCL++: fifo.hpp Source File
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_FIFO_HPP_
+
5 #define MSCCLPP_FIFO_HPP_
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
51 std::unique_ptr<Impl> pimpl;
+
+
+
+
+
56 #endif // MSCCLPP_FIFO_HPP_
+
Definition: fifo_device.hpp:24
Definition: fifo_device.hpp:41
void flushTail(bool sync=false)
FifoDeviceHandle deviceHandle()
constexpr size_t DEFAULT_FIFO_SIZE
Definition: fifo.hpp:15
Fifo(int size=DEFAULT_FIFO_SIZE)
~Fifo()
Destroys the Fifo object.
void pop()
Pops a trigger from the FIFO.
A class representing a host proxy FIFO that can consume work elements pushed by device threads.
Definition: fifo.hpp:18
Definition: atomic_device.hpp:13
MSCCL++: fifo_device.hpp File Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/fifo__device_8hpp__dep__incl.md5 b/docs/doxygen/html/fifo__device_8hpp__dep__incl.md5
new file mode 100644
index 00000000..859c6a46
--- /dev/null
+++ b/docs/doxygen/html/fifo__device_8hpp__dep__incl.md5
@@ -0,0 +1 @@
+0a795a0fc2a27dc4c4f62941da8406ba
\ No newline at end of file
diff --git a/docs/doxygen/html/fifo__device_8hpp__dep__incl.png b/docs/doxygen/html/fifo__device_8hpp__dep__incl.png
new file mode 100644
index 00000000..020a2898
Binary files /dev/null and b/docs/doxygen/html/fifo__device_8hpp__dep__incl.png differ
diff --git a/docs/doxygen/html/fifo__device_8hpp__incl.map b/docs/doxygen/html/fifo__device_8hpp__incl.map
new file mode 100644
index 00000000..5f3595ba
--- /dev/null
+++ b/docs/doxygen/html/fifo__device_8hpp__incl.map
@@ -0,0 +1,5 @@
+
+
diff --git a/docs/doxygen/html/fifo__device_8hpp__incl.md5 b/docs/doxygen/html/fifo__device_8hpp__incl.md5
new file mode 100644
index 00000000..5261a9e1
--- /dev/null
+++ b/docs/doxygen/html/fifo__device_8hpp__incl.md5
@@ -0,0 +1 @@
+1761324e403564c6b65912dde4f25d23
\ No newline at end of file
diff --git a/docs/doxygen/html/fifo__device_8hpp__incl.png b/docs/doxygen/html/fifo__device_8hpp__incl.png
new file mode 100644
index 00000000..995ac540
Binary files /dev/null and b/docs/doxygen/html/fifo__device_8hpp__incl.png differ
diff --git a/docs/doxygen/html/fifo__device_8hpp_source.html b/docs/doxygen/html/fifo__device_8hpp_source.html
new file mode 100644
index 00000000..79ec67c6
--- /dev/null
+++ b/docs/doxygen/html/fifo__device_8hpp_source.html
@@ -0,0 +1,167 @@
+
+
+
+MSCCL++: fifo_device.hpp Source File
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_FIFO_DEVICE_HPP_
+
5 #define MSCCLPP_FIFO_DEVICE_HPP_
+
+
+
+
+
+
11 #if defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
14 #endif // defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
+
+
+
+
+
+
42 #if defined(MSCCLPP_DEVICE_COMPILE)
+
43 MSCCLPP_DEVICE_INLINE uint64_t push(
ProxyTrigger trigger, int64_t maxSpinCount = 1000000) {
+
49 uint64_t curFifoHead = atomicFetchAdd(this->
head , (uint64_t)1, memoryOrderRelaxed);
+
+
+
+
53 trigger.
snd ^= ((uint64_t)1 << (uint64_t)63);
+
+
+
+
+
+
+
+
61 OR_POLL_MAYBE_JAILBREAK((curFifoHead >=
size + atomicLoad(this->
tailReplica , memoryOrderRelaxed)),
+
62 (atomicLoad(&(this->
triggers [curFifoHead %
size ].fst), memoryOrderRelaxed) != 0),
+
+
+
+
+
+
+
+
70 #if defined(MSCCLPP_DEVICE_CUDA)
+
71 asm volatile (
"st.global.relaxed.sys.v2.u64 [%0], {%1,%2};" ::
"l" (triggerPtr),
"l" (trigger.
fst ),
"l" (trigger.
snd ));
+
72 #else // !defined(MSCCLPP_DEVICE_CUDA)
+
+
74 atomicStore(&(triggerPtr->
snd ), trigger.
snd , memoryOrderRelaxed);
+
75 atomicStore(&(triggerPtr->
fst ), trigger.
fst , memoryOrderRelaxed);
+
76 #endif // !defined(MSCCLPP_DEVICE_CUDA)
+
+
+
+
+
85 MSCCLPP_DEVICE_INLINE
void sync(uint64_t curFifoHead, int64_t maxSpinCount = 1000000) {
+
+
+
88 OR_POLL_MAYBE_JAILBREAK((curFifoHead >= atomicLoad(this->
tailReplica , memoryOrderRelaxed)),
+
89 (atomicLoad(&(this->
triggers [curFifoHead %
size ].fst), memoryOrderRelaxed) != 0),
+
+
+
92 #endif // defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
+
+
+
+
+
+
+
106 #endif // MSCCLPP_FIFO_DEVICE_HPP_
+
uint64_t fst
Definition: fifo_device.hpp:25
Definition: fifo_device.hpp:24
Definition: fifo_device.hpp:41
uint64_t * head
The FIFO head. Allocated on the device and only accessed by the device.
Definition: fifo_device.hpp:99
int size
The FIFO size.
Definition: fifo_device.hpp:101
uint64_t snd
Definition: fifo_device.hpp:25
uint64_t * tailReplica
Replica of the FIFO tail that is allocated on device.
Definition: fifo_device.hpp:97
ProxyTrigger * triggers
The FIFO buffer that is allocated on the host via cudaHostAlloc().
Definition: fifo_device.hpp:95
Definition: atomic_device.hpp:13
MSCCL++: File List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all files with brief descriptions:
+
MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+
MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+
MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+
MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+
MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+
MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+
MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+
MSCCL++: Class Members - Functions
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/functions_func_b.html b/docs/doxygen/html/functions_func_b.html
new file mode 100644
index 00000000..02890e20
--- /dev/null
+++ b/docs/doxygen/html/functions_func_b.html
@@ -0,0 +1,105 @@
+
+
+
+MSCCL++: Class Members - Functions
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/functions_func_c.html b/docs/doxygen/html/functions_func_c.html
new file mode 100644
index 00000000..8b93aa73
--- /dev/null
+++ b/docs/doxygen/html/functions_func_c.html
@@ -0,0 +1,117 @@
+
+
+
+MSCCL++: Class Members - Functions
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/functions_func_d.html b/docs/doxygen/html/functions_func_d.html
new file mode 100644
index 00000000..54486ed2
--- /dev/null
+++ b/docs/doxygen/html/functions_func_d.html
@@ -0,0 +1,102 @@
+
+
+
+MSCCL++: Class Members - Functions
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/functions_func_e.html b/docs/doxygen/html/functions_func_e.html
new file mode 100644
index 00000000..fca58ca6
--- /dev/null
+++ b/docs/doxygen/html/functions_func_e.html
@@ -0,0 +1,101 @@
+
+
+
+MSCCL++: Class Members - Functions
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/functions_func_f.html b/docs/doxygen/html/functions_func_f.html
new file mode 100644
index 00000000..f5dd126a
--- /dev/null
+++ b/docs/doxygen/html/functions_func_f.html
@@ -0,0 +1,89 @@
+
+
+
+MSCCL++: Class Members - Functions
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/functions_func_g.html b/docs/doxygen/html/functions_func_g.html
new file mode 100644
index 00000000..6340d8d0
--- /dev/null
+++ b/docs/doxygen/html/functions_func_g.html
@@ -0,0 +1,120 @@
+
+
+
+MSCCL++: Class Members - Functions
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/functions_func_h.html b/docs/doxygen/html/functions_func_h.html
new file mode 100644
index 00000000..76c583a4
--- /dev/null
+++ b/docs/doxygen/html/functions_func_h.html
@@ -0,0 +1,86 @@
+
+
+
+MSCCL++: Class Members - Functions
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/functions_func_i.html b/docs/doxygen/html/functions_func_i.html
new file mode 100644
index 00000000..bb045539
--- /dev/null
+++ b/docs/doxygen/html/functions_func_i.html
@@ -0,0 +1,86 @@
+
+
+
+MSCCL++: Class Members - Functions
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/functions_func_n.html b/docs/doxygen/html/functions_func_n.html
new file mode 100644
index 00000000..d16f9912
--- /dev/null
+++ b/docs/doxygen/html/functions_func_n.html
@@ -0,0 +1,86 @@
+
+
+
+MSCCL++: Class Members - Functions
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/functions_func_o.html b/docs/doxygen/html/functions_func_o.html
new file mode 100644
index 00000000..efd26262
--- /dev/null
+++ b/docs/doxygen/html/functions_func_o.html
@@ -0,0 +1,123 @@
+
+
+
+MSCCL++: Class Members - Functions
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/functions_func_p.html b/docs/doxygen/html/functions_func_p.html
new file mode 100644
index 00000000..a7276e1d
--- /dev/null
+++ b/docs/doxygen/html/functions_func_p.html
@@ -0,0 +1,102 @@
+
+
+
+MSCCL++: Class Members - Functions
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/functions_func_r.html b/docs/doxygen/html/functions_func_r.html
new file mode 100644
index 00000000..465f65a4
--- /dev/null
+++ b/docs/doxygen/html/functions_func_r.html
@@ -0,0 +1,103 @@
+
+
+
+MSCCL++: Class Members - Functions
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/functions_func_s.html b/docs/doxygen/html/functions_func_s.html
new file mode 100644
index 00000000..d6d0950d
--- /dev/null
+++ b/docs/doxygen/html/functions_func_s.html
@@ -0,0 +1,138 @@
+
+
+
+MSCCL++: Class Members - Functions
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/functions_func_t.html b/docs/doxygen/html/functions_func_t.html
new file mode 100644
index 00000000..b22ee49a
--- /dev/null
+++ b/docs/doxygen/html/functions_func_t.html
@@ -0,0 +1,99 @@
+
+
+
+MSCCL++: Class Members - Functions
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/functions_func_u.html b/docs/doxygen/html/functions_func_u.html
new file mode 100644
index 00000000..c78441e5
--- /dev/null
+++ b/docs/doxygen/html/functions_func_u.html
@@ -0,0 +1,80 @@
+
+
+
+MSCCL++: Class Members - Functions
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/functions_func_w.html b/docs/doxygen/html/functions_func_w.html
new file mode 100644
index 00000000..415c38e6
--- /dev/null
+++ b/docs/doxygen/html/functions_func_w.html
@@ -0,0 +1,86 @@
+
+
+
+MSCCL++: Class Members - Functions
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/functions_func_~.html b/docs/doxygen/html/functions_func_~.html
new file mode 100644
index 00000000..3812fdc7
--- /dev/null
+++ b/docs/doxygen/html/functions_func_~.html
@@ -0,0 +1,146 @@
+
+
+
+MSCCL++: Class Members - Functions
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/functions_g.html b/docs/doxygen/html/functions_g.html
new file mode 100644
index 00000000..b0efacea
--- /dev/null
+++ b/docs/doxygen/html/functions_g.html
@@ -0,0 +1,123 @@
+
+
+
+MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+
MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+
MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+
MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+kNumCpuEventBuffers
+: NpKit
+
+kNumGpuEventBuffers
+: NpKit
+
+
+
MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+
MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+
MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+
MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+
MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+
MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+
MSCCL++: Class Members - Related Functions
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/functions_s.html b/docs/doxygen/html/functions_s.html
new file mode 100644
index 00000000..4d5427a7
--- /dev/null
+++ b/docs/doxygen/html/functions_s.html
@@ -0,0 +1,170 @@
+
+
+
+MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+ScopedTimer()
+: mscclpp::ScopedTimer
+
+semaphore()
+: mscclpp::ProxyService
+
+semaphore_
+: mscclpp::ProxyChannelDeviceHandle
+, mscclpp::SmChannelDeviceHandle
+
+semaphoreId_
+: mscclpp::ProxyChannelDeviceHandle
+
+send()
+: mscclpp::Bootstrap
+, mscclpp::TcpBootstrap
+
+sendMemoryOnSetup()
+: mscclpp::Communicator
+
+serialize()
+: mscclpp::Endpoint
+, mscclpp::NvlsConnection
+, mscclpp::RegisteredMemory
+
+set()
+: mscclpp::Timer
+
+setup()
+: mscclpp::Communicator
+
+Shutdown()
+: NpKit
+
+signal()
+: mscclpp::Host2DeviceSemaphore
+, mscclpp::Host2HostSemaphore
+
+SimpleProxyChannel()
+: mscclpp::SimpleProxyChannel
+
+size
+: mscclpp::ChannelTrigger
+, mscclpp::Fifo
+, mscclpp::FifoDeviceHandle
+, mscclpp::RegisteredMemory
+, NpKitEvent
+
+size_
+: mscclpp::PhysicalCudaMemory< T >
+
+SmChannel()
+: mscclpp::SmChannel
+
+SmDevice2DeviceSemaphore()
+: mscclpp::SmDevice2DeviceSemaphore
+
+snd
+: mscclpp::ProxyTrigger
+
+src_
+: mscclpp::SimpleProxyChannelDeviceHandle
+, mscclpp::SmChannelDeviceHandle
+
+srcMemoryId
+: mscclpp::ChannelTrigger
+
+srcOffset
+: mscclpp::ChannelTrigger
+
+start()
+: mscclpp::Proxy
+
+start_
+: mscclpp::Timer
+
+startProxy()
+: mscclpp::BaseProxyService
+, mscclpp::ProxyService
+
+stop()
+: mscclpp::Proxy
+
+stopProxy()
+: mscclpp::BaseProxyService
+, mscclpp::ProxyService
+
+stream_
+: mscclpp::CudaStreamWithFlags
+
+SysError()
+: mscclpp::SysError
+
+
+
MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+
MSCCL++: Class Members - Typedefs
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/functions_u.html b/docs/doxygen/html/functions_u.html
new file mode 100644
index 00000000..7b80e838
--- /dev/null
+++ b/docs/doxygen/html/functions_u.html
@@ -0,0 +1,80 @@
+
+
+
+MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+
MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+
MSCCL++: Class Members - Variables
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+kNumCpuEventBuffers
+: NpKit
+
+kNumGpuEventBuffers
+: NpKit
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+
MSCCL++: Class Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
+
MSCCL++: File Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all file members with links to the files they belong to:
+
MSCCL++: File Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/gpu_8hpp.html b/docs/doxygen/html/gpu_8hpp.html
new file mode 100644
index 00000000..d63670a2
--- /dev/null
+++ b/docs/doxygen/html/gpu_8hpp.html
@@ -0,0 +1,156 @@
+
+
+
+MSCCL++: gpu.hpp File Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <cuda.h>#include <cuda_runtime.h>#include <linux/version.h>
+
+
+
+
+
+
+
Go to the source code of this file.
+
+#define USE_NVLS ((CUDART_VERSION >= 12010) && (LINUX_VERSION_CODE >= KERNEL_VERSION(5, 6, 0))) #define __syncshm () __syncthreads();
+
+
+
◆
+
+
+
+
+
+ #define __syncshm
+ (
+ )
+ __syncthreads();
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define USE_NVLS ((CUDART_VERSION >= 12010) && (LINUX_VERSION_CODE >= KERNEL_VERSION(5, 6, 0)))
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/gpu_8hpp__dep__incl.md5 b/docs/doxygen/html/gpu_8hpp__dep__incl.md5
new file mode 100644
index 00000000..b676d2eb
--- /dev/null
+++ b/docs/doxygen/html/gpu_8hpp__dep__incl.md5
@@ -0,0 +1 @@
+89f4c527d70fec2f626b880b39d2dbbf
\ No newline at end of file
diff --git a/docs/doxygen/html/gpu_8hpp__dep__incl.png b/docs/doxygen/html/gpu_8hpp__dep__incl.png
new file mode 100644
index 00000000..351bfb3a
Binary files /dev/null and b/docs/doxygen/html/gpu_8hpp__dep__incl.png differ
diff --git a/docs/doxygen/html/gpu_8hpp__incl.map b/docs/doxygen/html/gpu_8hpp__incl.map
new file mode 100644
index 00000000..9a0944f4
--- /dev/null
+++ b/docs/doxygen/html/gpu_8hpp__incl.map
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/doxygen/html/gpu_8hpp__incl.md5 b/docs/doxygen/html/gpu_8hpp__incl.md5
new file mode 100644
index 00000000..84ba501b
--- /dev/null
+++ b/docs/doxygen/html/gpu_8hpp__incl.md5
@@ -0,0 +1 @@
+3f8e3babe3c64dcf7c1feb3dd093876a
\ No newline at end of file
diff --git a/docs/doxygen/html/gpu_8hpp__incl.png b/docs/doxygen/html/gpu_8hpp__incl.png
new file mode 100644
index 00000000..bfa03fb4
Binary files /dev/null and b/docs/doxygen/html/gpu_8hpp__incl.png differ
diff --git a/docs/doxygen/html/gpu_8hpp_source.html b/docs/doxygen/html/gpu_8hpp_source.html
new file mode 100644
index 00000000..ca7ac46c
--- /dev/null
+++ b/docs/doxygen/html/gpu_8hpp_source.html
@@ -0,0 +1,193 @@
+
+
+
+MSCCL++: gpu.hpp Source File
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_GPU_HPP_
+
5 #define MSCCLPP_GPU_HPP_
+
+
7 #if defined(__HIP_PLATFORM_AMD__)
+
+
9 #include <hip/hip_runtime.h>
+
+
11 using cudaError_t = hipError_t;
+
12 using cudaGraph_t = hipGraph_t;
+
13 using cudaGraphExec_t = hipGraphExec_t;
+
14 using cudaDeviceProp = hipDeviceProp_t;
+
15 using cudaStream_t = hipStream_t;
+
16 using cudaStreamCaptureMode = hipStreamCaptureMode;
+
17 using cudaMemcpyKind = hipMemcpyKind;
+
18 using cudaIpcMemHandle_t = hipIpcMemHandle_t;
+
+
20 using CUresult = hipError_t;
+
21 using CUdeviceptr = hipDeviceptr_t;
+
22 using CUmemGenericAllocationHandle = hipMemGenericAllocationHandle_t;
+
23 using CUmemAllocationProp = hipMemAllocationProp;
+
24 using CUmemAccessDesc = hipMemAccessDesc;
+
+
26 constexpr
auto cudaSuccess = hipSuccess;
+
27 constexpr
auto cudaStreamNonBlocking = hipStreamNonBlocking;
+
28 constexpr
auto cudaStreamCaptureModeGlobal = hipStreamCaptureModeGlobal;
+
29 constexpr
auto cudaStreamCaptureModeRelaxed = hipStreamCaptureModeRelaxed;
+
30 constexpr
auto cudaHostAllocMapped = hipHostMallocMapped;
+
31 constexpr
auto cudaHostAllocWriteCombined = hipHostMallocWriteCombined;
+
32 constexpr
auto cudaMemcpyDefault = hipMemcpyDefault;
+
33 constexpr
auto cudaMemcpyDeviceToDevice = hipMemcpyDeviceToDevice;
+
34 constexpr
auto cudaMemcpyHostToDevice = hipMemcpyHostToDevice;
+
35 constexpr
auto cudaMemcpyDeviceToHost = hipMemcpyDeviceToHost;
+
36 constexpr
auto cudaIpcMemLazyEnablePeerAccess = hipIpcMemLazyEnablePeerAccess;
+
+
38 constexpr
auto CU_MEM_ALLOCATION_TYPE_PINNED = hipMemAllocationTypePinned;
+
39 constexpr
auto CU_MEM_LOCATION_TYPE_DEVICE = hipMemLocationTypeDevice;
+
40 constexpr
auto CU_MEM_HANDLE_TYPE_POSIX_FILE_DESCRIPTOR = hipMemHandleTypePosixFileDescriptor;
+
41 constexpr
auto CU_MEM_ACCESS_FLAGS_PROT_READWRITE = hipMemAccessFlagsProtReadWrite;
+
+
+
44 #define CUDA_SUCCESS hipSuccess
+
45 #endif // CUDA_SUCCESS
+
+
47 #define cudaGetErrorString(...) hipGetErrorString(__VA_ARGS__)
+
48 #define cudaGetDevice(...) hipGetDevice(__VA_ARGS__)
+
49 #define cudaGetDeviceCount(...) hipGetDeviceCount(__VA_ARGS__)
+
50 #define cudaGetDeviceProperties(...) hipGetDeviceProperties(__VA_ARGS__)
+
51 #define cudaGetLastError(...) hipGetLastError(__VA_ARGS__)
+
52 #define cudaSetDevice(...) hipSetDevice(__VA_ARGS__)
+
53 #define cudaDeviceSynchronize(...) hipDeviceSynchronize(__VA_ARGS__)
+
54 #define cudaDeviceGetPCIBusId(...) hipDeviceGetPCIBusId(__VA_ARGS__)
+
55 #define cudaHostAlloc(...) hipHostMalloc(__VA_ARGS__)
+
56 #define cudaMalloc(...) hipMalloc(__VA_ARGS__)
+
57 #define cudaFree(...) hipFree(__VA_ARGS__)
+
58 #define cudaFreeHost(...) hipHostFree(__VA_ARGS__)
+
59 #define cudaMemset(...) hipMemset(__VA_ARGS__)
+
60 #define cudaMemsetAsync(...) hipMemsetAsync(__VA_ARGS__)
+
61 #define cudaMemcpy(...) hipMemcpy(__VA_ARGS__)
+
62 #define cudaMemcpyAsync(...) hipMemcpyAsync(__VA_ARGS__)
+
63 #define cudaMemcpyToSymbol(...) hipMemcpyToSymbol(__VA_ARGS__)
+
64 #define cudaMemcpyToSymbolAsync(...) hipMemcpyToSymbolAsync(__VA_ARGS__)
+
65 #define cudaStreamCreate(...) hipStreamCreate(__VA_ARGS__)
+
66 #define cudaStreamCreateWithFlags(...) hipStreamCreateWithFlags(__VA_ARGS__)
+
67 #define cudaStreamSynchronize(...) hipStreamSynchronize(__VA_ARGS__)
+
68 #define cudaStreamBeginCapture(...) hipStreamBeginCapture(__VA_ARGS__)
+
69 #define cudaStreamEndCapture(...) hipStreamEndCapture(__VA_ARGS__)
+
70 #define cudaStreamDestroy(...) hipStreamDestroy(__VA_ARGS__)
+
71 #define cudaGraphInstantiate(...) hipGraphInstantiate(__VA_ARGS__)
+
72 #define cudaGraphLaunch(...) hipGraphLaunch(__VA_ARGS__)
+
73 #define cudaGraphDestroy(...) hipGraphDestroy(__VA_ARGS__)
+
74 #define cudaGraphExecDestroy(...) hipGraphExecDestroy(__VA_ARGS__)
+
75 #define cudaThreadExchangeStreamCaptureMode(...) hipThreadExchangeStreamCaptureMode(__VA_ARGS__)
+
76 #define cudaIpcGetMemHandle(...) hipIpcGetMemHandle(__VA_ARGS__)
+
77 #define cudaIpcOpenMemHandle(...) hipIpcOpenMemHandle(__VA_ARGS__)
+
78 #define cudaIpcCloseMemHandle(...) hipIpcCloseMemHandle(__VA_ARGS__)
+
+
80 #define cuGetErrorString(...) hipDrvGetErrorString(__VA_ARGS__)
+
81 #define cuMemAddressReserve(...) hipMemAddressReserve(__VA_ARGS__)
+
82 #define cuMemAddressFree(...) hipMemAddressFree(__VA_ARGS__)
+
83 #define cuMemGetAddressRange(...) hipMemGetAddressRange(__VA_ARGS__)
+
84 #define cuMemCreate(...) hipMemCreate(__VA_ARGS__)
+
85 #define cuMemRelease(...) hipMemRelease(__VA_ARGS__)
+
86 #define cuMemSetAccess(...) hipMemSetAccess(__VA_ARGS__)
+
87 #define cuMemMap(...) hipMemMap(__VA_ARGS__)
+
88 #define cuMemUnmap(...) hipMemUnmap(__VA_ARGS__)
+
+
+
+
+
93 #include <cuda_runtime.h>
+
+
+
+
+
98 #if !defined(__HIP_PLATFORM_AMD__)
+
99 #include <linux/version.h>
+
100 #define USE_NVLS ((CUDART_VERSION >= 12010) && (LINUX_VERSION_CODE >= KERNEL_VERSION(5, 6, 0)))
+
101 #else // !defined(__HIP_PLATFORM_AMD__)
+
+
103 #endif // !defined(__HIP_PLATFORM_AMD__)
+
+
+
106 #if defined(__HIP_PLATFORM_AMD__)
+
107 #define __syncshm() asm volatile("s_waitcnt lgkmcnt(0) \n s_barrier");
+
+
109 #define __syncshm() __syncthreads();
+
+
+
112 #endif // MSCCLPP_GPU_HPP_
+
MSCCL++: gpu_utils.hpp File Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <cstring>
+
#include <memory>
+
#include "errors.hpp "
+
#include "gpu.hpp "
+
+
+
+
+
+
+
+
Go to the source code of this file.
+
+template<class T > T * mscclpp::detail::cudaCalloc (size_t nelem) template<class T > PhysicalCudaMemory< T > * mscclpp::detail::cudaPhysicalCalloc (size_t nelem, size_t gran) template<class T > T * mscclpp::detail::cudaExtCalloc (size_t nelem) template<class T > T * mscclpp::detail::cudaHostCalloc (size_t nelem) template<class T , T * , class Deleter , class Memory > Memory mscclpp::detail::safeAlloc (size_t nelem) template<class T , T * , class Deleter , class Memory > Memory mscclpp::detail::safeAlloc (size_t nelem, size_t gran) template<class T > std::shared_ptr< T > mscclpp::allocSharedCuda (size_t count=1) template<class T > std::shared_ptr< PhysicalCudaMemory< T > > mscclpp::allocSharedPhysicalCuda (size_t count, size_t gran) template<class T > std::shared_ptr< T > mscclpp::allocExtSharedCuda (size_t count=1) template<class T > UniqueCudaPtr< T > mscclpp::allocUniqueCuda (size_t count=1) template<class T > std::unique_ptr< PhysicalCudaMemory< T > > mscclpp::allocUniquePhysicalCuda (size_t count, size_t gran) template<class T > UniqueCudaPtr< T > mscclpp::allocExtUniqueCuda (size_t count=1) template<class T , typename... Args> std::shared_ptr< T > mscclpp::makeSharedCudaHost (Args &&... args) template<class T > std::shared_ptr< T[]> mscclpp::makeSharedCudaHost (size_t count) template<class T , typename... Args, std::enable_if_t< false==std::is_array_v< T >, bool > = true> UniqueCudaHostPtr< T > mscclpp::makeUniqueCudaHost (Args &&... args) template<class T , std::enable_if_t< true==std::is_array_v< T >, bool > = true> UniqueCudaHostPtr< T > mscclpp::makeUniqueCudaHost (size_t count) template<class T > void mscclpp::memcpyCudaAsync (T *dst, const T *src, size_t count, cudaStream_t stream, cudaMemcpyKind kind=cudaMemcpyDefault) template<class T > void mscclpp::memcpyCuda (T *dst, const T *src, size_t count, cudaMemcpyKind kind=cudaMemcpyDefault)
+
+
+
◆
+
+
+
+
+
+ #define MSCCLPP_CUDATHROW
+ (
+
+ cmd )
+
+
+
+
Value: do { \
+
cudaError_t err = cmd; \
+
if (err != cudaSuccess) { \
+
throw
mscclpp::CudaError (std::string(
"Call to " #cmd
" failed. " ) + __FILE__ +
":" + std::to_string(__LINE__), \
+
err); \
+
} \
+
} while (false )
+
Throw mscclpp::CudaError if cmd does not return cudaSuccess.
Parameters
+
+ cmd The command to execute.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define MSCCLPP_CUTHROW
+ (
+
+ cmd )
+
+
+
+
Value: do { \
+
CUresult err = cmd; \
+
if (err != CUDA_SUCCESS) { \
+
throw
mscclpp::CuError (std::string(
"Call to " #cmd
" failed." ) + __FILE__ +
":" + std::to_string(__LINE__), \
+
err); \
+
} \
+
} while (false )
+
Throw mscclpp::CuError if cmd does not return CUDA_SUCCESS.
Parameters
+
+ cmd The command to execute.
+
+
+
+
+
+
An error from a CUDA driver library call.
Definition: errors.hpp:83
An error from a CUDA runtime library call.
Definition: errors.hpp:76
+
diff --git a/docs/doxygen/html/gpu__utils_8hpp__dep__incl.md5 b/docs/doxygen/html/gpu__utils_8hpp__dep__incl.md5
new file mode 100644
index 00000000..07a4de62
--- /dev/null
+++ b/docs/doxygen/html/gpu__utils_8hpp__dep__incl.md5
@@ -0,0 +1 @@
+a6a8577ef9cd7691c52fb597d9b3d2d1
\ No newline at end of file
diff --git a/docs/doxygen/html/gpu__utils_8hpp__dep__incl.png b/docs/doxygen/html/gpu__utils_8hpp__dep__incl.png
new file mode 100644
index 00000000..8e8c5504
Binary files /dev/null and b/docs/doxygen/html/gpu__utils_8hpp__dep__incl.png differ
diff --git a/docs/doxygen/html/gpu__utils_8hpp__incl.map b/docs/doxygen/html/gpu__utils_8hpp__incl.map
new file mode 100644
index 00000000..07770eae
--- /dev/null
+++ b/docs/doxygen/html/gpu__utils_8hpp__incl.map
@@ -0,0 +1,11 @@
+
+
diff --git a/docs/doxygen/html/gpu__utils_8hpp__incl.md5 b/docs/doxygen/html/gpu__utils_8hpp__incl.md5
new file mode 100644
index 00000000..1a7b60c9
--- /dev/null
+++ b/docs/doxygen/html/gpu__utils_8hpp__incl.md5
@@ -0,0 +1 @@
+0194237d087e93dbb2b6c098e5454eaa
\ No newline at end of file
diff --git a/docs/doxygen/html/gpu__utils_8hpp__incl.png b/docs/doxygen/html/gpu__utils_8hpp__incl.png
new file mode 100644
index 00000000..50f1d2ce
Binary files /dev/null and b/docs/doxygen/html/gpu__utils_8hpp__incl.png differ
diff --git a/docs/doxygen/html/gpu__utils_8hpp_source.html b/docs/doxygen/html/gpu__utils_8hpp_source.html
new file mode 100644
index 00000000..b53363a4
--- /dev/null
+++ b/docs/doxygen/html/gpu__utils_8hpp_source.html
@@ -0,0 +1,414 @@
+
+
+
+MSCCL++: gpu_utils.hpp Source File
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_GPU_UTILS_HPP_
+
5 #define MSCCLPP_GPU_UTILS_HPP_
+
+
+
+
+
+
+
+
15 #define MSCCLPP_CUDATHROW(cmd) \
+
+
17 cudaError_t err = cmd; \
+
18 if (err != cudaSuccess) { \
+
19 throw mscclpp::CudaError(std::string("Call to " #cmd " failed. ") + __FILE__ + ":" + std::to_string(__LINE__), \
+
+
+
+
+
26 #define MSCCLPP_CUTHROW(cmd) \
+
+
+
29 if (err != CUDA_SUCCESS) { \
+
30 throw mscclpp::CuError(std::string("Call to " #cmd " failed.") + __FILE__ + ":" + std::to_string(__LINE__), \
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
49 operator cudaStream_t()
const {
return stream_ ; }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
89 CUmemAllocationProp prop = {};
+
90 prop.type = CU_MEM_ALLOCATION_TYPE_PINNED;
+
91 prop.location.type = CU_MEM_LOCATION_TYPE_DEVICE;
+
92 prop.location.id = deviceId;
+
93 #if defined(__HIP_PLATFORM_AMD__)
+
+
95 prop.requestedHandleType = CU_MEM_HANDLE_TYPE_POSIX_FILE_DESCRIPTOR;
+
+
97 prop.requestedHandleTypes = CU_MEM_HANDLE_TYPE_POSIX_FILE_DESCRIPTOR;
+
+
+
100 CUmemGenericAllocationHandle memHandle;
+
101 size_t bufferSize =
sizeof (T) * nelem;
+
+
+
+
105 CUmemAccessDesc accessDesc = {};
+
106 accessDesc.location.type = CU_MEM_LOCATION_TYPE_DEVICE;
+
107 accessDesc.location.id = deviceId;
+
108 accessDesc.flags = CU_MEM_ACCESS_FLAGS_PROT_READWRITE;
+
+
110 T* devicePtr =
nullptr ;
+
+
112 MSCCLPP_CUTHROW (cuMemAddressReserve((CUdeviceptr*)&devicePtr, bufferSize, gran, 0U, 0));
+
113 MSCCLPP_CUTHROW (cuMemMap((CUdeviceptr)devicePtr, bufferSize, 0, memHandle, 0));
+
114 MSCCLPP_CUTHROW (cuMemSetAccess((CUdeviceptr)devicePtr, bufferSize, &accessDesc, 1));
+
+
+
+
+
+
+
+
+
+
+
+
+
+
128 #if defined(__HIP_PLATFORM_AMD__)
+
129 MSCCLPP_CUDATHROW (hipExtMallocWithFlags((
void **)&ptr, nelem *
sizeof (T), hipDeviceMallocUncached));
+
+
+
+
+
+
+
+
+
+
+
+
+
146 MSCCLPP_CUDATHROW (cudaHostAlloc(&ptr, nelem *
sizeof (T), cudaHostAllocMapped | cudaHostAllocWriteCombined));
+
147 memset(ptr, 0, nelem *
sizeof (T));
+
+
+
+
160 template <
class T, T*(alloc)(
size_t ),
class Deleter,
class Memory>
+
+
+
+
+
+
+
+
+
+
+
171 return Memory(ptr, Deleter());
+
+
+
174 template <
class T, T*(alloc)(
size_t ,
size_t ),
class Deleter,
class Memory>
+
+
176 if ((nelem *
sizeof (T)) % gran) {
+
177 throw Error (
"The request allocation size is not divisible by the required granularity:" +
+
178 std::to_string(nelem *
sizeof (T)) +
" vs " + std::to_string(gran),
+
+
+
+
+
183 ptr = alloc(nelem, gran);
+
+
+
+
+
+
+
190 return Memory(ptr, Deleter());
+
+
+
+
+
+
+
199 using TPtrOrArray = std::conditional_t<std::is_array_v<T>, T, T*>;
+
+
+
+
+
+
+
+
+
208 static_assert(!std::is_array_v<T>,
"T must not be an array" );
+
+
+
+
+
+
+
+
+
+
+
221 using TPtrOrArray = std::conditional_t<std::is_array_v<T>, T, T*>;
+
+
+
+
+
+
+
+
+
234 return detail::safeAlloc<T, detail::cudaCalloc<T>,
CudaDeleter<T> , std::shared_ptr<T>>(count);
+
+
+
+
+
+
246 std::shared_ptr<PhysicalCudaMemory<T>>>(count, gran);
+
+
+
+
+
255 return detail::safeAlloc<T, detail::cudaExtCalloc<T>,
CudaDeleter<T> , std::shared_ptr<T>>(count);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
298 template <
class T,
typename ... Args>
+
+
300 auto ptr = detail::safeAlloc<T, detail::cudaHostCalloc<T>,
CudaHostDeleter<T> , std::shared_ptr<T>>(1);
+
301 new (ptr.get()) T(std::forward<Args>(args)...);
+
+
+
+
+
+
312 using TElem = std::remove_extent_t<T>;
+
313 auto ptr = detail::safeAlloc<T, detail::cudaHostCalloc<T>,
CudaHostDeleter<TElem> , std::shared_ptr<T[]>>(count);
+
314 for (
size_t i = 0; i < count; ++i) {
+
315 new (&ptr[i]) TElem();
+
+
+
+
+
+
+
+
330 template <
class T,
typename ... Args, std::enable_if_t<false == std::is_array_v<T>,
bool > =
true >
+
+
+
333 new (ptr.get()) T(std::forward<Args>(args)...);
+
+
+
+
342 template <
class T, std::enable_if_t<true == std::is_array_v<T>,
bool > = true>
+
+
344 using TElem = std::remove_extent_t<T>;
+
+
346 for (
size_t i = 0; i < count; ++i) {
+
347 new (&ptr[i]) TElem();
+
+
+
+
+
+
360 void memcpyCudaAsync (T* dst,
const T* src,
size_t count, cudaStream_t stream, cudaMemcpyKind kind = cudaMemcpyDefault) {
+
+
+
+
+
+
372 void memcpyCuda (T* dst,
const T* src,
size_t count, cudaMemcpyKind kind = cudaMemcpyDefault) {
+
+
+
+
+
+
+
+
+
381 #endif // MSCCLPP_GPU_UTILS_HPP_
+
CudaStreamWithFlags(unsigned int flags)
T * cudaHostCalloc(size_t nelem)
Definition: gpu_utils.hpp:143
void memcpyCuda(T *dst, const T *src, size_t count, cudaMemcpyKind kind=cudaMemcpyDefault)
Definition: gpu_utils.hpp:372
A RAII wrapper around cudaStream_t that will call cudaStreamDestroy on destruction.
Definition: gpu_utils.hpp:46
Definition: gpu_utils.hpp:220
T * cudaExtCalloc(size_t nelem)
Definition: gpu_utils.hpp:124
std::shared_ptr< T > allocSharedCuda(size_t count=1)
Definition: gpu_utils.hpp:233
cudaStreamCaptureMode mode_
Definition: gpu_utils.hpp:42
size_t size_
Definition: gpu_utils.hpp:60
Definition: gpu_utils.hpp:39
T * cudaCalloc(size_t nelem)
Definition: gpu_utils.hpp:72
UniqueCudaHostPtr< T > makeUniqueCudaHost(Args &&... args)
Definition: gpu_utils.hpp:331
std::shared_ptr< T > makeSharedCudaHost(Args &&... args)
Definition: gpu_utils.hpp:299
#define MSCCLPP_CUDATHROW(cmd)
Definition: gpu_utils.hpp:15
void operator()(TPtrOrArray ptr)
Definition: gpu_utils.hpp:222
UniqueCudaPtr< T > allocUniqueCuda(size_t count=1)
Definition: gpu_utils.hpp:268
cudaStream_t stream_
Definition: gpu_utils.hpp:50
std::conditional_t< std::is_array_v< T >, T, T * > TPtrOrArray
Definition: gpu_utils.hpp:199
void memcpyCudaAsync(T *dst, const T *src, size_t count, cudaStream_t stream, cudaMemcpyKind kind=cudaMemcpyDefault)
Definition: gpu_utils.hpp:360
Memory safeAlloc(size_t nelem)
Definition: gpu_utils.hpp:161
CUmemGenericAllocationHandle memHandle_
Definition: gpu_utils.hpp:58
void operator()(TPtrOrArray ptr)
Definition: gpu_utils.hpp:200
PhysicalCudaMemory(CUmemGenericAllocationHandle memHandle, T *devicePtr, size_t size)
Definition: gpu_utils.hpp:61
T * devicePtr_
Definition: gpu_utils.hpp:59
std::unique_ptr< T, CudaDeleter< T > > UniqueCudaPtr
Definition: gpu_utils.hpp:261
AvoidCudaGraphCaptureGuard()
void operator()(PhysicalCudaMemory< T > *ptr)
Definition: gpu_utils.hpp:209
#define MSCCLPP_CUTHROW(cmd)
Definition: gpu_utils.hpp:26
A generic error.
Definition: errors.hpp:61
std::conditional_t< std::is_array_v< T >, T, T * > TPtrOrArray
Definition: gpu_utils.hpp:221
~AvoidCudaGraphCaptureGuard()
std::shared_ptr< PhysicalCudaMemory< T > > allocSharedPhysicalCuda(size_t count, size_t gran)
Definition: gpu_utils.hpp:244
std::unique_ptr< T, CudaHostDeleter< T > > UniqueCudaHostPtr
Definition: gpu_utils.hpp:323
PhysicalCudaMemory< T > * cudaPhysicalCalloc(size_t nelem, size_t gran)
Definition: gpu_utils.hpp:83
std::shared_ptr< T > allocExtSharedCuda(size_t count=1)
Definition: gpu_utils.hpp:254
Definition: gpu_utils.hpp:207
UniqueCudaPtr< T > allocExtUniqueCuda(size_t count=1)
Definition: gpu_utils.hpp:289
std::unique_ptr< PhysicalCudaMemory< T > > allocUniquePhysicalCuda(size_t count, size_t gran)
Definition: gpu_utils.hpp:279
Definition: atomic_device.hpp:13
Definition: gpu_utils.hpp:54
Definition: gpu_utils.hpp:57
MSCCL++: Graph Legend
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This page explains how to interpret the graphs that are generated by doxygen.
+
Consider the following example:
+
class Invisible { };
+
+
+
class Truncated : public Invisible { };
+
+
+
class Undocumented { };
+
+
+
class PublicBase : public Truncated { };
+
+
+
template <class T> class Templ { };
+
+
+
class ProtectedBase { };
+
+
+
class PrivateBase { };
+
+
+
class Used { };
+
+
+
class Inherited : public PublicBase,
+
protected ProtectedBase,
+
private PrivateBase,
+
public Undocumented,
+
public Templ<int>
+
{
+
private :
+
Used *m_usedClass;
+
};
+
This will result in the following graph:
+
The boxes in the above graph have the following meaning:
+
+
+A filled gray box represents the struct or class for which the graph is generated.
+
+A box with a black border denotes a documented struct or class.
+
+A box with a gray border denotes an undocumented struct or class.
+
+A box with a red border denotes a documented struct or class forwhich not all inheritance/containment relations are shown. A graph is truncated if it does not fit within the specified boundaries.
+
+
The arrows have the following meaning:
+
+
+A dark blue arrow is used to visualize a public inheritance relation between two classes.
+
+A dark green arrow is used for protected inheritance.
+
+A dark red arrow is used for private inheritance.
+
+A purple dashed arrow is used if a class is contained or used by another class. The arrow is labelled with the variable(s) through which the pointed class or struct is accessible.
+
+A yellow dashed arrow denotes a relation between a template instance and the template class it was instantiated from. The arrow is labelled with the template parameters of the instance.
+
+
MSCCL++: Class Hierarchy
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the graphical class hierarchy
+This inheritance list is sorted roughly, but not completely, alphabetically:
+
MSCCL++: MSCCL++
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Latest Release License ](LICENSE) CodeQL
+
+
+Pipelines Build Status
+
+Unit Tests (CUDA)
+
+Integration Tests (CUDA)
+
+Integration Tests (ROCm)
+
+
A GPU-driven communication stack for scalable AI applications.
+
See Quick Start to quickly get started.
+
+
MSCCL++ redefines inter-GPU communication interfaces, thereby delivering a highly efficient and customizable communication stack for distributed GPU applications. Its design is specifically tailored to accommodate diverse performance optimization scenarios often encountered in state-of-the-art AI applications. Figure below provides a high-level overview of MSCCL++ abstractions in CUDA, C, and Python.
+
+
+MSCCL++ Abstractions Overview
+
+
+
+
The followings highlight the key features of MSCCL++.
+Light-weight and multi-layer abstractions. MSCCL++ provides communication abstractions at lowest level close to hardware and at the highest level close to application API. The lowest level of abstraction is ultra light weight which enables a user to implement logics of data movement for a collective operation such as AllReduce inside a GPU kernel extremely efficiently without worrying about memory ordering of different ops. The modularity of MSCCL++ enables a user to construct the building blocks of MSCCL++ in a high level abstraction in Python and feed them to a CUDA kernel in order to facilitate the user's productivity.1-sided 0-copy synchronous and asynchronous abstracts. MSCCL++ provides fine-grained synchronous and asynchronous 0-copy 1-sided abstracts for communication primitives such as put(), get(), signal(), flush(), and wait(). The 1-sided abstractions allows a user to asynchronously put() their data on the remote GPU as soon as it is ready without requiring the remote side to issue any receive instruction. This enables users to easily implement flexible communication logics, such as overlapping communication with computation, or implementing customized collective communication algorithms without worrying about potential deadlocks. Additionally, the 0-copy capability enables MSCCL++ to directly transfer data between user's buffers without using intermediate internal buffers which saves GPU bandwidth and memory capacity.Unified abstractions for different interconnection hardware. MSCCL++ provides consistent abstractions regardless of the location of the remote GPU (either on the local node or on a remote node) or the underlying link (either NVLink/xGMI or InfiniBand). This simplifies the code for inter-GPU communication, which is often complex due to memory ordering of GPU/CPU read/writes and therefore, is error-prone.
+
+
While the power of MSCCL++ is fully realized with application-specific optimization, it still delivers performance benefits even for collective communication operations. The following figures provide a comparison of the AllReduce throughput of MSCCL++ against NCCL 2.19.3. This benchmark was tested over two Azure NDmv4 SKUs (8 A100-80G GPUs per node). The key motivation behind these results is scaling of inference for LLM models using tensor parallelism. LLM requests usually are executed in two phases: prompt processing and token sampling. The prompt processing uses a large batch size that is usually equal to a request context length and the corresponding AllReduce size is len_context*dim_hidden*sizeof(fp16). For a context length of 2048 with a hidden dimension of 12288 (GPT-3 size), the AllReduce size is 48MB. The token sampling uses a smaller batch size which corresponds to concurrent user requests in the system and therefore, the AllReduce size is batch_size*dim_hidden*sizeof(fp16). For a concurrency of 16 users, the AllReduce size is 384KB. As the figures below demonstrates, MSCCL++ provides significant speed up over NCCL which is crucial for efficiency of serving LLMs at large scale.
+
+Single-node AllReduce Two-node AllReduce
+
+
+
+
+
The following highlights key concepts of MSCCL++.
+
MSCCL++ provides peer-to-peer communication methods between GPUs. A peer-to-peer connection between two GPUs is called a Channel . Channels are constructed by MSCCL++ host-side interfaces and copied to GPUs during initialization. Channels provide GPU-side interfaces , which means that all communication methods are defined as a device function to be called from a GPU kernel code. For example, the put() method in the following example copies 1KB data from the local GPU to a remote GPU.
+
+
__global__ void gpuKernel() {
+
...
+
+
channel.put( 0, 0, 1024);
+
...
+
}
+
MSCCL++ also provides efficient synchronization methods, signal(), flush(), and wait(). For example, we can implement a simple barrier between two ranks (peer-to-peer connected through channel) as follows. Explanation of each method is inlined.
+
__device__ void barrier() {
+
+
channel.signal();
+
+
channel.flush();
+
+
channel.wait();
+
+
+
+
}
+
MSCCL++ provides consistent interfaces, i.e., the above interfaces are used regardless of the location of the remote GPU (either on the local node or on a remote node) or the underlying link (either NVLink/xGMI or InfiniBand).
+
MSCCL++ delivers two types of channels, ProxyChannel and SmChannel . ProxyChannel provides (R)DMA-based data copy and synchronization methods. When called, these methods send/receive a signal to/from a host-side proxy (hence the name ProxyChannel), which will trigger (R)DMA (such as cudaMemcpy* or ibv_post_send) or issue synchronization methods (such as cudaStreamSynchronize or ibv_poll_cq). Since the key functionalities are run by the proxy, ProxyChannel requires only a single GPU thread to call its methods. See all ProxyChannel methods from here . On the other hand, SmChannel provides memory-mapping-based copy and synchronization methods. When called, these methods will directly use GPU threads to read/write from/to the remote GPU's memory space. Comparing against ProxyChannel, SmChannel is especially performant for low-latency scenarios, while it may need many GPU threads to call copying methods at the same time to achieve high copying bandwidth. See all SmChannel methods from here .
+
MSCCL++ provides a default implementation of a host-side proxy for ProxyChannels, which is a background host thread that busy polls triggers from GPUs and conducts functionalities accordingly. For example, the following is a typical host-side code for MSCCL++. ```cpp // Bootstrap: initialize control-plane connections between all ranks auto bootstrap = std::make_shared<mscclpp::TcpBootstrap>(rank, world_size); // Create a communicator for connection setup mscclpp::Communicator comm(bootstrap); // Setup connections here using comm ... // Construct the default proxy mscclpp::ProxyService proxyService(); // Start the proxy proxyService.startProxy(); // Run the user application, i.e., launch GPU kernels here ... // Stop the proxy after the application is finished proxyService.stopProxy(); While the default implementation already enables any kinds of communication, MSCCL++ also supports users to easily implement their own customized proxies for further optimization. For example, the following example re-defines how to interpret triggers from GPUs.
+
+
```cpp
+
// Proxy FIFO is obtained from mscclpp::Proxy on the host and copied to the device.
+
__device__ mscclpp::FifoDeviceHandle fifo;
+
__global__ void gpuKernel() {
+
...
+
// Only one thread is needed for the followings
+
mscclpp::ProxyTrigger trigger;
+
// Send a custom request: "1"
+
trigger.fst = 1;
+
fifo.push(trigger);
+
// Send a custom request: "2"
+
trigger.fst = 2;
+
fifo.push(trigger);
+
// Send a custom request: "0xdeadbeef"
+
trigger.fst = 0xdeadbeef;
+
fifo.push(trigger);
+
...
+
}
+
+
// Host-side custom proxy service
+
class CustomProxyService {
+
private:
+
mscclpp::Proxy proxy_;
+
public:
+
CustomProxyService() : proxy_([&](mscclpp::ProxyTrigger trigger) {
+
// Custom trigger handler
+
if (trigger.fst == 1) {
+
// Handle request "1"
+
} else if (trigger.fst == 2) {
+
// Handle request "2"
+
} else if (trigger.fst == 0xdeadbeef) {
+
// Handle request "0xdeadbeef"
+
}
+
},
+
[&]() { /* Empty proxy initializer */ }) {}
+
void startProxy() { proxy_.start(); }
+
void stopProxy() { proxy_.stop(); }
+
};
+
Customized proxies can be used for conducting a series of pre-defined data transfers within only a single trigger from GPU at runtime. This would be more efficient than sending a trigger for each data transfer one by one.
+
MSCCL++ provides Python bindings and interfaces, which simplifies integration with Python applications.
+
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com . When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. This project has adopted the Microsoft Open Source Code of Conduct . For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
+
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines . Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.
+
typename T::DeviceHandle DeviceHandle
A type which could be safely used in device side.
Definition: core.hpp:709
+
diff --git a/docs/doxygen/html/inherit_graph_0.md5 b/docs/doxygen/html/inherit_graph_0.md5
new file mode 100644
index 00000000..ce5ac481
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_0.md5
@@ -0,0 +1 @@
+5e11ee5377d5bc584584e313e61ec1e1
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_0.png b/docs/doxygen/html/inherit_graph_0.png
new file mode 100644
index 00000000..75164cd0
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_0.png differ
diff --git a/docs/doxygen/html/inherit_graph_1.map b/docs/doxygen/html/inherit_graph_1.map
new file mode 100644
index 00000000..51e28eef
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_1.map
@@ -0,0 +1,9 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_1.md5 b/docs/doxygen/html/inherit_graph_1.md5
new file mode 100644
index 00000000..d663829e
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_1.md5
@@ -0,0 +1 @@
+1b267dc3a7f107334ab6c1279e853192
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_1.png b/docs/doxygen/html/inherit_graph_1.png
new file mode 100644
index 00000000..7e6b4073
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_1.png differ
diff --git a/docs/doxygen/html/inherit_graph_10.map b/docs/doxygen/html/inherit_graph_10.map
new file mode 100644
index 00000000..4d61fc1c
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_10.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_10.md5 b/docs/doxygen/html/inherit_graph_10.md5
new file mode 100644
index 00000000..5823f0f2
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_10.md5
@@ -0,0 +1 @@
+b0313f682ac0a8169ecc18b881aff250
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_10.png b/docs/doxygen/html/inherit_graph_10.png
new file mode 100644
index 00000000..8bdbacad
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_10.png differ
diff --git a/docs/doxygen/html/inherit_graph_11.map b/docs/doxygen/html/inherit_graph_11.map
new file mode 100644
index 00000000..6e05e412
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_11.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_11.md5 b/docs/doxygen/html/inherit_graph_11.md5
new file mode 100644
index 00000000..c8d20a16
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_11.md5
@@ -0,0 +1 @@
+3f9de965198edbb81fe9066ee3f5b62f
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_11.png b/docs/doxygen/html/inherit_graph_11.png
new file mode 100644
index 00000000..97c0e1a9
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_11.png differ
diff --git a/docs/doxygen/html/inherit_graph_12.map b/docs/doxygen/html/inherit_graph_12.map
new file mode 100644
index 00000000..b8e32b27
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_12.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_12.md5 b/docs/doxygen/html/inherit_graph_12.md5
new file mode 100644
index 00000000..13f386ac
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_12.md5
@@ -0,0 +1 @@
+19f9532ff8d8e0a15f77c286b885448a
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_12.png b/docs/doxygen/html/inherit_graph_12.png
new file mode 100644
index 00000000..bc3b8891
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_12.png differ
diff --git a/docs/doxygen/html/inherit_graph_13.map b/docs/doxygen/html/inherit_graph_13.map
new file mode 100644
index 00000000..579042a4
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_13.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_13.md5 b/docs/doxygen/html/inherit_graph_13.md5
new file mode 100644
index 00000000..99adac22
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_13.md5
@@ -0,0 +1 @@
+985e8f27a09136d5c8d22237cbb1eb81
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_13.png b/docs/doxygen/html/inherit_graph_13.png
new file mode 100644
index 00000000..fcca3155
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_13.png differ
diff --git a/docs/doxygen/html/inherit_graph_14.map b/docs/doxygen/html/inherit_graph_14.map
new file mode 100644
index 00000000..cf05870c
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_14.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_14.md5 b/docs/doxygen/html/inherit_graph_14.md5
new file mode 100644
index 00000000..02e18108
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_14.md5
@@ -0,0 +1 @@
+f63397e999cfa4caaf096298991e1991
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_14.png b/docs/doxygen/html/inherit_graph_14.png
new file mode 100644
index 00000000..874565d6
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_14.png differ
diff --git a/docs/doxygen/html/inherit_graph_15.map b/docs/doxygen/html/inherit_graph_15.map
new file mode 100644
index 00000000..da71f68f
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_15.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_15.md5 b/docs/doxygen/html/inherit_graph_15.md5
new file mode 100644
index 00000000..6ae7591f
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_15.md5
@@ -0,0 +1 @@
+8ee086c76c4416d8b566502b8823e453
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_15.png b/docs/doxygen/html/inherit_graph_15.png
new file mode 100644
index 00000000..e512ff72
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_15.png differ
diff --git a/docs/doxygen/html/inherit_graph_16.map b/docs/doxygen/html/inherit_graph_16.map
new file mode 100644
index 00000000..ff5e29b6
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_16.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_16.md5 b/docs/doxygen/html/inherit_graph_16.md5
new file mode 100644
index 00000000..5341dfe7
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_16.md5
@@ -0,0 +1 @@
+dcba043e2869d7af379a29cd7fa0b558
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_16.png b/docs/doxygen/html/inherit_graph_16.png
new file mode 100644
index 00000000..24806fca
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_16.png differ
diff --git a/docs/doxygen/html/inherit_graph_17.map b/docs/doxygen/html/inherit_graph_17.map
new file mode 100644
index 00000000..7a547286
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_17.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_17.md5 b/docs/doxygen/html/inherit_graph_17.md5
new file mode 100644
index 00000000..51d4ba29
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_17.md5
@@ -0,0 +1 @@
+fc6c97a5503899990b73f542db80e53f
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_17.png b/docs/doxygen/html/inherit_graph_17.png
new file mode 100644
index 00000000..514b9da8
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_17.png differ
diff --git a/docs/doxygen/html/inherit_graph_18.map b/docs/doxygen/html/inherit_graph_18.map
new file mode 100644
index 00000000..ab2284b9
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_18.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_18.md5 b/docs/doxygen/html/inherit_graph_18.md5
new file mode 100644
index 00000000..da995d0f
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_18.md5
@@ -0,0 +1 @@
+eff10779a578aa30287671af89bf41fc
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_18.png b/docs/doxygen/html/inherit_graph_18.png
new file mode 100644
index 00000000..a093773d
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_18.png differ
diff --git a/docs/doxygen/html/inherit_graph_19.map b/docs/doxygen/html/inherit_graph_19.map
new file mode 100644
index 00000000..01199a49
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_19.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_19.md5 b/docs/doxygen/html/inherit_graph_19.md5
new file mode 100644
index 00000000..fce3c1cb
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_19.md5
@@ -0,0 +1 @@
+9cf969b37de51abffe276bbd8c9fad8f
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_19.png b/docs/doxygen/html/inherit_graph_19.png
new file mode 100644
index 00000000..cd8eb9af
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_19.png differ
diff --git a/docs/doxygen/html/inherit_graph_2.map b/docs/doxygen/html/inherit_graph_2.map
new file mode 100644
index 00000000..d62faa33
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_2.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_2.md5 b/docs/doxygen/html/inherit_graph_2.md5
new file mode 100644
index 00000000..141a1bee
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_2.md5
@@ -0,0 +1 @@
+2109712a7335dceda108e0ab54d79ce7
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_2.png b/docs/doxygen/html/inherit_graph_2.png
new file mode 100644
index 00000000..e1f801e9
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_2.png differ
diff --git a/docs/doxygen/html/inherit_graph_20.map b/docs/doxygen/html/inherit_graph_20.map
new file mode 100644
index 00000000..11300c52
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_20.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_20.md5 b/docs/doxygen/html/inherit_graph_20.md5
new file mode 100644
index 00000000..e17f095c
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_20.md5
@@ -0,0 +1 @@
+2f39d8f5af701b31e9af313de4f74211
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_20.png b/docs/doxygen/html/inherit_graph_20.png
new file mode 100644
index 00000000..6446add4
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_20.png differ
diff --git a/docs/doxygen/html/inherit_graph_21.map b/docs/doxygen/html/inherit_graph_21.map
new file mode 100644
index 00000000..fc630ac6
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_21.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_21.md5 b/docs/doxygen/html/inherit_graph_21.md5
new file mode 100644
index 00000000..bee1c382
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_21.md5
@@ -0,0 +1 @@
+f576912c0377238e784337ccc575b6a8
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_21.png b/docs/doxygen/html/inherit_graph_21.png
new file mode 100644
index 00000000..54c02b8d
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_21.png differ
diff --git a/docs/doxygen/html/inherit_graph_22.map b/docs/doxygen/html/inherit_graph_22.map
new file mode 100644
index 00000000..2b9f0348
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_22.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_22.md5 b/docs/doxygen/html/inherit_graph_22.md5
new file mode 100644
index 00000000..d3d2ffe2
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_22.md5
@@ -0,0 +1 @@
+791ce970765335d7afbd7e84713a42d8
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_22.png b/docs/doxygen/html/inherit_graph_22.png
new file mode 100644
index 00000000..8a378883
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_22.png differ
diff --git a/docs/doxygen/html/inherit_graph_23.map b/docs/doxygen/html/inherit_graph_23.map
new file mode 100644
index 00000000..c4a13412
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_23.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_23.md5 b/docs/doxygen/html/inherit_graph_23.md5
new file mode 100644
index 00000000..3969f71f
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_23.md5
@@ -0,0 +1 @@
+8437d44ed3cec71aef5dca100d7f790d
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_23.png b/docs/doxygen/html/inherit_graph_23.png
new file mode 100644
index 00000000..70eebeb3
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_23.png differ
diff --git a/docs/doxygen/html/inherit_graph_24.map b/docs/doxygen/html/inherit_graph_24.map
new file mode 100644
index 00000000..2f608704
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_24.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_24.md5 b/docs/doxygen/html/inherit_graph_24.md5
new file mode 100644
index 00000000..3df331e7
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_24.md5
@@ -0,0 +1 @@
+a78a4c62e43262bd8195b2116190974c
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_24.png b/docs/doxygen/html/inherit_graph_24.png
new file mode 100644
index 00000000..98df0a14
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_24.png differ
diff --git a/docs/doxygen/html/inherit_graph_25.map b/docs/doxygen/html/inherit_graph_25.map
new file mode 100644
index 00000000..771ffcf4
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_25.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_25.md5 b/docs/doxygen/html/inherit_graph_25.md5
new file mode 100644
index 00000000..6766cc14
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_25.md5
@@ -0,0 +1 @@
+b8b5c0f01d16739e29260fa8034c2910
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_25.png b/docs/doxygen/html/inherit_graph_25.png
new file mode 100644
index 00000000..fed1c47e
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_25.png differ
diff --git a/docs/doxygen/html/inherit_graph_26.map b/docs/doxygen/html/inherit_graph_26.map
new file mode 100644
index 00000000..6d348ee5
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_26.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_26.md5 b/docs/doxygen/html/inherit_graph_26.md5
new file mode 100644
index 00000000..51c9f839
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_26.md5
@@ -0,0 +1 @@
+1abdaa64ca8450f8727fe2db8e8c49cb
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_26.png b/docs/doxygen/html/inherit_graph_26.png
new file mode 100644
index 00000000..86ee0f40
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_26.png differ
diff --git a/docs/doxygen/html/inherit_graph_27.map b/docs/doxygen/html/inherit_graph_27.map
new file mode 100644
index 00000000..a65d5e0e
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_27.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_27.md5 b/docs/doxygen/html/inherit_graph_27.md5
new file mode 100644
index 00000000..306f5033
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_27.md5
@@ -0,0 +1 @@
+bb543179606b5b2c68ec547c9a3f2fb3
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_27.png b/docs/doxygen/html/inherit_graph_27.png
new file mode 100644
index 00000000..4803cfa2
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_27.png differ
diff --git a/docs/doxygen/html/inherit_graph_28.map b/docs/doxygen/html/inherit_graph_28.map
new file mode 100644
index 00000000..2a3a50ca
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_28.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_28.md5 b/docs/doxygen/html/inherit_graph_28.md5
new file mode 100644
index 00000000..de750a82
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_28.md5
@@ -0,0 +1 @@
+045e69a19950f7e1abeba25780435fe4
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_28.png b/docs/doxygen/html/inherit_graph_28.png
new file mode 100644
index 00000000..b7dc2ed0
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_28.png differ
diff --git a/docs/doxygen/html/inherit_graph_29.map b/docs/doxygen/html/inherit_graph_29.map
new file mode 100644
index 00000000..f42997c2
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_29.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_29.md5 b/docs/doxygen/html/inherit_graph_29.md5
new file mode 100644
index 00000000..f0d966a5
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_29.md5
@@ -0,0 +1 @@
+607ec7eb3e939a0dadadbc13aed3131b
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_29.png b/docs/doxygen/html/inherit_graph_29.png
new file mode 100644
index 00000000..86a4b7ea
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_29.png differ
diff --git a/docs/doxygen/html/inherit_graph_3.map b/docs/doxygen/html/inherit_graph_3.map
new file mode 100644
index 00000000..0d60d4f2
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_3.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_3.md5 b/docs/doxygen/html/inherit_graph_3.md5
new file mode 100644
index 00000000..a8160c14
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_3.md5
@@ -0,0 +1 @@
+50dbacb9ff8663bacd1330a0b9a69416
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_3.png b/docs/doxygen/html/inherit_graph_3.png
new file mode 100644
index 00000000..f3e1c35d
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_3.png differ
diff --git a/docs/doxygen/html/inherit_graph_30.map b/docs/doxygen/html/inherit_graph_30.map
new file mode 100644
index 00000000..59e8a53b
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_30.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_30.md5 b/docs/doxygen/html/inherit_graph_30.md5
new file mode 100644
index 00000000..78d093ac
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_30.md5
@@ -0,0 +1 @@
+513a5659c5ffb3346a1cbfb4fb026476
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_30.png b/docs/doxygen/html/inherit_graph_30.png
new file mode 100644
index 00000000..62d6ca6d
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_30.png differ
diff --git a/docs/doxygen/html/inherit_graph_31.map b/docs/doxygen/html/inherit_graph_31.map
new file mode 100644
index 00000000..0fc55ba4
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_31.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_31.md5 b/docs/doxygen/html/inherit_graph_31.md5
new file mode 100644
index 00000000..efe216ed
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_31.md5
@@ -0,0 +1 @@
+5ed1ba009dba51742e09e6e5875188bb
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_31.png b/docs/doxygen/html/inherit_graph_31.png
new file mode 100644
index 00000000..2c669d7d
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_31.png differ
diff --git a/docs/doxygen/html/inherit_graph_32.map b/docs/doxygen/html/inherit_graph_32.map
new file mode 100644
index 00000000..3d1874f6
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_32.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_32.md5 b/docs/doxygen/html/inherit_graph_32.md5
new file mode 100644
index 00000000..1926958d
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_32.md5
@@ -0,0 +1 @@
+aa4f15607de6c4af9b680a7012eb5899
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_32.png b/docs/doxygen/html/inherit_graph_32.png
new file mode 100644
index 00000000..5835bda8
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_32.png differ
diff --git a/docs/doxygen/html/inherit_graph_33.map b/docs/doxygen/html/inherit_graph_33.map
new file mode 100644
index 00000000..b82525a9
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_33.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_33.md5 b/docs/doxygen/html/inherit_graph_33.md5
new file mode 100644
index 00000000..e4887416
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_33.md5
@@ -0,0 +1 @@
+2b3f77c5858c3ec29cafe1f1252b8804
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_33.png b/docs/doxygen/html/inherit_graph_33.png
new file mode 100644
index 00000000..a7ae2495
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_33.png differ
diff --git a/docs/doxygen/html/inherit_graph_34.map b/docs/doxygen/html/inherit_graph_34.map
new file mode 100644
index 00000000..ff84b108
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_34.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_34.md5 b/docs/doxygen/html/inherit_graph_34.md5
new file mode 100644
index 00000000..34f25981
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_34.md5
@@ -0,0 +1 @@
+908a3031599bff7c1d2d6a7fd6621864
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_34.png b/docs/doxygen/html/inherit_graph_34.png
new file mode 100644
index 00000000..3d020acb
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_34.png differ
diff --git a/docs/doxygen/html/inherit_graph_35.map b/docs/doxygen/html/inherit_graph_35.map
new file mode 100644
index 00000000..ce54dcd0
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_35.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_35.md5 b/docs/doxygen/html/inherit_graph_35.md5
new file mode 100644
index 00000000..66014c79
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_35.md5
@@ -0,0 +1 @@
+e11426977d6ceb8623e8215dfcc2ac73
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_35.png b/docs/doxygen/html/inherit_graph_35.png
new file mode 100644
index 00000000..a532675d
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_35.png differ
diff --git a/docs/doxygen/html/inherit_graph_36.map b/docs/doxygen/html/inherit_graph_36.map
new file mode 100644
index 00000000..ee1b53f2
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_36.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_36.md5 b/docs/doxygen/html/inherit_graph_36.md5
new file mode 100644
index 00000000..0a4c38cb
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_36.md5
@@ -0,0 +1 @@
+d412698da604921babc3b1c1ac3593c3
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_36.png b/docs/doxygen/html/inherit_graph_36.png
new file mode 100644
index 00000000..a024ed85
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_36.png differ
diff --git a/docs/doxygen/html/inherit_graph_37.map b/docs/doxygen/html/inherit_graph_37.map
new file mode 100644
index 00000000..cd6d0aab
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_37.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_37.md5 b/docs/doxygen/html/inherit_graph_37.md5
new file mode 100644
index 00000000..8099d6ed
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_37.md5
@@ -0,0 +1 @@
+70be46a2c17c38ab3c4b33b231c8201b
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_37.png b/docs/doxygen/html/inherit_graph_37.png
new file mode 100644
index 00000000..b4cbe761
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_37.png differ
diff --git a/docs/doxygen/html/inherit_graph_38.map b/docs/doxygen/html/inherit_graph_38.map
new file mode 100644
index 00000000..d9c5cd76
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_38.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_38.md5 b/docs/doxygen/html/inherit_graph_38.md5
new file mode 100644
index 00000000..4d1bb4b0
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_38.md5
@@ -0,0 +1 @@
+a29084a0e913bcc5612cc07f35b01d83
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_38.png b/docs/doxygen/html/inherit_graph_38.png
new file mode 100644
index 00000000..d1a58bb0
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_38.png differ
diff --git a/docs/doxygen/html/inherit_graph_39.map b/docs/doxygen/html/inherit_graph_39.map
new file mode 100644
index 00000000..578d3b14
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_39.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_39.md5 b/docs/doxygen/html/inherit_graph_39.md5
new file mode 100644
index 00000000..f9093f6b
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_39.md5
@@ -0,0 +1 @@
+f13585ebe1028760e2dd60fe45eb14e3
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_39.png b/docs/doxygen/html/inherit_graph_39.png
new file mode 100644
index 00000000..d738e42d
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_39.png differ
diff --git a/docs/doxygen/html/inherit_graph_4.map b/docs/doxygen/html/inherit_graph_4.map
new file mode 100644
index 00000000..f220bd50
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_4.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_4.md5 b/docs/doxygen/html/inherit_graph_4.md5
new file mode 100644
index 00000000..bd5a7508
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_4.md5
@@ -0,0 +1 @@
+48eede47d3a980888634e4decd0ef2f7
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_4.png b/docs/doxygen/html/inherit_graph_4.png
new file mode 100644
index 00000000..560fe184
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_4.png differ
diff --git a/docs/doxygen/html/inherit_graph_40.map b/docs/doxygen/html/inherit_graph_40.map
new file mode 100644
index 00000000..af943c82
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_40.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_40.md5 b/docs/doxygen/html/inherit_graph_40.md5
new file mode 100644
index 00000000..e9d994ee
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_40.md5
@@ -0,0 +1 @@
+eb69e3656df6d4b2b84547e7d320ce10
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_40.png b/docs/doxygen/html/inherit_graph_40.png
new file mode 100644
index 00000000..f35cb395
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_40.png differ
diff --git a/docs/doxygen/html/inherit_graph_41.map b/docs/doxygen/html/inherit_graph_41.map
new file mode 100644
index 00000000..6b5f572f
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_41.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_41.md5 b/docs/doxygen/html/inherit_graph_41.md5
new file mode 100644
index 00000000..083fed0a
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_41.md5
@@ -0,0 +1 @@
+7518e36401dc97a29170e562c0dcfe19
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_41.png b/docs/doxygen/html/inherit_graph_41.png
new file mode 100644
index 00000000..6b354f10
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_41.png differ
diff --git a/docs/doxygen/html/inherit_graph_42.map b/docs/doxygen/html/inherit_graph_42.map
new file mode 100644
index 00000000..de334a2c
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_42.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_42.md5 b/docs/doxygen/html/inherit_graph_42.md5
new file mode 100644
index 00000000..70f7be1e
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_42.md5
@@ -0,0 +1 @@
+b6d75bc9c74310b27a4a8125cfbb7851
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_42.png b/docs/doxygen/html/inherit_graph_42.png
new file mode 100644
index 00000000..7bcc8d4d
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_42.png differ
diff --git a/docs/doxygen/html/inherit_graph_43.map b/docs/doxygen/html/inherit_graph_43.map
new file mode 100644
index 00000000..9dff2a66
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_43.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_43.md5 b/docs/doxygen/html/inherit_graph_43.md5
new file mode 100644
index 00000000..ae06ca39
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_43.md5
@@ -0,0 +1 @@
+95faa1e398f50506f0e83c8f90a21fb4
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_43.png b/docs/doxygen/html/inherit_graph_43.png
new file mode 100644
index 00000000..07f47383
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_43.png differ
diff --git a/docs/doxygen/html/inherit_graph_44.map b/docs/doxygen/html/inherit_graph_44.map
new file mode 100644
index 00000000..a8d8e158
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_44.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_44.md5 b/docs/doxygen/html/inherit_graph_44.md5
new file mode 100644
index 00000000..859eda24
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_44.md5
@@ -0,0 +1 @@
+d41c107e84a48c2bfae5fa8ab5a03122
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_44.png b/docs/doxygen/html/inherit_graph_44.png
new file mode 100644
index 00000000..97278621
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_44.png differ
diff --git a/docs/doxygen/html/inherit_graph_45.map b/docs/doxygen/html/inherit_graph_45.map
new file mode 100644
index 00000000..7782f33b
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_45.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_45.md5 b/docs/doxygen/html/inherit_graph_45.md5
new file mode 100644
index 00000000..f59b86a2
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_45.md5
@@ -0,0 +1 @@
+3bdc44a6c365077d4c6f964672b2965f
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_45.png b/docs/doxygen/html/inherit_graph_45.png
new file mode 100644
index 00000000..6cbb4c65
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_45.png differ
diff --git a/docs/doxygen/html/inherit_graph_46.map b/docs/doxygen/html/inherit_graph_46.map
new file mode 100644
index 00000000..0749f458
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_46.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_46.md5 b/docs/doxygen/html/inherit_graph_46.md5
new file mode 100644
index 00000000..90d7d120
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_46.md5
@@ -0,0 +1 @@
+1219e4847ea051b38676a7d3a0563634
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_46.png b/docs/doxygen/html/inherit_graph_46.png
new file mode 100644
index 00000000..682e8ffc
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_46.png differ
diff --git a/docs/doxygen/html/inherit_graph_47.map b/docs/doxygen/html/inherit_graph_47.map
new file mode 100644
index 00000000..0e407e45
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_47.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_47.md5 b/docs/doxygen/html/inherit_graph_47.md5
new file mode 100644
index 00000000..23064198
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_47.md5
@@ -0,0 +1 @@
+6c6366e8b1f0c43df3fd46736441dd04
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_47.png b/docs/doxygen/html/inherit_graph_47.png
new file mode 100644
index 00000000..57b7073f
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_47.png differ
diff --git a/docs/doxygen/html/inherit_graph_5.map b/docs/doxygen/html/inherit_graph_5.map
new file mode 100644
index 00000000..091e1766
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_5.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_5.md5 b/docs/doxygen/html/inherit_graph_5.md5
new file mode 100644
index 00000000..7fc54a54
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_5.md5
@@ -0,0 +1 @@
+c0128d6d1562537bc52ee510bd04eb0f
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_5.png b/docs/doxygen/html/inherit_graph_5.png
new file mode 100644
index 00000000..50d2c4ea
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_5.png differ
diff --git a/docs/doxygen/html/inherit_graph_6.map b/docs/doxygen/html/inherit_graph_6.map
new file mode 100644
index 00000000..4288dbe4
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_6.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_6.md5 b/docs/doxygen/html/inherit_graph_6.md5
new file mode 100644
index 00000000..d0c728b5
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_6.md5
@@ -0,0 +1 @@
+4f8f20f8552a32669df99fe50386ae1b
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_6.png b/docs/doxygen/html/inherit_graph_6.png
new file mode 100644
index 00000000..15b3556b
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_6.png differ
diff --git a/docs/doxygen/html/inherit_graph_7.map b/docs/doxygen/html/inherit_graph_7.map
new file mode 100644
index 00000000..73d52a71
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_7.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_7.md5 b/docs/doxygen/html/inherit_graph_7.md5
new file mode 100644
index 00000000..7861d526
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_7.md5
@@ -0,0 +1 @@
+a71e56d9827f757aaaca868ebcaafbe1
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_7.png b/docs/doxygen/html/inherit_graph_7.png
new file mode 100644
index 00000000..b5618667
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_7.png differ
diff --git a/docs/doxygen/html/inherit_graph_8.map b/docs/doxygen/html/inherit_graph_8.map
new file mode 100644
index 00000000..da1deb60
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_8.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_8.md5 b/docs/doxygen/html/inherit_graph_8.md5
new file mode 100644
index 00000000..09991e0c
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_8.md5
@@ -0,0 +1 @@
+9e46131a35d0c683f9fba01b45a5f023
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_8.png b/docs/doxygen/html/inherit_graph_8.png
new file mode 100644
index 00000000..4726e1c3
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_8.png differ
diff --git a/docs/doxygen/html/inherit_graph_9.map b/docs/doxygen/html/inherit_graph_9.map
new file mode 100644
index 00000000..14c27c0d
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_9.map
@@ -0,0 +1,3 @@
+
+
diff --git a/docs/doxygen/html/inherit_graph_9.md5 b/docs/doxygen/html/inherit_graph_9.md5
new file mode 100644
index 00000000..4767589b
--- /dev/null
+++ b/docs/doxygen/html/inherit_graph_9.md5
@@ -0,0 +1 @@
+ff4e2f01780f050d7fbcd4288f1ec193
\ No newline at end of file
diff --git a/docs/doxygen/html/inherit_graph_9.png b/docs/doxygen/html/inherit_graph_9.png
new file mode 100644
index 00000000..a3c539b5
Binary files /dev/null and b/docs/doxygen/html/inherit_graph_9.png differ
diff --git a/docs/doxygen/html/inherits.html b/docs/doxygen/html/inherits.html
new file mode 100644
index 00000000..f4bda855
--- /dev/null
+++ b/docs/doxygen/html/inherits.html
@@ -0,0 +1,334 @@
+
+
+
+MSCCL++: Class Hierarchy
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/jquery.js b/docs/doxygen/html/jquery.js
new file mode 100644
index 00000000..103c32d7
--- /dev/null
+++ b/docs/doxygen/html/jquery.js
@@ -0,0 +1,35 @@
+/*! jQuery v3.4.1 | (c) JS Foundation and other contributors | jquery.org/license */
+!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],E=C.document,r=Object.getPrototypeOf,s=t.slice,g=t.concat,u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType},x=function(e){return null!=e&&e===e.window},c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.4.1",k=function(e,t){return new k.fn.init(e,t)},p=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g;function d(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp($),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+$),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\([\\da-f]{1,6}"+M+"?|("+M+")|.)","ig"),ne=function(e,t,n){var r="0x"+t-65536;return r!=r||n?t:r<0?String.fromCharCode(r+65536):String.fromCharCode(r>>10|55296,1023&r|56320)},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(m.childNodes),m.childNodes),t[m.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&((e?e.ownerDocument||e:m)!==C&&T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!A[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&U.test(t)){(s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=k),o=(l=h(t)).length;while(o--)l[o]="#"+s+" "+xe(l[o]);c=l.join(","),f=ee.test(t)&&ye(e.parentNode)||e}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){A(t,!0)}finally{s===k&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[k]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e.namespaceURI,n=(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:m;return r!==C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),m!==C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=k,!C.getElementsByName||!C.getElementsByName(k).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){a.appendChild(e).innerHTML="":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=p[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&p(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?k.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?k.grep(e,function(e){return e===n!==r}):"string"!=typeof n?k.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(k.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||q,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:L.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof k?t[0]:t,k.merge(this,k.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),D.test(r[1])&&k.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(k):k.makeArray(e,this)}).prototype=k.fn,q=k(E);var H=/^(?:parents|prev(?:Until|All))/,O={children:!0,contents:!0,next:!0,prev:!0};function P(e,t){while((e=e[t])&&1!==e.nodeType);return e}k.fn.extend({has:function(e){var t=k(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i,ge={option:[1,""," "],thead:[1,""],col:[2,""],tr:[2,""],td:[3,""],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?k.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;nx",y.noCloneChecked=!!me.cloneNode(!0).lastChild.defaultValue;var Te=/^key/,Ce=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,Ee=/^([^.]*)(?:\.(.+)|)/;function ke(){return!0}function Se(){return!1}function Ne(e,t){return e===function(){try{return E.activeElement}catch(e){}}()==("focus"===t)}function Ae(e,t,n,r,i,o){var a,s;if("object"==typeof t){for(s in"string"!=typeof n&&(r=r||n,n=void 0),t)Ae(e,s,n,r,t[s],o);return e}if(null==r&&null==i?(i=n,r=n=void 0):null==i&&("string"==typeof n?(i=r,r=void 0):(i=r,r=n,n=void 0)),!1===i)i=Se;else if(!i)return e;return 1===o&&(a=i,(i=function(e){return k().off(e),a.apply(this,arguments)}).guid=a.guid||(a.guid=k.guid++)),e.each(function(){k.event.add(this,t,i,r,n)})}function De(e,i,o){o?(Q.set(e,i,!1),k.event.add(e,i,{namespace:!1,handler:function(e){var t,n,r=Q.get(this,i);if(1&e.isTrigger&&this[i]){if(r.length)(k.event.special[i]||{}).delegateType&&e.stopPropagation();else if(r=s.call(arguments),Q.set(this,i,r),t=o(this,i),this[i](),r!==(n=Q.get(this,i))||t?Q.set(this,i,!1):n={},r!==n)return e.stopImmediatePropagation(),e.preventDefault(),n.value}else r.length&&(Q.set(this,i,{value:k.event.trigger(k.extend(r[0],k.Event.prototype),r.slice(1),this)}),e.stopImmediatePropagation())}})):void 0===Q.get(e,i)&&k.event.add(e,i,ke)}k.event={global:{},add:function(t,e,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Q.get(t);if(v){n.handler&&(n=(o=n).handler,i=o.selector),i&&k.find.matchesSelector(ie,i),n.guid||(n.guid=k.guid++),(u=v.events)||(u=v.events={}),(a=v.handle)||(a=v.handle=function(e){return"undefined"!=typeof k&&k.event.triggered!==e.type?k.event.dispatch.apply(t,arguments):void 0}),l=(e=(e||"").match(R)||[""]).length;while(l--)d=g=(s=Ee.exec(e[l])||[])[1],h=(s[2]||"").split(".").sort(),d&&(f=k.event.special[d]||{},d=(i?f.delegateType:f.bindType)||d,f=k.event.special[d]||{},c=k.extend({type:d,origType:g,data:r,handler:n,guid:n.guid,selector:i,needsContext:i&&k.expr.match.needsContext.test(i),namespace:h.join(".")},o),(p=u[d])||((p=u[d]=[]).delegateCount=0,f.setup&&!1!==f.setup.call(t,r,h,a)||t.addEventListener&&t.addEventListener(d,a)),f.add&&(f.add.call(t,c),c.handler.guid||(c.handler.guid=n.guid)),i?p.splice(p.delegateCount++,0,c):p.push(c),k.event.global[d]=!0)}},remove:function(e,t,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Q.hasData(e)&&Q.get(e);if(v&&(u=v.events)){l=(t=(t||"").match(R)||[""]).length;while(l--)if(d=g=(s=Ee.exec(t[l])||[])[1],h=(s[2]||"").split(".").sort(),d){f=k.event.special[d]||{},p=u[d=(r?f.delegateType:f.bindType)||d]||[],s=s[2]&&new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"),a=o=p.length;while(o--)c=p[o],!i&&g!==c.origType||n&&n.guid!==c.guid||s&&!s.test(c.namespace)||r&&r!==c.selector&&("**"!==r||!c.selector)||(p.splice(o,1),c.selector&&p.delegateCount--,f.remove&&f.remove.call(e,c));a&&!p.length&&(f.teardown&&!1!==f.teardown.call(e,h,v.handle)||k.removeEvent(e,d,v.handle),delete u[d])}else for(d in u)k.event.remove(e,d+t[l],n,r,!0);k.isEmptyObject(u)&&Q.remove(e,"handle events")}},dispatch:function(e){var t,n,r,i,o,a,s=k.event.fix(e),u=new Array(arguments.length),l=(Q.get(this,"events")||{})[s.type]||[],c=k.event.special[s.type]||{};for(u[0]=s,t=1;t\x20\t\r\n\f]*)[^>]*)\/>/gi,qe=/\s*$/g;function Oe(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&k(e).children("tbody")[0]||e}function Pe(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function Re(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Me(e,t){var n,r,i,o,a,s,u,l;if(1===t.nodeType){if(Q.hasData(e)&&(o=Q.access(e),a=Q.set(t,o),l=o.events))for(i in delete a.handle,a.events={},l)for(n=0,r=l[i].length;n")},clone:function(e,t,n){var r,i,o,a,s,u,l,c=e.cloneNode(!0),f=oe(e);if(!(y.noCloneChecked||1!==e.nodeType&&11!==e.nodeType||k.isXMLDoc(e)))for(a=ve(c),r=0,i=(o=ve(e)).length;r").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Vt,Gt=[],Yt=/(=)\?(?=&|$)|\?\?/;k.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Gt.pop()||k.expando+"_"+kt++;return this[e]=!0,e}}),k.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Yt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Yt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Yt,"$1"+r):!1!==e.jsonp&&(e.url+=(St.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||k.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?k(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Gt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((Vt=E.implementation.createHTMLDocument("").body).innerHTML="",2===Vt.childNodes.length),k.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=D.exec(e))?[t.createElement(i[1])]:(i=we([e],t,o),o&&o.length&&k(o).remove(),k.merge([],i.childNodes)));var r,i,o},k.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(k.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},k.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){k.fn[t]=function(e){return this.on(t,e)}}),k.expr.pseudos.animated=function(t){return k.grep(k.timers,function(e){return t===e.elem}).length},k.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=k.css(e,"position"),c=k(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=k.css(e,"top"),u=k.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,k.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},k.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){k.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===k.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===k.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=k(e).offset()).top+=k.css(e,"borderTopWidth",!0),i.left+=k.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-k.css(r,"marginTop",!0),left:t.left-i.left-k.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===k.css(e,"position"))e=e.offsetParent;return e||ie})}}),k.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;k.fn[t]=function(e){return _(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),k.each(["top","left"],function(e,n){k.cssHooks[n]=ze(y.pixelPosition,function(e,t){if(t)return t=_e(e,n),$e.test(t)?k(e).position()[n]+"px":t})}),k.each({Height:"height",Width:"width"},function(a,s){k.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){k.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return _(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?k.css(e,t,i):k.style(e,t,n,i)},s,n?e:void 0,n)}})}),k.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){k.fn[n]=function(e,t){return 0a;a++)for(i in o[a])n=o[a][i],o[a].hasOwnProperty(i)&&void 0!==n&&(e[i]=t.isPlainObject(n)?t.isPlainObject(e[i])?t.widget.extend({},e[i],n):t.widget.extend({},n):n);return e},t.widget.bridge=function(e,i){var n=i.prototype.widgetFullName||e;t.fn[e]=function(o){var a="string"==typeof o,r=s.call(arguments,1),h=this;return a?this.length||"instance"!==o?this.each(function(){var i,s=t.data(this,n);return"instance"===o?(h=s,!1):s?t.isFunction(s[o])&&"_"!==o.charAt(0)?(i=s[o].apply(s,r),i!==s&&void 0!==i?(h=i&&i.jquery?h.pushStack(i.get()):i,!1):void 0):t.error("no such method '"+o+"' for "+e+" widget instance"):t.error("cannot call methods on "+e+" prior to initialization; "+"attempted to call method '"+o+"'")}):h=void 0:(r.length&&(o=t.widget.extend.apply(null,[o].concat(r))),this.each(function(){var e=t.data(this,n);e?(e.option(o||{}),e._init&&e._init()):t.data(this,n,new i(o,this))})),h}},t.Widget=function(){},t.Widget._childConstructors=[],t.Widget.prototype={widgetName:"widget",widgetEventPrefix:"",defaultElement:"",options:{classes:{},disabled:!1,create:null},_createWidget:function(e,s){s=t(s||this.defaultElement||this)[0],this.element=t(s),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=t(),this.hoverable=t(),this.focusable=t(),this.classesElementLookup={},s!==this&&(t.data(s,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===s&&this.destroy()}}),this.document=t(s.style?s.ownerDocument:s.document||s),this.window=t(this.document[0].defaultView||this.document[0].parentWindow)),this.options=t.widget.extend({},this.options,this._getCreateOptions(),e),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:t.noop,_create:t.noop,_init:t.noop,destroy:function(){var e=this;this._destroy(),t.each(this.classesElementLookup,function(t,i){e._removeClass(i,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:t.noop,widget:function(){return this.element},option:function(e,i){var s,n,o,a=e;if(0===arguments.length)return t.widget.extend({},this.options);if("string"==typeof e)if(a={},s=e.split("."),e=s.shift(),s.length){for(n=a[e]=t.widget.extend({},this.options[e]),o=0;s.length-1>o;o++)n[s[o]]=n[s[o]]||{},n=n[s[o]];if(e=s.pop(),1===arguments.length)return void 0===n[e]?null:n[e];n[e]=i}else{if(1===arguments.length)return void 0===this.options[e]?null:this.options[e];a[e]=i}return this._setOptions(a),this},_setOptions:function(t){var e;for(e in t)this._setOption(e,t[e]);return this},_setOption:function(t,e){return"classes"===t&&this._setOptionClasses(e),this.options[t]=e,"disabled"===t&&this._setOptionDisabled(e),this},_setOptionClasses:function(e){var i,s,n;for(i in e)n=this.classesElementLookup[i],e[i]!==this.options.classes[i]&&n&&n.length&&(s=t(n.get()),this._removeClass(n,i),s.addClass(this._classes({element:s,keys:i,classes:e,add:!0})))},_setOptionDisabled:function(t){this._toggleClass(this.widget(),this.widgetFullName+"-disabled",null,!!t),t&&(this._removeClass(this.hoverable,null,"ui-state-hover"),this._removeClass(this.focusable,null,"ui-state-focus"))},enable:function(){return this._setOptions({disabled:!1})},disable:function(){return this._setOptions({disabled:!0})},_classes:function(e){function i(i,o){var a,r;for(r=0;i.length>r;r++)a=n.classesElementLookup[i[r]]||t(),a=e.add?t(t.unique(a.get().concat(e.element.get()))):t(a.not(e.element).get()),n.classesElementLookup[i[r]]=a,s.push(i[r]),o&&e.classes[i[r]]&&s.push(e.classes[i[r]])}var s=[],n=this;return e=t.extend({element:this.element,classes:this.options.classes||{}},e),this._on(e.element,{remove:"_untrackClassesElement"}),e.keys&&i(e.keys.match(/\S+/g)||[],!0),e.extra&&i(e.extra.match(/\S+/g)||[]),s.join(" ")},_untrackClassesElement:function(e){var i=this;t.each(i.classesElementLookup,function(s,n){-1!==t.inArray(e.target,n)&&(i.classesElementLookup[s]=t(n.not(e.target).get()))})},_removeClass:function(t,e,i){return this._toggleClass(t,e,i,!1)},_addClass:function(t,e,i){return this._toggleClass(t,e,i,!0)},_toggleClass:function(t,e,i,s){s="boolean"==typeof s?s:i;var n="string"==typeof t||null===t,o={extra:n?e:i,keys:n?t:e,element:n?this.element:t,add:s};return o.element.toggleClass(this._classes(o),s),this},_on:function(e,i,s){var n,o=this;"boolean"!=typeof e&&(s=i,i=e,e=!1),s?(i=n=t(i),this.bindings=this.bindings.add(i)):(s=i,i=this.element,n=this.widget()),t.each(s,function(s,a){function r(){return e||o.options.disabled!==!0&&!t(this).hasClass("ui-state-disabled")?("string"==typeof a?o[a]:a).apply(o,arguments):void 0}"string"!=typeof a&&(r.guid=a.guid=a.guid||r.guid||t.guid++);var h=s.match(/^([\w:-]*)\s*(.*)$/),l=h[1]+o.eventNamespace,c=h[2];c?n.on(l,c,r):i.on(l,r)})},_off:function(e,i){i=(i||"").split(" ").join(this.eventNamespace+" ")+this.eventNamespace,e.off(i).off(i),this.bindings=t(this.bindings.not(e).get()),this.focusable=t(this.focusable.not(e).get()),this.hoverable=t(this.hoverable.not(e).get())},_delay:function(t,e){function i(){return("string"==typeof t?s[t]:t).apply(s,arguments)}var s=this;return setTimeout(i,e||0)},_hoverable:function(e){this.hoverable=this.hoverable.add(e),this._on(e,{mouseenter:function(e){this._addClass(t(e.currentTarget),null,"ui-state-hover")},mouseleave:function(e){this._removeClass(t(e.currentTarget),null,"ui-state-hover")}})},_focusable:function(e){this.focusable=this.focusable.add(e),this._on(e,{focusin:function(e){this._addClass(t(e.currentTarget),null,"ui-state-focus")},focusout:function(e){this._removeClass(t(e.currentTarget),null,"ui-state-focus")}})},_trigger:function(e,i,s){var n,o,a=this.options[e];if(s=s||{},i=t.Event(i),i.type=(e===this.widgetEventPrefix?e:this.widgetEventPrefix+e).toLowerCase(),i.target=this.element[0],o=i.originalEvent)for(n in o)n in i||(i[n]=o[n]);return this.element.trigger(i,s),!(t.isFunction(a)&&a.apply(this.element[0],[i].concat(s))===!1||i.isDefaultPrevented())}},t.each({show:"fadeIn",hide:"fadeOut"},function(e,i){t.Widget.prototype["_"+e]=function(s,n,o){"string"==typeof n&&(n={effect:n});var a,r=n?n===!0||"number"==typeof n?i:n.effect||i:e;n=n||{},"number"==typeof n&&(n={duration:n}),a=!t.isEmptyObject(n),n.complete=o,n.delay&&s.delay(n.delay),a&&t.effects&&t.effects.effect[r]?s[e](n):r!==e&&s[r]?s[r](n.duration,n.easing,o):s.queue(function(i){t(this)[e](),o&&o.call(s[0]),i()})}}),t.widget,function(){function e(t,e,i){return[parseFloat(t[0])*(u.test(t[0])?e/100:1),parseFloat(t[1])*(u.test(t[1])?i/100:1)]}function i(e,i){return parseInt(t.css(e,i),10)||0}function s(e){var i=e[0];return 9===i.nodeType?{width:e.width(),height:e.height(),offset:{top:0,left:0}}:t.isWindow(i)?{width:e.width(),height:e.height(),offset:{top:e.scrollTop(),left:e.scrollLeft()}}:i.preventDefault?{width:0,height:0,offset:{top:i.pageY,left:i.pageX}}:{width:e.outerWidth(),height:e.outerHeight(),offset:e.offset()}}var n,o=Math.max,a=Math.abs,r=/left|center|right/,h=/top|center|bottom/,l=/[\+\-]\d+(\.[\d]+)?%?/,c=/^\w+/,u=/%$/,d=t.fn.position;t.position={scrollbarWidth:function(){if(void 0!==n)return n;var e,i,s=t("
"),o=s.children()[0];return t("body").append(s),e=o.offsetWidth,s.css("overflow","scroll"),i=o.offsetWidth,e===i&&(i=s[0].clientWidth),s.remove(),n=e-i},getScrollInfo:function(e){var i=e.isWindow||e.isDocument?"":e.element.css("overflow-x"),s=e.isWindow||e.isDocument?"":e.element.css("overflow-y"),n="scroll"===i||"auto"===i&&e.width
i?"left":e>0?"right":"center",vertical:0>r?"top":s>0?"bottom":"middle"};l>p&&p>a(e+i)&&(u.horizontal="center"),c>f&&f>a(s+r)&&(u.vertical="middle"),u.important=o(a(e),a(i))>o(a(s),a(r))?"horizontal":"vertical",n.using.call(this,t,u)}),h.offset(t.extend(D,{using:r}))})},t.ui.position={fit:{left:function(t,e){var i,s=e.within,n=s.isWindow?s.scrollLeft:s.offset.left,a=s.width,r=t.left-e.collisionPosition.marginLeft,h=n-r,l=r+e.collisionWidth-a-n;e.collisionWidth>a?h>0&&0>=l?(i=t.left+h+e.collisionWidth-a-n,t.left+=h-i):t.left=l>0&&0>=h?n:h>l?n+a-e.collisionWidth:n:h>0?t.left+=h:l>0?t.left-=l:t.left=o(t.left-r,t.left)},top:function(t,e){var i,s=e.within,n=s.isWindow?s.scrollTop:s.offset.top,a=e.within.height,r=t.top-e.collisionPosition.marginTop,h=n-r,l=r+e.collisionHeight-a-n;e.collisionHeight>a?h>0&&0>=l?(i=t.top+h+e.collisionHeight-a-n,t.top+=h-i):t.top=l>0&&0>=h?n:h>l?n+a-e.collisionHeight:n:h>0?t.top+=h:l>0?t.top-=l:t.top=o(t.top-r,t.top)}},flip:{left:function(t,e){var i,s,n=e.within,o=n.offset.left+n.scrollLeft,r=n.width,h=n.isWindow?n.scrollLeft:n.offset.left,l=t.left-e.collisionPosition.marginLeft,c=l-h,u=l+e.collisionWidth-r-h,d="left"===e.my[0]?-e.elemWidth:"right"===e.my[0]?e.elemWidth:0,p="left"===e.at[0]?e.targetWidth:"right"===e.at[0]?-e.targetWidth:0,f=-2*e.offset[0];0>c?(i=t.left+d+p+f+e.collisionWidth-r-o,(0>i||a(c)>i)&&(t.left+=d+p+f)):u>0&&(s=t.left-e.collisionPosition.marginLeft+d+p+f-h,(s>0||u>a(s))&&(t.left+=d+p+f))},top:function(t,e){var i,s,n=e.within,o=n.offset.top+n.scrollTop,r=n.height,h=n.isWindow?n.scrollTop:n.offset.top,l=t.top-e.collisionPosition.marginTop,c=l-h,u=l+e.collisionHeight-r-h,d="top"===e.my[1],p=d?-e.elemHeight:"bottom"===e.my[1]?e.elemHeight:0,f="top"===e.at[1]?e.targetHeight:"bottom"===e.at[1]?-e.targetHeight:0,m=-2*e.offset[1];0>c?(s=t.top+p+f+m+e.collisionHeight-r-o,(0>s||a(c)>s)&&(t.top+=p+f+m)):u>0&&(i=t.top-e.collisionPosition.marginTop+p+f+m-h,(i>0||u>a(i))&&(t.top+=p+f+m))}},flipfit:{left:function(){t.ui.position.flip.left.apply(this,arguments),t.ui.position.fit.left.apply(this,arguments)},top:function(){t.ui.position.flip.top.apply(this,arguments),t.ui.position.fit.top.apply(this,arguments)}}}}(),t.ui.position,t.extend(t.expr[":"],{data:t.expr.createPseudo?t.expr.createPseudo(function(e){return function(i){return!!t.data(i,e)}}):function(e,i,s){return!!t.data(e,s[3])}}),t.fn.extend({disableSelection:function(){var t="onselectstart"in document.createElement("div")?"selectstart":"mousedown";return function(){return this.on(t+".ui-disableSelection",function(t){t.preventDefault()})}}(),enableSelection:function(){return this.off(".ui-disableSelection")}}),t.ui.focusable=function(i,s){var n,o,a,r,h,l=i.nodeName.toLowerCase();return"area"===l?(n=i.parentNode,o=n.name,i.href&&o&&"map"===n.nodeName.toLowerCase()?(a=t("img[usemap='#"+o+"']"),a.length>0&&a.is(":visible")):!1):(/^(input|select|textarea|button|object)$/.test(l)?(r=!i.disabled,r&&(h=t(i).closest("fieldset")[0],h&&(r=!h.disabled))):r="a"===l?i.href||s:s,r&&t(i).is(":visible")&&e(t(i)))},t.extend(t.expr[":"],{focusable:function(e){return t.ui.focusable(e,null!=t.attr(e,"tabindex"))}}),t.ui.focusable,t.fn.form=function(){return"string"==typeof this[0].form?this.closest("form"):t(this[0].form)},t.ui.formResetMixin={_formResetHandler:function(){var e=t(this);setTimeout(function(){var i=e.data("ui-form-reset-instances");t.each(i,function(){this.refresh()})})},_bindFormResetHandler:function(){if(this.form=this.element.form(),this.form.length){var t=this.form.data("ui-form-reset-instances")||[];t.length||this.form.on("reset.ui-form-reset",this._formResetHandler),t.push(this),this.form.data("ui-form-reset-instances",t)}},_unbindFormResetHandler:function(){if(this.form.length){var e=this.form.data("ui-form-reset-instances");e.splice(t.inArray(this,e),1),e.length?this.form.data("ui-form-reset-instances",e):this.form.removeData("ui-form-reset-instances").off("reset.ui-form-reset")}}},"1.7"===t.fn.jquery.substring(0,3)&&(t.each(["Width","Height"],function(e,i){function s(e,i,s,o){return t.each(n,function(){i-=parseFloat(t.css(e,"padding"+this))||0,s&&(i-=parseFloat(t.css(e,"border"+this+"Width"))||0),o&&(i-=parseFloat(t.css(e,"margin"+this))||0)}),i}var n="Width"===i?["Left","Right"]:["Top","Bottom"],o=i.toLowerCase(),a={innerWidth:t.fn.innerWidth,innerHeight:t.fn.innerHeight,outerWidth:t.fn.outerWidth,outerHeight:t.fn.outerHeight};t.fn["inner"+i]=function(e){return void 0===e?a["inner"+i].call(this):this.each(function(){t(this).css(o,s(this,e)+"px")})},t.fn["outer"+i]=function(e,n){return"number"!=typeof e?a["outer"+i].call(this,e):this.each(function(){t(this).css(o,s(this,e,!0,n)+"px")})}}),t.fn.addBack=function(t){return this.add(null==t?this.prevObject:this.prevObject.filter(t))}),t.ui.keyCode={BACKSPACE:8,COMMA:188,DELETE:46,DOWN:40,END:35,ENTER:13,ESCAPE:27,HOME:36,LEFT:37,PAGE_DOWN:34,PAGE_UP:33,PERIOD:190,RIGHT:39,SPACE:32,TAB:9,UP:38},t.ui.escapeSelector=function(){var t=/([!"#$%&'()*+,./:;<=>?@[\]^`{|}~])/g;return function(e){return e.replace(t,"\\$1")}}(),t.fn.labels=function(){var e,i,s,n,o;return this[0].labels&&this[0].labels.length?this.pushStack(this[0].labels):(n=this.eq(0).parents("label"),s=this.attr("id"),s&&(e=this.eq(0).parents().last(),o=e.add(e.length?e.siblings():this.siblings()),i="label[for='"+t.ui.escapeSelector(s)+"']",n=n.add(o.find(i).addBack(i))),this.pushStack(n))},t.fn.scrollParent=function(e){var i=this.css("position"),s="absolute"===i,n=e?/(auto|scroll|hidden)/:/(auto|scroll)/,o=this.parents().filter(function(){var e=t(this);return s&&"static"===e.css("position")?!1:n.test(e.css("overflow")+e.css("overflow-y")+e.css("overflow-x"))}).eq(0);return"fixed"!==i&&o.length?o:t(this[0].ownerDocument||document)},t.extend(t.expr[":"],{tabbable:function(e){var i=t.attr(e,"tabindex"),s=null!=i;return(!s||i>=0)&&t.ui.focusable(e,s)}}),t.fn.extend({uniqueId:function(){var t=0;return function(){return this.each(function(){this.id||(this.id="ui-id-"+ ++t)})}}(),removeUniqueId:function(){return this.each(function(){/^ui-id-\d+$/.test(this.id)&&t(this).removeAttr("id")})}}),t.ui.ie=!!/msie [\w.]+/.exec(navigator.userAgent.toLowerCase());var n=!1;t(document).on("mouseup",function(){n=!1}),t.widget("ui.mouse",{version:"1.12.1",options:{cancel:"input, textarea, button, select, option",distance:1,delay:0},_mouseInit:function(){var e=this;this.element.on("mousedown."+this.widgetName,function(t){return e._mouseDown(t)}).on("click."+this.widgetName,function(i){return!0===t.data(i.target,e.widgetName+".preventClickEvent")?(t.removeData(i.target,e.widgetName+".preventClickEvent"),i.stopImmediatePropagation(),!1):void 0}),this.started=!1},_mouseDestroy:function(){this.element.off("."+this.widgetName),this._mouseMoveDelegate&&this.document.off("mousemove."+this.widgetName,this._mouseMoveDelegate).off("mouseup."+this.widgetName,this._mouseUpDelegate)},_mouseDown:function(e){if(!n){this._mouseMoved=!1,this._mouseStarted&&this._mouseUp(e),this._mouseDownEvent=e;var i=this,s=1===e.which,o="string"==typeof this.options.cancel&&e.target.nodeName?t(e.target).closest(this.options.cancel).length:!1;return s&&!o&&this._mouseCapture(e)?(this.mouseDelayMet=!this.options.delay,this.mouseDelayMet||(this._mouseDelayTimer=setTimeout(function(){i.mouseDelayMet=!0},this.options.delay)),this._mouseDistanceMet(e)&&this._mouseDelayMet(e)&&(this._mouseStarted=this._mouseStart(e)!==!1,!this._mouseStarted)?(e.preventDefault(),!0):(!0===t.data(e.target,this.widgetName+".preventClickEvent")&&t.removeData(e.target,this.widgetName+".preventClickEvent"),this._mouseMoveDelegate=function(t){return i._mouseMove(t)},this._mouseUpDelegate=function(t){return i._mouseUp(t)},this.document.on("mousemove."+this.widgetName,this._mouseMoveDelegate).on("mouseup."+this.widgetName,this._mouseUpDelegate),e.preventDefault(),n=!0,!0)):!0}},_mouseMove:function(e){if(this._mouseMoved){if(t.ui.ie&&(!document.documentMode||9>document.documentMode)&&!e.button)return this._mouseUp(e);if(!e.which)if(e.originalEvent.altKey||e.originalEvent.ctrlKey||e.originalEvent.metaKey||e.originalEvent.shiftKey)this.ignoreMissingWhich=!0;else if(!this.ignoreMissingWhich)return this._mouseUp(e)}return(e.which||e.button)&&(this._mouseMoved=!0),this._mouseStarted?(this._mouseDrag(e),e.preventDefault()):(this._mouseDistanceMet(e)&&this._mouseDelayMet(e)&&(this._mouseStarted=this._mouseStart(this._mouseDownEvent,e)!==!1,this._mouseStarted?this._mouseDrag(e):this._mouseUp(e)),!this._mouseStarted)},_mouseUp:function(e){this.document.off("mousemove."+this.widgetName,this._mouseMoveDelegate).off("mouseup."+this.widgetName,this._mouseUpDelegate),this._mouseStarted&&(this._mouseStarted=!1,e.target===this._mouseDownEvent.target&&t.data(e.target,this.widgetName+".preventClickEvent",!0),this._mouseStop(e)),this._mouseDelayTimer&&(clearTimeout(this._mouseDelayTimer),delete this._mouseDelayTimer),this.ignoreMissingWhich=!1,n=!1,e.preventDefault()},_mouseDistanceMet:function(t){return Math.max(Math.abs(this._mouseDownEvent.pageX-t.pageX),Math.abs(this._mouseDownEvent.pageY-t.pageY))>=this.options.distance},_mouseDelayMet:function(){return this.mouseDelayMet},_mouseStart:function(){},_mouseDrag:function(){},_mouseStop:function(){},_mouseCapture:function(){return!0}}),t.ui.plugin={add:function(e,i,s){var n,o=t.ui[e].prototype;for(n in s)o.plugins[n]=o.plugins[n]||[],o.plugins[n].push([i,s[n]])},call:function(t,e,i,s){var n,o=t.plugins[e];if(o&&(s||t.element[0].parentNode&&11!==t.element[0].parentNode.nodeType))for(n=0;o.length>n;n++)t.options[o[n][0]]&&o[n][1].apply(t.element,i)}},t.widget("ui.resizable",t.ui.mouse,{version:"1.12.1",widgetEventPrefix:"resize",options:{alsoResize:!1,animate:!1,animateDuration:"slow",animateEasing:"swing",aspectRatio:!1,autoHide:!1,classes:{"ui-resizable-se":"ui-icon ui-icon-gripsmall-diagonal-se"},containment:!1,ghost:!1,grid:!1,handles:"e,s,se",helper:!1,maxHeight:null,maxWidth:null,minHeight:10,minWidth:10,zIndex:90,resize:null,start:null,stop:null},_num:function(t){return parseFloat(t)||0},_isNumber:function(t){return!isNaN(parseFloat(t))},_hasScroll:function(e,i){if("hidden"===t(e).css("overflow"))return!1;var s=i&&"left"===i?"scrollLeft":"scrollTop",n=!1;return e[s]>0?!0:(e[s]=1,n=e[s]>0,e[s]=0,n)},_create:function(){var e,i=this.options,s=this;this._addClass("ui-resizable"),t.extend(this,{_aspectRatio:!!i.aspectRatio,aspectRatio:i.aspectRatio,originalElement:this.element,_proportionallyResizeElements:[],_helper:i.helper||i.ghost||i.animate?i.helper||"ui-resizable-helper":null}),this.element[0].nodeName.match(/^(canvas|textarea|input|select|button|img)$/i)&&(this.element.wrap(t("
").css({position:this.element.css("position"),width:this.element.outerWidth(),height:this.element.outerHeight(),top:this.element.css("top"),left:this.element.css("left")})),this.element=this.element.parent().data("ui-resizable",this.element.resizable("instance")),this.elementIsWrapper=!0,e={marginTop:this.originalElement.css("marginTop"),marginRight:this.originalElement.css("marginRight"),marginBottom:this.originalElement.css("marginBottom"),marginLeft:this.originalElement.css("marginLeft")},this.element.css(e),this.originalElement.css("margin",0),this.originalResizeStyle=this.originalElement.css("resize"),this.originalElement.css("resize","none"),this._proportionallyResizeElements.push(this.originalElement.css({position:"static",zoom:1,display:"block"})),this.originalElement.css(e),this._proportionallyResize()),this._setupHandles(),i.autoHide&&t(this.element).on("mouseenter",function(){i.disabled||(s._removeClass("ui-resizable-autohide"),s._handles.show())}).on("mouseleave",function(){i.disabled||s.resizing||(s._addClass("ui-resizable-autohide"),s._handles.hide())}),this._mouseInit()},_destroy:function(){this._mouseDestroy();var e,i=function(e){t(e).removeData("resizable").removeData("ui-resizable").off(".resizable").find(".ui-resizable-handle").remove()};return this.elementIsWrapper&&(i(this.element),e=this.element,this.originalElement.css({position:e.css("position"),width:e.outerWidth(),height:e.outerHeight(),top:e.css("top"),left:e.css("left")}).insertAfter(e),e.remove()),this.originalElement.css("resize",this.originalResizeStyle),i(this.originalElement),this},_setOption:function(t,e){switch(this._super(t,e),t){case"handles":this._removeHandles(),this._setupHandles();break;default:}},_setupHandles:function(){var e,i,s,n,o,a=this.options,r=this;if(this.handles=a.handles||(t(".ui-resizable-handle",this.element).length?{n:".ui-resizable-n",e:".ui-resizable-e",s:".ui-resizable-s",w:".ui-resizable-w",se:".ui-resizable-se",sw:".ui-resizable-sw",ne:".ui-resizable-ne",nw:".ui-resizable-nw"}:"e,s,se"),this._handles=t(),this.handles.constructor===String)for("all"===this.handles&&(this.handles="n,e,s,w,se,sw,ne,nw"),s=this.handles.split(","),this.handles={},i=0;s.length>i;i++)e=t.trim(s[i]),n="ui-resizable-"+e,o=t(""),this._addClass(o,"ui-resizable-handle "+n),o.css({zIndex:a.zIndex}),this.handles[e]=".ui-resizable-"+e,this.element.append(o);this._renderAxis=function(e){var i,s,n,o;e=e||this.element;for(i in this.handles)this.handles[i].constructor===String?this.handles[i]=this.element.children(this.handles[i]).first().show():(this.handles[i].jquery||this.handles[i].nodeType)&&(this.handles[i]=t(this.handles[i]),this._on(this.handles[i],{mousedown:r._mouseDown})),this.elementIsWrapper&&this.originalElement[0].nodeName.match(/^(textarea|input|select|button)$/i)&&(s=t(this.handles[i],this.element),o=/sw|ne|nw|se|n|s/.test(i)?s.outerHeight():s.outerWidth(),n=["padding",/ne|nw|n/.test(i)?"Top":/se|sw|s/.test(i)?"Bottom":/^e$/.test(i)?"Right":"Left"].join(""),e.css(n,o),this._proportionallyResize()),this._handles=this._handles.add(this.handles[i])},this._renderAxis(this.element),this._handles=this._handles.add(this.element.find(".ui-resizable-handle")),this._handles.disableSelection(),this._handles.on("mouseover",function(){r.resizing||(this.className&&(o=this.className.match(/ui-resizable-(se|sw|ne|nw|n|e|s|w)/i)),r.axis=o&&o[1]?o[1]:"se")}),a.autoHide&&(this._handles.hide(),this._addClass("ui-resizable-autohide"))},_removeHandles:function(){this._handles.remove()},_mouseCapture:function(e){var i,s,n=!1;for(i in this.handles)s=t(this.handles[i])[0],(s===e.target||t.contains(s,e.target))&&(n=!0);return!this.options.disabled&&n},_mouseStart:function(e){var i,s,n,o=this.options,a=this.element;return this.resizing=!0,this._renderProxy(),i=this._num(this.helper.css("left")),s=this._num(this.helper.css("top")),o.containment&&(i+=t(o.containment).scrollLeft()||0,s+=t(o.containment).scrollTop()||0),this.offset=this.helper.offset(),this.position={left:i,top:s},this.size=this._helper?{width:this.helper.width(),height:this.helper.height()}:{width:a.width(),height:a.height()},this.originalSize=this._helper?{width:a.outerWidth(),height:a.outerHeight()}:{width:a.width(),height:a.height()},this.sizeDiff={width:a.outerWidth()-a.width(),height:a.outerHeight()-a.height()},this.originalPosition={left:i,top:s},this.originalMousePosition={left:e.pageX,top:e.pageY},this.aspectRatio="number"==typeof o.aspectRatio?o.aspectRatio:this.originalSize.width/this.originalSize.height||1,n=t(".ui-resizable-"+this.axis).css("cursor"),t("body").css("cursor","auto"===n?this.axis+"-resize":n),this._addClass("ui-resizable-resizing"),this._propagate("start",e),!0},_mouseDrag:function(e){var i,s,n=this.originalMousePosition,o=this.axis,a=e.pageX-n.left||0,r=e.pageY-n.top||0,h=this._change[o];return this._updatePrevProperties(),h?(i=h.apply(this,[e,a,r]),this._updateVirtualBoundaries(e.shiftKey),(this._aspectRatio||e.shiftKey)&&(i=this._updateRatio(i,e)),i=this._respectSize(i,e),this._updateCache(i),this._propagate("resize",e),s=this._applyChanges(),!this._helper&&this._proportionallyResizeElements.length&&this._proportionallyResize(),t.isEmptyObject(s)||(this._updatePrevProperties(),this._trigger("resize",e,this.ui()),this._applyChanges()),!1):!1},_mouseStop:function(e){this.resizing=!1;var i,s,n,o,a,r,h,l=this.options,c=this;return this._helper&&(i=this._proportionallyResizeElements,s=i.length&&/textarea/i.test(i[0].nodeName),n=s&&this._hasScroll(i[0],"left")?0:c.sizeDiff.height,o=s?0:c.sizeDiff.width,a={width:c.helper.width()-o,height:c.helper.height()-n},r=parseFloat(c.element.css("left"))+(c.position.left-c.originalPosition.left)||null,h=parseFloat(c.element.css("top"))+(c.position.top-c.originalPosition.top)||null,l.animate||this.element.css(t.extend(a,{top:h,left:r})),c.helper.height(c.size.height),c.helper.width(c.size.width),this._helper&&!l.animate&&this._proportionallyResize()),t("body").css("cursor","auto"),this._removeClass("ui-resizable-resizing"),this._propagate("stop",e),this._helper&&this.helper.remove(),!1},_updatePrevProperties:function(){this.prevPosition={top:this.position.top,left:this.position.left},this.prevSize={width:this.size.width,height:this.size.height}},_applyChanges:function(){var t={};return this.position.top!==this.prevPosition.top&&(t.top=this.position.top+"px"),this.position.left!==this.prevPosition.left&&(t.left=this.position.left+"px"),this.size.width!==this.prevSize.width&&(t.width=this.size.width+"px"),this.size.height!==this.prevSize.height&&(t.height=this.size.height+"px"),this.helper.css(t),t},_updateVirtualBoundaries:function(t){var e,i,s,n,o,a=this.options;o={minWidth:this._isNumber(a.minWidth)?a.minWidth:0,maxWidth:this._isNumber(a.maxWidth)?a.maxWidth:1/0,minHeight:this._isNumber(a.minHeight)?a.minHeight:0,maxHeight:this._isNumber(a.maxHeight)?a.maxHeight:1/0},(this._aspectRatio||t)&&(e=o.minHeight*this.aspectRatio,s=o.minWidth/this.aspectRatio,i=o.maxHeight*this.aspectRatio,n=o.maxWidth/this.aspectRatio,e>o.minWidth&&(o.minWidth=e),s>o.minHeight&&(o.minHeight=s),o.maxWidth>i&&(o.maxWidth=i),o.maxHeight>n&&(o.maxHeight=n)),this._vBoundaries=o},_updateCache:function(t){this.offset=this.helper.offset(),this._isNumber(t.left)&&(this.position.left=t.left),this._isNumber(t.top)&&(this.position.top=t.top),this._isNumber(t.height)&&(this.size.height=t.height),this._isNumber(t.width)&&(this.size.width=t.width)},_updateRatio:function(t){var e=this.position,i=this.size,s=this.axis;return this._isNumber(t.height)?t.width=t.height*this.aspectRatio:this._isNumber(t.width)&&(t.height=t.width/this.aspectRatio),"sw"===s&&(t.left=e.left+(i.width-t.width),t.top=null),"nw"===s&&(t.top=e.top+(i.height-t.height),t.left=e.left+(i.width-t.width)),t},_respectSize:function(t){var e=this._vBoundaries,i=this.axis,s=this._isNumber(t.width)&&e.maxWidth&&e.maxWidth
t.width,a=this._isNumber(t.height)&&e.minHeight&&e.minHeight>t.height,r=this.originalPosition.left+this.originalSize.width,h=this.originalPosition.top+this.originalSize.height,l=/sw|nw|w/.test(i),c=/nw|ne|n/.test(i);return o&&(t.width=e.minWidth),a&&(t.height=e.minHeight),s&&(t.width=e.maxWidth),n&&(t.height=e.maxHeight),o&&l&&(t.left=r-e.minWidth),s&&l&&(t.left=r-e.maxWidth),a&&c&&(t.top=h-e.minHeight),n&&c&&(t.top=h-e.maxHeight),t.width||t.height||t.left||!t.top?t.width||t.height||t.top||!t.left||(t.left=null):t.top=null,t},_getPaddingPlusBorderDimensions:function(t){for(var e=0,i=[],s=[t.css("borderTopWidth"),t.css("borderRightWidth"),t.css("borderBottomWidth"),t.css("borderLeftWidth")],n=[t.css("paddingTop"),t.css("paddingRight"),t.css("paddingBottom"),t.css("paddingLeft")];4>e;e++)i[e]=parseFloat(s[e])||0,i[e]+=parseFloat(n[e])||0;return{height:i[0]+i[2],width:i[1]+i[3]}},_proportionallyResize:function(){if(this._proportionallyResizeElements.length)for(var t,e=0,i=this.helper||this.element;this._proportionallyResizeElements.length>e;e++)t=this._proportionallyResizeElements[e],this.outerDimensions||(this.outerDimensions=this._getPaddingPlusBorderDimensions(t)),t.css({height:i.height()-this.outerDimensions.height||0,width:i.width()-this.outerDimensions.width||0})},_renderProxy:function(){var e=this.element,i=this.options;this.elementOffset=e.offset(),this._helper?(this.helper=this.helper||t("
"),this._addClass(this.helper,this._helper),this.helper.css({width:this.element.outerWidth(),height:this.element.outerHeight(),position:"absolute",left:this.elementOffset.left+"px",top:this.elementOffset.top+"px",zIndex:++i.zIndex}),this.helper.appendTo("body").disableSelection()):this.helper=this.element
+},_change:{e:function(t,e){return{width:this.originalSize.width+e}},w:function(t,e){var i=this.originalSize,s=this.originalPosition;return{left:s.left+e,width:i.width-e}},n:function(t,e,i){var s=this.originalSize,n=this.originalPosition;return{top:n.top+i,height:s.height-i}},s:function(t,e,i){return{height:this.originalSize.height+i}},se:function(e,i,s){return t.extend(this._change.s.apply(this,arguments),this._change.e.apply(this,[e,i,s]))},sw:function(e,i,s){return t.extend(this._change.s.apply(this,arguments),this._change.w.apply(this,[e,i,s]))},ne:function(e,i,s){return t.extend(this._change.n.apply(this,arguments),this._change.e.apply(this,[e,i,s]))},nw:function(e,i,s){return t.extend(this._change.n.apply(this,arguments),this._change.w.apply(this,[e,i,s]))}},_propagate:function(e,i){t.ui.plugin.call(this,e,[i,this.ui()]),"resize"!==e&&this._trigger(e,i,this.ui())},plugins:{},ui:function(){return{originalElement:this.originalElement,element:this.element,helper:this.helper,position:this.position,size:this.size,originalSize:this.originalSize,originalPosition:this.originalPosition}}}),t.ui.plugin.add("resizable","animate",{stop:function(e){var i=t(this).resizable("instance"),s=i.options,n=i._proportionallyResizeElements,o=n.length&&/textarea/i.test(n[0].nodeName),a=o&&i._hasScroll(n[0],"left")?0:i.sizeDiff.height,r=o?0:i.sizeDiff.width,h={width:i.size.width-r,height:i.size.height-a},l=parseFloat(i.element.css("left"))+(i.position.left-i.originalPosition.left)||null,c=parseFloat(i.element.css("top"))+(i.position.top-i.originalPosition.top)||null;i.element.animate(t.extend(h,c&&l?{top:c,left:l}:{}),{duration:s.animateDuration,easing:s.animateEasing,step:function(){var s={width:parseFloat(i.element.css("width")),height:parseFloat(i.element.css("height")),top:parseFloat(i.element.css("top")),left:parseFloat(i.element.css("left"))};n&&n.length&&t(n[0]).css({width:s.width,height:s.height}),i._updateCache(s),i._propagate("resize",e)}})}}),t.ui.plugin.add("resizable","containment",{start:function(){var e,i,s,n,o,a,r,h=t(this).resizable("instance"),l=h.options,c=h.element,u=l.containment,d=u instanceof t?u.get(0):/parent/.test(u)?c.parent().get(0):u;d&&(h.containerElement=t(d),/document/.test(u)||u===document?(h.containerOffset={left:0,top:0},h.containerPosition={left:0,top:0},h.parentData={element:t(document),left:0,top:0,width:t(document).width(),height:t(document).height()||document.body.parentNode.scrollHeight}):(e=t(d),i=[],t(["Top","Right","Left","Bottom"]).each(function(t,s){i[t]=h._num(e.css("padding"+s))}),h.containerOffset=e.offset(),h.containerPosition=e.position(),h.containerSize={height:e.innerHeight()-i[3],width:e.innerWidth()-i[1]},s=h.containerOffset,n=h.containerSize.height,o=h.containerSize.width,a=h._hasScroll(d,"left")?d.scrollWidth:o,r=h._hasScroll(d)?d.scrollHeight:n,h.parentData={element:d,left:s.left,top:s.top,width:a,height:r}))},resize:function(e){var i,s,n,o,a=t(this).resizable("instance"),r=a.options,h=a.containerOffset,l=a.position,c=a._aspectRatio||e.shiftKey,u={top:0,left:0},d=a.containerElement,p=!0;d[0]!==document&&/static/.test(d.css("position"))&&(u=h),l.left<(a._helper?h.left:0)&&(a.size.width=a.size.width+(a._helper?a.position.left-h.left:a.position.left-u.left),c&&(a.size.height=a.size.width/a.aspectRatio,p=!1),a.position.left=r.helper?h.left:0),l.top<(a._helper?h.top:0)&&(a.size.height=a.size.height+(a._helper?a.position.top-h.top:a.position.top),c&&(a.size.width=a.size.height*a.aspectRatio,p=!1),a.position.top=a._helper?h.top:0),n=a.containerElement.get(0)===a.element.parent().get(0),o=/relative|absolute/.test(a.containerElement.css("position")),n&&o?(a.offset.left=a.parentData.left+a.position.left,a.offset.top=a.parentData.top+a.position.top):(a.offset.left=a.element.offset().left,a.offset.top=a.element.offset().top),i=Math.abs(a.sizeDiff.width+(a._helper?a.offset.left-u.left:a.offset.left-h.left)),s=Math.abs(a.sizeDiff.height+(a._helper?a.offset.top-u.top:a.offset.top-h.top)),i+a.size.width>=a.parentData.width&&(a.size.width=a.parentData.width-i,c&&(a.size.height=a.size.width/a.aspectRatio,p=!1)),s+a.size.height>=a.parentData.height&&(a.size.height=a.parentData.height-s,c&&(a.size.width=a.size.height*a.aspectRatio,p=!1)),p||(a.position.left=a.prevPosition.left,a.position.top=a.prevPosition.top,a.size.width=a.prevSize.width,a.size.height=a.prevSize.height)},stop:function(){var e=t(this).resizable("instance"),i=e.options,s=e.containerOffset,n=e.containerPosition,o=e.containerElement,a=t(e.helper),r=a.offset(),h=a.outerWidth()-e.sizeDiff.width,l=a.outerHeight()-e.sizeDiff.height;e._helper&&!i.animate&&/relative/.test(o.css("position"))&&t(this).css({left:r.left-n.left-s.left,width:h,height:l}),e._helper&&!i.animate&&/static/.test(o.css("position"))&&t(this).css({left:r.left-n.left-s.left,width:h,height:l})}}),t.ui.plugin.add("resizable","alsoResize",{start:function(){var e=t(this).resizable("instance"),i=e.options;t(i.alsoResize).each(function(){var e=t(this);e.data("ui-resizable-alsoresize",{width:parseFloat(e.width()),height:parseFloat(e.height()),left:parseFloat(e.css("left")),top:parseFloat(e.css("top"))})})},resize:function(e,i){var s=t(this).resizable("instance"),n=s.options,o=s.originalSize,a=s.originalPosition,r={height:s.size.height-o.height||0,width:s.size.width-o.width||0,top:s.position.top-a.top||0,left:s.position.left-a.left||0};t(n.alsoResize).each(function(){var e=t(this),s=t(this).data("ui-resizable-alsoresize"),n={},o=e.parents(i.originalElement[0]).length?["width","height"]:["width","height","top","left"];t.each(o,function(t,e){var i=(s[e]||0)+(r[e]||0);i&&i>=0&&(n[e]=i||null)}),e.css(n)})},stop:function(){t(this).removeData("ui-resizable-alsoresize")}}),t.ui.plugin.add("resizable","ghost",{start:function(){var e=t(this).resizable("instance"),i=e.size;e.ghost=e.originalElement.clone(),e.ghost.css({opacity:.25,display:"block",position:"relative",height:i.height,width:i.width,margin:0,left:0,top:0}),e._addClass(e.ghost,"ui-resizable-ghost"),t.uiBackCompat!==!1&&"string"==typeof e.options.ghost&&e.ghost.addClass(this.options.ghost),e.ghost.appendTo(e.helper)},resize:function(){var e=t(this).resizable("instance");e.ghost&&e.ghost.css({position:"relative",height:e.size.height,width:e.size.width})},stop:function(){var e=t(this).resizable("instance");e.ghost&&e.helper&&e.helper.get(0).removeChild(e.ghost.get(0))}}),t.ui.plugin.add("resizable","grid",{resize:function(){var e,i=t(this).resizable("instance"),s=i.options,n=i.size,o=i.originalSize,a=i.originalPosition,r=i.axis,h="number"==typeof s.grid?[s.grid,s.grid]:s.grid,l=h[0]||1,c=h[1]||1,u=Math.round((n.width-o.width)/l)*l,d=Math.round((n.height-o.height)/c)*c,p=o.width+u,f=o.height+d,m=s.maxWidth&&p>s.maxWidth,g=s.maxHeight&&f>s.maxHeight,_=s.minWidth&&s.minWidth>p,v=s.minHeight&&s.minHeight>f;s.grid=h,_&&(p+=l),v&&(f+=c),m&&(p-=l),g&&(f-=c),/^(se|s|e)$/.test(r)?(i.size.width=p,i.size.height=f):/^(ne)$/.test(r)?(i.size.width=p,i.size.height=f,i.position.top=a.top-d):/^(sw)$/.test(r)?(i.size.width=p,i.size.height=f,i.position.left=a.left-u):((0>=f-c||0>=p-l)&&(e=i._getPaddingPlusBorderDimensions(this)),f-c>0?(i.size.height=f,i.position.top=a.top-d):(f=c-e.height,i.size.height=f,i.position.top=a.top+o.height-f),p-l>0?(i.size.width=p,i.position.left=a.left-u):(p=l-e.width,i.size.width=p,i.position.left=a.left+o.width-p))}}),t.ui.resizable});/**
+ * Copyright (c) 2007 Ariel Flesler - aflesler ○ gmail • com | https://github.com/flesler
+ * Licensed under MIT
+ * @author Ariel Flesler
+ * @version 2.1.2
+ */
+;(function(f){"use strict";"function"===typeof define&&define.amd?define(["jquery"],f):"undefined"!==typeof module&&module.exports?module.exports=f(require("jquery")):f(jQuery)})(function($){"use strict";function n(a){return!a.nodeName||-1!==$.inArray(a.nodeName.toLowerCase(),["iframe","#document","html","body"])}function h(a){return $.isFunction(a)||$.isPlainObject(a)?a:{top:a,left:a}}var p=$.scrollTo=function(a,d,b){return $(window).scrollTo(a,d,b)};p.defaults={axis:"xy",duration:0,limit:!0};$.fn.scrollTo=function(a,d,b){"object"=== typeof d&&(b=d,d=0);"function"===typeof b&&(b={onAfter:b});"max"===a&&(a=9E9);b=$.extend({},p.defaults,b);d=d||b.duration;var u=b.queue&&1=f[g]?0:Math.min(f[g],n));!a&&1-1){targetElements.on(evt+EVENT_NAMESPACE,function elementToggle(event){$.powerTip.toggle(this,event)})}else{targetElements.on(evt+EVENT_NAMESPACE,function elementOpen(event){$.powerTip.show(this,event)})}});$.each(options.closeEvents,function(idx,evt){if($.inArray(evt,options.openEvents)<0){targetElements.on(evt+EVENT_NAMESPACE,function elementClose(event){$.powerTip.hide(this,!isMouseEvent(event))})}});targetElements.on("keydown"+EVENT_NAMESPACE,function elementKeyDown(event){if(event.keyCode===27){$.powerTip.hide(this,true)}})}return targetElements};$.fn.powerTip.defaults={fadeInTime:200,fadeOutTime:100,followMouse:false,popupId:"powerTip",popupClass:null,intentSensitivity:7,intentPollInterval:100,closeDelay:100,placement:"n",smartPlacement:false,offset:10,mouseOnToPopup:false,manual:false,openEvents:["mouseenter","focus"],closeEvents:["mouseleave","blur"]};$.fn.powerTip.smartPlacementLists={n:["n","ne","nw","s"],e:["e","ne","se","w","nw","sw","n","s","e"],s:["s","se","sw","n"],w:["w","nw","sw","e","ne","se","n","s","w"],nw:["nw","w","sw","n","s","se","nw"],ne:["ne","e","se","n","s","sw","ne"],sw:["sw","w","nw","s","n","ne","sw"],se:["se","e","ne","s","n","nw","se"],"nw-alt":["nw-alt","n","ne-alt","sw-alt","s","se-alt","w","e"],"ne-alt":["ne-alt","n","nw-alt","se-alt","s","sw-alt","e","w"],"sw-alt":["sw-alt","s","se-alt","nw-alt","n","ne-alt","w","e"],"se-alt":["se-alt","s","sw-alt","ne-alt","n","nw-alt","e","w"]};$.powerTip={show:function apiShowTip(element,event){if(isMouseEvent(event)){trackMouse(event);session.previousX=event.pageX;session.previousY=event.pageY;$(element).data(DATA_DISPLAYCONTROLLER).show()}else{$(element).first().data(DATA_DISPLAYCONTROLLER).show(true,true)}return element},reposition:function apiResetPosition(element){$(element).first().data(DATA_DISPLAYCONTROLLER).resetPosition();return element},hide:function apiCloseTip(element,immediate){var displayController;immediate=element?immediate:true;if(element){displayController=$(element).first().data(DATA_DISPLAYCONTROLLER)}else if(session.activeHover){displayController=session.activeHover.data(DATA_DISPLAYCONTROLLER)}if(displayController){displayController.hide(immediate)}return element},toggle:function apiToggle(element,event){if(session.activeHover&&session.activeHover.is(element)){$.powerTip.hide(element,!isMouseEvent(event))}else{$.powerTip.show(element,event)}return element}};$.powerTip.showTip=$.powerTip.show;$.powerTip.closeTip=$.powerTip.hide;function CSSCoordinates(){var me=this;me.top="auto";me.left="auto";me.right="auto";me.bottom="auto";me.set=function(property,value){if($.isNumeric(value)){me[property]=Math.round(value)}}}function DisplayController(element,options,tipController){var hoverTimer=null,myCloseDelay=null;function openTooltip(immediate,forceOpen){cancelTimer();if(!element.data(DATA_HASACTIVEHOVER)){if(!immediate){session.tipOpenImminent=true;hoverTimer=setTimeout(function intentDelay(){hoverTimer=null;checkForIntent()},options.intentPollInterval)}else{if(forceOpen){element.data(DATA_FORCEDOPEN,true)}closeAnyDelayed();tipController.showTip(element)}}else{cancelClose()}}function closeTooltip(disableDelay){if(myCloseDelay){myCloseDelay=session.closeDelayTimeout=clearTimeout(myCloseDelay);session.delayInProgress=false}cancelTimer();session.tipOpenImminent=false;if(element.data(DATA_HASACTIVEHOVER)){element.data(DATA_FORCEDOPEN,false);if(!disableDelay){session.delayInProgress=true;session.closeDelayTimeout=setTimeout(function closeDelay(){session.closeDelayTimeout=null;tipController.hideTip(element);session.delayInProgress=false;myCloseDelay=null},options.closeDelay);myCloseDelay=session.closeDelayTimeout}else{tipController.hideTip(element)}}}function checkForIntent(){var xDifference=Math.abs(session.previousX-session.currentX),yDifference=Math.abs(session.previousY-session.currentY),totalDifference=xDifference+yDifference;if(totalDifference",{id:options.popupId});if($body.length===0){$body=$("body")}$body.append(tipElement);session.tooltips=session.tooltips?session.tooltips.add(tipElement):tipElement}if(options.followMouse){if(!tipElement.data(DATA_HASMOUSEMOVE)){$document.on("mousemove"+EVENT_NAMESPACE,positionTipOnCursor);$window.on("scroll"+EVENT_NAMESPACE,positionTipOnCursor);tipElement.data(DATA_HASMOUSEMOVE,true)}}function beginShowTip(element){element.data(DATA_HASACTIVEHOVER,true);tipElement.queue(function queueTipInit(next){showTip(element);next()})}function showTip(element){var tipContent;if(!element.data(DATA_HASACTIVEHOVER)){return}if(session.isTipOpen){if(!session.isClosing){hideTip(session.activeHover)}tipElement.delay(100).queue(function queueTipAgain(next){showTip(element);next()});return}element.trigger("powerTipPreRender");tipContent=getTooltipContent(element);if(tipContent){tipElement.empty().append(tipContent)}else{return}element.trigger("powerTipRender");session.activeHover=element;session.isTipOpen=true;tipElement.data(DATA_MOUSEONTOTIP,options.mouseOnToPopup);tipElement.addClass(options.popupClass);if(!options.followMouse||element.data(DATA_FORCEDOPEN)){positionTipOnElement(element);session.isFixedTipOpen=true}else{positionTipOnCursor()}if(!element.data(DATA_FORCEDOPEN)&&!options.followMouse){$document.on("click"+EVENT_NAMESPACE,function documentClick(event){var target=event.target;if(target!==element[0]){if(options.mouseOnToPopup){if(target!==tipElement[0]&&!$.contains(tipElement[0],target)){$.powerTip.hide()}}else{$.powerTip.hide()}}})}if(options.mouseOnToPopup&&!options.manual){tipElement.on("mouseenter"+EVENT_NAMESPACE,function tipMouseEnter(){if(session.activeHover){session.activeHover.data(DATA_DISPLAYCONTROLLER).cancel()}});tipElement.on("mouseleave"+EVENT_NAMESPACE,function tipMouseLeave(){if(session.activeHover){session.activeHover.data(DATA_DISPLAYCONTROLLER).hide()}})}tipElement.fadeIn(options.fadeInTime,function fadeInCallback(){if(!session.desyncTimeout){session.desyncTimeout=setInterval(closeDesyncedTip,500)}element.trigger("powerTipOpen")})}function hideTip(element){session.isClosing=true;session.isTipOpen=false;session.desyncTimeout=clearInterval(session.desyncTimeout);element.data(DATA_HASACTIVEHOVER,false);element.data(DATA_FORCEDOPEN,false);$document.off("click"+EVENT_NAMESPACE);tipElement.off(EVENT_NAMESPACE);tipElement.fadeOut(options.fadeOutTime,function fadeOutCallback(){var coords=new CSSCoordinates;session.activeHover=null;session.isClosing=false;session.isFixedTipOpen=false;tipElement.removeClass();coords.set("top",session.currentY+options.offset);coords.set("left",session.currentX+options.offset);tipElement.css(coords);element.trigger("powerTipClose")})}function positionTipOnCursor(){var tipWidth,tipHeight,coords,collisions,collisionCount;if(!session.isFixedTipOpen&&(session.isTipOpen||session.tipOpenImminent&&tipElement.data(DATA_HASMOUSEMOVE))){tipWidth=tipElement.outerWidth();tipHeight=tipElement.outerHeight();coords=new CSSCoordinates;coords.set("top",session.currentY+options.offset);coords.set("left",session.currentX+options.offset);collisions=getViewportCollisions(coords,tipWidth,tipHeight);if(collisions!==Collision.none){collisionCount=countFlags(collisions);if(collisionCount===1){if(collisions===Collision.right){coords.set("left",session.scrollLeft+session.windowWidth-tipWidth)}else if(collisions===Collision.bottom){coords.set("top",session.scrollTop+session.windowHeight-tipHeight)}}else{coords.set("left",session.currentX-tipWidth-options.offset);coords.set("top",session.currentY-tipHeight-options.offset)}}tipElement.css(coords)}}function positionTipOnElement(element){var priorityList,finalPlacement;if(options.smartPlacement||options.followMouse&&element.data(DATA_FORCEDOPEN)){priorityList=$.fn.powerTip.smartPlacementLists[options.placement];$.each(priorityList,function(idx,pos){var collisions=getViewportCollisions(placeTooltip(element,pos),tipElement.outerWidth(),tipElement.outerHeight());finalPlacement=pos;return collisions!==Collision.none})}else{placeTooltip(element,options.placement);finalPlacement=options.placement}tipElement.removeClass("w nw sw e ne se n s w se-alt sw-alt ne-alt nw-alt");tipElement.addClass(finalPlacement)}function placeTooltip(element,placement){var iterationCount=0,tipWidth,tipHeight,coords=new CSSCoordinates;coords.set("top",0);coords.set("left",0);tipElement.css(coords);do{tipWidth=tipElement.outerWidth();tipHeight=tipElement.outerHeight();coords=placementCalculator.compute(element,placement,tipWidth,tipHeight,options.offset);tipElement.css(coords)}while(++iterationCount<=5&&(tipWidth!==tipElement.outerWidth()||tipHeight!==tipElement.outerHeight()));return coords}function closeDesyncedTip(){var isDesynced=false,hasDesyncableCloseEvent=$.grep(["mouseleave","mouseout","blur","focusout"],function(eventType){return $.inArray(eventType,options.closeEvents)!==-1}).length>0;if(session.isTipOpen&&!session.isClosing&&!session.delayInProgress&&hasDesyncableCloseEvent){if(session.activeHover.data(DATA_HASACTIVEHOVER)===false||session.activeHover.is(":disabled")){isDesynced=true}else if(!isMouseOver(session.activeHover)&&!session.activeHover.is(":focus")&&!session.activeHover.data(DATA_FORCEDOPEN)){if(tipElement.data(DATA_MOUSEONTOTIP)){if(!isMouseOver(tipElement)){isDesynced=true}}else{isDesynced=true}}if(isDesynced){hideTip(session.activeHover)}}}this.showTip=beginShowTip;this.hideTip=hideTip;this.resetPosition=positionTipOnElement}function isSvgElement(element){return Boolean(window.SVGElement&&element[0]instanceof SVGElement)}function isMouseEvent(event){return Boolean(event&&$.inArray(event.type,MOUSE_EVENTS)>-1&&typeof event.pageX==="number")}function initTracking(){if(!session.mouseTrackingActive){session.mouseTrackingActive=true;getViewportDimensions();$(getViewportDimensions);$document.on("mousemove"+EVENT_NAMESPACE,trackMouse);$window.on("resize"+EVENT_NAMESPACE,trackResize);$window.on("scroll"+EVENT_NAMESPACE,trackScroll)}}function getViewportDimensions(){session.scrollLeft=$window.scrollLeft();session.scrollTop=$window.scrollTop();session.windowWidth=$window.width();session.windowHeight=$window.height()}function trackResize(){session.windowWidth=$window.width();session.windowHeight=$window.height()}function trackScroll(){var x=$window.scrollLeft(),y=$window.scrollTop();if(x!==session.scrollLeft){session.currentX+=x-session.scrollLeft;session.scrollLeft=x}if(y!==session.scrollTop){session.currentY+=y-session.scrollTop;session.scrollTop=y}}function trackMouse(event){session.currentX=event.pageX;session.currentY=event.pageY}function isMouseOver(element){var elementPosition=element.offset(),elementBox=element[0].getBoundingClientRect(),elementWidth=elementBox.right-elementBox.left,elementHeight=elementBox.bottom-elementBox.top;return session.currentX>=elementPosition.left&&session.currentX<=elementPosition.left+elementWidth&&session.currentY>=elementPosition.top&&session.currentY<=elementPosition.top+elementHeight}function getTooltipContent(element){var tipText=element.data(DATA_POWERTIP),tipObject=element.data(DATA_POWERTIPJQ),tipTarget=element.data(DATA_POWERTIPTARGET),targetElement,content;if(tipText){if($.isFunction(tipText)){tipText=tipText.call(element[0])}content=tipText}else if(tipObject){if($.isFunction(tipObject)){tipObject=tipObject.call(element[0])}if(tipObject.length>0){content=tipObject.clone(true,true)}}else if(tipTarget){targetElement=$("#"+tipTarget);if(targetElement.length>0){content=targetElement.html()}}return content}function getViewportCollisions(coords,elementWidth,elementHeight){var viewportTop=session.scrollTop,viewportLeft=session.scrollLeft,viewportBottom=viewportTop+session.windowHeight,viewportRight=viewportLeft+session.windowWidth,collisions=Collision.none;if(coords.topviewportBottom||Math.abs(coords.bottom-session.windowHeight)>viewportBottom){collisions|=Collision.bottom}if(coords.leftviewportRight){collisions|=Collision.left}if(coords.left+elementWidth>viewportRight||coords.right1)){a.preventDefault();var c=a.originalEvent.changedTouches[0],d=document.createEvent("MouseEvents");d.initMouseEvent(b,!0,!0,window,1,c.screenX,c.screenY,c.clientX,c.clientY,!1,!1,!1,!1,0,null),a.target.dispatchEvent(d)}}if(a.support.touch="ontouchend"in document,a.support.touch){var e,b=a.ui.mouse.prototype,c=b._mouseInit,d=b._mouseDestroy;b._touchStart=function(a){var b=this;!e&&b._mouseCapture(a.originalEvent.changedTouches[0])&&(e=!0,b._touchMoved=!1,f(a,"mouseover"),f(a,"mousemove"),f(a,"mousedown"))},b._touchMove=function(a){e&&(this._touchMoved=!0,f(a,"mousemove"))},b._touchEnd=function(a){e&&(f(a,"mouseup"),f(a,"mouseout"),this._touchMoved||f(a,"click"),e=!1)},b._mouseInit=function(){var b=this;b.element.bind({touchstart:a.proxy(b,"_touchStart"),touchmove:a.proxy(b,"_touchMove"),touchend:a.proxy(b,"_touchEnd")}),c.call(b)},b._mouseDestroy=function(){var b=this;b.element.unbind({touchstart:a.proxy(b,"_touchStart"),touchmove:a.proxy(b,"_touchMove"),touchend:a.proxy(b,"_touchEnd")}),d.call(b)}}}(jQuery);/*! SmartMenus jQuery Plugin - v1.1.0 - September 17, 2017
+ * http://www.smartmenus.org/
+ * Copyright Vasil Dinkov, Vadikom Web Ltd. http://vadikom.com; Licensed MIT */(function(t){"function"==typeof define&&define.amd?define(["jquery"],t):"object"==typeof module&&"object"==typeof module.exports?module.exports=t(require("jquery")):t(jQuery)})(function($){function initMouseDetection(t){var e=".smartmenus_mouse";if(mouseDetectionEnabled||t)mouseDetectionEnabled&&t&&($(document).off(e),mouseDetectionEnabled=!1);else{var i=!0,s=null,o={mousemove:function(t){var e={x:t.pageX,y:t.pageY,timeStamp:(new Date).getTime()};if(s){var o=Math.abs(s.x-e.x),a=Math.abs(s.y-e.y);if((o>0||a>0)&&2>=o&&2>=a&&300>=e.timeStamp-s.timeStamp&&(mouse=!0,i)){var n=$(t.target).closest("a");n.is("a")&&$.each(menuTrees,function(){return $.contains(this.$root[0],n[0])?(this.itemEnter({currentTarget:n[0]}),!1):void 0}),i=!1}}s=e}};o[touchEvents?"touchstart":"pointerover pointermove pointerout MSPointerOver MSPointerMove MSPointerOut"]=function(t){isTouchEvent(t.originalEvent)&&(mouse=!1)},$(document).on(getEventsNS(o,e)),mouseDetectionEnabled=!0}}function isTouchEvent(t){return!/^(4|mouse)$/.test(t.pointerType)}function getEventsNS(t,e){e||(e="");var i={};for(var s in t)i[s.split(" ").join(e+" ")+e]=t[s];return i}var menuTrees=[],mouse=!1,touchEvents="ontouchstart"in window,mouseDetectionEnabled=!1,requestAnimationFrame=window.requestAnimationFrame||function(t){return setTimeout(t,1e3/60)},cancelAnimationFrame=window.cancelAnimationFrame||function(t){clearTimeout(t)},canAnimate=!!$.fn.animate;return $.SmartMenus=function(t,e){this.$root=$(t),this.opts=e,this.rootId="",this.accessIdPrefix="",this.$subArrow=null,this.activatedItems=[],this.visibleSubMenus=[],this.showTimeout=0,this.hideTimeout=0,this.scrollTimeout=0,this.clickActivated=!1,this.focusActivated=!1,this.zIndexInc=0,this.idInc=0,this.$firstLink=null,this.$firstSub=null,this.disabled=!1,this.$disableOverlay=null,this.$touchScrollingSub=null,this.cssTransforms3d="perspective"in t.style||"webkitPerspective"in t.style,this.wasCollapsible=!1,this.init()},$.extend($.SmartMenus,{hideAll:function(){$.each(menuTrees,function(){this.menuHideAll()})},destroy:function(){for(;menuTrees.length;)menuTrees[0].destroy();initMouseDetection(!0)},prototype:{init:function(t){var e=this;if(!t){menuTrees.push(this),this.rootId=((new Date).getTime()+Math.random()+"").replace(/\D/g,""),this.accessIdPrefix="sm-"+this.rootId+"-",this.$root.hasClass("sm-rtl")&&(this.opts.rightToLeftSubMenus=!0);var i=".smartmenus";this.$root.data("smartmenus",this).attr("data-smartmenus-id",this.rootId).dataSM("level",1).on(getEventsNS({"mouseover focusin":$.proxy(this.rootOver,this),"mouseout focusout":$.proxy(this.rootOut,this),keydown:$.proxy(this.rootKeyDown,this)},i)).on(getEventsNS({mouseenter:$.proxy(this.itemEnter,this),mouseleave:$.proxy(this.itemLeave,this),mousedown:$.proxy(this.itemDown,this),focus:$.proxy(this.itemFocus,this),blur:$.proxy(this.itemBlur,this),click:$.proxy(this.itemClick,this)},i),"a"),i+=this.rootId,this.opts.hideOnClick&&$(document).on(getEventsNS({touchstart:$.proxy(this.docTouchStart,this),touchmove:$.proxy(this.docTouchMove,this),touchend:$.proxy(this.docTouchEnd,this),click:$.proxy(this.docClick,this)},i)),$(window).on(getEventsNS({"resize orientationchange":$.proxy(this.winResize,this)},i)),this.opts.subIndicators&&(this.$subArrow=$("
').css({position:"absolute",top:e.top,left:e.left,width:this.$root.outerWidth(),height:this.$root.outerHeight(),zIndex:this.getStartZIndex(!0),opacity:0}).appendTo(document.body)}this.disabled=!0}},docClick:function(t){return this.$touchScrollingSub?(this.$touchScrollingSub=null,void 0):((this.visibleSubMenus.length&&!$.contains(this.$root[0],t.target)||$(t.target).closest("a").length)&&this.menuHideAll(),void 0)},docTouchEnd:function(){if(this.lastTouch){if(!(!this.visibleSubMenus.length||void 0!==this.lastTouch.x2&&this.lastTouch.x1!=this.lastTouch.x2||void 0!==this.lastTouch.y2&&this.lastTouch.y1!=this.lastTouch.y2||this.lastTouch.target&&$.contains(this.$root[0],this.lastTouch.target))){this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0);var t=this;this.hideTimeout=setTimeout(function(){t.menuHideAll()},350)}this.lastTouch=null}},docTouchMove:function(t){if(this.lastTouch){var e=t.originalEvent.touches[0];this.lastTouch.x2=e.pageX,this.lastTouch.y2=e.pageY}},docTouchStart:function(t){var e=t.originalEvent.touches[0];this.lastTouch={x1:e.pageX,y1:e.pageY,target:e.target}},enable:function(){this.disabled&&(this.$disableOverlay&&(this.$disableOverlay.remove(),this.$disableOverlay=null),this.disabled=!1)},getClosestMenu:function(t){for(var e=$(t).closest("ul");e.dataSM("in-mega");)e=e.parent().closest("ul");return e[0]||null},getHeight:function(t){return this.getOffset(t,!0)},getOffset:function(t,e){var i;"none"==t.css("display")&&(i={position:t[0].style.position,visibility:t[0].style.visibility},t.css({position:"absolute",visibility:"hidden"}).show());var s=t[0].getBoundingClientRect&&t[0].getBoundingClientRect(),o=s&&(e?s.height||s.bottom-s.top:s.width||s.right-s.left);return o||0===o||(o=e?t[0].offsetHeight:t[0].offsetWidth),i&&t.hide().css(i),o},getStartZIndex:function(t){var e=parseInt(this[t?"$root":"$firstSub"].css("z-index"));return!t&&isNaN(e)&&(e=parseInt(this.$root.css("z-index"))),isNaN(e)?1:e},getTouchPoint:function(t){return t.touches&&t.touches[0]||t.changedTouches&&t.changedTouches[0]||t},getViewport:function(t){var e=t?"Height":"Width",i=document.documentElement["client"+e],s=window["inner"+e];return s&&(i=Math.min(i,s)),i},getViewportHeight:function(){return this.getViewport(!0)},getViewportWidth:function(){return this.getViewport()},getWidth:function(t){return this.getOffset(t)},handleEvents:function(){return!this.disabled&&this.isCSSOn()},handleItemEvents:function(t){return this.handleEvents()&&!this.isLinkInMegaMenu(t)},isCollapsible:function(){return"static"==this.$firstSub.css("position")},isCSSOn:function(){return"inline"!=this.$firstLink.css("display")},isFixed:function(){var t="fixed"==this.$root.css("position");return t||this.$root.parentsUntil("body").each(function(){return"fixed"==$(this).css("position")?(t=!0,!1):void 0}),t},isLinkInMegaMenu:function(t){return $(this.getClosestMenu(t[0])).hasClass("mega-menu")},isTouchMode:function(){return!mouse||this.opts.noMouseOver||this.isCollapsible()},itemActivate:function(t,e){var i=t.closest("ul"),s=i.dataSM("level");if(s>1&&(!this.activatedItems[s-2]||this.activatedItems[s-2][0]!=i.dataSM("parent-a")[0])){var o=this;$(i.parentsUntil("[data-smartmenus-id]","ul").get().reverse()).add(i).each(function(){o.itemActivate($(this).dataSM("parent-a"))})}if((!this.isCollapsible()||e)&&this.menuHideSubMenus(this.activatedItems[s-1]&&this.activatedItems[s-1][0]==t[0]?s:s-1),this.activatedItems[s-1]=t,this.$root.triggerHandler("activate.smapi",t[0])!==!1){var a=t.dataSM("sub");a&&(this.isTouchMode()||!this.opts.showOnClick||this.clickActivated)&&this.menuShow(a)}},itemBlur:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&this.$root.triggerHandler("blur.smapi",e[0])},itemClick:function(t){var e=$(t.currentTarget);if(this.handleItemEvents(e)){if(this.$touchScrollingSub&&this.$touchScrollingSub[0]==e.closest("ul")[0])return this.$touchScrollingSub=null,t.stopPropagation(),!1;if(this.$root.triggerHandler("click.smapi",e[0])===!1)return!1;var i=$(t.target).is(".sub-arrow"),s=e.dataSM("sub"),o=s?2==s.dataSM("level"):!1,a=this.isCollapsible(),n=/toggle$/.test(this.opts.collapsibleBehavior),r=/link$/.test(this.opts.collapsibleBehavior),h=/^accordion/.test(this.opts.collapsibleBehavior);if(s&&!s.is(":visible")){if((!r||!a||i)&&(this.opts.showOnClick&&o&&(this.clickActivated=!0),this.itemActivate(e,h),s.is(":visible")))return this.focusActivated=!0,!1}else if(a&&(n||i))return this.itemActivate(e,h),this.menuHide(s),n&&(this.focusActivated=!1),!1;return this.opts.showOnClick&&o||e.hasClass("disabled")||this.$root.triggerHandler("select.smapi",e[0])===!1?!1:void 0}},itemDown:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&e.dataSM("mousedown",!0)},itemEnter:function(t){var e=$(t.currentTarget);if(this.handleItemEvents(e)){if(!this.isTouchMode()){this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0);var i=this;this.showTimeout=setTimeout(function(){i.itemActivate(e)},this.opts.showOnClick&&1==e.closest("ul").dataSM("level")?1:this.opts.showTimeout)}this.$root.triggerHandler("mouseenter.smapi",e[0])}},itemFocus:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&(!this.focusActivated||this.isTouchMode()&&e.dataSM("mousedown")||this.activatedItems.length&&this.activatedItems[this.activatedItems.length-1][0]==e[0]||this.itemActivate(e,!0),this.$root.triggerHandler("focus.smapi",e[0]))},itemLeave:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&(this.isTouchMode()||(e[0].blur(),this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0)),e.removeDataSM("mousedown"),this.$root.triggerHandler("mouseleave.smapi",e[0]))},menuHide:function(t){if(this.$root.triggerHandler("beforehide.smapi",t[0])!==!1&&(canAnimate&&t.stop(!0,!0),"none"!=t.css("display"))){var e=function(){t.css("z-index","")};this.isCollapsible()?canAnimate&&this.opts.collapsibleHideFunction?this.opts.collapsibleHideFunction.call(this,t,e):t.hide(this.opts.collapsibleHideDuration,e):canAnimate&&this.opts.hideFunction?this.opts.hideFunction.call(this,t,e):t.hide(this.opts.hideDuration,e),t.dataSM("scroll")&&(this.menuScrollStop(t),t.css({"touch-action":"","-ms-touch-action":"","-webkit-transform":"",transform:""}).off(".smartmenus_scroll").removeDataSM("scroll").dataSM("scroll-arrows").hide()),t.dataSM("parent-a").removeClass("highlighted").attr("aria-expanded","false"),t.attr({"aria-expanded":"false","aria-hidden":"true"});var i=t.dataSM("level");this.activatedItems.splice(i-1,1),this.visibleSubMenus.splice($.inArray(t,this.visibleSubMenus),1),this.$root.triggerHandler("hide.smapi",t[0])}},menuHideAll:function(){this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0);for(var t=this.opts.isPopup?1:0,e=this.visibleSubMenus.length-1;e>=t;e--)this.menuHide(this.visibleSubMenus[e]);this.opts.isPopup&&(canAnimate&&this.$root.stop(!0,!0),this.$root.is(":visible")&&(canAnimate&&this.opts.hideFunction?this.opts.hideFunction.call(this,this.$root):this.$root.hide(this.opts.hideDuration))),this.activatedItems=[],this.visibleSubMenus=[],this.clickActivated=!1,this.focusActivated=!1,this.zIndexInc=0,this.$root.triggerHandler("hideAll.smapi")},menuHideSubMenus:function(t){for(var e=this.activatedItems.length-1;e>=t;e--){var i=this.activatedItems[e].dataSM("sub");i&&this.menuHide(i)}},menuInit:function(t){if(!t.dataSM("in-mega")){t.hasClass("mega-menu")&&t.find("ul").dataSM("in-mega",!0);for(var e=2,i=t[0];(i=i.parentNode.parentNode)!=this.$root[0];)e++;var s=t.prevAll("a").eq(-1);s.length||(s=t.prevAll().find("a").eq(-1)),s.addClass("has-submenu").dataSM("sub",t),t.dataSM("parent-a",s).dataSM("level",e).parent().dataSM("sub",t);var o=s.attr("id")||this.accessIdPrefix+ ++this.idInc,a=t.attr("id")||this.accessIdPrefix+ ++this.idInc;s.attr({id:o,"aria-haspopup":"true","aria-controls":a,"aria-expanded":"false"}),t.attr({id:a,role:"group","aria-hidden":"true","aria-labelledby":o,"aria-expanded":"false"}),this.opts.subIndicators&&s[this.opts.subIndicatorsPos](this.$subArrow.clone())}},menuPosition:function(t){var e,i,s=t.dataSM("parent-a"),o=s.closest("li"),a=o.parent(),n=t.dataSM("level"),r=this.getWidth(t),h=this.getHeight(t),u=s.offset(),l=u.left,c=u.top,d=this.getWidth(s),m=this.getHeight(s),p=$(window),f=p.scrollLeft(),v=p.scrollTop(),b=this.getViewportWidth(),S=this.getViewportHeight(),g=a.parent().is("[data-sm-horizontal-sub]")||2==n&&!a.hasClass("sm-vertical"),M=this.opts.rightToLeftSubMenus&&!o.is("[data-sm-reverse]")||!this.opts.rightToLeftSubMenus&&o.is("[data-sm-reverse]"),w=2==n?this.opts.mainMenuSubOffsetX:this.opts.subMenusSubOffsetX,T=2==n?this.opts.mainMenuSubOffsetY:this.opts.subMenusSubOffsetY;if(g?(e=M?d-r-w:w,i=this.opts.bottomToTopSubMenus?-h-T:m+T):(e=M?w-r:d-w,i=this.opts.bottomToTopSubMenus?m-T-h:T),this.opts.keepInViewport){var y=l+e,I=c+i;if(M&&f>y?e=g?f-y+e:d-w:!M&&y+r>f+b&&(e=g?f+b-r-y+e:w-r),g||(S>h&&I+h>v+S?i+=v+S-h-I:(h>=S||v>I)&&(i+=v-I)),g&&(I+h>v+S+.49||v>I)||!g&&h>S+.49){var x=this;t.dataSM("scroll-arrows")||t.dataSM("scroll-arrows",$([$('0;t.dataSM("scroll-arrows").eq(i?0:1).is(":visible")&&(t.dataSM("scroll").up=i,this.menuScroll(t,!0))}e.preventDefault()},menuScrollOut:function(t,e){mouse&&(/^scroll-(up|down)/.test((e.relatedTarget||"").className)||(t[0]==e.relatedTarget||$.contains(t[0],e.relatedTarget))&&this.getClosestMenu(e.relatedTarget)==t[0]||t.dataSM("scroll-arrows").css("visibility","hidden"))},menuScrollOver:function(t,e){if(mouse&&!/^scroll-(up|down)/.test(e.target.className)&&this.getClosestMenu(e.target)==t[0]){this.menuScrollRefreshData(t);var i=t.dataSM("scroll"),s=$(window).scrollTop()-t.dataSM("parent-a").offset().top-i.itemH;t.dataSM("scroll-arrows").eq(0).css("margin-top",s).end().eq(1).css("margin-top",s+this.getViewportHeight()-i.arrowDownH).end().css("visibility","visible")}},menuScrollRefreshData:function(t){var e=t.dataSM("scroll"),i=$(window).scrollTop()-t.dataSM("parent-a").offset().top-e.itemH;this.cssTransforms3d&&(i=-(parseFloat(t.css("margin-top"))-i)),$.extend(e,{upEnd:i,downEnd:i+this.getViewportHeight()-e.subH})},menuScrollStop:function(t){return this.scrollTimeout?(cancelAnimationFrame(this.scrollTimeout),this.scrollTimeout=0,t.dataSM("scroll").step=1,!0):void 0},menuScrollTouch:function(t,e){if(e=e.originalEvent,isTouchEvent(e)){var i=this.getTouchPoint(e);if(this.getClosestMenu(i.target)==t[0]){var s=t.dataSM("scroll");if(/(start|down)$/i.test(e.type))this.menuScrollStop(t)?(e.preventDefault(),this.$touchScrollingSub=t):this.$touchScrollingSub=null,this.menuScrollRefreshData(t),$.extend(s,{touchStartY:i.pageY,touchStartTime:e.timeStamp});else if(/move$/i.test(e.type)){var o=void 0!==s.touchY?s.touchY:s.touchStartY;if(void 0!==o&&o!=i.pageY){this.$touchScrollingSub=t;var a=i.pageY>o;void 0!==s.up&&s.up!=a&&$.extend(s,{touchStartY:i.pageY,touchStartTime:e.timeStamp}),$.extend(s,{up:a,touchY:i.pageY}),this.menuScroll(t,!0,Math.abs(i.pageY-o))}e.preventDefault()}else void 0!==s.touchY&&((s.momentum=15*Math.pow(Math.abs(i.pageY-s.touchStartY)/(e.timeStamp-s.touchStartTime),2))&&(this.menuScrollStop(t),this.menuScroll(t),e.preventDefault()),delete s.touchY)}}},menuShow:function(t){if((t.dataSM("beforefirstshowfired")||(t.dataSM("beforefirstshowfired",!0),this.$root.triggerHandler("beforefirstshow.smapi",t[0])!==!1))&&this.$root.triggerHandler("beforeshow.smapi",t[0])!==!1&&(t.dataSM("shown-before",!0),canAnimate&&t.stop(!0,!0),!t.is(":visible"))){var e=t.dataSM("parent-a"),i=this.isCollapsible();if((this.opts.keepHighlighted||i)&&e.addClass("highlighted"),i)t.removeClass("sm-nowrap").css({zIndex:"",width:"auto",minWidth:"",maxWidth:"",top:"",left:"",marginLeft:"",marginTop:""});else{if(t.css("z-index",this.zIndexInc=(this.zIndexInc||this.getStartZIndex())+1),(this.opts.subMenusMinWidth||this.opts.subMenusMaxWidth)&&(t.css({width:"auto",minWidth:"",maxWidth:""}).addClass("sm-nowrap"),this.opts.subMenusMinWidth&&t.css("min-width",this.opts.subMenusMinWidth),this.opts.subMenusMaxWidth)){var s=this.getWidth(t);t.css("max-width",this.opts.subMenusMaxWidth),s>this.getWidth(t)&&t.removeClass("sm-nowrap").css("width",this.opts.subMenusMaxWidth)}this.menuPosition(t)}var o=function(){t.css("overflow","")};i?canAnimate&&this.opts.collapsibleShowFunction?this.opts.collapsibleShowFunction.call(this,t,o):t.show(this.opts.collapsibleShowDuration,o):canAnimate&&this.opts.showFunction?this.opts.showFunction.call(this,t,o):t.show(this.opts.showDuration,o),e.attr("aria-expanded","true"),t.attr({"aria-expanded":"true","aria-hidden":"false"}),this.visibleSubMenus.push(t),this.$root.triggerHandler("show.smapi",t[0])}},popupHide:function(t){this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0);var e=this;this.hideTimeout=setTimeout(function(){e.menuHideAll()},t?1:this.opts.hideTimeout)},popupShow:function(t,e){if(!this.opts.isPopup)return alert('SmartMenus jQuery Error:\n\nIf you want to show this menu via the "popupShow" method, set the isPopup:true option.'),void 0;if(this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0),this.$root.dataSM("shown-before",!0),canAnimate&&this.$root.stop(!0,!0),!this.$root.is(":visible")){this.$root.css({left:t,top:e});var i=this,s=function(){i.$root.css("overflow","")};canAnimate&&this.opts.showFunction?this.opts.showFunction.call(this,this.$root,s):this.$root.show(this.opts.showDuration,s),this.visibleSubMenus[0]=this.$root}},refresh:function(){this.destroy(!0),this.init(!0)},rootKeyDown:function(t){if(this.handleEvents())switch(t.keyCode){case 27:var e=this.activatedItems[0];if(e){this.menuHideAll(),e[0].focus();var i=e.dataSM("sub");i&&this.menuHide(i)}break;case 32:var s=$(t.target);if(s.is("a")&&this.handleItemEvents(s)){var i=s.dataSM("sub");i&&!i.is(":visible")&&(this.itemClick({currentTarget:t.target}),t.preventDefault())}}},rootOut:function(t){if(this.handleEvents()&&!this.isTouchMode()&&t.target!=this.$root[0]&&(this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0),!this.opts.showOnClick||!this.opts.hideOnClick)){var e=this;this.hideTimeout=setTimeout(function(){e.menuHideAll()},this.opts.hideTimeout)}},rootOver:function(t){this.handleEvents()&&!this.isTouchMode()&&t.target!=this.$root[0]&&this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0)},winResize:function(t){if(this.handleEvents()){if(!("onorientationchange"in window)||"orientationchange"==t.type){var e=this.isCollapsible();this.wasCollapsible&&e||(this.activatedItems.length&&this.activatedItems[this.activatedItems.length-1][0].blur(),this.menuHideAll()),this.wasCollapsible=e}}else if(this.$disableOverlay){var i=this.$root.offset();this.$disableOverlay.css({top:i.top,left:i.left,width:this.$root.outerWidth(),height:this.$root.outerHeight()})}}}}),$.fn.dataSM=function(t,e){return e?this.data(t+"_smartmenus",e):this.data(t+"_smartmenus")},$.fn.removeDataSM=function(t){return this.removeData(t+"_smartmenus")},$.fn.smartmenus=function(options){if("string"==typeof options){var args=arguments,method=options;return Array.prototype.shift.call(args),this.each(function(){var t=$(this).data("smartmenus");t&&t[method]&&t[method].apply(t,args)})}return this.each(function(){var dataOpts=$(this).data("sm-options")||null;if(dataOpts)try{dataOpts=eval("("+dataOpts+")")}catch(e){dataOpts=null,alert('ERROR\n\nSmartMenus jQuery init:\nInvalid "data-sm-options" attribute value syntax.')}new $.SmartMenus(this,$.extend({},$.fn.smartmenus.defaults,options,dataOpts))})},$.fn.smartmenus.defaults={isPopup:!1,mainMenuSubOffsetX:0,mainMenuSubOffsetY:0,subMenusSubOffsetX:0,subMenusSubOffsetY:0,subMenusMinWidth:"10em",subMenusMaxWidth:"20em",subIndicators:!0,subIndicatorsPos:"append",subIndicatorsText:"",scrollStep:30,scrollAccelerate:!0,showTimeout:250,hideTimeout:500,showDuration:0,showFunction:null,hideDuration:0,hideFunction:function(t,e){t.fadeOut(200,e)},collapsibleShowDuration:0,collapsibleShowFunction:function(t,e){t.slideDown(200,e)},collapsibleHideDuration:0,collapsibleHideFunction:function(t,e){t.slideUp(200,e)},showOnClick:!1,hideOnClick:!0,noMouseOver:!1,keepInViewport:!0,keepHighlighted:!0,markCurrentItem:!1,markCurrentTree:!0,rightToLeftSubMenus:!1,bottomToTopSubMenus:!1,collapsibleBehavior:"default"},$});
\ No newline at end of file
diff --git a/docs/doxygen/html/menu.js b/docs/doxygen/html/menu.js
new file mode 100644
index 00000000..433c15b8
--- /dev/null
+++ b/docs/doxygen/html/menu.js
@@ -0,0 +1,50 @@
+/*
+ @licstart The following is the entire license notice for the
+ JavaScript code in this file.
+
+ Copyright (C) 1997-2017 by Dimitri van Heesch
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+ @licend The above is the entire license notice
+ for the JavaScript code in this file
+ */
+function initMenu(relPath,searchEnabled,serverSide,searchPage,search) {
+ function makeTree(data,relPath) {
+ var result='';
+ if ('children' in data) {
+ result+='';
+ }
+ return result;
+ }
+
+ $('#main-nav').append(makeTree(menudata,relPath));
+ $('#main-nav').children(':first').addClass('sm sm-dox').attr('id','main-menu');
+ if (searchEnabled) {
+ if (serverSide) {
+ $('#main-menu').append('MSCCL++: Namespace Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all namespace members with links to the namespace documentation for each member:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
MSCCL++: Namespace Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/namespacemembers_func.html b/docs/doxygen/html/namespacemembers_func.html
new file mode 100644
index 00000000..99a50ac0
--- /dev/null
+++ b/docs/doxygen/html/namespacemembers_func.html
@@ -0,0 +1,204 @@
+
+
+
+MSCCL++: Namespace Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+allocExtSharedCuda()
+: mscclpp
+
+allocExtUniqueCuda()
+: mscclpp
+
+allocSharedCuda()
+: mscclpp
+
+allocSharedPhysicalCuda()
+: mscclpp
+
+allocUniqueCuda()
+: mscclpp
+
+allocUniquePhysicalCuda()
+: mscclpp
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
MSCCL++: Namespace Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/namespacemembers_vars.html b/docs/doxygen/html/namespacemembers_vars.html
new file mode 100644
index 00000000..46480182
--- /dev/null
+++ b/docs/doxygen/html/namespacemembers_vars.html
@@ -0,0 +1,105 @@
+
+
+
+MSCCL++: Namespace Members
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/namespacemscclpp.html b/docs/doxygen/html/namespacemscclpp.html
new file mode 100644
index 00000000..7504f483
--- /dev/null
+++ b/docs/doxygen/html/namespacemscclpp.html
@@ -0,0 +1,1759 @@
+
+
+
+MSCCL++: mscclpp Namespace Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+enum Transport { Transport::Unknown ,
+Transport::CudaIpc ,
+Transport::Nvls ,
+Transport::IB0 ,
+Transport::IB1 ,
+Transport::IB2 ,
+Transport::IB3 ,
+Transport::IB4 ,
+Transport::IB5 ,
+Transport::IB6 ,
+Transport::IB7 ,
+Transport::Ethernet ,
+Transport::NumTransports
+ Enumerates the available transport types. More... enum ErrorCode { ErrorCode::SystemError ,
+ErrorCode::InternalError ,
+ErrorCode::RemoteError ,
+ErrorCode::InvalidUsage ,
+ErrorCode::Timeout ,
+ErrorCode::Aborted ,
+ErrorCode::ExecutorError
+ Enumeration of error codes used by MSCCL++. More... enum DataType { DataType::INT32 ,
+DataType::UINT32 ,
+DataType::FLOAT16 ,
+DataType::FLOAT32 ,
+DataType::BFLOAT16
+ enum PacketType { PacketType::LL8 ,
+PacketType::LL16
+ } enum ProxyHandlerResult { ProxyHandlerResult::Continue ,
+ProxyHandlerResult::FlushFifoTailAndContinue ,
+ProxyHandlerResult::Stop
+ }
+std::string version () Return a version string. More... TransportFlags operator| (Transport transport1, Transport transport2) TransportFlags operator& (Transport transport1, Transport transport2) TransportFlags operator^ (Transport transport1, Transport transport2) int getIBDeviceCount () std::string getIBDeviceName (Transport ibTransport) Transport getIBTransportByDeviceName (const std::string &ibDeviceName) template<typename T > DeviceHandle < std::remove_reference_t< T > > deviceHandle (T &&t) Retrieve the deviceHandle instance from host object. More... std::string errorToString (enum ErrorCode error) template<class T > std::shared_ptr< T > allocSharedCuda (size_t count=1) template<class T > std::shared_ptr< PhysicalCudaMemory < T > > allocSharedPhysicalCuda (size_t count, size_t gran) template<class T > std::shared_ptr< T > allocExtSharedCuda (size_t count=1) template<class T > UniqueCudaPtr < T > allocUniqueCuda (size_t count=1) template<class T > std::unique_ptr< PhysicalCudaMemory < T > > allocUniquePhysicalCuda (size_t count, size_t gran) template<class T > UniqueCudaPtr < T > allocExtUniqueCuda (size_t count=1) template<class T , typename... Args> std::shared_ptr< T > makeSharedCudaHost (Args &&... args) template<class T > std::shared_ptr< T[]> makeSharedCudaHost (size_t count) template<class T , typename... Args, std::enable_if_t< false==std::is_array_v< T >, bool > = true> UniqueCudaHostPtr < T > makeUniqueCudaHost (Args &&... args) template<class T , std::enable_if_t< true==std::is_array_v< T >, bool > = true> UniqueCudaHostPtr < T > makeUniqueCudaHost (size_t count) template<class T > void memcpyCudaAsync (T *dst, const T *src, size_t count, cudaStream_t stream, cudaMemcpyKind kind=cudaMemcpyDefault) template<class T > void memcpyCuda (T *dst, const T *src, size_t count, cudaMemcpyKind kind=cudaMemcpyDefault) int getDeviceNumaNode (int cudaDev) void numaBind (int node) std::shared_ptr< NvlsConnection > connectNvlsCollective (std::shared_ptr< Communicator > comm, std::vector< int > allRanks, size_t bufferSize=NvlsConnection::DefaultNvlsBufferSize ) std::string getHostName (int maxlen, const char delim) bool isNvlsSupported ()
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+
+
A type which could be safely used in device side.
+
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+
+
Packet value type.
+
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+
Unique CUDA host pointer that will call cudaFreeHost on destruction.
Template Parameters
+
+ T Type of each element in the allocated memory.
+
+
+
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+
Unique device pointer that will call cudaFree on destruction.
Template Parameters
+
+ T Type of each element in the allocated memory.
+
+
+
+
+
+
+
◆
+
+
+
+
+
Unique ID for a process. This is a MSCCLPP_UNIQUE_ID_BYTES byte array that uniquely identifies a process.
+
+
+
+
+
+
◆
+
+
+
+
+Enumerator
+
+
+
+
+
◆
+
+
+
+
+
Enumeration of error codes used by MSCCL++.
+
+Enumerator
+
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
+Enumerator
+
+
+
+
+
◆
+
+
+
+
+
Enumerates the available transport types.
+
+Enumerator
+
+
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+ std::shared_ptr<T> mscclpp::allocExtSharedCuda
+ (
+ size_t
+ count = 1)
+
+
+
+
Allocates memory on the device and returns a std::shared_ptr to it. The memory is zeroed out.
Template Parameters
+
+ T Type of each element in the allocated memory.
+
+
+
Parameters
+
+ count Number of elements to allocate.
+
+
+
Returns A std::shared_ptr to the allocated memory.
+
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+ UniqueCudaPtr <T> mscclpp::allocExtUniqueCuda (
+ size_t
+ count = 1)
+
+
+
+
Allocates memory on the device and returns a std::unique_ptr to it. The memory is zeroed out.
Template Parameters
+
+ T Type of each element in the allocated memory.
+
+
+
Parameters
+
+ count Number of elements to allocate.
+
+
+
Returns A std::unique_ptr to the allocated memory.
+
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+ std::shared_ptr<T> mscclpp::allocSharedCuda
+ (
+ size_t
+ count = 1)
+
+
+
+
Allocates memory on the device and returns a std::shared_ptr to it. The memory is zeroed out.
Template Parameters
+
+ T Type of each element in the allocated memory.
+
+
+
Parameters
+
+ count Number of elements to allocate.
+
+
+
Returns A std::shared_ptr to the allocated memory.
+
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+ std::shared_ptr<PhysicalCudaMemory <T> > mscclpp::allocSharedPhysicalCuda
+ (
+ size_t
+ count ,
+
+ size_t
+ gran
+
+ )
+
+
+
+
Allocated physical memory on the device and returns a memory handle along with a memory handle for it. The deallocation only happens PhysicalCudaMemory goes out of scope.
Template Parameters
+
+ T Type of each element in the allocated memory.
+
+
+
Parameters
+
+ count Number of elements to allocate. gran the granularity of the allocation.
+
+
+
Returns A std::shared_ptr to the memory handle and a device pointer for that memory.
+
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+ UniqueCudaPtr <T> mscclpp::allocUniqueCuda (
+ size_t
+ count = 1)
+
+
+
+
Allocates memory on the device and returns a std::unique_ptr to it. The memory is zeroed out.
Template Parameters
+
+ T Type of each element in the allocated memory.
+
+
+
Parameters
+
+ count Number of elements to allocate.
+
+
+
Returns A std::unique_ptr to the allocated memory.
+
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+ std::unique_ptr<PhysicalCudaMemory <T> > mscclpp::allocUniquePhysicalCuda
+ (
+ size_t
+ count ,
+
+ size_t
+ gran
+
+ )
+
+
+
+
Allocated physical memory on the device and returns a memory handle along with a virtual memory handle for it. The memory is zeroed out.
Template Parameters
+
+ T Type of each element in the allocated memory.
+
+
+
Parameters
+
+ count Number of elements to allocate. gran the granularity of the allocation.
+
+
+
Returns A std::unique_ptr to the memory handle and a device pointer for that memory.
+
+
+
+
+
◆
+
+
+
+
Connect to NVLS on setup.
+
This function used to connect to NVLS on setup. NVLS collective using multicast operations to send/recv data. Here we need to put all involved ranks into the collective group.
+
Parameters
+
+ comm The communicator. allRanks The ranks of all processes involved in the collective. config The configuration for the local endpoint.
+
+
+
Returns std::shared_ptr<NvlsConnection> A shared pointer to the NVLS connection.
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+ DeviceHandle <std::remove_reference_t<T> > mscclpp::deviceHandle (
+ T &&
+ t )
+
+
+
+
+
Retrieve the deviceHandle instance from host object.
+
+
+
+
+
◆
+
+
+
+
+
+ std::string mscclpp::errorToString
+ (
+ enum ErrorCode
+ error )
+
+
+
+
Convert an error code to a string.
+
Parameters
+
+ error The error code to convert.
+
+
+
Returns The string representation of the error code.
+
+
+
+
+
◆
+
+
+
+
+
+ int mscclpp::getDeviceNumaNode
+ (
+ int
+ cudaDev )
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ std::string mscclpp::getHostName
+ (
+ int
+ maxlen ,
+
+ const char
+ delim
+
+ )
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ int mscclpp::getIBDeviceCount
+ (
+ )
+
+
+
+
Get the number of available InfiniBand devices.
+
Returns The number of available InfiniBand devices.
+
+
+
+
+
◆
+
+
+
+
+
+ std::string mscclpp::getIBDeviceName
+ (
+ Transport ibTransport )
+
+
+
+
Get the name of the InfiniBand device associated with the specified transport.
+
Parameters
+
+ ibTransport The InfiniBand transport to get the device name for.
+
+
+
Returns The name of the InfiniBand device associated with the specified transport.
+
+
+
+
+
◆
+
+
+
+
+
+ Transport mscclpp::getIBTransportByDeviceName (
+ const std::string &
+ ibDeviceName )
+
+
+
+
Get the InfiniBand transport associated with the specified device name.
+
Parameters
+
+ ibDeviceName The name of the InfiniBand device to get the transport for.
+
+
+
Returns The InfiniBand transport associated with the specified device name.
+
+
+
+
+
◆
+
+
+
+
+
+ bool mscclpp::isNvlsSupported
+ (
+ )
+
+
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+template<class T , typename... Args>
+
+
+ std::shared_ptr<T> mscclpp::makeSharedCudaHost
+ (
+ Args &&...
+ args )
+
+
+
+
Allocates memory with cudaHostAlloc, constructs an object of type T in it and returns a std::shared_ptr to it.
Template Parameters
+
+ T Type of the object to construct. Args Types of the arguments to pass to the constructor.
+
+
+
Parameters
+
+ args Arguments to pass to the constructor.
+
+
+
Returns A std::shared_ptr to the allocated memory.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+template<class T >
+
+
+ std::shared_ptr<T[]> mscclpp::makeSharedCudaHost
+ (
+ size_t
+ count )
+
+
+
+
Allocates an array of objects of type T with cudaHostAlloc, default constructs each element and returns a std::shared_ptr to it.
Template Parameters
+
+ T Type of the object to construct.
+
+
+
Parameters
+
+ count Number of elements to allocate.
+
+
+
Returns A std::shared_ptr to the allocated memory.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+template<class T , typename... Args, std::enable_if_t< false==std::is_array_v< T >, bool > = true>
+
+
+
Allocates memory with cudaHostAlloc, constructs an object of type T in it and returns a std::unique_ptr to it.
Template Parameters
+
+ T Type of the object to construct. Args Types of the arguments to pass to the constructor.
+
+
+
Parameters
+
+ args Arguments to pass to the constructor.
+
+
+
Returns A std::unique_ptr to the allocated memory.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+template<class T , std::enable_if_t< true==std::is_array_v< T >, bool > = true>
+
+
+
Allocates an array of objects of type T with cudaHostAlloc, default constructs each element and returns a std::unique_ptr to it.
Template Parameters
+
+ T Type of the object to construct.
+
+
+
Parameters
+
+ count Number of elements to allocate.
+
+
+
Returns A std::unique_ptr to the allocated memory.
+
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+ void mscclpp::memcpyCuda
+ (
+ T *
+ dst ,
+
+ const T *
+ src ,
+
+ size_t
+ count ,
+
+ cudaMemcpyKind
+ kind = cudaMemcpyDefault
+
+ )
+
+
+
+
Synchronous cudaMemcpy without capture into a CUDA graph.
Template Parameters
+
+ T Type of each element in the allocated memory.
+
+
+
Parameters
+
+ dst Destination pointer. src Source pointer. count Number of elements to copy. kind Type of cudaMemcpy to perform.
+
+
+
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+ void mscclpp::memcpyCudaAsync
+ (
+ T *
+ dst ,
+
+ const T *
+ src ,
+
+ size_t
+ count ,
+
+ cudaStream_t
+ stream ,
+
+ cudaMemcpyKind
+ kind = cudaMemcpyDefault
+
+ )
+
+
+
+
Asynchronous cudaMemcpy without capture into a CUDA graph.
Template Parameters
+
+ T Type of each element in the allocated memory.
+
+
+
Parameters
+
+ dst Destination pointer. src Source pointer. count Number of elements to copy. stream CUDA stream to use. kind Type of cudaMemcpy to perform.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void mscclpp::numaBind
+ (
+ int
+ node )
+
+
+
+
+
+
+
+
◆
+
+
+
+
Bitwise AND operator for two Transport objects.
+
Parameters
+
+ transport1 The first Transport to perform the AND operation with. transport2 The second Transport to perform the AND operation with.
+
+
+
Returns A new TransportFlags object with the result of the AND operation.
+
+
+
+
+
◆
+
+
+
+
Bitwise XOR operator for two Transport objects.
+
Parameters
+
+ transport1 The first Transport to perform the XOR operation with. transport2 The second Transport to perform the XOR operation with.
+
+
+
Returns A new TransportFlags object with the result of the XOR operation.
+
+
+
+
+
◆
+
+
+
+
Bitwise OR operator for two Transport objects.
+
Parameters
+
+ transport1 The first Transport to perform the OR operation with. transport2 The second Transport to perform the OR operation with.
+
+
+
Returns A new TransportFlags object with the result of the OR operation.
+
+
+
+
+
◆
+
+
+
+
+
+ std::string mscclpp::version
+ (
+ )
+
+
+
+
+
Return a version string.
+
+
+
+
+
+
◆
+
+
+
+
+
A constant TransportFlags object representing all InfiniBand transports.
+
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ constexpr size_t mscclpp::DEFAULT_FIFO_SIZE = 128
+
+
+
+
+constexpr
+
+
+
+
+
+
+
+
◆
+
+
+
+
+template<class >
+
+
+
+
+
+ constexpr bool mscclpp::dependentFalse = false
+
+
+
+
+constexpr
+
+
+
+
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
+
+ const std::string mscclpp::TransportNames[]
+
+
+
+
Initial value: = {"UNK" , "IPC" , "NVLS" , "IB0" , "IB1" , "IB2" , "IB3" ,
+
"IB4" , "IB5" , "IB6" , "IB7" , "ETH" , "NUM" }
+
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
◆
+
+
+
MSCCL++: mscclpp::detail Namespace Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+template<class T > T * cudaCalloc (size_t nelem) template<class T > PhysicalCudaMemory < T > * cudaPhysicalCalloc (size_t nelem, size_t gran) template<class T > T * cudaExtCalloc (size_t nelem) template<class T > T * cudaHostCalloc (size_t nelem) template<class T , T * , class Deleter , class Memory > Memory safeAlloc (size_t nelem) template<class T , T * , class Deleter , class Memory > Memory safeAlloc (size_t nelem, size_t gran)
+
+
+
◆
+
+
+
+
+
Bitset for storing transport flags.
+
+
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+ T* mscclpp::detail::cudaCalloc
+ (
+ size_t
+ nelem )
+
+
+
+
A wrapper of cudaMalloc that sets the allocated memory to zero.
Template Parameters
+
+ T Type of each element in the allocated memory.
+
+
+
Parameters
+
+ nelem Number of elements to allocate.
+
+
+
Returns A pointer to the allocated memory.
+
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+ T* mscclpp::detail::cudaExtCalloc
+ (
+ size_t
+ nelem )
+
+
+
+
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+ T* mscclpp::detail::cudaHostCalloc
+ (
+ size_t
+ nelem )
+
+
+
+
A wrapper of cudaHostAlloc that sets the allocated memory to zero.
Template Parameters
+
+ T Type of each element in the allocated memory.
+
+
+
Parameters
+
+ nelem Number of elements to allocate.
+
+
+
Returns A pointer to the allocated memory.
+
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+ PhysicalCudaMemory <T>* mscclpp::detail::cudaPhysicalCalloc (
+ size_t
+ nelem ,
+
+ size_t
+ gran
+
+ )
+
+
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+template<class T , T * , class Deleter , class Memory >
+
+
+ Memory mscclpp::detail::safeAlloc
+ (
+ size_t
+ nelem )
+
+
+
+
A template function that allocates memory while ensuring that the memory will be freed when the returned object is destroyed.
Template Parameters
+
+ T Type of each element in the allocated memory. alloc A function that allocates memory. Deleter A deleter that will be used to free the allocated memory. Memory The type of the returned object.
+
+
+
Parameters
+
+ nelem Number of elements to allocate.
+
+
+
Returns An object of type Memory that will free the allocated memory when destroyed.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+template<class T , T * , class Deleter , class Memory >
+
+
+ Memory mscclpp::detail::safeAlloc
+ (
+ size_t
+ nelem ,
+
+ size_t
+ gran
+
+ )
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ const size_t mscclpp::detail::TransportFlagsSize = 12
+
+
+
+
+
+
+
MSCCL++: Namespace List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all namespaces with brief descriptions:
+
MSCCL++: std Namespace Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/nav_f.png b/docs/doxygen/html/nav_f.png
new file mode 100644
index 00000000..72a58a52
Binary files /dev/null and b/docs/doxygen/html/nav_f.png differ
diff --git a/docs/doxygen/html/nav_g.png b/docs/doxygen/html/nav_g.png
new file mode 100644
index 00000000..2093a237
Binary files /dev/null and b/docs/doxygen/html/nav_g.png differ
diff --git a/docs/doxygen/html/nav_h.png b/docs/doxygen/html/nav_h.png
new file mode 100644
index 00000000..33389b10
Binary files /dev/null and b/docs/doxygen/html/nav_h.png differ
diff --git a/docs/doxygen/html/npkit_8hpp.html b/docs/doxygen/html/npkit_8hpp.html
new file mode 100644
index 00000000..c3e9b924
--- /dev/null
+++ b/docs/doxygen/html/npkit_8hpp.html
@@ -0,0 +1,159 @@
+
+
+
+MSCCL++: npkit.hpp File Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <mscclpp/device.hpp >
+
#include <mscclpp/gpu_utils.hpp >
+
#include <mscclpp/npkit/npkit_event.hpp >
+
#include <mscclpp/npkit/npkit_struct.hpp >
+
#include <string>
+
#include <thread>
+
#include <vector>
+
+
+
+
+
+
+
+
Go to the source code of this file.
+
+
+
+
◆
+
+
+
+
+
+ #define NPKIT_GET_GPU_TIMESTAMP clock64
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define NPKIT_SHM_NUM_EVENTS 64
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/npkit_8hpp__incl.md5 b/docs/doxygen/html/npkit_8hpp__incl.md5
new file mode 100644
index 00000000..773d0dd4
--- /dev/null
+++ b/docs/doxygen/html/npkit_8hpp__incl.md5
@@ -0,0 +1 @@
+7127751afa8b766de8e9f12723ab20b2
\ No newline at end of file
diff --git a/docs/doxygen/html/npkit_8hpp__incl.png b/docs/doxygen/html/npkit_8hpp__incl.png
new file mode 100644
index 00000000..822a250e
Binary files /dev/null and b/docs/doxygen/html/npkit_8hpp__incl.png differ
diff --git a/docs/doxygen/html/npkit_8hpp_source.html b/docs/doxygen/html/npkit_8hpp_source.html
new file mode 100644
index 00000000..d846fe4f
--- /dev/null
+++ b/docs/doxygen/html/npkit_8hpp_source.html
@@ -0,0 +1,207 @@
+
+
+
+MSCCL++: npkit.hpp Source File
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
15 #if defined(__HIP_PLATFORM_AMD__)
+
16 #define NPKIT_GET_GPU_TIMESTAMP wall_clock64
+
17 #define NPKIT_MAX_NUM_GPU_THREADBLOCKS 64
+
18 #define NPKIT_CPU_TIMESTAMP_SLOT_SIZE 128
+
19 #define NPKIT_LOAD_CPU_TIMESTAMP_PER_BLOCK(buf, blk) *(buf + NPKIT_CPU_TIMESTAMP_SLOT_SIZE * blk / sizeof(uint64_t))
+
20 #define NPKIT_STORE_CPU_TIMESTAMP_PER_BLOCK(buf, val, blk) \
+
21 *reinterpret_cast<volatile uint64_t*>(buf + NPKIT_CPU_TIMESTAMP_SLOT_SIZE * blk / sizeof(uint64_t)) = val
+
+
+
24 #define NPKIT_GET_GPU_TIMESTAMP clock64
+
+
+
27 #define NPKIT_SHM_NUM_EVENTS 64
+
+
+
+
+
+
+
+
35 static void Init (
int rank);
+
+
37 static void Dump (
const std::string& dump_dir);
+
+
+
+
+
+
43 #if defined(MSCCLPP_DEVICE_COMPILE)
+
44 static MSCCLPP_DEVICE_INLINE
void CollectGpuEventShm(uint8_t type, uint32_t size, uint32_t rsvd, uint64_t timestamp,
+
45 NpKitEvent * event_buffer, uint64_t* event_buffer_head) {
+
+
47 if (threadIdx.x == 0) {
+
48 NpKitEvent &
event = event_buffer[*event_buffer_head];
+
+
50 event .fields.size = size;
+
51 event .fields.rsvd = rsvd;
+
52 event .fields.timestamp = timestamp;
+
+
54 (*event_buffer_head)++;
+
+
+
+
+
59 NpKitEvent * event_buffer, uint64_t event_buffer_head) {
+
+
+
+
+
64 for (
size_t i = threadIdx.x; i < event_buffer_head *
sizeof (
NpKitEvent ) /
sizeof (int4); i += blockDim.x) {
+
65 ((int4*)(global_event_buffer + global_event_buffer_head))[i] = ((int4*)event_buffer)[i];
+
+
67 if (threadIdx.x == 0) {
+
+
+
+
+
+
73 static void CollectCpuEvent (uint8_t type, uint32_t size, uint32_t rsvd, uint64_t timestamp,
int channel_id);
+
+
+
+
+
78 static void CpuTimestampUpdateThread();
+
+
+
81 static const uint64_t kMaxNumGpuEventsPerBuffer = 1ULL << 16;
+
+
+
84 static const uint64_t kMaxNumCpuEventsPerBuffer = 1ULL << 21;
+
+
86 static std::vector<mscclpp::UniqueCudaPtr<NpKitEvent>> gpu_event_buffers_;
+
87 static std::vector<std::unique_ptr<NpKitEvent[]>> cpu_event_buffers_;
+
+
+
90 static std::unique_ptr<NpKitEventCollectContext[]> cpu_collect_contexts_;
+
+
92 static uint64_t rank_;
+
+
94 #if defined(__HIP_PLATFORM_AMD__)
+
+
+
+
+
99 static std::unique_ptr<std::thread> cpu_timestamp_update_thread_;
+
100 static volatile bool cpu_timestamp_update_thread_should_stop_;
+
+
+
+
Definition: npkit_struct.hpp:21
#define __syncshm()
Definition: gpu.hpp:109
static void CollectCpuEvent(uint8_t type, uint32_t size, uint32_t rsvd, uint64_t timestamp, int channel_id)
uint64_t event_buffer_head
Definition: npkit_struct.hpp:23
static const uint64_t kNumCpuEventBuffers
Definition: npkit.hpp:33
static NpKitEventCollectContext * GetGpuEventCollectContexts()
static uint64_t * GetCpuTimestamp()
#define NPKIT_SHM_NUM_EVENTS
Definition: npkit.hpp:27
NpKitEvent * event_buffer
Definition: npkit_struct.hpp:22
uint64_t type
Definition: npkit_struct.hpp:14
static void Init(int rank)
Definition: npkit_struct.hpp:11
static const uint64_t kNumGpuEventBuffers
Definition: npkit.hpp:31
std::unique_ptr< T, CudaDeleter< T > > UniqueCudaPtr
Definition: gpu_utils.hpp:261
std::unique_ptr< T, CudaHostDeleter< T > > UniqueCudaHostPtr
Definition: gpu_utils.hpp:323
struct NpKitEvent::@0 fields
static void Dump(const std::string &dump_dir)
MSCCL++: npkit_event.hpp File Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the source code of this file.
+
+
+
+
◆
+
+
+
+
+
+ #define NPKIT_EVENT_EXECUTOR_INIT_ENTRY 0x3
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define NPKIT_EVENT_EXECUTOR_INIT_EXIT 0x4
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define NPKIT_EVENT_EXECUTOR_OP_BASE_ENTRY 0x5
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define NPKIT_EVENT_EXECUTOR_OP_BASE_EXIT 0x17
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define NPKIT_EVENT_INVALID 0x0
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define NPKIT_EVENT_TIME_SYNC_CPU 0x2
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define NPKIT_EVENT_TIME_SYNC_GPU 0x1
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/npkit__event_8hpp__dep__incl.md5 b/docs/doxygen/html/npkit__event_8hpp__dep__incl.md5
new file mode 100644
index 00000000..ccf92a77
--- /dev/null
+++ b/docs/doxygen/html/npkit__event_8hpp__dep__incl.md5
@@ -0,0 +1 @@
+1bb2a88f0a8e8630272fa98e111cbe9b
\ No newline at end of file
diff --git a/docs/doxygen/html/npkit__event_8hpp__dep__incl.png b/docs/doxygen/html/npkit__event_8hpp__dep__incl.png
new file mode 100644
index 00000000..82f4ab8c
Binary files /dev/null and b/docs/doxygen/html/npkit__event_8hpp__dep__incl.png differ
diff --git a/docs/doxygen/html/npkit__event_8hpp_source.html b/docs/doxygen/html/npkit__event_8hpp_source.html
new file mode 100644
index 00000000..3fb7cc08
--- /dev/null
+++ b/docs/doxygen/html/npkit__event_8hpp_source.html
@@ -0,0 +1,99 @@
+
+
+
+MSCCL++: npkit_event.hpp Source File
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
7 #define NPKIT_EVENT_INVALID 0x0
+
+
9 #define NPKIT_EVENT_TIME_SYNC_GPU 0x1
+
10 #define NPKIT_EVENT_TIME_SYNC_CPU 0x2
+
+
12 #define NPKIT_EVENT_EXECUTOR_INIT_ENTRY 0x3
+
13 #define NPKIT_EVENT_EXECUTOR_INIT_EXIT 0x4
+
+
15 #define NPKIT_EVENT_EXECUTOR_OP_BASE_ENTRY 0x5
+
16 #define NPKIT_EVENT_EXECUTOR_OP_BASE_EXIT 0x17
+
+
+
MSCCL++: npkit_struct.hpp File Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/npkit__struct_8hpp__dep__incl.md5 b/docs/doxygen/html/npkit__struct_8hpp__dep__incl.md5
new file mode 100644
index 00000000..0c36b20b
--- /dev/null
+++ b/docs/doxygen/html/npkit__struct_8hpp__dep__incl.md5
@@ -0,0 +1 @@
+1320386eef95ce4025716d314b62c7e0
\ No newline at end of file
diff --git a/docs/doxygen/html/npkit__struct_8hpp__dep__incl.png b/docs/doxygen/html/npkit__struct_8hpp__dep__incl.png
new file mode 100644
index 00000000..46a10f4a
Binary files /dev/null and b/docs/doxygen/html/npkit__struct_8hpp__dep__incl.png differ
diff --git a/docs/doxygen/html/npkit__struct_8hpp__incl.map b/docs/doxygen/html/npkit__struct_8hpp__incl.map
new file mode 100644
index 00000000..9c789400
--- /dev/null
+++ b/docs/doxygen/html/npkit__struct_8hpp__incl.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/npkit__struct_8hpp__incl.md5 b/docs/doxygen/html/npkit__struct_8hpp__incl.md5
new file mode 100644
index 00000000..4fb9928b
--- /dev/null
+++ b/docs/doxygen/html/npkit__struct_8hpp__incl.md5
@@ -0,0 +1 @@
+cf3b35750e0567bdc4c5e0b4951f2c92
\ No newline at end of file
diff --git a/docs/doxygen/html/npkit__struct_8hpp__incl.png b/docs/doxygen/html/npkit__struct_8hpp__incl.png
new file mode 100644
index 00000000..a9be5448
Binary files /dev/null and b/docs/doxygen/html/npkit__struct_8hpp__incl.png differ
diff --git a/docs/doxygen/html/npkit__struct_8hpp_source.html b/docs/doxygen/html/npkit__struct_8hpp_source.html
new file mode 100644
index 00000000..bc1a2007
--- /dev/null
+++ b/docs/doxygen/html/npkit__struct_8hpp_source.html
@@ -0,0 +1,119 @@
+
+
+
+MSCCL++: npkit_struct.hpp Source File
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef NPKIT_STRUCT_H_
+
5 #define NPKIT_STRUCT_H_
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Definition: npkit_struct.hpp:21
uint64_t event_buffer_head
Definition: npkit_struct.hpp:23
uint64_t rsvd
Definition: npkit_struct.hpp:16
NpKitEvent * event_buffer
Definition: npkit_struct.hpp:22
uint64_t type
Definition: npkit_struct.hpp:14
uint64_t bits[2]
Definition: npkit_struct.hpp:12
Definition: npkit_struct.hpp:11
uint64_t timestamp
Definition: npkit_struct.hpp:17
struct NpKitEvent::@0 fields
uint64_t size
Definition: npkit_struct.hpp:15
MSCCL++: numa.hpp File Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
MSCCL++: numa.hpp Source File
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_NUMA_HPP_
+
5 #define MSCCLPP_NUMA_HPP_
+
+
+
+
+
+
+
+
+
14 #endif // MSCCLPP_NUMA_HPP_
+
int getDeviceNumaNode(int cudaDev)
Definition: atomic_device.hpp:13
MSCCL++: nvls.hpp File Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the source code of this file.
+
+std::shared_ptr< NvlsConnection > mscclpp::connectNvlsCollective (std::shared_ptr< Communicator > comm, std::vector< int > allRanks, size_t bufferSize=NvlsConnection::DefaultNvlsBufferSize)
+
+
diff --git a/docs/doxygen/html/nvls_8hpp__incl.md5 b/docs/doxygen/html/nvls_8hpp__incl.md5
new file mode 100644
index 00000000..7769b03a
--- /dev/null
+++ b/docs/doxygen/html/nvls_8hpp__incl.md5
@@ -0,0 +1 @@
+4692ec8599115a8288f1d241185e48fc
\ No newline at end of file
diff --git a/docs/doxygen/html/nvls_8hpp__incl.png b/docs/doxygen/html/nvls_8hpp__incl.png
new file mode 100644
index 00000000..4cb77d83
Binary files /dev/null and b/docs/doxygen/html/nvls_8hpp__incl.png differ
diff --git a/docs/doxygen/html/nvls_8hpp_source.html b/docs/doxygen/html/nvls_8hpp_source.html
new file mode 100644
index 00000000..7d308d1c
--- /dev/null
+++ b/docs/doxygen/html/nvls_8hpp_source.html
@@ -0,0 +1,162 @@
+
+
+
+MSCCL++: nvls.hpp Source File
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_NVLS_HPP_
+
5 #define MSCCLPP_NVLS_HPP_
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
28 std::shared_ptr<PhysicalCudaMemory<char>> deviceMem_;
+
29 std::shared_ptr<char> mcPtr_;
+
+
+
+
+
+
+
36 : deviceMem_(deviceMem), mcPtr_(mcPtr), bufferSize_(bufferSize) {}
+
+
+
+
+
+
+
+
+
47 std::shared_ptr<char>
bindAllocatedCuda (CUmemGenericAllocationHandle memHandle,
size_t size);
+
+
+
+
+
+
53 std::shared_ptr<Impl> pimpl_;
+
+
+
+
+
67 std::shared_ptr<NvlsConnection>
connectNvlsCollective (std::shared_ptr<Communicator> comm, std::vector<int> allRanks,
+
+
+
+
+
72 #endif // MSCCLPP_NVLS_HPP_
+
typename T::DeviceHandle DeviceHandle
A type which could be safely used in device side.
Definition: core.hpp:709
std::shared_ptr< char > bindAllocatedCuda(CUmemGenericAllocationHandle memHandle, size_t size)
std::vector< char > serialize()
static const int DefaultNvlsBufferSize
Definition: nvls.hpp:20
std::shared_ptr< DeviceMulticastPointer > allocateAndBindCuda(size_t size)
std::shared_ptr< NvlsConnection > connectNvlsCollective(std::shared_ptr< Communicator > comm, std::vector< int > allRanks, size_t bufferSize=NvlsConnection::DefaultNvlsBufferSize)
Device-side handle for Host2DeviceSemaphore.
Definition: nvls_device.hpp:22
size_t getMultiCastMinGranularity()
DeviceHandle deviceHandle()
DeviceMulticastPointer(std::shared_ptr< PhysicalCudaMemory< char >> deviceMem, std::shared_ptr< char > mcPtr, size_t bufferSize)
Definition: nvls.hpp:34
Definition: atomic_device.hpp:13
Definition: gpu_utils.hpp:57
MSCCL++: nvls_device.hpp File Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/nvls__device_8hpp__dep__incl.md5 b/docs/doxygen/html/nvls__device_8hpp__dep__incl.md5
new file mode 100644
index 00000000..1b29080d
--- /dev/null
+++ b/docs/doxygen/html/nvls__device_8hpp__dep__incl.md5
@@ -0,0 +1 @@
+9aef05865dbb2bfffa58699725a36769
\ No newline at end of file
diff --git a/docs/doxygen/html/nvls__device_8hpp__dep__incl.png b/docs/doxygen/html/nvls__device_8hpp__dep__incl.png
new file mode 100644
index 00000000..3ca2c128
Binary files /dev/null and b/docs/doxygen/html/nvls__device_8hpp__dep__incl.png differ
diff --git a/docs/doxygen/html/nvls__device_8hpp__incl.map b/docs/doxygen/html/nvls__device_8hpp__incl.map
new file mode 100644
index 00000000..9901276c
--- /dev/null
+++ b/docs/doxygen/html/nvls__device_8hpp__incl.map
@@ -0,0 +1,9 @@
+
+
diff --git a/docs/doxygen/html/nvls__device_8hpp__incl.md5 b/docs/doxygen/html/nvls__device_8hpp__incl.md5
new file mode 100644
index 00000000..b7743d17
--- /dev/null
+++ b/docs/doxygen/html/nvls__device_8hpp__incl.md5
@@ -0,0 +1 @@
+4580e0b38c4c0b8852c2d2aeb02c9e7c
\ No newline at end of file
diff --git a/docs/doxygen/html/nvls__device_8hpp__incl.png b/docs/doxygen/html/nvls__device_8hpp__incl.png
new file mode 100644
index 00000000..db7e21ac
Binary files /dev/null and b/docs/doxygen/html/nvls__device_8hpp__incl.png differ
diff --git a/docs/doxygen/html/nvls__device_8hpp_source.html b/docs/doxygen/html/nvls__device_8hpp_source.html
new file mode 100644
index 00000000..291a5553
--- /dev/null
+++ b/docs/doxygen/html/nvls__device_8hpp_source.html
@@ -0,0 +1,201 @@
+
+
+
+MSCCL++: nvls_device.hpp Source File
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_NVLS_DEVICE_HPP_
+
5 #define MSCCLPP_NVLS_DEVICE_HPP_
+
+
+
+
+
10 #if defined(MSCCLPP_DEVICE_CUDA)
+
11 #include <cuda_fp16.h>
+
12 #endif // defined(MSCCLPP_DEVICE_CUDA)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #if defined(MSCCLPP_DEVICE_CUDA)
+
28 template <
typename TValue,
typename T>
+
29 MSCCLPP_DEVICE_INLINE
static void multimemLoadReduce(TValue& val, T* ptr) {
+
30 if constexpr (std::is_same_v<TValue, uint4> && std::is_same_v<T, float>) {
+
31 asm (
"multimem.ld_reduce.relaxed.sys.global.add.v4.f32 {%0,%1,%2,%3}, [%4];"
+
32 :
"=r" (val.x),
"=r" (val.y),
"=r" (val.z),
"=r" (val.w)
+
+
+
35 }
else if constexpr (std::is_same_v<TValue, uint2> && std::is_same_v<T, float>) {
+
36 asm (
"multimem.ld_reduce.relaxed.sys.global.add.v2.f32 {%0,%1}, [%2];"
+
37 :
"=r" (val.x),
"=r" (val.y)
+
+
+
40 }
else if constexpr (std::is_same_v<TValue, uint1> && std::is_same_v<T, float>) {
+
41 asm (
"multimem.ld_reduce.relaxed.sys.global.add.f32 {%0}, [%1];" :
"=r" (val.x) :
"l" (ptr) :
"memory" );
+
42 }
else if constexpr (std::is_same_v<TValue, uint4> && std::is_same_v<T, __half2>) {
+
43 asm (
"multimem.ld_reduce.relaxed.sys.global.add.v4.f16x2 {%0,%1,%2,%3}, [%4];"
+
44 :
"=r" (val.x),
"=r" (val.y),
"=r" (val.z),
"=r" (val.w)
+
+
+
47 }
else if constexpr (std::is_same_v<TValue, uint2> && std::is_same_v<T, __half2>) {
+
48 asm (
"multimem.ld_reduce.relaxed.sys.global.add.v2.f16x2 {%0,%1}, [%2];"
+
49 :
"=r" (val.x),
"=r" (val.y)
+
+
+
52 }
else if constexpr (std::is_same_v<TValue, uint1> && std::is_same_v<T, __half2>) {
+
53 asm (
"multimem.ld_reduce.relaxed.sys.global.add.f16x2 {%0}, [%1];" :
"=r" (val.x) :
"l" (ptr) :
"memory" );
+
+
55 static_assert(dependentFalse<T>,
"Not supported type" );
+
+
+
+
59 template <
typename TValue,
typename T>
+
60 MSCCLPP_DEVICE_INLINE
static void multimemStore(
const TValue& val, T* ptr) {
+
61 if constexpr (std::is_same_v<TValue, uint4> && std::is_same_v<T, float>) {
+
62 asm volatile (
"multimem.st.relaxed.sys.global.v4.f32 [%0], {%1,%2,%3,%4};" ::
"l" (ptr),
"r" (val.x),
"r" (val.y),
+
63 "r" (val.z),
"r" (val.w)
+
+
65 }
else if constexpr (std::is_same_v<TValue, uint2> && std::is_same_v<T, float>) {
+
66 asm volatile (
"multimem.st.relaxed.sys.global.v2.f32 [%0], {%1,%2};" ::
"l" (ptr),
"r" (val.x),
"r" (val.y)
+
+
68 }
else if constexpr (std::is_same_v<TValue, uint1> && std::is_same_v<T, float>) {
+
69 asm volatile (
"multimem.st.relaxed.sys.global.f32 [%0], {%1};" ::
"l" (ptr),
"r" (val.x) :
"memory" );
+
70 }
else if constexpr (std::is_same_v<TValue, uint4> && std::is_same_v<T, __half2>) {
+
71 asm volatile (
"multimem.st.relaxed.sys.global.v4.f16x2 [%0], {%1,%2,%3,%4};" ::
"l" (ptr),
"r" (val.x),
"r" (val.y),
+
72 "r" (val.z),
"r" (val.w)
+
+
74 }
else if constexpr (std::is_same_v<TValue, uint2> && std::is_same_v<T, __half2>) {
+
75 asm volatile (
"multimem.st.relaxed.sys.global.v2.f16x2 [%0], {%1,%2};" ::
"l" (ptr),
"r" (val.x),
"r" (val.y)
+
+
77 }
else if constexpr (std::is_same_v<TValue, uint1> && std::is_same_v<T, __half2>) {
+
78 asm volatile (
"multimem.st.relaxed.sys.global.f16x2 [%0], {%1};" ::
"l" (ptr),
"r" (val.x) :
"memory" );
+
+
80 static_assert(dependentFalse<T>,
"Not supported type" );
+
+
+
+
84 template <
typename TValue,
typename T>
+
85 MSCCLPP_DEVICE_INLINE
static void multimemStoreReduce(
const TValue& val, T* ptr) {
+
86 if constexpr (std::is_same_v<TValue, float4> && std::is_same_v<T, float>) {
+
87 asm volatile (
"multimem.red.relaxed.sys.global.add.v4.f32 [%0], {%1,%2,%3,%4};" ::
"l" (ptr),
"r" (val.x),
"r" (val.y),
+
88 "r" (val.z),
"r" (val.w)
+
+
90 }
else if constexpr (std::is_same_v<TValue, uint2> && std::is_same_v<T, float>) {
+
91 asm volatile (
"multimem.red.relaxed.sys.global.add.v2.f32 [%0], {%1,%2};" ::
"l" (ptr),
"r" (val.x),
"r" (val.y)
+
+
93 }
else if constexpr (std::is_same_v<TValue, uint1> && std::is_same_v<T, float>) {
+
94 asm volatile (
"multimem.red.relaxed.sys.global.add.f32 [%0], {%1};" ::
"l" (ptr),
"r" (val.x) :
"memory" );
+
95 }
else if constexpr (std::is_same_v<TValue, uint4> && std::is_same_v<T, __half2>) {
+
96 asm volatile (
"multimem.red.relaxed.sys.global.add.v4.f16x2 [%0], {%1,%2,%3,%4};" ::
"l" (ptr),
"r" (val.x),
+
97 "r" (val.y),
"r" (val.z),
"r" (val.w)
+
+
99 }
else if constexpr (std::is_same_v<TValue, uint2> && std::is_same_v<T, __half2>) {
+
100 asm volatile (
"multimem.red.relaxed.sys.global.add.v2.f16x2 [%0], {%1,%2};" ::
"l" (ptr),
"r" (val.x),
"r" (val.y)
+
+
102 }
else if constexpr (std::is_same_v<TValue, uint1> && std::is_same_v<T, __half2>) {
+
103 asm volatile (
"multimem.red.relaxed.sys.global.add.f16x2 [%0], {%1};" ::
"l" (ptr),
"r" (val.x) :
"memory" );
+
+
105 static_assert(dependentFalse<T>,
"Not supported type" );
+
+
+
108 #endif // defined(MSCCLPP_DEVICE_CUDA)
+
+
+
+
+
113 #endif // MSCCLPP_NVLS_DEVICE_HPP_
+
size_t bufferSize
Definition: nvls_device.hpp:25
void * devicePtr
Definition: nvls_device.hpp:23
Device-side handle for Host2DeviceSemaphore.
Definition: nvls_device.hpp:22
void * mcPtr
Definition: nvls_device.hpp:24
constexpr bool dependentFalse
Definition: nvls_device.hpp:19
Definition: atomic_device.hpp:13
MSCCL++: packet_device.hpp File Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <cstdint>
+
#include <type_traits>
+
#include "device.hpp "
+
+
Go to the source code of this file.
+
+
+
diff --git a/docs/doxygen/html/packet__device_8hpp__incl.md5 b/docs/doxygen/html/packet__device_8hpp__incl.md5
new file mode 100644
index 00000000..5672de69
--- /dev/null
+++ b/docs/doxygen/html/packet__device_8hpp__incl.md5
@@ -0,0 +1 @@
+76154bf274ab0835c066a123479fa03d
\ No newline at end of file
diff --git a/docs/doxygen/html/packet__device_8hpp__incl.png b/docs/doxygen/html/packet__device_8hpp__incl.png
new file mode 100644
index 00000000..94a516bc
Binary files /dev/null and b/docs/doxygen/html/packet__device_8hpp__incl.png differ
diff --git a/docs/doxygen/html/packet__device_8hpp_source.html b/docs/doxygen/html/packet__device_8hpp_source.html
new file mode 100644
index 00000000..72009911
--- /dev/null
+++ b/docs/doxygen/html/packet__device_8hpp_source.html
@@ -0,0 +1,318 @@
+
+
+
+MSCCL++: packet_device.hpp Source File
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_PACKET_DEVICE_HPP_
+
5 #define MSCCLPP_PACKET_DEVICE_HPP_
+
+
+
+
+
+
+
12 #if defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
15 #endif // defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
+
+
+
+
+
+
+
+
+
+
29 #if defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
+
+
34 MSCCLPP_DEVICE_INLINE
LL16Packet (uint2 val, uint32_t flag) {
+
+
+
+
+
+
+
45 MSCCLPP_DEVICE_INLINE
void write(uint32_t val1, uint32_t val2, uint32_t flag) {
+
46 #if defined(MSCCLPP_DEVICE_CUDA)
+
47 asm volatile (
"st.volatile.global.v4.u32 [%0], {%1,%2,%3,%4};" ::
"l" (&raw_),
"r" (val1),
"r" (flag),
"r" (val2),
+
+
49 #else // !defined(MSCCLPP_DEVICE_CUDA)
+
50 uint4 reg = make_uint4(val1, flag, val2, flag);
+
51 ulonglong2* p =
reinterpret_cast< ulonglong2*
> (®);
+
52 atomicStore(&(raw_.x), p->x, memoryOrderRelaxed);
+
53 atomicStore(&(raw_.y), p->y, memoryOrderRelaxed);
+
+
+
+
60 MSCCLPP_DEVICE_INLINE
void write(uint64_t val, uint32_t flag) { write((uint32_t)val, (uint32_t)(val >> 32), flag); }
+
+
65 MSCCLPP_DEVICE_INLINE
void write(uint2 val, uint32_t flag) { write(val.x, val.y, flag); }
+
+
71 MSCCLPP_DEVICE_INLINE
bool readOnce(uint32_t flag, uint2& data)
const {
+
72 #if defined(MSCCLPP_DEVICE_CUDA)
+
+
74 asm volatile (
"ld.volatile.global.v4.u32 {%0,%1,%2,%3}, [%4];"
+
75 :
"=r" (data.x),
"=r" (
flag1 ),
"=r" (data.y),
"=r" (
flag2 )
+
+
+
78 #else // !defined(MSCCLPP_DEVICE_CUDA)
+
+
80 reg.x = atomicLoad(&(raw_.x), memoryOrderRelaxed);
+
81 reg.y = atomicLoad(&(raw_.y), memoryOrderRelaxed);
+
82 uint4* ptr =
reinterpret_cast< uint4*
> (®);
+
+
+
85 return (ptr->y != flag) || (ptr->w != flag);
+
+
+
+
93 MSCCLPP_DEVICE_INLINE uint2 read(uint32_t flag, int64_t maxSpinCount = 100000000)
const {
+
+
95 POLL_MAYBE_JAILBREAK(readOnce(flag, data), maxSpinCount);
+
+
+
+
100 MSCCLPP_DEVICE_INLINE
void clear() { raw_ = make_ulonglong2(0, 0); }
+
101 #endif // defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
+
+
+
+
+
+
+
+
+
113 #if defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
+
117 MSCCLPP_DEVICE_INLINE
LL8Packet (uint32_t val, uint32_t
flag ) {
+
+
+
+
+
122 MSCCLPP_DEVICE_INLINE
void write(uint32_t val, uint32_t
flag ) {
+
123 #if defined(MSCCLPP_DEVICE_CUDA)
+
124 asm volatile (
"st.volatile.global.v2.u32 [%0], {%1,%2};" ::
"l" (&
raw_ ),
"r" (val),
"r" (
flag ));
+
125 #else // !defined(MSCCLPP_DEVICE_CUDA)
+
126 uint2 reg = make_uint2(val,
flag );
+
127 uint64_t* p =
reinterpret_cast< uint64_t*
> (®);
+
128 atomicStore(&(
raw_ ), *p, memoryOrderRelaxed);
+
+
+
+
132 MSCCLPP_DEVICE_INLINE
bool readOnce(uint32_t
flag , uint32_t&
data )
const {
+
133 #if defined(MSCCLPP_DEVICE_CUDA)
+
+
135 asm volatile (
"ld.volatile.global.v2.u32 {%0,%1}, [%2];" :
"=r" (
data ),
"=r" (f) :
"l" (&
raw_ ));
+
+
137 #else // !defined(MSCCLPP_DEVICE_CUDA)
+
+
139 reg = atomicLoad(&(
raw_ ), memoryOrderRelaxed);
+
140 uint2* ptr =
reinterpret_cast< uint2*
> (®);
+
+
142 return (ptr->y !=
flag );
+
+
+
+
146 MSCCLPP_DEVICE_INLINE uint32_t read(uint32_t
flag , int64_t maxSpinCount = 1000000)
const {
+
+
148 POLL_MAYBE_JAILBREAK(readOnce(
flag ,
data ), maxSpinCount);
+
+
+
+
153 MSCCLPP_DEVICE_INLINE
void clear() {
raw_ = 0; }
+
154 #endif // defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
+
+
159 #if defined(MSCCLPP_DEVICE_COMPILE)
+
160 MSCCLPP_DEVICE_INLINE
void putLL16Packets(
void * targetPtr, uint64_t targetOffset,
const void * originPtr,
+
172 uint64_t originOffset, uint64_t originBytes, uint32_t threadId,
+
173 uint32_t numThreads, uint32_t flag) {
+
+
175 const uint32_t* originBase = (
const uint32_t*)((
const char *)originPtr + originOffset);
+
+
177 size_t nElem = originBytes /
sizeof (uint64_t);
+
178 for (
size_t i = threadId; i < nElem; i += numThreads) {
+
+
180 pkt->write(originBase[2 * i], originBase[2 * i + 1], flag);
+
+
+
+
195 MSCCLPP_DEVICE_INLINE
void getLL16Packets(
const void * targetPtr, uint64_t targetOffset,
void * originPtr,
+
196 uint64_t originOffset, uint64_t originBytes, uint32_t threadId,
+
197 uint32_t numThreads, uint32_t flag) {
+
+
199 const LL16Packet* targetBase = (
const LL16Packet*)((
const char *)targetPtr + targetOffset);
+
200 uint2* originBase = (uint2*)((
char *)originPtr + originOffset);
+
201 size_t nElem = originBytes /
sizeof (uint2);
+
202 for (
size_t i = threadId; i < nElem; i += numThreads) {
+
203 const LL16Packet* pkt = &targetBase[i];
+
204 originBase[i] = pkt->read(flag);
+
+
+
+
219 MSCCLPP_DEVICE_INLINE
void putLL8Packets(
void * targetPtr, uint64_t targetOffset,
const void * originPtr,
+
220 uint64_t originOffset, uint64_t originBytes, uint32_t threadId,
+
221 uint32_t numThreads, uint32_t flag) {
+
+
223 const uint32_t* originBase = (
const uint32_t*)((
const char *)originPtr + originOffset);
+
224 LL8Packet* targetBase = (LL8Packet*)((
char *)targetPtr + targetOffset);
+
225 size_t nElem = originBytes /
sizeof (uint32_t);
+
226 for (
size_t i = threadId; i < nElem; i += numThreads) {
+
227 LL8Packet* pkt = &targetBase[i];
+
228 pkt->write(originBase[i], flag);
+
+
+
+
243 MSCCLPP_DEVICE_INLINE
void getLL8Packets(
const void * targetPtr, uint64_t targetOffset,
void * originPtr,
+
244 uint64_t originOffset, uint64_t originBytes, uint32_t threadId,
+
245 uint32_t numThreads, uint32_t flag) {
+
+
247 const LL8Packet* targetBase = (
const LL8Packet*)((
const char *)targetPtr + targetOffset);
+
248 uint32_t* originBase = (uint32_t*)((
char *)originPtr + originOffset);
+
249 size_t nElem = originBytes /
sizeof (uint32_t);
+
250 for (
size_t i = threadId; i < nElem; i += numThreads) {
+
251 const LL8Packet* pkt = &targetBase[i];
+
252 originBase[i] = pkt->read(flag);
+
+
+
+
268 template <
typename PacketType = LL16Packet>
+
269 MSCCLPP_DEVICE_INLINE
void putPackets(
void * targetPtr, uint64_t targetOffset,
const void * originPtr,
+
270 uint64_t originOffset, uint64_t originBytes, uint32_t threadId,
+
271 uint32_t numThreads, uint32_t flag) {
+
272 if constexpr (std::is_same<PacketType, LL16Packet>::value) {
+
273 putLL16Packets(targetPtr, targetOffset, originPtr, originOffset, originBytes, threadId, numThreads, flag);
+
274 }
else if constexpr (std::is_same<PacketType, LL8Packet>::value) {
+
275 putLL8Packets(targetPtr, targetOffset, originPtr, originOffset, originBytes, threadId, numThreads, flag);
+
+
277 static_assert(std::is_same<PacketType, LL16Packet>::value || std::is_same<PacketType, LL8Packet>::value,
+
278 "Unsupported packet type" );
+
+
+
+
294 template <
typename PacketType = LL16Packet>
+
295 MSCCLPP_DEVICE_INLINE
void getPackets(
const void * targetPtr, uint64_t targetOffset,
void * originPtr,
+
296 uint64_t originOffset, uint64_t originBytes, uint32_t threadId,
+
297 uint32_t numThreads, uint32_t flag) {
+
298 if constexpr (std::is_same<PacketType, LL16Packet>::value) {
+
299 getLL16Packets(targetPtr, targetOffset, originPtr, originOffset, originBytes, threadId, numThreads, flag);
+
300 }
else if constexpr (std::is_same<PacketType, LL8Packet>::value) {
+
301 getLL8Packets(targetPtr, targetOffset, originPtr, originOffset, originBytes, threadId, numThreads, flag);
+
+
303 static_assert(std::is_same<PacketType, LL16Packet>::value || std::is_same<PacketType, LL8Packet>::value,
+
304 "Unsupported packet type" );
+
+
+
307 #endif // defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
+
311 #endif // MSCCLPP_PACKET_DEVICE_HPP_
+
uint32_t data2
Definition: packet_device.hpp:24
uint32_t flag
Definition: packet_device.hpp:108
uint32_t data1
Definition: packet_device.hpp:22
uint32_t Payload
Definition: packet_device.hpp:112
uint64_t raw_
Definition: packet_device.hpp:110
uint32_t flag1
Definition: packet_device.hpp:23
Definition: packet_device.hpp:104
uint32_t data
Definition: packet_device.hpp:107
uint32_t flag2
Definition: packet_device.hpp:25
uint2 Payload
Definition: packet_device.hpp:27
LL (low latency) protocol packet.
Definition: packet_device.hpp:19
Definition: atomic_device.hpp:13
MSCCL++: poll_device.hpp File Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/poll__device_8hpp__dep__incl.md5 b/docs/doxygen/html/poll__device_8hpp__dep__incl.md5
new file mode 100644
index 00000000..9cdc6dbd
--- /dev/null
+++ b/docs/doxygen/html/poll__device_8hpp__dep__incl.md5
@@ -0,0 +1 @@
+86197ff363616f502a6db5b6927eb9c4
\ No newline at end of file
diff --git a/docs/doxygen/html/poll__device_8hpp__dep__incl.png b/docs/doxygen/html/poll__device_8hpp__dep__incl.png
new file mode 100644
index 00000000..657282a8
Binary files /dev/null and b/docs/doxygen/html/poll__device_8hpp__dep__incl.png differ
diff --git a/docs/doxygen/html/poll__device_8hpp__incl.map b/docs/doxygen/html/poll__device_8hpp__incl.map
new file mode 100644
index 00000000..4d5021c4
--- /dev/null
+++ b/docs/doxygen/html/poll__device_8hpp__incl.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/poll__device_8hpp__incl.md5 b/docs/doxygen/html/poll__device_8hpp__incl.md5
new file mode 100644
index 00000000..0b519b8a
--- /dev/null
+++ b/docs/doxygen/html/poll__device_8hpp__incl.md5
@@ -0,0 +1 @@
+f6446d107f511b71ce838a036008343f
\ No newline at end of file
diff --git a/docs/doxygen/html/poll__device_8hpp__incl.png b/docs/doxygen/html/poll__device_8hpp__incl.png
new file mode 100644
index 00000000..6164c7e8
Binary files /dev/null and b/docs/doxygen/html/poll__device_8hpp__incl.png differ
diff --git a/docs/doxygen/html/poll__device_8hpp_source.html b/docs/doxygen/html/poll__device_8hpp_source.html
new file mode 100644
index 00000000..aa4ad501
--- /dev/null
+++ b/docs/doxygen/html/poll__device_8hpp_source.html
@@ -0,0 +1,137 @@
+
+
+
+MSCCL++: poll_device.hpp Source File
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_POLL_DEVICE_HPP_
+
5 #define MSCCLPP_POLL_DEVICE_HPP_
+
+
+
+
9 #if defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
+
+
14 #define __assert_fail(__assertion, __file, __line, __function) ;
+
15 #else // !defined(NDEBUG)
+
16 #if defined(MSCCLPP_DEVICE_HIP)
+
17 extern "C" __device__
void __assert_fail(
const char *__assertion,
const char *__file,
unsigned int __line,
+
18 const char *__function);
+
19 #else // !defined(MSCCLPP_DEVICE_HIP)
+
20 extern "C" __host__ __device__
void __assert_fail(
const char *__assertion,
const char *__file,
unsigned int __line,
+
21 const char *__function) __THROW;
+
22 #endif // !defined(MSCCLPP_DEVICE_HIP)
+
+
+
+
26 #define POLL_MAYBE_JAILBREAK(__cond, __max_spin_cnt) \
+
+
28 int64_t __spin_cnt = 0; \
+
+
30 if (__max_spin_cnt >= 0 && __spin_cnt++ == __max_spin_cnt) { \
+
31 __assert_fail(#__cond, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
+
+
+
+
+
+
+
38 #define OR_POLL_MAYBE_JAILBREAK(__cond1, __cond2, __max_spin_cnt) \
+
+
40 int64_t __spin_cnt = 0; \
+
+
+
+
44 } else if (!(__cond2)) { \
+
+
+
47 if (__max_spin_cnt >= 0 && __spin_cnt++ == __max_spin_cnt) { \
+
48 __assert_fail(#__cond1 #__cond2, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
+
+
+
+
+
53 #endif // defined(MSCCLPP_DEVICE_COMPILE)
+
+
55 #endif // MSCCLPP_POLL_DEVICE_HPP_
+
MSCCL++: proxy.hpp File Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <functional>
+
#include <memory>
+
#include "fifo.hpp "
+
+
Go to the source code of this file.
+
+
+
diff --git a/docs/doxygen/html/proxy_8hpp__dep__incl.md5 b/docs/doxygen/html/proxy_8hpp__dep__incl.md5
new file mode 100644
index 00000000..1023cde3
--- /dev/null
+++ b/docs/doxygen/html/proxy_8hpp__dep__incl.md5
@@ -0,0 +1 @@
+ccdf15f0b56c0d6e9946a68d43264f9e
\ No newline at end of file
diff --git a/docs/doxygen/html/proxy_8hpp__dep__incl.png b/docs/doxygen/html/proxy_8hpp__dep__incl.png
new file mode 100644
index 00000000..67017dff
Binary files /dev/null and b/docs/doxygen/html/proxy_8hpp__dep__incl.png differ
diff --git a/docs/doxygen/html/proxy_8hpp__incl.map b/docs/doxygen/html/proxy_8hpp__incl.map
new file mode 100644
index 00000000..75cc9b57
--- /dev/null
+++ b/docs/doxygen/html/proxy_8hpp__incl.map
@@ -0,0 +1,9 @@
+
+
diff --git a/docs/doxygen/html/proxy_8hpp__incl.md5 b/docs/doxygen/html/proxy_8hpp__incl.md5
new file mode 100644
index 00000000..6d2570f8
--- /dev/null
+++ b/docs/doxygen/html/proxy_8hpp__incl.md5
@@ -0,0 +1 @@
+5c1e4ee025fd6e603fbb54f44e65cfb2
\ No newline at end of file
diff --git a/docs/doxygen/html/proxy_8hpp__incl.png b/docs/doxygen/html/proxy_8hpp__incl.png
new file mode 100644
index 00000000..ce20d63b
Binary files /dev/null and b/docs/doxygen/html/proxy_8hpp__incl.png differ
diff --git a/docs/doxygen/html/proxy_8hpp_source.html b/docs/doxygen/html/proxy_8hpp_source.html
new file mode 100644
index 00000000..47175ff3
--- /dev/null
+++ b/docs/doxygen/html/proxy_8hpp_source.html
@@ -0,0 +1,138 @@
+
+
+
+MSCCL++: proxy.hpp Source File
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_PROXY_HPP_
+
5 #define MSCCLPP_PROXY_HPP_
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
39 std::unique_ptr<Impl> pimpl;
+
+
+
+
+
44 #endif // MSCCLPP_PROXY_HPP_
+
Definition: fifo_device.hpp:24
std::function< ProxyHandlerResult(ProxyTrigger)> ProxyHandler
Definition: proxy.hpp:21
@ FlushFifoTailAndContinue
Proxy(ProxyHandler handler, std::function< void()> threadInit, size_t fifoSize=DEFAULT_FIFO_SIZE)
constexpr size_t DEFAULT_FIFO_SIZE
Definition: fifo.hpp:15
A class representing a host proxy FIFO that can consume work elements pushed by device threads.
Definition: fifo.hpp:18
Definition: atomic_device.hpp:13
ProxyHandlerResult
Definition: proxy.hpp:14
MSCCL++: proxy_channel.hpp File Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the source code of this file.
+
+
+
diff --git a/docs/doxygen/html/proxy__channel_8hpp__incl.md5 b/docs/doxygen/html/proxy__channel_8hpp__incl.md5
new file mode 100644
index 00000000..3bde9865
--- /dev/null
+++ b/docs/doxygen/html/proxy__channel_8hpp__incl.md5
@@ -0,0 +1 @@
+006a2d1409dc652c584e4e0fccd7e2f9
\ No newline at end of file
diff --git a/docs/doxygen/html/proxy__channel_8hpp__incl.png b/docs/doxygen/html/proxy__channel_8hpp__incl.png
new file mode 100644
index 00000000..352ee178
Binary files /dev/null and b/docs/doxygen/html/proxy__channel_8hpp__incl.png differ
diff --git a/docs/doxygen/html/proxy__channel_8hpp_source.html b/docs/doxygen/html/proxy__channel_8hpp_source.html
new file mode 100644
index 00000000..3d8a9f0f
--- /dev/null
+++ b/docs/doxygen/html/proxy__channel_8hpp_source.html
@@ -0,0 +1,217 @@
+
+
+
+MSCCL++: proxy_channel.hpp Source File
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_PROXY_CHANNEL_HPP_
+
5 #define MSCCLPP_PROXY_CHANNEL_HPP_
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
63 std::vector<std::shared_ptr<Host2DeviceSemaphore>> semaphores_;
+
64 std::vector<RegisteredMemory> memories_;
+
65 std::shared_ptr<Proxy> proxy_;
+
+
+
+
+
+
+
+
+
+
+
+
78 std::shared_ptr<Host2DeviceSemaphore> semaphore_;
+
+
80 std::shared_ptr<Proxy> proxy_;
+
+
+
+
+
85 ProxyChannel (
SemaphoreId semaphoreId, std::shared_ptr<Host2DeviceSemaphore> semaphore, std::shared_ptr<Proxy> proxy);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
140 #endif // MSCCLPP_PROXY_CHANNEL_HPP_
+
DeviceHandle deviceHandle() const
SemaphoreId buildAndAddSemaphore(Communicator &communicator, std::shared_ptr< Connection > connection)
SemaphoreId addSemaphore(std::shared_ptr< Host2DeviceSemaphore > semaphore)
void startProxy()
Start the proxy service.
Definition: fifo_device.hpp:24
MemoryId addMemory(RegisteredMemory memory)
SimpleProxyChannel()=default
Default constructor.
Simple proxy channel with a single destination and source memory region.
Definition: proxy_channel.hpp:102
SimpleProxyChannel(ProxyChannel proxyChan)
Definition: proxy_channel.hpp:120
BaseProxyService()=default
DeviceHandle deviceHandle() const
Proxy channel.
Definition: proxy_channel.hpp:74
Base class for proxy services. Proxy services are used to proxy data between devices.
Definition: proxy_channel.hpp:17
uint32_t SemaphoreId
Definition: proxy_channel_device.hpp:12
Definition: proxy_channel_device.hpp:178
void stopProxy()
Stop the proxy service.
ProxyService(size_t fifoSize=DEFAULT_FIFO_SIZE)
Constructor.
SimpleProxyChannel & operator=(SimpleProxyChannel &other)=default
Assignment operator.
ProxyChannel proxyChannel(SemaphoreId id)
virtual void stopProxy()=0
virtual void startProxy()=0
virtual ~BaseProxyService()=default
Proxy service implementation.
Definition: proxy_channel.hpp:26
Represents a block of memory that has been registered to a Context.
Definition: core.hpp:327
constexpr size_t DEFAULT_FIFO_SIZE
Definition: fifo.hpp:15
std::shared_ptr< Host2DeviceSemaphore > semaphore(SemaphoreId id) const
ProxyChannel & operator=(ProxyChannel &other)=default
Definition: proxy_channel_device.hpp:86
uint32_t MemoryId
Definition: proxy_channel_device.hpp:16
Definition: atomic_device.hpp:13
ProxyHandlerResult
Definition: proxy.hpp:14
MSCCL++: proxy_channel_device.hpp File Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the source code of this file.
+
+
+
+
◆
+
+
+
+
+
+ #define MSCCLPP_BITS_CONNID 10
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define MSCCLPP_BITS_FIFO_RESERVED 1
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define MSCCLPP_BITS_OFFSET 32
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define MSCCLPP_BITS_REGMEM_HANDLE 9
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define MSCCLPP_BITS_SIZE 32
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define MSCCLPP_BITS_TYPE 3
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/proxy__channel__device_8hpp__dep__incl.md5 b/docs/doxygen/html/proxy__channel__device_8hpp__dep__incl.md5
new file mode 100644
index 00000000..aafe5ed2
--- /dev/null
+++ b/docs/doxygen/html/proxy__channel__device_8hpp__dep__incl.md5
@@ -0,0 +1 @@
+88f5dd4f6c201b45690ded2881448772
\ No newline at end of file
diff --git a/docs/doxygen/html/proxy__channel__device_8hpp__dep__incl.png b/docs/doxygen/html/proxy__channel__device_8hpp__dep__incl.png
new file mode 100644
index 00000000..eb189b55
Binary files /dev/null and b/docs/doxygen/html/proxy__channel__device_8hpp__dep__incl.png differ
diff --git a/docs/doxygen/html/proxy__channel__device_8hpp__incl.map b/docs/doxygen/html/proxy__channel__device_8hpp__incl.map
new file mode 100644
index 00000000..f6234549
--- /dev/null
+++ b/docs/doxygen/html/proxy__channel__device_8hpp__incl.map
@@ -0,0 +1,7 @@
+
+
diff --git a/docs/doxygen/html/proxy__channel__device_8hpp__incl.md5 b/docs/doxygen/html/proxy__channel__device_8hpp__incl.md5
new file mode 100644
index 00000000..d4a97fba
--- /dev/null
+++ b/docs/doxygen/html/proxy__channel__device_8hpp__incl.md5
@@ -0,0 +1 @@
+16391707838c71e353cf3f5409462ac0
\ No newline at end of file
diff --git a/docs/doxygen/html/proxy__channel__device_8hpp__incl.png b/docs/doxygen/html/proxy__channel__device_8hpp__incl.png
new file mode 100644
index 00000000..11cdae14
Binary files /dev/null and b/docs/doxygen/html/proxy__channel__device_8hpp__incl.png differ
diff --git a/docs/doxygen/html/proxy__channel__device_8hpp_source.html b/docs/doxygen/html/proxy__channel__device_8hpp_source.html
new file mode 100644
index 00000000..fe3748d2
--- /dev/null
+++ b/docs/doxygen/html/proxy__channel__device_8hpp_source.html
@@ -0,0 +1,284 @@
+
+
+
+MSCCL++: proxy_channel_device.hpp Source File
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_PROXY_CHANNEL_DEVICE_HPP_
+
5 #define MSCCLPP_PROXY_CHANNEL_DEVICE_HPP_
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
23 #define MSCCLPP_BITS_SIZE 32
+
24 #define MSCCLPP_BITS_OFFSET 32
+
25 #define MSCCLPP_BITS_REGMEM_HANDLE 9
+
26 #define MSCCLPP_BITS_TYPE 3
+
27 #define MSCCLPP_BITS_CONNID 10
+
28 #define MSCCLPP_BITS_FIFO_RESERVED 1
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
50 #if defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
55 MSCCLPP_DEVICE_INLINE ChannelTrigger(ProxyTrigger
value ) :
value (
value ) {}
+
+
+
66 uint64_t
srcOffset , uint64_t bytes,
int semaphoreId) {
+
+
+
+
+
+
+
+
+
+
+
77 (dst & maskDstMemoryId))
+
+
79 (src & maskSrcMemoryId))
+
+
+
+
83 #endif // defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
+
+
+
+
+
+
+
+
+
95 #if defined(MSCCLPP_DEVICE_COMPILE)
+
96 MSCCLPP_DEVICE_INLINE
void put(
MemoryId dst, uint64_t dstOffset,
MemoryId src, uint64_t srcOffset, uint64_t size) {
+
+
+
+
111 MSCCLPP_DEVICE_INLINE
void put(
MemoryId dst,
MemoryId src, uint64_t offset, uint64_t size) {
+
112 put(dst, offset, src, offset, size);
+
+
+
+
+
124 MSCCLPP_DEVICE_INLINE
void putWithSignal(
MemoryId dst, uint64_t dstOffset,
MemoryId src, uint64_t srcOffset,
+
+
+
+
+
134 MSCCLPP_DEVICE_INLINE
void putWithSignal(
MemoryId dst,
MemoryId src, uint64_t offset, uint64_t size) {
+
135 putWithSignal(dst, offset, src, offset, size);
+
+
+
144 MSCCLPP_DEVICE_INLINE
void putWithSignalAndFlush(
MemoryId dst, uint64_t dstOffset,
MemoryId src, uint64_t srcOffset,
+
+
146 uint64_t curFifoHead =
fifo_ .push(
+
+
+
149 fifo_ .sync(curFifoHead);
+
+
+
157 MSCCLPP_DEVICE_INLINE
void putWithSignalAndFlush(
MemoryId dst,
MemoryId src, uint64_t offset, uint64_t size) {
+
158 putWithSignalAndFlush(dst, offset, src, offset, size);
+
+
+
162 MSCCLPP_DEVICE_INLINE
void flush() {
+
+
164 fifo_ .sync(curFifoHead);
+
+
+
169 MSCCLPP_DEVICE_INLINE
bool poll() {
return semaphore_ .poll(); }
+
+
173 MSCCLPP_DEVICE_INLINE
void wait(int64_t maxSpinCount = 10000000) {
semaphore_ .wait(maxSpinCount); }
+
+
175 #endif // defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
+
+
+
+
+
183 #if defined(MSCCLPP_DEVICE_COMPILE)
+
184 MSCCLPP_DEVICE_INLINE
void put(uint64_t dstOffset, uint64_t srcOffset, uint64_t size) {
+
+
+
+
195 MSCCLPP_DEVICE_INLINE
void put(uint64_t offset, uint64_t size) { put(offset, offset, size); }
+
+
198 MSCCLPP_DEVICE_INLINE
void signal() {
proxyChan_ .signal(); }
+
+
204 MSCCLPP_DEVICE_INLINE
void putWithSignal(uint64_t dstOffset, uint64_t srcOffset, uint64_t size) {
+
+
+
+
211 MSCCLPP_DEVICE_INLINE
void putWithSignal(uint64_t offset, uint64_t size) { putWithSignal(offset, offset, size); }
+
+
217 MSCCLPP_DEVICE_INLINE
void putWithSignalAndFlush(uint64_t dstOffset, uint64_t srcOffset, uint64_t size) {
+
+
+
+
224 MSCCLPP_DEVICE_INLINE
void putWithSignalAndFlush(uint64_t offset, uint64_t size) {
+
225 putWithSignalAndFlush(offset, offset, size);
+
+
+
229 MSCCLPP_DEVICE_INLINE
void flush() {
proxyChan_ .flush(); }
+
+
233 MSCCLPP_DEVICE_INLINE
bool poll() {
return proxyChan_ .poll(); }
+
+
237 MSCCLPP_DEVICE_INLINE
void wait(int64_t maxSpinCount = 10000000) {
proxyChan_ .wait(maxSpinCount); }
+
238 #endif // defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
+
+
243 #endif // MSCCLPP_PROXY_CHANNEL_DEVICE_HPP_
+
uint64_t fst
Definition: fifo_device.hpp:25
ProxyTrigger value
Definition: proxy_channel_device.hpp:32
Device-side handle for Host2DeviceSemaphore.
Definition: semaphore_device.hpp:17
uint64_t srcOffset
Definition: proxy_channel_device.hpp:37
Definition: fifo_device.hpp:24
uint64_t dstMemoryId
Definition: proxy_channel_device.hpp:42
uint64_t dstOffset
Definition: proxy_channel_device.hpp:40
const TriggerType TriggerData
Definition: proxy_channel_device.hpp:19
const TriggerType TriggerFlag
Definition: proxy_channel_device.hpp:20
Definition: fifo_device.hpp:41
#define MSCCLPP_BITS_CONNID
Definition: proxy_channel_device.hpp:27
#define MSCCLPP_BITS_TYPE
Definition: proxy_channel_device.hpp:26
MemoryId src_
Definition: proxy_channel_device.hpp:181
Host2DeviceSemaphoreDeviceHandle semaphore_
Definition: proxy_channel_device.hpp:89
uint64_t snd
Definition: fifo_device.hpp:25
#define MSCCLPP_BITS_SIZE
Definition: proxy_channel_device.hpp:23
SemaphoreId semaphoreId_
Definition: proxy_channel_device.hpp:87
#define MSCCLPP_BITS_OFFSET
Definition: proxy_channel_device.hpp:24
const TriggerType TriggerSync
Definition: proxy_channel_device.hpp:21
uint64_t chanId
Definition: proxy_channel_device.hpp:44
ProxyChannelDeviceHandle proxyChan_
Definition: proxy_channel_device.hpp:179
#define MSCCLPP_BITS_REGMEM_HANDLE
Definition: proxy_channel_device.hpp:25
MemoryId dst_
Definition: proxy_channel_device.hpp:180
#define MSCCLPP_BITS_FIFO_RESERVED
Definition: proxy_channel_device.hpp:28
uint64_t reserved
Definition: proxy_channel_device.hpp:47
uint64_t type
Definition: proxy_channel_device.hpp:43
Basic structure of each work element in the FIFO.
Definition: proxy_channel_device.hpp:31
uint32_t SemaphoreId
Definition: proxy_channel_device.hpp:12
Definition: proxy_channel_device.hpp:178
FifoDeviceHandle fifo_
Definition: proxy_channel_device.hpp:93
struct mscclpp::ChannelTrigger::@5 fields
uint64_t srcMemoryId
Definition: proxy_channel_device.hpp:41
Definition: proxy_channel_device.hpp:86
uint64_t size
Definition: proxy_channel_device.hpp:36
uint32_t MemoryId
Definition: proxy_channel_device.hpp:16
Definition: atomic_device.hpp:13
uint64_t TriggerType
Definition: proxy_channel_device.hpp:18
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
do a search
+ {
+ this.Search();
+ }
+ }
+
+ this.OnSearchSelectKey = function(evt)
+ {
+ var e = (evt) ? evt : window.event; // for IE
+ if (e.keyCode==40 && this.searchIndex0) // Up
+ {
+ this.searchIndex--;
+ this.OnSelectItem(this.searchIndex);
+ }
+ else if (e.keyCode==13 || e.keyCode==27)
+ {
+ this.OnSelectItem(this.searchIndex);
+ this.CloseSelectionWindow();
+ this.DOMSearchField().focus();
+ }
+ return false;
+ }
+
+ // --------- Actions
+
+ // Closes the results window.
+ this.CloseResultsWindow = function()
+ {
+ this.DOMPopupSearchResultsWindow().style.display = 'none';
+ this.DOMSearchClose().style.display = 'none';
+ this.Activate(false);
+ }
+
+ this.CloseSelectionWindow = function()
+ {
+ this.DOMSearchSelectWindow().style.display = 'none';
+ }
+
+ // Performs a search.
+ this.Search = function()
+ {
+ this.keyTimeout = 0;
+
+ // strip leading whitespace
+ var searchValue = this.DOMSearchField().value.replace(/^ +/, "");
+
+ var code = searchValue.toLowerCase().charCodeAt(0);
+ var idxChar = searchValue.substr(0, 1).toLowerCase();
+ if ( 0xD800 <= code && code <= 0xDBFF && searchValue > 1) // surrogate pair
+ {
+ idxChar = searchValue.substr(0, 2);
+ }
+
+ var resultsPage;
+ var resultsPageWithSearch;
+ var hasResultsPage;
+
+ var idx = indexSectionsWithContent[this.searchIndex].indexOf(idxChar);
+ if (idx!=-1)
+ {
+ var hexCode=idx.toString(16);
+ resultsPage = this.resultsPath + '/' + indexSectionNames[this.searchIndex] + '_' + hexCode + '.html';
+ resultsPageWithSearch = resultsPage+'?'+escape(searchValue);
+ hasResultsPage = true;
+ }
+ else // nothing available for this search term
+ {
+ resultsPage = this.resultsPath + '/nomatches.html';
+ resultsPageWithSearch = resultsPage;
+ hasResultsPage = false;
+ }
+
+ window.frames.MSearchResults.location = resultsPageWithSearch;
+ var domPopupSearchResultsWindow = this.DOMPopupSearchResultsWindow();
+
+ if (domPopupSearchResultsWindow.style.display!='block')
+ {
+ var domSearchBox = this.DOMSearchBox();
+ this.DOMSearchClose().style.display = 'inline';
+ if (this.insideFrame)
+ {
+ var domPopupSearchResults = this.DOMPopupSearchResults();
+ domPopupSearchResultsWindow.style.position = 'relative';
+ domPopupSearchResultsWindow.style.display = 'block';
+ var width = document.body.clientWidth - 8; // the -8 is for IE :-(
+ domPopupSearchResultsWindow.style.width = width + 'px';
+ domPopupSearchResults.style.width = width + 'px';
+ }
+ else
+ {
+ var domPopupSearchResults = this.DOMPopupSearchResults();
+ var left = getXPos(domSearchBox) + 150; // domSearchBox.offsetWidth;
+ var top = getYPos(domSearchBox) + 20; // domSearchBox.offsetHeight + 1;
+ domPopupSearchResultsWindow.style.display = 'block';
+ left -= domPopupSearchResults.offsetWidth;
+ domPopupSearchResultsWindow.style.top = top + 'px';
+ domPopupSearchResultsWindow.style.left = left + 'px';
+ }
+ }
+
+ this.lastSearchValue = searchValue;
+ this.lastResultsPage = resultsPage;
+ }
+
+ // -------- Activation Functions
+
+ // Activates or deactivates the search panel, resetting things to
+ // their default values if necessary.
+ this.Activate = function(isActive)
+ {
+ if (isActive || // open it
+ this.DOMPopupSearchResultsWindow().style.display == 'block'
+ )
+ {
+ this.DOMSearchBox().className = 'MSearchBoxActive';
+
+ var searchField = this.DOMSearchField();
+
+ if (searchField.value == this.searchLabel) // clear "Search" term upon entry
+ {
+ searchField.value = '';
+ this.searchActive = true;
+ }
+ }
+ else if (!isActive) // directly remove the panel
+ {
+ this.DOMSearchBox().className = 'MSearchBoxInactive';
+ this.DOMSearchField().value = this.searchLabel;
+ this.searchActive = false;
+ this.lastSearchValue = ''
+ this.lastResultsPage = '';
+ }
+ }
+}
+
+// -----------------------------------------------------------------------
+
+// The class that handles everything on the search results page.
+function SearchResults(name)
+{
+ // The number of matches from the last run of .
+ this.lastMatchCount = 0;
+ this.lastKey = 0;
+ this.repeatOn = false;
+
+ // Toggles the visibility of the passed element ID.
+ this.FindChildElement = function(id)
+ {
+ var parentElement = document.getElementById(id);
+ var element = parentElement.firstChild;
+
+ while (element && element!=parentElement)
+ {
+ if (element.nodeName == 'DIV' && element.className == 'SRChildren')
+ {
+ return element;
+ }
+
+ if (element.nodeName == 'DIV' && element.hasChildNodes())
+ {
+ element = element.firstChild;
+ }
+ else if (element.nextSibling)
+ {
+ element = element.nextSibling;
+ }
+ else
+ {
+ do
+ {
+ element = element.parentNode;
+ }
+ while (element && element!=parentElement && !element.nextSibling);
+
+ if (element && element!=parentElement)
+ {
+ element = element.nextSibling;
+ }
+ }
+ }
+ }
+
+ this.Toggle = function(id)
+ {
+ var element = this.FindChildElement(id);
+ if (element)
+ {
+ if (element.style.display == 'block')
+ {
+ element.style.display = 'none';
+ }
+ else
+ {
+ element.style.display = 'block';
+ }
+ }
+ }
+
+ // Searches for the passed string. If there is no parameter,
+ // it takes it from the URL query.
+ //
+ // Always returns true, since other documents may try to call it
+ // and that may or may not be possible.
+ this.Search = function(search)
+ {
+ if (!search) // get search word from URL
+ {
+ search = window.location.search;
+ search = search.substring(1); // Remove the leading '?'
+ search = unescape(search);
+ }
+
+ search = search.replace(/^ +/, ""); // strip leading spaces
+ search = search.replace(/ +$/, ""); // strip trailing spaces
+ search = search.toLowerCase();
+ search = convertToId(search);
+
+ var resultRows = document.getElementsByTagName("div");
+ var matches = 0;
+
+ var i = 0;
+ while (i < resultRows.length)
+ {
+ var row = resultRows.item(i);
+ if (row.className == "SRResult")
+ {
+ var rowMatchName = row.id.toLowerCase();
+ rowMatchName = rowMatchName.replace(/^sr\d*_/, ''); // strip 'sr123_'
+
+ if (search.length<=rowMatchName.length &&
+ rowMatchName.substr(0, search.length)==search)
+ {
+ row.style.display = 'block';
+ matches++;
+ }
+ else
+ {
+ row.style.display = 'none';
+ }
+ }
+ i++;
+ }
+ document.getElementById("Searching").style.display='none';
+ if (matches == 0) // no results
+ {
+ document.getElementById("NoMatches").style.display='block';
+ }
+ else // at least one result
+ {
+ document.getElementById("NoMatches").style.display='none';
+ }
+ this.lastMatchCount = matches;
+ return true;
+ }
+
+ // return the first item with index index or higher that is visible
+ this.NavNext = function(index)
+ {
+ var focusItem;
+ while (1)
+ {
+ var focusName = 'Item'+index;
+ focusItem = document.getElementById(focusName);
+ if (focusItem && focusItem.parentNode.parentNode.style.display=='block')
+ {
+ break;
+ }
+ else if (!focusItem) // last element
+ {
+ break;
+ }
+ focusItem=null;
+ index++;
+ }
+ return focusItem;
+ }
+
+ this.NavPrev = function(index)
+ {
+ var focusItem;
+ while (1)
+ {
+ var focusName = 'Item'+index;
+ focusItem = document.getElementById(focusName);
+ if (focusItem && focusItem.parentNode.parentNode.style.display=='block')
+ {
+ break;
+ }
+ else if (!focusItem) // last element
+ {
+ break;
+ }
+ focusItem=null;
+ index--;
+ }
+ return focusItem;
+ }
+
+ this.ProcessKeys = function(e)
+ {
+ if (e.type == "keydown")
+ {
+ this.repeatOn = false;
+ this.lastKey = e.keyCode;
+ }
+ else if (e.type == "keypress")
+ {
+ if (!this.repeatOn)
+ {
+ if (this.lastKey) this.repeatOn = true;
+ return false; // ignore first keypress after keydown
+ }
+ }
+ else if (e.type == "keyup")
+ {
+ this.lastKey = 0;
+ this.repeatOn = false;
+ }
+ return this.lastKey!=0;
+ }
+
+ this.Nav = function(evt,itemIndex)
+ {
+ var e = (evt) ? evt : window.event; // for IE
+ if (e.keyCode==13) return true;
+ if (!this.ProcessKeys(e)) return false;
+
+ if (this.lastKey==38) // Up
+ {
+ var newIndex = itemIndex-1;
+ var focusItem = this.NavPrev(newIndex);
+ if (focusItem)
+ {
+ var child = this.FindChildElement(focusItem.parentNode.parentNode.id);
+ if (child && child.style.display == 'block') // children visible
+ {
+ var n=0;
+ var tmpElem;
+ while (1) // search for last child
+ {
+ tmpElem = document.getElementById('Item'+newIndex+'_c'+n);
+ if (tmpElem)
+ {
+ focusItem = tmpElem;
+ }
+ else // found it!
+ {
+ break;
+ }
+ n++;
+ }
+ }
+ }
+ if (focusItem)
+ {
+ focusItem.focus();
+ }
+ else // return focus to search field
+ {
+ parent.document.getElementById("MSearchField").focus();
+ }
+ }
+ else if (this.lastKey==40) // Down
+ {
+ var newIndex = itemIndex+1;
+ var focusItem;
+ var item = document.getElementById('Item'+itemIndex);
+ var elem = this.FindChildElement(item.parentNode.parentNode.id);
+ if (elem && elem.style.display == 'block') // children visible
+ {
+ focusItem = document.getElementById('Item'+itemIndex+'_c0');
+ }
+ if (!focusItem) focusItem = this.NavNext(newIndex);
+ if (focusItem) focusItem.focus();
+ }
+ else if (this.lastKey==39) // Right
+ {
+ var item = document.getElementById('Item'+itemIndex);
+ var elem = this.FindChildElement(item.parentNode.parentNode.id);
+ if (elem) elem.style.display = 'block';
+ }
+ else if (this.lastKey==37) // Left
+ {
+ var item = document.getElementById('Item'+itemIndex);
+ var elem = this.FindChildElement(item.parentNode.parentNode.id);
+ if (elem) elem.style.display = 'none';
+ }
+ else if (this.lastKey==27) // Escape
+ {
+ parent.searchBox.CloseResultsWindow();
+ parent.document.getElementById("MSearchField").focus();
+ }
+ else if (this.lastKey==13) // Enter
+ {
+ return true;
+ }
+ return false;
+ }
+
+ this.NavChild = function(evt,itemIndex,childIndex)
+ {
+ var e = (evt) ? evt : window.event; // for IE
+ if (e.keyCode==13) return true;
+ if (!this.ProcessKeys(e)) return false;
+
+ if (this.lastKey==38) // Up
+ {
+ if (childIndex>0)
+ {
+ var newIndex = childIndex-1;
+ document.getElementById('Item'+itemIndex+'_c'+newIndex).focus();
+ }
+ else // already at first child, jump to parent
+ {
+ document.getElementById('Item'+itemIndex).focus();
+ }
+ }
+ else if (this.lastKey==40) // Down
+ {
+ var newIndex = childIndex+1;
+ var elem = document.getElementById('Item'+itemIndex+'_c'+newIndex);
+ if (!elem) // last child, jump to parent next parent
+ {
+ elem = this.NavNext(itemIndex+1);
+ }
+ if (elem)
+ {
+ elem.focus();
+ }
+ }
+ else if (this.lastKey==27) // Escape
+ {
+ parent.searchBox.CloseResultsWindow();
+ parent.document.getElementById("MSearchField").focus();
+ }
+ else if (this.lastKey==13) // Enter
+ {
+ return true;
+ }
+ return false;
+ }
+}
+
+function setKeyActions(elem,action)
+{
+ elem.setAttribute('onkeydown',action);
+ elem.setAttribute('onkeypress',action);
+ elem.setAttribute('onkeyup',action);
+}
+
+function setClassAttr(elem,attr)
+{
+ elem.setAttribute('class',attr);
+ elem.setAttribute('className',attr);
+}
+
+function createResults()
+{
+ var results = document.getElementById("SRResults");
+ for (var e=0; e
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
MSCCL++: semaphore.hpp File Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <memory>
+
#include "core.hpp "
+
#include "gpu_utils.hpp "
+
#include "semaphore_device.hpp "
+
+
+
+
+
+
+
+
Go to the source code of this file.
+
+
+
diff --git a/docs/doxygen/html/semaphore_8hpp__dep__incl.md5 b/docs/doxygen/html/semaphore_8hpp__dep__incl.md5
new file mode 100644
index 00000000..d51ebdfd
--- /dev/null
+++ b/docs/doxygen/html/semaphore_8hpp__dep__incl.md5
@@ -0,0 +1 @@
+c507d5a1666abfac84841849149b0f21
\ No newline at end of file
diff --git a/docs/doxygen/html/semaphore_8hpp__dep__incl.png b/docs/doxygen/html/semaphore_8hpp__dep__incl.png
new file mode 100644
index 00000000..5a2d63d9
Binary files /dev/null and b/docs/doxygen/html/semaphore_8hpp__dep__incl.png differ
diff --git a/docs/doxygen/html/semaphore_8hpp__incl.map b/docs/doxygen/html/semaphore_8hpp__incl.map
new file mode 100644
index 00000000..1c77a0bc
--- /dev/null
+++ b/docs/doxygen/html/semaphore_8hpp__incl.map
@@ -0,0 +1,20 @@
+
+
diff --git a/docs/doxygen/html/semaphore_8hpp__incl.md5 b/docs/doxygen/html/semaphore_8hpp__incl.md5
new file mode 100644
index 00000000..7b74c883
--- /dev/null
+++ b/docs/doxygen/html/semaphore_8hpp__incl.md5
@@ -0,0 +1 @@
+d24bf30e362af2d885718f7f2e34a7d7
\ No newline at end of file
diff --git a/docs/doxygen/html/semaphore_8hpp__incl.png b/docs/doxygen/html/semaphore_8hpp__incl.png
new file mode 100644
index 00000000..a7c4240e
Binary files /dev/null and b/docs/doxygen/html/semaphore_8hpp__incl.png differ
diff --git a/docs/doxygen/html/semaphore_8hpp_source.html b/docs/doxygen/html/semaphore_8hpp_source.html
new file mode 100644
index 00000000..408cd1da
--- /dev/null
+++ b/docs/doxygen/html/semaphore_8hpp_source.html
@@ -0,0 +1,193 @@
+
+
+
+MSCCL++: semaphore.hpp Source File
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_SEMAPHORE_HPP_
+
5 #define MSCCLPP_SEMAPHORE_HPP_
+
+
+
+
+
+
+
+
+
+
29 template <
template <
typename >
typename InboundDeleter,
template <
typename >
typename OutboundDeleter>
+
+
+
+
+
+
+
+
+
+
+
+
58 BaseSemaphore (std::unique_ptr<uint64_t, InboundDeleter<uint64_t>> localInboundSemaphoreId,
+
59 std::unique_ptr<uint64_t, InboundDeleter<uint64_t>> expectedInboundSemaphoreId,
+
60 std::unique_ptr<uint64_t, OutboundDeleter<uint64_t>> outboundSemaphoreId)
+
+
+
+
+
+
+
+
69 std::shared_ptr<Connection> connection_;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
113 void wait (int64_t maxSpinCount = 10000000);
+
+
+
116 std::shared_ptr<Connection> connection_;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
141 #endif // MSCCLPP_SEMAPHORE_HPP_
+
bool isRemoteInboundSemaphoreIdSet_
Definition: semaphore.hpp:136
std::unique_ptr< uint64_t, InboundDeleter< uint64_t > > expectedInboundSemaphore_
Definition: semaphore.hpp:44
A semaphore for sending signals from the local device to a peer device via SM.
Definition: semaphore.hpp:120
Device-side handle for Host2DeviceSemaphore.
Definition: semaphore_device.hpp:17
std::shared_ptr< Connection > connection()
A semaphore for sending signals from the host to the device.
Definition: semaphore.hpp:67
Host2DeviceSemaphore(Communicator &communicator, std::shared_ptr< Connection > connection)
std::unique_ptr< uint64_t, OutboundDeleter< uint64_t > > outboundSemaphore_
Definition: semaphore.hpp:50
Definition: semaphore.hpp:30
void signal()
Signal the device.
A non-blocking future that can be used to check if a value is ready and retrieve it.
Definition: core.hpp:562
void signal()
Signal the remote host.
BaseSemaphore(std::unique_ptr< uint64_t, InboundDeleter< uint64_t >> localInboundSemaphoreId, std::unique_ptr< uint64_t, InboundDeleter< uint64_t >> expectedInboundSemaphoreId, std::unique_ptr< uint64_t, OutboundDeleter< uint64_t >> outboundSemaphoreId)
Definition: semaphore.hpp:58
std::unique_ptr< uint64_t, InboundDeleter< uint64_t > > localInboundSemaphore_
Definition: semaphore.hpp:38
SmDevice2DeviceSemaphore()=delete
Constructor.
std::shared_ptr< Connection > connection()
Device-side handle for SmDevice2DeviceSemaphore.
Definition: semaphore_device.hpp:40
void wait(int64_t maxSpinCount=10000000)
Host2HostSemaphore(Communicator &communicator, std::shared_ptr< Connection > connection)
DeviceHandle deviceHandle() const
Returns the device-side handle.
A semaphore for sending signals from the local host to a remote host.
Definition: semaphore.hpp:92
NonblockingFuture< RegisteredMemory > remoteInboundSemaphoreIdsRegMem_
The registered memory for the remote peer's inbound semaphore ID.
Definition: semaphore.hpp:33
DeviceHandle deviceHandle()
Returns the device-side handle.
Definition: atomic_device.hpp:13
MSCCL++: semaphore_device.hpp File Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/semaphore__device_8hpp__dep__incl.md5 b/docs/doxygen/html/semaphore__device_8hpp__dep__incl.md5
new file mode 100644
index 00000000..ab43236e
--- /dev/null
+++ b/docs/doxygen/html/semaphore__device_8hpp__dep__incl.md5
@@ -0,0 +1 @@
+b312a8105c6fa3e71754c60a69175c62
\ No newline at end of file
diff --git a/docs/doxygen/html/semaphore__device_8hpp__dep__incl.png b/docs/doxygen/html/semaphore__device_8hpp__dep__incl.png
new file mode 100644
index 00000000..b9c22ed4
Binary files /dev/null and b/docs/doxygen/html/semaphore__device_8hpp__dep__incl.png differ
diff --git a/docs/doxygen/html/semaphore__device_8hpp__incl.map b/docs/doxygen/html/semaphore__device_8hpp__incl.map
new file mode 100644
index 00000000..fbf25fe2
--- /dev/null
+++ b/docs/doxygen/html/semaphore__device_8hpp__incl.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/semaphore__device_8hpp__incl.md5 b/docs/doxygen/html/semaphore__device_8hpp__incl.md5
new file mode 100644
index 00000000..10ffbc2e
--- /dev/null
+++ b/docs/doxygen/html/semaphore__device_8hpp__incl.md5
@@ -0,0 +1 @@
+e0468e6c82deb22ecf491c0c9defb843
\ No newline at end of file
diff --git a/docs/doxygen/html/semaphore__device_8hpp__incl.png b/docs/doxygen/html/semaphore__device_8hpp__incl.png
new file mode 100644
index 00000000..d62ee03b
Binary files /dev/null and b/docs/doxygen/html/semaphore__device_8hpp__incl.png differ
diff --git a/docs/doxygen/html/semaphore__device_8hpp_source.html b/docs/doxygen/html/semaphore__device_8hpp_source.html
new file mode 100644
index 00000000..253ea8f9
--- /dev/null
+++ b/docs/doxygen/html/semaphore__device_8hpp_source.html
@@ -0,0 +1,174 @@
+
+
+
+MSCCL++: semaphore_device.hpp Source File
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_SEMAPHORE_DEVICE_HPP_
+
5 #define MSCCLPP_SEMAPHORE_DEVICE_HPP_
+
+
+
+
9 #if defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
12 #endif // defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
+
+
18 #if defined(MSCCLPP_DEVICE_COMPILE)
+
19 MSCCLPP_DEVICE_INLINE
bool poll() {
+
22 bool signaled = (atomicLoad(
inboundSemaphoreId , memoryOrderAcquire) > (*expectedInboundSemaphoreId));
+
23 if (signaled) (*expectedInboundSemaphoreId) += 1;
+
+
+
+
28 MSCCLPP_DEVICE_INLINE
void wait(int64_t maxSpinCount = 100000000) {
+
29 (*expectedInboundSemaphoreId) += 1;
+
+
+
+
33 #endif // defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
+
+
+
+
41 #if defined(MSCCLPP_DEVICE_COMPILE)
+
42 MSCCLPP_DEVICE_INLINE
bool poll() {
+
45 bool signaled = (atomicLoad(
inboundSemaphoreId , memoryOrderAcquire) > (*expectedInboundSemaphoreId));
+
46 if (signaled) (*expectedInboundSemaphoreId) += 1;
+
+
+
+
51 MSCCLPP_DEVICE_INLINE
void wait(int64_t maxSpinCount = 100000000) {
+
52 (*expectedInboundSemaphoreId) += 1;
+
+
+
+
+
62 MSCCLPP_DEVICE_INLINE
void signal() {
+
+
+
+
+
+
+
74 MSCCLPP_DEVICE_INLINE
void relaxedSignal() {
+
+
+
+
+
+
+
87 MSCCLPP_DEVICE_INLINE
void signalPacket() {
+
+
+
+
+
+
+
+
97 #endif // defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
+
+
+
+
+
+
+
107 #endif // MSCCLPP_SEMAPHORE_DEVICE_HPP_
+
Device-side handle for Host2DeviceSemaphore.
Definition: semaphore_device.hpp:17
uint64_t * outboundSemaphoreId
Definition: semaphore_device.hpp:100
uint64_t * inboundSemaphoreId
Definition: semaphore_device.hpp:99
uint64_t * expectedInboundSemaphoreId
Definition: semaphore_device.hpp:102
uint64_t * expectedInboundSemaphoreId
Definition: semaphore_device.hpp:36
Device-side handle for SmDevice2DeviceSemaphore.
Definition: semaphore_device.hpp:40
uint64_t * inboundSemaphoreId
Definition: semaphore_device.hpp:35
uint64_t * remoteInboundSemaphoreId
Definition: semaphore_device.hpp:101
Definition: atomic_device.hpp:13
MSCCL++: sm_channel.hpp File Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <type_traits>
+
#include "core.hpp "
+
#include "semaphore.hpp "
+
#include "sm_channel_device.hpp "
+
+
+
+
+
+
+
+
Go to the source code of this file.
+
+
+
diff --git a/docs/doxygen/html/sm__channel_8hpp__incl.md5 b/docs/doxygen/html/sm__channel_8hpp__incl.md5
new file mode 100644
index 00000000..4cdadd60
--- /dev/null
+++ b/docs/doxygen/html/sm__channel_8hpp__incl.md5
@@ -0,0 +1 @@
+eeb64061dc4310fa0269ce7d3743bee5
\ No newline at end of file
diff --git a/docs/doxygen/html/sm__channel_8hpp__incl.png b/docs/doxygen/html/sm__channel_8hpp__incl.png
new file mode 100644
index 00000000..9e23d8d0
Binary files /dev/null and b/docs/doxygen/html/sm__channel_8hpp__incl.png differ
diff --git a/docs/doxygen/html/sm__channel_8hpp_source.html b/docs/doxygen/html/sm__channel_8hpp_source.html
new file mode 100644
index 00000000..05f910f1
--- /dev/null
+++ b/docs/doxygen/html/sm__channel_8hpp_source.html
@@ -0,0 +1,125 @@
+
+
+
+MSCCL++: sm_channel.hpp Source File
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_SM_CHANNEL_HPP_
+
5 #define MSCCLPP_SM_CHANNEL_HPP_
+
+
+
+
+
+
+
+
+
+
+
+
18 std::shared_ptr<SmDevice2DeviceSemaphore> semaphore_;
+
+
+
21 void * getPacketBuffer_;
+
+
+
+
+
+
33 void * getPacketBuffer =
nullptr );
+
+
+
+
+
+
+
+
+
47 #endif // MSCCLPP_SM_CHANNEL_HPP_
+
DeviceHandle deviceHandle() const
Represents a block of memory that has been registered to a Context.
Definition: core.hpp:327
SmChannel()=default
Constructor.
Channel for accessing peer memory directly from SM.
Definition: sm_channel_device.hpp:46
Channel for accessing peer memory directly from SM.
Definition: sm_channel.hpp:16
Definition: atomic_device.hpp:13
MSCCL++: sm_channel_device.hpp File Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/html/sm__channel__device_8hpp__dep__incl.md5 b/docs/doxygen/html/sm__channel__device_8hpp__dep__incl.md5
new file mode 100644
index 00000000..df9a8a7e
--- /dev/null
+++ b/docs/doxygen/html/sm__channel__device_8hpp__dep__incl.md5
@@ -0,0 +1 @@
+50f18631faf5bc352c0c3115a2164055
\ No newline at end of file
diff --git a/docs/doxygen/html/sm__channel__device_8hpp__dep__incl.png b/docs/doxygen/html/sm__channel__device_8hpp__dep__incl.png
new file mode 100644
index 00000000..b25d5d74
Binary files /dev/null and b/docs/doxygen/html/sm__channel__device_8hpp__dep__incl.png differ
diff --git a/docs/doxygen/html/sm__channel__device_8hpp__incl.map b/docs/doxygen/html/sm__channel__device_8hpp__incl.map
new file mode 100644
index 00000000..46393a79
--- /dev/null
+++ b/docs/doxygen/html/sm__channel__device_8hpp__incl.map
@@ -0,0 +1,5 @@
+
+
diff --git a/docs/doxygen/html/sm__channel__device_8hpp__incl.md5 b/docs/doxygen/html/sm__channel__device_8hpp__incl.md5
new file mode 100644
index 00000000..0c7a2d26
--- /dev/null
+++ b/docs/doxygen/html/sm__channel__device_8hpp__incl.md5
@@ -0,0 +1 @@
+3b3562f652f10fcf57e94850f2dbca96
\ No newline at end of file
diff --git a/docs/doxygen/html/sm__channel__device_8hpp__incl.png b/docs/doxygen/html/sm__channel__device_8hpp__incl.png
new file mode 100644
index 00000000..de8babe8
Binary files /dev/null and b/docs/doxygen/html/sm__channel__device_8hpp__incl.png differ
diff --git a/docs/doxygen/html/sm__channel__device_8hpp_source.html b/docs/doxygen/html/sm__channel__device_8hpp_source.html
new file mode 100644
index 00000000..5f2bd746
--- /dev/null
+++ b/docs/doxygen/html/sm__channel__device_8hpp_source.html
@@ -0,0 +1,235 @@
+
+
+
+MSCCL++: sm_channel_device.hpp Source File
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_SM_CHANNEL_DEVICE_HPP_
+
5 #define MSCCLPP_SM_CHANNEL_DEVICE_HPP_
+
+
+
8 #if defined(MSCCLPP_DEVICE_COMPILE)
+
+
10 #endif // defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
+
14 #if defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
+
+
31 MSCCLPP_DEVICE_INLINE
void copy(T* dst, T* src, uint64_t numElems, uint32_t threadId, uint32_t numThreads) {
+
+
33 for (
size_t i = threadId; i < numElems; i += numThreads) {
+
+
+
+
+
+
+
+
+
+
43 #endif // defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
+
+
+
+
+
52 #if defined(MSCCLPP_DEVICE_COMPILE)
+
+
58 MSCCLPP_DEVICE_INLINE T read(uint64_t index) {
+
59 return *(
reinterpret_cast< T*
> (
dst_ ) + index);
+
+
+
+
67 MSCCLPP_DEVICE_INLINE
void write(uint64_t index,
const T& v) {
+
68 *(
reinterpret_cast< T*
> (
dst_ ) + index) = v;
+
+
+
72 template <
typename T,
bool CopyRemainder = true>
+
73 MSCCLPP_DEVICE_INLINE
void copy_helper(
void * dst,
void * src, uint64_t bytes, uint32_t threadId, uint32_t numThreads) {
+
74 int * dstInt =
reinterpret_cast< int *
> (dst);
+
75 int * srcInt =
reinterpret_cast< int *
> (src);
+
76 const uintptr_t dstPtr =
reinterpret_cast< uintptr_t
> (dst);
+
77 const uintptr_t srcPtr =
reinterpret_cast< uintptr_t
> (src);
+
78 const uint64_t numInt = bytes /
sizeof (int);
+
79 T* dstElem =
reinterpret_cast< T*
> ((dstPtr +
sizeof (T) - 1) /
sizeof (T) *
sizeof (T));
+
80 T* srcElem =
reinterpret_cast< T*
> ((srcPtr +
sizeof (T) - 1) /
sizeof (T) *
sizeof (T));
+
81 uint64_t nFirstInt = (
reinterpret_cast< uintptr_t
> (dstElem) - dstPtr) /
sizeof (int);
+
+
+
84 Element::copy<int>(dstInt, srcInt, nFirstInt, threadId, numThreads);
+
+
+
87 constexpr uint64_t nIntPerElem =
sizeof (T) /
sizeof (
int );
+
88 uint64_t nElem = (numInt - nFirstInt) / nIntPerElem;
+
89 Element::copy<T>(dstElem, srcElem, nElem, threadId, numThreads);
+
90 if (CopyRemainder && nIntPerElem > 1) {
+
+
92 uint64_t nLastInt = (numInt - nFirstInt) % nIntPerElem;
+
93 Element::copy<int>(dstInt + nFirstInt + nElem * nIntPerElem, srcInt + nFirstInt + nElem * nIntPerElem, nLastInt,
+
94 threadId, numThreads);
+
+
+
+
111 template <
int Alignment = 16,
bool CopyRemainder = true>
+
112 MSCCLPP_DEVICE_INLINE
void copy(
void * dst,
void * src, uint64_t bytes, uint32_t threadId, uint32_t numThreads) {
+
113 if (Alignment == 4) {
+
114 copy_helper<int, CopyRemainder>(dst, src, bytes, threadId, numThreads);
+
115 }
else if (Alignment == 8) {
+
116 copy_helper<long long, CopyRemainder>(dst, src, bytes, threadId, numThreads);
+
117 }
else if (Alignment == 16) {
+
118 copy_helper<longlong2, CopyRemainder>(dst, src, bytes, threadId, numThreads);
+
+
120 static_assert(Alignment == 4 || Alignment == 8 || Alignment == 16,
"Unsupported alignment" );
+
+
+
+
138 template <
int Alignment = 16,
bool CopyRemainder = true>
+
139 MSCCLPP_DEVICE_INLINE
void put(uint64_t targetOffset, uint64_t originOffset, uint64_t originBytes, uint32_t threadId,
+
140 uint32_t numThreads) {
+
141 copy<Alignment, CopyRemainder>((
char *)
dst_ + targetOffset, (
char *)
src_ + originOffset, originBytes, threadId,
+
+
+
+
159 template <
int Alignment = 16,
bool CopyRemainder = true>
+
160 MSCCLPP_DEVICE_INLINE
void get(uint64_t targetOffset, uint64_t originOffset, uint64_t originBytes, uint32_t threadId,
+
161 uint32_t numThreads) {
+
+
163 copy<Alignment, CopyRemainder>((
char *)
src_ + originOffset, (
char *)
dst_ + targetOffset, originBytes, threadId,
+
+
+
+
180 template <
int Alignment = 16,
bool CopyRemainder = true>
+
181 MSCCLPP_DEVICE_INLINE
void put(uint64_t offset, uint64_t bytes, uint32_t threadId, uint32_t numThreads) {
+
182 put<Alignment, CopyRemainder>(offset, offset, bytes, threadId, numThreads);
+
+
+
198 template <
int Alignment = 16,
bool CopyRemainder = true>
+
199 MSCCLPP_DEVICE_INLINE
void get(uint64_t offset, uint64_t bytes, uint32_t threadId, uint32_t numThreads) {
+
200 get<Alignment, CopyRemainder>(offset, offset, bytes, threadId, numThreads);
+
+
+
216 template <
typename PacketType = LL16Packet>
+
217 MSCCLPP_DEVICE_INLINE
void putPackets(uint64_t targetOffset, uint64_t originOffset, uint64_t originBytes,
+
218 uint32_t threadId, uint32_t numThreads, uint32_t flag) {
+
219 mscclpp::putPackets<PacketType>(
dst_ , targetOffset,
src_ , originOffset, originBytes, threadId, numThreads, flag);
+
+
+
234 template <
typename PacketType = LL16Packet>
+
235 MSCCLPP_DEVICE_INLINE
void getPackets(uint64_t targetOffset, uint64_t originOffset, uint64_t originBytes,
+
236 uint32_t threadId, uint32_t numThreads, uint32_t flag) {
+
237 mscclpp::getPackets<PacketType>(
getPacketBuffer_ , targetOffset,
src_ , originOffset, originBytes, threadId,
+
+
+
+
246 MSCCLPP_DEVICE_INLINE
void signal() {
semaphore_ .signal(); }
+
+
253 MSCCLPP_DEVICE_INLINE
void relaxedSignal() {
semaphore_ .relaxedSignal(); }
+
+
261 MSCCLPP_DEVICE_INLINE
void signalPacket() {
semaphore_ .signalPacket(); }
+
+
264 MSCCLPP_DEVICE_INLINE
void semaphoreIncrement() {
semaphore_ .semaphoreIncrement(); }
+
+
267 MSCCLPP_DEVICE_INLINE uint64_t semaphoreGetLocal()
const {
return semaphore_ .semaphoreGetLocal(); }
+
+
271 MSCCLPP_DEVICE_INLINE
bool poll() {
return semaphore_ .poll(); }
+
+
275 MSCCLPP_DEVICE_INLINE
void wait(int64_t maxSpinCount = 10000000) {
semaphore_ .wait(maxSpinCount); }
+
276 #endif // defined(MSCCLPP_DEVICE_COMPILE)
+
+
+
+
+
281 #endif // MSCCLPP_SM_CHANNEL_DEVICE_HPP_
+
void * dst_
Definition: sm_channel_device.hpp:49
SmDevice2DeviceSemaphoreDeviceHandle semaphore_
Definition: sm_channel_device.hpp:47
void * src_
Definition: sm_channel_device.hpp:48
Device-side handle for SmDevice2DeviceSemaphore.
Definition: semaphore_device.hpp:40
Channel for accessing peer memory directly from SM.
Definition: sm_channel_device.hpp:46
void * getPacketBuffer_
Definition: sm_channel_device.hpp:50
Definition: atomic_device.hpp:13
MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for NpKitEventCollectContext , including all inherited members.
+
MSCCL++: NpKitEventCollectContext Struct Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <npkit_struct.hpp >
+
+
+
+
+
+
◆
+
+
+
+
+
+ NpKitEvent * NpKitEventCollectContext::event_buffer
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint64_t NpKitEventCollectContext::event_buffer_head
+
+
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
+
diff --git a/docs/doxygen/html/structNpKitEventCollectContext__coll__graph.md5 b/docs/doxygen/html/structNpKitEventCollectContext__coll__graph.md5
new file mode 100644
index 00000000..201cae3a
--- /dev/null
+++ b/docs/doxygen/html/structNpKitEventCollectContext__coll__graph.md5
@@ -0,0 +1 @@
+43dffd55a635fb6a164cc9225f282204
\ No newline at end of file
diff --git a/docs/doxygen/html/structNpKitEventCollectContext__coll__graph.png b/docs/doxygen/html/structNpKitEventCollectContext__coll__graph.png
new file mode 100644
index 00000000..f0e0e246
Binary files /dev/null and b/docs/doxygen/html/structNpKitEventCollectContext__coll__graph.png differ
diff --git a/docs/doxygen/html/structmscclpp_1_1AvoidCudaGraphCaptureGuard-members.html b/docs/doxygen/html/structmscclpp_1_1AvoidCudaGraphCaptureGuard-members.html
new file mode 100644
index 00000000..eefc8a9a
--- /dev/null
+++ b/docs/doxygen/html/structmscclpp_1_1AvoidCudaGraphCaptureGuard-members.html
@@ -0,0 +1,87 @@
+
+
+
+MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::AvoidCudaGraphCaptureGuard , including all inherited members.
+
MSCCL++: mscclpp::AvoidCudaGraphCaptureGuard Struct Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <gpu_utils.hpp >
+
+cudaStreamCaptureMode mode_
+
+
A RAII guard that will cudaThreadExchangeStreamCaptureMode to cudaStreamCaptureModeRelaxed on construction and restore the previous mode on destruction. This is helpful when we want to avoid CUDA graph capture.
+
+
+
◆
+
+
+
+
+
+ mscclpp::AvoidCudaGraphCaptureGuard::AvoidCudaGraphCaptureGuard
+ (
+ )
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ mscclpp::AvoidCudaGraphCaptureGuard::~AvoidCudaGraphCaptureGuard
+ (
+ )
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ cudaStreamCaptureMode mscclpp::AvoidCudaGraphCaptureGuard::mode_
+
+
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::CudaDeleter< T > , including all inherited members.
+
MSCCL++: mscclpp::CudaDeleter< T > Struct Template Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <gpu_utils.hpp >
+
+using TPtrOrArray = std::conditional_t< std::is_array_v< T >, T, T * >
+
+
template<class T>
+
+
A deleter that calls cudaFree for use with std::unique_ptr or std::shared_ptr.
Template Parameters
+
+ T Type of each element in the allocated memory.
+
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+
+
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::CudaHostDeleter< T > , including all inherited members.
+
MSCCL++: mscclpp::CudaHostDeleter< T > Struct Template Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <gpu_utils.hpp >
+
+using TPtrOrArray = std::conditional_t< std::is_array_v< T >, T, T * >
+
+
template<class T>
+
+
A deleter that calls cudaFreeHost for use with std::unique_ptr or std::shared_ptr.
Template Parameters
+
+ T Type of each element in the allocated memory.
+
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+
+
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::CudaPhysicalDeleter< T > , including all inherited members.
+
MSCCL++: mscclpp::CudaPhysicalDeleter< T > Struct Template Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <gpu_utils.hpp >
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::CudaStreamWithFlags , including all inherited members.
+
MSCCL++: mscclpp::CudaStreamWithFlags Struct Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A RAII wrapper around cudaStream_t that will call cudaStreamDestroy on destruction.
+ More...
+
+
#include <gpu_utils.hpp >
+
+
+
A RAII wrapper around cudaStream_t that will call cudaStreamDestroy on destruction.
+
+
+
◆
+
+
+
+
+
+ mscclpp::CudaStreamWithFlags::CudaStreamWithFlags
+ (
+ unsigned int
+ flags )
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ mscclpp::CudaStreamWithFlags::~CudaStreamWithFlags
+ (
+ )
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ mscclpp::CudaStreamWithFlags::operator cudaStream_t
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ cudaStream_t mscclpp::CudaStreamWithFlags::stream_
+
+
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::DeviceMulticastPointerDeviceHandle , including all inherited members.
+
MSCCL++: mscclpp::DeviceMulticastPointerDeviceHandle Struct Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Device-side handle for Host2DeviceSemaphore .
+ More...
+
+
#include <nvls_device.hpp >
+
+
+
Device-side handle for Host2DeviceSemaphore .
+
+
+
◆
+
+
+
+
+
+ size_t mscclpp::DeviceMulticastPointerDeviceHandle::bufferSize
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void* mscclpp::DeviceMulticastPointerDeviceHandle::devicePtr
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void* mscclpp::DeviceMulticastPointerDeviceHandle::mcPtr
+
+
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::DeviceSyncer , including all inherited members.
+
MSCCL++: mscclpp::DeviceSyncer Struct Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A device-wide barrier.
+ More...
+
+
#include <concurrency_device.hpp >
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ mscclpp::DeviceSyncer::DeviceSyncer
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ mscclpp::DeviceSyncer::~DeviceSyncer
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::EndpointConfig , including all inherited members.
+
MSCCL++: mscclpp::EndpointConfig Struct Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Used to configure an endpoint.
+ More...
+
+
#include <core.hpp >
+
+
+
Used to configure an endpoint.
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ mscclpp::EndpointConfig::EndpointConfig
+ (
+ )
+
+
+
+
+inline
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ mscclpp::EndpointConfig::EndpointConfig
+ (
+ Transport transport )
+
+
+
+
+inline
+
+
+
+
Constructor that takes a transport and sets the other fields to their default values.
+
Parameters
+
+ transport The transport to use.
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const int mscclpp::EndpointConfig::DefaultMaxCqPollNum = 1
+
+
+
+
+static
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const int mscclpp::EndpointConfig::DefaultMaxCqSize = 1024
+
+
+
+
+static
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const int mscclpp::EndpointConfig::DefaultMaxSendWr = 8192
+
+
+
+
+static
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const int mscclpp::EndpointConfig::DefaultMaxWrPerSend = 64
+
+
+
+
+static
+
+
+
+
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
+
+ Transport mscclpp::EndpointConfig::transport
+
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::FifoDeviceHandle , including all inherited members.
+
MSCCL++: mscclpp::FifoDeviceHandle Struct Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <fifo_device.hpp >
+
+
+
+ProxyTrigger * triggers The FIFO buffer that is allocated on the host via cudaHostAlloc(). More... uint64_t * tailReplica Replica of the FIFO tail that is allocated on device. More... uint64_t * head The FIFO head. Allocated on the device and only accessed by the device. More... int size The FIFO size. More...
+
+
A concurrent FIFO where multiple device threads (the number of threads should not exceed the fifo size) can push work elements and a single host proxy thread consumes them.
+
The FIFO has a head pointer allocated on the device which starts at 0 and goes up to 2^64-1, which is almost infinity. There are two copies of the tail, one on the device, FifoDeviceHandle::tailReplica , and another on the host, namely, hostTail. The host always has the "true" tail and occasionally pushes it to the copy on the device. Therefore, most of the time, the device has a stale version. The invariants are: tailReplica <= hostTail <= head. The push() function increments head, hostTail is updated in Fifo::pop() , and it occasionally flushes it to tailReplica via Fifo::flushTail() .
+
Duplicating the tail is a good idea because the FIFO is large enough, and we do not need frequent updates for the tail as there is usually enough space for device threads to push their work into.
+
+
+
◆
+
+
+
+
+
+ uint64_t* mscclpp::FifoDeviceHandle::head
+
+
+
+
+
The FIFO head. Allocated on the device and only accessed by the device.
+
+
+
+
+
◆
+
+
+
+
+
+ int mscclpp::FifoDeviceHandle::size
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint64_t* mscclpp::FifoDeviceHandle::tailReplica
+
+
+
+
+
Replica of the FIFO tail that is allocated on device.
+
+
+
+
+
◆
+
+
+
+
+
The FIFO buffer that is allocated on the host via cudaHostAlloc().
+
+
+
+
The documentation for this struct was generated from the following file:
+
+
diff --git a/docs/doxygen/html/structmscclpp_1_1FifoDeviceHandle__coll__graph.md5 b/docs/doxygen/html/structmscclpp_1_1FifoDeviceHandle__coll__graph.md5
new file mode 100644
index 00000000..0a43c3d2
--- /dev/null
+++ b/docs/doxygen/html/structmscclpp_1_1FifoDeviceHandle__coll__graph.md5
@@ -0,0 +1 @@
+b6fce07f92a31eee6d05d71f6f5c272a
\ No newline at end of file
diff --git a/docs/doxygen/html/structmscclpp_1_1FifoDeviceHandle__coll__graph.png b/docs/doxygen/html/structmscclpp_1_1FifoDeviceHandle__coll__graph.png
new file mode 100644
index 00000000..dbc33e19
Binary files /dev/null and b/docs/doxygen/html/structmscclpp_1_1FifoDeviceHandle__coll__graph.png differ
diff --git a/docs/doxygen/html/structmscclpp_1_1Host2DeviceSemaphoreDeviceHandle-members.html b/docs/doxygen/html/structmscclpp_1_1Host2DeviceSemaphoreDeviceHandle-members.html
new file mode 100644
index 00000000..c6f4ed93
--- /dev/null
+++ b/docs/doxygen/html/structmscclpp_1_1Host2DeviceSemaphoreDeviceHandle-members.html
@@ -0,0 +1,86 @@
+
+
+
+MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::Host2DeviceSemaphoreDeviceHandle , including all inherited members.
+
MSCCL++: mscclpp::Host2DeviceSemaphoreDeviceHandle Struct Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Device-side handle for Host2DeviceSemaphore .
+ More...
+
+
#include <semaphore_device.hpp >
+
+
+
Device-side handle for Host2DeviceSemaphore .
+
+
+
◆
+
+
+
+
+
+ uint64_t* mscclpp::Host2DeviceSemaphoreDeviceHandle::expectedInboundSemaphoreId
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint64_t* mscclpp::Host2DeviceSemaphoreDeviceHandle::inboundSemaphoreId
+
+
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::NvlsConnection::DeviceMulticastPointer , including all inherited members.
+
MSCCL++: mscclpp::NvlsConnection::DeviceMulticastPointer Struct Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <nvls.hpp >
+
+
+
+
◆
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ mscclpp::NvlsConnection::DeviceMulticastPointer::DeviceMulticastPointer
+ (
+ std::shared_ptr< PhysicalCudaMemory < char >>
+ deviceMem ,
+
+ std::shared_ptr< char >
+ mcPtr ,
+
+ size_t
+ bufferSize
+
+ )
+
+
+
+
+inline
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ DeviceHandle mscclpp::NvlsConnection::DeviceMulticastPointer::deviceHandle (
+ )
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ char* mscclpp::NvlsConnection::DeviceMulticastPointer::getDevicePtr
+ (
+ )
+
+
+
+
+
+
+
+
+
◆
+
+
+
The documentation for this struct was generated from the following file:
+
MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::PhysicalCudaMemory< T > , including all inherited members.
+
MSCCL++: mscclpp::PhysicalCudaMemory< T > Struct Template Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <gpu_utils.hpp >
+
+ PhysicalCudaMemory (CUmemGenericAllocationHandle memHandle, T *devicePtr, size_t size)
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+
+
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+
+
+
+
+
◆
+
+
+
+
+template<class T >
+
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::ProxyChannel , including all inherited members.
+
MSCCL++: mscclpp::ProxyChannel Struct Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Proxy channel.
+ More...
+
+
#include <proxy_channel.hpp >
+
+
+
+
+
◆
+
+
+
+
+
◆ [1/3]
+
+
+
+
+
+
+
+
+ mscclpp::ProxyChannel::ProxyChannel
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+ mscclpp::ProxyChannel::ProxyChannel
+ (
+ SemaphoreId semaphoreId ,
+
+ std::shared_ptr< Host2DeviceSemaphore >
+ semaphore ,
+
+ std::shared_ptr< Proxy >
+ proxy
+
+ )
+
+
+
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+
+
+
+ mscclpp::ProxyChannel::ProxyChannel
+ (
+ const ProxyChannel &
+ other )
+
+
+
+
+default
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ DeviceHandle mscclpp::ProxyChannel::deviceHandle (
+ )
+ const
+
+
+
+
Returns the device-side handle.
+
User should make sure the ProxyChannel is not released when using the returned handle.
+
+
+
+
+
◆
+
+
+
The documentation for this struct was generated from the following file:
+
MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::ProxyChannelDeviceHandle , including all inherited members.
+
MSCCL++: mscclpp::ProxyChannelDeviceHandle Struct Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <proxy_channel_device.hpp >
+
+
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
+
+ SemaphoreId mscclpp::ProxyChannelDeviceHandle::semaphoreId_
+
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
+
diff --git a/docs/doxygen/html/structmscclpp_1_1ProxyChannelDeviceHandle__coll__graph.md5 b/docs/doxygen/html/structmscclpp_1_1ProxyChannelDeviceHandle__coll__graph.md5
new file mode 100644
index 00000000..00ab7a0c
--- /dev/null
+++ b/docs/doxygen/html/structmscclpp_1_1ProxyChannelDeviceHandle__coll__graph.md5
@@ -0,0 +1 @@
+c63196ce9af3ada46fafeec18dd2d82d
\ No newline at end of file
diff --git a/docs/doxygen/html/structmscclpp_1_1ProxyChannelDeviceHandle__coll__graph.png b/docs/doxygen/html/structmscclpp_1_1ProxyChannelDeviceHandle__coll__graph.png
new file mode 100644
index 00000000..d71197fb
Binary files /dev/null and b/docs/doxygen/html/structmscclpp_1_1ProxyChannelDeviceHandle__coll__graph.png differ
diff --git a/docs/doxygen/html/structmscclpp_1_1ProxyTrigger-members.html b/docs/doxygen/html/structmscclpp_1_1ProxyTrigger-members.html
new file mode 100644
index 00000000..04bdcf65
--- /dev/null
+++ b/docs/doxygen/html/structmscclpp_1_1ProxyTrigger-members.html
@@ -0,0 +1,86 @@
+
+
+
+MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::ProxyTrigger , including all inherited members.
+
MSCCL++: mscclpp::ProxyTrigger Struct Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <fifo_device.hpp >
+
+uint64_t fst uint64_t snd
+
+
A struct representing a pair of 64-bit unsigned integers used as a trigger for the proxy.
+
This struct is used as a work element in the concurrent FIFO where multiple device threads can push ProxyTrigger elements and a single host proxy thread consumes these work elements.
+
Do not use the most significant bit of snd as it is reserved for memory consistency purposes
+
+
+
◆
+
+
+
+
+
+ uint64_t mscclpp::ProxyTrigger::fst
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint64_t mscclpp::ProxyTrigger::snd
+
+
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::ScopedTimer , including all inherited members.
+
MSCCL++: mscclpp::ScopedTimer Struct Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <utils.hpp >
+
+
+
+
+
+const std::string name_ std::chrono::steady_clock::time_point start_ int timeout_
+
+
+
◆
+
+
+
+
+
+ mscclpp::ScopedTimer::ScopedTimer
+ (
+ const std::string &
+ name )
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ mscclpp::ScopedTimer::~ScopedTimer
+ (
+ )
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ const std::string mscclpp::ScopedTimer::name_
+
+
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
+
diff --git a/docs/doxygen/html/structmscclpp_1_1ScopedTimer__coll__graph.md5 b/docs/doxygen/html/structmscclpp_1_1ScopedTimer__coll__graph.md5
new file mode 100644
index 00000000..81c6197e
--- /dev/null
+++ b/docs/doxygen/html/structmscclpp_1_1ScopedTimer__coll__graph.md5
@@ -0,0 +1 @@
+26378bd53a2f0c981ad3a7c5d654bb00
\ No newline at end of file
diff --git a/docs/doxygen/html/structmscclpp_1_1ScopedTimer__coll__graph.png b/docs/doxygen/html/structmscclpp_1_1ScopedTimer__coll__graph.png
new file mode 100644
index 00000000..753cfcf2
Binary files /dev/null and b/docs/doxygen/html/structmscclpp_1_1ScopedTimer__coll__graph.png differ
diff --git a/docs/doxygen/html/structmscclpp_1_1ScopedTimer__inherit__graph.map b/docs/doxygen/html/structmscclpp_1_1ScopedTimer__inherit__graph.map
new file mode 100644
index 00000000..e7520a1c
--- /dev/null
+++ b/docs/doxygen/html/structmscclpp_1_1ScopedTimer__inherit__graph.map
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/doxygen/html/structmscclpp_1_1ScopedTimer__inherit__graph.md5 b/docs/doxygen/html/structmscclpp_1_1ScopedTimer__inherit__graph.md5
new file mode 100644
index 00000000..81c6197e
--- /dev/null
+++ b/docs/doxygen/html/structmscclpp_1_1ScopedTimer__inherit__graph.md5
@@ -0,0 +1 @@
+26378bd53a2f0c981ad3a7c5d654bb00
\ No newline at end of file
diff --git a/docs/doxygen/html/structmscclpp_1_1ScopedTimer__inherit__graph.png b/docs/doxygen/html/structmscclpp_1_1ScopedTimer__inherit__graph.png
new file mode 100644
index 00000000..753cfcf2
Binary files /dev/null and b/docs/doxygen/html/structmscclpp_1_1ScopedTimer__inherit__graph.png differ
diff --git a/docs/doxygen/html/structmscclpp_1_1Setuppable-members.html b/docs/doxygen/html/structmscclpp_1_1Setuppable-members.html
new file mode 100644
index 00000000..365793d4
--- /dev/null
+++ b/docs/doxygen/html/structmscclpp_1_1Setuppable-members.html
@@ -0,0 +1,87 @@
+
+
+
+MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::Setuppable , including all inherited members.
+
MSCCL++: mscclpp::Setuppable Struct Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A base class for objects that can be set up during Communicator::setup() .
+ More...
+
+
#include <core.hpp >
+
+
+
A base class for objects that can be set up during Communicator::setup() .
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual mscclpp::Setuppable::~Setuppable
+ (
+ )
+
+
+
+
+virtual default
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void mscclpp::Setuppable::beginSetup
+ (
+ std::shared_ptr< Bootstrap >
+ bootstrap )
+
+
+
+
+virtual
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void mscclpp::Setuppable::endSetup
+ (
+ std::shared_ptr< Bootstrap >
+ bootstrap )
+
+
+
+
+virtual
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::SimpleProxyChannel , including all inherited members.
+
MSCCL++: mscclpp::SimpleProxyChannel Struct Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Simple proxy channel with a single destination and source memory region.
+ More...
+
+
#include <proxy_channel.hpp >
+
+
+
Simple proxy channel with a single destination and source memory region.
+
+
+
◆
+
+
+
+
+
◆ [1/4]
+
+
+
+
+
+
+
+
+ mscclpp::SimpleProxyChannel::SimpleProxyChannel
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
+ mscclpp::SimpleProxyChannel::SimpleProxyChannel
+ (
+ ProxyChannel proxyChan ,
+
+ MemoryId dst ,
+
+ MemoryId src
+
+ )
+
+
+
+
Constructor.
Parameters
+
+ proxyChan The proxy channel. dst The destination memory region. src The source memory region.
+
+
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
+
+
+
+ mscclpp::SimpleProxyChannel::SimpleProxyChannel
+ (
+ ProxyChannel proxyChan )
+
+
+
+
+inline
+
+
+
+
Constructor.
Parameters
+
+ proxyChan The proxy channel.
+
+
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
+
+
+
+ mscclpp::SimpleProxyChannel::SimpleProxyChannel
+ (
+ const SimpleProxyChannel &
+ other )
+
+
+
+
+default
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ DeviceHandle mscclpp::SimpleProxyChannel::deviceHandle (
+ )
+ const
+
+
+
+
Returns the device-side handle.
+
User should make sure the SimpleProxyChannel is not released when using the returned handle.
+
+
+
+
+
◆
+
+
+
+
+
Assignment operator.
+
+
+
+
The documentation for this struct was generated from the following file:
+
MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::SimpleProxyChannelDeviceHandle , including all inherited members.
+
MSCCL++: mscclpp::SimpleProxyChannelDeviceHandle Struct Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <proxy_channel_device.hpp >
+
+
+
+
+
+
[legend ]
+
+
+
+
◆
+
+
+
+
+
+ MemoryId mscclpp::SimpleProxyChannelDeviceHandle::dst_
+
+
+
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
+
+ MemoryId mscclpp::SimpleProxyChannelDeviceHandle::src_
+
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
+
diff --git a/docs/doxygen/html/structmscclpp_1_1SimpleProxyChannelDeviceHandle__coll__graph.md5 b/docs/doxygen/html/structmscclpp_1_1SimpleProxyChannelDeviceHandle__coll__graph.md5
new file mode 100644
index 00000000..317b7b60
--- /dev/null
+++ b/docs/doxygen/html/structmscclpp_1_1SimpleProxyChannelDeviceHandle__coll__graph.md5
@@ -0,0 +1 @@
+9a1a3edf9cdde2ee9101bb65151c5827
\ No newline at end of file
diff --git a/docs/doxygen/html/structmscclpp_1_1SimpleProxyChannelDeviceHandle__coll__graph.png b/docs/doxygen/html/structmscclpp_1_1SimpleProxyChannelDeviceHandle__coll__graph.png
new file mode 100644
index 00000000..ac905769
Binary files /dev/null and b/docs/doxygen/html/structmscclpp_1_1SimpleProxyChannelDeviceHandle__coll__graph.png differ
diff --git a/docs/doxygen/html/structmscclpp_1_1SmChannel-members.html b/docs/doxygen/html/structmscclpp_1_1SmChannel-members.html
new file mode 100644
index 00000000..ffb9d334
--- /dev/null
+++ b/docs/doxygen/html/structmscclpp_1_1SmChannel-members.html
@@ -0,0 +1,88 @@
+
+
+
+MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::SmChannel , including all inherited members.
+
MSCCL++: mscclpp::SmChannel Struct Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Channel for accessing peer memory directly from SM.
+ More...
+
+
#include <sm_channel.hpp >
+
+
+
Channel for accessing peer memory directly from SM.
+
+
+
◆
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ mscclpp::SmChannel::SmChannel
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ mscclpp::SmChannel::SmChannel
+ (
+ std::shared_ptr< SmDevice2DeviceSemaphore >
+ semaphore ,
+
+ RegisteredMemory dst ,
+
+ void *
+ src ,
+
+ void *
+ getPacketBuffer = nullptr
+
+ )
+
+
+
+
Constructor.
Parameters
+
+ semaphore The semaphore used to synchronize the communication. dst Registered memory of the destination. src The source memory address. getPacketBuffer The optional buffer used for getPackets().
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ DeviceHandle mscclpp::SmChannel::deviceHandle (
+ )
+ const
+
+
+
+
Returns the device-side handle.
+
User should make sure the SmChannel is not released when using the returned handle.
+
+
+
+
The documentation for this struct was generated from the following file:
+
MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::SmChannelDeviceHandle , including all inherited members.
+
MSCCL++: mscclpp::SmChannelDeviceHandle Struct Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Channel for accessing peer memory directly from SM.
+ More...
+
+
#include <sm_channel_device.hpp >
+
+
+
+
+
Channel for accessing peer memory directly from SM.
+
+
+
◆
+
+
+
+
+
+ void* mscclpp::SmChannelDeviceHandle::dst_
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void* mscclpp::SmChannelDeviceHandle::getPacketBuffer_
+
+
+
+
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
+
+ void* mscclpp::SmChannelDeviceHandle::src_
+
+
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
+
diff --git a/docs/doxygen/html/structmscclpp_1_1SmChannelDeviceHandle__coll__graph.md5 b/docs/doxygen/html/structmscclpp_1_1SmChannelDeviceHandle__coll__graph.md5
new file mode 100644
index 00000000..fe07954a
--- /dev/null
+++ b/docs/doxygen/html/structmscclpp_1_1SmChannelDeviceHandle__coll__graph.md5
@@ -0,0 +1 @@
+f6e6a80a1b4d9b76c3922863f28032e3
\ No newline at end of file
diff --git a/docs/doxygen/html/structmscclpp_1_1SmChannelDeviceHandle__coll__graph.png b/docs/doxygen/html/structmscclpp_1_1SmChannelDeviceHandle__coll__graph.png
new file mode 100644
index 00000000..53229dc2
Binary files /dev/null and b/docs/doxygen/html/structmscclpp_1_1SmChannelDeviceHandle__coll__graph.png differ
diff --git a/docs/doxygen/html/structmscclpp_1_1SmDevice2DeviceSemaphoreDeviceHandle-members.html b/docs/doxygen/html/structmscclpp_1_1SmDevice2DeviceSemaphoreDeviceHandle-members.html
new file mode 100644
index 00000000..ca72833e
--- /dev/null
+++ b/docs/doxygen/html/structmscclpp_1_1SmDevice2DeviceSemaphoreDeviceHandle-members.html
@@ -0,0 +1,88 @@
+
+
+
+MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::SmDevice2DeviceSemaphoreDeviceHandle , including all inherited members.
+
MSCCL++: mscclpp::SmDevice2DeviceSemaphoreDeviceHandle Struct Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Device-side handle for SmDevice2DeviceSemaphore .
+ More...
+
+
#include <semaphore_device.hpp >
+
+
+
Device-side handle for SmDevice2DeviceSemaphore .
+
+
+
◆
+
+
+
+
+
+ uint64_t* mscclpp::SmDevice2DeviceSemaphoreDeviceHandle::expectedInboundSemaphoreId
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint64_t* mscclpp::SmDevice2DeviceSemaphoreDeviceHandle::inboundSemaphoreId
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint64_t* mscclpp::SmDevice2DeviceSemaphoreDeviceHandle::outboundSemaphoreId
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint64_t* mscclpp::SmDevice2DeviceSemaphoreDeviceHandle::remoteInboundSemaphoreId
+
+
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::Timer , including all inherited members.
+
MSCCL++: mscclpp::Timer Struct Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <utils.hpp >
+
+
+
+ Timer (int timeout=-1) ~Timer () int64_t elapsed () const Returns the elapsed time in microseconds. More... void set (int timeout) void reset () void print (const std::string &name)
+
+
+
◆
+
+
+
+
+
+ mscclpp::Timer::Timer
+ (
+ int
+ timeout = -1)
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ mscclpp::Timer::~Timer
+ (
+ )
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ int64_t mscclpp::Timer::elapsed
+ (
+ )
+ const
+
+
+
+
+
Returns the elapsed time in microseconds.
+
+
+
+
+
◆
+
+
+
+
+
+ void mscclpp::Timer::print
+ (
+ const std::string &
+ name )
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void mscclpp::Timer::reset
+ (
+ )
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void mscclpp::Timer::set
+ (
+ int
+ timeout )
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ std::chrono::steady_clock::time_point mscclpp::Timer::start_
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ int mscclpp::Timer::timeout_
+
+
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
+
diff --git a/docs/doxygen/html/structmscclpp_1_1Timer__inherit__graph.md5 b/docs/doxygen/html/structmscclpp_1_1Timer__inherit__graph.md5
new file mode 100644
index 00000000..8a778b05
--- /dev/null
+++ b/docs/doxygen/html/structmscclpp_1_1Timer__inherit__graph.md5
@@ -0,0 +1 @@
+7b7f115790213c757608c34304670070
\ No newline at end of file
diff --git a/docs/doxygen/html/structmscclpp_1_1Timer__inherit__graph.png b/docs/doxygen/html/structmscclpp_1_1Timer__inherit__graph.png
new file mode 100644
index 00000000..065d9d6a
Binary files /dev/null and b/docs/doxygen/html/structmscclpp_1_1Timer__inherit__graph.png differ
diff --git a/docs/doxygen/html/sync_off.png b/docs/doxygen/html/sync_off.png
new file mode 100644
index 00000000..3b443fc6
Binary files /dev/null and b/docs/doxygen/html/sync_off.png differ
diff --git a/docs/doxygen/html/sync_on.png b/docs/doxygen/html/sync_on.png
new file mode 100644
index 00000000..e08320fb
Binary files /dev/null and b/docs/doxygen/html/sync_on.png differ
diff --git a/docs/doxygen/html/tab_a.png b/docs/doxygen/html/tab_a.png
new file mode 100644
index 00000000..3b725c41
Binary files /dev/null and b/docs/doxygen/html/tab_a.png differ
diff --git a/docs/doxygen/html/tab_b.png b/docs/doxygen/html/tab_b.png
new file mode 100644
index 00000000..e2b4a863
Binary files /dev/null and b/docs/doxygen/html/tab_b.png differ
diff --git a/docs/doxygen/html/tab_h.png b/docs/doxygen/html/tab_h.png
new file mode 100644
index 00000000..fd5cb705
Binary files /dev/null and b/docs/doxygen/html/tab_h.png differ
diff --git a/docs/doxygen/html/tab_s.png b/docs/doxygen/html/tab_s.png
new file mode 100644
index 00000000..ab478c95
Binary files /dev/null and b/docs/doxygen/html/tab_s.png differ
diff --git a/docs/doxygen/html/tabs.css b/docs/doxygen/html/tabs.css
new file mode 100644
index 00000000..7d45d36c
--- /dev/null
+++ b/docs/doxygen/html/tabs.css
@@ -0,0 +1 @@
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0px/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.sm-dox{background-image:url("tab_b.png")}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0px 12px;padding-right:43px;font-family:"Lucida Grande","Geneva","Helvetica",Arial,sans-serif;font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:0px 1px 1px rgba(255,255,255,0.9);color:#283A5D;outline:none}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:#fff;text-shadow:0px 1px 1px #000}.sm-dox a.current{color:#D23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:rgba(255,255,255,0.5);border-radius:5px}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{border-radius:0}.sm-dox ul{background:rgba(162,162,162,0.1)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:white;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:#fff;text-shadow:0px 1px 1px #000}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media (min-width: 768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:url("tab_b.png");line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:#283A5D transparent transparent transparent;background:transparent;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0px 12px;background-image:url("tab_s.png");background-repeat:no-repeat;background-position:right;border-radius:0 !important}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:#fff;text-shadow:0px 1px 1px #000}.sm-dox a:hover span.sub-arrow{border-color:#fff transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent #fff transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:#fff;border-radius:5px !important;box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent #555;border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:#555;background-image:none;border:0 !important;color:#555;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:#fff;text-shadow:0px 1px 1px #000}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent #fff}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:#fff;height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #D23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#D23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent #555 transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:#555 transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:url("tab_b.png")}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:#fff}}
diff --git a/docs/doxygen/html/unionNpKitEvent-members.html b/docs/doxygen/html/unionNpKitEvent-members.html
new file mode 100644
index 00000000..c74cdbf3
--- /dev/null
+++ b/docs/doxygen/html/unionNpKitEvent-members.html
@@ -0,0 +1,86 @@
+
+
+
+MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for NpKitEvent , including all inherited members.
+
MSCCL++: NpKitEvent Union Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <npkit_struct.hpp >
+
+
+
+
◆
+
+
+
+
+
+ uint64_t NpKitEvent::bits[2]
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ struct { ... } NpKitEvent::fields
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint64_t NpKitEvent::rsvd
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint64_t NpKitEvent::size
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint64_t NpKitEvent::timestamp
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint64_t NpKitEvent::type
+
+
+
+
+
+
+
The documentation for this union was generated from the following file:
+
MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::ChannelTrigger , including all inherited members.
+
MSCCL++: mscclpp::ChannelTrigger Union Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Basic structure of each work element in the FIFO.
+ More...
+
+
#include <proxy_channel_device.hpp >
+
+
+
+
+
Basic structure of each work element in the FIFO.
+
+
+
◆
+
+
+
+
+
+ uint64_t mscclpp::ChannelTrigger::__pad0__
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint64_t mscclpp::ChannelTrigger::__pad1__
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint64_t mscclpp::ChannelTrigger::chanId
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint64_t mscclpp::ChannelTrigger::dstMemoryId
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint64_t mscclpp::ChannelTrigger::dstOffset
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ struct { ... } mscclpp::ChannelTrigger::fields
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint64_t mscclpp::ChannelTrigger::reserved
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint64_t mscclpp::ChannelTrigger::size
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint64_t mscclpp::ChannelTrigger::srcMemoryId
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint64_t mscclpp::ChannelTrigger::srcOffset
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint64_t mscclpp::ChannelTrigger::type
+
+
+
+
+
+
+
+
◆
+
+
+
The documentation for this union was generated from the following file:
+
+
diff --git a/docs/doxygen/html/unionmscclpp_1_1ChannelTrigger__coll__graph.md5 b/docs/doxygen/html/unionmscclpp_1_1ChannelTrigger__coll__graph.md5
new file mode 100644
index 00000000..5431174b
--- /dev/null
+++ b/docs/doxygen/html/unionmscclpp_1_1ChannelTrigger__coll__graph.md5
@@ -0,0 +1 @@
+3505677cc7d4fee708fdfe6be9a81b2c
\ No newline at end of file
diff --git a/docs/doxygen/html/unionmscclpp_1_1ChannelTrigger__coll__graph.png b/docs/doxygen/html/unionmscclpp_1_1ChannelTrigger__coll__graph.png
new file mode 100644
index 00000000..d4d0c99d
Binary files /dev/null and b/docs/doxygen/html/unionmscclpp_1_1ChannelTrigger__coll__graph.png differ
diff --git a/docs/doxygen/html/unionmscclpp_1_1LL16Packet-members.html b/docs/doxygen/html/unionmscclpp_1_1LL16Packet-members.html
new file mode 100644
index 00000000..043b2606
--- /dev/null
+++ b/docs/doxygen/html/unionmscclpp_1_1LL16Packet-members.html
@@ -0,0 +1,89 @@
+
+
+
+MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::LL16Packet , including all inherited members.
+
MSCCL++: mscclpp::LL16Packet Union Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
LL (low latency) protocol packet.
+ More...
+
+
#include <packet_device.hpp >
+
+
+
LL (low latency) protocol packet.
+
+
+
◆
+
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
+
+ uint32_t mscclpp::LL16Packet::data1
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint32_t mscclpp::LL16Packet::data2
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint32_t mscclpp::LL16Packet::flag1
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint32_t mscclpp::LL16Packet::flag2
+
+
+
+
+
+
+
The documentation for this union was generated from the following file:
+
MSCCL++: Member List
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for mscclpp::LL8Packet , including all inherited members.
+
MSCCL++: mscclpp::LL8Packet Union Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <packet_device.hpp >
+
+struct { uint32_t data uint32_t flag }; uint64_t raw_
+
+
+
◆
+
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
+
+ uint32_t mscclpp::LL8Packet::data
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint32_t mscclpp::LL8Packet::flag
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ uint64_t mscclpp::LL8Packet::raw_
+
+
+
+
+
+
+
The documentation for this union was generated from the following file:
+
MSCCL++: utils.hpp File Reference
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <chrono>#include <string>
+
Go to the source code of this file.
+
+
+
diff --git a/docs/doxygen/html/utils_8hpp__incl.md5 b/docs/doxygen/html/utils_8hpp__incl.md5
new file mode 100644
index 00000000..69db40ce
--- /dev/null
+++ b/docs/doxygen/html/utils_8hpp__incl.md5
@@ -0,0 +1 @@
+ab3ca0c357204ea0b150b9f3e3e67b8a
\ No newline at end of file
diff --git a/docs/doxygen/html/utils_8hpp__incl.png b/docs/doxygen/html/utils_8hpp__incl.png
new file mode 100644
index 00000000..f55710d8
Binary files /dev/null and b/docs/doxygen/html/utils_8hpp__incl.png differ
diff --git a/docs/doxygen/html/utils_8hpp_source.html b/docs/doxygen/html/utils_8hpp_source.html
new file mode 100644
index 00000000..6ce0af64
--- /dev/null
+++ b/docs/doxygen/html/utils_8hpp_source.html
@@ -0,0 +1,140 @@
+
+
+
+MSCCL++: utils.hpp Source File
+
+
+
+
+
+
+ MSCCL++
+
+ GPU-driven computation & communication stack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
4 #ifndef MSCCLPP_UTILS_HPP_
+
5 #define MSCCLPP_UTILS_HPP_
+
+
+
+
+
+
+
+
13 std::chrono::steady_clock::time_point
start_ ;
+
+
+
16 Timer (
int timeout = -1);
+
+
+
+
+
+
23 void set (
int timeout);
+
+
+
+
27 void print (
const std::string& name);
+
+
+
+
+
+
+
+
+
+
+
38 std::string
getHostName (
int maxlen,
const char delim);
+
+
+
+
+
+
44 #endif // MSCCLPP_UTILS_HPP_
+
int64_t elapsed() const
Returns the elapsed time in microseconds.
int timeout_
Definition: utils.hpp:14
const std::string name_
Definition: utils.hpp:31
std::string getHostName(int maxlen, const char delim)
std::chrono::steady_clock::time_point start_
Definition: utils.hpp:13
ScopedTimer(const std::string &name)
void print(const std::string &name)
Definition: atomic_device.hpp:13
+
+ README.md
+
+
+
+
+
+# [](LICENSE) [](https://github.com/microsoft/mscclpp/actions/workflows/codeql-analysis.yml) | |--------------------------|-------------------| | | | A See ## MSCCL++ | |-------------------------------| | The * * * ## While The | |-------------------------------|----------------------------| | ## The ### MSCCL++ ```cpp // __device__ __global__ } ``` MSCCL++ ```cpp // __device__ } ``` MSCCL++ ### MSCCL++ On ### MSCCL++ ```cpp // auto // mscclpp::Communicator // ... // mscclpp::ProxyService // proxyService.startProxy(); // ... // proxyService.stopProxy(); ``` While ```cpp // __device__ __global__ } // class private: public: }; ``` Customized ### MSCCL++ ## This Contributor the When a provided This For contact ## This trademarks [Microsoft's Use Any
+
+
diff --git a/docs/doxygen/xml/atomic__device_8hpp.xml b/docs/doxygen/xml/atomic__device_8hpp.xml
new file mode 100644
index 00000000..c71f29dc
--- /dev/null
+++ b/docs/doxygen/xml/atomic__device_8hpp.xml
@@ -0,0 +1,105 @@
+
+
+
+ atomic_device.hpp
+ device.hpp
+ concurrency_device.hpp
+
+
+ device.hpp
+
+
+ atomic_device.hpp
+
+
+
+
+
+
+ atomic_device.hpp
+
+
+
+
+ concurrency_device.hpp
+
+
+ mscclpp
+
+
+
+
+
+#ifndef #define #include[device.hpp]" #if #include #endif namespace [mscclpp]#if constexpr constexpr constexpr constexpr constexpr template typename [MSCCLPP_HOST_DEVICE_INLINE]return } template typename [MSCCLPP_HOST_DEVICE_INLINE]void const } template typename [MSCCLPP_HOST_DEVICE_INLINE]const return } #elif constexpr auto constexpr auto constexpr auto constexpr auto constexpr auto template typename [MSCCLPP_HOST_DEVICE_INLINE]const int return } template typename [MSCCLPP_HOST_DEVICE_INLINE]void const int } template typename [MSCCLPP_HOST_DEVICE_INLINE]const int return } #endif } #endif
+
+
diff --git a/docs/doxygen/xml/classNpKit.xml b/docs/doxygen/xml/classNpKit.xml
new file mode 100644
index 00000000..831d0ad0
--- /dev/null
+++ b/docs/doxygen/xml/classNpKit.xml
@@ -0,0 +1,320 @@
+
+
+
+ NpKit
+ npkit.hpp
+
+
+ const uint64_t
+ const uint64_t NpKit::kNumGpuEventBuffers
+ kNumGpuEventBuffers
+ = 1024
+
+
+
+
+
+
+
+
+ const uint64_t
+ const uint64_t NpKit::kNumCpuEventBuffers
+ kNumCpuEventBuffers
+ = 64
+
+
+
+
+
+
+
+
+
+
+ const uint64_t
+ const uint64_t NpKit::kMaxNumGpuEventsPerBuffer
+ kMaxNumGpuEventsPerBuffer
+ = 1ULL << 16
+
+
+
+
+
+
+
+
+ const uint64_t
+ const uint64_t NpKit::kMaxNumCpuEventsPerBuffer
+ kMaxNumCpuEventsPerBuffer
+ = 1ULL << 21
+
+
+
+
+
+
+
+
+ std::vector< [mscclpp::UniqueCudaPtr]< [NpKitEvent] > >
+ std::vector<mscclpp::UniqueCudaPtr<NpKitEvent> > NpKit::gpu_event_buffers_
+ gpu_event_buffers_
+
+
+
+
+
+
+
+
+ std::vector< std::unique_ptr< [NpKitEvent][]> >
+ std::vector<std::unique_ptr<NpKitEvent[]> > NpKit::cpu_event_buffers_
+ cpu_event_buffers_
+
+
+
+
+
+
+
+
+ [mscclpp::UniqueCudaPtr]< [NpKitEventCollectContext] >mscclpp::UniqueCudaPtr<NpKitEventCollectContext> NpKit::gpu_collect_contexts_
+ gpu_collect_contexts_
+
+
+
+
+
+
+
+
+ std::unique_ptr< [NpKitEventCollectContext][]>
+ std::unique_ptr<NpKitEventCollectContext[]> NpKit::cpu_collect_contexts_
+ cpu_collect_contexts_
+
+
+
+
+
+
+
+
+ uint64_t
+ uint64_t NpKit::rank_
+ rank_
+
+
+
+
+
+
+
+
+ [mscclpp::UniqueCudaHostPtr]< uint64_t >mscclpp::UniqueCudaHostPtr<uint64_t> NpKit::cpu_timestamp_
+ cpu_timestamp_
+
+
+
+
+
+
+
+
+ std::unique_ptr< std::thread >
+ std::unique_ptr<std::thread> NpKit::cpu_timestamp_update_thread_
+ cpu_timestamp_update_thread_
+
+
+
+
+
+
+
+
+ bool
+ volatile bool NpKit::cpu_timestamp_update_thread_should_stop_
+ cpu_timestamp_update_thread_should_stop_
+
+
+
+
+
+
+
+
+
+
+ void
+ static void NpKit::Init
+ (int rank)
+ Init
+ int
+ rank
+
+
+
+
+
+
+
+
+
+ void
+ static void NpKit::Dump
+ (const std::string &dump_dir)
+ Dump
+ const std::string &
+ dump_dir
+
+
+
+
+
+
+
+
+
+ void
+ static void NpKit::Shutdown
+ ()
+ Shutdown
+
+
+
+
+
+
+
+
+ [NpKitEventCollectContext] *static NpKitEventCollectContext* NpKit::GetGpuEventCollectContexts
+ ()
+ GetGpuEventCollectContexts
+
+
+
+
+
+
+
+
+ void
+ static void NpKit::CollectCpuEvent
+ (uint8_t type, uint32_t size, uint32_t rsvd, uint64_t timestamp, int channel_id)
+ CollectCpuEvent
+ uint8_t
+ type
+
+ uint32_t
+ size
+
+ uint32_t
+ rsvd
+
+ uint64_t
+ timestamp
+
+ int
+ channel_id
+
+
+
+
+
+
+
+
+
+ uint64_t *
+ static uint64_t* NpKit::GetCpuTimestamp
+ ()
+ GetCpuTimestamp
+
+
+
+
+
+
+
+
+
+
+ void
+ static void NpKit::CpuTimestampUpdateThread
+ ()
+ CpuTimestampUpdateThread
+
+
+
+
+
+
+
+
+
+
+
+
+
+ NpKit CollectCpuEvent NpKit cpu_collect_contexts_ NpKit cpu_event_buffers_ NpKit cpu_timestamp_ NpKit cpu_timestamp_update_thread_ NpKit cpu_timestamp_update_thread_should_stop_ NpKit CpuTimestampUpdateThread NpKit Dump NpKit GetCpuTimestamp NpKit GetGpuEventCollectContexts NpKit gpu_collect_contexts_ NpKit gpu_event_buffers_ NpKit Init NpKit kMaxNumCpuEventsPerBuffer NpKit kMaxNumGpuEventsPerBuffer NpKit kNumCpuEventBuffers NpKit kNumGpuEventBuffers NpKit rank_ NpKit Shutdown
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1BaseError.xml b/docs/doxygen/xml/classmscclpp_1_1BaseError.xml
new file mode 100644
index 00000000..6d212e1d
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1BaseError.xml
@@ -0,0 +1,226 @@
+
+
+
+ mscclpp::BaseError
+ runtime_error
+ mscclpp::CudaError
+ mscclpp::CuError
+ mscclpp::Error
+ mscclpp::IbError
+ mscclpp::SysError
+ errors.hpp
+
+
+ std::string
+ std::string mscclpp::BaseError::message_
+ message_
+
+
+
+
+
+
+
+
+ int
+ int mscclpp::BaseError::errorCode_
+ errorCode_
+
+
+
+
+
+
+
+
+
+
+ mscclpp::BaseError::BaseError
+ (const std::string &message, int errorCode)
+ BaseError
+ const std::string &
+ message
+
+ int
+ errorCode
+
+
+
+
+Constructor for [BaseError].
+
+
+message
+
+
+The error message.
+
+
+
+
+errorCode
+
+
+The error code.
+
+
+
+
+
+
+
+ mscclpp::BaseError::BaseError
+ (int errorCode)
+ BaseError
+ int
+ errorCode
+
+
+
+
+Constructor for [BaseError].
+
+
+errorCode
+
+
+The error code.
+
+
+
+
+
+
+
+ virtual mscclpp::BaseError::~BaseError
+ ()=default
+ ~BaseError
+
+Virtual destructor for [BaseError].
+
+
+
+
+
+
+
+ int
+ int mscclpp::BaseError::getErrorCode
+ () const
+ getErrorCode
+
+
+
+Get the error code.
+The error code.
+
+
+
+
+
+ const char *
+ const char* mscclpp::BaseError::what
+ () const noexcept override
+ what
+
+
+
+Get the error message.
+The error message.
+
+
+
+
+
+
+Base class for all errors thrown by MSCCL++.
+
+
+
+
+
+ mscclpp::CudaError
+
+
+
+
+ std::runtime_error
+
+
+ mscclpp::SysError
+
+
+
+
+ mscclpp::Error
+
+
+
+
+ mscclpp::IbError
+
+
+
+
+ mscclpp::BaseError
+
+
+
+
+ mscclpp::CuError
+
+
+
+
+
+
+ std::runtime_error
+
+
+ mscclpp::BaseError
+
+
+
+
+
+ mscclpp::BaseError BaseError mscclpp::BaseError BaseError mscclpp::BaseError errorCode_ mscclpp::BaseError getErrorCode mscclpp::BaseError message_ mscclpp::BaseError what mscclpp::BaseError ~BaseError
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1BaseProxyService.xml b/docs/doxygen/xml/classmscclpp_1_1BaseProxyService.xml
new file mode 100644
index 00000000..950b911d
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1BaseProxyService.xml
@@ -0,0 +1,88 @@
+
+
+
+ mscclpp::BaseProxyService
+ mscclpp::ProxyService
+ proxy_channel.hpp
+
+
+ mscclpp::BaseProxyService::BaseProxyService
+ ()=default
+ BaseProxyService
+
+
+
+
+
+
+
+
+ virtual mscclpp::BaseProxyService::~BaseProxyService
+ ()=default
+ ~BaseProxyService
+
+
+
+
+
+
+
+
+ void
+ virtual void mscclpp::BaseProxyService::startProxy
+ ()=0
+ startProxy
+ startProxy
+
+
+
+
+
+
+
+
+ void
+ virtual void mscclpp::BaseProxyService::stopProxy
+ ()=0
+ stopProxy
+ stopProxy
+
+
+
+
+
+
+
+
+
+Base class for proxy services. [Proxy] services are used to proxy data between devices.
+
+
+
+
+
+ mscclpp::BaseProxyService
+
+
+ mscclpp::ProxyService
+
+
+
+
+
+ mscclpp::BaseProxyService BaseProxyService mscclpp::BaseProxyService startProxy mscclpp::BaseProxyService stopProxy mscclpp::BaseProxyService ~BaseProxyService
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1BaseSemaphore.xml b/docs/doxygen/xml/classmscclpp_1_1BaseSemaphore.xml
new file mode 100644
index 00000000..c92d6e1e
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1BaseSemaphore.xml
@@ -0,0 +1,179 @@
+
+
+
+ mscclpp::BaseSemaphore
+ semaphore.hpp
+
+ template< typename > typename
+ InboundDeleter
+ InboundDeleter
+
+ template< typename > typename
+ OutboundDeleter
+ OutboundDeleter
+
+
+
+
+ [NonblockingFuture]< [RegisteredMemory] >NonblockingFuture<RegisteredMemory> mscclpp::BaseSemaphore< InboundDeleter, OutboundDeleter >::remoteInboundSemaphoreIdsRegMem_
+ remoteInboundSemaphoreIdsRegMem_
+
+The registered memory for the remote peer's inbound semaphore ID.
+
+
+
+
+
+
+
+ std::unique_ptr< uint64_t, InboundDeleter< uint64_t > >
+ std::unique_ptr<uint64_t, InboundDeleter<uint64_t> > mscclpp::BaseSemaphore< InboundDeleter, OutboundDeleter >::localInboundSemaphore_
+ localInboundSemaphore_
+
+
+
+The inbound semaphore ID that is incremented by the remote peer and waited on by the local peer.
+The location of [localInboundSemaphore_] can be either on the host or on the device.
+
+
+
+
+
+ std::unique_ptr< uint64_t, InboundDeleter< uint64_t > >
+ std::unique_ptr<uint64_t, InboundDeleter<uint64_t> > mscclpp::BaseSemaphore< InboundDeleter, OutboundDeleter >::expectedInboundSemaphore_
+ expectedInboundSemaphore_
+
+
+
+The expected inbound semaphore ID to be incremented by the local peer and compared to the [localInboundSemaphore_].
+The location of [expectedInboundSemaphore_] can be either on the host or on the device.
+
+
+
+
+
+ std::unique_ptr< uint64_t, OutboundDeleter< uint64_t > >
+ std::unique_ptr<uint64_t, OutboundDeleter<uint64_t> > mscclpp::BaseSemaphore< InboundDeleter, OutboundDeleter >::outboundSemaphore_
+ outboundSemaphore_
+
+
+
+The outbound semaphore ID that is incremented by the local peer and copied to the remote peer's [localInboundSemaphore_].
+The location of [outboundSemaphore_] can be either on the host or on the device.
+
+
+
+
+
+
+
+ mscclpp::BaseSemaphore< InboundDeleter, OutboundDeleter >::BaseSemaphore
+ (std::unique_ptr< uint64_t, InboundDeleter< uint64_t >> localInboundSemaphoreId, std::unique_ptr< uint64_t, InboundDeleter< uint64_t >> expectedInboundSemaphoreId, std::unique_ptr< uint64_t, OutboundDeleter< uint64_t >> outboundSemaphoreId)
+ BaseSemaphore
+ std::unique_ptr< uint64_t, InboundDeleter< uint64_t >>
+ localInboundSemaphoreId
+
+ std::unique_ptr< uint64_t, InboundDeleter< uint64_t >>
+ expectedInboundSemaphoreId
+
+ std::unique_ptr< uint64_t, OutboundDeleter< uint64_t >>
+ outboundSemaphoreId
+
+
+
+
+Constructs a [BaseSemaphore].
+
+
+localInboundSemaphoreId
+
+
+The inbound semaphore ID
+
+
+
+
+expectedInboundSemaphoreId
+
+
+The expected inbound semaphore ID
+
+
+
+
+outboundSemaphoreId
+
+
+The outbound semaphore ID
+
+
+
+
+
+
+
+
+
+
+A base class for semaphores.
+An semaphore is a synchronization mechanism that allows the local peer to wait for the remote peer to complete a data transfer. The local peer signals the remote peer that it has completed a data transfer by incrementing the outbound semaphore ID. The incremented outbound semaphore ID is copied to the remote peer's inbound semaphore ID so that the remote peer can wait for the local peer to complete a data transfer. Vice versa, the remote peer signals the local peer that it has completed a data transfer by incrementing the remote peer's outbound semaphore ID and copying the incremented value to the local peer's inbound semaphore ID.
+
+
+InboundDeleter
+
+
+The deleter for inbound semaphore IDs. This is either std::default_delete for host memory or [CudaDeleter] for device memory.
+
+
+
+
+OutboundDeleter
+
+
+The deleter for outbound semaphore IDs. This is either std::default_delete for host memory or [CudaDeleter] for device memory.
+
+
+
+
+
+ mscclpp::NonblockingFuture< mscclpp::RegisteredMemory >
+
+
+ mscclpp::BaseSemaphore< InboundDeleter, OutboundDeleter >
+
+ remoteInboundSemaphoreIdsRegMem_
+
+
+
+
+ mscclpp::BaseSemaphore BaseSemaphore mscclpp::BaseSemaphore expectedInboundSemaphore_ mscclpp::BaseSemaphore localInboundSemaphore_ mscclpp::BaseSemaphore outboundSemaphore_ mscclpp::BaseSemaphore remoteInboundSemaphoreIdsRegMem_
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1Bootstrap.xml b/docs/doxygen/xml/classmscclpp_1_1Bootstrap.xml
new file mode 100644
index 00000000..f90c20ed
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1Bootstrap.xml
@@ -0,0 +1,273 @@
+
+
+
+ mscclpp::Bootstrap
+ mscclpp::TcpBootstrap
+ core.hpp
+
+
+ mscclpp::Bootstrap::Bootstrap
+ ()
+ Bootstrap
+
+
+
+
+
+
+
+
+ virtual mscclpp::Bootstrap::~Bootstrap
+ ()=default
+ ~Bootstrap
+
+
+
+
+
+
+
+
+ int
+ virtual int mscclpp::Bootstrap::getRank
+ ()=0
+ getRank
+ getRank
+
+
+
+
+
+
+
+
+ int
+ virtual int mscclpp::Bootstrap::getNranks
+ ()=0
+ getNranks
+ getNranks
+
+
+
+
+
+
+
+
+ int
+ virtual int mscclpp::Bootstrap::getNranksPerNode
+ ()=0
+ getNranksPerNode
+ getNranksPerNode
+
+
+
+
+
+
+
+
+ void
+ virtual void mscclpp::Bootstrap::send
+ (void *data, int size, int peer, int tag)=0
+ send
+ send
+ void *
+ data
+
+ int
+ size
+
+ int
+ peer
+
+ int
+ tag
+
+
+
+
+
+
+
+
+
+ void
+ virtual void mscclpp::Bootstrap::recv
+ (void *data, int size, int peer, int tag)=0
+ recv
+ recv
+ void *
+ data
+
+ int
+ size
+
+ int
+ peer
+
+ int
+ tag
+
+
+
+
+
+
+
+
+
+ void
+ virtual void mscclpp::Bootstrap::allGather
+ (void *allData, int size)=0
+ allGather
+ allGather
+ void *
+ allData
+
+ int
+ size
+
+
+
+
+
+
+
+
+
+ void
+ virtual void mscclpp::Bootstrap::barrier
+ ()=0
+ barrier
+ barrier
+
+
+
+
+
+
+
+
+ void
+ void mscclpp::Bootstrap::groupBarrier
+ (const std::vector< int > &ranks)
+ groupBarrier
+ const std::vector< int > &
+ ranks
+
+
+
+
+
+
+
+
+
+ void
+ void mscclpp::Bootstrap::send
+ (const std::vector< char > &data, int peer, int tag)
+ send
+ const std::vector< char > &
+ data
+
+ int
+ peer
+
+ int
+ tag
+
+
+
+
+
+
+
+
+
+ void
+ void mscclpp::Bootstrap::recv
+ (std::vector< char > &data, int peer, int tag)
+ recv
+ std::vector< char > &
+ data
+
+ int
+ peer
+
+ int
+ tag
+
+
+
+
+
+
+
+
+
+
+Base class for bootstraps.
+
+
+
+
+
+ mscclpp::Bootstrap
+
+
+ mscclpp::TcpBootstrap
+
+
+
+
+
+ mscclpp::Bootstrap allGather mscclpp::Bootstrap barrier mscclpp::Bootstrap Bootstrap mscclpp::Bootstrap getNranks mscclpp::Bootstrap getNranksPerNode mscclpp::Bootstrap getRank mscclpp::Bootstrap groupBarrier mscclpp::Bootstrap recv mscclpp::Bootstrap recv mscclpp::Bootstrap send mscclpp::Bootstrap send mscclpp::Bootstrap ~Bootstrap
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1Communicator.xml b/docs/doxygen/xml/classmscclpp_1_1Communicator.xml
new file mode 100644
index 00000000..9a775fee
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1Communicator.xml
@@ -0,0 +1,451 @@
+
+
+
+ mscclpp::Communicator
+ core.hpp
+
+
+ std::unique_ptr< Impl >
+ std::unique_ptr<Impl> mscclpp::Communicator::pimpl_
+ pimpl_
+
+
+
+
+
+
+
+
+
+
+ mscclpp::Communicator::Communicator
+ (std::shared_ptr< Bootstrap > bootstrap, std::shared_ptr< Context > context=nullptr)
+ Communicator
+ std::shared_ptr< [Bootstrap] >
+ bootstrap
+
+ std::shared_ptr< [Context] >
+ context
+ nullptr
+
+
+
+
+Initializes the communicator with a given bootstrap implementation.
+
+
+bootstrap
+
+
+An implementation of the [Bootstrap] that the communicator will use.
+
+
+
+
+context
+
+
+An optional context to use for the communicator. If not provided, a new context will be created.
+
+
+
+
+
+
+
+ mscclpp::Communicator::~Communicator
+ ()
+ ~Communicator
+
+Destroy the communicator.
+
+
+
+
+
+
+
+ std::shared_ptr< [Bootstrap] >
+ std::shared_ptr<Bootstrap> mscclpp::Communicator::bootstrap
+ ()
+ bootstrap
+
+
+
+Returns the bootstrap held by this communicator.
+std::shared_ptr<Bootstrap> The bootstrap held by this communicator.
+
+
+
+
+
+ std::shared_ptr< [Context] >
+ std::shared_ptr<Context> mscclpp::Communicator::context
+ ()
+ context
+
+
+
+Returns the context held by this communicator.
+std::shared_ptr<Context> The context held by this communicator.
+
+
+
+
+
+ [RegisteredMemory]RegisteredMemory mscclpp::Communicator::registerMemory
+ (void *ptr, size_t size, TransportFlags transports)
+ registerMemory
+ void *
+ ptr
+
+ size_t
+ size
+
+ [TransportFlags]transports
+
+
+
+
+Register a region of GPU memory for use in this communicator's context.
+
+
+ptr
+
+
+Base pointer to the memory.
+
+
+
+
+size
+
+
+Size of the memory region in bytes.
+
+
+
+
+transports
+
+
+Transport flags.
+
+
+[RegisteredMemory] A handle to the buffer.
+
+
+
+
+ void
+ void mscclpp::Communicator::sendMemoryOnSetup
+ (RegisteredMemory memory, int remoteRank, int tag)
+ sendMemoryOnSetup
+ [RegisteredMemory]memory
+
+ int
+ remoteRank
+
+ int
+ tag
+
+
+
+
+Send information of a registered memory to the remote side on setup.
+This function registers a send to a remote process that will happen by a following call of [setup()]. The send will carry information about a registered memory on the local process.
+
+
+memory
+
+
+The registered memory buffer to send information about.
+
+
+
+
+remoteRank
+
+
+The rank of the remote process.
+
+
+
+
+tag
+
+
+The tag to use for identifying the send.
+
+
+
+
+
+
+
+ [NonblockingFuture]< [RegisteredMemory] >NonblockingFuture<RegisteredMemory> mscclpp::Communicator::recvMemoryOnSetup
+ (int remoteRank, int tag)
+ recvMemoryOnSetup
+ int
+ remoteRank
+
+ int
+ tag
+
+
+
+
+Receive memory on setup.
+This function registers a receive from a remote process that will happen by a following call of [setup()]. The receive will carry information about a registered memory on the remote process.
+
+
+remoteRank
+
+
+The rank of the remote process.
+
+
+
+
+tag
+
+
+The tag to use for identifying the receive.
+
+
+NonblockingFuture<RegisteredMemory> A non-blocking future of registered memory.
+
+
+
+
+
+ [NonblockingFuture]< std::shared_ptr< [Connection] > >NonblockingFuture<std::shared_ptr<Connection> > mscclpp::Communicator::connectOnSetup
+ (int remoteRank, int tag, EndpointConfig localConfig)
+ connectOnSetup
+ int
+ remoteRank
+
+ int
+ tag
+
+ [EndpointConfig]localConfig
+
+
+
+
+Connect to a remote rank on setup.
+This function only prepares metadata for connection. The actual connection is made by a following call of [setup()]. Note that this function is two-way and a connection from rank i to remote rank j needs to have a counterpart from rank j to rank i . Note that with IB, buffers are registered at a page level and if a buffer is spread through multiple pages and do not fully utilize all of them, IB's QP has to register for all involved pages. This potentially has security risks if the connection's accesses are given to a malicious process.
+
+
+remoteRank
+
+
+The rank of the remote process.
+
+
+
+
+tag
+
+
+The tag of the connection for identifying it.
+
+
+
+
+config
+
+
+The configuration for the local endpoint.
+
+
+[NonblockingFuture]<[NonblockingFuture]<std::shared_ptr<Connection>>> A non-blocking future of shared pointer to the connection.
+
+
+
+
+ int
+ int mscclpp::Communicator::remoteRankOf
+ (const Connection &connection)
+ remoteRankOf
+ const [Connection] &
+ connection
+
+
+
+
+Get the remote rank a connection is connected to.
+
+
+connection
+
+
+The connection to get the remote rank for.
+
+
+The remote rank the connection is connected to.
+
+
+
+
+
+ int
+ int mscclpp::Communicator::tagOf
+ (const Connection &connection)
+ tagOf
+ const [Connection] &
+ connection
+
+
+
+
+Get the tag a connection was made with.
+
+
+connection
+
+
+The connection to get the tag for.
+
+
+The tag the connection was made with.
+
+
+
+
+
+ void
+ void mscclpp::Communicator::onSetup
+ (std::shared_ptr< Setuppable > setuppable)
+ onSetup
+ std::shared_ptr< [Setuppable] >
+ setuppable
+
+
+
+
+Add a custom [Setuppable] object to a list of objects to be setup later, when [setup()] is called.
+
+
+setuppable
+
+
+A shared pointer to the [Setuppable] object.
+
+
+
+
+
+
+
+ void
+ void mscclpp::Communicator::setup
+ ()
+ setup
+
+
+
+Setup all objects that have registered for setup.
+This includes previous calls of [sendMemoryOnSetup()], [recvMemoryOnSetup()], [connectOnSetup()], and [onSetup()]. It is allowed to call this function multiple times, where the n-th call will only setup objects that have been registered after the (n-1)-th call.
+
+
+
+
+
+
+
+
+A class that sets up all registered memories and connections between processes.
+A typical way to use this class:
+Call [connectOnSetup()] to declare connections between the calling process with other processes.
+Call [registerMemory()] to register memory regions that will be used for communication.
+Call [sendMemoryOnSetup()] or [recvMemoryOnSetup()] to send/receive registered memory regions to/from other processes.
+Call [setup()] to set up all registered memories and connections declared in the previous steps.
+Call [NonblockingFuture<RegisteredMemory>::get()] to get the registered memory regions received from other processes.
+All done; use connections and registered memories to build channels.
+
+
+
+
+ mscclpp::Communicator bootstrap mscclpp::Communicator Communicator mscclpp::Communicator connectOnSetup mscclpp::Communicator context mscclpp::Communicator onSetup mscclpp::Communicator pimpl_ mscclpp::Communicator recvMemoryOnSetup mscclpp::Communicator registerMemory mscclpp::Communicator remoteRankOf mscclpp::Communicator sendMemoryOnSetup mscclpp::Communicator setup mscclpp::Communicator tagOf mscclpp::Communicator ~Communicator
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1Connection.xml b/docs/doxygen/xml/classmscclpp_1_1Connection.xml
new file mode 100644
index 00000000..2606a824
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1Connection.xml
@@ -0,0 +1,285 @@
+
+
+
+ mscclpp::Connection
+ core.hpp
+
+
+ virtual mscclpp::Connection::~Connection
+ ()=default
+ ~Connection
+
+
+
+
+
+
+
+
+ void
+ virtual void mscclpp::Connection::write
+ (RegisteredMemory dst, uint64_t dstOffset, RegisteredMemory src, uint64_t srcOffset, uint64_t size)=0
+ write
+ [RegisteredMemory]dst
+
+ uint64_t
+ dstOffset
+
+ [RegisteredMemory]src
+
+ uint64_t
+ srcOffset
+
+ uint64_t
+ size
+
+
+
+
+Write data from a source [RegisteredMemory] to a destination [RegisteredMemory].
+
+
+dst
+
+
+The destination [RegisteredMemory].
+
+
+
+
+dstOffset
+
+
+The offset in bytes from the start of the destination [RegisteredMemory].
+
+
+
+
+src
+
+
+The source [RegisteredMemory].
+
+
+
+
+srcOffset
+
+
+The offset in bytes from the start of the source [RegisteredMemory].
+
+
+
+
+size
+
+
+The number of bytes to write.
+
+
+
+
+
+
+
+ void
+ virtual void mscclpp::Connection::updateAndSync
+ (RegisteredMemory dst, uint64_t dstOffset, uint64_t *src, uint64_t newValue)=0
+ updateAndSync
+ [RegisteredMemory]dst
+
+ uint64_t
+ dstOffset
+
+ uint64_t *
+ src
+
+ uint64_t
+ newValue
+
+
+
+
+Update a 8-byte value in a destination [RegisteredMemory] and synchronize the change with the remote process.
+
+
+dst
+
+
+The destination [RegisteredMemory].
+
+
+
+
+dstOffset
+
+
+The offset in bytes from the start of the destination [RegisteredMemory].
+
+
+
+
+src
+
+
+A pointer to the value to update.
+
+
+
+
+newValue
+
+
+The new value to write.
+
+
+
+
+
+
+
+ void
+ virtual void mscclpp::Connection::flush
+ (int64_t timeoutUsec=3e7)=0
+ flush
+ int64_t
+ timeoutUsec
+ 3e7
+
+
+Flush any pending writes to the remote process.
+
+
+
+
+
+
+
+ [Transport]virtual Transport mscclpp::Connection::transport
+ ()=0
+ transport
+
+
+
+Get the transport used by the local process.
+The transport used by the local process.
+
+
+
+
+
+ [Transport]virtual Transport mscclpp::Connection::remoteTransport
+ ()=0
+ remoteTransport
+
+
+
+Get the transport used by the remote process.
+The transport used by the remote process.
+
+
+
+
+
+ std::string
+ std::string mscclpp::Connection::getTransportName
+ ()
+ getTransportName
+
+
+
+Get the name of the transport used for this connection
+name of [transport()] -> [remoteTransport()]
+
+
+
+
+
+
+
+ std::shared_ptr< RegisteredMemory::Impl >
+ static std::shared_ptr<RegisteredMemory::Impl> mscclpp::Connection::getImpl
+ (RegisteredMemory &memory)
+ getImpl
+ [RegisteredMemory] &memory
+
+
+
+
+
+
+
+
+
+ std::shared_ptr< Endpoint::Impl >
+ static std::shared_ptr<Endpoint::Impl> mscclpp::Connection::getImpl
+ (Endpoint &memory)
+ getImpl
+ [Endpoint] &memory
+
+
+
+
+
+
+
+
+
+
+Represents a connection between two processes.
+
+
+
+
+ mscclpp::Connection flush mscclpp::Connection getImpl mscclpp::Connection getImpl mscclpp::Connection getTransportName mscclpp::Connection remoteTransport mscclpp::Connection transport mscclpp::Connection updateAndSync mscclpp::Connection write mscclpp::Connection ~Connection
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1Context.xml b/docs/doxygen/xml/classmscclpp_1_1Context.xml
new file mode 100644
index 00000000..50c898c2
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1Context.xml
@@ -0,0 +1,230 @@
+
+
+
+ mscclpp::Context
+ core.hpp
+
+
+ std::unique_ptr< Impl >
+ std::unique_ptr<Impl> mscclpp::Context::pimpl_
+ pimpl_
+
+
+
+
+
+
+
+
+
+
+ friend class
+ friend class RegisteredMemory
+ RegisteredMemory
+
+
+
+
+
+
+
+
+ friend class
+ friend class Endpoint
+ Endpoint
+
+
+
+
+
+
+
+
+
+
+ mscclpp::Context::Context
+ ()
+ Context
+
+Create a context.
+
+
+
+
+
+
+
+ mscclpp::Context::~Context
+ ()
+ ~Context
+
+Destroy the context.
+
+
+
+
+
+
+
+ [RegisteredMemory]RegisteredMemory mscclpp::Context::registerMemory
+ (void *ptr, size_t size, TransportFlags transports)
+ registerMemory
+ void *
+ ptr
+
+ size_t
+ size
+
+ [TransportFlags]transports
+
+
+
+
+Register a region of GPU memory for use in this context.
+
+
+ptr
+
+
+Base pointer to the memory.
+
+
+
+
+size
+
+
+Size of the memory region in bytes.
+
+
+
+
+transports
+
+
+Transport flags.
+
+
+[RegisteredMemory] A handle to the buffer.
+
+
+
+
+ [Endpoint]Endpoint mscclpp::Context::createEndpoint
+ (EndpointConfig config)
+ createEndpoint
+ [EndpointConfig]config
+
+
+
+
+Create an endpoint for establishing connections.
+
+
+config
+
+
+The configuration for the endpoint.
+
+
+The newly created endpoint.
+
+
+
+
+
+ std::shared_ptr< [Connection] >
+ std::shared_ptr<Connection> mscclpp::Context::connect
+ (Endpoint localEndpoint, Endpoint remoteEndpoint)
+ connect
+ [Endpoint]localEndpoint
+
+ [Endpoint]remoteEndpoint
+
+
+
+
+Establish a connection between two endpoints. While this method immediately returns a connection object, the connection is only safe to use after the corresponding connection on the remote endpoint has been established. This method must be called on both endpoints to establish a connection.
+
+
+localEndpoint
+
+
+The local endpoint.
+
+
+
+
+remoteEndpoint
+
+
+The remote endpoint.
+
+
+std::shared_ptr<Connection> A shared pointer to the connection.
+
+
+
+
+
+
+
+
+Represents a context for communication. This provides a low-level interface for forming connections in use-cases where the process group abstraction offered by [Communicator] is not suitable, e.g., ephemeral client-server connections. Correct use of this class requires external synchronization when finalizing connections with the [connect()] method.
+As an example, a client-server scenario where the server will write to the client might proceed as follows:
+The client creates an endpoint with [createEndpoint()] and sends it to the server.
+The server receives the client endpoint, creates its own endpoint with [createEndpoint()], sends it to the client, and creates a connection with [connect()].
+The client receives the server endpoint, creates a connection with [connect()] and sends a [RegisteredMemory] to the server.
+The server receives the [RegisteredMemory] and writes to it using the previously created connection. The client waiting to create a connection before sending the [RegisteredMemory] ensures that the server can not write to the [RegisteredMemory] before the connection is established.
+
+
+While some transports may have more relaxed implementation behavior, this should not be relied upon.
+
+
+ mscclpp::Context connect mscclpp::Context Context mscclpp::Context createEndpoint mscclpp::Context Endpoint mscclpp::Context pimpl_ mscclpp::Context RegisteredMemory mscclpp::Context registerMemory mscclpp::Context ~Context
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1CuError.xml b/docs/doxygen/xml/classmscclpp_1_1CuError.xml
new file mode 100644
index 00000000..d0d9eeff
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1CuError.xml
@@ -0,0 +1,95 @@
+
+
+
+ mscclpp::CuError
+ mscclpp::BaseError
+ errors.hpp
+
+
+ mscclpp::CuError::CuError
+ (const std::string &message, int errorCode)
+ CuError
+ const std::string &
+ message
+
+ int
+ errorCode
+
+
+
+
+
+
+
+
+
+ virtual mscclpp::CuError::~CuError
+ ()=default
+ ~CuError
+
+
+
+
+
+
+
+
+
+An error from a CUDA driver library call.
+
+
+
+
+
+ std::runtime_error
+
+
+ mscclpp::BaseError
+
+
+
+
+ mscclpp::CuError
+
+
+
+
+
+
+ std::runtime_error
+
+
+ mscclpp::BaseError
+
+
+
+
+ mscclpp::CuError
+
+
+
+
+
+ mscclpp::CuError BaseError mscclpp::CuError BaseError mscclpp::CuError CuError mscclpp::CuError errorCode_ mscclpp::CuError getErrorCode mscclpp::CuError message_ mscclpp::CuError what mscclpp::CuError ~BaseError mscclpp::CuError ~CuError
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1CudaError.xml b/docs/doxygen/xml/classmscclpp_1_1CudaError.xml
new file mode 100644
index 00000000..3ae674c3
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1CudaError.xml
@@ -0,0 +1,95 @@
+
+
+
+ mscclpp::CudaError
+ mscclpp::BaseError
+ errors.hpp
+
+
+ mscclpp::CudaError::CudaError
+ (const std::string &message, int errorCode)
+ CudaError
+ const std::string &
+ message
+
+ int
+ errorCode
+
+
+
+
+
+
+
+
+
+ virtual mscclpp::CudaError::~CudaError
+ ()=default
+ ~CudaError
+
+
+
+
+
+
+
+
+
+An error from a CUDA runtime library call.
+
+
+
+
+
+ mscclpp::CudaError
+
+
+
+
+ std::runtime_error
+
+
+ mscclpp::BaseError
+
+
+
+
+
+
+ mscclpp::CudaError
+
+
+
+
+ std::runtime_error
+
+
+ mscclpp::BaseError
+
+
+
+
+
+ mscclpp::CudaError BaseError mscclpp::CudaError BaseError mscclpp::CudaError CudaError mscclpp::CudaError errorCode_ mscclpp::CudaError getErrorCode mscclpp::CudaError message_ mscclpp::CudaError what mscclpp::CudaError ~BaseError mscclpp::CudaError ~CudaError
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1Endpoint.xml b/docs/doxygen/xml/classmscclpp_1_1Endpoint.xml
new file mode 100644
index 00000000..f96ba0ee
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1Endpoint.xml
@@ -0,0 +1,167 @@
+
+
+
+ mscclpp::Endpoint
+ core.hpp
+
+
+ std::shared_ptr< Impl >
+ std::shared_ptr<Impl> mscclpp::Endpoint::pimpl_
+ pimpl_
+
+
+
+
+
+
+
+
+
+
+ friend class
+ friend class Context
+ Context
+
+
+
+
+
+
+
+
+ friend class
+ friend class Connection
+ Connection
+
+
+
+
+
+
+
+
+
+
+ mscclpp::Endpoint::Endpoint
+ ()=default
+ Endpoint
+
+Default constructor.
+
+
+
+
+
+
+
+ [Transport]Transport mscclpp::Endpoint::transport
+ ()
+ transport
+
+
+
+Get the transport used.
+The transport used.
+
+
+
+
+
+ std::vector< char >
+ std::vector<char> mscclpp::Endpoint::serialize
+ ()
+ serialize
+
+
+
+Serialize the [Endpoint] object to a vector of characters.
+A vector of characters representing the serialized [Endpoint] object.
+
+
+
+
+
+
+
+ [Endpoint]static Endpoint mscclpp::Endpoint::deserialize
+ (const std::vector< char > &data)
+ deserialize
+ const std::vector< char > &
+ data
+
+
+
+
+Deserialize a [Endpoint] object from a vector of characters.
+
+
+data
+
+
+A vector of characters representing a serialized [Endpoint] object.
+
+
+A deserialized [Endpoint] object.
+
+
+
+
+
+
+
+ mscclpp::Endpoint::Endpoint
+ (std::shared_ptr< Impl > pimpl)
+ Endpoint
+ std::shared_ptr< Impl >
+ pimpl
+
+
+
+
+
+
+
+
+
+
+Represents one end of a connection.
+
+
+
+
+ mscclpp::Endpoint Connection mscclpp::Endpoint Context mscclpp::Endpoint deserialize mscclpp::Endpoint Endpoint mscclpp::Endpoint Endpoint mscclpp::Endpoint pimpl_ mscclpp::Endpoint serialize mscclpp::Endpoint transport
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1Error.xml b/docs/doxygen/xml/classmscclpp_1_1Error.xml
new file mode 100644
index 00000000..b15a275b
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1Error.xml
@@ -0,0 +1,108 @@
+
+
+
+ mscclpp::Error
+ mscclpp::BaseError
+ errors.hpp
+
+
+ mscclpp::Error::Error
+ (const std::string &message, ErrorCode errorCode)
+ Error
+ const std::string &
+ message
+
+ [ErrorCode]errorCode
+
+
+
+
+
+
+
+
+
+ virtual mscclpp::Error::~Error
+ ()=default
+ ~Error
+
+
+
+
+
+
+
+
+ [ErrorCode]ErrorCode mscclpp::Error::getErrorCode
+ () const
+ getErrorCode
+
+
+
+
+
+
+
+
+
+A generic error.
+
+
+
+
+
+ std::runtime_error
+
+
+ mscclpp::Error
+
+
+
+
+ mscclpp::BaseError
+
+
+
+
+
+
+ std::runtime_error
+
+
+ mscclpp::Error
+
+
+
+
+ mscclpp::BaseError
+
+
+
+
+
+ mscclpp::Error BaseError mscclpp::Error BaseError mscclpp::Error Error mscclpp::Error errorCode_ mscclpp::Error getErrorCode mscclpp::Error message_ mscclpp::Error what mscclpp::Error ~BaseError mscclpp::Error ~Error
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1ExecutionPlan.xml b/docs/doxygen/xml/classmscclpp_1_1ExecutionPlan.xml
new file mode 100644
index 00000000..a5602193
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1ExecutionPlan.xml
@@ -0,0 +1,84 @@
+
+
+
+ mscclpp::ExecutionPlan
+ executor.hpp
+
+
+ std::shared_ptr< Impl >
+ std::shared_ptr<Impl> mscclpp::ExecutionPlan::impl_
+ impl_
+
+
+
+
+
+
+
+
+
+
+ friend class
+ friend class Executor
+ Executor
+
+
+
+
+
+
+
+
+
+
+ mscclpp::ExecutionPlan::ExecutionPlan
+ (const std::string &name, const std::string &planPath)
+ ExecutionPlan
+ const std::string &
+ name
+
+ const std::string &
+ planPath
+
+
+
+
+
+
+
+
+
+ mscclpp::ExecutionPlan::~ExecutionPlan
+ ()=default
+ ~ExecutionPlan
+
+
+
+
+
+
+
+
+
+
+
+
+
+ mscclpp::ExecutionPlan ExecutionPlan mscclpp::ExecutionPlan Executor mscclpp::ExecutionPlan impl_ mscclpp::ExecutionPlan ~ExecutionPlan
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1Executor.xml b/docs/doxygen/xml/classmscclpp_1_1Executor.xml
new file mode 100644
index 00000000..3650fc9b
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1Executor.xml
@@ -0,0 +1,149 @@
+
+
+
+ mscclpp::Executor
+ executor.hpp
+
+
+ std::unique_ptr< Impl >
+ std::unique_ptr<Impl> mscclpp::Executor::impl_
+ impl_
+
+
+
+
+
+
+
+
+
+
+ mscclpp::Executor::Executor
+ (std::shared_ptr< Communicator > comm)
+ Executor
+ std::shared_ptr< [Communicator] >
+ comm
+
+
+
+
+
+
+
+
+
+ mscclpp::Executor::Executor
+ (const Executor &)=delete
+ Executor
+ const [Executor] &
+
+
+
+
+
+
+
+
+
+ [Executor] &Executor& mscclpp::Executor::operator=
+ (const Executor &)=delete
+ operator=
+ const [Executor] &
+
+
+
+
+
+
+
+
+
+ mscclpp::Executor::~Executor
+ ()
+ ~Executor
+
+
+
+
+
+
+
+
+ void
+ void mscclpp::Executor::execute
+ (int rank, void *sendbuff, void *recvBuff, size_t sendBuffSize, size_t recvBuffSize, DataType dataType, const ExecutionPlan &plan, cudaStream_t stream, PacketType packetType=PacketType::LL16)
+ execute
+ int
+ rank
+
+ void *
+ sendbuff
+
+ void *
+ recvBuff
+
+ size_t
+ sendBuffSize
+
+ size_t
+ recvBuffSize
+
+ [DataType]dataType
+
+ const [ExecutionPlan] &
+ plan
+
+ cudaStream_t
+ stream
+
+ [PacketType]packetType
+ [PacketType::LL16]
+
+
+
+
+
+
+
+
+
+
+
+
+ mscclpp::Executor execute mscclpp::Executor Executor mscclpp::Executor Executor mscclpp::Executor impl_ mscclpp::Executor operator= mscclpp::Executor ~Executor
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1Fifo.xml b/docs/doxygen/xml/classmscclpp_1_1Fifo.xml
new file mode 100644
index 00000000..2959c306
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1Fifo.xml
@@ -0,0 +1,173 @@
+
+
+
+ mscclpp::Fifo
+ fifo.hpp
+
+
+ std::unique_ptr< Impl >
+ std::unique_ptr<Impl> mscclpp::Fifo::pimpl
+ pimpl
+
+
+
+
+
+
+
+
+
+
+ mscclpp::Fifo::Fifo
+ (int size=DEFAULT_FIFO_SIZE)
+ Fifo
+ int
+ size
+ [DEFAULT_FIFO_SIZE]
+
+
+Constructs a new [Fifo] object.
+
+size
+
+
+The number of entires in the FIFO.
+
+
+
+
+
+
+
+
+ mscclpp::Fifo::~Fifo
+ ()
+ ~Fifo
+
+Destroys the [Fifo] object.
+
+
+
+
+
+
+
+ [ProxyTrigger]ProxyTrigger mscclpp::Fifo::poll
+ ()
+ poll
+
+
+
+Polls the FIFO for a trigger.
+Returns [ProxyTrigger] which is the trigger at the head of fifo.
+
+
+
+
+
+ void
+ void mscclpp::Fifo::pop
+ ()
+ pop
+
+Pops a trigger from the FIFO.
+
+
+
+
+
+
+
+ void
+ void mscclpp::Fifo::flushTail
+ (bool sync=false)
+ flushTail
+ bool
+ sync
+ false
+
+
+
+
+Flushes the tail of the FIFO.
+
+
+sync
+
+
+If true, waits for the flush to complete before returning.
+
+
+
+
+
+
+
+ int
+ int mscclpp::Fifo::size
+ () const
+ size
+
+
+
+Return the FIFO size. The FIFO size.
+
+
+
+
+
+
+ [FifoDeviceHandle]FifoDeviceHandle mscclpp::Fifo::deviceHandle
+ ()
+ deviceHandle
+
+
+
+Returns a [FifoDeviceHandle] object representing the device FIFO.
+A [FifoDeviceHandle] object representing the device FIFO.
+
+
+
+
+
+
+A class representing a host proxy FIFO that can consume work elements pushed by device threads.
+
+
+
+
+ mscclpp::Fifo deviceHandle mscclpp::Fifo Fifo mscclpp::Fifo flushTail mscclpp::Fifo pimpl mscclpp::Fifo poll mscclpp::Fifo pop mscclpp::Fifo size mscclpp::Fifo ~Fifo
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1Host2DeviceSemaphore.xml b/docs/doxygen/xml/classmscclpp_1_1Host2DeviceSemaphore.xml
new file mode 100644
index 00000000..a3f47992
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1Host2DeviceSemaphore.xml
@@ -0,0 +1,174 @@
+
+
+
+ mscclpp::Host2DeviceSemaphore
+ mscclpp::BaseSemaphore< CudaDeleter, std::default_delete >
+ semaphore.hpp
+
+
+ [Host2DeviceSemaphoreDeviceHandle]using mscclpp::Host2DeviceSemaphore::DeviceHandle = Host2DeviceSemaphoreDeviceHandle
+ DeviceHandle
+
+Device-side handle for [Host2DeviceSemaphore].
+
+
+
+
+
+
+
+
+
+ std::shared_ptr< [Connection] >
+ std::shared_ptr<Connection> mscclpp::Host2DeviceSemaphore::connection_
+ connection_
+
+
+
+
+
+
+
+
+
+
+ mscclpp::Host2DeviceSemaphore::Host2DeviceSemaphore
+ (Communicator &communicator, std::shared_ptr< Connection > connection)
+ Host2DeviceSemaphore
+ [Communicator] &communicator
+
+ std::shared_ptr< [Connection] >
+ connection
+
+
+
+
+Constructor.
+
+communicator
+
+
+The communicator.
+
+
+
+
+connection
+
+
+The connection associated with this semaphore.
+
+
+
+
+
+
+
+
+ std::shared_ptr< [Connection] >
+ std::shared_ptr<Connection> mscclpp::Host2DeviceSemaphore::connection
+ ()
+ connection
+
+
+
+Returns the connection. The connection associated with this semaphore.
+
+
+
+
+
+
+ void
+ void mscclpp::Host2DeviceSemaphore::signal
+ ()
+ signal
+
+Signal the device.
+
+
+
+
+
+
+
+ [DeviceHandle]DeviceHandle mscclpp::Host2DeviceSemaphore::deviceHandle
+ ()
+ deviceHandle
+
+Returns the device-side handle.
+
+
+
+
+
+
+
+
+A semaphore for sending signals from the host to the device.
+
+
+
+
+
+ mscclpp::BaseSemaphore< CudaDeleter, std::default_delete >
+
+
+ mscclpp::Host2DeviceSemaphore
+
+
+
+
+
+
+ mscclpp::NonblockingFuture< mscclpp::RegisteredMemory >
+
+
+ mscclpp::BaseSemaphore< CudaDeleter, std::default_delete >
+
+ remoteInboundSemaphoreIdsRegMem_
+
+
+
+ mscclpp::Host2DeviceSemaphore
+
+
+
+
+
+ mscclpp::Host2DeviceSemaphore BaseSemaphore mscclpp::Host2DeviceSemaphore connection mscclpp::Host2DeviceSemaphore connection_ mscclpp::Host2DeviceSemaphore DeviceHandle mscclpp::Host2DeviceSemaphore deviceHandle mscclpp::Host2DeviceSemaphore expectedInboundSemaphore_ mscclpp::Host2DeviceSemaphore Host2DeviceSemaphore mscclpp::Host2DeviceSemaphore localInboundSemaphore_ mscclpp::Host2DeviceSemaphore outboundSemaphore_ mscclpp::Host2DeviceSemaphore remoteInboundSemaphoreIdsRegMem_ mscclpp::Host2DeviceSemaphore signal
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1Host2HostSemaphore.xml b/docs/doxygen/xml/classmscclpp_1_1Host2HostSemaphore.xml
new file mode 100644
index 00000000..e34efa32
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1Host2HostSemaphore.xml
@@ -0,0 +1,188 @@
+
+
+
+ mscclpp::Host2HostSemaphore
+ mscclpp::BaseSemaphore< std::default_delete, std::default_delete >
+ semaphore.hpp
+
+
+ std::shared_ptr< [Connection] >
+ std::shared_ptr<Connection> mscclpp::Host2HostSemaphore::connection_
+ connection_
+
+
+
+
+
+
+
+
+
+
+ mscclpp::Host2HostSemaphore::Host2HostSemaphore
+ (Communicator &communicator, std::shared_ptr< Connection > connection)
+ Host2HostSemaphore
+ [Communicator] &communicator
+
+ std::shared_ptr< [Connection] >
+ connection
+
+
+
+
+Constructor
+
+communicator
+
+
+The communicator.
+
+
+
+
+connection
+
+
+The connection associated with this semaphore. [Transport::CudaIpc] is not allowed for [Host2HostSemaphore].
+
+
+
+
+
+
+
+
+ std::shared_ptr< [Connection] >
+ std::shared_ptr<Connection> mscclpp::Host2HostSemaphore::connection
+ ()
+ connection
+
+
+
+Returns the connection. The connection associated with this semaphore.
+
+
+
+
+
+
+ void
+ void mscclpp::Host2HostSemaphore::signal
+ ()
+ signal
+
+Signal the remote host.
+
+
+
+
+
+
+
+ bool
+ bool mscclpp::Host2HostSemaphore::poll
+ ()
+ poll
+
+
+
+Check if the remote host has signaled. true if the remote host has signaled.
+
+
+
+
+
+
+ void
+ void mscclpp::Host2HostSemaphore::wait
+ (int64_t maxSpinCount=10000000)
+ wait
+ int64_t
+ maxSpinCount
+ 10000000
+
+
+
+
+Wait for the remote host to signal.
+
+maxSpinCount
+
+
+The maximum number of spin counts before throwing an exception. Never throws if negative.
+
+
+
+
+
+
+
+
+
+A semaphore for sending signals from the local host to a remote host.
+
+
+
+
+
+ mscclpp::BaseSemaphore< std::default_delete, std::default_delete >
+
+
+ mscclpp::Host2HostSemaphore
+
+
+
+
+
+
+ mscclpp::NonblockingFuture< mscclpp::RegisteredMemory >
+
+
+ mscclpp::BaseSemaphore< std::default_delete, std::default_delete >
+
+ remoteInboundSemaphoreIdsRegMem_
+
+
+
+ mscclpp::Host2HostSemaphore
+
+
+
+
+
+ mscclpp::Host2HostSemaphore BaseSemaphore mscclpp::Host2HostSemaphore connection mscclpp::Host2HostSemaphore connection_ mscclpp::Host2HostSemaphore expectedInboundSemaphore_ mscclpp::Host2HostSemaphore Host2HostSemaphore mscclpp::Host2HostSemaphore localInboundSemaphore_ mscclpp::Host2HostSemaphore outboundSemaphore_ mscclpp::Host2HostSemaphore poll mscclpp::Host2HostSemaphore remoteInboundSemaphoreIdsRegMem_ mscclpp::Host2HostSemaphore signal mscclpp::Host2HostSemaphore wait
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1IbError.xml b/docs/doxygen/xml/classmscclpp_1_1IbError.xml
new file mode 100644
index 00000000..b569d32d
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1IbError.xml
@@ -0,0 +1,95 @@
+
+
+
+ mscclpp::IbError
+ mscclpp::BaseError
+ errors.hpp
+
+
+ mscclpp::IbError::IbError
+ (const std::string &message, int errorCode)
+ IbError
+ const std::string &
+ message
+
+ int
+ errorCode
+
+
+
+
+
+
+
+
+
+ virtual mscclpp::IbError::~IbError
+ ()=default
+ ~IbError
+
+
+
+
+
+
+
+
+
+An error from an ibverbs library call.
+
+
+
+
+
+ std::runtime_error
+
+
+ mscclpp::IbError
+
+
+
+
+ mscclpp::BaseError
+
+
+
+
+
+
+ std::runtime_error
+
+
+ mscclpp::IbError
+
+
+
+
+ mscclpp::BaseError
+
+
+
+
+
+ mscclpp::IbError BaseError mscclpp::IbError BaseError mscclpp::IbError errorCode_ mscclpp::IbError getErrorCode mscclpp::IbError IbError mscclpp::IbError message_ mscclpp::IbError what mscclpp::IbError ~BaseError mscclpp::IbError ~IbError
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1NonblockingFuture.xml b/docs/doxygen/xml/classmscclpp_1_1NonblockingFuture.xml
new file mode 100644
index 00000000..6373eeb6
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1NonblockingFuture.xml
@@ -0,0 +1,127 @@
+
+
+
+ mscclpp::NonblockingFuture
+ core.hpp
+
+ typename T
+
+
+
+
+ std::shared_future< T >
+ std::shared_future<T> mscclpp::NonblockingFuture< T >::future
+ future
+
+
+
+
+
+
+
+
+
+
+ mscclpp::NonblockingFuture< T >::NonblockingFuture
+ ()=default
+ NonblockingFuture
+
+Default constructor.
+
+
+
+
+
+
+
+ mscclpp::NonblockingFuture< T >::NonblockingFuture
+ (std::shared_future< T > &&future)
+ NonblockingFuture
+ std::shared_future< T > &&
+ future
+
+
+
+
+Constructor that takes a shared future and moves it into the [NonblockingFuture].
+
+
+future
+
+
+The shared future to move.
+
+
+
+
+
+
+
+ bool
+ bool mscclpp::NonblockingFuture< T >::ready
+ () const
+ ready
+
+
+
+Check if the value is ready to be retrieved.
+True if the value is ready, false otherwise.
+
+
+
+
+
+ T
+ T mscclpp::NonblockingFuture< T >::get
+ () const
+ get
+
+
+
+Get the value.
+The value.
+
+
+[Error]
+
+if the value is not ready.
+
+
+
+
+
+
+
+
+A non-blocking future that can be used to check if a value is ready and retrieve it.
+
+
+
+
+ mscclpp::NonblockingFuture future mscclpp::NonblockingFuture get mscclpp::NonblockingFuture NonblockingFuture mscclpp::NonblockingFuture NonblockingFuture mscclpp::NonblockingFuture ready
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1NvlsConnection.xml b/docs/doxygen/xml/classmscclpp_1_1NvlsConnection.xml
new file mode 100644
index 00000000..c2573dc3
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1NvlsConnection.xml
@@ -0,0 +1,204 @@
+
+
+
+ mscclpp::NvlsConnection
+ nvls.hpp
+ mscclpp::NvlsConnection::DeviceMulticastPointer
+
+
+ const int
+ const int mscclpp::NvlsConnection::DefaultNvlsBufferSize
+ DefaultNvlsBufferSize
+
+
+
+
+
+
+
+
+
+
+ std::shared_ptr< Impl >
+ std::shared_ptr<Impl> mscclpp::NvlsConnection::pimpl_
+ pimpl_
+
+
+
+
+
+
+
+
+
+
+ mscclpp::NvlsConnection::NvlsConnection
+ (size_t bufferSize, int numDevices)
+ NvlsConnection
+ size_t
+ bufferSize
+
+ int
+ numDevices
+
+
+
+
+
+
+
+
+
+ mscclpp::NvlsConnection::NvlsConnection
+ (const std::vector< char > &data)
+ NvlsConnection
+ const std::vector< char > &
+ data
+
+
+
+
+
+
+
+
+
+ mscclpp::NvlsConnection::NvlsConnection
+ ()=delete
+ NvlsConnection
+
+
+
+
+
+
+
+
+ std::vector< char >
+ std::vector<char> mscclpp::NvlsConnection::serialize
+ ()
+ serialize
+
+
+
+
+
+
+
+
+ void
+ void mscclpp::NvlsConnection::addDevice
+ ()
+ addDevice
+
+
+
+
+
+
+
+
+ void
+ void mscclpp::NvlsConnection::addDevice
+ (int cudaDeviceId)
+ addDevice
+ int
+ cudaDeviceId
+
+
+
+
+
+
+
+
+
+ std::shared_ptr< [DeviceMulticastPointer] >
+ std::shared_ptr<DeviceMulticastPointer> mscclpp::NvlsConnection::allocateAndBindCuda
+ (size_t size)
+ allocateAndBindCuda
+ size_t
+ size
+
+
+
+
+
+
+
+
+
+ std::shared_ptr< char >
+ std::shared_ptr<char> mscclpp::NvlsConnection::bindAllocatedCuda
+ (CUmemGenericAllocationHandle memHandle, size_t size)
+ bindAllocatedCuda
+ CUmemGenericAllocationHandle
+ memHandle
+
+ size_t
+ size
+
+
+
+
+The handle to the allocation (its lifetime is managed by the caller) and the size of the allocation.
+
+
+
+
+
+ size_t
+ size_t mscclpp::NvlsConnection::getMultiCastMinGranularity
+ ()
+ getMultiCastMinGranularity
+
+
+
+
+
+
+
+
+
+
+
+
+
+ mscclpp::NvlsConnection addDevice mscclpp::NvlsConnection addDevice mscclpp::NvlsConnection allocateAndBindCuda mscclpp::NvlsConnection bindAllocatedCuda mscclpp::NvlsConnection DefaultNvlsBufferSize mscclpp::NvlsConnection getMultiCastMinGranularity mscclpp::NvlsConnection NvlsConnection mscclpp::NvlsConnection NvlsConnection mscclpp::NvlsConnection NvlsConnection mscclpp::NvlsConnection pimpl_ mscclpp::NvlsConnection serialize
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1Proxy.xml b/docs/doxygen/xml/classmscclpp_1_1Proxy.xml
new file mode 100644
index 00000000..a7bb34ec
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1Proxy.xml
@@ -0,0 +1,141 @@
+
+
+
+ mscclpp::Proxy
+ proxy.hpp
+
+
+ std::unique_ptr< Impl >
+ std::unique_ptr<Impl> mscclpp::Proxy::pimpl
+ pimpl
+
+
+
+
+
+
+
+
+
+
+ mscclpp::Proxy::Proxy
+ (ProxyHandler handler, std::function< void()> threadInit, size_t fifoSize=DEFAULT_FIFO_SIZE)
+ Proxy
+ [ProxyHandler]handler
+
+ std::function< void()>
+ threadInit
+
+ size_t
+ fifoSize
+ [DEFAULT_FIFO_SIZE]
+
+
+
+
+
+
+
+ mscclpp::Proxy::Proxy
+ (ProxyHandler handler, size_t fifoSize=DEFAULT_FIFO_SIZE)
+ Proxy
+ [ProxyHandler]handler
+
+ size_t
+ fifoSize
+ [DEFAULT_FIFO_SIZE]
+
+
+
+
+
+
+
+ mscclpp::Proxy::~Proxy
+ ()
+ ~Proxy
+
+
+
+
+
+
+
+
+ void
+ void mscclpp::Proxy::start
+ ()
+ start
+
+
+
+
+
+
+
+
+ void
+ void mscclpp::Proxy::stop
+ ()
+ stop
+
+
+
+
+
+
+
+
+ [Fifo] &Fifo& mscclpp::Proxy::fifo
+ ()
+ fifo
+
+
+
+This is a concurrent fifo which is multiple threads from the device can produce for and the sole proxy thread consumes it. the fifo
+
+
+
+
+
+
+
+
+
+
+
+ mscclpp::Proxy fifo mscclpp::Proxy pimpl mscclpp::Proxy Proxy mscclpp::Proxy Proxy mscclpp::Proxy start mscclpp::Proxy stop mscclpp::Proxy ~Proxy
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1ProxyService.xml b/docs/doxygen/xml/classmscclpp_1_1ProxyService.xml
new file mode 100644
index 00000000..394f816d
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1ProxyService.xml
@@ -0,0 +1,342 @@
+
+
+
+ mscclpp::ProxyService
+ mscclpp::BaseProxyService
+ proxy_channel.hpp
+
+
+ std::vector< std::shared_ptr< [Host2DeviceSemaphore] > >
+ std::vector<std::shared_ptr<Host2DeviceSemaphore> > mscclpp::ProxyService::semaphores_
+ semaphores_
+
+
+
+
+
+
+
+
+ std::vector< [RegisteredMemory] >
+ std::vector<RegisteredMemory> mscclpp::ProxyService::memories_
+ memories_
+
+
+
+
+
+
+
+
+ std::shared_ptr< [Proxy] >
+ std::shared_ptr<Proxy> mscclpp::ProxyService::proxy_
+ proxy_
+
+
+
+
+
+
+
+
+ int
+ int mscclpp::ProxyService::deviceNumaNode
+ deviceNumaNode
+
+
+
+
+
+
+
+
+
+
+ mscclpp::ProxyService::ProxyService
+ (size_t fifoSize=DEFAULT_FIFO_SIZE)
+ ProxyService
+ size_t
+ fifoSize
+ [DEFAULT_FIFO_SIZE]
+Constructor.
+
+
+
+
+
+
+
+ [SemaphoreId]SemaphoreId mscclpp::ProxyService::buildAndAddSemaphore
+ (Communicator &communicator, std::shared_ptr< Connection > connection)
+ buildAndAddSemaphore
+ [Communicator] &communicator
+
+ std::shared_ptr< [Connection] >
+ connection
+
+
+
+
+Build and add a semaphore to the proxy service.
+
+connection
+
+
+The connection associated with the semaphore.
+
+
+The ID of the semaphore.
+
+
+
+
+
+
+ [SemaphoreId]SemaphoreId mscclpp::ProxyService::addSemaphore
+ (std::shared_ptr< Host2DeviceSemaphore > semaphore)
+ addSemaphore
+ std::shared_ptr< [Host2DeviceSemaphore] >
+ semaphore
+
+
+
+
+Add a semaphore to the proxy service.
+
+semaphore
+
+
+The semaphore to be added
+
+
+The ID of the semaphore.
+
+
+
+
+
+
+ [MemoryId]MemoryId mscclpp::ProxyService::addMemory
+ (RegisteredMemory memory)
+ addMemory
+ [RegisteredMemory]memory
+
+
+
+
+Register a memory region with the proxy service.
+
+memory
+
+
+The memory region to register.
+
+
+The ID of the memory region.
+
+
+
+
+
+
+ std::shared_ptr< [Host2DeviceSemaphore] >
+ std::shared_ptr<Host2DeviceSemaphore> mscclpp::ProxyService::semaphore
+ (SemaphoreId id) const
+ semaphore
+ [SemaphoreId]id
+
+
+
+
+Get a semaphore by ID.
+
+id
+
+
+The ID of the semaphore.
+
+
+The semaphore.
+
+
+
+
+
+
+ [ProxyChannel]ProxyChannel mscclpp::ProxyService::proxyChannel
+ (SemaphoreId id)
+ proxyChannel
+ [SemaphoreId]id
+
+
+
+
+Get a proxy channel by semaphore ID.
+
+id
+
+
+The ID of the semaphore.
+
+
+The proxy channel.
+
+
+
+
+
+
+ void
+ void mscclpp::ProxyService::startProxy
+ ()
+ startProxy
+ startProxy
+
+Start the proxy service.
+
+
+
+
+
+
+
+ void
+ void mscclpp::ProxyService::stopProxy
+ ()
+ stopProxy
+ stopProxy
+
+Stop the proxy service.
+
+
+
+
+
+
+
+
+
+ void
+ void mscclpp::ProxyService::bindThread
+ ()
+ bindThread
+
+
+
+
+
+
+
+
+ [ProxyHandlerResult]ProxyHandlerResult mscclpp::ProxyService::handleTrigger
+ (ProxyTrigger triggerRaw)
+ handleTrigger
+ [ProxyTrigger]triggerRaw
+
+
+
+
+
+
+
+
+
+
+[Proxy] service implementation.
+
+
+
+
+ mscclpp::BaseProxyService
+
+
+ mscclpp::ProxyService
+
+
+
+
+
+
+ mscclpp::BaseProxyService
+
+
+ mscclpp::ProxyService
+
+
+
+
+
+ mscclpp::ProxyService addMemory mscclpp::ProxyService addSemaphore mscclpp::ProxyService BaseProxyService mscclpp::ProxyService bindThread mscclpp::ProxyService buildAndAddSemaphore mscclpp::ProxyService deviceNumaNode mscclpp::ProxyService handleTrigger mscclpp::ProxyService memories_ mscclpp::ProxyService proxy_ mscclpp::ProxyService proxyChannel mscclpp::ProxyService ProxyService mscclpp::ProxyService semaphore mscclpp::ProxyService semaphores_ mscclpp::ProxyService startProxy mscclpp::ProxyService stopProxy mscclpp::ProxyService ~BaseProxyService
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1RegisteredMemory.xml b/docs/doxygen/xml/classmscclpp_1_1RegisteredMemory.xml
new file mode 100644
index 00000000..3c69a3bb
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1RegisteredMemory.xml
@@ -0,0 +1,236 @@
+
+
+
+ mscclpp::RegisteredMemory
+ core.hpp
+
+
+ std::shared_ptr< Impl >
+ std::shared_ptr<Impl> mscclpp::RegisteredMemory::pimpl_
+ pimpl_
+
+
+
+
+
+
+
+
+
+
+ friend class
+ friend class Context
+ Context
+
+
+
+
+
+
+
+
+ friend class
+ friend class Connection
+ Connection
+
+
+
+
+
+
+
+
+
+
+ mscclpp::RegisteredMemory::RegisteredMemory
+ ()=default
+ RegisteredMemory
+
+Default constructor.
+
+
+
+
+
+
+
+ mscclpp::RegisteredMemory::~RegisteredMemory
+ ()
+ ~RegisteredMemory
+
+Destructor.
+
+
+
+
+
+
+
+ void *
+ void* mscclpp::RegisteredMemory::data
+ () const
+ data
+
+
+
+Get a pointer to the memory block.
+A pointer to the memory block.
+
+
+
+
+
+ void *
+ void* mscclpp::RegisteredMemory::originalDataPtr
+ () const
+ originalDataPtr
+
+
+
+Get a pointer to the original memory block.
+A pointer to the original memory block.
+
+
+
+
+
+ size_t
+ size_t mscclpp::RegisteredMemory::size
+ ()
+ size
+
+
+
+Get the size of the memory block.
+The size of the memory block.
+
+
+
+
+
+ [TransportFlags]TransportFlags mscclpp::RegisteredMemory::transports
+ ()
+ transports
+
+
+
+Get the transport flags associated with the memory block.
+The transport flags associated with the memory block.
+
+
+
+
+
+ std::vector< char >
+ std::vector<char> mscclpp::RegisteredMemory::serialize
+ ()
+ serialize
+
+
+
+Serialize the [RegisteredMemory] object to a vector of characters.
+A vector of characters representing the serialized [RegisteredMemory] object.
+
+
+
+
+
+
+
+ [RegisteredMemory]static RegisteredMemory mscclpp::RegisteredMemory::deserialize
+ (const std::vector< char > &data)
+ deserialize
+ const std::vector< char > &
+ data
+
+
+
+
+Deserialize a [RegisteredMemory] object from a vector of characters.
+
+
+data
+
+
+A vector of characters representing a serialized [RegisteredMemory] object.
+
+
+A deserialized [RegisteredMemory] object.
+
+
+
+
+
+
+
+ mscclpp::RegisteredMemory::RegisteredMemory
+ (std::shared_ptr< Impl > pimpl)
+ RegisteredMemory
+ std::shared_ptr< Impl >
+ pimpl
+
+
+
+
+
+
+
+
+
+
+Represents a block of memory that has been registered to a [Context].
+
+
+
+
+ mscclpp::RegisteredMemory Connection mscclpp::RegisteredMemory Context mscclpp::RegisteredMemory data mscclpp::RegisteredMemory deserialize mscclpp::RegisteredMemory originalDataPtr mscclpp::RegisteredMemory pimpl_ mscclpp::RegisteredMemory RegisteredMemory mscclpp::RegisteredMemory RegisteredMemory mscclpp::RegisteredMemory serialize mscclpp::RegisteredMemory size mscclpp::RegisteredMemory transports mscclpp::RegisteredMemory ~RegisteredMemory
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1SmDevice2DeviceSemaphore.xml b/docs/doxygen/xml/classmscclpp_1_1SmDevice2DeviceSemaphore.xml
new file mode 100644
index 00000000..514b8b7a
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1SmDevice2DeviceSemaphore.xml
@@ -0,0 +1,157 @@
+
+
+
+ mscclpp::SmDevice2DeviceSemaphore
+ mscclpp::BaseSemaphore< CudaDeleter, CudaDeleter >
+ semaphore.hpp
+
+
+ [SmDevice2DeviceSemaphoreDeviceHandle]using mscclpp::SmDevice2DeviceSemaphore::DeviceHandle = SmDevice2DeviceSemaphoreDeviceHandle
+ DeviceHandle
+
+Device-side handle for [SmDevice2DeviceSemaphore].
+
+
+
+
+
+
+
+
+
+ bool
+ bool mscclpp::SmDevice2DeviceSemaphore::isRemoteInboundSemaphoreIdSet_
+ isRemoteInboundSemaphoreIdSet_
+
+
+
+
+
+
+
+
+
+
+ mscclpp::SmDevice2DeviceSemaphore::SmDevice2DeviceSemaphore
+ (Communicator &communicator, std::shared_ptr< Connection > connection)
+ SmDevice2DeviceSemaphore
+ [Communicator] &communicator
+
+ std::shared_ptr< [Connection] >
+ connection
+
+
+
+
+Constructor.
+
+communicator
+
+
+The communicator.
+
+
+
+
+connection
+
+
+The connection associated with this semaphore.
+
+
+
+
+
+
+
+
+ mscclpp::SmDevice2DeviceSemaphore::SmDevice2DeviceSemaphore
+ ()=delete
+ SmDevice2DeviceSemaphore
+
+Constructor.
+
+
+
+
+
+
+
+ [DeviceHandle]DeviceHandle mscclpp::SmDevice2DeviceSemaphore::deviceHandle
+ () const
+ deviceHandle
+
+Returns the device-side handle.
+
+
+
+
+
+
+
+
+A semaphore for sending signals from the local device to a peer device via SM.
+
+
+
+
+
+ mscclpp::BaseSemaphore< CudaDeleter, CudaDeleter >
+
+
+ mscclpp::SmDevice2DeviceSemaphore
+
+
+
+
+
+
+ mscclpp::NonblockingFuture< mscclpp::RegisteredMemory >
+
+
+ mscclpp::BaseSemaphore< CudaDeleter, CudaDeleter >
+
+ remoteInboundSemaphoreIdsRegMem_
+
+
+
+ mscclpp::SmDevice2DeviceSemaphore
+
+
+
+
+
+ mscclpp::SmDevice2DeviceSemaphore BaseSemaphore mscclpp::SmDevice2DeviceSemaphore DeviceHandle mscclpp::SmDevice2DeviceSemaphore deviceHandle mscclpp::SmDevice2DeviceSemaphore expectedInboundSemaphore_ mscclpp::SmDevice2DeviceSemaphore isRemoteInboundSemaphoreIdSet_ mscclpp::SmDevice2DeviceSemaphore localInboundSemaphore_ mscclpp::SmDevice2DeviceSemaphore outboundSemaphore_ mscclpp::SmDevice2DeviceSemaphore remoteInboundSemaphoreIdsRegMem_ mscclpp::SmDevice2DeviceSemaphore SmDevice2DeviceSemaphore mscclpp::SmDevice2DeviceSemaphore SmDevice2DeviceSemaphore
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1SysError.xml b/docs/doxygen/xml/classmscclpp_1_1SysError.xml
new file mode 100644
index 00000000..fd63643c
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1SysError.xml
@@ -0,0 +1,95 @@
+
+
+
+ mscclpp::SysError
+ mscclpp::BaseError
+ errors.hpp
+
+
+ mscclpp::SysError::SysError
+ (const std::string &message, int errorCode)
+ SysError
+ const std::string &
+ message
+
+ int
+ errorCode
+
+
+
+
+
+
+
+
+
+ virtual mscclpp::SysError::~SysError
+ ()=default
+ ~SysError
+
+
+
+
+
+
+
+
+
+An error from a system call that sets errno .
+
+
+
+
+
+ std::runtime_error
+
+
+ mscclpp::SysError
+
+
+
+
+ mscclpp::BaseError
+
+
+
+
+
+
+ std::runtime_error
+
+
+ mscclpp::SysError
+
+
+
+
+ mscclpp::BaseError
+
+
+
+
+
+ mscclpp::SysError BaseError mscclpp::SysError BaseError mscclpp::SysError errorCode_ mscclpp::SysError getErrorCode mscclpp::SysError message_ mscclpp::SysError SysError mscclpp::SysError what mscclpp::SysError ~BaseError mscclpp::SysError ~SysError
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1TcpBootstrap.xml b/docs/doxygen/xml/classmscclpp_1_1TcpBootstrap.xml
new file mode 100644
index 00000000..59e570f9
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1TcpBootstrap.xml
@@ -0,0 +1,477 @@
+
+
+
+ mscclpp::TcpBootstrap
+ mscclpp::Bootstrap
+ core.hpp
+
+
+ std::unique_ptr< Impl >
+ std::unique_ptr<Impl> mscclpp::TcpBootstrap::pimpl_
+ pimpl_
+
+
+
+
+
+
+
+
+
+
+ [UniqueId]static UniqueId mscclpp::TcpBootstrap::createUniqueId
+ ()
+ createUniqueId
+
+
+
+Create a random unique ID. The created unique ID.
+
+
+
+
+
+
+
+
+ mscclpp::TcpBootstrap::TcpBootstrap
+ (int rank, int nRanks)
+ TcpBootstrap
+ int
+ rank
+
+ int
+ nRanks
+
+
+
+
+Constructor.
+
+rank
+
+
+The rank of the process.
+
+
+
+
+nRanks
+
+
+The total number of ranks.
+
+
+
+
+
+
+
+
+ mscclpp::TcpBootstrap::~TcpBootstrap
+ ()
+ ~TcpBootstrap
+
+Destructor.
+
+
+
+
+
+
+
+ [UniqueId]UniqueId mscclpp::TcpBootstrap::getUniqueId
+ () const
+ getUniqueId
+
+
+
+Return the unique ID stored in the [TcpBootstrap]. The unique ID stored in the [TcpBootstrap].
+
+
+
+
+
+
+ void
+ void mscclpp::TcpBootstrap::initialize
+ (UniqueId uniqueId, int64_t timeoutSec=30)
+ initialize
+ [UniqueId]uniqueId
+
+ int64_t
+ timeoutSec
+ 30
+
+
+
+
+Initialize the [TcpBootstrap] with a given unique ID.
+
+uniqueId
+
+
+The unique ID to initialize the [TcpBootstrap] with.
+
+
+
+
+timeoutSec
+
+
+The connection timeout in seconds.
+
+
+
+
+
+
+
+
+ void
+ void mscclpp::TcpBootstrap::initialize
+ (const std::string &ifIpPortTrio, int64_t timeoutSec=30)
+ initialize
+ const std::string &
+ ifIpPortTrio
+
+ int64_t
+ timeoutSec
+ 30
+
+
+
+
+Initialize the [TcpBootstrap] with a string formatted as "ip:port" or "interface:ip:port".
+
+ifIpPortTrio
+
+
+The string formatted as "ip:port" or "interface:ip:port".
+
+
+
+
+timeoutSec
+
+
+The connection timeout in seconds.
+
+
+
+
+
+
+
+
+ int
+ int mscclpp::TcpBootstrap::getRank
+ () override
+ getRank
+ getRank
+
+Return the rank of the process.
+
+
+
+
+
+
+
+ int
+ int mscclpp::TcpBootstrap::getNranks
+ () override
+ getNranks
+ getNranks
+
+Return the total number of ranks.
+
+
+
+
+
+
+
+ int
+ int mscclpp::TcpBootstrap::getNranksPerNode
+ () override
+ getNranksPerNode
+ getNranksPerNode
+
+Return the total number of ranks per node.
+
+
+
+
+
+
+
+ void
+ void mscclpp::TcpBootstrap::send
+ (void *data, int size, int peer, int tag) override
+ send
+ send
+ void *
+ data
+
+ int
+ size
+
+ int
+ peer
+
+ int
+ tag
+
+
+
+
+Send data to another process.
+Data sent via send(senderBuff, size, receiverRank, tag) can be received via recv(receiverBuff, size, senderRank, tag) .
+
+
+data
+
+
+The data to send.
+
+
+
+
+size
+
+
+The size of the data to send.
+
+
+
+
+peer
+
+
+The rank of the process to send the data to.
+
+
+
+
+tag
+
+
+The tag to send the data with.
+
+
+
+
+
+
+
+ void
+ void mscclpp::TcpBootstrap::recv
+ (void *data, int size, int peer, int tag) override
+ recv
+ recv
+ void *
+ data
+
+ int
+ size
+
+ int
+ peer
+
+ int
+ tag
+
+
+
+
+Receive data from another process.
+Data sent via send(senderBuff, size, receiverRank, tag) can be received via recv(receiverBuff, size, senderRank, tag) .
+
+
+data
+
+
+The buffer to write the received data to.
+
+
+
+
+size
+
+
+The size of the data to receive.
+
+
+
+
+peer
+
+
+The rank of the process to receive the data from.
+
+
+
+
+tag
+
+
+The tag to receive the data with.
+
+
+
+
+
+
+
+ void
+ void mscclpp::TcpBootstrap::allGather
+ (void *allData, int size) override
+ allGather
+ allGather
+ void *
+ allData
+
+ int
+ size
+
+
+
+
+Gather data from all processes.
+When called by rank r , this sends data from allData[r * size] to allData[(r + 1) * size - 1] to all other ranks. The data sent by rank r is received into allData[r * size] of other ranks.
+
+
+allData
+
+
+The buffer to write the received data to.
+
+
+
+
+size
+
+
+The size of the data each rank sends.
+
+
+
+
+
+
+
+ void
+ void mscclpp::TcpBootstrap::barrier
+ () override
+ barrier
+ barrier
+
+Synchronize all processes.
+
+
+
+
+
+
+
+
+A native implementation of the bootstrap using TCP sockets.
+
+
+
+
+
+ mscclpp::Bootstrap
+
+
+ mscclpp::TcpBootstrap
+
+
+
+
+
+
+ mscclpp::Bootstrap
+
+
+ mscclpp::TcpBootstrap
+
+
+
+
+
+ mscclpp::TcpBootstrap allGather mscclpp::TcpBootstrap barrier mscclpp::TcpBootstrap Bootstrap mscclpp::TcpBootstrap createUniqueId mscclpp::TcpBootstrap getNranks mscclpp::TcpBootstrap getNranksPerNode mscclpp::TcpBootstrap getRank mscclpp::TcpBootstrap getUniqueId mscclpp::TcpBootstrap groupBarrier mscclpp::TcpBootstrap initialize mscclpp::TcpBootstrap initialize mscclpp::TcpBootstrap pimpl_ mscclpp::TcpBootstrap recv mscclpp::TcpBootstrap recv mscclpp::TcpBootstrap send mscclpp::TcpBootstrap send mscclpp::TcpBootstrap TcpBootstrap mscclpp::TcpBootstrap ~Bootstrap mscclpp::TcpBootstrap ~TcpBootstrap
+
+
diff --git a/docs/doxygen/xml/classmscclpp_1_1TransportFlags.xml b/docs/doxygen/xml/classmscclpp_1_1TransportFlags.xml
new file mode 100644
index 00000000..9102a69a
--- /dev/null
+++ b/docs/doxygen/xml/classmscclpp_1_1TransportFlags.xml
@@ -0,0 +1,595 @@
+
+
+
+ mscclpp::TransportFlags
+ TransportFlagsBase
+ core.hpp
+
+
+ mscclpp::TransportFlags::TransportFlags
+ ()=default
+ TransportFlags
+
+Default constructor for [TransportFlags].
+
+
+
+
+
+
+
+ mscclpp::TransportFlags::TransportFlags
+ (Transport transport)
+ TransportFlags
+ [Transport]transport
+
+
+
+
+Constructor for [TransportFlags] that takes a Transport enum value.
+
+
+transport
+
+
+The transport to set the flag for.
+
+
+
+
+
+
+
+ bool
+ bool mscclpp::TransportFlags::has
+ (Transport transport) const
+ has
+ [Transport]transport
+
+
+
+
+Check if a specific transport flag is set.
+
+
+transport
+
+
+The transport to check the flag for.
+
+
+True if the flag is set, false otherwise.
+
+
+
+
+
+ bool
+ bool mscclpp::TransportFlags::none
+ () const
+ none
+
+
+
+Check if no transport flags are set.
+True if no flags are set, false otherwise.
+
+
+
+
+
+ bool
+ bool mscclpp::TransportFlags::any
+ () const
+ any
+
+
+
+Check if any transport flags are set.
+True if any flags are set, false otherwise.
+
+
+
+
+
+ bool
+ bool mscclpp::TransportFlags::all
+ () const
+ all
+
+
+
+Check if all transport flags are set.
+True if all flags are set, false otherwise.
+
+
+
+
+
+ size_t
+ size_t mscclpp::TransportFlags::count
+ () const
+ count
+
+
+
+Get the number of transport flags that are set.
+The number of flags that are set.
+
+
+
+
+
+ [TransportFlags] &TransportFlags& mscclpp::TransportFlags::operator|=
+ (TransportFlags other)
+ operator|=
+ [TransportFlags]other
+
+
+
+
+Bitwise OR assignment operator for [TransportFlags].
+
+
+other
+
+
+The other [TransportFlags] to perform the OR operation with.
+
+
+A reference to the modified [TransportFlags].
+
+
+
+
+
+ [TransportFlags]TransportFlags mscclpp::TransportFlags::operator|
+ (TransportFlags other) const
+ operator|
+ [TransportFlags]other
+
+
+
+
+Bitwise OR operator for [TransportFlags].
+
+
+other
+
+
+The other [TransportFlags] to perform the OR operation with.
+
+
+A new [TransportFlags] object with the result of the OR operation.
+
+
+
+
+
+ [TransportFlags]TransportFlags mscclpp::TransportFlags::operator|
+ (Transport transport) const
+ operator|
+ [Transport]transport
+
+
+
+
+Bitwise OR operator for [TransportFlags] and Transport.
+
+
+transport
+
+
+The Transport to perform the OR operation with.
+
+
+A new [TransportFlags] object with the result of the OR operation.
+
+
+
+
+
+ [TransportFlags] &TransportFlags& mscclpp::TransportFlags::operator&=
+ (TransportFlags other)
+ operator&=
+ [TransportFlags]other
+
+
+
+
+Bitwise AND assignment operator for [TransportFlags].
+
+
+other
+
+
+The other [TransportFlags] to perform the AND operation with.
+
+
+A reference to the modified [TransportFlags].
+
+
+
+
+
+ [TransportFlags]TransportFlags mscclpp::TransportFlags::operator&
+ (TransportFlags other) const
+ operator&
+ [TransportFlags]other
+
+
+
+
+Bitwise AND operator for [TransportFlags].
+
+
+other
+
+
+The other [TransportFlags] to perform the AND operation with.
+
+
+A new [TransportFlags] object with the result of the AND operation.
+
+
+
+
+
+ [TransportFlags]TransportFlags mscclpp::TransportFlags::operator&
+ (Transport transport) const
+ operator&
+ [Transport]transport
+
+
+
+
+Bitwise AND operator for [TransportFlags] and Transport.
+
+
+transport
+
+
+The Transport to perform the AND operation with.
+
+
+A new [TransportFlags] object with the result of the AND operation.
+
+
+
+
+
+ [TransportFlags] &TransportFlags& mscclpp::TransportFlags::operator^=
+ (TransportFlags other)
+ operator^=
+ [TransportFlags]other
+
+
+
+
+Bitwise XOR assignment operator for [TransportFlags].
+
+
+other
+
+
+The other [TransportFlags] to perform the XOR operation with.
+
+
+A reference to the modified [TransportFlags].
+
+
+
+
+
+ [TransportFlags]TransportFlags mscclpp::TransportFlags::operator^
+ (TransportFlags other) const
+ operator^
+ [TransportFlags]other
+
+
+
+
+Bitwise XOR operator for [TransportFlags].
+
+
+other
+
+
+The other [TransportFlags] to perform the XOR operation with.
+
+
+A new [TransportFlags] object with the result of the XOR operation.
+
+
+
+
+
+ [TransportFlags]TransportFlags mscclpp::TransportFlags::operator^
+ (Transport transport) const
+ operator^
+ [Transport]transport
+
+
+
+
+Bitwise XOR operator for [TransportFlags] and Transport.
+
+
+transport
+
+
+The Transport to perform the XOR operation with.
+
+
+A new [TransportFlags] object with the result of the XOR operation.
+
+
+
+
+
+ [TransportFlags]TransportFlags mscclpp::TransportFlags::operator~
+ () const
+ operator~
+
+
+
+Bitwise NOT operator for [TransportFlags].
+A new [TransportFlags] object with the result of the NOT operation.
+
+
+
+
+
+ bool
+ bool mscclpp::TransportFlags::operator==
+ (TransportFlags other) const
+ operator==
+ [TransportFlags]other
+
+
+
+
+Equality comparison operator for [TransportFlags].
+
+
+other
+
+
+The other [TransportFlags] to compare with.
+
+
+True if the two [TransportFlags] objects are equal, false otherwise.
+
+
+
+
+
+ bool
+ bool mscclpp::TransportFlags::operator!=
+ (TransportFlags other) const
+ operator!=
+ [TransportFlags]other
+
+
+
+
+Inequality comparison operator for [TransportFlags].
+
+
+other
+
+
+The other [TransportFlags] to compare with.
+
+
+True if the two [TransportFlags] objects are not equal, false otherwise.
+
+
+
+
+
+ [detail::TransportFlagsBase]detail::TransportFlagsBase mscclpp::TransportFlags::toBitset
+ () const
+ toBitset
+
+
+
+Convert the [TransportFlags] object to a bitset representation.
+A [detail::TransportFlagsBase] object representing the [TransportFlags] object.
+
+
+
+
+
+
+
+ mscclpp::TransportFlags::TransportFlags
+ (detail::TransportFlagsBase bitset)
+ TransportFlags
+ [detail::TransportFlagsBase]bitset
+
+
+
+
+Private constructor for [TransportFlags] that takes a bitset representation.
+
+
+bitset
+
+
+The bitset representation of the [TransportFlags] object.
+
+
+
+
+
+
+
+
+Stores transport flags.
+
+
+
+
+
+ detail::TransportFlagsBase
+
+
+ mscclpp::TransportFlags
+
+
+
+
+
+
+ detail::TransportFlagsBase
+
+
+ mscclpp::TransportFlags
+
+
+
+
+
+ mscclpp::TransportFlags all mscclpp::TransportFlags any mscclpp::TransportFlags count mscclpp::TransportFlags has mscclpp::TransportFlags none mscclpp::TransportFlags operator!= mscclpp::TransportFlags operator& mscclpp::TransportFlags operator& mscclpp::TransportFlags operator&= mscclpp::TransportFlags operator== mscclpp::TransportFlags operator^ mscclpp::TransportFlags operator^ mscclpp::TransportFlags operator^= mscclpp::TransportFlags operator| mscclpp::TransportFlags operator| mscclpp::TransportFlags operator|= mscclpp::TransportFlags operator~ mscclpp::TransportFlags toBitset mscclpp::TransportFlags TransportFlags mscclpp::TransportFlags TransportFlags mscclpp::TransportFlags TransportFlags
+
+
diff --git a/docs/doxygen/xml/combine.xslt b/docs/doxygen/xml/combine.xslt
new file mode 100644
index 00000000..f0ee1fd9
--- /dev/null
+++ b/docs/doxygen/xml/combine.xslt
@@ -0,0 +1,15 @@
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/compound.xsd b/docs/doxygen/xml/compound.xsd
new file mode 100644
index 00000000..083df158
--- /dev/null
+++ b/docs/doxygen/xml/compound.xsd
@@ -0,0 +1,1187 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/concurrency__device_8hpp.xml b/docs/doxygen/xml/concurrency__device_8hpp.xml
new file mode 100644
index 00000000..4613f1e2
--- /dev/null
+++ b/docs/doxygen/xml/concurrency__device_8hpp.xml
@@ -0,0 +1,91 @@
+
+
+
+ concurrency_device.hpp
+ atomic_device.hpp
+ poll_device.hpp
+
+
+ device.hpp
+
+
+ atomic_device.hpp
+
+
+
+
+ poll_device.hpp
+
+
+
+
+ concurrency_device.hpp
+
+
+
+
+
+
+ mscclpp::DeviceSyncer
+ mscclpp
+
+
+
+
+
+#ifndef #define #include[atomic_device.hpp]" #include[poll_device.hpp]" namespace [mscclpp]struct [DeviceSyncer]public : [DeviceSyncer]()default ; [~DeviceSyncer]()default ; #if void int unsigned int if return ; if unsigned int if else #endif private : unsigned int unsigned int unsigned int }; } #endif
+
+
diff --git a/docs/doxygen/xml/core_8hpp.xml b/docs/doxygen/xml/core_8hpp.xml
new file mode 100644
index 00000000..eba9ec93
--- /dev/null
+++ b/docs/doxygen/xml/core_8hpp.xml
@@ -0,0 +1,597 @@
+
+
+
+ core.hpp
+ array
+ bitset
+ future
+ memory
+ mscclpp/gpu.hpp
+ mscclpp/gpu_utils.hpp
+ string
+ vector
+ errors.hpp
+ executor.hpp
+ proxy_channel.hpp
+ semaphore.hpp
+ sm_channel.hpp
+
+
+ core.hpp
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ errors.hpp
+
+
+
+
+ linux/version.h
+
+
+ cuda_runtime.h
+
+
+ stdexcept
+
+
+ string
+
+
+ mscclpp/gpu.hpp
+
+
+
+
+
+
+
+
+ bitset
+
+
+ future
+
+
+ vector
+
+
+ array
+
+
+ cuda.h
+
+
+ cstring
+
+
+ mscclpp/gpu_utils.hpp
+
+
+
+
+
+
+
+
+
+
+ memory
+
+
+
+
+ executor.hpp
+
+
+ core.hpp
+
+
+
+
+
+
+
+
+
+
+ semaphore.hpp
+
+
+
+
+
+
+ proxy_channel.hpp
+
+
+ sm_channel.hpp
+
+
+ mscclpp::Bootstrap
+ mscclpp::TcpBootstrap
+ mscclpp::TransportFlags
+ mscclpp::RegisteredMemory
+ mscclpp::Endpoint
+ mscclpp::Connection
+ mscclpp::EndpointConfig
+ mscclpp::Context
+ mscclpp::Setuppable
+ mscclpp::NonblockingFuture
+ mscclpp::Communicator
+ mscclpp
+ mscclpp::detail
+ std
+
+
+ MSCCLPP_MAJOR
+ 0
+
+
+
+
+
+
+
+
+ MSCCLPP_MINOR
+ 5
+
+
+
+
+
+
+
+
+ MSCCLPP_PATCH
+ 2
+
+
+
+
+
+
+
+
+ MSCCLPP_VERSION
+ ([MSCCLPP_MAJOR] * 10000 + [MSCCLPP_MINOR] * 100 + [MSCCLPP_PATCH])
+
+
+
+
+
+
+
+
+ MSCCLPP_UNIQUE_ID_BYTES
+ 128
+
+
+
+
+
+
+
+
+
+
+
+
+
+#ifndef #define #define #define #define #define #include #include #include #include #include[mscclpp/gpu.hpp]> #include[mscclpp/gpu_utils.hpp]> #include #include #include[errors.hpp]" namespace [mscclpp]#define using [UniqueId]std::string[version](); class [Bootstrap]public : [Bootstrap](){};virtual [~Bootstrap]()default ; virtual int [getRank]()virtual int [getNranks]()virtual int [getNranksPerNode]()virtual void [send](void * int int int virtual void [recv](void * int int int virtual void [allGather](void * int virtual void [barrier]()void [groupBarrier](const void [send](const int int void [recv](std::vector<char>&int int }; class [TcpBootstrap]public [Bootstrap]public : static [UniqueId][createUniqueId]();[TcpBootstrap](int int [~TcpBootstrap]();[UniqueId][getUniqueId]()const ; void [initialize]([UniqueId]void [initialize](const int [getRank]()override ; int [getNranks]()override ; int [getNranksPerNode]()override ; void [send](void * int int int override ; void [recv](void * int int int override ; void [allGather](void * int override ; void [barrier]()override ; private : class Impl; }; enum [Transport][Unknown],[CudaIpc],[Nvls],[IB0],[IB1],[IB2],[IB3],[IB4],[IB5],[IB6],[IB7],[Ethernet],[NumTransports],}; const [TransportNames][]"UNK" , "IPC" , "NVLS" , "IB0" , "IB1" , "IB2" , "IB3" , "IB4" , "IB5" , "IB6" , "IB7" , "ETH" , "NUM" }; namespace detail const size_t [TransportFlagsSize]static_assert([TransportFlagsSize] static_cast< size_t > ([Transport::NumTransports]), "TransportFlagsSize ); using [TransportFlagsBase]} class [TransportFlags]private [detail::TransportFlagsBase]public : [TransportFlags]()default ; [TransportFlags]([Transport]bool [has]([Transport]const ; bool [none]()const ; bool [any]()const ; bool [all]()const ; size_t [count]()const ; [TransportFlags]&[operator|=]([TransportFlags][TransportFlags][operator|]([TransportFlags]const ; [TransportFlags][operator|]([Transport]const ; [TransportFlags]&[operator&=]([TransportFlags][TransportFlags][operator&]([TransportFlags]const ; [TransportFlags][operator&]([Transport]const ; [TransportFlags]&[operator^=]([TransportFlags][TransportFlags][operator^]([TransportFlags]const ; [TransportFlags][operator^]([Transport]const ; [TransportFlags][operator~]()const ; bool [operator==]([TransportFlags]const ; bool [operator!=]([TransportFlags]const ; [detail::TransportFlagsBase][toBitset]()const ; private : [TransportFlags]([detail::TransportFlagsBase]}; inline [TransportFlags][operator|]([Transport][Transport]return [TransportFlags](transport1)} inline [TransportFlags][operator&]([Transport][Transport]return [TransportFlags](transport1)} inline [TransportFlags][operator^]([Transport][Transport]return [TransportFlags](transport1)} int [getIBDeviceCount]();std::string[getIBDeviceName]([Transport] [Transport][getIBTransportByDeviceName](const class Context; class Connection; class [RegisteredMemory]public : [RegisteredMemory]()default ; [~RegisteredMemory]();void *[data]() const ; void *[originalDataPtr]() const ; size_t [size]();[TransportFlags][transports]();[serialize]();static [RegisteredMemory][deserialize](const [data]);private : struct Impl; [RegisteredMemory](std::shared_ptr<Impl>friend class [Context];friend class [Connection];}; class [Endpoint]public : [Endpoint]()default ; [Transport][transport]();[serialize]();static [Endpoint][deserialize](const private : struct Impl; [Endpoint](std::shared_ptr<Impl>friend class [Context];friend class [Connection];}; class [Connection]public : virtual [~Connection]()default ; virtual void [write]([RegisteredMemory][RegisteredMemory]virtual void [updateAndSync]([RegisteredMemory]virtual void [flush](int64_tvirtual [Transport][transport]()virtual [Transport][remoteTransport]()[getTransportName]();protected : static [getImpl]([RegisteredMemory]&static [getImpl]([Endpoint]&}; struct [EndpointConfig]static const int [DefaultMaxCqSize]static const int [DefaultMaxCqPollNum]static const int [DefaultMaxSendWr]static const int [DefaultMaxWrPerSend][Transport][transport];int [ibMaxCqSize][DefaultMaxCqSize];int [ibMaxCqPollNum][DefaultMaxCqPollNum];int [ibMaxSendWr][DefaultMaxSendWr];int [ibMaxWrPerSend][DefaultMaxWrPerSend];[EndpointConfig]()[transport]([Transport]::[Unknown])[EndpointConfig]([Transport][transport])[transport]([transport])}; class [Context]public : [Context]();[~Context]();[RegisteredMemory][registerMemory](void * size_t [TransportFlags][Endpoint][createEndpoint]([EndpointConfig][connect]([Endpoint][Endpoint]private : struct Impl; friend class [RegisteredMemory];friend class [Endpoint];}; struct [Setuppable]virtual [~Setuppable]()default ; virtual void [beginSetup](std::shared_ptr<Bootstrap>virtual void [endSetup](std::shared_ptr<Bootstrap>}; template typename class [NonblockingFuture]public : [NonblockingFuture]()default ; [NonblockingFuture](std::shared_future<T>&&[std]::move(future))bool [ready](){ return [get](){ if [ready]())throw [Error]("NonblockingFuture::get() ,[ErrorCode::InvalidUsage]); return }; class [Communicator]public : [Communicator](std::shared_ptr<Bootstrap>[bootstrap],[context]nullptr ); [~Communicator]();[bootstrap]();[context]();[RegisteredMemory][registerMemory](void * size_t [TransportFlags]void [sendMemoryOnSetup]([RegisteredMemory]int int [NonblockingFuture<RegisteredMemory>][recvMemoryOnSetup](int int [NonblockingFuture<std::shared_ptr<Connection>]>[connectOnSetup](int int [EndpointConfig]int [remoteRankOf](const [Connection]&int [tagOf](const [Connection]&void [onSetup](std::shared_ptr<Setuppable>void [setup]();private : struct Impl; }; extern const [TransportFlags][NoTransports];extern const [TransportFlags][AllIBTransports];extern const [TransportFlags][AllTransports];template class using [DeviceHandle]typename [T::DeviceHandle];template typename [DeviceHandle<std::remove_reference_t<T>]>[deviceHandle](T&&return } template class using [PacketPayload]typename } namespace [std]template struct hash<[mscclpp]::TransportFlags>; } #endif
+
+
diff --git a/docs/doxygen/xml/device_8hpp.xml b/docs/doxygen/xml/device_8hpp.xml
new file mode 100644
index 00000000..ff96c555
--- /dev/null
+++ b/docs/doxygen/xml/device_8hpp.xml
@@ -0,0 +1,184 @@
+
+
+
+ device.hpp
+ atomic_device.hpp
+ poll_device.hpp
+ fifo_device.hpp
+ npkit.hpp
+ nvls_device.hpp
+ packet_device.hpp
+ semaphore_device.hpp
+
+
+ device.hpp
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ atomic_device.hpp
+
+
+
+
+ proxy_channel_device.hpp
+
+
+
+
+ nvls.hpp
+
+
+ semaphore_device.hpp
+
+
+
+
+
+
+
+
+ nvls_device.hpp
+
+
+
+
+ poll_device.hpp
+
+
+
+
+ sm_channel_device.hpp
+
+
+
+
+ proxy.hpp
+
+
+
+
+ packet_device.hpp
+
+
+ semaphore.hpp
+
+
+
+
+
+
+ proxy_channel.hpp
+
+
+ concurrency_device.hpp
+
+
+ sm_channel.hpp
+
+
+ npkit.hpp
+
+
+ fifo.hpp
+
+
+
+
+ fifo_device.hpp
+
+
+
+
+
+
+
+
+ MSCCLPP_HOST_COMPILE
+
+
+
+
+
+
+
+
+ MSCCLPP_HOST_DEVICE_INLINE
+ inline
+
+
+
+
+
+
+
+
+
+
+
+
+
+#ifndef #define #if #include #endif #if #define #define #define #if #define #else #define #endif #else #define #define #endif #endif
+
+
diff --git a/docs/doxygen/xml/dir_5b58d9d970ef29bd3b9d7292e7628c41.xml b/docs/doxygen/xml/dir_5b58d9d970ef29bd3b9d7292e7628c41.xml
new file mode 100644
index 00000000..a5f4a64e
--- /dev/null
+++ b/docs/doxygen/xml/dir_5b58d9d970ef29bd3b9d7292e7628c41.xml
@@ -0,0 +1,35 @@
+
+
+
+ mscclpp
+ npkit
+ atomic_device.hpp
+ concurrency_device.hpp
+ core.hpp
+ device.hpp
+ errors.hpp
+ executor.hpp
+ fifo.hpp
+ fifo_device.hpp
+ gpu.hpp
+ gpu_utils.hpp
+ numa.hpp
+ nvls.hpp
+ nvls_device.hpp
+ packet_device.hpp
+ poll_device.hpp
+ proxy.hpp
+ proxy_channel.hpp
+ proxy_channel_device.hpp
+ semaphore.hpp
+ semaphore_device.hpp
+ sm_channel.hpp
+ sm_channel_device.hpp
+ utils.hpp
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/dir_79cdab046adb8bd4bd5d2d3af1d20704.xml b/docs/doxygen/xml/dir_79cdab046adb8bd4bd5d2d3af1d20704.xml
new file mode 100644
index 00000000..3ec7d3e3
--- /dev/null
+++ b/docs/doxygen/xml/dir_79cdab046adb8bd4bd5d2d3af1d20704.xml
@@ -0,0 +1,14 @@
+
+
+
+ npkit
+ npkit.hpp
+ npkit_event.hpp
+ npkit_struct.hpp
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/dir_d44c64559bbebec7f509842c48db8b23.xml b/docs/doxygen/xml/dir_d44c64559bbebec7f509842c48db8b23.xml
new file mode 100644
index 00000000..5c3029b8
--- /dev/null
+++ b/docs/doxygen/xml/dir_d44c64559bbebec7f509842c48db8b23.xml
@@ -0,0 +1,12 @@
+
+
+
+ include
+ mscclpp
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/errors_8hpp.xml b/docs/doxygen/xml/errors_8hpp.xml
new file mode 100644
index 00000000..9871878c
--- /dev/null
+++ b/docs/doxygen/xml/errors_8hpp.xml
@@ -0,0 +1,169 @@
+
+
+
+ errors.hpp
+ stdexcept
+ core.hpp
+ gpu_utils.hpp
+
+
+ errors.hpp
+
+
+
+
+ stdexcept
+
+
+
+
+ executor.hpp
+
+
+ core.hpp
+
+
+
+
+
+
+
+
+
+
+ errors.hpp
+
+
+
+
+
+
+ nvls.hpp
+
+
+ semaphore.hpp
+
+
+
+
+
+
+ proxy_channel.hpp
+
+
+ sm_channel.hpp
+
+
+ gpu_utils.hpp
+
+
+
+
+
+
+
+
+
+
+ npkit.hpp
+
+
+ mscclpp::BaseError
+ mscclpp::Error
+ mscclpp::SysError
+ mscclpp::CudaError
+ mscclpp::CuError
+ mscclpp::IbError
+ mscclpp
+
+
+
+
+
+#ifndef #define #include namespace [mscclpp]enum [ErrorCode][SystemError],[InternalError],[RemoteError],[InvalidUsage],[Timeout],[Aborted],[ExecutorError],}; std::string[errorToString]( enum [ErrorCode]class [BaseError]public public : [BaseError](const int explicit [BaseError](int virtual [~BaseError]()default ; int [getErrorCode]()const ; const char *[what]() const override ; protected : [message_];int [errorCode_];}; class [Error]public [BaseError]public : [Error](const [ErrorCode]virtual [~Error]()default ; [ErrorCode][getErrorCode]()const ; }; class [SysError]public [BaseError]public : [SysError](const int virtual [~SysError]()default ; }; class [CudaError]public [BaseError]public : [CudaError](const int virtual [~CudaError]()default ; }; class [CuError]public [BaseError]public : [CuError](const int virtual [~CuError]()default ; }; class [IbError]public [BaseError]public : [IbError](const int virtual [~IbError]()default ; }; }; #endif
+
+
diff --git a/docs/doxygen/xml/executor_8hpp.xml b/docs/doxygen/xml/executor_8hpp.xml
new file mode 100644
index 00000000..3ba6430b
--- /dev/null
+++ b/docs/doxygen/xml/executor_8hpp.xml
@@ -0,0 +1,171 @@
+
+
+
+ executor.hpp
+ memory
+ mscclpp/core.hpp
+ unordered_map
+
+
+ executor.hpp
+
+
+
+
+
+
+
+
+ mscclpp/core.hpp
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ errors.hpp
+
+
+
+
+ linux/version.h
+
+
+ cuda_runtime.h
+
+
+ stdexcept
+
+
+ string
+
+
+ mscclpp/gpu.hpp
+
+
+
+
+
+
+
+
+ bitset
+
+
+ future
+
+
+ vector
+
+
+ array
+
+
+ unordered_map
+
+
+ cuda.h
+
+
+ cstring
+
+
+ mscclpp/gpu_utils.hpp
+
+
+
+
+
+
+
+
+
+
+ memory
+
+
+ mscclpp::ExecutionPlan
+ mscclpp::Executor
+ mscclpp
+
+
+
+
+
+#ifndef #define #include #include[mscclpp/core.hpp]> #include namespace [mscclpp]enum [DataType][INT32],[UINT32],[FLOAT16],[FLOAT32],[BFLOAT16],}; enum [PacketType][LL8],[LL16],}; class [ExecutionPlan]public : [ExecutionPlan](const const [~ExecutionPlan]()default ; private : struct Impl; friend class [Executor];}; class [Executor]public : [Executor](std::shared_ptr<Communicator>[Executor](const [Executor]&)delete ; [Executor]&[operator=](const [Executor]&)delete ; [~Executor]();void [execute](int void * void * size_t size_t [DataType]const [ExecutionPlan]&[PacketType][PacketType::LL16]);private : struct Impl; }; } #endif
+
+
diff --git a/docs/doxygen/xml/fifo_8hpp.xml b/docs/doxygen/xml/fifo_8hpp.xml
new file mode 100644
index 00000000..29510ca9
--- /dev/null
+++ b/docs/doxygen/xml/fifo_8hpp.xml
@@ -0,0 +1,113 @@
+
+
+
+ fifo.hpp
+ cstdint
+ functional
+ memory
+ fifo_device.hpp
+ proxy.hpp
+
+
+ device.hpp
+
+
+ functional
+
+
+ cstdint
+
+
+ memory
+
+
+ fifo.hpp
+
+
+
+
+
+
+
+
+
+
+ fifo_device.hpp
+
+
+
+
+
+
+
+
+ proxy.hpp
+
+
+
+
+ proxy_channel.hpp
+
+
+ fifo.hpp
+
+
+
+
+ mscclpp::Fifo
+ mscclpp
+
+
+
+
+
+#ifndef #define #include #include #include #include[fifo_device.hpp]" namespace [mscclpp]constexpr size_t [DEFAULT_FIFO_SIZE]class [Fifo]public : [Fifo](int [size][DEFAULT_FIFO_SIZE]);[~Fifo]();[ProxyTrigger][poll]();void [pop]();void [flushTail](bool false ); int [size]()const ; [FifoDeviceHandle][deviceHandle]();private : struct Impl; }; } #endif
+
+
diff --git a/docs/doxygen/xml/fifo__device_8hpp.xml b/docs/doxygen/xml/fifo__device_8hpp.xml
new file mode 100644
index 00000000..3faf1b37
--- /dev/null
+++ b/docs/doxygen/xml/fifo__device_8hpp.xml
@@ -0,0 +1,143 @@
+
+
+
+ fifo_device.hpp
+ cstdint
+ device.hpp
+ fifo.hpp
+ proxy_channel_device.hpp
+
+
+ device.hpp
+
+
+ cstdint
+
+
+ fifo_device.hpp
+
+
+
+
+
+
+
+
+ proxy_channel_device.hpp
+
+
+
+
+ proxy.hpp
+
+
+
+
+ proxy_channel.hpp
+
+
+ fifo.hpp
+
+
+
+
+ fifo_device.hpp
+
+
+
+
+
+
+ mscclpp::ProxyTrigger
+ mscclpp::FifoDeviceHandle
+ mscclpp
+
+
+
+
+
+#ifndef #define #include #include[device.hpp]" #if #include[atomic_device.hpp]" #include[poll_device.hpp]" #endif namespace [mscclpp]struct alignas (16)[ProxyTrigger] [fst],[snd];}; struct [FifoDeviceHandle]#if [ProxyTrigger][head],[snd]if [size][tailReplica]))[size][tailReplica],[triggers][curFifoHead[size]].fst),[ProxyTrigger]*[triggers][curFifoHead[size]]);#if asm volatile ( "st.global.relaxed.sys.v2.u64 "l" (triggerPtr), "l" (trigger.[fst]), "l" (trigger.[snd])); #else [snd]),[snd],[fst]),[fst],#endif return void [tailReplica],[triggers][curFifoHead[size]].fst),#endif [ProxyTrigger]*[triggers];[tailReplica];[head];int [size];}; } #endif
+
+
diff --git a/docs/doxygen/xml/gpu_8hpp.xml b/docs/doxygen/xml/gpu_8hpp.xml
new file mode 100644
index 00000000..921fa7f8
--- /dev/null
+++ b/docs/doxygen/xml/gpu_8hpp.xml
@@ -0,0 +1,247 @@
+
+
+
+ gpu.hpp
+ cuda.h
+ cuda_runtime.h
+ linux/version.h
+ core.hpp
+ gpu_utils.hpp
+ nvls_device.hpp
+
+
+ linux/version.h
+
+
+ cuda_runtime.h
+
+
+ gpu.hpp
+
+
+
+
+
+
+
+
+ cuda.h
+
+
+
+
+ executor.hpp
+
+
+ core.hpp
+
+
+
+
+
+
+
+
+
+
+ nvls.hpp
+
+
+ nvls_device.hpp
+
+
+
+
+ gpu.hpp
+
+
+
+
+
+
+
+
+ semaphore.hpp
+
+
+
+
+
+
+ proxy_channel.hpp
+
+
+ sm_channel.hpp
+
+
+ gpu_utils.hpp
+
+
+
+
+
+
+
+
+
+
+ npkit.hpp
+
+
+
+
+ USE_NVLS
+ ((CUDART_VERSION >= 12010) && (LINUX_VERSION_CODE >= KERNEL_VERSION(5, 6, 0)))
+
+
+
+
+
+
+
+
+ __syncshm
+ __syncthreads();
+
+
+
+
+
+
+
+
+
+
+
+
+
+#ifndef #define #if #include using using using using using using using using using using using using using constexpr auto constexpr auto constexpr auto constexpr auto constexpr auto constexpr auto constexpr auto constexpr auto constexpr auto constexpr auto constexpr auto constexpr auto constexpr auto constexpr auto constexpr auto #ifndef #define #endif #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #define #else #include #include #endif #if #include #define #else #define #endif #if #define #else #define #endif #endif
+
+
diff --git a/docs/doxygen/xml/gpu__utils_8hpp.xml b/docs/doxygen/xml/gpu__utils_8hpp.xml
new file mode 100644
index 00000000..c5f3ded8
--- /dev/null
+++ b/docs/doxygen/xml/gpu__utils_8hpp.xml
@@ -0,0 +1,478 @@
+
+
+
+ gpu_utils.hpp
+ cstring
+ memory
+ errors.hpp
+ gpu.hpp
+ core.hpp
+ npkit.hpp
+ nvls.hpp
+ semaphore.hpp
+
+
+ errors.hpp
+
+
+
+
+ linux/version.h
+
+
+ cuda_runtime.h
+
+
+ stdexcept
+
+
+ gpu.hpp
+
+
+
+
+
+
+
+
+ cuda.h
+
+
+ cstring
+
+
+ gpu_utils.hpp
+
+
+
+
+
+
+
+
+
+
+ memory
+
+
+
+
+ executor.hpp
+
+
+ core.hpp
+
+
+
+
+
+
+
+
+
+
+ nvls.hpp
+
+
+ semaphore.hpp
+
+
+
+
+
+
+ proxy_channel.hpp
+
+
+ sm_channel.hpp
+
+
+ gpu_utils.hpp
+
+
+
+
+
+
+
+
+
+
+ npkit.hpp
+
+
+ mscclpp::AvoidCudaGraphCaptureGuard
+ mscclpp::CudaStreamWithFlags
+ mscclpp::CudaDeleter
+ mscclpp::PhysicalCudaMemory
+ mscclpp::CudaDeleter
+ mscclpp::CudaPhysicalDeleter
+ mscclpp::CudaHostDeleter
+ mscclpp
+ mscclpp::detail
+
+
+ MSCCLPP_CUDATHROW
+ cmd
+ do { \
+ cudaError_t err = cmd; \
+ if (err != cudaSuccess) { \
+ throw [mscclpp::CudaError](std::string("Call to " #cmd " failed. ") + __FILE__ + ":" + std::to_string(__LINE__), \
+ err); \
+ } \
+ } while (false)
+
+
+
+Throw [mscclpp::CudaError] if cmd does not return cudaSuccess.
+
+cmd
+
+
+The command to execute.
+
+
+
+
+
+
+
+
+ MSCCLPP_CUTHROW
+ cmd
+ do { \
+ CUresult err = cmd; \
+ if (err != CUDA_SUCCESS) { \
+ throw [mscclpp::CuError](std::string("Call to " #cmd " failed.") + __FILE__ + ":" + std::to_string(__LINE__), \
+ err); \
+ } \
+ } while (false)
+
+
+
+Throw [mscclpp::CuError] if cmd does not return CUDA_SUCCESS.
+
+cmd
+
+
+The command to execute.
+
+
+
+
+
+
+
+
+
+
+
+
+
+#ifndef #define #include #include #include[errors.hpp]" #include[gpu.hpp]" #define #define namespace [mscclpp]struct [AvoidCudaGraphCaptureGuard][AvoidCudaGraphCaptureGuard]();[~AvoidCudaGraphCaptureGuard]();[mode_];}; struct [CudaStreamWithFlags][CudaStreamWithFlags](unsigned int [~CudaStreamWithFlags]();operator { return [stream_];[stream_];}; template class struct [CudaDeleter];template class struct [PhysicalCudaMemory][memHandle_];[devicePtr_];size_t [size_];[PhysicalCudaMemory](CUmemGenericAllocationHandlesize_t [memHandle_](memHandle),[devicePtr_](devicePtr),[size_](size)}; namespace detail template class T*[cudaCalloc]( size_t [AvoidCudaGraphCaptureGuard][CudaStreamWithFlags][MSCCLPP_CUDATHROW](cudaMalloc(&ptr,sizeof (T))); [MSCCLPP_CUDATHROW](cudaMemsetAsync(ptr,sizeof (T), [MSCCLPP_CUDATHROW](cudaStreamSynchronize(stream));return } template class [PhysicalCudaMemory<T>]*[cudaPhysicalCalloc](size_t size_t [AvoidCudaGraphCaptureGuard]int [MSCCLPP_CUDATHROW](cudaGetDevice(&deviceId));#if #else #endif size_t sizeof (T) [MSCCLPP_CUTHROW](cuMemCreate(&memHandle,)); nullptr ; [MSCCLPP_CUTHROW](cuMemAddressReserve((CUdeviceptr*)&devicePtr,[MSCCLPP_CUTHROW](cuMemMap((CUdeviceptr)devicePtr,[MSCCLPP_CUTHROW](cuMemSetAccess((CUdeviceptr)devicePtr,[CudaStreamWithFlags][MSCCLPP_CUDATHROW](cudaMemsetAsync(devicePtr,[MSCCLPP_CUDATHROW](cudaStreamSynchronize(stream));return new [PhysicalCudaMemory<T>](memHandle,} template class T*[cudaExtCalloc]( size_t [AvoidCudaGraphCaptureGuard][CudaStreamWithFlags]#if [MSCCLPP_CUDATHROW](hipExtMallocWithFlags((void **)&ptr, sizeof (T), #else [MSCCLPP_CUDATHROW](cudaMalloc(&ptr,sizeof (T))); #endif [MSCCLPP_CUDATHROW](cudaMemsetAsync(ptr,sizeof (T), [MSCCLPP_CUDATHROW](cudaStreamSynchronize(stream));return } template class T*[cudaHostCalloc]( size_t [AvoidCudaGraphCaptureGuard][MSCCLPP_CUDATHROW](cudaHostAlloc(&ptr,sizeof (T), sizeof (T)); return } template class size_t ), class class Memory[safeAlloc]( size_t nullptr ; try catch if throw ; return } template class size_t , size_t ), class class Memory[safeAlloc]( size_t size_t if sizeof (T)) throw [Error]("The sizeof (T)) " [ErrorCode::InvalidUsage]);nullptr ; try catch if throw ; return } } template class struct CudaDeleter using [TPtrOrArray]void [operator()]([TPtrOrArray][AvoidCudaGraphCaptureGuard][MSCCLPP_CUDATHROW](cudaFree(ptr));}; template class struct [CudaPhysicalDeleter]"T ); void [operator()]([PhysicalCudaMemory<T>]*[AvoidCudaGraphCaptureGuard][MSCCLPP_CUTHROW](cuMemUnmap((CUdeviceptr)ptr->[devicePtr_],[size_]));[MSCCLPP_CUTHROW](cuMemAddressFree((CUdeviceptr)ptr->[devicePtr_],[size_]));[MSCCLPP_CUTHROW](cuMemRelease(ptr->[memHandle_]));}; template class struct [CudaHostDeleter]using [TPtrOrArray]void [operator()]([TPtrOrArray][AvoidCudaGraphCaptureGuard][MSCCLPP_CUDATHROW](cudaFreeHost(ptr));}; template class std::shared_ptr<T>[allocSharedCuda]( size_t return [CudaDeleter<T>],} template class std::shared_ptr<PhysicalCudaMemory<T>>[allocSharedPhysicalCuda]( size_t size_t return [CudaPhysicalDeleter<T>],} template class std::shared_ptr<T>[allocExtSharedCuda]( size_t return [CudaDeleter<T>],} template class using [UniqueCudaPtr]template class [UniqueCudaPtr<T>][allocUniqueCuda](size_t return [CudaDeleter<T>],[UniqueCudaPtr<T>]>(count);} template class std::unique_ptr<PhysicalCudaMemory<T>>[allocUniquePhysicalCuda]( size_t size_t return [CudaPhysicalDeleter<T>],[CudaDeleter<CudaPhysicalDeleter<T>]>>>(count,} template class [UniqueCudaPtr<T>][allocExtUniqueCuda](size_t return [CudaDeleter<T>],[UniqueCudaPtr<T>]>(count);} template class T, typename ... std::shared_ptr<T>[makeSharedCudaHost](Args&&... auto [CudaHostDeleter<T>],new return } template class std::shared_ptr<T[]>[makeSharedCudaHost]( size_t using auto [CudaHostDeleter<TElem>],for size_t new return } template class using [UniqueCudaHostPtr]template class T, typename ... bool > true > [UniqueCudaHostPtr<T>][makeUniqueCudaHost](Args&&...auto [CudaHostDeleter<T>],[UniqueCudaHostPtr<T>]>(1);new return } template class bool > [UniqueCudaHostPtr<T>][makeUniqueCudaHost](size_t using auto [CudaHostDeleter<T>],[UniqueCudaHostPtr<T>]>(count);for size_t new return } template class void [memcpyCudaAsync](T*const size_t [AvoidCudaGraphCaptureGuard][MSCCLPP_CUDATHROW](cudaMemcpyAsync(dst,sizeof (T), } template class void [memcpyCuda](T*const size_t [AvoidCudaGraphCaptureGuard][CudaStreamWithFlags][MSCCLPP_CUDATHROW](cudaMemcpyAsync(dst,sizeof (T), [MSCCLPP_CUDATHROW](cudaStreamSynchronize(stream));} } #endif
+
+
diff --git a/docs/doxygen/xml/index.xml b/docs/doxygen/xml/index.xml
new file mode 100644
index 00000000..55c3e12b
--- /dev/null
+++ b/docs/doxygen/xml/index.xml
@@ -0,0 +1,647 @@
+
+
+ mscclpp::AvoidCudaGraphCaptureGuard
+ mode_ AvoidCudaGraphCaptureGuard ~AvoidCudaGraphCaptureGuard mscclpp::BaseError
+ message_ errorCode_ BaseError BaseError ~BaseError getErrorCode what mscclpp::BaseProxyService
+ BaseProxyService ~BaseProxyService startProxy stopProxy mscclpp::BaseSemaphore
+ remoteInboundSemaphoreIdsRegMem_ localInboundSemaphore_ expectedInboundSemaphore_ outboundSemaphore_ BaseSemaphore mscclpp::Bootstrap
+ Bootstrap ~Bootstrap getRank getNranks getNranksPerNode send recv allGather barrier groupBarrier send recv mscclpp::ChannelTrigger
+ value size srcOffset __pad0__ dstOffset srcMemoryId dstMemoryId type chanId __pad1__ reserved fields mscclpp::Communicator
+ pimpl_ Communicator ~Communicator bootstrap context registerMemory sendMemoryOnSetup recvMemoryOnSetup connectOnSetup remoteRankOf tagOf onSetup setup mscclpp::Connection
+ ~Connection write updateAndSync flush transport remoteTransport getTransportName getImpl getImpl mscclpp::Context
+ pimpl_ RegisteredMemory Endpoint Context ~Context registerMemory createEndpoint connect mscclpp::CudaDeleter
+ TPtrOrArray operator() mscclpp::CudaError
+ CudaError ~CudaError mscclpp::CudaHostDeleter
+ TPtrOrArray operator() mscclpp::CudaPhysicalDeleter
+ operator() mscclpp::CudaStreamWithFlags
+ stream_ CudaStreamWithFlags ~CudaStreamWithFlags operator cudaStream_t mscclpp::CuError
+ CuError ~CuError mscclpp::NvlsConnection::DeviceMulticastPointer
+ DeviceHandle deviceMem_ mcPtr_ bufferSize_ NvlsConnection DeviceMulticastPointer deviceHandle getDevicePtr mscclpp::DeviceMulticastPointerDeviceHandle
+ devicePtr mcPtr bufferSize mscclpp::DeviceSyncer
+ flag_ count_ preFlag_ DeviceSyncer ~DeviceSyncer mscclpp::Endpoint
+ pimpl_ Context Connection Endpoint transport serialize deserialize Endpoint mscclpp::EndpointConfig
+ DefaultMaxCqSize DefaultMaxCqPollNum DefaultMaxSendWr DefaultMaxWrPerSend transport ibMaxCqSize ibMaxCqPollNum ibMaxSendWr ibMaxWrPerSend EndpointConfig EndpointConfig mscclpp::Error
+ Error ~Error getErrorCode mscclpp::ExecutionPlan
+ impl_ Executor ExecutionPlan ~ExecutionPlan mscclpp::Executor
+ impl_ Executor Executor operator= ~Executor execute mscclpp::Fifo
+ pimpl Fifo ~Fifo poll pop flushTail size deviceHandle mscclpp::FifoDeviceHandle
+ triggers tailReplica head size mscclpp::Host2DeviceSemaphore
+ DeviceHandle connection_ Host2DeviceSemaphore connection signal deviceHandle mscclpp::Host2DeviceSemaphoreDeviceHandle
+ inboundSemaphoreId expectedInboundSemaphoreId mscclpp::Host2HostSemaphore
+ connection_ Host2HostSemaphore connection signal poll wait mscclpp::IbError
+ IbError ~IbError mscclpp::LL16Packet
+ Payload data1 flag1 data2 flag2 @2 mscclpp::LL8Packet
+ Payload data flag @4 raw_ mscclpp::NonblockingFuture
+ future NonblockingFuture NonblockingFuture ready get NpKit
+ kNumGpuEventBuffers kNumCpuEventBuffers kMaxNumGpuEventsPerBuffer kMaxNumCpuEventsPerBuffer gpu_event_buffers_ cpu_event_buffers_ gpu_collect_contexts_ cpu_collect_contexts_ rank_ cpu_timestamp_ cpu_timestamp_update_thread_ cpu_timestamp_update_thread_should_stop_ Init Dump Shutdown GetGpuEventCollectContexts CollectCpuEvent GetCpuTimestamp CpuTimestampUpdateThread NpKitEvent
+ bits type size rsvd timestamp fields NpKitEventCollectContext
+ event_buffer event_buffer_head mscclpp::NvlsConnection
+ DefaultNvlsBufferSize pimpl_ NvlsConnection NvlsConnection NvlsConnection serialize addDevice addDevice allocateAndBindCuda bindAllocatedCuda getMultiCastMinGranularity mscclpp::PhysicalCudaMemory
+ memHandle_ devicePtr_ size_ PhysicalCudaMemory mscclpp::Proxy
+ pimpl Proxy Proxy ~Proxy start stop fifo mscclpp::ProxyChannel
+ DeviceHandle semaphoreId_ semaphore_ proxy_ ProxyChannel ProxyChannel ProxyChannel operator= deviceHandle mscclpp::ProxyChannelDeviceHandle
+ semaphoreId_ semaphore_ fifo_ mscclpp::ProxyService
+ semaphores_ memories_ proxy_ deviceNumaNode ProxyService buildAndAddSemaphore addSemaphore addMemory semaphore proxyChannel startProxy stopProxy bindThread handleTrigger mscclpp::ProxyTrigger
+ fst snd mscclpp::RegisteredMemory
+ pimpl_ Context Connection RegisteredMemory ~RegisteredMemory data originalDataPtr size transports serialize deserialize RegisteredMemory mscclpp::ScopedTimer
+ name_ ScopedTimer ~ScopedTimer mscclpp::Setuppable
+ ~Setuppable beginSetup endSetup mscclpp::SimpleProxyChannel
+ DeviceHandle proxyChan_ dst_ src_ SimpleProxyChannel SimpleProxyChannel SimpleProxyChannel SimpleProxyChannel operator= deviceHandle mscclpp::SimpleProxyChannelDeviceHandle
+ proxyChan_ dst_ src_ mscclpp::SmChannel
+ DeviceHandle semaphore_ dst_ src_ getPacketBuffer_ SmChannel SmChannel deviceHandle mscclpp::SmChannelDeviceHandle
+ semaphore_ src_ dst_ getPacketBuffer_ mscclpp::SmDevice2DeviceSemaphore
+ DeviceHandle isRemoteInboundSemaphoreIdSet_ SmDevice2DeviceSemaphore SmDevice2DeviceSemaphore deviceHandle mscclpp::SmDevice2DeviceSemaphoreDeviceHandle
+ inboundSemaphoreId outboundSemaphoreId remoteInboundSemaphoreId expectedInboundSemaphoreId mscclpp::SysError
+ SysError ~SysError mscclpp::TcpBootstrap
+ pimpl_ createUniqueId TcpBootstrap ~TcpBootstrap getUniqueId initialize initialize getRank getNranks getNranksPerNode send recv allGather barrier mscclpp::Timer
+ start_ timeout_ Timer ~Timer elapsed set reset print mscclpp::TransportFlags
+ TransportFlags TransportFlags has none any all count operator|= operator| operator| operator&= operator& operator& operator^= operator^ operator^ operator~ operator== operator!= toBitset TransportFlags mscclpp
+ Transport Unknown CudaIpc Nvls IB0 IB1 IB2 IB3 IB4 IB5 IB6 IB7 Ethernet NumTransports ErrorCode SystemError InternalError RemoteError InvalidUsage Timeout Aborted ExecutorError DataType INT32 UINT32 FLOAT16 FLOAT32 BFLOAT16 PacketType LL8 LL16 ProxyHandlerResult Continue FlushFifoTailAndContinue Stop UniqueId DeviceHandle PacketPayload UniqueCudaPtr UniqueCudaHostPtr LLPacket ProxyHandler SemaphoreId MemoryId TriggerType TransportNames NoTransports AllIBTransports AllTransports DEFAULT_FIFO_SIZE dependentFalse TriggerData TriggerFlag TriggerSync version operator| operator& operator^ getIBDeviceCount getIBDeviceName getIBTransportByDeviceName deviceHandle errorToString allocSharedCuda allocSharedPhysicalCuda allocExtSharedCuda allocUniqueCuda allocUniquePhysicalCuda allocExtUniqueCuda makeSharedCudaHost makeSharedCudaHost makeUniqueCudaHost makeUniqueCudaHost memcpyCudaAsync memcpyCuda getDeviceNumaNode numaBind connectNvlsCollective getHostName isNvlsSupported mscclpp::detail
+ TransportFlagsBase TransportFlagsSize cudaCalloc cudaPhysicalCalloc cudaExtCalloc cudaHostCalloc safeAlloc safeAlloc std
+ atomic_device.hpp
+ concurrency_device.hpp
+ core.hpp
+ MSCCLPP_MAJOR MSCCLPP_MINOR MSCCLPP_PATCH MSCCLPP_VERSION MSCCLPP_UNIQUE_ID_BYTES device.hpp
+ MSCCLPP_HOST_COMPILE MSCCLPP_HOST_DEVICE_INLINE errors.hpp
+ executor.hpp
+ fifo.hpp
+ fifo_device.hpp
+ gpu.hpp
+ USE_NVLS __syncshm gpu_utils.hpp
+ MSCCLPP_CUDATHROW MSCCLPP_CUTHROW npkit.hpp
+ NPKIT_GET_GPU_TIMESTAMP NPKIT_SHM_NUM_EVENTS npkit_event.hpp
+ NPKIT_EVENT_INVALID NPKIT_EVENT_TIME_SYNC_GPU NPKIT_EVENT_TIME_SYNC_CPU NPKIT_EVENT_EXECUTOR_INIT_ENTRY NPKIT_EVENT_EXECUTOR_INIT_EXIT NPKIT_EVENT_EXECUTOR_OP_BASE_ENTRY NPKIT_EVENT_EXECUTOR_OP_BASE_EXIT npkit_struct.hpp
+ numa.hpp
+ nvls.hpp
+ nvls_device.hpp
+ packet_device.hpp
+ poll_device.hpp
+ proxy.hpp
+ proxy_channel.hpp
+ proxy_channel_device.hpp
+ MSCCLPP_BITS_SIZE MSCCLPP_BITS_OFFSET MSCCLPP_BITS_REGMEM_HANDLE MSCCLPP_BITS_TYPE MSCCLPP_BITS_CONNID MSCCLPP_BITS_FIFO_RESERVED README.md
+ semaphore.hpp
+ semaphore_device.hpp
+ sm_channel.hpp
+ sm_channel_device.hpp
+ utils.hpp
+ include
+ mscclpp
+ npkit
+ index
+
diff --git a/docs/doxygen/xml/index.xsd b/docs/doxygen/xml/index.xsd
new file mode 100644
index 00000000..04cb2f13
--- /dev/null
+++ b/docs/doxygen/xml/index.xsd
@@ -0,0 +1,67 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/indexpage.xml b/docs/doxygen/xml/indexpage.xml
new file mode 100644
index 00000000..5d3988b3
--- /dev/null
+++ b/docs/doxygen/xml/indexpage.xml
@@ -0,0 +1,180 @@
+
+
+
+ index
+ MSCCL++
+
+
+
+
+Pipelines
+Build Status
+
+
+Unit Tests (CUDA)
+
+
+Integration Tests (CUDA)
+
+
+Integration Tests (ROCm)
+
+
+A GPU-driven communication stack for scalable AI applications.
+See Quick Start to quickly get started.
+
+Overview
+MSCCL++ redefines inter-GPU communication interfaces, thereby delivering a highly efficient and customizable communication stack for distributed GPU applications. Its design is specifically tailored to accommodate diverse performance optimization scenarios often encountered in state-of-the-art AI applications. Figure below provides a high-level overview of MSCCL++ abstractions in CUDA, C, and Python.
+
+MSCCL++ Abstractions Overview
+
+
+
+The followings highlight the key features of MSCCL++.
+Light-weight and multi-layer abstractions. MSCCL++ provides communication abstractions at lowest level close to hardware and at the highest level close to application API. The lowest level of abstraction is ultra light weight which enables a user to implement logics of data movement for a collective operation such as AllReduce inside a GPU kernel extremely efficiently without worrying about memory ordering of different ops. The modularity of MSCCL++ enables a user to construct the building blocks of MSCCL++ in a high level abstraction in Python and feed them to a CUDA kernel in order to facilitate the user's productivity.1-sided 0-copy synchronous and asynchronous abstracts. MSCCL++ provides fine-grained synchronous and asynchronous 0-copy 1-sided abstracts for communication primitives such as put() , get() , signal() , flush() , and wait() . The 1-sided abstractions allows a user to asynchronously put() their data on the remote GPU as soon as it is ready without requiring the remote side to issue any receive instruction. This enables users to easily implement flexible communication logics, such as overlapping communication with computation, or implementing customized collective communication algorithms without worrying about potential deadlocks. Additionally, the 0-copy capability enables MSCCL++ to directly transfer data between user's buffers without using intermediate internal buffers which saves GPU bandwidth and memory capacity.Unified abstractions for different interconnection hardware. MSCCL++ provides consistent abstractions regardless of the location of the remote GPU (either on the local node or on a remote node) or the underlying link (either NVLink/xGMI or InfiniBand). This simplifies the code for inter-GPU communication, which is often complex due to memory ordering of GPU/CPU read/writes and therefore, is error-prone.
+
+
+Performance
+ While the power of MSCCL++ is fully realized with application-specific optimization, it still delivers performance benefits even for collective communication operations. The following figures provide a comparison of the AllReduce throughput of MSCCL++ against NCCL 2.19.3. This benchmark was tested over two Azure NDmv4 SKUs (8 A100-80G GPUs per node). The key motivation behind these results is scaling of inference for LLM models using tensor parallelism. LLM requests usually are executed in two phases: prompt processing and token sampling. The prompt processing uses a large batch size that is usually equal to a request context length and the corresponding AllReduce size is len_context*dim_hidden*sizeof(fp16) . For a context length of 2048 with a hidden dimension of 12288 (GPT-3 size), the AllReduce size is 48MB. The token sampling uses a smaller batch size which corresponds to concurrent user requests in the system and therefore, the AllReduce size is batch_size*dim_hidden*sizeof(fp16) . For a concurrency of 16 users, the AllReduce size is 384KB. As the figures below demonstrates, MSCCL++ provides significant speed up over NCCL which is crucial for efficiency of serving LLMs at large scale.
+Single-node AllReduce Two-node AllReduce
+
+
+
+
+
+Key Concepts
+ The following highlights key concepts of MSCCL++.
+On-GPU Communication Interfaces: Channels
+ MSCCL++ provides peer-to-peer communication methods between GPUs. A peer-to-peer connection between two GPUs is called a Channel . Channels are constructed by MSCCL++ host-side interfaces and copied to GPUs during initialization. Channels provide GPU-side interfaces , which means that all communication methods are defined as a device function to be called from a GPU kernel code. For example, the put() method in the following example copies 1KB data from the local GPU to a remote GPU. __device__[mscclpp::DeviceHandle<mscclpp::SimpleProxyChannel>] __global__ void } MSCCL++ also provides efficient synchronization methods, signal() , flush() , and wait() . For example, we can implement a simple barrier between two ranks (peer-to-peer connected through channel ) as follows. Explanation of each method is inlined. __device__ void } MSCCL++ provides consistent interfaces, i.e., the above interfaces are used regardless of the location of the remote GPU (either on the local node or on a remote node) or the underlying link (either NVLink/xGMI or InfiniBand).
+
+ProxyChannel and SmChannel
+ MSCCL++ delivers two types of channels, ProxyChannel and SmChannel . ProxyChannel provides (R)DMA-based data copy and synchronization methods. When called, these methods send/receive a signal to/from a host-side proxy (hence the name ProxyChannel ), which will trigger (R)DMA (such as cudaMemcpy* or ibv_post_send ) or issue synchronization methods (such as cudaStreamSynchronize or ibv_poll_cq ). Since the key functionalities are run by the proxy, ProxyChannel requires only a single GPU thread to call its methods. See all ProxyChannel methods from here . On the other hand, SmChannel provides memory-mapping-based copy and synchronization methods. When called, these methods will directly use GPU threads to read/write from/to the remote GPU's memory space. Comparing against ProxyChannel , SmChannel is especially performant for low-latency scenarios, while it may need many GPU threads to call copying methods at the same time to achieve high copying bandwidth. See all SmChannel methods from here .
+
+Host-Side Communication Proxy
+ MSCCL++ provides a default implementation of a host-side proxy for ProxyChannels, which is a background host thread that busy polls triggers from GPUs and conducts functionalities accordingly. For example, the following is a typical host-side code for MSCCL++. ```cpp // Bootstrap: initialize control-plane connections between all ranks auto bootstrap = std::make_shared<mscclpp::TcpBootstrap>(rank, world_size); // Create a communicator for connection setup [mscclpp::Communicator] comm(bootstrap); // Setup connections here using comm ... // Construct the default proxy [mscclpp::ProxyService] proxyService(); // Start the proxy proxyService.startProxy(); // Run the user application, i.e., launch GPU kernels here ... // Stop the proxy after the application is finished proxyService.stopProxy(); While ```cpp // __device__ __global__ } // class private: public: }; Customized proxies can be used for conducting a series of pre-defined data transfers within only a single trigger from GPU at runtime. This would be more efficient than sending a trigger for each data transfer one by one.
+
+Python Interfaces
+ MSCCL++ provides Python bindings and interfaces, which simplifies integration with Python applications.
+
+
+Contributing
+ This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com . When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. This project has adopted the Microsoft Open Source Code of Conduct . For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
+
+Trademarks
+ This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines . Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.
+
+
+
diff --git a/docs/doxygen/xml/namespacemscclpp.xml b/docs/doxygen/xml/namespacemscclpp.xml
new file mode 100644
index 00000000..3ea6260a
--- /dev/null
+++ b/docs/doxygen/xml/namespacemscclpp.xml
@@ -0,0 +1,1698 @@
+
+
+
+ mscclpp
+ mscclpp::AvoidCudaGraphCaptureGuard
+ mscclpp::BaseError
+ mscclpp::BaseProxyService
+ mscclpp::BaseSemaphore
+ mscclpp::Bootstrap
+ mscclpp::ChannelTrigger
+ mscclpp::Communicator
+ mscclpp::Connection
+ mscclpp::Context
+ mscclpp::CudaDeleter
+ mscclpp::CudaError
+ mscclpp::CudaHostDeleter
+ mscclpp::CudaPhysicalDeleter
+ mscclpp::CudaStreamWithFlags
+ mscclpp::CuError
+ mscclpp::DeviceMulticastPointerDeviceHandle
+ mscclpp::DeviceSyncer
+ mscclpp::Endpoint
+ mscclpp::EndpointConfig
+ mscclpp::Error
+ mscclpp::ExecutionPlan
+ mscclpp::Executor
+ mscclpp::Fifo
+ mscclpp::FifoDeviceHandle
+ mscclpp::Host2DeviceSemaphore
+ mscclpp::Host2DeviceSemaphoreDeviceHandle
+ mscclpp::Host2HostSemaphore
+ mscclpp::IbError
+ mscclpp::LL16Packet
+ mscclpp::LL8Packet
+ mscclpp::NonblockingFuture
+ mscclpp::NvlsConnection
+ mscclpp::PhysicalCudaMemory
+ mscclpp::Proxy
+ mscclpp::ProxyChannel
+ mscclpp::ProxyChannelDeviceHandle
+ mscclpp::ProxyService
+ mscclpp::ProxyTrigger
+ mscclpp::RegisteredMemory
+ mscclpp::ScopedTimer
+ mscclpp::Setuppable
+ mscclpp::SimpleProxyChannel
+ mscclpp::SimpleProxyChannelDeviceHandle
+ mscclpp::SmChannel
+ mscclpp::SmChannelDeviceHandle
+ mscclpp::SmDevice2DeviceSemaphore
+ mscclpp::SmDevice2DeviceSemaphoreDeviceHandle
+ mscclpp::SysError
+ mscclpp::TcpBootstrap
+ mscclpp::Timer
+ mscclpp::TransportFlags
+ mscclpp::detail
+
+
+ Transport
+
+ Unknown
+
+
+
+
+
+
+ CudaIpc
+
+
+
+
+
+
+ Nvls
+
+
+
+
+
+
+ IB0
+
+
+
+
+
+
+ IB1
+
+
+
+
+
+
+ IB2
+
+
+
+
+
+
+ IB3
+
+
+
+
+
+
+ IB4
+
+
+
+
+
+
+ IB5
+
+
+
+
+
+
+ IB6
+
+
+
+
+
+
+ IB7
+
+
+
+
+
+
+ Ethernet
+
+
+
+
+
+
+ NumTransports
+
+
+
+
+
+
+Enumerates the available transport types.
+
+
+
+
+
+
+
+ ErrorCode
+
+ SystemError
+
+
+
+
+
+
+ InternalError
+
+
+
+
+
+
+ RemoteError
+
+
+
+
+
+
+ InvalidUsage
+
+
+
+
+
+
+ Timeout
+
+
+
+
+
+
+ Aborted
+
+
+
+
+
+
+ ExecutorError
+
+
+
+
+
+
+Enumeration of error codes used by MSCCL++.
+
+
+
+
+
+
+
+ DataType
+
+ INT32
+
+
+
+
+
+
+ UINT32
+
+
+
+
+
+
+ FLOAT16
+
+
+
+
+
+
+ FLOAT32
+
+
+
+
+
+
+ BFLOAT16
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PacketType
+
+ LL8
+
+
+
+
+
+
+ LL16
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ProxyHandlerResult
+
+ Continue
+
+
+
+
+
+
+ FlushFifoTailAndContinue
+
+
+
+
+
+
+ Stop
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ std::array< uint8_t, [MSCCLPP_UNIQUE_ID_BYTES] >
+ using mscclpp::UniqueId = typedef std::array<uint8_t, MSCCLPP_UNIQUE_ID_BYTES>
+ UniqueId
+
+Unique ID for a process. This is a MSCCLPP_UNIQUE_ID_BYTES byte array that uniquely identifies a process.
+
+
+
+
+
+
+
+
+ class T
+
+
+ typename T::DeviceHandle
+ using mscclpp::DeviceHandle = typedef typename T::DeviceHandle
+ DeviceHandle
+
+A type which could be safely used in device side.
+
+
+
+
+
+
+
+
+ class T
+
+
+ typename T::Payload
+ using mscclpp::PacketPayload = typedef typename T::Payload
+ PacketPayload
+
+Packet value type.
+
+
+
+
+
+
+
+
+ class T
+
+
+ std::unique_ptr< T, [CudaDeleter]< T > >
+ using mscclpp::UniqueCudaPtr = typedef std::unique_ptr<T, CudaDeleter<T> >
+ UniqueCudaPtr
+
+
+
+Unique device pointer that will call cudaFree on destruction.
+
+T
+
+
+Type of each element in the allocated memory.
+
+
+
+
+
+
+
+
+
+ class T
+
+
+ std::unique_ptr< T, [CudaHostDeleter]< T > >
+ using mscclpp::UniqueCudaHostPtr = typedef std::unique_ptr<T, CudaHostDeleter<T> >
+ UniqueCudaHostPtr
+
+
+
+Unique CUDA host pointer that will call cudaFreeHost on destruction.
+
+T
+
+
+Type of each element in the allocated memory.
+
+
+
+
+
+
+
+
+ [LL16Packet]using mscclpp::LLPacket = typedef LL16Packet
+ LLPacket
+
+
+
+
+
+
+
+
+ std::function< [ProxyHandlerResult]([ProxyTrigger])>
+ using mscclpp::ProxyHandler = typedef std::function<ProxyHandlerResult(ProxyTrigger)>
+ ProxyHandler
+
+
+
+
+
+
+
+
+ uint32_t
+ using mscclpp::SemaphoreId = typedef uint32_t
+ SemaphoreId
+
+
+
+
+
+
+
+
+ uint32_t
+ using mscclpp::MemoryId = typedef uint32_t
+ MemoryId
+
+
+
+Numeric ID of [RegisteredMemory]. [ProxyService] has an internal array indexed by these handles mapping to the actual.
+
+
+
+
+
+ uint64_t
+ using mscclpp::TriggerType = typedef uint64_t
+ TriggerType
+
+
+
+
+
+
+
+
+
+
+ const std::string
+ const std::string mscclpp::TransportNames[]
+ []
+ TransportNames
+ = {"UNK", "IPC", "NVLS", "IB0", "IB1", "IB2", "IB3",
+ "IB4", "IB5", "IB6", "IB7", "ETH", "NUM"}
+
+
+
+
+
+
+
+
+ const [TransportFlags]
+ const TransportFlags mscclpp::NoTransports
+ NoTransports
+
+A constant [TransportFlags] object representing no transports.
+
+
+
+
+
+
+
+ const [TransportFlags]
+ const TransportFlags mscclpp::AllIBTransports
+ AllIBTransports
+
+A constant [TransportFlags] object representing all InfiniBand transports.
+
+
+
+
+
+
+
+ const [TransportFlags]
+ const TransportFlags mscclpp::AllTransports
+ AllTransports
+
+A constant [TransportFlags] object representing all transports.
+
+
+
+
+
+
+
+ constexpr size_t
+ constexpr size_t mscclpp::DEFAULT_FIFO_SIZE
+ DEFAULT_FIFO_SIZE
+ = 128
+
+
+
+
+
+
+
+
+
+ class
+
+
+ constexpr bool
+ constexpr bool mscclpp::dependentFalse
+ dependentFalse
+ = false
+
+
+
+
+
+
+
+
+ const [TriggerType]
+ const TriggerType mscclpp::TriggerData
+ TriggerData
+ = 0x1
+
+
+
+
+
+
+
+
+ const [TriggerType]
+ const TriggerType mscclpp::TriggerFlag
+ TriggerFlag
+ = 0x2
+
+
+
+
+
+
+
+
+ const [TriggerType]
+ const TriggerType mscclpp::TriggerSync
+ TriggerSync
+ = 0x4
+
+
+
+
+
+
+
+
+
+
+ std::string
+ std::string mscclpp::version
+ ()
+ version
+
+Return a version string.
+
+
+
+
+
+
+
+ [TransportFlags]TransportFlags mscclpp::operator|
+ (Transport transport1, Transport transport2)
+ operator|
+ [Transport]transport1
+
+ [Transport]transport2
+
+
+
+
+Bitwise OR operator for two Transport objects.
+
+
+transport1
+
+
+The first Transport to perform the OR operation with.
+
+
+
+
+transport2
+
+
+The second Transport to perform the OR operation with.
+
+
+A new [TransportFlags] object with the result of the OR operation.
+
+
+
+
+
+ [TransportFlags]TransportFlags mscclpp::operator&
+ (Transport transport1, Transport transport2)
+ operator&
+ [Transport]transport1
+
+ [Transport]transport2
+
+
+
+
+Bitwise AND operator for two Transport objects.
+
+
+transport1
+
+
+The first Transport to perform the AND operation with.
+
+
+
+
+transport2
+
+
+The second Transport to perform the AND operation with.
+
+
+A new [TransportFlags] object with the result of the AND operation.
+
+
+
+
+
+ [TransportFlags]TransportFlags mscclpp::operator^
+ (Transport transport1, Transport transport2)
+ operator^
+ [Transport]transport1
+
+ [Transport]transport2
+
+
+
+
+Bitwise XOR operator for two Transport objects.
+
+
+transport1
+
+
+The first Transport to perform the XOR operation with.
+
+
+
+
+transport2
+
+
+The second Transport to perform the XOR operation with.
+
+
+A new [TransportFlags] object with the result of the XOR operation.
+
+
+
+
+
+ int
+ int mscclpp::getIBDeviceCount
+ ()
+ getIBDeviceCount
+
+
+
+Get the number of available InfiniBand devices.
+The number of available InfiniBand devices.
+
+
+
+
+
+ std::string
+ std::string mscclpp::getIBDeviceName
+ (Transport ibTransport)
+ getIBDeviceName
+ [Transport]ibTransport
+
+
+
+
+Get the name of the InfiniBand device associated with the specified transport.
+
+
+ibTransport
+
+
+The InfiniBand transport to get the device name for.
+
+
+The name of the InfiniBand device associated with the specified transport.
+
+
+
+
+
+ [Transport]Transport mscclpp::getIBTransportByDeviceName
+ (const std::string &ibDeviceName)
+ getIBTransportByDeviceName
+ const std::string &
+ ibDeviceName
+
+
+
+
+Get the InfiniBand transport associated with the specified device name.
+
+
+ibDeviceName
+
+
+The name of the InfiniBand device to get the transport for.
+
+
+The InfiniBand transport associated with the specified device name.
+
+
+
+
+
+
+ typename T
+
+
+ [DeviceHandle]< std::remove_reference_t< T > >DeviceHandle<std::remove_reference_t<T> > mscclpp::deviceHandle
+ (T &&t)
+ deviceHandle
+ T &&
+ t
+
+
+Retrieve the deviceHandle instance from host object.
+
+
+
+
+
+
+
+ std::string
+ std::string mscclpp::errorToString
+ (enum ErrorCode error)
+ errorToString
+ enum [ErrorCode]
+ error
+
+
+
+
+Convert an error code to a string.
+
+
+error
+
+
+The error code to convert.
+
+
+The string representation of the error code.
+
+
+
+
+
+
+ class T
+
+
+ std::shared_ptr< T >
+ std::shared_ptr<T> mscclpp::allocSharedCuda
+ (size_t count=1)
+ allocSharedCuda
+ size_t
+ count
+ 1
+
+
+
+
+Allocates memory on the device and returns a std::shared_ptr to it. The memory is zeroed out.
+
+T
+
+
+Type of each element in the allocated memory.
+
+
+
+
+count
+
+
+Number of elements to allocate.
+
+
+A std::shared_ptr to the allocated memory.
+
+
+
+
+
+
+
+ class T
+
+
+ std::shared_ptr< [PhysicalCudaMemory]< T > >
+ std::shared_ptr<PhysicalCudaMemory<T> > mscclpp::allocSharedPhysicalCuda
+ (size_t count, size_t gran)
+ allocSharedPhysicalCuda
+ size_t
+ count
+
+ size_t
+ gran
+
+
+
+
+Allocated physical memory on the device and returns a memory handle along with a memory handle for it. The deallocation only happens [PhysicalCudaMemory] goes out of scope.
+
+T
+
+
+Type of each element in the allocated memory.
+
+
+
+
+count
+
+
+Number of elements to allocate.
+
+
+
+
+gran
+
+
+the granularity of the allocation.
+
+
+A std::shared_ptr to the memory handle and a device pointer for that memory.
+
+
+
+
+
+
+
+ class T
+
+
+ std::shared_ptr< T >
+ std::shared_ptr<T> mscclpp::allocExtSharedCuda
+ (size_t count=1)
+ allocExtSharedCuda
+ size_t
+ count
+ 1
+
+
+
+
+Allocates memory on the device and returns a std::shared_ptr to it. The memory is zeroed out.
+
+T
+
+
+Type of each element in the allocated memory.
+
+
+
+
+count
+
+
+Number of elements to allocate.
+
+
+A std::shared_ptr to the allocated memory.
+
+
+
+
+
+
+
+ class T
+
+
+ [UniqueCudaPtr]< T >UniqueCudaPtr<T> mscclpp::allocUniqueCuda
+ (size_t count=1)
+ allocUniqueCuda
+ size_t
+ count
+ 1
+
+
+
+
+Allocates memory on the device and returns a std::unique_ptr to it. The memory is zeroed out.
+
+T
+
+
+Type of each element in the allocated memory.
+
+
+
+
+count
+
+
+Number of elements to allocate.
+
+
+A std::unique_ptr to the allocated memory.
+
+
+
+
+
+
+
+ class T
+
+
+ std::unique_ptr< [PhysicalCudaMemory]< T > >
+ std::unique_ptr<PhysicalCudaMemory<T> > mscclpp::allocUniquePhysicalCuda
+ (size_t count, size_t gran)
+ allocUniquePhysicalCuda
+ size_t
+ count
+
+ size_t
+ gran
+
+
+
+
+Allocated physical memory on the device and returns a memory handle along with a virtual memory handle for it. The memory is zeroed out.
+
+T
+
+
+Type of each element in the allocated memory.
+
+
+
+
+count
+
+
+Number of elements to allocate.
+
+
+
+
+gran
+
+
+the granularity of the allocation.
+
+
+A std::unique_ptr to the memory handle and a device pointer for that memory.
+
+
+
+
+
+
+
+ class T
+
+
+ [UniqueCudaPtr]< T >UniqueCudaPtr<T> mscclpp::allocExtUniqueCuda
+ (size_t count=1)
+ allocExtUniqueCuda
+ size_t
+ count
+ 1
+
+
+
+
+Allocates memory on the device and returns a std::unique_ptr to it. The memory is zeroed out.
+
+T
+
+
+Type of each element in the allocated memory.
+
+
+
+
+count
+
+
+Number of elements to allocate.
+
+
+A std::unique_ptr to the allocated memory.
+
+
+
+
+
+
+
+ class T
+
+ typename...
+ Args
+ Args
+
+
+ std::shared_ptr< T >
+ std::shared_ptr<T> mscclpp::makeSharedCudaHost
+ (Args &&... args)
+ makeSharedCudaHost
+ Args &&...
+ args
+
+
+
+
+Allocates memory with cudaHostAlloc, constructs an object of type T in it and returns a std::shared_ptr to it.
+
+T
+
+
+Type of the object to construct.
+
+
+
+
+Args
+
+
+Types of the arguments to pass to the constructor.
+
+
+
+
+args
+
+
+Arguments to pass to the constructor.
+
+
+A std::shared_ptr to the allocated memory.
+
+
+
+
+
+
+
+ class T
+
+
+ std::shared_ptr< T[]>
+ std::shared_ptr<T[]> mscclpp::makeSharedCudaHost
+ (size_t count)
+ makeSharedCudaHost
+ size_t
+ count
+
+
+
+
+Allocates an array of objects of type T with cudaHostAlloc, default constructs each element and returns a std::shared_ptr to it.
+
+T
+
+
+Type of the object to construct.
+
+
+
+
+count
+
+
+Number of elements to allocate.
+
+
+A std::shared_ptr to the allocated memory.
+
+
+
+
+
+
+
+ class T
+
+ typename...
+ Args
+ Args
+
+ std::enable_if_t< false==std::is_array_v< T >, bool >
+ true
+
+
+ [UniqueCudaHostPtr]< T >UniqueCudaHostPtr<T> mscclpp::makeUniqueCudaHost
+ (Args &&... args)
+ makeUniqueCudaHost
+ Args &&...
+ args
+
+
+
+
+Allocates memory with cudaHostAlloc, constructs an object of type T in it and returns a std::unique_ptr to it.
+
+T
+
+
+Type of the object to construct.
+
+
+
+
+Args
+
+
+Types of the arguments to pass to the constructor.
+
+
+
+
+args
+
+
+Arguments to pass to the constructor.
+
+
+A std::unique_ptr to the allocated memory.
+
+
+
+
+
+
+
+ class T
+
+ std::enable_if_t< true==std::is_array_v< T >, bool >
+ true
+
+
+ [UniqueCudaHostPtr]< T >UniqueCudaHostPtr<T> mscclpp::makeUniqueCudaHost
+ (size_t count)
+ makeUniqueCudaHost
+ size_t
+ count
+
+
+
+
+Allocates an array of objects of type T with cudaHostAlloc, default constructs each element and returns a std::unique_ptr to it.
+
+T
+
+
+Type of the object to construct.
+
+
+
+
+count
+
+
+Number of elements to allocate.
+
+
+A std::unique_ptr to the allocated memory.
+
+
+
+
+
+
+
+ class T
+
+
+ void
+ void mscclpp::memcpyCudaAsync
+ (T *dst, const T *src, size_t count, cudaStream_t stream, cudaMemcpyKind kind=cudaMemcpyDefault)
+ memcpyCudaAsync
+ T *
+ dst
+
+ const T *
+ src
+
+ size_t
+ count
+
+ cudaStream_t
+ stream
+
+ cudaMemcpyKind
+ kind
+ cudaMemcpyDefault
+
+
+
+
+Asynchronous cudaMemcpy without capture into a CUDA graph.
+
+T
+
+
+Type of each element in the allocated memory.
+
+
+
+
+dst
+
+
+Destination pointer.
+
+
+
+
+src
+
+
+Source pointer.
+
+
+
+
+count
+
+
+Number of elements to copy.
+
+
+
+
+stream
+
+
+CUDA stream to use.
+
+
+
+
+kind
+
+
+Type of cudaMemcpy to perform.
+
+
+
+
+
+
+
+
+
+ class T
+
+
+ void
+ void mscclpp::memcpyCuda
+ (T *dst, const T *src, size_t count, cudaMemcpyKind kind=cudaMemcpyDefault)
+ memcpyCuda
+ T *
+ dst
+
+ const T *
+ src
+
+ size_t
+ count
+
+ cudaMemcpyKind
+ kind
+ cudaMemcpyDefault
+
+
+
+
+Synchronous cudaMemcpy without capture into a CUDA graph.
+
+T
+
+
+Type of each element in the allocated memory.
+
+
+
+
+dst
+
+
+Destination pointer.
+
+
+
+
+src
+
+
+Source pointer.
+
+
+
+
+count
+
+
+Number of elements to copy.
+
+
+
+
+kind
+
+
+Type of cudaMemcpy to perform.
+
+
+
+
+
+
+
+
+ int
+ int mscclpp::getDeviceNumaNode
+ (int cudaDev)
+ getDeviceNumaNode
+ int
+ cudaDev
+
+
+
+
+
+
+
+
+
+ void
+ void mscclpp::numaBind
+ (int node)
+ numaBind
+ int
+ node
+
+
+
+
+
+
+
+
+
+ std::shared_ptr< [NvlsConnection] >
+ std::shared_ptr<NvlsConnection> mscclpp::connectNvlsCollective
+ (std::shared_ptr< Communicator > comm, std::vector< int > allRanks, size_t bufferSize=NvlsConnection::DefaultNvlsBufferSize)
+ connectNvlsCollective
+ std::shared_ptr< [Communicator] >
+ comm
+
+ std::vector< int >
+ allRanks
+
+ size_t
+ bufferSize
+ [NvlsConnection::DefaultNvlsBufferSize]
+
+
+Connect to NVLS on setup.
+This function used to connect to NVLS on setup. NVLS collective using multicast operations to send/recv data. Here we need to put all involved ranks into the collective group.
+
+
+comm
+
+
+The communicator.
+
+
+
+
+allRanks
+
+
+The ranks of all processes involved in the collective.
+
+
+
+
+config
+
+
+The configuration for the local endpoint.
+
+
+std::shared_ptr<NvlsConnection> A shared pointer to the NVLS connection.
+
+
+
+
+
+ std::string
+ std::string mscclpp::getHostName
+ (int maxlen, const char delim)
+ getHostName
+ int
+ maxlen
+
+ const char
+ delim
+
+
+
+
+
+
+
+
+
+ bool
+ bool mscclpp::isNvlsSupported
+ ()
+ isNvlsSupported
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacemscclpp_1_1detail.xml b/docs/doxygen/xml/namespacemscclpp_1_1detail.xml
new file mode 100644
index 00000000..55e8f724
--- /dev/null
+++ b/docs/doxygen/xml/namespacemscclpp_1_1detail.xml
@@ -0,0 +1,290 @@
+
+
+
+ mscclpp::detail
+
+
+ std::bitset< [TransportFlagsSize] >
+ using mscclpp::detail::TransportFlagsBase = typedef std::bitset<TransportFlagsSize>
+ TransportFlagsBase
+
+Bitset for storing transport flags.
+
+
+
+
+
+
+
+
+
+ const size_t
+ const size_t mscclpp::detail::TransportFlagsSize
+ TransportFlagsSize
+ = 12
+
+
+
+
+
+
+
+
+
+
+
+ class T
+
+
+ T *
+ T* mscclpp::detail::cudaCalloc
+ (size_t nelem)
+ cudaCalloc
+ size_t
+ nelem
+
+
+
+
+A wrapper of cudaMalloc that sets the allocated memory to zero.
+
+T
+
+
+Type of each element in the allocated memory.
+
+
+
+
+nelem
+
+
+Number of elements to allocate.
+
+
+A pointer to the allocated memory.
+
+
+
+
+
+
+
+ class T
+
+
+ [PhysicalCudaMemory]< T > *PhysicalCudaMemory<T>* mscclpp::detail::cudaPhysicalCalloc
+ (size_t nelem, size_t gran)
+ cudaPhysicalCalloc
+ size_t
+ nelem
+
+ size_t
+ gran
+
+
+
+
+
+
+
+
+
+
+ class T
+
+
+ T *
+ T* mscclpp::detail::cudaExtCalloc
+ (size_t nelem)
+ cudaExtCalloc
+ size_t
+ nelem
+
+
+
+
+
+
+
+
+
+
+ class T
+
+
+ T *
+ T* mscclpp::detail::cudaHostCalloc
+ (size_t nelem)
+ cudaHostCalloc
+ size_t
+ nelem
+
+
+
+
+A wrapper of cudaHostAlloc that sets the allocated memory to zero.
+
+T
+
+
+Type of each element in the allocated memory.
+
+
+
+
+nelem
+
+
+Number of elements to allocate.
+
+
+A pointer to the allocated memory.
+
+
+
+
+
+
+
+ class T
+
+ T *
+
+ class Deleter
+
+ class Memory
+
+
+ Memory
+ Memory mscclpp::detail::safeAlloc
+ (size_t nelem)
+ safeAlloc
+ size_t
+ nelem
+
+
+
+
+A template function that allocates memory while ensuring that the memory will be freed when the returned object is destroyed.
+
+T
+
+
+Type of each element in the allocated memory.
+
+
+
+
+alloc
+
+
+A function that allocates memory.
+
+
+
+
+Deleter
+
+
+A deleter that will be used to free the allocated memory.
+
+
+
+
+Memory
+
+
+The type of the returned object.
+
+
+
+
+nelem
+
+
+Number of elements to allocate.
+
+
+An object of type Memory that will free the allocated memory when destroyed.
+
+
+
+
+
+
+
+ class T
+
+ T *
+
+ class Deleter
+
+ class Memory
+
+
+ Memory
+ Memory mscclpp::detail::safeAlloc
+ (size_t nelem, size_t gran)
+ safeAlloc
+ size_t
+ nelem
+
+ size_t
+ gran
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacestd.xml b/docs/doxygen/xml/namespacestd.xml
new file mode 100644
index 00000000..103e81b6
--- /dev/null
+++ b/docs/doxygen/xml/namespacestd.xml
@@ -0,0 +1,11 @@
+
+
+
+ std
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/npkit_8hpp.xml b/docs/doxygen/xml/npkit_8hpp.xml
new file mode 100644
index 00000000..e0cac53d
--- /dev/null
+++ b/docs/doxygen/xml/npkit_8hpp.xml
@@ -0,0 +1,240 @@
+
+
+
+ npkit.hpp
+ mscclpp/device.hpp
+ mscclpp/gpu_utils.hpp
+ mscclpp/npkit/npkit_event.hpp
+ mscclpp/npkit/npkit_struct.hpp
+ string
+ thread
+ vector
+
+
+ mscclpp/npkit/npkit_event.hpp
+
+
+ mscclpp/device.hpp
+
+
+ mscclpp/npkit/npkit_struct.hpp
+
+
+
+
+ errors.hpp
+
+
+
+
+ cstdint
+
+
+ linux/version.h
+
+
+ cuda_runtime.h
+
+
+ stdexcept
+
+
+ string
+
+
+ gpu.hpp
+
+
+
+
+
+
+
+
+ vector
+
+
+ cuda.h
+
+
+ thread
+
+
+ cstring
+
+
+ mscclpp/gpu_utils.hpp
+
+
+
+
+
+
+
+
+
+
+ memory
+
+
+ npkit.hpp
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ NpKit
+
+
+ NPKIT_GET_GPU_TIMESTAMP
+ clock64
+
+
+
+
+
+
+
+
+ NPKIT_SHM_NUM_EVENTS
+ 64
+
+
+
+
+
+
+
+
+
+
+
+
+
+#ifndef #define #include[mscclpp/device.hpp]> #include[mscclpp/gpu_utils.hpp]> #include[mscclpp/npkit/npkit_event.hpp]> #include[mscclpp/npkit/npkit_struct.hpp]> #include #include #include #if #define #define #define #define #define #else #define #endif #define class [NpKit]public : static const [kNumGpuEventBuffers]static const [kNumCpuEventBuffers]static void [Init](int static void [Dump](const static void [Shutdown]();static [NpKitEventCollectContext]*[GetGpuEventCollectContexts]();#if static void [NpKitEvent]*if [NPKIT_SHM_NUM_EVENTS])if [NpKitEvent]&event event .[fields].[type] event .fields.size event .fields.rsvd event .fields.timestamp static void [NpKitEventCollectContext]*[NpKitEvent]*[__syncshm]();[NpKitEventCollectContext]*[NpKitEvent]*[event_buffer];[event_buffer_head];for size_t sizeof ([NpKitEvent]) sizeof (int4); if [event_buffer_head]#endif static void [CollectCpuEvent](uint8_tint static [GetCpuTimestamp]();private : static void static const static const static static static [mscclpp::UniqueCudaPtr<NpKitEventCollectContext>]static static #if static [mscclpp::UniqueCudaHostPtr<uint64_t[]>]#else static [mscclpp::UniqueCudaHostPtr<uint64_t>]#endif static static volatile bool }; #endif
+
+
diff --git a/docs/doxygen/xml/npkit__event_8hpp.xml b/docs/doxygen/xml/npkit__event_8hpp.xml
new file mode 100644
index 00000000..e82b59df
--- /dev/null
+++ b/docs/doxygen/xml/npkit__event_8hpp.xml
@@ -0,0 +1,123 @@
+
+
+
+ npkit_event.hpp
+ npkit.hpp
+
+
+ npkit_event.hpp
+
+
+
+
+ npkit.hpp
+
+
+
+
+ NPKIT_EVENT_INVALID
+ 0x0
+
+
+
+
+
+
+
+
+ NPKIT_EVENT_TIME_SYNC_GPU
+ 0x1
+
+
+
+
+
+
+
+
+ NPKIT_EVENT_TIME_SYNC_CPU
+ 0x2
+
+
+
+
+
+
+
+
+ NPKIT_EVENT_EXECUTOR_INIT_ENTRY
+ 0x3
+
+
+
+
+
+
+
+
+ NPKIT_EVENT_EXECUTOR_INIT_EXIT
+ 0x4
+
+
+
+
+
+
+
+
+ NPKIT_EVENT_EXECUTOR_OP_BASE_ENTRY
+ 0x5
+
+
+
+
+
+
+
+
+ NPKIT_EVENT_EXECUTOR_OP_BASE_EXIT
+ 0x17
+
+
+
+
+
+
+
+
+
+
+
+
+
+#ifndef #define #define #define #define #define #define #define #define #endif
+
+
diff --git a/docs/doxygen/xml/npkit__struct_8hpp.xml b/docs/doxygen/xml/npkit__struct_8hpp.xml
new file mode 100644
index 00000000..e4e15998
--- /dev/null
+++ b/docs/doxygen/xml/npkit__struct_8hpp.xml
@@ -0,0 +1,68 @@
+
+
+
+ npkit_struct.hpp
+ cstdint
+ npkit.hpp
+
+
+ npkit_struct.hpp
+
+
+
+
+ cstdint
+
+
+
+
+ npkit_struct.hpp
+
+
+
+
+ npkit.hpp
+
+
+ NpKitEvent
+ NpKitEventCollectContext
+
+
+
+
+
+#ifndef #define #include #pragma union [NpKitEvent][bits][2];struct { [type][size][rsvd][timestamp];[fields];}; struct [NpKitEventCollectContext][NpKitEvent]*[event_buffer];[event_buffer_head];}; #pragma #endif
+
+
diff --git a/docs/doxygen/xml/numa_8hpp.xml b/docs/doxygen/xml/numa_8hpp.xml
new file mode 100644
index 00000000..c0c9f33c
--- /dev/null
+++ b/docs/doxygen/xml/numa_8hpp.xml
@@ -0,0 +1,28 @@
+
+
+
+ numa.hpp
+ mscclpp
+
+
+
+
+
+#ifndef #define namespace [mscclpp]int [getDeviceNumaNode](int void [numaBind](int } #endif
+
+
diff --git a/docs/doxygen/xml/nvls_8hpp.xml b/docs/doxygen/xml/nvls_8hpp.xml
new file mode 100644
index 00000000..58152356
--- /dev/null
+++ b/docs/doxygen/xml/nvls_8hpp.xml
@@ -0,0 +1,152 @@
+
+
+
+ nvls.hpp
+ mscclpp/gpu_utils.hpp
+ mscclpp/nvls_device.hpp
+
+
+ device.hpp
+
+
+ errors.hpp
+
+
+
+
+ linux/version.h
+
+
+ cuda_runtime.h
+
+
+ nvls.hpp
+
+
+
+
+
+
+ stdexcept
+
+
+ mscclpp/nvls_device.hpp
+
+
+
+
+
+
+
+
+ gpu.hpp
+
+
+
+
+
+
+
+
+ cuda.h
+
+
+ type_traits
+
+
+ cstring
+
+
+ mscclpp/gpu_utils.hpp
+
+
+
+
+
+
+
+
+
+
+ memory
+
+
+ mscclpp::NvlsConnection
+ mscclpp::NvlsConnection::DeviceMulticastPointer
+ mscclpp
+
+
+
+
+
+#ifndef #define #include[mscclpp/gpu_utils.hpp]> #include[mscclpp/nvls_device.hpp]> namespace [mscclpp]class [NvlsConnection]public : [NvlsConnection](size_t int [NvlsConnection](const [NvlsConnection]()delete ; [serialize]();static const int [DefaultNvlsBufferSize];void [addDevice]();void [addDevice](int struct [DeviceMulticastPointer]private : size_t public : using [DeviceHandle][DeviceMulticastPointerDeviceHandle];[DeviceMulticastPointer](std::shared_ptr<[PhysicalCudaMemory<char>]>size_t [DeviceHandle][deviceHandle]();char *[getDevicePtr](); friend class [NvlsConnection];[allocateAndBindCuda](size_t [bindAllocatedCuda](CUmemGenericAllocationHandlesize_t size_t [getMultiCastMinGranularity]();private : class Impl; }; class [Communicator];std::shared_ptr<NvlsConnection>[connectNvlsCollective](std::shared_ptr<Communicator> size_t [NvlsConnection::DefaultNvlsBufferSize]);} #endif
+
+
diff --git a/docs/doxygen/xml/nvls__device_8hpp.xml b/docs/doxygen/xml/nvls__device_8hpp.xml
new file mode 100644
index 00000000..867f401e
--- /dev/null
+++ b/docs/doxygen/xml/nvls__device_8hpp.xml
@@ -0,0 +1,181 @@
+
+
+
+ nvls_device.hpp
+ mscclpp/gpu.hpp
+ type_traits
+ device.hpp
+ nvls.hpp
+
+
+ device.hpp
+
+
+ linux/version.h
+
+
+ cuda_runtime.h
+
+
+ nvls_device.hpp
+
+
+
+
+
+
+
+
+ mscclpp/gpu.hpp
+
+
+
+
+
+
+
+
+ cuda.h
+
+
+ type_traits
+
+
+
+
+ nvls.hpp
+
+
+ nvls_device.hpp
+
+
+
+
+ mscclpp::DeviceMulticastPointerDeviceHandle
+ mscclpp
+
+
+
+
+
+#ifndef #define #include[mscclpp/gpu.hpp]> #include #if #include #endif #include[device.hpp]" namespace [mscclpp]template class > constexpr bool [dependentFalse]false ; struct [DeviceMulticastPointerDeviceHandle]void *[devicePtr]; void *[mcPtr]; size_t [bufferSize];#if template typename typename static void if asm ( "multimem.ld_reduce.relaxed.sys.global.add.v4.f32 "=r" (val.x), "=r" (val.y), "=r" (val.z), "=r" (val.w) "l" (ptr) "memory" ); else if asm ( "multimem.ld_reduce.relaxed.sys.global.add.v2.f32 "=r" (val.x), "=r" (val.y) "l" (ptr) "memory" ); else if asm ( "multimem.ld_reduce.relaxed.sys.global.add.f32 "=r" (val.x) "l" (ptr) "memory" ); else if asm ( "multimem.ld_reduce.relaxed.sys.global.add.v4.f16x2 "=r" (val.x), "=r" (val.y), "=r" (val.z), "=r" (val.w) "l" (ptr) "memory" ); else if asm ( "multimem.ld_reduce.relaxed.sys.global.add.v2.f16x2 "=r" (val.x), "=r" (val.y) "l" (ptr) "memory" ); else if asm ( "multimem.ld_reduce.relaxed.sys.global.add.f16x2 "=r" (val.x) "l" (ptr) "memory" ); else "Not ); template typename typename static void const if asm volatile ( "multimem.st.relaxed.sys.global.v4.f32 "l" (ptr), "r" (val.x), "r" (val.y), "r" (val.z), "r" (val.w) "memory" ); else if asm volatile ( "multimem.st.relaxed.sys.global.v2.f32 "l" (ptr), "r" (val.x), "r" (val.y) "memory" ); else if asm volatile ( "multimem.st.relaxed.sys.global.f32 "l" (ptr), "r" (val.x) "memory" ); else if asm volatile ( "multimem.st.relaxed.sys.global.v4.f16x2 "l" (ptr), "r" (val.x), "r" (val.y), "r" (val.z), "r" (val.w) "memory" ); else if asm volatile ( "multimem.st.relaxed.sys.global.v2.f16x2 "l" (ptr), "r" (val.x), "r" (val.y) "memory" ); else if asm volatile ( "multimem.st.relaxed.sys.global.f16x2 "l" (ptr), "r" (val.x) "memory" ); else "Not ); template typename typename static void const if asm volatile ( "multimem.red.relaxed.sys.global.add.v4.f32 "l" (ptr), "r" (val.x), "r" (val.y), "r" (val.z), "r" (val.w) "memory" ); else if asm volatile ( "multimem.red.relaxed.sys.global.add.v2.f32 "l" (ptr), "r" (val.x), "r" (val.y) "memory" ); else if asm volatile ( "multimem.red.relaxed.sys.global.add.f32 "l" (ptr), "r" (val.x) "memory" ); else if asm volatile ( "multimem.red.relaxed.sys.global.add.v4.f16x2 "l" (ptr), "r" (val.x), "r" (val.y), "r" (val.z), "r" (val.w) "memory" ); else if asm volatile ( "multimem.red.relaxed.sys.global.add.v2.f16x2 "l" (ptr), "r" (val.x), "r" (val.y) "memory" ); else if asm volatile ( "multimem.red.relaxed.sys.global.add.f16x2 "l" (ptr), "r" (val.x) "memory" ); else "Not ); #endif }; } #endif
+
+
diff --git a/docs/doxygen/xml/packet__device_8hpp.xml b/docs/doxygen/xml/packet__device_8hpp.xml
new file mode 100644
index 00000000..c7f73517
--- /dev/null
+++ b/docs/doxygen/xml/packet__device_8hpp.xml
@@ -0,0 +1,263 @@
+
+
+
+ packet_device.hpp
+ cstdint
+ type_traits
+ device.hpp
+
+
+ device.hpp
+
+
+ cstdint
+
+
+ packet_device.hpp
+
+
+
+
+
+
+
+
+ type_traits
+
+
+ mscclpp::LL16Packet
+ mscclpp::LL8Packet
+ mscclpp
+
+
+
+
+
+#ifndef #define #include #include #include[device.hpp]" #if #include[atomic_device.hpp]" #include[poll_device.hpp]" #endif namespace [mscclpp]union alignas (16)[LL16Packet] struct { [data1];[flag1];[data2];[flag2];using [Payload]#if [LL16Packet]()[LL16Packet](uint2[data1][flag1][data2][flag2]void #if asm volatile ( "st.volatile.global.v4.u32 "l" (&raw_), "r" (val1), "r" (flag), "r" (val2), "r" (flag)); #else reinterpret_cast< ulonglong2* > (®); #endif void void bool { #if [flag1],[flag2];asm volatile ( "ld.volatile.global.v4.u32 "=r" (data.x), "=r" ([flag1]), "=r" (data.y), "=r" ([flag2]) "l" (&raw_)); return [flag1][flag2]#else reinterpret_cast< uint4* > (®); return #endif { return void #endif }; union alignas (8)[LL8Packet] struct { [data];[flag];[raw_];using [Payload]#if [LL8Packet]()[LL8Packet](uint32_t[flag])[flag];void [flag])#if asm volatile ( "st.volatile.global.v2.u32 "l" (&[raw_]), "r" (val), "r" ([flag])); #else [flag]);reinterpret_cast< uint64_t* > (®); [raw_]),#endif bool [flag],[data]){ #if asm volatile ( "ld.volatile.global.v2.u32 "=r" ([data]), "=r" (f) "l" (&[raw_])); return [flag]);#else [raw_]),reinterpret_cast< uint2* > (®); [data]return [flag]);#endif [flag],{ [data];[flag],[data]),return [data];void [raw_]#endif }; using [LLPacket][LL16Packet];#if MSCCLPP_DEVICE_INLINE void void * const void * const const const char *)originPtr [LL16Packet]*[LL16Packet]*)((char *)targetPtr size_t sizeof (uint64_t); for size_t [LL16Packet]*} MSCCLPP_DEVICE_INLINE void const void * void * const const const char *)targetPtr char *)originPtr size_t sizeof (uint2); for size_t const } MSCCLPP_DEVICE_INLINE void void * const void * const const const char *)originPtr char *)targetPtr size_t sizeof (uint32_t); for size_t } MSCCLPP_DEVICE_INLINE void const void * void * const const const char *)targetPtr char *)originPtr size_t sizeof (uint32_t); for size_t const } template typename MSCCLPP_DEVICE_INLINE void void * const void * if else if else "Unsupported ); } template typename MSCCLPP_DEVICE_INLINE void const void * void * if else if else "Unsupported ); } #endif }; #endif
+
+
diff --git a/docs/doxygen/xml/poll__device_8hpp.xml b/docs/doxygen/xml/poll__device_8hpp.xml
new file mode 100644
index 00000000..9a9f8321
--- /dev/null
+++ b/docs/doxygen/xml/poll__device_8hpp.xml
@@ -0,0 +1,94 @@
+
+
+
+ poll_device.hpp
+ device.hpp
+ concurrency_device.hpp
+
+
+ device.hpp
+
+
+ poll_device.hpp
+
+
+
+
+
+
+ poll_device.hpp
+
+
+
+
+ concurrency_device.hpp
+
+
+
+
+
+
+
+#ifndef #define #include[device.hpp]" #if #include #if #define #else #if extern "C" void const char const char unsigned int const char #else extern "C" void const char const char unsigned int const char #endif #endif #define #define #endif #endif
+
+
diff --git a/docs/doxygen/xml/proxy_8hpp.xml b/docs/doxygen/xml/proxy_8hpp.xml
new file mode 100644
index 00000000..64ba71c6
--- /dev/null
+++ b/docs/doxygen/xml/proxy_8hpp.xml
@@ -0,0 +1,117 @@
+
+
+
+ proxy.hpp
+ functional
+ memory
+ fifo.hpp
+ proxy_channel.hpp
+
+
+ device.hpp
+
+
+ functional
+
+
+ cstdint
+
+
+ proxy.hpp
+
+
+
+
+
+
+
+
+ memory
+
+
+ fifo.hpp
+
+
+
+
+
+
+
+
+
+
+ fifo_device.hpp
+
+
+
+
+
+
+
+
+ proxy.hpp
+
+
+
+
+ proxy_channel.hpp
+
+
+ mscclpp::Proxy
+ mscclpp
+
+
+
+
+
+#ifndef #define #include #include #include[fifo.hpp]" namespace [mscclpp]enum [ProxyHandlerResult][Continue],[FlushFifoTailAndContinue],[Stop],}; class Proxy; using [ProxyHandler][ProxyHandlerResult]([ProxyTrigger])>;class [Proxy]public : [Proxy]([ProxyHandler]void ()> size_t [DEFAULT_FIFO_SIZE]);[Proxy]([ProxyHandler]size_t [DEFAULT_FIFO_SIZE]);[~Proxy]();void [start]();void [stop]();[Fifo]&[fifo]();private : struct Impl; }; } #endif
+
+
diff --git a/docs/doxygen/xml/proxy__channel_8hpp.xml b/docs/doxygen/xml/proxy__channel_8hpp.xml
new file mode 100644
index 00000000..bdeab39e
--- /dev/null
+++ b/docs/doxygen/xml/proxy__channel_8hpp.xml
@@ -0,0 +1,284 @@
+
+
+
+ proxy_channel.hpp
+ core.hpp
+ proxy.hpp
+ proxy_channel_device.hpp
+ semaphore.hpp
+
+
+ device.hpp
+
+
+ functional
+
+
+ core.hpp
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ errors.hpp
+
+
+
+
+ cstdint
+
+
+ linux/version.h
+
+
+ proxy_channel_device.hpp
+
+
+
+
+
+
+ cuda_runtime.h
+
+
+ stdexcept
+
+
+ string
+
+
+ semaphore_device.hpp
+
+
+
+
+ mscclpp/gpu.hpp
+
+
+
+
+
+
+
+
+ bitset
+
+
+ future
+
+
+ proxy.hpp
+
+
+
+
+
+
+
+
+ vector
+
+
+ array
+
+
+ semaphore.hpp
+
+
+
+
+
+
+
+
+
+
+ cuda.h
+
+
+ proxy_channel.hpp
+
+
+
+
+
+
+
+
+
+
+ cstring
+
+
+ mscclpp/gpu_utils.hpp
+
+
+
+
+
+
+
+
+
+
+ memory
+
+
+ fifo.hpp
+
+
+
+
+
+
+
+
+
+
+ fifo_device.hpp
+
+
+
+
+
+
+ mscclpp::BaseProxyService
+ mscclpp::ProxyService
+ mscclpp::ProxyChannel
+ mscclpp::SimpleProxyChannel
+ mscclpp
+
+
+
+
+
+#ifndef #define #include[core.hpp]" #include[proxy.hpp]" #include[proxy_channel_device.hpp]" #include[semaphore.hpp]" namespace [mscclpp]struct ProxyChannel; class [BaseProxyService]public : [BaseProxyService]()default ; virtual [~BaseProxyService]()default ; virtual void [startProxy]()virtual void [stopProxy]()}; class [ProxyService]public [BaseProxyService]public : [ProxyService](size_t [DEFAULT_FIFO_SIZE]);[SemaphoreId][buildAndAddSemaphore]([Communicator]&[SemaphoreId][addSemaphore](std::shared_ptr<Host2DeviceSemaphore>[semaphore]);[MemoryId][addMemory]([RegisteredMemory][semaphore]([SemaphoreId]id ) const ; [ProxyChannel][proxyChannel]([SemaphoreId]id ); void [startProxy]();void [stopProxy]();private : int void [ProxyHandlerResult][ProxyTrigger]}; struct [ProxyChannel]private : [SemaphoreId]public : [ProxyChannel]()default ; [ProxyChannel]([SemaphoreId][ProxyChannel](const [ProxyChannel]&default ; [ProxyChannel]&[operator=]([ProxyChannel]&default ; using [DeviceHandle][ProxyChannelDeviceHandle];[DeviceHandle][deviceHandle]()const ; }; struct [SimpleProxyChannel]private : [ProxyChannel][MemoryId][MemoryId]public : [SimpleProxyChannel]()default ; [SimpleProxyChannel]([ProxyChannel][MemoryId][MemoryId][SimpleProxyChannel]([ProxyChannel][SimpleProxyChannel](const [SimpleProxyChannel]&default ; [SimpleProxyChannel]&[operator=]([SimpleProxyChannel]&default ; using [DeviceHandle][SimpleProxyChannelDeviceHandle];[DeviceHandle][deviceHandle]()const ; }; } #endif
+
+
diff --git a/docs/doxygen/xml/proxy__channel__device_8hpp.xml b/docs/doxygen/xml/proxy__channel__device_8hpp.xml
new file mode 100644
index 00000000..5f802b37
--- /dev/null
+++ b/docs/doxygen/xml/proxy__channel__device_8hpp.xml
@@ -0,0 +1,295 @@
+
+
+
+ proxy_channel_device.hpp
+ fifo_device.hpp
+ semaphore_device.hpp
+ proxy_channel.hpp
+
+
+ device.hpp
+
+
+ cstdint
+
+
+ proxy_channel_device.hpp
+
+
+
+
+
+
+ semaphore_device.hpp
+
+
+
+
+ fifo_device.hpp
+
+
+
+
+
+
+
+
+ proxy_channel_device.hpp
+
+
+
+
+ proxy_channel.hpp
+
+
+ mscclpp::ChannelTrigger
+ mscclpp::ProxyChannelDeviceHandle
+ mscclpp::SimpleProxyChannelDeviceHandle
+ mscclpp
+
+
+ MSCCLPP_BITS_SIZE
+ 32
+
+
+
+
+
+
+
+
+ MSCCLPP_BITS_OFFSET
+ 32
+
+
+
+
+
+
+
+
+ MSCCLPP_BITS_REGMEM_HANDLE
+ 9
+
+
+
+
+
+
+
+
+ MSCCLPP_BITS_TYPE
+ 3
+
+
+
+
+
+
+
+
+ MSCCLPP_BITS_CONNID
+ 10
+
+
+
+
+
+
+
+
+ MSCCLPP_BITS_FIFO_RESERVED
+ 1
+
+
+
+
+
+
+
+
+
+
+
+
+
+#ifndef #define #include[fifo_device.hpp]" #include[semaphore_device.hpp]" namespace [mscclpp]using [SemaphoreId]using [MemoryId]using [TriggerType]const [TriggerType][TriggerData]const [TriggerType][TriggerFlag]const [TriggerType][TriggerSync]#define #define #define #define #define #define union [ChannelTrigger][ProxyTrigger][value];struct { [size][MSCCLPP_BITS_SIZE];[srcOffset][MSCCLPP_BITS_OFFSET];[MSCCLPP_BITS_SIZE][MSCCLPP_BITS_OFFSET]);[dstOffset][MSCCLPP_BITS_OFFSET];[srcMemoryId][MSCCLPP_BITS_REGMEM_HANDLE];[dstMemoryId][MSCCLPP_BITS_REGMEM_HANDLE];[type][MSCCLPP_BITS_TYPE];[chanId][MSCCLPP_BITS_CONNID];[MSCCLPP_BITS_OFFSET][MSCCLPP_BITS_REGMEM_HANDLE][MSCCLPP_BITS_REGMEM_HANDLE][MSCCLPP_BITS_TYPE][MSCCLPP_BITS_CONNID][MSCCLPP_BITS_FIFO_RESERVED]);[reserved][MSCCLPP_BITS_FIFO_RESERVED];[fields];#if [ChannelTrigger]()[value])[value]([value])[TriggerType][type],[MemoryId][dstOffset],[MemoryId][srcOffset],int [MSCCLPP_BITS_SIZE])[MSCCLPP_BITS_OFFSET])[MSCCLPP_BITS_OFFSET])[MSCCLPP_BITS_REGMEM_HANDLE])[MSCCLPP_BITS_REGMEM_HANDLE])[MSCCLPP_BITS_TYPE])[MSCCLPP_BITS_CONNID])[value].[fst][srcOffset][MSCCLPP_BITS_SIZE])[value].[snd][MSCCLPP_BITS_TYPE])[type][MSCCLPP_BITS_REGMEM_HANDLE])[MSCCLPP_BITS_REGMEM_HANDLE])[MSCCLPP_BITS_OFFSET])[dstOffset]#endif }; struct [ProxyChannelDeviceHandle][SemaphoreId][semaphoreId_];[Host2DeviceSemaphoreDeviceHandle][semaphore_];[FifoDeviceHandle][fifo_];#if void [MemoryId][MemoryId][fifo_].push([ChannelTrigger]([TriggerData],[semaphoreId_]).value);void [MemoryId][MemoryId]void [fifo_].push(ChannelTrigger([TriggerFlag],[semaphoreId_]).value);void [MemoryId][MemoryId][fifo_].push(ChannelTrigger([TriggerData][TriggerFlag],[semaphoreId_]).value);void [MemoryId][MemoryId]void [MemoryId][MemoryId][fifo_].push([TriggerData][TriggerFlag][TriggerSync],[semaphoreId_])[fifo_].sync(curFifoHead);void [MemoryId][MemoryId]void [fifo_].push(ChannelTrigger([TriggerSync],[semaphoreId_]).value);[fifo_].sync(curFifoHead);bool return [semaphore_].poll();void [semaphore_].wait(maxSpinCount);#endif }; struct [SimpleProxyChannelDeviceHandle][ProxyChannelDeviceHandle][proxyChan_];[MemoryId][dst_];[MemoryId][src_];#if void [proxyChan_].put([dst_],[src_],void void [proxyChan_].signal();void [proxyChan_].putWithSignal([dst_],[src_],void void [proxyChan_].putWithSignalAndFlush([dst_],[src_],void void [proxyChan_].flush();bool return [proxyChan_].poll();void [proxyChan_].wait(maxSpinCount);#endif }; } #endif
+
+
diff --git a/docs/doxygen/xml/semaphore_8hpp.xml b/docs/doxygen/xml/semaphore_8hpp.xml
new file mode 100644
index 00000000..c13bbcf4
--- /dev/null
+++ b/docs/doxygen/xml/semaphore_8hpp.xml
@@ -0,0 +1,231 @@
+
+
+
+ semaphore.hpp
+ memory
+ core.hpp
+ gpu_utils.hpp
+ semaphore_device.hpp
+ proxy_channel.hpp
+ sm_channel.hpp
+
+
+ device.hpp
+
+
+ core.hpp
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ errors.hpp
+
+
+
+
+ linux/version.h
+
+
+ cuda_runtime.h
+
+
+ stdexcept
+
+
+ string
+
+
+ semaphore_device.hpp
+
+
+
+
+ mscclpp/gpu.hpp
+
+
+
+
+
+
+
+
+ bitset
+
+
+ future
+
+
+ vector
+
+
+ array
+
+
+ semaphore.hpp
+
+
+
+
+
+
+
+
+
+
+ cuda.h
+
+
+ cstring
+
+
+ mscclpp/gpu_utils.hpp
+
+
+
+
+
+
+
+
+
+
+ memory
+
+
+
+
+ semaphore.hpp
+
+
+
+
+
+
+ proxy_channel.hpp
+
+
+ sm_channel.hpp
+
+
+ mscclpp::BaseSemaphore
+ mscclpp::Host2DeviceSemaphore
+ mscclpp::Host2HostSemaphore
+ mscclpp::SmDevice2DeviceSemaphore
+ mscclpp
+
+
+
+
+
+#ifndef #define #include #include[core.hpp]" #include[gpu_utils.hpp]" #include[semaphore_device.hpp]" namespace [mscclpp]template template typename > typename template typename > typename class [BaseSemaphore]protected : [NonblockingFuture<RegisteredMemory>][remoteInboundSemaphoreIdsRegMem_];[localInboundSemaphore_];[expectedInboundSemaphore_];[outboundSemaphore_];public : [BaseSemaphore](std::unique_ptr<uint64_t,[localInboundSemaphore_]([std]::move(localInboundSemaphoreId)),[expectedInboundSemaphore_]([std]::move(expectedInboundSemaphoreId)),[outboundSemaphore_]([std]::move(outboundSemaphoreId))}; class [Host2DeviceSemaphore]public [BaseSemaphore]<CudaDeleter,private : public : [Host2DeviceSemaphore]([Communicator]&[connection]);[connection]();void [signal]();using [DeviceHandle][Host2DeviceSemaphoreDeviceHandle];[DeviceHandle][deviceHandle]();}; class [Host2HostSemaphore]public [BaseSemaphore]<std::default_delete,public : [Host2HostSemaphore]([Communicator]&[connection]);[connection]();void [signal]();bool [poll]();void [wait](int64_tprivate : }; class [SmDevice2DeviceSemaphore]public [BaseSemaphore]<CudaDeleter,public : [SmDevice2DeviceSemaphore]([Communicator]&[SmDevice2DeviceSemaphore]()delete ; using [DeviceHandle][SmDevice2DeviceSemaphoreDeviceHandle];[DeviceHandle][deviceHandle]()const ; bool [isRemoteInboundSemaphoreIdSet_];}; } #endif
+
+
diff --git a/docs/doxygen/xml/semaphore__device_8hpp.xml b/docs/doxygen/xml/semaphore__device_8hpp.xml
new file mode 100644
index 00000000..814525fa
--- /dev/null
+++ b/docs/doxygen/xml/semaphore__device_8hpp.xml
@@ -0,0 +1,153 @@
+
+
+
+ semaphore_device.hpp
+ device.hpp
+ proxy_channel_device.hpp
+ semaphore.hpp
+ sm_channel_device.hpp
+
+
+ device.hpp
+
+
+ semaphore_device.hpp
+
+
+
+
+
+
+ proxy_channel_device.hpp
+
+
+
+
+ semaphore_device.hpp
+
+
+
+
+
+
+
+
+ sm_channel_device.hpp
+
+
+
+
+ semaphore.hpp
+
+
+
+
+
+
+ proxy_channel.hpp
+
+
+ sm_channel.hpp
+
+
+ mscclpp::Host2DeviceSemaphoreDeviceHandle
+ mscclpp::SmDevice2DeviceSemaphoreDeviceHandle
+ mscclpp
+
+
+
+
+
+#ifndef #define #include[device.hpp]" #if #include[atomic_device.hpp]" #include[poll_device.hpp]" #endif namespace [mscclpp]struct [Host2DeviceSemaphoreDeviceHandle]#if bool bool [inboundSemaphoreId],if return void [inboundSemaphoreId],[expectedInboundSemaphoreId])),#endif [inboundSemaphoreId];[expectedInboundSemaphoreId];}; struct [SmDevice2DeviceSemaphoreDeviceHandle]#if bool bool [inboundSemaphoreId],if return void [inboundSemaphoreId],[expectedInboundSemaphoreId])),void [remoteInboundSemaphoreId],void [remoteInboundSemaphoreId],void [remoteInboundSemaphoreId]void [outboundSemaphoreId]{ return [outboundSemaphoreId];#endif [inboundSemaphoreId];[outboundSemaphoreId];[remoteInboundSemaphoreId];[expectedInboundSemaphoreId];}; } #endif
+
+
diff --git a/docs/doxygen/xml/sm__channel_8hpp.xml b/docs/doxygen/xml/sm__channel_8hpp.xml
new file mode 100644
index 00000000..030ba33a
--- /dev/null
+++ b/docs/doxygen/xml/sm__channel_8hpp.xml
@@ -0,0 +1,182 @@
+
+
+
+ sm_channel.hpp
+ type_traits
+ core.hpp
+ semaphore.hpp
+ sm_channel_device.hpp
+
+
+ device.hpp
+
+
+ core.hpp
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ errors.hpp
+
+
+
+
+ linux/version.h
+
+
+ cuda_runtime.h
+
+
+ stdexcept
+
+
+ string
+
+
+ semaphore_device.hpp
+
+
+
+
+ mscclpp/gpu.hpp
+
+
+
+
+
+
+
+
+ sm_channel_device.hpp
+
+
+
+
+ bitset
+
+
+ future
+
+
+ vector
+
+
+ array
+
+
+ semaphore.hpp
+
+
+
+
+
+
+
+
+
+
+ cuda.h
+
+
+ type_traits
+
+
+ sm_channel.hpp
+
+
+
+
+
+
+
+
+
+
+ cstring
+
+
+ mscclpp/gpu_utils.hpp
+
+
+
+
+
+
+
+
+
+
+ memory
+
+
+ mscclpp::SmChannel
+ mscclpp
+
+
+
+
+
+#ifndef #define #include #include[core.hpp]" #include[semaphore.hpp]" #include[sm_channel_device.hpp]" namespace [mscclpp]struct [SmChannel]private : [RegisteredMemory]void * void * public : [SmChannel]()default ; [SmChannel](std::shared_ptr<SmDevice2DeviceSemaphore>[RegisteredMemory]void * void * nullptr ); using [DeviceHandle][SmChannelDeviceHandle];[DeviceHandle][deviceHandle]()const ; }; } #endif
+
+
diff --git a/docs/doxygen/xml/sm__channel__device_8hpp.xml b/docs/doxygen/xml/sm__channel__device_8hpp.xml
new file mode 100644
index 00000000..61ecacc9
--- /dev/null
+++ b/docs/doxygen/xml/sm__channel__device_8hpp.xml
@@ -0,0 +1,192 @@
+
+
+
+ sm_channel_device.hpp
+ semaphore_device.hpp
+ sm_channel.hpp
+
+
+ device.hpp
+
+
+ semaphore_device.hpp
+
+
+
+
+ sm_channel_device.hpp
+
+
+
+
+
+
+ sm_channel_device.hpp
+
+
+
+
+ sm_channel.hpp
+
+
+ mscclpp::SmChannelDeviceHandle
+ mscclpp
+
+
+
+
+
+#ifndef #define #include[semaphore_device.hpp]" #if #include[packet_device.hpp]" #endif namespace [mscclpp]#if namespace Element template typename MSCCLPP_DEVICE_INLINE void for size_t } } #endif struct [SmChannelDeviceHandle][SmDevice2DeviceSemaphoreDeviceHandle][semaphore_];void *[src_]; void *[dst_]; void *[getPacketBuffer_]; #if template typename return reinterpret_cast< T* > ([dst_]) template typename void const reinterpret_cast< T* > ([dst_]) template typename bool void void * void * int * reinterpret_cast< int * > (dst); int * reinterpret_cast< int * > (src); const reinterpret_cast< uintptr_t > (dst); const reinterpret_cast< uintptr_t > (src); const sizeof (int); reinterpret_cast< T* > ((dstPtr sizeof (T) sizeof (T) sizeof (T)); reinterpret_cast< T* > ((srcPtr sizeof (T) sizeof (T) sizeof (T)); reinterpret_cast< uintptr_t > (dstElem) sizeof (int); if sizeof (T) sizeof ( int ); if template int bool void void * void * if else if else if else "Unsupported ); template int bool void char *)[dst_] char *)[src_] template int bool void char *)[src_] char *)[dst_] template int bool void template int bool void template typename void [dst_],[src_],template typename void [getPacketBuffer_],[src_],void [semaphore_].signal();void [semaphore_].relaxedSignal();void [semaphore_].signalPacket();void [semaphore_].semaphoreIncrement();{ return [semaphore_].semaphoreGetLocal();bool return [semaphore_].poll();void [semaphore_].wait(maxSpinCount);#endif }; } #endif
+
+
diff --git a/docs/doxygen/xml/structNpKitEventCollectContext.xml b/docs/doxygen/xml/structNpKitEventCollectContext.xml
new file mode 100644
index 00000000..c5ec9892
--- /dev/null
+++ b/docs/doxygen/xml/structNpKitEventCollectContext.xml
@@ -0,0 +1,57 @@
+
+
+
+ NpKitEventCollectContext
+ npkit_struct.hpp
+
+
+ [NpKitEvent] *NpKitEvent* NpKitEventCollectContext::event_buffer
+ event_buffer
+
+
+
+
+
+
+
+
+ uint64_t
+ uint64_t NpKitEventCollectContext::event_buffer_head
+ event_buffer_head
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ NpKitEventCollectContext
+
+ event_buffer
+
+
+
+ NpKitEvent
+
+
+
+ NpKitEventCollectContext event_buffer NpKitEventCollectContext event_buffer_head
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1AvoidCudaGraphCaptureGuard.xml b/docs/doxygen/xml/structmscclpp_1_1AvoidCudaGraphCaptureGuard.xml
new file mode 100644
index 00000000..93d1332e
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1AvoidCudaGraphCaptureGuard.xml
@@ -0,0 +1,61 @@
+
+
+
+ mscclpp::AvoidCudaGraphCaptureGuard
+ gpu_utils.hpp
+
+
+ cudaStreamCaptureMode
+ cudaStreamCaptureMode mscclpp::AvoidCudaGraphCaptureGuard::mode_
+ mode_
+
+
+
+
+
+
+
+
+
+
+ mscclpp::AvoidCudaGraphCaptureGuard::AvoidCudaGraphCaptureGuard
+ ()
+ AvoidCudaGraphCaptureGuard
+
+
+
+
+
+
+
+
+ mscclpp::AvoidCudaGraphCaptureGuard::~AvoidCudaGraphCaptureGuard
+ ()
+ ~AvoidCudaGraphCaptureGuard
+
+
+
+
+
+
+
+
+
+
+
+A RAII guard that will cudaThreadExchangeStreamCaptureMode to cudaStreamCaptureModeRelaxed on construction and restore the previous mode on destruction. This is helpful when we want to avoid CUDA graph capture.
+
+
+ mscclpp::AvoidCudaGraphCaptureGuard AvoidCudaGraphCaptureGuard mscclpp::AvoidCudaGraphCaptureGuard mode_ mscclpp::AvoidCudaGraphCaptureGuard ~AvoidCudaGraphCaptureGuard
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1CudaDeleter.xml b/docs/doxygen/xml/structmscclpp_1_1CudaDeleter.xml
new file mode 100644
index 00000000..cae4bfc4
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1CudaDeleter.xml
@@ -0,0 +1,65 @@
+
+
+
+ mscclpp::CudaDeleter
+ gpu_utils.hpp
+
+ class T
+
+
+
+
+ std::conditional_t< std::is_array_v< T >, T, T * >
+ using mscclpp::CudaDeleter< T >::TPtrOrArray = std::conditional_t<std::is_array_v<T>, T, T*>
+ TPtrOrArray
+
+
+
+
+
+
+
+
+
+
+ void
+ void mscclpp::CudaDeleter< T >::operator()
+ (TPtrOrArray ptr)
+ operator()
+ [TPtrOrArray]ptr
+
+
+
+
+
+
+
+
+
+
+
+
+A deleter that calls cudaFree for use with std::unique_ptr or std::shared_ptr.
+
+T
+
+
+Type of each element in the allocated memory.
+
+
+
+
+
+ mscclpp::CudaDeleter operator() mscclpp::CudaDeleter TPtrOrArray
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1CudaHostDeleter.xml b/docs/doxygen/xml/structmscclpp_1_1CudaHostDeleter.xml
new file mode 100644
index 00000000..09b514bf
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1CudaHostDeleter.xml
@@ -0,0 +1,65 @@
+
+
+
+ mscclpp::CudaHostDeleter
+ gpu_utils.hpp
+
+ class T
+
+
+
+
+ std::conditional_t< std::is_array_v< T >, T, T * >
+ using mscclpp::CudaHostDeleter< T >::TPtrOrArray = std::conditional_t<std::is_array_v<T>, T, T*>
+ TPtrOrArray
+
+
+
+
+
+
+
+
+
+
+ void
+ void mscclpp::CudaHostDeleter< T >::operator()
+ (TPtrOrArray ptr)
+ operator()
+ [TPtrOrArray]ptr
+
+
+
+
+
+
+
+
+
+
+
+
+A deleter that calls cudaFreeHost for use with std::unique_ptr or std::shared_ptr.
+
+T
+
+
+Type of each element in the allocated memory.
+
+
+
+
+
+ mscclpp::CudaHostDeleter operator() mscclpp::CudaHostDeleter TPtrOrArray
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1CudaPhysicalDeleter.xml b/docs/doxygen/xml/structmscclpp_1_1CudaPhysicalDeleter.xml
new file mode 100644
index 00000000..efa990e4
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1CudaPhysicalDeleter.xml
@@ -0,0 +1,39 @@
+
+
+
+ mscclpp::CudaPhysicalDeleter
+ gpu_utils.hpp
+
+ class T
+
+
+
+
+ void
+ void mscclpp::CudaPhysicalDeleter< T >::operator()
+ (PhysicalCudaMemory< T > *ptr)
+ operator()
+ [PhysicalCudaMemory]< T > *ptr
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ mscclpp::CudaPhysicalDeleter operator()
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1CudaStreamWithFlags.xml b/docs/doxygen/xml/structmscclpp_1_1CudaStreamWithFlags.xml
new file mode 100644
index 00000000..1f99db3c
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1CudaStreamWithFlags.xml
@@ -0,0 +1,79 @@
+
+
+
+ mscclpp::CudaStreamWithFlags
+ gpu_utils.hpp
+
+
+ cudaStream_t
+ cudaStream_t mscclpp::CudaStreamWithFlags::stream_
+ stream_
+
+
+
+
+
+
+
+
+
+
+ mscclpp::CudaStreamWithFlags::CudaStreamWithFlags
+ (unsigned int flags)
+ CudaStreamWithFlags
+ unsigned int
+ flags
+
+
+
+
+
+
+
+
+
+ mscclpp::CudaStreamWithFlags::~CudaStreamWithFlags
+ ()
+ ~CudaStreamWithFlags
+
+
+
+
+
+
+
+
+ mscclpp::CudaStreamWithFlags::operator cudaStream_t
+ () const
+ operator cudaStream_t
+
+
+
+
+
+
+
+
+
+A RAII wrapper around cudaStream_t that will call cudaStreamDestroy on destruction.
+
+
+
+
+ mscclpp::CudaStreamWithFlags CudaStreamWithFlags mscclpp::CudaStreamWithFlags operator cudaStream_t mscclpp::CudaStreamWithFlags stream_ mscclpp::CudaStreamWithFlags ~CudaStreamWithFlags
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1DeviceMulticastPointerDeviceHandle.xml b/docs/doxygen/xml/structmscclpp_1_1DeviceMulticastPointerDeviceHandle.xml
new file mode 100644
index 00000000..83f7565e
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1DeviceMulticastPointerDeviceHandle.xml
@@ -0,0 +1,59 @@
+
+
+
+ mscclpp::DeviceMulticastPointerDeviceHandle
+ nvls_device.hpp
+
+
+ void *
+ void* mscclpp::DeviceMulticastPointerDeviceHandle::devicePtr
+ devicePtr
+
+
+
+
+
+
+
+
+ void *
+ void* mscclpp::DeviceMulticastPointerDeviceHandle::mcPtr
+ mcPtr
+
+
+
+
+
+
+
+
+ size_t
+ size_t mscclpp::DeviceMulticastPointerDeviceHandle::bufferSize
+ bufferSize
+
+
+
+
+
+
+
+
+
+Device-side handle for [Host2DeviceSemaphore].
+
+
+
+
+ mscclpp::DeviceMulticastPointerDeviceHandle bufferSize mscclpp::DeviceMulticastPointerDeviceHandle devicePtr mscclpp::DeviceMulticastPointerDeviceHandle mcPtr
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1DeviceSyncer.xml b/docs/doxygen/xml/structmscclpp_1_1DeviceSyncer.xml
new file mode 100644
index 00000000..e722f2d9
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1DeviceSyncer.xml
@@ -0,0 +1,94 @@
+
+
+
+ mscclpp::DeviceSyncer
+ concurrency_device.hpp
+
+
+ unsigned int
+ unsigned int mscclpp::DeviceSyncer::flag_
+ flag_
+
+The flag to indicate whether the barrier is reached by the latest thread.
+
+
+
+
+
+
+
+ unsigned int
+ unsigned int mscclpp::DeviceSyncer::count_
+ count_
+
+The counter of synchronized blocks.
+
+
+
+
+
+
+
+ unsigned int
+ unsigned int mscclpp::DeviceSyncer::preFlag_
+ preFlag_
+
+The flag to indicate whether to increase or decrease flag_.
+
+
+
+
+
+
+
+
+
+ mscclpp::DeviceSyncer::DeviceSyncer
+ ()=default
+ DeviceSyncer
+
+Construct a new [DeviceSyncer] object.
+
+
+
+
+
+
+
+ mscclpp::DeviceSyncer::~DeviceSyncer
+ ()=default
+ ~DeviceSyncer
+
+Destroy the [DeviceSyncer] object.
+
+
+
+
+
+
+
+
+A device-wide barrier.
+
+
+
+
+ mscclpp::DeviceSyncer count_ mscclpp::DeviceSyncer DeviceSyncer mscclpp::DeviceSyncer flag_ mscclpp::DeviceSyncer preFlag_ mscclpp::DeviceSyncer ~DeviceSyncer
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1EndpointConfig.xml b/docs/doxygen/xml/structmscclpp_1_1EndpointConfig.xml
new file mode 100644
index 00000000..1698689e
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1EndpointConfig.xml
@@ -0,0 +1,199 @@
+
+
+
+ mscclpp::EndpointConfig
+ core.hpp
+
+
+ const int
+ const int mscclpp::EndpointConfig::DefaultMaxCqSize
+ DefaultMaxCqSize
+ = 1024
+
+
+
+
+
+
+
+
+ const int
+ const int mscclpp::EndpointConfig::DefaultMaxCqPollNum
+ DefaultMaxCqPollNum
+ = 1
+
+
+
+
+
+
+
+
+ const int
+ const int mscclpp::EndpointConfig::DefaultMaxSendWr
+ DefaultMaxSendWr
+ = 8192
+
+
+
+
+
+
+
+
+ const int
+ const int mscclpp::EndpointConfig::DefaultMaxWrPerSend
+ DefaultMaxWrPerSend
+ = 64
+
+
+
+
+
+
+
+
+
+
+ [Transport]Transport mscclpp::EndpointConfig::transport
+ transport
+
+
+
+
+
+
+
+
+ int
+ int mscclpp::EndpointConfig::ibMaxCqSize
+ ibMaxCqSize
+ = [DefaultMaxCqSize]
+
+
+
+
+
+
+
+
+ int
+ int mscclpp::EndpointConfig::ibMaxCqPollNum
+ ibMaxCqPollNum
+ = [DefaultMaxCqPollNum]
+
+
+
+
+
+
+
+
+ int
+ int mscclpp::EndpointConfig::ibMaxSendWr
+ ibMaxSendWr
+ = [DefaultMaxSendWr]
+
+
+
+
+
+
+
+
+ int
+ int mscclpp::EndpointConfig::ibMaxWrPerSend
+ ibMaxWrPerSend
+ = [DefaultMaxWrPerSend]
+
+
+
+
+
+
+
+
+
+
+ mscclpp::EndpointConfig::EndpointConfig
+ ()
+ EndpointConfig
+
+Default constructor. Sets transport to [Transport::Unknown].
+
+
+
+
+
+
+
+ mscclpp::EndpointConfig::EndpointConfig
+ (Transport transport)
+ EndpointConfig
+ [Transport]transport
+
+
+
+
+Constructor that takes a transport and sets the other fields to their default values.
+
+
+transport
+
+
+The transport to use.
+
+
+
+
+
+
+
+
+Used to configure an endpoint.
+
+
+
+
+ mscclpp::EndpointConfig DefaultMaxCqPollNum mscclpp::EndpointConfig DefaultMaxCqSize mscclpp::EndpointConfig DefaultMaxSendWr mscclpp::EndpointConfig DefaultMaxWrPerSend mscclpp::EndpointConfig EndpointConfig mscclpp::EndpointConfig EndpointConfig mscclpp::EndpointConfig ibMaxCqPollNum mscclpp::EndpointConfig ibMaxCqSize mscclpp::EndpointConfig ibMaxSendWr mscclpp::EndpointConfig ibMaxWrPerSend mscclpp::EndpointConfig transport
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1FifoDeviceHandle.xml b/docs/doxygen/xml/structmscclpp_1_1FifoDeviceHandle.xml
new file mode 100644
index 00000000..070f87c0
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1FifoDeviceHandle.xml
@@ -0,0 +1,92 @@
+
+
+
+ mscclpp::FifoDeviceHandle
+ fifo_device.hpp
+
+
+ [ProxyTrigger] *ProxyTrigger* mscclpp::FifoDeviceHandle::triggers
+ triggers
+
+The FIFO buffer that is allocated on the host via cudaHostAlloc() .
+
+
+
+
+
+
+
+ uint64_t *
+ uint64_t* mscclpp::FifoDeviceHandle::tailReplica
+ tailReplica
+
+Replica of the FIFO tail that is allocated on device.
+
+
+
+
+
+
+
+ uint64_t *
+ uint64_t* mscclpp::FifoDeviceHandle::head
+ head
+
+The FIFO head. Allocated on the device and only accessed by the device.
+
+
+
+
+
+
+
+ int
+ int mscclpp::FifoDeviceHandle::size
+ size
+
+The FIFO size.
+
+
+
+
+
+
+
+
+
+
+A concurrent FIFO where multiple device threads (the number of threads should not exceed the fifo size) can push work elements and a single host proxy thread consumes them.
+The FIFO has a head pointer allocated on the device which starts at 0 and goes up to 2^64-1, which is almost infinity. There are two copies of the tail, one on the device, [FifoDeviceHandle::tailReplica], and another on the host, namely, hostTail. The host always has the "true" tail and occasionally pushes it to the copy on the device. Therefore, most of the time, the device has a stale version. The invariants are: tailReplica <= hostTail <= head. The push() function increments head, hostTail is updated in [Fifo::pop()], and it occasionally flushes it to tailReplica via [Fifo::flushTail()].
+Duplicating the tail is a good idea because the FIFO is large enough, and we do not need frequent updates for the tail as there is usually enough space for device threads to push their work into.
+
+
+
+ mscclpp::FifoDeviceHandle
+
+ triggers
+
+
+
+ mscclpp::ProxyTrigger
+
+
+
+ mscclpp::FifoDeviceHandle head mscclpp::FifoDeviceHandle size mscclpp::FifoDeviceHandle tailReplica mscclpp::FifoDeviceHandle triggers
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1Host2DeviceSemaphoreDeviceHandle.xml b/docs/doxygen/xml/structmscclpp_1_1Host2DeviceSemaphoreDeviceHandle.xml
new file mode 100644
index 00000000..2d0c828c
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1Host2DeviceSemaphoreDeviceHandle.xml
@@ -0,0 +1,45 @@
+
+
+
+ mscclpp::Host2DeviceSemaphoreDeviceHandle
+ semaphore_device.hpp
+
+
+ uint64_t *
+ uint64_t* mscclpp::Host2DeviceSemaphoreDeviceHandle::inboundSemaphoreId
+ inboundSemaphoreId
+
+
+
+
+
+
+
+
+ uint64_t *
+ uint64_t* mscclpp::Host2DeviceSemaphoreDeviceHandle::expectedInboundSemaphoreId
+ expectedInboundSemaphoreId
+
+
+
+
+
+
+
+
+
+Device-side handle for [Host2DeviceSemaphore].
+
+
+
+
+ mscclpp::Host2DeviceSemaphoreDeviceHandle expectedInboundSemaphoreId mscclpp::Host2DeviceSemaphoreDeviceHandle inboundSemaphoreId
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1NvlsConnection_1_1DeviceMulticastPointer.xml b/docs/doxygen/xml/structmscclpp_1_1NvlsConnection_1_1DeviceMulticastPointer.xml
new file mode 100644
index 00000000..5170e30f
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1NvlsConnection_1_1DeviceMulticastPointer.xml
@@ -0,0 +1,146 @@
+
+
+
+ mscclpp::NvlsConnection::DeviceMulticastPointer
+ nvls.hpp
+
+
+ [DeviceMulticastPointerDeviceHandle]using mscclpp::NvlsConnection::DeviceMulticastPointer::DeviceHandle = DeviceMulticastPointerDeviceHandle
+ DeviceHandle
+
+
+
+
+
+
+
+
+
+
+ std::shared_ptr< [PhysicalCudaMemory]< char > >
+ std::shared_ptr<PhysicalCudaMemory<char> > mscclpp::NvlsConnection::DeviceMulticastPointer::deviceMem_
+ deviceMem_
+
+
+
+
+
+
+
+
+ std::shared_ptr< char >
+ std::shared_ptr<char> mscclpp::NvlsConnection::DeviceMulticastPointer::mcPtr_
+ mcPtr_
+
+
+
+
+
+
+
+
+ size_t
+ size_t mscclpp::NvlsConnection::DeviceMulticastPointer::bufferSize_
+ bufferSize_
+
+
+
+
+
+
+
+
+
+
+ friend class
+ friend class NvlsConnection
+ NvlsConnection
+
+
+
+
+
+
+
+
+
+
+ mscclpp::NvlsConnection::DeviceMulticastPointer::DeviceMulticastPointer
+ (std::shared_ptr< PhysicalCudaMemory< char >> deviceMem, std::shared_ptr< char > mcPtr, size_t bufferSize)
+ DeviceMulticastPointer
+ std::shared_ptr< [PhysicalCudaMemory]< char >>
+ deviceMem
+
+ std::shared_ptr< char >
+ mcPtr
+
+ size_t
+ bufferSize
+
+
+
+
+
+
+
+
+
+ [DeviceHandle]DeviceHandle mscclpp::NvlsConnection::DeviceMulticastPointer::deviceHandle
+ ()
+ deviceHandle
+
+
+
+
+
+
+
+
+ char *
+ char* mscclpp::NvlsConnection::DeviceMulticastPointer::getDevicePtr
+ ()
+ getDevicePtr
+
+
+
+
+
+
+
+
+
+
+
+
+
+ mscclpp::NvlsConnection::DeviceMulticastPointer bufferSize_ mscclpp::NvlsConnection::DeviceMulticastPointer DeviceHandle mscclpp::NvlsConnection::DeviceMulticastPointer deviceHandle mscclpp::NvlsConnection::DeviceMulticastPointer deviceMem_ mscclpp::NvlsConnection::DeviceMulticastPointer DeviceMulticastPointer mscclpp::NvlsConnection::DeviceMulticastPointer getDevicePtr mscclpp::NvlsConnection::DeviceMulticastPointer mcPtr_ mscclpp::NvlsConnection::DeviceMulticastPointer NvlsConnection
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1PhysicalCudaMemory.xml b/docs/doxygen/xml/structmscclpp_1_1PhysicalCudaMemory.xml
new file mode 100644
index 00000000..3101b453
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1PhysicalCudaMemory.xml
@@ -0,0 +1,91 @@
+
+
+
+ mscclpp::PhysicalCudaMemory
+ gpu_utils.hpp
+
+ class T
+
+
+
+
+ CUmemGenericAllocationHandle
+ CUmemGenericAllocationHandle mscclpp::PhysicalCudaMemory< T >::memHandle_
+ memHandle_
+
+
+
+
+
+
+
+
+ T *
+ T* mscclpp::PhysicalCudaMemory< T >::devicePtr_
+ devicePtr_
+
+
+
+
+
+
+
+
+ size_t
+ size_t mscclpp::PhysicalCudaMemory< T >::size_
+ size_
+
+
+
+
+
+
+
+
+
+
+ mscclpp::PhysicalCudaMemory< T >::PhysicalCudaMemory
+ (CUmemGenericAllocationHandle memHandle, T *devicePtr, size_t size)
+ PhysicalCudaMemory
+ CUmemGenericAllocationHandle
+ memHandle
+
+ T *
+ devicePtr
+
+ size_t
+ size
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ mscclpp::PhysicalCudaMemory devicePtr_ mscclpp::PhysicalCudaMemory memHandle_ mscclpp::PhysicalCudaMemory PhysicalCudaMemory mscclpp::PhysicalCudaMemory size_
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1ProxyChannel.xml b/docs/doxygen/xml/structmscclpp_1_1ProxyChannel.xml
new file mode 100644
index 00000000..c038f6db
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1ProxyChannel.xml
@@ -0,0 +1,170 @@
+
+
+
+ mscclpp::ProxyChannel
+ proxy_channel.hpp
+
+
+ [ProxyChannelDeviceHandle]using mscclpp::ProxyChannel::DeviceHandle = ProxyChannelDeviceHandle
+ DeviceHandle
+
+Device-side handle for [ProxyChannel].
+
+
+
+
+
+
+
+
+
+ [SemaphoreId]SemaphoreId mscclpp::ProxyChannel::semaphoreId_
+ semaphoreId_
+
+
+
+
+
+
+
+
+ std::shared_ptr< [Host2DeviceSemaphore] >
+ std::shared_ptr<Host2DeviceSemaphore> mscclpp::ProxyChannel::semaphore_
+ semaphore_
+
+
+
+
+
+
+
+
+ std::shared_ptr< [Proxy] >
+ std::shared_ptr<Proxy> mscclpp::ProxyChannel::proxy_
+ proxy_
+
+
+
+
+
+
+
+
+
+
+ mscclpp::ProxyChannel::ProxyChannel
+ ()=default
+ ProxyChannel
+
+
+
+
+
+
+
+
+ mscclpp::ProxyChannel::ProxyChannel
+ (SemaphoreId semaphoreId, std::shared_ptr< Host2DeviceSemaphore > semaphore, std::shared_ptr< Proxy > proxy)
+ ProxyChannel
+ [SemaphoreId]semaphoreId
+
+ std::shared_ptr< [Host2DeviceSemaphore] >
+ semaphore
+
+ std::shared_ptr< [Proxy] >
+ proxy
+
+
+
+
+
+
+
+
+
+ mscclpp::ProxyChannel::ProxyChannel
+ (const ProxyChannel &other)=default
+ ProxyChannel
+ const [ProxyChannel] &
+ other
+
+
+
+
+
+
+
+
+
+ [ProxyChannel] &ProxyChannel& mscclpp::ProxyChannel::operator=
+ (ProxyChannel &other)=default
+ operator=
+ [ProxyChannel] &other
+
+
+
+
+
+
+
+
+
+ [DeviceHandle]DeviceHandle mscclpp::ProxyChannel::deviceHandle
+ () const
+ deviceHandle
+
+
+
+Returns the device-side handle.
+User should make sure the [ProxyChannel] is not released when using the returned handle.
+
+
+
+
+
+
+[Proxy] channel.
+
+
+
+ mscclpp::ProxyChannel DeviceHandle mscclpp::ProxyChannel deviceHandle mscclpp::ProxyChannel operator= mscclpp::ProxyChannel proxy_ mscclpp::ProxyChannel ProxyChannel mscclpp::ProxyChannel ProxyChannel mscclpp::ProxyChannel ProxyChannel mscclpp::ProxyChannel semaphore_ mscclpp::ProxyChannel semaphoreId_
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1ProxyChannelDeviceHandle.xml b/docs/doxygen/xml/structmscclpp_1_1ProxyChannelDeviceHandle.xml
new file mode 100644
index 00000000..081cfb06
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1ProxyChannelDeviceHandle.xml
@@ -0,0 +1,85 @@
+
+
+
+ mscclpp::ProxyChannelDeviceHandle
+ proxy_channel_device.hpp
+
+
+ [SemaphoreId]SemaphoreId mscclpp::ProxyChannelDeviceHandle::semaphoreId_
+ semaphoreId_
+
+
+
+
+
+
+
+
+ [Host2DeviceSemaphoreDeviceHandle]Host2DeviceSemaphoreDeviceHandle mscclpp::ProxyChannelDeviceHandle::semaphore_
+ semaphore_
+
+
+
+
+
+
+
+
+ [FifoDeviceHandle]FifoDeviceHandle mscclpp::ProxyChannelDeviceHandle::fifo_
+ fifo_
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ mscclpp::FifoDeviceHandle
+
+ triggers
+
+
+
+ mscclpp::Host2DeviceSemaphoreDeviceHandle
+
+
+ mscclpp::ProxyTrigger
+
+
+ mscclpp::ProxyChannelDeviceHandle
+
+ fifo_
+
+
+ semaphore_
+
+
+
+
+ mscclpp::ProxyChannelDeviceHandle fifo_ mscclpp::ProxyChannelDeviceHandle semaphore_ mscclpp::ProxyChannelDeviceHandle semaphoreId_
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1ProxyTrigger.xml b/docs/doxygen/xml/structmscclpp_1_1ProxyTrigger.xml
new file mode 100644
index 00000000..99e5b19f
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1ProxyTrigger.xml
@@ -0,0 +1,47 @@
+
+
+
+ mscclpp::ProxyTrigger
+ fifo_device.hpp
+
+
+ uint64_t
+ uint64_t mscclpp::ProxyTrigger::fst
+ fst
+
+
+
+
+
+
+
+
+ uint64_t
+ uint64_t mscclpp::ProxyTrigger::snd
+ snd
+
+
+
+
+
+
+
+
+
+
+
+A struct representing a pair of 64-bit unsigned integers used as a trigger for the proxy.
+This struct is used as a work element in the concurrent FIFO where multiple device threads can push [ProxyTrigger] elements and a single host proxy thread consumes these work elements.
+Do not use the most significant bit of [snd] as it is reserved for memory consistency purposes
+
+
+ mscclpp::ProxyTrigger fst mscclpp::ProxyTrigger snd
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1ScopedTimer.xml b/docs/doxygen/xml/structmscclpp_1_1ScopedTimer.xml
new file mode 100644
index 00000000..b3bff01d
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1ScopedTimer.xml
@@ -0,0 +1,97 @@
+
+
+
+ mscclpp::ScopedTimer
+ mscclpp::Timer
+ utils.hpp
+
+
+ const std::string
+ const std::string mscclpp::ScopedTimer::name_
+ name_
+
+
+
+
+
+
+
+
+
+
+ mscclpp::ScopedTimer::ScopedTimer
+ (const std::string &name)
+ ScopedTimer
+ const std::string &
+ name
+
+
+
+
+
+
+
+
+
+ mscclpp::ScopedTimer::~ScopedTimer
+ ()
+ ~ScopedTimer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ mscclpp::ScopedTimer
+
+
+
+
+ mscclpp::Timer
+
+
+
+
+ mscclpp::ScopedTimer
+
+
+
+
+ mscclpp::Timer
+
+
+
+ mscclpp::ScopedTimer elapsed mscclpp::ScopedTimer name_ mscclpp::ScopedTimer print mscclpp::ScopedTimer reset mscclpp::ScopedTimer ScopedTimer mscclpp::ScopedTimer set mscclpp::ScopedTimer start_ mscclpp::ScopedTimer timeout_ mscclpp::ScopedTimer Timer mscclpp::ScopedTimer ~ScopedTimer mscclpp::ScopedTimer ~Timer
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1Setuppable.xml b/docs/doxygen/xml/structmscclpp_1_1Setuppable.xml
new file mode 100644
index 00000000..d8ab1dc7
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1Setuppable.xml
@@ -0,0 +1,89 @@
+
+
+
+ mscclpp::Setuppable
+ core.hpp
+
+
+ virtual mscclpp::Setuppable::~Setuppable
+ ()=default
+ ~Setuppable
+
+
+
+
+
+
+
+
+ void
+ virtual void mscclpp::Setuppable::beginSetup
+ (std::shared_ptr< Bootstrap > bootstrap)
+ beginSetup
+ std::shared_ptr< [Bootstrap] >
+ bootstrap
+
+
+
+
+Called inside [Communicator::setup()] before any call to [endSetup()] of any [Setuppable] object that is being set up within the same [Communicator::setup()] call.
+
+
+bootstrap
+
+
+A shared pointer to the bootstrap implementation.
+
+
+
+
+
+
+
+ void
+ virtual void mscclpp::Setuppable::endSetup
+ (std::shared_ptr< Bootstrap > bootstrap)
+ endSetup
+ std::shared_ptr< [Bootstrap] >
+ bootstrap
+
+
+
+
+Called inside [Communicator::setup()] after all calls to [beginSetup()] of all [Setuppable] objects that are being set up within the same [Communicator::setup()] call.
+
+
+bootstrap
+
+
+A shared pointer to the bootstrap implementation.
+
+
+
+
+
+
+
+
+A base class for objects that can be set up during [Communicator::setup()].
+
+
+
+
+ mscclpp::Setuppable beginSetup mscclpp::Setuppable endSetup mscclpp::Setuppable ~Setuppable
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1SimpleProxyChannel.xml b/docs/doxygen/xml/structmscclpp_1_1SimpleProxyChannel.xml
new file mode 100644
index 00000000..faa8d323
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1SimpleProxyChannel.xml
@@ -0,0 +1,227 @@
+
+
+
+ mscclpp::SimpleProxyChannel
+ proxy_channel.hpp
+
+
+ [SimpleProxyChannelDeviceHandle]using mscclpp::SimpleProxyChannel::DeviceHandle = SimpleProxyChannelDeviceHandle
+ DeviceHandle
+
+Device-side handle for [SimpleProxyChannel].
+
+
+
+
+
+
+
+
+
+ [ProxyChannel]ProxyChannel mscclpp::SimpleProxyChannel::proxyChan_
+ proxyChan_
+
+
+
+
+
+
+
+
+ [MemoryId]MemoryId mscclpp::SimpleProxyChannel::dst_
+ dst_
+
+
+
+
+
+
+
+
+ [MemoryId]MemoryId mscclpp::SimpleProxyChannel::src_
+ src_
+
+
+
+
+
+
+
+
+
+
+ mscclpp::SimpleProxyChannel::SimpleProxyChannel
+ ()=default
+ SimpleProxyChannel
+
+Default constructor.
+
+
+
+
+
+
+
+ mscclpp::SimpleProxyChannel::SimpleProxyChannel
+ (ProxyChannel proxyChan, MemoryId dst, MemoryId src)
+ SimpleProxyChannel
+ [ProxyChannel]proxyChan
+
+ [MemoryId]dst
+
+ [MemoryId]src
+
+
+
+
+Constructor.
+
+proxyChan
+
+
+The proxy channel.
+
+
+
+
+dst
+
+
+The destination memory region.
+
+
+
+
+src
+
+
+The source memory region.
+
+
+
+
+
+
+
+
+ mscclpp::SimpleProxyChannel::SimpleProxyChannel
+ (ProxyChannel proxyChan)
+ SimpleProxyChannel
+ [ProxyChannel]proxyChan
+
+
+
+
+Constructor.
+
+proxyChan
+
+
+The proxy channel.
+
+
+
+
+
+
+
+
+ mscclpp::SimpleProxyChannel::SimpleProxyChannel
+ (const SimpleProxyChannel &other)=default
+ SimpleProxyChannel
+ const [SimpleProxyChannel] &
+ other
+
+
+Copy constructor.
+
+
+
+
+
+
+
+ [SimpleProxyChannel] &SimpleProxyChannel& mscclpp::SimpleProxyChannel::operator=
+ (SimpleProxyChannel &other)=default
+ operator=
+ [SimpleProxyChannel] &other
+
+
+Assignment operator.
+
+
+
+
+
+
+
+ [DeviceHandle]DeviceHandle mscclpp::SimpleProxyChannel::deviceHandle
+ () const
+ deviceHandle
+
+
+
+Returns the device-side handle.
+User should make sure the [SimpleProxyChannel] is not released when using the returned handle.
+
+
+
+
+
+
+Simple proxy channel with a single destination and source memory region.
+
+
+
+
+ mscclpp::SimpleProxyChannel DeviceHandle mscclpp::SimpleProxyChannel deviceHandle mscclpp::SimpleProxyChannel dst_ mscclpp::SimpleProxyChannel operator= mscclpp::SimpleProxyChannel proxyChan_ mscclpp::SimpleProxyChannel SimpleProxyChannel mscclpp::SimpleProxyChannel SimpleProxyChannel mscclpp::SimpleProxyChannel SimpleProxyChannel mscclpp::SimpleProxyChannel SimpleProxyChannel mscclpp::SimpleProxyChannel src_
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1SimpleProxyChannelDeviceHandle.xml b/docs/doxygen/xml/structmscclpp_1_1SimpleProxyChannelDeviceHandle.xml
new file mode 100644
index 00000000..cffd3d41
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1SimpleProxyChannelDeviceHandle.xml
@@ -0,0 +1,92 @@
+
+
+
+ mscclpp::SimpleProxyChannelDeviceHandle
+ proxy_channel_device.hpp
+
+
+ [ProxyChannelDeviceHandle]ProxyChannelDeviceHandle mscclpp::SimpleProxyChannelDeviceHandle::proxyChan_
+ proxyChan_
+
+
+
+
+
+
+
+
+ [MemoryId]MemoryId mscclpp::SimpleProxyChannelDeviceHandle::dst_
+ dst_
+
+
+
+
+
+
+
+
+ [MemoryId]MemoryId mscclpp::SimpleProxyChannelDeviceHandle::src_
+ src_
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ mscclpp::FifoDeviceHandle
+
+ triggers
+
+
+
+ mscclpp::Host2DeviceSemaphoreDeviceHandle
+
+
+ mscclpp::ProxyTrigger
+
+
+ mscclpp::SimpleProxyChannelDeviceHandle
+
+ proxyChan_
+
+
+
+ mscclpp::ProxyChannelDeviceHandle
+
+ fifo_
+
+
+ semaphore_
+
+
+
+
+ mscclpp::SimpleProxyChannelDeviceHandle dst_ mscclpp::SimpleProxyChannelDeviceHandle proxyChan_ mscclpp::SimpleProxyChannelDeviceHandle src_
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1SmChannel.xml b/docs/doxygen/xml/structmscclpp_1_1SmChannel.xml
new file mode 100644
index 00000000..6a4c6788
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1SmChannel.xml
@@ -0,0 +1,188 @@
+
+
+
+ mscclpp::SmChannel
+ sm_channel.hpp
+
+
+ [SmChannelDeviceHandle]using mscclpp::SmChannel::DeviceHandle = SmChannelDeviceHandle
+ DeviceHandle
+
+Device-side handle for [SmChannel].
+
+
+
+
+
+
+
+
+
+ std::shared_ptr< [SmDevice2DeviceSemaphore] >
+ std::shared_ptr<SmDevice2DeviceSemaphore> mscclpp::SmChannel::semaphore_
+ semaphore_
+
+
+
+
+
+
+
+
+ [RegisteredMemory]RegisteredMemory mscclpp::SmChannel::dst_
+ dst_
+
+
+
+
+
+
+
+
+ void *
+ void* mscclpp::SmChannel::src_
+ src_
+
+
+
+
+
+
+
+
+ void *
+ void* mscclpp::SmChannel::getPacketBuffer_
+ getPacketBuffer_
+
+
+
+
+
+
+
+
+
+
+ mscclpp::SmChannel::SmChannel
+ ()=default
+ SmChannel
+
+Constructor.
+
+
+
+
+
+
+
+ mscclpp::SmChannel::SmChannel
+ (std::shared_ptr< SmDevice2DeviceSemaphore > semaphore, RegisteredMemory dst, void *src, void *getPacketBuffer=nullptr)
+ SmChannel
+ std::shared_ptr< [SmDevice2DeviceSemaphore] >
+ semaphore
+
+ [RegisteredMemory]dst
+
+ void *
+ src
+
+ void *
+ getPacketBuffer
+ nullptr
+
+
+
+
+Constructor.
+
+semaphore
+
+
+The semaphore used to synchronize the communication.
+
+
+
+
+dst
+
+
+Registered memory of the destination.
+
+
+
+
+src
+
+
+The source memory address.
+
+
+
+
+getPacketBuffer
+
+
+The optional buffer used for getPackets().
+
+
+
+
+
+
+
+
+ [DeviceHandle]DeviceHandle mscclpp::SmChannel::deviceHandle
+ () const
+ deviceHandle
+
+
+
+Returns the device-side handle.
+User should make sure the [SmChannel] is not released when using the returned handle.
+
+
+
+
+
+
+Channel for accessing peer memory directly from SM.
+
+
+
+
+ mscclpp::SmChannel DeviceHandle mscclpp::SmChannel deviceHandle mscclpp::SmChannel dst_ mscclpp::SmChannel getPacketBuffer_ mscclpp::SmChannel semaphore_ mscclpp::SmChannel SmChannel mscclpp::SmChannel SmChannel mscclpp::SmChannel src_
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1SmChannelDeviceHandle.xml b/docs/doxygen/xml/structmscclpp_1_1SmChannelDeviceHandle.xml
new file mode 100644
index 00000000..89ee5443
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1SmChannelDeviceHandle.xml
@@ -0,0 +1,86 @@
+
+
+
+ mscclpp::SmChannelDeviceHandle
+ sm_channel_device.hpp
+
+
+ [SmDevice2DeviceSemaphoreDeviceHandle]SmDevice2DeviceSemaphoreDeviceHandle mscclpp::SmChannelDeviceHandle::semaphore_
+ semaphore_
+
+
+
+
+
+
+
+
+ void *
+ void* mscclpp::SmChannelDeviceHandle::src_
+ src_
+
+
+
+
+
+
+
+
+ void *
+ void* mscclpp::SmChannelDeviceHandle::dst_
+ dst_
+
+
+
+
+
+
+
+
+ void *
+ void* mscclpp::SmChannelDeviceHandle::getPacketBuffer_
+ getPacketBuffer_
+
+
+
+
+
+
+
+
+
+Channel for accessing peer memory directly from SM.
+
+
+
+
+
+ mscclpp::SmChannelDeviceHandle
+
+ semaphore_
+
+
+
+ mscclpp::SmDevice2DeviceSemaphoreDeviceHandle
+
+
+
+ mscclpp::SmChannelDeviceHandle dst_ mscclpp::SmChannelDeviceHandle getPacketBuffer_ mscclpp::SmChannelDeviceHandle semaphore_ mscclpp::SmChannelDeviceHandle src_
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1SmDevice2DeviceSemaphoreDeviceHandle.xml b/docs/doxygen/xml/structmscclpp_1_1SmDevice2DeviceSemaphoreDeviceHandle.xml
new file mode 100644
index 00000000..faf2389f
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1SmDevice2DeviceSemaphoreDeviceHandle.xml
@@ -0,0 +1,73 @@
+
+
+
+ mscclpp::SmDevice2DeviceSemaphoreDeviceHandle
+ semaphore_device.hpp
+
+
+ uint64_t *
+ uint64_t* mscclpp::SmDevice2DeviceSemaphoreDeviceHandle::inboundSemaphoreId
+ inboundSemaphoreId
+
+
+
+
+
+
+
+
+ uint64_t *
+ uint64_t* mscclpp::SmDevice2DeviceSemaphoreDeviceHandle::outboundSemaphoreId
+ outboundSemaphoreId
+
+
+
+
+
+
+
+
+ uint64_t *
+ uint64_t* mscclpp::SmDevice2DeviceSemaphoreDeviceHandle::remoteInboundSemaphoreId
+ remoteInboundSemaphoreId
+
+
+
+
+
+
+
+
+ uint64_t *
+ uint64_t* mscclpp::SmDevice2DeviceSemaphoreDeviceHandle::expectedInboundSemaphoreId
+ expectedInboundSemaphoreId
+
+
+
+
+
+
+
+
+
+Device-side handle for [SmDevice2DeviceSemaphore].
+
+
+
+
+ mscclpp::SmDevice2DeviceSemaphoreDeviceHandle expectedInboundSemaphoreId mscclpp::SmDevice2DeviceSemaphoreDeviceHandle inboundSemaphoreId mscclpp::SmDevice2DeviceSemaphoreDeviceHandle outboundSemaphoreId mscclpp::SmDevice2DeviceSemaphoreDeviceHandle remoteInboundSemaphoreId
+
+
diff --git a/docs/doxygen/xml/structmscclpp_1_1Timer.xml b/docs/doxygen/xml/structmscclpp_1_1Timer.xml
new file mode 100644
index 00000000..c10fac9a
--- /dev/null
+++ b/docs/doxygen/xml/structmscclpp_1_1Timer.xml
@@ -0,0 +1,157 @@
+
+
+
+ mscclpp::Timer
+ mscclpp::ScopedTimer
+ utils.hpp
+
+
+ std::chrono::steady_clock::time_point
+ std::chrono::steady_clock::time_point mscclpp::Timer::start_
+ start_
+
+
+
+
+
+
+
+
+ int
+ int mscclpp::Timer::timeout_
+ timeout_
+
+
+
+
+
+
+
+
+
+
+ mscclpp::Timer::Timer
+ (int timeout=-1)
+ Timer
+ int
+ timeout
+ -1
+
+
+
+
+
+
+
+
+
+ mscclpp::Timer::~Timer
+ ()
+ ~Timer
+
+
+
+
+
+
+
+
+ int64_t
+ int64_t mscclpp::Timer::elapsed
+ () const
+ elapsed
+
+Returns the elapsed time in microseconds.
+
+
+
+
+
+
+
+ void
+ void mscclpp::Timer::set
+ (int timeout)
+ set
+ int
+ timeout
+
+
+
+
+
+
+
+
+
+ void
+ void mscclpp::Timer::reset
+ ()
+ reset
+
+
+
+
+
+
+
+
+ void
+ void mscclpp::Timer::print
+ (const std::string &name)
+ print
+ const std::string &
+ name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ mscclpp::ScopedTimer
+
+
+
+
+ mscclpp::Timer
+
+
+
+ mscclpp::Timer elapsed mscclpp::Timer print mscclpp::Timer reset mscclpp::Timer set mscclpp::Timer start_ mscclpp::Timer timeout_ mscclpp::Timer Timer mscclpp::Timer ~Timer
+
+
diff --git a/docs/doxygen/xml/unionNpKitEvent.xml b/docs/doxygen/xml/unionNpKitEvent.xml
new file mode 100644
index 00000000..562414ce
--- /dev/null
+++ b/docs/doxygen/xml/unionNpKitEvent.xml
@@ -0,0 +1,103 @@
+
+
+
+ NpKitEvent
+ npkit_struct.hpp
+
+
+ uint64_t
+ uint64_t NpKitEvent::bits[2]
+ [2]
+ bits
+
+
+
+
+
+
+
+
+ uint64_t
+ uint64_t NpKitEvent::type
+ type
+ 8
+
+
+
+
+
+
+
+
+ uint64_t
+ uint64_t NpKitEvent::size
+ size
+ 32
+
+
+
+
+
+
+
+
+ uint64_t
+ uint64_t NpKitEvent::rsvd
+ rsvd
+ 24
+
+
+
+
+
+
+
+
+ uint64_t
+ uint64_t NpKitEvent::timestamp
+ timestamp
+
+
+
+
+
+
+
+
+ struct NpKitEvent::@0
+ struct NpKitEvent::@0 NpKitEvent::fields
+ fields
+
+
+
+
+
+
+
+
+
+
+
+
+
+ NpKitEvent bits NpKitEvent fields NpKitEvent rsvd NpKitEvent size NpKitEvent timestamp NpKitEvent type
+
+
diff --git a/docs/doxygen/xml/unionmscclpp_1_1ChannelTrigger.xml b/docs/doxygen/xml/unionmscclpp_1_1ChannelTrigger.xml
new file mode 100644
index 00000000..0c085914
--- /dev/null
+++ b/docs/doxygen/xml/unionmscclpp_1_1ChannelTrigger.xml
@@ -0,0 +1,208 @@
+
+
+
+ mscclpp::ChannelTrigger
+ proxy_channel_device.hpp
+
+
+ [ProxyTrigger]ProxyTrigger mscclpp::ChannelTrigger::value
+ value
+
+
+
+
+
+
+
+
+ uint64_t
+ uint64_t mscclpp::ChannelTrigger::size
+ size
+ MSCCLPP_BITS_SIZE
+
+
+
+
+
+
+
+
+ uint64_t
+ uint64_t mscclpp::ChannelTrigger::srcOffset
+ srcOffset
+ MSCCLPP_BITS_OFFSET
+
+
+
+
+
+
+
+
+ uint64_t
+ uint64_t mscclpp::ChannelTrigger::__pad0__
+ __pad0__
+ (64 - MSCCLPP_BITS_SIZE - MSCCLPP_BITS_OFFSET)
+
+
+
+
+
+
+
+
+ uint64_t
+ uint64_t mscclpp::ChannelTrigger::dstOffset
+ dstOffset
+ MSCCLPP_BITS_OFFSET
+
+
+
+
+
+
+
+
+ uint64_t
+ uint64_t mscclpp::ChannelTrigger::srcMemoryId
+ srcMemoryId
+ MSCCLPP_BITS_REGMEM_HANDLE
+
+
+
+
+
+
+
+
+ uint64_t
+ uint64_t mscclpp::ChannelTrigger::dstMemoryId
+ dstMemoryId
+ MSCCLPP_BITS_REGMEM_HANDLE
+
+
+
+
+
+
+
+
+ uint64_t
+ uint64_t mscclpp::ChannelTrigger::type
+ type
+ MSCCLPP_BITS_TYPE
+
+
+
+
+
+
+
+
+ uint64_t
+ uint64_t mscclpp::ChannelTrigger::chanId
+ chanId
+ MSCCLPP_BITS_CONNID
+
+
+
+
+
+
+
+
+ uint64_t
+ uint64_t mscclpp::ChannelTrigger::__pad1__
+ __pad1__
+ (64 - MSCCLPP_BITS_OFFSET - MSCCLPP_BITS_REGMEM_HANDLE - MSCCLPP_BITS_REGMEM_HANDLE - MSCCLPP_BITS_TYPE - MSCCLPP_BITS_CONNID - MSCCLPP_BITS_FIFO_RESERVED)
+
+
+
+
+
+
+
+
+ uint64_t
+ uint64_t mscclpp::ChannelTrigger::reserved
+ reserved
+ MSCCLPP_BITS_FIFO_RESERVED
+
+
+
+
+
+
+
+
+ struct mscclpp::ChannelTrigger::@5
+ struct mscclpp::ChannelTrigger::@5 mscclpp::ChannelTrigger::fields
+ fields
+
+
+
+
+
+
+
+
+
+Basic structure of each work element in the FIFO.
+
+
+
+
+
+ mscclpp::ProxyTrigger
+
+
+ mscclpp::ChannelTrigger
+
+ value
+
+
+
+
+ mscclpp::ChannelTrigger __pad0__ mscclpp::ChannelTrigger __pad1__ mscclpp::ChannelTrigger chanId mscclpp::ChannelTrigger dstMemoryId mscclpp::ChannelTrigger dstOffset mscclpp::ChannelTrigger fields mscclpp::ChannelTrigger reserved mscclpp::ChannelTrigger size mscclpp::ChannelTrigger srcMemoryId mscclpp::ChannelTrigger srcOffset mscclpp::ChannelTrigger type mscclpp::ChannelTrigger value
+
+
diff --git a/docs/doxygen/xml/unionmscclpp_1_1LL16Packet.xml b/docs/doxygen/xml/unionmscclpp_1_1LL16Packet.xml
new file mode 100644
index 00000000..7871f537
--- /dev/null
+++ b/docs/doxygen/xml/unionmscclpp_1_1LL16Packet.xml
@@ -0,0 +1,102 @@
+
+
+
+ mscclpp::LL16Packet
+ packet_device.hpp
+
+
+ uint2
+ using mscclpp::LL16Packet::Payload = uint2
+ Payload
+
+
+
+
+
+
+
+
+
+
+ uint32_t
+ uint32_t mscclpp::LL16Packet::data1
+ data1
+
+
+
+
+
+
+
+
+ uint32_t
+ uint32_t mscclpp::LL16Packet::flag1
+ flag1
+
+
+
+
+
+
+
+
+ uint32_t
+ uint32_t mscclpp::LL16Packet::data2
+ data2
+
+
+
+
+
+
+
+
+ uint32_t
+ uint32_t mscclpp::LL16Packet::flag2
+ flag2
+
+
+
+
+
+
+
+
+ struct mscclpp::LL16Packet::@1
+ struct mscclpp::LL16Packet::@1 mscclpp::LL16Packet::@2
+ @2
+
+
+
+
+
+
+
+
+
+LL (low latency) protocol packet.
+
+
+
+
+ mscclpp::LL16Packet data1 mscclpp::LL16Packet data2 mscclpp::LL16Packet flag1 mscclpp::LL16Packet flag2 mscclpp::LL16Packet Payload
+
+
diff --git a/docs/doxygen/xml/unionmscclpp_1_1LL8Packet.xml b/docs/doxygen/xml/unionmscclpp_1_1LL8Packet.xml
new file mode 100644
index 00000000..89c4f60d
--- /dev/null
+++ b/docs/doxygen/xml/unionmscclpp_1_1LL8Packet.xml
@@ -0,0 +1,87 @@
+
+
+
+ mscclpp::LL8Packet
+ packet_device.hpp
+
+
+ uint32_t
+ using mscclpp::LL8Packet::Payload = uint32_t
+ Payload
+
+
+
+
+
+
+
+
+
+
+ uint32_t
+ uint32_t mscclpp::LL8Packet::data
+ data
+
+
+
+
+
+
+
+
+ uint32_t
+ uint32_t mscclpp::LL8Packet::flag
+ flag
+
+
+
+
+
+
+
+
+ struct mscclpp::LL8Packet::@3
+ struct mscclpp::LL8Packet::@3 mscclpp::LL8Packet::@4
+ @4
+
+
+
+
+
+
+
+
+ uint64_t
+ uint64_t mscclpp::LL8Packet::raw_
+ raw_
+
+
+
+
+
+
+
+
+
+
+
+
+
+ mscclpp::LL8Packet data mscclpp::LL8Packet flag mscclpp::LL8Packet Payload mscclpp::LL8Packet raw_
+
+
diff --git a/docs/doxygen/xml/utils_8hpp.xml b/docs/doxygen/xml/utils_8hpp.xml
new file mode 100644
index 00000000..c41b7e13
--- /dev/null
+++ b/docs/doxygen/xml/utils_8hpp.xml
@@ -0,0 +1,77 @@
+
+
+
+ utils.hpp
+ chrono
+ string
+
+
+ utils.hpp
+
+
+
+
+
+
+ string
+
+
+ chrono
+
+
+ mscclpp::Timer
+ mscclpp::ScopedTimer
+ mscclpp
+
+
+
+
+
+#ifndef #define #include #include namespace [mscclpp]struct [Timer][start_];int [timeout_];[Timer](int [~Timer]();[elapsed]()const ; void [set](int void [reset]();void [print](const }; struct [ScopedTimer]public [Timer]const [name_];[ScopedTimer](const [~ScopedTimer]();}; std::string[getHostName]( int const char bool [isNvlsSupported]();} #endif
+
+
diff --git a/genindex.html b/genindex.html
index 62fe8ba1..d381fa91 100644
--- a/genindex.html
+++ b/genindex.html
@@ -49,6 +49,7 @@
Design
Performance
diff --git a/getting-started/quickstart.html b/getting-started/quickstart.html
index a562e246..f9f1aee3 100644
--- a/getting-started/quickstart.html
+++ b/getting-started/quickstart.html
@@ -67,6 +67,7 @@
Design
Performance
@@ -144,7 +145,7 @@ Build with Docker Images.
-Build from Source
+Build from Source
CMake 3.25 or later is required.
git clone https://github.com/microsoft/mscclpp.git
$ mkdir -p mscclpp/build && cd mscclpp/build
@@ -173,7 +174,7 @@ Install from Source (Libraries and Headers) 
+
+
Public Member Functions inherited from 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
