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
|
#!/usr/bin/env python3
# Owner(s): ["oncall: r2p"]
# Copyright (c) Facebook, Inc. and its affiliates.
# All rights reserved.
#
# This source code is licensed under the BSD-style license found in the
# LICENSE file in the root directory of this source tree.
import datetime
from multiprocessing.pool import ThreadPool
from typing import List
from unittest import mock
import torch.distributed as dist
import torch.distributed.elastic.utils.store as store_util
from torch.distributed.elastic.utils.logging import get_logger
from torch.testing._internal.common_utils import run_tests, TestCase
class MockStore:
_TEST_TIMEOUT = 1234
def __init__(self) -> None:
self.ops = []
def set_timeout(self, timeout: float) -> None:
self.ops.append(("set_timeout", timeout))
@property
def timeout(self) -> datetime.timedelta:
self.ops.append(("timeout",))
return datetime.timedelta(seconds=self._TEST_TIMEOUT)
def set(self, key: str, value: str) -> None:
self.ops.append(("set", key, value))
def get(self, key: str) -> str:
self.ops.append(("get", key))
return "value"
def multi_get(self, keys: List[str]) -> List[str]:
self.ops.append(("multi_get", keys))
return ["value"] * len(keys)
def add(self, key: str, val: int) -> int:
self.ops.append(("add", key, val))
return 3
def wait(self, keys: List[str]) -> None:
self.ops.append(("wait", keys))
class StoreUtilTest(TestCase):
def test_get_all_rank_0(self):
world_size = 3
store = MockStore()
store_util.get_all(store, 0, "test/store", world_size)
self.assertListEqual(
store.ops,
[
("multi_get", ["test/store0", "test/store1", "test/store2"]),
("add", "test/store/finished/num_members", 1),
("set", "test/store/finished/last_member", "<val_ignored>"),
("wait", ["test/store/finished/last_member"]),
],
)
def test_get_all_rank_n(self):
store = MockStore()
world_size = 3
store_util.get_all(store, 1, "test/store", world_size)
self.assertListEqual(
store.ops,
[
("multi_get", ["test/store0", "test/store1", "test/store2"]),
("add", "test/store/finished/num_members", 1),
("set", "test/store/finished/last_member", "<val_ignored>"),
],
)
def test_synchronize(self):
store = MockStore()
data = b"data0"
store_util.synchronize(store, data, 0, 3, key_prefix="test/store")
self.assertListEqual(
store.ops,
[
("timeout",),
("set_timeout", datetime.timedelta(seconds=300)),
("set", "test/store0", data),
("multi_get", ["test/store0", "test/store1", "test/store2"]),
("add", "test/store/finished/num_members", 1),
("set", "test/store/finished/last_member", "<val_ignored>"),
("wait", ["test/store/finished/last_member"]),
("set_timeout", datetime.timedelta(seconds=store._TEST_TIMEOUT)),
],
)
def test_synchronize_hash_store(self) -> None:
N = 4
store = dist.HashStore()
def f(i: int):
return store_util.synchronize(
store, f"data{i}", i, N, key_prefix="test/store"
)
with ThreadPool(N) as pool:
out = pool.map(f, range(N))
self.assertListEqual(out, [[f"data{i}".encode() for i in range(N)]] * N)
def test_barrier(self):
store = MockStore()
store_util.barrier(store, 3, key_prefix="test/store")
self.assertListEqual(
store.ops,
[
("timeout",),
("set_timeout", datetime.timedelta(seconds=300)),
("add", "test/store/num_members", 1),
("set", "test/store/last_member", "<val_ignored>"),
("wait", ["test/store/last_member"]),
("set_timeout", datetime.timedelta(seconds=store._TEST_TIMEOUT)),
],
)
def test_barrier_timeout_rank_tracing(self):
N = 3
store = dist.HashStore()
def run_barrier_for_rank(i: int):
try:
store_util.barrier(
store,
N,
key_prefix="test/store",
barrier_timeout=0.1,
rank=i,
rank_tracing_decoder=lambda x: f"Rank {x} host",
trace_timeout=0.01,
)
except Exception as e:
return str(e)
return ""
with ThreadPool(N - 1) as pool:
outputs: List[str] = pool.map(run_barrier_for_rank, range(N - 1))
self.assertTrue(any("missing_ranks=[Rank 2 host]" in msg for msg in outputs))
self.assertTrue(
any(
"check rank 0 (Rank 0 host) for missing rank info" in msg
for msg in outputs
)
)
def test_barrier_timeout_operations(self):
import torch
DistStoreError = torch._C._DistStoreError
N = 3
store = MockStore()
# rank 0
with mock.patch.object(store, "wait") as wait_mock:
wait_mock.side_effect = [DistStoreError("test"), None, None]
with self.assertRaises(DistStoreError):
store_util.barrier(
store,
N,
key_prefix="test/store",
barrier_timeout=1,
rank=0,
rank_tracing_decoder=lambda x: f"Rank {x} host",
trace_timeout=0.1,
)
self.assertListEqual(
store.ops,
[
("timeout",),
("set_timeout", datetime.timedelta(seconds=1)),
("add", "test/store/num_members", 1),
("set", "test/store/last_member", "<val_ignored>"),
# wait for last member is mocked
("set", "test/store0/TRACE", "<val_ignored>"),
# wait for each rank is mocked
("set", "test/store/TRACING_GATE", "<val_ignored>"),
],
)
# rank 1
with mock.patch.object(store, "wait") as wait_mock:
store.ops = []
wait_mock.side_effect = [
DistStoreError("test"),
None,
]
with self.assertRaises(DistStoreError):
store_util.barrier(
store,
N,
key_prefix="test/store",
barrier_timeout=1,
rank=1,
rank_tracing_decoder=lambda x: f"Rank {x} host",
trace_timeout=0.1,
)
self.assertListEqual(
store.ops,
[
("timeout",),
("set_timeout", datetime.timedelta(seconds=1)),
("add", "test/store/num_members", 1),
("set", "test/store/last_member", "<val_ignored>"),
("set", "test/store1/TRACE", "<val_ignored>"),
# wait for gate is mocked
],
)
def test_barrier_hash_store(self) -> None:
N = 4
store = dist.HashStore()
def f(i: int):
store_util.barrier(store, N, key_prefix="test/store")
with ThreadPool(N) as pool:
out = pool.map(f, range(N))
self.assertEqual(out, [None] * N)
class UtilTest(TestCase):
def test_get_logger_different(self):
logger1 = get_logger("name1")
logger2 = get_logger("name2")
self.assertNotEqual(logger1.name, logger2.name)
def test_get_logger(self):
logger1 = get_logger()
self.assertEqual(__name__, logger1.name)
def test_get_logger_none(self):
logger1 = get_logger(None)
self.assertEqual(__name__, logger1.name)
def test_get_logger_custom_name(self):
logger1 = get_logger("test.module")
self.assertEqual("test.module", logger1.name)
if __name__ == "__main__":
run_tests()
|