feat: support CCL Gather - #67
Open
GordonYang1 wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds
Gathersupport to the shared CCL backend abstraction by composing provider-native grouped point-to-point operations through the existing NCCL and MCCL layers for the existing publicinfinicclGather()API. It also keeps inter-only communicators on the existing OpenMPI staging path during mixed-backend bootstrap flows, hardens the shared OpenMPI/MPICH movement path with communicator validation, byte-count and overflow checks, and automatic host-buffer cleanup, defines zero-count behavior, makes the existing MPI example validate every received source block and propagate failures, and includes CCL-only plus OpenMPI-assistedGatherexamples with correctness and communication-bandwidth reporting.Changes
Public API and Dispatch
infinicclGather()API for configured CCL backends through generated bridge dispatch without changing its public signature.Gatherafter validating the communicator, data type, and root, without requiring non-null buffers or entering a backend.Common CCL Implementation
Gatherimplementation using grouped point-to-point operations because the providers do not expose a nativeGathercollective.size_toverflow.GroupEndafter a successfulGroupStart.Existing CCL Provider Bindings
GroupStart,GroupEnd,Send, andRecvbindings.Gatherwith the existing NCCL and MCCL provider layers without introducing a dependency on a vendor-specificGatherentry point.MPI Correctness and Safety
Gatheras a movement operation in the shared OpenMPI/MPICH implementation by usingMPI_BYTEwithcount * type_sizebytes per rank, preserving every data type includingFloat16andBFloat16.intcount-range, and total-buffer-size validation.Examples, Validation, and Metrics
Gatherexample using one shared unique ID and rank-based communicator initialization.Gatherexamples.world_size * rank_bytes / time, and bus bandwidth as algorithm bandwidth multiplied by(world_size - 1) / world_size.Platform and Backend Affected
Platform
Backend
Performance Impact
This adds GPU-native NCCL and MCCL paths for
Gather, avoiding the existing MPI host-staging path when a supported CCL backend and matching native communicator are available. The native path composes grouped point-to-point operations because neither provider exposes a vendorGathercollective, while the shared MPI fallback remains host-staged with byte-count movement semantics and additional validation and cleanup. Other collective operations are intended to remain unchanged. The validation-log timings below are execution references rather than a quantified cross-backend performance comparison.Known Issues & Future Work
Gatheralongside the existingAllReduce; other independently developed CCL collectives are outside this branch.Gatherinherits the backend/device combinations and data type support of the existing CCL providers; this PR does not add a new provider or device integration.Gatherentry point. Each rank sends once, while the root receives one block per rank, so root-side work and storage grow linearly with communicator size.Float32payloads with root rank 0 on the default stream. Additional data types, in-place layouts, non-default streams, and runtime coverage on Iluvatar and Moore Threads remain future work.intrange; chunked transfers remain future work.Test Results
The implementation commit is
773a7d32846a547c83effb5f0db9f5d8a208424e, a single commit directly based onef4045a2d99837c75c2acd90aae57dacb83172d2. The attached evidence contains exactly 15 hash-verified canonical logs from the current commit: all 15 targets passed, withCorrect: YES17 times andCorrect: NO0 times. The extra two positive results are the additional expected validation cases in the broadcast log.All four
Gatherpaths passed with a 1,048,576-elementFloat32contribution per rank (4.00 MiB), 2 warm-up iterations, and 20 profiled iterations:The reported times are the root rank's elapsed time averaged over the 20 profiled calls after the 2 warm-up calls. Algorithm bandwidth uses the total bytes gathered at the root, and bus bandwidth applies the
(world_size - 1) / world_sizecorrection factor. The values were independently recomputed while accounting for the displayed time being rounded to three decimal places. They are included as execution evidence, not as a cross-platform benchmark comparison.Gatherlog also confirms that the OpenMPI fallback passed before the native NCCL communicator was initialized.Test Involved Platform
Test Involved Backend
Pure CCL (NCCL) on single-node NVIDIA:
ccl_all_reduce.log
ccl_gather.log
CCL + MPI on single-node NVIDIA:
ccl_mpi_hybrid_all_reduce.log
ccl_mpi_hybrid_gather.log
MPI on Heterogeneous Cluster:
mpi_all_gather.log
mpi_all_reduce.log
mpi_all_to_all.log
mpi_broadcast.log
mpi_gather.log
mpi_reduce.log
mpi_reduce_scatter.log
mpi_scatter.log
mpi_send_recv.log
Pure CCL (MCCL) on single-node MetaX:
ccl_all_reduce.log
ccl_gather.log
Checklist
Title, Branch, and Commits
feat: …,fix(nccl): …).<type>/xxx-yyyy-zzzzwhere<type>matches the PR title's Conventional Commits type and words are joined with hyphens (seeCONTRIBUTING.md§Branches).CONTRIBUTING.md§Pull Requests).master— the branch is rebased cleanly on top of the currentmaster.fixup!/squash!/wipcommits remain.Scope and Design
CONTRIBUTING.md§Code/General).printf/std::cout/print(...)left behind, orTODOwithout an owner and issue link.General Code Hygiene
CONTRIBUTING.md§Code/General).CONTRIBUTING.md§Code/General).the `AllReduce` implementation) (CONTRIBUTING.md§Code/General).CONTRIBUTING.md§Code/General).CONTRIBUTING.md§Code/General; §Python).C++ Specific (if C++ files changed)
clang-format(version 16, per.github/workflows/clang-format.yml) has been run against all modified applicable files; the diff is clean.assertwith messages that include at least__FILE__,__LINE__, and__func__(CONTRIBUTING.md§C++).CONTRIBUTING.md§C++).CONTRIBUTING.md§C++).CONTRIBUTING.md§C++).CONTRIBUTING.md§C++).CONTRIBUTING.md§C++).Python Specific (if Python files changed)
ruff checkpasses cleanly on CI (see `.github/workflows/ruff.yml).ruff format --checkpasses cleanly — if not, runruff formatand commit the result.CONTRIBUTING.md§Python).pytest.skipmessages without terminal period) are honored where applicable (CONTRIBUTING.md§Python).CONTRIBUTING.md§Python).if,for, and similar control-flow statements (CONTRIBUTING.md§Python).return, except when it directly follows a control-flow statement (CONTRIBUTING.md§Python).Testing
Build, CI, and Tooling
CMakeLists.txtunderif(AUTO_DETECT_DEVICES)or toif(AUTO_DETECT_BACKENDS)if applicable.clang-format.yml,ruff.yml) are green locally (or expected to be green on CI).Documentation
README.md,CONTRIBUTING.md, or inline docs updated when behavior, build flags, or developer workflow changed.!orBREAKING CHANGE:footer.Security and Safety