← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

  • Committer: Robert Collins
  • Date: 2005-09-29 00:24:44 UTC
  • Revision ID: robertc@robertcollins.net-20050929002444-76fe66e99fb9bcd5
reinstate testfetch test case

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/hashcache.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
2
 
#
 
1
# (C) 2005 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
 
29
29
 
30
30
CACHE_HEADER = "### bzr hashcache v5\n"
31
31
 
32
 
import os
33
 
import stat
34
 
import time
35
 
 
36
 
from bzrlib import (
37
 
    atomicfile,
38
 
    errors,
39
 
    filters as _mod_filters,
40
 
    osutils,
41
 
    trace,
42
 
    )
43
 
 
44
 
 
45
 
FP_MTIME_COLUMN = 1
46
 
FP_CTIME_COLUMN = 2
47
 
FP_MODE_COLUMN = 5
48
 
 
 
32
import os, stat, time
 
33
 
 
34
from bzrlib.osutils import sha_file
 
35
from bzrlib.trace import mutter, warning
 
36
from bzrlib.atomicfile import AtomicFile
 
37
 
 
38
 
 
39
 
 
40
 
 
41
def _fingerprint(abspath):
 
42
    try:
 
43
        fs = os.lstat(abspath)
 
44
    except OSError:
 
45
        # might be missing, etc
 
46
        return None
 
47
 
 
48
    if stat.S_ISDIR(fs.st_mode):
 
49
        return None
 
50
 
 
51
    # we discard any high precision because it's not reliable; perhaps we
 
52
    # could do better on some systems?
 
53
    return (fs.st_size, long(fs.st_mtime),
 
54
            long(fs.st_ctime), fs.st_ino, fs.st_dev)
49
55
 
50
56
 
51
57
class HashCache(object):
78
84
    hit_count
79
85
        number of times files have been retrieved from the cache, avoiding a
80
86
        re-read
81
 
 
 
87
        
82
88
    miss_count
83
89
        number of misses (times files have been completely re-read)
84
90
    """
85
91
    needs_write = False
86
92
 
87
 
    def __init__(self, root, cache_file_name, mode=None,
88
 
            content_filter_stack_provider=None):
89
 
        """Create a hash cache in base dir, and set the file mode to mode.
90
 
 
91
 
        :param content_filter_stack_provider: a function that takes a
92
 
            path (relative to the top of the tree) and a file-id as
93
 
            parameters and returns a stack of ContentFilters.
94
 
            If None, no content filtering is performed.
95
 
        """
96
 
        self.root = osutils.safe_unicode(root)
97
 
        self.root_utf8 = self.root.encode('utf8') # where is the filesystem encoding ?
 
93
    def __init__(self, basedir):
 
94
        self.basedir = basedir
98
95
        self.hit_count = 0
99
96
        self.miss_count = 0
100
97
        self.stat_count = 0
102
99
        self.removed_count = 0
103
100
        self.update_count = 0
104
101
        self._cache = {}
105
 
        self._mode = mode
106
 
        self._cache_file_name = osutils.safe_unicode(cache_file_name)
107
 
        self._filter_provider = content_filter_stack_provider
 
102
 
108
103
 
109
104
    def cache_file_name(self):
110
 
        return self._cache_file_name
 
105
        return os.sep.join([self.basedir, '.bzr', 'stat-cache'])
 
106
 
 
107
 
 
108
 
111
109
 
112
110
    def clear(self):
113
111
        """Discard all cached information.
117
115
            self.needs_write = True
118
116
            self._cache = {}
119
117
 
 
118
 
120
119
    def scan(self):
121
120
        """Scan all files and remove entries where the cache entry is obsolete.
122
 
 
 
121
        
123
122
        Obsolete entries are those where the file has been modified or deleted
124
 
        since the entry was inserted.
 
123
        since the entry was inserted.        
125
124
        """
126
 
        # FIXME optimisation opportunity, on linux [and check other oses]:
127
 
        # rather than iteritems order, stat in inode order.
128
125
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
129
126
        prep.sort()
130
 
 
 
127
        
131
128
        for inum, path, cache_entry in prep:
132
 
            abspath = osutils.pathjoin(self.root, path)
133
 
            fp = self._fingerprint(abspath)
 
129
            abspath = os.sep.join([self.basedir, path])
 
130
            fp = _fingerprint(abspath)
134
131
            self.stat_count += 1
135
 
 
 
132
            
136
133
            cache_fp = cache_entry[1]
137
 
 
 
134
    
138
135
            if (not fp) or (cache_fp != fp):
139
136
                # not here or not a regular file anymore
140
137
                self.removed_count += 1
141
138
                self.needs_write = True
142
139
                del self._cache[path]
143
140
 
144
 
    def get_sha1(self, path, stat_value=None):
 
141
 
 
142
    def get_sha1(self, path):
145
143
        """Return the sha1 of a file.
146
144
        """
147
 
        if path.__class__ is str:
148
 
            abspath = osutils.pathjoin(self.root_utf8, path)
149
 
        else:
150
 
            abspath = osutils.pathjoin(self.root, path)
 
145
        abspath = os.sep.join([self.basedir, path])
151
146
        self.stat_count += 1
152
 
        file_fp = self._fingerprint(abspath, stat_value)
153
 
 
 
147
        file_fp = _fingerprint(abspath)
 
148
        
154
149
        if not file_fp:
155
150
            # not a regular file or not existing
156
151
            if path in self._cache:
157
152
                self.removed_count += 1
158
153
                self.needs_write = True
159
154
                del self._cache[path]
160
 
            return None
 
155
            return None        
161
156
 
162
157
        if path in self._cache:
163
158
            cache_sha1, cache_fp = self._cache[path]
165
160
            cache_sha1, cache_fp = None, None
166
161
 
167
162
        if cache_fp == file_fp:
168
 
            ## mutter("hashcache hit for %s %r -> %s", path, file_fp, cache_sha1)
169
 
            ## mutter("now = %s", time.time())
170
163
            self.hit_count += 1
171
164
            return cache_sha1
172
 
 
 
165
        
173
166
        self.miss_count += 1
174
 
 
175
 
        mode = file_fp[FP_MODE_COLUMN]
176
 
        if stat.S_ISREG(mode):
177
 
            if self._filter_provider is None:
178
 
                filters = []
179
 
            else:
180
 
                filters = self._filter_provider(path=path, file_id=None)
181
 
            digest = self._really_sha1_file(abspath, filters)
182
 
        elif stat.S_ISLNK(mode):
183
 
            target = osutils.readlink(osutils.safe_unicode(abspath))
184
 
            digest = osutils.sha_string(target.encode('UTF-8'))
185
 
        else:
186
 
            raise errors.BzrError("file %r: unknown file stat mode: %o"
187
 
                                  % (abspath, mode))
188
 
 
189
 
        # window of 3 seconds to allow for 2s resolution on windows,
190
 
        # unsynchronized file servers, etc.
191
 
        cutoff = self._cutoff_time()
192
 
        if file_fp[FP_MTIME_COLUMN] >= cutoff \
193
 
                or file_fp[FP_CTIME_COLUMN] >= cutoff:
 
167
        digest = sha_file(file(abspath, 'rb', buffering=65000))
 
168
 
 
169
        now = int(time.time())
 
170
        if file_fp[1] >= now or file_fp[2] >= now:
194
171
            # changed too recently; can't be cached.  we can
195
172
            # return the result and it could possibly be cached
196
173
            # next time.
197
 
            #
198
 
            # the point is that we only want to cache when we are sure that any
199
 
            # subsequent modifications of the file can be detected.  If a
200
 
            # modification neither changes the inode, the device, the size, nor
201
 
            # the mode, then we can only distinguish it by time; therefore we
202
 
            # need to let sufficient time elapse before we may cache this entry
203
 
            # again.  If we didn't do this, then, for example, a very quick 1
204
 
            # byte replacement in the file might go undetected.
205
 
            ## mutter('%r modified too recently; not caching', path)
206
 
            self.danger_count += 1
 
174
            self.danger_count += 1 
207
175
            if cache_fp:
208
176
                self.removed_count += 1
209
177
                self.needs_write = True
210
178
                del self._cache[path]
211
179
        else:
212
 
            ## mutter('%r added to cache: now=%f, mtime=%d, ctime=%d',
213
 
            ##        path, time.time(), file_fp[FP_MTIME_COLUMN],
214
 
            ##        file_fp[FP_CTIME_COLUMN])
215
180
            self.update_count += 1
216
181
            self.needs_write = True
217
182
            self._cache[path] = (digest, file_fp)
 
183
        
218
184
        return digest
219
 
 
220
 
    def _really_sha1_file(self, abspath, filters):
221
 
        """Calculate the SHA1 of a file by reading the full text"""
222
 
        return _mod_filters.internal_size_sha_file_byname(abspath, filters)[1]
 
185
        
 
186
 
 
187
 
223
188
 
224
189
    def write(self):
225
190
        """Write contents of cache to file."""
226
 
        outf = atomicfile.AtomicFile(self.cache_file_name(), 'wb',
227
 
                                     new_mode=self._mode)
 
191
        outf = AtomicFile(self.cache_file_name(), 'wb')
228
192
        try:
229
 
            outf.write(CACHE_HEADER)
 
193
            print >>outf, CACHE_HEADER,
230
194
 
231
195
            for path, c  in self._cache.iteritems():
232
 
                line_info = [path.encode('utf-8'), '// ', c[0], ' ']
233
 
                line_info.append(' '.join([str(fld) for fld in c[1]]))
234
 
                line_info.append('\n')
235
 
                outf.write(''.join(line_info))
 
196
                assert '//' not in path, path
 
197
                outf.write(path.encode('utf-8'))
 
198
                outf.write('// ')
 
199
                print >>outf, c[0],     # hex sha1
 
200
                for fld in c[1]:
 
201
                    print >>outf, "%d" % fld,
 
202
                print >>outf
 
203
 
236
204
            outf.commit()
237
205
            self.needs_write = False
238
 
            ## mutter("write hash cache: %s hits=%d misses=%d stat=%d recent=%d updates=%d",
239
 
            ##        self.cache_file_name(), self.hit_count, self.miss_count,
240
 
            ##        self.stat_count,
241
 
            ##        self.danger_count, self.update_count)
242
206
        finally:
243
 
            outf.close()
 
207
            if not outf.closed:
 
208
                outf.abort()
 
209
        
 
210
 
244
211
 
245
212
    def read(self):
246
213
        """Reinstate cache from file.
247
214
 
248
215
        Overwrites existing cache.
249
216
 
250
 
        If the cache file has the wrong version marker, this just clears
 
217
        If the cache file has the wrong version marker, this just clears 
251
218
        the cache."""
252
219
        self._cache = {}
253
220
 
255
222
        try:
256
223
            inf = file(fn, 'rb', buffering=65000)
257
224
        except IOError, e:
258
 
            trace.mutter("failed to open %s: %s", fn, e)
 
225
            mutter("failed to open %s: %s" % (fn, e))
259
226
            # better write it now so it is valid
260
227
            self.needs_write = True
261
228
            return
262
229
 
 
230
 
263
231
        hdr = inf.readline()
264
232
        if hdr != CACHE_HEADER:
265
 
            trace.mutter('cache header marker not found at top of %s;'
266
 
                         ' discarding cache', fn)
 
233
            mutter('cache header marker not found at top of %s; discarding cache'
 
234
                   % fn)
267
235
            self.needs_write = True
268
236
            return
269
237
 
271
239
            pos = l.index('// ')
272
240
            path = l[:pos].decode('utf-8')
273
241
            if path in self._cache:
274
 
                trace.warning('duplicated path %r in cache' % path)
 
242
                warning('duplicated path %r in cache' % path)
275
243
                continue
276
244
 
277
245
            pos += 3
278
246
            fields = l[pos:].split(' ')
279
 
            if len(fields) != 7:
280
 
                trace.warning("bad line in hashcache: %r" % l)
 
247
            if len(fields) != 6:
 
248
                warning("bad line in hashcache: %r" % l)
281
249
                continue
282
250
 
283
251
            sha1 = fields[0]
284
252
            if len(sha1) != 40:
285
 
                trace.warning("bad sha1 in hashcache: %r" % sha1)
 
253
                warning("bad sha1 in hashcache: %r" % sha1)
286
254
                continue
287
255
 
288
256
            fp = tuple(map(long, fields[1:]))
289
257
 
290
258
            self._cache[path] = (sha1, fp)
291
259
 
292
 
        # GZ 2009-09-20: Should really use a try/finally block to ensure close
293
 
        inf.close()
294
 
 
295
260
        self.needs_write = False
296
 
 
297
 
    def _cutoff_time(self):
298
 
        """Return cutoff time.
299
 
 
300
 
        Files modified more recently than this time are at risk of being
301
 
        undetectably modified and so can't be cached.
302
 
        """
303
 
        return int(time.time()) - 3
304
 
 
305
 
    def _fingerprint(self, abspath, stat_value=None):
306
 
        if stat_value is None:
307
 
            try:
308
 
                stat_value = os.lstat(abspath)
309
 
            except OSError:
310
 
                # might be missing, etc
311
 
                return None
312
 
        if stat.S_ISDIR(stat_value.st_mode):
313
 
            return None
314
 
        # we discard any high precision because it's not reliable; perhaps we
315
 
        # could do better on some systems?
316
 
        return (stat_value.st_size, long(stat_value.st_mtime),
317
 
                long(stat_value.st_ctime), stat_value.st_ino,
318
 
                stat_value.st_dev, stat_value.st_mode)
 
261
           
 
262
 
 
263
 
 
264