/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

  • Committer: Ian Clatworthy
  • Date: 2008-04-17 08:21:14 UTC
  • mto: (4171.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 4173.
  • Revision ID: ian.clatworthy@canonical.com-20080417082114-76imbiarcbj16ov3
first cut at working tree content filtering

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