File: test_read_write_lock.py

package info (click to toggle)
dask.distributed 2024.12.1%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 12,588 kB
  • sloc: python: 96,954; javascript: 1,549; sh: 390; makefile: 220
file content (205 lines) | stat: -rw-r--r-- 4,841 bytes parent folder | download
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
from __future__ import annotations

import threading

import pytest

from distributed.shuffle._disk import ReadWriteLock


def read(
    lock: ReadWriteLock, in_event: threading.Event, block_event: threading.Event
) -> None:
    with lock.read():
        in_event.set()
        block_event.wait()


def write(
    lock: ReadWriteLock, in_event: threading.Event, block_event: threading.Event
) -> None:
    with lock.write():
        in_event.set()
        block_event.wait()


def test_basic():
    lock = ReadWriteLock()

    with lock.write():
        pass

    # Write after write
    with lock.write():
        pass

    # Read after write
    with lock.read():
        pass

    # Write after read
    with lock.write():
        pass

    with pytest.raises(RuntimeError, match="unlocked read lock"):
        lock.release_read()

    with pytest.raises(RuntimeError, match="unlocked write lock"):
        lock.release_write()


def test_lock_timeout():
    lock = ReadWriteLock()

    result = lock.acquire_read()
    assert result is True

    result = lock.acquire_write(timeout=0.1)
    assert result is False

    # Timed out write does not prevent read
    with lock.read():
        pass

    lock.release_read()
    result = lock.acquire_write(timeout=0.1)
    assert result is True

    result = lock.acquire_read(timeout=0.1)
    assert result is False

    lock.release_write()
    result = lock.acquire_read(timeout=0.1)
    assert result is True


def test_concurrent_reads_are_allowed():
    in_event = threading.Event()
    block_event = threading.Event()
    lock = ReadWriteLock()

    other = threading.Thread(target=read, args=(lock, in_event, block_event))
    try:
        other.start()
        in_event.wait()
        with lock.read():
            pass
        block_event.set()
    finally:
        block_event.set()
        other.join()


def test_read_blocks_write():
    in_event = threading.Event()
    block_event = threading.Event()
    lock = ReadWriteLock()

    other = threading.Thread(target=read, args=(lock, in_event, block_event))
    try:
        other.start()
        in_event.wait()
        result = lock.acquire_write(timeout=0.1)
        assert result is False

        block_event.set()
        with lock.write():
            pass
    finally:
        block_event.set()
        other.join()


def test_write_blocks_read():
    in_event = threading.Event()
    block_event = threading.Event()
    lock = ReadWriteLock()

    other = threading.Thread(target=write, args=(lock, in_event, block_event))
    try:
        other.start()
        in_event.wait()
        result = lock.acquire_read(timeout=0.1)
        assert result is False

        block_event.set()
        with lock.read():
            pass
    finally:
        block_event.set()
        other.join()


def test_write_blocks_write():
    in_event = threading.Event()
    block_event = threading.Event()
    lock = ReadWriteLock()

    other = threading.Thread(target=write, args=(lock, in_event, block_event))
    try:
        other.start()
        in_event.wait()
        result = lock.acquire_write(timeout=0.1)
        assert result is False

        block_event.set()
        with lock.write():
            pass
    finally:
        block_event.set()
        other.join()


def test_write_preferred_over_read():
    in_read_event = threading.Event()
    block_read_event = threading.Event()
    in_other_read_event = threading.Event()
    block_other_read_event = threading.Event()
    in_write_event = threading.Event()
    block_write_event = threading.Event()

    lock = ReadWriteLock()

    reader = threading.Thread(target=read, args=(lock, in_read_event, block_read_event))
    other_reader = threading.Thread(
        target=read, args=(lock, in_other_read_event, block_other_read_event)
    )
    writer = threading.Thread(
        target=write, args=(lock, in_write_event, block_write_event)
    )

    try:
        reader.start()
        in_read_event.wait()

        writer.start()
        result = in_write_event.wait(0.1)
        # The write is blocked by the read lock
        assert result is False
        assert lock._write_pending is True

        other_reader.start()
        result = in_other_read_event.wait(0.1)
        # The read is blocked by the pending write
        assert result is False

        block_read_event.set()
        reader.join()

        # The write happens next
        in_write_event.wait()
        assert in_other_read_event.is_set() is False

        block_write_event.set()
        writer.join()

        in_other_read_event.wait()
        block_other_read_event.set()
        other_reader.join()
    finally:
        block_read_event.set()
        block_write_event.set()
        block_other_read_event.set()
        reader.join()
        writer.join()
        other_reader.join()