/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: Jelmer Vernooij
  • Date: 2020-02-07 02:14:30 UTC
  • mto: This revision was merged to the branch mainline in revision 7492.
  • Revision ID: jelmer@jelmer.uk-20200207021430-m49iq3x4x8xlib6x
Drop python2 support.

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