← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockdir.py

merge bzr.dev

Show diffs side-by-side

added added

removed removed

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