1
# Copyright (C) 2005, 2006 Canonical Ltd
1
# (C) 2005 Canonical Ltd
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
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
# it preserves the nice property that any caller will always get up-to-date
21
# data except in unavoidable cases.
19
# TODO: Perhaps have a way to stat all the files in inode order, and
20
# then remember that they're all fresh for the lifetime of the object?
22
# TODO: Keep track of whether there are in-memory updates that need to
23
25
# TODO: Perhaps return more details on the file to avoid statting it
24
26
# again: nonexistent, file type, size, etc
26
# TODO: Perhaps use a Python pickle instead of a text file; might be faster.
30
31
CACHE_HEADER = "### bzr hashcache v5\n"
34
from bzrlib.osutils import sha_file, sha_string, pathjoin, safe_unicode
35
from bzrlib.trace import mutter, warning
36
from bzrlib.atomicfile import AtomicFile
37
from bzrlib.errors import BzrError
34
def _fingerprint(abspath):
38
fs = os.lstat(abspath)
40
# might be missing, etc
43
if stat.S_ISDIR(fs.st_mode):
46
# we discard any high precision because it's not reliable; perhaps we
47
# could do better on some systems?
48
return (fs.st_size, long(fs.st_mtime),
49
long(fs.st_ctime), fs.st_ino, fs.st_dev)
46
52
class HashCache(object):
104
110
self.needs_write = True
108
"""Scan all files and remove entries where the cache entry is obsolete.
110
Obsolete entries are those where the file has been modified or deleted
111
since the entry was inserted.
113
# FIXME optimisation opportunity, on linux [and check other oses]:
114
# rather than iteritems order, stat in inode order.
115
prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
118
for inum, path, cache_entry in prep:
119
abspath = pathjoin(self.root, path)
120
fp = self._fingerprint(abspath)
123
cache_fp = cache_entry[1]
125
if (not fp) or (cache_fp != fp):
126
# not here or not a regular file anymore
127
self.removed_count += 1
128
self.needs_write = True
129
del self._cache[path]
131
def get_sha1(self, path, stat_value=None):
132
"""Return the sha1 of a file.
134
if path.__class__ is str:
135
abspath = pathjoin(self.root_utf8, path)
114
def get_sha1(self, path):
115
"""Return the hex SHA-1 of the contents of the file at path.
117
XXX: If the file does not exist or is not a plain file???
121
from bzrlib.osutils import sha_file
122
from bzrlib.trace import mutter
124
abspath = os.path.join(self.basedir, path)
125
fp = _fingerprint(abspath)
126
c = self._cache.get(path)
128
cache_sha1, cache_fp = c
137
abspath = pathjoin(self.root, path)
130
cache_sha1, cache_fp = None, None
138
132
self.stat_count += 1
139
file_fp = self._fingerprint(abspath, stat_value)
142
# not a regular file or not existing
143
if path in self._cache:
144
self.removed_count += 1
145
self.needs_write = True
146
del self._cache[path]
149
if path in self._cache:
150
cache_sha1, cache_fp = self._cache[path]
152
cache_sha1, cache_fp = None, None
154
if cache_fp == file_fp:
155
## mutter("hashcache hit for %s %r -> %s", path, file_fp, cache_sha1)
156
## mutter("now = %s", time.time())
137
elif cache_fp and (cache_fp == fp):
157
138
self.hit_count += 1
158
139
return cache_sha1
162
mode = file_fp[FP_MODE_COLUMN]
163
if stat.S_ISREG(mode):
164
digest = self._really_sha1_file(abspath)
165
elif stat.S_ISLNK(mode):
166
digest = sha_string(os.readlink(abspath))
168
raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
142
digest = sha_file(file(abspath, 'rb', buffering=65000))
170
# window of 3 seconds to allow for 2s resolution on windows,
171
# unsynchronized file servers, etc.
172
cutoff = self._cutoff_time()
173
if file_fp[FP_MTIME_COLUMN] >= cutoff \
174
or file_fp[FP_CTIME_COLUMN] >= cutoff:
175
# changed too recently; can't be cached. we can
176
# return the result and it could possibly be cached
179
# the point is that we only want to cache when we are sure that any
180
# subsequent modifications of the file can be detected. If a
181
# modification neither changes the inode, the device, the size, nor
182
# the mode, then we can only distinguish it by time; therefore we
183
# need to let sufficient time elapse before we may cache this entry
184
# again. If we didn't do this, then, for example, a very quick 1
185
# byte replacement in the file might go undetected.
186
## mutter('%r modified too recently; not caching', path)
187
self.danger_count += 1
189
self.removed_count += 1
144
now = int(time.time())
145
if fp[1] >= now or fp[2] >= now:
146
# changed too recently; can't be cached. we can
147
# return the result and it could possibly be cached
149
self.danger_count += 1
151
mutter("remove outdated entry for %s" % path)
152
self.needs_write = True
153
del self._cache[path]
154
elif (fp != cache_fp) or (digest != cache_sha1):
155
mutter("update entry for %s" % path)
156
mutter(" %r" % (fp,))
157
mutter(" %r" % (cache_fp,))
190
158
self.needs_write = True
191
del self._cache[path]
193
## mutter('%r added to cache: now=%f, mtime=%d, ctime=%d',
194
## path, time.time(), file_fp[FP_MTIME_COLUMN],
195
## file_fp[FP_CTIME_COLUMN])
196
self.update_count += 1
197
self.needs_write = True
198
self._cache[path] = (digest, file_fp)
201
def _really_sha1_file(self, abspath):
202
"""Calculate the SHA1 of a file by reading the full text"""
203
return sha_file(file(abspath, 'rb', buffering=65000))
159
self._cache[path] = (digest, fp)
206
166
"""Write contents of cache to file."""
207
outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
167
from atomicfile import AtomicFile
169
outf = AtomicFile(self.cache_file_name(), 'wb')
209
outf.write(CACHE_HEADER)
171
print >>outf, CACHE_HEADER,
211
173
for path, c in self._cache.iteritems():
212
line_info = [path.encode('utf-8'), '// ', c[0], ' ']
213
line_info.append(' '.join([str(fld) for fld in c[1]]))
214
line_info.append('\n')
215
outf.write(''.join(line_info))
174
assert '//' not in path, path
175
outf.write(path.encode('utf-8'))
177
print >>outf, c[0], # hex sha1
179
print >>outf, "%d" % fld,
217
183
self.needs_write = False
218
## mutter("write hash cache: %s hits=%d misses=%d stat=%d recent=%d updates=%d",
219
## self.cache_file_name(), self.hit_count, self.miss_count,
221
## self.danger_count, self.update_count)
226
191
"""Reinstate cache from file.
added
removed
bzrlib/hashcache.py
