/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 breezy/lockdir.py

  • Committer: Robert Collins
  • Date: 2005-12-24 02:20:45 UTC
  • mto: (1185.50.57 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1550.
  • Revision ID: robertc@robertcollins.net-20051224022045-14efc8dfa0e1a4e9
Start tests for api usage.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2011 Canonical Ltd
2
 
#
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
#
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
#
13
 
# You should have received a copy of the GNU General Public License
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
16
 
 
17
 
"""On-disk mutex protecting a resource
18
 
 
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.
23
 
 
24
 
Objects can be read if there is only physical read access; therefore
25
 
readers can never be required to create a lock, though they will
26
 
check whether a writer is using the lock.  Writers can't detect
27
 
whether anyone else is reading from the resource as they write.
28
 
This works because of ordering constraints that make sure readers
29
 
see a consistent view of existing data.
30
 
 
31
 
Waiting for a lock must be done by polling; this can be aborted after
32
 
a timeout.
33
 
 
34
 
Locks must always be explicitly released, typically from a try/finally
35
 
block -- they are not released from a finalizer or when Python
36
 
exits.
37
 
 
38
 
Locks may fail to be released if the process is abruptly terminated
39
 
(machine stop, SIGKILL) or if a remote transport becomes permanently
40
 
disconnected.  There is therefore a method to break an existing lock.
41
 
This should rarely be used, and generally only with user approval.
42
 
Locks contain some information on when the lock was taken and by who
43
 
which may guide in deciding whether it can safely be broken.  (This is
44
 
similar to the messages displayed by emacs and vim.) Note that if the
45
 
lock holder is still alive they will get no notification that the lock
46
 
has been broken and will continue their work -- so it is important to be
47
 
sure they are actually dead.
48
 
 
49
 
A lock is represented on disk by a directory of a particular name,
50
 
containing an information file.  Taking a lock is done by renaming a
51
 
temporary directory into place.  We use temporary directories because
52
 
for all known transports and filesystems we believe that exactly one
53
 
attempt to claim the lock will succeed and the others will fail.  (Files
54
 
won't do because some filesystems or transports only have
55
 
rename-and-overwrite, making it hard to tell who won.)
56
 
 
57
 
The desired characteristics are:
58
 
 
59
 
* Locks are not reentrant.  (That is, a client that tries to take a
60
 
  lock it already holds may deadlock or fail.)
61
 
* Stale locks can be guessed at by a heuristic
62
 
* Lost locks can be broken by any client
63
 
* Failed lock operations leave little or no mess
64
 
* Deadlocks are avoided by having a timeout always in use, clients
65
 
  desiring indefinite waits can retry or set a silly big timeout.
66
 
 
67
 
Storage formats use the locks, and also need to consider concurrency
68
 
issues underneath the lock.  A format may choose not to use a lock
69
 
at all for some operations.
70
 
 
71
 
LockDirs always operate over a Transport.  The transport may be readonly, in
72
 
which case the lock can be queried but not acquired.
73
 
 
74
 
Locks are identified by a path name, relative to a base transport.
75
 
 
76
 
Calling code will typically want to make sure there is exactly one LockDir
77
 
object per actual lock on disk.  This module does nothing to prevent aliasing
78
 
and deadlocks will likely occur if the locks are aliased.
79
 
 
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
82
 
update the timestamp within it.
83
 
 
84
 
Example usage:
85
 
 
86
 
>>> from breezy.transport.memory import MemoryTransport
87
 
>>> # typically will be obtained from a BzrDir, Branch, etc
88
 
>>> t = MemoryTransport()
89
 
>>> l = LockDir(t, 'sample-lock')
90
 
>>> l.create()
91
 
>>> token = l.wait_lock()
92
 
>>> # do something here
93
 
>>> l.unlock()
94
 
 
95
 
Some classes of stale locks can be predicted by checking: the host name is the
96
 
same as the local host name; the user name is the same as the local user; the
97
 
process id no longer exists.  The check on user name is not strictly necessary
98
 
but helps protect against colliding host names.
99
 
"""
100
 
 
101
 
 
102
 
# TODO: We sometimes have the problem that our attempt to rename '1234' to
103
 
# 'held' fails because the transport server moves into an existing directory,
104
 
# rather than failing the rename.  If we made the info file name the same as
105
 
# the locked directory name we would avoid this problem because moving into
106
 
# the held directory would implicitly clash.  However this would not mesh with
107
 
# the existing locking code and needs a new format of the containing object.
108
 
# -- robertc, mbp 20070628
109
 
 
110
 
import os
111
 
import time
112
 
 
113
 
from . import (
114
 
    config,
115
 
    debug,
116
 
    errors,
117
 
    lock,
118
 
    osutils,
119
 
    rio,
120
 
    ui,
121
 
    urlutils,
122
 
    )
123
 
from .decorators import only_raises
124
 
from .errors import (
125
 
    DirectoryNotEmpty,
126
 
    FileExists,
127
 
    LockBreakMismatch,
128
 
    LockBroken,
129
 
    LockContention,
130
 
    LockCorrupt,
131
 
    LockFailed,
132
 
    LockNotHeld,
133
 
    NoSuchFile,
134
 
    PathError,
135
 
    ResourceBusy,
136
 
    TransportError,
137
 
    )
138
 
from .i18n import gettext
139
 
from .osutils import format_delta, rand_chars, get_host_name
140
 
from .trace import mutter, note
141
 
 
142
 
 
143
 
# XXX: At the moment there is no consideration of thread safety on LockDir
144
 
# objects.  This should perhaps be updated - e.g. if two threads try to take a
145
 
# lock at the same time they should *both* get it.  But then that's unlikely
146
 
# to be a good idea.
147
 
 
148
 
# TODO: Perhaps store some kind of note like the bzr command line in the lock
149
 
# info?
150
 
 
151
 
# TODO: Some kind of callback run while polling a lock to show progress
152
 
# indicators.
153
 
 
154
 
# TODO: Make sure to pass the right file and directory mode bits to all
155
 
# files/dirs created.
156
 
 
157
 
 
158
 
_DEFAULT_TIMEOUT_SECONDS = 30
159
 
_DEFAULT_POLL_SECONDS = 1.0
160
 
 
161
 
 
162
 
class LockDir(lock.Lock):
163
 
    """Write-lock guarding access to data.
164
 
    """
165
 
 
166
 
    __INFO_NAME = '/info'
167
 
 
168
 
    def __init__(self, transport, path, file_modebits=0o644,
169
 
                 dir_modebits=0o755, extra_holder_info=None):
170
 
        """Create a new LockDir object.
171
 
 
172
 
        The LockDir is initially unlocked - this just creates the object.
173
 
 
174
 
        :param transport: Transport which will contain the lock
175
 
 
176
 
        :param path: Path to the lock within the base directory of the
177
 
            transport.
178
 
 
179
 
        :param extra_holder_info: If passed, {str:str} dict of extra or
180
 
            updated information to insert into the info file when the lock is
181
 
            taken.
182
 
        """
183
 
        self.transport = transport
184
 
        self.path = path
185
 
        self._lock_held = False
186
 
        self._locked_via_token = False
187
 
        self._fake_read_lock = False
188
 
        self._held_dir = path + '/held'
189
 
        self._held_info_path = self._held_dir + self.__INFO_NAME
190
 
        self._file_modebits = file_modebits
191
 
        self._dir_modebits = dir_modebits
192
 
        self._report_function = note
193
 
        self.extra_holder_info = extra_holder_info
194
 
        self._warned_about_lock_holder = None
195
 
 
196
 
    def __repr__(self):
197
 
        return '%s(%s%s)' % (self.__class__.__name__,
198
 
                             self.transport.base,
199
 
                             self.path)
200
 
 
201
 
    is_held = property(lambda self: self._lock_held)
202
 
 
203
 
    def create(self, mode=None):
204
 
        """Create the on-disk lock.
205
 
 
206
 
        This is typically only called when the object/directory containing the
207
 
        directory is first created.  The lock is not held when it's created.
208
 
        """
209
 
        self._trace("create lock directory")
210
 
        try:
211
 
            self.transport.mkdir(self.path, mode=mode)
212
 
        except (TransportError, PathError) as e:
213
 
            raise LockFailed(self, e)
214
 
 
215
 
    def _attempt_lock(self):
216
 
        """Make the pending directory and attempt to rename into place.
217
 
 
218
 
        If the rename succeeds, we read back the info file to check that we
219
 
        really got the lock.
220
 
 
221
 
        If we fail to acquire the lock, this method is responsible for
222
 
        cleaning up the pending directory if possible.  (But it doesn't do
223
 
        that yet.)
224
 
 
225
 
        :returns: The nonce of the lock, if it was successfully acquired.
226
 
 
227
 
        :raises LockContention: If the lock is held by someone else.  The
228
 
            exception contains the info of the current holder of the lock.
229
 
        """
230
 
        self._trace("lock_write...")
231
 
        start_time = time.time()
232
 
        try:
233
 
            tmpname = self._create_pending_dir()
234
 
        except (errors.TransportError, PathError) as e:
235
 
            self._trace("... failed to create pending dir, %s", e)
236
 
            raise LockFailed(self, e)
237
 
        while True:
238
 
            try:
239
 
                self.transport.rename(tmpname, self._held_dir)
240
 
                break
241
 
            except (errors.TransportError, PathError, DirectoryNotEmpty,
242
 
                    FileExists, ResourceBusy) as e:
243
 
                self._trace("... contention, %s", e)
244
 
                other_holder = self.peek()
245
 
                self._trace("other holder is %r" % other_holder)
246
 
                try:
247
 
                    self._handle_lock_contention(other_holder)
248
 
                except BaseException:
249
 
                    self._remove_pending_dir(tmpname)
250
 
                    raise
251
 
            except Exception as e:
252
 
                self._trace("... lock failed, %s", e)
253
 
                self._remove_pending_dir(tmpname)
254
 
                raise
255
 
        # We must check we really got the lock, because Launchpad's sftp
256
 
        # server at one time had a bug were the rename would successfully
257
 
        # move the new directory into the existing directory, which was
258
 
        # incorrect.  It's possible some other servers or filesystems will
259
 
        # have a similar bug allowing someone to think they got the lock
260
 
        # when it's already held.
261
 
        #
262
 
        # See <https://bugs.launchpad.net/bzr/+bug/498378> for one case.
263
 
        #
264
 
        # Strictly the check is unnecessary and a waste of time for most
265
 
        # people, but probably worth trapping if something is wrong.
266
 
        info = self.peek()
267
 
        self._trace("after locking, info=%r", info)
268
 
        if info is None:
269
 
            raise LockFailed(self, "lock was renamed into place, but "
270
 
                             "now is missing!")
271
 
        if info.get('nonce') != self.nonce:
272
 
            self._trace("rename succeeded, "
273
 
                        "but lock is still held by someone else")
274
 
            raise LockContention(self)
275
 
        self._lock_held = True
276
 
        self._trace("... lock succeeded after %dms",
277
 
                    (time.time() - start_time) * 1000)
278
 
        return self.nonce
279
 
 
280
 
    def _handle_lock_contention(self, other_holder):
281
 
        """A lock we want to take is held by someone else.
282
 
 
283
 
        This function can: tell the user about it; possibly detect that it's
284
 
        safe or appropriate to steal the lock, or just raise an exception.
285
 
 
286
 
        If this function returns (without raising an exception) the lock will
287
 
        be attempted again.
288
 
 
289
 
        :param other_holder: A LockHeldInfo for the current holder; note that
290
 
            it might be None if the lock can be seen to be held but the info
291
 
            can't be read.
292
 
        """
293
 
        if (other_holder is not None):
294
 
            if other_holder.is_lock_holder_known_dead():
295
 
                if self.get_config().get('locks.steal_dead'):
296
 
                    ui.ui_factory.show_user_warning(
297
 
                        'locks_steal_dead',
298
 
                        lock_url=urlutils.join(self.transport.base, self.path),
299
 
                        other_holder_info=str(other_holder))
300
 
                    self.force_break(other_holder)
301
 
                    self._trace("stole lock from dead holder")
302
 
                    return
303
 
        raise LockContention(self)
304
 
 
305
 
    def _remove_pending_dir(self, tmpname):
306
 
        """Remove the pending directory
307
 
 
308
 
        This is called if we failed to rename into place, so that the pending
309
 
        dirs don't clutter up the lockdir.
310
 
        """
311
 
        self._trace("remove %s", tmpname)
312
 
        try:
313
 
            self.transport.delete(tmpname + self.__INFO_NAME)
314
 
            self.transport.rmdir(tmpname)
315
 
        except PathError as e:
316
 
            note(gettext("error removing pending lock: %s"), e)
317
 
 
318
 
    def _create_pending_dir(self):
319
 
        tmpname = '%s/%s.tmp' % (self.path, rand_chars(10))
320
 
        try:
321
 
            self.transport.mkdir(tmpname)
322
 
        except NoSuchFile:
323
 
            # This may raise a FileExists exception
324
 
            # which is okay, it will be caught later and determined
325
 
            # to be a LockContention.
326
 
            self._trace("lock directory does not exist, creating it")
327
 
            self.create(mode=self._dir_modebits)
328
 
            # After creating the lock directory, try again
329
 
            self.transport.mkdir(tmpname)
330
 
        info = LockHeldInfo.for_this_process(self.extra_holder_info)
331
 
        self.nonce = info.get('nonce')
332
 
        # We use put_file_non_atomic because we just created a new unique
333
 
        # directory so we don't have to worry about files existing there.
334
 
        # We'll rename the whole directory into place to get atomic
335
 
        # properties
336
 
        self.transport.put_bytes_non_atomic(tmpname + self.__INFO_NAME,
337
 
                                            info.to_bytes())
338
 
        return tmpname
339
 
 
340
 
    @only_raises(LockNotHeld, LockBroken)
341
 
    def unlock(self):
342
 
        """Release a held lock
343
 
        """
344
 
        if self._fake_read_lock:
345
 
            self._fake_read_lock = False
346
 
            return
347
 
        if not self._lock_held:
348
 
            return lock.cant_unlock_not_held(self)
349
 
        if self._locked_via_token:
350
 
            self._locked_via_token = False
351
 
            self._lock_held = False
352
 
        else:
353
 
            old_nonce = self.nonce
354
 
            # rename before deleting, because we can't atomically remove the
355
 
            # whole tree
356
 
            start_time = time.time()
357
 
            self._trace("unlocking")
358
 
            tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
359
 
            # gotta own it to unlock
360
 
            self.confirm()
361
 
            self.transport.rename(self._held_dir, tmpname)
362
 
            self._lock_held = False
363
 
            self.transport.delete(tmpname + self.__INFO_NAME)
364
 
            try:
365
 
                self.transport.rmdir(tmpname)
366
 
            except DirectoryNotEmpty:
367
 
                # There might have been junk left over by a rename that moved
368
 
                # another locker within the 'held' directory.  do a slower
369
 
                # deletion where we list the directory and remove everything
370
 
                # within it.
371
 
                self._trace("doing recursive deletion of non-empty directory "
372
 
                            "%s", tmpname)
373
 
                self.transport.delete_tree(tmpname)
374
 
            self._trace("... unlock succeeded after %dms",
375
 
                        (time.time() - start_time) * 1000)
376
 
            result = lock.LockResult(self.transport.abspath(self.path),
377
 
                                     old_nonce)
378
 
            for hook in self.hooks['lock_released']:
379
 
                hook(result)
380
 
 
381
 
    def break_lock(self):
382
 
        """Break a lock not held by this instance of LockDir.
383
 
 
384
 
        This is a UI centric function: it uses the ui.ui_factory to
385
 
        prompt for input if a lock is detected and there is any doubt about
386
 
        it possibly being still active.  force_break is the non-interactive
387
 
        version.
388
 
 
389
 
        :returns: LockResult for the broken lock.
390
 
        """
391
 
        self._check_not_locked()
392
 
        try:
393
 
            holder_info = self.peek()
394
 
        except LockCorrupt as e:
395
 
            # The lock info is corrupt.
396
 
            if ui.ui_factory.get_boolean(u"Break (corrupt %r)" % (self,)):
397
 
                self.force_break_corrupt(e.file_data)
398
 
            return
399
 
        if holder_info is not None:
400
 
            if ui.ui_factory.confirm_action(
401
 
                u"Break %(lock_info)s",
402
 
                'breezy.lockdir.break',
403
 
                    dict(lock_info=str(holder_info))):
404
 
                result = self.force_break(holder_info)
405
 
                ui.ui_factory.show_message(
406
 
                    "Broke lock %s" % result.lock_url)
407
 
 
408
 
    def force_break(self, dead_holder_info):
409
 
        """Release a lock held by another process.
410
 
 
411
 
        WARNING: This should only be used when the other process is dead; if
412
 
        it still thinks it has the lock there will be two concurrent writers.
413
 
        In general the user's approval should be sought for lock breaks.
414
 
 
415
 
        After the lock is broken it will not be held by any process.
416
 
        It is possible that another process may sneak in and take the
417
 
        lock before the breaking process acquires it.
418
 
 
419
 
        :param dead_holder_info:
420
 
            Must be the result of a previous LockDir.peek() call; this is used
421
 
            to check that it's still held by the same process that the user
422
 
            decided was dead.  If this is not the current holder,
423
 
            LockBreakMismatch is raised.
424
 
 
425
 
        :returns: LockResult for the broken lock.
426
 
        """
427
 
        if not isinstance(dead_holder_info, LockHeldInfo):
428
 
            raise ValueError("dead_holder_info: %r" % dead_holder_info)
429
 
        self._check_not_locked()
430
 
        current_info = self.peek()
431
 
        if current_info is None:
432
 
            # must have been recently released
433
 
            return
434
 
        if current_info != dead_holder_info:
435
 
            raise LockBreakMismatch(self, current_info, dead_holder_info)
436
 
        tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
437
 
        self.transport.rename(self._held_dir, tmpname)
438
 
        # check that we actually broke the right lock, not someone else;
439
 
        # there's a small race window between checking it and doing the
440
 
        # rename.
441
 
        broken_info_path = tmpname + self.__INFO_NAME
442
 
        broken_info = self._read_info_file(broken_info_path)
443
 
        if broken_info != dead_holder_info:
444
 
            raise LockBreakMismatch(self, broken_info, dead_holder_info)
445
 
        self.transport.delete(broken_info_path)
446
 
        self.transport.rmdir(tmpname)
447
 
        result = lock.LockResult(self.transport.abspath(self.path),
448
 
                                 current_info.get('nonce'))
449
 
        for hook in self.hooks['lock_broken']:
450
 
            hook(result)
451
 
        return result
452
 
 
453
 
    def force_break_corrupt(self, corrupt_info_lines):
454
 
        """Release a lock that has been corrupted.
455
 
 
456
 
        This is very similar to force_break, it except it doesn't assume that
457
 
        self.peek() can work.
458
 
 
459
 
        :param corrupt_info_lines: the lines of the corrupted info file, used
460
 
            to check that the lock hasn't changed between reading the (corrupt)
461
 
            info file and calling force_break_corrupt.
462
 
        """
463
 
        # XXX: this copes with unparseable info files, but what about missing
464
 
        # info files?  Or missing lock dirs?
465
 
        self._check_not_locked()
466
 
        tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
467
 
        self.transport.rename(self._held_dir, tmpname)
468
 
        # check that we actually broke the right lock, not someone else;
469
 
        # there's a small race window between checking it and doing the
470
 
        # rename.
471
 
        broken_info_path = tmpname + self.__INFO_NAME
472
 
        broken_content = self.transport.get_bytes(broken_info_path)
473
 
        broken_lines = osutils.split_lines(broken_content)
474
 
        if broken_lines != corrupt_info_lines:
475
 
            raise LockBreakMismatch(self, broken_lines, corrupt_info_lines)
476
 
        self.transport.delete(broken_info_path)
477
 
        self.transport.rmdir(tmpname)
478
 
        result = lock.LockResult(self.transport.abspath(self.path))
479
 
        for hook in self.hooks['lock_broken']:
480
 
            hook(result)
481
 
 
482
 
    def _check_not_locked(self):
483
 
        """If the lock is held by this instance, raise an error."""
484
 
        if self._lock_held:
485
 
            raise AssertionError("can't break own lock: %r" % self)
486
 
 
487
 
    def confirm(self):
488
 
        """Make sure that the lock is still held by this locker.
489
 
 
490
 
        This should only fail if the lock was broken by user intervention,
491
 
        or if the lock has been affected by a bug.
492
 
 
493
 
        If the lock is not thought to be held, raises LockNotHeld.  If
494
 
        the lock is thought to be held but has been broken, raises
495
 
        LockBroken.
496
 
        """
497
 
        if not self._lock_held:
498
 
            raise LockNotHeld(self)
499
 
        info = self.peek()
500
 
        if info is None:
501
 
            # no lock there anymore!
502
 
            raise LockBroken(self)
503
 
        if info.get('nonce') != self.nonce:
504
 
            # there is a lock, but not ours
505
 
            raise LockBroken(self)
506
 
 
507
 
    def _read_info_file(self, path):
508
 
        """Read one given info file.
509
 
 
510
 
        peek() reads the info file of the lock holder, if any.
511
 
        """
512
 
        return LockHeldInfo.from_info_file_bytes(
513
 
            self.transport.get_bytes(path))
514
 
 
515
 
    def peek(self):
516
 
        """Check if the lock is held by anyone.
517
 
 
518
 
        If it is held, this returns the lock info structure as a dict
519
 
        which contains some information about the current lock holder.
520
 
        Otherwise returns None.
521
 
        """
522
 
        try:
523
 
            info = self._read_info_file(self._held_info_path)
524
 
            self._trace("peek -> held")
525
 
            return info
526
 
        except NoSuchFile:
527
 
            self._trace("peek -> not held")
528
 
 
529
 
    def _prepare_info(self):
530
 
        """Write information about a pending lock to a temporary file.
531
 
        """
532
 
 
533
 
    def attempt_lock(self):
534
 
        """Take the lock; fail if it's already held.
535
 
 
536
 
        If you wish to block until the lock can be obtained, call wait_lock()
537
 
        instead.
538
 
 
539
 
        :return: The lock token.
540
 
        :raises LockContention: if the lock is held by someone else.
541
 
        """
542
 
        if self._fake_read_lock:
543
 
            raise LockContention(self)
544
 
        result = self._attempt_lock()
545
 
        hook_result = lock.LockResult(self.transport.abspath(self.path),
546
 
                                      self.nonce)
547
 
        for hook in self.hooks['lock_acquired']:
548
 
            hook(hook_result)
549
 
        return result
550
 
 
551
 
    def lock_url_for_display(self):
552
 
        """Give a nicely-printable representation of the URL of this lock."""
553
 
        # As local lock urls are correct we display them.
554
 
        # We avoid displaying remote lock urls.
555
 
        lock_url = self.transport.abspath(self.path)
556
 
        if lock_url.startswith('file://'):
557
 
            lock_url = lock_url.split('.bzr/')[0]
558
 
        else:
559
 
            lock_url = ''
560
 
        return lock_url
561
 
 
562
 
    def wait_lock(self, timeout=None, poll=None, max_attempts=None):
563
 
        """Wait a certain period for a lock.
564
 
 
565
 
        If the lock can be acquired within the bounded time, it
566
 
        is taken and this returns.  Otherwise, LockContention
567
 
        is raised.  Either way, this function should return within
568
 
        approximately `timeout` seconds.  (It may be a bit more if
569
 
        a transport operation takes a long time to complete.)
570
 
 
571
 
        :param timeout: Approximate maximum amount of time to wait for the
572
 
        lock, in seconds.
573
 
 
574
 
        :param poll: Delay in seconds between retrying the lock.
575
 
 
576
 
        :param max_attempts: Maximum number of times to try to lock.
577
 
 
578
 
        :return: The lock token.
579
 
        """
580
 
        if timeout is None:
581
 
            timeout = _DEFAULT_TIMEOUT_SECONDS
582
 
        if poll is None:
583
 
            poll = _DEFAULT_POLL_SECONDS
584
 
        # XXX: the transport interface doesn't let us guard against operations
585
 
        # there taking a long time, so the total elapsed time or poll interval
586
 
        # may be more than was requested.
587
 
        deadline = time.time() + timeout
588
 
        deadline_str = None
589
 
        last_info = None
590
 
        attempt_count = 0
591
 
        lock_url = self.lock_url_for_display()
592
 
        while True:
593
 
            attempt_count += 1
594
 
            try:
595
 
                return self.attempt_lock()
596
 
            except LockContention:
597
 
                # possibly report the blockage, then try again
598
 
                pass
599
 
            # TODO: In a few cases, we find out that there's contention by
600
 
            # reading the held info and observing that it's not ours.  In
601
 
            # those cases it's a bit redundant to read it again.  However,
602
 
            # the normal case (??) is that the rename fails and so we
603
 
            # don't know who holds the lock.  For simplicity we peek
604
 
            # always.
605
 
            new_info = self.peek()
606
 
            if new_info is not None and new_info != last_info:
607
 
                if last_info is None:
608
 
                    start = gettext('Unable to obtain')
609
 
                else:
610
 
                    start = gettext('Lock owner changed for')
611
 
                last_info = new_info
612
 
                msg = gettext('{0} lock {1} {2}.').format(start, lock_url,
613
 
                                                          new_info)
614
 
                if deadline_str is None:
615
 
                    deadline_str = time.strftime('%H:%M:%S',
616
 
                                                 time.localtime(deadline))
617
 
                if timeout > 0:
618
 
                    msg += '\n' + gettext(
619
 
                        'Will continue to try until %s, unless '
620
 
                        'you press Ctrl-C.') % deadline_str
621
 
                msg += '\n' + gettext('See "brz help break-lock" for more.')
622
 
                self._report_function(msg)
623
 
            if (max_attempts is not None) and (attempt_count >= max_attempts):
624
 
                self._trace("exceeded %d attempts")
625
 
                raise LockContention(self)
626
 
            if time.time() + poll < deadline:
627
 
                self._trace("waiting %ss", poll)
628
 
                time.sleep(poll)
629
 
            else:
630
 
                # As timeout is always 0 for remote locks
631
 
                # this block is applicable only for local
632
 
                # lock contention
633
 
                self._trace("timeout after waiting %ss", timeout)
634
 
                raise LockContention('(local)', lock_url)
635
 
 
636
 
    def leave_in_place(self):
637
 
        self._locked_via_token = True
638
 
 
639
 
    def dont_leave_in_place(self):
640
 
        self._locked_via_token = False
641
 
 
642
 
    def lock_write(self, token=None):
643
 
        """Wait for and acquire the lock.
644
 
 
645
 
        :param token: if this is already locked, then lock_write will fail
646
 
            unless the token matches the existing lock.
647
 
        :returns: a token if this instance supports tokens, otherwise None.
648
 
        :raises TokenLockingNotSupported: when a token is given but this
649
 
            instance doesn't support using token locks.
650
 
        :raises MismatchedToken: if the specified token doesn't match the token
651
 
            of the existing lock.
652
 
 
653
 
        A token should be passed in if you know that you have locked the object
654
 
        some other way, and need to synchronise this object's state with that
655
 
        fact.
656
 
 
657
 
        XXX: docstring duplicated from LockableFiles.lock_write.
658
 
        """
659
 
        if token is not None:
660
 
            self.validate_token(token)
661
 
            self.nonce = token
662
 
            self._lock_held = True
663
 
            self._locked_via_token = True
664
 
            return token
665
 
        else:
666
 
            return self.wait_lock()
667
 
 
668
 
    def lock_read(self):
669
 
        """Compatibility-mode shared lock.
670
 
 
671
 
        LockDir doesn't support shared read-only locks, so this
672
 
        just pretends that the lock is taken but really does nothing.
673
 
        """
674
 
        # At the moment Branches are commonly locked for read, but
675
 
        # we can't rely on that remotely.  Once this is cleaned up,
676
 
        # reenable this warning to prevent it coming back in
677
 
        # -- mbp 20060303
678
 
        # warn("LockDir.lock_read falls back to write lock")
679
 
        if self._lock_held or self._fake_read_lock:
680
 
            raise LockContention(self)
681
 
        self._fake_read_lock = True
682
 
 
683
 
    def validate_token(self, token):
684
 
        if token is not None:
685
 
            info = self.peek()
686
 
            if info is None:
687
 
                # Lock isn't held
688
 
                lock_token = None
689
 
            else:
690
 
                lock_token = info.get('nonce')
691
 
            if token != lock_token:
692
 
                raise errors.TokenMismatch(token, lock_token)
693
 
            else:
694
 
                self._trace("revalidated by token %r", token)
695
 
 
696
 
    def _trace(self, format, *args):
697
 
        if 'lock' not in debug.debug_flags:
698
 
            return
699
 
        mutter(str(self) + ": " + (format % args))
700
 
 
701
 
    def get_config(self):
702
 
        """Get the configuration that governs this lockdir."""
703
 
        # XXX: This really should also use the locationconfig at least, but
704
 
        # that seems a bit hard to hook up at the moment. -- mbp 20110329
705
 
        # FIXME: The above is still true ;) -- vila 20110811
706
 
        return config.GlobalStack()
707
 
 
708
 
 
709
 
class LockHeldInfo(object):
710
 
    """The information recorded about a held lock.
711
 
 
712
 
    This information is recorded into the lock when it's taken, and it can be
713
 
    read back by any process with access to the lockdir.  It can be used, for
714
 
    example, to tell the user who holds the lock, or to try to detect whether
715
 
    the lock holder is still alive.
716
 
 
717
 
    Prior to bzr 2.4 a simple dict was used instead of an object.
718
 
    """
719
 
 
720
 
    def __init__(self, info_dict):
721
 
        self.info_dict = info_dict
722
 
 
723
 
    def __repr__(self):
724
 
        """Return a debugging representation of this object."""
725
 
        return "%s(%r)" % (self.__class__.__name__, self.info_dict)
726
 
 
727
 
    def __str__(self):
728
 
        """Return a user-oriented description of this object."""
729
 
        d = self.to_readable_dict()
730
 
        return (gettext(
731
 
            u'held by %(user)s on %(hostname)s (process #%(pid)s), '
732
 
            u'acquired %(time_ago)s') % d)
733
 
 
734
 
    def to_readable_dict(self):
735
 
        """Turn the holder info into a dict of human-readable attributes.
736
 
 
737
 
        For example, the start time is presented relative to the current time,
738
 
        rather than as seconds since the epoch.
739
 
 
740
 
        Returns a list of [user, hostname, pid, time_ago] all as readable
741
 
        strings.
742
 
        """
743
 
        start_time = self.info_dict.get('start_time')
744
 
        if start_time is None:
745
 
            time_ago = '(unknown)'
746
 
        else:
747
 
            time_ago = format_delta(
748
 
                time.time() - int(self.info_dict['start_time']))
749
 
        user = self.info_dict.get('user', '<unknown>')
750
 
        hostname = self.info_dict.get('hostname', '<unknown>')
751
 
        pid = self.info_dict.get('pid', '<unknown>')
752
 
        return dict(
753
 
            user=user,
754
 
            hostname=hostname,
755
 
            pid=pid,
756
 
            time_ago=time_ago)
757
 
 
758
 
    def get(self, field_name):
759
 
        """Return the contents of a field from the lock info, or None."""
760
 
        return self.info_dict.get(field_name)
761
 
 
762
 
    @classmethod
763
 
    def for_this_process(cls, extra_holder_info):
764
 
        """Return a new LockHeldInfo for a lock taken by this process.
765
 
        """
766
 
        info = dict(
767
 
            hostname=get_host_name(),
768
 
            pid=str(os.getpid()),
769
 
            nonce=rand_chars(20).encode('ascii'),
770
 
            start_time=str(int(time.time())),
771
 
            user=get_username_for_lock_info(),
772
 
            )
773
 
        if extra_holder_info is not None:
774
 
            info.update(extra_holder_info)
775
 
        return cls(info)
776
 
 
777
 
    def to_bytes(self):
778
 
        s = rio.Stanza(**self.info_dict)
779
 
        return s.to_string()
780
 
 
781
 
    @classmethod
782
 
    def from_info_file_bytes(cls, info_file_bytes):
783
 
        """Construct from the contents of the held file."""
784
 
        lines = osutils.split_lines(info_file_bytes)
785
 
        try:
786
 
            stanza = rio.read_stanza(lines)
787
 
        except ValueError as e:
788
 
            mutter('Corrupt lock info file: %r', lines)
789
 
            raise LockCorrupt("could not parse lock info file: " + str(e),
790
 
                              lines)
791
 
        if stanza is None:
792
 
            # see bug 185013; we fairly often end up with the info file being
793
 
            # empty after an interruption; we could log a message here but
794
 
            # there may not be much we can say
795
 
            return cls({})
796
 
        else:
797
 
            ret = stanza.as_dict()
798
 
            ret['nonce'] = ret['nonce'].encode('ascii')
799
 
            return cls(ret)
800
 
 
801
 
    def __hash__(self):
802
 
        return id(self)
803
 
 
804
 
    def __eq__(self, other):
805
 
        """Equality check for lock holders."""
806
 
        if type(self) != type(other):
807
 
            return False
808
 
        return self.info_dict == other.info_dict
809
 
 
810
 
    def __ne__(self, other):
811
 
        return not self == other
812
 
 
813
 
    def is_locked_by_this_process(self):
814
 
        """True if this process seems to be the current lock holder."""
815
 
        return (
816
 
            self.get('hostname') == get_host_name()
817
 
            and self.get('pid') == str(os.getpid())
818
 
            and self.get('user') == get_username_for_lock_info())
819
 
 
820
 
    def is_lock_holder_known_dead(self):
821
 
        """True if the lock holder process is known to be dead.
822
 
 
823
 
        False if it's either known to be still alive, or if we just can't tell.
824
 
 
825
 
        We can be fairly sure the lock holder is dead if it declared the same
826
 
        hostname and there is no process with the given pid alive.  If people
827
 
        have multiple machines with the same hostname this may cause trouble.
828
 
 
829
 
        This doesn't check whether the lock holder is in fact the same process
830
 
        calling this method.  (In that case it will return true.)
831
 
        """
832
 
        if self.get('hostname') != get_host_name():
833
 
            return False
834
 
        if self.get('hostname') == 'localhost':
835
 
            # Too ambiguous.
836
 
            return False
837
 
        if self.get('user') != get_username_for_lock_info():
838
 
            # Could well be another local process by a different user, but
839
 
            # just to be safe we won't conclude about this either.
840
 
            return False
841
 
        pid_str = self.info_dict.get('pid', None)
842
 
        if not pid_str:
843
 
            mutter("no pid recorded in %r" % (self, ))
844
 
            return False
845
 
        try:
846
 
            pid = int(pid_str)
847
 
        except ValueError:
848
 
            mutter("can't parse pid %r from %r"
849
 
                   % (pid_str, self))
850
 
            return False
851
 
        return osutils.is_local_pid_dead(pid)
852
 
 
853
 
 
854
 
def get_username_for_lock_info():
855
 
    """Get a username suitable for putting into a lock.
856
 
 
857
 
    It's ok if what's written here is not a proper email address as long
858
 
    as it gives some clue who the user is.
859
 
    """
860
 
    try:
861
 
        return config.GlobalStack().get('email')
862
 
    except errors.NoWhoami:
863
 
        return osutils.getuser_unicode()