← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lock.py

merge with bzr.dev revno.1860

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lock.py
1
 
# Copyright (C) 2005 Canonical Ltd
 
1
# Copyright (C) 2005, 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
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
 
"""Locking wrappers.
 
18
"""Locking using OS file locks or file existence.
19
19
 
20
 
This only does local locking using OS locks for now.
 
20
Note: This method of locking is generally deprecated in favour of LockDir, but
 
21
is used to lock local WorkingTrees, and by some old formats.  It's accessed
 
22
through Transport.lock_read(), etc.
21
23
 
22
24
This module causes two methods, lock() and unlock() to be defined in
23
25
any way that works on the current platform.
24
26
 
25
27
It is not specified whether these locks are reentrant (i.e. can be
26
28
taken repeatedly by a single process) or whether they exclude
27
 
different threads in a single process.  
28
 
 
29
 
Eventually we may need to use some kind of lock representation that
30
 
will work on a dumb filesystem without actual locking primitives.
 
29
different threads in a single process.  That reentrancy is provided by 
 
30
LockableFiles.
31
31
 
32
32
This defines two classes: ReadLock and WriteLock, which can be
33
33
implemented in different ways on different platforms.  Both have an
34
34
unlock() method.
35
35
"""
36
36
 
37
 
 
 
37
import errno
 
38
import os
38
39
import sys
39
 
import os
40
40
 
41
 
from bzrlib.trace import mutter, note, warning
 
41
from bzrlib.trace import mutter
42
42
from bzrlib.errors import LockError
43
43
 
 
44
 
44
45
class _base_Lock(object):
45
46
    def _open(self, filename, filemode):
46
 
        import errno
47
47
        try:
48
48
            self.f = open(filename, filemode)
49
49
            return self.f
52
52
                raise
53
53
 
54
54
            # maybe this is an old branch (before may 2005)
55
 
            mutter("trying to create missing branch lock %r" % filename)
 
55
            mutter("trying to create missing branch lock %r", filename)
56
56
            
57
 
            self.f = open(filename, 'wb')
 
57
            self.f = open(filename, 'wb+')
58
58
            return self.f
59
59
 
60
 
 
61
60
    def __del__(self):
62
61
        if self.f:
63
62
            from warnings import warn
64
63
            warn("lock on %r not released" % self.f)
65
64
            self.unlock()
66
65
            
67
 
 
68
66
    def unlock(self):
69
67
        raise NotImplementedError()
70
68
 
71
 
        
72
 
 
73
 
 
74
 
 
75
69
 
76
70
############################################################
77
71
# msvcrt locks
88
82
            self.f.close()
89
83
            del self.f 
90
84
 
91
 
 
92
85
    class _fcntl_WriteLock(_fcntl_FileLock):
93
86
        def __init__(self, filename):
 
87
            # standard IO errors get exposed directly.
 
88
            self._open(filename, 'wb')
94
89
            try:
95
 
                fcntl.lockf(self._open(filename, 'wb'), fcntl.LOCK_EX)
96
 
            except Exception, e:
 
90
                fcntl.lockf(self.f, fcntl.LOCK_EX)
 
91
            except IOError, e:
 
92
                # we should be more precise about whats a locking
 
93
                # error and whats a random-other error
97
94
                raise LockError(e)
98
95
 
99
 
 
100
96
    class _fcntl_ReadLock(_fcntl_FileLock):
 
97
 
101
98
        def __init__(self, filename):
 
99
            # standard IO errors get exposed directly.
 
100
            self._open(filename, 'rb')
102
101
            try:
103
 
                fcntl.lockf(self._open(filename, 'rb'), fcntl.LOCK_SH)
104
 
            except Exception, e:
 
102
                fcntl.lockf(self.f, fcntl.LOCK_SH)
 
103
            except IOError, e:
 
104
                # we should be more precise about whats a locking
 
105
                # error and whats a random-other error
105
106
                raise LockError(e)
106
107
 
107
108
    WriteLock = _fcntl_WriteLock
108
109
    ReadLock = _fcntl_ReadLock
109
110
 
 
111
 
110
112
except ImportError:
111
113
    try:
112
114
        import win32con, win32file, pywintypes
113
115
 
114
116
 
115
 
        #LOCK_SH = 0 # the default
116
 
        #LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
117
 
        #LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
 
117
        LOCK_SH = 0 # the default
 
118
        LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
 
119
        LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
118
120
 
119
121
        class _w32c_FileLock(_base_Lock):
120
122
            def _lock(self, filename, openmode, lockmode):
124
126
                    overlapped = pywintypes.OVERLAPPED()
125
127
                    win32file.LockFileEx(self.hfile, lockmode, 0, 0x7fff0000, overlapped)
126
128
                except Exception, e:
 
129
                    if self.f:
 
130
                        self.f.close()
 
131
                        self.f = None
127
132
                    raise LockError(e)
128
133
 
129
134
            def unlock(self):
136
141
                    raise LockError(e)
137
142
 
138
143
 
139
 
 
140
144
        class _w32c_ReadLock(_w32c_FileLock):
141
145
            def __init__(self, filename):
142
 
                _w32c_FileLock._lock(self, filename, 'rb', 0)
 
146
                _w32c_FileLock._lock(self, filename, 'rb',
 
147
                                     LOCK_NB)
143
148
 
144
149
        class _w32c_WriteLock(_w32c_FileLock):
145
150
            def __init__(self, filename):
146
151
                _w32c_FileLock._lock(self, filename, 'wb',
147
 
                                     win32con.LOCKFILE_EXCLUSIVE_LOCK)
148
 
 
 
152
                                     LOCK_EX + LOCK_NB)
149
153
 
150
154
 
151
155
        WriteLock = _w32c_WriteLock
182
186
                    _msvc_lock(self._open(filename, 'wb'), self.LOCK_EX)
183
187
 
184
188
 
185
 
 
186
189
            def _msvc_lock(f, flags):
187
190
                try:
188
191
                    # Unfortunately, msvcrt.LK_RLCK is equivalent to msvcrt.LK_LOCK
238
241
                    raise LockError(e)
239
242
 
240
243
 
241
 
 
242
244
            WriteLock = _msvc_WriteLock
243
245
            ReadLock = _msvc_ReadLock
244
246
        except ImportError:
245
247
            raise NotImplementedError("please write a locking method "
246
248
                                      "for platform %r" % sys.platform)
247
 
 
248
 
 
249
 
 
250
 
 
251
 
 
252
 
 
253