forked from apache/arrow
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_memory.py
More file actions
249 lines (200 loc) · 7.62 KB
/
Copy pathtest_memory.py
File metadata and controls
249 lines (200 loc) · 7.62 KB
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
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
import contextlib
import os
import signal
import subprocess
import sys
import weakref
import pyarrow as pa
import pytest
possible_backends = ["system", "jemalloc", "mimalloc"]
should_have_jemalloc = sys.platform == "linux"
should_have_mimalloc = sys.platform == "win32"
def supported_factories():
yield pa.default_memory_pool
for backend in pa.supported_memory_backends():
yield getattr(pa, f"{backend}_memory_pool")
@contextlib.contextmanager
def allocate_bytes(pool, nbytes):
"""
Temporarily allocate *nbytes* from the given *pool*.
"""
arr = pa.array([b"x" * nbytes], type=pa.binary(), memory_pool=pool)
# Fetch the values buffer from the varbinary array and release the rest,
# to get the desired allocation amount
buf = arr.buffers()[2]
arr = None
assert len(buf) == nbytes
try:
yield
finally:
buf = None
def check_allocated_bytes(pool):
"""
Check allocation stats on *pool*.
"""
allocated_before = pool.bytes_allocated()
max_mem_before = pool.max_memory()
with allocate_bytes(pool, 512):
assert pool.bytes_allocated() == allocated_before + 512
new_max_memory = pool.max_memory()
assert pool.max_memory() >= max_mem_before
assert pool.bytes_allocated() == allocated_before
assert pool.max_memory() == new_max_memory
def test_default_allocated_bytes():
pool = pa.default_memory_pool()
with allocate_bytes(pool, 1024):
check_allocated_bytes(pool)
assert pool.bytes_allocated() == pa.total_allocated_bytes()
def test_proxy_memory_pool():
pool = pa.proxy_memory_pool(pa.default_memory_pool())
check_allocated_bytes(pool)
wr = weakref.ref(pool)
assert wr() is not None
del pool
assert wr() is None
def test_logging_memory_pool(capfd):
pool = pa.logging_memory_pool(pa.default_memory_pool())
check_allocated_bytes(pool)
out, err = capfd.readouterr()
assert err == ""
assert out.count("Allocate:") > 0
assert out.count("Allocate:") == out.count("Free:")
def test_set_memory_pool():
old_pool = pa.default_memory_pool()
pool = pa.proxy_memory_pool(old_pool)
pa.set_memory_pool(pool)
try:
allocated_before = pool.bytes_allocated()
with allocate_bytes(None, 512):
assert pool.bytes_allocated() == allocated_before + 512
assert pool.bytes_allocated() == allocated_before
finally:
pa.set_memory_pool(old_pool)
def test_default_backend_name():
pool = pa.default_memory_pool()
assert pool.backend_name in possible_backends
def test_release_unused():
pool = pa.default_memory_pool()
pool.release_unused()
def check_env_var(name, expected, *, expect_warning=False):
code = f"""if 1:
import pyarrow as pa
pool = pa.default_memory_pool()
assert pool.backend_name in {expected!r}, pool.backend_name
"""
env = dict(os.environ)
env['ARROW_DEFAULT_MEMORY_POOL'] = name
res = subprocess.run([sys.executable, "-c", code], env=env,
universal_newlines=True, stderr=subprocess.PIPE)
if res.returncode != 0:
print(res.stderr, file=sys.stderr)
res.check_returncode() # fail
errlines = res.stderr.splitlines()
if expect_warning:
assert len(errlines) == 1
assert f"Unsupported backend '{name}'" in errlines[0]
else:
assert len(errlines) == 0
def test_env_var():
check_env_var("system", ["system"])
if should_have_jemalloc:
check_env_var("jemalloc", ["jemalloc"])
if should_have_mimalloc:
check_env_var("mimalloc", ["mimalloc"])
check_env_var("nonexistent", possible_backends, expect_warning=True)
def test_specific_memory_pools():
specific_pools = set()
def check(factory, name, *, can_fail=False):
if can_fail:
try:
pool = factory()
except NotImplementedError:
return
else:
pool = factory()
assert pool.backend_name == name
specific_pools.add(pool)
check(pa.system_memory_pool, "system")
check(pa.jemalloc_memory_pool, "jemalloc",
can_fail=not should_have_jemalloc)
check(pa.mimalloc_memory_pool, "mimalloc",
can_fail=not should_have_mimalloc)
def test_supported_memory_backends():
backends = pa.supported_memory_backends()
assert "system" in backends
if should_have_jemalloc:
assert "jemalloc" in backends
if should_have_mimalloc:
assert "mimalloc" in backends
def run_debug_memory_pool(pool_factory, env_value):
"""
Run a piece of code making an invalid memory write with the
ARROW_DEBUG_MEMORY_POOL environment variable set to a specific value.
"""
code = f"""if 1:
import ctypes
import pyarrow as pa
# ARROW-16873: some Python installs enable faulthandler by default,
# which could dump a spurious stack trace if the following crashes
import faulthandler
faulthandler.disable()
pool = pa.{pool_factory}()
buf = pa.allocate_buffer(64, memory_pool=pool)
# Write memory out of bounds
ptr = ctypes.cast(buf.address, ctypes.POINTER(ctypes.c_ubyte))
ptr[64] = 0
del buf
"""
env = dict(os.environ)
env['ARROW_DEBUG_MEMORY_POOL'] = env_value
res = subprocess.run([sys.executable, "-c", code], env=env,
universal_newlines=True, stderr=subprocess.PIPE)
print(res.stderr, file=sys.stderr)
return res
@pytest.mark.parametrize('pool_factory', supported_factories())
def test_debug_memory_pool_abort(pool_factory):
res = run_debug_memory_pool(pool_factory.__name__, "abort")
if os.name == "posix":
assert res.returncode == -signal.SIGABRT
else:
assert res.returncode != 0
assert "Wrong size on deallocation" in res.stderr
@pytest.mark.parametrize('pool_factory', supported_factories())
def test_debug_memory_pool_trap(pool_factory):
res = run_debug_memory_pool(pool_factory.__name__, "trap")
if os.name == "posix":
assert res.returncode == -signal.SIGTRAP
else:
assert res.returncode != 0
assert "Wrong size on deallocation" in res.stderr
@pytest.mark.parametrize('pool_factory', supported_factories())
def test_debug_memory_pool_warn(pool_factory):
res = run_debug_memory_pool(pool_factory.__name__, "warn")
res.check_returncode()
assert "Wrong size on deallocation" in res.stderr
@pytest.mark.parametrize('pool_factory', supported_factories())
def test_debug_memory_pool_disabled(pool_factory):
res = run_debug_memory_pool(pool_factory.__name__, "")
# The subprocess either returned successfully or was killed by a signal
# (due to writing out of bounds), depending on the underlying allocator.
if os.name == "posix":
assert res.returncode <= 0
else:
res.check_returncode()
assert res.stderr == ""