1 //===--- CodeGenAction.cpp - LLVM Code Generation Frontend Action ---------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #include "clang/CodeGen/CodeGenAction.h"
11 #include "clang/AST/ASTConsumer.h"
12 #include "clang/AST/ASTContext.h"
13 #include "clang/AST/DeclGroup.h"
14 #include "clang/AST/DeclCXX.h"
15 #include "clang/Basic/FileManager.h"
16 #include "clang/Basic/SourceManager.h"
17 #include "clang/Basic/TargetInfo.h"
18 #include "clang/CodeGen/BackendUtil.h"
19 #include "clang/CodeGen/ModuleBuilder.h"
20 #include "clang/Frontend/CompilerInstance.h"
21 #include "clang/Frontend/FrontendDiagnostic.h"
22 #include "llvm/ADT/SmallString.h"
23 #include "llvm/Bitcode/ReaderWriter.h"
24 #include "llvm/IR/DebugInfo.h"
25 #include "llvm/IR/DiagnosticInfo.h"
26 #include "llvm/IR/DiagnosticPrinter.h"
27 #include "llvm/IR/LLVMContext.h"
28 #include "llvm/IR/Module.h"
29 #include "llvm/IRReader/IRReader.h"
30 #include "llvm/Linker/Linker.h"
31 #include "llvm/Pass.h"
32 #include "llvm/Support/MemoryBuffer.h"
33 #include "llvm/Support/SourceMgr.h"
34 #include "llvm/Support/Timer.h"
35 #include <memory>
36 using namespace clang;
37 using namespace llvm;
38 
39 namespace clang {
40   class BackendConsumer : public ASTConsumer {
41     virtual void anchor();
42     DiagnosticsEngine &Diags;
43     BackendAction Action;
44     const CodeGenOptions &CodeGenOpts;
45     const TargetOptions &TargetOpts;
46     const LangOptions &LangOpts;
47     raw_ostream *AsmOutStream;
48     ASTContext *Context;
49 
50     Timer LLVMIRGeneration;
51 
52     std::unique_ptr<CodeGenerator> Gen;
53 
54     std::unique_ptr<llvm::Module> TheModule, LinkModule;
55 
56   public:
57     BackendConsumer(BackendAction action, DiagnosticsEngine &_Diags,
58                     const CodeGenOptions &compopts,
59                     const TargetOptions &targetopts,
60                     const LangOptions &langopts, bool TimePasses,
61                     const std::string &infile, llvm::Module *LinkModule,
62                     raw_ostream *OS, LLVMContext &C)
63         : Diags(_Diags), Action(action), CodeGenOpts(compopts),
64           TargetOpts(targetopts), LangOpts(langopts), AsmOutStream(OS),
65           Context(), LLVMIRGeneration("LLVM IR Generation Time"),
66           Gen(CreateLLVMCodeGen(Diags, infile, compopts, targetopts, C)),
67           LinkModule(LinkModule) {
68       llvm::TimePassesIsEnabled = TimePasses;
69     }
70 
71     llvm::Module *takeModule() { return TheModule.release(); }
72     llvm::Module *takeLinkModule() { return LinkModule.release(); }
73 
74     void HandleCXXStaticMemberVarInstantiation(VarDecl *VD) override {
75       Gen->HandleCXXStaticMemberVarInstantiation(VD);
76     }
77 
78     void Initialize(ASTContext &Ctx) override {
79       Context = &Ctx;
80 
81       if (llvm::TimePassesIsEnabled)
82         LLVMIRGeneration.startTimer();
83 
84       Gen->Initialize(Ctx);
85 
86       TheModule.reset(Gen->GetModule());
87 
88       if (llvm::TimePassesIsEnabled)
89         LLVMIRGeneration.stopTimer();
90     }
91 
92     bool HandleTopLevelDecl(DeclGroupRef D) override {
93       PrettyStackTraceDecl CrashInfo(*D.begin(), SourceLocation(),
94                                      Context->getSourceManager(),
95                                      "LLVM IR generation of declaration");
96 
97       if (llvm::TimePassesIsEnabled)
98         LLVMIRGeneration.startTimer();
99 
100       Gen->HandleTopLevelDecl(D);
101 
102       if (llvm::TimePassesIsEnabled)
103         LLVMIRGeneration.stopTimer();
104 
105       return true;
106     }
107 
108     void HandleInlineMethodDefinition(CXXMethodDecl *D) override {
109       PrettyStackTraceDecl CrashInfo(D, SourceLocation(),
110                                      Context->getSourceManager(),
111                                      "LLVM IR generation of inline method");
112       if (llvm::TimePassesIsEnabled)
113         LLVMIRGeneration.startTimer();
114 
115       Gen->HandleInlineMethodDefinition(D);
116 
117       if (llvm::TimePassesIsEnabled)
118         LLVMIRGeneration.stopTimer();
119     }
120 
121     void HandleTranslationUnit(ASTContext &C) override {
122       {
123         PrettyStackTraceString CrashInfo("Per-file LLVM IR generation");
124         if (llvm::TimePassesIsEnabled)
125           LLVMIRGeneration.startTimer();
126 
127         Gen->HandleTranslationUnit(C);
128 
129         if (llvm::TimePassesIsEnabled)
130           LLVMIRGeneration.stopTimer();
131       }
132 
133       // Silently ignore if we weren't initialized for some reason.
134       if (!TheModule)
135         return;
136 
137       // Make sure IR generation is happy with the module. This is released by
138       // the module provider.
139       llvm::Module *M = Gen->ReleaseModule();
140       if (!M) {
141         // The module has been released by IR gen on failures, do not double
142         // free.
143         TheModule.release();
144         return;
145       }
146 
147       assert(TheModule.get() == M &&
148              "Unexpected module change during IR generation");
149 
150       // Link LinkModule into this module if present, preserving its validity.
151       if (LinkModule) {
152         std::string ErrorMsg;
153         if (Linker::LinkModules(M, LinkModule.get(), Linker::PreserveSource,
154                                 &ErrorMsg)) {
155           Diags.Report(diag::err_fe_cannot_link_module)
156             << LinkModule->getModuleIdentifier() << ErrorMsg;
157           return;
158         }
159       }
160 
161       // Install an inline asm handler so that diagnostics get printed through
162       // our diagnostics hooks.
163       LLVMContext &Ctx = TheModule->getContext();
164       LLVMContext::InlineAsmDiagHandlerTy OldHandler =
165         Ctx.getInlineAsmDiagnosticHandler();
166       void *OldContext = Ctx.getInlineAsmDiagnosticContext();
167       Ctx.setInlineAsmDiagnosticHandler(InlineAsmDiagHandler, this);
168 
169       LLVMContext::DiagnosticHandlerTy OldDiagnosticHandler =
170           Ctx.getDiagnosticHandler();
171       void *OldDiagnosticContext = Ctx.getDiagnosticContext();
172       Ctx.setDiagnosticHandler(DiagnosticHandler, this);
173 
174       EmitBackendOutput(Diags, CodeGenOpts, TargetOpts, LangOpts,
175                         C.getTargetInfo().getTargetDescription(),
176                         TheModule.get(), Action, AsmOutStream);
177 
178       Ctx.setInlineAsmDiagnosticHandler(OldHandler, OldContext);
179 
180       Ctx.setDiagnosticHandler(OldDiagnosticHandler, OldDiagnosticContext);
181     }
182 
183     void HandleTagDeclDefinition(TagDecl *D) override {
184       PrettyStackTraceDecl CrashInfo(D, SourceLocation(),
185                                      Context->getSourceManager(),
186                                      "LLVM IR generation of declaration");
187       Gen->HandleTagDeclDefinition(D);
188     }
189 
190     void HandleTagDeclRequiredDefinition(const TagDecl *D) override {
191       Gen->HandleTagDeclRequiredDefinition(D);
192     }
193 
194     void CompleteTentativeDefinition(VarDecl *D) override {
195       Gen->CompleteTentativeDefinition(D);
196     }
197 
198     void HandleVTable(CXXRecordDecl *RD, bool DefinitionRequired) override {
199       Gen->HandleVTable(RD, DefinitionRequired);
200     }
201 
202     void HandleLinkerOptionPragma(llvm::StringRef Opts) override {
203       Gen->HandleLinkerOptionPragma(Opts);
204     }
205 
206     void HandleDetectMismatch(llvm::StringRef Name,
207                                       llvm::StringRef Value) override {
208       Gen->HandleDetectMismatch(Name, Value);
209     }
210 
211     void HandleDependentLibrary(llvm::StringRef Opts) override {
212       Gen->HandleDependentLibrary(Opts);
213     }
214 
215     static void InlineAsmDiagHandler(const llvm::SMDiagnostic &SM,void *Context,
216                                      unsigned LocCookie) {
217       SourceLocation Loc = SourceLocation::getFromRawEncoding(LocCookie);
218       ((BackendConsumer*)Context)->InlineAsmDiagHandler2(SM, Loc);
219     }
220 
221     static void DiagnosticHandler(const llvm::DiagnosticInfo &DI,
222                                   void *Context) {
223       ((BackendConsumer *)Context)->DiagnosticHandlerImpl(DI);
224     }
225 
226     void InlineAsmDiagHandler2(const llvm::SMDiagnostic &,
227                                SourceLocation LocCookie);
228 
229     void DiagnosticHandlerImpl(const llvm::DiagnosticInfo &DI);
230     /// \brief Specialized handler for InlineAsm diagnostic.
231     /// \return True if the diagnostic has been successfully reported, false
232     /// otherwise.
233     bool InlineAsmDiagHandler(const llvm::DiagnosticInfoInlineAsm &D);
234     /// \brief Specialized handler for StackSize diagnostic.
235     /// \return True if the diagnostic has been successfully reported, false
236     /// otherwise.
237     bool StackSizeDiagHandler(const llvm::DiagnosticInfoStackSize &D);
238     /// \brief Specialized handlers for optimization remarks.
239     /// Note that these handlers only accept remarks and they always handle
240     /// them.
241     void
242     EmitOptimizationRemark(const llvm::DiagnosticInfoOptimizationRemarkBase &D,
243                            unsigned DiagID);
244     void
245     OptimizationRemarkHandler(const llvm::DiagnosticInfoOptimizationRemark &D);
246     void OptimizationRemarkHandler(
247         const llvm::DiagnosticInfoOptimizationRemarkMissed &D);
248     void OptimizationRemarkHandler(
249         const llvm::DiagnosticInfoOptimizationRemarkAnalysis &D);
250   };
251 
252   void BackendConsumer::anchor() {}
253 }
254 
255 /// ConvertBackendLocation - Convert a location in a temporary llvm::SourceMgr
256 /// buffer to be a valid FullSourceLoc.
257 static FullSourceLoc ConvertBackendLocation(const llvm::SMDiagnostic &D,
258                                             SourceManager &CSM) {
259   // Get both the clang and llvm source managers.  The location is relative to
260   // a memory buffer that the LLVM Source Manager is handling, we need to add
261   // a copy to the Clang source manager.
262   const llvm::SourceMgr &LSM = *D.getSourceMgr();
263 
264   // We need to copy the underlying LLVM memory buffer because llvm::SourceMgr
265   // already owns its one and clang::SourceManager wants to own its one.
266   const MemoryBuffer *LBuf =
267   LSM.getMemoryBuffer(LSM.FindBufferContainingLoc(D.getLoc()));
268 
269   // Create the copy and transfer ownership to clang::SourceManager.
270   llvm::MemoryBuffer *CBuf =
271   llvm::MemoryBuffer::getMemBufferCopy(LBuf->getBuffer(),
272                                        LBuf->getBufferIdentifier());
273   FileID FID = CSM.createFileID(CBuf);
274 
275   // Translate the offset into the file.
276   unsigned Offset = D.getLoc().getPointer()  - LBuf->getBufferStart();
277   SourceLocation NewLoc =
278   CSM.getLocForStartOfFile(FID).getLocWithOffset(Offset);
279   return FullSourceLoc(NewLoc, CSM);
280 }
281 
282 
283 /// InlineAsmDiagHandler2 - This function is invoked when the backend hits an
284 /// error parsing inline asm.  The SMDiagnostic indicates the error relative to
285 /// the temporary memory buffer that the inline asm parser has set up.
286 void BackendConsumer::InlineAsmDiagHandler2(const llvm::SMDiagnostic &D,
287                                             SourceLocation LocCookie) {
288   // There are a couple of different kinds of errors we could get here.  First,
289   // we re-format the SMDiagnostic in terms of a clang diagnostic.
290 
291   // Strip "error: " off the start of the message string.
292   StringRef Message = D.getMessage();
293   if (Message.startswith("error: "))
294     Message = Message.substr(7);
295 
296   // If the SMDiagnostic has an inline asm source location, translate it.
297   FullSourceLoc Loc;
298   if (D.getLoc() != SMLoc())
299     Loc = ConvertBackendLocation(D, Context->getSourceManager());
300 
301   unsigned DiagID;
302   switch (D.getKind()) {
303   case llvm::SourceMgr::DK_Error:
304     DiagID = diag::err_fe_inline_asm;
305     break;
306   case llvm::SourceMgr::DK_Warning:
307     DiagID = diag::warn_fe_inline_asm;
308     break;
309   case llvm::SourceMgr::DK_Note:
310     DiagID = diag::note_fe_inline_asm;
311     break;
312   }
313   // If this problem has clang-level source location information, report the
314   // issue in the source with a note showing the instantiated
315   // code.
316   if (LocCookie.isValid()) {
317     Diags.Report(LocCookie, DiagID).AddString(Message);
318 
319     if (D.getLoc().isValid()) {
320       DiagnosticBuilder B = Diags.Report(Loc, diag::note_fe_inline_asm_here);
321       // Convert the SMDiagnostic ranges into SourceRange and attach them
322       // to the diagnostic.
323       for (unsigned i = 0, e = D.getRanges().size(); i != e; ++i) {
324         std::pair<unsigned, unsigned> Range = D.getRanges()[i];
325         unsigned Column = D.getColumnNo();
326         B << SourceRange(Loc.getLocWithOffset(Range.first - Column),
327                          Loc.getLocWithOffset(Range.second - Column));
328       }
329     }
330     return;
331   }
332 
333   // Otherwise, report the backend issue as occurring in the generated .s file.
334   // If Loc is invalid, we still need to report the issue, it just gets no
335   // location info.
336   Diags.Report(Loc, DiagID).AddString(Message);
337 }
338 
339 #define ComputeDiagID(Severity, GroupName, DiagID)                             \
340   do {                                                                         \
341     switch (Severity) {                                                        \
342     case llvm::DS_Error:                                                       \
343       DiagID = diag::err_fe_##GroupName;                                       \
344       break;                                                                   \
345     case llvm::DS_Warning:                                                     \
346       DiagID = diag::warn_fe_##GroupName;                                      \
347       break;                                                                   \
348     case llvm::DS_Remark:                                                      \
349       llvm_unreachable("'remark' severity not expected");                      \
350       break;                                                                   \
351     case llvm::DS_Note:                                                        \
352       DiagID = diag::note_fe_##GroupName;                                      \
353       break;                                                                   \
354     }                                                                          \
355   } while (false)
356 
357 #define ComputeDiagRemarkID(Severity, GroupName, DiagID)                       \
358   do {                                                                         \
359     switch (Severity) {                                                        \
360     case llvm::DS_Error:                                                       \
361       DiagID = diag::err_fe_##GroupName;                                       \
362       break;                                                                   \
363     case llvm::DS_Warning:                                                     \
364       DiagID = diag::warn_fe_##GroupName;                                      \
365       break;                                                                   \
366     case llvm::DS_Remark:                                                      \
367       DiagID = diag::remark_fe_##GroupName;                                    \
368       break;                                                                   \
369     case llvm::DS_Note:                                                        \
370       DiagID = diag::note_fe_##GroupName;                                      \
371       break;                                                                   \
372     }                                                                          \
373   } while (false)
374 
375 bool
376 BackendConsumer::InlineAsmDiagHandler(const llvm::DiagnosticInfoInlineAsm &D) {
377   unsigned DiagID;
378   ComputeDiagID(D.getSeverity(), inline_asm, DiagID);
379   std::string Message = D.getMsgStr().str();
380 
381   // If this problem has clang-level source location information, report the
382   // issue as being a problem in the source with a note showing the instantiated
383   // code.
384   SourceLocation LocCookie =
385       SourceLocation::getFromRawEncoding(D.getLocCookie());
386   if (LocCookie.isValid())
387     Diags.Report(LocCookie, DiagID).AddString(Message);
388   else {
389     // Otherwise, report the backend diagnostic as occurring in the generated
390     // .s file.
391     // If Loc is invalid, we still need to report the diagnostic, it just gets
392     // no location info.
393     FullSourceLoc Loc;
394     Diags.Report(Loc, DiagID).AddString(Message);
395   }
396   // We handled all the possible severities.
397   return true;
398 }
399 
400 bool
401 BackendConsumer::StackSizeDiagHandler(const llvm::DiagnosticInfoStackSize &D) {
402   if (D.getSeverity() != llvm::DS_Warning)
403     // For now, the only support we have for StackSize diagnostic is warning.
404     // We do not know how to format other severities.
405     return false;
406 
407   if (const Decl *ND = Gen->GetDeclForMangledName(D.getFunction().getName())) {
408     Diags.Report(ND->getASTContext().getFullLoc(ND->getLocation()),
409                  diag::warn_fe_frame_larger_than)
410         << D.getStackSize() << Decl::castToDeclContext(ND);
411     return true;
412   }
413 
414   return false;
415 }
416 
417 void BackendConsumer::EmitOptimizationRemark(
418     const llvm::DiagnosticInfoOptimizationRemarkBase &D, unsigned DiagID) {
419   // We only support remarks.
420   assert(D.getSeverity() == llvm::DS_Remark);
421 
422   SourceManager &SourceMgr = Context->getSourceManager();
423   FileManager &FileMgr = SourceMgr.getFileManager();
424   StringRef Filename;
425   unsigned Line, Column;
426   D.getLocation(&Filename, &Line, &Column);
427   SourceLocation DILoc;
428   const FileEntry *FE = FileMgr.getFile(Filename);
429   if (FE && Line > 0) {
430     // If -gcolumn-info was not used, Column will be 0. This upsets the
431     // source manager, so pass 1 if Column is not set.
432     DILoc = SourceMgr.translateFileLineCol(FE, Line, Column ? Column : 1);
433   }
434 
435   // If a location isn't available, try to approximate it using the associated
436   // function definition. We use the definition's right brace to differentiate
437   // from diagnostics that genuinely relate to the function itself.
438   FullSourceLoc Loc(DILoc, SourceMgr);
439   if (Loc.isInvalid())
440     if (const Decl *FD = Gen->GetDeclForMangledName(D.getFunction().getName()))
441       Loc = FD->getASTContext().getFullLoc(FD->getBodyRBrace());
442 
443   Diags.Report(Loc, DiagID) << AddFlagValue(D.getPassName())
444                             << D.getMsg().str();
445 
446   if (Line == 0)
447     // If we could not extract a source location for the diagnostic,
448     // inform the user how they can get source locations back.
449     //
450     // FIXME: We should really be generating !srcloc annotations when
451     // -Rpass is used. !srcloc annotations need to be emitted in
452     // approximately the same spots as !dbg nodes.
453     Diags.Report(Loc, diag::note_fe_backend_optimization_remark_missing_loc);
454   else if (DILoc.isInvalid())
455     // If we were not able to translate the file:line:col information
456     // back to a SourceLocation, at least emit a note stating that
457     // we could not translate this location. This can happen in the
458     // case of #line directives.
459     Diags.Report(Loc, diag::note_fe_backend_optimization_remark_invalid_loc)
460         << Filename << Line << Column;
461 }
462 
463 void BackendConsumer::OptimizationRemarkHandler(
464     const llvm::DiagnosticInfoOptimizationRemark &D) {
465   // Optimization remarks are active only if the -Rpass flag has a regular
466   // expression that matches the name of the pass name in \p D.
467   if (CodeGenOpts.OptimizationRemarkPattern &&
468       CodeGenOpts.OptimizationRemarkPattern->match(D.getPassName()))
469     EmitOptimizationRemark(D, diag::remark_fe_backend_optimization_remark);
470 }
471 
472 void BackendConsumer::OptimizationRemarkHandler(
473     const llvm::DiagnosticInfoOptimizationRemarkMissed &D) {
474   // Missed optimization remarks are active only if the -Rpass-missed
475   // flag has a regular expression that matches the name of the pass
476   // name in \p D.
477   if (CodeGenOpts.OptimizationRemarkMissedPattern &&
478       CodeGenOpts.OptimizationRemarkMissedPattern->match(D.getPassName()))
479     EmitOptimizationRemark(D,
480                            diag::remark_fe_backend_optimization_remark_missed);
481 }
482 
483 void BackendConsumer::OptimizationRemarkHandler(
484     const llvm::DiagnosticInfoOptimizationRemarkAnalysis &D) {
485   // Optimization analysis remarks are active only if the -Rpass-analysis
486   // flag has a regular expression that matches the name of the pass
487   // name in \p D.
488   if (CodeGenOpts.OptimizationRemarkAnalysisPattern &&
489       CodeGenOpts.OptimizationRemarkAnalysisPattern->match(D.getPassName()))
490     EmitOptimizationRemark(
491         D, diag::remark_fe_backend_optimization_remark_analysis);
492 }
493 
494 /// \brief This function is invoked when the backend needs
495 /// to report something to the user.
496 void BackendConsumer::DiagnosticHandlerImpl(const DiagnosticInfo &DI) {
497   unsigned DiagID = diag::err_fe_inline_asm;
498   llvm::DiagnosticSeverity Severity = DI.getSeverity();
499   // Get the diagnostic ID based.
500   switch (DI.getKind()) {
501   case llvm::DK_InlineAsm:
502     if (InlineAsmDiagHandler(cast<DiagnosticInfoInlineAsm>(DI)))
503       return;
504     ComputeDiagID(Severity, inline_asm, DiagID);
505     break;
506   case llvm::DK_StackSize:
507     if (StackSizeDiagHandler(cast<DiagnosticInfoStackSize>(DI)))
508       return;
509     ComputeDiagID(Severity, backend_frame_larger_than, DiagID);
510     break;
511   case llvm::DK_OptimizationRemark:
512     // Optimization remarks are always handled completely by this
513     // handler. There is no generic way of emitting them.
514     OptimizationRemarkHandler(cast<DiagnosticInfoOptimizationRemark>(DI));
515     return;
516   case llvm::DK_OptimizationRemarkMissed:
517     // Optimization remarks are always handled completely by this
518     // handler. There is no generic way of emitting them.
519     OptimizationRemarkHandler(cast<DiagnosticInfoOptimizationRemarkMissed>(DI));
520     return;
521   case llvm::DK_OptimizationRemarkAnalysis:
522     // Optimization remarks are always handled completely by this
523     // handler. There is no generic way of emitting them.
524     OptimizationRemarkHandler(
525         cast<DiagnosticInfoOptimizationRemarkAnalysis>(DI));
526     return;
527   default:
528     // Plugin IDs are not bound to any value as they are set dynamically.
529     ComputeDiagRemarkID(Severity, backend_plugin, DiagID);
530     break;
531   }
532   std::string MsgStorage;
533   {
534     raw_string_ostream Stream(MsgStorage);
535     DiagnosticPrinterRawOStream DP(Stream);
536     DI.print(DP);
537   }
538 
539   // Report the backend message using the usual diagnostic mechanism.
540   FullSourceLoc Loc;
541   Diags.Report(Loc, DiagID).AddString(MsgStorage);
542 }
543 #undef ComputeDiagID
544 
545 CodeGenAction::CodeGenAction(unsigned _Act, LLVMContext *_VMContext)
546   : Act(_Act), LinkModule(nullptr),
547     VMContext(_VMContext ? _VMContext : new LLVMContext),
548     OwnsVMContext(!_VMContext) {}
549 
550 CodeGenAction::~CodeGenAction() {
551   TheModule.reset();
552   if (OwnsVMContext)
553     delete VMContext;
554 }
555 
556 bool CodeGenAction::hasIRSupport() const { return true; }
557 
558 void CodeGenAction::EndSourceFileAction() {
559   // If the consumer creation failed, do nothing.
560   if (!getCompilerInstance().hasASTConsumer())
561     return;
562 
563   // If we were given a link module, release consumer's ownership of it.
564   if (LinkModule)
565     BEConsumer->takeLinkModule();
566 
567   // Steal the module from the consumer.
568   TheModule.reset(BEConsumer->takeModule());
569 }
570 
571 llvm::Module *CodeGenAction::takeModule() { return TheModule.release(); }
572 
573 llvm::LLVMContext *CodeGenAction::takeLLVMContext() {
574   OwnsVMContext = false;
575   return VMContext;
576 }
577 
578 static raw_ostream *GetOutputStream(CompilerInstance &CI,
579                                     StringRef InFile,
580                                     BackendAction Action) {
581   switch (Action) {
582   case Backend_EmitAssembly:
583     return CI.createDefaultOutputFile(false, InFile, "s");
584   case Backend_EmitLL:
585     return CI.createDefaultOutputFile(false, InFile, "ll");
586   case Backend_EmitBC:
587     return CI.createDefaultOutputFile(true, InFile, "bc");
588   case Backend_EmitNothing:
589     return nullptr;
590   case Backend_EmitMCNull:
591     return CI.createNullOutputFile();
592   case Backend_EmitObj:
593     return CI.createDefaultOutputFile(true, InFile, "o");
594   }
595 
596   llvm_unreachable("Invalid action!");
597 }
598 
599 ASTConsumer *CodeGenAction::CreateASTConsumer(CompilerInstance &CI,
600                                               StringRef InFile) {
601   BackendAction BA = static_cast<BackendAction>(Act);
602   std::unique_ptr<raw_ostream> OS(GetOutputStream(CI, InFile, BA));
603   if (BA != Backend_EmitNothing && !OS)
604     return nullptr;
605 
606   llvm::Module *LinkModuleToUse = LinkModule;
607 
608   // If we were not given a link module, and the user requested that one be
609   // loaded from bitcode, do so now.
610   const std::string &LinkBCFile = CI.getCodeGenOpts().LinkBitcodeFile;
611   if (!LinkModuleToUse && !LinkBCFile.empty()) {
612     std::string ErrorStr;
613 
614     llvm::MemoryBuffer *BCBuf =
615       CI.getFileManager().getBufferForFile(LinkBCFile, &ErrorStr);
616     if (!BCBuf) {
617       CI.getDiagnostics().Report(diag::err_cannot_open_file)
618         << LinkBCFile << ErrorStr;
619       return nullptr;
620     }
621 
622     ErrorOr<llvm::Module *> ModuleOrErr =
623         getLazyBitcodeModule(BCBuf, *VMContext);
624     if (std::error_code EC = ModuleOrErr.getError()) {
625       CI.getDiagnostics().Report(diag::err_cannot_open_file)
626         << LinkBCFile << EC.message();
627       return nullptr;
628     }
629     LinkModuleToUse = ModuleOrErr.get();
630   }
631 
632   BEConsumer = new BackendConsumer(BA, CI.getDiagnostics(), CI.getCodeGenOpts(),
633                                    CI.getTargetOpts(), CI.getLangOpts(),
634                                    CI.getFrontendOpts().ShowTimers, InFile,
635                                    LinkModuleToUse, OS.release(), *VMContext);
636   return BEConsumer;
637 }
638 
639 void CodeGenAction::ExecuteAction() {
640   // If this is an IR file, we have to treat it specially.
641   if (getCurrentFileKind() == IK_LLVM_IR) {
642     BackendAction BA = static_cast<BackendAction>(Act);
643     CompilerInstance &CI = getCompilerInstance();
644     raw_ostream *OS = GetOutputStream(CI, getCurrentFile(), BA);
645     if (BA != Backend_EmitNothing && !OS)
646       return;
647 
648     bool Invalid;
649     SourceManager &SM = CI.getSourceManager();
650     const llvm::MemoryBuffer *MainFile = SM.getBuffer(SM.getMainFileID(),
651                                                       &Invalid);
652     if (Invalid)
653       return;
654 
655     // FIXME: This is stupid, IRReader shouldn't take ownership.
656     llvm::MemoryBuffer *MainFileCopy =
657       llvm::MemoryBuffer::getMemBufferCopy(MainFile->getBuffer(),
658                                            getCurrentFile());
659 
660     llvm::SMDiagnostic Err;
661     TheModule.reset(ParseIR(MainFileCopy, Err, *VMContext));
662     if (!TheModule) {
663       // Translate from the diagnostic info to the SourceManager location.
664       SourceLocation Loc = SM.translateFileLineCol(
665         SM.getFileEntryForID(SM.getMainFileID()), Err.getLineNo(),
666         Err.getColumnNo() + 1);
667 
668       // Strip off a leading diagnostic code if there is one.
669       StringRef Msg = Err.getMessage();
670       if (Msg.startswith("error: "))
671         Msg = Msg.substr(7);
672 
673       unsigned DiagID =
674           CI.getDiagnostics().getCustomDiagID(DiagnosticsEngine::Error, "%0");
675 
676       CI.getDiagnostics().Report(Loc, DiagID) << Msg;
677       return;
678     }
679     const TargetOptions &TargetOpts = CI.getTargetOpts();
680     if (TheModule->getTargetTriple() != TargetOpts.Triple) {
681       unsigned DiagID = CI.getDiagnostics().getCustomDiagID(
682           DiagnosticsEngine::Warning,
683           "overriding the module target triple with %0");
684 
685       CI.getDiagnostics().Report(SourceLocation(), DiagID) << TargetOpts.Triple;
686       TheModule->setTargetTriple(TargetOpts.Triple);
687     }
688 
689     EmitBackendOutput(CI.getDiagnostics(), CI.getCodeGenOpts(), TargetOpts,
690                       CI.getLangOpts(), CI.getTarget().getTargetDescription(),
691                       TheModule.get(), BA, OS);
692     return;
693   }
694 
695   // Otherwise follow the normal AST path.
696   this->ASTFrontendAction::ExecuteAction();
697 }
698 
699 //
700 
701 void EmitAssemblyAction::anchor() { }
702 EmitAssemblyAction::EmitAssemblyAction(llvm::LLVMContext *_VMContext)
703   : CodeGenAction(Backend_EmitAssembly, _VMContext) {}
704 
705 void EmitBCAction::anchor() { }
706 EmitBCAction::EmitBCAction(llvm::LLVMContext *_VMContext)
707   : CodeGenAction(Backend_EmitBC, _VMContext) {}
708 
709 void EmitLLVMAction::anchor() { }
710 EmitLLVMAction::EmitLLVMAction(llvm::LLVMContext *_VMContext)
711   : CodeGenAction(Backend_EmitLL, _VMContext) {}
712 
713 void EmitLLVMOnlyAction::anchor() { }
714 EmitLLVMOnlyAction::EmitLLVMOnlyAction(llvm::LLVMContext *_VMContext)
715   : CodeGenAction(Backend_EmitNothing, _VMContext) {}
716 
717 void EmitCodeGenOnlyAction::anchor() { }
718 EmitCodeGenOnlyAction::EmitCodeGenOnlyAction(llvm::LLVMContext *_VMContext)
719   : CodeGenAction(Backend_EmitMCNull, _VMContext) {}
720 
721 void EmitObjAction::anchor() { }
722 EmitObjAction::EmitObjAction(llvm::LLVMContext *_VMContext)
723   : CodeGenAction(Backend_EmitObj, _VMContext) {}
724