/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: 2018-02-18 21:42:57 UTC
  • mto: This revision was merged to the branch mainline in revision 6859.
  • Revision ID: jelmer@jelmer.uk-20180218214257-jpevutp1wa30tz3v
Update TODO to reference Breezy, not Bazaar.

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