/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: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

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