Compare commits

...

94 Commits

Author SHA1 Message Date
Cheng ec59531c02 Add free threaded build 2026-05-06 17:27:07 -07:00
Cheng 1091e3dd0a Use uv in macOS CI 2026-05-06 15:41:43 +09:00
Cheng 80bcd1c658 [CUDA] Fix half type matmul in cutlass kernels (#3469) 2026-05-06 08:35:53 +09:00
serenposh 1fdd4e23c2 Clearer error when shape dimension overflows int32 (#3425)
Co-authored-by: Kanishk <kanishk.chores@gmail.com>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-05 09:53:36 +09:00
Pedro Cuenca b43965925f Define ST_F8_E8M0 (#3448) 2026-05-05 09:22:23 +09:00
Abhilash Shankarampeta 0938db7e54 Add determinant and sign-log-determinant functions to mlx.core.linalg (#3416)
Co-authored-by: Lucas Fernandes Martins <Lucas-Fernandes-Martins@users.noreply.github.com>
2026-05-05 09:06:23 +09:00
Irakli Salia e8ebdebeeb Add barrier to JACCL (#3459) 2026-04-28 09:39:56 -07:00
Cheng d7d0992d75 Reuse nightly build's ccache for release (#3458) 2026-04-28 10:54:41 +09:00
Kimon N. bdb6ff8881 Keep gguflib input-validation asserts active in release builds (#3436) 2026-04-27 08:46:57 +09:00
Long Yixing 894c948773 [CUDA] Fix qmm_naive K-tail dispatch for FP quantized kernels (#3445) 2026-04-27 08:40:14 +09:00
Angelos Katharopoulos 211e57be53 Bump minor (#3438) 2026-04-22 11:09:30 -07:00
Cheng c284e0a231 Enable swap for all CI building CUDA (#3437) 2026-04-22 13:13:24 +09:00
Cheng b9b1bfb9a5 Generate qmm implementaions with cmake (#3424) 2026-04-22 13:11:55 +09:00
Cameron Churchwell 68cf2fddd8 Fix mx.prod vjp for complex types (#3433) 2026-04-21 17:35:20 -07:00
Doğukan Veziroğlu c594e6ec38 Fix use after move in Compiled primitive (#3427) 2026-04-21 15:22:45 -07:00
Doğukan Veziroğlu 7d40a4fd5a Throw meaningful error when Metal device is not found (#3428) 2026-04-21 15:21:08 -07:00
Doğukan Veziroğlu 5f519ef6f9 Fix bytes_per_key truncation in random kernels (Metal + CUDA) (#3432) 2026-04-21 15:15:11 -07:00
Angelos Katharopoulos 705c828feb Fix synchronize for ThreadLocalStream (#3429) 2026-04-20 11:29:49 -07:00
Cheng b4ddf9b374 Fix flaky TestVmap.test_vmap_masked_scatter (#3421) 2026-04-20 17:19:20 +09:00
Cheng 1f5a413a27 Make Scheduler::enqueue thread safe (#3423) 2026-04-20 14:30:05 +09:00
Angelos Katharopoulos a6222f53d5 Speed up NAX split-K by better tuning and routing and fix NAX addmm (#3422)
I 'll merge now and comment with more benchmarks later since this also fixes two bugs so worst case we 'll do another tuning, it isn't like we won't need the functionality of this PR.
2026-04-19 18:05:39 -07:00
Cheng fa4320d5fa [CUDA] Handle residue k in qmm_naive (#3379) 2026-04-18 13:30:07 +09:00
Long Yixing 859f22fbb0 [CUDA] GatherQMM matrix-matrix sm80/naive path (#3417)
Co-authored-by: Cheng <git@zcbenz.com>
2026-04-18 10:59:47 +09:00
Cheng d142de6a20 [CUDA] gather_mm (#3414) 2026-04-17 16:53:44 +09:00
Angelos Katharopoulos 940ba473fe Segmented mm nax kernel (#3419) 2026-04-16 17:26:29 -07:00
Angelos Katharopoulos 8e649be4d0 Fix jaccl init bug (#3418) 2026-04-16 01:23:35 -07:00
Cheng dec6b4d10f ThreadLocalStream in C++ (#3405) 2026-04-15 15:46:11 -07:00
NeuralNoble fd8e849e26 Document sort stability and NaN handling (#3400) 2026-04-15 14:32:42 -07:00
Matias Insaurralde 50ae31241a Validate safetensors data offsets against file boundaries (#3410)
Co-authored-by: Angelos Katharopoulos <a_katharopoulos@apple.com>
2026-04-15 14:30:55 -07:00
Dan Anderson 6cef1e995e Validate safetensors data offsets (#3364) 2026-04-15 00:52:42 -07:00
Cheng 57bcced8cb Fixes for CUDA CI (#3413) 2026-04-14 23:52:52 -07:00
Angelos Katharopoulos 4400504ad5 Jaccl refactor (#3412) 2026-04-14 23:52:21 -07:00
jrp2014 1fa764fbec Update nanobind version to v2.12.0 (#3396) 2026-04-14 17:21:00 -07:00
Cheng 435f0b6cdb Add clear_streams API for cleanup before exit (#3395) 2026-04-14 18:41:32 +09:00
Cheng 520cea2bec Avoid joining threads on exit (#3388) 2026-04-11 09:22:34 +09:00
Clydingus a33b791615 Fix int16 overflow in SDPA NAX mask indexing for KV sequences > 32K (#3361)
Co-authored-by: Angelos Katharopoulos <a_katharopoulos@apple.com>
2026-04-10 00:01:47 -07:00
Cameron Churchwell d6d9b24801 Conjugate VJP and JVP support (#3386) 2026-04-09 15:04:46 -07:00
Daniil Seredkin 8332e228e4 Fix test "test get streams" missing initialization (#3376) 2026-04-09 08:29:04 +09:00
Cheng 4403165843 [CUDA] Thread safety (#3367) 2026-04-09 08:18:00 +09:00
Shantanu Suryawanshi a8776b7bbd Fix: Correct cross-attention query routing in Post-LN TransformerDecoderLayer (#3382) 2026-04-07 09:16:12 -07:00
Doğukan Veziroğlu b98831ad0e fix: fail build when Metal compiler header resolution fails (#3332) 2026-04-06 12:49:25 -07:00
Long Yixing d025111b1d [CUDA] Add GatherQMM for quantized gather matmul (#3321) 2026-04-06 12:48:18 -07:00
Harrison Powers 9239808225 Fix CMake finding wrong Python during pip install (#3375) 2026-04-06 12:32:16 -07:00
Angelos Katharopoulos 6a9a121d09 Add a convenience for making local streams in python (#3355) 2026-04-02 18:43:02 -07:00
Christophe Prat befe42d303 Add printoptions (#3333) 2026-04-01 22:24:48 -07:00
Valentin Roussellet 80a1c206f9 Use metal as the front-end for the metal linker (#3354) 2026-04-01 16:52:07 -07:00
Angelos Katharopoulos b0748ad8de Fix regression in array creation (#3353) 2026-04-01 11:30:36 -07:00
Cheng 2ffafe07f4 [CUDA] 3/5/6-bit quants for qmm_naive (#3352) 2026-04-01 20:13:01 +09:00
Cheng 5e2c44259f Make CommandEncoder thread local (#3348) 2026-04-01 18:42:49 +09:00
Cheng 1c9ee2f655 [CUDA] Fallback QMM (#3315) 2026-04-01 12:41:26 +09:00
Long Yixing 7cd73c4202 [Metal] Support sorting complex numbers (#3314) 2026-04-01 12:40:50 +09:00
declanhealy2 2105df91da Add fftfreq, rfftfreq and scalar axes for fftshift/ifftshift (#3298) 2026-03-31 18:29:16 -07:00
Angelos Katharopoulos 1944cf67a2 Add vmap for BroadcastAxes (#3344) 2026-03-31 17:08:56 -07:00
Cheng 939e425c7a Decouple CommandEncoder from Device (#3316) 2026-04-01 08:51:17 +09:00
Angelos Katharopoulos 8439b1f501 Fix use after move (#3343) 2026-03-31 10:37:40 -07:00
dependabot[bot] 117b4f1806 Bump actions/deploy-pages from 4 to 5 (#3334)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-03-31 09:04:19 +09:00
Cheng 66f58032dc Remove no longer needed const_cast (#3325) 2026-03-31 08:10:49 +09:00
Kellen Sun 8a6d28713c Fix np bfloat16 misinterpreted as complex (#3146)
Co-authored-by: Cheng <git@zcbenz.com>
2026-03-31 08:04:55 +09:00
Long Yixing 0ff1115a46 [CUDA] Implement BlockMaskedMM (#3299)
Co-authored-by: Cheng <git@zcbenz.com>
2026-03-27 06:57:26 +09:00
Cheng df7f7db943 Make each thread have its own default stream (#3281) 2026-03-25 15:48:49 +09:00
Sheldon Aristide 57c813f042 Add norm parameter to FFT transforms (#3287)
Co-authored-by: Cheng <git@zcbenz.com>
2026-03-25 13:27:40 +09:00
Long Yixing f8eda2c61b [CUDA] support sorting complex numbers (#3286) 2026-03-25 12:35:02 +09:00
Cheng 282174dd03 Manage Metal objects with smart pointers (#3282) 2026-03-25 11:19:20 +09:00
Pranav Hari bd200d6267 Add output_shapes for AddMM (#3262)
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Angelos Katharopoulos <a_katharopoulos@apple.com>
2026-03-25 10:46:15 +09:00
Cheng d01b83dfe7 Use nb::ndarray for checking arrays (#3283) 2026-03-25 10:44:54 +09:00
Sheldon Aristide 1b1c56352a Fix moved-from shape bug in broadcast_arrays causing vmap bus error (#3310) 2026-03-24 17:02:31 -07:00
Robert Johansson e18d4e97f6 Fix vmap + floor_divide: preserve integer dtype (#3292)
Co-authored-by: Robert Johansson <robert@Mac-Mini-KI.lan>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Angelos Katharopoulos <katharas@gmail.com>
Co-authored-by: Angelos Katharopoulos <a_katharopoulos@apple.com>
2026-03-25 08:10:37 +09:00
Ronan Collobert 9ab3913567 logo files (#3308) 2026-03-24 15:08:06 -07:00
Sheldon Aristide 81530c261b Implement Pad::vmap (#3304)
Co-authored-by: Angelos Katharopoulos <a_katharopoulos@apple.com>
2026-03-24 15:02:31 -07:00
LongYinan 604c825538 Fix stale transform copy-chain leaks (#3290) 2026-03-24 14:15:23 -07:00
LongYinan e40ada3fe2 [Metal] Fix depthwise conv 1D kernel name for large variant (#3289) 2026-03-23 16:20:13 -07:00
Ziqiao-git 38ad257088 [Metal][Performance]: Add split-K for quantized matmul (small M) (#3120) 2026-03-20 20:15:48 -07:00
Cheng 70a0da6fca Use thread local storage for frontend compile cache (#3280) 2026-03-20 07:44:45 +09:00
Long Yixing 82809ebd12 Fix sort NaN handling for float16 and bfloat16 (#3269) 2026-03-19 15:19:41 -07:00
AN Long 5fa1a8d59f Support indexing with any type which implmented __index__ (#3210) 2026-03-19 15:19:08 -07:00
Cheng 21c11fc9b0 Create default random key lazily (#3278) 2026-03-19 20:22:52 +09:00
Cheng e1cbac9cf4 [CUDA] Search system-installed CUDA toolkit for headers (#3277) 2026-03-19 20:09:05 +09:00
Cheng c8292ea11c Merge DeviceStream into CommandEncoder (#3264) 2026-03-19 19:39:30 +09:00
Angelos Katharopoulos 45af0df90b Fix repr of conv layers (#3275) 2026-03-18 22:47:38 -07:00
Cheng dbfbc0f65a [CUDA] fp and int4 quants for qmm_sm80 (#3268) 2026-03-19 09:38:55 +09:00
Cheng 75f74ea9bc Fix building with CUDA toolkit 13.2 (#3273) 2026-03-19 08:31:44 +09:00
Jagrit Digani b41b349b67 Nax Refactor (#3271) 2026-03-18 10:26:49 -07:00
Angelos Katharopoulos 7bc61cceed Slice update with operation (#3266) 2026-03-18 06:18:02 -07:00
Ihar Hrachyshka e353be8235 tests: harden memory leak check in test_siblings_without_eval (#3088)
Signed-off-by: Ihar Hrachyshka <ihar.hrachyshka@gmail.com>
2026-03-17 16:03:10 +09:00
Cheng 1e855446b2 [CUDA] Pipelined QMM (#3255) 2026-03-17 07:10:12 +09:00
mm65x f226eeec9e Fix nn.GRU skipping bhn bias when hidden is None (#3252)
Co-authored-by: mm65x <mm65x@users.noreply.github.com>
2026-03-16 13:28:14 -07:00
mm65x 505fc9850d Fix comparison op JVP returning bool tangents instead of input dtype (#3253) 2026-03-16 10:57:28 -07:00
Thomas Schranz ea91bd02cf update requirements for Macbook Neo (#3257) 2026-03-16 04:33:09 -07:00
Lik Xun Yuan (Lx) 1d44d913e6 docs: fix PyTorch to MLX conversion example (#3265) 2026-03-16 04:20:12 -07:00
Long Yixing 0bdbfdb838 [CUDA] Implement MaskedScatter (#3151) 2026-03-15 10:33:55 +09:00
Lucas Newman 5d1700493a [CUDA] Add FFT support (#3243) 2026-03-14 21:02:19 +09:00
Valentin Roussellet b0564a9112 Fix crashes in multi-threaded process teardown (#3167) 2026-03-12 21:45:06 -07:00
Daniel Hiltgen 7adfc83c7d win: re-enable and fix cuDNN performance (#3242) 2026-03-13 09:41:59 +09:00
Angelos Katharopoulos 0358c602c7 Bump (#3244) 2026-03-11 23:57:22 -07:00
256 changed files with 13213 additions and 4244 deletions
@@ -18,9 +18,9 @@ runs:
env:
CMAKE_ARGS: -DMLX_BUILD_CUDA=ON
run: |
pip install auditwheel build patchelf setuptools
pip install auditwheel "build<=1.4.2" patchelf setuptools
python setup.py clean --all
MLX_DISABLE_SM90A_KERNELS=1 MLX_BUILD_STAGE=2 python -m build -w
MLX_BUILD_STAGE=2 python -m build -w
auditwheel repair dist/mlx_cuda*.whl \
--plat manylinux_2_35_${{ inputs.arch }} \
@@ -25,7 +25,7 @@ runs:
- name: Build Python package
shell: bash
run: |
pip install auditwheel patchelf build
pip install auditwheel patchelf "build<=1.4.2"
python setup.py clean --all
MLX_BUILD_STAGE=1 python -m build -w
auditwheel repair dist/mlx-*.whl \
@@ -21,7 +21,7 @@ runs:
DEVELOPER_DIR: /Applications/Xcode-latest.app
MACOSX_DEPLOYMENT_TARGET: ${{ inputs.macos-target }}
run: |
pip install build
uv pip install build
python setup.py clean --all
MLX_BUILD_STAGE=1 python -m build -w
+40 -24
View File
@@ -4,59 +4,72 @@ description: 'Build and test MLX on macOS'
runs:
using: "composite"
steps:
- name: Install dependencies
- name: Install Python package
env:
DEBUG: 1
CMAKE_ARGS: "-DCMAKE_COMPILE_WARNING_AS_ERROR=ON"
shell: bash -l {0}
shell: bash
run: |
pip install --upgrade pip
pip install cmake setuptools typing_extensions
pip install -e . -v
echo "::group::Install Python package"
uv pip install -e ".[dev]" -v
echo "::endgroup::"
- name: Install tests dependencies
shell: bash -l {0}
shell: bash
run: |
pip install numpy torch tensorflow
echo "::group::Install tests dependencies"
uv pip install tensorflow
echo "::endgroup::"
- name: Run Python tests
shell: bash -l {0}
shell: bash
env:
LOW_MEMORY: 1
run: |
echo "::group::Run Python tests"
DEVICE=cpu python -m unittest discover -v python/tests
DEVICE=gpu METAL_DEVICE_WRAPPER_TYPE=1 METAL_DEBUG_ERROR_MODE=0 python -m unittest discover -v python/tests
mpirun --bind-to none -host localhost:8 -np 8 -x DYLD_LIBRARY_PATH=/opt/homebrew/lib/ python python/tests/mpi_test_distributed.py
mlx.launch --verbose -n 8 python/tests/ring_test_distributed.py -v 2> >(tee -a stderr.log >&2)
if $(grep "\[WARN\]" stderr.log); then echo "Distributed ring test failed"; exit 1; fi
echo "::endgroup::"
- name: Build example extension
shell: bash -l {0}
shell: bash
run: |
echo "::group::Build example extension"
cd examples/extensions
pip install -r requirements.txt
python setup.py build_ext --inplace
python test.py
uv pip install -r requirements.txt
uv run --no-project setup.py build_ext --inplace
uv run --no-project test.py
echo "::endgroup::"
- name: Build CPP only
shell: bash -l {0}
shell: bash
run: |
echo "::group::Build CPP only"
mkdir -p build
cd build
cmake ..
make -j $(sysctl -n hw.ncpu)
echo "::endgroup::"
- name: Run CPP tests
shell: bash -l {0}
shell: bash
env:
DEVICE: gpu
METAL_DEVICE_WRAPPER_TYPE: 1
METAL_DEBUG_ERROR_MODE: 0
run: ./build/tests/tests
- name: Build small binary with JIT
shell: bash -l {0}
run: |
echo "::group::Run CPP tests"
./build/tests/tests
./build/tests/test_teardown
echo "::endgroup::"
- name: Build small binary with JIT
shell: bash
run: |
echo "::group::Build small binary with JIT"
mkdir -p build
cd build
cmake .. -DCMAKE_BUILD_TYPE=MinSizeRel \
@@ -66,15 +79,18 @@ runs:
-DMLX_BUILD_GGUF=OFF \
-DMLX_METAL_JIT=ON
make -j $(sysctl -n hw.ncpu)
echo "::endgroup::"
- name: Run Python tests with JIT
shell: bash -l {0}
shell: bash
env:
LOW_MEMORY: 1
DEVICE: gpu
METAL_DEVICE_WRAPPER_TYPE: 1
METAL_DEBUG_ERROR_MODE: 0
run: |
echo "::group::Run Python tests with JIT"
CMAKE_ARGS="-DMLX_METAL_JIT=ON" \
pip install -e . -v
uv pip install -e . -v
python -m unittest discover -v python/tests
echo "::endgroup::"
+10 -1
View File
@@ -14,6 +14,9 @@ inputs:
description: 'Whether to enable ccache'
required: false
default: 'true'
ccache-key:
required: false
default: 'ccache'
runs:
using: "composite"
@@ -33,7 +36,7 @@ runs:
if: ${{ inputs.use-ccache == 'true' }}
uses: hendrikmuhs/ccache-action@v1.2
with:
key: ccache-${{ runner.os }}-${{ runner.arch }}-${{ inputs.toolkit }}
key: ${{ inputs.ccache-key }}-${{ runner.os }}-${{ runner.arch }}-${{ inputs.toolkit }}
max-size: 1GB
# ccache-action bug: running "apt-get update" fails on large arm runner.
update-package-index: false
@@ -54,6 +57,12 @@ runs:
echo PYTHONPATH=`python -c 'import sys; print(sys.path[-1])'` >> $GITHUB_ENV
echo "::endgroup::"
- name: Set swap space
if: ${{ startsWith(inputs.toolkit, 'cuda') }}
uses: pierotofy/set-swap-space@fc79b3f67fa8a838184ce84a674ca12238d2c761
with:
swap-size-gb: 16
- name: Install CUDA toolkit
if: ${{ startsWith(inputs.toolkit, 'cuda') }}
shell: bash
+13 -5
View File
@@ -13,12 +13,20 @@ runs:
- name: Install Homebrew packages
shell: sh
run: /opt/homebrew/bin/brew install openmpi
- name: Verify MetalToolchain installed
shell: bash
run: xcodebuild -showComponent MetalToolchain
- uses: conda-incubator/setup-miniconda@v3
with:
miniconda-version: "latest"
python-version: ${{ inputs.python-version }}
- uses: astral-sh/setup-uv@v7
- name: Setup Python venv
shell: bash
run: |
echo "::group::Setup Python venv"
uv venv --python ${{ inputs.python-version }}
source .venv/bin/activate
echo PATH=$PATH >> $GITHUB_ENV
# Search python packages in .venv
echo PYTHONPATH=`python -c 'import sys; print(sys.path[-1])'` >> $GITHUB_ENV
echo "::endgroup::"
+16 -2
View File
@@ -9,7 +9,21 @@ inputs:
runs:
using: "composite"
steps:
# FIXME: The distributed tests fail with free-threading Python.
- name: Check free-threading Python
id: is-free-threading
shell: bash
run: |
echo "::group::Check free-threading Python"
if python -VV 2>&1 | grep "free-threading"; then
echo "result=true" >> $GITHUB_OUTPUT
else
echo "result=false" >> $GITHUB_OUTPUT
fi
echo "::endgroup::"
- name: Run MPI tests
if: ${{ steps.is-free-threading.outputs.result == 'false' }}
shell: bash
run: |
echo "::group::MPI tests"
@@ -17,7 +31,7 @@ runs:
echo "::endgroup::"
- name: Run distributed tests
if: ${{ inputs.has-gpu == 'false' }}
if: ${{ steps.is-free-threading.outputs.result == 'false' && inputs.has-gpu == 'false' }}
shell: bash
run: |
echo "::group::Distributed tests"
@@ -65,5 +79,5 @@ runs:
DEVICE: gpu
run: |
echo "::group::CPP tests - GPU"
./build/tests/tests -sfe="*fft_tests.cpp,*linalg_tests.cpp"
./build/tests/tests -sfe="*linalg_tests.cpp"
echo "::endgroup::"
+1
View File
@@ -17,4 +17,5 @@ runs:
run: |
echo "::group::CPP tests - CPU"
./build/tests.exe -tce="*gguf*,test random uniform"
./build/test_teardown.exe
echo "::endgroup::"
+1 -1
View File
@@ -25,4 +25,4 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
uses: actions/deploy-pages@v5
+11 -7
View File
@@ -41,7 +41,7 @@ jobs:
strategy:
fail-fast: false
matrix:
python_version: ["3.11", "3.12", "3.13", "3.14"]
python_version: ["3.11", "3.12", "3.13", "3.14", "3.14t"]
runner:
- ubuntu-22.04
- ubuntu-22.04-arm
@@ -59,7 +59,7 @@ jobs:
if: github.repository == 'ml-explore/mlx'
strategy:
matrix:
python-version: ["3.10", "3.13"]
python-version: ["3.10", "3.13", "3.14t"]
runs-on: [self-hosted, macos]
steps:
- uses: actions/checkout@v6
@@ -85,20 +85,24 @@ jobs:
build_cuda_release:
if: github.repository == 'ml-explore/mlx'
runs-on: ubuntu-22-large
strategy:
matrix:
arch: ['x86_64', 'aarch64']
toolkit: ['cuda-12.9', 'cuda-13.0']
runs-on: ${{ matrix.arch == 'x86_64' && 'ubuntu-22-large' || 'ubuntu-22-large-arm' }}
steps:
- uses: actions/checkout@v6
- uses: ./.github/actions/setup-linux
with:
toolkit: 'cuda-12.9'
toolkit: ${{ matrix.toolkit }}
ccache-key: 'ccache-release'
- name: Build Python package
uses: ./.github/actions/build-cuda-release
with:
toolkit: 'cuda-12.9'
arch: 'x86_64'
arch: ${{ matrix.arch }}
- name: Upload artifacts
uses: actions/upload-artifact@v7
with:
name: mlx-cuda
name: mlx-${{ matrix.toolkit }}-${{ matrix.arch }}
path: wheelhouse/mlx_cuda_*.whl
retention-days: 7
+6 -11
View File
@@ -41,13 +41,13 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
uses: actions/deploy-pages@v5
build_linux_release:
if: github.repository == 'ml-explore/mlx'
strategy:
matrix:
python_version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
python_version: ["3.10", "3.11", "3.12", "3.13", "3.13t", "3.14", "3.14t"]
arch: ['x86_64', 'aarch64']
runs-on: ${{ matrix.arch == 'x86_64' && 'ubuntu-22.04' || 'ubuntu-22.04-arm' }}
env:
@@ -83,7 +83,7 @@ jobs:
if: github.repository == 'ml-explore/mlx'
strategy:
matrix:
python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
python-version: ["3.10", "3.11", "3.12", "3.13", "3.13t", "3.14", "3.14t"]
runs-on: [self-hosted, macos]
env:
PYPI_RELEASE: 1
@@ -93,13 +93,8 @@ jobs:
- uses: ./.github/actions/setup-macos
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
shell: bash -l {0}
run: |
pip install --upgrade pip
pip install cmake setuptools typing_extensions
pip install -e . -v
- name: Install Python package
run: uv pip install -e . -v
- name: Build macOS 14 package
uses: ./.github/actions/build-macos-release
with:
@@ -146,7 +141,7 @@ jobs:
- uses: ./.github/actions/setup-linux
with:
toolkit: ${{ matrix.toolkit }}
use-ccache: false
ccache-key: 'ccache-release'
- name: Build Python package
uses: ./.github/actions/build-cuda-release
with:
+14 -1
View File
@@ -156,6 +156,10 @@ if(MLX_BUILD_CUDA)
enable_language(CUDA)
find_package(CUDAToolkit REQUIRED)
find_package(CUDNN REQUIRED)
if(CUDAToolkit_VERSION VERSION_GREATER_EQUAL "13.1" AND CUDAToolkit_VERSION
VERSION_LESS "13.2")
message(FATAL_ERROR "CUDA Toolkit 13.1 is not supported.")
endif()
endif()
if(MLX_BUILD_METAL)
@@ -317,6 +321,15 @@ FetchContent_MakeAvailable(json)
target_include_directories(
mlx PRIVATE $<BUILD_INTERFACE:${json_SOURCE_DIR}/single_include/nlohmann>)
# Add standalone JACCL library (RDMA over Thunderbolt distributed backend)
if(MLX_BUILD_CPU
AND ${CMAKE_SYSTEM_NAME} MATCHES "Darwin"
AND DEFINED MACOS_SDK_VERSION
AND MACOS_SDK_VERSION GREATER_EQUAL 26.2)
add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/mlx/distributed/jaccl/lib
${CMAKE_BINARY_DIR}/jaccl)
endif()
add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/mlx)
target_include_directories(
@@ -344,7 +357,7 @@ if(MLX_BUILD_PYTHON_BINDINGS)
FetchContent_Declare(
nanobind
GIT_REPOSITORY https://github.com/wjakob/nanobind.git
GIT_TAG v2.10.2
GIT_TAG v2.12.0
GIT_SHALLOW TRUE
EXCLUDE_FROM_ALL)
FetchContent_MakeAvailable(nanobind)
+193
View File
@@ -0,0 +1,193 @@
# Copyright © 2025 Apple Inc.
import argparse
import time
import mlx.core as mx
import numpy as np
MLX_DTYPES = {
"float16": mx.float16,
"bfloat16": mx.bfloat16,
"float32": mx.float32,
}
def parse_cases(cases):
parsed = []
for spec in cases.split(","):
parts = spec.split("x")
m, n, k, bs = int(parts[0]), int(parts[1]), int(parts[2]), int(parts[3])
sparsity = float(parts[4]) if len(parts) > 4 else 0.5
parsed.append((m, n, k, bs, sparsity))
return parsed
def make_masks(m, n, k, block_size, sparsity, rng):
"""Create block masks with given sparsity (fraction of blocks zeroed)."""
tm = (m + block_size - 1) // block_size
tn = (n + block_size - 1) // block_size
tk = (k + block_size - 1) // block_size
lhs_mask = (rng.random((tm, tk)) >= sparsity).astype(np.bool_)
rhs_mask = (rng.random((tk, tn)) >= sparsity).astype(np.bool_)
out_mask = (rng.random((tm, tn)) >= sparsity).astype(np.bool_)
return lhs_mask, rhs_mask, out_mask
def mlx_naive_block_masked_mm(a, b, block_size, out_mask, lhs_mask, rhs_mask):
"""MLX naive: expand masks and use regular matmul."""
M, K = a.shape[-2], a.shape[-1]
N = b.shape[-1]
def expand(mask, rows, cols):
e = mx.repeat(mx.repeat(mask, block_size, axis=-2), block_size, axis=-1)
return e[..., :rows, :cols]
a_masked = a * expand(lhs_mask, M, K)
b_masked = b * expand(rhs_mask, K, N)
c = a_masked @ b_masked
c = c * expand(out_mask, M, N)
return c
def bench_mlx(fn, warmup, iters):
for _ in range(warmup):
y = fn()
mx.eval(y)
mx.synchronize()
start = time.perf_counter()
for _ in range(iters):
y = fn()
mx.eval(y)
mx.synchronize()
return (time.perf_counter() - start) * 1e3 / iters
def print_table(headers, rows):
widths = [len(h) for h in headers]
for row in rows:
for i, cell in enumerate(row):
widths[i] = max(widths[i], len(cell))
def fmt_row(row):
return (
"| "
+ " | ".join(f"{cell:<{widths[i]}}" for i, cell in enumerate(row))
+ " |"
)
sep = "|-" + "-|-".join("-" * w for w in widths) + "-|"
print(fmt_row(headers))
print(sep)
for row in rows:
print(fmt_row(row))
def main():
parser = argparse.ArgumentParser(
description="Benchmark block_masked_mm vs naive expand+matmul"
)
parser.add_argument(
"--cases",
default=(
"256x256x256x32x0.5,"
"512x512x512x32x0.5,"
"1024x1024x1024x32x0.5,"
"1024x1024x1024x64x0.5,"
"2048x2048x2048x64x0.5,"
"256x256x256x32x0.0,"
"1024x1024x1024x32x0.0,"
"1024x1024x1024x32x0.9"
),
help="Comma-separated MxNxKxBSxSparsity list. Sparsity=fraction of blocks zeroed.",
)
parser.add_argument(
"--dtype",
default="float32",
choices=["float16", "bfloat16", "float32"],
)
parser.add_argument("--warmup", type=int, default=10)
parser.add_argument("--iters", type=int, default=50)
parser.add_argument("--seed", type=int, default=42)
parser.add_argument("--no-check", action="store_true")
args = parser.parse_args()
mlx_dtype = MLX_DTYPES[args.dtype]
print(f"dtype={args.dtype} warmup={args.warmup} iters={args.iters}")
headers = [
"Case (MxNxKxBS)",
"Sparsity",
"MLX ms",
"Naive ms",
"Speedup",
]
if not args.no_check:
headers.append("Max err")
rows = []
cases = parse_cases(args.cases)
for idx, (m, n, k, bs, sparsity) in enumerate(cases):
rng = np.random.default_rng(args.seed + idx)
a_np = rng.standard_normal((m, k)).astype(np.float32)
b_np = rng.standard_normal((k, n)).astype(np.float32)
lhs_mask_np, rhs_mask_np, out_mask_np = make_masks(m, n, k, bs, sparsity, rng)
a_mx = mx.array(a_np, dtype=mlx_dtype)
b_mx = mx.array(b_np, dtype=mlx_dtype)
lhs_mask_mx = mx.array(lhs_mask_np)
rhs_mask_mx = mx.array(rhs_mask_np)
out_mask_mx = mx.array(out_mask_np)
mx.eval(a_mx, b_mx, lhs_mask_mx, rhs_mask_mx, out_mask_mx)
# Correctness check: block_masked_mm vs naive expand+matmul
err_str = ""
if not args.no_check:
y_op = mx.block_masked_mm(
a_mx, b_mx, bs, out_mask_mx, lhs_mask_mx, rhs_mask_mx
)
y_naive = mlx_naive_block_masked_mm(
a_mx, b_mx, bs, out_mask_mx, lhs_mask_mx, rhs_mask_mx
)
mx.eval(y_op, y_naive)
err = float(mx.max(mx.abs(y_op - y_naive)).item())
err_str = f"{err:.2e}"
# Benchmark
t_mlx = bench_mlx(
lambda: mx.block_masked_mm(
a_mx, b_mx, bs, out_mask_mx, lhs_mask_mx, rhs_mask_mx
),
args.warmup,
args.iters,
)
t_naive = bench_mlx(
lambda: mlx_naive_block_masked_mm(
a_mx, b_mx, bs, out_mask_mx, lhs_mask_mx, rhs_mask_mx
),
args.warmup,
args.iters,
)
speedup = f"{t_naive / t_mlx:.2f}x" if t_mlx > 0 else "-"
row = [
f"{m}x{n}x{k}x{bs}",
f"{sparsity:.0%}",
f"{t_mlx:.3f}",
f"{t_naive:.3f}",
speedup,
]
if not args.no_check:
row.append(err_str)
rows.append(row)
print_table(headers, rows)
if not args.no_check:
print("err: max|block_masked_mm - naive_expand_matmul|")
if __name__ == "__main__":
main()
+29 -5
View File
@@ -1,5 +1,6 @@
import math
import os
import platform
import subprocess
import time
from copy import copy
@@ -17,9 +18,6 @@ RESULTS_DIR = "./results"
if not os.path.isdir(RESULTS_DIR):
os.mkdir(RESULTS_DIR)
DEVICE_NAME = subprocess.check_output(["sysctl", "-n", "machdep.cpu.brand_string"])
DEVICE_NAME = DEVICE_NAME.decode("utf-8").strip("\n")
TORCH_DEVICE = torch.device(
"mps"
if torch.backends.mps.is_available()
@@ -27,11 +25,36 @@ TORCH_DEVICE = torch.device(
)
def get_device_name():
if TORCH_DEVICE.type == "cuda":
try:
out = subprocess.check_output(
["nvidia-smi", "--query-gpu=name", "--format=csv,noheader"],
stderr=subprocess.DEVNULL,
)
return out.decode("utf-8").splitlines()[0].strip()
except Exception:
return "CUDA_GPU"
if TORCH_DEVICE.type == "mps":
try:
out = subprocess.check_output(
["sysctl", "-n", "machdep.cpu.brand_string"],
stderr=subprocess.DEVNULL,
)
return out.decode("utf-8").strip()
except Exception:
return "Apple_Silicon"
return platform.processor() or platform.machine() or "CPU"
DEVICE_NAME = get_device_name()
N_WARMUP = 5
N_ITER_BENCH = 50
N_ITER_FUNC = 20
VECTOR_LENGTHS = [4096 * (2**i) for i in range(10)]
VECTOR_LENGTHS = [4096 * (2**i) for i in range(12)]
MASK_DENSITIES = [0.01, 0.1, 0.25, 0.5]
D_TYPES = ("float32", "float16")
@@ -202,9 +225,10 @@ def main():
)
output_path = os.path.join(
RESULTS_DIR,
f"{DEVICE_NAME.replace(' ', '_')}_masked_scatter_{dtype}.pdf",
f"{DEVICE_NAME.replace(' ', '_')}_masked_scatter_{dtype}.png",
)
fig.savefig(output_path)
print(f"Saved benchmark image: {output_path}")
plt.close(fig)
+6
View File
@@ -176,6 +176,8 @@ if __name__ == "__main__":
( 1, 1024, 1024, 64, 32, 8),
( 1, 2048, 2048, 64, 32, 8),
( 1, 4096, 4096, 64, 32, 8),
( 1, 4096, 5000, 64, 32, 8),
( 1, 2048, 32121, 64, 32, 8),
)
shapes_80 = (
@@ -183,6 +185,8 @@ if __name__ == "__main__":
( 1, 1024, 1024, 80, 32, 8),
( 1, 2048, 2048, 80, 32, 8),
( 1, 4096, 4096, 80, 32, 8),
( 1, 4096, 5000, 80, 32, 8),
( 1, 2048, 32121, 80, 32, 8),
)
shapes_128 = (
@@ -190,6 +194,8 @@ if __name__ == "__main__":
( 1, 1024, 1024, 128, 32, 8),
( 1, 2048, 2048, 128, 32, 8),
( 1, 4096, 4096, 128, 32, 8),
( 1, 4096, 5000, 128, 32, 8),
( 1, 2048, 32121, 128, 32, 8),
)
# fmt: on
+109
View File
@@ -0,0 +1,109 @@
# Copyright © 2023-2024 Apple Inc.
import argparse
import mlx.core as mx
import torch
from time_utils import measure_runtime
def benchmark_slice_update_mlx(dst_shape, slice_shape, slice_range, dtype, iters=10):
def slice_update(arguments):
for i in range(iters):
arguments["dst"] = (
arguments["dst"].at[slice_range].add(arguments["updates"])
)
mx.eval(arguments)
dtype = getattr(mx, dtype)
arguments = {
"dst": mx.random.normal(dst_shape).astype(dtype),
"updates": mx.random.normal(slice_shape).astype(dtype),
}
runtime = measure_runtime(slice_update, arguments=arguments)
bytes_processed = (
arguments["dst"][slice_range].nbytes * 2 + arguments["updates"].nbytes
) * iters
bandwidth_gb_s = bytes_processed / runtime / 1e6
return runtime, bandwidth_gb_s
def benchmark_slice_update_torch(
dst_shape, slice_shape, slice_range, device, dtype, iters=10
):
def slice_update(dst, updates, slice_range):
for i in range(iters):
dst[slice_range] = dst[slice_range] + updates
if device == torch.device("mps"):
torch.mps.synchronize()
dtype = getattr(torch, dtype)
updates = torch.randn(slice_shape, dtype=dtype).to(device)
dst = torch.randn(dst_shape, dtype=dtype).to(device)
runtime = measure_runtime(
slice_update, dst=dst, updates=updates, slice_range=slice_range
)
bytes_processed = (dst[slice_range].nbytes * 2 + updates.nbytes) * iters
bandwidth_gb_s = bytes_processed / runtime / 1e6
return runtime, bandwidth_gb_s
if __name__ == "__main__":
parser = argparse.ArgumentParser("Slice update benchmarks.")
parser.add_argument("--cpu", action="store_true", help="Use the CPU.")
args = parser.parse_args()
if args.cpu:
mx.set_default_device(mx.cpu)
device = torch.device("cpu")
elif torch.mps.is_available():
device = torch.device("mps")
elif torch.cuda.is_available():
device = torch.device("cuda")
else:
raise ValueError()
dtypes = ["float32", "bfloat16"]
test_cases = [
((10_000_000,), slice(0, 1_000_000), (1_000_000,)),
((100_000,), slice(10_000, 20_000), (10_000,)),
((1000, 64), slice(100, 200), (100, 64)),
((100, 100, 64), slice(20, 40), (20, 100, 64)),
(
(2048, 2048, 128),
(slice(500, 1500), slice(200, 1200), slice(32, 96)),
(1000, 1000, 64),
),
(
(2048, 2048, 128),
(slice(1800, 1850), slice(100, 200), slice(64, 128)),
(50, 100, 64),
),
(
(2048, 2048, 128),
(slice(1000, 1010), slice(1000, 1010), slice(64, 128)),
(10, 10, 64),
),
]
print(
f"{'Dtype':<12} {'Dst Shape':<25} {'Update Shape':<20} "
f"{'MLX (ms)':<12} {'MLX GB/s':<12} {'Torch (ms)':<12} {'Torch GB/s':<12}"
)
print("-" * 110)
for dtype in dtypes:
for dst_shape, slice_range, update_shape in test_cases:
mlx_time, mlx_bw = benchmark_slice_update_mlx(
dst_shape, update_shape, slice_range, dtype
)
torch_time, torch_bw = benchmark_slice_update_torch(
dst_shape, update_shape, slice_range, device, dtype
)
print(
f"{dtype:<12} {str(dst_shape):<25} {str(update_shape):<20} "
f"{mlx_time:<12.3f} {mlx_bw:<12.2f} {torch_time:<12.3f} {torch_bw:<12.2f}"
)
Binary file not shown.
Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

+36
View File
@@ -0,0 +1,36 @@
<?xml version="1.0" encoding="UTF-8"?>
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="433.19" height="139.72" viewBox="0 0 433.19 139.72">
<defs>
<g>
<g id="glyph-0-0">
<path d="M 9.6875 -171.1875 L 188.609375 -171.1875 L 188.609375 -188.8125 L 9.6875 -188.8125 Z M 9.6875 -127.421875 L 188.609375 -127.421875 L 188.609375 -145.046875 L 9.6875 -145.046875 Z M 9.6875 -83.5625 L 188.609375 -83.5625 L 188.609375 -101.1875 L 9.6875 -101.1875 Z M 9.6875 -39.796875 L 188.609375 -39.796875 L 188.609375 -57.421875 L 9.6875 -57.421875 Z M 9.6875 4.0625 L 188.609375 4.0625 L 188.609375 -13.5625 L 9.6875 -13.5625 Z M 9.6875 47.828125 L 188.609375 47.828125 L 188.609375 30.203125 L 9.6875 30.203125 Z M 9.6875 47.828125 "/>
</g>
<g id="glyph-0-1">
<path d="M 13.9375 0 L 42.3125 0 L 42.3125 -91.796875 L 43.671875 -91.796875 L 78.71875 0 L 97.984375 0 L 133.03125 -91.796875 L 134.390625 -91.796875 L 134.390625 0 L 162.765625 0 L 162.765625 -139.71875 L 125.96875 -139.71875 L 88.984375 -42.015625 L 87.8125 -42.015625 L 50.734375 -139.71875 L 13.9375 -139.71875 Z M 13.9375 0 "/>
</g>
<g id="glyph-0-2">
<path d="M 13.9375 0 L 106.21875 0 L 106.21875 -26.046875 L 45.984375 -26.046875 L 45.984375 -139.71875 L 13.9375 -139.71875 Z M 13.9375 0 "/>
</g>
<g id="glyph-0-3">
<path d="M 6.296875 0 L 40.5625 0 L 69.515625 -47.34375 L 70.484375 -47.34375 L 99.625 0 L 135.84375 0 L 91.109375 -69.8125 L 91.109375 -70.296875 L 136.328125 -139.71875 L 100.703125 -139.71875 L 73 -90.71875 L 71.84375 -90.71875 L 43.953125 -139.71875 L 6.484375 -139.71875 L 49.96875 -70.6875 L 49.96875 -70.296875 Z M 6.296875 0 "/>
</g>
</g>
<clipPath id="clip-0">
<path clip-rule="nonzero" d="M 13 0 L 283 0 L 283 139.71875 L 13 139.71875 Z M 13 0 "/>
</clipPath>
<clipPath id="clip-1">
<path clip-rule="nonzero" d="M 296 0 L 427 0 L 427 139.71875 L 296 139.71875 Z M 296 0 "/>
</clipPath>
</defs>
<g clip-path="url(#clip-0)">
<g fill="rgb(0%, 0%, 0%)" fill-opacity="1">
<use xlink:href="#glyph-0-1" x="0" y="139.72"/>
<use xlink:href="#glyph-0-2" x="176.682092" y="139.72"/>
</g>
</g>
<g clip-path="url(#clip-1)">
<g fill="rgb(82.998657%, 82.998657%, 82.998657%)" fill-opacity="1">
<use xlink:href="#glyph-0-3" x="290.57" y="139.72"/>
</g>
</g>
</svg>

After

Width:  |  Height:  |  Size: 2.2 KiB

Binary file not shown.
Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

+36
View File
@@ -0,0 +1,36 @@
<?xml version="1.0" encoding="UTF-8"?>
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="433.19" height="139.72" viewBox="0 0 433.19 139.72">
<defs>
<g>
<g id="glyph-0-0">
<path d="M 9.6875 -171.1875 L 188.609375 -171.1875 L 188.609375 -188.8125 L 9.6875 -188.8125 Z M 9.6875 -127.421875 L 188.609375 -127.421875 L 188.609375 -145.046875 L 9.6875 -145.046875 Z M 9.6875 -83.5625 L 188.609375 -83.5625 L 188.609375 -101.1875 L 9.6875 -101.1875 Z M 9.6875 -39.796875 L 188.609375 -39.796875 L 188.609375 -57.421875 L 9.6875 -57.421875 Z M 9.6875 4.0625 L 188.609375 4.0625 L 188.609375 -13.5625 L 9.6875 -13.5625 Z M 9.6875 47.828125 L 188.609375 47.828125 L 188.609375 30.203125 L 9.6875 30.203125 Z M 9.6875 47.828125 "/>
</g>
<g id="glyph-0-1">
<path d="M 13.9375 0 L 42.3125 0 L 42.3125 -91.796875 L 43.671875 -91.796875 L 78.71875 0 L 97.984375 0 L 133.03125 -91.796875 L 134.390625 -91.796875 L 134.390625 0 L 162.765625 0 L 162.765625 -139.71875 L 125.96875 -139.71875 L 88.984375 -42.015625 L 87.8125 -42.015625 L 50.734375 -139.71875 L 13.9375 -139.71875 Z M 13.9375 0 "/>
</g>
<g id="glyph-0-2">
<path d="M 13.9375 0 L 106.21875 0 L 106.21875 -26.046875 L 45.984375 -26.046875 L 45.984375 -139.71875 L 13.9375 -139.71875 Z M 13.9375 0 "/>
</g>
<g id="glyph-0-3">
<path d="M 6.296875 0 L 40.5625 0 L 69.515625 -47.34375 L 70.484375 -47.34375 L 99.625 0 L 135.84375 0 L 91.109375 -69.8125 L 91.109375 -70.296875 L 136.328125 -139.71875 L 100.703125 -139.71875 L 73 -90.71875 L 71.84375 -90.71875 L 43.953125 -139.71875 L 6.484375 -139.71875 L 49.96875 -70.6875 L 49.96875 -70.296875 Z M 6.296875 0 "/>
</g>
</g>
<clipPath id="clip-0">
<path clip-rule="nonzero" d="M 13 0 L 283 0 L 283 139.71875 L 13 139.71875 Z M 13 0 "/>
</clipPath>
<clipPath id="clip-1">
<path clip-rule="nonzero" d="M 296 0 L 427 0 L 427 139.71875 L 296 139.71875 Z M 296 0 "/>
</clipPath>
</defs>
<g clip-path="url(#clip-0)">
<g fill="rgb(100%, 100%, 100%)" fill-opacity="1">
<use xlink:href="#glyph-0-1" x="0" y="139.72"/>
<use xlink:href="#glyph-0-2" x="176.682092" y="139.72"/>
</g>
</g>
<g clip-path="url(#clip-1)">
<g fill="rgb(56.999207%, 56.999207%, 56.999207%)" fill-opacity="1">
<use xlink:href="#glyph-0-3" x="290.57" y="139.72"/>
</g>
</g>
</svg>

After

Width:  |  Height:  |  Size: 2.2 KiB

+2 -2
View File
@@ -404,7 +404,7 @@ below.
auto kernel = d.get_kernel(kname, lib);
// Prepare to encode kernel
auto& compute_encoder = d.get_command_encoder(s.index);
auto& compute_encoder = mx::metal::get_command_encoder(s);
compute_encoder.set_compute_pipeline_state(kernel);
// Kernel parameters are registered with buffer indices corresponding to
@@ -448,7 +448,7 @@ We can now call the :meth:`axpby` operation on both the CPU and the GPU!
A few things to note about MLX and Metal before moving on. MLX keeps track of
the active ``command_buffer`` and the ``MTLCommandBuffer`` to which it is
associated. We rely on :meth:`d.get_command_encoder` to give us the active
associated. We rely on :meth:`metal::get_command_encoder` to give us the active
metal compute command encoder instead of building a new one and calling
:meth:`compute_encoder->end_encoding` at the end. MLX adds kernels (compute
pipelines) to the active command buffer until some specified limit is hit or
+2 -1
View File
@@ -32,7 +32,7 @@ are the CPU and GPU.
install
.. toctree::
:caption: Usage
:caption: Usage
:maxdepth: 1
usage/quick_start
@@ -78,6 +78,7 @@ are the CPU and GPU.
python/optimizers
python/distributed
python/tree_utils
python/printoptions
.. toctree::
:caption: C++ API Reference
+1 -1
View File
@@ -15,7 +15,7 @@ silicon computer is
To install from PyPI your system must meet the following requirements:
- Using an M series chip (Apple silicon)
- Using `Apple silicon <https://support.apple.com/en-us/116943>`_
- Using a native Python >= 3.10
- macOS >= 14.0
+2
View File
@@ -14,8 +14,10 @@ Devices and Streams
set_default_device
default_stream
new_stream
new_thread_local_stream
set_default_stream
stream
synchronize
clear_streams
device_count
device_info
+2
View File
@@ -20,5 +20,7 @@ FFT
irfft2
rfftn
irfftn
fftfreq
rfftfreq
fftshift
ifftshift
+2
View File
@@ -14,6 +14,7 @@ Linear Algebra
cholesky
cholesky_inv
cross
det
qr
svd
eigvals
@@ -23,5 +24,6 @@ Linear Algebra
lu
lu_factor
pinv
slogdet
solve
solve_triangular
+12
View File
@@ -0,0 +1,12 @@
Print Options
===============
.. currentmodule:: mlx.core
.. autosummary::
:toctree: _autosummary
PrintOptions
set_printoptions
printoptions
get_printoptions
+1 -4
View File
@@ -90,10 +90,7 @@ PyTorch supports the buffer protocol, but it requires an explicit
a = mx.arange(3)
b = torch.tensor(memoryview(a))
c = mx.array(b.numpy())
Conversion from PyTorch tensors back to arrays must be done via intermediate
NumPy arrays with ``numpy()``.
c = mx.array(b)
JAX
---
+1 -1
View File
@@ -192,7 +192,7 @@ void Axpby::eval_gpu(
auto kernel = d.get_kernel(kname, lib);
// Prepare to encode kernel
auto& compute_encoder = d.get_command_encoder(s.index);
auto& compute_encoder = mx::metal::get_command_encoder(s);
compute_encoder.set_compute_pipeline_state(kernel);
// Kernel parameters are registered with buffer indices corresponding to
+1 -1
View File
@@ -3,6 +3,6 @@ requires = [
"setuptools>=42",
"cmake>=3.25",
"mlx>=0.18.0",
"nanobind==2.10.2",
"nanobind==2.12.0",
]
build-backend = "setuptools.build_meta"
+2 -2
View File
@@ -1,4 +1,4 @@
setuptools>=42
cmake>=3.25
mlx>=0.21.0
nanobind==2.10.2
mlx>=0.31.2
nanobind==2.12.0
+1
View File
@@ -14,6 +14,7 @@ target_sources(
${CMAKE_CURRENT_SOURCE_DIR}/primitives.cpp
${CMAKE_CURRENT_SOURCE_DIR}/random.cpp
${CMAKE_CURRENT_SOURCE_DIR}/scheduler.cpp
${CMAKE_CURRENT_SOURCE_DIR}/stream.cpp
${CMAKE_CURRENT_SOURCE_DIR}/transforms.cpp
${CMAKE_CURRENT_SOURCE_DIR}/utils.cpp
${CMAKE_CURRENT_SOURCE_DIR}/linalg.cpp
+33
View File
@@ -116,6 +116,39 @@ struct ContiguousIterator {
loc += strides_[i];
}
void step(int64_t s) {
int dims = shape_.size();
if (dims == 0) {
return;
}
int i = dims - 1;
while (s > 0) {
if (shape_[i] - pos_[i] > 1) {
int steps = static_cast<int>(
std::min(static_cast<int64_t>(shape_[i] - pos_[i] - 1), s));
pos_[i] += steps;
loc += strides_[i] * steps;
s -= steps;
} else {
while (pos_[i] == (shape_[i] - 1) && i > 0) {
pos_[i] = 0;
loc -= (shape_[i] - 1) * strides_[i];
i--;
}
pos_[i]++;
loc += strides_[i];
s--;
}
}
}
int64_t contiguous_suffix() {
if (shape_.size() == 0) {
return 0;
}
return (strides_.back() == 1) ? shape_.back() : 0;
}
void seek(int64_t n) {
loc = 0;
for (int i = shape_.size() - 1; i >= 0; --i) {
+130 -3
View File
@@ -4,11 +4,14 @@
#include <cmath>
#include "mlx/allocator.h"
#include "mlx/primitives.h"
#include "mlx/backend/common/utils.h"
#include "mlx/backend/cpu/binary.h"
#include "mlx/backend/cpu/binary_ops.h"
#include "mlx/backend/cpu/copy.h"
#include "mlx/backend/cpu/encoder.h"
#include "mlx/backend/cpu/slicing.h"
#include "mlx/dtype_utils.h"
#include "mlx/primitives.h"
namespace mlx::core {
@@ -788,7 +791,7 @@ void MaskedScatter::eval_cpu(const std::vector<array>& inputs, array& out) {
auto& mask = inputs[1];
auto& src = inputs[2];
// Copy src into out (copy allocates memory for out)
// Copy dst into out (copy allocates memory for out)
auto ctype =
dst.flags().row_contiguous ? CopyType::Vector : CopyType::General;
copy_cpu(dst, out, ctype, stream());
@@ -851,4 +854,128 @@ void MaskedScatter::eval_cpu(const std::vector<array>& inputs, array& out) {
});
}
template <typename T, typename Op>
void slice_update_impl(
array& out,
const array& upd,
int64_t data_offset,
const Strides& out_strides) {
ContiguousIterator out_it(upd.shape(), out_strides, upd.ndim());
ContiguousIterator upd_it(upd);
Op op;
constexpr int SIMD_START = 32;
T* out_ptr = out.data<T>() + data_offset;
const T* upd_ptr = upd.data<T>();
int64_t size = upd.size();
int64_t suffix = out_it.contiguous_suffix();
if (upd.data_size() == 1) {
if (suffix >= SIMD_START) {
for (int64_t i = 0; i < size; i += suffix) {
VectorScalar<Op>{}(
out_ptr + out_it.loc, upd_ptr, out_ptr + out_it.loc, suffix);
out_it.step(suffix);
}
} else {
T update = upd_ptr[0];
for (int64_t i = 0; i < size; i++) {
out_ptr[out_it.loc] = op(out_ptr[out_it.loc], update);
out_it.step();
}
}
} else if (suffix == upd_it.contiguous_suffix() && suffix >= SIMD_START) {
for (int64_t i = 0; i < size; i += suffix) {
VectorVector<Op>{}(
out_ptr + out_it.loc,
upd_ptr + upd_it.loc,
out_ptr + out_it.loc,
suffix);
out_it.step(suffix);
upd_it.step(suffix);
}
} else {
for (int64_t i = 0; i < size; i++) {
out_ptr[out_it.loc] = op(out_ptr[out_it.loc], upd_ptr[upd_it.loc]);
out_it.step();
upd_it.step();
}
}
}
void SliceUpdate::eval_cpu(const std::vector<array>& inputs, array& out) {
assert(inputs.size() == 2);
if (out.size() == 0) {
out.set_data(allocator::malloc(0));
return;
}
auto& in = inputs[0];
auto& upd = inputs[1];
if (upd.size() == 0) {
out.copy_shared_buffer(in);
return;
}
// Check if materialization is needed
auto ctype = in.flags().contiguous && in.size() == in.data_size()
? CopyType::Vector
: CopyType::General;
copy_cpu(in, out, in.data_size() == 1 ? CopyType::Scalar : ctype, stream());
// Calculate out strides, initial offset and if copy needs to be made
auto [data_offset, out_strides] =
prepare_slice(out, start_indices_, strides_);
// Do copy
if (reduce_type_ == SliceUpdate::None) {
copy_cpu_inplace(
/* const array& src = */ upd,
/* array& dst = */ out,
/* const std::vector<int>& data_shape = */ upd.shape(),
/* const std::vector<stride_t>& i_strides = */ upd.strides(),
/* const std::vector<stride_t>& o_strides = */ out_strides,
/* int64_t i_offset = */ 0,
/* int64_t o_offset = */ data_offset,
/* CopyType ctype = */ CopyType::GeneralGeneral,
stream());
return;
}
auto& encoder = cpu::get_command_encoder(stream());
encoder.set_input_array(upd);
encoder.set_output_array(out);
encoder.dispatch([upd = array::unsafe_weak_copy(upd),
out = array::unsafe_weak_copy(out),
data_offset = data_offset,
out_strides = std::move(out_strides),
reduce_type = reduce_type_]() mutable {
dispatch_all_types(out.dtype(), [&](auto type_tag) {
using T = MLX_GET_TYPE(type_tag);
switch (reduce_type) {
case SliceUpdate::Sum:
slice_update_impl<T, detail::Add>(out, upd, data_offset, out_strides);
break;
case SliceUpdate::Prod:
slice_update_impl<T, detail::Multiply>(
out, upd, data_offset, out_strides);
break;
case SliceUpdate::Max:
slice_update_impl<T, detail::Maximum>(
out, upd, data_offset, out_strides);
break;
case SliceUpdate::Min:
slice_update_impl<T, detail::Minimum>(
out, upd, data_offset, out_strides);
break;
case SliceUpdate::None:
// Should never be here
break;
}
});
});
}
} // namespace mlx::core
+2 -3
View File
@@ -67,11 +67,10 @@ void luf_impl(
/* ipiv */ reinterpret_cast<int*>(pivots_ptr),
/* info */ &info);
if (info != 0) {
if (info < 0) {
std::stringstream ss;
ss << "[LUF::eval_cpu] sgetrf_ failed with code " << info
<< ((info > 0) ? " because matrix is singular"
: " because argument had an illegal value");
<< " because argument had an illegal value";
throw std::runtime_error(ss.str());
}
-38
View File
@@ -398,44 +398,6 @@ void DynamicSliceUpdate::eval_cpu(
}
}
void SliceUpdate::eval_cpu(const std::vector<array>& inputs, array& out) {
assert(inputs.size() == 2);
if (out.size() == 0) {
out.set_data(allocator::malloc(0));
return;
}
auto& in = inputs[0];
auto& upd = inputs[1];
if (upd.size() == 0) {
out.copy_shared_buffer(in);
return;
}
// Check if materialization is needed
auto ctype = in.flags().contiguous && in.size() == in.data_size()
? CopyType::Vector
: CopyType::General;
copy_cpu(in, out, in.data_size() == 1 ? CopyType::Scalar : ctype, stream());
// Calculate out strides, initial offset and if copy needs to be made
auto [data_offset, out_strides] =
prepare_slice(out, start_indices_, strides_);
// Do copy
copy_cpu_inplace(
/* const array& src = */ upd,
/* array& dst = */ out,
/* const std::vector<int>& data_shape = */ upd.shape(),
/* const std::vector<stride_t>& i_strides = */ upd.strides(),
/* const std::vector<stride_t>& o_strides = */ out_strides,
/* int64_t i_offset = */ 0,
/* int64_t o_offset = */ data_offset,
/* CopyType ctype = */ CopyType::GeneralGeneral,
stream());
}
void View::eval_cpu(const std::vector<array>& inputs, array& out) {
assert(inputs.size() == 1);
auto& in = inputs[0];
+9 -5
View File
@@ -15,10 +15,14 @@ namespace mlx::core {
namespace {
template <typename T>
inline constexpr bool is_floating_v = std::is_floating_point_v<T> ||
std::is_same_v<T, float16_t> || std::is_same_v<T, bfloat16_t>;
// NaN-aware comparator that places NaNs at the end
template <typename T>
bool nan_aware_less(T a, T b) {
if constexpr (std::is_floating_point_v<T> || std::is_same_v<T, complex64_t>) {
if constexpr (is_floating_v<T> || std::is_same_v<T, complex64_t>) {
if (std::isnan(a))
return false;
if (std::isnan(b))
@@ -103,11 +107,11 @@ struct StridedIterator {
return *this;
}
StridedIterator operator+(difference_type diff) {
StridedIterator operator+(difference_type diff) const {
return StridedIterator(ptr_, stride_, diff);
}
StridedIterator operator-(difference_type diff) {
StridedIterator operator-(difference_type diff) const {
return StridedIterator(ptr_, stride_, -diff);
}
@@ -198,7 +202,7 @@ void argsort(const array& in, array& out, int axis) {
auto v2 = data_ptr[b * in_stride];
// Handle NaNs (place them at the end)
if (std::is_floating_point<T>::value) {
if constexpr (is_floating_v<T>) {
if (std::isnan(v1))
return false;
if (std::isnan(v2))
@@ -299,7 +303,7 @@ void argpartition(const array& in, array& out, int axis, int kth) {
auto v2 = data_ptr[b * in_stride];
// Handle NaNs (place them at the end)
if (std::is_floating_point<T>::value) {
if constexpr (is_floating_v<T>) {
if (std::isnan(v1))
return false;
if (std::isnan(v2))
+14 -5
View File
@@ -26,9 +26,12 @@ target_sources(
${CMAKE_CURRENT_SOURCE_DIR}/distributed.cu
${CMAKE_CURRENT_SOURCE_DIR}/eval.cpp
${CMAKE_CURRENT_SOURCE_DIR}/event.cu
${CMAKE_CURRENT_SOURCE_DIR}/fft.cu
${CMAKE_CURRENT_SOURCE_DIR}/fence.cpp
${CMAKE_CURRENT_SOURCE_DIR}/gemms/block_mask.cu
${CMAKE_CURRENT_SOURCE_DIR}/gemms/gemv.cu
${CMAKE_CURRENT_SOURCE_DIR}/gemms/cublas_gemm.cpp
${CMAKE_CURRENT_SOURCE_DIR}/gemms/gather_gemm.cu
${CMAKE_CURRENT_SOURCE_DIR}/gemms/grouped_gemm_unaligned.cu
${CMAKE_CURRENT_SOURCE_DIR}/hadamard.cu
${CMAKE_CURRENT_SOURCE_DIR}/jit_module.cpp
@@ -117,8 +120,12 @@ target_compile_options(mlx
target_compile_options(
mlx PRIVATE "$<$<COMPILE_LANGUAGE:CUDA>:--expt-relaxed-constexpr>")
# Required for generating optimized CUTLASS code.
# Ignore warnings from CUTLASS.
target_compile_options(
mlx PRIVATE $<$<COMPILE_LANGUAGE:CUDA>:-Xcudafe="--diag_suppress=2908,2361">)
if(NOT MSVC)
# Required for generating optimized CUTLASS code.
target_compile_options(
mlx PRIVATE "$<$<COMPILE_LANGUAGE:CUDA>:-Xcompiler=-fno-strict-aliasing>")
endif()
@@ -161,9 +168,8 @@ set_target_properties(mlx PROPERTIES CUDA_ARCHITECTURES
"${MLX_CUDA_ARCHITECTURES}")
# Skip Hopper-only kernels when not building for sm90a.
if(NOT DEFINED ENV{MLX_DISABLE_SM90A_KERNELS}
AND (("90a" IN_LIST MLX_CUDA_ARCHITECTURES) OR ("90a-real" IN_LIST
MLX_CUDA_ARCHITECTURES)))
if(("90a" IN_LIST MLX_CUDA_ARCHITECTURES) OR ("90a-real" IN_LIST
MLX_CUDA_ARCHITECTURES))
target_compile_definitions(mlx PRIVATE MLX_CUDA_SM90A_ENABLED)
endif()
@@ -247,6 +253,9 @@ target_include_directories(mlx PRIVATE ${CUDAToolkit_INCLUDE_DIRS})
# Use cublasLt.
target_link_libraries(mlx PRIVATE CUDA::cublasLt)
# Use cuFFT.
target_link_libraries(mlx PRIVATE CUDA::cufft)
# Use NVRTC and driver APIs.
target_link_libraries(mlx PRIVATE CUDA::nvrtc CUDA::cuda_driver)
@@ -270,7 +279,7 @@ target_link_libraries(mlx PRIVATE CUDNN::cudnn_all)
FetchContent_Declare(
cutlass
GIT_REPOSITORY https://github.com/NVIDIA/cutlass.git
GIT_TAG v4.3.5
GIT_TAG v4.4.2
GIT_SHALLOW TRUE
SOURCE_SUBDIR include EXCLUDE_FROM_ALL)
FetchContent_MakeAvailable(cutlass)
+28 -5
View File
@@ -16,8 +16,14 @@ namespace cu {
namespace cg = cooperative_groups;
constexpr int BINARY_MAX_BLOCK_DIM = 1024;
template <typename Op, typename In, typename Out, typename IdxT, int N_READS>
__global__ void binary_ss(const In* a, const In* b, Out* out, IdxT size) {
__global__ __launch_bounds__(BINARY_MAX_BLOCK_DIM) void binary_ss(
const In* a,
const In* b,
Out* out,
IdxT size) {
IdxT index = cg::this_grid().thread_rank();
if ((index + 1) * N_READS > size) {
@@ -36,7 +42,11 @@ __global__ void binary_ss(const In* a, const In* b, Out* out, IdxT size) {
}
template <typename Op, typename In, typename Out, typename IdxT, int N_READS>
__global__ void binary_sv(const In* a, const In* b, Out* out, IdxT size) {
__global__ __launch_bounds__(BINARY_MAX_BLOCK_DIM) void binary_sv(
const In* a,
const In* b,
Out* out,
IdxT size) {
IdxT index = cg::this_grid().thread_rank();
if ((index + 1) * N_READS > size) {
@@ -57,7 +67,11 @@ __global__ void binary_sv(const In* a, const In* b, Out* out, IdxT size) {
}
template <typename Op, typename In, typename Out, typename IdxT, int N_READS>
__global__ void binary_vs(const In* a, const In* b, Out* out, IdxT size) {
__global__ __launch_bounds__(BINARY_MAX_BLOCK_DIM) void binary_vs(
const In* a,
const In* b,
Out* out,
IdxT size) {
IdxT index = cg::this_grid().thread_rank();
if ((index + 1) * N_READS > size) {
@@ -78,7 +92,11 @@ __global__ void binary_vs(const In* a, const In* b, Out* out, IdxT size) {
}
template <typename Op, typename In, typename Out, typename IdxT, int N_READS>
__global__ void binary_vv(const In* a, const In* b, Out* out, IdxT size) {
__global__ __launch_bounds__(BINARY_MAX_BLOCK_DIM) void binary_vv(
const In* a,
const In* b,
Out* out,
IdxT size) {
IdxT index = cg::this_grid().thread_rank();
if ((index + 1) * N_READS > size) {
@@ -331,7 +349,12 @@ void binary_op_gpu_inplace(
kernel = cu::binary_vv<Op, InType, OutType, IdxT, N_READS>;
}
auto [num_blocks, block_dims] = get_launch_args(
out.data_size(), out.shape(), out.strides(), large(), N_READS);
out.data_size(),
out.shape(),
out.strides(),
large(),
N_READS,
cu::BINARY_MAX_BLOCK_DIM);
encoder.add_kernel_node(
kernel,
num_blocks,
+22 -19
View File
@@ -39,7 +39,7 @@ struct ConvCacheKey {
};
auto& conv_cache() {
static LRUBytesKeyCache<
static thread_local LRUBytesKeyCache<
ConvCacheKey,
std::pair<ConvBackendType, std::optional<DnnGraph>>>
cache("MLX_CUDA_CONV_CACHE_SIZE", /* default_capacity */ 128);
@@ -103,7 +103,7 @@ std::optional<DnnGraph> build_conv_graph(
const std::vector<int64_t>& dilation) {
auto compute_dtype =
(dtype == float16 || dtype == bfloat16) ? float32 : dtype;
DnnGraph graph(encoder.device().get_cudnn_handle(), dtype, compute_dtype);
DnnGraph graph(get_cudnn_handle(encoder.device()), dtype, compute_dtype);
auto x_ = graph.tensor_nchw("X", 'x', x);
auto w_ = graph.tensor_nchw("W", 'w', w);
@@ -139,7 +139,7 @@ std::optional<DnnGraph> build_conv_graph(
if (dtype == float32 && !env::enable_tf32()) {
graph.deselect_numeric_notes({fe::NumericalNote_t::TENSOR_CORE});
}
CHECK_CUDNN_FE_ERROR(graph.build());
CHECK_CUDNN_ERROR(graph.build());
return graph;
}
@@ -252,6 +252,10 @@ void register_args(
} // namespace
void init_cudnn_conv_cache() {
conv_cache();
}
void Convolution::eval_gpu(const std::vector<array>& inputs, array& out_) {
nvtx3::scoped_range r("Convolution::eval_gpu");
if (out_.size() == 0) {
@@ -269,20 +273,19 @@ void Convolution::eval_gpu(const std::vector<array>& inputs, array& out_) {
// Search cache.
BytesKey<ConvCacheKey> cache_key;
cache_key.pod = {
encoder.device().cuda_device(),
dtype_to_cudnn_type(dtype),
vector_key(in.shape()),
vector_key(wt.shape()),
vector_key(kernel_strides_),
vector_key(padding_lo_),
vector_key(padding_hi_),
vector_key(kernel_dilation_),
groups_,
flip_,
get_alignment(in),
get_alignment(wt),
get_alignment(out)};
cache_key.pod.device_id = encoder.device().cuda_device();
cache_key.pod.cudnn_dtype = dtype_to_cudnn_type(dtype);
cache_key.pod.input_shape = vector_key(in.shape());
cache_key.pod.weight_shape = vector_key(wt.shape());
cache_key.pod.stride = vector_key(kernel_strides_);
cache_key.pod.padding_lo = vector_key(padding_lo_);
cache_key.pod.padding_hi = vector_key(padding_hi_);
cache_key.pod.dilation = vector_key(kernel_dilation_);
cache_key.pod.groups = groups_;
cache_key.pod.flip = flip_;
cache_key.pod.input_alignment = get_alignment(in);
cache_key.pod.weight_alignment = get_alignment(wt);
cache_key.pod.output_alignment = get_alignment(out);
if (auto it = conv_cache().find(cache_key); it != conv_cache().end()) {
auto& [backend_type, graph] = it->second;
if (graph) {
@@ -290,7 +293,7 @@ void Convolution::eval_gpu(const std::vector<array>& inputs, array& out_) {
std::tie(in, wt, out) =
prepare_args(encoder, backend_type, in, wt, out, groups_, s);
register_args(encoder, backend_type, in, wt, out, out_);
CHECK_CUDNN_FE_ERROR(graph->encode_capturing(
CHECK_CUDNN_ERROR(graph->encode_capturing(
encoder,
{
{'x', gpu_ptr<void>(in)},
@@ -372,7 +375,7 @@ void Convolution::eval_gpu(const std::vector<array>& inputs, array& out_) {
if (graph) {
register_args(encoder, backend_type, in, wt, out, out_);
CHECK_CUDNN_FE_ERROR(graph->encode_capturing(
CHECK_CUDNN_ERROR(graph->encode_capturing(
encoder,
{
{'x', gpu_ptr<void>(in)},
+56 -35
View File
@@ -2,44 +2,13 @@
#include "mlx/backend/cuda/cublas_utils.h"
#include "mlx/backend/cuda/cuda.h"
#include "mlx/backend/gpu/device_info.h"
#include "mlx/utils.h"
namespace mlx::core {
namespace cublas_utils {
namespace {
struct CublasPreference {
CublasPreference(cu::Device& device) {
// The recommended cublas workspace size is 4 MiB for pre-Hopper and 32 MiB
// for Hopper+:
// https://docs.nvidia.com/cuda/cublas/#cublassetworkspace
uint64_t MiB = 1024 * 1024;
uint64_t workspace_size =
device.compute_capability_major() >= 9 ? 32 * MiB : 4 * MiB;
CHECK_CUBLAS_ERROR(cublasLtMatmulPreferenceCreate(&pref_));
CHECK_CUBLAS_ERROR(cublasLtMatmulPreferenceSetAttribute(
pref_,
CUBLASLT_MATMUL_PREF_MAX_WORKSPACE_BYTES,
&workspace_size,
sizeof(uint64_t)));
}
~CublasPreference() {
CHECK_CUBLAS_ERROR(cublasLtMatmulPreferenceDestroy(pref_));
}
cublasLtMatmulPreference_t pref_{nullptr};
};
} // namespace
cublasLtMatmulPreference_t get_preference(cu::Device& device) {
static CublasPreference pref(device);
return pref.pref_;
}
cublasLtMatrixLayout_t create_matrix_layout(
cudaDataType_t type,
uint64_t rows,
@@ -70,6 +39,59 @@ cublasLtMatrixLayout_t create_matrix_layout(
} // namespace cublas_utils
namespace {
auto& cublas_handles_cache() {
struct CublasHandles {
~CublasHandles() {
if (handle) {
CHECK_CUBLAS_ERROR(cublasLtDestroy(handle));
CHECK_CUBLAS_ERROR(cublasLtMatmulPreferenceDestroy(pref));
}
}
cublasLtHandle_t handle{nullptr};
cublasLtMatmulPreference_t pref{nullptr};
};
static thread_local std::vector<CublasHandles> cache(gpu::device_count());
return cache;
}
auto get_cublas_handles(cu::Device& device) {
auto& storage = cublas_handles_cache().at(device.cuda_device());
if (!storage.handle) {
// Create cublasLt handle.
device.make_current();
CHECK_CUBLAS_ERROR(cublasLtCreate(&storage.handle));
// The recommended cublas workspace size is 4 MiB for pre-Hopper and 32
// MiB for Hopper+:
// https://docs.nvidia.com/cuda/cublas/#cublassetworkspace
uint64_t MiB = 1024 * 1024;
uint64_t workspace_size =
device.compute_capability_major() >= 9 ? 32 * MiB : 4 * MiB;
CHECK_CUBLAS_ERROR(cublasLtMatmulPreferenceCreate(&storage.pref));
CHECK_CUBLAS_ERROR(cublasLtMatmulPreferenceSetAttribute(
storage.pref,
CUBLASLT_MATMUL_PREF_MAX_WORKSPACE_BYTES,
&workspace_size,
sizeof(uint64_t)));
}
return std::make_tuple(storage.handle, storage.pref);
}
} // namespace
void check_cublas_error(const char* name, cublasStatus_t err) {
if (err != CUBLAS_STATUS_SUCCESS) {
// TODO: Use cublasGetStatusString when it is widely available.
throw std::runtime_error(
fmt::format("{} failed with code: {}.", name, static_cast<int>(err)));
}
}
void init_cublas_handles_cache() {
cublas_handles_cache();
}
CublasMatmulBase::~CublasMatmulBase() {
CHECK_CUBLAS_ERROR(cublasLtMatrixLayoutDestroy(a_desc_));
CHECK_CUBLAS_ERROR(cublasLtMatrixLayoutDestroy(b_desc_));
@@ -98,8 +120,7 @@ void CublasMatmulBase::init_base(
M_ = a_rows;
N_ = b_cols;
scale_type_ = scale_type;
handle_ = device.get_cublaslt_handle();
pref_ = cublas_utils::get_preference(device);
std::tie(handle_, pref_) = get_cublas_handles(device);
heuristic_.state = CUBLAS_STATUS_NOT_INITIALIZED;
CHECK_CUBLAS_ERROR(
+8 -4
View File
@@ -1,17 +1,15 @@
// Copyright © 2025 Apple Inc.
#pragma once
#include <cublasLt.h>
#include "mlx/array.h"
#include "mlx/backend/cuda/device.h"
#include "mlx/dtype_utils.h"
#include <cublasLt.h>
namespace mlx::core {
namespace cublas_utils {
// Get the shared cublas preference for a device
cublasLtMatmulPreference_t get_preference(cu::Device& device);
cublasLtMatrixLayout_t create_matrix_layout(
cudaDataType_t type,
uint64_t rows,
@@ -42,6 +40,12 @@ inline cudaDataType_t dtype_to_cublas_type(Dtype dtype, std::string_view tag) {
} // namespace cublas_utils
void check_cublas_error(const char* name, cublasStatus_t err);
#define CHECK_CUBLAS_ERROR(cmd) check_cublas_error(#cmd, (cmd))
void init_cublas_handles_cache();
class CublasMatmulBase {
public:
virtual ~CublasMatmulBase();
-6
View File
@@ -2,23 +2,17 @@
#pragma once
#include <cublasLt.h>
#include <cuda.h>
#include <cuda_runtime.h>
#include <cudnn.h>
namespace mlx::core {
// Throw exception if the cuda API does not succeed.
void check_cublas_error(const char* name, cublasStatus_t err);
void check_cuda_error(const char* name, cudaError_t err);
void check_cuda_error(const char* name, CUresult err);
void check_cudnn_error(const char* name, cudnnStatus_t err);
// The macro version that prints the command that failed.
#define CHECK_CUBLAS_ERROR(cmd) check_cublas_error(#cmd, (cmd))
#define CHECK_CUDA_ERROR(cmd) check_cuda_error(#cmd, (cmd))
#define CHECK_CUDNN_ERROR(cmd) check_cudnn_error(#cmd, (cmd))
// Base class for RAII managed CUDA resources.
template <typename Handle, cudaError_t (*Destroy)(Handle)>
+62 -5
View File
@@ -2,6 +2,7 @@
#include "mlx/backend/cuda/cudnn_utils.h"
#include "mlx/backend/cuda/device.h"
#include "mlx/backend/gpu/device_info.h"
namespace mlx::core {
@@ -47,8 +48,48 @@ inline auto nhwc_to_nchw(const array& x) {
return std::make_tuple(std::move(shape), std::move(strides));
}
auto& cudnn_handles_cache() {
struct CudnnHandle {
~CudnnHandle() {
if (handle) {
CHECK_CUDNN_ERROR(cudnnDestroy(handle));
}
}
cudnnHandle_t handle{nullptr};
};
static thread_local std::vector<CudnnHandle> cache(gpu::device_count());
return cache;
}
} // namespace
void check_cudnn_error(const char* name, cudnnStatus_t err) {
if (err != CUDNN_STATUS_SUCCESS) {
throw std::runtime_error(
fmt::format("{} failed: {}.", name, cudnnGetErrorString(err)));
}
}
void check_cudnn_error(const char* name, fe::error_t err) {
if (!err.is_good()) {
throw std::runtime_error(
fmt::format("{} failed: {}.", name, err.get_message()));
}
}
cudnnHandle_t get_cudnn_handle(cu::Device& device) {
auto& storage = cudnn_handles_cache().at(device.cuda_device());
if (!storage.handle) {
device.make_current();
CHECK_CUDNN_ERROR(cudnnCreate(&storage.handle));
}
return storage.handle;
}
void init_cudnn_handles_cache() {
cudnn_handles_cache();
}
fe::error_t DnnGraph::prepare() {
RETURN_IF_ERROR(validate());
try {
@@ -71,10 +112,26 @@ fe::error_t DnnGraph::encode_graph(
cu::CommandEncoder& encoder,
std::unordered_map<int64_t, void*> variant_pack) {
cudnnSetStream(handle_, encoder.stream());
CudaGraph cuda_graph(encoder.device());
RETURN_IF_ERROR(populate_cuda_graph(
handle_, variant_pack, prepare_workspace(encoder), cuda_graph));
encoder.add_graph_node(cuda_graph);
auto* workspace_ptr = prepare_workspace(encoder);
if (!cached_cuda_graph_) {
// First call: populate the CUDA graph from the cuDNN execution plan.
// Also compute and cache the subgraph key to avoid calling
// cudaGraphKernelNodeGetAttribute on every subsequent call (expensive
// on WDDM where each driver API call has ~40-400us overhead).
cached_cuda_graph_.emplace(encoder.device());
RETURN_IF_ERROR(populate_cuda_graph(
handle_, variant_pack, workspace_ptr, *cached_cuda_graph_));
std::tie(cached_subgraph_key_, cached_is_updatable_) =
cu::subgraph_to_key(*cached_cuda_graph_);
} else {
// Subsequent calls: patch data pointers without re-running kernel setup.
RETURN_IF_ERROR(update_cuda_graph(
handle_, variant_pack, workspace_ptr, *cached_cuda_graph_));
}
// Add the cuDNN child graph to the parent CUDA graph for batched launch.
// The pre-computed subgraph key avoids expensive per-node attribute queries.
encoder.add_graph_node(
*cached_cuda_graph_, cached_subgraph_key_, cached_is_updatable_);
return {};
}
@@ -93,7 +150,7 @@ fe::error_t DnnGraph::encode_capturing(
void* DnnGraph::prepare_workspace(cu::CommandEncoder& encoder) {
int64_t workspace_size = 0;
CHECK_CUDNN_FE_ERROR(get_workspace_size(workspace_size));
CHECK_CUDNN_ERROR(get_workspace_size(workspace_size));
return allocate_workspace(encoder, workspace_size);
}
+17 -8
View File
@@ -2,6 +2,10 @@
#pragma once
#include <cassert>
#include <optional>
#include "mlx/backend/cuda/cuda_utils.h"
#include "mlx/backend/cuda/device/config.h"
#include "mlx/backend/cuda/utils.h"
#include "mlx/dtype_utils.h"
@@ -17,14 +21,16 @@ class CommandEncoder;
namespace fe = cudnn_frontend;
#define CHECK_CUDNN_FE_ERROR(cmd) \
do { \
auto error = cmd; \
if (!error.is_good()) { \
throw std::runtime_error( \
fmt::format("{} failed: {}.", #cmd, error.get_message())); \
} \
} while (0)
void check_cudnn_error(const char* name, cudnnStatus_t err);
void check_cudnn_error(const char* name, fe::error_t err);
#define CHECK_CUDNN_ERROR(cmd) check_cudnn_error(#cmd, (cmd))
cudnnHandle_t get_cudnn_handle(cu::Device& device);
void init_cudnn_handles_cache();
void init_cudnn_conv_cache();
void init_cudnn_sdpa_cache();
// Return pointer alignment of |x|'s data.
inline uint8_t get_alignment(const array& x) {
@@ -182,6 +188,9 @@ class DnnGraph : public fe::graph::Graph {
const array& x);
cudnnHandle_t handle_;
std::optional<CudaGraph> cached_cuda_graph_;
std::string cached_subgraph_key_;
bool cached_is_updatable_{true};
};
} // namespace mlx::core
+46 -44
View File
@@ -1,7 +1,6 @@
// Copyright © 2025 Apple Inc.
#include "mlx/backend/cuda/device.h"
#include "mlx/backend/cuda/jit_module.h"
#include "mlx/backend/cuda/worker.h"
#include "mlx/backend/gpu/device_info.h"
#include "mlx/utils.h"
@@ -55,14 +54,7 @@ Device::Device(int device) : device_(device) {
&memory_pools_, cudaDevAttrMemoryPoolsSupported, device_));
}
Device::~Device() {
if (cudnn_handle_) {
CHECK_CUDNN_ERROR(cudnnDestroy(cudnn_handle_));
}
if (cublaslt_handle_) {
CHECK_CUBLAS_ERROR(cublasLtDestroy(cublaslt_handle_));
}
}
Device::~Device() = default;
void Device::make_current() {
// We need to set/get current CUDA device very frequently, cache it to reduce
@@ -76,30 +68,6 @@ void Device::make_current() {
}
}
CommandEncoder& Device::get_command_encoder(Stream s) {
auto it = encoders_.find(s.index);
if (it == encoders_.end()) {
it = encoders_.try_emplace(s.index, *this).first;
}
return it->second;
}
cublasLtHandle_t Device::get_cublaslt_handle() {
if (!cublaslt_handle_) {
make_current();
CHECK_CUBLAS_ERROR(cublasLtCreate(&cublaslt_handle_));
}
return cublaslt_handle_;
}
cudnnHandle_t Device::get_cudnn_handle() {
if (!cudnn_handle_) {
make_current();
CHECK_CUDNN_ERROR(cudnnCreate(&cudnn_handle_));
}
return cudnn_handle_;
}
CommandEncoder::CaptureContext::CaptureContext(CommandEncoder& enc) : enc(enc) {
enc.device().make_current();
if (!use_cuda_graphs()) {
@@ -238,13 +206,19 @@ CommandEncoder::CommandEncoder(Device& d)
: device_(d),
stream_(d),
graph_(d),
worker_(d),
worker_(std::make_shared<Worker>(d)),
graph_cache_("MLX_CUDA_GRAPH_CACHE_SIZE", /* default_capacity */ 400) {
std::tie(max_ops_per_graph_, max_mb_per_graph_) = get_graph_limits(d);
worker_->start();
}
CommandEncoder::~CommandEncoder() {
synchronize();
worker_->stop();
}
void CommandEncoder::add_completed_handler(std::function<void()> task) {
worker_.add_task(std::move(task));
worker_->add_task(std::move(task));
}
void CommandEncoder::set_input_array(const array& arr) {
@@ -463,6 +437,24 @@ void CommandEncoder::add_graph_node(cudaGraph_t child) {
insert_graph_dependencies(GraphNode{node, sub_graph_key});
}
void CommandEncoder::add_graph_node(
cudaGraph_t child,
const std::string& subgraph_key,
bool is_updatable) {
if (!use_cuda_graphs()) {
node_count_++;
CudaGraphExec graph_exec;
graph_exec.instantiate(child);
device_.make_current();
CHECK_CUDA_ERROR(cudaGraphLaunch(graph_exec, stream()));
return;
}
is_graph_updatable_ &= is_updatable;
cudaGraphNode_t node;
CHECK_CUDA_ERROR(cudaGraphAddChildGraphNode(&node, graph_, NULL, 0, child));
insert_graph_dependencies(GraphNode{node, subgraph_key});
}
bool CommandEncoder::needs_commit() {
return (node_count_ > max_ops_per_graph_) ||
((bytes_in_graph_ >> 20) > max_mb_per_graph_);
@@ -538,7 +530,7 @@ void CommandEncoder::commit() {
}
// Put completion handlers in a batch.
worker_.commit(stream_);
worker_->commit(stream_);
node_count_ = 0;
bytes_in_graph_ = 0;
}
@@ -553,18 +545,17 @@ void CommandEncoder::synchronize() {
}
Device& device(int cuda_device) {
static auto devices = []() {
std::vector<Device> devices;
// The devices are leak intentionally as user code may still be accessing
// device after main thread teardown.
static auto* devices = []() {
auto* devices = new std::vector<Device>;
int device_count = gpu::device_count();
for (int i = 0; i < device_count; ++i) {
devices.emplace_back(i);
devices->emplace_back(i);
}
// Initialize the jit module cache here ensures it is not unloaded before
// any evaluation is done.
get_jit_module_cache();
return devices;
}();
return devices.at(cuda_device);
return devices->at(cuda_device);
}
Device& device(mlx::core::Device d) {
@@ -572,7 +563,18 @@ Device& device(mlx::core::Device d) {
}
CommandEncoder& get_command_encoder(Stream s) {
return device(s.device).get_command_encoder(s);
auto& encoders = get_command_encoders();
auto it = encoders.find(s.index);
if (it == encoders.end()) {
throw std::runtime_error(
fmt::format("There is no Stream(gpu, {}) in current thread.", s.index));
}
return it->second;
}
std::unordered_map<int, CommandEncoder>& get_command_encoders() {
static thread_local std::unordered_map<int, CommandEncoder> encoders;
return encoders;
}
} // namespace mlx::core::cu
+18 -16
View File
@@ -5,17 +5,19 @@
#include "mlx/array.h"
#include "mlx/backend/cuda/allocator.h"
#include "mlx/backend/cuda/lru_cache.h"
#include "mlx/backend/cuda/worker.h"
#include "mlx/backend/cuda/utils.h"
#include "mlx/stream.h"
#include <cublasLt.h>
#include <cuda.h>
#include <cudnn.h>
#include <memory>
#include <unordered_map>
namespace mlx::core::cu {
// Compute a key and updatability flag for a CUDA graph by walking its nodes.
std::pair<std::string, bool> subgraph_to_key(cudaGraph_t graph);
class Worker;
class CommandEncoder {
public:
struct CaptureContext {
@@ -32,6 +34,7 @@ class CommandEncoder {
};
explicit CommandEncoder(Device& d);
~CommandEncoder();
CommandEncoder(const CommandEncoder&) = delete;
CommandEncoder& operator=(const CommandEncoder&) = delete;
@@ -92,6 +95,10 @@ class CommandEncoder {
void** params);
void add_graph_node(cudaGraph_t child);
void add_graph_node(
cudaGraph_t child,
const std::string& subgraph_key,
bool is_updatable);
void add_temporary(const array& arr) {
temporaries_.push_back(arr.data_shared_ptr());
@@ -132,7 +139,7 @@ class CommandEncoder {
Device& device_;
CudaStream stream_;
CudaGraph graph_;
Worker worker_;
std::shared_ptr<Worker> worker_;
int node_count_{0};
bool in_concurrent_{false};
std::vector<cudaGraphNode_t> from_nodes_;
@@ -163,10 +170,6 @@ class Device {
// Make this device the current cuda device, this method is thread-safe.
void make_current();
CommandEncoder& get_command_encoder(Stream s);
cublasLtHandle_t get_cublaslt_handle();
cudnnHandle_t get_cudnn_handle();
int cuda_device() const {
return device_;
}
@@ -198,13 +201,12 @@ class Device {
int managed_memory_;
int memory_pools_;
std::string device_name_;
cublasLtHandle_t cublaslt_handle_{nullptr};
cudnnHandle_t cudnn_handle_{nullptr};
std::unordered_map<int, CommandEncoder> encoders_;
};
Device& device(int cuda_device);
Device& device(mlx::core::Device d);
CommandEncoder& get_command_encoder(Stream s);
MLX_API Device& device(int cuda_device);
MLX_API Device& device(mlx::core::Device d);
MLX_API CommandEncoder& get_command_encoder(Stream s);
std::unordered_map<int, CommandEncoder>& get_command_encoders();
} // namespace mlx::core::cu
+87
View File
@@ -65,4 +65,91 @@ __global__ void scatter(
Op{}(out + out_idx, upd[upd_loc]);
}
template <typename T, bool SrcContiguous, bool DstContiguous, typename IdxT>
__global__ void masked_scatter(
const T* dst,
const bool* mask,
const int32_t* scatter_offsets,
const T* src,
T* out,
IdxT size,
IdxT src_batch_size,
IdxT mask_batch_size,
const __grid_constant__ Shape dst_shape,
const __grid_constant__ Strides dst_strides,
int32_t dst_ndim,
const __grid_constant__ Shape src_shape,
const __grid_constant__ Strides src_strides,
int32_t src_ndim) {
IdxT index = cg::this_grid().thread_rank();
if (index >= size) {
return;
}
T dst_val;
if constexpr (DstContiguous) {
dst_val = dst[index];
} else {
IdxT dst_loc =
elem_to_loc(index, dst_shape.data(), dst_strides.data(), dst_ndim);
dst_val = dst[dst_loc];
}
if (mask[index]) {
IdxT src_index = static_cast<IdxT>(scatter_offsets[index]);
if (src_index < src_batch_size) {
IdxT batch_idx = index / mask_batch_size;
if constexpr (SrcContiguous) {
out[index] = src[batch_idx * src_batch_size + src_index];
} else {
IdxT src_elem = batch_idx * src_batch_size + src_index;
IdxT src_loc = elem_to_loc(
src_elem, src_shape.data(), src_strides.data(), src_ndim);
out[index] = src[src_loc];
}
return;
}
}
out[index] = dst_val;
}
template <typename T, typename IdxT, int N_READS>
__global__ void masked_scatter_vec_contiguous(
const T* dst,
const bool* mask,
const int32_t* scatter_offsets,
const T* src,
T* out,
IdxT size,
IdxT src_batch_size,
IdxT mask_batch_size) {
IdxT vec_index = cg::this_grid().thread_rank();
IdxT base = vec_index * N_READS;
if (base >= size) {
return;
}
auto out_vec = load_vector<N_READS>(dst, vec_index, size, static_cast<T>(0));
auto mask_vec = load_vector<N_READS>(mask, vec_index, size, false);
auto offset_vec = load_vector<N_READS>(scatter_offsets, vec_index, size, 0);
#pragma unroll
for (int i = 0; i < N_READS; ++i) {
IdxT index = base + i;
if (index >= size) {
break;
}
if (mask_vec[i]) {
IdxT src_index = static_cast<IdxT>(offset_vec[i]);
if (src_index < src_batch_size) {
IdxT batch_idx = index / mask_batch_size;
out_vec[i] = src[batch_idx * src_batch_size + src_index];
}
}
}
store_vector<N_READS>(out, vec_index, out_vec, size);
}
} // namespace mlx::core::cu
+75
View File
@@ -0,0 +1,75 @@
// Copyright © 2025 Apple Inc.
#pragma once
#include "mlx/backend/cuda/device/binary_ops.cuh"
#include "mlx/backend/cuda/device/utils.cuh"
#include <cooperative_groups.h>
namespace mlx::core::cu {
namespace cg = cooperative_groups;
template <
typename T,
typename IdxT,
typename Op,
bool OUT_ROW_CONTIG,
bool UPD_ROW_CONTIG,
bool UPD_SCALAR,
int NWORK>
__global__ void slice_update_op(
const T* updates,
T* out,
int64_t update_size,
const __grid_constant__ Shape update_shape,
const __grid_constant__ Strides update_strides,
int32_t update_ndim,
const __grid_constant__ Strides output_strides,
int64_t output_offset) {
Op op;
IdxT idx = cg::this_grid().thread_rank() * NWORK;
IdxT out_idx;
IdxT update_idx;
if constexpr (OUT_ROW_CONTIG) {
out_idx = idx;
} else {
out_idx = elem_to_loc<IdxT>(
idx, update_shape.data(), output_strides.data(), update_ndim);
}
if constexpr (!UPD_SCALAR) {
if constexpr (UPD_ROW_CONTIG) {
update_idx = idx;
} else {
update_idx = elem_to_loc<IdxT>(
idx, update_shape.data(), update_strides.data(), update_ndim);
}
} else {
update_idx = 0;
}
out += output_offset;
for (int j = 0; j < NWORK && idx < update_size; j++) {
out[out_idx] = op(out[out_idx], updates[update_idx]);
idx++;
if constexpr (OUT_ROW_CONTIG) {
out_idx = idx;
} else {
out_idx += output_strides[update_ndim - 1];
}
if constexpr (UPD_ROW_CONTIG) {
update_idx = idx;
} else if constexpr (!UPD_SCALAR) {
update_idx += update_strides[update_ndim - 1];
}
}
}
} // namespace mlx::core::cu
+23 -6
View File
@@ -2,7 +2,9 @@
#include "mlx/backend/gpu/eval.h"
#include "mlx/backend/cuda/allocator.h"
#include "mlx/backend/cuda/device.h"
#include "mlx/backend/cuda/cublas_utils.h"
#include "mlx/backend/cuda/cudnn_utils.h"
#include "mlx/backend/cuda/event.h"
#include "mlx/primitives.h"
#include "mlx/scheduler.h"
@@ -10,13 +12,24 @@
namespace mlx::core::gpu {
void new_stream(Stream s) {
// Force initalization of CUDA, so CUDA runtime get destroyed at last.
void init() {
// Force initalization of CUDA, so CUDA runtime get destroyed last.
cudaFree(nullptr);
// Make sure CUDA event pool get destroyed after device and stream.
cu::CudaEvent::init_pool();
// Ensure the static stream objects get created.
cu::get_command_encoder(s);
mlx::core::cu::CudaEvent::init_pool();
}
void new_stream(Stream s) {
// Make sure the handles get destroyed after CommandEncoder.
init_cublas_handles_cache();
init_cudnn_handles_cache();
init_cudnn_conv_cache();
init_cudnn_sdpa_cache();
// Create CommandEncoder.
assert(s.device == Device::gpu);
auto& encoders = cu::get_command_encoders();
auto& d = cu::device(s.device);
encoders.try_emplace(s.index, d);
}
void eval(array& arr) {
@@ -67,4 +80,8 @@ void synchronize(Stream s) {
cu::get_command_encoder(s).synchronize();
}
void clear_streams() {
cu::get_command_encoders().clear();
}
} // namespace mlx::core::gpu
+443
View File
@@ -0,0 +1,443 @@
// Copyright © 2025 Apple Inc.
#include <cufftXt.h>
#include <algorithm>
#include <cstdint>
#include <memory>
#include <numeric>
#include <stdexcept>
#include <string>
#include <vector>
#include <cooperative_groups.h>
#include <nvtx3/nvtx3.hpp>
#include "mlx/backend/common/utils.h"
#include "mlx/backend/cuda/allocator.h"
#include "mlx/backend/cuda/device.h"
#include "mlx/backend/cuda/device/complex.cuh"
#include "mlx/backend/cuda/lru_cache.h"
#include "mlx/backend/cuda/utils.h"
#include "mlx/backend/gpu/copy.h"
#include "mlx/primitives.h"
namespace mlx::core {
namespace cu {
namespace cg = cooperative_groups;
template <typename T>
__global__ void scale_fft_output(T* out, T scale, size_t size) {
auto index = cg::this_grid().thread_rank();
if (index < size) {
out[index] *= scale;
}
}
} // namespace cu
namespace {
void check_cufft_error(const char* name, cufftResult err) {
if (err != CUFFT_SUCCESS) {
throw std::runtime_error(
std::string(name) +
" failed with code: " + std::to_string(static_cast<int>(err)) + ".");
}
}
#define CHECK_CUFFT_ERROR(cmd) check_cufft_error(#cmd, (cmd))
enum class FFTTransformType : uint8_t {
C2C = 0,
R2C = 1,
C2R = 2,
};
struct FFTPlanKey {
int device_id;
FFTTransformType transform_type;
int64_t n;
int64_t batch;
};
struct CuFFTPlan {
explicit CuFFTPlan(int device_id, cufftHandle handle, size_t workspace_size)
: device_id(device_id), handle(handle), workspace_size(workspace_size) {}
~CuFFTPlan() {
if (handle != 0) {
try {
cu::device(device_id).make_current();
cufftDestroy(handle);
} catch (...) {
}
}
}
int device_id;
cufftHandle handle;
size_t workspace_size;
};
struct OrderedArray {
array arr;
std::vector<int> order;
};
auto& fft_plan_cache() {
static LRUBytesKeyCache<FFTPlanKey, std::shared_ptr<CuFFTPlan>> cache(
"MLX_CUDA_FFT_CACHE_SIZE",
/* default_capacity */ 128);
return cache;
}
FFTPlanKey make_plan_key(
int device_id,
FFTTransformType transform_type,
int64_t n,
int64_t batch) {
FFTPlanKey key{};
key.device_id = device_id;
key.transform_type = transform_type;
key.n = n;
key.batch = batch;
return key;
}
cudaDataType_t input_type(FFTTransformType transform_type) {
switch (transform_type) {
case FFTTransformType::C2C:
case FFTTransformType::C2R:
return CUDA_C_32F;
case FFTTransformType::R2C:
return CUDA_R_32F;
}
throw std::runtime_error("[FFT] Unsupported cuFFT input transform type.");
}
cudaDataType_t output_type(FFTTransformType transform_type) {
switch (transform_type) {
case FFTTransformType::C2C:
case FFTTransformType::R2C:
return CUDA_C_32F;
case FFTTransformType::C2R:
return CUDA_R_32F;
}
throw std::runtime_error("[FFT] Unsupported cuFFT output transform type.");
}
cudaDataType_t execution_type(FFTTransformType transform_type) {
switch (transform_type) {
case FFTTransformType::C2C:
return CUDA_C_32F;
case FFTTransformType::R2C:
return CUDA_R_32F;
case FFTTransformType::C2R:
return CUDA_C_32F;
}
throw std::runtime_error("[FFT] Unsupported cuFFT execution transform type.");
}
int64_t input_embed(FFTTransformType transform_type, int64_t n) {
return transform_type == FFTTransformType::C2R ? (n / 2 + 1) : n;
}
int64_t output_embed(FFTTransformType transform_type, int64_t n) {
return transform_type == FFTTransformType::R2C ? (n / 2 + 1) : n;
}
int exec_direction(FFTTransformType transform_type, bool inverse) {
switch (transform_type) {
case FFTTransformType::C2C:
return inverse ? CUFFT_INVERSE : CUFFT_FORWARD;
case FFTTransformType::R2C:
return CUFFT_FORWARD;
case FFTTransformType::C2R:
return CUFFT_INVERSE;
}
throw std::runtime_error("[FFT] Unsupported cuFFT execution direction.");
}
std::shared_ptr<CuFFTPlan> get_fft_plan(
cu::CommandEncoder& encoder,
FFTTransformType transform_type,
int64_t n,
int64_t batch) {
auto key = BytesKey<FFTPlanKey>{};
key.pod =
make_plan_key(encoder.device().cuda_device(), transform_type, n, batch);
auto& cache = fft_plan_cache();
if (auto entry = cache.find(key); entry != cache.end()) {
return entry->second;
}
encoder.device().make_current();
cufftHandle handle = 0;
size_t workspace_size = 0;
try {
CHECK_CUFFT_ERROR(cufftCreate(&handle));
CHECK_CUFFT_ERROR(cufftSetAutoAllocation(handle, 0));
CHECK_CUFFT_ERROR(cufftSetStream(handle, encoder.stream()));
long long plan_n[1] = {n};
long long inembed[1] = {input_embed(transform_type, n)};
long long onembed[1] = {output_embed(transform_type, n)};
CHECK_CUFFT_ERROR(cufftXtMakePlanMany(
handle,
/* rank= */ 1,
plan_n,
inembed,
/* istride= */ 1,
/* idist= */ input_embed(transform_type, n),
input_type(transform_type),
onembed,
/* ostride= */ 1,
/* odist= */ output_embed(transform_type, n),
output_type(transform_type),
batch,
&workspace_size,
execution_type(transform_type)));
} catch (...) {
if (handle != 0) {
encoder.device().make_current();
cufftDestroy(handle);
}
throw;
}
auto plan = std::make_shared<CuFFTPlan>(
encoder.device().cuda_device(), handle, workspace_size);
return cache.emplace(key, plan).first->second;
}
std::vector<int> make_identity_order(int ndim) {
std::vector<int> order(ndim);
std::iota(order.begin(), order.end(), 0);
return order;
}
std::vector<int> move_axis_to_back_permutation(int ndim, int axis_pos) {
std::vector<int> perm;
perm.reserve(ndim);
for (int i = 0; i < ndim; ++i) {
if (i != axis_pos) {
perm.push_back(i);
}
}
perm.push_back(axis_pos);
return perm;
}
std::vector<int> apply_permutation(
const std::vector<int>& values,
const std::vector<int>& perm) {
std::vector<int> out(perm.size());
for (int i = 0; i < perm.size(); ++i) {
out[i] = values[perm[i]];
}
return out;
}
int find_axis_position(const std::vector<int>& order, int axis) {
auto it = std::find(order.begin(), order.end(), axis);
if (it == order.end()) {
throw std::runtime_error("[FFT] Internal axis tracking mismatch.");
}
return static_cast<int>(it - order.begin());
}
OrderedArray prepare_input(
const OrderedArray& current,
int axis,
bool allow_direct,
cu::CommandEncoder& encoder,
Stream s) {
int axis_pos = find_axis_position(current.order, axis);
bool axis_last = axis_pos == static_cast<int>(current.order.size()) - 1;
bool direct = allow_direct && axis_last && current.arr.flags().row_contiguous;
if (direct) {
return current;
}
array view = current.arr;
std::vector<int> order = current.order;
if (!axis_last) {
auto perm = move_axis_to_back_permutation(current.arr.ndim(), axis_pos);
view = transpose_in_eval(current.arr, perm);
order = apply_permutation(current.order, perm);
}
array packed = contiguous_copy_gpu(view, s);
encoder.add_temporary(packed);
return {std::move(packed), std::move(order)};
}
void execute_fft(
const array& in,
array& out,
FFTTransformType transform_type,
bool inverse,
cu::CommandEncoder& encoder) {
if (!in.flags().row_contiguous || in.strides(-1) != 1) {
throw std::runtime_error("[FFT] Expected packed row-contiguous FFT input.");
}
int64_t n =
transform_type == FFTTransformType::C2R ? out.shape(-1) : in.shape(-1);
int64_t batch = in.shape().empty() ? 1 : in.size() / in.shape(-1);
auto plan = get_fft_plan(encoder, transform_type, n, batch);
encoder.set_input_array(in);
out.set_data(cu::malloc_async(out.nbytes(), encoder));
encoder.set_output_array(out);
encoder.add_completed_handler([plan]() {});
encoder.device().make_current();
CHECK_CUFFT_ERROR(cufftSetStream(plan->handle, encoder.stream()));
auto* workspace = allocate_workspace(encoder, plan->workspace_size);
CHECK_CUFFT_ERROR(cufftSetWorkArea(plan->handle, workspace));
auto capture = encoder.capture_context();
CHECK_CUFFT_ERROR(cufftXtExec(
plan->handle,
gpu_ptr<void>(in),
gpu_ptr<void>(out),
exec_direction(transform_type, inverse)));
}
void restore_output_layout(const OrderedArray& current, array& out) {
Strides out_strides(out.ndim());
for (int i = 0; i < current.order.size(); ++i) {
out_strides[current.order[i]] = current.arr.strides(i);
}
auto [data_size, row_contiguous, col_contiguous] =
check_contiguity(out.shape(), out_strides);
bool contiguous =
current.arr.flags().contiguous && data_size == current.arr.data_size();
out.copy_shared_buffer(
current.arr,
out_strides,
{contiguous, row_contiguous, col_contiguous},
current.arr.data_size());
}
void apply_inverse_scale(
array& arr,
const std::vector<size_t>& axes,
const array& out,
cu::CommandEncoder& encoder) {
if (axes.empty()) {
return;
}
double scale = 1.0;
for (auto axis : axes) {
scale /= out.shape(axis);
}
size_t size = arr.data_size();
dim3 block_dims(256);
dim3 grid_dims((size + block_dims.x - 1) / block_dims.x);
encoder.set_input_array(arr);
encoder.set_output_array(arr);
if (arr.dtype() == float32) {
float scale_f = static_cast<float>(scale);
encoder.add_kernel_node(
cu::scale_fft_output<float>,
grid_dims,
block_dims,
gpu_ptr<float>(arr),
scale_f,
size);
} else if (arr.dtype() == complex64) {
cu::complex64_t scale_f(static_cast<float>(scale), 0.0f);
encoder.add_kernel_node(
cu::scale_fft_output<cu::complex64_t>,
grid_dims,
block_dims,
gpu_ptr<cu::complex64_t>(arr),
scale_f,
size);
} else {
throw std::runtime_error("[FFT] Unsupported dtype for inverse scaling.");
}
}
} // namespace
void FFT::eval_gpu(const std::vector<array>& inputs, array& out) {
nvtx3::scoped_range r("FFT::eval_gpu");
auto& s = stream();
auto& encoder = cu::get_command_encoder(s);
auto& in = inputs[0];
if (out.size() == 0) {
return;
}
auto order = make_identity_order(in.ndim());
OrderedArray current{in, std::move(order)};
std::vector<int> axis_sequence;
axis_sequence.reserve(axes_.size());
if (inverse_) {
for (auto axis : axes_) {
axis_sequence.push_back(static_cast<int>(axis));
}
} else {
for (int i = static_cast<int>(axes_.size()) - 1; i >= 0; --i) {
axis_sequence.push_back(static_cast<int>(axes_[i]));
}
}
int real_axis = axes_.empty() ? -1 : static_cast<int>(axes_.back());
for (int i = 0; i < axis_sequence.size(); ++i) {
int axis = axis_sequence[i];
bool step_real = real_ && axis == real_axis;
auto transform_type = step_real
? (inverse_ ? FFTTransformType::C2R : FFTTransformType::R2C)
: FFTTransformType::C2C;
// cuFFT may overwrite the input buffer for C2R, so only use the direct
// input when the transform is out-of-place from the library's perspective
// or when the original input may be donated to the output.
auto prepared = prepare_input(
current,
axis,
/* allow_direct= */ transform_type != FFTTransformType::C2R ||
is_donatable(in, out),
encoder,
s);
Shape step_shape = prepared.arr.shape();
if (step_real) {
step_shape.back() = out.shape(axis);
}
Dtype step_dtype =
transform_type == FFTTransformType::C2R ? float32 : complex64;
array step_out(std::move(step_shape), step_dtype, nullptr, {});
execute_fft(prepared.arr, step_out, transform_type, inverse_, encoder);
encoder.add_temporary(step_out);
current = {std::move(step_out), std::move(prepared.order)};
}
if (inverse_) {
apply_inverse_scale(current.arr, axes_, out, encoder);
}
restore_output_layout(current, out);
}
} // namespace mlx::core
+176
View File
@@ -0,0 +1,176 @@
// Copyright © 2026 Apple Inc.
#include "mlx/backend/cuda/device.h"
#include "mlx/backend/cuda/device/utils.cuh"
#include "mlx/backend/cuda/gemms/block_mask.h"
#include "mlx/backend/cuda/kernel_utils.cuh"
#include "mlx/dtype_utils.h"
#include <cooperative_groups.h>
namespace mlx::core {
namespace cg = cooperative_groups;
namespace cu {
template <typename T, typename MaskT, bool SrcContiguous>
__global__ void block_mask_copy_kernel(
const T* src,
T* dst,
int block_size,
int64_t rows,
int64_t cols,
const __grid_constant__ Shape src_shape,
const __grid_constant__ Strides src_strides,
int src_ndim,
MaskT* mask,
const __grid_constant__ Shape mask_shape,
const __grid_constant__ Strides mask_strides,
int mask_ndim,
int64_t mask_row_stride,
int64_t mask_col_stride,
int64_t mask_mat_size,
int64_t batch_count) {
int64_t mat_size = rows * cols;
int64_t idx = cg::this_grid().thread_rank();
if (idx >= batch_count * mat_size)
return;
int64_t batch = idx / mat_size;
int64_t within = idx % mat_size;
int64_t mask_batch_offset = elem_to_loc(
batch * mask_mat_size, mask_shape.data(), mask_strides.data(), mask_ndim);
MaskT mask_val = mask
[mask_batch_offset + (within / cols) / block_size * mask_row_stride +
(within % cols) / block_size * mask_col_stride];
int64_t src_offset;
if constexpr (SrcContiguous) {
src_offset = idx;
} else {
src_offset = elem_to_loc(
batch * mat_size + within,
src_shape.data(),
src_strides.data(),
src_ndim);
}
if constexpr (std::is_same_v<MaskT, bool>) {
dst[idx] = mask_val ? src[src_offset] : T(0);
} else {
dst[idx] = src[src_offset] * T(mask_val);
}
}
} // namespace cu
namespace {
template <typename T, typename F>
void dispatch_mask_type(Dtype mask_dtype, F&& f) {
if (mask_dtype == bool_) {
f.template operator()<bool>();
} else {
f.template operator()<T>();
}
}
void block_mask_copy(
cu::CommandEncoder& encoder,
const array& src,
array& dst,
const array& mask,
int block_size,
int64_t rows,
int64_t cols,
bool src_contiguous,
int64_t batch_count) {
int mask_ndim = mask.ndim();
int64_t mask_row_str = mask.strides()[mask_ndim - 2];
int64_t mask_col_str = mask.strides()[mask_ndim - 1];
int64_t mask_mat_size =
int64_t(mask.shape()[mask_ndim - 2]) * mask.shape()[mask_ndim - 1];
auto [num_blocks, block_dims] = get_launch_args(src, src.size() > INT32_MAX);
dispatch_float_types(src.dtype(), "block_mask_copy", [&](auto type_tag) {
using T = cuda_type_t<MLX_GET_TYPE(type_tag)>;
dispatch_mask_type<T>(mask.dtype(), [&]<typename MaskT>() {
dispatch_bool(src_contiguous, [&](auto contiguous_tag) {
constexpr bool Contiguous = decltype(contiguous_tag)::value;
encoder.add_kernel_node(
cu::block_mask_copy_kernel<T, MaskT, Contiguous>,
num_blocks,
block_dims,
gpu_ptr<T>(src),
gpu_ptr<T>(dst),
block_size,
rows,
cols,
const_param(src.shape()),
const_param(src.strides()),
src.ndim(),
gpu_ptr<MaskT>(mask),
const_param(mask.shape()),
const_param(mask.strides()),
mask_ndim,
mask_row_str,
mask_col_str,
mask_mat_size,
batch_count);
});
});
});
}
} // namespace
void apply_block_mask(
cu::CommandEncoder& encoder,
array& data,
const array& mask,
int block_size,
int64_t rows,
int64_t cols,
int64_t batch_count) {
encoder.set_input_array(mask);
encoder.set_output_array(data);
// Use block_mask_copy in-place (src == dst) with SrcContiguous=true.
block_mask_copy(
encoder, data, data, mask, block_size, rows, cols, true, batch_count);
}
array copy_with_block_mask(
cu::CommandEncoder& encoder,
const array& src,
const array& mask,
int block_size,
int64_t rows,
int64_t cols,
int64_t batch_count) {
array dst(src.shape(), src.dtype(), nullptr, {});
dst.set_data(cu::malloc_async(dst.nbytes(), encoder));
encoder.add_temporary(dst);
encoder.set_input_array(src);
encoder.set_input_array(mask);
encoder.set_output_array(dst);
block_mask_copy(
encoder,
src,
dst,
mask,
block_size,
rows,
cols,
src.flags().row_contiguous,
batch_count);
return dst;
}
} // namespace mlx::core
+28
View File
@@ -0,0 +1,28 @@
// Copyright © 2026 Apple Inc.
#pragma once
#include "mlx/array.h"
#include "mlx/backend/cuda/device.h"
namespace mlx::core {
void apply_block_mask(
cu::CommandEncoder& encoder,
array& data,
const array& mask,
int block_size,
int64_t rows,
int64_t cols,
int64_t batch_count);
array copy_with_block_mask(
cu::CommandEncoder& encoder,
const array& src,
const array& mask,
int block_size,
int64_t rows,
int64_t cols,
int64_t batch_count);
} // namespace mlx::core
+339
View File
@@ -0,0 +1,339 @@
// Copyright © 2026 Apple Inc.
#include "mlx/backend/cuda/cutlass_utils.cuh"
#include "mlx/backend/cuda/device.h"
#include "mlx/backend/cuda/kernel_utils.cuh"
#include "mlx/dtype_utils.h"
#include <cutlass/epilogue/collective/collective_epilogue.hpp>
#include <cutlass/epilogue/thread/linear_combination.h>
#include <cutlass/gemm/collective/collective_mma.hpp>
#include <cutlass/gemm/device/gemm_universal_adapter.h>
#include <cutlass/gemm/dispatch_policy.hpp>
#include <cutlass/gemm/kernel/gemm_universal.hpp>
// We can't put kernel code in mlx::core due to name conflicts of "Shape".
namespace cutlass_gemm {
using namespace cute;
// Modified from cutlass/include/cutlass/gemm/kernel/sm70_gemm.hpp to fuse
// gather into GEMM.
template <
class ProblemShape_,
class CollectiveMainloop_,
class CollectiveEpilogue_>
class GatherGemm {
public:
using ProblemShape = ProblemShape_;
using CollectiveMainloop = CollectiveMainloop_;
using TileShape = typename CollectiveMainloop::TileShape;
using TiledMma = typename CollectiveMainloop::TiledMma;
using ArchTag = typename CollectiveMainloop::ArchTag;
using ElementA = typename CollectiveMainloop::ElementA;
using StrideA = typename CollectiveMainloop::StrideA;
using ElementB = typename CollectiveMainloop::ElementB;
using StrideB = typename CollectiveMainloop::StrideB;
using DispatchPolicy = typename CollectiveMainloop::DispatchPolicy;
using ElementAccumulator = typename CollectiveMainloop::ElementAccumulator;
using CollectiveEpilogue = CollectiveEpilogue_;
using ElementC = typename CollectiveEpilogue::ElementC;
using StrideC = typename CollectiveEpilogue::StrideC;
using ElementD = typename CollectiveEpilogue::ElementD;
using StrideD = typename CollectiveEpilogue::StrideD;
static_assert(
cute::is_same_v<
ElementAccumulator,
typename CollectiveEpilogue::ElementAccumulator>,
"Mainloop and epilogue do not agree on accumulator value type.");
static constexpr int SharedStorageSize = static_cast<int>(cute::max(
sizeof(typename CollectiveMainloop::SharedStorage),
sizeof(typename CollectiveEpilogue::SharedStorage)));
static constexpr uint32_t MaxThreadsPerBlock =
CUTE_STATIC_V(size(TiledMma{}));
static constexpr uint32_t MinBlocksPerMultiprocessor = 1;
struct Arguments {
ProblemShape problem_shape;
const uint32_t* lhs_indices;
const uint32_t* rhs_indices;
typename CollectiveMainloop::Arguments mainloop;
typename CollectiveEpilogue::Arguments epilogue;
};
struct Params {
ProblemShape problem_shape;
const uint32_t* lhs_indices;
const uint32_t* rhs_indices;
typename CollectiveMainloop::Params mainloop;
typename CollectiveEpilogue::Params epilogue;
};
static Params to_underlying_arguments(
const Arguments& args,
void* workspace) {
return {
args.problem_shape,
args.lhs_indices,
args.rhs_indices,
CollectiveMainloop::to_underlying_arguments(
args.problem_shape, args.mainloop, workspace),
CollectiveEpilogue::to_underlying_arguments(
args.problem_shape, args.epilogue, workspace)};
}
static cutlass::Status
initialize_workspace(const Arguments&, void*, cudaStream_t, void*) {
return cutlass::Status::kSuccess;
}
static dim3 get_grid_shape(const Params& params) {
auto [m, n, k, l] = params.problem_shape;
return dim3{
uint32_t(ceil_div(m, shape<0>(TileShape{}))),
uint32_t(ceil_div(n, shape<1>(TileShape{}))),
uint32_t(l)};
}
static dim3 get_block_shape() {
return dim3{MaxThreadsPerBlock, 1, 1};
}
CUTLASS_DEVICE void operator()(const Params& params, char* smem_buf) {
int thread_idx = int(threadIdx.x);
int m_coord = int(blockIdx.x);
int n_coord = int(blockIdx.y);
int l_coord = int(blockIdx.z);
auto shape_MNKL = append<4>(params.problem_shape, Int<1>{});
auto cta_tile = TileShape{};
auto cta_coord = make_coord(m_coord, n_coord, _, l_coord);
// Represent the full tensors.
Tensor mA_mkl = make_tensor(
make_gmem_ptr(params.mainloop.ptr_A),
select<0, 2, 3>(shape_MNKL),
params.mainloop.dA);
Tensor mB_nkl = make_tensor(
make_gmem_ptr(params.mainloop.ptr_B),
select<1, 2, 3>(shape_MNKL),
params.mainloop.dB);
// Get batch slice.
Tensor mA_mk = mA_mkl(_, _, params.lhs_indices[l_coord]);
Tensor mB_nk = mB_nkl(_, _, params.rhs_indices[l_coord]);
// Slice to get the tiles this thread block is responsible for.
Tensor gA =
local_tile(mA_mk, cta_tile, take<0, 3>(cta_coord), Step<_1, X, _1>{});
Tensor gB =
local_tile(mB_nk, cta_tile, take<0, 3>(cta_coord), Step<X, _1, _1>{});
// Compute tile residues for predication.
auto m_max_coord = size<0>(shape_MNKL) - size<0>(gA) * get<0>(cta_coord);
auto n_max_coord = size<1>(shape_MNKL) - size<0>(gB) * get<1>(cta_coord);
auto k_residue = size<2>(shape_MNKL) - size<1>(gA) * size<2>(gA);
auto residue_mnk = make_tuple(m_max_coord, n_max_coord, k_residue);
// Allocate the tiled_mma and the accumulators for the (M,N) cta_tile.
TiledMma tiled_mma;
Tensor accum = partition_fragment_C(tiled_mma, take<0, 2>(cta_tile));
clear(accum);
auto k_tile_iter = make_coord_iterator(shape<2>(gA));
int k_tile_count = size<2>(gA);
// Perform the collective scoped MMA.
CollectiveMainloop collective_mma;
collective_mma(
accum,
gA,
gB,
accum,
k_tile_iter,
k_tile_count,
residue_mnk,
thread_idx,
smem_buf);
// Epilogue and write to out.
CollectiveEpilogue epilogue(params.epilogue);
epilogue(
shape_MNKL,
cta_tile,
cta_coord,
accum,
tiled_mma,
residue_mnk,
thread_idx,
smem_buf);
}
};
template <typename Element, bool KMajor>
struct SimtCopyTraits {};
template <typename Element>
struct SimtCopyTraits<Element, true> {
using GmemTiledCopy = decltype(make_tiled_copy(
Copy_Atom<UniversalCopy<Element>, Element>{},
Layout<Shape<_32, _8>, Stride<_8, _1>>{},
Layout<Shape<_1, _1>>{}));
using SmemLayout = Layout<Shape<_128, _8>, Stride<_1, Int<128 + 1>>>;
using SmemCopyAtom = Copy_Atom<DefaultCopy, Element>;
};
template <typename Element>
struct SimtCopyTraits<Element, false> {
using GmemTiledCopy = decltype(make_tiled_copy(
Copy_Atom<UniversalCopy<Element>, Element>{},
Layout<Shape<_32, _8>, Stride<_1, _32>>{},
Layout<Shape<_1, _1>>{}));
using SmemLayout = Layout<Shape<_128, _8>, Stride<_1, _128>>;
using SmemCopyAtom = Copy_Atom<DefaultCopy, Element>;
};
template <typename F>
void dispatch_stride(bool k_major, int m, int k, F&& f) {
if (k_major) {
f(make_stride(k, Int<1>{}, m * k), std::true_type{});
} else {
f(make_stride(Int<1>{}, m, m * k), std::false_type{});
}
}
template <typename Element, typename F>
void gather_mm(
int m,
int n,
int k,
int l,
bool a_transposed,
bool b_transposed,
const Element* A,
const Element* B,
const uint32_t* lhs_indices,
const uint32_t* rhs_indices,
Element* C,
F&& launch_kernel) {
auto problem_shape = make_shape(m, n, k, l);
auto dC = make_stride(m, Int<1>{}, m * n);
dispatch_stride(!a_transposed, m, k, [&](auto dA, auto k_major_a) {
dispatch_stride(b_transposed, n, k, [&](auto dB, auto k_major_b) {
using Accumulator =
std::conditional_t<(sizeof(Element) < 4), float, Element>;
using TileShape = Shape<_128, _128, _8>;
using DispatchPolicy = cutlass::gemm::MainloopSm70TwoStage;
using TiledMma = TiledMMA<
MMA_Atom<UniversalFMA<Accumulator, Element, Element, Accumulator>>,
Layout<Shape<_16, _16, _1>>>;
using CopyTraitsA = SimtCopyTraits<Element, k_major_a.value>;
using CopyTraitsB = SimtCopyTraits<Element, k_major_b.value>;
using CollectiveMainloop = cutlass::gemm::collective::CollectiveMma<
DispatchPolicy,
TileShape,
Element,
decltype(dA),
Element,
decltype(dB),
TiledMma,
typename CopyTraitsA::GmemTiledCopy,
typename CopyTraitsA::SmemLayout,
typename CopyTraitsA::SmemCopyAtom,
identity,
typename CopyTraitsB::GmemTiledCopy,
typename CopyTraitsB::SmemLayout,
typename CopyTraitsB::SmemCopyAtom,
identity>;
using CollectiveEpilogue = cutlass::epilogue::collective::DefaultEpilogue<
Element,
decltype(dC),
decltype(dC),
cutlass::epilogue::thread::
LinearCombination<Element, 1, Accumulator, Accumulator>,
cutlass::gemm::EpilogueDefault>;
using GemmKernel = GatherGemm<
decltype(problem_shape),
CollectiveMainloop,
CollectiveEpilogue>;
using Gemm = cutlass::gemm::device::GemmUniversalAdapter<GemmKernel>;
Gemm gemm;
typename Gemm::Arguments args{
problem_shape,
lhs_indices,
rhs_indices,
{A, dA, B, dB},
{{1.f, 0.f}, C, dC, C, dC}};
CHECK_CUTLASS_ERROR(gemm.initialize(args, nullptr));
auto* kernel = &cutlass::device_kernel<GemmKernel>;
void* kernel_params[] = {const_cast<Gemm::Params*>(&gemm.params())};
launch_kernel(
reinterpret_cast<void*>(kernel),
gemm.get_grid_shape(gemm.params()),
GemmKernel::get_block_shape(),
GemmKernel::SharedStorageSize,
kernel_params);
});
});
}
} // namespace cutlass_gemm
namespace mlx::core {
void cutlass_gather_mm(
bool a_transposed,
bool b_transposed,
const array& a,
const array& b,
const array& lhs_indices,
const array& rhs_indices,
array& out,
cu::CommandEncoder& encoder) {
int m = out.shape(-2);
int n = out.shape(-1);
int k = a.shape(-1);
int l = out.size() / (m * n);
encoder.set_input_array(a);
encoder.set_input_array(b);
encoder.set_input_array(lhs_indices);
encoder.set_input_array(rhs_indices);
encoder.set_output_array(out);
dispatch_float_types(out.dtype(), "gather_mm", [&](auto type_tag) {
using Element = cutlass_type_t<MLX_GET_TYPE(type_tag)>;
cutlass_gemm::gather_mm(
m,
n,
k,
l,
a_transposed,
b_transposed,
gpu_ptr<Element>(a),
gpu_ptr<Element>(b),
gpu_ptr<uint32_t>(lhs_indices),
gpu_ptr<uint32_t>(rhs_indices),
gpu_ptr<Element>(out),
[&](auto* kernel,
dim3 num_blocks,
dim3 block_dims,
uint32_t smem_bytes,
void** args) {
encoder.add_kernel_node_raw(
kernel, num_blocks, block_dims, {}, smem_bytes, args);
});
});
}
} // namespace mlx::core
+23
View File
@@ -0,0 +1,23 @@
// Copyright © 2026 Apple Inc.
#pragma once
namespace mlx::core {
namespace cu {
class CommandEncoder;
}
class array;
void cutlass_gather_mm(
bool a_transposed,
bool b_transposed,
const array& a,
const array& b,
const array& lhs_indices,
const array& rhs_indices,
array& out,
cu::CommandEncoder& encoder);
} // namespace mlx::core
+1 -1
View File
@@ -167,7 +167,7 @@ __global__ void gemv_gather(
}
bool can_use_gemv(int M, int N, int K, bool a_transposed, bool b_transposed) {
return K % 32 == 0 && ((M == 1 && b_transposed) || (N == 1 && !a_transposed));
return (M == 1 && b_transposed) || (N == 1 && !a_transposed);
}
template <typename F>
@@ -245,7 +245,7 @@ void grouped_gemm_v2(
LayoutB,
cutlass::ComplexTransform::kNone,
GemmConfiguration::kAlignmentAB,
typename GemmConfiguration::Element,
typename GemmConfiguration::Accumulator,
cutlass::layout::RowMajor,
typename GemmConfiguration::Accumulator,
typename GemmConfiguration::OpClass,
@@ -325,6 +325,11 @@ void cutlass_grouped_gemm_unaligned(
const array& indices,
array& out,
cu::CommandEncoder& encoder) {
if (group_count > 1024) {
throw std::runtime_error(
"[gather_mm] Group count can not be larger than 1024.");
}
int K = a.shape(-1);
int N = b.shape(-1);
+247
View File
@@ -1,10 +1,13 @@
// Copyright © 2025 Apple Inc.
#include "mlx/backend/common/compiled.h"
#include "mlx/backend/common/slicing.h"
#include "mlx/backend/cuda/device.h"
#include "mlx/backend/cuda/jit_module.h"
#include "mlx/backend/cuda/kernel_utils.cuh"
#include "mlx/backend/gpu/copy.h"
#include "mlx/backend/gpu/scan.h"
#include "mlx/backend/gpu/slicing.h"
#include "mlx/dtype_utils.h"
#include "mlx/primitives.h"
@@ -23,6 +26,8 @@ namespace mlx::core {
namespace {
constexpr const char* g_scatter_ops[] = {"Max", "Min", "Sum", "Prod", "Assign"};
constexpr const char* g_slice_ops[] =
{"Maximum", "Minimum", "Add", "Multiply", ""};
void append_indices_arg(
cu::KernelArgs& args,
@@ -435,4 +440,246 @@ void ScatterAxis::eval_gpu(const std::vector<array>& inputs, array& out) {
kernel, num_blocks, block_dims, {}, 0, args.args());
}
void MaskedScatter::eval_gpu(const std::vector<array>& inputs, array& out) {
nvtx3::scoped_range r("MaskedScatter::eval_gpu");
assert(inputs.size() == 3);
const array& dst = inputs[0];
const array& mask = inputs[1];
const array& src = inputs[2];
auto& s = stream();
auto& encoder = cu::get_command_encoder(s);
const size_t total = mask.size();
out.set_data(cu::malloc_async(out.nbytes(), encoder));
if (total == 0) {
return;
}
array mask_flat = flatten_in_eval(mask, 1, -1, s);
if (gpu_ptr<void>(mask_flat) != gpu_ptr<void>(mask)) {
encoder.add_temporary(mask_flat);
}
if (!mask_flat.flags().row_contiguous) {
mask_flat = contiguous_copy_gpu(mask_flat, s);
encoder.add_temporary(mask_flat);
}
array scatter_offsets(mask_flat.shape(), int32, nullptr, {});
scatter_offsets.set_data(cu::malloc_async(scatter_offsets.nbytes(), encoder));
encoder.add_temporary(scatter_offsets);
scan_gpu_inplace(
mask_flat,
scatter_offsets,
Scan::Sum,
/* axis= */ 1,
/* reverse= */ false,
/* inclusive= */ false,
s);
const size_t batch_count = mask.shape(0);
const size_t mask_batch_size = mask_flat.size() / batch_count;
const size_t src_batch_size = src.size() / src.shape(0);
bool large = total > INT32_MAX || src.size() > INT32_MAX;
bool vectorized = src.flags().row_contiguous && dst.flags().row_contiguous;
constexpr int kMaskedScatterVecSize = 16;
constexpr int kMaskedScatterVecBlockDim = 256;
std::string module_name =
fmt::format("masked_scatter_{}", dtype_to_string(out.dtype()));
cu::JitModule& mod = cu::get_jit_module(s.device, module_name, [&]() {
std::vector<std::string> kernel_names;
for (int src_contiguous = 0; src_contiguous <= 1; ++src_contiguous) {
for (int dst_contiguous = 0; dst_contiguous <= 1; ++dst_contiguous) {
for (int use_large = 0; use_large <= 1; ++use_large) {
kernel_names.push_back(
fmt::format(
"mlx::core::cu::masked_scatter<{}, {}, {}, {}>",
dtype_to_cuda_type(out.dtype()),
src_contiguous ? "true" : "false",
dst_contiguous ? "true" : "false",
use_large ? "int64_t" : "int32_t"));
}
}
}
for (int use_large = 0; use_large <= 1; ++use_large) {
kernel_names.push_back(
fmt::format(
"mlx::core::cu::masked_scatter_vec_contiguous<{}, {}, {}>",
dtype_to_cuda_type(out.dtype()),
use_large ? "int64_t" : "int32_t",
kMaskedScatterVecSize));
}
return std::make_tuple(false, jit_source_scatter, std::move(kernel_names));
});
cu::KernelArgs args;
args.append(dst);
args.append(mask_flat);
args.append(scatter_offsets);
args.append(src);
args.append(out);
if (large) {
args.append<int64_t>(mask_flat.size());
args.append<int64_t>(src_batch_size);
args.append<int64_t>(mask_batch_size);
} else {
args.append<int32_t>(mask_flat.size());
args.append<int32_t>(src_batch_size);
args.append<int32_t>(mask_batch_size);
}
if (!vectorized) {
args.append_ndim(dst.shape());
args.append_ndim(dst.strides());
args.append<int32_t>(dst.ndim());
args.append_ndim(src.shape());
args.append_ndim(src.strides());
args.append<int32_t>(src.ndim());
}
encoder.set_input_array(dst);
encoder.set_input_array(mask_flat);
encoder.set_input_array(scatter_offsets);
encoder.set_input_array(src);
encoder.set_output_array(out);
std::string kernel_name = vectorized
? fmt::format(
"mlx::core::cu::masked_scatter_vec_contiguous<{}, {}, {}>",
dtype_to_cuda_type(out.dtype()),
large ? "int64_t" : "int32_t",
kMaskedScatterVecSize)
: fmt::format(
"mlx::core::cu::masked_scatter<{}, {}, {}, {}>",
dtype_to_cuda_type(out.dtype()),
src.flags().row_contiguous ? "true" : "false",
dst.flags().row_contiguous ? "true" : "false",
large ? "int64_t" : "int32_t");
auto kernel = mod.get_kernel(kernel_name);
auto [num_blocks, block_dims] = vectorized
? get_launch_args(
mask_flat, large, kMaskedScatterVecSize, kMaskedScatterVecBlockDim)
: get_launch_args(mask_flat, large);
encoder.add_kernel_node_raw(
kernel, num_blocks, block_dims, {}, 0, args.args());
}
void SliceUpdate::eval_gpu(const std::vector<array>& inputs, array& out) {
nvtx3::scoped_range r("SliceUpdate::eval_gpu");
assert(inputs.size() == 2);
if (out.size() == 0) {
return;
}
auto& in = inputs[0];
auto& upd = inputs[1];
if (upd.size() == 0) {
out.copy_shared_buffer(in);
return;
}
auto ctype = in.flags().contiguous && in.size() == in.data_size()
? CopyType::Vector
: CopyType::General;
copy_gpu(in, out, in.data_size() == 1 ? CopyType::Scalar : ctype, stream());
// Calculate out strides, initial offset and if copy needs to be made
auto [data_offset, out_strides] =
prepare_slice(out, start_indices_, strides_);
// Do copy for None reduce type
if (reduce_type_ == SliceUpdate::None) {
copy_gpu_inplace(
/* const array& src = */ upd,
/* array& dst = */ out,
/* const Shape& data_shape = */ upd.shape(),
/* const Strides& i_strides = */ upd.strides(),
/* const Strides& o_strides = */ out_strides,
/* int64_t i_offset = */ 0,
/* int64_t o_offset = */ data_offset,
/* CopyType ctype = */ CopyType::GeneralGeneral,
/* const Stream& s = */ stream());
return;
}
auto [shape, strides] =
collapse_contiguous_dims(upd.shape(), {upd.strides(), out_strides});
int nwork = 1;
if (shape.back() % 4 == 0) {
nwork = 4;
} else if (shape.back() % 2 == 0) {
nwork = 2;
}
const char* op_name = g_slice_ops[reduce_type_];
auto [ds, rc, cc] = check_contiguity(shape, strides[1]);
bool upd_contiguous = upd.flags().row_contiguous;
bool upd_scalar = upd.data_size() == 1;
bool out_contiguous = rc;
bool large = upd.size() > INT32_MAX;
std::string module_name =
fmt::format("slice_update_{}_{}", op_name, dtype_to_string(out.dtype()));
auto& s = stream();
auto& encoder = cu::get_command_encoder(s);
cu::JitModule& mod = cu::get_jit_module(s.device, module_name, [&]() {
std::vector<std::string> kernel_names;
for (int out_c = 0; out_c <= 1; ++out_c) {
for (int upd_c = 0; upd_c <= 1; ++upd_c) {
for (int upd_s = 0; upd_s <= 1; ++upd_s) {
for (int large = 0; large <= 1; ++large) {
for (int nwork = 1; nwork <= 16; nwork *= 2) {
kernel_names.push_back(
fmt::format(
"mlx::core::cu::slice_update_op<{}, {}, mlx::core::cu::{}, {}, {}, {}, {}>",
dtype_to_cuda_type(out.dtype()),
large ? "int64_t" : "int32_t",
op_name,
out_c ? "true" : "false",
upd_c ? "true" : "false",
upd_s ? "true" : "false",
nwork));
}
}
}
}
}
return std::make_tuple(
false, jit_source_slice_update, std::move(kernel_names));
});
cu::KernelArgs args;
args.append(upd);
args.append(out);
args.append<int64_t>(upd.size());
args.append_ndim(shape);
args.append_ndim(strides[0]);
args.append<int32_t>(shape.size());
args.append_ndim(strides[1]);
args.append<int64_t>(data_offset);
encoder.set_input_array(upd);
encoder.set_output_array(out);
std::string kernel_name;
kernel_name = fmt::format(
"mlx::core::cu::slice_update_op<{}, {}, mlx::core::cu::{}, {}, {}, {}, {}>",
dtype_to_cuda_type(out.dtype()),
large ? "int64_t" : "int32_t",
op_name,
out_contiguous,
upd_contiguous,
upd_scalar,
nwork);
auto kernel = mod.get_kernel(kernel_name);
auto [num_blocks, block_dims] = get_launch_args(upd, large, nwork);
encoder.add_kernel_node_raw(
kernel, num_blocks, block_dims, {}, 0, args.args());
}
} // namespace mlx::core
+44 -20
View File
@@ -9,6 +9,7 @@
#include <cstdlib>
#include <filesystem>
#include <fstream>
#include <shared_mutex>
#include <fmt/format.h>
#include <nvrtc.h>
@@ -26,6 +27,25 @@ void check_nvrtc_error(const char* name, nvrtcResult err) {
}
}
// Return the default path to CUDA toolkit.
const std::filesystem::path& default_cuda_toolkit_path() {
#if defined(_WIN32)
static auto cached_path = []() -> std::filesystem::path {
std::filesystem::path root(
LR"(C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA)");
for (auto& file : std::filesystem::directory_iterator(root)) {
if (std::filesystem::exists(file.path() / "include" / "cuda.h")) {
return file.path();
}
}
return {};
}();
#else
static std::filesystem::path cached_path = "/usr/local/cuda";
#endif
return cached_path;
}
// Return the --include-path args used for invoking NVRTC.
const std::vector<std::string>& include_path_args() {
static std::vector<std::string> cached_args = []() {
@@ -47,26 +67,22 @@ const std::vector<std::string>& include_path_args() {
// Add path to CUDA runtime headers, try local-installed python package
// first and then system-installed headers.
path = root_dir.parent_path() / "nvidia" / "cuda_runtime" / "include";
if (std::filesystem::exists(path)) {
args.push_back(fmt::format("--include-path={}", path.string()));
} else {
if (!std::filesystem::exists(path)) {
const char* home = std::getenv("CUDA_HOME");
if (!home) {
home = std::getenv("CUDA_PATH");
}
#if defined(__linux__)
if (!home) {
home = "/usr/local/cuda";
path = home ? std::filesystem::path(home) : default_cuda_toolkit_path();
if (!path.empty()) {
path = path / "include";
}
#endif
if (home && std::filesystem::exists(home)) {
args.push_back(fmt::format("--include-path={}/include", home));
} else {
if (path.empty() || !std::filesystem::exists(path)) {
throw std::runtime_error(
"Can not find locations of CUDA headers, please set environment "
"variable CUDA_HOME or CUDA_PATH.");
}
}
args.push_back(fmt::format("--include-path={}", path.string()));
return args;
}();
return cached_args;
@@ -424,20 +440,28 @@ CUfunction JitModule::get_kernel(
return get_kernel_and_dims(kernel_name, std::move(configure_kernel)).first;
}
std::unordered_map<std::string, JitModule>& get_jit_module_cache() {
static std::unordered_map<std::string, JitModule> map;
return map;
}
JitModule& get_jit_module(
const mlx::core::Device& device,
const std::string& name,
const KernelBuilder& builder,
bool cache) {
auto& map = get_jit_module_cache();
auto it = map.find(name);
if (it == map.end()) {
it = map.try_emplace(name, cu::device(device), name, builder, cache).first;
bool use_disk_cache) {
// The cache are leak intentionally as user code may still be running JIT
// compiled code after main thread teardown.
static auto* cache = new std::unordered_map<std::string, JitModule>;
static auto* mtx = new std::shared_mutex;
{
std::shared_lock rlock(*mtx);
if (auto it = cache->find(name); it != cache->end()) {
return it->second;
}
}
std::unique_lock wlock(*mtx);
auto it = cache->find(name);
if (it == cache->end()) {
auto& d = cu::device(device);
it = cache->try_emplace(name, d, name, builder, use_disk_cache).first;
}
return it->second;
}
+2 -3
View File
@@ -91,11 +91,12 @@ class JitModule {
Device& device,
const std::string& module_name,
const KernelBuilder& builder,
bool cache);
bool use_disk_cache);
~JitModule();
JitModule(const JitModule&) = delete;
JitModule& operator=(const JitModule&) = delete;
CUfunction get_kernel(
const std::string& kernel_name,
std::function<void(CUfunction)> configure_kernel = nullptr);
@@ -109,8 +110,6 @@ class JitModule {
kernels_;
};
std::unordered_map<std::string, JitModule>& get_jit_module_cache();
JitModule& get_jit_module(
const mlx::core::Device& device,
const std::string& name,
+2 -1
View File
@@ -89,7 +89,8 @@ using cuda_type_t = typename CTypeToCudaType<T>::type;
template <typename T>
inline constexpr bool is_floating_v =
cuda::std::is_same_v<T, float> || cuda::std::is_same_v<T, double> ||
cuda::std::is_same_v<T, float16_t> || cuda::std::is_same_v<T, bfloat16_t>;
cuda::std::is_same_v<T, float16_t> || cuda::std::is_same_v<T, bfloat16_t> ||
cuda::std::is_same_v<T, __half> || cuda::std::is_same_v<T, __nv_bfloat16>;
// Type traits for detecting complex numbers.
template <typename T>
+7 -1
View File
@@ -137,9 +137,15 @@ class LRUCache {
// Turn a POD struct into a container key by doing bytes compare.
//
// IMPORTANT: Do not use aggregate init on the pod field (key.pod = {...}).
// It creates a stack temporary whose padding bytes are uninitialized, and
// trivial copy-assignment copies the entire struct including padding —
// breaking the memcmp-based comparison. Set fields individually instead.
//
// Usage:
// BytesKey<MyKey> key;
// key.pod = { ... };
// key.pod.field1 = value1;
// key.pod.field2 = value2;
template <typename T>
struct BytesKey {
T pod;
+107 -59
View File
@@ -2,7 +2,9 @@
#include "mlx/backend/common/matmul.h"
#include "mlx/backend/cuda/device.h"
#include "mlx/backend/cuda/gemms/block_mask.h"
#include "mlx/backend/cuda/gemms/cublas_gemm.h"
#include "mlx/backend/cuda/gemms/gather_gemm.h"
#include "mlx/backend/cuda/gemms/gemv.h"
#include "mlx/backend/cuda/gemms/grouped_gemm.h"
#include "mlx/backend/gpu/copy.h"
@@ -136,40 +138,6 @@ void gemm_and_bias(
encoder, out, a, b, batch_shape, a_batch_strides, b_batch_strides, alpha);
}
void gather_mm_rhs(
const array& a_,
const array& b_,
const array& indices_,
array& out,
cu::CommandEncoder& encoder,
Stream s) {
if (a_.size() / a_.shape(-2) / a_.shape(-1) != indices_.size()) {
throw std::runtime_error("[gather_mm] Broadcasting lhs is not supported.");
}
int group_count = b_.size() / b_.shape(-1) / b_.shape(-2);
if (group_count > 1024) {
throw std::runtime_error(
"[gather_mm] Group count can not be larger than 1024.");
}
auto [a_transposed, lda, a] = ensure_batch_contiguous(a_, encoder, s);
auto [b_transposed, ldb, b] = ensure_batch_contiguous(b_, encoder, s);
auto indices = ensure_row_contiguous(indices_, encoder, s);
cutlass_grouped_gemm_unaligned(
a_transposed,
lda,
b_transposed,
ldb,
group_count,
a,
b,
indices,
out,
encoder);
}
} // namespace
void Matmul::eval_gpu(const std::vector<array>& inputs, array& out) {
@@ -203,6 +171,82 @@ void Matmul::eval_gpu(const std::vector<array>& inputs, array& out) {
encoder, M, N, K, a_transposed, lda, b_transposed, ldb, out, a, b);
}
void BlockMaskedMM::eval_gpu(const std::vector<array>& inputs, array& out) {
nvtx3::scoped_range r("BlockMaskedMM::eval_gpu");
if (!issubdtype(out.dtype(), floating)) {
throw std::runtime_error(
"[BlockMaskedMM] Does not yet support non-floating point types.");
}
auto& s = stream();
auto& encoder = cu::get_command_encoder(s);
auto& a_pre = inputs[0];
auto& b_pre = inputs[1];
// Return 0s if either input is empty.
if (a_pre.size() == 0 || b_pre.size() == 0) {
array zero(0, a_pre.dtype());
encoder.add_temporary(zero);
fill_gpu(zero, out, s);
return;
}
int M = a_pre.shape(-2);
int N = b_pre.shape(-1);
int K = a_pre.shape(-1);
if (M == 0 || N == 0) {
return;
}
if (K == 0) {
array zero(0, a_pre.dtype());
encoder.add_temporary(zero);
fill_gpu(zero, out, s);
return;
}
out.set_data(cu::malloc_async(out.nbytes(), encoder));
bool has_op_mask = inputs.size() > 3;
bool has_out_mask = inputs.size() == 3 || inputs.size() == 5;
int64_t batch_count = out.size() / (int64_t(M) * N);
bool a_transposed;
int64_t lda;
array a = a_pre;
bool b_transposed;
int64_t ldb;
array b = b_pre;
if (has_op_mask) {
// Fused copy + mask in a single pass per matrix.
auto& lhs_mask = inputs[inputs.size() - 2];
auto& rhs_mask = inputs[inputs.size() - 1];
a = copy_with_block_mask(
encoder, a_pre, lhs_mask, block_size_, M, K, batch_count);
b = copy_with_block_mask(
encoder, b_pre, rhs_mask, block_size_, K, N, batch_count);
a_transposed = false;
lda = K;
b_transposed = false;
ldb = N;
} else {
std::tie(a_transposed, lda, a) = check_transpose(encoder, s, a_pre);
std::tie(b_transposed, ldb, b) = check_transpose(encoder, s, b_pre);
}
// Run GEMM.
gemm_and_bias(
encoder, M, N, K, a_transposed, lda, b_transposed, ldb, out, a, b);
// Apply output mask.
if (has_out_mask) {
auto& out_mask = inputs[2];
apply_block_mask(encoder, out, out_mask, block_size_, M, N, batch_count);
}
}
void AddMM::eval_gpu(const std::vector<array>& inputs, array& out) {
nvtx3::scoped_range r("AddMM::eval_gpu");
auto& s = stream();
@@ -327,14 +371,12 @@ void GatherMM::eval_gpu(const std::vector<array>& inputs, array& out) {
auto& encoder = cu::get_command_encoder(s);
assert(inputs.size() == 4);
auto& a = inputs[0];
auto& b = inputs[1];
auto& lhs_indices = inputs[2];
auto& rhs_indices = inputs[3];
auto& a_pre = inputs[0];
auto& b_pre = inputs[1];
// Return 0s if either input is empty.
if (a.size() == 0 || b.size() == 0) {
array zero(0, a.dtype());
if (a_pre.size() == 0 || b_pre.size() == 0) {
array zero(0, a_pre.dtype());
encoder.add_temporary(zero);
fill_gpu(zero, out, s);
return;
@@ -343,31 +385,44 @@ void GatherMM::eval_gpu(const std::vector<array>& inputs, array& out) {
out.set_data(cu::malloc_async(out.nbytes(), encoder));
// Extract shapes from inputs.
int M = a.shape(-2);
int N = b.shape(-1);
int K = a.shape(-1);
int M = a_pre.shape(-2);
int N = b_pre.shape(-1);
int K = a_pre.shape(-1);
auto [a_transposed, lda, a] = ensure_batch_contiguous(a_pre, encoder, s);
auto [b_transposed, ldb, b] = ensure_batch_contiguous(b_pre, encoder, s);
auto lhs_indices = ensure_row_contiguous(inputs[2], encoder, s);
auto rhs_indices = ensure_row_contiguous(inputs[3], encoder, s);
// We are walking a in order and b is also in order so we can batch up the
// matmuls and reuse reading a and b.
if (M == 1 && right_sorted_ == true) {
gather_mm_rhs(a, b, rhs_indices, out, encoder, s);
cutlass_grouped_gemm_unaligned(
a_transposed,
lda,
b_transposed,
ldb,
b.size() / b.shape(-1) / b.shape(-2), // group_count
a,
b,
rhs_indices,
out,
encoder);
return;
}
auto [transposed_a, lda, a_] = check_transpose(encoder, s, a);
auto [transposed_b, ldb, b_] = check_transpose(encoder, s, b);
auto use_gemv = cu::can_use_gemv(M, N, K, transposed_a, transposed_b);
auto use_gemv = cu::can_use_gemv(M, N, K, a_transposed, b_transposed);
if (M == 1 && use_gemv) {
gather_mv(b_, a_, rhs_indices, lhs_indices, out, N, K, encoder);
gather_mv(b, a, rhs_indices, lhs_indices, out, N, K, encoder);
return;
}
if (N == 1 && use_gemv) {
gather_mv(a_, b_, lhs_indices, rhs_indices, out, M, K, encoder);
gather_mv(a, b, lhs_indices, rhs_indices, out, M, K, encoder);
return;
}
throw std::runtime_error("NYI");
cutlass_gather_mm(
a_transposed, b_transposed, a, b, lhs_indices, rhs_indices, out, encoder);
}
void SegmentedMM::eval_gpu(const std::vector<array>& inputs, array& out) {
@@ -396,14 +451,7 @@ void SegmentedMM::eval_gpu(const std::vector<array>& inputs, array& out) {
auto [a_transposed, lda, a] = check_transpose(encoder, s, a_pre);
auto [b_transposed, ldb, b] = check_transpose(encoder, s, b_pre);
auto segments = [&] {
if (segments_pre.flags().row_contiguous) {
return segments_pre;
}
array copy = contiguous_copy_gpu(segments_pre, s);
encoder.add_temporary(copy);
return copy;
}();
auto segments = ensure_row_contiguous(segments_pre, encoder, s);
cutlass_segmented_mm(
a_transposed,
-4
View File
@@ -24,9 +24,6 @@ namespace mlx::core {
throw std::runtime_error(#func " has no CUDA implementation."); \
}
NO_GPU(BlockMaskedMM)
NO_GPU(FFT)
NO_GPU(GatherQMM)
NO_GPU_MULTI(LUF)
NO_GPU_MULTI(QRF)
NO_GPU_MULTI(SVD)
@@ -34,7 +31,6 @@ NO_GPU(Inverse)
NO_GPU(Cholesky)
NO_GPU_MULTI(Eig)
NO_GPU_MULTI(Eigh)
NO_GPU(MaskedScatter)
namespace distributed {
NO_GPU_MULTI(Send)
+33 -8
View File
@@ -1,10 +1,35 @@
target_sources(
mlx
PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/qmm.cu
${CMAKE_CURRENT_SOURCE_DIR}/qmv.cu
${CMAKE_CURRENT_SOURCE_DIR}/fp_qmv.cu
${CMAKE_CURRENT_SOURCE_DIR}/qmm_impl_sm90_m128_n16_m1.cu
${CMAKE_CURRENT_SOURCE_DIR}/qmm_impl_sm90_m128_n32_m1.cu
${CMAKE_CURRENT_SOURCE_DIR}/qmm_impl_sm90_m128_n64_m2.cu
${CMAKE_CURRENT_SOURCE_DIR}/qmm_impl_sm90_m128_n128_m2.cu
${CMAKE_CURRENT_SOURCE_DIR}/qmm_impl_sm90_m128_n256_m2.cu)
PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/qmm.cu ${CMAKE_CURRENT_SOURCE_DIR}/qmv.cu
${CMAKE_CURRENT_SOURCE_DIR}/fp_qmv.cu)
foreach(TileN 16 32 64 128 256)
set(OUTPUT_FILE "qmm_sm90_impl_n${TileN}.cu")
configure_file("${CMAKE_CURRENT_SOURCE_DIR}/qmm_sm90.cu"
"${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_FILE}" @ONLY)
target_sources(mlx PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_FILE})
endforeach()
foreach(TileM 16 32 64)
set(OUTPUT_FILE "qmm_sm80_impl_m${TileM}.cu")
configure_file("${CMAKE_CURRENT_SOURCE_DIR}/qmm_sm80.cu"
"${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_FILE}" @ONLY)
target_sources(mlx PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_FILE})
endforeach()
foreach(TileM 16 32 64)
foreach(KMajor true false)
foreach(HasKResidue true false)
foreach(SM80 true false)
if(${KMajor} AND ${HasKResidue})
continue()
endif()
set(OUTPUT_FILE
"qmm_naive_impl_m${TileM}_${KMajor}_${HasKResidue}_${SM80}.cu")
configure_file("${CMAKE_CURRENT_SOURCE_DIR}/qmm_naive.cu"
"${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_FILE}" @ONLY)
target_sources(mlx PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_FILE})
endforeach()
endforeach()
endforeach()
endforeach()
@@ -0,0 +1,169 @@
// Copyright © 2026 Apple Inc.
#pragma once
#include <cute/numeric/numeric_types.hpp>
#include <cute/tensor.hpp>
#include <cutlass/numeric_conversion.h>
#include <cuda/std/array>
namespace cutlass {
using uint3b_t = integer_subbyte<3, false>;
using uint5b_t = integer_subbyte<5, false>;
template <typename T, int N, FloatRoundStyle Round>
struct NumericArrayConverter<T, uint3b_t, N, Round> {
static_assert(N % 8 == 0);
using result_type = Array<T, N>;
using source_type = Array<uint3b_t, N>;
CUTLASS_HOST_DEVICE
static result_type convert(const source_type& source) {
result_type result;
auto* s_base = reinterpret_cast<const uint8_t*>(&source);
CUTLASS_PRAGMA_UNROLL
for (int i = 0; i < N / 8; ++i) {
auto* s = s_base + i * 3;
result[i * 8] = T(s[0] & 0x07);
result[i * 8 + 1] = T((s[0] & 0x38) >> 3);
result[i * 8 + 2] = T((s[0] & 0xc0) >> 6) + T((s[1] & 0x01) << 2);
result[i * 8 + 3] = T((s[1] & 0x0e) >> 1);
result[i * 8 + 4] = T((s[1] & 0x70) >> 4);
result[i * 8 + 5] = T((s[1] & 0x80) >> 7) + T((s[2] & 0x03) << 1);
result[i * 8 + 6] = T((s[2] & 0x1c) >> 2);
result[i * 8 + 7] = T((s[2] & 0xe0) >> 5);
}
return result;
}
CUTLASS_HOST_DEVICE
result_type operator()(const source_type& s) const {
return convert(s);
}
};
template <typename T, int N, FloatRoundStyle Round>
struct NumericArrayConverter<T, uint5b_t, N, Round> {
static_assert(N % 8 == 0);
using result_type = Array<T, N>;
using source_type = Array<uint5b_t, N>;
CUTLASS_HOST_DEVICE
static result_type convert(const source_type& source) {
result_type result;
auto* s_base = reinterpret_cast<const uint8_t*>(&source);
CUTLASS_PRAGMA_UNROLL
for (int i = 0; i < N / 8; ++i) {
auto* s = s_base + i * 5;
result[i * 8] = T(s[0] & 0x1f);
result[i * 8 + 1] = T((s[0] & 0xe0) >> 5) + T((s[1] & 0x03) << 3);
result[i * 8 + 2] = T((s[1] & 0x7c) >> 2);
result[i * 8 + 3] = T((s[1] & 0x80) >> 7) + T((s[2] & 0x0f) << 1);
result[i * 8 + 4] = T((s[2] & 0xf0) >> 4) + T((s[3] & 0x01) << 4);
result[i * 8 + 5] = T((s[3] & 0x3e) >> 1);
result[i * 8 + 6] = T((s[3] & 0xc0) >> 6) + T((s[4] & 0x07) << 2);
result[i * 8 + 7] = T((s[4] & 0xf8) >> 3);
}
return result;
}
CUTLASS_HOST_DEVICE
result_type operator()(const source_type& s) const {
return convert(s);
}
};
template <typename T, int N, FloatRoundStyle Round>
struct NumericArrayConverter<T, uint6b_t, N, Round> {
static_assert(N % 4 == 0);
using result_type = Array<T, N>;
using source_type = Array<uint6b_t, N>;
CUTLASS_HOST_DEVICE
static result_type convert(const source_type& source) {
result_type result;
auto* s_base = reinterpret_cast<const uint8_t*>(&source);
CUTLASS_PRAGMA_UNROLL
for (int i = 0; i < N / 4; ++i) {
auto* s = s_base + i * 3;
result[i * 4] = T(s[0] & 0x3f);
result[i * 4 + 1] = T((s[0] >> 6) & 0x03) + T((s[1] & 0x0f) << 2);
result[i * 4 + 2] = T((s[1] >> 4) & 0x0f) + T((s[2] & 0x03) << 4);
result[i * 4 + 3] = T((s[2] >> 2) & 0x3f);
}
return result;
}
CUTLASS_HOST_DEVICE
result_type operator()(const source_type& s) const {
return convert(s);
}
};
} // namespace cutlass
namespace cute {
// Required by tiled copy for 3/5/6-bit weights.
struct uint24_t {
cuda::std::array<std::uint8_t, 3> bytes;
};
struct uint40_t {
cuda::std::array<std::uint8_t, 5> bytes;
};
struct uint48_t {
cuda::std::array<std::uint8_t, 6> bytes;
};
template <>
struct uint_bit<24> {
using type = uint24_t;
};
template <>
struct uint_bit<40> {
using type = uint40_t;
};
template <>
struct uint_bit<48> {
using type = uint48_t;
};
} // namespace cute
namespace cutlass_gemm {
// Whether the quant type is affine quantization.
template <typename Quant>
constexpr bool quant_has_bias_v = !cutlass::has_negative_zero_v<Quant>;
// Dequantize CuTe tensors with out = w * s + z.
__device__ __forceinline__ void
cute_vectorized_dequant(auto w, auto s, auto z, auto out) {
using namespace cute;
using Element = typename decltype(out)::value_type;
using Quant = typename decltype(w)::value_type;
// Scale must be one element.
CUTE_STATIC_ASSERT_V(cosize(s.layout()) == Int<1>{});
CUTE_STATIC_ASSERT_V(cosize(z.layout()) == Int<1>{});
// Quant must be contiguous.
auto layout = coalesce(w.layout());
CUTE_STATIC_ASSERT_V(stride(layout) == Int<1>{});
// Use cutlass for conversions.
constexpr int N = size(layout);
auto& w_vec = *(reinterpret_cast<const cutlass::Array<Quant, N>*>(
raw_pointer_cast(w.data())));
Element scale{s[0]};
cutlass::NumericArrayConverter<Element, Quant, N> converter;
auto w_dq = converter(w_vec) * scale;
if constexpr (quant_has_bias_v<Quant>) {
Element zero_point{z[0]};
w_dq = w_dq + zero_point;
}
copy(make_tensor(make_rmem_ptr<Element>(&w_dq), out.layout()), out);
}
} // namespace cutlass_gemm
+218 -19
View File
@@ -1,15 +1,25 @@
// Copyright © 2026 Apple Inc.
#include "mlx/backend/cuda/kernel_utils.cuh"
#include "mlx/backend/cuda/quantized/qmm/qmm.h"
#include <cute/tensor.hpp>
namespace mlx::core {
namespace {
inline bool is_last_2_dims_row_contiguous(const array& x) {
return x.flags().contiguous && (x.ndim() >= 2) && (x.strides(-1) == 1) &&
(x.strides(-2) == x.shape(-1));
}
} // namespace
#if defined(MLX_CUDA_SM90A_ENABLED)
// Defined in qmm_impl_sm90_xxx.cu files.
template <typename TileShape, typename ClusterShape>
void qmm_impl_sm90(
// Defined in qmm_sm90.cu.
template <int TileN>
void qmm_sm90_impl(
const array& x,
const array& w,
const array& scales,
@@ -42,8 +52,9 @@ bool supports_qmm_sm90(
if (!biases) {
return false;
}
if (!x.flags().row_contiguous || !w.flags().row_contiguous ||
!scales.flags().row_contiguous || !biases->flags().row_contiguous) {
if (!is_last_2_dims_row_contiguous(w) ||
!is_last_2_dims_row_contiguous(scales) ||
!is_last_2_dims_row_contiguous(*biases)) {
return false;
}
if (!transpose) {
@@ -72,24 +83,21 @@ void qmm_sm90(
cu::CommandEncoder& encoder,
Stream s) {
#if defined(MLX_CUDA_SM90A_ENABLED)
auto dispatch = [&]<int tile_m, int tile_n, int cluster_m>() {
using cute::Int;
using TileShapeMN = cute::Shape<Int<tile_m>, Int<tile_n>>;
using ClusterShape = cute::Shape<Int<cluster_m>, Int<1>, Int<1>>;
qmm_impl_sm90<TileShapeMN, ClusterShape>(
auto dispatch = [&]<int TileN>() {
qmm_sm90_impl<TileN>(
x, w, scales, biases, out, bits, group_size, encoder, s);
};
int m = out.shape(-2);
int m = out.ndim() > 1 ? out.shape(-2) : 1;
if (m <= 16) {
dispatch.template operator()<128, 16, 1>();
dispatch.template operator()<16>();
} else if (m <= 32) {
dispatch.template operator()<128, 32, 1>();
dispatch.template operator()<32>();
} else if (m <= 64) {
dispatch.template operator()<128, 64, 2>();
dispatch.template operator()<64>();
} else if (m <= 128) {
dispatch.template operator()<128, 128, 2>();
dispatch.template operator()<128>();
} else {
dispatch.template operator()<128, 256, 2>();
dispatch.template operator()<256>();
}
#else
throw std::runtime_error(
@@ -97,6 +105,197 @@ void qmm_sm90(
#endif // defined(MLX_CUDA_SM90A_ENABLED)
}
// Defined in qmm_sm80.cu.
template <int TileM>
void qmm_sm80_impl(
const array& x,
const array& w,
const array& scales,
const std::optional<array>& biases,
const std::optional<array>& lhs_indices,
const std::optional<array>& rhs_indices,
array& out,
int bits,
int group_size,
QuantizationMode mode,
cu::CommandEncoder& encoder);
bool supports_qmm_sm80(
const array& x,
const array& w,
const array& scales,
const std::optional<array>& biases,
const array& out,
bool transpose,
int bits,
int group_size,
QuantizationMode mode,
cu::Device& device) {
if (device.compute_capability_major() < 8) {
return false;
}
int n = out.shape(-1);
int k = x.shape(-1);
if ((n % 128 != 0) || (k % std::max(64, group_size) != 0)) {
return false;
}
if (!is_last_2_dims_row_contiguous(w) ||
!is_last_2_dims_row_contiguous(scales)) {
return false;
}
if (biases && !is_last_2_dims_row_contiguous(*biases)) {
return false;
}
if (x.dtype() != float16 && x.dtype() != bfloat16) {
return false;
}
if (!transpose) {
return false;
}
if (bits != 4 && bits != 8) {
return false;
}
return true;
}
void qmm_sm80(
const array& x,
const array& w,
const array& scales,
const std::optional<array>& biases,
const std::optional<array>& lhs_indices,
const std::optional<array>& rhs_indices,
array& out,
int bits,
int group_size,
QuantizationMode mode,
cu::CommandEncoder& encoder) {
auto dispatch = [&]<int TileM>() {
qmm_sm80_impl<TileM>(
x,
w,
scales,
biases,
lhs_indices,
rhs_indices,
out,
bits,
group_size,
mode,
encoder);
};
int m = out.ndim() > 1 ? out.shape(-2) : 1;
if (m <= 16) {
dispatch.template operator()<16>();
} else if (m <= 32) {
dispatch.template operator()<32>();
} else {
dispatch.template operator()<64>();
}
}
// Defined in qmm_naive.cu.
template <int TileM, bool KMajor, bool HasKResidue, bool SM80>
void qmm_naive_impl(
const array& x,
const array& w,
const array& scales,
const std::optional<array>& biases,
const std::optional<array>& lhs_indices,
const std::optional<array>& rhs_indices,
array& out,
int bits,
int group_size,
QuantizationMode mode,
cu::CommandEncoder& encoder);
bool supports_qmm_naive(
const array& x,
const array& w,
const array& scales,
const std::optional<array>& biases,
const array& out,
bool transpose,
int bits,
int group_size,
QuantizationMode mode,
cu::Device& device) {
int k = x.shape(-1);
if (transpose && (k % std::max(64, group_size) != 0)) {
return false;
}
if (!is_last_2_dims_row_contiguous(w) ||
!is_last_2_dims_row_contiguous(scales)) {
return false;
}
if (biases && !is_last_2_dims_row_contiguous(*biases)) {
return false;
}
return true;
}
void qmm_naive(
const array& x,
const array& w,
const array& scales,
const std::optional<array>& biases,
const std::optional<array>& lhs_indices,
const std::optional<array>& rhs_indices,
array& out,
bool transpose,
int bits,
int group_size,
QuantizationMode mode,
cu::CommandEncoder& encoder) {
auto dispatch = [&]<int TileM, bool KMajor, bool HasKResidue, bool SM80>() {
qmm_naive_impl<TileM, KMajor, HasKResidue, SM80>(
x,
w,
scales,
biases,
lhs_indices,
rhs_indices,
out,
bits,
group_size,
mode,
encoder);
};
auto dispatch_k = [&](auto k_major, bool has_k_residue, auto&& f) {
if constexpr (k_major.value) {
if (has_k_residue) {
throw std::invalid_argument(
"[quantized_matmul] K must be multiples of max(64, group_size).");
}
f.template operator()<false>();
} else {
dispatch_bool(has_k_residue, [&](auto has_k_residue) {
f.template operator()<has_k_residue.value>();
});
}
};
int m = out.ndim() > 1 ? out.shape(-2) : 1;
int k = x.shape(-1);
int tile_k = std::max(64, group_size);
bool has_k_residue = k % tile_k != 0;
bool sm80 = encoder.device().compute_capability_major() >= 8;
dispatch_bool(transpose, [&](auto k_major) {
dispatch_k(k_major, has_k_residue, [&]<bool HasKResidue>() {
dispatch_bool(sm80, [&](auto sm80) {
constexpr bool KMajor = k_major.value;
constexpr bool SM80 = sm80.value;
if (m <= 16) {
dispatch.template operator()<16, KMajor, HasKResidue, SM80>();
} else if (m <= 32) {
dispatch.template operator()<32, KMajor, HasKResidue, SM80>();
} else {
dispatch.template operator()<64, KMajor, HasKResidue, SM80>();
}
});
});
});
}
bool supports_fp_qmv(
const array& x,
const array& w,
@@ -144,11 +343,11 @@ bool supports_qmv(
if (k % 8 != 0) {
return false;
}
if (!x.flags().row_contiguous || !w.flags().row_contiguous ||
!scales.flags().row_contiguous) {
if (!is_last_2_dims_row_contiguous(w) ||
!is_last_2_dims_row_contiguous(scales)) {
return false;
}
if (biases && !biases->flags().row_contiguous) {
if (biases && !is_last_2_dims_row_contiguous(*biases)) {
return false;
}
if (!transpose) {
+64
View File
@@ -32,6 +32,57 @@ void qmm_sm90(
cu::CommandEncoder& encoder,
Stream s);
bool supports_qmm_sm80(
const array& x,
const array& w,
const array& scales,
const std::optional<array>& biases,
const array& out,
bool transpose,
int bits,
int group_size,
QuantizationMode mode,
cu::Device& device);
void qmm_sm80(
const array& x,
const array& w,
const array& scales,
const std::optional<array>& biases,
const std::optional<array>& lhs_indices,
const std::optional<array>& rhs_indices,
array& out,
int bits,
int group_size,
QuantizationMode mode,
cu::CommandEncoder& encoder);
bool supports_qmm_naive(
const array& x,
const array& w,
const array& scales,
const std::optional<array>& biases,
const array& out,
bool transpose,
int bits,
int group_size,
QuantizationMode mode,
cu::Device& device);
void qmm_naive(
const array& x,
const array& w,
const array& scales,
const std::optional<array>& biases,
const std::optional<array>& lhs_indices,
const std::optional<array>& rhs_indices,
array& out,
bool transpose,
int bits,
int group_size,
QuantizationMode mode,
cu::CommandEncoder& encoder);
bool supports_fp_qmv(
const array& x,
const array& w,
@@ -77,4 +128,17 @@ void qmv(
QuantizationMode mode,
cu::CommandEncoder& encoder);
void gather_qmv(
const array& x,
const array& w,
const array& scales,
const std::optional<array>& biases,
const array& lhs_indices,
const array& rhs_indices,
array& out,
int bits,
int group_size,
QuantizationMode mode,
cu::CommandEncoder& encoder);
} // namespace mlx::core
@@ -1,10 +0,0 @@
// Copyright © 2026 Apple Inc.
#include "mlx/backend/cuda/quantized/qmm/qmm_impl_sm90.cuh"
using namespace cute;
using TileShapeMN = Shape<_128, _128>;
using ClusterShape = Shape<_2, _1, _1>;
QMM_SM90_GPU(TileShapeMN, ClusterShape)
@@ -1,10 +0,0 @@
// Copyright © 2026 Apple Inc.
#include "mlx/backend/cuda/quantized/qmm/qmm_impl_sm90.cuh"
using namespace cute;
using TileShapeMN = Shape<_128, _16>;
using ClusterShape = Shape<_1, _1, _1>;
QMM_SM90_GPU(TileShapeMN, ClusterShape)
@@ -1,10 +0,0 @@
// Copyright © 2026 Apple Inc.
#include "mlx/backend/cuda/quantized/qmm/qmm_impl_sm90.cuh"
using namespace cute;
using TileShapeMN = Shape<_128, _256>;
using ClusterShape = Shape<_2, _1, _1>;
QMM_SM90_GPU(TileShapeMN, ClusterShape)
@@ -1,10 +0,0 @@
// Copyright © 2026 Apple Inc.
#include "mlx/backend/cuda/quantized/qmm/qmm_impl_sm90.cuh"
using namespace cute;
using TileShapeMN = Shape<_128, _32>;
using ClusterShape = Shape<_1, _1, _1>;
QMM_SM90_GPU(TileShapeMN, ClusterShape)
@@ -1,10 +0,0 @@
// Copyright © 2026 Apple Inc.
#include "mlx/backend/cuda/quantized/qmm/qmm_impl_sm90.cuh"
using namespace cute;
using TileShapeMN = Shape<_128, _64>;
using ClusterShape = Shape<_2, _1, _1>;
QMM_SM90_GPU(TileShapeMN, ClusterShape)
+545
View File
@@ -0,0 +1,545 @@
// Copyright © 2026 Apple Inc.
#include "mlx/backend/cuda/kernel_utils.cuh"
#include "mlx/backend/cuda/quantized/qmm/cute_dequant.cuh"
#include "mlx/backend/cuda/quantized/qmm/qmm.h"
#include "mlx/dtype_utils.h"
// clang-format off
// We can't put kernel code in mlx::core due to name conflicts of "Shape".
namespace cutlass_gemm {
using namespace cute;
template <typename Element, typename SmemLayoutA, typename SmemLayoutB>
struct SharedStorage {
ArrayEngine<Element, cosize_v<SmemLayoutA>> A;
ArrayEngine<Element, cosize_v<SmemLayoutB>> B;
};
__device__ __forceinline__ void
cute_naive_dequant(auto w, auto s, auto z, auto out) {
using Element = typename decltype(out)::value_type;
using Quant = typename decltype(w)::value_type;
using Scale = typename decltype(s)::value_type;
transform(w, out, [](Quant q) { return Element(q); } );
transform(out, s, out, [](Element e, Scale s) { return e * Element(s); });
if constexpr (quant_has_bias_v<Quant>) {
transform(out, z, out, plus{});
}
}
__device__ __forceinline__ void
cute_dequant(auto w, auto s, auto z, auto out) {
if constexpr (stride(coalesce(w.layout())) == Int<1>{} &&
is_static_v<decltype(s.layout())>) {
cute_vectorized_dequant(w, s, z, out);
} else {
cute_naive_dequant(w, s, z, out);
}
}
template <bool HasKResidue, typename ProblemShape, typename CtaTiler,
typename Element, typename Quant, typename Scale,
typename StrideA, typename SmemLayoutA, typename TiledCopyA,
typename StrideB, typename SmemLayoutB, typename TiledCopyB,
typename StrideC, typename LayoutS, typename TiledMma>
__global__ void qmm_naive_kernel(
ProblemShape shape_MNKL, CtaTiler cta_tiler,
const Element* A, StrideA dA, SmemLayoutA sA_layout, TiledCopyA copy_a,
const Quant* B, StrideB dB, SmemLayoutB sB_layout, TiledCopyB copy_b,
Element* C, StrideC dC,
const Scale* S, const Element* Z, LayoutS S_layout,
const uint32_t* lhs_indices, const uint32_t* rhs_indices,
TiledMma mma) {
CUTE_STATIC_ASSERT_V(size(copy_a) == size(mma));
CUTE_STATIC_ASSERT_V(size(copy_b) == size(mma));
CUTE_STATIC_ASSERT_V(congruent(select<0,2,3>(shape_MNKL), dA));
CUTE_STATIC_ASSERT_V(congruent(select<1,2,3>(shape_MNKL), dB));
CUTE_STATIC_ASSERT_V(congruent(select<0,1,3>(shape_MNKL), dC));
int thread_idx = int(threadIdx.x);
int m_coord = int(blockIdx.x);
int n_coord = int(blockIdx.y);
int l_coord = int(blockIdx.z);
auto m_max_coord = size<0>(shape_MNKL) - size<0>(cta_tiler) * m_coord; // M - BLK_M * m_coord
auto n_max_coord = size<1>(shape_MNKL) - size<1>(cta_tiler) * n_coord; // N - BLK_N * n_coord
// Shift tensor so we handle residue of K in the 0th tile.
auto shape_K = size<2>(shape_MNKL);
auto bK = size<2>(cta_tiler);
auto k_residue = shape_K - bK * ceil_div(shape_K, bK);
if constexpr (HasKResidue) {
A += k_residue * get<1>(dA);
B += k_residue * get<1>(dB) * cuda::std::min(8, sizeof_bits_v<Quant>) / 8;
S += k_residue * stride<1>(S_layout);
Z += k_residue * stride<1>(S_layout);
}
// Represent the full tensors.
Tensor mA_mkl = make_tensor(make_gmem_ptr(A), select<0,2,3>(shape_MNKL), dA); // (M,K,L)
Tensor mB_nkl = make_tensor(make_gmem_ptr<Quant>(B), select<1,2,3>(shape_MNKL), dB); // (N,K,L)
Tensor mC_mnl = make_tensor(make_gmem_ptr(C), select<0,1,3>(shape_MNKL), dC); // (M,N,L)
Tensor mS_nkl = make_tensor(make_gmem_ptr(S), S_layout); // (N,(group_size,K/group_size),L)
Tensor mZ_nkl = make_tensor(make_gmem_ptr(Z), S_layout); // (N,(group_size,K/group_size),L)
// For gather, use index lookup for input batch slicing.
uint32_t a_batch = lhs_indices ? lhs_indices[l_coord] : l_coord;
uint32_t b_batch = rhs_indices ? rhs_indices[l_coord] : l_coord;
// Get batch slice.
Tensor mA = mA_mkl(_,_,a_batch); // (M,K)
Tensor mB = mB_nkl(_,_,b_batch); // (N,K)
Tensor mC = mC_mnl(_,_,l_coord); // (M,N)
Tensor mS = mS_nkl(_,_,b_batch); // (N,(group_size,K/group_size))
Tensor mZ = mZ_nkl(_,_,b_batch); // (N,(group_size,K/group_size))
// Get the appropriate blocks for this thread block.
auto cta_coord = make_coord(m_coord, n_coord, _); // (m,n,k)
Tensor gA = local_tile(mA, cta_tiler, cta_coord, Step<_1, X,_1>{}); // (BLK_M,BLK_K,k)
Tensor gB = local_tile(mB, cta_tiler, cta_coord, Step< X,_1,_1>{}); // (BLK_N,BLK_K,k)
Tensor gC = local_tile(mC, cta_tiler, cta_coord, Step<_1,_1, X>{}); // (BLK_M,BLK_N)
Tensor gS = local_tile(mS, cta_tiler, cta_coord, Step< X,_1,_1>{}); // (BLK_N,BLK_K,k)
Tensor gZ = local_tile(mZ, cta_tiler, cta_coord, Step< X,_1,_1>{}); // (BLK_N,BLK_K,k)
// Shared memory buffers.
extern __shared__ char shared_memory[];
using SharedStorage = SharedStorage<Element, SmemLayoutA, SmemLayoutB>;
SharedStorage& smem = *reinterpret_cast<SharedStorage*>(shared_memory);
Tensor sA = make_tensor(make_smem_ptr(smem.A.begin()), sA_layout); // (BLK_M,BLK_K)
Tensor sB = make_tensor(make_smem_ptr(smem.B.begin()), sB_layout); // (BLK_N,BLK_K)
// Partition the copying of A/B/C tiles across the threads.
ThrCopy thr_copy_a = copy_a.get_slice(thread_idx);
Tensor tAgA = thr_copy_a.partition_S(gA); // (ACPY,ACPY_M,ACPY_K,k)
Tensor tAsA = thr_copy_a.partition_D(sA); // (ACPY,ACPY_M,ACPY_K)
Tensor tArA = make_fragment_like(tAsA); // (ACPY,ACPY_M,ACPY_K)
ThrCopy thr_copy_b = copy_b.get_slice(thread_idx);
Tensor tBgB = thr_copy_b.partition_S(gB); // (BCPY,BCPY_N,BCPY_K,k)
Tensor tBsB = thr_copy_b.partition_D(sB); // (BCPY,BCPY_N,BCPY_K)
Tensor tBrB = make_fragment_like<Quant>(tBsB); // (BCPY,BCPY_M,BCPY_K)
Tensor tBrB_dq = make_fragment_like(tBsB); // (BCPY,BCPY_M,BCPY_K)
Tensor tBgS = thr_copy_b.partition_S(gS); // (BCPY,BCPY_N,BCPY_K,k)
Tensor tBrS = make_fragment_like(tBgS(_,_,_,0)); // (BCPY,BCPY_N,BCPY_K)
Tensor tBgZ = thr_copy_b.partition_S(gZ); // (BCPY,BCPY_N,BCPY_K,k)
Tensor tBrZ = make_fragment_like(tBgZ(_,_,_,0)); // (BCPY,BCPY_N,BCPY_K)
// MMA.
ThrMMA thr_mma = mma.get_slice(thread_idx);
Tensor tCsA = thr_mma.partition_A(sA); // (MMA,MMA_M,MMA_K)
Tensor tCsB = thr_mma.partition_B(sB); // (MMA,MMA_N,MMA_K)
Tensor tCgC = thr_mma.partition_C(gC); // (MMA,MMA_M,MMA_N)
Tensor tCrC = thr_mma.make_fragment_C(tCgC); // (MMA,MMA_M,MMA_N)
// Predicates for m/n bounds.
Tensor tApA = make_tensor<bool>(make_shape(size<1>(tAsA), size<2>(tAsA)), Stride<_1,_0>{}); // (CPY_M,CPY_K)
Tensor tBpB = make_tensor<bool>(make_shape(size<1>(tBsB), size<2>(tBsB)), Stride<_1,_0>{}); // (CPY_N,CPY_K)
Tensor cA = make_identity_tensor(make_shape(size<0>(sA), size<1>(sA))); // (BLK_M,BLK_K)
Tensor cB = make_identity_tensor(make_shape(size<0>(sB), size<1>(sB))); // (BLK_N,BLK_K)
Tensor cC = make_identity_tensor(make_shape(size<0>(gC), size<1>(gC))); // (M,N)
Tensor tAcA = thr_copy_a.partition_S(cA); // (CPY,CPY_M,CPY_K)
Tensor tBcB = thr_copy_b.partition_S(cB); // (CPY,CPY_N,CPY_K)
Tensor tCcC = thr_mma.partition_C(cC); // (MMA,MMA_M,MMA_N)
CUTE_UNROLL
for (int m = 0; m < size<0>(tApA); ++m) {
tApA(m,0) = get<0>(tAcA(0,m,0)) < m_max_coord;
}
CUTE_UNROLL
for (int n = 0; n < size<0>(tBpB); ++n) {
tBpB(n,0) = get<0>(tBcB(0,n,0)) < n_max_coord;
}
// GMEM => RMEM.
auto fetch_gmem = [&](int tile) {
copy_if(copy_a, tApA, tAgA(_,_,_,tile), tArA);
copy_if(copy_b, tBpB, tBgB(_,_,_,tile), tBrB);
copy(tBgS(_,_,_,tile), tBrS);
copy(tBgZ(_,_,_,tile), tBrZ);
};
// RMEM => SMEM.
auto store_smem = [&]() {
__syncthreads();
copy(tArA, tAsA);
CUTE_UNROLL
for (int k = 0; k < size<2>(tBrB); ++k) {
CUTE_UNROLL
for (int n = 0; n < size<1>(tBrB); ++n) {
cute_dequant(tBrB(_,n,k), tBrS(_,n,k), tBrZ(_,n,k), tBrB_dq(_,n,k));
}
}
copy(tBrB_dq, tBsB);
__syncthreads();
};
// Clear the rmem tiles to account for predicated off loads.
if constexpr (HasKResidue) {
clear(tArA);
clear(tBrB);
clear(tBrS);
clear(tBrZ);
}
// Prefetch first tile.
if constexpr (HasKResidue) {
Tensor tAgA_k = tAgA(_,_,_,0);
CUTE_UNROLL
for (int k = 0; k < size<2>(tArA); ++k) {
if (get<1>(tAcA(0,0,k)) >= -k_residue) {
copy_if(copy_a, tApA(_,k), tAgA_k(_,_,k), tArA(_,_,k));
}
}
Tensor tBgB_k = tBgB(_,_,_,0);
Tensor tBgS_k = tBgS(_,_,_,0);
Tensor tBgZ_k = tBgZ(_,_,_,0);
CUTE_UNROLL
for (int k = 0; k < size<2>(tBrB); ++k) {
if (get<1>(tBcB(0,0,k)) >= -k_residue) {
copy_if(copy_b, tBpB(_,k), tBgB_k(_,_,k), tBrB(_,_,k));
copy(tBgS_k(_,_,k), tBrS(_,_,k));
copy(tBgZ_k(_,_,k), tBrZ(_,_,k));
}
}
} else {
fetch_gmem(0);
}
// Clear accumulators.
clear(tCrC);
// Loop over CTA tiles.
auto K_TILE_MAX = size<3>(tAgA);
for (int tile = 0; tile < K_TILE_MAX; ++tile) {
store_smem();
if constexpr (HasKResidue) {
// Avoid fetching full 0th-tile when there is residue.
if (K_TILE_MAX > 1) {
fetch_gmem((tile + 1 < K_TILE_MAX) ? tile + 1 : tile);
}
} else {
fetch_gmem((tile + 1 < K_TILE_MAX) ? tile + 1 : tile);
}
gemm(mma, tCsA, tCsB, tCrC);
}
// Epilogue.
CUTE_UNROLL
for (int i = 0; i < size(tCrC); ++i) {
if ((get<0>(tCcC(i)) < m_max_coord) && (get<1>(tCcC(i)) < n_max_coord)) {
tCgC(i) = Element(tCrC(i));
}
}
}
template <bool KMajor>
inline constexpr auto make_matrix_stride(auto m, auto k) {
if constexpr (KMajor) {
return cute::make_stride(k, cute::Int<1>{}, m * k);
} else {
return cute::make_stride(cute::Int<1>{}, m, m * k);
}
}
template <bool KMajor = true>
inline constexpr auto make_smem_layout(auto bM, auto bK) {
// TODO: Calculate swizzle based on tile shape.
if constexpr (KMajor) {
auto swizzle = composition(Swizzle<3,3,3>{},
Layout<Shape <_8,Shape <_8, _8>>,
Stride<_8,Stride<_1,_64>>>{});
return tile_to_shape(swizzle, make_shape(bM, bK));
} else {
auto swizzle = composition(Swizzle<3,3,3>{},
Layout<Shape<_64,_1>, Stride<_1,_64>>{});
return tile_to_shape(swizzle, make_shape(bM, bK));
}
}
template <int TileM, bool SM80, typename Element>
inline constexpr auto make_tiled_mma() {
using Atom = std::conditional_t<
SM80,
std::conditional_t<
std::is_same_v<Element, half_t>,
SM80_16x8x16_F32F16F16F32_TN,
std::conditional_t<
std::is_same_v<Element, bfloat16_t>,
SM80_16x8x16_F32BF16BF16F32_TN,
UniversalFMA<float>
>
>,
UniversalFMA<float, Element, Element>>;
if constexpr (!SM80 || std::is_same_v<Element, float>) {
return make_tiled_mma(Atom{}, Layout<Shape<_16,_8,_1>>{});
} else {
if constexpr (TileM >= 32) {
return make_tiled_mma(Atom{}, Layout<Shape<_2,_2,_1>>{}, Tile<_32,_32,_16>{});
} else {
return make_tiled_mma(Atom{}, Layout<Shape<_1,_4,_1>>{}, Tile<_16,_32,_16>{});
}
}
}
template <typename T, bool KMajor = true, bool HasKResidue = false>
inline auto make_tiled_copy(auto num_threads, auto bM, auto bK) {
// TODO: Only do 1-element read for the tile of residue.
auto n_read = Int<HasKResidue ? 1 : 8>{};
auto atom = Copy_Atom<UniversalCopy<uint_bit_t<n_read * sizeof_bits_v<T>>>, T>{};
if constexpr (KMajor) {
auto k_threads = bK / n_read;
return make_tiled_copy(
atom,
make_layout(make_shape(Int<num_threads / k_threads>{}, k_threads), LayoutRight{}),
make_layout(make_shape(Int<1>{}, n_read)));
} else {
auto m_threads = bM / n_read;
return make_tiled_copy(
atom,
make_layout(make_shape(m_threads, Int<num_threads / m_threads>{}), LayoutLeft{}),
make_layout(make_shape(n_read, Int<1>{})));
}
}
template <bool KMajor>
inline constexpr auto make_scales_layout(auto n, auto k, auto l, auto group_size) {
if constexpr (KMajor) {
return make_layout(
make_shape(n, make_shape(group_size, k / group_size), l),
make_stride(k / group_size, Stride<_0,_1>{}, n * k / group_size));
} else {
return make_layout(
make_shape(make_shape(group_size, n / group_size), k, l),
make_stride(Stride<_0,_1>{}, n / group_size, n * k / group_size));
}
}
template <int TileM = 16, bool KMajor = true, bool HasKResidue = false, bool SM80 = true,
typename Element, typename Quant, typename Scale>
void qmm_naive(
const Element* A,
const Quant* B,
const Scale* S,
const Element* Z,
const uint32_t* lhs_indices,
const uint32_t* rhs_indices,
Element* C,
int m, int n, int k, int l,
bool broadcast_b,
auto group_size,
auto&& launch_kernel) {
// Define shapes (dynamic).
auto prob_shape = make_shape(m, n, k, l); // (M,N,K,L)
// Define TN strides (mixed).
auto dA = make_stride(k, Int<1>{}, m * k); // (dM,dK,dL)
auto dB = make_matrix_stride<KMajor>(n, k); // (dN,dK,dL)
auto dC = make_stride(n, Int<1>{}, m * n); // (dM,dN,dL)
// Define layout of scales/biases (mixed).
auto S_layout = make_scales_layout<KMajor>(n, k, l, group_size);
// Handle broadcasting.
if (broadcast_b) {
get<2>(dB) = 0;
get<2>(stride(S_layout)) = 0;
}
// Define CTA tile sizes (static).
auto bM = Int<TileM>{};
auto bN = Int<(!SM80 && group_size > 64) ? 64 : 128>{};
auto bK = Int<max(64, group_size)>{};
auto cta_tiler = make_shape(bM, bN, bK); // (BLK_M,BLK_N,BLK_K)
// Define MMA.
TiledMMA mma = make_tiled_mma<TileM, SM80, Element>();
auto num_threads = size(mma);
// Define the A/B smem layouts (static).
auto sA_layout = make_smem_layout(bM, bK);
auto sB_layout = make_smem_layout<KMajor>(bN, bK);
// Atoms.
TiledCopy copy_a = make_tiled_copy<Element, true, HasKResidue>(num_threads, bM, bK);
TiledCopy copy_b = make_tiled_copy<Quant, KMajor>(num_threads, bN, bK);
auto* kernel = &qmm_naive_kernel<
HasKResidue, decltype(prob_shape), decltype(cta_tiler),
Element, Quant, Scale,
decltype(dA), decltype(sA_layout), decltype(copy_a),
decltype(dB), decltype(sB_layout), decltype(copy_b),
decltype(dC), decltype(S_layout), decltype(mma)>;
// Set L1 to be SMEM only.
size_t smem_bytes = sizeof(SharedStorage<Element, decltype(sA_layout), decltype(sB_layout)>);
cudaFuncSetAttribute(kernel, cudaFuncAttributeMaxDynamicSharedMemorySize, smem_bytes);
cudaFuncSetAttribute(kernel, cudaFuncAttributePreferredSharedMemoryCarveout, 100);
dim3 num_blocks(size(ceil_div(m, bM)), size(ceil_div(n, bN)), l);
dim3 block_dims(num_threads);
void* args[] = {
&prob_shape, &cta_tiler,
&A, &dA, &sA_layout, &copy_a,
&B, &dB, &sB_layout, &copy_b,
&C, &dC,
&S, &Z, &S_layout,
&lhs_indices, &rhs_indices,
&mma};
launch_kernel(reinterpret_cast<void*>(kernel), num_blocks, block_dims, smem_bytes, args);
}
} // namespace cutlass_gemm
// clang-format on
namespace mlx::core {
template <typename F>
inline void dispatch_element_types(Dtype dtype, const char* tag, F&& f) {
if (dtype == float32) {
f.template operator()<float>();
} else if (dtype == float16) {
f.template operator()<cutlass::half_t>();
} else if (dtype == bfloat16) {
f.template operator()<cutlass::bfloat16_t>();
} else {
throw std::invalid_argument(
fmt::format("{} Unsupported dtype: {}.", tag, dtype_to_string(dtype)));
}
}
template <typename F>
inline void dispatch_groups(int group_size, const char* tag, F&& f) {
if (group_size == 32) {
f.template operator()<32>();
} else if (group_size == 64) {
f.template operator()<64>();
} else if (group_size == 128) {
f.template operator()<128>();
} else {
throw std::invalid_argument(
fmt::format("{} Group size {} is not supported.", tag, group_size));
}
}
template <typename T, typename F>
inline void dispatch_quant_types(
int bits,
int group_size,
QuantizationMode mode,
const char* tag,
F&& f) {
if (mode == QuantizationMode::Mxfp4) {
f.template operator()<cutlass::float_e2m1_t, cutlass::float_ue8m0_t, 32>();
} else if (mode == QuantizationMode::Mxfp8) {
f.template operator()<cutlass::float_e4m3_t, cutlass::float_ue8m0_t, 32>();
} else if (mode == QuantizationMode::Nvfp4) {
f.template operator()<cutlass::float_e2m1_t, cutlass::float_e4m3_t, 16>();
} else {
dispatch_groups(group_size, tag, [&]<int group_size>() {
if (bits == 2) {
f.template operator()<cutlass::uint2b_t, T, group_size>();
} else if (bits == 3) {
f.template operator()<cutlass::uint3b_t, T, group_size>();
} else if (bits == 4) {
f.template operator()<cutlass::uint4b_t, T, group_size>();
} else if (bits == 5) {
f.template operator()<cutlass::uint5b_t, T, group_size>();
} else if (bits == 6) {
f.template operator()<cutlass::uint6b_t, T, group_size>();
} else if (bits == 8) {
f.template operator()<uint8_t, T, group_size>();
} else {
throw std::invalid_argument(
fmt::format("{} {}-bit quantization is not supported.", tag, bits));
}
});
}
}
template <int TileM, bool KMajor, bool HasKResidue, bool SM80>
void qmm_naive_impl(
const array& x,
const array& w,
const array& scales,
const std::optional<array>& biases,
const std::optional<array>& lhs_indices,
const std::optional<array>& rhs_indices,
array& out,
int bits,
int group_size,
QuantizationMode mode,
cu::CommandEncoder& encoder) {
const char* tag = "[quantized_matmul]";
int m = out.ndim() > 1 ? out.shape(-2) : 1;
int n = out.shape(-1);
int k = x.shape(-1);
int l = out.size() / (m * n);
bool broadcast_b = (w.ndim() <= 2) || (w.size() != w.data_size());
dispatch_element_types(out.dtype(), tag, [&]<typename Element>() {
dispatch_quant_types<Element>(
bits,
group_size,
mode,
tag,
[&]<typename Quant, typename Scale, int group_size>() {
encoder.set_input_array(x);
encoder.set_input_array(w);
encoder.set_input_array(scales);
if (biases) {
encoder.set_input_array(*biases);
}
if (lhs_indices) {
encoder.set_input_array(*lhs_indices);
}
if (rhs_indices) {
encoder.set_input_array(*rhs_indices);
}
encoder.set_output_array(out);
cutlass_gemm::qmm_naive<TileM, KMajor, HasKResidue, SM80>(
gpu_ptr<Element>(x),
gpu_ptr<Quant>(w),
gpu_ptr<Scale>(scales),
biases ? gpu_ptr<Element>(*biases) : nullptr,
lhs_indices ? gpu_ptr<uint32_t>(*lhs_indices) : nullptr,
rhs_indices ? gpu_ptr<uint32_t>(*rhs_indices) : nullptr,
gpu_ptr<Element>(out),
m,
n,
k,
l,
broadcast_b,
cute::Int<group_size>{},
[&](auto* kernel,
dim3 num_blocks,
dim3 block_dims,
uint32_t smem_bytes,
void** args) {
encoder.add_kernel_node_raw(
kernel, num_blocks, block_dims, {}, smem_bytes, args);
});
});
});
}
// clang-format off
template void qmm_naive_impl<@TileM@, @KMajor@, @HasKResidue@, @SM80@>(
const array& x,
const array& w,
const array& scales,
const std::optional<array>& biases,
const std::optional<array>& lhs_indices,
const std::optional<array>& rhs_indices,
array& out,
int bits,
int group_size,
QuantizationMode mode,
cu::CommandEncoder& encoder);
// clang-format on
} // namespace mlx::core
+519
View File
@@ -0,0 +1,519 @@
// Copyright © 2026 Apple Inc.
#include "mlx/backend/cuda/quantized/qmm/cute_dequant.cuh"
#include "mlx/backend/cuda/quantized/qmm/qmm.h"
#include "mlx/dtype_utils.h"
// clang-format off
// We can't put kernel code in mlx::core due to name conflicts of "Shape".
namespace cutlass_gemm {
using namespace cute;
template <typename Element,
typename Quant,
typename SmemLayoutA,
typename SmemLayoutB,
typename SmemLayoutC>
union SharedStorage {
struct {
ArrayEngine<Element, cosize_v<SmemLayoutA>> A;
ArrayEngine<Quant, cosize_v<SmemLayoutB>> B;
} mainloop;
struct {
ArrayEngine<Element, cosize_v<SmemLayoutC>> C;
} epilogue;
};
template <typename ProblemShape, typename CtaTiler,
typename Element, typename Quant, typename Scale,
typename StrideA, typename SmemLayoutA, typename TiledCopyA, typename S2RAtomA,
typename StrideB, typename SmemLayoutB, typename TiledCopyB, typename S2RAtomB,
typename StrideC, typename SmemLayoutC, typename TiledCopyC, typename R2SAtomC,
typename LayoutS, typename G2RAtomS, typename TiledMma>
__global__ void qmm_sm80_kernel(
ProblemShape shape_MNKL, CtaTiler cta_tiler,
const Element* A, StrideA dA, SmemLayoutA sA_layout, TiledCopyA g2s_copy_a, S2RAtomA s2r_atom_a,
const Quant* B, StrideB dB, SmemLayoutB sB_layout, TiledCopyB g2s_copy_b, S2RAtomB s2r_atom_b,
Element* C, StrideC dC, SmemLayoutC sC_layout, TiledCopyC s2g_copy_c, R2SAtomC r2s_atom_c,
const Scale* S, const Element* Z, LayoutS S_layout, G2RAtomS g2r_atom_s,
const uint32_t* lhs_indices, const uint32_t* rhs_indices,
TiledMma mma) {
CUTE_STATIC_ASSERT_V(size(g2s_copy_a) == size(mma));
CUTE_STATIC_ASSERT_V(size(g2s_copy_b) == size(mma));
CUTE_STATIC_ASSERT_V(size(s2g_copy_c) == size(mma));
CUTE_STATIC_ASSERT_V(congruent(select<0,2,3>(shape_MNKL), dA));
CUTE_STATIC_ASSERT_V(congruent(select<1,2,3>(shape_MNKL), dB));
CUTE_STATIC_ASSERT_V(congruent(select<0,1,3>(shape_MNKL), dC));
int thread_idx = int(threadIdx.x);
int m_coord = int(blockIdx.x);
int n_coord = int(blockIdx.y);
int l_coord = int(blockIdx.z);
// For gather, use index lookup for input batch slicing.
uint32_t a_batch = lhs_indices ? lhs_indices[l_coord] : l_coord;
uint32_t b_batch = rhs_indices ? rhs_indices[l_coord] : l_coord;
// Represent the full tensors.
Tensor mA_mkl = make_tensor(make_gmem_ptr(A), select<0,2,3>(shape_MNKL), dA); // (M,K,L)
Tensor mB_nkl = make_tensor(make_gmem_ptr<Quant>(B), select<1,2,3>(shape_MNKL), dB); // (N,K,L)
Tensor mC_mnl = make_tensor(make_gmem_ptr(C), select<0,1,3>(shape_MNKL), dC); // (M,N,L)
Tensor mS_nkl = make_tensor(make_gmem_ptr(S), S_layout); // (N,(group_size,K/group_size),L)
Tensor mZ_nkl = make_tensor(make_gmem_ptr(Z), S_layout); // (N,(group_size,K/group_size),L)
// Get batch slice.
Tensor mA = mA_mkl(_,_,a_batch); // (M,K)
Tensor mB = mB_nkl(_,_,b_batch); // (N,K)
Tensor mC = mC_mnl(_,_,l_coord); // (M,N)
Tensor mS = mS_nkl(_,_,b_batch); // (N,(group_size,K/group_size))
Tensor mZ = mZ_nkl(_,_,b_batch); // (N,(group_size,K/group_size))
// Get the appropriate blocks for this thread block.
auto cta_coord = make_coord(m_coord, n_coord, _); // (m,n,k)
Tensor gA = local_tile(mA, cta_tiler, cta_coord, Step<_1, X,_1>{}); // (BLK_M,BLK_K,k)
Tensor gB = local_tile(mB, cta_tiler, cta_coord, Step< X,_1,_1>{}); // (BLK_N,BLK_K,k)
Tensor gC = local_tile(mC, cta_tiler, cta_coord, Step<_1,_1, X>{}); // (BLK_M,BLK_N)
Tensor gS = local_tile(mS, cta_tiler, cta_coord, Step< X,_1,_1>{}); // (BLK_N,BLK_K,k)
Tensor gZ = local_tile(mZ, cta_tiler, cta_coord, Step< X,_1,_1>{}); // (BLK_N,BLK_K,k)
// Shared memory buffers.
extern __shared__ char shared_memory[];
using SharedStorage = SharedStorage<Element, Quant,
SmemLayoutA,
SmemLayoutB,
SmemLayoutC>;
SharedStorage& smem = *reinterpret_cast<SharedStorage*>(shared_memory);
Tensor sA = make_tensor(make_smem_ptr(smem.mainloop.A.begin()), sA_layout); // (BLK_M,BLK_K)
Tensor sB = make_tensor(make_smem_ptr(smem.mainloop.B.begin()), sB_layout); // (BLK_N,BLK_K)
Tensor sC = make_tensor(make_smem_ptr(smem.epilogue.C.begin()), sC_layout); // (BLK_M,BLK_N)
// Partition the copying of A/B/C tiles across the threads.
ThrCopy g2s_thr_copy_a = g2s_copy_a.get_slice(thread_idx);
Tensor tAgA = g2s_thr_copy_a.partition_S(gA); // (ACPY,ACPY_M,ACPY_K,k)
Tensor tAsA = g2s_thr_copy_a.partition_D(sA); // (ACPY,ACPY_M,ACPY_K,PIPE)
ThrCopy g2s_thr_copy_b = g2s_copy_b.get_slice(thread_idx);
Tensor tBgB = g2s_thr_copy_b.partition_S(gB); // (BCPY,BCPY_N,BCPY_K,k)
Tensor tBsB = g2s_thr_copy_b.partition_D(sB); // (BCPY,BCPY_N,BCPY_K,PIPE)
ThrCopy s2g_thr_copy_c = s2g_copy_c.get_slice(thread_idx);
Tensor s2g_tCsC = s2g_thr_copy_c.partition_S(sC); // (CCPY,CCPY_M,CCPY_N)
Tensor s2g_tCgC = s2g_thr_copy_c.partition_D(gC); // (CCPY,CCPY_M,CCPY_N)
// MMA.
ThrMMA thr_mma = mma.get_slice(thread_idx);
Tensor tCrA = thr_mma.partition_fragment_A(sA(_,_,0)); // (MMA,MMA_M,MMA_K)
Tensor tCsB = thr_mma.partition_B(sB(_,_,0)); // (MMA,MMA_N,MMA_K)
Tensor tCrB = make_fragment_like<Quant>(tCsB); // (MMA,MMA_N,MMA_K)
Tensor tCrB_dq = make_fragment_like<Element>(tCsB); // (MMA,MMA_N,MMA_K)
Tensor tCgC = thr_mma.partition_C(gC); // (MMA,MMA_M,MMA_N)
Tensor tCrC_accu = make_fragment_like<float>(tCgC); // (MMA,MMA_M,MMA_N)
Tensor tCrC = make_fragment_like<Element>(tCgC); // (MMA,MMA_M,MMA_N)
Tensor tCgS = thr_mma.partition_B(gS); // (MMA,MMA_N,MMA_K,k)
Tensor tCrS = make_tensor_like(tCgS(_,_,_,0)); // (MMA,MMA_N,MMA_K)
Tensor tCgZ = thr_mma.partition_B(gZ); // (MMA,MMA_N,MMA_K,k)
Tensor tCrZ = make_tensor_like(tCgZ(_,_,_,0)); // (MMA,MMA_N,MMA_K)
// Copy Atom retiling.
TiledCopy s2r_copy_a = make_tiled_copy_A(s2r_atom_a, mma);
ThrCopy s2r_thr_copy_a = s2r_copy_a.get_slice(thread_idx);
Tensor s2r_tCsA = s2r_thr_copy_a.partition_S(sA); // (ACPY,MMA_M,MMA_K,PIPE)
Tensor s2r_tCrA = s2r_thr_copy_a.retile_D(tCrA); // (ACPY,MMA_M,MMA_K)
TiledCopy s2r_copy_b = make_tiled_copy_B(s2r_atom_b, mma);
ThrCopy s2r_thr_copy_b = s2r_copy_b.get_slice(thread_idx);
Tensor s2r_tCsB = s2r_thr_copy_b.partition_S(sB); // (BCPY,MMA_N,MMA_K,PIPE)
Tensor s2r_tCrB = s2r_thr_copy_b.retile_D(tCrB); // (BCPY,MMA_N,MMA_K)
TiledCopy r2s_copy_c = make_tiled_copy_C(r2s_atom_c, mma);
ThrCopy r2s_thr_copy_c = r2s_copy_c.get_slice(thread_idx);
Tensor r2s_tCrC = r2s_thr_copy_c.retile_S(tCrC); // (CCPY,MMA_M,MMA_N)
Tensor r2s_tCsC = r2s_thr_copy_c.partition_D(sC); // (CCPY,MMA_M,MMA_N)
TiledCopy g2r_copy_s = make_tiled_copy_B(g2r_atom_s, mma);
ThrCopy g2r_thr_copy_s = g2r_copy_s.get_slice(thread_idx);
Tensor g2r_tCgS = g2r_thr_copy_s.partition_S(gS); // (BCPY,MMA_N,MMA_K,k)
Tensor g2r_tCrS = g2r_thr_copy_s.retile_D(tCrS); // (BCPY,MMA_N,MMA_K)
Tensor g2r_tCgZ = g2r_thr_copy_s.partition_S(gZ); // (BCPY,MMA_N,MMA_K,k)
Tensor g2r_tCrZ = g2r_thr_copy_s.retile_D(tCrZ); // (BCPY,MMA_N,MMA_K)
// Predicates for m bound.
auto m_max_coord = size<0>(shape_MNKL) - size<0>(gA) * m_coord; // M - BLK_M * m_coord
Tensor tApA = make_tensor<bool>(make_shape(size<1>(tAsA), size<2>(tAsA)), Stride<_1,_0>{}); // (CPY_M,CPY_K)
Tensor tCpC = make_tensor<bool>(make_shape(size<1>(s2g_tCsC), size<2>(s2g_tCsC)), Stride<_1,_0>{}); // (CPY_M,CPY_N)
Tensor cA = make_identity_tensor(make_shape(size<0>(sA), size<1>(sA))); // (BLK_M,BLK_K)
Tensor cC = make_identity_tensor(make_shape(size<0>(sC), size<1>(sC))); // (BLK_M,BLK_N)
Tensor tAcA = g2s_thr_copy_a.partition_D(cA); // (CPY,CPY_M,CPY_K)
Tensor tCcC = s2g_thr_copy_c.partition_D(cC); // (CPY,CPY_M,CPY_N)
CUTE_UNROLL
for (int m = 0; m < size<0>(tApA); ++m) {
tApA(m,0) = get<0>(tAcA(0,m,0)) < m_max_coord;
}
CUTE_UNROLL
for (int m = 0; m < size<0>(tCpC); ++m) {
tCpC(m,0) = get<0>(tCcC(0,m,0)) < m_max_coord;
}
auto K_PIPE_MAX = size<3>(tAsA);
int smem_pipe_read = 0;
int smem_pipe_write = 0;
// Copy A/B: GMEM => SMEM.
auto fetch_gmem = [&](int tile) {
copy_if(g2s_copy_a, tApA, tAgA(_,_,_,tile), tAsA(_,_,_,smem_pipe_write));
copy(g2s_copy_b, tBgB(_,_,_,tile), tBsB(_,_,_,smem_pipe_write));
cp_async_fence();
smem_pipe_write = (smem_pipe_write + 1) % K_PIPE_MAX;
};
// Copy S/Z: GMEM => RMEM.
auto fetch_scales = [&](int tile) {
copy(g2r_copy_s, g2r_tCgS(_,_,_,tile), g2r_tCrS);
if constexpr (quant_has_bias_v<Quant>) {
copy(g2r_copy_s, g2r_tCgZ(_,_,_,tile), g2r_tCrZ);
}
};
// Copy A/B: SMEM => RMEM.
auto fetch_smem = [&](auto block) {
copy(s2r_atom_a, s2r_tCsA(_,_,block,smem_pipe_read), s2r_tCrA(_,_,block));
copy(s2r_atom_b, s2r_tCsB(_,_,block,smem_pipe_read), s2r_tCrB(_,_,block));
CUTE_UNROLL
for (int n = 0; n < size<1>(tCrB); ++n) {
cute_vectorized_dequant(
tCrB(_,n,block),
tCrS(_,n,block),
tCrZ(_,n,block),
tCrB_dq(_,n,block));
}
};
auto K_TILE_MAX = size<3>(tAgA);
auto K_BLOCK_MAX = size<2>(tCrA);
// Prefetch beginning tiles.
int tile_pipe = 0;
CUTE_UNROLL
for (; tile_pipe < K_PIPE_MAX - 1; ++tile_pipe) {
fetch_gmem(tile_pipe);
}
// Clear accumulators.
clear(tCrC_accu);
// Prefetch first block.
if constexpr (K_BLOCK_MAX > 1) {
cp_async_wait<K_PIPE_MAX - 2>();
__syncthreads();
fetch_scales(0);
fetch_smem(Int<0>{});
}
// Loop over CTA tiles.
for (int tile = 0; tile < K_TILE_MAX; ++tile) {
// Unroll MMA blocks.
CUTE_UNROLL
for (int block = 0; block < K_BLOCK_MAX; ++block) {
// Wait for last tile.
if (block == K_BLOCK_MAX - 1) {
smem_pipe_read = (smem_pipe_read + 1) % K_PIPE_MAX;
cp_async_wait<K_PIPE_MAX - 2>();
__syncthreads();
fetch_scales((tile + 1 < K_TILE_MAX) ? tile + 1 : tile);
}
// Prefetch next block.
fetch_smem((block + 1) % K_BLOCK_MAX);
// Prefetch next tile.
if (block == 0) {
fetch_gmem(tile_pipe);
tile_pipe = (tile_pipe + 1 < K_TILE_MAX) ? tile_pipe + 1 : tile_pipe;
}
// MMA.
gemm(mma, tCrA(_,_,block), tCrB_dq(_,_,block), tCrC_accu);
}
}
// Epilogue.
CUTE_UNROLL
for (int i = 0; i < size(tCrC_accu); i++) {
tCrC(i) = Element(tCrC_accu(i));
}
copy(r2s_copy_c, r2s_tCrC, r2s_tCsC);
__syncthreads();
copy_if(s2g_copy_c, tCpC, s2g_tCsC, s2g_tCgC);
}
template <typename Element>
inline constexpr auto make_mma_atom() {
if constexpr (std::is_same_v<Element, half_t>) {
return SM80_16x8x16_F32F16F16F32_TN{};
}
if constexpr (std::is_same_v<Element, bfloat16_t>) {
return SM80_16x8x16_F32BF16BF16F32_TN{};
}
}
template <int TileM, typename Element>
inline constexpr auto make_tiled_mma() {
constexpr auto atom = make_mma_atom<Element>();
if constexpr (TileM >= 32) {
return make_tiled_mma(atom, Layout<Shape<_2,_2,_1>>{}, Tile<_32,_32,_16>{});
} else {
return make_tiled_mma(atom, Layout<Shape<_1,_4,_1>>{}, Tile<_16,_32,_16>{});
}
}
template <typename T, int bits, template <typename U> typename Atom, typename NumThreads>
inline auto make_tiled_copy(NumThreads num_threads) {
return make_tiled_copy(
Copy_Atom<Atom<uint_bit_t<bits>>, T>{},
make_layout(make_shape(Int<num_threads / 8>{}, Int<8>{}), LayoutRight{}),
make_layout(make_shape(Int<1>{}, Int<bits / sizeof_bits_v<T>>{})));
}
template <int TileM = 16, typename Element, typename Quant, typename Scale, typename GroupSize>
void qmm_sm80(
const Element* A,
const Quant* B,
const Scale* S,
const Element* Z,
const uint32_t* lhs_indices,
const uint32_t* rhs_indices,
Element* C,
int m, int n, int k, int l,
bool broadcast_b,
GroupSize group_size,
auto&& launch_kernel) {
// Define shapes (dynamic).
auto prob_shape = make_shape(m, n, k, l); // (M,N,K,L)
// Define TN strides (mixed).
auto dA = make_stride(k, Int<1>{}, m * k); // (dM,dK,dL)
auto dB = make_stride(k, Int<1>{}, n * k); // (dN,dK,dL)
auto dC = make_stride(n, Int<1>{}, m * n); // (dM,dN,dL)
// Define layout of scales/biases (mixed).
auto S_layout = make_layout(
make_shape(n, make_shape(group_size, k / group_size), l),
make_stride(k / group_size, Stride<_0, _1>{}, n * k / group_size));
// Handle broadcasting.
if (broadcast_b) {
get<2>(dB) = 0;
get<2>(stride(S_layout)) = 0;
}
// Define CTA tile sizes (static).
auto bM = Int<TileM>{};
auto bN = Int<128>{};
auto bK = Int<max(64, group_size)>{};
auto cta_tiler = make_shape(bM, bN, bK); // (BLK_M,BLK_N,BLK_K)
// Define MMA.
TiledMMA mma = make_tiled_mma<TileM, Element>();
auto num_threads = size(mma);
// Define the A/B smem layouts (static).
auto swizzle_ab = composition(Swizzle<3,3,3>{},
Layout<Shape <_8,Shape <_8, _8>>,
Stride<_8,Stride<_1,_64>>>{});
auto bP = Int<3>{}; // pipeline
auto sA_layout = tile_to_shape(swizzle_ab, make_shape(bM, bK, bP));
auto sB_layout = tile_to_shape(swizzle_ab, make_shape(bN, bK, bP));
// Define the C smem layouts (static).
// TODO: Find a better swizzle.
auto sC_layout = tile_to_shape(swizzle_ab, make_shape(bM, bN));
// Define the scales/biases smem layouts (static).
auto bS = ceil_div(bK, group_size);
auto sS_layout = make_layout(make_shape(bN, make_shape(group_size, bS)),
make_stride(bS, Stride<_0, _1>{}));
// Atoms.
constexpr int element_bits = sizeof_bits_v<Element>;
constexpr int quant_bits = sizeof_bits_v<Quant>;
constexpr int qload = 128 / (element_bits / quant_bits);
TiledCopy g2s_copy_a = make_tiled_copy<Element, 128, SM80_CP_ASYNC_CACHEALWAYS>(num_threads);
TiledCopy g2s_copy_b = make_tiled_copy<Quant, qload, SM80_CP_ASYNC_CACHEALWAYS>(num_threads);
TiledCopy s2g_copy_c = make_tiled_copy<Element, 128, UniversalCopy>(num_threads);
Copy_Atom<SM75_U32x4_LDSM_N, Element> s2r_atom_a;
Copy_Atom<UniversalCopy<uint_bit_t<2 * quant_bits>>, Quant> s2r_atom_b;
Copy_Atom<UniversalCopy<uint_bit_t<2 * element_bits>>, Element> r2s_atom_c;
Copy_Atom<UniversalCopy<Scale>, Scale> g2r_atom_s;
auto* kernel = &qmm_sm80_kernel<
decltype(prob_shape), decltype(cta_tiler),
Element, Quant, Scale,
decltype(dA), decltype(sA_layout), decltype(g2s_copy_a), decltype(s2r_atom_a),
decltype(dB), decltype(sB_layout), decltype(g2s_copy_b), decltype(s2r_atom_b),
decltype(dC), decltype(sC_layout), decltype(s2g_copy_c), decltype(r2s_atom_c),
decltype(S_layout), decltype(g2r_atom_s), decltype(mma)>;
// Set L1 to be SMEM only.
size_t smem_bytes = sizeof(SharedStorage<Element, Quant,
decltype(sA_layout),
decltype(sB_layout),
decltype(sC_layout)>);
cudaFuncSetAttribute(kernel, cudaFuncAttributeMaxDynamicSharedMemorySize, smem_bytes);
cudaFuncSetAttribute(kernel, cudaFuncAttributePreferredSharedMemoryCarveout, 100);
dim3 num_blocks(size(ceil_div(m, bM)), size(ceil_div(n, bN)), l);
dim3 block_dims(num_threads);
void* args[] = {
&prob_shape, &cta_tiler,
&A, &dA, &sA_layout, &g2s_copy_a, &s2r_atom_a,
&B, &dB, &sB_layout, &g2s_copy_b, &s2r_atom_b,
&C, &dC, &sC_layout, &s2g_copy_c, &r2s_atom_c,
&S, &Z, &S_layout, &g2r_atom_s,
&lhs_indices, &rhs_indices,
&mma};
launch_kernel(reinterpret_cast<void*>(kernel), num_blocks, block_dims, smem_bytes, args);
}
} // namespace cutlass_gemm
// clang-format on
namespace mlx::core {
template <typename F>
inline void dispatch_element_types(Dtype dtype, const char* tag, F&& f) {
if (dtype == float16) {
f.template operator()<cutlass::half_t>();
} else if (dtype == bfloat16) {
f.template operator()<cutlass::bfloat16_t>();
} else {
throw std::invalid_argument(
fmt::format("{} Unsupported dtype: {}.", tag, dtype_to_string(dtype)));
}
}
template <typename F>
inline void dispatch_groups(int group_size, const char* tag, F&& f) {
if (group_size == 32) {
f.template operator()<32>();
} else if (group_size == 64) {
f.template operator()<64>();
} else if (group_size == 128) {
f.template operator()<128>();
} else {
throw std::invalid_argument(
fmt::format("{} Group size {} is not supported.", tag, group_size));
}
}
template <typename T, typename F>
inline void dispatch_quant_types(
int bits,
int group_size,
QuantizationMode mode,
const char* tag,
F&& f) {
if (mode == QuantizationMode::Mxfp4) {
f.template operator()<cutlass::float_e2m1_t, cutlass::float_ue8m0_t, 32>();
} else if (mode == QuantizationMode::Mxfp8) {
f.template operator()<cutlass::float_e4m3_t, cutlass::float_ue8m0_t, 32>();
} else if (mode == QuantizationMode::Nvfp4) {
f.template operator()<cutlass::float_e2m1_t, cutlass::float_e4m3_t, 16>();
} else {
dispatch_groups(group_size, tag, [&]<int group_size>() {
if (bits == 4) {
f.template operator()<cutlass::uint4b_t, T, group_size>();
} else if (bits == 8) {
f.template operator()<uint8_t, T, group_size>();
} else {
throw std::invalid_argument(
fmt::format("{} {}-bit quantization is not supported.", tag, bits));
}
});
}
}
template <int TileM>
void qmm_sm80_impl(
const array& x,
const array& w,
const array& scales,
const std::optional<array>& biases,
const std::optional<array>& lhs_indices,
const std::optional<array>& rhs_indices,
array& out,
int bits,
int group_size,
QuantizationMode mode,
cu::CommandEncoder& encoder) {
const char* tag = "[quantized_matmul]";
int m = out.ndim() > 1 ? out.shape(-2) : 1;
int n = out.shape(-1);
int k = x.shape(-1);
int l = out.size() / (m * n);
bool broadcast_b = (w.ndim() <= 2) || (w.size() != w.data_size());
dispatch_element_types(out.dtype(), tag, [&]<typename Element>() {
dispatch_quant_types<Element>(
bits,
group_size,
mode,
tag,
[&]<typename Quant, typename Scale, int group_size>() {
encoder.set_input_array(x);
encoder.set_input_array(w);
encoder.set_input_array(scales);
if (biases) {
encoder.set_input_array(*biases);
}
if (lhs_indices) {
encoder.set_input_array(*lhs_indices);
}
if (rhs_indices) {
encoder.set_input_array(*rhs_indices);
}
encoder.set_output_array(out);
cutlass_gemm::qmm_sm80<TileM>(
gpu_ptr<Element>(x),
gpu_ptr<Quant>(w),
gpu_ptr<Scale>(scales),
biases ? gpu_ptr<Element>(*biases) : nullptr,
lhs_indices ? gpu_ptr<uint32_t>(*lhs_indices) : nullptr,
rhs_indices ? gpu_ptr<uint32_t>(*rhs_indices) : nullptr,
gpu_ptr<Element>(out),
m,
n,
k,
l,
broadcast_b,
cute::Int<group_size>{},
[&](auto* kernel,
dim3 num_blocks,
dim3 block_dims,
uint32_t smem_bytes,
void** args) {
encoder.add_kernel_node_raw(
kernel, num_blocks, block_dims, {}, smem_bytes, args);
});
});
});
}
// clang-format off
template void qmm_sm80_impl<@TileM@>(
const array& x,
const array& w,
const array& scales,
const std::optional<array>& biases,
const std::optional<array>& lhs_indices,
const std::optional<array>& rhs_indices,
array& out,
int bits,
int group_size,
QuantizationMode mode,
cu::CommandEncoder& encoder);
// clang-format on
} // namespace mlx::core
@@ -20,8 +20,7 @@ namespace cutlass_gemm {
using namespace cute;
template <
typename TileShapeMN = Shape<_128, _16>,
typename ClusterShape = Shape<_1, _1, _1>,
int TileN = 16,
typename Element,
typename Quant,
typename GroupSize,
@@ -36,6 +35,7 @@ void qmm_sm90(
int64_t n,
int64_t k,
int64_t l,
bool broadcast_b,
GroupSize group_size,
F&& launch_kernel) {
constexpr int kAlignmentA = 128 / sizeof_bits<Element>::value;
@@ -46,7 +46,8 @@ void qmm_sm90(
using Arch = cutlass::arch::Sm90;
using Accumulator = float;
using TileShape = decltype(append(TileShapeMN{}, Int<kTileShapeK>{}));
using TileShape = Shape<_128, Int<TileN>, Int<kTileShapeK>>;
using ClusterShape = Shape<Int<(TileN <= 32) ? 1 : 2>, _1, _1>;
using Epilogue = typename cutlass::epilogue::collective::CollectiveBuilder<
Arch,
@@ -93,6 +94,10 @@ void qmm_sm90(
auto dB = make_stride(k, Int<1>{}, n * k);
auto dS = make_stride(Int<1>{}, n, n * k / group_size);
auto dD = make_stride(Int<1>{}, n, m * n);
if (broadcast_b) {
get<2>(dB) = 0;
get<2>(dS) = 0;
}
Gemm gemm;
typename Gemm::Arguments args{
@@ -172,8 +177,8 @@ inline void dispatch_groups(int group_size, const char* tag, F&& f) {
}
}
template <typename TileShapeMN, typename ClusterShape>
void qmm_impl_sm90(
template <int TileN>
void qmm_sm90_impl(
const array& x,
const array& w,
const array& scales_,
@@ -184,10 +189,11 @@ void qmm_impl_sm90(
cu::CommandEncoder& encoder,
Stream s) {
const char* tag = "[quantized_matmul]";
int m = out.shape(-2);
int m = out.ndim() > 1 ? out.shape(-2) : 1;
int n = out.shape(-1);
int k = x.shape(-1);
int l = out.size() / (m * n);
bool broadcast_b = (w.ndim() <= 2) || (w.size() != w.data_size());
// FIXME: Copy happens for every call.
array scales = transpose_last_2_dims(scales_, encoder, s);
@@ -201,7 +207,7 @@ void qmm_impl_sm90(
encoder.set_input_array(scales);
encoder.set_input_array(biases);
encoder.set_output_array(out);
cutlass_gemm::qmm_sm90(
cutlass_gemm::qmm_sm90<TileN>(
gpu_ptr<Element>(x),
gpu_ptr<Quant>(w),
gpu_ptr<Element>(scales),
@@ -211,6 +217,7 @@ void qmm_impl_sm90(
n,
k,
l,
broadcast_b,
group_size,
[&](auto* kernel,
dim3 num_blocks,
@@ -231,24 +238,19 @@ void qmm_impl_sm90(
});
}
// clang-format off
template void qmm_sm90_impl<@TileN@>(
const array& x,
const array& w,
const array& scales,
const array& biases,
array& out,
int bits,
int group_size,
cu::CommandEncoder& encoder,
Stream s);
// clang-format on
} // namespace mlx::core
#define QMM_SM90_GPU(TileShapeMN, ClusterShape) \
namespace mlx::core { \
template void qmm_impl_sm90<TileShapeMN, ClusterShape>( \
const array& x, \
const array& w, \
const array& scales, \
const array& biases, \
array& out, \
int bits, \
int group_size, \
cu::CommandEncoder& encoder, \
Stream s); \
}
#else
#define QMM_SM90_GPU(TileShapeMN, ClusterShape)
#endif // defined(MLX_CUDA_SM90A_ENABLED)
+186 -122
View File
@@ -1,112 +1,12 @@
// Copyright © 2026 Apple Inc.
#include "mlx/backend/cuda/kernel_utils.cuh"
#include "mlx/backend/cuda/quantized/qmm/cute_dequant.cuh"
#include "mlx/backend/cuda/quantized/qmm/qmm.h"
#include "mlx/dtype_utils.h"
#include <cooperative_groups.h>
#include <cooperative_groups/reduce.h>
#include <cute/numeric/numeric_types.hpp>
#include <cutlass/numeric_conversion.h>
namespace cutlass {
using uint3b_t = integer_subbyte<3, false>;
using uint5b_t = integer_subbyte<5, false>;
template <typename T, int N, FloatRoundStyle Round>
struct NumericArrayConverter<T, uint3b_t, N, Round> {
static_assert(N % 8 == 0);
using result_type = Array<T, N>;
using source_type = Array<uint3b_t, N>;
CUTLASS_HOST_DEVICE
static result_type convert(const source_type& source) {
result_type result;
auto* s_base = reinterpret_cast<const uint8_t*>(&source);
CUTLASS_PRAGMA_UNROLL
for (int i = 0; i < N / 8; ++i) {
auto* s = s_base + i * 3;
result[i * 8] = T(s[0] & 0x07);
result[i * 8 + 1] = T((s[0] & 0x38) >> 3);
result[i * 8 + 2] = T((s[0] & 0xc0) >> 6) + T((s[1] & 0x01) << 2);
result[i * 8 + 3] = T((s[1] & 0x0e) >> 1);
result[i * 8 + 4] = T((s[1] & 0x70) >> 4);
result[i * 8 + 5] = T((s[1] & 0x80) >> 7) + T((s[2] & 0x03) << 1);
result[i * 8 + 6] = T((s[2] & 0x1c) >> 2);
result[i * 8 + 7] = T((s[2] & 0xe0) >> 5);
}
return result;
}
CUTLASS_HOST_DEVICE
result_type operator()(const source_type& s) const {
return convert(s);
}
};
template <typename T, int N, FloatRoundStyle Round>
struct NumericArrayConverter<T, uint5b_t, N, Round> {
static_assert(N % 8 == 0);
using result_type = Array<T, N>;
using source_type = Array<uint5b_t, N>;
CUTLASS_HOST_DEVICE
static result_type convert(const source_type& source) {
result_type result;
auto* s_base = reinterpret_cast<const uint8_t*>(&source);
CUTLASS_PRAGMA_UNROLL
for (int i = 0; i < N / 8; ++i) {
auto* s = s_base + i * 5;
result[i * 8] = T(s[0] & 0x1f);
result[i * 8 + 1] = T((s[0] & 0xe0) >> 5) + T((s[1] & 0x03) << 3);
result[i * 8 + 2] = T((s[1] & 0x7c) >> 2);
result[i * 8 + 3] = T((s[1] & 0x80) >> 7) + T((s[2] & 0x0f) << 1);
result[i * 8 + 4] = T((s[2] & 0xf0) >> 4) + T((s[3] & 0x01) << 4);
result[i * 8 + 5] = T((s[3] & 0x3e) >> 1);
result[i * 8 + 6] = T((s[3] & 0xc0) >> 6) + T((s[4] & 0x07) << 2);
result[i * 8 + 7] = T((s[4] & 0xf8) >> 3);
}
return result;
}
CUTLASS_HOST_DEVICE
result_type operator()(const source_type& s) const {
return convert(s);
}
};
template <typename T, int N, FloatRoundStyle Round>
struct NumericArrayConverter<T, uint6b_t, N, Round> {
static_assert(N % 4 == 0);
using result_type = Array<T, N>;
using source_type = Array<uint6b_t, N>;
CUTLASS_HOST_DEVICE
static result_type convert(const source_type& source) {
result_type result;
auto* s_base = reinterpret_cast<const uint8_t*>(&source);
CUTLASS_PRAGMA_UNROLL
for (int i = 0; i < N / 4; ++i) {
auto* s = s_base + i * 3;
result[i * 4] = T(s[0] & 0x3f);
result[i * 4 + 1] = T((s[0] >> 6) & 0x03) + T((s[1] & 0x0f) << 2);
result[i * 4 + 2] = T((s[1] >> 4) & 0x0f) + T((s[2] & 0x03) << 4);
result[i * 4 + 3] = T((s[2] >> 2) & 0x3f);
}
return result;
}
CUTLASS_HOST_DEVICE
result_type operator()(const source_type& s) const {
return convert(s);
}
};
} // namespace cutlass
namespace mlx::core {
@@ -182,7 +82,6 @@ dequant_fma(const T* x, const Q* w, S scale, T bias, float* out) {
}
template <
int rows_per_block,
int elems_per_thread,
int group_size,
bool has_bias,
@@ -190,30 +89,17 @@ template <
typename T,
typename Q,
typename S>
__global__ void qmv_kernel(
__device__ __forceinline__ void qmv_kernel_impl(
const T* x,
const Q* w,
const S* scales,
const T* biases,
T* out,
int row,
int w_batch,
int n,
int k,
bool broadcast_w) {
auto grid = cg::this_grid();
auto block = cg::this_thread_block();
auto warp = cg::tiled_partition<WARP_SIZE>(block);
// The row that this warp handles.
int row = block.group_index().x * rows_per_block + warp.meta_group_rank();
if (row >= n) {
return;
}
// Advance pointers of x/out.
int m = grid.dim_blocks().y;
int l = block.group_index().z;
x += block.group_index().y * k + m * k * l;
out += block.group_index().y * n + m * n * l;
int k) {
auto warp = cg::tiled_partition<WARP_SIZE>(cg::this_thread_block());
// For sub-byte Q, pointer moves by 8bits for each advance, e.g. w += 1 would
// move past 2 elements for 4-bit Q.
@@ -224,7 +110,6 @@ __global__ void qmv_kernel(
int groups_per_row = k / group_size;
// Advance w/scales/biases to current row.
int w_batch = broadcast_w ? 0 : l;
w += (static_cast<int64_t>(row) + n * w_batch) * w_step(k);
scales += (static_cast<int64_t>(row) + n * w_batch) * groups_per_row;
if constexpr (has_bias) {
@@ -274,6 +159,85 @@ __global__ void qmv_kernel(
}
}
template <
int rows_per_block,
int elems_per_thread,
int group_size,
bool has_bias,
bool has_residue_k,
typename T,
typename Q,
typename S>
__global__ void qmv_kernel(
const T* x,
const Q* w,
const S* scales,
const T* biases,
T* out,
int n,
int k,
bool broadcast_w) {
auto grid = cg::this_grid();
auto block = cg::this_thread_block();
auto warp = cg::tiled_partition<WARP_SIZE>(block);
// The row that this warp handles.
int row = block.group_index().x * rows_per_block + warp.meta_group_rank();
if (row >= n) {
return;
}
// Advance pointers of x/out for M and batch dimensions.
int m = grid.dim_blocks().y;
int l = block.group_index().z;
x += block.group_index().y * k + m * k * l;
out += block.group_index().y * n + m * n * l;
int w_batch = broadcast_w ? 0 : l;
qmv_kernel_impl<elems_per_thread, group_size, has_bias, has_residue_k>(
x, w, scales, biases, out, row, w_batch, n, k);
}
template <
int rows_per_block,
int elems_per_thread,
int group_size,
bool has_bias,
bool has_residue_k,
typename T,
typename Q,
typename S>
__global__ void gather_qmv_kernel(
const T* x,
const Q* w,
const S* scales,
const T* biases,
T* out,
const uint32_t* lhs_indices,
const uint32_t* rhs_indices,
int n,
int k) {
auto grid = cg::this_grid();
auto block = cg::this_thread_block();
auto warp = cg::tiled_partition<WARP_SIZE>(block);
int row = block.group_index().x * rows_per_block + warp.meta_group_rank();
if (row >= n) {
return;
}
int m = grid.dim_blocks().y;
int l = block.group_index().z;
uint32_t x_idx = lhs_indices[l];
uint32_t w_idx = rhs_indices[l];
x += block.group_index().y * k + m * k * x_idx;
out += block.group_index().y * n + m * n * l;
qmv_kernel_impl<elems_per_thread, group_size, has_bias, has_residue_k>(
x, w, scales, biases, out, row, w_idx, n, k);
}
template <
int group_size,
bool has_bias,
@@ -317,6 +281,51 @@ void qmv(
});
}
template <
int group_size,
bool has_bias,
typename T,
typename Q,
typename S,
typename F>
void gather_qmv(
const T* x,
const Q* w,
const S* scales,
const T* biases,
T* out,
const uint32_t* lhs_indices,
const uint32_t* rhs_indices,
int m,
int n,
int k,
int l,
F&& launch_kernel) {
constexpr int rows_per_block = 8;
constexpr int elems_per_thread =
(cute::sizeof_bits_v<T> <= 16 && cute::sizeof_bits_v<Q> <= 4) ? 16 : 8;
dim3 num_blocks{
uint32_t(cuda::ceil_div(n, rows_per_block)), uint32_t(m), uint32_t(l)};
dim3 block_dims{WARP_SIZE, rows_per_block};
void* args[] = {
&x, &w, &scales, &biases, &out, &lhs_indices, &rhs_indices, &n, &k};
dispatch_bool(k % (WARP_SIZE * elems_per_thread), [&](auto has_residue_k) {
auto* kernel = &gather_qmv_kernel<
rows_per_block,
elems_per_thread,
group_size,
has_bias,
has_residue_k.value,
T,
Q,
S>;
launch_kernel(
reinterpret_cast<void*>(kernel), num_blocks, block_dims, args);
});
}
} // namespace cu
template <typename F>
@@ -397,7 +406,7 @@ void qmv(
int n = out.shape(-1);
int k = x.shape(-1);
int l = out.size() / (m * n);
bool broadcast_w = w.ndim() == 2;
bool broadcast_w = (w.ndim() <= 2) || (w.size() != w.data_size());
dispatch_element_types(out.dtype(), tag, [&]<typename T>() {
dispatch_quant_types<T>(
@@ -433,4 +442,59 @@ void qmv(
});
}
void gather_qmv(
const array& x,
const array& w,
const array& scales,
const std::optional<array>& biases,
const array& lhs_indices,
const array& rhs_indices,
array& out,
int bits,
int group_size,
QuantizationMode mode,
cu::CommandEncoder& encoder) {
const char* tag = "[gather_qmm]";
int m = out.shape(-2);
int n = out.shape(-1);
int k = x.shape(-1);
int l = out.size() / (m * n);
dispatch_element_types(out.dtype(), tag, [&]<typename T>() {
dispatch_quant_types<T>(
bits,
group_size,
mode,
tag,
[&]<typename Q, typename S, int group_size>() {
encoder.set_input_array(x);
encoder.set_input_array(w);
encoder.set_input_array(scales);
if (biases) {
encoder.set_input_array(*biases);
}
encoder.set_input_array(lhs_indices);
encoder.set_input_array(rhs_indices);
encoder.set_output_array(out);
constexpr bool has_bias = !cutlass::has_negative_zero_v<Q>;
cu::gather_qmv<group_size, has_bias>(
gpu_ptr<T>(x),
gpu_ptr<Q>(w),
gpu_ptr<S>(scales),
biases ? gpu_ptr<T>(*biases) : nullptr,
gpu_ptr<T>(out),
gpu_ptr<uint32_t>(lhs_indices),
gpu_ptr<uint32_t>(rhs_indices),
m,
n,
k,
l,
[&](auto* kernel, dim3 num_blocks, dim3 block_dims, void** args) {
encoder.add_kernel_node_raw(
kernel, num_blocks, block_dims, {}, 0, args);
});
});
});
}
} // namespace mlx::core
+197 -32
View File
@@ -17,7 +17,7 @@ void QuantizedMatmul::eval_gpu(const std::vector<array>& inputs, array& out) {
auto& s = stream();
auto& encoder = cu::get_command_encoder(s);
const array& x = inputs[0];
array x = ensure_row_contiguous(inputs[0], encoder, s);
const array& w = inputs[1];
const array& scales = inputs[2];
std::optional<array> biases;
@@ -25,19 +25,6 @@ void QuantizedMatmul::eval_gpu(const std::vector<array>& inputs, array& out) {
biases = inputs[3];
}
auto call_qmm_sm90 = [&]() {
out.set_data(cu::malloc_async(out.nbytes(), encoder));
qmm_sm90(x, w, scales, *biases, out, bits_, group_size_, encoder, s);
};
auto call_fp_qmv = [&]() {
out.set_data(cu::malloc_async(out.nbytes(), encoder));
fp_qmv(x, w, scales, out, bits_, group_size_, encoder, s);
};
auto call_qmv = [&]() {
out.set_data(cu::malloc_async(out.nbytes(), encoder));
qmv(x, w, scales, biases, out, bits_, group_size_, mode_, encoder);
};
auto supports = [&](auto&& f) {
return f(
x,
@@ -52,34 +39,87 @@ void QuantizedMatmul::eval_gpu(const std::vector<array>& inputs, array& out) {
encoder.device());
};
bool can_use_qmm_sm90 = supports(supports_qmm_sm90);
bool can_use_qmm_sm80 = supports(supports_qmm_sm80);
bool can_use_qmm_naive = supports(supports_qmm_naive);
bool can_use_fp_qmv = supports(supports_fp_qmv);
bool can_use_qmv = supports(supports_qmv);
bool can_use_qmv = supports(supports_qmv) || can_use_fp_qmv;
int M = out.shape(-2);
auto call_qmm_sm90 = [&]() {
out.set_data(cu::malloc_async(out.nbytes(), encoder));
qmm_sm90(x, w, scales, *biases, out, bits_, group_size_, encoder, s);
};
auto call_qmm_sm80 = [&]() {
out.set_data(cu::malloc_async(out.nbytes(), encoder));
qmm_sm80(
x,
w,
scales,
biases,
std::nullopt,
std::nullopt,
out,
bits_,
group_size_,
mode_,
encoder);
};
auto call_qmm_naive = [&]() {
out.set_data(cu::malloc_async(out.nbytes(), encoder));
qmm_naive(
x,
w,
scales,
biases,
std::nullopt,
std::nullopt,
out,
transpose_,
bits_,
group_size_,
mode_,
encoder);
};
auto call_qmv = [&]() {
out.set_data(cu::malloc_async(out.nbytes(), encoder));
if (can_use_fp_qmv) {
fp_qmv(x, w, scales, out, bits_, group_size_, encoder, s);
} else {
qmv(x, w, scales, biases, out, bits_, group_size_, mode_, encoder);
}
};
int M = out.ndim() > 1 ? out.shape(-2) : 1;
int N = out.shape(-1);
int K = x.shape(-1);
int B = out.size() / (M * N);
bool prefer_qmv = M == 1 && B == 1 && N <= 16384 && K <= 16384;
if (can_use_qmm_sm90) {
if (prefer_qmv) {
if (can_use_fp_qmv) {
call_fp_qmv();
return;
}
if (can_use_qmv) {
call_qmv();
return;
}
if (can_use_qmv && (M == 1 && B == 1 && N <= 16384 && K <= 16384)) {
call_qmv();
} else {
call_qmm_sm90();
}
call_qmm_sm90();
return;
}
if (can_use_fp_qmv) {
call_fp_qmv();
if (can_use_qmm_sm80) {
if (can_use_qmv && (M * B < 8)) {
call_qmv();
} else {
call_qmm_sm80();
}
return;
}
if (can_use_qmm_naive) {
if (can_use_qmv && (M * B < 8)) {
call_qmv();
} else {
call_qmm_naive();
}
return;
}
if (can_use_qmv) {
call_qmv();
return;
@@ -88,12 +128,138 @@ void QuantizedMatmul::eval_gpu(const std::vector<array>& inputs, array& out) {
throw std::runtime_error(
fmt::format(
"[quantized_matmul] No implementation for "
"problem shape: {}x{}x{}x{} "
"problem shape: {}x{}x{}x{}, transpose: {}, "
"activation: {}, bits: {}, group size: {}, mode: \"{}\".",
M,
N,
K,
B,
transpose_,
dtype_to_string(x.dtype()),
bits_,
group_size_,
quantization_mode_to_string(mode_)));
}
void GatherQMM::eval_gpu(const std::vector<array>& inputs, array& out) {
nvtx3::scoped_range r("GatherQMM::eval_gpu");
auto& s = stream();
auto& encoder = cu::get_command_encoder(s);
array x = ensure_row_contiguous(inputs[0], encoder, s);
const array& w = inputs[1];
const array& scales = inputs[2];
std::optional<array> biases;
if (inputs.size() == 6) {
biases = inputs[3];
}
array lhs_indices =
ensure_row_contiguous(inputs[inputs.size() - 2], encoder, s);
array rhs_indices =
ensure_row_contiguous(inputs[inputs.size() - 1], encoder, s);
int M = out.ndim() > 1 ? out.shape(-2) : 1;
int N = out.shape(-1);
int K = x.shape(-1);
int B = out.size() / (M * N);
auto supports = [&](auto&& f) {
return f(
x,
w,
scales,
biases,
out,
transpose_,
bits_,
group_size_,
mode_,
encoder.device());
};
bool can_use_qmm_sm80 = supports(supports_qmm_sm80);
bool can_use_qmm_naive = supports(supports_qmm_naive);
bool can_use_qmv = supports(supports_qmv);
auto call_qmm_sm80 = [&]() {
out.set_data(cu::malloc_async(out.nbytes(), encoder));
qmm_sm80(
x,
w,
scales,
biases,
lhs_indices,
rhs_indices,
out,
bits_,
group_size_,
mode_,
encoder);
};
auto call_qmm_naive = [&]() {
out.set_data(cu::malloc_async(out.nbytes(), encoder));
qmm_naive(
x,
w,
scales,
biases,
lhs_indices,
rhs_indices,
out,
transpose_,
bits_,
group_size_,
mode_,
encoder);
};
auto call_qmv = [&]() {
out.set_data(cu::malloc_async(out.nbytes(), encoder));
gather_qmv(
x,
w,
scales,
biases,
lhs_indices,
rhs_indices,
out,
bits_,
group_size_,
mode_,
encoder);
};
if (can_use_qmm_sm80) {
if (can_use_qmv && (M * B < 8)) {
call_qmv();
} else {
call_qmm_sm80();
}
return;
}
if (can_use_qmm_naive) {
if (can_use_qmv && (M * B < 8)) {
call_qmv();
} else {
call_qmm_naive();
}
return;
}
if (can_use_qmv) {
call_qmv();
return;
}
throw std::runtime_error(
fmt::format(
"[gather_qmm] No implementation for "
"problem shape: {}x{}x{}x{}, transpose: {}, "
"activation: {}, bits: {}, group size: {}, mode: \"{}\".",
M,
N,
K,
B,
transpose_,
dtype_to_string(x.dtype()),
bits_,
group_size_,
@@ -105,8 +271,7 @@ void fast::Quantize::eval_gpu(
std::vector<array>& outputs) {
nvtx3::scoped_range r("Quantize::eval_gpu");
auto& s = stream();
auto& d = cu::device(s.device);
auto& enc = d.get_command_encoder(s);
auto& enc = cu::get_command_encoder(s);
if (dequantize_) {
auto wq = ensure_row_contiguous(inputs[0], enc, s);
auto scales = ensure_row_contiguous(inputs[1], enc, s);
+2 -2
View File
@@ -49,7 +49,7 @@ __global__ void rbitsc(
uint8_t* out,
dim3 grid_dims,
bool odd,
uint32_t bytes_per_key) {
uint64_t bytes_per_key) {
auto grid = cg::this_grid();
uint32_t thread_index = grid.thread_rank();
uint32_t index_x = thread_index % grid_dims.x;
@@ -89,7 +89,7 @@ __global__ void rbits(
uint8_t* out,
dim3 grid_dims,
bool odd,
uint32_t bytes_per_key,
uint64_t bytes_per_key,
int32_t ndim,
const __grid_constant__ Shape key_shape,
const __grid_constant__ Strides key_strides) {
+3 -11
View File
@@ -98,9 +98,7 @@ void all_reduce(
size_t block_step;
size_t insize = in.size();
Dtype dt = in.dtype();
// Cub doesn't like const pointers for load (sigh).
void* indata = const_cast<void*>(gpu_ptr<void>(in));
void* indata = gpu_ptr<void>(in);
// Large array so allocate an intermediate and accumulate there
std::tie(blocks, threads, block_step) = get_args(insize, N_READS);
@@ -120,7 +118,7 @@ void all_reduce(
kernel,
blocks,
threads,
static_cast<T*>(indata),
indata,
gpu_ptr<U>(intermediate),
block_step,
insize);
@@ -143,13 +141,7 @@ void all_reduce(
using U = typename cu::ReduceResult<OP, T>::type;
auto kernel = cu::all_reduce<T, U, OP, N_READS>;
encoder.add_kernel_node(
kernel,
blocks,
threads,
static_cast<T*>(indata),
gpu_ptr<U>(out),
block_step,
insize);
kernel, blocks, threads, indata, gpu_ptr<U>(out), block_step, insize);
});
});
}
+2 -6
View File
@@ -282,8 +282,6 @@ void col_reduce_looped(
using OP = MLX_GET_TYPE(reduce_type_tag);
using T = cuda_type_t<MLX_GET_TYPE(type_tag)>;
using U = typename cu::ReduceResult<OP, T>::type;
// Cub doesn't like const pointers for vectorized loads. (sigh)
T* indata = const_cast<T*>(gpu_ptr<T>(in));
constexpr int N_READS = 4;
constexpr int BM = 32;
@@ -296,7 +294,7 @@ void col_reduce_looped(
kernel,
grid,
blocks,
indata,
gpu_ptr<T>(in),
gpu_ptr<U>(out),
static_cast<cu::ColReduceArgs>(args),
out.size() / args.reduction_stride);
@@ -389,8 +387,6 @@ void col_reduce_two_pass(
using OP = MLX_GET_TYPE(reduce_type_tag);
using T = cuda_type_t<MLX_GET_TYPE(type_tag)>;
using U = typename cu::ReduceResult<OP, T>::type;
// Cub doesn't like const pointers for vectorized loads. (sigh)
T* indata = const_cast<T*>(gpu_ptr<T>(in));
constexpr int N_READS = 4;
constexpr int BM = 32;
@@ -403,7 +399,7 @@ void col_reduce_two_pass(
kernel,
grid,
blocks,
indata,
gpu_ptr<T>(in),
gpu_ptr<U>(intermediate),
static_cast<cu::ColReduceArgs>(args),
out.size() / args.reduction_stride);
+7 -2
View File
@@ -268,10 +268,15 @@ void row_reduce_simple(
kernel = cu::row_reduce_simple<T, U, OP, N_READS, 2>;
}
T* indata = const_cast<T*>(gpu_ptr<T>(in));
int size = plan.shape.back();
encoder.add_kernel_node(
kernel, grid, block, indata, gpu_ptr<U>(out), out.size(), size);
kernel,
grid,
block,
gpu_ptr<T>(in),
gpu_ptr<U>(out),
out.size(),
size);
});
});
}
@@ -150,21 +150,17 @@ inline BytesKey<SDPACacheKey> build_sdpa_cache_key(
bool decoding = false,
bool output_logsumexp = false) {
BytesKey<SDPACacheKey> cache_key;
cache_key.pod = {
encoder.device().cuda_device(),
dtype_to_cudnn_type(q.dtype()),
vector_key<QKV_NDIM>(q.shape()),
vector_key<QKV_NDIM>(k.shape()),
vector_key<QKV_NDIM>(v.shape()),
vector_key<QKV_NDIM>(q.strides()),
vector_key<QKV_NDIM>(k.strides()),
vector_key<QKV_NDIM>(v.strides()),
do_causal,
{},
{},
sinks.has_value(),
output_logsumexp,
};
cache_key.pod.device_id = encoder.device().cuda_device();
cache_key.pod.cudnn_dtype = dtype_to_cudnn_type(q.dtype());
cache_key.pod.q_shape = vector_key<QKV_NDIM>(q.shape());
cache_key.pod.k_shape = vector_key<QKV_NDIM>(k.shape());
cache_key.pod.v_shape = vector_key<QKV_NDIM>(v.shape());
cache_key.pod.q_strides = vector_key<QKV_NDIM>(q.strides());
cache_key.pod.k_strides = vector_key<QKV_NDIM>(k.strides());
cache_key.pod.v_strides = vector_key<QKV_NDIM>(v.strides());
cache_key.pod.do_causal = do_causal;
cache_key.pod.has_sinks = sinks.has_value();
cache_key.pod.output_logsumexp = output_logsumexp;
if (mask_arr) {
cache_key.pod.mask_shape = vector_key<QKV_NDIM>(mask_arr->shape());
cache_key.pod.mask_strides = vector_key<QKV_NDIM>(mask_arr->strides());
@@ -180,13 +176,13 @@ inline BytesKey<SDPACacheKey> build_sdpa_cache_key(
}
auto& sdpa_cache() {
static LRUBytesKeyCache<SDPACacheKey, DnnGraph> cache(
static thread_local LRUBytesKeyCache<SDPACacheKey, DnnGraph> cache(
"MLX_CUDA_SDPA_CACHE_SIZE", /* default_capacity */ 256);
return cache;
}
auto& sdpa_backward_cache() {
static LRUBytesKeyCache<SDPACacheKey, DnnGraph> cache(
static thread_local LRUBytesKeyCache<SDPACacheKey, DnnGraph> cache(
"MLX_CUDA_SDPA_BACKWARD_CACHE_SIZE", /* default_capacity */ 64);
return cache;
}
@@ -253,10 +249,10 @@ DnnGraph build_sdpa_graph(
graph.tensor(stats_, STATS, *stats)->set_output(true);
}
CHECK_CUDNN_FE_ERROR(graph.prepare());
CHECK_CUDNN_ERROR(graph.prepare());
graph.select_behavior_notes(
{fe::BehaviorNote_t::SUPPORTS_CUDA_GRAPH_NATIVE_API});
CHECK_CUDNN_FE_ERROR(graph.build());
CHECK_CUDNN_ERROR(graph.build());
return graph;
}
@@ -302,15 +298,20 @@ DnnGraph build_sdpa_backward_graph(
graph.tensor(d_k_, D_K, d_k)->set_output(true);
graph.tensor(d_v_, D_V, d_v)->set_output(true);
CHECK_CUDNN_FE_ERROR(graph.prepare());
CHECK_CUDNN_ERROR(graph.prepare());
graph.select_behavior_notes(
{fe::BehaviorNote_t::SUPPORTS_CUDA_GRAPH_NATIVE_API});
CHECK_CUDNN_FE_ERROR(graph.build());
CHECK_CUDNN_ERROR(graph.build());
return graph;
}
} // namespace
void init_cudnn_sdpa_cache() {
sdpa_cache();
sdpa_backward_cache();
}
bool supports_sdpa_cudnn(
const array& q,
const array& k,
@@ -318,15 +319,7 @@ bool supports_sdpa_cudnn(
bool has_arr_mask,
bool do_causal,
Stream s) {
#ifdef _WIN32
// On Windows (WDDM), cuDNN SDPA has severe performance issues due to
// high per-kernel-launch overhead in the WDDM driver model. cuDNN's
// multi-kernel SDPA amplifies this, making it much slower than the
// single-kernel sdpa_vector path for both prefill and generation.
static bool enabled = env::get_var("MLX_CUDA_USE_CUDNN_SDPA", 0);
#else
static bool enabled = env::get_var("MLX_CUDA_USE_CUDNN_SDPA", 1);
#endif
if (!enabled) {
return false;
}
@@ -369,7 +362,7 @@ void sdpa_cudnn(
bool output_logsumexp,
Stream s) {
auto& encoder = cu::get_command_encoder(s);
auto handle = encoder.device().get_cudnn_handle();
auto handle = get_cudnn_handle(encoder.device());
malloc_with_same_layout(encoder, o, q);
@@ -452,7 +445,7 @@ void sdpa_cudnn(
variant_pack[STATS] = gpu_ptr<void>(*stats);
}
CHECK_CUDNN_FE_ERROR(graph.encode_graph(encoder, std::move(variant_pack)));
CHECK_CUDNN_ERROR(graph.encode_graph(encoder, std::move(variant_pack)));
}
void sdpa_backward_cudnn(
@@ -471,7 +464,7 @@ void sdpa_backward_cudnn(
array& d_v,
Stream s) {
auto& encoder = cu::get_command_encoder(s);
auto handle = encoder.device().get_cudnn_handle();
auto handle = get_cudnn_handle(encoder.device());
malloc_with_same_layout(encoder, d_q, q);
malloc_with_same_layout(encoder, d_k, k);
@@ -534,7 +527,7 @@ void sdpa_backward_cudnn(
variant_pack[SINKS] = gpu_ptr<void>(*sinks);
}
CHECK_CUDNN_FE_ERROR(graph.encode_graph(encoder, std::move(variant_pack)));
CHECK_CUDNN_ERROR(graph.encode_graph(encoder, std::move(variant_pack)));
}
// Defined in scaled_dot_product_attention.cu file.
+44 -31
View File
@@ -5,6 +5,7 @@
#include "mlx/backend/cuda/kernel_utils.cuh"
#include "mlx/backend/cuda/reduce/reduce_ops.cuh"
#include "mlx/backend/gpu/copy.h"
#include "mlx/backend/gpu/scan.h"
#include "mlx/dtype_utils.h"
#include "mlx/primitives.h"
@@ -362,51 +363,38 @@ constexpr bool supports_scan_op() {
}
}
void Scan::eval_gpu(const std::vector<array>& inputs, array& out) {
nvtx3::scoped_range r("Scan::eval_gpu");
assert(inputs.size() == 1);
auto in = inputs[0];
auto& s = stream();
void scan_gpu_inplace(
const array& in,
array& out,
Scan::ReduceType reduce_type,
int axis,
bool reverse,
bool inclusive,
const Stream& s) {
auto& encoder = cu::get_command_encoder(s);
if (in.flags().contiguous && in.strides()[axis_] != 0) {
if (in.is_donatable() && in.itemsize() == out.itemsize()) {
out.copy_shared_buffer(in);
} else {
out.set_data(
cu::malloc_async(in.data_size() * out.itemsize(), encoder),
in.data_size(),
in.strides(),
in.flags());
}
} else {
in = contiguous_copy_gpu(in, s);
out.copy_shared_buffer(in);
}
constexpr int N_READS = 4;
int32_t axis_size = in.shape(axis_);
bool contiguous = in.strides()[axis_] == 1;
int32_t axis_size = in.shape(axis);
bool contiguous = in.strides()[axis] == 1;
encoder.set_input_array(in);
encoder.set_output_array(out);
dispatch_all_types(in.dtype(), [&](auto type_tag) {
using T = cuda_type_t<MLX_GET_TYPE(type_tag)>;
dispatch_scan_ops(reduce_type_, [&](auto scan_op_tag) {
dispatch_scan_ops(reduce_type, [&](auto scan_op_tag) {
using Op = MLX_GET_TYPE(scan_op_tag);
if constexpr (supports_scan_op<Op, T>()) {
using U = typename cu::ScanResult<Op, T>::type;
dispatch_bool(inclusive_, [&](auto inclusive) {
dispatch_bool(reverse_, [&](auto reverse) {
dispatch_bool(inclusive, [&](auto inclusive_tag) {
dispatch_bool(reverse, [&](auto reverse_tag) {
if (contiguous) {
auto kernel = cu::contiguous_scan<
T,
U,
Op,
N_READS,
inclusive.value,
reverse.value>;
inclusive_tag.value,
reverse_tag.value>;
int block_dim = cuda::ceil_div(axis_size, N_READS);
block_dim = cuda::ceil_div(block_dim, WARP_SIZE) * WARP_SIZE;
block_dim = std::min(block_dim, WARP_SIZE * WARP_SIZE);
@@ -427,9 +415,9 @@ void Scan::eval_gpu(const std::vector<array>& inputs, array& out) {
N_READS,
BM,
BN,
inclusive.value,
reverse.value>;
int64_t stride = in.strides()[axis_];
inclusive_tag.value,
reverse_tag.value>;
int64_t stride = in.strides()[axis];
int64_t stride_blocks = cuda::ceil_div(stride, BN);
dim3 num_blocks = get_2d_grid_dims(
in.shape(), in.strides(), axis_size * stride);
@@ -463,4 +451,29 @@ void Scan::eval_gpu(const std::vector<array>& inputs, array& out) {
});
}
void Scan::eval_gpu(const std::vector<array>& inputs, array& out) {
nvtx3::scoped_range r("Scan::eval_gpu");
assert(inputs.size() == 1);
auto in = inputs[0];
auto& s = stream();
auto& encoder = cu::get_command_encoder(s);
if (in.flags().contiguous && in.strides()[axis_] != 0) {
if (in.is_donatable() && in.itemsize() == out.itemsize()) {
out.copy_shared_buffer(in);
} else {
out.set_data(
cu::malloc_async(in.data_size() * out.itemsize(), encoder),
in.data_size(),
in.strides(),
in.flags());
}
} else {
in = contiguous_copy_gpu(in, s);
out.copy_shared_buffer(in);
}
scan_gpu_inplace(in, out, reduce_type_, axis_, reverse_, inclusive_, s);
}
} // namespace mlx::core
+161 -155
View File
@@ -44,6 +44,12 @@ __device__ __forceinline__ __nv_bfloat16 nan_value<__nv_bfloat16>() {
return __float2bfloat16(cuda::std::numeric_limits<float>::quiet_NaN());
}
template <>
__device__ __forceinline__ complex64_t nan_value<complex64_t>() {
float qnan = cuda::std::numeric_limits<float>::quiet_NaN();
return complex64_t{qnan, qnan};
}
template <typename T, typename = void>
struct InitValue {
__device__ __forceinline__ static T value() {
@@ -52,7 +58,9 @@ struct InitValue {
};
template <typename T>
struct InitValue<T, cuda::std::enable_if_t<std::is_floating_point_v<T>>> {
struct InitValue<
T,
cuda::std::enable_if_t<is_floating_v<T> || cu::is_complex_v<T>>> {
__device__ __forceinline__ static T value() {
return nan_value<T>();
}
@@ -65,6 +73,15 @@ __device__ __forceinline__ void thread_swap(T& a, T& b) {
b = w;
}
template <typename T>
__device__ __forceinline__ bool check_nan(T a) {
if constexpr (cu::is_complex_v<T>) {
return cuda::std::isnan(a.real()) || cuda::std::isnan(a.imag());
} else {
return cuda::std::isnan(a);
}
}
template <typename T>
struct LessThan {
__device__ __forceinline__ static T init() {
@@ -72,9 +89,9 @@ struct LessThan {
}
__device__ __forceinline__ bool operator()(T a, T b) const {
if constexpr (std::is_floating_point_v<T>) {
bool an = cuda::std::isnan(a);
bool bn = cuda::std::isnan(b);
if constexpr (is_floating_v<T> || cu::is_complex_v<T>) {
bool an = check_nan(a);
bool bn = check_nan(b);
if (an | bn) {
return (!an) & bn;
}
@@ -745,82 +762,76 @@ void single_block_sort(
dispatch_all_types(in.dtype(), [&](auto type_tag) {
using CTYPE = MLX_GET_TYPE(type_tag);
if constexpr (!std::is_same_v<CTYPE, complex64_t>) {
using ValT = cuda_type_t<CTYPE>;
dispatch_block_dim(bn, [&](auto block_dim) {
constexpr int BLOCK_THREADS = block_dim();
if constexpr (BLOCK_THREADS < 1024) {
dim3 grid(1, n_rows, 1);
dim3 block(BLOCK_THREADS, 1, 1);
using ValT = cuda_type_t<CTYPE>;
dispatch_block_dim(bn, [&](auto block_dim) {
constexpr int BLOCK_THREADS = block_dim();
if constexpr (BLOCK_THREADS < 1024) {
dim3 grid(1, n_rows, 1);
dim3 block(BLOCK_THREADS, 1, 1);
dispatch_bool(argsort, [&](auto arg_tag) {
constexpr bool ARG_SORT = decltype(arg_tag)::value;
using OutT = std::conditional_t<ARG_SORT, uint32_t, ValT>;
dispatch_bool(argsort, [&](auto arg_tag) {
constexpr bool ARG_SORT = decltype(arg_tag)::value;
using OutT = std::conditional_t<ARG_SORT, uint32_t, ValT>;
if (contiguous) {
auto kernel = cu::block_sort_kernel<
ValT,
OutT,
ARG_SORT,
BLOCK_THREADS,
N_PER_THREAD>;
int64_t in_stride_segment_axis = INT64_MAX;
int64_t out_stride_segment_axis = INT64_MAX;
for (int i = 0; i < nc_shape.size(); i++) {
if (nc_shape[i] == 1) {
continue;
}
if (in_nc_str[i] > INT32_MAX || out_nc_str[i] > INT32_MAX) {
throw std::runtime_error(
"[Sort::eval_gpu] Stride too large.");
}
in_stride_segment_axis =
std::min(in_stride_segment_axis, in_nc_str[i]);
out_stride_segment_axis =
std::min(out_stride_segment_axis, out_nc_str[i]);
if (contiguous) {
auto kernel = cu::block_sort_kernel<
ValT,
OutT,
ARG_SORT,
BLOCK_THREADS,
N_PER_THREAD>;
int64_t in_stride_segment_axis = INT64_MAX;
int64_t out_stride_segment_axis = INT64_MAX;
for (int i = 0; i < nc_shape.size(); i++) {
if (nc_shape[i] == 1) {
continue;
}
encoder.add_kernel_node(
kernel,
grid,
block,
gpu_ptr<ValT>(in),
gpu_ptr<OutT>(out),
size_sorted_axis,
in_stride_sorted_axis,
out_stride_sorted_axis,
in_stride_segment_axis,
out_stride_segment_axis);
} else {
auto kernel = cu::block_sort_nc_kernel<
ValT,
OutT,
ARG_SORT,
BLOCK_THREADS,
N_PER_THREAD>;
auto nc_shape_param = const_param(nc_shape);
auto in_nc_strides_param = const_param(in_nc_str);
auto out_nc_strides_param = const_param(out_nc_str);
encoder.add_kernel_node(
kernel,
grid,
block,
gpu_ptr<ValT>(in),
gpu_ptr<OutT>(out),
size_sorted_axis,
in_stride_sorted_axis,
out_stride_sorted_axis,
nc_shape_param,
in_nc_strides_param,
out_nc_strides_param,
nc_dim);
if (in_nc_str[i] > INT32_MAX || out_nc_str[i] > INT32_MAX) {
throw std::runtime_error("[Sort::eval_gpu] Stride too large.");
}
in_stride_segment_axis =
std::min(in_stride_segment_axis, in_nc_str[i]);
out_stride_segment_axis =
std::min(out_stride_segment_axis, out_nc_str[i]);
}
});
}
});
} else {
throw std::runtime_error(
"CUDA backend does not support sorting complex numbers");
}
encoder.add_kernel_node(
kernel,
grid,
block,
gpu_ptr<ValT>(in),
gpu_ptr<OutT>(out),
size_sorted_axis,
in_stride_sorted_axis,
out_stride_sorted_axis,
in_stride_segment_axis,
out_stride_segment_axis);
} else {
auto kernel = cu::block_sort_nc_kernel<
ValT,
OutT,
ARG_SORT,
BLOCK_THREADS,
N_PER_THREAD>;
auto nc_shape_param = const_param(nc_shape);
auto in_nc_strides_param = const_param(in_nc_str);
auto out_nc_strides_param = const_param(out_nc_str);
encoder.add_kernel_node(
kernel,
grid,
block,
gpu_ptr<ValT>(in),
gpu_ptr<OutT>(out),
size_sorted_axis,
in_stride_sorted_axis,
out_stride_sorted_axis,
nc_shape_param,
in_nc_strides_param,
out_nc_strides_param,
nc_dim);
}
});
}
});
});
}
@@ -870,99 +881,94 @@ void multi_block_sort(
dispatch_all_types(in.dtype(), [&](auto type_tag) {
using CTYPE = MLX_GET_TYPE(type_tag);
if constexpr (!std::is_same_v<CTYPE, complex64_t>) {
using ValT = cuda_type_t<CTYPE>;
using IdxT = uint32_t;
constexpr int BLOCK_THREADS = sizeof(ValT) == 8 ? 256 : 512;
dim3 grid(n_blocks, n_rows, 1);
dim3 block(BLOCK_THREADS, 1, 1);
using ValT = cuda_type_t<CTYPE>;
using IdxT = uint32_t;
constexpr int BLOCK_THREADS = sizeof(ValT) == 8 ? 256 : 512;
dim3 grid(n_blocks, n_rows, 1);
dim3 block(BLOCK_THREADS, 1, 1);
dispatch_bool(argsort, [&](auto arg_tag) {
constexpr bool ARG_SORT = decltype(arg_tag)::value;
auto nc_shape_param = const_param(nc_shape);
auto nc_strides_param = const_param(nc_str);
dispatch_bool(argsort, [&](auto arg_tag) {
constexpr bool ARG_SORT = decltype(arg_tag)::value;
auto nc_shape_param = const_param(nc_shape);
auto nc_strides_param = const_param(nc_str);
auto block_sort_kernel = cu::mb_block_sort_kernel<
auto block_sort_kernel = cu::mb_block_sort_kernel<
ValT,
IdxT,
ARG_SORT,
BLOCK_THREADS,
N_PER_THREAD>;
encoder.set_input_array(in);
encoder.set_output_array(dev_vals_in);
encoder.set_output_array(dev_idxs_in);
encoder.add_kernel_node(
block_sort_kernel,
grid,
block,
gpu_ptr<ValT>(in),
gpu_ptr<ValT>(dev_vals_in),
gpu_ptr<IdxT>(dev_idxs_in),
size_sorted_axis,
stride_sorted_axis,
nc_shape_param,
nc_strides_param,
nc_dim);
int n_thr_per_group = (n_blocks + 1) < 1024 ? (n_blocks + 1) : 1024;
for (int merge_tiles = 2; (merge_tiles / 2) < n_blocks;
merge_tiles *= 2) {
auto partition_kernel = cu::mb_block_partition_kernel<
ValT,
IdxT,
ARG_SORT,
BLOCK_THREADS,
N_PER_THREAD>;
encoder.set_input_array(in);
encoder.set_output_array(dev_vals_in);
encoder.set_output_array(dev_idxs_in);
encoder.set_input_array(dev_vals_in);
encoder.set_input_array(dev_idxs_in);
encoder.set_output_array(block_partitions);
encoder.add_kernel_node(
block_sort_kernel,
grid,
block,
gpu_ptr<ValT>(in),
partition_kernel,
dim3(1, n_rows, 1),
dim3(n_thr_per_group, 1, 1),
gpu_ptr<IdxT>(block_partitions),
gpu_ptr<ValT>(dev_vals_in),
gpu_ptr<IdxT>(dev_idxs_in),
size_sorted_axis,
stride_sorted_axis,
nc_shape_param,
nc_strides_param,
nc_dim);
merge_tiles,
n_blocks);
int n_thr_per_group = (n_blocks + 1) < 1024 ? (n_blocks + 1) : 1024;
auto merge_kernel = cu::mb_block_merge_kernel<
ValT,
IdxT,
ARG_SORT,
BLOCK_THREADS,
N_PER_THREAD>;
for (int merge_tiles = 2; (merge_tiles / 2) < n_blocks;
merge_tiles *= 2) {
auto partition_kernel = cu::mb_block_partition_kernel<
ValT,
IdxT,
ARG_SORT,
BLOCK_THREADS,
N_PER_THREAD>;
encoder.set_input_array(dev_vals_in);
encoder.set_input_array(dev_idxs_in);
encoder.set_input_array(block_partitions);
encoder.set_output_array(dev_vals_out);
encoder.set_output_array(dev_idxs_out);
encoder.set_input_array(dev_vals_in);
encoder.set_input_array(dev_idxs_in);
encoder.set_output_array(block_partitions);
encoder.add_kernel_node(
partition_kernel,
dim3(1, n_rows, 1),
dim3(n_thr_per_group, 1, 1),
gpu_ptr<IdxT>(block_partitions),
gpu_ptr<ValT>(dev_vals_in),
gpu_ptr<IdxT>(dev_idxs_in),
size_sorted_axis,
merge_tiles,
n_blocks);
auto merge_kernel = cu::mb_block_merge_kernel<
ValT,
IdxT,
ARG_SORT,
BLOCK_THREADS,
N_PER_THREAD>;
encoder.set_input_array(dev_vals_in);
encoder.set_input_array(dev_idxs_in);
encoder.set_input_array(block_partitions);
encoder.set_output_array(dev_vals_out);
encoder.set_output_array(dev_idxs_out);
encoder.add_kernel_node(
merge_kernel,
dim3(n_blocks, n_rows, 1),
dim3(BLOCK_THREADS, 1, 1),
gpu_ptr<IdxT>(block_partitions),
gpu_ptr<ValT>(dev_vals_in),
gpu_ptr<IdxT>(dev_idxs_in),
gpu_ptr<ValT>(dev_vals_out),
gpu_ptr<IdxT>(dev_idxs_out),
size_sorted_axis,
merge_tiles,
n_blocks);
std::swap(dev_vals_in, dev_vals_out);
std::swap(dev_idxs_in, dev_idxs_out);
}
});
} else {
throw std::runtime_error(
"CUDA backend does not support sorting complex numbers");
}
encoder.add_kernel_node(
merge_kernel,
dim3(n_blocks, n_rows, 1),
dim3(BLOCK_THREADS, 1, 1),
gpu_ptr<IdxT>(block_partitions),
gpu_ptr<ValT>(dev_vals_in),
gpu_ptr<IdxT>(dev_idxs_in),
gpu_ptr<ValT>(dev_vals_out),
gpu_ptr<IdxT>(dev_idxs_out),
size_sorted_axis,
merge_tiles,
n_blocks);
std::swap(dev_vals_in, dev_vals_out);
std::swap(dev_idxs_in, dev_idxs_out);
}
});
});
encoder.add_temporary(dev_vals_out);
-15
View File
@@ -10,14 +10,6 @@
namespace mlx::core {
void check_cublas_error(const char* name, cublasStatus_t err) {
if (err != CUBLAS_STATUS_SUCCESS) {
// TODO: Use cublasGetStatusString when it is widely available.
throw std::runtime_error(
fmt::format("{} failed with code: {}.", name, static_cast<int>(err)));
}
}
void check_cuda_error(const char* name, cudaError_t err) {
if (err != cudaSuccess) {
throw std::runtime_error(
@@ -33,13 +25,6 @@ void check_cuda_error(const char* name, CUresult err) {
}
}
void check_cudnn_error(const char* name, cudnnStatus_t err) {
if (err != CUDNN_STATUS_SUCCESS) {
throw std::runtime_error(
fmt::format("{} failed: {}.", name, cudnnGetErrorString(err)));
}
}
const char* dtype_to_cuda_type(const Dtype& dtype) {
switch (dtype) {
case bool_:
+13 -4
View File
@@ -7,16 +7,25 @@ namespace mlx::core::cu {
Worker::Worker(Device& d)
: signal_stream_(d),
signal_event_(d, cudaEventDisableTiming | cudaEventBlockingSync),
worker_(&Worker::thread_fn, this) {}
signal_event_(d, cudaEventDisableTiming | cudaEventBlockingSync) {}
Worker::~Worker() {
Worker::~Worker() = default;
void Worker::start() {
// Note that |shared_from_this| can not be called in constructor.
worker_ = std::thread(&Worker::thread_fn, shared_from_this());
// Detach the thread and let it free itself after finishing tasks.
// This is to avoid deadlock when joining threads on exit on Windows:
// https://developercommunity.visualstudio.com/t/1654756
worker_.detach();
}
void Worker::stop() {
{
std::lock_guard lock(mtx_);
stop_ = true;
}
cond_.notify_one();
worker_.join();
}
void Worker::add_task(std::function<void()> task) {
+5 -1
View File
@@ -7,13 +7,14 @@
#include <condition_variable>
#include <functional>
#include <map>
#include <memory>
#include <mutex>
#include <thread>
namespace mlx::core::cu {
// Run tasks in worker thread, synchronized with cuda stream.
class Worker {
class Worker : public std::enable_shared_from_this<Worker> {
public:
explicit Worker(Device& d);
~Worker();
@@ -21,6 +22,9 @@ class Worker {
Worker(const Worker&) = delete;
Worker& operator=(const Worker&) = delete;
void start();
void stop();
// Add a pending |task| that will run when consumed or commited.
void add_task(std::function<void()> task);
+22 -12
View File
@@ -4,6 +4,7 @@
#include "mlx/primitives.h"
#include <cassert>
#include <numeric>
namespace mlx::core {
@@ -59,19 +60,13 @@ array reshape_in_eval(const array& x, Shape shape, Stream s) {
return out;
}
array swapaxes_in_eval(const array& x, int axis1, int axis2) {
int ndim = x.ndim();
if (axis1 < 0) {
axis1 += ndim;
array transpose_in_eval(const array& x, const std::vector<int>& axes) {
Shape shape(axes.size());
Strides strides(axes.size());
for (int i = 0; i < axes.size(); ++i) {
shape[i] = x.shape(axes[i]);
strides[i] = x.strides(axes[i]);
}
if (axis2 < 0) {
axis2 += ndim;
}
auto shape = x.shape();
std::swap(shape[axis1], shape[axis2]);
auto strides = x.strides();
std::swap(strides[axis1], strides[axis2]);
auto [data_size, row_contiguous, col_contiguous] =
check_contiguity(shape, strides);
@@ -86,4 +81,19 @@ array swapaxes_in_eval(const array& x, int axis1, int axis2) {
return out;
}
array swapaxes_in_eval(const array& x, int axis1, int axis2) {
int ndim = x.ndim();
if (axis1 < 0) {
axis1 += ndim;
}
if (axis2 < 0) {
axis2 += ndim;
}
std::vector<int> axes(ndim);
std::iota(axes.begin(), axes.end(), 0);
std::swap(axes[axis1], axes[axis2]);
return transpose_in_eval(x, axes);
}
} // namespace mlx::core
+2
View File
@@ -6,6 +6,7 @@
#include "mlx/stream.h"
#include <optional>
#include <vector>
namespace mlx::core {
@@ -52,6 +53,7 @@ void reshape_gpu(const array& in, array& out, Stream s);
// Like the normal ops but safe to call in eval_gpu.
array flatten_in_eval(const array& x, int start_axis, int end_axis, Stream s);
array reshape_in_eval(const array& x, Shape shape, Stream s);
array transpose_in_eval(const array& x, const std::vector<int>& axes);
array swapaxes_in_eval(const array& x, int axis1, int axis2);
} // namespace mlx::core
+2
View File
@@ -10,9 +10,11 @@
namespace mlx::core::gpu {
void init();
void new_stream(Stream stream);
void eval(array& arr);
void finalize(Stream s);
void synchronize(Stream s);
void clear_streams();
} // namespace mlx::core::gpu
-35
View File
@@ -217,41 +217,6 @@ void Slice::eval_gpu(const std::vector<array>& inputs, array& out) {
slice_gpu(in, out, start_indices_, strides_, stream());
}
void SliceUpdate::eval_gpu(const std::vector<array>& inputs, array& out) {
assert(inputs.size() == 2);
if (out.size() == 0) {
out.set_data(allocator::malloc(0));
return;
}
auto& in = inputs[0];
auto& upd = inputs[1];
if (upd.size() == 0) {
out.copy_shared_buffer(in);
return;
}
auto ctype = in.flags().contiguous && in.size() == in.data_size()
? CopyType::Vector
: CopyType::General;
copy_gpu(in, out, in.data_size() == 1 ? CopyType::Scalar : ctype, stream());
auto [data_offset, out_strides] =
prepare_slice(out, start_indices_, strides_);
// Do copy
copy_gpu_inplace(
/* const array& src = */ upd,
/* array& dst = */ out,
/* const Shape& data_shape = */ upd.shape(),
/* const Strides& i_strides = */ upd.strides(),
/* const Strides& o_strides = */ out_strides,
/* int64_t i_offset = */ 0,
/* int64_t o_offset = */ data_offset,
/* CopyType ctype = */ CopyType::GeneralGeneral,
/* const Stream& s = */ stream());
}
void Squeeze::eval_gpu(const std::vector<array>& inputs, array& out) {
MLX_PROFILER_RANGE("Squeeze::eval_gpu");
eval(inputs, out);
@@ -6,7 +6,7 @@
namespace mlx::core {
void scan_gpu_inplace(
array in,
const array& in,
array& out,
Scan::ReduceType reduce_type,
int axis,
+1
View File
@@ -89,6 +89,7 @@ if(MLX_METAL_JIT)
make_jit_source(steel/gemm/kernels/steel_gemm_fused_nax)
make_jit_source(steel/gemm/kernels/steel_gemm_gather_nax)
make_jit_source(steel/gemm/kernels/steel_gemm_splitk_nax)
make_jit_source(steel/gemm/kernels/steel_gemm_segmented_nax)
make_jit_source(quantized_nax kernels/quantized_utils.h)
make_jit_source(fp_quantized_nax kernels/quantized_utils.h kernels/fp8.h
+12 -23
View File
@@ -31,8 +31,9 @@ void* Buffer::raw_ptr() {
namespace metal {
MetalAllocator::MetalAllocator()
: device_(device(mlx::core::Device::gpu).mtl_device()),
MetalAllocator::MetalAllocator(Device& d)
: device_(d.mtl_device()),
residency_set_(d.residency_set()),
buffer_cache_(
vm_page_size,
[](MTL::Buffer* buf) { return buf->length(); },
@@ -40,10 +41,9 @@ MetalAllocator::MetalAllocator()
if (!buf->heap()) {
residency_set_.erase(buf);
}
auto pool = metal::new_scoped_memory_pool();
buf->release();
}),
residency_set_(device_) {
auto pool = metal::new_scoped_memory_pool();
}) {
const auto& info = gpu::device_info(0);
auto memsize = std::get<size_t>(info.at("memory_size"));
auto max_rec_size =
@@ -52,28 +52,20 @@ MetalAllocator::MetalAllocator()
block_limit_ = std::min(1.5 * max_rec_size, 0.95 * memsize);
gc_limit_ = std::min(static_cast<size_t>(0.95 * max_rec_size), block_limit_);
max_pool_size_ = block_limit_;
device(mlx::core::Device::gpu)
.set_residency_set(residency_set_.mtl_residency_set());
bool is_vm = std::get<std::string>(info.at("device_name")) ==
"Apple Paravirtual device";
if (is_vm) {
return;
}
auto heap_desc = MTL::HeapDescriptor::alloc()->init();
auto pool = metal::new_scoped_memory_pool();
auto heap_desc = MTL::HeapDescriptor::alloc()->init()->autorelease();
heap_desc->setResourceOptions(resource_options);
heap_desc->setSize(heap_size_);
heap_ = device_->newHeap(heap_desc);
heap_desc->release();
residency_set_.insert(heap_);
heap_ = NS::TransferPtr(device_->newHeap(heap_desc));
residency_set_.insert(heap_.get());
}
MetalAllocator::~MetalAllocator() {
auto pool = metal::new_scoped_memory_pool();
if (heap_) {
heap_->release();
}
buffer_cache_.clear();
}
MetalAllocator::~MetalAllocator() = default;
size_t MetalAllocator::set_cache_limit(size_t limit) {
std::unique_lock lk(mutex_);
@@ -128,8 +120,6 @@ Buffer MetalAllocator::malloc(size_t size) {
if (!buf) {
size_t mem_required = get_active_memory() + get_cache_memory() + size;
auto pool = metal::new_scoped_memory_pool();
// If we have a lot of memory pressure try to reclaim memory from the cache
if (mem_required >= gc_limit_ || num_resources_ >= resource_limit_) {
num_resources_ -=
@@ -167,7 +157,6 @@ Buffer MetalAllocator::malloc(size_t size) {
// Maintain the cache below the requested limit
if (get_cache_memory() > max_pool_size_) {
auto pool = metal::new_scoped_memory_pool();
num_resources_ -= buffer_cache_.release_cached_buffers(
get_cache_memory() - max_pool_size_);
}
@@ -177,7 +166,6 @@ Buffer MetalAllocator::malloc(size_t size) {
void MetalAllocator::clear_cache() {
std::unique_lock lk(mutex_);
auto pool = metal::new_scoped_memory_pool();
num_resources_ -= buffer_cache_.clear();
}
@@ -236,7 +224,8 @@ MetalAllocator& allocator() {
// By creating the |allocator_| on heap, the destructor of MetalAllocator
// will not be called on exit and buffers in the cache will be leaked. This
// can save some time at program exit.
static MetalAllocator* allocator_ = new MetalAllocator;
static MetalAllocator* allocator_ =
new MetalAllocator(device(mlx::core::Device::gpu));
return *allocator_;
}
+6 -5
View File
@@ -9,7 +9,6 @@
#include "mlx/allocator.h"
#include "mlx/backend/common/buffer_cache.h"
#include "mlx/backend/metal/device.h"
#include "mlx/backend/metal/resident.h"
namespace mlx::core::metal {
@@ -51,16 +50,18 @@ class MetalAllocator : public allocator::Allocator {
// the heap, a heap can have at most heap.size() / 256 buffers.
static constexpr int small_size_ = 256;
static constexpr int heap_size_ = 1 << 20;
MTL::Heap* heap_;
MetalAllocator();
MetalAllocator(Device& d);
~MetalAllocator();
friend MetalAllocator& allocator();
NS::SharedPtr<MTL::Heap> heap_;
ResidencySet& residency_set_;
// Caching allocator
BufferCache<MTL::Buffer> buffer_cache_;
ResidencySet residency_set_;
// Allocation stats
size_t block_limit_;
size_t gc_limit_;
+1 -1
View File
@@ -106,7 +106,7 @@ void binary_op_gpu_inplace(
auto kernel = outputs.size() == 2
? get_binary_two_kernel(d, kernel_name, a.dtype(), out.dtype(), op)
: get_binary_kernel(d, kernel_name, a.dtype(), out.dtype(), op);
auto& compute_encoder = d.get_command_encoder(s.index);
auto& compute_encoder = metal::get_command_encoder(s);
compute_encoder.set_compute_pipeline_state(kernel);
int arg_idx = 0;
+1 -1
View File
@@ -389,7 +389,7 @@ void Compiled::eval_gpu(
kernel_name += "_large";
}
auto kernel = d.get_kernel(kernel_name, lib);
auto& compute_encoder = d.get_command_encoder(s.index);
auto& compute_encoder = metal::get_command_encoder(s);
compute_encoder.set_compute_pipeline_state(kernel);
// Put the inputs in

Some files were not shown because too many files have changed in this diff Show More