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
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
|
# -*- coding: utf-8 -*-
# Copyright 2011 OpenStack Foundation.
# All Rights Reserved.
#
# Licensed 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.
from contextlib import contextmanager
import errno
import functools
import logging
import os
from pathlib import Path
import threading
import time
from typing import Callable
from typing import Optional
from typing import Union
from fasteners import _utils
from fasteners.process_mechanism import _interprocess_mechanism
from fasteners.process_mechanism import _interprocess_reader_writer_mechanism
LOG = logging.getLogger(__name__)
def _ensure_tree(path):
"""Create a directory (and any ancestor directories required).
:param path: Directory to create
"""
try:
os.makedirs(path)
except OSError as e:
if e.errno == errno.EEXIST:
if not os.path.isdir(path):
raise
else:
return False
elif e.errno == errno.EISDIR:
return False
else:
raise
else:
return True
class InterProcessLock:
"""An interprocess lock."""
MAX_DELAY = 0.1 # For backwards compatibility
DELAY_INCREMENT = 0.01 # For backwards compatibility
def __init__(self,
path: Union[Path, str],
sleep_func: Callable[[float], None] = time.sleep,
logger: Optional[logging.Logger] = None):
"""
args:
path:
Path to the file that will be used for locking.
sleep_func:
Optional function to use for sleeping.
logger:
Optional logger to use for logging.
"""
self.lockfile = None
self.path = _utils.canonicalize_path(path)
self.acquired = False
self.sleep_func = sleep_func
self.logger = _utils.pick_first_not_none(logger, LOG)
def _try_acquire(self, blocking, watch):
try:
self.trylock()
except IOError as e:
if e.errno in (errno.EACCES, errno.EAGAIN):
if not blocking or watch.expired():
return False
else:
raise _utils.RetryAgain()
else:
raise threading.ThreadError("Unable to acquire lock on"
" `%(path)s` due to"
" %(exception)s" %
{
'path': self.path,
'exception': e,
})
else:
return True
def _do_open(self):
basedir = os.path.dirname(self.path)
if basedir:
made_basedir = _ensure_tree(basedir)
if made_basedir:
self.logger.log(_utils.BLATHER,
'Created lock base path `%s`', basedir)
# Open in append mode so we don't overwrite any potential contents of
# the target file. This eliminates the possibility of an attacker
# creating a symlink to an important file in our lock path.
if self.lockfile is None or self.lockfile.closed:
self.lockfile = open(self.path, 'a')
def acquire(self,
blocking: bool = True,
delay: float = 0.01,
max_delay: float = 0.1,
timeout: Optional[float] = None) -> bool:
"""Attempt to acquire the lock.
Args:
blocking:
Whether to wait to try to acquire the lock.
delay:
When `blocking`, starting delay as well as the delay increment
(in seconds).
max_delay:
When `blocking` the maximum delay in between attempts to
acquire (in seconds).
timeout:
When `blocking`, maximal waiting time (in seconds).
Returns:
whether or not the acquisition succeeded
"""
if delay < 0:
raise ValueError("Delay must be greater than or equal to zero")
if timeout is not None and timeout < 0:
raise ValueError("Timeout must be greater than or equal to zero")
if delay >= max_delay:
max_delay = delay
self._do_open()
watch = _utils.StopWatch(duration=timeout)
r = _utils.Retry(delay, max_delay,
sleep_func=self.sleep_func, watch=watch)
with watch:
gotten = r(self._try_acquire, blocking, watch)
if not gotten:
return False
else:
self.acquired = True
self.logger.log(_utils.BLATHER,
"Acquired file lock `%s` after waiting %0.3fs [%s"
" attempts were required]", self.path,
watch.elapsed(), r.attempts)
return True
def _do_close(self):
if self.lockfile is not None:
self.lockfile.close()
self.lockfile = None
def __enter__(self):
gotten = self.acquire()
if not gotten:
# This shouldn't happen, but just in case...
raise threading.ThreadError("Unable to acquire a file lock"
" on `%s` (when used as a"
" context manager)" % self.path)
return self
def release(self):
"""Release the previously acquired lock."""
if not self.acquired:
raise threading.ThreadError("Unable to release an unaquired lock")
try:
self.unlock()
except Exception as e:
msg = "Could not unlock the acquired lock opened on `%s`", self.path
self.logger.exception(msg)
raise threading.ThreadError(msg) from e
else:
self.acquired = False
try:
self._do_close()
except IOError:
self.logger.exception("Could not close the file handle"
" opened on `%s`", self.path)
else:
self.logger.log(_utils.BLATHER,
"Unlocked and closed file lock open on"
" `%s`", self.path)
def __exit__(self, exc_type, exc_val, exc_tb):
self.release()
def exists(self):
return os.path.exists(self.path)
def trylock(self):
_interprocess_mechanism.trylock(self.lockfile)
def unlock(self):
_interprocess_mechanism.unlock(self.lockfile)
class InterProcessReaderWriterLock:
"""An interprocess readers writer lock."""
MAX_DELAY = 0.1 # for backwards compatibility
DELAY_INCREMENT = 0.01 # for backwards compatibility
def __init__(self,
path: Union[Path, str],
sleep_func: Callable[[float], None] = time.sleep,
logger: Optional[logging.Logger] = None):
"""
Args:
path:
Path to the file that will be used for locking.
sleep_func:
Optional function to use for sleeping.
logger:
Optional logger to use for logging.
"""
self.lockfile = None
self.path = _utils.canonicalize_path(path)
self.sleep_func = sleep_func
self.logger = _utils.pick_first_not_none(logger, LOG)
@contextmanager
def read_lock(self, delay=0.01, max_delay=0.1):
"""Context manager that grans a read lock"""
self.acquire_read_lock(blocking=True, delay=delay,
max_delay=max_delay, timeout=None)
try:
yield
finally:
self.release_read_lock()
@contextmanager
def write_lock(self, delay=0.01, max_delay=0.1):
"""Context manager that grans a write lock"""
gotten = self.acquire_write_lock(blocking=True, delay=delay,
max_delay=max_delay, timeout=None)
if not gotten:
# This shouldn't happen, but just in case...
raise threading.ThreadError("Unable to acquire a file lock"
" on `%s` (when used as a"
" context manager)" % self.path)
try:
yield
finally:
self.release_write_lock()
def _try_acquire(self, blocking, watch, exclusive):
try:
gotten = _interprocess_reader_writer_mechanism.trylock(self.lockfile, exclusive)
except Exception as e:
raise threading.ThreadError(
"Unable to acquire lock on {} due to {}!".format(self.path, e))
if gotten:
return True
if not blocking or watch.expired():
return False
raise _utils.RetryAgain()
def _do_open(self):
basedir = os.path.dirname(self.path)
if basedir:
made_basedir = _ensure_tree(basedir)
if made_basedir:
self.logger.log(_utils.BLATHER,
'Created lock base path `%s`', basedir)
if self.lockfile is None:
self.lockfile = _interprocess_reader_writer_mechanism.get_handle(self.path)
def acquire_read_lock(self,
blocking: bool = True,
delay: float = 0.01,
max_delay: float = 0.1,
timeout: float = None) -> bool:
"""Attempt to acquire a reader's lock.
Args:
blocking:
Whether to wait to try to acquire the lock.
delay:
When `blocking`, starting delay as well as the delay increment
(in seconds).
max_delay:
When `blocking` the maximum delay in between attempts to
acquire (in seconds).
timeout:
When `blocking`, maximal waiting time (in seconds).
Returns:
whether or not the acquisition succeeded
"""
return self._acquire(blocking, delay, max_delay, timeout, exclusive=False)
def acquire_write_lock(self,
blocking: bool = True,
delay: float = 0.01,
max_delay: float = 0.1,
timeout: float = None) -> bool:
"""Attempt to acquire a writer's lock.
Args:
blocking:
Whether to wait to try to acquire the lock.
delay:
When `blocking`, starting delay as well as the delay increment
(in seconds).
max_delay:
When `blocking` the maximum delay in between attempts to
acquire (in seconds).
timeout:
When `blocking`, maximal waiting time (in seconds).
Returns:
whether or not the acquisition succeeded
"""
return self._acquire(blocking, delay, max_delay, timeout, exclusive=True)
def _acquire(self, blocking=True,
delay=0.01, max_delay=0.1,
timeout=None, exclusive=True):
if delay < 0:
raise ValueError("Delay must be greater than or equal to zero")
if timeout is not None and timeout < 0:
raise ValueError("Timeout must be greater than or equal to zero")
if delay >= max_delay:
max_delay = delay
self._do_open()
watch = _utils.StopWatch(duration=timeout)
r = _utils.Retry(delay, max_delay,
sleep_func=self.sleep_func, watch=watch)
with watch:
gotten = r(self._try_acquire, blocking, watch, exclusive)
if not gotten:
return False
else:
self.logger.log(_utils.BLATHER,
"Acquired file lock `%s` after waiting %0.3fs [%s"
" attempts were required]", self.path,
watch.elapsed(), r.attempts)
return True
def _do_close(self):
if self.lockfile is not None:
_interprocess_reader_writer_mechanism.close_handle(self.lockfile)
self.lockfile = None
def release_write_lock(self):
"""Release the writer's lock."""
try:
_interprocess_reader_writer_mechanism.unlock(self.lockfile)
except IOError:
self.logger.exception("Could not unlock the acquired lock opened"
" on `%s`", self.path)
else:
try:
self._do_close()
except IOError:
self.logger.exception("Could not close the file handle"
" opened on `%s`", self.path)
else:
self.logger.log(_utils.BLATHER,
"Unlocked and closed file lock open on"
" `%s`", self.path)
def release_read_lock(self):
"""Release the reader's lock."""
try:
_interprocess_reader_writer_mechanism.unlock(self.lockfile)
except IOError:
self.logger.exception("Could not unlock the acquired lock opened"
" on `%s`", self.path)
else:
try:
self._do_close()
except IOError:
self.logger.exception("Could not close the file handle"
" opened on `%s`", self.path)
else:
self.logger.log(_utils.BLATHER,
"Unlocked and closed file lock open on"
" `%s`", self.path)
def interprocess_write_locked(path: Union[Path, str]):
"""Acquires & releases an interprocess **write** lock around the call into
the decorated function
Args:
path: Path to the file used for locking.
"""
lock = InterProcessReaderWriterLock(path)
def decorator(f):
@functools.wraps(f)
def wrapper(*args, **kwargs):
with lock.write_lock():
return f(*args, **kwargs)
return wrapper
return decorator
def interprocess_read_locked(path: Union[Path, str]):
"""Acquires & releases an interprocess **read** lock around the call into
the decorated function
Args:
path: Path to the file used for locking.
"""
lock = InterProcessReaderWriterLock(path)
def decorator(f):
@functools.wraps(f)
def wrapper(*args, **kwargs):
with lock.read_lock():
return f(*args, **kwargs)
return wrapper
return decorator
def interprocess_locked(path: Union[Path, str]):
"""Acquires & releases an interprocess lock around the call to the
decorated function.
Args:
path: Path to the file used for locking.
"""
lock = InterProcessLock(path)
def decorator(f):
@functools.wraps(f)
def wrapper(*args, **kwargs):
with lock:
return f(*args, **kwargs)
return wrapper
return decorator
|
