[Codegen] Use default read semantics for LinalgExt scatter (#24504)
The original impl. will introduce critical but very subtle bugs. We
identified the bug when running Qwen-3.5, with decode-prefill-decode
pattern. Because of the problem detailed below, the 2nd decode are
completely wrong.
## Problem
`iree_linalg_ext.scatter` **was** special-cased in the LinalgExt
bufferization
external model as not reading its DPS init operand which is not correct.
## Fix
Remove the ScatterOp-specific no-read override and use the default
DestinationStyleOpInterface bufferization read semantics.
After this change, out-of-place bufferization preserves the init value
before
scatter updates it:
```
alloc tmp[32][1][512]
copy original -> tmp // which was previously dropped.
scatter writes 11 rows into tmp
```
### Minimal Repro
A simple overwrite scatter still needs to preserve elements that are not
updated:
```text
result = original // this was incorrectly dropped if it's not fixed with
the config shown in test cases attached
for i in updated_indices:
result[i] = update[i]
```
Example shape:
original: 32 x 1 x 512
updates : 11 x 1 x 512
indices : 11 rows
result : 32 x 1 x 512
Scatter writes only 11 rows. The remaining 21 rows must come from original.
**Before this change, bufferization thinks `outs(%original)` as a destination
placeholder instead of a read. So it stores tmp[32][1][512] to output**
### Analysis
I propose that we remove the override because scatter op should be bufferized as reads except for some small corner cases. Overriding the scatter op does not preserve correctness.
Let's analyze the following cases for scatter:
- `updates` is read: scatter must read the update value.
- `indices` is read: scatter must read indices to know where to write.
- `mask`, if present, is read: a false mask suppresses the update and preserves
the original value.
- DPS init / original is read:
- elements not hit by `indices` must be inherited from original;
- masked-off updates must preserve original;
- the combiner region may use the old value, e.g. `yield update + old`;
- `unique_indices(false)` combine/reduction-style scatter also needs the
old/current value.
The only case where init may not need to be read is a separately proven
full-overwrite optimization: indices cover the entire result, mask cannot
suppress updates, and the combiner does not use the old value. That should be
handled by a dedicated copy-elision/full-overwrite analysis, not by the default
bufferization semantics.
## Tests
Added LLVMGPU bufferization tests for:
- overwrite scatter preserving original;
- combiner scatter reading original;
- masked scatter preserving original.
Signed-off-by: Yuwei Sun <yuweis2@illinois.edu>
Signed-off-by: Hao Ren <rhao8608@gmail.com>
Co-authored-by: Hao Ren <rhao8608@gmail.com>
Co-authored-by: Yuwei Sun <yuweis2@illinois.edu>IREE (Intermediate Representation Execution Eenvironment, pronounced as “eerie”) is an MLIR-based end-to-end compiler and runtime that lowers Machine Learning (ML) models to a unified IR that scales up to meet the needs of the datacenter and down to satisfy the constraints and special considerations of mobile and edge deployments.
See our website for project details, user guides, and instructions on building from source.
Releases notes are published on GitHub releases.
| Package | Release status |
|---|---|
| GitHub release (stable) | |
| GitHub release (nightly) | |
iree-base-compiler | |
iree-base-runtime |
For more details on the release process, see https://iree.dev/developers/general/release-management/.
| Operating system | Build status |
|---|---|
| Linux | |
| macOS | |
| macOS |
For the full list of workflows see https://iree.dev/developers/general/github-actions/.
See our website for more information.
Community meeting recordings: IREE YouTube channel
| Date | Title | Recording | Slides |
|---|---|---|---|
| 2025-06-10 | Data-Tiling in IREE: Achieving High Performance Through Compiler Design (AsiaLLVM) | recording | slides |
| 2025-05-17 | Introduction to GPU architecture and IREE's GPU CodeGen Pipeline | recording | slides |
| 2025-02-12 | The Long Tail of AI: SPIR-V in IREE and MLIR (Vulkanised) | recording | slides |
| 2024-10-01 | Unveiling the Inner Workings of IREE: An MLIR-Based Compiler for Diverse Hardware | recording | |
| 2021-06-09 | IREE Runtime Design Tech Talk | recording | slides |
| 2020-08-20 | IREE CodeGen (MLIR Open Design Meeting) | recording | slides |
| 2020-03-18 | Interactive HAL IR Walkthrough | recording | |
| 2020-01-31 | End-to-end MLIR Workflow in IREE (MLIR Open Design Meeting) | recording | slides |
IREE is licensed under the terms of the Apache 2.0 License with LLVM Exceptions. See LICENSE for more information.