← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lock.py

add a clean target

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lock.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005 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 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
41
from bzrlib.trace import mutter, note, warning
42
42
from bzrlib.errors import LockError
43
43
 
44
44
class _base_Lock(object):
45
45
    def _open(self, filename, filemode):
 
46
        import errno
46
47
        try:
47
48
            self.f = open(filename, filemode)
48
49
            return self.f
51
52
                raise
52
53
 
53
54
            # maybe this is an old branch (before may 2005)
54
 
            mutter("trying to create missing branch lock %r", filename)
 
55
            mutter("trying to create missing branch lock %r" % filename)
55
56
            
56
 
            self.f = open(filename, 'wb+')
 
57
            self.f = open(filename, 'wb')
57
58
            return self.f
58
59
 
 
60
 
59
61
    def __del__(self):
60
62
        if self.f:
61
63
            from warnings import warn
62
64
            warn("lock on %r not released" % self.f)
63
65
            self.unlock()
64
66
            
 
67
 
65
68
    def unlock(self):
66
69
        raise NotImplementedError()
67
70
 
81
84
        f = None
82
85
 
83
86
        def unlock(self):
84
 
            fcntl.lockf(self.f, fcntl.LOCK_UN)
 
87
            fcntl.flock(self.f, fcntl.LOCK_UN)
85
88
            self.f.close()
86
89
            del self.f 
87
90
 
 
91
 
88
92
    class _fcntl_WriteLock(_fcntl_FileLock):
89
93
        def __init__(self, filename):
90
 
            # standard IO errors get exposed directly.
91
 
            self._open(filename, 'wb')
92
94
            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
 
95
                fcntl.flock(self._open(filename, 'wb'), fcntl.LOCK_EX)
 
96
            except Exception, e:
97
97
                raise LockError(e)
98
98
 
 
99
 
99
100
    class _fcntl_ReadLock(_fcntl_FileLock):
100
 
 
101
101
        def __init__(self, filename):
102
 
            # standard IO errors get exposed directly.
103
 
            self._open(filename, 'rb')
104
102
            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
 
103
                fcntl.flock(self._open(filename, 'rb'), fcntl.LOCK_SH)
 
104
            except Exception, e:
109
105
                raise LockError(e)
110
106
 
111
107
    WriteLock = _fcntl_WriteLock
112
108
    ReadLock = _fcntl_ReadLock
113
109
 
114
 
 
115
110
except ImportError:
116
111
    try:
117
112
        import win32con, win32file, pywintypes
118
113
 
119
114
 
120
 
        LOCK_SH = 0 # the default
121
 
        LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
122
 
        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
123
118
 
124
119
        class _w32c_FileLock(_base_Lock):
125
120
            def _lock(self, filename, openmode, lockmode):
144
139
 
145
140
        class _w32c_ReadLock(_w32c_FileLock):
146
141
            def __init__(self, filename):
147
 
                _w32c_FileLock._lock(self, filename, 'rb',
148
 
                                     LOCK_NB)
 
142
                _w32c_FileLock._lock(self, filename, 'rb', 0)
149
143
 
150
144
        class _w32c_WriteLock(_w32c_FileLock):
151
145
            def __init__(self, filename):
152
146
                _w32c_FileLock._lock(self, filename, 'wb',
153
 
                                     LOCK_EX + LOCK_NB)
 
147
                                     win32con.LOCKFILE_EXCLUSIVE_LOCK)
154
148
 
155
149
 
156
150
 
174
168
                LOCK_NB = 4
175
169
                def unlock(self):
176
170
                    _msvc_unlock(self.f)
177
 
                    self.f.close()
178
 
                    self.f = None
179
171
 
180
172
 
181
173
            class _msvc_ReadLock(_msvc_FileLock):
250
242
        except ImportError:
251
243
            raise NotImplementedError("please write a locking method "
252
244
                                      "for platform %r" % sys.platform)
 
245
 
 
246
 
 
247
 
 
248
 
 
249
 
 
250
 
 
251