summaryrefslogtreecommitdiff
path: root/src/buildtool/execution_api/local/garbage_collector.hpp
diff options
context:
space:
mode:
authorOliver Reiche <oliver.reiche@huawei.com>2023-02-24 15:49:14 +0100
committerOliver Reiche <oliver.reiche@huawei.com>2023-03-13 17:28:59 +0100
commit42b452e72f536b63bac080880b8daa481099793c (patch)
tree0af1a60e5e0fefb5572df38e092def3d8ac74c05 /src/buildtool/execution_api/local/garbage_collector.hpp
parent546bf5beebf2eb75e7b325f8f18969b4dd34a169 (diff)
downloadjustbuild-42b452e72f536b63bac080880b8daa481099793c.tar.gz
Storage: Reworked storage and garbage collection
The improved GC implementation uses refactored storage classes instead of directly accessing "unknown" file paths. The required storage class refactoring is quite substantial and outlined in the following paragraphs. The module `buildtool/file_system` was extended by: - `ObjectCAS`: a plain CAS implementation for reading/writing blobs and computing digests for a given `ObjectType`. Depending on that type, files written to the file system may have different properties (e.g., the x-bit set) or the digest may be computed differently (e.g., tree digests in non-compatible mode). A new module `buildtool/storage` was introduced containing: - `LocalCAS`: provides a common interface for the "logical CAS", which internally combines three `ObjectCAS`s, one for each `ObjectType` (file, executable, tree). - `LocalAC`: implements the action cache, which needs the `LocalCAS` for storing cache values. - `TargetCache`: implements the high-level target cache, which also needs the `LocalCAS` for storing cache values. - `LocalStorage`: combines the storage classes `LocalCAS`, `LocalAC`, and `TargetCache`. Those are initialized with settings from `StorageConfig`, such as the build root base path or number of generations for the garbage collector. `LocalStorage` is templated with a Boolean parameter `kDoGlobalUplink`, which indicates that, on every read/write access, the garbage collector should be used for uplinking across all generations (global). - `GarbageCollector`: responsible for garbage collection and the global uplinking across all generations. To do so, it employs instances of `LocalStorage` with `kDoGlobalUplink` set to false, in order to avoid endless recursion. The actual (local) uplinking within two single generations is performed by the corresponding storage class (e.g., `TargetCache` implements uplinking of target cache entries between two target cache generations etc.). Thereby, the actual knowledge how data should be uplinked is implemented by the instance that is responsible for creating the data in the first place.
Diffstat (limited to 'src/buildtool/execution_api/local/garbage_collector.hpp')
-rw-r--r--src/buildtool/execution_api/local/garbage_collector.hpp78
1 files changed, 0 insertions, 78 deletions
diff --git a/src/buildtool/execution_api/local/garbage_collector.hpp b/src/buildtool/execution_api/local/garbage_collector.hpp
deleted file mode 100644
index 6b89c841..00000000
--- a/src/buildtool/execution_api/local/garbage_collector.hpp
+++ /dev/null
@@ -1,78 +0,0 @@
-// Copyright 2022 Huawei Cloud Computing Technology Co., Ltd.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-#ifndef INCLUDED_SRC_BUILDTOOL_EXECUTION_API_LOCAL_GARBAGE_COLLECTOR_HPP
-#define INCLUDED_SRC_BUILDTOOL_EXECUTION_API_LOCAL_GARBAGE_COLLECTOR_HPP
-
-#include <optional>
-#include <string>
-
-#include "src/utils/cpp/file_locking.hpp"
-
-/// \brief
-class GarbageCollector {
- public:
- [[nodiscard]] auto static FindAndUplinkBlob(std::string const& id,
- bool is_executable) noexcept
- -> bool;
-
- [[nodiscard]] auto static FindAndUplinkTree(std::string const& id) noexcept
- -> bool;
-
- [[nodiscard]] auto static FindAndUplinkActionCacheEntry(
- std::string const& id) noexcept -> bool;
-
- [[nodiscard]] auto static FindAndUplinkTargetCacheEntry(
- std::string const& id) noexcept -> bool;
-
- [[nodiscard]] auto static TriggerGarbageCollection() noexcept -> bool;
-
- [[nodiscard]] auto static SharedLock() noexcept -> std::optional<LockFile>;
-
- [[nodiscard]] auto static ExclusiveLock() noexcept
- -> std::optional<LockFile>;
-
- private:
- [[nodiscard]] auto static LockFilePath() noexcept -> std::filesystem::path;
-
- [[nodiscard]] auto static UplinkBlob(int index,
- std::string const& id,
- bool is_executable) noexcept -> bool;
-
- [[nodiscard]] auto static UplinkTree(int index,
- std::string const& id) noexcept
- -> bool;
-
- [[nodiscard]] auto static UplinkBazelDirectory(
- int index,
- std::string const& id) noexcept -> bool;
-
- [[nodiscard]] auto static UplinkActionCacheEntry(
- int index,
- std::string const& id) noexcept -> bool;
-
- [[nodiscard]] auto static UplinkActionCacheEntryBlob(
- int index,
- std::string const& id) noexcept -> bool;
-
- [[nodiscard]] auto static UplinkTargetCacheEntry(
- int index,
- std::string const& id) noexcept -> bool;
-
- [[nodiscard]] auto static UplinkTargetCacheEntryBlob(
- int index,
- std::string const& id) noexcept -> bool;
-};
-
-#endif // INCLUDED_SRC_BUILDTOOL_EXECUTION_API_LOCAL_GARBAGE_COLLECTOR_HPP