← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockdir.py

  • Committer: Vincent Ladeuil
  • Date: 2010-02-03 07:18:36 UTC
  • mto: (5008.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5009.
  • Revision ID: v.ladeuil+lp@free.fr-20100203071836-u9b86q68fr9ri5s6
Fix NEWS.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockdir.py
1
 
# Copyright (C) 2006 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
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
12
12
#
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
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""On-disk mutex protecting a resource
18
18
 
21
21
internal locks (such as flock etc) because they can be seen across all
22
22
transports, including http.
23
23
 
24
 
Objects can be read if there is only physical read access; therefore 
 
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
26
26
check whether a writer is using the lock.  Writers can't detect
27
27
whether anyone else is reading from the resource as they write.
56
56
 
57
57
The desired characteristics are:
58
58
 
59
 
* Locks are not reentrant.  (That is, a client that tries to take a 
 
59
* Locks are not reentrant.  (That is, a client that tries to take a
60
60
  lock it already holds may deadlock or fail.)
61
61
* Stale locks can be guessed at by a heuristic
62
62
* Lost locks can be broken by any client
78
78
and deadlocks will likely occur if the locks are aliased.
79
79
 
80
80
In the future we may add a "freshen" method which can be called
81
 
by a lock holder to check that their lock has not been broken, and to 
 
81
by a lock holder to check that their lock has not been broken, and to
82
82
update the timestamp within it.
83
83
 
84
84
Example usage:
88
88
>>> t = MemoryTransport()
89
89
>>> l = LockDir(t, 'sample-lock')
90
90
>>> l.create()
91
 
>>> l.wait_lock()
 
91
>>> token = l.wait_lock()
92
92
>>> # do something here
93
93
>>> l.unlock()
94
94
 
95
95
"""
96
96
 
 
97
 
 
98
# TODO: We sometimes have the problem that our attempt to rename '1234' to
 
99
# 'held' fails because the transport server moves into an existing directory,
 
100
# rather than failing the rename.  If we made the info file name the same as
 
101
# the locked directory name we would avoid this problem because moving into
 
102
# the held directory would implicitly clash.  However this would not mesh with
 
103
# the existing locking code and needs a new format of the containing object.
 
104
# -- robertc, mbp 20070628
 
105
 
97
106
import os
98
107
import time
99
 
from StringIO import StringIO
100
108
 
 
109
from bzrlib import (
 
110
    debug,
 
111
    errors,
 
112
    lock,
 
113
    osutils,
 
114
    )
101
115
import bzrlib.config
 
116
from bzrlib.decorators import only_raises
102
117
from bzrlib.errors import (
103
118
        DirectoryNotEmpty,
104
119
        FileExists,
105
120
        LockBreakMismatch,
106
121
        LockBroken,
107
122
        LockContention,
 
123
        LockFailed,
108
124
        LockNotHeld,
109
125
        NoSuchFile,
110
126
        PathError,
111
127
        ResourceBusy,
112
 
        UnlockableTransport,
 
128
        TransportError,
113
129
        )
114
 
from bzrlib.trace import mutter
115
 
from bzrlib.transport import Transport
116
 
from bzrlib.osutils import rand_chars
117
 
from bzrlib.rio import RioWriter, read_stanza, Stanza
 
130
from bzrlib.trace import mutter, note
 
131
from bzrlib.osutils import format_delta, rand_chars, get_host_name
 
132
import bzrlib.ui
 
133
 
 
134
from bzrlib.lazy_import import lazy_import
 
135
lazy_import(globals(), """
 
136
from bzrlib import rio
 
137
""")
118
138
 
119
139
# XXX: At the moment there is no consideration of thread safety on LockDir
120
140
# objects.  This should perhaps be updated - e.g. if two threads try to take a
130
150
# TODO: Make sure to pass the right file and directory mode bits to all
131
151
# files/dirs created.
132
152
 
 
153
 
133
154
_DEFAULT_TIMEOUT_SECONDS = 300
134
 
_DEFAULT_POLL_SECONDS = 0.5
135
 
 
136
 
class LockDir(object):
137
 
    """Write-lock guarding access to data."""
 
155
_DEFAULT_POLL_SECONDS = 1.0
 
156
 
 
157
 
 
158
class LockDir(lock.Lock):
 
159
    """Write-lock guarding access to data.
 
160
    """
138
161
 
139
162
    __INFO_NAME = '/info'
140
163
 
145
168
 
146
169
        :param transport: Transport which will contain the lock
147
170
 
148
 
        :param path: Path to the lock within the base directory of the 
 
171
        :param path: Path to the lock within the base directory of the
149
172
            transport.
150
173
        """
151
 
        assert isinstance(transport, Transport), \
152
 
            ("not a transport: %r" % transport)
153
174
        self.transport = transport
154
175
        self.path = path
155
176
        self._lock_held = False
 
177
        self._locked_via_token = False
156
178
        self._fake_read_lock = False
157
179
        self._held_dir = path + '/held'
158
180
        self._held_info_path = self._held_dir + self.__INFO_NAME
159
181
        self._file_modebits = file_modebits
160
182
        self._dir_modebits = dir_modebits
161
 
        self.nonce = rand_chars(20)
 
183
 
 
184
        self._report_function = note
162
185
 
163
186
    def __repr__(self):
164
187
        return '%s(%s%s)' % (self.__class__.__name__,
170
193
    def create(self, mode=None):
171
194
        """Create the on-disk lock.
172
195
 
173
 
        This is typically only called when the object/directory containing the 
 
196
        This is typically only called when the object/directory containing the
174
197
        directory is first created.  The lock is not held when it's created.
175
198
        """
176
 
        if self.transport.is_readonly():
177
 
            raise UnlockableTransport(self.transport)
178
 
        self.transport.mkdir(self.path, mode=mode)
179
 
 
180
 
    def attempt_lock(self):
181
 
        """Take the lock; fail if it's already held.
182
 
        
183
 
        If you wish to block until the lock can be obtained, call wait_lock()
184
 
        instead.
 
199
        self._trace("create lock directory")
 
200
        try:
 
201
            self.transport.mkdir(self.path, mode=mode)
 
202
        except (TransportError, PathError), e:
 
203
            raise LockFailed(self, e)
 
204
 
 
205
 
 
206
    def _attempt_lock(self):
 
207
        """Make the pending directory and attempt to rename into place.
 
208
 
 
209
        If the rename succeeds, we read back the info file to check that we
 
210
        really got the lock.
 
211
 
 
212
        If we fail to acquire the lock, this method is responsible for
 
213
        cleaning up the pending directory if possible.  (But it doesn't do
 
214
        that yet.)
 
215
 
 
216
        :returns: The nonce of the lock, if it was successfully acquired.
 
217
 
 
218
        :raises LockContention: If the lock is held by someone else.  The exception
 
219
            contains the info of the current holder of the lock.
185
220
        """
186
 
        if self._fake_read_lock:
187
 
            raise LockContention(self)
188
 
        if self.transport.is_readonly():
189
 
            raise UnlockableTransport(self.transport)
190
 
        try:
191
 
            tmpname = '%s/pending.%s.tmp' % (self.path, rand_chars(20))
192
 
            self.transport.mkdir(tmpname)
193
 
            sio = StringIO()
194
 
            self._prepare_info(sio)
195
 
            sio.seek(0)
196
 
            # append will create a new file; we use append rather than put
197
 
            # because we don't want to write to a temporary file and rename
198
 
            # into place, because that's going to happen to the whole
199
 
            # directory
200
 
            self.transport.append(tmpname + self.__INFO_NAME, sio)
 
221
        self._trace("lock_write...")
 
222
        start_time = time.time()
 
223
        try:
 
224
            tmpname = self._create_pending_dir()
 
225
        except (errors.TransportError, PathError), e:
 
226
            self._trace("... failed to create pending dir, %s", e)
 
227
            raise LockFailed(self, e)
 
228
        try:
201
229
            self.transport.rename(tmpname, self._held_dir)
202
 
            self._lock_held = True
203
 
            self.confirm()
204
 
        except (PathError, DirectoryNotEmpty, FileExists, ResourceBusy), e:
205
 
            mutter("contention on %r: %s", self, e)
206
 
            raise LockContention(self)
207
 
 
 
230
        except (errors.TransportError, PathError, DirectoryNotEmpty,
 
231
                FileExists, ResourceBusy), e:
 
232
            self._trace("... contention, %s", e)
 
233
            self._remove_pending_dir(tmpname)
 
234
            raise LockContention(self)
 
235
        except Exception, e:
 
236
            self._trace("... lock failed, %s", e)
 
237
            self._remove_pending_dir(tmpname)
 
238
            raise
 
239
        # We must check we really got the lock, because Launchpad's sftp
 
240
        # server at one time had a bug were the rename would successfully
 
241
        # move the new directory into the existing directory, which was
 
242
        # incorrect.  It's possible some other servers or filesystems will
 
243
        # have a similar bug allowing someone to think they got the lock
 
244
        # when it's already held.
 
245
        #
 
246
        # See <https://bugs.edge.launchpad.net/bzr/+bug/498378> for one case.
 
247
        #
 
248
        # Strictly the check is unnecessary and a waste of time for most
 
249
        # people, but probably worth trapping if something is wrong.
 
250
        info = self.peek()
 
251
        self._trace("after locking, info=%r", info)
 
252
        if info is None:
 
253
            raise LockFailed(self, "lock was renamed into place, but "
 
254
                "now is missing!")
 
255
        if info['nonce'] != self.nonce:
 
256
            self._trace("rename succeeded, "
 
257
                "but lock is still held by someone else")
 
258
            raise LockContention(self)
 
259
        self._lock_held = True
 
260
        self._trace("... lock succeeded after %dms",
 
261
                (time.time() - start_time) * 1000)
 
262
        return self.nonce
 
263
 
 
264
    def _remove_pending_dir(self, tmpname):
 
265
        """Remove the pending directory
 
266
 
 
267
        This is called if we failed to rename into place, so that the pending
 
268
        dirs don't clutter up the lockdir.
 
269
        """
 
270
        self._trace("remove %s", tmpname)
 
271
        try:
 
272
            self.transport.delete(tmpname + self.__INFO_NAME)
 
273
            self.transport.rmdir(tmpname)
 
274
        except PathError, e:
 
275
            note("error removing pending lock: %s", e)
 
276
 
 
277
    def _create_pending_dir(self):
 
278
        tmpname = '%s/%s.tmp' % (self.path, rand_chars(10))
 
279
        try:
 
280
            self.transport.mkdir(tmpname)
 
281
        except NoSuchFile:
 
282
            # This may raise a FileExists exception
 
283
            # which is okay, it will be caught later and determined
 
284
            # to be a LockContention.
 
285
            self._trace("lock directory does not exist, creating it")
 
286
            self.create(mode=self._dir_modebits)
 
287
            # After creating the lock directory, try again
 
288
            self.transport.mkdir(tmpname)
 
289
        self.nonce = rand_chars(20)
 
290
        info_bytes = self._prepare_info()
 
291
        # We use put_file_non_atomic because we just created a new unique
 
292
        # directory so we don't have to worry about files existing there.
 
293
        # We'll rename the whole directory into place to get atomic
 
294
        # properties
 
295
        self.transport.put_bytes_non_atomic(tmpname + self.__INFO_NAME,
 
296
                                            info_bytes)
 
297
        return tmpname
 
298
 
 
299
    @only_raises(LockNotHeld, LockBroken)
208
300
    def unlock(self):
209
301
        """Release a held lock
210
302
        """
212
304
            self._fake_read_lock = False
213
305
            return
214
306
        if not self._lock_held:
215
 
            raise LockNotHeld(self)
216
 
        # rename before deleting, because we can't atomically remove the whole
217
 
        # tree
218
 
        tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
219
 
        # gotta own it to unlock
220
 
        self.confirm()
221
 
        self.transport.rename(self._held_dir, tmpname)
222
 
        self._lock_held = False
223
 
        self.transport.delete(tmpname + self.__INFO_NAME)
224
 
        self.transport.rmdir(tmpname)
 
307
            return lock.cant_unlock_not_held(self)
 
308
        if self._locked_via_token:
 
309
            self._locked_via_token = False
 
310
            self._lock_held = False
 
311
        else:
 
312
            old_nonce = self.nonce
 
313
            # rename before deleting, because we can't atomically remove the
 
314
            # whole tree
 
315
            start_time = time.time()
 
316
            self._trace("unlocking")
 
317
            tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
 
318
            # gotta own it to unlock
 
319
            self.confirm()
 
320
            self.transport.rename(self._held_dir, tmpname)
 
321
            self._lock_held = False
 
322
            self.transport.delete(tmpname + self.__INFO_NAME)
 
323
            try:
 
324
                self.transport.rmdir(tmpname)
 
325
            except DirectoryNotEmpty, e:
 
326
                # There might have been junk left over by a rename that moved
 
327
                # another locker within the 'held' directory.  do a slower
 
328
                # deletion where we list the directory and remove everything
 
329
                # within it.
 
330
                #
 
331
                # Maybe this should be broader to allow for ftp servers with
 
332
                # non-specific error messages?
 
333
                self._trace("doing recursive deletion of non-empty directory "
 
334
                        "%s", tmpname)
 
335
                self.transport.delete_tree(tmpname)
 
336
            self._trace("... unlock succeeded after %dms",
 
337
                    (time.time() - start_time) * 1000)
 
338
            result = lock.LockResult(self.transport.abspath(self.path),
 
339
                                     old_nonce)
 
340
            for hook in self.hooks['lock_released']:
 
341
                hook(result)
225
342
 
226
343
    def break_lock(self):
227
344
        """Break a lock not held by this instance of LockDir.
233
350
        self._check_not_locked()
234
351
        holder_info = self.peek()
235
352
        if holder_info is not None:
236
 
            if bzrlib.ui.ui_factory.get_boolean(
237
 
                "Break lock %s held by %s@%s [process #%s]" % (
238
 
                    self.transport,
239
 
                    holder_info["user"],
240
 
                    holder_info["hostname"],
241
 
                    holder_info["pid"])):
 
353
            lock_info = '\n'.join(self._format_lock_info(holder_info))
 
354
            if bzrlib.ui.ui_factory.get_boolean("Break %s" % lock_info):
242
355
                self.force_break(holder_info)
243
 
        
 
356
 
244
357
    def force_break(self, dead_holder_info):
245
358
        """Release a lock held by another process.
246
359
 
254
367
        LockBreakMismatch is raised.
255
368
 
256
369
        After the lock is broken it will not be held by any process.
257
 
        It is possible that another process may sneak in and take the 
 
370
        It is possible that another process may sneak in and take the
258
371
        lock before the breaking process acquires it.
259
372
        """
260
373
        if not isinstance(dead_holder_info, dict):
269
382
        tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
270
383
        self.transport.rename(self._held_dir, tmpname)
271
384
        # check that we actually broke the right lock, not someone else;
272
 
        # there's a small race window between checking it and doing the 
 
385
        # there's a small race window between checking it and doing the
273
386
        # rename.
274
387
        broken_info_path = tmpname + self.__INFO_NAME
275
388
        broken_info = self._read_info_file(broken_info_path)
277
390
            raise LockBreakMismatch(self, broken_info, dead_holder_info)
278
391
        self.transport.delete(broken_info_path)
279
392
        self.transport.rmdir(tmpname)
 
393
        result = lock.LockResult(self.transport.abspath(self.path),
 
394
                                 current_info.get('nonce'))
 
395
        for hook in self.hooks['lock_broken']:
 
396
            hook(result)
280
397
 
281
398
    def _check_not_locked(self):
282
399
        """If the lock is held by this instance, raise an error."""
290
407
        or if the lock has been affected by a bug.
291
408
 
292
409
        If the lock is not thought to be held, raises LockNotHeld.  If
293
 
        the lock is thought to be held but has been broken, raises 
 
410
        the lock is thought to be held but has been broken, raises
294
411
        LockBroken.
295
412
        """
296
413
        if not self._lock_held:
302
419
        if info.get('nonce') != self.nonce:
303
420
            # there is a lock, but not ours
304
421
            raise LockBroken(self)
305
 
        
 
422
 
306
423
    def _read_info_file(self, path):
307
424
        """Read one given info file.
308
425
 
309
426
        peek() reads the info file of the lock holder, if any.
310
427
        """
311
 
        return self._parse_info(self.transport.get(path))
 
428
        return self._parse_info(self.transport.get_bytes(path))
312
429
 
313
430
    def peek(self):
314
431
        """Check if the lock is held by anyone.
315
 
        
 
432
 
316
433
        If it is held, this returns the lock info structure as a rio Stanza,
317
434
        which contains some information about the current lock holder.
318
435
        Otherwise returns None.
319
436
        """
320
437
        try:
321
438
            info = self._read_info_file(self._held_info_path)
322
 
            assert isinstance(info, dict), \
323
 
                    "bad parse result %r" % info
 
439
            self._trace("peek -> held")
324
440
            return info
325
441
        except NoSuchFile, e:
326
 
            return None
 
442
            self._trace("peek -> not held")
327
443
 
328
 
    def _prepare_info(self, outf):
 
444
    def _prepare_info(self):
329
445
        """Write information about a pending lock to a temporary file.
330
446
        """
331
 
        import socket
332
447
        # XXX: is creating this here inefficient?
333
448
        config = bzrlib.config.GlobalConfig()
334
 
        s = Stanza(hostname=socket.gethostname(),
 
449
        try:
 
450
            user = config.user_email()
 
451
        except errors.NoEmailInUsername:
 
452
            user = config.username()
 
453
        s = rio.Stanza(hostname=get_host_name(),
335
454
                   pid=str(os.getpid()),
336
455
                   start_time=str(int(time.time())),
337
456
                   nonce=self.nonce,
338
 
                   user=config.user_email(),
 
457
                   user=user,
339
458
                   )
340
 
        RioWriter(outf).write_stanza(s)
341
 
 
342
 
    def _parse_info(self, info_file):
343
 
        return read_stanza(info_file.readlines()).as_dict()
344
 
 
345
 
    def wait_lock(self, timeout=_DEFAULT_TIMEOUT_SECONDS,
346
 
                  poll=_DEFAULT_POLL_SECONDS):
 
459
        return s.to_string()
 
460
 
 
461
    def _parse_info(self, info_bytes):
 
462
        # TODO: Handle if info_bytes is empty
 
463
        return rio.read_stanza(osutils.split_lines(info_bytes)).as_dict()
 
464
 
 
465
    def attempt_lock(self):
 
466
        """Take the lock; fail if it's already held.
 
467
 
 
468
        If you wish to block until the lock can be obtained, call wait_lock()
 
469
        instead.
 
470
 
 
471
        :return: The lock token.
 
472
        :raises LockContention: if the lock is held by someone else.
 
473
        """
 
474
        if self._fake_read_lock:
 
475
            raise LockContention(self)
 
476
        result = self._attempt_lock()
 
477
        hook_result = lock.LockResult(self.transport.abspath(self.path),
 
478
                self.nonce)
 
479
        for hook in self.hooks['lock_acquired']:
 
480
            hook(hook_result)
 
481
        return result
 
482
 
 
483
    def wait_lock(self, timeout=None, poll=None, max_attempts=None):
347
484
        """Wait a certain period for a lock.
348
485
 
349
486
        If the lock can be acquired within the bounded time, it
351
488
        is raised.  Either way, this function should return within
352
489
        approximately `timeout` seconds.  (It may be a bit more if
353
490
        a transport operation takes a long time to complete.)
 
491
 
 
492
        :param timeout: Approximate maximum amount of time to wait for the
 
493
        lock, in seconds.
 
494
 
 
495
        :param poll: Delay in seconds between retrying the lock.
 
496
 
 
497
        :param max_attempts: Maximum number of times to try to lock.
 
498
 
 
499
        :return: The lock token.
354
500
        """
355
 
        # XXX: the transport interface doesn't let us guard 
356
 
        # against operations there taking a long time.
 
501
        if timeout is None:
 
502
            timeout = _DEFAULT_TIMEOUT_SECONDS
 
503
        if poll is None:
 
504
            poll = _DEFAULT_POLL_SECONDS
 
505
        # XXX: the transport interface doesn't let us guard against operations
 
506
        # there taking a long time, so the total elapsed time or poll interval
 
507
        # may be more than was requested.
357
508
        deadline = time.time() + timeout
 
509
        deadline_str = None
 
510
        last_info = None
 
511
        attempt_count = 0
358
512
        while True:
 
513
            attempt_count += 1
359
514
            try:
360
 
                self.attempt_lock()
361
 
                return
 
515
                return self.attempt_lock()
362
516
            except LockContention:
 
517
                # possibly report the blockage, then try again
363
518
                pass
 
519
            # TODO: In a few cases, we find out that there's contention by
 
520
            # reading the held info and observing that it's not ours.  In
 
521
            # those cases it's a bit redundant to read it again.  However,
 
522
            # the normal case (??) is that the rename fails and so we
 
523
            # don't know who holds the lock.  For simplicity we peek
 
524
            # always.
 
525
            new_info = self.peek()
 
526
            if new_info is not None and new_info != last_info:
 
527
                if last_info is None:
 
528
                    start = 'Unable to obtain'
 
529
                else:
 
530
                    start = 'Lock owner changed for'
 
531
                last_info = new_info
 
532
                formatted_info = self._format_lock_info(new_info)
 
533
                if deadline_str is None:
 
534
                    deadline_str = time.strftime('%H:%M:%S',
 
535
                                                 time.localtime(deadline))
 
536
                lock_url = self.transport.abspath(self.path)
 
537
                # See <https://bugs.edge.launchpad.net/bzr/+bug/250451>
 
538
                # the URL here is sometimes not one that is useful to the
 
539
                # user, perhaps being wrapped in a lp-%d or chroot decorator,
 
540
                # especially if this error is issued from the server.
 
541
                self._report_function('%s %s\n'
 
542
                    '%s\n' # held by
 
543
                    '%s\n' # locked ... ago
 
544
                    'Will continue to try until %s, unless '
 
545
                    'you press Ctrl-C.\n'
 
546
                    'See "bzr help break-lock" for more.',
 
547
                    start,
 
548
                    formatted_info[0],
 
549
                    formatted_info[1],
 
550
                    formatted_info[2],
 
551
                    deadline_str,
 
552
                    )
 
553
 
 
554
            if (max_attempts is not None) and (attempt_count >= max_attempts):
 
555
                self._trace("exceeded %d attempts")
 
556
                raise LockContention(self)
364
557
            if time.time() + poll < deadline:
 
558
                self._trace("waiting %ss", poll)
365
559
                time.sleep(poll)
366
560
            else:
 
561
                self._trace("timeout after waiting %ss", timeout)
367
562
                raise LockContention(self)
368
563
 
369
 
    def lock_write(self):
370
 
        """Wait for and acquire the lock."""
371
 
        self.attempt_lock()
 
564
    def leave_in_place(self):
 
565
        self._locked_via_token = True
 
566
 
 
567
    def dont_leave_in_place(self):
 
568
        self._locked_via_token = False
 
569
 
 
570
    def lock_write(self, token=None):
 
571
        """Wait for and acquire the lock.
 
572
 
 
573
        :param token: if this is already locked, then lock_write will fail
 
574
            unless the token matches the existing lock.
 
575
        :returns: a token if this instance supports tokens, otherwise None.
 
576
        :raises TokenLockingNotSupported: when a token is given but this
 
577
            instance doesn't support using token locks.
 
578
        :raises MismatchedToken: if the specified token doesn't match the token
 
579
            of the existing lock.
 
580
 
 
581
        A token should be passed in if you know that you have locked the object
 
582
        some other way, and need to synchronise this object's state with that
 
583
        fact.
 
584
 
 
585
        XXX: docstring duplicated from LockableFiles.lock_write.
 
586
        """
 
587
        if token is not None:
 
588
            self.validate_token(token)
 
589
            self.nonce = token
 
590
            self._lock_held = True
 
591
            self._locked_via_token = True
 
592
            return token
 
593
        else:
 
594
            return self.wait_lock()
372
595
 
373
596
    def lock_read(self):
374
597
        """Compatibility-mode shared lock.
375
598
 
376
 
        LockDir doesn't support shared read-only locks, so this 
 
599
        LockDir doesn't support shared read-only locks, so this
377
600
        just pretends that the lock is taken but really does nothing.
378
601
        """
379
 
        # At the moment Branches are commonly locked for read, but 
 
602
        # At the moment Branches are commonly locked for read, but
380
603
        # we can't rely on that remotely.  Once this is cleaned up,
381
 
        # reenable this warning to prevent it coming back in 
 
604
        # reenable this warning to prevent it coming back in
382
605
        # -- mbp 20060303
383
606
        ## warn("LockDir.lock_read falls back to write lock")
384
607
        if self._lock_held or self._fake_read_lock:
385
608
            raise LockContention(self)
386
609
        self._fake_read_lock = True
387
610
 
388
 
    def wait(self, timeout=20, poll=0.5):
389
 
        """Wait a certain period for a lock to be released."""
390
 
        # XXX: the transport interface doesn't let us guard 
391
 
        # against operations there taking a long time.
392
 
        deadline = time.time() + timeout
393
 
        while True:
394
 
            if self.peek():
395
 
                return
396
 
            if time.time() + poll < deadline:
397
 
                time.sleep(poll)
398
 
            else:
399
 
                raise LockContention(self)
400
 
 
 
611
    def _format_lock_info(self, info):
 
612
        """Turn the contents of peek() into something for the user"""
 
613
        lock_url = self.transport.abspath(self.path)
 
614
        delta = time.time() - int(info['start_time'])
 
615
        return [
 
616
            'lock %s' % (lock_url,),
 
617
            'held by %(user)s on host %(hostname)s [process #%(pid)s]' % info,
 
618
            'locked %s' % (format_delta(delta),),
 
619
            ]
 
620
 
 
621
    def validate_token(self, token):
 
622
        if token is not None:
 
623
            info = self.peek()
 
624
            if info is None:
 
625
                # Lock isn't held
 
626
                lock_token = None
 
627
            else:
 
628
                lock_token = info.get('nonce')
 
629
            if token != lock_token:
 
630
                raise errors.TokenMismatch(token, lock_token)
 
631
            else:
 
632
                self._trace("revalidated by token %r", token)
 
633
 
 
634
    def _trace(self, format, *args):
 
635
        if 'lock' not in debug.debug_flags:
 
636
            return
 
637
        mutter(str(self) + ": " + (format % args))