← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transactions.py

  • Committer: Robert Collins
  • Date: 2005-10-19 10:11:57 UTC
  • mfrom: (1185.16.78)
  • mto: This revision was merged to the branch mainline in revision 1470.
  • Revision ID: robertc@robertcollins.net-20051019101157-17438d311e746b4f
merge from upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transactions.py
1
 
# Copyright (C) 2005 Canonical Ltd
 
1
# Copyright (C) 2005 by 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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. 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.
 
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.
25
26
 
26
27
Read only transactions raise an assert when objects are listed as dirty
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.
 
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.
37
40
"""
38
41
 
39
42
import sys
46
49
class ReadOnlyTransaction(object):
47
50
    """A read only unit of work for data objects."""
48
51
 
 
52
    def commit(self):
 
53
        """ReadOnlyTransactions cannot commit."""
 
54
        raise errors.CommitNotPossible('In a read only transaction')
 
55
 
49
56
    def finish(self):
50
 
        """Clean up this transaction."""
 
57
        """Clean up this transaction
 
58
 
 
59
        This will rollback on transactions that can if they have nto been
 
60
        committed.
 
61
        """
51
62
 
52
63
    def __init__(self):
53
64
        super(ReadOnlyTransaction, self).__init__()
57
68
        self._limit = -1
58
69
        self._precious_objects = set()
59
70
 
60
 
    def is_clean(self, an_object):
61
 
        """Return True if an_object is clean."""
62
 
        return (an_object in self._clean_objects)
63
 
 
64
71
    def register_clean(self, an_object, precious=False):
65
72
        """Register an_object as being clean.
66
 
 
 
73
        
67
74
        If the precious hint is True, the object will not
68
75
        be ejected from the object identity map ever.
69
76
        """
75
82
 
76
83
    def register_dirty(self, an_object):
77
84
        """Register an_object as being dirty."""
78
 
        raise errors.ReadOnlyObjectDirtiedError(an_object)
 
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."""
79
90
 
80
91
    def set_cache_size(self, size):
81
92
        """Set a new cache size."""
82
 
        if size < -1:
83
 
            raise ValueError(size)
 
93
        assert -1 <= size
84
94
        self._limit = size
85
95
        self._trim()
86
96
 
110
120
            else:
111
121
                offset += 1
112
122
 
113
 
    def writeable(self):
114
 
        """Read only transactions do not allow writes."""
115
 
 
116
 
 
117
 
class WriteTransaction(ReadOnlyTransaction):
118
 
    """A write transaction
119
 
 
120
 
    - caches domain objects
121
 
    - clean objects can be removed from the cache
122
 
    - dirty objects are retained.
123
 
    """
124
 
 
125
 
    def finish(self):
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:
130
 
                callback()
131
 
 
132
 
    def __init__(self):
133
 
        super(WriteTransaction, self).__init__()
134
 
        self._dirty_objects = set()
135
 
 
136
 
    def is_dirty(self, an_object):
137
 
        """Return True if an_object is dirty."""
138
 
        return (an_object in self._dirty_objects)
139
 
 
140
 
    def register_dirty(self, an_object):
141
 
        """Register an_object as being dirty.
142
 
 
143
 
        Dirty objects are not ejected from the identity map
144
 
        until the transaction finishes and get informed
145
 
        when the transaction finishes.
146
 
        """
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)]
151
 
        self._trim()
152
 
 
153
 
    def writeable(self):
154
 
        """Write transactions allow writes."""
155
 
        return True
156
 
 
157
 
 
 
123
 
 
124
        
158
125
class PassThroughTransaction(object):
159
126
    """A pass through transaction
160
 
 
161
 
    - nothing is cached.
162
 
    - nothing ever gets into the identity map.
 
127
    
 
128
    - all actions are committed immediately.
 
129
    - rollback is not supported.
 
130
    - commit() is a no-op.
163
131
    """
164
132
 
 
133
    def commit(self):
 
134
        """PassThroughTransactions have nothing to do."""
 
135
 
165
136
    def finish(self):
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:
170
 
                callback()
 
137
        """Clean up this transaction
 
138
 
 
139
        This will rollback on transactions that can if they have nto been
 
140
        committed.
 
141
        """
171
142
 
172
143
    def __init__(self):
173
144
        super(PassThroughTransaction, self).__init__()
174
145
        self.map = NullIdentityMap()
175
 
        self._dirty_objects = set()
176
146
 
177
147
    def register_clean(self, an_object, precious=False):
178
148
        """Register an_object as being clean.
179
 
 
 
149
        
180
150
        Note that precious is only a hint, and PassThroughTransaction
181
151
        ignores it.
182
152
        """
183
153
 
184
154
    def register_dirty(self, an_object):
185
 
        """Register an_object as being dirty.
 
155
        """Register an_object as being dirty."""
186
156
 
187
 
        Dirty objects get informed
188
 
        when the transaction finishes.
189
 
        """
190
 
        self._dirty_objects.add(an_object)
 
157
    def rollback(self):
 
158
        """Cannot rollback a pass through transaction."""
 
159
        raise errors.AlreadyCommitted
191
160
 
192
161
    def set_cache_size(self, ignored):
193
162
        """Do nothing, we are passing through."""
194
 
 
195
 
    def writeable(self):
196
 
        """Pass through transactions allow writes."""
197
 
        return True