← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lock.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-09 04:51:05 UTC
  • Revision ID: mbp@sourcefrog.net-20050309045105-d02cd410a115da2c
import all docs from arch

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lock.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
 
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
 
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
 
13
 
# You should have received a copy of the GNU General Public License
14
 
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
18
 
"""Locking using OS file locks or file existence.
19
 
 
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.
23
 
 
24
 
This module causes two methods, lock() and unlock() to be defined in
25
 
any way that works on the current platform.
26
 
 
27
 
It is not specified whether these locks are reentrant (i.e. can be
28
 
taken repeatedly by a single process) or whether they exclude
29
 
different threads in a single process.  That reentrancy is provided by 
30
 
LockableFiles.
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.
35
 
"""
36
 
 
37
 
import errno
38
 
import os
39
 
import sys
40
 
 
41
 
from bzrlib.trace import mutter
42
 
from bzrlib.errors import LockError
43
 
 
44
 
class _base_Lock(object):
45
 
    def _open(self, filename, filemode):
46
 
        try:
47
 
            self.f = open(filename, filemode)
48
 
            return self.f
49
 
        except IOError, e:
50
 
            if e.errno != errno.ENOENT:
51
 
                raise
52
 
 
53
 
            # maybe this is an old branch (before may 2005)
54
 
            mutter("trying to create missing branch lock %r", filename)
55
 
            
56
 
            self.f = open(filename, 'wb+')
57
 
            return self.f
58
 
 
59
 
    def __del__(self):
60
 
        if self.f:
61
 
            from warnings import warn
62
 
            warn("lock on %r not released" % self.f)
63
 
            self.unlock()
64
 
            
65
 
    def unlock(self):
66
 
        raise NotImplementedError()
67
 
 
68
 
        
69
 
 
70
 
 
71
 
 
72
 
 
73
 
############################################################
74
 
# msvcrt locks
75
 
 
76
 
 
77
 
try:
78
 
    import fcntl
79
 
 
80
 
    class _fcntl_FileLock(_base_Lock):
81
 
        f = None
82
 
 
83
 
        def unlock(self):
84
 
            fcntl.lockf(self.f, fcntl.LOCK_UN)
85
 
            self.f.close()
86
 
            del self.f 
87
 
 
88
 
    class _fcntl_WriteLock(_fcntl_FileLock):
89
 
        def __init__(self, filename):
90
 
            # standard IO errors get exposed directly.
91
 
            self._open(filename, 'wb')
92
 
            try:
93
 
                fcntl.lockf(self.f, fcntl.LOCK_EX)
94
 
            except IOError, e:
95
 
                # we should be more precise about whats a locking
96
 
                # error and whats a random-other error
97
 
                raise LockError(e)
98
 
 
99
 
    class _fcntl_ReadLock(_fcntl_FileLock):
100
 
 
101
 
        def __init__(self, filename):
102
 
            # standard IO errors get exposed directly.
103
 
            self._open(filename, 'rb')
104
 
            try:
105
 
                fcntl.lockf(self.f, fcntl.LOCK_SH)
106
 
            except IOError, e:
107
 
                # we should be more precise about whats a locking
108
 
                # error and whats a random-other error
109
 
                raise LockError(e)
110
 
 
111
 
    WriteLock = _fcntl_WriteLock
112
 
    ReadLock = _fcntl_ReadLock
113
 
 
114
 
 
115
 
except ImportError:
116
 
    try:
117
 
        import win32con, win32file, pywintypes
118
 
 
119
 
 
120
 
        LOCK_SH = 0 # the default
121
 
        LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
122
 
        LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
123
 
 
124
 
        class _w32c_FileLock(_base_Lock):
125
 
            def _lock(self, filename, openmode, lockmode):
126
 
                try:
127
 
                    self._open(filename, openmode)
128
 
                    self.hfile = win32file._get_osfhandle(self.f.fileno())
129
 
                    overlapped = pywintypes.OVERLAPPED()
130
 
                    win32file.LockFileEx(self.hfile, lockmode, 0, 0x7fff0000, overlapped)
131
 
                except Exception, e:
132
 
                    raise LockError(e)
133
 
 
134
 
            def unlock(self):
135
 
                try:
136
 
                    overlapped = pywintypes.OVERLAPPED()
137
 
                    win32file.UnlockFileEx(self.hfile, 0, 0x7fff0000, overlapped)
138
 
                    self.f.close()
139
 
                    self.f = None
140
 
                except Exception, e:
141
 
                    raise LockError(e)
142
 
 
143
 
 
144
 
 
145
 
        class _w32c_ReadLock(_w32c_FileLock):
146
 
            def __init__(self, filename):
147
 
                _w32c_FileLock._lock(self, filename, 'rb',
148
 
                                     LOCK_NB)
149
 
 
150
 
        class _w32c_WriteLock(_w32c_FileLock):
151
 
            def __init__(self, filename):
152
 
                _w32c_FileLock._lock(self, filename, 'wb',
153
 
                                     LOCK_EX + LOCK_NB)
154
 
 
155
 
 
156
 
 
157
 
        WriteLock = _w32c_WriteLock
158
 
        ReadLock = _w32c_ReadLock
159
 
 
160
 
    except ImportError:
161
 
        try:
162
 
            import msvcrt
163
 
 
164
 
 
165
 
            # Unfortunately, msvcrt.locking() doesn't distinguish between
166
 
            # read locks and write locks. Also, the way the combinations
167
 
            # work to get non-blocking is not the same, so we
168
 
            # have to write extra special functions here.
169
 
 
170
 
 
171
 
            class _msvc_FileLock(_base_Lock):
172
 
                LOCK_SH = 1
173
 
                LOCK_EX = 2
174
 
                LOCK_NB = 4
175
 
                def unlock(self):
176
 
                    _msvc_unlock(self.f)
177
 
                    self.f.close()
178
 
                    self.f = None
179
 
 
180
 
 
181
 
            class _msvc_ReadLock(_msvc_FileLock):
182
 
                def __init__(self, filename):
183
 
                    _msvc_lock(self._open(filename, 'rb'), self.LOCK_SH)
184
 
 
185
 
 
186
 
            class _msvc_WriteLock(_msvc_FileLock):
187
 
                def __init__(self, filename):
188
 
                    _msvc_lock(self._open(filename, 'wb'), self.LOCK_EX)
189
 
 
190
 
 
191
 
 
192
 
            def _msvc_lock(f, flags):
193
 
                try:
194
 
                    # Unfortunately, msvcrt.LK_RLCK is equivalent to msvcrt.LK_LOCK
195
 
                    # according to the comments, LK_RLCK is open the lock for writing.
196
 
 
197
 
                    # Unfortunately, msvcrt.locking() also has the side effect that it
198
 
                    # will only block for 10 seconds at most, and then it will throw an
199
 
                    # exception, this isn't terrible, though.
200
 
                    if type(f) == file:
201
 
                        fpos = f.tell()
202
 
                        fn = f.fileno()
203
 
                        f.seek(0)
204
 
                    else:
205
 
                        fn = f
206
 
                        fpos = os.lseek(fn, 0,0)
207
 
                        os.lseek(fn, 0,0)
208
 
 
209
 
                    if flags & _msvc_FileLock.LOCK_SH:
210
 
                        if flags & _msvc_FileLock.LOCK_NB:
211
 
                            lock_mode = msvcrt.LK_NBLCK
212
 
                        else:
213
 
                            lock_mode = msvcrt.LK_LOCK
214
 
                    elif flags & _msvc_FileLock.LOCK_EX:
215
 
                        if flags & _msvc_FileLock.LOCK_NB:
216
 
                            lock_mode = msvcrt.LK_NBRLCK
217
 
                        else:
218
 
                            lock_mode = msvcrt.LK_RLCK
219
 
                    else:
220
 
                        raise ValueError('Invalid lock mode: %r' % flags)
221
 
                    try:
222
 
                        msvcrt.locking(fn, lock_mode, -1)
223
 
                    finally:
224
 
                        os.lseek(fn, fpos, 0)
225
 
                except Exception, e:
226
 
                    raise LockError(e)
227
 
 
228
 
            def _msvc_unlock(f):
229
 
                try:
230
 
                    if type(f) == file:
231
 
                        fpos = f.tell()
232
 
                        fn = f.fileno()
233
 
                        f.seek(0)
234
 
                    else:
235
 
                        fn = f
236
 
                        fpos = os.lseek(fn, 0,0)
237
 
                        os.lseek(fn, 0,0)
238
 
 
239
 
                    try:
240
 
                        msvcrt.locking(fn, msvcrt.LK_UNLCK, -1)
241
 
                    finally:
242
 
                        os.lseek(fn, fpos, 0)
243
 
                except Exception, e:
244
 
                    raise LockError(e)
245
 
 
246
 
 
247
 
 
248
 
            WriteLock = _msvc_WriteLock
249
 
            ReadLock = _msvc_ReadLock
250
 
        except ImportError:
251
 
            raise NotImplementedError("please write a locking method "
252
 
                                      "for platform %r" % sys.platform)