Skip to content

feat: support CCL ReduceScatter - #64

Open
GordonYang1 wants to merge 1 commit into
InfiniTensor:masterfrom
GordonYang1:feat/support-ccl-reduce-scatter
Open

feat: support CCL ReduceScatter#64
GordonYang1 wants to merge 1 commit into
InfiniTensor:masterfrom
GordonYang1:feat/support-ccl-reduce-scatter

Conversation

@GordonYang1

Copy link
Copy Markdown
Collaborator

Summary

This PR adds ReduceScatter support to the shared CCL backend abstraction, including native bindings through the existing NCCL and MCCL provider layers for the public infinicclReduceScatter() API. It also keeps inter-only communicators on the existing OpenMPI staging path during mixed-backend bootstrap flows, hardens the shared OpenMPI/MPICH ReduceScatter implementation with typed-reduction validation, overflow checks, and automatic host-buffer cleanup, defines zero-count behavior, makes the existing MPI example validate rank-specific destination blocks and propagate failures, and includes CCL-only plus OpenMPI-assisted ReduceScatter example programs covering out-of-place and canonical in-place flows.

Changes

  • Public API and Dispatch

    • Enable the existing infinicclReduceScatter() API for configured CCL backends through generated bridge dispatch without changing its public signature.
    • Use a matching native CCL intra communicator when available, and otherwise delegate to the existing OpenMPI provider when the communicator has only an OpenMPI inter communicator.
    • Return success for a zero-count ReduceScatter after validating the communicator, data type, and reduction operation, without requiring non-null buffers or entering a backend.
  • Common CCL Implementation

    • Add a shared provider-oriented CCL ReduceScatter implementation following the existing AllReduce structure.
    • Validate the native communicator backend, device, and handle before dispatch.
    • Map InfiniCCL data types and reduction operations through the configured provider and return NotSupported when the provider cannot represent either value.
  • Existing CCL Provider Bindings

    • Extend the existing NCCL and MCCL API wrappers with thin bindings to ncclReduceScatter() and mcclReduceScatter().
    • Register ReduceScatter with the existing NCCL and MCCL provider layers.
  • MPI Correctness and Safety

    • Keep arithmetic reduction on typed MPI_Reduce_scatter_block() calls and reject data types that map to MPI_BYTE, avoiding invalid byte-wise reductions for Float16 and BFloat16.
    • Add world-size, size_t multiplication, buffer-size, and MPI int count-range checks for staged transfers.
    • Manage host staging buffers with automatic cleanup across success and error paths.
    • Validate the rank-specific destination block in the existing MPI example and return a non-zero process status on failure.
  • Examples and Validation

    • Add a thread-per-GPU single-node CCL ReduceScatter example using one shared unique ID and rank-based communicator initialization.
    • Add an OpenMPI-assisted CCL ReduceScatter example that first uses the public ReduceScatter API through the OpenMPI inter communicator to distribute the native unique ID, then initializes the native CCL communicator for GPU reduction and scatter.
    • Validate both out-of-place and canonical in-place layouts with destination-block-dependent expected values on every rank.
    • Restore the local input block before every in-place iteration and propagate cluster-wide validation failures through a native ReduceScatter status operation.
    • Parse numeric options without exceptions and guard example buffer-size calculations against overflow.

Platform and Backend Affected

Platform

  • CPU
  • NVIDIA GPU
  • Iluvatar GPU
  • MetaX GPU
  • Moore Threads GPU
  • Cambricon MLU
  • HYGON DCU

Backend

  • OpenMPI
  • MPICH
  • NCCL
  • MCCL

Performance Impact

  • No performance impact
  • Performance improved
  • Performance regression possible

This adds GPU-native NCCL and MCCL paths for ReduceScatter, avoiding the existing MPI host-staging path when a supported CCL backend and native communicator are available. The shared MPI path remains host-staged and retains typed reduction semantics with additional validation and cleanup. Other collective operations are intended to remain unchanged.

Known Issues & Future Work

  • The CCL collective backend on this branch now covers AllReduce and ReduceScatter; other CCL collective operations remain future work.
  • ReduceScatter inherits the backend/device combinations, data types, and reduction operations supported by the existing CCL providers; this PR does not add a new provider or device integration.
  • The server examples validate Float32 Sum payloads on the default stream. Additional payload data types, reduction operations, non-default streams, and runtime coverage on Iluvatar and Moore Threads remain future work.
  • The shared OpenMPI/MPICH fallback remains host-staged with per-call allocations, rejects Float16 and BFloat16 arithmetic reductions until a typed host conversion path is available, and rejects per-rank counts above the MPI int range; chunked transfers remain future work.

Test Results

Test Involved Platform

  • CPU
  • NVIDIA GPU
  • Iluvatar GPU
  • MetaX GPU
  • Moore Threads GPU
  • Cambricon MLU
  • HYGON DCU

Test Involved Backend

  • OpenMPI
  • MPICH
  • NCCL
  • MCCL

Pure CCL (NCCL) on single-node NVIDIA:
ccl_all_reduce.log
ccl_reduce_scatter.log

CCL + MPI on single-node NVIDIA:
ccl_mpi_hybrid_all_reduce.log
ccl_mpi_hybrid_reduce_scatter.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_reduce_scatter.log


Checklist

Every contributor must verify every item below before requesting
review. Tick each box only after the check has actually been performed —
do not tick speculatively. If an item truly does not apply, replace the
checkbox with N/A and briefly explain why in an inline comment.

Title, Branch, and Commits

  • PR title follows Conventional Commits (e.g. feat: …, fix(nccl): …).
  • Branch name follows <type>/xxx-yyyy-zzzz where <type> matches the PR title's Conventional Commits type and words are joined with hyphens (see CONTRIBUTING.md §Branches).
  • Each commit message follows Conventional Commits.
  • Small PR is a single squashable commit; or, for a large PR, every commit is meaningful, well-formed, and independently reviewable (see CONTRIBUTING.md §Pull Requests).
  • No stray merge commits from master — the branch is rebased cleanly on top of the current master.
  • No fixup! / squash! / wip commits remain.

Scope and Design

  • Changes are minimal — no unrelated modifications were introduced (CONTRIBUTING.md §Code/General).
  • No dead code, commented-out blocks, debug prints, printf/std::cout/print(...) left behind, or TODO without an owner and issue link.
  • No unrelated formatting churn that would obscure the diff.
  • Public API changes (if any) are intentional, documented, and reflected in affected callers/tests.

General Code Hygiene

  • The code is self-explanatory; comments were added only where the intent or rationale is non-obvious (CONTRIBUTING.md §Code/General).
  • Every modified or added file ends with a single trailing newline (CONTRIBUTING.md §Code/General).
  • No trailing whitespace, inconsistent indentation, or mixed formatting styles remain.
  • Identifiers referenced in comments or error messages are wrapped in Markdown backticks (e.g. the `AllReduce` implementation) (CONTRIBUTING.md §Code/General).
  • All comments and error messages are in English (CONTRIBUTING.md §Code/General).
  • Comments and error messages are complete sentences — capitalized first letter, terminal punctuation — unless the language/framework convention says otherwise (CONTRIBUTING.md §Code/General; §Python).

C++ Specific (if C++ files changed)

  • Code follows the Google C++ Style Guide strictly.
  • clang-format (version 16, per .github/workflows/clang-format.yml) has been run against all modified applicable files; the diff is clean.
  • No exceptions are thrown. Error paths use assert with messages that include at least __FILE__, __LINE__, and __func__ (CONTRIBUTING.md §C++).
  • Error and warning message wording follows the LLVM Coding Standards (CONTRIBUTING.md §C++).
  • N/A- Constructor initializer list order matches member declaration order (CONTRIBUTING.md §C++).
  • Exactly one blank line between classes, between classes and functions, and between functions (CONTRIBUTING.md §C++).
  • Exactly one blank line between members (functions and variables) within a class (CONTRIBUTING.md §C++).
  • Exactly one blank line before and after the contents of a namespace (CONTRIBUTING.md §C++).

Python Specific (if Python files changed)

  • N/A- Code is PEP 8 compliant; ruff check passes cleanly on CI (see `.github/workflows/ruff.yml).
  • N/A- ruff format --check passes cleanly — if not, run ruff format and commit the result.
  • N/A- Comments are complete English sentences, starting with a capital letter and ending with punctuation; Markdown backticks are used for code references (CONTRIBUTING.md §Python).
  • N/A- Framework-specific conventions (e.g. lowercase pytest.skip messages without terminal period) are honored where applicable (CONTRIBUTING.md §Python).
  • N/A- No blank line between the function signature and the body when there is no docstring or comment (CONTRIBUTING.md §Python).
  • N/A- A blank line is present before and after if, for, and similar control-flow statements (CONTRIBUTING.md §Python).
  • N/A- A blank line appears before each return, except when it directly follows a control-flow statement (CONTRIBUTING.md §Python).
  • N/A- Docstrings (if any) follow PEP 257 (CONTRIBUTING.md §Python).
  • N/A- Type hints are added / kept consistent with the surrounding code.

Testing

  • All applicable example programs have been built and tested successfully on at least one supported heterogeneous cluster setup.

Build, CI, and Tooling

  • N/A- New backends or devices have been added to auto-detection in CMakeLists.txt under if(AUTO_DETECT_DEVICES) or to if(AUTO_DETECT_BACKENDS) if applicable.
  • Both CI workflows (clang-format.yml, ruff.yml) are green locally (or expected to be green on CI).

Documentation

  • N/A- README.md, CONTRIBUTING.md, or inline docs updated when behavior, build flags, or developer workflow changed.
  • N/A- Any user-visible breaking change is called out explicitly under "Summary" and in the commit/PR title with a ! or BREAKING CHANGE: footer.

Security and Safety

  • No secrets, access tokens, internal URLs, customer data, or personal hardware identifiers have been committed.
  • N/A- Third-party code is license-compatible and attributed.
  • No unsafe pointer arithmetic, uninitialized reads, or missing bounds checks were introduced.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant