← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

[merge] fix \t in commit messages

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
35
36
from bzrlib.trace import mutter, warning
36
37
from bzrlib.atomicfile import AtomicFile
37
 
from bzrlib.errors import BzrError
38
 
 
39
 
 
40
 
FP_MTIME_COLUMN = 1
41
 
FP_CTIME_COLUMN = 2
 
38
 
 
39
 
42
40
FP_MODE_COLUMN = 5
43
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)
44
56
 
45
57
 
46
58
class HashCache(object):
79
91
    """
80
92
    needs_write = False
81
93
 
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 ?
 
94
    def __init__(self, basedir):
 
95
        self.basedir = basedir
86
96
        self.hit_count = 0
87
97
        self.miss_count = 0
88
98
        self.stat_count = 0
90
100
        self.removed_count = 0
91
101
        self.update_count = 0
92
102
        self._cache = {}
93
 
        self._mode = mode
94
 
        self._cache_file_name = safe_unicode(cache_file_name)
95
103
 
96
104
    def cache_file_name(self):
97
 
        return self._cache_file_name
 
105
        # FIXME: duplicate path logic here, this should be 
 
106
        # something like 'branch.controlfile'.
 
107
        return os.sep.join([self.basedir, '.bzr', 'stat-cache'])
98
108
 
99
109
    def clear(self):
100
110
        """Discard all cached information.
104
114
            self.needs_write = True
105
115
            self._cache = {}
106
116
 
 
117
 
107
118
    def scan(self):
108
119
        """Scan all files and remove entries where the cache entry is obsolete.
109
120
        
110
121
        Obsolete entries are those where the file has been modified or deleted
111
122
        since the entry was inserted.        
112
123
        """
113
 
        # FIXME optimisation opportunity, on linux [and check other oses]:
114
 
        # rather than iteritems order, stat in inode order.
115
124
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
116
125
        prep.sort()
117
126
        
118
127
        for inum, path, cache_entry in prep:
119
 
            abspath = pathjoin(self.root, path)
120
 
            fp = self._fingerprint(abspath)
 
128
            abspath = os.sep.join([self.basedir, path])
 
129
            fp = _fingerprint(abspath)
121
130
            self.stat_count += 1
122
131
            
123
132
            cache_fp = cache_entry[1]
128
137
                self.needs_write = True
129
138
                del self._cache[path]
130
139
 
131
 
    def get_sha1(self, path, stat_value=None):
 
140
 
 
141
    def get_sha1(self, path):
132
142
        """Return the sha1 of a file.
133
143
        """
134
 
        if path.__class__ is str:
135
 
            abspath = pathjoin(self.root_utf8, path)
136
 
        else:
137
 
            abspath = pathjoin(self.root, path)
 
144
        abspath = os.sep.join([self.basedir, path])
138
145
        self.stat_count += 1
139
 
        file_fp = self._fingerprint(abspath, stat_value)
 
146
        file_fp = _fingerprint(abspath)
140
147
        
141
148
        if not file_fp:
142
149
            # not a regular file or not existing
152
159
            cache_sha1, cache_fp = None, None
153
160
 
154
161
        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
162
            self.hit_count += 1
158
163
            return cache_sha1
159
164
        
160
165
        self.miss_count += 1
161
166
 
 
167
 
162
168
        mode = file_fp[FP_MODE_COLUMN]
163
169
        if stat.S_ISREG(mode):
164
 
            digest = self._really_sha1_file(abspath)
 
170
            digest = sha_file(file(abspath, 'rb', buffering=65000))
165
171
        elif stat.S_ISLNK(mode):
166
 
            digest = sha_string(os.readlink(abspath))
 
172
            link_target = os.readlink(abspath)
 
173
            digest = sha.new(os.readlink(abspath)).hexdigest()
167
174
        else:
168
175
            raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
169
176
 
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:
 
177
        now = int(time.time())
 
178
        if file_fp[1] >= now or file_fp[2] >= now:
175
179
            # changed too recently; can't be cached.  we can
176
180
            # return the result and it could possibly be cached
177
181
            # 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
 
182
            self.danger_count += 1 
188
183
            if cache_fp:
189
184
                self.removed_count += 1
190
185
                self.needs_write = True
191
186
                del self._cache[path]
192
187
        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
188
            self.update_count += 1
197
189
            self.needs_write = True
198
190
            self._cache[path] = (digest, file_fp)
199
191
        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
192
        
205
193
    def write(self):
206
194
        """Write contents of cache to file."""
207
 
        outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
 
195
        outf = AtomicFile(self.cache_file_name(), 'wb')
208
196
        try:
209
 
            outf.write(CACHE_HEADER)
 
197
            print >>outf, CACHE_HEADER,
210
198
 
211
199
            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))
 
200
                assert '//' not in path, path
 
201
                outf.write(path.encode('utf-8'))
 
202
                outf.write('// ')
 
203
                print >>outf, c[0],     # hex sha1
 
204
                for fld in c[1]:
 
205
                    print >>outf, "%d" % fld,
 
206
                print >>outf
 
207
 
216
208
            outf.commit()
217
209
            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
210
        finally:
223
 
            outf.close()
 
211
            if not outf.closed:
 
212
                outf.abort()
224
213
 
225
214
    def read(self):
226
215
        """Reinstate cache from file.
240
229
            self.needs_write = True
241
230
            return
242
231
 
 
232
 
243
233
        hdr = inf.readline()
244
234
        if hdr != CACHE_HEADER:
245
235
            mutter('cache header marker not found at top of %s;'
270
260
            self._cache[path] = (sha1, fp)
271
261
 
272
262
        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
263
           
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)
 
264
 
 
265
 
 
266