← 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-12 09:50:44 UTC
  • Revision ID: mbp@sourcefrog.net-20050912095044-6acfdb5611729987
- no tests in bzrlib.fetch anymore

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)
86
 
        self.root_utf8 = self.root.encode('utf8') # where is the filesystem encoding ?
 
93
    def __init__(self, basedir):
 
94
        self.basedir = basedir
87
95
        self.hit_count = 0
88
96
        self.miss_count = 0
89
97
        self.stat_count = 0
91
99
        self.removed_count = 0
92
100
        self.update_count = 0
93
101
        self._cache = {}
94
 
        self._mode = mode
95
 
        self._cache_file_name = safe_unicode(cache_file_name)
 
102
 
96
103
 
97
104
    def cache_file_name(self):
98
 
        return self._cache_file_name
 
105
        return os.sep.join([self.basedir, '.bzr', 'stat-cache'])
 
106
 
 
107
 
 
108
 
99
109
 
100
110
    def clear(self):
101
111
        """Discard all cached information.
105
115
            self.needs_write = True
106
116
            self._cache = {}
107
117
 
 
118
 
108
119
    def scan(self):
109
120
        """Scan all files and remove entries where the cache entry is obsolete.
110
121
        
111
122
        Obsolete entries are those where the file has been modified or deleted
112
123
        since the entry was inserted.        
113
124
        """
114
 
        # FIXME optimisation opportunity, on linux [and check other oses]:
115
 
        # rather than iteritems order, stat in inode order.
116
125
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
117
126
        prep.sort()
118
127
        
119
128
        for inum, path, cache_entry in prep:
120
 
            abspath = pathjoin(self.root, path)
121
 
            fp = self._fingerprint(abspath)
 
129
            abspath = os.sep.join([self.basedir, path])
 
130
            fp = _fingerprint(abspath)
122
131
            self.stat_count += 1
123
132
            
124
133
            cache_fp = cache_entry[1]
129
138
                self.needs_write = True
130
139
                del self._cache[path]
131
140
 
132
 
    def get_sha1(self, path, stat_value=None):
 
141
 
 
142
 
 
143
    def get_sha1(self, path):
133
144
        """Return the sha1 of a file.
134
145
        """
135
 
        if path.__class__ is str:
136
 
            abspath = pathjoin(self.root_utf8, path)
137
 
        else:
138
 
            abspath = pathjoin(self.root, path)
 
146
        abspath = os.sep.join([self.basedir, path])
139
147
        self.stat_count += 1
140
 
        file_fp = self._fingerprint(abspath, stat_value)
 
148
        file_fp = _fingerprint(abspath)
141
149
        
142
150
        if not file_fp:
143
151
            # not a regular file or not existing
153
161
            cache_sha1, cache_fp = None, None
154
162
 
155
163
        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
164
            self.hit_count += 1
159
165
            return cache_sha1
160
166
        
161
167
        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:
 
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:
176
172
            # changed too recently; can't be cached.  we can
177
173
            # return the result and it could possibly be cached
178
174
            # 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
 
175
            self.danger_count += 1 
189
176
            if cache_fp:
190
177
                self.removed_count += 1
191
178
                self.needs_write = True
192
179
                del self._cache[path]
193
180
        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
181
            self.update_count += 1
198
182
            self.needs_write = True
199
183
            self._cache[path] = (digest, file_fp)
 
184
        
200
185
        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
186
        
 
187
 
 
188
 
 
189
 
206
190
    def write(self):
207
191
        """Write contents of cache to file."""
208
 
        outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
 
192
        outf = AtomicFile(self.cache_file_name(), 'wb')
209
193
        try:
210
 
            outf.write(CACHE_HEADER)
 
194
            print >>outf, CACHE_HEADER,
211
195
 
212
196
            for path, c  in self._cache.iteritems():
213
197
                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))
 
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
 
218
205
            outf.commit()
219
206
            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
207
        finally:
225
 
            outf.close()
 
208
            if not outf.closed:
 
209
                outf.abort()
 
210
        
 
211
 
226
212
 
227
213
    def read(self):
228
214
        """Reinstate cache from file.
237
223
        try:
238
224
            inf = file(fn, 'rb', buffering=65000)
239
225
        except IOError, e:
240
 
            mutter("failed to open %s: %s", fn, e)
 
226
            mutter("failed to open %s: %s" % (fn, e))
241
227
            # better write it now so it is valid
242
228
            self.needs_write = True
243
229
            return
244
230
 
 
231
 
245
232
        hdr = inf.readline()
246
233
        if hdr != CACHE_HEADER:
247
 
            mutter('cache header marker not found at top of %s;'
248
 
                   ' discarding cache', fn)
 
234
            mutter('cache header marker not found at top of %s; discarding cache'
 
235
                   % fn)
249
236
            self.needs_write = True
250
237
            return
251
238
 
258
245
 
259
246
            pos += 3
260
247
            fields = l[pos:].split(' ')
261
 
            if len(fields) != 7:
 
248
            if len(fields) != 6:
262
249
                warning("bad line in hashcache: %r" % l)
263
250
                continue
264
251
 
272
259
            self._cache[path] = (sha1, fp)
273
260
 
274
261
        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
262
           
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)
 
263
 
 
264
 
 
265