blob: 2130aab0a9c153fa14c8a180bce1da7da9247b53 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
|
// Copyright 2024 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_STORAGE_REPOSITORY_GARBAGE_COLLECTOR_HPP
#define INCLUDED_SRC_BUILDTOOL_STORAGE_REPOSITORY_GARBAGE_COLLECTOR_HPP
#include <filesystem>
#include <optional>
#include "src/buildtool/storage/config.hpp"
#include "src/utils/cpp/file_locking.hpp"
/// \brief Global garbage collector implementation.
/// Responsible for deleting oldest generation.
class RepositoryGarbageCollector {
public:
/// \brief Trigger garbage collection, i.e., rotate the generations and
/// delete the oldest. \returns true on success.
[[nodiscard]] auto static TriggerGarbageCollection(
StorageConfig const& storage_config,
bool drop_only = false) noexcept -> bool;
/// \brief Acquire shared lock to prevent garbage collection from running.
/// \param storage_config Storage to be locked.
/// \returns The acquired lock file on success or nullopt otherwise.
[[nodiscard]] auto static SharedLock(
StorageConfig const& storage_config) noexcept
-> std::optional<LockFile>;
private:
[[nodiscard]] auto static ExclusiveLock(
StorageConfig const& storage_config) noexcept
-> std::optional<LockFile>;
[[nodiscard]] auto static LockFilePath(
StorageConfig const& storage_config) noexcept -> std::filesystem::path;
};
#endif // INCLUDED_SRC_BUILDTOOL_STORAGE_GARBAGE_COLLECTOR_HPP
|
