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
|
//===- SPIRVFunction.h - 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 defines 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.
//
//===----------------------------------------------------------------------===//
#ifndef SPIRV_LIBSPIRV_SPIRVFUNCTION_H
#define SPIRV_LIBSPIRV_SPIRVFUNCTION_H
#include "SPIRVBasicBlock.h"
#include "SPIRVValue.h"
#include <functional>
namespace SPIRV {
class BIFunction;
class SPIRVDecoder;
class SPIRVFunctionParameter : public SPIRVValue {
public:
SPIRVFunctionParameter(SPIRVType *TheType, SPIRVId TheId,
SPIRVFunction *TheParent, unsigned TheArgNo);
SPIRVFunctionParameter()
: SPIRVValue(OpFunctionParameter), ParentFunc(nullptr), ArgNo(0) {}
unsigned getArgNo() const { return ArgNo; }
void foreachAttr(std::function<void(SPIRVFuncParamAttrKind)>);
void addAttr(SPIRVFuncParamAttrKind Kind) {
addDecorate(new SPIRVDecorate(DecorationFuncParamAttr, this, Kind));
}
void setParent(SPIRVFunction *Parent) { ParentFunc = Parent; }
bool hasAttr(SPIRVFuncParamAttrKind Kind) const {
return getDecorate(DecorationFuncParamAttr).count(Kind);
}
bool isByVal() const { return hasAttr(FunctionParameterAttributeByVal); }
bool isZext() const { return hasAttr(FunctionParameterAttributeZext); }
SPIRVCapVec getRequiredCapability() const override {
if (hasLinkageType() && getLinkageType() == LinkageTypeImport)
return getVec(CapabilityLinkage);
return SPIRVCapVec();
}
protected:
void validate() const override {
SPIRVValue::validate();
assert(ParentFunc && "Invalid parent function");
}
_SPIRV_DEF_ENCDEC2(Type, Id)
private:
SPIRVFunction *ParentFunc;
unsigned ArgNo;
};
class SPIRVFunction : public SPIRVValue, public SPIRVComponentExecutionModes {
public:
// Complete constructor. It does not construct basic blocks.
SPIRVFunction(SPIRVModule *M, SPIRVTypeFunction *FunctionType, SPIRVId TheId)
: SPIRVValue(M, 5, OpFunction, FunctionType->getReturnType(), TheId),
FuncType(FunctionType), FCtrlMask(FunctionControlMaskNone) {
addAllArguments(TheId + 1);
validate();
}
// Incomplete constructor
SPIRVFunction()
: SPIRVValue(OpFunction), FuncType(NULL),
FCtrlMask(FunctionControlMaskNone) {}
SPIRVDecoder getDecoder(std::istream &IS) override;
SPIRVTypeFunction *getFunctionType() const { return FuncType; }
SPIRVWord getFuncCtlMask() const { return FCtrlMask; }
size_t getNumBasicBlock() const { return BBVec.size(); }
SPIRVBasicBlock *getBasicBlock(size_t I) const { return BBVec[I]; }
size_t getNumArguments() const {
return getFunctionType()->getNumParameters();
}
SPIRVId getArgumentId(size_t I) const { return Parameters[I]->getId(); }
const std::vector<SPIRVId> getVariables() const {
std::vector<SPIRVId> Ids;
for (auto Variable : Variables)
Ids.push_back(Variable->getId());
return Ids;
}
void addVariable(const SPIRVValue *Variable) {
Variables.push_back(Variable);
}
SPIRVFunctionParameter *getArgument(size_t I) const { return Parameters[I]; }
void foreachArgument(std::function<void(SPIRVFunctionParameter *)> Func) {
for (size_t I = 0, E = getNumArguments(); I != E; ++I)
Func(getArgument(I));
}
void foreachReturnValueAttr(std::function<void(SPIRVFuncParamAttrKind)>);
void setFunctionControlMask(SPIRVWord Mask) { FCtrlMask = Mask; }
void takeExecutionModes(SPIRVForward *Forward) {
ExecModes = std::move(Forward->ExecModes);
}
// Assume BB contains valid Id.
SPIRVBasicBlock *addBasicBlock(SPIRVBasicBlock *BB) {
Module->add(BB);
BB->setParent(this);
BBVec.push_back(BB);
return BB;
}
void encodeChildren(spv_ostream &) const override;
void encodeExecutionModes(spv_ostream &) const;
_SPIRV_DCL_ENCDEC
void validate() const override {
SPIRVValue::validate();
validateFunctionControlMask(FCtrlMask);
assert(FuncType && "Invalid func type");
}
private:
SPIRVFunctionParameter *addArgument(unsigned TheArgNo, SPIRVId TheId) {
SPIRVFunctionParameter *Arg = new SPIRVFunctionParameter(
getFunctionType()->getParameterType(TheArgNo), TheId, this, TheArgNo);
Module->add(Arg);
Parameters.push_back(Arg);
return Arg;
}
void addAllArguments(SPIRVId FirstArgId) {
for (size_t I = 0, E = getFunctionType()->getNumParameters(); I != E; ++I)
addArgument(I, FirstArgId + I);
}
bool decodeBB(SPIRVDecoder &);
SPIRVTypeFunction *FuncType; // Function type
SPIRVWord FCtrlMask; // Function control mask
std::vector<SPIRVFunctionParameter *> Parameters;
std::vector<const SPIRVValue *> Variables;
typedef std::vector<SPIRVBasicBlock *> SPIRVLBasicBlockVector;
SPIRVLBasicBlockVector BBVec;
};
typedef SPIRVEntryOpCodeOnly<OpFunctionEnd> SPIRVFunctionEnd;
class SPIRVConstantFunctionPointerINTEL : public SPIRVValue {
const static Op OC = OpConstantFunctionPointerINTEL;
const static SPIRVWord FixedWordCount = 4;
public:
SPIRVConstantFunctionPointerINTEL(SPIRVId TheId, SPIRVType *TheType,
SPIRVFunction *TheFunction, SPIRVModule *M)
: SPIRVValue(M, FixedWordCount, OC, TheType, TheId),
TheFunction(TheFunction->getId()) {
validate();
}
SPIRVConstantFunctionPointerINTEL()
: SPIRVValue(OC), TheFunction(SPIRVID_INVALID) {}
SPIRVFunction *getFunction() const { return get<SPIRVFunction>(TheFunction); }
_SPIRV_DEF_ENCDEC3(Type, Id, TheFunction)
void validate() const override { SPIRVValue::validate(); }
std::optional<ExtensionID> getRequiredExtension() const override {
return ExtensionID::SPV_INTEL_function_pointers;
}
SPIRVCapVec getRequiredCapability() const override {
return getVec(CapabilityFunctionPointersINTEL);
}
protected:
SPIRVId TheFunction;
};
} // namespace SPIRV
#endif // SPIRV_LIBSPIRV_SPIRVFUNCTION_H
|
