317 lines
8.5 KiB
Python
317 lines
8.5 KiB
Python
# coding: utf-8
|
|
import gc
|
|
import logging
|
|
import sys
|
|
import time
|
|
import weakref
|
|
from unittest.mock import Mock
|
|
|
|
import numpy as np
|
|
import pytest
|
|
|
|
import ray
|
|
import ray.cluster_utils
|
|
from ray._common.test_utils import wait_for_condition
|
|
from ray._private.gc_collect_manager import PythonGCThread
|
|
from ray._private.internal_api import global_gc
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
def test_auto_local_gc(shutdown_only):
|
|
ray.init(
|
|
num_cpus=2,
|
|
_system_config={
|
|
"local_gc_interval_s": 10,
|
|
"local_gc_min_interval_s": 5,
|
|
"global_gc_min_interval_s": 10,
|
|
},
|
|
)
|
|
|
|
class ObjectWithCyclicRef:
|
|
def __init__(self):
|
|
self.loop = self
|
|
|
|
@ray.remote(num_cpus=1)
|
|
class GarbageHolder:
|
|
def __init__(self):
|
|
gc.disable()
|
|
x = ObjectWithCyclicRef()
|
|
self.garbage = weakref.ref(x)
|
|
|
|
def has_garbage(self):
|
|
return self.garbage() is not None
|
|
|
|
try:
|
|
gc.disable()
|
|
|
|
# Local driver.
|
|
local_ref = weakref.ref(ObjectWithCyclicRef())
|
|
|
|
# Remote workers.
|
|
actors = [GarbageHolder.remote() for _ in range(2)]
|
|
assert local_ref() is not None
|
|
assert all(ray.get([a.has_garbage.remote() for a in actors]))
|
|
|
|
def check_refs_gced():
|
|
return local_ref() is None and not any(
|
|
ray.get([a.has_garbage.remote() for a in actors])
|
|
)
|
|
|
|
wait_for_condition(check_refs_gced)
|
|
finally:
|
|
gc.enable()
|
|
|
|
|
|
@pytest.mark.xfail(
|
|
ray.cluster_utils.cluster_not_supported, reason="cluster not supported"
|
|
)
|
|
def test_global_gc(shutdown_only):
|
|
cluster = ray.cluster_utils.Cluster()
|
|
cluster.add_node(
|
|
num_cpus=1,
|
|
num_gpus=0,
|
|
_system_config={
|
|
"local_gc_interval_s": 10,
|
|
"local_gc_min_interval_s": 5,
|
|
"global_gc_min_interval_s": 10,
|
|
},
|
|
)
|
|
cluster.add_node(num_cpus=1, num_gpus=0)
|
|
ray.init(address=cluster.address)
|
|
|
|
class ObjectWithCyclicRef:
|
|
def __init__(self):
|
|
self.loop = self
|
|
|
|
@ray.remote(num_cpus=1)
|
|
class GarbageHolder:
|
|
def __init__(self):
|
|
gc.disable()
|
|
x = ObjectWithCyclicRef()
|
|
self.garbage = weakref.ref(x)
|
|
|
|
def has_garbage(self):
|
|
return self.garbage() is not None
|
|
|
|
try:
|
|
gc.disable()
|
|
|
|
# Local driver.
|
|
local_ref = weakref.ref(ObjectWithCyclicRef())
|
|
|
|
# Remote workers.
|
|
actors = [GarbageHolder.remote() for _ in range(2)]
|
|
assert local_ref() is not None
|
|
assert all(ray.get([a.has_garbage.remote() for a in actors]))
|
|
|
|
# GC should be triggered for all workers, including the local driver.
|
|
global_gc()
|
|
|
|
def check_refs_gced():
|
|
return local_ref() is None and not any(
|
|
ray.get([a.has_garbage.remote() for a in actors])
|
|
)
|
|
|
|
wait_for_condition(check_refs_gced, timeout=30)
|
|
finally:
|
|
gc.enable()
|
|
|
|
|
|
@pytest.mark.xfail(
|
|
ray.cluster_utils.cluster_not_supported, reason="cluster not supported"
|
|
)
|
|
def test_global_gc_when_full(shutdown_only):
|
|
cluster = ray.cluster_utils.Cluster()
|
|
for _ in range(2):
|
|
cluster.add_node(num_cpus=1, num_gpus=0, object_store_memory=100 * 1024 * 1024)
|
|
ray.init(address=cluster.address)
|
|
|
|
class LargeObjectWithCyclicRef:
|
|
def __init__(self):
|
|
self.loop = self
|
|
self.large_object = ray.put(np.zeros(20 * 1024 * 1024, dtype=np.uint8))
|
|
|
|
@ray.remote(num_cpus=1)
|
|
class GarbageHolder:
|
|
def __init__(self):
|
|
gc.disable()
|
|
x = LargeObjectWithCyclicRef()
|
|
self.garbage = weakref.ref(x)
|
|
|
|
def has_garbage(self):
|
|
return self.garbage() is not None
|
|
|
|
def return_large_array(self):
|
|
return np.zeros(60 * 1024 * 1024, dtype=np.uint8)
|
|
|
|
try:
|
|
gc.disable()
|
|
|
|
# Local driver.
|
|
# 20MB
|
|
local_ref = weakref.ref(LargeObjectWithCyclicRef())
|
|
|
|
# Remote workers.
|
|
# 20MB * 2
|
|
actors = [GarbageHolder.remote() for _ in range(2)]
|
|
assert local_ref() is not None
|
|
assert all(ray.get([a.has_garbage.remote() for a in actors]))
|
|
|
|
# GC should be triggered for all workers, including the local driver,
|
|
# when the driver tries to ray.put a value that doesn't fit in the
|
|
# object store. This should cause the captured ObjectRefs' numpy arrays
|
|
# to be evicted.
|
|
ray.put(np.zeros(80 * 1024 * 1024, dtype=np.uint8))
|
|
|
|
def check_refs_gced():
|
|
return local_ref() is None and not any(
|
|
ray.get([a.has_garbage.remote() for a in actors])
|
|
)
|
|
|
|
wait_for_condition(check_refs_gced)
|
|
|
|
# Local driver.
|
|
local_ref = weakref.ref(LargeObjectWithCyclicRef())
|
|
|
|
# Remote workers.
|
|
actors = [GarbageHolder.remote() for _ in range(2)]
|
|
assert all(ray.get([a.has_garbage.remote() for a in actors]))
|
|
|
|
# GC should be triggered for all workers, including the local driver,
|
|
# when a remote task tries to put a return value that doesn't fit in
|
|
# the object store. This should cause the captured ObjectRefs' numpy
|
|
# arrays to be evicted.
|
|
ray.get(actors[0].return_large_array.remote())
|
|
|
|
def check_refs_gced():
|
|
return local_ref() is None and not any(
|
|
ray.get([a.has_garbage.remote() for a in actors])
|
|
)
|
|
|
|
wait_for_condition(check_refs_gced)
|
|
finally:
|
|
gc.enable()
|
|
|
|
|
|
def test_global_gc_actors(shutdown_only):
|
|
ray.init(num_cpus=1, _system_config={"debug_dump_period_milliseconds": 500})
|
|
|
|
try:
|
|
gc.disable()
|
|
|
|
@ray.remote(num_cpus=1)
|
|
class A:
|
|
def f(self):
|
|
return "Ok"
|
|
|
|
# Try creating 3 actors. Unless python GC is triggered to break
|
|
# reference cycles, this won't be possible.
|
|
for i in range(3):
|
|
a = A.remote()
|
|
cycle = [a]
|
|
cycle.append(cycle)
|
|
ray.get(a.f.remote())
|
|
print("iteration", i)
|
|
del a
|
|
del cycle
|
|
finally:
|
|
gc.enable()
|
|
|
|
|
|
def test_local_gc_called_once_per_interval(shutdown_only):
|
|
ray.init(
|
|
num_cpus=2,
|
|
_system_config={
|
|
"local_gc_interval_s": 1,
|
|
"local_gc_min_interval_s": 0,
|
|
"global_gc_min_interval_s": 0,
|
|
},
|
|
)
|
|
|
|
class ObjectWithCyclicRef:
|
|
def __init__(self):
|
|
self.loop = self
|
|
|
|
@ray.remote(num_cpus=1)
|
|
class GarbageHolder:
|
|
def __init__(self):
|
|
gc.disable()
|
|
self.garbage = None
|
|
|
|
def make_garbage(self):
|
|
x = ObjectWithCyclicRef()
|
|
self.garbage = weakref.ref(x)
|
|
return True
|
|
|
|
def has_garbage(self):
|
|
return self.garbage() is not None
|
|
|
|
gc.disable()
|
|
|
|
# 1) Test GC behavior for the local driver.
|
|
|
|
# 1a) Wait for the first GC to happen to avoid timing issues.
|
|
local_ref = weakref.ref(ObjectWithCyclicRef())
|
|
wait_for_condition(lambda: local_ref() is None, retry_interval_ms=10)
|
|
|
|
# 1b) Check that GC is called.
|
|
wait_for_condition(
|
|
lambda: local_ref() is None,
|
|
timeout=5,
|
|
)
|
|
|
|
# 2) Test GC behavior for a remote actor.
|
|
a = GarbageHolder.remote()
|
|
|
|
# 2a) Wait for the first GC to happen to avoid timing issues.
|
|
ray.get(a.make_garbage.remote())
|
|
wait_for_condition(
|
|
lambda: not ray.get(a.has_garbage.remote()), retry_interval_ms=10
|
|
)
|
|
|
|
# 2b) Check that GC is called.
|
|
wait_for_condition(
|
|
lambda: not ray.get(a.has_garbage.remote()),
|
|
timeout=5,
|
|
)
|
|
|
|
gc.enable()
|
|
|
|
|
|
def test_gc_manager_thread_basic_functionality():
|
|
mock_gc_collect = Mock(return_value=10)
|
|
|
|
gc_thread = PythonGCThread(gc_collect_func=mock_gc_collect)
|
|
gc_thread.start()
|
|
assert gc_thread.is_alive()
|
|
|
|
gc_thread.trigger_gc()
|
|
wait_for_condition(lambda: mock_gc_collect.call_count == 1, timeout=2)
|
|
|
|
gc_thread.trigger_gc()
|
|
wait_for_condition(lambda: mock_gc_collect.call_count == 2, timeout=2)
|
|
|
|
gc_thread.stop()
|
|
assert not gc_thread.is_alive()
|
|
|
|
|
|
def test_gc_manager_thread_exception_handling():
|
|
mock_gc_collect = Mock(side_effect=RuntimeError("GC failed"))
|
|
|
|
gc_thread = PythonGCThread(gc_collect_func=mock_gc_collect)
|
|
gc_thread.start()
|
|
|
|
for _ in range(3):
|
|
gc_thread.trigger_gc()
|
|
time.sleep(0.1)
|
|
|
|
assert gc_thread.is_alive()
|
|
assert mock_gc_collect.call_count == 3
|
|
|
|
gc_thread.stop()
|
|
|
|
|
|
if __name__ == "__main__":
|
|
sys.exit(pytest.main(["-sv", __file__]))
|