slang_backend.h revision 34e6205f1d5ceb90a73192cee8b215fa0b7ab306
1c383a500aa59423264811be3874461bf8adbfea0Zonr Chang/* 2c383a500aa59423264811be3874461bf8adbfea0Zonr Chang * Copyright 2010, The Android Open Source Project 3c383a500aa59423264811be3874461bf8adbfea0Zonr Chang * 4c383a500aa59423264811be3874461bf8adbfea0Zonr Chang * Licensed under the Apache License, Version 2.0 (the "License"); 5c383a500aa59423264811be3874461bf8adbfea0Zonr Chang * you may not use this file except in compliance with the License. 6c383a500aa59423264811be3874461bf8adbfea0Zonr Chang * You may obtain a copy of the License at 7c383a500aa59423264811be3874461bf8adbfea0Zonr Chang * 8c383a500aa59423264811be3874461bf8adbfea0Zonr Chang * http://www.apache.org/licenses/LICENSE-2.0 9c383a500aa59423264811be3874461bf8adbfea0Zonr Chang * 10c383a500aa59423264811be3874461bf8adbfea0Zonr Chang * Unless required by applicable law or agreed to in writing, software 11c383a500aa59423264811be3874461bf8adbfea0Zonr Chang * distributed under the License is distributed on an "AS IS" BASIS, 12c383a500aa59423264811be3874461bf8adbfea0Zonr Chang * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13c383a500aa59423264811be3874461bf8adbfea0Zonr Chang * See the License for the specific language governing permissions and 14c383a500aa59423264811be3874461bf8adbfea0Zonr Chang * limitations under the License. 15c383a500aa59423264811be3874461bf8adbfea0Zonr Chang */ 16c383a500aa59423264811be3874461bf8adbfea0Zonr Chang 17e639eb5caa2c386b4a60659a4929e8a6141a2cbeStephen Hines#ifndef _FRAMEWORKS_COMPILE_SLANG_SLANG_BACKEND_H_ // NOLINT 18e639eb5caa2c386b4a60659a4929e8a6141a2cbeStephen Hines#define _FRAMEWORKS_COMPILE_SLANG_SLANG_BACKEND_H_ 19e639eb5caa2c386b4a60659a4929e8a6141a2cbeStephen Hines 20e639eb5caa2c386b4a60659a4929e8a6141a2cbeStephen Hines#include "clang/AST/ASTConsumer.h" 21462aefd62cc646d2ff753c1d003ef3cd7bbea26Shih-wei Liao 22c706907a8041faaa882f9bd87f1d1c1669023a62Stephen Hines#include "llvm/IR/LegacyPassManager.h" 23462aefd62cc646d2ff753c1d003ef3cd7bbea26Shih-wei Liao 2421cc01860b95cad7ae60c686e511e8f4ae034e39Pirama Arumuga Nainar#include "llvm/Support/raw_ostream.h" 25462aefd62cc646d2ff753c1d003ef3cd7bbea26Shih-wei Liao 263a9ca1f0d6bd8f12c2bb2adea51f95c255996180Zonr Chang#include "slang.h" 2734e6205f1d5ceb90a73192cee8b215fa0b7ab306David Gross#include "slang_pragma_list.h" 288024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet#include "slang_rs_check_ast.h" 29fb40ee2a90f37967bf4a40a18dec7f60e5c580d8Yang Ni#include "slang_rs_foreach_lowering.h" 308024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet#include "slang_rs_object_ref_count.h" 314cc499d6e5ec602309501873449c938af61170b2Stephen Hines#include "slang_version.h" 326315f76e3cc6ff2d012d1183a0b030d4ff0dc808zonr 33462aefd62cc646d2ff753c1d003ef3cd7bbea26Shih-wei Liaonamespace llvm { 3421cc01860b95cad7ae60c686e511e8f4ae034e39Pirama Arumuga Nainar class buffer_ostream; 356315f76e3cc6ff2d012d1183a0b030d4ff0dc808zonr class LLVMContext; 366315f76e3cc6ff2d012d1183a0b030d4ff0dc808zonr class NamedMDNode; 376315f76e3cc6ff2d012d1183a0b030d4ff0dc808zonr class Module; 389ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao} 39462aefd62cc646d2ff753c1d003ef3cd7bbea26Shih-wei Liao 40462aefd62cc646d2ff753c1d003ef3cd7bbea26Shih-wei Liaonamespace clang { 418024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet class ASTConsumer; 428024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet class ASTContext; 433a9ca1f0d6bd8f12c2bb2adea51f95c255996180Zonr Chang class CodeGenOptions; 446315f76e3cc6ff2d012d1183a0b030d4ff0dc808zonr class CodeGenerator; 456315f76e3cc6ff2d012d1183a0b030d4ff0dc808zonr class DeclGroupRef; 468024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet class DiagnosticsEngine; 478024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet class FunctionDecl; 486315f76e3cc6ff2d012d1183a0b030d4ff0dc808zonr class TagDecl; 498024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet class TargetOptions; 506315f76e3cc6ff2d012d1183a0b030d4ff0dc808zonr class VarDecl; 519ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao} 52462aefd62cc646d2ff753c1d003ef3cd7bbea26Shih-wei Liao 53462aefd62cc646d2ff753c1d003ef3cd7bbea26Shih-wei Liaonamespace slang { 54462aefd62cc646d2ff753c1d003ef3cd7bbea26Shih-wei Liao 558024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouilletclass RSContext; 568024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet 579ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liaoclass Backend : public clang::ASTConsumer { 589ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao private: 599ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao const clang::TargetOptions &mTargetOpts; 60462aefd62cc646d2ff753c1d003ef3cd7bbea26Shih-wei Liao 6168fc02ca4a7235e2981be5eee4ad968a9d3928c0Zonr Chang llvm::Module *mpModule; 6268fc02ca4a7235e2981be5eee4ad968a9d3928c0Zonr Chang 639ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao // Output stream 649ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao llvm::raw_ostream *mpOS; 653a9ca1f0d6bd8f12c2bb2adea51f95c255996180Zonr Chang Slang::OutputType mOT; 666b22674f4ef0a6c689c589830f1c44f443520785Kirk Stewart 679ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao // This helps us translate Clang AST using into LLVM IR 689ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao clang::CodeGenerator *mGen; 69462aefd62cc646d2ff753c1d003ef3cd7bbea26Shih-wei Liao 709ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao // Passes 71462aefd62cc646d2ff753c1d003ef3cd7bbea26Shih-wei Liao 729ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao // Passes apply on function scope in a translation unit 73c706907a8041faaa882f9bd87f1d1c1669023a62Stephen Hines llvm::legacy::FunctionPassManager *mPerFunctionPasses; 749ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao // Passes apply on module scope 75c706907a8041faaa882f9bd87f1d1c1669023a62Stephen Hines llvm::legacy::PassManager *mPerModulePasses; 769ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao // Passes for code emission 77c706907a8041faaa882f9bd87f1d1c1669023a62Stephen Hines llvm::legacy::FunctionPassManager *mCodeGenPasses; 78462aefd62cc646d2ff753c1d003ef3cd7bbea26Shih-wei Liao 7921cc01860b95cad7ae60c686e511e8f4ae034e39Pirama Arumuga Nainar llvm::buffer_ostream mBufferOutStream; 80462aefd62cc646d2ff753c1d003ef3cd7bbea26Shih-wei Liao 813a9ca1f0d6bd8f12c2bb2adea51f95c255996180Zonr Chang void CreateFunctionPasses(); 823a9ca1f0d6bd8f12c2bb2adea51f95c255996180Zonr Chang void CreateModulePasses(); 839ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao bool CreateCodeGenPasses(); 849ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao 858024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet RSContext *mContext; 868024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet 878024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet clang::SourceManager &mSourceMgr; 888024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet 892770d0e31ef3b14cd51ca07273240ad0995dc5cdDavid Gross bool mASTPrint; 902770d0e31ef3b14cd51ca07273240ad0995dc5cdDavid Gross 918024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet bool mAllowRSPrefix; 928024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet 938024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet bool mIsFilterscript; 948024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet 958024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet llvm::NamedMDNode *mExportVarMetadata; 968024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet llvm::NamedMDNode *mExportFuncMetadata; 978024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet llvm::NamedMDNode *mExportForEachNameMetadata; 988024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet llvm::NamedMDNode *mExportForEachSignatureMetadata; 99c0c5dd85f2d2df2bcf0cb284001f544d6c42eff9Matt Wala llvm::NamedMDNode *mExportReduceMetadata; 1008024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet llvm::NamedMDNode *mExportTypeMetadata; 1018024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet llvm::NamedMDNode *mRSObjectSlotsMetadata; 1028024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet 1038024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet RSObjectRefCount mRefCount; 1048024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet 1058024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet RSCheckAST mASTChecker; 1068024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet 107fb40ee2a90f37967bf4a40a18dec7f60e5c580d8Yang Ni RSForEachLowering mForEachHandler; 108fb40ee2a90f37967bf4a40a18dec7f60e5c580d8Yang Ni 1098024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet void AnnotateFunction(clang::FunctionDecl *FD); 1108024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet 1118024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet void dumpExportVarInfo(llvm::Module *M); 1128024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet void dumpExportFunctionInfo(llvm::Module *M); 1138024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet void dumpExportForEachInfo(llvm::Module *M); 114c0c5dd85f2d2df2bcf0cb284001f544d6c42eff9Matt Wala void dumpExportReduceInfo(llvm::Module *M); 1158024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet void dumpExportTypeInfo(llvm::Module *M); 1168024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet 117fb40ee2a90f37967bf4a40a18dec7f60e5c580d8Yang Ni void LowerRSForEachCall(clang::FunctionDecl* FD); 118fb40ee2a90f37967bf4a40a18dec7f60e5c580d8Yang Ni 1199ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao protected: 1209ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao llvm::LLVMContext &mLLVMContext; 1219207a2e495c8363606861e4f034504ec5c153dabLogan Chien clang::DiagnosticsEngine &mDiagEngine; 122c460b37ffb50819a32c2a8967754b6f784b28263mkopec const clang::CodeGenOptions &mCodeGenOpts; 1239ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao 1243fd0a94a5cf1656569b1aea07043cc63939dcb46Stephen Hines PragmaList *mPragmas; 1259ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao 1268024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet unsigned int getTargetAPI() const { return mContext->getTargetAPI(); } 1278024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet 1288024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet // TODO These are no longer virtual from base. Look into merging into caller. 1294cc499d6e5ec602309501873449c938af61170b2Stephen Hines 1308785d056b8912325b7e2c9c6c7adbd13b90964c4Zonr Chang // This handler will be invoked before Clang translates @Ctx to LLVM IR. This 13168fc02ca4a7235e2981be5eee4ad968a9d3928c0Zonr Chang // give you an opportunity to modified the IR in AST level (scope information, 13268fc02ca4a7235e2981be5eee4ad968a9d3928c0Zonr Chang // unoptimized IR, etc.). After the return from this method, slang will start 13368fc02ca4a7235e2981be5eee4ad968a9d3928c0Zonr Chang // translate @Ctx into LLVM IR. One should not operate on @Ctx afterwards 13468fc02ca4a7235e2981be5eee4ad968a9d3928c0Zonr Chang // since the changes applied on that never reflects to the LLVM module used 13568fc02ca4a7235e2981be5eee4ad968a9d3928c0Zonr Chang // in the final codegen. 1368024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet void HandleTranslationUnitPre(clang::ASTContext &Ctx); 13768fc02ca4a7235e2981be5eee4ad968a9d3928c0Zonr Chang 13868fc02ca4a7235e2981be5eee4ad968a9d3928c0Zonr Chang // This handler will be invoked when Clang have converted AST tree to LLVM IR. 13968fc02ca4a7235e2981be5eee4ad968a9d3928c0Zonr Chang // The @M contains the resulting LLVM IR tree. After the return from this 14068fc02ca4a7235e2981be5eee4ad968a9d3928c0Zonr Chang // method, slang will start doing optimization and code generation for @M. 1418024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet void HandleTranslationUnitPost(llvm::Module *M); 1429ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao 1439ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao public: 1448024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet Backend(RSContext *Context, 1458024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet clang::DiagnosticsEngine *DiagEngine, 1462770d0e31ef3b14cd51ca07273240ad0995dc5cdDavid Gross const RSCCOptions &Opts, 1478024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet const clang::CodeGenOptions &CodeGenOpts, 1488024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet const clang::TargetOptions &TargetOpts, 1498024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet PragmaList *Pragmas, 1508024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet llvm::raw_ostream *OS, 1518024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet Slang::OutputType OT, 1528024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet clang::SourceManager &SourceMgr, 1538024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet bool AllowRSPrefix, 1548024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet bool IsFilterscript); 1558024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet 1568024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet virtual ~Backend(); 1579ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao 1589ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao // Initialize - This is called to initialize the consumer, providing the 1599ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao // ASTContext. 1608024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet void Initialize(clang::ASTContext &Ctx) override; 1618024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet 1628024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet // TODO Clean up what should be private, protected 1638024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet // TODO Also clean up the include files 1649ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao 1659ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao // HandleTopLevelDecl - Handle the specified top-level declaration. This is 1669ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao // called by the parser to process every top-level Decl*. Note that D can be 1679ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao // the head of a chain of Decls (e.g. for `int a, b` the chain will have two 1689ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao // elements). Use Decl::getNextDeclarator() to walk the chain. 1698024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet bool HandleTopLevelDecl(clang::DeclGroupRef D) override; 1709ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao 1719ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao // HandleTranslationUnit - This method is called when the ASTs for entire 1729ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao // translation unit have been parsed. 1738024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet void HandleTranslationUnit(clang::ASTContext &Ctx) override; 1749ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao 1759ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao // HandleTagDeclDefinition - This callback is invoked each time a TagDecl 1769ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao // (e.g. struct, union, enum, class) is completed. This allows the client to 1779ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao // hack on the type, which can occur at any point in the file (because these 1789ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao // can be defined in declspecs). 1798024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet void HandleTagDeclDefinition(clang::TagDecl *D) override; 1809ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao 1819ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao // CompleteTentativeDefinition - Callback invoked at the end of a translation 1829ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao // unit to notify the consumer that the given tentative definition should be 1839ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao // completed. 1848024ed54c23c08534434da14d3be99c3efcc5754Jean-Luc Brouillet void CompleteTentativeDefinition(clang::VarDecl *D) override; 185462aefd62cc646d2ff753c1d003ef3cd7bbea26Shih-wei Liao}; 186462aefd62cc646d2ff753c1d003ef3cd7bbea26Shih-wei Liao 1879ef2f785e0cc490af678dfd685995dec787321ffShih-wei Liao} // namespace slang 188462aefd62cc646d2ff753c1d003ef3cd7bbea26Shih-wei Liao 189e639eb5caa2c386b4a60659a4929e8a6141a2cbeStephen Hines#endif // _FRAMEWORKS_COMPILE_SLANG_SLANG_BACKEND_H_ NOLINT 190