Chris Lattner | f97fe38 | 2007-05-24 06:29:05 +0000 | [diff] [blame] | 1 | //===--- ModuleBuilder.cpp - Emit LLVM Code from ASTs ---------------------===// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
Chris Lattner | 5b12ab8 | 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. |
Chris Lattner | f97fe38 | 2007-05-24 06:29:05 +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 | 48ad6dc | 2013-07-13 21:08:14 +0000 | [diff] [blame] | 15 | #include "CGDebugInfo.h" |
Chandler Carruth | 5553d0d | 2014-01-07 11:51:46 +0000 | [diff] [blame] | 16 | #include "CodeGenModule.h" |
Chris Lattner | adf1f51 | 2008-02-06 02:01:47 +0000 | [diff] [blame] | 17 | #include "clang/AST/ASTContext.h" |
Daniel Dunbar | 221fa94 | 2008-08-11 04:54:23 +0000 | [diff] [blame] | 18 | #include "clang/AST/DeclObjC.h" |
| 19 | #include "clang/AST/Expr.h" |
Chris Lattner | adf1f51 | 2008-02-06 02:01:47 +0000 | [diff] [blame] | 20 | #include "clang/Basic/Diagnostic.h" |
| 21 | #include "clang/Basic/TargetInfo.h" |
Chandler Carruth | 3a02247 | 2012-12-04 09:13:33 +0000 | [diff] [blame] | 22 | #include "clang/Frontend/CodeGenOptions.h" |
Reid Kleckner | e43f0fe | 2013-05-08 13:44:39 +0000 | [diff] [blame] | 23 | #include "llvm/ADT/StringRef.h" |
Chandler Carruth | ffd5551 | 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" |
Ahmed Charles | dfca6f9 | 2014-03-09 11:36:40 +0000 | [diff] [blame] | 27 | #include <memory> |
Chris Lattner | 984fac5 | 2009-03-26 05:00:52 +0000 | [diff] [blame] | 28 | using namespace clang; |
Ted Kremenek | 2c674f6 | 2008-08-05 18:50:11 +0000 | [diff] [blame] | 29 | |
Chris Lattner | adf1f51 | 2008-02-06 02:01:47 +0000 | [diff] [blame] | 30 | namespace { |
Benjamin Kramer | 337e3a5 | 2009-11-28 19:45:26 +0000 | [diff] [blame] | 31 | class CodeGeneratorImpl : public CodeGenerator { |
David Blaikie | 9c902b5 | 2011-09-25 23:23:43 +0000 | [diff] [blame] | 32 | DiagnosticsEngine &Diags; |
Chris Lattner | adf1f51 | 2008-02-06 02:01:47 +0000 | [diff] [blame] | 33 | ASTContext *Ctx; |
Adrian Prantl | e74f525 | 2015-06-30 02:26:03 +0000 | [diff] [blame] | 34 | const HeaderSearchOptions &HeaderSearchOpts; // Only used for debug info. |
| 35 | const PreprocessorOptions &PreprocessorOpts; // Only used for debug info. |
Chandler Carruth | bc55fe2 | 2009-11-12 17:24:48 +0000 | [diff] [blame] | 36 | const CodeGenOptions CodeGenOpts; // Intentionally copied in. |
Richard Smith | 7f5755c | 2014-08-01 22:42:16 +0000 | [diff] [blame] | 37 | |
| 38 | unsigned HandlingTopLevelDecls; |
| 39 | struct HandlingTopLevelDeclRAII { |
| 40 | CodeGeneratorImpl &Self; |
| 41 | HandlingTopLevelDeclRAII(CodeGeneratorImpl &Self) : Self(Self) { |
| 42 | ++Self.HandlingTopLevelDecls; |
| 43 | } |
| 44 | ~HandlingTopLevelDeclRAII() { |
| 45 | if (--Self.HandlingTopLevelDecls == 0) |
| 46 | Self.EmitDeferredDecls(); |
| 47 | } |
| 48 | }; |
| 49 | |
Alex Lorenz | ee02499 | 2014-08-04 18:41:51 +0000 | [diff] [blame] | 50 | CoverageSourceInfo *CoverageInfo; |
| 51 | |
Chris Lattner | adf1f51 | 2008-02-06 02:01:47 +0000 | [diff] [blame] | 52 | protected: |
Ahmed Charles | b898432 | 2014-03-07 20:03:18 +0000 | [diff] [blame] | 53 | std::unique_ptr<llvm::Module> M; |
| 54 | std::unique_ptr<CodeGen::CodeGenModule> Builder; |
| 55 | |
Hans Wennborg | 2b0d014 | 2014-12-18 19:19:00 +0000 | [diff] [blame] | 56 | private: |
| 57 | SmallVector<CXXMethodDecl *, 8> DeferredInlineMethodDefinitions; |
| 58 | |
Chris Lattner | adf1f51 | 2008-02-06 02:01:47 +0000 | [diff] [blame] | 59 | public: |
Adrian Prantl | e74f525 | 2015-06-30 02:26:03 +0000 | [diff] [blame] | 60 | CodeGeneratorImpl(DiagnosticsEngine &diags, const std::string &ModuleName, |
| 61 | const HeaderSearchOptions &HSO, |
| 62 | const PreprocessorOptions &PPO, const CodeGenOptions &CGO, |
| 63 | llvm::LLVMContext &C, |
Alex Lorenz | ee02499 | 2014-08-04 18:41:51 +0000 | [diff] [blame] | 64 | CoverageSourceInfo *CoverageInfo = nullptr) |
Adrian Prantl | e74f525 | 2015-06-30 02:26:03 +0000 | [diff] [blame] | 65 | : Diags(diags), Ctx(nullptr), HeaderSearchOpts(HSO), |
| 66 | PreprocessorOpts(PPO), CodeGenOpts(CGO), HandlingTopLevelDecls(0), |
| 67 | CoverageInfo(CoverageInfo), |
| 68 | M(new llvm::Module(ModuleName, C)) {} |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 69 | |
Alexander Kornienko | 34eb207 | 2015-04-11 02:00:23 +0000 | [diff] [blame] | 70 | ~CodeGeneratorImpl() override { |
Hans Wennborg | 0c0a8c8 | 2014-12-19 23:35:11 +0000 | [diff] [blame] | 71 | // There should normally not be any leftover inline method definitions. |
| 72 | assert(DeferredInlineMethodDefinitions.empty() || |
| 73 | Diags.hasErrorOccurred()); |
Hans Wennborg | 2b0d014 | 2014-12-18 19:19:00 +0000 | [diff] [blame] | 74 | } |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 75 | |
Craig Topper | 4f12f10 | 2014-03-12 06:41:41 +0000 | [diff] [blame] | 76 | llvm::Module* GetModule() override { |
Daniel Dunbar | 30c514e | 2008-10-21 19:55:09 +0000 | [diff] [blame] | 77 | return M.get(); |
| 78 | } |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 79 | |
Alp Toker | fb8d02b | 2014-06-05 22:10:59 +0000 | [diff] [blame] | 80 | const Decl *GetDeclForMangledName(StringRef MangledName) override { |
| 81 | GlobalDecl Result; |
| 82 | if (!Builder->lookupRepresentativeDecl(MangledName, Result)) |
| 83 | return nullptr; |
| 84 | const Decl *D = Result.getCanonicalDecl().getDecl(); |
| 85 | if (auto FD = dyn_cast<FunctionDecl>(D)) { |
| 86 | if (FD->hasBody(FD)) |
| 87 | return FD; |
| 88 | } else if (auto TD = dyn_cast<TagDecl>(D)) { |
| 89 | if (auto Def = TD->getDefinition()) |
| 90 | return Def; |
| 91 | } |
| 92 | return D; |
| 93 | } |
| 94 | |
Craig Topper | 4f12f10 | 2014-03-12 06:41:41 +0000 | [diff] [blame] | 95 | llvm::Module *ReleaseModule() override { return M.release(); } |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 96 | |
Craig Topper | 4f12f10 | 2014-03-12 06:41:41 +0000 | [diff] [blame] | 97 | void Initialize(ASTContext &Context) override { |
Chris Lattner | adf1f51 | 2008-02-06 02:01:47 +0000 | [diff] [blame] | 98 | Ctx = &Context; |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 99 | |
Douglas Gregor | e8bbc12 | 2011-09-02 00:18:52 +0000 | [diff] [blame] | 100 | M->setTargetTriple(Ctx->getTargetInfo().getTriple().getTriple()); |
Eric Christopher | 964a5f3 | 2015-08-05 23:48:05 +0000 | [diff] [blame] | 101 | M->setDataLayout(Ctx->getTargetInfo().getDataLayoutString()); |
Mehdi Amini | ca3cf9e | 2015-07-24 16:04:29 +0000 | [diff] [blame] | 102 | Builder.reset(new CodeGen::CodeGenModule(Context, HeaderSearchOpts, |
| 103 | PreprocessorOpts, CodeGenOpts, |
| 104 | *M, Diags, CoverageInfo)); |
Hans Wennborg | 75958c4 | 2013-08-08 00:17:41 +0000 | [diff] [blame] | 105 | |
Peter Collingbourne | dc13453 | 2016-01-16 00:31:22 +0000 | [diff] [blame] | 106 | for (auto &&Lib : CodeGenOpts.DependentLibraries) |
| 107 | HandleDependentLibrary(Lib); |
| 108 | for (auto &&Opt : CodeGenOpts.LinkerOptions) |
| 109 | HandleLinkerOption(Opt); |
Chris Lattner | adf1f51 | 2008-02-06 02:01:47 +0000 | [diff] [blame] | 110 | } |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 111 | |
Craig Topper | 4f12f10 | 2014-03-12 06:41:41 +0000 | [diff] [blame] | 112 | void HandleCXXStaticMemberVarInstantiation(VarDecl *VD) override { |
David Blaikie | 4a9ec7b | 2013-08-19 21:02:26 +0000 | [diff] [blame] | 113 | if (Diags.hasErrorOccurred()) |
| 114 | return; |
| 115 | |
Rafael Espindola | df88f6f | 2012-03-08 15:51:03 +0000 | [diff] [blame] | 116 | Builder->HandleCXXStaticMemberVarInstantiation(VD); |
Rafael Espindola | 189fa74 | 2012-03-05 10:54:55 +0000 | [diff] [blame] | 117 | } |
| 118 | |
Craig Topper | 4f12f10 | 2014-03-12 06:41:41 +0000 | [diff] [blame] | 119 | bool HandleTopLevelDecl(DeclGroupRef DG) override { |
David Blaikie | 4a9ec7b | 2013-08-19 21:02:26 +0000 | [diff] [blame] | 120 | if (Diags.hasErrorOccurred()) |
| 121 | return true; |
| 122 | |
Richard Smith | 7f5755c | 2014-08-01 22:42:16 +0000 | [diff] [blame] | 123 | HandlingTopLevelDeclRAII HandlingDecl(*this); |
| 124 | |
Douglas Gregor | 6e6ad60 | 2009-01-20 01:17:11 +0000 | [diff] [blame] | 125 | // Make sure to emit all elements of a Decl. |
Chris Lattner | 5bbb3c8 | 2009-03-29 16:50:03 +0000 | [diff] [blame] | 126 | for (DeclGroupRef::iterator I = DG.begin(), E = DG.end(); I != E; ++I) |
| 127 | Builder->EmitTopLevelDecl(*I); |
Hans Wennborg | dfcb7d6 | 2014-06-06 17:36:17 +0000 | [diff] [blame] | 128 | |
Richard Smith | 7f5755c | 2014-08-01 22:42:16 +0000 | [diff] [blame] | 129 | return true; |
| 130 | } |
| 131 | |
| 132 | void EmitDeferredDecls() { |
Richard Smith | c9cbde7 | 2014-08-13 21:15:09 +0000 | [diff] [blame] | 133 | if (DeferredInlineMethodDefinitions.empty()) |
| 134 | return; |
| 135 | |
Richard Smith | 1ba0a07 | 2014-08-01 20:39:36 +0000 | [diff] [blame] | 136 | // Emit any deferred inline method definitions. Note that more deferred |
| 137 | // methods may be added during this loop, since ASTConsumer callbacks |
| 138 | // can be invoked if AST inspection results in declarations being added. |
Richard Smith | c9cbde7 | 2014-08-13 21:15:09 +0000 | [diff] [blame] | 139 | HandlingTopLevelDeclRAII HandlingDecl(*this); |
| 140 | for (unsigned I = 0; I != DeferredInlineMethodDefinitions.size(); ++I) |
Richard Smith | 1ba0a07 | 2014-08-01 20:39:36 +0000 | [diff] [blame] | 141 | Builder->EmitTopLevelDecl(DeferredInlineMethodDefinitions[I]); |
Richard Smith | 455768e | 2014-08-01 20:09:39 +0000 | [diff] [blame] | 142 | DeferredInlineMethodDefinitions.clear(); |
Chris Lattner | adf1f51 | 2008-02-06 02:01:47 +0000 | [diff] [blame] | 143 | } |
Daniel Dunbar | fce4be8 | 2008-08-15 23:26:23 +0000 | [diff] [blame] | 144 | |
Hans Wennborg | a926d84 | 2014-05-23 20:37:38 +0000 | [diff] [blame] | 145 | void HandleInlineMethodDefinition(CXXMethodDecl *D) override { |
| 146 | if (Diags.hasErrorOccurred()) |
| 147 | return; |
| 148 | |
| 149 | assert(D->doesThisDeclarationHaveABody()); |
| 150 | |
Hans Wennborg | dfcb7d6 | 2014-06-06 17:36:17 +0000 | [diff] [blame] | 151 | // We may want to emit this definition. However, that decision might be |
| 152 | // based on computing the linkage, and we have to defer that in case we |
| 153 | // are inside of something that will change the method's final linkage, |
| 154 | // e.g. |
| 155 | // typedef struct { |
| 156 | // void bar(); |
| 157 | // void foo() { bar(); } |
| 158 | // } A; |
| 159 | DeferredInlineMethodDefinitions.push_back(D); |
Alex Lorenz | ee02499 | 2014-08-04 18:41:51 +0000 | [diff] [blame] | 160 | |
Justin Bogner | 94d384e | 2014-11-18 00:34:46 +0000 | [diff] [blame] | 161 | // Provide some coverage mapping even for methods that aren't emitted. |
| 162 | // Don't do this for templated classes though, as they may not be |
| 163 | // instantiable. |
| 164 | if (!D->getParent()->getDescribedClassTemplate()) |
| 165 | Builder->AddDeferredUnusedCoverageMapping(D); |
Hans Wennborg | a926d84 | 2014-05-23 20:37:38 +0000 | [diff] [blame] | 166 | } |
| 167 | |
Chris Lattner | a5e4d30 | 2008-02-06 04:51:19 +0000 | [diff] [blame] | 168 | /// HandleTagDeclDefinition - This callback is invoked each time a TagDecl |
Chris Lattner | 5bbb3c8 | 2009-03-29 16:50:03 +0000 | [diff] [blame] | 169 | /// to (e.g. struct, union, enum, class) is completed. This allows the |
| 170 | /// client hack on the type, which can occur at any point in the file |
| 171 | /// (because these can be defined in declspecs). |
Craig Topper | 4f12f10 | 2014-03-12 06:41:41 +0000 | [diff] [blame] | 172 | void HandleTagDeclDefinition(TagDecl *D) override { |
David Blaikie | 4a9ec7b | 2013-08-19 21:02:26 +0000 | [diff] [blame] | 173 | if (Diags.hasErrorOccurred()) |
| 174 | return; |
| 175 | |
Chris Lattner | 68be606 | 2008-02-06 05:08:19 +0000 | [diff] [blame] | 176 | Builder->UpdateCompletedType(D); |
Hans Wennborg | 56fc62b | 2014-07-17 20:25:23 +0000 | [diff] [blame] | 177 | |
| 178 | // For MSVC compatibility, treat declarations of static data members with |
| 179 | // inline initializers as definitions. |
David Majnemer | 3f02150 | 2015-10-08 04:53:31 +0000 | [diff] [blame] | 180 | if (Ctx->getTargetInfo().getCXXABI().isMicrosoft()) { |
Hans Wennborg | 56fc62b | 2014-07-17 20:25:23 +0000 | [diff] [blame] | 181 | for (Decl *Member : D->decls()) { |
| 182 | if (VarDecl *VD = dyn_cast<VarDecl>(Member)) { |
| 183 | if (Ctx->isMSStaticDataMemberInlineDefinition(VD) && |
| 184 | Ctx->DeclMustBeEmitted(VD)) { |
| 185 | Builder->EmitGlobal(VD); |
| 186 | } |
| 187 | } |
| 188 | } |
| 189 | } |
Chris Lattner | a5e4d30 | 2008-02-06 04:51:19 +0000 | [diff] [blame] | 190 | } |
Ted Kremenek | 7db4f60 | 2008-08-07 19:47:41 +0000 | [diff] [blame] | 191 | |
Craig Topper | 4f12f10 | 2014-03-12 06:41:41 +0000 | [diff] [blame] | 192 | void HandleTagDeclRequiredDefinition(const TagDecl *D) override { |
David Blaikie | 4a9ec7b | 2013-08-19 21:02:26 +0000 | [diff] [blame] | 193 | if (Diags.hasErrorOccurred()) |
| 194 | return; |
| 195 | |
David Blaikie | 48ad6dc | 2013-07-13 21:08:14 +0000 | [diff] [blame] | 196 | if (CodeGen::CGDebugInfo *DI = Builder->getModuleDebugInfo()) |
| 197 | if (const RecordDecl *RD = dyn_cast<RecordDecl>(D)) |
David Blaikie | b2e86eb | 2013-08-15 20:49:17 +0000 | [diff] [blame] | 198 | DI->completeRequiredType(RD); |
David Blaikie | 48ad6dc | 2013-07-13 21:08:14 +0000 | [diff] [blame] | 199 | } |
| 200 | |
Craig Topper | 4f12f10 | 2014-03-12 06:41:41 +0000 | [diff] [blame] | 201 | void HandleTranslationUnit(ASTContext &Ctx) override { |
Manman Ren | 581c2b9 | 2016-01-28 23:29:02 +0000 | [diff] [blame^] | 202 | // Release the Builder when there is no error. |
| 203 | if (!Diags.hasErrorOccurred() && Builder) |
| 204 | Builder->Release(); |
| 205 | |
| 206 | // If there are errors before or when releasing the Builder, reset |
| 207 | // the module to stop here before invoking the backend. |
Ted Kremenek | 7db4f60 | 2008-08-07 19:47:41 +0000 | [diff] [blame] | 208 | if (Diags.hasErrorOccurred()) { |
Rafael Espindola | c0ff744 | 2013-12-09 14:59:08 +0000 | [diff] [blame] | 209 | if (Builder) |
| 210 | Builder->clear(); |
Ted Kremenek | 7db4f60 | 2008-08-07 19:47:41 +0000 | [diff] [blame] | 211 | M.reset(); |
| 212 | return; |
| 213 | } |
Daniel Dunbar | e017ecc | 2009-12-19 17:50:07 +0000 | [diff] [blame] | 214 | } |
Douglas Gregor | beecd58 | 2009-04-21 17:11:58 +0000 | [diff] [blame] | 215 | |
David Majnemer | 929025d | 2016-01-26 19:30:26 +0000 | [diff] [blame] | 216 | void AssignInheritanceModel(CXXRecordDecl *RD) override { |
| 217 | if (Diags.hasErrorOccurred()) |
| 218 | return; |
| 219 | |
| 220 | Builder->RefreshTypeCacheForClass(RD); |
| 221 | } |
| 222 | |
Craig Topper | 4f12f10 | 2014-03-12 06:41:41 +0000 | [diff] [blame] | 223 | void CompleteTentativeDefinition(VarDecl *D) override { |
Douglas Gregor | beecd58 | 2009-04-21 17:11:58 +0000 | [diff] [blame] | 224 | if (Diags.hasErrorOccurred()) |
| 225 | return; |
| 226 | |
| 227 | Builder->EmitTentativeDefinition(D); |
| 228 | } |
Douglas Gregor | 88d292c | 2010-05-13 16:44:06 +0000 | [diff] [blame] | 229 | |
Nico Weber | b6a5d05 | 2015-01-15 04:07:35 +0000 | [diff] [blame] | 230 | void HandleVTable(CXXRecordDecl *RD) override { |
Douglas Gregor | 88d292c | 2010-05-13 16:44:06 +0000 | [diff] [blame] | 231 | if (Diags.hasErrorOccurred()) |
| 232 | return; |
| 233 | |
Nico Weber | b6a5d05 | 2015-01-15 04:07:35 +0000 | [diff] [blame] | 234 | Builder->EmitVTable(RD); |
Douglas Gregor | 88d292c | 2010-05-13 16:44:06 +0000 | [diff] [blame] | 235 | } |
Reid Kleckner | e43f0fe | 2013-05-08 13:44:39 +0000 | [diff] [blame] | 236 | |
Peter Collingbourne | dc13453 | 2016-01-16 00:31:22 +0000 | [diff] [blame] | 237 | void HandleLinkerOption(llvm::StringRef Opts) override { |
Reid Kleckner | e43f0fe | 2013-05-08 13:44:39 +0000 | [diff] [blame] | 238 | Builder->AppendLinkerOptions(Opts); |
| 239 | } |
| 240 | |
Craig Topper | 4f12f10 | 2014-03-12 06:41:41 +0000 | [diff] [blame] | 241 | void HandleDetectMismatch(llvm::StringRef Name, |
| 242 | llvm::StringRef Value) override { |
Aaron Ballman | 5d041be | 2013-06-04 02:07:14 +0000 | [diff] [blame] | 243 | Builder->AddDetectMismatch(Name, Value); |
| 244 | } |
| 245 | |
Craig Topper | 4f12f10 | 2014-03-12 06:41:41 +0000 | [diff] [blame] | 246 | void HandleDependentLibrary(llvm::StringRef Lib) override { |
Reid Kleckner | e43f0fe | 2013-05-08 13:44:39 +0000 | [diff] [blame] | 247 | Builder->AddDependentLib(Lib); |
| 248 | } |
Chris Lattner | adf1f51 | 2008-02-06 02:01:47 +0000 | [diff] [blame] | 249 | }; |
Alexander Kornienko | ab9db51 | 2015-06-22 23:07:51 +0000 | [diff] [blame] | 250 | } |
Chris Lattner | f97fe38 | 2007-05-24 06:29:05 +0000 | [diff] [blame] | 251 | |
David Blaikie | 68e081d | 2011-12-20 02:48:34 +0000 | [diff] [blame] | 252 | void CodeGenerator::anchor() { } |
| 253 | |
Adrian Prantl | e74f525 | 2015-06-30 02:26:03 +0000 | [diff] [blame] | 254 | CodeGenerator *clang::CreateLLVMCodeGen( |
| 255 | DiagnosticsEngine &Diags, const std::string &ModuleName, |
| 256 | const HeaderSearchOptions &HeaderSearchOpts, |
| 257 | const PreprocessorOptions &PreprocessorOpts, const CodeGenOptions &CGO, |
| 258 | llvm::LLVMContext &C, CoverageSourceInfo *CoverageInfo) { |
| 259 | return new CodeGeneratorImpl(Diags, ModuleName, HeaderSearchOpts, |
| 260 | PreprocessorOpts, CGO, C, CoverageInfo); |
Chris Lattner | f97fe38 | 2007-05-24 06:29:05 +0000 | [diff] [blame] | 261 | } |