1
# Copyright (C) 2006-2011 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.
25
MINIKIND = "f" | "d" | "l" | "a" | "r" | "t";
28
WHOLE_NUMBER = {digit}, digit;
30
REVISION_ID = a non-empty utf8 string;
32
dirstate format = header line, full checksum, row count, parent details,
33
ghost_details, entries;
34
header line = "#bazaar dirstate flat format 3", NL;
35
full checksum = "crc32: ", ["-"], WHOLE_NUMBER, NL;
36
row count = "num_entries: ", WHOLE_NUMBER, NL;
37
parent_details = WHOLE NUMBER, {REVISION_ID}* NL;
38
ghost_details = WHOLE NUMBER, {REVISION_ID}*, NL;
40
entry = entry_key, current_entry_details, {parent_entry_details};
41
entry_key = dirname, basename, fileid;
42
current_entry_details = common_entry_details, working_entry_details;
43
parent_entry_details = common_entry_details, history_entry_details;
44
common_entry_details = MINIKIND, fingerprint, size, executable
45
working_entry_details = packed_stat
46
history_entry_details = REVISION_ID;
49
fingerprint = a nonempty utf8 sequence with meaning defined by minikind.
51
Given this definition, the following is useful to know::
53
entry (aka row) - all the data for a given key.
54
entry[0]: The key (dirname, basename, fileid)
58
entry[1]: The tree(s) data for this path and id combination.
59
entry[1][0]: The current tree
60
entry[1][1]: The second tree
62
For an entry for a tree, we have (using tree 0 - current tree) to demonstrate::
64
entry[1][0][0]: minikind
65
entry[1][0][1]: fingerprint
67
entry[1][0][3]: executable
68
entry[1][0][4]: packed_stat
72
entry[1][1][4]: revision_id
74
There may be multiple rows at the root, one per id present in the root, so the
75
in memory root row is now::
77
self._dirblocks[0] -> ('', [entry ...]),
79
and the entries in there are::
83
entries[0][2]: file_id
84
entries[1][0]: The tree data for the current tree for this fileid at /
89
'r' is a relocated entry: This path is not present in this tree with this
90
id, but the id can be found at another location. The fingerprint is
91
used to point to the target location.
92
'a' is an absent entry: In that tree the id is not present at this path.
93
'd' is a directory entry: This path in this tree is a directory with the
94
current file id. There is no fingerprint for directories.
95
'f' is a file entry: As for directory, but it's a file. The fingerprint is
96
the sha1 value of the file's canonical form, i.e. after any read
97
filters have been applied to the convenience form stored in the working
99
'l' is a symlink entry: As for directory, but a symlink. The fingerprint is
101
't' is a reference to a nested subtree; the fingerprint is the referenced
106
The entries on disk and in memory are ordered according to the following keys::
108
directory, as a list of components
112
--- Format 1 had the following different definition: ---
116
rows = dirname, NULL, basename, NULL, MINIKIND, NULL, fileid_utf8, NULL,
117
WHOLE NUMBER (* size *), NULL, packed stat, NULL, sha1|symlink target,
119
PARENT ROW = NULL, revision_utf8, NULL, MINIKIND, NULL, dirname, NULL,
120
basename, NULL, WHOLE NUMBER (* size *), NULL, "y" | "n", NULL,
123
PARENT ROW's are emitted for every parent that is not in the ghosts details
124
line. That is, if the parents are foo, bar, baz, and the ghosts are bar, then
125
each row will have a PARENT ROW for foo and baz, but not for bar.
128
In any tree, a kind of 'moved' indicates that the fingerprint field
129
(which we treat as opaque data specific to the 'kind' anyway) has the
130
details for the id of this row in that tree.
132
I'm strongly tempted to add a id->path index as well, but I think that
133
where we need id->path mapping; we also usually read the whole file, so
134
I'm going to skip that for the moment, as we have the ability to locate
135
via bisect any path in any tree, and if we lookup things by path, we can
136
accumulate an id->path mapping as we go, which will tend to match what we
139
I plan to implement this asap, so please speak up now to alter/tweak the
140
design - and once we stabilise on this, I'll update the wiki page for
143
The rationale for all this is that we want fast operations for the
144
common case (diff/status/commit/merge on all files) and extremely fast
145
operations for the less common but still occurs a lot status/diff/commit
146
on specific files). Operations on specific files involve a scan for all
147
the children of a path, *in every involved tree*, which the current
148
format did not accommodate.
152
1. Fast end to end use for bzr's top 5 uses cases. (commmit/diff/status/merge/???)
153
2. fall back current object model as needed.
154
3. scale usably to the largest trees known today - say 50K entries. (mozilla
155
is an example of this)
160
Eventually reuse dirstate objects across locks IFF the dirstate file has not
161
been modified, but will require that we flush/ignore cached stat-hit data
162
because we won't want to restat all files on disk just because a lock was
163
acquired, yet we cannot trust the data after the previous lock was released.
165
Memory representation::
167
vector of all directories, and vector of the childen ?
169
root_entrie = (direntry for root, [parent_direntries_for_root]),
171
('', ['data for achild', 'data for bchild', 'data for cchild'])
172
('dir', ['achild', 'cchild', 'echild'])
174
- single bisect to find N subtrees from a path spec
175
- in-order for serialisation - this is 'dirblock' grouping.
176
- insertion of a file '/a' affects only the '/' child-vector, that is, to
177
insert 10K elements from scratch does not generates O(N^2) memoves of a
178
single vector, rather each individual, which tends to be limited to a
179
manageable number. Will scale badly on trees with 10K entries in a
180
single directory. compare with Inventory.InventoryDirectory which has
181
a dictionary for the children. No bisect capability, can only probe for
182
exact matches, or grab all elements and sort.
183
- What's the risk of error here? Once we have the base format being processed
184
we should have a net win regardless of optimality. So we are going to
185
go with what seems reasonable.
189
Maybe we should do a test profile of the core structure - 10K simulated
190
searches/lookups/etc?
192
Objects for each row?
193
The lifetime of Dirstate objects is current per lock, but see above for
194
possible extensions. The lifetime of a row from a dirstate is expected to be
195
very short in the optimistic case: which we are optimising for. For instance,
196
subtree status will determine from analysis of the disk data what rows need to
197
be examined at all, and will be able to determine from a single row whether
198
that file has altered or not, so we are aiming to process tens of thousands of
199
entries each second within the dirstate context, before exposing anything to
200
the larger codebase. This suggests we want the time for a single file
201
comparison to be < 0.1 milliseconds. That would give us 10000 paths per second
202
processed, and to scale to 100 thousand we'll another order of magnitude to do
203
that. Now, as the lifetime for all unchanged entries is the time to parse, stat
204
the file on disk, and then immediately discard, the overhead of object creation
205
becomes a significant cost.
207
Figures: Creating a tuple from 3 elements was profiled at 0.0625
208
microseconds, whereas creating a object which is subclassed from tuple was
209
0.500 microseconds, and creating an object with 3 elements and slots was 3
210
microseconds long. 0.1 milliseconds is 100 microseconds, and ideally we'll get
211
down to 10 microseconds for the total processing - having 33% of that be object
212
creation is a huge overhead. There is a potential cost in using tuples within
213
each row which is that the conditional code to do comparisons may be slower
214
than method invocation, but method invocation is known to be slow due to stack
215
frame creation, so avoiding methods in these tight inner loops in unfortunately
216
desirable. We can consider a pyrex version of this with objects in future if
221
from __future__ import absolute_import
227
from stat import S_IEXEC
247
# This is the Windows equivalent of ENOTDIR
248
# It is defined in pywin32.winerror, but we don't want a strong dependency for
249
# just an error code.
250
ERROR_PATH_NOT_FOUND = 3
251
ERROR_DIRECTORY = 267
254
class SHA1Provider(object):
255
"""An interface for getting sha1s of a file."""
257
def sha1(self, abspath):
258
"""Return the sha1 of a file given its absolute path.
260
:param abspath: May be a filesystem encoded absolute path
263
raise NotImplementedError(self.sha1)
265
def stat_and_sha1(self, abspath):
266
"""Return the stat and sha1 of a file given its absolute path.
268
:param abspath: May be a filesystem encoded absolute path
271
Note: the stat should be the stat of the physical file
272
while the sha may be the sha of its canonical content.
274
raise NotImplementedError(self.stat_and_sha1)
277
class DefaultSHA1Provider(SHA1Provider):
278
"""A SHA1Provider that reads directly from the filesystem."""
280
def sha1(self, abspath):
281
"""Return the sha1 of a file given its absolute path."""
282
return osutils.sha_file_by_name(abspath)
284
def stat_and_sha1(self, abspath):
285
"""Return the stat and sha1 of a file given its absolute path."""
286
file_obj = file(abspath, 'rb')
288
statvalue = os.fstat(file_obj.fileno())
289
sha1 = osutils.sha_file(file_obj)
292
return statvalue, sha1
295
class DirState(object):
296
"""Record directory and metadata state for fast access.
298
A dirstate is a specialised data structure for managing local working
299
tree state information. Its not yet well defined whether it is platform
300
specific, and if it is how we detect/parameterize that.
302
Dirstates use the usual lock_write, lock_read and unlock mechanisms.
303
Unlike most bzr disk formats, DirStates must be locked for reading, using
304
lock_read. (This is an os file lock internally.) This is necessary
305
because the file can be rewritten in place.
307
DirStates must be explicitly written with save() to commit changes; just
308
unlocking them does not write the changes to disk.
311
_kind_to_minikind = {
317
'tree-reference': 't',
319
_minikind_to_kind = {
325
't': 'tree-reference',
327
_stat_to_minikind = {
332
_to_yesno = {True:'y', False: 'n'} # TODO profile the performance gain
333
# of using int conversion rather than a dict here. AND BLAME ANDREW IF
336
# TODO: jam 20070221 Figure out what to do if we have a record that exceeds
337
# the BISECT_PAGE_SIZE. For now, we just have to make it large enough
338
# that we are sure a single record will always fit.
339
BISECT_PAGE_SIZE = 4096
342
IN_MEMORY_UNMODIFIED = 1
343
IN_MEMORY_MODIFIED = 2
344
IN_MEMORY_HASH_MODIFIED = 3 # Only hash-cache updates
346
# A pack_stat (the x's) that is just noise and will never match the output
349
NULL_PARENT_DETAILS = static_tuple.StaticTuple('a', '', 0, False, '')
351
HEADER_FORMAT_2 = '#bazaar dirstate flat format 2\n'
352
HEADER_FORMAT_3 = '#bazaar dirstate flat format 3\n'
354
def __init__(self, path, sha1_provider, worth_saving_limit=0):
355
"""Create a DirState object.
357
:param path: The path at which the dirstate file on disk should live.
358
:param sha1_provider: an object meeting the SHA1Provider interface.
359
:param worth_saving_limit: when the exact number of hash changed
360
entries is known, only bother saving the dirstate if more than
361
this count of entries have changed.
362
-1 means never save hash changes, 0 means always save hash changes.
364
# _header_state and _dirblock_state represent the current state
365
# of the dirstate metadata and the per-row data respectiely.
366
# NOT_IN_MEMORY indicates that no data is in memory
367
# IN_MEMORY_UNMODIFIED indicates that what we have in memory
368
# is the same as is on disk
369
# IN_MEMORY_MODIFIED indicates that we have a modified version
370
# of what is on disk.
371
# In future we will add more granularity, for instance _dirblock_state
372
# will probably support partially-in-memory as a separate variable,
373
# allowing for partially-in-memory unmodified and partially-in-memory
375
self._header_state = DirState.NOT_IN_MEMORY
376
self._dirblock_state = DirState.NOT_IN_MEMORY
377
# If true, an error has been detected while updating the dirstate, and
378
# for safety we're not going to commit to disk.
379
self._changes_aborted = False
383
self._state_file = None
384
self._filename = path
385
self._lock_token = None
386
self._lock_state = None
387
self._id_index = None
388
# a map from packed_stat to sha's.
389
self._packed_stat_index = None
390
self._end_of_header = None
391
self._cutoff_time = None
392
self._split_path_cache = {}
393
self._bisect_page_size = DirState.BISECT_PAGE_SIZE
394
self._sha1_provider = sha1_provider
395
if 'hashcache' in debug.debug_flags:
396
self._sha1_file = self._sha1_file_and_mutter
398
self._sha1_file = self._sha1_provider.sha1
399
# These two attributes provide a simple cache for lookups into the
400
# dirstate in-memory vectors. By probing respectively for the last
401
# block, and for the next entry, we save nearly 2 bisections per path
403
self._last_block_index = None
404
self._last_entry_index = None
405
# The set of known hash changes
406
self._known_hash_changes = set()
407
# How many hash changed entries can we have without saving
408
self._worth_saving_limit = worth_saving_limit
409
self._config_stack = config.LocationStack(urlutils.local_path_to_url(
414
(self.__class__.__name__, self._filename)
416
def _mark_modified(self, hash_changed_entries=None, header_modified=False):
417
"""Mark this dirstate as modified.
419
:param hash_changed_entries: if non-None, mark just these entries as
420
having their hash modified.
421
:param header_modified: mark the header modified as well, not just the
424
#trace.mutter_callsite(3, "modified hash entries: %s", hash_changed_entries)
425
if hash_changed_entries:
426
self._known_hash_changes.update([e[0] for e in hash_changed_entries])
427
if self._dirblock_state in (DirState.NOT_IN_MEMORY,
428
DirState.IN_MEMORY_UNMODIFIED):
429
# If the dirstate is already marked a IN_MEMORY_MODIFIED, then
430
# that takes precedence.
431
self._dirblock_state = DirState.IN_MEMORY_HASH_MODIFIED
433
# TODO: Since we now have a IN_MEMORY_HASH_MODIFIED state, we
434
# should fail noisily if someone tries to set
435
# IN_MEMORY_MODIFIED but we don't have a write-lock!
436
# We don't know exactly what changed so disable smart saving
437
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
439
self._header_state = DirState.IN_MEMORY_MODIFIED
441
def _mark_unmodified(self):
442
"""Mark this dirstate as unmodified."""
443
self._header_state = DirState.IN_MEMORY_UNMODIFIED
444
self._dirblock_state = DirState.IN_MEMORY_UNMODIFIED
445
self._known_hash_changes = set()
447
def add(self, path, file_id, kind, stat, fingerprint):
448
"""Add a path to be tracked.
450
:param path: The path within the dirstate - '' is the root, 'foo' is the
451
path foo within the root, 'foo/bar' is the path bar within foo
453
:param file_id: The file id of the path being added.
454
:param kind: The kind of the path, as a string like 'file',
456
:param stat: The output of os.lstat for the path.
457
:param fingerprint: The sha value of the file's canonical form (i.e.
458
after any read filters have been applied),
459
or the target of a symlink,
460
or the referenced revision id for tree-references,
461
or '' for directories.
464
# find the block its in.
465
# find the location in the block.
466
# check its not there
468
#------- copied from inventory.ensure_normalized_name - keep synced.
469
# --- normalized_filename wants a unicode basename only, so get one.
470
dirname, basename = osutils.split(path)
471
# we dont import normalized_filename directly because we want to be
472
# able to change the implementation at runtime for tests.
473
norm_name, can_access = osutils.normalized_filename(basename)
474
if norm_name != basename:
478
raise errors.InvalidNormalization(path)
479
# you should never have files called . or ..; just add the directory
480
# in the parent, or according to the special treatment for the root
481
if basename == '.' or basename == '..':
482
raise errors.InvalidEntryName(path)
483
# now that we've normalised, we need the correct utf8 path and
484
# dirname and basename elements. This single encode and split should be
485
# faster than three separate encodes.
486
utf8path = (dirname + '/' + basename).strip('/').encode('utf8')
487
dirname, basename = osutils.split(utf8path)
488
# uses __class__ for speed; the check is needed for safety
489
if file_id.__class__ is not str:
490
raise AssertionError(
491
"must be a utf8 file_id not %s" % (type(file_id), ))
492
# Make sure the file_id does not exist in this tree
494
file_id_entry = self._get_entry(0, fileid_utf8=file_id, include_deleted=True)
495
if file_id_entry != (None, None):
496
if file_id_entry[1][0][0] == 'a':
497
if file_id_entry[0] != (dirname, basename, file_id):
498
# set the old name's current operation to rename
499
self.update_minimal(file_id_entry[0],
505
rename_from = file_id_entry[0][0:2]
507
path = osutils.pathjoin(file_id_entry[0][0], file_id_entry[0][1])
508
kind = DirState._minikind_to_kind[file_id_entry[1][0][0]]
509
info = '%s:%s' % (kind, path)
510
raise errors.DuplicateFileId(file_id, info)
511
first_key = (dirname, basename, '')
512
block_index, present = self._find_block_index_from_key(first_key)
514
# check the path is not in the tree
515
block = self._dirblocks[block_index][1]
516
entry_index, _ = self._find_entry_index(first_key, block)
517
while (entry_index < len(block) and
518
block[entry_index][0][0:2] == first_key[0:2]):
519
if block[entry_index][1][0][0] not in 'ar':
520
# this path is in the dirstate in the current tree.
521
raise Exception, "adding already added path!"
524
# The block where we want to put the file is not present. But it
525
# might be because the directory was empty, or not loaded yet. Look
526
# for a parent entry, if not found, raise NotVersionedError
527
parent_dir, parent_base = osutils.split(dirname)
528
parent_block_idx, parent_entry_idx, _, parent_present = \
529
self._get_block_entry_index(parent_dir, parent_base, 0)
530
if not parent_present:
531
raise errors.NotVersionedError(path, str(self))
532
self._ensure_block(parent_block_idx, parent_entry_idx, dirname)
533
block = self._dirblocks[block_index][1]
534
entry_key = (dirname, basename, file_id)
537
packed_stat = DirState.NULLSTAT
540
packed_stat = pack_stat(stat)
541
parent_info = self._empty_parent_info()
542
minikind = DirState._kind_to_minikind[kind]
543
if rename_from is not None:
545
old_path_utf8 = '%s/%s' % rename_from
547
old_path_utf8 = rename_from[1]
548
parent_info[0] = ('r', old_path_utf8, 0, False, '')
550
entry_data = entry_key, [
551
(minikind, fingerprint, size, False, packed_stat),
553
elif kind == 'directory':
554
entry_data = entry_key, [
555
(minikind, '', 0, False, packed_stat),
557
elif kind == 'symlink':
558
entry_data = entry_key, [
559
(minikind, fingerprint, size, False, packed_stat),
561
elif kind == 'tree-reference':
562
entry_data = entry_key, [
563
(minikind, fingerprint, 0, False, packed_stat),
566
raise errors.BzrError('unknown kind %r' % kind)
567
entry_index, present = self._find_entry_index(entry_key, block)
569
block.insert(entry_index, entry_data)
571
if block[entry_index][1][0][0] != 'a':
572
raise AssertionError(" %r(%r) already added" % (basename, file_id))
573
block[entry_index][1][0] = entry_data[1][0]
575
if kind == 'directory':
576
# insert a new dirblock
577
self._ensure_block(block_index, entry_index, utf8path)
578
self._mark_modified()
580
self._add_to_id_index(self._id_index, entry_key)
582
def _bisect(self, paths):
583
"""Bisect through the disk structure for specific rows.
585
:param paths: A list of paths to find
586
:return: A dict mapping path => entries for found entries. Missing
587
entries will not be in the map.
588
The list is not sorted, and entries will be populated
589
based on when they were read.
591
self._requires_lock()
592
# We need the file pointer to be right after the initial header block
593
self._read_header_if_needed()
594
# If _dirblock_state was in memory, we should just return info from
595
# there, this function is only meant to handle when we want to read
597
if self._dirblock_state != DirState.NOT_IN_MEMORY:
598
raise AssertionError("bad dirblock state %r" % self._dirblock_state)
600
# The disk representation is generally info + '\0\n\0' at the end. But
601
# for bisecting, it is easier to treat this as '\0' + info + '\0\n'
602
# Because it means we can sync on the '\n'
603
state_file = self._state_file
604
file_size = os.fstat(state_file.fileno()).st_size
605
# We end up with 2 extra fields, we should have a trailing '\n' to
606
# ensure that we read the whole record, and we should have a precursur
607
# '' which ensures that we start after the previous '\n'
608
entry_field_count = self._fields_per_entry() + 1
610
low = self._end_of_header
611
high = file_size - 1 # Ignore the final '\0'
612
# Map from (dir, name) => entry
615
# Avoid infinite seeking
616
max_count = 30*len(paths)
618
# pending is a list of places to look.
619
# each entry is a tuple of low, high, dir_names
620
# low -> the first byte offset to read (inclusive)
621
# high -> the last byte offset (inclusive)
622
# dir_names -> The list of (dir, name) pairs that should be found in
623
# the [low, high] range
624
pending = [(low, high, paths)]
626
page_size = self._bisect_page_size
628
fields_to_entry = self._get_fields_to_entry()
631
low, high, cur_files = pending.pop()
633
if not cur_files or low >= high:
638
if count > max_count:
639
raise errors.BzrError('Too many seeks, most likely a bug.')
641
mid = max(low, (low+high-page_size)/2)
644
# limit the read size, so we don't end up reading data that we have
646
read_size = min(page_size, (high-mid)+1)
647
block = state_file.read(read_size)
650
entries = block.split('\n')
653
# We didn't find a '\n', so we cannot have found any records.
654
# So put this range back and try again. But we know we have to
655
# increase the page size, because a single read did not contain
656
# a record break (so records must be larger than page_size)
658
pending.append((low, high, cur_files))
661
# Check the first and last entries, in case they are partial, or if
662
# we don't care about the rest of this page
664
first_fields = entries[0].split('\0')
665
if len(first_fields) < entry_field_count:
666
# We didn't get the complete first entry
667
# so move start, and grab the next, which
668
# should be a full entry
669
start += len(entries[0])+1
670
first_fields = entries[1].split('\0')
673
if len(first_fields) <= 2:
674
# We didn't even get a filename here... what do we do?
675
# Try a large page size and repeat this query
677
pending.append((low, high, cur_files))
680
# Find what entries we are looking for, which occur before and
681
# after this first record.
684
first_path = first_fields[1] + '/' + first_fields[2]
686
first_path = first_fields[2]
687
first_loc = _bisect_path_left(cur_files, first_path)
689
# These exist before the current location
690
pre = cur_files[:first_loc]
691
# These occur after the current location, which may be in the
692
# data we read, or might be after the last entry
693
post = cur_files[first_loc:]
695
if post and len(first_fields) >= entry_field_count:
696
# We have files after the first entry
698
# Parse the last entry
699
last_entry_num = len(entries)-1
700
last_fields = entries[last_entry_num].split('\0')
701
if len(last_fields) < entry_field_count:
702
# The very last hunk was not complete,
703
# read the previous hunk
704
after = mid + len(block) - len(entries[-1])
706
last_fields = entries[last_entry_num].split('\0')
708
after = mid + len(block)
711
last_path = last_fields[1] + '/' + last_fields[2]
713
last_path = last_fields[2]
714
last_loc = _bisect_path_right(post, last_path)
716
middle_files = post[:last_loc]
717
post = post[last_loc:]
720
# We have files that should occur in this block
721
# (>= first, <= last)
722
# Either we will find them here, or we can mark them as
725
if middle_files[0] == first_path:
726
# We might need to go before this location
727
pre.append(first_path)
728
if middle_files[-1] == last_path:
729
post.insert(0, last_path)
731
# Find out what paths we have
732
paths = {first_path:[first_fields]}
733
# last_path might == first_path so we need to be
734
# careful if we should append rather than overwrite
735
if last_entry_num != first_entry_num:
736
paths.setdefault(last_path, []).append(last_fields)
737
for num in xrange(first_entry_num+1, last_entry_num):
738
# TODO: jam 20070223 We are already splitting here, so
739
# shouldn't we just split the whole thing rather
740
# than doing the split again in add_one_record?
741
fields = entries[num].split('\0')
743
path = fields[1] + '/' + fields[2]
746
paths.setdefault(path, []).append(fields)
748
for path in middle_files:
749
for fields in paths.get(path, []):
750
# offset by 1 because of the opening '\0'
751
# consider changing fields_to_entry to avoid the
753
entry = fields_to_entry(fields[1:])
754
found.setdefault(path, []).append(entry)
756
# Now we have split up everything into pre, middle, and post, and
757
# we have handled everything that fell in 'middle'.
758
# We add 'post' first, so that we prefer to seek towards the
759
# beginning, so that we will tend to go as early as we need, and
760
# then only seek forward after that.
762
pending.append((after, high, post))
764
pending.append((low, start-1, pre))
766
# Consider that we may want to return the directory entries in sorted
767
# order. For now, we just return them in whatever order we found them,
768
# and leave it up to the caller if they care if it is ordered or not.
771
def _bisect_dirblocks(self, dir_list):
772
"""Bisect through the disk structure to find entries in given dirs.
774
_bisect_dirblocks is meant to find the contents of directories, which
775
differs from _bisect, which only finds individual entries.
777
:param dir_list: A sorted list of directory names ['', 'dir', 'foo'].
778
:return: A map from dir => entries_for_dir
780
# TODO: jam 20070223 A lot of the bisecting logic could be shared
781
# between this and _bisect. It would require parameterizing the
782
# inner loop with a function, though. We should evaluate the
783
# performance difference.
784
self._requires_lock()
785
# We need the file pointer to be right after the initial header block
786
self._read_header_if_needed()
787
# If _dirblock_state was in memory, we should just return info from
788
# there, this function is only meant to handle when we want to read
790
if self._dirblock_state != DirState.NOT_IN_MEMORY:
791
raise AssertionError("bad dirblock state %r" % self._dirblock_state)
792
# The disk representation is generally info + '\0\n\0' at the end. But
793
# for bisecting, it is easier to treat this as '\0' + info + '\0\n'
794
# Because it means we can sync on the '\n'
795
state_file = self._state_file
796
file_size = os.fstat(state_file.fileno()).st_size
797
# We end up with 2 extra fields, we should have a trailing '\n' to
798
# ensure that we read the whole record, and we should have a precursur
799
# '' which ensures that we start after the previous '\n'
800
entry_field_count = self._fields_per_entry() + 1
802
low = self._end_of_header
803
high = file_size - 1 # Ignore the final '\0'
804
# Map from dir => entry
807
# Avoid infinite seeking
808
max_count = 30*len(dir_list)
810
# pending is a list of places to look.
811
# each entry is a tuple of low, high, dir_names
812
# low -> the first byte offset to read (inclusive)
813
# high -> the last byte offset (inclusive)
814
# dirs -> The list of directories that should be found in
815
# the [low, high] range
816
pending = [(low, high, dir_list)]
818
page_size = self._bisect_page_size
820
fields_to_entry = self._get_fields_to_entry()
823
low, high, cur_dirs = pending.pop()
825
if not cur_dirs or low >= high:
830
if count > max_count:
831
raise errors.BzrError('Too many seeks, most likely a bug.')
833
mid = max(low, (low+high-page_size)/2)
836
# limit the read size, so we don't end up reading data that we have
838
read_size = min(page_size, (high-mid)+1)
839
block = state_file.read(read_size)
842
entries = block.split('\n')
845
# We didn't find a '\n', so we cannot have found any records.
846
# So put this range back and try again. But we know we have to
847
# increase the page size, because a single read did not contain
848
# a record break (so records must be larger than page_size)
850
pending.append((low, high, cur_dirs))
853
# Check the first and last entries, in case they are partial, or if
854
# we don't care about the rest of this page
856
first_fields = entries[0].split('\0')
857
if len(first_fields) < entry_field_count:
858
# We didn't get the complete first entry
859
# so move start, and grab the next, which
860
# should be a full entry
861
start += len(entries[0])+1
862
first_fields = entries[1].split('\0')
865
if len(first_fields) <= 1:
866
# We didn't even get a dirname here... what do we do?
867
# Try a large page size and repeat this query
869
pending.append((low, high, cur_dirs))
872
# Find what entries we are looking for, which occur before and
873
# after this first record.
875
first_dir = first_fields[1]
876
first_loc = bisect.bisect_left(cur_dirs, first_dir)
878
# These exist before the current location
879
pre = cur_dirs[:first_loc]
880
# These occur after the current location, which may be in the
881
# data we read, or might be after the last entry
882
post = cur_dirs[first_loc:]
884
if post and len(first_fields) >= entry_field_count:
885
# We have records to look at after the first entry
887
# Parse the last entry
888
last_entry_num = len(entries)-1
889
last_fields = entries[last_entry_num].split('\0')
890
if len(last_fields) < entry_field_count:
891
# The very last hunk was not complete,
892
# read the previous hunk
893
after = mid + len(block) - len(entries[-1])
895
last_fields = entries[last_entry_num].split('\0')
897
after = mid + len(block)
899
last_dir = last_fields[1]
900
last_loc = bisect.bisect_right(post, last_dir)
902
middle_files = post[:last_loc]
903
post = post[last_loc:]
906
# We have files that should occur in this block
907
# (>= first, <= last)
908
# Either we will find them here, or we can mark them as
911
if middle_files[0] == first_dir:
912
# We might need to go before this location
913
pre.append(first_dir)
914
if middle_files[-1] == last_dir:
915
post.insert(0, last_dir)
917
# Find out what paths we have
918
paths = {first_dir:[first_fields]}
919
# last_dir might == first_dir so we need to be
920
# careful if we should append rather than overwrite
921
if last_entry_num != first_entry_num:
922
paths.setdefault(last_dir, []).append(last_fields)
923
for num in xrange(first_entry_num+1, last_entry_num):
924
# TODO: jam 20070223 We are already splitting here, so
925
# shouldn't we just split the whole thing rather
926
# than doing the split again in add_one_record?
927
fields = entries[num].split('\0')
928
paths.setdefault(fields[1], []).append(fields)
930
for cur_dir in middle_files:
931
for fields in paths.get(cur_dir, []):
932
# offset by 1 because of the opening '\0'
933
# consider changing fields_to_entry to avoid the
935
entry = fields_to_entry(fields[1:])
936
found.setdefault(cur_dir, []).append(entry)
938
# Now we have split up everything into pre, middle, and post, and
939
# we have handled everything that fell in 'middle'.
940
# We add 'post' first, so that we prefer to seek towards the
941
# beginning, so that we will tend to go as early as we need, and
942
# then only seek forward after that.
944
pending.append((after, high, post))
946
pending.append((low, start-1, pre))
950
def _bisect_recursive(self, paths):
951
"""Bisect for entries for all paths and their children.
953
This will use bisect to find all records for the supplied paths. It
954
will then continue to bisect for any records which are marked as
955
directories. (and renames?)
957
:param paths: A sorted list of (dir, name) pairs
958
eg: [('', 'a'), ('', 'f'), ('a/b', 'c')]
959
:return: A dictionary mapping (dir, name, file_id) => [tree_info]
961
# Map from (dir, name, file_id) => [tree_info]
964
found_dir_names = set()
966
# Directories that have been read
967
processed_dirs = set()
968
# Get the ball rolling with the first bisect for all entries.
969
newly_found = self._bisect(paths)
972
# Directories that need to be read
974
paths_to_search = set()
975
for entry_list in newly_found.itervalues():
976
for dir_name_id, trees_info in entry_list:
977
found[dir_name_id] = trees_info
978
found_dir_names.add(dir_name_id[:2])
980
for tree_info in trees_info:
981
minikind = tree_info[0]
984
# We already processed this one as a directory,
985
# we don't need to do the extra work again.
987
subdir, name, file_id = dir_name_id
988
path = osutils.pathjoin(subdir, name)
990
if path not in processed_dirs:
991
pending_dirs.add(path)
992
elif minikind == 'r':
993
# Rename, we need to directly search the target
994
# which is contained in the fingerprint column
995
dir_name = osutils.split(tree_info[1])
996
if dir_name[0] in pending_dirs:
997
# This entry will be found in the dir search
999
if dir_name not in found_dir_names:
1000
paths_to_search.add(tree_info[1])
1001
# Now we have a list of paths to look for directly, and
1002
# directory blocks that need to be read.
1003
# newly_found is mixing the keys between (dir, name) and path
1004
# entries, but that is okay, because we only really care about the
1006
newly_found = self._bisect(sorted(paths_to_search))
1007
newly_found.update(self._bisect_dirblocks(sorted(pending_dirs)))
1008
processed_dirs.update(pending_dirs)
1011
def _discard_merge_parents(self):
1012
"""Discard any parents trees beyond the first.
1014
Note that if this fails the dirstate is corrupted.
1016
After this function returns the dirstate contains 2 trees, neither of
1019
self._read_header_if_needed()
1020
parents = self.get_parent_ids()
1021
if len(parents) < 1:
1023
# only require all dirblocks if we are doing a full-pass removal.
1024
self._read_dirblocks_if_needed()
1025
dead_patterns = set([('a', 'r'), ('a', 'a'), ('r', 'r'), ('r', 'a')])
1026
def iter_entries_removable():
1027
for block in self._dirblocks:
1028
deleted_positions = []
1029
for pos, entry in enumerate(block[1]):
1031
if (entry[1][0][0], entry[1][1][0]) in dead_patterns:
1032
deleted_positions.append(pos)
1033
if deleted_positions:
1034
if len(deleted_positions) == len(block[1]):
1037
for pos in reversed(deleted_positions):
1039
# if the first parent is a ghost:
1040
if parents[0] in self.get_ghosts():
1041
empty_parent = [DirState.NULL_PARENT_DETAILS]
1042
for entry in iter_entries_removable():
1043
entry[1][1:] = empty_parent
1045
for entry in iter_entries_removable():
1049
self._parents = [parents[0]]
1050
self._mark_modified(header_modified=True)
1052
def _empty_parent_info(self):
1053
return [DirState.NULL_PARENT_DETAILS] * (len(self._parents) -
1056
def _ensure_block(self, parent_block_index, parent_row_index, dirname):
1057
"""Ensure a block for dirname exists.
1059
This function exists to let callers which know that there is a
1060
directory dirname ensure that the block for it exists. This block can
1061
fail to exist because of demand loading, or because a directory had no
1062
children. In either case it is not an error. It is however an error to
1063
call this if there is no parent entry for the directory, and thus the
1064
function requires the coordinates of such an entry to be provided.
1066
The root row is special cased and can be indicated with a parent block
1069
:param parent_block_index: The index of the block in which dirname's row
1071
:param parent_row_index: The index in the parent block where the row
1073
:param dirname: The utf8 dirname to ensure there is a block for.
1074
:return: The index for the block.
1076
if dirname == '' and parent_row_index == 0 and parent_block_index == 0:
1077
# This is the signature of the root row, and the
1078
# contents-of-root row is always index 1
1080
# the basename of the directory must be the end of its full name.
1081
if not (parent_block_index == -1 and
1082
parent_block_index == -1 and dirname == ''):
1083
if not dirname.endswith(
1084
self._dirblocks[parent_block_index][1][parent_row_index][0][1]):
1085
raise AssertionError("bad dirname %r" % dirname)
1086
block_index, present = self._find_block_index_from_key((dirname, '', ''))
1088
## In future, when doing partial parsing, this should load and
1089
# populate the entire block.
1090
self._dirblocks.insert(block_index, (dirname, []))
1093
def _entries_to_current_state(self, new_entries):
1094
"""Load new_entries into self.dirblocks.
1096
Process new_entries into the current state object, making them the active
1097
state. The entries are grouped together by directory to form dirblocks.
1099
:param new_entries: A sorted list of entries. This function does not sort
1100
to prevent unneeded overhead when callers have a sorted list already.
1103
if new_entries[0][0][0:2] != ('', ''):
1104
raise AssertionError(
1105
"Missing root row %r" % (new_entries[0][0],))
1106
# The two blocks here are deliberate: the root block and the
1107
# contents-of-root block.
1108
self._dirblocks = [('', []), ('', [])]
1109
current_block = self._dirblocks[0][1]
1110
current_dirname = ''
1112
append_entry = current_block.append
1113
for entry in new_entries:
1114
if entry[0][0] != current_dirname:
1115
# new block - different dirname
1117
current_dirname = entry[0][0]
1118
self._dirblocks.append((current_dirname, current_block))
1119
append_entry = current_block.append
1120
# append the entry to the current block
1122
self._split_root_dirblock_into_contents()
1124
def _split_root_dirblock_into_contents(self):
1125
"""Split the root dirblocks into root and contents-of-root.
1127
After parsing by path, we end up with root entries and contents-of-root
1128
entries in the same block. This loop splits them out again.
1130
# The above loop leaves the "root block" entries mixed with the
1131
# "contents-of-root block". But we don't want an if check on
1132
# all entries, so instead we just fix it up here.
1133
if self._dirblocks[1] != ('', []):
1134
raise ValueError("bad dirblock start %r" % (self._dirblocks[1],))
1136
contents_of_root_block = []
1137
for entry in self._dirblocks[0][1]:
1138
if not entry[0][1]: # This is a root entry
1139
root_block.append(entry)
1141
contents_of_root_block.append(entry)
1142
self._dirblocks[0] = ('', root_block)
1143
self._dirblocks[1] = ('', contents_of_root_block)
1145
def _entries_for_path(self, path):
1146
"""Return a list with all the entries that match path for all ids."""
1147
dirname, basename = os.path.split(path)
1148
key = (dirname, basename, '')
1149
block_index, present = self._find_block_index_from_key(key)
1151
# the block which should contain path is absent.
1154
block = self._dirblocks[block_index][1]
1155
entry_index, _ = self._find_entry_index(key, block)
1156
# we may need to look at multiple entries at this path: walk while the specific_files match.
1157
while (entry_index < len(block) and
1158
block[entry_index][0][0:2] == key[0:2]):
1159
result.append(block[entry_index])
1163
def _entry_to_line(self, entry):
1164
"""Serialize entry to a NULL delimited line ready for _get_output_lines.
1166
:param entry: An entry_tuple as defined in the module docstring.
1168
entire_entry = list(entry[0])
1169
for tree_number, tree_data in enumerate(entry[1]):
1170
# (minikind, fingerprint, size, executable, tree_specific_string)
1171
entire_entry.extend(tree_data)
1172
# 3 for the key, 5 for the fields per tree.
1173
tree_offset = 3 + tree_number * 5
1175
entire_entry[tree_offset + 0] = tree_data[0]
1177
entire_entry[tree_offset + 2] = str(tree_data[2])
1179
entire_entry[tree_offset + 3] = DirState._to_yesno[tree_data[3]]
1180
return '\0'.join(entire_entry)
1182
def _fields_per_entry(self):
1183
"""How many null separated fields should be in each entry row.
1185
Each line now has an extra '\\n' field which is not used
1186
so we just skip over it
1189
3 fields for the key
1190
+ number of fields per tree_data (5) * tree count
1193
tree_count = 1 + self._num_present_parents()
1194
return 3 + 5 * tree_count + 1
1196
def _find_block(self, key, add_if_missing=False):
1197
"""Return the block that key should be present in.
1199
:param key: A dirstate entry key.
1200
:return: The block tuple.
1202
block_index, present = self._find_block_index_from_key(key)
1204
if not add_if_missing:
1205
# check to see if key is versioned itself - we might want to
1206
# add it anyway, because dirs with no entries dont get a
1207
# dirblock at parse time.
1208
# This is an uncommon branch to take: most dirs have children,
1209
# and most code works with versioned paths.
1210
parent_base, parent_name = osutils.split(key[0])
1211
if not self._get_block_entry_index(parent_base, parent_name, 0)[3]:
1212
# some parent path has not been added - its an error to add
1214
raise errors.NotVersionedError(key[0:2], str(self))
1215
self._dirblocks.insert(block_index, (key[0], []))
1216
return self._dirblocks[block_index]
1218
def _find_block_index_from_key(self, key):
1219
"""Find the dirblock index for a key.
1221
:return: The block index, True if the block for the key is present.
1223
if key[0:2] == ('', ''):
1226
if (self._last_block_index is not None and
1227
self._dirblocks[self._last_block_index][0] == key[0]):
1228
return self._last_block_index, True
1231
block_index = bisect_dirblock(self._dirblocks, key[0], 1,
1232
cache=self._split_path_cache)
1233
# _right returns one-past-where-key is so we have to subtract
1234
# one to use it. we use _right here because there are two
1235
# '' blocks - the root, and the contents of root
1236
# we always have a minimum of 2 in self._dirblocks: root and
1237
# root-contents, and for '', we get 2 back, so this is
1238
# simple and correct:
1239
present = (block_index < len(self._dirblocks) and
1240
self._dirblocks[block_index][0] == key[0])
1241
self._last_block_index = block_index
1242
# Reset the entry index cache to the beginning of the block.
1243
self._last_entry_index = -1
1244
return block_index, present
1246
def _find_entry_index(self, key, block):
1247
"""Find the entry index for a key in a block.
1249
:return: The entry index, True if the entry for the key is present.
1251
len_block = len(block)
1253
if self._last_entry_index is not None:
1255
entry_index = self._last_entry_index + 1
1256
# A hit is when the key is after the last slot, and before or
1257
# equal to the next slot.
1258
if ((entry_index > 0 and block[entry_index - 1][0] < key) and
1259
key <= block[entry_index][0]):
1260
self._last_entry_index = entry_index
1261
present = (block[entry_index][0] == key)
1262
return entry_index, present
1265
entry_index = bisect.bisect_left(block, (key, []))
1266
present = (entry_index < len_block and
1267
block[entry_index][0] == key)
1268
self._last_entry_index = entry_index
1269
return entry_index, present
1272
def from_tree(tree, dir_state_filename, sha1_provider=None):
1273
"""Create a dirstate from a bzr Tree.
1275
:param tree: The tree which should provide parent information and
1277
:param sha1_provider: an object meeting the SHA1Provider interface.
1278
If None, a DefaultSHA1Provider is used.
1279
:return: a DirState object which is currently locked for writing.
1280
(it was locked by DirState.initialize)
1282
result = DirState.initialize(dir_state_filename,
1283
sha1_provider=sha1_provider)
1287
parent_ids = tree.get_parent_ids()
1288
num_parents = len(parent_ids)
1290
for parent_id in parent_ids:
1291
parent_tree = tree.branch.repository.revision_tree(parent_id)
1292
parent_trees.append((parent_id, parent_tree))
1293
parent_tree.lock_read()
1294
result.set_parent_trees(parent_trees, [])
1295
result.set_state_from_inventory(tree.inventory)
1297
for revid, parent_tree in parent_trees:
1298
parent_tree.unlock()
1301
# The caller won't have a chance to unlock this, so make sure we
1307
def _check_delta_is_valid(self, delta):
1308
return list(inventory._check_delta_unique_ids(
1309
inventory._check_delta_unique_old_paths(
1310
inventory._check_delta_unique_new_paths(
1311
inventory._check_delta_ids_match_entry(
1312
inventory._check_delta_ids_are_valid(
1313
inventory._check_delta_new_path_entry_both_or_None(delta)))))))
1315
def update_by_delta(self, delta):
1316
"""Apply an inventory delta to the dirstate for tree 0
1318
This is the workhorse for apply_inventory_delta in dirstate based
1321
:param delta: An inventory delta. See Inventory.apply_delta for
1324
self._read_dirblocks_if_needed()
1325
encode = cache_utf8.encode
1328
# Accumulate parent references (path_utf8, id), to check for parentless
1329
# items or items placed under files/links/tree-references. We get
1330
# references from every item in the delta that is not a deletion and
1331
# is not itself the root.
1333
# Added ids must not be in the dirstate already. This set holds those
1336
# This loop transforms the delta to single atomic operations that can
1337
# be executed and validated.
1338
delta = sorted(self._check_delta_is_valid(delta), reverse=True)
1339
for old_path, new_path, file_id, inv_entry in delta:
1340
if (file_id in insertions) or (file_id in removals):
1341
self._raise_invalid(old_path or new_path, file_id,
1343
if old_path is not None:
1344
old_path = old_path.encode('utf-8')
1345
removals[file_id] = old_path
1347
new_ids.add(file_id)
1348
if new_path is not None:
1349
if inv_entry is None:
1350
self._raise_invalid(new_path, file_id,
1351
"new_path with no entry")
1352
new_path = new_path.encode('utf-8')
1353
dirname_utf8, basename = osutils.split(new_path)
1355
parents.add((dirname_utf8, inv_entry.parent_id))
1356
key = (dirname_utf8, basename, file_id)
1357
minikind = DirState._kind_to_minikind[inv_entry.kind]
1359
fingerprint = inv_entry.reference_revision or ''
1362
insertions[file_id] = (key, minikind, inv_entry.executable,
1363
fingerprint, new_path)
1364
# Transform moves into delete+add pairs
1365
if None not in (old_path, new_path):
1366
for child in self._iter_child_entries(0, old_path):
1367
if child[0][2] in insertions or child[0][2] in removals:
1369
child_dirname = child[0][0]
1370
child_basename = child[0][1]
1371
minikind = child[1][0][0]
1372
fingerprint = child[1][0][4]
1373
executable = child[1][0][3]
1374
old_child_path = osutils.pathjoin(child_dirname,
1376
removals[child[0][2]] = old_child_path
1377
child_suffix = child_dirname[len(old_path):]
1378
new_child_dirname = (new_path + child_suffix)
1379
key = (new_child_dirname, child_basename, child[0][2])
1380
new_child_path = osutils.pathjoin(new_child_dirname,
1382
insertions[child[0][2]] = (key, minikind, executable,
1383
fingerprint, new_child_path)
1384
self._check_delta_ids_absent(new_ids, delta, 0)
1386
self._apply_removals(removals.iteritems())
1387
self._apply_insertions(insertions.values())
1389
self._after_delta_check_parents(parents, 0)
1390
except errors.BzrError, e:
1391
self._changes_aborted = True
1392
if 'integrity error' not in str(e):
1394
# _get_entry raises BzrError when a request is inconsistent; we
1395
# want such errors to be shown as InconsistentDelta - and that
1396
# fits the behaviour we trigger.
1397
raise errors.InconsistentDeltaDelta(delta,
1398
"error from _get_entry. %s" % (e,))
1400
def _apply_removals(self, removals):
1401
for file_id, path in sorted(removals, reverse=True,
1402
key=operator.itemgetter(1)):
1403
dirname, basename = osutils.split(path)
1404
block_i, entry_i, d_present, f_present = \
1405
self._get_block_entry_index(dirname, basename, 0)
1407
entry = self._dirblocks[block_i][1][entry_i]
1409
self._raise_invalid(path, file_id,
1410
"Wrong path for old path.")
1411
if not f_present or entry[1][0][0] in 'ar':
1412
self._raise_invalid(path, file_id,
1413
"Wrong path for old path.")
1414
if file_id != entry[0][2]:
1415
self._raise_invalid(path, file_id,
1416
"Attempt to remove path has wrong id - found %r."
1418
self._make_absent(entry)
1419
# See if we have a malformed delta: deleting a directory must not
1420
# leave crud behind. This increases the number of bisects needed
1421
# substantially, but deletion or renames of large numbers of paths
1422
# is rare enough it shouldn't be an issue (famous last words?) RBC
1424
block_i, entry_i, d_present, f_present = \
1425
self._get_block_entry_index(path, '', 0)
1427
# The dir block is still present in the dirstate; this could
1428
# be due to it being in a parent tree, or a corrupt delta.
1429
for child_entry in self._dirblocks[block_i][1]:
1430
if child_entry[1][0][0] not in ('r', 'a'):
1431
self._raise_invalid(path, entry[0][2],
1432
"The file id was deleted but its children were "
1435
def _apply_insertions(self, adds):
1437
for key, minikind, executable, fingerprint, path_utf8 in sorted(adds):
1438
self.update_minimal(key, minikind, executable, fingerprint,
1439
path_utf8=path_utf8)
1440
except errors.NotVersionedError:
1441
self._raise_invalid(path_utf8.decode('utf8'), key[2],
1444
def update_basis_by_delta(self, delta, new_revid):
1445
"""Update the parents of this tree after a commit.
1447
This gives the tree one parent, with revision id new_revid. The
1448
inventory delta is applied to the current basis tree to generate the
1449
inventory for the parent new_revid, and all other parent trees are
1452
Note that an exception during the operation of this method will leave
1453
the dirstate in a corrupt state where it should not be saved.
1455
:param new_revid: The new revision id for the trees parent.
1456
:param delta: An inventory delta (see apply_inventory_delta) describing
1457
the changes from the current left most parent revision to new_revid.
1459
self._read_dirblocks_if_needed()
1460
self._discard_merge_parents()
1461
if self._ghosts != []:
1462
raise NotImplementedError(self.update_basis_by_delta)
1463
if len(self._parents) == 0:
1464
# setup a blank tree, the most simple way.
1465
empty_parent = DirState.NULL_PARENT_DETAILS
1466
for entry in self._iter_entries():
1467
entry[1].append(empty_parent)
1468
self._parents.append(new_revid)
1470
self._parents[0] = new_revid
1472
delta = sorted(self._check_delta_is_valid(delta), reverse=True)
1476
# The paths this function accepts are unicode and must be encoded as we
1478
encode = cache_utf8.encode
1479
inv_to_entry = self._inv_entry_to_details
1480
# delta is now (deletes, changes), (adds) in reverse lexographical
1482
# deletes in reverse lexographic order are safe to process in situ.
1483
# renames are not, as a rename from any path could go to a path
1484
# lexographically lower, so we transform renames into delete, add pairs,
1485
# expanding them recursively as needed.
1486
# At the same time, to reduce interface friction we convert the input
1487
# inventory entries to dirstate.
1488
root_only = ('', '')
1489
# Accumulate parent references (path_utf8, id), to check for parentless
1490
# items or items placed under files/links/tree-references. We get
1491
# references from every item in the delta that is not a deletion and
1492
# is not itself the root.
1494
# Added ids must not be in the dirstate already. This set holds those
1497
for old_path, new_path, file_id, inv_entry in delta:
1498
if inv_entry is not None and file_id != inv_entry.file_id:
1499
self._raise_invalid(new_path, file_id,
1500
"mismatched entry file_id %r" % inv_entry)
1501
if new_path is None:
1502
new_path_utf8 = None
1504
if inv_entry is None:
1505
self._raise_invalid(new_path, file_id,
1506
"new_path with no entry")
1507
new_path_utf8 = encode(new_path)
1508
# note the parent for validation
1509
dirname_utf8, basename_utf8 = osutils.split(new_path_utf8)
1511
parents.add((dirname_utf8, inv_entry.parent_id))
1512
if old_path is None:
1513
old_path_utf8 = None
1515
old_path_utf8 = encode(old_path)
1516
if old_path is None:
1517
adds.append((None, new_path_utf8, file_id,
1518
inv_to_entry(inv_entry), True))
1519
new_ids.add(file_id)
1520
elif new_path is None:
1521
deletes.append((old_path_utf8, None, file_id, None, True))
1522
elif (old_path, new_path) == root_only:
1523
# change things in-place
1524
# Note: the case of a parent directory changing its file_id
1525
# tends to break optimizations here, because officially
1526
# the file has actually been moved, it just happens to
1527
# end up at the same path. If we can figure out how to
1528
# handle that case, we can avoid a lot of add+delete
1529
# pairs for objects that stay put.
1530
# elif old_path == new_path:
1531
changes.append((old_path_utf8, new_path_utf8, file_id,
1532
inv_to_entry(inv_entry)))
1535
# Because renames must preserve their children we must have
1536
# processed all relocations and removes before hand. The sort
1537
# order ensures we've examined the child paths, but we also
1538
# have to execute the removals, or the split to an add/delete
1539
# pair will result in the deleted item being reinserted, or
1540
# renamed items being reinserted twice - and possibly at the
1541
# wrong place. Splitting into a delete/add pair also simplifies
1542
# the handling of entries with ('f', ...), ('r' ...) because
1543
# the target of the 'r' is old_path here, and we add that to
1544
# deletes, meaning that the add handler does not need to check
1545
# for 'r' items on every pass.
1546
self._update_basis_apply_deletes(deletes)
1548
# Split into an add/delete pair recursively.
1549
adds.append((old_path_utf8, new_path_utf8, file_id,
1550
inv_to_entry(inv_entry), False))
1551
# Expunge deletes that we've seen so that deleted/renamed
1552
# children of a rename directory are handled correctly.
1553
new_deletes = reversed(list(
1554
self._iter_child_entries(1, old_path_utf8)))
1555
# Remove the current contents of the tree at orig_path, and
1556
# reinsert at the correct new path.
1557
for entry in new_deletes:
1558
child_dirname, child_basename, child_file_id = entry[0]
1560
source_path = child_dirname + '/' + child_basename
1562
source_path = child_basename
1564
target_path = new_path_utf8 + source_path[len(old_path):]
1567
raise AssertionError("cannot rename directory to"
1569
target_path = source_path[len(old_path) + 1:]
1570
adds.append((None, target_path, entry[0][2], entry[1][1], False))
1572
(source_path, target_path, entry[0][2], None, False))
1573
deletes.append((old_path_utf8, new_path, file_id, None, False))
1574
self._check_delta_ids_absent(new_ids, delta, 1)
1576
# Finish expunging deletes/first half of renames.
1577
self._update_basis_apply_deletes(deletes)
1578
# Reinstate second half of renames and new paths.
1579
self._update_basis_apply_adds(adds)
1580
# Apply in-situ changes.
1581
self._update_basis_apply_changes(changes)
1583
self._after_delta_check_parents(parents, 1)
1584
except errors.BzrError, e:
1585
self._changes_aborted = True
1586
if 'integrity error' not in str(e):
1588
# _get_entry raises BzrError when a request is inconsistent; we
1589
# want such errors to be shown as InconsistentDelta - and that
1590
# fits the behaviour we trigger.
1591
raise errors.InconsistentDeltaDelta(delta,
1592
"error from _get_entry. %s" % (e,))
1594
self._mark_modified(header_modified=True)
1595
self._id_index = None
1598
def _check_delta_ids_absent(self, new_ids, delta, tree_index):
1599
"""Check that none of the file_ids in new_ids are present in a tree."""
1602
id_index = self._get_id_index()
1603
for file_id in new_ids:
1604
for key in id_index.get(file_id, ()):
1605
block_i, entry_i, d_present, f_present = \
1606
self._get_block_entry_index(key[0], key[1], tree_index)
1608
# In a different tree
1610
entry = self._dirblocks[block_i][1][entry_i]
1611
if entry[0][2] != file_id:
1612
# Different file_id, so not what we want.
1614
self._raise_invalid(("%s/%s" % key[0:2]).decode('utf8'), file_id,
1615
"This file_id is new in the delta but already present in "
1618
def _raise_invalid(self, path, file_id, reason):
1619
self._changes_aborted = True
1620
raise errors.InconsistentDelta(path, file_id, reason)
1622
def _update_basis_apply_adds(self, adds):
1623
"""Apply a sequence of adds to tree 1 during update_basis_by_delta.
1625
They may be adds, or renames that have been split into add/delete
1628
:param adds: A sequence of adds. Each add is a tuple:
1629
(None, new_path_utf8, file_id, (entry_details), real_add). real_add
1630
is False when the add is the second half of a remove-and-reinsert
1631
pair created to handle renames and deletes.
1633
# Adds are accumulated partly from renames, so can be in any input
1635
# TODO: we may want to sort in dirblocks order. That way each entry
1636
# will end up in the same directory, allowing the _get_entry
1637
# fast-path for looking up 2 items in the same dir work.
1638
adds.sort(key=lambda x: x[1])
1639
# adds is now in lexographic order, which places all parents before
1640
# their children, so we can process it linearly.
1642
st = static_tuple.StaticTuple
1643
for old_path, new_path, file_id, new_details, real_add in adds:
1644
dirname, basename = osutils.split(new_path)
1645
entry_key = st(dirname, basename, file_id)
1646
block_index, present = self._find_block_index_from_key(entry_key)
1648
self._raise_invalid(new_path, file_id,
1649
"Unable to find block for this record."
1650
" Was the parent added?")
1651
block = self._dirblocks[block_index][1]
1652
entry_index, present = self._find_entry_index(entry_key, block)
1654
if old_path is not None:
1655
self._raise_invalid(new_path, file_id,
1656
'considered a real add but still had old_path at %s'
1659
entry = block[entry_index]
1660
basis_kind = entry[1][1][0]
1661
if basis_kind == 'a':
1662
entry[1][1] = new_details
1663
elif basis_kind == 'r':
1664
raise NotImplementedError()
1666
self._raise_invalid(new_path, file_id,
1667
"An entry was marked as a new add"
1668
" but the basis target already existed")
1670
# The exact key was not found in the block. However, we need to
1671
# check if there is a key next to us that would have matched.
1672
# We only need to check 2 locations, because there are only 2
1674
for maybe_index in range(entry_index-1, entry_index+1):
1675
if maybe_index < 0 or maybe_index >= len(block):
1677
maybe_entry = block[maybe_index]
1678
if maybe_entry[0][:2] != (dirname, basename):
1679
# Just a random neighbor
1681
if maybe_entry[0][2] == file_id:
1682
raise AssertionError(
1683
'_find_entry_index didnt find a key match'
1684
' but walking the data did, for %s'
1686
basis_kind = maybe_entry[1][1][0]
1687
if basis_kind not in 'ar':
1688
self._raise_invalid(new_path, file_id,
1689
"we have an add record for path, but the path"
1690
" is already present with another file_id %s"
1691
% (maybe_entry[0][2],))
1693
entry = (entry_key, [DirState.NULL_PARENT_DETAILS,
1695
block.insert(entry_index, entry)
1697
active_kind = entry[1][0][0]
1698
if active_kind == 'a':
1699
# The active record shows up as absent, this could be genuine,
1700
# or it could be present at some other location. We need to
1702
id_index = self._get_id_index()
1703
# The id_index may not be perfectly accurate for tree1, because
1704
# we haven't been keeping it updated. However, it should be
1705
# fine for tree0, and that gives us enough info for what we
1707
keys = id_index.get(file_id, ())
1709
block_i, entry_i, d_present, f_present = \
1710
self._get_block_entry_index(key[0], key[1], 0)
1713
active_entry = self._dirblocks[block_i][1][entry_i]
1714
if (active_entry[0][2] != file_id):
1715
# Some other file is at this path, we don't need to
1718
real_active_kind = active_entry[1][0][0]
1719
if real_active_kind in 'ar':
1720
# We found a record, which was not *this* record,
1721
# which matches the file_id, but is not actually
1722
# present. Something seems *really* wrong.
1723
self._raise_invalid(new_path, file_id,
1724
"We found a tree0 entry that doesnt make sense")
1725
# Now, we've found a tree0 entry which matches the file_id
1726
# but is at a different location. So update them to be
1728
active_dir, active_name = active_entry[0][:2]
1730
active_path = active_dir + '/' + active_name
1732
active_path = active_name
1733
active_entry[1][1] = st('r', new_path, 0, False, '')
1734
entry[1][0] = st('r', active_path, 0, False, '')
1735
elif active_kind == 'r':
1736
raise NotImplementedError()
1738
new_kind = new_details[0]
1740
self._ensure_block(block_index, entry_index, new_path)
1742
def _update_basis_apply_changes(self, changes):
1743
"""Apply a sequence of changes to tree 1 during update_basis_by_delta.
1745
:param adds: A sequence of changes. Each change is a tuple:
1746
(path_utf8, path_utf8, file_id, (entry_details))
1749
for old_path, new_path, file_id, new_details in changes:
1750
# the entry for this file_id must be in tree 0.
1751
entry = self._get_entry(1, file_id, new_path)
1752
if entry[0] is None or entry[1][1][0] in 'ar':
1753
self._raise_invalid(new_path, file_id,
1754
'changed entry considered not present')
1755
entry[1][1] = new_details
1757
def _update_basis_apply_deletes(self, deletes):
1758
"""Apply a sequence of deletes to tree 1 during update_basis_by_delta.
1760
They may be deletes, or renames that have been split into add/delete
1763
:param deletes: A sequence of deletes. Each delete is a tuple:
1764
(old_path_utf8, new_path_utf8, file_id, None, real_delete).
1765
real_delete is True when the desired outcome is an actual deletion
1766
rather than the rename handling logic temporarily deleting a path
1767
during the replacement of a parent.
1769
null = DirState.NULL_PARENT_DETAILS
1770
for old_path, new_path, file_id, _, real_delete in deletes:
1771
if real_delete != (new_path is None):
1772
self._raise_invalid(old_path, file_id, "bad delete delta")
1773
# the entry for this file_id must be in tree 1.
1774
dirname, basename = osutils.split(old_path)
1775
block_index, entry_index, dir_present, file_present = \
1776
self._get_block_entry_index(dirname, basename, 1)
1777
if not file_present:
1778
self._raise_invalid(old_path, file_id,
1779
'basis tree does not contain removed entry')
1780
entry = self._dirblocks[block_index][1][entry_index]
1781
# The state of the entry in the 'active' WT
1782
active_kind = entry[1][0][0]
1783
if entry[0][2] != file_id:
1784
self._raise_invalid(old_path, file_id,
1785
'mismatched file_id in tree 1')
1787
old_kind = entry[1][1][0]
1788
if active_kind in 'ar':
1789
# The active tree doesn't have this file_id.
1790
# The basis tree is changing this record. If this is a
1791
# rename, then we don't want the record here at all
1792
# anymore. If it is just an in-place change, we want the
1793
# record here, but we'll add it if we need to. So we just
1795
if active_kind == 'r':
1796
active_path = entry[1][0][1]
1797
active_entry = self._get_entry(0, file_id, active_path)
1798
if active_entry[1][1][0] != 'r':
1799
self._raise_invalid(old_path, file_id,
1800
"Dirstate did not have matching rename entries")
1801
elif active_entry[1][0][0] in 'ar':
1802
self._raise_invalid(old_path, file_id,
1803
"Dirstate had a rename pointing at an inactive"
1805
active_entry[1][1] = null
1806
del self._dirblocks[block_index][1][entry_index]
1808
# This was a directory, and the active tree says it
1809
# doesn't exist, and now the basis tree says it doesn't
1810
# exist. Remove its dirblock if present
1812
present) = self._find_block_index_from_key(
1815
dir_block = self._dirblocks[dir_block_index][1]
1817
# This entry is empty, go ahead and just remove it
1818
del self._dirblocks[dir_block_index]
1820
# There is still an active record, so just mark this
1823
block_i, entry_i, d_present, f_present = \
1824
self._get_block_entry_index(old_path, '', 1)
1826
dir_block = self._dirblocks[block_i][1]
1827
for child_entry in dir_block:
1828
child_basis_kind = child_entry[1][1][0]
1829
if child_basis_kind not in 'ar':
1830
self._raise_invalid(old_path, file_id,
1831
"The file id was deleted but its children were "
1834
def _after_delta_check_parents(self, parents, index):
1835
"""Check that parents required by the delta are all intact.
1837
:param parents: An iterable of (path_utf8, file_id) tuples which are
1838
required to be present in tree 'index' at path_utf8 with id file_id
1840
:param index: The column in the dirstate to check for parents in.
1842
for dirname_utf8, file_id in parents:
1843
# Get the entry - the ensures that file_id, dirname_utf8 exists and
1844
# has the right file id.
1845
entry = self._get_entry(index, file_id, dirname_utf8)
1846
if entry[1] is None:
1847
self._raise_invalid(dirname_utf8.decode('utf8'),
1848
file_id, "This parent is not present.")
1849
# Parents of things must be directories
1850
if entry[1][index][0] != 'd':
1851
self._raise_invalid(dirname_utf8.decode('utf8'),
1852
file_id, "This parent is not a directory.")
1854
def _observed_sha1(self, entry, sha1, stat_value,
1855
_stat_to_minikind=_stat_to_minikind):
1856
"""Note the sha1 of a file.
1858
:param entry: The entry the sha1 is for.
1859
:param sha1: The observed sha1.
1860
:param stat_value: The os.lstat for the file.
1863
minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
1868
if self._cutoff_time is None:
1869
self._sha_cutoff_time()
1870
if (stat_value.st_mtime < self._cutoff_time
1871
and stat_value.st_ctime < self._cutoff_time):
1872
entry[1][0] = ('f', sha1, stat_value.st_size, entry[1][0][3],
1873
pack_stat(stat_value))
1874
self._mark_modified([entry])
1876
def _sha_cutoff_time(self):
1877
"""Return cutoff time.
1879
Files modified more recently than this time are at risk of being
1880
undetectably modified and so can't be cached.
1882
# Cache the cutoff time as long as we hold a lock.
1883
# time.time() isn't super expensive (approx 3.38us), but
1884
# when you call it 50,000 times it adds up.
1885
# For comparison, os.lstat() costs 7.2us if it is hot.
1886
self._cutoff_time = int(time.time()) - 3
1887
return self._cutoff_time
1889
def _lstat(self, abspath, entry):
1890
"""Return the os.lstat value for this path."""
1891
return os.lstat(abspath)
1893
def _sha1_file_and_mutter(self, abspath):
1894
# when -Dhashcache is turned on, this is monkey-patched in to log
1896
trace.mutter("dirstate sha1 " + abspath)
1897
return self._sha1_provider.sha1(abspath)
1899
def _is_executable(self, mode, old_executable):
1900
"""Is this file executable?"""
1901
return bool(S_IEXEC & mode)
1903
def _is_executable_win32(self, mode, old_executable):
1904
"""On win32 the executable bit is stored in the dirstate."""
1905
return old_executable
1907
if sys.platform == 'win32':
1908
_is_executable = _is_executable_win32
1910
def _read_link(self, abspath, old_link):
1911
"""Read the target of a symlink"""
1912
# TODO: jam 200700301 On Win32, this could just return the value
1913
# already in memory. However, this really needs to be done at a
1914
# higher level, because there either won't be anything on disk,
1915
# or the thing on disk will be a file.
1916
fs_encoding = osutils._fs_enc
1917
if isinstance(abspath, unicode):
1918
# abspath is defined as the path to pass to lstat. readlink is
1919
# buggy in python < 2.6 (it doesn't encode unicode path into FS
1920
# encoding), so we need to encode ourselves knowing that unicode
1921
# paths are produced by UnicodeDirReader on purpose.
1922
abspath = abspath.encode(fs_encoding)
1923
target = os.readlink(abspath)
1924
if fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1925
# Change encoding if needed
1926
target = target.decode(fs_encoding).encode('UTF-8')
1929
def get_ghosts(self):
1930
"""Return a list of the parent tree revision ids that are ghosts."""
1931
self._read_header_if_needed()
1934
def get_lines(self):
1935
"""Serialise the entire dirstate to a sequence of lines."""
1936
if (self._header_state == DirState.IN_MEMORY_UNMODIFIED and
1937
self._dirblock_state == DirState.IN_MEMORY_UNMODIFIED):
1938
# read what's on disk.
1939
self._state_file.seek(0)
1940
return self._state_file.readlines()
1942
lines.append(self._get_parents_line(self.get_parent_ids()))
1943
lines.append(self._get_ghosts_line(self._ghosts))
1944
lines.extend(self._get_entry_lines())
1945
return self._get_output_lines(lines)
1947
def _get_ghosts_line(self, ghost_ids):
1948
"""Create a line for the state file for ghost information."""
1949
return '\0'.join([str(len(ghost_ids))] + ghost_ids)
1951
def _get_parents_line(self, parent_ids):
1952
"""Create a line for the state file for parents information."""
1953
return '\0'.join([str(len(parent_ids))] + parent_ids)
1955
def _get_entry_lines(self):
1956
"""Create lines for entries."""
1957
return map(self._entry_to_line, self._iter_entries())
1959
def _get_fields_to_entry(self):
1960
"""Get a function which converts entry fields into a entry record.
1962
This handles size and executable, as well as parent records.
1964
:return: A function which takes a list of fields, and returns an
1965
appropriate record for storing in memory.
1967
# This is intentionally unrolled for performance
1968
num_present_parents = self._num_present_parents()
1969
if num_present_parents == 0:
1970
def fields_to_entry_0_parents(fields, _int=int):
1971
path_name_file_id_key = (fields[0], fields[1], fields[2])
1972
return (path_name_file_id_key, [
1974
fields[3], # minikind
1975
fields[4], # fingerprint
1976
_int(fields[5]), # size
1977
fields[6] == 'y', # executable
1978
fields[7], # packed_stat or revision_id
1980
return fields_to_entry_0_parents
1981
elif num_present_parents == 1:
1982
def fields_to_entry_1_parent(fields, _int=int):
1983
path_name_file_id_key = (fields[0], fields[1], fields[2])
1984
return (path_name_file_id_key, [
1986
fields[3], # minikind
1987
fields[4], # fingerprint
1988
_int(fields[5]), # size
1989
fields[6] == 'y', # executable
1990
fields[7], # packed_stat or revision_id
1993
fields[8], # minikind
1994
fields[9], # fingerprint
1995
_int(fields[10]), # size
1996
fields[11] == 'y', # executable
1997
fields[12], # packed_stat or revision_id
2000
return fields_to_entry_1_parent
2001
elif num_present_parents == 2:
2002
def fields_to_entry_2_parents(fields, _int=int):
2003
path_name_file_id_key = (fields[0], fields[1], fields[2])
2004
return (path_name_file_id_key, [
2006
fields[3], # minikind
2007
fields[4], # fingerprint
2008
_int(fields[5]), # size
2009
fields[6] == 'y', # executable
2010
fields[7], # packed_stat or revision_id
2013
fields[8], # minikind
2014
fields[9], # fingerprint
2015
_int(fields[10]), # size
2016
fields[11] == 'y', # executable
2017
fields[12], # packed_stat or revision_id
2020
fields[13], # minikind
2021
fields[14], # fingerprint
2022
_int(fields[15]), # size
2023
fields[16] == 'y', # executable
2024
fields[17], # packed_stat or revision_id
2027
return fields_to_entry_2_parents
2029
def fields_to_entry_n_parents(fields, _int=int):
2030
path_name_file_id_key = (fields[0], fields[1], fields[2])
2031
trees = [(fields[cur], # minikind
2032
fields[cur+1], # fingerprint
2033
_int(fields[cur+2]), # size
2034
fields[cur+3] == 'y', # executable
2035
fields[cur+4], # stat or revision_id
2036
) for cur in xrange(3, len(fields)-1, 5)]
2037
return path_name_file_id_key, trees
2038
return fields_to_entry_n_parents
2040
def get_parent_ids(self):
2041
"""Return a list of the parent tree ids for the directory state."""
2042
self._read_header_if_needed()
2043
return list(self._parents)
2045
def _get_block_entry_index(self, dirname, basename, tree_index):
2046
"""Get the coordinates for a path in the state structure.
2048
:param dirname: The utf8 dirname to lookup.
2049
:param basename: The utf8 basename to lookup.
2050
:param tree_index: The index of the tree for which this lookup should
2052
:return: A tuple describing where the path is located, or should be
2053
inserted. The tuple contains four fields: the block index, the row
2054
index, the directory is present (boolean), the entire path is
2055
present (boolean). There is no guarantee that either
2056
coordinate is currently reachable unless the found field for it is
2057
True. For instance, a directory not present in the searched tree
2058
may be returned with a value one greater than the current highest
2059
block offset. The directory present field will always be True when
2060
the path present field is True. The directory present field does
2061
NOT indicate that the directory is present in the searched tree,
2062
rather it indicates that there are at least some files in some
2065
self._read_dirblocks_if_needed()
2066
key = dirname, basename, ''
2067
block_index, present = self._find_block_index_from_key(key)
2069
# no such directory - return the dir index and 0 for the row.
2070
return block_index, 0, False, False
2071
block = self._dirblocks[block_index][1] # access the entries only
2072
entry_index, present = self._find_entry_index(key, block)
2073
# linear search through entries at this path to find the one
2075
while entry_index < len(block) and block[entry_index][0][1] == basename:
2076
if block[entry_index][1][tree_index][0] not in 'ar':
2077
# neither absent or relocated
2078
return block_index, entry_index, True, True
2080
return block_index, entry_index, True, False
2082
def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None,
2083
include_deleted=False):
2084
"""Get the dirstate entry for path in tree tree_index.
2086
If either file_id or path is supplied, it is used as the key to lookup.
2087
If both are supplied, the fastest lookup is used, and an error is
2088
raised if they do not both point at the same row.
2090
:param tree_index: The index of the tree we wish to locate this path
2091
in. If the path is present in that tree, the entry containing its
2092
details is returned, otherwise (None, None) is returned
2093
0 is the working tree, higher indexes are successive parent
2095
:param fileid_utf8: A utf8 file_id to look up.
2096
:param path_utf8: An utf8 path to be looked up.
2097
:param include_deleted: If True, and performing a lookup via
2098
fileid_utf8 rather than path_utf8, return an entry for deleted
2100
:return: The dirstate entry tuple for path, or (None, None)
2102
self._read_dirblocks_if_needed()
2103
if path_utf8 is not None:
2104
if type(path_utf8) is not str:
2105
raise errors.BzrError('path_utf8 is not a str: %s %r'
2106
% (type(path_utf8), path_utf8))
2107
# path lookups are faster
2108
dirname, basename = osutils.split(path_utf8)
2109
block_index, entry_index, dir_present, file_present = \
2110
self._get_block_entry_index(dirname, basename, tree_index)
2111
if not file_present:
2113
entry = self._dirblocks[block_index][1][entry_index]
2114
if not (entry[0][2] and entry[1][tree_index][0] not in ('a', 'r')):
2115
raise AssertionError('unversioned entry?')
2117
if entry[0][2] != fileid_utf8:
2118
self._changes_aborted = True
2119
raise errors.BzrError('integrity error ? : mismatching'
2120
' tree_index, file_id and path')
2123
possible_keys = self._get_id_index().get(fileid_utf8, ())
2124
if not possible_keys:
2126
for key in possible_keys:
2127
block_index, present = \
2128
self._find_block_index_from_key(key)
2129
# strange, probably indicates an out of date
2130
# id index - for now, allow this.
2133
# WARNING: DO not change this code to use _get_block_entry_index
2134
# as that function is not suitable: it does not use the key
2135
# to lookup, and thus the wrong coordinates are returned.
2136
block = self._dirblocks[block_index][1]
2137
entry_index, present = self._find_entry_index(key, block)
2139
entry = self._dirblocks[block_index][1][entry_index]
2140
# TODO: We might want to assert that entry[0][2] ==
2142
if entry[1][tree_index][0] in 'fdlt':
2143
# this is the result we are looking for: the
2144
# real home of this file_id in this tree.
2146
if entry[1][tree_index][0] == 'a':
2147
# there is no home for this entry in this tree
2151
if entry[1][tree_index][0] != 'r':
2152
raise AssertionError(
2153
"entry %r has invalid minikind %r for tree %r" \
2155
entry[1][tree_index][0],
2157
real_path = entry[1][tree_index][1]
2158
return self._get_entry(tree_index, fileid_utf8=fileid_utf8,
2159
path_utf8=real_path)
2163
def initialize(cls, path, sha1_provider=None):
2164
"""Create a new dirstate on path.
2166
The new dirstate will be an empty tree - that is it has no parents,
2167
and only a root node - which has id ROOT_ID.
2169
:param path: The name of the file for the dirstate.
2170
:param sha1_provider: an object meeting the SHA1Provider interface.
2171
If None, a DefaultSHA1Provider is used.
2172
:return: A write-locked DirState object.
2174
# This constructs a new DirState object on a path, sets the _state_file
2175
# to a new empty file for that path. It then calls _set_data() with our
2176
# stock empty dirstate information - a root with ROOT_ID, no children,
2177
# and no parents. Finally it calls save() to ensure that this data will
2179
if sha1_provider is None:
2180
sha1_provider = DefaultSHA1Provider()
2181
result = cls(path, sha1_provider)
2182
# root dir and root dir contents with no children.
2183
empty_tree_dirblocks = [('', []), ('', [])]
2184
# a new root directory, with a NULLSTAT.
2185
empty_tree_dirblocks[0][1].append(
2186
(('', '', inventory.ROOT_ID), [
2187
('d', '', 0, False, DirState.NULLSTAT),
2191
result._set_data([], empty_tree_dirblocks)
2199
def _inv_entry_to_details(inv_entry):
2200
"""Convert an inventory entry (from a revision tree) to state details.
2202
:param inv_entry: An inventory entry whose sha1 and link targets can be
2203
relied upon, and which has a revision set.
2204
:return: A details tuple - the details for a single tree at a path +
2207
kind = inv_entry.kind
2208
minikind = DirState._kind_to_minikind[kind]
2209
tree_data = inv_entry.revision
2210
if kind == 'directory':
2214
elif kind == 'symlink':
2215
if inv_entry.symlink_target is None:
2218
fingerprint = inv_entry.symlink_target.encode('utf8')
2221
elif kind == 'file':
2222
fingerprint = inv_entry.text_sha1 or ''
2223
size = inv_entry.text_size or 0
2224
executable = inv_entry.executable
2225
elif kind == 'tree-reference':
2226
fingerprint = inv_entry.reference_revision or ''
2230
raise Exception("can't pack %s" % inv_entry)
2231
return static_tuple.StaticTuple(minikind, fingerprint, size,
2232
executable, tree_data)
2234
def _iter_child_entries(self, tree_index, path_utf8):
2235
"""Iterate over all the entries that are children of path_utf.
2237
This only returns entries that are present (not in 'a', 'r') in
2238
tree_index. tree_index data is not refreshed, so if tree 0 is used,
2239
results may differ from that obtained if paths were statted to
2240
determine what ones were directories.
2242
Asking for the children of a non-directory will return an empty
2246
next_pending_dirs = [path_utf8]
2248
while next_pending_dirs:
2249
pending_dirs = next_pending_dirs
2250
next_pending_dirs = []
2251
for path in pending_dirs:
2252
block_index, present = self._find_block_index_from_key(
2254
if block_index == 0:
2256
if len(self._dirblocks) == 1:
2257
# asked for the children of the root with no other
2261
# children of a non-directory asked for.
2263
block = self._dirblocks[block_index]
2264
for entry in block[1]:
2265
kind = entry[1][tree_index][0]
2266
if kind not in absent:
2270
path = entry[0][0] + '/' + entry[0][1]
2273
next_pending_dirs.append(path)
2275
def _iter_entries(self):
2276
"""Iterate over all the entries in the dirstate.
2278
Each yelt item is an entry in the standard format described in the
2279
docstring of bzrlib.dirstate.
2281
self._read_dirblocks_if_needed()
2282
for directory in self._dirblocks:
2283
for entry in directory[1]:
2286
def _get_id_index(self):
2287
"""Get an id index of self._dirblocks.
2289
This maps from file_id => [(directory, name, file_id)] entries where
2290
that file_id appears in one of the trees.
2292
if self._id_index is None:
2294
for key, tree_details in self._iter_entries():
2295
self._add_to_id_index(id_index, key)
2296
self._id_index = id_index
2297
return self._id_index
2299
def _add_to_id_index(self, id_index, entry_key):
2300
"""Add this entry to the _id_index mapping."""
2301
# This code used to use a set for every entry in the id_index. However,
2302
# it is *rare* to have more than one entry. So a set is a large
2303
# overkill. And even when we do, we won't ever have more than the
2304
# number of parent trees. Which is still a small number (rarely >2). As
2305
# such, we use a simple tuple, and do our own uniqueness checks. While
2306
# the 'in' check is O(N) since N is nicely bounded it shouldn't ever
2307
# cause quadratic failure.
2308
file_id = entry_key[2]
2309
entry_key = static_tuple.StaticTuple.from_sequence(entry_key)
2310
if file_id not in id_index:
2311
id_index[file_id] = static_tuple.StaticTuple(entry_key,)
2313
entry_keys = id_index[file_id]
2314
if entry_key not in entry_keys:
2315
id_index[file_id] = entry_keys + (entry_key,)
2317
def _remove_from_id_index(self, id_index, entry_key):
2318
"""Remove this entry from the _id_index mapping.
2320
It is an programming error to call this when the entry_key is not
2323
file_id = entry_key[2]
2324
entry_keys = list(id_index[file_id])
2325
entry_keys.remove(entry_key)
2326
id_index[file_id] = static_tuple.StaticTuple.from_sequence(entry_keys)
2328
def _get_output_lines(self, lines):
2329
"""Format lines for final output.
2331
:param lines: A sequence of lines containing the parents list and the
2334
output_lines = [DirState.HEADER_FORMAT_3]
2335
lines.append('') # a final newline
2336
inventory_text = '\0\n\0'.join(lines)
2337
output_lines.append('crc32: %s\n' % (zlib.crc32(inventory_text),))
2338
# -3, 1 for num parents, 1 for ghosts, 1 for final newline
2339
num_entries = len(lines)-3
2340
output_lines.append('num_entries: %s\n' % (num_entries,))
2341
output_lines.append(inventory_text)
2344
def _make_deleted_row(self, fileid_utf8, parents):
2345
"""Return a deleted row for fileid_utf8."""
2346
return ('/', 'RECYCLED.BIN', 'file', fileid_utf8, 0, DirState.NULLSTAT,
2349
def _num_present_parents(self):
2350
"""The number of parent entries in each record row."""
2351
return len(self._parents) - len(self._ghosts)
2354
def on_file(cls, path, sha1_provider=None, worth_saving_limit=0):
2355
"""Construct a DirState on the file at path "path".
2357
:param path: The path at which the dirstate file on disk should live.
2358
:param sha1_provider: an object meeting the SHA1Provider interface.
2359
If None, a DefaultSHA1Provider is used.
2360
:param worth_saving_limit: when the exact number of hash changed
2361
entries is known, only bother saving the dirstate if more than
2362
this count of entries have changed. -1 means never save.
2363
:return: An unlocked DirState object, associated with the given path.
2365
if sha1_provider is None:
2366
sha1_provider = DefaultSHA1Provider()
2367
result = cls(path, sha1_provider,
2368
worth_saving_limit=worth_saving_limit)
2371
def _read_dirblocks_if_needed(self):
2372
"""Read in all the dirblocks from the file if they are not in memory.
2374
This populates self._dirblocks, and sets self._dirblock_state to
2375
IN_MEMORY_UNMODIFIED. It is not currently ready for incremental block
2378
self._read_header_if_needed()
2379
if self._dirblock_state == DirState.NOT_IN_MEMORY:
2380
_read_dirblocks(self)
2382
def _read_header(self):
2383
"""This reads in the metadata header, and the parent ids.
2385
After reading in, the file should be positioned at the null
2386
just before the start of the first record in the file.
2388
:return: (expected crc checksum, number of entries, parent list)
2390
self._read_prelude()
2391
parent_line = self._state_file.readline()
2392
info = parent_line.split('\0')
2393
num_parents = int(info[0])
2394
self._parents = info[1:-1]
2395
ghost_line = self._state_file.readline()
2396
info = ghost_line.split('\0')
2397
num_ghosts = int(info[1])
2398
self._ghosts = info[2:-1]
2399
self._header_state = DirState.IN_MEMORY_UNMODIFIED
2400
self._end_of_header = self._state_file.tell()
2402
def _read_header_if_needed(self):
2403
"""Read the header of the dirstate file if needed."""
2404
# inline this as it will be called a lot
2405
if not self._lock_token:
2406
raise errors.ObjectNotLocked(self)
2407
if self._header_state == DirState.NOT_IN_MEMORY:
2410
def _read_prelude(self):
2411
"""Read in the prelude header of the dirstate file.
2413
This only reads in the stuff that is not connected to the crc
2414
checksum. The position will be correct to read in the rest of
2415
the file and check the checksum after this point.
2416
The next entry in the file should be the number of parents,
2417
and their ids. Followed by a newline.
2419
header = self._state_file.readline()
2420
if header != DirState.HEADER_FORMAT_3:
2421
raise errors.BzrError(
2422
'invalid header line: %r' % (header,))
2423
crc_line = self._state_file.readline()
2424
if not crc_line.startswith('crc32: '):
2425
raise errors.BzrError('missing crc32 checksum: %r' % crc_line)
2426
self.crc_expected = int(crc_line[len('crc32: '):-1])
2427
num_entries_line = self._state_file.readline()
2428
if not num_entries_line.startswith('num_entries: '):
2429
raise errors.BzrError('missing num_entries line')
2430
self._num_entries = int(num_entries_line[len('num_entries: '):-1])
2432
def sha1_from_stat(self, path, stat_result):
2433
"""Find a sha1 given a stat lookup."""
2434
return self._get_packed_stat_index().get(pack_stat(stat_result), None)
2436
def _get_packed_stat_index(self):
2437
"""Get a packed_stat index of self._dirblocks."""
2438
if self._packed_stat_index is None:
2440
for key, tree_details in self._iter_entries():
2441
if tree_details[0][0] == 'f':
2442
index[tree_details[0][4]] = tree_details[0][1]
2443
self._packed_stat_index = index
2444
return self._packed_stat_index
2447
"""Save any pending changes created during this session.
2449
We reuse the existing file, because that prevents race conditions with
2450
file creation, and use oslocks on it to prevent concurrent modification
2451
and reads - because dirstate's incremental data aggregation is not
2452
compatible with reading a modified file, and replacing a file in use by
2453
another process is impossible on Windows.
2455
A dirstate in read only mode should be smart enough though to validate
2456
that the file has not changed, and otherwise discard its cache and
2457
start over, to allow for fine grained read lock duration, so 'status'
2458
wont block 'commit' - for example.
2460
if self._changes_aborted:
2461
# Should this be a warning? For now, I'm expecting that places that
2462
# mark it inconsistent will warn, making a warning here redundant.
2463
trace.mutter('Not saving DirState because '
2464
'_changes_aborted is set.')
2466
# TODO: Since we now distinguish IN_MEMORY_MODIFIED from
2467
# IN_MEMORY_HASH_MODIFIED, we should only fail quietly if we fail
2468
# to save an IN_MEMORY_HASH_MODIFIED, and fail *noisily* if we
2469
# fail to save IN_MEMORY_MODIFIED
2470
if not self._worth_saving():
2473
grabbed_write_lock = False
2474
if self._lock_state != 'w':
2475
grabbed_write_lock, new_lock = self._lock_token.temporary_write_lock()
2476
# Switch over to the new lock, as the old one may be closed.
2477
# TODO: jam 20070315 We should validate the disk file has
2478
# not changed contents, since temporary_write_lock may
2479
# not be an atomic operation.
2480
self._lock_token = new_lock
2481
self._state_file = new_lock.f
2482
if not grabbed_write_lock:
2483
# We couldn't grab a write lock, so we switch back to a read one
2486
lines = self.get_lines()
2487
self._state_file.seek(0)
2488
self._state_file.writelines(lines)
2489
self._state_file.truncate()
2490
self._state_file.flush()
2491
self._maybe_fdatasync()
2492
self._mark_unmodified()
2494
if grabbed_write_lock:
2495
self._lock_token = self._lock_token.restore_read_lock()
2496
self._state_file = self._lock_token.f
2497
# TODO: jam 20070315 We should validate the disk file has
2498
# not changed contents. Since restore_read_lock may
2499
# not be an atomic operation.
2501
def _maybe_fdatasync(self):
2502
"""Flush to disk if possible and if not configured off."""
2503
if self._config_stack.get('dirstate.fdatasync'):
2504
osutils.fdatasync(self._state_file.fileno())
2506
def _worth_saving(self):
2507
"""Is it worth saving the dirstate or not?"""
2508
if (self._header_state == DirState.IN_MEMORY_MODIFIED
2509
or self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
2511
if self._dirblock_state == DirState.IN_MEMORY_HASH_MODIFIED:
2512
if self._worth_saving_limit == -1:
2513
# We never save hash changes when the limit is -1
2515
# If we're using smart saving and only a small number of
2516
# entries have changed their hash, don't bother saving. John has
2517
# suggested using a heuristic here based on the size of the
2518
# changed files and/or tree. For now, we go with a configurable
2519
# number of changes, keeping the calculation time
2520
# as low overhead as possible. (This also keeps all existing
2521
# tests passing as the default is 0, i.e. always save.)
2522
if len(self._known_hash_changes) >= self._worth_saving_limit:
2526
def _set_data(self, parent_ids, dirblocks):
2527
"""Set the full dirstate data in memory.
2529
This is an internal function used to completely replace the objects
2530
in memory state. It puts the dirstate into state 'full-dirty'.
2532
:param parent_ids: A list of parent tree revision ids.
2533
:param dirblocks: A list containing one tuple for each directory in the
2534
tree. Each tuple contains the directory path and a list of entries
2535
found in that directory.
2537
# our memory copy is now authoritative.
2538
self._dirblocks = dirblocks
2539
self._mark_modified(header_modified=True)
2540
self._parents = list(parent_ids)
2541
self._id_index = None
2542
self._packed_stat_index = None
2544
def set_path_id(self, path, new_id):
2545
"""Change the id of path to new_id in the current working tree.
2547
:param path: The path inside the tree to set - '' is the root, 'foo'
2548
is the path foo in the root.
2549
:param new_id: The new id to assign to the path. This must be a utf8
2550
file id (not unicode, and not None).
2552
self._read_dirblocks_if_needed()
2554
# TODO: logic not written
2555
raise NotImplementedError(self.set_path_id)
2556
# TODO: check new id is unique
2557
entry = self._get_entry(0, path_utf8=path)
2558
if entry[0][2] == new_id:
2559
# Nothing to change.
2561
# mark the old path absent, and insert a new root path
2562
self._make_absent(entry)
2563
self.update_minimal(('', '', new_id), 'd',
2564
path_utf8='', packed_stat=entry[1][0][4])
2565
self._mark_modified()
2566
# XXX: This was added by Ian, we need to make sure there
2567
# are tests for it, because it isn't in bzr.dev TRUNK
2568
# It looks like the only place it is called is in setting the root
2569
# id of the tree. So probably we never had an _id_index when we
2570
# don't even have a root yet.
2571
if self._id_index is not None:
2572
self._add_to_id_index(self._id_index, entry[0])
2574
def set_parent_trees(self, trees, ghosts):
2575
"""Set the parent trees for the dirstate.
2577
:param trees: A list of revision_id, tree tuples. tree must be provided
2578
even if the revision_id refers to a ghost: supply an empty tree in
2580
:param ghosts: A list of the revision_ids that are ghosts at the time
2583
# TODO: generate a list of parent indexes to preserve to save
2584
# processing specific parent trees. In the common case one tree will
2585
# be preserved - the left most parent.
2586
# TODO: if the parent tree is a dirstate, we might want to walk them
2587
# all by path in parallel for 'optimal' common-case performance.
2588
# generate new root row.
2589
self._read_dirblocks_if_needed()
2590
# TODO future sketch: Examine the existing parents to generate a change
2591
# map and then walk the new parent trees only, mapping them into the
2592
# dirstate. Walk the dirstate at the same time to remove unreferenced
2595
# sketch: loop over all entries in the dirstate, cherry picking
2596
# entries from the parent trees, if they are not ghost trees.
2597
# after we finish walking the dirstate, all entries not in the dirstate
2598
# are deletes, so we want to append them to the end as per the design
2599
# discussions. So do a set difference on ids with the parents to
2600
# get deletes, and add them to the end.
2601
# During the update process we need to answer the following questions:
2602
# - find other keys containing a fileid in order to create cross-path
2603
# links. We dont't trivially use the inventory from other trees
2604
# because this leads to either double touching, or to accessing
2606
# - find other keys containing a path
2607
# We accumulate each entry via this dictionary, including the root
2610
# we could do parallel iterators, but because file id data may be
2611
# scattered throughout, we dont save on index overhead: we have to look
2612
# at everything anyway. We can probably save cycles by reusing parent
2613
# data and doing an incremental update when adding an additional
2614
# parent, but for now the common cases are adding a new parent (merge),
2615
# and replacing completely (commit), and commit is more common: so
2616
# optimise merge later.
2618
# ---- start generation of full tree mapping data
2619
# what trees should we use?
2620
parent_trees = [tree for rev_id, tree in trees if rev_id not in ghosts]
2621
# how many trees do we end up with
2622
parent_count = len(parent_trees)
2623
st = static_tuple.StaticTuple
2625
# one: the current tree
2626
for entry in self._iter_entries():
2627
# skip entries not in the current tree
2628
if entry[1][0][0] in 'ar': # absent, relocated
2630
by_path[entry[0]] = [entry[1][0]] + \
2631
[DirState.NULL_PARENT_DETAILS] * parent_count
2632
# TODO: Possibly inline this, since we know it isn't present yet
2633
# id_index[entry[0][2]] = (entry[0],)
2634
self._add_to_id_index(id_index, entry[0])
2636
# now the parent trees:
2637
for tree_index, tree in enumerate(parent_trees):
2638
# the index is off by one, adjust it.
2639
tree_index = tree_index + 1
2640
# when we add new locations for a fileid we need these ranges for
2641
# any fileid in this tree as we set the by_path[id] to:
2642
# already_processed_tree_details + new_details + new_location_suffix
2643
# the suffix is from tree_index+1:parent_count+1.
2644
new_location_suffix = [DirState.NULL_PARENT_DETAILS] * (parent_count - tree_index)
2645
# now stitch in all the entries from this tree
2647
for path, entry in tree.iter_entries_by_dir():
2648
# here we process each trees details for each item in the tree.
2649
# we first update any existing entries for the id at other paths,
2650
# then we either create or update the entry for the id at the
2651
# right path, and finally we add (if needed) a mapping from
2652
# file_id to this path. We do it in this order to allow us to
2653
# avoid checking all known paths for the id when generating a
2654
# new entry at this path: by adding the id->path mapping last,
2655
# all the mappings are valid and have correct relocation
2656
# records where needed.
2657
file_id = entry.file_id
2658
path_utf8 = path.encode('utf8')
2659
dirname, basename = osutils.split(path_utf8)
2660
if dirname == last_dirname:
2661
# Try to re-use objects as much as possible
2662
dirname = last_dirname
2664
last_dirname = dirname
2665
new_entry_key = st(dirname, basename, file_id)
2666
# tree index consistency: All other paths for this id in this tree
2667
# index must point to the correct path.
2668
entry_keys = id_index.get(file_id, ())
2669
for entry_key in entry_keys:
2670
# TODO:PROFILING: It might be faster to just update
2671
# rather than checking if we need to, and then overwrite
2672
# the one we are located at.
2673
if entry_key != new_entry_key:
2674
# this file id is at a different path in one of the
2675
# other trees, so put absent pointers there
2676
# This is the vertical axis in the matrix, all pointing
2678
by_path[entry_key][tree_index] = st('r', path_utf8, 0,
2680
# by path consistency: Insert into an existing path record
2681
# (trivial), or add a new one with relocation pointers for the
2682
# other tree indexes.
2683
if new_entry_key in entry_keys:
2684
# there is already an entry where this data belongs, just
2686
by_path[new_entry_key][tree_index] = \
2687
self._inv_entry_to_details(entry)
2689
# add relocated entries to the horizontal axis - this row
2690
# mapping from path,id. We need to look up the correct path
2691
# for the indexes from 0 to tree_index -1
2693
for lookup_index in xrange(tree_index):
2694
# boundary case: this is the first occurence of file_id
2695
# so there are no id_indexes, possibly take this out of
2697
if not len(entry_keys):
2698
new_details.append(DirState.NULL_PARENT_DETAILS)
2700
# grab any one entry, use it to find the right path.
2701
a_key = iter(entry_keys).next()
2702
if by_path[a_key][lookup_index][0] in ('r', 'a'):
2703
# its a pointer or missing statement, use it as
2705
new_details.append(by_path[a_key][lookup_index])
2707
# we have the right key, make a pointer to it.
2708
real_path = ('/'.join(a_key[0:2])).strip('/')
2709
new_details.append(st('r', real_path, 0, False,
2711
new_details.append(self._inv_entry_to_details(entry))
2712
new_details.extend(new_location_suffix)
2713
by_path[new_entry_key] = new_details
2714
self._add_to_id_index(id_index, new_entry_key)
2715
# --- end generation of full tree mappings
2717
# sort and output all the entries
2718
new_entries = self._sort_entries(by_path.items())
2719
self._entries_to_current_state(new_entries)
2720
self._parents = [rev_id for rev_id, tree in trees]
2721
self._ghosts = list(ghosts)
2722
self._mark_modified(header_modified=True)
2723
self._id_index = id_index
2725
def _sort_entries(self, entry_list):
2726
"""Given a list of entries, sort them into the right order.
2728
This is done when constructing a new dirstate from trees - normally we
2729
try to keep everything in sorted blocks all the time, but sometimes
2730
it's easier to sort after the fact.
2732
# When sorting, we usually have 10x more entries than directories. (69k
2733
# total entries, 4k directories). So cache the results of splitting.
2734
# Saving time and objects. Also, use StaticTuple to avoid putting all
2735
# of these object into python's garbage collector.
2737
def _key(entry, _split_dirs=split_dirs, _st=static_tuple.StaticTuple):
2738
# sort by: directory parts, file name, file id
2739
dirpath, fname, file_id = entry[0]
2741
split = _split_dirs[dirpath]
2743
split = _st.from_sequence(dirpath.split('/'))
2744
_split_dirs[dirpath] = split
2745
return _st(split, fname, file_id)
2746
return sorted(entry_list, key=_key)
2748
def set_state_from_inventory(self, new_inv):
2749
"""Set new_inv as the current state.
2751
This API is called by tree transform, and will usually occur with
2752
existing parent trees.
2754
:param new_inv: The inventory object to set current state from.
2756
if 'evil' in debug.debug_flags:
2757
trace.mutter_callsite(1,
2758
"set_state_from_inventory called; please mutate the tree instead")
2759
tracing = 'dirstate' in debug.debug_flags
2761
trace.mutter("set_state_from_inventory trace:")
2762
self._read_dirblocks_if_needed()
2764
# Two iterators: current data and new data, both in dirblock order.
2765
# We zip them together, which tells about entries that are new in the
2766
# inventory, or removed in the inventory, or present in both and
2769
# You might think we could just synthesize a new dirstate directly
2770
# since we're processing it in the right order. However, we need to
2771
# also consider there may be any number of parent trees and relocation
2772
# pointers, and we don't want to duplicate that here.
2773
new_iterator = new_inv.iter_entries_by_dir()
2774
# we will be modifying the dirstate, so we need a stable iterator. In
2775
# future we might write one, for now we just clone the state into a
2776
# list using a copy so that we see every original item and don't have
2777
# to adjust the position when items are inserted or deleted in the
2778
# underlying dirstate.
2779
old_iterator = iter(list(self._iter_entries()))
2780
# both must have roots so this is safe:
2781
current_new = new_iterator.next()
2782
current_old = old_iterator.next()
2783
def advance(iterator):
2785
return iterator.next()
2786
except StopIteration:
2788
while current_new or current_old:
2789
# skip entries in old that are not really there
2790
if current_old and current_old[1][0][0] in 'ar':
2791
# relocated or absent
2792
current_old = advance(old_iterator)
2795
# convert new into dirblock style
2796
new_path_utf8 = current_new[0].encode('utf8')
2797
new_dirname, new_basename = osutils.split(new_path_utf8)
2798
new_id = current_new[1].file_id
2799
new_entry_key = (new_dirname, new_basename, new_id)
2800
current_new_minikind = \
2801
DirState._kind_to_minikind[current_new[1].kind]
2802
if current_new_minikind == 't':
2803
fingerprint = current_new[1].reference_revision or ''
2805
# We normally only insert or remove records, or update
2806
# them when it has significantly changed. Then we want to
2807
# erase its fingerprint. Unaffected records should
2808
# normally not be updated at all.
2811
# for safety disable variables
2812
new_path_utf8 = new_dirname = new_basename = new_id = \
2813
new_entry_key = None
2814
# 5 cases, we dont have a value that is strictly greater than everything, so
2815
# we make both end conditions explicit
2817
# old is finished: insert current_new into the state.
2819
trace.mutter("Appending from new '%s'.",
2820
new_path_utf8.decode('utf8'))
2821
self.update_minimal(new_entry_key, current_new_minikind,
2822
executable=current_new[1].executable,
2823
path_utf8=new_path_utf8, fingerprint=fingerprint,
2825
current_new = advance(new_iterator)
2826
elif not current_new:
2829
trace.mutter("Truncating from old '%s/%s'.",
2830
current_old[0][0].decode('utf8'),
2831
current_old[0][1].decode('utf8'))
2832
self._make_absent(current_old)
2833
current_old = advance(old_iterator)
2834
elif new_entry_key == current_old[0]:
2835
# same - common case
2836
# We're looking at the same path and id in both the dirstate
2837
# and inventory, so just need to update the fields in the
2838
# dirstate from the one in the inventory.
2839
# TODO: update the record if anything significant has changed.
2840
# the minimal required trigger is if the execute bit or cached
2842
if (current_old[1][0][3] != current_new[1].executable or
2843
current_old[1][0][0] != current_new_minikind):
2845
trace.mutter("Updating in-place change '%s'.",
2846
new_path_utf8.decode('utf8'))
2847
self.update_minimal(current_old[0], current_new_minikind,
2848
executable=current_new[1].executable,
2849
path_utf8=new_path_utf8, fingerprint=fingerprint,
2851
# both sides are dealt with, move on
2852
current_old = advance(old_iterator)
2853
current_new = advance(new_iterator)
2854
elif (cmp_by_dirs(new_dirname, current_old[0][0]) < 0
2855
or (new_dirname == current_old[0][0]
2856
and new_entry_key[1:] < current_old[0][1:])):
2858
# add a entry for this and advance new
2860
trace.mutter("Inserting from new '%s'.",
2861
new_path_utf8.decode('utf8'))
2862
self.update_minimal(new_entry_key, current_new_minikind,
2863
executable=current_new[1].executable,
2864
path_utf8=new_path_utf8, fingerprint=fingerprint,
2866
current_new = advance(new_iterator)
2868
# we've advanced past the place where the old key would be,
2869
# without seeing it in the new list. so it must be gone.
2871
trace.mutter("Deleting from old '%s/%s'.",
2872
current_old[0][0].decode('utf8'),
2873
current_old[0][1].decode('utf8'))
2874
self._make_absent(current_old)
2875
current_old = advance(old_iterator)
2876
self._mark_modified()
2877
self._id_index = None
2878
self._packed_stat_index = None
2880
trace.mutter("set_state_from_inventory complete.")
2882
def set_state_from_scratch(self, working_inv, parent_trees, parent_ghosts):
2883
"""Wipe the currently stored state and set it to something new.
2885
This is a hard-reset for the data we are working with.
2887
# Technically, we really want a write lock, but until we write, we
2888
# don't really need it.
2889
self._requires_lock()
2890
# root dir and root dir contents with no children. We have to have a
2891
# root for set_state_from_inventory to work correctly.
2892
empty_root = (('', '', inventory.ROOT_ID),
2893
[('d', '', 0, False, DirState.NULLSTAT)])
2894
empty_tree_dirblocks = [('', [empty_root]), ('', [])]
2895
self._set_data([], empty_tree_dirblocks)
2896
self.set_state_from_inventory(working_inv)
2897
self.set_parent_trees(parent_trees, parent_ghosts)
2899
def _make_absent(self, current_old):
2900
"""Mark current_old - an entry - as absent for tree 0.
2902
:return: True if this was the last details entry for the entry key:
2903
that is, if the underlying block has had the entry removed, thus
2904
shrinking in length.
2906
# build up paths that this id will be left at after the change is made,
2907
# so we can update their cross references in tree 0
2908
all_remaining_keys = set()
2909
# Dont check the working tree, because it's going.
2910
for details in current_old[1][1:]:
2911
if details[0] not in 'ar': # absent, relocated
2912
all_remaining_keys.add(current_old[0])
2913
elif details[0] == 'r': # relocated
2914
# record the key for the real path.
2915
all_remaining_keys.add(tuple(osutils.split(details[1])) + (current_old[0][2],))
2916
# absent rows are not present at any path.
2917
last_reference = current_old[0] not in all_remaining_keys
2919
# the current row consists entire of the current item (being marked
2920
# absent), and relocated or absent entries for the other trees:
2921
# Remove it, its meaningless.
2922
block = self._find_block(current_old[0])
2923
entry_index, present = self._find_entry_index(current_old[0], block[1])
2925
raise AssertionError('could not find entry for %s' % (current_old,))
2926
block[1].pop(entry_index)
2927
# if we have an id_index in use, remove this key from it for this id.
2928
if self._id_index is not None:
2929
self._remove_from_id_index(self._id_index, current_old[0])
2930
# update all remaining keys for this id to record it as absent. The
2931
# existing details may either be the record we are marking as deleted
2932
# (if there were other trees with the id present at this path), or may
2934
for update_key in all_remaining_keys:
2935
update_block_index, present = \
2936
self._find_block_index_from_key(update_key)
2938
raise AssertionError('could not find block for %s' % (update_key,))
2939
update_entry_index, present = \
2940
self._find_entry_index(update_key, self._dirblocks[update_block_index][1])
2942
raise AssertionError('could not find entry for %s' % (update_key,))
2943
update_tree_details = self._dirblocks[update_block_index][1][update_entry_index][1]
2944
# it must not be absent at the moment
2945
if update_tree_details[0][0] == 'a': # absent
2946
raise AssertionError('bad row %r' % (update_tree_details,))
2947
update_tree_details[0] = DirState.NULL_PARENT_DETAILS
2948
self._mark_modified()
2949
return last_reference
2951
def update_minimal(self, key, minikind, executable=False, fingerprint='',
2952
packed_stat=None, size=0, path_utf8=None, fullscan=False):
2953
"""Update an entry to the state in tree 0.
2955
This will either create a new entry at 'key' or update an existing one.
2956
It also makes sure that any other records which might mention this are
2959
:param key: (dir, name, file_id) for the new entry
2960
:param minikind: The type for the entry ('f' == 'file', 'd' ==
2962
:param executable: Should the executable bit be set?
2963
:param fingerprint: Simple fingerprint for new entry: canonical-form
2964
sha1 for files, referenced revision id for subtrees, etc.
2965
:param packed_stat: Packed stat value for new entry.
2966
:param size: Size information for new entry
2967
:param path_utf8: key[0] + '/' + key[1], just passed in to avoid doing
2969
:param fullscan: If True then a complete scan of the dirstate is being
2970
done and checking for duplicate rows should not be done. This
2971
should only be set by set_state_from_inventory and similar methods.
2973
If packed_stat and fingerprint are not given, they're invalidated in
2976
block = self._find_block(key)[1]
2977
if packed_stat is None:
2978
packed_stat = DirState.NULLSTAT
2979
# XXX: Some callers pass '' as the packed_stat, and it seems to be
2980
# sometimes present in the dirstate - this seems oddly inconsistent.
2982
entry_index, present = self._find_entry_index(key, block)
2983
new_details = (minikind, fingerprint, size, executable, packed_stat)
2984
id_index = self._get_id_index()
2986
# New record. Check there isn't a entry at this path already.
2988
low_index, _ = self._find_entry_index(key[0:2] + ('',), block)
2989
while low_index < len(block):
2990
entry = block[low_index]
2991
if entry[0][0:2] == key[0:2]:
2992
if entry[1][0][0] not in 'ar':
2993
# This entry has the same path (but a different id) as
2994
# the new entry we're adding, and is present in ths
2996
self._raise_invalid(
2997
("%s/%s" % key[0:2]).decode('utf8'), key[2],
2998
"Attempt to add item at path already occupied by "
2999
"id %r" % entry[0][2])
3003
# new entry, synthesis cross reference here,
3004
existing_keys = id_index.get(key[2], ())
3005
if not existing_keys:
3006
# not currently in the state, simplest case
3007
new_entry = key, [new_details] + self._empty_parent_info()
3009
# present at one or more existing other paths.
3010
# grab one of them and use it to generate parent
3011
# relocation/absent entries.
3012
new_entry = key, [new_details]
3013
# existing_keys can be changed as we iterate.
3014
for other_key in tuple(existing_keys):
3015
# change the record at other to be a pointer to this new
3016
# record. The loop looks similar to the change to
3017
# relocations when updating an existing record but its not:
3018
# the test for existing kinds is different: this can be
3019
# factored out to a helper though.
3020
other_block_index, present = self._find_block_index_from_key(
3023
raise AssertionError('could not find block for %s' % (
3025
other_block = self._dirblocks[other_block_index][1]
3026
other_entry_index, present = self._find_entry_index(
3027
other_key, other_block)
3029
raise AssertionError(
3030
'update_minimal: could not find other entry for %s'
3032
if path_utf8 is None:
3033
raise AssertionError('no path')
3034
# Turn this other location into a reference to the new
3035
# location. This also updates the aliased iterator
3036
# (current_old in set_state_from_inventory) so that the old
3037
# entry, if not already examined, is skipped over by that
3039
other_entry = other_block[other_entry_index]
3040
other_entry[1][0] = ('r', path_utf8, 0, False, '')
3041
if self._maybe_remove_row(other_block, other_entry_index,
3043
# If the row holding this was removed, we need to
3044
# recompute where this entry goes
3045
entry_index, _ = self._find_entry_index(key, block)
3048
# adds a tuple to the new details for each column
3049
# - either by copying an existing relocation pointer inside that column
3050
# - or by creating a new pointer to the right row inside that column
3051
num_present_parents = self._num_present_parents()
3052
if num_present_parents:
3053
# TODO: This re-evaluates the existing_keys set, do we need
3054
# to do that ourselves?
3055
other_key = list(existing_keys)[0]
3056
for lookup_index in xrange(1, num_present_parents + 1):
3057
# grab any one entry, use it to find the right path.
3058
# TODO: optimise this to reduce memory use in highly
3059
# fragmented situations by reusing the relocation
3061
update_block_index, present = \
3062
self._find_block_index_from_key(other_key)
3064
raise AssertionError('could not find block for %s' % (other_key,))
3065
update_entry_index, present = \
3066
self._find_entry_index(other_key, self._dirblocks[update_block_index][1])
3068
raise AssertionError('update_minimal: could not find entry for %s' % (other_key,))
3069
update_details = self._dirblocks[update_block_index][1][update_entry_index][1][lookup_index]
3070
if update_details[0] in 'ar': # relocated, absent
3071
# its a pointer or absent in lookup_index's tree, use
3073
new_entry[1].append(update_details)
3075
# we have the right key, make a pointer to it.
3076
pointer_path = osutils.pathjoin(*other_key[0:2])
3077
new_entry[1].append(('r', pointer_path, 0, False, ''))
3078
block.insert(entry_index, new_entry)
3079
self._add_to_id_index(id_index, key)
3081
# Does the new state matter?
3082
block[entry_index][1][0] = new_details
3083
# parents cannot be affected by what we do.
3084
# other occurences of this id can be found
3085
# from the id index.
3087
# tree index consistency: All other paths for this id in this tree
3088
# index must point to the correct path. We have to loop here because
3089
# we may have passed entries in the state with this file id already
3090
# that were absent - where parent entries are - and they need to be
3091
# converted to relocated.
3092
if path_utf8 is None:
3093
raise AssertionError('no path')
3094
existing_keys = id_index.get(key[2], ())
3095
if key not in existing_keys:
3096
raise AssertionError('We found the entry in the blocks, but'
3097
' the key is not in the id_index.'
3098
' key: %s, existing_keys: %s' % (key, existing_keys))
3099
for entry_key in existing_keys:
3100
# TODO:PROFILING: It might be faster to just update
3101
# rather than checking if we need to, and then overwrite
3102
# the one we are located at.
3103
if entry_key != key:
3104
# this file id is at a different path in one of the
3105
# other trees, so put absent pointers there
3106
# This is the vertical axis in the matrix, all pointing
3108
block_index, present = self._find_block_index_from_key(entry_key)
3110
raise AssertionError('not present: %r', entry_key)
3111
entry_index, present = self._find_entry_index(entry_key, self._dirblocks[block_index][1])
3113
raise AssertionError('not present: %r', entry_key)
3114
self._dirblocks[block_index][1][entry_index][1][0] = \
3115
('r', path_utf8, 0, False, '')
3116
# add a containing dirblock if needed.
3117
if new_details[0] == 'd':
3118
subdir_key = (osutils.pathjoin(*key[0:2]), '', '')
3119
block_index, present = self._find_block_index_from_key(subdir_key)
3121
self._dirblocks.insert(block_index, (subdir_key[0], []))
3123
self._mark_modified()
3125
def _maybe_remove_row(self, block, index, id_index):
3126
"""Remove index if it is absent or relocated across the row.
3128
id_index is updated accordingly.
3129
:return: True if we removed the row, False otherwise
3131
present_in_row = False
3132
entry = block[index]
3133
for column in entry[1]:
3134
if column[0] not in 'ar':
3135
present_in_row = True
3137
if not present_in_row:
3139
self._remove_from_id_index(id_index, entry[0])
3143
def _validate(self):
3144
"""Check that invariants on the dirblock are correct.
3146
This can be useful in debugging; it shouldn't be necessary in
3149
This must be called with a lock held.
3151
# NOTE: This must always raise AssertionError not just assert,
3152
# otherwise it may not behave properly under python -O
3154
# TODO: All entries must have some content that's not 'a' or 'r',
3155
# otherwise it could just be removed.
3157
# TODO: All relocations must point directly to a real entry.
3159
# TODO: No repeated keys.
3162
from pprint import pformat
3163
self._read_dirblocks_if_needed()
3164
if len(self._dirblocks) > 0:
3165
if not self._dirblocks[0][0] == '':
3166
raise AssertionError(
3167
"dirblocks don't start with root block:\n" + \
3168
pformat(self._dirblocks))
3169
if len(self._dirblocks) > 1:
3170
if not self._dirblocks[1][0] == '':
3171
raise AssertionError(
3172
"dirblocks missing root directory:\n" + \
3173
pformat(self._dirblocks))
3174
# the dirblocks are sorted by their path components, name, and dir id
3175
dir_names = [d[0].split('/')
3176
for d in self._dirblocks[1:]]
3177
if dir_names != sorted(dir_names):
3178
raise AssertionError(
3179
"dir names are not in sorted order:\n" + \
3180
pformat(self._dirblocks) + \
3183
for dirblock in self._dirblocks:
3184
# within each dirblock, the entries are sorted by filename and
3186
for entry in dirblock[1]:
3187
if dirblock[0] != entry[0][0]:
3188
raise AssertionError(
3190
"doesn't match directory name in\n%r" %
3191
(entry, pformat(dirblock)))
3192
if dirblock[1] != sorted(dirblock[1]):
3193
raise AssertionError(
3194
"dirblock for %r is not sorted:\n%s" % \
3195
(dirblock[0], pformat(dirblock)))
3197
def check_valid_parent():
3198
"""Check that the current entry has a valid parent.
3200
This makes sure that the parent has a record,
3201
and that the parent isn't marked as "absent" in the
3202
current tree. (It is invalid to have a non-absent file in an absent
3205
if entry[0][0:2] == ('', ''):
3206
# There should be no parent for the root row
3208
parent_entry = self._get_entry(tree_index, path_utf8=entry[0][0])
3209
if parent_entry == (None, None):
3210
raise AssertionError(
3211
"no parent entry for: %s in tree %s"
3212
% (this_path, tree_index))
3213
if parent_entry[1][tree_index][0] != 'd':
3214
raise AssertionError(
3215
"Parent entry for %s is not marked as a valid"
3216
" directory. %s" % (this_path, parent_entry,))
3218
# For each file id, for each tree: either
3219
# the file id is not present at all; all rows with that id in the
3220
# key have it marked as 'absent'
3221
# OR the file id is present under exactly one name; any other entries
3222
# that mention that id point to the correct name.
3224
# We check this with a dict per tree pointing either to the present
3225
# name, or None if absent.
3226
tree_count = self._num_present_parents() + 1
3227
id_path_maps = [dict() for i in range(tree_count)]
3228
# Make sure that all renamed entries point to the correct location.
3229
for entry in self._iter_entries():
3230
file_id = entry[0][2]
3231
this_path = osutils.pathjoin(entry[0][0], entry[0][1])
3232
if len(entry[1]) != tree_count:
3233
raise AssertionError(
3234
"wrong number of entry details for row\n%s" \
3235
",\nexpected %d" % \
3236
(pformat(entry), tree_count))
3237
absent_positions = 0
3238
for tree_index, tree_state in enumerate(entry[1]):
3239
this_tree_map = id_path_maps[tree_index]
3240
minikind = tree_state[0]
3241
if minikind in 'ar':
3242
absent_positions += 1
3243
# have we seen this id before in this column?
3244
if file_id in this_tree_map:
3245
previous_path, previous_loc = this_tree_map[file_id]
3246
# any later mention of this file must be consistent with
3247
# what was said before
3249
if previous_path is not None:
3250
raise AssertionError(
3251
"file %s is absent in row %r but also present " \
3253
(file_id, entry, previous_path))
3254
elif minikind == 'r':
3255
target_location = tree_state[1]
3256
if previous_path != target_location:
3257
raise AssertionError(
3258
"file %s relocation in row %r but also at %r" \
3259
% (file_id, entry, previous_path))
3261
# a file, directory, etc - may have been previously
3262
# pointed to by a relocation, which must point here
3263
if previous_path != this_path:
3264
raise AssertionError(
3265
"entry %r inconsistent with previous path %r "
3267
(entry, previous_path, previous_loc))
3268
check_valid_parent()
3271
# absent; should not occur anywhere else
3272
this_tree_map[file_id] = None, this_path
3273
elif minikind == 'r':
3274
# relocation, must occur at expected location
3275
this_tree_map[file_id] = tree_state[1], this_path
3277
this_tree_map[file_id] = this_path, this_path
3278
check_valid_parent()
3279
if absent_positions == tree_count:
3280
raise AssertionError(
3281
"entry %r has no data for any tree." % (entry,))
3282
if self._id_index is not None:
3283
for file_id, entry_keys in self._id_index.iteritems():
3284
for entry_key in entry_keys:
3285
if entry_key[2] != file_id:
3286
raise AssertionError(
3287
'file_id %r did not match entry key %s'
3288
% (file_id, entry_key))
3289
if len(entry_keys) != len(set(entry_keys)):
3290
raise AssertionError(
3291
'id_index contained non-unique data for %s'
3294
def _wipe_state(self):
3295
"""Forget all state information about the dirstate."""
3296
self._header_state = DirState.NOT_IN_MEMORY
3297
self._dirblock_state = DirState.NOT_IN_MEMORY
3298
self._changes_aborted = False
3301
self._dirblocks = []
3302
self._id_index = None
3303
self._packed_stat_index = None
3304
self._end_of_header = None
3305
self._cutoff_time = None
3306
self._split_path_cache = {}
3308
def lock_read(self):
3309
"""Acquire a read lock on the dirstate."""
3310
if self._lock_token is not None:
3311
raise errors.LockContention(self._lock_token)
3312
# TODO: jam 20070301 Rather than wiping completely, if the blocks are
3313
# already in memory, we could read just the header and check for
3314
# any modification. If not modified, we can just leave things
3316
self._lock_token = lock.ReadLock(self._filename)
3317
self._lock_state = 'r'
3318
self._state_file = self._lock_token.f
3321
def lock_write(self):
3322
"""Acquire a write lock on the dirstate."""
3323
if self._lock_token is not None:
3324
raise errors.LockContention(self._lock_token)
3325
# TODO: jam 20070301 Rather than wiping completely, if the blocks are
3326
# already in memory, we could read just the header and check for
3327
# any modification. If not modified, we can just leave things
3329
self._lock_token = lock.WriteLock(self._filename)
3330
self._lock_state = 'w'
3331
self._state_file = self._lock_token.f
3335
"""Drop any locks held on the dirstate."""
3336
if self._lock_token is None:
3337
raise errors.LockNotHeld(self)
3338
# TODO: jam 20070301 Rather than wiping completely, if the blocks are
3339
# already in memory, we could read just the header and check for
3340
# any modification. If not modified, we can just leave things
3342
self._state_file = None
3343
self._lock_state = None
3344
self._lock_token.unlock()
3345
self._lock_token = None
3346
self._split_path_cache = {}
3348
def _requires_lock(self):
3349
"""Check that a lock is currently held by someone on the dirstate."""
3350
if not self._lock_token:
3351
raise errors.ObjectNotLocked(self)
3354
def py_update_entry(state, entry, abspath, stat_value,
3355
_stat_to_minikind=DirState._stat_to_minikind):
3356
"""Update the entry based on what is actually on disk.
3358
This function only calculates the sha if it needs to - if the entry is
3359
uncachable, or clearly different to the first parent's entry, no sha
3360
is calculated, and None is returned.
3362
:param state: The dirstate this entry is in.
3363
:param entry: This is the dirblock entry for the file in question.
3364
:param abspath: The path on disk for this file.
3365
:param stat_value: The stat value done on the path.
3366
:return: None, or The sha1 hexdigest of the file (40 bytes) or link
3367
target of a symlink.
3370
minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
3374
packed_stat = pack_stat(stat_value)
3375
(saved_minikind, saved_link_or_sha1, saved_file_size,
3376
saved_executable, saved_packed_stat) = entry[1][0]
3378
if minikind == 'd' and saved_minikind == 't':
3380
if (minikind == saved_minikind
3381
and packed_stat == saved_packed_stat):
3382
# The stat hasn't changed since we saved, so we can re-use the
3387
# size should also be in packed_stat
3388
if saved_file_size == stat_value.st_size:
3389
return saved_link_or_sha1
3391
# If we have gotten this far, that means that we need to actually
3392
# process this entry.
3396
executable = state._is_executable(stat_value.st_mode,
3398
if state._cutoff_time is None:
3399
state._sha_cutoff_time()
3400
if (stat_value.st_mtime < state._cutoff_time
3401
and stat_value.st_ctime < state._cutoff_time
3402
and len(entry[1]) > 1
3403
and entry[1][1][0] != 'a'):
3404
# Could check for size changes for further optimised
3405
# avoidance of sha1's. However the most prominent case of
3406
# over-shaing is during initial add, which this catches.
3407
# Besides, if content filtering happens, size and sha
3408
# are calculated at the same time, so checking just the size
3409
# gains nothing w.r.t. performance.
3410
link_or_sha1 = state._sha1_file(abspath)
3411
entry[1][0] = ('f', link_or_sha1, stat_value.st_size,
3412
executable, packed_stat)
3414
entry[1][0] = ('f', '', stat_value.st_size,
3415
executable, DirState.NULLSTAT)
3416
worth_saving = False
3417
elif minikind == 'd':
3419
entry[1][0] = ('d', '', 0, False, packed_stat)
3420
if saved_minikind != 'd':
3421
# This changed from something into a directory. Make sure we
3422
# have a directory block for it. This doesn't happen very
3423
# often, so this doesn't have to be super fast.
3424
block_index, entry_index, dir_present, file_present = \
3425
state._get_block_entry_index(entry[0][0], entry[0][1], 0)
3426
state._ensure_block(block_index, entry_index,
3427
osutils.pathjoin(entry[0][0], entry[0][1]))
3429
worth_saving = False
3430
elif minikind == 'l':
3431
if saved_minikind == 'l':
3432
worth_saving = False
3433
link_or_sha1 = state._read_link(abspath, saved_link_or_sha1)
3434
if state._cutoff_time is None:
3435
state._sha_cutoff_time()
3436
if (stat_value.st_mtime < state._cutoff_time
3437
and stat_value.st_ctime < state._cutoff_time):
3438
entry[1][0] = ('l', link_or_sha1, stat_value.st_size,
3441
entry[1][0] = ('l', '', stat_value.st_size,
3442
False, DirState.NULLSTAT)
3444
state._mark_modified([entry])
3448
class ProcessEntryPython(object):
3450
__slots__ = ["old_dirname_to_file_id", "new_dirname_to_file_id",
3451
"last_source_parent", "last_target_parent", "include_unchanged",
3452
"partial", "use_filesystem_for_exec", "utf8_decode",
3453
"searched_specific_files", "search_specific_files",
3454
"searched_exact_paths", "search_specific_file_parents", "seen_ids",
3455
"state", "source_index", "target_index", "want_unversioned", "tree"]
3457
def __init__(self, include_unchanged, use_filesystem_for_exec,
3458
search_specific_files, state, source_index, target_index,
3459
want_unversioned, tree):
3460
self.old_dirname_to_file_id = {}
3461
self.new_dirname_to_file_id = {}
3462
# Are we doing a partial iter_changes?
3463
self.partial = search_specific_files != set([''])
3464
# Using a list so that we can access the values and change them in
3465
# nested scope. Each one is [path, file_id, entry]
3466
self.last_source_parent = [None, None]
3467
self.last_target_parent = [None, None]
3468
self.include_unchanged = include_unchanged
3469
self.use_filesystem_for_exec = use_filesystem_for_exec
3470
self.utf8_decode = cache_utf8._utf8_decode
3471
# for all search_indexs in each path at or under each element of
3472
# search_specific_files, if the detail is relocated: add the id, and
3473
# add the relocated path as one to search if its not searched already.
3474
# If the detail is not relocated, add the id.
3475
self.searched_specific_files = set()
3476
# When we search exact paths without expanding downwards, we record
3478
self.searched_exact_paths = set()
3479
self.search_specific_files = search_specific_files
3480
# The parents up to the root of the paths we are searching.
3481
# After all normal paths are returned, these specific items are returned.
3482
self.search_specific_file_parents = set()
3483
# The ids we've sent out in the delta.
3484
self.seen_ids = set()
3486
self.source_index = source_index
3487
self.target_index = target_index
3488
if target_index != 0:
3489
# A lot of code in here depends on target_index == 0
3490
raise errors.BzrError('unsupported target index')
3491
self.want_unversioned = want_unversioned
3494
def _process_entry(self, entry, path_info, pathjoin=osutils.pathjoin):
3495
"""Compare an entry and real disk to generate delta information.
3497
:param path_info: top_relpath, basename, kind, lstat, abspath for
3498
the path of entry. If None, then the path is considered absent in
3499
the target (Perhaps we should pass in a concrete entry for this ?)
3500
Basename is returned as a utf8 string because we expect this
3501
tuple will be ignored, and don't want to take the time to
3503
:return: (iter_changes_result, changed). If the entry has not been
3504
handled then changed is None. Otherwise it is False if no content
3505
or metadata changes have occurred, and True if any content or
3506
metadata change has occurred. If self.include_unchanged is True then
3507
if changed is not None, iter_changes_result will always be a result
3508
tuple. Otherwise, iter_changes_result is None unless changed is
3511
if self.source_index is None:
3512
source_details = DirState.NULL_PARENT_DETAILS
3514
source_details = entry[1][self.source_index]
3515
target_details = entry[1][self.target_index]
3516
target_minikind = target_details[0]
3517
if path_info is not None and target_minikind in 'fdlt':
3518
if not (self.target_index == 0):
3519
raise AssertionError()
3520
link_or_sha1 = update_entry(self.state, entry,
3521
abspath=path_info[4], stat_value=path_info[3])
3522
# The entry may have been modified by update_entry
3523
target_details = entry[1][self.target_index]
3524
target_minikind = target_details[0]
3527
file_id = entry[0][2]
3528
source_minikind = source_details[0]
3529
if source_minikind in 'fdltr' and target_minikind in 'fdlt':
3530
# claimed content in both: diff
3531
# r | fdlt | | add source to search, add id path move and perform
3532
# | | | diff check on source-target
3533
# r | fdlt | a | dangling file that was present in the basis.
3535
if source_minikind in 'r':
3536
# add the source to the search path to find any children it
3537
# has. TODO ? : only add if it is a container ?
3538
if not osutils.is_inside_any(self.searched_specific_files,
3540
self.search_specific_files.add(source_details[1])
3541
# generate the old path; this is needed for stating later
3543
old_path = source_details[1]
3544
old_dirname, old_basename = os.path.split(old_path)
3545
path = pathjoin(entry[0][0], entry[0][1])
3546
old_entry = self.state._get_entry(self.source_index,
3548
# update the source details variable to be the real
3550
if old_entry == (None, None):
3551
raise errors.CorruptDirstate(self.state._filename,
3552
"entry '%s/%s' is considered renamed from %r"
3553
" but source does not exist\n"
3554
"entry: %s" % (entry[0][0], entry[0][1], old_path, entry))
3555
source_details = old_entry[1][self.source_index]
3556
source_minikind = source_details[0]
3558
old_dirname = entry[0][0]
3559
old_basename = entry[0][1]
3560
old_path = path = None
3561
if path_info is None:
3562
# the file is missing on disk, show as removed.
3563
content_change = True
3567
# source and target are both versioned and disk file is present.
3568
target_kind = path_info[2]
3569
if target_kind == 'directory':
3571
old_path = path = pathjoin(old_dirname, old_basename)
3572
self.new_dirname_to_file_id[path] = file_id
3573
if source_minikind != 'd':
3574
content_change = True
3576
# directories have no fingerprint
3577
content_change = False
3579
elif target_kind == 'file':
3580
if source_minikind != 'f':
3581
content_change = True
3583
# Check the sha. We can't just rely on the size as
3584
# content filtering may mean differ sizes actually
3585
# map to the same content
3586
if link_or_sha1 is None:
3588
statvalue, link_or_sha1 = \
3589
self.state._sha1_provider.stat_and_sha1(
3591
self.state._observed_sha1(entry, link_or_sha1,
3593
content_change = (link_or_sha1 != source_details[1])
3594
# Target details is updated at update_entry time
3595
if self.use_filesystem_for_exec:
3596
# We don't need S_ISREG here, because we are sure
3597
# we are dealing with a file.
3598
target_exec = bool(stat.S_IEXEC & path_info[3].st_mode)
3600
target_exec = target_details[3]
3601
elif target_kind == 'symlink':
3602
if source_minikind != 'l':
3603
content_change = True
3605
content_change = (link_or_sha1 != source_details[1])
3607
elif target_kind == 'tree-reference':
3608
if source_minikind != 't':
3609
content_change = True
3611
content_change = False
3615
path = pathjoin(old_dirname, old_basename)
3616
raise errors.BadFileKindError(path, path_info[2])
3617
if source_minikind == 'd':
3619
old_path = path = pathjoin(old_dirname, old_basename)
3620
self.old_dirname_to_file_id[old_path] = file_id
3621
# parent id is the entry for the path in the target tree
3622
if old_basename and old_dirname == self.last_source_parent[0]:
3623
source_parent_id = self.last_source_parent[1]
3626
source_parent_id = self.old_dirname_to_file_id[old_dirname]
3628
source_parent_entry = self.state._get_entry(self.source_index,
3629
path_utf8=old_dirname)
3630
source_parent_id = source_parent_entry[0][2]
3631
if source_parent_id == entry[0][2]:
3632
# This is the root, so the parent is None
3633
source_parent_id = None
3635
self.last_source_parent[0] = old_dirname
3636
self.last_source_parent[1] = source_parent_id
3637
new_dirname = entry[0][0]
3638
if entry[0][1] and new_dirname == self.last_target_parent[0]:
3639
target_parent_id = self.last_target_parent[1]
3642
target_parent_id = self.new_dirname_to_file_id[new_dirname]
3644
# TODO: We don't always need to do the lookup, because the
3645
# parent entry will be the same as the source entry.
3646
target_parent_entry = self.state._get_entry(self.target_index,
3647
path_utf8=new_dirname)
3648
if target_parent_entry == (None, None):
3649
raise AssertionError(
3650
"Could not find target parent in wt: %s\nparent of: %s"
3651
% (new_dirname, entry))
3652
target_parent_id = target_parent_entry[0][2]
3653
if target_parent_id == entry[0][2]:
3654
# This is the root, so the parent is None
3655
target_parent_id = None
3657
self.last_target_parent[0] = new_dirname
3658
self.last_target_parent[1] = target_parent_id
3660
source_exec = source_details[3]
3661
changed = (content_change
3662
or source_parent_id != target_parent_id
3663
or old_basename != entry[0][1]
3664
or source_exec != target_exec
3666
if not changed and not self.include_unchanged:
3669
if old_path is None:
3670
old_path = path = pathjoin(old_dirname, old_basename)
3671
old_path_u = self.utf8_decode(old_path)[0]
3674
old_path_u = self.utf8_decode(old_path)[0]
3675
if old_path == path:
3678
path_u = self.utf8_decode(path)[0]
3679
source_kind = DirState._minikind_to_kind[source_minikind]
3680
return (entry[0][2],
3681
(old_path_u, path_u),
3684
(source_parent_id, target_parent_id),
3685
(self.utf8_decode(old_basename)[0], self.utf8_decode(entry[0][1])[0]),
3686
(source_kind, target_kind),
3687
(source_exec, target_exec)), changed
3688
elif source_minikind in 'a' and target_minikind in 'fdlt':
3689
# looks like a new file
3690
path = pathjoin(entry[0][0], entry[0][1])
3691
# parent id is the entry for the path in the target tree
3692
# TODO: these are the same for an entire directory: cache em.
3693
parent_id = self.state._get_entry(self.target_index,
3694
path_utf8=entry[0][0])[0][2]
3695
if parent_id == entry[0][2]:
3697
if path_info is not None:
3699
if self.use_filesystem_for_exec:
3700
# We need S_ISREG here, because we aren't sure if this
3703
stat.S_ISREG(path_info[3].st_mode)
3704
and stat.S_IEXEC & path_info[3].st_mode)
3706
target_exec = target_details[3]
3707
return (entry[0][2],
3708
(None, self.utf8_decode(path)[0]),
3712
(None, self.utf8_decode(entry[0][1])[0]),
3713
(None, path_info[2]),
3714
(None, target_exec)), True
3716
# Its a missing file, report it as such.
3717
return (entry[0][2],
3718
(None, self.utf8_decode(path)[0]),
3722
(None, self.utf8_decode(entry[0][1])[0]),
3724
(None, False)), True
3725
elif source_minikind in 'fdlt' and target_minikind in 'a':
3726
# unversioned, possibly, or possibly not deleted: we dont care.
3727
# if its still on disk, *and* theres no other entry at this
3728
# path [we dont know this in this routine at the moment -
3729
# perhaps we should change this - then it would be an unknown.
3730
old_path = pathjoin(entry[0][0], entry[0][1])
3731
# parent id is the entry for the path in the target tree
3732
parent_id = self.state._get_entry(self.source_index, path_utf8=entry[0][0])[0][2]
3733
if parent_id == entry[0][2]:
3735
return (entry[0][2],
3736
(self.utf8_decode(old_path)[0], None),
3740
(self.utf8_decode(entry[0][1])[0], None),
3741
(DirState._minikind_to_kind[source_minikind], None),
3742
(source_details[3], None)), True
3743
elif source_minikind in 'fdlt' and target_minikind in 'r':
3744
# a rename; could be a true rename, or a rename inherited from
3745
# a renamed parent. TODO: handle this efficiently. Its not
3746
# common case to rename dirs though, so a correct but slow
3747
# implementation will do.
3748
if not osutils.is_inside_any(self.searched_specific_files, target_details[1]):
3749
self.search_specific_files.add(target_details[1])
3750
elif source_minikind in 'ra' and target_minikind in 'ra':
3751
# neither of the selected trees contain this file,
3752
# so skip over it. This is not currently directly tested, but
3753
# is indirectly via test_too_much.TestCommands.test_conflicts.
3756
raise AssertionError("don't know how to compare "
3757
"source_minikind=%r, target_minikind=%r"
3758
% (source_minikind, target_minikind))
3764
def _gather_result_for_consistency(self, result):
3765
"""Check a result we will yield to make sure we are consistent later.
3767
This gathers result's parents into a set to output later.
3769
:param result: A result tuple.
3771
if not self.partial or not result[0]:
3773
self.seen_ids.add(result[0])
3774
new_path = result[1][1]
3776
# Not the root and not a delete: queue up the parents of the path.
3777
self.search_specific_file_parents.update(
3778
osutils.parent_directories(new_path.encode('utf8')))
3779
# Add the root directory which parent_directories does not
3781
self.search_specific_file_parents.add('')
3783
def iter_changes(self):
3784
"""Iterate over the changes."""
3785
utf8_decode = cache_utf8._utf8_decode
3786
_cmp_by_dirs = cmp_by_dirs
3787
_process_entry = self._process_entry
3788
search_specific_files = self.search_specific_files
3789
searched_specific_files = self.searched_specific_files
3790
splitpath = osutils.splitpath
3792
# compare source_index and target_index at or under each element of search_specific_files.
3793
# follow the following comparison table. Note that we only want to do diff operations when
3794
# the target is fdl because thats when the walkdirs logic will have exposed the pathinfo
3798
# Source | Target | disk | action
3799
# r | fdlt | | add source to search, add id path move and perform
3800
# | | | diff check on source-target
3801
# r | fdlt | a | dangling file that was present in the basis.
3803
# r | a | | add source to search
3805
# r | r | | this path is present in a non-examined tree, skip.
3806
# r | r | a | this path is present in a non-examined tree, skip.
3807
# a | fdlt | | add new id
3808
# a | fdlt | a | dangling locally added file, skip
3809
# a | a | | not present in either tree, skip
3810
# a | a | a | not present in any tree, skip
3811
# a | r | | not present in either tree at this path, skip as it
3812
# | | | may not be selected by the users list of paths.
3813
# a | r | a | not present in either tree at this path, skip as it
3814
# | | | may not be selected by the users list of paths.
3815
# fdlt | fdlt | | content in both: diff them
3816
# fdlt | fdlt | a | deleted locally, but not unversioned - show as deleted ?
3817
# fdlt | a | | unversioned: output deleted id for now
3818
# fdlt | a | a | unversioned and deleted: output deleted id
3819
# fdlt | r | | relocated in this tree, so add target to search.
3820
# | | | Dont diff, we will see an r,fd; pair when we reach
3821
# | | | this id at the other path.
3822
# fdlt | r | a | relocated in this tree, so add target to search.
3823
# | | | Dont diff, we will see an r,fd; pair when we reach
3824
# | | | this id at the other path.
3826
# TODO: jam 20070516 - Avoid the _get_entry lookup overhead by
3827
# keeping a cache of directories that we have seen.
3829
while search_specific_files:
3830
# TODO: the pending list should be lexically sorted? the
3831
# interface doesn't require it.
3832
current_root = search_specific_files.pop()
3833
current_root_unicode = current_root.decode('utf8')
3834
searched_specific_files.add(current_root)
3835
# process the entries for this containing directory: the rest will be
3836
# found by their parents recursively.
3837
root_entries = self.state._entries_for_path(current_root)
3838
root_abspath = self.tree.abspath(current_root_unicode)
3840
root_stat = os.lstat(root_abspath)
3842
if e.errno == errno.ENOENT:
3843
# the path does not exist: let _process_entry know that.
3844
root_dir_info = None
3846
# some other random error: hand it up.
3849
root_dir_info = ('', current_root,
3850
osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
3852
if root_dir_info[2] == 'directory':
3853
if self.tree._directory_is_tree_reference(
3854
current_root.decode('utf8')):
3855
root_dir_info = root_dir_info[:2] + \
3856
('tree-reference',) + root_dir_info[3:]
3858
if not root_entries and not root_dir_info:
3859
# this specified path is not present at all, skip it.
3861
path_handled = False
3862
for entry in root_entries:
3863
result, changed = _process_entry(entry, root_dir_info)
3864
if changed is not None:
3867
self._gather_result_for_consistency(result)
3868
if changed or self.include_unchanged:
3870
if self.want_unversioned and not path_handled and root_dir_info:
3871
new_executable = bool(
3872
stat.S_ISREG(root_dir_info[3].st_mode)
3873
and stat.S_IEXEC & root_dir_info[3].st_mode)
3875
(None, current_root_unicode),
3879
(None, splitpath(current_root_unicode)[-1]),
3880
(None, root_dir_info[2]),
3881
(None, new_executable)
3883
initial_key = (current_root, '', '')
3884
block_index, _ = self.state._find_block_index_from_key(initial_key)
3885
if block_index == 0:
3886
# we have processed the total root already, but because the
3887
# initial key matched it we should skip it here.
3889
if root_dir_info and root_dir_info[2] == 'tree-reference':
3890
current_dir_info = None
3892
dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
3894
current_dir_info = dir_iterator.next()
3896
# on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
3897
# python 2.5 has e.errno == EINVAL,
3898
# and e.winerror == ERROR_DIRECTORY
3899
e_winerror = getattr(e, 'winerror', None)
3900
win_errors = (ERROR_DIRECTORY, ERROR_PATH_NOT_FOUND)
3901
# there may be directories in the inventory even though
3902
# this path is not a file on disk: so mark it as end of
3904
if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
3905
current_dir_info = None
3906
elif (sys.platform == 'win32'
3907
and (e.errno in win_errors
3908
or e_winerror in win_errors)):
3909
current_dir_info = None
3913
if current_dir_info[0][0] == '':
3914
# remove .bzr from iteration
3915
bzr_index = bisect.bisect_left(current_dir_info[1], ('.bzr',))
3916
if current_dir_info[1][bzr_index][0] != '.bzr':
3917
raise AssertionError()
3918
del current_dir_info[1][bzr_index]
3919
# walk until both the directory listing and the versioned metadata
3921
if (block_index < len(self.state._dirblocks) and
3922
osutils.is_inside(current_root, self.state._dirblocks[block_index][0])):
3923
current_block = self.state._dirblocks[block_index]
3925
current_block = None
3926
while (current_dir_info is not None or
3927
current_block is not None):
3928
if (current_dir_info and current_block
3929
and current_dir_info[0][0] != current_block[0]):
3930
if _cmp_by_dirs(current_dir_info[0][0], current_block[0]) < 0:
3931
# filesystem data refers to paths not covered by the dirblock.
3932
# this has two possibilities:
3933
# A) it is versioned but empty, so there is no block for it
3934
# B) it is not versioned.
3936
# if (A) then we need to recurse into it to check for
3937
# new unknown files or directories.
3938
# if (B) then we should ignore it, because we don't
3939
# recurse into unknown directories.
3941
while path_index < len(current_dir_info[1]):
3942
current_path_info = current_dir_info[1][path_index]
3943
if self.want_unversioned:
3944
if current_path_info[2] == 'directory':
3945
if self.tree._directory_is_tree_reference(
3946
current_path_info[0].decode('utf8')):
3947
current_path_info = current_path_info[:2] + \
3948
('tree-reference',) + current_path_info[3:]
3949
new_executable = bool(
3950
stat.S_ISREG(current_path_info[3].st_mode)
3951
and stat.S_IEXEC & current_path_info[3].st_mode)
3953
(None, utf8_decode(current_path_info[0])[0]),
3957
(None, utf8_decode(current_path_info[1])[0]),
3958
(None, current_path_info[2]),
3959
(None, new_executable))
3960
# dont descend into this unversioned path if it is
3962
if current_path_info[2] in ('directory',
3964
del current_dir_info[1][path_index]
3968
# This dir info has been handled, go to the next
3970
current_dir_info = dir_iterator.next()
3971
except StopIteration:
3972
current_dir_info = None
3974
# We have a dirblock entry for this location, but there
3975
# is no filesystem path for this. This is most likely
3976
# because a directory was removed from the disk.
3977
# We don't have to report the missing directory,
3978
# because that should have already been handled, but we
3979
# need to handle all of the files that are contained
3981
for current_entry in current_block[1]:
3982
# entry referring to file not present on disk.
3983
# advance the entry only, after processing.
3984
result, changed = _process_entry(current_entry, None)
3985
if changed is not None:
3987
self._gather_result_for_consistency(result)
3988
if changed or self.include_unchanged:
3991
if (block_index < len(self.state._dirblocks) and
3992
osutils.is_inside(current_root,
3993
self.state._dirblocks[block_index][0])):
3994
current_block = self.state._dirblocks[block_index]
3996
current_block = None
3999
if current_block and entry_index < len(current_block[1]):
4000
current_entry = current_block[1][entry_index]
4002
current_entry = None
4003
advance_entry = True
4005
if current_dir_info and path_index < len(current_dir_info[1]):
4006
current_path_info = current_dir_info[1][path_index]
4007
if current_path_info[2] == 'directory':
4008
if self.tree._directory_is_tree_reference(
4009
current_path_info[0].decode('utf8')):
4010
current_path_info = current_path_info[:2] + \
4011
('tree-reference',) + current_path_info[3:]
4013
current_path_info = None
4015
path_handled = False
4016
while (current_entry is not None or
4017
current_path_info is not None):
4018
if current_entry is None:
4019
# the check for path_handled when the path is advanced
4020
# will yield this path if needed.
4022
elif current_path_info is None:
4023
# no path is fine: the per entry code will handle it.
4024
result, changed = _process_entry(current_entry, current_path_info)
4025
if changed is not None:
4027
self._gather_result_for_consistency(result)
4028
if changed or self.include_unchanged:
4030
elif (current_entry[0][1] != current_path_info[1]
4031
or current_entry[1][self.target_index][0] in 'ar'):
4032
# The current path on disk doesn't match the dirblock
4033
# record. Either the dirblock is marked as absent, or
4034
# the file on disk is not present at all in the
4035
# dirblock. Either way, report about the dirblock
4036
# entry, and let other code handle the filesystem one.
4038
# Compare the basename for these files to determine
4040
if current_path_info[1] < current_entry[0][1]:
4041
# extra file on disk: pass for now, but only
4042
# increment the path, not the entry
4043
advance_entry = False
4045
# entry referring to file not present on disk.
4046
# advance the entry only, after processing.
4047
result, changed = _process_entry(current_entry, None)
4048
if changed is not None:
4050
self._gather_result_for_consistency(result)
4051
if changed or self.include_unchanged:
4053
advance_path = False
4055
result, changed = _process_entry(current_entry, current_path_info)
4056
if changed is not None:
4059
self._gather_result_for_consistency(result)
4060
if changed or self.include_unchanged:
4062
if advance_entry and current_entry is not None:
4064
if entry_index < len(current_block[1]):
4065
current_entry = current_block[1][entry_index]
4067
current_entry = None
4069
advance_entry = True # reset the advance flaga
4070
if advance_path and current_path_info is not None:
4071
if not path_handled:
4072
# unversioned in all regards
4073
if self.want_unversioned:
4074
new_executable = bool(
4075
stat.S_ISREG(current_path_info[3].st_mode)
4076
and stat.S_IEXEC & current_path_info[3].st_mode)
4078
relpath_unicode = utf8_decode(current_path_info[0])[0]
4079
except UnicodeDecodeError:
4080
raise errors.BadFilenameEncoding(
4081
current_path_info[0], osutils._fs_enc)
4083
(None, relpath_unicode),
4087
(None, utf8_decode(current_path_info[1])[0]),
4088
(None, current_path_info[2]),
4089
(None, new_executable))
4090
# dont descend into this unversioned path if it is
4092
if current_path_info[2] in ('directory'):
4093
del current_dir_info[1][path_index]
4095
# dont descend the disk iterator into any tree
4097
if current_path_info[2] == 'tree-reference':
4098
del current_dir_info[1][path_index]
4101
if path_index < len(current_dir_info[1]):
4102
current_path_info = current_dir_info[1][path_index]
4103
if current_path_info[2] == 'directory':
4104
if self.tree._directory_is_tree_reference(
4105
current_path_info[0].decode('utf8')):
4106
current_path_info = current_path_info[:2] + \
4107
('tree-reference',) + current_path_info[3:]
4109
current_path_info = None
4110
path_handled = False
4112
advance_path = True # reset the advance flagg.
4113
if current_block is not None:
4115
if (block_index < len(self.state._dirblocks) and
4116
osutils.is_inside(current_root, self.state._dirblocks[block_index][0])):
4117
current_block = self.state._dirblocks[block_index]
4119
current_block = None
4120
if current_dir_info is not None:
4122
current_dir_info = dir_iterator.next()
4123
except StopIteration:
4124
current_dir_info = None
4125
for result in self._iter_specific_file_parents():
4128
def _iter_specific_file_parents(self):
4129
"""Iter over the specific file parents."""
4130
while self.search_specific_file_parents:
4131
# Process the parent directories for the paths we were iterating.
4132
# Even in extremely large trees this should be modest, so currently
4133
# no attempt is made to optimise.
4134
path_utf8 = self.search_specific_file_parents.pop()
4135
if osutils.is_inside_any(self.searched_specific_files, path_utf8):
4136
# We've examined this path.
4138
if path_utf8 in self.searched_exact_paths:
4139
# We've examined this path.
4141
path_entries = self.state._entries_for_path(path_utf8)
4142
# We need either one or two entries. If the path in
4143
# self.target_index has moved (so the entry in source_index is in
4144
# 'ar') then we need to also look for the entry for this path in
4145
# self.source_index, to output the appropriate delete-or-rename.
4146
selected_entries = []
4148
for candidate_entry in path_entries:
4149
# Find entries present in target at this path:
4150
if candidate_entry[1][self.target_index][0] not in 'ar':
4152
selected_entries.append(candidate_entry)
4153
# Find entries present in source at this path:
4154
elif (self.source_index is not None and
4155
candidate_entry[1][self.source_index][0] not in 'ar'):
4157
if candidate_entry[1][self.target_index][0] == 'a':
4158
# Deleted, emit it here.
4159
selected_entries.append(candidate_entry)
4161
# renamed, emit it when we process the directory it
4163
self.search_specific_file_parents.add(
4164
candidate_entry[1][self.target_index][1])
4166
raise AssertionError(
4167
"Missing entry for specific path parent %r, %r" % (
4168
path_utf8, path_entries))
4169
path_info = self._path_info(path_utf8, path_utf8.decode('utf8'))
4170
for entry in selected_entries:
4171
if entry[0][2] in self.seen_ids:
4173
result, changed = self._process_entry(entry, path_info)
4175
raise AssertionError(
4176
"Got entry<->path mismatch for specific path "
4177
"%r entry %r path_info %r " % (
4178
path_utf8, entry, path_info))
4179
# Only include changes - we're outside the users requested
4182
self._gather_result_for_consistency(result)
4183
if (result[6][0] == 'directory' and
4184
result[6][1] != 'directory'):
4185
# This stopped being a directory, the old children have
4187
if entry[1][self.source_index][0] == 'r':
4188
# renamed, take the source path
4189
entry_path_utf8 = entry[1][self.source_index][1]
4191
entry_path_utf8 = path_utf8
4192
initial_key = (entry_path_utf8, '', '')
4193
block_index, _ = self.state._find_block_index_from_key(
4195
if block_index == 0:
4196
# The children of the root are in block index 1.
4198
current_block = None
4199
if block_index < len(self.state._dirblocks):
4200
current_block = self.state._dirblocks[block_index]
4201
if not osutils.is_inside(
4202
entry_path_utf8, current_block[0]):
4203
# No entries for this directory at all.
4204
current_block = None
4205
if current_block is not None:
4206
for entry in current_block[1]:
4207
if entry[1][self.source_index][0] in 'ar':
4208
# Not in the source tree, so doesn't have to be
4211
# Path of the entry itself.
4213
self.search_specific_file_parents.add(
4214
osutils.pathjoin(*entry[0][:2]))
4215
if changed or self.include_unchanged:
4217
self.searched_exact_paths.add(path_utf8)
4219
def _path_info(self, utf8_path, unicode_path):
4220
"""Generate path_info for unicode_path.
4222
:return: None if unicode_path does not exist, or a path_info tuple.
4224
abspath = self.tree.abspath(unicode_path)
4226
stat = os.lstat(abspath)
4228
if e.errno == errno.ENOENT:
4229
# the path does not exist.
4233
utf8_basename = utf8_path.rsplit('/', 1)[-1]
4234
dir_info = (utf8_path, utf8_basename,
4235
osutils.file_kind_from_stat_mode(stat.st_mode), stat,
4237
if dir_info[2] == 'directory':
4238
if self.tree._directory_is_tree_reference(
4240
self.root_dir_info = self.root_dir_info[:2] + \
4241
('tree-reference',) + self.root_dir_info[3:]
4245
# Try to load the compiled form if possible
4247
from bzrlib._dirstate_helpers_pyx import (
4254
ProcessEntryC as _process_entry,
4255
update_entry as update_entry,
4257
except ImportError, e:
4258
osutils.failed_to_load_extension(e)
4259
from bzrlib._dirstate_helpers_py import (
4267
# FIXME: It would be nice to be able to track moved lines so that the
4268
# corresponding python code can be moved to the _dirstate_helpers_py
4269
# module. I don't want to break the history for this important piece of
4270
# code so I left the code here -- vila 20090622
4271
update_entry = py_update_entry
4272
_process_entry = ProcessEntryPython
added
removed
bzrlib/dirstate.py
