~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/dirstate.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006, 2007, 2008 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
233
from bzrlib 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,
224
244
    )
225
245
 
226
246
 
231
251
ERROR_DIRECTORY = 267
232
252
 
233
253
 
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
254
class SHA1Provider(object):
268
255
    """An interface for getting sha1s of a file."""
269
256
 
354
341
    NOT_IN_MEMORY = 0
355
342
    IN_MEMORY_UNMODIFIED = 1
356
343
    IN_MEMORY_MODIFIED = 2
 
344
    IN_MEMORY_HASH_MODIFIED = 3 # Only hash-cache updates
357
345
 
358
346
    # A pack_stat (the x's) that is just noise and will never match the output
359
347
    # of base64 encode.
360
348
    NULLSTAT = 'x' * 32
361
 
    NULL_PARENT_DETAILS = ('a', '', 0, False, '')
 
349
    NULL_PARENT_DETAILS = static_tuple.StaticTuple('a', '', 0, False, '')
362
350
 
363
351
    HEADER_FORMAT_2 = '#bazaar dirstate flat format 2\n'
364
352
    HEADER_FORMAT_3 = '#bazaar dirstate flat format 3\n'
365
353
 
366
 
    def __init__(self, path, sha1_provider):
 
354
    def __init__(self, path, sha1_provider, worth_saving_limit=0):
367
355
        """Create a  DirState object.
368
356
 
369
357
        :param path: The path at which the dirstate file on disk should live.
370
358
        :param sha1_provider: an object meeting the SHA1Provider interface.
 
359
        :param worth_saving_limit: when the exact number of hash changed
 
360
            entries is known, only bother saving the dirstate if more than
 
361
            this count of entries have changed.
 
362
            -1 means never save hash changes, 0 means always save hash changes.
371
363
        """
372
364
        # _header_state and _dirblock_state represent the current state
373
365
        # of the dirstate metadata and the per-row data respectiely.
410
402
        # during commit.
411
403
        self._last_block_index = None
412
404
        self._last_entry_index = None
 
405
        # The set of known hash changes
 
406
        self._known_hash_changes = set()
 
407
        # How many hash changed entries can we have without saving
 
408
        self._worth_saving_limit = worth_saving_limit
 
409
        self._config_stack = config.LocationStack(urlutils.local_path_to_url(
 
410
            path))
413
411
 
414
412
    def __repr__(self):
415
413
        return "%s(%r)" % \
416
414
            (self.__class__.__name__, self._filename)
417
415
 
 
416
    def _mark_modified(self, hash_changed_entries=None, header_modified=False):
 
417
        """Mark this dirstate as modified.
 
418
 
 
419
        :param hash_changed_entries: if non-None, mark just these entries as
 
420
            having their hash modified.
 
421
        :param header_modified: mark the header modified as well, not just the
 
422
            dirblocks.
 
423
        """
 
424
        #trace.mutter_callsite(3, "modified hash entries: %s", hash_changed_entries)
 
425
        if hash_changed_entries:
 
426
            self._known_hash_changes.update([e[0] for e in hash_changed_entries])
 
427
            if self._dirblock_state in (DirState.NOT_IN_MEMORY,
 
428
                                        DirState.IN_MEMORY_UNMODIFIED):
 
429
                # If the dirstate is already marked a IN_MEMORY_MODIFIED, then
 
430
                # that takes precedence.
 
431
                self._dirblock_state = DirState.IN_MEMORY_HASH_MODIFIED
 
432
        else:
 
433
            # TODO: Since we now have a IN_MEMORY_HASH_MODIFIED state, we
 
434
            #       should fail noisily if someone tries to set
 
435
            #       IN_MEMORY_MODIFIED but we don't have a write-lock!
 
436
            # We don't know exactly what changed so disable smart saving
 
437
            self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
438
        if header_modified:
 
439
            self._header_state = DirState.IN_MEMORY_MODIFIED
 
440
 
 
441
    def _mark_unmodified(self):
 
442
        """Mark this dirstate as unmodified."""
 
443
        self._header_state = DirState.IN_MEMORY_UNMODIFIED
 
444
        self._dirblock_state = DirState.IN_MEMORY_UNMODIFIED
 
445
        self._known_hash_changes = set()
 
446
 
418
447
    def add(self, path, file_id, kind, stat, fingerprint):
419
448
        """Add a path to be tracked.
420
449
 
546
575
        if kind == 'directory':
547
576
           # insert a new dirblock
548
577
           self._ensure_block(block_index, entry_index, utf8path)
549
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
578
        self._mark_modified()
550
579
        if self._id_index:
551
 
            self._id_index.setdefault(entry_key[2], set()).add(entry_key)
 
580
            self._add_to_id_index(self._id_index, entry_key)
552
581
 
553
582
    def _bisect(self, paths):
554
583
        """Bisect through the disk structure for specific rows.
1018
1047
 
1019
1048
        self._ghosts = []
1020
1049
        self._parents = [parents[0]]
1021
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1022
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
 
1050
        self._mark_modified(header_modified=True)
1023
1051
 
1024
1052
    def _empty_parent_info(self):
1025
1053
        return [DirState.NULL_PARENT_DETAILS] * (len(self._parents) -
1154
1182
    def _fields_per_entry(self):
1155
1183
        """How many null separated fields should be in each entry row.
1156
1184
 
1157
 
        Each line now has an extra '\n' field which is not used
 
1185
        Each line now has an extra '\\n' field which is not used
1158
1186
        so we just skip over it
1159
 
        entry size:
 
1187
 
 
1188
        entry size::
1160
1189
            3 fields for the key
1161
1190
            + number of fields per tree_data (5) * tree count
1162
1191
            + newline
1263
1292
                    parent_trees.append((parent_id, parent_tree))
1264
1293
                    parent_tree.lock_read()
1265
1294
                result.set_parent_trees(parent_trees, [])
1266
 
                result.set_state_from_inventory(tree.inventory)
 
1295
                result.set_state_from_inventory(tree.root_inventory)
1267
1296
            finally:
1268
1297
                for revid, parent_tree in parent_trees:
1269
1298
                    parent_tree.unlock()
1275
1304
            raise
1276
1305
        return result
1277
1306
 
 
1307
    def _check_delta_is_valid(self, delta):
 
1308
        return list(inventory._check_delta_unique_ids(
 
1309
                    inventory._check_delta_unique_old_paths(
 
1310
                    inventory._check_delta_unique_new_paths(
 
1311
                    inventory._check_delta_ids_match_entry(
 
1312
                    inventory._check_delta_ids_are_valid(
 
1313
                    inventory._check_delta_new_path_entry_both_or_None(delta)))))))
 
1314
 
1278
1315
    def update_by_delta(self, delta):
1279
1316
        """Apply an inventory delta to the dirstate for tree 0
1280
1317
 
1298
1335
        new_ids = set()
1299
1336
        # This loop transforms the delta to single atomic operations that can
1300
1337
        # 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):
 
1338
        delta = sorted(self._check_delta_is_valid(delta), reverse=True)
 
1339
        for old_path, new_path, file_id, inv_entry in delta:
1308
1340
            if (file_id in insertions) or (file_id in removals):
1309
 
                raise errors.InconsistentDelta(old_path or new_path, file_id,
 
1341
                self._raise_invalid(old_path or new_path, file_id,
1310
1342
                    "repeated file_id")
1311
1343
            if old_path is not None:
1312
1344
                old_path = old_path.encode('utf-8')
1315
1347
                new_ids.add(file_id)
1316
1348
            if new_path is not None:
1317
1349
                if inv_entry is None:
1318
 
                    raise errors.InconsistentDelta(new_path, file_id,
 
1350
                    self._raise_invalid(new_path, file_id,
1319
1351
                        "new_path with no entry")
1320
1352
                new_path = new_path.encode('utf-8')
1321
1353
                dirname_utf8, basename = osutils.split(new_path)
1324
1356
                key = (dirname_utf8, basename, file_id)
1325
1357
                minikind = DirState._kind_to_minikind[inv_entry.kind]
1326
1358
                if minikind == 't':
1327
 
                    fingerprint = inv_entry.reference_revision
 
1359
                    fingerprint = inv_entry.reference_revision or ''
1328
1360
                else:
1329
1361
                    fingerprint = ''
1330
1362
                insertions[file_id] = (key, minikind, inv_entry.executable,
1339
1371
                    minikind = child[1][0][0]
1340
1372
                    fingerprint = child[1][0][4]
1341
1373
                    executable = child[1][0][3]
1342
 
                    old_child_path = osutils.pathjoin(child[0][0],
1343
 
                                                      child[0][1])
 
1374
                    old_child_path = osutils.pathjoin(child_dirname,
 
1375
                                                      child_basename)
1344
1376
                    removals[child[0][2]] = old_child_path
1345
1377
                    child_suffix = child_dirname[len(old_path):]
1346
1378
                    new_child_dirname = (new_path + child_suffix)
1347
1379
                    key = (new_child_dirname, child_basename, child[0][2])
1348
 
                    new_child_path = os.path.join(new_child_dirname,
1349
 
                                                  child_basename)
 
1380
                    new_child_path = osutils.pathjoin(new_child_dirname,
 
1381
                                                      child_basename)
1350
1382
                    insertions[child[0][2]] = (key, minikind, executable,
1351
1383
                                               fingerprint, new_child_path)
1352
1384
        self._check_delta_ids_absent(new_ids, delta, 0)
1362
1394
            # _get_entry raises BzrError when a request is inconsistent; we
1363
1395
            # want such errors to be shown as InconsistentDelta - and that 
1364
1396
            # fits the behaviour we trigger.
1365
 
            raise errors.InconsistentDeltaDelta(delta, "error from _get_entry.")
 
1397
            raise errors.InconsistentDeltaDelta(delta,
 
1398
                "error from _get_entry. %s" % (e,))
1366
1399
 
1367
1400
    def _apply_removals(self, removals):
1368
1401
        for file_id, path in sorted(removals, reverse=True,
1373
1406
            try:
1374
1407
                entry = self._dirblocks[block_i][1][entry_i]
1375
1408
            except IndexError:
1376
 
                self._changes_aborted = True
1377
 
                raise errors.InconsistentDelta(path, file_id,
 
1409
                self._raise_invalid(path, file_id,
1378
1410
                    "Wrong path for old path.")
1379
1411
            if not f_present or entry[1][0][0] in 'ar':
1380
 
                self._changes_aborted = True
1381
 
                raise errors.InconsistentDelta(path, file_id,
 
1412
                self._raise_invalid(path, file_id,
1382
1413
                    "Wrong path for old path.")
1383
1414
            if file_id != entry[0][2]:
1384
 
                self._changes_aborted = True
1385
 
                raise errors.InconsistentDelta(path, file_id,
 
1415
                self._raise_invalid(path, file_id,
1386
1416
                    "Attempt to remove path has wrong id - found %r."
1387
1417
                    % entry[0][2])
1388
1418
            self._make_absent(entry)
1398
1428
                # be due to it being in a parent tree, or a corrupt delta.
1399
1429
                for child_entry in self._dirblocks[block_i][1]:
1400
1430
                    if child_entry[1][0][0] not in ('r', 'a'):
1401
 
                        self._changes_aborted = True
1402
 
                        raise errors.InconsistentDelta(path, entry[0][2],
 
1431
                        self._raise_invalid(path, entry[0][2],
1403
1432
                            "The file id was deleted but its children were "
1404
1433
                            "not deleted.")
1405
1434
 
1409
1438
                self.update_minimal(key, minikind, executable, fingerprint,
1410
1439
                                    path_utf8=path_utf8)
1411
1440
        except errors.NotVersionedError:
1412
 
            self._changes_aborted = True
1413
 
            raise errors.InconsistentDelta(path_utf8.decode('utf8'), key[2],
 
1441
            self._raise_invalid(path_utf8.decode('utf8'), key[2],
1414
1442
                "Missing parent")
1415
1443
 
1416
1444
    def update_basis_by_delta(self, delta, new_revid):
1424
1452
        Note that an exception during the operation of this method will leave
1425
1453
        the dirstate in a corrupt state where it should not be saved.
1426
1454
 
1427
 
        Finally, we expect all changes to be synchronising the basis tree with
1428
 
        the working tree.
1429
 
 
1430
1455
        :param new_revid: The new revision id for the trees parent.
1431
1456
        :param delta: An inventory delta (see apply_inventory_delta) describing
1432
1457
            the changes from the current left most parent revision to new_revid.
1444
1469
 
1445
1470
        self._parents[0] = new_revid
1446
1471
 
1447
 
        delta = sorted(delta, reverse=True)
 
1472
        delta = sorted(self._check_delta_is_valid(delta), reverse=True)
1448
1473
        adds = []
1449
1474
        changes = []
1450
1475
        deletes = []
1471
1496
        new_ids = set()
1472
1497
        for old_path, new_path, file_id, inv_entry in delta:
1473
1498
            if inv_entry is not None and file_id != inv_entry.file_id:
1474
 
                raise errors.InconsistentDelta(new_path, file_id,
 
1499
                self._raise_invalid(new_path, file_id,
1475
1500
                    "mismatched entry file_id %r" % inv_entry)
1476
 
            if new_path is not None:
 
1501
            if new_path is None:
 
1502
                new_path_utf8 = None
 
1503
            else:
1477
1504
                if inv_entry is None:
1478
 
                    raise errors.InconsistentDelta(new_path, file_id,
 
1505
                    self._raise_invalid(new_path, file_id,
1479
1506
                        "new_path with no entry")
1480
1507
                new_path_utf8 = encode(new_path)
1481
1508
                # note the parent for validation
1483
1510
                if basename_utf8:
1484
1511
                    parents.add((dirname_utf8, inv_entry.parent_id))
1485
1512
            if old_path is None:
1486
 
                adds.append((None, encode(new_path), file_id,
 
1513
                old_path_utf8 = None
 
1514
            else:
 
1515
                old_path_utf8 = encode(old_path)
 
1516
            if old_path is None:
 
1517
                adds.append((None, new_path_utf8, file_id,
1487
1518
                    inv_to_entry(inv_entry), True))
1488
1519
                new_ids.add(file_id)
1489
1520
            elif new_path is None:
1490
 
                deletes.append((encode(old_path), None, file_id, None, True))
1491
 
            elif (old_path, new_path) != root_only:
 
1521
                deletes.append((old_path_utf8, None, file_id, None, True))
 
1522
            elif (old_path, new_path) == root_only:
 
1523
                # change things in-place
 
1524
                # Note: the case of a parent directory changing its file_id
 
1525
                #       tends to break optimizations here, because officially
 
1526
                #       the file has actually been moved, it just happens to
 
1527
                #       end up at the same path. If we can figure out how to
 
1528
                #       handle that case, we can avoid a lot of add+delete
 
1529
                #       pairs for objects that stay put.
 
1530
                # elif old_path == new_path:
 
1531
                changes.append((old_path_utf8, new_path_utf8, file_id,
 
1532
                                inv_to_entry(inv_entry)))
 
1533
            else:
1492
1534
                # Renames:
1493
1535
                # Because renames must preserve their children we must have
1494
1536
                # processed all relocations and removes before hand. The sort
1504
1546
                self._update_basis_apply_deletes(deletes)
1505
1547
                deletes = []
1506
1548
                # Split into an add/delete pair recursively.
1507
 
                adds.append((None, new_path_utf8, file_id,
1508
 
                    inv_to_entry(inv_entry), False))
 
1549
                adds.append((old_path_utf8, new_path_utf8, file_id,
 
1550
                             inv_to_entry(inv_entry), False))
1509
1551
                # Expunge deletes that we've seen so that deleted/renamed
1510
1552
                # children of a rename directory are handled correctly.
1511
 
                new_deletes = reversed(list(self._iter_child_entries(1,
1512
 
                    encode(old_path))))
 
1553
                new_deletes = reversed(list(
 
1554
                    self._iter_child_entries(1, old_path_utf8)))
1513
1555
                # Remove the current contents of the tree at orig_path, and
1514
1556
                # reinsert at the correct new path.
1515
1557
                for entry in new_deletes:
1516
 
                    if entry[0][0]:
1517
 
                        source_path = entry[0][0] + '/' + entry[0][1]
 
1558
                    child_dirname, child_basename, child_file_id = entry[0]
 
1559
                    if child_dirname:
 
1560
                        source_path = child_dirname + '/' + child_basename
1518
1561
                    else:
1519
 
                        source_path = entry[0][1]
 
1562
                        source_path = child_basename
1520
1563
                    if new_path_utf8:
1521
 
                        target_path = new_path_utf8 + source_path[len(old_path):]
 
1564
                        target_path = \
 
1565
                            new_path_utf8 + source_path[len(old_path_utf8):]
1522
1566
                    else:
1523
 
                        if old_path == '':
 
1567
                        if old_path_utf8 == '':
1524
1568
                            raise AssertionError("cannot rename directory to"
1525
 
                                " itself")
1526
 
                        target_path = source_path[len(old_path) + 1:]
 
1569
                                                 " itself")
 
1570
                        target_path = source_path[len(old_path_utf8) + 1:]
1527
1571
                    adds.append((None, target_path, entry[0][2], entry[1][1], False))
1528
1572
                    deletes.append(
1529
1573
                        (source_path, target_path, entry[0][2], None, False))
1530
1574
                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
                    (old_path_utf8, new_path_utf8, file_id, None, False))
 
1576
 
1537
1577
        self._check_delta_ids_absent(new_ids, delta, 1)
1538
1578
        try:
1539
1579
            # Finish expunging deletes/first half of renames.
1549
1589
            if 'integrity error' not in str(e):
1550
1590
                raise
1551
1591
            # _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.")
 
1592
            # want such errors to be shown as InconsistentDelta - and that
 
1593
            # fits the behaviour we trigger.
 
1594
            raise errors.InconsistentDeltaDelta(delta,
 
1595
                "error from _get_entry. %s" % (e,))
1557
1596
 
1558
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1559
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
 
1597
        self._mark_modified(header_modified=True)
1560
1598
        self._id_index = None
1561
1599
        return
1562
1600
 
1566
1604
            return
1567
1605
        id_index = self._get_id_index()
1568
1606
        for file_id in new_ids:
1569
 
            for key in id_index.get(file_id, []):
 
1607
            for key in id_index.get(file_id, ()):
1570
1608
                block_i, entry_i, d_present, f_present = \
1571
1609
                    self._get_block_entry_index(key[0], key[1], tree_index)
1572
1610
                if not f_present:
1576
1614
                if entry[0][2] != file_id:
1577
1615
                    # Different file_id, so not what we want.
1578
1616
                    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,
 
1617
                self._raise_invalid(("%s/%s" % key[0:2]).decode('utf8'), file_id,
1583
1618
                    "This file_id is new in the delta but already present in "
1584
1619
                    "the target")
1585
1620
 
 
1621
    def _raise_invalid(self, path, file_id, reason):
 
1622
        self._changes_aborted = True
 
1623
        raise errors.InconsistentDelta(path, file_id, reason)
 
1624
 
1586
1625
    def _update_basis_apply_adds(self, adds):
1587
1626
        """Apply a sequence of adds to tree 1 during update_basis_by_delta.
1588
1627
 
1596
1635
        """
1597
1636
        # Adds are accumulated partly from renames, so can be in any input
1598
1637
        # order - sort it.
1599
 
        adds.sort()
 
1638
        # TODO: we may want to sort in dirblocks order. That way each entry
 
1639
        #       will end up in the same directory, allowing the _get_entry
 
1640
        #       fast-path for looking up 2 items in the same dir work.
 
1641
        adds.sort(key=lambda x: x[1])
1600
1642
        # adds is now in lexographic order, which places all parents before
1601
1643
        # their children, so we can process it linearly.
1602
1644
        absent = 'ar'
 
1645
        st = static_tuple.StaticTuple
1603
1646
        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
 
1647
            dirname, basename = osutils.split(new_path)
 
1648
            entry_key = st(dirname, basename, file_id)
 
1649
            block_index, present = self._find_block_index_from_key(entry_key)
 
1650
            if not present:
 
1651
                # The block where we want to put the file is not present.
 
1652
                # However, it might have just been an empty directory. Look for
 
1653
                # the parent in the basis-so-far before throwing an error.
 
1654
                parent_dir, parent_base = osutils.split(dirname)
 
1655
                parent_block_idx, parent_entry_idx, _, parent_present = \
 
1656
                    self._get_block_entry_index(parent_dir, parent_base, 1)
 
1657
                if not parent_present:
 
1658
                    self._raise_invalid(new_path, file_id,
 
1659
                        "Unable to find block for this record."
 
1660
                        " Was the parent added?")
 
1661
                self._ensure_block(parent_block_idx, parent_entry_idx, dirname)
 
1662
 
 
1663
            block = self._dirblocks[block_index][1]
 
1664
            entry_index, present = self._find_entry_index(entry_key, block)
 
1665
            if real_add:
 
1666
                if old_path is not None:
 
1667
                    self._raise_invalid(new_path, file_id,
 
1668
                        'considered a real add but still had old_path at %s'
 
1669
                        % (old_path,))
 
1670
            if present:
 
1671
                entry = block[entry_index]
 
1672
                basis_kind = entry[1][1][0]
 
1673
                if basis_kind == 'a':
 
1674
                    entry[1][1] = new_details
 
1675
                elif basis_kind == 'r':
 
1676
                    raise NotImplementedError()
 
1677
                else:
 
1678
                    self._raise_invalid(new_path, file_id,
 
1679
                        "An entry was marked as a new add"
 
1680
                        " but the basis target already existed")
 
1681
            else:
 
1682
                # The exact key was not found in the block. However, we need to
 
1683
                # check if there is a key next to us that would have matched.
 
1684
                # We only need to check 2 locations, because there are only 2
 
1685
                # trees present.
 
1686
                for maybe_index in range(entry_index-1, entry_index+1):
 
1687
                    if maybe_index < 0 or maybe_index >= len(block):
 
1688
                        continue
 
1689
                    maybe_entry = block[maybe_index]
 
1690
                    if maybe_entry[0][:2] != (dirname, basename):
 
1691
                        # Just a random neighbor
 
1692
                        continue
 
1693
                    if maybe_entry[0][2] == file_id:
 
1694
                        raise AssertionError(
 
1695
                            '_find_entry_index didnt find a key match'
 
1696
                            ' but walking the data did, for %s'
 
1697
                            % (entry_key,))
 
1698
                    basis_kind = maybe_entry[1][1][0]
 
1699
                    if basis_kind not in 'ar':
 
1700
                        self._raise_invalid(new_path, file_id,
 
1701
                            "we have an add record for path, but the path"
 
1702
                            " is already present with another file_id %s"
 
1703
                            % (maybe_entry[0][2],))
 
1704
 
 
1705
                entry = (entry_key, [DirState.NULL_PARENT_DETAILS,
 
1706
                                     new_details])
 
1707
                block.insert(entry_index, entry)
 
1708
 
 
1709
            active_kind = entry[1][0][0]
 
1710
            if active_kind == 'a':
 
1711
                # The active record shows up as absent, this could be genuine,
 
1712
                # or it could be present at some other location. We need to
 
1713
                # verify.
 
1714
                id_index = self._get_id_index()
 
1715
                # The id_index may not be perfectly accurate for tree1, because
 
1716
                # we haven't been keeping it updated. However, it should be
 
1717
                # fine for tree0, and that gives us enough info for what we
 
1718
                # need
 
1719
                keys = id_index.get(file_id, ())
 
1720
                for key in keys:
 
1721
                    block_i, entry_i, d_present, f_present = \
 
1722
                        self._get_block_entry_index(key[0], key[1], 0)
 
1723
                    if not f_present:
 
1724
                        continue
 
1725
                    active_entry = self._dirblocks[block_i][1][entry_i]
 
1726
                    if (active_entry[0][2] != file_id):
 
1727
                        # Some other file is at this path, we don't need to
 
1728
                        # link it.
 
1729
                        continue
 
1730
                    real_active_kind = active_entry[1][0][0]
 
1731
                    if real_active_kind in 'ar':
 
1732
                        # We found a record, which was not *this* record,
 
1733
                        # which matches the file_id, but is not actually
 
1734
                        # present. Something seems *really* wrong.
 
1735
                        self._raise_invalid(new_path, file_id,
 
1736
                            "We found a tree0 entry that doesnt make sense")
 
1737
                    # Now, we've found a tree0 entry which matches the file_id
 
1738
                    # but is at a different location. So update them to be
 
1739
                    # rename records.
 
1740
                    active_dir, active_name = active_entry[0][:2]
 
1741
                    if active_dir:
 
1742
                        active_path = active_dir + '/' + active_name
 
1743
                    else:
 
1744
                        active_path = active_name
 
1745
                    active_entry[1][1] = st('r', new_path, 0, False, '')
 
1746
                    entry[1][0] = st('r', active_path, 0, False, '')
 
1747
            elif active_kind == 'r':
 
1748
                raise NotImplementedError()
 
1749
 
 
1750
            new_kind = new_details[0]
 
1751
            if new_kind == 'd':
 
1752
                self._ensure_block(block_index, entry_index, new_path)
1619
1753
 
1620
1754
    def _update_basis_apply_changes(self, changes):
1621
1755
        """Apply a sequence of changes to tree 1 during update_basis_by_delta.
1626
1760
        absent = 'ar'
1627
1761
        for old_path, new_path, file_id, new_details in changes:
1628
1762
            # 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')
 
1763
            entry = self._get_entry(1, file_id, new_path)
 
1764
            if entry[0] is None or entry[1][1][0] in 'ar':
 
1765
                self._raise_invalid(new_path, file_id,
 
1766
                    'changed entry considered not present')
1639
1767
            entry[1][1] = new_details
1640
1768
 
1641
1769
    def _update_basis_apply_deletes(self, deletes):
1653
1781
        null = DirState.NULL_PARENT_DETAILS
1654
1782
        for old_path, new_path, file_id, _, real_delete in deletes:
1655
1783
            if real_delete != (new_path is None):
1656
 
                self._changes_aborted = True
1657
 
                raise AssertionError("bad delete delta")
 
1784
                self._raise_invalid(old_path, file_id, "bad delete delta")
1658
1785
            # the entry for this file_id must be in tree 1.
1659
1786
            dirname, basename = osutils.split(old_path)
1660
1787
            block_index, entry_index, dir_present, file_present = \
1661
1788
                self._get_block_entry_index(dirname, basename, 1)
1662
1789
            if not file_present:
1663
 
                self._changes_aborted = True
1664
 
                raise errors.InconsistentDelta(old_path, file_id,
 
1790
                self._raise_invalid(old_path, file_id,
1665
1791
                    'basis tree does not contain removed entry')
1666
1792
            entry = self._dirblocks[block_index][1][entry_index]
 
1793
            # The state of the entry in the 'active' WT
 
1794
            active_kind = entry[1][0][0]
1667
1795
            if entry[0][2] != file_id:
1668
 
                self._changes_aborted = True
1669
 
                raise errors.InconsistentDelta(old_path, file_id,
 
1796
                self._raise_invalid(old_path, file_id,
1670
1797
                    '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.')
 
1798
            dir_block = ()
 
1799
            old_kind = entry[1][1][0]
 
1800
            if active_kind in 'ar':
 
1801
                # The active tree doesn't have this file_id.
 
1802
                # The basis tree is changing this record. If this is a
 
1803
                # rename, then we don't want the record here at all
 
1804
                # anymore. If it is just an in-place change, we want the
 
1805
                # record here, but we'll add it if we need to. So we just
 
1806
                # delete it
 
1807
                if active_kind == 'r':
 
1808
                    active_path = entry[1][0][1]
 
1809
                    active_entry = self._get_entry(0, file_id, active_path)
 
1810
                    if active_entry[1][1][0] != 'r':
 
1811
                        self._raise_invalid(old_path, file_id,
 
1812
                            "Dirstate did not have matching rename entries")
 
1813
                    elif active_entry[1][0][0] in 'ar':
 
1814
                        self._raise_invalid(old_path, file_id,
 
1815
                            "Dirstate had a rename pointing at an inactive"
 
1816
                            " tree0")
 
1817
                    active_entry[1][1] = null
1677
1818
                del self._dirblocks[block_index][1][entry_index]
 
1819
                if old_kind == 'd':
 
1820
                    # This was a directory, and the active tree says it
 
1821
                    # doesn't exist, and now the basis tree says it doesn't
 
1822
                    # exist. Remove its dirblock if present
 
1823
                    (dir_block_index,
 
1824
                     present) = self._find_block_index_from_key(
 
1825
                        (old_path, '', ''))
 
1826
                    if present:
 
1827
                        dir_block = self._dirblocks[dir_block_index][1]
 
1828
                        if not dir_block:
 
1829
                            # This entry is empty, go ahead and just remove it
 
1830
                            del self._dirblocks[dir_block_index]
1678
1831
            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
 
1832
                # There is still an active record, so just mark this
 
1833
                # removed.
 
1834
                entry[1][1] = null
 
1835
                block_i, entry_i, d_present, f_present = \
 
1836
                    self._get_block_entry_index(old_path, '', 1)
 
1837
                if d_present:
 
1838
                    dir_block = self._dirblocks[block_i][1]
 
1839
            for child_entry in dir_block:
 
1840
                child_basis_kind = child_entry[1][1][0]
 
1841
                if child_basis_kind not in 'ar':
 
1842
                    self._raise_invalid(old_path, file_id,
 
1843
                        "The file id was deleted but its children were "
 
1844
                        "not deleted.")
1694
1845
 
1695
1846
    def _after_delta_check_parents(self, parents, index):
1696
1847
        """Check that parents required by the delta are all intact.
1705
1856
            # has the right file id.
1706
1857
            entry = self._get_entry(index, file_id, dirname_utf8)
1707
1858
            if entry[1] is None:
1708
 
                self._changes_aborted = True
1709
 
                raise errors.InconsistentDelta(dirname_utf8.decode('utf8'),
 
1859
                self._raise_invalid(dirname_utf8.decode('utf8'),
1710
1860
                    file_id, "This parent is not present.")
1711
1861
            # Parents of things must be directories
1712
1862
            if entry[1][index][0] != 'd':
1713
 
                self._changes_aborted = True
1714
 
                raise errors.InconsistentDelta(dirname_utf8.decode('utf8'),
 
1863
                self._raise_invalid(dirname_utf8.decode('utf8'),
1715
1864
                    file_id, "This parent is not a directory.")
1716
1865
 
1717
1866
    def _observed_sha1(self, entry, sha1, stat_value,
1718
 
        _stat_to_minikind=_stat_to_minikind, _pack_stat=pack_stat):
 
1867
        _stat_to_minikind=_stat_to_minikind):
1719
1868
        """Note the sha1 of a file.
1720
1869
 
1721
1870
        :param entry: The entry the sha1 is for.
1727
1876
        except KeyError:
1728
1877
            # Unhandled kind
1729
1878
            return None
1730
 
        packed_stat = _pack_stat(stat_value)
1731
1879
        if minikind == 'f':
1732
1880
            if self._cutoff_time is None:
1733
1881
                self._sha_cutoff_time()
1734
1882
            if (stat_value.st_mtime < self._cutoff_time
1735
1883
                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
 
1884
                entry[1][0] = ('f', sha1, stat_value.st_size, entry[1][0][3],
 
1885
                               pack_stat(stat_value))
 
1886
                self._mark_modified([entry])
1739
1887
 
1740
1888
    def _sha_cutoff_time(self):
1741
1889
        """Return cutoff time.
1785
1933
            # paths are produced by UnicodeDirReader on purpose.
1786
1934
            abspath = abspath.encode(fs_encoding)
1787
1935
        target = os.readlink(abspath)
1788
 
        if fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1936
        if fs_encoding not in ('utf-8', 'ascii'):
1789
1937
            # Change encoding if needed
1790
1938
            target = target.decode(fs_encoding).encode('UTF-8')
1791
1939
        return target
1799
1947
        """Serialise the entire dirstate to a sequence of lines."""
1800
1948
        if (self._header_state == DirState.IN_MEMORY_UNMODIFIED and
1801
1949
            self._dirblock_state == DirState.IN_MEMORY_UNMODIFIED):
1802
 
            # read whats on disk.
 
1950
            # read what's on disk.
1803
1951
            self._state_file.seek(0)
1804
1952
            return self._state_file.readlines()
1805
1953
        lines = []
1806
1954
        lines.append(self._get_parents_line(self.get_parent_ids()))
1807
1955
        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()))
 
1956
        lines.extend(self._get_entry_lines())
1810
1957
        return self._get_output_lines(lines)
1811
1958
 
1812
1959
    def _get_ghosts_line(self, ghost_ids):
1817
1964
        """Create a line for the state file for parents information."""
1818
1965
        return '\0'.join([str(len(parent_ids))] + parent_ids)
1819
1966
 
 
1967
    def _get_entry_lines(self):
 
1968
        """Create lines for entries."""
 
1969
        return map(self._entry_to_line, self._iter_entries())
 
1970
 
1820
1971
    def _get_fields_to_entry(self):
1821
1972
        """Get a function which converts entry fields into a entry record.
1822
1973
 
1940
2091
            entry_index += 1
1941
2092
        return block_index, entry_index, True, False
1942
2093
 
1943
 
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None, include_deleted=False):
 
2094
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None,
 
2095
                   include_deleted=False):
1944
2096
        """Get the dirstate entry for path in tree tree_index.
1945
2097
 
1946
2098
        If either file_id or path is supplied, it is used as the key to lookup.
1980
2132
                                          ' tree_index, file_id and path')
1981
2133
            return entry
1982
2134
        else:
1983
 
            possible_keys = self._get_id_index().get(fileid_utf8, None)
 
2135
            possible_keys = self._get_id_index().get(fileid_utf8, ())
1984
2136
            if not possible_keys:
1985
2137
                return None, None
1986
2138
            for key in possible_keys:
1997
2149
                entry_index, present = self._find_entry_index(key, block)
1998
2150
                if present:
1999
2151
                    entry = self._dirblocks[block_index][1][entry_index]
 
2152
                    # TODO: We might want to assert that entry[0][2] ==
 
2153
                    #       fileid_utf8.
2000
2154
                    if entry[1][tree_index][0] in 'fdlt':
2001
2155
                        # this is the result we are looking for: the
2002
2156
                        # real home of this file_id in this tree.
2086
2240
            executable = False
2087
2241
        else:
2088
2242
            raise Exception("can't pack %s" % inv_entry)
2089
 
        return (minikind, fingerprint, size, executable, tree_data)
 
2243
        return static_tuple.StaticTuple(minikind, fingerprint, size,
 
2244
                                        executable, tree_data)
2090
2245
 
2091
2246
    def _iter_child_entries(self, tree_index, path_utf8):
2092
2247
        """Iterate over all the entries that are children of path_utf.
2141
2296
                yield entry
2142
2297
 
2143
2298
    def _get_id_index(self):
2144
 
        """Get an id index of self._dirblocks."""
 
2299
        """Get an id index of self._dirblocks.
 
2300
 
 
2301
        This maps from file_id => [(directory, name, file_id)] entries where
 
2302
        that file_id appears in one of the trees.
 
2303
        """
2145
2304
        if self._id_index is None:
2146
2305
            id_index = {}
2147
2306
            for key, tree_details in self._iter_entries():
2148
 
                id_index.setdefault(key[2], set()).add(key)
 
2307
                self._add_to_id_index(id_index, key)
2149
2308
            self._id_index = id_index
2150
2309
        return self._id_index
2151
2310
 
 
2311
    def _add_to_id_index(self, id_index, entry_key):
 
2312
        """Add this entry to the _id_index mapping."""
 
2313
        # This code used to use a set for every entry in the id_index. However,
 
2314
        # it is *rare* to have more than one entry. So a set is a large
 
2315
        # overkill. And even when we do, we won't ever have more than the
 
2316
        # number of parent trees. Which is still a small number (rarely >2). As
 
2317
        # such, we use a simple tuple, and do our own uniqueness checks. While
 
2318
        # the 'in' check is O(N) since N is nicely bounded it shouldn't ever
 
2319
        # cause quadratic failure.
 
2320
        file_id = entry_key[2]
 
2321
        entry_key = static_tuple.StaticTuple.from_sequence(entry_key)
 
2322
        if file_id not in id_index:
 
2323
            id_index[file_id] = static_tuple.StaticTuple(entry_key,)
 
2324
        else:
 
2325
            entry_keys = id_index[file_id]
 
2326
            if entry_key not in entry_keys:
 
2327
                id_index[file_id] = entry_keys + (entry_key,)
 
2328
 
 
2329
    def _remove_from_id_index(self, id_index, entry_key):
 
2330
        """Remove this entry from the _id_index mapping.
 
2331
 
 
2332
        It is an programming error to call this when the entry_key is not
 
2333
        already present.
 
2334
        """
 
2335
        file_id = entry_key[2]
 
2336
        entry_keys = list(id_index[file_id])
 
2337
        entry_keys.remove(entry_key)
 
2338
        id_index[file_id] = static_tuple.StaticTuple.from_sequence(entry_keys)
 
2339
 
2152
2340
    def _get_output_lines(self, lines):
2153
2341
        """Format lines for final output.
2154
2342
 
2174
2362
        """The number of parent entries in each record row."""
2175
2363
        return len(self._parents) - len(self._ghosts)
2176
2364
 
2177
 
    @staticmethod
2178
 
    def on_file(path, sha1_provider=None):
 
2365
    @classmethod
 
2366
    def on_file(cls, path, sha1_provider=None, worth_saving_limit=0):
2179
2367
        """Construct a DirState on the file at path "path".
2180
2368
 
2181
2369
        :param path: The path at which the dirstate file on disk should live.
2182
2370
        :param sha1_provider: an object meeting the SHA1Provider interface.
2183
2371
            If None, a DefaultSHA1Provider is used.
 
2372
        :param worth_saving_limit: when the exact number of hash changed
 
2373
            entries is known, only bother saving the dirstate if more than
 
2374
            this count of entries have changed. -1 means never save.
2184
2375
        :return: An unlocked DirState object, associated with the given path.
2185
2376
        """
2186
2377
        if sha1_provider is None:
2187
2378
            sha1_provider = DefaultSHA1Provider()
2188
 
        result = DirState(path, sha1_provider)
 
2379
        result = cls(path, sha1_provider,
 
2380
                     worth_saving_limit=worth_saving_limit)
2189
2381
        return result
2190
2382
 
2191
2383
    def _read_dirblocks_if_needed(self):
2249
2441
            raise errors.BzrError('missing num_entries line')
2250
2442
        self._num_entries = int(num_entries_line[len('num_entries: '):-1])
2251
2443
 
2252
 
    def sha1_from_stat(self, path, stat_result, _pack_stat=pack_stat):
 
2444
    def sha1_from_stat(self, path, stat_result):
2253
2445
        """Find a sha1 given a stat lookup."""
2254
 
        return self._get_packed_stat_index().get(_pack_stat(stat_result), None)
 
2446
        return self._get_packed_stat_index().get(pack_stat(stat_result), None)
2255
2447
 
2256
2448
    def _get_packed_stat_index(self):
2257
2449
        """Get a packed_stat index of self._dirblocks."""
2283
2475
            trace.mutter('Not saving DirState because '
2284
2476
                    '_changes_aborted is set.')
2285
2477
            return
2286
 
        if (self._header_state == DirState.IN_MEMORY_MODIFIED or
2287
 
            self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
 
2478
        # TODO: Since we now distinguish IN_MEMORY_MODIFIED from
 
2479
        #       IN_MEMORY_HASH_MODIFIED, we should only fail quietly if we fail
 
2480
        #       to save an IN_MEMORY_HASH_MODIFIED, and fail *noisily* if we
 
2481
        #       fail to save IN_MEMORY_MODIFIED
 
2482
        if not self._worth_saving():
 
2483
            return
2288
2484
 
2289
 
            grabbed_write_lock = False
2290
 
            if self._lock_state != 'w':
2291
 
                grabbed_write_lock, new_lock = self._lock_token.temporary_write_lock()
2292
 
                # Switch over to the new lock, as the old one may be closed.
 
2485
        grabbed_write_lock = False
 
2486
        if self._lock_state != 'w':
 
2487
            grabbed_write_lock, new_lock = self._lock_token.temporary_write_lock()
 
2488
            # Switch over to the new lock, as the old one may be closed.
 
2489
            # TODO: jam 20070315 We should validate the disk file has
 
2490
            #       not changed contents, since temporary_write_lock may
 
2491
            #       not be an atomic operation.
 
2492
            self._lock_token = new_lock
 
2493
            self._state_file = new_lock.f
 
2494
            if not grabbed_write_lock:
 
2495
                # We couldn't grab a write lock, so we switch back to a read one
 
2496
                return
 
2497
        try:
 
2498
            lines = self.get_lines()
 
2499
            self._state_file.seek(0)
 
2500
            self._state_file.writelines(lines)
 
2501
            self._state_file.truncate()
 
2502
            self._state_file.flush()
 
2503
            self._maybe_fdatasync()
 
2504
            self._mark_unmodified()
 
2505
        finally:
 
2506
            if grabbed_write_lock:
 
2507
                self._lock_token = self._lock_token.restore_read_lock()
 
2508
                self._state_file = self._lock_token.f
2293
2509
                # TODO: jam 20070315 We should validate the disk file has
2294
 
                #       not changed contents. Since temporary_write_lock may
2295
 
                #       not be an atomic operation.
2296
 
                self._lock_token = new_lock
2297
 
                self._state_file = new_lock.f
2298
 
                if not grabbed_write_lock:
2299
 
                    # We couldn't grab a write lock, so we switch back to a read one
2300
 
                    return
2301
 
            try:
2302
 
                self._state_file.seek(0)
2303
 
                self._state_file.writelines(self.get_lines())
2304
 
                self._state_file.truncate()
2305
 
                self._state_file.flush()
2306
 
                self._header_state = DirState.IN_MEMORY_UNMODIFIED
2307
 
                self._dirblock_state = DirState.IN_MEMORY_UNMODIFIED
2308
 
            finally:
2309
 
                if grabbed_write_lock:
2310
 
                    self._lock_token = self._lock_token.restore_read_lock()
2311
 
                    self._state_file = self._lock_token.f
2312
 
                    # TODO: jam 20070315 We should validate the disk file has
2313
 
                    #       not changed contents. Since restore_read_lock may
2314
 
                    #       not be an atomic operation.
 
2510
                #       not changed contents. Since restore_read_lock may
 
2511
                #       not be an atomic operation.                
 
2512
 
 
2513
    def _maybe_fdatasync(self):
 
2514
        """Flush to disk if possible and if not configured off."""
 
2515
        if self._config_stack.get('dirstate.fdatasync'):
 
2516
            osutils.fdatasync(self._state_file.fileno())
 
2517
 
 
2518
    def _worth_saving(self):
 
2519
        """Is it worth saving the dirstate or not?"""
 
2520
        if (self._header_state == DirState.IN_MEMORY_MODIFIED
 
2521
            or self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
 
2522
            return True
 
2523
        if self._dirblock_state == DirState.IN_MEMORY_HASH_MODIFIED:
 
2524
            if self._worth_saving_limit == -1:
 
2525
                # We never save hash changes when the limit is -1
 
2526
                return False
 
2527
            # If we're using smart saving and only a small number of
 
2528
            # entries have changed their hash, don't bother saving. John has
 
2529
            # suggested using a heuristic here based on the size of the
 
2530
            # changed files and/or tree. For now, we go with a configurable
 
2531
            # number of changes, keeping the calculation time
 
2532
            # as low overhead as possible. (This also keeps all existing
 
2533
            # tests passing as the default is 0, i.e. always save.)
 
2534
            if len(self._known_hash_changes) >= self._worth_saving_limit:
 
2535
                return True
 
2536
        return False
2315
2537
 
2316
2538
    def _set_data(self, parent_ids, dirblocks):
2317
2539
        """Set the full dirstate data in memory.
2326
2548
        """
2327
2549
        # our memory copy is now authoritative.
2328
2550
        self._dirblocks = dirblocks
2329
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
2330
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2551
        self._mark_modified(header_modified=True)
2331
2552
        self._parents = list(parent_ids)
2332
2553
        self._id_index = None
2333
2554
        self._packed_stat_index = None
2353
2574
        self._make_absent(entry)
2354
2575
        self.update_minimal(('', '', new_id), 'd',
2355
2576
            path_utf8='', packed_stat=entry[1][0][4])
2356
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2357
 
        if self._id_index is not None:
2358
 
            self._id_index.setdefault(new_id, set()).add(entry[0])
 
2577
        self._mark_modified()
2359
2578
 
2360
2579
    def set_parent_trees(self, trees, ghosts):
2361
2580
        """Set the parent trees for the dirstate.
2406
2625
        parent_trees = [tree for rev_id, tree in trees if rev_id not in ghosts]
2407
2626
        # how many trees do we end up with
2408
2627
        parent_count = len(parent_trees)
 
2628
        st = static_tuple.StaticTuple
2409
2629
 
2410
2630
        # one: the current tree
2411
2631
        for entry in self._iter_entries():
2414
2634
                continue
2415
2635
            by_path[entry[0]] = [entry[1][0]] + \
2416
2636
                [DirState.NULL_PARENT_DETAILS] * parent_count
2417
 
            id_index[entry[0][2]] = set([entry[0]])
 
2637
            # TODO: Possibly inline this, since we know it isn't present yet
 
2638
            #       id_index[entry[0][2]] = (entry[0],)
 
2639
            self._add_to_id_index(id_index, entry[0])
2418
2640
 
2419
2641
        # now the parent trees:
2420
2642
        for tree_index, tree in enumerate(parent_trees):
2426
2648
            # the suffix is from tree_index+1:parent_count+1.
2427
2649
            new_location_suffix = [DirState.NULL_PARENT_DETAILS] * (parent_count - tree_index)
2428
2650
            # now stitch in all the entries from this tree
2429
 
            for path, entry in tree.inventory.iter_entries_by_dir():
 
2651
            last_dirname = None
 
2652
            for path, entry in tree.iter_entries_by_dir():
2430
2653
                # here we process each trees details for each item in the tree.
2431
2654
                # we first update any existing entries for the id at other paths,
2432
2655
                # then we either create or update the entry for the id at the
2439
2662
                file_id = entry.file_id
2440
2663
                path_utf8 = path.encode('utf8')
2441
2664
                dirname, basename = osutils.split(path_utf8)
2442
 
                new_entry_key = (dirname, basename, file_id)
 
2665
                if dirname == last_dirname:
 
2666
                    # Try to re-use objects as much as possible
 
2667
                    dirname = last_dirname
 
2668
                else:
 
2669
                    last_dirname = dirname
 
2670
                new_entry_key = st(dirname, basename, file_id)
2443
2671
                # tree index consistency: All other paths for this id in this tree
2444
2672
                # index must point to the correct path.
2445
 
                for entry_key in id_index.setdefault(file_id, set()):
 
2673
                entry_keys = id_index.get(file_id, ())
 
2674
                for entry_key in entry_keys:
2446
2675
                    # TODO:PROFILING: It might be faster to just update
2447
2676
                    # rather than checking if we need to, and then overwrite
2448
2677
                    # the one we are located at.
2451
2680
                        # other trees, so put absent pointers there
2452
2681
                        # This is the vertical axis in the matrix, all pointing
2453
2682
                        # 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.
 
2683
                        by_path[entry_key][tree_index] = st('r', path_utf8, 0,
 
2684
                                                            False, '')
 
2685
                # by path consistency: Insert into an existing path record
 
2686
                # (trivial), or add a new one with relocation pointers for the
 
2687
                # other tree indexes.
 
2688
                if new_entry_key in entry_keys:
 
2689
                    # there is already an entry where this data belongs, just
 
2690
                    # insert it.
2459
2691
                    by_path[new_entry_key][tree_index] = \
2460
2692
                        self._inv_entry_to_details(entry)
2461
2693
                else:
2465
2697
                    new_details = []
2466
2698
                    for lookup_index in xrange(tree_index):
2467
2699
                        # boundary case: this is the first occurence of file_id
2468
 
                        # so there are no id_indexs, possibly take this out of
 
2700
                        # so there are no id_indexes, possibly take this out of
2469
2701
                        # the loop?
2470
 
                        if not len(id_index[file_id]):
 
2702
                        if not len(entry_keys):
2471
2703
                            new_details.append(DirState.NULL_PARENT_DETAILS)
2472
2704
                        else:
2473
2705
                            # 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()
 
2706
                            a_key = iter(entry_keys).next()
2478
2707
                            if by_path[a_key][lookup_index][0] in ('r', 'a'):
2479
 
                                # its a pointer or missing statement, use it as is.
 
2708
                                # its a pointer or missing statement, use it as
 
2709
                                # is.
2480
2710
                                new_details.append(by_path[a_key][lookup_index])
2481
2711
                            else:
2482
2712
                                # we have the right key, make a pointer to it.
2483
2713
                                real_path = ('/'.join(a_key[0:2])).strip('/')
2484
 
                                new_details.append(('r', real_path, 0, False, ''))
 
2714
                                new_details.append(st('r', real_path, 0, False,
 
2715
                                                      ''))
2485
2716
                    new_details.append(self._inv_entry_to_details(entry))
2486
2717
                    new_details.extend(new_location_suffix)
2487
2718
                    by_path[new_entry_key] = new_details
2488
 
                    id_index[file_id].add(new_entry_key)
 
2719
                    self._add_to_id_index(id_index, new_entry_key)
2489
2720
        # --- end generation of full tree mappings
2490
2721
 
2491
2722
        # sort and output all the entries
2493
2724
        self._entries_to_current_state(new_entries)
2494
2725
        self._parents = [rev_id for rev_id, tree in trees]
2495
2726
        self._ghosts = list(ghosts)
2496
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
2497
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2727
        self._mark_modified(header_modified=True)
2498
2728
        self._id_index = id_index
2499
2729
 
2500
2730
    def _sort_entries(self, entry_list):
2504
2734
        try to keep everything in sorted blocks all the time, but sometimes
2505
2735
        it's easier to sort after the fact.
2506
2736
        """
2507
 
        def _key(entry):
 
2737
        # When sorting, we usually have 10x more entries than directories. (69k
 
2738
        # total entries, 4k directories). So cache the results of splitting.
 
2739
        # Saving time and objects. Also, use StaticTuple to avoid putting all
 
2740
        # of these object into python's garbage collector.
 
2741
        split_dirs = {}
 
2742
        def _key(entry, _split_dirs=split_dirs, _st=static_tuple.StaticTuple):
2508
2743
            # sort by: directory parts, file name, file id
2509
 
            return entry[0][0].split('/'), entry[0][1], entry[0][2]
 
2744
            dirpath, fname, file_id = entry[0]
 
2745
            try:
 
2746
                split = _split_dirs[dirpath]
 
2747
            except KeyError:
 
2748
                split = _st.from_sequence(dirpath.split('/'))
 
2749
                _split_dirs[dirpath] = split
 
2750
            return _st(split, fname, file_id)
2510
2751
        return sorted(entry_list, key=_key)
2511
2752
 
2512
2753
    def set_state_from_inventory(self, new_inv):
2637
2878
                        current_old[0][1].decode('utf8'))
2638
2879
                self._make_absent(current_old)
2639
2880
                current_old = advance(old_iterator)
2640
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2881
        self._mark_modified()
2641
2882
        self._id_index = None
2642
2883
        self._packed_stat_index = None
2643
2884
        if tracing:
2644
2885
            trace.mutter("set_state_from_inventory complete.")
2645
2886
 
 
2887
    def set_state_from_scratch(self, working_inv, parent_trees, parent_ghosts):
 
2888
        """Wipe the currently stored state and set it to something new.
 
2889
 
 
2890
        This is a hard-reset for the data we are working with.
 
2891
        """
 
2892
        # Technically, we really want a write lock, but until we write, we
 
2893
        # don't really need it.
 
2894
        self._requires_lock()
 
2895
        # root dir and root dir contents with no children. We have to have a
 
2896
        # root for set_state_from_inventory to work correctly.
 
2897
        empty_root = (('', '', inventory.ROOT_ID),
 
2898
                      [('d', '', 0, False, DirState.NULLSTAT)])
 
2899
        empty_tree_dirblocks = [('', [empty_root]), ('', [])]
 
2900
        self._set_data([], empty_tree_dirblocks)
 
2901
        self.set_state_from_inventory(working_inv)
 
2902
        self.set_parent_trees(parent_trees, parent_ghosts)
 
2903
 
2646
2904
    def _make_absent(self, current_old):
2647
2905
        """Mark current_old - an entry - as absent for tree 0.
2648
2906
 
2673
2931
            block[1].pop(entry_index)
2674
2932
            # if we have an id_index in use, remove this key from it for this id.
2675
2933
            if self._id_index is not None:
2676
 
                self._id_index[current_old[0][2]].remove(current_old[0])
 
2934
                self._remove_from_id_index(self._id_index, current_old[0])
2677
2935
        # update all remaining keys for this id to record it as absent. The
2678
2936
        # existing details may either be the record we are marking as deleted
2679
2937
        # (if there were other trees with the id present at this path), or may
2692
2950
            if update_tree_details[0][0] == 'a': # absent
2693
2951
                raise AssertionError('bad row %r' % (update_tree_details,))
2694
2952
            update_tree_details[0] = DirState.NULL_PARENT_DETAILS
2695
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2953
        self._mark_modified()
2696
2954
        return last_reference
2697
2955
 
2698
2956
    def update_minimal(self, key, minikind, executable=False, fingerprint='',
2740
2998
                            # This entry has the same path (but a different id) as
2741
2999
                            # the new entry we're adding, and is present in ths
2742
3000
                            # tree.
2743
 
                            raise errors.InconsistentDelta(
 
3001
                            self._raise_invalid(
2744
3002
                                ("%s/%s" % key[0:2]).decode('utf8'), key[2],
2745
3003
                                "Attempt to add item at path already occupied by "
2746
3004
                                "id %r" % entry[0][2])
2748
3006
                    else:
2749
3007
                        break
2750
3008
            # new entry, synthesis cross reference here,
2751
 
            existing_keys = id_index.setdefault(key[2], set())
 
3009
            existing_keys = id_index.get(key[2], ())
2752
3010
            if not existing_keys:
2753
3011
                # not currently in the state, simplest case
2754
3012
                new_entry = key, [new_details] + self._empty_parent_info()
2785
3043
                    # loop.
2786
3044
                    other_entry = other_block[other_entry_index]
2787
3045
                    other_entry[1][0] = ('r', path_utf8, 0, False, '')
2788
 
                    self._maybe_remove_row(other_block, other_entry_index,
2789
 
                        id_index)
 
3046
                    if self._maybe_remove_row(other_block, other_entry_index,
 
3047
                                              id_index):
 
3048
                        # If the row holding this was removed, we need to
 
3049
                        # recompute where this entry goes
 
3050
                        entry_index, _ = self._find_entry_index(key, block)
2790
3051
 
2791
3052
                # This loop:
2792
3053
                # adds a tuple to the new details for each column
2794
3055
                #  - or by creating a new pointer to the right row inside that column
2795
3056
                num_present_parents = self._num_present_parents()
2796
3057
                if num_present_parents:
 
3058
                    # TODO: This re-evaluates the existing_keys set, do we need
 
3059
                    #       to do that ourselves?
2797
3060
                    other_key = list(existing_keys)[0]
2798
3061
                for lookup_index in xrange(1, num_present_parents + 1):
2799
3062
                    # grab any one entry, use it to find the right path.
2818
3081
                        pointer_path = osutils.pathjoin(*other_key[0:2])
2819
3082
                        new_entry[1].append(('r', pointer_path, 0, False, ''))
2820
3083
            block.insert(entry_index, new_entry)
2821
 
            existing_keys.add(key)
 
3084
            self._add_to_id_index(id_index, key)
2822
3085
        else:
2823
3086
            # Does the new state matter?
2824
3087
            block[entry_index][1][0] = new_details
2833
3096
            # converted to relocated.
2834
3097
            if path_utf8 is None:
2835
3098
                raise AssertionError('no path')
2836
 
            for entry_key in id_index.setdefault(key[2], set()):
 
3099
            existing_keys = id_index.get(key[2], ())
 
3100
            if key not in existing_keys:
 
3101
                raise AssertionError('We found the entry in the blocks, but'
 
3102
                    ' the key is not in the id_index.'
 
3103
                    ' key: %s, existing_keys: %s' % (key, existing_keys))
 
3104
            for entry_key in existing_keys:
2837
3105
                # TODO:PROFILING: It might be faster to just update
2838
3106
                # rather than checking if we need to, and then overwrite
2839
3107
                # the one we are located at.
2857
3125
            if not present:
2858
3126
                self._dirblocks.insert(block_index, (subdir_key[0], []))
2859
3127
 
2860
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
3128
        self._mark_modified()
2861
3129
 
2862
3130
    def _maybe_remove_row(self, block, index, id_index):
2863
3131
        """Remove index if it is absent or relocated across the row.
2864
3132
        
2865
3133
        id_index is updated accordingly.
 
3134
        :return: True if we removed the row, False otherwise
2866
3135
        """
2867
3136
        present_in_row = False
2868
3137
        entry = block[index]
2872
3141
                break
2873
3142
        if not present_in_row:
2874
3143
            block.pop(index)
2875
 
            id_index[entry[0][2]].remove(entry[0])
 
3144
            self._remove_from_id_index(id_index, entry[0])
 
3145
            return True
 
3146
        return False
2876
3147
 
2877
3148
    def _validate(self):
2878
3149
        """Check that invariants on the dirblock are correct.
3013
3284
            if absent_positions == tree_count:
3014
3285
                raise AssertionError(
3015
3286
                    "entry %r has no data for any tree." % (entry,))
 
3287
        if self._id_index is not None:
 
3288
            for file_id, entry_keys in self._id_index.iteritems():
 
3289
                for entry_key in entry_keys:
 
3290
                    # Check that the entry in the map is pointing to the same
 
3291
                    # file_id
 
3292
                    if entry_key[2] != file_id:
 
3293
                        raise AssertionError(
 
3294
                            'file_id %r did not match entry key %s'
 
3295
                            % (file_id, entry_key))
 
3296
                    # And that from this entry key, we can look up the original
 
3297
                    # record
 
3298
                    block_index, present = self._find_block_index_from_key(entry_key)
 
3299
                    if not present:
 
3300
                        raise AssertionError('missing block for entry key: %r', entry_key)
 
3301
                    entry_index, present = self._find_entry_index(entry_key, self._dirblocks[block_index][1])
 
3302
                    if not present:
 
3303
                        raise AssertionError('missing entry for key: %r', entry_key)
 
3304
                if len(entry_keys) != len(set(entry_keys)):
 
3305
                    raise AssertionError(
 
3306
                        'id_index contained non-unique data for %s'
 
3307
                        % (entry_keys,))
3016
3308
 
3017
3309
    def _wipe_state(self):
3018
3310
        """Forget all state information about the dirstate."""
3075
3367
 
3076
3368
 
3077
3369
def py_update_entry(state, entry, abspath, stat_value,
3078
 
                 _stat_to_minikind=DirState._stat_to_minikind,
3079
 
                 _pack_stat=pack_stat):
 
3370
                 _stat_to_minikind=DirState._stat_to_minikind):
3080
3371
    """Update the entry based on what is actually on disk.
3081
3372
 
3082
3373
    This function only calculates the sha if it needs to - if the entry is
3095
3386
    except KeyError:
3096
3387
        # Unhandled kind
3097
3388
        return None
3098
 
    packed_stat = _pack_stat(stat_value)
 
3389
    packed_stat = pack_stat(stat_value)
3099
3390
    (saved_minikind, saved_link_or_sha1, saved_file_size,
3100
3391
     saved_executable, saved_packed_stat) = entry[1][0]
3101
3392
 
3115
3406
    # If we have gotten this far, that means that we need to actually
3116
3407
    # process this entry.
3117
3408
    link_or_sha1 = None
 
3409
    worth_saving = True
3118
3410
    if minikind == 'f':
3119
3411
        executable = state._is_executable(stat_value.st_mode,
3120
3412
                                         saved_executable)
3136
3428
        else:
3137
3429
            entry[1][0] = ('f', '', stat_value.st_size,
3138
3430
                           executable, DirState.NULLSTAT)
 
3431
            worth_saving = False
3139
3432
    elif minikind == 'd':
3140
3433
        link_or_sha1 = None
3141
3434
        entry[1][0] = ('d', '', 0, False, packed_stat)
3147
3440
                state._get_block_entry_index(entry[0][0], entry[0][1], 0)
3148
3441
            state._ensure_block(block_index, entry_index,
3149
3442
                               osutils.pathjoin(entry[0][0], entry[0][1]))
 
3443
        else:
 
3444
            worth_saving = False
3150
3445
    elif minikind == 'l':
 
3446
        if saved_minikind == 'l':
 
3447
            worth_saving = False
3151
3448
        link_or_sha1 = state._read_link(abspath, saved_link_or_sha1)
3152
3449
        if state._cutoff_time is None:
3153
3450
            state._sha_cutoff_time()
3158
3455
        else:
3159
3456
            entry[1][0] = ('l', '', stat_value.st_size,
3160
3457
                           False, DirState.NULLSTAT)
3161
 
    state._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
3458
    if worth_saving:
 
3459
        state._mark_modified([entry])
3162
3460
    return link_or_sha1
3163
3461
 
3164
3462
 
3166
3464
 
3167
3465
    __slots__ = ["old_dirname_to_file_id", "new_dirname_to_file_id",
3168
3466
        "last_source_parent", "last_target_parent", "include_unchanged",
3169
 
        "use_filesystem_for_exec", "utf8_decode", "searched_specific_files",
3170
 
        "search_specific_files", "state", "source_index", "target_index",
3171
 
        "want_unversioned", "tree"]
 
3467
        "partial", "use_filesystem_for_exec", "utf8_decode",
 
3468
        "searched_specific_files", "search_specific_files",
 
3469
        "searched_exact_paths", "search_specific_file_parents", "seen_ids",
 
3470
        "state", "source_index", "target_index", "want_unversioned", "tree"]
3172
3471
 
3173
3472
    def __init__(self, include_unchanged, use_filesystem_for_exec,
3174
3473
        search_specific_files, state, source_index, target_index,
3175
3474
        want_unversioned, tree):
3176
3475
        self.old_dirname_to_file_id = {}
3177
3476
        self.new_dirname_to_file_id = {}
 
3477
        # Are we doing a partial iter_changes?
 
3478
        self.partial = search_specific_files != set([''])
3178
3479
        # Using a list so that we can access the values and change them in
3179
3480
        # nested scope. Each one is [path, file_id, entry]
3180
3481
        self.last_source_parent = [None, None]
3183
3484
        self.use_filesystem_for_exec = use_filesystem_for_exec
3184
3485
        self.utf8_decode = cache_utf8._utf8_decode
3185
3486
        # for all search_indexs in each path at or under each element of
3186
 
        # search_specific_files, if the detail is relocated: add the id, and add the
3187
 
        # relocated path as one to search if its not searched already. If the
3188
 
        # detail is not relocated, add the id.
 
3487
        # search_specific_files, if the detail is relocated: add the id, and
 
3488
        # add the relocated path as one to search if its not searched already.
 
3489
        # If the detail is not relocated, add the id.
3189
3490
        self.searched_specific_files = set()
 
3491
        # When we search exact paths without expanding downwards, we record
 
3492
        # that here.
 
3493
        self.searched_exact_paths = set()
3190
3494
        self.search_specific_files = search_specific_files
 
3495
        # The parents up to the root of the paths we are searching.
 
3496
        # After all normal paths are returned, these specific items are returned.
 
3497
        self.search_specific_file_parents = set()
 
3498
        # The ids we've sent out in the delta.
 
3499
        self.seen_ids = set()
3191
3500
        self.state = state
3192
3501
        self.source_index = source_index
3193
3502
        self.target_index = target_index
 
3503
        if target_index != 0:
 
3504
            # A lot of code in here depends on target_index == 0
 
3505
            raise errors.BzrError('unsupported target index')
3194
3506
        self.want_unversioned = want_unversioned
3195
3507
        self.tree = tree
3196
3508
 
3198
3510
        """Compare an entry and real disk to generate delta information.
3199
3511
 
3200
3512
        :param path_info: top_relpath, basename, kind, lstat, abspath for
3201
 
            the path of entry. If None, then the path is considered absent.
3202
 
            (Perhaps we should pass in a concrete entry for this ?)
 
3513
            the path of entry. If None, then the path is considered absent in 
 
3514
            the target (Perhaps we should pass in a concrete entry for this ?)
3203
3515
            Basename is returned as a utf8 string because we expect this
3204
3516
            tuple will be ignored, and don't want to take the time to
3205
3517
            decode.
3206
3518
        :return: (iter_changes_result, changed). If the entry has not been
3207
3519
            handled then changed is None. Otherwise it is False if no content
3208
 
            or metadata changes have occured, and None if any content or
3209
 
            metadata change has occured. If self.include_unchanged is True then
 
3520
            or metadata changes have occurred, and True if any content or
 
3521
            metadata change has occurred. If self.include_unchanged is True then
3210
3522
            if changed is not None, iter_changes_result will always be a result
3211
3523
            tuple. Otherwise, iter_changes_result is None unless changed is
3212
3524
            True.
3314
3626
                        content_change = False
3315
3627
                    target_exec = False
3316
3628
                else:
3317
 
                    raise Exception, "unknown kind %s" % path_info[2]
 
3629
                    if path is None:
 
3630
                        path = pathjoin(old_dirname, old_basename)
 
3631
                    raise errors.BadFileKindError(path, path_info[2])
3318
3632
            if source_minikind == 'd':
3319
3633
                if path is None:
3320
3634
                    old_path = path = pathjoin(old_dirname, old_basename)
3457
3771
            raise AssertionError("don't know how to compare "
3458
3772
                "source_minikind=%r, target_minikind=%r"
3459
3773
                % (source_minikind, target_minikind))
3460
 
            ## import pdb;pdb.set_trace()
3461
3774
        return None, None
3462
3775
 
3463
3776
    def __iter__(self):
3464
3777
        return self
3465
3778
 
 
3779
    def _gather_result_for_consistency(self, result):
 
3780
        """Check a result we will yield to make sure we are consistent later.
 
3781
        
 
3782
        This gathers result's parents into a set to output later.
 
3783
 
 
3784
        :param result: A result tuple.
 
3785
        """
 
3786
        if not self.partial or not result[0]:
 
3787
            return
 
3788
        self.seen_ids.add(result[0])
 
3789
        new_path = result[1][1]
 
3790
        if new_path:
 
3791
            # Not the root and not a delete: queue up the parents of the path.
 
3792
            self.search_specific_file_parents.update(
 
3793
                osutils.parent_directories(new_path.encode('utf8')))
 
3794
            # Add the root directory which parent_directories does not
 
3795
            # provide.
 
3796
            self.search_specific_file_parents.add('')
 
3797
 
3466
3798
    def iter_changes(self):
3467
3799
        """Iterate over the changes."""
3468
3800
        utf8_decode = cache_utf8._utf8_decode
3546
3878
                result, changed = _process_entry(entry, root_dir_info)
3547
3879
                if changed is not None:
3548
3880
                    path_handled = True
 
3881
                    if changed:
 
3882
                        self._gather_result_for_consistency(result)
3549
3883
                    if changed or self.include_unchanged:
3550
3884
                        yield result
3551
3885
            if self.want_unversioned and not path_handled and root_dir_info:
3664
3998
                            # advance the entry only, after processing.
3665
3999
                            result, changed = _process_entry(current_entry, None)
3666
4000
                            if changed is not None:
 
4001
                                if changed:
 
4002
                                    self._gather_result_for_consistency(result)
3667
4003
                                if changed or self.include_unchanged:
3668
4004
                                    yield result
3669
4005
                        block_index +=1
3702
4038
                        # no path is fine: the per entry code will handle it.
3703
4039
                        result, changed = _process_entry(current_entry, current_path_info)
3704
4040
                        if changed is not None:
 
4041
                            if changed:
 
4042
                                self._gather_result_for_consistency(result)
3705
4043
                            if changed or self.include_unchanged:
3706
4044
                                yield result
3707
4045
                    elif (current_entry[0][1] != current_path_info[1]
3723
4061
                            # advance the entry only, after processing.
3724
4062
                            result, changed = _process_entry(current_entry, None)
3725
4063
                            if changed is not None:
 
4064
                                if changed:
 
4065
                                    self._gather_result_for_consistency(result)
3726
4066
                                if changed or self.include_unchanged:
3727
4067
                                    yield result
3728
4068
                            advance_path = False
3730
4070
                        result, changed = _process_entry(current_entry, current_path_info)
3731
4071
                        if changed is not None:
3732
4072
                            path_handled = True
 
4073
                            if changed:
 
4074
                                self._gather_result_for_consistency(result)
3733
4075
                            if changed or self.include_unchanged:
3734
4076
                                yield result
3735
4077
                    if advance_entry and current_entry is not None:
3795
4137
                        current_dir_info = dir_iterator.next()
3796
4138
                    except StopIteration:
3797
4139
                        current_dir_info = None
 
4140
        for result in self._iter_specific_file_parents():
 
4141
            yield result
 
4142
 
 
4143
    def _iter_specific_file_parents(self):
 
4144
        """Iter over the specific file parents."""
 
4145
        while self.search_specific_file_parents:
 
4146
            # Process the parent directories for the paths we were iterating.
 
4147
            # Even in extremely large trees this should be modest, so currently
 
4148
            # no attempt is made to optimise.
 
4149
            path_utf8 = self.search_specific_file_parents.pop()
 
4150
            if osutils.is_inside_any(self.searched_specific_files, path_utf8):
 
4151
                # We've examined this path.
 
4152
                continue
 
4153
            if path_utf8 in self.searched_exact_paths:
 
4154
                # We've examined this path.
 
4155
                continue
 
4156
            path_entries = self.state._entries_for_path(path_utf8)
 
4157
            # We need either one or two entries. If the path in
 
4158
            # self.target_index has moved (so the entry in source_index is in
 
4159
            # 'ar') then we need to also look for the entry for this path in
 
4160
            # self.source_index, to output the appropriate delete-or-rename.
 
4161
            selected_entries = []
 
4162
            found_item = False
 
4163
            for candidate_entry in path_entries:
 
4164
                # Find entries present in target at this path:
 
4165
                if candidate_entry[1][self.target_index][0] not in 'ar':
 
4166
                    found_item = True
 
4167
                    selected_entries.append(candidate_entry)
 
4168
                # Find entries present in source at this path:
 
4169
                elif (self.source_index is not None and
 
4170
                    candidate_entry[1][self.source_index][0] not in 'ar'):
 
4171
                    found_item = True
 
4172
                    if candidate_entry[1][self.target_index][0] == 'a':
 
4173
                        # Deleted, emit it here.
 
4174
                        selected_entries.append(candidate_entry)
 
4175
                    else:
 
4176
                        # renamed, emit it when we process the directory it
 
4177
                        # ended up at.
 
4178
                        self.search_specific_file_parents.add(
 
4179
                            candidate_entry[1][self.target_index][1])
 
4180
            if not found_item:
 
4181
                raise AssertionError(
 
4182
                    "Missing entry for specific path parent %r, %r" % (
 
4183
                    path_utf8, path_entries))
 
4184
            path_info = self._path_info(path_utf8, path_utf8.decode('utf8'))
 
4185
            for entry in selected_entries:
 
4186
                if entry[0][2] in self.seen_ids:
 
4187
                    continue
 
4188
                result, changed = self._process_entry(entry, path_info)
 
4189
                if changed is None:
 
4190
                    raise AssertionError(
 
4191
                        "Got entry<->path mismatch for specific path "
 
4192
                        "%r entry %r path_info %r " % (
 
4193
                        path_utf8, entry, path_info))
 
4194
                # Only include changes - we're outside the users requested
 
4195
                # expansion.
 
4196
                if changed:
 
4197
                    self._gather_result_for_consistency(result)
 
4198
                    if (result[6][0] == 'directory' and
 
4199
                        result[6][1] != 'directory'):
 
4200
                        # This stopped being a directory, the old children have
 
4201
                        # to be included.
 
4202
                        if entry[1][self.source_index][0] == 'r':
 
4203
                            # renamed, take the source path
 
4204
                            entry_path_utf8 = entry[1][self.source_index][1]
 
4205
                        else:
 
4206
                            entry_path_utf8 = path_utf8
 
4207
                        initial_key = (entry_path_utf8, '', '')
 
4208
                        block_index, _ = self.state._find_block_index_from_key(
 
4209
                            initial_key)
 
4210
                        if block_index == 0:
 
4211
                            # The children of the root are in block index 1.
 
4212
                            block_index +=1
 
4213
                        current_block = None
 
4214
                        if block_index < len(self.state._dirblocks):
 
4215
                            current_block = self.state._dirblocks[block_index]
 
4216
                            if not osutils.is_inside(
 
4217
                                entry_path_utf8, current_block[0]):
 
4218
                                # No entries for this directory at all.
 
4219
                                current_block = None
 
4220
                        if current_block is not None:
 
4221
                            for entry in current_block[1]:
 
4222
                                if entry[1][self.source_index][0] in 'ar':
 
4223
                                    # Not in the source tree, so doesn't have to be
 
4224
                                    # included.
 
4225
                                    continue
 
4226
                                # Path of the entry itself.
 
4227
 
 
4228
                                self.search_specific_file_parents.add(
 
4229
                                    osutils.pathjoin(*entry[0][:2]))
 
4230
                if changed or self.include_unchanged:
 
4231
                    yield result
 
4232
            self.searched_exact_paths.add(path_utf8)
 
4233
 
 
4234
    def _path_info(self, utf8_path, unicode_path):
 
4235
        """Generate path_info for unicode_path.
 
4236
 
 
4237
        :return: None if unicode_path does not exist, or a path_info tuple.
 
4238
        """
 
4239
        abspath = self.tree.abspath(unicode_path)
 
4240
        try:
 
4241
            stat = os.lstat(abspath)
 
4242
        except OSError, e:
 
4243
            if e.errno == errno.ENOENT:
 
4244
                # the path does not exist.
 
4245
                return None
 
4246
            else:
 
4247
                raise
 
4248
        utf8_basename = utf8_path.rsplit('/', 1)[-1]
 
4249
        dir_info = (utf8_path, utf8_basename,
 
4250
            osutils.file_kind_from_stat_mode(stat.st_mode), stat,
 
4251
            abspath)
 
4252
        if dir_info[2] == 'directory':
 
4253
            if self.tree._directory_is_tree_reference(
 
4254
                unicode_path):
 
4255
                self.root_dir_info = self.root_dir_info[:2] + \
 
4256
                    ('tree-reference',) + self.root_dir_info[3:]
 
4257
        return dir_info
3798
4258
 
3799
4259
 
3800
4260
# Try to load the compiled form if possible
3805
4265
        _bisect_path_left,
3806
4266
        _bisect_path_right,
3807
4267
        cmp_by_dirs,
 
4268
        pack_stat,
3808
4269
        ProcessEntryC as _process_entry,
3809
4270
        update_entry as update_entry,
3810
4271
        )
3811
 
except ImportError:
 
4272
except ImportError, e:
 
4273
    osutils.failed_to_load_extension(e)
3812
4274
    from bzrlib._dirstate_helpers_py import (
3813
4275
        _read_dirblocks,
3814
4276
        bisect_dirblock,
3815
4277
        _bisect_path_left,
3816
4278
        _bisect_path_right,
3817
4279
        cmp_by_dirs,
 
4280
        pack_stat,
3818
4281
        )
3819
4282
    # FIXME: It would be nice to be able to track moved lines so that the
3820
4283
    # corresponding python code can be moved to the _dirstate_helpers_py