1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
|
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//
// This implements a Clang tool to generate compilation information that is
// sufficient to recompile the code with clang. For each compilation unit, all
// source files which are necessary for compiling it are determined. For each
// compilation unit, a file is created containing a list of all file paths of
// included files.
#include <assert.h>
#include <fstream>
#include <iostream>
#include <memory>
#include <set>
#include <stack>
#include <string>
#include <vector>
#include "clang/Basic/Diagnostic.h"
#include "clang/Basic/FileManager.h"
#include "clang/Basic/SourceManager.h"
#include "clang/Frontend/CompilerInstance.h"
#include "clang/Frontend/FrontendActions.h"
#include "clang/Lex/HeaderSearchOptions.h"
#include "clang/Lex/PPCallbacks.h"
#include "clang/Lex/Preprocessor.h"
#include "clang/Tooling/CommonOptionsParser.h"
#include "clang/Tooling/CompilationDatabase.h"
#include "clang/Tooling/Refactoring.h"
#include "clang/Tooling/Tooling.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/Path.h"
using clang::HeaderSearchOptions;
using clang::tooling::CommonOptionsParser;
using llvm::sys::fs::real_path;
using llvm::SmallVector;
using std::set;
using std::stack;
using std::string;
using std::vector;
namespace {
// Set of preprocessor callbacks used to record files included.
class IncludeFinderPPCallbacks : public clang::PPCallbacks {
public:
IncludeFinderPPCallbacks(clang::SourceManager* source_manager,
string* main_source_file,
set<string>* source_file_paths,
const HeaderSearchOptions* header_search_options);
void FileChanged(clang::SourceLocation /*loc*/,
clang::PPCallbacks::FileChangeReason reason,
clang::SrcMgr::CharacteristicKind /*file_type*/,
clang::FileID /*prev_fid*/) override;
void AddFile(const string& path);
void InclusionDirective(clang::SourceLocation hash_loc,
const clang::Token& include_tok,
llvm::StringRef file_name,
bool is_angled,
clang::CharSourceRange range,
clang::OptionalFileEntryRef file,
llvm::StringRef search_path,
llvm::StringRef relative_path,
const clang::Module* SuggestedModule,
bool ModuleImported,
clang::SrcMgr::CharacteristicKind /*file_type*/
) override;
void EndOfMainFile() override;
private:
string DoubleSlashSystemHeaders(const string& search_path,
const string& relative_path) const;
clang::SourceManager* const source_manager_;
#if !defined(NDEBUG)
string* const main_source_file_;
#endif
set<string>* const source_file_paths_;
set<string> system_header_prefixes_;
// The path of the file that was last referenced by an inclusion directive,
// normalized for includes that are relative to a different source file.
string last_inclusion_directive_;
// The stack of currently parsed files. top() gives the current file.
stack<string> current_files_;
};
IncludeFinderPPCallbacks::IncludeFinderPPCallbacks(
clang::SourceManager* source_manager,
string* main_source_file,
set<string>* source_file_paths,
const HeaderSearchOptions* header_search_options)
: source_manager_(source_manager),
#if !defined(NDEBUG)
main_source_file_(main_source_file),
#endif
source_file_paths_(source_file_paths) {
// In practice this list seems to be empty, but add it anyway just in case.
for (const auto& prefix : header_search_options->SystemHeaderPrefixes) {
system_header_prefixes_.insert(prefix.Prefix);
}
// This list contains all the include directories of different type. We add
// all system headers to the set - excluding the Quoted and Angled groups
// which are from -iquote and -I flags.
for (const auto& entry : header_search_options->UserEntries) {
switch (entry.Group) {
case clang::frontend::System:
case clang::frontend::ExternCSystem:
case clang::frontend::CSystem:
case clang::frontend::CXXSystem:
case clang::frontend::ObjCSystem:
case clang::frontend::ObjCXXSystem:
case clang::frontend::After:
system_header_prefixes_.insert(entry.Path);
break;
default:
break;
}
}
}
void IncludeFinderPPCallbacks::FileChanged(
clang::SourceLocation /*loc*/,
clang::PPCallbacks::FileChangeReason reason,
clang::SrcMgr::CharacteristicKind /*file_type*/,
clang::FileID /*prev_fid*/) {
if (reason == clang::PPCallbacks::EnterFile) {
if (!last_inclusion_directive_.empty()) {
current_files_.push(last_inclusion_directive_);
} else {
current_files_.push(std::string(
source_manager_
->getFileEntryRefForID(source_manager_->getMainFileID())
->getName()));
}
} else if (reason == ExitFile) {
current_files_.pop();
}
// Other reasons are not interesting for us.
}
void IncludeFinderPPCallbacks::AddFile(const string& path) {
source_file_paths_->insert(path);
}
void IncludeFinderPPCallbacks::InclusionDirective(
clang::SourceLocation hash_loc,
const clang::Token& include_tok,
llvm::StringRef file_name,
bool is_angled,
clang::CharSourceRange range,
clang::OptionalFileEntryRef file,
llvm::StringRef search_path,
llvm::StringRef relative_path,
const clang::Module* SuggestedModule,
bool ModuleImported,
clang::SrcMgr::CharacteristicKind /*file_type*/
) {
if (!file)
return;
assert(!current_files_.top().empty());
const clang::OptionalDirectoryEntryRef search_path_entry =
source_manager_->getFileManager().getOptionalDirectoryRef(search_path);
const clang::OptionalFileEntryRef current_file_entry =
source_manager_->getFileManager().getOptionalFileRef(
current_files_.top().c_str());
const clang::OptionalDirectoryEntryRef current_file_parent_entry =
current_file_entry
? clang::OptionalDirectoryEntryRef(current_file_entry->getDir())
: clang::OptionalDirectoryEntryRef(std::nullopt);
// If the include file was found relatively to the current file's parent
// directory or a search path, we need to normalize it. This is necessary
// because llvm internalizes the path by which an inode was first accessed,
// and always returns that path afterwards. If we do not normalize this
// we will get an error when we replay the compilation, as the virtual
// file system is not aware of inodes.
if (search_path_entry == current_file_parent_entry) {
string parent =
llvm::sys::path::parent_path(current_files_.top().c_str()).str();
// If the file is a top level file ("file.cc"), we normalize to a path
// relative to "./".
if (parent.empty() || parent == "/")
parent = ".";
// Otherwise we take the literal path as we stored it for the current
// file, and append the relative path.
last_inclusion_directive_ =
DoubleSlashSystemHeaders(parent, relative_path.str());
} else if (!search_path.empty()) {
last_inclusion_directive_ =
DoubleSlashSystemHeaders(search_path.str(), relative_path.str());
} else {
last_inclusion_directive_ = file_name.str();
}
AddFile(last_inclusion_directive_);
}
string IncludeFinderPPCallbacks::DoubleSlashSystemHeaders(
const string& search_path,
const string& relative_path) const {
// We want to be able to extract the search path relative to which the
// include statement is defined. Therefore if search_path is a system header
// we use "//" as a separator between the search path and the relative path.
const bool is_system_header =
system_header_prefixes_.find(search_path) !=
system_header_prefixes_.end();
return search_path + (is_system_header ? "//" : "/") + relative_path;
}
void IncludeFinderPPCallbacks::EndOfMainFile() {
clang::OptionalFileEntryRef main_file =
source_manager_->getFileEntryRefForID(source_manager_->getMainFileID());
assert(main_file.has_value());
SmallVector<char, 100> main_source_file_real_path;
SmallVector<char, 100> main_file_name_real_path;
assert(!real_path(*main_source_file_, main_source_file_real_path));
assert(!real_path(main_file->getName(), main_file_name_real_path));
assert(main_source_file_real_path == main_file_name_real_path);
AddFile(std::string(main_file->getName()));
}
class CompilationIndexerAction : public clang::PreprocessorFrontendAction {
public:
CompilationIndexerAction() {}
void ExecuteAction() override;
// Runs the preprocessor over the translation unit.
// This triggers the PPCallbacks we register to intercept all required
// files for the compilation.
void Preprocess();
void EndSourceFileAction() override;
private:
// Set up the state extracted during the compilation, and run Clang over the
// input.
string main_source_file_;
// Maps file names to their contents as read by Clang's source manager.
set<string> source_file_paths_;
};
void CompilationIndexerAction::ExecuteAction() {
auto inputs = getCompilerInstance().getFrontendOpts().Inputs;
assert(inputs.size() == 1);
main_source_file_ = std::string(inputs[0].getFile());
Preprocess();
}
void CompilationIndexerAction::Preprocess() {
clang::Preprocessor& preprocessor = getCompilerInstance().getPreprocessor();
preprocessor.addPPCallbacks(std::make_unique<IncludeFinderPPCallbacks>(
&getCompilerInstance().getSourceManager(), &main_source_file_,
&source_file_paths_, &getCompilerInstance().getHeaderSearchOpts()));
preprocessor.getDiagnostics().setIgnoreAllWarnings(true);
preprocessor.SetSuppressIncludeNotFoundError(true);
preprocessor.EnterMainSourceFile();
clang::Token token;
do {
preprocessor.Lex(token);
} while (token.isNot(clang::tok::eof));
}
void CompilationIndexerAction::EndSourceFileAction() {
std::ofstream out(main_source_file_ + ".filepaths");
for (const string& path : source_file_paths_) {
out << path << std::endl;
}
}
} // namespace
static llvm::cl::extrahelp common_help(CommonOptionsParser::HelpMessage);
int main(int argc, const char* argv[]) {
llvm::cl::OptionCategory category("TranslationUnitGenerator Tool");
auto ExpectedParser = CommonOptionsParser::create(
argc, argv, category, llvm::cl::OneOrMore, nullptr);
if (!ExpectedParser) {
llvm::errs() << ExpectedParser.takeError();
return 1;
}
CommonOptionsParser& options = ExpectedParser.get();
std::unique_ptr<clang::tooling::FrontendActionFactory> frontend_factory =
clang::tooling::newFrontendActionFactory<CompilationIndexerAction>();
clang::tooling::ClangTool tool(options.getCompilations(),
options.getSourcePathList());
return tool.run(frontend_factory.get());
}
|