← 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: 2007-04-04 01:22:11 UTC
  • mfrom: (2393.1.1 bzr.docs)
  • mto: This revision was merged to the branch mainline in revision 2397.
  • Revision ID: mbp@sourcefrog.net-20070404012211-sq269me6bai9m6xk
merge trunk and doc fix from elliot

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