1 //===--- FileRemapper.cpp - File Remapping Helper -------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "clang/ARCMigrate/FileRemapper.h"
11 #include "clang/Basic/Diagnostic.h"
12 #include "clang/Basic/FileManager.h"
13 #include "clang/Lex/PreprocessorOptions.h"
14 #include "llvm/Support/FileSystem.h"
15 #include "llvm/Support/MemoryBuffer.h"
16 #include "llvm/Support/Path.h"
17 #include "llvm/Support/raw_ostream.h"
20 using namespace clang;
21 using namespace arcmt;
23 FileRemapper::FileRemapper() {
24 FileMgr.reset(new FileManager(FileSystemOptions()));
27 FileRemapper::~FileRemapper() {
31 void FileRemapper::clear(StringRef outputDir) {
32 for (MappingsTy::iterator
33 I = FromToMappings.begin(), E = FromToMappings.end(); I != E; ++I)
34 resetTarget(I->second);
35 FromToMappings.clear();
36 assert(ToFromMappings.empty());
37 if (!outputDir.empty()) {
38 std::string infoFile = getRemapInfoFile(outputDir);
39 llvm::sys::fs::remove(infoFile);
43 std::string FileRemapper::getRemapInfoFile(StringRef outputDir) {
44 assert(!outputDir.empty());
45 SmallString<128> InfoFile = outputDir;
46 llvm::sys::path::append(InfoFile, "remap");
47 return InfoFile.str();
50 bool FileRemapper::initFromDisk(StringRef outputDir, DiagnosticsEngine &Diag,
51 bool ignoreIfFilesChanged) {
52 std::string infoFile = getRemapInfoFile(outputDir);
53 return initFromFile(infoFile, Diag, ignoreIfFilesChanged);
56 bool FileRemapper::initFromFile(StringRef filePath, DiagnosticsEngine &Diag,
57 bool ignoreIfFilesChanged) {
58 assert(FromToMappings.empty() &&
59 "initFromDisk should be called before any remap calls");
60 std::string infoFile = filePath;
61 if (!llvm::sys::fs::exists(infoFile))
64 std::vector<std::pair<const FileEntry *, const FileEntry *> > pairs;
66 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> fileBuf =
67 llvm::MemoryBuffer::getFile(infoFile);
69 return report("Error opening file: " + infoFile, Diag);
71 SmallVector<StringRef, 64> lines;
72 fileBuf.get()->getBuffer().split(lines, "\n");
74 for (unsigned idx = 0; idx+3 <= lines.size(); idx += 3) {
75 StringRef fromFilename = lines[idx];
76 unsigned long long timeModified;
77 if (lines[idx+1].getAsInteger(10, timeModified))
78 return report("Invalid file data: '" + lines[idx+1] + "' not a number",
80 StringRef toFilename = lines[idx+2];
82 const FileEntry *origFE = FileMgr->getFile(fromFilename);
84 if (ignoreIfFilesChanged)
86 return report("File does not exist: " + fromFilename, Diag);
88 const FileEntry *newFE = FileMgr->getFile(toFilename);
90 if (ignoreIfFilesChanged)
92 return report("File does not exist: " + toFilename, Diag);
95 if ((uint64_t)origFE->getModificationTime() != timeModified) {
96 if (ignoreIfFilesChanged)
98 return report("File was modified: " + fromFilename, Diag);
101 pairs.push_back(std::make_pair(origFE, newFE));
104 for (unsigned i = 0, e = pairs.size(); i != e; ++i)
105 remap(pairs[i].first, pairs[i].second);
110 bool FileRemapper::flushToDisk(StringRef outputDir, DiagnosticsEngine &Diag) {
111 using namespace llvm::sys;
113 if (fs::create_directory(outputDir))
114 return report("Could not create directory: " + outputDir, Diag);
116 std::string infoFile = getRemapInfoFile(outputDir);
117 return flushToFile(infoFile, Diag);
120 bool FileRemapper::flushToFile(StringRef outputPath, DiagnosticsEngine &Diag) {
121 using namespace llvm::sys;
124 std::string infoFile = outputPath;
125 llvm::raw_fd_ostream infoOut(infoFile, EC, llvm::sys::fs::F_None);
127 return report(EC.message(), Diag);
129 for (MappingsTy::iterator
130 I = FromToMappings.begin(), E = FromToMappings.end(); I != E; ++I) {
132 const FileEntry *origFE = I->first;
133 SmallString<200> origPath = StringRef(origFE->getName());
134 fs::make_absolute(origPath);
135 infoOut << origPath << '\n';
136 infoOut << (uint64_t)origFE->getModificationTime() << '\n';
138 if (const FileEntry *FE = I->second.dyn_cast<const FileEntry *>()) {
139 SmallString<200> newPath = StringRef(FE->getName());
140 fs::make_absolute(newPath);
141 infoOut << newPath << '\n';
144 SmallString<64> tempPath;
146 if (fs::createTemporaryFile(path::filename(origFE->getName()),
147 path::extension(origFE->getName()).drop_front(), fd,
149 return report("Could not create file: " + tempPath.str(), Diag);
151 llvm::raw_fd_ostream newOut(fd, /*shouldClose=*/true);
152 llvm::MemoryBuffer *mem = I->second.get<llvm::MemoryBuffer *>();
153 newOut.write(mem->getBufferStart(), mem->getBufferSize());
156 const FileEntry *newE = FileMgr->getFile(tempPath);
158 infoOut << newE->getName() << '\n';
166 bool FileRemapper::overwriteOriginal(DiagnosticsEngine &Diag,
167 StringRef outputDir) {
168 using namespace llvm::sys;
170 for (MappingsTy::iterator
171 I = FromToMappings.begin(), E = FromToMappings.end(); I != E; ++I) {
172 const FileEntry *origFE = I->first;
173 assert(I->second.is<llvm::MemoryBuffer *>());
174 if (!fs::exists(origFE->getName()))
175 return report(StringRef("File does not exist: ") + origFE->getName(),
179 llvm::raw_fd_ostream Out(origFE->getName(), EC, llvm::sys::fs::F_None);
181 return report(EC.message(), Diag);
183 llvm::MemoryBuffer *mem = I->second.get<llvm::MemoryBuffer *>();
184 Out.write(mem->getBufferStart(), mem->getBufferSize());
192 void FileRemapper::applyMappings(PreprocessorOptions &PPOpts) const {
193 for (MappingsTy::const_iterator
194 I = FromToMappings.begin(), E = FromToMappings.end(); I != E; ++I) {
195 if (const FileEntry *FE = I->second.dyn_cast<const FileEntry *>()) {
196 PPOpts.addRemappedFile(I->first->getName(), FE->getName());
198 llvm::MemoryBuffer *mem = I->second.get<llvm::MemoryBuffer *>();
199 PPOpts.addRemappedFile(I->first->getName(), mem);
203 PPOpts.RetainRemappedFileBuffers = true;
206 void FileRemapper::remap(StringRef filePath,
207 std::unique_ptr<llvm::MemoryBuffer> memBuf) {
208 remap(getOriginalFile(filePath), std::move(memBuf));
211 void FileRemapper::remap(const FileEntry *file,
212 std::unique_ptr<llvm::MemoryBuffer> memBuf) {
214 Target &targ = FromToMappings[file];
216 targ = memBuf.release();
219 void FileRemapper::remap(const FileEntry *file, const FileEntry *newfile) {
220 assert(file && newfile);
221 Target &targ = FromToMappings[file];
224 ToFromMappings[newfile] = file;
227 const FileEntry *FileRemapper::getOriginalFile(StringRef filePath) {
228 const FileEntry *file = FileMgr->getFile(filePath);
229 // If we are updating a file that overriden an original file,
230 // actually update the original file.
231 llvm::DenseMap<const FileEntry *, const FileEntry *>::iterator
232 I = ToFromMappings.find(file);
233 if (I != ToFromMappings.end()) {
235 assert(FromToMappings.find(file) != FromToMappings.end() &&
236 "Original file not in mappings!");
241 void FileRemapper::resetTarget(Target &targ) {
245 if (llvm::MemoryBuffer *oldmem = targ.dyn_cast<llvm::MemoryBuffer *>()) {
248 const FileEntry *toFE = targ.get<const FileEntry *>();
249 ToFromMappings.erase(toFE);
253 bool FileRemapper::report(const Twine &err, DiagnosticsEngine &Diag) {
254 Diag.Report(Diag.getCustomDiagID(DiagnosticsEngine::Error, "%0"))