~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lock.py

  • Committer: Martin Pool
  • Date: 2005-07-04 07:33:32 UTC
  • Revision ID: mbp@sourcefrog.net-20050704073332-48c024b7b80671b6
- New validate_revision_id function

Show diffs side-by-side

added added

removed removed

Lines of Context:
28
28
 
29
29
Eventually we may need to use some kind of lock representation that
30
30
will work on a dumb filesystem without actual locking primitives.
 
31
 
 
32
This defines two classes: ReadLock and WriteLock, which can be
 
33
implemented in different ways on different platforms.  Both have an
 
34
unlock() method.
31
35
"""
32
36
 
33
37
 
34
 
import sys, os
35
 
 
36
 
import bzrlib
37
 
from trace import mutter, note, warning
38
 
from errors import LockError
 
38
import sys
 
39
import os
 
40
 
 
41
from bzrlib.trace import mutter, note, warning
 
42
from bzrlib.errors import LockError
 
43
 
 
44
class _base_Lock(object):
 
45
    def _open(self, filename, filemode):
 
46
        import errno
 
47
        try:
 
48
            self.f = open(filename, filemode)
 
49
            return self.f
 
50
        except IOError, e:
 
51
            if e.errno != errno.ENOENT:
 
52
                raise
 
53
 
 
54
            # maybe this is an old branch (before may 2005)
 
55
            mutter("trying to create missing branch lock %r" % filename)
 
56
            
 
57
            self.f = open(filename, 'wb')
 
58
            return self.f
 
59
 
 
60
 
 
61
    def __del__(self):
 
62
        if self.f:
 
63
            from warnings import warn
 
64
            warn("lock on %r not released" % self.f)
 
65
            self.unlock()
 
66
            
 
67
 
 
68
    def unlock(self):
 
69
        raise NotImplementedError()
 
70
 
 
71
        
 
72
 
 
73
 
 
74
 
 
75
 
 
76
############################################################
 
77
# msvcrt locks
 
78
 
39
79
 
40
80
try:
41
81
    import fcntl
42
 
    LOCK_SH = fcntl.LOCK_SH
43
 
    LOCK_EX = fcntl.LOCK_EX
44
 
    LOCK_NB = fcntl.LOCK_NB
45
 
    def lock(f, flags):
46
 
        try:
47
 
            fcntl.flock(f, flags)
48
 
        except Exception, e:
49
 
            raise LockError(e)
50
 
 
51
 
    def unlock(f):
52
 
        try:
53
 
            fcntl.flock(f, fcntl.LOCK_UN)
54
 
        except Exception, e:
55
 
            raise LockError(e)
 
82
 
 
83
    class _fcntl_FileLock(_base_Lock):
 
84
        f = None
 
85
 
 
86
        def unlock(self):
 
87
            fcntl.flock(self.f, fcntl.LOCK_UN)
 
88
            self.f.close()
 
89
            del self.f 
 
90
 
 
91
 
 
92
    class _fcntl_WriteLock(_fcntl_FileLock):
 
93
        def __init__(self, filename):
 
94
            try:
 
95
                fcntl.flock(self._open(filename, 'wb'), fcntl.LOCK_EX)
 
96
            except Exception, e:
 
97
                raise LockError(e)
 
98
 
 
99
 
 
100
    class _fcntl_ReadLock(_fcntl_FileLock):
 
101
        def __init__(self, filename):
 
102
            try:
 
103
                fcntl.flock(self._open(filename, 'rb'), fcntl.LOCK_SH)
 
104
            except Exception, e:
 
105
                raise LockError(e)
 
106
 
 
107
    WriteLock = _fcntl_WriteLock
 
108
    ReadLock = _fcntl_ReadLock
56
109
 
57
110
except ImportError:
58
111
    try:
59
112
        import win32con, win32file, pywintypes
60
 
        LOCK_SH = 0 # the default
61
 
        LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
62
 
        LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
63
 
 
64
 
        def lock(f, flags):
65
 
            try:
66
 
                if type(f) == file:
67
 
                    hfile = win32file._get_osfhandle(f.fileno())
68
 
                else:
69
 
                    hfile = win32file._get_osfhandle(f)
70
 
                overlapped = pywintypes.OVERLAPPED()
71
 
                win32file.LockFileEx(hfile, flags, 0, 0x7fff0000, overlapped)
72
 
            except Exception, e:
73
 
                raise LockError(e)
74
 
 
75
 
        def unlock(f):
76
 
            try:
77
 
                if type(f) == file:
78
 
                    hfile = win32file._get_osfhandle(f.fileno())
79
 
                else:
80
 
                    hfile = win32file._get_osfhandle(f)
81
 
                overlapped = pywintypes.OVERLAPPED()
82
 
                win32file.UnlockFileEx(hfile, 0, 0x7fff0000, overlapped)
83
 
            except Exception, e:
84
 
                raise LockError(e)
 
113
 
 
114
 
 
115
        #LOCK_SH = 0 # the default
 
116
        #LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
 
117
        #LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
 
118
 
 
119
        class _w32c_FileLock(_base_Lock):
 
120
            def _lock(self, filename, openmode, lockmode):
 
121
                try:
 
122
                    self._open(filename, openmode)
 
123
                    self.hfile = win32file._get_osfhandle(self.f.fileno())
 
124
                    overlapped = pywintypes.OVERLAPPED()
 
125
                    win32file.LockFileEx(self.hfile, lockmode, 0, 0x7fff0000, overlapped)
 
126
                except Exception, e:
 
127
                    raise LockError(e)
 
128
 
 
129
            def unlock(self):
 
130
                try:
 
131
                    overlapped = pywintypes.OVERLAPPED()
 
132
                    win32file.UnlockFileEx(self.hfile, 0, 0x7fff0000, overlapped)
 
133
                    self.f.close()
 
134
                    self.f = None
 
135
                except Exception, e:
 
136
                    raise LockError(e)
 
137
 
 
138
 
 
139
 
 
140
        class _w32c_ReadLock(_w32c_FileLock):
 
141
            def __init__(self, filename):
 
142
                _w32c_FileLock._lock(self, filename, 'rb', 0)
 
143
 
 
144
        class _w32c_WriteLock(_w32c_FileLock):
 
145
            def __init__(self, filename):
 
146
                _w32c_FileLock._lock(self, filename, 'wb',
 
147
                                     win32con.LOCKFILE_EXCLUSIVE_LOCK)
 
148
 
 
149
 
 
150
 
 
151
        WriteLock = _w32c_WriteLock
 
152
        ReadLock = _w32c_ReadLock
 
153
 
85
154
    except ImportError:
86
155
        try:
87
156
            import msvcrt
 
157
 
 
158
 
88
159
            # Unfortunately, msvcrt.locking() doesn't distinguish between
89
160
            # read locks and write locks. Also, the way the combinations
90
161
            # work to get non-blocking is not the same, so we
91
162
            # have to write extra special functions here.
92
163
 
93
 
            LOCK_SH = 1
94
 
            LOCK_EX = 2
95
 
            LOCK_NB = 4
96
 
 
97
 
            def lock(f, flags):
 
164
 
 
165
            class _msvc_FileLock(_base_Lock):
 
166
                LOCK_SH = 1
 
167
                LOCK_EX = 2
 
168
                LOCK_NB = 4
 
169
                def unlock(self):
 
170
                    _msvc_unlock(self.f)
 
171
 
 
172
 
 
173
            class _msvc_ReadLock(_msvc_FileLock):
 
174
                def __init__(self, filename):
 
175
                    _msvc_lock(self._open(filename, 'rb'), self.LOCK_SH)
 
176
 
 
177
 
 
178
            class _msvc_WriteLock(_msvc_FileLock):
 
179
                def __init__(self, filename):
 
180
                    _msvc_lock(self._open(filename, 'wb'), self.LOCK_EX)
 
181
 
 
182
 
 
183
 
 
184
            def _msvc_lock(f, flags):
98
185
                try:
99
186
                    # Unfortunately, msvcrt.LK_RLCK is equivalent to msvcrt.LK_LOCK
100
187
                    # according to the comments, LK_RLCK is open the lock for writing.
110
197
                        fn = f
111
198
                        fpos = os.lseek(fn, 0,0)
112
199
                        os.lseek(fn, 0,0)
113
 
                    
114
 
                    if flags & LOCK_SH:
115
 
                        if flags & LOCK_NB:
 
200
 
 
201
                    if flags & self.LOCK_SH:
 
202
                        if flags & self.LOCK_NB:
116
203
                            lock_mode = msvcrt.LK_NBLCK
117
204
                        else:
118
205
                            lock_mode = msvcrt.LK_LOCK
119
 
                    elif flags & LOCK_EX:
120
 
                        if flags & LOCK_NB:
 
206
                    elif flags & self.LOCK_EX:
 
207
                        if flags & self.LOCK_NB:
121
208
                            lock_mode = msvcrt.LK_NBRLCK
122
209
                        else:
123
210
                            lock_mode = msvcrt.LK_RLCK
130
217
                except Exception, e:
131
218
                    raise LockError(e)
132
219
 
133
 
            def unlock(f):
 
220
            def _msvc_unlock(f):
134
221
                try:
135
222
                    if type(f) == file:
136
223
                        fpos = f.tell()
147
234
                        os.lseek(fn, fpos, 0)
148
235
                except Exception, e:
149
236
                    raise LockError(e)
 
237
 
 
238
 
 
239
 
 
240
            WriteLock = _msvc_WriteLock
 
241
            ReadLock = _msvc_ReadLock
150
242
        except ImportError:
151
 
            from warnings import Warning
152
 
            
153
 
            warning("please write a locking method for platform %r" % sys.platform)
154
 
 
155
 
            # Creating no-op lock/unlock for now
156
 
            def lock(f, flags):
157
 
                pass
158
 
            def unlock(f):
159
 
                pass
 
243
            raise NotImplementedError("please write a locking method "
 
244
                                      "for platform %r" % sys.platform)
 
245
 
 
246
 
 
247
 
 
248
 
 
249
 
 
250
 
160
251