← 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: 2005-08-18 05:44:39 UTC
  • Revision ID: mbp@sourcefrog.net-20050818054439-ba0873b87a8c1671
- add code to run weave utility under profiler

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/hashcache.py
1
 
# Copyright (C) 2005, 2006 by Canonical Ltd
 
1
# (C) 2005 Canonical Ltd
2
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
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
 
 
28
26
 
29
27
 
30
28
CACHE_HEADER = "### bzr hashcache v5\n"
31
29
 
32
30
import os, stat, time
33
 
import sha
34
31
 
35
 
from bzrlib.osutils import sha_file, pathjoin, safe_unicode
 
32
from bzrlib.osutils import sha_file
36
33
from bzrlib.trace import mutter, warning
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
 
34
 
 
35
 
44
36
 
45
37
def _fingerprint(abspath):
46
38
    try:
55
47
    # we discard any high precision because it's not reliable; perhaps we
56
48
    # could do better on some systems?
57
49
    return (fs.st_size, long(fs.st_mtime),
58
 
            long(fs.st_ctime), fs.st_ino, fs.st_dev, fs.st_mode)
 
50
            long(fs.st_ctime), fs.st_ino, fs.st_dev)
59
51
 
60
52
 
61
53
class HashCache(object):
94
86
    """
95
87
    needs_write = False
96
88
 
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)
 
89
    def __init__(self, basedir):
 
90
        self.basedir = basedir
100
91
        self.hit_count = 0
101
92
        self.miss_count = 0
102
93
        self.stat_count = 0
104
95
        self.removed_count = 0
105
96
        self.update_count = 0
106
97
        self._cache = {}
107
 
        self._mode = mode
108
 
        self._cache_file_name = safe_unicode(cache_file_name)
 
98
 
109
99
 
110
100
    def cache_file_name(self):
111
 
        return self._cache_file_name
 
101
        return os.sep.join([self.basedir, '.bzr', 'stat-cache'])
 
102
 
 
103
 
 
104
 
112
105
 
113
106
    def clear(self):
114
107
        """Discard all cached information.
118
111
            self.needs_write = True
119
112
            self._cache = {}
120
113
 
 
114
 
121
115
    def scan(self):
122
116
        """Scan all files and remove entries where the cache entry is obsolete.
123
117
        
124
118
        Obsolete entries are those where the file has been modified or deleted
125
119
        since the entry was inserted.        
126
120
        """
127
 
        # FIXME optimisation opportunity, on linux [and check other oses]:
128
 
        # rather than iteritems order, stat in inode order.
129
121
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
130
122
        prep.sort()
131
123
        
132
124
        for inum, path, cache_entry in prep:
133
 
            abspath = pathjoin(self.root, path)
 
125
            abspath = os.sep.join([self.basedir, path])
134
126
            fp = _fingerprint(abspath)
135
127
            self.stat_count += 1
136
128
            
143
135
                del self._cache[path]
144
136
 
145
137
 
 
138
 
146
139
    def get_sha1(self, path):
147
140
        """Return the sha1 of a file.
148
141
        """
149
 
        abspath = pathjoin(self.root, path)
 
142
        abspath = os.sep.join([self.basedir, path])
150
143
        self.stat_count += 1
151
144
        file_fp = _fingerprint(abspath)
152
145
        
168
161
            return cache_sha1
169
162
        
170
163
        self.miss_count += 1
171
 
 
172
 
 
173
 
        mode = file_fp[FP_MODE_COLUMN]
174
 
        if stat.S_ISREG(mode):
175
 
            digest = sha_file(file(abspath, 'rb', buffering=65000))
176
 
        elif stat.S_ISLNK(mode):
177
 
            digest = sha.new(os.readlink(abspath)).hexdigest()
178
 
        else:
179
 
            raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
 
164
        digest = sha_file(file(abspath, 'rb', buffering=65000))
180
165
 
181
166
        now = int(time.time())
182
 
        if file_fp[FP_MTIME_COLUMN] >= now or file_fp[FP_CTIME_COLUMN] >= now:
 
167
        if file_fp[1] >= now or file_fp[2] >= now:
183
168
            # changed too recently; can't be cached.  we can
184
169
            # return the result and it could possibly be cached
185
170
            # next time.
186
 
            #
187
 
            # the point is that we only want to cache when we are sure that any
188
 
            # subsequent modifications of the file can be detected.  If a
189
 
            # modification neither changes the inode, the device, the size, nor
190
 
            # the mode, then we can only distinguish it by time; therefore we
191
 
            # need to let sufficient time elapse before we may cache this entry
192
 
            # again.  If we didn't do this, then, for example, a very quick 1
193
 
            # byte replacement in the file might go undetected.
194
171
            self.danger_count += 1 
195
172
            if cache_fp:
196
173
                self.removed_count += 1
200
177
            self.update_count += 1
201
178
            self.needs_write = True
202
179
            self._cache[path] = (digest, file_fp)
 
180
        
203
181
        return digest
204
182
        
 
183
 
 
184
 
 
185
 
205
186
    def write(self):
206
187
        """Write contents of cache to file."""
207
 
        outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
 
188
        from atomicfile import AtomicFile
 
189
 
 
190
        outf = AtomicFile(self.cache_file_name(), 'wb')
208
191
        try:
209
192
            print >>outf, CACHE_HEADER,
210
193
 
216
199
                for fld in c[1]:
217
200
                    print >>outf, "%d" % fld,
218
201
                print >>outf
 
202
 
219
203
            outf.commit()
220
204
            self.needs_write = False
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
205
        finally:
226
206
            if not outf.closed:
227
207
                outf.abort()
 
208
        
 
209
 
228
210
 
229
211
    def read(self):
230
212
        """Reinstate cache from file.
239
221
        try:
240
222
            inf = file(fn, 'rb', buffering=65000)
241
223
        except IOError, e:
242
 
            mutter("failed to open %s: %s", fn, e)
243
 
            # better write it now so it is valid
244
 
            self.needs_write = True
 
224
            mutter("failed to open %s: %s" % (fn, e))
245
225
            return
246
226
 
247
227
 
248
228
        hdr = inf.readline()
249
229
        if hdr != CACHE_HEADER:
250
 
            mutter('cache header marker not found at top of %s;'
251
 
                   ' discarding cache', fn)
252
 
            self.needs_write = True
 
230
            mutter('cache header marker not found at top of %s; discarding cache'
 
231
                   % fn)
253
232
            return
254
233
 
255
234
        for l in inf:
261
240
 
262
241
            pos += 3
263
242
            fields = l[pos:].split(' ')
264
 
            if len(fields) != 7:
 
243
            if len(fields) != 6:
265
244
                warning("bad line in hashcache: %r" % l)
266
245
                continue
267
246