← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockdir.py

  • Committer: Patch Queue Manager
  • Date: 2011-09-22 14:12:18 UTC
  • mfrom: (6155.3.1 jam)
  • Revision ID: pqm@pqm.ubuntu.com-20110922141218-86s4uu6nqvourw4f
(jameinel) Cleanup comments bzrlib/smart/__init__.py (John A Meinel)

Show diffs side-by-side

added added

removed removed

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