1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 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
225
def pack_stat(st, _encode=binascii.b2a_base64, _pack=struct.pack):
226
"""Convert stat values into a packed representation."""
227
# jam 20060614 it isn't really worth removing more entries if we
228
# are going to leave it in packed form.
229
# With only st_mtime and st_mode filesize is 5.5M and read time is 275ms
230
# With all entries, filesize is 5.9M and read time is maybe 280ms
231
# well within the noise margin
233
# base64 encoding always adds a final newline, so strip it off
234
# The current version
235
return _encode(_pack('>LLLLLL'
236
, st.st_size, int(st.st_mtime), int(st.st_ctime)
237
, st.st_dev, st.st_ino & 0xFFFFFFFF, st.st_mode))[:-1]
238
# This is 0.060s / 1.520s faster by not encoding as much information
239
# return _encode(_pack('>LL', int(st.st_mtime), st.st_mode))[:-1]
240
# This is not strictly faster than _encode(_pack())[:-1]
241
# return '%X.%X.%X.%X.%X.%X' % (
242
# st.st_size, int(st.st_mtime), int(st.st_ctime),
243
# st.st_dev, st.st_ino, st.st_mode)
244
# Similar to the _encode(_pack('>LL'))
245
# return '%X.%X' % (int(st.st_mtime), st.st_mode)
248
class DirState(object):
249
"""Record directory and metadata state for fast access.
251
A dirstate is a specialised data structure for managing local working
252
tree state information. Its not yet well defined whether it is platform
253
specific, and if it is how we detect/parameterize that.
255
Dirstates use the usual lock_write, lock_read and unlock mechanisms.
256
Unlike most bzr disk formats, DirStates must be locked for reading, using
257
lock_read. (This is an os file lock internally.) This is necessary
258
because the file can be rewritten in place.
260
DirStates must be explicitly written with save() to commit changes; just
261
unlocking them does not write the changes to disk.
264
_kind_to_minikind = {
270
'tree-reference': 't',
272
_minikind_to_kind = {
278
't': 'tree-reference',
280
_stat_to_minikind = {
285
_to_yesno = {True:'y', False: 'n'} # TODO profile the performance gain
286
# of using int conversion rather than a dict here. AND BLAME ANDREW IF
289
# TODO: jam 20070221 Figure out what to do if we have a record that exceeds
290
# the BISECT_PAGE_SIZE. For now, we just have to make it large enough
291
# that we are sure a single record will always fit.
292
BISECT_PAGE_SIZE = 4096
295
IN_MEMORY_UNMODIFIED = 1
296
IN_MEMORY_MODIFIED = 2
298
# A pack_stat (the x's) that is just noise and will never match the output
301
NULL_PARENT_DETAILS = ('a', '', 0, False, '')
303
HEADER_FORMAT_2 = '#bazaar dirstate flat format 2\n'
304
HEADER_FORMAT_3 = '#bazaar dirstate flat format 3\n'
306
def __init__(self, path):
307
"""Create a DirState object.
309
:param path: The path at which the dirstate file on disk should live.
311
# _header_state and _dirblock_state represent the current state
312
# of the dirstate metadata and the per-row data respectiely.
313
# NOT_IN_MEMORY indicates that no data is in memory
314
# IN_MEMORY_UNMODIFIED indicates that what we have in memory
315
# is the same as is on disk
316
# IN_MEMORY_MODIFIED indicates that we have a modified version
317
# of what is on disk.
318
# In future we will add more granularity, for instance _dirblock_state
319
# will probably support partially-in-memory as a separate variable,
320
# allowing for partially-in-memory unmodified and partially-in-memory
322
self._header_state = DirState.NOT_IN_MEMORY
323
self._dirblock_state = DirState.NOT_IN_MEMORY
324
# If true, an error has been detected while updating the dirstate, and
325
# for safety we're not going to commit to disk.
326
self._changes_aborted = False
330
self._state_file = None
331
self._filename = path
332
self._lock_token = None
333
self._lock_state = None
334
self._id_index = None
335
# a map from packed_stat to sha's.
336
self._packed_stat_index = None
337
self._end_of_header = None
338
self._cutoff_time = None
339
self._split_path_cache = {}
340
self._bisect_page_size = DirState.BISECT_PAGE_SIZE
341
if 'hashcache' in debug.debug_flags:
342
self._sha1_file = self._sha1_file_and_mutter
344
self._sha1_file = osutils.sha_file_by_name
345
# These two attributes provide a simple cache for lookups into the
346
# dirstate in-memory vectors. By probing respectively for the last
347
# block, and for the next entry, we save nearly 2 bisections per path
349
self._last_block_index = None
350
self._last_entry_index = None
354
(self.__class__.__name__, self._filename)
356
def add(self, path, file_id, kind, stat, fingerprint):
357
"""Add a path to be tracked.
359
:param path: The path within the dirstate - '' is the root, 'foo' is the
360
path foo within the root, 'foo/bar' is the path bar within foo
362
:param file_id: The file id of the path being added.
363
:param kind: The kind of the path, as a string like 'file',
365
:param stat: The output of os.lstat for the path.
366
:param fingerprint: The sha value of the file,
367
or the target of a symlink,
368
or the referenced revision id for tree-references,
369
or '' for directories.
372
# find the block its in.
373
# find the location in the block.
374
# check its not there
376
#------- copied from inventory.ensure_normalized_name - keep synced.
377
# --- normalized_filename wants a unicode basename only, so get one.
378
dirname, basename = osutils.split(path)
379
# we dont import normalized_filename directly because we want to be
380
# able to change the implementation at runtime for tests.
381
norm_name, can_access = osutils.normalized_filename(basename)
382
if norm_name != basename:
386
raise errors.InvalidNormalization(path)
387
# you should never have files called . or ..; just add the directory
388
# in the parent, or according to the special treatment for the root
389
if basename == '.' or basename == '..':
390
raise errors.InvalidEntryName(path)
391
# now that we've normalised, we need the correct utf8 path and
392
# dirname and basename elements. This single encode and split should be
393
# faster than three separate encodes.
394
utf8path = (dirname + '/' + basename).strip('/').encode('utf8')
395
dirname, basename = osutils.split(utf8path)
396
assert file_id.__class__ == str, \
397
"must be a utf8 file_id not %s" % (type(file_id))
398
# Make sure the file_id does not exist in this tree
399
file_id_entry = self._get_entry(0, fileid_utf8=file_id)
400
if file_id_entry != (None, None):
401
path = osutils.pathjoin(file_id_entry[0][0], file_id_entry[0][1])
402
kind = DirState._minikind_to_kind[file_id_entry[1][0][0]]
403
info = '%s:%s' % (kind, path)
404
raise errors.DuplicateFileId(file_id, info)
405
first_key = (dirname, basename, '')
406
block_index, present = self._find_block_index_from_key(first_key)
408
# check the path is not in the tree
409
block = self._dirblocks[block_index][1]
410
entry_index, _ = self._find_entry_index(first_key, block)
411
while (entry_index < len(block) and
412
block[entry_index][0][0:2] == first_key[0:2]):
413
if block[entry_index][1][0][0] not in 'ar':
414
# this path is in the dirstate in the current tree.
415
raise Exception, "adding already added path!"
418
# The block where we want to put the file is not present. But it
419
# might be because the directory was empty, or not loaded yet. Look
420
# for a parent entry, if not found, raise NotVersionedError
421
parent_dir, parent_base = osutils.split(dirname)
422
parent_block_idx, parent_entry_idx, _, parent_present = \
423
self._get_block_entry_index(parent_dir, parent_base, 0)
424
if not parent_present:
425
raise errors.NotVersionedError(path, str(self))
426
self._ensure_block(parent_block_idx, parent_entry_idx, dirname)
427
block = self._dirblocks[block_index][1]
428
entry_key = (dirname, basename, file_id)
431
packed_stat = DirState.NULLSTAT
434
packed_stat = pack_stat(stat)
435
parent_info = self._empty_parent_info()
436
minikind = DirState._kind_to_minikind[kind]
438
entry_data = entry_key, [
439
(minikind, fingerprint, size, False, packed_stat),
441
elif kind == 'directory':
442
entry_data = entry_key, [
443
(minikind, '', 0, False, packed_stat),
445
elif kind == 'symlink':
446
entry_data = entry_key, [
447
(minikind, fingerprint, size, False, packed_stat),
449
elif kind == 'tree-reference':
450
entry_data = entry_key, [
451
(minikind, fingerprint, 0, False, packed_stat),
454
raise errors.BzrError('unknown kind %r' % kind)
455
entry_index, present = self._find_entry_index(entry_key, block)
457
block.insert(entry_index, entry_data)
459
assert block[entry_index][1][0][0] == 'a', " %r(%r) already added" % (basename, file_id)
460
block[entry_index][1][0] = entry_data[1][0]
462
if kind == 'directory':
463
# insert a new dirblock
464
self._ensure_block(block_index, entry_index, utf8path)
465
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
467
self._id_index.setdefault(entry_key[2], set()).add(entry_key)
469
def _bisect(self, paths):
470
"""Bisect through the disk structure for specific rows.
472
:param paths: A list of paths to find
473
:return: A dict mapping path => entries for found entries. Missing
474
entries will not be in the map.
475
The list is not sorted, and entries will be populated
476
based on when they were read.
478
self._requires_lock()
479
# We need the file pointer to be right after the initial header block
480
self._read_header_if_needed()
481
# If _dirblock_state was in memory, we should just return info from
482
# there, this function is only meant to handle when we want to read
484
assert self._dirblock_state == DirState.NOT_IN_MEMORY
486
# The disk representation is generally info + '\0\n\0' at the end. But
487
# for bisecting, it is easier to treat this as '\0' + info + '\0\n'
488
# Because it means we can sync on the '\n'
489
state_file = self._state_file
490
file_size = os.fstat(state_file.fileno()).st_size
491
# We end up with 2 extra fields, we should have a trailing '\n' to
492
# ensure that we read the whole record, and we should have a precursur
493
# '' which ensures that we start after the previous '\n'
494
entry_field_count = self._fields_per_entry() + 1
496
low = self._end_of_header
497
high = file_size - 1 # Ignore the final '\0'
498
# Map from (dir, name) => entry
501
# Avoid infinite seeking
502
max_count = 30*len(paths)
504
# pending is a list of places to look.
505
# each entry is a tuple of low, high, dir_names
506
# low -> the first byte offset to read (inclusive)
507
# high -> the last byte offset (inclusive)
508
# dir_names -> The list of (dir, name) pairs that should be found in
509
# the [low, high] range
510
pending = [(low, high, paths)]
512
page_size = self._bisect_page_size
514
fields_to_entry = self._get_fields_to_entry()
517
low, high, cur_files = pending.pop()
519
if not cur_files or low >= high:
524
if count > max_count:
525
raise errors.BzrError('Too many seeks, most likely a bug.')
527
mid = max(low, (low+high-page_size)/2)
530
# limit the read size, so we don't end up reading data that we have
532
read_size = min(page_size, (high-mid)+1)
533
block = state_file.read(read_size)
536
entries = block.split('\n')
539
# We didn't find a '\n', so we cannot have found any records.
540
# So put this range back and try again. But we know we have to
541
# increase the page size, because a single read did not contain
542
# a record break (so records must be larger than page_size)
544
pending.append((low, high, cur_files))
547
# Check the first and last entries, in case they are partial, or if
548
# we don't care about the rest of this page
550
first_fields = entries[0].split('\0')
551
if len(first_fields) < entry_field_count:
552
# We didn't get the complete first entry
553
# so move start, and grab the next, which
554
# should be a full entry
555
start += len(entries[0])+1
556
first_fields = entries[1].split('\0')
559
if len(first_fields) <= 2:
560
# We didn't even get a filename here... what do we do?
561
# Try a large page size and repeat this query
563
pending.append((low, high, cur_files))
566
# Find what entries we are looking for, which occur before and
567
# after this first record.
570
first_path = first_fields[1] + '/' + first_fields[2]
572
first_path = first_fields[2]
573
first_loc = _bisect_path_left(cur_files, first_path)
575
# These exist before the current location
576
pre = cur_files[:first_loc]
577
# These occur after the current location, which may be in the
578
# data we read, or might be after the last entry
579
post = cur_files[first_loc:]
581
if post and len(first_fields) >= entry_field_count:
582
# We have files after the first entry
584
# Parse the last entry
585
last_entry_num = len(entries)-1
586
last_fields = entries[last_entry_num].split('\0')
587
if len(last_fields) < entry_field_count:
588
# The very last hunk was not complete,
589
# read the previous hunk
590
after = mid + len(block) - len(entries[-1])
592
last_fields = entries[last_entry_num].split('\0')
594
after = mid + len(block)
597
last_path = last_fields[1] + '/' + last_fields[2]
599
last_path = last_fields[2]
600
last_loc = _bisect_path_right(post, last_path)
602
middle_files = post[:last_loc]
603
post = post[last_loc:]
606
# We have files that should occur in this block
607
# (>= first, <= last)
608
# Either we will find them here, or we can mark them as
611
if middle_files[0] == first_path:
612
# We might need to go before this location
613
pre.append(first_path)
614
if middle_files[-1] == last_path:
615
post.insert(0, last_path)
617
# Find out what paths we have
618
paths = {first_path:[first_fields]}
619
# last_path might == first_path so we need to be
620
# careful if we should append rather than overwrite
621
if last_entry_num != first_entry_num:
622
paths.setdefault(last_path, []).append(last_fields)
623
for num in xrange(first_entry_num+1, last_entry_num):
624
# TODO: jam 20070223 We are already splitting here, so
625
# shouldn't we just split the whole thing rather
626
# than doing the split again in add_one_record?
627
fields = entries[num].split('\0')
629
path = fields[1] + '/' + fields[2]
632
paths.setdefault(path, []).append(fields)
634
for path in middle_files:
635
for fields in paths.get(path, []):
636
# offset by 1 because of the opening '\0'
637
# consider changing fields_to_entry to avoid the
639
entry = fields_to_entry(fields[1:])
640
found.setdefault(path, []).append(entry)
642
# Now we have split up everything into pre, middle, and post, and
643
# we have handled everything that fell in 'middle'.
644
# We add 'post' first, so that we prefer to seek towards the
645
# beginning, so that we will tend to go as early as we need, and
646
# then only seek forward after that.
648
pending.append((after, high, post))
650
pending.append((low, start-1, pre))
652
# Consider that we may want to return the directory entries in sorted
653
# order. For now, we just return them in whatever order we found them,
654
# and leave it up to the caller if they care if it is ordered or not.
657
def _bisect_dirblocks(self, dir_list):
658
"""Bisect through the disk structure to find entries in given dirs.
660
_bisect_dirblocks is meant to find the contents of directories, which
661
differs from _bisect, which only finds individual entries.
663
:param dir_list: A sorted list of directory names ['', 'dir', 'foo'].
664
:return: A map from dir => entries_for_dir
666
# TODO: jam 20070223 A lot of the bisecting logic could be shared
667
# between this and _bisect. It would require parameterizing the
668
# inner loop with a function, though. We should evaluate the
669
# performance difference.
670
self._requires_lock()
671
# We need the file pointer to be right after the initial header block
672
self._read_header_if_needed()
673
# If _dirblock_state was in memory, we should just return info from
674
# there, this function is only meant to handle when we want to read
676
assert self._dirblock_state == DirState.NOT_IN_MEMORY
678
# The disk representation is generally info + '\0\n\0' at the end. But
679
# for bisecting, it is easier to treat this as '\0' + info + '\0\n'
680
# Because it means we can sync on the '\n'
681
state_file = self._state_file
682
file_size = os.fstat(state_file.fileno()).st_size
683
# We end up with 2 extra fields, we should have a trailing '\n' to
684
# ensure that we read the whole record, and we should have a precursur
685
# '' which ensures that we start after the previous '\n'
686
entry_field_count = self._fields_per_entry() + 1
688
low = self._end_of_header
689
high = file_size - 1 # Ignore the final '\0'
690
# Map from dir => entry
693
# Avoid infinite seeking
694
max_count = 30*len(dir_list)
696
# pending is a list of places to look.
697
# each entry is a tuple of low, high, dir_names
698
# low -> the first byte offset to read (inclusive)
699
# high -> the last byte offset (inclusive)
700
# dirs -> The list of directories that should be found in
701
# the [low, high] range
702
pending = [(low, high, dir_list)]
704
page_size = self._bisect_page_size
706
fields_to_entry = self._get_fields_to_entry()
709
low, high, cur_dirs = pending.pop()
711
if not cur_dirs or low >= high:
716
if count > max_count:
717
raise errors.BzrError('Too many seeks, most likely a bug.')
719
mid = max(low, (low+high-page_size)/2)
722
# limit the read size, so we don't end up reading data that we have
724
read_size = min(page_size, (high-mid)+1)
725
block = state_file.read(read_size)
728
entries = block.split('\n')
731
# We didn't find a '\n', so we cannot have found any records.
732
# So put this range back and try again. But we know we have to
733
# increase the page size, because a single read did not contain
734
# a record break (so records must be larger than page_size)
736
pending.append((low, high, cur_dirs))
739
# Check the first and last entries, in case they are partial, or if
740
# we don't care about the rest of this page
742
first_fields = entries[0].split('\0')
743
if len(first_fields) < entry_field_count:
744
# We didn't get the complete first entry
745
# so move start, and grab the next, which
746
# should be a full entry
747
start += len(entries[0])+1
748
first_fields = entries[1].split('\0')
751
if len(first_fields) <= 1:
752
# We didn't even get a dirname here... what do we do?
753
# Try a large page size and repeat this query
755
pending.append((low, high, cur_dirs))
758
# Find what entries we are looking for, which occur before and
759
# after this first record.
761
first_dir = first_fields[1]
762
first_loc = bisect.bisect_left(cur_dirs, first_dir)
764
# These exist before the current location
765
pre = cur_dirs[:first_loc]
766
# These occur after the current location, which may be in the
767
# data we read, or might be after the last entry
768
post = cur_dirs[first_loc:]
770
if post and len(first_fields) >= entry_field_count:
771
# We have records to look at after the first entry
773
# Parse the last entry
774
last_entry_num = len(entries)-1
775
last_fields = entries[last_entry_num].split('\0')
776
if len(last_fields) < entry_field_count:
777
# The very last hunk was not complete,
778
# read the previous hunk
779
after = mid + len(block) - len(entries[-1])
781
last_fields = entries[last_entry_num].split('\0')
783
after = mid + len(block)
785
last_dir = last_fields[1]
786
last_loc = bisect.bisect_right(post, last_dir)
788
middle_files = post[:last_loc]
789
post = post[last_loc:]
792
# We have files that should occur in this block
793
# (>= first, <= last)
794
# Either we will find them here, or we can mark them as
797
if middle_files[0] == first_dir:
798
# We might need to go before this location
799
pre.append(first_dir)
800
if middle_files[-1] == last_dir:
801
post.insert(0, last_dir)
803
# Find out what paths we have
804
paths = {first_dir:[first_fields]}
805
# last_dir might == first_dir so we need to be
806
# careful if we should append rather than overwrite
807
if last_entry_num != first_entry_num:
808
paths.setdefault(last_dir, []).append(last_fields)
809
for num in xrange(first_entry_num+1, last_entry_num):
810
# TODO: jam 20070223 We are already splitting here, so
811
# shouldn't we just split the whole thing rather
812
# than doing the split again in add_one_record?
813
fields = entries[num].split('\0')
814
paths.setdefault(fields[1], []).append(fields)
816
for cur_dir in middle_files:
817
for fields in paths.get(cur_dir, []):
818
# offset by 1 because of the opening '\0'
819
# consider changing fields_to_entry to avoid the
821
entry = fields_to_entry(fields[1:])
822
found.setdefault(cur_dir, []).append(entry)
824
# Now we have split up everything into pre, middle, and post, and
825
# we have handled everything that fell in 'middle'.
826
# We add 'post' first, so that we prefer to seek towards the
827
# beginning, so that we will tend to go as early as we need, and
828
# then only seek forward after that.
830
pending.append((after, high, post))
832
pending.append((low, start-1, pre))
836
def _bisect_recursive(self, paths):
837
"""Bisect for entries for all paths and their children.
839
This will use bisect to find all records for the supplied paths. It
840
will then continue to bisect for any records which are marked as
841
directories. (and renames?)
843
:param paths: A sorted list of (dir, name) pairs
844
eg: [('', 'a'), ('', 'f'), ('a/b', 'c')]
845
:return: A dictionary mapping (dir, name, file_id) => [tree_info]
847
# Map from (dir, name, file_id) => [tree_info]
850
found_dir_names = set()
852
# Directories that have been read
853
processed_dirs = set()
854
# Get the ball rolling with the first bisect for all entries.
855
newly_found = self._bisect(paths)
858
# Directories that need to be read
860
paths_to_search = set()
861
for entry_list in newly_found.itervalues():
862
for dir_name_id, trees_info in entry_list:
863
found[dir_name_id] = trees_info
864
found_dir_names.add(dir_name_id[:2])
866
for tree_info in trees_info:
867
minikind = tree_info[0]
870
# We already processed this one as a directory,
871
# we don't need to do the extra work again.
873
subdir, name, file_id = dir_name_id
874
path = osutils.pathjoin(subdir, name)
876
if path not in processed_dirs:
877
pending_dirs.add(path)
878
elif minikind == 'r':
879
# Rename, we need to directly search the target
880
# which is contained in the fingerprint column
881
dir_name = osutils.split(tree_info[1])
882
if dir_name[0] in pending_dirs:
883
# This entry will be found in the dir search
885
if dir_name not in found_dir_names:
886
paths_to_search.add(tree_info[1])
887
# Now we have a list of paths to look for directly, and
888
# directory blocks that need to be read.
889
# newly_found is mixing the keys between (dir, name) and path
890
# entries, but that is okay, because we only really care about the
892
newly_found = self._bisect(sorted(paths_to_search))
893
newly_found.update(self._bisect_dirblocks(sorted(pending_dirs)))
894
processed_dirs.update(pending_dirs)
897
def _discard_merge_parents(self):
898
"""Discard any parents trees beyond the first.
900
Note that if this fails the dirstate is corrupted.
902
After this function returns the dirstate contains 2 trees, neither of
905
self._read_header_if_needed()
906
parents = self.get_parent_ids()
909
# only require all dirblocks if we are doing a full-pass removal.
910
self._read_dirblocks_if_needed()
911
dead_patterns = set([('a', 'r'), ('a', 'a'), ('r', 'r'), ('r', 'a')])
912
def iter_entries_removable():
913
for block in self._dirblocks:
914
deleted_positions = []
915
for pos, entry in enumerate(block[1]):
917
if (entry[1][0][0], entry[1][1][0]) in dead_patterns:
918
deleted_positions.append(pos)
919
if deleted_positions:
920
if len(deleted_positions) == len(block[1]):
923
for pos in reversed(deleted_positions):
925
# if the first parent is a ghost:
926
if parents[0] in self.get_ghosts():
927
empty_parent = [DirState.NULL_PARENT_DETAILS]
928
for entry in iter_entries_removable():
929
entry[1][1:] = empty_parent
931
for entry in iter_entries_removable():
935
self._parents = [parents[0]]
936
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
937
self._header_state = DirState.IN_MEMORY_MODIFIED
939
def _empty_parent_info(self):
940
return [DirState.NULL_PARENT_DETAILS] * (len(self._parents) -
943
def _ensure_block(self, parent_block_index, parent_row_index, dirname):
944
"""Ensure a block for dirname exists.
946
This function exists to let callers which know that there is a
947
directory dirname ensure that the block for it exists. This block can
948
fail to exist because of demand loading, or because a directory had no
949
children. In either case it is not an error. It is however an error to
950
call this if there is no parent entry for the directory, and thus the
951
function requires the coordinates of such an entry to be provided.
953
The root row is special cased and can be indicated with a parent block
956
:param parent_block_index: The index of the block in which dirname's row
958
:param parent_row_index: The index in the parent block where the row
960
:param dirname: The utf8 dirname to ensure there is a block for.
961
:return: The index for the block.
963
if dirname == '' and parent_row_index == 0 and parent_block_index == 0:
964
# This is the signature of the root row, and the
965
# contents-of-root row is always index 1
967
# the basename of the directory must be the end of its full name.
968
if not (parent_block_index == -1 and
969
parent_block_index == -1 and dirname == ''):
970
assert dirname.endswith(
971
self._dirblocks[parent_block_index][1][parent_row_index][0][1])
972
block_index, present = self._find_block_index_from_key((dirname, '', ''))
974
## In future, when doing partial parsing, this should load and
975
# populate the entire block.
976
self._dirblocks.insert(block_index, (dirname, []))
979
def _entries_to_current_state(self, new_entries):
980
"""Load new_entries into self.dirblocks.
982
Process new_entries into the current state object, making them the active
983
state. The entries are grouped together by directory to form dirblocks.
985
:param new_entries: A sorted list of entries. This function does not sort
986
to prevent unneeded overhead when callers have a sorted list already.
989
assert new_entries[0][0][0:2] == ('', ''), \
990
"Missing root row %r" % (new_entries[0][0],)
991
# The two blocks here are deliberate: the root block and the
992
# contents-of-root block.
993
self._dirblocks = [('', []), ('', [])]
994
current_block = self._dirblocks[0][1]
997
append_entry = current_block.append
998
for entry in new_entries:
999
if entry[0][0] != current_dirname:
1000
# new block - different dirname
1002
current_dirname = entry[0][0]
1003
self._dirblocks.append((current_dirname, current_block))
1004
append_entry = current_block.append
1005
# append the entry to the current block
1007
self._split_root_dirblock_into_contents()
1009
def _split_root_dirblock_into_contents(self):
1010
"""Split the root dirblocks into root and contents-of-root.
1012
After parsing by path, we end up with root entries and contents-of-root
1013
entries in the same block. This loop splits them out again.
1015
# The above loop leaves the "root block" entries mixed with the
1016
# "contents-of-root block". But we don't want an if check on
1017
# all entries, so instead we just fix it up here.
1018
assert self._dirblocks[1] == ('', [])
1020
contents_of_root_block = []
1021
for entry in self._dirblocks[0][1]:
1022
if not entry[0][1]: # This is a root entry
1023
root_block.append(entry)
1025
contents_of_root_block.append(entry)
1026
self._dirblocks[0] = ('', root_block)
1027
self._dirblocks[1] = ('', contents_of_root_block)
1029
def _entry_to_line(self, entry):
1030
"""Serialize entry to a NULL delimited line ready for _get_output_lines.
1032
:param entry: An entry_tuple as defined in the module docstring.
1034
entire_entry = list(entry[0])
1035
for tree_number, tree_data in enumerate(entry[1]):
1036
# (minikind, fingerprint, size, executable, tree_specific_string)
1037
entire_entry.extend(tree_data)
1038
# 3 for the key, 5 for the fields per tree.
1039
tree_offset = 3 + tree_number * 5
1041
entire_entry[tree_offset + 0] = tree_data[0]
1043
entire_entry[tree_offset + 2] = str(tree_data[2])
1045
entire_entry[tree_offset + 3] = DirState._to_yesno[tree_data[3]]
1046
return '\0'.join(entire_entry)
1048
def _fields_per_entry(self):
1049
"""How many null separated fields should be in each entry row.
1051
Each line now has an extra '\n' field which is not used
1052
so we just skip over it
1054
3 fields for the key
1055
+ number of fields per tree_data (5) * tree count
1058
tree_count = 1 + self._num_present_parents()
1059
return 3 + 5 * tree_count + 1
1061
def _find_block(self, key, add_if_missing=False):
1062
"""Return the block that key should be present in.
1064
:param key: A dirstate entry key.
1065
:return: The block tuple.
1067
block_index, present = self._find_block_index_from_key(key)
1069
if not add_if_missing:
1070
# check to see if key is versioned itself - we might want to
1071
# add it anyway, because dirs with no entries dont get a
1072
# dirblock at parse time.
1073
# This is an uncommon branch to take: most dirs have children,
1074
# and most code works with versioned paths.
1075
parent_base, parent_name = osutils.split(key[0])
1076
if not self._get_block_entry_index(parent_base, parent_name, 0)[3]:
1077
# some parent path has not been added - its an error to add
1079
raise errors.NotVersionedError(key[0:2], str(self))
1080
self._dirblocks.insert(block_index, (key[0], []))
1081
return self._dirblocks[block_index]
1083
def _find_block_index_from_key(self, key):
1084
"""Find the dirblock index for a key.
1086
:return: The block index, True if the block for the key is present.
1088
if key[0:2] == ('', ''):
1091
if (self._last_block_index is not None and
1092
self._dirblocks[self._last_block_index][0] == key[0]):
1093
return self._last_block_index, True
1096
block_index = bisect_dirblock(self._dirblocks, key[0], 1,
1097
cache=self._split_path_cache)
1098
# _right returns one-past-where-key is so we have to subtract
1099
# one to use it. we use _right here because there are two
1100
# '' blocks - the root, and the contents of root
1101
# we always have a minimum of 2 in self._dirblocks: root and
1102
# root-contents, and for '', we get 2 back, so this is
1103
# simple and correct:
1104
present = (block_index < len(self._dirblocks) and
1105
self._dirblocks[block_index][0] == key[0])
1106
self._last_block_index = block_index
1107
# Reset the entry index cache to the beginning of the block.
1108
self._last_entry_index = -1
1109
return block_index, present
1111
def _find_entry_index(self, key, block):
1112
"""Find the entry index for a key in a block.
1114
:return: The entry index, True if the entry for the key is present.
1116
len_block = len(block)
1118
if self._last_entry_index is not None:
1120
entry_index = self._last_entry_index + 1
1121
# A hit is when the key is after the last slot, and before or
1122
# equal to the next slot.
1123
if ((entry_index > 0 and block[entry_index - 1][0] < key) and
1124
key <= block[entry_index][0]):
1125
self._last_entry_index = entry_index
1126
present = (block[entry_index][0] == key)
1127
return entry_index, present
1130
entry_index = bisect.bisect_left(block, (key, []))
1131
present = (entry_index < len_block and
1132
block[entry_index][0] == key)
1133
self._last_entry_index = entry_index
1134
return entry_index, present
1137
def from_tree(tree, dir_state_filename):
1138
"""Create a dirstate from a bzr Tree.
1140
:param tree: The tree which should provide parent information and
1142
:return: a DirState object which is currently locked for writing.
1143
(it was locked by DirState.initialize)
1145
result = DirState.initialize(dir_state_filename)
1149
parent_ids = tree.get_parent_ids()
1150
num_parents = len(parent_ids)
1152
for parent_id in parent_ids:
1153
parent_tree = tree.branch.repository.revision_tree(parent_id)
1154
parent_trees.append((parent_id, parent_tree))
1155
parent_tree.lock_read()
1156
result.set_parent_trees(parent_trees, [])
1157
result.set_state_from_inventory(tree.inventory)
1159
for revid, parent_tree in parent_trees:
1160
parent_tree.unlock()
1163
# The caller won't have a chance to unlock this, so make sure we
1169
def update_by_delta(self, delta):
1170
"""Apply an inventory delta to the dirstate for tree 0
1172
:param delta: An inventory delta. See Inventory.apply_delta for
1175
self._read_dirblocks_if_needed()
1178
for old_path, new_path, file_id, inv_entry in sorted(delta,
1180
assert file_id not in insertions
1181
assert file_id not in removals
1182
if old_path is not None:
1183
old_path = old_path.encode('utf-8')
1184
removals[file_id] = old_path
1185
if new_path is not None:
1186
new_path = new_path.encode('utf-8')
1187
dirname, basename = osutils.split(new_path)
1188
key = (dirname, basename, file_id)
1189
minikind = DirState._kind_to_minikind[inv_entry.kind]
1191
fingerprint = inv_entry.reference_revision
1194
insertions[file_id] = (key, minikind, inv_entry.executable,
1195
fingerprint, new_path)
1196
if None not in (old_path, new_path):
1197
for child in self._iter_child_entries(0, old_path):
1198
if child[0][2] in insertions or child[0][2] in removals:
1200
child_dirname = child[0][0]
1201
child_basename = child[0][1]
1202
minikind = child[1][0][0]
1203
fingerprint = child[1][0][4]
1204
executable = child[1][0][3]
1205
old_child_path = osutils.pathjoin(child[0][0],
1207
removals[child[0][2]] = old_child_path
1208
child_suffix = child_dirname[len(old_path):]
1209
new_child_dirname = (new_path + child_suffix)
1210
key = (new_child_dirname, child_basename, child[0][2])
1211
new_child_path = os.path.join(new_child_dirname,
1213
insertions[child[0][2]] = (key, minikind, executable,
1214
fingerprint, new_child_path)
1215
self._apply_removals(removals.values())
1216
self._apply_insertions(insertions.values())
1218
def _apply_removals(self, removals):
1219
for path in sorted(removals, reverse=True):
1220
dirname, basename = osutils.split(path)
1221
block_i, entry_i, d_present, f_present = \
1222
self._get_block_entry_index(dirname, basename, 0)
1223
entry = self._dirblocks[block_i][1][entry_i]
1224
self._make_absent(entry)
1226
def _apply_insertions(self, adds):
1227
for key, minikind, executable, fingerprint, path_utf8 in sorted(adds):
1228
self.update_minimal(key, minikind, executable, fingerprint,
1229
path_utf8=path_utf8)
1231
def update_basis_by_delta(self, delta, new_revid):
1232
"""Update the parents of this tree after a commit.
1234
This gives the tree one parent, with revision id new_revid. The
1235
inventory delta is applied to the current basis tree to generate the
1236
inventory for the parent new_revid, and all other parent trees are
1239
Note that an exception during the operation of this method will leave
1240
the dirstate in a corrupt state where it should not be saved.
1242
Finally, we expect all changes to be synchronising the basis tree with
1245
:param new_revid: The new revision id for the trees parent.
1246
:param delta: An inventory delta (see apply_inventory_delta) describing
1247
the changes from the current left most parent revision to new_revid.
1249
self._read_dirblocks_if_needed()
1250
self._discard_merge_parents()
1251
if self._ghosts != []:
1252
raise NotImplementedError(self.update_basis_by_delta)
1253
if len(self._parents) == 0:
1254
# setup a blank tree, the most simple way.
1255
empty_parent = DirState.NULL_PARENT_DETAILS
1256
for entry in self._iter_entries():
1257
entry[1].append(empty_parent)
1258
self._parents.append(new_revid)
1260
self._parents[0] = new_revid
1262
delta = sorted(delta, reverse=True)
1266
# The paths this function accepts are unicode and must be encoded as we
1268
encode = cache_utf8.encode
1269
inv_to_entry = self._inv_entry_to_details
1270
# delta is now (deletes, changes), (adds) in reverse lexographical
1272
# deletes in reverse lexographic order are safe to process in situ.
1273
# renames are not, as a rename from any path could go to a path
1274
# lexographically lower, so we transform renames into delete, add pairs,
1275
# expanding them recursively as needed.
1276
# At the same time, to reduce interface friction we convert the input
1277
# inventory entries to dirstate.
1278
root_only = ('', '')
1279
for old_path, new_path, file_id, inv_entry in delta:
1280
if old_path is None:
1281
adds.append((None, encode(new_path), file_id,
1282
inv_to_entry(inv_entry), True))
1283
elif new_path is None:
1284
deletes.append((encode(old_path), None, file_id, None, True))
1285
elif (old_path, new_path) != root_only:
1287
# Because renames must preserve their children we must have
1288
# processed all relocations and removes before hand. The sort
1289
# order ensures we've examined the child paths, but we also
1290
# have to execute the removals, or the split to an add/delete
1291
# pair will result in the deleted item being reinserted, or
1292
# renamed items being reinserted twice - and possibly at the
1293
# wrong place. Splitting into a delete/add pair also simplifies
1294
# the handling of entries with ('f', ...), ('r' ...) because
1295
# the target of the 'r' is old_path here, and we add that to
1296
# deletes, meaning that the add handler does not need to check
1297
# for 'r' items on every pass.
1298
self._update_basis_apply_deletes(deletes)
1300
new_path_utf8 = encode(new_path)
1301
# Split into an add/delete pair recursively.
1302
adds.append((None, new_path_utf8, file_id,
1303
inv_to_entry(inv_entry), False))
1304
# Expunge deletes that we've seen so that deleted/renamed
1305
# children of a rename directory are handled correctly.
1306
new_deletes = reversed(list(self._iter_child_entries(1,
1308
# Remove the current contents of the tree at orig_path, and
1309
# reinsert at the correct new path.
1310
for entry in new_deletes:
1312
source_path = entry[0][0] + '/' + entry[0][1]
1314
source_path = entry[0][1]
1316
target_path = new_path_utf8 + source_path[len(old_path):]
1318
assert len(old_path) > 0, ("cannot rename directory to"
1320
target_path = source_path[len(old_path) + 1:]
1321
adds.append((None, target_path, entry[0][2], entry[1][1], False))
1323
(source_path, target_path, entry[0][2], None, False))
1325
(encode(old_path), new_path, file_id, None, False))
1327
# changes to just the root should not require remove/insertion
1329
changes.append((encode(old_path), encode(new_path), file_id,
1330
inv_to_entry(inv_entry)))
1332
# Finish expunging deletes/first half of renames.
1333
self._update_basis_apply_deletes(deletes)
1334
# Reinstate second half of renames and new paths.
1335
self._update_basis_apply_adds(adds)
1336
# Apply in-situ changes.
1337
self._update_basis_apply_changes(changes)
1339
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1340
self._header_state = DirState.IN_MEMORY_MODIFIED
1341
self._id_index = None
1344
def _update_basis_apply_adds(self, adds):
1345
"""Apply a sequence of adds to tree 1 during update_basis_by_delta.
1347
They may be adds, or renames that have been split into add/delete
1350
:param adds: A sequence of adds. Each add is a tuple:
1351
(None, new_path_utf8, file_id, (entry_details), real_add). real_add
1352
is False when the add is the second half of a remove-and-reinsert
1353
pair created to handle renames and deletes.
1355
# Adds are accumulated partly from renames, so can be in any input
1358
# adds is now in lexographic order, which places all parents before
1359
# their children, so we can process it linearly.
1361
for old_path, new_path, file_id, new_details, real_add in adds:
1362
assert old_path is None
1363
# the entry for this file_id must be in tree 0.
1364
entry = self._get_entry(0, file_id, new_path)
1365
if entry[0] is None or entry[0][2] != file_id:
1366
self._changes_aborted = True
1367
raise errors.InconsistentDelta(new_path, file_id,
1368
'working tree does not contain new entry')
1369
if real_add and entry[1][1][0] not in absent:
1370
self._changes_aborted = True
1371
raise errors.InconsistentDelta(new_path, file_id,
1372
'The entry was considered to be a genuinely new record,'
1373
' but there was already an old record for it.')
1374
# We don't need to update the target of an 'r' because the handling
1375
# of renames turns all 'r' situations into a delete at the original
1377
entry[1][1] = new_details
1379
def _update_basis_apply_changes(self, changes):
1380
"""Apply a sequence of changes to tree 1 during update_basis_by_delta.
1382
:param adds: A sequence of changes. Each change is a tuple:
1383
(path_utf8, path_utf8, file_id, (entry_details))
1386
for old_path, new_path, file_id, new_details in changes:
1387
assert old_path == new_path
1388
# the entry for this file_id must be in tree 0.
1389
entry = self._get_entry(0, file_id, new_path)
1390
if entry[0] is None or entry[0][2] != file_id:
1391
self._changes_aborted = True
1392
raise errors.InconsistentDelta(new_path, file_id,
1393
'working tree does not contain new entry')
1394
if (entry[1][0][0] in absent or
1395
entry[1][1][0] in absent):
1396
self._changes_aborted = True
1397
raise errors.InconsistentDelta(new_path, file_id,
1398
'changed considered absent')
1399
entry[1][1] = new_details
1401
def _update_basis_apply_deletes(self, deletes):
1402
"""Apply a sequence of deletes to tree 1 during update_basis_by_delta.
1404
They may be deletes, or renames that have been split into add/delete
1407
:param deletes: A sequence of deletes. Each delete is a tuple:
1408
(old_path_utf8, new_path_utf8, file_id, None, real_delete).
1409
real_delete is True when the desired outcome is an actual deletion
1410
rather than the rename handling logic temporarily deleting a path
1411
during the replacement of a parent.
1413
null = DirState.NULL_PARENT_DETAILS
1414
for old_path, new_path, file_id, _, real_delete in deletes:
1416
assert new_path is None
1418
assert new_path is not None
1419
# the entry for this file_id must be in tree 1.
1420
dirname, basename = osutils.split(old_path)
1421
block_index, entry_index, dir_present, file_present = \
1422
self._get_block_entry_index(dirname, basename, 1)
1423
if not file_present:
1424
self._changes_aborted = True
1425
raise errors.InconsistentDelta(old_path, file_id,
1426
'basis tree does not contain removed entry')
1427
entry = self._dirblocks[block_index][1][entry_index]
1428
if entry[0][2] != file_id:
1429
self._changes_aborted = True
1430
raise errors.InconsistentDelta(old_path, file_id,
1431
'mismatched file_id in tree 1')
1433
if entry[1][0][0] != 'a':
1434
self._changes_aborted = True
1435
raise errors.InconsistentDelta(old_path, file_id,
1436
'This was marked as a real delete, but the WT state'
1437
' claims that it still exists and is versioned.')
1438
del self._dirblocks[block_index][1][entry_index]
1440
if entry[1][0][0] == 'a':
1441
self._changes_aborted = True
1442
raise errors.InconsistentDelta(old_path, file_id,
1443
'The entry was considered a rename, but the source path'
1444
' is marked as absent.')
1445
# For whatever reason, we were asked to rename an entry
1446
# that was originally marked as deleted. This could be
1447
# because we are renaming the parent directory, and the WT
1448
# current state has the file marked as deleted.
1449
elif entry[1][0][0] == 'r':
1450
# implement the rename
1451
del self._dirblocks[block_index][1][entry_index]
1453
# it is being resurrected here, so blank it out temporarily.
1454
self._dirblocks[block_index][1][entry_index][1][1] = null
1456
def update_entry(self, entry, abspath, stat_value,
1457
_stat_to_minikind=_stat_to_minikind,
1458
_pack_stat=pack_stat):
1459
"""Update the entry based on what is actually on disk.
1461
:param entry: This is the dirblock entry for the file in question.
1462
:param abspath: The path on disk for this file.
1463
:param stat_value: (optional) if we already have done a stat on the
1465
:return: The sha1 hexdigest of the file (40 bytes) or link target of a
1469
minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
1473
packed_stat = _pack_stat(stat_value)
1474
(saved_minikind, saved_link_or_sha1, saved_file_size,
1475
saved_executable, saved_packed_stat) = entry[1][0]
1477
if (minikind == saved_minikind
1478
and packed_stat == saved_packed_stat):
1479
# The stat hasn't changed since we saved, so we can re-use the
1484
# size should also be in packed_stat
1485
if saved_file_size == stat_value.st_size:
1486
return saved_link_or_sha1
1488
# If we have gotten this far, that means that we need to actually
1489
# process this entry.
1492
link_or_sha1 = self._sha1_file(abspath)
1493
executable = self._is_executable(stat_value.st_mode,
1495
if self._cutoff_time is None:
1496
self._sha_cutoff_time()
1497
if (stat_value.st_mtime < self._cutoff_time
1498
and stat_value.st_ctime < self._cutoff_time):
1499
entry[1][0] = ('f', link_or_sha1, stat_value.st_size,
1500
executable, packed_stat)
1502
entry[1][0] = ('f', '', stat_value.st_size,
1503
executable, DirState.NULLSTAT)
1504
elif minikind == 'd':
1506
entry[1][0] = ('d', '', 0, False, packed_stat)
1507
if saved_minikind != 'd':
1508
# This changed from something into a directory. Make sure we
1509
# have a directory block for it. This doesn't happen very
1510
# often, so this doesn't have to be super fast.
1511
block_index, entry_index, dir_present, file_present = \
1512
self._get_block_entry_index(entry[0][0], entry[0][1], 0)
1513
self._ensure_block(block_index, entry_index,
1514
osutils.pathjoin(entry[0][0], entry[0][1]))
1515
elif minikind == 'l':
1516
link_or_sha1 = self._read_link(abspath, saved_link_or_sha1)
1517
if self._cutoff_time is None:
1518
self._sha_cutoff_time()
1519
if (stat_value.st_mtime < self._cutoff_time
1520
and stat_value.st_ctime < self._cutoff_time):
1521
entry[1][0] = ('l', link_or_sha1, stat_value.st_size,
1524
entry[1][0] = ('l', '', stat_value.st_size,
1525
False, DirState.NULLSTAT)
1526
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1529
def _sha_cutoff_time(self):
1530
"""Return cutoff time.
1532
Files modified more recently than this time are at risk of being
1533
undetectably modified and so can't be cached.
1535
# Cache the cutoff time as long as we hold a lock.
1536
# time.time() isn't super expensive (approx 3.38us), but
1537
# when you call it 50,000 times it adds up.
1538
# For comparison, os.lstat() costs 7.2us if it is hot.
1539
self._cutoff_time = int(time.time()) - 3
1540
return self._cutoff_time
1542
def _lstat(self, abspath, entry):
1543
"""Return the os.lstat value for this path."""
1544
return os.lstat(abspath)
1546
def _sha1_file_and_mutter(self, abspath):
1547
# when -Dhashcache is turned on, this is monkey-patched in to log
1549
trace.mutter("dirstate sha1 " + abspath)
1550
return osutils.sha_file_by_name(abspath)
1552
def _is_executable(self, mode, old_executable):
1553
"""Is this file executable?"""
1554
return bool(S_IEXEC & mode)
1556
def _is_executable_win32(self, mode, old_executable):
1557
"""On win32 the executable bit is stored in the dirstate."""
1558
return old_executable
1560
if sys.platform == 'win32':
1561
_is_executable = _is_executable_win32
1563
def _read_link(self, abspath, old_link):
1564
"""Read the target of a symlink"""
1565
# TODO: jam 200700301 On Win32, this could just return the value
1566
# already in memory. However, this really needs to be done at a
1567
# higher level, because there either won't be anything on disk,
1568
# or the thing on disk will be a file.
1569
return os.readlink(abspath)
1571
def get_ghosts(self):
1572
"""Return a list of the parent tree revision ids that are ghosts."""
1573
self._read_header_if_needed()
1576
def get_lines(self):
1577
"""Serialise the entire dirstate to a sequence of lines."""
1578
if (self._header_state == DirState.IN_MEMORY_UNMODIFIED and
1579
self._dirblock_state == DirState.IN_MEMORY_UNMODIFIED):
1580
# read whats on disk.
1581
self._state_file.seek(0)
1582
return self._state_file.readlines()
1584
lines.append(self._get_parents_line(self.get_parent_ids()))
1585
lines.append(self._get_ghosts_line(self._ghosts))
1586
# append the root line which is special cased
1587
lines.extend(map(self._entry_to_line, self._iter_entries()))
1588
return self._get_output_lines(lines)
1590
def _get_ghosts_line(self, ghost_ids):
1591
"""Create a line for the state file for ghost information."""
1592
return '\0'.join([str(len(ghost_ids))] + ghost_ids)
1594
def _get_parents_line(self, parent_ids):
1595
"""Create a line for the state file for parents information."""
1596
return '\0'.join([str(len(parent_ids))] + parent_ids)
1598
def _get_fields_to_entry(self):
1599
"""Get a function which converts entry fields into a entry record.
1601
This handles size and executable, as well as parent records.
1603
:return: A function which takes a list of fields, and returns an
1604
appropriate record for storing in memory.
1606
# This is intentionally unrolled for performance
1607
num_present_parents = self._num_present_parents()
1608
if num_present_parents == 0:
1609
def fields_to_entry_0_parents(fields, _int=int):
1610
path_name_file_id_key = (fields[0], fields[1], fields[2])
1611
return (path_name_file_id_key, [
1613
fields[3], # minikind
1614
fields[4], # fingerprint
1615
_int(fields[5]), # size
1616
fields[6] == 'y', # executable
1617
fields[7], # packed_stat or revision_id
1619
return fields_to_entry_0_parents
1620
elif num_present_parents == 1:
1621
def fields_to_entry_1_parent(fields, _int=int):
1622
path_name_file_id_key = (fields[0], fields[1], fields[2])
1623
return (path_name_file_id_key, [
1625
fields[3], # minikind
1626
fields[4], # fingerprint
1627
_int(fields[5]), # size
1628
fields[6] == 'y', # executable
1629
fields[7], # packed_stat or revision_id
1632
fields[8], # minikind
1633
fields[9], # fingerprint
1634
_int(fields[10]), # size
1635
fields[11] == 'y', # executable
1636
fields[12], # packed_stat or revision_id
1639
return fields_to_entry_1_parent
1640
elif num_present_parents == 2:
1641
def fields_to_entry_2_parents(fields, _int=int):
1642
path_name_file_id_key = (fields[0], fields[1], fields[2])
1643
return (path_name_file_id_key, [
1645
fields[3], # minikind
1646
fields[4], # fingerprint
1647
_int(fields[5]), # size
1648
fields[6] == 'y', # executable
1649
fields[7], # packed_stat or revision_id
1652
fields[8], # minikind
1653
fields[9], # fingerprint
1654
_int(fields[10]), # size
1655
fields[11] == 'y', # executable
1656
fields[12], # packed_stat or revision_id
1659
fields[13], # minikind
1660
fields[14], # fingerprint
1661
_int(fields[15]), # size
1662
fields[16] == 'y', # executable
1663
fields[17], # packed_stat or revision_id
1666
return fields_to_entry_2_parents
1668
def fields_to_entry_n_parents(fields, _int=int):
1669
path_name_file_id_key = (fields[0], fields[1], fields[2])
1670
trees = [(fields[cur], # minikind
1671
fields[cur+1], # fingerprint
1672
_int(fields[cur+2]), # size
1673
fields[cur+3] == 'y', # executable
1674
fields[cur+4], # stat or revision_id
1675
) for cur in xrange(3, len(fields)-1, 5)]
1676
return path_name_file_id_key, trees
1677
return fields_to_entry_n_parents
1679
def get_parent_ids(self):
1680
"""Return a list of the parent tree ids for the directory state."""
1681
self._read_header_if_needed()
1682
return list(self._parents)
1684
def _get_block_entry_index(self, dirname, basename, tree_index):
1685
"""Get the coordinates for a path in the state structure.
1687
:param dirname: The utf8 dirname to lookup.
1688
:param basename: The utf8 basename to lookup.
1689
:param tree_index: The index of the tree for which this lookup should
1691
:return: A tuple describing where the path is located, or should be
1692
inserted. The tuple contains four fields: the block index, the row
1693
index, the directory is present (boolean), the entire path is
1694
present (boolean). There is no guarantee that either
1695
coordinate is currently reachable unless the found field for it is
1696
True. For instance, a directory not present in the searched tree
1697
may be returned with a value one greater than the current highest
1698
block offset. The directory present field will always be True when
1699
the path present field is True. The directory present field does
1700
NOT indicate that the directory is present in the searched tree,
1701
rather it indicates that there are at least some files in some
1704
self._read_dirblocks_if_needed()
1705
key = dirname, basename, ''
1706
block_index, present = self._find_block_index_from_key(key)
1708
# no such directory - return the dir index and 0 for the row.
1709
return block_index, 0, False, False
1710
block = self._dirblocks[block_index][1] # access the entries only
1711
entry_index, present = self._find_entry_index(key, block)
1712
# linear search through entries at this path to find the one
1714
while entry_index < len(block) and block[entry_index][0][1] == basename:
1715
if block[entry_index][1][tree_index][0] not in 'ar':
1716
# neither absent or relocated
1717
return block_index, entry_index, True, True
1719
return block_index, entry_index, True, False
1721
def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None):
1722
"""Get the dirstate entry for path in tree tree_index.
1724
If either file_id or path is supplied, it is used as the key to lookup.
1725
If both are supplied, the fastest lookup is used, and an error is
1726
raised if they do not both point at the same row.
1728
:param tree_index: The index of the tree we wish to locate this path
1729
in. If the path is present in that tree, the entry containing its
1730
details is returned, otherwise (None, None) is returned
1731
0 is the working tree, higher indexes are successive parent
1733
:param fileid_utf8: A utf8 file_id to look up.
1734
:param path_utf8: An utf8 path to be looked up.
1735
:return: The dirstate entry tuple for path, or (None, None)
1737
self._read_dirblocks_if_needed()
1738
if path_utf8 is not None:
1739
assert path_utf8.__class__ == str, ('path_utf8 is not a str: %s %s'
1740
% (type(path_utf8), path_utf8))
1741
# path lookups are faster
1742
dirname, basename = osutils.split(path_utf8)
1743
block_index, entry_index, dir_present, file_present = \
1744
self._get_block_entry_index(dirname, basename, tree_index)
1745
if not file_present:
1747
entry = self._dirblocks[block_index][1][entry_index]
1748
assert entry[0][2] and entry[1][tree_index][0] not in ('a', 'r'), 'unversioned entry?!?!'
1750
if entry[0][2] != fileid_utf8:
1751
self._changes_aborted = True
1752
raise errors.BzrError('integrity error ? : mismatching'
1753
' tree_index, file_id and path')
1756
assert fileid_utf8 is not None
1757
possible_keys = self._get_id_index().get(fileid_utf8, None)
1758
if not possible_keys:
1760
for key in possible_keys:
1761
block_index, present = \
1762
self._find_block_index_from_key(key)
1763
# strange, probably indicates an out of date
1764
# id index - for now, allow this.
1767
# WARNING: DO not change this code to use _get_block_entry_index
1768
# as that function is not suitable: it does not use the key
1769
# to lookup, and thus the wrong coordinates are returned.
1770
block = self._dirblocks[block_index][1]
1771
entry_index, present = self._find_entry_index(key, block)
1773
entry = self._dirblocks[block_index][1][entry_index]
1774
if entry[1][tree_index][0] in 'fdlt':
1775
# this is the result we are looking for: the
1776
# real home of this file_id in this tree.
1778
if entry[1][tree_index][0] == 'a':
1779
# there is no home for this entry in this tree
1781
assert entry[1][tree_index][0] == 'r', \
1782
"entry %r has invalid minikind %r for tree %r" \
1784
entry[1][tree_index][0],
1786
real_path = entry[1][tree_index][1]
1787
return self._get_entry(tree_index, fileid_utf8=fileid_utf8,
1788
path_utf8=real_path)
1792
def initialize(cls, path):
1793
"""Create a new dirstate on path.
1795
The new dirstate will be an empty tree - that is it has no parents,
1796
and only a root node - which has id ROOT_ID.
1798
:param path: The name of the file for the dirstate.
1799
:return: A write-locked DirState object.
1801
# This constructs a new DirState object on a path, sets the _state_file
1802
# to a new empty file for that path. It then calls _set_data() with our
1803
# stock empty dirstate information - a root with ROOT_ID, no children,
1804
# and no parents. Finally it calls save() to ensure that this data will
1807
# root dir and root dir contents with no children.
1808
empty_tree_dirblocks = [('', []), ('', [])]
1809
# a new root directory, with a NULLSTAT.
1810
empty_tree_dirblocks[0][1].append(
1811
(('', '', inventory.ROOT_ID), [
1812
('d', '', 0, False, DirState.NULLSTAT),
1816
result._set_data([], empty_tree_dirblocks)
1823
def _inv_entry_to_details(self, inv_entry):
1824
"""Convert an inventory entry (from a revision tree) to state details.
1826
:param inv_entry: An inventory entry whose sha1 and link targets can be
1827
relied upon, and which has a revision set.
1828
:return: A details tuple - the details for a single tree at a path +
1831
kind = inv_entry.kind
1832
minikind = DirState._kind_to_minikind[kind]
1833
tree_data = inv_entry.revision
1834
assert tree_data, 'empty revision for the inv_entry %s.' % \
1836
if kind == 'directory':
1840
elif kind == 'symlink':
1841
fingerprint = inv_entry.symlink_target or ''
1844
elif kind == 'file':
1845
fingerprint = inv_entry.text_sha1 or ''
1846
size = inv_entry.text_size or 0
1847
executable = inv_entry.executable
1848
elif kind == 'tree-reference':
1849
fingerprint = inv_entry.reference_revision or ''
1853
raise Exception("can't pack %s" % inv_entry)
1854
return (minikind, fingerprint, size, executable, tree_data)
1856
def _iter_child_entries(self, tree_index, path_utf8):
1857
"""Iterate over all the entries that are children of path_utf.
1859
This only returns entries that are present (not in 'a', 'r') in
1860
tree_index. tree_index data is not refreshed, so if tree 0 is used,
1861
results may differ from that obtained if paths were statted to
1862
determine what ones were directories.
1864
Asking for the children of a non-directory will return an empty
1868
next_pending_dirs = [path_utf8]
1870
while next_pending_dirs:
1871
pending_dirs = next_pending_dirs
1872
next_pending_dirs = []
1873
for path in pending_dirs:
1874
block_index, present = self._find_block_index_from_key(
1876
if block_index == 0:
1878
if len(self._dirblocks) == 1:
1879
# asked for the children of the root with no other
1883
# children of a non-directory asked for.
1885
block = self._dirblocks[block_index]
1886
for entry in block[1]:
1887
kind = entry[1][tree_index][0]
1888
if kind not in absent:
1892
path = entry[0][0] + '/' + entry[0][1]
1895
next_pending_dirs.append(path)
1897
def _iter_entries(self):
1898
"""Iterate over all the entries in the dirstate.
1900
Each yelt item is an entry in the standard format described in the
1901
docstring of bzrlib.dirstate.
1903
self._read_dirblocks_if_needed()
1904
for directory in self._dirblocks:
1905
for entry in directory[1]:
1908
def _get_id_index(self):
1909
"""Get an id index of self._dirblocks."""
1910
if self._id_index is None:
1912
for key, tree_details in self._iter_entries():
1913
id_index.setdefault(key[2], set()).add(key)
1914
self._id_index = id_index
1915
return self._id_index
1917
def _get_output_lines(self, lines):
1918
"""Format lines for final output.
1920
:param lines: A sequence of lines containing the parents list and the
1923
output_lines = [DirState.HEADER_FORMAT_3]
1924
lines.append('') # a final newline
1925
inventory_text = '\0\n\0'.join(lines)
1926
output_lines.append('crc32: %s\n' % (zlib.crc32(inventory_text),))
1927
# -3, 1 for num parents, 1 for ghosts, 1 for final newline
1928
num_entries = len(lines)-3
1929
output_lines.append('num_entries: %s\n' % (num_entries,))
1930
output_lines.append(inventory_text)
1933
def _make_deleted_row(self, fileid_utf8, parents):
1934
"""Return a deleted row for fileid_utf8."""
1935
return ('/', 'RECYCLED.BIN', 'file', fileid_utf8, 0, DirState.NULLSTAT,
1938
def _num_present_parents(self):
1939
"""The number of parent entries in each record row."""
1940
return len(self._parents) - len(self._ghosts)
1944
"""Construct a DirState on the file at path path.
1946
:return: An unlocked DirState object, associated with the given path.
1948
result = DirState(path)
1951
def _read_dirblocks_if_needed(self):
1952
"""Read in all the dirblocks from the file if they are not in memory.
1954
This populates self._dirblocks, and sets self._dirblock_state to
1955
IN_MEMORY_UNMODIFIED. It is not currently ready for incremental block
1958
self._read_header_if_needed()
1959
if self._dirblock_state == DirState.NOT_IN_MEMORY:
1960
_read_dirblocks(self)
1962
def _read_header(self):
1963
"""This reads in the metadata header, and the parent ids.
1965
After reading in, the file should be positioned at the null
1966
just before the start of the first record in the file.
1968
:return: (expected crc checksum, number of entries, parent list)
1970
self._read_prelude()
1971
parent_line = self._state_file.readline()
1972
info = parent_line.split('\0')
1973
num_parents = int(info[0])
1974
assert num_parents == len(info)-2, 'incorrect parent info line'
1975
self._parents = info[1:-1]
1977
ghost_line = self._state_file.readline()
1978
info = ghost_line.split('\0')
1979
num_ghosts = int(info[1])
1980
assert num_ghosts == len(info)-3, 'incorrect ghost info line'
1981
self._ghosts = info[2:-1]
1982
self._header_state = DirState.IN_MEMORY_UNMODIFIED
1983
self._end_of_header = self._state_file.tell()
1985
def _read_header_if_needed(self):
1986
"""Read the header of the dirstate file if needed."""
1987
# inline this as it will be called a lot
1988
if not self._lock_token:
1989
raise errors.ObjectNotLocked(self)
1990
if self._header_state == DirState.NOT_IN_MEMORY:
1993
def _read_prelude(self):
1994
"""Read in the prelude header of the dirstate file.
1996
This only reads in the stuff that is not connected to the crc
1997
checksum. The position will be correct to read in the rest of
1998
the file and check the checksum after this point.
1999
The next entry in the file should be the number of parents,
2000
and their ids. Followed by a newline.
2002
header = self._state_file.readline()
2003
assert header == DirState.HEADER_FORMAT_3, \
2004
'invalid header line: %r' % (header,)
2005
crc_line = self._state_file.readline()
2006
assert crc_line.startswith('crc32: '), 'missing crc32 checksum'
2007
self.crc_expected = int(crc_line[len('crc32: '):-1])
2008
num_entries_line = self._state_file.readline()
2009
assert num_entries_line.startswith('num_entries: '), 'missing num_entries line'
2010
self._num_entries = int(num_entries_line[len('num_entries: '):-1])
2012
def sha1_from_stat(self, path, stat_result, _pack_stat=pack_stat):
2013
"""Find a sha1 given a stat lookup."""
2014
return self._get_packed_stat_index().get(_pack_stat(stat_result), None)
2016
def _get_packed_stat_index(self):
2017
"""Get a packed_stat index of self._dirblocks."""
2018
if self._packed_stat_index is None:
2020
for key, tree_details in self._iter_entries():
2021
if tree_details[0][0] == 'f':
2022
index[tree_details[0][4]] = tree_details[0][1]
2023
self._packed_stat_index = index
2024
return self._packed_stat_index
2027
"""Save any pending changes created during this session.
2029
We reuse the existing file, because that prevents race conditions with
2030
file creation, and use oslocks on it to prevent concurrent modification
2031
and reads - because dirstate's incremental data aggregation is not
2032
compatible with reading a modified file, and replacing a file in use by
2033
another process is impossible on Windows.
2035
A dirstate in read only mode should be smart enough though to validate
2036
that the file has not changed, and otherwise discard its cache and
2037
start over, to allow for fine grained read lock duration, so 'status'
2038
wont block 'commit' - for example.
2040
if self._changes_aborted:
2041
# Should this be a warning? For now, I'm expecting that places that
2042
# mark it inconsistent will warn, making a warning here redundant.
2043
trace.mutter('Not saving DirState because '
2044
'_changes_aborted is set.')
2046
if (self._header_state == DirState.IN_MEMORY_MODIFIED or
2047
self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
2049
grabbed_write_lock = False
2050
if self._lock_state != 'w':
2051
grabbed_write_lock, new_lock = self._lock_token.temporary_write_lock()
2052
# Switch over to the new lock, as the old one may be closed.
2053
# TODO: jam 20070315 We should validate the disk file has
2054
# not changed contents. Since temporary_write_lock may
2055
# not be an atomic operation.
2056
self._lock_token = new_lock
2057
self._state_file = new_lock.f
2058
if not grabbed_write_lock:
2059
# We couldn't grab a write lock, so we switch back to a read one
2062
self._state_file.seek(0)
2063
self._state_file.writelines(self.get_lines())
2064
self._state_file.truncate()
2065
self._state_file.flush()
2066
self._header_state = DirState.IN_MEMORY_UNMODIFIED
2067
self._dirblock_state = DirState.IN_MEMORY_UNMODIFIED
2069
if grabbed_write_lock:
2070
self._lock_token = self._lock_token.restore_read_lock()
2071
self._state_file = self._lock_token.f
2072
# TODO: jam 20070315 We should validate the disk file has
2073
# not changed contents. Since restore_read_lock may
2074
# not be an atomic operation.
2076
def _set_data(self, parent_ids, dirblocks):
2077
"""Set the full dirstate data in memory.
2079
This is an internal function used to completely replace the objects
2080
in memory state. It puts the dirstate into state 'full-dirty'.
2082
:param parent_ids: A list of parent tree revision ids.
2083
:param dirblocks: A list containing one tuple for each directory in the
2084
tree. Each tuple contains the directory path and a list of entries
2085
found in that directory.
2087
# our memory copy is now authoritative.
2088
self._dirblocks = dirblocks
2089
self._header_state = DirState.IN_MEMORY_MODIFIED
2090
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2091
self._parents = list(parent_ids)
2092
self._id_index = None
2093
self._packed_stat_index = None
2095
def set_path_id(self, path, new_id):
2096
"""Change the id of path to new_id in the current working tree.
2098
:param path: The path inside the tree to set - '' is the root, 'foo'
2099
is the path foo in the root.
2100
:param new_id: The new id to assign to the path. This must be a utf8
2101
file id (not unicode, and not None).
2103
assert new_id.__class__ == str, \
2104
"path_id %r is not a plain string" % (new_id,)
2105
self._read_dirblocks_if_needed()
2107
# TODO: logic not written
2108
raise NotImplementedError(self.set_path_id)
2109
# TODO: check new id is unique
2110
entry = self._get_entry(0, path_utf8=path)
2111
if entry[0][2] == new_id:
2112
# Nothing to change.
2114
# mark the old path absent, and insert a new root path
2115
self._make_absent(entry)
2116
self.update_minimal(('', '', new_id), 'd',
2117
path_utf8='', packed_stat=entry[1][0][4])
2118
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2119
if self._id_index is not None:
2120
self._id_index.setdefault(new_id, set()).add(entry[0])
2122
def set_parent_trees(self, trees, ghosts):
2123
"""Set the parent trees for the dirstate.
2125
:param trees: A list of revision_id, tree tuples. tree must be provided
2126
even if the revision_id refers to a ghost: supply an empty tree in
2128
:param ghosts: A list of the revision_ids that are ghosts at the time
2131
# TODO: generate a list of parent indexes to preserve to save
2132
# processing specific parent trees. In the common case one tree will
2133
# be preserved - the left most parent.
2134
# TODO: if the parent tree is a dirstate, we might want to walk them
2135
# all by path in parallel for 'optimal' common-case performance.
2136
# generate new root row.
2137
self._read_dirblocks_if_needed()
2138
# TODO future sketch: Examine the existing parents to generate a change
2139
# map and then walk the new parent trees only, mapping them into the
2140
# dirstate. Walk the dirstate at the same time to remove unreferenced
2143
# sketch: loop over all entries in the dirstate, cherry picking
2144
# entries from the parent trees, if they are not ghost trees.
2145
# after we finish walking the dirstate, all entries not in the dirstate
2146
# are deletes, so we want to append them to the end as per the design
2147
# discussions. So do a set difference on ids with the parents to
2148
# get deletes, and add them to the end.
2149
# During the update process we need to answer the following questions:
2150
# - find other keys containing a fileid in order to create cross-path
2151
# links. We dont't trivially use the inventory from other trees
2152
# because this leads to either double touching, or to accessing
2154
# - find other keys containing a path
2155
# We accumulate each entry via this dictionary, including the root
2158
# we could do parallel iterators, but because file id data may be
2159
# scattered throughout, we dont save on index overhead: we have to look
2160
# at everything anyway. We can probably save cycles by reusing parent
2161
# data and doing an incremental update when adding an additional
2162
# parent, but for now the common cases are adding a new parent (merge),
2163
# and replacing completely (commit), and commit is more common: so
2164
# optimise merge later.
2166
# ---- start generation of full tree mapping data
2167
# what trees should we use?
2168
parent_trees = [tree for rev_id, tree in trees if rev_id not in ghosts]
2169
# how many trees do we end up with
2170
parent_count = len(parent_trees)
2172
# one: the current tree
2173
for entry in self._iter_entries():
2174
# skip entries not in the current tree
2175
if entry[1][0][0] in 'ar': # absent, relocated
2177
by_path[entry[0]] = [entry[1][0]] + \
2178
[DirState.NULL_PARENT_DETAILS] * parent_count
2179
id_index[entry[0][2]] = set([entry[0]])
2181
# now the parent trees:
2182
for tree_index, tree in enumerate(parent_trees):
2183
# the index is off by one, adjust it.
2184
tree_index = tree_index + 1
2185
# when we add new locations for a fileid we need these ranges for
2186
# any fileid in this tree as we set the by_path[id] to:
2187
# already_processed_tree_details + new_details + new_location_suffix
2188
# the suffix is from tree_index+1:parent_count+1.
2189
new_location_suffix = [DirState.NULL_PARENT_DETAILS] * (parent_count - tree_index)
2190
# now stitch in all the entries from this tree
2191
for path, entry in tree.inventory.iter_entries_by_dir():
2192
# here we process each trees details for each item in the tree.
2193
# we first update any existing entries for the id at other paths,
2194
# then we either create or update the entry for the id at the
2195
# right path, and finally we add (if needed) a mapping from
2196
# file_id to this path. We do it in this order to allow us to
2197
# avoid checking all known paths for the id when generating a
2198
# new entry at this path: by adding the id->path mapping last,
2199
# all the mappings are valid and have correct relocation
2200
# records where needed.
2201
file_id = entry.file_id
2202
path_utf8 = path.encode('utf8')
2203
dirname, basename = osutils.split(path_utf8)
2204
new_entry_key = (dirname, basename, file_id)
2205
# tree index consistency: All other paths for this id in this tree
2206
# index must point to the correct path.
2207
for entry_key in id_index.setdefault(file_id, set()):
2208
# TODO:PROFILING: It might be faster to just update
2209
# rather than checking if we need to, and then overwrite
2210
# the one we are located at.
2211
if entry_key != new_entry_key:
2212
# this file id is at a different path in one of the
2213
# other trees, so put absent pointers there
2214
# This is the vertical axis in the matrix, all pointing
2216
by_path[entry_key][tree_index] = ('r', path_utf8, 0, False, '')
2217
# by path consistency: Insert into an existing path record (trivial), or
2218
# add a new one with relocation pointers for the other tree indexes.
2219
if new_entry_key in id_index[file_id]:
2220
# there is already an entry where this data belongs, just insert it.
2221
by_path[new_entry_key][tree_index] = \
2222
self._inv_entry_to_details(entry)
2224
# add relocated entries to the horizontal axis - this row
2225
# mapping from path,id. We need to look up the correct path
2226
# for the indexes from 0 to tree_index -1
2228
for lookup_index in xrange(tree_index):
2229
# boundary case: this is the first occurence of file_id
2230
# so there are no id_indexs, possibly take this out of
2232
if not len(id_index[file_id]):
2233
new_details.append(DirState.NULL_PARENT_DETAILS)
2235
# grab any one entry, use it to find the right path.
2236
# TODO: optimise this to reduce memory use in highly
2237
# fragmented situations by reusing the relocation
2239
a_key = iter(id_index[file_id]).next()
2240
if by_path[a_key][lookup_index][0] in ('r', 'a'):
2241
# its a pointer or missing statement, use it as is.
2242
new_details.append(by_path[a_key][lookup_index])
2244
# we have the right key, make a pointer to it.
2245
real_path = ('/'.join(a_key[0:2])).strip('/')
2246
new_details.append(('r', real_path, 0, False, ''))
2247
new_details.append(self._inv_entry_to_details(entry))
2248
new_details.extend(new_location_suffix)
2249
by_path[new_entry_key] = new_details
2250
id_index[file_id].add(new_entry_key)
2251
# --- end generation of full tree mappings
2253
# sort and output all the entries
2254
new_entries = self._sort_entries(by_path.items())
2255
self._entries_to_current_state(new_entries)
2256
self._parents = [rev_id for rev_id, tree in trees]
2257
self._ghosts = list(ghosts)
2258
self._header_state = DirState.IN_MEMORY_MODIFIED
2259
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2260
self._id_index = id_index
2262
def _sort_entries(self, entry_list):
2263
"""Given a list of entries, sort them into the right order.
2265
This is done when constructing a new dirstate from trees - normally we
2266
try to keep everything in sorted blocks all the time, but sometimes
2267
it's easier to sort after the fact.
2270
# sort by: directory parts, file name, file id
2271
return entry[0][0].split('/'), entry[0][1], entry[0][2]
2272
return sorted(entry_list, key=_key)
2274
def set_state_from_inventory(self, new_inv):
2275
"""Set new_inv as the current state.
2277
This API is called by tree transform, and will usually occur with
2278
existing parent trees.
2280
:param new_inv: The inventory object to set current state from.
2282
if 'evil' in debug.debug_flags:
2283
trace.mutter_callsite(1,
2284
"set_state_from_inventory called; please mutate the tree instead")
2285
self._read_dirblocks_if_needed()
2287
# Two iterators: current data and new data, both in dirblock order.
2288
# We zip them together, which tells about entries that are new in the
2289
# inventory, or removed in the inventory, or present in both and
2292
# You might think we could just synthesize a new dirstate directly
2293
# since we're processing it in the right order. However, we need to
2294
# also consider there may be any number of parent trees and relocation
2295
# pointers, and we don't want to duplicate that here.
2296
new_iterator = new_inv.iter_entries_by_dir()
2297
# we will be modifying the dirstate, so we need a stable iterator. In
2298
# future we might write one, for now we just clone the state into a
2299
# list - which is a shallow copy.
2300
old_iterator = iter(list(self._iter_entries()))
2301
# both must have roots so this is safe:
2302
current_new = new_iterator.next()
2303
current_old = old_iterator.next()
2304
def advance(iterator):
2306
return iterator.next()
2307
except StopIteration:
2309
while current_new or current_old:
2310
# skip entries in old that are not really there
2311
if current_old and current_old[1][0][0] in 'ar':
2312
# relocated or absent
2313
current_old = advance(old_iterator)
2316
# convert new into dirblock style
2317
new_path_utf8 = current_new[0].encode('utf8')
2318
new_dirname, new_basename = osutils.split(new_path_utf8)
2319
new_id = current_new[1].file_id
2320
new_entry_key = (new_dirname, new_basename, new_id)
2321
current_new_minikind = \
2322
DirState._kind_to_minikind[current_new[1].kind]
2323
if current_new_minikind == 't':
2324
fingerprint = current_new[1].reference_revision or ''
2326
# We normally only insert or remove records, or update
2327
# them when it has significantly changed. Then we want to
2328
# erase its fingerprint. Unaffected records should
2329
# normally not be updated at all.
2332
# for safety disable variables
2333
new_path_utf8 = new_dirname = new_basename = new_id = \
2334
new_entry_key = None
2335
# 5 cases, we dont have a value that is strictly greater than everything, so
2336
# we make both end conditions explicit
2338
# old is finished: insert current_new into the state.
2339
self.update_minimal(new_entry_key, current_new_minikind,
2340
executable=current_new[1].executable,
2341
path_utf8=new_path_utf8, fingerprint=fingerprint)
2342
current_new = advance(new_iterator)
2343
elif not current_new:
2345
self._make_absent(current_old)
2346
current_old = advance(old_iterator)
2347
elif new_entry_key == current_old[0]:
2348
# same - common case
2349
# We're looking at the same path and id in both the dirstate
2350
# and inventory, so just need to update the fields in the
2351
# dirstate from the one in the inventory.
2352
# TODO: update the record if anything significant has changed.
2353
# the minimal required trigger is if the execute bit or cached
2355
if (current_old[1][0][3] != current_new[1].executable or
2356
current_old[1][0][0] != current_new_minikind):
2357
self.update_minimal(current_old[0], current_new_minikind,
2358
executable=current_new[1].executable,
2359
path_utf8=new_path_utf8, fingerprint=fingerprint)
2360
# both sides are dealt with, move on
2361
current_old = advance(old_iterator)
2362
current_new = advance(new_iterator)
2363
elif (cmp_by_dirs(new_dirname, current_old[0][0]) < 0
2364
or (new_dirname == current_old[0][0]
2365
and new_entry_key[1:] < current_old[0][1:])):
2367
# add a entry for this and advance new
2368
self.update_minimal(new_entry_key, current_new_minikind,
2369
executable=current_new[1].executable,
2370
path_utf8=new_path_utf8, fingerprint=fingerprint)
2371
current_new = advance(new_iterator)
2373
# we've advanced past the place where the old key would be,
2374
# without seeing it in the new list. so it must be gone.
2375
self._make_absent(current_old)
2376
current_old = advance(old_iterator)
2377
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2378
self._id_index = None
2379
self._packed_stat_index = None
2381
def _make_absent(self, current_old):
2382
"""Mark current_old - an entry - as absent for tree 0.
2384
:return: True if this was the last details entry for the entry key:
2385
that is, if the underlying block has had the entry removed, thus
2386
shrinking in length.
2388
# build up paths that this id will be left at after the change is made,
2389
# so we can update their cross references in tree 0
2390
all_remaining_keys = set()
2391
# Dont check the working tree, because it's going.
2392
for details in current_old[1][1:]:
2393
if details[0] not in 'ar': # absent, relocated
2394
all_remaining_keys.add(current_old[0])
2395
elif details[0] == 'r': # relocated
2396
# record the key for the real path.
2397
all_remaining_keys.add(tuple(osutils.split(details[1])) + (current_old[0][2],))
2398
# absent rows are not present at any path.
2399
last_reference = current_old[0] not in all_remaining_keys
2401
# the current row consists entire of the current item (being marked
2402
# absent), and relocated or absent entries for the other trees:
2403
# Remove it, its meaningless.
2404
block = self._find_block(current_old[0])
2405
entry_index, present = self._find_entry_index(current_old[0], block[1])
2406
assert present, 'could not find entry for %s' % (current_old,)
2407
block[1].pop(entry_index)
2408
# if we have an id_index in use, remove this key from it for this id.
2409
if self._id_index is not None:
2410
self._id_index[current_old[0][2]].remove(current_old[0])
2411
# update all remaining keys for this id to record it as absent. The
2412
# existing details may either be the record we are marking as deleted
2413
# (if there were other trees with the id present at this path), or may
2415
for update_key in all_remaining_keys:
2416
update_block_index, present = \
2417
self._find_block_index_from_key(update_key)
2418
assert present, 'could not find block for %s' % (update_key,)
2419
update_entry_index, present = \
2420
self._find_entry_index(update_key, self._dirblocks[update_block_index][1])
2421
assert present, 'could not find entry for %s' % (update_key,)
2422
update_tree_details = self._dirblocks[update_block_index][1][update_entry_index][1]
2423
# it must not be absent at the moment
2424
assert update_tree_details[0][0] != 'a' # absent
2425
update_tree_details[0] = DirState.NULL_PARENT_DETAILS
2426
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2427
return last_reference
2429
def update_minimal(self, key, minikind, executable=False, fingerprint='',
2430
packed_stat=None, size=0, path_utf8=None):
2431
"""Update an entry to the state in tree 0.
2433
This will either create a new entry at 'key' or update an existing one.
2434
It also makes sure that any other records which might mention this are
2437
:param key: (dir, name, file_id) for the new entry
2438
:param minikind: The type for the entry ('f' == 'file', 'd' ==
2440
:param executable: Should the executable bit be set?
2441
:param fingerprint: Simple fingerprint for new entry: sha1 for files,
2442
referenced revision id for subtrees, etc.
2443
:param packed_stat: Packed stat value for new entry.
2444
:param size: Size information for new entry
2445
:param path_utf8: key[0] + '/' + key[1], just passed in to avoid doing
2448
If packed_stat and fingerprint are not given, they're invalidated in
2451
block = self._find_block(key)[1]
2452
if packed_stat is None:
2453
packed_stat = DirState.NULLSTAT
2454
# XXX: Some callers pass '' as the packed_stat, and it seems to be
2455
# sometimes present in the dirstate - this seems oddly inconsistent.
2457
entry_index, present = self._find_entry_index(key, block)
2458
new_details = (minikind, fingerprint, size, executable, packed_stat)
2459
id_index = self._get_id_index()
2461
# new entry, synthesis cross reference here,
2462
existing_keys = id_index.setdefault(key[2], set())
2463
if not existing_keys:
2464
# not currently in the state, simplest case
2465
new_entry = key, [new_details] + self._empty_parent_info()
2467
# present at one or more existing other paths.
2468
# grab one of them and use it to generate parent
2469
# relocation/absent entries.
2470
new_entry = key, [new_details]
2471
for other_key in existing_keys:
2472
# change the record at other to be a pointer to this new
2473
# record. The loop looks similar to the change to
2474
# relocations when updating an existing record but its not:
2475
# the test for existing kinds is different: this can be
2476
# factored out to a helper though.
2477
other_block_index, present = self._find_block_index_from_key(other_key)
2478
assert present, 'could not find block for %s' % (other_key,)
2479
other_entry_index, present = self._find_entry_index(other_key,
2480
self._dirblocks[other_block_index][1])
2481
assert present, 'could not find entry for %s' % (other_key,)
2482
assert path_utf8 is not None
2483
self._dirblocks[other_block_index][1][other_entry_index][1][0] = \
2484
('r', path_utf8, 0, False, '')
2486
num_present_parents = self._num_present_parents()
2487
for lookup_index in xrange(1, num_present_parents + 1):
2488
# grab any one entry, use it to find the right path.
2489
# TODO: optimise this to reduce memory use in highly
2490
# fragmented situations by reusing the relocation
2492
update_block_index, present = \
2493
self._find_block_index_from_key(other_key)
2494
assert present, 'could not find block for %s' % (other_key,)
2495
update_entry_index, present = \
2496
self._find_entry_index(other_key, self._dirblocks[update_block_index][1])
2497
assert present, 'could not find entry for %s' % (other_key,)
2498
update_details = self._dirblocks[update_block_index][1][update_entry_index][1][lookup_index]
2499
if update_details[0] in 'ar': # relocated, absent
2500
# its a pointer or absent in lookup_index's tree, use
2502
new_entry[1].append(update_details)
2504
# we have the right key, make a pointer to it.
2505
pointer_path = osutils.pathjoin(*other_key[0:2])
2506
new_entry[1].append(('r', pointer_path, 0, False, ''))
2507
block.insert(entry_index, new_entry)
2508
existing_keys.add(key)
2510
# Does the new state matter?
2511
block[entry_index][1][0] = new_details
2512
# parents cannot be affected by what we do.
2513
# other occurences of this id can be found
2514
# from the id index.
2516
# tree index consistency: All other paths for this id in this tree
2517
# index must point to the correct path. We have to loop here because
2518
# we may have passed entries in the state with this file id already
2519
# that were absent - where parent entries are - and they need to be
2520
# converted to relocated.
2521
assert path_utf8 is not None
2522
for entry_key in id_index.setdefault(key[2], set()):
2523
# TODO:PROFILING: It might be faster to just update
2524
# rather than checking if we need to, and then overwrite
2525
# the one we are located at.
2526
if entry_key != key:
2527
# this file id is at a different path in one of the
2528
# other trees, so put absent pointers there
2529
# This is the vertical axis in the matrix, all pointing
2531
block_index, present = self._find_block_index_from_key(entry_key)
2533
entry_index, present = self._find_entry_index(entry_key, self._dirblocks[block_index][1])
2535
self._dirblocks[block_index][1][entry_index][1][0] = \
2536
('r', path_utf8, 0, False, '')
2537
# add a containing dirblock if needed.
2538
if new_details[0] == 'd':
2539
subdir_key = (osutils.pathjoin(*key[0:2]), '', '')
2540
block_index, present = self._find_block_index_from_key(subdir_key)
2542
self._dirblocks.insert(block_index, (subdir_key[0], []))
2544
self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2546
def _validate(self):
2547
"""Check that invariants on the dirblock are correct.
2549
This can be useful in debugging; it shouldn't be necessary in
2552
This must be called with a lock held.
2554
# NOTE: This must always raise AssertionError not just assert,
2555
# otherwise it may not behave properly under python -O
2557
# TODO: All entries must have some content that's not 'a' or 'r',
2558
# otherwise it could just be removed.
2560
# TODO: All relocations must point directly to a real entry.
2562
# TODO: No repeated keys.
2565
from pprint import pformat
2566
self._read_dirblocks_if_needed()
2567
if len(self._dirblocks) > 0:
2568
if not self._dirblocks[0][0] == '':
2569
raise AssertionError(
2570
"dirblocks don't start with root block:\n" + \
2572
if len(self._dirblocks) > 1:
2573
if not self._dirblocks[1][0] == '':
2574
raise AssertionError(
2575
"dirblocks missing root directory:\n" + \
2577
# the dirblocks are sorted by their path components, name, and dir id
2578
dir_names = [d[0].split('/')
2579
for d in self._dirblocks[1:]]
2580
if dir_names != sorted(dir_names):
2581
raise AssertionError(
2582
"dir names are not in sorted order:\n" + \
2583
pformat(self._dirblocks) + \
2586
for dirblock in self._dirblocks:
2587
# within each dirblock, the entries are sorted by filename and
2589
for entry in dirblock[1]:
2590
if dirblock[0] != entry[0][0]:
2591
raise AssertionError(
2593
"doesn't match directory name in\n%r" %
2594
(entry, pformat(dirblock)))
2595
if dirblock[1] != sorted(dirblock[1]):
2596
raise AssertionError(
2597
"dirblock for %r is not sorted:\n%s" % \
2598
(dirblock[0], pformat(dirblock)))
2600
def check_valid_parent():
2601
"""Check that the current entry has a valid parent.
2603
This makes sure that the parent has a record,
2604
and that the parent isn't marked as "absent" in the
2605
current tree. (It is invalid to have a non-absent file in an absent
2608
if entry[0][0:2] == ('', ''):
2609
# There should be no parent for the root row
2611
parent_entry = self._get_entry(tree_index, path_utf8=entry[0][0])
2612
if parent_entry == (None, None):
2613
raise AssertionError(
2614
"no parent entry for: %s in tree %s"
2615
% (this_path, tree_index))
2616
if parent_entry[1][tree_index][0] != 'd':
2617
raise AssertionError(
2618
"Parent entry for %s is not marked as a valid"
2619
" directory. %s" % (this_path, parent_entry,))
2621
# For each file id, for each tree: either
2622
# the file id is not present at all; all rows with that id in the
2623
# key have it marked as 'absent'
2624
# OR the file id is present under exactly one name; any other entries
2625
# that mention that id point to the correct name.
2627
# We check this with a dict per tree pointing either to the present
2628
# name, or None if absent.
2629
tree_count = self._num_present_parents() + 1
2630
id_path_maps = [dict() for i in range(tree_count)]
2631
# Make sure that all renamed entries point to the correct location.
2632
for entry in self._iter_entries():
2633
file_id = entry[0][2]
2634
this_path = osutils.pathjoin(entry[0][0], entry[0][1])
2635
if len(entry[1]) != tree_count:
2636
raise AssertionError(
2637
"wrong number of entry details for row\n%s" \
2638
",\nexpected %d" % \
2639
(pformat(entry), tree_count))
2640
absent_positions = 0
2641
for tree_index, tree_state in enumerate(entry[1]):
2642
this_tree_map = id_path_maps[tree_index]
2643
minikind = tree_state[0]
2644
if minikind in 'ar':
2645
absent_positions += 1
2646
# have we seen this id before in this column?
2647
if file_id in this_tree_map:
2648
previous_path, previous_loc = this_tree_map[file_id]
2649
# any later mention of this file must be consistent with
2650
# what was said before
2652
if previous_path is not None:
2653
raise AssertionError(
2654
"file %s is absent in row %r but also present " \
2656
(file_id, entry, previous_path))
2657
elif minikind == 'r':
2658
target_location = tree_state[1]
2659
if previous_path != target_location:
2660
raise AssertionError(
2661
"file %s relocation in row %r but also at %r" \
2662
% (file_id, entry, previous_path))
2664
# a file, directory, etc - may have been previously
2665
# pointed to by a relocation, which must point here
2666
if previous_path != this_path:
2667
raise AssertionError(
2668
"entry %r inconsistent with previous path %r "
2670
(entry, previous_path, previous_loc))
2671
check_valid_parent()
2674
# absent; should not occur anywhere else
2675
this_tree_map[file_id] = None, this_path
2676
elif minikind == 'r':
2677
# relocation, must occur at expected location
2678
this_tree_map[file_id] = tree_state[1], this_path
2680
this_tree_map[file_id] = this_path, this_path
2681
check_valid_parent()
2682
if absent_positions == tree_count:
2683
raise AssertionError(
2684
"entry %r has no data for any tree." % (entry,))
2686
def _wipe_state(self):
2687
"""Forget all state information about the dirstate."""
2688
self._header_state = DirState.NOT_IN_MEMORY
2689
self._dirblock_state = DirState.NOT_IN_MEMORY
2690
self._changes_aborted = False
2693
self._dirblocks = []
2694
self._id_index = None
2695
self._packed_stat_index = None
2696
self._end_of_header = None
2697
self._cutoff_time = None
2698
self._split_path_cache = {}
2700
def lock_read(self):
2701
"""Acquire a read lock on the dirstate."""
2702
if self._lock_token is not None:
2703
raise errors.LockContention(self._lock_token)
2704
# TODO: jam 20070301 Rather than wiping completely, if the blocks are
2705
# already in memory, we could read just the header and check for
2706
# any modification. If not modified, we can just leave things
2708
self._lock_token = lock.ReadLock(self._filename)
2709
self._lock_state = 'r'
2710
self._state_file = self._lock_token.f
2713
def lock_write(self):
2714
"""Acquire a write lock on the dirstate."""
2715
if self._lock_token is not None:
2716
raise errors.LockContention(self._lock_token)
2717
# TODO: jam 20070301 Rather than wiping completely, if the blocks are
2718
# already in memory, we could read just the header and check for
2719
# any modification. If not modified, we can just leave things
2721
self._lock_token = lock.WriteLock(self._filename)
2722
self._lock_state = 'w'
2723
self._state_file = self._lock_token.f
2727
"""Drop any locks held on the dirstate."""
2728
if self._lock_token is None:
2729
raise errors.LockNotHeld(self)
2730
# TODO: jam 20070301 Rather than wiping completely, if the blocks are
2731
# already in memory, we could read just the header and check for
2732
# any modification. If not modified, we can just leave things
2734
self._state_file = None
2735
self._lock_state = None
2736
self._lock_token.unlock()
2737
self._lock_token = None
2738
self._split_path_cache = {}
2740
def _requires_lock(self):
2741
"""Check that a lock is currently held by someone on the dirstate."""
2742
if not self._lock_token:
2743
raise errors.ObjectNotLocked(self)
2746
# Try to load the compiled form if possible
2748
from bzrlib._dirstate_helpers_c import (
2749
_read_dirblocks_c as _read_dirblocks,
2750
bisect_dirblock_c as bisect_dirblock,
2751
_bisect_path_left_c as _bisect_path_left,
2752
_bisect_path_right_c as _bisect_path_right,
2753
cmp_by_dirs_c as cmp_by_dirs,
2756
from bzrlib._dirstate_helpers_py import (
2757
_read_dirblocks_py as _read_dirblocks,
2758
bisect_dirblock_py as bisect_dirblock,
2759
_bisect_path_left_py as _bisect_path_left,
2760
_bisect_path_right_py as _bisect_path_right,
2761
cmp_by_dirs_py as cmp_by_dirs,
added
removed
bzrlib/dirstate.py
