← 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-01-13 03:11:04 UTC
  • mto: This revision was merged to the branch mainline in revision 3937.
  • Revision ID: mbp@sourcefrog.net-20090113031104-03my054s02i9l2pe
Bump version to 1.12 and add news template

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockdir.py
1
 
# Copyright (C) 2006-2010 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
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:
110
110
    debug,
111
111
    errors,
112
112
    lock,
113
 
    osutils,
114
113
    )
115
114
import bzrlib.config
116
 
from bzrlib.decorators import only_raises
117
115
from bzrlib.errors import (
118
116
        DirectoryNotEmpty,
119
117
        FileExists,
127
125
        ResourceBusy,
128
126
        TransportError,
129
127
        )
 
128
from bzrlib.hooks import Hooks
130
129
from bzrlib.trace import mutter, note
131
130
from bzrlib.osutils import format_delta, rand_chars, get_host_name
132
131
import bzrlib.ui
168
167
 
169
168
        :param transport: Transport which will contain the lock
170
169
 
171
 
        :param path: Path to the lock within the base directory of the
 
170
        :param path: Path to the lock within the base directory of the 
172
171
            transport.
173
172
        """
174
173
        self.transport = transport
193
192
    def create(self, mode=None):
194
193
        """Create the on-disk lock.
195
194
 
196
 
        This is typically only called when the object/directory containing the
 
195
        This is typically only called when the object/directory containing the 
197
196
        directory is first created.  The lock is not held when it's created.
198
197
        """
199
198
        self._trace("create lock directory")
205
204
 
206
205
    def _attempt_lock(self):
207
206
        """Make the pending directory and attempt to rename into place.
208
 
 
 
207
        
209
208
        If the rename succeeds, we read back the info file to check that we
210
209
        really got the lock.
211
210
 
242
241
        # incorrect.  It's possible some other servers or filesystems will
243
242
        # have a similar bug allowing someone to think they got the lock
244
243
        # when it's already held.
245
 
        #
246
 
        # See <https://bugs.edge.launchpad.net/bzr/+bug/498378> for one case.
247
 
        #
248
 
        # Strictly the check is unnecessary and a waste of time for most
249
 
        # people, but probably worth trapping if something is wrong.
250
244
        info = self.peek()
251
245
        self._trace("after locking, info=%r", info)
252
 
        if info is None:
253
 
            raise LockFailed(self, "lock was renamed into place, but "
254
 
                "now is missing!")
255
 
        if info.get('nonce') != self.nonce:
 
246
        if info['nonce'] != self.nonce:
256
247
            self._trace("rename succeeded, "
257
248
                "but lock is still held by someone else")
258
249
            raise LockContention(self)
264
255
    def _remove_pending_dir(self, tmpname):
265
256
        """Remove the pending directory
266
257
 
267
 
        This is called if we failed to rename into place, so that the pending
 
258
        This is called if we failed to rename into place, so that the pending 
268
259
        dirs don't clutter up the lockdir.
269
260
        """
270
261
        self._trace("remove %s", tmpname)
296
287
                                            info_bytes)
297
288
        return tmpname
298
289
 
299
 
    @only_raises(LockNotHeld, LockBroken)
300
290
    def unlock(self):
301
291
        """Release a held lock
302
292
        """
304
294
            self._fake_read_lock = False
305
295
            return
306
296
        if not self._lock_held:
307
 
            return lock.cant_unlock_not_held(self)
 
297
            raise LockNotHeld(self)
308
298
        if self._locked_via_token:
309
299
            self._locked_via_token = False
310
300
            self._lock_held = False
336
326
            self._trace("... unlock succeeded after %dms",
337
327
                    (time.time() - start_time) * 1000)
338
328
            result = lock.LockResult(self.transport.abspath(self.path),
339
 
                                     old_nonce)
 
329
                old_nonce)
340
330
            for hook in self.hooks['lock_released']:
341
331
                hook(result)
342
332
 
353
343
            lock_info = '\n'.join(self._format_lock_info(holder_info))
354
344
            if bzrlib.ui.ui_factory.get_boolean("Break %s" % lock_info):
355
345
                self.force_break(holder_info)
356
 
 
 
346
        
357
347
    def force_break(self, dead_holder_info):
358
348
        """Release a lock held by another process.
359
349
 
367
357
        LockBreakMismatch is raised.
368
358
 
369
359
        After the lock is broken it will not be held by any process.
370
 
        It is possible that another process may sneak in and take the
 
360
        It is possible that another process may sneak in and take the 
371
361
        lock before the breaking process acquires it.
372
362
        """
373
363
        if not isinstance(dead_holder_info, dict):
382
372
        tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
383
373
        self.transport.rename(self._held_dir, tmpname)
384
374
        # check that we actually broke the right lock, not someone else;
385
 
        # there's a small race window between checking it and doing the
 
375
        # there's a small race window between checking it and doing the 
386
376
        # rename.
387
377
        broken_info_path = tmpname + self.__INFO_NAME
388
378
        broken_info = self._read_info_file(broken_info_path)
390
380
            raise LockBreakMismatch(self, broken_info, dead_holder_info)
391
381
        self.transport.delete(broken_info_path)
392
382
        self.transport.rmdir(tmpname)
393
 
        result = lock.LockResult(self.transport.abspath(self.path),
394
 
                                 current_info.get('nonce'))
395
 
        for hook in self.hooks['lock_broken']:
396
 
            hook(result)
397
383
 
398
384
    def _check_not_locked(self):
399
385
        """If the lock is held by this instance, raise an error."""
407
393
        or if the lock has been affected by a bug.
408
394
 
409
395
        If the lock is not thought to be held, raises LockNotHeld.  If
410
 
        the lock is thought to be held but has been broken, raises
 
396
        the lock is thought to be held but has been broken, raises 
411
397
        LockBroken.
412
398
        """
413
399
        if not self._lock_held:
419
405
        if info.get('nonce') != self.nonce:
420
406
            # there is a lock, but not ours
421
407
            raise LockBroken(self)
422
 
 
 
408
        
423
409
    def _read_info_file(self, path):
424
410
        """Read one given info file.
425
411
 
426
412
        peek() reads the info file of the lock holder, if any.
427
413
        """
428
 
        return self._parse_info(self.transport.get_bytes(path))
 
414
        return self._parse_info(self.transport.get(path))
429
415
 
430
416
    def peek(self):
431
417
        """Check if the lock is held by anyone.
432
 
 
433
 
        If it is held, this returns the lock info structure as a dict
 
418
        
 
419
        If it is held, this returns the lock info structure as a rio Stanza,
434
420
        which contains some information about the current lock holder.
435
421
        Otherwise returns None.
436
422
        """
458
444
                   )
459
445
        return s.to_string()
460
446
 
461
 
    def _parse_info(self, info_bytes):
462
 
        stanza = rio.read_stanza(osutils.split_lines(info_bytes))
463
 
        if stanza is None:
464
 
            # see bug 185013; we fairly often end up with the info file being
465
 
            # empty after an interruption; we could log a message here but
466
 
            # there may not be much we can say
467
 
            return {}
468
 
        else:
469
 
            return stanza.as_dict()
 
447
    def _parse_info(self, info_file):
 
448
        return rio.read_stanza(info_file.readlines()).as_dict()
470
449
 
471
450
    def attempt_lock(self):
472
451
        """Take the lock; fail if it's already held.
473
 
 
 
452
        
474
453
        If you wish to block until the lock can be obtained, call wait_lock()
475
454
        instead.
476
455
 
497
476
 
498
477
        :param timeout: Approximate maximum amount of time to wait for the
499
478
        lock, in seconds.
500
 
 
 
479
         
501
480
        :param poll: Delay in seconds between retrying the lock.
502
481
 
503
482
        :param max_attempts: Maximum number of times to try to lock.
540
519
                    deadline_str = time.strftime('%H:%M:%S',
541
520
                                                 time.localtime(deadline))
542
521
                lock_url = self.transport.abspath(self.path)
543
 
                # See <https://bugs.edge.launchpad.net/bzr/+bug/250451>
544
 
                # the URL here is sometimes not one that is useful to the
545
 
                # user, perhaps being wrapped in a lp-%d or chroot decorator,
546
 
                # especially if this error is issued from the server.
547
522
                self._report_function('%s %s\n'
548
 
                    '%s\n' # held by
549
 
                    '%s\n' # locked ... ago
550
 
                    'Will continue to try until %s, unless '
551
 
                    'you press Ctrl-C.\n'
552
 
                    'See "bzr help break-lock" for more.',
553
 
                    start,
554
 
                    formatted_info[0],
555
 
                    formatted_info[1],
556
 
                    formatted_info[2],
557
 
                    deadline_str,
558
 
                    )
 
523
                                      '%s\n' # held by
 
524
                                      '%s\n' # locked ... ago
 
525
                                      'Will continue to try until %s, unless '
 
526
                                      'you press Ctrl-C\n'
 
527
                                      'If you\'re sure that it\'s not being '
 
528
                                      'modified, use bzr break-lock %s',
 
529
                                      start,
 
530
                                      formatted_info[0],
 
531
                                      formatted_info[1],
 
532
                                      formatted_info[2],
 
533
                                      deadline_str,
 
534
                                      lock_url)
559
535
 
560
536
            if (max_attempts is not None) and (attempt_count >= max_attempts):
561
537
                self._trace("exceeded %d attempts")
566
542
            else:
567
543
                self._trace("timeout after waiting %ss", timeout)
568
544
                raise LockContention(self)
569
 
 
 
545
    
570
546
    def leave_in_place(self):
571
547
        self._locked_via_token = True
572
548
 
575
551
 
576
552
    def lock_write(self, token=None):
577
553
        """Wait for and acquire the lock.
578
 
 
 
554
        
579
555
        :param token: if this is already locked, then lock_write will fail
580
556
            unless the token matches the existing lock.
581
557
        :returns: a token if this instance supports tokens, otherwise None.
587
563
        A token should be passed in if you know that you have locked the object
588
564
        some other way, and need to synchronise this object's state with that
589
565
        fact.
590
 
 
 
566
         
591
567
        XXX: docstring duplicated from LockableFiles.lock_write.
592
568
        """
593
569
        if token is not None:
602
578
    def lock_read(self):
603
579
        """Compatibility-mode shared lock.
604
580
 
605
 
        LockDir doesn't support shared read-only locks, so this
 
581
        LockDir doesn't support shared read-only locks, so this 
606
582
        just pretends that the lock is taken but really does nothing.
607
583
        """
608
 
        # At the moment Branches are commonly locked for read, but
 
584
        # At the moment Branches are commonly locked for read, but 
609
585
        # we can't rely on that remotely.  Once this is cleaned up,
610
 
        # reenable this warning to prevent it coming back in
 
586
        # reenable this warning to prevent it coming back in 
611
587
        # -- mbp 20060303
612
588
        ## warn("LockDir.lock_read falls back to write lock")
613
589
        if self._lock_held or self._fake_read_lock:
617
593
    def _format_lock_info(self, info):
618
594
        """Turn the contents of peek() into something for the user"""
619
595
        lock_url = self.transport.abspath(self.path)
620
 
        start_time = info.get('start_time')
621
 
        if start_time is None:
622
 
            time_ago = '(unknown)'
623
 
        else:
624
 
            time_ago = format_delta(time.time() - int(info['start_time']))
 
596
        delta = time.time() - int(info['start_time'])
625
597
        return [
626
598
            'lock %s' % (lock_url,),
627
 
            'held by %s on host %s [process #%s]' %
628
 
                tuple([info.get(x, '<unknown>') for x in ['user', 'hostname', 'pid']]),
629
 
            'locked %s' % (time_ago,),
 
599
            'held by %(user)s on host %(hostname)s [process #%(pid)s]' % info,
 
600
            'locked %s' % (format_delta(delta),),
630
601
            ]
631
602
 
632
603
    def validate_token(self, token):