← 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 12:29:27 UTC
  • Revision ID: mbp@sourcefrog.net-20050729122927-d51c2cedc14dd5d5
doc

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
31
 
34
 
from bzrlib.osutils import sha_file, sha_string, pathjoin, safe_unicode
 
32
from bzrlib.osutils import sha_file
35
33
from bzrlib.trace import mutter, warning
36
 
from bzrlib.atomicfile import AtomicFile
37
 
from bzrlib.errors import BzrError
38
 
 
39
 
 
40
 
FP_MTIME_COLUMN = 1
41
 
FP_CTIME_COLUMN = 2
42
 
FP_MODE_COLUMN = 5
43
 
 
 
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)
44
51
 
45
52
 
46
53
class HashCache(object):
79
86
    """
80
87
    needs_write = False
81
88
 
82
 
    def __init__(self, root, cache_file_name, mode=None):
83
 
        """Create a hash cache in base dir, and set the file mode to mode."""
84
 
        self.root = safe_unicode(root)
85
 
        self.root_utf8 = self.root.encode('utf8') # where is the filesystem encoding ?
 
89
    def __init__(self, basedir):
 
90
        self.basedir = basedir
86
91
        self.hit_count = 0
87
92
        self.miss_count = 0
88
93
        self.stat_count = 0
90
95
        self.removed_count = 0
91
96
        self.update_count = 0
92
97
        self._cache = {}
93
 
        self._mode = mode
94
 
        self._cache_file_name = safe_unicode(cache_file_name)
 
98
 
95
99
 
96
100
    def cache_file_name(self):
97
 
        return self._cache_file_name
 
101
        return os.sep.join([self.basedir, '.bzr', 'stat-cache'])
 
102
 
 
103
 
 
104
 
98
105
 
99
106
    def clear(self):
100
107
        """Discard all cached information.
104
111
            self.needs_write = True
105
112
            self._cache = {}
106
113
 
 
114
 
107
115
    def scan(self):
108
116
        """Scan all files and remove entries where the cache entry is obsolete.
109
117
        
110
118
        Obsolete entries are those where the file has been modified or deleted
111
119
        since the entry was inserted.        
112
120
        """
113
 
        # FIXME optimisation opportunity, on linux [and check other oses]:
114
 
        # rather than iteritems order, stat in inode order.
115
121
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
116
122
        prep.sort()
117
123
        
118
124
        for inum, path, cache_entry in prep:
119
 
            abspath = pathjoin(self.root, path)
120
 
            fp = self._fingerprint(abspath)
 
125
            abspath = os.sep.join([self.basedir, path])
 
126
            fp = _fingerprint(abspath)
121
127
            self.stat_count += 1
122
128
            
123
129
            cache_fp = cache_entry[1]
128
134
                self.needs_write = True
129
135
                del self._cache[path]
130
136
 
131
 
    def get_sha1(self, path, stat_value=None):
 
137
 
 
138
 
 
139
    def get_sha1(self, path):
132
140
        """Return the sha1 of a file.
133
141
        """
134
 
        if path.__class__ is str:
135
 
            abspath = pathjoin(self.root_utf8, path)
136
 
        else:
137
 
            abspath = pathjoin(self.root, path)
 
142
        abspath = os.sep.join([self.basedir, path])
138
143
        self.stat_count += 1
139
 
        file_fp = self._fingerprint(abspath, stat_value)
 
144
        file_fp = _fingerprint(abspath)
140
145
        
141
146
        if not file_fp:
142
147
            # not a regular file or not existing
152
157
            cache_sha1, cache_fp = None, None
153
158
 
154
159
        if cache_fp == file_fp:
155
 
            ## mutter("hashcache hit for %s %r -> %s", path, file_fp, cache_sha1)
156
 
            ## mutter("now = %s", time.time())
157
160
            self.hit_count += 1
158
161
            return cache_sha1
159
162
        
160
163
        self.miss_count += 1
161
 
 
162
 
        mode = file_fp[FP_MODE_COLUMN]
163
 
        if stat.S_ISREG(mode):
164
 
            digest = self._really_sha1_file(abspath)
165
 
        elif stat.S_ISLNK(mode):
166
 
            digest = sha_string(os.readlink(abspath))
167
 
        else:
168
 
            raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
169
 
 
170
 
        # window of 3 seconds to allow for 2s resolution on windows,
171
 
        # unsynchronized file servers, etc.
172
 
        cutoff = self._cutoff_time()
173
 
        if file_fp[FP_MTIME_COLUMN] >= cutoff \
174
 
                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:
175
168
            # changed too recently; can't be cached.  we can
176
169
            # return the result and it could possibly be cached
177
170
            # next time.
178
 
            #
179
 
            # the point is that we only want to cache when we are sure that any
180
 
            # subsequent modifications of the file can be detected.  If a
181
 
            # modification neither changes the inode, the device, the size, nor
182
 
            # the mode, then we can only distinguish it by time; therefore we
183
 
            # need to let sufficient time elapse before we may cache this entry
184
 
            # again.  If we didn't do this, then, for example, a very quick 1
185
 
            # byte replacement in the file might go undetected.
186
 
            ## mutter('%r modified too recently; not caching', path)
187
 
            self.danger_count += 1
 
171
            self.danger_count += 1 
188
172
            if cache_fp:
189
173
                self.removed_count += 1
190
174
                self.needs_write = True
191
175
                del self._cache[path]
192
176
        else:
193
 
            ## mutter('%r added to cache: now=%f, mtime=%d, ctime=%d',
194
 
            ##        path, time.time(), file_fp[FP_MTIME_COLUMN],
195
 
            ##        file_fp[FP_CTIME_COLUMN])
196
177
            self.update_count += 1
197
178
            self.needs_write = True
198
179
            self._cache[path] = (digest, file_fp)
 
180
        
199
181
        return digest
200
 
 
201
 
    def _really_sha1_file(self, abspath):
202
 
        """Calculate the SHA1 of a file by reading the full text"""
203
 
        return sha_file(file(abspath, 'rb', buffering=65000))
204
182
        
 
183
 
 
184
 
 
185
 
205
186
    def write(self):
206
187
        """Write contents of cache to file."""
207
 
        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')
208
191
        try:
209
 
            outf.write(CACHE_HEADER)
 
192
            print >>outf, CACHE_HEADER,
210
193
 
211
194
            for path, c  in self._cache.iteritems():
212
 
                line_info = [path.encode('utf-8'), '// ', c[0], ' ']
213
 
                line_info.append(' '.join([str(fld) for fld in c[1]]))
214
 
                line_info.append('\n')
215
 
                outf.write(''.join(line_info))
 
195
                assert '//' not in path, path
 
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
 
216
203
            outf.commit()
217
204
            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)
222
205
        finally:
223
 
            outf.close()
 
206
            if not outf.closed:
 
207
                outf.abort()
 
208
        
 
209
 
224
210
 
225
211
    def read(self):
226
212
        """Reinstate cache from file.
235
221
        try:
236
222
            inf = file(fn, 'rb', buffering=65000)
237
223
        except IOError, e:
238
 
            mutter("failed to open %s: %s", fn, e)
239
 
            # better write it now so it is valid
240
 
            self.needs_write = True
 
224
            mutter("failed to open %s: %s" % (fn, e))
241
225
            return
242
226
 
 
227
 
243
228
        hdr = inf.readline()
244
229
        if hdr != CACHE_HEADER:
245
 
            mutter('cache header marker not found at top of %s;'
246
 
                   ' discarding cache', fn)
247
 
            self.needs_write = True
 
230
            mutter('cache header marker not found at top of %s; discarding cache'
 
231
                   % fn)
248
232
            return
249
233
 
250
234
        for l in inf:
256
240
 
257
241
            pos += 3
258
242
            fields = l[pos:].split(' ')
259
 
            if len(fields) != 7:
 
243
            if len(fields) != 6:
260
244
                warning("bad line in hashcache: %r" % l)
261
245
                continue
262
246
 
270
254
            self._cache[path] = (sha1, fp)
271
255
 
272
256
        self.needs_write = False
273
 
 
274
 
    def _cutoff_time(self):
275
 
        """Return cutoff time.
276
 
 
277
 
        Files modified more recently than this time are at risk of being
278
 
        undetectably modified and so can't be cached.
279
 
        """
280
 
        return int(time.time()) - 3
281
257
           
282
 
    def _fingerprint(self, abspath, stat_value=None):
283
 
        if stat_value is None:
284
 
            try:
285
 
                stat_value = os.lstat(abspath)
286
 
            except OSError:
287
 
                # might be missing, etc
288
 
                return None
289
 
        if stat.S_ISDIR(stat_value.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 (stat_value.st_size, long(stat_value.st_mtime),
294
 
                long(stat_value.st_ctime), stat_value.st_ino, 
295
 
                stat_value.st_dev, stat_value.st_mode)
 
258
 
 
259
 
 
260