← 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-06 22:15:52 UTC
  • mfrom: (1185.13.2)
  • mto: This revision was merged to the branch mainline in revision 1420.
  • Revision ID: robertc@robertcollins.net-20051006221552-9b15c96fa504e0ad
merge from upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/hashcache.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
# (C) 2005 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
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.
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
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
 
 
42
def _fingerprint(abspath):
 
43
    try:
 
44
        fs = os.lstat(abspath)
 
45
    except OSError:
 
46
        # might be missing, etc
 
47
        return None
 
48
 
 
49
    if stat.S_ISDIR(fs.st_mode):
 
50
        return None
 
51
 
 
52
    # we discard any high precision because it's not reliable; perhaps we
 
53
    # could do better on some systems?
 
54
    return (fs.st_size, long(fs.st_mtime),
 
55
            long(fs.st_ctime), fs.st_ino, fs.st_dev, fs.st_mode)
45
56
 
46
57
 
47
58
class HashCache(object):
80
91
    """
81
92
    needs_write = False
82
93
 
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)
86
 
        self.root_utf8 = self.root.encode('utf8') # where is the filesystem encoding ?
 
94
    def __init__(self, basedir):
 
95
        self.basedir = basedir
87
96
        self.hit_count = 0
88
97
        self.miss_count = 0
89
98
        self.stat_count = 0
91
100
        self.removed_count = 0
92
101
        self.update_count = 0
93
102
        self._cache = {}
94
 
        self._mode = mode
95
 
        self._cache_file_name = safe_unicode(cache_file_name)
 
103
 
96
104
 
97
105
    def cache_file_name(self):
98
 
        return self._cache_file_name
 
106
        return os.sep.join([self.basedir, '.bzr', 'stat-cache'])
 
107
 
 
108
 
 
109
 
99
110
 
100
111
    def clear(self):
101
112
        """Discard all cached information.
105
116
            self.needs_write = True
106
117
            self._cache = {}
107
118
 
 
119
 
108
120
    def scan(self):
109
121
        """Scan all files and remove entries where the cache entry is obsolete.
110
122
        
111
123
        Obsolete entries are those where the file has been modified or deleted
112
124
        since the entry was inserted.        
113
125
        """
114
 
        # FIXME optimisation opportunity, on linux [and check other oses]:
115
 
        # rather than iteritems order, stat in inode order.
116
126
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
117
127
        prep.sort()
118
128
        
119
129
        for inum, path, cache_entry in prep:
120
 
            abspath = pathjoin(self.root, path)
121
 
            fp = self._fingerprint(abspath)
 
130
            abspath = os.sep.join([self.basedir, path])
 
131
            fp = _fingerprint(abspath)
122
132
            self.stat_count += 1
123
133
            
124
134
            cache_fp = cache_entry[1]
129
139
                self.needs_write = True
130
140
                del self._cache[path]
131
141
 
132
 
    def get_sha1(self, path, stat_value=None):
 
142
 
 
143
    def get_sha1(self, path):
133
144
        """Return the sha1 of a file.
134
145
        """
135
 
        if path.__class__ is str:
136
 
            abspath = pathjoin(self.root_utf8, path)
137
 
        else:
138
 
            abspath = pathjoin(self.root, path)
 
146
        abspath = os.sep.join([self.basedir, path])
139
147
        self.stat_count += 1
140
 
        file_fp = self._fingerprint(abspath, stat_value)
 
148
        file_fp = _fingerprint(abspath)
141
149
        
142
150
        if not file_fp:
143
151
            # not a regular file or not existing
153
161
            cache_sha1, cache_fp = None, None
154
162
 
155
163
        if cache_fp == file_fp:
156
 
            ## mutter("hashcache hit for %s %r -> %s", path, file_fp, cache_sha1)
157
 
            ## mutter("now = %s", time.time())
158
164
            self.hit_count += 1
159
165
            return cache_sha1
160
166
        
161
167
        self.miss_count += 1
162
168
 
 
169
 
163
170
        mode = file_fp[FP_MODE_COLUMN]
164
171
        if stat.S_ISREG(mode):
165
 
            digest = self._really_sha1_file(abspath)
 
172
            digest = sha_file(file(abspath, 'rb', buffering=65000))
166
173
        elif stat.S_ISLNK(mode):
 
174
            link_target = os.readlink(abspath)
167
175
            digest = sha.new(os.readlink(abspath)).hexdigest()
168
176
        else:
169
177
            raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
170
178
 
171
 
        # window of 3 seconds to allow for 2s resolution on windows,
172
 
        # unsynchronized file servers, etc.
173
 
        cutoff = self._cutoff_time()
174
 
        if file_fp[FP_MTIME_COLUMN] >= cutoff \
175
 
                or file_fp[FP_CTIME_COLUMN] >= cutoff:
 
179
        now = int(time.time())
 
180
        if file_fp[1] >= now or file_fp[2] >= now:
176
181
            # changed too recently; can't be cached.  we can
177
182
            # return the result and it could possibly be cached
178
183
            # next time.
179
 
            #
180
 
            # the point is that we only want to cache when we are sure that any
181
 
            # subsequent modifications of the file can be detected.  If a
182
 
            # modification neither changes the inode, the device, the size, nor
183
 
            # the mode, then we can only distinguish it by time; therefore we
184
 
            # need to let sufficient time elapse before we may cache this entry
185
 
            # again.  If we didn't do this, then, for example, a very quick 1
186
 
            # byte replacement in the file might go undetected.
187
 
            ## mutter('%r modified too recently; not caching', path)
188
 
            self.danger_count += 1
 
184
            self.danger_count += 1 
189
185
            if cache_fp:
190
186
                self.removed_count += 1
191
187
                self.needs_write = True
192
188
                del self._cache[path]
193
189
        else:
194
 
            ## mutter('%r added to cache: now=%f, mtime=%d, ctime=%d',
195
 
            ##        path, time.time(), file_fp[FP_MTIME_COLUMN],
196
 
            ##        file_fp[FP_CTIME_COLUMN])
197
190
            self.update_count += 1
198
191
            self.needs_write = True
199
192
            self._cache[path] = (digest, file_fp)
200
193
        return digest
201
 
 
202
 
    def _really_sha1_file(self, abspath):
203
 
        """Calculate the SHA1 of a file by reading the full text"""
204
 
        return sha_file(file(abspath, 'rb', buffering=65000))
205
194
        
206
195
    def write(self):
207
196
        """Write contents of cache to file."""
208
 
        outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
 
197
        outf = AtomicFile(self.cache_file_name(), 'wb')
209
198
        try:
210
 
            outf.write(CACHE_HEADER)
 
199
            print >>outf, CACHE_HEADER,
211
200
 
212
201
            for path, c  in self._cache.iteritems():
213
202
                assert '//' not in path, path
214
 
                line_info = [path.encode('utf-8'), '// ', c[0], ' ']
215
 
                line_info.append(' '.join([str(fld) for fld in c[1]]))
216
 
                line_info.append('\n')
217
 
                outf.write(''.join(line_info))
 
203
                outf.write(path.encode('utf-8'))
 
204
                outf.write('// ')
 
205
                print >>outf, c[0],     # hex sha1
 
206
                for fld in c[1]:
 
207
                    print >>outf, "%d" % fld,
 
208
                print >>outf
 
209
 
218
210
            outf.commit()
219
211
            self.needs_write = False
220
 
            ## mutter("write hash cache: %s hits=%d misses=%d stat=%d recent=%d updates=%d",
221
 
            ##        self.cache_file_name(), self.hit_count, self.miss_count,
222
 
            ##        self.stat_count,
223
 
            ##        self.danger_count, self.update_count)
224
212
        finally:
225
 
            outf.close()
 
213
            if not outf.closed:
 
214
                outf.abort()
 
215
        
 
216
 
226
217
 
227
218
    def read(self):
228
219
        """Reinstate cache from file.
237
228
        try:
238
229
            inf = file(fn, 'rb', buffering=65000)
239
230
        except IOError, e:
240
 
            mutter("failed to open %s: %s", fn, e)
 
231
            mutter("failed to open %s: %s" % (fn, e))
241
232
            # better write it now so it is valid
242
233
            self.needs_write = True
243
234
            return
244
235
 
 
236
 
245
237
        hdr = inf.readline()
246
238
        if hdr != CACHE_HEADER:
247
 
            mutter('cache header marker not found at top of %s;'
248
 
                   ' discarding cache', fn)
 
239
            mutter('cache header marker not found at top of %s; discarding cache'
 
240
                   % fn)
249
241
            self.needs_write = True
250
242
            return
251
243
 
272
264
            self._cache[path] = (sha1, fp)
273
265
 
274
266
        self.needs_write = False
275
 
 
276
 
    def _cutoff_time(self):
277
 
        """Return cutoff time.
278
 
 
279
 
        Files modified more recently than this time are at risk of being
280
 
        undetectably modified and so can't be cached.
281
 
        """
282
 
        return int(time.time()) - 3
283
267
           
284
 
    def _fingerprint(self, abspath, stat_value=None):
285
 
        if stat_value is None:
286
 
            try:
287
 
                stat_value = os.lstat(abspath)
288
 
            except OSError:
289
 
                # might be missing, etc
290
 
                return None
291
 
        if stat.S_ISDIR(stat_value.st_mode):
292
 
            return None
293
 
        # we discard any high precision because it's not reliable; perhaps we
294
 
        # could do better on some systems?
295
 
        return (stat_value.st_size, long(stat_value.st_mtime),
296
 
                long(stat_value.st_ctime), stat_value.st_ino, 
297
 
                stat_value.st_dev, stat_value.st_mode)
 
268
 
 
269
 
 
270