← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

  • Committer: Andrew Bennetts
  • Date: 2010-10-08 08:15:14 UTC
  • mto: This revision was merged to the branch mainline in revision 5498.
  • Revision ID: andrew.bennetts@canonical.com-20101008081514-dviqzrdfwyzsqbz2
Split NEWS into per-release doc/en/release-notes/bzr-*.txt

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