1
# Copyright (C) 2005 by Canonical Ltd
2
# Authors: Robert Collins <robert.collins@canonical.com>
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
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
18
"""This module provides a transactional facility.
20
Transactions provide hooks to allow data objects (i.e. inventory weaves or
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.
27
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.
44
import bzrlib.errors as errors
45
from bzrlib.identitymap import IdentityMap, NullIdentityMap
46
from bzrlib.trace import mutter
49
class ReadOnlyTransaction(object):
50
"""A read only unit of work for data objects."""
53
"""ReadOnlyTransactions cannot commit."""
54
raise errors.CommitNotPossible()
57
"""Clean up this transaction
59
This will rollback on transactions that can if they have nto been
64
super(ReadOnlyTransaction, self).__init__()
65
self.map = IdentityMap()
66
self._clean_objects = set()
67
self._clean_queue = []
69
self._precious_objects = set()
71
def register_clean(self, an_object, precious=False):
72
"""Register an_object as being clean.
74
If the precious hint is True, the object will not
75
be ejected from the object identity map ever.
77
self._clean_objects.add(an_object)
78
self._clean_queue.append(an_object)
80
self._precious_objects.add(an_object)
83
def register_dirty(self, an_object):
84
"""Register an_object as being dirty."""
85
raise errors.ReadOnlyObjectDirtiedError(an_object)
88
"""Let people call this even though nothing has to happen."""
90
def set_cache_size(self, size):
91
"""Set a new cache size."""
97
"""Trim the cache back if needed."""
98
if self._limit < 0 or self._limit - len(self._clean_objects) > 0:
100
needed = len(self._clean_objects) - self._limit
102
while needed and offset < len(self._clean_objects):
103
# references we know of:
104
# temp passed to getrefcount in our frame
105
# temp in getrefcount's frame
111
if (sys.getrefcount(self._clean_queue[offset]) <= 7 and
112
not self._clean_queue[offset] in self._precious_objects):
113
removed = self._clean_queue[offset]
114
self._clean_objects.remove(removed)
115
del self._clean_queue[offset]
116
self.map.remove_object(removed)
117
mutter('removed object %r', removed)
124
class PassThroughTransaction(object):
125
"""A pass through transaction
127
- all actions are committed immediately.
128
- rollback is not supported.
129
- commit() is a no-op.
133
"""PassThroughTransactions have nothing to do."""
136
"""Clean up this transaction
138
This will rollback on transactions that can if they have nto been
143
super(PassThroughTransaction, self).__init__()
144
self.map = NullIdentityMap()
146
def register_clean(self, an_object, precious=False):
147
"""Register an_object as being clean.
149
Note that precious is only a hint, and PassThroughTransaction
153
def register_dirty(self, an_object):
154
"""Register an_object as being dirty."""
157
"""Cannot rollback a pass through transaction."""
158
raise errors.AlreadyCommitted
160
def set_cache_size(self, ignored):
161
"""Do nothing, we are passing through."""
added
removed
bzrlib/transactions.py
