/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: Gustav Hartvigsson
  • Date: 2021-01-09 21:36:27 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20210109213627-h1xwcutzy9m7a99b
Added 'Case Preserving Working Tree Use Cases' from Canonical Wiki

* Addod a page from the Canonical Bazaar wiki
  with information on the scmeatics of case
  perserving filesystems an a case insensitive
  filesystem works.
  
  * Needs re-work, but this will do as it is the
    same inforamoton as what was on the linked
    page in the currint documentation.

Show diffs side-by-side

added added

removed removed

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