← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

  • Committer: Aaron Bentley
  • Date: 2007-12-12 15:17:13 UTC
  • mto: This revision was merged to the branch mainline in revision 3113.
  • Revision ID: abentley@panoramicfeedback.com-20071212151713-ox5n8rlx8m3nsspy
Add support for reconfiguring repositories into branches or trees

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