blob: 782b713d3e2c41bfeb943edd23d85b43b626a442 [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));
95 Consumers.push_back(
Adrian Prantlfb2398d2015-07-17 01:19:54 +000096 CI.getPCHContainerWriter().CreatePCHContainerGenerator(
Adrian Prantlbb165fb2015-06-20 18:53:08 +000097 CI.getDiagnostics(), CI.getHeaderSearchOpts(),
98 CI.getPreprocessorOpts(), CI.getTargetOpts(), CI.getLangOpts(),
99 InFile, OutputFile, OS, Buffer));
100
101 return llvm::make_unique<MultiplexConsumer>(std::move(Consumers));
Douglas Gregor48c8cd32010-08-03 08:14:03 +0000102}
103
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000104raw_pwrite_stream *GeneratePCHAction::ComputeASTConsumerArguments(
Rafael Espindola47de1492015-04-10 12:54:53 +0000105 CompilerInstance &CI, StringRef InFile, std::string &Sysroot,
106 std::string &OutputFile) {
Douglas Gregor48c8cd32010-08-03 08:14:03 +0000107 Sysroot = CI.getHeaderSearchOpts().Sysroot;
108 if (CI.getFrontendOpts().RelocatablePCH && Sysroot.empty()) {
Sebastian Redlea68af42010-08-17 17:55:38 +0000109 CI.getDiagnostics().Report(diag::err_relocatable_without_isysroot);
Rafael Espindola47de1492015-04-10 12:54:53 +0000110 return nullptr;
Daniel Dunbar02bd2d72009-11-14 10:42:46 +0000111 }
112
Daniel Dunbara2867c72011-01-31 22:00:44 +0000113 // We use createOutputFile here because this is exposed via libclang, and we
114 // must disable the RemoveFileOnSignal behavior.
Argyrios Kyrtzidis08a2bfd2011-07-28 00:45:10 +0000115 // We use a temporary to avoid race conditions.
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000116 raw_pwrite_stream *OS =
Rafael Espindola47de1492015-04-10 12:54:53 +0000117 CI.createOutputFile(CI.getFrontendOpts().OutputFile, /*Binary=*/true,
118 /*RemoveFileOnSignal=*/false, InFile,
119 /*Extension=*/"", /*useTemporary=*/true);
Daniel Dunbar75546992009-12-03 09:13:30 +0000120 if (!OS)
Rafael Espindola47de1492015-04-10 12:54:53 +0000121 return nullptr;
Daniel Dunbar75546992009-12-03 09:13:30 +0000122
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +0000123 OutputFile = CI.getFrontendOpts().OutputFile;
Rafael Espindola47de1492015-04-10 12:54:53 +0000124 return OS;
Daniel Dunbar02bd2d72009-11-14 10:42:46 +0000125}
126
David Blaikie6beb6aa2014-08-10 19:56:51 +0000127std::unique_ptr<ASTConsumer>
128GenerateModuleAction::CreateASTConsumer(CompilerInstance &CI,
129 StringRef InFile) {
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000130 std::string Sysroot;
131 std::string OutputFile;
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000132 raw_pwrite_stream *OS =
Rafael Espindolabfd25d42015-04-10 13:14:31 +0000133 ComputeASTConsumerArguments(CI, InFile, Sysroot, OutputFile);
134 if (!OS)
Craig Topper49a27902014-05-22 04:46:25 +0000135 return nullptr;
136
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000137 auto Buffer = std::make_shared<PCHBuffer>();
138 std::vector<std::unique_ptr<ASTConsumer>> Consumers;
139 Consumers.push_back(llvm::make_unique<PCHGenerator>(
Richard Smithe75ee0f2015-08-17 07:13:32 +0000140 CI.getPreprocessor(), OutputFile, Module, Sysroot, Buffer,
141 /*AllowASTWithErrors*/false,
142 /*IncludeTimestamps*/+CI.getFrontendOpts().BuildingImplicitModule));
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000143 Consumers.push_back(
Adrian Prantlfb2398d2015-07-17 01:19:54 +0000144 CI.getPCHContainerWriter().CreatePCHContainerGenerator(
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000145 CI.getDiagnostics(), CI.getHeaderSearchOpts(),
146 CI.getPreprocessorOpts(), CI.getTargetOpts(), CI.getLangOpts(),
147 InFile, OutputFile, OS, Buffer));
148 return llvm::make_unique<MultiplexConsumer>(std::move(Consumers));
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000149}
150
Argyrios Kyrtzidis130190f2012-10-10 02:12:39 +0000151static SmallVectorImpl<char> &
152operator+=(SmallVectorImpl<char> &Includes, StringRef RHS) {
153 Includes.append(RHS.begin(), RHS.end());
154 return Includes;
155}
156
Rafael Espindolac0809172014-06-12 14:02:15 +0000157static std::error_code addHeaderInclude(StringRef HeaderName,
158 SmallVectorImpl<char> &Includes,
159 const LangOptions &LangOpts,
160 bool IsExternC) {
Richard Smith9bca2982014-03-08 00:03:56 +0000161 if (IsExternC && LangOpts.CPlusPlus)
Richard Smith77944862014-03-02 05:58:18 +0000162 Includes += "extern \"C\" {\n";
Argyrios Kyrtzidis130190f2012-10-10 02:12:39 +0000163 if (LangOpts.ObjC1)
164 Includes += "#import \"";
165 else
166 Includes += "#include \"";
Richard Smith3c1a41a2014-12-02 00:08:08 +0000167
168 Includes += HeaderName;
169
Argyrios Kyrtzidis130190f2012-10-10 02:12:39 +0000170 Includes += "\"\n";
Richard Smith9bca2982014-03-08 00:03:56 +0000171 if (IsExternC && LangOpts.CPlusPlus)
Richard Smith77944862014-03-02 05:58:18 +0000172 Includes += "}\n";
Rafael Espindolac0809172014-06-12 14:02:15 +0000173 return std::error_code();
Argyrios Kyrtzidis130190f2012-10-10 02:12:39 +0000174}
175
Douglas Gregor4332b322011-11-16 17:04:00 +0000176/// \brief Collect the set of header includes needed to construct the given
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +0000177/// module and update the TopHeaders file set of the module.
Douglas Gregor4332b322011-11-16 17:04:00 +0000178///
179/// \param Module The module we're collecting includes from.
Douglas Gregore5626c42011-12-06 17:15:11 +0000180///
James Dennettc423c532012-06-15 21:48:19 +0000181/// \param Includes Will be augmented with the set of \#includes or \#imports
Douglas Gregore5626c42011-12-06 17:15:11 +0000182/// needed to load all of the named headers.
Rafael Espindolac0809172014-06-12 14:02:15 +0000183static std::error_code
Richard Smith723928c2014-03-11 02:02:47 +0000184collectModuleHeaderIncludes(const LangOptions &LangOpts, FileManager &FileMgr,
185 ModuleMap &ModMap, clang::Module *Module,
186 SmallVectorImpl<char> &Includes) {
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +0000187 // Don't collect any headers for unavailable modules.
188 if (!Module->isAvailable())
Rafael Espindolac0809172014-06-12 14:02:15 +0000189 return std::error_code();
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +0000190
Douglas Gregore5626c42011-12-06 17:15:11 +0000191 // Add includes for each of these headers.
Richard Smith3c1a41a2014-12-02 00:08:08 +0000192 for (Module::Header &H : Module->Headers[Module::HK_Normal]) {
193 Module->addTopHeader(H.Entry);
194 // Use the path as specified in the module map file. We'll look for this
195 // file relative to the module build directory (the directory containing
196 // the module map file) so this will find the same file that we found
197 // while parsing the module map.
198 if (std::error_code Err = addHeaderInclude(H.NameAsWritten, Includes,
199 LangOpts, Module->IsExternC))
Richard Smith723928c2014-03-11 02:02:47 +0000200 return Err;
Douglas Gregor3ec66632012-02-02 18:42:48 +0000201 }
Lawrence Crowlb53e5482013-06-20 21:14:14 +0000202 // Note that Module->PrivateHeaders will not be a TopHeader.
Douglas Gregore5626c42011-12-06 17:15:11 +0000203
Richard Smith2b63d152015-05-16 02:28:53 +0000204 if (Module::Header UmbrellaHeader = Module->getUmbrellaHeader()) {
205 Module->addTopHeader(UmbrellaHeader.Entry);
Douglas Gregor3ec66632012-02-02 18:42:48 +0000206 if (Module->Parent) {
207 // Include the umbrella header for submodules.
Richard Smith2b63d152015-05-16 02:28:53 +0000208 if (std::error_code Err = addHeaderInclude(UmbrellaHeader.NameAsWritten,
209 Includes, LangOpts,
210 Module->IsExternC))
Richard Smith723928c2014-03-11 02:02:47 +0000211 return Err;
Douglas Gregor3ec66632012-02-02 18:42:48 +0000212 }
Richard Smith2b63d152015-05-16 02:28:53 +0000213 } else if (Module::DirectoryName UmbrellaDir = Module->getUmbrellaDir()) {
Douglas Gregord2a8fe12012-01-05 00:04:05 +0000214 // Add all of the headers we find in this subdirectory.
Rafael Espindolac0809172014-06-12 14:02:15 +0000215 std::error_code EC;
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000216 SmallString<128> DirNative;
Richard Smith2b63d152015-05-16 02:28:53 +0000217 llvm::sys::path::native(UmbrellaDir.Entry->getName(), DirNative);
Yaron Keren92e1b622015-03-18 10:17:07 +0000218 for (llvm::sys::fs::recursive_directory_iterator Dir(DirNative, EC),
Douglas Gregorc1aaf8c2011-12-12 19:13:53 +0000219 DirEnd;
Douglas Gregor524e33e2011-12-08 19:11:24 +0000220 Dir != DirEnd && !EC; Dir.increment(EC)) {
221 // Check whether this entry has an extension typically associated with
222 // headers.
223 if (!llvm::StringSwitch<bool>(llvm::sys::path::extension(Dir->path()))
224 .Cases(".h", ".H", ".hh", ".hpp", true)
225 .Default(false))
226 continue;
Richard Smith3c1a41a2014-12-02 00:08:08 +0000227
228 const FileEntry *Header = FileMgr.getFile(Dir->path());
229 // FIXME: This shouldn't happen unless there is a file system race. Is
230 // that worth diagnosing?
231 if (!Header)
232 continue;
233
Douglas Gregord2a8fe12012-01-05 00:04:05 +0000234 // If this header is marked 'unavailable' in this module, don't include
235 // it.
Richard Smith3c1a41a2014-12-02 00:08:08 +0000236 if (ModMap.isHeaderUnavailableInModule(Header, Module))
237 continue;
238
Richard Smith2b63d152015-05-16 02:28:53 +0000239 // Compute the relative path from the directory to this file.
240 SmallVector<StringRef, 16> Components;
241 auto PathIt = llvm::sys::path::rbegin(Dir->path());
242 for (int I = 0; I != Dir.level() + 1; ++I, ++PathIt)
243 Components.push_back(*PathIt);
244 SmallString<128> RelativeHeader(UmbrellaDir.NameAsWritten);
245 for (auto It = Components.rbegin(), End = Components.rend(); It != End;
246 ++It)
247 llvm::sys::path::append(RelativeHeader, *It);
248
Richard Smith723928c2014-03-11 02:02:47 +0000249 // Include this header as part of the umbrella directory.
Richard Smith3c1a41a2014-12-02 00:08:08 +0000250 Module->addTopHeader(Header);
Richard Smith2b63d152015-05-16 02:28:53 +0000251 if (std::error_code Err = addHeaderInclude(RelativeHeader, Includes,
252 LangOpts, Module->IsExternC))
Richard Smith723928c2014-03-11 02:02:47 +0000253 return Err;
Douglas Gregor524e33e2011-12-08 19:11:24 +0000254 }
Richard Smith723928c2014-03-11 02:02:47 +0000255
256 if (EC)
257 return EC;
Douglas Gregor4332b322011-11-16 17:04:00 +0000258 }
Richard Smith3c1a41a2014-12-02 00:08:08 +0000259
Douglas Gregor4332b322011-11-16 17:04:00 +0000260 // Recurse into submodules.
Douglas Gregoreb90e832012-01-04 23:32:19 +0000261 for (clang::Module::submodule_iterator Sub = Module->submodule_begin(),
262 SubEnd = Module->submodule_end();
Douglas Gregore5626c42011-12-06 17:15:11 +0000263 Sub != SubEnd; ++Sub)
Rafael Espindolac0809172014-06-12 14:02:15 +0000264 if (std::error_code Err = collectModuleHeaderIncludes(
Richard Smith723928c2014-03-11 02:02:47 +0000265 LangOpts, FileMgr, ModMap, *Sub, Includes))
266 return Err;
267
Rafael Espindolac0809172014-06-12 14:02:15 +0000268 return std::error_code();
Douglas Gregor4332b322011-11-16 17:04:00 +0000269}
270
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000271bool GenerateModuleAction::BeginSourceFileAction(CompilerInstance &CI,
272 StringRef Filename) {
Richard Smithfb1e7f72015-08-14 05:02:58 +0000273 // Find the module map file.
274 const FileEntry *ModuleMap =
275 CI.getFileManager().getFile(Filename, /*openFile*/true);
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000276 if (!ModuleMap) {
277 CI.getDiagnostics().Report(diag::err_module_map_not_found)
278 << Filename;
279 return false;
280 }
281
282 // Parse the module map file.
283 HeaderSearch &HS = CI.getPreprocessor().getHeaderSearchInfo();
Douglas Gregor963c5532013-06-21 16:28:10 +0000284 if (HS.loadModuleMapFile(ModuleMap, IsSystem))
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000285 return false;
286
287 if (CI.getLangOpts().CurrentModule.empty()) {
288 CI.getDiagnostics().Report(diag::err_missing_module_name);
289
290 // FIXME: Eventually, we could consider asking whether there was just
291 // a single module described in the module map, and use that as a
292 // default. Then it would be fairly trivial to just "compile" a module
293 // map with a single module (the common case).
294 return false;
295 }
Richard Smith7bea1d42014-03-05 20:55:36 +0000296
Richard Smithfb1e7f72015-08-14 05:02:58 +0000297 // Set up embedding for any specified files.
298 for (const auto &F : CI.getFrontendOpts().ModulesEmbedFiles) {
299 if (const auto *FE = CI.getFileManager().getFile(F, /*openFile*/true))
300 CI.getSourceManager().embedFileContentsInModule(FE);
301 else
302 CI.getDiagnostics().Report(diag::err_modules_embed_file_not_found) << F;
303 }
304
Richard Smith7bea1d42014-03-05 20:55:36 +0000305 // If we're being run from the command-line, the module build stack will not
306 // have been filled in yet, so complete it now in order to allow us to detect
307 // module cycles.
308 SourceManager &SourceMgr = CI.getSourceManager();
309 if (SourceMgr.getModuleBuildStack().empty())
310 SourceMgr.pushModuleBuildStack(CI.getLangOpts().CurrentModule,
311 FullSourceLoc(SourceLocation(), SourceMgr));
312
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000313 // Dig out the module definition.
Douglas Gregor279a6c32012-01-29 17:08:11 +0000314 Module = HS.lookupModule(CI.getLangOpts().CurrentModule,
315 /*AllowSearch=*/false);
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000316 if (!Module) {
317 CI.getDiagnostics().Report(diag::err_missing_module)
318 << CI.getLangOpts().CurrentModule << Filename;
319
320 return false;
321 }
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +0000322
323 // Check whether we can build this module at all.
Richard Smitha3feee22013-10-28 22:18:19 +0000324 clang::Module::Requirement Requirement;
Richard Smith3c1a41a2014-12-02 00:08:08 +0000325 clang::Module::UnresolvedHeaderDirective MissingHeader;
Daniel Jasper0761a8a2013-12-17 10:31:37 +0000326 if (!Module->isAvailable(CI.getLangOpts(), CI.getTarget(), Requirement,
327 MissingHeader)) {
328 if (MissingHeader.FileNameLoc.isValid()) {
Ben Langmuirec8c9752014-04-18 22:07:31 +0000329 CI.getDiagnostics().Report(MissingHeader.FileNameLoc,
330 diag::err_module_header_missing)
Daniel Jasper0761a8a2013-12-17 10:31:37 +0000331 << MissingHeader.IsUmbrella << MissingHeader.FileName;
332 } else {
333 CI.getDiagnostics().Report(diag::err_module_unavailable)
334 << Module->getFullModuleName()
335 << Requirement.second << Requirement.first;
336 }
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +0000337
338 return false;
339 }
340
Ben Langmuir9d6448b2014-08-09 00:57:23 +0000341 if (ModuleMapForUniquing && ModuleMapForUniquing != ModuleMap) {
342 Module->IsInferred = true;
343 HS.getModuleMap().setInferredModuleAllowedBy(Module, ModuleMapForUniquing);
344 } else {
Ben Langmuirbeee15e2014-04-14 18:00:01 +0000345 ModuleMapForUniquing = ModuleMap;
Ben Langmuir9d6448b2014-08-09 00:57:23 +0000346 }
Ben Langmuirbeee15e2014-04-14 18:00:01 +0000347
Argyrios Kyrtzidis130190f2012-10-10 02:12:39 +0000348 FileManager &FileMgr = CI.getFileManager();
349
Douglas Gregor4332b322011-11-16 17:04:00 +0000350 // Collect the set of #includes we need to build the module.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000351 SmallString<256> HeaderContents;
Rafael Espindola8e650d72014-06-12 20:37:59 +0000352 std::error_code Err = std::error_code();
Richard Smith2b63d152015-05-16 02:28:53 +0000353 if (Module::Header UmbrellaHeader = Module->getUmbrellaHeader())
354 Err = addHeaderInclude(UmbrellaHeader.NameAsWritten, HeaderContents,
355 CI.getLangOpts(), Module->IsExternC);
Richard Smith723928c2014-03-11 02:02:47 +0000356 if (!Err)
357 Err = collectModuleHeaderIncludes(
358 CI.getLangOpts(), FileMgr,
359 CI.getPreprocessor().getHeaderSearchInfo().getModuleMap(), Module,
360 HeaderContents);
361
362 if (Err) {
363 CI.getDiagnostics().Report(diag::err_module_cannot_create_includes)
364 << Module->getFullModuleName() << Err.message();
365 return false;
366 }
Douglas Gregor4332b322011-11-16 17:04:00 +0000367
Richard Smith3c1a41a2014-12-02 00:08:08 +0000368 // Inform the preprocessor that includes from within the input buffer should
369 // be resolved relative to the build directory of the module map file.
370 CI.getPreprocessor().setMainFileDir(Module->Directory);
371
Rafael Espindolad87f8d72014-08-27 20:03:29 +0000372 std::unique_ptr<llvm::MemoryBuffer> InputBuffer =
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +0000373 llvm::MemoryBuffer::getMemBufferCopy(HeaderContents,
374 Module::getModuleInputBufferName());
Alp Tokerf6a24ce2013-12-05 16:25:25 +0000375 // Ownership of InputBuffer will be transferred to the SourceManager.
Rafael Espindolad87f8d72014-08-27 20:03:29 +0000376 setCurrentInput(FrontendInputFile(InputBuffer.release(), getCurrentFileKind(),
Douglas Gregora686e1b2012-01-27 19:52:33 +0000377 Module->IsSystem));
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000378 return true;
379}
380
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000381raw_pwrite_stream *GenerateModuleAction::ComputeASTConsumerArguments(
Rafael Espindolabfd25d42015-04-10 13:14:31 +0000382 CompilerInstance &CI, StringRef InFile, std::string &Sysroot,
383 std::string &OutputFile) {
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000384 // If no output file was provided, figure out where this module would go
385 // in the module cache.
386 if (CI.getFrontendOpts().OutputFile.empty()) {
387 HeaderSearch &HS = CI.getPreprocessor().getHeaderSearchInfo();
Ben Langmuirbeee15e2014-04-14 18:00:01 +0000388 CI.getFrontendOpts().OutputFile =
389 HS.getModuleFileName(CI.getLangOpts().CurrentModule,
Ben Langmuird89dc562015-02-19 20:23:22 +0000390 ModuleMapForUniquing->getName());
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000391 }
Rafael Espindolabfd25d42015-04-10 13:14:31 +0000392
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000393 // We use createOutputFile here because this is exposed via libclang, and we
394 // must disable the RemoveFileOnSignal behavior.
395 // We use a temporary to avoid race conditions.
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000396 raw_pwrite_stream *OS =
Rafael Espindolabfd25d42015-04-10 13:14:31 +0000397 CI.createOutputFile(CI.getFrontendOpts().OutputFile, /*Binary=*/true,
398 /*RemoveFileOnSignal=*/false, InFile,
399 /*Extension=*/"", /*useTemporary=*/true,
400 /*CreateMissingDirectories=*/true);
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000401 if (!OS)
Rafael Espindolabfd25d42015-04-10 13:14:31 +0000402 return nullptr;
403
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000404 OutputFile = CI.getFrontendOpts().OutputFile;
Rafael Espindolabfd25d42015-04-10 13:14:31 +0000405 return OS;
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000406}
407
David Blaikie6beb6aa2014-08-10 19:56:51 +0000408std::unique_ptr<ASTConsumer>
409SyntaxOnlyAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
410 return llvm::make_unique<ASTConsumer>();
Daniel Dunbar02bd2d72009-11-14 10:42:46 +0000411}
412
David Blaikie6beb6aa2014-08-10 19:56:51 +0000413std::unique_ptr<ASTConsumer>
414DumpModuleInfoAction::CreateASTConsumer(CompilerInstance &CI,
415 StringRef InFile) {
416 return llvm::make_unique<ASTConsumer>();
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000417}
418
David Blaikie6beb6aa2014-08-10 19:56:51 +0000419std::unique_ptr<ASTConsumer>
420VerifyPCHAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
421 return llvm::make_unique<ASTConsumer>();
Ben Langmuir2cb4a782014-02-05 22:21:15 +0000422}
423
424void VerifyPCHAction::ExecuteAction() {
Ben Langmuir3d4417c2014-02-07 17:31:11 +0000425 CompilerInstance &CI = getCompilerInstance();
426 bool Preamble = CI.getPreprocessorOpts().PrecompiledPreambleBytes.first != 0;
427 const std::string &Sysroot = CI.getHeaderSearchOpts().Sysroot;
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000428 std::unique_ptr<ASTReader> Reader(new ASTReader(
Adrian Prantlfb2398d2015-07-17 01:19:54 +0000429 CI.getPreprocessor(), CI.getASTContext(), CI.getPCHContainerReader(),
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000430 Sysroot.empty() ? "" : Sysroot.c_str(),
431 /*DisableValidation*/ false,
432 /*AllowPCHWithCompilerErrors*/ false,
433 /*AllowConfigurationMismatch*/ true,
434 /*ValidateSystemInputs*/ true));
Ben Langmuir3d4417c2014-02-07 17:31:11 +0000435
436 Reader->ReadAST(getCurrentFile(),
437 Preamble ? serialization::MK_Preamble
438 : serialization::MK_PCH,
439 SourceLocation(),
440 ASTReader::ARR_ConfigurationMismatch);
Ben Langmuir2cb4a782014-02-05 22:21:15 +0000441}
442
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000443namespace {
444 /// \brief AST reader listener that dumps module information for a module
445 /// file.
446 class DumpModuleInfoListener : public ASTReaderListener {
447 llvm::raw_ostream &Out;
448
449 public:
450 DumpModuleInfoListener(llvm::raw_ostream &Out) : Out(Out) { }
451
452#define DUMP_BOOLEAN(Value, Text) \
453 Out.indent(4) << Text << ": " << (Value? "Yes" : "No") << "\n"
454
Craig Topperafa7cb32014-03-13 06:07:04 +0000455 bool ReadFullVersionInformation(StringRef FullVersion) override {
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000456 Out.indent(2)
457 << "Generated by "
458 << (FullVersion == getClangFullRepositoryVersion()? "this"
459 : "a different")
460 << " Clang: " << FullVersion << "\n";
461 return ASTReaderListener::ReadFullVersionInformation(FullVersion);
462 }
463
Ben Langmuir4f5212a2014-04-14 22:12:44 +0000464 void ReadModuleName(StringRef ModuleName) override {
465 Out.indent(2) << "Module name: " << ModuleName << "\n";
466 }
467 void ReadModuleMapFile(StringRef ModuleMapPath) override {
468 Out.indent(2) << "Module map file: " << ModuleMapPath << "\n";
469 }
470
Richard Smith1e2cf0d2014-10-31 02:28:58 +0000471 bool ReadLanguageOptions(const LangOptions &LangOpts, bool Complain,
472 bool AllowCompatibleDifferences) override {
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000473 Out.indent(2) << "Language options:\n";
474#define LANGOPT(Name, Bits, Default, Description) \
475 DUMP_BOOLEAN(LangOpts.Name, Description);
476#define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
477 Out.indent(4) << Description << ": " \
478 << static_cast<unsigned>(LangOpts.get##Name()) << "\n";
479#define VALUE_LANGOPT(Name, Bits, Default, Description) \
480 Out.indent(4) << Description << ": " << LangOpts.Name << "\n";
481#define BENIGN_LANGOPT(Name, Bits, Default, Description)
482#define BENIGN_ENUM_LANGOPT(Name, Type, Bits, Default, Description)
483#include "clang/Basic/LangOptions.def"
Ben Langmuircd98cb72015-06-23 18:20:18 +0000484
485 if (!LangOpts.ModuleFeatures.empty()) {
486 Out.indent(4) << "Module features:\n";
487 for (StringRef Feature : LangOpts.ModuleFeatures)
488 Out.indent(6) << Feature << "\n";
489 }
490
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000491 return false;
492 }
493
Chandler Carruth0d745bc2015-03-14 04:47:43 +0000494 bool ReadTargetOptions(const TargetOptions &TargetOpts, bool Complain,
495 bool AllowCompatibleDifferences) override {
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000496 Out.indent(2) << "Target options:\n";
497 Out.indent(4) << " Triple: " << TargetOpts.Triple << "\n";
498 Out.indent(4) << " CPU: " << TargetOpts.CPU << "\n";
499 Out.indent(4) << " ABI: " << TargetOpts.ABI << "\n";
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000500
501 if (!TargetOpts.FeaturesAsWritten.empty()) {
502 Out.indent(4) << "Target features:\n";
503 for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size();
504 I != N; ++I) {
505 Out.indent(6) << TargetOpts.FeaturesAsWritten[I] << "\n";
506 }
507 }
508
509 return false;
510 }
511
Alexander Kornienko34eb2072015-04-11 02:00:23 +0000512 bool ReadDiagnosticOptions(IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts,
513 bool Complain) override {
Ben Langmuirb92de022014-04-29 16:25:26 +0000514 Out.indent(2) << "Diagnostic options:\n";
515#define DIAGOPT(Name, Bits, Default) DUMP_BOOLEAN(DiagOpts->Name, #Name);
516#define ENUM_DIAGOPT(Name, Type, Bits, Default) \
517 Out.indent(4) << #Name << ": " << DiagOpts->get##Name() << "\n";
518#define VALUE_DIAGOPT(Name, Bits, Default) \
519 Out.indent(4) << #Name << ": " << DiagOpts->Name << "\n";
520#include "clang/Basic/DiagnosticOptions.def"
521
Richard Smith3be1cb22014-08-07 00:24:21 +0000522 Out.indent(4) << "Diagnostic flags:\n";
523 for (const std::string &Warning : DiagOpts->Warnings)
Ben Langmuirb92de022014-04-29 16:25:26 +0000524 Out.indent(6) << "-W" << Warning << "\n";
Richard Smith3be1cb22014-08-07 00:24:21 +0000525 for (const std::string &Remark : DiagOpts->Remarks)
526 Out.indent(6) << "-R" << Remark << "\n";
Ben Langmuirb92de022014-04-29 16:25:26 +0000527
528 return false;
529 }
530
Craig Topperafa7cb32014-03-13 06:07:04 +0000531 bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +0000532 StringRef SpecificModuleCachePath,
Craig Topperafa7cb32014-03-13 06:07:04 +0000533 bool Complain) override {
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000534 Out.indent(2) << "Header search options:\n";
535 Out.indent(4) << "System root [-isysroot=]: '" << HSOpts.Sysroot << "'\n";
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +0000536 Out.indent(4) << "Module Cache: '" << SpecificModuleCachePath << "'\n";
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000537 DUMP_BOOLEAN(HSOpts.UseBuiltinIncludes,
538 "Use builtin include directories [-nobuiltininc]");
539 DUMP_BOOLEAN(HSOpts.UseStandardSystemIncludes,
540 "Use standard system include directories [-nostdinc]");
541 DUMP_BOOLEAN(HSOpts.UseStandardCXXIncludes,
542 "Use standard C++ include directories [-nostdinc++]");
543 DUMP_BOOLEAN(HSOpts.UseLibcxx,
544 "Use libc++ (rather than libstdc++) [-stdlib=]");
545 return false;
546 }
547
Craig Topperafa7cb32014-03-13 06:07:04 +0000548 bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts,
549 bool Complain,
550 std::string &SuggestedPredefines) override {
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000551 Out.indent(2) << "Preprocessor options:\n";
552 DUMP_BOOLEAN(PPOpts.UsePredefines,
553 "Uses compiler/target-specific predefines [-undef]");
554 DUMP_BOOLEAN(PPOpts.DetailedRecord,
555 "Uses detailed preprocessing record (for indexing)");
556
557 if (!PPOpts.Macros.empty()) {
558 Out.indent(4) << "Predefined macros:\n";
559 }
560
561 for (std::vector<std::pair<std::string, bool/*isUndef*/> >::const_iterator
562 I = PPOpts.Macros.begin(), IEnd = PPOpts.Macros.end();
563 I != IEnd; ++I) {
564 Out.indent(6);
565 if (I->second)
566 Out << "-U";
567 else
568 Out << "-D";
569 Out << I->first << "\n";
570 }
571 return false;
572 }
573#undef DUMP_BOOLEAN
574 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000575}
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000576
577void DumpModuleInfoAction::ExecuteAction() {
578 // Set up the output file.
Ahmed Charlesb8984322014-03-07 20:03:18 +0000579 std::unique_ptr<llvm::raw_fd_ostream> OutFile;
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000580 StringRef OutputFileName = getCompilerInstance().getFrontendOpts().OutputFile;
581 if (!OutputFileName.empty() && OutputFileName != "-") {
Rafael Espindoladae941a2014-08-25 18:17:04 +0000582 std::error_code EC;
583 OutFile.reset(new llvm::raw_fd_ostream(OutputFileName.str(), EC,
584 llvm::sys::fs::F_Text));
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000585 }
586 llvm::raw_ostream &Out = OutFile.get()? *OutFile.get() : llvm::outs();
587
588 Out << "Information for module file '" << getCurrentFile() << "':\n";
589 DumpModuleInfoListener Listener(Out);
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000590 ASTReader::readASTFileControlBlock(
591 getCurrentFile(), getCompilerInstance().getFileManager(),
Adrian Prantlfb2398d2015-07-17 01:19:54 +0000592 getCompilerInstance().getPCHContainerReader(), Listener);
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000593}
594
Daniel Dunbar88357802009-11-14 10:42:57 +0000595//===----------------------------------------------------------------------===//
596// Preprocessor Actions
597//===----------------------------------------------------------------------===//
598
599void DumpRawTokensAction::ExecuteAction() {
600 Preprocessor &PP = getCompilerInstance().getPreprocessor();
601 SourceManager &SM = PP.getSourceManager();
602
603 // Start lexing the specified input file.
Chris Lattner710bb872009-11-30 04:18:44 +0000604 const llvm::MemoryBuffer *FromFile = SM.getBuffer(SM.getMainFileID());
David Blaikiebbafb8a2012-03-11 07:00:24 +0000605 Lexer RawLex(SM.getMainFileID(), FromFile, SM, PP.getLangOpts());
Daniel Dunbar88357802009-11-14 10:42:57 +0000606 RawLex.SetKeepWhitespaceMode(true);
607
608 Token RawTok;
609 RawLex.LexFromRawLexer(RawTok);
610 while (RawTok.isNot(tok::eof)) {
611 PP.DumpToken(RawTok, true);
Daniel Dunbar75024622009-11-25 10:27:48 +0000612 llvm::errs() << "\n";
Daniel Dunbar88357802009-11-14 10:42:57 +0000613 RawLex.LexFromRawLexer(RawTok);
614 }
615}
616
617void DumpTokensAction::ExecuteAction() {
618 Preprocessor &PP = getCompilerInstance().getPreprocessor();
619 // Start preprocessing the specified input file.
620 Token Tok;
Chris Lattnerfb24a3a2010-04-20 20:35:58 +0000621 PP.EnterMainSourceFile();
Daniel Dunbar88357802009-11-14 10:42:57 +0000622 do {
623 PP.Lex(Tok);
624 PP.DumpToken(Tok, true);
Daniel Dunbar75024622009-11-25 10:27:48 +0000625 llvm::errs() << "\n";
Daniel Dunbar88357802009-11-14 10:42:57 +0000626 } while (Tok.isNot(tok::eof));
627}
628
629void GeneratePTHAction::ExecuteAction() {
630 CompilerInstance &CI = getCompilerInstance();
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000631 raw_pwrite_stream *OS = CI.createDefaultOutputFile(true, getCurrentFile());
NAKAMURA Takumi5594d792015-04-13 08:43:40 +0000632 if (!OS)
633 return;
Daniel Dunbar75546992009-12-03 09:13:30 +0000634
Daniel Dunbar88357802009-11-14 10:42:57 +0000635 CacheTokens(CI.getPreprocessor(), OS);
636}
637
Daniel Dunbar88357802009-11-14 10:42:57 +0000638void PreprocessOnlyAction::ExecuteAction() {
639 Preprocessor &PP = getCompilerInstance().getPreprocessor();
640
Daniel Dunbard839e772010-06-11 20:10:12 +0000641 // Ignore unknown pragmas.
Lubos Lunak576a0412014-05-01 12:54:03 +0000642 PP.IgnorePragmas();
Daniel Dunbard839e772010-06-11 20:10:12 +0000643
Daniel Dunbar88357802009-11-14 10:42:57 +0000644 Token Tok;
645 // Start parsing the specified input file.
Chris Lattnerfb24a3a2010-04-20 20:35:58 +0000646 PP.EnterMainSourceFile();
Daniel Dunbar88357802009-11-14 10:42:57 +0000647 do {
648 PP.Lex(Tok);
649 } while (Tok.isNot(tok::eof));
650}
651
Daniel Dunbar88357802009-11-14 10:42:57 +0000652void PrintPreprocessedAction::ExecuteAction() {
653 CompilerInstance &CI = getCompilerInstance();
Douglas Gregor52da28b2011-09-23 23:43:36 +0000654 // Output file may need to be set to 'Binary', to avoid converting Unix style
Steve Naroff3d38a682010-01-05 17:33:23 +0000655 // line feeds (<LF>) to Microsoft style line feeds (<CR><LF>).
Douglas Gregor52da28b2011-09-23 23:43:36 +0000656 //
657 // Look to see what type of line endings the file uses. If there's a
658 // CRLF, then we won't open the file up in binary mode. If there is
659 // just an LF or CR, then we will open the file up in binary mode.
660 // In this fashion, the output format should match the input format, unless
661 // the input format has inconsistent line endings.
662 //
663 // This should be a relatively fast operation since most files won't have
664 // all of their source code on a single line. However, that is still a
665 // concern, so if we scan for too long, we'll just assume the file should
666 // be opened in binary mode.
667 bool BinaryMode = true;
668 bool InvalidFile = false;
669 const SourceManager& SM = CI.getSourceManager();
670 const llvm::MemoryBuffer *Buffer = SM.getBuffer(SM.getMainFileID(),
671 &InvalidFile);
672 if (!InvalidFile) {
673 const char *cur = Buffer->getBufferStart();
674 const char *end = Buffer->getBufferEnd();
675 const char *next = (cur != end) ? cur + 1 : end;
676
677 // Limit ourselves to only scanning 256 characters into the source
678 // file. This is mostly a sanity check in case the file has no
679 // newlines whatsoever.
680 if (end - cur > 256) end = cur + 256;
681
682 while (next < end) {
683 if (*cur == 0x0D) { // CR
684 if (*next == 0x0A) // CRLF
685 BinaryMode = false;
686
687 break;
688 } else if (*cur == 0x0A) // LF
689 break;
690
691 ++cur, ++next;
692 }
693 }
694
695 raw_ostream *OS = CI.createDefaultOutputFile(BinaryMode, getCurrentFile());
Daniel Dunbar75546992009-12-03 09:13:30 +0000696 if (!OS) return;
697
Daniel Dunbar88357802009-11-14 10:42:57 +0000698 DoPrintPreprocessedInput(CI.getPreprocessor(), OS,
699 CI.getPreprocessorOutputOpts());
700}
Douglas Gregoraf82e352010-07-20 20:18:03 +0000701
702void PrintPreambleAction::ExecuteAction() {
703 switch (getCurrentFileKind()) {
704 case IK_C:
705 case IK_CXX:
706 case IK_ObjC:
707 case IK_ObjCXX:
708 case IK_OpenCL:
Peter Collingbourne62089b82010-12-01 03:15:20 +0000709 case IK_CUDA:
Douglas Gregoraf82e352010-07-20 20:18:03 +0000710 break;
711
712 case IK_None:
713 case IK_Asm:
714 case IK_PreprocessedC:
Artem Belevich83a6dcc2015-03-19 17:32:06 +0000715 case IK_PreprocessedCuda:
Douglas Gregoraf82e352010-07-20 20:18:03 +0000716 case IK_PreprocessedCXX:
717 case IK_PreprocessedObjC:
718 case IK_PreprocessedObjCXX:
719 case IK_AST:
720 case IK_LLVM_IR:
721 // We can't do anything with these.
722 return;
723 }
Rafael Espindola6406f7b2014-08-26 19:54:40 +0000724
Argyrios Kyrtzidis71731d62010-11-03 22:45:23 +0000725 CompilerInstance &CI = getCompilerInstance();
Benjamin Kramera8857962014-10-26 22:44:13 +0000726 auto Buffer = CI.getFileManager().getBufferForFile(getCurrentFile());
727 if (Buffer) {
Rafael Espindolacd0b3802014-08-12 15:46:24 +0000728 unsigned Preamble =
Benjamin Kramera8857962014-10-26 22:44:13 +0000729 Lexer::ComputePreamble((*Buffer)->getBuffer(), CI.getLangOpts()).first;
730 llvm::outs().write((*Buffer)->getBufferStart(), Preamble);
Douglas Gregoraf82e352010-07-20 20:18:03 +0000731 }
732}