-
Notifications
You must be signed in to change notification settings - Fork 0
/
filecache.py
441 lines (360 loc) · 15.1 KB
/
filecache.py
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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
"""
A shared caching layer for file-like objects.
pseudo_file objects can be used as drop-in replacements for actual file
handles to provide a transparent caching layer to avoid reading multiple
times from disk or network.
To create a pseudo_file instance, encapsulate a 'real' file handler
inside a lazy cache object:
from dxtbx.filecache import lazy_file_cache
cache = lazy_file_cache(open(filename, 'rb'))
Finally use a reference to the cache object to create one or many pseudo_file
instances:
fh1 = cache.open()
from dxtbx.filecache import pseudo_file
fh2 = pseudo_file(cache) # equivalent
fh3 = pseudo_file(cache)
...
Each pseudo_file instance can then be treated as a proper read-only
file handle, but will benefit from a shared cache:
with cache.open() as fh:
fh.read(100)
fh.readline()
fh.seek(500)
fh.read()
fh.readlines()
fh.close()
To flush the cache and free the memory you can use
cache.close()
This will drop the cache when all associated file handles are closed.
To instantly drop the cache you can use
cache.force_close()
Any further access attempts will then result in an exception.
"""
from __future__ import absolute_import, division, print_function
import io
import os
from builtins import object
from threading import Lock
class lazy_file_cache(object):
"""An object providing shared cached access to files"""
def __init__(self, file_object):
"""Create a shared cache based on a single file handle."""
# Uncomment this line to print debug information
# self._debug = self._debug_enable
# Size of a block to read. This should not be smaller than 4k, which is the
# default block size on many systems.
self._page_size = max(4096, io.DEFAULT_BUFFER_SIZE)
# Reference to the underlying file object. When no further information can
# be gained from the file (ie. it has been read once completely), it may
# be closed.
self._all_cached = False
self._file = file_object
self._file_lock = Lock()
# BytesIO object containing cached information
self._cache_object = io.BytesIO()
self._cache_size = 0
self._cache_limit = 4 * 1024 * 1024
self._cache_limit_reached = False
# Current status of lazy cache towards client objects.
# Opening new file handles is disallowed when the object is closing.
self._closing = False
# When the lazy cache object is closed no further access is allowed,
# and cached information is dropped.
self._closed = False
# Number of currently registered client objects
self._reference_counter = 0
self._reference_counter_lock = Lock()
self._debug("Created cache object for %s: %s" % (str(file_object), str(self)))
def _debug(self, string):
pass
def _debug_enable(self, string):
print("%s: %s" % (format(id(self), "#x"), string))
def __del__(self):
"""Close file handles and drop cache on garbage collection."""
try:
self.force_close()
except TypeError:
# Ignore errors that might happen during interpreter shutdown
pass
def _cache_up_to(self, position):
'''Ensure that the file has been read up to "position"'''
# Limit reads to upper cache size limit
if position > self._cache_limit:
position = self._cache_limit
# Is read actually necessary?
if self._all_cached or (position < self._cache_size):
return
with self._file_lock:
read_bytes = position - self._cache_size
# This looks like an unnecessary check, but required for concurrency
if read_bytes <= 0:
return
# Do not read less than a memory page, round up read size to a
# multiple of page sizes if necessary.
read_bytes = self._page_size * (
(read_bytes + self._page_size - 1) // self._page_size
)
self._debug("Reading %d bytes from file" % read_bytes)
expected_cache_size = self._cache_size + read_bytes
data = self._file.read(read_bytes)
self._cache_object.seek(self._cache_size)
self._cache_object.write(data)
self._cache_size = self._cache_object.tell()
self._debug(
"Read %d bytes from file, cache size %d" % (len(data), self._cache_size)
)
if expected_cache_size != self._cache_size:
# must have reached end of file
self._debug(
"Lazy cache reached EOF (%d != %d)"
% (expected_cache_size, self._cache_size)
)
self._all_cached = True
self._close_file()
if self._cache_size >= self._cache_limit:
self._cache_limit_reached = True
self._debug("Cache limit reached with %d bytes" % self._cache_size)
def _cache_all(self):
"""Read entire remaining file into cache."""
# Is read actually necessary?
if self._all_cached:
return
# Is read actually possible?
if self._cache_limit_reached:
return
with self._file_lock:
# Check again with lock held, required for concurrency
if self._all_cached or self._cache_limit_reached:
return
self._debug("Reading remaining file into cache")
data = self._file.read(self._cache_limit - self._cache_size)
self._cache_object.seek(self._cache_size)
self._cache_object.write(data)
self._debug("Read %d bytes" % len(data))
self._cache_size += len(data)
if self._cache_size >= self._cache_limit:
# Don't cache more than the set limit. In this case keep file handler
# open and pass read requests through.
self._cache_limit_reached = True
self._debug("Cache size limit reached")
return
self._all_cached = True
self._close_file()
def _check_not_closed(self):
if self._closed:
self._debug("Instance tried to access closed cache")
raise IOError(
"Accessing lazy file cache %s after closing is not allowed" % str(self)
)
def _close_file(self):
if self._file is not None:
self._debug(
"Closing lazy cache internal file handle (%d bytes read)"
% self._cache_size
)
self._file.close()
def open(self):
"""Create and return a new pseudo_file object for this cache."""
return pseudo_file(self)
def close(self):
if not self._closing:
self._closing = True
self._debug("Closing lazy cache %s" % str(self))
with self._reference_counter_lock:
if self._reference_counter == 0:
self.force_close()
def force_close(self):
"""Close encapsulated file handle, drop cache and prevent further reads."""
if not self._closed:
self._closing = True
self._closed = True
self._close_file()
if self._reference_counter > 0:
self._debug(
"Warning: %d connected instances remain" % self._reference_counter
)
if self._cache_object is not None:
self._cache_object.close()
self._cache_object = None
def register(self):
"""Register a client object. Reference counting for debug purposes."""
with self._reference_counter_lock:
self._check_not_closed()
if self._closing:
self._debug("Instance tried to connect to closing cache")
raise IOError("Cannot open new file handle: lazy file cache is closing")
self._reference_counter += 1
self._debug("Instance connected to lazy cache")
def unregister(self):
"""Unregister a client object. Reference counting for debug purposes."""
self._debug("Instance disconnected from lazy cache")
with self._reference_counter_lock:
self._reference_counter -= 1
if self._closing and (self._reference_counter == 0):
self.force_close()
def pass_read(self, start=0, maxbytes=None):
"""Read from position start up to maxbytes bytes from file.
If maxbytes is not set, read the entire file."""
self._check_not_closed()
# Do we need to pass the read request to the underlying file object?
passthrough = False
if not self._all_cached:
# Ensure that relevant data is in cache
if maxbytes is None:
self._cache_all()
if not self._all_cached:
passthrough = True
else:
self._cache_up_to(start + maxbytes)
if self._cache_limit_reached:
passthrough = start + maxbytes > self._cache_size
if passthrough:
with self._file_lock:
self._file.seek(start)
if maxbytes is None:
self._debug("Passing through read from %d" % start)
return self._file.read(), self._file.tell()
else:
self._debug(
"Passing through read from %d to %d"
% (start, start + maxbytes - 1)
)
return self._file.read(maxbytes), self._file.tell()
else:
self._cache_object.seek(start)
if maxbytes is None:
return self._cache_object.read(), self._cache_object.tell()
else:
return self._cache_object.read(maxbytes), self._cache_object.tell()
def pass_readline(self, start=0, maxbytes=None):
"""Read a line from file, but no more than maxbytes bytes."""
self._check_not_closed()
if self._all_cached:
self._cache_object.seek(start)
if maxbytes is None:
return self._cache_object.readline(), self._cache_object.tell()
else:
return self._cache_object.readline(maxbytes), self._cache_object.tell()
if self._cache_size <= start:
self._cache_up_to(start + self._page_size)
self._cache_object.seek(start)
if maxbytes is None:
line_candidate = self._cache_object.readline()
else:
line_candidate = self._cache_object.readline(maxbytes)
end_position = self._cache_object.tell()
if end_position < self._cache_size or line_candidate.endswith(b"\n"):
# Found a complete line within the cache
return line_candidate, end_position
if (maxbytes is not None) and (end_position == start + maxbytes):
# Fulfilled maxbytes condition within the cache
return line_candidate, end_position
# Need more data
while end_position == self._cache_size and not self._cache_limit_reached:
# Do we have a complete line?
if line_candidate.endswith(b"\n"):
return line_candidate, end_position
# Ran against cache limit. Extend cache
self._cache_up_to(self._cache_size + self._page_size)
self._cache_object.seek(end_position)
# Continue reading
if maxbytes is None:
line_candidate += self._cache_object.readline()
else:
foundbytes = end_position - start
line_candidate += self._cache_object.readline(maxbytes - foundbytes)
end_position = self._cache_object.tell()
# Do we have a complete line?
if line_candidate.endswith(b"\n") or self._all_cached:
return line_candidate, end_position
assert self._cache_limit_reached # Only legitimate way of reaching here
with self._file_lock:
self._file.seek(end_position)
if maxbytes is None:
return line_candidate + self._file.readline(), self._file.tell()
else:
foundbytes = end_position - start
return (
line_candidate + self._file.readline(maxbytes - foundbytes),
self._file.tell(),
)
class pseudo_file(object):
"""A file-like object that serves as frontend to a dxtbx lazy file cache."""
def __init__(self, lazy_cache_object):
self._cache_object = lazy_cache_object
self._cache_object.register()
self._closed = False
self._seek = 0
def __del__(self):
self.close()
def __enter__(self):
return self
def __iter__(self):
return self
def __exit__(self, exc_type, exc_val, exc_tb):
self.close()
return False
def _check_not_closed(self):
if self._closed:
raise IOError("Accessing lazy file cache after closing is not allowed")
def close(self):
self._closed = True
if self._cache_object is not None:
self._cache_object.unregister()
self._cache_object = None
def flush(self):
self._check_not_closed()
def next(self):
data = self.readline()
if data == b"":
raise StopIteration()
return data
__next__ = next
def read(self, size=-1):
self._check_not_closed()
if size > 0:
data, self._seek = self._cache_object.pass_read(
start=self._seek, maxbytes=size
)
elif size == 0:
data = b""
else:
data, self._seek = self._cache_object.pass_read(start=self._seek)
return data
def readline(self, size=-1):
self._check_not_closed()
if size > 0:
data, self._seek = self._cache_object.pass_readline(
start=self._seek, maxbytes=size
)
else:
data, self._seek = self._cache_object.pass_readline(start=self._seek)
return data
def readlines(self, sizehint=-1):
self._check_not_closed()
if sizehint > 0:
data, self._seek = self._cache_object.pass_read(
start=self._seek, maxbytes=sizehint
)
else:
data, self._seek = self._cache_object.pass_read(start=self._seek)
return data.splitlines(True)
def seek(self, offset, whence=os.SEEK_SET):
self._check_not_closed()
if whence == os.SEEK_SET:
self._seek = offset
elif whence == os.SEEK_CUR:
self._seek += offset
else:
raise NotImplementedError(
"Seeking relative to file length is not supported"
)
def tell(self):
self._check_not_closed()
return self._seek
def truncate(self, size=0):
raise NotImplementedError("Truncating lazy file caches is not allowed")
def write(self, string):
raise NotImplementedError("Writing to lazy file caches is not allowed")
def writelines(self, sequence):
raise NotImplementedError("Writing to lazy file caches is not allowed")