← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

Nearly complete .bzr/checkout splitout.

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
30
30
CACHE_HEADER = "### bzr hashcache v5\n"
31
31
 
32
32
import os, stat, time
 
33
import sha
33
34
 
34
 
from bzrlib.osutils import sha_file, sha_string, pathjoin, safe_unicode
 
35
from bzrlib.osutils import sha_file, pathjoin
35
36
from bzrlib.trace import mutter, warning
36
37
from bzrlib.atomicfile import AtomicFile
37
38
from bzrlib.errors import BzrError
41
42
FP_CTIME_COLUMN = 2
42
43
FP_MODE_COLUMN = 5
43
44
 
 
45
def _fingerprint(abspath):
 
46
    try:
 
47
        fs = os.lstat(abspath)
 
48
    except OSError:
 
49
        # might be missing, etc
 
50
        return None
 
51
 
 
52
    if stat.S_ISDIR(fs.st_mode):
 
53
        return None
 
54
 
 
55
    # we discard any high precision because it's not reliable; perhaps we
 
56
    # could do better on some systems?
 
57
    return (fs.st_size, long(fs.st_mtime),
 
58
            long(fs.st_ctime), fs.st_ino, fs.st_dev, fs.st_mode)
44
59
 
45
60
 
46
61
class HashCache(object):
79
94
    """
80
95
    needs_write = False
81
96
 
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 ?
 
97
    def __init__(self, basedir):
 
98
        self.basedir = basedir
86
99
        self.hit_count = 0
87
100
        self.miss_count = 0
88
101
        self.stat_count = 0
90
103
        self.removed_count = 0
91
104
        self.update_count = 0
92
105
        self._cache = {}
93
 
        self._mode = mode
94
 
        self._cache_file_name = safe_unicode(cache_file_name)
95
106
 
96
107
    def cache_file_name(self):
97
 
        return self._cache_file_name
 
108
        # FIXME: duplicate path logic here, this should be 
 
109
        # something like 'branch.controlfile'.
 
110
        return pathjoin(self.basedir, '.bzr', 'stat-cache')
98
111
 
99
112
    def clear(self):
100
113
        """Discard all cached information.
104
117
            self.needs_write = True
105
118
            self._cache = {}
106
119
 
 
120
 
107
121
    def scan(self):
108
122
        """Scan all files and remove entries where the cache entry is obsolete.
109
123
        
110
124
        Obsolete entries are those where the file has been modified or deleted
111
125
        since the entry was inserted.        
112
126
        """
113
 
        # FIXME optimisation opportunity, on linux [and check other oses]:
114
 
        # rather than iteritems order, stat in inode order.
115
127
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
116
128
        prep.sort()
117
129
        
118
130
        for inum, path, cache_entry in prep:
119
 
            abspath = pathjoin(self.root, path)
120
 
            fp = self._fingerprint(abspath)
 
131
            abspath = pathjoin(self.basedir, path)
 
132
            fp = _fingerprint(abspath)
121
133
            self.stat_count += 1
122
134
            
123
135
            cache_fp = cache_entry[1]
128
140
                self.needs_write = True
129
141
                del self._cache[path]
130
142
 
131
 
    def get_sha1(self, path, stat_value=None):
 
143
 
 
144
    def get_sha1(self, path):
132
145
        """Return the sha1 of a file.
133
146
        """
134
 
        if path.__class__ is str:
135
 
            abspath = pathjoin(self.root_utf8, path)
136
 
        else:
137
 
            abspath = pathjoin(self.root, path)
 
147
        abspath = pathjoin(self.basedir, path)
138
148
        self.stat_count += 1
139
 
        file_fp = self._fingerprint(abspath, stat_value)
 
149
        file_fp = _fingerprint(abspath)
140
150
        
141
151
        if not file_fp:
142
152
            # not a regular file or not existing
152
162
            cache_sha1, cache_fp = None, None
153
163
 
154
164
        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
165
            self.hit_count += 1
158
166
            return cache_sha1
159
167
        
160
168
        self.miss_count += 1
161
169
 
 
170
 
162
171
        mode = file_fp[FP_MODE_COLUMN]
163
172
        if stat.S_ISREG(mode):
164
 
            digest = self._really_sha1_file(abspath)
 
173
            digest = sha_file(file(abspath, 'rb', buffering=65000))
165
174
        elif stat.S_ISLNK(mode):
166
 
            digest = sha_string(os.readlink(abspath))
 
175
            digest = sha.new(os.readlink(abspath)).hexdigest()
167
176
        else:
168
177
            raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
169
178
 
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:
 
179
        now = int(time.time())
 
180
        if file_fp[FP_MTIME_COLUMN] >= now or file_fp[FP_CTIME_COLUMN] >= now:
175
181
            # changed too recently; can't be cached.  we can
176
182
            # return the result and it could possibly be cached
177
183
            # next time.
183
189
            # need to let sufficient time elapse before we may cache this entry
184
190
            # again.  If we didn't do this, then, for example, a very quick 1
185
191
            # byte replacement in the file might go undetected.
186
 
            ## mutter('%r modified too recently; not caching', path)
187
 
            self.danger_count += 1
 
192
            self.danger_count += 1 
188
193
            if cache_fp:
189
194
                self.removed_count += 1
190
195
                self.needs_write = True
191
196
                del self._cache[path]
192
197
        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
198
            self.update_count += 1
197
199
            self.needs_write = True
198
200
            self._cache[path] = (digest, file_fp)
199
201
        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
202
        
205
203
    def write(self):
206
204
        """Write contents of cache to file."""
207
 
        outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
 
205
        outf = AtomicFile(self.cache_file_name(), 'wb')
208
206
        try:
209
 
            outf.write(CACHE_HEADER)
 
207
            print >>outf, CACHE_HEADER,
210
208
 
211
209
            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))
 
210
                assert '//' not in path, path
 
211
                outf.write(path.encode('utf-8'))
 
212
                outf.write('// ')
 
213
                print >>outf, c[0],     # hex sha1
 
214
                for fld in c[1]:
 
215
                    print >>outf, "%d" % fld,
 
216
                print >>outf
 
217
 
216
218
            outf.commit()
217
219
            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
220
        finally:
223
 
            outf.close()
 
221
            if not outf.closed:
 
222
                outf.abort()
224
223
 
225
224
    def read(self):
226
225
        """Reinstate cache from file.
240
239
            self.needs_write = True
241
240
            return
242
241
 
 
242
 
243
243
        hdr = inf.readline()
244
244
        if hdr != CACHE_HEADER:
245
245
            mutter('cache header marker not found at top of %s;'
270
270
            self._cache[path] = (sha1, fp)
271
271
 
272
272
        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
273
           
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)
 
274
 
 
275
 
 
276