← 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: 2006-03-02 03:12:34 UTC
  • mto: (1594.2.4 integration)
  • mto: This revision was merged to the branch mainline in revision 1596.
  • Revision ID: robertc@robertcollins.net-20060302031234-cf6b75961f27c5df
InterVersionedFile implemented.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/hashcache.py
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
 
26
28
 
27
29
 
28
30
CACHE_HEADER = "### bzr hashcache v5\n"
29
31
 
30
32
import os, stat, time
 
33
import sha
31
34
 
32
 
from bzrlib.osutils import sha_file
 
35
from bzrlib.osutils import sha_file, pathjoin, safe_unicode
33
36
from bzrlib.trace import mutter, warning
34
 
 
35
 
 
 
37
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
36
44
 
37
45
def _fingerprint(abspath):
38
46
    try:
47
55
    # we discard any high precision because it's not reliable; perhaps we
48
56
    # could do better on some systems?
49
57
    return (fs.st_size, long(fs.st_mtime),
50
 
            long(fs.st_ctime), fs.st_ino, fs.st_dev)
 
58
            long(fs.st_ctime), fs.st_ino, fs.st_dev, fs.st_mode)
51
59
 
52
60
 
53
61
class HashCache(object):
86
94
    """
87
95
    needs_write = False
88
96
 
89
 
    def __init__(self, basedir):
90
 
        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)
91
100
        self.hit_count = 0
92
101
        self.miss_count = 0
93
102
        self.stat_count = 0
95
104
        self.removed_count = 0
96
105
        self.update_count = 0
97
106
        self._cache = {}
98
 
 
 
107
        self._mode = mode
 
108
        self._cache_file_name = safe_unicode(cache_file_name)
99
109
 
100
110
    def cache_file_name(self):
101
 
        return os.sep.join([self.basedir, '.bzr', 'stat-cache'])
102
 
 
103
 
 
104
 
 
 
111
        return self._cache_file_name
105
112
 
106
113
    def clear(self):
107
114
        """Discard all cached information.
111
118
            self.needs_write = True
112
119
            self._cache = {}
113
120
 
114
 
 
115
121
    def scan(self):
116
122
        """Scan all files and remove entries where the cache entry is obsolete.
117
123
        
118
124
        Obsolete entries are those where the file has been modified or deleted
119
125
        since the entry was inserted.        
120
126
        """
 
127
        # FIXME optimisation opportunity, on linux [and check other oses]:
 
128
        # rather than iteritems order, stat in inode order.
121
129
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
122
130
        prep.sort()
123
131
        
124
132
        for inum, path, cache_entry in prep:
125
 
            abspath = os.sep.join([self.basedir, path])
 
133
            abspath = pathjoin(self.root, path)
126
134
            fp = _fingerprint(abspath)
127
135
            self.stat_count += 1
128
136
            
135
143
                del self._cache[path]
136
144
 
137
145
 
138
 
 
139
146
    def get_sha1(self, path):
140
147
        """Return the sha1 of a file.
141
148
        """
142
 
        abspath = os.sep.join([self.basedir, path])
 
149
        abspath = pathjoin(self.root, path)
143
150
        self.stat_count += 1
144
151
        file_fp = _fingerprint(abspath)
145
152
        
161
168
            return cache_sha1
162
169
        
163
170
        self.miss_count += 1
164
 
        digest = sha_file(file(abspath, 'rb', buffering=65000))
 
171
 
 
172
 
 
173
        mode = file_fp[FP_MODE_COLUMN]
 
174
        if stat.S_ISREG(mode):
 
175
            digest = sha_file(file(abspath, 'rb', buffering=65000))
 
176
        elif stat.S_ISLNK(mode):
 
177
            digest = sha.new(os.readlink(abspath)).hexdigest()
 
178
        else:
 
179
            raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
165
180
 
166
181
        now = int(time.time())
167
 
        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:
168
183
            # changed too recently; can't be cached.  we can
169
184
            # return the result and it could possibly be cached
170
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.
171
194
            self.danger_count += 1 
172
195
            if cache_fp:
173
196
                self.removed_count += 1
177
200
            self.update_count += 1
178
201
            self.needs_write = True
179
202
            self._cache[path] = (digest, file_fp)
180
 
        
181
203
        return digest
182
204
        
183
 
 
184
 
 
185
 
 
186
205
    def write(self):
187
206
        """Write contents of cache to file."""
188
 
        from atomicfile import AtomicFile
189
 
 
190
 
        outf = AtomicFile(self.cache_file_name(), 'wb')
 
207
        outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
191
208
        try:
192
209
            print >>outf, CACHE_HEADER,
193
210
 
205
222
        finally:
206
223
            if not outf.closed:
207
224
                outf.abort()
208
 
        
209
 
 
210
225
 
211
226
    def read(self):
212
227
        """Reinstate cache from file.
221
236
        try:
222
237
            inf = file(fn, 'rb', buffering=65000)
223
238
        except IOError, e:
224
 
            mutter("failed to open %s: %s" % (fn, e))
 
239
            mutter("failed to open %s: %s", fn, e)
 
240
            # better write it now so it is valid
 
241
            self.needs_write = True
225
242
            return
226
243
 
227
244
 
228
245
        hdr = inf.readline()
229
246
        if hdr != CACHE_HEADER:
230
 
            mutter('cache header marker not found at top of %s; discarding cache'
231
 
                   % fn)
 
247
            mutter('cache header marker not found at top of %s;'
 
248
                   ' discarding cache', fn)
 
249
            self.needs_write = True
232
250
            return
233
251
 
234
252
        for l in inf:
240
258
 
241
259
            pos += 3
242
260
            fields = l[pos:].split(' ')
243
 
            if len(fields) != 6:
 
261
            if len(fields) != 7:
244
262
                warning("bad line in hashcache: %r" % l)
245
263
                continue
246
264