← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

Fix BzrDir.create_workingtree for NULL_REVISION

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
32
32
import os, stat, time
33
33
import sha
34
34
 
35
 
from bzrlib.osutils import sha_file
 
35
from bzrlib.osutils import sha_file, pathjoin, safe_unicode
36
36
from bzrlib.trace import mutter, warning
37
37
from bzrlib.atomicfile import AtomicFile
38
 
from bzrlib.osutils import pathjoin
39
 
 
40
 
 
 
38
from bzrlib.errors import BzrError
 
39
 
 
40
 
 
41
FP_MTIME_COLUMN = 1
 
42
FP_CTIME_COLUMN = 2
41
43
FP_MODE_COLUMN = 5
42
44
 
43
 
def _fingerprint(abspath):
44
 
    try:
45
 
        fs = os.lstat(abspath)
46
 
    except OSError:
47
 
        # might be missing, etc
48
 
        return None
49
 
 
50
 
    if stat.S_ISDIR(fs.st_mode):
51
 
        return None
52
 
 
53
 
    # we discard any high precision because it's not reliable; perhaps we
54
 
    # could do better on some systems?
55
 
    return (fs.st_size, long(fs.st_mtime),
56
 
            long(fs.st_ctime), fs.st_ino, fs.st_dev, fs.st_mode)
57
45
 
58
46
 
59
47
class HashCache(object):
92
80
    """
93
81
    needs_write = False
94
82
 
95
 
    def __init__(self, basedir):
96
 
        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)
97
86
        self.hit_count = 0
98
87
        self.miss_count = 0
99
88
        self.stat_count = 0
101
90
        self.removed_count = 0
102
91
        self.update_count = 0
103
92
        self._cache = {}
 
93
        self._mode = mode
 
94
        self._cache_file_name = safe_unicode(cache_file_name)
104
95
 
105
96
    def cache_file_name(self):
106
 
        # FIXME: duplicate path logic here, this should be 
107
 
        # something like 'branch.controlfile'.
108
 
        return pathjoin(self.basedir, '.bzr', 'stat-cache')
 
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 = pathjoin(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
131
    def get_sha1(self, path):
143
132
        """Return the sha1 of a file.
144
133
        """
145
 
        abspath = pathjoin(self.basedir, path)
 
134
        abspath = pathjoin(self.root, path)
146
135
        self.stat_count += 1
147
 
        file_fp = _fingerprint(abspath)
 
136
        file_fp = self._fingerprint(abspath)
148
137
        
149
138
        if not file_fp:
150
139
            # not a regular file or not existing
160
149
            cache_sha1, cache_fp = None, None
161
150
 
162
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())
163
154
            self.hit_count += 1
164
155
            return cache_sha1
165
156
        
166
157
        self.miss_count += 1
167
158
 
168
 
 
169
159
        mode = file_fp[FP_MODE_COLUMN]
170
160
        if stat.S_ISREG(mode):
171
 
            digest = sha_file(file(abspath, 'rb', buffering=65000))
 
161
            digest = self._really_sha1_file(abspath)
172
162
        elif stat.S_ISLNK(mode):
173
 
            link_target = os.readlink(abspath)
174
163
            digest = sha.new(os.readlink(abspath)).hexdigest()
175
164
        else:
176
165
            raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
177
166
 
178
 
        now = int(time.time())
179
 
        if file_fp[1] >= now or file_fp[2] >= now:
 
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:
180
172
            # changed too recently; can't be cached.  we can
181
173
            # return the result and it could possibly be cached
182
174
            # next time.
183
 
            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
184
185
            if cache_fp:
185
186
                self.removed_count += 1
186
187
                self.needs_write = True
187
188
                del self._cache[path]
188
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])
189
193
            self.update_count += 1
190
194
            self.needs_write = True
191
195
            self._cache[path] = (digest, file_fp)
192
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))
193
201
        
194
202
    def write(self):
195
203
        """Write contents of cache to file."""
196
 
        outf = AtomicFile(self.cache_file_name(), 'wb')
 
204
        outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
197
205
        try:
198
 
            print >>outf, CACHE_HEADER,
 
206
            outf.write(CACHE_HEADER)
199
207
 
200
208
            for path, c  in self._cache.iteritems():
201
209
                assert '//' not in path, path
202
 
                outf.write(path.encode('utf-8'))
203
 
                outf.write('// ')
204
 
                print >>outf, c[0],     # hex sha1
205
 
                for fld in c[1]:
206
 
                    print >>outf, "%d" % fld,
207
 
                print >>outf
208
 
 
 
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))
209
214
            outf.commit()
210
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)
211
220
        finally:
212
 
            if not outf.closed:
213
 
                outf.abort()
 
221
            outf.close()
214
222
 
215
223
    def read(self):
216
224
        """Reinstate cache from file.
230
238
            self.needs_write = True
231
239
            return
232
240
 
233
 
 
234
241
        hdr = inf.readline()
235
242
        if hdr != CACHE_HEADER:
236
243
            mutter('cache header marker not found at top of %s;'
261
268
            self._cache[path] = (sha1, fp)
262
269
 
263
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
264
279
           
265
 
 
266
 
 
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)