1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
//===- AdaptorTest.cpp - Adaptor unit tests -------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
#include "mlir/Bytecode/BytecodeReader.h"
#include "mlir/Bytecode/BytecodeWriter.h"
#include "mlir/IR/AsmState.h"
#include "mlir/IR/BuiltinAttributes.h"
#include "mlir/IR/OpImplementation.h"
#include "mlir/IR/OwningOpRef.h"
#include "mlir/Parser/Parser.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/Endian.h"
#include "llvm/Support/MemoryBufferRef.h"
#include "llvm/Support/raw_ostream.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"
using namespace llvm;
using namespace mlir;
StringLiteral irWithResources = R"(
module @TestDialectResources attributes {
bytecode.test = dense_resource<resource> : tensor<4xi32>
} {}
{-#
dialect_resources: {
builtin: {
resource: "0x2000000001000000020000000300000004000000",
resource_2: "0x2000000001000000020000000300000004000000"
}
}
#-}
)";
struct MockOstream final : public raw_ostream {
std::unique_ptr<std::byte[]> buffer;
size_t size = 0;
MOCK_METHOD(void, reserveExtraSpace, (uint64_t extraSpace), (override));
MockOstream() : raw_ostream(true) {}
uint64_t current_pos() const override { return pos; }
private:
size_t pos = 0;
void write_impl(const char *ptr, size_t length) override {
if (pos + length <= size) {
memcpy((void *)(buffer.get() + pos), ptr, length);
pos += length;
} else {
report_fatal_error(
"Attempted to write past the end of the fixed size buffer.");
}
}
};
TEST(Bytecode, MultiModuleWithResource) {
MLIRContext context;
Builder builder(&context);
ParserConfig parseConfig(&context);
OwningOpRef<Operation *> module =
parseSourceString<Operation *>(irWithResources, parseConfig);
ASSERT_TRUE(module);
// Write the module to bytecode.
MockOstream ostream;
EXPECT_CALL(ostream, reserveExtraSpace).WillOnce([&](uint64_t space) {
ostream.buffer = std::make_unique<std::byte[]>(space);
ostream.size = space;
});
ASSERT_TRUE(succeeded(writeBytecodeToFile(module.get(), ostream)));
// Create copy of buffer which is aligned to requested resource alignment.
std::string buffer((char *)ostream.buffer.get(),
(char *)ostream.buffer.get() + ostream.size);
constexpr size_t kAlignment = 0x20;
size_t bufferSize = buffer.size();
buffer.reserve(bufferSize + kAlignment - 1);
size_t pad = (~(uintptr_t)buffer.data() + 1) & (kAlignment - 1);
buffer.insert(0, pad, ' ');
StringRef alignedBuffer(buffer.data() + pad, bufferSize);
// Parse it back
OwningOpRef<Operation *> roundTripModule =
parseSourceString<Operation *>(alignedBuffer, parseConfig);
ASSERT_TRUE(roundTripModule);
// FIXME: Parsing external resources does not work on big-endian
// platforms currently.
if (llvm::endianness::native == llvm::endianness::big)
GTEST_SKIP();
// Try to see if we have a valid resource in the parsed module.
auto checkResourceAttribute = [](Operation *parsedModule) {
Attribute attr = parsedModule->getDiscardableAttr("bytecode.test");
ASSERT_TRUE(attr);
auto denseResourceAttr = dyn_cast<DenseI32ResourceElementsAttr>(attr);
ASSERT_TRUE(denseResourceAttr);
std::optional<ArrayRef<int32_t>> attrData =
denseResourceAttr.tryGetAsArrayRef();
ASSERT_TRUE(attrData.has_value());
ASSERT_EQ(attrData->size(), static_cast<size_t>(4));
EXPECT_EQ((*attrData)[0], 1);
EXPECT_EQ((*attrData)[1], 2);
EXPECT_EQ((*attrData)[2], 3);
EXPECT_EQ((*attrData)[3], 4);
};
checkResourceAttribute(*module);
checkResourceAttribute(*roundTripModule);
}
namespace {
/// A custom operation for the purpose of showcasing how discardable attributes
/// are handled in absence of properties.
class OpWithoutProperties : public Op<OpWithoutProperties> {
public:
// Begin boilerplate.
MLIR_DEFINE_EXPLICIT_INTERNAL_INLINE_TYPE_ID(OpWithoutProperties)
using Op::Op;
static ArrayRef<StringRef> getAttributeNames() {
static StringRef attributeNames[] = {StringRef("inherent_attr")};
return ArrayRef(attributeNames);
};
static StringRef getOperationName() {
return "test_op_properties.op_without_properties";
}
// End boilerplate.
};
// A trivial supporting dialect to register the above operation.
class TestOpPropertiesDialect : public Dialect {
public:
MLIR_DEFINE_EXPLICIT_INTERNAL_INLINE_TYPE_ID(TestOpPropertiesDialect)
static constexpr StringLiteral getDialectNamespace() {
return StringLiteral("test_op_properties");
}
explicit TestOpPropertiesDialect(MLIRContext *context)
: Dialect(getDialectNamespace(), context,
TypeID::get<TestOpPropertiesDialect>()) {
addOperations<OpWithoutProperties>();
}
};
} // namespace
constexpr StringLiteral withoutPropertiesAttrsSrc = R"mlir(
"test_op_properties.op_without_properties"()
{inherent_attr = 42, other_attr = 56} : () -> ()
)mlir";
TEST(Bytecode, OpWithoutProperties) {
MLIRContext context;
context.getOrLoadDialect<TestOpPropertiesDialect>();
ParserConfig config(&context);
OwningOpRef<Operation *> op =
parseSourceString(withoutPropertiesAttrsSrc, config);
std::string bytecode;
llvm::raw_string_ostream os(bytecode);
ASSERT_TRUE(succeeded(writeBytecodeToFile(op.get(), os)));
std::unique_ptr<Block> block = std::make_unique<Block>();
ASSERT_TRUE(succeeded(readBytecodeFile(
llvm::MemoryBufferRef(bytecode, "string-buffer"), block.get(), config)));
Operation *roundtripped = &block->front();
EXPECT_EQ(roundtripped->getAttrs().size(), 2u);
EXPECT_TRUE(roundtripped->getInherentAttr("inherent_attr") != std::nullopt);
EXPECT_TRUE(roundtripped->getDiscardableAttr("other_attr") != Attribute());
EXPECT_TRUE(OperationEquivalence::computeHash(op.get()) ==
OperationEquivalence::computeHash(roundtripped));
}
|
