/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/lockdir.py

  • Committer: John Arbash Meinel
  • Date: 2006-04-25 15:05:42 UTC
  • mfrom: (1185.85.85 bzr-encoding)
  • mto: This revision was merged to the branch mainline in revision 1752.
  • Revision ID: john@arbash-meinel.com-20060425150542-c7b518dca9928691
[merge] the old bzr-encoding changes, reparenting them on bzr.dev

Show diffs side-by-side

added added

removed removed

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