/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-10-19 10:11:57 UTC
  • mfrom: (1185.16.78)
  • mto: This revision was merged to the branch mainline in revision 1470.
  • Revision ID: robertc@robertcollins.net-20051019101157-17438d311e746b4f
merge from upstream

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