← 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-09-13 09:06:10 UTC
  • Revision ID: mbp@sourcefrog.net-20050913090610-7ce557143a7ca17a
- remove a lot of dead code from fetch

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