/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-04-01 15:14:38 UTC
  • mfrom: (4202.3.2 bzr-send-tweak)
  • Revision ID: pqm@pqm.ubuntu.com-20090401151438-hqulqoazddtacbls
(andrew) Don't use get_revision_xml when writing a bundle,
        instead get all the revisions together.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/hashcache.py
1
 
# Copyright (C) 2005, 2006 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
# TODO: Up-front, stat all files in order and remove those which are deleted or 
18
 
# out-of-date.  Don't actually re-read them until they're needed.  That ought 
19
 
# to bring all the inodes into core so that future stats to them are fast, and 
 
17
# TODO: Up-front, stat all files in order and remove those which are deleted or
 
18
# out-of-date.  Don't actually re-read them until they're needed.  That ought
 
19
# to bring all the inodes into core so that future stats to them are fast, and
20
20
# it preserves the nice property that any caller will always get up-to-date
21
21
# data except in unavoidable cases.
22
22
 
30
30
CACHE_HEADER = "### bzr hashcache v5\n"
31
31
 
32
32
import os, stat, time
33
 
import sha
34
33
 
35
 
from bzrlib.osutils import sha_file, pathjoin, safe_unicode
 
34
from bzrlib.filters import internal_size_sha_file_byname
 
35
from bzrlib.osutils import sha_file, sha_string, pathjoin, safe_unicode
36
36
from bzrlib.trace import mutter, warning
37
37
from bzrlib.atomicfile import AtomicFile
38
38
from bzrlib.errors import BzrError
42
42
FP_CTIME_COLUMN = 2
43
43
FP_MODE_COLUMN = 5
44
44
 
45
 
def _fingerprint(abspath):
46
 
    try:
47
 
        fs = os.lstat(abspath)
48
 
    except OSError:
49
 
        # might be missing, etc
50
 
        return None
51
 
 
52
 
    if stat.S_ISDIR(fs.st_mode):
53
 
        return None
54
 
 
55
 
    # we discard any high precision because it's not reliable; perhaps we
56
 
    # could do better on some systems?
57
 
    return (fs.st_size, long(fs.st_mtime),
58
 
            long(fs.st_ctime), fs.st_ino, fs.st_dev, fs.st_mode)
59
45
 
60
46
 
61
47
class HashCache(object):
88
74
    hit_count
89
75
        number of times files have been retrieved from the cache, avoiding a
90
76
        re-read
91
 
        
 
77
 
92
78
    miss_count
93
79
        number of misses (times files have been completely re-read)
94
80
    """
95
81
    needs_write = False
96
82
 
97
 
    def __init__(self, root, cache_file_name, mode=None):
98
 
        """Create a hash cache in base dir, and set the file mode to mode."""
 
83
    def __init__(self, root, cache_file_name, mode=None,
 
84
            content_filter_stack_provider=None):
 
85
        """Create a hash cache in base dir, and set the file mode to mode.
 
86
 
 
87
        :param content_filter_stack_provider: a function that takes a
 
88
            path (relative to the top of the tree) and a file-id as
 
89
            parameters and returns a stack of ContentFilters.
 
90
            If None, no content filtering is performed.
 
91
        """
99
92
        self.root = safe_unicode(root)
 
93
        self.root_utf8 = self.root.encode('utf8') # where is the filesystem encoding ?
100
94
        self.hit_count = 0
101
95
        self.miss_count = 0
102
96
        self.stat_count = 0
106
100
        self._cache = {}
107
101
        self._mode = mode
108
102
        self._cache_file_name = safe_unicode(cache_file_name)
 
103
        self._filter_provider = content_filter_stack_provider
109
104
 
110
105
    def cache_file_name(self):
111
106
        return self._cache_file_name
120
115
 
121
116
    def scan(self):
122
117
        """Scan all files and remove entries where the cache entry is obsolete.
123
 
        
 
118
 
124
119
        Obsolete entries are those where the file has been modified or deleted
125
 
        since the entry was inserted.        
 
120
        since the entry was inserted.
126
121
        """
127
122
        # FIXME optimisation opportunity, on linux [and check other oses]:
128
123
        # rather than iteritems order, stat in inode order.
129
124
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
130
125
        prep.sort()
131
 
        
 
126
 
132
127
        for inum, path, cache_entry in prep:
133
128
            abspath = pathjoin(self.root, path)
134
 
            fp = _fingerprint(abspath)
 
129
            fp = self._fingerprint(abspath)
135
130
            self.stat_count += 1
136
 
            
 
131
 
137
132
            cache_fp = cache_entry[1]
138
 
    
 
133
 
139
134
            if (not fp) or (cache_fp != fp):
140
135
                # not here or not a regular file anymore
141
136
                self.removed_count += 1
142
137
                self.needs_write = True
143
138
                del self._cache[path]
144
139
 
145
 
 
146
 
    def get_sha1(self, path):
 
140
    def get_sha1(self, path, stat_value=None):
147
141
        """Return the sha1 of a file.
148
142
        """
149
 
        abspath = pathjoin(self.root, path)
 
143
        if path.__class__ is str:
 
144
            abspath = pathjoin(self.root_utf8, path)
 
145
        else:
 
146
            abspath = pathjoin(self.root, path)
150
147
        self.stat_count += 1
151
 
        file_fp = _fingerprint(abspath)
152
 
        
 
148
        file_fp = self._fingerprint(abspath, stat_value)
 
149
 
153
150
        if not file_fp:
154
151
            # not a regular file or not existing
155
152
            if path in self._cache:
156
153
                self.removed_count += 1
157
154
                self.needs_write = True
158
155
                del self._cache[path]
159
 
            return None        
 
156
            return None
160
157
 
161
158
        if path in self._cache:
162
159
            cache_sha1, cache_fp = self._cache[path]
164
161
            cache_sha1, cache_fp = None, None
165
162
 
166
163
        if cache_fp == file_fp:
 
164
            ## mutter("hashcache hit for %s %r -> %s", path, file_fp, cache_sha1)
 
165
            ## mutter("now = %s", time.time())
167
166
            self.hit_count += 1
168
167
            return cache_sha1
169
 
        
 
168
 
170
169
        self.miss_count += 1
171
170
 
172
 
 
173
171
        mode = file_fp[FP_MODE_COLUMN]
174
172
        if stat.S_ISREG(mode):
175
 
            digest = sha_file(file(abspath, 'rb', buffering=65000))
 
173
            if self._filter_provider is None:
 
174
                filters = []
 
175
            else:
 
176
                filters = self._filter_provider(path=path, file_id=None)
 
177
            digest = self._really_sha1_file(abspath, filters)
176
178
        elif stat.S_ISLNK(mode):
177
 
            digest = sha.new(os.readlink(abspath)).hexdigest()
 
179
            digest = sha_string(os.readlink(abspath))
178
180
        else:
179
181
            raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
180
182
 
181
 
        now = int(time.time())
182
 
        if file_fp[FP_MTIME_COLUMN] >= now or file_fp[FP_CTIME_COLUMN] >= now:
 
183
        # window of 3 seconds to allow for 2s resolution on windows,
 
184
        # unsynchronized file servers, etc.
 
185
        cutoff = self._cutoff_time()
 
186
        if file_fp[FP_MTIME_COLUMN] >= cutoff \
 
187
                or file_fp[FP_CTIME_COLUMN] >= cutoff:
183
188
            # changed too recently; can't be cached.  we can
184
189
            # return the result and it could possibly be cached
185
190
            # next time.
191
196
            # need to let sufficient time elapse before we may cache this entry
192
197
            # again.  If we didn't do this, then, for example, a very quick 1
193
198
            # byte replacement in the file might go undetected.
194
 
            self.danger_count += 1 
 
199
            ## mutter('%r modified too recently; not caching', path)
 
200
            self.danger_count += 1
195
201
            if cache_fp:
196
202
                self.removed_count += 1
197
203
                self.needs_write = True
198
204
                del self._cache[path]
199
205
        else:
 
206
            ## mutter('%r added to cache: now=%f, mtime=%d, ctime=%d',
 
207
            ##        path, time.time(), file_fp[FP_MTIME_COLUMN],
 
208
            ##        file_fp[FP_CTIME_COLUMN])
200
209
            self.update_count += 1
201
210
            self.needs_write = True
202
211
            self._cache[path] = (digest, file_fp)
203
212
        return digest
204
 
        
 
213
 
 
214
    def _really_sha1_file(self, abspath, filters):
 
215
        """Calculate the SHA1 of a file by reading the full text"""
 
216
        return internal_size_sha_file_byname(abspath, filters)[1]
 
217
 
205
218
    def write(self):
206
219
        """Write contents of cache to file."""
207
220
        outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
208
221
        try:
209
 
            print >>outf, CACHE_HEADER,
 
222
            outf.write(CACHE_HEADER)
210
223
 
211
224
            for path, c  in self._cache.iteritems():
212
 
                assert '//' not in path, path
213
 
                outf.write(path.encode('utf-8'))
214
 
                outf.write('// ')
215
 
                print >>outf, c[0],     # hex sha1
216
 
                for fld in c[1]:
217
 
                    print >>outf, "%d" % fld,
218
 
                print >>outf
 
225
                line_info = [path.encode('utf-8'), '// ', c[0], ' ']
 
226
                line_info.append(' '.join([str(fld) for fld in c[1]]))
 
227
                line_info.append('\n')
 
228
                outf.write(''.join(line_info))
219
229
            outf.commit()
220
230
            self.needs_write = False
221
 
            mutter("write hash cache: %s hits=%d misses=%d stat=%d recent=%d updates=%d",
222
 
                   self.cache_file_name(), self.hit_count, self.miss_count,
223
 
                   self.stat_count,
224
 
                   self.danger_count, self.update_count)
 
231
            ## mutter("write hash cache: %s hits=%d misses=%d stat=%d recent=%d updates=%d",
 
232
            ##        self.cache_file_name(), self.hit_count, self.miss_count,
 
233
            ##        self.stat_count,
 
234
            ##        self.danger_count, self.update_count)
225
235
        finally:
226
 
            if not outf.closed:
227
 
                outf.abort()
 
236
            outf.close()
228
237
 
229
238
    def read(self):
230
239
        """Reinstate cache from file.
231
240
 
232
241
        Overwrites existing cache.
233
242
 
234
 
        If the cache file has the wrong version marker, this just clears 
 
243
        If the cache file has the wrong version marker, this just clears
235
244
        the cache."""
236
245
        self._cache = {}
237
246
 
244
253
            self.needs_write = True
245
254
            return
246
255
 
247
 
 
248
256
        hdr = inf.readline()
249
257
        if hdr != CACHE_HEADER:
250
258
            mutter('cache header marker not found at top of %s;'
275
283
            self._cache[path] = (sha1, fp)
276
284
 
277
285
        self.needs_write = False
278
 
           
279
 
 
280
 
 
281
 
        
 
286
 
 
287
    def _cutoff_time(self):
 
288
        """Return cutoff time.
 
289
 
 
290
        Files modified more recently than this time are at risk of being
 
291
        undetectably modified and so can't be cached.
 
292
        """
 
293
        return int(time.time()) - 3
 
294
 
 
295
    def _fingerprint(self, abspath, stat_value=None):
 
296
        if stat_value is None:
 
297
            try:
 
298
                stat_value = os.lstat(abspath)
 
299
            except OSError:
 
300
                # might be missing, etc
 
301
                return None
 
302
        if stat.S_ISDIR(stat_value.st_mode):
 
303
            return None
 
304
        # we discard any high precision because it's not reliable; perhaps we
 
305
        # could do better on some systems?
 
306
        return (stat_value.st_size, long(stat_value.st_mtime),
 
307
                long(stat_value.st_ctime), stat_value.st_ino,
 
308
                stat_value.st_dev, stat_value.st_mode)