1 //===-- cc1_main.cpp - Clang CC1 Compiler Frontend ------------------------===//
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 // This is the entry point to the clang -cc1 functionality, which implements the
11 // core compiler functionality along with a number of additional tools for
12 // demonstration and testing purposes.
13 //
14 //===----------------------------------------------------------------------===//
15 
16 #include "clang/Driver/Arg.h"
17 #include "clang/Driver/ArgList.h"
18 #include "clang/Driver/CC1Options.h"
19 #include "clang/Driver/DriverDiagnostic.h"
20 #include "clang/Driver/OptTable.h"
21 #include "clang/Frontend/CompilerInstance.h"
22 #include "clang/Frontend/CompilerInvocation.h"
23 #include "clang/Frontend/FrontendDiagnostic.h"
24 #include "clang/Frontend/TextDiagnosticBuffer.h"
25 #include "clang/Frontend/TextDiagnosticPrinter.h"
26 #include "clang/FrontendTool/Utils.h"
27 #include "llvm/ADT/Statistic.h"
28 #include "llvm/Support/ErrorHandling.h"
29 #include "llvm/Support/ManagedStatic.h"
30 #include "llvm/Support/TargetSelect.h"
31 #include "llvm/Support/Timer.h"
32 #include "llvm/Support/raw_ostream.h"
33 #include "llvm/LinkAllPasses.h"
34 #include <cstdio>
35 using namespace clang;
36 
37 //===----------------------------------------------------------------------===//
38 // Main driver
39 //===----------------------------------------------------------------------===//
40 
41 static void LLVMErrorHandler(void *UserData, const std::string &Message) {
42   DiagnosticsEngine &Diags = *static_cast<DiagnosticsEngine*>(UserData);
43 
44   Diags.Report(diag::err_fe_error_backend) << Message;
45 
46   // We cannot recover from llvm errors.
47   exit(1);
48 }
49 
50 // FIXME: Define the need for this testing away.
51 static int cc1_test(DiagnosticsEngine &Diags,
52                     const char **ArgBegin, const char **ArgEnd) {
53   using namespace clang::driver;
54 
55   llvm::errs() << "cc1 argv:";
56   for (const char **i = ArgBegin; i != ArgEnd; ++i)
57     llvm::errs() << " \"" << *i << '"';
58   llvm::errs() << "\n";
59 
60   // Parse the arguments.
61   OptTable *Opts = createCC1OptTable();
62   unsigned MissingArgIndex, MissingArgCount;
63   InputArgList *Args = Opts->ParseArgs(ArgBegin, ArgEnd,
64                                        MissingArgIndex, MissingArgCount);
65 
66   // Check for missing argument error.
67   if (MissingArgCount)
68     Diags.Report(clang::diag::err_drv_missing_argument)
69       << Args->getArgString(MissingArgIndex) << MissingArgCount;
70 
71   // Dump the parsed arguments.
72   llvm::errs() << "cc1 parsed options:\n";
73   for (ArgList::const_iterator it = Args->begin(), ie = Args->end();
74        it != ie; ++it)
75     (*it)->dump();
76 
77   // Create a compiler invocation.
78   llvm::errs() << "cc1 creating invocation.\n";
79   CompilerInvocation Invocation;
80   CompilerInvocation::CreateFromArgs(Invocation, ArgBegin, ArgEnd, Diags);
81 
82   // Convert the invocation back to argument strings.
83   std::vector<std::string> InvocationArgs;
84   Invocation.toArgs(InvocationArgs);
85 
86   // Dump the converted arguments.
87   SmallVector<const char*, 32> Invocation2Args;
88   llvm::errs() << "invocation argv :";
89   for (unsigned i = 0, e = InvocationArgs.size(); i != e; ++i) {
90     Invocation2Args.push_back(InvocationArgs[i].c_str());
91     llvm::errs() << " \"" << InvocationArgs[i] << '"';
92   }
93   llvm::errs() << "\n";
94 
95   // Convert those arguments to another invocation, and check that we got the
96   // same thing.
97   CompilerInvocation Invocation2;
98   CompilerInvocation::CreateFromArgs(Invocation2, Invocation2Args.begin(),
99                                      Invocation2Args.end(), Diags);
100 
101   // FIXME: Implement CompilerInvocation comparison.
102   if (true) {
103     //llvm::errs() << "warning: Invocations differ!\n";
104 
105     std::vector<std::string> Invocation2Args;
106     Invocation2.toArgs(Invocation2Args);
107     llvm::errs() << "invocation2 argv:";
108     for (unsigned i = 0, e = Invocation2Args.size(); i != e; ++i)
109       llvm::errs() << " \"" << Invocation2Args[i] << '"';
110     llvm::errs() << "\n";
111   }
112 
113   return 0;
114 }
115 
116 int cc1_main(const char **ArgBegin, const char **ArgEnd,
117              const char *Argv0, void *MainAddr) {
118   llvm::OwningPtr<CompilerInstance> Clang(new CompilerInstance());
119   llvm::IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
120 
121   // Run clang -cc1 test.
122   if (ArgBegin != ArgEnd && StringRef(ArgBegin[0]) == "-cc1test") {
123     DiagnosticsEngine Diags(DiagID, new TextDiagnosticPrinter(llvm::errs(),
124                                                        DiagnosticOptions()));
125     return cc1_test(Diags, ArgBegin + 1, ArgEnd);
126   }
127 
128   // Initialize targets first, so that --version shows registered targets.
129   llvm::InitializeAllTargets();
130   llvm::InitializeAllTargetMCs();
131   llvm::InitializeAllAsmPrinters();
132   llvm::InitializeAllAsmParsers();
133 
134   // Buffer diagnostics from argument parsing so that we can output them using a
135   // well formed diagnostic object.
136   TextDiagnosticBuffer *DiagsBuffer = new TextDiagnosticBuffer;
137   DiagnosticsEngine Diags(DiagID, DiagsBuffer);
138   CompilerInvocation::CreateFromArgs(Clang->getInvocation(), ArgBegin, ArgEnd,
139                                      Diags);
140 
141   // Infer the builtin include path if unspecified.
142   if (Clang->getHeaderSearchOpts().UseBuiltinIncludes &&
143       Clang->getHeaderSearchOpts().ResourceDir.empty())
144     Clang->getHeaderSearchOpts().ResourceDir =
145       CompilerInvocation::GetResourcesPath(Argv0, MainAddr);
146 
147   // Create the actual diagnostics engine.
148   Clang->createDiagnostics(ArgEnd - ArgBegin, const_cast<char**>(ArgBegin));
149   if (!Clang->hasDiagnostics())
150     return 1;
151 
152   // Set an error handler, so that any LLVM backend diagnostics go through our
153   // error handler.
154   llvm::install_fatal_error_handler(LLVMErrorHandler,
155                                   static_cast<void*>(&Clang->getDiagnostics()));
156 
157   DiagsBuffer->FlushDiagnostics(Clang->getDiagnostics());
158 
159   // Execute the frontend actions.
160   bool Success = ExecuteCompilerInvocation(Clang.get());
161 
162   // If any timers were active but haven't been destroyed yet, print their
163   // results now.  This happens in -disable-free mode.
164   llvm::TimerGroup::printAll(llvm::errs());
165 
166   // Our error handler depends on the Diagnostics object, which we're
167   // potentially about to delete. Uninstall the handler now so that any
168   // later errors use the default handling behavior instead.
169   llvm::remove_fatal_error_handler();
170 
171   // When running with -disable-free, don't do any destruction or shutdown.
172   if (Clang->getFrontendOpts().DisableFree) {
173     if (llvm::AreStatisticsEnabled() || Clang->getFrontendOpts().ShowStats)
174       llvm::PrintStatistics();
175     Clang.take();
176     return !Success;
177   }
178 
179   // Managed static deconstruction. Useful for making things like
180   // -time-passes usable.
181   llvm::llvm_shutdown();
182 
183   return !Success;
184 }
185