← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

  • Committer: Martin Pool
  • Date: 2009-03-03 01:45:32 UTC
  • mto: (4070.4.5 gnu-changelog)
  • mto: This revision was merged to the branch mainline in revision 4081.
  • Revision ID: mbp@sourcefrog.net-20090303014532-d223fxy97cb1og8f
Recommend setting timestamp in BranchBuilder

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