← 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-07-29 19:53:21 UTC
  • Revision ID: mbp@sourcefrog.net-20050729195321-6d9eef1a43dd6c81
- notes from discussion on splitting and joining files

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
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
44
 
 
 
34
 
 
35
 
 
36
 
 
37
def _fingerprint(abspath):
 
38
    try:
 
39
        fs = os.lstat(abspath)
 
40
    except OSError:
 
41
        # might be missing, etc
 
42
        return None
 
43
 
 
44
    if stat.S_ISDIR(fs.st_mode):
 
45
        return None
 
46
 
 
47
    # we discard any high precision because it's not reliable; perhaps we
 
48
    # could do better on some systems?
 
49
    return (fs.st_size, long(fs.st_mtime),
 
50
            long(fs.st_ctime), fs.st_ino, fs.st_dev)
45
51
 
46
52
 
47
53
class HashCache(object):
80
86
    """
81
87
    needs_write = False
82
88
 
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 ?
 
89
    def __init__(self, basedir):
 
90
        self.basedir = basedir
87
91
        self.hit_count = 0
88
92
        self.miss_count = 0
89
93
        self.stat_count = 0
91
95
        self.removed_count = 0
92
96
        self.update_count = 0
93
97
        self._cache = {}
94
 
        self._mode = mode
95
 
        self._cache_file_name = safe_unicode(cache_file_name)
 
98
 
96
99
 
97
100
    def cache_file_name(self):
98
 
        return self._cache_file_name
 
101
        return os.sep.join([self.basedir, '.bzr', 'stat-cache'])
 
102
 
 
103
 
 
104
 
99
105
 
100
106
    def clear(self):
101
107
        """Discard all cached information.
105
111
            self.needs_write = True
106
112
            self._cache = {}
107
113
 
 
114
 
108
115
    def scan(self):
109
116
        """Scan all files and remove entries where the cache entry is obsolete.
110
117
        
111
118
        Obsolete entries are those where the file has been modified or deleted
112
119
        since the entry was inserted.        
113
120
        """
114
 
        # FIXME optimisation opportunity, on linux [and check other oses]:
115
 
        # rather than iteritems order, stat in inode order.
116
121
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
117
122
        prep.sort()
118
123
        
119
124
        for inum, path, cache_entry in prep:
120
 
            abspath = pathjoin(self.root, path)
121
 
            fp = self._fingerprint(abspath)
 
125
            abspath = os.sep.join([self.basedir, path])
 
126
            fp = _fingerprint(abspath)
122
127
            self.stat_count += 1
123
128
            
124
129
            cache_fp = cache_entry[1]
129
134
                self.needs_write = True
130
135
                del self._cache[path]
131
136
 
132
 
    def get_sha1(self, path, stat_value=None):
 
137
 
 
138
 
 
139
    def get_sha1(self, path):
133
140
        """Return the sha1 of a file.
134
141
        """
135
 
        if path.__class__ is str:
136
 
            abspath = pathjoin(self.root_utf8, path)
137
 
        else:
138
 
            abspath = pathjoin(self.root, path)
 
142
        abspath = os.sep.join([self.basedir, path])
139
143
        self.stat_count += 1
140
 
        file_fp = self._fingerprint(abspath, stat_value)
 
144
        file_fp = _fingerprint(abspath)
141
145
        
142
146
        if not file_fp:
143
147
            # not a regular file or not existing
153
157
            cache_sha1, cache_fp = None, None
154
158
 
155
159
        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
160
            self.hit_count += 1
159
161
            return cache_sha1
160
162
        
161
163
        self.miss_count += 1
162
 
 
163
 
        mode = file_fp[FP_MODE_COLUMN]
164
 
        if stat.S_ISREG(mode):
165
 
            digest = self._really_sha1_file(abspath)
166
 
        elif stat.S_ISLNK(mode):
167
 
            digest = sha.new(os.readlink(abspath)).hexdigest()
168
 
        else:
169
 
            raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
170
 
 
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:
 
164
        digest = sha_file(file(abspath, 'rb', buffering=65000))
 
165
 
 
166
        now = int(time.time())
 
167
        if file_fp[1] >= now or file_fp[2] >= now:
176
168
            # changed too recently; can't be cached.  we can
177
169
            # return the result and it could possibly be cached
178
170
            # 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
 
171
            self.danger_count += 1 
189
172
            if cache_fp:
190
173
                self.removed_count += 1
191
174
                self.needs_write = True
192
175
                del self._cache[path]
193
176
        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
177
            self.update_count += 1
198
178
            self.needs_write = True
199
179
            self._cache[path] = (digest, file_fp)
 
180
        
200
181
        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
182
        
 
183
 
 
184
 
 
185
 
206
186
    def write(self):
207
187
        """Write contents of cache to file."""
208
 
        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')
209
191
        try:
210
 
            outf.write(CACHE_HEADER)
 
192
            print >>outf, CACHE_HEADER,
211
193
 
212
194
            for path, c  in self._cache.iteritems():
213
195
                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))
 
196
                outf.write(path.encode('utf-8'))
 
197
                outf.write('// ')
 
198
                print >>outf, c[0],     # hex sha1
 
199
                for fld in c[1]:
 
200
                    print >>outf, "%d" % fld,
 
201
                print >>outf
 
202
 
218
203
            outf.commit()
219
204
            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
205
        finally:
225
 
            outf.close()
 
206
            if not outf.closed:
 
207
                outf.abort()
 
208
        
 
209
 
226
210
 
227
211
    def read(self):
228
212
        """Reinstate cache from file.
237
221
        try:
238
222
            inf = file(fn, 'rb', buffering=65000)
239
223
        except IOError, e:
240
 
            mutter("failed to open %s: %s", fn, e)
241
 
            # better write it now so it is valid
242
 
            self.needs_write = True
 
224
            mutter("failed to open %s: %s" % (fn, e))
243
225
            return
244
226
 
 
227
 
245
228
        hdr = inf.readline()
246
229
        if hdr != CACHE_HEADER:
247
 
            mutter('cache header marker not found at top of %s;'
248
 
                   ' discarding cache', fn)
249
 
            self.needs_write = True
 
230
            mutter('cache header marker not found at top of %s; discarding cache'
 
231
                   % fn)
250
232
            return
251
233
 
252
234
        for l in inf:
258
240
 
259
241
            pos += 3
260
242
            fields = l[pos:].split(' ')
261
 
            if len(fields) != 7:
 
243
            if len(fields) != 6:
262
244
                warning("bad line in hashcache: %r" % l)
263
245
                continue
264
246
 
272
254
            self._cache[path] = (sha1, fp)
273
255
 
274
256
        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
257
           
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)
 
258
 
 
259
 
 
260