← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-03-16 14:01:20 UTC
  • mfrom: (3280.2.5 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20080316140120-i3yq8yr1l66m11h7
Start 1.4 development

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/hashcache.py
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
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
# TODO: Up-front, stat all files in order and remove those which are deleted or
18
 
# out-of-date.  Don't actually re-read them until they're needed.  That ought
19
 
# to bring all the inodes into core so that future stats to them are fast, and
 
17
# TODO: Up-front, stat all files in order and remove those which are deleted or 
 
18
# out-of-date.  Don't actually re-read them until they're needed.  That ought 
 
19
# to bring all the inodes into core so that future stats to them are fast, and 
20
20
# it preserves the nice property that any caller will always get up-to-date
21
21
# data except in unavoidable cases.
22
22
 
29
29
 
30
30
CACHE_HEADER = "### bzr hashcache v5\n"
31
31
 
32
 
import os
33
 
import stat
34
 
import time
 
32
import os, stat, time
 
33
import sha
35
34
 
36
 
from bzrlib import (
37
 
    atomicfile,
38
 
    errors,
39
 
    filters as _mod_filters,
40
 
    osutils,
41
 
    trace,
42
 
    )
 
35
from bzrlib.osutils import sha_file, pathjoin, safe_unicode
 
36
from bzrlib.trace import mutter, warning
 
37
from bzrlib.atomicfile import AtomicFile
 
38
from bzrlib.errors import BzrError
43
39
 
44
40
 
45
41
FP_MTIME_COLUMN = 1
78
74
    hit_count
79
75
        number of times files have been retrieved from the cache, avoiding a
80
76
        re-read
81
 
 
 
77
        
82
78
    miss_count
83
79
        number of misses (times files have been completely re-read)
84
80
    """
85
81
    needs_write = False
86
82
 
87
 
    def __init__(self, root, cache_file_name, mode=None,
88
 
            content_filter_stack_provider=None):
89
 
        """Create a hash cache in base dir, and set the file mode to mode.
90
 
 
91
 
        :param content_filter_stack_provider: a function that takes a
92
 
            path (relative to the top of the tree) and a file-id as
93
 
            parameters and returns a stack of ContentFilters.
94
 
            If None, no content filtering is performed.
95
 
        """
96
 
        self.root = osutils.safe_unicode(root)
 
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)
97
86
        self.root_utf8 = self.root.encode('utf8') # where is the filesystem encoding ?
98
87
        self.hit_count = 0
99
88
        self.miss_count = 0
103
92
        self.update_count = 0
104
93
        self._cache = {}
105
94
        self._mode = mode
106
 
        self._cache_file_name = osutils.safe_unicode(cache_file_name)
107
 
        self._filter_provider = content_filter_stack_provider
 
95
        self._cache_file_name = safe_unicode(cache_file_name)
108
96
 
109
97
    def cache_file_name(self):
110
98
        return self._cache_file_name
119
107
 
120
108
    def scan(self):
121
109
        """Scan all files and remove entries where the cache entry is obsolete.
122
 
 
 
110
        
123
111
        Obsolete entries are those where the file has been modified or deleted
124
 
        since the entry was inserted.
 
112
        since the entry was inserted.        
125
113
        """
126
114
        # FIXME optimisation opportunity, on linux [and check other oses]:
127
115
        # rather than iteritems order, stat in inode order.
128
116
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
129
117
        prep.sort()
130
 
 
 
118
        
131
119
        for inum, path, cache_entry in prep:
132
 
            abspath = osutils.pathjoin(self.root, path)
 
120
            abspath = pathjoin(self.root, path)
133
121
            fp = self._fingerprint(abspath)
134
122
            self.stat_count += 1
135
 
 
 
123
            
136
124
            cache_fp = cache_entry[1]
137
 
 
 
125
    
138
126
            if (not fp) or (cache_fp != fp):
139
127
                # not here or not a regular file anymore
140
128
                self.removed_count += 1
145
133
        """Return the sha1 of a file.
146
134
        """
147
135
        if path.__class__ is str:
148
 
            abspath = osutils.pathjoin(self.root_utf8, path)
 
136
            abspath = pathjoin(self.root_utf8, path)
149
137
        else:
150
 
            abspath = osutils.pathjoin(self.root, path)
 
138
            abspath = pathjoin(self.root, path)
151
139
        self.stat_count += 1
152
140
        file_fp = self._fingerprint(abspath, stat_value)
153
 
 
 
141
        
154
142
        if not file_fp:
155
143
            # not a regular file or not existing
156
144
            if path in self._cache:
157
145
                self.removed_count += 1
158
146
                self.needs_write = True
159
147
                del self._cache[path]
160
 
            return None
 
148
            return None        
161
149
 
162
150
        if path in self._cache:
163
151
            cache_sha1, cache_fp = self._cache[path]
169
157
            ## mutter("now = %s", time.time())
170
158
            self.hit_count += 1
171
159
            return cache_sha1
172
 
 
 
160
        
173
161
        self.miss_count += 1
174
162
 
175
163
        mode = file_fp[FP_MODE_COLUMN]
176
164
        if stat.S_ISREG(mode):
177
 
            if self._filter_provider is None:
178
 
                filters = []
179
 
            else:
180
 
                filters = self._filter_provider(path=path, file_id=None)
181
 
            digest = self._really_sha1_file(abspath, filters)
 
165
            digest = self._really_sha1_file(abspath)
182
166
        elif stat.S_ISLNK(mode):
183
 
            digest = osutils.sha_string(os.readlink(abspath))
 
167
            digest = sha.new(os.readlink(abspath)).hexdigest()
184
168
        else:
185
 
            raise errors.BzrError("file %r: unknown file stat mode: %o"
186
 
                                  % (abspath, mode))
 
169
            raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
187
170
 
188
171
        # window of 3 seconds to allow for 2s resolution on windows,
189
172
        # unsynchronized file servers, etc.
216
199
            self._cache[path] = (digest, file_fp)
217
200
        return digest
218
201
 
219
 
    def _really_sha1_file(self, abspath, filters):
 
202
    def _really_sha1_file(self, abspath):
220
203
        """Calculate the SHA1 of a file by reading the full text"""
221
 
        return _mod_filters.internal_size_sha_file_byname(abspath, filters)[1]
222
 
 
 
204
        return sha_file(file(abspath, 'rb', buffering=65000))
 
205
        
223
206
    def write(self):
224
207
        """Write contents of cache to file."""
225
 
        outf = atomicfile.AtomicFile(self.cache_file_name(), 'wb',
226
 
                                     new_mode=self._mode)
 
208
        outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
227
209
        try:
228
210
            outf.write(CACHE_HEADER)
229
211
 
230
212
            for path, c  in self._cache.iteritems():
 
213
                assert '//' not in path, path
231
214
                line_info = [path.encode('utf-8'), '// ', c[0], ' ']
232
215
                line_info.append(' '.join([str(fld) for fld in c[1]]))
233
216
                line_info.append('\n')
246
229
 
247
230
        Overwrites existing cache.
248
231
 
249
 
        If the cache file has the wrong version marker, this just clears
 
232
        If the cache file has the wrong version marker, this just clears 
250
233
        the cache."""
251
234
        self._cache = {}
252
235
 
254
237
        try:
255
238
            inf = file(fn, 'rb', buffering=65000)
256
239
        except IOError, e:
257
 
            trace.mutter("failed to open %s: %s", fn, e)
 
240
            mutter("failed to open %s: %s", fn, e)
258
241
            # better write it now so it is valid
259
242
            self.needs_write = True
260
243
            return
261
244
 
262
245
        hdr = inf.readline()
263
246
        if hdr != CACHE_HEADER:
264
 
            trace.mutter('cache header marker not found at top of %s;'
265
 
                         ' discarding cache', fn)
 
247
            mutter('cache header marker not found at top of %s;'
 
248
                   ' discarding cache', fn)
266
249
            self.needs_write = True
267
250
            return
268
251
 
270
253
            pos = l.index('// ')
271
254
            path = l[:pos].decode('utf-8')
272
255
            if path in self._cache:
273
 
                trace.warning('duplicated path %r in cache' % path)
 
256
                warning('duplicated path %r in cache' % path)
274
257
                continue
275
258
 
276
259
            pos += 3
277
260
            fields = l[pos:].split(' ')
278
261
            if len(fields) != 7:
279
 
                trace.warning("bad line in hashcache: %r" % l)
 
262
                warning("bad line in hashcache: %r" % l)
280
263
                continue
281
264
 
282
265
            sha1 = fields[0]
283
266
            if len(sha1) != 40:
284
 
                trace.warning("bad sha1 in hashcache: %r" % sha1)
 
267
                warning("bad sha1 in hashcache: %r" % sha1)
285
268
                continue
286
269
 
287
270
            fp = tuple(map(long, fields[1:]))
297
280
        undetectably modified and so can't be cached.
298
281
        """
299
282
        return int(time.time()) - 3
300
 
 
 
283
           
301
284
    def _fingerprint(self, abspath, stat_value=None):
302
285
        if stat_value is None:
303
286
            try:
310
293
        # we discard any high precision because it's not reliable; perhaps we
311
294
        # could do better on some systems?
312
295
        return (stat_value.st_size, long(stat_value.st_mtime),
313
 
                long(stat_value.st_ctime), stat_value.st_ino,
 
296
                long(stat_value.st_ctime), stat_value.st_ino, 
314
297
                stat_value.st_dev, stat_value.st_mode)