← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

  • Committer: Aaron Bentley
  • Date: 2007-03-12 19:56:41 UTC
  • mto: (1551.19.24 Aaron's mergeable stuff)
  • mto: This revision was merged to the branch mainline in revision 2353.
  • Revision ID: abentley@panoramicfeedback.com-20070312195641-ezjnseqwgjtkh0iu
merge3 auto-detects line endings for conflict markers

Show diffs side-by-side

added added

removed removed

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