/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/dirstate.py

  • Committer: Martin
  • Date: 2017-06-04 18:09:30 UTC
  • mto: This revision was merged to the branch mainline in revision 6653.
  • Revision ID: gzlist@googlemail.com-20170604180930-zpcenvzu13lilaax
Apply 2to3 xrange fix and fix up with sixish range

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
20
20
lines by NL. The field delimiters are ommitted in the grammar, line delimiters
21
21
are not - this is done for clarity of reading. All string data is in utf8.
22
22
 
23
 
MINIKIND = "f" | "d" | "l" | "a" | "r" | "t";
24
 
NL = "\n";
25
 
NULL = "\0";
26
 
WHOLE_NUMBER = {digit}, digit;
27
 
BOOLEAN = "y" | "n";
28
 
REVISION_ID = a non-empty utf8 string;
29
 
 
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;
37
 
entries = {entry};
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;
45
 
executable = BOOLEAN;
46
 
size = WHOLE_NUMBER;
47
 
fingerprint = a nonempty utf8 sequence with meaning defined by minikind.
48
 
 
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)
52
 
entry[0][0]: dirname
53
 
entry[0][1]: basename
54
 
entry[0][2]: 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
58
 
 
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
62
 
entry[1][0][2]: size
63
 
entry[1][0][3]: executable
64
 
entry[1][0][4]: packed_stat
65
 
OR (for non tree-0)
66
 
entry[1][1][4]: revision_id
 
23
::
 
24
 
 
25
    MINIKIND = "f" | "d" | "l" | "a" | "r" | "t";
 
26
    NL = "\\n";
 
27
    NULL = "\\0";
 
28
    WHOLE_NUMBER = {digit}, digit;
 
29
    BOOLEAN = "y" | "n";
 
30
    REVISION_ID = a non-empty utf8 string;
 
31
    
 
32
    dirstate format = header line, full checksum, row count, parent details,
 
33
     ghost_details, entries;
 
34
    header line = "#bazaar dirstate flat format 3", NL;
 
35
    full checksum = "crc32: ", ["-"], WHOLE_NUMBER, NL;
 
36
    row count = "num_entries: ", WHOLE_NUMBER, NL;
 
37
    parent_details = WHOLE NUMBER, {REVISION_ID}* NL;
 
38
    ghost_details = WHOLE NUMBER, {REVISION_ID}*, NL;
 
39
    entries = {entry};
 
40
    entry = entry_key, current_entry_details, {parent_entry_details};
 
41
    entry_key = dirname,  basename, fileid;
 
42
    current_entry_details = common_entry_details, working_entry_details;
 
43
    parent_entry_details = common_entry_details, history_entry_details;
 
44
    common_entry_details = MINIKIND, fingerprint, size, executable
 
45
    working_entry_details = packed_stat
 
46
    history_entry_details = REVISION_ID;
 
47
    executable = BOOLEAN;
 
48
    size = WHOLE_NUMBER;
 
49
    fingerprint = a nonempty utf8 sequence with meaning defined by minikind.
 
50
 
 
51
Given this definition, the following is useful to know::
 
52
 
 
53
    entry (aka row) - all the data for a given key.
 
54
    entry[0]: The key (dirname, basename, fileid)
 
55
    entry[0][0]: dirname
 
56
    entry[0][1]: basename
 
57
    entry[0][2]: fileid
 
58
    entry[1]: The tree(s) data for this path and id combination.
 
59
    entry[1][0]: The current tree
 
60
    entry[1][1]: The second tree
 
61
 
 
62
For an entry for a tree, we have (using tree 0 - current tree) to demonstrate::
 
63
 
 
64
    entry[1][0][0]: minikind
 
65
    entry[1][0][1]: fingerprint
 
66
    entry[1][0][2]: size
 
67
    entry[1][0][3]: executable
 
68
    entry[1][0][4]: packed_stat
 
69
 
 
70
OR (for non tree-0)::
 
71
 
 
72
    entry[1][1][4]: revision_id
67
73
 
68
74
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
72
 
entries[0][0]: ''
73
 
entries[0][1]: ''
74
 
entries[0][2]: file_id
75
 
entries[1][0]: The tree data for the current tree for this fileid at /
76
 
etc.
77
 
 
78
 
Kinds:
79
 
'r' is a relocated entry: This path is not present in this tree with this id,
80
 
    but the id can be found at another location. The fingerprint is used to
81
 
    point to the target location.
82
 
'a' is an absent entry: In that tree the id is not present at this path.
83
 
'd' is a directory entry: This path in this tree is a directory with the
84
 
    current file id. There is no fingerprint for directories.
85
 
'f' is a file entry: As for directory, but it's a file. The fingerprint is the
86
 
    sha1 value of the file's canonical form, i.e. after any read filters have
87
 
    been applied to the convenience form stored in the working tree.
88
 
'l' is a symlink entry: As for directory, but a symlink. The fingerprint is the
89
 
    link target.
90
 
't' is a reference to a nested subtree; the fingerprint is the referenced
91
 
    revision.
 
75
in memory root row is now::
 
76
 
 
77
    self._dirblocks[0] -> ('', [entry ...]),
 
78
 
 
79
and the entries in there are::
 
80
 
 
81
    entries[0][0]: ''
 
82
    entries[0][1]: ''
 
83
    entries[0][2]: file_id
 
84
    entries[1][0]: The tree data for the current tree for this fileid at /
 
85
    etc.
 
86
 
 
87
Kinds::
 
88
 
 
89
    'r' is a relocated entry: This path is not present in this tree with this
 
90
        id, but the id can be found at another location. The fingerprint is
 
91
        used to point to the target location.
 
92
    'a' is an absent entry: In that tree the id is not present at this path.
 
93
    'd' is a directory entry: This path in this tree is a directory with the
 
94
        current file id. There is no fingerprint for directories.
 
95
    'f' is a file entry: As for directory, but it's a file. The fingerprint is
 
96
        the sha1 value of the file's canonical form, i.e. after any read
 
97
        filters have been applied to the convenience form stored in the working
 
98
        tree.
 
99
    'l' is a symlink entry: As for directory, but a symlink. The fingerprint is
 
100
        the link target.
 
101
    't' is a reference to a nested subtree; the fingerprint is the referenced
 
102
        revision.
92
103
 
93
104
Ordering:
94
105
 
95
 
The entries on disk and in memory are ordered according to the following keys:
 
106
The entries on disk and in memory are ordered according to the following keys::
96
107
 
97
108
    directory, as a list of components
98
109
    filename
99
110
    file-id
100
111
 
101
112
--- Format 1 had the following different definition: ---
102
 
rows = dirname, NULL, basename, NULL, MINIKIND, NULL, fileid_utf8, NULL,
103
 
    WHOLE NUMBER (* size *), NULL, packed stat, NULL, sha1|symlink target,
104
 
    {PARENT ROW}
105
 
PARENT ROW = NULL, revision_utf8, NULL, MINIKIND, NULL, dirname, NULL,
106
 
    basename, NULL, WHOLE NUMBER (* size *), NULL, "y" | "n", NULL,
107
 
    SHA1
 
113
 
 
114
::
 
115
 
 
116
    rows = dirname, NULL, basename, NULL, MINIKIND, NULL, fileid_utf8, NULL,
 
117
        WHOLE NUMBER (* size *), NULL, packed stat, NULL, sha1|symlink target,
 
118
        {PARENT ROW}
 
119
    PARENT ROW = NULL, revision_utf8, NULL, MINIKIND, NULL, dirname, NULL,
 
120
        basename, NULL, WHOLE NUMBER (* size *), NULL, "y" | "n", NULL,
 
121
        SHA1
108
122
 
109
123
PARENT ROW's are emitted for every parent that is not in the ghosts details
110
124
line. That is, if the parents are foo, bar, baz, and the ghosts are bar, then
135
149
----
136
150
 
137
151
Design priorities:
138
 
 1) Fast end to end use for bzr's top 5 uses cases. (commmit/diff/status/merge/???)
139
 
 2) fall back current object model as needed.
140
 
 3) scale usably to the largest trees known today - say 50K entries. (mozilla
 
152
 1. Fast end to end use for bzr's top 5 uses cases. (commmit/diff/status/merge/???)
 
153
 2. fall back current object model as needed.
 
154
 3. scale usably to the largest trees known today - say 50K entries. (mozilla
141
155
    is an example of this)
142
156
 
143
157
 
144
158
Locking:
 
159
 
145
160
 Eventually reuse dirstate objects across locks IFF the dirstate file has not
146
161
 been modified, but will require that we flush/ignore cached stat-hit data
147
162
 because we won't want to restat all files on disk just because a lock was
148
163
 acquired, yet we cannot trust the data after the previous lock was released.
149
164
 
150
 
Memory representation:
 
165
Memory representation::
 
166
 
151
167
 vector of all directories, and vector of the childen ?
152
168
   i.e.
153
169
     root_entrie = (direntry for root, [parent_direntries_for_root]),
167
183
    - What's the risk of error here? Once we have the base format being processed
168
184
      we should have a net win regardless of optimality. So we are going to
169
185
      go with what seems reasonable.
 
186
 
170
187
open questions:
171
188
 
172
189
Maybe we should do a test profile of the core structure - 10K simulated
201
218
 
202
219
"""
203
220
 
 
221
from __future__ import absolute_import
 
222
 
204
223
import bisect
205
 
import binascii
206
224
import errno
207
225
import operator
208
226
import os
209
227
from stat import S_IEXEC
210
228
import stat
211
 
import struct
212
229
import sys
213
230
import time
214
231
import zlib
215
232
 
216
 
from bzrlib import (
 
233
from breezy import (
217
234
    cache_utf8,
 
235
    config,
218
236
    debug,
219
237
    errors,
220
238
    inventory,
221
239
    lock,
222
240
    osutils,
 
241
    static_tuple,
223
242
    trace,
 
243
    urlutils,
 
244
    )
 
245
from .sixish import (
 
246
    range,
224
247
    )
225
248
 
226
249
 
231
254
ERROR_DIRECTORY = 267
232
255
 
233
256
 
234
 
if not getattr(struct, '_compile', None):
235
 
    # Cannot pre-compile the dirstate pack_stat
236
 
    def pack_stat(st, _encode=binascii.b2a_base64, _pack=struct.pack):
237
 
        """Convert stat values into a packed representation."""
238
 
        return _encode(_pack('>LLLLLL', st.st_size, int(st.st_mtime),
239
 
            int(st.st_ctime), st.st_dev, st.st_ino & 0xFFFFFFFF,
240
 
            st.st_mode))[:-1]
241
 
else:
242
 
    # compile the struct compiler we need, so as to only do it once
243
 
    from _struct import Struct
244
 
    _compiled_pack = Struct('>LLLLLL').pack
245
 
    def pack_stat(st, _encode=binascii.b2a_base64, _pack=_compiled_pack):
246
 
        """Convert stat values into a packed representation."""
247
 
        # jam 20060614 it isn't really worth removing more entries if we
248
 
        # are going to leave it in packed form.
249
 
        # With only st_mtime and st_mode filesize is 5.5M and read time is 275ms
250
 
        # With all entries, filesize is 5.9M and read time is maybe 280ms
251
 
        # well within the noise margin
252
 
 
253
 
        # base64 encoding always adds a final newline, so strip it off
254
 
        # The current version
255
 
        return _encode(_pack(st.st_size, int(st.st_mtime), int(st.st_ctime),
256
 
            st.st_dev, st.st_ino & 0xFFFFFFFF, st.st_mode))[:-1]
257
 
        # This is 0.060s / 1.520s faster by not encoding as much information
258
 
        # return _encode(_pack('>LL', int(st.st_mtime), st.st_mode))[:-1]
259
 
        # This is not strictly faster than _encode(_pack())[:-1]
260
 
        # return '%X.%X.%X.%X.%X.%X' % (
261
 
        #      st.st_size, int(st.st_mtime), int(st.st_ctime),
262
 
        #      st.st_dev, st.st_ino, st.st_mode)
263
 
        # Similar to the _encode(_pack('>LL'))
264
 
        # return '%X.%X' % (int(st.st_mtime), st.st_mode)
265
 
 
266
 
 
267
257
class SHA1Provider(object):
268
258
    """An interface for getting sha1s of a file."""
269
259
 
354
344
    NOT_IN_MEMORY = 0
355
345
    IN_MEMORY_UNMODIFIED = 1
356
346
    IN_MEMORY_MODIFIED = 2
 
347
    IN_MEMORY_HASH_MODIFIED = 3 # Only hash-cache updates
357
348
 
358
349
    # A pack_stat (the x's) that is just noise and will never match the output
359
350
    # of base64 encode.
360
351
    NULLSTAT = 'x' * 32
361
 
    NULL_PARENT_DETAILS = ('a', '', 0, False, '')
 
352
    NULL_PARENT_DETAILS = static_tuple.StaticTuple('a', '', 0, False, '')
362
353
 
363
354
    HEADER_FORMAT_2 = '#bazaar dirstate flat format 2\n'
364
355
    HEADER_FORMAT_3 = '#bazaar dirstate flat format 3\n'
365
356
 
366
 
    def __init__(self, path, sha1_provider):
 
357
    def __init__(self, path, sha1_provider, worth_saving_limit=0):
367
358
        """Create a  DirState object.
368
359
 
369
360
        :param path: The path at which the dirstate file on disk should live.
370
361
        :param sha1_provider: an object meeting the SHA1Provider interface.
 
362
        :param worth_saving_limit: when the exact number of hash changed
 
363
            entries is known, only bother saving the dirstate if more than
 
364
            this count of entries have changed.
 
365
            -1 means never save hash changes, 0 means always save hash changes.
371
366
        """
372
367
        # _header_state and _dirblock_state represent the current state
373
368
        # of the dirstate metadata and the per-row data respectiely.
410
405
        # during commit.
411
406
        self._last_block_index = None
412
407
        self._last_entry_index = None
 
408
        # The set of known hash changes
 
409
        self._known_hash_changes = set()
 
410
        # How many hash changed entries can we have without saving
 
411
        self._worth_saving_limit = worth_saving_limit
 
412
        self._config_stack = config.LocationStack(urlutils.local_path_to_url(
 
413
            path))
413
414
 
414
415
    def __repr__(self):
415
416
        return "%s(%r)" % \
416
417
            (self.__class__.__name__, self._filename)
417
418
 
 
419
    def _mark_modified(self, hash_changed_entries=None, header_modified=False):
 
420
        """Mark this dirstate as modified.
 
421
 
 
422
        :param hash_changed_entries: if non-None, mark just these entries as
 
423
            having their hash modified.
 
424
        :param header_modified: mark the header modified as well, not just the
 
425
            dirblocks.
 
426
        """
 
427
        #trace.mutter_callsite(3, "modified hash entries: %s", hash_changed_entries)
 
428
        if hash_changed_entries:
 
429
            self._known_hash_changes.update([e[0] for e in hash_changed_entries])
 
430
            if self._dirblock_state in (DirState.NOT_IN_MEMORY,
 
431
                                        DirState.IN_MEMORY_UNMODIFIED):
 
432
                # If the dirstate is already marked a IN_MEMORY_MODIFIED, then
 
433
                # that takes precedence.
 
434
                self._dirblock_state = DirState.IN_MEMORY_HASH_MODIFIED
 
435
        else:
 
436
            # TODO: Since we now have a IN_MEMORY_HASH_MODIFIED state, we
 
437
            #       should fail noisily if someone tries to set
 
438
            #       IN_MEMORY_MODIFIED but we don't have a write-lock!
 
439
            # We don't know exactly what changed so disable smart saving
 
440
            self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
441
        if header_modified:
 
442
            self._header_state = DirState.IN_MEMORY_MODIFIED
 
443
 
 
444
    def _mark_unmodified(self):
 
445
        """Mark this dirstate as unmodified."""
 
446
        self._header_state = DirState.IN_MEMORY_UNMODIFIED
 
447
        self._dirblock_state = DirState.IN_MEMORY_UNMODIFIED
 
448
        self._known_hash_changes = set()
 
449
 
418
450
    def add(self, path, file_id, kind, stat, fingerprint):
419
451
        """Add a path to be tracked.
420
452
 
489
521
                block[entry_index][0][0:2] == first_key[0:2]):
490
522
                if block[entry_index][1][0][0] not in 'ar':
491
523
                    # this path is in the dirstate in the current tree.
492
 
                    raise Exception, "adding already added path!"
 
524
                    raise Exception("adding already added path!")
493
525
                entry_index += 1
494
526
        else:
495
527
            # The block where we want to put the file is not present. But it
546
578
        if kind == 'directory':
547
579
           # insert a new dirblock
548
580
           self._ensure_block(block_index, entry_index, utf8path)
549
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
581
        self._mark_modified()
550
582
        if self._id_index:
551
 
            self._id_index.setdefault(entry_key[2], set()).add(entry_key)
 
583
            self._add_to_id_index(self._id_index, entry_key)
552
584
 
553
585
    def _bisect(self, paths):
554
586
        """Bisect through the disk structure for specific rows.
705
737
                    # careful if we should append rather than overwrite
706
738
                    if last_entry_num != first_entry_num:
707
739
                        paths.setdefault(last_path, []).append(last_fields)
708
 
                    for num in xrange(first_entry_num+1, last_entry_num):
 
740
                    for num in range(first_entry_num+1, last_entry_num):
709
741
                        # TODO: jam 20070223 We are already splitting here, so
710
742
                        #       shouldn't we just split the whole thing rather
711
743
                        #       than doing the split again in add_one_record?
891
923
                    # careful if we should append rather than overwrite
892
924
                    if last_entry_num != first_entry_num:
893
925
                        paths.setdefault(last_dir, []).append(last_fields)
894
 
                    for num in xrange(first_entry_num+1, last_entry_num):
 
926
                    for num in range(first_entry_num+1, last_entry_num):
895
927
                        # TODO: jam 20070223 We are already splitting here, so
896
928
                        #       shouldn't we just split the whole thing rather
897
929
                        #       than doing the split again in add_one_record?
993
1025
            return
994
1026
        # only require all dirblocks if we are doing a full-pass removal.
995
1027
        self._read_dirblocks_if_needed()
996
 
        dead_patterns = set([('a', 'r'), ('a', 'a'), ('r', 'r'), ('r', 'a')])
 
1028
        dead_patterns = {('a', 'r'), ('a', 'a'), ('r', 'r'), ('r', 'a')}
997
1029
        def iter_entries_removable():
998
1030
            for block in self._dirblocks:
999
1031
                deleted_positions = []
1018
1050
 
1019
1051
        self._ghosts = []
1020
1052
        self._parents = [parents[0]]
1021
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1022
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
 
1053
        self._mark_modified(header_modified=True)
1023
1054
 
1024
1055
    def _empty_parent_info(self):
1025
1056
        return [DirState.NULL_PARENT_DETAILS] * (len(self._parents) -
1154
1185
    def _fields_per_entry(self):
1155
1186
        """How many null separated fields should be in each entry row.
1156
1187
 
1157
 
        Each line now has an extra '\n' field which is not used
 
1188
        Each line now has an extra '\\n' field which is not used
1158
1189
        so we just skip over it
1159
 
        entry size:
 
1190
 
 
1191
        entry size::
1160
1192
            3 fields for the key
1161
1193
            + number of fields per tree_data (5) * tree count
1162
1194
            + newline
1263
1295
                    parent_trees.append((parent_id, parent_tree))
1264
1296
                    parent_tree.lock_read()
1265
1297
                result.set_parent_trees(parent_trees, [])
1266
 
                result.set_state_from_inventory(tree.inventory)
 
1298
                result.set_state_from_inventory(tree.root_inventory)
1267
1299
            finally:
1268
1300
                for revid, parent_tree in parent_trees:
1269
1301
                    parent_tree.unlock()
1275
1307
            raise
1276
1308
        return result
1277
1309
 
 
1310
    def _check_delta_is_valid(self, delta):
 
1311
        return list(inventory._check_delta_unique_ids(
 
1312
                    inventory._check_delta_unique_old_paths(
 
1313
                    inventory._check_delta_unique_new_paths(
 
1314
                    inventory._check_delta_ids_match_entry(
 
1315
                    inventory._check_delta_ids_are_valid(
 
1316
                    inventory._check_delta_new_path_entry_both_or_None(delta)))))))
 
1317
 
1278
1318
    def update_by_delta(self, delta):
1279
1319
        """Apply an inventory delta to the dirstate for tree 0
1280
1320
 
1298
1338
        new_ids = set()
1299
1339
        # This loop transforms the delta to single atomic operations that can
1300
1340
        # be executed and validated.
1301
 
        for old_path, new_path, file_id, inv_entry in sorted(
1302
 
            inventory._check_delta_unique_old_paths(
1303
 
            inventory._check_delta_unique_new_paths(
1304
 
            inventory._check_delta_ids_match_entry(
1305
 
            inventory._check_delta_ids_are_valid(
1306
 
            inventory._check_delta_new_path_entry_both_or_None(delta))))),
1307
 
            reverse=True):
 
1341
        delta = sorted(self._check_delta_is_valid(delta), reverse=True)
 
1342
        for old_path, new_path, file_id, inv_entry in delta:
1308
1343
            if (file_id in insertions) or (file_id in removals):
1309
 
                raise errors.InconsistentDelta(old_path or new_path, file_id,
 
1344
                self._raise_invalid(old_path or new_path, file_id,
1310
1345
                    "repeated file_id")
1311
1346
            if old_path is not None:
1312
1347
                old_path = old_path.encode('utf-8')
1315
1350
                new_ids.add(file_id)
1316
1351
            if new_path is not None:
1317
1352
                if inv_entry is None:
1318
 
                    raise errors.InconsistentDelta(new_path, file_id,
 
1353
                    self._raise_invalid(new_path, file_id,
1319
1354
                        "new_path with no entry")
1320
1355
                new_path = new_path.encode('utf-8')
1321
1356
                dirname_utf8, basename = osutils.split(new_path)
1355
1390
            self._apply_insertions(insertions.values())
1356
1391
            # Validate parents
1357
1392
            self._after_delta_check_parents(parents, 0)
1358
 
        except errors.BzrError, e:
 
1393
        except errors.BzrError as e:
1359
1394
            self._changes_aborted = True
1360
1395
            if 'integrity error' not in str(e):
1361
1396
                raise
1362
1397
            # _get_entry raises BzrError when a request is inconsistent; we
1363
1398
            # want such errors to be shown as InconsistentDelta - and that 
1364
1399
            # fits the behaviour we trigger.
1365
 
            raise errors.InconsistentDeltaDelta(delta, "error from _get_entry.")
 
1400
            raise errors.InconsistentDeltaDelta(delta,
 
1401
                "error from _get_entry. %s" % (e,))
1366
1402
 
1367
1403
    def _apply_removals(self, removals):
1368
1404
        for file_id, path in sorted(removals, reverse=True,
1373
1409
            try:
1374
1410
                entry = self._dirblocks[block_i][1][entry_i]
1375
1411
            except IndexError:
1376
 
                self._changes_aborted = True
1377
 
                raise errors.InconsistentDelta(path, file_id,
 
1412
                self._raise_invalid(path, file_id,
1378
1413
                    "Wrong path for old path.")
1379
1414
            if not f_present or entry[1][0][0] in 'ar':
1380
 
                self._changes_aborted = True
1381
 
                raise errors.InconsistentDelta(path, file_id,
 
1415
                self._raise_invalid(path, file_id,
1382
1416
                    "Wrong path for old path.")
1383
1417
            if file_id != entry[0][2]:
1384
 
                self._changes_aborted = True
1385
 
                raise errors.InconsistentDelta(path, file_id,
 
1418
                self._raise_invalid(path, file_id,
1386
1419
                    "Attempt to remove path has wrong id - found %r."
1387
1420
                    % entry[0][2])
1388
1421
            self._make_absent(entry)
1398
1431
                # be due to it being in a parent tree, or a corrupt delta.
1399
1432
                for child_entry in self._dirblocks[block_i][1]:
1400
1433
                    if child_entry[1][0][0] not in ('r', 'a'):
1401
 
                        self._changes_aborted = True
1402
 
                        raise errors.InconsistentDelta(path, entry[0][2],
 
1434
                        self._raise_invalid(path, entry[0][2],
1403
1435
                            "The file id was deleted but its children were "
1404
1436
                            "not deleted.")
1405
1437
 
1409
1441
                self.update_minimal(key, minikind, executable, fingerprint,
1410
1442
                                    path_utf8=path_utf8)
1411
1443
        except errors.NotVersionedError:
1412
 
            self._changes_aborted = True
1413
 
            raise errors.InconsistentDelta(path_utf8.decode('utf8'), key[2],
 
1444
            self._raise_invalid(path_utf8.decode('utf8'), key[2],
1414
1445
                "Missing parent")
1415
1446
 
1416
1447
    def update_basis_by_delta(self, delta, new_revid):
1424
1455
        Note that an exception during the operation of this method will leave
1425
1456
        the dirstate in a corrupt state where it should not be saved.
1426
1457
 
1427
 
        Finally, we expect all changes to be synchronising the basis tree with
1428
 
        the working tree.
1429
 
 
1430
1458
        :param new_revid: The new revision id for the trees parent.
1431
1459
        :param delta: An inventory delta (see apply_inventory_delta) describing
1432
1460
            the changes from the current left most parent revision to new_revid.
1444
1472
 
1445
1473
        self._parents[0] = new_revid
1446
1474
 
1447
 
        delta = sorted(delta, reverse=True)
 
1475
        delta = sorted(self._check_delta_is_valid(delta), reverse=True)
1448
1476
        adds = []
1449
1477
        changes = []
1450
1478
        deletes = []
1471
1499
        new_ids = set()
1472
1500
        for old_path, new_path, file_id, inv_entry in delta:
1473
1501
            if inv_entry is not None and file_id != inv_entry.file_id:
1474
 
                raise errors.InconsistentDelta(new_path, file_id,
 
1502
                self._raise_invalid(new_path, file_id,
1475
1503
                    "mismatched entry file_id %r" % inv_entry)
1476
 
            if new_path is not None:
 
1504
            if new_path is None:
 
1505
                new_path_utf8 = None
 
1506
            else:
1477
1507
                if inv_entry is None:
1478
 
                    raise errors.InconsistentDelta(new_path, file_id,
 
1508
                    self._raise_invalid(new_path, file_id,
1479
1509
                        "new_path with no entry")
1480
1510
                new_path_utf8 = encode(new_path)
1481
1511
                # note the parent for validation
1483
1513
                if basename_utf8:
1484
1514
                    parents.add((dirname_utf8, inv_entry.parent_id))
1485
1515
            if old_path is None:
1486
 
                adds.append((None, encode(new_path), file_id,
 
1516
                old_path_utf8 = None
 
1517
            else:
 
1518
                old_path_utf8 = encode(old_path)
 
1519
            if old_path is None:
 
1520
                adds.append((None, new_path_utf8, file_id,
1487
1521
                    inv_to_entry(inv_entry), True))
1488
1522
                new_ids.add(file_id)
1489
1523
            elif new_path is None:
1490
 
                deletes.append((encode(old_path), None, file_id, None, True))
1491
 
            elif (old_path, new_path) != root_only:
 
1524
                deletes.append((old_path_utf8, None, file_id, None, True))
 
1525
            elif (old_path, new_path) == root_only:
 
1526
                # change things in-place
 
1527
                # Note: the case of a parent directory changing its file_id
 
1528
                #       tends to break optimizations here, because officially
 
1529
                #       the file has actually been moved, it just happens to
 
1530
                #       end up at the same path. If we can figure out how to
 
1531
                #       handle that case, we can avoid a lot of add+delete
 
1532
                #       pairs for objects that stay put.
 
1533
                # elif old_path == new_path:
 
1534
                changes.append((old_path_utf8, new_path_utf8, file_id,
 
1535
                                inv_to_entry(inv_entry)))
 
1536
            else:
1492
1537
                # Renames:
1493
1538
                # Because renames must preserve their children we must have
1494
1539
                # processed all relocations and removes before hand. The sort
1504
1549
                self._update_basis_apply_deletes(deletes)
1505
1550
                deletes = []
1506
1551
                # Split into an add/delete pair recursively.
1507
 
                adds.append((None, new_path_utf8, file_id,
1508
 
                    inv_to_entry(inv_entry), False))
 
1552
                adds.append((old_path_utf8, new_path_utf8, file_id,
 
1553
                             inv_to_entry(inv_entry), False))
1509
1554
                # Expunge deletes that we've seen so that deleted/renamed
1510
1555
                # children of a rename directory are handled correctly.
1511
 
                new_deletes = reversed(list(self._iter_child_entries(1,
1512
 
                    encode(old_path))))
 
1556
                new_deletes = reversed(list(
 
1557
                    self._iter_child_entries(1, old_path_utf8)))
1513
1558
                # Remove the current contents of the tree at orig_path, and
1514
1559
                # reinsert at the correct new path.
1515
1560
                for entry in new_deletes:
1516
 
                    if entry[0][0]:
1517
 
                        source_path = entry[0][0] + '/' + entry[0][1]
 
1561
                    child_dirname, child_basename, child_file_id = entry[0]
 
1562
                    if child_dirname:
 
1563
                        source_path = child_dirname + '/' + child_basename
1518
1564
                    else:
1519
 
                        source_path = entry[0][1]
 
1565
                        source_path = child_basename
1520
1566
                    if new_path_utf8:
1521
 
                        target_path = new_path_utf8 + source_path[len(old_path):]
 
1567
                        target_path = \
 
1568
                            new_path_utf8 + source_path[len(old_path_utf8):]
1522
1569
                    else:
1523
 
                        if old_path == '':
 
1570
                        if old_path_utf8 == '':
1524
1571
                            raise AssertionError("cannot rename directory to"
1525
 
                                " itself")
1526
 
                        target_path = source_path[len(old_path) + 1:]
 
1572
                                                 " itself")
 
1573
                        target_path = source_path[len(old_path_utf8) + 1:]
1527
1574
                    adds.append((None, target_path, entry[0][2], entry[1][1], False))
1528
1575
                    deletes.append(
1529
1576
                        (source_path, target_path, entry[0][2], None, False))
1530
1577
                deletes.append(
1531
 
                    (encode(old_path), new_path, file_id, None, False))
1532
 
            else:
1533
 
                # changes to just the root should not require remove/insertion
1534
 
                # of everything.
1535
 
                changes.append((encode(old_path), encode(new_path), file_id,
1536
 
                    inv_to_entry(inv_entry)))
 
1578
                    (old_path_utf8, new_path_utf8, file_id, None, False))
 
1579
 
1537
1580
        self._check_delta_ids_absent(new_ids, delta, 1)
1538
1581
        try:
1539
1582
            # Finish expunging deletes/first half of renames.
1544
1587
            self._update_basis_apply_changes(changes)
1545
1588
            # Validate parents
1546
1589
            self._after_delta_check_parents(parents, 1)
1547
 
        except errors.BzrError, e:
 
1590
        except errors.BzrError as e:
1548
1591
            self._changes_aborted = True
1549
1592
            if 'integrity error' not in str(e):
1550
1593
                raise
1551
1594
            # _get_entry raises BzrError when a request is inconsistent; we
1552
 
            # want such errors to be shown as InconsistentDelta - and that 
1553
 
            # fits the behaviour we trigger. Partof this is driven by dirstate
1554
 
            # only supporting deltas that turn the basis into a closer fit to
1555
 
            # the active tree.
1556
 
            raise errors.InconsistentDeltaDelta(delta, "error from _get_entry.")
 
1595
            # want such errors to be shown as InconsistentDelta - and that
 
1596
            # fits the behaviour we trigger.
 
1597
            raise errors.InconsistentDeltaDelta(delta,
 
1598
                "error from _get_entry. %s" % (e,))
1557
1599
 
1558
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1559
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
 
1600
        self._mark_modified(header_modified=True)
1560
1601
        self._id_index = None
1561
1602
        return
1562
1603
 
1566
1607
            return
1567
1608
        id_index = self._get_id_index()
1568
1609
        for file_id in new_ids:
1569
 
            for key in id_index.get(file_id, []):
 
1610
            for key in id_index.get(file_id, ()):
1570
1611
                block_i, entry_i, d_present, f_present = \
1571
1612
                    self._get_block_entry_index(key[0], key[1], tree_index)
1572
1613
                if not f_present:
1576
1617
                if entry[0][2] != file_id:
1577
1618
                    # Different file_id, so not what we want.
1578
1619
                    continue
1579
 
                # NB: No changes made before this helper is called, so no need
1580
 
                # to set the _changes_aborted flag.
1581
 
                raise errors.InconsistentDelta(
1582
 
                    ("%s/%s" % key[0:2]).decode('utf8'), file_id,
 
1620
                self._raise_invalid(("%s/%s" % key[0:2]).decode('utf8'), file_id,
1583
1621
                    "This file_id is new in the delta but already present in "
1584
1622
                    "the target")
1585
1623
 
 
1624
    def _raise_invalid(self, path, file_id, reason):
 
1625
        self._changes_aborted = True
 
1626
        raise errors.InconsistentDelta(path, file_id, reason)
 
1627
 
1586
1628
    def _update_basis_apply_adds(self, adds):
1587
1629
        """Apply a sequence of adds to tree 1 during update_basis_by_delta.
1588
1630
 
1596
1638
        """
1597
1639
        # Adds are accumulated partly from renames, so can be in any input
1598
1640
        # order - sort it.
1599
 
        adds.sort()
 
1641
        # TODO: we may want to sort in dirblocks order. That way each entry
 
1642
        #       will end up in the same directory, allowing the _get_entry
 
1643
        #       fast-path for looking up 2 items in the same dir work.
 
1644
        adds.sort(key=lambda x: x[1])
1600
1645
        # adds is now in lexographic order, which places all parents before
1601
1646
        # their children, so we can process it linearly.
1602
1647
        absent = 'ar'
 
1648
        st = static_tuple.StaticTuple
1603
1649
        for old_path, new_path, file_id, new_details, real_add in adds:
1604
 
            # the entry for this file_id must be in tree 0.
1605
 
            entry = self._get_entry(0, file_id, new_path)
1606
 
            if entry[0] is None or entry[0][2] != file_id:
1607
 
                self._changes_aborted = True
1608
 
                raise errors.InconsistentDelta(new_path, file_id,
1609
 
                    'working tree does not contain new entry')
1610
 
            if real_add and entry[1][1][0] not in absent:
1611
 
                self._changes_aborted = True
1612
 
                raise errors.InconsistentDelta(new_path, file_id,
1613
 
                    'The entry was considered to be a genuinely new record,'
1614
 
                    ' but there was already an old record for it.')
1615
 
            # We don't need to update the target of an 'r' because the handling
1616
 
            # of renames turns all 'r' situations into a delete at the original
1617
 
            # location.
1618
 
            entry[1][1] = new_details
 
1650
            dirname, basename = osutils.split(new_path)
 
1651
            entry_key = st(dirname, basename, file_id)
 
1652
            block_index, present = self._find_block_index_from_key(entry_key)
 
1653
            if not present:
 
1654
                # The block where we want to put the file is not present.
 
1655
                # However, it might have just been an empty directory. Look for
 
1656
                # the parent in the basis-so-far before throwing an error.
 
1657
                parent_dir, parent_base = osutils.split(dirname)
 
1658
                parent_block_idx, parent_entry_idx, _, parent_present = \
 
1659
                    self._get_block_entry_index(parent_dir, parent_base, 1)
 
1660
                if not parent_present:
 
1661
                    self._raise_invalid(new_path, file_id,
 
1662
                        "Unable to find block for this record."
 
1663
                        " Was the parent added?")
 
1664
                self._ensure_block(parent_block_idx, parent_entry_idx, dirname)
 
1665
 
 
1666
            block = self._dirblocks[block_index][1]
 
1667
            entry_index, present = self._find_entry_index(entry_key, block)
 
1668
            if real_add:
 
1669
                if old_path is not None:
 
1670
                    self._raise_invalid(new_path, file_id,
 
1671
                        'considered a real add but still had old_path at %s'
 
1672
                        % (old_path,))
 
1673
            if present:
 
1674
                entry = block[entry_index]
 
1675
                basis_kind = entry[1][1][0]
 
1676
                if basis_kind == 'a':
 
1677
                    entry[1][1] = new_details
 
1678
                elif basis_kind == 'r':
 
1679
                    raise NotImplementedError()
 
1680
                else:
 
1681
                    self._raise_invalid(new_path, file_id,
 
1682
                        "An entry was marked as a new add"
 
1683
                        " but the basis target already existed")
 
1684
            else:
 
1685
                # The exact key was not found in the block. However, we need to
 
1686
                # check if there is a key next to us that would have matched.
 
1687
                # We only need to check 2 locations, because there are only 2
 
1688
                # trees present.
 
1689
                for maybe_index in range(entry_index-1, entry_index+1):
 
1690
                    if maybe_index < 0 or maybe_index >= len(block):
 
1691
                        continue
 
1692
                    maybe_entry = block[maybe_index]
 
1693
                    if maybe_entry[0][:2] != (dirname, basename):
 
1694
                        # Just a random neighbor
 
1695
                        continue
 
1696
                    if maybe_entry[0][2] == file_id:
 
1697
                        raise AssertionError(
 
1698
                            '_find_entry_index didnt find a key match'
 
1699
                            ' but walking the data did, for %s'
 
1700
                            % (entry_key,))
 
1701
                    basis_kind = maybe_entry[1][1][0]
 
1702
                    if basis_kind not in 'ar':
 
1703
                        self._raise_invalid(new_path, file_id,
 
1704
                            "we have an add record for path, but the path"
 
1705
                            " is already present with another file_id %s"
 
1706
                            % (maybe_entry[0][2],))
 
1707
 
 
1708
                entry = (entry_key, [DirState.NULL_PARENT_DETAILS,
 
1709
                                     new_details])
 
1710
                block.insert(entry_index, entry)
 
1711
 
 
1712
            active_kind = entry[1][0][0]
 
1713
            if active_kind == 'a':
 
1714
                # The active record shows up as absent, this could be genuine,
 
1715
                # or it could be present at some other location. We need to
 
1716
                # verify.
 
1717
                id_index = self._get_id_index()
 
1718
                # The id_index may not be perfectly accurate for tree1, because
 
1719
                # we haven't been keeping it updated. However, it should be
 
1720
                # fine for tree0, and that gives us enough info for what we
 
1721
                # need
 
1722
                keys = id_index.get(file_id, ())
 
1723
                for key in keys:
 
1724
                    block_i, entry_i, d_present, f_present = \
 
1725
                        self._get_block_entry_index(key[0], key[1], 0)
 
1726
                    if not f_present:
 
1727
                        continue
 
1728
                    active_entry = self._dirblocks[block_i][1][entry_i]
 
1729
                    if (active_entry[0][2] != file_id):
 
1730
                        # Some other file is at this path, we don't need to
 
1731
                        # link it.
 
1732
                        continue
 
1733
                    real_active_kind = active_entry[1][0][0]
 
1734
                    if real_active_kind in 'ar':
 
1735
                        # We found a record, which was not *this* record,
 
1736
                        # which matches the file_id, but is not actually
 
1737
                        # present. Something seems *really* wrong.
 
1738
                        self._raise_invalid(new_path, file_id,
 
1739
                            "We found a tree0 entry that doesnt make sense")
 
1740
                    # Now, we've found a tree0 entry which matches the file_id
 
1741
                    # but is at a different location. So update them to be
 
1742
                    # rename records.
 
1743
                    active_dir, active_name = active_entry[0][:2]
 
1744
                    if active_dir:
 
1745
                        active_path = active_dir + '/' + active_name
 
1746
                    else:
 
1747
                        active_path = active_name
 
1748
                    active_entry[1][1] = st('r', new_path, 0, False, '')
 
1749
                    entry[1][0] = st('r', active_path, 0, False, '')
 
1750
            elif active_kind == 'r':
 
1751
                raise NotImplementedError()
 
1752
 
 
1753
            new_kind = new_details[0]
 
1754
            if new_kind == 'd':
 
1755
                self._ensure_block(block_index, entry_index, new_path)
1619
1756
 
1620
1757
    def _update_basis_apply_changes(self, changes):
1621
1758
        """Apply a sequence of changes to tree 1 during update_basis_by_delta.
1626
1763
        absent = 'ar'
1627
1764
        for old_path, new_path, file_id, new_details in changes:
1628
1765
            # the entry for this file_id must be in tree 0.
1629
 
            entry = self._get_entry(0, file_id, new_path)
1630
 
            if entry[0] is None or entry[0][2] != file_id:
1631
 
                self._changes_aborted = True
1632
 
                raise errors.InconsistentDelta(new_path, file_id,
1633
 
                    'working tree does not contain new entry')
1634
 
            if (entry[1][0][0] in absent or
1635
 
                entry[1][1][0] in absent):
1636
 
                self._changes_aborted = True
1637
 
                raise errors.InconsistentDelta(new_path, file_id,
1638
 
                    'changed considered absent')
 
1766
            entry = self._get_entry(1, file_id, new_path)
 
1767
            if entry[0] is None or entry[1][1][0] in 'ar':
 
1768
                self._raise_invalid(new_path, file_id,
 
1769
                    'changed entry considered not present')
1639
1770
            entry[1][1] = new_details
1640
1771
 
1641
1772
    def _update_basis_apply_deletes(self, deletes):
1653
1784
        null = DirState.NULL_PARENT_DETAILS
1654
1785
        for old_path, new_path, file_id, _, real_delete in deletes:
1655
1786
            if real_delete != (new_path is None):
1656
 
                self._changes_aborted = True
1657
 
                raise AssertionError("bad delete delta")
 
1787
                self._raise_invalid(old_path, file_id, "bad delete delta")
1658
1788
            # the entry for this file_id must be in tree 1.
1659
1789
            dirname, basename = osutils.split(old_path)
1660
1790
            block_index, entry_index, dir_present, file_present = \
1661
1791
                self._get_block_entry_index(dirname, basename, 1)
1662
1792
            if not file_present:
1663
 
                self._changes_aborted = True
1664
 
                raise errors.InconsistentDelta(old_path, file_id,
 
1793
                self._raise_invalid(old_path, file_id,
1665
1794
                    'basis tree does not contain removed entry')
1666
1795
            entry = self._dirblocks[block_index][1][entry_index]
 
1796
            # The state of the entry in the 'active' WT
 
1797
            active_kind = entry[1][0][0]
1667
1798
            if entry[0][2] != file_id:
1668
 
                self._changes_aborted = True
1669
 
                raise errors.InconsistentDelta(old_path, file_id,
 
1799
                self._raise_invalid(old_path, file_id,
1670
1800
                    'mismatched file_id in tree 1')
1671
 
            if real_delete:
1672
 
                if entry[1][0][0] != 'a':
1673
 
                    self._changes_aborted = True
1674
 
                    raise errors.InconsistentDelta(old_path, file_id,
1675
 
                            'This was marked as a real delete, but the WT state'
1676
 
                            ' claims that it still exists and is versioned.')
 
1801
            dir_block = ()
 
1802
            old_kind = entry[1][1][0]
 
1803
            if active_kind in 'ar':
 
1804
                # The active tree doesn't have this file_id.
 
1805
                # The basis tree is changing this record. If this is a
 
1806
                # rename, then we don't want the record here at all
 
1807
                # anymore. If it is just an in-place change, we want the
 
1808
                # record here, but we'll add it if we need to. So we just
 
1809
                # delete it
 
1810
                if active_kind == 'r':
 
1811
                    active_path = entry[1][0][1]
 
1812
                    active_entry = self._get_entry(0, file_id, active_path)
 
1813
                    if active_entry[1][1][0] != 'r':
 
1814
                        self._raise_invalid(old_path, file_id,
 
1815
                            "Dirstate did not have matching rename entries")
 
1816
                    elif active_entry[1][0][0] in 'ar':
 
1817
                        self._raise_invalid(old_path, file_id,
 
1818
                            "Dirstate had a rename pointing at an inactive"
 
1819
                            " tree0")
 
1820
                    active_entry[1][1] = null
1677
1821
                del self._dirblocks[block_index][1][entry_index]
 
1822
                if old_kind == 'd':
 
1823
                    # This was a directory, and the active tree says it
 
1824
                    # doesn't exist, and now the basis tree says it doesn't
 
1825
                    # exist. Remove its dirblock if present
 
1826
                    (dir_block_index,
 
1827
                     present) = self._find_block_index_from_key(
 
1828
                        (old_path, '', ''))
 
1829
                    if present:
 
1830
                        dir_block = self._dirblocks[dir_block_index][1]
 
1831
                        if not dir_block:
 
1832
                            # This entry is empty, go ahead and just remove it
 
1833
                            del self._dirblocks[dir_block_index]
1678
1834
            else:
1679
 
                if entry[1][0][0] == 'a':
1680
 
                    self._changes_aborted = True
1681
 
                    raise errors.InconsistentDelta(old_path, file_id,
1682
 
                        'The entry was considered a rename, but the source path'
1683
 
                        ' is marked as absent.')
1684
 
                    # For whatever reason, we were asked to rename an entry
1685
 
                    # that was originally marked as deleted. This could be
1686
 
                    # because we are renaming the parent directory, and the WT
1687
 
                    # current state has the file marked as deleted.
1688
 
                elif entry[1][0][0] == 'r':
1689
 
                    # implement the rename
1690
 
                    del self._dirblocks[block_index][1][entry_index]
1691
 
                else:
1692
 
                    # it is being resurrected here, so blank it out temporarily.
1693
 
                    self._dirblocks[block_index][1][entry_index][1][1] = null
 
1835
                # There is still an active record, so just mark this
 
1836
                # removed.
 
1837
                entry[1][1] = null
 
1838
                block_i, entry_i, d_present, f_present = \
 
1839
                    self._get_block_entry_index(old_path, '', 1)
 
1840
                if d_present:
 
1841
                    dir_block = self._dirblocks[block_i][1]
 
1842
            for child_entry in dir_block:
 
1843
                child_basis_kind = child_entry[1][1][0]
 
1844
                if child_basis_kind not in 'ar':
 
1845
                    self._raise_invalid(old_path, file_id,
 
1846
                        "The file id was deleted but its children were "
 
1847
                        "not deleted.")
1694
1848
 
1695
1849
    def _after_delta_check_parents(self, parents, index):
1696
1850
        """Check that parents required by the delta are all intact.
1705
1859
            # has the right file id.
1706
1860
            entry = self._get_entry(index, file_id, dirname_utf8)
1707
1861
            if entry[1] is None:
1708
 
                self._changes_aborted = True
1709
 
                raise errors.InconsistentDelta(dirname_utf8.decode('utf8'),
 
1862
                self._raise_invalid(dirname_utf8.decode('utf8'),
1710
1863
                    file_id, "This parent is not present.")
1711
1864
            # Parents of things must be directories
1712
1865
            if entry[1][index][0] != 'd':
1713
 
                self._changes_aborted = True
1714
 
                raise errors.InconsistentDelta(dirname_utf8.decode('utf8'),
 
1866
                self._raise_invalid(dirname_utf8.decode('utf8'),
1715
1867
                    file_id, "This parent is not a directory.")
1716
1868
 
1717
1869
    def _observed_sha1(self, entry, sha1, stat_value,
1718
 
        _stat_to_minikind=_stat_to_minikind, _pack_stat=pack_stat):
 
1870
        _stat_to_minikind=_stat_to_minikind):
1719
1871
        """Note the sha1 of a file.
1720
1872
 
1721
1873
        :param entry: The entry the sha1 is for.
1723
1875
        :param stat_value: The os.lstat for the file.
1724
1876
        """
1725
1877
        try:
1726
 
            minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
 
1878
            minikind = _stat_to_minikind[stat_value.st_mode & 0o170000]
1727
1879
        except KeyError:
1728
1880
            # Unhandled kind
1729
1881
            return None
1730
 
        packed_stat = _pack_stat(stat_value)
1731
1882
        if minikind == 'f':
1732
1883
            if self._cutoff_time is None:
1733
1884
                self._sha_cutoff_time()
1734
1885
            if (stat_value.st_mtime < self._cutoff_time
1735
1886
                and stat_value.st_ctime < self._cutoff_time):
1736
 
                entry[1][0] = ('f', sha1, entry[1][0][2], entry[1][0][3],
1737
 
                    packed_stat)
1738
 
                self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
1887
                entry[1][0] = ('f', sha1, stat_value.st_size, entry[1][0][3],
 
1888
                               pack_stat(stat_value))
 
1889
                self._mark_modified([entry])
1739
1890
 
1740
1891
    def _sha_cutoff_time(self):
1741
1892
        """Return cutoff time.
1785
1936
            # paths are produced by UnicodeDirReader on purpose.
1786
1937
            abspath = abspath.encode(fs_encoding)
1787
1938
        target = os.readlink(abspath)
1788
 
        if fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1939
        if fs_encoding not in ('utf-8', 'ascii'):
1789
1940
            # Change encoding if needed
1790
1941
            target = target.decode(fs_encoding).encode('UTF-8')
1791
1942
        return target
1799
1950
        """Serialise the entire dirstate to a sequence of lines."""
1800
1951
        if (self._header_state == DirState.IN_MEMORY_UNMODIFIED and
1801
1952
            self._dirblock_state == DirState.IN_MEMORY_UNMODIFIED):
1802
 
            # read whats on disk.
 
1953
            # read what's on disk.
1803
1954
            self._state_file.seek(0)
1804
1955
            return self._state_file.readlines()
1805
1956
        lines = []
1806
1957
        lines.append(self._get_parents_line(self.get_parent_ids()))
1807
1958
        lines.append(self._get_ghosts_line(self._ghosts))
1808
 
        # append the root line which is special cased
1809
 
        lines.extend(map(self._entry_to_line, self._iter_entries()))
 
1959
        lines.extend(self._iter_entry_lines())
1810
1960
        return self._get_output_lines(lines)
1811
1961
 
1812
1962
    def _get_ghosts_line(self, ghost_ids):
1817
1967
        """Create a line for the state file for parents information."""
1818
1968
        return '\0'.join([str(len(parent_ids))] + parent_ids)
1819
1969
 
 
1970
    def _iter_entry_lines(self):
 
1971
        """Create lines for entries."""
 
1972
        return map(self._entry_to_line, self._iter_entries())
 
1973
 
1820
1974
    def _get_fields_to_entry(self):
1821
1975
        """Get a function which converts entry fields into a entry record.
1822
1976
 
1894
2048
                          _int(fields[cur+2]),        # size
1895
2049
                          fields[cur+3] == 'y',       # executable
1896
2050
                          fields[cur+4],              # stat or revision_id
1897
 
                         ) for cur in xrange(3, len(fields)-1, 5)]
 
2051
                         ) for cur in range(3, len(fields)-1, 5)]
1898
2052
                return path_name_file_id_key, trees
1899
2053
            return fields_to_entry_n_parents
1900
2054
 
1940
2094
            entry_index += 1
1941
2095
        return block_index, entry_index, True, False
1942
2096
 
1943
 
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None, include_deleted=False):
 
2097
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None,
 
2098
                   include_deleted=False):
1944
2099
        """Get the dirstate entry for path in tree tree_index.
1945
2100
 
1946
2101
        If either file_id or path is supplied, it is used as the key to lookup.
1961
2116
        """
1962
2117
        self._read_dirblocks_if_needed()
1963
2118
        if path_utf8 is not None:
1964
 
            if type(path_utf8) is not str:
 
2119
            if not isinstance(path_utf8, str):
1965
2120
                raise errors.BzrError('path_utf8 is not a str: %s %r'
1966
2121
                    % (type(path_utf8), path_utf8))
1967
2122
            # path lookups are faster
1980
2135
                                          ' tree_index, file_id and path')
1981
2136
            return entry
1982
2137
        else:
1983
 
            possible_keys = self._get_id_index().get(fileid_utf8, None)
 
2138
            possible_keys = self._get_id_index().get(fileid_utf8, ())
1984
2139
            if not possible_keys:
1985
2140
                return None, None
1986
2141
            for key in possible_keys:
2088
2243
            executable = False
2089
2244
        else:
2090
2245
            raise Exception("can't pack %s" % inv_entry)
2091
 
        return (minikind, fingerprint, size, executable, tree_data)
 
2246
        return static_tuple.StaticTuple(minikind, fingerprint, size,
 
2247
                                        executable, tree_data)
2092
2248
 
2093
2249
    def _iter_child_entries(self, tree_index, path_utf8):
2094
2250
        """Iterate over all the entries that are children of path_utf.
2135
2291
        """Iterate over all the entries in the dirstate.
2136
2292
 
2137
2293
        Each yelt item is an entry in the standard format described in the
2138
 
        docstring of bzrlib.dirstate.
 
2294
        docstring of breezy.dirstate.
2139
2295
        """
2140
2296
        self._read_dirblocks_if_needed()
2141
2297
        for directory in self._dirblocks:
2143
2299
                yield entry
2144
2300
 
2145
2301
    def _get_id_index(self):
2146
 
        """Get an id index of self._dirblocks."""
 
2302
        """Get an id index of self._dirblocks.
 
2303
 
 
2304
        This maps from file_id => [(directory, name, file_id)] entries where
 
2305
        that file_id appears in one of the trees.
 
2306
        """
2147
2307
        if self._id_index is None:
2148
2308
            id_index = {}
2149
2309
            for key, tree_details in self._iter_entries():
2150
 
                id_index.setdefault(key[2], set()).add(key)
 
2310
                self._add_to_id_index(id_index, key)
2151
2311
            self._id_index = id_index
2152
2312
        return self._id_index
2153
2313
 
 
2314
    def _add_to_id_index(self, id_index, entry_key):
 
2315
        """Add this entry to the _id_index mapping."""
 
2316
        # This code used to use a set for every entry in the id_index. However,
 
2317
        # it is *rare* to have more than one entry. So a set is a large
 
2318
        # overkill. And even when we do, we won't ever have more than the
 
2319
        # number of parent trees. Which is still a small number (rarely >2). As
 
2320
        # such, we use a simple tuple, and do our own uniqueness checks. While
 
2321
        # the 'in' check is O(N) since N is nicely bounded it shouldn't ever
 
2322
        # cause quadratic failure.
 
2323
        file_id = entry_key[2]
 
2324
        entry_key = static_tuple.StaticTuple.from_sequence(entry_key)
 
2325
        if file_id not in id_index:
 
2326
            id_index[file_id] = static_tuple.StaticTuple(entry_key,)
 
2327
        else:
 
2328
            entry_keys = id_index[file_id]
 
2329
            if entry_key not in entry_keys:
 
2330
                id_index[file_id] = entry_keys + (entry_key,)
 
2331
 
 
2332
    def _remove_from_id_index(self, id_index, entry_key):
 
2333
        """Remove this entry from the _id_index mapping.
 
2334
 
 
2335
        It is an programming error to call this when the entry_key is not
 
2336
        already present.
 
2337
        """
 
2338
        file_id = entry_key[2]
 
2339
        entry_keys = list(id_index[file_id])
 
2340
        entry_keys.remove(entry_key)
 
2341
        id_index[file_id] = static_tuple.StaticTuple.from_sequence(entry_keys)
 
2342
 
2154
2343
    def _get_output_lines(self, lines):
2155
2344
        """Format lines for final output.
2156
2345
 
2176
2365
        """The number of parent entries in each record row."""
2177
2366
        return len(self._parents) - len(self._ghosts)
2178
2367
 
2179
 
    @staticmethod
2180
 
    def on_file(path, sha1_provider=None):
 
2368
    @classmethod
 
2369
    def on_file(cls, path, sha1_provider=None, worth_saving_limit=0):
2181
2370
        """Construct a DirState on the file at path "path".
2182
2371
 
2183
2372
        :param path: The path at which the dirstate file on disk should live.
2184
2373
        :param sha1_provider: an object meeting the SHA1Provider interface.
2185
2374
            If None, a DefaultSHA1Provider is used.
 
2375
        :param worth_saving_limit: when the exact number of hash changed
 
2376
            entries is known, only bother saving the dirstate if more than
 
2377
            this count of entries have changed. -1 means never save.
2186
2378
        :return: An unlocked DirState object, associated with the given path.
2187
2379
        """
2188
2380
        if sha1_provider is None:
2189
2381
            sha1_provider = DefaultSHA1Provider()
2190
 
        result = DirState(path, sha1_provider)
 
2382
        result = cls(path, sha1_provider,
 
2383
                     worth_saving_limit=worth_saving_limit)
2191
2384
        return result
2192
2385
 
2193
2386
    def _read_dirblocks_if_needed(self):
2251
2444
            raise errors.BzrError('missing num_entries line')
2252
2445
        self._num_entries = int(num_entries_line[len('num_entries: '):-1])
2253
2446
 
2254
 
    def sha1_from_stat(self, path, stat_result, _pack_stat=pack_stat):
 
2447
    def sha1_from_stat(self, path, stat_result):
2255
2448
        """Find a sha1 given a stat lookup."""
2256
 
        return self._get_packed_stat_index().get(_pack_stat(stat_result), None)
 
2449
        return self._get_packed_stat_index().get(pack_stat(stat_result), None)
2257
2450
 
2258
2451
    def _get_packed_stat_index(self):
2259
2452
        """Get a packed_stat index of self._dirblocks."""
2285
2478
            trace.mutter('Not saving DirState because '
2286
2479
                    '_changes_aborted is set.')
2287
2480
            return
2288
 
        if (self._header_state == DirState.IN_MEMORY_MODIFIED or
2289
 
            self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
 
2481
        # TODO: Since we now distinguish IN_MEMORY_MODIFIED from
 
2482
        #       IN_MEMORY_HASH_MODIFIED, we should only fail quietly if we fail
 
2483
        #       to save an IN_MEMORY_HASH_MODIFIED, and fail *noisily* if we
 
2484
        #       fail to save IN_MEMORY_MODIFIED
 
2485
        if not self._worth_saving():
 
2486
            return
2290
2487
 
2291
 
            grabbed_write_lock = False
2292
 
            if self._lock_state != 'w':
2293
 
                grabbed_write_lock, new_lock = self._lock_token.temporary_write_lock()
2294
 
                # Switch over to the new lock, as the old one may be closed.
 
2488
        grabbed_write_lock = False
 
2489
        if self._lock_state != 'w':
 
2490
            grabbed_write_lock, new_lock = self._lock_token.temporary_write_lock()
 
2491
            # Switch over to the new lock, as the old one may be closed.
 
2492
            # TODO: jam 20070315 We should validate the disk file has
 
2493
            #       not changed contents, since temporary_write_lock may
 
2494
            #       not be an atomic operation.
 
2495
            self._lock_token = new_lock
 
2496
            self._state_file = new_lock.f
 
2497
            if not grabbed_write_lock:
 
2498
                # We couldn't grab a write lock, so we switch back to a read one
 
2499
                return
 
2500
        try:
 
2501
            lines = self.get_lines()
 
2502
            self._state_file.seek(0)
 
2503
            self._state_file.writelines(lines)
 
2504
            self._state_file.truncate()
 
2505
            self._state_file.flush()
 
2506
            self._maybe_fdatasync()
 
2507
            self._mark_unmodified()
 
2508
        finally:
 
2509
            if grabbed_write_lock:
 
2510
                self._lock_token = self._lock_token.restore_read_lock()
 
2511
                self._state_file = self._lock_token.f
2295
2512
                # TODO: jam 20070315 We should validate the disk file has
2296
 
                #       not changed contents. Since temporary_write_lock may
2297
 
                #       not be an atomic operation.
2298
 
                self._lock_token = new_lock
2299
 
                self._state_file = new_lock.f
2300
 
                if not grabbed_write_lock:
2301
 
                    # We couldn't grab a write lock, so we switch back to a read one
2302
 
                    return
2303
 
            try:
2304
 
                self._state_file.seek(0)
2305
 
                self._state_file.writelines(self.get_lines())
2306
 
                self._state_file.truncate()
2307
 
                self._state_file.flush()
2308
 
                self._header_state = DirState.IN_MEMORY_UNMODIFIED
2309
 
                self._dirblock_state = DirState.IN_MEMORY_UNMODIFIED
2310
 
            finally:
2311
 
                if grabbed_write_lock:
2312
 
                    self._lock_token = self._lock_token.restore_read_lock()
2313
 
                    self._state_file = self._lock_token.f
2314
 
                    # TODO: jam 20070315 We should validate the disk file has
2315
 
                    #       not changed contents. Since restore_read_lock may
2316
 
                    #       not be an atomic operation.
 
2513
                #       not changed contents. Since restore_read_lock may
 
2514
                #       not be an atomic operation.                
 
2515
 
 
2516
    def _maybe_fdatasync(self):
 
2517
        """Flush to disk if possible and if not configured off."""
 
2518
        if self._config_stack.get('dirstate.fdatasync'):
 
2519
            osutils.fdatasync(self._state_file.fileno())
 
2520
 
 
2521
    def _worth_saving(self):
 
2522
        """Is it worth saving the dirstate or not?"""
 
2523
        if (self._header_state == DirState.IN_MEMORY_MODIFIED
 
2524
            or self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
 
2525
            return True
 
2526
        if self._dirblock_state == DirState.IN_MEMORY_HASH_MODIFIED:
 
2527
            if self._worth_saving_limit == -1:
 
2528
                # We never save hash changes when the limit is -1
 
2529
                return False
 
2530
            # If we're using smart saving and only a small number of
 
2531
            # entries have changed their hash, don't bother saving. John has
 
2532
            # suggested using a heuristic here based on the size of the
 
2533
            # changed files and/or tree. For now, we go with a configurable
 
2534
            # number of changes, keeping the calculation time
 
2535
            # as low overhead as possible. (This also keeps all existing
 
2536
            # tests passing as the default is 0, i.e. always save.)
 
2537
            if len(self._known_hash_changes) >= self._worth_saving_limit:
 
2538
                return True
 
2539
        return False
2317
2540
 
2318
2541
    def _set_data(self, parent_ids, dirblocks):
2319
2542
        """Set the full dirstate data in memory.
2328
2551
        """
2329
2552
        # our memory copy is now authoritative.
2330
2553
        self._dirblocks = dirblocks
2331
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
2332
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2554
        self._mark_modified(header_modified=True)
2333
2555
        self._parents = list(parent_ids)
2334
2556
        self._id_index = None
2335
2557
        self._packed_stat_index = None
2355
2577
        self._make_absent(entry)
2356
2578
        self.update_minimal(('', '', new_id), 'd',
2357
2579
            path_utf8='', packed_stat=entry[1][0][4])
2358
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2580
        self._mark_modified()
2359
2581
 
2360
2582
    def set_parent_trees(self, trees, ghosts):
2361
2583
        """Set the parent trees for the dirstate.
2406
2628
        parent_trees = [tree for rev_id, tree in trees if rev_id not in ghosts]
2407
2629
        # how many trees do we end up with
2408
2630
        parent_count = len(parent_trees)
 
2631
        st = static_tuple.StaticTuple
2409
2632
 
2410
2633
        # one: the current tree
2411
2634
        for entry in self._iter_entries():
2414
2637
                continue
2415
2638
            by_path[entry[0]] = [entry[1][0]] + \
2416
2639
                [DirState.NULL_PARENT_DETAILS] * parent_count
2417
 
            id_index[entry[0][2]] = set([entry[0]])
 
2640
            # TODO: Possibly inline this, since we know it isn't present yet
 
2641
            #       id_index[entry[0][2]] = (entry[0],)
 
2642
            self._add_to_id_index(id_index, entry[0])
2418
2643
 
2419
2644
        # now the parent trees:
2420
2645
        for tree_index, tree in enumerate(parent_trees):
2426
2651
            # the suffix is from tree_index+1:parent_count+1.
2427
2652
            new_location_suffix = [DirState.NULL_PARENT_DETAILS] * (parent_count - tree_index)
2428
2653
            # now stitch in all the entries from this tree
2429
 
            for path, entry in tree.inventory.iter_entries_by_dir():
 
2654
            last_dirname = None
 
2655
            for path, entry in tree.iter_entries_by_dir():
2430
2656
                # here we process each trees details for each item in the tree.
2431
2657
                # we first update any existing entries for the id at other paths,
2432
2658
                # then we either create or update the entry for the id at the
2439
2665
                file_id = entry.file_id
2440
2666
                path_utf8 = path.encode('utf8')
2441
2667
                dirname, basename = osutils.split(path_utf8)
2442
 
                new_entry_key = (dirname, basename, file_id)
 
2668
                if dirname == last_dirname:
 
2669
                    # Try to re-use objects as much as possible
 
2670
                    dirname = last_dirname
 
2671
                else:
 
2672
                    last_dirname = dirname
 
2673
                new_entry_key = st(dirname, basename, file_id)
2443
2674
                # tree index consistency: All other paths for this id in this tree
2444
2675
                # index must point to the correct path.
2445
 
                for entry_key in id_index.setdefault(file_id, set()):
 
2676
                entry_keys = id_index.get(file_id, ())
 
2677
                for entry_key in entry_keys:
2446
2678
                    # TODO:PROFILING: It might be faster to just update
2447
2679
                    # rather than checking if we need to, and then overwrite
2448
2680
                    # the one we are located at.
2451
2683
                        # other trees, so put absent pointers there
2452
2684
                        # This is the vertical axis in the matrix, all pointing
2453
2685
                        # to the real path.
2454
 
                        by_path[entry_key][tree_index] = ('r', path_utf8, 0, False, '')
2455
 
                # by path consistency: Insert into an existing path record (trivial), or
2456
 
                # add a new one with relocation pointers for the other tree indexes.
2457
 
                if new_entry_key in id_index[file_id]:
2458
 
                    # there is already an entry where this data belongs, just insert it.
 
2686
                        by_path[entry_key][tree_index] = st('r', path_utf8, 0,
 
2687
                                                            False, '')
 
2688
                # by path consistency: Insert into an existing path record
 
2689
                # (trivial), or add a new one with relocation pointers for the
 
2690
                # other tree indexes.
 
2691
                if new_entry_key in entry_keys:
 
2692
                    # there is already an entry where this data belongs, just
 
2693
                    # insert it.
2459
2694
                    by_path[new_entry_key][tree_index] = \
2460
2695
                        self._inv_entry_to_details(entry)
2461
2696
                else:
2463
2698
                    # mapping from path,id. We need to look up the correct path
2464
2699
                    # for the indexes from 0 to tree_index -1
2465
2700
                    new_details = []
2466
 
                    for lookup_index in xrange(tree_index):
 
2701
                    for lookup_index in range(tree_index):
2467
2702
                        # boundary case: this is the first occurence of file_id
2468
 
                        # so there are no id_indexs, possibly take this out of
 
2703
                        # so there are no id_indexes, possibly take this out of
2469
2704
                        # the loop?
2470
 
                        if not len(id_index[file_id]):
 
2705
                        if not len(entry_keys):
2471
2706
                            new_details.append(DirState.NULL_PARENT_DETAILS)
2472
2707
                        else:
2473
2708
                            # grab any one entry, use it to find the right path.
2474
 
                            # TODO: optimise this to reduce memory use in highly
2475
 
                            # fragmented situations by reusing the relocation
2476
 
                            # records.
2477
 
                            a_key = iter(id_index[file_id]).next()
 
2709
                            a_key = next(iter(entry_keys))
2478
2710
                            if by_path[a_key][lookup_index][0] in ('r', 'a'):
2479
 
                                # its a pointer or missing statement, use it as is.
 
2711
                                # its a pointer or missing statement, use it as
 
2712
                                # is.
2480
2713
                                new_details.append(by_path[a_key][lookup_index])
2481
2714
                            else:
2482
2715
                                # we have the right key, make a pointer to it.
2483
2716
                                real_path = ('/'.join(a_key[0:2])).strip('/')
2484
 
                                new_details.append(('r', real_path, 0, False, ''))
 
2717
                                new_details.append(st('r', real_path, 0, False,
 
2718
                                                      ''))
2485
2719
                    new_details.append(self._inv_entry_to_details(entry))
2486
2720
                    new_details.extend(new_location_suffix)
2487
2721
                    by_path[new_entry_key] = new_details
2488
 
                    id_index[file_id].add(new_entry_key)
 
2722
                    self._add_to_id_index(id_index, new_entry_key)
2489
2723
        # --- end generation of full tree mappings
2490
2724
 
2491
2725
        # sort and output all the entries
2493
2727
        self._entries_to_current_state(new_entries)
2494
2728
        self._parents = [rev_id for rev_id, tree in trees]
2495
2729
        self._ghosts = list(ghosts)
2496
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
2497
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2730
        self._mark_modified(header_modified=True)
2498
2731
        self._id_index = id_index
2499
2732
 
2500
2733
    def _sort_entries(self, entry_list):
2504
2737
        try to keep everything in sorted blocks all the time, but sometimes
2505
2738
        it's easier to sort after the fact.
2506
2739
        """
2507
 
        def _key(entry):
 
2740
        # When sorting, we usually have 10x more entries than directories. (69k
 
2741
        # total entries, 4k directories). So cache the results of splitting.
 
2742
        # Saving time and objects. Also, use StaticTuple to avoid putting all
 
2743
        # of these object into python's garbage collector.
 
2744
        split_dirs = {}
 
2745
        def _key(entry, _split_dirs=split_dirs, _st=static_tuple.StaticTuple):
2508
2746
            # sort by: directory parts, file name, file id
2509
 
            return entry[0][0].split('/'), entry[0][1], entry[0][2]
 
2747
            dirpath, fname, file_id = entry[0]
 
2748
            try:
 
2749
                split = _split_dirs[dirpath]
 
2750
            except KeyError:
 
2751
                split = _st.from_sequence(dirpath.split('/'))
 
2752
                _split_dirs[dirpath] = split
 
2753
            return _st(split, fname, file_id)
2510
2754
        return sorted(entry_list, key=_key)
2511
2755
 
2512
2756
    def set_state_from_inventory(self, new_inv):
2542
2786
        # underlying dirstate.
2543
2787
        old_iterator = iter(list(self._iter_entries()))
2544
2788
        # both must have roots so this is safe:
2545
 
        current_new = new_iterator.next()
2546
 
        current_old = old_iterator.next()
 
2789
        current_new = next(new_iterator)
 
2790
        current_old = next(old_iterator)
2547
2791
        def advance(iterator):
2548
2792
            try:
2549
 
                return iterator.next()
 
2793
                return next(iterator)
2550
2794
            except StopIteration:
2551
2795
                return None
2552
2796
        while current_new or current_old:
2637
2881
                        current_old[0][1].decode('utf8'))
2638
2882
                self._make_absent(current_old)
2639
2883
                current_old = advance(old_iterator)
2640
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2884
        self._mark_modified()
2641
2885
        self._id_index = None
2642
2886
        self._packed_stat_index = None
2643
2887
        if tracing:
2644
2888
            trace.mutter("set_state_from_inventory complete.")
2645
2889
 
 
2890
    def set_state_from_scratch(self, working_inv, parent_trees, parent_ghosts):
 
2891
        """Wipe the currently stored state and set it to something new.
 
2892
 
 
2893
        This is a hard-reset for the data we are working with.
 
2894
        """
 
2895
        # Technically, we really want a write lock, but until we write, we
 
2896
        # don't really need it.
 
2897
        self._requires_lock()
 
2898
        # root dir and root dir contents with no children. We have to have a
 
2899
        # root for set_state_from_inventory to work correctly.
 
2900
        empty_root = (('', '', inventory.ROOT_ID),
 
2901
                      [('d', '', 0, False, DirState.NULLSTAT)])
 
2902
        empty_tree_dirblocks = [('', [empty_root]), ('', [])]
 
2903
        self._set_data([], empty_tree_dirblocks)
 
2904
        self.set_state_from_inventory(working_inv)
 
2905
        self.set_parent_trees(parent_trees, parent_ghosts)
 
2906
 
2646
2907
    def _make_absent(self, current_old):
2647
2908
        """Mark current_old - an entry - as absent for tree 0.
2648
2909
 
2673
2934
            block[1].pop(entry_index)
2674
2935
            # if we have an id_index in use, remove this key from it for this id.
2675
2936
            if self._id_index is not None:
2676
 
                self._id_index[current_old[0][2]].remove(current_old[0])
 
2937
                self._remove_from_id_index(self._id_index, current_old[0])
2677
2938
        # update all remaining keys for this id to record it as absent. The
2678
2939
        # existing details may either be the record we are marking as deleted
2679
2940
        # (if there were other trees with the id present at this path), or may
2692
2953
            if update_tree_details[0][0] == 'a': # absent
2693
2954
                raise AssertionError('bad row %r' % (update_tree_details,))
2694
2955
            update_tree_details[0] = DirState.NULL_PARENT_DETAILS
2695
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2956
        self._mark_modified()
2696
2957
        return last_reference
2697
2958
 
2698
2959
    def update_minimal(self, key, minikind, executable=False, fingerprint='',
2740
3001
                            # This entry has the same path (but a different id) as
2741
3002
                            # the new entry we're adding, and is present in ths
2742
3003
                            # tree.
2743
 
                            raise errors.InconsistentDelta(
 
3004
                            self._raise_invalid(
2744
3005
                                ("%s/%s" % key[0:2]).decode('utf8'), key[2],
2745
3006
                                "Attempt to add item at path already occupied by "
2746
3007
                                "id %r" % entry[0][2])
2748
3009
                    else:
2749
3010
                        break
2750
3011
            # new entry, synthesis cross reference here,
2751
 
            existing_keys = id_index.setdefault(key[2], set())
 
3012
            existing_keys = id_index.get(key[2], ())
2752
3013
            if not existing_keys:
2753
3014
                # not currently in the state, simplest case
2754
3015
                new_entry = key, [new_details] + self._empty_parent_info()
2785
3046
                    # loop.
2786
3047
                    other_entry = other_block[other_entry_index]
2787
3048
                    other_entry[1][0] = ('r', path_utf8, 0, False, '')
2788
 
                    self._maybe_remove_row(other_block, other_entry_index,
2789
 
                        id_index)
 
3049
                    if self._maybe_remove_row(other_block, other_entry_index,
 
3050
                                              id_index):
 
3051
                        # If the row holding this was removed, we need to
 
3052
                        # recompute where this entry goes
 
3053
                        entry_index, _ = self._find_entry_index(key, block)
2790
3054
 
2791
3055
                # This loop:
2792
3056
                # adds a tuple to the new details for each column
2794
3058
                #  - or by creating a new pointer to the right row inside that column
2795
3059
                num_present_parents = self._num_present_parents()
2796
3060
                if num_present_parents:
 
3061
                    # TODO: This re-evaluates the existing_keys set, do we need
 
3062
                    #       to do that ourselves?
2797
3063
                    other_key = list(existing_keys)[0]
2798
 
                for lookup_index in xrange(1, num_present_parents + 1):
 
3064
                for lookup_index in range(1, num_present_parents + 1):
2799
3065
                    # grab any one entry, use it to find the right path.
2800
3066
                    # TODO: optimise this to reduce memory use in highly
2801
3067
                    # fragmented situations by reusing the relocation
2818
3084
                        pointer_path = osutils.pathjoin(*other_key[0:2])
2819
3085
                        new_entry[1].append(('r', pointer_path, 0, False, ''))
2820
3086
            block.insert(entry_index, new_entry)
2821
 
            existing_keys.add(key)
 
3087
            self._add_to_id_index(id_index, key)
2822
3088
        else:
2823
3089
            # Does the new state matter?
2824
3090
            block[entry_index][1][0] = new_details
2833
3099
            # converted to relocated.
2834
3100
            if path_utf8 is None:
2835
3101
                raise AssertionError('no path')
2836
 
            for entry_key in id_index.setdefault(key[2], set()):
 
3102
            existing_keys = id_index.get(key[2], ())
 
3103
            if key not in existing_keys:
 
3104
                raise AssertionError('We found the entry in the blocks, but'
 
3105
                    ' the key is not in the id_index.'
 
3106
                    ' key: %s, existing_keys: %s' % (key, existing_keys))
 
3107
            for entry_key in existing_keys:
2837
3108
                # TODO:PROFILING: It might be faster to just update
2838
3109
                # rather than checking if we need to, and then overwrite
2839
3110
                # the one we are located at.
2857
3128
            if not present:
2858
3129
                self._dirblocks.insert(block_index, (subdir_key[0], []))
2859
3130
 
2860
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
3131
        self._mark_modified()
2861
3132
 
2862
3133
    def _maybe_remove_row(self, block, index, id_index):
2863
3134
        """Remove index if it is absent or relocated across the row.
2864
3135
        
2865
3136
        id_index is updated accordingly.
 
3137
        :return: True if we removed the row, False otherwise
2866
3138
        """
2867
3139
        present_in_row = False
2868
3140
        entry = block[index]
2872
3144
                break
2873
3145
        if not present_in_row:
2874
3146
            block.pop(index)
2875
 
            id_index[entry[0][2]].remove(entry[0])
 
3147
            self._remove_from_id_index(id_index, entry[0])
 
3148
            return True
 
3149
        return False
2876
3150
 
2877
3151
    def _validate(self):
2878
3152
        """Check that invariants on the dirblock are correct.
2958
3232
        # We check this with a dict per tree pointing either to the present
2959
3233
        # name, or None if absent.
2960
3234
        tree_count = self._num_present_parents() + 1
2961
 
        id_path_maps = [dict() for i in range(tree_count)]
 
3235
        id_path_maps = [{} for _ in range(tree_count)]
2962
3236
        # Make sure that all renamed entries point to the correct location.
2963
3237
        for entry in self._iter_entries():
2964
3238
            file_id = entry[0][2]
3016
3290
        if self._id_index is not None:
3017
3291
            for file_id, entry_keys in self._id_index.iteritems():
3018
3292
                for entry_key in entry_keys:
 
3293
                    # Check that the entry in the map is pointing to the same
 
3294
                    # file_id
3019
3295
                    if entry_key[2] != file_id:
3020
3296
                        raise AssertionError(
3021
3297
                            'file_id %r did not match entry key %s'
3022
3298
                            % (file_id, entry_key))
 
3299
                    # And that from this entry key, we can look up the original
 
3300
                    # record
 
3301
                    block_index, present = self._find_block_index_from_key(entry_key)
 
3302
                    if not present:
 
3303
                        raise AssertionError('missing block for entry key: %r', entry_key)
 
3304
                    entry_index, present = self._find_entry_index(entry_key, self._dirblocks[block_index][1])
 
3305
                    if not present:
 
3306
                        raise AssertionError('missing entry for key: %r', entry_key)
 
3307
                if len(entry_keys) != len(set(entry_keys)):
 
3308
                    raise AssertionError(
 
3309
                        'id_index contained non-unique data for %s'
 
3310
                        % (entry_keys,))
3023
3311
 
3024
3312
    def _wipe_state(self):
3025
3313
        """Forget all state information about the dirstate."""
3082
3370
 
3083
3371
 
3084
3372
def py_update_entry(state, entry, abspath, stat_value,
3085
 
                 _stat_to_minikind=DirState._stat_to_minikind,
3086
 
                 _pack_stat=pack_stat):
 
3373
                 _stat_to_minikind=DirState._stat_to_minikind):
3087
3374
    """Update the entry based on what is actually on disk.
3088
3375
 
3089
3376
    This function only calculates the sha if it needs to - if the entry is
3098
3385
        target of a symlink.
3099
3386
    """
3100
3387
    try:
3101
 
        minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
 
3388
        minikind = _stat_to_minikind[stat_value.st_mode & 0o170000]
3102
3389
    except KeyError:
3103
3390
        # Unhandled kind
3104
3391
        return None
3105
 
    packed_stat = _pack_stat(stat_value)
 
3392
    packed_stat = pack_stat(stat_value)
3106
3393
    (saved_minikind, saved_link_or_sha1, saved_file_size,
3107
3394
     saved_executable, saved_packed_stat) = entry[1][0]
3108
3395
 
3122
3409
    # If we have gotten this far, that means that we need to actually
3123
3410
    # process this entry.
3124
3411
    link_or_sha1 = None
 
3412
    worth_saving = True
3125
3413
    if minikind == 'f':
3126
3414
        executable = state._is_executable(stat_value.st_mode,
3127
3415
                                         saved_executable)
3143
3431
        else:
3144
3432
            entry[1][0] = ('f', '', stat_value.st_size,
3145
3433
                           executable, DirState.NULLSTAT)
 
3434
            worth_saving = False
3146
3435
    elif minikind == 'd':
3147
3436
        link_or_sha1 = None
3148
3437
        entry[1][0] = ('d', '', 0, False, packed_stat)
3154
3443
                state._get_block_entry_index(entry[0][0], entry[0][1], 0)
3155
3444
            state._ensure_block(block_index, entry_index,
3156
3445
                               osutils.pathjoin(entry[0][0], entry[0][1]))
 
3446
        else:
 
3447
            worth_saving = False
3157
3448
    elif minikind == 'l':
 
3449
        if saved_minikind == 'l':
 
3450
            worth_saving = False
3158
3451
        link_or_sha1 = state._read_link(abspath, saved_link_or_sha1)
3159
3452
        if state._cutoff_time is None:
3160
3453
            state._sha_cutoff_time()
3165
3458
        else:
3166
3459
            entry[1][0] = ('l', '', stat_value.st_size,
3167
3460
                           False, DirState.NULLSTAT)
3168
 
    state._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
3461
    if worth_saving:
 
3462
        state._mark_modified([entry])
3169
3463
    return link_or_sha1
3170
3464
 
3171
3465
 
3184
3478
        self.old_dirname_to_file_id = {}
3185
3479
        self.new_dirname_to_file_id = {}
3186
3480
        # Are we doing a partial iter_changes?
3187
 
        self.partial = search_specific_files != set([''])
 
3481
        self.partial = search_specific_files != {''}
3188
3482
        # Using a list so that we can access the values and change them in
3189
3483
        # nested scope. Each one is [path, file_id, entry]
3190
3484
        self.last_source_parent = [None, None]
3480
3774
            raise AssertionError("don't know how to compare "
3481
3775
                "source_minikind=%r, target_minikind=%r"
3482
3776
                % (source_minikind, target_minikind))
3483
 
            ## import pdb;pdb.set_trace()
3484
3777
        return None, None
3485
3778
 
3486
3779
    def __iter__(self):
3563
3856
            root_abspath = self.tree.abspath(current_root_unicode)
3564
3857
            try:
3565
3858
                root_stat = os.lstat(root_abspath)
3566
 
            except OSError, e:
 
3859
            except OSError as e:
3567
3860
                if e.errno == errno.ENOENT:
3568
3861
                    # the path does not exist: let _process_entry know that.
3569
3862
                    root_dir_info = None
3616
3909
            else:
3617
3910
                dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
3618
3911
                try:
3619
 
                    current_dir_info = dir_iterator.next()
3620
 
                except OSError, e:
 
3912
                    current_dir_info = next(dir_iterator)
 
3913
                except OSError as e:
3621
3914
                    # on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
3622
3915
                    # python 2.5 has e.errno == EINVAL,
3623
3916
                    #            and e.winerror == ERROR_DIRECTORY
3692
3985
 
3693
3986
                        # This dir info has been handled, go to the next
3694
3987
                        try:
3695
 
                            current_dir_info = dir_iterator.next()
 
3988
                            current_dir_info = next(dir_iterator)
3696
3989
                        except StopIteration:
3697
3990
                            current_dir_info = None
3698
3991
                    else:
3844
4137
                        current_block = None
3845
4138
                if current_dir_info is not None:
3846
4139
                    try:
3847
 
                        current_dir_info = dir_iterator.next()
 
4140
                        current_dir_info = next(dir_iterator)
3848
4141
                    except StopIteration:
3849
4142
                        current_dir_info = None
3850
4143
        for result in self._iter_specific_file_parents():
3949
4242
        abspath = self.tree.abspath(unicode_path)
3950
4243
        try:
3951
4244
            stat = os.lstat(abspath)
3952
 
        except OSError, e:
 
4245
        except OSError as e:
3953
4246
            if e.errno == errno.ENOENT:
3954
4247
                # the path does not exist.
3955
4248
                return None
3969
4262
 
3970
4263
# Try to load the compiled form if possible
3971
4264
try:
3972
 
    from bzrlib._dirstate_helpers_pyx import (
 
4265
    from breezy._dirstate_helpers_pyx import (
3973
4266
        _read_dirblocks,
3974
4267
        bisect_dirblock,
3975
4268
        _bisect_path_left,
3976
4269
        _bisect_path_right,
3977
4270
        cmp_by_dirs,
 
4271
        pack_stat,
3978
4272
        ProcessEntryC as _process_entry,
3979
4273
        update_entry as update_entry,
3980
4274
        )
3981
 
except ImportError, e:
 
4275
except ImportError as e:
3982
4276
    osutils.failed_to_load_extension(e)
3983
 
    from bzrlib._dirstate_helpers_py import (
 
4277
    from breezy._dirstate_helpers_py import (
3984
4278
        _read_dirblocks,
3985
4279
        bisect_dirblock,
3986
4280
        _bisect_path_left,
3987
4281
        _bisect_path_right,
3988
4282
        cmp_by_dirs,
 
4283
        pack_stat,
3989
4284
        )
3990
4285
    # FIXME: It would be nice to be able to track moved lines so that the
3991
4286
    # corresponding python code can be moved to the _dirstate_helpers_py