d29ebb750fc6fea2f105619a98a7fab9b53cd26b
[lldb.git] / clang / lib / Basic / FileSystemStatCache.cpp
1 //===- FileSystemStatCache.cpp - Caching for 'stat' calls -----------------===//
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 defines the FileSystemStatCache interface.
10 //
11 //===----------------------------------------------------------------------===//
12
13 #include "clang/Basic/FileSystemStatCache.h"
14 #include "llvm/Support/Chrono.h"
15 #include "llvm/Support/ErrorOr.h"
16 #include "llvm/Support/Path.h"
17 #include "llvm/Support/VirtualFileSystem.h"
18 #include <utility>
19
20 using namespace clang;
21
22 void FileSystemStatCache::anchor() {}
23
24 static void copyStatusToFileData(const llvm::vfs::Status &Status,
25                                  FileData &Data) {
26   Data.Name = Status.getName();
27   Data.Size = Status.getSize();
28   Data.ModTime = llvm::sys::toTimeT(Status.getLastModificationTime());
29   Data.UniqueID = Status.getUniqueID();
30   Data.IsDirectory = Status.isDirectory();
31   Data.IsNamedPipe = Status.getType() == llvm::sys::fs::file_type::fifo_file;
32   Data.InPCH = false;
33   Data.IsVFSMapped = Status.IsVFSMapped;
34 }
35
36 /// FileSystemStatCache::get - Get the 'stat' information for the specified
37 /// path, using the cache to accelerate it if possible.  This returns true if
38 /// the path does not exist or false if it exists.
39 ///
40 /// If isFile is true, then this lookup should only return success for files
41 /// (not directories).  If it is false this lookup should only return
42 /// success for directories (not files).  On a successful file lookup, the
43 /// implementation can optionally fill in FileDescriptor with a valid
44 /// descriptor and the client guarantees that it will close it.
45 bool FileSystemStatCache::get(StringRef Path, FileData &Data, bool isFile,
46                               std::unique_ptr<llvm::vfs::File> *F,
47                               FileSystemStatCache *Cache,
48                               llvm::vfs::FileSystem &FS) {
49   LookupResult R;
50   bool isForDir = !isFile;
51
52   // If we have a cache, use it to resolve the stat query.
53   if (Cache)
54     R = Cache->getStat(Path, Data, isFile, F, FS);
55   else if (isForDir || !F) {
56     // If this is a directory or a file descriptor is not needed and we have
57     // no cache, just go to the file system.
58     llvm::ErrorOr<llvm::vfs::Status> Status = FS.status(Path);
59     if (!Status) {
60       R = CacheMissing;
61     } else {
62       R = CacheExists;
63       copyStatusToFileData(*Status, Data);
64     }
65   } else {
66     // Otherwise, we have to go to the filesystem.  We can always just use
67     // 'stat' here, but (for files) the client is asking whether the file exists
68     // because it wants to turn around and *open* it.  It is more efficient to
69     // do "open+fstat" on success than it is to do "stat+open".
70     //
71     // Because of this, check to see if the file exists with 'open'.  If the
72     // open succeeds, use fstat to get the stat info.
73     auto OwnedFile = FS.openFileForRead(Path);
74
75     if (!OwnedFile) {
76       // If the open fails, our "stat" fails.
77       R = CacheMissing;
78     } else {
79       // Otherwise, the open succeeded.  Do an fstat to get the information
80       // about the file.  We'll end up returning the open file descriptor to the
81       // client to do what they please with it.
82       llvm::ErrorOr<llvm::vfs::Status> Status = (*OwnedFile)->status();
83       if (Status) {
84         R = CacheExists;
85         copyStatusToFileData(*Status, Data);
86         *F = std::move(*OwnedFile);
87       } else {
88         // fstat rarely fails.  If it does, claim the initial open didn't
89         // succeed.
90         R = CacheMissing;
91         *F = nullptr;
92       }
93     }
94   }
95
96   // If the path doesn't exist, return failure.
97   if (R == CacheMissing) return true;
98
99   // If the path exists, make sure that its "directoryness" matches the clients
100   // demands.
101   if (Data.IsDirectory != isForDir) {
102     // If not, close the file if opened.
103     if (F)
104       *F = nullptr;
105
106     return true;
107   }
108
109   return false;
110 }
111
112 MemorizeStatCalls::LookupResult
113 MemorizeStatCalls::getStat(StringRef Path, FileData &Data, bool isFile,
114                            std::unique_ptr<llvm::vfs::File> *F,
115                            llvm::vfs::FileSystem &FS) {
116   if (get(Path, Data, isFile, F, nullptr, FS)) {
117     // Do not cache failed stats, it is easy to construct common inconsistent
118     // situations if we do, and they are not important for PCH performance
119     // (which currently only needs the stats to construct the initial
120     // FileManager entries).
121     return CacheMissing;
122   }
123
124   // Cache file 'stat' results and directories with absolutely paths.
125   if (!Data.IsDirectory || llvm::sys::path::is_absolute(Path))
126     StatCalls[Path] = Data;
127
128   return CacheExists;
129 }