Bug Summary

File:build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/llvm/lib/Support/VirtualFileSystem.cpp
Warning:line 1866, column 14
The left operand of '==' is a garbage value

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -clear-ast-before-backend -disable-llvm-verifier -discard-value-names -main-file-name VirtualFileSystem.cpp -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -analyzer-config-compatibility-mode=true -mrelocation-model pic -pic-level 2 -mframe-pointer=none -fmath-errno -ffp-contract=on -fno-rounding-math -mconstructor-aliases -funwind-tables=2 -target-cpu x86-64 -tune-cpu generic -debugger-tuning=gdb -ffunction-sections -fdata-sections -fcoverage-compilation-dir=/build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/build-llvm -resource-dir /usr/lib/llvm-16/lib/clang/16.0.0 -D _DEBUG -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I lib/Support -I /build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/llvm/lib/Support -I include -I /build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/llvm/include -D _FORTIFY_SOURCE=2 -D NDEBUG -U NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/x86_64-linux-gnu/c++/10 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10/backward -internal-isystem /usr/lib/llvm-16/lib/clang/16.0.0/include -internal-isystem /usr/local/include -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../x86_64-linux-gnu/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -fmacro-prefix-map=/build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/build-llvm=build-llvm -fmacro-prefix-map=/build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/= -fcoverage-prefix-map=/build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/build-llvm=build-llvm -fcoverage-prefix-map=/build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/= -O3 -Wno-unused-command-line-argument -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-maybe-uninitialized -Wno-class-memaccess -Wno-redundant-move -Wno-pessimizing-move -Wno-noexcept-type -Wno-comment -Wno-misleading-indentation -std=c++17 -fdeprecated-macro -fdebug-compilation-dir=/build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/build-llvm -fdebug-prefix-map=/build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/build-llvm=build-llvm -fdebug-prefix-map=/build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/= -ferror-limit 19 -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -fcolor-diagnostics -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -faddrsig -D__GCC_HAVE_DWARF2_CFI_ASM=1 -o /tmp/scan-build-2022-10-03-140002-15933-1 -x c++ /build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/llvm/lib/Support/VirtualFileSystem.cpp
1//===- VirtualFileSystem.cpp - Virtual File System Layer ------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file implements the VirtualFileSystem interface.
10//
11//===----------------------------------------------------------------------===//
12
13#include "llvm/Support/VirtualFileSystem.h"
14#include "llvm/ADT/ArrayRef.h"
15#include "llvm/ADT/DenseMap.h"
16#include "llvm/ADT/IntrusiveRefCntPtr.h"
17#include "llvm/ADT/None.h"
18#include "llvm/ADT/Optional.h"
19#include "llvm/ADT/STLExtras.h"
20#include "llvm/ADT/SmallString.h"
21#include "llvm/ADT/SmallVector.h"
22#include "llvm/ADT/StringRef.h"
23#include "llvm/ADT/StringSet.h"
24#include "llvm/ADT/Twine.h"
25#include "llvm/ADT/iterator_range.h"
26#include "llvm/Config/llvm-config.h"
27#include "llvm/Support/Casting.h"
28#include "llvm/Support/Chrono.h"
29#include "llvm/Support/Compiler.h"
30#include "llvm/Support/Debug.h"
31#include "llvm/Support/Errc.h"
32#include "llvm/Support/ErrorHandling.h"
33#include "llvm/Support/ErrorOr.h"
34#include "llvm/Support/FileSystem.h"
35#include "llvm/Support/FileSystem/UniqueID.h"
36#include "llvm/Support/MemoryBuffer.h"
37#include "llvm/Support/Path.h"
38#include "llvm/Support/SMLoc.h"
39#include "llvm/Support/SourceMgr.h"
40#include "llvm/Support/YAMLParser.h"
41#include "llvm/Support/raw_ostream.h"
42#include <algorithm>
43#include <atomic>
44#include <cassert>
45#include <cstdint>
46#include <iterator>
47#include <limits>
48#include <memory>
49#include <string>
50#include <system_error>
51#include <utility>
52#include <vector>
53
54using namespace llvm;
55using namespace llvm::vfs;
56
57using llvm::sys::fs::file_t;
58using llvm::sys::fs::file_status;
59using llvm::sys::fs::file_type;
60using llvm::sys::fs::kInvalidFile;
61using llvm::sys::fs::perms;
62using llvm::sys::fs::UniqueID;
63
64Status::Status(const file_status &Status)
65 : UID(Status.getUniqueID()), MTime(Status.getLastModificationTime()),
66 User(Status.getUser()), Group(Status.getGroup()), Size(Status.getSize()),
67 Type(Status.type()), Perms(Status.permissions()) {}
68
69Status::Status(const Twine &Name, UniqueID UID, sys::TimePoint<> MTime,
70 uint32_t User, uint32_t Group, uint64_t Size, file_type Type,
71 perms Perms)
72 : Name(Name.str()), UID(UID), MTime(MTime), User(User), Group(Group),
73 Size(Size), Type(Type), Perms(Perms) {}
74
75Status Status::copyWithNewSize(const Status &In, uint64_t NewSize) {
76 return Status(In.getName(), In.getUniqueID(), In.getLastModificationTime(),
77 In.getUser(), In.getGroup(), NewSize, In.getType(),
78 In.getPermissions());
79}
80
81Status Status::copyWithNewName(const Status &In, const Twine &NewName) {
82 return Status(NewName, In.getUniqueID(), In.getLastModificationTime(),
83 In.getUser(), In.getGroup(), In.getSize(), In.getType(),
84 In.getPermissions());
85}
86
87Status Status::copyWithNewName(const file_status &In, const Twine &NewName) {
88 return Status(NewName, In.getUniqueID(), In.getLastModificationTime(),
89 In.getUser(), In.getGroup(), In.getSize(), In.type(),
90 In.permissions());
91}
92
93bool Status::equivalent(const Status &Other) const {
94 assert(isStatusKnown() && Other.isStatusKnown())(static_cast <bool> (isStatusKnown() && Other.isStatusKnown
()) ? void (0) : __assert_fail ("isStatusKnown() && Other.isStatusKnown()"
, "llvm/lib/Support/VirtualFileSystem.cpp", 94, __extension__
__PRETTY_FUNCTION__))
;
95 return getUniqueID() == Other.getUniqueID();
96}
97
98bool Status::isDirectory() const { return Type == file_type::directory_file; }
99
100bool Status::isRegularFile() const { return Type == file_type::regular_file; }
101
102bool Status::isOther() const {
103 return exists() && !isRegularFile() && !isDirectory() && !isSymlink();
104}
105
106bool Status::isSymlink() const { return Type == file_type::symlink_file; }
107
108bool Status::isStatusKnown() const { return Type != file_type::status_error; }
109
110bool Status::exists() const {
111 return isStatusKnown() && Type != file_type::file_not_found;
112}
113
114File::~File() = default;
115
116FileSystem::~FileSystem() = default;
117
118ErrorOr<std::unique_ptr<MemoryBuffer>>
119FileSystem::getBufferForFile(const llvm::Twine &Name, int64_t FileSize,
120 bool RequiresNullTerminator, bool IsVolatile) {
121 auto F = openFileForRead(Name);
122 if (!F)
123 return F.getError();
124
125 return (*F)->getBuffer(Name, FileSize, RequiresNullTerminator, IsVolatile);
126}
127
128std::error_code FileSystem::makeAbsolute(SmallVectorImpl<char> &Path) const {
129 if (llvm::sys::path::is_absolute(Path))
130 return {};
131
132 auto WorkingDir = getCurrentWorkingDirectory();
133 if (!WorkingDir)
134 return WorkingDir.getError();
135
136 llvm::sys::fs::make_absolute(WorkingDir.get(), Path);
137 return {};
138}
139
140std::error_code FileSystem::getRealPath(const Twine &Path,
141 SmallVectorImpl<char> &Output) const {
142 return errc::operation_not_permitted;
143}
144
145std::error_code FileSystem::isLocal(const Twine &Path, bool &Result) {
146 return errc::operation_not_permitted;
147}
148
149bool FileSystem::exists(const Twine &Path) {
150 auto Status = status(Path);
151 return Status && Status->exists();
152}
153
154#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
155void FileSystem::dump() const { print(dbgs(), PrintType::RecursiveContents); }
156#endif
157
158#ifndef NDEBUG
159static bool isTraversalComponent(StringRef Component) {
160 return Component.equals("..") || Component.equals(".");
161}
162
163static bool pathHasTraversal(StringRef Path) {
164 using namespace llvm::sys;
165
166 for (StringRef Comp : llvm::make_range(path::begin(Path), path::end(Path)))
167 if (isTraversalComponent(Comp))
168 return true;
169 return false;
170}
171#endif
172
173//===-----------------------------------------------------------------------===/
174// RealFileSystem implementation
175//===-----------------------------------------------------------------------===/
176
177namespace {
178
179/// Wrapper around a raw file descriptor.
180class RealFile : public File {
181 friend class RealFileSystem;
182
183 file_t FD;
184 Status S;
185 std::string RealName;
186
187 RealFile(file_t RawFD, StringRef NewName, StringRef NewRealPathName)
188 : FD(RawFD), S(NewName, {}, {}, {}, {}, {},
189 llvm::sys::fs::file_type::status_error, {}),
190 RealName(NewRealPathName.str()) {
191 assert(FD != kInvalidFile && "Invalid or inactive file descriptor")(static_cast <bool> (FD != kInvalidFile && "Invalid or inactive file descriptor"
) ? void (0) : __assert_fail ("FD != kInvalidFile && \"Invalid or inactive file descriptor\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 191, __extension__
__PRETTY_FUNCTION__))
;
192 }
193
194public:
195 ~RealFile() override;
196
197 ErrorOr<Status> status() override;
198 ErrorOr<std::string> getName() override;
199 ErrorOr<std::unique_ptr<MemoryBuffer>> getBuffer(const Twine &Name,
200 int64_t FileSize,
201 bool RequiresNullTerminator,
202 bool IsVolatile) override;
203 std::error_code close() override;
204 void setPath(const Twine &Path) override;
205};
206
207} // namespace
208
209RealFile::~RealFile() { close(); }
210
211ErrorOr<Status> RealFile::status() {
212 assert(FD != kInvalidFile && "cannot stat closed file")(static_cast <bool> (FD != kInvalidFile && "cannot stat closed file"
) ? void (0) : __assert_fail ("FD != kInvalidFile && \"cannot stat closed file\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 212, __extension__
__PRETTY_FUNCTION__))
;
213 if (!S.isStatusKnown()) {
214 file_status RealStatus;
215 if (std::error_code EC = sys::fs::status(FD, RealStatus))
216 return EC;
217 S = Status::copyWithNewName(RealStatus, S.getName());
218 }
219 return S;
220}
221
222ErrorOr<std::string> RealFile::getName() {
223 return RealName.empty() ? S.getName().str() : RealName;
224}
225
226ErrorOr<std::unique_ptr<MemoryBuffer>>
227RealFile::getBuffer(const Twine &Name, int64_t FileSize,
228 bool RequiresNullTerminator, bool IsVolatile) {
229 assert(FD != kInvalidFile && "cannot get buffer for closed file")(static_cast <bool> (FD != kInvalidFile && "cannot get buffer for closed file"
) ? void (0) : __assert_fail ("FD != kInvalidFile && \"cannot get buffer for closed file\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 229, __extension__
__PRETTY_FUNCTION__))
;
230 return MemoryBuffer::getOpenFile(FD, Name, FileSize, RequiresNullTerminator,
231 IsVolatile);
232}
233
234std::error_code RealFile::close() {
235 std::error_code EC = sys::fs::closeFile(FD);
236 FD = kInvalidFile;
237 return EC;
238}
239
240void RealFile::setPath(const Twine &Path) {
241 RealName = Path.str();
242 if (auto Status = status())
243 S = Status.get().copyWithNewName(Status.get(), Path);
244}
245
246namespace {
247
248/// A file system according to your operating system.
249/// This may be linked to the process's working directory, or maintain its own.
250///
251/// Currently, its own working directory is emulated by storing the path and
252/// sending absolute paths to llvm::sys::fs:: functions.
253/// A more principled approach would be to push this down a level, modelling
254/// the working dir as an llvm::sys::fs::WorkingDir or similar.
255/// This would enable the use of openat()-style functions on some platforms.
256class RealFileSystem : public FileSystem {
257public:
258 explicit RealFileSystem(bool LinkCWDToProcess) {
259 if (!LinkCWDToProcess) {
260 SmallString<128> PWD, RealPWD;
261 if (llvm::sys::fs::current_path(PWD))
262 return; // Awful, but nothing to do here.
263 if (llvm::sys::fs::real_path(PWD, RealPWD))
264 WD = {PWD, PWD};
265 else
266 WD = {PWD, RealPWD};
267 }
268 }
269
270 ErrorOr<Status> status(const Twine &Path) override;
271 ErrorOr<std::unique_ptr<File>> openFileForRead(const Twine &Path) override;
272 directory_iterator dir_begin(const Twine &Dir, std::error_code &EC) override;
273
274 llvm::ErrorOr<std::string> getCurrentWorkingDirectory() const override;
275 std::error_code setCurrentWorkingDirectory(const Twine &Path) override;
276 std::error_code isLocal(const Twine &Path, bool &Result) override;
277 std::error_code getRealPath(const Twine &Path,
278 SmallVectorImpl<char> &Output) const override;
279
280protected:
281 void printImpl(raw_ostream &OS, PrintType Type,
282 unsigned IndentLevel) const override;
283
284private:
285 // If this FS has its own working dir, use it to make Path absolute.
286 // The returned twine is safe to use as long as both Storage and Path live.
287 Twine adjustPath(const Twine &Path, SmallVectorImpl<char> &Storage) const {
288 if (!WD)
289 return Path;
290 Path.toVector(Storage);
291 sys::fs::make_absolute(WD->Resolved, Storage);
292 return Storage;
293 }
294
295 struct WorkingDirectory {
296 // The current working directory, without symlinks resolved. (echo $PWD).
297 SmallString<128> Specified;
298 // The current working directory, with links resolved. (readlink .).
299 SmallString<128> Resolved;
300 };
301 Optional<WorkingDirectory> WD;
302};
303
304} // namespace
305
306ErrorOr<Status> RealFileSystem::status(const Twine &Path) {
307 SmallString<256> Storage;
308 sys::fs::file_status RealStatus;
309 if (std::error_code EC =
310 sys::fs::status(adjustPath(Path, Storage), RealStatus))
311 return EC;
312 return Status::copyWithNewName(RealStatus, Path);
313}
314
315ErrorOr<std::unique_ptr<File>>
316RealFileSystem::openFileForRead(const Twine &Name) {
317 SmallString<256> RealName, Storage;
318 Expected<file_t> FDOrErr = sys::fs::openNativeFileForRead(
319 adjustPath(Name, Storage), sys::fs::OF_None, &RealName);
320 if (!FDOrErr)
321 return errorToErrorCode(FDOrErr.takeError());
322 return std::unique_ptr<File>(
323 new RealFile(*FDOrErr, Name.str(), RealName.str()));
324}
325
326llvm::ErrorOr<std::string> RealFileSystem::getCurrentWorkingDirectory() const {
327 if (WD)
328 return std::string(WD->Specified.str());
329
330 SmallString<128> Dir;
331 if (std::error_code EC = llvm::sys::fs::current_path(Dir))
332 return EC;
333 return std::string(Dir.str());
334}
335
336std::error_code RealFileSystem::setCurrentWorkingDirectory(const Twine &Path) {
337 if (!WD)
338 return llvm::sys::fs::set_current_path(Path);
339
340 SmallString<128> Absolute, Resolved, Storage;
341 adjustPath(Path, Storage).toVector(Absolute);
342 bool IsDir;
343 if (auto Err = llvm::sys::fs::is_directory(Absolute, IsDir))
344 return Err;
345 if (!IsDir)
346 return std::make_error_code(std::errc::not_a_directory);
347 if (auto Err = llvm::sys::fs::real_path(Absolute, Resolved))
348 return Err;
349 WD = {Absolute, Resolved};
350 return std::error_code();
351}
352
353std::error_code RealFileSystem::isLocal(const Twine &Path, bool &Result) {
354 SmallString<256> Storage;
355 return llvm::sys::fs::is_local(adjustPath(Path, Storage), Result);
356}
357
358std::error_code
359RealFileSystem::getRealPath(const Twine &Path,
360 SmallVectorImpl<char> &Output) const {
361 SmallString<256> Storage;
362 return llvm::sys::fs::real_path(adjustPath(Path, Storage), Output);
363}
364
365void RealFileSystem::printImpl(raw_ostream &OS, PrintType Type,
366 unsigned IndentLevel) const {
367 printIndent(OS, IndentLevel);
368 OS << "RealFileSystem using ";
369 if (WD)
370 OS << "own";
371 else
372 OS << "process";
373 OS << " CWD\n";
374}
375
376IntrusiveRefCntPtr<FileSystem> vfs::getRealFileSystem() {
377 static IntrusiveRefCntPtr<FileSystem> FS(new RealFileSystem(true));
378 return FS;
379}
380
381std::unique_ptr<FileSystem> vfs::createPhysicalFileSystem() {
382 return std::make_unique<RealFileSystem>(false);
383}
384
385namespace {
386
387class RealFSDirIter : public llvm::vfs::detail::DirIterImpl {
388 llvm::sys::fs::directory_iterator Iter;
389
390public:
391 RealFSDirIter(const Twine &Path, std::error_code &EC) : Iter(Path, EC) {
392 if (Iter != llvm::sys::fs::directory_iterator())
393 CurrentEntry = directory_entry(Iter->path(), Iter->type());
394 }
395
396 std::error_code increment() override {
397 std::error_code EC;
398 Iter.increment(EC);
399 CurrentEntry = (Iter == llvm::sys::fs::directory_iterator())
400 ? directory_entry()
401 : directory_entry(Iter->path(), Iter->type());
402 return EC;
403 }
404};
405
406} // namespace
407
408directory_iterator RealFileSystem::dir_begin(const Twine &Dir,
409 std::error_code &EC) {
410 SmallString<128> Storage;
411 return directory_iterator(
412 std::make_shared<RealFSDirIter>(adjustPath(Dir, Storage), EC));
413}
414
415//===-----------------------------------------------------------------------===/
416// OverlayFileSystem implementation
417//===-----------------------------------------------------------------------===/
418
419OverlayFileSystem::OverlayFileSystem(IntrusiveRefCntPtr<FileSystem> BaseFS) {
420 FSList.push_back(std::move(BaseFS));
421}
422
423void OverlayFileSystem::pushOverlay(IntrusiveRefCntPtr<FileSystem> FS) {
424 FSList.push_back(FS);
425 // Synchronize added file systems by duplicating the working directory from
426 // the first one in the list.
427 FS->setCurrentWorkingDirectory(getCurrentWorkingDirectory().get());
428}
429
430ErrorOr<Status> OverlayFileSystem::status(const Twine &Path) {
431 // FIXME: handle symlinks that cross file systems
432 for (iterator I = overlays_begin(), E = overlays_end(); I != E; ++I) {
433 ErrorOr<Status> Status = (*I)->status(Path);
434 if (Status || Status.getError() != llvm::errc::no_such_file_or_directory)
435 return Status;
436 }
437 return make_error_code(llvm::errc::no_such_file_or_directory);
438}
439
440ErrorOr<std::unique_ptr<File>>
441OverlayFileSystem::openFileForRead(const llvm::Twine &Path) {
442 // FIXME: handle symlinks that cross file systems
443 for (iterator I = overlays_begin(), E = overlays_end(); I != E; ++I) {
444 auto Result = (*I)->openFileForRead(Path);
445 if (Result || Result.getError() != llvm::errc::no_such_file_or_directory)
446 return Result;
447 }
448 return make_error_code(llvm::errc::no_such_file_or_directory);
449}
450
451llvm::ErrorOr<std::string>
452OverlayFileSystem::getCurrentWorkingDirectory() const {
453 // All file systems are synchronized, just take the first working directory.
454 return FSList.front()->getCurrentWorkingDirectory();
455}
456
457std::error_code
458OverlayFileSystem::setCurrentWorkingDirectory(const Twine &Path) {
459 for (auto &FS : FSList)
460 if (std::error_code EC = FS->setCurrentWorkingDirectory(Path))
461 return EC;
462 return {};
463}
464
465std::error_code OverlayFileSystem::isLocal(const Twine &Path, bool &Result) {
466 for (auto &FS : FSList)
467 if (FS->exists(Path))
468 return FS->isLocal(Path, Result);
469 return errc::no_such_file_or_directory;
470}
471
472std::error_code
473OverlayFileSystem::getRealPath(const Twine &Path,
474 SmallVectorImpl<char> &Output) const {
475 for (const auto &FS : FSList)
476 if (FS->exists(Path))
477 return FS->getRealPath(Path, Output);
478 return errc::no_such_file_or_directory;
479}
480
481void OverlayFileSystem::printImpl(raw_ostream &OS, PrintType Type,
482 unsigned IndentLevel) const {
483 printIndent(OS, IndentLevel);
484 OS << "OverlayFileSystem\n";
485 if (Type == PrintType::Summary)
486 return;
487
488 if (Type == PrintType::Contents)
489 Type = PrintType::Summary;
490 for (auto FS : overlays_range())
491 FS->print(OS, Type, IndentLevel + 1);
492}
493
494llvm::vfs::detail::DirIterImpl::~DirIterImpl() = default;
495
496namespace {
497
498/// Combines and deduplicates directory entries across multiple file systems.
499class CombiningDirIterImpl : public llvm::vfs::detail::DirIterImpl {
500 using FileSystemPtr = llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem>;
501
502 /// Iterators to combine, processed in reverse order.
503 SmallVector<directory_iterator, 8> IterList;
504 /// The iterator currently being traversed.
505 directory_iterator CurrentDirIter;
506 /// The set of names already returned as entries.
507 llvm::StringSet<> SeenNames;
508
509 /// Sets \c CurrentDirIter to the next iterator in the list, or leaves it as
510 /// is (at its end position) if we've already gone through them all.
511 std::error_code incrementIter(bool IsFirstTime) {
512 while (!IterList.empty()) {
513 CurrentDirIter = IterList.back();
514 IterList.pop_back();
515 if (CurrentDirIter != directory_iterator())
516 break; // found
517 }
518
519 if (IsFirstTime && CurrentDirIter == directory_iterator())
520 return errc::no_such_file_or_directory;
521 return {};
522 }
523
524 std::error_code incrementDirIter(bool IsFirstTime) {
525 assert((IsFirstTime || CurrentDirIter != directory_iterator()) &&(static_cast <bool> ((IsFirstTime || CurrentDirIter != directory_iterator
()) && "incrementing past end") ? void (0) : __assert_fail
("(IsFirstTime || CurrentDirIter != directory_iterator()) && \"incrementing past end\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 526, __extension__
__PRETTY_FUNCTION__))
526 "incrementing past end")(static_cast <bool> ((IsFirstTime || CurrentDirIter != directory_iterator
()) && "incrementing past end") ? void (0) : __assert_fail
("(IsFirstTime || CurrentDirIter != directory_iterator()) && \"incrementing past end\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 526, __extension__
__PRETTY_FUNCTION__))
;
527 std::error_code EC;
528 if (!IsFirstTime)
529 CurrentDirIter.increment(EC);
530 if (!EC && CurrentDirIter == directory_iterator())
531 EC = incrementIter(IsFirstTime);
532 return EC;
533 }
534
535 std::error_code incrementImpl(bool IsFirstTime) {
536 while (true) {
537 std::error_code EC = incrementDirIter(IsFirstTime);
538 if (EC || CurrentDirIter == directory_iterator()) {
539 CurrentEntry = directory_entry();
540 return EC;
541 }
542 CurrentEntry = *CurrentDirIter;
543 StringRef Name = llvm::sys::path::filename(CurrentEntry.path());
544 if (SeenNames.insert(Name).second)
545 return EC; // name not seen before
546 }
547 llvm_unreachable("returned above")::llvm::llvm_unreachable_internal("returned above", "llvm/lib/Support/VirtualFileSystem.cpp"
, 547)
;
548 }
549
550public:
551 CombiningDirIterImpl(ArrayRef<FileSystemPtr> FileSystems, std::string Dir,
552 std::error_code &EC) {
553 for (auto FS : FileSystems) {
554 std::error_code FEC;
555 directory_iterator Iter = FS->dir_begin(Dir, FEC);
556 if (FEC && FEC != errc::no_such_file_or_directory) {
557 EC = FEC;
558 return;
559 }
560 if (!FEC)
561 IterList.push_back(Iter);
562 }
563 EC = incrementImpl(true);
564 }
565
566 CombiningDirIterImpl(ArrayRef<directory_iterator> DirIters,
567 std::error_code &EC)
568 : IterList(DirIters.begin(), DirIters.end()) {
569 EC = incrementImpl(true);
570 }
571
572 std::error_code increment() override { return incrementImpl(false); }
573};
574
575} // namespace
576
577directory_iterator OverlayFileSystem::dir_begin(const Twine &Dir,
578 std::error_code &EC) {
579 directory_iterator Combined = directory_iterator(
580 std::make_shared<CombiningDirIterImpl>(FSList, Dir.str(), EC));
581 if (EC)
582 return {};
583 return Combined;
584}
585
586void ProxyFileSystem::anchor() {}
587
588namespace llvm {
589namespace vfs {
590
591namespace detail {
592
593enum InMemoryNodeKind {
594 IME_File,
595 IME_Directory,
596 IME_HardLink,
597 IME_SymbolicLink,
598};
599
600/// The in memory file system is a tree of Nodes. Every node can either be a
601/// file, symlink, hardlink or a directory.
602class InMemoryNode {
603 InMemoryNodeKind Kind;
604 std::string FileName;
605
606public:
607 InMemoryNode(llvm::StringRef FileName, InMemoryNodeKind Kind)
608 : Kind(Kind), FileName(std::string(llvm::sys::path::filename(FileName))) {
609 }
610 virtual ~InMemoryNode() = default;
611
612 /// Return the \p Status for this node. \p RequestedName should be the name
613 /// through which the caller referred to this node. It will override
614 /// \p Status::Name in the return value, to mimic the behavior of \p RealFile.
615 virtual Status getStatus(const Twine &RequestedName) const = 0;
616
617 /// Get the filename of this node (the name without the directory part).
618 StringRef getFileName() const { return FileName; }
619 InMemoryNodeKind getKind() const { return Kind; }
620 virtual std::string toString(unsigned Indent) const = 0;
621};
622
623class InMemoryFile : public InMemoryNode {
624 Status Stat;
625 std::unique_ptr<llvm::MemoryBuffer> Buffer;
626
627public:
628 InMemoryFile(Status Stat, std::unique_ptr<llvm::MemoryBuffer> Buffer)
629 : InMemoryNode(Stat.getName(), IME_File), Stat(std::move(Stat)),
630 Buffer(std::move(Buffer)) {}
631
632 Status getStatus(const Twine &RequestedName) const override {
633 return Status::copyWithNewName(Stat, RequestedName);
634 }
635 llvm::MemoryBuffer *getBuffer() const { return Buffer.get(); }
636
637 std::string toString(unsigned Indent) const override {
638 return (std::string(Indent, ' ') + Stat.getName() + "\n").str();
639 }
640
641 static bool classof(const InMemoryNode *N) {
642 return N->getKind() == IME_File;
643 }
644};
645
646namespace {
647
648class InMemoryHardLink : public InMemoryNode {
649 const InMemoryFile &ResolvedFile;
650
651public:
652 InMemoryHardLink(StringRef Path, const InMemoryFile &ResolvedFile)
653 : InMemoryNode(Path, IME_HardLink), ResolvedFile(ResolvedFile) {}
654 const InMemoryFile &getResolvedFile() const { return ResolvedFile; }
655
656 Status getStatus(const Twine &RequestedName) const override {
657 return ResolvedFile.getStatus(RequestedName);
658 }
659
660 std::string toString(unsigned Indent) const override {
661 return std::string(Indent, ' ') + "HardLink to -> " +
662 ResolvedFile.toString(0);
663 }
664
665 static bool classof(const InMemoryNode *N) {
666 return N->getKind() == IME_HardLink;
667 }
668};
669
670class InMemorySymbolicLink : public InMemoryNode {
671 std::string TargetPath;
672 Status Stat;
673
674public:
675 InMemorySymbolicLink(StringRef Path, StringRef TargetPath, Status Stat)
676 : InMemoryNode(Path, IME_SymbolicLink), TargetPath(std::move(TargetPath)),
677 Stat(Stat) {}
678
679 std::string toString(unsigned Indent) const override {
680 return std::string(Indent, ' ') + "SymbolicLink to -> " + TargetPath;
681 }
682
683 Status getStatus(const Twine &RequestedName) const override {
684 return Status::copyWithNewName(Stat, RequestedName);
685 }
686
687 StringRef getTargetPath() const { return TargetPath; }
688
689 static bool classof(const InMemoryNode *N) {
690 return N->getKind() == IME_SymbolicLink;
691 }
692};
693
694/// Adapt a InMemoryFile for VFS' File interface. The goal is to make
695/// \p InMemoryFileAdaptor mimic as much as possible the behavior of
696/// \p RealFile.
697class InMemoryFileAdaptor : public File {
698 const InMemoryFile &Node;
699 /// The name to use when returning a Status for this file.
700 std::string RequestedName;
701
702public:
703 explicit InMemoryFileAdaptor(const InMemoryFile &Node,
704 std::string RequestedName)
705 : Node(Node), RequestedName(std::move(RequestedName)) {}
706
707 llvm::ErrorOr<Status> status() override {
708 return Node.getStatus(RequestedName);
709 }
710
711 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>>
712 getBuffer(const Twine &Name, int64_t FileSize, bool RequiresNullTerminator,
713 bool IsVolatile) override {
714 llvm::MemoryBuffer *Buf = Node.getBuffer();
715 return llvm::MemoryBuffer::getMemBuffer(
716 Buf->getBuffer(), Buf->getBufferIdentifier(), RequiresNullTerminator);
717 }
718
719 std::error_code close() override { return {}; }
720
721 void setPath(const Twine &Path) override { RequestedName = Path.str(); }
722};
723} // namespace
724
725class InMemoryDirectory : public InMemoryNode {
726 Status Stat;
727 llvm::StringMap<std::unique_ptr<InMemoryNode>> Entries;
728
729public:
730 InMemoryDirectory(Status Stat)
731 : InMemoryNode(Stat.getName(), IME_Directory), Stat(std::move(Stat)) {}
732
733 /// Return the \p Status for this node. \p RequestedName should be the name
734 /// through which the caller referred to this node. It will override
735 /// \p Status::Name in the return value, to mimic the behavior of \p RealFile.
736 Status getStatus(const Twine &RequestedName) const override {
737 return Status::copyWithNewName(Stat, RequestedName);
738 }
739
740 UniqueID getUniqueID() const { return Stat.getUniqueID(); }
741
742 InMemoryNode *getChild(StringRef Name) const {
743 auto I = Entries.find(Name);
744 if (I != Entries.end())
745 return I->second.get();
746 return nullptr;
747 }
748
749 InMemoryNode *addChild(StringRef Name, std::unique_ptr<InMemoryNode> Child) {
750 return Entries.insert(make_pair(Name, std::move(Child)))
751 .first->second.get();
752 }
753
754 using const_iterator = decltype(Entries)::const_iterator;
755
756 const_iterator begin() const { return Entries.begin(); }
757 const_iterator end() const { return Entries.end(); }
758
759 std::string toString(unsigned Indent) const override {
760 std::string Result =
761 (std::string(Indent, ' ') + Stat.getName() + "\n").str();
762 for (const auto &Entry : Entries)
763 Result += Entry.second->toString(Indent + 2);
764 return Result;
765 }
766
767 static bool classof(const InMemoryNode *N) {
768 return N->getKind() == IME_Directory;
769 }
770};
771
772} // namespace detail
773
774// The UniqueID of in-memory files is derived from path and content.
775// This avoids difficulties in creating exactly equivalent in-memory FSes,
776// as often needed in multithreaded programs.
777static sys::fs::UniqueID getUniqueID(hash_code Hash) {
778 return sys::fs::UniqueID(std::numeric_limits<uint64_t>::max(),
779 uint64_t(size_t(Hash)));
780}
781static sys::fs::UniqueID getFileID(sys::fs::UniqueID Parent,
782 llvm::StringRef Name,
783 llvm::StringRef Contents) {
784 return getUniqueID(llvm::hash_combine(Parent.getFile(), Name, Contents));
785}
786static sys::fs::UniqueID getDirectoryID(sys::fs::UniqueID Parent,
787 llvm::StringRef Name) {
788 return getUniqueID(llvm::hash_combine(Parent.getFile(), Name));
789}
790
791Status detail::NewInMemoryNodeInfo::makeStatus() const {
792 UniqueID UID =
793 (Type == sys::fs::file_type::directory_file)
794 ? getDirectoryID(DirUID, Name)
795 : getFileID(DirUID, Name, Buffer ? Buffer->getBuffer() : "");
796
797 return Status(Path, UID, llvm::sys::toTimePoint(ModificationTime), User,
798 Group, Buffer ? Buffer->getBufferSize() : 0, Type, Perms);
799}
800
801InMemoryFileSystem::InMemoryFileSystem(bool UseNormalizedPaths)
802 : Root(new detail::InMemoryDirectory(
803 Status("", getDirectoryID(llvm::sys::fs::UniqueID(), ""),
804 llvm::sys::TimePoint<>(), 0, 0, 0,
805 llvm::sys::fs::file_type::directory_file,
806 llvm::sys::fs::perms::all_all))),
807 UseNormalizedPaths(UseNormalizedPaths) {}
808
809InMemoryFileSystem::~InMemoryFileSystem() = default;
810
811std::string InMemoryFileSystem::toString() const {
812 return Root->toString(/*Indent=*/0);
813}
814
815bool InMemoryFileSystem::addFile(const Twine &P, time_t ModificationTime,
816 std::unique_ptr<llvm::MemoryBuffer> Buffer,
817 Optional<uint32_t> User,
818 Optional<uint32_t> Group,
819 Optional<llvm::sys::fs::file_type> Type,
820 Optional<llvm::sys::fs::perms> Perms,
821 MakeNodeFn MakeNode) {
822 SmallString<128> Path;
823 P.toVector(Path);
824
825 // Fix up relative paths. This just prepends the current working directory.
826 std::error_code EC = makeAbsolute(Path);
827 assert(!EC)(static_cast <bool> (!EC) ? void (0) : __assert_fail ("!EC"
, "llvm/lib/Support/VirtualFileSystem.cpp", 827, __extension__
__PRETTY_FUNCTION__))
;
828 (void)EC;
829
830 if (useNormalizedPaths())
831 llvm::sys::path::remove_dots(Path, /*remove_dot_dot=*/true);
832
833 if (Path.empty())
834 return false;
835
836 detail::InMemoryDirectory *Dir = Root.get();
837 auto I = llvm::sys::path::begin(Path), E = sys::path::end(Path);
838 const auto ResolvedUser = User.value_or(0);
839 const auto ResolvedGroup = Group.value_or(0);
840 const auto ResolvedType = Type.value_or(sys::fs::file_type::regular_file);
841 const auto ResolvedPerms = Perms.value_or(sys::fs::all_all);
842 // Any intermediate directories we create should be accessible by
843 // the owner, even if Perms says otherwise for the final path.
844 const auto NewDirectoryPerms = ResolvedPerms | sys::fs::owner_all;
845 while (true) {
846 StringRef Name = *I;
847 detail::InMemoryNode *Node = Dir->getChild(Name);
848 ++I;
849 if (!Node) {
850 if (I == E) {
851 // End of the path.
852 Dir->addChild(
853 Name, MakeNode({Dir->getUniqueID(), Path, Name, ModificationTime,
854 std::move(Buffer), ResolvedUser, ResolvedGroup,
855 ResolvedType, ResolvedPerms}));
856 return true;
857 }
858
859 // Create a new directory. Use the path up to here.
860 Status Stat(
861 StringRef(Path.str().begin(), Name.end() - Path.str().begin()),
862 getDirectoryID(Dir->getUniqueID(), Name),
863 llvm::sys::toTimePoint(ModificationTime), ResolvedUser, ResolvedGroup,
864 0, sys::fs::file_type::directory_file, NewDirectoryPerms);
865 Dir = cast<detail::InMemoryDirectory>(Dir->addChild(
866 Name, std::make_unique<detail::InMemoryDirectory>(std::move(Stat))));
867 continue;
868 }
869
870 if (auto *NewDir = dyn_cast<detail::InMemoryDirectory>(Node)) {
871 Dir = NewDir;
872 } else {
873 assert((isa<detail::InMemoryFile>(Node) ||(static_cast <bool> ((isa<detail::InMemoryFile>(Node
) || isa<detail::InMemoryHardLink>(Node)) && "Must be either file, hardlink or directory!"
) ? void (0) : __assert_fail ("(isa<detail::InMemoryFile>(Node) || isa<detail::InMemoryHardLink>(Node)) && \"Must be either file, hardlink or directory!\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 875, __extension__
__PRETTY_FUNCTION__))
874 isa<detail::InMemoryHardLink>(Node)) &&(static_cast <bool> ((isa<detail::InMemoryFile>(Node
) || isa<detail::InMemoryHardLink>(Node)) && "Must be either file, hardlink or directory!"
) ? void (0) : __assert_fail ("(isa<detail::InMemoryFile>(Node) || isa<detail::InMemoryHardLink>(Node)) && \"Must be either file, hardlink or directory!\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 875, __extension__
__PRETTY_FUNCTION__))
875 "Must be either file, hardlink or directory!")(static_cast <bool> ((isa<detail::InMemoryFile>(Node
) || isa<detail::InMemoryHardLink>(Node)) && "Must be either file, hardlink or directory!"
) ? void (0) : __assert_fail ("(isa<detail::InMemoryFile>(Node) || isa<detail::InMemoryHardLink>(Node)) && \"Must be either file, hardlink or directory!\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 875, __extension__
__PRETTY_FUNCTION__))
;
876
877 // Trying to insert a directory in place of a file.
878 if (I != E)
879 return false;
880
881 // Return false only if the new file is different from the existing one.
882 if (auto Link = dyn_cast<detail::InMemoryHardLink>(Node)) {
883 return Link->getResolvedFile().getBuffer()->getBuffer() ==
884 Buffer->getBuffer();
885 }
886 return cast<detail::InMemoryFile>(Node)->getBuffer()->getBuffer() ==
887 Buffer->getBuffer();
888 }
889 }
890}
891
892bool InMemoryFileSystem::addFile(const Twine &P, time_t ModificationTime,
893 std::unique_ptr<llvm::MemoryBuffer> Buffer,
894 Optional<uint32_t> User,
895 Optional<uint32_t> Group,
896 Optional<llvm::sys::fs::file_type> Type,
897 Optional<llvm::sys::fs::perms> Perms) {
898 return addFile(P, ModificationTime, std::move(Buffer), User, Group, Type,
899 Perms,
900 [](detail::NewInMemoryNodeInfo NNI)
901 -> std::unique_ptr<detail::InMemoryNode> {
902 Status Stat = NNI.makeStatus();
903 if (Stat.getType() == sys::fs::file_type::directory_file)
904 return std::make_unique<detail::InMemoryDirectory>(Stat);
905 return std::make_unique<detail::InMemoryFile>(
906 Stat, std::move(NNI.Buffer));
907 });
908}
909
910bool InMemoryFileSystem::addFileNoOwn(const Twine &P, time_t ModificationTime,
911 const llvm::MemoryBufferRef &Buffer,
912 Optional<uint32_t> User,
913 Optional<uint32_t> Group,
914 Optional<llvm::sys::fs::file_type> Type,
915 Optional<llvm::sys::fs::perms> Perms) {
916 return addFile(P, ModificationTime, llvm::MemoryBuffer::getMemBuffer(Buffer),
917 std::move(User), std::move(Group), std::move(Type),
918 std::move(Perms),
919 [](detail::NewInMemoryNodeInfo NNI)
920 -> std::unique_ptr<detail::InMemoryNode> {
921 Status Stat = NNI.makeStatus();
922 if (Stat.getType() == sys::fs::file_type::directory_file)
923 return std::make_unique<detail::InMemoryDirectory>(Stat);
924 return std::make_unique<detail::InMemoryFile>(
925 Stat, std::move(NNI.Buffer));
926 });
927}
928
929detail::NamedNodeOrError
930InMemoryFileSystem::lookupNode(const Twine &P, bool FollowFinalSymlink,
931 size_t SymlinkDepth) const {
932 SmallString<128> Path;
933 P.toVector(Path);
934
935 // Fix up relative paths. This just prepends the current working directory.
936 std::error_code EC = makeAbsolute(Path);
937 assert(!EC)(static_cast <bool> (!EC) ? void (0) : __assert_fail ("!EC"
, "llvm/lib/Support/VirtualFileSystem.cpp", 937, __extension__
__PRETTY_FUNCTION__))
;
938 (void)EC;
939
940 if (useNormalizedPaths())
941 llvm::sys::path::remove_dots(Path, /*remove_dot_dot=*/true);
942
943 const detail::InMemoryDirectory *Dir = Root.get();
944 if (Path.empty())
945 return detail::NamedNodeOrError(Path, Dir);
946
947 auto I = llvm::sys::path::begin(Path), E = llvm::sys::path::end(Path);
948 while (true) {
949 detail::InMemoryNode *Node = Dir->getChild(*I);
950 ++I;
951 if (!Node)
952 return errc::no_such_file_or_directory;
953
954 if (auto Symlink = dyn_cast<detail::InMemorySymbolicLink>(Node)) {
955 // If we're at the end of the path, and we're not following through
956 // terminal symlinks, then we're done.
957 if (I == E && !FollowFinalSymlink)
958 return detail::NamedNodeOrError(Path, Symlink);
959
960 if (SymlinkDepth > InMemoryFileSystem::MaxSymlinkDepth)
961 return errc::no_such_file_or_directory;
962
963 SmallString<128> TargetPath = Symlink->getTargetPath();
964 if (std::error_code EC = makeAbsolute(TargetPath))
965 return EC;
966
967 // Keep going with the target. We always want to follow symlinks here
968 // because we're either at the end of a path that we want to follow, or
969 // not at the end of a path, in which case we need to follow the symlink
970 // regardless.
971 auto Target =
972 lookupNode(TargetPath, /*FollowFinalSymlink=*/true, SymlinkDepth + 1);
973 if (!Target || I == E)
974 return Target;
975
976 if (!isa<detail::InMemoryDirectory>(*Target))
977 return errc::no_such_file_or_directory;
978
979 // Otherwise, continue on the search in the symlinked directory.
980 Dir = cast<detail::InMemoryDirectory>(*Target);
981 continue;
982 }
983
984 // Return the file if it's at the end of the path.
985 if (auto File = dyn_cast<detail::InMemoryFile>(Node)) {
986 if (I == E)
987 return detail::NamedNodeOrError(Path, File);
988 return errc::no_such_file_or_directory;
989 }
990
991 // If Node is HardLink then return the resolved file.
992 if (auto File = dyn_cast<detail::InMemoryHardLink>(Node)) {
993 if (I == E)
994 return detail::NamedNodeOrError(Path, &File->getResolvedFile());
995 return errc::no_such_file_or_directory;
996 }
997 // Traverse directories.
998 Dir = cast<detail::InMemoryDirectory>(Node);
999 if (I == E)
1000 return detail::NamedNodeOrError(Path, Dir);
1001 }
1002}
1003
1004bool InMemoryFileSystem::addHardLink(const Twine &NewLink,
1005 const Twine &Target) {
1006 auto NewLinkNode = lookupNode(NewLink, /*FollowFinalSymlink=*/false);
1007 // Whether symlinks in the hardlink target are followed is
1008 // implementation-defined in POSIX.
1009 // We're following symlinks here to be consistent with macOS.
1010 auto TargetNode = lookupNode(Target, /*FollowFinalSymlink=*/true);
1011 // FromPath must not have been added before. ToPath must have been added
1012 // before. Resolved ToPath must be a File.
1013 if (!TargetNode || NewLinkNode || !isa<detail::InMemoryFile>(*TargetNode))
1014 return false;
1015 return addFile(NewLink, 0, nullptr, None, None, None, None,
1016 [&](detail::NewInMemoryNodeInfo NNI) {
1017 return std::make_unique<detail::InMemoryHardLink>(
1018 NNI.Path.str(),
1019 *cast<detail::InMemoryFile>(*TargetNode));
1020 });
1021}
1022
1023bool InMemoryFileSystem::addSymbolicLink(const Twine &NewLink,
1024 const Twine &Target,
1025 time_t ModificationTime,
1026 Optional<uint32_t> User,
1027 Optional<uint32_t> Group,
1028 Optional<llvm::sys::fs::perms> Perms) {
1029 auto NewLinkNode = lookupNode(NewLink, /*FollowFinalSymlink=*/false);
1030 if (NewLinkNode)
1031 return false;
1032
1033 SmallString<128> NewLinkStr, TargetStr;
1034 NewLink.toVector(NewLinkStr);
1035 Target.toVector(TargetStr);
1036
1037 return addFile(NewLinkStr, ModificationTime, nullptr, User, Group,
1038 sys::fs::file_type::symlink_file, Perms,
1039 [&](detail::NewInMemoryNodeInfo NNI) {
1040 return std::make_unique<detail::InMemorySymbolicLink>(
1041 NewLinkStr, TargetStr, NNI.makeStatus());
1042 });
1043}
1044
1045llvm::ErrorOr<Status> InMemoryFileSystem::status(const Twine &Path) {
1046 auto Node = lookupNode(Path, /*FollowFinalSymlink=*/true);
1047 if (Node)
1048 return (*Node)->getStatus(Path);
1049 return Node.getError();
1050}
1051
1052llvm::ErrorOr<std::unique_ptr<File>>
1053InMemoryFileSystem::openFileForRead(const Twine &Path) {
1054 auto Node = lookupNode(Path,/*FollowFinalSymlink=*/true);
1055 if (!Node)
1056 return Node.getError();
1057
1058 // When we have a file provide a heap-allocated wrapper for the memory buffer
1059 // to match the ownership semantics for File.
1060 if (auto *F = dyn_cast<detail::InMemoryFile>(*Node))
1061 return std::unique_ptr<File>(
1062 new detail::InMemoryFileAdaptor(*F, Path.str()));
1063
1064 // FIXME: errc::not_a_file?
1065 return make_error_code(llvm::errc::invalid_argument);
1066}
1067
1068/// Adaptor from InMemoryDir::iterator to directory_iterator.
1069class InMemoryFileSystem::DirIterator : public llvm::vfs::detail::DirIterImpl {
1070 const InMemoryFileSystem *FS;
1071 detail::InMemoryDirectory::const_iterator I;
1072 detail::InMemoryDirectory::const_iterator E;
1073 std::string RequestedDirName;
1074
1075 void setCurrentEntry() {
1076 if (I != E) {
1077 SmallString<256> Path(RequestedDirName);
1078 llvm::sys::path::append(Path, I->second->getFileName());
1079 sys::fs::file_type Type = sys::fs::file_type::type_unknown;
1080 switch (I->second->getKind()) {
1081 case detail::IME_File:
1082 case detail::IME_HardLink:
1083 Type = sys::fs::file_type::regular_file;
1084 break;
1085 case detail::IME_Directory:
1086 Type = sys::fs::file_type::directory_file;
1087 break;
1088 case detail::IME_SymbolicLink:
1089 if (auto SymlinkTarget =
1090 FS->lookupNode(Path, /*FollowFinalSymlink=*/true)) {
1091 Path = SymlinkTarget.getName();
1092 Type = (*SymlinkTarget)->getStatus(Path).getType();
1093 }
1094 break;
1095 }
1096 CurrentEntry = directory_entry(std::string(Path.str()), Type);
1097 } else {
1098 // When we're at the end, make CurrentEntry invalid and DirIterImpl will
1099 // do the rest.
1100 CurrentEntry = directory_entry();
1101 }
1102 }
1103
1104public:
1105 DirIterator() = default;
1106
1107 DirIterator(const InMemoryFileSystem *FS,
1108 const detail::InMemoryDirectory &Dir,
1109 std::string RequestedDirName)
1110 : FS(FS), I(Dir.begin()), E(Dir.end()),
1111 RequestedDirName(std::move(RequestedDirName)) {
1112 setCurrentEntry();
1113 }
1114
1115 std::error_code increment() override {
1116 ++I;
1117 setCurrentEntry();
1118 return {};
1119 }
1120};
1121
1122directory_iterator InMemoryFileSystem::dir_begin(const Twine &Dir,
1123 std::error_code &EC) {
1124 auto Node = lookupNode(Dir, /*FollowFinalSymlink=*/true);
1125 if (!Node) {
1126 EC = Node.getError();
1127 return directory_iterator(std::make_shared<DirIterator>());
1128 }
1129
1130 if (auto *DirNode = dyn_cast<detail::InMemoryDirectory>(*Node))
1131 return directory_iterator(
1132 std::make_shared<DirIterator>(this, *DirNode, Dir.str()));
1133
1134 EC = make_error_code(llvm::errc::not_a_directory);
1135 return directory_iterator(std::make_shared<DirIterator>());
1136}
1137
1138std::error_code InMemoryFileSystem::setCurrentWorkingDirectory(const Twine &P) {
1139 SmallString<128> Path;
1140 P.toVector(Path);
1141
1142 // Fix up relative paths. This just prepends the current working directory.
1143 std::error_code EC = makeAbsolute(Path);
1144 assert(!EC)(static_cast <bool> (!EC) ? void (0) : __assert_fail ("!EC"
, "llvm/lib/Support/VirtualFileSystem.cpp", 1144, __extension__
__PRETTY_FUNCTION__))
;
1145 (void)EC;
1146
1147 if (useNormalizedPaths())
1148 llvm::sys::path::remove_dots(Path, /*remove_dot_dot=*/true);
1149
1150 if (!Path.empty())
1151 WorkingDirectory = std::string(Path.str());
1152 return {};
1153}
1154
1155std::error_code
1156InMemoryFileSystem::getRealPath(const Twine &Path,
1157 SmallVectorImpl<char> &Output) const {
1158 auto CWD = getCurrentWorkingDirectory();
1159 if (!CWD || CWD->empty())
1160 return errc::operation_not_permitted;
1161 Path.toVector(Output);
1162 if (auto EC = makeAbsolute(Output))
1163 return EC;
1164 llvm::sys::path::remove_dots(Output, /*remove_dot_dot=*/true);
1165 return {};
1166}
1167
1168std::error_code InMemoryFileSystem::isLocal(const Twine &Path, bool &Result) {
1169 Result = false;
1170 return {};
1171}
1172
1173void InMemoryFileSystem::printImpl(raw_ostream &OS, PrintType PrintContents,
1174 unsigned IndentLevel) const {
1175 printIndent(OS, IndentLevel);
1176 OS << "InMemoryFileSystem\n";
1177}
1178
1179} // namespace vfs
1180} // namespace llvm
1181
1182//===-----------------------------------------------------------------------===/
1183// RedirectingFileSystem implementation
1184//===-----------------------------------------------------------------------===/
1185
1186namespace {
1187
1188static llvm::sys::path::Style getExistingStyle(llvm::StringRef Path) {
1189 // Detect the path style in use by checking the first separator.
1190 llvm::sys::path::Style style = llvm::sys::path::Style::native;
1191 const size_t n = Path.find_first_of("/\\");
1192 // Can't distinguish between posix and windows_slash here.
1193 if (n != static_cast<size_t>(-1))
1194 style = (Path[n] == '/') ? llvm::sys::path::Style::posix
1195 : llvm::sys::path::Style::windows_backslash;
1196 return style;
1197}
1198
1199/// Removes leading "./" as well as path components like ".." and ".".
1200static llvm::SmallString<256> canonicalize(llvm::StringRef Path) {
1201 // First detect the path style in use by checking the first separator.
1202 llvm::sys::path::Style style = getExistingStyle(Path);
1203
1204 // Now remove the dots. Explicitly specifying the path style prevents the
1205 // direction of the slashes from changing.
1206 llvm::SmallString<256> result =
1207 llvm::sys::path::remove_leading_dotslash(Path, style);
1208 llvm::sys::path::remove_dots(result, /*remove_dot_dot=*/true, style);
1209 return result;
1210}
1211
1212/// Whether the error and entry specify a file/directory that was not found.
1213static bool isFileNotFound(std::error_code EC,
1214 RedirectingFileSystem::Entry *E = nullptr) {
1215 if (E && !isa<RedirectingFileSystem::DirectoryRemapEntry>(E))
1216 return false;
1217 return EC == llvm::errc::no_such_file_or_directory;
1218}
1219
1220} // anonymous namespace
1221
1222
1223RedirectingFileSystem::RedirectingFileSystem(IntrusiveRefCntPtr<FileSystem> FS)
1224 : ExternalFS(std::move(FS)) {
1225 if (ExternalFS)
1226 if (auto ExternalWorkingDirectory =
1227 ExternalFS->getCurrentWorkingDirectory()) {
1228 WorkingDirectory = *ExternalWorkingDirectory;
1229 }
1230}
1231
1232/// Directory iterator implementation for \c RedirectingFileSystem's
1233/// directory entries.
1234class llvm::vfs::RedirectingFSDirIterImpl
1235 : public llvm::vfs::detail::DirIterImpl {
1236 std::string Dir;
1237 RedirectingFileSystem::DirectoryEntry::iterator Current, End;
1238
1239 std::error_code incrementImpl(bool IsFirstTime) {
1240 assert((IsFirstTime || Current != End) && "cannot iterate past end")(static_cast <bool> ((IsFirstTime || Current != End) &&
"cannot iterate past end") ? void (0) : __assert_fail ("(IsFirstTime || Current != End) && \"cannot iterate past end\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 1240, __extension__
__PRETTY_FUNCTION__))
;
1241 if (!IsFirstTime)
1242 ++Current;
1243 if (Current != End) {
1244 SmallString<128> PathStr(Dir);
1245 llvm::sys::path::append(PathStr, (*Current)->getName());
1246 sys::fs::file_type Type = sys::fs::file_type::type_unknown;
1247 switch ((*Current)->getKind()) {
1248 case RedirectingFileSystem::EK_Directory:
1249 [[fallthrough]];
1250 case RedirectingFileSystem::EK_DirectoryRemap:
1251 Type = sys::fs::file_type::directory_file;
1252 break;
1253 case RedirectingFileSystem::EK_File:
1254 Type = sys::fs::file_type::regular_file;
1255 break;
1256 }
1257 CurrentEntry = directory_entry(std::string(PathStr.str()), Type);
1258 } else {
1259 CurrentEntry = directory_entry();
1260 }
1261 return {};
1262 };
1263
1264public:
1265 RedirectingFSDirIterImpl(
1266 const Twine &Path, RedirectingFileSystem::DirectoryEntry::iterator Begin,
1267 RedirectingFileSystem::DirectoryEntry::iterator End, std::error_code &EC)
1268 : Dir(Path.str()), Current(Begin), End(End) {
1269 EC = incrementImpl(/*IsFirstTime=*/true);
1270 }
1271
1272 std::error_code increment() override {
1273 return incrementImpl(/*IsFirstTime=*/false);
1274 }
1275};
1276
1277namespace {
1278/// Directory iterator implementation for \c RedirectingFileSystem's
1279/// directory remap entries that maps the paths reported by the external
1280/// file system's directory iterator back to the virtual directory's path.
1281class RedirectingFSDirRemapIterImpl : public llvm::vfs::detail::DirIterImpl {
1282 std::string Dir;
1283 llvm::sys::path::Style DirStyle;
1284 llvm::vfs::directory_iterator ExternalIter;
1285
1286public:
1287 RedirectingFSDirRemapIterImpl(std::string DirPath,
1288 llvm::vfs::directory_iterator ExtIter)
1289 : Dir(std::move(DirPath)), DirStyle(getExistingStyle(Dir)),
1290 ExternalIter(ExtIter) {
1291 if (ExternalIter != llvm::vfs::directory_iterator())
1292 setCurrentEntry();
1293 }
1294
1295 void setCurrentEntry() {
1296 StringRef ExternalPath = ExternalIter->path();
1297 llvm::sys::path::Style ExternalStyle = getExistingStyle(ExternalPath);
1298 StringRef File = llvm::sys::path::filename(ExternalPath, ExternalStyle);
1299
1300 SmallString<128> NewPath(Dir);
1301 llvm::sys::path::append(NewPath, DirStyle, File);
1302
1303 CurrentEntry = directory_entry(std::string(NewPath), ExternalIter->type());
1304 }
1305
1306 std::error_code increment() override {
1307 std::error_code EC;
1308 ExternalIter.increment(EC);
1309 if (!EC && ExternalIter != llvm::vfs::directory_iterator())
1310 setCurrentEntry();
1311 else
1312 CurrentEntry = directory_entry();
1313 return EC;
1314 }
1315};
1316} // namespace
1317
1318llvm::ErrorOr<std::string>
1319RedirectingFileSystem::getCurrentWorkingDirectory() const {
1320 return WorkingDirectory;
1321}
1322
1323std::error_code
1324RedirectingFileSystem::setCurrentWorkingDirectory(const Twine &Path) {
1325 // Don't change the working directory if the path doesn't exist.
1326 if (!exists(Path))
1327 return errc::no_such_file_or_directory;
1328
1329 SmallString<128> AbsolutePath;
1330 Path.toVector(AbsolutePath);
1331 if (std::error_code EC = makeAbsolute(AbsolutePath))
1332 return EC;
1333 WorkingDirectory = std::string(AbsolutePath.str());
1334 return {};
1335}
1336
1337std::error_code RedirectingFileSystem::isLocal(const Twine &Path_,
1338 bool &Result) {
1339 SmallString<256> Path;
1340 Path_.toVector(Path);
1341
1342 if (std::error_code EC = makeCanonical(Path))
1343 return {};
1344
1345 return ExternalFS->isLocal(Path, Result);
1346}
1347
1348std::error_code RedirectingFileSystem::makeAbsolute(SmallVectorImpl<char> &Path) const {
1349 // is_absolute(..., Style::windows_*) accepts paths with both slash types.
1350 if (llvm::sys::path::is_absolute(Path, llvm::sys::path::Style::posix) ||
1351 llvm::sys::path::is_absolute(Path,
1352 llvm::sys::path::Style::windows_backslash))
1353 return {};
1354
1355 auto WorkingDir = getCurrentWorkingDirectory();
1356 if (!WorkingDir)
1357 return WorkingDir.getError();
1358
1359 // We can't use sys::fs::make_absolute because that assumes the path style
1360 // is native and there is no way to override that. Since we know WorkingDir
1361 // is absolute, we can use it to determine which style we actually have and
1362 // append Path ourselves.
1363 sys::path::Style style = sys::path::Style::windows_backslash;
1364 if (sys::path::is_absolute(WorkingDir.get(), sys::path::Style::posix)) {
1365 style = sys::path::Style::posix;
1366 } else {
1367 // Distinguish between windows_backslash and windows_slash; getExistingStyle
1368 // returns posix for a path with windows_slash.
1369 if (getExistingStyle(WorkingDir.get()) !=
1370 sys::path::Style::windows_backslash)
1371 style = sys::path::Style::windows_slash;
1372 }
1373
1374 std::string Result = WorkingDir.get();
1375 StringRef Dir(Result);
1376 if (!Dir.endswith(sys::path::get_separator(style))) {
1377 Result += sys::path::get_separator(style);
1378 }
1379 Result.append(Path.data(), Path.size());
1380 Path.assign(Result.begin(), Result.end());
1381
1382 return {};
1383}
1384
1385directory_iterator RedirectingFileSystem::dir_begin(const Twine &Dir,
1386 std::error_code &EC) {
1387 SmallString<256> Path;
1388 Dir.toVector(Path);
1389
1390 EC = makeCanonical(Path);
1391 if (EC)
1392 return {};
1393
1394 ErrorOr<RedirectingFileSystem::LookupResult> Result = lookupPath(Path);
1395 if (!Result) {
1396 if (Redirection != RedirectKind::RedirectOnly &&
1397 isFileNotFound(Result.getError()))
1398 return ExternalFS->dir_begin(Path, EC);
1399
1400 EC = Result.getError();
1401 return {};
1402 }
1403
1404 // Use status to make sure the path exists and refers to a directory.
1405 ErrorOr<Status> S = status(Path, Dir, *Result);
1406 if (!S) {
1407 if (Redirection != RedirectKind::RedirectOnly &&
1408 isFileNotFound(S.getError(), Result->E))
1409 return ExternalFS->dir_begin(Dir, EC);
1410
1411 EC = S.getError();
1412 return {};
1413 }
1414
1415 if (!S->isDirectory()) {
1416 EC = errc::not_a_directory;
1417 return {};
1418 }
1419
1420 // Create the appropriate directory iterator based on whether we found a
1421 // DirectoryRemapEntry or DirectoryEntry.
1422 directory_iterator RedirectIter;
1423 std::error_code RedirectEC;
1424 if (auto ExtRedirect = Result->getExternalRedirect()) {
1425 auto RE = cast<RedirectingFileSystem::RemapEntry>(Result->E);
1426 RedirectIter = ExternalFS->dir_begin(*ExtRedirect, RedirectEC);
1427
1428 if (!RE->useExternalName(UseExternalNames)) {
1429 // Update the paths in the results to use the virtual directory's path.
1430 RedirectIter =
1431 directory_iterator(std::make_shared<RedirectingFSDirRemapIterImpl>(
1432 std::string(Path), RedirectIter));
1433 }
1434 } else {
1435 auto DE = cast<DirectoryEntry>(Result->E);
1436 RedirectIter =
1437 directory_iterator(std::make_shared<RedirectingFSDirIterImpl>(
1438 Path, DE->contents_begin(), DE->contents_end(), RedirectEC));
1439 }
1440
1441 if (RedirectEC) {
1442 if (RedirectEC != errc::no_such_file_or_directory) {
1443 EC = RedirectEC;
1444 return {};
1445 }
1446 RedirectIter = {};
1447 }
1448
1449 if (Redirection == RedirectKind::RedirectOnly) {
1450 EC = RedirectEC;
1451 return RedirectIter;
1452 }
1453
1454 std::error_code ExternalEC;
1455 directory_iterator ExternalIter = ExternalFS->dir_begin(Path, ExternalEC);
1456 if (ExternalEC) {
1457 if (ExternalEC != errc::no_such_file_or_directory) {
1458 EC = ExternalEC;
1459 return {};
1460 }
1461 ExternalIter = {};
1462 }
1463
1464 SmallVector<directory_iterator, 2> Iters;
1465 switch (Redirection) {
1466 case RedirectKind::Fallthrough:
1467 Iters.push_back(ExternalIter);
1468 Iters.push_back(RedirectIter);
1469 break;
1470 case RedirectKind::Fallback:
1471 Iters.push_back(RedirectIter);
1472 Iters.push_back(ExternalIter);
1473 break;
1474 default:
1475 llvm_unreachable("unhandled RedirectKind")::llvm::llvm_unreachable_internal("unhandled RedirectKind", "llvm/lib/Support/VirtualFileSystem.cpp"
, 1475)
;
1476 }
1477
1478 directory_iterator Combined{
1479 std::make_shared<CombiningDirIterImpl>(Iters, EC)};
1480 if (EC)
1481 return {};
1482 return Combined;
1483}
1484
1485void RedirectingFileSystem::setExternalContentsPrefixDir(StringRef PrefixDir) {
1486 ExternalContentsPrefixDir = PrefixDir.str();
1487}
1488
1489StringRef RedirectingFileSystem::getExternalContentsPrefixDir() const {
1490 return ExternalContentsPrefixDir;
1491}
1492
1493void RedirectingFileSystem::setFallthrough(bool Fallthrough) {
1494 if (Fallthrough) {
1495 Redirection = RedirectingFileSystem::RedirectKind::Fallthrough;
1496 } else {
1497 Redirection = RedirectingFileSystem::RedirectKind::RedirectOnly;
1498 }
1499}
1500
1501void RedirectingFileSystem::setRedirection(
1502 RedirectingFileSystem::RedirectKind Kind) {
1503 Redirection = Kind;
1504}
1505
1506std::vector<StringRef> RedirectingFileSystem::getRoots() const {
1507 std::vector<StringRef> R;
1508 for (const auto &Root : Roots)
1509 R.push_back(Root->getName());
1510 return R;
1511}
1512
1513void RedirectingFileSystem::printImpl(raw_ostream &OS, PrintType Type,
1514 unsigned IndentLevel) const {
1515 printIndent(OS, IndentLevel);
1516 OS << "RedirectingFileSystem (UseExternalNames: "
1517 << (UseExternalNames ? "true" : "false") << ")\n";
1518 if (Type == PrintType::Summary)
1519 return;
1520
1521 for (const auto &Root : Roots)
1522 printEntry(OS, Root.get(), IndentLevel);
1523
1524 printIndent(OS, IndentLevel);
1525 OS << "ExternalFS:\n";
1526 ExternalFS->print(OS, Type == PrintType::Contents ? PrintType::Summary : Type,
1527 IndentLevel + 1);
1528}
1529
1530void RedirectingFileSystem::printEntry(raw_ostream &OS,
1531 RedirectingFileSystem::Entry *E,
1532 unsigned IndentLevel) const {
1533 printIndent(OS, IndentLevel);
1534 OS << "'" << E->getName() << "'";
1535
1536 switch (E->getKind()) {
1537 case EK_Directory: {
1538 auto *DE = cast<RedirectingFileSystem::DirectoryEntry>(E);
1539
1540 OS << "\n";
1541 for (std::unique_ptr<Entry> &SubEntry :
1542 llvm::make_range(DE->contents_begin(), DE->contents_end()))
1543 printEntry(OS, SubEntry.get(), IndentLevel + 1);
1544 break;
1545 }
1546 case EK_DirectoryRemap:
1547 case EK_File: {
1548 auto *RE = cast<RedirectingFileSystem::RemapEntry>(E);
1549 OS << " -> '" << RE->getExternalContentsPath() << "'";
1550 switch (RE->getUseName()) {
1551 case NK_NotSet:
1552 break;
1553 case NK_External:
1554 OS << " (UseExternalName: true)";
1555 break;
1556 case NK_Virtual:
1557 OS << " (UseExternalName: false)";
1558 break;
1559 }
1560 OS << "\n";
1561 break;
1562 }
1563 }
1564}
1565
1566/// A helper class to hold the common YAML parsing state.
1567class llvm::vfs::RedirectingFileSystemParser {
1568 yaml::Stream &Stream;
1569
1570 void error(yaml::Node *N, const Twine &Msg) { Stream.printError(N, Msg); }
1571
1572 // false on error
1573 bool parseScalarString(yaml::Node *N, StringRef &Result,
1574 SmallVectorImpl<char> &Storage) {
1575 const auto *S = dyn_cast<yaml::ScalarNode>(N);
1576
1577 if (!S) {
1578 error(N, "expected string");
1579 return false;
1580 }
1581 Result = S->getValue(Storage);
1582 return true;
1583 }
1584
1585 // false on error
1586 bool parseScalarBool(yaml::Node *N, bool &Result) {
1587 SmallString<5> Storage;
1588 StringRef Value;
1589 if (!parseScalarString(N, Value, Storage))
1590 return false;
1591
1592 if (Value.equals_insensitive("true") || Value.equals_insensitive("on") ||
1593 Value.equals_insensitive("yes") || Value == "1") {
1594 Result = true;
1595 return true;
1596 } else if (Value.equals_insensitive("false") ||
1597 Value.equals_insensitive("off") ||
1598 Value.equals_insensitive("no") || Value == "0") {
1599 Result = false;
1600 return true;
1601 }
1602
1603 error(N, "expected boolean value");
1604 return false;
1605 }
1606
1607 Optional<RedirectingFileSystem::RedirectKind>
1608 parseRedirectKind(yaml::Node *N) {
1609 SmallString<12> Storage;
1610 StringRef Value;
1611 if (!parseScalarString(N, Value, Storage))
1612 return None;
1613
1614 if (Value.equals_insensitive("fallthrough")) {
1615 return RedirectingFileSystem::RedirectKind::Fallthrough;
1616 } else if (Value.equals_insensitive("fallback")) {
1617 return RedirectingFileSystem::RedirectKind::Fallback;
1618 } else if (Value.equals_insensitive("redirect-only")) {
1619 return RedirectingFileSystem::RedirectKind::RedirectOnly;
1620 }
1621 return None;
1622 }
1623
1624 struct KeyStatus {
1625 bool Required;
1626 bool Seen = false;
1627
1628 KeyStatus(bool Required = false) : Required(Required) {}
1629 };
1630
1631 using KeyStatusPair = std::pair<StringRef, KeyStatus>;
1632
1633 // false on error
1634 bool checkDuplicateOrUnknownKey(yaml::Node *KeyNode, StringRef Key,
1635 DenseMap<StringRef, KeyStatus> &Keys) {
1636 if (!Keys.count(Key)) {
1637 error(KeyNode, "unknown key");
1638 return false;
1639 }
1640 KeyStatus &S = Keys[Key];
1641 if (S.Seen) {
1642 error(KeyNode, Twine("duplicate key '") + Key + "'");
1643 return false;
1644 }
1645 S.Seen = true;
1646 return true;
1647 }
1648
1649 // false on error
1650 bool checkMissingKeys(yaml::Node *Obj, DenseMap<StringRef, KeyStatus> &Keys) {
1651 for (const auto &I : Keys) {
1652 if (I.second.Required && !I.second.Seen) {
1653 error(Obj, Twine("missing key '") + I.first + "'");
1654 return false;
1655 }
1656 }
1657 return true;
1658 }
1659
1660public:
1661 static RedirectingFileSystem::Entry *
1662 lookupOrCreateEntry(RedirectingFileSystem *FS, StringRef Name,
1663 RedirectingFileSystem::Entry *ParentEntry = nullptr) {
1664 if (!ParentEntry) { // Look for a existent root
1665 for (const auto &Root : FS->Roots) {
1666 if (Name.equals(Root->getName())) {
1667 ParentEntry = Root.get();
1668 return ParentEntry;
1669 }
1670 }
1671 } else { // Advance to the next component
1672 auto *DE = dyn_cast<RedirectingFileSystem::DirectoryEntry>(ParentEntry);
1673 for (std::unique_ptr<RedirectingFileSystem::Entry> &Content :
1674 llvm::make_range(DE->contents_begin(), DE->contents_end())) {
1675 auto *DirContent =
1676 dyn_cast<RedirectingFileSystem::DirectoryEntry>(Content.get());
1677 if (DirContent && Name.equals(Content->getName()))
1678 return DirContent;
1679 }
1680 }
1681
1682 // ... or create a new one
1683 std::unique_ptr<RedirectingFileSystem::Entry> E =
1684 std::make_unique<RedirectingFileSystem::DirectoryEntry>(
1685 Name, Status("", getNextVirtualUniqueID(),
1686 std::chrono::system_clock::now(), 0, 0, 0,
1687 file_type::directory_file, sys::fs::all_all));
1688
1689 if (!ParentEntry) { // Add a new root to the overlay
1690 FS->Roots.push_back(std::move(E));
1691 ParentEntry = FS->Roots.back().get();
1692 return ParentEntry;
1693 }
1694
1695 auto *DE = cast<RedirectingFileSystem::DirectoryEntry>(ParentEntry);
1696 DE->addContent(std::move(E));
1697 return DE->getLastContent();
1698 }
1699
1700private:
1701 void uniqueOverlayTree(RedirectingFileSystem *FS,
1702 RedirectingFileSystem::Entry *SrcE,
1703 RedirectingFileSystem::Entry *NewParentE = nullptr) {
1704 StringRef Name = SrcE->getName();
1705 switch (SrcE->getKind()) {
1706 case RedirectingFileSystem::EK_Directory: {
1707 auto *DE = cast<RedirectingFileSystem::DirectoryEntry>(SrcE);
1708 // Empty directories could be present in the YAML as a way to
1709 // describe a file for a current directory after some of its subdir
1710 // is parsed. This only leads to redundant walks, ignore it.
1711 if (!Name.empty())
1712 NewParentE = lookupOrCreateEntry(FS, Name, NewParentE);
1713 for (std::unique_ptr<RedirectingFileSystem::Entry> &SubEntry :
1714 llvm::make_range(DE->contents_begin(), DE->contents_end()))
1715 uniqueOverlayTree(FS, SubEntry.get(), NewParentE);
1716 break;
1717 }
1718 case RedirectingFileSystem::EK_DirectoryRemap: {
1719 assert(NewParentE && "Parent entry must exist")(static_cast <bool> (NewParentE && "Parent entry must exist"
) ? void (0) : __assert_fail ("NewParentE && \"Parent entry must exist\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 1719, __extension__
__PRETTY_FUNCTION__))
;
1720 auto *DR = cast<RedirectingFileSystem::DirectoryRemapEntry>(SrcE);
1721 auto *DE = cast<RedirectingFileSystem::DirectoryEntry>(NewParentE);
1722 DE->addContent(
1723 std::make_unique<RedirectingFileSystem::DirectoryRemapEntry>(
1724 Name, DR->getExternalContentsPath(), DR->getUseName()));
1725 break;
1726 }
1727 case RedirectingFileSystem::EK_File: {
1728 assert(NewParentE && "Parent entry must exist")(static_cast <bool> (NewParentE && "Parent entry must exist"
) ? void (0) : __assert_fail ("NewParentE && \"Parent entry must exist\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 1728, __extension__
__PRETTY_FUNCTION__))
;
1729 auto *FE = cast<RedirectingFileSystem::FileEntry>(SrcE);
1730 auto *DE = cast<RedirectingFileSystem::DirectoryEntry>(NewParentE);
1731 DE->addContent(std::make_unique<RedirectingFileSystem::FileEntry>(
1732 Name, FE->getExternalContentsPath(), FE->getUseName()));
1733 break;
1734 }
1735 }
1736 }
1737
1738 std::unique_ptr<RedirectingFileSystem::Entry>
1739 parseEntry(yaml::Node *N, RedirectingFileSystem *FS, bool IsRootEntry) {
1740 auto *M = dyn_cast<yaml::MappingNode>(N);
1
Assuming 'N' is a 'CastReturnType'
1741 if (!M
1.1
'M' is non-null
) {
2
Taking false branch
1742 error(N, "expected mapping node for file or directory entry");
1743 return nullptr;
1744 }
1745
1746 KeyStatusPair Fields[] = {
1747 KeyStatusPair("name", true),
1748 KeyStatusPair("type", true),
1749 KeyStatusPair("contents", false),
1750 KeyStatusPair("external-contents", false),
1751 KeyStatusPair("use-external-name", false),
1752 };
1753
1754 DenseMap<StringRef, KeyStatus> Keys(std::begin(Fields), std::end(Fields));
1755
1756 enum { CF_NotSet, CF_List, CF_External } ContentsField = CF_NotSet;
1757 std::vector<std::unique_ptr<RedirectingFileSystem::Entry>>
1758 EntryArrayContents;
1759 SmallString<256> ExternalContentsPath;
1760 SmallString<256> Name;
1761 yaml::Node *NameValueNode = nullptr;
1762 auto UseExternalName = RedirectingFileSystem::NK_NotSet;
1763 RedirectingFileSystem::EntryKind Kind;
3
'Kind' declared without an initial value
1764
1765 for (auto &I : *M) {
1766 StringRef Key;
1767 // Reuse the buffer for key and value, since we don't look at key after
1768 // parsing value.
1769 SmallString<256> Buffer;
1770 if (!parseScalarString(I.getKey(), Key, Buffer))
4
Taking false branch
1771 return nullptr;
1772
1773 if (!checkDuplicateOrUnknownKey(I.getKey(), Key, Keys))
5
Taking false branch
1774 return nullptr;
1775
1776 StringRef Value;
1777 if (Key == "name") {
6
Assuming the condition is false
7
Taking false branch
1778 if (!parseScalarString(I.getValue(), Value, Buffer))
1779 return nullptr;
1780
1781 NameValueNode = I.getValue();
1782 // Guarantee that old YAML files containing paths with ".." and "."
1783 // are properly canonicalized before read into the VFS.
1784 Name = canonicalize(Value).str();
1785 } else if (Key == "type") {
8
Assuming the condition is false
9
Taking false branch
1786 if (!parseScalarString(I.getValue(), Value, Buffer))
1787 return nullptr;
1788 if (Value == "file")
1789 Kind = RedirectingFileSystem::EK_File;
1790 else if (Value == "directory")
1791 Kind = RedirectingFileSystem::EK_Directory;
1792 else if (Value == "directory-remap")
1793 Kind = RedirectingFileSystem::EK_DirectoryRemap;
1794 else {
1795 error(I.getValue(), "unknown value for 'type'");
1796 return nullptr;
1797 }
1798 } else if (Key == "contents") {
10
Assuming the condition is true
11
Taking true branch
1799 if (ContentsField
11.1
'ContentsField' is equal to CF_NotSet
!= CF_NotSet) {
12
Taking false branch
1800 error(I.getKey(),
1801 "entry already has 'contents' or 'external-contents'");
1802 return nullptr;
1803 }
1804 ContentsField = CF_List;
1805 auto *Contents = dyn_cast<yaml::SequenceNode>(I.getValue());
13
Assuming the object is a 'CastReturnType'
1806 if (!Contents
13.1
'Contents' is non-null
) {
14
Taking false branch
1807 // FIXME: this is only for directories, what about files?
1808 error(I.getValue(), "expected array");
1809 return nullptr;
1810 }
1811
1812 for (auto &I : *Contents) {
1813 if (std::unique_ptr<RedirectingFileSystem::Entry> E =
1814 parseEntry(&I, FS, /*IsRootEntry*/ false))
1815 EntryArrayContents.push_back(std::move(E));
1816 else
1817 return nullptr;
1818 }
1819 } else if (Key == "external-contents") {
1820 if (ContentsField != CF_NotSet) {
1821 error(I.getKey(),
1822 "entry already has 'contents' or 'external-contents'");
1823 return nullptr;
1824 }
1825 ContentsField = CF_External;
1826 if (!parseScalarString(I.getValue(), Value, Buffer))
1827 return nullptr;
1828
1829 SmallString<256> FullPath;
1830 if (FS->IsRelativeOverlay) {
1831 FullPath = FS->getExternalContentsPrefixDir();
1832 assert(!FullPath.empty() &&(static_cast <bool> (!FullPath.empty() && "External contents prefix directory must exist"
) ? void (0) : __assert_fail ("!FullPath.empty() && \"External contents prefix directory must exist\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 1833, __extension__
__PRETTY_FUNCTION__))
1833 "External contents prefix directory must exist")(static_cast <bool> (!FullPath.empty() && "External contents prefix directory must exist"
) ? void (0) : __assert_fail ("!FullPath.empty() && \"External contents prefix directory must exist\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 1833, __extension__
__PRETTY_FUNCTION__))
;
1834 llvm::sys::path::append(FullPath, Value);
1835 } else {
1836 FullPath = Value;
1837 }
1838
1839 // Guarantee that old YAML files containing paths with ".." and "."
1840 // are properly canonicalized before read into the VFS.
1841 FullPath = canonicalize(FullPath);
1842 ExternalContentsPath = FullPath.str();
1843 } else if (Key == "use-external-name") {
1844 bool Val;
1845 if (!parseScalarBool(I.getValue(), Val))
1846 return nullptr;
1847 UseExternalName = Val ? RedirectingFileSystem::NK_External
1848 : RedirectingFileSystem::NK_Virtual;
1849 } else {
1850 llvm_unreachable("key missing from Keys")::llvm::llvm_unreachable_internal("key missing from Keys", "llvm/lib/Support/VirtualFileSystem.cpp"
, 1850)
;
1851 }
1852 }
1853
1854 if (Stream.failed())
15
Assuming the condition is false
16
Taking false branch
1855 return nullptr;
1856
1857 // check for missing keys
1858 if (ContentsField
16.1
'ContentsField' is not equal to CF_NotSet
== CF_NotSet) {
17
Taking false branch
1859 error(N, "missing key 'contents' or 'external-contents'");
1860 return nullptr;
1861 }
1862 if (!checkMissingKeys(N, Keys))
18
Assuming the condition is false
1863 return nullptr;
1864
1865 // check invalid configuration
1866 if (Kind == RedirectingFileSystem::EK_Directory &&
19
The left operand of '==' is a garbage value
1867 UseExternalName != RedirectingFileSystem::NK_NotSet) {
1868 error(N, "'use-external-name' is not supported for 'directory' entries");
1869 return nullptr;
1870 }
1871
1872 if (Kind == RedirectingFileSystem::EK_DirectoryRemap &&
1873 ContentsField == CF_List) {
1874 error(N, "'contents' is not supported for 'directory-remap' entries");
1875 return nullptr;
1876 }
1877
1878 sys::path::Style path_style = sys::path::Style::native;
1879 if (IsRootEntry) {
1880 // VFS root entries may be in either Posix or Windows style. Figure out
1881 // which style we have, and use it consistently.
1882 if (sys::path::is_absolute(Name, sys::path::Style::posix)) {
1883 path_style = sys::path::Style::posix;
1884 } else if (sys::path::is_absolute(Name,
1885 sys::path::Style::windows_backslash)) {
1886 path_style = sys::path::Style::windows_backslash;
1887 } else {
1888 // Relative VFS root entries are made absolute to the current working
1889 // directory, then we can determine the path style from that.
1890 auto EC = sys::fs::make_absolute(Name);
1891 if (EC) {
1892 assert(NameValueNode && "Name presence should be checked earlier")(static_cast <bool> (NameValueNode && "Name presence should be checked earlier"
) ? void (0) : __assert_fail ("NameValueNode && \"Name presence should be checked earlier\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 1892, __extension__
__PRETTY_FUNCTION__))
;
1893 error(
1894 NameValueNode,
1895 "entry with relative path at the root level is not discoverable");
1896 return nullptr;
1897 }
1898 path_style = sys::path::is_absolute(Name, sys::path::Style::posix)
1899 ? sys::path::Style::posix
1900 : sys::path::Style::windows_backslash;
1901 }
1902 }
1903
1904 // Remove trailing slash(es), being careful not to remove the root path
1905 StringRef Trimmed = Name;
1906 size_t RootPathLen = sys::path::root_path(Trimmed, path_style).size();
1907 while (Trimmed.size() > RootPathLen &&
1908 sys::path::is_separator(Trimmed.back(), path_style))
1909 Trimmed = Trimmed.slice(0, Trimmed.size() - 1);
1910
1911 // Get the last component
1912 StringRef LastComponent = sys::path::filename(Trimmed, path_style);
1913
1914 std::unique_ptr<RedirectingFileSystem::Entry> Result;
1915 switch (Kind) {
1916 case RedirectingFileSystem::EK_File:
1917 Result = std::make_unique<RedirectingFileSystem::FileEntry>(
1918 LastComponent, std::move(ExternalContentsPath), UseExternalName);
1919 break;
1920 case RedirectingFileSystem::EK_DirectoryRemap:
1921 Result = std::make_unique<RedirectingFileSystem::DirectoryRemapEntry>(
1922 LastComponent, std::move(ExternalContentsPath), UseExternalName);
1923 break;
1924 case RedirectingFileSystem::EK_Directory:
1925 Result = std::make_unique<RedirectingFileSystem::DirectoryEntry>(
1926 LastComponent, std::move(EntryArrayContents),
1927 Status("", getNextVirtualUniqueID(), std::chrono::system_clock::now(),
1928 0, 0, 0, file_type::directory_file, sys::fs::all_all));
1929 break;
1930 }
1931
1932 StringRef Parent = sys::path::parent_path(Trimmed, path_style);
1933 if (Parent.empty())
1934 return Result;
1935
1936 // if 'name' contains multiple components, create implicit directory entries
1937 for (sys::path::reverse_iterator I = sys::path::rbegin(Parent, path_style),
1938 E = sys::path::rend(Parent);
1939 I != E; ++I) {
1940 std::vector<std::unique_ptr<RedirectingFileSystem::Entry>> Entries;
1941 Entries.push_back(std::move(Result));
1942 Result = std::make_unique<RedirectingFileSystem::DirectoryEntry>(
1943 *I, std::move(Entries),
1944 Status("", getNextVirtualUniqueID(), std::chrono::system_clock::now(),
1945 0, 0, 0, file_type::directory_file, sys::fs::all_all));
1946 }
1947 return Result;
1948 }
1949
1950public:
1951 RedirectingFileSystemParser(yaml::Stream &S) : Stream(S) {}
1952
1953 // false on error
1954 bool parse(yaml::Node *Root, RedirectingFileSystem *FS) {
1955 auto *Top = dyn_cast<yaml::MappingNode>(Root);
1956 if (!Top) {
1957 error(Root, "expected mapping node");
1958 return false;
1959 }
1960
1961 KeyStatusPair Fields[] = {
1962 KeyStatusPair("version", true),
1963 KeyStatusPair("case-sensitive", false),
1964 KeyStatusPair("use-external-names", false),
1965 KeyStatusPair("overlay-relative", false),
1966 KeyStatusPair("fallthrough", false),
1967 KeyStatusPair("redirecting-with", false),
1968 KeyStatusPair("roots", true),
1969 };
1970
1971 DenseMap<StringRef, KeyStatus> Keys(std::begin(Fields), std::end(Fields));
1972 std::vector<std::unique_ptr<RedirectingFileSystem::Entry>> RootEntries;
1973
1974 // Parse configuration and 'roots'
1975 for (auto &I : *Top) {
1976 SmallString<10> KeyBuffer;
1977 StringRef Key;
1978 if (!parseScalarString(I.getKey(), Key, KeyBuffer))
1979 return false;
1980
1981 if (!checkDuplicateOrUnknownKey(I.getKey(), Key, Keys))
1982 return false;
1983
1984 if (Key == "roots") {
1985 auto *Roots = dyn_cast<yaml::SequenceNode>(I.getValue());
1986 if (!Roots) {
1987 error(I.getValue(), "expected array");
1988 return false;
1989 }
1990
1991 for (auto &I : *Roots) {
1992 if (std::unique_ptr<RedirectingFileSystem::Entry> E =
1993 parseEntry(&I, FS, /*IsRootEntry*/ true))
1994 RootEntries.push_back(std::move(E));
1995 else
1996 return false;
1997 }
1998 } else if (Key == "version") {
1999 StringRef VersionString;
2000 SmallString<4> Storage;
2001 if (!parseScalarString(I.getValue(), VersionString, Storage))
2002 return false;
2003 int Version;
2004 if (VersionString.getAsInteger<int>(10, Version)) {
2005 error(I.getValue(), "expected integer");
2006 return false;
2007 }
2008 if (Version < 0) {
2009 error(I.getValue(), "invalid version number");
2010 return false;
2011 }
2012 if (Version != 0) {
2013 error(I.getValue(), "version mismatch, expected 0");
2014 return false;
2015 }
2016 } else if (Key == "case-sensitive") {
2017 if (!parseScalarBool(I.getValue(), FS->CaseSensitive))
2018 return false;
2019 } else if (Key == "overlay-relative") {
2020 if (!parseScalarBool(I.getValue(), FS->IsRelativeOverlay))
2021 return false;
2022 } else if (Key == "use-external-names") {
2023 if (!parseScalarBool(I.getValue(), FS->UseExternalNames))
2024 return false;
2025 } else if (Key == "fallthrough") {
2026 if (Keys["redirecting-with"].Seen) {
2027 error(I.getValue(),
2028 "'fallthrough' and 'redirecting-with' are mutually exclusive");
2029 return false;
2030 }
2031
2032 bool ShouldFallthrough = false;
2033 if (!parseScalarBool(I.getValue(), ShouldFallthrough))
2034 return false;
2035
2036 if (ShouldFallthrough) {
2037 FS->Redirection = RedirectingFileSystem::RedirectKind::Fallthrough;
2038 } else {
2039 FS->Redirection = RedirectingFileSystem::RedirectKind::RedirectOnly;
2040 }
2041 } else if (Key == "redirecting-with") {
2042 if (Keys["fallthrough"].Seen) {
2043 error(I.getValue(),
2044 "'fallthrough' and 'redirecting-with' are mutually exclusive");
2045 return false;
2046 }
2047
2048 if (auto Kind = parseRedirectKind(I.getValue())) {
2049 FS->Redirection = *Kind;
2050 } else {
2051 error(I.getValue(), "expected valid redirect kind");
2052 return false;
2053 }
2054 } else {
2055 llvm_unreachable("key missing from Keys")::llvm::llvm_unreachable_internal("key missing from Keys", "llvm/lib/Support/VirtualFileSystem.cpp"
, 2055)
;
2056 }
2057 }
2058
2059 if (Stream.failed())
2060 return false;
2061
2062 if (!checkMissingKeys(Top, Keys))
2063 return false;
2064
2065 // Now that we sucessefully parsed the YAML file, canonicalize the internal
2066 // representation to a proper directory tree so that we can search faster
2067 // inside the VFS.
2068 for (auto &E : RootEntries)
2069 uniqueOverlayTree(FS, E.get());
2070
2071 return true;
2072 }
2073};
2074
2075std::unique_ptr<RedirectingFileSystem>
2076RedirectingFileSystem::create(std::unique_ptr<MemoryBuffer> Buffer,
2077 SourceMgr::DiagHandlerTy DiagHandler,
2078 StringRef YAMLFilePath, void *DiagContext,
2079 IntrusiveRefCntPtr<FileSystem> ExternalFS) {
2080 SourceMgr SM;
2081 yaml::Stream Stream(Buffer->getMemBufferRef(), SM);
2082
2083 SM.setDiagHandler(DiagHandler, DiagContext);
2084 yaml::document_iterator DI = Stream.begin();
2085 yaml::Node *Root = DI->getRoot();
2086 if (DI == Stream.end() || !Root) {
2087 SM.PrintMessage(SMLoc(), SourceMgr::DK_Error, "expected root node");
2088 return nullptr;
2089 }
2090
2091 RedirectingFileSystemParser P(Stream);
2092
2093 std::unique_ptr<RedirectingFileSystem> FS(
2094 new RedirectingFileSystem(ExternalFS));
2095
2096 if (!YAMLFilePath.empty()) {
2097 // Use the YAML path from -ivfsoverlay to compute the dir to be prefixed
2098 // to each 'external-contents' path.
2099 //
2100 // Example:
2101 // -ivfsoverlay dummy.cache/vfs/vfs.yaml
2102 // yields:
2103 // FS->ExternalContentsPrefixDir => /<absolute_path_to>/dummy.cache/vfs
2104 //
2105 SmallString<256> OverlayAbsDir = sys::path::parent_path(YAMLFilePath);
2106 std::error_code EC = llvm::sys::fs::make_absolute(OverlayAbsDir);
2107 assert(!EC && "Overlay dir final path must be absolute")(static_cast <bool> (!EC && "Overlay dir final path must be absolute"
) ? void (0) : __assert_fail ("!EC && \"Overlay dir final path must be absolute\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 2107, __extension__
__PRETTY_FUNCTION__))
;
2108 (void)EC;
2109 FS->setExternalContentsPrefixDir(OverlayAbsDir);
2110 }
2111
2112 if (!P.parse(Root, FS.get()))
2113 return nullptr;
2114
2115 return FS;
2116}
2117
2118std::unique_ptr<RedirectingFileSystem> RedirectingFileSystem::create(
2119 ArrayRef<std::pair<std::string, std::string>> RemappedFiles,
2120 bool UseExternalNames, FileSystem &ExternalFS) {
2121 std::unique_ptr<RedirectingFileSystem> FS(
2122 new RedirectingFileSystem(&ExternalFS));
2123 FS->UseExternalNames = UseExternalNames;
2124
2125 StringMap<RedirectingFileSystem::Entry *> Entries;
2126
2127 for (auto &Mapping : llvm::reverse(RemappedFiles)) {
2128 SmallString<128> From = StringRef(Mapping.first);
2129 SmallString<128> To = StringRef(Mapping.second);
2130 {
2131 auto EC = ExternalFS.makeAbsolute(From);
2132 (void)EC;
2133 assert(!EC && "Could not make absolute path")(static_cast <bool> (!EC && "Could not make absolute path"
) ? void (0) : __assert_fail ("!EC && \"Could not make absolute path\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 2133, __extension__
__PRETTY_FUNCTION__))
;
2134 }
2135
2136 // Check if we've already mapped this file. The first one we see (in the
2137 // reverse iteration) wins.
2138 RedirectingFileSystem::Entry *&ToEntry = Entries[From];
2139 if (ToEntry)
2140 continue;
2141
2142 // Add parent directories.
2143 RedirectingFileSystem::Entry *Parent = nullptr;
2144 StringRef FromDirectory = llvm::sys::path::parent_path(From);
2145 for (auto I = llvm::sys::path::begin(FromDirectory),
2146 E = llvm::sys::path::end(FromDirectory);
2147 I != E; ++I) {
2148 Parent = RedirectingFileSystemParser::lookupOrCreateEntry(FS.get(), *I,
2149 Parent);
2150 }
2151 assert(Parent && "File without a directory?")(static_cast <bool> (Parent && "File without a directory?"
) ? void (0) : __assert_fail ("Parent && \"File without a directory?\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 2151, __extension__
__PRETTY_FUNCTION__))
;
2152 {
2153 auto EC = ExternalFS.makeAbsolute(To);
2154 (void)EC;
2155 assert(!EC && "Could not make absolute path")(static_cast <bool> (!EC && "Could not make absolute path"
) ? void (0) : __assert_fail ("!EC && \"Could not make absolute path\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 2155, __extension__
__PRETTY_FUNCTION__))
;
2156 }
2157
2158 // Add the file.
2159 auto NewFile = std::make_unique<RedirectingFileSystem::FileEntry>(
2160 llvm::sys::path::filename(From), To,
2161 UseExternalNames ? RedirectingFileSystem::NK_External
2162 : RedirectingFileSystem::NK_Virtual);
2163 ToEntry = NewFile.get();
2164 cast<RedirectingFileSystem::DirectoryEntry>(Parent)->addContent(
2165 std::move(NewFile));
2166 }
2167
2168 return FS;
2169}
2170
2171RedirectingFileSystem::LookupResult::LookupResult(
2172 Entry *E, sys::path::const_iterator Start, sys::path::const_iterator End)
2173 : E(E) {
2174 assert(E != nullptr)(static_cast <bool> (E != nullptr) ? void (0) : __assert_fail
("E != nullptr", "llvm/lib/Support/VirtualFileSystem.cpp", 2174
, __extension__ __PRETTY_FUNCTION__))
;
2175 // If the matched entry is a DirectoryRemapEntry, set ExternalRedirect to the
2176 // path of the directory it maps to in the external file system plus any
2177 // remaining path components in the provided iterator.
2178 if (auto *DRE = dyn_cast<RedirectingFileSystem::DirectoryRemapEntry>(E)) {
2179 SmallString<256> Redirect(DRE->getExternalContentsPath());
2180 sys::path::append(Redirect, Start, End,
2181 getExistingStyle(DRE->getExternalContentsPath()));
2182 ExternalRedirect = std::string(Redirect);
2183 }
2184}
2185
2186std::error_code
2187RedirectingFileSystem::makeCanonical(SmallVectorImpl<char> &Path) const {
2188 if (std::error_code EC = makeAbsolute(Path))
2189 return EC;
2190
2191 llvm::SmallString<256> CanonicalPath =
2192 canonicalize(StringRef(Path.data(), Path.size()));
2193 if (CanonicalPath.empty())
2194 return make_error_code(llvm::errc::invalid_argument);
2195
2196 Path.assign(CanonicalPath.begin(), CanonicalPath.end());
2197 return {};
2198}
2199
2200ErrorOr<RedirectingFileSystem::LookupResult>
2201RedirectingFileSystem::lookupPath(StringRef Path) const {
2202 sys::path::const_iterator Start = sys::path::begin(Path);
2203 sys::path::const_iterator End = sys::path::end(Path);
2204 for (const auto &Root : Roots) {
2205 ErrorOr<RedirectingFileSystem::LookupResult> Result =
2206 lookupPathImpl(Start, End, Root.get());
2207 if (Result || Result.getError() != llvm::errc::no_such_file_or_directory)
2208 return Result;
2209 }
2210 return make_error_code(llvm::errc::no_such_file_or_directory);
2211}
2212
2213ErrorOr<RedirectingFileSystem::LookupResult>
2214RedirectingFileSystem::lookupPathImpl(
2215 sys::path::const_iterator Start, sys::path::const_iterator End,
2216 RedirectingFileSystem::Entry *From) const {
2217 assert(!isTraversalComponent(*Start) &&(static_cast <bool> (!isTraversalComponent(*Start) &&
!isTraversalComponent(From->getName()) && "Paths should not contain traversal components"
) ? void (0) : __assert_fail ("!isTraversalComponent(*Start) && !isTraversalComponent(From->getName()) && \"Paths should not contain traversal components\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 2219, __extension__
__PRETTY_FUNCTION__))
2218 !isTraversalComponent(From->getName()) &&(static_cast <bool> (!isTraversalComponent(*Start) &&
!isTraversalComponent(From->getName()) && "Paths should not contain traversal components"
) ? void (0) : __assert_fail ("!isTraversalComponent(*Start) && !isTraversalComponent(From->getName()) && \"Paths should not contain traversal components\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 2219, __extension__
__PRETTY_FUNCTION__))
2219 "Paths should not contain traversal components")(static_cast <bool> (!isTraversalComponent(*Start) &&
!isTraversalComponent(From->getName()) && "Paths should not contain traversal components"
) ? void (0) : __assert_fail ("!isTraversalComponent(*Start) && !isTraversalComponent(From->getName()) && \"Paths should not contain traversal components\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 2219, __extension__
__PRETTY_FUNCTION__))
;
2220
2221 StringRef FromName = From->getName();
2222
2223 // Forward the search to the next component in case this is an empty one.
2224 if (!FromName.empty()) {
2225 if (!pathComponentMatches(*Start, FromName))
2226 return make_error_code(llvm::errc::no_such_file_or_directory);
2227
2228 ++Start;
2229
2230 if (Start == End) {
2231 // Match!
2232 return LookupResult(From, Start, End);
2233 }
2234 }
2235
2236 if (isa<RedirectingFileSystem::FileEntry>(From))
2237 return make_error_code(llvm::errc::not_a_directory);
2238
2239 if (isa<RedirectingFileSystem::DirectoryRemapEntry>(From))
2240 return LookupResult(From, Start, End);
2241
2242 auto *DE = cast<RedirectingFileSystem::DirectoryEntry>(From);
2243 for (const std::unique_ptr<RedirectingFileSystem::Entry> &DirEntry :
2244 llvm::make_range(DE->contents_begin(), DE->contents_end())) {
2245 ErrorOr<RedirectingFileSystem::LookupResult> Result =
2246 lookupPathImpl(Start, End, DirEntry.get());
2247 if (Result || Result.getError() != llvm::errc::no_such_file_or_directory)
2248 return Result;
2249 }
2250
2251 return make_error_code(llvm::errc::no_such_file_or_directory);
2252}
2253
2254static Status getRedirectedFileStatus(const Twine &OriginalPath,
2255 bool UseExternalNames,
2256 Status ExternalStatus) {
2257 // The path has been mapped by some nested VFS and exposes an external path,
2258 // don't override it with the original path.
2259 if (ExternalStatus.ExposesExternalVFSPath)
2260 return ExternalStatus;
2261
2262 Status S = ExternalStatus;
2263 if (!UseExternalNames)
2264 S = Status::copyWithNewName(S, OriginalPath);
2265 else
2266 S.ExposesExternalVFSPath = true;
2267 S.IsVFSMapped = true;
2268 return S;
2269}
2270
2271ErrorOr<Status> RedirectingFileSystem::status(
2272 const Twine &CanonicalPath, const Twine &OriginalPath,
2273 const RedirectingFileSystem::LookupResult &Result) {
2274 if (Optional<StringRef> ExtRedirect = Result.getExternalRedirect()) {
2275 SmallString<256> CanonicalRemappedPath((*ExtRedirect).str());
2276 if (std::error_code EC = makeCanonical(CanonicalRemappedPath))
2277 return EC;
2278
2279 ErrorOr<Status> S = ExternalFS->status(CanonicalRemappedPath);
2280 if (!S)
2281 return S;
2282 S = Status::copyWithNewName(*S, *ExtRedirect);
2283 auto *RE = cast<RedirectingFileSystem::RemapEntry>(Result.E);
2284 return getRedirectedFileStatus(OriginalPath,
2285 RE->useExternalName(UseExternalNames), *S);
2286 }
2287
2288 auto *DE = cast<RedirectingFileSystem::DirectoryEntry>(Result.E);
2289 return Status::copyWithNewName(DE->getStatus(), CanonicalPath);
2290}
2291
2292ErrorOr<Status>
2293RedirectingFileSystem::getExternalStatus(const Twine &CanonicalPath,
2294 const Twine &OriginalPath) const {
2295 auto Result = ExternalFS->status(CanonicalPath);
2296
2297 // The path has been mapped by some nested VFS, don't override it with the
2298 // original path.
2299 if (!Result || Result->ExposesExternalVFSPath)
2300 return Result;
2301 return Status::copyWithNewName(Result.get(), OriginalPath);
2302}
2303
2304ErrorOr<Status> RedirectingFileSystem::status(const Twine &OriginalPath) {
2305 SmallString<256> CanonicalPath;
2306 OriginalPath.toVector(CanonicalPath);
2307
2308 if (std::error_code EC = makeCanonical(CanonicalPath))
2309 return EC;
2310
2311 if (Redirection == RedirectKind::Fallback) {
2312 // Attempt to find the original file first, only falling back to the
2313 // mapped file if that fails.
2314 ErrorOr<Status> S = getExternalStatus(CanonicalPath, OriginalPath);
2315 if (S)
2316 return S;
2317 }
2318
2319 ErrorOr<RedirectingFileSystem::LookupResult> Result =
2320 lookupPath(CanonicalPath);
2321 if (!Result) {
2322 // Was not able to map file, fallthrough to using the original path if
2323 // that was the specified redirection type.
2324 if (Redirection == RedirectKind::Fallthrough &&
2325 isFileNotFound(Result.getError()))
2326 return getExternalStatus(CanonicalPath, OriginalPath);
2327 return Result.getError();
2328 }
2329
2330 ErrorOr<Status> S = status(CanonicalPath, OriginalPath, *Result);
2331 if (!S && Redirection == RedirectKind::Fallthrough &&
2332 isFileNotFound(S.getError(), Result->E)) {
2333 // Mapped the file but it wasn't found in the underlying filesystem,
2334 // fallthrough to using the original path if that was the specified
2335 // redirection type.
2336 return getExternalStatus(CanonicalPath, OriginalPath);
2337 }
2338
2339 return S;
2340}
2341
2342namespace {
2343
2344/// Provide a file wrapper with an overriden status.
2345class FileWithFixedStatus : public File {
2346 std::unique_ptr<File> InnerFile;
2347 Status S;
2348
2349public:
2350 FileWithFixedStatus(std::unique_ptr<File> InnerFile, Status S)
2351 : InnerFile(std::move(InnerFile)), S(std::move(S)) {}
2352
2353 ErrorOr<Status> status() override { return S; }
2354 ErrorOr<std::unique_ptr<llvm::MemoryBuffer>>
2355
2356 getBuffer(const Twine &Name, int64_t FileSize, bool RequiresNullTerminator,
2357 bool IsVolatile) override {
2358 return InnerFile->getBuffer(Name, FileSize, RequiresNullTerminator,
2359 IsVolatile);
2360 }
2361
2362 std::error_code close() override { return InnerFile->close(); }
2363
2364 void setPath(const Twine &Path) override { S = S.copyWithNewName(S, Path); }
2365};
2366
2367} // namespace
2368
2369ErrorOr<std::unique_ptr<File>>
2370File::getWithPath(ErrorOr<std::unique_ptr<File>> Result, const Twine &P) {
2371 // See \c getRedirectedFileStatus - don't update path if it's exposing an
2372 // external path.
2373 if (!Result || (*Result)->status()->ExposesExternalVFSPath)
2374 return Result;
2375
2376 ErrorOr<std::unique_ptr<File>> F = std::move(*Result);
2377 auto Name = F->get()->getName();
2378 if (Name && Name.get() != P.str())
2379 F->get()->setPath(P);
2380 return F;
2381}
2382
2383ErrorOr<std::unique_ptr<File>>
2384RedirectingFileSystem::openFileForRead(const Twine &OriginalPath) {
2385 SmallString<256> CanonicalPath;
2386 OriginalPath.toVector(CanonicalPath);
2387
2388 if (std::error_code EC = makeCanonical(CanonicalPath))
2389 return EC;
2390
2391 if (Redirection == RedirectKind::Fallback) {
2392 // Attempt to find the original file first, only falling back to the
2393 // mapped file if that fails.
2394 auto F = File::getWithPath(ExternalFS->openFileForRead(CanonicalPath),
2395 OriginalPath);
2396 if (F)
2397 return F;
2398 }
2399
2400 ErrorOr<RedirectingFileSystem::LookupResult> Result =
2401 lookupPath(CanonicalPath);
2402 if (!Result) {
2403 // Was not able to map file, fallthrough to using the original path if
2404 // that was the specified redirection type.
2405 if (Redirection == RedirectKind::Fallthrough &&
2406 isFileNotFound(Result.getError()))
2407 return File::getWithPath(ExternalFS->openFileForRead(CanonicalPath),
2408 OriginalPath);
2409 return Result.getError();
2410 }
2411
2412 if (!Result->getExternalRedirect()) // FIXME: errc::not_a_file?
2413 return make_error_code(llvm::errc::invalid_argument);
2414
2415 StringRef ExtRedirect = *Result->getExternalRedirect();
2416 SmallString<256> CanonicalRemappedPath(ExtRedirect.str());
2417 if (std::error_code EC = makeCanonical(CanonicalRemappedPath))
2418 return EC;
2419
2420 auto *RE = cast<RedirectingFileSystem::RemapEntry>(Result->E);
2421
2422 auto ExternalFile = File::getWithPath(
2423 ExternalFS->openFileForRead(CanonicalRemappedPath), ExtRedirect);
2424 if (!ExternalFile) {
2425 if (Redirection == RedirectKind::Fallthrough &&
2426 isFileNotFound(ExternalFile.getError(), Result->E)) {
2427 // Mapped the file but it wasn't found in the underlying filesystem,
2428 // fallthrough to using the original path if that was the specified
2429 // redirection type.
2430 return File::getWithPath(ExternalFS->openFileForRead(CanonicalPath),
2431 OriginalPath);
2432 }
2433 return ExternalFile;
2434 }
2435
2436 auto ExternalStatus = (*ExternalFile)->status();
2437 if (!ExternalStatus)
2438 return ExternalStatus.getError();
2439
2440 // Otherwise, the file was successfully remapped. Mark it as such. Also
2441 // replace the underlying path if the external name is being used.
2442 Status S = getRedirectedFileStatus(
2443 OriginalPath, RE->useExternalName(UseExternalNames), *ExternalStatus);
2444 return std::unique_ptr<File>(
2445 std::make_unique<FileWithFixedStatus>(std::move(*ExternalFile), S));
2446}
2447
2448std::error_code
2449RedirectingFileSystem::getRealPath(const Twine &OriginalPath,
2450 SmallVectorImpl<char> &Output) const {
2451 SmallString<256> CanonicalPath;
2452 OriginalPath.toVector(CanonicalPath);
2453
2454 if (std::error_code EC = makeCanonical(CanonicalPath))
2455 return EC;
2456
2457 if (Redirection == RedirectKind::Fallback) {
2458 // Attempt to find the original file first, only falling back to the
2459 // mapped file if that fails.
2460 std::error_code EC = ExternalFS->getRealPath(CanonicalPath, Output);
2461 if (!EC)
2462 return EC;
2463 }
2464
2465 ErrorOr<RedirectingFileSystem::LookupResult> Result =
2466 lookupPath(CanonicalPath);
2467 if (!Result) {
2468 // Was not able to map file, fallthrough to using the original path if
2469 // that was the specified redirection type.
2470 if (Redirection == RedirectKind::Fallthrough &&
2471 isFileNotFound(Result.getError()))
2472 return ExternalFS->getRealPath(CanonicalPath, Output);
2473 return Result.getError();
2474 }
2475
2476 // If we found FileEntry or DirectoryRemapEntry, look up the mapped
2477 // path in the external file system.
2478 if (auto ExtRedirect = Result->getExternalRedirect()) {
2479 auto P = ExternalFS->getRealPath(*ExtRedirect, Output);
2480 if (P && Redirection == RedirectKind::Fallthrough &&
2481 isFileNotFound(P, Result->E)) {
2482 // Mapped the file but it wasn't found in the underlying filesystem,
2483 // fallthrough to using the original path if that was the specified
2484 // redirection type.
2485 return ExternalFS->getRealPath(CanonicalPath, Output);
2486 }
2487 return P;
2488 }
2489
2490 // If we found a DirectoryEntry, still fallthrough to the original path if
2491 // allowed, because directories don't have a single external contents path.
2492 if (Redirection == RedirectKind::Fallthrough)
2493 return ExternalFS->getRealPath(CanonicalPath, Output);
2494 return llvm::errc::invalid_argument;
2495}
2496
2497std::unique_ptr<FileSystem>
2498vfs::getVFSFromYAML(std::unique_ptr<MemoryBuffer> Buffer,
2499 SourceMgr::DiagHandlerTy DiagHandler,
2500 StringRef YAMLFilePath, void *DiagContext,
2501 IntrusiveRefCntPtr<FileSystem> ExternalFS) {
2502 return RedirectingFileSystem::create(std::move(Buffer), DiagHandler,
2503 YAMLFilePath, DiagContext,
2504 std::move(ExternalFS));
2505}
2506
2507static void getVFSEntries(RedirectingFileSystem::Entry *SrcE,
2508 SmallVectorImpl<StringRef> &Path,
2509 SmallVectorImpl<YAMLVFSEntry> &Entries) {
2510 auto Kind = SrcE->getKind();
2511 if (Kind == RedirectingFileSystem::EK_Directory) {
2512 auto *DE = dyn_cast<RedirectingFileSystem::DirectoryEntry>(SrcE);
2513 assert(DE && "Must be a directory")(static_cast <bool> (DE && "Must be a directory"
) ? void (0) : __assert_fail ("DE && \"Must be a directory\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 2513, __extension__
__PRETTY_FUNCTION__))
;
2514 for (std::unique_ptr<RedirectingFileSystem::Entry> &SubEntry :
2515 llvm::make_range(DE->contents_begin(), DE->contents_end())) {
2516 Path.push_back(SubEntry->getName());
2517 getVFSEntries(SubEntry.get(), Path, Entries);
2518 Path.pop_back();
2519 }
2520 return;
2521 }
2522
2523 if (Kind == RedirectingFileSystem::EK_DirectoryRemap) {
2524 auto *DR = dyn_cast<RedirectingFileSystem::DirectoryRemapEntry>(SrcE);
2525 assert(DR && "Must be a directory remap")(static_cast <bool> (DR && "Must be a directory remap"
) ? void (0) : __assert_fail ("DR && \"Must be a directory remap\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 2525, __extension__
__PRETTY_FUNCTION__))
;
2526 SmallString<128> VPath;
2527 for (auto &Comp : Path)
2528 llvm::sys::path::append(VPath, Comp);
2529 Entries.push_back(
2530 YAMLVFSEntry(VPath.c_str(), DR->getExternalContentsPath()));
2531 return;
2532 }
2533
2534 assert(Kind == RedirectingFileSystem::EK_File && "Must be a EK_File")(static_cast <bool> (Kind == RedirectingFileSystem::EK_File
&& "Must be a EK_File") ? void (0) : __assert_fail (
"Kind == RedirectingFileSystem::EK_File && \"Must be a EK_File\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 2534, __extension__
__PRETTY_FUNCTION__))
;
2535 auto *FE = dyn_cast<RedirectingFileSystem::FileEntry>(SrcE);
2536 assert(FE && "Must be a file")(static_cast <bool> (FE && "Must be a file") ? void
(0) : __assert_fail ("FE && \"Must be a file\"", "llvm/lib/Support/VirtualFileSystem.cpp"
, 2536, __extension__ __PRETTY_FUNCTION__))
;
2537 SmallString<128> VPath;
2538 for (auto &Comp : Path)
2539 llvm::sys::path::append(VPath, Comp);
2540 Entries.push_back(YAMLVFSEntry(VPath.c_str(), FE->getExternalContentsPath()));
2541}
2542
2543void vfs::collectVFSFromYAML(std::unique_ptr<MemoryBuffer> Buffer,
2544 SourceMgr::DiagHandlerTy DiagHandler,
2545 StringRef YAMLFilePath,
2546 SmallVectorImpl<YAMLVFSEntry> &CollectedEntries,
2547 void *DiagContext,
2548 IntrusiveRefCntPtr<FileSystem> ExternalFS) {
2549 std::unique_ptr<RedirectingFileSystem> VFS = RedirectingFileSystem::create(
2550 std::move(Buffer), DiagHandler, YAMLFilePath, DiagContext,
2551 std::move(ExternalFS));
2552 if (!VFS)
2553 return;
2554 ErrorOr<RedirectingFileSystem::LookupResult> RootResult =
2555 VFS->lookupPath("/");
2556 if (!RootResult)
2557 return;
2558 SmallVector<StringRef, 8> Components;
2559 Components.push_back("/");
2560 getVFSEntries(RootResult->E, Components, CollectedEntries);
2561}
2562
2563UniqueID vfs::getNextVirtualUniqueID() {
2564 static std::atomic<unsigned> UID;
2565 unsigned ID = ++UID;
2566 // The following assumes that uint64_t max will never collide with a real
2567 // dev_t value from the OS.
2568 return UniqueID(std::numeric_limits<uint64_t>::max(), ID);
2569}
2570
2571void YAMLVFSWriter::addEntry(StringRef VirtualPath, StringRef RealPath,
2572 bool IsDirectory) {
2573 assert(sys::path::is_absolute(VirtualPath) && "virtual path not absolute")(static_cast <bool> (sys::path::is_absolute(VirtualPath
) && "virtual path not absolute") ? void (0) : __assert_fail
("sys::path::is_absolute(VirtualPath) && \"virtual path not absolute\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 2573, __extension__
__PRETTY_FUNCTION__))
;
2574 assert(sys::path::is_absolute(RealPath) && "real path not absolute")(static_cast <bool> (sys::path::is_absolute(RealPath) &&
"real path not absolute") ? void (0) : __assert_fail ("sys::path::is_absolute(RealPath) && \"real path not absolute\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 2574, __extension__
__PRETTY_FUNCTION__))
;
2575 assert(!pathHasTraversal(VirtualPath) && "path traversal is not supported")(static_cast <bool> (!pathHasTraversal(VirtualPath) &&
"path traversal is not supported") ? void (0) : __assert_fail
("!pathHasTraversal(VirtualPath) && \"path traversal is not supported\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 2575, __extension__
__PRETTY_FUNCTION__))
;
2576 Mappings.emplace_back(VirtualPath, RealPath, IsDirectory);
2577}
2578
2579void YAMLVFSWriter::addFileMapping(StringRef VirtualPath, StringRef RealPath) {
2580 addEntry(VirtualPath, RealPath, /*IsDirectory=*/false);
2581}
2582
2583void YAMLVFSWriter::addDirectoryMapping(StringRef VirtualPath,
2584 StringRef RealPath) {
2585 addEntry(VirtualPath, RealPath, /*IsDirectory=*/true);
2586}
2587
2588namespace {
2589
2590class JSONWriter {
2591 llvm::raw_ostream &OS;
2592 SmallVector<StringRef, 16> DirStack;
2593
2594 unsigned getDirIndent() { return 4 * DirStack.size(); }
2595 unsigned getFileIndent() { return 4 * (DirStack.size() + 1); }
2596 bool containedIn(StringRef Parent, StringRef Path);
2597 StringRef containedPart(StringRef Parent, StringRef Path);
2598 void startDirectory(StringRef Path);
2599 void endDirectory();
2600 void writeEntry(StringRef VPath, StringRef RPath);
2601
2602public:
2603 JSONWriter(llvm::raw_ostream &OS) : OS(OS) {}
2604
2605 void write(ArrayRef<YAMLVFSEntry> Entries, Optional<bool> UseExternalNames,
2606 Optional<bool> IsCaseSensitive, Optional<bool> IsOverlayRelative,
2607 StringRef OverlayDir);
2608};
2609
2610} // namespace
2611
2612bool JSONWriter::containedIn(StringRef Parent, StringRef Path) {
2613 using namespace llvm::sys;
2614
2615 // Compare each path component.
2616 auto IParent = path::begin(Parent), EParent = path::end(Parent);
2617 for (auto IChild = path::begin(Path), EChild = path::end(Path);
2618 IParent != EParent && IChild != EChild; ++IParent, ++IChild) {
2619 if (*IParent != *IChild)
2620 return false;
2621 }
2622 // Have we exhausted the parent path?
2623 return IParent == EParent;
2624}
2625
2626StringRef JSONWriter::containedPart(StringRef Parent, StringRef Path) {
2627 assert(!Parent.empty())(static_cast <bool> (!Parent.empty()) ? void (0) : __assert_fail
("!Parent.empty()", "llvm/lib/Support/VirtualFileSystem.cpp"
, 2627, __extension__ __PRETTY_FUNCTION__))
;
2628 assert(containedIn(Parent, Path))(static_cast <bool> (containedIn(Parent, Path)) ? void (
0) : __assert_fail ("containedIn(Parent, Path)", "llvm/lib/Support/VirtualFileSystem.cpp"
, 2628, __extension__ __PRETTY_FUNCTION__))
;
2629 return Path.slice(Parent.size() + 1, StringRef::npos);
2630}
2631
2632void JSONWriter::startDirectory(StringRef Path) {
2633 StringRef Name =
2634 DirStack.empty() ? Path : containedPart(DirStack.back(), Path);
2635 DirStack.push_back(Path);
2636 unsigned Indent = getDirIndent();
2637 OS.indent(Indent) << "{\n";
2638 OS.indent(Indent + 2) << "'type': 'directory',\n";
2639 OS.indent(Indent + 2) << "'name': \"" << llvm::yaml::escape(Name) << "\",\n";
2640 OS.indent(Indent + 2) << "'contents': [\n";
2641}
2642
2643void JSONWriter::endDirectory() {
2644 unsigned Indent = getDirIndent();
2645 OS.indent(Indent + 2) << "]\n";
2646 OS.indent(Indent) << "}";
2647
2648 DirStack.pop_back();
2649}
2650
2651void JSONWriter::writeEntry(StringRef VPath, StringRef RPath) {
2652 unsigned Indent = getFileIndent();
2653 OS.indent(Indent) << "{\n";
2654 OS.indent(Indent + 2) << "'type': 'file',\n";
2655 OS.indent(Indent + 2) << "'name': \"" << llvm::yaml::escape(VPath) << "\",\n";
2656 OS.indent(Indent + 2) << "'external-contents': \""
2657 << llvm::yaml::escape(RPath) << "\"\n";
2658 OS.indent(Indent) << "}";
2659}
2660
2661void JSONWriter::write(ArrayRef<YAMLVFSEntry> Entries,
2662 Optional<bool> UseExternalNames,
2663 Optional<bool> IsCaseSensitive,
2664 Optional<bool> IsOverlayRelative,
2665 StringRef OverlayDir) {
2666 using namespace llvm::sys;
2667
2668 OS << "{\n"
2669 " 'version': 0,\n";
2670 if (IsCaseSensitive)
2671 OS << " 'case-sensitive': '"
2672 << (IsCaseSensitive.value() ? "true" : "false") << "',\n";
2673 if (UseExternalNames)
2674 OS << " 'use-external-names': '"
2675 << (UseExternalNames.value() ? "true" : "false") << "',\n";
2676 bool UseOverlayRelative = false;
2677 if (IsOverlayRelative) {
2678 UseOverlayRelative = IsOverlayRelative.value();
2679 OS << " 'overlay-relative': '" << (UseOverlayRelative ? "true" : "false")
2680 << "',\n";
2681 }
2682 OS << " 'roots': [\n";
2683
2684 if (!Entries.empty()) {
2685 const YAMLVFSEntry &Entry = Entries.front();
2686
2687 startDirectory(
2688 Entry.IsDirectory ? Entry.VPath : path::parent_path(Entry.VPath)
2689 );
2690
2691 StringRef RPath = Entry.RPath;
2692 if (UseOverlayRelative) {
2693 unsigned OverlayDirLen = OverlayDir.size();
2694 assert(RPath.substr(0, OverlayDirLen) == OverlayDir &&(static_cast <bool> (RPath.substr(0, OverlayDirLen) == OverlayDir
&& "Overlay dir must be contained in RPath") ? void (
0) : __assert_fail ("RPath.substr(0, OverlayDirLen) == OverlayDir && \"Overlay dir must be contained in RPath\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 2695, __extension__
__PRETTY_FUNCTION__))
2695 "Overlay dir must be contained in RPath")(static_cast <bool> (RPath.substr(0, OverlayDirLen) == OverlayDir
&& "Overlay dir must be contained in RPath") ? void (
0) : __assert_fail ("RPath.substr(0, OverlayDirLen) == OverlayDir && \"Overlay dir must be contained in RPath\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 2695, __extension__
__PRETTY_FUNCTION__))
;
2696 RPath = RPath.slice(OverlayDirLen, RPath.size());
2697 }
2698
2699 bool IsCurrentDirEmpty = true;
2700 if (!Entry.IsDirectory) {
2701 writeEntry(path::filename(Entry.VPath), RPath);
2702 IsCurrentDirEmpty = false;
2703 }
2704
2705 for (const auto &Entry : Entries.slice(1)) {
2706 StringRef Dir =
2707 Entry.IsDirectory ? Entry.VPath : path::parent_path(Entry.VPath);
2708 if (Dir == DirStack.back()) {
2709 if (!IsCurrentDirEmpty) {
2710 OS << ",\n";
2711 }
2712 } else {
2713 bool IsDirPoppedFromStack = false;
2714 while (!DirStack.empty() && !containedIn(DirStack.back(), Dir)) {
2715 OS << "\n";
2716 endDirectory();
2717 IsDirPoppedFromStack = true;
2718 }
2719 if (IsDirPoppedFromStack || !IsCurrentDirEmpty) {
2720 OS << ",\n";
2721 }
2722 startDirectory(Dir);
2723 IsCurrentDirEmpty = true;
2724 }
2725 StringRef RPath = Entry.RPath;
2726 if (UseOverlayRelative) {
2727 unsigned OverlayDirLen = OverlayDir.size();
2728 assert(RPath.substr(0, OverlayDirLen) == OverlayDir &&(static_cast <bool> (RPath.substr(0, OverlayDirLen) == OverlayDir
&& "Overlay dir must be contained in RPath") ? void (
0) : __assert_fail ("RPath.substr(0, OverlayDirLen) == OverlayDir && \"Overlay dir must be contained in RPath\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 2729, __extension__
__PRETTY_FUNCTION__))
2729 "Overlay dir must be contained in RPath")(static_cast <bool> (RPath.substr(0, OverlayDirLen) == OverlayDir
&& "Overlay dir must be contained in RPath") ? void (
0) : __assert_fail ("RPath.substr(0, OverlayDirLen) == OverlayDir && \"Overlay dir must be contained in RPath\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 2729, __extension__
__PRETTY_FUNCTION__))
;
2730 RPath = RPath.slice(OverlayDirLen, RPath.size());
2731 }
2732 if (!Entry.IsDirectory) {
2733 writeEntry(path::filename(Entry.VPath), RPath);
2734 IsCurrentDirEmpty = false;
2735 }
2736 }
2737
2738 while (!DirStack.empty()) {
2739 OS << "\n";
2740 endDirectory();
2741 }
2742 OS << "\n";
2743 }
2744
2745 OS << " ]\n"
2746 << "}\n";
2747}
2748
2749void YAMLVFSWriter::write(llvm::raw_ostream &OS) {
2750 llvm::sort(Mappings, [](const YAMLVFSEntry &LHS, const YAMLVFSEntry &RHS) {
2751 return LHS.VPath < RHS.VPath;
2752 });
2753
2754 JSONWriter(OS).write(Mappings, UseExternalNames, IsCaseSensitive,
2755 IsOverlayRelative, OverlayDir);
2756}
2757
2758vfs::recursive_directory_iterator::recursive_directory_iterator(
2759 FileSystem &FS_, const Twine &Path, std::error_code &EC)
2760 : FS(&FS_) {
2761 directory_iterator I = FS->dir_begin(Path, EC);
2762 if (I != directory_iterator()) {
2763 State = std::make_shared<detail::RecDirIterState>();
2764 State->Stack.push(I);
2765 }
2766}
2767
2768vfs::recursive_directory_iterator &
2769recursive_directory_iterator::increment(std::error_code &EC) {
2770 assert(FS && State && !State->Stack.empty() && "incrementing past end")(static_cast <bool> (FS && State && !State
->Stack.empty() && "incrementing past end") ? void
(0) : __assert_fail ("FS && State && !State->Stack.empty() && \"incrementing past end\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 2770, __extension__
__PRETTY_FUNCTION__))
;
2771 assert(!State->Stack.top()->path().empty() && "non-canonical end iterator")(static_cast <bool> (!State->Stack.top()->path().
empty() && "non-canonical end iterator") ? void (0) :
__assert_fail ("!State->Stack.top()->path().empty() && \"non-canonical end iterator\""
, "llvm/lib/Support/VirtualFileSystem.cpp", 2771, __extension__
__PRETTY_FUNCTION__))
;
2772 vfs::directory_iterator End;
2773
2774 if (State->HasNoPushRequest)
2775 State->HasNoPushRequest = false;
2776 else {
2777 if (State->Stack.top()->type() == sys::fs::file_type::directory_file) {
2778 vfs::directory_iterator I = FS->dir_begin(State->Stack.top()->path(), EC);
2779 if (I != End) {
2780 State->Stack.push(I);
2781 return *this;
2782 }
2783 }
2784 }
2785
2786 while (!State->Stack.empty() && State->Stack.top().increment(EC) == End)
2787 State->Stack.pop();
2788
2789 if (State->Stack.empty())
2790 State.reset(); // end iterator
2791
2792 return *this;
2793}