← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lock.py

  • Committer: Jelmer Vernooij
  • Date: 2006-06-21 13:54:14 UTC
  • mto: (1558.14.8 Aaron's integration)
  • mto: This revision was merged to the branch mainline in revision 1803.
  • Revision ID: jelmer@samba.org-20060621135414-11a3a70e53adbb99
Install benchmarks.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lock.py
1
 
# Copyright (C) 2005 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
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
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
 
 
38
 
import sys, os
39
 
 
40
 
from trace import mutter, note, warning
41
 
from errors import LockError
 
37
import errno
 
38
import os
 
39
import sys
 
40
 
 
41
from bzrlib.trace import mutter
 
42
from bzrlib.errors import LockError
42
43
 
43
44
class _base_Lock(object):
44
45
    def _open(self, filename, filemode):
45
 
        self.f = open(filename, filemode)
46
 
        return self.f
47
 
    
 
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
48
58
 
49
59
    def __del__(self):
50
60
        if self.f:
51
61
            from warnings import warn
52
62
            warn("lock on %r not released" % self.f)
53
63
            self.unlock()
54
 
 
 
64
            
55
65
    def unlock(self):
56
66
        raise NotImplementedError()
57
67
 
71
81
        f = None
72
82
 
73
83
        def unlock(self):
74
 
            fcntl.flock(self.f, fcntl.LOCK_UN)
 
84
            fcntl.lockf(self.f, fcntl.LOCK_UN)
75
85
            self.f.close()
76
86
            del self.f 
77
87
 
78
 
 
79
88
    class _fcntl_WriteLock(_fcntl_FileLock):
80
89
        def __init__(self, filename):
 
90
            # standard IO errors get exposed directly.
 
91
            self._open(filename, 'wb')
81
92
            try:
82
 
                fcntl.flock(self._open(filename, 'wb'), fcntl.LOCK_EX)
83
 
            except Exception, e:
 
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
84
97
                raise LockError(e)
85
98
 
86
 
 
87
99
    class _fcntl_ReadLock(_fcntl_FileLock):
 
100
 
88
101
        def __init__(self, filename):
 
102
            # standard IO errors get exposed directly.
 
103
            self._open(filename, 'rb')
89
104
            try:
90
 
                fcntl.flock(self._open(filename, 'rb'), fcntl.LOCK_SH)
91
 
            except Exception, e:
 
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
92
109
                raise LockError(e)
93
110
 
94
111
    WriteLock = _fcntl_WriteLock
95
112
    ReadLock = _fcntl_ReadLock
96
113
 
 
114
 
97
115
except ImportError:
98
116
    try:
99
117
        import win32con, win32file, pywintypes
100
118
 
101
119
 
102
 
        #LOCK_SH = 0 # the default
103
 
        #LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
104
 
        #LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
 
120
        LOCK_SH = 0 # the default
 
121
        LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
 
122
        LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
105
123
 
106
124
        class _w32c_FileLock(_base_Lock):
107
125
            def _lock(self, filename, openmode, lockmode):
126
144
 
127
145
        class _w32c_ReadLock(_w32c_FileLock):
128
146
            def __init__(self, filename):
129
 
                _w32c_FileLock._lock(self, filename, 'rb', 0)
 
147
                _w32c_FileLock._lock(self, filename, 'rb',
 
148
                                     LOCK_NB)
130
149
 
131
150
        class _w32c_WriteLock(_w32c_FileLock):
132
151
            def __init__(self, filename):
133
152
                _w32c_FileLock._lock(self, filename, 'wb',
134
 
                                     win32con.LOCKFILE_EXCLUSIVE_LOCK)
 
153
                                     LOCK_EX + LOCK_NB)
135
154
 
136
155
 
137
156
 
155
174
                LOCK_NB = 4
156
175
                def unlock(self):
157
176
                    _msvc_unlock(self.f)
 
177
                    self.f.close()
 
178
                    self.f = None
158
179
 
159
180
 
160
181
            class _msvc_ReadLock(_msvc_FileLock):
185
206
                        fpos = os.lseek(fn, 0,0)
186
207
                        os.lseek(fn, 0,0)
187
208
 
188
 
                    if flags & self.LOCK_SH:
189
 
                        if flags & self.LOCK_NB:
 
209
                    if flags & _msvc_FileLock.LOCK_SH:
 
210
                        if flags & _msvc_FileLock.LOCK_NB:
190
211
                            lock_mode = msvcrt.LK_NBLCK
191
212
                        else:
192
213
                            lock_mode = msvcrt.LK_LOCK
193
 
                    elif flags & self.LOCK_EX:
194
 
                        if flags & self.LOCK_NB:
 
214
                    elif flags & _msvc_FileLock.LOCK_EX:
 
215
                        if flags & _msvc_FileLock.LOCK_NB:
195
216
                            lock_mode = msvcrt.LK_NBRLCK
196
217
                        else:
197
218
                            lock_mode = msvcrt.LK_RLCK
229
250
        except ImportError:
230
251
            raise NotImplementedError("please write a locking method "
231
252
                                      "for platform %r" % sys.platform)
232
 
 
233
 
 
234
 
 
235
 
 
236
 
 
237
 
 
238