← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

Update news and readme

- better explanation of dependencies

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
36
36
from bzrlib.trace import mutter, warning
37
37
from bzrlib.atomicfile import AtomicFile
38
 
from bzrlib.errors import BzrError
39
 
 
40
 
 
41
 
FP_MTIME_COLUMN = 1
42
 
FP_CTIME_COLUMN = 2
 
38
 
 
39
 
43
40
FP_MODE_COLUMN = 5
44
41
 
 
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)
45
56
 
46
57
 
47
58
class HashCache(object):
80
91
    """
81
92
    needs_write = False
82
93
 
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 ?
 
94
    def __init__(self, basedir):
 
95
        self.basedir = basedir
87
96
        self.hit_count = 0
88
97
        self.miss_count = 0
89
98
        self.stat_count = 0
91
100
        self.removed_count = 0
92
101
        self.update_count = 0
93
102
        self._cache = {}
94
 
        self._mode = mode
95
 
        self._cache_file_name = safe_unicode(cache_file_name)
96
103
 
97
104
    def cache_file_name(self):
98
 
        return self._cache_file_name
 
105
        # FIXME: duplicate path logic here, this should be 
 
106
        # something like 'branch.controlfile'.
 
107
        return os.sep.join([self.basedir, '.bzr', 'stat-cache'])
99
108
 
100
109
    def clear(self):
101
110
        """Discard all cached information.
105
114
            self.needs_write = True
106
115
            self._cache = {}
107
116
 
 
117
 
108
118
    def scan(self):
109
119
        """Scan all files and remove entries where the cache entry is obsolete.
110
120
        
111
121
        Obsolete entries are those where the file has been modified or deleted
112
122
        since the entry was inserted.        
113
123
        """
114
 
        # FIXME optimisation opportunity, on linux [and check other oses]:
115
 
        # rather than iteritems order, stat in inode order.
116
124
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
117
125
        prep.sort()
118
126
        
119
127
        for inum, path, cache_entry in prep:
120
 
            abspath = pathjoin(self.root, path)
121
 
            fp = self._fingerprint(abspath)
 
128
            abspath = os.sep.join([self.basedir, path])
 
129
            fp = _fingerprint(abspath)
122
130
            self.stat_count += 1
123
131
            
124
132
            cache_fp = cache_entry[1]
129
137
                self.needs_write = True
130
138
                del self._cache[path]
131
139
 
132
 
    def get_sha1(self, path, stat_value=None):
 
140
 
 
141
    def get_sha1(self, path):
133
142
        """Return the sha1 of a file.
134
143
        """
135
 
        if path.__class__ is str:
136
 
            abspath = pathjoin(self.root_utf8, path)
137
 
        else:
138
 
            abspath = pathjoin(self.root, path)
 
144
        abspath = os.sep.join([self.basedir, path])
139
145
        self.stat_count += 1
140
 
        file_fp = self._fingerprint(abspath, stat_value)
 
146
        file_fp = _fingerprint(abspath)
141
147
        
142
148
        if not file_fp:
143
149
            # not a regular file or not existing
153
159
            cache_sha1, cache_fp = None, None
154
160
 
155
161
        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
162
            self.hit_count += 1
159
163
            return cache_sha1
160
164
        
161
165
        self.miss_count += 1
162
166
 
 
167
 
163
168
        mode = file_fp[FP_MODE_COLUMN]
164
169
        if stat.S_ISREG(mode):
165
 
            digest = self._really_sha1_file(abspath)
 
170
            digest = sha_file(file(abspath, 'rb', buffering=65000))
166
171
        elif stat.S_ISLNK(mode):
 
172
            link_target = os.readlink(abspath)
167
173
            digest = sha.new(os.readlink(abspath)).hexdigest()
168
174
        else:
169
175
            raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
170
176
 
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:
 
177
        now = int(time.time())
 
178
        if file_fp[1] >= now or file_fp[2] >= now:
176
179
            # changed too recently; can't be cached.  we can
177
180
            # return the result and it could possibly be cached
178
181
            # next time.
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
 
182
            self.danger_count += 1 
189
183
            if cache_fp:
190
184
                self.removed_count += 1
191
185
                self.needs_write = True
192
186
                del self._cache[path]
193
187
        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
188
            self.update_count += 1
198
189
            self.needs_write = True
199
190
            self._cache[path] = (digest, file_fp)
200
191
        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
192
        
206
193
    def write(self):
207
194
        """Write contents of cache to file."""
208
 
        outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
 
195
        outf = AtomicFile(self.cache_file_name(), 'wb')
209
196
        try:
210
 
            outf.write(CACHE_HEADER)
 
197
            print >>outf, CACHE_HEADER,
211
198
 
212
199
            for path, c  in self._cache.iteritems():
213
200
                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))
 
201
                outf.write(path.encode('utf-8'))
 
202
                outf.write('// ')
 
203
                print >>outf, c[0],     # hex sha1
 
204
                for fld in c[1]:
 
205
                    print >>outf, "%d" % fld,
 
206
                print >>outf
 
207
 
218
208
            outf.commit()
219
209
            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
210
        finally:
225
 
            outf.close()
 
211
            if not outf.closed:
 
212
                outf.abort()
 
213
        
 
214
 
226
215
 
227
216
    def read(self):
228
217
        """Reinstate cache from file.
237
226
        try:
238
227
            inf = file(fn, 'rb', buffering=65000)
239
228
        except IOError, e:
240
 
            mutter("failed to open %s: %s", fn, e)
 
229
            mutter("failed to open %s: %s" % (fn, e))
241
230
            # better write it now so it is valid
242
231
            self.needs_write = True
243
232
            return
244
233
 
 
234
 
245
235
        hdr = inf.readline()
246
236
        if hdr != CACHE_HEADER:
247
 
            mutter('cache header marker not found at top of %s;'
248
 
                   ' discarding cache', fn)
 
237
            mutter('cache header marker not found at top of %s; discarding cache'
 
238
                   % fn)
249
239
            self.needs_write = True
250
240
            return
251
241
 
272
262
            self._cache[path] = (sha1, fp)
273
263
 
274
264
        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
265
           
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)
 
266
 
 
267
 
 
268