← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

(mbp) merge bzr.dev to 0.8, prepare for release

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/hashcache.py
1
 
# (C) 2005 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 by Canonical Ltd
2
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
32
32
import os, stat, time
33
33
import sha
34
34
 
35
 
from bzrlib.osutils import sha_file
 
35
from bzrlib.osutils import sha_file, pathjoin, safe_unicode
36
36
from bzrlib.trace import mutter, warning
37
37
from bzrlib.atomicfile import AtomicFile
38
 
 
39
 
 
 
38
from bzrlib.errors import BzrError
 
39
 
 
40
 
 
41
FP_MTIME_COLUMN = 1
 
42
FP_CTIME_COLUMN = 2
40
43
FP_MODE_COLUMN = 5
41
44
 
42
45
def _fingerprint(abspath):
91
94
    """
92
95
    needs_write = False
93
96
 
94
 
    def __init__(self, basedir):
95
 
        self.basedir = basedir
 
97
    def __init__(self, root, cache_file_name, mode=None):
 
98
        """Create a hash cache in base dir, and set the file mode to mode."""
 
99
        self.root = safe_unicode(root)
96
100
        self.hit_count = 0
97
101
        self.miss_count = 0
98
102
        self.stat_count = 0
100
104
        self.removed_count = 0
101
105
        self.update_count = 0
102
106
        self._cache = {}
 
107
        self._mode = mode
 
108
        self._cache_file_name = safe_unicode(cache_file_name)
103
109
 
104
110
    def cache_file_name(self):
105
 
        # FIXME: duplicate path logic here, this should be 
106
 
        # something like 'branch.controlfile'.
107
 
        return os.sep.join([self.basedir, '.bzr', 'stat-cache'])
 
111
        return self._cache_file_name
108
112
 
109
113
    def clear(self):
110
114
        """Discard all cached information.
114
118
            self.needs_write = True
115
119
            self._cache = {}
116
120
 
117
 
 
118
121
    def scan(self):
119
122
        """Scan all files and remove entries where the cache entry is obsolete.
120
123
        
121
124
        Obsolete entries are those where the file has been modified or deleted
122
125
        since the entry was inserted.        
123
126
        """
 
127
        # FIXME optimisation opportunity, on linux [and check other oses]:
 
128
        # rather than iteritems order, stat in inode order.
124
129
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
125
130
        prep.sort()
126
131
        
127
132
        for inum, path, cache_entry in prep:
128
 
            abspath = os.sep.join([self.basedir, path])
 
133
            abspath = pathjoin(self.root, path)
129
134
            fp = _fingerprint(abspath)
130
135
            self.stat_count += 1
131
136
            
141
146
    def get_sha1(self, path):
142
147
        """Return the sha1 of a file.
143
148
        """
144
 
        abspath = os.sep.join([self.basedir, path])
 
149
        abspath = pathjoin(self.root, path)
145
150
        self.stat_count += 1
146
151
        file_fp = _fingerprint(abspath)
147
152
        
169
174
        if stat.S_ISREG(mode):
170
175
            digest = sha_file(file(abspath, 'rb', buffering=65000))
171
176
        elif stat.S_ISLNK(mode):
172
 
            link_target = os.readlink(abspath)
173
177
            digest = sha.new(os.readlink(abspath)).hexdigest()
174
178
        else:
175
179
            raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
176
180
 
177
181
        now = int(time.time())
178
 
        if file_fp[1] >= now or file_fp[2] >= now:
 
182
        if file_fp[FP_MTIME_COLUMN] >= now or file_fp[FP_CTIME_COLUMN] >= now:
179
183
            # changed too recently; can't be cached.  we can
180
184
            # return the result and it could possibly be cached
181
185
            # next time.
 
186
            #
 
187
            # the point is that we only want to cache when we are sure that any
 
188
            # subsequent modifications of the file can be detected.  If a
 
189
            # modification neither changes the inode, the device, the size, nor
 
190
            # the mode, then we can only distinguish it by time; therefore we
 
191
            # need to let sufficient time elapse before we may cache this entry
 
192
            # again.  If we didn't do this, then, for example, a very quick 1
 
193
            # byte replacement in the file might go undetected.
182
194
            self.danger_count += 1 
183
195
            if cache_fp:
184
196
                self.removed_count += 1
192
204
        
193
205
    def write(self):
194
206
        """Write contents of cache to file."""
195
 
        outf = AtomicFile(self.cache_file_name(), 'wb')
 
207
        outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
196
208
        try:
197
209
            print >>outf, CACHE_HEADER,
198
210
 
204
216
                for fld in c[1]:
205
217
                    print >>outf, "%d" % fld,
206
218
                print >>outf
207
 
 
208
219
            outf.commit()
209
220
            self.needs_write = False
 
221
            mutter("write hash cache: %s hits=%d misses=%d stat=%d recent=%d updates=%d",
 
222
                   self.cache_file_name(), self.hit_count, self.miss_count,
 
223
                   self.stat_count,
 
224
                   self.danger_count, self.update_count)
210
225
        finally:
211
226
            if not outf.closed:
212
227
                outf.abort()
213
 
        
214
 
 
215
228
 
216
229
    def read(self):
217
230
        """Reinstate cache from file.
226
239
        try:
227
240
            inf = file(fn, 'rb', buffering=65000)
228
241
        except IOError, e:
229
 
            mutter("failed to open %s: %s" % (fn, e))
 
242
            mutter("failed to open %s: %s", fn, e)
230
243
            # better write it now so it is valid
231
244
            self.needs_write = True
232
245
            return
234
247
 
235
248
        hdr = inf.readline()
236
249
        if hdr != CACHE_HEADER:
237
 
            mutter('cache header marker not found at top of %s; discarding cache'
238
 
                   % fn)
 
250
            mutter('cache header marker not found at top of %s;'
 
251
                   ' discarding cache', fn)
239
252
            self.needs_write = True
240
253
            return
241
254