« back to all changes in this revision
Viewing changes to bzrlib/statcache.py
- browse files at revision 593
- compare with another revision
- download diff
- download tarball
- view history from revision 593
- Committer: Martin Pool
- Date: 2005-05-30 03:05:03 UTC
- Revision ID: mbp@sourcefrog.net-20050530030503-8fd9959e40c31eeb
todo
- files added:
- TODO
- contrib
- contrib/bash
- contrib/zsh
- patches
- files removed:
- bzrlib/tests.py
- files modified:
- .bzrignore
added
removed
bzrlib/statcache.py
1
# (C) 2005 Canonical Ltd
2
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
7
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
12
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
17
import stat, os, sha, time
18
19
from trace import mutter
20
from errors import BzrError, BzrCheckError
21
22
23
"""File stat cache to speed up tree comparisons.
24
25
This module basically gives a quick way to find the SHA-1 and related
26
information of a file in the working directory, without actually
27
reading and hashing the whole file.
28
29
30
31
Implementation
32
==============
33
34
Users of this module should not need to know about how this is
35
implemented, and in particular should not depend on the particular
36
data which is stored or its format.
37
38
This is done by maintaining a cache indexed by a file fingerprint of
39
(path, size, mtime, ctime, ino, dev) pointing to the SHA-1. If the
40
fingerprint has changed, we assume the file content has not changed
41
either and the SHA-1 is therefore the same.
42
43
If any of the fingerprint fields have changed then the file content
44
*may* have changed, or it may not have. We need to reread the file
45
contents to make sure, but this is not visible to the user or
46
higher-level code (except as a delay of course).
47
48
The mtime and ctime are stored with nanosecond fields, but not all
49
filesystems give this level of precision. There is therefore a
50
possible race: the file might be modified twice within a second
51
without changing the size or mtime, and a SHA-1 cached from the first
52
version would be wrong. We handle this by not recording a cached hash
53
for any files which were modified in the current second and that
54
therefore have the chance to change again before the second is up.
55
56
The only known hole in this design is if the system clock jumps
57
backwards crossing invocations of bzr. Please don't do that; use ntp
58
to gradually adjust your clock or don't use bzr over the step.
59
60
At the moment this is stored in a simple textfile; it might be nice
61
to use a tdb instead.
62
63
The cache is represented as a map from file_id to a tuple of (file_id,
64
sha1, path, size, mtime, ctime, ino, dev).
65
66
The SHA-1 is stored in memory as a hexdigest.
67
68
File names and file-ids are written out with non-ascii or whitespace
69
characters given as python-style unicode escapes. (file-ids shouldn't
70
contain wierd characters, but it might happen.)
71
"""
72
73
# order of fields returned by fingerprint()
74
FP_SIZE = 0
75
FP_MTIME = 1
76
FP_CTIME = 2
77
FP_INO = 3
78
FP_DEV = 4
79
80
# order of fields in the statcache file and in the in-memory map
81
SC_FILE_ID = 0
82
SC_SHA1 = 1
83
SC_PATH = 2
84
SC_SIZE = 3
85
SC_MTIME = 4
86
SC_CTIME = 5
87
SC_INO = 6
88
SC_DEV = 7
89
90
91
92
CACHE_HEADER = "### bzr statcache v3"
93
94
95
def fingerprint(abspath):
96
try:
97
fs = os.lstat(abspath)
98
except OSError:
99
# might be missing, etc
100
return None
101
102
if stat.S_ISDIR(fs.st_mode):
103
return None
104
105
return (fs.st_size, fs.st_mtime,
106
fs.st_ctime, fs.st_ino, fs.st_dev)
107
108
109
110
def safe_quote(s):
111
return s.encode('unicode_escape') \
112
.replace('\n', '\\u000a') \
113
.replace(' ', '\\u0020') \
114
.replace('\r', '\\u000d')
115
116
117
def _write_cache(basedir, entries):
118
from atomicfile import AtomicFile
119
120
cachefn = os.path.join(basedir, '.bzr', 'stat-cache')
121
outf = AtomicFile(cachefn, 'wb')
122
outf.write(CACHE_HEADER + '\n')
123
try:
124
for entry in entries:
125
if len(entry) != 8:
126
raise ValueError("invalid statcache entry tuple %r" % entry)
127
outf.write(safe_quote(entry[0])) # file id
128
outf.write(' ')
129
outf.write(entry[1]) # hex sha1
130
outf.write(' ')
131
outf.write(safe_quote(entry[2])) # name
132
for nf in entry[3:]:
133
outf.write(' %d' % nf)
134
outf.write('\n')
135
136
outf.commit()
137
finally:
138
if not outf.closed:
139
outf.abort()
140
141
142
def _try_write_cache(basedir, entries):
143
try:
144
return _write_cache(basedir, entries)
145
except IOError, e:
146
mutter("cannot update statcache in %s: %s" % (basedir, e))
147
except OSError, e:
148
mutter("cannot update statcache in %s: %s" % (basedir, e))
149
150
151
152
def load_cache(basedir):
153
import re
154
cache = {}
155
seen_paths = {}
156
157
sha_re = re.compile(r'[a-f0-9]{40}')
158
159
try:
160
cachefn = os.path.join(basedir, '.bzr', 'stat-cache')
161
cachefile = open(cachefn, 'rb')
162
except IOError:
163
return cache
164
165
line1 = cachefile.readline().rstrip('\r\n')
166
if line1 != CACHE_HEADER:
167
mutter('cache header marker not found at top of %s' % cachefn)
168
return cache
169
170
for l in cachefile:
171
f = l.split(' ')
172
173
file_id = f[0].decode('unicode_escape')
174
if file_id in cache:
175
raise BzrCheckError("duplicated file_id in cache: {%s}" % file_id)
176
177
text_sha = f[1]
178
if len(text_sha) != 40 or not sha_re.match(text_sha):
179
raise BzrCheckError("invalid file SHA-1 in cache: %r" % text_sha)
180
181
path = f[2].decode('unicode_escape')
182
if path in seen_paths:
183
raise BzrCheckError("duplicated path in cache: %r" % path)
184
seen_paths[path] = True
185
186
entry = (file_id, text_sha, path) + tuple([long(x) for x in f[3:]])
187
if len(entry) != 8:
188
raise ValueError("invalid statcache entry tuple %r" % entry)
189
190
cache[file_id] = entry
191
return cache
192
193
194
195
196
def _files_from_inventory(inv):
197
for path, ie in inv.iter_entries():
198
if ie.kind != 'file':
199
continue
200
yield ie.file_id, path
201
202
203
204
def update_cache(basedir, inv, flush=False):
205
"""Update and return the cache for the branch.
206
207
The returned cache may contain entries that have not been written
208
to disk for files recently touched.
209
210
flush -- discard any previous cache and recalculate from scratch.
211
"""
212
213
# load the existing cache; use information there to find a list of
214
# files ordered by inode, which is alleged to be the fastest order
215
# to stat the files.
216
217
to_update = _files_from_inventory(inv)
218
219
assert isinstance(flush, bool)
220
if flush:
221
cache = {}
222
else:
223
cache = load_cache(basedir)
224
225
by_inode = []
226
without_inode = []
227
for file_id, path in to_update:
228
if file_id in cache:
229
by_inode.append((cache[file_id][SC_INO], file_id, path))
230
else:
231
without_inode.append((file_id, path))
232
by_inode.sort()
233
234
to_update = [a[1:] for a in by_inode] + without_inode
235
236
stat_cnt = missing_cnt = new_cnt = hardcheck = change_cnt = 0
237
238
# dangerfiles have been recently touched and can't be committed to
239
# a persistent cache yet, but they are returned to the caller.
240
dangerfiles = []
241
242
now = int(time.time())
243
244
## mutter('update statcache under %r' % basedir)
245
for file_id, path in to_update:
246
abspath = os.path.join(basedir, path)
247
fp = fingerprint(abspath)
248
stat_cnt += 1
249
250
cacheentry = cache.get(file_id)
251
252
if fp == None: # not here
253
if cacheentry:
254
del cache[file_id]
255
change_cnt += 1
256
missing_cnt += 1
257
continue
258
elif not cacheentry:
259
new_cnt += 1
260
261
if (fp[FP_MTIME] >= now) or (fp[FP_CTIME] >= now):
262
dangerfiles.append(file_id)
263
264
if cacheentry and (cacheentry[3:] == fp):
265
continue # all stat fields unchanged
266
267
hardcheck += 1
268
269
dig = sha.new(file(abspath, 'rb').read()).hexdigest()
270
271
# We update the cache even if the digest has not changed from
272
# last time we looked, so that the fingerprint fields will
273
# match in future.
274
cacheentry = (file_id, dig, path) + fp
275
cache[file_id] = cacheentry
276
change_cnt += 1
277
278
mutter('statcache: statted %d files, read %d files, %d changed, %d dangerous, '
279
'%d deleted, %d new, '
280
'%d in cache'
281
% (stat_cnt, hardcheck, change_cnt, len(dangerfiles),
282
missing_cnt, new_cnt, len(cache)))
283
284
if change_cnt:
285
mutter('updating on-disk statcache')
286
287
if dangerfiles:
288
safe_cache = cache.copy()
289
for file_id in dangerfiles:
290
del safe_cache[file_id]
291
else:
292
safe_cache = cache
293
294
_try_write_cache(basedir, safe_cache.itervalues())
295
296
return cache
Loggerhead is a web-based interface for Breezy
Version: 2.0.1