/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: John Arbash Meinel
  • Date: 2006-04-25 15:05:42 UTC
  • mfrom: (1185.85.85 bzr-encoding)
  • mto: This revision was merged to the branch mainline in revision 1752.
  • Revision ID: john@arbash-meinel.com-20060425150542-c7b518dca9928691
[merge] the old bzr-encoding changes, reparenting them on bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/hashcache.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005, 2006 by 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
 
    )
 
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, pathjoin, safe_unicode
 
36
from bzrlib.trace import mutter, warning
 
37
from bzrlib.atomicfile import AtomicFile
 
38
from bzrlib.errors import BzrError
48
39
 
49
40
 
50
41
FP_MTIME_COLUMN = 1
51
42
FP_CTIME_COLUMN = 2
52
43
FP_MODE_COLUMN = 5
53
44
 
 
45
def _fingerprint(abspath):
 
46
    try:
 
47
        fs = os.lstat(abspath)
 
48
    except OSError:
 
49
        # might be missing, etc
 
50
        return None
 
51
 
 
52
    if stat.S_ISDIR(fs.st_mode):
 
53
        return None
 
54
 
 
55
    # we discard any high precision because it's not reliable; perhaps we
 
56
    # could do better on some systems?
 
57
    return (fs.st_size, long(fs.st_mtime),
 
58
            long(fs.st_ctime), fs.st_ino, fs.st_dev, fs.st_mode)
 
59
 
54
60
 
55
61
class HashCache(object):
56
62
    """Cache for looking up file SHA-1.
82
88
    hit_count
83
89
        number of times files have been retrieved from the cache, avoiding a
84
90
        re-read
85
 
 
 
91
        
86
92
    miss_count
87
93
        number of misses (times files have been completely re-read)
88
94
    """
89
95
    needs_write = False
90
96
 
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
 
97
    def __init__(self, root, cache_file_name, mode=None):
 
98
        """Create a hash cache in base dir, and set the file mode to mode."""
 
99
        self.root = safe_unicode(root)
103
100
        self.hit_count = 0
104
101
        self.miss_count = 0
105
102
        self.stat_count = 0
108
105
        self.update_count = 0
109
106
        self._cache = {}
110
107
        self._mode = mode
111
 
        self._cache_file_name = cache_file_name
112
 
        self._filter_provider = content_filter_stack_provider
 
108
        self._cache_file_name = safe_unicode(cache_file_name)
113
109
 
114
110
    def cache_file_name(self):
115
111
        return self._cache_file_name
124
120
 
125
121
    def scan(self):
126
122
        """Scan all files and remove entries where the cache entry is obsolete.
127
 
 
 
123
        
128
124
        Obsolete entries are those where the file has been modified or deleted
129
 
        since the entry was inserted.
 
125
        since the entry was inserted.        
130
126
        """
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)
 
127
        # FIXME optimisation opportunity, on linux [and check other oses]:
 
128
        # rather than iteritems order, stat in inode order.
 
129
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
 
130
        prep.sort()
 
131
        
 
132
        for inum, path, cache_entry in prep:
 
133
            abspath = pathjoin(self.root, path)
 
134
            fp = _fingerprint(abspath)
137
135
            self.stat_count += 1
138
 
 
139
 
            if not fp or cache_val[1] != fp:
 
136
            
 
137
            cache_fp = cache_entry[1]
 
138
    
 
139
            if (not fp) or (cache_fp != fp):
140
140
                # not here or not a regular file anymore
141
141
                self.removed_count += 1
142
142
                self.needs_write = True
143
143
                del self._cache[path]
144
144
 
145
 
    def get_sha1(self, path, stat_value=None):
 
145
 
 
146
    def get_sha1(self, path):
146
147
        """Return the sha1 of a file.
147
148
        """
148
 
        abspath = osutils.pathjoin(self.root, path)
 
149
        abspath = pathjoin(self.root, path)
149
150
        self.stat_count += 1
150
 
        file_fp = self._fingerprint(abspath, stat_value)
151
 
 
 
151
        file_fp = _fingerprint(abspath)
 
152
        
152
153
        if not file_fp:
153
154
            # not a regular file or not existing
154
155
            if path in self._cache:
155
156
                self.removed_count += 1
156
157
                self.needs_write = True
157
158
                del self._cache[path]
158
 
            return None
 
159
            return None        
159
160
 
160
161
        if path in self._cache:
161
162
            cache_sha1, cache_fp = self._cache[path]
165
166
        if cache_fp == file_fp:
166
167
            self.hit_count += 1
167
168
            return cache_sha1
168
 
 
 
169
        
169
170
        self.miss_count += 1
170
171
 
 
172
 
171
173
        mode = file_fp[FP_MODE_COLUMN]
172
174
        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)
 
175
            digest = sha_file(file(abspath, 'rb', buffering=65000))
178
176
        elif stat.S_ISLNK(mode):
179
 
            target = osutils.readlink(abspath)
180
 
            digest = osutils.sha_string(target.encode('UTF-8'))
 
177
            digest = sha.new(os.readlink(abspath)).hexdigest()
181
178
        else:
182
 
            raise errors.BzrError("file %r: unknown file stat mode: %o"
183
 
                                  % (abspath, mode))
 
179
            raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
184
180
 
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:
 
181
        now = int(time.time())
 
182
        if file_fp[FP_MTIME_COLUMN] >= now or file_fp[FP_CTIME_COLUMN] >= now:
190
183
            # changed too recently; can't be cached.  we can
191
184
            # return the result and it could possibly be cached
192
185
            # next time.
198
191
            # need to let sufficient time elapse before we may cache this entry
199
192
            # again.  If we didn't do this, then, for example, a very quick 1
200
193
            # byte replacement in the file might go undetected.
201
 
            ## mutter('%r modified too recently; not caching', path)
202
 
            self.danger_count += 1
 
194
            self.danger_count += 1 
203
195
            if cache_fp:
204
196
                self.removed_count += 1
205
197
                self.needs_write = True
206
198
                del self._cache[path]
207
199
        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
200
            self.update_count += 1
212
201
            self.needs_write = True
213
202
            self._cache[path] = (digest, file_fp)
214
203
        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
 
 
 
204
        
220
205
    def write(self):
221
206
        """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)
 
207
        outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
 
208
        try:
 
209
            print >>outf, CACHE_HEADER,
225
210
 
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))
 
211
            for path, c  in self._cache.iteritems():
 
212
                assert '//' not in path, path
 
213
                outf.write(path.encode('utf-8'))
 
214
                outf.write('// ')
 
215
                print >>outf, c[0],     # hex sha1
 
216
                for fld in c[1]:
 
217
                    print >>outf, "%d" % fld,
 
218
                print >>outf
 
219
            outf.commit()
231
220
            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)
 
221
            mutter("write hash cache: %s hits=%d misses=%d stat=%d recent=%d updates=%d",
 
222
                   self.cache_file_name(), self.hit_count, self.miss_count,
 
223
                   self.stat_count,
 
224
                   self.danger_count, self.update_count)
 
225
        finally:
 
226
            if not outf.closed:
 
227
                outf.abort()
236
228
 
237
229
    def read(self):
238
230
        """Reinstate cache from file.
239
231
 
240
232
        Overwrites existing cache.
241
233
 
242
 
        If the cache file has the wrong version marker, this just clears
 
234
        If the cache file has the wrong version marker, this just clears 
243
235
        the cache."""
244
236
        self._cache = {}
245
237
 
246
238
        fn = self.cache_file_name()
247
239
        try:
248
 
            inf = open(fn, 'rb', buffering=65000)
249
 
        except IOError as e:
250
 
            trace.mutter("failed to open %s: %s", fn, str(e))
 
240
            inf = file(fn, 'rb', buffering=65000)
 
241
        except IOError, e:
 
242
            mutter("failed to open %s: %s", fn, e)
251
243
            # better write it now so it is valid
252
244
            self.needs_write = True
253
245
            return
254
246
 
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)
 
247
 
 
248
        hdr = inf.readline()
 
249
        if hdr != CACHE_HEADER:
 
250
            mutter('cache header marker not found at top of %s;'
 
251
                   ' discarding cache', fn)
 
252
            self.needs_write = True
 
253
            return
 
254
 
 
255
        for l in inf:
 
256
            pos = l.index('// ')
 
257
            path = l[:pos].decode('utf-8')
 
258
            if path in self._cache:
 
259
                warning('duplicated path %r in cache' % path)
 
260
                continue
 
261
 
 
262
            pos += 3
 
263
            fields = l[pos:].split(' ')
 
264
            if len(fields) != 7:
 
265
                warning("bad line in hashcache: %r" % l)
 
266
                continue
 
267
 
 
268
            sha1 = fields[0]
 
269
            if len(sha1) != 40:
 
270
                warning("bad sha1 in hashcache: %r" % sha1)
 
271
                continue
 
272
 
 
273
            fp = tuple(map(long, fields[1:]))
 
274
 
 
275
            self._cache[path] = (sha1, fp)
284
276
 
285
277
        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)
 
278
           
 
279
 
 
280
 
 
281