Guray Ozen 3d41197d68

[MLIR] Introduce RemarkEngine + pluggable remark streaming (YAML/Bitstream) (#152474) ...

This PR implements structured, tooling-friendly optimization remarks
with zero cost unless enabled. It implements:
- `RemarkEngine` collects finalized remarks within `MLIRContext`.
- `MLIRRemarkStreamerBase` abstract class streams them to a backend.
- Backends: `MLIRLLVMRemarkStreamer` (bridges to llvm::remarks →
YAML/Bitstream) or your own custom streamer.
- Optional mirroring to DiagnosticEngine (printAsEmitRemarks +
categories).
- Off by default; no behavior change unless enabled. Thread-safe;
ordering best-effort.


## Overview

```
Passes (reportOptimization*)
         │
         ▼
+-------------------+
|  RemarkEngine     |   collects
+-------------------+
     │         │
     │ mirror  │ stream
     ▼         ▼
emitRemark    MLIRRemarkStreamerBase (abstract)
                   │
                   ├── MLIRLLVMRemarkStreamer → llvm::remarks → YAML | Bitstream
                   └── CustomStreamer → your sink
```

## Enable Remark engine and Plug LLVM's Remark streamer
```
// Enable once per MLIRContext. This uses `MLIRLLVMRemarkStreamer`
mlir::remark::enableOptimizationRemarksToFile(
    ctx, path, llvm::remarks::Format::YAML, cats);
```

## API to emit remark
```
// Emit from a pass
 remark::passed(loc, categoryVectorizer, myPassname1)
        << "vectorized loop";

remark::missed(loc, categoryUnroll, "MyPass")
        << remark::reason("not profitable at this size")   // Creates structured reason arg
        << remark::suggest("increase unroll factor to >=4");   // Creates structured suggestion arg

remark::passed(loc, categoryVectorizer, myPassname1)
        << "vectorized loop" 
        << remark::metric("tripCount", 128);                // Create structured metric on-the-fly
```

2025-08-21 16:02:31 +02:00

..

PDL

[mlir] Remove unused includes (NFC) (#150476)

2025-07-24 11:23:53 -07:00

AffineExpr.cpp

[mlir] Remove unused includes (NFC) (#150476)

2025-07-24 11:23:53 -07:00

AffineExprDetail.h

…

AffineMap.cpp

[mlir] Remove unused includes (NFC) (#146812)

2025-07-03 09:08:09 -07:00

AffineMapDetail.h

[NFCI][LLVM/MLIR] Adopt TrailingObjects convenience API (#138554)

2025-05-12 16:17:43 -07:00

AsmPrinter.cpp

[MLIR] Use LDBG in MLIR AsmPrinter (#151163)

2025-07-30 17:56:34 +02:00

AttributeDetail.h

[MLIR] Fix use-after-frees when accessing DistinctAttr storage (#148666)

2025-07-16 12:11:38 +02:00

Attributes.cpp

[mlir] Add NamedAttribute ctor taking StringRef. NFC. (#123974)

2025-01-22 19:02:17 -05:00

AttrTypeSubElements.cpp

[mlir] Avoid repeated hash lookups (NFC) (#107519)

2024-09-06 07:48:39 -07:00

Block.cpp

[mlir][IR] Fix Block::without_terminator for blocks without terminator (#154498)

2025-08-20 18:02:24 +02:00

Builders.cpp

[mlir] Remove unused includes (NFC) (#146812)

2025-07-03 09:08:09 -07:00

BuiltinAttributeInterfaces.cpp

[mlir][MemRef][~NFC] Move getStridesAndOffset() onto layouts (#138011)

2025-05-05 09:09:32 -07:00

BuiltinAttributes.cpp

[MLIR] Adopt LDBG() macro in BuiltinAttributes.cpp (NFC) (#154723)

2025-08-21 10:31:18 +00:00

BuiltinDialect.cpp

[mlir][NFC] update mlir/lib create APIs (26/n) (#149933)

2025-07-22 08:40:42 -04:00

BuiltinDialectBytecode.cpp

[MLIR][NFC] Fix incomplete boundary comments. (#133516)

2025-03-31 09:29:54 -07:00

BuiltinDialectBytecode.h

…

BuiltinTypeInterfaces.cpp

[mlir] Remove unused includes (NFC) (#146812)

2025-07-03 09:08:09 -07:00

BuiltinTypes.cpp

[mlir] Add isStatic* size check for ShapedTypes. NFCI. (#147085)

2025-07-07 14:57:27 -04:00

CMakeLists.txt

[MLIR] Introduce RemarkEngine + pluggable remark streaming (YAML/Bitstream) (#152474)

2025-08-21 16:02:31 +02:00

Diagnostics.cpp

[mlir] Report line number from file rather than split (#150982)

2025-07-29 13:29:00 +02:00

Dialect.cpp

[MLIR] Use LDBG() macro in Dialect.cpp (NFC) (#154720)

2025-08-21 10:28:51 +00:00

DialectResourceBlobManager.cpp

[mlir] Allow accessing DialectResourceBlobManager::blobMap (#142352)

2025-06-23 09:50:28 +02:00

Dominance.cpp

[mlir] Remove unused includes (NFC) (#146812)

2025-07-03 09:08:09 -07:00

ExtensibleDialect.cpp

[mlir] Clean up prints with llvm::interleaved. NFC. (#136468)

2025-04-19 22:59:57 -04:00

IntegerSet.cpp

…

IntegerSetDetail.h

…

Location.cpp

[mlir] Remove unused includes (NFC) (#150476)

2025-07-24 11:23:53 -07:00

MLIRContext.cpp

[MLIR] Introduce RemarkEngine + pluggable remark streaming (YAML/Bitstream) (#152474)

2025-08-21 16:02:31 +02:00

ODSSupport.cpp

[MLIR] Add support for IntArrayProp<I32Prop> (#146685)

2025-07-06 11:55:02 +02:00

Operation.cpp

[mlir] Remove unused includes (NFC) (#146812)

2025-07-03 09:08:09 -07:00

OperationSupport.cpp

[mlir] Remove unused includes (NFC) (#146812)

2025-07-03 09:08:09 -07:00

PatternLoggingListener.cpp

[MLIR] Migrate PatternLoggingListener to the standard LDBG output (#150686)

2025-07-25 21:51:07 +02:00

PatternMatch.cpp

[mlir][IR] Set insertion point when erasing an operation (#146955)

2025-07-27 10:27:27 +02:00

Region.cpp

[MLIR][NFC] Fix comment in Region.cpp

2025-02-24 15:33:44 +01:00

RegionKindInterface.cpp

[mlir][IR] Trigger notifyOperationRemoved callback for nested ops (#66771)

2023-09-20 08:45:46 +02:00

Remarks.cpp

[MLIR] Introduce RemarkEngine + pluggable remark streaming (YAML/Bitstream) (#152474)

2025-08-21 16:02:31 +02:00

SymbolTable.cpp

[mlir] Remove unused includes (NFC) (#150476)

2025-07-24 11:23:53 -07:00

TensorEncoding.cpp

…

TypeDetail.h

[NFCI][LLVM/MLIR] Adopt TrailingObjects convenience API (#138554)

2025-05-12 16:17:43 -07:00

TypeRange.cpp

[mlir] Remove unused includes (NFC) (#146812)

2025-07-03 09:08:09 -07:00

Types.cpp

[MLIR][AMDGPU] Add OCP FP8 support for new hardware (#127728)

2025-03-03 14:10:31 -06:00

TypeUtilities.cpp

[mlir] Add isStatic* size check for ShapedTypes. NFCI. (#147085)

2025-07-07 14:57:27 -04:00

Unit.cpp

[mlir] Remove unused includes (NFC) (#146812)

2025-07-03 09:08:09 -07:00

Value.cpp

[mlir] Remove unused includes (NFC) (#150476)

2025-07-24 11:23:53 -07:00

ValueRange.cpp

[MLIR][NFC] Fix incomplete boundary comments. (#133516)

2025-03-31 09:29:54 -07:00

Verifier.cpp

[mlir] Remove unused local variables (NFC) (#138642)

2025-05-06 07:55:50 -07:00

Visitors.cpp

…