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
|
//===- ConvertFromBinary.cpp - MLIR SPIR-V binary to module conversion ----===//
//
// Copyright 2019 The MLIR Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// =============================================================================
//
// This file implements a translation from SPIR-V binary module to MLIR SPIR-V
// ModuleOp.
//
//===----------------------------------------------------------------------===//
#include "mlir/Dialect/SPIRV/SPIRVOps.h"
#include "mlir/Dialect/SPIRV/Serialization.h"
#include "mlir/Dialect/StandardOps/Ops.h"
#include "mlir/IR/Builders.h"
#include "mlir/IR/Function.h"
#include "mlir/IR/Module.h"
#include "mlir/Support/FileUtilities.h"
#include "mlir/Translation.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/MemoryBuffer.h"
using namespace mlir;
// Adds a one-block function named as `spirv_module` to `module` and returns the
// block. The created block will be terminated by `std.return`.
Block *createOneBlockFunction(Builder builder, ModuleOp module) {
auto fnType = builder.getFunctionType(/*inputs=*/{}, /*results=*/{});
auto fn = FuncOp::create(builder.getUnknownLoc(), "spirv_module", fnType);
module.push_back(fn);
auto *block = fn.addEntryBlock();
OpBuilder(block).create<ReturnOp>(builder.getUnknownLoc());
return block;
}
// Deserializes the SPIR-V binary module stored in the file named as
// `inputFilename` and returns a module containing the SPIR-V module.
OwningModuleRef deserializeModule(llvm::StringRef inputFilename,
MLIRContext *context) {
Builder builder(context);
std::string errorMessage;
auto file = openInputFile(inputFilename, &errorMessage);
if (!file) {
emitError(UnknownLoc::get(context), errorMessage);
return {};
}
// Make sure the input stream can be treated as a stream of SPIR-V words
auto start = file->getBufferStart();
auto size = file->getBufferSize();
if (size % sizeof(uint32_t) != 0) {
emitError(UnknownLoc::get(context))
<< "SPIR-V binary module must contain integral number of 32-bit words";
return {};
}
auto binary = llvm::makeArrayRef(reinterpret_cast<const uint32_t *>(start),
size / sizeof(uint32_t));
auto spirvModule = spirv::deserialize(binary, context);
if (!spirvModule)
return {};
// TODO(antiagainst): due to the restriction of the current translation
// infrastructure, we must return a MLIR module here. So we are wrapping the
// converted SPIR-V ModuleOp inside a MLIR module. This should be changed to
// return the SPIR-V ModuleOp directly after module and function are migrated
// to be general ops.
OwningModuleRef module(ModuleOp::create(
FileLineColLoc::get(inputFilename, /*line=*/0, /*column=*/0, context)));
Block *block = createOneBlockFunction(builder, module.get());
block->push_front(spirvModule->getOperation());
return module;
}
static TranslateToMLIRRegistration
registration("deserialize-spirv",
[](StringRef inputFilename, MLIRContext *context) {
return deserializeModule(inputFilename, context);
});
|