/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: Ian Clatworthy
  • Date: 2008-04-17 08:21:14 UTC
  • mto: (4171.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 4173.
  • Revision ID: ian.clatworthy@canonical.com-20080417082114-76imbiarcbj16ov3
first cut at working tree content filtering

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/hashcache.py
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
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
 
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 
 
20
# it preserves the nice property that any caller will always get up-to-date
 
21
# data except in unavoidable cases.
 
22
 
 
23
# TODO: Perhaps return more details on the file to avoid statting it
 
24
# again: nonexistent, file type, size, etc
 
25
 
 
26
# TODO: Perhaps use a Python pickle instead of a text file; might be faster.
 
27
 
 
28
 
 
29
 
 
30
CACHE_HEADER = "### bzr hashcache v5\n"
 
31
 
 
32
import os, stat, time
 
33
import sha
 
34
 
 
35
from bzrlib.filters import sha_file_by_name
 
36
from bzrlib.osutils import pathjoin, safe_unicode
 
37
from bzrlib.trace import mutter, warning
 
38
from bzrlib.atomicfile import AtomicFile
 
39
from bzrlib.errors import BzrError
 
40
 
 
41
 
 
42
FP_MTIME_COLUMN = 1
 
43
FP_CTIME_COLUMN = 2
 
44
FP_MODE_COLUMN = 5
 
45
 
 
46
 
 
47
 
 
48
class HashCache(object):
 
49
    """Cache for looking up file SHA-1.
 
50
 
 
51
    Files are considered to match the cached value if the fingerprint
 
52
    of the file has not changed.  This includes its mtime, ctime,
 
53
    device number, inode number, and size.  This should catch
 
54
    modifications or replacement of the file by a new one.
 
55
 
 
56
    This may not catch modifications that do not change the file's
 
57
    size and that occur within the resolution window of the
 
58
    timestamps.  To handle this we specifically do not cache files
 
59
    which have changed since the start of the present second, since
 
60
    they could undetectably change again.
 
61
 
 
62
    This scheme may fail if the machine's clock steps backwards.
 
63
    Don't do that.
 
64
 
 
65
    This does not canonicalize the paths passed in; that should be
 
66
    done by the caller.
 
67
 
 
68
    _cache
 
69
        Indexed by path, points to a two-tuple of the SHA-1 of the file.
 
70
        and its fingerprint.
 
71
 
 
72
    stat_count
 
73
        number of times files have been statted
 
74
 
 
75
    hit_count
 
76
        number of times files have been retrieved from the cache, avoiding a
 
77
        re-read
 
78
        
 
79
    miss_count
 
80
        number of misses (times files have been completely re-read)
 
81
    """
 
82
    needs_write = False
 
83
 
 
84
    def __init__(self, root, cache_file_name, mode=None):
 
85
        """Create a hash cache in base dir, and set the file mode to mode."""
 
86
        self.root = safe_unicode(root)
 
87
        self.root_utf8 = self.root.encode('utf8') # where is the filesystem encoding ?
 
88
        self.hit_count = 0
 
89
        self.miss_count = 0
 
90
        self.stat_count = 0
 
91
        self.danger_count = 0
 
92
        self.removed_count = 0
 
93
        self.update_count = 0
 
94
        self._cache = {}
 
95
        self._mode = mode
 
96
        self._cache_file_name = safe_unicode(cache_file_name)
 
97
 
 
98
    def cache_file_name(self):
 
99
        return self._cache_file_name
 
100
 
 
101
    def clear(self):
 
102
        """Discard all cached information.
 
103
 
 
104
        This does not reset the counters."""
 
105
        if self._cache:
 
106
            self.needs_write = True
 
107
            self._cache = {}
 
108
 
 
109
    def scan(self):
 
110
        """Scan all files and remove entries where the cache entry is obsolete.
 
111
        
 
112
        Obsolete entries are those where the file has been modified or deleted
 
113
        since the entry was inserted.        
 
114
        """
 
115
        # FIXME optimisation opportunity, on linux [and check other oses]:
 
116
        # rather than iteritems order, stat in inode order.
 
117
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
 
118
        prep.sort()
 
119
        
 
120
        for inum, path, cache_entry in prep:
 
121
            abspath = pathjoin(self.root, path)
 
122
            fp = self._fingerprint(abspath)
 
123
            self.stat_count += 1
 
124
            
 
125
            cache_fp = cache_entry[1]
 
126
    
 
127
            if (not fp) or (cache_fp != fp):
 
128
                # not here or not a regular file anymore
 
129
                self.removed_count += 1
 
130
                self.needs_write = True
 
131
                del self._cache[path]
 
132
 
 
133
    def get_sha1(self, path, stat_value=None):
 
134
        """Return the sha1 of a file.
 
135
        """
 
136
        if path.__class__ is str:
 
137
            abspath = pathjoin(self.root_utf8, path)
 
138
        else:
 
139
            abspath = pathjoin(self.root, path)
 
140
        self.stat_count += 1
 
141
        file_fp = self._fingerprint(abspath, stat_value)
 
142
        
 
143
        if not file_fp:
 
144
            # not a regular file or not existing
 
145
            if path in self._cache:
 
146
                self.removed_count += 1
 
147
                self.needs_write = True
 
148
                del self._cache[path]
 
149
            return None        
 
150
 
 
151
        if path in self._cache:
 
152
            cache_sha1, cache_fp = self._cache[path]
 
153
        else:
 
154
            cache_sha1, cache_fp = None, None
 
155
 
 
156
        if cache_fp == file_fp:
 
157
            ## mutter("hashcache hit for %s %r -> %s", path, file_fp, cache_sha1)
 
158
            ## mutter("now = %s", time.time())
 
159
            self.hit_count += 1
 
160
            return cache_sha1
 
161
        
 
162
        self.miss_count += 1
 
163
 
 
164
        mode = file_fp[FP_MODE_COLUMN]
 
165
        if stat.S_ISREG(mode):
 
166
            digest = self._really_sha1_file(abspath)
 
167
        elif stat.S_ISLNK(mode):
 
168
            digest = sha.new(os.readlink(abspath)).hexdigest()
 
169
        else:
 
170
            raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
 
171
 
 
172
        # window of 3 seconds to allow for 2s resolution on windows,
 
173
        # unsynchronized file servers, etc.
 
174
        cutoff = self._cutoff_time()
 
175
        if file_fp[FP_MTIME_COLUMN] >= cutoff \
 
176
                or file_fp[FP_CTIME_COLUMN] >= cutoff:
 
177
            # changed too recently; can't be cached.  we can
 
178
            # return the result and it could possibly be cached
 
179
            # next time.
 
180
            #
 
181
            # the point is that we only want to cache when we are sure that any
 
182
            # subsequent modifications of the file can be detected.  If a
 
183
            # modification neither changes the inode, the device, the size, nor
 
184
            # the mode, then we can only distinguish it by time; therefore we
 
185
            # need to let sufficient time elapse before we may cache this entry
 
186
            # again.  If we didn't do this, then, for example, a very quick 1
 
187
            # byte replacement in the file might go undetected.
 
188
            ## mutter('%r modified too recently; not caching', path)
 
189
            self.danger_count += 1
 
190
            if cache_fp:
 
191
                self.removed_count += 1
 
192
                self.needs_write = True
 
193
                del self._cache[path]
 
194
        else:
 
195
            ## mutter('%r added to cache: now=%f, mtime=%d, ctime=%d',
 
196
            ##        path, time.time(), file_fp[FP_MTIME_COLUMN],
 
197
            ##        file_fp[FP_CTIME_COLUMN])
 
198
            self.update_count += 1
 
199
            self.needs_write = True
 
200
            self._cache[path] = (digest, file_fp)
 
201
        return digest
 
202
 
 
203
    def _really_sha1_file(self, abspath):
 
204
        """Calculate the SHA1 of a file by reading the full text"""
 
205
        return sha_file_by_name(abspath)
 
206
        
 
207
    def write(self):
 
208
        """Write contents of cache to file."""
 
209
        outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
 
210
        try:
 
211
            outf.write(CACHE_HEADER)
 
212
 
 
213
            for path, c  in self._cache.iteritems():
 
214
                assert '//' not in path, path
 
215
                line_info = [path.encode('utf-8'), '// ', c[0], ' ']
 
216
                line_info.append(' '.join([str(fld) for fld in c[1]]))
 
217
                line_info.append('\n')
 
218
                outf.write(''.join(line_info))
 
219
            outf.commit()
 
220
            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)
 
225
        finally:
 
226
            outf.close()
 
227
 
 
228
    def read(self):
 
229
        """Reinstate cache from file.
 
230
 
 
231
        Overwrites existing cache.
 
232
 
 
233
        If the cache file has the wrong version marker, this just clears 
 
234
        the cache."""
 
235
        self._cache = {}
 
236
 
 
237
        fn = self.cache_file_name()
 
238
        try:
 
239
            inf = file(fn, 'rb', buffering=65000)
 
240
        except IOError, e:
 
241
            mutter("failed to open %s: %s", fn, e)
 
242
            # better write it now so it is valid
 
243
            self.needs_write = True
 
244
            return
 
245
 
 
246
        hdr = inf.readline()
 
247
        if hdr != CACHE_HEADER:
 
248
            mutter('cache header marker not found at top of %s;'
 
249
                   ' discarding cache', fn)
 
250
            self.needs_write = True
 
251
            return
 
252
 
 
253
        for l in inf:
 
254
            pos = l.index('// ')
 
255
            path = l[:pos].decode('utf-8')
 
256
            if path in self._cache:
 
257
                warning('duplicated path %r in cache' % path)
 
258
                continue
 
259
 
 
260
            pos += 3
 
261
            fields = l[pos:].split(' ')
 
262
            if len(fields) != 7:
 
263
                warning("bad line in hashcache: %r" % l)
 
264
                continue
 
265
 
 
266
            sha1 = fields[0]
 
267
            if len(sha1) != 40:
 
268
                warning("bad sha1 in hashcache: %r" % sha1)
 
269
                continue
 
270
 
 
271
            fp = tuple(map(long, fields[1:]))
 
272
 
 
273
            self._cache[path] = (sha1, fp)
 
274
 
 
275
        self.needs_write = False
 
276
 
 
277
    def _cutoff_time(self):
 
278
        """Return cutoff time.
 
279
 
 
280
        Files modified more recently than this time are at risk of being
 
281
        undetectably modified and so can't be cached.
 
282
        """
 
283
        return int(time.time()) - 3
 
284
           
 
285
    def _fingerprint(self, abspath, stat_value=None):
 
286
        if stat_value is None:
 
287
            try:
 
288
                stat_value = os.lstat(abspath)
 
289
            except OSError:
 
290
                # might be missing, etc
 
291
                return None
 
292
        if stat.S_ISDIR(stat_value.st_mode):
 
293
            return None
 
294
        # we discard any high precision because it's not reliable; perhaps we
 
295
        # could do better on some systems?
 
296
        return (stat_value.st_size, long(stat_value.st_mtime),
 
297
                long(stat_value.st_ctime), stat_value.st_ino, 
 
298
                stat_value.st_dev, stat_value.st_mode)