← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

doc

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/hashcache.py
1
 
# Copyright (C) 2005, 2006 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
 
32
import os, stat, time
 
33
import sha
 
34
 
 
35
from bzrlib.osutils import sha_file
 
36
from bzrlib.trace import mutter, warning
 
37
from bzrlib.atomicfile import AtomicFile
 
38
 
 
39
 
47
40
FP_MODE_COLUMN = 5
48
41
 
 
42
def _fingerprint(abspath):
 
43
    try:
 
44
        fs = os.lstat(abspath)
 
45
    except OSError:
 
46
        # might be missing, etc
 
47
        return None
 
48
 
 
49
    if stat.S_ISDIR(fs.st_mode):
 
50
        return None
 
51
 
 
52
    # we discard any high precision because it's not reliable; perhaps we
 
53
    # could do better on some systems?
 
54
    return (fs.st_size, long(fs.st_mtime),
 
55
            long(fs.st_ctime), fs.st_ino, fs.st_dev, fs.st_mode)
49
56
 
50
57
 
51
58
class HashCache(object):
78
85
    hit_count
79
86
        number of times files have been retrieved from the cache, avoiding a
80
87
        re-read
81
 
 
 
88
        
82
89
    miss_count
83
90
        number of misses (times files have been completely re-read)
84
91
    """
85
92
    needs_write = False
86
93
 
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 ?
 
94
    def __init__(self, basedir):
 
95
        self.basedir = basedir
98
96
        self.hit_count = 0
99
97
        self.miss_count = 0
100
98
        self.stat_count = 0
102
100
        self.removed_count = 0
103
101
        self.update_count = 0
104
102
        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
108
103
 
109
104
    def cache_file_name(self):
110
 
        return self._cache_file_name
 
105
        # FIXME: duplicate path logic here, this should be 
 
106
        # something like 'branch.controlfile'.
 
107
        return os.sep.join([self.basedir, '.bzr', 'stat-cache'])
111
108
 
112
109
    def clear(self):
113
110
        """Discard all cached information.
117
114
            self.needs_write = True
118
115
            self._cache = {}
119
116
 
 
117
 
120
118
    def scan(self):
121
119
        """Scan all files and remove entries where the cache entry is obsolete.
122
 
 
 
120
        
123
121
        Obsolete entries are those where the file has been modified or deleted
124
 
        since the entry was inserted.
 
122
        since the entry was inserted.        
125
123
        """
126
 
        # FIXME optimisation opportunity, on linux [and check other oses]:
127
 
        # rather than iteritems order, stat in inode order.
128
124
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
129
125
        prep.sort()
130
 
 
 
126
        
131
127
        for inum, path, cache_entry in prep:
132
 
            abspath = osutils.pathjoin(self.root, path)
133
 
            fp = self._fingerprint(abspath)
 
128
            abspath = os.sep.join([self.basedir, path])
 
129
            fp = _fingerprint(abspath)
134
130
            self.stat_count += 1
135
 
 
 
131
            
136
132
            cache_fp = cache_entry[1]
137
 
 
 
133
    
138
134
            if (not fp) or (cache_fp != fp):
139
135
                # not here or not a regular file anymore
140
136
                self.removed_count += 1
141
137
                self.needs_write = True
142
138
                del self._cache[path]
143
139
 
144
 
    def get_sha1(self, path, stat_value=None):
 
140
 
 
141
    def get_sha1(self, path):
145
142
        """Return the sha1 of a file.
146
143
        """
147
 
        if path.__class__ is str:
148
 
            abspath = osutils.pathjoin(self.root_utf8, path)
149
 
        else:
150
 
            abspath = osutils.pathjoin(self.root, path)
 
144
        abspath = os.sep.join([self.basedir, path])
151
145
        self.stat_count += 1
152
 
        file_fp = self._fingerprint(abspath, stat_value)
153
 
 
 
146
        file_fp = _fingerprint(abspath)
 
147
        
154
148
        if not file_fp:
155
149
            # not a regular file or not existing
156
150
            if path in self._cache:
157
151
                self.removed_count += 1
158
152
                self.needs_write = True
159
153
                del self._cache[path]
160
 
            return None
 
154
            return None        
161
155
 
162
156
        if path in self._cache:
163
157
            cache_sha1, cache_fp = self._cache[path]
165
159
            cache_sha1, cache_fp = None, None
166
160
 
167
161
        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
162
            self.hit_count += 1
171
163
            return cache_sha1
172
 
 
 
164
        
173
165
        self.miss_count += 1
174
166
 
 
167
 
175
168
        mode = file_fp[FP_MODE_COLUMN]
176
169
        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)
 
170
            digest = sha_file(file(abspath, 'rb', buffering=65000))
182
171
        elif stat.S_ISLNK(mode):
183
 
            target = osutils.readlink(osutils.safe_unicode(abspath))
184
 
            digest = osutils.sha_string(target.encode('UTF-8'))
 
172
            link_target = os.readlink(abspath)
 
173
            digest = sha.new(os.readlink(abspath)).hexdigest()
185
174
        else:
186
 
            raise errors.BzrError("file %r: unknown file stat mode: %o"
187
 
                                  % (abspath, mode))
 
175
            raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
188
176
 
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:
 
177
        now = int(time.time())
 
178
        if file_fp[1] >= now or file_fp[2] >= now:
194
179
            # changed too recently; can't be cached.  we can
195
180
            # return the result and it could possibly be cached
196
181
            # 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
 
182
            self.danger_count += 1 
207
183
            if cache_fp:
208
184
                self.removed_count += 1
209
185
                self.needs_write = True
210
186
                del self._cache[path]
211
187
        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
188
            self.update_count += 1
216
189
            self.needs_write = True
217
190
            self._cache[path] = (digest, file_fp)
218
191
        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]
223
 
 
 
192
        
224
193
    def write(self):
225
194
        """Write contents of cache to file."""
226
 
        outf = atomicfile.AtomicFile(self.cache_file_name(), 'wb',
227
 
                                     new_mode=self._mode)
 
195
        outf = AtomicFile(self.cache_file_name(), 'wb')
228
196
        try:
229
 
            outf.write(CACHE_HEADER)
 
197
            print >>outf, CACHE_HEADER,
230
198
 
231
199
            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))
 
200
                assert '//' not in path, path
 
201
                outf.write(path.encode('utf-8'))
 
202
                outf.write('// ')
 
203
                print >>outf, c[0],     # hex sha1
 
204
                for fld in c[1]:
 
205
                    print >>outf, "%d" % fld,
 
206
                print >>outf
 
207
 
236
208
            outf.commit()
237
209
            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
210
        finally:
243
 
            outf.close()
 
211
            if not outf.closed:
 
212
                outf.abort()
244
213
 
245
214
    def read(self):
246
215
        """Reinstate cache from file.
247
216
 
248
217
        Overwrites existing cache.
249
218
 
250
 
        If the cache file has the wrong version marker, this just clears
 
219
        If the cache file has the wrong version marker, this just clears 
251
220
        the cache."""
252
221
        self._cache = {}
253
222
 
255
224
        try:
256
225
            inf = file(fn, 'rb', buffering=65000)
257
226
        except IOError, e:
258
 
            trace.mutter("failed to open %s: %s", fn, e)
 
227
            mutter("failed to open %s: %s", fn, e)
259
228
            # better write it now so it is valid
260
229
            self.needs_write = True
261
230
            return
262
231
 
 
232
 
263
233
        hdr = inf.readline()
264
234
        if hdr != CACHE_HEADER:
265
 
            trace.mutter('cache header marker not found at top of %s;'
266
 
                         ' discarding cache', fn)
 
235
            mutter('cache header marker not found at top of %s;'
 
236
                   ' discarding cache', fn)
267
237
            self.needs_write = True
268
238
            return
269
239
 
271
241
            pos = l.index('// ')
272
242
            path = l[:pos].decode('utf-8')
273
243
            if path in self._cache:
274
 
                trace.warning('duplicated path %r in cache' % path)
 
244
                warning('duplicated path %r in cache' % path)
275
245
                continue
276
246
 
277
247
            pos += 3
278
248
            fields = l[pos:].split(' ')
279
249
            if len(fields) != 7:
280
 
                trace.warning("bad line in hashcache: %r" % l)
 
250
                warning("bad line in hashcache: %r" % l)
281
251
                continue
282
252
 
283
253
            sha1 = fields[0]
284
254
            if len(sha1) != 40:
285
 
                trace.warning("bad sha1 in hashcache: %r" % sha1)
 
255
                warning("bad sha1 in hashcache: %r" % sha1)
286
256
                continue
287
257
 
288
258
            fp = tuple(map(long, fields[1:]))
290
260
            self._cache[path] = (sha1, fp)
291
261
 
292
262
        self.needs_write = False
293
 
 
294
 
    def _cutoff_time(self):
295
 
        """Return cutoff time.
296
 
 
297
 
        Files modified more recently than this time are at risk of being
298
 
        undetectably modified and so can't be cached.
299
 
        """
300
 
        return int(time.time()) - 3
301
 
 
302
 
    def _fingerprint(self, abspath, stat_value=None):
303
 
        if stat_value is None:
304
 
            try:
305
 
                stat_value = os.lstat(abspath)
306
 
            except OSError:
307
 
                # might be missing, etc
308
 
                return None
309
 
        if stat.S_ISDIR(stat_value.st_mode):
310
 
            return None
311
 
        # we discard any high precision because it's not reliable; perhaps we
312
 
        # could do better on some systems?
313
 
        return (stat_value.st_size, long(stat_value.st_mtime),
314
 
                long(stat_value.st_ctime), stat_value.st_ino,
315
 
                stat_value.st_dev, stat_value.st_mode)
 
263
           
 
264
 
 
265
 
 
266