LLVM 22.0.0git
UnifiedOnDiskCache.cpp
Go to the documentation of this file.
1//===----------------------------------------------------------------------===//
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/// \file
10/// Encapsulates \p OnDiskGraphDB and \p OnDiskKeyValueDB instances within one
11/// directory while also restricting storage growth with a scheme of chaining
12/// the two most recent directories (primary & upstream), where the primary
13/// "faults-in" data from the upstream one. When the primary (most recent)
14/// directory exceeds its intended limit a new empty directory becomes the
15/// primary one.
16///
17/// Within the top-level directory (the path that \p UnifiedOnDiskCache::open
18/// receives) there are directories named like this:
19///
20/// 'v<version>.<x>'
21/// 'v<version>.<x+1>'
22/// 'v<version>.<x+2>'
23/// ...
24///
25/// 'version' is the version integer for this \p UnifiedOnDiskCache's scheme and
26/// the part after the dot is an increasing integer. The primary directory is
27/// the one with the highest integer and the upstream one is the directory
28/// before it. For example, if the sub-directories contained are:
29///
30/// 'v1.5', 'v1.6', 'v1.7', 'v1.8'
31///
32/// Then the primary one is 'v1.8', the upstream one is 'v1.7', and the rest are
33/// unused directories that can be safely deleted at any time and by any
34/// process.
35///
36/// Contained within the top-level directory is a file named "lock" which is
37/// used for processes to take shared or exclusive locks for the contents of the
38/// top directory. While a \p UnifiedOnDiskCache is open it keeps a shared lock
39/// for the top-level directory; when it closes, if the primary sub-directory
40/// exceeded its limit, it attempts to get an exclusive lock in order to create
41/// a new empty primary directory; if it can't get the exclusive lock it gives
42/// up and lets the next \p UnifiedOnDiskCache instance that closes to attempt
43/// again.
44///
45/// The downside of this scheme is that while \p UnifiedOnDiskCache is open on a
46/// directory, by any process, the storage size in that directory will keep
47/// growing unrestricted. But the major benefit is that garbage-collection can
48/// be triggered on a directory concurrently, at any time and by any process,
49/// without affecting any active readers/writers in the same process or other
50/// processes.
51///
52/// The \c UnifiedOnDiskCache also provides validation and recovery on top of
53/// the underlying on-disk storage. The low-level storage is designed to remain
54/// coherent across regular process crashes, but may be invalid after power loss
55/// or similar system failures. \c UnifiedOnDiskCache::validateIfNeeded allows
56/// validating the contents once per boot and can recover by marking invalid
57/// data for garbage collection.
58///
59/// The data recovery described above requires exclusive access to the CAS, and
60/// it is an error to attempt recovery if the CAS is open in any process/thread.
61/// In order to maximize backwards compatibility with tools that do not perform
62/// validation before opening the CAS, we do not attempt to get exclusive access
63/// until recovery is actually performed, meaning as long as the data is valid
64/// it will not conflict with concurrent use.
65//
66//===----------------------------------------------------------------------===//
67
69#include "BuiltinCAS.h"
70#include "OnDiskCommon.h"
71#include "llvm/ADT/STLExtras.h"
72#include "llvm/ADT/ScopeExit.h"
76#include "llvm/ADT/StringRef.h"
81#include "llvm/Support/Errc.h"
82#include "llvm/Support/Error.h"
86#include "llvm/Support/Path.h"
89#include <optional>
90
91using namespace llvm;
92using namespace llvm::cas;
93using namespace llvm::cas::ondisk;
94
95/// FIXME: When the version of \p DBDirPrefix is bumped up we need to figure out
96/// how to handle the leftover sub-directories of the previous version, within
97/// the \p UnifiedOnDiskCache::collectGarbage function.
98static constexpr StringLiteral DBDirPrefix = "v1.";
99
100static constexpr StringLiteral ValidationFilename = "v1.validation";
101static constexpr StringLiteral CorruptPrefix = "corrupt.";
102
108
111 // little endian encoded.
113 static_assert(ValBytes.size() == sizeof(ID.getOpaqueData()));
114 support::endian::write64le(ValBytes.data(), ID.getOpaqueData());
115 return ValBytes;
116}
117
119UnifiedOnDiskCache::faultInFromUpstreamKV(ArrayRef<uint8_t> Key) {
120 assert(UpstreamGraphDB);
121 assert(UpstreamKVDB);
122
123 std::optional<ArrayRef<char>> UpstreamValue;
124 if (Error E = UpstreamKVDB->get(Key).moveInto(UpstreamValue))
125 return std::move(E);
126 if (!UpstreamValue)
127 return std::nullopt;
128
129 // The value is the \p ObjectID in the context of the upstream
130 // \p OnDiskGraphDB instance. Translate it to the context of the primary
131 // \p OnDiskGraphDB instance.
132 ObjectID UpstreamID = getObjectIDFromValue(*UpstreamValue);
133 auto PrimaryID =
134 PrimaryGraphDB->getReference(UpstreamGraphDB->getDigest(UpstreamID));
135 if (LLVM_UNLIKELY(!PrimaryID))
136 return PrimaryID.takeError();
137 return PrimaryKVDB->put(Key, getValueFromObjectID(*PrimaryID));
138}
139
140/// \returns all the 'v<version>.<x>' names of sub-directories, sorted with
141/// ascending order of the integer after the dot. Corrupt directories, if
142/// included, will come first.
144getAllDBDirs(StringRef Path, bool IncludeCorrupt = false) {
145 struct DBDir {
146 uint64_t Order;
147 std::string Name;
148 };
149 SmallVector<DBDir> FoundDBDirs;
150
151 std::error_code EC;
152 for (sys::fs::directory_iterator DirI(Path, EC), DirE; !EC && DirI != DirE;
153 DirI.increment(EC)) {
154 if (DirI->type() != sys::fs::file_type::directory_file)
155 continue;
156 StringRef SubDir = sys::path::filename(DirI->path());
157 if (IncludeCorrupt && SubDir.starts_with(CorruptPrefix)) {
158 FoundDBDirs.push_back({0, std::string(SubDir)});
159 continue;
160 }
161 if (!SubDir.starts_with(DBDirPrefix))
162 continue;
163 uint64_t Order;
164 if (SubDir.substr(DBDirPrefix.size()).getAsInteger(10, Order))
166 "unexpected directory " + DirI->path());
167 FoundDBDirs.push_back({Order, std::string(SubDir)});
168 }
169 if (EC)
170 return createFileError(Path, EC);
171
172 llvm::sort(FoundDBDirs, [](const DBDir &LHS, const DBDir &RHS) -> bool {
173 return LHS.Order < RHS.Order;
174 });
175
177 for (DBDir &Dir : FoundDBDirs)
178 DBDirs.push_back(std::move(Dir.Name));
179 return DBDirs;
180}
181
183 auto DBDirs = getAllDBDirs(Path, /*IncludeCorrupt=*/true);
184 if (!DBDirs)
185 return DBDirs.takeError();
186
187 // FIXME: When the version of \p DBDirPrefix is bumped up we need to figure
188 // out how to handle the leftover sub-directories of the previous version.
189
190 for (unsigned Keep = 2; Keep > 0 && !DBDirs->empty(); --Keep) {
191 StringRef Back(DBDirs->back());
192 if (Back.starts_with(CorruptPrefix))
193 break;
194 DBDirs->pop_back();
195 }
196 return *DBDirs;
197}
198
199/// \returns Given a sub-directory named 'v<version>.<x>', it outputs the
200/// 'v<version>.<x+1>' name.
204 bool Failed = DBDir.substr(DBDirPrefix.size()).getAsInteger(10, Count);
205 assert(!Failed);
206 (void)Failed;
207 OS << DBDirPrefix << Count + 1;
208}
209
210static Error validateOutOfProcess(StringRef LLVMCasBinary, StringRef RootPath,
211 bool CheckHash) {
212 SmallVector<StringRef> Args{LLVMCasBinary, "-cas", RootPath, "-validate"};
213 if (CheckHash)
214 Args.push_back("-check-hash");
215
216 llvm::SmallString<128> StdErrPath;
217 int StdErrFD = -1;
218 if (std::error_code EC = sys::fs::createTemporaryFile(
219 "llvm-cas-validate-stderr", "txt", StdErrFD, StdErrPath,
221 return createStringError(EC, "failed to create temporary file");
222 FileRemover OutputRemover(StdErrPath.c_str());
223
224 std::optional<llvm::StringRef> Redirects[] = {
225 {""}, // stdin = /dev/null
226 {""}, // stdout = /dev/null
227 StdErrPath.str(),
228 };
229
230 std::string ErrMsg;
231 int Result =
232 sys::ExecuteAndWait(LLVMCasBinary, Args, /*Env=*/std::nullopt, Redirects,
233 /*SecondsToWait=*/120, /*MemoryLimit=*/0, &ErrMsg);
234
235 if (Result == -1)
236 return createStringError("failed to exec " + join(Args, " ") + ": " +
237 ErrMsg);
238 if (Result != 0) {
239 llvm::SmallString<64> Err("cas contents invalid");
240 if (!ErrMsg.empty()) {
241 Err += ": ";
242 Err += ErrMsg;
243 }
244 auto StdErrBuf = MemoryBuffer::getFile(StdErrPath.c_str());
245 if (StdErrBuf && !(*StdErrBuf)->getBuffer().empty()) {
246 Err += ": ";
247 Err += (*StdErrBuf)->getBuffer();
248 }
249 return createStringError(Err);
250 }
251 return Error::success();
252}
253
254static Error validateInProcess(StringRef RootPath, StringRef HashName,
255 unsigned HashByteSize, bool CheckHash) {
256 std::shared_ptr<UnifiedOnDiskCache> UniDB;
257 if (Error E = UnifiedOnDiskCache::open(RootPath, std::nullopt, HashName,
258 HashByteSize)
259 .moveInto(UniDB))
260 return E;
262 if (Error E = CAS->validate(CheckHash))
263 return E;
265 if (Error E = Cache->validate())
266 return E;
267 return Error::success();
268}
269
271 StringRef RootPath, StringRef HashName, unsigned HashByteSize,
272 bool CheckHash, bool AllowRecovery, bool ForceValidation,
273 std::optional<StringRef> LLVMCasBinaryPath) {
274 if (std::error_code EC = sys::fs::create_directories(RootPath))
275 return createFileError(RootPath, EC);
276
277 SmallString<256> PathBuf(RootPath);
279 int FD = -1;
280 if (std::error_code EC = sys::fs::openFileForReadWrite(
282 return createFileError(PathBuf, EC);
283 assert(FD != -1);
284
286 auto CloseFile = make_scope_exit([&]() { sys::fs::closeFile(File); });
287
288 if (std::error_code EC = lockFileThreadSafe(FD, sys::fs::LockKind::Exclusive))
289 return createFileError(PathBuf, EC);
290 auto UnlockFD = make_scope_exit([&]() { unlockFileThreadSafe(FD); });
291
292 SmallString<8> Bytes;
293 if (Error E = sys::fs::readNativeFileToEOF(File, Bytes))
294 return createFileError(PathBuf, std::move(E));
295
296 uint64_t ValidationBootTime = 0;
297 if (!Bytes.empty() &&
298 StringRef(Bytes).trim().getAsInteger(10, ValidationBootTime))
300 "expected integer");
301
302 static uint64_t BootTime = 0;
303 if (BootTime == 0)
304 if (Error E = getBootTime().moveInto(BootTime))
305 return std::move(E);
306
307 if (ValidationBootTime == BootTime && !ForceValidation)
309
310 // Validate!
311 bool NeedsRecovery = false;
312 if (Error E =
313 LLVMCasBinaryPath
314 ? validateOutOfProcess(*LLVMCasBinaryPath, RootPath, CheckHash)
315 : validateInProcess(RootPath, HashName, HashByteSize,
316 CheckHash)) {
317 if (AllowRecovery) {
318 consumeError(std::move(E));
319 NeedsRecovery = true;
320 } else {
321 return std::move(E);
322 }
323 }
324
325 if (NeedsRecovery) {
327 sys::path::append(PathBuf, "lock");
328
329 int LockFD = -1;
330 if (std::error_code EC = sys::fs::openFileForReadWrite(
331 PathBuf, LockFD, sys::fs::CD_OpenAlways, sys::fs::OF_None))
332 return createFileError(PathBuf, EC);
334 auto CloseLock = make_scope_exit([&]() { sys::fs::closeFile(LockFile); });
335 if (std::error_code EC = tryLockFileThreadSafe(LockFD)) {
336 if (EC == std::errc::no_lock_available)
337 return createFileError(
338 PathBuf, EC,
339 "CAS validation requires exclusive access but CAS was in use");
340 return createFileError(PathBuf, EC);
341 }
342 auto UnlockFD = make_scope_exit([&]() { unlockFileThreadSafe(LockFD); });
343
344 auto DBDirs = getAllDBDirs(RootPath);
345 if (!DBDirs)
346 return DBDirs.takeError();
347
348 for (StringRef DBDir : *DBDirs) {
350 sys::path::append(PathBuf, DBDir);
351 std::error_code EC;
352 int Attempt = 0, MaxAttempts = 100;
353 SmallString<128> GCPath;
354 for (; Attempt < MaxAttempts; ++Attempt) {
355 GCPath.assign(RootPath);
356 sys::path::append(GCPath, CorruptPrefix + std::to_string(Attempt) +
357 "." + DBDir);
358 EC = sys::fs::rename(PathBuf, GCPath);
359 // Darwin uses ENOTEMPTY. Linux may return either ENOTEMPTY or EEXIST.
361 break;
362 }
363 if (Attempt == MaxAttempts)
364 return createStringError(
365 EC, "rename " + PathBuf +
366 " failed: too many CAS directories awaiting pruning");
367 if (EC)
368 return createStringError(EC, "rename " + PathBuf + " to " + GCPath +
369 " failed: " + EC.message());
370 }
371 }
372
373 if (ValidationBootTime != BootTime) {
374 // Fix filename in case we have error to report.
377 if (std::error_code EC = sys::fs::resize_file(FD, 0))
378 return createFileError(PathBuf, EC);
379 raw_fd_ostream OS(FD, /*shouldClose=*/false);
380 OS.seek(0); // resize does not reset position
381 OS << BootTime << '\n';
382 if (OS.has_error())
383 return createFileError(PathBuf, OS.error());
384 }
385
387}
388
390UnifiedOnDiskCache::open(StringRef RootPath, std::optional<uint64_t> SizeLimit,
391 StringRef HashName, unsigned HashByteSize,
392 OnDiskGraphDB::FaultInPolicy FaultInPolicy) {
393 if (std::error_code EC = sys::fs::create_directories(RootPath))
394 return createFileError(RootPath, EC);
395
396 SmallString<256> PathBuf(RootPath);
397 sys::path::append(PathBuf, "lock");
398 int LockFD = -1;
399 if (std::error_code EC = sys::fs::openFileForReadWrite(
400 PathBuf, LockFD, sys::fs::CD_OpenAlways, sys::fs::OF_None))
401 return createFileError(PathBuf, EC);
402 assert(LockFD != -1);
403 // Locking the directory using shared lock, which will prevent other processes
404 // from creating a new chain (essentially while a \p UnifiedOnDiskCache
405 // instance holds a shared lock the storage for the primary directory will
406 // grow unrestricted).
407 if (std::error_code EC =
409 return createFileError(PathBuf, EC);
410
411 auto DBDirs = getAllDBDirs(RootPath);
412 if (!DBDirs)
413 return DBDirs.takeError();
414 if (DBDirs->empty())
415 DBDirs->push_back((Twine(DBDirPrefix) + "1").str());
416
417 assert(!DBDirs->empty());
418
419 /// If there is only one directory open databases on it. If there are 2 or
420 /// more directories, get the most recent directories and chain them, with the
421 /// most recent being the primary one. The remaining directories are unused
422 /// data than can be garbage-collected.
423 auto UniDB = std::unique_ptr<UnifiedOnDiskCache>(new UnifiedOnDiskCache());
424 std::unique_ptr<OnDiskGraphDB> UpstreamGraphDB;
425 std::unique_ptr<OnDiskKeyValueDB> UpstreamKVDB;
426 if (DBDirs->size() > 1) {
427 StringRef UpstreamDir = *(DBDirs->end() - 2);
428 PathBuf = RootPath;
429 sys::path::append(PathBuf, UpstreamDir);
430 if (Error E = OnDiskGraphDB::open(PathBuf, HashName, HashByteSize,
431 /*UpstreamDB=*/nullptr, FaultInPolicy)
432 .moveInto(UpstreamGraphDB))
433 return std::move(E);
434 if (Error E = OnDiskKeyValueDB::open(PathBuf, HashName, HashByteSize,
435 /*ValueName=*/"objectid",
436 /*ValueSize=*/sizeof(uint64_t))
437 .moveInto(UpstreamKVDB))
438 return std::move(E);
439 }
440
441 StringRef PrimaryDir = *(DBDirs->end() - 1);
442 PathBuf = RootPath;
443 sys::path::append(PathBuf, PrimaryDir);
444 std::unique_ptr<OnDiskGraphDB> PrimaryGraphDB;
445 if (Error E = OnDiskGraphDB::open(PathBuf, HashName, HashByteSize,
446 UpstreamGraphDB.get(), FaultInPolicy)
447 .moveInto(PrimaryGraphDB))
448 return std::move(E);
449 std::unique_ptr<OnDiskKeyValueDB> PrimaryKVDB;
450 // \p UnifiedOnDiskCache does manual chaining for key-value requests,
451 // including an extra translation step of the value during fault-in.
452 if (Error E =
453 OnDiskKeyValueDB::open(PathBuf, HashName, HashByteSize,
454 /*ValueName=*/"objectid",
455 /*ValueSize=*/sizeof(uint64_t), UniDB.get())
456 .moveInto(PrimaryKVDB))
457 return std::move(E);
458
459 UniDB->RootPath = RootPath;
460 UniDB->SizeLimit = SizeLimit.value_or(0);
461 UniDB->LockFD = LockFD;
462 UniDB->NeedsGarbageCollection = DBDirs->size() > 2;
463 UniDB->PrimaryDBDir = PrimaryDir;
464 UniDB->UpstreamGraphDB = std::move(UpstreamGraphDB);
465 UniDB->PrimaryGraphDB = std::move(PrimaryGraphDB);
466 UniDB->UpstreamKVDB = std::move(UpstreamKVDB);
467 UniDB->PrimaryKVDB = std::move(PrimaryKVDB);
468
469 return std::move(UniDB);
470}
471
472void UnifiedOnDiskCache::setSizeLimit(std::optional<uint64_t> SizeLimit) {
473 this->SizeLimit = SizeLimit.value_or(0);
474}
475
477 uint64_t TotalSize = getPrimaryStorageSize();
478 if (UpstreamGraphDB)
479 TotalSize += UpstreamGraphDB->getStorageSize();
480 if (UpstreamKVDB)
481 TotalSize += UpstreamKVDB->getStorageSize();
482 return TotalSize;
483}
484
485uint64_t UnifiedOnDiskCache::getPrimaryStorageSize() const {
486 return PrimaryGraphDB->getStorageSize() + PrimaryKVDB->getStorageSize();
487}
488
490 uint64_t CurSizeLimit = SizeLimit;
491 if (!CurSizeLimit)
492 return false;
493
494 // If the hard limit is beyond 85%, declare above limit and request clean up.
495 unsigned CurrentPercent =
496 std::max(PrimaryGraphDB->getHardStorageLimitUtilization(),
497 PrimaryKVDB->getHardStorageLimitUtilization());
498 if (CurrentPercent > 85)
499 return true;
500
501 // We allow each of the directories in the chain to reach up to half the
502 // intended size limit. Check whether the primary directory has exceeded half
503 // the limit or not, in order to decide whether we need to start a new chain.
504 //
505 // We could check the size limit against the sum of sizes of both the primary
506 // and upstream directories but then if the upstream is significantly larger
507 // than the intended limit, it would trigger a new chain to be created before
508 // the primary has reached its own limit. Essentially in such situation we
509 // prefer reclaiming the storage later in order to have more consistent cache
510 // hits behavior.
511 return (CurSizeLimit / 2) < getPrimaryStorageSize();
512}
513
514Error UnifiedOnDiskCache::close(bool CheckSizeLimit) {
515 if (LockFD == -1)
516 return Error::success(); // already closed.
517 auto CloseLock = make_scope_exit([&]() {
518 assert(LockFD >= 0);
520 sys::fs::closeFile(LockFile);
521 LockFD = -1;
522 });
523
524 bool ExceededSizeLimit = CheckSizeLimit ? hasExceededSizeLimit() : false;
525 UpstreamKVDB.reset();
526 PrimaryKVDB.reset();
527 UpstreamGraphDB.reset();
528 PrimaryGraphDB.reset();
529 if (std::error_code EC = unlockFileThreadSafe(LockFD))
530 return createFileError(RootPath, EC);
531
532 if (!ExceededSizeLimit)
533 return Error::success();
534
535 // The primary directory exceeded its intended size limit. Try to get an
536 // exclusive lock in order to create a new primary directory for next time
537 // this \p UnifiedOnDiskCache path is opened.
538
539 if (std::error_code EC = tryLockFileThreadSafe(
540 LockFD, std::chrono::milliseconds(0), sys::fs::LockKind::Exclusive)) {
541 if (EC == errc::no_lock_available)
542 return Error::success(); // couldn't get exclusive lock, give up.
543 return createFileError(RootPath, EC);
544 }
545 auto UnlockFile = make_scope_exit([&]() { unlockFileThreadSafe(LockFD); });
546
547 // Managed to get an exclusive lock which means there are no other open
548 // \p UnifiedOnDiskCache instances for the same path, so we can safely start a
549 // new primary directory. To start a new primary directory we just have to
550 // create a new empty directory with the next consecutive index; since this is
551 // an atomic operation we will leave the top-level directory in a consistent
552 // state even if the process dies during this code-path.
553
554 SmallString<256> PathBuf(RootPath);
555 raw_svector_ostream OS(PathBuf);
557 getNextDBDirName(PrimaryDBDir, OS);
558 if (std::error_code EC = sys::fs::create_directory(PathBuf))
559 return createFileError(PathBuf, EC);
560
561 NeedsGarbageCollection = true;
562 return Error::success();
563}
564
565UnifiedOnDiskCache::UnifiedOnDiskCache() = default;
566
568
570 auto DBDirs = getAllGarbageDirs(Path);
571 if (!DBDirs)
572 return DBDirs.takeError();
573
574 SmallString<256> PathBuf(Path);
575 for (StringRef UnusedSubDir : *DBDirs) {
576 sys::path::append(PathBuf, UnusedSubDir);
577 if (std::error_code EC = sys::fs::remove_directories(PathBuf))
578 return createFileError(PathBuf, EC);
580 }
581 return Error::success();
582}
583
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
This file contains the declaration of the ActionCache class, which is the base class for ActionCache ...
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
#define LLVM_UNLIKELY(EXPR)
Definition Compiler.h:336
This declares OnDiskGraphDB, an ondisk CAS database with a fixed length hash.
This declares OnDiskKeyValueDB, a key value storage database of fixed size key and value.
This file contains some templates that are useful if you are working with the STL at all.
This file defines the make_scope_exit function, which executes user-defined cleanup logic at scope ex...
This file defines the SmallString class.
This file defines the SmallVector class.
This file contains some functions that are useful when dealing with strings.
static constexpr StringLiteral DBDirPrefix
FIXME: When the version of DBDirPrefix is bumped up we need to figure out how to handle the leftover ...
static Error validateInProcess(StringRef RootPath, StringRef HashName, unsigned HashByteSize, bool CheckHash)
static Expected< SmallVector< std::string, 4 > > getAllGarbageDirs(StringRef Path)
static constexpr StringLiteral ValidationFilename
static constexpr StringLiteral CorruptPrefix
static void getNextDBDirName(StringRef DBDir, llvm::raw_ostream &OS)
static Error validateOutOfProcess(StringRef LLVMCasBinary, StringRef RootPath, bool CheckHash)
static Expected< SmallVector< std::string, 4 > > getAllDBDirs(StringRef Path, bool IncludeCorrupt=false)
Value * RHS
Value * LHS
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition ArrayRef.h:40
Lightweight error class with error context and mandatory checking.
Definition Error.h:159
static ErrorSuccess success()
Create a success value.
Definition Error.h:336
Tagged union holding either a T or a Error.
Definition Error.h:485
FileRemover - This class is a simple object meant to be stack allocated.
static ErrorOr< std::unique_ptr< MemoryBuffer > > getFile(const Twine &Filename, bool IsText=false, bool RequiresNullTerminator=true, bool IsVolatile=false, std::optional< Align > Alignment=std::nullopt)
Open the specified file as a MemoryBuffer, returning a new MemoryBuffer if successful,...
SmallString - A SmallString is just a SmallVector with methods and accessors that make it work better...
Definition SmallString.h:26
void assign(StringRef RHS)
Assign from a StringRef.
Definition SmallString.h:51
const char * c_str()
StringRef str() const
Explicit conversion to StringRef.
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
A wrapper around a string literal that serves as a proxy for constructing global tables of StringRefs...
Definition StringRef.h:854
StringRef - Represent a constant reference to a string, i.e.
Definition StringRef.h:55
bool getAsInteger(unsigned Radix, T &Result) const
Parse the current string as an integer of the specified radix.
Definition StringRef.h:472
constexpr StringRef substr(size_t Start, size_t N=npos) const
Return a reference to the substring from [Start, Start + N).
Definition StringRef.h:573
bool starts_with(StringRef Prefix) const
Check if this string starts with the given Prefix.
Definition StringRef.h:261
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition Twine.h:82
LLVM Value Representation.
Definition Value.h:75
Reference to a node.
static ObjectID fromOpaqueData(uint64_t Opaque)
FaultInPolicy
How to fault-in nodes if an upstream database is used.
static LLVM_ABI_FOR_TEST Expected< std::unique_ptr< OnDiskGraphDB > > open(StringRef Path, StringRef HashName, unsigned HashByteSize, OnDiskGraphDB *UpstreamDB=nullptr, FaultInPolicy Policy=FaultInPolicy::FullTree)
Open the on-disk store from a directory.
static LLVM_ABI_FOR_TEST Expected< std::unique_ptr< OnDiskKeyValueDB > > open(StringRef Path, StringRef HashName, unsigned KeySize, StringRef ValueName, size_t ValueSize, UnifiedOnDiskCache *UnifiedCache=nullptr)
Open the on-disk store from a directory.
LLVM_ABI_FOR_TEST uint64_t getStorageSize() const
static LLVM_ABI_FOR_TEST ValueBytes getValueFromObjectID(ObjectID ID)
static LLVM_ABI_FOR_TEST Expected< std::unique_ptr< UnifiedOnDiskCache > > open(StringRef Path, std::optional< uint64_t > SizeLimit, StringRef HashName, unsigned HashByteSize, OnDiskGraphDB::FaultInPolicy FaultInPolicy=OnDiskGraphDB::FaultInPolicy::FullTree)
Open a UnifiedOnDiskCache instance for a directory.
LLVM_ABI_FOR_TEST Error close(bool CheckSizeLimit=true)
This is called implicitly at destruction time, so it is not required for a client to call this.
static LLVM_ABI_FOR_TEST ObjectID getObjectIDFromValue(ArrayRef< char > Value)
Helper function to convert the value stored in KeyValueDB and ObjectID.
static Expected< ValidationResult > validateIfNeeded(StringRef Path, StringRef HashName, unsigned HashByteSize, bool CheckHash, bool AllowRecovery, bool ForceValidation, std::optional< StringRef > LLVMCasBinary)
Validate the data in Path, if needed to ensure correctness.
LLVM_ABI_FOR_TEST bool hasExceededSizeLimit() const
std::array< char, sizeof(uint64_t)> ValueBytes
Error collectGarbage()
Remove unused data from the current UnifiedOnDiskCache.
LLVM_ABI_FOR_TEST void setSizeLimit(std::optional< uint64_t > SizeLimit)
Set the size for limiting growth.
A raw_ostream that writes to a file descriptor.
bool has_error() const
Return the value of the flag in this raw_fd_ostream indicating whether an output error has been encou...
std::error_code error() const
uint64_t seek(uint64_t off)
Flushes the stream and repositions the underlying file descriptor position to the offset specified fr...
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition raw_ostream.h:53
A raw_ostream that writes to an SmallVector or SmallString.
directory_iterator - Iterates through the entries in path.
unsigned ID
LLVM IR allows to use arbitrary numbers as calling convention identifiers.
Definition CallingConv.h:24
std::unique_ptr< ObjectStore > createObjectStoreFromUnifiedOnDiskCache(std::shared_ptr< ondisk::UnifiedOnDiskCache > UniDB)
std::unique_ptr< ActionCache > createActionCacheFromUnifiedOnDiskCache(std::shared_ptr< ondisk::UnifiedOnDiskCache > UniDB)
std::error_code lockFileThreadSafe(int FD, llvm::sys::fs::LockKind Kind)
Thread-safe alternative to sys::fs::lockFile.
std::error_code unlockFileThreadSafe(int FD)
Thread-safe alternative to sys::fs::unlockFile.
std::error_code tryLockFileThreadSafe(int FD, std::chrono::milliseconds Timeout=std::chrono::milliseconds(0), llvm::sys::fs::LockKind Kind=llvm::sys::fs::LockKind::Exclusive)
Thread-safe alternative to sys::fs::tryLockFile.
Expected< uint64_t > getBootTime()
Get boot time for the OS.
@ Valid
The data is already valid.
@ Recovered
The data was invalid, but was recovered.
@ Skipped
Validation was skipped, as it was not needed.
uint64_t read64le(const void *P)
Definition Endian.h:435
void write64le(void *P, uint64_t V)
Definition Endian.h:478
LLVM_ABI std::error_code closeFile(file_t &F)
Close the file object.
std::error_code openFileForReadWrite(const Twine &Name, int &ResultFD, CreationDisposition Disp, OpenFlags Flags, unsigned Mode=0666)
Opens the file with the given name in a write-only or read-write mode, returning its open file descri...
LLVM_ABI std::error_code rename(const Twine &from, const Twine &to)
Rename from to to.
LLVM_ABI Error readNativeFileToEOF(file_t FileHandle, SmallVectorImpl< char > &Buffer, ssize_t ChunkSize=DefaultReadChunkSize)
Reads from FileHandle until EOF, appending to Buffer in chunks of size ChunkSize.
Definition Path.cpp:1174
@ OF_Text
The file should be opened in text mode on platforms like z/OS that make this distinction.
Definition FileSystem.h:755
@ CD_OpenAlways
CD_OpenAlways - When opening a file:
Definition FileSystem.h:742
LLVM_ABI std::error_code create_directories(const Twine &path, bool IgnoreExisting=true, perms Perms=owner_all|group_all)
Create all the non-existent directories in path.
Definition Path.cpp:967
LLVM_ABI std::error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix, int &ResultFD, SmallVectorImpl< char > &ResultPath, OpenFlags Flags=OF_None)
Create a file in the system temporary directory.
Definition Path.cpp:912
LLVM_ABI std::error_code resize_file(int FD, uint64_t Size)
Resize path to size.
LLVM_ABI file_t convertFDToNativeFile(int FD)
Converts from a Posix file descriptor number to a native file handle.
Definition FileSystem.h:991
LLVM_ABI std::error_code create_directory(const Twine &path, bool IgnoreExisting=true, perms Perms=owner_all|group_all)
Create the directory in path.
LLVM_ABI std::error_code remove_directories(const Twine &path, bool IgnoreErrors=true)
Recursively delete a directory.
LLVM_ABI StringRef get_separator(Style style=Style::native)
Return the preferred separator for this platform.
Definition Path.cpp:609
LLVM_ABI void remove_filename(SmallVectorImpl< char > &path, Style style=Style::native)
Remove the last component from path unless it is the root dir.
Definition Path.cpp:474
LLVM_ABI StringRef filename(StringRef path LLVM_LIFETIME_BOUND, Style style=Style::native)
Get filename.
Definition Path.cpp:577
LLVM_ABI void append(SmallVectorImpl< char > &path, const Twine &a, const Twine &b="", const Twine &c="", const Twine &d="")
Append to path.
Definition Path.cpp:456
LLVM_ABI int ExecuteAndWait(StringRef Program, ArrayRef< StringRef > Args, std::optional< ArrayRef< StringRef > > Env=std::nullopt, ArrayRef< std::optional< StringRef > > Redirects={}, unsigned SecondsToWait=0, unsigned MemoryLimit=0, std::string *ErrMsg=nullptr, bool *ExecutionFailed=nullptr, std::optional< ProcessStatistics > *ProcStat=nullptr, BitVector *AffinityMask=nullptr)
This function executes the program using the arguments provided.
Definition Program.cpp:32
This is an optimization pass for GlobalISel generic memory operations.
Error createFileError(const Twine &F, Error E)
Concatenate a source file path and/or name with an Error.
Definition Error.h:1399
detail::scope_exit< std::decay_t< Callable > > make_scope_exit(Callable &&F)
Definition ScopeExit.h:59
LLVM_ABI std::error_code inconvertibleErrorCode()
The value returned by this function can be returned from convertToErrorCode for Error values where no...
Definition Error.cpp:98
testing::Matcher< const detail::ErrorHolder & > Failed()
Definition Error.h:198
Error createStringError(std::error_code EC, char const *Fmt, const Ts &... Vals)
Create formatted StringError object.
Definition Error.h:1305
@ file_exists
Definition Errc.h:48
@ illegal_byte_sequence
Definition Errc.h:52
@ no_lock_available
Definition Errc.h:61
@ directory_not_empty
Definition Errc.h:46
void sort(IteratorTy Start, IteratorTy End)
Definition STLExtras.h:1634
FunctionAddr VTableAddr Count
Definition InstrProf.h:139
LLVM_ATTRIBUTE_VISIBILITY_DEFAULT AnalysisKey InnerAnalysisManagerProxy< AnalysisManagerT, IRUnitT, ExtraArgTs... >::Key
std::string join(IteratorT Begin, IteratorT End, StringRef Separator)
Joins the strings in the range [Begin, End), adding Separator between the elements.
void consumeError(Error Err)
Consume a Error without doing anything.
Definition Error.h:1083
@ Keep
No function return thunk.
Definition CodeGen.h:162