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 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
|
#include <c10/util/irange.h>
#include "StoreTestCommon.hpp"
#include <cstdlib>
#include <string>
#include <thread>
#include <gtest/gtest.h>
#include <torch/csrc/distributed/c10d/PrefixStore.hpp>
#include <torch/csrc/distributed/c10d/TCPStore.hpp>
constexpr int64_t kShortStoreTimeoutMillis = 100;
constexpr int defaultTimeout = 20;
c10::intrusive_ptr<c10d::TCPStore> _createServer(
bool useLibUV,
int numWorkers = 1,
int timeout = defaultTimeout) {
return c10::make_intrusive<c10d::TCPStore>(
"127.0.0.1",
c10d::TCPStoreOptions{
/* port */ 0,
/* isServer */ true,
numWorkers,
/* waitWorkers */ false,
/* timeout */ std::chrono::seconds(timeout),
/* multiTenant */ false,
/* masterListenFd */ std::nullopt,
/* useLibUV*/ useLibUV});
}
// Different ports for different tests.
void testHelper(bool useLibUV, const std::string& prefix = "") {
constexpr auto numThreads = 16;
constexpr auto numWorkers = numThreads + 1;
auto serverTCPStore = _createServer(useLibUV, numWorkers);
auto serverStore =
c10::make_intrusive<c10d::PrefixStore>(prefix, serverTCPStore);
// server store
auto serverThread = std::thread([&serverStore, &serverTCPStore] {
// Wait for all workers to join.
serverTCPStore->waitForWorkers();
// Basic set/get on the server store
c10d::test::set(*serverStore, "key0", "value0");
c10d::test::set(*serverStore, "key1", "value1");
c10d::test::set(*serverStore, "key2", "value2");
c10d::test::check(*serverStore, "key0", "value0");
c10d::test::check(*serverStore, "key1", "value1");
c10d::test::check(*serverStore, "key2", "value2");
serverStore->add("counter", 1);
auto numKeys = serverStore->getNumKeys();
// We expect 5 keys since 3 are added above, 'counter' is added by the
// helper thread, and the init key to coordinate workers.
EXPECT_EQ(numKeys, 5);
// Check compareSet, does not check return value
c10d::test::compareSet(
*serverStore, "key0", "wrongExpectedValue", "newValue");
c10d::test::check(*serverStore, "key0", "value0");
c10d::test::compareSet(*serverStore, "key0", "value0", "newValue");
c10d::test::check(*serverStore, "key0", "newValue");
auto delSuccess = serverStore->deleteKey("key0");
// Ensure that the key was successfully deleted
EXPECT_TRUE(delSuccess);
auto delFailure = serverStore->deleteKey("badKeyName");
// The key was not in the store so the delete operation should have failed
// and returned false.
EXPECT_FALSE(delFailure);
numKeys = serverStore->getNumKeys();
EXPECT_EQ(numKeys, 4);
auto timeout = std::chrono::milliseconds(kShortStoreTimeoutMillis);
serverStore->setTimeout(timeout);
EXPECT_THROW(serverStore->get("key0"), c10::Error);
});
// Hammer on TCPStore
std::vector<std::thread> threads;
constexpr auto numIterations = 1000;
c10d::test::Semaphore sem1, sem2;
c10d::TCPStoreOptions opts{};
opts.port = serverTCPStore->getPort();
opts.numWorkers = numWorkers;
// Each thread will have a client store to send/recv data
std::vector<c10::intrusive_ptr<c10d::TCPStore>> clientTCPStores;
std::vector<c10::intrusive_ptr<c10d::PrefixStore>> clientStores;
for (const auto i : c10::irange(numThreads)) {
clientTCPStores.push_back(
c10::make_intrusive<c10d::TCPStore>("127.0.0.1", opts));
clientStores.push_back(
c10::make_intrusive<c10d::PrefixStore>(prefix, clientTCPStores[i]));
}
std::string expectedCounterRes =
std::to_string(numThreads * numIterations + 1);
for (const auto i : c10::irange(numThreads)) {
threads.emplace_back([=, &sem1, &sem2, &clientStores, &expectedCounterRes] {
for ([[maybe_unused]] const auto j : c10::irange(numIterations)) {
clientStores[i]->add("counter", 1);
}
// Let each thread set and get key on its client store
std::string key = "thread_" + std::to_string(i);
for (const auto j : c10::irange(numIterations)) {
std::string val = "thread_val_" + std::to_string(j);
c10d::test::set(*clientStores[i], key, val);
c10d::test::check(*clientStores[i], key, val);
}
sem1.post();
sem2.wait();
// Check the counter results
c10d::test::check(*clientStores[i], "counter", expectedCounterRes);
// Now check other threads' written data
for (const auto j : c10::irange(numThreads)) {
if (j == i) {
continue;
}
std::string key = "thread_" + std::to_string(i);
std::string val = "thread_val_" + std::to_string(numIterations - 1);
c10d::test::check(*clientStores[i], key, val);
}
});
}
sem1.wait(numThreads);
sem2.post(numThreads);
for (auto& thread : threads) {
thread.join();
}
serverThread.join();
// Clear the store to test that client disconnect won't shutdown the store
clientStores.clear();
clientTCPStores.clear();
// Check that the counter has the expected value
c10d::test::check(*serverStore, "counter", expectedCounterRes);
// Check that each threads' written data from the main thread
for (const auto i : c10::irange(numThreads)) {
std::string key = "thread_" + std::to_string(i);
std::string val = "thread_val_" + std::to_string(numIterations - 1);
c10d::test::check(*serverStore, key, val);
}
}
TEST(TCPStoreTest, testHelper) {
testHelper(false);
}
TEST(TCPStoreTest, testHelperUV) {
testHelper(true);
}
TEST(TCPStoreTest, testHelperPrefix) {
testHelper(false, "testPrefixNoUV");
}
TEST(TCPStoreTest, testHelperPrefixUV) {
testHelper(true, "testPrefixUV");
}
TEST(TCPStoreTest, testCleanShutdown) {
int numWorkers = 2;
auto serverTCPStore = std::make_unique<c10d::TCPStore>(
"127.0.0.1",
c10d::TCPStoreOptions{
/* port */ 0,
/* isServer */ true,
numWorkers,
/* waitWorkers */ false,
/* timeout */ std::chrono::seconds(defaultTimeout)});
c10d::test::set(*serverTCPStore, "key", "val");
auto clientTCPStore = c10::make_intrusive<c10d::TCPStore>(
"127.0.0.1",
c10d::TCPStoreOptions{
/* port */ serverTCPStore->getPort(),
/* isServer */ false,
numWorkers,
/* waitWorkers */ false,
/* timeout */ std::chrono::seconds(defaultTimeout)});
clientTCPStore->get("key");
auto clientThread = std::thread([&clientTCPStore] {
EXPECT_THROW(clientTCPStore->get("invalid_key"), c10::DistNetworkError);
});
// start server shutdown during a client request
serverTCPStore = nullptr;
clientThread.join();
}
TEST(TCPStoreTest, testLibUVPartialRead) {
int numWorkers = 2; // thread 0 creates both server and client
// server part
c10d::TCPStoreOptions server_opts{
0,
true, // is master
numWorkers,
false, // don't wait otherwise client thread won't spawn
std::chrono::seconds(defaultTimeout)};
server_opts.useLibUV = true;
auto serverTCPStore =
std::make_unique<c10d::TCPStore>("127.0.0.1", server_opts);
// client part
c10d::TCPStoreOptions client_opts{
serverTCPStore->getPort(),
false, // is master
numWorkers,
false, // wait workers
std::chrono::seconds(defaultTimeout)};
client_opts.useLibUV = true;
auto clientTCPStore =
c10::make_intrusive<c10d::TCPStore>("127.0.0.1", client_opts);
auto clientThread = std::thread([&clientTCPStore] {
std::string keyPrefix(
"/default_pg/0//b7dc24de75e482ba2ceb9f9ee20732c25c0166d8//cuda//");
std::string value("v");
std::vector<uint8_t> valueBuf(value.begin(), value.end());
// split store->set(key, valueBuf) into two requests
for (int i = 0; i < 10; ++i) {
std::string key = keyPrefix + std::to_string(i);
clientTCPStore->_splitSet(key, valueBuf);
// check the result on server
c10d::test::check(*clientTCPStore, key, "v");
}
});
clientThread.join();
}
void testMultiTenantStores(bool libUV) {
c10d::TCPStoreOptions opts{};
opts.isServer = true;
opts.multiTenant = true;
opts.useLibUV = libUV;
// Construct two server stores on the same port.
auto store1 = c10::make_intrusive<c10d::TCPStore>("localhost", opts);
auto store2 = c10::make_intrusive<c10d::TCPStore>("localhost", opts);
// Assert that the two stores share the same server.
c10d::test::set(*store1, "key0", "value0");
c10d::test::check(*store2, "key0", "value0");
// Dispose the second instance and assert that the server is still alive.
store2.reset();
c10d::test::set(*store1, "key0", "value0");
c10d::test::check(*store1, "key0", "value0");
}
TEST(TCPStoreTest, testMultiTenantStores) {
testMultiTenantStores(false);
}
TEST(TCPStoreTest, testMultiTenantStoresUV) {
testMultiTenantStores(true);
}
|