/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/hashcache.py

  • Committer: Jelmer Vernooij
  • Date: 2019-03-13 23:24:13 UTC
  • mto: (7290.1.23 work)
  • mto: This revision was merged to the branch mainline in revision 7311.
  • Revision ID: jelmer@jelmer.uk-20190313232413-y1c951be4surcc9g
Fix formatting.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/hashcache.py
 
1
# Copyright (C) 2005-2010 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
# TODO: Up-front, stat all files in order and remove those which are deleted or
 
20
# out-of-date.  Don't actually re-read them until they're needed.  That ought
 
21
# to bring all the inodes into core so that future stats to them are fast, and
 
22
# it preserves the nice property that any caller will always get up-to-date
 
23
# data except in unavoidable cases.
 
24
 
 
25
# TODO: Perhaps return more details on the file to avoid statting it
 
26
# again: nonexistent, file type, size, etc
 
27
 
 
28
# TODO: Perhaps use a Python pickle instead of a text file; might be faster.
 
29
 
 
30
 
 
31
CACHE_HEADER = b"### bzr hashcache v5\n"
 
32
 
 
33
import os
 
34
import stat
 
35
import time
 
36
 
 
37
from . import (
 
38
    atomicfile,
 
39
    errors,
 
40
    filters as _mod_filters,
 
41
    osutils,
 
42
    trace,
 
43
    )
 
44
from .sixish import (
 
45
    text_type,
 
46
    viewitems,
 
47
    )
 
48
 
 
49
 
 
50
FP_MTIME_COLUMN = 1
 
51
FP_CTIME_COLUMN = 2
 
52
FP_MODE_COLUMN = 5
 
53
 
 
54
 
 
55
class HashCache(object):
 
56
    """Cache for looking up file SHA-1.
 
57
 
 
58
    Files are considered to match the cached value if the fingerprint
 
59
    of the file has not changed.  This includes its mtime, ctime,
 
60
    device number, inode number, and size.  This should catch
 
61
    modifications or replacement of the file by a new one.
 
62
 
 
63
    This may not catch modifications that do not change the file's
 
64
    size and that occur within the resolution window of the
 
65
    timestamps.  To handle this we specifically do not cache files
 
66
    which have changed since the start of the present second, since
 
67
    they could undetectably change again.
 
68
 
 
69
    This scheme may fail if the machine's clock steps backwards.
 
70
    Don't do that.
 
71
 
 
72
    This does not canonicalize the paths passed in; that should be
 
73
    done by the caller.
 
74
 
 
75
    _cache
 
76
        Indexed by path, points to a two-tuple of the SHA-1 of the file.
 
77
        and its fingerprint.
 
78
 
 
79
    stat_count
 
80
        number of times files have been statted
 
81
 
 
82
    hit_count
 
83
        number of times files have been retrieved from the cache, avoiding a
 
84
        re-read
 
85
 
 
86
    miss_count
 
87
        number of misses (times files have been completely re-read)
 
88
    """
 
89
    needs_write = False
 
90
 
 
91
    def __init__(self, root, cache_file_name, mode=None,
 
92
                 content_filter_stack_provider=None):
 
93
        """Create a hash cache in base dir, and set the file mode to mode.
 
94
 
 
95
        :param content_filter_stack_provider: a function that takes a
 
96
            path (relative to the top of the tree) and a file-id as
 
97
            parameters and returns a stack of ContentFilters.
 
98
            If None, no content filtering is performed.
 
99
        """
 
100
        if not isinstance(root, text_type):
 
101
            raise ValueError("Base dir for hashcache must be text")
 
102
        self.root = root
 
103
        self.hit_count = 0
 
104
        self.miss_count = 0
 
105
        self.stat_count = 0
 
106
        self.danger_count = 0
 
107
        self.removed_count = 0
 
108
        self.update_count = 0
 
109
        self._cache = {}
 
110
        self._mode = mode
 
111
        self._cache_file_name = cache_file_name
 
112
        self._filter_provider = content_filter_stack_provider
 
113
 
 
114
    def cache_file_name(self):
 
115
        return self._cache_file_name
 
116
 
 
117
    def clear(self):
 
118
        """Discard all cached information.
 
119
 
 
120
        This does not reset the counters."""
 
121
        if self._cache:
 
122
            self.needs_write = True
 
123
            self._cache = {}
 
124
 
 
125
    def scan(self):
 
126
        """Scan all files and remove entries where the cache entry is obsolete.
 
127
 
 
128
        Obsolete entries are those where the file has been modified or deleted
 
129
        since the entry was inserted.
 
130
        """
 
131
        # Stat in inode order as optimisation for at least linux.
 
132
        def inode_order(path_and_cache):
 
133
            return path_and_cache[1][1][3]
 
134
        for path, cache_val in sorted(viewitems(self._cache), key=inode_order):
 
135
            abspath = osutils.pathjoin(self.root, path)
 
136
            fp = self._fingerprint(abspath)
 
137
            self.stat_count += 1
 
138
 
 
139
            if not fp or cache_val[1] != fp:
 
140
                # not here or not a regular file anymore
 
141
                self.removed_count += 1
 
142
                self.needs_write = True
 
143
                del self._cache[path]
 
144
 
 
145
    def get_sha1(self, path, stat_value=None):
 
146
        """Return the sha1 of a file.
 
147
        """
 
148
        abspath = osutils.pathjoin(self.root, path)
 
149
        self.stat_count += 1
 
150
        file_fp = self._fingerprint(abspath, stat_value)
 
151
 
 
152
        if not file_fp:
 
153
            # not a regular file or not existing
 
154
            if path in self._cache:
 
155
                self.removed_count += 1
 
156
                self.needs_write = True
 
157
                del self._cache[path]
 
158
            return None
 
159
 
 
160
        if path in self._cache:
 
161
            cache_sha1, cache_fp = self._cache[path]
 
162
        else:
 
163
            cache_sha1, cache_fp = None, None
 
164
 
 
165
        if cache_fp == file_fp:
 
166
            self.hit_count += 1
 
167
            return cache_sha1
 
168
 
 
169
        self.miss_count += 1
 
170
 
 
171
        mode = file_fp[FP_MODE_COLUMN]
 
172
        if stat.S_ISREG(mode):
 
173
            if self._filter_provider is None:
 
174
                filters = []
 
175
            else:
 
176
                filters = self._filter_provider(path=path)
 
177
            digest = self._really_sha1_file(abspath, filters)
 
178
        elif stat.S_ISLNK(mode):
 
179
            target = osutils.readlink(abspath)
 
180
            digest = osutils.sha_string(target.encode('UTF-8'))
 
181
        else:
 
182
            raise errors.BzrError("file %r: unknown file stat mode: %o"
 
183
                                  % (abspath, mode))
 
184
 
 
185
        # window of 3 seconds to allow for 2s resolution on windows,
 
186
        # unsynchronized file servers, etc.
 
187
        cutoff = self._cutoff_time()
 
188
        if file_fp[FP_MTIME_COLUMN] >= cutoff \
 
189
                or file_fp[FP_CTIME_COLUMN] >= cutoff:
 
190
            # changed too recently; can't be cached.  we can
 
191
            # return the result and it could possibly be cached
 
192
            # next time.
 
193
            #
 
194
            # the point is that we only want to cache when we are sure that any
 
195
            # subsequent modifications of the file can be detected.  If a
 
196
            # modification neither changes the inode, the device, the size, nor
 
197
            # the mode, then we can only distinguish it by time; therefore we
 
198
            # need to let sufficient time elapse before we may cache this entry
 
199
            # again.  If we didn't do this, then, for example, a very quick 1
 
200
            # byte replacement in the file might go undetected.
 
201
            ## mutter('%r modified too recently; not caching', path)
 
202
            self.danger_count += 1
 
203
            if cache_fp:
 
204
                self.removed_count += 1
 
205
                self.needs_write = True
 
206
                del self._cache[path]
 
207
        else:
 
208
            # mutter('%r added to cache: now=%f, mtime=%d, ctime=%d',
 
209
            ##        path, time.time(), file_fp[FP_MTIME_COLUMN],
 
210
            # file_fp[FP_CTIME_COLUMN])
 
211
            self.update_count += 1
 
212
            self.needs_write = True
 
213
            self._cache[path] = (digest, file_fp)
 
214
        return digest
 
215
 
 
216
    def _really_sha1_file(self, abspath, filters):
 
217
        """Calculate the SHA1 of a file by reading the full text"""
 
218
        return _mod_filters.internal_size_sha_file_byname(abspath, filters)[1]
 
219
 
 
220
    def write(self):
 
221
        """Write contents of cache to file."""
 
222
        with atomicfile.AtomicFile(self.cache_file_name(), 'wb',
 
223
                                   new_mode=self._mode) as outf:
 
224
            outf.write(CACHE_HEADER)
 
225
 
 
226
            for path, c in viewitems(self._cache):
 
227
                line_info = [path.encode('utf-8'), b'// ', c[0], b' ']
 
228
                line_info.append(b'%d %d %d %d %d %d' % c[1])
 
229
                line_info.append(b'\n')
 
230
                outf.write(b''.join(line_info))
 
231
            self.needs_write = False
 
232
            # mutter("write hash cache: %s hits=%d misses=%d stat=%d recent=%d updates=%d",
 
233
            #        self.cache_file_name(), self.hit_count, self.miss_count,
 
234
            # self.stat_count,
 
235
            # self.danger_count, self.update_count)
 
236
 
 
237
    def read(self):
 
238
        """Reinstate cache from file.
 
239
 
 
240
        Overwrites existing cache.
 
241
 
 
242
        If the cache file has the wrong version marker, this just clears
 
243
        the cache."""
 
244
        self._cache = {}
 
245
 
 
246
        fn = self.cache_file_name()
 
247
        try:
 
248
            inf = open(fn, 'rb', buffering=65000)
 
249
        except IOError as e:
 
250
            trace.mutter("failed to open %s: %s", fn, str(e))
 
251
            # better write it now so it is valid
 
252
            self.needs_write = True
 
253
            return
 
254
 
 
255
        with inf:
 
256
            hdr = inf.readline()
 
257
            if hdr != CACHE_HEADER:
 
258
                trace.mutter('cache header marker not found at top of %s;'
 
259
                             ' discarding cache', fn)
 
260
                self.needs_write = True
 
261
                return
 
262
 
 
263
            for l in inf:
 
264
                pos = l.index(b'// ')
 
265
                path = l[:pos].decode('utf-8')
 
266
                if path in self._cache:
 
267
                    trace.warning('duplicated path %r in cache' % path)
 
268
                    continue
 
269
 
 
270
                pos += 3
 
271
                fields = l[pos:].split(b' ')
 
272
                if len(fields) != 7:
 
273
                    trace.warning("bad line in hashcache: %r" % l)
 
274
                    continue
 
275
 
 
276
                sha1 = fields[0]
 
277
                if len(sha1) != 40:
 
278
                    trace.warning("bad sha1 in hashcache: %r" % sha1)
 
279
                    continue
 
280
 
 
281
                fp = tuple(map(int, fields[1:]))
 
282
 
 
283
                self._cache[path] = (sha1, fp)
 
284
 
 
285
        self.needs_write = False
 
286
 
 
287
    def _cutoff_time(self):
 
288
        """Return cutoff time.
 
289
 
 
290
        Files modified more recently than this time are at risk of being
 
291
        undetectably modified and so can't be cached.
 
292
        """
 
293
        return int(time.time()) - 3
 
294
 
 
295
    def _fingerprint(self, abspath, stat_value=None):
 
296
        if stat_value is None:
 
297
            try:
 
298
                stat_value = os.lstat(abspath)
 
299
            except OSError:
 
300
                # might be missing, etc
 
301
                return None
 
302
        if stat.S_ISDIR(stat_value.st_mode):
 
303
            return None
 
304
        # we discard any high precision because it's not reliable; perhaps we
 
305
        # could do better on some systems?
 
306
        return (stat_value.st_size, int(stat_value.st_mtime),
 
307
                int(stat_value.st_ctime), stat_value.st_ino,
 
308
                stat_value.st_dev, stat_value.st_mode)