Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 1 | //===--- ModuleBuilder.cpp - Emit LLVM Code from ASTs ---------------------===// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
Chris Lattner | 0bc735f | 2007-12-29 19:59:25 +0000 | [diff] [blame] | 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | // |
| 10 | // This builds an AST and converts it to LLVM Code. |
| 11 | // |
| 12 | //===----------------------------------------------------------------------===// |
| 13 | |
| 14 | #include "clang/CodeGen/ModuleBuilder.h" |
David Blaikie | 658cd2c | 2013-07-13 21:08:14 +0000 | [diff] [blame] | 15 | #include "CGDebugInfo.h" |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 16 | #include "CodeGenModule.h" |
Chris Lattner | 8ee3c03 | 2008-02-06 02:01:47 +0000 | [diff] [blame] | 17 | #include "clang/AST/ASTContext.h" |
Daniel Dunbar | e91593e | 2008-08-11 04:54:23 +0000 | [diff] [blame] | 18 | #include "clang/AST/DeclObjC.h" |
| 19 | #include "clang/AST/Expr.h" |
Chris Lattner | 8ee3c03 | 2008-02-06 02:01:47 +0000 | [diff] [blame] | 20 | #include "clang/Basic/Diagnostic.h" |
| 21 | #include "clang/Basic/TargetInfo.h" |
Chandler Carruth | 55fc873 | 2012-12-04 09:13:33 +0000 | [diff] [blame] | 22 | #include "clang/Frontend/CodeGenOptions.h" |
Reid Kleckner | 3190ca9 | 2013-05-08 13:44:39 +0000 | [diff] [blame] | 23 | #include "llvm/ADT/StringRef.h" |
Chandler Carruth | 3b844ba | 2013-01-02 11:45:17 +0000 | [diff] [blame] | 24 | #include "llvm/IR/DataLayout.h" |
| 25 | #include "llvm/IR/LLVMContext.h" |
| 26 | #include "llvm/IR/Module.h" |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 27 | #include <memory> |
Chris Lattner | bd36064 | 2009-03-26 05:00:52 +0000 | [diff] [blame] | 28 | using namespace clang; |
Ted Kremenek | 815c78f | 2008-08-05 18:50:11 +0000 | [diff] [blame] | 29 | |
Chris Lattner | 8ee3c03 | 2008-02-06 02:01:47 +0000 | [diff] [blame] | 30 | namespace { |
Benjamin Kramer | 85b4521 | 2009-11-28 19:45:26 +0000 | [diff] [blame] | 31 | class CodeGeneratorImpl : public CodeGenerator { |
David Blaikie | d6471f7 | 2011-09-25 23:23:43 +0000 | [diff] [blame] | 32 | DiagnosticsEngine &Diags; |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 33 | std::unique_ptr<const llvm::DataLayout> TD; |
Chris Lattner | 8ee3c03 | 2008-02-06 02:01:47 +0000 | [diff] [blame] | 34 | ASTContext *Ctx; |
Chandler Carruth | 2811ccf | 2009-11-12 17:24:48 +0000 | [diff] [blame] | 35 | const CodeGenOptions CodeGenOpts; // Intentionally copied in. |
Stephen Hines | 176edba | 2014-12-01 14:53:08 -0800 | [diff] [blame] | 36 | |
| 37 | unsigned HandlingTopLevelDecls; |
| 38 | struct HandlingTopLevelDeclRAII { |
| 39 | CodeGeneratorImpl &Self; |
| 40 | HandlingTopLevelDeclRAII(CodeGeneratorImpl &Self) : Self(Self) { |
| 41 | ++Self.HandlingTopLevelDecls; |
| 42 | } |
| 43 | ~HandlingTopLevelDeclRAII() { |
| 44 | if (--Self.HandlingTopLevelDecls == 0) |
| 45 | Self.EmitDeferredDecls(); |
| 46 | } |
| 47 | }; |
| 48 | |
| 49 | CoverageSourceInfo *CoverageInfo; |
| 50 | |
Chris Lattner | 8ee3c03 | 2008-02-06 02:01:47 +0000 | [diff] [blame] | 51 | protected: |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 52 | std::unique_ptr<llvm::Module> M; |
| 53 | std::unique_ptr<CodeGen::CodeGenModule> Builder; |
| 54 | |
Stephen Hines | 0e2c34f | 2015-03-23 12:09:02 -0700 | [diff] [blame^] | 55 | private: |
| 56 | SmallVector<CXXMethodDecl *, 8> DeferredInlineMethodDefinitions; |
| 57 | |
Chris Lattner | 8ee3c03 | 2008-02-06 02:01:47 +0000 | [diff] [blame] | 58 | public: |
David Blaikie | d6471f7 | 2011-09-25 23:23:43 +0000 | [diff] [blame] | 59 | CodeGeneratorImpl(DiagnosticsEngine &diags, const std::string& ModuleName, |
Stephen Hines | 176edba | 2014-12-01 14:53:08 -0800 | [diff] [blame] | 60 | const CodeGenOptions &CGO, llvm::LLVMContext& C, |
| 61 | CoverageSourceInfo *CoverageInfo = nullptr) |
Stephen Hines | 0e2c34f | 2015-03-23 12:09:02 -0700 | [diff] [blame^] | 62 | : Diags(diags), Ctx(nullptr), CodeGenOpts(CGO), HandlingTopLevelDecls(0), |
Stephen Hines | 176edba | 2014-12-01 14:53:08 -0800 | [diff] [blame] | 63 | CoverageInfo(CoverageInfo), |
Bill Wendling | e1092df | 2013-02-14 08:09:20 +0000 | [diff] [blame] | 64 | M(new llvm::Module(ModuleName, C)) {} |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 65 | |
Stephen Hines | 0e2c34f | 2015-03-23 12:09:02 -0700 | [diff] [blame^] | 66 | virtual ~CodeGeneratorImpl() { |
| 67 | // There should normally not be any leftover inline method definitions. |
| 68 | assert(DeferredInlineMethodDefinitions.empty() || |
| 69 | Diags.hasErrorOccurred()); |
| 70 | } |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 71 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 72 | llvm::Module* GetModule() override { |
Daniel Dunbar | d8c0ea1 | 2008-10-21 19:55:09 +0000 | [diff] [blame] | 73 | return M.get(); |
| 74 | } |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 75 | |
Stephen Hines | c568f1e | 2014-07-21 00:47:37 -0700 | [diff] [blame] | 76 | const Decl *GetDeclForMangledName(StringRef MangledName) override { |
| 77 | GlobalDecl Result; |
| 78 | if (!Builder->lookupRepresentativeDecl(MangledName, Result)) |
| 79 | return nullptr; |
| 80 | const Decl *D = Result.getCanonicalDecl().getDecl(); |
| 81 | if (auto FD = dyn_cast<FunctionDecl>(D)) { |
| 82 | if (FD->hasBody(FD)) |
| 83 | return FD; |
| 84 | } else if (auto TD = dyn_cast<TagDecl>(D)) { |
| 85 | if (auto Def = TD->getDefinition()) |
| 86 | return Def; |
| 87 | } |
| 88 | return D; |
| 89 | } |
| 90 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 91 | llvm::Module *ReleaseModule() override { return M.release(); } |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 92 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 93 | void Initialize(ASTContext &Context) override { |
Chris Lattner | 8ee3c03 | 2008-02-06 02:01:47 +0000 | [diff] [blame] | 94 | Ctx = &Context; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 95 | |
Douglas Gregor | bcfd1f5 | 2011-09-02 00:18:52 +0000 | [diff] [blame] | 96 | M->setTargetTriple(Ctx->getTargetInfo().getTriple().getTriple()); |
| 97 | M->setDataLayout(Ctx->getTargetInfo().getTargetDescription()); |
Stephen Hines | 0e2c34f | 2015-03-23 12:09:02 -0700 | [diff] [blame^] | 98 | TD.reset( |
| 99 | new llvm::DataLayout(Ctx->getTargetInfo().getTargetDescription())); |
John McCall | 3abae09 | 2013-04-16 22:48:20 +0000 | [diff] [blame] | 100 | Builder.reset(new CodeGen::CodeGenModule(Context, CodeGenOpts, *M, *TD, |
Stephen Hines | 176edba | 2014-12-01 14:53:08 -0800 | [diff] [blame] | 101 | Diags, CoverageInfo)); |
Hans Wennborg | b357479 | 2013-08-08 00:17:41 +0000 | [diff] [blame] | 102 | |
| 103 | for (size_t i = 0, e = CodeGenOpts.DependentLibraries.size(); i < e; ++i) |
| 104 | HandleDependentLibrary(CodeGenOpts.DependentLibraries[i]); |
Chris Lattner | 8ee3c03 | 2008-02-06 02:01:47 +0000 | [diff] [blame] | 105 | } |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 106 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 107 | void HandleCXXStaticMemberVarInstantiation(VarDecl *VD) override { |
David Blaikie | 0a1c862 | 2013-08-19 21:02:26 +0000 | [diff] [blame] | 108 | if (Diags.hasErrorOccurred()) |
| 109 | return; |
| 110 | |
Rafael Espindola | 0250393 | 2012-03-08 15:51:03 +0000 | [diff] [blame] | 111 | Builder->HandleCXXStaticMemberVarInstantiation(VD); |
Rafael Espindola | 234fe65 | 2012-03-05 10:54:55 +0000 | [diff] [blame] | 112 | } |
| 113 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 114 | bool HandleTopLevelDecl(DeclGroupRef DG) override { |
David Blaikie | 0a1c862 | 2013-08-19 21:02:26 +0000 | [diff] [blame] | 115 | if (Diags.hasErrorOccurred()) |
| 116 | return true; |
| 117 | |
Stephen Hines | 176edba | 2014-12-01 14:53:08 -0800 | [diff] [blame] | 118 | HandlingTopLevelDeclRAII HandlingDecl(*this); |
| 119 | |
Douglas Gregor | 4afa39d | 2009-01-20 01:17:11 +0000 | [diff] [blame] | 120 | // Make sure to emit all elements of a Decl. |
Chris Lattner | 682bf92 | 2009-03-29 16:50:03 +0000 | [diff] [blame] | 121 | for (DeclGroupRef::iterator I = DG.begin(), E = DG.end(); I != E; ++I) |
| 122 | Builder->EmitTopLevelDecl(*I); |
Stephen Hines | c568f1e | 2014-07-21 00:47:37 -0700 | [diff] [blame] | 123 | |
Argyrios Kyrtzidis | 88c2596 | 2011-11-18 00:26:59 +0000 | [diff] [blame] | 124 | return true; |
Chris Lattner | 8ee3c03 | 2008-02-06 02:01:47 +0000 | [diff] [blame] | 125 | } |
Daniel Dunbar | 41071de | 2008-08-15 23:26:23 +0000 | [diff] [blame] | 126 | |
Stephen Hines | 176edba | 2014-12-01 14:53:08 -0800 | [diff] [blame] | 127 | void EmitDeferredDecls() { |
| 128 | if (DeferredInlineMethodDefinitions.empty()) |
| 129 | return; |
| 130 | |
| 131 | // Emit any deferred inline method definitions. Note that more deferred |
| 132 | // methods may be added during this loop, since ASTConsumer callbacks |
| 133 | // can be invoked if AST inspection results in declarations being added. |
| 134 | HandlingTopLevelDeclRAII HandlingDecl(*this); |
| 135 | for (unsigned I = 0; I != DeferredInlineMethodDefinitions.size(); ++I) |
| 136 | Builder->EmitTopLevelDecl(DeferredInlineMethodDefinitions[I]); |
| 137 | DeferredInlineMethodDefinitions.clear(); |
| 138 | } |
| 139 | |
Stephen Hines | 6bcf27b | 2014-05-29 04:14:42 -0700 | [diff] [blame] | 140 | void HandleInlineMethodDefinition(CXXMethodDecl *D) override { |
| 141 | if (Diags.hasErrorOccurred()) |
| 142 | return; |
| 143 | |
| 144 | assert(D->doesThisDeclarationHaveABody()); |
| 145 | |
Stephen Hines | c568f1e | 2014-07-21 00:47:37 -0700 | [diff] [blame] | 146 | // We may want to emit this definition. However, that decision might be |
| 147 | // based on computing the linkage, and we have to defer that in case we |
| 148 | // are inside of something that will change the method's final linkage, |
| 149 | // e.g. |
| 150 | // typedef struct { |
| 151 | // void bar(); |
| 152 | // void foo() { bar(); } |
| 153 | // } A; |
| 154 | DeferredInlineMethodDefinitions.push_back(D); |
Stephen Hines | 176edba | 2014-12-01 14:53:08 -0800 | [diff] [blame] | 155 | |
| 156 | // Provide some coverage mapping even for methods that aren't emitted. |
| 157 | // Don't do this for templated classes though, as they may not be |
| 158 | // instantiable. |
| 159 | if (!D->getParent()->getDescribedClassTemplate()) |
| 160 | Builder->AddDeferredUnusedCoverageMapping(D); |
Stephen Hines | 6bcf27b | 2014-05-29 04:14:42 -0700 | [diff] [blame] | 161 | } |
| 162 | |
Chris Lattner | 9eee0f8 | 2008-02-06 04:51:19 +0000 | [diff] [blame] | 163 | /// HandleTagDeclDefinition - This callback is invoked each time a TagDecl |
Chris Lattner | 682bf92 | 2009-03-29 16:50:03 +0000 | [diff] [blame] | 164 | /// to (e.g. struct, union, enum, class) is completed. This allows the |
| 165 | /// client hack on the type, which can occur at any point in the file |
| 166 | /// (because these can be defined in declspecs). |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 167 | void HandleTagDeclDefinition(TagDecl *D) override { |
David Blaikie | 0a1c862 | 2013-08-19 21:02:26 +0000 | [diff] [blame] | 168 | if (Diags.hasErrorOccurred()) |
| 169 | return; |
| 170 | |
Chris Lattner | c5b8806 | 2008-02-06 05:08:19 +0000 | [diff] [blame] | 171 | Builder->UpdateCompletedType(D); |
Stephen Hines | 176edba | 2014-12-01 14:53:08 -0800 | [diff] [blame] | 172 | |
| 173 | // For MSVC compatibility, treat declarations of static data members with |
| 174 | // inline initializers as definitions. |
| 175 | if (Ctx->getLangOpts().MSVCCompat) { |
| 176 | for (Decl *Member : D->decls()) { |
| 177 | if (VarDecl *VD = dyn_cast<VarDecl>(Member)) { |
| 178 | if (Ctx->isMSStaticDataMemberInlineDefinition(VD) && |
| 179 | Ctx->DeclMustBeEmitted(VD)) { |
| 180 | Builder->EmitGlobal(VD); |
| 181 | } |
| 182 | } |
| 183 | } |
| 184 | } |
Chris Lattner | 9eee0f8 | 2008-02-06 04:51:19 +0000 | [diff] [blame] | 185 | } |
Ted Kremenek | 159346a | 2008-08-07 19:47:41 +0000 | [diff] [blame] | 186 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 187 | void HandleTagDeclRequiredDefinition(const TagDecl *D) override { |
David Blaikie | 0a1c862 | 2013-08-19 21:02:26 +0000 | [diff] [blame] | 188 | if (Diags.hasErrorOccurred()) |
| 189 | return; |
| 190 | |
David Blaikie | 658cd2c | 2013-07-13 21:08:14 +0000 | [diff] [blame] | 191 | if (CodeGen::CGDebugInfo *DI = Builder->getModuleDebugInfo()) |
| 192 | if (const RecordDecl *RD = dyn_cast<RecordDecl>(D)) |
David Blaikie | 2780489 | 2013-08-15 20:49:17 +0000 | [diff] [blame] | 193 | DI->completeRequiredType(RD); |
David Blaikie | 658cd2c | 2013-07-13 21:08:14 +0000 | [diff] [blame] | 194 | } |
| 195 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 196 | void HandleTranslationUnit(ASTContext &Ctx) override { |
Ted Kremenek | 159346a | 2008-08-07 19:47:41 +0000 | [diff] [blame] | 197 | if (Diags.hasErrorOccurred()) { |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 198 | if (Builder) |
| 199 | Builder->clear(); |
Ted Kremenek | 159346a | 2008-08-07 19:47:41 +0000 | [diff] [blame] | 200 | M.reset(); |
| 201 | return; |
| 202 | } |
| 203 | |
| 204 | if (Builder) |
| 205 | Builder->Release(); |
Daniel Dunbar | 7177dee | 2009-12-19 17:50:07 +0000 | [diff] [blame] | 206 | } |
Douglas Gregor | b6c8c8b | 2009-04-21 17:11:58 +0000 | [diff] [blame] | 207 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 208 | void CompleteTentativeDefinition(VarDecl *D) override { |
Douglas Gregor | b6c8c8b | 2009-04-21 17:11:58 +0000 | [diff] [blame] | 209 | if (Diags.hasErrorOccurred()) |
| 210 | return; |
| 211 | |
| 212 | Builder->EmitTentativeDefinition(D); |
| 213 | } |
Douglas Gregor | 6fb745b | 2010-05-13 16:44:06 +0000 | [diff] [blame] | 214 | |
Stephen Hines | 0e2c34f | 2015-03-23 12:09:02 -0700 | [diff] [blame^] | 215 | void HandleVTable(CXXRecordDecl *RD) override { |
Douglas Gregor | 6fb745b | 2010-05-13 16:44:06 +0000 | [diff] [blame] | 216 | if (Diags.hasErrorOccurred()) |
| 217 | return; |
| 218 | |
Stephen Hines | 0e2c34f | 2015-03-23 12:09:02 -0700 | [diff] [blame^] | 219 | Builder->EmitVTable(RD); |
Douglas Gregor | 6fb745b | 2010-05-13 16:44:06 +0000 | [diff] [blame] | 220 | } |
Reid Kleckner | 3190ca9 | 2013-05-08 13:44:39 +0000 | [diff] [blame] | 221 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 222 | void HandleLinkerOptionPragma(llvm::StringRef Opts) override { |
Reid Kleckner | 3190ca9 | 2013-05-08 13:44:39 +0000 | [diff] [blame] | 223 | Builder->AppendLinkerOptions(Opts); |
| 224 | } |
| 225 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 226 | void HandleDetectMismatch(llvm::StringRef Name, |
| 227 | llvm::StringRef Value) override { |
Aaron Ballman | a7ff62f | 2013-06-04 02:07:14 +0000 | [diff] [blame] | 228 | Builder->AddDetectMismatch(Name, Value); |
| 229 | } |
| 230 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 231 | void HandleDependentLibrary(llvm::StringRef Lib) override { |
Reid Kleckner | 3190ca9 | 2013-05-08 13:44:39 +0000 | [diff] [blame] | 232 | Builder->AddDependentLib(Lib); |
| 233 | } |
Chris Lattner | 8ee3c03 | 2008-02-06 02:01:47 +0000 | [diff] [blame] | 234 | }; |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 235 | } |
| 236 | |
David Blaikie | 99ba9e3 | 2011-12-20 02:48:34 +0000 | [diff] [blame] | 237 | void CodeGenerator::anchor() { } |
| 238 | |
David Blaikie | d6471f7 | 2011-09-25 23:23:43 +0000 | [diff] [blame] | 239 | CodeGenerator *clang::CreateLLVMCodeGen(DiagnosticsEngine &Diags, |
Ted Kremenek | 815c78f | 2008-08-05 18:50:11 +0000 | [diff] [blame] | 240 | const std::string& ModuleName, |
Chandler Carruth | 2811ccf | 2009-11-12 17:24:48 +0000 | [diff] [blame] | 241 | const CodeGenOptions &CGO, |
Stephen Hines | 176edba | 2014-12-01 14:53:08 -0800 | [diff] [blame] | 242 | llvm::LLVMContext& C, |
| 243 | CoverageSourceInfo *CoverageInfo) { |
| 244 | return new CodeGeneratorImpl(Diags, ModuleName, CGO, C, CoverageInfo); |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 245 | } |