← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

merge merge tweaks from aaron, which includes latest .dev

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