← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lock.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-03-12 16:31:21 UTC
  • mfrom: (2329.1.2 knit_corrupt)
  • Revision ID: pqm@pqm.ubuntu.com-20070312163121-a8078e3704c91ffe
(John Arbash Meinel) raise more helpful errors when detecting Knit corruption.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lock.py
1
 
# Copyright (C) 2005 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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
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
 
 
41
 
from bzrlib.trace import mutter, note, warning
42
 
from bzrlib.errors import LockError
 
40
 
 
41
from bzrlib.errors import LockError, LockContention
 
42
from bzrlib.osutils import realpath
 
43
from bzrlib.trace import mutter
 
44
 
43
45
 
44
46
class _base_Lock(object):
 
47
 
45
48
    def _open(self, filename, filemode):
46
 
        import errno
47
49
        try:
48
50
            self.f = open(filename, filemode)
49
51
            return self.f
52
54
                raise
53
55
 
54
56
            # maybe this is an old branch (before may 2005)
55
 
            mutter("trying to create missing branch lock %r" % filename)
 
57
            mutter("trying to create missing branch lock %r", filename)
56
58
            
57
 
            self.f = open(filename, 'wb')
 
59
            self.f = open(filename, 'wb+')
58
60
            return self.f
59
61
 
60
 
 
61
62
    def __del__(self):
62
63
        if self.f:
63
64
            from warnings import warn
64
65
            warn("lock on %r not released" % self.f)
65
66
            self.unlock()
66
67
            
67
 
 
68
68
    def unlock(self):
69
69
        raise NotImplementedError()
70
70
 
71
 
        
72
 
 
73
 
 
74
 
 
75
71
 
76
72
############################################################
77
73
# msvcrt locks
81
77
    import fcntl
82
78
 
83
79
    class _fcntl_FileLock(_base_Lock):
 
80
 
84
81
        f = None
85
82
 
86
 
        def unlock(self):
87
 
            fcntl.flock(self.f, fcntl.LOCK_UN)
 
83
        def _unlock(self):
 
84
            fcntl.lockf(self.f, fcntl.LOCK_UN)
 
85
            self._clear_f()
 
86
 
 
87
        def _clear_f(self):
 
88
            """Clear the self.f attribute cleanly."""
88
89
            self.f.close()
89
 
            del self.f 
 
90
            del self.f
90
91
 
91
92
 
92
93
    class _fcntl_WriteLock(_fcntl_FileLock):
 
94
 
 
95
        open_locks = {}
 
96
 
93
97
        def __init__(self, filename):
 
98
            # standard IO errors get exposed directly.
 
99
            self._open(filename, 'rb+')
 
100
            self.filename = realpath(filename)
 
101
            if self.filename in self.open_locks:
 
102
                self._clear_f()
 
103
                raise LockContention("Lock already held.")
 
104
            # reserve a slot for this lock - even if the lockf call fails,
 
105
            # at thisi point unlock() will be called, because self.f is set.
 
106
            # TODO: make this fully threadsafe, if we decide we care.
 
107
            self.open_locks[self.filename] = self.filename
94
108
            try:
95
 
                fcntl.flock(self._open(filename, 'wb'), fcntl.LOCK_EX)
96
 
            except Exception, e:
 
109
                # LOCK_NB will cause IOError to be raised if we can't grab a
 
110
                # lock right away.
 
111
                fcntl.lockf(self.f, fcntl.LOCK_EX | fcntl.LOCK_NB)
 
112
            except IOError, e:
 
113
                if e.errno in (errno.EAGAIN, errno.EACCES):
 
114
                    # We couldn't grab the lock
 
115
                    self.unlock()
 
116
                # we should be more precise about whats a locking
 
117
                # error and whats a random-other error
97
118
                raise LockError(e)
98
119
 
 
120
        def unlock(self):
 
121
            del self.open_locks[self.filename]
 
122
            self._unlock()
 
123
 
99
124
 
100
125
    class _fcntl_ReadLock(_fcntl_FileLock):
 
126
 
101
127
        def __init__(self, filename):
 
128
            # standard IO errors get exposed directly.
 
129
            self._open(filename, 'rb')
102
130
            try:
103
 
                fcntl.flock(self._open(filename, 'rb'), fcntl.LOCK_SH)
104
 
            except Exception, e:
 
131
                # LOCK_NB will cause IOError to be raised if we can't grab a
 
132
                # lock right away.
 
133
                fcntl.lockf(self.f, fcntl.LOCK_SH | fcntl.LOCK_NB)
 
134
            except IOError, e:
 
135
                # we should be more precise about whats a locking
 
136
                # error and whats a random-other error
105
137
                raise LockError(e)
106
138
 
 
139
        def unlock(self):
 
140
            self._unlock()
 
141
 
 
142
 
107
143
    WriteLock = _fcntl_WriteLock
108
144
    ReadLock = _fcntl_ReadLock
109
145
 
 
146
 
110
147
except ImportError:
111
148
    try:
112
149
        import win32con, win32file, pywintypes
113
150
 
114
151
 
115
 
        #LOCK_SH = 0 # the default
116
 
        #LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
117
 
        #LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
 
152
        LOCK_SH = 0 # the default
 
153
        LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
 
154
        LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
118
155
 
119
156
        class _w32c_FileLock(_base_Lock):
120
157
            def _lock(self, filename, openmode, lockmode):
124
161
                    overlapped = pywintypes.OVERLAPPED()
125
162
                    win32file.LockFileEx(self.hfile, lockmode, 0, 0x7fff0000, overlapped)
126
163
                except Exception, e:
 
164
                    if self.f:
 
165
                        self.f.close()
 
166
                        self.f = None
127
167
                    raise LockError(e)
128
168
 
129
169
            def unlock(self):
136
176
                    raise LockError(e)
137
177
 
138
178
 
139
 
 
140
179
        class _w32c_ReadLock(_w32c_FileLock):
141
180
            def __init__(self, filename):
142
 
                _w32c_FileLock._lock(self, filename, 'rb', 0)
 
181
                _w32c_FileLock._lock(self, filename, 'rb',
 
182
                                     LOCK_NB)
143
183
 
144
184
        class _w32c_WriteLock(_w32c_FileLock):
145
185
            def __init__(self, filename):
146
 
                _w32c_FileLock._lock(self, filename, 'wb',
147
 
                                     win32con.LOCKFILE_EXCLUSIVE_LOCK)
148
 
 
 
186
                _w32c_FileLock._lock(self, filename, 'rb+',
 
187
                                     LOCK_EX + LOCK_NB)
149
188
 
150
189
 
151
190
        WriteLock = _w32c_WriteLock
166
205
                LOCK_SH = 1
167
206
                LOCK_EX = 2
168
207
                LOCK_NB = 4
 
208
 
169
209
                def unlock(self):
170
210
                    _msvc_unlock(self.f)
 
211
                    self.f.close()
 
212
                    self.f = None
171
213
 
172
214
 
173
215
            class _msvc_ReadLock(_msvc_FileLock):
174
216
                def __init__(self, filename):
175
 
                    _msvc_lock(self._open(filename, 'rb'), self.LOCK_SH)
 
217
                    _msvc_lock(self._open(filename, 'rb'),
 
218
                               self.LOCK_SH | self.LOCK_NB)
176
219
 
177
220
 
178
221
            class _msvc_WriteLock(_msvc_FileLock):
179
222
                def __init__(self, filename):
180
 
                    _msvc_lock(self._open(filename, 'wb'), self.LOCK_EX)
181
 
 
 
223
                    _msvc_lock(self._open(filename, 'rb+'),
 
224
                               self.LOCK_EX | self.LOCK_NB)
182
225
 
183
226
 
184
227
            def _msvc_lock(f, flags):
236
279
                    raise LockError(e)
237
280
 
238
281
 
239
 
 
240
282
            WriteLock = _msvc_WriteLock
241
283
            ReadLock = _msvc_ReadLock
242
284
        except ImportError:
243
285
            raise NotImplementedError("please write a locking method "
244
286
                                      "for platform %r" % sys.platform)
245
 
 
246
 
 
247
 
 
248
 
 
249
 
 
250
 
 
251