1
# Copyright (C) 2006, 2007 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""DirState objects record the state of a directory and its bzr metadata.
19
Pseudo EBNF grammar for the state file. Fields are separated by NULLs, and
20
lines by NL. The field delimiters are ommitted in the grammar, line delimiters
21
are not - this is done for clarity of reading. All string data is in utf8.
23
MINIKIND = "f" | "d" | "l" | "a" | "r" | "t";
26
WHOLE_NUMBER = {digit}, digit;
28
REVISION_ID = a non-empty utf8 string;
30
dirstate format = header line, full checksum, row count, parent details,
31
ghost_details, entries;
32
header line = "#bazaar dirstate flat format 3", NL;
33
full checksum = "crc32: ", ["-"], WHOLE_NUMBER, NL;
34
row count = "num_entries: ", WHOLE_NUMBER, NL;
35
parent_details = WHOLE NUMBER, {REVISION_ID}* NL;
36
ghost_details = WHOLE NUMBER, {REVISION_ID}*, NL;
38
entry = entry_key, current_entry_details, {parent_entry_details};
39
entry_key = dirname, basename, fileid;
40
current_entry_details = common_entry_details, working_entry_details;
41
parent_entry_details = common_entry_details, history_entry_details;
42
common_entry_details = MINIKIND, fingerprint, size, executable
43
working_entry_details = packed_stat
44
history_entry_details = REVISION_ID;
47
fingerprint = a nonempty utf8 sequence with meaning defined by minikind.
49
Given this definition, the following is useful to know:
50
entry (aka row) - all the data for a given key.
51
entry[0]: The key (dirname, basename, fileid)
55
entry[1]: The tree(s) data for this path and id combination.
56
entry[1][0]: The current tree
57
entry[1][1]: The second tree
59
For an entry for a tree, we have (using tree 0 - current tree) to demonstrate:
60
entry[1][0][0]: minikind
61
entry[1][0][1]: fingerprint
63
entry[1][0][3]: executable
64
entry[1][0][4]: packed_stat
66
entry[1][1][4]: revision_id
68
There may be multiple rows at the root, one per id present in the root, so the
69
in memory root row is now:
70
self._dirblocks[0] -> ('', [entry ...]),
71
and the entries in there are
74
entries[0][2]: file_id
75
entries[1][0]: The tree data for the current tree for this fileid at /
79
'r' is a relocated entry: This path is not present in this tree with this id,
80
but the id can be found at another location. The fingerprint is used to
81
point to the target location.
82
'a' is an absent entry: In that tree the id is not present at this path.
83
'd' is a directory entry: This path in this tree is a directory with the
84
current file id. There is no fingerprint for directories.
85
'f' is a file entry: As for directory, but its a file. The fingerprint is a
87
'l' is a symlink entry: As for directory, but a symlink. The fingerprint is the
89
't' is a reference to a nested subtree; the fingerprint is the referenced
94
The entries on disk and in memory are ordered according to the following keys:
96
directory, as a list of components
100
--- Format 1 had the following different definition: ---
101
rows = dirname, NULL, basename, NULL, MINIKIND, NULL, fileid_utf8, NULL,
102
WHOLE NUMBER (* size *), NULL, packed stat, NULL, sha1|symlink target,
104
PARENT ROW = NULL, revision_utf8, NULL, MINIKIND, NULL, dirname, NULL,
105
basename, NULL, WHOLE NUMBER (* size *), NULL, "y" | "n", NULL,
108
PARENT ROW's are emitted for every parent that is not in the ghosts details
109
line. That is, if the parents are foo, bar, baz, and the ghosts are bar, then
110
each row will have a PARENT ROW for foo and baz, but not for bar.
113
In any tree, a kind of 'moved' indicates that the fingerprint field
114
(which we treat as opaque data specific to the 'kind' anyway) has the
115
details for the id of this row in that tree.
117
I'm strongly tempted to add a id->path index as well, but I think that
118
where we need id->path mapping; we also usually read the whole file, so
119
I'm going to skip that for the moment, as we have the ability to locate
120
via bisect any path in any tree, and if we lookup things by path, we can
121
accumulate an id->path mapping as we go, which will tend to match what we
124
I plan to implement this asap, so please speak up now to alter/tweak the
125
design - and once we stabilise on this, I'll update the wiki page for
128
The rationale for all this is that we want fast operations for the
129
common case (diff/status/commit/merge on all files) and extremely fast
130
operations for the less common but still occurs a lot status/diff/commit
131
on specific files). Operations on specific files involve a scan for all
132
the children of a path, *in every involved tree*, which the current
133
format did not accommodate.
137
1) Fast end to end use for bzr's top 5 uses cases. (commmit/diff/status/merge/???)
138
2) fall back current object model as needed.
139
3) scale usably to the largest trees known today - say 50K entries. (mozilla
140
is an example of this)
144
Eventually reuse dirstate objects across locks IFF the dirstate file has not
145
been modified, but will require that we flush/ignore cached stat-hit data
146
because we won't want to restat all files on disk just because a lock was
147
acquired, yet we cannot trust the data after the previous lock was released.
149
Memory representation:
150
vector of all directories, and vector of the childen ?
152
root_entrie = (direntry for root, [parent_direntries_for_root]),
154
('', ['data for achild', 'data for bchild', 'data for cchild'])
155
('dir', ['achild', 'cchild', 'echild'])
157
- single bisect to find N subtrees from a path spec
158
- in-order for serialisation - this is 'dirblock' grouping.
159
- insertion of a file '/a' affects only the '/' child-vector, that is, to
160
insert 10K elements from scratch does not generates O(N^2) memoves of a
161
single vector, rather each individual, which tends to be limited to a
162
manageable number. Will scale badly on trees with 10K entries in a
163
single directory. compare with Inventory.InventoryDirectory which has
164
a dictionary for the children. No bisect capability, can only probe for
165
exact matches, or grab all elements and sort.
166
- What's the risk of error here? Once we have the base format being processed
167
we should have a net win regardless of optimality. So we are going to
168
go with what seems reasonable.
171
Maybe we should do a test profile of the core structure - 10K simulated
172
searches/lookups/etc?
174
Objects for each row?
175
The lifetime of Dirstate objects is current per lock, but see above for
176
possible extensions. The lifetime of a row from a dirstate is expected to be
177
very short in the optimistic case: which we are optimising for. For instance,
178
subtree status will determine from analysis of the disk data what rows need to
179
be examined at all, and will be able to determine from a single row whether
180
that file has altered or not, so we are aiming to process tens of thousands of
181
entries each second within the dirstate context, before exposing anything to
182
the larger codebase. This suggests we want the time for a single file
183
comparison to be < 0.1 milliseconds. That would give us 10000 paths per second
184
processed, and to scale to 100 thousand we'll another order of magnitude to do
185
that. Now, as the lifetime for all unchanged entries is the time to parse, stat
186
the file on disk, and then immediately discard, the overhead of object creation
187
becomes a significant cost.
189
Figures: Creating a tuple from from 3 elements was profiled at 0.0625
190
microseconds, whereas creating a object which is subclassed from tuple was
191
0.500 microseconds, and creating an object with 3 elements and slots was 3
192
microseconds long. 0.1 milliseconds is 100 microseconds, and ideally we'll get
193
down to 10 microseconds for the total processing - having 33% of that be object
194
creation is a huge overhead. There is a potential cost in using tuples within
195
each row which is that the conditional code to do comparisons may be slower
196
than method invocation, but method invocation is known to be slow due to stack
197
frame creation, so avoiding methods in these tight inner loops in unfortunately
198
desirable. We can consider a pyrex version of this with objects in future if
207
from stat import S_IEXEC
224
def pack_stat(st, _encode=binascii.b2a_base64, _pack=struct.pack):
225
"""Convert stat values into a packed representation."""
226
# jam 20060614 it isn't really worth removing more entries if we
227
# are going to leave it in packed form.
228
# With only st_mtime and st_mode filesize is 5.5M and read time is 275ms
229
# With all entries, filesize is 5.9M and read time is maybe 280ms
230
# well within the noise margin
232
# base64 encoding always adds a final newline, so strip it off
233
# The current version
234
return _encode(_pack('>LLLLLL'
235
, st.st_size, int(st.st_mtime), int(st.st_ctime)
236
, st.st_dev, st.st_ino & 0xFFFFFFFF, st.st_mode))[:-1]
237
# This is 0.060s / 1.520s faster by not encoding as much information
238
# return _encode(_pack('>LL', int(st.st_mtime), st.st_mode))[:-1]
239
# This is not strictly faster than _encode(_pack())[:-1]
240
# return '%X.%X.%X.%X.%X.%X' % (
241
# st.st_size, int(st.st_mtime), int(st.st_ctime),
242
# st.st_dev, st.st_ino, st.st_mode)
243
# Similar to the _encode(_pack('>LL'))
244
# return '%X.%X' % (int(st.st_mtime), st.st_mode)
247
class DirState(object):
248
"""Record directory and metadata state for fast access.
250
A dirstate is a specialised data structure for managing local working
251
tree state information. Its not yet well defined whether it is platform
252
specific, and if it is how we detect/parameterise that.
254
Dirstates use the usual lock_write, lock_read and unlock mechanisms.
255
Unlike most bzr disk formats, DirStates must be locked for reading, using
256
lock_read. (This is an os file lock internally.) This is necessary
257
because the file can be rewritten in place.
259
DirStates must be explicitly written with save() to commit changes; just
260
unlocking them does not write the changes to disk.
263
_kind_to_minikind = {
269
'tree-reference': 't',
271
_minikind_to_kind = {
277
't': 'tree-reference',
279
_stat_to_minikind = {
284
_to_yesno = {True:'y', False: 'n'} # TODO profile the performance gain
285
# of using int conversion rather than a dict here. AND BLAME ANDREW IF
288
# TODO: jam 20070221 Figure out what to do if we have a record that exceeds
289
# the BISECT_PAGE_SIZE. For now, we just have to make it large enough
290
# that we are sure a single record will always fit.
291
BISECT_PAGE_SIZE = 4096
294
IN_MEMORY_UNMODIFIED = 1
295
IN_MEMORY_MODIFIED = 2
297
# A pack_stat (the x's) that is just noise and will never match the output
300
NULL_PARENT_DETAILS = ('a', '', 0, False, '')
302
HEADER_FORMAT_2 = '#bazaar dirstate flat format 2\n'
303
HEADER_FORMAT_3 = '#bazaar dirstate flat format 3\n'
305
def __init__(self, path):
306
"""Create a DirState object.
310
:attr _root_entrie: The root row of the directory/file information,
311
- contains the path to / - '', ''
312
- kind of 'directory',
313
- the file id of the root in utf8
316
- and no sha information.
317
:param path: The path at which the dirstate file on disk should live.
319
# _header_state and _dirblock_state represent the current state
320
# of the dirstate metadata and the per-row data respectiely.
321
# NOT_IN_MEMORY indicates that no data is in memory
322
# IN_MEMORY_UNMODIFIED indicates that what we have in memory
323
# is the same as is on disk
324
# IN_MEMORY_MODIFIED indicates that we have a modified version
325
# of what is on disk.
326
# In future we will add more granularity, for instance _dirblock_state
327
# will probably support partially-in-memory as a separate variable,
328
# allowing for partially-in-memory unmodified and partially-in-memory
330
self._header_state = DirState.NOT_IN_MEMORY
331
self._dirblock_state = DirState.NOT_IN_MEMORY
335
self._state_file = None
336
self._filename = path
337
self._lock_token = None
338
self._lock_state = None
339
self._id_index = None
340
self._end_of_header = None
341
self._cutoff_time = None
342
self._split_path_cache = {}
343
self._bisect_page_size = DirState.BISECT_PAGE_SIZE
344
if 'hashcache' in debug.debug_flags:
345
self._sha1_file = self._sha1_file_and_mutter
347
self._sha1_file = osutils.sha_file_by_name
351
(self.__class__.__name__, self._filename)
353
def add(self, path, file_id, kind, stat, fingerprint):
354
"""Add a path to be tracked.
356
:param path: The path within the dirstate - '' is the root, 'foo' is the
357
path foo within the root, 'foo/bar' is the path bar within foo
359
:param file_id: The file id of the path being added.
360
:param kind: The kind of the path, as a string like 'file',
362
:param stat: The output of os.lstat for the path.
363
:param fingerprint: The sha value of the file,
364
or the target of a symlink,
365
or the referenced revision id for tree-references,
366
or '' for directories.
369
# find the block its in.
370
# find the location in the block.
371
# check its not there
373
#------- copied from inventory.ensure_normalized_name - keep synced.
374
# --- normalized_filename wants a unicode basename only, so get one.
375
dirname, basename = osutils.split(path)
376
# we dont import normalized_filename directly because we want to be
377
# able to change the implementation at runtime for tests.
378
norm_name, can_access = osutils.normalized_filename(basename)
379
if norm_name != basename:
383
raise errors.InvalidNormalization(path)
384
# you should never have files called . or ..; just add the directory
385
# in the parent, or according to the special treatment for the root
386
if basename == '.' or basename == '..':
387
raise errors.InvalidEntryName(path)
388
# now that we've normalised, we need the correct utf8 path and
389
# dirname and basename elements. This single encode and split should be
390
# faster than three separate encodes.
391
utf8path = (dirname + '/' + basename).strip('/').encode('utf8')
392
dirname, basename = osutils.split(utf8path)
393
assert file_id.__class__ == str, \
394
"must be a utf8 file_id not %s" % (type(file_id))
395
# Make sure the file_id does not exist in this tree
396
file_id_entry = self._get_entry(0, fileid_utf8=file_id)
397
if file_id_entry != (None, None):
398
path = osutils.pathjoin(file_id_entry[0][0], file_id_entry[0][1])
399
kind = DirState._minikind_to_kind[file_id_entry[1][0][0]]
400
info = '%s:%s' % (kind, path)
401
raise errors.DuplicateFileId(file_id, info)
402
first_key = (dirname, basename, '')
403
block_index, present = self._find_block_index_from_key(first_key)
405
# check the path is not in the tree
406
block = self._dirblocks[block_index][1]
407
entry_index, _ = self._find_entry_index(first_key, block)
408
while (entry_index < len(block) and
409
block[entry_index][0][0:2] == first_key[0:2]):
410
if block[entry_index][1][0][0] not in 'ar':
411
# this path is in the dirstate in the current tree.
412
raise Exception, "adding already added path!"
415
# The block where we want to put the file is not present. But it
416
# might be because the directory was empty, or not loaded yet. Look
417
# for a parent entry, if not found, raise NotVersionedError
418
parent_dir, parent_base = osutils.split(dirname)
419
parent_block_idx, parent_entry_idx, _, parent_present = \
420
self._get_block_entry_index(parent_dir, parent_base, 0)
421
if not parent_present:
422
raise errors.NotVersionedError(path, str(self))
423
self._ensure_block(parent_block_idx, parent_entry_idx, dirname)
424
block = self._dirblocks[block_index][1]
425
entry_key = (dirname, basename, file_id)
428
packed_stat = DirState.NULLSTAT
431
packed_stat = pack_stat(stat)
432
parent_info = self._empty_parent_info()
433
minikind = DirState._kind_to_minikind[kind]
435
entry_data = entry_key, [
436
(minikind, fingerprint, size, False, packed_stat),
438
elif kind == 'directory':
439
entry_data = entry_key, [
440
(minikind, '', 0, False, packed_stat),
442
elif kind == 'symlink':
443
entry_data = entry_key, [
444
(minikind, fingerprint, size, False, packed_stat),
446
elif kind == 'tree-reference':
447
entry_data = entry_key, [
448
(minikind, fingerprint, 0, False, packed_stat),
451
raise errors.BzrError('unknown kind %r' % kind)
452
entry_index, present = self._find_entry_index(entry_key, block)
454
block.insert(entry_index, entry_data)
456
assert block[entry_index][1][0][0] == 'a', " %r(%r) already added" % (basename, file_id)
457
block[entry_index][1][0] = entry_data[1][0]
459
if kind == 'directory':
460
# insert a new dirblock
461
self._ensure_block(block_index, entry_index, utf8path)
462
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
464
self._id_index.setdefault(entry_key[2], set()).add(entry_key)
466
def _bisect(self, paths):
467
"""Bisect through the disk structure for specific rows.
469
:param paths: A list of paths to find
470
:return: A dict mapping path => entries for found entries. Missing
471
entries will not be in the map.
472
The list is not sorted, and entries will be populated
473
based on when they were read.
475
self._requires_lock()
476
# We need the file pointer to be right after the initial header block
477
self._read_header_if_needed()
478
# If _dirblock_state was in memory, we should just return info from
479
# there, this function is only meant to handle when we want to read
481
assert self._dirblock_state == DirState.NOT_IN_MEMORY
483
# The disk representation is generally info + '\0\n\0' at the end. But
484
# for bisecting, it is easier to treat this as '\0' + info + '\0\n'
485
# Because it means we can sync on the '\n'
486
state_file = self._state_file
487
file_size = os.fstat(state_file.fileno()).st_size
488
# We end up with 2 extra fields, we should have a trailing '\n' to
489
# ensure that we read the whole record, and we should have a precursur
490
# '' which ensures that we start after the previous '\n'
491
entry_field_count = self._fields_per_entry() + 1
493
low = self._end_of_header
494
high = file_size - 1 # Ignore the final '\0'
495
# Map from (dir, name) => entry
498
# Avoid infinite seeking
499
max_count = 30*len(paths)
501
# pending is a list of places to look.
502
# each entry is a tuple of low, high, dir_names
503
# low -> the first byte offset to read (inclusive)
504
# high -> the last byte offset (inclusive)
505
# dir_names -> The list of (dir, name) pairs that should be found in
506
# the [low, high] range
507
pending = [(low, high, paths)]
509
page_size = self._bisect_page_size
511
fields_to_entry = self._get_fields_to_entry()
514
low, high, cur_files = pending.pop()
516
if not cur_files or low >= high:
521
if count > max_count:
522
raise errors.BzrError('Too many seeks, most likely a bug.')
524
mid = max(low, (low+high-page_size)/2)
527
# limit the read size, so we don't end up reading data that we have
529
read_size = min(page_size, (high-mid)+1)
530
block = state_file.read(read_size)
533
entries = block.split('\n')
536
# We didn't find a '\n', so we cannot have found any records.
537
# So put this range back and try again. But we know we have to
538
# increase the page size, because a single read did not contain
539
# a record break (so records must be larger than page_size)
541
pending.append((low, high, cur_files))
544
# Check the first and last entries, in case they are partial, or if
545
# we don't care about the rest of this page
547
first_fields = entries[0].split('\0')
548
if len(first_fields) < entry_field_count:
549
# We didn't get the complete first entry
550
# so move start, and grab the next, which
551
# should be a full entry
552
start += len(entries[0])+1
553
first_fields = entries[1].split('\0')
556
if len(first_fields) <= 2:
557
# We didn't even get a filename here... what do we do?
558
# Try a large page size and repeat this query
560
pending.append((low, high, cur_files))
563
# Find what entries we are looking for, which occur before and
564
# after this first record.
567
first_path = first_fields[1] + '/' + first_fields[2]
569
first_path = first_fields[2]
570
first_loc = _bisect_path_left(cur_files, first_path)
572
# These exist before the current location
573
pre = cur_files[:first_loc]
574
# These occur after the current location, which may be in the
575
# data we read, or might be after the last entry
576
post = cur_files[first_loc:]
578
if post and len(first_fields) >= entry_field_count:
579
# We have files after the first entry
581
# Parse the last entry
582
last_entry_num = len(entries)-1
583
last_fields = entries[last_entry_num].split('\0')
584
if len(last_fields) < entry_field_count:
585
# The very last hunk was not complete,
586
# read the previous hunk
587
after = mid + len(block) - len(entries[-1])
589
last_fields = entries[last_entry_num].split('\0')
591
after = mid + len(block)
594
last_path = last_fields[1] + '/' + last_fields[2]
596
last_path = last_fields[2]
597
last_loc = _bisect_path_right(post, last_path)
599
middle_files = post[:last_loc]
600
post = post[last_loc:]
603
# We have files that should occur in this block
604
# (>= first, <= last)
605
# Either we will find them here, or we can mark them as
608
if middle_files[0] == first_path:
609
# We might need to go before this location
610
pre.append(first_path)
611
if middle_files[-1] == last_path:
612
post.insert(0, last_path)
614
# Find out what paths we have
615
paths = {first_path:[first_fields]}
616
# last_path might == first_path so we need to be
617
# careful if we should append rather than overwrite
618
if last_entry_num != first_entry_num:
619
paths.setdefault(last_path, []).append(last_fields)
620
for num in xrange(first_entry_num+1, last_entry_num):
621
# TODO: jam 20070223 We are already splitting here, so
622
# shouldn't we just split the whole thing rather
623
# than doing the split again in add_one_record?
624
fields = entries[num].split('\0')
626
path = fields[1] + '/' + fields[2]
629
paths.setdefault(path, []).append(fields)
631
for path in middle_files:
632
for fields in paths.get(path, []):
633
# offset by 1 because of the opening '\0'
634
# consider changing fields_to_entry to avoid the
636
entry = fields_to_entry(fields[1:])
637
found.setdefault(path, []).append(entry)
639
# Now we have split up everything into pre, middle, and post, and
640
# we have handled everything that fell in 'middle'.
641
# We add 'post' first, so that we prefer to seek towards the
642
# beginning, so that we will tend to go as early as we need, and
643
# then only seek forward after that.
645
pending.append((after, high, post))
647
pending.append((low, start-1, pre))
649
# Consider that we may want to return the directory entries in sorted
650
# order. For now, we just return them in whatever order we found them,
651
# and leave it up to the caller if they care if it is ordered or not.
654
def _bisect_dirblocks(self, dir_list):
655
"""Bisect through the disk structure to find entries in given dirs.
657
_bisect_dirblocks is meant to find the contents of directories, which
658
differs from _bisect, which only finds individual entries.
660
:param dir_list: A sorted list of directory names ['', 'dir', 'foo'].
661
:return: A map from dir => entries_for_dir
663
# TODO: jam 20070223 A lot of the bisecting logic could be shared
664
# between this and _bisect. It would require parameterizing the
665
# inner loop with a function, though. We should evaluate the
666
# performance difference.
667
self._requires_lock()
668
# We need the file pointer to be right after the initial header block
669
self._read_header_if_needed()
670
# If _dirblock_state was in memory, we should just return info from
671
# there, this function is only meant to handle when we want to read
673
assert self._dirblock_state == DirState.NOT_IN_MEMORY
675
# The disk representation is generally info + '\0\n\0' at the end. But
676
# for bisecting, it is easier to treat this as '\0' + info + '\0\n'
677
# Because it means we can sync on the '\n'
678
state_file = self._state_file
679
file_size = os.fstat(state_file.fileno()).st_size
680
# We end up with 2 extra fields, we should have a trailing '\n' to
681
# ensure that we read the whole record, and we should have a precursur
682
# '' which ensures that we start after the previous '\n'
683
entry_field_count = self._fields_per_entry() + 1
685
low = self._end_of_header
686
high = file_size - 1 # Ignore the final '\0'
687
# Map from dir => entry
690
# Avoid infinite seeking
691
max_count = 30*len(dir_list)
693
# pending is a list of places to look.
694
# each entry is a tuple of low, high, dir_names
695
# low -> the first byte offset to read (inclusive)
696
# high -> the last byte offset (inclusive)
697
# dirs -> The list of directories that should be found in
698
# the [low, high] range
699
pending = [(low, high, dir_list)]
701
page_size = self._bisect_page_size
703
fields_to_entry = self._get_fields_to_entry()
706
low, high, cur_dirs = pending.pop()
708
if not cur_dirs or low >= high:
713
if count > max_count:
714
raise errors.BzrError('Too many seeks, most likely a bug.')
716
mid = max(low, (low+high-page_size)/2)
719
# limit the read size, so we don't end up reading data that we have
721
read_size = min(page_size, (high-mid)+1)
722
block = state_file.read(read_size)
725
entries = block.split('\n')
728
# We didn't find a '\n', so we cannot have found any records.
729
# So put this range back and try again. But we know we have to
730
# increase the page size, because a single read did not contain
731
# a record break (so records must be larger than page_size)
733
pending.append((low, high, cur_dirs))
736
# Check the first and last entries, in case they are partial, or if
737
# we don't care about the rest of this page
739
first_fields = entries[0].split('\0')
740
if len(first_fields) < entry_field_count:
741
# We didn't get the complete first entry
742
# so move start, and grab the next, which
743
# should be a full entry
744
start += len(entries[0])+1
745
first_fields = entries[1].split('\0')
748
if len(first_fields) <= 1:
749
# We didn't even get a dirname here... what do we do?
750
# Try a large page size and repeat this query
752
pending.append((low, high, cur_dirs))
755
# Find what entries we are looking for, which occur before and
756
# after this first record.
758
first_dir = first_fields[1]
759
first_loc = bisect.bisect_left(cur_dirs, first_dir)
761
# These exist before the current location
762
pre = cur_dirs[:first_loc]
763
# These occur after the current location, which may be in the
764
# data we read, or might be after the last entry
765
post = cur_dirs[first_loc:]
767
if post and len(first_fields) >= entry_field_count:
768
# We have records to look at after the first entry
770
# Parse the last entry
771
last_entry_num = len(entries)-1
772
last_fields = entries[last_entry_num].split('\0')
773
if len(last_fields) < entry_field_count:
774
# The very last hunk was not complete,
775
# read the previous hunk
776
after = mid + len(block) - len(entries[-1])
778
last_fields = entries[last_entry_num].split('\0')
780
after = mid + len(block)
782
last_dir = last_fields[1]
783
last_loc = bisect.bisect_right(post, last_dir)
785
middle_files = post[:last_loc]
786
post = post[last_loc:]
789
# We have files that should occur in this block
790
# (>= first, <= last)
791
# Either we will find them here, or we can mark them as
794
if middle_files[0] == first_dir:
795
# We might need to go before this location
796
pre.append(first_dir)
797
if middle_files[-1] == last_dir:
798
post.insert(0, last_dir)
800
# Find out what paths we have
801
paths = {first_dir:[first_fields]}
802
# last_dir might == first_dir so we need to be
803
# careful if we should append rather than overwrite
804
if last_entry_num != first_entry_num:
805
paths.setdefault(last_dir, []).append(last_fields)
806
for num in xrange(first_entry_num+1, last_entry_num):
807
# TODO: jam 20070223 We are already splitting here, so
808
# shouldn't we just split the whole thing rather
809
# than doing the split again in add_one_record?
810
fields = entries[num].split('\0')
811
paths.setdefault(fields[1], []).append(fields)
813
for cur_dir in middle_files:
814
for fields in paths.get(cur_dir, []):
815
# offset by 1 because of the opening '\0'
816
# consider changing fields_to_entry to avoid the
818
entry = fields_to_entry(fields[1:])
819
found.setdefault(cur_dir, []).append(entry)
821
# Now we have split up everything into pre, middle, and post, and
822
# we have handled everything that fell in 'middle'.
823
# We add 'post' first, so that we prefer to seek towards the
824
# beginning, so that we will tend to go as early as we need, and
825
# then only seek forward after that.
827
pending.append((after, high, post))
829
pending.append((low, start-1, pre))
833
def _bisect_recursive(self, paths):
834
"""Bisect for entries for all paths and their children.
836
This will use bisect to find all records for the supplied paths. It
837
will then continue to bisect for any records which are marked as
838
directories. (and renames?)
840
:param paths: A sorted list of (dir, name) pairs
841
eg: [('', 'a'), ('', 'f'), ('a/b', 'c')]
842
:return: A dictionary mapping (dir, name, file_id) => [tree_info]
844
# Map from (dir, name, file_id) => [tree_info]
847
found_dir_names = set()
849
# Directories that have been read
850
processed_dirs = set()
851
# Get the ball rolling with the first bisect for all entries.
852
newly_found = self._bisect(paths)
855
# Directories that need to be read
857
paths_to_search = set()
858
for entry_list in newly_found.itervalues():
859
for dir_name_id, trees_info in entry_list:
860
found[dir_name_id] = trees_info
861
found_dir_names.add(dir_name_id[:2])
863
for tree_info in trees_info:
864
minikind = tree_info[0]
867
# We already processed this one as a directory,
868
# we don't need to do the extra work again.
870
subdir, name, file_id = dir_name_id
871
path = osutils.pathjoin(subdir, name)
873
if path not in processed_dirs:
874
pending_dirs.add(path)
875
elif minikind == 'r':
876
# Rename, we need to directly search the target
877
# which is contained in the fingerprint column
878
dir_name = osutils.split(tree_info[1])
879
if dir_name[0] in pending_dirs:
880
# This entry will be found in the dir search
882
if dir_name not in found_dir_names:
883
paths_to_search.add(tree_info[1])
884
# Now we have a list of paths to look for directly, and
885
# directory blocks that need to be read.
886
# newly_found is mixing the keys between (dir, name) and path
887
# entries, but that is okay, because we only really care about the
889
newly_found = self._bisect(sorted(paths_to_search))
890
newly_found.update(self._bisect_dirblocks(sorted(pending_dirs)))
891
processed_dirs.update(pending_dirs)
894
def _empty_parent_info(self):
895
return [DirState.NULL_PARENT_DETAILS] * (len(self._parents) -
898
def _ensure_block(self, parent_block_index, parent_row_index, dirname):
899
"""Ensure a block for dirname exists.
901
This function exists to let callers which know that there is a
902
directory dirname ensure that the block for it exists. This block can
903
fail to exist because of demand loading, or because a directory had no
904
children. In either case it is not an error. It is however an error to
905
call this if there is no parent entry for the directory, and thus the
906
function requires the coordinates of such an entry to be provided.
908
The root row is special cased and can be indicated with a parent block
911
:param parent_block_index: The index of the block in which dirname's row
913
:param parent_row_index: The index in the parent block where the row
915
:param dirname: The utf8 dirname to ensure there is a block for.
916
:return: The index for the block.
918
if dirname == '' and parent_row_index == 0 and parent_block_index == 0:
919
# This is the signature of the root row, and the
920
# contents-of-root row is always index 1
922
# the basename of the directory must be the end of its full name.
923
if not (parent_block_index == -1 and
924
parent_block_index == -1 and dirname == ''):
925
assert dirname.endswith(
926
self._dirblocks[parent_block_index][1][parent_row_index][0][1])
927
block_index, present = self._find_block_index_from_key((dirname, '', ''))
929
## In future, when doing partial parsing, this should load and
930
# populate the entire block.
931
self._dirblocks.insert(block_index, (dirname, []))
934
def _entries_to_current_state(self, new_entries):
935
"""Load new_entries into self.dirblocks.
937
Process new_entries into the current state object, making them the active
938
state. The entries are grouped together by directory to form dirblocks.
940
:param new_entries: A sorted list of entries. This function does not sort
941
to prevent unneeded overhead when callers have a sorted list already.
944
assert new_entries[0][0][0:2] == ('', ''), \
945
"Missing root row %r" % (new_entries[0][0],)
946
# The two blocks here are deliberate: the root block and the
947
# contents-of-root block.
948
self._dirblocks = [('', []), ('', [])]
949
current_block = self._dirblocks[0][1]
952
append_entry = current_block.append
953
for entry in new_entries:
954
if entry[0][0] != current_dirname:
955
# new block - different dirname
957
current_dirname = entry[0][0]
958
self._dirblocks.append((current_dirname, current_block))
959
append_entry = current_block.append
960
# append the entry to the current block
962
self._split_root_dirblock_into_contents()
964
def _split_root_dirblock_into_contents(self):
965
"""Split the root dirblocks into root and contents-of-root.
967
After parsing by path, we end up with root entries and contents-of-root
968
entries in the same block. This loop splits them out again.
970
# The above loop leaves the "root block" entries mixed with the
971
# "contents-of-root block". But we don't want an if check on
972
# all entries, so instead we just fix it up here.
973
assert self._dirblocks[1] == ('', [])
975
contents_of_root_block = []
976
for entry in self._dirblocks[0][1]:
977
if not entry[0][1]: # This is a root entry
978
root_block.append(entry)
980
contents_of_root_block.append(entry)
981
self._dirblocks[0] = ('', root_block)
982
self._dirblocks[1] = ('', contents_of_root_block)
984
def _entry_to_line(self, entry):
985
"""Serialize entry to a NULL delimited line ready for _get_output_lines.
987
:param entry: An entry_tuple as defined in the module docstring.
989
entire_entry = list(entry[0])
990
for tree_number, tree_data in enumerate(entry[1]):
991
# (minikind, fingerprint, size, executable, tree_specific_string)
992
entire_entry.extend(tree_data)
993
# 3 for the key, 5 for the fields per tree.
994
tree_offset = 3 + tree_number * 5
996
entire_entry[tree_offset + 0] = tree_data[0]
998
entire_entry[tree_offset + 2] = str(tree_data[2])
1000
entire_entry[tree_offset + 3] = DirState._to_yesno[tree_data[3]]
1001
return '\0'.join(entire_entry)
1003
def _fields_per_entry(self):
1004
"""How many null separated fields should be in each entry row.
1006
Each line now has an extra '\n' field which is not used
1007
so we just skip over it
1009
3 fields for the key
1010
+ number of fields per tree_data (5) * tree count
1013
tree_count = 1 + self._num_present_parents()
1014
return 3 + 5 * tree_count + 1
1016
def _find_block(self, key, add_if_missing=False):
1017
"""Return the block that key should be present in.
1019
:param key: A dirstate entry key.
1020
:return: The block tuple.
1022
block_index, present = self._find_block_index_from_key(key)
1024
if not add_if_missing:
1025
# check to see if key is versioned itself - we might want to
1026
# add it anyway, because dirs with no entries dont get a
1027
# dirblock at parse time.
1028
# This is an uncommon branch to take: most dirs have children,
1029
# and most code works with versioned paths.
1030
parent_base, parent_name = osutils.split(key[0])
1031
if not self._get_block_entry_index(parent_base, parent_name, 0)[3]:
1032
# some parent path has not been added - its an error to add
1034
raise errors.NotVersionedError(key[0:2], str(self))
1035
self._dirblocks.insert(block_index, (key[0], []))
1036
return self._dirblocks[block_index]
1038
def _find_block_index_from_key(self, key):
1039
"""Find the dirblock index for a key.
1041
:return: The block index, True if the block for the key is present.
1043
if key[0:2] == ('', ''):
1045
block_index = bisect_dirblock(self._dirblocks, key[0], 1,
1046
cache=self._split_path_cache)
1047
# _right returns one-past-where-key is so we have to subtract
1048
# one to use it. we use _right here because there are two
1049
# '' blocks - the root, and the contents of root
1050
# we always have a minimum of 2 in self._dirblocks: root and
1051
# root-contents, and for '', we get 2 back, so this is
1052
# simple and correct:
1053
present = (block_index < len(self._dirblocks) and
1054
self._dirblocks[block_index][0] == key[0])
1055
return block_index, present
1057
def _find_entry_index(self, key, block):
1058
"""Find the entry index for a key in a block.
1060
:return: The entry index, True if the entry for the key is present.
1062
entry_index = bisect.bisect_left(block, (key, []))
1063
present = (entry_index < len(block) and
1064
block[entry_index][0] == key)
1065
return entry_index, present
1068
def from_tree(tree, dir_state_filename):
1069
"""Create a dirstate from a bzr Tree.
1071
:param tree: The tree which should provide parent information and
1073
:return: a DirState object which is currently locked for writing.
1074
(it was locked by DirState.initialize)
1076
result = DirState.initialize(dir_state_filename)
1080
parent_ids = tree.get_parent_ids()
1081
num_parents = len(parent_ids)
1083
for parent_id in parent_ids:
1084
parent_tree = tree.branch.repository.revision_tree(parent_id)
1085
parent_trees.append((parent_id, parent_tree))
1086
parent_tree.lock_read()
1087
result.set_parent_trees(parent_trees, [])
1088
result.set_state_from_inventory(tree.inventory)
1090
for revid, parent_tree in parent_trees:
1091
parent_tree.unlock()
1094
# The caller won't have a chance to unlock this, so make sure we
1100
def update_entry(self, entry, abspath, stat_value,
1101
_stat_to_minikind=_stat_to_minikind,
1102
_pack_stat=pack_stat):
1103
"""Update the entry based on what is actually on disk.
1105
:param entry: This is the dirblock entry for the file in question.
1106
:param abspath: The path on disk for this file.
1107
:param stat_value: (optional) if we already have done a stat on the
1109
:return: The sha1 hexdigest of the file (40 bytes) or link target of a
1113
minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
1117
packed_stat = _pack_stat(stat_value)
1118
(saved_minikind, saved_link_or_sha1, saved_file_size,
1119
saved_executable, saved_packed_stat) = entry[1][0]
1121
if (minikind == saved_minikind
1122
and packed_stat == saved_packed_stat):
1123
# The stat hasn't changed since we saved, so we can re-use the
1128
# size should also be in packed_stat
1129
if saved_file_size == stat_value.st_size:
1130
return saved_link_or_sha1
1132
# If we have gotten this far, that means that we need to actually
1133
# process this entry.
1136
link_or_sha1 = self._sha1_file(abspath)
1137
executable = self._is_executable(stat_value.st_mode,
1139
if self._cutoff_time is None:
1140
self._sha_cutoff_time()
1141
if (stat_value.st_mtime < self._cutoff_time
1142
and stat_value.st_ctime < self._cutoff_time):
1143
entry[1][0] = ('f', link_or_sha1, stat_value.st_size,
1144
executable, packed_stat)
1146
entry[1][0] = ('f', '', stat_value.st_size,
1147
executable, DirState.NULLSTAT)
1148
elif minikind == 'd':
1150
entry[1][0] = ('d', '', 0, False, packed_stat)
1151
if saved_minikind != 'd':
1152
# This changed from something into a directory. Make sure we
1153
# have a directory block for it. This doesn't happen very
1154
# often, so this doesn't have to be super fast.
1155
block_index, entry_index, dir_present, file_present = \
1156
self._get_block_entry_index(entry[0][0], entry[0][1], 0)
1157
self._ensure_block(block_index, entry_index,
1158
osutils.pathjoin(entry[0][0], entry[0][1]))
1159
elif minikind == 'l':
1160
link_or_sha1 = self._read_link(abspath, saved_link_or_sha1)
1161
if self._cutoff_time is None:
1162
self._sha_cutoff_time()
1163
if (stat_value.st_mtime < self._cutoff_time
1164
and stat_value.st_ctime < self._cutoff_time):
1165
entry[1][0] = ('l', link_or_sha1, stat_value.st_size,
1168
entry[1][0] = ('l', '', stat_value.st_size,
1169
False, DirState.NULLSTAT)
1170
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1173
def _sha_cutoff_time(self):
1174
"""Return cutoff time.
1176
Files modified more recently than this time are at risk of being
1177
undetectably modified and so can't be cached.
1179
# Cache the cutoff time as long as we hold a lock.
1180
# time.time() isn't super expensive (approx 3.38us), but
1181
# when you call it 50,000 times it adds up.
1182
# For comparison, os.lstat() costs 7.2us if it is hot.
1183
self._cutoff_time = int(time.time()) - 3
1184
return self._cutoff_time
1186
def _lstat(self, abspath, entry):
1187
"""Return the os.lstat value for this path."""
1188
return os.lstat(abspath)
1190
def _sha1_file_and_mutter(self, abspath):
1191
# when -Dhashcache is turned on, this is monkey-patched in to log
1193
trace.mutter("dirstate sha1 " + abspath)
1194
return osutils.sha_file_by_name(abspath)
1196
def _is_executable(self, mode, old_executable):
1197
"""Is this file executable?"""
1198
return bool(S_IEXEC & mode)
1200
def _is_executable_win32(self, mode, old_executable):
1201
"""On win32 the executable bit is stored in the dirstate."""
1202
return old_executable
1204
if sys.platform == 'win32':
1205
_is_executable = _is_executable_win32
1207
def _read_link(self, abspath, old_link):
1208
"""Read the target of a symlink"""
1209
# TODO: jam 200700301 On Win32, this could just return the value
1210
# already in memory. However, this really needs to be done at a
1211
# higher level, because there either won't be anything on disk,
1212
# or the thing on disk will be a file.
1213
return os.readlink(abspath)
1215
def get_ghosts(self):
1216
"""Return a list of the parent tree revision ids that are ghosts."""
1217
self._read_header_if_needed()
1220
def get_lines(self):
1221
"""Serialise the entire dirstate to a sequence of lines."""
1222
if (self._header_state == DirState.IN_MEMORY_UNMODIFIED and
1223
self._dirblock_state == DirState.IN_MEMORY_UNMODIFIED):
1224
# read whats on disk.
1225
self._state_file.seek(0)
1226
return self._state_file.readlines()
1228
lines.append(self._get_parents_line(self.get_parent_ids()))
1229
lines.append(self._get_ghosts_line(self._ghosts))
1230
# append the root line which is special cased
1231
lines.extend(map(self._entry_to_line, self._iter_entries()))
1232
return self._get_output_lines(lines)
1234
def _get_ghosts_line(self, ghost_ids):
1235
"""Create a line for the state file for ghost information."""
1236
return '\0'.join([str(len(ghost_ids))] + ghost_ids)
1238
def _get_parents_line(self, parent_ids):
1239
"""Create a line for the state file for parents information."""
1240
return '\0'.join([str(len(parent_ids))] + parent_ids)
1242
def _get_fields_to_entry(self):
1243
"""Get a function which converts entry fields into a entry record.
1245
This handles size and executable, as well as parent records.
1247
:return: A function which takes a list of fields, and returns an
1248
appropriate record for storing in memory.
1250
# This is intentionally unrolled for performance
1251
num_present_parents = self._num_present_parents()
1252
if num_present_parents == 0:
1253
def fields_to_entry_0_parents(fields, _int=int):
1254
path_name_file_id_key = (fields[0], fields[1], fields[2])
1255
return (path_name_file_id_key, [
1257
fields[3], # minikind
1258
fields[4], # fingerprint
1259
_int(fields[5]), # size
1260
fields[6] == 'y', # executable
1261
fields[7], # packed_stat or revision_id
1263
return fields_to_entry_0_parents
1264
elif num_present_parents == 1:
1265
def fields_to_entry_1_parent(fields, _int=int):
1266
path_name_file_id_key = (fields[0], fields[1], fields[2])
1267
return (path_name_file_id_key, [
1269
fields[3], # minikind
1270
fields[4], # fingerprint
1271
_int(fields[5]), # size
1272
fields[6] == 'y', # executable
1273
fields[7], # packed_stat or revision_id
1276
fields[8], # minikind
1277
fields[9], # fingerprint
1278
_int(fields[10]), # size
1279
fields[11] == 'y', # executable
1280
fields[12], # packed_stat or revision_id
1283
return fields_to_entry_1_parent
1284
elif num_present_parents == 2:
1285
def fields_to_entry_2_parents(fields, _int=int):
1286
path_name_file_id_key = (fields[0], fields[1], fields[2])
1287
return (path_name_file_id_key, [
1289
fields[3], # minikind
1290
fields[4], # fingerprint
1291
_int(fields[5]), # size
1292
fields[6] == 'y', # executable
1293
fields[7], # packed_stat or revision_id
1296
fields[8], # minikind
1297
fields[9], # fingerprint
1298
_int(fields[10]), # size
1299
fields[11] == 'y', # executable
1300
fields[12], # packed_stat or revision_id
1303
fields[13], # minikind
1304
fields[14], # fingerprint
1305
_int(fields[15]), # size
1306
fields[16] == 'y', # executable
1307
fields[17], # packed_stat or revision_id
1310
return fields_to_entry_2_parents
1312
def fields_to_entry_n_parents(fields, _int=int):
1313
path_name_file_id_key = (fields[0], fields[1], fields[2])
1314
trees = [(fields[cur], # minikind
1315
fields[cur+1], # fingerprint
1316
_int(fields[cur+2]), # size
1317
fields[cur+3] == 'y', # executable
1318
fields[cur+4], # stat or revision_id
1319
) for cur in xrange(3, len(fields)-1, 5)]
1320
return path_name_file_id_key, trees
1321
return fields_to_entry_n_parents
1323
def get_parent_ids(self):
1324
"""Return a list of the parent tree ids for the directory state."""
1325
self._read_header_if_needed()
1326
return list(self._parents)
1328
def _get_block_entry_index(self, dirname, basename, tree_index):
1329
"""Get the coordinates for a path in the state structure.
1331
:param dirname: The utf8 dirname to lookup.
1332
:param basename: The utf8 basename to lookup.
1333
:param tree_index: The index of the tree for which this lookup should
1335
:return: A tuple describing where the path is located, or should be
1336
inserted. The tuple contains four fields: the block index, the row
1337
index, the directory is present (boolean), the entire path is
1338
present (boolean). There is no guarantee that either
1339
coordinate is currently reachable unless the found field for it is
1340
True. For instance, a directory not present in the searched tree
1341
may be returned with a value one greater than the current highest
1342
block offset. The directory present field will always be True when
1343
the path present field is True. The directory present field does
1344
NOT indicate that the directory is present in the searched tree,
1345
rather it indicates that there are at least some files in some
1348
self._read_dirblocks_if_needed()
1349
key = dirname, basename, ''
1350
block_index, present = self._find_block_index_from_key(key)
1352
# no such directory - return the dir index and 0 for the row.
1353
return block_index, 0, False, False
1354
block = self._dirblocks[block_index][1] # access the entries only
1355
entry_index, present = self._find_entry_index(key, block)
1356
# linear search through present entries at this path to find the one
1358
while entry_index < len(block) and block[entry_index][0][1] == basename:
1359
if block[entry_index][1][tree_index][0] not in \
1360
('a', 'r'): # absent, relocated
1361
return block_index, entry_index, True, True
1363
return block_index, entry_index, True, False
1365
def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None):
1366
"""Get the dirstate entry for path in tree tree_index.
1368
If either file_id or path is supplied, it is used as the key to lookup.
1369
If both are supplied, the fastest lookup is used, and an error is
1370
raised if they do not both point at the same row.
1372
:param tree_index: The index of the tree we wish to locate this path
1373
in. If the path is present in that tree, the entry containing its
1374
details is returned, otherwise (None, None) is returned
1375
0 is the working tree, higher indexes are successive parent
1377
:param fileid_utf8: A utf8 file_id to look up.
1378
:param path_utf8: An utf8 path to be looked up.
1379
:return: The dirstate entry tuple for path, or (None, None)
1381
self._read_dirblocks_if_needed()
1382
if path_utf8 is not None:
1383
assert path_utf8.__class__ == str, 'path_utf8 is not a str: %s %s' % (type(path_utf8), path_utf8)
1384
# path lookups are faster
1385
dirname, basename = osutils.split(path_utf8)
1386
block_index, entry_index, dir_present, file_present = \
1387
self._get_block_entry_index(dirname, basename, tree_index)
1388
if not file_present:
1390
entry = self._dirblocks[block_index][1][entry_index]
1391
assert entry[0][2] and entry[1][tree_index][0] not in ('a', 'r'), 'unversioned entry?!?!'
1393
if entry[0][2] != fileid_utf8:
1394
raise errors.BzrError('integrity error ? : mismatching'
1395
' tree_index, file_id and path')
1398
assert fileid_utf8 is not None
1399
possible_keys = self._get_id_index().get(fileid_utf8, None)
1400
if not possible_keys:
1402
for key in possible_keys:
1403
block_index, present = \
1404
self._find_block_index_from_key(key)
1405
# strange, probably indicates an out of date
1406
# id index - for now, allow this.
1409
# WARNING: DO not change this code to use _get_block_entry_index
1410
# as that function is not suitable: it does not use the key
1411
# to lookup, and thus the wrong coordinates are returned.
1412
block = self._dirblocks[block_index][1]
1413
entry_index, present = self._find_entry_index(key, block)
1415
entry = self._dirblocks[block_index][1][entry_index]
1416
if entry[1][tree_index][0] in 'fdlt':
1417
# this is the result we are looking for: the
1418
# real home of this file_id in this tree.
1420
if entry[1][tree_index][0] == 'a':
1421
# there is no home for this entry in this tree
1423
assert entry[1][tree_index][0] == 'r', \
1424
"entry %r has invalid minikind %r for tree %r" \
1426
entry[1][tree_index][0],
1428
real_path = entry[1][tree_index][1]
1429
return self._get_entry(tree_index, fileid_utf8=fileid_utf8,
1430
path_utf8=real_path)
1434
def initialize(cls, path):
1435
"""Create a new dirstate on path.
1437
The new dirstate will be an empty tree - that is it has no parents,
1438
and only a root node - which has id ROOT_ID.
1440
:param path: The name of the file for the dirstate.
1441
:return: A write-locked DirState object.
1443
# This constructs a new DirState object on a path, sets the _state_file
1444
# to a new empty file for that path. It then calls _set_data() with our
1445
# stock empty dirstate information - a root with ROOT_ID, no children,
1446
# and no parents. Finally it calls save() to ensure that this data will
1449
# root dir and root dir contents with no children.
1450
empty_tree_dirblocks = [('', []), ('', [])]
1451
# a new root directory, with a NULLSTAT.
1452
empty_tree_dirblocks[0][1].append(
1453
(('', '', inventory.ROOT_ID), [
1454
('d', '', 0, False, DirState.NULLSTAT),
1458
result._set_data([], empty_tree_dirblocks)
1465
def _inv_entry_to_details(self, inv_entry):
1466
"""Convert an inventory entry (from a revision tree) to state details.
1468
:param inv_entry: An inventory entry whose sha1 and link targets can be
1469
relied upon, and which has a revision set.
1470
:return: A details tuple - the details for a single tree at a path +
1473
kind = inv_entry.kind
1474
minikind = DirState._kind_to_minikind[kind]
1475
tree_data = inv_entry.revision
1476
assert tree_data, 'empty revision for the inv_entry %s.' % \
1478
if kind == 'directory':
1482
elif kind == 'symlink':
1483
fingerprint = inv_entry.symlink_target or ''
1486
elif kind == 'file':
1487
fingerprint = inv_entry.text_sha1 or ''
1488
size = inv_entry.text_size or 0
1489
executable = inv_entry.executable
1490
elif kind == 'tree-reference':
1491
fingerprint = inv_entry.reference_revision or ''
1495
raise Exception("can't pack %s" % inv_entry)
1496
return (minikind, fingerprint, size, executable, tree_data)
1498
def _iter_entries(self):
1499
"""Iterate over all the entries in the dirstate.
1501
Each yelt item is an entry in the standard format described in the
1502
docstring of bzrlib.dirstate.
1504
self._read_dirblocks_if_needed()
1505
for directory in self._dirblocks:
1506
for entry in directory[1]:
1509
def _get_id_index(self):
1510
"""Get an id index of self._dirblocks."""
1511
if self._id_index is None:
1513
for key, tree_details in self._iter_entries():
1514
id_index.setdefault(key[2], set()).add(key)
1515
self._id_index = id_index
1516
return self._id_index
1518
def _get_output_lines(self, lines):
1519
"""Format lines for final output.
1521
:param lines: A sequence of lines containing the parents list and the
1524
output_lines = [DirState.HEADER_FORMAT_3]
1525
lines.append('') # a final newline
1526
inventory_text = '\0\n\0'.join(lines)
1527
output_lines.append('crc32: %s\n' % (zlib.crc32(inventory_text),))
1528
# -3, 1 for num parents, 1 for ghosts, 1 for final newline
1529
num_entries = len(lines)-3
1530
output_lines.append('num_entries: %s\n' % (num_entries,))
1531
output_lines.append(inventory_text)
1534
def _make_deleted_row(self, fileid_utf8, parents):
1535
"""Return a deleted row for fileid_utf8."""
1536
return ('/', 'RECYCLED.BIN', 'file', fileid_utf8, 0, DirState.NULLSTAT,
1539
def _num_present_parents(self):
1540
"""The number of parent entries in each record row."""
1541
return len(self._parents) - len(self._ghosts)
1545
"""Construct a DirState on the file at path path.
1547
:return: An unlocked DirState object, associated with the given path.
1549
result = DirState(path)
1552
def _read_dirblocks_if_needed(self):
1553
"""Read in all the dirblocks from the file if they are not in memory.
1555
This populates self._dirblocks, and sets self._dirblock_state to
1556
IN_MEMORY_UNMODIFIED. It is not currently ready for incremental block
1559
self._read_header_if_needed()
1560
if self._dirblock_state == DirState.NOT_IN_MEMORY:
1561
_read_dirblocks(self)
1563
def _read_header(self):
1564
"""This reads in the metadata header, and the parent ids.
1566
After reading in, the file should be positioned at the null
1567
just before the start of the first record in the file.
1569
:return: (expected crc checksum, number of entries, parent list)
1571
self._read_prelude()
1572
parent_line = self._state_file.readline()
1573
info = parent_line.split('\0')
1574
num_parents = int(info[0])
1575
assert num_parents == len(info)-2, 'incorrect parent info line'
1576
self._parents = info[1:-1]
1578
ghost_line = self._state_file.readline()
1579
info = ghost_line.split('\0')
1580
num_ghosts = int(info[1])
1581
assert num_ghosts == len(info)-3, 'incorrect ghost info line'
1582
self._ghosts = info[2:-1]
1583
self._header_state = DirState.IN_MEMORY_UNMODIFIED
1584
self._end_of_header = self._state_file.tell()
1586
def _read_header_if_needed(self):
1587
"""Read the header of the dirstate file if needed."""
1588
# inline this as it will be called a lot
1589
if not self._lock_token:
1590
raise errors.ObjectNotLocked(self)
1591
if self._header_state == DirState.NOT_IN_MEMORY:
1594
def _read_prelude(self):
1595
"""Read in the prelude header of the dirstate file.
1597
This only reads in the stuff that is not connected to the crc
1598
checksum. The position will be correct to read in the rest of
1599
the file and check the checksum after this point.
1600
The next entry in the file should be the number of parents,
1601
and their ids. Followed by a newline.
1603
header = self._state_file.readline()
1604
assert header == DirState.HEADER_FORMAT_3, \
1605
'invalid header line: %r' % (header,)
1606
crc_line = self._state_file.readline()
1607
assert crc_line.startswith('crc32: '), 'missing crc32 checksum'
1608
self.crc_expected = int(crc_line[len('crc32: '):-1])
1609
num_entries_line = self._state_file.readline()
1610
assert num_entries_line.startswith('num_entries: '), 'missing num_entries line'
1611
self._num_entries = int(num_entries_line[len('num_entries: '):-1])
1614
"""Save any pending changes created during this session.
1616
We reuse the existing file, because that prevents race conditions with
1617
file creation, and use oslocks on it to prevent concurrent modification
1618
and reads - because dirstate's incremental data aggregation is not
1619
compatible with reading a modified file, and replacing a file in use by
1620
another process is impossible on Windows.
1622
A dirstate in read only mode should be smart enough though to validate
1623
that the file has not changed, and otherwise discard its cache and
1624
start over, to allow for fine grained read lock duration, so 'status'
1625
wont block 'commit' - for example.
1627
if (self._header_state == DirState.IN_MEMORY_MODIFIED or
1628
self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
1630
grabbed_write_lock = False
1631
if self._lock_state != 'w':
1632
grabbed_write_lock, new_lock = self._lock_token.temporary_write_lock()
1633
# Switch over to the new lock, as the old one may be closed.
1634
# TODO: jam 20070315 We should validate the disk file has
1635
# not changed contents. Since temporary_write_lock may
1636
# not be an atomic operation.
1637
self._lock_token = new_lock
1638
self._state_file = new_lock.f
1639
if not grabbed_write_lock:
1640
# We couldn't grab a write lock, so we switch back to a read one
1643
self._state_file.seek(0)
1644
self._state_file.writelines(self.get_lines())
1645
self._state_file.truncate()
1646
self._state_file.flush()
1647
self._header_state = DirState.IN_MEMORY_UNMODIFIED
1648
self._dirblock_state = DirState.IN_MEMORY_UNMODIFIED
1650
if grabbed_write_lock:
1651
self._lock_token = self._lock_token.restore_read_lock()
1652
self._state_file = self._lock_token.f
1653
# TODO: jam 20070315 We should validate the disk file has
1654
# not changed contents. Since restore_read_lock may
1655
# not be an atomic operation.
1657
def _set_data(self, parent_ids, dirblocks):
1658
"""Set the full dirstate data in memory.
1660
This is an internal function used to completely replace the objects
1661
in memory state. It puts the dirstate into state 'full-dirty'.
1663
:param parent_ids: A list of parent tree revision ids.
1664
:param dirblocks: A list containing one tuple for each directory in the
1665
tree. Each tuple contains the directory path and a list of entries
1666
found in that directory.
1668
# our memory copy is now authoritative.
1669
self._dirblocks = dirblocks
1670
self._header_state = DirState.IN_MEMORY_MODIFIED
1671
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1672
self._parents = list(parent_ids)
1673
self._id_index = None
1675
def set_path_id(self, path, new_id):
1676
"""Change the id of path to new_id in the current working tree.
1678
:param path: The path inside the tree to set - '' is the root, 'foo'
1679
is the path foo in the root.
1680
:param new_id: The new id to assign to the path. This must be a utf8
1681
file id (not unicode, and not None).
1683
assert new_id.__class__ == str, \
1684
"path_id %r is not a plain string" % (new_id,)
1685
self._read_dirblocks_if_needed()
1687
# TODO: logic not written
1688
raise NotImplementedError(self.set_path_id)
1689
# TODO: check new id is unique
1690
entry = self._get_entry(0, path_utf8=path)
1691
if entry[0][2] == new_id:
1692
# Nothing to change.
1694
# mark the old path absent, and insert a new root path
1695
self._make_absent(entry)
1696
self.update_minimal(('', '', new_id), 'd',
1697
path_utf8='', packed_stat=entry[1][0][4])
1698
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1699
if self._id_index is not None:
1700
self._id_index.setdefault(new_id, set()).add(entry[0])
1702
def set_parent_trees(self, trees, ghosts):
1703
"""Set the parent trees for the dirstate.
1705
:param trees: A list of revision_id, tree tuples. tree must be provided
1706
even if the revision_id refers to a ghost: supply an empty tree in
1708
:param ghosts: A list of the revision_ids that are ghosts at the time
1711
# TODO: generate a list of parent indexes to preserve to save
1712
# processing specific parent trees. In the common case one tree will
1713
# be preserved - the left most parent.
1714
# TODO: if the parent tree is a dirstate, we might want to walk them
1715
# all by path in parallel for 'optimal' common-case performance.
1716
# generate new root row.
1717
self._read_dirblocks_if_needed()
1718
# TODO future sketch: Examine the existing parents to generate a change
1719
# map and then walk the new parent trees only, mapping them into the
1720
# dirstate. Walk the dirstate at the same time to remove unreferenced
1723
# sketch: loop over all entries in the dirstate, cherry picking
1724
# entries from the parent trees, if they are not ghost trees.
1725
# after we finish walking the dirstate, all entries not in the dirstate
1726
# are deletes, so we want to append them to the end as per the design
1727
# discussions. So do a set difference on ids with the parents to
1728
# get deletes, and add them to the end.
1729
# During the update process we need to answer the following questions:
1730
# - find other keys containing a fileid in order to create cross-path
1731
# links. We dont't trivially use the inventory from other trees
1732
# because this leads to either double touching, or to accessing
1734
# - find other keys containing a path
1735
# We accumulate each entry via this dictionary, including the root
1738
# we could do parallel iterators, but because file id data may be
1739
# scattered throughout, we dont save on index overhead: we have to look
1740
# at everything anyway. We can probably save cycles by reusing parent
1741
# data and doing an incremental update when adding an additional
1742
# parent, but for now the common cases are adding a new parent (merge),
1743
# and replacing completely (commit), and commit is more common: so
1744
# optimise merge later.
1746
# ---- start generation of full tree mapping data
1747
# what trees should we use?
1748
parent_trees = [tree for rev_id, tree in trees if rev_id not in ghosts]
1749
# how many trees do we end up with
1750
parent_count = len(parent_trees)
1752
# one: the current tree
1753
for entry in self._iter_entries():
1754
# skip entries not in the current tree
1755
if entry[1][0][0] in ('a', 'r'): # absent, relocated
1757
by_path[entry[0]] = [entry[1][0]] + \
1758
[DirState.NULL_PARENT_DETAILS] * parent_count
1759
id_index[entry[0][2]] = set([entry[0]])
1761
# now the parent trees:
1762
for tree_index, tree in enumerate(parent_trees):
1763
# the index is off by one, adjust it.
1764
tree_index = tree_index + 1
1765
# when we add new locations for a fileid we need these ranges for
1766
# any fileid in this tree as we set the by_path[id] to:
1767
# already_processed_tree_details + new_details + new_location_suffix
1768
# the suffix is from tree_index+1:parent_count+1.
1769
new_location_suffix = [DirState.NULL_PARENT_DETAILS] * (parent_count - tree_index)
1770
# now stitch in all the entries from this tree
1771
for path, entry in tree.inventory.iter_entries_by_dir():
1772
# here we process each trees details for each item in the tree.
1773
# we first update any existing entries for the id at other paths,
1774
# then we either create or update the entry for the id at the
1775
# right path, and finally we add (if needed) a mapping from
1776
# file_id to this path. We do it in this order to allow us to
1777
# avoid checking all known paths for the id when generating a
1778
# new entry at this path: by adding the id->path mapping last,
1779
# all the mappings are valid and have correct relocation
1780
# records where needed.
1781
file_id = entry.file_id
1782
path_utf8 = path.encode('utf8')
1783
dirname, basename = osutils.split(path_utf8)
1784
new_entry_key = (dirname, basename, file_id)
1785
# tree index consistency: All other paths for this id in this tree
1786
# index must point to the correct path.
1787
for entry_key in id_index.setdefault(file_id, set()):
1788
# TODO:PROFILING: It might be faster to just update
1789
# rather than checking if we need to, and then overwrite
1790
# the one we are located at.
1791
if entry_key != new_entry_key:
1792
# this file id is at a different path in one of the
1793
# other trees, so put absent pointers there
1794
# This is the vertical axis in the matrix, all pointing
1796
by_path[entry_key][tree_index] = ('r', path_utf8, 0, False, '')
1797
# by path consistency: Insert into an existing path record (trivial), or
1798
# add a new one with relocation pointers for the other tree indexes.
1799
if new_entry_key in id_index[file_id]:
1800
# there is already an entry where this data belongs, just insert it.
1801
by_path[new_entry_key][tree_index] = \
1802
self._inv_entry_to_details(entry)
1804
# add relocated entries to the horizontal axis - this row
1805
# mapping from path,id. We need to look up the correct path
1806
# for the indexes from 0 to tree_index -1
1808
for lookup_index in xrange(tree_index):
1809
# boundary case: this is the first occurence of file_id
1810
# so there are no id_indexs, possibly take this out of
1812
if not len(id_index[file_id]):
1813
new_details.append(DirState.NULL_PARENT_DETAILS)
1815
# grab any one entry, use it to find the right path.
1816
# TODO: optimise this to reduce memory use in highly
1817
# fragmented situations by reusing the relocation
1819
a_key = iter(id_index[file_id]).next()
1820
if by_path[a_key][lookup_index][0] in ('r', 'a'):
1821
# its a pointer or missing statement, use it as is.
1822
new_details.append(by_path[a_key][lookup_index])
1824
# we have the right key, make a pointer to it.
1825
real_path = ('/'.join(a_key[0:2])).strip('/')
1826
new_details.append(('r', real_path, 0, False, ''))
1827
new_details.append(self._inv_entry_to_details(entry))
1828
new_details.extend(new_location_suffix)
1829
by_path[new_entry_key] = new_details
1830
id_index[file_id].add(new_entry_key)
1831
# --- end generation of full tree mappings
1833
# sort and output all the entries
1834
new_entries = self._sort_entries(by_path.items())
1835
self._entries_to_current_state(new_entries)
1836
self._parents = [rev_id for rev_id, tree in trees]
1837
self._ghosts = list(ghosts)
1838
self._header_state = DirState.IN_MEMORY_MODIFIED
1839
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1840
self._id_index = id_index
1842
def _sort_entries(self, entry_list):
1843
"""Given a list of entries, sort them into the right order.
1845
This is done when constructing a new dirstate from trees - normally we
1846
try to keep everything in sorted blocks all the time, but sometimes
1847
it's easier to sort after the fact.
1850
# sort by: directory parts, file name, file id
1851
return entry[0][0].split('/'), entry[0][1], entry[0][2]
1852
return sorted(entry_list, key=_key)
1854
def set_state_from_inventory(self, new_inv):
1855
"""Set new_inv as the current state.
1857
This API is called by tree transform, and will usually occur with
1858
existing parent trees.
1860
:param new_inv: The inventory object to set current state from.
1862
if 'evil' in debug.debug_flags:
1863
trace.mutter_callsite(1,
1864
"set_state_from_inventory called; please mutate the tree instead")
1865
self._read_dirblocks_if_needed()
1867
# Two iterators: current data and new data, both in dirblock order.
1868
# We zip them together, which tells about entries that are new in the
1869
# inventory, or removed in the inventory, or present in both and
1872
# You might think we could just synthesize a new dirstate directly
1873
# since we're processing it in the right order. However, we need to
1874
# also consider there may be any number of parent trees and relocation
1875
# pointers, and we don't want to duplicate that here.
1876
new_iterator = new_inv.iter_entries_by_dir()
1877
# we will be modifying the dirstate, so we need a stable iterator. In
1878
# future we might write one, for now we just clone the state into a
1879
# list - which is a shallow copy.
1880
old_iterator = iter(list(self._iter_entries()))
1881
# both must have roots so this is safe:
1882
current_new = new_iterator.next()
1883
current_old = old_iterator.next()
1884
def advance(iterator):
1886
return iterator.next()
1887
except StopIteration:
1889
while current_new or current_old:
1890
# skip entries in old that are not really there
1891
if current_old and current_old[1][0][0] in ('r', 'a'):
1892
# relocated or absent
1893
current_old = advance(old_iterator)
1896
# convert new into dirblock style
1897
new_path_utf8 = current_new[0].encode('utf8')
1898
new_dirname, new_basename = osutils.split(new_path_utf8)
1899
new_id = current_new[1].file_id
1900
new_entry_key = (new_dirname, new_basename, new_id)
1901
current_new_minikind = \
1902
DirState._kind_to_minikind[current_new[1].kind]
1903
if current_new_minikind == 't':
1904
fingerprint = current_new[1].reference_revision or ''
1906
# We normally only insert or remove records, or update
1907
# them when it has significantly changed. Then we want to
1908
# erase its fingerprint. Unaffected records should
1909
# normally not be updated at all.
1912
# for safety disable variables
1913
new_path_utf8 = new_dirname = new_basename = new_id = \
1914
new_entry_key = None
1915
# 5 cases, we dont have a value that is strictly greater than everything, so
1916
# we make both end conditions explicit
1918
# old is finished: insert current_new into the state.
1919
self.update_minimal(new_entry_key, current_new_minikind,
1920
executable=current_new[1].executable,
1921
path_utf8=new_path_utf8, fingerprint=fingerprint)
1922
current_new = advance(new_iterator)
1923
elif not current_new:
1925
self._make_absent(current_old)
1926
current_old = advance(old_iterator)
1927
elif new_entry_key == current_old[0]:
1928
# same - common case
1929
# We're looking at the same path and id in both the dirstate
1930
# and inventory, so just need to update the fields in the
1931
# dirstate from the one in the inventory.
1932
# TODO: update the record if anything significant has changed.
1933
# the minimal required trigger is if the execute bit or cached
1935
if (current_old[1][0][3] != current_new[1].executable or
1936
current_old[1][0][0] != current_new_minikind):
1937
self.update_minimal(current_old[0], current_new_minikind,
1938
executable=current_new[1].executable,
1939
path_utf8=new_path_utf8, fingerprint=fingerprint)
1940
# both sides are dealt with, move on
1941
current_old = advance(old_iterator)
1942
current_new = advance(new_iterator)
1943
elif (cmp_by_dirs(new_dirname, current_old[0][0]) < 0
1944
or (new_dirname == current_old[0][0]
1945
and new_entry_key[1:] < current_old[0][1:])):
1947
# add a entry for this and advance new
1948
self.update_minimal(new_entry_key, current_new_minikind,
1949
executable=current_new[1].executable,
1950
path_utf8=new_path_utf8, fingerprint=fingerprint)
1951
current_new = advance(new_iterator)
1953
# we've advanced past the place where the old key would be,
1954
# without seeing it in the new list. so it must be gone.
1955
self._make_absent(current_old)
1956
current_old = advance(old_iterator)
1957
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1958
self._id_index = None
1960
def _make_absent(self, current_old):
1961
"""Mark current_old - an entry - as absent for tree 0.
1963
:return: True if this was the last details entry for the entry key:
1964
that is, if the underlying block has had the entry removed, thus
1965
shrinking in length.
1967
# build up paths that this id will be left at after the change is made,
1968
# so we can update their cross references in tree 0
1969
all_remaining_keys = set()
1970
# Dont check the working tree, because it's going.
1971
for details in current_old[1][1:]:
1972
if details[0] not in ('a', 'r'): # absent, relocated
1973
all_remaining_keys.add(current_old[0])
1974
elif details[0] == 'r': # relocated
1975
# record the key for the real path.
1976
all_remaining_keys.add(tuple(osutils.split(details[1])) + (current_old[0][2],))
1977
# absent rows are not present at any path.
1978
last_reference = current_old[0] not in all_remaining_keys
1980
# the current row consists entire of the current item (being marked
1981
# absent), and relocated or absent entries for the other trees:
1982
# Remove it, its meaningless.
1983
block = self._find_block(current_old[0])
1984
entry_index, present = self._find_entry_index(current_old[0], block[1])
1985
assert present, 'could not find entry for %s' % (current_old,)
1986
block[1].pop(entry_index)
1987
# if we have an id_index in use, remove this key from it for this id.
1988
if self._id_index is not None:
1989
self._id_index[current_old[0][2]].remove(current_old[0])
1990
# update all remaining keys for this id to record it as absent. The
1991
# existing details may either be the record we are making as deleted
1992
# (if there were other trees with the id present at this path), or may
1994
for update_key in all_remaining_keys:
1995
update_block_index, present = \
1996
self._find_block_index_from_key(update_key)
1997
assert present, 'could not find block for %s' % (update_key,)
1998
update_entry_index, present = \
1999
self._find_entry_index(update_key, self._dirblocks[update_block_index][1])
2000
assert present, 'could not find entry for %s' % (update_key,)
2001
update_tree_details = self._dirblocks[update_block_index][1][update_entry_index][1]
2002
# it must not be absent at the moment
2003
assert update_tree_details[0][0] != 'a' # absent
2004
update_tree_details[0] = DirState.NULL_PARENT_DETAILS
2005
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2006
return last_reference
2008
def update_minimal(self, key, minikind, executable=False, fingerprint='',
2009
packed_stat=None, size=0, path_utf8=None):
2010
"""Update an entry to the state in tree 0.
2012
This will either create a new entry at 'key' or update an existing one.
2013
It also makes sure that any other records which might mention this are
2016
:param key: (dir, name, file_id) for the new entry
2017
:param minikind: The type for the entry ('f' == 'file', 'd' ==
2019
:param executable: Should the executable bit be set?
2020
:param fingerprint: Simple fingerprint for new entry: sha1 for files,
2021
referenced revision id for subtrees, etc.
2022
:param packed_stat: Packed stat value for new entry.
2023
:param size: Size information for new entry
2024
:param path_utf8: key[0] + '/' + key[1], just passed in to avoid doing
2027
If packed_stat and fingerprint are not given, they're invalidated in
2030
block = self._find_block(key)[1]
2031
if packed_stat is None:
2032
packed_stat = DirState.NULLSTAT
2033
# XXX: Some callers pass '' as the packed_stat, and it seems to be
2034
# sometimes present in the dirstate - this seems oddly inconsistent.
2036
entry_index, present = self._find_entry_index(key, block)
2037
new_details = (minikind, fingerprint, size, executable, packed_stat)
2038
id_index = self._get_id_index()
2040
# new entry, synthesis cross reference here,
2041
existing_keys = id_index.setdefault(key[2], set())
2042
if not existing_keys:
2043
# not currently in the state, simplest case
2044
new_entry = key, [new_details] + self._empty_parent_info()
2046
# present at one or more existing other paths.
2047
# grab one of them and use it to generate parent
2048
# relocation/absent entries.
2049
new_entry = key, [new_details]
2050
for other_key in existing_keys:
2051
# change the record at other to be a pointer to this new
2052
# record. The loop looks similar to the change to
2053
# relocations when updating an existing record but its not:
2054
# the test for existing kinds is different: this can be
2055
# factored out to a helper though.
2056
other_block_index, present = self._find_block_index_from_key(other_key)
2057
assert present, 'could not find block for %s' % (other_key,)
2058
other_entry_index, present = self._find_entry_index(other_key,
2059
self._dirblocks[other_block_index][1])
2060
assert present, 'could not find entry for %s' % (other_key,)
2061
assert path_utf8 is not None
2062
self._dirblocks[other_block_index][1][other_entry_index][1][0] = \
2063
('r', path_utf8, 0, False, '')
2065
num_present_parents = self._num_present_parents()
2066
for lookup_index in xrange(1, num_present_parents + 1):
2067
# grab any one entry, use it to find the right path.
2068
# TODO: optimise this to reduce memory use in highly
2069
# fragmented situations by reusing the relocation
2071
update_block_index, present = \
2072
self._find_block_index_from_key(other_key)
2073
assert present, 'could not find block for %s' % (other_key,)
2074
update_entry_index, present = \
2075
self._find_entry_index(other_key, self._dirblocks[update_block_index][1])
2076
assert present, 'could not find entry for %s' % (other_key,)
2077
update_details = self._dirblocks[update_block_index][1][update_entry_index][1][lookup_index]
2078
if update_details[0] in ('r', 'a'): # relocated, absent
2079
# its a pointer or absent in lookup_index's tree, use
2081
new_entry[1].append(update_details)
2083
# we have the right key, make a pointer to it.
2084
pointer_path = osutils.pathjoin(*other_key[0:2])
2085
new_entry[1].append(('r', pointer_path, 0, False, ''))
2086
block.insert(entry_index, new_entry)
2087
existing_keys.add(key)
2089
# Does the new state matter?
2090
block[entry_index][1][0] = new_details
2091
# parents cannot be affected by what we do.
2092
# other occurences of this id can be found
2093
# from the id index.
2095
# tree index consistency: All other paths for this id in this tree
2096
# index must point to the correct path. We have to loop here because
2097
# we may have passed entries in the state with this file id already
2098
# that were absent - where parent entries are - and they need to be
2099
# converted to relocated.
2100
assert path_utf8 is not None
2101
for entry_key in id_index.setdefault(key[2], set()):
2102
# TODO:PROFILING: It might be faster to just update
2103
# rather than checking if we need to, and then overwrite
2104
# the one we are located at.
2105
if entry_key != key:
2106
# this file id is at a different path in one of the
2107
# other trees, so put absent pointers there
2108
# This is the vertical axis in the matrix, all pointing
2110
block_index, present = self._find_block_index_from_key(entry_key)
2112
entry_index, present = self._find_entry_index(entry_key, self._dirblocks[block_index][1])
2114
self._dirblocks[block_index][1][entry_index][1][0] = \
2115
('r', path_utf8, 0, False, '')
2116
# add a containing dirblock if needed.
2117
if new_details[0] == 'd':
2118
subdir_key = (osutils.pathjoin(*key[0:2]), '', '')
2119
block_index, present = self._find_block_index_from_key(subdir_key)
2121
self._dirblocks.insert(block_index, (subdir_key[0], []))
2123
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2125
def _validate(self):
2126
"""Check that invariants on the dirblock are correct.
2128
This can be useful in debugging; it shouldn't be necessary in
2131
This must be called with a lock held.
2133
# NOTE: This must always raise AssertionError not just assert,
2134
# otherwise it may not behave properly under python -O
2136
# TODO: All entries must have some content that's not 'a' or 'r',
2137
# otherwise it could just be removed.
2139
# TODO: All relocations must point directly to a real entry.
2141
# TODO: No repeated keys.
2144
from pprint import pformat
2145
self._read_dirblocks_if_needed()
2146
if len(self._dirblocks) > 0:
2147
if not self._dirblocks[0][0] == '':
2148
raise AssertionError(
2149
"dirblocks don't start with root block:\n" + \
2151
if len(self._dirblocks) > 1:
2152
if not self._dirblocks[1][0] == '':
2153
raise AssertionError(
2154
"dirblocks missing root directory:\n" + \
2156
# the dirblocks are sorted by their path components, name, and dir id
2157
dir_names = [d[0].split('/')
2158
for d in self._dirblocks[1:]]
2159
if dir_names != sorted(dir_names):
2160
raise AssertionError(
2161
"dir names are not in sorted order:\n" + \
2162
pformat(self._dirblocks) + \
2165
for dirblock in self._dirblocks:
2166
# within each dirblock, the entries are sorted by filename and
2168
for entry in dirblock[1]:
2169
if dirblock[0] != entry[0][0]:
2170
raise AssertionError(
2172
"doesn't match directory name in\n%r" %
2173
(entry, pformat(dirblock)))
2174
if dirblock[1] != sorted(dirblock[1]):
2175
raise AssertionError(
2176
"dirblock for %r is not sorted:\n%s" % \
2177
(dirblock[0], pformat(dirblock)))
2180
def check_valid_parent():
2181
"""Check that the current entry has a valid parent.
2183
This makes sure that the parent has a record,
2184
and that the parent isn't marked as "absent" in the
2185
current tree. (It is invalid to have a non-absent file in an absent
2188
if entry[0][0:2] == ('', ''):
2189
# There should be no parent for the root row
2191
parent_entry = self._get_entry(tree_index, path_utf8=entry[0][0])
2192
if parent_entry == (None, None):
2193
raise AssertionError(
2194
"no parent entry for: %s in tree %s"
2195
% (this_path, tree_index))
2196
if parent_entry[1][tree_index][0] != 'd':
2197
raise AssertionError(
2198
"Parent entry for %s is not marked as a valid"
2199
" directory. %s" % (this_path, parent_entry,))
2201
# For each file id, for each tree: either
2202
# the file id is not present at all; all rows with that id in the
2203
# key have it marked as 'absent'
2204
# OR the file id is present under exactly one name; any other entries
2205
# that mention that id point to the correct name.
2207
# We check this with a dict per tree pointing either to the present
2208
# name, or None if absent.
2209
tree_count = self._num_present_parents() + 1
2210
id_path_maps = [dict() for i in range(tree_count)]
2211
# Make sure that all renamed entries point to the correct location.
2212
for entry in self._iter_entries():
2213
file_id = entry[0][2]
2214
this_path = osutils.pathjoin(entry[0][0], entry[0][1])
2215
if len(entry[1]) != tree_count:
2216
raise AssertionError(
2217
"wrong number of entry details for row\n%s" \
2218
",\nexpected %d" % \
2219
(pformat(entry), tree_count))
2220
for tree_index, tree_state in enumerate(entry[1]):
2221
this_tree_map = id_path_maps[tree_index]
2222
minikind = tree_state[0]
2223
# have we seen this id before in this column?
2224
if file_id in this_tree_map:
2225
previous_path = this_tree_map[file_id]
2226
# any later mention of this file must be consistent with
2227
# what was said before
2229
if previous_path is not None:
2230
raise AssertionError(
2231
"file %s is absent in row %r but also present " \
2233
(file_id, entry, previous_path))
2234
elif minikind == 'r':
2235
target_location = tree_state[1]
2236
if previous_path != target_location:
2237
raise AssertionError(
2238
"file %s relocation in row %r but also at %r" \
2239
% (file_id, entry, previous_path))
2241
# a file, directory, etc - may have been previously
2242
# pointed to by a relocation, which must point here
2243
if previous_path != this_path:
2244
raise AssertionError(
2245
"entry %r inconsistent with previous path %r" % \
2246
(entry, previous_path))
2247
check_valid_parent()
2250
# absent; should not occur anywhere else
2251
this_tree_map[file_id] = None
2252
elif minikind == 'r':
2253
# relocation, must occur at expected location
2254
this_tree_map[file_id] = tree_state[1]
2256
this_tree_map[file_id] = this_path
2257
check_valid_parent()
2259
def _wipe_state(self):
2260
"""Forget all state information about the dirstate."""
2261
self._header_state = DirState.NOT_IN_MEMORY
2262
self._dirblock_state = DirState.NOT_IN_MEMORY
2265
self._dirblocks = []
2266
self._id_index = None
2267
self._end_of_header = None
2268
self._cutoff_time = None
2269
self._split_path_cache = {}
2271
def lock_read(self):
2272
"""Acquire a read lock on the dirstate."""
2273
if self._lock_token is not None:
2274
raise errors.LockContention(self._lock_token)
2275
# TODO: jam 20070301 Rather than wiping completely, if the blocks are
2276
# already in memory, we could read just the header and check for
2277
# any modification. If not modified, we can just leave things
2279
self._lock_token = lock.ReadLock(self._filename)
2280
self._lock_state = 'r'
2281
self._state_file = self._lock_token.f
2284
def lock_write(self):
2285
"""Acquire a write lock on the dirstate."""
2286
if self._lock_token is not None:
2287
raise errors.LockContention(self._lock_token)
2288
# TODO: jam 20070301 Rather than wiping completely, if the blocks are
2289
# already in memory, we could read just the header and check for
2290
# any modification. If not modified, we can just leave things
2292
self._lock_token = lock.WriteLock(self._filename)
2293
self._lock_state = 'w'
2294
self._state_file = self._lock_token.f
2298
"""Drop any locks held on the dirstate."""
2299
if self._lock_token is None:
2300
raise errors.LockNotHeld(self)
2301
# TODO: jam 20070301 Rather than wiping completely, if the blocks are
2302
# already in memory, we could read just the header and check for
2303
# any modification. If not modified, we can just leave things
2305
self._state_file = None
2306
self._lock_state = None
2307
self._lock_token.unlock()
2308
self._lock_token = None
2309
self._split_path_cache = {}
2311
def _requires_lock(self):
2312
"""Check that a lock is currently held by someone on the dirstate."""
2313
if not self._lock_token:
2314
raise errors.ObjectNotLocked(self)
2317
# Try to load the compiled form if possible
2319
from bzrlib._dirstate_helpers_c import (
2320
_read_dirblocks_c as _read_dirblocks,
2321
bisect_dirblock_c as bisect_dirblock,
2322
_bisect_path_left_c as _bisect_path_left,
2323
_bisect_path_right_c as _bisect_path_right,
2324
cmp_by_dirs_c as cmp_by_dirs,
2327
from bzrlib._dirstate_helpers_py import (
2328
_read_dirblocks_py as _read_dirblocks,
2329
bisect_dirblock_py as bisect_dirblock,
2330
_bisect_path_left_py as _bisect_path_left,
2331
_bisect_path_right_py as _bisect_path_right,
2332
cmp_by_dirs_py as cmp_by_dirs,
added
removed
bzrlib/dirstate.py
