~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: 2009-02-18 13:27:08 UTC
  • mfrom: (4011.4.3 ssh-hints)
  • Revision ID: pqm@pqm.ubuntu.com-20090218132708-okubrahz9exvae9r
(Jelmer) Point out bzr+ssh:// to the user when they use ssh://.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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
38
import sys
39
 
import os
40
 
 
41
 
from bzrlib.trace import mutter, note, warning
42
 
from bzrlib.errors import LockError
43
 
 
44
 
class _base_Lock(object):
 
39
 
 
40
from bzrlib import (
 
41
    errors,
 
42
    osutils,
 
43
    trace,
 
44
    )
 
45
from bzrlib.hooks import Hooks
 
46
 
 
47
 
 
48
class LockHooks(Hooks):
 
49
 
 
50
    def __init__(self):
 
51
        Hooks.__init__(self)
 
52
 
 
53
        # added in 1.8; called with a LockResult when a physical lock is
 
54
        # acquired
 
55
        self['lock_acquired'] = []
 
56
 
 
57
        # added in 1.8; called with a LockResult when a physical lock is
 
58
        # acquired
 
59
        self['lock_released'] = []
 
60
 
 
61
 
 
62
class Lock(object):
 
63
    """Base class for locks.
 
64
 
 
65
    :cvar hooks: Hook dictionary for operations on locks.
 
66
    """
 
67
 
 
68
    hooks = LockHooks()
 
69
 
 
70
 
 
71
class LockResult(object):
 
72
    """Result of an operation on a lock; passed to a hook"""
 
73
 
 
74
    def __init__(self, lock_url, details=None):
 
75
        """Create a lock result for lock with optional details about the lock."""
 
76
        self.lock_url = lock_url
 
77
        self.details = details
 
78
 
 
79
    def __eq__(self, other):
 
80
        return self.lock_url == other.lock_url and self.details == other.details
 
81
 
 
82
 
 
83
try:
 
84
    import fcntl
 
85
    have_fcntl = True
 
86
except ImportError:
 
87
    have_fcntl = False
 
88
 
 
89
have_pywin32 = False
 
90
have_ctypes_win32 = False
 
91
if sys.platform == 'win32':
 
92
    import msvcrt
 
93
    try:
 
94
        import win32con, win32file, pywintypes, winerror
 
95
        have_pywin32 = True
 
96
    except ImportError:
 
97
        pass
 
98
 
 
99
    try:
 
100
        import ctypes
 
101
        have_ctypes_win32 = True
 
102
    except ImportError:
 
103
        pass
 
104
 
 
105
 
 
106
class _OSLock(object):
 
107
 
 
108
    def __init__(self):
 
109
        self.f = None
 
110
        self.filename = None
 
111
 
45
112
    def _open(self, filename, filemode):
46
 
        import errno
 
113
        self.filename = osutils.realpath(filename)
47
114
        try:
48
 
            self.f = open(filename, filemode)
 
115
            self.f = open(self.filename, filemode)
49
116
            return self.f
50
117
        except IOError, e:
 
118
            if e.errno in (errno.EACCES, errno.EPERM):
 
119
                raise errors.LockFailed(self.filename, str(e))
51
120
            if e.errno != errno.ENOENT:
52
121
                raise
53
122
 
54
123
            # maybe this is an old branch (before may 2005)
55
 
            mutter("trying to create missing branch lock %r" % filename)
56
 
            
57
 
            self.f = open(filename, 'wb')
 
124
            trace.mutter("trying to create missing lock %r", self.filename)
 
125
 
 
126
            self.f = open(self.filename, 'wb+')
58
127
            return self.f
59
128
 
 
129
    def _clear_f(self):
 
130
        """Clear the self.f attribute cleanly."""
 
131
        if self.f:
 
132
            self.f.close()
 
133
            self.f = None
60
134
 
61
135
    def __del__(self):
62
136
        if self.f:
63
137
            from warnings import warn
64
138
            warn("lock on %r not released" % self.f)
65
139
            self.unlock()
66
 
            
67
140
 
68
141
    def unlock(self):
69
142
        raise NotImplementedError()
70
143
 
71
 
        
72
 
 
73
 
 
74
 
 
75
 
 
76
 
############################################################
77
 
# msvcrt locks
78
 
 
79
 
 
80
 
try:
81
 
    import fcntl
82
 
 
83
 
    class _fcntl_FileLock(_base_Lock):
84
 
        f = None
85
 
 
86
 
        def unlock(self):
 
144
 
 
145
_lock_classes = []
 
146
 
 
147
 
 
148
if have_fcntl:
 
149
    LOCK_SH = fcntl.LOCK_SH
 
150
    LOCK_NB = fcntl.LOCK_NB
 
151
    lock_EX = fcntl.LOCK_EX
 
152
 
 
153
 
 
154
    class _fcntl_FileLock(_OSLock):
 
155
 
 
156
        def _unlock(self):
87
157
            fcntl.lockf(self.f, fcntl.LOCK_UN)
88
 
            self.f.close()
89
 
            del self.f 
 
158
            self._clear_f()
90
159
 
91
160
 
92
161
    class _fcntl_WriteLock(_fcntl_FileLock):
 
162
 
 
163
        _open_locks = set()
 
164
 
93
165
        def __init__(self, filename):
 
166
            super(_fcntl_WriteLock, self).__init__()
 
167
            # Check we can grab a lock before we actually open the file.
 
168
            self.filename = osutils.realpath(filename)
 
169
            if self.filename in _fcntl_WriteLock._open_locks:
 
170
                self._clear_f()
 
171
                raise errors.LockContention(self.filename)
 
172
 
 
173
            self._open(self.filename, 'rb+')
 
174
            # reserve a slot for this lock - even if the lockf call fails,
 
175
            # at thisi point unlock() will be called, because self.f is set.
 
176
            # TODO: make this fully threadsafe, if we decide we care.
 
177
            _fcntl_WriteLock._open_locks.add(self.filename)
94
178
            try:
95
 
                fcntl.lockf(self._open(filename, 'wb'), fcntl.LOCK_EX)
96
 
            except Exception, e:
97
 
                raise LockError(e)
 
179
                # LOCK_NB will cause IOError to be raised if we can't grab a
 
180
                # lock right away.
 
181
                fcntl.lockf(self.f, fcntl.LOCK_EX | fcntl.LOCK_NB)
 
182
            except IOError, e:
 
183
                if e.errno in (errno.EAGAIN, errno.EACCES):
 
184
                    # We couldn't grab the lock
 
185
                    self.unlock()
 
186
                # we should be more precise about whats a locking
 
187
                # error and whats a random-other error
 
188
                raise errors.LockContention(e)
 
189
 
 
190
        def unlock(self):
 
191
            _fcntl_WriteLock._open_locks.remove(self.filename)
 
192
            self._unlock()
98
193
 
99
194
 
100
195
    class _fcntl_ReadLock(_fcntl_FileLock):
101
 
        def __init__(self, filename):
102
 
            try:
103
 
                fcntl.lockf(self._open(filename, 'rb'), fcntl.LOCK_SH)
104
 
            except Exception, e:
105
 
                raise LockError(e)
106
 
 
107
 
    WriteLock = _fcntl_WriteLock
108
 
    ReadLock = _fcntl_ReadLock
109
 
 
110
 
except ImportError:
111
 
    try:
112
 
        import win32con, win32file, pywintypes
113
 
 
114
 
 
115
 
        #LOCK_SH = 0 # the default
116
 
        #LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
117
 
        #LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
118
 
 
119
 
        class _w32c_FileLock(_base_Lock):
120
 
            def _lock(self, filename, openmode, lockmode):
121
 
                try:
122
 
                    self._open(filename, openmode)
123
 
                    self.hfile = win32file._get_osfhandle(self.f.fileno())
124
 
                    overlapped = pywintypes.OVERLAPPED()
125
 
                    win32file.LockFileEx(self.hfile, lockmode, 0, 0x7fff0000, overlapped)
126
 
                except Exception, e:
127
 
                    raise LockError(e)
128
 
 
129
 
            def unlock(self):
130
 
                try:
131
 
                    overlapped = pywintypes.OVERLAPPED()
132
 
                    win32file.UnlockFileEx(self.hfile, 0, 0x7fff0000, overlapped)
133
 
                    self.f.close()
134
 
                    self.f = None
135
 
                except Exception, e:
136
 
                    raise LockError(e)
137
 
 
138
 
 
139
 
 
140
 
        class _w32c_ReadLock(_w32c_FileLock):
141
 
            def __init__(self, filename):
142
 
                _w32c_FileLock._lock(self, filename, 'rb', 0)
143
 
 
144
 
        class _w32c_WriteLock(_w32c_FileLock):
145
 
            def __init__(self, filename):
146
 
                _w32c_FileLock._lock(self, filename, 'wb',
147
 
                                     win32con.LOCKFILE_EXCLUSIVE_LOCK)
148
 
 
149
 
 
150
 
 
151
 
        WriteLock = _w32c_WriteLock
152
 
        ReadLock = _w32c_ReadLock
153
 
 
154
 
    except ImportError:
155
 
        try:
156
 
            import msvcrt
157
 
 
158
 
 
159
 
            # Unfortunately, msvcrt.locking() doesn't distinguish between
160
 
            # read locks and write locks. Also, the way the combinations
161
 
            # work to get non-blocking is not the same, so we
162
 
            # have to write extra special functions here.
163
 
 
164
 
 
165
 
            class _msvc_FileLock(_base_Lock):
166
 
                LOCK_SH = 1
167
 
                LOCK_EX = 2
168
 
                LOCK_NB = 4
169
 
                def unlock(self):
170
 
                    _msvc_unlock(self.f)
171
 
                    self.f.close()
172
 
                    self.f = None
173
 
 
174
 
 
175
 
            class _msvc_ReadLock(_msvc_FileLock):
176
 
                def __init__(self, filename):
177
 
                    _msvc_lock(self._open(filename, 'rb'), self.LOCK_SH)
178
 
 
179
 
 
180
 
            class _msvc_WriteLock(_msvc_FileLock):
181
 
                def __init__(self, filename):
182
 
                    _msvc_lock(self._open(filename, 'wb'), self.LOCK_EX)
183
 
 
184
 
 
185
 
 
186
 
            def _msvc_lock(f, flags):
187
 
                try:
188
 
                    # Unfortunately, msvcrt.LK_RLCK is equivalent to msvcrt.LK_LOCK
189
 
                    # according to the comments, LK_RLCK is open the lock for writing.
190
 
 
191
 
                    # Unfortunately, msvcrt.locking() also has the side effect that it
192
 
                    # will only block for 10 seconds at most, and then it will throw an
193
 
                    # exception, this isn't terrible, though.
194
 
                    if type(f) == file:
195
 
                        fpos = f.tell()
196
 
                        fn = f.fileno()
197
 
                        f.seek(0)
198
 
                    else:
199
 
                        fn = f
200
 
                        fpos = os.lseek(fn, 0,0)
201
 
                        os.lseek(fn, 0,0)
202
 
 
203
 
                    if flags & _msvc_FileLock.LOCK_SH:
204
 
                        if flags & _msvc_FileLock.LOCK_NB:
205
 
                            lock_mode = msvcrt.LK_NBLCK
206
 
                        else:
207
 
                            lock_mode = msvcrt.LK_LOCK
208
 
                    elif flags & _msvc_FileLock.LOCK_EX:
209
 
                        if flags & _msvc_FileLock.LOCK_NB:
210
 
                            lock_mode = msvcrt.LK_NBRLCK
211
 
                        else:
212
 
                            lock_mode = msvcrt.LK_RLCK
213
 
                    else:
214
 
                        raise ValueError('Invalid lock mode: %r' % flags)
215
 
                    try:
216
 
                        msvcrt.locking(fn, lock_mode, -1)
217
 
                    finally:
218
 
                        os.lseek(fn, fpos, 0)
219
 
                except Exception, e:
220
 
                    raise LockError(e)
221
 
 
222
 
            def _msvc_unlock(f):
223
 
                try:
224
 
                    if type(f) == file:
225
 
                        fpos = f.tell()
226
 
                        fn = f.fileno()
227
 
                        f.seek(0)
228
 
                    else:
229
 
                        fn = f
230
 
                        fpos = os.lseek(fn, 0,0)
231
 
                        os.lseek(fn, 0,0)
232
 
 
233
 
                    try:
234
 
                        msvcrt.locking(fn, msvcrt.LK_UNLCK, -1)
235
 
                    finally:
236
 
                        os.lseek(fn, fpos, 0)
237
 
                except Exception, e:
238
 
                    raise LockError(e)
239
 
 
240
 
 
241
 
 
242
 
            WriteLock = _msvc_WriteLock
243
 
            ReadLock = _msvc_ReadLock
244
 
        except ImportError:
245
 
            raise NotImplementedError("please write a locking method "
246
 
                                      "for platform %r" % sys.platform)
247
 
 
248
 
 
249
 
 
250
 
 
251
 
 
252
 
 
 
196
 
 
197
        _open_locks = {}
 
198
 
 
199
        def __init__(self, filename):
 
200
            super(_fcntl_ReadLock, self).__init__()
 
201
            self.filename = osutils.realpath(filename)
 
202
            _fcntl_ReadLock._open_locks.setdefault(self.filename, 0)
 
203
            _fcntl_ReadLock._open_locks[self.filename] += 1
 
204
            self._open(filename, 'rb')
 
205
            try:
 
206
                # LOCK_NB will cause IOError to be raised if we can't grab a
 
207
                # lock right away.
 
208
                fcntl.lockf(self.f, fcntl.LOCK_SH | fcntl.LOCK_NB)
 
209
            except IOError, e:
 
210
                # we should be more precise about whats a locking
 
211
                # error and whats a random-other error
 
212
                raise errors.LockContention(e)
 
213
 
 
214
        def unlock(self):
 
215
            count = _fcntl_ReadLock._open_locks[self.filename]
 
216
            if count == 1:
 
217
                del _fcntl_ReadLock._open_locks[self.filename]
 
218
            else:
 
219
                _fcntl_ReadLock._open_locks[self.filename] = count - 1
 
220
            self._unlock()
 
221
 
 
222
        def temporary_write_lock(self):
 
223
            """Try to grab a write lock on the file.
 
224
 
 
225
            On platforms that support it, this will upgrade to a write lock
 
226
            without unlocking the file.
 
227
            Otherwise, this will release the read lock, and try to acquire a
 
228
            write lock.
 
229
 
 
230
            :return: A token which can be used to switch back to a read lock.
 
231
            """
 
232
            if self.filename in _fcntl_WriteLock._open_locks:
 
233
                raise AssertionError('file already locked: %r'
 
234
                    % (self.filename,))
 
235
            try:
 
236
                wlock = _fcntl_TemporaryWriteLock(self)
 
237
            except errors.LockError:
 
238
                # We didn't unlock, so we can just return 'self'
 
239
                return False, self
 
240
            return True, wlock
 
241
 
 
242
 
 
243
    class _fcntl_TemporaryWriteLock(_OSLock):
 
244
        """A token used when grabbing a temporary_write_lock.
 
245
 
 
246
        Call restore_read_lock() when you are done with the write lock.
 
247
        """
 
248
 
 
249
        def __init__(self, read_lock):
 
250
            super(_fcntl_TemporaryWriteLock, self).__init__()
 
251
            self._read_lock = read_lock
 
252
            self.filename = read_lock.filename
 
253
 
 
254
            count = _fcntl_ReadLock._open_locks[self.filename]
 
255
            if count > 1:
 
256
                # Something else also has a read-lock, so we cannot grab a
 
257
                # write lock.
 
258
                raise errors.LockContention(self.filename)
 
259
 
 
260
            if self.filename in _fcntl_WriteLock._open_locks:
 
261
                raise AssertionError('file already locked: %r'
 
262
                    % (self.filename,))
 
263
 
 
264
            # See if we can open the file for writing. Another process might
 
265
            # have a read lock. We don't use self._open() because we don't want
 
266
            # to create the file if it exists. That would have already been
 
267
            # done by _fcntl_ReadLock
 
268
            try:
 
269
                new_f = open(self.filename, 'rb+')
 
270
            except IOError, e:
 
271
                if e.errno in (errno.EACCES, errno.EPERM):
 
272
                    raise errors.LockFailed(self.filename, str(e))
 
273
                raise
 
274
            try:
 
275
                # LOCK_NB will cause IOError to be raised if we can't grab a
 
276
                # lock right away.
 
277
                fcntl.lockf(new_f, fcntl.LOCK_EX | fcntl.LOCK_NB)
 
278
            except IOError, e:
 
279
                # TODO: Raise a more specific error based on the type of error
 
280
                raise errors.LockContention(e)
 
281
            _fcntl_WriteLock._open_locks.add(self.filename)
 
282
 
 
283
            self.f = new_f
 
284
 
 
285
        def restore_read_lock(self):
 
286
            """Restore the original ReadLock."""
 
287
            # For fcntl, since we never released the read lock, just release the
 
288
            # write lock, and return the original lock.
 
289
            fcntl.lockf(self.f, fcntl.LOCK_UN)
 
290
            self._clear_f()
 
291
            _fcntl_WriteLock._open_locks.remove(self.filename)
 
292
            # Avoid reference cycles
 
293
            read_lock = self._read_lock
 
294
            self._read_lock = None
 
295
            return read_lock
 
296
 
 
297
 
 
298
    _lock_classes.append(('fcntl', _fcntl_WriteLock, _fcntl_ReadLock))
 
299
 
 
300
 
 
301
if have_pywin32 and sys.platform == 'win32':
 
302
    LOCK_SH = 0 # the default
 
303
    LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
 
304
    LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
 
305
 
 
306
 
 
307
    class _w32c_FileLock(_OSLock):
 
308
 
 
309
        def _lock(self, filename, openmode, lockmode):
 
310
            self._open(filename, openmode)
 
311
 
 
312
            self.hfile = msvcrt.get_osfhandle(self.f.fileno())
 
313
            overlapped = pywintypes.OVERLAPPED()
 
314
            try:
 
315
                win32file.LockFileEx(self.hfile, lockmode, 0, 0x7fff0000,
 
316
                                     overlapped)
 
317
            except pywintypes.error, e:
 
318
                self._clear_f()
 
319
                if e.args[0] in (winerror.ERROR_LOCK_VIOLATION,):
 
320
                    raise errors.LockContention(filename)
 
321
                ## import pdb; pdb.set_trace()
 
322
                raise
 
323
            except Exception, e:
 
324
                self._clear_f()
 
325
                raise errors.LockContention(e)
 
326
 
 
327
        def unlock(self):
 
328
            overlapped = pywintypes.OVERLAPPED()
 
329
            try:
 
330
                win32file.UnlockFileEx(self.hfile, 0, 0x7fff0000, overlapped)
 
331
                self._clear_f()
 
332
            except Exception, e:
 
333
                raise errors.LockContention(e)
 
334
 
 
335
 
 
336
    class _w32c_ReadLock(_w32c_FileLock):
 
337
        def __init__(self, filename):
 
338
            super(_w32c_ReadLock, self).__init__()
 
339
            self._lock(filename, 'rb', LOCK_SH + LOCK_NB)
 
340
 
 
341
        def temporary_write_lock(self):
 
342
            """Try to grab a write lock on the file.
 
343
 
 
344
            On platforms that support it, this will upgrade to a write lock
 
345
            without unlocking the file.
 
346
            Otherwise, this will release the read lock, and try to acquire a
 
347
            write lock.
 
348
 
 
349
            :return: A token which can be used to switch back to a read lock.
 
350
            """
 
351
            # I can't find a way to upgrade a read lock to a write lock without
 
352
            # unlocking first. So here, we do just that.
 
353
            self.unlock()
 
354
            try:
 
355
                wlock = _w32c_WriteLock(self.filename)
 
356
            except errors.LockError:
 
357
                return False, _w32c_ReadLock(self.filename)
 
358
            return True, wlock
 
359
 
 
360
 
 
361
    class _w32c_WriteLock(_w32c_FileLock):
 
362
        def __init__(self, filename):
 
363
            super(_w32c_WriteLock, self).__init__()
 
364
            self._lock(filename, 'rb+', LOCK_EX + LOCK_NB)
 
365
 
 
366
        def restore_read_lock(self):
 
367
            """Restore the original ReadLock."""
 
368
            # For win32 we had to completely let go of the original lock, so we
 
369
            # just unlock and create a new read lock.
 
370
            self.unlock()
 
371
            return _w32c_ReadLock(self.filename)
 
372
 
 
373
 
 
374
    _lock_classes.append(('pywin32', _w32c_WriteLock, _w32c_ReadLock))
 
375
 
 
376
 
 
377
if have_ctypes_win32:
 
378
    # These constants were copied from the win32con.py module.
 
379
    LOCKFILE_FAIL_IMMEDIATELY = 1
 
380
    LOCKFILE_EXCLUSIVE_LOCK = 2
 
381
    # Constant taken from winerror.py module
 
382
    ERROR_LOCK_VIOLATION = 33
 
383
 
 
384
    LOCK_SH = 0
 
385
    LOCK_EX = LOCKFILE_EXCLUSIVE_LOCK
 
386
    LOCK_NB = LOCKFILE_FAIL_IMMEDIATELY
 
387
    _LockFileEx = ctypes.windll.kernel32.LockFileEx
 
388
    _UnlockFileEx = ctypes.windll.kernel32.UnlockFileEx
 
389
    _GetLastError = ctypes.windll.kernel32.GetLastError
 
390
 
 
391
    ### Define the OVERLAPPED structure.
 
392
    #   http://msdn2.microsoft.com/en-us/library/ms684342.aspx
 
393
    # typedef struct _OVERLAPPED {
 
394
    #   ULONG_PTR Internal;
 
395
    #   ULONG_PTR InternalHigh;
 
396
    #   union {
 
397
    #     struct {
 
398
    #       DWORD Offset;
 
399
    #       DWORD OffsetHigh;
 
400
    #     };
 
401
    #     PVOID Pointer;
 
402
    #   };
 
403
    #   HANDLE hEvent;
 
404
    # } OVERLAPPED,
 
405
 
 
406
    class _inner_struct(ctypes.Structure):
 
407
        _fields_ = [('Offset', ctypes.c_uint), # DWORD
 
408
                    ('OffsetHigh', ctypes.c_uint), # DWORD
 
409
                   ]
 
410
 
 
411
    class _inner_union(ctypes.Union):
 
412
        _fields_  = [('anon_struct', _inner_struct), # struct
 
413
                     ('Pointer', ctypes.c_void_p), # PVOID
 
414
                    ]
 
415
 
 
416
    class OVERLAPPED(ctypes.Structure):
 
417
        _fields_ = [('Internal', ctypes.c_void_p), # ULONG_PTR
 
418
                    ('InternalHigh', ctypes.c_void_p), # ULONG_PTR
 
419
                    ('_inner_union', _inner_union),
 
420
                    ('hEvent', ctypes.c_void_p), # HANDLE
 
421
                   ]
 
422
 
 
423
    class _ctypes_FileLock(_OSLock):
 
424
 
 
425
        def _lock(self, filename, openmode, lockmode):
 
426
            self._open(filename, openmode)
 
427
 
 
428
            self.hfile = msvcrt.get_osfhandle(self.f.fileno())
 
429
            overlapped = OVERLAPPED()
 
430
            result = _LockFileEx(self.hfile, # HANDLE hFile
 
431
                                 lockmode,   # DWORD dwFlags
 
432
                                 0,          # DWORD dwReserved
 
433
                                 0x7fffffff, # DWORD nNumberOfBytesToLockLow
 
434
                                 0x00000000, # DWORD nNumberOfBytesToLockHigh
 
435
                                 ctypes.byref(overlapped), # lpOverlapped
 
436
                                )
 
437
            if result == 0:
 
438
                self._clear_f()
 
439
                last_err = _GetLastError()
 
440
                if last_err in (ERROR_LOCK_VIOLATION,):
 
441
                    raise errors.LockContention(filename)
 
442
                raise errors.LockContention('Unknown locking error: %s'
 
443
                                            % (last_err,))
 
444
 
 
445
        def unlock(self):
 
446
            overlapped = OVERLAPPED()
 
447
            result = _UnlockFileEx(self.hfile, # HANDLE hFile
 
448
                                   0,          # DWORD dwReserved
 
449
                                   0x7fffffff, # DWORD nNumberOfBytesToLockLow
 
450
                                   0x00000000, # DWORD nNumberOfBytesToLockHigh
 
451
                                   ctypes.byref(overlapped), # lpOverlapped
 
452
                                  )
 
453
            self._clear_f()
 
454
            if result == 0:
 
455
                self._clear_f()
 
456
                last_err = _GetLastError()
 
457
                raise errors.LockContention('Unknown unlocking error: %s'
 
458
                                            % (last_err,))
 
459
 
 
460
 
 
461
    class _ctypes_ReadLock(_ctypes_FileLock):
 
462
        def __init__(self, filename):
 
463
            super(_ctypes_ReadLock, self).__init__()
 
464
            self._lock(filename, 'rb', LOCK_SH + LOCK_NB)
 
465
 
 
466
        def temporary_write_lock(self):
 
467
            """Try to grab a write lock on the file.
 
468
 
 
469
            On platforms that support it, this will upgrade to a write lock
 
470
            without unlocking the file.
 
471
            Otherwise, this will release the read lock, and try to acquire a
 
472
            write lock.
 
473
 
 
474
            :return: A token which can be used to switch back to a read lock.
 
475
            """
 
476
            # I can't find a way to upgrade a read lock to a write lock without
 
477
            # unlocking first. So here, we do just that.
 
478
            self.unlock()
 
479
            try:
 
480
                wlock = _ctypes_WriteLock(self.filename)
 
481
            except errors.LockError:
 
482
                return False, _ctypes_ReadLock(self.filename)
 
483
            return True, wlock
 
484
 
 
485
    class _ctypes_WriteLock(_ctypes_FileLock):
 
486
        def __init__(self, filename):
 
487
            super(_ctypes_WriteLock, self).__init__()
 
488
            self._lock(filename, 'rb+', LOCK_EX + LOCK_NB)
 
489
 
 
490
        def restore_read_lock(self):
 
491
            """Restore the original ReadLock."""
 
492
            # For win32 we had to completely let go of the original lock, so we
 
493
            # just unlock and create a new read lock.
 
494
            self.unlock()
 
495
            return _ctypes_ReadLock(self.filename)
 
496
 
 
497
 
 
498
    _lock_classes.append(('ctypes', _ctypes_WriteLock, _ctypes_ReadLock))
 
499
 
 
500
 
 
501
if len(_lock_classes) == 0:
 
502
    raise NotImplementedError(
 
503
        "We must have one of fcntl, pywin32, or ctypes available"
 
504
        " to support OS locking."
 
505
        )
 
506
 
 
507
 
 
508
# We default to using the first available lock class.
 
509
_lock_type, WriteLock, ReadLock = _lock_classes[0]
253
510