← 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: 2006-09-19 04:17:47 UTC
  • mfrom: (2018.1.12 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060919041747-9f0e1130a3a78022
Trivially cleanup BRANCH.TODO

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
40
 
41
 
from bzrlib.trace import mutter, note, warning
42
41
from bzrlib.errors import LockError
 
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
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, 'wb')
94
100
            try:
95
 
                fcntl.flock(self._open(filename, 'wb'), fcntl.LOCK_EX)
96
 
            except Exception, e:
 
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
97
113
                raise LockError(e)
98
114
 
 
115
        def unlock(self):
 
116
            del self.open_locks[self.filename]
 
117
            self._unlock()
 
118
 
99
119
 
100
120
    class _fcntl_ReadLock(_fcntl_FileLock):
 
121
 
101
122
        def __init__(self, filename):
 
123
            # standard IO errors get exposed directly.
 
124
            self._open(filename, 'rb')
102
125
            try:
103
 
                fcntl.flock(self._open(filename, 'rb'), fcntl.LOCK_SH)
104
 
            except Exception, e:
 
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
105
130
                raise LockError(e)
106
131
 
 
132
        def unlock(self):
 
133
            self._unlock()
 
134
 
 
135
 
107
136
    WriteLock = _fcntl_WriteLock
108
137
    ReadLock = _fcntl_ReadLock
109
138
 
 
139
 
110
140
except ImportError:
111
141
    try:
112
142
        import win32con, win32file, pywintypes
113
143
 
114
144
 
115
 
        #LOCK_SH = 0 # the default
116
 
        #LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
117
 
        #LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
 
145
        LOCK_SH = 0 # the default
 
146
        LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
 
147
        LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
118
148
 
119
149
        class _w32c_FileLock(_base_Lock):
120
150
            def _lock(self, filename, openmode, lockmode):
124
154
                    overlapped = pywintypes.OVERLAPPED()
125
155
                    win32file.LockFileEx(self.hfile, lockmode, 0, 0x7fff0000, overlapped)
126
156
                except Exception, e:
 
157
                    if self.f:
 
158
                        self.f.close()
 
159
                        self.f = None
127
160
                    raise LockError(e)
128
161
 
129
162
            def unlock(self):
136
169
                    raise LockError(e)
137
170
 
138
171
 
139
 
 
140
172
        class _w32c_ReadLock(_w32c_FileLock):
141
173
            def __init__(self, filename):
142
 
                _w32c_FileLock._lock(self, filename, 'rb', 0)
 
174
                _w32c_FileLock._lock(self, filename, 'rb',
 
175
                                     LOCK_NB)
143
176
 
144
177
        class _w32c_WriteLock(_w32c_FileLock):
145
178
            def __init__(self, filename):
146
179
                _w32c_FileLock._lock(self, filename, 'wb',
147
 
                                     win32con.LOCKFILE_EXCLUSIVE_LOCK)
148
 
 
 
180
                                     LOCK_EX + LOCK_NB)
149
181
 
150
182
 
151
183
        WriteLock = _w32c_WriteLock
168
200
                LOCK_NB = 4
169
201
                def unlock(self):
170
202
                    _msvc_unlock(self.f)
 
203
                    self.f.close()
 
204
                    self.f = None
171
205
 
172
206
 
173
207
            class _msvc_ReadLock(_msvc_FileLock):
180
214
                    _msvc_lock(self._open(filename, 'wb'), self.LOCK_EX)
181
215
 
182
216
 
183
 
 
184
217
            def _msvc_lock(f, flags):
185
218
                try:
186
219
                    # Unfortunately, msvcrt.LK_RLCK is equivalent to msvcrt.LK_LOCK
236
269
                    raise LockError(e)
237
270
 
238
271
 
239
 
 
240
272
            WriteLock = _msvc_WriteLock
241
273
            ReadLock = _msvc_ReadLock
242
274
        except ImportError:
243
275
            raise NotImplementedError("please write a locking method "
244
276
                                      "for platform %r" % sys.platform)
245
 
 
246
 
 
247
 
 
248
 
 
249
 
 
250
 
 
251