← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

- rules for using destructors

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
# (C) 2005 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, pathjoin, safe_unicode
 
35
from bzrlib.osutils import sha_file
36
36
from bzrlib.trace import mutter, warning
37
37
from bzrlib.atomicfile import AtomicFile
38
 
from bzrlib.errors import BzrError
39
 
 
40
 
 
41
 
FP_MTIME_COLUMN = 1
42
 
FP_CTIME_COLUMN = 2
 
38
 
 
39
 
43
40
FP_MODE_COLUMN = 5
44
41
 
 
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)
45
56
 
46
57
 
47
58
class HashCache(object):
80
91
    """
81
92
    needs_write = False
82
93
 
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)
 
94
    def __init__(self, basedir):
 
95
        self.basedir = basedir
86
96
        self.hit_count = 0
87
97
        self.miss_count = 0
88
98
        self.stat_count = 0
90
100
        self.removed_count = 0
91
101
        self.update_count = 0
92
102
        self._cache = {}
93
 
        self._mode = mode
94
 
        self._cache_file_name = safe_unicode(cache_file_name)
95
103
 
96
104
    def cache_file_name(self):
97
 
        return self._cache_file_name
 
105
        # FIXME: duplicate path logic here, this should be 
 
106
        # something like 'branch.controlfile'.
 
107
        return os.sep.join([self.basedir, '.bzr', 'stat-cache'])
98
108
 
99
109
    def clear(self):
100
110
        """Discard all cached information.
104
114
            self.needs_write = True
105
115
            self._cache = {}
106
116
 
 
117
 
107
118
    def scan(self):
108
119
        """Scan all files and remove entries where the cache entry is obsolete.
109
120
        
110
121
        Obsolete entries are those where the file has been modified or deleted
111
122
        since the entry was inserted.        
112
123
        """
113
 
        # FIXME optimisation opportunity, on linux [and check other oses]:
114
 
        # rather than iteritems order, stat in inode order.
115
124
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
116
125
        prep.sort()
117
126
        
118
127
        for inum, path, cache_entry in prep:
119
 
            abspath = pathjoin(self.root, path)
120
 
            fp = self._fingerprint(abspath)
 
128
            abspath = os.sep.join([self.basedir, path])
 
129
            fp = _fingerprint(abspath)
121
130
            self.stat_count += 1
122
131
            
123
132
            cache_fp = cache_entry[1]
128
137
                self.needs_write = True
129
138
                del self._cache[path]
130
139
 
 
140
 
131
141
    def get_sha1(self, path):
132
142
        """Return the sha1 of a file.
133
143
        """
134
 
        abspath = pathjoin(self.root, path)
 
144
        abspath = os.sep.join([self.basedir, path])
135
145
        self.stat_count += 1
136
 
        file_fp = self._fingerprint(abspath)
 
146
        file_fp = _fingerprint(abspath)
137
147
        
138
148
        if not file_fp:
139
149
            # not a regular file or not existing
149
159
            cache_sha1, cache_fp = None, None
150
160
 
151
161
        if cache_fp == file_fp:
152
 
            ## mutter("hashcache hit for %s %r -> %s", path, file_fp, cache_sha1)
153
 
            ## mutter("now = %s", time.time())
154
162
            self.hit_count += 1
155
163
            return cache_sha1
156
164
        
157
165
        self.miss_count += 1
158
166
 
 
167
 
159
168
        mode = file_fp[FP_MODE_COLUMN]
160
169
        if stat.S_ISREG(mode):
161
 
            digest = self._really_sha1_file(abspath)
 
170
            digest = sha_file(file(abspath, 'rb', buffering=65000))
162
171
        elif stat.S_ISLNK(mode):
 
172
            link_target = os.readlink(abspath)
163
173
            digest = sha.new(os.readlink(abspath)).hexdigest()
164
174
        else:
165
175
            raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
166
176
 
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:
 
177
        now = int(time.time())
 
178
        if file_fp[1] >= now or file_fp[2] >= now:
172
179
            # changed too recently; can't be cached.  we can
173
180
            # return the result and it could possibly be cached
174
181
            # next time.
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
 
182
            self.danger_count += 1 
185
183
            if cache_fp:
186
184
                self.removed_count += 1
187
185
                self.needs_write = True
188
186
                del self._cache[path]
189
187
        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])
193
188
            self.update_count += 1
194
189
            self.needs_write = True
195
190
            self._cache[path] = (digest, file_fp)
196
191
        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))
201
192
        
202
193
    def write(self):
203
194
        """Write contents of cache to file."""
204
 
        outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
 
195
        outf = AtomicFile(self.cache_file_name(), 'wb')
205
196
        try:
206
197
            print >>outf, CACHE_HEADER,
207
198
 
213
204
                for fld in c[1]:
214
205
                    print >>outf, "%d" % fld,
215
206
                print >>outf
 
207
 
216
208
            outf.commit()
217
209
            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)
222
210
        finally:
223
211
            if not outf.closed:
224
212
                outf.abort()
 
213
        
 
214
 
225
215
 
226
216
    def read(self):
227
217
        """Reinstate cache from file.
236
226
        try:
237
227
            inf = file(fn, 'rb', buffering=65000)
238
228
        except IOError, e:
239
 
            mutter("failed to open %s: %s", fn, e)
 
229
            mutter("failed to open %s: %s" % (fn, e))
240
230
            # better write it now so it is valid
241
231
            self.needs_write = True
242
232
            return
243
233
 
 
234
 
244
235
        hdr = inf.readline()
245
236
        if hdr != CACHE_HEADER:
246
 
            mutter('cache header marker not found at top of %s;'
247
 
                   ' discarding cache', fn)
 
237
            mutter('cache header marker not found at top of %s; discarding cache'
 
238
                   % fn)
248
239
            self.needs_write = True
249
240
            return
250
241
 
271
262
            self._cache[path] = (sha1, fp)
272
263
 
273
264
        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
282
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)
 
266
 
 
267
 
 
268