← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lock.py

  • Committer: Martin Pool
  • Date: 2005-07-22 23:32:00 UTC
  • Revision ID: mbp@sourcefrog.net-20050722233200-ccdeca985093a9fb
- now needs python 2.4
- update instructions for running selftest

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lock.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005 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 using OS file locks or file existence.
 
18
"""Locking wrappers.
19
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.
 
20
This only does local locking using OS locks for now.
23
21
 
24
22
This module causes two methods, lock() and unlock() to be defined in
25
23
any way that works on the current platform.
26
24
 
27
25
It is not specified whether these locks are reentrant (i.e. can be
28
26
taken repeatedly by a single process) or whether they exclude
29
 
different threads in a single process.  That reentrancy is provided by 
30
 
LockableFiles.
 
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.
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
 
import errno
 
37
 
 
38
import sys
38
39
import os
39
 
import sys
40
40
 
 
41
from bzrlib.trace import mutter, note, warning
41
42
from bzrlib.errors import LockError
42
 
from bzrlib.osutils import realpath
43
 
from bzrlib.trace import mutter
44
 
 
45
43
 
46
44
class _base_Lock(object):
47
 
 
48
45
    def _open(self, filename, filemode):
 
46
        import errno
49
47
        try:
50
48
            self.f = open(filename, filemode)
51
49
            return self.f
54
52
                raise
55
53
 
56
54
            # maybe this is an old branch (before may 2005)
57
 
            mutter("trying to create missing branch lock %r", filename)
 
55
            mutter("trying to create missing branch lock %r" % filename)
58
56
            
59
 
            self.f = open(filename, 'wb+')
 
57
            self.f = open(filename, 'wb')
60
58
            return self.f
61
59
 
 
60
 
62
61
    def __del__(self):
63
62
        if self.f:
64
63
            from warnings import warn
65
64
            warn("lock on %r not released" % self.f)
66
65
            self.unlock()
67
66
            
 
67
 
68
68
    def unlock(self):
69
69
        raise NotImplementedError()
70
70
 
 
71
        
 
72
 
 
73
 
 
74
 
71
75
 
72
76
############################################################
73
77
# msvcrt locks
77
81
    import fcntl
78
82
 
79
83
    class _fcntl_FileLock(_base_Lock):
80
 
 
81
84
        f = None
82
85
 
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."""
 
86
        def unlock(self):
 
87
            fcntl.flock(self.f, fcntl.LOCK_UN)
89
88
            self.f.close()
90
89
            del self.f 
91
90
 
92
91
 
93
92
    class _fcntl_WriteLock(_fcntl_FileLock):
94
 
 
95
 
        open_locks = {}
96
 
 
97
93
        def __init__(self, filename):
98
 
            # standard IO errors get exposed directly.
99
 
            self._open(filename, 'wb')
100
94
            try:
101
 
                self.filename = realpath(filename)
102
 
                if self.filename in self.open_locks:
103
 
                    self._clear_f() 
104
 
                    raise LockError("Lock already held.")
105
 
                # reserve a slot for this lock - even if the lockf call fails, 
106
 
                # at thisi point unlock() will be called, because self.f is set.
107
 
                # TODO: make this fully threadsafe, if we decide we care.
108
 
                self.open_locks[self.filename] = self.filename
109
 
                fcntl.lockf(self.f, fcntl.LOCK_EX)
110
 
            except IOError, e:
111
 
                # we should be more precise about whats a locking
112
 
                # error and whats a random-other error
 
95
                fcntl.flock(self._open(filename, 'wb'), fcntl.LOCK_EX)
 
96
            except Exception, e:
113
97
                raise LockError(e)
114
98
 
115
 
        def unlock(self):
116
 
            del self.open_locks[self.filename]
117
 
            self._unlock()
118
 
 
119
99
 
120
100
    class _fcntl_ReadLock(_fcntl_FileLock):
121
 
 
122
101
        def __init__(self, filename):
123
 
            # standard IO errors get exposed directly.
124
 
            self._open(filename, 'rb')
125
102
            try:
126
 
                fcntl.lockf(self.f, fcntl.LOCK_SH)
127
 
            except IOError, e:
128
 
                # we should be more precise about whats a locking
129
 
                # error and whats a random-other error
 
103
                fcntl.flock(self._open(filename, 'rb'), fcntl.LOCK_SH)
 
104
            except Exception, e:
130
105
                raise LockError(e)
131
106
 
132
 
        def unlock(self):
133
 
            self._unlock()
134
 
 
135
 
 
136
107
    WriteLock = _fcntl_WriteLock
137
108
    ReadLock = _fcntl_ReadLock
138
109
 
139
 
 
140
110
except ImportError:
141
111
    try:
142
112
        import win32con, win32file, pywintypes
143
113
 
144
114
 
145
 
        LOCK_SH = 0 # the default
146
 
        LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
147
 
        LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
 
115
        #LOCK_SH = 0 # the default
 
116
        #LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
 
117
        #LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
148
118
 
149
119
        class _w32c_FileLock(_base_Lock):
150
120
            def _lock(self, filename, openmode, lockmode):
154
124
                    overlapped = pywintypes.OVERLAPPED()
155
125
                    win32file.LockFileEx(self.hfile, lockmode, 0, 0x7fff0000, overlapped)
156
126
                except Exception, e:
157
 
                    if self.f:
158
 
                        self.f.close()
159
 
                        self.f = None
160
127
                    raise LockError(e)
161
128
 
162
129
            def unlock(self):
169
136
                    raise LockError(e)
170
137
 
171
138
 
 
139
 
172
140
        class _w32c_ReadLock(_w32c_FileLock):
173
141
            def __init__(self, filename):
174
 
                _w32c_FileLock._lock(self, filename, 'rb',
175
 
                                     LOCK_NB)
 
142
                _w32c_FileLock._lock(self, filename, 'rb', 0)
176
143
 
177
144
        class _w32c_WriteLock(_w32c_FileLock):
178
145
            def __init__(self, filename):
179
146
                _w32c_FileLock._lock(self, filename, 'wb',
180
 
                                     LOCK_EX + LOCK_NB)
 
147
                                     win32con.LOCKFILE_EXCLUSIVE_LOCK)
 
148
 
181
149
 
182
150
 
183
151
        WriteLock = _w32c_WriteLock
200
168
                LOCK_NB = 4
201
169
                def unlock(self):
202
170
                    _msvc_unlock(self.f)
203
 
                    self.f.close()
204
 
                    self.f = None
205
171
 
206
172
 
207
173
            class _msvc_ReadLock(_msvc_FileLock):
214
180
                    _msvc_lock(self._open(filename, 'wb'), self.LOCK_EX)
215
181
 
216
182
 
 
183
 
217
184
            def _msvc_lock(f, flags):
218
185
                try:
219
186
                    # Unfortunately, msvcrt.LK_RLCK is equivalent to msvcrt.LK_LOCK
269
236
                    raise LockError(e)
270
237
 
271
238
 
 
239
 
272
240
            WriteLock = _msvc_WriteLock
273
241
            ReadLock = _msvc_ReadLock
274
242
        except ImportError:
275
243
            raise NotImplementedError("please write a locking method "
276
244
                                      "for platform %r" % sys.platform)
 
245
 
 
246
 
 
247
 
 
248
 
 
249
 
 
250
 
 
251