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
18
18
"""This module provides a transactional facility.
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.
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.
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.
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.
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.
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.
49
46
class ReadOnlyTransaction(object):
50
47
"""A read only unit of work for data objects."""
53
"""ReadOnlyTransactions cannot commit."""
54
raise errors.CommitNotPossible('In a read only transaction')
57
"""Clean up this transaction
59
This will rollback on transactions that can if they have nto been
50
"""Clean up this transaction."""
63
52
def __init__(self):
64
53
super(ReadOnlyTransaction, self).__init__()
69
58
self._precious_objects = set()
60
def is_clean(self, an_object):
61
"""Return True if an_object is clean."""
62
return (an_object in self._clean_objects)
71
64
def register_clean(self, an_object, precious=False):
72
65
"""Register an_object as being clean.
74
67
If the precious hint is True, the object will not
75
68
be ejected from the object identity map ever.
83
76
def register_dirty(self, an_object):
84
77
"""Register an_object as being dirty."""
85
raise errors.ReadOnlyError(
86
"Cannot dirty objects in a read only transaction")
89
"""Let people call this even though nothing has to happen."""
78
raise errors.ReadOnlyObjectDirtiedError(an_object)
91
80
def set_cache_size(self, size):
92
81
"""Set a new cache size."""
83
raise ValueError(size)
114
"""Read only transactions do not allow writes."""
117
class WriteTransaction(ReadOnlyTransaction):
118
"""A write transaction
120
- caches domain objects
121
- clean objects can be removed from the cache
122
- dirty objects are retained.
126
"""Clean up this transaction."""
127
for thing in self._dirty_objects:
128
callback = getattr(thing, 'transaction_finished', None)
129
if callback is not None:
133
super(WriteTransaction, self).__init__()
134
self._dirty_objects = set()
136
def is_dirty(self, an_object):
137
"""Return True if an_object is dirty."""
138
return (an_object in self._dirty_objects)
140
def register_dirty(self, an_object):
141
"""Register an_object as being dirty.
143
Dirty objects are not ejected from the identity map
144
until the transaction finishes and get informed
145
when the transaction finishes.
147
self._dirty_objects.add(an_object)
148
if self.is_clean(an_object):
149
self._clean_objects.remove(an_object)
150
del self._clean_queue[self._clean_queue.index(an_object)]
154
"""Write transactions allow writes."""
125
158
class PassThroughTransaction(object):
126
159
"""A pass through transaction
128
- all actions are committed immediately.
129
- rollback is not supported.
130
- commit() is a no-op.
162
- nothing ever gets into the identity map.
134
"""PassThroughTransactions have nothing to do."""
136
165
def finish(self):
137
"""Clean up this transaction
139
This will rollback on transactions that can if they have nto been
166
"""Clean up this transaction."""
167
for thing in self._dirty_objects:
168
callback = getattr(thing, 'transaction_finished', None)
169
if callback is not None:
143
172
def __init__(self):
144
173
super(PassThroughTransaction, self).__init__()
145
174
self.map = NullIdentityMap()
175
self._dirty_objects = set()
147
177
def register_clean(self, an_object, precious=False):
148
178
"""Register an_object as being clean.
150
180
Note that precious is only a hint, and PassThroughTransaction
154
184
def register_dirty(self, an_object):
155
"""Register an_object as being dirty."""
185
"""Register an_object as being dirty.
158
"""Cannot rollback a pass through transaction."""
159
raise errors.AlreadyCommitted
187
Dirty objects get informed
188
when the transaction finishes.
190
self._dirty_objects.add(an_object)
161
192
def set_cache_size(self, ignored):
162
193
"""Do nothing, we are passing through."""
196
"""Pass through transactions allow writes."""