mirror of
https://github.com/intel/llvm.git
synced 2026-01-26 21:53:12 +08:00
0e0b6070fd
A dialect can opt-in to handle versioning through the `BytecodeDialectInterface`. Few 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 parsing 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. Custom Attribute and Type encodings can also be upgraded according to the dialect version using readAttribute and readType methods. There is no restriction on what kind of information a dialect is allowed to encode to model its versioning. Currently, versioning is supported only for bytecode formats. Reviewed By: rriddle, mehdi_amini Differential Revision: https://reviews.llvm.org/D143647
98 lines
2.9 KiB
C++
98 lines
2.9 KiB
C++
//===- Encoding.h - MLIR binary format encoding information -----*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This header defines enum values describing the structure of MLIR bytecode
|
|
// files.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LIB_MLIR_BYTECODE_ENCODING_H
|
|
#define LIB_MLIR_BYTECODE_ENCODING_H
|
|
|
|
#include <cstdint>
|
|
|
|
namespace mlir {
|
|
namespace bytecode {
|
|
//===----------------------------------------------------------------------===//
|
|
// General constants
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
enum {
|
|
/// The minimum supported version of the bytecode.
|
|
kMinSupportedVersion = 0,
|
|
|
|
/// The current bytecode version.
|
|
kVersion = 1,
|
|
|
|
/// An arbitrary value used to fill alignment padding.
|
|
kAlignmentByte = 0xCB,
|
|
};
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
// Sections
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
namespace Section {
|
|
enum ID : uint8_t {
|
|
/// This section contains strings referenced within the bytecode.
|
|
kString = 0,
|
|
|
|
/// This section contains the dialects referenced within an IR module.
|
|
kDialect = 1,
|
|
|
|
/// This section contains the attributes and types referenced within an IR
|
|
/// module.
|
|
kAttrType = 2,
|
|
|
|
/// This section contains the offsets for the attribute and types within the
|
|
/// AttrType section.
|
|
kAttrTypeOffset = 3,
|
|
|
|
/// This section contains the list of operations serialized into the bytecode,
|
|
/// and their nested regions/operations.
|
|
kIR = 4,
|
|
|
|
/// This section contains the resources of the bytecode.
|
|
kResource = 5,
|
|
|
|
/// This section contains the offsets of resources within the Resource
|
|
/// section.
|
|
kResourceOffset = 6,
|
|
|
|
/// This section contains the versions of each dialect.
|
|
kDialectVersions = 7,
|
|
|
|
/// The total number of section types.
|
|
kNumSections = 8,
|
|
};
|
|
} // namespace Section
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
// IR Section
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
/// This enum represents a mask of all of the potential components of an
|
|
/// operation. This mask is used when encoding an operation to indicate which
|
|
/// components are present in the bytecode.
|
|
namespace OpEncodingMask {
|
|
enum : uint8_t {
|
|
// clang-format off
|
|
kHasAttrs = 0b00000001,
|
|
kHasResults = 0b00000010,
|
|
kHasOperands = 0b00000100,
|
|
kHasSuccessors = 0b00001000,
|
|
kHasInlineRegions = 0b00010000,
|
|
// clang-format on
|
|
};
|
|
} // namespace OpEncodingMask
|
|
|
|
} // namespace bytecode
|
|
} // namespace mlir
|
|
|
|
#endif
|