← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

[merge] land Robert's branch-formats branch

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
32
32
import os, stat, time
33
33
import sha
34
34
 
35
 
from bzrlib.osutils import sha_file, pathjoin, safe_unicode
 
35
from bzrlib.osutils import sha_file, pathjoin
36
36
from bzrlib.trace import mutter, warning
37
37
from bzrlib.atomicfile import AtomicFile
38
38
from bzrlib.errors import BzrError
42
42
FP_CTIME_COLUMN = 2
43
43
FP_MODE_COLUMN = 5
44
44
 
 
45
def _fingerprint(abspath):
 
46
    try:
 
47
        fs = os.lstat(abspath)
 
48
    except OSError:
 
49
        # might be missing, etc
 
50
        return None
 
51
 
 
52
    if stat.S_ISDIR(fs.st_mode):
 
53
        return None
 
54
 
 
55
    # we discard any high precision because it's not reliable; perhaps we
 
56
    # could do better on some systems?
 
57
    return (fs.st_size, long(fs.st_mtime),
 
58
            long(fs.st_ctime), fs.st_ino, fs.st_dev, fs.st_mode)
45
59
 
46
60
 
47
61
class HashCache(object):
80
94
    """
81
95
    needs_write = False
82
96
 
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 ?
 
97
    def __init__(self, basedir):
 
98
        self.basedir = basedir
87
99
        self.hit_count = 0
88
100
        self.miss_count = 0
89
101
        self.stat_count = 0
91
103
        self.removed_count = 0
92
104
        self.update_count = 0
93
105
        self._cache = {}
94
 
        self._mode = mode
95
 
        self._cache_file_name = safe_unicode(cache_file_name)
96
106
 
97
107
    def cache_file_name(self):
98
 
        return self._cache_file_name
 
108
        # FIXME: duplicate path logic here, this should be 
 
109
        # something like 'branch.controlfile'.
 
110
        return pathjoin(self.basedir, '.bzr', 'stat-cache')
99
111
 
100
112
    def clear(self):
101
113
        """Discard all cached information.
105
117
            self.needs_write = True
106
118
            self._cache = {}
107
119
 
 
120
 
108
121
    def scan(self):
109
122
        """Scan all files and remove entries where the cache entry is obsolete.
110
123
        
111
124
        Obsolete entries are those where the file has been modified or deleted
112
125
        since the entry was inserted.        
113
126
        """
114
 
        # FIXME optimisation opportunity, on linux [and check other oses]:
115
 
        # rather than iteritems order, stat in inode order.
116
127
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
117
128
        prep.sort()
118
129
        
119
130
        for inum, path, cache_entry in prep:
120
 
            abspath = pathjoin(self.root, path)
121
 
            fp = self._fingerprint(abspath)
 
131
            abspath = pathjoin(self.basedir, path)
 
132
            fp = _fingerprint(abspath)
122
133
            self.stat_count += 1
123
134
            
124
135
            cache_fp = cache_entry[1]
129
140
                self.needs_write = True
130
141
                del self._cache[path]
131
142
 
132
 
    def get_sha1(self, path, stat_value=None):
 
143
 
 
144
    def get_sha1(self, path):
133
145
        """Return the sha1 of a file.
134
146
        """
135
 
        if path.__class__ is str:
136
 
            abspath = pathjoin(self.root_utf8, path)
137
 
        else:
138
 
            abspath = pathjoin(self.root, path)
 
147
        abspath = pathjoin(self.basedir, path)
139
148
        self.stat_count += 1
140
 
        file_fp = self._fingerprint(abspath, stat_value)
 
149
        file_fp = _fingerprint(abspath)
141
150
        
142
151
        if not file_fp:
143
152
            # not a regular file or not existing
153
162
            cache_sha1, cache_fp = None, None
154
163
 
155
164
        if cache_fp == file_fp:
156
 
            ## mutter("hashcache hit for %s %r -> %s", path, file_fp, cache_sha1)
157
 
            ## mutter("now = %s", time.time())
158
165
            self.hit_count += 1
159
166
            return cache_sha1
160
167
        
161
168
        self.miss_count += 1
162
169
 
 
170
 
163
171
        mode = file_fp[FP_MODE_COLUMN]
164
172
        if stat.S_ISREG(mode):
165
 
            digest = self._really_sha1_file(abspath)
 
173
            digest = sha_file(file(abspath, 'rb', buffering=65000))
166
174
        elif stat.S_ISLNK(mode):
167
175
            digest = sha.new(os.readlink(abspath)).hexdigest()
168
176
        else:
169
177
            raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
170
178
 
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:
 
179
        now = int(time.time())
 
180
        if file_fp[FP_MTIME_COLUMN] >= now or file_fp[FP_CTIME_COLUMN] >= now:
176
181
            # changed too recently; can't be cached.  we can
177
182
            # return the result and it could possibly be cached
178
183
            # next time.
184
189
            # need to let sufficient time elapse before we may cache this entry
185
190
            # again.  If we didn't do this, then, for example, a very quick 1
186
191
            # byte replacement in the file might go undetected.
187
 
            ## mutter('%r modified too recently; not caching', path)
188
 
            self.danger_count += 1
 
192
            self.danger_count += 1 
189
193
            if cache_fp:
190
194
                self.removed_count += 1
191
195
                self.needs_write = True
192
196
                del self._cache[path]
193
197
        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])
197
198
            self.update_count += 1
198
199
            self.needs_write = True
199
200
            self._cache[path] = (digest, file_fp)
200
201
        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))
205
202
        
206
203
    def write(self):
207
204
        """Write contents of cache to file."""
208
 
        outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
 
205
        outf = AtomicFile(self.cache_file_name(), 'wb')
209
206
        try:
210
 
            outf.write(CACHE_HEADER)
 
207
            print >>outf, CACHE_HEADER,
211
208
 
212
209
            for path, c  in self._cache.iteritems():
213
210
                assert '//' not in path, path
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))
 
211
                outf.write(path.encode('utf-8'))
 
212
                outf.write('// ')
 
213
                print >>outf, c[0],     # hex sha1
 
214
                for fld in c[1]:
 
215
                    print >>outf, "%d" % fld,
 
216
                print >>outf
 
217
 
218
218
            outf.commit()
219
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)
224
220
        finally:
225
 
            outf.close()
 
221
            if not outf.closed:
 
222
                outf.abort()
226
223
 
227
224
    def read(self):
228
225
        """Reinstate cache from file.
242
239
            self.needs_write = True
243
240
            return
244
241
 
 
242
 
245
243
        hdr = inf.readline()
246
244
        if hdr != CACHE_HEADER:
247
245
            mutter('cache header marker not found at top of %s;'
272
270
            self._cache[path] = (sha1, fp)
273
271
 
274
272
        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
283
273
           
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)
 
274
 
 
275
 
 
276