blob: ba1d2adb0b6fcfed543f402077d60bcf63a05b6b [file] [log] [blame]
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +00001//
Nicolas Capensb1f45b72013-12-19 17:37:19 -05002// Copyright (c) 2002-2014 The ANGLE Project Authors. All rights reserved.
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +00003// Use of this source code is governed by a BSD-style license that can be
4// found in the LICENSE file.
5//
6
Geoff Lang0a73dd82014-11-19 16:18:08 -05007#ifndef COMPILER_TRANSLATOR_OUTPUTHLSL_H_
8#define COMPILER_TRANSLATOR_OUTPUTHLSL_H_
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +00009
alokp@chromium.org4e89d232010-05-14 19:37:21 +000010#include <list>
11#include <set>
daniel@transgaming.com652468c2012-12-20 21:11:57 +000012#include <map>
Jamie Madill32aab012015-01-27 14:12:26 -050013#include <stack>
daniel@transgaming.com652468c2012-12-20 21:11:57 +000014
Jamie Madillf51639a2014-06-25 16:04:57 -040015#include "angle_gl.h"
Corentin Wallezf4eab3b2015-03-18 12:55:45 -070016#include "compiler/translator/ASTMetadataHLSL.h"
Jamie Madillb1a85f42014-08-19 15:23:24 -040017#include "compiler/translator/IntermNode.h"
Jamie Madill6b9cb252013-10-17 10:45:47 -040018#include "compiler/translator/ParseContext.h"
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +000019
Olli Etuaho8efc5ad2015-03-03 17:21:10 +020020class BuiltInFunctionEmulator;
Olli Etuahoe17e3192015-01-02 12:47:59 +020021
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +000022namespace sh
23{
daniel@transgaming.comf8f8f362012-04-28 00:35:00 +000024class UnfoldShortCircuit;
Jamie Madill8daaba12014-06-13 10:04:33 -040025class StructureHLSL;
Jamie Madillf91ce812014-06-13 10:04:34 -040026class UniformHLSL;
27
28typedef std::map<TString, TIntermSymbol*> ReferencedSymbols;
daniel@transgaming.comb5875982010-04-15 20:44:53 +000029
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +000030class OutputHLSL : public TIntermTraverser
31{
32 public:
Olli Etuahoa3a5cc62015-02-13 13:12:22 +020033 OutputHLSL(sh::GLenum shaderType, int shaderVersion,
34 const TExtensionBehavior &extensionBehavior,
35 const char *sourcePath, ShShaderOutput outputType,
36 int numRenderTargets, const std::vector<Uniform> &uniforms,
37 int compileOptions);
38
daniel@transgaming.comb5875982010-04-15 20:44:53 +000039 ~OutputHLSL();
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +000040
Olli Etuahoa3a5cc62015-02-13 13:12:22 +020041 void output(TIntermNode *treeRoot, TInfoSinkBase &objSink);
daniel@transgaming.com950f9932010-04-13 03:26:14 +000042
Jamie Madill4e1fd412014-07-10 17:50:10 -040043 const std::map<std::string, unsigned int> &getInterfaceBlockRegisterMap() const;
Jamie Madill9fe25e92014-07-18 10:33:08 -040044 const std::map<std::string, unsigned int> &getUniformRegisterMap() const;
Jamie Madill4e1fd412014-07-10 17:50:10 -040045
daniel@transgaming.comb5875982010-04-15 20:44:53 +000046 static TString initializer(const TType &type);
daniel@transgaming.comb5875982010-04-15 20:44:53 +000047
Jamie Madill32aab012015-01-27 14:12:26 -050048 TInfoSinkBase &getInfoSink() { ASSERT(!mInfoSinkStack.empty()); return *mInfoSinkStack.top(); }
49
daniel@transgaming.com950f9932010-04-13 03:26:14 +000050 protected:
Olli Etuaho8efc5ad2015-03-03 17:21:10 +020051 void header(const BuiltInFunctionEmulator *builtInFunctionEmulator);
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +000052
daniel@transgaming.com950f9932010-04-13 03:26:14 +000053 // Visit AST nodes and output their code to the body stream
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +000054 void visitSymbol(TIntermSymbol*);
Jamie Madill4cfb1e82014-07-07 12:49:23 -040055 void visitRaw(TIntermRaw*);
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +000056 void visitConstantUnion(TIntermConstantUnion*);
57 bool visitBinary(Visit visit, TIntermBinary*);
58 bool visitUnary(Visit visit, TIntermUnary*);
59 bool visitSelection(Visit visit, TIntermSelection*);
Olli Etuaho3c1dfb52015-02-20 11:34:03 +020060 bool visitSwitch(Visit visit, TIntermSwitch *);
61 bool visitCase(Visit visit, TIntermCase *);
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +000062 bool visitAggregate(Visit visit, TIntermAggregate*);
63 bool visitLoop(Visit visit, TIntermLoop*);
64 bool visitBranch(Visit visit, TIntermBranch*);
65
daniel@transgaming.comb5875982010-04-15 20:44:53 +000066 bool isSingleStatement(TIntermNode *node);
daniel@transgaming.com4a35ef22010-04-08 03:51:06 +000067 bool handleExcessiveLoop(TIntermLoop *node);
Daniel Bratell29190082015-02-20 16:42:54 +010068
69 // Emit one of three strings depending on traverse phase. Called with literal strings so using const char* instead of TString.
Olli Etuaho7fb49552015-03-18 17:27:44 +020070 void outputTriplet(Visit visit, const char *preString, const char *inString, const char *postString, TInfoSinkBase &out);
Daniel Bratell29190082015-02-20 16:42:54 +010071 void outputTriplet(Visit visit, const char *preString, const char *inString, const char *postString);
apatrick@chromium.org0f4cefe2011-01-26 19:30:57 +000072 void outputLineDirective(int line);
daniel@transgaming.com005c7392010-04-15 20:45:27 +000073 TString argumentString(const TIntermSymbol *symbol);
daniel@transgaming.com0b6b8342010-04-26 15:33:45 +000074 int vectorSize(const TType &type) const;
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +000075
Daniel Bratell29190082015-02-20 16:42:54 +010076 // Emit constructor. Called with literal names so using const char* instead of TString.
77 void outputConstructor(Visit visit, const TType &type, const char *name, const TIntermSequence *parameters);
Jamie Madill6ba6ead2015-05-04 14:21:21 -040078 const TConstantUnion *writeConstantUnion(const TType &type, const TConstantUnion *constUnion);
daniel@transgaming.com63691862010-04-29 03:32:42 +000079
Olli Etuaho7fb49552015-03-18 17:27:44 +020080 void outputEqual(Visit visit, const TType &type, TOperator op, TInfoSinkBase &out);
81
Olli Etuaho5c9cd3d2014-12-18 13:04:25 +020082 void writeEmulatedFunctionTriplet(Visit visit, const char *preStr);
Jamie Madill37997142015-01-28 10:06:34 -050083 void makeFlaggedStructMaps(const std::vector<TIntermTyped *> &flaggedStructs);
84
85 // Returns true if it found a 'same symbol' initializer (initializer that references the variable it's initting)
86 bool writeSameSymbolInitializer(TInfoSinkBase &out, TIntermSymbol *symbolNode, TIntermTyped *expression);
87 void writeDeferredGlobalInitializers(TInfoSinkBase &out);
Olli Etuaho5c9cd3d2014-12-18 13:04:25 +020088
Jamie Madill55e79e02015-02-09 15:35:00 -050089 // Returns the function name
90 TString addStructEqualityFunction(const TStructure &structure);
Olli Etuaho7fb49552015-03-18 17:27:44 +020091 TString addArrayEqualityFunction(const TType &type);
Olli Etuaho12690762015-03-31 12:55:28 +030092 TString addArrayAssignmentFunction(const TType &type);
Olli Etuaho9638c352015-04-01 14:34:52 +030093 TString addArrayConstructIntoFunction(const TType &type);
Jamie Madill55e79e02015-02-09 15:35:00 -050094
Jamie Madill2e295e22015-04-29 10:41:33 -040095 // Ensures if the type is a struct, the struct is defined
96 void ensureStructDefined(const TType &type);
97
Olli Etuahoa3a5cc62015-02-13 13:12:22 +020098 sh::GLenum mShaderType;
99 int mShaderVersion;
100 const TExtensionBehavior &mExtensionBehavior;
101 const char *mSourcePath;
shannon.woods@transgaming.comb73964e2013-01-25 21:49:14 +0000102 const ShShaderOutput mOutputType;
Olli Etuahoa3a5cc62015-02-13 13:12:22 +0200103 int mCompileOptions;
104
daniel@transgaming.comf9ef1072010-04-22 13:35:16 +0000105 bool mInsideFunction;
daniel@transgaming.com950f9932010-04-13 03:26:14 +0000106
107 // Output streams
108 TInfoSinkBase mHeader;
109 TInfoSinkBase mBody;
110 TInfoSinkBase mFooter;
daniel@transgaming.comd91cfe72010-04-13 03:26:17 +0000111
Jamie Madill32aab012015-01-27 14:12:26 -0500112 // A stack is useful when we want to traverse in the header, or in helper functions, but not always
113 // write to the body. Instead use an InfoSink stack to keep our current state intact.
Olli Etuaho7fb49552015-03-18 17:27:44 +0200114 // TODO (jmadill): Just passing an InfoSink in function parameters would be simpler.
Jamie Madill32aab012015-01-27 14:12:26 -0500115 std::stack<TInfoSinkBase *> mInfoSinkStack;
116
daniel@transgaming.com8803b852012-12-20 21:11:47 +0000117 ReferencedSymbols mReferencedUniforms;
shannonwoods@chromium.org4a643ae2013-05-30 00:12:27 +0000118 ReferencedSymbols mReferencedInterfaceBlocks;
daniel@transgaming.com8803b852012-12-20 21:11:47 +0000119 ReferencedSymbols mReferencedAttributes;
120 ReferencedSymbols mReferencedVaryings;
Jamie Madill46131a32013-06-20 11:55:50 -0400121 ReferencedSymbols mReferencedOutputVariables;
daniel@transgaming.com86f7c9d2010-04-20 18:52:06 +0000122
Jamie Madill8daaba12014-06-13 10:04:33 -0400123 StructureHLSL *mStructureHLSL;
Jamie Madillf91ce812014-06-13 10:04:34 -0400124 UniformHLSL *mUniformHLSL;
Jamie Madill8daaba12014-06-13 10:04:33 -0400125
Nicolas Capense0ba27a2013-06-24 16:10:52 -0400126 struct TextureFunction
127 {
Nicolas Capens75fb4752013-07-10 15:14:47 -0400128 enum Method
Nicolas Capense0ba27a2013-06-24 16:10:52 -0400129 {
Nicolas Capens75fb4752013-07-10 15:14:47 -0400130 IMPLICIT, // Mipmap LOD determined implicitly (standard lookup)
Nicolas Capense0ba27a2013-06-24 16:10:52 -0400131 BIAS,
132 LOD,
Nicolas Capens75fb4752013-07-10 15:14:47 -0400133 LOD0,
Nicolas Capens84cfa122014-04-14 13:48:45 -0400134 LOD0BIAS,
Nicolas Capensfc014542014-02-18 14:47:13 -0500135 SIZE, // textureSize()
Nicolas Capensd11d5492014-02-19 17:06:10 -0500136 FETCH,
137 GRAD
Nicolas Capense0ba27a2013-06-24 16:10:52 -0400138 };
139
140 TBasicType sampler;
141 int coords;
142 bool proj;
Nicolas Capensb1f45b72013-12-19 17:37:19 -0500143 bool offset;
Nicolas Capens75fb4752013-07-10 15:14:47 -0400144 Method method;
Nicolas Capense0ba27a2013-06-24 16:10:52 -0400145
146 TString name() const;
147
148 bool operator<(const TextureFunction &rhs) const;
149 };
150
151 typedef std::set<TextureFunction> TextureFunctionSet;
152
daniel@transgaming.comd91cfe72010-04-13 03:26:17 +0000153 // Parameters determining what goes in the header output
Nicolas Capense0ba27a2013-06-24 16:10:52 -0400154 TextureFunctionSet mUsesTexture;
shannon.woods%transgaming.com@gtempaccount.comaa8b5cf2013-04-13 03:31:55 +0000155 bool mUsesFragColor;
156 bool mUsesFragData;
daniel@transgaming.comd7c98102010-05-14 17:30:48 +0000157 bool mUsesDepthRange;
daniel@transgaming.com4af7acc2010-05-14 17:30:53 +0000158 bool mUsesFragCoord;
159 bool mUsesPointCoord;
160 bool mUsesFrontFacing;
161 bool mUsesPointSize;
Gregoire Payen de La Garanderieb3dced22015-01-12 14:54:55 +0000162 bool mUsesInstanceID;
Jamie Madill2aeb26a2013-07-08 14:02:55 -0400163 bool mUsesFragDepth;
daniel@transgaming.comd7c98102010-05-14 17:30:48 +0000164 bool mUsesXor;
Jamie Madill3c9eeb92013-11-04 11:09:26 -0500165 bool mUsesDiscardRewriting;
Nicolas Capens655fe362014-04-11 13:12:34 -0400166 bool mUsesNestedBreak;
Arun Patole44efa0b2015-03-04 17:11:05 +0530167 bool mRequiresIEEEStrictCompiling;
168
daniel@transgaming.com005c7392010-04-15 20:45:27 +0000169
shannon.woods%transgaming.com@gtempaccount.comaa8b5cf2013-04-13 03:31:55 +0000170 int mNumRenderTargets;
171
daniel@transgaming.comb6ef8f12010-11-15 16:41:14 +0000172 int mUniqueIndex; // For creating unique names
daniel@transgaming.com89431aa2012-05-31 01:20:29 +0000173
Corentin Wallez1239ee92015-03-19 14:38:02 -0700174 CallDAG mCallDag;
175 MetadataList mASTMetadataList;
176 ASTMetadataHLSL *mCurrentFunctionMetadata;
daniel@transgaming.com89431aa2012-05-31 01:20:29 +0000177 bool mOutputLod0Function;
daniel@transgaming.come11100c2012-05-31 01:20:32 +0000178 bool mInsideDiscontinuousLoop;
Nicolas Capens655fe362014-04-11 13:12:34 -0400179 int mNestedLoopDepth;
daniel@transgaming.come9b3f602012-07-11 20:37:31 +0000180
181 TIntermSymbol *mExcessiveLoopIndex;
daniel@transgaming.com652468c2012-12-20 21:11:57 +0000182
Jamie Madill98493dd2013-07-08 14:39:03 -0400183 TString structInitializerString(int indent, const TStructure &structure, const TString &rhsStructName);
daniel@transgaming.comf4d9fef2012-12-20 21:12:13 +0000184
Jamie Madill570e04d2013-06-21 09:15:33 -0400185 std::map<TIntermTyped*, TString> mFlaggedStructMappedNames;
186 std::map<TIntermTyped*, TString> mFlaggedStructOriginalNames;
187
Jamie Madill37997142015-01-28 10:06:34 -0500188 // Some initializers use varyings, uniforms or attributes, thus we can't evaluate some variables
189 // at global static scope in HLSL. These variables depend on values which we retrieve from the
190 // shader input structure, which we set in the D3D main function. Instead, we can initialize
191 // these static globals after we initialize our other globals.
192 std::vector<std::pair<TIntermSymbol*, TIntermTyped*>> mDeferredGlobalInitializers;
Jamie Madill55e79e02015-02-09 15:35:00 -0500193
Olli Etuaho12690762015-03-31 12:55:28 +0300194 struct HelperFunction
Olli Etuahoae37a5c2015-03-20 16:50:15 +0200195 {
196 TString functionName;
197 TString functionDefinition;
198
Olli Etuaho12690762015-03-31 12:55:28 +0300199 virtual ~HelperFunction() {}
Olli Etuahoae37a5c2015-03-20 16:50:15 +0200200 };
201
202 // A list of all equality comparison functions. It's important to preserve the order at
203 // which we add the functions, since nested structures call each other recursively, and
204 // structure equality functions may need to call array equality functions and vice versa.
205 // The ownership of the pointers is maintained by the type-specific arrays.
Olli Etuaho12690762015-03-31 12:55:28 +0300206 std::vector<HelperFunction*> mEqualityFunctions;
Olli Etuahoae37a5c2015-03-20 16:50:15 +0200207
Olli Etuaho12690762015-03-31 12:55:28 +0300208 struct StructEqualityFunction : public HelperFunction
Jamie Madill55e79e02015-02-09 15:35:00 -0500209 {
210 const TStructure *structure;
Jamie Madill55e79e02015-02-09 15:35:00 -0500211 };
Olli Etuahoae37a5c2015-03-20 16:50:15 +0200212 std::vector<StructEqualityFunction*> mStructEqualityFunctions;
Jamie Madill55e79e02015-02-09 15:35:00 -0500213
Olli Etuaho12690762015-03-31 12:55:28 +0300214 struct ArrayHelperFunction : public HelperFunction
Olli Etuaho7fb49552015-03-18 17:27:44 +0200215 {
216 TType type;
Olli Etuaho7fb49552015-03-18 17:27:44 +0200217 };
Olli Etuaho12690762015-03-31 12:55:28 +0300218 std::vector<ArrayHelperFunction*> mArrayEqualityFunctions;
219
220 std::vector<ArrayHelperFunction> mArrayAssignmentFunctions;
Olli Etuaho9638c352015-04-01 14:34:52 +0300221
222 // The construct-into functions are functions that fill an N-element array passed as an out parameter
223 // with the other N parameters of the function. This is used to work around that arrays can't be
224 // return values in HLSL.
225 std::vector<ArrayHelperFunction> mArrayConstructIntoFunctions;
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +0000226};
Jamie Madill8daaba12014-06-13 10:04:33 -0400227
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +0000228}
229
Geoff Lang0a73dd82014-11-19 16:18:08 -0500230#endif // COMPILER_TRANSLATOR_OUTPUTHLSL_H_