← 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: 2009-02-18 13:27:08 UTC
  • mfrom: (4011.4.3 ssh-hints)
  • Revision ID: pqm@pqm.ubuntu.com-20090218132708-okubrahz9exvae9r
(Jelmer) Point out bzr+ssh:// to the user when they use ssh://.

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