1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
1
# Copyright (C) 2006 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""On-disk mutex protecting a resource
17
"""lock file protecting a resource
19
bzr on-disk objects are locked by the existence of a directory with a
20
particular name within the control directory. We use this rather than OS
21
internal locks (such as flock etc) because they can be seen across all
22
transports, including http.
19
bzr objects are locked by the existence of a file with a particular name
20
within the control directory. We use this rather than OS internal locks
21
(such as flock etc) because they can be seen across all transports,
24
24
Objects can be read if there is only physical read access; therefore
25
25
readers can never be required to create a lock, though they will
118
104
LockBreakMismatch,
128
from bzrlib.hooks import Hooks
129
from bzrlib.trace import mutter, note
130
from bzrlib.osutils import format_delta, rand_chars, get_host_name
133
from bzrlib.lazy_import import lazy_import
134
lazy_import(globals(), """
135
from bzrlib import rio
112
from bzrlib.transport import Transport
113
from bzrlib.osutils import rand_chars
114
from bzrlib.rio import RioWriter, read_stanza, Stanza
138
116
# XXX: At the moment there is no consideration of thread safety on LockDir
139
117
# objects. This should perhaps be updated - e.g. if two threads try to take a
140
118
# lock at the same time they should *both* get it. But then that's unlikely
141
119
# to be a good idea.
121
# TODO: After renaming the directory, check the contents are what we
122
# expected. It's possible that the rename failed but the transport lost
123
# the failure indication.
125
# TODO: Transport could offer a simpler put() method that avoids the
126
# rename-into-place for cases like creating the lock template, where there is
127
# no chance that the file already exists.
143
129
# TODO: Perhaps store some kind of note like the bzr command line in the lock
146
132
# TODO: Some kind of callback run while polling a lock to show progress
149
# TODO: Make sure to pass the right file and directory mode bits to all
150
# files/dirs created.
153
135
_DEFAULT_TIMEOUT_SECONDS = 300
154
_DEFAULT_POLL_SECONDS = 1.0
157
class LockDir(lock.Lock):
136
_DEFAULT_POLL_SECONDS = 0.5
138
class LockDir(object):
158
139
"""Write-lock guarding access to data.
161
__INFO_NAME = '/info'
163
def __init__(self, transport, path, file_modebits=0644, dir_modebits=0755):
144
def __init__(self, transport, path):
164
145
"""Create a new LockDir object.
166
147
The LockDir is initially unlocked - this just creates the object.
190
167
is_held = property(lambda self: self._lock_held)
192
def create(self, mode=None):
193
"""Create the on-disk lock.
195
This is typically only called when the object/directory containing the
196
directory is first created. The lock is not held when it's created.
198
self._trace("create lock directory")
200
self.transport.mkdir(self.path, mode=mode)
201
except (TransportError, PathError), e:
202
raise LockFailed(self, e)
205
def _attempt_lock(self):
206
"""Make the pending directory and attempt to rename into place.
169
def attempt_lock(self):
170
"""Take the lock; fail if it's already held
208
If the rename succeeds, we read back the info file to check that we
211
If we fail to acquire the lock, this method is responsible for
212
cleaning up the pending directory if possible. (But it doesn't do
215
:returns: The nonce of the lock, if it was successfully acquired.
217
:raises LockContention: If the lock is held by someone else. The exception
218
contains the info of the current holder of the lock.
220
self._trace("lock_write...")
221
start_time = time.time()
223
tmpname = self._create_pending_dir()
224
except (errors.TransportError, PathError), e:
225
self._trace("... failed to create pending dir, %s", e)
226
raise LockFailed(self, e)
228
self.transport.rename(tmpname, self._held_dir)
229
except (errors.TransportError, PathError, DirectoryNotEmpty,
230
FileExists, ResourceBusy), e:
231
self._trace("... contention, %s", e)
232
self._remove_pending_dir(tmpname)
233
raise LockContention(self)
235
self._trace("... lock failed, %s", e)
236
self._remove_pending_dir(tmpname)
238
# We must check we really got the lock, because Launchpad's sftp
239
# server at one time had a bug were the rename would successfully
240
# move the new directory into the existing directory, which was
241
# incorrect. It's possible some other servers or filesystems will
242
# have a similar bug allowing someone to think they got the lock
243
# when it's already held.
245
self._trace("after locking, info=%r", info)
246
if info['nonce'] != self.nonce:
247
self._trace("rename succeeded, "
248
"but lock is still held by someone else")
249
raise LockContention(self)
250
self._lock_held = True
251
self._trace("... lock succeeded after %dms",
252
(time.time() - start_time) * 1000)
255
def _remove_pending_dir(self, tmpname):
256
"""Remove the pending directory
258
This is called if we failed to rename into place, so that the pending
259
dirs don't clutter up the lockdir.
261
self._trace("remove %s", tmpname)
263
self.transport.delete(tmpname + self.__INFO_NAME)
264
self.transport.rmdir(tmpname)
266
note("error removing pending lock: %s", e)
268
def _create_pending_dir(self):
269
tmpname = '%s/%s.tmp' % (self.path, rand_chars(10))
271
self.transport.mkdir(tmpname)
273
# This may raise a FileExists exception
274
# which is okay, it will be caught later and determined
275
# to be a LockContention.
276
self._trace("lock directory does not exist, creating it")
277
self.create(mode=self._dir_modebits)
278
# After creating the lock directory, try again
279
self.transport.mkdir(tmpname)
280
self.nonce = rand_chars(20)
281
info_bytes = self._prepare_info()
282
# We use put_file_non_atomic because we just created a new unique
283
# directory so we don't have to worry about files existing there.
284
# We'll rename the whole directory into place to get atomic
286
self.transport.put_bytes_non_atomic(tmpname + self.__INFO_NAME,
172
If you wish to block until the lock can be obtained, call wait_lock()
175
if self.transport.is_readonly():
176
raise UnlockableTransport(self.transport)
178
tmpname = '%s.pending.%s.tmp' % (self.path, rand_chars(20))
179
self.transport.mkdir(tmpname)
181
self._prepare_info(sio)
183
self.transport.put(tmpname + self.INFO_NAME, sio)
184
# FIXME: this turns into os.rename on posix, but into a fancy rename
185
# on Windows that may overwrite existing directory trees.
186
# NB: posix rename will overwrite empty directories, but not
187
# non-empty directories.
188
self.transport.move(tmpname, self.path)
189
self._lock_held = True
191
except (DirectoryNotEmpty, FileExists), e:
193
# fall through to here on contention
194
raise LockContention(self)
290
196
def unlock(self):
291
"""Release a held lock
293
if self._fake_read_lock:
294
self._fake_read_lock = False
296
197
if not self._lock_held:
297
198
raise LockNotHeld(self)
298
if self._locked_via_token:
299
self._locked_via_token = False
300
self._lock_held = False
302
old_nonce = self.nonce
303
# rename before deleting, because we can't atomically remove the
305
start_time = time.time()
306
self._trace("unlocking")
307
tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
308
# gotta own it to unlock
310
self.transport.rename(self._held_dir, tmpname)
311
self._lock_held = False
312
self.transport.delete(tmpname + self.__INFO_NAME)
314
self.transport.rmdir(tmpname)
315
except DirectoryNotEmpty, e:
316
# There might have been junk left over by a rename that moved
317
# another locker within the 'held' directory. do a slower
318
# deletion where we list the directory and remove everything
321
# Maybe this should be broader to allow for ftp servers with
322
# non-specific error messages?
323
self._trace("doing recursive deletion of non-empty directory "
325
self.transport.delete_tree(tmpname)
326
self._trace("... unlock succeeded after %dms",
327
(time.time() - start_time) * 1000)
328
result = lock.LockResult(self.transport.abspath(self.path),
330
for hook in self.hooks['lock_released']:
333
def break_lock(self):
334
"""Break a lock not held by this instance of LockDir.
336
This is a UI centric function: it uses the bzrlib.ui.ui_factory to
337
prompt for input if a lock is detected and there is any doubt about
338
it possibly being still active.
340
self._check_not_locked()
341
holder_info = self.peek()
342
if holder_info is not None:
343
lock_info = '\n'.join(self._format_lock_info(holder_info))
344
if bzrlib.ui.ui_factory.get_boolean("Break %s" % lock_info):
345
self.force_break(holder_info)
199
# rename before deleting, because we can't atomically remove the whole
201
tmpname = '%s.releasing.%s.tmp' % (self.path, rand_chars(20))
202
self.transport.rename(self.path, tmpname)
203
self._lock_held = False
204
self.transport.delete(tmpname + self.INFO_NAME)
205
self.transport.rmdir(tmpname)
347
207
def force_break(self, dead_holder_info):
348
208
"""Release a lock held by another process.
363
223
if not isinstance(dead_holder_info, dict):
364
224
raise ValueError("dead_holder_info: %r" % dead_holder_info)
365
self._check_not_locked()
226
raise AssertionError("can't break own lock: %r" % self)
366
227
current_info = self.peek()
367
228
if current_info is None:
368
229
# must have been recently released
370
231
if current_info != dead_holder_info:
371
232
raise LockBreakMismatch(self, current_info, dead_holder_info)
372
tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
373
self.transport.rename(self._held_dir, tmpname)
233
tmpname = '%s.broken.%s.tmp' % (self.path, rand_chars(20))
234
self.transport.rename(self.path, tmpname)
374
235
# check that we actually broke the right lock, not someone else;
375
236
# there's a small race window between checking it and doing the
377
broken_info_path = tmpname + self.__INFO_NAME
378
broken_info = self._read_info_file(broken_info_path)
238
broken_info_path = tmpname + self.INFO_NAME
239
broken_info = self._parse_info(self.transport.get(broken_info_path))
379
240
if broken_info != dead_holder_info:
380
241
raise LockBreakMismatch(self, broken_info, dead_holder_info)
381
242
self.transport.delete(broken_info_path)
382
243
self.transport.rmdir(tmpname)
384
def _check_not_locked(self):
385
"""If the lock is held by this instance, raise an error."""
387
raise AssertionError("can't break own lock: %r" % self)
389
245
def confirm(self):
390
246
"""Make sure that the lock is still held by this locker.
421
270
Otherwise returns None.
424
info = self._read_info_file(self._held_info_path)
425
self._trace("peek -> held")
273
info = self._parse_info(self.transport.get(self._info_path))
274
assert isinstance(info, dict), \
275
"bad parse result %r" % info
427
277
except NoSuchFile, e:
428
self._trace("peek -> not held")
430
def _prepare_info(self):
280
def _prepare_info(self, outf):
431
281
"""Write information about a pending lock to a temporary file.
433
284
# XXX: is creating this here inefficient?
434
285
config = bzrlib.config.GlobalConfig()
436
user = config.user_email()
437
except errors.NoEmailInUsername:
438
user = config.username()
439
s = rio.Stanza(hostname=get_host_name(),
286
s = Stanza(hostname=socket.gethostname(),
440
287
pid=str(os.getpid()),
441
288
start_time=str(int(time.time())),
442
289
nonce=self.nonce,
290
user=config.user_email(),
292
RioWriter(outf).write_stanza(s)
447
294
def _parse_info(self, info_file):
448
return rio.read_stanza(info_file.readlines()).as_dict()
450
def attempt_lock(self):
451
"""Take the lock; fail if it's already held.
453
If you wish to block until the lock can be obtained, call wait_lock()
456
:return: The lock token.
457
:raises LockContention: if the lock is held by someone else.
459
if self._fake_read_lock:
460
raise LockContention(self)
461
result = self._attempt_lock()
462
hook_result = lock.LockResult(self.transport.abspath(self.path),
464
for hook in self.hooks['lock_acquired']:
468
def wait_lock(self, timeout=None, poll=None, max_attempts=None):
295
return read_stanza(info_file.readlines()).as_dict()
297
def wait_lock(self, timeout=_DEFAULT_TIMEOUT_SECONDS,
298
poll=_DEFAULT_POLL_SECONDS):
469
299
"""Wait a certain period for a lock.
471
301
If the lock can be acquired within the bounded time, it
473
303
is raised. Either way, this function should return within
474
304
approximately `timeout` seconds. (It may be a bit more if
475
305
a transport operation takes a long time to complete.)
477
:param timeout: Approximate maximum amount of time to wait for the
480
:param poll: Delay in seconds between retrying the lock.
482
:param max_attempts: Maximum number of times to try to lock.
484
:return: The lock token.
487
timeout = _DEFAULT_TIMEOUT_SECONDS
489
poll = _DEFAULT_POLL_SECONDS
490
# XXX: the transport interface doesn't let us guard against operations
491
# there taking a long time, so the total elapsed time or poll interval
492
# may be more than was requested.
307
# XXX: the transport interface doesn't let us guard
308
# against operations there taking a long time.
493
309
deadline = time.time() + timeout
500
return self.attempt_lock()
501
314
except LockContention:
502
# possibly report the blockage, then try again
504
# TODO: In a few cases, we find out that there's contention by
505
# reading the held info and observing that it's not ours. In
506
# those cases it's a bit redundant to read it again. However,
507
# the normal case (??) is that the rename fails and so we
508
# don't know who holds the lock. For simplicity we peek
510
new_info = self.peek()
511
if new_info is not None and new_info != last_info:
512
if last_info is None:
513
start = 'Unable to obtain'
515
start = 'Lock owner changed for'
517
formatted_info = self._format_lock_info(new_info)
518
if deadline_str is None:
519
deadline_str = time.strftime('%H:%M:%S',
520
time.localtime(deadline))
521
lock_url = self.transport.abspath(self.path)
522
self._report_function('%s %s\n'
524
'%s\n' # locked ... ago
525
'Will continue to try until %s, unless '
527
'If you\'re sure that it\'s not being '
528
'modified, use bzr break-lock %s',
536
if (max_attempts is not None) and (attempt_count >= max_attempts):
537
self._trace("exceeded %d attempts")
538
raise LockContention(self)
539
if time.time() + poll < deadline:
540
self._trace("waiting %ss", poll)
543
self._trace("timeout after waiting %ss", timeout)
544
raise LockContention(self)
546
def leave_in_place(self):
547
self._locked_via_token = True
549
def dont_leave_in_place(self):
550
self._locked_via_token = False
552
def lock_write(self, token=None):
553
"""Wait for and acquire the lock.
555
:param token: if this is already locked, then lock_write will fail
556
unless the token matches the existing lock.
557
:returns: a token if this instance supports tokens, otherwise None.
558
:raises TokenLockingNotSupported: when a token is given but this
559
instance doesn't support using token locks.
560
:raises MismatchedToken: if the specified token doesn't match the token
561
of the existing lock.
563
A token should be passed in if you know that you have locked the object
564
some other way, and need to synchronise this object's state with that
567
XXX: docstring duplicated from LockableFiles.lock_write.
569
if token is not None:
570
self.validate_token(token)
572
self._lock_held = True
573
self._locked_via_token = True
576
return self.wait_lock()
579
"""Compatibility-mode shared lock.
581
LockDir doesn't support shared read-only locks, so this
582
just pretends that the lock is taken but really does nothing.
584
# At the moment Branches are commonly locked for read, but
585
# we can't rely on that remotely. Once this is cleaned up,
586
# reenable this warning to prevent it coming back in
588
## warn("LockDir.lock_read falls back to write lock")
589
if self._lock_held or self._fake_read_lock:
590
raise LockContention(self)
591
self._fake_read_lock = True
593
def _format_lock_info(self, info):
594
"""Turn the contents of peek() into something for the user"""
595
lock_url = self.transport.abspath(self.path)
596
delta = time.time() - int(info['start_time'])
598
'lock %s' % (lock_url,),
599
'held by %(user)s on host %(hostname)s [process #%(pid)s]' % info,
600
'locked %s' % (format_delta(delta),),
603
def validate_token(self, token):
604
if token is not None:
610
lock_token = info.get('nonce')
611
if token != lock_token:
612
raise errors.TokenMismatch(token, lock_token)
614
self._trace("revalidated by token %r", token)
616
def _trace(self, format, *args):
617
if 'lock' not in debug.debug_flags:
619
mutter(str(self) + ": " + (format % args))
316
if time.time() + poll < deadline:
319
raise LockContention(self)
321
def wait(self, timeout=20, poll=0.5):
322
"""Wait a certain period for a lock to be released.
324
# XXX: the transport interface doesn't let us guard
325
# against operations there taking a long time.
326
deadline = time.time() + timeout
330
if time.time() + poll < deadline:
333
raise LockContention(self)
added
removed
bzrlib/lockdir.py
