1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
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.
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.
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
17
"""DirState objects record the state of a directory and its bzr metadata.
19
Pseudo EBNF grammar for the state file. Fields are separated by NULLs, and
20
lines by NL. The field delimiters are ommitted in the grammar, line delimiters
21
are not - this is done for clarity of reading. All string data is in utf8.
23
MINIKIND = "f" | "d" | "l" | "a" | "r" | "t";
26
WHOLE_NUMBER = {digit}, digit;
28
REVISION_ID = a non-empty utf8 string;
30
dirstate format = header line, full checksum, row count, parent details,
31
ghost_details, entries;
32
header line = "#bazaar dirstate flat format 3", NL;
33
full checksum = "crc32: ", ["-"], WHOLE_NUMBER, NL;
34
row count = "num_entries: ", WHOLE_NUMBER, NL;
35
parent_details = WHOLE NUMBER, {REVISION_ID}* NL;
36
ghost_details = WHOLE NUMBER, {REVISION_ID}*, NL;
38
entry = entry_key, current_entry_details, {parent_entry_details};
39
entry_key = dirname, basename, fileid;
40
current_entry_details = common_entry_details, working_entry_details;
41
parent_entry_details = common_entry_details, history_entry_details;
42
common_entry_details = MINIKIND, fingerprint, size, executable
43
working_entry_details = packed_stat
44
history_entry_details = REVISION_ID;
47
fingerprint = a nonempty utf8 sequence with meaning defined by minikind.
49
Given this definition, the following is useful to know:
50
entry (aka row) - all the data for a given key.
51
entry[0]: The key (dirname, basename, fileid)
55
entry[1]: The tree(s) data for this path and id combination.
56
entry[1][0]: The current tree
57
entry[1][1]: The second tree
59
For an entry for a tree, we have (using tree 0 - current tree) to demonstrate:
60
entry[1][0][0]: minikind
61
entry[1][0][1]: fingerprint
63
entry[1][0][3]: executable
64
entry[1][0][4]: packed_stat
66
entry[1][1][4]: revision_id
68
There may be multiple rows at the root, one per id present in the root, so the
69
in memory root row is now:
70
self._dirblocks[0] -> ('', [entry ...]),
71
and the entries in there are
74
entries[0][2]: file_id
75
entries[1][0]: The tree data for the current tree for this fileid at /
79
'r' is a relocated entry: This path is not present in this tree with this id,
80
but the id can be found at another location. The fingerprint is used to
81
point to the target location.
82
'a' is an absent entry: In that tree the id is not present at this path.
83
'd' is a directory entry: This path in this tree is a directory with the
84
current file id. There is no fingerprint for directories.
85
'f' is a file entry: As for directory, but it's a file. The fingerprint is the
86
sha1 value of the file's canonical form, i.e. after any read filters have
87
been applied to the convenience form stored in the working tree.
88
'l' is a symlink entry: As for directory, but a symlink. The fingerprint is the
90
't' is a reference to a nested subtree; the fingerprint is the referenced
95
The entries on disk and in memory are ordered according to the following keys:
97
directory, as a list of components
101
--- Format 1 had the following different definition: ---
102
rows = dirname, NULL, basename, NULL, MINIKIND, NULL, fileid_utf8, NULL,
103
WHOLE NUMBER (* size *), NULL, packed stat, NULL, sha1|symlink target,
105
PARENT ROW = NULL, revision_utf8, NULL, MINIKIND, NULL, dirname, NULL,
106
basename, NULL, WHOLE NUMBER (* size *), NULL, "y" | "n", NULL,
109
PARENT ROW's are emitted for every parent that is not in the ghosts details
110
line. That is, if the parents are foo, bar, baz, and the ghosts are bar, then
111
each row will have a PARENT ROW for foo and baz, but not for bar.
114
In any tree, a kind of 'moved' indicates that the fingerprint field
115
(which we treat as opaque data specific to the 'kind' anyway) has the
116
details for the id of this row in that tree.
118
I'm strongly tempted to add a id->path index as well, but I think that
119
where we need id->path mapping; we also usually read the whole file, so
120
I'm going to skip that for the moment, as we have the ability to locate
121
via bisect any path in any tree, and if we lookup things by path, we can
122
accumulate an id->path mapping as we go, which will tend to match what we
125
I plan to implement this asap, so please speak up now to alter/tweak the
126
design - and once we stabilise on this, I'll update the wiki page for
129
The rationale for all this is that we want fast operations for the
130
common case (diff/status/commit/merge on all files) and extremely fast
131
operations for the less common but still occurs a lot status/diff/commit
132
on specific files). Operations on specific files involve a scan for all
133
the children of a path, *in every involved tree*, which the current
134
format did not accommodate.
138
1) Fast end to end use for bzr's top 5 uses cases. (commmit/diff/status/merge/???)
139
2) fall back current object model as needed.
140
3) scale usably to the largest trees known today - say 50K entries. (mozilla
141
is an example of this)
145
Eventually reuse dirstate objects across locks IFF the dirstate file has not
146
been modified, but will require that we flush/ignore cached stat-hit data
147
because we won't want to restat all files on disk just because a lock was
148
acquired, yet we cannot trust the data after the previous lock was released.
150
Memory representation:
151
vector of all directories, and vector of the childen ?
153
root_entrie = (direntry for root, [parent_direntries_for_root]),
155
('', ['data for achild', 'data for bchild', 'data for cchild'])
156
('dir', ['achild', 'cchild', 'echild'])
158
- single bisect to find N subtrees from a path spec
159
- in-order for serialisation - this is 'dirblock' grouping.
160
- insertion of a file '/a' affects only the '/' child-vector, that is, to
161
insert 10K elements from scratch does not generates O(N^2) memoves of a
162
single vector, rather each individual, which tends to be limited to a
163
manageable number. Will scale badly on trees with 10K entries in a
164
single directory. compare with Inventory.InventoryDirectory which has
165
a dictionary for the children. No bisect capability, can only probe for
166
exact matches, or grab all elements and sort.
167
- What's the risk of error here? Once we have the base format being processed
168
we should have a net win regardless of optimality. So we are going to
169
go with what seems reasonable.
172
Maybe we should do a test profile of the core structure - 10K simulated
173
searches/lookups/etc?
175
Objects for each row?
176
The lifetime of Dirstate objects is current per lock, but see above for
177
possible extensions. The lifetime of a row from a dirstate is expected to be
178
very short in the optimistic case: which we are optimising for. For instance,
179
subtree status will determine from analysis of the disk data what rows need to
180
be examined at all, and will be able to determine from a single row whether
181
that file has altered or not, so we are aiming to process tens of thousands of
182
entries each second within the dirstate context, before exposing anything to
183
the larger codebase. This suggests we want the time for a single file
184
comparison to be < 0.1 milliseconds. That would give us 10000 paths per second
185
processed, and to scale to 100 thousand we'll another order of magnitude to do
186
that. Now, as the lifetime for all unchanged entries is the time to parse, stat
187
the file on disk, and then immediately discard, the overhead of object creation
188
becomes a significant cost.
190
Figures: Creating a tuple from 3 elements was profiled at 0.0625
191
microseconds, whereas creating a object which is subclassed from tuple was
192
0.500 microseconds, and creating an object with 3 elements and slots was 3
193
microseconds long. 0.1 milliseconds is 100 microseconds, and ideally we'll get
194
down to 10 microseconds for the total processing - having 33% of that be object
195
creation is a huge overhead. There is a potential cost in using tuples within
196
each row which is that the conditional code to do comparisons may be slower
197
than method invocation, but method invocation is known to be slow due to stack
198
frame creation, so avoiding methods in these tight inner loops in unfortunately
199
desirable. We can consider a pyrex version of this with objects in future if
208
from stat import S_IEXEC
226
# This is the Windows equivalent of ENOTDIR
227
# It is defined in pywin32.winerror, but we don't want a strong dependency for
228
# just an error code.
229
ERROR_PATH_NOT_FOUND = 3
230
ERROR_DIRECTORY = 267
233
if not getattr(struct, '_compile', None):
234
# Cannot pre-compile the dirstate pack_stat
235
def pack_stat(st, _encode=binascii.b2a_base64, _pack=struct.pack):
236
"""Convert stat values into a packed representation."""
237
return _encode(_pack('>LLLLLL', st.st_size, int(st.st_mtime),
238
int(st.st_ctime), st.st_dev, st.st_ino & 0xFFFFFFFF,
241
# compile the struct compiler we need, so as to only do it once
242
from _struct import Struct
243
_compiled_pack = Struct('>LLLLLL').pack
244
def pack_stat(st, _encode=binascii.b2a_base64, _pack=_compiled_pack):
245
"""Convert stat values into a packed representation."""
246
# jam 20060614 it isn't really worth removing more entries if we
247
# are going to leave it in packed form.
248
# With only st_mtime and st_mode filesize is 5.5M and read time is 275ms
249
# With all entries, filesize is 5.9M and read time is maybe 280ms
250
# well within the noise margin
252
# base64 encoding always adds a final newline, so strip it off
253
# The current version
254
return _encode(_pack(st.st_size, int(st.st_mtime), int(st.st_ctime),
255
st.st_dev, st.st_ino & 0xFFFFFFFF, st.st_mode))[:-1]
256
# This is 0.060s / 1.520s faster by not encoding as much information
257
# return _encode(_pack('>LL', int(st.st_mtime), st.st_mode))[:-1]
258
# This is not strictly faster than _encode(_pack())[:-1]
259
# return '%X.%X.%X.%X.%X.%X' % (
260
# st.st_size, int(st.st_mtime), int(st.st_ctime),
261
# st.st_dev, st.st_ino, st.st_mode)
262
# Similar to the _encode(_pack('>LL'))
263
# return '%X.%X' % (int(st.st_mtime), st.st_mode)
266
class SHA1Provider(object):
267
"""An interface for getting sha1s of a file."""
269
def sha1(self, abspath):
270
"""Return the sha1 of a file given its absolute path.
272
:param abspath: May be a filesystem encoded absolute path
275
raise NotImplementedError(self.sha1)
277
def stat_and_sha1(self, abspath):
278
"""Return the stat and sha1 of a file given its absolute path.
280
:param abspath: May be a filesystem encoded absolute path
283
Note: the stat should be the stat of the physical file
284
while the sha may be the sha of its canonical content.
286
raise NotImplementedError(self.stat_and_sha1)
289
class DefaultSHA1Provider(SHA1Provider):
290
"""A SHA1Provider that reads directly from the filesystem."""
292
def sha1(self, abspath):
293
"""Return the sha1 of a file given its absolute path."""
294
return osutils.sha_file_by_name(abspath)
296
def stat_and_sha1(self, abspath):
297
"""Return the stat and sha1 of a file given its absolute path."""
298
file_obj = file(abspath, 'rb')
300
statvalue = os.fstat(file_obj.fileno())
301
sha1 = osutils.sha_file(file_obj)
304
return statvalue, sha1
307
class DirState(object):
308
"""Record directory and metadata state for fast access.
310
A dirstate is a specialised data structure for managing local working
311
tree state information. Its not yet well defined whether it is platform
312
specific, and if it is how we detect/parameterize that.
314
Dirstates use the usual lock_write, lock_read and unlock mechanisms.
315
Unlike most bzr disk formats, DirStates must be locked for reading, using
316
lock_read. (This is an os file lock internally.) This is necessary
317
because the file can be rewritten in place.
319
DirStates must be explicitly written with save() to commit changes; just
320
unlocking them does not write the changes to disk.
323
_kind_to_minikind = {
329
'tree-reference': 't',
331
_minikind_to_kind = {
337
't': 'tree-reference',
339
_stat_to_minikind = {
344
_to_yesno = {True:'y', False: 'n'} # TODO profile the performance gain
345
# of using int conversion rather than a dict here. AND BLAME ANDREW IF
348
# TODO: jam 20070221 Figure out what to do if we have a record that exceeds
349
# the BISECT_PAGE_SIZE. For now, we just have to make it large enough
350
# that we are sure a single record will always fit.
351
BISECT_PAGE_SIZE = 4096
354
IN_MEMORY_UNMODIFIED = 1
355
IN_MEMORY_MODIFIED = 2
357
# A pack_stat (the x's) that is just noise and will never match the output
360
NULL_PARENT_DETAILS = ('a', '', 0, False, '')
362
HEADER_FORMAT_2 = '#bazaar dirstate flat format 2\n'
363
HEADER_FORMAT_3 = '#bazaar dirstate flat format 3\n'
365
def __init__(self, path, sha1_provider):
366
"""Create a DirState object.
368
:param path: The path at which the dirstate file on disk should live.
369
:param sha1_provider: an object meeting the SHA1Provider interface.
371
# _header_state and _dirblock_state represent the current state
372
# of the dirstate metadata and the per-row data respectiely.
373
# NOT_IN_MEMORY indicates that no data is in memory
374
# IN_MEMORY_UNMODIFIED indicates that what we have in memory
375
# is the same as is on disk
376
# IN_MEMORY_MODIFIED indicates that we have a modified version
377
# of what is on disk.
378
# In future we will add more granularity, for instance _dirblock_state
379
# will probably support partially-in-memory as a separate variable,
380
# allowing for partially-in-memory unmodified and partially-in-memory
382
self._header_state = DirState.NOT_IN_MEMORY
383
self._dirblock_state = DirState.NOT_IN_MEMORY
384
# If true, an error has been detected while updating the dirstate, and
385
# for safety we're not going to commit to disk.
386
self._changes_aborted = False
390
self._state_file = None
391
self._filename = path
392
self._lock_token = None
393
self._lock_state = None
394
self._id_index = None
395
# a map from packed_stat to sha's.
396
self._packed_stat_index = None
397
self._end_of_header = None
398
self._cutoff_time = None
399
self._split_path_cache = {}
400
self._bisect_page_size = DirState.BISECT_PAGE_SIZE
401
self._sha1_provider = sha1_provider
402
if 'hashcache' in debug.debug_flags:
403
self._sha1_file = self._sha1_file_and_mutter
405
self._sha1_file = self._sha1_provider.sha1
406
# These two attributes provide a simple cache for lookups into the
407
# dirstate in-memory vectors. By probing respectively for the last
408
# block, and for the next entry, we save nearly 2 bisections per path
410
self._last_block_index = None
411
self._last_entry_index = None
415
(self.__class__.__name__, self._filename)
417
def add(self, path, file_id, kind, stat, fingerprint):
418
"""Add a path to be tracked.
420
:param path: The path within the dirstate - '' is the root, 'foo' is the
421
path foo within the root, 'foo/bar' is the path bar within foo
423
:param file_id: The file id of the path being added.
424
:param kind: The kind of the path, as a string like 'file',
426
:param stat: The output of os.lstat for the path.
427
:param fingerprint: The sha value of the file's canonical form (i.e.
428
after any read filters have been applied),
429
or the target of a symlink,
430
or the referenced revision id for tree-references,
431
or '' for directories.
434
# find the block its in.
435
# find the location in the block.
436
# check its not there
438
#------- copied from inventory.ensure_normalized_name - keep synced.
439
# --- normalized_filename wants a unicode basename only, so get one.
440
dirname, basename = osutils.split(path)
441
# we dont import normalized_filename directly because we want to be
442
# able to change the implementation at runtime for tests.
443
norm_name, can_access = osutils.normalized_filename(basename)
444
if norm_name != basename:
448
raise errors.InvalidNormalization(path)
449
# you should never have files called . or ..; just add the directory
450
# in the parent, or according to the special treatment for the root
451
if basename == '.' or basename == '..':
452
raise errors.InvalidEntryName(path)
453
# now that we've normalised, we need the correct utf8 path and
454
# dirname and basename elements. This single encode and split should be
455
# faster than three separate encodes.
456
utf8path = (dirname + '/' + basename).strip('/').encode('utf8')
457
dirname, basename = osutils.split(utf8path)
458
# uses __class__ for speed; the check is needed for safety
459
if file_id.__class__ is not str:
460
raise AssertionError(
461
"must be a utf8 file_id not %s" % (type(file_id), ))
462
# Make sure the file_id does not exist in this tree
464
file_id_entry = self._get_entry(0, fileid_utf8=file_id, include_deleted=True)
465
if file_id_entry != (None, None):
466
if file_id_entry[1][0][0] == 'a':
467
if file_id_entry[0] != (dirname, basename, file_id):
468
# set the old name's current operation to rename
469
self.update_minimal(file_id_entry[0],
475
rename_from = file_id_entry[0][0:2]
477
path = osutils.pathjoin(file_id_entry[0][0], file_id_entry[0][1])
478
kind = DirState._minikind_to_kind[file_id_entry[1][0][0]]
479
info = '%s:%s' % (kind, path)
480
raise errors.DuplicateFileId(file_id, info)
481
first_key = (dirname, basename, '')
482
block_index, present = self._find_block_index_from_key(first_key)
484
# check the path is not in the tree
485
block = self._dirblocks[block_index][1]
486
entry_index, _ = self._find_entry_index(first_key, block)
487
while (entry_index < len(block) and
488
block[entry_index][0][0:2] == first_key[0:2]):
489
if block[entry_index][1][0][0] not in 'ar':
490
# this path is in the dirstate in the current tree.
491
raise Exception, "adding already added path!"
494
# The block where we want to put the file is not present. But it
495
# might be because the directory was empty, or not loaded yet. Look
496
# for a parent entry, if not found, raise NotVersionedError
497
parent_dir, parent_base = osutils.split(dirname)
498
parent_block_idx, parent_entry_idx, _, parent_present = \
499
self._get_block_entry_index(parent_dir, parent_base, 0)
500
if not parent_present:
501
raise errors.NotVersionedError(path, str(self))
502
self._ensure_block(parent_block_idx, parent_entry_idx, dirname)
503
block = self._dirblocks[block_index][1]
504
entry_key = (dirname, basename, file_id)
507
packed_stat = DirState.NULLSTAT
510
packed_stat = pack_stat(stat)
511
parent_info = self._empty_parent_info()
512
minikind = DirState._kind_to_minikind[kind]
513
if rename_from is not None:
515
old_path_utf8 = '%s/%s' % rename_from
517
old_path_utf8 = rename_from[1]
518
parent_info[0] = ('r', old_path_utf8, 0, False, '')
520
entry_data = entry_key, [
521
(minikind, fingerprint, size, False, packed_stat),
523
elif kind == 'directory':
524
entry_data = entry_key, [
525
(minikind, '', 0, False, packed_stat),
527
elif kind == 'symlink':
528
entry_data = entry_key, [
529
(minikind, fingerprint, size, False, packed_stat),
531
elif kind == 'tree-reference':
532
entry_data = entry_key, [
533
(minikind, fingerprint, 0, False, packed_stat),
536
raise errors.BzrError('unknown kind %r' % kind)
537
entry_index, present = self._find_entry_index(entry_key, block)
539
block.insert(entry_index, entry_data)
541
if block[entry_index][1][0][0] != 'a':
542
raise AssertionError(" %r(%r) already added" % (basename, file_id))
543
block[entry_index][1][0] = entry_data[1][0]
545
if kind == 'directory':
546
# insert a new dirblock
547
self._ensure_block(block_index, entry_index, utf8path)
548
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
550
self._id_index.setdefault(entry_key[2], set()).add(entry_key)
552
def _bisect(self, paths):
553
"""Bisect through the disk structure for specific rows.
555
:param paths: A list of paths to find
556
:return: A dict mapping path => entries for found entries. Missing
557
entries will not be in the map.
558
The list is not sorted, and entries will be populated
559
based on when they were read.
561
self._requires_lock()
562
# We need the file pointer to be right after the initial header block
563
self._read_header_if_needed()
564
# If _dirblock_state was in memory, we should just return info from
565
# there, this function is only meant to handle when we want to read
567
if self._dirblock_state != DirState.NOT_IN_MEMORY:
568
raise AssertionError("bad dirblock state %r" % self._dirblock_state)
570
# The disk representation is generally info + '\0\n\0' at the end. But
571
# for bisecting, it is easier to treat this as '\0' + info + '\0\n'
572
# Because it means we can sync on the '\n'
573
state_file = self._state_file
574
file_size = os.fstat(state_file.fileno()).st_size
575
# We end up with 2 extra fields, we should have a trailing '\n' to
576
# ensure that we read the whole record, and we should have a precursur
577
# '' which ensures that we start after the previous '\n'
578
entry_field_count = self._fields_per_entry() + 1
580
low = self._end_of_header
581
high = file_size - 1 # Ignore the final '\0'
582
# Map from (dir, name) => entry
585
# Avoid infinite seeking
586
max_count = 30*len(paths)
588
# pending is a list of places to look.
589
# each entry is a tuple of low, high, dir_names
590
# low -> the first byte offset to read (inclusive)
591
# high -> the last byte offset (inclusive)
592
# dir_names -> The list of (dir, name) pairs that should be found in
593
# the [low, high] range
594
pending = [(low, high, paths)]
596
page_size = self._bisect_page_size
598
fields_to_entry = self._get_fields_to_entry()
601
low, high, cur_files = pending.pop()
603
if not cur_files or low >= high:
608
if count > max_count:
609
raise errors.BzrError('Too many seeks, most likely a bug.')
611
mid = max(low, (low+high-page_size)/2)
614
# limit the read size, so we don't end up reading data that we have
616
read_size = min(page_size, (high-mid)+1)
617
block = state_file.read(read_size)
620
entries = block.split('\n')
623
# We didn't find a '\n', so we cannot have found any records.
624
# So put this range back and try again. But we know we have to
625
# increase the page size, because a single read did not contain
626
# a record break (so records must be larger than page_size)
628
pending.append((low, high, cur_files))
631
# Check the first and last entries, in case they are partial, or if
632
# we don't care about the rest of this page
634
first_fields = entries[0].split('\0')
635
if len(first_fields) < entry_field_count:
636
# We didn't get the complete first entry
637
# so move start, and grab the next, which
638
# should be a full entry
639
start += len(entries[0])+1
640
first_fields = entries[1].split('\0')
643
if len(first_fields) <= 2:
644
# We didn't even get a filename here... what do we do?
645
# Try a large page size and repeat this query
647
pending.append((low, high, cur_files))
650
# Find what entries we are looking for, which occur before and
651
# after this first record.
654
first_path = first_fields[1] + '/' + first_fields[2]
656
first_path = first_fields[2]
657
first_loc = _bisect_path_left(cur_files, first_path)
659
# These exist before the current location
660
pre = cur_files[:first_loc]
661
# These occur after the current location, which may be in the
662
# data we read, or might be after the last entry
663
post = cur_files[first_loc:]
665
if post and len(first_fields) >= entry_field_count:
666
# We have files after the first entry
668
# Parse the last entry
669
last_entry_num = len(entries)-1
670
last_fields = entries[last_entry_num].split('\0')
671
if len(last_fields) < entry_field_count:
672
# The very last hunk was not complete,
673
# read the previous hunk
674
after = mid + len(block) - len(entries[-1])
676
last_fields = entries[last_entry_num].split('\0')
678
after = mid + len(block)
681
last_path = last_fields[1] + '/' + last_fields[2]
683
last_path = last_fields[2]
684
last_loc = _bisect_path_right(post, last_path)
686
middle_files = post[:last_loc]
687
post = post[last_loc:]
690
# We have files that should occur in this block
691
# (>= first, <= last)
692
# Either we will find them here, or we can mark them as
695
if middle_files[0] == first_path:
696
# We might need to go before this location
697
pre.append(first_path)
698
if middle_files[-1] == last_path:
699
post.insert(0, last_path)
701
# Find out what paths we have
702
paths = {first_path:[first_fields]}
703
# last_path might == first_path so we need to be
704
# careful if we should append rather than overwrite
705
if last_entry_num != first_entry_num:
706
paths.setdefault(last_path, []).append(last_fields)
707
for num in xrange(first_entry_num+1, last_entry_num):
708
# TODO: jam 20070223 We are already splitting here, so
709
# shouldn't we just split the whole thing rather
710
# than doing the split again in add_one_record?
711
fields = entries[num].split('\0')
713
path = fields[1] + '/' + fields[2]
716
paths.setdefault(path, []).append(fields)
718
for path in middle_files:
719
for fields in paths.get(path, []):
720
# offset by 1 because of the opening '\0'
721
# consider changing fields_to_entry to avoid the
723
entry = fields_to_entry(fields[1:])
724
found.setdefault(path, []).append(entry)
726
# Now we have split up everything into pre, middle, and post, and
727
# we have handled everything that fell in 'middle'.
728
# We add 'post' first, so that we prefer to seek towards the
729
# beginning, so that we will tend to go as early as we need, and
730
# then only seek forward after that.
732
pending.append((after, high, post))
734
pending.append((low, start-1, pre))
736
# Consider that we may want to return the directory entries in sorted
737
# order. For now, we just return them in whatever order we found them,
738
# and leave it up to the caller if they care if it is ordered or not.
741
def _bisect_dirblocks(self, dir_list):
742
"""Bisect through the disk structure to find entries in given dirs.
744
_bisect_dirblocks is meant to find the contents of directories, which
745
differs from _bisect, which only finds individual entries.
747
:param dir_list: A sorted list of directory names ['', 'dir', 'foo'].
748
:return: A map from dir => entries_for_dir
750
# TODO: jam 20070223 A lot of the bisecting logic could be shared
751
# between this and _bisect. It would require parameterizing the
752
# inner loop with a function, though. We should evaluate the
753
# performance difference.
754
self._requires_lock()
755
# We need the file pointer to be right after the initial header block
756
self._read_header_if_needed()
757
# If _dirblock_state was in memory, we should just return info from
758
# there, this function is only meant to handle when we want to read
760
if self._dirblock_state != DirState.NOT_IN_MEMORY:
761
raise AssertionError("bad dirblock state %r" % self._dirblock_state)
762
# The disk representation is generally info + '\0\n\0' at the end. But
763
# for bisecting, it is easier to treat this as '\0' + info + '\0\n'
764
# Because it means we can sync on the '\n'
765
state_file = self._state_file
766
file_size = os.fstat(state_file.fileno()).st_size
767
# We end up with 2 extra fields, we should have a trailing '\n' to
768
# ensure that we read the whole record, and we should have a precursur
769
# '' which ensures that we start after the previous '\n'
770
entry_field_count = self._fields_per_entry() + 1
772
low = self._end_of_header
773
high = file_size - 1 # Ignore the final '\0'
774
# Map from dir => entry
777
# Avoid infinite seeking
778
max_count = 30*len(dir_list)
780
# pending is a list of places to look.
781
# each entry is a tuple of low, high, dir_names
782
# low -> the first byte offset to read (inclusive)
783
# high -> the last byte offset (inclusive)
784
# dirs -> The list of directories that should be found in
785
# the [low, high] range
786
pending = [(low, high, dir_list)]
788
page_size = self._bisect_page_size
790
fields_to_entry = self._get_fields_to_entry()
793
low, high, cur_dirs = pending.pop()
795
if not cur_dirs or low >= high:
800
if count > max_count:
801
raise errors.BzrError('Too many seeks, most likely a bug.')
803
mid = max(low, (low+high-page_size)/2)
806
# limit the read size, so we don't end up reading data that we have
808
read_size = min(page_size, (high-mid)+1)
809
block = state_file.read(read_size)
812
entries = block.split('\n')
815
# We didn't find a '\n', so we cannot have found any records.
816
# So put this range back and try again. But we know we have to
817
# increase the page size, because a single read did not contain
818
# a record break (so records must be larger than page_size)
820
pending.append((low, high, cur_dirs))
823
# Check the first and last entries, in case they are partial, or if
824
# we don't care about the rest of this page
826
first_fields = entries[0].split('\0')
827
if len(first_fields) < entry_field_count:
828
# We didn't get the complete first entry
829
# so move start, and grab the next, which
830
# should be a full entry
831
start += len(entries[0])+1
832
first_fields = entries[1].split('\0')
835
if len(first_fields) <= 1:
836
# We didn't even get a dirname here... what do we do?
837
# Try a large page size and repeat this query
839
pending.append((low, high, cur_dirs))
842
# Find what entries we are looking for, which occur before and
843
# after this first record.
845
first_dir = first_fields[1]
846
first_loc = bisect.bisect_left(cur_dirs, first_dir)
848
# These exist before the current location
849
pre = cur_dirs[:first_loc]
850
# These occur after the current location, which may be in the
851
# data we read, or might be after the last entry
852
post = cur_dirs[first_loc:]
854
if post and len(first_fields) >= entry_field_count:
855
# We have records to look at after the first entry
857
# Parse the last entry
858
last_entry_num = len(entries)-1
859
last_fields = entries[last_entry_num].split('\0')
860
if len(last_fields) < entry_field_count:
861
# The very last hunk was not complete,
862
# read the previous hunk
863
after = mid + len(block) - len(entries[-1])
865
last_fields = entries[last_entry_num].split('\0')
867
after = mid + len(block)
869
last_dir = last_fields[1]
870
last_loc = bisect.bisect_right(post, last_dir)
872
middle_files = post[:last_loc]
873
post = post[last_loc:]
876
# We have files that should occur in this block
877
# (>= first, <= last)
878
# Either we will find them here, or we can mark them as
881
if middle_files[0] == first_dir:
882
# We might need to go before this location
883
pre.append(first_dir)
884
if middle_files[-1] == last_dir:
885
post.insert(0, last_dir)
887
# Find out what paths we have
888
paths = {first_dir:[first_fields]}
889
# last_dir might == first_dir so we need to be
890
# careful if we should append rather than overwrite
891
if last_entry_num != first_entry_num:
892
paths.setdefault(last_dir, []).append(last_fields)
893
for num in xrange(first_entry_num+1, last_entry_num):
894
# TODO: jam 20070223 We are already splitting here, so
895
# shouldn't we just split the whole thing rather
896
# than doing the split again in add_one_record?
897
fields = entries[num].split('\0')
898
paths.setdefault(fields[1], []).append(fields)
900
for cur_dir in middle_files:
901
for fields in paths.get(cur_dir, []):
902
# offset by 1 because of the opening '\0'
903
# consider changing fields_to_entry to avoid the
905
entry = fields_to_entry(fields[1:])
906
found.setdefault(cur_dir, []).append(entry)
908
# Now we have split up everything into pre, middle, and post, and
909
# we have handled everything that fell in 'middle'.
910
# We add 'post' first, so that we prefer to seek towards the
911
# beginning, so that we will tend to go as early as we need, and
912
# then only seek forward after that.
914
pending.append((after, high, post))
916
pending.append((low, start-1, pre))
920
def _bisect_recursive(self, paths):
921
"""Bisect for entries for all paths and their children.
923
This will use bisect to find all records for the supplied paths. It
924
will then continue to bisect for any records which are marked as
925
directories. (and renames?)
927
:param paths: A sorted list of (dir, name) pairs
928
eg: [('', 'a'), ('', 'f'), ('a/b', 'c')]
929
:return: A dictionary mapping (dir, name, file_id) => [tree_info]
931
# Map from (dir, name, file_id) => [tree_info]
934
found_dir_names = set()
936
# Directories that have been read
937
processed_dirs = set()
938
# Get the ball rolling with the first bisect for all entries.
939
newly_found = self._bisect(paths)
942
# Directories that need to be read
944
paths_to_search = set()
945
for entry_list in newly_found.itervalues():
946
for dir_name_id, trees_info in entry_list:
947
found[dir_name_id] = trees_info
948
found_dir_names.add(dir_name_id[:2])
950
for tree_info in trees_info:
951
minikind = tree_info[0]
954
# We already processed this one as a directory,
955
# we don't need to do the extra work again.
957
subdir, name, file_id = dir_name_id
958
path = osutils.pathjoin(subdir, name)
960
if path not in processed_dirs:
961
pending_dirs.add(path)
962
elif minikind == 'r':
963
# Rename, we need to directly search the target
964
# which is contained in the fingerprint column
965
dir_name = osutils.split(tree_info[1])
966
if dir_name[0] in pending_dirs:
967
# This entry will be found in the dir search
969
if dir_name not in found_dir_names:
970
paths_to_search.add(tree_info[1])
971
# Now we have a list of paths to look for directly, and
972
# directory blocks that need to be read.
973
# newly_found is mixing the keys between (dir, name) and path
974
# entries, but that is okay, because we only really care about the
976
newly_found = self._bisect(sorted(paths_to_search))
977
newly_found.update(self._bisect_dirblocks(sorted(pending_dirs)))
978
processed_dirs.update(pending_dirs)
981
def _discard_merge_parents(self):
982
"""Discard any parents trees beyond the first.
984
Note that if this fails the dirstate is corrupted.
986
After this function returns the dirstate contains 2 trees, neither of
989
self._read_header_if_needed()
990
parents = self.get_parent_ids()
993
# only require all dirblocks if we are doing a full-pass removal.
994
self._read_dirblocks_if_needed()
995
dead_patterns = set([('a', 'r'), ('a', 'a'), ('r', 'r'), ('r', 'a')])
996
def iter_entries_removable():
997
for block in self._dirblocks:
998
deleted_positions = []
999
for pos, entry in enumerate(block[1]):
1001
if (entry[1][0][0], entry[1][1][0]) in dead_patterns:
1002
deleted_positions.append(pos)
1003
if deleted_positions:
1004
if len(deleted_positions) == len(block[1]):
1007
for pos in reversed(deleted_positions):
1009
# if the first parent is a ghost:
1010
if parents[0] in self.get_ghosts():
1011
empty_parent = [DirState.NULL_PARENT_DETAILS]
1012
for entry in iter_entries_removable():
1013
entry[1][1:] = empty_parent
1015
for entry in iter_entries_removable():
1019
self._parents = [parents[0]]
1020
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1021
self._header_state = DirState.IN_MEMORY_MODIFIED
1023
def _empty_parent_info(self):
1024
return [DirState.NULL_PARENT_DETAILS] * (len(self._parents) -
1027
def _ensure_block(self, parent_block_index, parent_row_index, dirname):
1028
"""Ensure a block for dirname exists.
1030
This function exists to let callers which know that there is a
1031
directory dirname ensure that the block for it exists. This block can
1032
fail to exist because of demand loading, or because a directory had no
1033
children. In either case it is not an error. It is however an error to
1034
call this if there is no parent entry for the directory, and thus the
1035
function requires the coordinates of such an entry to be provided.
1037
The root row is special cased and can be indicated with a parent block
1040
:param parent_block_index: The index of the block in which dirname's row
1042
:param parent_row_index: The index in the parent block where the row
1044
:param dirname: The utf8 dirname to ensure there is a block for.
1045
:return: The index for the block.
1047
if dirname == '' and parent_row_index == 0 and parent_block_index == 0:
1048
# This is the signature of the root row, and the
1049
# contents-of-root row is always index 1
1051
# the basename of the directory must be the end of its full name.
1052
if not (parent_block_index == -1 and
1053
parent_block_index == -1 and dirname == ''):
1054
if not dirname.endswith(
1055
self._dirblocks[parent_block_index][1][parent_row_index][0][1]):
1056
raise AssertionError("bad dirname %r" % dirname)
1057
block_index, present = self._find_block_index_from_key((dirname, '', ''))
1059
## In future, when doing partial parsing, this should load and
1060
# populate the entire block.
1061
self._dirblocks.insert(block_index, (dirname, []))
1064
def _entries_to_current_state(self, new_entries):
1065
"""Load new_entries into self.dirblocks.
1067
Process new_entries into the current state object, making them the active
1068
state. The entries are grouped together by directory to form dirblocks.
1070
:param new_entries: A sorted list of entries. This function does not sort
1071
to prevent unneeded overhead when callers have a sorted list already.
1074
if new_entries[0][0][0:2] != ('', ''):
1075
raise AssertionError(
1076
"Missing root row %r" % (new_entries[0][0],))
1077
# The two blocks here are deliberate: the root block and the
1078
# contents-of-root block.
1079
self._dirblocks = [('', []), ('', [])]
1080
current_block = self._dirblocks[0][1]
1081
current_dirname = ''
1083
append_entry = current_block.append
1084
for entry in new_entries:
1085
if entry[0][0] != current_dirname:
1086
# new block - different dirname
1088
current_dirname = entry[0][0]
1089
self._dirblocks.append((current_dirname, current_block))
1090
append_entry = current_block.append
1091
# append the entry to the current block
1093
self._split_root_dirblock_into_contents()
1095
def _split_root_dirblock_into_contents(self):
1096
"""Split the root dirblocks into root and contents-of-root.
1098
After parsing by path, we end up with root entries and contents-of-root
1099
entries in the same block. This loop splits them out again.
1101
# The above loop leaves the "root block" entries mixed with the
1102
# "contents-of-root block". But we don't want an if check on
1103
# all entries, so instead we just fix it up here.
1104
if self._dirblocks[1] != ('', []):
1105
raise ValueError("bad dirblock start %r" % (self._dirblocks[1],))
1107
contents_of_root_block = []
1108
for entry in self._dirblocks[0][1]:
1109
if not entry[0][1]: # This is a root entry
1110
root_block.append(entry)
1112
contents_of_root_block.append(entry)
1113
self._dirblocks[0] = ('', root_block)
1114
self._dirblocks[1] = ('', contents_of_root_block)
1116
def _entries_for_path(self, path):
1117
"""Return a list with all the entries that match path for all ids."""
1118
dirname, basename = os.path.split(path)
1119
key = (dirname, basename, '')
1120
block_index, present = self._find_block_index_from_key(key)
1122
# the block which should contain path is absent.
1125
block = self._dirblocks[block_index][1]
1126
entry_index, _ = self._find_entry_index(key, block)
1127
# we may need to look at multiple entries at this path: walk while the specific_files match.
1128
while (entry_index < len(block) and
1129
block[entry_index][0][0:2] == key[0:2]):
1130
result.append(block[entry_index])
1134
def _entry_to_line(self, entry):
1135
"""Serialize entry to a NULL delimited line ready for _get_output_lines.
1137
:param entry: An entry_tuple as defined in the module docstring.
1139
entire_entry = list(entry[0])
1140
for tree_number, tree_data in enumerate(entry[1]):
1141
# (minikind, fingerprint, size, executable, tree_specific_string)
1142
entire_entry.extend(tree_data)
1143
# 3 for the key, 5 for the fields per tree.
1144
tree_offset = 3 + tree_number * 5
1146
entire_entry[tree_offset + 0] = tree_data[0]
1148
entire_entry[tree_offset + 2] = str(tree_data[2])
1150
entire_entry[tree_offset + 3] = DirState._to_yesno[tree_data[3]]
1151
return '\0'.join(entire_entry)
1153
def _fields_per_entry(self):
1154
"""How many null separated fields should be in each entry row.
1156
Each line now has an extra '\n' field which is not used
1157
so we just skip over it
1159
3 fields for the key
1160
+ number of fields per tree_data (5) * tree count
1163
tree_count = 1 + self._num_present_parents()
1164
return 3 + 5 * tree_count + 1
1166
def _find_block(self, key, add_if_missing=False):
1167
"""Return the block that key should be present in.
1169
:param key: A dirstate entry key.
1170
:return: The block tuple.
1172
block_index, present = self._find_block_index_from_key(key)
1174
if not add_if_missing:
1175
# check to see if key is versioned itself - we might want to
1176
# add it anyway, because dirs with no entries dont get a
1177
# dirblock at parse time.
1178
# This is an uncommon branch to take: most dirs have children,
1179
# and most code works with versioned paths.
1180
parent_base, parent_name = osutils.split(key[0])
1181
if not self._get_block_entry_index(parent_base, parent_name, 0)[3]:
1182
# some parent path has not been added - its an error to add
1184
raise errors.NotVersionedError(key[0:2], str(self))
1185
self._dirblocks.insert(block_index, (key[0], []))
1186
return self._dirblocks[block_index]
1188
def _find_block_index_from_key(self, key):
1189
"""Find the dirblock index for a key.
1191
:return: The block index, True if the block for the key is present.
1193
if key[0:2] == ('', ''):
1196
if (self._last_block_index is not None and
1197
self._dirblocks[self._last_block_index][0] == key[0]):
1198
return self._last_block_index, True
1201
block_index = bisect_dirblock(self._dirblocks, key[0], 1,
1202
cache=self._split_path_cache)
1203
# _right returns one-past-where-key is so we have to subtract
1204
# one to use it. we use _right here because there are two
1205
# '' blocks - the root, and the contents of root
1206
# we always have a minimum of 2 in self._dirblocks: root and
1207
# root-contents, and for '', we get 2 back, so this is
1208
# simple and correct:
1209
present = (block_index < len(self._dirblocks) and
1210
self._dirblocks[block_index][0] == key[0])
1211
self._last_block_index = block_index
1212
# Reset the entry index cache to the beginning of the block.
1213
self._last_entry_index = -1
1214
return block_index, present
1216
def _find_entry_index(self, key, block):
1217
"""Find the entry index for a key in a block.
1219
:return: The entry index, True if the entry for the key is present.
1221
len_block = len(block)
1223
if self._last_entry_index is not None:
1225
entry_index = self._last_entry_index + 1
1226
# A hit is when the key is after the last slot, and before or
1227
# equal to the next slot.
1228
if ((entry_index > 0 and block[entry_index - 1][0] < key) and
1229
key <= block[entry_index][0]):
1230
self._last_entry_index = entry_index
1231
present = (block[entry_index][0] == key)
1232
return entry_index, present
1235
entry_index = bisect.bisect_left(block, (key, []))
1236
present = (entry_index < len_block and
1237
block[entry_index][0] == key)
1238
self._last_entry_index = entry_index
1239
return entry_index, present
1242
def from_tree(tree, dir_state_filename, sha1_provider=None):
1243
"""Create a dirstate from a bzr Tree.
1245
:param tree: The tree which should provide parent information and
1247
:param sha1_provider: an object meeting the SHA1Provider interface.
1248
If None, a DefaultSHA1Provider is used.
1249
:return: a DirState object which is currently locked for writing.
1250
(it was locked by DirState.initialize)
1252
result = DirState.initialize(dir_state_filename,
1253
sha1_provider=sha1_provider)
1257
parent_ids = tree.get_parent_ids()
1258
num_parents = len(parent_ids)
1260
for parent_id in parent_ids:
1261
parent_tree = tree.branch.repository.revision_tree(parent_id)
1262
parent_trees.append((parent_id, parent_tree))
1263
parent_tree.lock_read()
1264
result.set_parent_trees(parent_trees, [])
1265
result.set_state_from_inventory(tree.inventory)
1267
for revid, parent_tree in parent_trees:
1268
parent_tree.unlock()
1271
# The caller won't have a chance to unlock this, so make sure we
1277
def update_by_delta(self, delta):
1278
"""Apply an inventory delta to the dirstate for tree 0
1280
:param delta: An inventory delta. See Inventory.apply_delta for
1283
self._read_dirblocks_if_needed()
1286
for old_path, new_path, file_id, inv_entry in sorted(delta, reverse=True):
1287
if (file_id in insertions) or (file_id in removals):
1288
raise errors.InconsistentDelta(old_path or new_path, file_id,
1290
if old_path is not None:
1291
old_path = old_path.encode('utf-8')
1292
removals[file_id] = old_path
1293
if new_path is not None:
1294
new_path = new_path.encode('utf-8')
1295
dirname, basename = osutils.split(new_path)
1296
key = (dirname, basename, file_id)
1297
minikind = DirState._kind_to_minikind[inv_entry.kind]
1299
fingerprint = inv_entry.reference_revision
1302
insertions[file_id] = (key, minikind, inv_entry.executable,
1303
fingerprint, new_path)
1304
# Transform moves into delete+add pairs
1305
if None not in (old_path, new_path):
1306
for child in self._iter_child_entries(0, old_path):
1307
if child[0][2] in insertions or child[0][2] in removals:
1309
child_dirname = child[0][0]
1310
child_basename = child[0][1]
1311
minikind = child[1][0][0]
1312
fingerprint = child[1][0][4]
1313
executable = child[1][0][3]
1314
old_child_path = osutils.pathjoin(child[0][0],
1316
removals[child[0][2]] = old_child_path
1317
child_suffix = child_dirname[len(old_path):]
1318
new_child_dirname = (new_path + child_suffix)
1319
key = (new_child_dirname, child_basename, child[0][2])
1320
new_child_path = os.path.join(new_child_dirname,
1322
insertions[child[0][2]] = (key, minikind, executable,
1323
fingerprint, new_child_path)
1324
self._apply_removals(removals.values())
1325
self._apply_insertions(insertions.values())
1327
def _apply_removals(self, removals):
1328
for path in sorted(removals, reverse=True):
1329
dirname, basename = osutils.split(path)
1330
block_i, entry_i, d_present, f_present = \
1331
self._get_block_entry_index(dirname, basename, 0)
1332
entry = self._dirblocks[block_i][1][entry_i]
1333
self._make_absent(entry)
1334
# See if we have a malformed delta: deleting a directory must not
1335
# leave crud behind. This increases the number of bisects needed
1336
# substantially, but deletion or renames of large numbers of paths
1337
# is rare enough it shouldn't be an issue (famous last words?) RBC
1339
block_i, entry_i, d_present, f_present = \
1340
self._get_block_entry_index(path, '', 0)
1342
# The dir block is still present in the dirstate; this could
1343
# be due to it being in a parent tree, or a corrupt delta.
1344
for child_entry in self._dirblocks[block_i][1]:
1345
if child_entry[1][0][0] not in ('r', 'a'):
1346
raise errors.InconsistentDelta(path, entry[0][2],
1347
"The file id was deleted but its children were "
1350
def _apply_insertions(self, adds):
1351
for key, minikind, executable, fingerprint, path_utf8 in sorted(adds):
1352
self.update_minimal(key, minikind, executable, fingerprint,
1353
path_utf8=path_utf8)
1355
def update_basis_by_delta(self, delta, new_revid):
1356
"""Update the parents of this tree after a commit.
1358
This gives the tree one parent, with revision id new_revid. The
1359
inventory delta is applied to the current basis tree to generate the
1360
inventory for the parent new_revid, and all other parent trees are
1363
Note that an exception during the operation of this method will leave
1364
the dirstate in a corrupt state where it should not be saved.
1366
Finally, we expect all changes to be synchronising the basis tree with
1369
:param new_revid: The new revision id for the trees parent.
1370
:param delta: An inventory delta (see apply_inventory_delta) describing
1371
the changes from the current left most parent revision to new_revid.
1373
self._read_dirblocks_if_needed()
1374
self._discard_merge_parents()
1375
if self._ghosts != []:
1376
raise NotImplementedError(self.update_basis_by_delta)
1377
if len(self._parents) == 0:
1378
# setup a blank tree, the most simple way.
1379
empty_parent = DirState.NULL_PARENT_DETAILS
1380
for entry in self._iter_entries():
1381
entry[1].append(empty_parent)
1382
self._parents.append(new_revid)
1384
self._parents[0] = new_revid
1386
delta = sorted(delta, reverse=True)
1390
# The paths this function accepts are unicode and must be encoded as we
1392
encode = cache_utf8.encode
1393
inv_to_entry = self._inv_entry_to_details
1394
# delta is now (deletes, changes), (adds) in reverse lexographical
1396
# deletes in reverse lexographic order are safe to process in situ.
1397
# renames are not, as a rename from any path could go to a path
1398
# lexographically lower, so we transform renames into delete, add pairs,
1399
# expanding them recursively as needed.
1400
# At the same time, to reduce interface friction we convert the input
1401
# inventory entries to dirstate.
1402
root_only = ('', '')
1403
# Accumulate parent references (path and id), to check for parentless
1404
# items or items placed under files/links/tree-references. We get
1405
# references from every item in the delta that is not a deletion and
1406
# is not itself the root.
1408
for old_path, new_path, file_id, inv_entry in delta:
1409
if inv_entry is not None and file_id != inv_entry.file_id:
1410
raise errors.InconsistentDelta(new_path, file_id,
1411
"mismatched entry file_id %r" % inv_entry)
1412
if new_path is not None:
1413
new_path_utf8 = encode(new_path)
1414
# note the parent for validation
1415
dirname_utf8, basename_utf8 = osutils.split(new_path_utf8)
1417
parents.add((dirname_utf8, inv_entry.parent_id))
1418
if old_path is None:
1419
adds.append((None, encode(new_path), file_id,
1420
inv_to_entry(inv_entry), True))
1421
elif new_path is None:
1422
deletes.append((encode(old_path), None, file_id, None, True))
1423
elif (old_path, new_path) != root_only:
1425
# Because renames must preserve their children we must have
1426
# processed all relocations and removes before hand. The sort
1427
# order ensures we've examined the child paths, but we also
1428
# have to execute the removals, or the split to an add/delete
1429
# pair will result in the deleted item being reinserted, or
1430
# renamed items being reinserted twice - and possibly at the
1431
# wrong place. Splitting into a delete/add pair also simplifies
1432
# the handling of entries with ('f', ...), ('r' ...) because
1433
# the target of the 'r' is old_path here, and we add that to
1434
# deletes, meaning that the add handler does not need to check
1435
# for 'r' items on every pass.
1436
self._update_basis_apply_deletes(deletes)
1438
# Split into an add/delete pair recursively.
1439
adds.append((None, new_path_utf8, file_id,
1440
inv_to_entry(inv_entry), False))
1441
# Expunge deletes that we've seen so that deleted/renamed
1442
# children of a rename directory are handled correctly.
1443
new_deletes = reversed(list(self._iter_child_entries(1,
1445
# Remove the current contents of the tree at orig_path, and
1446
# reinsert at the correct new path.
1447
for entry in new_deletes:
1449
source_path = entry[0][0] + '/' + entry[0][1]
1451
source_path = entry[0][1]
1453
target_path = new_path_utf8 + source_path[len(old_path):]
1456
raise AssertionError("cannot rename directory to"
1458
target_path = source_path[len(old_path) + 1:]
1459
adds.append((None, target_path, entry[0][2], entry[1][1], False))
1461
(source_path, target_path, entry[0][2], None, False))
1463
(encode(old_path), new_path, file_id, None, False))
1465
# changes to just the root should not require remove/insertion
1467
changes.append((encode(old_path), encode(new_path), file_id,
1468
inv_to_entry(inv_entry)))
1471
# Finish expunging deletes/first half of renames.
1472
self._update_basis_apply_deletes(deletes)
1473
# Reinstate second half of renames and new paths.
1474
self._update_basis_apply_adds(adds)
1475
# Apply in-situ changes.
1476
self._update_basis_apply_changes(changes)
1478
self._update_basis_check_parents(parents)
1479
except errors.BzrError, e:
1480
if 'integrity error' not in str(e):
1482
# _get_entry raises BzrError when a request is inconsistent; we
1483
# want such errors to be shown as InconsistentDelta - and that
1484
# fits the behaviour we trigger. Partof this is driven by dirstate
1485
# only supporting deltas that turn the basis into a closer fit to
1487
self._changes_aborted = True
1488
raise errors.InconsistentDeltaDelta(delta, "error from _get_entry.")
1490
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1491
self._header_state = DirState.IN_MEMORY_MODIFIED
1492
self._id_index = None
1495
def _update_basis_apply_adds(self, adds):
1496
"""Apply a sequence of adds to tree 1 during update_basis_by_delta.
1498
They may be adds, or renames that have been split into add/delete
1501
:param adds: A sequence of adds. Each add is a tuple:
1502
(None, new_path_utf8, file_id, (entry_details), real_add). real_add
1503
is False when the add is the second half of a remove-and-reinsert
1504
pair created to handle renames and deletes.
1506
# Adds are accumulated partly from renames, so can be in any input
1509
# adds is now in lexographic order, which places all parents before
1510
# their children, so we can process it linearly.
1512
for old_path, new_path, file_id, new_details, real_add in adds:
1513
# the entry for this file_id must be in tree 0.
1514
entry = self._get_entry(0, file_id, new_path)
1515
if entry[0] is None or entry[0][2] != file_id:
1516
self._changes_aborted = True
1517
raise errors.InconsistentDelta(new_path, file_id,
1518
'working tree does not contain new entry')
1519
if real_add and entry[1][1][0] not in absent:
1520
self._changes_aborted = True
1521
raise errors.InconsistentDelta(new_path, file_id,
1522
'The entry was considered to be a genuinely new record,'
1523
' but there was already an old record for it.')
1524
# We don't need to update the target of an 'r' because the handling
1525
# of renames turns all 'r' situations into a delete at the original
1527
entry[1][1] = new_details
1529
def _update_basis_apply_changes(self, changes):
1530
"""Apply a sequence of changes to tree 1 during update_basis_by_delta.
1532
:param adds: A sequence of changes. Each change is a tuple:
1533
(path_utf8, path_utf8, file_id, (entry_details))
1536
for old_path, new_path, file_id, new_details in changes:
1537
# the entry for this file_id must be in tree 0.
1538
entry = self._get_entry(0, file_id, new_path)
1539
if entry[0] is None or entry[0][2] != file_id:
1540
self._changes_aborted = True
1541
raise errors.InconsistentDelta(new_path, file_id,
1542
'working tree does not contain new entry')
1543
if (entry[1][0][0] in absent or
1544
entry[1][1][0] in absent):
1545
self._changes_aborted = True
1546
raise errors.InconsistentDelta(new_path, file_id,
1547
'changed considered absent')
1548
entry[1][1] = new_details
1550
def _update_basis_apply_deletes(self, deletes):
1551
"""Apply a sequence of deletes to tree 1 during update_basis_by_delta.
1553
They may be deletes, or renames that have been split into add/delete
1556
:param deletes: A sequence of deletes. Each delete is a tuple:
1557
(old_path_utf8, new_path_utf8, file_id, None, real_delete).
1558
real_delete is True when the desired outcome is an actual deletion
1559
rather than the rename handling logic temporarily deleting a path
1560
during the replacement of a parent.
1562
null = DirState.NULL_PARENT_DETAILS
1563
for old_path, new_path, file_id, _, real_delete in deletes:
1564
if real_delete != (new_path is None):
1565
raise AssertionError("bad delete delta")
1566
# the entry for this file_id must be in tree 1.
1567
dirname, basename = osutils.split(old_path)
1568
block_index, entry_index, dir_present, file_present = \
1569
self._get_block_entry_index(dirname, basename, 1)
1570
if not file_present:
1571
self._changes_aborted = True
1572
raise errors.InconsistentDelta(old_path, file_id,
1573
'basis tree does not contain removed entry')
1574
entry = self._dirblocks[block_index][1][entry_index]
1575
if entry[0][2] != file_id:
1576
self._changes_aborted = True
1577
raise errors.InconsistentDelta(old_path, file_id,
1578
'mismatched file_id in tree 1')
1580
if entry[1][0][0] != 'a':
1581
self._changes_aborted = True
1582
raise errors.InconsistentDelta(old_path, file_id,
1583
'This was marked as a real delete, but the WT state'
1584
' claims that it still exists and is versioned.')
1585
del self._dirblocks[block_index][1][entry_index]
1587
if entry[1][0][0] == 'a':
1588
self._changes_aborted = True
1589
raise errors.InconsistentDelta(old_path, file_id,
1590
'The entry was considered a rename, but the source path'
1591
' is marked as absent.')
1592
# For whatever reason, we were asked to rename an entry
1593
# that was originally marked as deleted. This could be
1594
# because we are renaming the parent directory, and the WT
1595
# current state has the file marked as deleted.
1596
elif entry[1][0][0] == 'r':
1597
# implement the rename
1598
del self._dirblocks[block_index][1][entry_index]
1600
# it is being resurrected here, so blank it out temporarily.
1601
self._dirblocks[block_index][1][entry_index][1][1] = null
1603
def _update_basis_check_parents(self, parents):
1604
"""Check that parents required by the delta are all intact."""
1605
for dirname_utf8, file_id in parents:
1606
# Get the entry - the ensures that file_id, dirname_utf8 exists and
1607
# has the right file id.
1608
entry = self._get_entry(1, file_id, dirname_utf8)
1609
if entry[1] is None:
1610
self._changes_aborted = True
1611
raise errors.InconsistentDelta(dirname_utf8.decode('utf8'),
1612
file_id, "This parent is not present.")
1613
# Parents of things must be directories
1614
if entry[1][1][0] != 'd':
1615
self._changes_aborted = True
1616
raise errors.InconsistentDelta(dirname_utf8.decode('utf8'),
1617
file_id, "This parent is not a directory.")
1619
def _observed_sha1(self, entry, sha1, stat_value,
1620
_stat_to_minikind=_stat_to_minikind, _pack_stat=pack_stat):
1621
"""Note the sha1 of a file.
1623
:param entry: The entry the sha1 is for.
1624
:param sha1: The observed sha1.
1625
:param stat_value: The os.lstat for the file.
1628
minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
1632
packed_stat = _pack_stat(stat_value)
1634
if self._cutoff_time is None:
1635
self._sha_cutoff_time()
1636
if (stat_value.st_mtime < self._cutoff_time
1637
and stat_value.st_ctime < self._cutoff_time):
1638
entry[1][0] = ('f', sha1, entry[1][0][2], entry[1][0][3],
1640
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1642
def _sha_cutoff_time(self):
1643
"""Return cutoff time.
1645
Files modified more recently than this time are at risk of being
1646
undetectably modified and so can't be cached.
1648
# Cache the cutoff time as long as we hold a lock.
1649
# time.time() isn't super expensive (approx 3.38us), but
1650
# when you call it 50,000 times it adds up.
1651
# For comparison, os.lstat() costs 7.2us if it is hot.
1652
self._cutoff_time = int(time.time()) - 3
1653
return self._cutoff_time
1655
def _lstat(self, abspath, entry):
1656
"""Return the os.lstat value for this path."""
1657
return os.lstat(abspath)
1659
def _sha1_file_and_mutter(self, abspath):
1660
# when -Dhashcache is turned on, this is monkey-patched in to log
1662
trace.mutter("dirstate sha1 " + abspath)
1663
return self._sha1_provider.sha1(abspath)
1665
def _is_executable(self, mode, old_executable):
1666
"""Is this file executable?"""
1667
return bool(S_IEXEC & mode)
1669
def _is_executable_win32(self, mode, old_executable):
1670
"""On win32 the executable bit is stored in the dirstate."""
1671
return old_executable
1673
if sys.platform == 'win32':
1674
_is_executable = _is_executable_win32
1676
def _read_link(self, abspath, old_link):
1677
"""Read the target of a symlink"""
1678
# TODO: jam 200700301 On Win32, this could just return the value
1679
# already in memory. However, this really needs to be done at a
1680
# higher level, because there either won't be anything on disk,
1681
# or the thing on disk will be a file.
1682
fs_encoding = osutils._fs_enc
1683
if isinstance(abspath, unicode):
1684
# abspath is defined as the path to pass to lstat. readlink is
1685
# buggy in python < 2.6 (it doesn't encode unicode path into FS
1686
# encoding), so we need to encode ourselves knowing that unicode
1687
# paths are produced by UnicodeDirReader on purpose.
1688
abspath = abspath.encode(fs_encoding)
1689
target = os.readlink(abspath)
1690
if fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1691
# Change encoding if needed
1692
target = target.decode(fs_encoding).encode('UTF-8')
1695
def get_ghosts(self):
1696
"""Return a list of the parent tree revision ids that are ghosts."""
1697
self._read_header_if_needed()
1700
def get_lines(self):
1701
"""Serialise the entire dirstate to a sequence of lines."""
1702
if (self._header_state == DirState.IN_MEMORY_UNMODIFIED and
1703
self._dirblock_state == DirState.IN_MEMORY_UNMODIFIED):
1704
# read whats on disk.
1705
self._state_file.seek(0)
1706
return self._state_file.readlines()
1708
lines.append(self._get_parents_line(self.get_parent_ids()))
1709
lines.append(self._get_ghosts_line(self._ghosts))
1710
# append the root line which is special cased
1711
lines.extend(map(self._entry_to_line, self._iter_entries()))
1712
return self._get_output_lines(lines)
1714
def _get_ghosts_line(self, ghost_ids):
1715
"""Create a line for the state file for ghost information."""
1716
return '\0'.join([str(len(ghost_ids))] + ghost_ids)
1718
def _get_parents_line(self, parent_ids):
1719
"""Create a line for the state file for parents information."""
1720
return '\0'.join([str(len(parent_ids))] + parent_ids)
1722
def _get_fields_to_entry(self):
1723
"""Get a function which converts entry fields into a entry record.
1725
This handles size and executable, as well as parent records.
1727
:return: A function which takes a list of fields, and returns an
1728
appropriate record for storing in memory.
1730
# This is intentionally unrolled for performance
1731
num_present_parents = self._num_present_parents()
1732
if num_present_parents == 0:
1733
def fields_to_entry_0_parents(fields, _int=int):
1734
path_name_file_id_key = (fields[0], fields[1], fields[2])
1735
return (path_name_file_id_key, [
1737
fields[3], # minikind
1738
fields[4], # fingerprint
1739
_int(fields[5]), # size
1740
fields[6] == 'y', # executable
1741
fields[7], # packed_stat or revision_id
1743
return fields_to_entry_0_parents
1744
elif num_present_parents == 1:
1745
def fields_to_entry_1_parent(fields, _int=int):
1746
path_name_file_id_key = (fields[0], fields[1], fields[2])
1747
return (path_name_file_id_key, [
1749
fields[3], # minikind
1750
fields[4], # fingerprint
1751
_int(fields[5]), # size
1752
fields[6] == 'y', # executable
1753
fields[7], # packed_stat or revision_id
1756
fields[8], # minikind
1757
fields[9], # fingerprint
1758
_int(fields[10]), # size
1759
fields[11] == 'y', # executable
1760
fields[12], # packed_stat or revision_id
1763
return fields_to_entry_1_parent
1764
elif num_present_parents == 2:
1765
def fields_to_entry_2_parents(fields, _int=int):
1766
path_name_file_id_key = (fields[0], fields[1], fields[2])
1767
return (path_name_file_id_key, [
1769
fields[3], # minikind
1770
fields[4], # fingerprint
1771
_int(fields[5]), # size
1772
fields[6] == 'y', # executable
1773
fields[7], # packed_stat or revision_id
1776
fields[8], # minikind
1777
fields[9], # fingerprint
1778
_int(fields[10]), # size
1779
fields[11] == 'y', # executable
1780
fields[12], # packed_stat or revision_id
1783
fields[13], # minikind
1784
fields[14], # fingerprint
1785
_int(fields[15]), # size
1786
fields[16] == 'y', # executable
1787
fields[17], # packed_stat or revision_id
1790
return fields_to_entry_2_parents
1792
def fields_to_entry_n_parents(fields, _int=int):
1793
path_name_file_id_key = (fields[0], fields[1], fields[2])
1794
trees = [(fields[cur], # minikind
1795
fields[cur+1], # fingerprint
1796
_int(fields[cur+2]), # size
1797
fields[cur+3] == 'y', # executable
1798
fields[cur+4], # stat or revision_id
1799
) for cur in xrange(3, len(fields)-1, 5)]
1800
return path_name_file_id_key, trees
1801
return fields_to_entry_n_parents
1803
def get_parent_ids(self):
1804
"""Return a list of the parent tree ids for the directory state."""
1805
self._read_header_if_needed()
1806
return list(self._parents)
1808
def _get_block_entry_index(self, dirname, basename, tree_index):
1809
"""Get the coordinates for a path in the state structure.
1811
:param dirname: The utf8 dirname to lookup.
1812
:param basename: The utf8 basename to lookup.
1813
:param tree_index: The index of the tree for which this lookup should
1815
:return: A tuple describing where the path is located, or should be
1816
inserted. The tuple contains four fields: the block index, the row
1817
index, the directory is present (boolean), the entire path is
1818
present (boolean). There is no guarantee that either
1819
coordinate is currently reachable unless the found field for it is
1820
True. For instance, a directory not present in the searched tree
1821
may be returned with a value one greater than the current highest
1822
block offset. The directory present field will always be True when
1823
the path present field is True. The directory present field does
1824
NOT indicate that the directory is present in the searched tree,
1825
rather it indicates that there are at least some files in some
1828
self._read_dirblocks_if_needed()
1829
key = dirname, basename, ''
1830
block_index, present = self._find_block_index_from_key(key)
1832
# no such directory - return the dir index and 0 for the row.
1833
return block_index, 0, False, False
1834
block = self._dirblocks[block_index][1] # access the entries only
1835
entry_index, present = self._find_entry_index(key, block)
1836
# linear search through entries at this path to find the one
1838
while entry_index < len(block) and block[entry_index][0][1] == basename:
1839
if block[entry_index][1][tree_index][0] not in 'ar':
1840
# neither absent or relocated
1841
return block_index, entry_index, True, True
1843
return block_index, entry_index, True, False
1845
def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None, include_deleted=False):
1846
"""Get the dirstate entry for path in tree tree_index.
1848
If either file_id or path is supplied, it is used as the key to lookup.
1849
If both are supplied, the fastest lookup is used, and an error is
1850
raised if they do not both point at the same row.
1852
:param tree_index: The index of the tree we wish to locate this path
1853
in. If the path is present in that tree, the entry containing its
1854
details is returned, otherwise (None, None) is returned
1855
0 is the working tree, higher indexes are successive parent
1857
:param fileid_utf8: A utf8 file_id to look up.
1858
:param path_utf8: An utf8 path to be looked up.
1859
:param include_deleted: If True, and performing a lookup via
1860
fileid_utf8 rather than path_utf8, return an entry for deleted
1862
:return: The dirstate entry tuple for path, or (None, None)
1864
self._read_dirblocks_if_needed()
1865
if path_utf8 is not None:
1866
if type(path_utf8) is not str:
1867
raise errors.BzrError('path_utf8 is not a str: %s %r'
1868
% (type(path_utf8), path_utf8))
1869
# path lookups are faster
1870
dirname, basename = osutils.split(path_utf8)
1871
block_index, entry_index, dir_present, file_present = \
1872
self._get_block_entry_index(dirname, basename, tree_index)
1873
if not file_present:
1875
entry = self._dirblocks[block_index][1][entry_index]
1876
if not (entry[0][2] and entry[1][tree_index][0] not in ('a', 'r')):
1877
raise AssertionError('unversioned entry?')
1879
if entry[0][2] != fileid_utf8:
1880
self._changes_aborted = True
1881
raise errors.BzrError('integrity error ? : mismatching'
1882
' tree_index, file_id and path')
1885
possible_keys = self._get_id_index().get(fileid_utf8, None)
1886
if not possible_keys:
1888
for key in possible_keys:
1889
block_index, present = \
1890
self._find_block_index_from_key(key)
1891
# strange, probably indicates an out of date
1892
# id index - for now, allow this.
1895
# WARNING: DO not change this code to use _get_block_entry_index
1896
# as that function is not suitable: it does not use the key
1897
# to lookup, and thus the wrong coordinates are returned.
1898
block = self._dirblocks[block_index][1]
1899
entry_index, present = self._find_entry_index(key, block)
1901
entry = self._dirblocks[block_index][1][entry_index]
1902
if entry[1][tree_index][0] in 'fdlt':
1903
# this is the result we are looking for: the
1904
# real home of this file_id in this tree.
1906
if entry[1][tree_index][0] == 'a':
1907
# there is no home for this entry in this tree
1911
if entry[1][tree_index][0] != 'r':
1912
raise AssertionError(
1913
"entry %r has invalid minikind %r for tree %r" \
1915
entry[1][tree_index][0],
1917
real_path = entry[1][tree_index][1]
1918
return self._get_entry(tree_index, fileid_utf8=fileid_utf8,
1919
path_utf8=real_path)
1923
def initialize(cls, path, sha1_provider=None):
1924
"""Create a new dirstate on path.
1926
The new dirstate will be an empty tree - that is it has no parents,
1927
and only a root node - which has id ROOT_ID.
1929
:param path: The name of the file for the dirstate.
1930
:param sha1_provider: an object meeting the SHA1Provider interface.
1931
If None, a DefaultSHA1Provider is used.
1932
:return: A write-locked DirState object.
1934
# This constructs a new DirState object on a path, sets the _state_file
1935
# to a new empty file for that path. It then calls _set_data() with our
1936
# stock empty dirstate information - a root with ROOT_ID, no children,
1937
# and no parents. Finally it calls save() to ensure that this data will
1939
if sha1_provider is None:
1940
sha1_provider = DefaultSHA1Provider()
1941
result = cls(path, sha1_provider)
1942
# root dir and root dir contents with no children.
1943
empty_tree_dirblocks = [('', []), ('', [])]
1944
# a new root directory, with a NULLSTAT.
1945
empty_tree_dirblocks[0][1].append(
1946
(('', '', inventory.ROOT_ID), [
1947
('d', '', 0, False, DirState.NULLSTAT),
1951
result._set_data([], empty_tree_dirblocks)
1959
def _inv_entry_to_details(inv_entry):
1960
"""Convert an inventory entry (from a revision tree) to state details.
1962
:param inv_entry: An inventory entry whose sha1 and link targets can be
1963
relied upon, and which has a revision set.
1964
:return: A details tuple - the details for a single tree at a path +
1967
kind = inv_entry.kind
1968
minikind = DirState._kind_to_minikind[kind]
1969
tree_data = inv_entry.revision
1970
if kind == 'directory':
1974
elif kind == 'symlink':
1975
if inv_entry.symlink_target is None:
1978
fingerprint = inv_entry.symlink_target.encode('utf8')
1981
elif kind == 'file':
1982
fingerprint = inv_entry.text_sha1 or ''
1983
size = inv_entry.text_size or 0
1984
executable = inv_entry.executable
1985
elif kind == 'tree-reference':
1986
fingerprint = inv_entry.reference_revision or ''
1990
raise Exception("can't pack %s" % inv_entry)
1991
return (minikind, fingerprint, size, executable, tree_data)
1993
def _iter_child_entries(self, tree_index, path_utf8):
1994
"""Iterate over all the entries that are children of path_utf.
1996
This only returns entries that are present (not in 'a', 'r') in
1997
tree_index. tree_index data is not refreshed, so if tree 0 is used,
1998
results may differ from that obtained if paths were statted to
1999
determine what ones were directories.
2001
Asking for the children of a non-directory will return an empty
2005
next_pending_dirs = [path_utf8]
2007
while next_pending_dirs:
2008
pending_dirs = next_pending_dirs
2009
next_pending_dirs = []
2010
for path in pending_dirs:
2011
block_index, present = self._find_block_index_from_key(
2013
if block_index == 0:
2015
if len(self._dirblocks) == 1:
2016
# asked for the children of the root with no other
2020
# children of a non-directory asked for.
2022
block = self._dirblocks[block_index]
2023
for entry in block[1]:
2024
kind = entry[1][tree_index][0]
2025
if kind not in absent:
2029
path = entry[0][0] + '/' + entry[0][1]
2032
next_pending_dirs.append(path)
2034
def _iter_entries(self):
2035
"""Iterate over all the entries in the dirstate.
2037
Each yelt item is an entry in the standard format described in the
2038
docstring of bzrlib.dirstate.
2040
self._read_dirblocks_if_needed()
2041
for directory in self._dirblocks:
2042
for entry in directory[1]:
2045
def _get_id_index(self):
2046
"""Get an id index of self._dirblocks."""
2047
if self._id_index is None:
2049
for key, tree_details in self._iter_entries():
2050
id_index.setdefault(key[2], set()).add(key)
2051
self._id_index = id_index
2052
return self._id_index
2054
def _get_output_lines(self, lines):
2055
"""Format lines for final output.
2057
:param lines: A sequence of lines containing the parents list and the
2060
output_lines = [DirState.HEADER_FORMAT_3]
2061
lines.append('') # a final newline
2062
inventory_text = '\0\n\0'.join(lines)
2063
output_lines.append('crc32: %s\n' % (zlib.crc32(inventory_text),))
2064
# -3, 1 for num parents, 1 for ghosts, 1 for final newline
2065
num_entries = len(lines)-3
2066
output_lines.append('num_entries: %s\n' % (num_entries,))
2067
output_lines.append(inventory_text)
2070
def _make_deleted_row(self, fileid_utf8, parents):
2071
"""Return a deleted row for fileid_utf8."""
2072
return ('/', 'RECYCLED.BIN', 'file', fileid_utf8, 0, DirState.NULLSTAT,
2075
def _num_present_parents(self):
2076
"""The number of parent entries in each record row."""
2077
return len(self._parents) - len(self._ghosts)
2080
def on_file(path, sha1_provider=None):
2081
"""Construct a DirState on the file at path "path".
2083
:param path: The path at which the dirstate file on disk should live.
2084
:param sha1_provider: an object meeting the SHA1Provider interface.
2085
If None, a DefaultSHA1Provider is used.
2086
:return: An unlocked DirState object, associated with the given path.
2088
if sha1_provider is None:
2089
sha1_provider = DefaultSHA1Provider()
2090
result = DirState(path, sha1_provider)
2093
def _read_dirblocks_if_needed(self):
2094
"""Read in all the dirblocks from the file if they are not in memory.
2096
This populates self._dirblocks, and sets self._dirblock_state to
2097
IN_MEMORY_UNMODIFIED. It is not currently ready for incremental block
2100
self._read_header_if_needed()
2101
if self._dirblock_state == DirState.NOT_IN_MEMORY:
2102
_read_dirblocks(self)
2104
def _read_header(self):
2105
"""This reads in the metadata header, and the parent ids.
2107
After reading in, the file should be positioned at the null
2108
just before the start of the first record in the file.
2110
:return: (expected crc checksum, number of entries, parent list)
2112
self._read_prelude()
2113
parent_line = self._state_file.readline()
2114
info = parent_line.split('\0')
2115
num_parents = int(info[0])
2116
self._parents = info[1:-1]
2117
ghost_line = self._state_file.readline()
2118
info = ghost_line.split('\0')
2119
num_ghosts = int(info[1])
2120
self._ghosts = info[2:-1]
2121
self._header_state = DirState.IN_MEMORY_UNMODIFIED
2122
self._end_of_header = self._state_file.tell()
2124
def _read_header_if_needed(self):
2125
"""Read the header of the dirstate file if needed."""
2126
# inline this as it will be called a lot
2127
if not self._lock_token:
2128
raise errors.ObjectNotLocked(self)
2129
if self._header_state == DirState.NOT_IN_MEMORY:
2132
def _read_prelude(self):
2133
"""Read in the prelude header of the dirstate file.
2135
This only reads in the stuff that is not connected to the crc
2136
checksum. The position will be correct to read in the rest of
2137
the file and check the checksum after this point.
2138
The next entry in the file should be the number of parents,
2139
and their ids. Followed by a newline.
2141
header = self._state_file.readline()
2142
if header != DirState.HEADER_FORMAT_3:
2143
raise errors.BzrError(
2144
'invalid header line: %r' % (header,))
2145
crc_line = self._state_file.readline()
2146
if not crc_line.startswith('crc32: '):
2147
raise errors.BzrError('missing crc32 checksum: %r' % crc_line)
2148
self.crc_expected = int(crc_line[len('crc32: '):-1])
2149
num_entries_line = self._state_file.readline()
2150
if not num_entries_line.startswith('num_entries: '):
2151
raise errors.BzrError('missing num_entries line')
2152
self._num_entries = int(num_entries_line[len('num_entries: '):-1])
2154
def sha1_from_stat(self, path, stat_result, _pack_stat=pack_stat):
2155
"""Find a sha1 given a stat lookup."""
2156
return self._get_packed_stat_index().get(_pack_stat(stat_result), None)
2158
def _get_packed_stat_index(self):
2159
"""Get a packed_stat index of self._dirblocks."""
2160
if self._packed_stat_index is None:
2162
for key, tree_details in self._iter_entries():
2163
if tree_details[0][0] == 'f':
2164
index[tree_details[0][4]] = tree_details[0][1]
2165
self._packed_stat_index = index
2166
return self._packed_stat_index
2169
"""Save any pending changes created during this session.
2171
We reuse the existing file, because that prevents race conditions with
2172
file creation, and use oslocks on it to prevent concurrent modification
2173
and reads - because dirstate's incremental data aggregation is not
2174
compatible with reading a modified file, and replacing a file in use by
2175
another process is impossible on Windows.
2177
A dirstate in read only mode should be smart enough though to validate
2178
that the file has not changed, and otherwise discard its cache and
2179
start over, to allow for fine grained read lock duration, so 'status'
2180
wont block 'commit' - for example.
2182
if self._changes_aborted:
2183
# Should this be a warning? For now, I'm expecting that places that
2184
# mark it inconsistent will warn, making a warning here redundant.
2185
trace.mutter('Not saving DirState because '
2186
'_changes_aborted is set.')
2188
if (self._header_state == DirState.IN_MEMORY_MODIFIED or
2189
self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
2191
grabbed_write_lock = False
2192
if self._lock_state != 'w':
2193
grabbed_write_lock, new_lock = self._lock_token.temporary_write_lock()
2194
# Switch over to the new lock, as the old one may be closed.
2195
# TODO: jam 20070315 We should validate the disk file has
2196
# not changed contents. Since temporary_write_lock may
2197
# not be an atomic operation.
2198
self._lock_token = new_lock
2199
self._state_file = new_lock.f
2200
if not grabbed_write_lock:
2201
# We couldn't grab a write lock, so we switch back to a read one
2204
self._state_file.seek(0)
2205
self._state_file.writelines(self.get_lines())
2206
self._state_file.truncate()
2207
self._state_file.flush()
2208
self._header_state = DirState.IN_MEMORY_UNMODIFIED
2209
self._dirblock_state = DirState.IN_MEMORY_UNMODIFIED
2211
if grabbed_write_lock:
2212
self._lock_token = self._lock_token.restore_read_lock()
2213
self._state_file = self._lock_token.f
2214
# TODO: jam 20070315 We should validate the disk file has
2215
# not changed contents. Since restore_read_lock may
2216
# not be an atomic operation.
2218
def _set_data(self, parent_ids, dirblocks):
2219
"""Set the full dirstate data in memory.
2221
This is an internal function used to completely replace the objects
2222
in memory state. It puts the dirstate into state 'full-dirty'.
2224
:param parent_ids: A list of parent tree revision ids.
2225
:param dirblocks: A list containing one tuple for each directory in the
2226
tree. Each tuple contains the directory path and a list of entries
2227
found in that directory.
2229
# our memory copy is now authoritative.
2230
self._dirblocks = dirblocks
2231
self._header_state = DirState.IN_MEMORY_MODIFIED
2232
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2233
self._parents = list(parent_ids)
2234
self._id_index = None
2235
self._packed_stat_index = None
2237
def set_path_id(self, path, new_id):
2238
"""Change the id of path to new_id in the current working tree.
2240
:param path: The path inside the tree to set - '' is the root, 'foo'
2241
is the path foo in the root.
2242
:param new_id: The new id to assign to the path. This must be a utf8
2243
file id (not unicode, and not None).
2245
self._read_dirblocks_if_needed()
2247
# TODO: logic not written
2248
raise NotImplementedError(self.set_path_id)
2249
# TODO: check new id is unique
2250
entry = self._get_entry(0, path_utf8=path)
2251
if entry[0][2] == new_id:
2252
# Nothing to change.
2254
# mark the old path absent, and insert a new root path
2255
self._make_absent(entry)
2256
self.update_minimal(('', '', new_id), 'd',
2257
path_utf8='', packed_stat=entry[1][0][4])
2258
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2259
if self._id_index is not None:
2260
self._id_index.setdefault(new_id, set()).add(entry[0])
2262
def set_parent_trees(self, trees, ghosts):
2263
"""Set the parent trees for the dirstate.
2265
:param trees: A list of revision_id, tree tuples. tree must be provided
2266
even if the revision_id refers to a ghost: supply an empty tree in
2268
:param ghosts: A list of the revision_ids that are ghosts at the time
2271
# TODO: generate a list of parent indexes to preserve to save
2272
# processing specific parent trees. In the common case one tree will
2273
# be preserved - the left most parent.
2274
# TODO: if the parent tree is a dirstate, we might want to walk them
2275
# all by path in parallel for 'optimal' common-case performance.
2276
# generate new root row.
2277
self._read_dirblocks_if_needed()
2278
# TODO future sketch: Examine the existing parents to generate a change
2279
# map and then walk the new parent trees only, mapping them into the
2280
# dirstate. Walk the dirstate at the same time to remove unreferenced
2283
# sketch: loop over all entries in the dirstate, cherry picking
2284
# entries from the parent trees, if they are not ghost trees.
2285
# after we finish walking the dirstate, all entries not in the dirstate
2286
# are deletes, so we want to append them to the end as per the design
2287
# discussions. So do a set difference on ids with the parents to
2288
# get deletes, and add them to the end.
2289
# During the update process we need to answer the following questions:
2290
# - find other keys containing a fileid in order to create cross-path
2291
# links. We dont't trivially use the inventory from other trees
2292
# because this leads to either double touching, or to accessing
2294
# - find other keys containing a path
2295
# We accumulate each entry via this dictionary, including the root
2298
# we could do parallel iterators, but because file id data may be
2299
# scattered throughout, we dont save on index overhead: we have to look
2300
# at everything anyway. We can probably save cycles by reusing parent
2301
# data and doing an incremental update when adding an additional
2302
# parent, but for now the common cases are adding a new parent (merge),
2303
# and replacing completely (commit), and commit is more common: so
2304
# optimise merge later.
2306
# ---- start generation of full tree mapping data
2307
# what trees should we use?
2308
parent_trees = [tree for rev_id, tree in trees if rev_id not in ghosts]
2309
# how many trees do we end up with
2310
parent_count = len(parent_trees)
2312
# one: the current tree
2313
for entry in self._iter_entries():
2314
# skip entries not in the current tree
2315
if entry[1][0][0] in 'ar': # absent, relocated
2317
by_path[entry[0]] = [entry[1][0]] + \
2318
[DirState.NULL_PARENT_DETAILS] * parent_count
2319
id_index[entry[0][2]] = set([entry[0]])
2321
# now the parent trees:
2322
for tree_index, tree in enumerate(parent_trees):
2323
# the index is off by one, adjust it.
2324
tree_index = tree_index + 1
2325
# when we add new locations for a fileid we need these ranges for
2326
# any fileid in this tree as we set the by_path[id] to:
2327
# already_processed_tree_details + new_details + new_location_suffix
2328
# the suffix is from tree_index+1:parent_count+1.
2329
new_location_suffix = [DirState.NULL_PARENT_DETAILS] * (parent_count - tree_index)
2330
# now stitch in all the entries from this tree
2331
for path, entry in tree.inventory.iter_entries_by_dir():
2332
# here we process each trees details for each item in the tree.
2333
# we first update any existing entries for the id at other paths,
2334
# then we either create or update the entry for the id at the
2335
# right path, and finally we add (if needed) a mapping from
2336
# file_id to this path. We do it in this order to allow us to
2337
# avoid checking all known paths for the id when generating a
2338
# new entry at this path: by adding the id->path mapping last,
2339
# all the mappings are valid and have correct relocation
2340
# records where needed.
2341
file_id = entry.file_id
2342
path_utf8 = path.encode('utf8')
2343
dirname, basename = osutils.split(path_utf8)
2344
new_entry_key = (dirname, basename, file_id)
2345
# tree index consistency: All other paths for this id in this tree
2346
# index must point to the correct path.
2347
for entry_key in id_index.setdefault(file_id, set()):
2348
# TODO:PROFILING: It might be faster to just update
2349
# rather than checking if we need to, and then overwrite
2350
# the one we are located at.
2351
if entry_key != new_entry_key:
2352
# this file id is at a different path in one of the
2353
# other trees, so put absent pointers there
2354
# This is the vertical axis in the matrix, all pointing
2356
by_path[entry_key][tree_index] = ('r', path_utf8, 0, False, '')
2357
# by path consistency: Insert into an existing path record (trivial), or
2358
# add a new one with relocation pointers for the other tree indexes.
2359
if new_entry_key in id_index[file_id]:
2360
# there is already an entry where this data belongs, just insert it.
2361
by_path[new_entry_key][tree_index] = \
2362
self._inv_entry_to_details(entry)
2364
# add relocated entries to the horizontal axis - this row
2365
# mapping from path,id. We need to look up the correct path
2366
# for the indexes from 0 to tree_index -1
2368
for lookup_index in xrange(tree_index):
2369
# boundary case: this is the first occurence of file_id
2370
# so there are no id_indexs, possibly take this out of
2372
if not len(id_index[file_id]):
2373
new_details.append(DirState.NULL_PARENT_DETAILS)
2375
# grab any one entry, use it to find the right path.
2376
# TODO: optimise this to reduce memory use in highly
2377
# fragmented situations by reusing the relocation
2379
a_key = iter(id_index[file_id]).next()
2380
if by_path[a_key][lookup_index][0] in ('r', 'a'):
2381
# its a pointer or missing statement, use it as is.
2382
new_details.append(by_path[a_key][lookup_index])
2384
# we have the right key, make a pointer to it.
2385
real_path = ('/'.join(a_key[0:2])).strip('/')
2386
new_details.append(('r', real_path, 0, False, ''))
2387
new_details.append(self._inv_entry_to_details(entry))
2388
new_details.extend(new_location_suffix)
2389
by_path[new_entry_key] = new_details
2390
id_index[file_id].add(new_entry_key)
2391
# --- end generation of full tree mappings
2393
# sort and output all the entries
2394
new_entries = self._sort_entries(by_path.items())
2395
self._entries_to_current_state(new_entries)
2396
self._parents = [rev_id for rev_id, tree in trees]
2397
self._ghosts = list(ghosts)
2398
self._header_state = DirState.IN_MEMORY_MODIFIED
2399
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2400
self._id_index = id_index
2402
def _sort_entries(self, entry_list):
2403
"""Given a list of entries, sort them into the right order.
2405
This is done when constructing a new dirstate from trees - normally we
2406
try to keep everything in sorted blocks all the time, but sometimes
2407
it's easier to sort after the fact.
2410
# sort by: directory parts, file name, file id
2411
return entry[0][0].split('/'), entry[0][1], entry[0][2]
2412
return sorted(entry_list, key=_key)
2414
def set_state_from_inventory(self, new_inv):
2415
"""Set new_inv as the current state.
2417
This API is called by tree transform, and will usually occur with
2418
existing parent trees.
2420
:param new_inv: The inventory object to set current state from.
2422
if 'evil' in debug.debug_flags:
2423
trace.mutter_callsite(1,
2424
"set_state_from_inventory called; please mutate the tree instead")
2425
tracing = 'dirstate' in debug.debug_flags
2427
trace.mutter("set_state_from_inventory trace:")
2428
self._read_dirblocks_if_needed()
2430
# Two iterators: current data and new data, both in dirblock order.
2431
# We zip them together, which tells about entries that are new in the
2432
# inventory, or removed in the inventory, or present in both and
2435
# You might think we could just synthesize a new dirstate directly
2436
# since we're processing it in the right order. However, we need to
2437
# also consider there may be any number of parent trees and relocation
2438
# pointers, and we don't want to duplicate that here.
2439
new_iterator = new_inv.iter_entries_by_dir()
2440
# we will be modifying the dirstate, so we need a stable iterator. In
2441
# future we might write one, for now we just clone the state into a
2442
# list using a copy so that we see every original item and don't have
2443
# to adjust the position when items are inserted or deleted in the
2444
# underlying dirstate.
2445
old_iterator = iter(list(self._iter_entries()))
2446
# both must have roots so this is safe:
2447
current_new = new_iterator.next()
2448
current_old = old_iterator.next()
2449
def advance(iterator):
2451
return iterator.next()
2452
except StopIteration:
2454
while current_new or current_old:
2455
# skip entries in old that are not really there
2456
if current_old and current_old[1][0][0] in 'ar':
2457
# relocated or absent
2458
current_old = advance(old_iterator)
2461
# convert new into dirblock style
2462
new_path_utf8 = current_new[0].encode('utf8')
2463
new_dirname, new_basename = osutils.split(new_path_utf8)
2464
new_id = current_new[1].file_id
2465
new_entry_key = (new_dirname, new_basename, new_id)
2466
current_new_minikind = \
2467
DirState._kind_to_minikind[current_new[1].kind]
2468
if current_new_minikind == 't':
2469
fingerprint = current_new[1].reference_revision or ''
2471
# We normally only insert or remove records, or update
2472
# them when it has significantly changed. Then we want to
2473
# erase its fingerprint. Unaffected records should
2474
# normally not be updated at all.
2477
# for safety disable variables
2478
new_path_utf8 = new_dirname = new_basename = new_id = \
2479
new_entry_key = None
2480
# 5 cases, we dont have a value that is strictly greater than everything, so
2481
# we make both end conditions explicit
2483
# old is finished: insert current_new into the state.
2485
trace.mutter("Appending from new '%s'.",
2486
new_path_utf8.decode('utf8'))
2487
self.update_minimal(new_entry_key, current_new_minikind,
2488
executable=current_new[1].executable,
2489
path_utf8=new_path_utf8, fingerprint=fingerprint)
2490
current_new = advance(new_iterator)
2491
elif not current_new:
2494
trace.mutter("Truncating from old '%s/%s'.",
2495
current_old[0][0].decode('utf8'),
2496
current_old[0][1].decode('utf8'))
2497
self._make_absent(current_old)
2498
current_old = advance(old_iterator)
2499
elif new_entry_key == current_old[0]:
2500
# same - common case
2501
# We're looking at the same path and id in both the dirstate
2502
# and inventory, so just need to update the fields in the
2503
# dirstate from the one in the inventory.
2504
# TODO: update the record if anything significant has changed.
2505
# the minimal required trigger is if the execute bit or cached
2507
if (current_old[1][0][3] != current_new[1].executable or
2508
current_old[1][0][0] != current_new_minikind):
2510
trace.mutter("Updating in-place change '%s'.",
2511
new_path_utf8.decode('utf8'))
2512
self.update_minimal(current_old[0], current_new_minikind,
2513
executable=current_new[1].executable,
2514
path_utf8=new_path_utf8, fingerprint=fingerprint)
2515
# both sides are dealt with, move on
2516
current_old = advance(old_iterator)
2517
current_new = advance(new_iterator)
2518
elif (cmp_by_dirs(new_dirname, current_old[0][0]) < 0
2519
or (new_dirname == current_old[0][0]
2520
and new_entry_key[1:] < current_old[0][1:])):
2522
# add a entry for this and advance new
2524
trace.mutter("Inserting from new '%s'.",
2525
new_path_utf8.decode('utf8'))
2526
self.update_minimal(new_entry_key, current_new_minikind,
2527
executable=current_new[1].executable,
2528
path_utf8=new_path_utf8, fingerprint=fingerprint)
2529
current_new = advance(new_iterator)
2531
# we've advanced past the place where the old key would be,
2532
# without seeing it in the new list. so it must be gone.
2534
trace.mutter("Deleting from old '%s/%s'.",
2535
current_old[0][0].decode('utf8'),
2536
current_old[0][1].decode('utf8'))
2537
self._make_absent(current_old)
2538
current_old = advance(old_iterator)
2539
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2540
self._id_index = None
2541
self._packed_stat_index = None
2543
trace.mutter("set_state_from_inventory complete.")
2545
def _make_absent(self, current_old):
2546
"""Mark current_old - an entry - as absent for tree 0.
2548
:return: True if this was the last details entry for the entry key:
2549
that is, if the underlying block has had the entry removed, thus
2550
shrinking in length.
2552
# build up paths that this id will be left at after the change is made,
2553
# so we can update their cross references in tree 0
2554
all_remaining_keys = set()
2555
# Dont check the working tree, because it's going.
2556
for details in current_old[1][1:]:
2557
if details[0] not in 'ar': # absent, relocated
2558
all_remaining_keys.add(current_old[0])
2559
elif details[0] == 'r': # relocated
2560
# record the key for the real path.
2561
all_remaining_keys.add(tuple(osutils.split(details[1])) + (current_old[0][2],))
2562
# absent rows are not present at any path.
2563
last_reference = current_old[0] not in all_remaining_keys
2565
# the current row consists entire of the current item (being marked
2566
# absent), and relocated or absent entries for the other trees:
2567
# Remove it, its meaningless.
2568
block = self._find_block(current_old[0])
2569
entry_index, present = self._find_entry_index(current_old[0], block[1])
2571
raise AssertionError('could not find entry for %s' % (current_old,))
2572
block[1].pop(entry_index)
2573
# if we have an id_index in use, remove this key from it for this id.
2574
if self._id_index is not None:
2575
self._id_index[current_old[0][2]].remove(current_old[0])
2576
# update all remaining keys for this id to record it as absent. The
2577
# existing details may either be the record we are marking as deleted
2578
# (if there were other trees with the id present at this path), or may
2580
for update_key in all_remaining_keys:
2581
update_block_index, present = \
2582
self._find_block_index_from_key(update_key)
2584
raise AssertionError('could not find block for %s' % (update_key,))
2585
update_entry_index, present = \
2586
self._find_entry_index(update_key, self._dirblocks[update_block_index][1])
2588
raise AssertionError('could not find entry for %s' % (update_key,))
2589
update_tree_details = self._dirblocks[update_block_index][1][update_entry_index][1]
2590
# it must not be absent at the moment
2591
if update_tree_details[0][0] == 'a': # absent
2592
raise AssertionError('bad row %r' % (update_tree_details,))
2593
update_tree_details[0] = DirState.NULL_PARENT_DETAILS
2594
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2595
return last_reference
2597
def update_minimal(self, key, minikind, executable=False, fingerprint='',
2598
packed_stat=None, size=0, path_utf8=None):
2599
"""Update an entry to the state in tree 0.
2601
This will either create a new entry at 'key' or update an existing one.
2602
It also makes sure that any other records which might mention this are
2605
:param key: (dir, name, file_id) for the new entry
2606
:param minikind: The type for the entry ('f' == 'file', 'd' ==
2608
:param executable: Should the executable bit be set?
2609
:param fingerprint: Simple fingerprint for new entry: canonical-form
2610
sha1 for files, referenced revision id for subtrees, etc.
2611
:param packed_stat: Packed stat value for new entry.
2612
:param size: Size information for new entry
2613
:param path_utf8: key[0] + '/' + key[1], just passed in to avoid doing
2616
If packed_stat and fingerprint are not given, they're invalidated in
2619
block = self._find_block(key)[1]
2620
if packed_stat is None:
2621
packed_stat = DirState.NULLSTAT
2622
# XXX: Some callers pass '' as the packed_stat, and it seems to be
2623
# sometimes present in the dirstate - this seems oddly inconsistent.
2625
entry_index, present = self._find_entry_index(key, block)
2626
new_details = (minikind, fingerprint, size, executable, packed_stat)
2627
id_index = self._get_id_index()
2629
# new entry, synthesis cross reference here,
2630
existing_keys = id_index.setdefault(key[2], set())
2631
if not existing_keys:
2632
# not currently in the state, simplest case
2633
new_entry = key, [new_details] + self._empty_parent_info()
2635
# present at one or more existing other paths.
2636
# grab one of them and use it to generate parent
2637
# relocation/absent entries.
2638
new_entry = key, [new_details]
2639
# existing_keys can be changed as we iterate.
2640
for other_key in tuple(existing_keys):
2641
# change the record at other to be a pointer to this new
2642
# record. The loop looks similar to the change to
2643
# relocations when updating an existing record but its not:
2644
# the test for existing kinds is different: this can be
2645
# factored out to a helper though.
2646
other_block_index, present = self._find_block_index_from_key(
2649
raise AssertionError('could not find block for %s' % (
2651
other_block = self._dirblocks[other_block_index][1]
2652
other_entry_index, present = self._find_entry_index(
2653
other_key, other_block)
2655
raise AssertionError(
2656
'update_minimal: could not find other entry for %s'
2658
if path_utf8 is None:
2659
raise AssertionError('no path')
2660
# Turn this other location into a reference to the new
2661
# location. This also updates the aliased iterator
2662
# (current_old in set_state_from_inventory) so that the old
2663
# entry, if not already examined, is skipped over by that
2665
other_entry = other_block[other_entry_index]
2666
other_entry[1][0] = ('r', path_utf8, 0, False, '')
2667
self._maybe_remove_row(other_block, other_entry_index,
2671
# adds a tuple to the new details for each column
2672
# - either by copying an existing relocation pointer inside that column
2673
# - or by creating a new pointer to the right row inside that column
2674
num_present_parents = self._num_present_parents()
2675
if num_present_parents:
2676
other_key = list(existing_keys)[0]
2677
for lookup_index in xrange(1, num_present_parents + 1):
2678
# grab any one entry, use it to find the right path.
2679
# TODO: optimise this to reduce memory use in highly
2680
# fragmented situations by reusing the relocation
2682
update_block_index, present = \
2683
self._find_block_index_from_key(other_key)
2685
raise AssertionError('could not find block for %s' % (other_key,))
2686
update_entry_index, present = \
2687
self._find_entry_index(other_key, self._dirblocks[update_block_index][1])
2689
raise AssertionError('update_minimal: could not find entry for %s' % (other_key,))
2690
update_details = self._dirblocks[update_block_index][1][update_entry_index][1][lookup_index]
2691
if update_details[0] in 'ar': # relocated, absent
2692
# its a pointer or absent in lookup_index's tree, use
2694
new_entry[1].append(update_details)
2696
# we have the right key, make a pointer to it.
2697
pointer_path = osutils.pathjoin(*other_key[0:2])
2698
new_entry[1].append(('r', pointer_path, 0, False, ''))
2699
block.insert(entry_index, new_entry)
2700
existing_keys.add(key)
2702
# Does the new state matter?
2703
block[entry_index][1][0] = new_details
2704
# parents cannot be affected by what we do.
2705
# other occurences of this id can be found
2706
# from the id index.
2708
# tree index consistency: All other paths for this id in this tree
2709
# index must point to the correct path. We have to loop here because
2710
# we may have passed entries in the state with this file id already
2711
# that were absent - where parent entries are - and they need to be
2712
# converted to relocated.
2713
if path_utf8 is None:
2714
raise AssertionError('no path')
2715
for entry_key in id_index.setdefault(key[2], set()):
2716
# TODO:PROFILING: It might be faster to just update
2717
# rather than checking if we need to, and then overwrite
2718
# the one we are located at.
2719
if entry_key != key:
2720
# this file id is at a different path in one of the
2721
# other trees, so put absent pointers there
2722
# This is the vertical axis in the matrix, all pointing
2724
block_index, present = self._find_block_index_from_key(entry_key)
2726
raise AssertionError('not present: %r', entry_key)
2727
entry_index, present = self._find_entry_index(entry_key, self._dirblocks[block_index][1])
2729
raise AssertionError('not present: %r', entry_key)
2730
self._dirblocks[block_index][1][entry_index][1][0] = \
2731
('r', path_utf8, 0, False, '')
2732
# add a containing dirblock if needed.
2733
if new_details[0] == 'd':
2734
subdir_key = (osutils.pathjoin(*key[0:2]), '', '')
2735
block_index, present = self._find_block_index_from_key(subdir_key)
2737
self._dirblocks.insert(block_index, (subdir_key[0], []))
2739
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2741
def _maybe_remove_row(self, block, index, id_index):
2742
"""Remove index if it is absent or relocated across the row.
2744
id_index is updated accordingly.
2746
present_in_row = False
2747
entry = block[index]
2748
for column in entry[1]:
2749
if column[0] not in 'ar':
2750
present_in_row = True
2752
if not present_in_row:
2754
id_index[entry[0][2]].remove(entry[0])
2756
def _validate(self):
2757
"""Check that invariants on the dirblock are correct.
2759
This can be useful in debugging; it shouldn't be necessary in
2762
This must be called with a lock held.
2764
# NOTE: This must always raise AssertionError not just assert,
2765
# otherwise it may not behave properly under python -O
2767
# TODO: All entries must have some content that's not 'a' or 'r',
2768
# otherwise it could just be removed.
2770
# TODO: All relocations must point directly to a real entry.
2772
# TODO: No repeated keys.
2775
from pprint import pformat
2776
self._read_dirblocks_if_needed()
2777
if len(self._dirblocks) > 0:
2778
if not self._dirblocks[0][0] == '':
2779
raise AssertionError(
2780
"dirblocks don't start with root block:\n" + \
2781
pformat(self._dirblocks))
2782
if len(self._dirblocks) > 1:
2783
if not self._dirblocks[1][0] == '':
2784
raise AssertionError(
2785
"dirblocks missing root directory:\n" + \
2786
pformat(self._dirblocks))
2787
# the dirblocks are sorted by their path components, name, and dir id
2788
dir_names = [d[0].split('/')
2789
for d in self._dirblocks[1:]]
2790
if dir_names != sorted(dir_names):
2791
raise AssertionError(
2792
"dir names are not in sorted order:\n" + \
2793
pformat(self._dirblocks) + \
2796
for dirblock in self._dirblocks:
2797
# within each dirblock, the entries are sorted by filename and
2799
for entry in dirblock[1]:
2800
if dirblock[0] != entry[0][0]:
2801
raise AssertionError(
2803
"doesn't match directory name in\n%r" %
2804
(entry, pformat(dirblock)))
2805
if dirblock[1] != sorted(dirblock[1]):
2806
raise AssertionError(
2807
"dirblock for %r is not sorted:\n%s" % \
2808
(dirblock[0], pformat(dirblock)))
2810
def check_valid_parent():
2811
"""Check that the current entry has a valid parent.
2813
This makes sure that the parent has a record,
2814
and that the parent isn't marked as "absent" in the
2815
current tree. (It is invalid to have a non-absent file in an absent
2818
if entry[0][0:2] == ('', ''):
2819
# There should be no parent for the root row
2821
parent_entry = self._get_entry(tree_index, path_utf8=entry[0][0])
2822
if parent_entry == (None, None):
2823
raise AssertionError(
2824
"no parent entry for: %s in tree %s"
2825
% (this_path, tree_index))
2826
if parent_entry[1][tree_index][0] != 'd':
2827
raise AssertionError(
2828
"Parent entry for %s is not marked as a valid"
2829
" directory. %s" % (this_path, parent_entry,))
2831
# For each file id, for each tree: either
2832
# the file id is not present at all; all rows with that id in the
2833
# key have it marked as 'absent'
2834
# OR the file id is present under exactly one name; any other entries
2835
# that mention that id point to the correct name.
2837
# We check this with a dict per tree pointing either to the present
2838
# name, or None if absent.
2839
tree_count = self._num_present_parents() + 1
2840
id_path_maps = [dict() for i in range(tree_count)]
2841
# Make sure that all renamed entries point to the correct location.
2842
for entry in self._iter_entries():
2843
file_id = entry[0][2]
2844
this_path = osutils.pathjoin(entry[0][0], entry[0][1])
2845
if len(entry[1]) != tree_count:
2846
raise AssertionError(
2847
"wrong number of entry details for row\n%s" \
2848
",\nexpected %d" % \
2849
(pformat(entry), tree_count))
2850
absent_positions = 0
2851
for tree_index, tree_state in enumerate(entry[1]):
2852
this_tree_map = id_path_maps[tree_index]
2853
minikind = tree_state[0]
2854
if minikind in 'ar':
2855
absent_positions += 1
2856
# have we seen this id before in this column?
2857
if file_id in this_tree_map:
2858
previous_path, previous_loc = this_tree_map[file_id]
2859
# any later mention of this file must be consistent with
2860
# what was said before
2862
if previous_path is not None:
2863
raise AssertionError(
2864
"file %s is absent in row %r but also present " \
2866
(file_id, entry, previous_path))
2867
elif minikind == 'r':
2868
target_location = tree_state[1]
2869
if previous_path != target_location:
2870
raise AssertionError(
2871
"file %s relocation in row %r but also at %r" \
2872
% (file_id, entry, previous_path))
2874
# a file, directory, etc - may have been previously
2875
# pointed to by a relocation, which must point here
2876
if previous_path != this_path:
2877
raise AssertionError(
2878
"entry %r inconsistent with previous path %r "
2880
(entry, previous_path, previous_loc))
2881
check_valid_parent()
2884
# absent; should not occur anywhere else
2885
this_tree_map[file_id] = None, this_path
2886
elif minikind == 'r':
2887
# relocation, must occur at expected location
2888
this_tree_map[file_id] = tree_state[1], this_path
2890
this_tree_map[file_id] = this_path, this_path
2891
check_valid_parent()
2892
if absent_positions == tree_count:
2893
raise AssertionError(
2894
"entry %r has no data for any tree." % (entry,))
2896
def _wipe_state(self):
2897
"""Forget all state information about the dirstate."""
2898
self._header_state = DirState.NOT_IN_MEMORY
2899
self._dirblock_state = DirState.NOT_IN_MEMORY
2900
self._changes_aborted = False
2903
self._dirblocks = []
2904
self._id_index = None
2905
self._packed_stat_index = None
2906
self._end_of_header = None
2907
self._cutoff_time = None
2908
self._split_path_cache = {}
2910
def lock_read(self):
2911
"""Acquire a read lock on the dirstate."""
2912
if self._lock_token is not None:
2913
raise errors.LockContention(self._lock_token)
2914
# TODO: jam 20070301 Rather than wiping completely, if the blocks are
2915
# already in memory, we could read just the header and check for
2916
# any modification. If not modified, we can just leave things
2918
self._lock_token = lock.ReadLock(self._filename)
2919
self._lock_state = 'r'
2920
self._state_file = self._lock_token.f
2923
def lock_write(self):
2924
"""Acquire a write lock on the dirstate."""
2925
if self._lock_token is not None:
2926
raise errors.LockContention(self._lock_token)
2927
# TODO: jam 20070301 Rather than wiping completely, if the blocks are
2928
# already in memory, we could read just the header and check for
2929
# any modification. If not modified, we can just leave things
2931
self._lock_token = lock.WriteLock(self._filename)
2932
self._lock_state = 'w'
2933
self._state_file = self._lock_token.f
2937
"""Drop any locks held on the dirstate."""
2938
if self._lock_token is None:
2939
raise errors.LockNotHeld(self)
2940
# TODO: jam 20070301 Rather than wiping completely, if the blocks are
2941
# already in memory, we could read just the header and check for
2942
# any modification. If not modified, we can just leave things
2944
self._state_file = None
2945
self._lock_state = None
2946
self._lock_token.unlock()
2947
self._lock_token = None
2948
self._split_path_cache = {}
2950
def _requires_lock(self):
2951
"""Check that a lock is currently held by someone on the dirstate."""
2952
if not self._lock_token:
2953
raise errors.ObjectNotLocked(self)
2956
def py_update_entry(state, entry, abspath, stat_value,
2957
_stat_to_minikind=DirState._stat_to_minikind,
2958
_pack_stat=pack_stat):
2959
"""Update the entry based on what is actually on disk.
2961
This function only calculates the sha if it needs to - if the entry is
2962
uncachable, or clearly different to the first parent's entry, no sha
2963
is calculated, and None is returned.
2965
:param state: The dirstate this entry is in.
2966
:param entry: This is the dirblock entry for the file in question.
2967
:param abspath: The path on disk for this file.
2968
:param stat_value: The stat value done on the path.
2969
:return: None, or The sha1 hexdigest of the file (40 bytes) or link
2970
target of a symlink.
2973
minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
2977
packed_stat = _pack_stat(stat_value)
2978
(saved_minikind, saved_link_or_sha1, saved_file_size,
2979
saved_executable, saved_packed_stat) = entry[1][0]
2981
if minikind == 'd' and saved_minikind == 't':
2983
if (minikind == saved_minikind
2984
and packed_stat == saved_packed_stat):
2985
# The stat hasn't changed since we saved, so we can re-use the
2990
# size should also be in packed_stat
2991
if saved_file_size == stat_value.st_size:
2992
return saved_link_or_sha1
2994
# If we have gotten this far, that means that we need to actually
2995
# process this entry.
2998
executable = state._is_executable(stat_value.st_mode,
3000
if state._cutoff_time is None:
3001
state._sha_cutoff_time()
3002
if (stat_value.st_mtime < state._cutoff_time
3003
and stat_value.st_ctime < state._cutoff_time
3004
and len(entry[1]) > 1
3005
and entry[1][1][0] != 'a'):
3006
# Could check for size changes for further optimised
3007
# avoidance of sha1's. However the most prominent case of
3008
# over-shaing is during initial add, which this catches.
3009
# Besides, if content filtering happens, size and sha
3010
# are calculated at the same time, so checking just the size
3011
# gains nothing w.r.t. performance.
3012
link_or_sha1 = state._sha1_file(abspath)
3013
entry[1][0] = ('f', link_or_sha1, stat_value.st_size,
3014
executable, packed_stat)
3016
entry[1][0] = ('f', '', stat_value.st_size,
3017
executable, DirState.NULLSTAT)
3018
elif minikind == 'd':
3020
entry[1][0] = ('d', '', 0, False, packed_stat)
3021
if saved_minikind != 'd':
3022
# This changed from something into a directory. Make sure we
3023
# have a directory block for it. This doesn't happen very
3024
# often, so this doesn't have to be super fast.
3025
block_index, entry_index, dir_present, file_present = \
3026
state._get_block_entry_index(entry[0][0], entry[0][1], 0)
3027
state._ensure_block(block_index, entry_index,
3028
osutils.pathjoin(entry[0][0], entry[0][1]))
3029
elif minikind == 'l':
3030
link_or_sha1 = state._read_link(abspath, saved_link_or_sha1)
3031
if state._cutoff_time is None:
3032
state._sha_cutoff_time()
3033
if (stat_value.st_mtime < state._cutoff_time
3034
and stat_value.st_ctime < state._cutoff_time):
3035
entry[1][0] = ('l', link_or_sha1, stat_value.st_size,
3038
entry[1][0] = ('l', '', stat_value.st_size,
3039
False, DirState.NULLSTAT)
3040
state._dirblock_state = DirState.IN_MEMORY_MODIFIED
3044
class ProcessEntryPython(object):
3046
__slots__ = ["old_dirname_to_file_id", "new_dirname_to_file_id", "uninteresting",
3047
"last_source_parent", "last_target_parent", "include_unchanged",
3048
"use_filesystem_for_exec", "utf8_decode", "searched_specific_files",
3049
"search_specific_files", "state", "source_index", "target_index",
3050
"want_unversioned", "tree"]
3052
def __init__(self, include_unchanged, use_filesystem_for_exec,
3053
search_specific_files, state, source_index, target_index,
3054
want_unversioned, tree):
3055
self.old_dirname_to_file_id = {}
3056
self.new_dirname_to_file_id = {}
3057
# Just a sentry, so that _process_entry can say that this
3058
# record is handled, but isn't interesting to process (unchanged)
3059
self.uninteresting = object()
3060
# Using a list so that we can access the values and change them in
3061
# nested scope. Each one is [path, file_id, entry]
3062
self.last_source_parent = [None, None]
3063
self.last_target_parent = [None, None]
3064
self.include_unchanged = include_unchanged
3065
self.use_filesystem_for_exec = use_filesystem_for_exec
3066
self.utf8_decode = cache_utf8._utf8_decode
3067
# for all search_indexs in each path at or under each element of
3068
# search_specific_files, if the detail is relocated: add the id, and add the
3069
# relocated path as one to search if its not searched already. If the
3070
# detail is not relocated, add the id.
3071
self.searched_specific_files = set()
3072
self.search_specific_files = search_specific_files
3074
self.source_index = source_index
3075
self.target_index = target_index
3076
self.want_unversioned = want_unversioned
3079
def _process_entry(self, entry, path_info, pathjoin=osutils.pathjoin):
3080
"""Compare an entry and real disk to generate delta information.
3082
:param path_info: top_relpath, basename, kind, lstat, abspath for
3083
the path of entry. If None, then the path is considered absent.
3084
(Perhaps we should pass in a concrete entry for this ?)
3085
Basename is returned as a utf8 string because we expect this
3086
tuple will be ignored, and don't want to take the time to
3088
:return: None if these don't match
3089
A tuple of information about the change, or
3090
the object 'uninteresting' if these match, but are
3091
basically identical.
3093
if self.source_index is None:
3094
source_details = DirState.NULL_PARENT_DETAILS
3096
source_details = entry[1][self.source_index]
3097
target_details = entry[1][self.target_index]
3098
target_minikind = target_details[0]
3099
if path_info is not None and target_minikind in 'fdlt':
3100
if not (self.target_index == 0):
3101
raise AssertionError()
3102
link_or_sha1 = update_entry(self.state, entry,
3103
abspath=path_info[4], stat_value=path_info[3])
3104
# The entry may have been modified by update_entry
3105
target_details = entry[1][self.target_index]
3106
target_minikind = target_details[0]
3109
file_id = entry[0][2]
3110
source_minikind = source_details[0]
3111
if source_minikind in 'fdltr' and target_minikind in 'fdlt':
3112
# claimed content in both: diff
3113
# r | fdlt | | add source to search, add id path move and perform
3114
# | | | diff check on source-target
3115
# r | fdlt | a | dangling file that was present in the basis.
3117
if source_minikind in 'r':
3118
# add the source to the search path to find any children it
3119
# has. TODO ? : only add if it is a container ?
3120
if not osutils.is_inside_any(self.searched_specific_files,
3122
self.search_specific_files.add(source_details[1])
3123
# generate the old path; this is needed for stating later
3125
old_path = source_details[1]
3126
old_dirname, old_basename = os.path.split(old_path)
3127
path = pathjoin(entry[0][0], entry[0][1])
3128
old_entry = self.state._get_entry(self.source_index,
3130
# update the source details variable to be the real
3132
if old_entry == (None, None):
3133
raise errors.CorruptDirstate(self.state._filename,
3134
"entry '%s/%s' is considered renamed from %r"
3135
" but source does not exist\n"
3136
"entry: %s" % (entry[0][0], entry[0][1], old_path, entry))
3137
source_details = old_entry[1][self.source_index]
3138
source_minikind = source_details[0]
3140
old_dirname = entry[0][0]
3141
old_basename = entry[0][1]
3142
old_path = path = None
3143
if path_info is None:
3144
# the file is missing on disk, show as removed.
3145
content_change = True
3149
# source and target are both versioned and disk file is present.
3150
target_kind = path_info[2]
3151
if target_kind == 'directory':
3153
old_path = path = pathjoin(old_dirname, old_basename)
3154
self.new_dirname_to_file_id[path] = file_id
3155
if source_minikind != 'd':
3156
content_change = True
3158
# directories have no fingerprint
3159
content_change = False
3161
elif target_kind == 'file':
3162
if source_minikind != 'f':
3163
content_change = True
3165
# Check the sha. We can't just rely on the size as
3166
# content filtering may mean differ sizes actually
3167
# map to the same content
3168
if link_or_sha1 is None:
3170
statvalue, link_or_sha1 = \
3171
self.state._sha1_provider.stat_and_sha1(
3173
self.state._observed_sha1(entry, link_or_sha1,
3175
content_change = (link_or_sha1 != source_details[1])
3176
# Target details is updated at update_entry time
3177
if self.use_filesystem_for_exec:
3178
# We don't need S_ISREG here, because we are sure
3179
# we are dealing with a file.
3180
target_exec = bool(stat.S_IEXEC & path_info[3].st_mode)
3182
target_exec = target_details[3]
3183
elif target_kind == 'symlink':
3184
if source_minikind != 'l':
3185
content_change = True
3187
content_change = (link_or_sha1 != source_details[1])
3189
elif target_kind == 'tree-reference':
3190
if source_minikind != 't':
3191
content_change = True
3193
content_change = False
3196
raise Exception, "unknown kind %s" % path_info[2]
3197
if source_minikind == 'd':
3199
old_path = path = pathjoin(old_dirname, old_basename)
3200
self.old_dirname_to_file_id[old_path] = file_id
3201
# parent id is the entry for the path in the target tree
3202
if old_dirname == self.last_source_parent[0]:
3203
source_parent_id = self.last_source_parent[1]
3206
source_parent_id = self.old_dirname_to_file_id[old_dirname]
3208
source_parent_entry = self.state._get_entry(self.source_index,
3209
path_utf8=old_dirname)
3210
source_parent_id = source_parent_entry[0][2]
3211
if source_parent_id == entry[0][2]:
3212
# This is the root, so the parent is None
3213
source_parent_id = None
3215
self.last_source_parent[0] = old_dirname
3216
self.last_source_parent[1] = source_parent_id
3217
new_dirname = entry[0][0]
3218
if new_dirname == self.last_target_parent[0]:
3219
target_parent_id = self.last_target_parent[1]
3222
target_parent_id = self.new_dirname_to_file_id[new_dirname]
3224
# TODO: We don't always need to do the lookup, because the
3225
# parent entry will be the same as the source entry.
3226
target_parent_entry = self.state._get_entry(self.target_index,
3227
path_utf8=new_dirname)
3228
if target_parent_entry == (None, None):
3229
raise AssertionError(
3230
"Could not find target parent in wt: %s\nparent of: %s"
3231
% (new_dirname, entry))
3232
target_parent_id = target_parent_entry[0][2]
3233
if target_parent_id == entry[0][2]:
3234
# This is the root, so the parent is None
3235
target_parent_id = None
3237
self.last_target_parent[0] = new_dirname
3238
self.last_target_parent[1] = target_parent_id
3240
source_exec = source_details[3]
3241
if (self.include_unchanged
3243
or source_parent_id != target_parent_id
3244
or old_basename != entry[0][1]
3245
or source_exec != target_exec
3247
if old_path is None:
3248
old_path = path = pathjoin(old_dirname, old_basename)
3249
old_path_u = self.utf8_decode(old_path)[0]
3252
old_path_u = self.utf8_decode(old_path)[0]
3253
if old_path == path:
3256
path_u = self.utf8_decode(path)[0]
3257
source_kind = DirState._minikind_to_kind[source_minikind]
3258
return (entry[0][2],
3259
(old_path_u, path_u),
3262
(source_parent_id, target_parent_id),
3263
(self.utf8_decode(old_basename)[0], self.utf8_decode(entry[0][1])[0]),
3264
(source_kind, target_kind),
3265
(source_exec, target_exec))
3267
return self.uninteresting
3268
elif source_minikind in 'a' and target_minikind in 'fdlt':
3269
# looks like a new file
3270
path = pathjoin(entry[0][0], entry[0][1])
3271
# parent id is the entry for the path in the target tree
3272
# TODO: these are the same for an entire directory: cache em.
3273
parent_id = self.state._get_entry(self.target_index,
3274
path_utf8=entry[0][0])[0][2]
3275
if parent_id == entry[0][2]:
3277
if path_info is not None:
3279
if self.use_filesystem_for_exec:
3280
# We need S_ISREG here, because we aren't sure if this
3283
stat.S_ISREG(path_info[3].st_mode)
3284
and stat.S_IEXEC & path_info[3].st_mode)
3286
target_exec = target_details[3]
3287
return (entry[0][2],
3288
(None, self.utf8_decode(path)[0]),
3292
(None, self.utf8_decode(entry[0][1])[0]),
3293
(None, path_info[2]),
3294
(None, target_exec))
3296
# Its a missing file, report it as such.
3297
return (entry[0][2],
3298
(None, self.utf8_decode(path)[0]),
3302
(None, self.utf8_decode(entry[0][1])[0]),
3305
elif source_minikind in 'fdlt' and target_minikind in 'a':
3306
# unversioned, possibly, or possibly not deleted: we dont care.
3307
# if its still on disk, *and* theres no other entry at this
3308
# path [we dont know this in this routine at the moment -
3309
# perhaps we should change this - then it would be an unknown.
3310
old_path = pathjoin(entry[0][0], entry[0][1])
3311
# parent id is the entry for the path in the target tree
3312
parent_id = self.state._get_entry(self.source_index, path_utf8=entry[0][0])[0][2]
3313
if parent_id == entry[0][2]:
3315
return (entry[0][2],
3316
(self.utf8_decode(old_path)[0], None),
3320
(self.utf8_decode(entry[0][1])[0], None),
3321
(DirState._minikind_to_kind[source_minikind], None),
3322
(source_details[3], None))
3323
elif source_minikind in 'fdlt' and target_minikind in 'r':
3324
# a rename; could be a true rename, or a rename inherited from
3325
# a renamed parent. TODO: handle this efficiently. Its not
3326
# common case to rename dirs though, so a correct but slow
3327
# implementation will do.
3328
if not osutils.is_inside_any(self.searched_specific_files, target_details[1]):
3329
self.search_specific_files.add(target_details[1])
3330
elif source_minikind in 'ra' and target_minikind in 'ra':
3331
# neither of the selected trees contain this file,
3332
# so skip over it. This is not currently directly tested, but
3333
# is indirectly via test_too_much.TestCommands.test_conflicts.
3336
raise AssertionError("don't know how to compare "
3337
"source_minikind=%r, target_minikind=%r"
3338
% (source_minikind, target_minikind))
3339
## import pdb;pdb.set_trace()
3345
def iter_changes(self):
3346
"""Iterate over the changes."""
3347
utf8_decode = cache_utf8._utf8_decode
3348
_cmp_by_dirs = cmp_by_dirs
3349
_process_entry = self._process_entry
3350
uninteresting = self.uninteresting
3351
search_specific_files = self.search_specific_files
3352
searched_specific_files = self.searched_specific_files
3353
splitpath = osutils.splitpath
3355
# compare source_index and target_index at or under each element of search_specific_files.
3356
# follow the following comparison table. Note that we only want to do diff operations when
3357
# the target is fdl because thats when the walkdirs logic will have exposed the pathinfo
3361
# Source | Target | disk | action
3362
# r | fdlt | | add source to search, add id path move and perform
3363
# | | | diff check on source-target
3364
# r | fdlt | a | dangling file that was present in the basis.
3366
# r | a | | add source to search
3368
# r | r | | this path is present in a non-examined tree, skip.
3369
# r | r | a | this path is present in a non-examined tree, skip.
3370
# a | fdlt | | add new id
3371
# a | fdlt | a | dangling locally added file, skip
3372
# a | a | | not present in either tree, skip
3373
# a | a | a | not present in any tree, skip
3374
# a | r | | not present in either tree at this path, skip as it
3375
# | | | may not be selected by the users list of paths.
3376
# a | r | a | not present in either tree at this path, skip as it
3377
# | | | may not be selected by the users list of paths.
3378
# fdlt | fdlt | | content in both: diff them
3379
# fdlt | fdlt | a | deleted locally, but not unversioned - show as deleted ?
3380
# fdlt | a | | unversioned: output deleted id for now
3381
# fdlt | a | a | unversioned and deleted: output deleted id
3382
# fdlt | r | | relocated in this tree, so add target to search.
3383
# | | | Dont diff, we will see an r,fd; pair when we reach
3384
# | | | this id at the other path.
3385
# fdlt | r | a | relocated in this tree, so add target to search.
3386
# | | | Dont diff, we will see an r,fd; pair when we reach
3387
# | | | this id at the other path.
3389
# TODO: jam 20070516 - Avoid the _get_entry lookup overhead by
3390
# keeping a cache of directories that we have seen.
3392
while search_specific_files:
3393
# TODO: the pending list should be lexically sorted? the
3394
# interface doesn't require it.
3395
current_root = search_specific_files.pop()
3396
current_root_unicode = current_root.decode('utf8')
3397
searched_specific_files.add(current_root)
3398
# process the entries for this containing directory: the rest will be
3399
# found by their parents recursively.
3400
root_entries = self.state._entries_for_path(current_root)
3401
root_abspath = self.tree.abspath(current_root_unicode)
3403
root_stat = os.lstat(root_abspath)
3405
if e.errno == errno.ENOENT:
3406
# the path does not exist: let _process_entry know that.
3407
root_dir_info = None
3409
# some other random error: hand it up.
3412
root_dir_info = ('', current_root,
3413
osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
3415
if root_dir_info[2] == 'directory':
3416
if self.tree._directory_is_tree_reference(
3417
current_root.decode('utf8')):
3418
root_dir_info = root_dir_info[:2] + \
3419
('tree-reference',) + root_dir_info[3:]
3421
if not root_entries and not root_dir_info:
3422
# this specified path is not present at all, skip it.
3424
path_handled = False
3425
for entry in root_entries:
3426
result = _process_entry(entry, root_dir_info)
3427
if result is not None:
3429
if result is not uninteresting:
3431
if self.want_unversioned and not path_handled and root_dir_info:
3432
new_executable = bool(
3433
stat.S_ISREG(root_dir_info[3].st_mode)
3434
and stat.S_IEXEC & root_dir_info[3].st_mode)
3436
(None, current_root_unicode),
3440
(None, splitpath(current_root_unicode)[-1]),
3441
(None, root_dir_info[2]),
3442
(None, new_executable)
3444
initial_key = (current_root, '', '')
3445
block_index, _ = self.state._find_block_index_from_key(initial_key)
3446
if block_index == 0:
3447
# we have processed the total root already, but because the
3448
# initial key matched it we should skip it here.
3450
if root_dir_info and root_dir_info[2] == 'tree-reference':
3451
current_dir_info = None
3453
dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
3455
current_dir_info = dir_iterator.next()
3457
# on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
3458
# python 2.5 has e.errno == EINVAL,
3459
# and e.winerror == ERROR_DIRECTORY
3460
e_winerror = getattr(e, 'winerror', None)
3461
win_errors = (ERROR_DIRECTORY, ERROR_PATH_NOT_FOUND)
3462
# there may be directories in the inventory even though
3463
# this path is not a file on disk: so mark it as end of
3465
if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
3466
current_dir_info = None
3467
elif (sys.platform == 'win32'
3468
and (e.errno in win_errors
3469
or e_winerror in win_errors)):
3470
current_dir_info = None
3474
if current_dir_info[0][0] == '':
3475
# remove .bzr from iteration
3476
bzr_index = bisect.bisect_left(current_dir_info[1], ('.bzr',))
3477
if current_dir_info[1][bzr_index][0] != '.bzr':
3478
raise AssertionError()
3479
del current_dir_info[1][bzr_index]
3480
# walk until both the directory listing and the versioned metadata
3482
if (block_index < len(self.state._dirblocks) and
3483
osutils.is_inside(current_root, self.state._dirblocks[block_index][0])):
3484
current_block = self.state._dirblocks[block_index]
3486
current_block = None
3487
while (current_dir_info is not None or
3488
current_block is not None):
3489
if (current_dir_info and current_block
3490
and current_dir_info[0][0] != current_block[0]):
3491
if _cmp_by_dirs(current_dir_info[0][0], current_block[0]) < 0:
3492
# filesystem data refers to paths not covered by the dirblock.
3493
# this has two possibilities:
3494
# A) it is versioned but empty, so there is no block for it
3495
# B) it is not versioned.
3497
# if (A) then we need to recurse into it to check for
3498
# new unknown files or directories.
3499
# if (B) then we should ignore it, because we don't
3500
# recurse into unknown directories.
3502
while path_index < len(current_dir_info[1]):
3503
current_path_info = current_dir_info[1][path_index]
3504
if self.want_unversioned:
3505
if current_path_info[2] == 'directory':
3506
if self.tree._directory_is_tree_reference(
3507
current_path_info[0].decode('utf8')):
3508
current_path_info = current_path_info[:2] + \
3509
('tree-reference',) + current_path_info[3:]
3510
new_executable = bool(
3511
stat.S_ISREG(current_path_info[3].st_mode)
3512
and stat.S_IEXEC & current_path_info[3].st_mode)
3514
(None, utf8_decode(current_path_info[0])[0]),
3518
(None, utf8_decode(current_path_info[1])[0]),
3519
(None, current_path_info[2]),
3520
(None, new_executable))
3521
# dont descend into this unversioned path if it is
3523
if current_path_info[2] in ('directory',
3525
del current_dir_info[1][path_index]
3529
# This dir info has been handled, go to the next
3531
current_dir_info = dir_iterator.next()
3532
except StopIteration:
3533
current_dir_info = None
3535
# We have a dirblock entry for this location, but there
3536
# is no filesystem path for this. This is most likely
3537
# because a directory was removed from the disk.
3538
# We don't have to report the missing directory,
3539
# because that should have already been handled, but we
3540
# need to handle all of the files that are contained
3542
for current_entry in current_block[1]:
3543
# entry referring to file not present on disk.
3544
# advance the entry only, after processing.
3545
result = _process_entry(current_entry, None)
3546
if result is not None:
3547
if result is not uninteresting:
3550
if (block_index < len(self.state._dirblocks) and
3551
osutils.is_inside(current_root,
3552
self.state._dirblocks[block_index][0])):
3553
current_block = self.state._dirblocks[block_index]
3555
current_block = None
3558
if current_block and entry_index < len(current_block[1]):
3559
current_entry = current_block[1][entry_index]
3561
current_entry = None
3562
advance_entry = True
3564
if current_dir_info and path_index < len(current_dir_info[1]):
3565
current_path_info = current_dir_info[1][path_index]
3566
if current_path_info[2] == 'directory':
3567
if self.tree._directory_is_tree_reference(
3568
current_path_info[0].decode('utf8')):
3569
current_path_info = current_path_info[:2] + \
3570
('tree-reference',) + current_path_info[3:]
3572
current_path_info = None
3574
path_handled = False
3575
while (current_entry is not None or
3576
current_path_info is not None):
3577
if current_entry is None:
3578
# the check for path_handled when the path is advanced
3579
# will yield this path if needed.
3581
elif current_path_info is None:
3582
# no path is fine: the per entry code will handle it.
3583
result = _process_entry(current_entry, current_path_info)
3584
if result is not None:
3585
if result is not uninteresting:
3587
elif (current_entry[0][1] != current_path_info[1]
3588
or current_entry[1][self.target_index][0] in 'ar'):
3589
# The current path on disk doesn't match the dirblock
3590
# record. Either the dirblock is marked as absent, or
3591
# the file on disk is not present at all in the
3592
# dirblock. Either way, report about the dirblock
3593
# entry, and let other code handle the filesystem one.
3595
# Compare the basename for these files to determine
3597
if current_path_info[1] < current_entry[0][1]:
3598
# extra file on disk: pass for now, but only
3599
# increment the path, not the entry
3600
advance_entry = False
3602
# entry referring to file not present on disk.
3603
# advance the entry only, after processing.
3604
result = _process_entry(current_entry, None)
3605
if result is not None:
3606
if result is not uninteresting:
3608
advance_path = False
3610
result = _process_entry(current_entry, current_path_info)
3611
if result is not None:
3613
if result is not uninteresting:
3615
if advance_entry and current_entry is not None:
3617
if entry_index < len(current_block[1]):
3618
current_entry = current_block[1][entry_index]
3620
current_entry = None
3622
advance_entry = True # reset the advance flaga
3623
if advance_path and current_path_info is not None:
3624
if not path_handled:
3625
# unversioned in all regards
3626
if self.want_unversioned:
3627
new_executable = bool(
3628
stat.S_ISREG(current_path_info[3].st_mode)
3629
and stat.S_IEXEC & current_path_info[3].st_mode)
3631
relpath_unicode = utf8_decode(current_path_info[0])[0]
3632
except UnicodeDecodeError:
3633
raise errors.BadFilenameEncoding(
3634
current_path_info[0], osutils._fs_enc)
3636
(None, relpath_unicode),
3640
(None, utf8_decode(current_path_info[1])[0]),
3641
(None, current_path_info[2]),
3642
(None, new_executable))
3643
# dont descend into this unversioned path if it is
3645
if current_path_info[2] in ('directory'):
3646
del current_dir_info[1][path_index]
3648
# dont descend the disk iterator into any tree
3650
if current_path_info[2] == 'tree-reference':
3651
del current_dir_info[1][path_index]
3654
if path_index < len(current_dir_info[1]):
3655
current_path_info = current_dir_info[1][path_index]
3656
if current_path_info[2] == 'directory':
3657
if self.tree._directory_is_tree_reference(
3658
current_path_info[0].decode('utf8')):
3659
current_path_info = current_path_info[:2] + \
3660
('tree-reference',) + current_path_info[3:]
3662
current_path_info = None
3663
path_handled = False
3665
advance_path = True # reset the advance flagg.
3666
if current_block is not None:
3668
if (block_index < len(self.state._dirblocks) and
3669
osutils.is_inside(current_root, self.state._dirblocks[block_index][0])):
3670
current_block = self.state._dirblocks[block_index]
3672
current_block = None
3673
if current_dir_info is not None:
3675
current_dir_info = dir_iterator.next()
3676
except StopIteration:
3677
current_dir_info = None
3680
# Try to load the compiled form if possible
3682
from bzrlib._dirstate_helpers_pyx import (
3688
ProcessEntryC as _process_entry,
3689
update_entry as update_entry,
3692
from bzrlib._dirstate_helpers_py import (
3699
# FIXME: It would be nice to be able to track moved lines so that the
3700
# corresponding python code can be moved to the _dirstate_helpers_py
3701
# module. I don't want to break the history for this important piece of
3702
# code so I left the code here -- vila 20090622
3703
update_entry = py_update_entry
3704
_process_entry = ProcessEntryPython
added
removed
bzrlib/dirstate.py
