← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transactions.py

  • Committer: Andrew Bennetts
  • Date: 2009-06-16 08:06:58 UTC
  • mto: This revision was merged to the branch mainline in revision 4446.
  • Revision ID: andrew.bennetts@canonical.com-20090616080658-ej18m1u773k55tsc
Fix test failures in test_lookup_revision_id_by_dotted.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transactions.py
 
1
# Copyright (C) 2005 Canonical Ltd
 
2
#   Authors: Robert Collins <robert.collins@canonical.com>
 
3
#
 
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.
 
8
#
 
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.
 
13
#
 
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
17
 
 
18
"""This module provides a transactional facility.
 
19
 
 
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. 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.
 
25
 
 
26
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.
 
37
"""
 
38
 
 
39
import sys
 
40
 
 
41
import bzrlib.errors as errors
 
42
from bzrlib.identitymap import IdentityMap, NullIdentityMap
 
43
from bzrlib.trace import mutter
 
44
 
 
45
 
 
46
class ReadOnlyTransaction(object):
 
47
    """A read only unit of work for data objects."""
 
48
 
 
49
    def finish(self):
 
50
        """Clean up this transaction."""
 
51
 
 
52
    def __init__(self):
 
53
        super(ReadOnlyTransaction, self).__init__()
 
54
        self.map = IdentityMap()
 
55
        self._clean_objects = set()
 
56
        self._clean_queue = []
 
57
        self._limit = -1
 
58
        self._precious_objects = set()
 
59
 
 
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
    def register_clean(self, an_object, precious=False):
 
65
        """Register an_object as being clean.
 
66
 
 
67
        If the precious hint is True, the object will not
 
68
        be ejected from the object identity map ever.
 
69
        """
 
70
        self._clean_objects.add(an_object)
 
71
        self._clean_queue.append(an_object)
 
72
        if precious:
 
73
            self._precious_objects.add(an_object)
 
74
        self._trim()
 
75
 
 
76
    def register_dirty(self, an_object):
 
77
        """Register an_object as being dirty."""
 
78
        raise errors.ReadOnlyObjectDirtiedError(an_object)
 
79
 
 
80
    def set_cache_size(self, size):
 
81
        """Set a new cache size."""
 
82
        if size < -1:
 
83
            raise ValueError(size)
 
84
        self._limit = size
 
85
        self._trim()
 
86
 
 
87
    def _trim(self):
 
88
        """Trim the cache back if needed."""
 
89
        if self._limit < 0 or self._limit - len(self._clean_objects) > 0:
 
90
            return
 
91
        needed = len(self._clean_objects) - self._limit
 
92
        offset = 0
 
93
        while needed and offset < len(self._clean_objects):
 
94
            # references we know of:
 
95
            # temp passed to getrefcount in our frame
 
96
            # temp in getrefcount's frame
 
97
            # the map forward
 
98
            # the map backwards
 
99
            # _clean_objects
 
100
            # _clean_queue
 
101
            # 1 missing ?
 
102
            if (sys.getrefcount(self._clean_queue[offset]) <= 7 and
 
103
                not self._clean_queue[offset] in self._precious_objects):
 
104
                removed = self._clean_queue[offset]
 
105
                self._clean_objects.remove(removed)
 
106
                del self._clean_queue[offset]
 
107
                self.map.remove_object(removed)
 
108
                mutter('removed object %r', removed)
 
109
                needed -= 1
 
110
            else:
 
111
                offset += 1
 
112
 
 
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
 
 
158
class PassThroughTransaction(object):
 
159
    """A pass through transaction
 
160
 
 
161
    - nothing is cached.
 
162
    - nothing ever gets into the identity map.
 
163
    """
 
164
 
 
165
    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()
 
171
 
 
172
    def __init__(self):
 
173
        super(PassThroughTransaction, self).__init__()
 
174
        self.map = NullIdentityMap()
 
175
        self._dirty_objects = set()
 
176
 
 
177
    def register_clean(self, an_object, precious=False):
 
178
        """Register an_object as being clean.
 
179
 
 
180
        Note that precious is only a hint, and PassThroughTransaction
 
181
        ignores it.
 
182
        """
 
183
 
 
184
    def register_dirty(self, an_object):
 
185
        """Register an_object as being dirty.
 
186
 
 
187
        Dirty objects get informed
 
188
        when the transaction finishes.
 
189
        """
 
190
        self._dirty_objects.add(an_object)
 
191
 
 
192
    def set_cache_size(self, ignored):
 
193
        """Do nothing, we are passing through."""
 
194
 
 
195
    def writeable(self):
 
196
        """Pass through transactions allow writes."""
 
197
        return True