Zonr Chang | c383a50 | 2010-10-12 01:52:08 +0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2010, The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
Stephen Hines | e639eb5 | 2010-11-08 19:27:20 -0800 | [diff] [blame] | 17 | #ifndef _FRAMEWORKS_COMPILE_SLANG_SLANG_BACKEND_H_ // NOLINT |
| 18 | #define _FRAMEWORKS_COMPILE_SLANG_SLANG_BACKEND_H_ |
| 19 | |
| 20 | #include "clang/AST/ASTConsumer.h" |
Shih-wei Liao | 462aefd | 2010-06-04 15:32:04 -0700 | [diff] [blame] | 21 | |
Stephen Hines | c706907 | 2015-03-18 14:53:14 -0700 | [diff] [blame] | 22 | #include "llvm/IR/LegacyPassManager.h" |
Shih-wei Liao | 462aefd | 2010-06-04 15:32:04 -0700 | [diff] [blame] | 23 | |
Pirama Arumuga Nainar | 21cc018 | 2015-05-06 11:17:16 -0700 | [diff] [blame] | 24 | #include "llvm/Support/raw_ostream.h" |
Shih-wei Liao | 462aefd | 2010-06-04 15:32:04 -0700 | [diff] [blame] | 25 | |
Zonr Chang | 3a9ca1f | 2010-10-06 17:52:56 +0800 | [diff] [blame] | 26 | #include "slang.h" |
David Gross | 34e6205 | 2015-11-05 09:55:03 -0800 | [diff] [blame] | 27 | #include "slang_pragma_list.h" |
Jean-Luc Brouillet | 8024ed5 | 2015-05-04 23:02:25 -0700 | [diff] [blame] | 28 | #include "slang_rs_check_ast.h" |
Yang Ni | fb40ee2 | 2015-10-13 20:34:06 +0000 | [diff] [blame] | 29 | #include "slang_rs_foreach_lowering.h" |
Jean-Luc Brouillet | 8024ed5 | 2015-05-04 23:02:25 -0700 | [diff] [blame] | 30 | #include "slang_rs_object_ref_count.h" |
Stephen Hines | 4cc499d | 2011-08-24 19:06:17 -0700 | [diff] [blame] | 31 | #include "slang_version.h" |
zonr | 6315f76 | 2010-10-05 15:35:14 +0800 | [diff] [blame] | 32 | |
Shih-wei Liao | 462aefd | 2010-06-04 15:32:04 -0700 | [diff] [blame] | 33 | namespace llvm { |
Pirama Arumuga Nainar | 21cc018 | 2015-05-06 11:17:16 -0700 | [diff] [blame] | 34 | class buffer_ostream; |
zonr | 6315f76 | 2010-10-05 15:35:14 +0800 | [diff] [blame] | 35 | class LLVMContext; |
| 36 | class NamedMDNode; |
zonr | 6315f76 | 2010-10-05 15:35:14 +0800 | [diff] [blame] | 37 | class Module; |
Shih-wei Liao | 9ef2f78 | 2010-10-01 12:31:37 -0700 | [diff] [blame] | 38 | } |
Shih-wei Liao | 462aefd | 2010-06-04 15:32:04 -0700 | [diff] [blame] | 39 | |
| 40 | namespace clang { |
Jean-Luc Brouillet | 8024ed5 | 2015-05-04 23:02:25 -0700 | [diff] [blame] | 41 | class ASTConsumer; |
| 42 | class ASTContext; |
Zonr Chang | 3a9ca1f | 2010-10-06 17:52:56 +0800 | [diff] [blame] | 43 | class CodeGenOptions; |
zonr | 6315f76 | 2010-10-05 15:35:14 +0800 | [diff] [blame] | 44 | class CodeGenerator; |
zonr | 6315f76 | 2010-10-05 15:35:14 +0800 | [diff] [blame] | 45 | class DeclGroupRef; |
Jean-Luc Brouillet | 8024ed5 | 2015-05-04 23:02:25 -0700 | [diff] [blame] | 46 | class DiagnosticsEngine; |
| 47 | class FunctionDecl; |
Pirama Arumuga Nainar | 8f093e0 | 2016-03-03 23:56:27 -0800 | [diff] [blame] | 48 | class HeaderSearchOptions; |
| 49 | class PreprocessorOptions; |
zonr | 6315f76 | 2010-10-05 15:35:14 +0800 | [diff] [blame] | 50 | class TagDecl; |
Jean-Luc Brouillet | 8024ed5 | 2015-05-04 23:02:25 -0700 | [diff] [blame] | 51 | class TargetOptions; |
zonr | 6315f76 | 2010-10-05 15:35:14 +0800 | [diff] [blame] | 52 | class VarDecl; |
Shih-wei Liao | 9ef2f78 | 2010-10-01 12:31:37 -0700 | [diff] [blame] | 53 | } |
Shih-wei Liao | 462aefd | 2010-06-04 15:32:04 -0700 | [diff] [blame] | 54 | |
| 55 | namespace slang { |
| 56 | |
Jean-Luc Brouillet | 8024ed5 | 2015-05-04 23:02:25 -0700 | [diff] [blame] | 57 | class RSContext; |
| 58 | |
Shih-wei Liao | 9ef2f78 | 2010-10-01 12:31:37 -0700 | [diff] [blame] | 59 | class Backend : public clang::ASTConsumer { |
| 60 | private: |
Shih-wei Liao | 9ef2f78 | 2010-10-01 12:31:37 -0700 | [diff] [blame] | 61 | const clang::TargetOptions &mTargetOpts; |
Shih-wei Liao | 462aefd | 2010-06-04 15:32:04 -0700 | [diff] [blame] | 62 | |
Zonr Chang | 68fc02c | 2010-10-13 19:09:19 +0800 | [diff] [blame] | 63 | llvm::Module *mpModule; |
| 64 | |
Shih-wei Liao | 9ef2f78 | 2010-10-01 12:31:37 -0700 | [diff] [blame] | 65 | // Output stream |
| 66 | llvm::raw_ostream *mpOS; |
Zonr Chang | 3a9ca1f | 2010-10-06 17:52:56 +0800 | [diff] [blame] | 67 | Slang::OutputType mOT; |
Kirk Stewart | 6b22674 | 2010-06-11 10:51:12 -0700 | [diff] [blame] | 68 | |
Shih-wei Liao | 9ef2f78 | 2010-10-01 12:31:37 -0700 | [diff] [blame] | 69 | // This helps us translate Clang AST using into LLVM IR |
| 70 | clang::CodeGenerator *mGen; |
Shih-wei Liao | 462aefd | 2010-06-04 15:32:04 -0700 | [diff] [blame] | 71 | |
Shih-wei Liao | 9ef2f78 | 2010-10-01 12:31:37 -0700 | [diff] [blame] | 72 | // Passes |
Shih-wei Liao | 462aefd | 2010-06-04 15:32:04 -0700 | [diff] [blame] | 73 | |
Shih-wei Liao | 9ef2f78 | 2010-10-01 12:31:37 -0700 | [diff] [blame] | 74 | // Passes apply on function scope in a translation unit |
Stephen Hines | c706907 | 2015-03-18 14:53:14 -0700 | [diff] [blame] | 75 | llvm::legacy::FunctionPassManager *mPerFunctionPasses; |
Shih-wei Liao | 9ef2f78 | 2010-10-01 12:31:37 -0700 | [diff] [blame] | 76 | // Passes apply on module scope |
Stephen Hines | c706907 | 2015-03-18 14:53:14 -0700 | [diff] [blame] | 77 | llvm::legacy::PassManager *mPerModulePasses; |
Shih-wei Liao | 9ef2f78 | 2010-10-01 12:31:37 -0700 | [diff] [blame] | 78 | // Passes for code emission |
Stephen Hines | c706907 | 2015-03-18 14:53:14 -0700 | [diff] [blame] | 79 | llvm::legacy::FunctionPassManager *mCodeGenPasses; |
Shih-wei Liao | 462aefd | 2010-06-04 15:32:04 -0700 | [diff] [blame] | 80 | |
Pirama Arumuga Nainar | 21cc018 | 2015-05-06 11:17:16 -0700 | [diff] [blame] | 81 | llvm::buffer_ostream mBufferOutStream; |
Shih-wei Liao | 462aefd | 2010-06-04 15:32:04 -0700 | [diff] [blame] | 82 | |
Zonr Chang | 3a9ca1f | 2010-10-06 17:52:56 +0800 | [diff] [blame] | 83 | void CreateFunctionPasses(); |
| 84 | void CreateModulePasses(); |
Shih-wei Liao | 9ef2f78 | 2010-10-01 12:31:37 -0700 | [diff] [blame] | 85 | bool CreateCodeGenPasses(); |
Shih-wei Liao | 462aefd | 2010-06-04 15:32:04 -0700 | [diff] [blame] | 86 | |
Jean-Luc Brouillet | 8024ed5 | 2015-05-04 23:02:25 -0700 | [diff] [blame] | 87 | RSContext *mContext; |
| 88 | |
| 89 | clang::SourceManager &mSourceMgr; |
| 90 | |
David Gross | 2770d0e | 2015-08-03 14:58:59 -0700 | [diff] [blame] | 91 | bool mASTPrint; |
| 92 | |
Jean-Luc Brouillet | 8024ed5 | 2015-05-04 23:02:25 -0700 | [diff] [blame] | 93 | bool mAllowRSPrefix; |
| 94 | |
| 95 | bool mIsFilterscript; |
| 96 | |
| 97 | llvm::NamedMDNode *mExportVarMetadata; |
| 98 | llvm::NamedMDNode *mExportFuncMetadata; |
| 99 | llvm::NamedMDNode *mExportForEachNameMetadata; |
| 100 | llvm::NamedMDNode *mExportForEachSignatureMetadata; |
David Gross | 8ee018b | 2016-06-02 14:46:55 -0700 | [diff] [blame] | 101 | llvm::NamedMDNode *mExportReduceMetadata; |
Jean-Luc Brouillet | 8024ed5 | 2015-05-04 23:02:25 -0700 | [diff] [blame] | 102 | llvm::NamedMDNode *mExportTypeMetadata; |
| 103 | llvm::NamedMDNode *mRSObjectSlotsMetadata; |
| 104 | |
| 105 | RSObjectRefCount mRefCount; |
| 106 | |
| 107 | RSCheckAST mASTChecker; |
| 108 | |
Yang Ni | fb40ee2 | 2015-10-13 20:34:06 +0000 | [diff] [blame] | 109 | RSForEachLowering mForEachHandler; |
| 110 | |
Jean-Luc Brouillet | 8024ed5 | 2015-05-04 23:02:25 -0700 | [diff] [blame] | 111 | void AnnotateFunction(clang::FunctionDecl *FD); |
| 112 | |
| 113 | void dumpExportVarInfo(llvm::Module *M); |
| 114 | void dumpExportFunctionInfo(llvm::Module *M); |
| 115 | void dumpExportForEachInfo(llvm::Module *M); |
David Gross | 8ee018b | 2016-06-02 14:46:55 -0700 | [diff] [blame] | 116 | void dumpExportReduceInfo(llvm::Module *M); |
Jean-Luc Brouillet | 8024ed5 | 2015-05-04 23:02:25 -0700 | [diff] [blame] | 117 | void dumpExportTypeInfo(llvm::Module *M); |
| 118 | |
Yang Ni | 9319dfc | 2016-02-25 15:14:37 -0800 | [diff] [blame] | 119 | // Translates any rsForEach() or rsForEachWithOptions() calls inside the body |
| 120 | // of FD to lower-level runtime calls to rsForEachInternal(), if FD is not a |
| 121 | // kernel function itself, as indicated by isKernel being false. If isKernel |
| 122 | // is true, reports an error on any calls to rsForEach() or |
| 123 | // rsForEachWithOptions(). |
| 124 | void LowerRSForEachCall(clang::FunctionDecl* FD, bool isKernel); |
Yang Ni | fb40ee2 | 2015-10-13 20:34:06 +0000 | [diff] [blame] | 125 | |
David Gross | 37dbf5c | 2017-03-29 20:54:15 +0000 | [diff] [blame] | 126 | // Insert explicit padding fields into struct to follow the current |
| 127 | // layout as defined by the RenderScript ABI (32-bit or 64-bit ARM). |
| 128 | // |
| 129 | // The padding does not change field offset or structure size -- it |
| 130 | // makes explicit any padding that was implicit due to the ABI. |
| 131 | // This ensures that if the frontend compiles for an ABI with |
| 132 | // stricter alignment requirements than the backend compiles for, |
| 133 | // the frontend and backend will still agree on structure layout |
| 134 | // (field offset and structure size). This is important for 32-bit |
| 135 | // x86: The frontend compiles for 32-bit ARM ABI, in which 64-bit |
| 136 | // scalars are 64-bit aligned; but the 32-bit x86 ABI says that |
| 137 | // 64-bit scalars are only 32-bit aligned. |
| 138 | void PadStruct(clang::RecordDecl* RD); |
| 139 | |
Shih-wei Liao | 9ef2f78 | 2010-10-01 12:31:37 -0700 | [diff] [blame] | 140 | protected: |
| 141 | llvm::LLVMContext &mLLVMContext; |
Logan Chien | 9207a2e | 2011-10-21 15:39:28 +0800 | [diff] [blame] | 142 | clang::DiagnosticsEngine &mDiagEngine; |
mkopec1 | c460b37 | 2012-01-09 11:21:50 -0500 | [diff] [blame] | 143 | const clang::CodeGenOptions &mCodeGenOpts; |
Shih-wei Liao | 462aefd | 2010-06-04 15:32:04 -0700 | [diff] [blame] | 144 | |
Stephen Hines | 3fd0a94 | 2011-01-18 12:27:39 -0800 | [diff] [blame] | 145 | PragmaList *mPragmas; |
Shih-wei Liao | cecd11d | 2010-09-21 08:07:58 -0700 | [diff] [blame] | 146 | |
Jean-Luc Brouillet | 8024ed5 | 2015-05-04 23:02:25 -0700 | [diff] [blame] | 147 | unsigned int getTargetAPI() const { return mContext->getTargetAPI(); } |
| 148 | |
| 149 | // TODO These are no longer virtual from base. Look into merging into caller. |
Stephen Hines | 4cc499d | 2011-08-24 19:06:17 -0700 | [diff] [blame] | 150 | |
Zonr Chang | 8785d05 | 2010-10-13 22:42:43 +0800 | [diff] [blame] | 151 | // This handler will be invoked before Clang translates @Ctx to LLVM IR. This |
Zonr Chang | 68fc02c | 2010-10-13 19:09:19 +0800 | [diff] [blame] | 152 | // give you an opportunity to modified the IR in AST level (scope information, |
| 153 | // unoptimized IR, etc.). After the return from this method, slang will start |
| 154 | // translate @Ctx into LLVM IR. One should not operate on @Ctx afterwards |
| 155 | // since the changes applied on that never reflects to the LLVM module used |
| 156 | // in the final codegen. |
Jean-Luc Brouillet | 8024ed5 | 2015-05-04 23:02:25 -0700 | [diff] [blame] | 157 | void HandleTranslationUnitPre(clang::ASTContext &Ctx); |
Zonr Chang | 68fc02c | 2010-10-13 19:09:19 +0800 | [diff] [blame] | 158 | |
| 159 | // This handler will be invoked when Clang have converted AST tree to LLVM IR. |
| 160 | // The @M contains the resulting LLVM IR tree. After the return from this |
| 161 | // method, slang will start doing optimization and code generation for @M. |
Jean-Luc Brouillet | 8024ed5 | 2015-05-04 23:02:25 -0700 | [diff] [blame] | 162 | void HandleTranslationUnitPost(llvm::Module *M); |
Shih-wei Liao | 462aefd | 2010-06-04 15:32:04 -0700 | [diff] [blame] | 163 | |
Shih-wei Liao | 9ef2f78 | 2010-10-01 12:31:37 -0700 | [diff] [blame] | 164 | public: |
Jean-Luc Brouillet | 8024ed5 | 2015-05-04 23:02:25 -0700 | [diff] [blame] | 165 | Backend(RSContext *Context, |
| 166 | clang::DiagnosticsEngine *DiagEngine, |
David Gross | 2770d0e | 2015-08-03 14:58:59 -0700 | [diff] [blame] | 167 | const RSCCOptions &Opts, |
Pirama Arumuga Nainar | 8f093e0 | 2016-03-03 23:56:27 -0800 | [diff] [blame] | 168 | const clang::HeaderSearchOptions &HeaderSearchOpts, |
| 169 | const clang::PreprocessorOptions &PreprocessorOpts, |
Jean-Luc Brouillet | 8024ed5 | 2015-05-04 23:02:25 -0700 | [diff] [blame] | 170 | const clang::CodeGenOptions &CodeGenOpts, |
| 171 | const clang::TargetOptions &TargetOpts, |
| 172 | PragmaList *Pragmas, |
| 173 | llvm::raw_ostream *OS, |
| 174 | Slang::OutputType OT, |
| 175 | clang::SourceManager &SourceMgr, |
| 176 | bool AllowRSPrefix, |
| 177 | bool IsFilterscript); |
| 178 | |
| 179 | virtual ~Backend(); |
Shih-wei Liao | 462aefd | 2010-06-04 15:32:04 -0700 | [diff] [blame] | 180 | |
Shih-wei Liao | 9ef2f78 | 2010-10-01 12:31:37 -0700 | [diff] [blame] | 181 | // Initialize - This is called to initialize the consumer, providing the |
| 182 | // ASTContext. |
Jean-Luc Brouillet | 8024ed5 | 2015-05-04 23:02:25 -0700 | [diff] [blame] | 183 | void Initialize(clang::ASTContext &Ctx) override; |
| 184 | |
| 185 | // TODO Clean up what should be private, protected |
| 186 | // TODO Also clean up the include files |
Shih-wei Liao | 462aefd | 2010-06-04 15:32:04 -0700 | [diff] [blame] | 187 | |
Shih-wei Liao | 9ef2f78 | 2010-10-01 12:31:37 -0700 | [diff] [blame] | 188 | // HandleTopLevelDecl - Handle the specified top-level declaration. This is |
| 189 | // called by the parser to process every top-level Decl*. Note that D can be |
| 190 | // the head of a chain of Decls (e.g. for `int a, b` the chain will have two |
| 191 | // elements). Use Decl::getNextDeclarator() to walk the chain. |
Jean-Luc Brouillet | 8024ed5 | 2015-05-04 23:02:25 -0700 | [diff] [blame] | 192 | bool HandleTopLevelDecl(clang::DeclGroupRef D) override; |
Shih-wei Liao | 462aefd | 2010-06-04 15:32:04 -0700 | [diff] [blame] | 193 | |
Shih-wei Liao | 9ef2f78 | 2010-10-01 12:31:37 -0700 | [diff] [blame] | 194 | // HandleTranslationUnit - This method is called when the ASTs for entire |
| 195 | // translation unit have been parsed. |
Jean-Luc Brouillet | 8024ed5 | 2015-05-04 23:02:25 -0700 | [diff] [blame] | 196 | void HandleTranslationUnit(clang::ASTContext &Ctx) override; |
Shih-wei Liao | 462aefd | 2010-06-04 15:32:04 -0700 | [diff] [blame] | 197 | |
Shih-wei Liao | 9ef2f78 | 2010-10-01 12:31:37 -0700 | [diff] [blame] | 198 | // HandleTagDeclDefinition - This callback is invoked each time a TagDecl |
| 199 | // (e.g. struct, union, enum, class) is completed. This allows the client to |
| 200 | // hack on the type, which can occur at any point in the file (because these |
| 201 | // can be defined in declspecs). |
Jean-Luc Brouillet | 8024ed5 | 2015-05-04 23:02:25 -0700 | [diff] [blame] | 202 | void HandleTagDeclDefinition(clang::TagDecl *D) override; |
Shih-wei Liao | 462aefd | 2010-06-04 15:32:04 -0700 | [diff] [blame] | 203 | |
Shih-wei Liao | 9ef2f78 | 2010-10-01 12:31:37 -0700 | [diff] [blame] | 204 | // CompleteTentativeDefinition - Callback invoked at the end of a translation |
| 205 | // unit to notify the consumer that the given tentative definition should be |
| 206 | // completed. |
Jean-Luc Brouillet | 8024ed5 | 2015-05-04 23:02:25 -0700 | [diff] [blame] | 207 | void CompleteTentativeDefinition(clang::VarDecl *D) override; |
Shih-wei Liao | 462aefd | 2010-06-04 15:32:04 -0700 | [diff] [blame] | 208 | }; |
| 209 | |
Shih-wei Liao | 9ef2f78 | 2010-10-01 12:31:37 -0700 | [diff] [blame] | 210 | } // namespace slang |
Shih-wei Liao | 462aefd | 2010-06-04 15:32:04 -0700 | [diff] [blame] | 211 | |
Stephen Hines | e639eb5 | 2010-11-08 19:27:20 -0800 | [diff] [blame] | 212 | #endif // _FRAMEWORKS_COMPILE_SLANG_SLANG_BACKEND_H_ NOLINT |