← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

  • Committer: Vincent Ladeuil
  • Date: 2012-08-02 14:14:36 UTC
  • mto: This revision was merged to the branch mainline in revision 6551.
  • Revision ID: v.ladeuil+lp@free.fr-20120802141436-pa7qqfq0qj3t4oup
Fix obvious bug, the filter stack needs the path to not be None.

Show diffs side-by-side

added added

removed removed

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