← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

- refactor handling of short option names

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/hashcache.py
1
 
# Copyright (C) 2005, 2006 by Canonical Ltd
 
1
# (C) 2005 Canonical Ltd
2
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
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
 
45
42
def _fingerprint(abspath):
94
91
    """
95
92
    needs_write = False
96
93
 
97
 
    def __init__(self, root, cache_file_name, mode=None):
98
 
        """Create a hash cache in base dir, and set the file mode to mode."""
99
 
        self.root = safe_unicode(root)
 
94
    def __init__(self, basedir):
 
95
        self.basedir = basedir
100
96
        self.hit_count = 0
101
97
        self.miss_count = 0
102
98
        self.stat_count = 0
104
100
        self.removed_count = 0
105
101
        self.update_count = 0
106
102
        self._cache = {}
107
 
        self._mode = mode
108
 
        self._cache_file_name = safe_unicode(cache_file_name)
109
103
 
110
104
    def cache_file_name(self):
111
 
        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'])
112
108
 
113
109
    def clear(self):
114
110
        """Discard all cached information.
118
114
            self.needs_write = True
119
115
            self._cache = {}
120
116
 
 
117
 
121
118
    def scan(self):
122
119
        """Scan all files and remove entries where the cache entry is obsolete.
123
120
        
124
121
        Obsolete entries are those where the file has been modified or deleted
125
122
        since the entry was inserted.        
126
123
        """
127
 
        # FIXME optimisation opportunity, on linux [and check other oses]:
128
 
        # rather than iteritems order, stat in inode order.
129
124
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
130
125
        prep.sort()
131
126
        
132
127
        for inum, path, cache_entry in prep:
133
 
            abspath = pathjoin(self.root, path)
 
128
            abspath = os.sep.join([self.basedir, path])
134
129
            fp = _fingerprint(abspath)
135
130
            self.stat_count += 1
136
131
            
146
141
    def get_sha1(self, path):
147
142
        """Return the sha1 of a file.
148
143
        """
149
 
        abspath = pathjoin(self.root, path)
 
144
        abspath = os.sep.join([self.basedir, path])
150
145
        self.stat_count += 1
151
146
        file_fp = _fingerprint(abspath)
152
147
        
174
169
        if stat.S_ISREG(mode):
175
170
            digest = sha_file(file(abspath, 'rb', buffering=65000))
176
171
        elif stat.S_ISLNK(mode):
 
172
            link_target = os.readlink(abspath)
177
173
            digest = sha.new(os.readlink(abspath)).hexdigest()
178
174
        else:
179
175
            raise BzrError("file %r: unknown file stat mode: %o"%(abspath,mode))
180
176
 
181
177
        now = int(time.time())
182
 
        if file_fp[FP_MTIME_COLUMN] >= now or file_fp[FP_CTIME_COLUMN] >= now:
 
178
        if file_fp[1] >= now or file_fp[2] >= now:
183
179
            # changed too recently; can't be cached.  we can
184
180
            # return the result and it could possibly be cached
185
181
            # next time.
186
 
            #
187
 
            # the point is that we only want to cache when we are sure that any
188
 
            # subsequent modifications of the file can be detected.  If a
189
 
            # modification neither changes the inode, the device, the size, nor
190
 
            # the mode, then we can only distinguish it by time; therefore we
191
 
            # need to let sufficient time elapse before we may cache this entry
192
 
            # again.  If we didn't do this, then, for example, a very quick 1
193
 
            # byte replacement in the file might go undetected.
194
182
            self.danger_count += 1 
195
183
            if cache_fp:
196
184
                self.removed_count += 1
204
192
        
205
193
    def write(self):
206
194
        """Write contents of cache to file."""
207
 
        outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
 
195
        outf = AtomicFile(self.cache_file_name(), 'wb')
208
196
        try:
209
197
            print >>outf, CACHE_HEADER,
210
198
 
216
204
                for fld in c[1]:
217
205
                    print >>outf, "%d" % fld,
218
206
                print >>outf
 
207
 
219
208
            outf.commit()
220
209
            self.needs_write = False
221
 
            mutter("write hash cache: %s hits=%d misses=%d stat=%d recent=%d updates=%d",
222
 
                   self.cache_file_name(), self.hit_count, self.miss_count,
223
 
                   self.stat_count,
224
 
                   self.danger_count, self.update_count)
225
210
        finally:
226
211
            if not outf.closed:
227
212
                outf.abort()
 
213
        
 
214
 
228
215
 
229
216
    def read(self):
230
217
        """Reinstate cache from file.
239
226
        try:
240
227
            inf = file(fn, 'rb', buffering=65000)
241
228
        except IOError, e:
242
 
            mutter("failed to open %s: %s", fn, e)
 
229
            mutter("failed to open %s: %s" % (fn, e))
243
230
            # better write it now so it is valid
244
231
            self.needs_write = True
245
232
            return
247
234
 
248
235
        hdr = inf.readline()
249
236
        if hdr != CACHE_HEADER:
250
 
            mutter('cache header marker not found at top of %s;'
251
 
                   ' discarding cache', fn)
 
237
            mutter('cache header marker not found at top of %s; discarding cache'
 
238
                   % fn)
252
239
            self.needs_write = True
253
240
            return
254
241