← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

  • Committer: John Arbash Meinel
  • Date: 2006-09-20 14:51:03 UTC
  • mfrom: (0.8.23 version_info)
  • mto: This revision was merged to the branch mainline in revision 2028.
  • Revision ID: john@arbash-meinel.com-20060920145103-02725c6d6c886040
[merge] version-info plugin, and cleanup for layout in bzr

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