← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

  • Committer: Ian Clatworthy
  • Date: 2009-01-19 02:24:15 UTC
  • mto: This revision was merged to the branch mainline in revision 3944.
  • Revision ID: ian.clatworthy@canonical.com-20090119022415-mo0mcfeiexfktgwt
apply jam's log --short fix (Ian Clatworthy)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/hashcache.py
1
 
# Copyright (C) 2005, 2006 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006 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
34
33
 
35
 
from bzrlib.osutils import sha_file, pathjoin, safe_unicode
 
34
from bzrlib.osutils import sha_file, sha_string, pathjoin, safe_unicode
36
35
from bzrlib.trace import mutter, warning
37
36
from bzrlib.atomicfile import AtomicFile
38
37
from bzrlib.errors import BzrError
42
41
FP_CTIME_COLUMN = 2
43
42
FP_MODE_COLUMN = 5
44
43
 
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)
59
44
 
60
45
 
61
46
class HashCache(object):
97
82
    def __init__(self, root, cache_file_name, mode=None):
98
83
        """Create a hash cache in base dir, and set the file mode to mode."""
99
84
        self.root = safe_unicode(root)
 
85
        self.root_utf8 = self.root.encode('utf8') # where is the filesystem encoding ?
100
86
        self.hit_count = 0
101
87
        self.miss_count = 0
102
88
        self.stat_count = 0
131
117
        
132
118
        for inum, path, cache_entry in prep:
133
119
            abspath = pathjoin(self.root, path)
134
 
            fp = _fingerprint(abspath)
 
120
            fp = self._fingerprint(abspath)
135
121
            self.stat_count += 1
136
122
            
137
123
            cache_fp = cache_entry[1]
142
128
                self.needs_write = True
143
129
                del self._cache[path]
144
130
 
145
 
 
146
 
    def get_sha1(self, path):
 
131
    def get_sha1(self, path, stat_value=None):
147
132
        """Return the sha1 of a file.
148
133
        """
149
 
        abspath = pathjoin(self.root, path)
 
134
        if path.__class__ is str:
 
135
            abspath = pathjoin(self.root_utf8, path)
 
136
        else:
 
137
            abspath = pathjoin(self.root, path)
150
138
        self.stat_count += 1
151
 
        file_fp = _fingerprint(abspath)
 
139
        file_fp = self._fingerprint(abspath, stat_value)
152
140
        
153
141
        if not file_fp:
154
142
            # not a regular file or not existing
164
152
            cache_sha1, cache_fp = None, None
165
153
 
166
154
        if cache_fp == file_fp:
 
155
            ## mutter("hashcache hit for %s %r -> %s", path, file_fp, cache_sha1)
 
156
            ## mutter("now = %s", time.time())
167
157
            self.hit_count += 1
168
158
            return cache_sha1
169
159
        
170
160
        self.miss_count += 1
171
161
 
172
 
 
173
162
        mode = file_fp[FP_MODE_COLUMN]
174
163
        if stat.S_ISREG(mode):
175
 
            digest = sha_file(file(abspath, 'rb', buffering=65000))
 
164
            digest = self._really_sha1_file(abspath)
176
165
        elif stat.S_ISLNK(mode):
177
 
            digest = sha.new(os.readlink(abspath)).hexdigest()
 
166
            digest = sha_string(os.readlink(abspath))
178
167
        else:
179
168
            raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
180
169
 
181
 
        now = int(time.time())
182
 
        if file_fp[FP_MTIME_COLUMN] >= now or file_fp[FP_CTIME_COLUMN] >= now:
 
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:
183
175
            # changed too recently; can't be cached.  we can
184
176
            # return the result and it could possibly be cached
185
177
            # next time.
191
183
            # need to let sufficient time elapse before we may cache this entry
192
184
            # again.  If we didn't do this, then, for example, a very quick 1
193
185
            # byte replacement in the file might go undetected.
194
 
            self.danger_count += 1 
 
186
            ## mutter('%r modified too recently; not caching', path)
 
187
            self.danger_count += 1
195
188
            if cache_fp:
196
189
                self.removed_count += 1
197
190
                self.needs_write = True
198
191
                del self._cache[path]
199
192
        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])
200
196
            self.update_count += 1
201
197
            self.needs_write = True
202
198
            self._cache[path] = (digest, file_fp)
203
199
        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
204
        
205
205
    def write(self):
206
206
        """Write contents of cache to file."""
207
207
        outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
208
208
        try:
209
 
            print >>outf, CACHE_HEADER,
 
209
            outf.write(CACHE_HEADER)
210
210
 
211
211
            for path, c  in self._cache.iteritems():
212
 
                assert '//' not in path, path
213
 
                outf.write(path.encode('utf-8'))
214
 
                outf.write('// ')
215
 
                print >>outf, c[0],     # hex sha1
216
 
                for fld in c[1]:
217
 
                    print >>outf, "%d" % fld,
218
 
                print >>outf
 
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))
219
216
            outf.commit()
220
217
            self.needs_write = False
221
 
            mutter("write hash cache: %s hits=%d misses=%d stat=%d recent=%d updates=%d",
222
 
                   self.cache_file_name(), self.hit_count, self.miss_count,
223
 
                   self.stat_count,
224
 
                   self.danger_count, self.update_count)
 
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)
225
222
        finally:
226
 
            if not outf.closed:
227
 
                outf.abort()
 
223
            outf.close()
228
224
 
229
225
    def read(self):
230
226
        """Reinstate cache from file.
244
240
            self.needs_write = True
245
241
            return
246
242
 
247
 
 
248
243
        hdr = inf.readline()
249
244
        if hdr != CACHE_HEADER:
250
245
            mutter('cache header marker not found at top of %s;'
275
270
            self._cache[path] = (sha1, fp)
276
271
 
277
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
278
281
           
279
 
 
280
 
 
281
 
        
 
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)