← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

  • Committer: Robert Collins
  • Date: 2005-10-02 22:47:02 UTC
  • mto: This revision was merged to the branch mainline in revision 1397.
  • Revision ID: robertc@robertcollins.net-20051002224701-8a8b20b90de559a6
support ghosts in commits

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)
 
103
 
95
104
 
96
105
    def cache_file_name(self):
97
 
        return self._cache_file_name
 
106
        return os.sep.join([self.basedir, '.bzr', 'stat-cache'])
 
107
 
 
108
 
 
109
 
98
110
 
99
111
    def clear(self):
100
112
        """Discard all cached information.
104
116
            self.needs_write = True
105
117
            self._cache = {}
106
118
 
 
119
 
107
120
    def scan(self):
108
121
        """Scan all files and remove entries where the cache entry is obsolete.
109
122
        
110
123
        Obsolete entries are those where the file has been modified or deleted
111
124
        since the entry was inserted.        
112
125
        """
113
 
        # FIXME optimisation opportunity, on linux [and check other oses]:
114
 
        # rather than iteritems order, stat in inode order.
115
126
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
116
127
        prep.sort()
117
128
        
118
129
        for inum, path, cache_entry in prep:
119
 
            abspath = pathjoin(self.root, path)
120
 
            fp = self._fingerprint(abspath)
 
130
            abspath = os.sep.join([self.basedir, path])
 
131
            fp = _fingerprint(abspath)
121
132
            self.stat_count += 1
122
133
            
123
134
            cache_fp = cache_entry[1]
128
139
                self.needs_write = True
129
140
                del self._cache[path]
130
141
 
 
142
 
131
143
    def get_sha1(self, path):
132
144
        """Return the sha1 of a file.
133
145
        """
134
 
        abspath = pathjoin(self.root, path)
 
146
        abspath = os.sep.join([self.basedir, path])
135
147
        self.stat_count += 1
136
 
        file_fp = self._fingerprint(abspath)
 
148
        file_fp = _fingerprint(abspath)
137
149
        
138
150
        if not file_fp:
139
151
            # not a regular file or not existing
149
161
            cache_sha1, cache_fp = None, None
150
162
 
151
163
        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
164
            self.hit_count += 1
155
165
            return cache_sha1
156
166
        
157
167
        self.miss_count += 1
158
168
 
 
169
 
159
170
        mode = file_fp[FP_MODE_COLUMN]
160
171
        if stat.S_ISREG(mode):
161
 
            digest = self._really_sha1_file(abspath)
 
172
            digest = sha_file(file(abspath, 'rb', buffering=65000))
162
173
        elif stat.S_ISLNK(mode):
 
174
            link_target = os.readlink(abspath)
163
175
            digest = sha.new(os.readlink(abspath)).hexdigest()
164
176
        else:
165
177
            raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
166
178
 
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:
 
179
        now = int(time.time())
 
180
        if file_fp[1] >= now or file_fp[2] >= now:
172
181
            # changed too recently; can't be cached.  we can
173
182
            # return the result and it could possibly be cached
174
183
            # 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
 
184
            self.danger_count += 1 
185
185
            if cache_fp:
186
186
                self.removed_count += 1
187
187
                self.needs_write = True
188
188
                del self._cache[path]
189
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])
193
190
            self.update_count += 1
194
191
            self.needs_write = True
195
192
            self._cache[path] = (digest, file_fp)
196
193
        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
194
        
202
195
    def write(self):
203
196
        """Write contents of cache to file."""
204
 
        outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
 
197
        outf = AtomicFile(self.cache_file_name(), 'wb')
205
198
        try:
206
 
            outf.write(CACHE_HEADER)
 
199
            print >>outf, CACHE_HEADER,
207
200
 
208
201
            for path, c  in self._cache.iteritems():
209
202
                assert '//' not in path, path
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
                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
210
            outf.commit()
215
211
            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)
220
212
        finally:
221
 
            outf.close()
 
213
            if not outf.closed:
 
214
                outf.abort()
 
215
        
 
216
 
222
217
 
223
218
    def read(self):
224
219
        """Reinstate cache from file.
233
228
        try:
234
229
            inf = file(fn, 'rb', buffering=65000)
235
230
        except IOError, e:
236
 
            mutter("failed to open %s: %s", fn, e)
 
231
            mutter("failed to open %s: %s" % (fn, e))
237
232
            # better write it now so it is valid
238
233
            self.needs_write = True
239
234
            return
240
235
 
 
236
 
241
237
        hdr = inf.readline()
242
238
        if hdr != CACHE_HEADER:
243
 
            mutter('cache header marker not found at top of %s;'
244
 
                   ' discarding cache', fn)
 
239
            mutter('cache header marker not found at top of %s; discarding cache'
 
240
                   % fn)
245
241
            self.needs_write = True
246
242
            return
247
243
 
268
264
            self._cache[path] = (sha1, fp)
269
265
 
270
266
        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
279
267
           
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)
 
268
 
 
269
 
 
270