dda996b875
Add llvm::cas::ObjectStore abstraction and InMemoryCAS as a in-memory CAS object store implementation. The ObjectStore models its objects as: * Content: An array of bytes for the data to be stored. * Refs: An array of references to other objects in the ObjectStore. And each CAS Object can be idenfied with an unqine ID/Hash. ObjectStore supports following general action: * Expected<ID> store(Content, ArrayRef<Ref>) * Expected<Ref> get(ID) It also introduces following types to interact with a CAS ObjectStore: * CASID: Hash representation for an CAS Objects with its context to help print/compare CASIDs. * ObjectRef: A light-weight ref for an object in the ObjectStore. It is implementation defined so it can be optimized for read/store/references depending on the implementation. * ObjectProxy: A proxy for the users of CAS to interact with the data inside CAS Object. It bundles a ObjectHandle and an ObjectStore instance.
75 lines
2.6 KiB
C++
75 lines
2.6 KiB
C++
//===- BuiltinCAS.h ---------------------------------------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_LIB_CAS_BUILTINCAS_H
|
|
#define LLVM_LIB_CAS_BUILTINCAS_H
|
|
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/CAS/BuiltinCASContext.h"
|
|
#include "llvm/CAS/ObjectStore.h"
|
|
|
|
namespace llvm::cas {
|
|
class ActionCache;
|
|
namespace builtin {
|
|
|
|
/// Common base class for builtin CAS implementations using the same CASContext.
|
|
class BuiltinCAS : public ObjectStore {
|
|
public:
|
|
BuiltinCAS() : ObjectStore(BuiltinCASContext::getDefaultContext()) {}
|
|
|
|
Expected<CASID> parseID(StringRef Reference) final;
|
|
|
|
Expected<ObjectRef> store(ArrayRef<ObjectRef> Refs,
|
|
ArrayRef<char> Data) final;
|
|
virtual Expected<ObjectRef> storeImpl(ArrayRef<uint8_t> ComputedHash,
|
|
ArrayRef<ObjectRef> Refs,
|
|
ArrayRef<char> Data) = 0;
|
|
|
|
virtual Expected<ObjectRef>
|
|
storeFromNullTerminatedRegion(ArrayRef<uint8_t> ComputedHash,
|
|
sys::fs::mapped_file_region Map) {
|
|
return storeImpl(ComputedHash, {}, ArrayRef(Map.data(), Map.size()));
|
|
}
|
|
|
|
/// Both builtin CAS implementations provide lifetime for free, so this can
|
|
/// be const, and readData() and getDataSize() can be implemented on top of
|
|
/// it.
|
|
virtual ArrayRef<char> getDataConst(ObjectHandle Node) const = 0;
|
|
|
|
ArrayRef<char> getData(ObjectHandle Node,
|
|
bool RequiresNullTerminator) const final {
|
|
// BuiltinCAS Objects are always null terminated.
|
|
return getDataConst(Node);
|
|
}
|
|
uint64_t getDataSize(ObjectHandle Node) const final {
|
|
return getDataConst(Node).size();
|
|
}
|
|
|
|
Error createUnknownObjectError(const CASID &ID) const {
|
|
return createStringError(std::make_error_code(std::errc::invalid_argument),
|
|
"unknown object '" + ID.toString() + "'");
|
|
}
|
|
|
|
Error createCorruptObjectError(const CASID &ID) const {
|
|
return createStringError(std::make_error_code(std::errc::invalid_argument),
|
|
"corrupt object '" + ID.toString() + "'");
|
|
}
|
|
|
|
Error createCorruptStorageError() const {
|
|
return createStringError(std::make_error_code(std::errc::invalid_argument),
|
|
"corrupt storage");
|
|
}
|
|
|
|
Error validate(const CASID &ID) final;
|
|
};
|
|
|
|
} // end namespace builtin
|
|
} // end namespace llvm::cas
|
|
|
|
#endif // LLVM_LIB_CAS_BUILTINCAS_H
|