← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockdir.py

  • Committer: Alexander Belchenko
  • Date: 2006-10-14 08:51:07 UTC
  • mto: (2080.1.1 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 2081.
  • Revision ID: bialix@ukr.net-20061014085107-8dff865674eed30a
win32 installer: make short info page instead of full GPL license text

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockdir.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
 
>>> token = l.wait_lock()
 
91
>>> 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
 
 
106
97
import os
107
98
import time
 
99
from cStringIO import StringIO
108
100
 
109
101
from bzrlib import (
110
 
    debug,
111
102
    errors,
112
 
    lock,
113
 
    osutils,
114
103
    )
115
104
import bzrlib.config
116
 
from bzrlib.decorators import only_raises
117
105
from bzrlib.errors import (
118
106
        DirectoryNotEmpty,
119
107
        FileExists,
120
108
        LockBreakMismatch,
121
109
        LockBroken,
122
110
        LockContention,
123
 
        LockFailed,
124
111
        LockNotHeld,
125
112
        NoSuchFile,
126
113
        PathError,
127
114
        ResourceBusy,
128
 
        TransportError,
 
115
        UnlockableTransport,
129
116
        )
130
117
from bzrlib.trace import mutter, note
131
 
from bzrlib.osutils import format_delta, rand_chars, get_host_name
132
 
import bzrlib.ui
 
118
from bzrlib.transport import Transport
 
119
from bzrlib.osutils import rand_chars, format_delta
 
120
from bzrlib.rio import read_stanza, Stanza
133
121
 
134
 
from bzrlib.lazy_import import lazy_import
135
 
lazy_import(globals(), """
136
 
from bzrlib import rio
137
 
""")
138
122
 
139
123
# XXX: At the moment there is no consideration of thread safety on LockDir
140
124
# objects.  This should perhaps be updated - e.g. if two threads try to take a
151
135
# files/dirs created.
152
136
 
153
137
 
154
 
_DEFAULT_TIMEOUT_SECONDS = 30
 
138
_DEFAULT_TIMEOUT_SECONDS = 300
155
139
_DEFAULT_POLL_SECONDS = 1.0
156
140
 
157
141
 
158
 
class LockDir(lock.Lock):
159
 
    """Write-lock guarding access to data.
160
 
    """
 
142
class LockDir(object):
 
143
    """Write-lock guarding access to data."""
161
144
 
162
145
    __INFO_NAME = '/info'
163
146
 
168
151
 
169
152
        :param transport: Transport which will contain the lock
170
153
 
171
 
        :param path: Path to the lock within the base directory of the
 
154
        :param path: Path to the lock within the base directory of the 
172
155
            transport.
173
156
        """
 
157
        assert isinstance(transport, Transport), \
 
158
            ("not a transport: %r" % transport)
174
159
        self.transport = transport
175
160
        self.path = path
176
161
        self._lock_held = False
177
 
        self._locked_via_token = False
178
162
        self._fake_read_lock = False
179
163
        self._held_dir = path + '/held'
180
164
        self._held_info_path = self._held_dir + self.__INFO_NAME
181
165
        self._file_modebits = file_modebits
182
166
        self._dir_modebits = dir_modebits
 
167
        self.nonce = rand_chars(20)
183
168
 
184
169
        self._report_function = note
185
170
 
193
178
    def create(self, mode=None):
194
179
        """Create the on-disk lock.
195
180
 
196
 
        This is typically only called when the object/directory containing the
 
181
        This is typically only called when the object/directory containing the 
197
182
        directory is first created.  The lock is not held when it's created.
198
183
        """
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.
 
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.
220
193
        """
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:
 
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
 
229
219
            self.transport.rename(tmpname, self._held_dir)
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.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)
 
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
 
300
226
    def unlock(self):
301
227
        """Release a held lock
302
228
        """
304
230
            self._fake_read_lock = False
305
231
            return
306
232
        if not self._lock_held:
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)
 
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)
342
243
 
343
244
    def break_lock(self):
344
245
        """Break a lock not held by this instance of LockDir.
353
254
            lock_info = '\n'.join(self._format_lock_info(holder_info))
354
255
            if bzrlib.ui.ui_factory.get_boolean("Break %s" % lock_info):
355
256
                self.force_break(holder_info)
356
 
 
 
257
        
357
258
    def force_break(self, dead_holder_info):
358
259
        """Release a lock held by another process.
359
260
 
367
268
        LockBreakMismatch is raised.
368
269
 
369
270
        After the lock is broken it will not be held by any process.
370
 
        It is possible that another process may sneak in and take the
 
271
        It is possible that another process may sneak in and take the 
371
272
        lock before the breaking process acquires it.
372
273
        """
373
274
        if not isinstance(dead_holder_info, dict):
382
283
        tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
383
284
        self.transport.rename(self._held_dir, tmpname)
384
285
        # check that we actually broke the right lock, not someone else;
385
 
        # there's a small race window between checking it and doing the
 
286
        # there's a small race window between checking it and doing the 
386
287
        # rename.
387
288
        broken_info_path = tmpname + self.__INFO_NAME
388
289
        broken_info = self._read_info_file(broken_info_path)
390
291
            raise LockBreakMismatch(self, broken_info, dead_holder_info)
391
292
        self.transport.delete(broken_info_path)
392
293
        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)
397
294
 
398
295
    def _check_not_locked(self):
399
296
        """If the lock is held by this instance, raise an error."""
407
304
        or if the lock has been affected by a bug.
408
305
 
409
306
        If the lock is not thought to be held, raises LockNotHeld.  If
410
 
        the lock is thought to be held but has been broken, raises
 
307
        the lock is thought to be held but has been broken, raises 
411
308
        LockBroken.
412
309
        """
413
310
        if not self._lock_held:
419
316
        if info.get('nonce') != self.nonce:
420
317
            # there is a lock, but not ours
421
318
            raise LockBroken(self)
422
 
 
 
319
        
423
320
    def _read_info_file(self, path):
424
321
        """Read one given info file.
425
322
 
426
323
        peek() reads the info file of the lock holder, if any.
427
324
        """
428
 
        return self._parse_info(self.transport.get_bytes(path))
 
325
        return self._parse_info(self.transport.get(path))
429
326
 
430
327
    def peek(self):
431
328
        """Check if the lock is held by anyone.
432
 
 
433
 
        If it is held, this returns the lock info structure as a dict
 
329
        
 
330
        If it is held, this returns the lock info structure as a rio Stanza,
434
331
        which contains some information about the current lock holder.
435
332
        Otherwise returns None.
436
333
        """
437
334
        try:
438
335
            info = self._read_info_file(self._held_info_path)
439
 
            self._trace("peek -> held")
 
336
            assert isinstance(info, dict), \
 
337
                    "bad parse result %r" % info
440
338
            return info
441
339
        except NoSuchFile, e:
442
 
            self._trace("peek -> not held")
 
340
            return None
443
341
 
444
342
    def _prepare_info(self):
445
343
        """Write information about a pending lock to a temporary file.
446
344
        """
 
345
        import socket
447
346
        # XXX: is creating this here inefficient?
448
347
        config = bzrlib.config.GlobalConfig()
449
348
        try:
 
349
            user = config.user_email()
 
350
        except errors.NoEmailInUsername:
450
351
            user = config.username()
451
 
        except errors.NoWhoami:
452
 
            user = osutils.getuser_unicode()
453
 
        s = rio.Stanza(hostname=get_host_name(),
 
352
        s = Stanza(hostname=socket.gethostname(),
454
353
                   pid=str(os.getpid()),
455
354
                   start_time=str(int(time.time())),
456
355
                   nonce=self.nonce,
458
357
                   )
459
358
        return s.to_string()
460
359
 
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):
 
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):
490
364
        """Wait a certain period for a lock.
491
365
 
492
366
        If the lock can be acquired within the bounded time, it
494
368
        is raised.  Either way, this function should return within
495
369
        approximately `timeout` seconds.  (It may be a bit more if
496
370
        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.
506
371
        """
507
372
        if timeout is None:
508
373
            timeout = _DEFAULT_TIMEOUT_SECONDS
509
374
        if poll is None:
510
375
            poll = _DEFAULT_POLL_SECONDS
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.
 
376
 
 
377
        # XXX: the transport interface doesn't let us guard 
 
378
        # against operations there taking a long time.
514
379
        deadline = time.time() + timeout
515
380
        deadline_str = None
516
381
        last_info = None
517
 
        attempt_count = 0
518
382
        while True:
519
 
            attempt_count += 1
520
383
            try:
521
 
                return self.attempt_lock()
 
384
                self.attempt_lock()
 
385
                return
522
386
            except LockContention:
523
 
                # possibly report the blockage, then try again
524
387
                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.
531
388
            new_info = self.peek()
 
389
            mutter('last_info: %s, new info: %s', last_info, new_info)
532
390
            if new_info is not None and new_info != last_info:
533
391
                if last_info is None:
534
392
                    start = 'Unable to obtain'
539
397
                if deadline_str is None:
540
398
                    deadline_str = time.strftime('%H:%M:%S',
541
399
                                                 time.localtime(deadline))
542
 
                # As local lock urls are correct we display them.
543
 
                # We avoid displaying remote lock urls.
544
 
                lock_url = self.transport.abspath(self.path)
545
 
                if lock_url.startswith('file://'):
546
 
                    lock_url = lock_url.split('.bzr/')[0]
547
 
                else:
548
 
                    lock_url = ''
549
 
                user, hostname, pid, time_ago = formatted_info
550
 
                msg = ('%s lock %s '        # lock_url
551
 
                    'held by '              # start
552
 
                    '%s\n'                  # user
553
 
                    'at %s '                # hostname
554
 
                    '[process #%s], '       # pid
555
 
                    'acquired %s.')         # time ago
556
 
                msg_args = [start, lock_url, user, hostname, pid, time_ago]
557
 
                if timeout > 0:
558
 
                    msg += ('\nWill continue to try until %s, unless '
559
 
                        'you press Ctrl-C.')
560
 
                    msg_args.append(deadline_str)
561
 
                msg += '\nSee "bzr help break-lock" for more.'
562
 
                self._report_function(msg, *msg_args)
563
 
            if (max_attempts is not None) and (attempt_count >= max_attempts):
564
 
                self._trace("exceeded %d attempts")
565
 
                raise LockContention(self)
 
400
                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)
 
409
 
566
410
            if time.time() + poll < deadline:
567
 
                self._trace("waiting %ss", poll)
568
411
                time.sleep(poll)
569
412
            else:
570
 
                # As timeout is always 0 for remote locks
571
 
                # this block is applicable only for local
572
 
                # lock contention
573
 
                self._trace("timeout after waiting %ss", timeout)
574
 
                raise LockContention('(local)', lock_url)
575
 
 
576
 
    def leave_in_place(self):
577
 
        self._locked_via_token = True
578
 
 
579
 
    def dont_leave_in_place(self):
580
 
        self._locked_via_token = False
581
 
 
582
 
    def lock_write(self, token=None):
583
 
        """Wait for and acquire the lock.
584
 
 
585
 
        :param token: if this is already locked, then lock_write will fail
586
 
            unless the token matches the existing lock.
587
 
        :returns: a token if this instance supports tokens, otherwise None.
588
 
        :raises TokenLockingNotSupported: when a token is given but this
589
 
            instance doesn't support using token locks.
590
 
        :raises MismatchedToken: if the specified token doesn't match the token
591
 
            of the existing lock.
592
 
 
593
 
        A token should be passed in if you know that you have locked the object
594
 
        some other way, and need to synchronise this object's state with that
595
 
        fact.
596
 
 
597
 
        XXX: docstring duplicated from LockableFiles.lock_write.
598
 
        """
599
 
        if token is not None:
600
 
            self.validate_token(token)
601
 
            self.nonce = token
602
 
            self._lock_held = True
603
 
            self._locked_via_token = True
604
 
            return token
605
 
        else:
606
 
            return self.wait_lock()
 
413
                raise LockContention(self)
 
414
 
 
415
    def lock_write(self):
 
416
        """Wait for and acquire the lock."""
 
417
        self.wait_lock()
607
418
 
608
419
    def lock_read(self):
609
420
        """Compatibility-mode shared lock.
610
421
 
611
 
        LockDir doesn't support shared read-only locks, so this
 
422
        LockDir doesn't support shared read-only locks, so this 
612
423
        just pretends that the lock is taken but really does nothing.
613
424
        """
614
 
        # At the moment Branches are commonly locked for read, but
 
425
        # At the moment Branches are commonly locked for read, but 
615
426
        # we can't rely on that remotely.  Once this is cleaned up,
616
 
        # reenable this warning to prevent it coming back in
 
427
        # reenable this warning to prevent it coming back in 
617
428
        # -- mbp 20060303
618
429
        ## warn("LockDir.lock_read falls back to write lock")
619
430
        if self._lock_held or self._fake_read_lock:
620
431
            raise LockContention(self)
621
432
        self._fake_read_lock = True
622
433
 
 
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
 
623
447
    def _format_lock_info(self, info):
624
448
        """Turn the contents of peek() into something for the user"""
625
 
        start_time = info.get('start_time')
626
 
        if start_time is None:
627
 
            time_ago = '(unknown)'
628
 
        else:
629
 
            time_ago = format_delta(time.time() - int(info['start_time']))
630
 
        user = info.get('user', '<unknown>')
631
 
        hostname = info.get('hostname', '<unknown>')
632
 
        pid = info.get('pid', '<unknown>')
 
449
        lock_url = self.transport.abspath(self.path)
 
450
        delta = time.time() - int(info['start_time'])
633
451
        return [
634
 
            user,
635
 
            hostname,
636
 
            pid,
637
 
            time_ago,
 
452
            'lock %s' % (lock_url,),
 
453
            'held by %(user)s on host %(hostname)s [process #%(pid)s]' % info,
 
454
            'locked %s' % (format_delta(delta),),
638
455
            ]
639
456
 
640
 
    def validate_token(self, token):
641
 
        if token is not None:
642
 
            info = self.peek()
643
 
            if info is None:
644
 
                # Lock isn't held
645
 
                lock_token = None
646
 
            else:
647
 
                lock_token = info.get('nonce')
648
 
            if token != lock_token:
649
 
                raise errors.TokenMismatch(token, lock_token)
650
 
            else:
651
 
                self._trace("revalidated by token %r", token)
652
 
 
653
 
    def _trace(self, format, *args):
654
 
        if 'lock' not in debug.debug_flags:
655
 
            return
656
 
        mutter(str(self) + ": " + (format % args))