/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

  • Committer: Robert Collins
  • Date: 2005-12-24 02:20:45 UTC
  • mto: (1185.50.57 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1550.
  • Revision ID: robertc@robertcollins.net-20051224022045-14efc8dfa0e1a4e9
Start tests for api usage.

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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
 
26
26
# TODO: Perhaps use a Python pickle instead of a text file; might be faster.
27
27
 
28
28
 
29
 
CACHE_HEADER = b"### bzr hashcache v5\n"
30
 
 
31
 
import os
32
 
import stat
33
 
import time
34
 
 
35
 
from . import (
36
 
    atomicfile,
37
 
    errors,
38
 
    filters as _mod_filters,
39
 
    osutils,
40
 
    trace,
41
 
    )
42
 
 
43
 
 
44
 
FP_MTIME_COLUMN = 1
45
 
FP_CTIME_COLUMN = 2
 
29
 
 
30
CACHE_HEADER = "### bzr hashcache v5\n"
 
31
 
 
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
 
46
40
FP_MODE_COLUMN = 5
47
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)
 
56
 
48
57
 
49
58
class HashCache(object):
50
59
    """Cache for looking up file SHA-1.
76
85
    hit_count
77
86
        number of times files have been retrieved from the cache, avoiding a
78
87
        re-read
79
 
 
 
88
        
80
89
    miss_count
81
90
        number of misses (times files have been completely re-read)
82
91
    """
83
92
    needs_write = False
84
93
 
85
 
    def __init__(self, root, cache_file_name, mode=None,
86
 
                 content_filter_stack_provider=None):
87
 
        """Create a hash cache in base dir, and set the file mode to mode.
88
 
 
89
 
        :param content_filter_stack_provider: a function that takes a
90
 
            path (relative to the top of the tree) and a file-id as
91
 
            parameters and returns a stack of ContentFilters.
92
 
            If None, no content filtering is performed.
93
 
        """
94
 
        if not isinstance(root, str):
95
 
            raise ValueError("Base dir for hashcache must be text")
96
 
        self.root = root
 
94
    def __init__(self, basedir):
 
95
        self.basedir = basedir
97
96
        self.hit_count = 0
98
97
        self.miss_count = 0
99
98
        self.stat_count = 0
101
100
        self.removed_count = 0
102
101
        self.update_count = 0
103
102
        self._cache = {}
104
 
        self._mode = mode
105
 
        self._cache_file_name = cache_file_name
106
 
        self._filter_provider = content_filter_stack_provider
107
103
 
108
104
    def cache_file_name(self):
109
 
        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'])
110
108
 
111
109
    def clear(self):
112
110
        """Discard all cached information.
116
114
            self.needs_write = True
117
115
            self._cache = {}
118
116
 
 
117
 
119
118
    def scan(self):
120
119
        """Scan all files and remove entries where the cache entry is obsolete.
121
 
 
 
120
        
122
121
        Obsolete entries are those where the file has been modified or deleted
123
 
        since the entry was inserted.
 
122
        since the entry was inserted.        
124
123
        """
125
 
        # Stat in inode order as optimisation for at least linux.
126
 
        def inode_order(path_and_cache):
127
 
            return path_and_cache[1][1][3]
128
 
        for path, cache_val in sorted(self._cache.items(), key=inode_order):
129
 
            abspath = osutils.pathjoin(self.root, path)
130
 
            fp = self._fingerprint(abspath)
 
124
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
 
125
        prep.sort()
 
126
        
 
127
        for inum, path, cache_entry in prep:
 
128
            abspath = os.sep.join([self.basedir, path])
 
129
            fp = _fingerprint(abspath)
131
130
            self.stat_count += 1
132
 
 
133
 
            if not fp or cache_val[1] != fp:
 
131
            
 
132
            cache_fp = cache_entry[1]
 
133
    
 
134
            if (not fp) or (cache_fp != fp):
134
135
                # not here or not a regular file anymore
135
136
                self.removed_count += 1
136
137
                self.needs_write = True
137
138
                del self._cache[path]
138
139
 
139
 
    def get_sha1(self, path, stat_value=None):
 
140
 
 
141
    def get_sha1(self, path):
140
142
        """Return the sha1 of a file.
141
143
        """
142
 
        abspath = osutils.pathjoin(self.root, path)
 
144
        abspath = os.sep.join([self.basedir, path])
143
145
        self.stat_count += 1
144
 
        file_fp = self._fingerprint(abspath, stat_value)
145
 
 
 
146
        file_fp = _fingerprint(abspath)
 
147
        
146
148
        if not file_fp:
147
149
            # not a regular file or not existing
148
150
            if path in self._cache:
149
151
                self.removed_count += 1
150
152
                self.needs_write = True
151
153
                del self._cache[path]
152
 
            return None
 
154
            return None        
153
155
 
154
156
        if path in self._cache:
155
157
            cache_sha1, cache_fp = self._cache[path]
159
161
        if cache_fp == file_fp:
160
162
            self.hit_count += 1
161
163
            return cache_sha1
162
 
 
 
164
        
163
165
        self.miss_count += 1
164
166
 
 
167
 
165
168
        mode = file_fp[FP_MODE_COLUMN]
166
169
        if stat.S_ISREG(mode):
167
 
            if self._filter_provider is None:
168
 
                filters = []
169
 
            else:
170
 
                filters = self._filter_provider(path=path)
171
 
            digest = self._really_sha1_file(abspath, filters)
 
170
            digest = sha_file(file(abspath, 'rb', buffering=65000))
172
171
        elif stat.S_ISLNK(mode):
173
 
            target = osutils.readlink(abspath)
174
 
            digest = osutils.sha_string(target.encode('UTF-8'))
 
172
            link_target = os.readlink(abspath)
 
173
            digest = sha.new(os.readlink(abspath)).hexdigest()
175
174
        else:
176
 
            raise errors.BzrError("file %r: unknown file stat mode: %o"
177
 
                                  % (abspath, mode))
 
175
            raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
178
176
 
179
 
        # window of 3 seconds to allow for 2s resolution on windows,
180
 
        # unsynchronized file servers, etc.
181
 
        cutoff = self._cutoff_time()
182
 
        if file_fp[FP_MTIME_COLUMN] >= cutoff \
183
 
                or file_fp[FP_CTIME_COLUMN] >= cutoff:
 
177
        now = int(time.time())
 
178
        if file_fp[1] >= now or file_fp[2] >= now:
184
179
            # changed too recently; can't be cached.  we can
185
180
            # return the result and it could possibly be cached
186
181
            # next time.
187
 
            #
188
 
            # the point is that we only want to cache when we are sure that any
189
 
            # subsequent modifications of the file can be detected.  If a
190
 
            # modification neither changes the inode, the device, the size, nor
191
 
            # the mode, then we can only distinguish it by time; therefore we
192
 
            # need to let sufficient time elapse before we may cache this entry
193
 
            # again.  If we didn't do this, then, for example, a very quick 1
194
 
            # byte replacement in the file might go undetected.
195
 
            ## mutter('%r modified too recently; not caching', path)
196
 
            self.danger_count += 1
 
182
            self.danger_count += 1 
197
183
            if cache_fp:
198
184
                self.removed_count += 1
199
185
                self.needs_write = True
200
186
                del self._cache[path]
201
187
        else:
202
 
            # mutter('%r added to cache: now=%f, mtime=%d, ctime=%d',
203
 
            ##        path, time.time(), file_fp[FP_MTIME_COLUMN],
204
 
            # file_fp[FP_CTIME_COLUMN])
205
188
            self.update_count += 1
206
189
            self.needs_write = True
207
190
            self._cache[path] = (digest, file_fp)
208
191
        return digest
209
 
 
210
 
    def _really_sha1_file(self, abspath, filters):
211
 
        """Calculate the SHA1 of a file by reading the full text"""
212
 
        return _mod_filters.internal_size_sha_file_byname(abspath, filters)[1]
213
 
 
 
192
        
214
193
    def write(self):
215
194
        """Write contents of cache to file."""
216
 
        with atomicfile.AtomicFile(self.cache_file_name(), 'wb',
217
 
                                   new_mode=self._mode) as outf:
218
 
            outf.write(CACHE_HEADER)
219
 
 
220
 
            for path, c in self._cache.items():
221
 
                line_info = [path.encode('utf-8'), b'// ', c[0], b' ']
222
 
                line_info.append(b'%d %d %d %d %d %d' % c[1])
223
 
                line_info.append(b'\n')
224
 
                outf.write(b''.join(line_info))
 
195
        outf = AtomicFile(self.cache_file_name(), 'wb')
 
196
        try:
 
197
            print >>outf, CACHE_HEADER,
 
198
 
 
199
            for path, c  in self._cache.iteritems():
 
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
 
 
208
            outf.commit()
225
209
            self.needs_write = False
226
 
            # mutter("write hash cache: %s hits=%d misses=%d stat=%d recent=%d updates=%d",
227
 
            #        self.cache_file_name(), self.hit_count, self.miss_count,
228
 
            # self.stat_count,
229
 
            # self.danger_count, self.update_count)
 
210
        finally:
 
211
            if not outf.closed:
 
212
                outf.abort()
230
213
 
231
214
    def read(self):
232
215
        """Reinstate cache from file.
233
216
 
234
217
        Overwrites existing cache.
235
218
 
236
 
        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 
237
220
        the cache."""
238
221
        self._cache = {}
239
222
 
240
223
        fn = self.cache_file_name()
241
224
        try:
242
 
            inf = open(fn, 'rb', buffering=65000)
243
 
        except IOError as e:
244
 
            trace.mutter("failed to open %s: %s", fn, str(e))
 
225
            inf = file(fn, 'rb', buffering=65000)
 
226
        except IOError, e:
 
227
            mutter("failed to open %s: %s", fn, e)
245
228
            # better write it now so it is valid
246
229
            self.needs_write = True
247
230
            return
248
231
 
249
 
        with inf:
250
 
            hdr = inf.readline()
251
 
            if hdr != CACHE_HEADER:
252
 
                trace.mutter('cache header marker not found at top of %s;'
253
 
                             ' discarding cache', fn)
254
 
                self.needs_write = True
255
 
                return
256
 
 
257
 
            for l in inf:
258
 
                pos = l.index(b'// ')
259
 
                path = l[:pos].decode('utf-8')
260
 
                if path in self._cache:
261
 
                    trace.warning('duplicated path %r in cache' % path)
262
 
                    continue
263
 
 
264
 
                pos += 3
265
 
                fields = l[pos:].split(b' ')
266
 
                if len(fields) != 7:
267
 
                    trace.warning("bad line in hashcache: %r" % l)
268
 
                    continue
269
 
 
270
 
                sha1 = fields[0]
271
 
                if len(sha1) != 40:
272
 
                    trace.warning("bad sha1 in hashcache: %r" % sha1)
273
 
                    continue
274
 
 
275
 
                fp = tuple(map(int, fields[1:]))
276
 
 
277
 
                self._cache[path] = (sha1, fp)
 
232
 
 
233
        hdr = inf.readline()
 
234
        if hdr != CACHE_HEADER:
 
235
            mutter('cache header marker not found at top of %s;'
 
236
                   ' discarding cache', fn)
 
237
            self.needs_write = True
 
238
            return
 
239
 
 
240
        for l in inf:
 
241
            pos = l.index('// ')
 
242
            path = l[:pos].decode('utf-8')
 
243
            if path in self._cache:
 
244
                warning('duplicated path %r in cache' % path)
 
245
                continue
 
246
 
 
247
            pos += 3
 
248
            fields = l[pos:].split(' ')
 
249
            if len(fields) != 7:
 
250
                warning("bad line in hashcache: %r" % l)
 
251
                continue
 
252
 
 
253
            sha1 = fields[0]
 
254
            if len(sha1) != 40:
 
255
                warning("bad sha1 in hashcache: %r" % sha1)
 
256
                continue
 
257
 
 
258
            fp = tuple(map(long, fields[1:]))
 
259
 
 
260
            self._cache[path] = (sha1, fp)
278
261
 
279
262
        self.needs_write = False
280
 
 
281
 
    def _cutoff_time(self):
282
 
        """Return cutoff time.
283
 
 
284
 
        Files modified more recently than this time are at risk of being
285
 
        undetectably modified and so can't be cached.
286
 
        """
287
 
        return int(time.time()) - 3
288
 
 
289
 
    def _fingerprint(self, abspath, stat_value=None):
290
 
        if stat_value is None:
291
 
            try:
292
 
                stat_value = os.lstat(abspath)
293
 
            except OSError:
294
 
                # might be missing, etc
295
 
                return None
296
 
        if stat.S_ISDIR(stat_value.st_mode):
297
 
            return None
298
 
        # we discard any high precision because it's not reliable; perhaps we
299
 
        # could do better on some systems?
300
 
        return (stat_value.st_size, int(stat_value.st_mtime),
301
 
                int(stat_value.st_ctime), stat_value.st_ino,
302
 
                stat_value.st_dev, stat_value.st_mode)
 
263
           
 
264
 
 
265
 
 
266