diff options
author | Mehdi Amini <joker.eph@gmail.com> | 2024-02-16 13:25:03 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-02-16 13:25:03 -0800 |
commit | 450462cbaceddf57812ce15b5135b17f65a77654 (patch) | |
tree | 28521ffb9ae2df5e02919f17f7578ec18ba05e99 /mlir/docs | |
parent | 7c3ad9e72bc034ad655a7e16aa73b9864c58768b (diff) | |
download | llvm-450462cbaceddf57812ce15b5135b17f65a77654.zip llvm-450462cbaceddf57812ce15b5135b17f65a77654.tar.gz llvm-450462cbaceddf57812ce15b5135b17f65a77654.tar.bz2 |
[MLIR] Document the stability and versioning aspect of the Bytecode (#81969)
See the two RFCs:
https://discourse.llvm.org/t/rfc-mlir-bytecode-a-stable-serialization-format/71062
https://discourse.llvm.org/t/rfc-ir-versioning/5893
Diffstat (limited to 'mlir/docs')
-rw-r--r-- | mlir/docs/BytecodeFormat.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/mlir/docs/BytecodeFormat.md b/mlir/docs/BytecodeFormat.md index 589671e..869b2d8 100644 --- a/mlir/docs/BytecodeFormat.md +++ b/mlir/docs/BytecodeFormat.md @@ -1,6 +1,25 @@ # MLIR Bytecode Format This documents describes the MLIR bytecode format and its encoding. +This format is versioned and stable: we don't plan to ever break +compatibility, that is a dialect should be able to deserialize and +older bytecode. Similarly, we support back-deployment we an older +version of the format can be targetted. + +That said, it is important to realize that the promises of the +bytecode format are made assuming immutable dialects: the format +allows backward and forward compatibility, but only when nothing +in a dialect changes (operations, types, attributes definitions). + +A dialect can opt-in to handle its own versioning through the +`BytecodeDialectInterface`. Some hooks are exposed to the dialect +to allow managing a version encoded into the bytecode file. The +version is loaded lazily and allows to retrieve the version +information while decoding the input IR, and gives an opportunity +to each dialect for which a version is present to perform IR +upgrades post-parsing through the `upgradeFromVersion` method. +There is no restriction on what kind of information a dialect +is allowed to encode to model its versioning [TOC] |