/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/lockdir.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

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-2010 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 cStringIO import StringIO
100
108
 
101
109
from bzrlib import (
 
110
    debug,
102
111
    errors,
 
112
    lock,
 
113
    osutils,
103
114
    )
104
115
import bzrlib.config
 
116
from bzrlib.decorators import only_raises
105
117
from bzrlib.errors import (
106
118
        DirectoryNotEmpty,
107
119
        FileExists,
108
120
        LockBreakMismatch,
109
121
        LockBroken,
110
122
        LockContention,
 
123
        LockFailed,
111
124
        LockNotHeld,
112
125
        NoSuchFile,
113
126
        PathError,
114
127
        ResourceBusy,
115
 
        UnlockableTransport,
 
128
        TransportError,
116
129
        )
117
130
from bzrlib.trace import mutter, note
118
 
from bzrlib.transport import Transport
119
 
from bzrlib.osutils import rand_chars, format_delta
120
 
from bzrlib.rio import read_stanza, Stanza
 
131
from bzrlib.osutils import format_delta, rand_chars, get_host_name
 
132
import bzrlib.ui
121
133
 
 
134
from bzrlib.lazy_import import lazy_import
 
135
lazy_import(globals(), """
 
136
from bzrlib import rio
 
137
""")
122
138
 
123
139
# XXX: At the moment there is no consideration of thread safety on LockDir
124
140
# objects.  This should perhaps be updated - e.g. if two threads try to take a
139
155
_DEFAULT_POLL_SECONDS = 1.0
140
156
 
141
157
 
142
 
class LockDir(object):
143
 
    """Write-lock guarding access to data."""
 
158
class LockDir(lock.Lock):
 
159
    """Write-lock guarding access to data.
 
160
    """
144
161
 
145
162
    __INFO_NAME = '/info'
146
163
 
151
168
 
152
169
        :param transport: Transport which will contain the lock
153
170
 
154
 
        :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
155
172
            transport.
156
173
        """
157
 
        assert isinstance(transport, Transport), \
158
 
            ("not a transport: %r" % transport)
159
174
        self.transport = transport
160
175
        self.path = path
161
176
        self._lock_held = False
 
177
        self._locked_via_token = False
162
178
        self._fake_read_lock = False
163
179
        self._held_dir = path + '/held'
164
180
        self._held_info_path = self._held_dir + self.__INFO_NAME
165
181
        self._file_modebits = file_modebits
166
182
        self._dir_modebits = dir_modebits
167
 
        self.nonce = rand_chars(20)
168
183
 
169
184
        self._report_function = note
170
185
 
178
193
    def create(self, mode=None):
179
194
        """Create the on-disk lock.
180
195
 
181
 
        This is typically only called when the object/directory containing the 
 
196
        This is typically only called when the object/directory containing the
182
197
        directory is first created.  The lock is not held when it's created.
183
198
        """
184
 
        if self.transport.is_readonly():
185
 
            raise UnlockableTransport(self.transport)
186
 
        self.transport.mkdir(self.path, mode=mode)
187
 
 
188
 
    def attempt_lock(self):
189
 
        """Take the lock; fail if it's already held.
190
 
        
191
 
        If you wish to block until the lock can be obtained, call wait_lock()
192
 
        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.
193
220
        """
194
 
        if self._fake_read_lock:
195
 
            raise LockContention(self)
196
 
        if self.transport.is_readonly():
197
 
            raise UnlockableTransport(self.transport)
198
 
        try:
199
 
            tmpname = '%s/pending.%s.tmp' % (self.path, rand_chars(20))
200
 
            try:
201
 
                self.transport.mkdir(tmpname)
202
 
            except NoSuchFile:
203
 
                # This may raise a FileExists exception
204
 
                # which is okay, it will be caught later and determined
205
 
                # to be a LockContention.
206
 
                self.create(mode=self._dir_modebits)
207
 
                
208
 
                # After creating the lock directory, try again
209
 
                self.transport.mkdir(tmpname)
210
 
 
211
 
            info_bytes = self._prepare_info()
212
 
            # We use put_file_non_atomic because we just created a new unique
213
 
            # directory so we don't have to worry about files existing there.
214
 
            # We'll rename the whole directory into place to get atomic
215
 
            # properties
216
 
            self.transport.put_bytes_non_atomic(tmpname + self.__INFO_NAME,
217
 
                                                info_bytes)
218
 
 
 
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:
219
229
            self.transport.rename(tmpname, self._held_dir)
220
 
            self._lock_held = True
221
 
            self.confirm()
222
 
        except (PathError, DirectoryNotEmpty, FileExists, ResourceBusy), e:
223
 
            mutter("contention on %r: %s", self, e)
224
 
            raise LockContention(self)
225
 
 
 
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.get('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)
226
300
    def unlock(self):
227
301
        """Release a held lock
228
302
        """
230
304
            self._fake_read_lock = False
231
305
            return
232
306
        if not self._lock_held:
233
 
            raise LockNotHeld(self)
234
 
        # rename before deleting, because we can't atomically remove the whole
235
 
        # tree
236
 
        tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
237
 
        # gotta own it to unlock
238
 
        self.confirm()
239
 
        self.transport.rename(self._held_dir, tmpname)
240
 
        self._lock_held = False
241
 
        self.transport.delete(tmpname + self.__INFO_NAME)
242
 
        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)
243
342
 
244
343
    def break_lock(self):
245
344
        """Break a lock not held by this instance of LockDir.
254
353
            lock_info = '\n'.join(self._format_lock_info(holder_info))
255
354
            if bzrlib.ui.ui_factory.get_boolean("Break %s" % lock_info):
256
355
                self.force_break(holder_info)
257
 
        
 
356
 
258
357
    def force_break(self, dead_holder_info):
259
358
        """Release a lock held by another process.
260
359
 
268
367
        LockBreakMismatch is raised.
269
368
 
270
369
        After the lock is broken it will not be held by any process.
271
 
        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
272
371
        lock before the breaking process acquires it.
273
372
        """
274
373
        if not isinstance(dead_holder_info, dict):
283
382
        tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
284
383
        self.transport.rename(self._held_dir, tmpname)
285
384
        # check that we actually broke the right lock, not someone else;
286
 
        # 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
287
386
        # rename.
288
387
        broken_info_path = tmpname + self.__INFO_NAME
289
388
        broken_info = self._read_info_file(broken_info_path)
291
390
            raise LockBreakMismatch(self, broken_info, dead_holder_info)
292
391
        self.transport.delete(broken_info_path)
293
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)
294
397
 
295
398
    def _check_not_locked(self):
296
399
        """If the lock is held by this instance, raise an error."""
304
407
        or if the lock has been affected by a bug.
305
408
 
306
409
        If the lock is not thought to be held, raises LockNotHeld.  If
307
 
        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
308
411
        LockBroken.
309
412
        """
310
413
        if not self._lock_held:
316
419
        if info.get('nonce') != self.nonce:
317
420
            # there is a lock, but not ours
318
421
            raise LockBroken(self)
319
 
        
 
422
 
320
423
    def _read_info_file(self, path):
321
424
        """Read one given info file.
322
425
 
323
426
        peek() reads the info file of the lock holder, if any.
324
427
        """
325
 
        return self._parse_info(self.transport.get(path))
 
428
        return self._parse_info(self.transport.get_bytes(path))
326
429
 
327
430
    def peek(self):
328
431
        """Check if the lock is held by anyone.
329
 
        
330
 
        If it is held, this returns the lock info structure as a rio Stanza,
 
432
 
 
433
        If it is held, this returns the lock info structure as a dict
331
434
        which contains some information about the current lock holder.
332
435
        Otherwise returns None.
333
436
        """
334
437
        try:
335
438
            info = self._read_info_file(self._held_info_path)
336
 
            assert isinstance(info, dict), \
337
 
                    "bad parse result %r" % info
 
439
            self._trace("peek -> held")
338
440
            return info
339
441
        except NoSuchFile, e:
340
 
            return None
 
442
            self._trace("peek -> not held")
341
443
 
342
444
    def _prepare_info(self):
343
445
        """Write information about a pending lock to a temporary file.
344
446
        """
345
 
        import socket
346
447
        # XXX: is creating this here inefficient?
347
448
        config = bzrlib.config.GlobalConfig()
348
449
        try:
349
450
            user = config.user_email()
350
451
        except errors.NoEmailInUsername:
351
452
            user = config.username()
352
 
        s = Stanza(hostname=socket.gethostname(),
 
453
        s = rio.Stanza(hostname=get_host_name(),
353
454
                   pid=str(os.getpid()),
354
455
                   start_time=str(int(time.time())),
355
456
                   nonce=self.nonce,
357
458
                   )
358
459
        return s.to_string()
359
460
 
360
 
    def _parse_info(self, info_file):
361
 
        return read_stanza(info_file.readlines()).as_dict()
362
 
 
363
 
    def wait_lock(self, timeout=None, poll=None):
 
461
    def _parse_info(self, info_bytes):
 
462
        stanza = rio.read_stanza(osutils.split_lines(info_bytes))
 
463
        if stanza is None:
 
464
            # see bug 185013; we fairly often end up with the info file being
 
465
            # empty after an interruption; we could log a message here but
 
466
            # there may not be much we can say
 
467
            return {}
 
468
        else:
 
469
            return stanza.as_dict()
 
470
 
 
471
    def attempt_lock(self):
 
472
        """Take the lock; fail if it's already held.
 
473
 
 
474
        If you wish to block until the lock can be obtained, call wait_lock()
 
475
        instead.
 
476
 
 
477
        :return: The lock token.
 
478
        :raises LockContention: if the lock is held by someone else.
 
479
        """
 
480
        if self._fake_read_lock:
 
481
            raise LockContention(self)
 
482
        result = self._attempt_lock()
 
483
        hook_result = lock.LockResult(self.transport.abspath(self.path),
 
484
                self.nonce)
 
485
        for hook in self.hooks['lock_acquired']:
 
486
            hook(hook_result)
 
487
        return result
 
488
 
 
489
    def wait_lock(self, timeout=None, poll=None, max_attempts=None):
364
490
        """Wait a certain period for a lock.
365
491
 
366
492
        If the lock can be acquired within the bounded time, it
368
494
        is raised.  Either way, this function should return within
369
495
        approximately `timeout` seconds.  (It may be a bit more if
370
496
        a transport operation takes a long time to complete.)
 
497
 
 
498
        :param timeout: Approximate maximum amount of time to wait for the
 
499
        lock, in seconds.
 
500
 
 
501
        :param poll: Delay in seconds between retrying the lock.
 
502
 
 
503
        :param max_attempts: Maximum number of times to try to lock.
 
504
 
 
505
        :return: The lock token.
371
506
        """
372
507
        if timeout is None:
373
508
            timeout = _DEFAULT_TIMEOUT_SECONDS
374
509
        if poll is None:
375
510
            poll = _DEFAULT_POLL_SECONDS
376
 
 
377
 
        # XXX: the transport interface doesn't let us guard 
378
 
        # against operations there taking a long time.
 
511
        # XXX: the transport interface doesn't let us guard against operations
 
512
        # there taking a long time, so the total elapsed time or poll interval
 
513
        # may be more than was requested.
379
514
        deadline = time.time() + timeout
380
515
        deadline_str = None
381
516
        last_info = None
 
517
        attempt_count = 0
382
518
        while True:
 
519
            attempt_count += 1
383
520
            try:
384
 
                self.attempt_lock()
385
 
                return
 
521
                return self.attempt_lock()
386
522
            except LockContention:
 
523
                # possibly report the blockage, then try again
387
524
                pass
 
525
            # TODO: In a few cases, we find out that there's contention by
 
526
            # reading the held info and observing that it's not ours.  In
 
527
            # those cases it's a bit redundant to read it again.  However,
 
528
            # the normal case (??) is that the rename fails and so we
 
529
            # don't know who holds the lock.  For simplicity we peek
 
530
            # always.
388
531
            new_info = self.peek()
389
 
            mutter('last_info: %s, new info: %s', last_info, new_info)
390
532
            if new_info is not None and new_info != last_info:
391
533
                if last_info is None:
392
534
                    start = 'Unable to obtain'
397
539
                if deadline_str is None:
398
540
                    deadline_str = time.strftime('%H:%M:%S',
399
541
                                                 time.localtime(deadline))
 
542
                lock_url = self.transport.abspath(self.path)
 
543
                # See <https://bugs.edge.launchpad.net/bzr/+bug/250451>
 
544
                # the URL here is sometimes not one that is useful to the
 
545
                # user, perhaps being wrapped in a lp-%d or chroot decorator,
 
546
                # especially if this error is issued from the server.
400
547
                self._report_function('%s %s\n'
401
 
                                      '%s\n' # held by
402
 
                                      '%s\n' # locked ... ago
403
 
                                      'Will continue to try until %s\n',
404
 
                                      start,
405
 
                                      formatted_info[0],
406
 
                                      formatted_info[1],
407
 
                                      formatted_info[2],
408
 
                                      deadline_str)
 
548
                    '%s\n' # held by
 
549
                    '%s\n' # locked ... ago
 
550
                    'Will continue to try until %s, unless '
 
551
                    'you press Ctrl-C.\n'
 
552
                    'See "bzr help break-lock" for more.',
 
553
                    start,
 
554
                    formatted_info[0],
 
555
                    formatted_info[1],
 
556
                    formatted_info[2],
 
557
                    deadline_str,
 
558
                    )
409
559
 
 
560
            if (max_attempts is not None) and (attempt_count >= max_attempts):
 
561
                self._trace("exceeded %d attempts")
 
562
                raise LockContention(self)
410
563
            if time.time() + poll < deadline:
 
564
                self._trace("waiting %ss", poll)
411
565
                time.sleep(poll)
412
566
            else:
 
567
                self._trace("timeout after waiting %ss", timeout)
413
568
                raise LockContention(self)
414
569
 
415
 
    def lock_write(self):
416
 
        """Wait for and acquire the lock."""
417
 
        self.wait_lock()
 
570
    def leave_in_place(self):
 
571
        self._locked_via_token = True
 
572
 
 
573
    def dont_leave_in_place(self):
 
574
        self._locked_via_token = False
 
575
 
 
576
    def lock_write(self, token=None):
 
577
        """Wait for and acquire the lock.
 
578
 
 
579
        :param token: if this is already locked, then lock_write will fail
 
580
            unless the token matches the existing lock.
 
581
        :returns: a token if this instance supports tokens, otherwise None.
 
582
        :raises TokenLockingNotSupported: when a token is given but this
 
583
            instance doesn't support using token locks.
 
584
        :raises MismatchedToken: if the specified token doesn't match the token
 
585
            of the existing lock.
 
586
 
 
587
        A token should be passed in if you know that you have locked the object
 
588
        some other way, and need to synchronise this object's state with that
 
589
        fact.
 
590
 
 
591
        XXX: docstring duplicated from LockableFiles.lock_write.
 
592
        """
 
593
        if token is not None:
 
594
            self.validate_token(token)
 
595
            self.nonce = token
 
596
            self._lock_held = True
 
597
            self._locked_via_token = True
 
598
            return token
 
599
        else:
 
600
            return self.wait_lock()
418
601
 
419
602
    def lock_read(self):
420
603
        """Compatibility-mode shared lock.
421
604
 
422
 
        LockDir doesn't support shared read-only locks, so this 
 
605
        LockDir doesn't support shared read-only locks, so this
423
606
        just pretends that the lock is taken but really does nothing.
424
607
        """
425
 
        # At the moment Branches are commonly locked for read, but 
 
608
        # At the moment Branches are commonly locked for read, but
426
609
        # we can't rely on that remotely.  Once this is cleaned up,
427
 
        # reenable this warning to prevent it coming back in 
 
610
        # reenable this warning to prevent it coming back in
428
611
        # -- mbp 20060303
429
612
        ## warn("LockDir.lock_read falls back to write lock")
430
613
        if self._lock_held or self._fake_read_lock:
431
614
            raise LockContention(self)
432
615
        self._fake_read_lock = True
433
616
 
434
 
    def wait(self, timeout=20, poll=0.5):
435
 
        """Wait a certain period for a lock to be released."""
436
 
        # XXX: the transport interface doesn't let us guard 
437
 
        # against operations there taking a long time.
438
 
        deadline = time.time() + timeout
439
 
        while True:
440
 
            if self.peek():
441
 
                return
442
 
            if time.time() + poll < deadline:
443
 
                time.sleep(poll)
444
 
            else:
445
 
                raise LockContention(self)
446
 
 
447
617
    def _format_lock_info(self, info):
448
618
        """Turn the contents of peek() into something for the user"""
449
619
        lock_url = self.transport.abspath(self.path)
450
 
        delta = time.time() - int(info['start_time'])
 
620
        start_time = info.get('start_time')
 
621
        if start_time is None:
 
622
            time_ago = '(unknown)'
 
623
        else:
 
624
            time_ago = format_delta(time.time() - int(info['start_time']))
451
625
        return [
452
626
            'lock %s' % (lock_url,),
453
 
            'held by %(user)s on host %(hostname)s [process #%(pid)s]' % info,
454
 
            'locked %s' % (format_delta(delta),),
 
627
            'held by %s on host %s [process #%s]' %
 
628
                tuple([info.get(x, '<unknown>') for x in ['user', 'hostname', 'pid']]),
 
629
            'locked %s' % (time_ago,),
455
630
            ]
456
631
 
 
632
    def validate_token(self, token):
 
633
        if token is not None:
 
634
            info = self.peek()
 
635
            if info is None:
 
636
                # Lock isn't held
 
637
                lock_token = None
 
638
            else:
 
639
                lock_token = info.get('nonce')
 
640
            if token != lock_token:
 
641
                raise errors.TokenMismatch(token, lock_token)
 
642
            else:
 
643
                self._trace("revalidated by token %r", token)
 
644
 
 
645
    def _trace(self, format, *args):
 
646
        if 'lock' not in debug.debug_flags:
 
647
            return
 
648
        mutter(str(self) + ": " + (format % args))