← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

  • Committer: Martin Pool
  • Date: 2005-08-30 03:29:32 UTC
  • Revision ID: mbp@sourcefrog.net-20050830032932-1ad1c40cfacde866
- add a docstring for the placeholder plugin

- remove the checkperms shell plugin, which was in the wrong
  place anyhow

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