1 /* 2 * Copyright 2016 Google Inc. 3 * 4 * Use of this source code is governed by a BSD-style license that can be 5 * found in the LICENSE file. 6 */ 7 8 #ifndef SKSL_METALCODEGENERATOR 9 #define SKSL_METALCODEGENERATOR 10 11 #include <stack> 12 #include <tuple> 13 #include <unordered_map> 14 15 #include "SkSLCodeGenerator.h" 16 #include "SkSLMemoryLayout.h" 17 #include "SkSLStringStream.h" 18 #include "ir/SkSLBinaryExpression.h" 19 #include "ir/SkSLBoolLiteral.h" 20 #include "ir/SkSLConstructor.h" 21 #include "ir/SkSLDoStatement.h" 22 #include "ir/SkSLExtension.h" 23 #include "ir/SkSLFloatLiteral.h" 24 #include "ir/SkSLIfStatement.h" 25 #include "ir/SkSLIndexExpression.h" 26 #include "ir/SkSLInterfaceBlock.h" 27 #include "ir/SkSLIntLiteral.h" 28 #include "ir/SkSLFieldAccess.h" 29 #include "ir/SkSLForStatement.h" 30 #include "ir/SkSLFunctionCall.h" 31 #include "ir/SkSLFunctionDeclaration.h" 32 #include "ir/SkSLFunctionDefinition.h" 33 #include "ir/SkSLPrefixExpression.h" 34 #include "ir/SkSLPostfixExpression.h" 35 #include "ir/SkSLProgramElement.h" 36 #include "ir/SkSLReturnStatement.h" 37 #include "ir/SkSLSetting.h" 38 #include "ir/SkSLStatement.h" 39 #include "ir/SkSLSwitchStatement.h" 40 #include "ir/SkSLSwizzle.h" 41 #include "ir/SkSLTernaryExpression.h" 42 #include "ir/SkSLVarDeclarations.h" 43 #include "ir/SkSLVarDeclarationsStatement.h" 44 #include "ir/SkSLVariableReference.h" 45 #include "ir/SkSLWhileStatement.h" 46 47 namespace SkSL { 48 49 #define kLast_Capability SpvCapabilityMultiViewport 50 51 /** 52 * Converts a Program into Metal code. 53 */ 54 class MetalCodeGenerator : public CodeGenerator { 55 public: 56 static constexpr const char* SAMPLER_SUFFIX = "Smplr"; 57 static constexpr const char* PACKED_PREFIX = "packed_"; 58 59 enum Precedence { 60 kParentheses_Precedence = 1, 61 kPostfix_Precedence = 2, 62 kPrefix_Precedence = 3, 63 kMultiplicative_Precedence = 4, 64 kAdditive_Precedence = 5, 65 kShift_Precedence = 6, 66 kRelational_Precedence = 7, 67 kEquality_Precedence = 8, 68 kBitwiseAnd_Precedence = 9, 69 kBitwiseXor_Precedence = 10, 70 kBitwiseOr_Precedence = 11, 71 kLogicalAnd_Precedence = 12, 72 kLogicalXor_Precedence = 13, 73 kLogicalOr_Precedence = 14, 74 kTernary_Precedence = 15, 75 kAssignment_Precedence = 16, 76 kSequence_Precedence = 17, 77 kTopLevel_Precedence = kSequence_Precedence 78 }; 79 MetalCodeGenerator(const Context * context,const Program * program,ErrorReporter * errors,OutputStream * out)80 MetalCodeGenerator(const Context* context, const Program* program, ErrorReporter* errors, 81 OutputStream* out) 82 : INHERITED(program, errors, out) 83 , fReservedWords({"atan2", "rsqrt", "dfdx", "dfdy", "vertex", "fragment"}) 84 , fLineEnding("\n") 85 , fContext(*context) { 86 this->setupIntrinsics(); 87 } 88 89 bool generateCode() override; 90 91 protected: 92 typedef int Requirements; 93 static constexpr Requirements kNo_Requirements = 0; 94 static constexpr Requirements kInputs_Requirement = 1 << 0; 95 static constexpr Requirements kOutputs_Requirement = 1 << 1; 96 static constexpr Requirements kUniforms_Requirement = 1 << 2; 97 static constexpr Requirements kGlobals_Requirement = 1 << 3; 98 99 enum IntrinsicKind { 100 kSpecial_IntrinsicKind, 101 kMetal_IntrinsicKind, 102 }; 103 104 enum SpecialIntrinsic { 105 kTexture_SpecialIntrinsic, 106 kMod_SpecialIntrinsic, 107 }; 108 109 enum MetalIntrinsic { 110 kLessThan_MetalIntrinsic, 111 kLessThanEqual_MetalIntrinsic, 112 kGreaterThan_MetalIntrinsic, 113 kGreaterThanEqual_MetalIntrinsic, 114 }; 115 116 void setupIntrinsics(); 117 118 void write(const char* s); 119 120 void writeLine(); 121 122 void writeLine(const char* s); 123 124 void write(const String& s); 125 126 void writeLine(const String& s); 127 128 void writeHeader(); 129 130 void writeUniformStruct(); 131 132 void writeInputStruct(); 133 134 void writeOutputStruct(); 135 136 void writeInterfaceBlocks(); 137 138 void writeFields(const std::vector<Type::Field>& fields, int parentOffset, 139 const InterfaceBlock* parentIntf = nullptr); 140 141 int size(const Type* type, bool isPacked) const; 142 143 int alignment(const Type* type, bool isPacked) const; 144 145 void writeGlobalStruct(); 146 147 void writePrecisionModifier(); 148 149 void writeType(const Type& type); 150 151 void writeExtension(const Extension& ext); 152 153 void writeInterfaceBlock(const InterfaceBlock& intf); 154 155 void writeFunctionStart(const FunctionDeclaration& f); 156 157 void writeFunctionDeclaration(const FunctionDeclaration& f); 158 159 void writeFunction(const FunctionDefinition& f); 160 161 void writeLayout(const Layout& layout); 162 163 void writeModifiers(const Modifiers& modifiers, bool globalContext); 164 165 void writeGlobalVars(const VarDeclaration& vs); 166 167 void writeVarInitializer(const Variable& var, const Expression& value); 168 169 void writeName(const String& name); 170 171 void writeVarDeclarations(const VarDeclarations& decl, bool global); 172 173 void writeFragCoord(); 174 175 void writeVariableReference(const VariableReference& ref); 176 177 void writeExpression(const Expression& expr, Precedence parentPrecedence); 178 179 void writeIntrinsicCall(const FunctionCall& c); 180 181 void writeMinAbsHack(Expression& absExpr, Expression& otherExpr); 182 183 void writeFunctionCall(const FunctionCall& c); 184 185 void writeInverseHack(const Expression& mat); 186 187 String getMatrixConstructHelper(const Type& matrix, const Type& arg); 188 189 void writeSpecialIntrinsic(const FunctionCall& c, SpecialIntrinsic kind); 190 191 bool canCoerce(const Type& t1, const Type& t2); 192 193 void writeConstructor(const Constructor& c, Precedence parentPrecedence); 194 195 void writeFieldAccess(const FieldAccess& f); 196 197 void writeSwizzle(const Swizzle& swizzle); 198 199 static Precedence GetBinaryPrecedence(Token::Kind op); 200 201 void writeBinaryExpression(const BinaryExpression& b, Precedence parentPrecedence); 202 203 void writeTernaryExpression(const TernaryExpression& t, Precedence parentPrecedence); 204 205 void writeIndexExpression(const IndexExpression& expr); 206 207 void writePrefixExpression(const PrefixExpression& p, Precedence parentPrecedence); 208 209 void writePostfixExpression(const PostfixExpression& p, Precedence parentPrecedence); 210 211 void writeBoolLiteral(const BoolLiteral& b); 212 213 void writeIntLiteral(const IntLiteral& i); 214 215 void writeFloatLiteral(const FloatLiteral& f); 216 217 void writeSetting(const Setting& s); 218 219 void writeStatement(const Statement& s); 220 221 void writeStatements(const std::vector<std::unique_ptr<Statement>>& statements); 222 223 void writeBlock(const Block& b); 224 225 void writeIfStatement(const IfStatement& stmt); 226 227 void writeForStatement(const ForStatement& f); 228 229 void writeWhileStatement(const WhileStatement& w); 230 231 void writeDoStatement(const DoStatement& d); 232 233 void writeSwitchStatement(const SwitchStatement& s); 234 235 void writeReturnStatement(const ReturnStatement& r); 236 237 void writeProgramElement(const ProgramElement& e); 238 239 Requirements requirements(const FunctionDeclaration& f); 240 241 Requirements requirements(const Expression& e); 242 243 Requirements requirements(const Statement& e); 244 245 typedef std::pair<IntrinsicKind, int32_t> Intrinsic; 246 std::unordered_map<String, Intrinsic> fIntrinsicMap; 247 std::unordered_set<String> fReservedWords; 248 std::vector<const VarDeclaration*> fInitNonConstGlobalVars; 249 std::vector<const Variable*> fTextures; 250 std::unordered_map<const Type::Field*, const InterfaceBlock*> fInterfaceBlockMap; 251 std::unordered_map<const InterfaceBlock*, String> fInterfaceBlockNameMap; 252 int fAnonInterfaceCount = 0; 253 int fPaddingCount = 0; 254 bool fNeedsGlobalStructInit = false; 255 const char* fLineEnding; 256 const Context& fContext; 257 StringStream fHeader; 258 String fFunctionHeader; 259 StringStream fExtraFunctions; 260 Program::Kind fProgramKind; 261 int fVarCount = 0; 262 int fIndentation = 0; 263 bool fAtLineStart = false; 264 // Keeps track of which struct types we have written. Given that we are unlikely to ever write 265 // more than one or two structs per shader, a simple linear search will be faster than anything 266 // fancier. 267 std::vector<const Type*> fWrittenStructs; 268 std::set<String> fWrittenIntrinsics; 269 // true if we have run into usages of dFdx / dFdy 270 bool fFoundDerivatives = false; 271 bool fFoundImageDecl = false; 272 std::unordered_map<const FunctionDeclaration*, Requirements> fRequirements; 273 bool fSetupFragPositionGlobal = false; 274 bool fSetupFragPositionLocal = false; 275 std::unordered_map<String, String> fMatrixConstructHelpers; 276 int fUniformBuffer = -1; 277 278 typedef CodeGenerator INHERITED; 279 }; 280 281 } 282 283 #endif 284