/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: 2020-02-07 02:14:30 UTC
  • mto: This revision was merged to the branch mainline in revision 7492.
  • Revision ID: jelmer@jelmer.uk-20200207021430-m49iq3x4x8xlib6x
Drop python2 support.

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