← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transactions.py

(vila) Fix test failures blocking package builds. (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transactions.py
1
 
# Copyright (C) 2005 by Canonical Ltd
 
1
# Copyright (C) 2005 Canonical Ltd
2
2
#   Authors: Robert Collins <robert.collins@canonical.com>
3
3
#
4
4
# This program is free software; you can redistribute it and/or modify
13
13
#
14
14
# You should have received a copy of the GNU General Public License
15
15
# along with this program; if not, write to the Free Software
16
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
17
 
18
18
"""This module provides a transactional facility.
19
19
 
20
20
Transactions provide hooks to allow data objects (i.e. inventory weaves or
21
21
the revision-history file) to be placed in a registry and retrieved later
22
 
during the same transaction.  This allows for repeated read isolation. At
23
 
the end of a transaction, a callback is issued to each registered changed
24
 
item informing it whether it should commit or not. We provide a two layer
25
 
facility - domain objects are notified first, then data objects.
 
22
during the same transaction. Transactions in bzr are not atomic - they
 
23
depend on data ordering of writes, so we do not have commit or rollback
 
24
facilities at the transaction level.
26
25
 
27
26
Read only transactions raise an assert when objects are listed as dirty
28
 
against them - preventing unintended writes. Once all the data storage is
29
 
hooked into this facility, it might be nice to have a readonly transaction
30
 
that just excepts on commit, for testing or simulating of things.
31
 
 
32
 
Write transactions queue all changes in the transaction (which may in the 
33
 
future involve writing them to uncommitted atomic files in preparation 
34
 
for commit - i.e. on network connections where latency matters) and then
35
 
notify each object of commit or rollback.
36
 
 
37
 
Both read and write transactions *may* flush unchanged objects out of 
38
 
memory, unless they are marked as 'preserve' which indicates that 
39
 
repeated reads cannot be obtained if the object is ejected.
 
27
against them - preventing unintended writes.
 
28
 
 
29
Write transactions preserve dirty objects in the cache, though due to the
 
30
write ordering approach we use for consistency 'dirty' is a misleading term.
 
31
A dirty object is one we have modified.
 
32
 
 
33
Both read and write transactions *may* flush unchanged objects out of
 
34
memory, unless they are marked as 'precious' which indicates that
 
35
repeated reads cannot be obtained if the object is ejected, or that
 
36
the object is an expensive one for obtaining.
40
37
"""
41
38
 
 
39
from __future__ import absolute_import
 
40
 
42
41
import sys
43
42
 
44
43
import bzrlib.errors as errors
49
48
class ReadOnlyTransaction(object):
50
49
    """A read only unit of work for data objects."""
51
50
 
52
 
    def commit(self):
53
 
        """ReadOnlyTransactions cannot commit."""
54
 
        raise errors.CommitNotPossible('In a read only transaction')
55
 
 
56
51
    def finish(self):
57
 
        """Clean up this transaction
58
 
 
59
 
        This will rollback on transactions that can if they have nto been
60
 
        committed.
61
 
        """
 
52
        """Clean up this transaction."""
62
53
 
63
54
    def __init__(self):
64
55
        super(ReadOnlyTransaction, self).__init__()
68
59
        self._limit = -1
69
60
        self._precious_objects = set()
70
61
 
 
62
    def is_clean(self, an_object):
 
63
        """Return True if an_object is clean."""
 
64
        return (an_object in self._clean_objects)
 
65
 
71
66
    def register_clean(self, an_object, precious=False):
72
67
        """Register an_object as being clean.
73
 
        
 
68
 
74
69
        If the precious hint is True, the object will not
75
70
        be ejected from the object identity map ever.
76
71
        """
82
77
 
83
78
    def register_dirty(self, an_object):
84
79
        """Register an_object as being dirty."""
85
 
        raise errors.ReadOnlyError(
86
 
            "Cannot dirty objects in a read only transaction")
87
 
 
88
 
    def rollback(self):
89
 
        """Let people call this even though nothing has to happen."""
 
80
        raise errors.ReadOnlyObjectDirtiedError(an_object)
90
81
 
91
82
    def set_cache_size(self, size):
92
83
        """Set a new cache size."""
93
 
        assert -1 <= size
 
84
        if size < -1:
 
85
            raise ValueError(size)
94
86
        self._limit = size
95
87
        self._trim()
96
88
 
120
112
            else:
121
113
                offset += 1
122
114
 
123
 
 
124
 
        
 
115
    def writeable(self):
 
116
        """Read only transactions do not allow writes."""
 
117
 
 
118
 
 
119
class WriteTransaction(ReadOnlyTransaction):
 
120
    """A write transaction
 
121
 
 
122
    - caches domain objects
 
123
    - clean objects can be removed from the cache
 
124
    - dirty objects are retained.
 
125
    """
 
126
 
 
127
    def finish(self):
 
128
        """Clean up this transaction."""
 
129
        for thing in self._dirty_objects:
 
130
            callback = getattr(thing, 'transaction_finished', None)
 
131
            if callback is not None:
 
132
                callback()
 
133
 
 
134
    def __init__(self):
 
135
        super(WriteTransaction, self).__init__()
 
136
        self._dirty_objects = set()
 
137
 
 
138
    def is_dirty(self, an_object):
 
139
        """Return True if an_object is dirty."""
 
140
        return (an_object in self._dirty_objects)
 
141
 
 
142
    def register_dirty(self, an_object):
 
143
        """Register an_object as being dirty.
 
144
 
 
145
        Dirty objects are not ejected from the identity map
 
146
        until the transaction finishes and get informed
 
147
        when the transaction finishes.
 
148
        """
 
149
        self._dirty_objects.add(an_object)
 
150
        if self.is_clean(an_object):
 
151
            self._clean_objects.remove(an_object)
 
152
            del self._clean_queue[self._clean_queue.index(an_object)]
 
153
        self._trim()
 
154
 
 
155
    def writeable(self):
 
156
        """Write transactions allow writes."""
 
157
        return True
 
158
 
 
159
 
125
160
class PassThroughTransaction(object):
126
161
    """A pass through transaction
127
 
    
128
 
    - all actions are committed immediately.
129
 
    - rollback is not supported.
130
 
    - commit() is a no-op.
 
162
 
 
163
    - nothing is cached.
 
164
    - nothing ever gets into the identity map.
131
165
    """
132
166
 
133
 
    def commit(self):
134
 
        """PassThroughTransactions have nothing to do."""
135
 
 
136
167
    def finish(self):
137
 
        """Clean up this transaction
138
 
 
139
 
        This will rollback on transactions that can if they have nto been
140
 
        committed.
141
 
        """
 
168
        """Clean up this transaction."""
 
169
        for thing in self._dirty_objects:
 
170
            callback = getattr(thing, 'transaction_finished', None)
 
171
            if callback is not None:
 
172
                callback()
142
173
 
143
174
    def __init__(self):
144
175
        super(PassThroughTransaction, self).__init__()
145
176
        self.map = NullIdentityMap()
 
177
        self._dirty_objects = set()
146
178
 
147
179
    def register_clean(self, an_object, precious=False):
148
180
        """Register an_object as being clean.
149
 
        
 
181
 
150
182
        Note that precious is only a hint, and PassThroughTransaction
151
183
        ignores it.
152
184
        """
153
185
 
154
186
    def register_dirty(self, an_object):
155
 
        """Register an_object as being dirty."""
 
187
        """Register an_object as being dirty.
156
188
 
157
 
    def rollback(self):
158
 
        """Cannot rollback a pass through transaction."""
159
 
        raise errors.AlreadyCommitted
 
189
        Dirty objects get informed
 
190
        when the transaction finishes.
 
191
        """
 
192
        self._dirty_objects.add(an_object)
160
193
 
161
194
    def set_cache_size(self, ignored):
162
195
        """Do nothing, we are passing through."""
 
196
 
 
197
    def writeable(self):
 
198
        """Pass through transactions allow writes."""
 
199
        return True