← 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: 2005-11-18 16:50:56 UTC
  • mto: (1185.82.108 w-changeset)
  • mto: This revision was merged to the branch mainline in revision 1738.
  • Revision ID: john@arbash-meinel.com-20051118165056-97f164d958a1886b
Moved testdata code to subdirectory

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