← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

  • Committer: Robert Collins
  • Date: 2005-10-09 23:12:35 UTC
  • Revision ID: robertc@robertcollins.net-20051009231235-93626e72cac71b78
clean up test dirs on make clean

Show diffs side-by-side

added added

removed removed

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