~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/dirstate.py

  • Committer: Jelmer Vernooij
  • Date: 2011-12-19 10:58:39 UTC
  • mfrom: (6383 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6386.
  • Revision ID: jelmer@canonical.com-20111219105839-uji05ck4rkm1mj4j
Merge bzr.dev.

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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
17
19
"""DirState objects record the state of a directory and its bzr metadata.
18
20
 
19
21
Pseudo EBNF grammar for the state file. Fields are separated by NULLs, and
20
22
lines by NL. The field delimiters are ommitted in the grammar, line delimiters
21
23
are not - this is done for clarity of reading. All string data is in utf8.
22
24
 
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
 
25
::
 
26
 
 
27
    MINIKIND = "f" | "d" | "l" | "a" | "r" | "t";
 
28
    NL = "\\n";
 
29
    NULL = "\\0";
 
30
    WHOLE_NUMBER = {digit}, digit;
 
31
    BOOLEAN = "y" | "n";
 
32
    REVISION_ID = a non-empty utf8 string;
 
33
    
 
34
    dirstate format = header line, full checksum, row count, parent details,
 
35
     ghost_details, entries;
 
36
    header line = "#bazaar dirstate flat format 3", NL;
 
37
    full checksum = "crc32: ", ["-"], WHOLE_NUMBER, NL;
 
38
    row count = "num_entries: ", WHOLE_NUMBER, NL;
 
39
    parent_details = WHOLE NUMBER, {REVISION_ID}* NL;
 
40
    ghost_details = WHOLE NUMBER, {REVISION_ID}*, NL;
 
41
    entries = {entry};
 
42
    entry = entry_key, current_entry_details, {parent_entry_details};
 
43
    entry_key = dirname,  basename, fileid;
 
44
    current_entry_details = common_entry_details, working_entry_details;
 
45
    parent_entry_details = common_entry_details, history_entry_details;
 
46
    common_entry_details = MINIKIND, fingerprint, size, executable
 
47
    working_entry_details = packed_stat
 
48
    history_entry_details = REVISION_ID;
 
49
    executable = BOOLEAN;
 
50
    size = WHOLE_NUMBER;
 
51
    fingerprint = a nonempty utf8 sequence with meaning defined by minikind.
 
52
 
 
53
Given this definition, the following is useful to know::
 
54
 
 
55
    entry (aka row) - all the data for a given key.
 
56
    entry[0]: The key (dirname, basename, fileid)
 
57
    entry[0][0]: dirname
 
58
    entry[0][1]: basename
 
59
    entry[0][2]: fileid
 
60
    entry[1]: The tree(s) data for this path and id combination.
 
61
    entry[1][0]: The current tree
 
62
    entry[1][1]: The second tree
 
63
 
 
64
For an entry for a tree, we have (using tree 0 - current tree) to demonstrate::
 
65
 
 
66
    entry[1][0][0]: minikind
 
67
    entry[1][0][1]: fingerprint
 
68
    entry[1][0][2]: size
 
69
    entry[1][0][3]: executable
 
70
    entry[1][0][4]: packed_stat
 
71
 
 
72
OR (for non tree-0)::
 
73
 
 
74
    entry[1][1][4]: revision_id
67
75
 
68
76
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.
 
77
in memory root row is now::
 
78
 
 
79
    self._dirblocks[0] -> ('', [entry ...]),
 
80
 
 
81
and the entries in there are::
 
82
 
 
83
    entries[0][0]: ''
 
84
    entries[0][1]: ''
 
85
    entries[0][2]: file_id
 
86
    entries[1][0]: The tree data for the current tree for this fileid at /
 
87
    etc.
 
88
 
 
89
Kinds::
 
90
 
 
91
    'r' is a relocated entry: This path is not present in this tree with this
 
92
        id, but the id can be found at another location. The fingerprint is
 
93
        used to point to the target location.
 
94
    'a' is an absent entry: In that tree the id is not present at this path.
 
95
    'd' is a directory entry: This path in this tree is a directory with the
 
96
        current file id. There is no fingerprint for directories.
 
97
    'f' is a file entry: As for directory, but it's a file. The fingerprint is
 
98
        the sha1 value of the file's canonical form, i.e. after any read
 
99
        filters have been applied to the convenience form stored in the working
 
100
        tree.
 
101
    'l' is a symlink entry: As for directory, but a symlink. The fingerprint is
 
102
        the link target.
 
103
    't' is a reference to a nested subtree; the fingerprint is the referenced
 
104
        revision.
92
105
 
93
106
Ordering:
94
107
 
95
 
The entries on disk and in memory are ordered according to the following keys:
 
108
The entries on disk and in memory are ordered according to the following keys::
96
109
 
97
110
    directory, as a list of components
98
111
    filename
99
112
    file-id
100
113
 
101
114
--- 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
 
115
 
 
116
::
 
117
 
 
118
    rows = dirname, NULL, basename, NULL, MINIKIND, NULL, fileid_utf8, NULL,
 
119
        WHOLE NUMBER (* size *), NULL, packed stat, NULL, sha1|symlink target,
 
120
        {PARENT ROW}
 
121
    PARENT ROW = NULL, revision_utf8, NULL, MINIKIND, NULL, dirname, NULL,
 
122
        basename, NULL, WHOLE NUMBER (* size *), NULL, "y" | "n", NULL,
 
123
        SHA1
108
124
 
109
125
PARENT ROW's are emitted for every parent that is not in the ghosts details
110
126
line. That is, if the parents are foo, bar, baz, and the ghosts are bar, then
135
151
----
136
152
 
137
153
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
 
154
 1. Fast end to end use for bzr's top 5 uses cases. (commmit/diff/status/merge/???)
 
155
 2. fall back current object model as needed.
 
156
 3. scale usably to the largest trees known today - say 50K entries. (mozilla
141
157
    is an example of this)
142
158
 
143
159
 
144
160
Locking:
 
161
 
145
162
 Eventually reuse dirstate objects across locks IFF the dirstate file has not
146
163
 been modified, but will require that we flush/ignore cached stat-hit data
147
164
 because we won't want to restat all files on disk just because a lock was
148
165
 acquired, yet we cannot trust the data after the previous lock was released.
149
166
 
150
 
Memory representation:
 
167
Memory representation::
 
168
 
151
169
 vector of all directories, and vector of the childen ?
152
170
   i.e.
153
171
     root_entrie = (direntry for root, [parent_direntries_for_root]),
167
185
    - What's the risk of error here? Once we have the base format being processed
168
186
      we should have a net win regardless of optimality. So we are going to
169
187
      go with what seems reasonable.
 
188
 
170
189
open questions:
171
190
 
172
191
Maybe we should do a test profile of the core structure - 10K simulated
201
220
 
202
221
"""
203
222
 
 
223
from __future__ import absolute_import
 
224
 
204
225
import bisect
205
 
import binascii
206
226
import errno
207
227
import operator
208
228
import os
209
229
from stat import S_IEXEC
210
230
import stat
211
 
import struct
212
231
import sys
213
232
import time
214
233
import zlib
215
234
 
216
235
from bzrlib import (
217
236
    cache_utf8,
 
237
    config,
218
238
    debug,
219
239
    errors,
220
240
    inventory,
221
241
    lock,
222
242
    osutils,
 
243
    static_tuple,
223
244
    trace,
 
245
    urlutils,
224
246
    )
225
247
 
226
248
 
231
253
ERROR_DIRECTORY = 267
232
254
 
233
255
 
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
256
class SHA1Provider(object):
268
257
    """An interface for getting sha1s of a file."""
269
258
 
354
343
    NOT_IN_MEMORY = 0
355
344
    IN_MEMORY_UNMODIFIED = 1
356
345
    IN_MEMORY_MODIFIED = 2
 
346
    IN_MEMORY_HASH_MODIFIED = 3 # Only hash-cache updates
357
347
 
358
348
    # A pack_stat (the x's) that is just noise and will never match the output
359
349
    # of base64 encode.
360
350
    NULLSTAT = 'x' * 32
361
 
    NULL_PARENT_DETAILS = ('a', '', 0, False, '')
 
351
    NULL_PARENT_DETAILS = static_tuple.StaticTuple('a', '', 0, False, '')
362
352
 
363
353
    HEADER_FORMAT_2 = '#bazaar dirstate flat format 2\n'
364
354
    HEADER_FORMAT_3 = '#bazaar dirstate flat format 3\n'
365
355
 
366
 
    def __init__(self, path, sha1_provider):
 
356
    def __init__(self, path, sha1_provider, worth_saving_limit=0):
367
357
        """Create a  DirState object.
368
358
 
369
359
        :param path: The path at which the dirstate file on disk should live.
370
360
        :param sha1_provider: an object meeting the SHA1Provider interface.
 
361
        :param worth_saving_limit: when the exact number of hash changed
 
362
            entries is known, only bother saving the dirstate if more than
 
363
            this count of entries have changed.
 
364
            -1 means never save hash changes, 0 means always save hash changes.
371
365
        """
372
366
        # _header_state and _dirblock_state represent the current state
373
367
        # of the dirstate metadata and the per-row data respectiely.
410
404
        # during commit.
411
405
        self._last_block_index = None
412
406
        self._last_entry_index = None
 
407
        # The set of known hash changes
 
408
        self._known_hash_changes = set()
 
409
        # How many hash changed entries can we have without saving
 
410
        self._worth_saving_limit = worth_saving_limit
 
411
        self._config_stack = config.LocationStack(urlutils.local_path_to_url(
 
412
            path))
413
413
 
414
414
    def __repr__(self):
415
415
        return "%s(%r)" % \
416
416
            (self.__class__.__name__, self._filename)
417
417
 
 
418
    def _mark_modified(self, hash_changed_entries=None, header_modified=False):
 
419
        """Mark this dirstate as modified.
 
420
 
 
421
        :param hash_changed_entries: if non-None, mark just these entries as
 
422
            having their hash modified.
 
423
        :param header_modified: mark the header modified as well, not just the
 
424
            dirblocks.
 
425
        """
 
426
        #trace.mutter_callsite(3, "modified hash entries: %s", hash_changed_entries)
 
427
        if hash_changed_entries:
 
428
            self._known_hash_changes.update([e[0] for e in hash_changed_entries])
 
429
            if self._dirblock_state in (DirState.NOT_IN_MEMORY,
 
430
                                        DirState.IN_MEMORY_UNMODIFIED):
 
431
                # If the dirstate is already marked a IN_MEMORY_MODIFIED, then
 
432
                # that takes precedence.
 
433
                self._dirblock_state = DirState.IN_MEMORY_HASH_MODIFIED
 
434
        else:
 
435
            # TODO: Since we now have a IN_MEMORY_HASH_MODIFIED state, we
 
436
            #       should fail noisily if someone tries to set
 
437
            #       IN_MEMORY_MODIFIED but we don't have a write-lock!
 
438
            # We don't know exactly what changed so disable smart saving
 
439
            self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
440
        if header_modified:
 
441
            self._header_state = DirState.IN_MEMORY_MODIFIED
 
442
 
 
443
    def _mark_unmodified(self):
 
444
        """Mark this dirstate as unmodified."""
 
445
        self._header_state = DirState.IN_MEMORY_UNMODIFIED
 
446
        self._dirblock_state = DirState.IN_MEMORY_UNMODIFIED
 
447
        self._known_hash_changes = set()
 
448
 
418
449
    def add(self, path, file_id, kind, stat, fingerprint):
419
450
        """Add a path to be tracked.
420
451
 
546
577
        if kind == 'directory':
547
578
           # insert a new dirblock
548
579
           self._ensure_block(block_index, entry_index, utf8path)
549
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
580
        self._mark_modified()
550
581
        if self._id_index:
551
 
            self._id_index.setdefault(entry_key[2], set()).add(entry_key)
 
582
            self._add_to_id_index(self._id_index, entry_key)
552
583
 
553
584
    def _bisect(self, paths):
554
585
        """Bisect through the disk structure for specific rows.
1018
1049
 
1019
1050
        self._ghosts = []
1020
1051
        self._parents = [parents[0]]
1021
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1022
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
 
1052
        self._mark_modified(header_modified=True)
1023
1053
 
1024
1054
    def _empty_parent_info(self):
1025
1055
        return [DirState.NULL_PARENT_DETAILS] * (len(self._parents) -
1154
1184
    def _fields_per_entry(self):
1155
1185
        """How many null separated fields should be in each entry row.
1156
1186
 
1157
 
        Each line now has an extra '\n' field which is not used
 
1187
        Each line now has an extra '\\n' field which is not used
1158
1188
        so we just skip over it
1159
 
        entry size:
 
1189
 
 
1190
        entry size::
1160
1191
            3 fields for the key
1161
1192
            + number of fields per tree_data (5) * tree count
1162
1193
            + newline
1275
1306
            raise
1276
1307
        return result
1277
1308
 
 
1309
    def _check_delta_is_valid(self, delta):
 
1310
        return list(inventory._check_delta_unique_ids(
 
1311
                    inventory._check_delta_unique_old_paths(
 
1312
                    inventory._check_delta_unique_new_paths(
 
1313
                    inventory._check_delta_ids_match_entry(
 
1314
                    inventory._check_delta_ids_are_valid(
 
1315
                    inventory._check_delta_new_path_entry_both_or_None(delta)))))))
 
1316
 
1278
1317
    def update_by_delta(self, delta):
1279
1318
        """Apply an inventory delta to the dirstate for tree 0
1280
1319
 
1298
1337
        new_ids = set()
1299
1338
        # This loop transforms the delta to single atomic operations that can
1300
1339
        # 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):
 
1340
        delta = sorted(self._check_delta_is_valid(delta), reverse=True)
 
1341
        for old_path, new_path, file_id, inv_entry in delta:
1308
1342
            if (file_id in insertions) or (file_id in removals):
1309
 
                raise errors.InconsistentDelta(old_path or new_path, file_id,
 
1343
                self._raise_invalid(old_path or new_path, file_id,
1310
1344
                    "repeated file_id")
1311
1345
            if old_path is not None:
1312
1346
                old_path = old_path.encode('utf-8')
1315
1349
                new_ids.add(file_id)
1316
1350
            if new_path is not None:
1317
1351
                if inv_entry is None:
1318
 
                    raise errors.InconsistentDelta(new_path, file_id,
 
1352
                    self._raise_invalid(new_path, file_id,
1319
1353
                        "new_path with no entry")
1320
1354
                new_path = new_path.encode('utf-8')
1321
1355
                dirname_utf8, basename = osutils.split(new_path)
1362
1396
            # _get_entry raises BzrError when a request is inconsistent; we
1363
1397
            # want such errors to be shown as InconsistentDelta - and that 
1364
1398
            # fits the behaviour we trigger.
1365
 
            raise errors.InconsistentDeltaDelta(delta, "error from _get_entry.")
 
1399
            raise errors.InconsistentDeltaDelta(delta,
 
1400
                "error from _get_entry. %s" % (e,))
1366
1401
 
1367
1402
    def _apply_removals(self, removals):
1368
1403
        for file_id, path in sorted(removals, reverse=True,
1373
1408
            try:
1374
1409
                entry = self._dirblocks[block_i][1][entry_i]
1375
1410
            except IndexError:
1376
 
                self._changes_aborted = True
1377
 
                raise errors.InconsistentDelta(path, file_id,
 
1411
                self._raise_invalid(path, file_id,
1378
1412
                    "Wrong path for old path.")
1379
1413
            if not f_present or entry[1][0][0] in 'ar':
1380
 
                self._changes_aborted = True
1381
 
                raise errors.InconsistentDelta(path, file_id,
 
1414
                self._raise_invalid(path, file_id,
1382
1415
                    "Wrong path for old path.")
1383
1416
            if file_id != entry[0][2]:
1384
 
                self._changes_aborted = True
1385
 
                raise errors.InconsistentDelta(path, file_id,
 
1417
                self._raise_invalid(path, file_id,
1386
1418
                    "Attempt to remove path has wrong id - found %r."
1387
1419
                    % entry[0][2])
1388
1420
            self._make_absent(entry)
1398
1430
                # be due to it being in a parent tree, or a corrupt delta.
1399
1431
                for child_entry in self._dirblocks[block_i][1]:
1400
1432
                    if child_entry[1][0][0] not in ('r', 'a'):
1401
 
                        self._changes_aborted = True
1402
 
                        raise errors.InconsistentDelta(path, entry[0][2],
 
1433
                        self._raise_invalid(path, entry[0][2],
1403
1434
                            "The file id was deleted but its children were "
1404
1435
                            "not deleted.")
1405
1436
 
1409
1440
                self.update_minimal(key, minikind, executable, fingerprint,
1410
1441
                                    path_utf8=path_utf8)
1411
1442
        except errors.NotVersionedError:
1412
 
            self._changes_aborted = True
1413
 
            raise errors.InconsistentDelta(path_utf8.decode('utf8'), key[2],
 
1443
            self._raise_invalid(path_utf8.decode('utf8'), key[2],
1414
1444
                "Missing parent")
1415
1445
 
1416
1446
    def update_basis_by_delta(self, delta, new_revid):
1424
1454
        Note that an exception during the operation of this method will leave
1425
1455
        the dirstate in a corrupt state where it should not be saved.
1426
1456
 
1427
 
        Finally, we expect all changes to be synchronising the basis tree with
1428
 
        the working tree.
1429
 
 
1430
1457
        :param new_revid: The new revision id for the trees parent.
1431
1458
        :param delta: An inventory delta (see apply_inventory_delta) describing
1432
1459
            the changes from the current left most parent revision to new_revid.
1444
1471
 
1445
1472
        self._parents[0] = new_revid
1446
1473
 
1447
 
        delta = sorted(delta, reverse=True)
 
1474
        delta = sorted(self._check_delta_is_valid(delta), reverse=True)
1448
1475
        adds = []
1449
1476
        changes = []
1450
1477
        deletes = []
1471
1498
        new_ids = set()
1472
1499
        for old_path, new_path, file_id, inv_entry in delta:
1473
1500
            if inv_entry is not None and file_id != inv_entry.file_id:
1474
 
                raise errors.InconsistentDelta(new_path, file_id,
 
1501
                self._raise_invalid(new_path, file_id,
1475
1502
                    "mismatched entry file_id %r" % inv_entry)
1476
 
            if new_path is not None:
 
1503
            if new_path is None:
 
1504
                new_path_utf8 = None
 
1505
            else:
1477
1506
                if inv_entry is None:
1478
 
                    raise errors.InconsistentDelta(new_path, file_id,
 
1507
                    self._raise_invalid(new_path, file_id,
1479
1508
                        "new_path with no entry")
1480
1509
                new_path_utf8 = encode(new_path)
1481
1510
                # note the parent for validation
1483
1512
                if basename_utf8:
1484
1513
                    parents.add((dirname_utf8, inv_entry.parent_id))
1485
1514
            if old_path is None:
1486
 
                adds.append((None, encode(new_path), file_id,
 
1515
                old_path_utf8 = None
 
1516
            else:
 
1517
                old_path_utf8 = encode(old_path)
 
1518
            if old_path is None:
 
1519
                adds.append((None, new_path_utf8, file_id,
1487
1520
                    inv_to_entry(inv_entry), True))
1488
1521
                new_ids.add(file_id)
1489
1522
            elif new_path is None:
1490
 
                deletes.append((encode(old_path), None, file_id, None, True))
1491
 
            elif (old_path, new_path) != root_only:
 
1523
                deletes.append((old_path_utf8, None, file_id, None, True))
 
1524
            elif (old_path, new_path) == root_only:
 
1525
                # change things in-place
 
1526
                # Note: the case of a parent directory changing its file_id
 
1527
                #       tends to break optimizations here, because officially
 
1528
                #       the file has actually been moved, it just happens to
 
1529
                #       end up at the same path. If we can figure out how to
 
1530
                #       handle that case, we can avoid a lot of add+delete
 
1531
                #       pairs for objects that stay put.
 
1532
                # elif old_path == new_path:
 
1533
                changes.append((old_path_utf8, new_path_utf8, file_id,
 
1534
                                inv_to_entry(inv_entry)))
 
1535
            else:
1492
1536
                # Renames:
1493
1537
                # Because renames must preserve their children we must have
1494
1538
                # processed all relocations and removes before hand. The sort
1504
1548
                self._update_basis_apply_deletes(deletes)
1505
1549
                deletes = []
1506
1550
                # Split into an add/delete pair recursively.
1507
 
                adds.append((None, new_path_utf8, file_id,
1508
 
                    inv_to_entry(inv_entry), False))
 
1551
                adds.append((old_path_utf8, new_path_utf8, file_id,
 
1552
                             inv_to_entry(inv_entry), False))
1509
1553
                # Expunge deletes that we've seen so that deleted/renamed
1510
1554
                # children of a rename directory are handled correctly.
1511
 
                new_deletes = reversed(list(self._iter_child_entries(1,
1512
 
                    encode(old_path))))
 
1555
                new_deletes = reversed(list(
 
1556
                    self._iter_child_entries(1, old_path_utf8)))
1513
1557
                # Remove the current contents of the tree at orig_path, and
1514
1558
                # reinsert at the correct new path.
1515
1559
                for entry in new_deletes:
1516
 
                    if entry[0][0]:
1517
 
                        source_path = entry[0][0] + '/' + entry[0][1]
 
1560
                    child_dirname, child_basename, child_file_id = entry[0]
 
1561
                    if child_dirname:
 
1562
                        source_path = child_dirname + '/' + child_basename
1518
1563
                    else:
1519
 
                        source_path = entry[0][1]
 
1564
                        source_path = child_basename
1520
1565
                    if new_path_utf8:
1521
1566
                        target_path = new_path_utf8 + source_path[len(old_path):]
1522
1567
                    else:
1523
1568
                        if old_path == '':
1524
1569
                            raise AssertionError("cannot rename directory to"
1525
 
                                " itself")
 
1570
                                                 " itself")
1526
1571
                        target_path = source_path[len(old_path) + 1:]
1527
1572
                    adds.append((None, target_path, entry[0][2], entry[1][1], False))
1528
1573
                    deletes.append(
1529
1574
                        (source_path, target_path, entry[0][2], None, False))
1530
 
                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)))
 
1575
                deletes.append((old_path_utf8, new_path, file_id, None, False))
1537
1576
        self._check_delta_ids_absent(new_ids, delta, 1)
1538
1577
        try:
1539
1578
            # Finish expunging deletes/first half of renames.
1549
1588
            if 'integrity error' not in str(e):
1550
1589
                raise
1551
1590
            # _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.")
 
1591
            # want such errors to be shown as InconsistentDelta - and that
 
1592
            # fits the behaviour we trigger.
 
1593
            raise errors.InconsistentDeltaDelta(delta,
 
1594
                "error from _get_entry. %s" % (e,))
1557
1595
 
1558
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1559
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
 
1596
        self._mark_modified(header_modified=True)
1560
1597
        self._id_index = None
1561
1598
        return
1562
1599
 
1566
1603
            return
1567
1604
        id_index = self._get_id_index()
1568
1605
        for file_id in new_ids:
1569
 
            for key in id_index.get(file_id, []):
 
1606
            for key in id_index.get(file_id, ()):
1570
1607
                block_i, entry_i, d_present, f_present = \
1571
1608
                    self._get_block_entry_index(key[0], key[1], tree_index)
1572
1609
                if not f_present:
1576
1613
                if entry[0][2] != file_id:
1577
1614
                    # Different file_id, so not what we want.
1578
1615
                    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,
 
1616
                self._raise_invalid(("%s/%s" % key[0:2]).decode('utf8'), file_id,
1583
1617
                    "This file_id is new in the delta but already present in "
1584
1618
                    "the target")
1585
1619
 
 
1620
    def _raise_invalid(self, path, file_id, reason):
 
1621
        self._changes_aborted = True
 
1622
        raise errors.InconsistentDelta(path, file_id, reason)
 
1623
 
1586
1624
    def _update_basis_apply_adds(self, adds):
1587
1625
        """Apply a sequence of adds to tree 1 during update_basis_by_delta.
1588
1626
 
1596
1634
        """
1597
1635
        # Adds are accumulated partly from renames, so can be in any input
1598
1636
        # order - sort it.
1599
 
        adds.sort()
 
1637
        # TODO: we may want to sort in dirblocks order. That way each entry
 
1638
        #       will end up in the same directory, allowing the _get_entry
 
1639
        #       fast-path for looking up 2 items in the same dir work.
 
1640
        adds.sort(key=lambda x: x[1])
1600
1641
        # adds is now in lexographic order, which places all parents before
1601
1642
        # their children, so we can process it linearly.
1602
1643
        absent = 'ar'
 
1644
        st = static_tuple.StaticTuple
1603
1645
        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
 
1646
            dirname, basename = osutils.split(new_path)
 
1647
            entry_key = st(dirname, basename, file_id)
 
1648
            block_index, present = self._find_block_index_from_key(entry_key)
 
1649
            if not present:
 
1650
                self._raise_invalid(new_path, file_id,
 
1651
                    "Unable to find block for this record."
 
1652
                    " Was the parent added?")
 
1653
            block = self._dirblocks[block_index][1]
 
1654
            entry_index, present = self._find_entry_index(entry_key, block)
 
1655
            if real_add:
 
1656
                if old_path is not None:
 
1657
                    self._raise_invalid(new_path, file_id,
 
1658
                        'considered a real add but still had old_path at %s'
 
1659
                        % (old_path,))
 
1660
            if present:
 
1661
                entry = block[entry_index]
 
1662
                basis_kind = entry[1][1][0]
 
1663
                if basis_kind == 'a':
 
1664
                    entry[1][1] = new_details
 
1665
                elif basis_kind == 'r':
 
1666
                    raise NotImplementedError()
 
1667
                else:
 
1668
                    self._raise_invalid(new_path, file_id,
 
1669
                        "An entry was marked as a new add"
 
1670
                        " but the basis target already existed")
 
1671
            else:
 
1672
                # The exact key was not found in the block. However, we need to
 
1673
                # check if there is a key next to us that would have matched.
 
1674
                # We only need to check 2 locations, because there are only 2
 
1675
                # trees present.
 
1676
                for maybe_index in range(entry_index-1, entry_index+1):
 
1677
                    if maybe_index < 0 or maybe_index >= len(block):
 
1678
                        continue
 
1679
                    maybe_entry = block[maybe_index]
 
1680
                    if maybe_entry[0][:2] != (dirname, basename):
 
1681
                        # Just a random neighbor
 
1682
                        continue
 
1683
                    if maybe_entry[0][2] == file_id:
 
1684
                        raise AssertionError(
 
1685
                            '_find_entry_index didnt find a key match'
 
1686
                            ' but walking the data did, for %s'
 
1687
                            % (entry_key,))
 
1688
                    basis_kind = maybe_entry[1][1][0]
 
1689
                    if basis_kind not in 'ar':
 
1690
                        self._raise_invalid(new_path, file_id,
 
1691
                            "we have an add record for path, but the path"
 
1692
                            " is already present with another file_id %s"
 
1693
                            % (maybe_entry[0][2],))
 
1694
 
 
1695
                entry = (entry_key, [DirState.NULL_PARENT_DETAILS,
 
1696
                                     new_details])
 
1697
                block.insert(entry_index, entry)
 
1698
 
 
1699
            active_kind = entry[1][0][0]
 
1700
            if active_kind == 'a':
 
1701
                # The active record shows up as absent, this could be genuine,
 
1702
                # or it could be present at some other location. We need to
 
1703
                # verify.
 
1704
                id_index = self._get_id_index()
 
1705
                # The id_index may not be perfectly accurate for tree1, because
 
1706
                # we haven't been keeping it updated. However, it should be
 
1707
                # fine for tree0, and that gives us enough info for what we
 
1708
                # need
 
1709
                keys = id_index.get(file_id, ())
 
1710
                for key in keys:
 
1711
                    block_i, entry_i, d_present, f_present = \
 
1712
                        self._get_block_entry_index(key[0], key[1], 0)
 
1713
                    if not f_present:
 
1714
                        continue
 
1715
                    active_entry = self._dirblocks[block_i][1][entry_i]
 
1716
                    if (active_entry[0][2] != file_id):
 
1717
                        # Some other file is at this path, we don't need to
 
1718
                        # link it.
 
1719
                        continue
 
1720
                    real_active_kind = active_entry[1][0][0]
 
1721
                    if real_active_kind in 'ar':
 
1722
                        # We found a record, which was not *this* record,
 
1723
                        # which matches the file_id, but is not actually
 
1724
                        # present. Something seems *really* wrong.
 
1725
                        self._raise_invalid(new_path, file_id,
 
1726
                            "We found a tree0 entry that doesnt make sense")
 
1727
                    # Now, we've found a tree0 entry which matches the file_id
 
1728
                    # but is at a different location. So update them to be
 
1729
                    # rename records.
 
1730
                    active_dir, active_name = active_entry[0][:2]
 
1731
                    if active_dir:
 
1732
                        active_path = active_dir + '/' + active_name
 
1733
                    else:
 
1734
                        active_path = active_name
 
1735
                    active_entry[1][1] = st('r', new_path, 0, False, '')
 
1736
                    entry[1][0] = st('r', active_path, 0, False, '')
 
1737
            elif active_kind == 'r':
 
1738
                raise NotImplementedError()
 
1739
 
 
1740
            new_kind = new_details[0]
 
1741
            if new_kind == 'd':
 
1742
                self._ensure_block(block_index, entry_index, new_path)
1619
1743
 
1620
1744
    def _update_basis_apply_changes(self, changes):
1621
1745
        """Apply a sequence of changes to tree 1 during update_basis_by_delta.
1626
1750
        absent = 'ar'
1627
1751
        for old_path, new_path, file_id, new_details in changes:
1628
1752
            # 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')
 
1753
            entry = self._get_entry(1, file_id, new_path)
 
1754
            if entry[0] is None or entry[1][1][0] in 'ar':
 
1755
                self._raise_invalid(new_path, file_id,
 
1756
                    'changed entry considered not present')
1639
1757
            entry[1][1] = new_details
1640
1758
 
1641
1759
    def _update_basis_apply_deletes(self, deletes):
1653
1771
        null = DirState.NULL_PARENT_DETAILS
1654
1772
        for old_path, new_path, file_id, _, real_delete in deletes:
1655
1773
            if real_delete != (new_path is None):
1656
 
                self._changes_aborted = True
1657
 
                raise AssertionError("bad delete delta")
 
1774
                self._raise_invalid(old_path, file_id, "bad delete delta")
1658
1775
            # the entry for this file_id must be in tree 1.
1659
1776
            dirname, basename = osutils.split(old_path)
1660
1777
            block_index, entry_index, dir_present, file_present = \
1661
1778
                self._get_block_entry_index(dirname, basename, 1)
1662
1779
            if not file_present:
1663
 
                self._changes_aborted = True
1664
 
                raise errors.InconsistentDelta(old_path, file_id,
 
1780
                self._raise_invalid(old_path, file_id,
1665
1781
                    'basis tree does not contain removed entry')
1666
1782
            entry = self._dirblocks[block_index][1][entry_index]
 
1783
            # The state of the entry in the 'active' WT
 
1784
            active_kind = entry[1][0][0]
1667
1785
            if entry[0][2] != file_id:
1668
 
                self._changes_aborted = True
1669
 
                raise errors.InconsistentDelta(old_path, file_id,
 
1786
                self._raise_invalid(old_path, file_id,
1670
1787
                    '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.')
 
1788
            dir_block = ()
 
1789
            old_kind = entry[1][1][0]
 
1790
            if active_kind in 'ar':
 
1791
                # The active tree doesn't have this file_id.
 
1792
                # The basis tree is changing this record. If this is a
 
1793
                # rename, then we don't want the record here at all
 
1794
                # anymore. If it is just an in-place change, we want the
 
1795
                # record here, but we'll add it if we need to. So we just
 
1796
                # delete it
 
1797
                if active_kind == 'r':
 
1798
                    active_path = entry[1][0][1]
 
1799
                    active_entry = self._get_entry(0, file_id, active_path)
 
1800
                    if active_entry[1][1][0] != 'r':
 
1801
                        self._raise_invalid(old_path, file_id,
 
1802
                            "Dirstate did not have matching rename entries")
 
1803
                    elif active_entry[1][0][0] in 'ar':
 
1804
                        self._raise_invalid(old_path, file_id,
 
1805
                            "Dirstate had a rename pointing at an inactive"
 
1806
                            " tree0")
 
1807
                    active_entry[1][1] = null
1677
1808
                del self._dirblocks[block_index][1][entry_index]
 
1809
                if old_kind == 'd':
 
1810
                    # This was a directory, and the active tree says it
 
1811
                    # doesn't exist, and now the basis tree says it doesn't
 
1812
                    # exist. Remove its dirblock if present
 
1813
                    (dir_block_index,
 
1814
                     present) = self._find_block_index_from_key(
 
1815
                        (old_path, '', ''))
 
1816
                    if present:
 
1817
                        dir_block = self._dirblocks[dir_block_index][1]
 
1818
                        if not dir_block:
 
1819
                            # This entry is empty, go ahead and just remove it
 
1820
                            del self._dirblocks[dir_block_index]
1678
1821
            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
 
1822
                # There is still an active record, so just mark this
 
1823
                # removed.
 
1824
                entry[1][1] = null
 
1825
                block_i, entry_i, d_present, f_present = \
 
1826
                    self._get_block_entry_index(old_path, '', 1)
 
1827
                if d_present:
 
1828
                    dir_block = self._dirblocks[block_i][1]
 
1829
            for child_entry in dir_block:
 
1830
                child_basis_kind = child_entry[1][1][0]
 
1831
                if child_basis_kind not in 'ar':
 
1832
                    self._raise_invalid(old_path, file_id,
 
1833
                        "The file id was deleted but its children were "
 
1834
                        "not deleted.")
1694
1835
 
1695
1836
    def _after_delta_check_parents(self, parents, index):
1696
1837
        """Check that parents required by the delta are all intact.
1705
1846
            # has the right file id.
1706
1847
            entry = self._get_entry(index, file_id, dirname_utf8)
1707
1848
            if entry[1] is None:
1708
 
                self._changes_aborted = True
1709
 
                raise errors.InconsistentDelta(dirname_utf8.decode('utf8'),
 
1849
                self._raise_invalid(dirname_utf8.decode('utf8'),
1710
1850
                    file_id, "This parent is not present.")
1711
1851
            # Parents of things must be directories
1712
1852
            if entry[1][index][0] != 'd':
1713
 
                self._changes_aborted = True
1714
 
                raise errors.InconsistentDelta(dirname_utf8.decode('utf8'),
 
1853
                self._raise_invalid(dirname_utf8.decode('utf8'),
1715
1854
                    file_id, "This parent is not a directory.")
1716
1855
 
1717
1856
    def _observed_sha1(self, entry, sha1, stat_value,
1718
 
        _stat_to_minikind=_stat_to_minikind, _pack_stat=pack_stat):
 
1857
        _stat_to_minikind=_stat_to_minikind):
1719
1858
        """Note the sha1 of a file.
1720
1859
 
1721
1860
        :param entry: The entry the sha1 is for.
1727
1866
        except KeyError:
1728
1867
            # Unhandled kind
1729
1868
            return None
1730
 
        packed_stat = _pack_stat(stat_value)
1731
1869
        if minikind == 'f':
1732
1870
            if self._cutoff_time is None:
1733
1871
                self._sha_cutoff_time()
1734
1872
            if (stat_value.st_mtime < self._cutoff_time
1735
1873
                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
 
1874
                entry[1][0] = ('f', sha1, stat_value.st_size, entry[1][0][3],
 
1875
                               pack_stat(stat_value))
 
1876
                self._mark_modified([entry])
1739
1877
 
1740
1878
    def _sha_cutoff_time(self):
1741
1879
        """Return cutoff time.
1799
1937
        """Serialise the entire dirstate to a sequence of lines."""
1800
1938
        if (self._header_state == DirState.IN_MEMORY_UNMODIFIED and
1801
1939
            self._dirblock_state == DirState.IN_MEMORY_UNMODIFIED):
1802
 
            # read whats on disk.
 
1940
            # read what's on disk.
1803
1941
            self._state_file.seek(0)
1804
1942
            return self._state_file.readlines()
1805
1943
        lines = []
1806
1944
        lines.append(self._get_parents_line(self.get_parent_ids()))
1807
1945
        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()))
 
1946
        lines.extend(self._get_entry_lines())
1810
1947
        return self._get_output_lines(lines)
1811
1948
 
1812
1949
    def _get_ghosts_line(self, ghost_ids):
1817
1954
        """Create a line for the state file for parents information."""
1818
1955
        return '\0'.join([str(len(parent_ids))] + parent_ids)
1819
1956
 
 
1957
    def _get_entry_lines(self):
 
1958
        """Create lines for entries."""
 
1959
        return map(self._entry_to_line, self._iter_entries())
 
1960
 
1820
1961
    def _get_fields_to_entry(self):
1821
1962
        """Get a function which converts entry fields into a entry record.
1822
1963
 
1940
2081
            entry_index += 1
1941
2082
        return block_index, entry_index, True, False
1942
2083
 
1943
 
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None, include_deleted=False):
 
2084
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None,
 
2085
                   include_deleted=False):
1944
2086
        """Get the dirstate entry for path in tree tree_index.
1945
2087
 
1946
2088
        If either file_id or path is supplied, it is used as the key to lookup.
1980
2122
                                          ' tree_index, file_id and path')
1981
2123
            return entry
1982
2124
        else:
1983
 
            possible_keys = self._get_id_index().get(fileid_utf8, None)
 
2125
            possible_keys = self._get_id_index().get(fileid_utf8, ())
1984
2126
            if not possible_keys:
1985
2127
                return None, None
1986
2128
            for key in possible_keys:
2088
2230
            executable = False
2089
2231
        else:
2090
2232
            raise Exception("can't pack %s" % inv_entry)
2091
 
        return (minikind, fingerprint, size, executable, tree_data)
 
2233
        return static_tuple.StaticTuple(minikind, fingerprint, size,
 
2234
                                        executable, tree_data)
2092
2235
 
2093
2236
    def _iter_child_entries(self, tree_index, path_utf8):
2094
2237
        """Iterate over all the entries that are children of path_utf.
2143
2286
                yield entry
2144
2287
 
2145
2288
    def _get_id_index(self):
2146
 
        """Get an id index of self._dirblocks."""
 
2289
        """Get an id index of self._dirblocks.
 
2290
 
 
2291
        This maps from file_id => [(directory, name, file_id)] entries where
 
2292
        that file_id appears in one of the trees.
 
2293
        """
2147
2294
        if self._id_index is None:
2148
2295
            id_index = {}
2149
2296
            for key, tree_details in self._iter_entries():
2150
 
                id_index.setdefault(key[2], set()).add(key)
 
2297
                self._add_to_id_index(id_index, key)
2151
2298
            self._id_index = id_index
2152
2299
        return self._id_index
2153
2300
 
 
2301
    def _add_to_id_index(self, id_index, entry_key):
 
2302
        """Add this entry to the _id_index mapping."""
 
2303
        # This code used to use a set for every entry in the id_index. However,
 
2304
        # it is *rare* to have more than one entry. So a set is a large
 
2305
        # overkill. And even when we do, we won't ever have more than the
 
2306
        # number of parent trees. Which is still a small number (rarely >2). As
 
2307
        # such, we use a simple tuple, and do our own uniqueness checks. While
 
2308
        # the 'in' check is O(N) since N is nicely bounded it shouldn't ever
 
2309
        # cause quadratic failure.
 
2310
        file_id = entry_key[2]
 
2311
        entry_key = static_tuple.StaticTuple.from_sequence(entry_key)
 
2312
        if file_id not in id_index:
 
2313
            id_index[file_id] = static_tuple.StaticTuple(entry_key,)
 
2314
        else:
 
2315
            entry_keys = id_index[file_id]
 
2316
            if entry_key not in entry_keys:
 
2317
                id_index[file_id] = entry_keys + (entry_key,)
 
2318
 
 
2319
    def _remove_from_id_index(self, id_index, entry_key):
 
2320
        """Remove this entry from the _id_index mapping.
 
2321
 
 
2322
        It is an programming error to call this when the entry_key is not
 
2323
        already present.
 
2324
        """
 
2325
        file_id = entry_key[2]
 
2326
        entry_keys = list(id_index[file_id])
 
2327
        entry_keys.remove(entry_key)
 
2328
        id_index[file_id] = static_tuple.StaticTuple.from_sequence(entry_keys)
 
2329
 
2154
2330
    def _get_output_lines(self, lines):
2155
2331
        """Format lines for final output.
2156
2332
 
2176
2352
        """The number of parent entries in each record row."""
2177
2353
        return len(self._parents) - len(self._ghosts)
2178
2354
 
2179
 
    @staticmethod
2180
 
    def on_file(path, sha1_provider=None):
 
2355
    @classmethod
 
2356
    def on_file(cls, path, sha1_provider=None, worth_saving_limit=0):
2181
2357
        """Construct a DirState on the file at path "path".
2182
2358
 
2183
2359
        :param path: The path at which the dirstate file on disk should live.
2184
2360
        :param sha1_provider: an object meeting the SHA1Provider interface.
2185
2361
            If None, a DefaultSHA1Provider is used.
 
2362
        :param worth_saving_limit: when the exact number of hash changed
 
2363
            entries is known, only bother saving the dirstate if more than
 
2364
            this count of entries have changed. -1 means never save.
2186
2365
        :return: An unlocked DirState object, associated with the given path.
2187
2366
        """
2188
2367
        if sha1_provider is None:
2189
2368
            sha1_provider = DefaultSHA1Provider()
2190
 
        result = DirState(path, sha1_provider)
 
2369
        result = cls(path, sha1_provider,
 
2370
                     worth_saving_limit=worth_saving_limit)
2191
2371
        return result
2192
2372
 
2193
2373
    def _read_dirblocks_if_needed(self):
2251
2431
            raise errors.BzrError('missing num_entries line')
2252
2432
        self._num_entries = int(num_entries_line[len('num_entries: '):-1])
2253
2433
 
2254
 
    def sha1_from_stat(self, path, stat_result, _pack_stat=pack_stat):
 
2434
    def sha1_from_stat(self, path, stat_result):
2255
2435
        """Find a sha1 given a stat lookup."""
2256
 
        return self._get_packed_stat_index().get(_pack_stat(stat_result), None)
 
2436
        return self._get_packed_stat_index().get(pack_stat(stat_result), None)
2257
2437
 
2258
2438
    def _get_packed_stat_index(self):
2259
2439
        """Get a packed_stat index of self._dirblocks."""
2285
2465
            trace.mutter('Not saving DirState because '
2286
2466
                    '_changes_aborted is set.')
2287
2467
            return
2288
 
        if (self._header_state == DirState.IN_MEMORY_MODIFIED or
2289
 
            self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
 
2468
        # TODO: Since we now distinguish IN_MEMORY_MODIFIED from
 
2469
        #       IN_MEMORY_HASH_MODIFIED, we should only fail quietly if we fail
 
2470
        #       to save an IN_MEMORY_HASH_MODIFIED, and fail *noisily* if we
 
2471
        #       fail to save IN_MEMORY_MODIFIED
 
2472
        if not self._worth_saving():
 
2473
            return
2290
2474
 
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.
 
2475
        grabbed_write_lock = False
 
2476
        if self._lock_state != 'w':
 
2477
            grabbed_write_lock, new_lock = self._lock_token.temporary_write_lock()
 
2478
            # Switch over to the new lock, as the old one may be closed.
 
2479
            # TODO: jam 20070315 We should validate the disk file has
 
2480
            #       not changed contents, since temporary_write_lock may
 
2481
            #       not be an atomic operation.
 
2482
            self._lock_token = new_lock
 
2483
            self._state_file = new_lock.f
 
2484
            if not grabbed_write_lock:
 
2485
                # We couldn't grab a write lock, so we switch back to a read one
 
2486
                return
 
2487
        try:
 
2488
            lines = self.get_lines()
 
2489
            self._state_file.seek(0)
 
2490
            self._state_file.writelines(lines)
 
2491
            self._state_file.truncate()
 
2492
            self._state_file.flush()
 
2493
            self._maybe_fdatasync()
 
2494
            self._mark_unmodified()
 
2495
        finally:
 
2496
            if grabbed_write_lock:
 
2497
                self._lock_token = self._lock_token.restore_read_lock()
 
2498
                self._state_file = self._lock_token.f
2295
2499
                # 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.
 
2500
                #       not changed contents. Since restore_read_lock may
 
2501
                #       not be an atomic operation.                
 
2502
 
 
2503
    def _maybe_fdatasync(self):
 
2504
        """Flush to disk if possible and if not configured off."""
 
2505
        if self._config_stack.get('dirstate.fdatasync'):
 
2506
            osutils.fdatasync(self._state_file.fileno())
 
2507
 
 
2508
    def _worth_saving(self):
 
2509
        """Is it worth saving the dirstate or not?"""
 
2510
        if (self._header_state == DirState.IN_MEMORY_MODIFIED
 
2511
            or self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
 
2512
            return True
 
2513
        if self._dirblock_state == DirState.IN_MEMORY_HASH_MODIFIED:
 
2514
            if self._worth_saving_limit == -1:
 
2515
                # We never save hash changes when the limit is -1
 
2516
                return False
 
2517
            # If we're using smart saving and only a small number of
 
2518
            # entries have changed their hash, don't bother saving. John has
 
2519
            # suggested using a heuristic here based on the size of the
 
2520
            # changed files and/or tree. For now, we go with a configurable
 
2521
            # number of changes, keeping the calculation time
 
2522
            # as low overhead as possible. (This also keeps all existing
 
2523
            # tests passing as the default is 0, i.e. always save.)
 
2524
            if len(self._known_hash_changes) >= self._worth_saving_limit:
 
2525
                return True
 
2526
        return False
2317
2527
 
2318
2528
    def _set_data(self, parent_ids, dirblocks):
2319
2529
        """Set the full dirstate data in memory.
2328
2538
        """
2329
2539
        # our memory copy is now authoritative.
2330
2540
        self._dirblocks = dirblocks
2331
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
2332
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2541
        self._mark_modified(header_modified=True)
2333
2542
        self._parents = list(parent_ids)
2334
2543
        self._id_index = None
2335
2544
        self._packed_stat_index = None
2355
2564
        self._make_absent(entry)
2356
2565
        self.update_minimal(('', '', new_id), 'd',
2357
2566
            path_utf8='', packed_stat=entry[1][0][4])
2358
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2567
        self._mark_modified()
 
2568
        # XXX: This was added by Ian, we need to make sure there
 
2569
        #      are tests for it, because it isn't in bzr.dev TRUNK
 
2570
        #      It looks like the only place it is called is in setting the root
 
2571
        #      id of the tree. So probably we never had an _id_index when we
 
2572
        #      don't even have a root yet.
 
2573
        if self._id_index is not None:
 
2574
            self._add_to_id_index(self._id_index, entry[0])
2359
2575
 
2360
2576
    def set_parent_trees(self, trees, ghosts):
2361
2577
        """Set the parent trees for the dirstate.
2406
2622
        parent_trees = [tree for rev_id, tree in trees if rev_id not in ghosts]
2407
2623
        # how many trees do we end up with
2408
2624
        parent_count = len(parent_trees)
 
2625
        st = static_tuple.StaticTuple
2409
2626
 
2410
2627
        # one: the current tree
2411
2628
        for entry in self._iter_entries():
2414
2631
                continue
2415
2632
            by_path[entry[0]] = [entry[1][0]] + \
2416
2633
                [DirState.NULL_PARENT_DETAILS] * parent_count
2417
 
            id_index[entry[0][2]] = set([entry[0]])
 
2634
            # TODO: Possibly inline this, since we know it isn't present yet
 
2635
            #       id_index[entry[0][2]] = (entry[0],)
 
2636
            self._add_to_id_index(id_index, entry[0])
2418
2637
 
2419
2638
        # now the parent trees:
2420
2639
        for tree_index, tree in enumerate(parent_trees):
2426
2645
            # the suffix is from tree_index+1:parent_count+1.
2427
2646
            new_location_suffix = [DirState.NULL_PARENT_DETAILS] * (parent_count - tree_index)
2428
2647
            # now stitch in all the entries from this tree
2429
 
            for path, entry in tree.inventory.iter_entries_by_dir():
 
2648
            last_dirname = None
 
2649
            for path, entry in tree.iter_entries_by_dir():
2430
2650
                # here we process each trees details for each item in the tree.
2431
2651
                # we first update any existing entries for the id at other paths,
2432
2652
                # then we either create or update the entry for the id at the
2439
2659
                file_id = entry.file_id
2440
2660
                path_utf8 = path.encode('utf8')
2441
2661
                dirname, basename = osutils.split(path_utf8)
2442
 
                new_entry_key = (dirname, basename, file_id)
 
2662
                if dirname == last_dirname:
 
2663
                    # Try to re-use objects as much as possible
 
2664
                    dirname = last_dirname
 
2665
                else:
 
2666
                    last_dirname = dirname
 
2667
                new_entry_key = st(dirname, basename, file_id)
2443
2668
                # tree index consistency: All other paths for this id in this tree
2444
2669
                # index must point to the correct path.
2445
 
                for entry_key in id_index.setdefault(file_id, set()):
 
2670
                entry_keys = id_index.get(file_id, ())
 
2671
                for entry_key in entry_keys:
2446
2672
                    # TODO:PROFILING: It might be faster to just update
2447
2673
                    # rather than checking if we need to, and then overwrite
2448
2674
                    # the one we are located at.
2451
2677
                        # other trees, so put absent pointers there
2452
2678
                        # This is the vertical axis in the matrix, all pointing
2453
2679
                        # 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.
 
2680
                        by_path[entry_key][tree_index] = st('r', path_utf8, 0,
 
2681
                                                            False, '')
 
2682
                # by path consistency: Insert into an existing path record
 
2683
                # (trivial), or add a new one with relocation pointers for the
 
2684
                # other tree indexes.
 
2685
                if new_entry_key in entry_keys:
 
2686
                    # there is already an entry where this data belongs, just
 
2687
                    # insert it.
2459
2688
                    by_path[new_entry_key][tree_index] = \
2460
2689
                        self._inv_entry_to_details(entry)
2461
2690
                else:
2465
2694
                    new_details = []
2466
2695
                    for lookup_index in xrange(tree_index):
2467
2696
                        # boundary case: this is the first occurence of file_id
2468
 
                        # so there are no id_indexs, possibly take this out of
 
2697
                        # so there are no id_indexes, possibly take this out of
2469
2698
                        # the loop?
2470
 
                        if not len(id_index[file_id]):
 
2699
                        if not len(entry_keys):
2471
2700
                            new_details.append(DirState.NULL_PARENT_DETAILS)
2472
2701
                        else:
2473
2702
                            # 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()
 
2703
                            a_key = iter(entry_keys).next()
2478
2704
                            if by_path[a_key][lookup_index][0] in ('r', 'a'):
2479
 
                                # its a pointer or missing statement, use it as is.
 
2705
                                # its a pointer or missing statement, use it as
 
2706
                                # is.
2480
2707
                                new_details.append(by_path[a_key][lookup_index])
2481
2708
                            else:
2482
2709
                                # we have the right key, make a pointer to it.
2483
2710
                                real_path = ('/'.join(a_key[0:2])).strip('/')
2484
 
                                new_details.append(('r', real_path, 0, False, ''))
 
2711
                                new_details.append(st('r', real_path, 0, False,
 
2712
                                                      ''))
2485
2713
                    new_details.append(self._inv_entry_to_details(entry))
2486
2714
                    new_details.extend(new_location_suffix)
2487
2715
                    by_path[new_entry_key] = new_details
2488
 
                    id_index[file_id].add(new_entry_key)
 
2716
                    self._add_to_id_index(id_index, new_entry_key)
2489
2717
        # --- end generation of full tree mappings
2490
2718
 
2491
2719
        # sort and output all the entries
2493
2721
        self._entries_to_current_state(new_entries)
2494
2722
        self._parents = [rev_id for rev_id, tree in trees]
2495
2723
        self._ghosts = list(ghosts)
2496
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
2497
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2724
        self._mark_modified(header_modified=True)
2498
2725
        self._id_index = id_index
2499
2726
 
2500
2727
    def _sort_entries(self, entry_list):
2504
2731
        try to keep everything in sorted blocks all the time, but sometimes
2505
2732
        it's easier to sort after the fact.
2506
2733
        """
2507
 
        def _key(entry):
 
2734
        # When sorting, we usually have 10x more entries than directories. (69k
 
2735
        # total entries, 4k directories). So cache the results of splitting.
 
2736
        # Saving time and objects. Also, use StaticTuple to avoid putting all
 
2737
        # of these object into python's garbage collector.
 
2738
        split_dirs = {}
 
2739
        def _key(entry, _split_dirs=split_dirs, _st=static_tuple.StaticTuple):
2508
2740
            # sort by: directory parts, file name, file id
2509
 
            return entry[0][0].split('/'), entry[0][1], entry[0][2]
 
2741
            dirpath, fname, file_id = entry[0]
 
2742
            try:
 
2743
                split = _split_dirs[dirpath]
 
2744
            except KeyError:
 
2745
                split = _st.from_sequence(dirpath.split('/'))
 
2746
                _split_dirs[dirpath] = split
 
2747
            return _st(split, fname, file_id)
2510
2748
        return sorted(entry_list, key=_key)
2511
2749
 
2512
2750
    def set_state_from_inventory(self, new_inv):
2637
2875
                        current_old[0][1].decode('utf8'))
2638
2876
                self._make_absent(current_old)
2639
2877
                current_old = advance(old_iterator)
2640
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2878
        self._mark_modified()
2641
2879
        self._id_index = None
2642
2880
        self._packed_stat_index = None
2643
2881
        if tracing:
2644
2882
            trace.mutter("set_state_from_inventory complete.")
2645
2883
 
 
2884
    def set_state_from_scratch(self, working_inv, parent_trees, parent_ghosts):
 
2885
        """Wipe the currently stored state and set it to something new.
 
2886
 
 
2887
        This is a hard-reset for the data we are working with.
 
2888
        """
 
2889
        # Technically, we really want a write lock, but until we write, we
 
2890
        # don't really need it.
 
2891
        self._requires_lock()
 
2892
        # root dir and root dir contents with no children. We have to have a
 
2893
        # root for set_state_from_inventory to work correctly.
 
2894
        empty_root = (('', '', inventory.ROOT_ID),
 
2895
                      [('d', '', 0, False, DirState.NULLSTAT)])
 
2896
        empty_tree_dirblocks = [('', [empty_root]), ('', [])]
 
2897
        self._set_data([], empty_tree_dirblocks)
 
2898
        self.set_state_from_inventory(working_inv)
 
2899
        self.set_parent_trees(parent_trees, parent_ghosts)
 
2900
 
2646
2901
    def _make_absent(self, current_old):
2647
2902
        """Mark current_old - an entry - as absent for tree 0.
2648
2903
 
2673
2928
            block[1].pop(entry_index)
2674
2929
            # if we have an id_index in use, remove this key from it for this id.
2675
2930
            if self._id_index is not None:
2676
 
                self._id_index[current_old[0][2]].remove(current_old[0])
 
2931
                self._remove_from_id_index(self._id_index, current_old[0])
2677
2932
        # update all remaining keys for this id to record it as absent. The
2678
2933
        # existing details may either be the record we are marking as deleted
2679
2934
        # (if there were other trees with the id present at this path), or may
2692
2947
            if update_tree_details[0][0] == 'a': # absent
2693
2948
                raise AssertionError('bad row %r' % (update_tree_details,))
2694
2949
            update_tree_details[0] = DirState.NULL_PARENT_DETAILS
2695
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2950
        self._mark_modified()
2696
2951
        return last_reference
2697
2952
 
2698
2953
    def update_minimal(self, key, minikind, executable=False, fingerprint='',
2740
2995
                            # This entry has the same path (but a different id) as
2741
2996
                            # the new entry we're adding, and is present in ths
2742
2997
                            # tree.
2743
 
                            raise errors.InconsistentDelta(
 
2998
                            self._raise_invalid(
2744
2999
                                ("%s/%s" % key[0:2]).decode('utf8'), key[2],
2745
3000
                                "Attempt to add item at path already occupied by "
2746
3001
                                "id %r" % entry[0][2])
2748
3003
                    else:
2749
3004
                        break
2750
3005
            # new entry, synthesis cross reference here,
2751
 
            existing_keys = id_index.setdefault(key[2], set())
 
3006
            existing_keys = id_index.get(key[2], ())
2752
3007
            if not existing_keys:
2753
3008
                # not currently in the state, simplest case
2754
3009
                new_entry = key, [new_details] + self._empty_parent_info()
2785
3040
                    # loop.
2786
3041
                    other_entry = other_block[other_entry_index]
2787
3042
                    other_entry[1][0] = ('r', path_utf8, 0, False, '')
2788
 
                    self._maybe_remove_row(other_block, other_entry_index,
2789
 
                        id_index)
 
3043
                    if self._maybe_remove_row(other_block, other_entry_index,
 
3044
                                              id_index):
 
3045
                        # If the row holding this was removed, we need to
 
3046
                        # recompute where this entry goes
 
3047
                        entry_index, _ = self._find_entry_index(key, block)
2790
3048
 
2791
3049
                # This loop:
2792
3050
                # adds a tuple to the new details for each column
2794
3052
                #  - or by creating a new pointer to the right row inside that column
2795
3053
                num_present_parents = self._num_present_parents()
2796
3054
                if num_present_parents:
 
3055
                    # TODO: This re-evaluates the existing_keys set, do we need
 
3056
                    #       to do that ourselves?
2797
3057
                    other_key = list(existing_keys)[0]
2798
3058
                for lookup_index in xrange(1, num_present_parents + 1):
2799
3059
                    # grab any one entry, use it to find the right path.
2818
3078
                        pointer_path = osutils.pathjoin(*other_key[0:2])
2819
3079
                        new_entry[1].append(('r', pointer_path, 0, False, ''))
2820
3080
            block.insert(entry_index, new_entry)
2821
 
            existing_keys.add(key)
 
3081
            self._add_to_id_index(id_index, key)
2822
3082
        else:
2823
3083
            # Does the new state matter?
2824
3084
            block[entry_index][1][0] = new_details
2833
3093
            # converted to relocated.
2834
3094
            if path_utf8 is None:
2835
3095
                raise AssertionError('no path')
2836
 
            for entry_key in id_index.setdefault(key[2], set()):
 
3096
            existing_keys = id_index.get(key[2], ())
 
3097
            if key not in existing_keys:
 
3098
                raise AssertionError('We found the entry in the blocks, but'
 
3099
                    ' the key is not in the id_index.'
 
3100
                    ' key: %s, existing_keys: %s' % (key, existing_keys))
 
3101
            for entry_key in existing_keys:
2837
3102
                # TODO:PROFILING: It might be faster to just update
2838
3103
                # rather than checking if we need to, and then overwrite
2839
3104
                # the one we are located at.
2857
3122
            if not present:
2858
3123
                self._dirblocks.insert(block_index, (subdir_key[0], []))
2859
3124
 
2860
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
3125
        self._mark_modified()
2861
3126
 
2862
3127
    def _maybe_remove_row(self, block, index, id_index):
2863
3128
        """Remove index if it is absent or relocated across the row.
2864
3129
        
2865
3130
        id_index is updated accordingly.
 
3131
        :return: True if we removed the row, False otherwise
2866
3132
        """
2867
3133
        present_in_row = False
2868
3134
        entry = block[index]
2872
3138
                break
2873
3139
        if not present_in_row:
2874
3140
            block.pop(index)
2875
 
            id_index[entry[0][2]].remove(entry[0])
 
3141
            self._remove_from_id_index(id_index, entry[0])
 
3142
            return True
 
3143
        return False
2876
3144
 
2877
3145
    def _validate(self):
2878
3146
        """Check that invariants on the dirblock are correct.
3020
3288
                        raise AssertionError(
3021
3289
                            'file_id %r did not match entry key %s'
3022
3290
                            % (file_id, entry_key))
 
3291
                if len(entry_keys) != len(set(entry_keys)):
 
3292
                    raise AssertionError(
 
3293
                        'id_index contained non-unique data for %s'
 
3294
                        % (entry_keys,))
3023
3295
 
3024
3296
    def _wipe_state(self):
3025
3297
        """Forget all state information about the dirstate."""
3082
3354
 
3083
3355
 
3084
3356
def py_update_entry(state, entry, abspath, stat_value,
3085
 
                 _stat_to_minikind=DirState._stat_to_minikind,
3086
 
                 _pack_stat=pack_stat):
 
3357
                 _stat_to_minikind=DirState._stat_to_minikind):
3087
3358
    """Update the entry based on what is actually on disk.
3088
3359
 
3089
3360
    This function only calculates the sha if it needs to - if the entry is
3102
3373
    except KeyError:
3103
3374
        # Unhandled kind
3104
3375
        return None
3105
 
    packed_stat = _pack_stat(stat_value)
 
3376
    packed_stat = pack_stat(stat_value)
3106
3377
    (saved_minikind, saved_link_or_sha1, saved_file_size,
3107
3378
     saved_executable, saved_packed_stat) = entry[1][0]
3108
3379
 
3122
3393
    # If we have gotten this far, that means that we need to actually
3123
3394
    # process this entry.
3124
3395
    link_or_sha1 = None
 
3396
    worth_saving = True
3125
3397
    if minikind == 'f':
3126
3398
        executable = state._is_executable(stat_value.st_mode,
3127
3399
                                         saved_executable)
3143
3415
        else:
3144
3416
            entry[1][0] = ('f', '', stat_value.st_size,
3145
3417
                           executable, DirState.NULLSTAT)
 
3418
            worth_saving = False
3146
3419
    elif minikind == 'd':
3147
3420
        link_or_sha1 = None
3148
3421
        entry[1][0] = ('d', '', 0, False, packed_stat)
3154
3427
                state._get_block_entry_index(entry[0][0], entry[0][1], 0)
3155
3428
            state._ensure_block(block_index, entry_index,
3156
3429
                               osutils.pathjoin(entry[0][0], entry[0][1]))
 
3430
        else:
 
3431
            worth_saving = False
3157
3432
    elif minikind == 'l':
 
3433
        if saved_minikind == 'l':
 
3434
            worth_saving = False
3158
3435
        link_or_sha1 = state._read_link(abspath, saved_link_or_sha1)
3159
3436
        if state._cutoff_time is None:
3160
3437
            state._sha_cutoff_time()
3165
3442
        else:
3166
3443
            entry[1][0] = ('l', '', stat_value.st_size,
3167
3444
                           False, DirState.NULLSTAT)
3168
 
    state._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
3445
    if worth_saving:
 
3446
        state._mark_modified([entry])
3169
3447
    return link_or_sha1
3170
3448
 
3171
3449
 
3480
3758
            raise AssertionError("don't know how to compare "
3481
3759
                "source_minikind=%r, target_minikind=%r"
3482
3760
                % (source_minikind, target_minikind))
3483
 
            ## import pdb;pdb.set_trace()
3484
3761
        return None, None
3485
3762
 
3486
3763
    def __iter__(self):
3975
4252
        _bisect_path_left,
3976
4253
        _bisect_path_right,
3977
4254
        cmp_by_dirs,
 
4255
        pack_stat,
3978
4256
        ProcessEntryC as _process_entry,
3979
4257
        update_entry as update_entry,
3980
4258
        )
3986
4264
        _bisect_path_left,
3987
4265
        _bisect_path_right,
3988
4266
        cmp_by_dirs,
 
4267
        pack_stat,
3989
4268
        )
3990
4269
    # FIXME: It would be nice to be able to track moved lines so that the
3991
4270
    # corresponding python code can be moved to the _dirstate_helpers_py