blob: be4ec5b123208635d7e05ae5b9656a9e61c65386 [file] [log] [blame]
Daniel Dunbar02bd2d72009-11-14 10:42:46 +00001//===--- FrontendActions.cpp ----------------------------------------------===//
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/Frontend/FrontendActions.h"
11#include "clang/AST/ASTConsumer.h"
12#include "clang/Basic/FileManager.h"
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000013#include "clang/Frontend/ASTConsumers.h"
14#include "clang/Frontend/ASTUnit.h"
15#include "clang/Frontend/CompilerInstance.h"
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000016#include "clang/Frontend/FrontendDiagnostic.h"
Adrian Prantlbb165fb2015-06-20 18:53:08 +000017#include "clang/Frontend/MultiplexConsumer.h"
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000018#include "clang/Frontend/Utils.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000019#include "clang/Lex/HeaderSearch.h"
20#include "clang/Lex/Pragma.h"
21#include "clang/Lex/Preprocessor.h"
22#include "clang/Parse/Parser.h"
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +000023#include "clang/Serialization/ASTReader.h"
Sebastian Redl1914c6f2010-08-18 23:56:37 +000024#include "clang/Serialization/ASTWriter.h"
Douglas Gregor524e33e2011-12-08 19:11:24 +000025#include "llvm/Support/FileSystem.h"
Douglas Gregoraf82e352010-07-20 20:18:03 +000026#include "llvm/Support/MemoryBuffer.h"
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000027#include "llvm/Support/raw_ostream.h"
Ahmed Charlesdfca6f92014-03-09 11:36:40 +000028#include <memory>
Rafael Espindola8a8e5542014-06-12 17:19:42 +000029#include <system_error>
Douglas Gregor52da28b2011-09-23 23:43:36 +000030
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000031using namespace clang;
32
Daniel Dunbar88357802009-11-14 10:42:57 +000033//===----------------------------------------------------------------------===//
Daniel Dunbar1c201fb2010-03-19 19:44:04 +000034// Custom Actions
35//===----------------------------------------------------------------------===//
36
David Blaikie6beb6aa2014-08-10 19:56:51 +000037std::unique_ptr<ASTConsumer>
38InitOnlyAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
39 return llvm::make_unique<ASTConsumer>();
Daniel Dunbar1c201fb2010-03-19 19:44:04 +000040}
41
42void InitOnlyAction::ExecuteAction() {
43}
44
45//===----------------------------------------------------------------------===//
Daniel Dunbar88357802009-11-14 10:42:57 +000046// AST Consumer Actions
47//===----------------------------------------------------------------------===//
48
David Blaikie6beb6aa2014-08-10 19:56:51 +000049std::unique_ptr<ASTConsumer>
50ASTPrintAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +000051 if (raw_ostream *OS = CI.createDefaultOutputFile(false, InFile))
Alexander Kornienko3db68ee2012-07-26 16:01:23 +000052 return CreateASTPrinter(OS, CI.getFrontendOpts().ASTDumpFilter);
Craig Topper49a27902014-05-22 04:46:25 +000053 return nullptr;
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000054}
55
David Blaikie6beb6aa2014-08-10 19:56:51 +000056std::unique_ptr<ASTConsumer>
57ASTDumpAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
Richard Smith6ea05822013-06-24 01:45:33 +000058 return CreateASTDumper(CI.getFrontendOpts().ASTDumpFilter,
Richard Smith35f986d2014-08-11 22:11:07 +000059 CI.getFrontendOpts().ASTDumpDecls,
Richard Smith6ea05822013-06-24 01:45:33 +000060 CI.getFrontendOpts().ASTDumpLookups);
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000061}
62
David Blaikie6beb6aa2014-08-10 19:56:51 +000063std::unique_ptr<ASTConsumer>
64ASTDeclListAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
Alexander Kornienko4de03592012-07-31 09:37:40 +000065 return CreateASTDeclNodeLister();
66}
67
David Blaikie6beb6aa2014-08-10 19:56:51 +000068std::unique_ptr<ASTConsumer>
69ASTViewAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000070 return CreateASTViewer();
71}
72
David Blaikie6beb6aa2014-08-10 19:56:51 +000073std::unique_ptr<ASTConsumer>
74DeclContextPrintAction::CreateASTConsumer(CompilerInstance &CI,
75 StringRef InFile) {
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000076 return CreateDeclContextPrinter();
77}
78
David Blaikie6beb6aa2014-08-10 19:56:51 +000079std::unique_ptr<ASTConsumer>
80GeneratePCHAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
Douglas Gregor48c8cd32010-08-03 08:14:03 +000081 std::string Sysroot;
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +000082 std::string OutputFile;
Adrian Prantlbb165fb2015-06-20 18:53:08 +000083 raw_pwrite_stream *OS =
Rafael Espindola47de1492015-04-10 12:54:53 +000084 ComputeASTConsumerArguments(CI, InFile, Sysroot, OutputFile);
85 if (!OS)
Craig Topper49a27902014-05-22 04:46:25 +000086 return nullptr;
Douglas Gregor48c8cd32010-08-03 08:14:03 +000087
Douglas Gregorc567ba22011-07-22 16:35:34 +000088 if (!CI.getFrontendOpts().RelocatablePCH)
89 Sysroot.clear();
Adrian Prantlbb165fb2015-06-20 18:53:08 +000090
91 auto Buffer = std::make_shared<PCHBuffer>();
92 std::vector<std::unique_ptr<ASTConsumer>> Consumers;
93 Consumers.push_back(llvm::make_unique<PCHGenerator>(
94 CI.getPreprocessor(), OutputFile, nullptr, Sysroot, Buffer));
Adrian Prantl03914062015-09-18 22:10:59 +000095 Consumers.push_back(CI.getPCHContainerWriter().CreatePCHContainerGenerator(
96 CI.getDiagnostics(), CI, InFile, OutputFile, OS, Buffer));
Adrian Prantlbb165fb2015-06-20 18:53:08 +000097
98 return llvm::make_unique<MultiplexConsumer>(std::move(Consumers));
Douglas Gregor48c8cd32010-08-03 08:14:03 +000099}
100
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000101raw_pwrite_stream *GeneratePCHAction::ComputeASTConsumerArguments(
Rafael Espindola47de1492015-04-10 12:54:53 +0000102 CompilerInstance &CI, StringRef InFile, std::string &Sysroot,
103 std::string &OutputFile) {
Douglas Gregor48c8cd32010-08-03 08:14:03 +0000104 Sysroot = CI.getHeaderSearchOpts().Sysroot;
105 if (CI.getFrontendOpts().RelocatablePCH && Sysroot.empty()) {
Sebastian Redlea68af42010-08-17 17:55:38 +0000106 CI.getDiagnostics().Report(diag::err_relocatable_without_isysroot);
Rafael Espindola47de1492015-04-10 12:54:53 +0000107 return nullptr;
Daniel Dunbar02bd2d72009-11-14 10:42:46 +0000108 }
109
Daniel Dunbara2867c72011-01-31 22:00:44 +0000110 // We use createOutputFile here because this is exposed via libclang, and we
111 // must disable the RemoveFileOnSignal behavior.
Argyrios Kyrtzidis08a2bfd2011-07-28 00:45:10 +0000112 // We use a temporary to avoid race conditions.
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000113 raw_pwrite_stream *OS =
Rafael Espindola47de1492015-04-10 12:54:53 +0000114 CI.createOutputFile(CI.getFrontendOpts().OutputFile, /*Binary=*/true,
115 /*RemoveFileOnSignal=*/false, InFile,
116 /*Extension=*/"", /*useTemporary=*/true);
Daniel Dunbar75546992009-12-03 09:13:30 +0000117 if (!OS)
Rafael Espindola47de1492015-04-10 12:54:53 +0000118 return nullptr;
Daniel Dunbar75546992009-12-03 09:13:30 +0000119
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +0000120 OutputFile = CI.getFrontendOpts().OutputFile;
Rafael Espindola47de1492015-04-10 12:54:53 +0000121 return OS;
Daniel Dunbar02bd2d72009-11-14 10:42:46 +0000122}
123
David Blaikie6beb6aa2014-08-10 19:56:51 +0000124std::unique_ptr<ASTConsumer>
125GenerateModuleAction::CreateASTConsumer(CompilerInstance &CI,
126 StringRef InFile) {
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000127 std::string Sysroot;
128 std::string OutputFile;
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000129 raw_pwrite_stream *OS =
Rafael Espindolabfd25d42015-04-10 13:14:31 +0000130 ComputeASTConsumerArguments(CI, InFile, Sysroot, OutputFile);
131 if (!OS)
Craig Topper49a27902014-05-22 04:46:25 +0000132 return nullptr;
133
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000134 auto Buffer = std::make_shared<PCHBuffer>();
135 std::vector<std::unique_ptr<ASTConsumer>> Consumers;
136 Consumers.push_back(llvm::make_unique<PCHGenerator>(
Richard Smithe75ee0f2015-08-17 07:13:32 +0000137 CI.getPreprocessor(), OutputFile, Module, Sysroot, Buffer,
138 /*AllowASTWithErrors*/false,
139 /*IncludeTimestamps*/+CI.getFrontendOpts().BuildingImplicitModule));
Adrian Prantl03914062015-09-18 22:10:59 +0000140 Consumers.push_back(CI.getPCHContainerWriter().CreatePCHContainerGenerator(
141 CI.getDiagnostics(), CI, InFile, OutputFile, OS, Buffer));
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000142 return llvm::make_unique<MultiplexConsumer>(std::move(Consumers));
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000143}
144
Argyrios Kyrtzidis130190f2012-10-10 02:12:39 +0000145static SmallVectorImpl<char> &
146operator+=(SmallVectorImpl<char> &Includes, StringRef RHS) {
147 Includes.append(RHS.begin(), RHS.end());
148 return Includes;
149}
150
Rafael Espindolac0809172014-06-12 14:02:15 +0000151static std::error_code addHeaderInclude(StringRef HeaderName,
152 SmallVectorImpl<char> &Includes,
153 const LangOptions &LangOpts,
154 bool IsExternC) {
Richard Smith9bca2982014-03-08 00:03:56 +0000155 if (IsExternC && LangOpts.CPlusPlus)
Richard Smith77944862014-03-02 05:58:18 +0000156 Includes += "extern \"C\" {\n";
Argyrios Kyrtzidis130190f2012-10-10 02:12:39 +0000157 if (LangOpts.ObjC1)
158 Includes += "#import \"";
159 else
160 Includes += "#include \"";
Richard Smith3c1a41a2014-12-02 00:08:08 +0000161
162 Includes += HeaderName;
163
Argyrios Kyrtzidis130190f2012-10-10 02:12:39 +0000164 Includes += "\"\n";
Richard Smith9bca2982014-03-08 00:03:56 +0000165 if (IsExternC && LangOpts.CPlusPlus)
Richard Smith77944862014-03-02 05:58:18 +0000166 Includes += "}\n";
Rafael Espindolac0809172014-06-12 14:02:15 +0000167 return std::error_code();
Argyrios Kyrtzidis130190f2012-10-10 02:12:39 +0000168}
169
Douglas Gregor4332b322011-11-16 17:04:00 +0000170/// \brief Collect the set of header includes needed to construct the given
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +0000171/// module and update the TopHeaders file set of the module.
Douglas Gregor4332b322011-11-16 17:04:00 +0000172///
173/// \param Module The module we're collecting includes from.
Douglas Gregore5626c42011-12-06 17:15:11 +0000174///
James Dennettc423c532012-06-15 21:48:19 +0000175/// \param Includes Will be augmented with the set of \#includes or \#imports
Douglas Gregore5626c42011-12-06 17:15:11 +0000176/// needed to load all of the named headers.
Rafael Espindolac0809172014-06-12 14:02:15 +0000177static std::error_code
Richard Smith723928c2014-03-11 02:02:47 +0000178collectModuleHeaderIncludes(const LangOptions &LangOpts, FileManager &FileMgr,
179 ModuleMap &ModMap, clang::Module *Module,
180 SmallVectorImpl<char> &Includes) {
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +0000181 // Don't collect any headers for unavailable modules.
182 if (!Module->isAvailable())
Rafael Espindolac0809172014-06-12 14:02:15 +0000183 return std::error_code();
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +0000184
Douglas Gregore5626c42011-12-06 17:15:11 +0000185 // Add includes for each of these headers.
Richard Smith3c1a41a2014-12-02 00:08:08 +0000186 for (Module::Header &H : Module->Headers[Module::HK_Normal]) {
187 Module->addTopHeader(H.Entry);
188 // Use the path as specified in the module map file. We'll look for this
189 // file relative to the module build directory (the directory containing
190 // the module map file) so this will find the same file that we found
191 // while parsing the module map.
192 if (std::error_code Err = addHeaderInclude(H.NameAsWritten, Includes,
193 LangOpts, Module->IsExternC))
Richard Smith723928c2014-03-11 02:02:47 +0000194 return Err;
Douglas Gregor3ec66632012-02-02 18:42:48 +0000195 }
Lawrence Crowlb53e5482013-06-20 21:14:14 +0000196 // Note that Module->PrivateHeaders will not be a TopHeader.
Douglas Gregore5626c42011-12-06 17:15:11 +0000197
Richard Smith2b63d152015-05-16 02:28:53 +0000198 if (Module::Header UmbrellaHeader = Module->getUmbrellaHeader()) {
199 Module->addTopHeader(UmbrellaHeader.Entry);
Douglas Gregor3ec66632012-02-02 18:42:48 +0000200 if (Module->Parent) {
201 // Include the umbrella header for submodules.
Richard Smith2b63d152015-05-16 02:28:53 +0000202 if (std::error_code Err = addHeaderInclude(UmbrellaHeader.NameAsWritten,
203 Includes, LangOpts,
204 Module->IsExternC))
Richard Smith723928c2014-03-11 02:02:47 +0000205 return Err;
Douglas Gregor3ec66632012-02-02 18:42:48 +0000206 }
Richard Smith2b63d152015-05-16 02:28:53 +0000207 } else if (Module::DirectoryName UmbrellaDir = Module->getUmbrellaDir()) {
Douglas Gregord2a8fe12012-01-05 00:04:05 +0000208 // Add all of the headers we find in this subdirectory.
Rafael Espindolac0809172014-06-12 14:02:15 +0000209 std::error_code EC;
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000210 SmallString<128> DirNative;
Richard Smith2b63d152015-05-16 02:28:53 +0000211 llvm::sys::path::native(UmbrellaDir.Entry->getName(), DirNative);
Yaron Keren92e1b622015-03-18 10:17:07 +0000212 for (llvm::sys::fs::recursive_directory_iterator Dir(DirNative, EC),
Douglas Gregorc1aaf8c2011-12-12 19:13:53 +0000213 DirEnd;
Douglas Gregor524e33e2011-12-08 19:11:24 +0000214 Dir != DirEnd && !EC; Dir.increment(EC)) {
215 // Check whether this entry has an extension typically associated with
216 // headers.
217 if (!llvm::StringSwitch<bool>(llvm::sys::path::extension(Dir->path()))
218 .Cases(".h", ".H", ".hh", ".hpp", true)
219 .Default(false))
220 continue;
Richard Smith3c1a41a2014-12-02 00:08:08 +0000221
222 const FileEntry *Header = FileMgr.getFile(Dir->path());
223 // FIXME: This shouldn't happen unless there is a file system race. Is
224 // that worth diagnosing?
225 if (!Header)
226 continue;
227
Douglas Gregord2a8fe12012-01-05 00:04:05 +0000228 // If this header is marked 'unavailable' in this module, don't include
229 // it.
Richard Smith3c1a41a2014-12-02 00:08:08 +0000230 if (ModMap.isHeaderUnavailableInModule(Header, Module))
231 continue;
232
Richard Smith2b63d152015-05-16 02:28:53 +0000233 // Compute the relative path from the directory to this file.
234 SmallVector<StringRef, 16> Components;
235 auto PathIt = llvm::sys::path::rbegin(Dir->path());
236 for (int I = 0; I != Dir.level() + 1; ++I, ++PathIt)
237 Components.push_back(*PathIt);
238 SmallString<128> RelativeHeader(UmbrellaDir.NameAsWritten);
239 for (auto It = Components.rbegin(), End = Components.rend(); It != End;
240 ++It)
241 llvm::sys::path::append(RelativeHeader, *It);
242
Richard Smith723928c2014-03-11 02:02:47 +0000243 // Include this header as part of the umbrella directory.
Richard Smith3c1a41a2014-12-02 00:08:08 +0000244 Module->addTopHeader(Header);
Richard Smith2b63d152015-05-16 02:28:53 +0000245 if (std::error_code Err = addHeaderInclude(RelativeHeader, Includes,
246 LangOpts, Module->IsExternC))
Richard Smith723928c2014-03-11 02:02:47 +0000247 return Err;
Douglas Gregor524e33e2011-12-08 19:11:24 +0000248 }
Richard Smith723928c2014-03-11 02:02:47 +0000249
250 if (EC)
251 return EC;
Douglas Gregor4332b322011-11-16 17:04:00 +0000252 }
Richard Smith3c1a41a2014-12-02 00:08:08 +0000253
Douglas Gregor4332b322011-11-16 17:04:00 +0000254 // Recurse into submodules.
Douglas Gregoreb90e832012-01-04 23:32:19 +0000255 for (clang::Module::submodule_iterator Sub = Module->submodule_begin(),
256 SubEnd = Module->submodule_end();
Douglas Gregore5626c42011-12-06 17:15:11 +0000257 Sub != SubEnd; ++Sub)
Rafael Espindolac0809172014-06-12 14:02:15 +0000258 if (std::error_code Err = collectModuleHeaderIncludes(
Richard Smith723928c2014-03-11 02:02:47 +0000259 LangOpts, FileMgr, ModMap, *Sub, Includes))
260 return Err;
261
Rafael Espindolac0809172014-06-12 14:02:15 +0000262 return std::error_code();
Douglas Gregor4332b322011-11-16 17:04:00 +0000263}
264
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000265bool GenerateModuleAction::BeginSourceFileAction(CompilerInstance &CI,
266 StringRef Filename) {
Richard Smithfb1e7f72015-08-14 05:02:58 +0000267 // Find the module map file.
268 const FileEntry *ModuleMap =
269 CI.getFileManager().getFile(Filename, /*openFile*/true);
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000270 if (!ModuleMap) {
271 CI.getDiagnostics().Report(diag::err_module_map_not_found)
272 << Filename;
273 return false;
274 }
275
276 // Parse the module map file.
277 HeaderSearch &HS = CI.getPreprocessor().getHeaderSearchInfo();
Douglas Gregor963c5532013-06-21 16:28:10 +0000278 if (HS.loadModuleMapFile(ModuleMap, IsSystem))
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000279 return false;
280
281 if (CI.getLangOpts().CurrentModule.empty()) {
282 CI.getDiagnostics().Report(diag::err_missing_module_name);
283
284 // FIXME: Eventually, we could consider asking whether there was just
285 // a single module described in the module map, and use that as a
286 // default. Then it would be fairly trivial to just "compile" a module
287 // map with a single module (the common case).
288 return false;
289 }
Richard Smith7bea1d42014-03-05 20:55:36 +0000290
Richard Smithfb1e7f72015-08-14 05:02:58 +0000291 // Set up embedding for any specified files.
292 for (const auto &F : CI.getFrontendOpts().ModulesEmbedFiles) {
293 if (const auto *FE = CI.getFileManager().getFile(F, /*openFile*/true))
294 CI.getSourceManager().embedFileContentsInModule(FE);
295 else
296 CI.getDiagnostics().Report(diag::err_modules_embed_file_not_found) << F;
297 }
298
Richard Smith7bea1d42014-03-05 20:55:36 +0000299 // If we're being run from the command-line, the module build stack will not
300 // have been filled in yet, so complete it now in order to allow us to detect
301 // module cycles.
302 SourceManager &SourceMgr = CI.getSourceManager();
303 if (SourceMgr.getModuleBuildStack().empty())
304 SourceMgr.pushModuleBuildStack(CI.getLangOpts().CurrentModule,
305 FullSourceLoc(SourceLocation(), SourceMgr));
306
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000307 // Dig out the module definition.
Douglas Gregor279a6c32012-01-29 17:08:11 +0000308 Module = HS.lookupModule(CI.getLangOpts().CurrentModule,
309 /*AllowSearch=*/false);
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000310 if (!Module) {
311 CI.getDiagnostics().Report(diag::err_missing_module)
312 << CI.getLangOpts().CurrentModule << Filename;
313
314 return false;
315 }
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +0000316
317 // Check whether we can build this module at all.
Richard Smitha3feee22013-10-28 22:18:19 +0000318 clang::Module::Requirement Requirement;
Richard Smith3c1a41a2014-12-02 00:08:08 +0000319 clang::Module::UnresolvedHeaderDirective MissingHeader;
Daniel Jasper0761a8a2013-12-17 10:31:37 +0000320 if (!Module->isAvailable(CI.getLangOpts(), CI.getTarget(), Requirement,
321 MissingHeader)) {
322 if (MissingHeader.FileNameLoc.isValid()) {
Ben Langmuirec8c9752014-04-18 22:07:31 +0000323 CI.getDiagnostics().Report(MissingHeader.FileNameLoc,
324 diag::err_module_header_missing)
Daniel Jasper0761a8a2013-12-17 10:31:37 +0000325 << MissingHeader.IsUmbrella << MissingHeader.FileName;
326 } else {
327 CI.getDiagnostics().Report(diag::err_module_unavailable)
328 << Module->getFullModuleName()
329 << Requirement.second << Requirement.first;
330 }
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +0000331
332 return false;
333 }
334
Ben Langmuir9d6448b2014-08-09 00:57:23 +0000335 if (ModuleMapForUniquing && ModuleMapForUniquing != ModuleMap) {
336 Module->IsInferred = true;
337 HS.getModuleMap().setInferredModuleAllowedBy(Module, ModuleMapForUniquing);
338 } else {
Ben Langmuirbeee15e2014-04-14 18:00:01 +0000339 ModuleMapForUniquing = ModuleMap;
Ben Langmuir9d6448b2014-08-09 00:57:23 +0000340 }
Ben Langmuirbeee15e2014-04-14 18:00:01 +0000341
Argyrios Kyrtzidis130190f2012-10-10 02:12:39 +0000342 FileManager &FileMgr = CI.getFileManager();
343
Douglas Gregor4332b322011-11-16 17:04:00 +0000344 // Collect the set of #includes we need to build the module.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000345 SmallString<256> HeaderContents;
Rafael Espindola8e650d72014-06-12 20:37:59 +0000346 std::error_code Err = std::error_code();
Richard Smith2b63d152015-05-16 02:28:53 +0000347 if (Module::Header UmbrellaHeader = Module->getUmbrellaHeader())
348 Err = addHeaderInclude(UmbrellaHeader.NameAsWritten, HeaderContents,
349 CI.getLangOpts(), Module->IsExternC);
Richard Smith723928c2014-03-11 02:02:47 +0000350 if (!Err)
351 Err = collectModuleHeaderIncludes(
352 CI.getLangOpts(), FileMgr,
353 CI.getPreprocessor().getHeaderSearchInfo().getModuleMap(), Module,
354 HeaderContents);
355
356 if (Err) {
357 CI.getDiagnostics().Report(diag::err_module_cannot_create_includes)
358 << Module->getFullModuleName() << Err.message();
359 return false;
360 }
Douglas Gregor4332b322011-11-16 17:04:00 +0000361
Richard Smith3c1a41a2014-12-02 00:08:08 +0000362 // Inform the preprocessor that includes from within the input buffer should
363 // be resolved relative to the build directory of the module map file.
364 CI.getPreprocessor().setMainFileDir(Module->Directory);
365
Rafael Espindolad87f8d72014-08-27 20:03:29 +0000366 std::unique_ptr<llvm::MemoryBuffer> InputBuffer =
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +0000367 llvm::MemoryBuffer::getMemBufferCopy(HeaderContents,
368 Module::getModuleInputBufferName());
Alp Tokerf6a24ce2013-12-05 16:25:25 +0000369 // Ownership of InputBuffer will be transferred to the SourceManager.
Rafael Espindolad87f8d72014-08-27 20:03:29 +0000370 setCurrentInput(FrontendInputFile(InputBuffer.release(), getCurrentFileKind(),
Douglas Gregora686e1b2012-01-27 19:52:33 +0000371 Module->IsSystem));
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000372 return true;
373}
374
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000375raw_pwrite_stream *GenerateModuleAction::ComputeASTConsumerArguments(
Rafael Espindolabfd25d42015-04-10 13:14:31 +0000376 CompilerInstance &CI, StringRef InFile, std::string &Sysroot,
377 std::string &OutputFile) {
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000378 // If no output file was provided, figure out where this module would go
379 // in the module cache.
380 if (CI.getFrontendOpts().OutputFile.empty()) {
381 HeaderSearch &HS = CI.getPreprocessor().getHeaderSearchInfo();
Ben Langmuirbeee15e2014-04-14 18:00:01 +0000382 CI.getFrontendOpts().OutputFile =
383 HS.getModuleFileName(CI.getLangOpts().CurrentModule,
Ben Langmuird89dc562015-02-19 20:23:22 +0000384 ModuleMapForUniquing->getName());
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000385 }
Rafael Espindolabfd25d42015-04-10 13:14:31 +0000386
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000387 // We use createOutputFile here because this is exposed via libclang, and we
388 // must disable the RemoveFileOnSignal behavior.
389 // We use a temporary to avoid race conditions.
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000390 raw_pwrite_stream *OS =
Rafael Espindolabfd25d42015-04-10 13:14:31 +0000391 CI.createOutputFile(CI.getFrontendOpts().OutputFile, /*Binary=*/true,
392 /*RemoveFileOnSignal=*/false, InFile,
393 /*Extension=*/"", /*useTemporary=*/true,
394 /*CreateMissingDirectories=*/true);
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000395 if (!OS)
Rafael Espindolabfd25d42015-04-10 13:14:31 +0000396 return nullptr;
397
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000398 OutputFile = CI.getFrontendOpts().OutputFile;
Rafael Espindolabfd25d42015-04-10 13:14:31 +0000399 return OS;
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000400}
401
David Blaikie6beb6aa2014-08-10 19:56:51 +0000402std::unique_ptr<ASTConsumer>
403SyntaxOnlyAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
404 return llvm::make_unique<ASTConsumer>();
Daniel Dunbar02bd2d72009-11-14 10:42:46 +0000405}
406
David Blaikie6beb6aa2014-08-10 19:56:51 +0000407std::unique_ptr<ASTConsumer>
408DumpModuleInfoAction::CreateASTConsumer(CompilerInstance &CI,
409 StringRef InFile) {
410 return llvm::make_unique<ASTConsumer>();
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000411}
412
David Blaikie6beb6aa2014-08-10 19:56:51 +0000413std::unique_ptr<ASTConsumer>
414VerifyPCHAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
415 return llvm::make_unique<ASTConsumer>();
Ben Langmuir2cb4a782014-02-05 22:21:15 +0000416}
417
418void VerifyPCHAction::ExecuteAction() {
Ben Langmuir3d4417c2014-02-07 17:31:11 +0000419 CompilerInstance &CI = getCompilerInstance();
420 bool Preamble = CI.getPreprocessorOpts().PrecompiledPreambleBytes.first != 0;
421 const std::string &Sysroot = CI.getHeaderSearchOpts().Sysroot;
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000422 std::unique_ptr<ASTReader> Reader(new ASTReader(
Adrian Prantlfb2398d2015-07-17 01:19:54 +0000423 CI.getPreprocessor(), CI.getASTContext(), CI.getPCHContainerReader(),
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000424 Sysroot.empty() ? "" : Sysroot.c_str(),
425 /*DisableValidation*/ false,
426 /*AllowPCHWithCompilerErrors*/ false,
427 /*AllowConfigurationMismatch*/ true,
428 /*ValidateSystemInputs*/ true));
Ben Langmuir3d4417c2014-02-07 17:31:11 +0000429
430 Reader->ReadAST(getCurrentFile(),
431 Preamble ? serialization::MK_Preamble
432 : serialization::MK_PCH,
433 SourceLocation(),
434 ASTReader::ARR_ConfigurationMismatch);
Ben Langmuir2cb4a782014-02-05 22:21:15 +0000435}
436
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000437namespace {
438 /// \brief AST reader listener that dumps module information for a module
439 /// file.
440 class DumpModuleInfoListener : public ASTReaderListener {
441 llvm::raw_ostream &Out;
442
443 public:
444 DumpModuleInfoListener(llvm::raw_ostream &Out) : Out(Out) { }
445
446#define DUMP_BOOLEAN(Value, Text) \
447 Out.indent(4) << Text << ": " << (Value? "Yes" : "No") << "\n"
448
Craig Topperafa7cb32014-03-13 06:07:04 +0000449 bool ReadFullVersionInformation(StringRef FullVersion) override {
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000450 Out.indent(2)
451 << "Generated by "
452 << (FullVersion == getClangFullRepositoryVersion()? "this"
453 : "a different")
454 << " Clang: " << FullVersion << "\n";
455 return ASTReaderListener::ReadFullVersionInformation(FullVersion);
456 }
457
Ben Langmuir4f5212a2014-04-14 22:12:44 +0000458 void ReadModuleName(StringRef ModuleName) override {
459 Out.indent(2) << "Module name: " << ModuleName << "\n";
460 }
461 void ReadModuleMapFile(StringRef ModuleMapPath) override {
462 Out.indent(2) << "Module map file: " << ModuleMapPath << "\n";
463 }
464
Richard Smith1e2cf0d2014-10-31 02:28:58 +0000465 bool ReadLanguageOptions(const LangOptions &LangOpts, bool Complain,
466 bool AllowCompatibleDifferences) override {
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000467 Out.indent(2) << "Language options:\n";
468#define LANGOPT(Name, Bits, Default, Description) \
469 DUMP_BOOLEAN(LangOpts.Name, Description);
470#define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
471 Out.indent(4) << Description << ": " \
472 << static_cast<unsigned>(LangOpts.get##Name()) << "\n";
473#define VALUE_LANGOPT(Name, Bits, Default, Description) \
474 Out.indent(4) << Description << ": " << LangOpts.Name << "\n";
475#define BENIGN_LANGOPT(Name, Bits, Default, Description)
476#define BENIGN_ENUM_LANGOPT(Name, Type, Bits, Default, Description)
477#include "clang/Basic/LangOptions.def"
Ben Langmuircd98cb72015-06-23 18:20:18 +0000478
479 if (!LangOpts.ModuleFeatures.empty()) {
480 Out.indent(4) << "Module features:\n";
481 for (StringRef Feature : LangOpts.ModuleFeatures)
482 Out.indent(6) << Feature << "\n";
483 }
484
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000485 return false;
486 }
487
Chandler Carruth0d745bc2015-03-14 04:47:43 +0000488 bool ReadTargetOptions(const TargetOptions &TargetOpts, bool Complain,
489 bool AllowCompatibleDifferences) override {
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000490 Out.indent(2) << "Target options:\n";
491 Out.indent(4) << " Triple: " << TargetOpts.Triple << "\n";
492 Out.indent(4) << " CPU: " << TargetOpts.CPU << "\n";
493 Out.indent(4) << " ABI: " << TargetOpts.ABI << "\n";
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000494
495 if (!TargetOpts.FeaturesAsWritten.empty()) {
496 Out.indent(4) << "Target features:\n";
497 for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size();
498 I != N; ++I) {
499 Out.indent(6) << TargetOpts.FeaturesAsWritten[I] << "\n";
500 }
501 }
502
503 return false;
504 }
505
Alexander Kornienko34eb2072015-04-11 02:00:23 +0000506 bool ReadDiagnosticOptions(IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts,
507 bool Complain) override {
Ben Langmuirb92de022014-04-29 16:25:26 +0000508 Out.indent(2) << "Diagnostic options:\n";
509#define DIAGOPT(Name, Bits, Default) DUMP_BOOLEAN(DiagOpts->Name, #Name);
510#define ENUM_DIAGOPT(Name, Type, Bits, Default) \
511 Out.indent(4) << #Name << ": " << DiagOpts->get##Name() << "\n";
512#define VALUE_DIAGOPT(Name, Bits, Default) \
513 Out.indent(4) << #Name << ": " << DiagOpts->Name << "\n";
514#include "clang/Basic/DiagnosticOptions.def"
515
Richard Smith3be1cb22014-08-07 00:24:21 +0000516 Out.indent(4) << "Diagnostic flags:\n";
517 for (const std::string &Warning : DiagOpts->Warnings)
Ben Langmuirb92de022014-04-29 16:25:26 +0000518 Out.indent(6) << "-W" << Warning << "\n";
Richard Smith3be1cb22014-08-07 00:24:21 +0000519 for (const std::string &Remark : DiagOpts->Remarks)
520 Out.indent(6) << "-R" << Remark << "\n";
Ben Langmuirb92de022014-04-29 16:25:26 +0000521
522 return false;
523 }
524
Craig Topperafa7cb32014-03-13 06:07:04 +0000525 bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +0000526 StringRef SpecificModuleCachePath,
Craig Topperafa7cb32014-03-13 06:07:04 +0000527 bool Complain) override {
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000528 Out.indent(2) << "Header search options:\n";
529 Out.indent(4) << "System root [-isysroot=]: '" << HSOpts.Sysroot << "'\n";
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +0000530 Out.indent(4) << "Module Cache: '" << SpecificModuleCachePath << "'\n";
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000531 DUMP_BOOLEAN(HSOpts.UseBuiltinIncludes,
532 "Use builtin include directories [-nobuiltininc]");
533 DUMP_BOOLEAN(HSOpts.UseStandardSystemIncludes,
534 "Use standard system include directories [-nostdinc]");
535 DUMP_BOOLEAN(HSOpts.UseStandardCXXIncludes,
536 "Use standard C++ include directories [-nostdinc++]");
537 DUMP_BOOLEAN(HSOpts.UseLibcxx,
538 "Use libc++ (rather than libstdc++) [-stdlib=]");
539 return false;
540 }
541
Craig Topperafa7cb32014-03-13 06:07:04 +0000542 bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts,
543 bool Complain,
544 std::string &SuggestedPredefines) override {
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000545 Out.indent(2) << "Preprocessor options:\n";
546 DUMP_BOOLEAN(PPOpts.UsePredefines,
547 "Uses compiler/target-specific predefines [-undef]");
548 DUMP_BOOLEAN(PPOpts.DetailedRecord,
549 "Uses detailed preprocessing record (for indexing)");
550
551 if (!PPOpts.Macros.empty()) {
552 Out.indent(4) << "Predefined macros:\n";
553 }
554
555 for (std::vector<std::pair<std::string, bool/*isUndef*/> >::const_iterator
556 I = PPOpts.Macros.begin(), IEnd = PPOpts.Macros.end();
557 I != IEnd; ++I) {
558 Out.indent(6);
559 if (I->second)
560 Out << "-U";
561 else
562 Out << "-D";
563 Out << I->first << "\n";
564 }
565 return false;
566 }
567#undef DUMP_BOOLEAN
568 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000569}
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000570
571void DumpModuleInfoAction::ExecuteAction() {
572 // Set up the output file.
Ahmed Charlesb8984322014-03-07 20:03:18 +0000573 std::unique_ptr<llvm::raw_fd_ostream> OutFile;
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000574 StringRef OutputFileName = getCompilerInstance().getFrontendOpts().OutputFile;
575 if (!OutputFileName.empty() && OutputFileName != "-") {
Rafael Espindoladae941a2014-08-25 18:17:04 +0000576 std::error_code EC;
577 OutFile.reset(new llvm::raw_fd_ostream(OutputFileName.str(), EC,
578 llvm::sys::fs::F_Text));
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000579 }
580 llvm::raw_ostream &Out = OutFile.get()? *OutFile.get() : llvm::outs();
581
582 Out << "Information for module file '" << getCurrentFile() << "':\n";
583 DumpModuleInfoListener Listener(Out);
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000584 ASTReader::readASTFileControlBlock(
585 getCurrentFile(), getCompilerInstance().getFileManager(),
Adrian Prantlfb2398d2015-07-17 01:19:54 +0000586 getCompilerInstance().getPCHContainerReader(), Listener);
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000587}
588
Daniel Dunbar88357802009-11-14 10:42:57 +0000589//===----------------------------------------------------------------------===//
590// Preprocessor Actions
591//===----------------------------------------------------------------------===//
592
593void DumpRawTokensAction::ExecuteAction() {
594 Preprocessor &PP = getCompilerInstance().getPreprocessor();
595 SourceManager &SM = PP.getSourceManager();
596
597 // Start lexing the specified input file.
Chris Lattner710bb872009-11-30 04:18:44 +0000598 const llvm::MemoryBuffer *FromFile = SM.getBuffer(SM.getMainFileID());
David Blaikiebbafb8a2012-03-11 07:00:24 +0000599 Lexer RawLex(SM.getMainFileID(), FromFile, SM, PP.getLangOpts());
Daniel Dunbar88357802009-11-14 10:42:57 +0000600 RawLex.SetKeepWhitespaceMode(true);
601
602 Token RawTok;
603 RawLex.LexFromRawLexer(RawTok);
604 while (RawTok.isNot(tok::eof)) {
605 PP.DumpToken(RawTok, true);
Daniel Dunbar75024622009-11-25 10:27:48 +0000606 llvm::errs() << "\n";
Daniel Dunbar88357802009-11-14 10:42:57 +0000607 RawLex.LexFromRawLexer(RawTok);
608 }
609}
610
611void DumpTokensAction::ExecuteAction() {
612 Preprocessor &PP = getCompilerInstance().getPreprocessor();
613 // Start preprocessing the specified input file.
614 Token Tok;
Chris Lattnerfb24a3a2010-04-20 20:35:58 +0000615 PP.EnterMainSourceFile();
Daniel Dunbar88357802009-11-14 10:42:57 +0000616 do {
617 PP.Lex(Tok);
618 PP.DumpToken(Tok, true);
Daniel Dunbar75024622009-11-25 10:27:48 +0000619 llvm::errs() << "\n";
Daniel Dunbar88357802009-11-14 10:42:57 +0000620 } while (Tok.isNot(tok::eof));
621}
622
623void GeneratePTHAction::ExecuteAction() {
624 CompilerInstance &CI = getCompilerInstance();
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000625 raw_pwrite_stream *OS = CI.createDefaultOutputFile(true, getCurrentFile());
NAKAMURA Takumi5594d792015-04-13 08:43:40 +0000626 if (!OS)
627 return;
Daniel Dunbar75546992009-12-03 09:13:30 +0000628
Daniel Dunbar88357802009-11-14 10:42:57 +0000629 CacheTokens(CI.getPreprocessor(), OS);
630}
631
Daniel Dunbar88357802009-11-14 10:42:57 +0000632void PreprocessOnlyAction::ExecuteAction() {
633 Preprocessor &PP = getCompilerInstance().getPreprocessor();
634
Daniel Dunbard839e772010-06-11 20:10:12 +0000635 // Ignore unknown pragmas.
Lubos Lunak576a0412014-05-01 12:54:03 +0000636 PP.IgnorePragmas();
Daniel Dunbard839e772010-06-11 20:10:12 +0000637
Daniel Dunbar88357802009-11-14 10:42:57 +0000638 Token Tok;
639 // Start parsing the specified input file.
Chris Lattnerfb24a3a2010-04-20 20:35:58 +0000640 PP.EnterMainSourceFile();
Daniel Dunbar88357802009-11-14 10:42:57 +0000641 do {
642 PP.Lex(Tok);
643 } while (Tok.isNot(tok::eof));
644}
645
Daniel Dunbar88357802009-11-14 10:42:57 +0000646void PrintPreprocessedAction::ExecuteAction() {
647 CompilerInstance &CI = getCompilerInstance();
Douglas Gregor52da28b2011-09-23 23:43:36 +0000648 // Output file may need to be set to 'Binary', to avoid converting Unix style
Steve Naroff3d38a682010-01-05 17:33:23 +0000649 // line feeds (<LF>) to Microsoft style line feeds (<CR><LF>).
Douglas Gregor52da28b2011-09-23 23:43:36 +0000650 //
651 // Look to see what type of line endings the file uses. If there's a
652 // CRLF, then we won't open the file up in binary mode. If there is
653 // just an LF or CR, then we will open the file up in binary mode.
654 // In this fashion, the output format should match the input format, unless
655 // the input format has inconsistent line endings.
656 //
657 // This should be a relatively fast operation since most files won't have
658 // all of their source code on a single line. However, that is still a
659 // concern, so if we scan for too long, we'll just assume the file should
660 // be opened in binary mode.
661 bool BinaryMode = true;
662 bool InvalidFile = false;
663 const SourceManager& SM = CI.getSourceManager();
664 const llvm::MemoryBuffer *Buffer = SM.getBuffer(SM.getMainFileID(),
665 &InvalidFile);
666 if (!InvalidFile) {
667 const char *cur = Buffer->getBufferStart();
668 const char *end = Buffer->getBufferEnd();
669 const char *next = (cur != end) ? cur + 1 : end;
670
671 // Limit ourselves to only scanning 256 characters into the source
672 // file. This is mostly a sanity check in case the file has no
673 // newlines whatsoever.
674 if (end - cur > 256) end = cur + 256;
675
676 while (next < end) {
677 if (*cur == 0x0D) { // CR
678 if (*next == 0x0A) // CRLF
679 BinaryMode = false;
680
681 break;
682 } else if (*cur == 0x0A) // LF
683 break;
684
685 ++cur, ++next;
686 }
687 }
688
689 raw_ostream *OS = CI.createDefaultOutputFile(BinaryMode, getCurrentFile());
Daniel Dunbar75546992009-12-03 09:13:30 +0000690 if (!OS) return;
691
Daniel Dunbar88357802009-11-14 10:42:57 +0000692 DoPrintPreprocessedInput(CI.getPreprocessor(), OS,
693 CI.getPreprocessorOutputOpts());
694}
Douglas Gregoraf82e352010-07-20 20:18:03 +0000695
696void PrintPreambleAction::ExecuteAction() {
697 switch (getCurrentFileKind()) {
698 case IK_C:
699 case IK_CXX:
700 case IK_ObjC:
701 case IK_ObjCXX:
702 case IK_OpenCL:
Peter Collingbourne62089b82010-12-01 03:15:20 +0000703 case IK_CUDA:
Douglas Gregoraf82e352010-07-20 20:18:03 +0000704 break;
705
706 case IK_None:
707 case IK_Asm:
708 case IK_PreprocessedC:
Artem Belevich83a6dcc2015-03-19 17:32:06 +0000709 case IK_PreprocessedCuda:
Douglas Gregoraf82e352010-07-20 20:18:03 +0000710 case IK_PreprocessedCXX:
711 case IK_PreprocessedObjC:
712 case IK_PreprocessedObjCXX:
713 case IK_AST:
714 case IK_LLVM_IR:
715 // We can't do anything with these.
716 return;
717 }
Rafael Espindola6406f7b2014-08-26 19:54:40 +0000718
Argyrios Kyrtzidis71731d62010-11-03 22:45:23 +0000719 CompilerInstance &CI = getCompilerInstance();
Benjamin Kramera8857962014-10-26 22:44:13 +0000720 auto Buffer = CI.getFileManager().getBufferForFile(getCurrentFile());
721 if (Buffer) {
Rafael Espindolacd0b3802014-08-12 15:46:24 +0000722 unsigned Preamble =
Benjamin Kramera8857962014-10-26 22:44:13 +0000723 Lexer::ComputePreamble((*Buffer)->getBuffer(), CI.getLangOpts()).first;
724 llvm::outs().write((*Buffer)->getBufferStart(), Preamble);
Douglas Gregoraf82e352010-07-20 20:18:03 +0000725 }
726}