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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
#pragma once
#include <chrono>
#include <cstdint>
#include <string>
#include <vector>
#include <c10/macros/Macros.h>
#include <torch/custom_class.h>
namespace c10d {
// callback function will be given arguments (std::optional<string> oldValue,
// std::optional<string> newValue)
using WatchKeyCallback =
std::function<void(std::optional<std::string>, std::optional<std::string>)>;
class TORCH_API Store : public torch::CustomClassHolder {
public:
static constexpr std::chrono::milliseconds kDefaultTimeout =
std::chrono::seconds(300);
static constexpr std::chrono::milliseconds kNoTimeout =
std::chrono::milliseconds::zero();
Store() : timeout_(kDefaultTimeout) {}
explicit Store(const std::chrono::milliseconds& timeout)
: timeout_(timeout) {}
Store(const Store&) = default;
Store(Store&&) noexcept = default;
~Store() override = default;
void set(const std::string& key, const std::string& value);
virtual void set(
const std::string& key,
const std::vector<uint8_t>& value) = 0;
std::string compareSet(
const std::string& key,
const std::string& currentValue,
const std::string& newValue);
virtual std::vector<uint8_t> compareSet(
const std::string& key,
const std::vector<uint8_t>& currentValue,
const std::vector<uint8_t>& newValue) {
TORCH_INTERNAL_ASSERT(false, "Not implemented.");
}
std::string get_to_str(const std::string& key);
virtual std::vector<uint8_t> get(const std::string& key) = 0;
virtual int64_t add(const std::string& key, int64_t value) = 0;
virtual bool deleteKey(const std::string& key) = 0;
virtual bool check(const std::vector<std::string>& keys) = 0;
virtual int64_t getNumKeys() = 0;
virtual void wait(const std::vector<std::string>& keys) = 0;
virtual void wait(
const std::vector<std::string>& keys,
const std::chrono::milliseconds& timeout) = 0;
virtual const std::chrono::milliseconds& getTimeout() const noexcept;
virtual void setTimeout(const std::chrono::milliseconds& timeout);
// watchKey() is deprecated and no longer supported.
virtual void watchKey(
const std::string& /* unused */,
// NOLINTNEXTLINE(performance-unnecessary-value-param)
WatchKeyCallback /* unused */) {
TORCH_CHECK(false, "watchKey is deprecated, no implementation support it.");
}
virtual void append(
const std::string& key,
const std::vector<uint8_t>& value);
virtual std::vector<std::vector<uint8_t>> multiGet(
const std::vector<std::string>& keys);
virtual void multiSet(
const std::vector<std::string>& keys,
const std::vector<std::vector<uint8_t>>& values);
// Returns true if this store support append, multiGet and multiSet
virtual bool hasExtendedApi() const;
protected:
std::chrono::milliseconds timeout_;
};
/*
StoreTimeoutGuard is a RAII guard that will set the store timeout and restore it
when it returns.
*/
class StoreTimeoutGuard {
public:
explicit StoreTimeoutGuard(
Store& store,
const std::chrono::milliseconds& timeout)
: store_(store), oldTimeout_(store.getTimeout()) {
store.setTimeout(timeout);
}
~StoreTimeoutGuard() {
store_.setTimeout(oldTimeout_);
}
/* Disabling copy and move semantics */
StoreTimeoutGuard(const StoreTimeoutGuard&) = delete;
StoreTimeoutGuard& operator=(const StoreTimeoutGuard&) = delete;
StoreTimeoutGuard(StoreTimeoutGuard&&) = delete;
StoreTimeoutGuard& operator=(StoreTimeoutGuard&&) = delete;
private:
Store& store_;
std::chrono::milliseconds oldTimeout_{};
};
} // namespace c10d
|
