← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

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