← 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-09-13 05:22:41 UTC
  • Revision ID: mbp@sourcefrog.net-20050913052241-52dbd8e8ced620f6
- better BZR_DEBUG trace output

Show diffs side-by-side

added added

removed removed

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