← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

  • Committer: Patch Queue Manager
  • Date: 2011-09-22 14:12:18 UTC
  • mfrom: (6155.3.1 jam)
  • Revision ID: pqm@pqm.ubuntu.com-20110922141218-86s4uu6nqvourw4f
(jameinel) Cleanup comments bzrlib/smart/__init__.py (John A Meinel)

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