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 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
|
//===- SPIRVFunction.cpp - Class to represent a SPIR-V Function --- C++ -*-===//
//
// The LLVM/SPIRV Translator
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file implements Function class for SPIRV.
//
// Copyright (c) 2014 Advanced Micro Devices, Inc. All rights reserved.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal with the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimers.
// Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimers in the documentation
// and/or other materials provided with the distribution.
// Neither the names of Advanced Micro Devices, Inc., nor the names of its
// contributors may be used to endorse or promote products derived from this
// Software without specific prior written permission.
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH
// THE SOFTWARE.
//
//===----------------------------------------------------------------------===//
#include "SPIRVFunction.h"
#include "SPIRVBasicBlock.h"
#include "SPIRVEntry.h"
#include "SPIRVInstruction.h"
#include "SPIRVStream.h"
#include <algorithm>
#include <functional>
using namespace SPIRV;
SPIRVFunctionParameter::SPIRVFunctionParameter(SPIRVType *TheType,
SPIRVId TheId,
SPIRVFunction *TheParent,
unsigned TheArgNo)
: SPIRVValue(TheParent->getModule(), 3, OpFunctionParameter, TheType,
TheId),
ParentFunc(TheParent), ArgNo(TheArgNo) {
validate();
}
void SPIRVFunctionParameter::foreachAttr(
std::function<void(SPIRVFuncParamAttrKind)> Func) {
auto Locs = Decorates.equal_range(DecorationFuncParamAttr);
for (auto I = Locs.first, E = Locs.second; I != E; ++I) {
auto Attr = static_cast<SPIRVFuncParamAttrKind>(I->second->getLiteral(0));
assert(isValid(Attr));
Func(Attr);
}
}
SPIRVDecoder SPIRVFunction::getDecoder(std::istream &IS) {
return SPIRVDecoder(IS, *this);
}
void SPIRVFunction::encode(spv_ostream &O) const {
getEncoder(O) << Type << Id << FCtrlMask << FuncType;
}
void SPIRVFunction::encodeChildren(spv_ostream &O) const {
O << SPIRVNL();
for (auto &I : Parameters)
O << *I;
O << SPIRVNL();
for (auto &I : BBVec)
O << *I;
O << SPIRVFunctionEnd();
}
void SPIRVFunction::encodeExecutionModes(spv_ostream &O) const {
for (auto &I : ExecModes)
O << *I.second;
}
void SPIRVFunction::decode(std::istream &I) {
SPIRVDecoder Decoder = getDecoder(I);
Decoder >> Type >> Id >> FCtrlMask >> FuncType;
Module->addFunction(this);
SPIRVDBG(spvdbgs() << "Decode function: " << Id << '\n');
Decoder.getWordCountAndOpCode();
while (!I.eof()) {
if (Decoder.OpCode == OpFunctionEnd)
break;
switch (Decoder.OpCode) {
case OpFunctionParameter: {
auto *Param = static_cast<SPIRVFunctionParameter *>(Decoder.getEntry());
assert(Param);
Module->add(Param);
Param->setParent(this);
Parameters.push_back(Param);
Decoder.getWordCountAndOpCode();
break;
}
case OpLabel: {
if (!decodeBB(Decoder))
return;
break;
}
default:
assert(0 && "Invalid SPIRV format");
}
}
}
/// Decode basic block and contained instructions.
/// Do it here instead of in BB:decode to avoid back track in input stream.
bool SPIRVFunction::decodeBB(SPIRVDecoder &Decoder) {
SPIRVBasicBlock *BB = static_cast<SPIRVBasicBlock *>(Decoder.getEntry());
assert(BB);
addBasicBlock(BB);
SPIRVDBG(spvdbgs() << "Decode BB: " << BB->getId() << '\n');
Decoder.setScope(BB);
SPIRVEntry *DebugScope = nullptr;
while (Decoder.getWordCountAndOpCode()) {
if (Decoder.OpCode == OpFunctionEnd || Decoder.OpCode == OpLabel) {
break;
}
if (Decoder.OpCode == OpNoLine || Decoder.OpCode == OpNop) {
continue;
}
SPIRVEntry *Entry = Decoder.getEntry();
if (Decoder.OpCode == OpLine) {
std::shared_ptr<const SPIRVLine> L(static_cast<SPIRVLine *>(Entry));
Module->setCurrentLine(L);
continue;
}
if (!Module->getErrorLog().checkError(Entry->isImplemented(),
SPIRVEC_UnimplementedOpCode,
std::to_string(Entry->getOpCode()))) {
// Bail out if the opcode is not implemented.
Module->setInvalid();
delete Entry;
return false;
}
auto *Inst = static_cast<SPIRVInstruction *>(Entry);
assert(Inst);
if (Inst->getOpCode() == OpUndef) {
Module->add(Inst);
} else if (Inst->isExtInst(SPIRVEIS_NonSemantic_Shader_DebugInfo_100,
SPIRVDebug::DebugNoLine) ||
Inst->isExtInst(SPIRVEIS_NonSemantic_Shader_DebugInfo_200,
SPIRVDebug::DebugNoLine)) {
delete Entry;
continue;
} else if (Inst->isExtInst(SPIRVEIS_NonSemantic_Shader_DebugInfo_100,
SPIRVDebug::DebugLine) ||
Inst->isExtInst(SPIRVEIS_NonSemantic_Shader_DebugInfo_200,
SPIRVDebug::DebugLine)) {
std::shared_ptr<const SPIRVExtInst> DL(static_cast<SPIRVExtInst *>(Inst));
Module->setCurrentDebugLine(DL);
} else {
if (Inst->isExtInst(SPIRVEIS_Debug, SPIRVDebug::Scope) ||
Inst->isExtInst(SPIRVEIS_OpenCL_DebugInfo_100, SPIRVDebug::Scope) ||
Inst->isExtInst(SPIRVEIS_NonSemantic_Shader_DebugInfo_100,
SPIRVDebug::Scope) ||
Inst->isExtInst(SPIRVEIS_NonSemantic_Shader_DebugInfo_200,
SPIRVDebug::Scope)) {
DebugScope = Inst;
} else if (Inst->isExtInst(SPIRVEIS_Debug, SPIRVDebug::NoScope) ||
Inst->isExtInst(SPIRVEIS_OpenCL_DebugInfo_100,
SPIRVDebug::NoScope) ||
Inst->isExtInst(SPIRVEIS_NonSemantic_Shader_DebugInfo_100,
SPIRVDebug::NoScope) ||
Inst->isExtInst(SPIRVEIS_NonSemantic_Shader_DebugInfo_200,
SPIRVDebug::NoScope)) {
DebugScope = nullptr;
} else {
Inst->setDebugScope(DebugScope);
}
BB->addInstruction(Inst);
}
}
Decoder.setScope(this);
return true;
}
void SPIRVFunction::foreachReturnValueAttr(
std::function<void(SPIRVFuncParamAttrKind)> Func) {
auto Locs = Decorates.equal_range(DecorationFuncParamAttr);
for (auto I = Locs.first, E = Locs.second; I != E; ++I) {
auto Attr = static_cast<SPIRVFuncParamAttrKind>(I->second->getLiteral(0));
assert(isValid(Attr));
Func(Attr);
}
}
|