← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

  • Committer: John Arbash Meinel
  • Date: 2013-05-19 14:29:37 UTC
  • mfrom: (6437.63.9 2.5)
  • mto: (6437.63.10 2.5)
  • mto: This revision was merged to the branch mainline in revision 6575.
  • Revision ID: john@arbash-meinel.com-20130519142937-21ykz2n2y2f22za9
Merge in the actual 2.5 branch. It seems I failed before

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/hashcache.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
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
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
import os
 
35
import stat
 
36
import time
34
37
 
35
 
from bzrlib.osutils import sha_file, pathjoin, safe_unicode
36
 
from bzrlib.trace import mutter, warning
37
 
from bzrlib.atomicfile import AtomicFile
38
 
from bzrlib.errors import BzrError
 
38
from bzrlib import (
 
39
    atomicfile,
 
40
    errors,
 
41
    filters as _mod_filters,
 
42
    osutils,
 
43
    trace,
 
44
    )
39
45
 
40
46
 
41
47
FP_MTIME_COLUMN = 1
74
80
    hit_count
75
81
        number of times files have been retrieved from the cache, avoiding a
76
82
        re-read
77
 
        
 
83
 
78
84
    miss_count
79
85
        number of misses (times files have been completely re-read)
80
86
    """
81
87
    needs_write = False
82
88
 
83
 
    def __init__(self, root, cache_file_name, mode=None):
84
 
        """Create a hash cache in base dir, and set the file mode to mode."""
85
 
        self.root = safe_unicode(root)
 
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)
86
99
        self.root_utf8 = self.root.encode('utf8') # where is the filesystem encoding ?
87
100
        self.hit_count = 0
88
101
        self.miss_count = 0
92
105
        self.update_count = 0
93
106
        self._cache = {}
94
107
        self._mode = mode
95
 
        self._cache_file_name = safe_unicode(cache_file_name)
 
108
        self._cache_file_name = osutils.safe_unicode(cache_file_name)
 
109
        self._filter_provider = content_filter_stack_provider
96
110
 
97
111
    def cache_file_name(self):
98
112
        return self._cache_file_name
107
121
 
108
122
    def scan(self):
109
123
        """Scan all files and remove entries where the cache entry is obsolete.
110
 
        
 
124
 
111
125
        Obsolete entries are those where the file has been modified or deleted
112
 
        since the entry was inserted.        
 
126
        since the entry was inserted.
113
127
        """
114
128
        # FIXME optimisation opportunity, on linux [and check other oses]:
115
129
        # rather than iteritems order, stat in inode order.
116
130
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
117
131
        prep.sort()
118
 
        
 
132
 
119
133
        for inum, path, cache_entry in prep:
120
 
            abspath = pathjoin(self.root, path)
 
134
            abspath = osutils.pathjoin(self.root, path)
121
135
            fp = self._fingerprint(abspath)
122
136
            self.stat_count += 1
123
 
            
 
137
 
124
138
            cache_fp = cache_entry[1]
125
 
    
 
139
 
126
140
            if (not fp) or (cache_fp != fp):
127
141
                # not here or not a regular file anymore
128
142
                self.removed_count += 1
133
147
        """Return the sha1 of a file.
134
148
        """
135
149
        if path.__class__ is str:
136
 
            abspath = pathjoin(self.root_utf8, path)
 
150
            abspath = osutils.pathjoin(self.root_utf8, path)
137
151
        else:
138
 
            abspath = pathjoin(self.root, path)
 
152
            abspath = osutils.pathjoin(self.root, path)
139
153
        self.stat_count += 1
140
154
        file_fp = self._fingerprint(abspath, stat_value)
141
 
        
 
155
 
142
156
        if not file_fp:
143
157
            # not a regular file or not existing
144
158
            if path in self._cache:
145
159
                self.removed_count += 1
146
160
                self.needs_write = True
147
161
                del self._cache[path]
148
 
            return None        
 
162
            return None
149
163
 
150
164
        if path in self._cache:
151
165
            cache_sha1, cache_fp = self._cache[path]
157
171
            ## mutter("now = %s", time.time())
158
172
            self.hit_count += 1
159
173
            return cache_sha1
160
 
        
 
174
 
161
175
        self.miss_count += 1
162
176
 
163
177
        mode = file_fp[FP_MODE_COLUMN]
164
178
        if stat.S_ISREG(mode):
165
 
            digest = self._really_sha1_file(abspath)
 
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)
166
184
        elif stat.S_ISLNK(mode):
167
 
            digest = sha.new(os.readlink(abspath)).hexdigest()
 
185
            target = osutils.readlink(osutils.safe_unicode(abspath))
 
186
            digest = osutils.sha_string(target.encode('UTF-8'))
168
187
        else:
169
 
            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))
170
190
 
171
191
        # window of 3 seconds to allow for 2s resolution on windows,
172
192
        # unsynchronized file servers, etc.
199
219
            self._cache[path] = (digest, file_fp)
200
220
        return digest
201
221
 
202
 
    def _really_sha1_file(self, abspath):
 
222
    def _really_sha1_file(self, abspath, filters):
203
223
        """Calculate the SHA1 of a file by reading the full text"""
204
 
        return sha_file(file(abspath, 'rb', buffering=65000))
205
 
        
 
224
        return _mod_filters.internal_size_sha_file_byname(abspath, filters)[1]
 
225
 
206
226
    def write(self):
207
227
        """Write contents of cache to file."""
208
 
        outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
 
228
        outf = atomicfile.AtomicFile(self.cache_file_name(), 'wb',
 
229
                                     new_mode=self._mode)
209
230
        try:
210
231
            outf.write(CACHE_HEADER)
211
232
 
212
233
            for path, c  in self._cache.iteritems():
213
 
                assert '//' not in path, path
214
234
                line_info = [path.encode('utf-8'), '// ', c[0], ' ']
215
235
                line_info.append(' '.join([str(fld) for fld in c[1]]))
216
236
                line_info.append('\n')
229
249
 
230
250
        Overwrites existing cache.
231
251
 
232
 
        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
233
253
        the cache."""
234
254
        self._cache = {}
235
255
 
237
257
        try:
238
258
            inf = file(fn, 'rb', buffering=65000)
239
259
        except IOError, e:
240
 
            mutter("failed to open %s: %s", fn, e)
 
260
            trace.mutter("failed to open %s: %s", fn, e)
241
261
            # better write it now so it is valid
242
262
            self.needs_write = True
243
263
            return
244
264
 
245
265
        hdr = inf.readline()
246
266
        if hdr != CACHE_HEADER:
247
 
            mutter('cache header marker not found at top of %s;'
248
 
                   ' discarding cache', fn)
 
267
            trace.mutter('cache header marker not found at top of %s;'
 
268
                         ' discarding cache', fn)
249
269
            self.needs_write = True
250
270
            return
251
271
 
253
273
            pos = l.index('// ')
254
274
            path = l[:pos].decode('utf-8')
255
275
            if path in self._cache:
256
 
                warning('duplicated path %r in cache' % path)
 
276
                trace.warning('duplicated path %r in cache' % path)
257
277
                continue
258
278
 
259
279
            pos += 3
260
280
            fields = l[pos:].split(' ')
261
281
            if len(fields) != 7:
262
 
                warning("bad line in hashcache: %r" % l)
 
282
                trace.warning("bad line in hashcache: %r" % l)
263
283
                continue
264
284
 
265
285
            sha1 = fields[0]
266
286
            if len(sha1) != 40:
267
 
                warning("bad sha1 in hashcache: %r" % sha1)
 
287
                trace.warning("bad sha1 in hashcache: %r" % sha1)
268
288
                continue
269
289
 
270
290
            fp = tuple(map(long, fields[1:]))
271
291
 
272
292
            self._cache[path] = (sha1, fp)
273
293
 
 
294
        # GZ 2009-09-20: Should really use a try/finally block to ensure close
 
295
        inf.close()
 
296
 
274
297
        self.needs_write = False
275
298
 
276
299
    def _cutoff_time(self):
280
303
        undetectably modified and so can't be cached.
281
304
        """
282
305
        return int(time.time()) - 3
283
 
           
 
306
 
284
307
    def _fingerprint(self, abspath, stat_value=None):
285
308
        if stat_value is None:
286
309
            try:
293
316
        # we discard any high precision because it's not reliable; perhaps we
294
317
        # could do better on some systems?
295
318
        return (stat_value.st_size, long(stat_value.st_mtime),
296
 
                long(stat_value.st_ctime), stat_value.st_ino, 
 
319
                long(stat_value.st_ctime), stat_value.st_ino,
297
320
                stat_value.st_dev, stat_value.st_mode)