← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockdir.py

  • Committer: Martin Pool
  • Date: 2009-03-24 05:21:02 UTC
  • mfrom: (4192 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4202.
  • Revision ID: mbp@sourcefrog.net-20090324052102-8kk087b32tep3d9h
merge trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockdir.py
1
 
# Copyright (C) 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008 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
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:
105
105
 
106
106
import os
107
107
import time
108
 
from cStringIO import StringIO
109
108
 
110
109
from bzrlib import (
111
110
    debug,
112
111
    errors,
 
112
    lock,
113
113
    )
114
114
import bzrlib.config
115
115
from bzrlib.errors import (
124
124
        PathError,
125
125
        ResourceBusy,
126
126
        TransportError,
127
 
        UnlockableTransport,
128
127
        )
129
128
from bzrlib.trace import mutter, note
130
 
from bzrlib.transport import Transport
131
 
from bzrlib.osutils import rand_chars, format_delta
132
 
from bzrlib.rio import read_stanza, Stanza
 
129
from bzrlib.osutils import format_delta, rand_chars, get_host_name
133
130
import bzrlib.ui
134
131
 
 
132
from bzrlib.lazy_import import lazy_import
 
133
lazy_import(globals(), """
 
134
from bzrlib import rio
 
135
""")
135
136
 
136
137
# XXX: At the moment there is no consideration of thread safety on LockDir
137
138
# objects.  This should perhaps be updated - e.g. if two threads try to take a
152
153
_DEFAULT_POLL_SECONDS = 1.0
153
154
 
154
155
 
155
 
class LockDir(object):
156
 
    """Write-lock guarding access to data."""
 
156
class LockDir(lock.Lock):
 
157
    """Write-lock guarding access to data.
 
158
    """
157
159
 
158
160
    __INFO_NAME = '/info'
159
161
 
164
166
 
165
167
        :param transport: Transport which will contain the lock
166
168
 
167
 
        :param path: Path to the lock within the base directory of the 
 
169
        :param path: Path to the lock within the base directory of the
168
170
            transport.
169
171
        """
170
172
        self.transport = transport
189
191
    def create(self, mode=None):
190
192
        """Create the on-disk lock.
191
193
 
192
 
        This is typically only called when the object/directory containing the 
 
194
        This is typically only called when the object/directory containing the
193
195
        directory is first created.  The lock is not held when it's created.
194
196
        """
195
197
        self._trace("create lock directory")
201
203
 
202
204
    def _attempt_lock(self):
203
205
        """Make the pending directory and attempt to rename into place.
204
 
        
 
206
 
205
207
        If the rename succeeds, we read back the info file to check that we
206
208
        really got the lock.
207
209
 
252
254
    def _remove_pending_dir(self, tmpname):
253
255
        """Remove the pending directory
254
256
 
255
 
        This is called if we failed to rename into place, so that the pending 
 
257
        This is called if we failed to rename into place, so that the pending
256
258
        dirs don't clutter up the lockdir.
257
259
        """
258
260
        self._trace("remove %s", tmpname)
296
298
            self._locked_via_token = False
297
299
            self._lock_held = False
298
300
        else:
 
301
            old_nonce = self.nonce
299
302
            # rename before deleting, because we can't atomically remove the
300
303
            # whole tree
301
304
            start_time = time.time()
321
324
                self.transport.delete_tree(tmpname)
322
325
            self._trace("... unlock succeeded after %dms",
323
326
                    (time.time() - start_time) * 1000)
 
327
            result = lock.LockResult(self.transport.abspath(self.path),
 
328
                old_nonce)
 
329
            for hook in self.hooks['lock_released']:
 
330
                hook(result)
324
331
 
325
332
    def break_lock(self):
326
333
        """Break a lock not held by this instance of LockDir.
335
342
            lock_info = '\n'.join(self._format_lock_info(holder_info))
336
343
            if bzrlib.ui.ui_factory.get_boolean("Break %s" % lock_info):
337
344
                self.force_break(holder_info)
338
 
        
 
345
 
339
346
    def force_break(self, dead_holder_info):
340
347
        """Release a lock held by another process.
341
348
 
349
356
        LockBreakMismatch is raised.
350
357
 
351
358
        After the lock is broken it will not be held by any process.
352
 
        It is possible that another process may sneak in and take the 
 
359
        It is possible that another process may sneak in and take the
353
360
        lock before the breaking process acquires it.
354
361
        """
355
362
        if not isinstance(dead_holder_info, dict):
364
371
        tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
365
372
        self.transport.rename(self._held_dir, tmpname)
366
373
        # check that we actually broke the right lock, not someone else;
367
 
        # there's a small race window between checking it and doing the 
 
374
        # there's a small race window between checking it and doing the
368
375
        # rename.
369
376
        broken_info_path = tmpname + self.__INFO_NAME
370
377
        broken_info = self._read_info_file(broken_info_path)
385
392
        or if the lock has been affected by a bug.
386
393
 
387
394
        If the lock is not thought to be held, raises LockNotHeld.  If
388
 
        the lock is thought to be held but has been broken, raises 
 
395
        the lock is thought to be held but has been broken, raises
389
396
        LockBroken.
390
397
        """
391
398
        if not self._lock_held:
397
404
        if info.get('nonce') != self.nonce:
398
405
            # there is a lock, but not ours
399
406
            raise LockBroken(self)
400
 
        
 
407
 
401
408
    def _read_info_file(self, path):
402
409
        """Read one given info file.
403
410
 
407
414
 
408
415
    def peek(self):
409
416
        """Check if the lock is held by anyone.
410
 
        
 
417
 
411
418
        If it is held, this returns the lock info structure as a rio Stanza,
412
419
        which contains some information about the current lock holder.
413
420
        Otherwise returns None.
422
429
    def _prepare_info(self):
423
430
        """Write information about a pending lock to a temporary file.
424
431
        """
425
 
        import socket
426
432
        # XXX: is creating this here inefficient?
427
433
        config = bzrlib.config.GlobalConfig()
428
434
        try:
429
435
            user = config.user_email()
430
436
        except errors.NoEmailInUsername:
431
437
            user = config.username()
432
 
        s = Stanza(hostname=socket.gethostname(),
 
438
        s = rio.Stanza(hostname=get_host_name(),
433
439
                   pid=str(os.getpid()),
434
440
                   start_time=str(int(time.time())),
435
441
                   nonce=self.nonce,
438
444
        return s.to_string()
439
445
 
440
446
    def _parse_info(self, info_file):
441
 
        return read_stanza(info_file.readlines()).as_dict()
 
447
        return rio.read_stanza(info_file.readlines()).as_dict()
442
448
 
443
449
    def attempt_lock(self):
444
450
        """Take the lock; fail if it's already held.
445
 
        
 
451
 
446
452
        If you wish to block until the lock can be obtained, call wait_lock()
447
453
        instead.
448
454
 
451
457
        """
452
458
        if self._fake_read_lock:
453
459
            raise LockContention(self)
454
 
        return self._attempt_lock()
 
460
        result = self._attempt_lock()
 
461
        hook_result = lock.LockResult(self.transport.abspath(self.path),
 
462
                self.nonce)
 
463
        for hook in self.hooks['lock_acquired']:
 
464
            hook(hook_result)
 
465
        return result
455
466
 
456
467
    def wait_lock(self, timeout=None, poll=None, max_attempts=None):
457
468
        """Wait a certain period for a lock.
464
475
 
465
476
        :param timeout: Approximate maximum amount of time to wait for the
466
477
        lock, in seconds.
467
 
         
 
478
 
468
479
        :param poll: Delay in seconds between retrying the lock.
469
480
 
470
481
        :param max_attempts: Maximum number of times to try to lock.
530
541
            else:
531
542
                self._trace("timeout after waiting %ss", timeout)
532
543
                raise LockContention(self)
533
 
    
 
544
 
534
545
    def leave_in_place(self):
535
546
        self._locked_via_token = True
536
547
 
539
550
 
540
551
    def lock_write(self, token=None):
541
552
        """Wait for and acquire the lock.
542
 
        
 
553
 
543
554
        :param token: if this is already locked, then lock_write will fail
544
555
            unless the token matches the existing lock.
545
556
        :returns: a token if this instance supports tokens, otherwise None.
551
562
        A token should be passed in if you know that you have locked the object
552
563
        some other way, and need to synchronise this object's state with that
553
564
        fact.
554
 
         
 
565
 
555
566
        XXX: docstring duplicated from LockableFiles.lock_write.
556
567
        """
557
568
        if token is not None:
566
577
    def lock_read(self):
567
578
        """Compatibility-mode shared lock.
568
579
 
569
 
        LockDir doesn't support shared read-only locks, so this 
 
580
        LockDir doesn't support shared read-only locks, so this
570
581
        just pretends that the lock is taken but really does nothing.
571
582
        """
572
 
        # At the moment Branches are commonly locked for read, but 
 
583
        # At the moment Branches are commonly locked for read, but
573
584
        # we can't rely on that remotely.  Once this is cleaned up,
574
 
        # reenable this warning to prevent it coming back in 
 
585
        # reenable this warning to prevent it coming back in
575
586
        # -- mbp 20060303
576
587
        ## warn("LockDir.lock_read falls back to write lock")
577
588
        if self._lock_held or self._fake_read_lock: