← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: Aaron Bentley
  • Date: 2012-07-19 16:57:16 UTC
  • mto: This revision was merged to the branch mainline in revision 6540.
  • Revision ID: aaron@aaronbentley.com-20120719165716-b4iupzkb17b9l9wx
Avoid branch write lock to preserve VFS call count.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockable_files.py
1
 
# Copyright (C) 2005, 2006, 2008 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
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
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
from cStringIO import StringIO
18
 
import codecs
19
 
#import traceback
20
 
from warnings import warn
21
 
 
22
 
import bzrlib
23
 
from bzrlib.decorators import (needs_read_lock,
24
 
        needs_write_lock)
25
 
import bzrlib.errors as errors
26
 
from bzrlib.errors import BzrError
27
 
from bzrlib.osutils import file_iterator, safe_unicode
28
 
from bzrlib.symbol_versioning import (
29
 
    deprecated_in,
30
 
    deprecated_method,
31
 
    )
32
 
from bzrlib.trace import mutter, note
33
 
import bzrlib.transactions as transactions
34
 
import bzrlib.urlutils as urlutils
35
 
 
36
 
 
37
 
# XXX: The tracking here of lock counts and whether the lock is held is
38
 
# somewhat redundant with what's done in LockDir; the main difference is that
39
 
# LockableFiles permits reentrancy.
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
from bzrlib.lazy_import import lazy_import
 
20
lazy_import(globals(), """
 
21
import warnings
 
22
 
 
23
from bzrlib import (
 
24
    counted_lock,
 
25
    errors,
 
26
    lock,
 
27
    osutils,
 
28
    transactions,
 
29
    urlutils,
 
30
    )
 
31
""")
 
32
 
 
33
from bzrlib.decorators import (
 
34
    only_raises,
 
35
    )
 
36
 
40
37
 
41
38
class LockableFiles(object):
42
39
    """Object representing a set of related files locked within the same scope.
43
40
 
44
 
    These files are used by a WorkingTree, Repository or Branch, and should
45
 
    generally only be touched by that object.
46
 
 
47
 
    LockableFiles also provides some policy on top of Transport for encoding
48
 
    control files as utf-8.
 
41
    This coordinates access to the lock along with providing a transaction.
49
42
 
50
43
    LockableFiles manage a lock count and can be locked repeatedly by
51
44
    a single caller.  (The underlying lock implementation generally does not
52
45
    support this.)
53
46
 
54
47
    Instances of this class are often called control_files.
55
 
    
56
 
    This object builds on top of a Transport, which is used to actually write
57
 
    the files to disk, and an OSLock or LockDir, which controls how access to
58
 
    the files is controlled.  The particular type of locking used is set when
59
 
    the object is constructed.  In older formats OSLocks are used everywhere.
60
 
    in newer formats a LockDir is used for Repositories and Branches, and 
61
 
    OSLocks for the local filesystem.
 
48
 
 
49
    This class is now deprecated; code should move to using the Transport
 
50
    directly for file operations and using the lock or CountedLock for
 
51
    locking.
 
52
 
 
53
    :ivar _lock: The real underlying lock (e.g. a LockDir)
 
54
    :ivar _lock_count: If _lock_mode is true, a positive count of the number
 
55
        of times the lock has been taken (and not yet released) *by this
 
56
        process*, through this particular object instance.
 
57
    :ivar _lock_mode: None, or 'r' or 'w'
62
58
    """
63
59
 
64
 
    # _lock_mode: None, or 'r' or 'w'
65
 
 
66
 
    # _lock_count: If _lock_mode is true, a positive count of the number of
67
 
    # times the lock has been taken *by this process*.   
68
 
    
69
 
    # If set to False (by a plugin, etc) BzrBranch will not set the
70
 
    # mode on created files or directories
71
 
    _set_file_mode = True
72
 
    _set_dir_mode = True
73
 
 
74
60
    def __init__(self, transport, lock_name, lock_class):
75
61
        """Create a LockableFiles group
76
62
 
77
 
        :param transport: Transport pointing to the directory holding the 
 
63
        :param transport: Transport pointing to the directory holding the
78
64
            control files and lock.
79
65
        :param lock_name: Name of the lock guarding these files.
80
66
        :param lock_class: Class of lock strategy to use: typically
90
76
        self._lock = lock_class(transport, esc_name,
91
77
                                file_modebits=self._file_mode,
92
78
                                dir_modebits=self._dir_mode)
 
79
        self._counted_lock = counted_lock.CountedLock(self._lock)
93
80
 
94
81
    def create_lock(self):
95
82
        """Create the lock.
102
89
    def __repr__(self):
103
90
        return '%s(%r)' % (self.__class__.__name__,
104
91
                           self._transport)
 
92
 
105
93
    def __str__(self):
106
94
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
107
95
 
108
 
    def __del__(self):
109
 
        if self.is_locked():
110
 
            # do not automatically unlock; there should have been a
111
 
            # try/finally to unlock this.
112
 
            warn("%r was gc'd while locked" % self)
113
 
 
114
96
    def break_lock(self):
115
97
        """Break the lock of this lockable files group if it is held.
116
98
 
119
101
        self._lock.break_lock()
120
102
 
121
103
    def _escape(self, file_or_path):
 
104
        """DEPRECATED: Do not use outside this class"""
122
105
        if not isinstance(file_or_path, basestring):
123
106
            file_or_path = '/'.join(file_or_path)
124
107
        if file_or_path == '':
125
108
            return u''
126
 
        return urlutils.escape(safe_unicode(file_or_path))
 
109
        return urlutils.escape(osutils.safe_unicode(file_or_path))
127
110
 
128
111
    def _find_modes(self):
129
 
        """Determine the appropriate modes for files and directories."""
 
112
        """Determine the appropriate modes for files and directories.
 
113
 
 
114
        :deprecated: Replaced by BzrDir._find_creation_modes.
 
115
        """
 
116
        # XXX: The properties created by this can be removed or deprecated
 
117
        # once all the _get_text_store methods etc no longer use them.
 
118
        # -- mbp 20080512
130
119
        try:
131
120
            st = self._transport.stat('.')
132
121
        except errors.TransportNotPossible:
140
129
            self._dir_mode = (st.st_mode & 07777) | 00700
141
130
            # Remove the sticky and execute bits for files
142
131
            self._file_mode = self._dir_mode & ~07111
143
 
        if not self._set_dir_mode:
144
 
            self._dir_mode = None
145
 
        if not self._set_file_mode:
146
 
            self._file_mode = None
147
 
 
148
 
    def controlfilename(self, file_or_path):
149
 
        """Return location relative to branch."""
150
 
        return self._transport.abspath(self._escape(file_or_path))
151
 
 
152
 
    @needs_read_lock
153
 
    def get(self, relpath):
154
 
        """Get a file as a bytestream."""
155
 
        relpath = self._escape(relpath)
156
 
        return self._transport.get(relpath)
157
 
 
158
 
    @needs_read_lock
159
 
    @deprecated_method(deprecated_in((1, 5, 0)))
160
 
    def get_utf8(self, relpath):
161
 
        """Get a file as a unicode stream."""
162
 
        relpath = self._escape(relpath)
163
 
        # DO NOT introduce an errors=replace here.
164
 
        return codecs.getreader('utf-8')(self._transport.get(relpath))
165
 
 
166
 
    @needs_write_lock
167
 
    def put(self, path, file):
168
 
        """Write a file.
169
 
        
170
 
        :param path: The path to put the file, relative to the .bzr control
171
 
                     directory
172
 
        :param f: A file-like or string object whose contents should be copied.
173
 
        """
174
 
        self._transport.put_file(self._escape(path), file, mode=self._file_mode)
175
 
 
176
 
    @needs_write_lock
177
 
    def put_bytes(self, path, a_string):
178
 
        """Write a string of bytes.
179
 
 
180
 
        :param path: The path to put the bytes, relative to the transport root.
181
 
        :param string: A string object, whose exact bytes are to be copied.
182
 
        """
183
 
        self._transport.put_bytes(self._escape(path), a_string,
184
 
                                  mode=self._file_mode)
185
 
 
186
 
    @needs_write_lock
187
 
    def put_utf8(self, path, a_string):
188
 
        """Write a string, encoding as utf-8.
189
 
 
190
 
        :param path: The path to put the string, relative to the transport root.
191
 
        :param string: A string or unicode object whose contents should be copied.
192
 
        """
193
 
        # IterableFile would not be needed if Transport.put took iterables
194
 
        # instead of files.  ADHB 2005-12-25
195
 
        # RBC 20060103 surely its not needed anyway, with codecs transcode
196
 
        # file support ?
197
 
        # JAM 20060103 We definitely don't want encode(..., 'replace')
198
 
        # these are valuable files which should have exact contents.
199
 
        if not isinstance(a_string, basestring):
200
 
            raise errors.BzrBadParameterNotString(a_string)
201
 
        self.put_bytes(path, a_string.encode('utf-8'))
202
132
 
203
133
    def leave_in_place(self):
204
134
        """Set this LockableFiles to not clear the physical lock on unlock."""
210
140
 
211
141
    def lock_write(self, token=None):
212
142
        """Lock this group of files for writing.
213
 
        
 
143
 
214
144
        :param token: if this is already locked, then lock_write will fail
215
145
            unless the token matches the existing lock.
216
146
        :returns: a token if this instance supports tokens, otherwise None.
223
153
        some other way, and need to synchronise this object's state with that
224
154
        fact.
225
155
        """
226
 
        # mutter("lock write: %s (%s)", self, self._lock_count)
227
 
        # TODO: Upgrade locking to support using a Transport,
228
 
        # and potentially a remote locking protocol
229
156
        if self._lock_mode:
230
 
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
 
157
            if (self._lock_mode != 'w'
 
158
                or not self.get_transaction().writeable()):
231
159
                raise errors.ReadOnlyError(self)
232
160
            self._lock.validate_token(token)
233
161
            self._lock_count += 1
234
162
            return self._token_from_lock
235
163
        else:
236
164
            token_from_lock = self._lock.lock_write(token=token)
237
 
            #note('write locking %s', self)
238
165
            #traceback.print_stack()
239
166
            self._lock_mode = 'w'
240
167
            self._lock_count = 1
241
 
            self._set_transaction(transactions.WriteTransaction())
 
168
            self._set_write_transaction()
242
169
            self._token_from_lock = token_from_lock
243
170
            return token_from_lock
244
171
 
245
172
    def lock_read(self):
246
 
        # mutter("lock read: %s (%s)", self, self._lock_count)
247
173
        if self._lock_mode:
248
174
            if self._lock_mode not in ('r', 'w'):
249
175
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
250
176
            self._lock_count += 1
251
177
        else:
252
178
            self._lock.lock_read()
253
 
            #note('read locking %s', self)
254
179
            #traceback.print_stack()
255
180
            self._lock_mode = 'r'
256
181
            self._lock_count = 1
257
 
            self._set_transaction(transactions.ReadOnlyTransaction())
258
 
            # 5K may be excessive, but hey, its a knob.
259
 
            self.get_transaction().set_cache_size(5000)
260
 
                        
 
182
            self._set_read_transaction()
 
183
 
 
184
    def _set_read_transaction(self):
 
185
        """Setup a read transaction."""
 
186
        self._set_transaction(transactions.ReadOnlyTransaction())
 
187
        # 5K may be excessive, but hey, its a knob.
 
188
        self.get_transaction().set_cache_size(5000)
 
189
 
 
190
    def _set_write_transaction(self):
 
191
        """Setup a write transaction."""
 
192
        self._set_transaction(transactions.WriteTransaction())
 
193
 
 
194
    @only_raises(errors.LockNotHeld, errors.LockBroken)
261
195
    def unlock(self):
262
 
        # mutter("unlock: %s (%s)", self, self._lock_count)
263
196
        if not self._lock_mode:
264
 
            raise errors.LockNotHeld(self)
 
197
            return lock.cant_unlock_not_held(self)
265
198
        if self._lock_count > 1:
266
199
            self._lock_count -= 1
267
200
        else:
268
 
            #note('unlocking %s', self)
269
201
            #traceback.print_stack()
270
202
            self._finish_transaction()
271
203
            try:
279
211
 
280
212
    def get_physical_lock_status(self):
281
213
        """Return physical lock status.
282
 
        
 
214
 
283
215
        Returns true if a lock is held on the transport. If no lock is held, or
284
216
        the underlying locking mechanism does not support querying lock
285
217
        status, false is returned.
367
299
    def validate_token(self, token):
368
300
        if token is not None:
369
301
            raise errors.TokenLockingNotSupported(self)
370