← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-07-12 15:13:59 UTC
  • mfrom: (1850.1.2 diff-6391)
  • Revision ID: pqm@pqm.ubuntu.com-20060712151359-b22a8c043fa52eb7
(jam) update help text for diff (bug #6391)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/hashcache.py
1
 
# (C) 2005 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 by 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
32
32
import os, stat, time
33
33
import sha
34
34
 
35
 
from bzrlib.osutils import sha_file
 
35
from bzrlib.osutils import sha_file, pathjoin, safe_unicode
36
36
from bzrlib.trace import mutter, warning
37
37
from bzrlib.atomicfile import AtomicFile
38
 
 
39
 
 
 
38
from bzrlib.errors import BzrError
 
39
 
 
40
 
 
41
FP_MTIME_COLUMN = 1
 
42
FP_CTIME_COLUMN = 2
40
43
FP_MODE_COLUMN = 5
41
44
 
42
 
def _fingerprint(abspath):
43
 
    try:
44
 
        fs = os.lstat(abspath)
45
 
    except OSError:
46
 
        # might be missing, etc
47
 
        return None
48
 
 
49
 
    if stat.S_ISDIR(fs.st_mode):
50
 
        return None
51
 
 
52
 
    # we discard any high precision because it's not reliable; perhaps we
53
 
    # could do better on some systems?
54
 
    return (fs.st_size, long(fs.st_mtime),
55
 
            long(fs.st_ctime), fs.st_ino, fs.st_dev, fs.st_mode)
56
45
 
57
46
 
58
47
class HashCache(object):
91
80
    """
92
81
    needs_write = False
93
82
 
94
 
    def __init__(self, basedir):
95
 
        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)
96
86
        self.hit_count = 0
97
87
        self.miss_count = 0
98
88
        self.stat_count = 0
100
90
        self.removed_count = 0
101
91
        self.update_count = 0
102
92
        self._cache = {}
103
 
 
 
93
        self._mode = mode
 
94
        self._cache_file_name = safe_unicode(cache_file_name)
104
95
 
105
96
    def cache_file_name(self):
106
 
        return os.sep.join([self.basedir, '.bzr', 'stat-cache'])
107
 
 
108
 
 
109
 
 
 
97
        return self._cache_file_name
110
98
 
111
99
    def clear(self):
112
100
        """Discard all cached information.
116
104
            self.needs_write = True
117
105
            self._cache = {}
118
106
 
119
 
 
120
107
    def scan(self):
121
108
        """Scan all files and remove entries where the cache entry is obsolete.
122
109
        
123
110
        Obsolete entries are those where the file has been modified or deleted
124
111
        since the entry was inserted.        
125
112
        """
 
113
        # FIXME optimisation opportunity, on linux [and check other oses]:
 
114
        # rather than iteritems order, stat in inode order.
126
115
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
127
116
        prep.sort()
128
117
        
129
118
        for inum, path, cache_entry in prep:
130
 
            abspath = os.sep.join([self.basedir, path])
131
 
            fp = _fingerprint(abspath)
 
119
            abspath = pathjoin(self.root, path)
 
120
            fp = self._fingerprint(abspath)
132
121
            self.stat_count += 1
133
122
            
134
123
            cache_fp = cache_entry[1]
139
128
                self.needs_write = True
140
129
                del self._cache[path]
141
130
 
142
 
 
143
131
    def get_sha1(self, path):
144
132
        """Return the sha1 of a file.
145
133
        """
146
 
        abspath = os.sep.join([self.basedir, path])
 
134
        abspath = pathjoin(self.root, path)
147
135
        self.stat_count += 1
148
 
        file_fp = _fingerprint(abspath)
 
136
        file_fp = self._fingerprint(abspath)
149
137
        
150
138
        if not file_fp:
151
139
            # not a regular file or not existing
161
149
            cache_sha1, cache_fp = None, None
162
150
 
163
151
        if cache_fp == file_fp:
 
152
            ## mutter("hashcache hit for %s %r -> %s", path, file_fp, cache_sha1)
 
153
            ## mutter("now = %s", time.time())
164
154
            self.hit_count += 1
165
155
            return cache_sha1
166
156
        
167
157
        self.miss_count += 1
168
158
 
169
 
 
170
159
        mode = file_fp[FP_MODE_COLUMN]
171
160
        if stat.S_ISREG(mode):
172
 
            digest = sha_file(file(abspath, 'rb', buffering=65000))
 
161
            digest = self._really_sha1_file(abspath)
173
162
        elif stat.S_ISLNK(mode):
174
 
            link_target = os.readlink(abspath)
175
163
            digest = sha.new(os.readlink(abspath)).hexdigest()
176
164
        else:
177
165
            raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
178
166
 
179
 
        now = int(time.time())
180
 
        if file_fp[1] >= now or file_fp[2] >= now:
 
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:
181
172
            # changed too recently; can't be cached.  we can
182
173
            # return the result and it could possibly be cached
183
174
            # next time.
184
 
            self.danger_count += 1 
 
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
185
185
            if cache_fp:
186
186
                self.removed_count += 1
187
187
                self.needs_write = True
188
188
                del self._cache[path]
189
189
        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])
190
193
            self.update_count += 1
191
194
            self.needs_write = True
192
195
            self._cache[path] = (digest, file_fp)
193
196
        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))
194
201
        
195
202
    def write(self):
196
203
        """Write contents of cache to file."""
197
 
        outf = AtomicFile(self.cache_file_name(), 'wb')
 
204
        outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
198
205
        try:
199
206
            print >>outf, CACHE_HEADER,
200
207
 
206
213
                for fld in c[1]:
207
214
                    print >>outf, "%d" % fld,
208
215
                print >>outf
209
 
 
210
216
            outf.commit()
211
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)
212
222
        finally:
213
223
            if not outf.closed:
214
224
                outf.abort()
215
 
        
216
 
 
217
225
 
218
226
    def read(self):
219
227
        """Reinstate cache from file.
228
236
        try:
229
237
            inf = file(fn, 'rb', buffering=65000)
230
238
        except IOError, e:
231
 
            mutter("failed to open %s: %s" % (fn, e))
 
239
            mutter("failed to open %s: %s", fn, e)
232
240
            # better write it now so it is valid
233
241
            self.needs_write = True
234
242
            return
235
243
 
236
 
 
237
244
        hdr = inf.readline()
238
245
        if hdr != CACHE_HEADER:
239
 
            mutter('cache header marker not found at top of %s; discarding cache'
240
 
                   % fn)
 
246
            mutter('cache header marker not found at top of %s;'
 
247
                   ' discarding cache', fn)
241
248
            self.needs_write = True
242
249
            return
243
250
 
264
271
            self._cache[path] = (sha1, fp)
265
272
 
266
273
        self.needs_write = False
 
274
 
 
275
    def _cutoff_time(self):
 
276
        """Return cutoff time.
 
277
 
 
278
        Files modified more recently than this time are at risk of being
 
279
        undetectably modified and so can't be cached.
 
280
        """
 
281
        return int(time.time()) - 3
267
282
           
268
 
 
269
 
 
270
 
        
 
283
    def _fingerprint(self, abspath):
 
284
        try:
 
285
            fs = os.lstat(abspath)
 
286
        except OSError:
 
287
            # might be missing, etc
 
288
            return None
 
289
        if stat.S_ISDIR(fs.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 (fs.st_size, long(fs.st_mtime),
 
294
                long(fs.st_ctime), fs.st_ino, fs.st_dev, fs.st_mode)