← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-08-01 20:07:49 UTC
  • mfrom: (1711.2.112 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060801200749-e0bd496331bb4d2b
(bialix) Create a nice win32 installer

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
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
 
35
from bzrlib.osutils import sha_file, pathjoin, safe_unicode
35
36
from bzrlib.trace import mutter, warning
36
37
from bzrlib.atomicfile import AtomicFile
37
 
 
38
 
 
39
 
 
40
 
 
41
 
def _fingerprint(abspath):
42
 
    try:
43
 
        fs = os.lstat(abspath)
44
 
    except OSError:
45
 
        # might be missing, etc
46
 
        return None
47
 
 
48
 
    if stat.S_ISDIR(fs.st_mode):
49
 
        return None
50
 
 
51
 
    # we discard any high precision because it's not reliable; perhaps we
52
 
    # could do better on some systems?
53
 
    return (fs.st_size, long(fs.st_mtime),
54
 
            long(fs.st_ctime), fs.st_ino, fs.st_dev)
 
38
from bzrlib.errors import BzrError
 
39
 
 
40
 
 
41
FP_MTIME_COLUMN = 1
 
42
FP_CTIME_COLUMN = 2
 
43
FP_MODE_COLUMN = 5
 
44
 
55
45
 
56
46
 
57
47
class HashCache(object):
90
80
    """
91
81
    needs_write = False
92
82
 
93
 
    def __init__(self, basedir):
94
 
        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)
95
86
        self.hit_count = 0
96
87
        self.miss_count = 0
97
88
        self.stat_count = 0
99
90
        self.removed_count = 0
100
91
        self.update_count = 0
101
92
        self._cache = {}
102
 
 
 
93
        self._mode = mode
 
94
        self._cache_file_name = safe_unicode(cache_file_name)
103
95
 
104
96
    def cache_file_name(self):
105
 
        return os.sep.join([self.basedir, '.bzr', 'stat-cache'])
106
 
 
107
 
 
108
 
 
 
97
        return self._cache_file_name
109
98
 
110
99
    def clear(self):
111
100
        """Discard all cached information.
115
104
            self.needs_write = True
116
105
            self._cache = {}
117
106
 
118
 
 
119
107
    def scan(self):
120
108
        """Scan all files and remove entries where the cache entry is obsolete.
121
109
        
122
110
        Obsolete entries are those where the file has been modified or deleted
123
111
        since the entry was inserted.        
124
112
        """
 
113
        # FIXME optimisation opportunity, on linux [and check other oses]:
 
114
        # rather than iteritems order, stat in inode order.
125
115
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
126
116
        prep.sort()
127
117
        
128
118
        for inum, path, cache_entry in prep:
129
 
            abspath = os.sep.join([self.basedir, path])
130
 
            fp = _fingerprint(abspath)
 
119
            abspath = pathjoin(self.root, path)
 
120
            fp = self._fingerprint(abspath)
131
121
            self.stat_count += 1
132
122
            
133
123
            cache_fp = cache_entry[1]
138
128
                self.needs_write = True
139
129
                del self._cache[path]
140
130
 
141
 
 
142
 
 
143
131
    def get_sha1(self, path):
144
132
        """Return the sha1 of a file.
145
133
        """
146
 
        abspath = os.sep.join([self.basedir, path])
 
134
        abspath = pathjoin(self.root, path)
147
135
        self.stat_count += 1
148
 
        file_fp = _fingerprint(abspath)
 
136
        file_fp = self._fingerprint(abspath)
149
137
        
150
138
        if not file_fp:
151
139
            # not a regular file or not existing
161
149
            cache_sha1, cache_fp = None, None
162
150
 
163
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())
164
154
            self.hit_count += 1
165
155
            return cache_sha1
166
156
        
167
157
        self.miss_count += 1
168
 
        digest = sha_file(file(abspath, 'rb', buffering=65000))
169
 
 
170
 
        now = int(time.time())
171
 
        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:
172
172
            # changed too recently; can't be cached.  we can
173
173
            # return the result and it could possibly be cached
174
174
            # next time.
175
 
            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
176
185
            if cache_fp:
177
186
                self.removed_count += 1
178
187
                self.needs_write = True
179
188
                del self._cache[path]
180
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])
181
193
            self.update_count += 1
182
194
            self.needs_write = True
183
195
            self._cache[path] = (digest, file_fp)
184
 
        
185
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))
186
201
        
187
 
 
188
 
 
189
 
 
190
202
    def write(self):
191
203
        """Write contents of cache to file."""
192
 
        outf = AtomicFile(self.cache_file_name(), 'wb')
 
204
        outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
193
205
        try:
194
206
            print >>outf, CACHE_HEADER,
195
207
 
201
213
                for fld in c[1]:
202
214
                    print >>outf, "%d" % fld,
203
215
                print >>outf
204
 
 
205
216
            outf.commit()
206
217
            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)
207
222
        finally:
208
223
            if not outf.closed:
209
224
                outf.abort()
210
 
        
211
 
 
212
225
 
213
226
    def read(self):
214
227
        """Reinstate cache from file.
223
236
        try:
224
237
            inf = file(fn, 'rb', buffering=65000)
225
238
        except IOError, e:
226
 
            mutter("failed to open %s: %s" % (fn, e))
 
239
            mutter("failed to open %s: %s", fn, e)
227
240
            # better write it now so it is valid
228
241
            self.needs_write = True
229
242
            return
230
243
 
231
 
 
232
244
        hdr = inf.readline()
233
245
        if hdr != CACHE_HEADER:
234
 
            mutter('cache header marker not found at top of %s; discarding cache'
235
 
                   % fn)
 
246
            mutter('cache header marker not found at top of %s;'
 
247
                   ' discarding cache', fn)
236
248
            self.needs_write = True
237
249
            return
238
250
 
245
257
 
246
258
            pos += 3
247
259
            fields = l[pos:].split(' ')
248
 
            if len(fields) != 6:
 
260
            if len(fields) != 7:
249
261
                warning("bad line in hashcache: %r" % l)
250
262
                continue
251
263
 
259
271
            self._cache[path] = (sha1, fp)
260
272
 
261
273
        self.needs_write = False
 
274
 
 
275
    def _cutoff_time(self):
 
276
        """Return cutoff time.
 
277
 
 
278
        Files modified more recently than this time are at risk of being
 
279
        undetectably modified and so can't be cached.
 
280
        """
 
281
        return int(time.time()) - 3
262
282
           
263
 
 
264
 
 
265
 
        
 
283
    def _fingerprint(self, abspath):
 
284
        try:
 
285
            fs = os.lstat(abspath)
 
286
        except OSError:
 
287
            # might be missing, etc
 
288
            return None
 
289
        if stat.S_ISDIR(fs.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 (fs.st_size, long(fs.st_mtime),
 
294
                long(fs.st_ctime), fs.st_ino, fs.st_dev, fs.st_mode)